diff --git a/docs/dyn/admin_directory_v1.users.html b/docs/dyn/admin_directory_v1.users.html index a6bb41d121..0e59b447c9 100644 --- a/docs/dyn/admin_directory_v1.users.html +++ b/docs/dyn/admin_directory_v1.users.html @@ -89,7 +89,7 @@

Instance Methods

Close httplib2 connections.

createGuest(body=None, x__xgafv=None)

-

Create a guest user with access to a [subset of Workspace capabilities](https://support.google.com/a/answer/16558545). This feature is currently in Alpha. Please reach out to support if you are interested in trying this feature.

+

Create a guest user with access to a [subset of Workspace capabilities](https://support.google.com/a/answer/16558545). This feature is currently in Open Beta.

delete(userKey, x__xgafv=None)

Deletes a user.

@@ -131,15 +131,15 @@

Method Details

createGuest(body=None, x__xgafv=None) -
Create a guest user with access to a [subset of Workspace capabilities](https://support.google.com/a/answer/16558545). This feature is currently in Alpha. Please reach out to support if you are interested in trying this feature.
+  
Create a guest user with access to a [subset of Workspace capabilities](https://support.google.com/a/answer/16558545). This feature is currently in Open Beta.
 
 Args:
   body: object, The request body.
     The object takes the form of:
 
 { # Directory users guest creation request message.
-  "customer": "A String", # Optional. Immutable ID of the Google Workspace account.
-  "primaryGuestEmail": "A String", # Immutable. External email of the guest user being created.
+  "customer": "A String", # Optional. Immutable ID of the Google Workspace account. Only required when request is created by a service account. Defaults to the authenticated user's customer ID otherwise.
+  "primaryGuestEmail": "A String", # Required. External email of the guest user being created.
 }
 
   x__xgafv: string, V1 error format.
diff --git a/docs/dyn/aiplatform_v1.endpoints.html b/docs/dyn/aiplatform_v1.endpoints.html
index fcb1a00741..022cd06c50 100644
--- a/docs/dyn/aiplatform_v1.endpoints.html
+++ b/docs/dyn/aiplatform_v1.endpoints.html
@@ -522,6 +522,12 @@ 

Method Details

"A String", ], }, + "exaAiSearch": { # ExaAiSearch tool type. A tool that uses the Exa.ai search engine for grounding. # Optional. Uses Exa.ai to search for information to answer user queries. The search results will be grounded on Exa.ai and presented to the model for response generation + "apiKey": "A String", # Required. The API key for ExaAiSearch. + "customConfigs": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. + "a_key": "", # Properties of the object. + }, + }, "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "behavior": "A String", # Optional. Specifies the function Behavior. If not specified, the system keeps the current function call behavior. This field is currently only supported by the BidiGenerateContent method. @@ -1107,6 +1113,12 @@

Method Details

"A String", ], }, + "exaAiSearch": { # ExaAiSearch tool type. A tool that uses the Exa.ai search engine for grounding. # Optional. Uses Exa.ai to search for information to answer user queries. The search results will be grounded on Exa.ai and presented to the model for response generation + "apiKey": "A String", # Required. The API key for ExaAiSearch. + "customConfigs": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. + "a_key": "", # Properties of the object. + }, + }, "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "behavior": "A String", # Optional. Specifies the function Behavior. If not specified, the system keeps the current function call behavior. This field is currently only supported by the BidiGenerateContent method. @@ -2006,6 +2018,12 @@

Method Details

"A String", ], }, + "exaAiSearch": { # ExaAiSearch tool type. A tool that uses the Exa.ai search engine for grounding. # Optional. Uses Exa.ai to search for information to answer user queries. The search results will be grounded on Exa.ai and presented to the model for response generation + "apiKey": "A String", # Required. The API key for ExaAiSearch. + "customConfigs": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. + "a_key": "", # Properties of the object. + }, + }, "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "behavior": "A String", # Optional. Specifies the function Behavior. If not specified, the system keeps the current function call behavior. This field is currently only supported by the BidiGenerateContent method. diff --git a/docs/dyn/aiplatform_v1.projects.locations.cachedContents.html b/docs/dyn/aiplatform_v1.projects.locations.cachedContents.html index c1ea0d93a6..e8f060904b 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.cachedContents.html +++ b/docs/dyn/aiplatform_v1.projects.locations.cachedContents.html @@ -301,6 +301,12 @@

Method Details

"A String", ], }, + "exaAiSearch": { # ExaAiSearch tool type. A tool that uses the Exa.ai search engine for grounding. # Optional. Uses Exa.ai to search for information to answer user queries. The search results will be grounded on Exa.ai and presented to the model for response generation + "apiKey": "A String", # Required. The API key for ExaAiSearch. + "customConfigs": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. + "a_key": "", # Properties of the object. + }, + }, "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "behavior": "A String", # Optional. Specifies the function Behavior. If not specified, the system keeps the current function call behavior. This field is currently only supported by the BidiGenerateContent method. @@ -712,6 +718,12 @@

Method Details

"A String", ], }, + "exaAiSearch": { # ExaAiSearch tool type. A tool that uses the Exa.ai search engine for grounding. # Optional. Uses Exa.ai to search for information to answer user queries. The search results will be grounded on Exa.ai and presented to the model for response generation + "apiKey": "A String", # Required. The API key for ExaAiSearch. + "customConfigs": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. + "a_key": "", # Properties of the object. + }, + }, "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "behavior": "A String", # Optional. Specifies the function Behavior. If not specified, the system keeps the current function call behavior. This field is currently only supported by the BidiGenerateContent method. @@ -1148,6 +1160,12 @@

Method Details

"A String", ], }, + "exaAiSearch": { # ExaAiSearch tool type. A tool that uses the Exa.ai search engine for grounding. # Optional. Uses Exa.ai to search for information to answer user queries. The search results will be grounded on Exa.ai and presented to the model for response generation + "apiKey": "A String", # Required. The API key for ExaAiSearch. + "customConfigs": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. + "a_key": "", # Properties of the object. + }, + }, "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "behavior": "A String", # Optional. Specifies the function Behavior. If not specified, the system keeps the current function call behavior. This field is currently only supported by the BidiGenerateContent method. @@ -1570,6 +1588,12 @@

Method Details

"A String", ], }, + "exaAiSearch": { # ExaAiSearch tool type. A tool that uses the Exa.ai search engine for grounding. # Optional. Uses Exa.ai to search for information to answer user queries. The search results will be grounded on Exa.ai and presented to the model for response generation + "apiKey": "A String", # Required. The API key for ExaAiSearch. + "customConfigs": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. + "a_key": "", # Properties of the object. + }, + }, "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "behavior": "A String", # Optional. Specifies the function Behavior. If not specified, the system keeps the current function call behavior. This field is currently only supported by the BidiGenerateContent method. @@ -2000,6 +2024,12 @@

Method Details

"A String", ], }, + "exaAiSearch": { # ExaAiSearch tool type. A tool that uses the Exa.ai search engine for grounding. # Optional. Uses Exa.ai to search for information to answer user queries. The search results will be grounded on Exa.ai and presented to the model for response generation + "apiKey": "A String", # Required. The API key for ExaAiSearch. + "customConfigs": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. + "a_key": "", # Properties of the object. + }, + }, "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "behavior": "A String", # Optional. Specifies the function Behavior. If not specified, the system keeps the current function call behavior. This field is currently only supported by the BidiGenerateContent method. @@ -2412,6 +2442,12 @@

Method Details

"A String", ], }, + "exaAiSearch": { # ExaAiSearch tool type. A tool that uses the Exa.ai search engine for grounding. # Optional. Uses Exa.ai to search for information to answer user queries. The search results will be grounded on Exa.ai and presented to the model for response generation + "apiKey": "A String", # Required. The API key for ExaAiSearch. + "customConfigs": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. + "a_key": "", # Properties of the object. + }, + }, "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "behavior": "A String", # Optional. Specifies the function Behavior. If not specified, the system keeps the current function call behavior. This field is currently only supported by the BidiGenerateContent method. diff --git a/docs/dyn/aiplatform_v1.projects.locations.endpoints.html b/docs/dyn/aiplatform_v1.projects.locations.endpoints.html index 5af24c86cf..51643aef3f 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.endpoints.html +++ b/docs/dyn/aiplatform_v1.projects.locations.endpoints.html @@ -590,6 +590,12 @@

Method Details

"A String", ], }, + "exaAiSearch": { # ExaAiSearch tool type. A tool that uses the Exa.ai search engine for grounding. # Optional. Uses Exa.ai to search for information to answer user queries. The search results will be grounded on Exa.ai and presented to the model for response generation + "apiKey": "A String", # Required. The API key for ExaAiSearch. + "customConfigs": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. + "a_key": "", # Properties of the object. + }, + }, "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "behavior": "A String", # Optional. Specifies the function Behavior. If not specified, the system keeps the current function call behavior. This field is currently only supported by the BidiGenerateContent method. @@ -2071,6 +2077,12 @@

Method Details

"A String", ], }, + "exaAiSearch": { # ExaAiSearch tool type. A tool that uses the Exa.ai search engine for grounding. # Optional. Uses Exa.ai to search for information to answer user queries. The search results will be grounded on Exa.ai and presented to the model for response generation + "apiKey": "A String", # Required. The API key for ExaAiSearch. + "customConfigs": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. + "a_key": "", # Properties of the object. + }, + }, "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "behavior": "A String", # Optional. Specifies the function Behavior. If not specified, the system keeps the current function call behavior. This field is currently only supported by the BidiGenerateContent method. @@ -4452,6 +4464,12 @@

Method Details

"A String", ], }, + "exaAiSearch": { # ExaAiSearch tool type. A tool that uses the Exa.ai search engine for grounding. # Optional. Uses Exa.ai to search for information to answer user queries. The search results will be grounded on Exa.ai and presented to the model for response generation + "apiKey": "A String", # Required. The API key for ExaAiSearch. + "customConfigs": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. + "a_key": "", # Properties of the object. + }, + }, "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "behavior": "A String", # Optional. Specifies the function Behavior. If not specified, the system keeps the current function call behavior. This field is currently only supported by the BidiGenerateContent method. diff --git a/docs/dyn/aiplatform_v1.projects.locations.html b/docs/dyn/aiplatform_v1.projects.locations.html index 1f15326b01..59005c4dcd 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.html +++ b/docs/dyn/aiplatform_v1.projects.locations.html @@ -358,6 +358,12 @@

Method Details

"A String", ], }, + "exaAiSearch": { # ExaAiSearch tool type. A tool that uses the Exa.ai search engine for grounding. # Optional. Uses Exa.ai to search for information to answer user queries. The search results will be grounded on Exa.ai and presented to the model for response generation + "apiKey": "A String", # Required. The API key for ExaAiSearch. + "customConfigs": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. + "a_key": "", # Properties of the object. + }, + }, "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "behavior": "A String", # Optional. Specifies the function Behavior. If not specified, the system keeps the current function call behavior. This field is currently only supported by the BidiGenerateContent method. @@ -636,6 +642,12 @@

Method Details

"A String", ], }, + "exaAiSearch": { # ExaAiSearch tool type. A tool that uses the Exa.ai search engine for grounding. # Optional. Uses Exa.ai to search for information to answer user queries. The search results will be grounded on Exa.ai and presented to the model for response generation + "apiKey": "A String", # Required. The API key for ExaAiSearch. + "customConfigs": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. + "a_key": "", # Properties of the object. + }, + }, "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "behavior": "A String", # Optional. Specifies the function Behavior. If not specified, the system keeps the current function call behavior. This field is currently only supported by the BidiGenerateContent method. @@ -2260,6 +2272,12 @@

Method Details

"A String", ], }, + "exaAiSearch": { # ExaAiSearch tool type. A tool that uses the Exa.ai search engine for grounding. # Optional. Uses Exa.ai to search for information to answer user queries. The search results will be grounded on Exa.ai and presented to the model for response generation + "apiKey": "A String", # Required. The API key for ExaAiSearch. + "customConfigs": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. + "a_key": "", # Properties of the object. + }, + }, "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "behavior": "A String", # Optional. Specifies the function Behavior. If not specified, the system keeps the current function call behavior. This field is currently only supported by the BidiGenerateContent method. @@ -2570,6 +2588,12 @@

Method Details

"A String", ], }, + "exaAiSearch": { # ExaAiSearch tool type. A tool that uses the Exa.ai search engine for grounding. # Optional. Uses Exa.ai to search for information to answer user queries. The search results will be grounded on Exa.ai and presented to the model for response generation + "apiKey": "A String", # Required. The API key for ExaAiSearch. + "customConfigs": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. + "a_key": "", # Properties of the object. + }, + }, "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "behavior": "A String", # Optional. Specifies the function Behavior. If not specified, the system keeps the current function call behavior. This field is currently only supported by the BidiGenerateContent method. @@ -2951,6 +2975,12 @@

Method Details

"A String", ], }, + "exaAiSearch": { # ExaAiSearch tool type. A tool that uses the Exa.ai search engine for grounding. # Optional. Uses Exa.ai to search for information to answer user queries. The search results will be grounded on Exa.ai and presented to the model for response generation + "apiKey": "A String", # Required. The API key for ExaAiSearch. + "customConfigs": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. + "a_key": "", # Properties of the object. + }, + }, "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "behavior": "A String", # Optional. Specifies the function Behavior. If not specified, the system keeps the current function call behavior. This field is currently only supported by the BidiGenerateContent method. @@ -3174,6 +3204,12 @@

Method Details

"A String", ], }, + "exaAiSearch": { # ExaAiSearch tool type. A tool that uses the Exa.ai search engine for grounding. # Optional. Uses Exa.ai to search for information to answer user queries. The search results will be grounded on Exa.ai and presented to the model for response generation + "apiKey": "A String", # Required. The API key for ExaAiSearch. + "customConfigs": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. + "a_key": "", # Properties of the object. + }, + }, "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "behavior": "A String", # Optional. Specifies the function Behavior. If not specified, the system keeps the current function call behavior. This field is currently only supported by the BidiGenerateContent method. @@ -5332,6 +5368,12 @@

Method Details

"A String", ], }, + "exaAiSearch": { # ExaAiSearch tool type. A tool that uses the Exa.ai search engine for grounding. # Optional. Uses Exa.ai to search for information to answer user queries. The search results will be grounded on Exa.ai and presented to the model for response generation + "apiKey": "A String", # Required. The API key for ExaAiSearch. + "customConfigs": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. + "a_key": "", # Properties of the object. + }, + }, "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "behavior": "A String", # Optional. Specifies the function Behavior. If not specified, the system keeps the current function call behavior. This field is currently only supported by the BidiGenerateContent method. diff --git a/docs/dyn/aiplatform_v1.projects.locations.notebookExecutionJobs.html b/docs/dyn/aiplatform_v1.projects.locations.notebookExecutionJobs.html index 2a018030ce..370097b0d2 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.notebookExecutionJobs.html +++ b/docs/dyn/aiplatform_v1.projects.locations.notebookExecutionJobs.html @@ -134,9 +134,9 @@

Method Details

"network": "A String", # The full name of the Google Compute Engine [network](https://cloud.google.com//compute/docs/networks-and-firewalls#networks) "subnetwork": "A String", # The name of the subnet that this instance is in. Format: `projects/{project_id_or_number}/regions/{region}/subnetworks/{subnetwork_id}` }, - "persistentDiskSpec": { # Represents the spec of persistent disk options. # The specification of a persistent disk to attach for the execution job. + "persistentDiskSpec": { # Represents the spec of persistent disk and hyperdisk options. # The specification of a persistent disk to attach for the execution job. "diskSizeGb": "A String", # Size in GB of the disk (default is 100GB). - "diskType": "A String", # Type of the disk (default is "pd-standard"). Valid values: "pd-ssd" (Persistent Disk Solid State Drive) "pd-standard" (Persistent Disk Hard Disk Drive) "pd-balanced" (Balanced Persistent Disk) "pd-extreme" (Extreme Persistent Disk) + "diskType": "A String", # Type of the disk (default is "pd-standard"). Valid values: "pd-ssd" (Persistent Disk Solid State Drive) "pd-standard" (Persistent Disk Hard Disk Drive) "pd-balanced" (Balanced Persistent Disk) "pd-extreme" (Extreme Persistent Disk) "hyperdisk-balanced" (Hyperdisk Balanced) "hyperdisk-extreme" (Hyperdisk Extreme) "hyperdisk-balanced-high-availability" (Hyperdisk Balanced High Availability) "hyperdisk-ml" (Hyperdisk ML) "hyperdisk-throughput" (Hyperdisk Throughput) }, }, "dataformRepositorySource": { # The Dataform Repository containing the input notebook. # The Dataform Repository pointing to a single file notebook repository. @@ -286,9 +286,9 @@

Method Details

"network": "A String", # The full name of the Google Compute Engine [network](https://cloud.google.com//compute/docs/networks-and-firewalls#networks) "subnetwork": "A String", # The name of the subnet that this instance is in. Format: `projects/{project_id_or_number}/regions/{region}/subnetworks/{subnetwork_id}` }, - "persistentDiskSpec": { # Represents the spec of persistent disk options. # The specification of a persistent disk to attach for the execution job. + "persistentDiskSpec": { # Represents the spec of persistent disk and hyperdisk options. # The specification of a persistent disk to attach for the execution job. "diskSizeGb": "A String", # Size in GB of the disk (default is 100GB). - "diskType": "A String", # Type of the disk (default is "pd-standard"). Valid values: "pd-ssd" (Persistent Disk Solid State Drive) "pd-standard" (Persistent Disk Hard Disk Drive) "pd-balanced" (Balanced Persistent Disk) "pd-extreme" (Extreme Persistent Disk) + "diskType": "A String", # Type of the disk (default is "pd-standard"). Valid values: "pd-ssd" (Persistent Disk Solid State Drive) "pd-standard" (Persistent Disk Hard Disk Drive) "pd-balanced" (Balanced Persistent Disk) "pd-extreme" (Extreme Persistent Disk) "hyperdisk-balanced" (Hyperdisk Balanced) "hyperdisk-extreme" (Hyperdisk Extreme) "hyperdisk-balanced-high-availability" (Hyperdisk Balanced High Availability) "hyperdisk-ml" (Hyperdisk ML) "hyperdisk-throughput" (Hyperdisk Throughput) }, }, "dataformRepositorySource": { # The Dataform Repository containing the input notebook. # The Dataform Repository pointing to a single file notebook repository. @@ -381,9 +381,9 @@

Method Details

"network": "A String", # The full name of the Google Compute Engine [network](https://cloud.google.com//compute/docs/networks-and-firewalls#networks) "subnetwork": "A String", # The name of the subnet that this instance is in. Format: `projects/{project_id_or_number}/regions/{region}/subnetworks/{subnetwork_id}` }, - "persistentDiskSpec": { # Represents the spec of persistent disk options. # The specification of a persistent disk to attach for the execution job. + "persistentDiskSpec": { # Represents the spec of persistent disk and hyperdisk options. # The specification of a persistent disk to attach for the execution job. "diskSizeGb": "A String", # Size in GB of the disk (default is 100GB). - "diskType": "A String", # Type of the disk (default is "pd-standard"). Valid values: "pd-ssd" (Persistent Disk Solid State Drive) "pd-standard" (Persistent Disk Hard Disk Drive) "pd-balanced" (Balanced Persistent Disk) "pd-extreme" (Extreme Persistent Disk) + "diskType": "A String", # Type of the disk (default is "pd-standard"). Valid values: "pd-ssd" (Persistent Disk Solid State Drive) "pd-standard" (Persistent Disk Hard Disk Drive) "pd-balanced" (Balanced Persistent Disk) "pd-extreme" (Extreme Persistent Disk) "hyperdisk-balanced" (Hyperdisk Balanced) "hyperdisk-extreme" (Hyperdisk Extreme) "hyperdisk-balanced-high-availability" (Hyperdisk Balanced High Availability) "hyperdisk-ml" (Hyperdisk ML) "hyperdisk-throughput" (Hyperdisk Throughput) }, }, "dataformRepositorySource": { # The Dataform Repository containing the input notebook. # The Dataform Repository pointing to a single file notebook repository. diff --git a/docs/dyn/aiplatform_v1.projects.locations.notebookRuntimeTemplates.html b/docs/dyn/aiplatform_v1.projects.locations.notebookRuntimeTemplates.html index 3c75c241ee..3e8178c8da 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.notebookRuntimeTemplates.html +++ b/docs/dyn/aiplatform_v1.projects.locations.notebookRuntimeTemplates.html @@ -126,9 +126,9 @@

Method Details

{ # A template that specifies runtime configurations such as machine type, runtime version, network configurations, etc. Multiple runtimes can be created from a runtime template. "createTime": "A String", # Output only. Timestamp when this NotebookRuntimeTemplate was created. - "dataPersistentDiskSpec": { # Represents the spec of persistent disk options. # Optional. The specification of persistent disk attached to the runtime as data disk storage. + "dataPersistentDiskSpec": { # Represents the spec of persistent disk and hyperdisk options. # Optional. The specification of persistent disk attached to the runtime as data disk storage. "diskSizeGb": "A String", # Size in GB of the disk (default is 100GB). - "diskType": "A String", # Type of the disk (default is "pd-standard"). Valid values: "pd-ssd" (Persistent Disk Solid State Drive) "pd-standard" (Persistent Disk Hard Disk Drive) "pd-balanced" (Balanced Persistent Disk) "pd-extreme" (Extreme Persistent Disk) + "diskType": "A String", # Type of the disk (default is "pd-standard"). Valid values: "pd-ssd" (Persistent Disk Solid State Drive) "pd-standard" (Persistent Disk Hard Disk Drive) "pd-balanced" (Balanced Persistent Disk) "pd-extreme" (Extreme Persistent Disk) "hyperdisk-balanced" (Hyperdisk Balanced) "hyperdisk-extreme" (Hyperdisk Extreme) "hyperdisk-balanced-high-availability" (Hyperdisk Balanced High Availability) "hyperdisk-ml" (Hyperdisk ML) "hyperdisk-throughput" (Hyperdisk Throughput) }, "description": "A String", # The description of the NotebookRuntimeTemplate. "displayName": "A String", # Required. The display name of the NotebookRuntimeTemplate. The name can be up to 128 characters long and can consist of any UTF-8 characters. @@ -284,9 +284,9 @@

Method Details

{ # A template that specifies runtime configurations such as machine type, runtime version, network configurations, etc. Multiple runtimes can be created from a runtime template. "createTime": "A String", # Output only. Timestamp when this NotebookRuntimeTemplate was created. - "dataPersistentDiskSpec": { # Represents the spec of persistent disk options. # Optional. The specification of persistent disk attached to the runtime as data disk storage. + "dataPersistentDiskSpec": { # Represents the spec of persistent disk and hyperdisk options. # Optional. The specification of persistent disk attached to the runtime as data disk storage. "diskSizeGb": "A String", # Size in GB of the disk (default is 100GB). - "diskType": "A String", # Type of the disk (default is "pd-standard"). Valid values: "pd-ssd" (Persistent Disk Solid State Drive) "pd-standard" (Persistent Disk Hard Disk Drive) "pd-balanced" (Balanced Persistent Disk) "pd-extreme" (Extreme Persistent Disk) + "diskType": "A String", # Type of the disk (default is "pd-standard"). Valid values: "pd-ssd" (Persistent Disk Solid State Drive) "pd-standard" (Persistent Disk Hard Disk Drive) "pd-balanced" (Balanced Persistent Disk) "pd-extreme" (Extreme Persistent Disk) "hyperdisk-balanced" (Hyperdisk Balanced) "hyperdisk-extreme" (Hyperdisk Extreme) "hyperdisk-balanced-high-availability" (Hyperdisk Balanced High Availability) "hyperdisk-ml" (Hyperdisk ML) "hyperdisk-throughput" (Hyperdisk Throughput) }, "description": "A String", # The description of the NotebookRuntimeTemplate. "displayName": "A String", # Required. The display name of the NotebookRuntimeTemplate. The name can be up to 128 characters long and can consist of any UTF-8 characters. @@ -421,9 +421,9 @@

Method Details

"notebookRuntimeTemplates": [ # List of NotebookRuntimeTemplates in the requested page. { # A template that specifies runtime configurations such as machine type, runtime version, network configurations, etc. Multiple runtimes can be created from a runtime template. "createTime": "A String", # Output only. Timestamp when this NotebookRuntimeTemplate was created. - "dataPersistentDiskSpec": { # Represents the spec of persistent disk options. # Optional. The specification of persistent disk attached to the runtime as data disk storage. + "dataPersistentDiskSpec": { # Represents the spec of persistent disk and hyperdisk options. # Optional. The specification of persistent disk attached to the runtime as data disk storage. "diskSizeGb": "A String", # Size in GB of the disk (default is 100GB). - "diskType": "A String", # Type of the disk (default is "pd-standard"). Valid values: "pd-ssd" (Persistent Disk Solid State Drive) "pd-standard" (Persistent Disk Hard Disk Drive) "pd-balanced" (Balanced Persistent Disk) "pd-extreme" (Extreme Persistent Disk) + "diskType": "A String", # Type of the disk (default is "pd-standard"). Valid values: "pd-ssd" (Persistent Disk Solid State Drive) "pd-standard" (Persistent Disk Hard Disk Drive) "pd-balanced" (Balanced Persistent Disk) "pd-extreme" (Extreme Persistent Disk) "hyperdisk-balanced" (Hyperdisk Balanced) "hyperdisk-extreme" (Hyperdisk Extreme) "hyperdisk-balanced-high-availability" (Hyperdisk Balanced High Availability) "hyperdisk-ml" (Hyperdisk ML) "hyperdisk-throughput" (Hyperdisk Throughput) }, "description": "A String", # The description of the NotebookRuntimeTemplate. "displayName": "A String", # Required. The display name of the NotebookRuntimeTemplate. The name can be up to 128 characters long and can consist of any UTF-8 characters. @@ -526,9 +526,9 @@

Method Details

{ # A template that specifies runtime configurations such as machine type, runtime version, network configurations, etc. Multiple runtimes can be created from a runtime template. "createTime": "A String", # Output only. Timestamp when this NotebookRuntimeTemplate was created. - "dataPersistentDiskSpec": { # Represents the spec of persistent disk options. # Optional. The specification of persistent disk attached to the runtime as data disk storage. + "dataPersistentDiskSpec": { # Represents the spec of persistent disk and hyperdisk options. # Optional. The specification of persistent disk attached to the runtime as data disk storage. "diskSizeGb": "A String", # Size in GB of the disk (default is 100GB). - "diskType": "A String", # Type of the disk (default is "pd-standard"). Valid values: "pd-ssd" (Persistent Disk Solid State Drive) "pd-standard" (Persistent Disk Hard Disk Drive) "pd-balanced" (Balanced Persistent Disk) "pd-extreme" (Extreme Persistent Disk) + "diskType": "A String", # Type of the disk (default is "pd-standard"). Valid values: "pd-ssd" (Persistent Disk Solid State Drive) "pd-standard" (Persistent Disk Hard Disk Drive) "pd-balanced" (Balanced Persistent Disk) "pd-extreme" (Extreme Persistent Disk) "hyperdisk-balanced" (Hyperdisk Balanced) "hyperdisk-extreme" (Hyperdisk Extreme) "hyperdisk-balanced-high-availability" (Hyperdisk Balanced High Availability) "hyperdisk-ml" (Hyperdisk ML) "hyperdisk-throughput" (Hyperdisk Throughput) }, "description": "A String", # The description of the NotebookRuntimeTemplate. "displayName": "A String", # Required. The display name of the NotebookRuntimeTemplate. The name can be up to 128 characters long and can consist of any UTF-8 characters. @@ -614,9 +614,9 @@

Method Details

{ # A template that specifies runtime configurations such as machine type, runtime version, network configurations, etc. Multiple runtimes can be created from a runtime template. "createTime": "A String", # Output only. Timestamp when this NotebookRuntimeTemplate was created. - "dataPersistentDiskSpec": { # Represents the spec of persistent disk options. # Optional. The specification of persistent disk attached to the runtime as data disk storage. + "dataPersistentDiskSpec": { # Represents the spec of persistent disk and hyperdisk options. # Optional. The specification of persistent disk attached to the runtime as data disk storage. "diskSizeGb": "A String", # Size in GB of the disk (default is 100GB). - "diskType": "A String", # Type of the disk (default is "pd-standard"). Valid values: "pd-ssd" (Persistent Disk Solid State Drive) "pd-standard" (Persistent Disk Hard Disk Drive) "pd-balanced" (Balanced Persistent Disk) "pd-extreme" (Extreme Persistent Disk) + "diskType": "A String", # Type of the disk (default is "pd-standard"). Valid values: "pd-ssd" (Persistent Disk Solid State Drive) "pd-standard" (Persistent Disk Hard Disk Drive) "pd-balanced" (Balanced Persistent Disk) "pd-extreme" (Extreme Persistent Disk) "hyperdisk-balanced" (Hyperdisk Balanced) "hyperdisk-extreme" (Hyperdisk Extreme) "hyperdisk-balanced-high-availability" (Hyperdisk Balanced High Availability) "hyperdisk-ml" (Hyperdisk ML) "hyperdisk-throughput" (Hyperdisk Throughput) }, "description": "A String", # The description of the NotebookRuntimeTemplate. "displayName": "A String", # Required. The display name of the NotebookRuntimeTemplate. The name can be up to 128 characters long and can consist of any UTF-8 characters. diff --git a/docs/dyn/aiplatform_v1.projects.locations.notebookRuntimes.html b/docs/dyn/aiplatform_v1.projects.locations.notebookRuntimes.html index 5bd64dc5fd..aed6b1a060 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.notebookRuntimes.html +++ b/docs/dyn/aiplatform_v1.projects.locations.notebookRuntimes.html @@ -119,9 +119,9 @@

Method Details

{ # Request message for NotebookService.AssignNotebookRuntime. "notebookRuntime": { # A runtime is a virtual machine allocated to a particular user for a particular Notebook file on temporary basis with lifetime. Default runtimes have a lifetime of 18 hours, while custom runtimes last for 6 months from their creation or last upgrade. # Required. Provide runtime specific information (e.g. runtime owner, notebook id) used for NotebookRuntime assignment. "createTime": "A String", # Output only. Timestamp when this NotebookRuntime was created. - "dataPersistentDiskSpec": { # Represents the spec of persistent disk options. # Output only. The specification of persistent disk attached to the notebook runtime as data disk storage. + "dataPersistentDiskSpec": { # Represents the spec of persistent disk and hyperdisk options. # Output only. The specification of persistent disk attached to the notebook runtime as data disk storage. "diskSizeGb": "A String", # Size in GB of the disk (default is 100GB). - "diskType": "A String", # Type of the disk (default is "pd-standard"). Valid values: "pd-ssd" (Persistent Disk Solid State Drive) "pd-standard" (Persistent Disk Hard Disk Drive) "pd-balanced" (Balanced Persistent Disk) "pd-extreme" (Extreme Persistent Disk) + "diskType": "A String", # Type of the disk (default is "pd-standard"). Valid values: "pd-ssd" (Persistent Disk Solid State Drive) "pd-standard" (Persistent Disk Hard Disk Drive) "pd-balanced" (Balanced Persistent Disk) "pd-extreme" (Extreme Persistent Disk) "hyperdisk-balanced" (Hyperdisk Balanced) "hyperdisk-extreme" (Hyperdisk Extreme) "hyperdisk-balanced-high-availability" (Hyperdisk Balanced High Availability) "hyperdisk-ml" (Hyperdisk ML) "hyperdisk-throughput" (Hyperdisk Throughput) }, "description": "A String", # The description of the NotebookRuntime. "displayName": "A String", # Required. The display name of the NotebookRuntime. The name can be up to 128 characters long and can consist of any UTF-8 characters. @@ -294,9 +294,9 @@

Method Details

{ # A runtime is a virtual machine allocated to a particular user for a particular Notebook file on temporary basis with lifetime. Default runtimes have a lifetime of 18 hours, while custom runtimes last for 6 months from their creation or last upgrade. "createTime": "A String", # Output only. Timestamp when this NotebookRuntime was created. - "dataPersistentDiskSpec": { # Represents the spec of persistent disk options. # Output only. The specification of persistent disk attached to the notebook runtime as data disk storage. + "dataPersistentDiskSpec": { # Represents the spec of persistent disk and hyperdisk options. # Output only. The specification of persistent disk attached to the notebook runtime as data disk storage. "diskSizeGb": "A String", # Size in GB of the disk (default is 100GB). - "diskType": "A String", # Type of the disk (default is "pd-standard"). Valid values: "pd-ssd" (Persistent Disk Solid State Drive) "pd-standard" (Persistent Disk Hard Disk Drive) "pd-balanced" (Balanced Persistent Disk) "pd-extreme" (Extreme Persistent Disk) + "diskType": "A String", # Type of the disk (default is "pd-standard"). Valid values: "pd-ssd" (Persistent Disk Solid State Drive) "pd-standard" (Persistent Disk Hard Disk Drive) "pd-balanced" (Balanced Persistent Disk) "pd-extreme" (Extreme Persistent Disk) "hyperdisk-balanced" (Hyperdisk Balanced) "hyperdisk-extreme" (Hyperdisk Extreme) "hyperdisk-balanced-high-availability" (Hyperdisk Balanced High Availability) "hyperdisk-ml" (Hyperdisk ML) "hyperdisk-throughput" (Hyperdisk Throughput) }, "description": "A String", # The description of the NotebookRuntime. "displayName": "A String", # Required. The display name of the NotebookRuntime. The name can be up to 128 characters long and can consist of any UTF-8 characters. @@ -406,9 +406,9 @@

Method Details

"notebookRuntimes": [ # List of NotebookRuntimes in the requested page. { # A runtime is a virtual machine allocated to a particular user for a particular Notebook file on temporary basis with lifetime. Default runtimes have a lifetime of 18 hours, while custom runtimes last for 6 months from their creation or last upgrade. "createTime": "A String", # Output only. Timestamp when this NotebookRuntime was created. - "dataPersistentDiskSpec": { # Represents the spec of persistent disk options. # Output only. The specification of persistent disk attached to the notebook runtime as data disk storage. + "dataPersistentDiskSpec": { # Represents the spec of persistent disk and hyperdisk options. # Output only. The specification of persistent disk attached to the notebook runtime as data disk storage. "diskSizeGb": "A String", # Size in GB of the disk (default is 100GB). - "diskType": "A String", # Type of the disk (default is "pd-standard"). Valid values: "pd-ssd" (Persistent Disk Solid State Drive) "pd-standard" (Persistent Disk Hard Disk Drive) "pd-balanced" (Balanced Persistent Disk) "pd-extreme" (Extreme Persistent Disk) + "diskType": "A String", # Type of the disk (default is "pd-standard"). Valid values: "pd-ssd" (Persistent Disk Solid State Drive) "pd-standard" (Persistent Disk Hard Disk Drive) "pd-balanced" (Balanced Persistent Disk) "pd-extreme" (Extreme Persistent Disk) "hyperdisk-balanced" (Hyperdisk Balanced) "hyperdisk-extreme" (Hyperdisk Extreme) "hyperdisk-balanced-high-availability" (Hyperdisk Balanced High Availability) "hyperdisk-ml" (Hyperdisk ML) "hyperdisk-throughput" (Hyperdisk Throughput) }, "description": "A String", # The description of the NotebookRuntime. "displayName": "A String", # Required. The display name of the NotebookRuntime. The name can be up to 128 characters long and can consist of any UTF-8 characters. diff --git a/docs/dyn/aiplatform_v1.projects.locations.publishers.models.html b/docs/dyn/aiplatform_v1.projects.locations.publishers.models.html index b5e97ef962..f4676f6faf 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.publishers.models.html +++ b/docs/dyn/aiplatform_v1.projects.locations.publishers.models.html @@ -529,6 +529,12 @@

Method Details

"A String", ], }, + "exaAiSearch": { # ExaAiSearch tool type. A tool that uses the Exa.ai search engine for grounding. # Optional. Uses Exa.ai to search for information to answer user queries. The search results will be grounded on Exa.ai and presented to the model for response generation + "apiKey": "A String", # Required. The API key for ExaAiSearch. + "customConfigs": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. + "a_key": "", # Properties of the object. + }, + }, "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "behavior": "A String", # Optional. Specifies the function Behavior. If not specified, the system keeps the current function call behavior. This field is currently only supported by the BidiGenerateContent method. @@ -1263,6 +1269,12 @@

Method Details

"A String", ], }, + "exaAiSearch": { # ExaAiSearch tool type. A tool that uses the Exa.ai search engine for grounding. # Optional. Uses Exa.ai to search for information to answer user queries. The search results will be grounded on Exa.ai and presented to the model for response generation + "apiKey": "A String", # Required. The API key for ExaAiSearch. + "customConfigs": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. + "a_key": "", # Properties of the object. + }, + }, "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "behavior": "A String", # Optional. Specifies the function Behavior. If not specified, the system keeps the current function call behavior. This field is currently only supported by the BidiGenerateContent method. @@ -2390,6 +2402,12 @@

Method Details

"A String", ], }, + "exaAiSearch": { # ExaAiSearch tool type. A tool that uses the Exa.ai search engine for grounding. # Optional. Uses Exa.ai to search for information to answer user queries. The search results will be grounded on Exa.ai and presented to the model for response generation + "apiKey": "A String", # Required. The API key for ExaAiSearch. + "customConfigs": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. + "a_key": "", # Properties of the object. + }, + }, "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "behavior": "A String", # Optional. Specifies the function Behavior. If not specified, the system keeps the current function call behavior. This field is currently only supported by the BidiGenerateContent method. diff --git a/docs/dyn/aiplatform_v1.projects.locations.reasoningEngines.memories.html b/docs/dyn/aiplatform_v1.projects.locations.reasoningEngines.memories.html index 940999c606..200d5512e4 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.reasoningEngines.memories.html +++ b/docs/dyn/aiplatform_v1.projects.locations.reasoningEngines.memories.html @@ -559,7 +559,7 @@

Method Details

"updateTime": "A String", # Output only. Represents the timestamp when this Memory was most recently updated. } - updateMask: string, Optional. Mask specifying which fields to update. Supported fields: * `display_name` * `description` * `fact` + updateMask: string, Optional. Mask specifying which fields to update. The following fields are immutable: * `scope` * `memory_type` x__xgafv: string, V1 error format. Allowed values 1 - v1 error format diff --git a/docs/dyn/aiplatform_v1.projects.locations.reasoningEngines.sandboxEnvironmentTemplates.html b/docs/dyn/aiplatform_v1.projects.locations.reasoningEngines.sandboxEnvironmentTemplates.html index 29b0d1e5f9..09c27cb5bf 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.reasoningEngines.sandboxEnvironmentTemplates.html +++ b/docs/dyn/aiplatform_v1.projects.locations.reasoningEngines.sandboxEnvironmentTemplates.html @@ -135,6 +135,14 @@

Method Details

}, "defaultContainerEnvironment": { # The default sandbox runtime environment for default container workloads. # The sandbox environment for default container workloads. "defaultContainerCategory": "A String", # Required. The category of the default container image. + "resources": { # Message to define resource requests and limits (mirroring Kubernetes) for each sandbox instance created from this template. # Optional. Resource requests and limits for the default container. + "limits": { # Optional. The maximum amounts of compute resources allowed. Keys are resource names (e.g., "cpu", "memory"). Values are quantities (e.g., "500m", "1Gi"). + "a_key": "A String", + }, + "requests": { # Optional. The requested amounts of compute resources. Keys are resource names (e.g., "cpu", "memory"). Values are quantities (e.g., "250m", "512Mi"). + "a_key": "A String", + }, + }, }, "displayName": "A String", # Required. The display name of the SandboxEnvironmentTemplate. "egressControlConfig": { # Configuration for egress control of sandbox instances. # Optional. The configuration for egress control of this template. @@ -246,6 +254,14 @@

Method Details

}, "defaultContainerEnvironment": { # The default sandbox runtime environment for default container workloads. # The sandbox environment for default container workloads. "defaultContainerCategory": "A String", # Required. The category of the default container image. + "resources": { # Message to define resource requests and limits (mirroring Kubernetes) for each sandbox instance created from this template. # Optional. Resource requests and limits for the default container. + "limits": { # Optional. The maximum amounts of compute resources allowed. Keys are resource names (e.g., "cpu", "memory"). Values are quantities (e.g., "500m", "1Gi"). + "a_key": "A String", + }, + "requests": { # Optional. The requested amounts of compute resources. Keys are resource names (e.g., "cpu", "memory"). Values are quantities (e.g., "250m", "512Mi"). + "a_key": "A String", + }, + }, }, "displayName": "A String", # Required. The display name of the SandboxEnvironmentTemplate. "egressControlConfig": { # Configuration for egress control of sandbox instances. # Optional. The configuration for egress control of this template. @@ -300,6 +316,14 @@

Method Details

}, "defaultContainerEnvironment": { # The default sandbox runtime environment for default container workloads. # The sandbox environment for default container workloads. "defaultContainerCategory": "A String", # Required. The category of the default container image. + "resources": { # Message to define resource requests and limits (mirroring Kubernetes) for each sandbox instance created from this template. # Optional. Resource requests and limits for the default container. + "limits": { # Optional. The maximum amounts of compute resources allowed. Keys are resource names (e.g., "cpu", "memory"). Values are quantities (e.g., "500m", "1Gi"). + "a_key": "A String", + }, + "requests": { # Optional. The requested amounts of compute resources. Keys are resource names (e.g., "cpu", "memory"). Values are quantities (e.g., "250m", "512Mi"). + "a_key": "A String", + }, + }, }, "displayName": "A String", # Required. The display name of the SandboxEnvironmentTemplate. "egressControlConfig": { # Configuration for egress control of sandbox instances. # Optional. The configuration for egress control of this template. diff --git a/docs/dyn/aiplatform_v1.projects.locations.schedules.html b/docs/dyn/aiplatform_v1.projects.locations.schedules.html index 1e757c9b50..2b7253ec17 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.schedules.html +++ b/docs/dyn/aiplatform_v1.projects.locations.schedules.html @@ -147,9 +147,9 @@

Method Details

"network": "A String", # The full name of the Google Compute Engine [network](https://cloud.google.com//compute/docs/networks-and-firewalls#networks) "subnetwork": "A String", # The name of the subnet that this instance is in. Format: `projects/{project_id_or_number}/regions/{region}/subnetworks/{subnetwork_id}` }, - "persistentDiskSpec": { # Represents the spec of persistent disk options. # The specification of a persistent disk to attach for the execution job. + "persistentDiskSpec": { # Represents the spec of persistent disk and hyperdisk options. # The specification of a persistent disk to attach for the execution job. "diskSizeGb": "A String", # Size in GB of the disk (default is 100GB). - "diskType": "A String", # Type of the disk (default is "pd-standard"). Valid values: "pd-ssd" (Persistent Disk Solid State Drive) "pd-standard" (Persistent Disk Hard Disk Drive) "pd-balanced" (Balanced Persistent Disk) "pd-extreme" (Extreme Persistent Disk) + "diskType": "A String", # Type of the disk (default is "pd-standard"). Valid values: "pd-ssd" (Persistent Disk Solid State Drive) "pd-standard" (Persistent Disk Hard Disk Drive) "pd-balanced" (Balanced Persistent Disk) "pd-extreme" (Extreme Persistent Disk) "hyperdisk-balanced" (Hyperdisk Balanced) "hyperdisk-extreme" (Hyperdisk Extreme) "hyperdisk-balanced-high-availability" (Hyperdisk Balanced High Availability) "hyperdisk-ml" (Hyperdisk ML) "hyperdisk-throughput" (Hyperdisk Throughput) }, }, "dataformRepositorySource": { # The Dataform Repository containing the input notebook. # The Dataform Repository pointing to a single file notebook repository. @@ -480,9 +480,9 @@

Method Details

"network": "A String", # The full name of the Google Compute Engine [network](https://cloud.google.com//compute/docs/networks-and-firewalls#networks) "subnetwork": "A String", # The name of the subnet that this instance is in. Format: `projects/{project_id_or_number}/regions/{region}/subnetworks/{subnetwork_id}` }, - "persistentDiskSpec": { # Represents the spec of persistent disk options. # The specification of a persistent disk to attach for the execution job. + "persistentDiskSpec": { # Represents the spec of persistent disk and hyperdisk options. # The specification of a persistent disk to attach for the execution job. "diskSizeGb": "A String", # Size in GB of the disk (default is 100GB). - "diskType": "A String", # Type of the disk (default is "pd-standard"). Valid values: "pd-ssd" (Persistent Disk Solid State Drive) "pd-standard" (Persistent Disk Hard Disk Drive) "pd-balanced" (Balanced Persistent Disk) "pd-extreme" (Extreme Persistent Disk) + "diskType": "A String", # Type of the disk (default is "pd-standard"). Valid values: "pd-ssd" (Persistent Disk Solid State Drive) "pd-standard" (Persistent Disk Hard Disk Drive) "pd-balanced" (Balanced Persistent Disk) "pd-extreme" (Extreme Persistent Disk) "hyperdisk-balanced" (Hyperdisk Balanced) "hyperdisk-extreme" (Hyperdisk Extreme) "hyperdisk-balanced-high-availability" (Hyperdisk Balanced High Availability) "hyperdisk-ml" (Hyperdisk ML) "hyperdisk-throughput" (Hyperdisk Throughput) }, }, "dataformRepositorySource": { # The Dataform Repository containing the input notebook. # The Dataform Repository pointing to a single file notebook repository. @@ -855,9 +855,9 @@

Method Details

"network": "A String", # The full name of the Google Compute Engine [network](https://cloud.google.com//compute/docs/networks-and-firewalls#networks) "subnetwork": "A String", # The name of the subnet that this instance is in. Format: `projects/{project_id_or_number}/regions/{region}/subnetworks/{subnetwork_id}` }, - "persistentDiskSpec": { # Represents the spec of persistent disk options. # The specification of a persistent disk to attach for the execution job. + "persistentDiskSpec": { # Represents the spec of persistent disk and hyperdisk options. # The specification of a persistent disk to attach for the execution job. "diskSizeGb": "A String", # Size in GB of the disk (default is 100GB). - "diskType": "A String", # Type of the disk (default is "pd-standard"). Valid values: "pd-ssd" (Persistent Disk Solid State Drive) "pd-standard" (Persistent Disk Hard Disk Drive) "pd-balanced" (Balanced Persistent Disk) "pd-extreme" (Extreme Persistent Disk) + "diskType": "A String", # Type of the disk (default is "pd-standard"). Valid values: "pd-ssd" (Persistent Disk Solid State Drive) "pd-standard" (Persistent Disk Hard Disk Drive) "pd-balanced" (Balanced Persistent Disk) "pd-extreme" (Extreme Persistent Disk) "hyperdisk-balanced" (Hyperdisk Balanced) "hyperdisk-extreme" (Hyperdisk Extreme) "hyperdisk-balanced-high-availability" (Hyperdisk Balanced High Availability) "hyperdisk-ml" (Hyperdisk ML) "hyperdisk-throughput" (Hyperdisk Throughput) }, }, "dataformRepositorySource": { # The Dataform Repository containing the input notebook. # The Dataform Repository pointing to a single file notebook repository. @@ -1202,9 +1202,9 @@

Method Details

"network": "A String", # The full name of the Google Compute Engine [network](https://cloud.google.com//compute/docs/networks-and-firewalls#networks) "subnetwork": "A String", # The name of the subnet that this instance is in. Format: `projects/{project_id_or_number}/regions/{region}/subnetworks/{subnetwork_id}` }, - "persistentDiskSpec": { # Represents the spec of persistent disk options. # The specification of a persistent disk to attach for the execution job. + "persistentDiskSpec": { # Represents the spec of persistent disk and hyperdisk options. # The specification of a persistent disk to attach for the execution job. "diskSizeGb": "A String", # Size in GB of the disk (default is 100GB). - "diskType": "A String", # Type of the disk (default is "pd-standard"). Valid values: "pd-ssd" (Persistent Disk Solid State Drive) "pd-standard" (Persistent Disk Hard Disk Drive) "pd-balanced" (Balanced Persistent Disk) "pd-extreme" (Extreme Persistent Disk) + "diskType": "A String", # Type of the disk (default is "pd-standard"). Valid values: "pd-ssd" (Persistent Disk Solid State Drive) "pd-standard" (Persistent Disk Hard Disk Drive) "pd-balanced" (Balanced Persistent Disk) "pd-extreme" (Extreme Persistent Disk) "hyperdisk-balanced" (Hyperdisk Balanced) "hyperdisk-extreme" (Hyperdisk Extreme) "hyperdisk-balanced-high-availability" (Hyperdisk Balanced High Availability) "hyperdisk-ml" (Hyperdisk ML) "hyperdisk-throughput" (Hyperdisk Throughput) }, }, "dataformRepositorySource": { # The Dataform Repository containing the input notebook. # The Dataform Repository pointing to a single file notebook repository. @@ -1553,9 +1553,9 @@

Method Details

"network": "A String", # The full name of the Google Compute Engine [network](https://cloud.google.com//compute/docs/networks-and-firewalls#networks) "subnetwork": "A String", # The name of the subnet that this instance is in. Format: `projects/{project_id_or_number}/regions/{region}/subnetworks/{subnetwork_id}` }, - "persistentDiskSpec": { # Represents the spec of persistent disk options. # The specification of a persistent disk to attach for the execution job. + "persistentDiskSpec": { # Represents the spec of persistent disk and hyperdisk options. # The specification of a persistent disk to attach for the execution job. "diskSizeGb": "A String", # Size in GB of the disk (default is 100GB). - "diskType": "A String", # Type of the disk (default is "pd-standard"). Valid values: "pd-ssd" (Persistent Disk Solid State Drive) "pd-standard" (Persistent Disk Hard Disk Drive) "pd-balanced" (Balanced Persistent Disk) "pd-extreme" (Extreme Persistent Disk) + "diskType": "A String", # Type of the disk (default is "pd-standard"). Valid values: "pd-ssd" (Persistent Disk Solid State Drive) "pd-standard" (Persistent Disk Hard Disk Drive) "pd-balanced" (Balanced Persistent Disk) "pd-extreme" (Extreme Persistent Disk) "hyperdisk-balanced" (Hyperdisk Balanced) "hyperdisk-extreme" (Hyperdisk Extreme) "hyperdisk-balanced-high-availability" (Hyperdisk Balanced High Availability) "hyperdisk-ml" (Hyperdisk ML) "hyperdisk-throughput" (Hyperdisk Throughput) }, }, "dataformRepositorySource": { # The Dataform Repository containing the input notebook. # The Dataform Repository pointing to a single file notebook repository. @@ -1887,9 +1887,9 @@

Method Details

"network": "A String", # The full name of the Google Compute Engine [network](https://cloud.google.com//compute/docs/networks-and-firewalls#networks) "subnetwork": "A String", # The name of the subnet that this instance is in. Format: `projects/{project_id_or_number}/regions/{region}/subnetworks/{subnetwork_id}` }, - "persistentDiskSpec": { # Represents the spec of persistent disk options. # The specification of a persistent disk to attach for the execution job. + "persistentDiskSpec": { # Represents the spec of persistent disk and hyperdisk options. # The specification of a persistent disk to attach for the execution job. "diskSizeGb": "A String", # Size in GB of the disk (default is 100GB). - "diskType": "A String", # Type of the disk (default is "pd-standard"). Valid values: "pd-ssd" (Persistent Disk Solid State Drive) "pd-standard" (Persistent Disk Hard Disk Drive) "pd-balanced" (Balanced Persistent Disk) "pd-extreme" (Extreme Persistent Disk) + "diskType": "A String", # Type of the disk (default is "pd-standard"). Valid values: "pd-ssd" (Persistent Disk Solid State Drive) "pd-standard" (Persistent Disk Hard Disk Drive) "pd-balanced" (Balanced Persistent Disk) "pd-extreme" (Extreme Persistent Disk) "hyperdisk-balanced" (Hyperdisk Balanced) "hyperdisk-extreme" (Hyperdisk Extreme) "hyperdisk-balanced-high-availability" (Hyperdisk Balanced High Availability) "hyperdisk-ml" (Hyperdisk ML) "hyperdisk-throughput" (Hyperdisk Throughput) }, }, "dataformRepositorySource": { # The Dataform Repository containing the input notebook. # The Dataform Repository pointing to a single file notebook repository. diff --git a/docs/dyn/aiplatform_v1.publishers.models.html b/docs/dyn/aiplatform_v1.publishers.models.html index 9a358c7eb9..8eca465d6f 100644 --- a/docs/dyn/aiplatform_v1.publishers.models.html +++ b/docs/dyn/aiplatform_v1.publishers.models.html @@ -515,6 +515,12 @@

Method Details

"A String", ], }, + "exaAiSearch": { # ExaAiSearch tool type. A tool that uses the Exa.ai search engine for grounding. # Optional. Uses Exa.ai to search for information to answer user queries. The search results will be grounded on Exa.ai and presented to the model for response generation + "apiKey": "A String", # Required. The API key for ExaAiSearch. + "customConfigs": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. + "a_key": "", # Properties of the object. + }, + }, "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "behavior": "A String", # Optional. Specifies the function Behavior. If not specified, the system keeps the current function call behavior. This field is currently only supported by the BidiGenerateContent method. @@ -1100,6 +1106,12 @@

Method Details

"A String", ], }, + "exaAiSearch": { # ExaAiSearch tool type. A tool that uses the Exa.ai search engine for grounding. # Optional. Uses Exa.ai to search for information to answer user queries. The search results will be grounded on Exa.ai and presented to the model for response generation + "apiKey": "A String", # Required. The API key for ExaAiSearch. + "customConfigs": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. + "a_key": "", # Properties of the object. + }, + }, "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "behavior": "A String", # Optional. Specifies the function Behavior. If not specified, the system keeps the current function call behavior. This field is currently only supported by the BidiGenerateContent method. @@ -2574,6 +2586,12 @@

Method Details

"A String", ], }, + "exaAiSearch": { # ExaAiSearch tool type. A tool that uses the Exa.ai search engine for grounding. # Optional. Uses Exa.ai to search for information to answer user queries. The search results will be grounded on Exa.ai and presented to the model for response generation + "apiKey": "A String", # Required. The API key for ExaAiSearch. + "customConfigs": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. + "a_key": "", # Properties of the object. + }, + }, "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "behavior": "A String", # Optional. Specifies the function Behavior. If not specified, the system keeps the current function call behavior. This field is currently only supported by the BidiGenerateContent method. diff --git a/docs/dyn/aiplatform_v1.reasoningEngines.sandboxEnvironmentTemplates.html b/docs/dyn/aiplatform_v1.reasoningEngines.sandboxEnvironmentTemplates.html index 645d06e1bc..9d0a06baac 100644 --- a/docs/dyn/aiplatform_v1.reasoningEngines.sandboxEnvironmentTemplates.html +++ b/docs/dyn/aiplatform_v1.reasoningEngines.sandboxEnvironmentTemplates.html @@ -135,6 +135,14 @@

Method Details

}, "defaultContainerEnvironment": { # The default sandbox runtime environment for default container workloads. # The sandbox environment for default container workloads. "defaultContainerCategory": "A String", # Required. The category of the default container image. + "resources": { # Message to define resource requests and limits (mirroring Kubernetes) for each sandbox instance created from this template. # Optional. Resource requests and limits for the default container. + "limits": { # Optional. The maximum amounts of compute resources allowed. Keys are resource names (e.g., "cpu", "memory"). Values are quantities (e.g., "500m", "1Gi"). + "a_key": "A String", + }, + "requests": { # Optional. The requested amounts of compute resources. Keys are resource names (e.g., "cpu", "memory"). Values are quantities (e.g., "250m", "512Mi"). + "a_key": "A String", + }, + }, }, "displayName": "A String", # Required. The display name of the SandboxEnvironmentTemplate. "egressControlConfig": { # Configuration for egress control of sandbox instances. # Optional. The configuration for egress control of this template. @@ -246,6 +254,14 @@

Method Details

}, "defaultContainerEnvironment": { # The default sandbox runtime environment for default container workloads. # The sandbox environment for default container workloads. "defaultContainerCategory": "A String", # Required. The category of the default container image. + "resources": { # Message to define resource requests and limits (mirroring Kubernetes) for each sandbox instance created from this template. # Optional. Resource requests and limits for the default container. + "limits": { # Optional. The maximum amounts of compute resources allowed. Keys are resource names (e.g., "cpu", "memory"). Values are quantities (e.g., "500m", "1Gi"). + "a_key": "A String", + }, + "requests": { # Optional. The requested amounts of compute resources. Keys are resource names (e.g., "cpu", "memory"). Values are quantities (e.g., "250m", "512Mi"). + "a_key": "A String", + }, + }, }, "displayName": "A String", # Required. The display name of the SandboxEnvironmentTemplate. "egressControlConfig": { # Configuration for egress control of sandbox instances. # Optional. The configuration for egress control of this template. @@ -300,6 +316,14 @@

Method Details

}, "defaultContainerEnvironment": { # The default sandbox runtime environment for default container workloads. # The sandbox environment for default container workloads. "defaultContainerCategory": "A String", # Required. The category of the default container image. + "resources": { # Message to define resource requests and limits (mirroring Kubernetes) for each sandbox instance created from this template. # Optional. Resource requests and limits for the default container. + "limits": { # Optional. The maximum amounts of compute resources allowed. Keys are resource names (e.g., "cpu", "memory"). Values are quantities (e.g., "500m", "1Gi"). + "a_key": "A String", + }, + "requests": { # Optional. The requested amounts of compute resources. Keys are resource names (e.g., "cpu", "memory"). Values are quantities (e.g., "250m", "512Mi"). + "a_key": "A String", + }, + }, }, "displayName": "A String", # Required. The display name of the SandboxEnvironmentTemplate. "egressControlConfig": { # Configuration for egress control of sandbox instances. # Optional. The configuration for egress control of this template. diff --git a/docs/dyn/aiplatform_v1.v1.html b/docs/dyn/aiplatform_v1.v1.html index c49956c1b0..c4e10e2e39 100644 --- a/docs/dyn/aiplatform_v1.v1.html +++ b/docs/dyn/aiplatform_v1.v1.html @@ -889,6 +889,12 @@

Method Details

"A String", ], }, + "exaAiSearch": { # ExaAiSearch tool type. A tool that uses the Exa.ai search engine for grounding. # Optional. Uses Exa.ai to search for information to answer user queries. The search results will be grounded on Exa.ai and presented to the model for response generation + "apiKey": "A String", # Required. The API key for ExaAiSearch. + "customConfigs": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. + "a_key": "", # Properties of the object. + }, + }, "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "behavior": "A String", # Optional. Specifies the function Behavior. If not specified, the system keeps the current function call behavior. This field is currently only supported by the BidiGenerateContent method. @@ -1199,6 +1205,12 @@

Method Details

"A String", ], }, + "exaAiSearch": { # ExaAiSearch tool type. A tool that uses the Exa.ai search engine for grounding. # Optional. Uses Exa.ai to search for information to answer user queries. The search results will be grounded on Exa.ai and presented to the model for response generation + "apiKey": "A String", # Required. The API key for ExaAiSearch. + "customConfigs": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. + "a_key": "", # Properties of the object. + }, + }, "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "behavior": "A String", # Optional. Specifies the function Behavior. If not specified, the system keeps the current function call behavior. This field is currently only supported by the BidiGenerateContent method. @@ -1580,6 +1592,12 @@

Method Details

"A String", ], }, + "exaAiSearch": { # ExaAiSearch tool type. A tool that uses the Exa.ai search engine for grounding. # Optional. Uses Exa.ai to search for information to answer user queries. The search results will be grounded on Exa.ai and presented to the model for response generation + "apiKey": "A String", # Required. The API key for ExaAiSearch. + "customConfigs": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. + "a_key": "", # Properties of the object. + }, + }, "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "behavior": "A String", # Optional. Specifies the function Behavior. If not specified, the system keeps the current function call behavior. This field is currently only supported by the BidiGenerateContent method. @@ -1803,6 +1821,12 @@

Method Details

"A String", ], }, + "exaAiSearch": { # ExaAiSearch tool type. A tool that uses the Exa.ai search engine for grounding. # Optional. Uses Exa.ai to search for information to answer user queries. The search results will be grounded on Exa.ai and presented to the model for response generation + "apiKey": "A String", # Required. The API key for ExaAiSearch. + "customConfigs": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. + "a_key": "", # Properties of the object. + }, + }, "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "behavior": "A String", # Optional. Specifies the function Behavior. If not specified, the system keeps the current function call behavior. This field is currently only supported by the BidiGenerateContent method. @@ -3960,6 +3984,12 @@

Method Details

"A String", ], }, + "exaAiSearch": { # ExaAiSearch tool type. A tool that uses the Exa.ai search engine for grounding. # Optional. Uses Exa.ai to search for information to answer user queries. The search results will be grounded on Exa.ai and presented to the model for response generation + "apiKey": "A String", # Required. The API key for ExaAiSearch. + "customConfigs": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. + "a_key": "", # Properties of the object. + }, + }, "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "behavior": "A String", # Optional. Specifies the function Behavior. If not specified, the system keeps the current function call behavior. This field is currently only supported by the BidiGenerateContent method. diff --git a/docs/dyn/aiplatform_v1beta1.endpoints.html b/docs/dyn/aiplatform_v1beta1.endpoints.html index 1142b2ef46..47cf2a83fb 100644 --- a/docs/dyn/aiplatform_v1beta1.endpoints.html +++ b/docs/dyn/aiplatform_v1beta1.endpoints.html @@ -531,6 +531,12 @@

Method Details

"A String", ], }, + "exaAiSearch": { # ExaAiSearch tool type. A tool that uses the Exa.ai search engine for grounding. # Optional. Uses Exa.ai to search for information to answer user queries. The search results will be grounded on Exa.ai and presented to the model for response generation + "apiKey": "A String", # Required. The API key for ExaAiSearch. + "customConfigs": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. + "a_key": "", # Properties of the object. + }, + }, "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "behavior": "A String", # Optional. Specifies the function Behavior. If not specified, the system keeps the current function call behavior. This field is currently only supported by the BidiGenerateContent method. @@ -1130,6 +1136,12 @@

Method Details

"A String", ], }, + "exaAiSearch": { # ExaAiSearch tool type. A tool that uses the Exa.ai search engine for grounding. # Optional. Uses Exa.ai to search for information to answer user queries. The search results will be grounded on Exa.ai and presented to the model for response generation + "apiKey": "A String", # Required. The API key for ExaAiSearch. + "customConfigs": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. + "a_key": "", # Properties of the object. + }, + }, "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "behavior": "A String", # Optional. Specifies the function Behavior. If not specified, the system keeps the current function call behavior. This field is currently only supported by the BidiGenerateContent method. @@ -2050,6 +2062,12 @@

Method Details

"A String", ], }, + "exaAiSearch": { # ExaAiSearch tool type. A tool that uses the Exa.ai search engine for grounding. # Optional. Uses Exa.ai to search for information to answer user queries. The search results will be grounded on Exa.ai and presented to the model for response generation + "apiKey": "A String", # Required. The API key for ExaAiSearch. + "customConfigs": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. + "a_key": "", # Properties of the object. + }, + }, "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "behavior": "A String", # Optional. Specifies the function Behavior. If not specified, the system keeps the current function call behavior. This field is currently only supported by the BidiGenerateContent method. diff --git a/docs/dyn/aiplatform_v1beta1.html b/docs/dyn/aiplatform_v1beta1.html index 8b9d912064..85a75c6fa9 100644 --- a/docs/dyn/aiplatform_v1beta1.html +++ b/docs/dyn/aiplatform_v1beta1.html @@ -294,11 +294,6 @@

Instance Methods

Returns the semanticGovernancePolicies Resource.

-

- semanticGovernancePolicyEngine() -

-

Returns the semanticGovernancePolicyEngine Resource.

-

servingProfiles()

diff --git a/docs/dyn/aiplatform_v1beta1.interactions.html b/docs/dyn/aiplatform_v1beta1.interactions.html index d35744131e..196fadd7db 100644 --- a/docs/dyn/aiplatform_v1beta1.interactions.html +++ b/docs/dyn/aiplatform_v1beta1.interactions.html @@ -1031,6 +1031,8 @@

Method Details

], }, "created": "A String", # Required. Output only. The time at which the response was created in ISO 8601 format (YYYY-MM-DDThh:mm:ssZ). + "env_id": "A String", # The environment ID for the interaction. Can be 'remote' for default environment. + "environment_id": "A String", # Output only. The environment ID for the interaction. Only populated if environment config is set in the request. "id": "A String", # Required. Output only. A unique identifier for the interaction completion. "modelInteraction": { # Interaction for generating the completion using models. # Interaction for generating the completion using models. "generation_config": { # Configuration parameters for model interactions. # Input only. Configuration parameters for the model interaction. @@ -1515,6 +1517,28 @@

Method Details

}, ], "previous_interaction_id": "A String", # The ID of the previous interaction, if any. + "remoteEnvironment": { # Configuration for a custom environment. + "networkAllowlist": { # Network egress configuration for the environment. # Allow only specific domains. + "allowlist": [ # List of allowed domains and their configurations. + { # A network egress rule that controls which external domains the environment is allowed to reach. Each rule identifies a target domain and, optionally, a set of HTTP headers to inject into every matching outbound request. + "domain": "A String", # The domain pattern to match for this rule. Use an exact hostname (e.g., `github.com`), a wildcard prefix (e.g., `*.googleapis.com`), or `*` to match all domains. + "transform": { # Headers to inject into requests matching this rule. Key: header name (e.g., "Authorization"). Value: header value (e.g., "Bearer your-token"). + "a_key": "A String", + }, + }, + ], + }, + "networkMode": "A String", # Network egress mode. + "sources": [ + { # A source to be mounted into the environment. + "content": "A String", # The inline content if `type` is `INLINE`. + "encoding": "A String", # Optional encoding for inline content (e.g. `base64`). + "source": "A String", # The source of the environment. For GCS, this is the GCS path. For GitHub, this is the GitHub path. + "target": "A String", # Where the source should appear in the environment. + "type": "A String", + }, + ], + }, "responseFormatList": { "response_formats": [ { @@ -1571,8 +1595,6 @@

Method Details

], }, }, - "video": { # Configuration for video output format. - }, }, ], }, @@ -1630,8 +1652,6 @@

Method Details

], }, }, - "video": { # Configuration for video output format. - }, }, "response_format": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. # Enforces that the generated response is a JSON object that complies with the JSON schema specified in this field. "boolValue": True or False, # Represents a boolean value. @@ -2470,487 +2490,301 @@

Method Details

}, }, "userInput": { # Input provided by the user. - "content": [ - { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mime_type": "A String", # The mime type of the audio. - "sample_rate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mime_type": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mime_type": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "end_index": 42, # End of the attributed segment, exclusive. - "file_citation": { # A file citation annotation. # A file citation annotation. - "custom_metadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiValue - ], + "contentList": { # A list of Content. # The content of the step. An array of Content objects. + "contents": [ # The contents of the list. + { # The content of the response. + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mime_type": "A String", # The mime type of the audio. + "sample_rate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mime_type": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mime_type": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "end_index": 42, # End of the attributed segment, exclusive. + "file_citation": { # A file citation annotation. # A file citation annotation. + "custom_metadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiValue + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiStruct # Represents a structured value. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiStruct # Represents a structured value. }, + ], + }, + "document_uri": "A String", # The URI of the file. + "file_name": "A String", # The name of the file. + "media_id": "A String", # Media ID in-case of image citations, if applicable. + "page_number": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "place_citation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "place_id": "A String", # The ID of the place, in `places/{place_id}` format. + "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "review_id": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, ], + "url": "A String", # URI reference of the place. + }, + "start_index": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "url_citation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, - "document_uri": "A String", # The URI of the file. - "file_name": "A String", # The name of the file. - "media_id": "A String", # Media ID in-case of image citations, if applicable. - "page_number": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "place_citation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "place_id": "A String", # The ID of the place, in `places/{place_id}` format. - "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "review_id": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "start_index": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "url_citation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mime_type": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "end_index": 42, # End of the attributed segment, exclusive. - "file_citation": { # A file citation annotation. # A file citation annotation. - "custom_metadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiValue - ], + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mime_type": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "end_index": 42, # End of the attributed segment, exclusive. + "file_citation": { # A file citation annotation. # A file citation annotation. + "custom_metadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiValue + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiStruct # Represents a structured value. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiStruct # Represents a structured value. }, + ], + }, + "document_uri": "A String", # The URI of the file. + "file_name": "A String", # The name of the file. + "media_id": "A String", # Media ID in-case of image citations, if applicable. + "page_number": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "place_citation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "place_id": "A String", # The ID of the place, in `places/{place_id}` format. + "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "review_id": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, ], + "url": "A String", # URI reference of the place. + }, + "start_index": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "url_citation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, - "document_uri": "A String", # The URI of the file. - "file_name": "A String", # The name of the file. - "media_id": "A String", # Media ID in-case of image citations, if applicable. - "page_number": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "place_citation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "place_id": "A String", # The ID of the place, in `places/{place_id}` format. - "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "review_id": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "start_index": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "url_citation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. }, - }, - ], - "text": "A String", # Required. The text content. + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. }, }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. + "fileSearchCall": { # File Search content. }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiValue - ], + "functionCall": { # A function tool call content block. + "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiValue + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiStruct # Represents a structured value. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiStruct # Represents a structured value. }, - }, - ], + ], + }, + "name": "A String", # Required. The name of the tool to call. }, - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "search_type": "A String", # The type of search grounding enabled. }, - "search_type": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiValue - ], + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiValue + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiStruct # Represents a structured value. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiStruct # Represents a structured value. }, - }, - ], + ], + }, + "name": "A String", # Required. The name of the tool which was called. + "server_name": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, }, - "name": "A String", # Required. The name of the tool which was called. - "server_name": "A String", # Required. The name of the used MCP server. }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", + "toolResult": { # Tool result content. + "call_id": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "is_error": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, ], }, - }, - }, - "toolResult": { # Tool result content. - "call_id": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "is_error": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mime_type": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "end_index": 42, # End of the attributed segment, exclusive. - "file_citation": { # A file citation annotation. # A file citation annotation. - "custom_metadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiValue - ], + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mime_type": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "end_index": 42, # End of the attributed segment, exclusive. + "file_citation": { # A file citation annotation. # A file citation annotation. + "custom_metadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiValue + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiStruct # Represents a structured value. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiStruct # Represents a structured value. }, + ], + }, + "document_uri": "A String", # The URI of the file. + "file_name": "A String", # The name of the file. + "media_id": "A String", # Media ID in-case of image citations, if applicable. + "page_number": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "place_citation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "place_id": "A String", # The ID of the place, in `places/{place_id}` format. + "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "review_id": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, ], + "url": "A String", # URI reference of the place. + }, + "start_index": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "url_citation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, - "document_uri": "A String", # The URI of the file. - "file_name": "A String", # The name of the file. - "media_id": "A String", # Media ID in-case of image citations, if applicable. - "page_number": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "place_citation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "place_id": "A String", # The ID of the place, in `places/{place_id}` format. - "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "review_id": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "start_index": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "url_citation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "is_error": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiValue ], + "text": "A String", # Required. The text content. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiStruct # Represents a structured value. - }, - }, - ], - }, - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "place_id": "A String", # The ID of the place, in `places/{place_id}` format. - "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "review_id": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. }, ], - "widget_context_token": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "is_error": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "search_suggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mime_type": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "end_index": 42, # End of the attributed segment, exclusive. - "file_citation": { # A file citation annotation. # A file citation annotation. - "custom_metadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiValue - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiStruct # Represents a structured value. - }, - }, - ], - }, - "document_uri": "A String", # The URI of the file. - "file_name": "A String", # The name of the file. - "media_id": "A String", # Media ID in-case of image citations, if applicable. - "page_number": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "place_citation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "place_id": "A String", # The ID of the place, in `places/{place_id}` format. - "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "review_id": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "start_index": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "url_citation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "server_name": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiValue - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiStruct # Represents a structured value. - }, - }, - ], - }, - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "is_error": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. }, - ], - }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mime_type": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - ], - }, - }, - ], - }, - "steps": [ # Output only. The steps that make up the interaction. - { # A step in the interaction. - "modelOutput": { # Output generated by the model. - "content": [ - { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mime_type": "A String", # The mime type of the audio. - "sample_rate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mime_type": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mime_type": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "end_index": 42, # End of the attributed segment, exclusive. - "file_citation": { # A file citation annotation. # A file citation annotation. - "custom_metadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. + "is_error": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. { # Represents a single field in a struct. "name": "A String", @@ -2969,46 +2803,235 @@

Method Details

}, ], }, - "document_uri": "A String", # The URI of the file. - "file_name": "A String", # The name of the file. - "media_id": "A String", # Media ID in-case of image citations, if applicable. - "page_number": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. }, - "place_citation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "place_id": "A String", # The ID of the place, in `places/{place_id}` format. - "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "review_id": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "place_id": "A String", # The ID of the place, in `places/{place_id}` format. + "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "review_id": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widget_context_token": "A String", # Resource name of the Google Maps widget context token. }, ], - "url": "A String", # URI reference of the place. - }, - "start_index": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "url_citation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. }, - }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mime_type": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + "googleSearchResult": { # Google Search result content. + "is_error": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "search_suggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mime_type": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "end_index": 42, # End of the attributed segment, exclusive. + "file_citation": { # A file citation annotation. # A file citation annotation. + "custom_metadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiValue + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiStruct # Represents a structured value. + }, + }, + ], + }, + "document_uri": "A String", # The URI of the file. + "file_name": "A String", # The name of the file. + "media_id": "A String", # Media ID in-case of image citations, if applicable. + "page_number": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "place_citation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "place_id": "A String", # The ID of the place, in `places/{place_id}` format. + "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "review_id": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "start_index": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "url_citation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "server_name": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiValue + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiStruct # Represents a structured value. + }, + }, + ], + }, + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "is_error": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mime_type": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + ], + }, + "contentString": "A String", # The content of the step. A single string. + }, + }, + ], + }, + "steps": [ # Required. Output only. The steps that make up the interaction. + { # A step in the interaction. + "modelOutput": { # Output generated by the model. + "content": [ + { # The content of the response. + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mime_type": "A String", # The mime type of the audio. + "sample_rate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mime_type": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mime_type": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "end_index": 42, # End of the attributed segment, exclusive. + "file_citation": { # A file citation annotation. # A file citation annotation. + "custom_metadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiValue + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiStruct # Represents a structured value. + }, + }, + ], + }, + "document_uri": "A String", # The URI of the file. + "file_name": "A String", # The name of the file. + "media_id": "A String", # Media ID in-case of image citations, if applicable. + "page_number": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "place_citation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "place_id": "A String", # The ID of the place, in `places/{place_id}` format. + "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "review_id": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "start_index": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "url_citation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mime_type": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. "end_index": 42, # End of the attributed segment, exclusive. "file_citation": { # A file citation annotation. # A file citation annotation. "custom_metadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. @@ -3740,454 +3763,457 @@

Method Details

}, }, "userInput": { # Input provided by the user. - "content": [ - { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mime_type": "A String", # The mime type of the audio. - "sample_rate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mime_type": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mime_type": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "end_index": 42, # End of the attributed segment, exclusive. - "file_citation": { # A file citation annotation. # A file citation annotation. - "custom_metadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiValue - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiStruct # Represents a structured value. - }, - }, - ], - }, - "document_uri": "A String", # The URI of the file. - "file_name": "A String", # The name of the file. - "media_id": "A String", # Media ID in-case of image citations, if applicable. - "page_number": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "place_citation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "place_id": "A String", # The ID of the place, in `places/{place_id}` format. - "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "review_id": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "start_index": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "url_citation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mime_type": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + "contentList": { # A list of Content. # The content of the step. An array of Content objects. + "contents": [ # The contents of the list. + { # The content of the response. + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mime_type": "A String", # The mime type of the audio. + "sample_rate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mime_type": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mime_type": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "end_index": 42, # End of the attributed segment, exclusive. + "file_citation": { # A file citation annotation. # A file citation annotation. + "custom_metadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiValue + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiStruct # Represents a structured value. + }, + }, + ], + }, + "document_uri": "A String", # The URI of the file. + "file_name": "A String", # The name of the file. + "media_id": "A String", # Media ID in-case of image citations, if applicable. + "page_number": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "place_citation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "place_id": "A String", # The ID of the place, in `places/{place_id}` format. + "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "review_id": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "start_index": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "url_citation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "end_index": 42, # End of the attributed segment, exclusive. - "file_citation": { # A file citation annotation. # A file citation annotation. - "custom_metadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiValue - ], + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mime_type": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "end_index": 42, # End of the attributed segment, exclusive. + "file_citation": { # A file citation annotation. # A file citation annotation. + "custom_metadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiValue + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiStruct # Represents a structured value. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiStruct # Represents a structured value. }, + ], + }, + "document_uri": "A String", # The URI of the file. + "file_name": "A String", # The name of the file. + "media_id": "A String", # Media ID in-case of image citations, if applicable. + "page_number": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "place_citation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "place_id": "A String", # The ID of the place, in `places/{place_id}` format. + "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "review_id": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, ], + "url": "A String", # URI reference of the place. + }, + "start_index": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "url_citation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, - "document_uri": "A String", # The URI of the file. - "file_name": "A String", # The name of the file. - "media_id": "A String", # Media ID in-case of image citations, if applicable. - "page_number": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "place_citation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "place_id": "A String", # The ID of the place, in `places/{place_id}` format. - "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "review_id": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "start_index": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "url_citation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. }, - }, - ], - "text": "A String", # Required. The text content. + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. }, }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. + "fileSearchCall": { # File Search content. }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiValue - ], + "functionCall": { # A function tool call content block. + "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiValue + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiStruct # Represents a structured value. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiStruct # Represents a structured value. }, - }, - ], - }, - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], + ], + }, + "name": "A String", # Required. The name of the tool to call. }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, }, - "search_type": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiValue - ], + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "search_type": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiValue + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiStruct # Represents a structured value. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiStruct # Represents a structured value. }, - }, - ], + ], + }, + "name": "A String", # Required. The name of the tool which was called. + "server_name": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, }, - "name": "A String", # Required. The name of the tool which was called. - "server_name": "A String", # Required. The name of the used MCP server. }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", + "toolResult": { # Tool result content. + "call_id": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "is_error": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, ], }, - }, - }, - "toolResult": { # Tool result content. - "call_id": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "is_error": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mime_type": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "end_index": 42, # End of the attributed segment, exclusive. - "file_citation": { # A file citation annotation. # A file citation annotation. - "custom_metadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiValue - ], + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mime_type": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "end_index": 42, # End of the attributed segment, exclusive. + "file_citation": { # A file citation annotation. # A file citation annotation. + "custom_metadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiValue + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiStruct # Represents a structured value. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiStruct # Represents a structured value. }, + ], + }, + "document_uri": "A String", # The URI of the file. + "file_name": "A String", # The name of the file. + "media_id": "A String", # Media ID in-case of image citations, if applicable. + "page_number": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "place_citation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "place_id": "A String", # The ID of the place, in `places/{place_id}` format. + "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "review_id": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, ], + "url": "A String", # URI reference of the place. + }, + "start_index": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "url_citation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, - "document_uri": "A String", # The URI of the file. - "file_name": "A String", # The name of the file. - "media_id": "A String", # Media ID in-case of image citations, if applicable. - "page_number": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "place_citation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "place_id": "A String", # The ID of the place, in `places/{place_id}` format. - "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "review_id": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "start_index": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "url_citation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "is_error": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiValue ], + "text": "A String", # Required. The text content. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiStruct # Represents a structured value. - }, - }, - ], - }, - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "place_id": "A String", # The ID of the place, in `places/{place_id}` format. - "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "review_id": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. }, ], - "widget_context_token": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "is_error": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "search_suggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mime_type": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + "is_error": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiValue + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiStruct # Represents a structured value. + }, }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "end_index": 42, # End of the attributed segment, exclusive. - "file_citation": { # A file citation annotation. # A file citation annotation. - "custom_metadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiValue - ], + ], + }, + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "place_id": "A String", # The ID of the place, in `places/{place_id}` format. + "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "review_id": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widget_context_token": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "is_error": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "search_suggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mime_type": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "end_index": 42, # End of the attributed segment, exclusive. + "file_citation": { # A file citation annotation. # A file citation annotation. + "custom_metadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiValue + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiStruct # Represents a structured value. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiStruct # Represents a structured value. }, + ], + }, + "document_uri": "A String", # The URI of the file. + "file_name": "A String", # The name of the file. + "media_id": "A String", # Media ID in-case of image citations, if applicable. + "page_number": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "place_citation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "place_id": "A String", # The ID of the place, in `places/{place_id}` format. + "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "review_id": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, ], + "url": "A String", # URI reference of the place. + }, + "start_index": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "url_citation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, - "document_uri": "A String", # The URI of the file. - "file_name": "A String", # The name of the file. - "media_id": "A String", # Media ID in-case of image citations, if applicable. - "page_number": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "place_citation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "place_id": "A String", # The ID of the place, in `places/{place_id}` format. - "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "review_id": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "start_index": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "url_citation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "server_name": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiValue ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "server_name": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiValue + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiStruct # Represents a structured value. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiStruct # Represents a structured value. }, + ], + }, + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "is_error": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. }, ], }, }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "is_error": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], + "video": { # A video content block. + "data": "A String", # The video content. + "mime_type": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. }, }, - "video": { # A video content block. - "data": "A String", # The video content. - "mime_type": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - ], + ], + }, + "contentString": "A String", # The content of the step. A single string. }, }, ], @@ -5740,6 +5766,8 @@

Method Details

], }, "created": "A String", # Required. Output only. The time at which the response was created in ISO 8601 format (YYYY-MM-DDThh:mm:ssZ). + "env_id": "A String", # The environment ID for the interaction. Can be 'remote' for default environment. + "environment_id": "A String", # Output only. The environment ID for the interaction. Only populated if environment config is set in the request. "id": "A String", # Required. Output only. A unique identifier for the interaction completion. "modelInteraction": { # Interaction for generating the completion using models. # Interaction for generating the completion using models. "generation_config": { # Configuration parameters for model interactions. # Input only. Configuration parameters for the model interaction. @@ -6224,6 +6252,28 @@

Method Details

}, ], "previous_interaction_id": "A String", # The ID of the previous interaction, if any. + "remoteEnvironment": { # Configuration for a custom environment. + "networkAllowlist": { # Network egress configuration for the environment. # Allow only specific domains. + "allowlist": [ # List of allowed domains and their configurations. + { # A network egress rule that controls which external domains the environment is allowed to reach. Each rule identifies a target domain and, optionally, a set of HTTP headers to inject into every matching outbound request. + "domain": "A String", # The domain pattern to match for this rule. Use an exact hostname (e.g., `github.com`), a wildcard prefix (e.g., `*.googleapis.com`), or `*` to match all domains. + "transform": { # Headers to inject into requests matching this rule. Key: header name (e.g., "Authorization"). Value: header value (e.g., "Bearer your-token"). + "a_key": "A String", + }, + }, + ], + }, + "networkMode": "A String", # Network egress mode. + "sources": [ + { # A source to be mounted into the environment. + "content": "A String", # The inline content if `type` is `INLINE`. + "encoding": "A String", # Optional encoding for inline content (e.g. `base64`). + "source": "A String", # The source of the environment. For GCS, this is the GCS path. For GitHub, this is the GitHub path. + "target": "A String", # Where the source should appear in the environment. + "type": "A String", + }, + ], + }, "responseFormatList": { "response_formats": [ { @@ -6280,8 +6330,6 @@

Method Details

], }, }, - "video": { # Configuration for video output format. - }, }, ], }, @@ -6339,8 +6387,6 @@

Method Details

], }, }, - "video": { # Configuration for video output format. - }, }, "response_format": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. # Enforces that the generated response is a JSON object that complies with the JSON schema specified in this field. "boolValue": True or False, # Represents a boolean value. @@ -7179,487 +7225,301 @@

Method Details

}, }, "userInput": { # Input provided by the user. - "content": [ - { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mime_type": "A String", # The mime type of the audio. - "sample_rate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mime_type": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mime_type": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "end_index": 42, # End of the attributed segment, exclusive. - "file_citation": { # A file citation annotation. # A file citation annotation. - "custom_metadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiValue - ], + "contentList": { # A list of Content. # The content of the step. An array of Content objects. + "contents": [ # The contents of the list. + { # The content of the response. + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mime_type": "A String", # The mime type of the audio. + "sample_rate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mime_type": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mime_type": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "end_index": 42, # End of the attributed segment, exclusive. + "file_citation": { # A file citation annotation. # A file citation annotation. + "custom_metadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiValue + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiStruct # Represents a structured value. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiStruct # Represents a structured value. }, + ], + }, + "document_uri": "A String", # The URI of the file. + "file_name": "A String", # The name of the file. + "media_id": "A String", # Media ID in-case of image citations, if applicable. + "page_number": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "place_citation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "place_id": "A String", # The ID of the place, in `places/{place_id}` format. + "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "review_id": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, ], + "url": "A String", # URI reference of the place. + }, + "start_index": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "url_citation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, - "document_uri": "A String", # The URI of the file. - "file_name": "A String", # The name of the file. - "media_id": "A String", # Media ID in-case of image citations, if applicable. - "page_number": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "place_citation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "place_id": "A String", # The ID of the place, in `places/{place_id}` format. - "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "review_id": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "start_index": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "url_citation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mime_type": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "end_index": 42, # End of the attributed segment, exclusive. - "file_citation": { # A file citation annotation. # A file citation annotation. - "custom_metadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiValue - ], + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mime_type": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "end_index": 42, # End of the attributed segment, exclusive. + "file_citation": { # A file citation annotation. # A file citation annotation. + "custom_metadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiValue + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiStruct # Represents a structured value. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiStruct # Represents a structured value. }, + ], + }, + "document_uri": "A String", # The URI of the file. + "file_name": "A String", # The name of the file. + "media_id": "A String", # Media ID in-case of image citations, if applicable. + "page_number": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "place_citation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "place_id": "A String", # The ID of the place, in `places/{place_id}` format. + "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "review_id": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, ], + "url": "A String", # URI reference of the place. + }, + "start_index": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "url_citation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, - "document_uri": "A String", # The URI of the file. - "file_name": "A String", # The name of the file. - "media_id": "A String", # Media ID in-case of image citations, if applicable. - "page_number": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "place_citation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "place_id": "A String", # The ID of the place, in `places/{place_id}` format. - "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "review_id": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. }, - "start_index": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "url_citation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiValue + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiStruct # Represents a structured value. }, }, ], - "text": "A String", # Required. The text content. }, + "name": "A String", # Required. The name of the tool to call. }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiValue - ], + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "search_type": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiValue + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiStruct # Represents a structured value. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiStruct # Represents a structured value. }, - }, - ], + ], + }, + "name": "A String", # Required. The name of the tool which was called. + "server_name": "A String", # Required. The name of the used MCP server. }, - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, }, }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], + "toolResult": { # Tool result content. + "call_id": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "is_error": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. }, - "search_type": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiValue - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiStruct # Represents a structured value. - }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. }, ], }, - "name": "A String", # Required. The name of the tool which was called. - "server_name": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, - }, - "toolResult": { # Tool result content. - "call_id": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "is_error": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mime_type": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "end_index": 42, # End of the attributed segment, exclusive. - "file_citation": { # A file citation annotation. # A file citation annotation. - "custom_metadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiValue - ], + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mime_type": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "end_index": 42, # End of the attributed segment, exclusive. + "file_citation": { # A file citation annotation. # A file citation annotation. + "custom_metadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiValue + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiStruct # Represents a structured value. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiStruct # Represents a structured value. }, + ], + }, + "document_uri": "A String", # The URI of the file. + "file_name": "A String", # The name of the file. + "media_id": "A String", # Media ID in-case of image citations, if applicable. + "page_number": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "place_citation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "place_id": "A String", # The ID of the place, in `places/{place_id}` format. + "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "review_id": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, ], + "url": "A String", # URI reference of the place. + }, + "start_index": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "url_citation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, - "document_uri": "A String", # The URI of the file. - "file_name": "A String", # The name of the file. - "media_id": "A String", # Media ID in-case of image citations, if applicable. - "page_number": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "place_citation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "place_id": "A String", # The ID of the place, in `places/{place_id}` format. - "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "review_id": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "start_index": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "url_citation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "is_error": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiValue ], + "text": "A String", # Required. The text content. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiStruct # Represents a structured value. - }, - }, - ], - }, - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "place_id": "A String", # The ID of the place, in `places/{place_id}` format. - "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "review_id": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. }, ], - "widget_context_token": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "is_error": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "search_suggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mime_type": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "end_index": 42, # End of the attributed segment, exclusive. - "file_citation": { # A file citation annotation. # A file citation annotation. - "custom_metadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiValue - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiStruct # Represents a structured value. - }, - }, - ], - }, - "document_uri": "A String", # The URI of the file. - "file_name": "A String", # The name of the file. - "media_id": "A String", # Media ID in-case of image citations, if applicable. - "page_number": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "place_citation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "place_id": "A String", # The ID of the place, in `places/{place_id}` format. - "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "review_id": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "start_index": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "url_citation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "server_name": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiValue - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiStruct # Represents a structured value. - }, - }, - ], - }, - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "is_error": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. }, - ], - }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mime_type": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - ], - }, - }, - ], - }, - "steps": [ # Output only. The steps that make up the interaction. - { # A step in the interaction. - "modelOutput": { # Output generated by the model. - "content": [ - { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mime_type": "A String", # The mime type of the audio. - "sample_rate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mime_type": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mime_type": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "end_index": 42, # End of the attributed segment, exclusive. - "file_citation": { # A file citation annotation. # A file citation annotation. - "custom_metadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. + "is_error": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. { # Represents a single field in a struct. "name": "A String", @@ -7678,72 +7538,261 @@

Method Details

}, ], }, - "document_uri": "A String", # The URI of the file. - "file_name": "A String", # The name of the file. - "media_id": "A String", # Media ID in-case of image citations, if applicable. - "page_number": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. }, - "place_citation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "place_id": "A String", # The ID of the place, in `places/{place_id}` format. - "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "review_id": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "place_id": "A String", # The ID of the place, in `places/{place_id}` format. + "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "review_id": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widget_context_token": "A String", # Resource name of the Google Maps widget context token. }, ], - "url": "A String", # URI reference of the place. - }, - "start_index": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "url_citation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. }, - }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mime_type": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + "googleSearchResult": { # Google Search result content. + "is_error": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "search_suggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "end_index": 42, # End of the attributed segment, exclusive. - "file_citation": { # A file citation annotation. # A file citation annotation. - "custom_metadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiValue - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiStruct # Represents a structured value. - }, - }, - ], - }, - "document_uri": "A String", # The URI of the file. - "file_name": "A String", # The name of the file. - "media_id": "A String", # Media ID in-case of image citations, if applicable. - "page_number": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mime_type": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "end_index": 42, # End of the attributed segment, exclusive. + "file_citation": { # A file citation annotation. # A file citation annotation. + "custom_metadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiValue + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiStruct # Represents a structured value. + }, + }, + ], + }, + "document_uri": "A String", # The URI of the file. + "file_name": "A String", # The name of the file. + "media_id": "A String", # Media ID in-case of image citations, if applicable. + "page_number": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "place_citation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "place_id": "A String", # The ID of the place, in `places/{place_id}` format. + "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "review_id": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "start_index": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "url_citation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "server_name": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiValue + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiStruct # Represents a structured value. + }, + }, + ], + }, + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "is_error": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mime_type": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + ], + }, + "contentString": "A String", # The content of the step. A single string. + }, + }, + ], + }, + "steps": [ # Required. Output only. The steps that make up the interaction. + { # A step in the interaction. + "modelOutput": { # Output generated by the model. + "content": [ + { # The content of the response. + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mime_type": "A String", # The mime type of the audio. + "sample_rate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mime_type": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mime_type": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "end_index": 42, # End of the attributed segment, exclusive. + "file_citation": { # A file citation annotation. # A file citation annotation. + "custom_metadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiValue + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiStruct # Represents a structured value. + }, + }, + ], + }, + "document_uri": "A String", # The URI of the file. + "file_name": "A String", # The name of the file. + "media_id": "A String", # Media ID in-case of image citations, if applicable. + "page_number": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "place_citation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "place_id": "A String", # The ID of the place, in `places/{place_id}` format. + "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "review_id": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "start_index": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "url_citation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mime_type": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "end_index": 42, # End of the attributed segment, exclusive. + "file_citation": { # A file citation annotation. # A file citation annotation. + "custom_metadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiValue + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiStruct # Represents a structured value. + }, + }, + ], + }, + "document_uri": "A String", # The URI of the file. + "file_name": "A String", # The name of the file. + "media_id": "A String", # Media ID in-case of image citations, if applicable. + "page_number": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. }, "place_citation": { # A place citation annotation. # A place citation annotation. "name": "A String", # Title of the place. @@ -8449,454 +8498,457 @@

Method Details

}, }, "userInput": { # Input provided by the user. - "content": [ - { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mime_type": "A String", # The mime type of the audio. - "sample_rate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mime_type": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mime_type": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "end_index": 42, # End of the attributed segment, exclusive. - "file_citation": { # A file citation annotation. # A file citation annotation. - "custom_metadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiValue - ], + "contentList": { # A list of Content. # The content of the step. An array of Content objects. + "contents": [ # The contents of the list. + { # The content of the response. + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mime_type": "A String", # The mime type of the audio. + "sample_rate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mime_type": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mime_type": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "end_index": 42, # End of the attributed segment, exclusive. + "file_citation": { # A file citation annotation. # A file citation annotation. + "custom_metadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiValue + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiStruct # Represents a structured value. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiStruct # Represents a structured value. }, + ], + }, + "document_uri": "A String", # The URI of the file. + "file_name": "A String", # The name of the file. + "media_id": "A String", # Media ID in-case of image citations, if applicable. + "page_number": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "place_citation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "place_id": "A String", # The ID of the place, in `places/{place_id}` format. + "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "review_id": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, ], + "url": "A String", # URI reference of the place. + }, + "start_index": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "url_citation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, - "document_uri": "A String", # The URI of the file. - "file_name": "A String", # The name of the file. - "media_id": "A String", # Media ID in-case of image citations, if applicable. - "page_number": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "place_citation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "place_id": "A String", # The ID of the place, in `places/{place_id}` format. - "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "review_id": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "start_index": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "url_citation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mime_type": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "end_index": 42, # End of the attributed segment, exclusive. - "file_citation": { # A file citation annotation. # A file citation annotation. - "custom_metadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiValue - ], + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mime_type": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "end_index": 42, # End of the attributed segment, exclusive. + "file_citation": { # A file citation annotation. # A file citation annotation. + "custom_metadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiValue + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiStruct # Represents a structured value. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiStruct # Represents a structured value. }, + ], + }, + "document_uri": "A String", # The URI of the file. + "file_name": "A String", # The name of the file. + "media_id": "A String", # Media ID in-case of image citations, if applicable. + "page_number": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "place_citation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "place_id": "A String", # The ID of the place, in `places/{place_id}` format. + "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "review_id": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, ], + "url": "A String", # URI reference of the place. + }, + "start_index": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "url_citation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, - "document_uri": "A String", # The URI of the file. - "file_name": "A String", # The name of the file. - "media_id": "A String", # Media ID in-case of image citations, if applicable. - "page_number": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "place_citation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "place_id": "A String", # The ID of the place, in `places/{place_id}` format. - "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "review_id": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. }, - "start_index": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "url_citation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiValue + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiStruct # Represents a structured value. }, }, ], - "text": "A String", # Required. The text content. }, + "name": "A String", # Required. The name of the tool to call. }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiValue - ], + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "search_type": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiValue + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiStruct # Represents a structured value. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiStruct # Represents a structured value. }, - }, - ], + ], + }, + "name": "A String", # Required. The name of the tool which was called. + "server_name": "A String", # Required. The name of the used MCP server. }, - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, }, }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], + "toolResult": { # Tool result content. + "call_id": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "is_error": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. }, - "search_type": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiValue - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiStruct # Represents a structured value. - }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. }, ], }, - "name": "A String", # Required. The name of the tool which was called. - "server_name": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, - }, - "toolResult": { # Tool result content. - "call_id": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "is_error": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mime_type": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "end_index": 42, # End of the attributed segment, exclusive. - "file_citation": { # A file citation annotation. # A file citation annotation. - "custom_metadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiValue - ], + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mime_type": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "end_index": 42, # End of the attributed segment, exclusive. + "file_citation": { # A file citation annotation. # A file citation annotation. + "custom_metadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiValue + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiStruct # Represents a structured value. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiStruct # Represents a structured value. }, + ], + }, + "document_uri": "A String", # The URI of the file. + "file_name": "A String", # The name of the file. + "media_id": "A String", # Media ID in-case of image citations, if applicable. + "page_number": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "place_citation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "place_id": "A String", # The ID of the place, in `places/{place_id}` format. + "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "review_id": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, ], + "url": "A String", # URI reference of the place. + }, + "start_index": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "url_citation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, - "document_uri": "A String", # The URI of the file. - "file_name": "A String", # The name of the file. - "media_id": "A String", # Media ID in-case of image citations, if applicable. - "page_number": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "place_citation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "place_id": "A String", # The ID of the place, in `places/{place_id}` format. - "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "review_id": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "start_index": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "url_citation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "is_error": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiValue ], + "text": "A String", # Required. The text content. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiStruct # Represents a structured value. - }, - }, - ], - }, - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "place_id": "A String", # The ID of the place, in `places/{place_id}` format. - "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "review_id": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. }, ], - "widget_context_token": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "is_error": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "search_suggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mime_type": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + "is_error": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiValue + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiStruct # Represents a structured value. + }, }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "end_index": 42, # End of the attributed segment, exclusive. - "file_citation": { # A file citation annotation. # A file citation annotation. - "custom_metadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiValue - ], + ], + }, + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "place_id": "A String", # The ID of the place, in `places/{place_id}` format. + "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "review_id": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widget_context_token": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "is_error": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "search_suggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mime_type": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "end_index": 42, # End of the attributed segment, exclusive. + "file_citation": { # A file citation annotation. # A file citation annotation. + "custom_metadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiValue + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiStruct # Represents a structured value. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiStruct # Represents a structured value. }, + ], + }, + "document_uri": "A String", # The URI of the file. + "file_name": "A String", # The name of the file. + "media_id": "A String", # Media ID in-case of image citations, if applicable. + "page_number": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "place_citation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "place_id": "A String", # The ID of the place, in `places/{place_id}` format. + "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "review_id": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, ], + "url": "A String", # URI reference of the place. + }, + "start_index": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "url_citation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, - "document_uri": "A String", # The URI of the file. - "file_name": "A String", # The name of the file. - "media_id": "A String", # Media ID in-case of image citations, if applicable. - "page_number": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "place_citation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "place_id": "A String", # The ID of the place, in `places/{place_id}` format. - "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "review_id": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "start_index": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "url_citation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "server_name": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiValue ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "server_name": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiValue + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiStruct # Represents a structured value. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiStruct # Represents a structured value. }, + ], + }, + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "is_error": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. }, ], }, }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "is_error": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], + "video": { # A video content block. + "data": "A String", # The video content. + "mime_type": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. }, }, - "video": { # A video content block. - "data": "A String", # The video content. - "mime_type": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - ], + ], + }, + "contentString": "A String", # The content of the step. A single string. }, }, ], @@ -11331,6 +11383,8 @@

Method Details

], }, "created": "A String", # Required. Output only. The time at which the response was created in ISO 8601 format (YYYY-MM-DDThh:mm:ssZ). + "env_id": "A String", # The environment ID for the interaction. Can be 'remote' for default environment. + "environment_id": "A String", # Output only. The environment ID for the interaction. Only populated if environment config is set in the request. "id": "A String", # Required. Output only. A unique identifier for the interaction completion. "modelInteraction": { # Interaction for generating the completion using models. # Interaction for generating the completion using models. "generation_config": { # Configuration parameters for model interactions. # Input only. Configuration parameters for the model interaction. @@ -11815,6 +11869,28 @@

Method Details

}, ], "previous_interaction_id": "A String", # The ID of the previous interaction, if any. + "remoteEnvironment": { # Configuration for a custom environment. + "networkAllowlist": { # Network egress configuration for the environment. # Allow only specific domains. + "allowlist": [ # List of allowed domains and their configurations. + { # A network egress rule that controls which external domains the environment is allowed to reach. Each rule identifies a target domain and, optionally, a set of HTTP headers to inject into every matching outbound request. + "domain": "A String", # The domain pattern to match for this rule. Use an exact hostname (e.g., `github.com`), a wildcard prefix (e.g., `*.googleapis.com`), or `*` to match all domains. + "transform": { # Headers to inject into requests matching this rule. Key: header name (e.g., "Authorization"). Value: header value (e.g., "Bearer your-token"). + "a_key": "A String", + }, + }, + ], + }, + "networkMode": "A String", # Network egress mode. + "sources": [ + { # A source to be mounted into the environment. + "content": "A String", # The inline content if `type` is `INLINE`. + "encoding": "A String", # Optional encoding for inline content (e.g. `base64`). + "source": "A String", # The source of the environment. For GCS, this is the GCS path. For GitHub, this is the GitHub path. + "target": "A String", # Where the source should appear in the environment. + "type": "A String", + }, + ], + }, "responseFormatList": { "response_formats": [ { @@ -11871,8 +11947,6 @@

Method Details

], }, }, - "video": { # Configuration for video output format. - }, }, ], }, @@ -11930,8 +12004,6 @@

Method Details

], }, }, - "video": { # Configuration for video output format. - }, }, "response_format": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. # Enforces that the generated response is a JSON object that complies with the JSON schema specified in this field. "boolValue": True or False, # Represents a boolean value. @@ -12770,459 +12842,462 @@

Method Details

}, }, "userInput": { # Input provided by the user. - "content": [ - { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mime_type": "A String", # The mime type of the audio. - "sample_rate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mime_type": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mime_type": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "end_index": 42, # End of the attributed segment, exclusive. - "file_citation": { # A file citation annotation. # A file citation annotation. - "custom_metadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiValue + "contentList": { # A list of Content. # The content of the step. An array of Content objects. + "contents": [ # The contents of the list. + { # The content of the response. + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mime_type": "A String", # The mime type of the audio. + "sample_rate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mime_type": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mime_type": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "end_index": 42, # End of the attributed segment, exclusive. + "file_citation": { # A file citation annotation. # A file citation annotation. + "custom_metadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiValue + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiStruct # Represents a structured value. + }, + }, + ], + }, + "document_uri": "A String", # The URI of the file. + "file_name": "A String", # The name of the file. + "media_id": "A String", # Media ID in-case of image citations, if applicable. + "page_number": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "place_citation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "place_id": "A String", # The ID of the place, in `places/{place_id}` format. + "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "review_id": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "start_index": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "url_citation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mime_type": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "end_index": 42, # End of the attributed segment, exclusive. + "file_citation": { # A file citation annotation. # A file citation annotation. + "custom_metadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiValue + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiStruct # Represents a structured value. + }, + }, ], }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiStruct # Represents a structured value. + "document_uri": "A String", # The URI of the file. + "file_name": "A String", # The name of the file. + "media_id": "A String", # Media ID in-case of image citations, if applicable. + "page_number": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "place_citation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "place_id": "A String", # The ID of the place, in `places/{place_id}` format. + "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "review_id": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "start_index": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "url_citation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, }, ], + "text": "A String", # Required. The text content. }, - "document_uri": "A String", # The URI of the file. - "file_name": "A String", # The name of the file. - "media_id": "A String", # Media ID in-case of image citations, if applicable. - "page_number": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. }, - "place_citation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "place_id": "A String", # The ID of the place, in `places/{place_id}` format. - "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "review_id": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiValue + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiStruct # Represents a structured value. + }, }, ], - "url": "A String", # URI reference of the place. }, - "start_index": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "url_citation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], }, }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mime_type": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "end_index": 42, # End of the attributed segment, exclusive. - "file_citation": { # A file citation annotation. # A file citation annotation. - "custom_metadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiValue - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiStruct # Represents a structured value. - }, - }, + "search_type": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiValue ], }, - "document_uri": "A String", # The URI of the file. - "file_name": "A String", # The name of the file. - "media_id": "A String", # Media ID in-case of image citations, if applicable. - "page_number": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "place_citation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "place_id": "A String", # The ID of the place, in `places/{place_id}` format. - "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "review_id": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "start_index": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "url_citation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiStruct # Represents a structured value. }, }, ], - "text": "A String", # Required. The text content. }, + "name": "A String", # Required. The name of the tool which was called. + "server_name": "A String", # Required. The name of the used MCP server. }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiValue - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiStruct # Represents a structured value. - }, - }, - ], + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, }, - "name": "A String", # Required. The name of the tool to call. }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], + "toolResult": { # Tool result content. + "call_id": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "is_error": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, ], }, - "search_type": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiValue + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mime_type": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "end_index": 42, # End of the attributed segment, exclusive. + "file_citation": { # A file citation annotation. # A file citation annotation. + "custom_metadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiValue + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiStruct # Represents a structured value. + }, + }, + ], + }, + "document_uri": "A String", # The URI of the file. + "file_name": "A String", # The name of the file. + "media_id": "A String", # Media ID in-case of image citations, if applicable. + "page_number": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "place_citation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "place_id": "A String", # The ID of the place, in `places/{place_id}` format. + "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "review_id": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "start_index": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "url_citation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "is_error": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiValue + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiStruct # Represents a structured value. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiStruct # Represents a structured value. }, + ], + }, + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "place_id": "A String", # The ID of the place, in `places/{place_id}` format. + "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "review_id": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widget_context_token": "A String", # Resource name of the Google Maps widget context token. }, ], }, - "name": "A String", # Required. The name of the tool which was called. - "server_name": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", + "googleSearchResult": { # Google Search result content. + "is_error": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "search_suggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, ], }, - }, - }, - "toolResult": { # Tool result content. - "call_id": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "is_error": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mime_type": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "end_index": 42, # End of the attributed segment, exclusive. - "file_citation": { # A file citation annotation. # A file citation annotation. - "custom_metadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiValue - ], + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mime_type": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "end_index": 42, # End of the attributed segment, exclusive. + "file_citation": { # A file citation annotation. # A file citation annotation. + "custom_metadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiValue + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiStruct # Represents a structured value. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiStruct # Represents a structured value. }, + ], + }, + "document_uri": "A String", # The URI of the file. + "file_name": "A String", # The name of the file. + "media_id": "A String", # Media ID in-case of image citations, if applicable. + "page_number": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "place_citation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "place_id": "A String", # The ID of the place, in `places/{place_id}` format. + "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "review_id": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, ], + "url": "A String", # URI reference of the place. + }, + "start_index": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "url_citation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, - "document_uri": "A String", # The URI of the file. - "file_name": "A String", # The name of the file. - "media_id": "A String", # Media ID in-case of image citations, if applicable. - "page_number": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "place_citation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "place_id": "A String", # The ID of the place, in `places/{place_id}` format. - "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "review_id": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "start_index": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "url_citation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "is_error": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiValue ], + "text": "A String", # Required. The text content. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiStruct # Represents a structured value. }, - }, - ], - }, - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "place_id": "A String", # The ID of the place, in `places/{place_id}` format. - "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "review_id": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "server_name": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiValue + ], }, - ], - "url": "A String", # URI reference of the place. + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiStruct # Represents a structured value. + }, }, ], - "widget_context_token": "A String", # Resource name of the Google Maps widget context token. }, - ], + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "is_error": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, }, - "googleSearchResult": { # Google Search result content. - "is_error": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "search_suggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mime_type": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "end_index": 42, # End of the attributed segment, exclusive. - "file_citation": { # A file citation annotation. # A file citation annotation. - "custom_metadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiValue - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiStruct # Represents a structured value. - }, - }, - ], - }, - "document_uri": "A String", # The URI of the file. - "file_name": "A String", # The name of the file. - "media_id": "A String", # Media ID in-case of image citations, if applicable. - "page_number": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "place_citation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "place_id": "A String", # The ID of the place, in `places/{place_id}` format. - "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "review_id": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "start_index": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "url_citation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "server_name": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiValue - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiStruct # Represents a structured value. - }, - }, - ], - }, - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "is_error": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], + "video": { # A video content block. + "data": "A String", # The video content. + "mime_type": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. }, }, - "video": { # A video content block. - "data": "A String", # The video content. - "mime_type": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - ], + ], + }, + "contentString": "A String", # The content of the step. A single string. }, }, ], }, - "steps": [ # Output only. The steps that make up the interaction. + "steps": [ # Required. Output only. The steps that make up the interaction. { # A step in the interaction. "modelOutput": { # Output generated by the model. "content": [ @@ -14040,454 +14115,457 @@

Method Details

}, }, "userInput": { # Input provided by the user. - "content": [ - { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mime_type": "A String", # The mime type of the audio. - "sample_rate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mime_type": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mime_type": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "end_index": 42, # End of the attributed segment, exclusive. - "file_citation": { # A file citation annotation. # A file citation annotation. - "custom_metadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiValue - ], + "contentList": { # A list of Content. # The content of the step. An array of Content objects. + "contents": [ # The contents of the list. + { # The content of the response. + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mime_type": "A String", # The mime type of the audio. + "sample_rate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mime_type": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mime_type": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "end_index": 42, # End of the attributed segment, exclusive. + "file_citation": { # A file citation annotation. # A file citation annotation. + "custom_metadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiValue + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiStruct # Represents a structured value. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiStruct # Represents a structured value. }, + ], + }, + "document_uri": "A String", # The URI of the file. + "file_name": "A String", # The name of the file. + "media_id": "A String", # Media ID in-case of image citations, if applicable. + "page_number": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "place_citation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "place_id": "A String", # The ID of the place, in `places/{place_id}` format. + "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "review_id": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, ], + "url": "A String", # URI reference of the place. + }, + "start_index": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "url_citation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, - "document_uri": "A String", # The URI of the file. - "file_name": "A String", # The name of the file. - "media_id": "A String", # Media ID in-case of image citations, if applicable. - "page_number": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "place_citation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "place_id": "A String", # The ID of the place, in `places/{place_id}` format. - "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "review_id": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "start_index": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "url_citation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mime_type": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "end_index": 42, # End of the attributed segment, exclusive. - "file_citation": { # A file citation annotation. # A file citation annotation. - "custom_metadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiValue - ], + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mime_type": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "end_index": 42, # End of the attributed segment, exclusive. + "file_citation": { # A file citation annotation. # A file citation annotation. + "custom_metadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiValue + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiStruct # Represents a structured value. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiStruct # Represents a structured value. }, + ], + }, + "document_uri": "A String", # The URI of the file. + "file_name": "A String", # The name of the file. + "media_id": "A String", # Media ID in-case of image citations, if applicable. + "page_number": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "place_citation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "place_id": "A String", # The ID of the place, in `places/{place_id}` format. + "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "review_id": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, ], + "url": "A String", # URI reference of the place. + }, + "start_index": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "url_citation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, - "document_uri": "A String", # The URI of the file. - "file_name": "A String", # The name of the file. - "media_id": "A String", # Media ID in-case of image citations, if applicable. - "page_number": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "place_citation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "place_id": "A String", # The ID of the place, in `places/{place_id}` format. - "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "review_id": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. }, - "start_index": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "url_citation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiValue + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiStruct # Represents a structured value. }, }, ], - "text": "A String", # Required. The text content. }, + "name": "A String", # Required. The name of the tool to call. }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiValue - ], + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "search_type": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiValue + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiStruct # Represents a structured value. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiStruct # Represents a structured value. }, - }, - ], + ], + }, + "name": "A String", # Required. The name of the tool which was called. + "server_name": "A String", # Required. The name of the used MCP server. }, - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, }, }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], + "toolResult": { # Tool result content. + "call_id": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "is_error": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. }, - "search_type": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiValue - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiStruct # Represents a structured value. - }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. }, ], }, - "name": "A String", # Required. The name of the tool which was called. - "server_name": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, - }, - "toolResult": { # Tool result content. - "call_id": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "is_error": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mime_type": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "end_index": 42, # End of the attributed segment, exclusive. - "file_citation": { # A file citation annotation. # A file citation annotation. - "custom_metadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiValue - ], + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mime_type": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "end_index": 42, # End of the attributed segment, exclusive. + "file_citation": { # A file citation annotation. # A file citation annotation. + "custom_metadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiValue + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiStruct # Represents a structured value. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiStruct # Represents a structured value. }, + ], + }, + "document_uri": "A String", # The URI of the file. + "file_name": "A String", # The name of the file. + "media_id": "A String", # Media ID in-case of image citations, if applicable. + "page_number": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "place_citation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "place_id": "A String", # The ID of the place, in `places/{place_id}` format. + "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "review_id": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, ], + "url": "A String", # URI reference of the place. + }, + "start_index": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "url_citation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, - "document_uri": "A String", # The URI of the file. - "file_name": "A String", # The name of the file. - "media_id": "A String", # Media ID in-case of image citations, if applicable. - "page_number": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "place_citation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "place_id": "A String", # The ID of the place, in `places/{place_id}` format. - "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "review_id": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "start_index": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "url_citation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "is_error": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiValue + ], }, - ], - "text": "A String", # Required. The text content. + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiStruct # Represents a structured value. + }, }, - }, - ], + ], + }, }, - "is_error": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiValue + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "place_id": "A String", # The ID of the place, in `places/{place_id}` format. + "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "review_id": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, ], + "url": "A String", # URI reference of the place. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiStruct # Represents a structured value. - }, + ], + "widget_context_token": "A String", # Resource name of the Google Maps widget context token. }, ], }, - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. + "googleSearchResult": { # Google Search result content. + "is_error": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "search_suggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ { - "name": "A String", # Title of the place. - "place_id": "A String", # The ID of the place, in `places/{place_id}` format. - "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "review_id": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. + "image": { # An image content block. + "data": "A String", # The image content. + "mime_type": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "end_index": 42, # End of the attributed segment, exclusive. + "file_citation": { # A file citation annotation. # A file citation annotation. + "custom_metadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiValue + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiStruct # Represents a structured value. + }, + }, + ], + }, + "document_uri": "A String", # The URI of the file. + "file_name": "A String", # The name of the file. + "media_id": "A String", # Media ID in-case of image citations, if applicable. + "page_number": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "place_citation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "place_id": "A String", # The ID of the place, in `places/{place_id}` format. + "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "review_id": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "start_index": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "url_citation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, }, ], - "widget_context_token": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "is_error": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "search_suggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mime_type": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "end_index": 42, # End of the attributed segment, exclusive. - "file_citation": { # A file citation annotation. # A file citation annotation. - "custom_metadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiValue - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiStruct # Represents a structured value. - }, - }, - ], - }, - "document_uri": "A String", # The URI of the file. - "file_name": "A String", # The name of the file. - "media_id": "A String", # Media ID in-case of image citations, if applicable. - "page_number": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "place_citation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "place_id": "A String", # The ID of the place, in `places/{place_id}` format. - "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "review_id": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "start_index": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "url_citation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "server_name": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiValue + ], }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "server_name": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiValue - ], + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiStruct # Represents a structured value. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiStruct # Represents a structured value. }, + ], + }, + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "is_error": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. }, ], }, }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "is_error": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], + "video": { # A video content block. + "data": "A String", # The video content. + "mime_type": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. }, }, - "video": { # A video content block. - "data": "A String", # The video content. - "mime_type": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - ], + ], + }, + "contentString": "A String", # The content of the step. A single string. }, }, ], @@ -15993,6 +16071,8 @@

Method Details

], }, "created": "A String", # Required. Output only. The time at which the response was created in ISO 8601 format (YYYY-MM-DDThh:mm:ssZ). + "env_id": "A String", # The environment ID for the interaction. Can be 'remote' for default environment. + "environment_id": "A String", # Output only. The environment ID for the interaction. Only populated if environment config is set in the request. "id": "A String", # Required. Output only. A unique identifier for the interaction completion. "modelInteraction": { # Interaction for generating the completion using models. # Interaction for generating the completion using models. "generation_config": { # Configuration parameters for model interactions. # Input only. Configuration parameters for the model interaction. @@ -16477,6 +16557,28 @@

Method Details

}, ], "previous_interaction_id": "A String", # The ID of the previous interaction, if any. + "remoteEnvironment": { # Configuration for a custom environment. + "networkAllowlist": { # Network egress configuration for the environment. # Allow only specific domains. + "allowlist": [ # List of allowed domains and their configurations. + { # A network egress rule that controls which external domains the environment is allowed to reach. Each rule identifies a target domain and, optionally, a set of HTTP headers to inject into every matching outbound request. + "domain": "A String", # The domain pattern to match for this rule. Use an exact hostname (e.g., `github.com`), a wildcard prefix (e.g., `*.googleapis.com`), or `*` to match all domains. + "transform": { # Headers to inject into requests matching this rule. Key: header name (e.g., "Authorization"). Value: header value (e.g., "Bearer your-token"). + "a_key": "A String", + }, + }, + ], + }, + "networkMode": "A String", # Network egress mode. + "sources": [ + { # A source to be mounted into the environment. + "content": "A String", # The inline content if `type` is `INLINE`. + "encoding": "A String", # Optional encoding for inline content (e.g. `base64`). + "source": "A String", # The source of the environment. For GCS, this is the GCS path. For GitHub, this is the GitHub path. + "target": "A String", # Where the source should appear in the environment. + "type": "A String", + }, + ], + }, "responseFormatList": { "response_formats": [ { @@ -16533,8 +16635,6 @@

Method Details

], }, }, - "video": { # Configuration for video output format. - }, }, ], }, @@ -16592,8 +16692,6 @@

Method Details

], }, }, - "video": { # Configuration for video output format. - }, }, "response_format": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. # Enforces that the generated response is a JSON object that complies with the JSON schema specified in this field. "boolValue": True or False, # Represents a boolean value. @@ -17432,118 +17530,325 @@

Method Details

}, }, "userInput": { # Input provided by the user. - "content": [ - { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mime_type": "A String", # The mime type of the audio. - "sample_rate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mime_type": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mime_type": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "end_index": 42, # End of the attributed segment, exclusive. - "file_citation": { # A file citation annotation. # A file citation annotation. - "custom_metadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiValue - ], + "contentList": { # A list of Content. # The content of the step. An array of Content objects. + "contents": [ # The contents of the list. + { # The content of the response. + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mime_type": "A String", # The mime type of the audio. + "sample_rate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mime_type": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mime_type": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "end_index": 42, # End of the attributed segment, exclusive. + "file_citation": { # A file citation annotation. # A file citation annotation. + "custom_metadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiValue + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiStruct # Represents a structured value. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiStruct # Represents a structured value. }, + ], + }, + "document_uri": "A String", # The URI of the file. + "file_name": "A String", # The name of the file. + "media_id": "A String", # Media ID in-case of image citations, if applicable. + "page_number": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "place_citation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "place_id": "A String", # The ID of the place, in `places/{place_id}` format. + "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "review_id": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, ], + "url": "A String", # URI reference of the place. + }, + "start_index": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "url_citation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, - "document_uri": "A String", # The URI of the file. - "file_name": "A String", # The name of the file. - "media_id": "A String", # Media ID in-case of image citations, if applicable. - "page_number": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "place_citation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "place_id": "A String", # The ID of the place, in `places/{place_id}` format. - "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "review_id": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "start_index": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "url_citation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. }, - }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mime_type": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "end_index": 42, # End of the attributed segment, exclusive. - "file_citation": { # A file citation annotation. # A file citation annotation. - "custom_metadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiValue - ], + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mime_type": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "end_index": 42, # End of the attributed segment, exclusive. + "file_citation": { # A file citation annotation. # A file citation annotation. + "custom_metadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiValue + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiStruct # Represents a structured value. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiStruct # Represents a structured value. }, + ], + }, + "document_uri": "A String", # The URI of the file. + "file_name": "A String", # The name of the file. + "media_id": "A String", # Media ID in-case of image citations, if applicable. + "page_number": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "place_citation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "place_id": "A String", # The ID of the place, in `places/{place_id}` format. + "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "review_id": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, ], + "url": "A String", # URI reference of the place. + }, + "start_index": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "url_citation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, - "document_uri": "A String", # The URI of the file. - "file_name": "A String", # The name of the file. - "media_id": "A String", # Media ID in-case of image citations, if applicable. - "page_number": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. }, - "place_citation": { # A place citation annotation. # A place citation annotation. + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiValue + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiStruct # Represents a structured value. + }, + }, + ], + }, + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "search_type": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiValue + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiStruct # Represents a structured value. + }, + }, + ], + }, + "name": "A String", # Required. The name of the tool which was called. + "server_name": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "call_id": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "is_error": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mime_type": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "end_index": 42, # End of the attributed segment, exclusive. + "file_citation": { # A file citation annotation. # A file citation annotation. + "custom_metadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiValue + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiStruct # Represents a structured value. + }, + }, + ], + }, + "document_uri": "A String", # The URI of the file. + "file_name": "A String", # The name of the file. + "media_id": "A String", # Media ID in-case of image citations, if applicable. + "page_number": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "place_citation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "place_id": "A String", # The ID of the place, in `places/{place_id}` format. + "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "review_id": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "start_index": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "url_citation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "is_error": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiValue + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiStruct # Represents a structured value. + }, + }, + ], + }, + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { "name": "A String", # Title of the place. "place_id": "A String", # The ID of the place, in `places/{place_id}` format. "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. @@ -17555,201 +17860,246 @@

Method Details

], "url": "A String", # URI reference of the place. }, - "start_index": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "url_citation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. + ], + "widget_context_token": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "is_error": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "search_suggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mime_type": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "end_index": 42, # End of the attributed segment, exclusive. + "file_citation": { # A file citation annotation. # A file citation annotation. + "custom_metadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiValue + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiStruct # Represents a structured value. + }, + }, + ], + }, + "document_uri": "A String", # The URI of the file. + "file_name": "A String", # The name of the file. + "media_id": "A String", # Media ID in-case of image citations, if applicable. + "page_number": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "place_citation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "place_id": "A String", # The ID of the place, in `places/{place_id}` format. + "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "review_id": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "start_index": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "url_citation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. }, }, ], - "text": "A String", # Required. The text content. }, - }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiValue - ], + "name": "A String", # Name of the tool which is called for this specific tool call. + "server_name": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiValue + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiStruct # Represents a structured value. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiStruct # Represents a structured value. }, + ], + }, + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "is_error": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. }, ], }, - "name": "A String", # Required. The name of the tool to call. }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, + "video": { # A video content block. + "data": "A String", # The video content. + "mime_type": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "search_type": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiValue - ], + }, + ], + }, + "contentString": "A String", # The content of the step. A single string. + }, + }, + ], + }, + "steps": [ # Required. Output only. The steps that make up the interaction. + { # A step in the interaction. + "modelOutput": { # Output generated by the model. + "content": [ + { # The content of the response. + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mime_type": "A String", # The mime type of the audio. + "sample_rate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mime_type": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mime_type": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "end_index": 42, # End of the attributed segment, exclusive. + "file_citation": { # A file citation annotation. # A file citation annotation. + "custom_metadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiValue + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiStruct # Represents a structured value. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiStruct # Represents a structured value. }, + ], + }, + "document_uri": "A String", # The URI of the file. + "file_name": "A String", # The name of the file. + "media_id": "A String", # Media ID in-case of image citations, if applicable. + "page_number": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "place_citation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "place_id": "A String", # The ID of the place, in `places/{place_id}` format. + "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "review_id": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, ], + "url": "A String", # URI reference of the place. }, - "name": "A String", # Required. The name of the tool which was called. - "server_name": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], + "start_index": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "url_citation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, }, - }, - "toolResult": { # Tool result content. - "call_id": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "is_error": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mime_type": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "end_index": 42, # End of the attributed segment, exclusive. - "file_citation": { # A file citation annotation. # A file citation annotation. - "custom_metadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiValue - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiStruct # Represents a structured value. - }, - }, - ], - }, - "document_uri": "A String", # The URI of the file. - "file_name": "A String", # The name of the file. - "media_id": "A String", # Media ID in-case of image citations, if applicable. - "page_number": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "place_citation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "place_id": "A String", # The ID of the place, in `places/{place_id}` format. - "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "review_id": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mime_type": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "end_index": 42, # End of the attributed segment, exclusive. + "file_citation": { # A file citation annotation. # A file citation annotation. + "custom_metadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiValue + ], }, - ], - "url": "A String", # URI reference of the place. - }, - "start_index": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "url_citation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiStruct # Represents a structured value. + }, }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "is_error": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiValue ], }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiStruct # Represents a structured value. + "document_uri": "A String", # The URI of the file. + "file_name": "A String", # The name of the file. + "media_id": "A String", # Media ID in-case of image citations, if applicable. + "page_number": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. }, - }, - ], - }, - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { + "place_citation": { # A place citation annotation. # A place citation annotation. "name": "A String", # Title of the place. "place_id": "A String", # The ID of the place, in `places/{place_id}` format. "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. @@ -17761,264 +18111,15 @@

Method Details

], "url": "A String", # URI reference of the place. }, - ], - "widget_context_token": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "is_error": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "search_suggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mime_type": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "end_index": 42, # End of the attributed segment, exclusive. - "file_citation": { # A file citation annotation. # A file citation annotation. - "custom_metadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiValue - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiStruct # Represents a structured value. - }, - }, - ], - }, - "document_uri": "A String", # The URI of the file. - "file_name": "A String", # The name of the file. - "media_id": "A String", # Media ID in-case of image citations, if applicable. - "page_number": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "place_citation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "place_id": "A String", # The ID of the place, in `places/{place_id}` format. - "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "review_id": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "start_index": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "url_citation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "server_name": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiValue - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiStruct # Represents a structured value. - }, - }, - ], - }, - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "is_error": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], - }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mime_type": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - ], - }, - }, - ], - }, - "steps": [ # Output only. The steps that make up the interaction. - { # A step in the interaction. - "modelOutput": { # Output generated by the model. - "content": [ - { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mime_type": "A String", # The mime type of the audio. - "sample_rate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mime_type": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mime_type": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "end_index": 42, # End of the attributed segment, exclusive. - "file_citation": { # A file citation annotation. # A file citation annotation. - "custom_metadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiValue - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiStruct # Represents a structured value. - }, - }, - ], - }, - "document_uri": "A String", # The URI of the file. - "file_name": "A String", # The name of the file. - "media_id": "A String", # Media ID in-case of image citations, if applicable. - "page_number": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "place_citation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "place_id": "A String", # The ID of the place, in `places/{place_id}` format. - "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "review_id": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "start_index": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "url_citation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mime_type": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "end_index": 42, # End of the attributed segment, exclusive. - "file_citation": { # A file citation annotation. # A file citation annotation. - "custom_metadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiValue - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiStruct # Represents a structured value. - }, - }, - ], - }, - "document_uri": "A String", # The URI of the file. - "file_name": "A String", # The name of the file. - "media_id": "A String", # Media ID in-case of image citations, if applicable. - "page_number": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "place_citation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "place_id": "A String", # The ID of the place, in `places/{place_id}` format. - "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "review_id": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "start_index": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "url_citation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, + "start_index": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "url_citation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, }, ], }, @@ -18702,454 +18803,457 @@

Method Details

}, }, "userInput": { # Input provided by the user. - "content": [ - { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mime_type": "A String", # The mime type of the audio. - "sample_rate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mime_type": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mime_type": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "end_index": 42, # End of the attributed segment, exclusive. - "file_citation": { # A file citation annotation. # A file citation annotation. - "custom_metadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiValue - ], + "contentList": { # A list of Content. # The content of the step. An array of Content objects. + "contents": [ # The contents of the list. + { # The content of the response. + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mime_type": "A String", # The mime type of the audio. + "sample_rate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mime_type": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mime_type": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "end_index": 42, # End of the attributed segment, exclusive. + "file_citation": { # A file citation annotation. # A file citation annotation. + "custom_metadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiValue + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiStruct # Represents a structured value. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiStruct # Represents a structured value. }, + ], + }, + "document_uri": "A String", # The URI of the file. + "file_name": "A String", # The name of the file. + "media_id": "A String", # Media ID in-case of image citations, if applicable. + "page_number": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "place_citation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "place_id": "A String", # The ID of the place, in `places/{place_id}` format. + "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "review_id": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, ], + "url": "A String", # URI reference of the place. + }, + "start_index": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "url_citation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, - "document_uri": "A String", # The URI of the file. - "file_name": "A String", # The name of the file. - "media_id": "A String", # Media ID in-case of image citations, if applicable. - "page_number": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "place_citation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "place_id": "A String", # The ID of the place, in `places/{place_id}` format. - "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "review_id": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "start_index": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "url_citation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mime_type": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "end_index": 42, # End of the attributed segment, exclusive. - "file_citation": { # A file citation annotation. # A file citation annotation. - "custom_metadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiValue - ], + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mime_type": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "end_index": 42, # End of the attributed segment, exclusive. + "file_citation": { # A file citation annotation. # A file citation annotation. + "custom_metadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiValue + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiStruct # Represents a structured value. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiStruct # Represents a structured value. }, + ], + }, + "document_uri": "A String", # The URI of the file. + "file_name": "A String", # The name of the file. + "media_id": "A String", # Media ID in-case of image citations, if applicable. + "page_number": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "place_citation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "place_id": "A String", # The ID of the place, in `places/{place_id}` format. + "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "review_id": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, ], + "url": "A String", # URI reference of the place. + }, + "start_index": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "url_citation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, - "document_uri": "A String", # The URI of the file. - "file_name": "A String", # The name of the file. - "media_id": "A String", # Media ID in-case of image citations, if applicable. - "page_number": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "place_citation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "place_id": "A String", # The ID of the place, in `places/{place_id}` format. - "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "review_id": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "start_index": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "url_citation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. }, - }, - ], - "text": "A String", # Required. The text content. + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. }, }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. + "fileSearchCall": { # File Search content. }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiValue - ], + "functionCall": { # A function tool call content block. + "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiValue + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiStruct # Represents a structured value. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiStruct # Represents a structured value. }, - }, - ], + ], + }, + "name": "A String", # Required. The name of the tool to call. }, - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "search_type": "A String", # The type of search grounding enabled. }, - "search_type": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiValue - ], + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiValue + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiStruct # Represents a structured value. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiStruct # Represents a structured value. }, - }, - ], + ], + }, + "name": "A String", # Required. The name of the tool which was called. + "server_name": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, }, - "name": "A String", # Required. The name of the tool which was called. - "server_name": "A String", # Required. The name of the used MCP server. }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", + "toolResult": { # Tool result content. + "call_id": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "is_error": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, ], }, - }, - }, - "toolResult": { # Tool result content. - "call_id": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "is_error": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mime_type": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "end_index": 42, # End of the attributed segment, exclusive. - "file_citation": { # A file citation annotation. # A file citation annotation. - "custom_metadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiValue - ], + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mime_type": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "end_index": 42, # End of the attributed segment, exclusive. + "file_citation": { # A file citation annotation. # A file citation annotation. + "custom_metadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiValue + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiStruct # Represents a structured value. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiStruct # Represents a structured value. }, + ], + }, + "document_uri": "A String", # The URI of the file. + "file_name": "A String", # The name of the file. + "media_id": "A String", # Media ID in-case of image citations, if applicable. + "page_number": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "place_citation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "place_id": "A String", # The ID of the place, in `places/{place_id}` format. + "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "review_id": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, ], + "url": "A String", # URI reference of the place. + }, + "start_index": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "url_citation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, - "document_uri": "A String", # The URI of the file. - "file_name": "A String", # The name of the file. - "media_id": "A String", # Media ID in-case of image citations, if applicable. - "page_number": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "place_citation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "place_id": "A String", # The ID of the place, in `places/{place_id}` format. - "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "review_id": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "start_index": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "url_citation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. }, - }, - ], - "text": "A String", # Required. The text content. + ], + "text": "A String", # Required. The text content. + }, }, - }, - ], - }, - "is_error": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiValue - ], + ], + }, + "is_error": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiValue + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiStruct # Represents a structured value. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiStruct # Represents a structured value. }, + ], + }, + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "place_id": "A String", # The ID of the place, in `places/{place_id}` format. + "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "review_id": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widget_context_token": "A String", # Resource name of the Google Maps widget context token. }, ], }, - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. + "googleSearchResult": { # Google Search result content. + "is_error": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "search_suggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ { - "name": "A String", # Title of the place. - "place_id": "A String", # The ID of the place, in `places/{place_id}` format. - "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "review_id": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - ], - "widget_context_token": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "is_error": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "search_suggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mime_type": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "end_index": 42, # End of the attributed segment, exclusive. - "file_citation": { # A file citation annotation. # A file citation annotation. - "custom_metadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiValue - ], + "image": { # An image content block. + "data": "A String", # The image content. + "mime_type": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "end_index": 42, # End of the attributed segment, exclusive. + "file_citation": { # A file citation annotation. # A file citation annotation. + "custom_metadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiValue + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiStruct # Represents a structured value. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiStruct # Represents a structured value. }, + ], + }, + "document_uri": "A String", # The URI of the file. + "file_name": "A String", # The name of the file. + "media_id": "A String", # Media ID in-case of image citations, if applicable. + "page_number": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "place_citation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "place_id": "A String", # The ID of the place, in `places/{place_id}` format. + "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "review_id": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, ], + "url": "A String", # URI reference of the place. + }, + "start_index": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "url_citation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, - "document_uri": "A String", # The URI of the file. - "file_name": "A String", # The name of the file. - "media_id": "A String", # Media ID in-case of image citations, if applicable. - "page_number": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "place_citation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "place_id": "A String", # The ID of the place, in `places/{place_id}` format. - "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "review_id": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "start_index": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "url_citation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "server_name": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiValue ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "server_name": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiValue + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiStruct # Represents a structured value. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiStruct # Represents a structured value. }, + ], + }, + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "is_error": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. }, ], }, }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "is_error": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], - }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mime_type": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. + "video": { # A video content block. + "data": "A String", # The video content. + "mime_type": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, }, - }, - ], + ], + }, + "contentString": "A String", # The content of the step. A single string. }, }, ], @@ -20655,6 +20759,8 @@

Method Details

], }, "created": "A String", # Required. Output only. The time at which the response was created in ISO 8601 format (YYYY-MM-DDThh:mm:ssZ). + "env_id": "A String", # The environment ID for the interaction. Can be 'remote' for default environment. + "environment_id": "A String", # Output only. The environment ID for the interaction. Only populated if environment config is set in the request. "id": "A String", # Required. Output only. A unique identifier for the interaction completion. "modelInteraction": { # Interaction for generating the completion using models. # Interaction for generating the completion using models. "generation_config": { # Configuration parameters for model interactions. # Input only. Configuration parameters for the model interaction. @@ -21139,6 +21245,28 @@

Method Details

}, ], "previous_interaction_id": "A String", # The ID of the previous interaction, if any. + "remoteEnvironment": { # Configuration for a custom environment. + "networkAllowlist": { # Network egress configuration for the environment. # Allow only specific domains. + "allowlist": [ # List of allowed domains and their configurations. + { # A network egress rule that controls which external domains the environment is allowed to reach. Each rule identifies a target domain and, optionally, a set of HTTP headers to inject into every matching outbound request. + "domain": "A String", # The domain pattern to match for this rule. Use an exact hostname (e.g., `github.com`), a wildcard prefix (e.g., `*.googleapis.com`), or `*` to match all domains. + "transform": { # Headers to inject into requests matching this rule. Key: header name (e.g., "Authorization"). Value: header value (e.g., "Bearer your-token"). + "a_key": "A String", + }, + }, + ], + }, + "networkMode": "A String", # Network egress mode. + "sources": [ + { # A source to be mounted into the environment. + "content": "A String", # The inline content if `type` is `INLINE`. + "encoding": "A String", # Optional encoding for inline content (e.g. `base64`). + "source": "A String", # The source of the environment. For GCS, this is the GCS path. For GitHub, this is the GitHub path. + "target": "A String", # Where the source should appear in the environment. + "type": "A String", + }, + ], + }, "responseFormatList": { "response_formats": [ { @@ -21195,8 +21323,6 @@

Method Details

], }, }, - "video": { # Configuration for video output format. - }, }, ], }, @@ -21254,8 +21380,6 @@

Method Details

], }, }, - "video": { # Configuration for video output format. - }, }, "response_format": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. # Enforces that the generated response is a JSON object that complies with the JSON schema specified in this field. "boolValue": True or False, # Represents a boolean value. @@ -22094,459 +22218,462 @@

Method Details

}, }, "userInput": { # Input provided by the user. - "content": [ - { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mime_type": "A String", # The mime type of the audio. - "sample_rate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mime_type": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mime_type": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "end_index": 42, # End of the attributed segment, exclusive. - "file_citation": { # A file citation annotation. # A file citation annotation. - "custom_metadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiValue - ], + "contentList": { # A list of Content. # The content of the step. An array of Content objects. + "contents": [ # The contents of the list. + { # The content of the response. + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mime_type": "A String", # The mime type of the audio. + "sample_rate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mime_type": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mime_type": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "end_index": 42, # End of the attributed segment, exclusive. + "file_citation": { # A file citation annotation. # A file citation annotation. + "custom_metadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiValue + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiStruct # Represents a structured value. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiStruct # Represents a structured value. }, + ], + }, + "document_uri": "A String", # The URI of the file. + "file_name": "A String", # The name of the file. + "media_id": "A String", # Media ID in-case of image citations, if applicable. + "page_number": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "place_citation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "place_id": "A String", # The ID of the place, in `places/{place_id}` format. + "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "review_id": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, ], + "url": "A String", # URI reference of the place. + }, + "start_index": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "url_citation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, - "document_uri": "A String", # The URI of the file. - "file_name": "A String", # The name of the file. - "media_id": "A String", # Media ID in-case of image citations, if applicable. - "page_number": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "place_citation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "place_id": "A String", # The ID of the place, in `places/{place_id}` format. - "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "review_id": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "start_index": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "url_citation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mime_type": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "end_index": 42, # End of the attributed segment, exclusive. - "file_citation": { # A file citation annotation. # A file citation annotation. - "custom_metadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiValue - ], + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mime_type": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "end_index": 42, # End of the attributed segment, exclusive. + "file_citation": { # A file citation annotation. # A file citation annotation. + "custom_metadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiValue + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiStruct # Represents a structured value. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiStruct # Represents a structured value. }, + ], + }, + "document_uri": "A String", # The URI of the file. + "file_name": "A String", # The name of the file. + "media_id": "A String", # Media ID in-case of image citations, if applicable. + "page_number": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "place_citation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "place_id": "A String", # The ID of the place, in `places/{place_id}` format. + "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "review_id": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, ], + "url": "A String", # URI reference of the place. + }, + "start_index": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "url_citation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, - "document_uri": "A String", # The URI of the file. - "file_name": "A String", # The name of the file. - "media_id": "A String", # Media ID in-case of image citations, if applicable. - "page_number": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "place_citation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "place_id": "A String", # The ID of the place, in `places/{place_id}` format. - "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "review_id": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "start_index": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "url_citation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. }, - }, - ], - "text": "A String", # Required. The text content. + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. }, }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. + "fileSearchCall": { # File Search content. }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiValue - ], + "functionCall": { # A function tool call content block. + "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiValue + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiStruct # Represents a structured value. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiStruct # Represents a structured value. }, - }, - ], + ], + }, + "name": "A String", # Required. The name of the tool to call. }, - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "search_type": "A String", # The type of search grounding enabled. }, - "search_type": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiValue - ], + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiValue + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiStruct # Represents a structured value. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiStruct # Represents a structured value. }, - }, - ], + ], + }, + "name": "A String", # Required. The name of the tool which was called. + "server_name": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, }, - "name": "A String", # Required. The name of the tool which was called. - "server_name": "A String", # Required. The name of the used MCP server. }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", + "toolResult": { # Tool result content. + "call_id": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "is_error": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, ], }, - }, - }, - "toolResult": { # Tool result content. - "call_id": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "is_error": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mime_type": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "end_index": 42, # End of the attributed segment, exclusive. - "file_citation": { # A file citation annotation. # A file citation annotation. - "custom_metadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiValue - ], + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mime_type": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "end_index": 42, # End of the attributed segment, exclusive. + "file_citation": { # A file citation annotation. # A file citation annotation. + "custom_metadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiValue + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiStruct # Represents a structured value. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiStruct # Represents a structured value. }, + ], + }, + "document_uri": "A String", # The URI of the file. + "file_name": "A String", # The name of the file. + "media_id": "A String", # Media ID in-case of image citations, if applicable. + "page_number": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "place_citation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "place_id": "A String", # The ID of the place, in `places/{place_id}` format. + "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "review_id": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, ], + "url": "A String", # URI reference of the place. + }, + "start_index": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "url_citation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, - "document_uri": "A String", # The URI of the file. - "file_name": "A String", # The name of the file. - "media_id": "A String", # Media ID in-case of image citations, if applicable. - "page_number": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "place_citation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "place_id": "A String", # The ID of the place, in `places/{place_id}` format. - "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "review_id": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "start_index": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "url_citation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "is_error": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiValue + ], }, - ], - "text": "A String", # Required. The text content. + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiStruct # Represents a structured value. + }, }, - }, - ], + ], + }, }, - "is_error": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiValue + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "place_id": "A String", # The ID of the place, in `places/{place_id}` format. + "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "review_id": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, ], + "url": "A String", # URI reference of the place. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiStruct # Represents a structured value. - }, + ], + "widget_context_token": "A String", # Resource name of the Google Maps widget context token. }, ], }, - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. + "googleSearchResult": { # Google Search result content. + "is_error": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "search_suggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ { - "name": "A String", # Title of the place. - "place_id": "A String", # The ID of the place, in `places/{place_id}` format. - "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "review_id": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. + "image": { # An image content block. + "data": "A String", # The image content. + "mime_type": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "end_index": 42, # End of the attributed segment, exclusive. + "file_citation": { # A file citation annotation. # A file citation annotation. + "custom_metadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiValue + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiStruct # Represents a structured value. + }, + }, + ], + }, + "document_uri": "A String", # The URI of the file. + "file_name": "A String", # The name of the file. + "media_id": "A String", # Media ID in-case of image citations, if applicable. + "page_number": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "place_citation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "place_id": "A String", # The ID of the place, in `places/{place_id}` format. + "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "review_id": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "start_index": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "url_citation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, }, ], - "widget_context_token": "A String", # Resource name of the Google Maps widget context token. }, - ], - }, - "googleSearchResult": { # Google Search result content. - "is_error": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "search_suggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mime_type": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "end_index": 42, # End of the attributed segment, exclusive. - "file_citation": { # A file citation annotation. # A file citation annotation. - "custom_metadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiValue - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiStruct # Represents a structured value. - }, - }, - ], - }, - "document_uri": "A String", # The URI of the file. - "file_name": "A String", # The name of the file. - "media_id": "A String", # Media ID in-case of image citations, if applicable. - "page_number": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "place_citation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "place_id": "A String", # The ID of the place, in `places/{place_id}` format. - "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "review_id": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "start_index": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "url_citation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "server_name": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiValue + ], }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "server_name": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiValue - ], + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiStruct # Represents a structured value. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiStruct # Represents a structured value. }, + ], + }, + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "is_error": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. }, ], }, }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "is_error": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], + "video": { # A video content block. + "data": "A String", # The video content. + "mime_type": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. }, }, - "video": { # A video content block. - "data": "A String", # The video content. - "mime_type": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - ], + ], + }, + "contentString": "A String", # The content of the step. A single string. }, }, ], }, - "steps": [ # Output only. The steps that make up the interaction. + "steps": [ # Required. Output only. The steps that make up the interaction. { # A step in the interaction. "modelOutput": { # Output generated by the model. "content": [ @@ -23364,454 +23491,457 @@

Method Details

}, }, "userInput": { # Input provided by the user. - "content": [ - { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mime_type": "A String", # The mime type of the audio. - "sample_rate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mime_type": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mime_type": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "end_index": 42, # End of the attributed segment, exclusive. - "file_citation": { # A file citation annotation. # A file citation annotation. - "custom_metadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiValue - ], + "contentList": { # A list of Content. # The content of the step. An array of Content objects. + "contents": [ # The contents of the list. + { # The content of the response. + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mime_type": "A String", # The mime type of the audio. + "sample_rate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mime_type": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mime_type": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "end_index": 42, # End of the attributed segment, exclusive. + "file_citation": { # A file citation annotation. # A file citation annotation. + "custom_metadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiValue + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiStruct # Represents a structured value. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiStruct # Represents a structured value. }, + ], + }, + "document_uri": "A String", # The URI of the file. + "file_name": "A String", # The name of the file. + "media_id": "A String", # Media ID in-case of image citations, if applicable. + "page_number": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "place_citation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "place_id": "A String", # The ID of the place, in `places/{place_id}` format. + "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "review_id": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, ], + "url": "A String", # URI reference of the place. + }, + "start_index": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "url_citation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, - "document_uri": "A String", # The URI of the file. - "file_name": "A String", # The name of the file. - "media_id": "A String", # Media ID in-case of image citations, if applicable. - "page_number": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "place_citation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "place_id": "A String", # The ID of the place, in `places/{place_id}` format. - "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "review_id": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "start_index": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "url_citation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. }, - }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mime_type": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "end_index": 42, # End of the attributed segment, exclusive. - "file_citation": { # A file citation annotation. # A file citation annotation. - "custom_metadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiValue - ], + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mime_type": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "end_index": 42, # End of the attributed segment, exclusive. + "file_citation": { # A file citation annotation. # A file citation annotation. + "custom_metadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiValue + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiStruct # Represents a structured value. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiStruct # Represents a structured value. }, + ], + }, + "document_uri": "A String", # The URI of the file. + "file_name": "A String", # The name of the file. + "media_id": "A String", # Media ID in-case of image citations, if applicable. + "page_number": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "place_citation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "place_id": "A String", # The ID of the place, in `places/{place_id}` format. + "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "review_id": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, ], + "url": "A String", # URI reference of the place. + }, + "start_index": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "url_citation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, - "document_uri": "A String", # The URI of the file. - "file_name": "A String", # The name of the file. - "media_id": "A String", # Media ID in-case of image citations, if applicable. - "page_number": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "place_citation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "place_id": "A String", # The ID of the place, in `places/{place_id}` format. - "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "review_id": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. }, - "start_index": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "url_citation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiValue + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiStruct # Represents a structured value. }, }, ], - "text": "A String", # Required. The text content. }, + "name": "A String", # Required. The name of the tool to call. }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiValue - ], + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "search_type": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiValue + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiStruct # Represents a structured value. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiStruct # Represents a structured value. }, - }, - ], + ], + }, + "name": "A String", # Required. The name of the tool which was called. + "server_name": "A String", # Required. The name of the used MCP server. }, - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, }, }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], + "toolResult": { # Tool result content. + "call_id": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "is_error": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. }, - "search_type": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiValue - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiStruct # Represents a structured value. - }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. }, ], }, - "name": "A String", # Required. The name of the tool which was called. - "server_name": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, - }, - "toolResult": { # Tool result content. - "call_id": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "is_error": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mime_type": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "end_index": 42, # End of the attributed segment, exclusive. - "file_citation": { # A file citation annotation. # A file citation annotation. - "custom_metadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiValue - ], + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mime_type": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "end_index": 42, # End of the attributed segment, exclusive. + "file_citation": { # A file citation annotation. # A file citation annotation. + "custom_metadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiValue + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiStruct # Represents a structured value. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiStruct # Represents a structured value. }, + ], + }, + "document_uri": "A String", # The URI of the file. + "file_name": "A String", # The name of the file. + "media_id": "A String", # Media ID in-case of image citations, if applicable. + "page_number": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "place_citation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "place_id": "A String", # The ID of the place, in `places/{place_id}` format. + "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "review_id": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, ], + "url": "A String", # URI reference of the place. + }, + "start_index": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "url_citation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, - "document_uri": "A String", # The URI of the file. - "file_name": "A String", # The name of the file. - "media_id": "A String", # Media ID in-case of image citations, if applicable. - "page_number": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "place_citation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "place_id": "A String", # The ID of the place, in `places/{place_id}` format. - "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "review_id": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "start_index": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "url_citation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "is_error": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiValue + ], }, - ], - "text": "A String", # Required. The text content. + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiStruct # Represents a structured value. + }, }, - }, - ], + ], + }, }, - "is_error": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiValue + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "place_id": "A String", # The ID of the place, in `places/{place_id}` format. + "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "review_id": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, ], + "url": "A String", # URI reference of the place. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiStruct # Represents a structured value. - }, + ], + "widget_context_token": "A String", # Resource name of the Google Maps widget context token. }, ], }, - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. + "googleSearchResult": { # Google Search result content. + "is_error": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "search_suggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ { - "name": "A String", # Title of the place. - "place_id": "A String", # The ID of the place, in `places/{place_id}` format. - "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "review_id": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - ], - "widget_context_token": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "is_error": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "search_suggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mime_type": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "end_index": 42, # End of the attributed segment, exclusive. - "file_citation": { # A file citation annotation. # A file citation annotation. - "custom_metadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiValue - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiStruct # Represents a structured value. - }, - }, - ], - }, - "document_uri": "A String", # The URI of the file. - "file_name": "A String", # The name of the file. - "media_id": "A String", # Media ID in-case of image citations, if applicable. - "page_number": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "place_citation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "place_id": "A String", # The ID of the place, in `places/{place_id}` format. - "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "review_id": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. + "image": { # An image content block. + "data": "A String", # The image content. + "mime_type": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "end_index": 42, # End of the attributed segment, exclusive. + "file_citation": { # A file citation annotation. # A file citation annotation. + "custom_metadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiValue + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiStruct # Represents a structured value. + }, + }, + ], }, - ], - "url": "A String", # URI reference of the place. - }, - "start_index": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "url_citation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. + "document_uri": "A String", # The URI of the file. + "file_name": "A String", # The name of the file. + "media_id": "A String", # Media ID in-case of image citations, if applicable. + "page_number": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "place_citation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "place_id": "A String", # The ID of the place, in `places/{place_id}` format. + "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "review_id": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "start_index": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "url_citation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "server_name": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiValue ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "server_name": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiValue + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiStruct # Represents a structured value. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiStruct # Represents a structured value. }, + ], + }, + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "is_error": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. }, ], }, }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "is_error": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], + "video": { # A video content block. + "data": "A String", # The video content. + "mime_type": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. }, }, - "video": { # A video content block. - "data": "A String", # The video content. - "mime_type": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - ], + ], + }, + "contentString": "A String", # The content of the step. A single string. }, }, ], @@ -25317,6 +25447,8 @@

Method Details

], }, "created": "A String", # Required. Output only. The time at which the response was created in ISO 8601 format (YYYY-MM-DDThh:mm:ssZ). + "env_id": "A String", # The environment ID for the interaction. Can be 'remote' for default environment. + "environment_id": "A String", # Output only. The environment ID for the interaction. Only populated if environment config is set in the request. "id": "A String", # Required. Output only. A unique identifier for the interaction completion. "modelInteraction": { # Interaction for generating the completion using models. # Interaction for generating the completion using models. "generation_config": { # Configuration parameters for model interactions. # Input only. Configuration parameters for the model interaction. @@ -25801,6 +25933,28 @@

Method Details

}, ], "previous_interaction_id": "A String", # The ID of the previous interaction, if any. + "remoteEnvironment": { # Configuration for a custom environment. + "networkAllowlist": { # Network egress configuration for the environment. # Allow only specific domains. + "allowlist": [ # List of allowed domains and their configurations. + { # A network egress rule that controls which external domains the environment is allowed to reach. Each rule identifies a target domain and, optionally, a set of HTTP headers to inject into every matching outbound request. + "domain": "A String", # The domain pattern to match for this rule. Use an exact hostname (e.g., `github.com`), a wildcard prefix (e.g., `*.googleapis.com`), or `*` to match all domains. + "transform": { # Headers to inject into requests matching this rule. Key: header name (e.g., "Authorization"). Value: header value (e.g., "Bearer your-token"). + "a_key": "A String", + }, + }, + ], + }, + "networkMode": "A String", # Network egress mode. + "sources": [ + { # A source to be mounted into the environment. + "content": "A String", # The inline content if `type` is `INLINE`. + "encoding": "A String", # Optional encoding for inline content (e.g. `base64`). + "source": "A String", # The source of the environment. For GCS, this is the GCS path. For GitHub, this is the GitHub path. + "target": "A String", # Where the source should appear in the environment. + "type": "A String", + }, + ], + }, "responseFormatList": { "response_formats": [ { @@ -25857,8 +26011,6 @@

Method Details

], }, }, - "video": { # Configuration for video output format. - }, }, ], }, @@ -25916,8 +26068,6 @@

Method Details

], }, }, - "video": { # Configuration for video output format. - }, }, "response_format": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. # Enforces that the generated response is a JSON object that complies with the JSON schema specified in this field. "boolValue": True or False, # Represents a boolean value. @@ -26756,118 +26906,325 @@

Method Details

}, }, "userInput": { # Input provided by the user. - "content": [ - { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mime_type": "A String", # The mime type of the audio. - "sample_rate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mime_type": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mime_type": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "end_index": 42, # End of the attributed segment, exclusive. - "file_citation": { # A file citation annotation. # A file citation annotation. - "custom_metadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiValue - ], + "contentList": { # A list of Content. # The content of the step. An array of Content objects. + "contents": [ # The contents of the list. + { # The content of the response. + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mime_type": "A String", # The mime type of the audio. + "sample_rate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mime_type": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mime_type": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "end_index": 42, # End of the attributed segment, exclusive. + "file_citation": { # A file citation annotation. # A file citation annotation. + "custom_metadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiValue + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiStruct # Represents a structured value. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiStruct # Represents a structured value. }, + ], + }, + "document_uri": "A String", # The URI of the file. + "file_name": "A String", # The name of the file. + "media_id": "A String", # Media ID in-case of image citations, if applicable. + "page_number": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "place_citation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "place_id": "A String", # The ID of the place, in `places/{place_id}` format. + "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "review_id": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, ], + "url": "A String", # URI reference of the place. + }, + "start_index": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "url_citation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, - "document_uri": "A String", # The URI of the file. - "file_name": "A String", # The name of the file. - "media_id": "A String", # Media ID in-case of image citations, if applicable. - "page_number": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. }, - "place_citation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "place_id": "A String", # The ID of the place, in `places/{place_id}` format. - "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "review_id": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mime_type": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "end_index": 42, # End of the attributed segment, exclusive. + "file_citation": { # A file citation annotation. # A file citation annotation. + "custom_metadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiValue + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiStruct # Represents a structured value. + }, + }, + ], + }, + "document_uri": "A String", # The URI of the file. + "file_name": "A String", # The name of the file. + "media_id": "A String", # Media ID in-case of image citations, if applicable. + "page_number": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "place_citation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "place_id": "A String", # The ID of the place, in `places/{place_id}` format. + "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "review_id": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "start_index": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "url_citation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiValue + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiStruct # Represents a structured value. + }, }, ], - "url": "A String", # URI reference of the place. }, - "start_index": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "url_citation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], }, }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mime_type": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "end_index": 42, # End of the attributed segment, exclusive. - "file_citation": { # A file citation annotation. # A file citation annotation. - "custom_metadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiValue - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiStruct # Represents a structured value. + "search_type": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiValue + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiStruct # Represents a structured value. + }, + }, + ], + }, + "name": "A String", # Required. The name of the tool which was called. + "server_name": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "call_id": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "is_error": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mime_type": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "end_index": 42, # End of the attributed segment, exclusive. + "file_citation": { # A file citation annotation. # A file citation annotation. + "custom_metadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiValue + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiStruct # Represents a structured value. + }, + }, + ], }, + "document_uri": "A String", # The URI of the file. + "file_name": "A String", # The name of the file. + "media_id": "A String", # Media ID in-case of image citations, if applicable. + "page_number": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "place_citation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "place_id": "A String", # The ID of the place, in `places/{place_id}` format. + "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "review_id": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. }, + "start_index": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "url_citation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "is_error": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiValue ], }, - "document_uri": "A String", # The URI of the file. - "file_name": "A String", # The name of the file. - "media_id": "A String", # Media ID in-case of image citations, if applicable. - "page_number": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiStruct # Represents a structured value. }, - "place_citation": { # A place citation annotation. # A place citation annotation. + }, + ], + }, + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { "name": "A String", # Title of the place. "place_id": "A String", # The ID of the place, in `places/{place_id}` format. "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. @@ -26879,484 +27236,428 @@

Method Details

], "url": "A String", # URI reference of the place. }, - "start_index": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "url_citation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. + ], + "widget_context_token": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "is_error": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "search_suggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mime_type": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "end_index": 42, # End of the attributed segment, exclusive. + "file_citation": { # A file citation annotation. # A file citation annotation. + "custom_metadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiValue + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiStruct # Represents a structured value. + }, + }, + ], + }, + "document_uri": "A String", # The URI of the file. + "file_name": "A String", # The name of the file. + "media_id": "A String", # Media ID in-case of image citations, if applicable. + "page_number": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "place_citation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "place_id": "A String", # The ID of the place, in `places/{place_id}` format. + "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "review_id": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "start_index": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "url_citation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "server_name": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiValue + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiStruct # Represents a structured value. }, }, ], - "text": "A String", # Required. The text content. }, }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "is_error": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], }, }, - "fileSearchCall": { # File Search content. + "video": { # A video content block. + "data": "A String", # The video content. + "mime_type": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. }, - "functionCall": { # A function tool call content block. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiValue - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiStruct # Represents a structured value. + }, + ], + }, + "contentString": "A String", # The content of the step. A single string. + }, + }, + ], + }, + "steps": [ # Required. Output only. The steps that make up the interaction. + { # A step in the interaction. + "modelOutput": { # Output generated by the model. + "content": [ + { # The content of the response. + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mime_type": "A String", # The mime type of the audio. + "sample_rate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mime_type": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mime_type": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "end_index": 42, # End of the attributed segment, exclusive. + "file_citation": { # A file citation annotation. # A file citation annotation. + "custom_metadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiValue + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiStruct # Represents a structured value. + }, }, + ], + }, + "document_uri": "A String", # The URI of the file. + "file_name": "A String", # The name of the file. + "media_id": "A String", # Media ID in-case of image citations, if applicable. + "page_number": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "place_citation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "place_id": "A String", # The ID of the place, in `places/{place_id}` format. + "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "review_id": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, ], + "url": "A String", # URI reference of the place. }, - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], + "start_index": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "url_citation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mime_type": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. }, - "search_type": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiValue + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "end_index": 42, # End of the attributed segment, exclusive. + "file_citation": { # A file citation annotation. # A file citation annotation. + "custom_metadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiValue + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiStruct # Represents a structured value. + }, + }, ], }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiStruct # Represents a structured value. + "document_uri": "A String", # The URI of the file. + "file_name": "A String", # The name of the file. + "media_id": "A String", # Media ID in-case of image citations, if applicable. + "page_number": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "place_citation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "place_id": "A String", # The ID of the place, in `places/{place_id}` format. + "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "review_id": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "start_index": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "url_citation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, }, ], + "text": "A String", # Required. The text content. }, - "name": "A String", # Required. The name of the tool which was called. - "server_name": "A String", # Required. The name of the used MCP server. }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. }, }, - "toolResult": { # Tool result content. - "call_id": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "is_error": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiValue + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiStruct # Represents a structured value. + }, }, ], }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mime_type": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "end_index": 42, # End of the attributed segment, exclusive. - "file_citation": { # A file citation annotation. # A file citation annotation. - "custom_metadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiValue - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiStruct # Represents a structured value. - }, - }, - ], - }, - "document_uri": "A String", # The URI of the file. - "file_name": "A String", # The name of the file. - "media_id": "A String", # Media ID in-case of image citations, if applicable. - "page_number": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "place_citation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "place_id": "A String", # The ID of the place, in `places/{place_id}` format. - "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "review_id": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "start_index": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "url_citation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "is_error": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiValue - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiStruct # Represents a structured value. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "search_type": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiValue + ], }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiStruct # Represents a structured value. }, - ], - }, - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "place_id": "A String", # The ID of the place, in `places/{place_id}` format. - "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "review_id": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - ], - "widget_context_token": "A String", # Resource name of the Google Maps widget context token. }, ], }, - "googleSearchResult": { # Google Search result content. - "is_error": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "search_suggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, + "name": "A String", # Required. The name of the tool which was called. + "server_name": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", ], }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mime_type": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "end_index": 42, # End of the attributed segment, exclusive. - "file_citation": { # A file citation annotation. # A file citation annotation. - "custom_metadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiValue - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiStruct # Represents a structured value. + }, + }, + "toolResult": { # Tool result content. + "call_id": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "is_error": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mime_type": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "end_index": 42, # End of the attributed segment, exclusive. + "file_citation": { # A file citation annotation. # A file citation annotation. + "custom_metadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiValue + ], }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiStruct # Represents a structured value. }, - ], - }, - "document_uri": "A String", # The URI of the file. - "file_name": "A String", # The name of the file. - "media_id": "A String", # Media ID in-case of image citations, if applicable. - "page_number": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "place_citation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "place_id": "A String", # The ID of the place, in `places/{place_id}` format. - "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "review_id": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. }, ], - "url": "A String", # URI reference of the place. - }, - "start_index": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "url_citation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. }, + "document_uri": "A String", # The URI of the file. + "file_name": "A String", # The name of the file. + "media_id": "A String", # Media ID in-case of image citations, if applicable. + "page_number": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "place_citation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "place_id": "A String", # The ID of the place, in `places/{place_id}` format. + "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "review_id": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "start_index": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "url_citation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "server_name": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiValue - ], }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiStruct # Represents a structured value. - }, + ], + "text": "A String", # Required. The text content. }, - ], - }, - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "is_error": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. }, ], }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mime_type": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - ], - }, - }, - ], - }, - "steps": [ # Output only. The steps that make up the interaction. - { # A step in the interaction. - "modelOutput": { # Output generated by the model. - "content": [ - { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mime_type": "A String", # The mime type of the audio. - "sample_rate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mime_type": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mime_type": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "end_index": 42, # End of the attributed segment, exclusive. - "file_citation": { # A file citation annotation. # A file citation annotation. - "custom_metadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiValue - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiStruct # Represents a structured value. - }, - }, - ], - }, - "document_uri": "A String", # The URI of the file. - "file_name": "A String", # The name of the file. - "media_id": "A String", # Media ID in-case of image citations, if applicable. - "page_number": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "place_citation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "place_id": "A String", # The ID of the place, in `places/{place_id}` format. - "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "review_id": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "start_index": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "url_citation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mime_type": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "end_index": 42, # End of the attributed segment, exclusive. - "file_citation": { # A file citation annotation. # A file citation annotation. - "custom_metadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiValue - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiStruct # Represents a structured value. - }, - }, - ], - }, - "document_uri": "A String", # The URI of the file. - "file_name": "A String", # The name of the file. - "media_id": "A String", # Media ID in-case of image citations, if applicable. - "page_number": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "place_citation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "place_id": "A String", # The ID of the place, in `places/{place_id}` format. - "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "review_id": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "start_index": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "url_citation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. + "is_error": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. { # Represents a single field in a struct. "name": "A String", @@ -27375,69 +27676,37 @@

Method Details

}, ], }, - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "search_type": "A String", # The type of search grounding enabled. }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiValue - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiStruct # Represents a structured value. + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "place_id": "A String", # The ID of the place, in `places/{place_id}` format. + "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "review_id": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. }, - }, - ], - }, - "name": "A String", # Required. The name of the tool which was called. - "server_name": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, - }, - "toolResult": { # Tool result content. - "call_id": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "is_error": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. + ], + "widget_context_token": "A String", # Resource name of the Google Maps widget context token. + }, + ], }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. + "googleSearchResult": { # Google Search result content. + "is_error": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "search_suggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. }, ], }, - "functionResult": { # A function tool result content block. + "mcpServerToolResult": { # MCPServer tool result content. "contentList": { "contents": [ { @@ -27501,124 +27770,8 @@

Method Details

}, ], }, - "is_error": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiValue - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiStruct # Represents a structured value. - }, - }, - ], - }, - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "place_id": "A String", # The ID of the place, in `places/{place_id}` format. - "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "review_id": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - ], - "widget_context_token": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "is_error": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "search_suggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mime_type": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "end_index": 42, # End of the attributed segment, exclusive. - "file_citation": { # A file citation annotation. # A file citation annotation. - "custom_metadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiValue - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiStruct # Represents a structured value. - }, - }, - ], - }, - "document_uri": "A String", # The URI of the file. - "file_name": "A String", # The name of the file. - "media_id": "A String", # Media ID in-case of image citations, if applicable. - "page_number": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "place_citation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "place_id": "A String", # The ID of the place, in `places/{place_id}` format. - "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "review_id": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "start_index": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "url_citation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "server_name": "A String", # The name of the used MCP server. + "name": "A String", # Name of the tool which is called for this specific tool call. + "server_name": "A String", # The name of the used MCP server. "stringResult": "A String", "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. @@ -28026,454 +28179,457 @@

Method Details

}, }, "userInput": { # Input provided by the user. - "content": [ - { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mime_type": "A String", # The mime type of the audio. - "sample_rate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mime_type": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mime_type": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "end_index": 42, # End of the attributed segment, exclusive. - "file_citation": { # A file citation annotation. # A file citation annotation. - "custom_metadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiValue - ], + "contentList": { # A list of Content. # The content of the step. An array of Content objects. + "contents": [ # The contents of the list. + { # The content of the response. + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mime_type": "A String", # The mime type of the audio. + "sample_rate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mime_type": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mime_type": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "end_index": 42, # End of the attributed segment, exclusive. + "file_citation": { # A file citation annotation. # A file citation annotation. + "custom_metadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiValue + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiStruct # Represents a structured value. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiStruct # Represents a structured value. }, + ], + }, + "document_uri": "A String", # The URI of the file. + "file_name": "A String", # The name of the file. + "media_id": "A String", # Media ID in-case of image citations, if applicable. + "page_number": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "place_citation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "place_id": "A String", # The ID of the place, in `places/{place_id}` format. + "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "review_id": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, ], + "url": "A String", # URI reference of the place. + }, + "start_index": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "url_citation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, - "document_uri": "A String", # The URI of the file. - "file_name": "A String", # The name of the file. - "media_id": "A String", # Media ID in-case of image citations, if applicable. - "page_number": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "place_citation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "place_id": "A String", # The ID of the place, in `places/{place_id}` format. - "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "review_id": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "start_index": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "url_citation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mime_type": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "end_index": 42, # End of the attributed segment, exclusive. - "file_citation": { # A file citation annotation. # A file citation annotation. - "custom_metadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiValue - ], + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mime_type": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "end_index": 42, # End of the attributed segment, exclusive. + "file_citation": { # A file citation annotation. # A file citation annotation. + "custom_metadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiValue + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiStruct # Represents a structured value. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiStruct # Represents a structured value. }, + ], + }, + "document_uri": "A String", # The URI of the file. + "file_name": "A String", # The name of the file. + "media_id": "A String", # Media ID in-case of image citations, if applicable. + "page_number": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "place_citation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "place_id": "A String", # The ID of the place, in `places/{place_id}` format. + "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "review_id": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, ], + "url": "A String", # URI reference of the place. + }, + "start_index": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "url_citation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, - "document_uri": "A String", # The URI of the file. - "file_name": "A String", # The name of the file. - "media_id": "A String", # Media ID in-case of image citations, if applicable. - "page_number": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "place_citation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "place_id": "A String", # The ID of the place, in `places/{place_id}` format. - "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "review_id": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. }, - "start_index": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "url_citation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiValue + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiStruct # Represents a structured value. }, }, ], - "text": "A String", # Required. The text content. }, + "name": "A String", # Required. The name of the tool to call. }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiValue - ], + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "search_type": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiValue + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiStruct # Represents a structured value. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiStruct # Represents a structured value. }, - }, - ], + ], + }, + "name": "A String", # Required. The name of the tool which was called. + "server_name": "A String", # Required. The name of the used MCP server. }, - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, }, }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], + "toolResult": { # Tool result content. + "call_id": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "is_error": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. }, - "search_type": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiValue - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiStruct # Represents a structured value. - }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. }, ], }, - "name": "A String", # Required. The name of the tool which was called. - "server_name": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, - }, - "toolResult": { # Tool result content. - "call_id": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "is_error": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mime_type": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "end_index": 42, # End of the attributed segment, exclusive. - "file_citation": { # A file citation annotation. # A file citation annotation. - "custom_metadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiValue - ], + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mime_type": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "end_index": 42, # End of the attributed segment, exclusive. + "file_citation": { # A file citation annotation. # A file citation annotation. + "custom_metadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiValue + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiStruct # Represents a structured value. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiStruct # Represents a structured value. }, + ], + }, + "document_uri": "A String", # The URI of the file. + "file_name": "A String", # The name of the file. + "media_id": "A String", # Media ID in-case of image citations, if applicable. + "page_number": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "place_citation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "place_id": "A String", # The ID of the place, in `places/{place_id}` format. + "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "review_id": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, ], + "url": "A String", # URI reference of the place. + }, + "start_index": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "url_citation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, - "document_uri": "A String", # The URI of the file. - "file_name": "A String", # The name of the file. - "media_id": "A String", # Media ID in-case of image citations, if applicable. - "page_number": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "place_citation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "place_id": "A String", # The ID of the place, in `places/{place_id}` format. - "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "review_id": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "start_index": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "url_citation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "is_error": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiValue + ], }, - ], - "text": "A String", # Required. The text content. + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiStruct # Represents a structured value. + }, }, - }, - ], + ], + }, }, - "is_error": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiValue + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "place_id": "A String", # The ID of the place, in `places/{place_id}` format. + "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "review_id": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, ], + "url": "A String", # URI reference of the place. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiStruct # Represents a structured value. - }, + ], + "widget_context_token": "A String", # Resource name of the Google Maps widget context token. }, ], }, - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. + "googleSearchResult": { # Google Search result content. + "is_error": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "search_suggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ { - "name": "A String", # Title of the place. - "place_id": "A String", # The ID of the place, in `places/{place_id}` format. - "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "review_id": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. + "image": { # An image content block. + "data": "A String", # The image content. + "mime_type": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "end_index": 42, # End of the attributed segment, exclusive. + "file_citation": { # A file citation annotation. # A file citation annotation. + "custom_metadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiValue + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiStruct # Represents a structured value. + }, + }, + ], + }, + "document_uri": "A String", # The URI of the file. + "file_name": "A String", # The name of the file. + "media_id": "A String", # Media ID in-case of image citations, if applicable. + "page_number": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "place_citation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "place_id": "A String", # The ID of the place, in `places/{place_id}` format. + "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "review_id": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "start_index": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "url_citation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, }, ], - "widget_context_token": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "is_error": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "search_suggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mime_type": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "end_index": 42, # End of the attributed segment, exclusive. - "file_citation": { # A file citation annotation. # A file citation annotation. - "custom_metadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiValue - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiStruct # Represents a structured value. - }, - }, - ], - }, - "document_uri": "A String", # The URI of the file. - "file_name": "A String", # The name of the file. - "media_id": "A String", # Media ID in-case of image citations, if applicable. - "page_number": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "place_citation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "place_id": "A String", # The ID of the place, in `places/{place_id}` format. - "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "review_id": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "start_index": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "url_citation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "server_name": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiValue + ], }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "server_name": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiValue - ], + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiStruct # Represents a structured value. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiStruct # Represents a structured value. }, + ], + }, + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "is_error": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. }, ], }, }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "is_error": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], + "video": { # A video content block. + "data": "A String", # The video content. + "mime_type": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. }, }, - "video": { # A video content block. - "data": "A String", # The video content. - "mime_type": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - ], + ], + }, + "contentString": "A String", # The content of the step. A single string. }, }, ], @@ -28976,108 +29132,428 @@

Method Details

# Object with schema name: GenaiValue ], }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiStruct # Represents a structured value. + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiStruct # Represents a structured value. + }, + }, + ], + }, + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "is_error": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mime_type": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + ], + }, + "contentString": "A String", # The content of the turn. A single string. + "role": "A String", # The originator of this turn. Must be user for input or model for model output. + }, + ], + }, + "updated": "A String", # Required. Output only. The time at which the response was last updated in ISO 8601 format (YYYY-MM-DDThh:mm:ssZ). + "usage": { # Statistics on the interaction request's token usage. # Output only. Statistics on the interaction request's token usage. + "cached_tokens_by_modality": [ # A breakdown of cached token usage by modality. + { # The token count for a single response modality. + "modality": "A String", # The modality associated with the token count. + "tokens": 42, # Number of tokens for the modality. + }, + ], + "grounding_tool_count": [ # Grounding tool count. + { # The number of grounding tool counts. + "count": 42, # The number of grounding tool counts. + "type": "A String", # The grounding tool type associated with the count. + }, + ], + "input_tokens_by_modality": [ # A breakdown of input token usage by modality. + { # The token count for a single response modality. + "modality": "A String", # The modality associated with the token count. + "tokens": 42, # Number of tokens for the modality. + }, + ], + "output_tokens_by_modality": [ # A breakdown of output token usage by modality. + { # The token count for a single response modality. + "modality": "A String", # The modality associated with the token count. + "tokens": 42, # Number of tokens for the modality. + }, + ], + "tool_use_tokens_by_modality": [ # A breakdown of tool-use token usage by modality. + { # The token count for a single response modality. + "modality": "A String", # The modality associated with the token count. + "tokens": 42, # Number of tokens for the modality. + }, + ], + "total_cached_tokens": 42, # Number of tokens in the cached part of the prompt (the cached content). + "total_input_tokens": 42, # Number of tokens in the prompt (context). + "total_output_tokens": 42, # Total number of tokens across all the generated responses. + "total_thought_tokens": 42, # Number of tokens of thoughts for thinking models. + "total_tokens": 42, # Total token count for the interaction request (prompt + responses + other internal tokens). + "total_tool_use_tokens": 42, # Number of tokens present in tool-use prompt(s). + }, + }, + }, + "interactionStatusUpdate": { # The interaction status data, used for interaction.status_update events. + "interaction_id": "A String", + "status": "A String", + }, + "metadata": { # Optional metadata accompanying ANY streamed event. + "usage": { # Statistics on the interaction request's token usage. + "cached_tokens_by_modality": [ # A breakdown of cached token usage by modality. + { # The token count for a single response modality. + "modality": "A String", # The modality associated with the token count. + "tokens": 42, # Number of tokens for the modality. + }, + ], + "grounding_tool_count": [ # Grounding tool count. + { # The number of grounding tool counts. + "count": 42, # The number of grounding tool counts. + "type": "A String", # The grounding tool type associated with the count. + }, + ], + "input_tokens_by_modality": [ # A breakdown of input token usage by modality. + { # The token count for a single response modality. + "modality": "A String", # The modality associated with the token count. + "tokens": 42, # Number of tokens for the modality. + }, + ], + "output_tokens_by_modality": [ # A breakdown of output token usage by modality. + { # The token count for a single response modality. + "modality": "A String", # The modality associated with the token count. + "tokens": 42, # Number of tokens for the modality. + }, + ], + "tool_use_tokens_by_modality": [ # A breakdown of tool-use token usage by modality. + { # The token count for a single response modality. + "modality": "A String", # The modality associated with the token count. + "tokens": 42, # Number of tokens for the modality. + }, + ], + "total_cached_tokens": 42, # Number of tokens in the cached part of the prompt (the cached content). + "total_input_tokens": 42, # Number of tokens in the prompt (context). + "total_output_tokens": 42, # Total number of tokens across all the generated responses. + "total_thought_tokens": 42, # Number of tokens of thoughts for thinking models. + "total_tokens": 42, # Total token count for the interaction request (prompt + responses + other internal tokens). + "total_tool_use_tokens": 42, # Number of tokens present in tool-use prompt(s). + }, + }, + "stepDelta": { # The step delta data, used for step.delta events. + "delta": { + "argumentsDelta": { + "arguments": "A String", + }, + "audio": { + "channels": 42, # The number of audio channels. + "data": "A String", + "mime_type": "A String", + "rate": 42, # Deprecated. Use sample_rate instead. The value is ignored. + "sample_rate": 42, # The sample rate of the audio. + "uri": "A String", + }, + "document": { + "data": "A String", + "mime_type": "A String", + "uri": "A String", + }, + "functionResult": { + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mime_type": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "end_index": 42, # End of the attributed segment, exclusive. + "file_citation": { # A file citation annotation. # A file citation annotation. + "custom_metadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiValue + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiStruct # Represents a structured value. + }, + }, + ], + }, + "document_uri": "A String", # The URI of the file. + "file_name": "A String", # The name of the file. + "media_id": "A String", # Media ID in-case of image citations, if applicable. + "page_number": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "place_citation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "place_id": "A String", # The ID of the place, in `places/{place_id}` format. + "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "review_id": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "start_index": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "url_citation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "is_error": True or False, + "name": "A String", + "stringResult": "A String", + "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiValue + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiStruct # Represents a structured value. + }, + }, + ], + }, + }, + "image": { + "data": "A String", + "mime_type": "A String", + "resolution": "A String", # The resolution of the media. + "uri": "A String", + }, + "serverToolCall": { + "codeExecutionCall": { + "arguments": { # The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { + }, + "googleMapsCall": { + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { + "arguments": { # The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + }, + "mcpServerToolCall": { + "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiValue + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiStruct # Represents a structured value. + }, + }, + ], + }, + "name": "A String", + "server_name": "A String", + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { + "arguments": { # The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "serverToolResult": { + "codeExecutionResult": { + "is_error": True or False, + "result": "A String", + }, + "fileSearchResult": { + "result": [ + { # The result of the File Search. + }, + ], + }, + "googleMapsResult": { + "result": [ # The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "place_id": "A String", # The ID of the place, in `places/{place_id}` format. + "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "review_id": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widget_context_token": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { + "is_error": True or False, + "result": [ + { # The result of the Google Search. + "search_suggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mime_type": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "end_index": 42, # End of the attributed segment, exclusive. + "file_citation": { # A file citation annotation. # A file citation annotation. + "custom_metadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiValue + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiStruct # Represents a structured value. + }, }, + ], + }, + "document_uri": "A String", # The URI of the file. + "file_name": "A String", # The name of the file. + "media_id": "A String", # Media ID in-case of image citations, if applicable. + "page_number": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "place_citation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "place_id": "A String", # The ID of the place, in `places/{place_id}` format. + "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "review_id": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, ], + "url": "A String", # URI reference of the place. + }, + "start_index": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "url_citation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "is_error": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], - }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mime_type": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, + ], + "text": "A String", # Required. The text content. }, - ], - }, - "contentString": "A String", # The content of the turn. A single string. - "role": "A String", # The originator of this turn. Must be user for input or model for model output. - }, - ], - }, - "updated": "A String", # Required. Output only. The time at which the response was last updated in ISO 8601 format (YYYY-MM-DDThh:mm:ssZ). - "usage": { # Statistics on the interaction request's token usage. # Output only. Statistics on the interaction request's token usage. - "cached_tokens_by_modality": [ # A breakdown of cached token usage by modality. - { # The token count for a single response modality. - "modality": "A String", # The modality associated with the token count. - "tokens": 42, # Number of tokens for the modality. - }, - ], - "grounding_tool_count": [ # Grounding tool count. - { # The number of grounding tool counts. - "count": 42, # The number of grounding tool counts. - "type": "A String", # The grounding tool type associated with the count. - }, - ], - "input_tokens_by_modality": [ # A breakdown of input token usage by modality. - { # The token count for a single response modality. - "modality": "A String", # The modality associated with the token count. - "tokens": 42, # Number of tokens for the modality. - }, - ], - "output_tokens_by_modality": [ # A breakdown of output token usage by modality. - { # The token count for a single response modality. - "modality": "A String", # The modality associated with the token count. - "tokens": 42, # Number of tokens for the modality. + }, + ], }, - ], - "tool_use_tokens_by_modality": [ # A breakdown of tool-use token usage by modality. - { # The token count for a single response modality. - "modality": "A String", # The modality associated with the token count. - "tokens": 42, # Number of tokens for the modality. + "name": "A String", + "server_name": "A String", + "stringResult": "A String", + "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiValue + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiStruct # Represents a structured value. + }, + }, + ], }, - ], - "total_cached_tokens": 42, # Number of tokens in the cached part of the prompt (the cached content). - "total_input_tokens": 42, # Number of tokens in the prompt (context). - "total_output_tokens": 42, # Total number of tokens across all the generated responses. - "total_thought_tokens": 42, # Number of tokens of thoughts for thinking models. - "total_tokens": 42, # Total token count for the interaction request (prompt + responses + other internal tokens). - "total_tool_use_tokens": 42, # Number of tokens present in tool-use prompt(s). - }, - }, - }, - "interactionStatusUpdate": { # The interaction status data, used for interaction.status_update events. - "interaction_id": "A String", - "status": "A String", - }, - "stepDelta": { # The step delta data, used for step.delta events. - "delta": { - "argumentsDelta": { - "partial_arguments": "A String", - }, - "audio": { - "channels": 42, # The number of audio channels. - "data": "A String", - "mime_type": "A String", - "rate": 42, # Deprecated. Use sample_rate instead. The value is ignored. - "sample_rate": 42, # The sample rate of the audio. - "uri": "A String", - }, - "document": { - "data": "A String", - "mime_type": "A String", - "uri": "A String", - }, - "image": { - "data": "A String", - "mime_type": "A String", - "resolution": "A String", # The resolution of the media. - "uri": "A String", + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { + "is_error": True or False, + "result": [ + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, }, "text": { "text": "A String", @@ -29983,495 +30459,498 @@

Method Details

"url": "A String", # The URL. }, }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "server_name": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiValue - ], + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "server_name": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiValue + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiStruct # Represents a structured value. + }, + }, + ], + }, + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result step. + "is_error": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, + }, + "userInput": { # Input provided by the user. + "contentList": { # A list of Content. # The content of the step. An array of Content objects. + "contents": [ # The contents of the list. + { # The content of the response. + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mime_type": "A String", # The mime type of the audio. + "sample_rate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mime_type": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mime_type": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "end_index": 42, # End of the attributed segment, exclusive. + "file_citation": { # A file citation annotation. # A file citation annotation. + "custom_metadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiValue + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiStruct # Represents a structured value. + }, + }, + ], + }, + "document_uri": "A String", # The URI of the file. + "file_name": "A String", # The name of the file. + "media_id": "A String", # Media ID in-case of image citations, if applicable. + "page_number": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "place_citation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "place_id": "A String", # The ID of the place, in `places/{place_id}` format. + "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "review_id": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "start_index": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "url_citation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiStruct # Represents a structured value. - }, + ], + "text": "A String", # Required. The text content. }, - ], - }, - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result step. - "is_error": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], - }, - }, - "userInput": { # Input provided by the user. - "content": [ - { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mime_type": "A String", # The mime type of the audio. - "sample_rate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mime_type": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mime_type": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "end_index": 42, # End of the attributed segment, exclusive. - "file_citation": { # A file citation annotation. # A file citation annotation. - "custom_metadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiValue + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mime_type": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "end_index": 42, # End of the attributed segment, exclusive. + "file_citation": { # A file citation annotation. # A file citation annotation. + "custom_metadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiValue + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiStruct # Represents a structured value. + }, + }, ], }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiStruct # Represents a structured value. + "document_uri": "A String", # The URI of the file. + "file_name": "A String", # The name of the file. + "media_id": "A String", # Media ID in-case of image citations, if applicable. + "page_number": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "place_citation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "place_id": "A String", # The ID of the place, in `places/{place_id}` format. + "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "review_id": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "start_index": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "url_citation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, }, ], + "text": "A String", # Required. The text content. }, - "document_uri": "A String", # The URI of the file. - "file_name": "A String", # The name of the file. - "media_id": "A String", # Media ID in-case of image citations, if applicable. - "page_number": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "place_citation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "place_id": "A String", # The ID of the place, in `places/{place_id}` format. - "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "review_id": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. }, - "start_index": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "url_citation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. }, }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mime_type": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "end_index": 42, # End of the attributed segment, exclusive. - "file_citation": { # A file citation annotation. # A file citation annotation. - "custom_metadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiValue - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiStruct # Represents a structured value. - }, - }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiValue ], }, - "document_uri": "A String", # The URI of the file. - "file_name": "A String", # The name of the file. - "media_id": "A String", # Media ID in-case of image citations, if applicable. - "page_number": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "place_citation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "place_id": "A String", # The ID of the place, in `places/{place_id}` format. - "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "review_id": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "start_index": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "url_citation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiStruct # Represents a structured value. }, }, ], - "text": "A String", # Required. The text content. + }, + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], }, }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "search_type": "A String", # The type of search grounding enabled. }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiValue - ], + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiValue + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiStruct # Represents a structured value. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiStruct # Represents a structured value. }, - }, - ], + ], + }, + "name": "A String", # Required. The name of the tool which was called. + "server_name": "A String", # Required. The name of the used MCP server. }, - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, }, }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], + "toolResult": { # Tool result content. + "call_id": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "is_error": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. }, - "search_type": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiValue - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiStruct # Represents a structured value. - }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. }, ], }, - "name": "A String", # Required. The name of the tool which was called. - "server_name": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, - }, - "toolResult": { # Tool result content. - "call_id": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "is_error": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mime_type": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "end_index": 42, # End of the attributed segment, exclusive. - "file_citation": { # A file citation annotation. # A file citation annotation. - "custom_metadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiValue - ], + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mime_type": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "end_index": 42, # End of the attributed segment, exclusive. + "file_citation": { # A file citation annotation. # A file citation annotation. + "custom_metadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiValue + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiStruct # Represents a structured value. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiStruct # Represents a structured value. }, + ], + }, + "document_uri": "A String", # The URI of the file. + "file_name": "A String", # The name of the file. + "media_id": "A String", # Media ID in-case of image citations, if applicable. + "page_number": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "place_citation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "place_id": "A String", # The ID of the place, in `places/{place_id}` format. + "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "review_id": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, ], + "url": "A String", # URI reference of the place. + }, + "start_index": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "url_citation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, - "document_uri": "A String", # The URI of the file. - "file_name": "A String", # The name of the file. - "media_id": "A String", # Media ID in-case of image citations, if applicable. - "page_number": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "place_citation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "place_id": "A String", # The ID of the place, in `places/{place_id}` format. - "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "review_id": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "start_index": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "url_citation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "is_error": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiValue + ], }, - ], - "text": "A String", # Required. The text content. + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiStruct # Represents a structured value. + }, }, - }, - ], + ], + }, }, - "is_error": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiValue + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "place_id": "A String", # The ID of the place, in `places/{place_id}` format. + "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "review_id": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, ], + "url": "A String", # URI reference of the place. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiStruct # Represents a structured value. - }, + ], + "widget_context_token": "A String", # Resource name of the Google Maps widget context token. }, ], }, - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. + "googleSearchResult": { # Google Search result content. + "is_error": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "search_suggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ { - "name": "A String", # Title of the place. - "place_id": "A String", # The ID of the place, in `places/{place_id}` format. - "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "review_id": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - ], - "widget_context_token": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "is_error": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "search_suggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mime_type": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "end_index": 42, # End of the attributed segment, exclusive. - "file_citation": { # A file citation annotation. # A file citation annotation. - "custom_metadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiValue - ], + "image": { # An image content block. + "data": "A String", # The image content. + "mime_type": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "end_index": 42, # End of the attributed segment, exclusive. + "file_citation": { # A file citation annotation. # A file citation annotation. + "custom_metadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiValue + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiStruct # Represents a structured value. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiStruct # Represents a structured value. }, + ], + }, + "document_uri": "A String", # The URI of the file. + "file_name": "A String", # The name of the file. + "media_id": "A String", # Media ID in-case of image citations, if applicable. + "page_number": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "place_citation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "place_id": "A String", # The ID of the place, in `places/{place_id}` format. + "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "review_id": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, ], + "url": "A String", # URI reference of the place. + }, + "start_index": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "url_citation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, - "document_uri": "A String", # The URI of the file. - "file_name": "A String", # The name of the file. - "media_id": "A String", # Media ID in-case of image citations, if applicable. - "page_number": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "place_citation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "place_id": "A String", # The ID of the place, in `places/{place_id}` format. - "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "review_id": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "start_index": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "url_citation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "server_name": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiValue ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "server_name": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiValue + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiStruct # Represents a structured value. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiStruct # Represents a structured value. }, + ], + }, + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "is_error": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. }, ], }, }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "is_error": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], + "video": { # A video content block. + "data": "A String", # The video content. + "mime_type": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. }, }, - "video": { # A video content block. - "data": "A String", # The video content. - "mime_type": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - ], + ], + }, + "contentString": "A String", # The content of the step. A single string. }, }, }, diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.agents.html b/docs/dyn/aiplatform_v1beta1.projects.locations.agents.html index 84acb4cdd9..e273abf416 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.agents.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.agents.html @@ -84,22 +84,22 @@

Instance Methods

Close httplib2 connections.

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

-

Creates a new Agent in a given location.

+

Creates an agent.

delete(name, x__xgafv=None)

-

Deletes the specific Agent.

+

Deletes an agent.

get(name, x__xgafv=None)

-

Gets details of the specific Agent.

+

Retrieves an agent.

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

-

Lists Agents in a given location.

+

Lists agents in a location.

list_next()

Retrieves the next page of results.

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

-

Updates the specific Agent.

+

Updates an agent.

Method Details

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

Method Details

create(parent, body=None, x__xgafv=None) -
Creates a new Agent in a given location.
+  
Creates an agent.
 
 Args:
   parent: string, Required. The resource name of the location to create the agent in. Format: `projects/{project}/locations/{location}`. (required)
@@ -116,28 +116,28 @@ 

Method Details

The object takes the form of: { # A Vertex agent contains instructions and configurations for the LLM to execute a certain task. - "base_agent": "A String", # Required. The base agent of the agent. Supported values: - "antigravity-preview-05-2026" - "base_environment": "", # Optional. The environment config of the agent. Valid types are: - string value for environment_id, or 'remote' for default - struct value for EnvironmentConfig. - "created": "A String", # Output only. Timestamp when the agent was created. + "base_agent": "A String", # Required. The base agent for the agent. Supported values: * `antigravity-preview-05-2026` + "base_environment": "", # Optional. The base environment configuration for the agent. Valid types: * A string value for the environment ID, or `remote` for the default. * A struct value for the `environment_config`. + "created": "A String", # Output only. The time the agent was created. "description": "A String", # Optional. The description of the agent. - "id": "A String", # Immutable. The ID to use for agent, which will become the final component of the agent resource name. If not provided, Vertex AI will generate a value for this ID. This value may be up to 63 characters, and valid characters are `[a-z0-9-]`. The first character must be a letter, the last character must be a letter or number. - "metadata": { # Optional. The metadata of the agent. + "id": "A String", # Immutable. The user-specified ID for the agent. This ID becomes the final component of the agent resource name. If not provided, Vertex AI will generate a value for this ID. The ID can be up to 63 characters and must match the regular expression `[a-z]([a-z0-9-]{0,61}[a-z0-9])?`. + "metadata": { # Optional. The metadata for the agent. "a_key": "A String", }, - "name": "A String", # Identifier. The resource name of the Agent. Format: `projects/{project}/locations/{location}/agents/{agent}`. - "object": "A String", # Output only. The object type of this resource. Always set to "agent" in this case. - "system_instruction": "A String", # Optional. The detailed struction that the agent should follow. The instruction is passed to LLM as system instruction. - "tools": [ # Optional. A list of tools that are available for the agent during the process of execucting the task. - { # A tool provides a list of actions that are available for the Agent during the process of executing the task. - "headers": { # Optional. Headers for the MCP server (e.g., authentication). Only applicable when `type` is "mcp". + "name": "A String", # Identifier. The resource name of the agent. Format: `projects/{project}/locations/{location}/agents/{agent}`. + "object": "A String", # Output only. The object type of the resource. For agents, the value is `agent`. + "system_instruction": "A String", # Optional. The instructions for the agent to follow. These instructions are passed to the LLM as a system instruction. + "tools": [ # Optional. The tools available to the agent. + { # A tool provides a list of actions available to the Agent during the process of executing a task. + "headers": { # Optional. The headers for the MCP server, such as for authentication. Only applicable when `type` is `mcp_server`. "a_key": "A String", }, - "name": "A String", # Optional. The name of the MCP server. Only applicable when `type` is "mcp". - "type": "A String", # Required. Type of the tool. Supported types: - "code_execution" - "filesystem" - "google_search" - "mcp" - "url_context" - "url": "A String", # Optional. The full URL for the MCP server endpoint. Only applicable when `type` is "mcp". + "name": "A String", # Optional. The name of the MCP server. Only applicable when `type` is `mcp_server`. + "type": "A String", # Required. The type of the tool. Supported types: * `code_execution` * `filesystem` * `google_search` * `mcp_server` * `url_context` + "url": "A String", # Optional. The URL for the MCP server endpoint. Only applicable when `type` is `mcp_server`. }, ], - "updated": "A String", # Output only. Timestamp when the agent was last updated. + "updated": "A String", # Output only. The time the agent was last updated. } x__xgafv: string, V1 error format. @@ -171,10 +171,10 @@

Method Details

delete(name, x__xgafv=None) -
Deletes the specific Agent.
+  
Deletes an agent.
 
 Args:
-  name: string, Required. The resource name of the agent. Format: `projects/{project}/locations/{location}/agents/{agent}` (required)
+  name: string, Required. The resource name of the agent to delete. Format: `projects/{project}/locations/{location}/agents/{agent}`. (required)
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -206,10 +206,10 @@ 

Method Details

get(name, x__xgafv=None) -
Gets details of the specific Agent.
+  
Retrieves an agent.
 
 Args:
-  name: string, Required. The resource name of the agent. Format: `projects/{project}/locations/{location}/agents/{agent}`. (required)
+  name: string, Required. The resource name of the agent to retrieve. Format: `projects/{project}/locations/{location}/agents/{agent}`. (required)
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -219,40 +219,40 @@ 

Method Details

An object of the form: { # A Vertex agent contains instructions and configurations for the LLM to execute a certain task. - "base_agent": "A String", # Required. The base agent of the agent. Supported values: - "antigravity-preview-05-2026" - "base_environment": "", # Optional. The environment config of the agent. Valid types are: - string value for environment_id, or 'remote' for default - struct value for EnvironmentConfig. - "created": "A String", # Output only. Timestamp when the agent was created. + "base_agent": "A String", # Required. The base agent for the agent. Supported values: * `antigravity-preview-05-2026` + "base_environment": "", # Optional. The base environment configuration for the agent. Valid types: * A string value for the environment ID, or `remote` for the default. * A struct value for the `environment_config`. + "created": "A String", # Output only. The time the agent was created. "description": "A String", # Optional. The description of the agent. - "id": "A String", # Immutable. The ID to use for agent, which will become the final component of the agent resource name. If not provided, Vertex AI will generate a value for this ID. This value may be up to 63 characters, and valid characters are `[a-z0-9-]`. The first character must be a letter, the last character must be a letter or number. - "metadata": { # Optional. The metadata of the agent. + "id": "A String", # Immutable. The user-specified ID for the agent. This ID becomes the final component of the agent resource name. If not provided, Vertex AI will generate a value for this ID. The ID can be up to 63 characters and must match the regular expression `[a-z]([a-z0-9-]{0,61}[a-z0-9])?`. + "metadata": { # Optional. The metadata for the agent. "a_key": "A String", }, - "name": "A String", # Identifier. The resource name of the Agent. Format: `projects/{project}/locations/{location}/agents/{agent}`. - "object": "A String", # Output only. The object type of this resource. Always set to "agent" in this case. - "system_instruction": "A String", # Optional. The detailed struction that the agent should follow. The instruction is passed to LLM as system instruction. - "tools": [ # Optional. A list of tools that are available for the agent during the process of execucting the task. - { # A tool provides a list of actions that are available for the Agent during the process of executing the task. - "headers": { # Optional. Headers for the MCP server (e.g., authentication). Only applicable when `type` is "mcp". + "name": "A String", # Identifier. The resource name of the agent. Format: `projects/{project}/locations/{location}/agents/{agent}`. + "object": "A String", # Output only. The object type of the resource. For agents, the value is `agent`. + "system_instruction": "A String", # Optional. The instructions for the agent to follow. These instructions are passed to the LLM as a system instruction. + "tools": [ # Optional. The tools available to the agent. + { # A tool provides a list of actions available to the Agent during the process of executing a task. + "headers": { # Optional. The headers for the MCP server, such as for authentication. Only applicable when `type` is `mcp_server`. "a_key": "A String", }, - "name": "A String", # Optional. The name of the MCP server. Only applicable when `type` is "mcp". - "type": "A String", # Required. Type of the tool. Supported types: - "code_execution" - "filesystem" - "google_search" - "mcp" - "url_context" - "url": "A String", # Optional. The full URL for the MCP server endpoint. Only applicable when `type` is "mcp". + "name": "A String", # Optional. The name of the MCP server. Only applicable when `type` is `mcp_server`. + "type": "A String", # Required. The type of the tool. Supported types: * `code_execution` * `filesystem` * `google_search` * `mcp_server` * `url_context` + "url": "A String", # Optional. The URL for the MCP server endpoint. Only applicable when `type` is `mcp_server`. }, ], - "updated": "A String", # Output only. Timestamp when the agent was last updated. + "updated": "A String", # Output only. The time the agent was last updated. }
list(parent, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None) -
Lists Agents in a given location.
+  
Lists agents in a location.
 
 Args:
-  parent: string, Required. The resource name of the location to list agents from. Format: `projects/{project}/locations/{location} (required)
-  orderBy: string, Optional. A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `create_time` * `update_time` Example: `create_time desc`.
-  pageSize: integer, Optional. The maximum number of agents to return. The service may return fewer than this value. If unspecified, at most 100 agents will be returned.
-  pageToken: string, Optional. The next_page_token value returned from a previous list AgentService.ListAgents call.
+  parent: string, Required. The resource name of the location to list agents from. Format: `projects/{project}/locations/{location}`. (required)
+  orderBy: string, Optional. A comma-separated list of fields to order by. Supported fields: * `create_time` * `update_time` Use `desc` after a field name for descending order. Example: `create_time desc`.
+  pageSize: integer, Optional. The maximum number of agents to return. The service may return fewer than this value. The maximum page size is 100; values above 100 will be coerced to 100. If unspecified, the default page size is 10.
+  pageToken: string, Optional. A page token, received from a previous AgentService.ListAgents call. Provide this to retrieve the subsequent page.
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -262,33 +262,33 @@ 

Method Details

An object of the form: { # Response message for AgentService.ListAgents. - "agents": [ # A list of agents matching the request. + "agents": [ # The agents matching the request. { # A Vertex agent contains instructions and configurations for the LLM to execute a certain task. - "base_agent": "A String", # Required. The base agent of the agent. Supported values: - "antigravity-preview-05-2026" - "base_environment": "", # Optional. The environment config of the agent. Valid types are: - string value for environment_id, or 'remote' for default - struct value for EnvironmentConfig. - "created": "A String", # Output only. Timestamp when the agent was created. + "base_agent": "A String", # Required. The base agent for the agent. Supported values: * `antigravity-preview-05-2026` + "base_environment": "", # Optional. The base environment configuration for the agent. Valid types: * A string value for the environment ID, or `remote` for the default. * A struct value for the `environment_config`. + "created": "A String", # Output only. The time the agent was created. "description": "A String", # Optional. The description of the agent. - "id": "A String", # Immutable. The ID to use for agent, which will become the final component of the agent resource name. If not provided, Vertex AI will generate a value for this ID. This value may be up to 63 characters, and valid characters are `[a-z0-9-]`. The first character must be a letter, the last character must be a letter or number. - "metadata": { # Optional. The metadata of the agent. + "id": "A String", # Immutable. The user-specified ID for the agent. This ID becomes the final component of the agent resource name. If not provided, Vertex AI will generate a value for this ID. The ID can be up to 63 characters and must match the regular expression `[a-z]([a-z0-9-]{0,61}[a-z0-9])?`. + "metadata": { # Optional. The metadata for the agent. "a_key": "A String", }, - "name": "A String", # Identifier. The resource name of the Agent. Format: `projects/{project}/locations/{location}/agents/{agent}`. - "object": "A String", # Output only. The object type of this resource. Always set to "agent" in this case. - "system_instruction": "A String", # Optional. The detailed struction that the agent should follow. The instruction is passed to LLM as system instruction. - "tools": [ # Optional. A list of tools that are available for the agent during the process of execucting the task. - { # A tool provides a list of actions that are available for the Agent during the process of executing the task. - "headers": { # Optional. Headers for the MCP server (e.g., authentication). Only applicable when `type` is "mcp". + "name": "A String", # Identifier. The resource name of the agent. Format: `projects/{project}/locations/{location}/agents/{agent}`. + "object": "A String", # Output only. The object type of the resource. For agents, the value is `agent`. + "system_instruction": "A String", # Optional. The instructions for the agent to follow. These instructions are passed to the LLM as a system instruction. + "tools": [ # Optional. The tools available to the agent. + { # A tool provides a list of actions available to the Agent during the process of executing a task. + "headers": { # Optional. The headers for the MCP server, such as for authentication. Only applicable when `type` is `mcp_server`. "a_key": "A String", }, - "name": "A String", # Optional. The name of the MCP server. Only applicable when `type` is "mcp". - "type": "A String", # Required. Type of the tool. Supported types: - "code_execution" - "filesystem" - "google_search" - "mcp" - "url_context" - "url": "A String", # Optional. The full URL for the MCP server endpoint. Only applicable when `type` is "mcp". + "name": "A String", # Optional. The name of the MCP server. Only applicable when `type` is `mcp_server`. + "type": "A String", # Required. The type of the tool. Supported types: * `code_execution` * `filesystem` * `google_search` * `mcp_server` * `url_context` + "url": "A String", # Optional. The URL for the MCP server endpoint. Only applicable when `type` is `mcp_server`. }, ], - "updated": "A String", # Output only. Timestamp when the agent was last updated. + "updated": "A String", # Output only. The time the agent was last updated. }, ], - "nextPageToken": "A String", # A token, which can be sent as ListAgentsRequest.page_token to retrieve the next page. Absence of this field indicates there are no subsequent pages. + "nextPageToken": "A String", # A token to retrieve the next page of results. Pass this value as ListAgentsRequest.page_token in a subsequent call. }
@@ -308,39 +308,39 @@

Method Details

patch(name, body=None, updateMask=None, x__xgafv=None) -
Updates the specific Agent.
+  
Updates an agent.
 
 Args:
-  name: string, Identifier. The resource name of the Agent. Format: `projects/{project}/locations/{location}/agents/{agent}`. (required)
+  name: string, Identifier. The resource name of the agent. Format: `projects/{project}/locations/{location}/agents/{agent}`. (required)
   body: object, The request body.
     The object takes the form of:
 
 { # A Vertex agent contains instructions and configurations for the LLM to execute a certain task.
-  "base_agent": "A String", # Required. The base agent of the agent. Supported values: - "antigravity-preview-05-2026"
-  "base_environment": "", # Optional. The environment config of the agent. Valid types are: - string value for environment_id, or 'remote' for default - struct value for EnvironmentConfig.
-  "created": "A String", # Output only. Timestamp when the agent was created.
+  "base_agent": "A String", # Required. The base agent for the agent. Supported values: * `antigravity-preview-05-2026`
+  "base_environment": "", # Optional. The base environment configuration for the agent. Valid types: * A string value for the environment ID, or `remote` for the default. * A struct value for the `environment_config`.
+  "created": "A String", # Output only. The time the agent was created.
   "description": "A String", # Optional. The description of the agent.
-  "id": "A String", # Immutable. The ID to use for agent, which will become the final component of the agent resource name. If not provided, Vertex AI will generate a value for this ID. This value may be up to 63 characters, and valid characters are `[a-z0-9-]`. The first character must be a letter, the last character must be a letter or number.
-  "metadata": { # Optional. The metadata of the agent.
+  "id": "A String", # Immutable. The user-specified ID for the agent. This ID becomes the final component of the agent resource name. If not provided, Vertex AI will generate a value for this ID. The ID can be up to 63 characters and must match the regular expression `[a-z]([a-z0-9-]{0,61}[a-z0-9])?`.
+  "metadata": { # Optional. The metadata for the agent.
     "a_key": "A String",
   },
-  "name": "A String", # Identifier. The resource name of the Agent. Format: `projects/{project}/locations/{location}/agents/{agent}`.
-  "object": "A String", # Output only. The object type of this resource. Always set to "agent" in this case.
-  "system_instruction": "A String", # Optional. The detailed struction that the agent should follow. The instruction is passed to LLM as system instruction.
-  "tools": [ # Optional. A list of tools that are available for the agent during the process of execucting the task.
-    { # A tool provides a list of actions that are available for the Agent during the process of executing the task.
-      "headers": { # Optional. Headers for the MCP server (e.g., authentication). Only applicable when `type` is "mcp".
+  "name": "A String", # Identifier. The resource name of the agent. Format: `projects/{project}/locations/{location}/agents/{agent}`.
+  "object": "A String", # Output only. The object type of the resource. For agents, the value is `agent`.
+  "system_instruction": "A String", # Optional. The instructions for the agent to follow. These instructions are passed to the LLM as a system instruction.
+  "tools": [ # Optional. The tools available to the agent.
+    { # A tool provides a list of actions available to the Agent during the process of executing a task.
+      "headers": { # Optional. The headers for the MCP server, such as for authentication. Only applicable when `type` is `mcp_server`.
         "a_key": "A String",
       },
-      "name": "A String", # Optional. The name of the MCP server. Only applicable when `type` is "mcp".
-      "type": "A String", # Required. Type of the tool. Supported types: - "code_execution" - "filesystem" - "google_search" - "mcp" - "url_context"
-      "url": "A String", # Optional. The full URL for the MCP server endpoint. Only applicable when `type` is "mcp".
+      "name": "A String", # Optional. The name of the MCP server. Only applicable when `type` is `mcp_server`.
+      "type": "A String", # Required. The type of the tool. Supported types: * `code_execution` * `filesystem` * `google_search` * `mcp_server` * `url_context`
+      "url": "A String", # Optional. The URL for the MCP server endpoint. Only applicable when `type` is `mcp_server`.
     },
   ],
-  "updated": "A String", # Output only. Timestamp when the agent was last updated.
+  "updated": "A String", # Output only. The time the agent was last updated.
 }
 
-  updateMask: string, Optional. Field mask is used to control which fields get updated. If the mask is not present, all fields will be updated.
+  updateMask: string, Optional. The list of fields to update. If not present, all fields are updated.
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -350,28 +350,28 @@ 

Method Details

An object of the form: { # A Vertex agent contains instructions and configurations for the LLM to execute a certain task. - "base_agent": "A String", # Required. The base agent of the agent. Supported values: - "antigravity-preview-05-2026" - "base_environment": "", # Optional. The environment config of the agent. Valid types are: - string value for environment_id, or 'remote' for default - struct value for EnvironmentConfig. - "created": "A String", # Output only. Timestamp when the agent was created. + "base_agent": "A String", # Required. The base agent for the agent. Supported values: * `antigravity-preview-05-2026` + "base_environment": "", # Optional. The base environment configuration for the agent. Valid types: * A string value for the environment ID, or `remote` for the default. * A struct value for the `environment_config`. + "created": "A String", # Output only. The time the agent was created. "description": "A String", # Optional. The description of the agent. - "id": "A String", # Immutable. The ID to use for agent, which will become the final component of the agent resource name. If not provided, Vertex AI will generate a value for this ID. This value may be up to 63 characters, and valid characters are `[a-z0-9-]`. The first character must be a letter, the last character must be a letter or number. - "metadata": { # Optional. The metadata of the agent. + "id": "A String", # Immutable. The user-specified ID for the agent. This ID becomes the final component of the agent resource name. If not provided, Vertex AI will generate a value for this ID. The ID can be up to 63 characters and must match the regular expression `[a-z]([a-z0-9-]{0,61}[a-z0-9])?`. + "metadata": { # Optional. The metadata for the agent. "a_key": "A String", }, - "name": "A String", # Identifier. The resource name of the Agent. Format: `projects/{project}/locations/{location}/agents/{agent}`. - "object": "A String", # Output only. The object type of this resource. Always set to "agent" in this case. - "system_instruction": "A String", # Optional. The detailed struction that the agent should follow. The instruction is passed to LLM as system instruction. - "tools": [ # Optional. A list of tools that are available for the agent during the process of execucting the task. - { # A tool provides a list of actions that are available for the Agent during the process of executing the task. - "headers": { # Optional. Headers for the MCP server (e.g., authentication). Only applicable when `type` is "mcp". + "name": "A String", # Identifier. The resource name of the agent. Format: `projects/{project}/locations/{location}/agents/{agent}`. + "object": "A String", # Output only. The object type of the resource. For agents, the value is `agent`. + "system_instruction": "A String", # Optional. The instructions for the agent to follow. These instructions are passed to the LLM as a system instruction. + "tools": [ # Optional. The tools available to the agent. + { # A tool provides a list of actions available to the Agent during the process of executing a task. + "headers": { # Optional. The headers for the MCP server, such as for authentication. Only applicable when `type` is `mcp_server`. "a_key": "A String", }, - "name": "A String", # Optional. The name of the MCP server. Only applicable when `type` is "mcp". - "type": "A String", # Required. Type of the tool. Supported types: - "code_execution" - "filesystem" - "google_search" - "mcp" - "url_context" - "url": "A String", # Optional. The full URL for the MCP server endpoint. Only applicable when `type` is "mcp". + "name": "A String", # Optional. The name of the MCP server. Only applicable when `type` is `mcp_server`. + "type": "A String", # Required. The type of the tool. Supported types: * `code_execution` * `filesystem` * `google_search` * `mcp_server` * `url_context` + "url": "A String", # Optional. The URL for the MCP server endpoint. Only applicable when `type` is `mcp_server`. }, ], - "updated": "A String", # Output only. Timestamp when the agent was last updated. + "updated": "A String", # Output only. The time the agent was last updated. }
diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.cachedContents.html b/docs/dyn/aiplatform_v1beta1.projects.locations.cachedContents.html index 7c49d837c6..5222efde2e 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.cachedContents.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.cachedContents.html @@ -305,6 +305,12 @@

Method Details

"A String", ], }, + "exaAiSearch": { # ExaAiSearch tool type. A tool that uses the Exa.ai search engine for grounding. # Optional. Uses Exa.ai to search for information to answer user queries. The search results will be grounded on Exa.ai and presented to the model for response generation + "apiKey": "A String", # Required. The API key for ExaAiSearch. + "customConfigs": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. + "a_key": "", # Properties of the object. + }, + }, "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "behavior": "A String", # Optional. Specifies the function Behavior. If not specified, the system keeps the current function call behavior. This field is currently only supported by the BidiGenerateContent method. @@ -727,6 +733,12 @@

Method Details

"A String", ], }, + "exaAiSearch": { # ExaAiSearch tool type. A tool that uses the Exa.ai search engine for grounding. # Optional. Uses Exa.ai to search for information to answer user queries. The search results will be grounded on Exa.ai and presented to the model for response generation + "apiKey": "A String", # Required. The API key for ExaAiSearch. + "customConfigs": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. + "a_key": "", # Properties of the object. + }, + }, "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "behavior": "A String", # Optional. Specifies the function Behavior. If not specified, the system keeps the current function call behavior. This field is currently only supported by the BidiGenerateContent method. @@ -1174,6 +1186,12 @@

Method Details

"A String", ], }, + "exaAiSearch": { # ExaAiSearch tool type. A tool that uses the Exa.ai search engine for grounding. # Optional. Uses Exa.ai to search for information to answer user queries. The search results will be grounded on Exa.ai and presented to the model for response generation + "apiKey": "A String", # Required. The API key for ExaAiSearch. + "customConfigs": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. + "a_key": "", # Properties of the object. + }, + }, "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "behavior": "A String", # Optional. Specifies the function Behavior. If not specified, the system keeps the current function call behavior. This field is currently only supported by the BidiGenerateContent method. @@ -1607,6 +1625,12 @@

Method Details

"A String", ], }, + "exaAiSearch": { # ExaAiSearch tool type. A tool that uses the Exa.ai search engine for grounding. # Optional. Uses Exa.ai to search for information to answer user queries. The search results will be grounded on Exa.ai and presented to the model for response generation + "apiKey": "A String", # Required. The API key for ExaAiSearch. + "customConfigs": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. + "a_key": "", # Properties of the object. + }, + }, "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "behavior": "A String", # Optional. Specifies the function Behavior. If not specified, the system keeps the current function call behavior. This field is currently only supported by the BidiGenerateContent method. @@ -2048,6 +2072,12 @@

Method Details

"A String", ], }, + "exaAiSearch": { # ExaAiSearch tool type. A tool that uses the Exa.ai search engine for grounding. # Optional. Uses Exa.ai to search for information to answer user queries. The search results will be grounded on Exa.ai and presented to the model for response generation + "apiKey": "A String", # Required. The API key for ExaAiSearch. + "customConfigs": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. + "a_key": "", # Properties of the object. + }, + }, "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "behavior": "A String", # Optional. Specifies the function Behavior. If not specified, the system keeps the current function call behavior. This field is currently only supported by the BidiGenerateContent method. @@ -2471,6 +2501,12 @@

Method Details

"A String", ], }, + "exaAiSearch": { # ExaAiSearch tool type. A tool that uses the Exa.ai search engine for grounding. # Optional. Uses Exa.ai to search for information to answer user queries. The search results will be grounded on Exa.ai and presented to the model for response generation + "apiKey": "A String", # Required. The API key for ExaAiSearch. + "customConfigs": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. + "a_key": "", # Properties of the object. + }, + }, "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "behavior": "A String", # Optional. Specifies the function Behavior. If not specified, the system keeps the current function call behavior. This field is currently only supported by the BidiGenerateContent method. diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.datasets.html b/docs/dyn/aiplatform_v1beta1.projects.locations.datasets.html index 1e2efb0af9..9a94bab942 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.datasets.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.datasets.html @@ -483,6 +483,12 @@

Method Details

"A String", ], }, + "exaAiSearch": { # ExaAiSearch tool type. A tool that uses the Exa.ai search engine for grounding. # Optional. Uses Exa.ai to search for information to answer user queries. The search results will be grounded on Exa.ai and presented to the model for response generation + "apiKey": "A String", # Required. The API key for ExaAiSearch. + "customConfigs": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. + "a_key": "", # Properties of the object. + }, + }, "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "behavior": "A String", # Optional. Specifies the function Behavior. If not specified, the system keeps the current function call behavior. This field is currently only supported by the BidiGenerateContent method. @@ -1066,6 +1072,12 @@

Method Details

"A String", ], }, + "exaAiSearch": { # ExaAiSearch tool type. A tool that uses the Exa.ai search engine for grounding. # Optional. Uses Exa.ai to search for information to answer user queries. The search results will be grounded on Exa.ai and presented to the model for response generation + "apiKey": "A String", # Required. The API key for ExaAiSearch. + "customConfigs": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. + "a_key": "", # Properties of the object. + }, + }, "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "behavior": "A String", # Optional. Specifies the function Behavior. If not specified, the system keeps the current function call behavior. This field is currently only supported by the BidiGenerateContent method. diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.endpoints.html b/docs/dyn/aiplatform_v1beta1.projects.locations.endpoints.html index 7bd79425a3..d3aa73e1e2 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.endpoints.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.endpoints.html @@ -613,6 +613,12 @@

Method Details

"A String", ], }, + "exaAiSearch": { # ExaAiSearch tool type. A tool that uses the Exa.ai search engine for grounding. # Optional. Uses Exa.ai to search for information to answer user queries. The search results will be grounded on Exa.ai and presented to the model for response generation + "apiKey": "A String", # Required. The API key for ExaAiSearch. + "customConfigs": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. + "a_key": "", # Properties of the object. + }, + }, "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "behavior": "A String", # Optional. Specifies the function Behavior. If not specified, the system keeps the current function call behavior. This field is currently only supported by the BidiGenerateContent method. @@ -2302,6 +2308,12 @@

Method Details

"A String", ], }, + "exaAiSearch": { # ExaAiSearch tool type. A tool that uses the Exa.ai search engine for grounding. # Optional. Uses Exa.ai to search for information to answer user queries. The search results will be grounded on Exa.ai and presented to the model for response generation + "apiKey": "A String", # Required. The API key for ExaAiSearch. + "customConfigs": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. + "a_key": "", # Properties of the object. + }, + }, "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "behavior": "A String", # Optional. Specifies the function Behavior. If not specified, the system keeps the current function call behavior. This field is currently only supported by the BidiGenerateContent method. @@ -4967,6 +4979,12 @@

Method Details

"A String", ], }, + "exaAiSearch": { # ExaAiSearch tool type. A tool that uses the Exa.ai search engine for grounding. # Optional. Uses Exa.ai to search for information to answer user queries. The search results will be grounded on Exa.ai and presented to the model for response generation + "apiKey": "A String", # Required. The API key for ExaAiSearch. + "customConfigs": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. + "a_key": "", # Properties of the object. + }, + }, "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "behavior": "A String", # Optional. Specifies the function Behavior. If not specified, the system keeps the current function call behavior. This field is currently only supported by the BidiGenerateContent method. diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.evaluationItems.html b/docs/dyn/aiplatform_v1beta1.projects.locations.evaluationItems.html index 029be95727..3cfdae478a 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.evaluationItems.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.evaluationItems.html @@ -154,6 +154,12 @@

Method Details

"A String", ], }, + "exaAiSearch": { # ExaAiSearch tool type. A tool that uses the Exa.ai search engine for grounding. # Optional. Uses Exa.ai to search for information to answer user queries. The search results will be grounded on Exa.ai and presented to the model for response generation + "apiKey": "A String", # Required. The API key for ExaAiSearch. + "customConfigs": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. + "a_key": "", # Properties of the object. + }, + }, "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "behavior": "A String", # Optional. Specifies the function Behavior. If not specified, the system keeps the current function call behavior. This field is currently only supported by the BidiGenerateContent method. @@ -384,6 +390,12 @@

Method Details

"A String", ], }, + "exaAiSearch": { # ExaAiSearch tool type. A tool that uses the Exa.ai search engine for grounding. # Optional. Uses Exa.ai to search for information to answer user queries. The search results will be grounded on Exa.ai and presented to the model for response generation + "apiKey": "A String", # Required. The API key for ExaAiSearch. + "customConfigs": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. + "a_key": "", # Properties of the object. + }, + }, "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "behavior": "A String", # Optional. Specifies the function Behavior. If not specified, the system keeps the current function call behavior. This field is currently only supported by the BidiGenerateContent method. @@ -799,6 +811,12 @@

Method Details

"A String", ], }, + "exaAiSearch": { # ExaAiSearch tool type. A tool that uses the Exa.ai search engine for grounding. # Optional. Uses Exa.ai to search for information to answer user queries. The search results will be grounded on Exa.ai and presented to the model for response generation + "apiKey": "A String", # Required. The API key for ExaAiSearch. + "customConfigs": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. + "a_key": "", # Properties of the object. + }, + }, "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "behavior": "A String", # Optional. Specifies the function Behavior. If not specified, the system keeps the current function call behavior. This field is currently only supported by the BidiGenerateContent method. @@ -1029,6 +1047,12 @@

Method Details

"A String", ], }, + "exaAiSearch": { # ExaAiSearch tool type. A tool that uses the Exa.ai search engine for grounding. # Optional. Uses Exa.ai to search for information to answer user queries. The search results will be grounded on Exa.ai and presented to the model for response generation + "apiKey": "A String", # Required. The API key for ExaAiSearch. + "customConfigs": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. + "a_key": "", # Properties of the object. + }, + }, "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "behavior": "A String", # Optional. Specifies the function Behavior. If not specified, the system keeps the current function call behavior. This field is currently only supported by the BidiGenerateContent method. @@ -1443,6 +1467,12 @@

Method Details

"A String", ], }, + "exaAiSearch": { # ExaAiSearch tool type. A tool that uses the Exa.ai search engine for grounding. # Optional. Uses Exa.ai to search for information to answer user queries. The search results will be grounded on Exa.ai and presented to the model for response generation + "apiKey": "A String", # Required. The API key for ExaAiSearch. + "customConfigs": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. + "a_key": "", # Properties of the object. + }, + }, "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "behavior": "A String", # Optional. Specifies the function Behavior. If not specified, the system keeps the current function call behavior. This field is currently only supported by the BidiGenerateContent method. @@ -1673,6 +1703,12 @@

Method Details

"A String", ], }, + "exaAiSearch": { # ExaAiSearch tool type. A tool that uses the Exa.ai search engine for grounding. # Optional. Uses Exa.ai to search for information to answer user queries. The search results will be grounded on Exa.ai and presented to the model for response generation + "apiKey": "A String", # Required. The API key for ExaAiSearch. + "customConfigs": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. + "a_key": "", # Properties of the object. + }, + }, "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "behavior": "A String", # Optional. Specifies the function Behavior. If not specified, the system keeps the current function call behavior. This field is currently only supported by the BidiGenerateContent method. @@ -2134,6 +2170,12 @@

Method Details

"A String", ], }, + "exaAiSearch": { # ExaAiSearch tool type. A tool that uses the Exa.ai search engine for grounding. # Optional. Uses Exa.ai to search for information to answer user queries. The search results will be grounded on Exa.ai and presented to the model for response generation + "apiKey": "A String", # Required. The API key for ExaAiSearch. + "customConfigs": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. + "a_key": "", # Properties of the object. + }, + }, "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "behavior": "A String", # Optional. Specifies the function Behavior. If not specified, the system keeps the current function call behavior. This field is currently only supported by the BidiGenerateContent method. @@ -2364,6 +2406,12 @@

Method Details

"A String", ], }, + "exaAiSearch": { # ExaAiSearch tool type. A tool that uses the Exa.ai search engine for grounding. # Optional. Uses Exa.ai to search for information to answer user queries. The search results will be grounded on Exa.ai and presented to the model for response generation + "apiKey": "A String", # Required. The API key for ExaAiSearch. + "customConfigs": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. + "a_key": "", # Properties of the object. + }, + }, "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "behavior": "A String", # Optional. Specifies the function Behavior. If not specified, the system keeps the current function call behavior. This field is currently only supported by the BidiGenerateContent method. @@ -2779,6 +2827,12 @@

Method Details

"A String", ], }, + "exaAiSearch": { # ExaAiSearch tool type. A tool that uses the Exa.ai search engine for grounding. # Optional. Uses Exa.ai to search for information to answer user queries. The search results will be grounded on Exa.ai and presented to the model for response generation + "apiKey": "A String", # Required. The API key for ExaAiSearch. + "customConfigs": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. + "a_key": "", # Properties of the object. + }, + }, "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "behavior": "A String", # Optional. Specifies the function Behavior. If not specified, the system keeps the current function call behavior. This field is currently only supported by the BidiGenerateContent method. @@ -3009,6 +3063,12 @@

Method Details

"A String", ], }, + "exaAiSearch": { # ExaAiSearch tool type. A tool that uses the Exa.ai search engine for grounding. # Optional. Uses Exa.ai to search for information to answer user queries. The search results will be grounded on Exa.ai and presented to the model for response generation + "apiKey": "A String", # Required. The API key for ExaAiSearch. + "customConfigs": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. + "a_key": "", # Properties of the object. + }, + }, "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "behavior": "A String", # Optional. Specifies the function Behavior. If not specified, the system keeps the current function call behavior. This field is currently only supported by the BidiGenerateContent method. @@ -3423,6 +3483,12 @@

Method Details

"A String", ], }, + "exaAiSearch": { # ExaAiSearch tool type. A tool that uses the Exa.ai search engine for grounding. # Optional. Uses Exa.ai to search for information to answer user queries. The search results will be grounded on Exa.ai and presented to the model for response generation + "apiKey": "A String", # Required. The API key for ExaAiSearch. + "customConfigs": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. + "a_key": "", # Properties of the object. + }, + }, "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "behavior": "A String", # Optional. Specifies the function Behavior. If not specified, the system keeps the current function call behavior. This field is currently only supported by the BidiGenerateContent method. @@ -3653,6 +3719,12 @@

Method Details

"A String", ], }, + "exaAiSearch": { # ExaAiSearch tool type. A tool that uses the Exa.ai search engine for grounding. # Optional. Uses Exa.ai to search for information to answer user queries. The search results will be grounded on Exa.ai and presented to the model for response generation + "apiKey": "A String", # Required. The API key for ExaAiSearch. + "customConfigs": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. + "a_key": "", # Properties of the object. + }, + }, "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "behavior": "A String", # Optional. Specifies the function Behavior. If not specified, the system keeps the current function call behavior. This field is currently only supported by the BidiGenerateContent method. @@ -4114,6 +4186,12 @@

Method Details

"A String", ], }, + "exaAiSearch": { # ExaAiSearch tool type. A tool that uses the Exa.ai search engine for grounding. # Optional. Uses Exa.ai to search for information to answer user queries. The search results will be grounded on Exa.ai and presented to the model for response generation + "apiKey": "A String", # Required. The API key for ExaAiSearch. + "customConfigs": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. + "a_key": "", # Properties of the object. + }, + }, "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "behavior": "A String", # Optional. Specifies the function Behavior. If not specified, the system keeps the current function call behavior. This field is currently only supported by the BidiGenerateContent method. @@ -4344,6 +4422,12 @@

Method Details

"A String", ], }, + "exaAiSearch": { # ExaAiSearch tool type. A tool that uses the Exa.ai search engine for grounding. # Optional. Uses Exa.ai to search for information to answer user queries. The search results will be grounded on Exa.ai and presented to the model for response generation + "apiKey": "A String", # Required. The API key for ExaAiSearch. + "customConfigs": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. + "a_key": "", # Properties of the object. + }, + }, "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "behavior": "A String", # Optional. Specifies the function Behavior. If not specified, the system keeps the current function call behavior. This field is currently only supported by the BidiGenerateContent method. @@ -4759,6 +4843,12 @@

Method Details

"A String", ], }, + "exaAiSearch": { # ExaAiSearch tool type. A tool that uses the Exa.ai search engine for grounding. # Optional. Uses Exa.ai to search for information to answer user queries. The search results will be grounded on Exa.ai and presented to the model for response generation + "apiKey": "A String", # Required. The API key for ExaAiSearch. + "customConfigs": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. + "a_key": "", # Properties of the object. + }, + }, "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "behavior": "A String", # Optional. Specifies the function Behavior. If not specified, the system keeps the current function call behavior. This field is currently only supported by the BidiGenerateContent method. @@ -4989,6 +5079,12 @@

Method Details

"A String", ], }, + "exaAiSearch": { # ExaAiSearch tool type. A tool that uses the Exa.ai search engine for grounding. # Optional. Uses Exa.ai to search for information to answer user queries. The search results will be grounded on Exa.ai and presented to the model for response generation + "apiKey": "A String", # Required. The API key for ExaAiSearch. + "customConfigs": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. + "a_key": "", # Properties of the object. + }, + }, "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "behavior": "A String", # Optional. Specifies the function Behavior. If not specified, the system keeps the current function call behavior. This field is currently only supported by the BidiGenerateContent method. @@ -5403,6 +5499,12 @@

Method Details

"A String", ], }, + "exaAiSearch": { # ExaAiSearch tool type. A tool that uses the Exa.ai search engine for grounding. # Optional. Uses Exa.ai to search for information to answer user queries. The search results will be grounded on Exa.ai and presented to the model for response generation + "apiKey": "A String", # Required. The API key for ExaAiSearch. + "customConfigs": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. + "a_key": "", # Properties of the object. + }, + }, "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "behavior": "A String", # Optional. Specifies the function Behavior. If not specified, the system keeps the current function call behavior. This field is currently only supported by the BidiGenerateContent method. @@ -5633,6 +5735,12 @@

Method Details

"A String", ], }, + "exaAiSearch": { # ExaAiSearch tool type. A tool that uses the Exa.ai search engine for grounding. # Optional. Uses Exa.ai to search for information to answer user queries. The search results will be grounded on Exa.ai and presented to the model for response generation + "apiKey": "A String", # Required. The API key for ExaAiSearch. + "customConfigs": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. + "a_key": "", # Properties of the object. + }, + }, "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "behavior": "A String", # Optional. Specifies the function Behavior. If not specified, the system keeps the current function call behavior. This field is currently only supported by the BidiGenerateContent method. @@ -6094,6 +6202,12 @@

Method Details

"A String", ], }, + "exaAiSearch": { # ExaAiSearch tool type. A tool that uses the Exa.ai search engine for grounding. # Optional. Uses Exa.ai to search for information to answer user queries. The search results will be grounded on Exa.ai and presented to the model for response generation + "apiKey": "A String", # Required. The API key for ExaAiSearch. + "customConfigs": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. + "a_key": "", # Properties of the object. + }, + }, "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "behavior": "A String", # Optional. Specifies the function Behavior. If not specified, the system keeps the current function call behavior. This field is currently only supported by the BidiGenerateContent method. @@ -6324,6 +6438,12 @@

Method Details

"A String", ], }, + "exaAiSearch": { # ExaAiSearch tool type. A tool that uses the Exa.ai search engine for grounding. # Optional. Uses Exa.ai to search for information to answer user queries. The search results will be grounded on Exa.ai and presented to the model for response generation + "apiKey": "A String", # Required. The API key for ExaAiSearch. + "customConfigs": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. + "a_key": "", # Properties of the object. + }, + }, "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "behavior": "A String", # Optional. Specifies the function Behavior. If not specified, the system keeps the current function call behavior. This field is currently only supported by the BidiGenerateContent method. @@ -6739,6 +6859,12 @@

Method Details

"A String", ], }, + "exaAiSearch": { # ExaAiSearch tool type. A tool that uses the Exa.ai search engine for grounding. # Optional. Uses Exa.ai to search for information to answer user queries. The search results will be grounded on Exa.ai and presented to the model for response generation + "apiKey": "A String", # Required. The API key for ExaAiSearch. + "customConfigs": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. + "a_key": "", # Properties of the object. + }, + }, "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "behavior": "A String", # Optional. Specifies the function Behavior. If not specified, the system keeps the current function call behavior. This field is currently only supported by the BidiGenerateContent method. @@ -6969,6 +7095,12 @@

Method Details

"A String", ], }, + "exaAiSearch": { # ExaAiSearch tool type. A tool that uses the Exa.ai search engine for grounding. # Optional. Uses Exa.ai to search for information to answer user queries. The search results will be grounded on Exa.ai and presented to the model for response generation + "apiKey": "A String", # Required. The API key for ExaAiSearch. + "customConfigs": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. + "a_key": "", # Properties of the object. + }, + }, "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "behavior": "A String", # Optional. Specifies the function Behavior. If not specified, the system keeps the current function call behavior. This field is currently only supported by the BidiGenerateContent method. @@ -7383,6 +7515,12 @@

Method Details

"A String", ], }, + "exaAiSearch": { # ExaAiSearch tool type. A tool that uses the Exa.ai search engine for grounding. # Optional. Uses Exa.ai to search for information to answer user queries. The search results will be grounded on Exa.ai and presented to the model for response generation + "apiKey": "A String", # Required. The API key for ExaAiSearch. + "customConfigs": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. + "a_key": "", # Properties of the object. + }, + }, "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "behavior": "A String", # Optional. Specifies the function Behavior. If not specified, the system keeps the current function call behavior. This field is currently only supported by the BidiGenerateContent method. @@ -7613,6 +7751,12 @@

Method Details

"A String", ], }, + "exaAiSearch": { # ExaAiSearch tool type. A tool that uses the Exa.ai search engine for grounding. # Optional. Uses Exa.ai to search for information to answer user queries. The search results will be grounded on Exa.ai and presented to the model for response generation + "apiKey": "A String", # Required. The API key for ExaAiSearch. + "customConfigs": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. + "a_key": "", # Properties of the object. + }, + }, "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "behavior": "A String", # Optional. Specifies the function Behavior. If not specified, the system keeps the current function call behavior. This field is currently only supported by the BidiGenerateContent method. @@ -8116,6 +8260,12 @@

Method Details

"A String", ], }, + "exaAiSearch": { # ExaAiSearch tool type. A tool that uses the Exa.ai search engine for grounding. # Optional. Uses Exa.ai to search for information to answer user queries. The search results will be grounded on Exa.ai and presented to the model for response generation + "apiKey": "A String", # Required. The API key for ExaAiSearch. + "customConfigs": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. + "a_key": "", # Properties of the object. + }, + }, "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "behavior": "A String", # Optional. Specifies the function Behavior. If not specified, the system keeps the current function call behavior. This field is currently only supported by the BidiGenerateContent method. @@ -8346,6 +8496,12 @@

Method Details

"A String", ], }, + "exaAiSearch": { # ExaAiSearch tool type. A tool that uses the Exa.ai search engine for grounding. # Optional. Uses Exa.ai to search for information to answer user queries. The search results will be grounded on Exa.ai and presented to the model for response generation + "apiKey": "A String", # Required. The API key for ExaAiSearch. + "customConfigs": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. + "a_key": "", # Properties of the object. + }, + }, "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "behavior": "A String", # Optional. Specifies the function Behavior. If not specified, the system keeps the current function call behavior. This field is currently only supported by the BidiGenerateContent method. @@ -8761,6 +8917,12 @@

Method Details

"A String", ], }, + "exaAiSearch": { # ExaAiSearch tool type. A tool that uses the Exa.ai search engine for grounding. # Optional. Uses Exa.ai to search for information to answer user queries. The search results will be grounded on Exa.ai and presented to the model for response generation + "apiKey": "A String", # Required. The API key for ExaAiSearch. + "customConfigs": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. + "a_key": "", # Properties of the object. + }, + }, "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "behavior": "A String", # Optional. Specifies the function Behavior. If not specified, the system keeps the current function call behavior. This field is currently only supported by the BidiGenerateContent method. @@ -8991,6 +9153,12 @@

Method Details

"A String", ], }, + "exaAiSearch": { # ExaAiSearch tool type. A tool that uses the Exa.ai search engine for grounding. # Optional. Uses Exa.ai to search for information to answer user queries. The search results will be grounded on Exa.ai and presented to the model for response generation + "apiKey": "A String", # Required. The API key for ExaAiSearch. + "customConfigs": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. + "a_key": "", # Properties of the object. + }, + }, "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "behavior": "A String", # Optional. Specifies the function Behavior. If not specified, the system keeps the current function call behavior. This field is currently only supported by the BidiGenerateContent method. @@ -9405,6 +9573,12 @@

Method Details

"A String", ], }, + "exaAiSearch": { # ExaAiSearch tool type. A tool that uses the Exa.ai search engine for grounding. # Optional. Uses Exa.ai to search for information to answer user queries. The search results will be grounded on Exa.ai and presented to the model for response generation + "apiKey": "A String", # Required. The API key for ExaAiSearch. + "customConfigs": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. + "a_key": "", # Properties of the object. + }, + }, "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "behavior": "A String", # Optional. Specifies the function Behavior. If not specified, the system keeps the current function call behavior. This field is currently only supported by the BidiGenerateContent method. @@ -9635,6 +9809,12 @@

Method Details

"A String", ], }, + "exaAiSearch": { # ExaAiSearch tool type. A tool that uses the Exa.ai search engine for grounding. # Optional. Uses Exa.ai to search for information to answer user queries. The search results will be grounded on Exa.ai and presented to the model for response generation + "apiKey": "A String", # Required. The API key for ExaAiSearch. + "customConfigs": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. + "a_key": "", # Properties of the object. + }, + }, "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "behavior": "A String", # Optional. Specifies the function Behavior. If not specified, the system keeps the current function call behavior. This field is currently only supported by the BidiGenerateContent method. @@ -10096,6 +10276,12 @@

Method Details

"A String", ], }, + "exaAiSearch": { # ExaAiSearch tool type. A tool that uses the Exa.ai search engine for grounding. # Optional. Uses Exa.ai to search for information to answer user queries. The search results will be grounded on Exa.ai and presented to the model for response generation + "apiKey": "A String", # Required. The API key for ExaAiSearch. + "customConfigs": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. + "a_key": "", # Properties of the object. + }, + }, "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "behavior": "A String", # Optional. Specifies the function Behavior. If not specified, the system keeps the current function call behavior. This field is currently only supported by the BidiGenerateContent method. @@ -10326,6 +10512,12 @@

Method Details

"A String", ], }, + "exaAiSearch": { # ExaAiSearch tool type. A tool that uses the Exa.ai search engine for grounding. # Optional. Uses Exa.ai to search for information to answer user queries. The search results will be grounded on Exa.ai and presented to the model for response generation + "apiKey": "A String", # Required. The API key for ExaAiSearch. + "customConfigs": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. + "a_key": "", # Properties of the object. + }, + }, "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "behavior": "A String", # Optional. Specifies the function Behavior. If not specified, the system keeps the current function call behavior. This field is currently only supported by the BidiGenerateContent method. @@ -10741,6 +10933,12 @@

Method Details

"A String", ], }, + "exaAiSearch": { # ExaAiSearch tool type. A tool that uses the Exa.ai search engine for grounding. # Optional. Uses Exa.ai to search for information to answer user queries. The search results will be grounded on Exa.ai and presented to the model for response generation + "apiKey": "A String", # Required. The API key for ExaAiSearch. + "customConfigs": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. + "a_key": "", # Properties of the object. + }, + }, "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "behavior": "A String", # Optional. Specifies the function Behavior. If not specified, the system keeps the current function call behavior. This field is currently only supported by the BidiGenerateContent method. @@ -10971,6 +11169,12 @@

Method Details

"A String", ], }, + "exaAiSearch": { # ExaAiSearch tool type. A tool that uses the Exa.ai search engine for grounding. # Optional. Uses Exa.ai to search for information to answer user queries. The search results will be grounded on Exa.ai and presented to the model for response generation + "apiKey": "A String", # Required. The API key for ExaAiSearch. + "customConfigs": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. + "a_key": "", # Properties of the object. + }, + }, "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "behavior": "A String", # Optional. Specifies the function Behavior. If not specified, the system keeps the current function call behavior. This field is currently only supported by the BidiGenerateContent method. @@ -11385,6 +11589,12 @@

Method Details

"A String", ], }, + "exaAiSearch": { # ExaAiSearch tool type. A tool that uses the Exa.ai search engine for grounding. # Optional. Uses Exa.ai to search for information to answer user queries. The search results will be grounded on Exa.ai and presented to the model for response generation + "apiKey": "A String", # Required. The API key for ExaAiSearch. + "customConfigs": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. + "a_key": "", # Properties of the object. + }, + }, "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "behavior": "A String", # Optional. Specifies the function Behavior. If not specified, the system keeps the current function call behavior. This field is currently only supported by the BidiGenerateContent method. @@ -11615,6 +11825,12 @@

Method Details

"A String", ], }, + "exaAiSearch": { # ExaAiSearch tool type. A tool that uses the Exa.ai search engine for grounding. # Optional. Uses Exa.ai to search for information to answer user queries. The search results will be grounded on Exa.ai and presented to the model for response generation + "apiKey": "A String", # Required. The API key for ExaAiSearch. + "customConfigs": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. + "a_key": "", # Properties of the object. + }, + }, "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "behavior": "A String", # Optional. Specifies the function Behavior. If not specified, the system keeps the current function call behavior. This field is currently only supported by the BidiGenerateContent method. @@ -12089,6 +12305,12 @@

Method Details

"A String", ], }, + "exaAiSearch": { # ExaAiSearch tool type. A tool that uses the Exa.ai search engine for grounding. # Optional. Uses Exa.ai to search for information to answer user queries. The search results will be grounded on Exa.ai and presented to the model for response generation + "apiKey": "A String", # Required. The API key for ExaAiSearch. + "customConfigs": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. + "a_key": "", # Properties of the object. + }, + }, "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "behavior": "A String", # Optional. Specifies the function Behavior. If not specified, the system keeps the current function call behavior. This field is currently only supported by the BidiGenerateContent method. @@ -12319,6 +12541,12 @@

Method Details

"A String", ], }, + "exaAiSearch": { # ExaAiSearch tool type. A tool that uses the Exa.ai search engine for grounding. # Optional. Uses Exa.ai to search for information to answer user queries. The search results will be grounded on Exa.ai and presented to the model for response generation + "apiKey": "A String", # Required. The API key for ExaAiSearch. + "customConfigs": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. + "a_key": "", # Properties of the object. + }, + }, "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "behavior": "A String", # Optional. Specifies the function Behavior. If not specified, the system keeps the current function call behavior. This field is currently only supported by the BidiGenerateContent method. @@ -12734,6 +12962,12 @@

Method Details

"A String", ], }, + "exaAiSearch": { # ExaAiSearch tool type. A tool that uses the Exa.ai search engine for grounding. # Optional. Uses Exa.ai to search for information to answer user queries. The search results will be grounded on Exa.ai and presented to the model for response generation + "apiKey": "A String", # Required. The API key for ExaAiSearch. + "customConfigs": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. + "a_key": "", # Properties of the object. + }, + }, "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "behavior": "A String", # Optional. Specifies the function Behavior. If not specified, the system keeps the current function call behavior. This field is currently only supported by the BidiGenerateContent method. @@ -12964,6 +13198,12 @@

Method Details

"A String", ], }, + "exaAiSearch": { # ExaAiSearch tool type. A tool that uses the Exa.ai search engine for grounding. # Optional. Uses Exa.ai to search for information to answer user queries. The search results will be grounded on Exa.ai and presented to the model for response generation + "apiKey": "A String", # Required. The API key for ExaAiSearch. + "customConfigs": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. + "a_key": "", # Properties of the object. + }, + }, "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "behavior": "A String", # Optional. Specifies the function Behavior. If not specified, the system keeps the current function call behavior. This field is currently only supported by the BidiGenerateContent method. @@ -13378,6 +13618,12 @@

Method Details

"A String", ], }, + "exaAiSearch": { # ExaAiSearch tool type. A tool that uses the Exa.ai search engine for grounding. # Optional. Uses Exa.ai to search for information to answer user queries. The search results will be grounded on Exa.ai and presented to the model for response generation + "apiKey": "A String", # Required. The API key for ExaAiSearch. + "customConfigs": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. + "a_key": "", # Properties of the object. + }, + }, "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "behavior": "A String", # Optional. Specifies the function Behavior. If not specified, the system keeps the current function call behavior. This field is currently only supported by the BidiGenerateContent method. @@ -13608,6 +13854,12 @@

Method Details

"A String", ], }, + "exaAiSearch": { # ExaAiSearch tool type. A tool that uses the Exa.ai search engine for grounding. # Optional. Uses Exa.ai to search for information to answer user queries. The search results will be grounded on Exa.ai and presented to the model for response generation + "apiKey": "A String", # Required. The API key for ExaAiSearch. + "customConfigs": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. + "a_key": "", # Properties of the object. + }, + }, "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "behavior": "A String", # Optional. Specifies the function Behavior. If not specified, the system keeps the current function call behavior. This field is currently only supported by the BidiGenerateContent method. @@ -14069,6 +14321,12 @@

Method Details

"A String", ], }, + "exaAiSearch": { # ExaAiSearch tool type. A tool that uses the Exa.ai search engine for grounding. # Optional. Uses Exa.ai to search for information to answer user queries. The search results will be grounded on Exa.ai and presented to the model for response generation + "apiKey": "A String", # Required. The API key for ExaAiSearch. + "customConfigs": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. + "a_key": "", # Properties of the object. + }, + }, "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "behavior": "A String", # Optional. Specifies the function Behavior. If not specified, the system keeps the current function call behavior. This field is currently only supported by the BidiGenerateContent method. @@ -14299,6 +14557,12 @@

Method Details

"A String", ], }, + "exaAiSearch": { # ExaAiSearch tool type. A tool that uses the Exa.ai search engine for grounding. # Optional. Uses Exa.ai to search for information to answer user queries. The search results will be grounded on Exa.ai and presented to the model for response generation + "apiKey": "A String", # Required. The API key for ExaAiSearch. + "customConfigs": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. + "a_key": "", # Properties of the object. + }, + }, "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "behavior": "A String", # Optional. Specifies the function Behavior. If not specified, the system keeps the current function call behavior. This field is currently only supported by the BidiGenerateContent method. @@ -14714,6 +14978,12 @@

Method Details

"A String", ], }, + "exaAiSearch": { # ExaAiSearch tool type. A tool that uses the Exa.ai search engine for grounding. # Optional. Uses Exa.ai to search for information to answer user queries. The search results will be grounded on Exa.ai and presented to the model for response generation + "apiKey": "A String", # Required. The API key for ExaAiSearch. + "customConfigs": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. + "a_key": "", # Properties of the object. + }, + }, "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "behavior": "A String", # Optional. Specifies the function Behavior. If not specified, the system keeps the current function call behavior. This field is currently only supported by the BidiGenerateContent method. @@ -14944,6 +15214,12 @@

Method Details

"A String", ], }, + "exaAiSearch": { # ExaAiSearch tool type. A tool that uses the Exa.ai search engine for grounding. # Optional. Uses Exa.ai to search for information to answer user queries. The search results will be grounded on Exa.ai and presented to the model for response generation + "apiKey": "A String", # Required. The API key for ExaAiSearch. + "customConfigs": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. + "a_key": "", # Properties of the object. + }, + }, "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "behavior": "A String", # Optional. Specifies the function Behavior. If not specified, the system keeps the current function call behavior. This field is currently only supported by the BidiGenerateContent method. @@ -15358,6 +15634,12 @@

Method Details

"A String", ], }, + "exaAiSearch": { # ExaAiSearch tool type. A tool that uses the Exa.ai search engine for grounding. # Optional. Uses Exa.ai to search for information to answer user queries. The search results will be grounded on Exa.ai and presented to the model for response generation + "apiKey": "A String", # Required. The API key for ExaAiSearch. + "customConfigs": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. + "a_key": "", # Properties of the object. + }, + }, "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "behavior": "A String", # Optional. Specifies the function Behavior. If not specified, the system keeps the current function call behavior. This field is currently only supported by the BidiGenerateContent method. @@ -15588,6 +15870,12 @@

Method Details

"A String", ], }, + "exaAiSearch": { # ExaAiSearch tool type. A tool that uses the Exa.ai search engine for grounding. # Optional. Uses Exa.ai to search for information to answer user queries. The search results will be grounded on Exa.ai and presented to the model for response generation + "apiKey": "A String", # Required. The API key for ExaAiSearch. + "customConfigs": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. + "a_key": "", # Properties of the object. + }, + }, "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "behavior": "A String", # Optional. Specifies the function Behavior. If not specified, the system keeps the current function call behavior. This field is currently only supported by the BidiGenerateContent method. diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.evaluationRuns.html b/docs/dyn/aiplatform_v1beta1.projects.locations.evaluationRuns.html index a9c4764dbf..745357588c 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.evaluationRuns.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.evaluationRuns.html @@ -1395,6 +1395,12 @@

Method Details

"A String", ], }, + "exaAiSearch": { # ExaAiSearch tool type. A tool that uses the Exa.ai search engine for grounding. # Optional. Uses Exa.ai to search for information to answer user queries. The search results will be grounded on Exa.ai and presented to the model for response generation + "apiKey": "A String", # Required. The API key for ExaAiSearch. + "customConfigs": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. + "a_key": "", # Properties of the object. + }, + }, "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "behavior": "A String", # Optional. Specifies the function Behavior. If not specified, the system keeps the current function call behavior. This field is currently only supported by the BidiGenerateContent method. @@ -1625,6 +1631,12 @@

Method Details

"A String", ], }, + "exaAiSearch": { # ExaAiSearch tool type. A tool that uses the Exa.ai search engine for grounding. # Optional. Uses Exa.ai to search for information to answer user queries. The search results will be grounded on Exa.ai and presented to the model for response generation + "apiKey": "A String", # Required. The API key for ExaAiSearch. + "customConfigs": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. + "a_key": "", # Properties of the object. + }, + }, "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "behavior": "A String", # Optional. Specifies the function Behavior. If not specified, the system keeps the current function call behavior. This field is currently only supported by the BidiGenerateContent method. @@ -2040,6 +2052,12 @@

Method Details

"A String", ], }, + "exaAiSearch": { # ExaAiSearch tool type. A tool that uses the Exa.ai search engine for grounding. # Optional. Uses Exa.ai to search for information to answer user queries. The search results will be grounded on Exa.ai and presented to the model for response generation + "apiKey": "A String", # Required. The API key for ExaAiSearch. + "customConfigs": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. + "a_key": "", # Properties of the object. + }, + }, "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "behavior": "A String", # Optional. Specifies the function Behavior. If not specified, the system keeps the current function call behavior. This field is currently only supported by the BidiGenerateContent method. @@ -2270,6 +2288,12 @@

Method Details

"A String", ], }, + "exaAiSearch": { # ExaAiSearch tool type. A tool that uses the Exa.ai search engine for grounding. # Optional. Uses Exa.ai to search for information to answer user queries. The search results will be grounded on Exa.ai and presented to the model for response generation + "apiKey": "A String", # Required. The API key for ExaAiSearch. + "customConfigs": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. + "a_key": "", # Properties of the object. + }, + }, "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "behavior": "A String", # Optional. Specifies the function Behavior. If not specified, the system keeps the current function call behavior. This field is currently only supported by the BidiGenerateContent method. @@ -2684,6 +2708,12 @@

Method Details

"A String", ], }, + "exaAiSearch": { # ExaAiSearch tool type. A tool that uses the Exa.ai search engine for grounding. # Optional. Uses Exa.ai to search for information to answer user queries. The search results will be grounded on Exa.ai and presented to the model for response generation + "apiKey": "A String", # Required. The API key for ExaAiSearch. + "customConfigs": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. + "a_key": "", # Properties of the object. + }, + }, "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "behavior": "A String", # Optional. Specifies the function Behavior. If not specified, the system keeps the current function call behavior. This field is currently only supported by the BidiGenerateContent method. @@ -2914,6 +2944,12 @@

Method Details

"A String", ], }, + "exaAiSearch": { # ExaAiSearch tool type. A tool that uses the Exa.ai search engine for grounding. # Optional. Uses Exa.ai to search for information to answer user queries. The search results will be grounded on Exa.ai and presented to the model for response generation + "apiKey": "A String", # Required. The API key for ExaAiSearch. + "customConfigs": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. + "a_key": "", # Properties of the object. + }, + }, "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "behavior": "A String", # Optional. Specifies the function Behavior. If not specified, the system keeps the current function call behavior. This field is currently only supported by the BidiGenerateContent method. @@ -3443,6 +3479,12 @@

Method Details

"A String", ], }, + "exaAiSearch": { # ExaAiSearch tool type. A tool that uses the Exa.ai search engine for grounding. # Optional. Uses Exa.ai to search for information to answer user queries. The search results will be grounded on Exa.ai and presented to the model for response generation + "apiKey": "A String", # Required. The API key for ExaAiSearch. + "customConfigs": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. + "a_key": "", # Properties of the object. + }, + }, "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "behavior": "A String", # Optional. Specifies the function Behavior. If not specified, the system keeps the current function call behavior. This field is currently only supported by the BidiGenerateContent method. @@ -3809,6 +3851,12 @@

Method Details

"A String", ], }, + "exaAiSearch": { # ExaAiSearch tool type. A tool that uses the Exa.ai search engine for grounding. # Optional. Uses Exa.ai to search for information to answer user queries. The search results will be grounded on Exa.ai and presented to the model for response generation + "apiKey": "A String", # Required. The API key for ExaAiSearch. + "customConfigs": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. + "a_key": "", # Properties of the object. + }, + }, "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "behavior": "A String", # Optional. Specifies the function Behavior. If not specified, the system keeps the current function call behavior. This field is currently only supported by the BidiGenerateContent method. @@ -5411,6 +5459,12 @@

Method Details

"A String", ], }, + "exaAiSearch": { # ExaAiSearch tool type. A tool that uses the Exa.ai search engine for grounding. # Optional. Uses Exa.ai to search for information to answer user queries. The search results will be grounded on Exa.ai and presented to the model for response generation + "apiKey": "A String", # Required. The API key for ExaAiSearch. + "customConfigs": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. + "a_key": "", # Properties of the object. + }, + }, "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "behavior": "A String", # Optional. Specifies the function Behavior. If not specified, the system keeps the current function call behavior. This field is currently only supported by the BidiGenerateContent method. @@ -5641,6 +5695,12 @@

Method Details

"A String", ], }, + "exaAiSearch": { # ExaAiSearch tool type. A tool that uses the Exa.ai search engine for grounding. # Optional. Uses Exa.ai to search for information to answer user queries. The search results will be grounded on Exa.ai and presented to the model for response generation + "apiKey": "A String", # Required. The API key for ExaAiSearch. + "customConfigs": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. + "a_key": "", # Properties of the object. + }, + }, "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "behavior": "A String", # Optional. Specifies the function Behavior. If not specified, the system keeps the current function call behavior. This field is currently only supported by the BidiGenerateContent method. @@ -6056,6 +6116,12 @@

Method Details

"A String", ], }, + "exaAiSearch": { # ExaAiSearch tool type. A tool that uses the Exa.ai search engine for grounding. # Optional. Uses Exa.ai to search for information to answer user queries. The search results will be grounded on Exa.ai and presented to the model for response generation + "apiKey": "A String", # Required. The API key for ExaAiSearch. + "customConfigs": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. + "a_key": "", # Properties of the object. + }, + }, "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "behavior": "A String", # Optional. Specifies the function Behavior. If not specified, the system keeps the current function call behavior. This field is currently only supported by the BidiGenerateContent method. @@ -6286,6 +6352,12 @@

Method Details

"A String", ], }, + "exaAiSearch": { # ExaAiSearch tool type. A tool that uses the Exa.ai search engine for grounding. # Optional. Uses Exa.ai to search for information to answer user queries. The search results will be grounded on Exa.ai and presented to the model for response generation + "apiKey": "A String", # Required. The API key for ExaAiSearch. + "customConfigs": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. + "a_key": "", # Properties of the object. + }, + }, "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "behavior": "A String", # Optional. Specifies the function Behavior. If not specified, the system keeps the current function call behavior. This field is currently only supported by the BidiGenerateContent method. @@ -6700,6 +6772,12 @@

Method Details

"A String", ], }, + "exaAiSearch": { # ExaAiSearch tool type. A tool that uses the Exa.ai search engine for grounding. # Optional. Uses Exa.ai to search for information to answer user queries. The search results will be grounded on Exa.ai and presented to the model for response generation + "apiKey": "A String", # Required. The API key for ExaAiSearch. + "customConfigs": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. + "a_key": "", # Properties of the object. + }, + }, "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "behavior": "A String", # Optional. Specifies the function Behavior. If not specified, the system keeps the current function call behavior. This field is currently only supported by the BidiGenerateContent method. @@ -6930,6 +7008,12 @@

Method Details

"A String", ], }, + "exaAiSearch": { # ExaAiSearch tool type. A tool that uses the Exa.ai search engine for grounding. # Optional. Uses Exa.ai to search for information to answer user queries. The search results will be grounded on Exa.ai and presented to the model for response generation + "apiKey": "A String", # Required. The API key for ExaAiSearch. + "customConfigs": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. + "a_key": "", # Properties of the object. + }, + }, "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "behavior": "A String", # Optional. Specifies the function Behavior. If not specified, the system keeps the current function call behavior. This field is currently only supported by the BidiGenerateContent method. @@ -7459,6 +7543,12 @@

Method Details

"A String", ], }, + "exaAiSearch": { # ExaAiSearch tool type. A tool that uses the Exa.ai search engine for grounding. # Optional. Uses Exa.ai to search for information to answer user queries. The search results will be grounded on Exa.ai and presented to the model for response generation + "apiKey": "A String", # Required. The API key for ExaAiSearch. + "customConfigs": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. + "a_key": "", # Properties of the object. + }, + }, "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "behavior": "A String", # Optional. Specifies the function Behavior. If not specified, the system keeps the current function call behavior. This field is currently only supported by the BidiGenerateContent method. @@ -7825,6 +7915,12 @@

Method Details

"A String", ], }, + "exaAiSearch": { # ExaAiSearch tool type. A tool that uses the Exa.ai search engine for grounding. # Optional. Uses Exa.ai to search for information to answer user queries. The search results will be grounded on Exa.ai and presented to the model for response generation + "apiKey": "A String", # Required. The API key for ExaAiSearch. + "customConfigs": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. + "a_key": "", # Properties of the object. + }, + }, "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "behavior": "A String", # Optional. Specifies the function Behavior. If not specified, the system keeps the current function call behavior. This field is currently only supported by the BidiGenerateContent method. @@ -9469,6 +9565,12 @@

Method Details

"A String", ], }, + "exaAiSearch": { # ExaAiSearch tool type. A tool that uses the Exa.ai search engine for grounding. # Optional. Uses Exa.ai to search for information to answer user queries. The search results will be grounded on Exa.ai and presented to the model for response generation + "apiKey": "A String", # Required. The API key for ExaAiSearch. + "customConfigs": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. + "a_key": "", # Properties of the object. + }, + }, "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "behavior": "A String", # Optional. Specifies the function Behavior. If not specified, the system keeps the current function call behavior. This field is currently only supported by the BidiGenerateContent method. @@ -9699,6 +9801,12 @@

Method Details

"A String", ], }, + "exaAiSearch": { # ExaAiSearch tool type. A tool that uses the Exa.ai search engine for grounding. # Optional. Uses Exa.ai to search for information to answer user queries. The search results will be grounded on Exa.ai and presented to the model for response generation + "apiKey": "A String", # Required. The API key for ExaAiSearch. + "customConfigs": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. + "a_key": "", # Properties of the object. + }, + }, "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "behavior": "A String", # Optional. Specifies the function Behavior. If not specified, the system keeps the current function call behavior. This field is currently only supported by the BidiGenerateContent method. @@ -10114,6 +10222,12 @@

Method Details

"A String", ], }, + "exaAiSearch": { # ExaAiSearch tool type. A tool that uses the Exa.ai search engine for grounding. # Optional. Uses Exa.ai to search for information to answer user queries. The search results will be grounded on Exa.ai and presented to the model for response generation + "apiKey": "A String", # Required. The API key for ExaAiSearch. + "customConfigs": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. + "a_key": "", # Properties of the object. + }, + }, "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "behavior": "A String", # Optional. Specifies the function Behavior. If not specified, the system keeps the current function call behavior. This field is currently only supported by the BidiGenerateContent method. @@ -10344,6 +10458,12 @@

Method Details

"A String", ], }, + "exaAiSearch": { # ExaAiSearch tool type. A tool that uses the Exa.ai search engine for grounding. # Optional. Uses Exa.ai to search for information to answer user queries. The search results will be grounded on Exa.ai and presented to the model for response generation + "apiKey": "A String", # Required. The API key for ExaAiSearch. + "customConfigs": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. + "a_key": "", # Properties of the object. + }, + }, "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "behavior": "A String", # Optional. Specifies the function Behavior. If not specified, the system keeps the current function call behavior. This field is currently only supported by the BidiGenerateContent method. @@ -10758,6 +10878,12 @@

Method Details

"A String", ], }, + "exaAiSearch": { # ExaAiSearch tool type. A tool that uses the Exa.ai search engine for grounding. # Optional. Uses Exa.ai to search for information to answer user queries. The search results will be grounded on Exa.ai and presented to the model for response generation + "apiKey": "A String", # Required. The API key for ExaAiSearch. + "customConfigs": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. + "a_key": "", # Properties of the object. + }, + }, "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "behavior": "A String", # Optional. Specifies the function Behavior. If not specified, the system keeps the current function call behavior. This field is currently only supported by the BidiGenerateContent method. @@ -10988,6 +11114,12 @@

Method Details

"A String", ], }, + "exaAiSearch": { # ExaAiSearch tool type. A tool that uses the Exa.ai search engine for grounding. # Optional. Uses Exa.ai to search for information to answer user queries. The search results will be grounded on Exa.ai and presented to the model for response generation + "apiKey": "A String", # Required. The API key for ExaAiSearch. + "customConfigs": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. + "a_key": "", # Properties of the object. + }, + }, "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "behavior": "A String", # Optional. Specifies the function Behavior. If not specified, the system keeps the current function call behavior. This field is currently only supported by the BidiGenerateContent method. @@ -11517,6 +11649,12 @@

Method Details

"A String", ], }, + "exaAiSearch": { # ExaAiSearch tool type. A tool that uses the Exa.ai search engine for grounding. # Optional. Uses Exa.ai to search for information to answer user queries. The search results will be grounded on Exa.ai and presented to the model for response generation + "apiKey": "A String", # Required. The API key for ExaAiSearch. + "customConfigs": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. + "a_key": "", # Properties of the object. + }, + }, "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "behavior": "A String", # Optional. Specifies the function Behavior. If not specified, the system keeps the current function call behavior. This field is currently only supported by the BidiGenerateContent method. @@ -11883,6 +12021,12 @@

Method Details

"A String", ], }, + "exaAiSearch": { # ExaAiSearch tool type. A tool that uses the Exa.ai search engine for grounding. # Optional. Uses Exa.ai to search for information to answer user queries. The search results will be grounded on Exa.ai and presented to the model for response generation + "apiKey": "A String", # Required. The API key for ExaAiSearch. + "customConfigs": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. + "a_key": "", # Properties of the object. + }, + }, "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "behavior": "A String", # Optional. Specifies the function Behavior. If not specified, the system keeps the current function call behavior. This field is currently only supported by the BidiGenerateContent method. @@ -13498,6 +13642,12 @@

Method Details

"A String", ], }, + "exaAiSearch": { # ExaAiSearch tool type. A tool that uses the Exa.ai search engine for grounding. # Optional. Uses Exa.ai to search for information to answer user queries. The search results will be grounded on Exa.ai and presented to the model for response generation + "apiKey": "A String", # Required. The API key for ExaAiSearch. + "customConfigs": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. + "a_key": "", # Properties of the object. + }, + }, "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "behavior": "A String", # Optional. Specifies the function Behavior. If not specified, the system keeps the current function call behavior. This field is currently only supported by the BidiGenerateContent method. @@ -13728,6 +13878,12 @@

Method Details

"A String", ], }, + "exaAiSearch": { # ExaAiSearch tool type. A tool that uses the Exa.ai search engine for grounding. # Optional. Uses Exa.ai to search for information to answer user queries. The search results will be grounded on Exa.ai and presented to the model for response generation + "apiKey": "A String", # Required. The API key for ExaAiSearch. + "customConfigs": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. + "a_key": "", # Properties of the object. + }, + }, "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "behavior": "A String", # Optional. Specifies the function Behavior. If not specified, the system keeps the current function call behavior. This field is currently only supported by the BidiGenerateContent method. @@ -14143,6 +14299,12 @@

Method Details

"A String", ], }, + "exaAiSearch": { # ExaAiSearch tool type. A tool that uses the Exa.ai search engine for grounding. # Optional. Uses Exa.ai to search for information to answer user queries. The search results will be grounded on Exa.ai and presented to the model for response generation + "apiKey": "A String", # Required. The API key for ExaAiSearch. + "customConfigs": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. + "a_key": "", # Properties of the object. + }, + }, "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "behavior": "A String", # Optional. Specifies the function Behavior. If not specified, the system keeps the current function call behavior. This field is currently only supported by the BidiGenerateContent method. @@ -14373,6 +14535,12 @@

Method Details

"A String", ], }, + "exaAiSearch": { # ExaAiSearch tool type. A tool that uses the Exa.ai search engine for grounding. # Optional. Uses Exa.ai to search for information to answer user queries. The search results will be grounded on Exa.ai and presented to the model for response generation + "apiKey": "A String", # Required. The API key for ExaAiSearch. + "customConfigs": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. + "a_key": "", # Properties of the object. + }, + }, "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "behavior": "A String", # Optional. Specifies the function Behavior. If not specified, the system keeps the current function call behavior. This field is currently only supported by the BidiGenerateContent method. @@ -14787,6 +14955,12 @@

Method Details

"A String", ], }, + "exaAiSearch": { # ExaAiSearch tool type. A tool that uses the Exa.ai search engine for grounding. # Optional. Uses Exa.ai to search for information to answer user queries. The search results will be grounded on Exa.ai and presented to the model for response generation + "apiKey": "A String", # Required. The API key for ExaAiSearch. + "customConfigs": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. + "a_key": "", # Properties of the object. + }, + }, "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "behavior": "A String", # Optional. Specifies the function Behavior. If not specified, the system keeps the current function call behavior. This field is currently only supported by the BidiGenerateContent method. @@ -15017,6 +15191,12 @@

Method Details

"A String", ], }, + "exaAiSearch": { # ExaAiSearch tool type. A tool that uses the Exa.ai search engine for grounding. # Optional. Uses Exa.ai to search for information to answer user queries. The search results will be grounded on Exa.ai and presented to the model for response generation + "apiKey": "A String", # Required. The API key for ExaAiSearch. + "customConfigs": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. + "a_key": "", # Properties of the object. + }, + }, "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "behavior": "A String", # Optional. Specifies the function Behavior. If not specified, the system keeps the current function call behavior. This field is currently only supported by the BidiGenerateContent method. @@ -15546,6 +15726,12 @@

Method Details

"A String", ], }, + "exaAiSearch": { # ExaAiSearch tool type. A tool that uses the Exa.ai search engine for grounding. # Optional. Uses Exa.ai to search for information to answer user queries. The search results will be grounded on Exa.ai and presented to the model for response generation + "apiKey": "A String", # Required. The API key for ExaAiSearch. + "customConfigs": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. + "a_key": "", # Properties of the object. + }, + }, "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "behavior": "A String", # Optional. Specifies the function Behavior. If not specified, the system keeps the current function call behavior. This field is currently only supported by the BidiGenerateContent method. @@ -15912,6 +16098,12 @@

Method Details

"A String", ], }, + "exaAiSearch": { # ExaAiSearch tool type. A tool that uses the Exa.ai search engine for grounding. # Optional. Uses Exa.ai to search for information to answer user queries. The search results will be grounded on Exa.ai and presented to the model for response generation + "apiKey": "A String", # Required. The API key for ExaAiSearch. + "customConfigs": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. + "a_key": "", # Properties of the object. + }, + }, "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "behavior": "A String", # Optional. Specifies the function Behavior. If not specified, the system keeps the current function call behavior. This field is currently only supported by the BidiGenerateContent method. diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.evaluationSets.html b/docs/dyn/aiplatform_v1beta1.projects.locations.evaluationSets.html index 6ef0cdef36..c6a627010c 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.evaluationSets.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.evaluationSets.html @@ -141,6 +141,12 @@

Method Details

"A String", ], }, + "exaAiSearch": { # ExaAiSearch tool type. A tool that uses the Exa.ai search engine for grounding. # Optional. Uses Exa.ai to search for information to answer user queries. The search results will be grounded on Exa.ai and presented to the model for response generation + "apiKey": "A String", # Required. The API key for ExaAiSearch. + "customConfigs": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. + "a_key": "", # Properties of the object. + }, + }, "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "behavior": "A String", # Optional. Specifies the function Behavior. If not specified, the system keeps the current function call behavior. This field is currently only supported by the BidiGenerateContent method. @@ -395,6 +401,12 @@

Method Details

"A String", ], }, + "exaAiSearch": { # ExaAiSearch tool type. A tool that uses the Exa.ai search engine for grounding. # Optional. Uses Exa.ai to search for information to answer user queries. The search results will be grounded on Exa.ai and presented to the model for response generation + "apiKey": "A String", # Required. The API key for ExaAiSearch. + "customConfigs": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. + "a_key": "", # Properties of the object. + }, + }, "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "behavior": "A String", # Optional. Specifies the function Behavior. If not specified, the system keeps the current function call behavior. This field is currently only supported by the BidiGenerateContent method. @@ -691,6 +703,12 @@

Method Details

"A String", ], }, + "exaAiSearch": { # ExaAiSearch tool type. A tool that uses the Exa.ai search engine for grounding. # Optional. Uses Exa.ai to search for information to answer user queries. The search results will be grounded on Exa.ai and presented to the model for response generation + "apiKey": "A String", # Required. The API key for ExaAiSearch. + "customConfigs": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. + "a_key": "", # Properties of the object. + }, + }, "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "behavior": "A String", # Optional. Specifies the function Behavior. If not specified, the system keeps the current function call behavior. This field is currently only supported by the BidiGenerateContent method. @@ -958,6 +976,12 @@

Method Details

"A String", ], }, + "exaAiSearch": { # ExaAiSearch tool type. A tool that uses the Exa.ai search engine for grounding. # Optional. Uses Exa.ai to search for information to answer user queries. The search results will be grounded on Exa.ai and presented to the model for response generation + "apiKey": "A String", # Required. The API key for ExaAiSearch. + "customConfigs": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. + "a_key": "", # Properties of the object. + }, + }, "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "behavior": "A String", # Optional. Specifies the function Behavior. If not specified, the system keeps the current function call behavior. This field is currently only supported by the BidiGenerateContent method. @@ -1231,6 +1255,12 @@

Method Details

"A String", ], }, + "exaAiSearch": { # ExaAiSearch tool type. A tool that uses the Exa.ai search engine for grounding. # Optional. Uses Exa.ai to search for information to answer user queries. The search results will be grounded on Exa.ai and presented to the model for response generation + "apiKey": "A String", # Required. The API key for ExaAiSearch. + "customConfigs": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. + "a_key": "", # Properties of the object. + }, + }, "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "behavior": "A String", # Optional. Specifies the function Behavior. If not specified, the system keeps the current function call behavior. This field is currently only supported by the BidiGenerateContent method. @@ -1486,6 +1516,12 @@

Method Details

"A String", ], }, + "exaAiSearch": { # ExaAiSearch tool type. A tool that uses the Exa.ai search engine for grounding. # Optional. Uses Exa.ai to search for information to answer user queries. The search results will be grounded on Exa.ai and presented to the model for response generation + "apiKey": "A String", # Required. The API key for ExaAiSearch. + "customConfigs": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. + "a_key": "", # Properties of the object. + }, + }, "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "behavior": "A String", # Optional. Specifies the function Behavior. If not specified, the system keeps the current function call behavior. This field is currently only supported by the BidiGenerateContent method. diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.html b/docs/dyn/aiplatform_v1beta1.projects.locations.html index d22572260c..6bcb285ef1 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.html @@ -384,6 +384,9 @@

Instance Methods

getRagEngineConfig(name, x__xgafv=None)

Gets a RagEngineConfig.

+

+ getSemanticGovernancePolicyEngine(name, x__xgafv=None)

+

Gets a SemanticGovernancePolicyEngine. A SemanticGovernancePolicyEngine is a singleton resource that is created when its parent is created, and deleted when its parent is deleted. This method retrieves the current state of the Semantic Governance Policy Engine.

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

Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the ListLocationsRequest.name field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.

@@ -399,6 +402,9 @@

Instance Methods

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

Updates a RagEngineConfig.

+

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

+

Updates a SemanticGovernancePolicyEngine. This method performs an upsert operation. If the SemanticGovernancePolicyEngine resource does not exist, it will be created. Otherwise, it will be updated.

Method Details

askContexts(parent, body=None, x__xgafv=None) @@ -452,6 +458,12 @@

Method Details

"A String", ], }, + "exaAiSearch": { # ExaAiSearch tool type. A tool that uses the Exa.ai search engine for grounding. # Optional. Uses Exa.ai to search for information to answer user queries. The search results will be grounded on Exa.ai and presented to the model for response generation + "apiKey": "A String", # Required. The API key for ExaAiSearch. + "customConfigs": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. + "a_key": "", # Properties of the object. + }, + }, "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "behavior": "A String", # Optional. Specifies the function Behavior. If not specified, the system keeps the current function call behavior. This field is currently only supported by the BidiGenerateContent method. @@ -748,6 +760,12 @@

Method Details

"A String", ], }, + "exaAiSearch": { # ExaAiSearch tool type. A tool that uses the Exa.ai search engine for grounding. # Optional. Uses Exa.ai to search for information to answer user queries. The search results will be grounded on Exa.ai and presented to the model for response generation + "apiKey": "A String", # Required. The API key for ExaAiSearch. + "customConfigs": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. + "a_key": "", # Properties of the object. + }, + }, "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "behavior": "A String", # Optional. Specifies the function Behavior. If not specified, the system keeps the current function call behavior. This field is currently only supported by the BidiGenerateContent method. @@ -2513,6 +2531,12 @@

Method Details

"A String", ], }, + "exaAiSearch": { # ExaAiSearch tool type. A tool that uses the Exa.ai search engine for grounding. # Optional. Uses Exa.ai to search for information to answer user queries. The search results will be grounded on Exa.ai and presented to the model for response generation + "apiKey": "A String", # Required. The API key for ExaAiSearch. + "customConfigs": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. + "a_key": "", # Properties of the object. + }, + }, "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "behavior": "A String", # Optional. Specifies the function Behavior. If not specified, the system keeps the current function call behavior. This field is currently only supported by the BidiGenerateContent method. @@ -2832,6 +2856,12 @@

Method Details

"A String", ], }, + "exaAiSearch": { # ExaAiSearch tool type. A tool that uses the Exa.ai search engine for grounding. # Optional. Uses Exa.ai to search for information to answer user queries. The search results will be grounded on Exa.ai and presented to the model for response generation + "apiKey": "A String", # Required. The API key for ExaAiSearch. + "customConfigs": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. + "a_key": "", # Properties of the object. + }, + }, "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "behavior": "A String", # Optional. Specifies the function Behavior. If not specified, the system keeps the current function call behavior. This field is currently only supported by the BidiGenerateContent method. @@ -3224,6 +3254,12 @@

Method Details

"A String", ], }, + "exaAiSearch": { # ExaAiSearch tool type. A tool that uses the Exa.ai search engine for grounding. # Optional. Uses Exa.ai to search for information to answer user queries. The search results will be grounded on Exa.ai and presented to the model for response generation + "apiKey": "A String", # Required. The API key for ExaAiSearch. + "customConfigs": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. + "a_key": "", # Properties of the object. + }, + }, "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "behavior": "A String", # Optional. Specifies the function Behavior. If not specified, the system keeps the current function call behavior. This field is currently only supported by the BidiGenerateContent method. @@ -3454,6 +3490,12 @@

Method Details

"A String", ], }, + "exaAiSearch": { # ExaAiSearch tool type. A tool that uses the Exa.ai search engine for grounding. # Optional. Uses Exa.ai to search for information to answer user queries. The search results will be grounded on Exa.ai and presented to the model for response generation + "apiKey": "A String", # Required. The API key for ExaAiSearch. + "customConfigs": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. + "a_key": "", # Properties of the object. + }, + }, "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "behavior": "A String", # Optional. Specifies the function Behavior. If not specified, the system keeps the current function call behavior. This field is currently only supported by the BidiGenerateContent method. @@ -3776,6 +3818,12 @@

Method Details

"A String", ], }, + "exaAiSearch": { # ExaAiSearch tool type. A tool that uses the Exa.ai search engine for grounding. # Optional. Uses Exa.ai to search for information to answer user queries. The search results will be grounded on Exa.ai and presented to the model for response generation + "apiKey": "A String", # Required. The API key for ExaAiSearch. + "customConfigs": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. + "a_key": "", # Properties of the object. + }, + }, "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "behavior": "A String", # Optional. Specifies the function Behavior. If not specified, the system keeps the current function call behavior. This field is currently only supported by the BidiGenerateContent method. @@ -4006,6 +4054,12 @@

Method Details

"A String", ], }, + "exaAiSearch": { # ExaAiSearch tool type. A tool that uses the Exa.ai search engine for grounding. # Optional. Uses Exa.ai to search for information to answer user queries. The search results will be grounded on Exa.ai and presented to the model for response generation + "apiKey": "A String", # Required. The API key for ExaAiSearch. + "customConfigs": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. + "a_key": "", # Properties of the object. + }, + }, "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "behavior": "A String", # Optional. Specifies the function Behavior. If not specified, the system keeps the current function call behavior. This field is currently only supported by the BidiGenerateContent method. @@ -6199,6 +6253,12 @@

Method Details

"A String", ], }, + "exaAiSearch": { # ExaAiSearch tool type. A tool that uses the Exa.ai search engine for grounding. # Optional. Uses Exa.ai to search for information to answer user queries. The search results will be grounded on Exa.ai and presented to the model for response generation + "apiKey": "A String", # Required. The API key for ExaAiSearch. + "customConfigs": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. + "a_key": "", # Properties of the object. + }, + }, "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "behavior": "A String", # Optional. Specifies the function Behavior. If not specified, the system keeps the current function call behavior. This field is currently only supported by the BidiGenerateContent method. @@ -6728,6 +6788,12 @@

Method Details

"A String", ], }, + "exaAiSearch": { # ExaAiSearch tool type. A tool that uses the Exa.ai search engine for grounding. # Optional. Uses Exa.ai to search for information to answer user queries. The search results will be grounded on Exa.ai and presented to the model for response generation + "apiKey": "A String", # Required. The API key for ExaAiSearch. + "customConfigs": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. + "a_key": "", # Properties of the object. + }, + }, "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "behavior": "A String", # Optional. Specifies the function Behavior. If not specified, the system keeps the current function call behavior. This field is currently only supported by the BidiGenerateContent method. @@ -6958,6 +7024,12 @@

Method Details

"A String", ], }, + "exaAiSearch": { # ExaAiSearch tool type. A tool that uses the Exa.ai search engine for grounding. # Optional. Uses Exa.ai to search for information to answer user queries. The search results will be grounded on Exa.ai and presented to the model for response generation + "apiKey": "A String", # Required. The API key for ExaAiSearch. + "customConfigs": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. + "a_key": "", # Properties of the object. + }, + }, "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "behavior": "A String", # Optional. Specifies the function Behavior. If not specified, the system keeps the current function call behavior. This field is currently only supported by the BidiGenerateContent method. @@ -7373,6 +7445,12 @@

Method Details

"A String", ], }, + "exaAiSearch": { # ExaAiSearch tool type. A tool that uses the Exa.ai search engine for grounding. # Optional. Uses Exa.ai to search for information to answer user queries. The search results will be grounded on Exa.ai and presented to the model for response generation + "apiKey": "A String", # Required. The API key for ExaAiSearch. + "customConfigs": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. + "a_key": "", # Properties of the object. + }, + }, "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "behavior": "A String", # Optional. Specifies the function Behavior. If not specified, the system keeps the current function call behavior. This field is currently only supported by the BidiGenerateContent method. @@ -7603,6 +7681,12 @@

Method Details

"A String", ], }, + "exaAiSearch": { # ExaAiSearch tool type. A tool that uses the Exa.ai search engine for grounding. # Optional. Uses Exa.ai to search for information to answer user queries. The search results will be grounded on Exa.ai and presented to the model for response generation + "apiKey": "A String", # Required. The API key for ExaAiSearch. + "customConfigs": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. + "a_key": "", # Properties of the object. + }, + }, "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "behavior": "A String", # Optional. Specifies the function Behavior. If not specified, the system keeps the current function call behavior. This field is currently only supported by the BidiGenerateContent method. @@ -8017,6 +8101,12 @@

Method Details

"A String", ], }, + "exaAiSearch": { # ExaAiSearch tool type. A tool that uses the Exa.ai search engine for grounding. # Optional. Uses Exa.ai to search for information to answer user queries. The search results will be grounded on Exa.ai and presented to the model for response generation + "apiKey": "A String", # Required. The API key for ExaAiSearch. + "customConfigs": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. + "a_key": "", # Properties of the object. + }, + }, "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "behavior": "A String", # Optional. Specifies the function Behavior. If not specified, the system keeps the current function call behavior. This field is currently only supported by the BidiGenerateContent method. @@ -8247,6 +8337,12 @@

Method Details

"A String", ], }, + "exaAiSearch": { # ExaAiSearch tool type. A tool that uses the Exa.ai search engine for grounding. # Optional. Uses Exa.ai to search for information to answer user queries. The search results will be grounded on Exa.ai and presented to the model for response generation + "apiKey": "A String", # Required. The API key for ExaAiSearch. + "customConfigs": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. + "a_key": "", # Properties of the object. + }, + }, "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "behavior": "A String", # Optional. Specifies the function Behavior. If not specified, the system keeps the current function call behavior. This field is currently only supported by the BidiGenerateContent method. @@ -8923,6 +9019,12 @@

Method Details

"A String", ], }, + "exaAiSearch": { # ExaAiSearch tool type. A tool that uses the Exa.ai search engine for grounding. # Optional. Uses Exa.ai to search for information to answer user queries. The search results will be grounded on Exa.ai and presented to the model for response generation + "apiKey": "A String", # Required. The API key for ExaAiSearch. + "customConfigs": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. + "a_key": "", # Properties of the object. + }, + }, "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "behavior": "A String", # Optional. Specifies the function Behavior. If not specified, the system keeps the current function call behavior. This field is currently only supported by the BidiGenerateContent method. @@ -9228,6 +9330,43 @@

Method Details

}
+
+ getSemanticGovernancePolicyEngine(name, x__xgafv=None) +
Gets a SemanticGovernancePolicyEngine. A SemanticGovernancePolicyEngine is a singleton resource that is created when its parent is created, and deleted when its parent is deleted. This method retrieves the current state of the Semantic Governance Policy Engine.
+
+Args:
+  name: string, Required. The resource name of the SemanticGovernancePolicyEngine to retrieve. Format: projects/{project}/locations/{location}/semanticGovernancePolicyEngine (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Define a singleton SemanticGovernancePolicyEngine resource under a project and location.
+  "createTime": "A String", # Output only. Timestamp when this SemanticGovernancePolicyEngine was created.
+  "gatewayConfigs": { # Optional. Configurations for gateways. The keys are user-defined names for each gateway.
+    "a_key": { # Configuration for a single gateway.
+      "dnsRecord": "A String", # Output only. The fully qualified record name of the created A-record in Cloud DNS.
+      "dnsZoneName": "A String", # Optional. FQDN of the private DNS zone to create DNS record set for PSC endpoint.
+      "ipAddress": "A String", # Output only. The private IP address of the PSC endpoint.
+      "network": "A String", # Optional. The URI of the network resource where PSC-E will be provisioned. if not provided `default` network will be used. Format: projects/{project}/global/networks/{network}
+      "pscEndpoint": "A String", # Output only. The self-link or name of the Private Service Connect endpoint forwarding rule.
+      "state": "A String", # Output only. The state of the Gateway configuration.
+      "subnetwork": "A String", # Optional. The URI of the subnetwork resource where PSC-E will be provisioned. if not provided `default` subnet will be used from the same {location} Format: projects/{project}/regions/{region}/subnetworks/{subnetwork}
+    },
+  },
+  "ipAddress": "A String", # Output only. The private IPv4 address of the PSC endpoint.
+  "name": "A String", # Identifier. The resource name of the SemanticGovernancePolicyEngine. Format: projects/{project}/locations/{location}/semanticGovernancePolicyEngine
+  "pscForwardingRule": "A String", # Output only. The URI of the PSC endpoint resource created in customer project. Format: projects/{project}/regions/{region}/forwardingRules/{forwarding_rule}
+  "pscServiceAttachment": "A String", # Output only. URI of the PSC attachment resource provided by SGP. Format: projects/{project}/regions/{region}/serviceAttachments/{service_attachment}
+  "state": "A String", # Output only. The state of the SemanticGovernancePolicyEngine.
+  "targetProject": "A String", # Optional. The project where network, subnetwork and dns resources are located. If not provided, it is assumed to be the same project of SemanticGovernancePolicyEngine. This field is for Shared VPC scenarios, where network resources may be in a target project and SGP engine in a service project.
+  "updateTime": "A String", # Output only. Timestamp when this SemanticGovernancePolicyEngine was last updated.
+}
+
+
list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the ListLocationsRequest.name field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.
@@ -9749,4 +9888,65 @@ 

Method Details

}
+
+ updateSemanticGovernancePolicyEngine(name, body=None, updateMask=None, x__xgafv=None) +
Updates a SemanticGovernancePolicyEngine. This method performs an upsert operation. If the SemanticGovernancePolicyEngine resource does not exist, it will be created. Otherwise, it will be updated.
+
+Args:
+  name: string, Identifier. The resource name of the SemanticGovernancePolicyEngine. Format: projects/{project}/locations/{location}/semanticGovernancePolicyEngine (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Define a singleton SemanticGovernancePolicyEngine resource under a project and location.
+  "createTime": "A String", # Output only. Timestamp when this SemanticGovernancePolicyEngine was created.
+  "gatewayConfigs": { # Optional. Configurations for gateways. The keys are user-defined names for each gateway.
+    "a_key": { # Configuration for a single gateway.
+      "dnsRecord": "A String", # Output only. The fully qualified record name of the created A-record in Cloud DNS.
+      "dnsZoneName": "A String", # Optional. FQDN of the private DNS zone to create DNS record set for PSC endpoint.
+      "ipAddress": "A String", # Output only. The private IP address of the PSC endpoint.
+      "network": "A String", # Optional. The URI of the network resource where PSC-E will be provisioned. if not provided `default` network will be used. Format: projects/{project}/global/networks/{network}
+      "pscEndpoint": "A String", # Output only. The self-link or name of the Private Service Connect endpoint forwarding rule.
+      "state": "A String", # Output only. The state of the Gateway configuration.
+      "subnetwork": "A String", # Optional. The URI of the subnetwork resource where PSC-E will be provisioned. if not provided `default` subnet will be used from the same {location} Format: projects/{project}/regions/{region}/subnetworks/{subnetwork}
+    },
+  },
+  "ipAddress": "A String", # Output only. The private IPv4 address of the PSC endpoint.
+  "name": "A String", # Identifier. The resource name of the SemanticGovernancePolicyEngine. Format: projects/{project}/locations/{location}/semanticGovernancePolicyEngine
+  "pscForwardingRule": "A String", # Output only. The URI of the PSC endpoint resource created in customer project. Format: projects/{project}/regions/{region}/forwardingRules/{forwarding_rule}
+  "pscServiceAttachment": "A String", # Output only. URI of the PSC attachment resource provided by SGP. Format: projects/{project}/regions/{region}/serviceAttachments/{service_attachment}
+  "state": "A String", # Output only. The state of the SemanticGovernancePolicyEngine.
+  "targetProject": "A String", # Optional. The project where network, subnetwork and dns resources are located. If not provided, it is assumed to be the same project of SemanticGovernancePolicyEngine. This field is for Shared VPC scenarios, where network resources may be in a target project and SGP engine in a service project.
+  "updateTime": "A String", # Output only. Timestamp when this SemanticGovernancePolicyEngine was last updated.
+}
+
+  updateMask: string, Optional. Specifies the fields to be overwritten in the SemanticGovernancePolicyEngine resource by the update. The fields specified in the update_mask are relative to the resource itself. If no update_mask is provided, all fields are overwritten.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.interactions.html b/docs/dyn/aiplatform_v1beta1.projects.locations.interactions.html index 00b2660a08..74d7d3231b 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.interactions.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.interactions.html @@ -1028,6 +1028,8 @@

Method Details

], }, "created": "A String", # Required. Output only. The time at which the response was created in ISO 8601 format (YYYY-MM-DDThh:mm:ssZ). + "env_id": "A String", # The environment ID for the interaction. Can be 'remote' for default environment. + "environment_id": "A String", # Output only. The environment ID for the interaction. Only populated if environment config is set in the request. "id": "A String", # Required. Output only. A unique identifier for the interaction completion. "modelInteraction": { # Interaction for generating the completion using models. # Interaction for generating the completion using models. "generation_config": { # Configuration parameters for model interactions. # Input only. Configuration parameters for the model interaction. @@ -1512,6 +1514,28 @@

Method Details

}, ], "previous_interaction_id": "A String", # The ID of the previous interaction, if any. + "remoteEnvironment": { # Configuration for a custom environment. + "networkAllowlist": { # Network egress configuration for the environment. # Allow only specific domains. + "allowlist": [ # List of allowed domains and their configurations. + { # A network egress rule that controls which external domains the environment is allowed to reach. Each rule identifies a target domain and, optionally, a set of HTTP headers to inject into every matching outbound request. + "domain": "A String", # The domain pattern to match for this rule. Use an exact hostname (e.g., `github.com`), a wildcard prefix (e.g., `*.googleapis.com`), or `*` to match all domains. + "transform": { # Headers to inject into requests matching this rule. Key: header name (e.g., "Authorization"). Value: header value (e.g., "Bearer your-token"). + "a_key": "A String", + }, + }, + ], + }, + "networkMode": "A String", # Network egress mode. + "sources": [ + { # A source to be mounted into the environment. + "content": "A String", # The inline content if `type` is `INLINE`. + "encoding": "A String", # Optional encoding for inline content (e.g. `base64`). + "source": "A String", # The source of the environment. For GCS, this is the GCS path. For GitHub, this is the GitHub path. + "target": "A String", # Where the source should appear in the environment. + "type": "A String", + }, + ], + }, "responseFormatList": { "response_formats": [ { @@ -1568,8 +1592,6 @@

Method Details

], }, }, - "video": { # Configuration for video output format. - }, }, ], }, @@ -1627,8 +1649,6 @@

Method Details

], }, }, - "video": { # Configuration for video output format. - }, }, "response_format": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. # Enforces that the generated response is a JSON object that complies with the JSON schema specified in this field. "boolValue": True or False, # Represents a boolean value. @@ -2467,118 +2487,325 @@

Method Details

}, }, "userInput": { # Input provided by the user. - "content": [ - { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mime_type": "A String", # The mime type of the audio. - "sample_rate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mime_type": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mime_type": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "end_index": 42, # End of the attributed segment, exclusive. - "file_citation": { # A file citation annotation. # A file citation annotation. - "custom_metadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiValue + "contentList": { # A list of Content. # The content of the step. An array of Content objects. + "contents": [ # The contents of the list. + { # The content of the response. + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mime_type": "A String", # The mime type of the audio. + "sample_rate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mime_type": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mime_type": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "end_index": 42, # End of the attributed segment, exclusive. + "file_citation": { # A file citation annotation. # A file citation annotation. + "custom_metadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiValue + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiStruct # Represents a structured value. + }, + }, + ], + }, + "document_uri": "A String", # The URI of the file. + "file_name": "A String", # The name of the file. + "media_id": "A String", # Media ID in-case of image citations, if applicable. + "page_number": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "place_citation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "place_id": "A String", # The ID of the place, in `places/{place_id}` format. + "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "review_id": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "start_index": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "url_citation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mime_type": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "end_index": 42, # End of the attributed segment, exclusive. + "file_citation": { # A file citation annotation. # A file citation annotation. + "custom_metadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiValue + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiStruct # Represents a structured value. + }, + }, ], }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiStruct # Represents a structured value. + "document_uri": "A String", # The URI of the file. + "file_name": "A String", # The name of the file. + "media_id": "A String", # Media ID in-case of image citations, if applicable. + "page_number": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "place_citation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "place_id": "A String", # The ID of the place, in `places/{place_id}` format. + "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "review_id": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "start_index": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "url_citation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, }, ], + "text": "A String", # Required. The text content. }, - "document_uri": "A String", # The URI of the file. - "file_name": "A String", # The name of the file. - "media_id": "A String", # Media ID in-case of image citations, if applicable. - "page_number": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. }, - "place_citation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "place_id": "A String", # The ID of the place, in `places/{place_id}` format. - "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "review_id": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiValue + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiStruct # Represents a structured value. + }, }, ], - "url": "A String", # URI reference of the place. }, - "start_index": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "url_citation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], }, }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mime_type": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "end_index": 42, # End of the attributed segment, exclusive. - "file_citation": { # A file citation annotation. # A file citation annotation. - "custom_metadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiValue - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiStruct # Represents a structured value. + "search_type": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiValue + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiStruct # Represents a structured value. + }, + }, + ], + }, + "name": "A String", # Required. The name of the tool which was called. + "server_name": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "call_id": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "is_error": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mime_type": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "end_index": 42, # End of the attributed segment, exclusive. + "file_citation": { # A file citation annotation. # A file citation annotation. + "custom_metadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiValue + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiStruct # Represents a structured value. + }, + }, + ], }, + "document_uri": "A String", # The URI of the file. + "file_name": "A String", # The name of the file. + "media_id": "A String", # Media ID in-case of image citations, if applicable. + "page_number": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "place_citation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "place_id": "A String", # The ID of the place, in `places/{place_id}` format. + "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "review_id": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "start_index": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "url_citation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "is_error": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiValue ], }, - "document_uri": "A String", # The URI of the file. - "file_name": "A String", # The name of the file. - "media_id": "A String", # Media ID in-case of image citations, if applicable. - "page_number": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiStruct # Represents a structured value. }, - "place_citation": { # A place citation annotation. # A place citation annotation. + }, + ], + }, + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { "name": "A String", # Title of the place. "place_id": "A String", # The ID of the place, in `places/{place_id}` format. "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. @@ -2590,336 +2817,132 @@

Method Details

], "url": "A String", # URI reference of the place. }, - "start_index": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "url_citation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiValue - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiStruct # Represents a structured value. - }, + ], + "widget_context_token": "A String", # Resource name of the Google Maps widget context token. }, ], }, - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "search_type": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiValue - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiStruct # Represents a structured value. - }, + "googleSearchResult": { # Google Search result content. + "is_error": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "search_suggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. }, ], }, - "name": "A String", # Required. The name of the tool which was called. - "server_name": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, - }, - "toolResult": { # Tool result content. - "call_id": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "is_error": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mime_type": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "end_index": 42, # End of the attributed segment, exclusive. - "file_citation": { # A file citation annotation. # A file citation annotation. - "custom_metadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiValue - ], + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mime_type": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "end_index": 42, # End of the attributed segment, exclusive. + "file_citation": { # A file citation annotation. # A file citation annotation. + "custom_metadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiValue + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiStruct # Represents a structured value. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiStruct # Represents a structured value. }, + ], + }, + "document_uri": "A String", # The URI of the file. + "file_name": "A String", # The name of the file. + "media_id": "A String", # Media ID in-case of image citations, if applicable. + "page_number": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "place_citation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "place_id": "A String", # The ID of the place, in `places/{place_id}` format. + "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "review_id": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, ], + "url": "A String", # URI reference of the place. + }, + "start_index": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "url_citation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, - "document_uri": "A String", # The URI of the file. - "file_name": "A String", # The name of the file. - "media_id": "A String", # Media ID in-case of image citations, if applicable. - "page_number": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "place_citation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "place_id": "A String", # The ID of the place, in `places/{place_id}` format. - "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "review_id": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "start_index": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "url_citation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "is_error": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiValue ], + "text": "A String", # Required. The text content. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiStruct # Represents a structured value. - }, - }, - ], - }, - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "place_id": "A String", # The ID of the place, in `places/{place_id}` format. - "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "review_id": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. }, ], - "widget_context_token": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "is_error": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "search_suggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mime_type": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "end_index": 42, # End of the attributed segment, exclusive. - "file_citation": { # A file citation annotation. # A file citation annotation. - "custom_metadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiValue - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiStruct # Represents a structured value. - }, - }, - ], - }, - "document_uri": "A String", # The URI of the file. - "file_name": "A String", # The name of the file. - "media_id": "A String", # Media ID in-case of image citations, if applicable. - "page_number": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "place_citation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "place_id": "A String", # The ID of the place, in `places/{place_id}` format. - "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "review_id": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "start_index": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "url_citation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "server_name": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiValue + ], }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "server_name": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiValue - ], + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiStruct # Represents a structured value. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiStruct # Represents a structured value. }, + ], + }, + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "is_error": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. }, ], }, }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "is_error": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], + "video": { # A video content block. + "data": "A String", # The video content. + "mime_type": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. }, }, - "video": { # A video content block. - "data": "A String", # The video content. - "mime_type": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - ], + ], + }, + "contentString": "A String", # The content of the step. A single string. }, }, ], }, - "steps": [ # Output only. The steps that make up the interaction. + "steps": [ # Required. Output only. The steps that make up the interaction. { # A step in the interaction. "modelOutput": { # Output generated by the model. "content": [ @@ -3737,118 +3760,325 @@

Method Details

}, }, "userInput": { # Input provided by the user. - "content": [ - { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mime_type": "A String", # The mime type of the audio. - "sample_rate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mime_type": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mime_type": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "end_index": 42, # End of the attributed segment, exclusive. - "file_citation": { # A file citation annotation. # A file citation annotation. - "custom_metadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiValue + "contentList": { # A list of Content. # The content of the step. An array of Content objects. + "contents": [ # The contents of the list. + { # The content of the response. + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mime_type": "A String", # The mime type of the audio. + "sample_rate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mime_type": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mime_type": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "end_index": 42, # End of the attributed segment, exclusive. + "file_citation": { # A file citation annotation. # A file citation annotation. + "custom_metadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiValue + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiStruct # Represents a structured value. + }, + }, + ], + }, + "document_uri": "A String", # The URI of the file. + "file_name": "A String", # The name of the file. + "media_id": "A String", # Media ID in-case of image citations, if applicable. + "page_number": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "place_citation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "place_id": "A String", # The ID of the place, in `places/{place_id}` format. + "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "review_id": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "start_index": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "url_citation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mime_type": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "end_index": 42, # End of the attributed segment, exclusive. + "file_citation": { # A file citation annotation. # A file citation annotation. + "custom_metadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiValue + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiStruct # Represents a structured value. + }, + }, ], }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiStruct # Represents a structured value. + "document_uri": "A String", # The URI of the file. + "file_name": "A String", # The name of the file. + "media_id": "A String", # Media ID in-case of image citations, if applicable. + "page_number": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "place_citation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "place_id": "A String", # The ID of the place, in `places/{place_id}` format. + "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "review_id": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "start_index": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "url_citation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, }, ], + "text": "A String", # Required. The text content. }, - "document_uri": "A String", # The URI of the file. - "file_name": "A String", # The name of the file. - "media_id": "A String", # Media ID in-case of image citations, if applicable. - "page_number": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. }, - "place_citation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "place_id": "A String", # The ID of the place, in `places/{place_id}` format. - "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "review_id": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiValue + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiStruct # Represents a structured value. + }, }, ], - "url": "A String", # URI reference of the place. }, - "start_index": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "url_citation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], }, }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mime_type": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "end_index": 42, # End of the attributed segment, exclusive. - "file_citation": { # A file citation annotation. # A file citation annotation. - "custom_metadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiValue - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiStruct # Represents a structured value. + "search_type": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiValue + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiStruct # Represents a structured value. + }, + }, + ], + }, + "name": "A String", # Required. The name of the tool which was called. + "server_name": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "call_id": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "is_error": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mime_type": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "end_index": 42, # End of the attributed segment, exclusive. + "file_citation": { # A file citation annotation. # A file citation annotation. + "custom_metadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiValue + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiStruct # Represents a structured value. + }, + }, + ], }, + "document_uri": "A String", # The URI of the file. + "file_name": "A String", # The name of the file. + "media_id": "A String", # Media ID in-case of image citations, if applicable. + "page_number": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "place_citation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "place_id": "A String", # The ID of the place, in `places/{place_id}` format. + "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "review_id": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "start_index": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "url_citation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "is_error": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiValue ], }, - "document_uri": "A String", # The URI of the file. - "file_name": "A String", # The name of the file. - "media_id": "A String", # Media ID in-case of image citations, if applicable. - "page_number": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiStruct # Represents a structured value. }, - "place_citation": { # A place citation annotation. # A place citation annotation. + }, + ], + }, + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { "name": "A String", # Title of the place. "place_id": "A String", # The ID of the place, in `places/{place_id}` format. "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. @@ -3860,331 +4090,127 @@

Method Details

], "url": "A String", # URI reference of the place. }, - "start_index": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "url_citation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. + ], + "widget_context_token": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "is_error": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "search_suggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mime_type": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "end_index": 42, # End of the attributed segment, exclusive. + "file_citation": { # A file citation annotation. # A file citation annotation. + "custom_metadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiValue + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiStruct # Represents a structured value. + }, + }, + ], + }, + "document_uri": "A String", # The URI of the file. + "file_name": "A String", # The name of the file. + "media_id": "A String", # Media ID in-case of image citations, if applicable. + "page_number": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "place_citation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "place_id": "A String", # The ID of the place, in `places/{place_id}` format. + "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "review_id": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "start_index": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "url_citation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "server_name": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiValue + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiStruct # Represents a structured value. }, }, ], - "text": "A String", # Required. The text content. }, }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "is_error": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], }, }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiValue - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiStruct # Represents a structured value. - }, - }, - ], - }, - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "search_type": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiValue - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiStruct # Represents a structured value. - }, - }, - ], - }, - "name": "A String", # Required. The name of the tool which was called. - "server_name": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, - }, - "toolResult": { # Tool result content. - "call_id": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "is_error": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mime_type": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "end_index": 42, # End of the attributed segment, exclusive. - "file_citation": { # A file citation annotation. # A file citation annotation. - "custom_metadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiValue - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiStruct # Represents a structured value. - }, - }, - ], - }, - "document_uri": "A String", # The URI of the file. - "file_name": "A String", # The name of the file. - "media_id": "A String", # Media ID in-case of image citations, if applicable. - "page_number": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "place_citation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "place_id": "A String", # The ID of the place, in `places/{place_id}` format. - "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "review_id": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "start_index": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "url_citation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "is_error": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiValue - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiStruct # Represents a structured value. - }, - }, - ], - }, - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "place_id": "A String", # The ID of the place, in `places/{place_id}` format. - "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "review_id": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - ], - "widget_context_token": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "is_error": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "search_suggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mime_type": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "end_index": 42, # End of the attributed segment, exclusive. - "file_citation": { # A file citation annotation. # A file citation annotation. - "custom_metadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiValue - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiStruct # Represents a structured value. - }, - }, - ], - }, - "document_uri": "A String", # The URI of the file. - "file_name": "A String", # The name of the file. - "media_id": "A String", # Media ID in-case of image citations, if applicable. - "page_number": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "place_citation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "place_id": "A String", # The ID of the place, in `places/{place_id}` format. - "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "review_id": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "start_index": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "url_citation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "server_name": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiValue - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiStruct # Represents a structured value. - }, - }, - ], - }, - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "is_error": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], + "video": { # A video content block. + "data": "A String", # The video content. + "mime_type": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. }, }, - "video": { # A video content block. - "data": "A String", # The video content. - "mime_type": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - ], + ], + }, + "contentString": "A String", # The content of the step. A single string. }, }, ], @@ -5700,6 +5726,8 @@

Method Details

], }, "created": "A String", # Required. Output only. The time at which the response was created in ISO 8601 format (YYYY-MM-DDThh:mm:ssZ). + "env_id": "A String", # The environment ID for the interaction. Can be 'remote' for default environment. + "environment_id": "A String", # Output only. The environment ID for the interaction. Only populated if environment config is set in the request. "id": "A String", # Required. Output only. A unique identifier for the interaction completion. "modelInteraction": { # Interaction for generating the completion using models. # Interaction for generating the completion using models. "generation_config": { # Configuration parameters for model interactions. # Input only. Configuration parameters for the model interaction. @@ -6184,6 +6212,28 @@

Method Details

}, ], "previous_interaction_id": "A String", # The ID of the previous interaction, if any. + "remoteEnvironment": { # Configuration for a custom environment. + "networkAllowlist": { # Network egress configuration for the environment. # Allow only specific domains. + "allowlist": [ # List of allowed domains and their configurations. + { # A network egress rule that controls which external domains the environment is allowed to reach. Each rule identifies a target domain and, optionally, a set of HTTP headers to inject into every matching outbound request. + "domain": "A String", # The domain pattern to match for this rule. Use an exact hostname (e.g., `github.com`), a wildcard prefix (e.g., `*.googleapis.com`), or `*` to match all domains. + "transform": { # Headers to inject into requests matching this rule. Key: header name (e.g., "Authorization"). Value: header value (e.g., "Bearer your-token"). + "a_key": "A String", + }, + }, + ], + }, + "networkMode": "A String", # Network egress mode. + "sources": [ + { # A source to be mounted into the environment. + "content": "A String", # The inline content if `type` is `INLINE`. + "encoding": "A String", # Optional encoding for inline content (e.g. `base64`). + "source": "A String", # The source of the environment. For GCS, this is the GCS path. For GitHub, this is the GitHub path. + "target": "A String", # Where the source should appear in the environment. + "type": "A String", + }, + ], + }, "responseFormatList": { "response_formats": [ { @@ -6240,8 +6290,6 @@

Method Details

], }, }, - "video": { # Configuration for video output format. - }, }, ], }, @@ -6299,8 +6347,6 @@

Method Details

], }, }, - "video": { # Configuration for video output format. - }, }, "response_format": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. # Enforces that the generated response is a JSON object that complies with the JSON schema specified in this field. "boolValue": True or False, # Represents a boolean value. @@ -7139,118 +7185,325 @@

Method Details

}, }, "userInput": { # Input provided by the user. - "content": [ - { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mime_type": "A String", # The mime type of the audio. - "sample_rate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mime_type": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mime_type": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "end_index": 42, # End of the attributed segment, exclusive. - "file_citation": { # A file citation annotation. # A file citation annotation. - "custom_metadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiValue + "contentList": { # A list of Content. # The content of the step. An array of Content objects. + "contents": [ # The contents of the list. + { # The content of the response. + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mime_type": "A String", # The mime type of the audio. + "sample_rate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mime_type": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mime_type": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "end_index": 42, # End of the attributed segment, exclusive. + "file_citation": { # A file citation annotation. # A file citation annotation. + "custom_metadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiValue + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiStruct # Represents a structured value. + }, + }, + ], + }, + "document_uri": "A String", # The URI of the file. + "file_name": "A String", # The name of the file. + "media_id": "A String", # Media ID in-case of image citations, if applicable. + "page_number": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "place_citation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "place_id": "A String", # The ID of the place, in `places/{place_id}` format. + "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "review_id": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "start_index": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "url_citation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mime_type": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "end_index": 42, # End of the attributed segment, exclusive. + "file_citation": { # A file citation annotation. # A file citation annotation. + "custom_metadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiValue + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiStruct # Represents a structured value. + }, + }, ], }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiStruct # Represents a structured value. + "document_uri": "A String", # The URI of the file. + "file_name": "A String", # The name of the file. + "media_id": "A String", # Media ID in-case of image citations, if applicable. + "page_number": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "place_citation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "place_id": "A String", # The ID of the place, in `places/{place_id}` format. + "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "review_id": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "start_index": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "url_citation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, }, ], + "text": "A String", # Required. The text content. }, - "document_uri": "A String", # The URI of the file. - "file_name": "A String", # The name of the file. - "media_id": "A String", # Media ID in-case of image citations, if applicable. - "page_number": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. }, - "place_citation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "place_id": "A String", # The ID of the place, in `places/{place_id}` format. - "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "review_id": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiValue + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiStruct # Represents a structured value. + }, }, ], - "url": "A String", # URI reference of the place. }, - "start_index": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "url_citation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], }, }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mime_type": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "end_index": 42, # End of the attributed segment, exclusive. - "file_citation": { # A file citation annotation. # A file citation annotation. - "custom_metadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiValue - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiStruct # Represents a structured value. + "search_type": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiValue + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiStruct # Represents a structured value. + }, + }, + ], + }, + "name": "A String", # Required. The name of the tool which was called. + "server_name": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "call_id": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "is_error": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mime_type": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "end_index": 42, # End of the attributed segment, exclusive. + "file_citation": { # A file citation annotation. # A file citation annotation. + "custom_metadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiValue + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiStruct # Represents a structured value. + }, + }, + ], }, + "document_uri": "A String", # The URI of the file. + "file_name": "A String", # The name of the file. + "media_id": "A String", # Media ID in-case of image citations, if applicable. + "page_number": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "place_citation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "place_id": "A String", # The ID of the place, in `places/{place_id}` format. + "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "review_id": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "start_index": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "url_citation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "is_error": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiValue ], }, - "document_uri": "A String", # The URI of the file. - "file_name": "A String", # The name of the file. - "media_id": "A String", # Media ID in-case of image citations, if applicable. - "page_number": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiStruct # Represents a structured value. }, - "place_citation": { # A place citation annotation. # A place citation annotation. + }, + ], + }, + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { "name": "A String", # Title of the place. "place_id": "A String", # The ID of the place, in `places/{place_id}` format. "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. @@ -7262,336 +7515,132 @@

Method Details

], "url": "A String", # URI reference of the place. }, - "start_index": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "url_citation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiValue - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiStruct # Represents a structured value. - }, + ], + "widget_context_token": "A String", # Resource name of the Google Maps widget context token. }, ], }, - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "search_type": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiValue - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiStruct # Represents a structured value. - }, + "googleSearchResult": { # Google Search result content. + "is_error": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "search_suggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. }, ], }, - "name": "A String", # Required. The name of the tool which was called. - "server_name": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, - }, - "toolResult": { # Tool result content. - "call_id": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "is_error": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mime_type": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "end_index": 42, # End of the attributed segment, exclusive. - "file_citation": { # A file citation annotation. # A file citation annotation. - "custom_metadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiValue - ], + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mime_type": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "end_index": 42, # End of the attributed segment, exclusive. + "file_citation": { # A file citation annotation. # A file citation annotation. + "custom_metadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiValue + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiStruct # Represents a structured value. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiStruct # Represents a structured value. }, + ], + }, + "document_uri": "A String", # The URI of the file. + "file_name": "A String", # The name of the file. + "media_id": "A String", # Media ID in-case of image citations, if applicable. + "page_number": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "place_citation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "place_id": "A String", # The ID of the place, in `places/{place_id}` format. + "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "review_id": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, ], + "url": "A String", # URI reference of the place. + }, + "start_index": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "url_citation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, - "document_uri": "A String", # The URI of the file. - "file_name": "A String", # The name of the file. - "media_id": "A String", # Media ID in-case of image citations, if applicable. - "page_number": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "place_citation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "place_id": "A String", # The ID of the place, in `places/{place_id}` format. - "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "review_id": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "start_index": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "url_citation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "is_error": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiValue ], + "text": "A String", # Required. The text content. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiStruct # Represents a structured value. - }, - }, - ], - }, - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "place_id": "A String", # The ID of the place, in `places/{place_id}` format. - "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "review_id": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. }, ], - "widget_context_token": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "is_error": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "search_suggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mime_type": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "end_index": 42, # End of the attributed segment, exclusive. - "file_citation": { # A file citation annotation. # A file citation annotation. - "custom_metadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiValue - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiStruct # Represents a structured value. - }, - }, - ], - }, - "document_uri": "A String", # The URI of the file. - "file_name": "A String", # The name of the file. - "media_id": "A String", # Media ID in-case of image citations, if applicable. - "page_number": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "place_citation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "place_id": "A String", # The ID of the place, in `places/{place_id}` format. - "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "review_id": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "start_index": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "url_citation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "server_name": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiValue + ], }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "server_name": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiValue - ], + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiStruct # Represents a structured value. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiStruct # Represents a structured value. }, + ], + }, + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "is_error": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. }, ], }, }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "is_error": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], + "video": { # A video content block. + "data": "A String", # The video content. + "mime_type": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. }, }, - "video": { # A video content block. - "data": "A String", # The video content. - "mime_type": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - ], + ], + }, + "contentString": "A String", # The content of the step. A single string. }, }, ], }, - "steps": [ # Output only. The steps that make up the interaction. + "steps": [ # Required. Output only. The steps that make up the interaction. { # A step in the interaction. "modelOutput": { # Output generated by the model. "content": [ @@ -8409,118 +8458,325 @@

Method Details

}, }, "userInput": { # Input provided by the user. - "content": [ - { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mime_type": "A String", # The mime type of the audio. - "sample_rate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mime_type": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mime_type": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "end_index": 42, # End of the attributed segment, exclusive. - "file_citation": { # A file citation annotation. # A file citation annotation. - "custom_metadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiValue + "contentList": { # A list of Content. # The content of the step. An array of Content objects. + "contents": [ # The contents of the list. + { # The content of the response. + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mime_type": "A String", # The mime type of the audio. + "sample_rate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mime_type": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mime_type": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "end_index": 42, # End of the attributed segment, exclusive. + "file_citation": { # A file citation annotation. # A file citation annotation. + "custom_metadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiValue + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiStruct # Represents a structured value. + }, + }, + ], + }, + "document_uri": "A String", # The URI of the file. + "file_name": "A String", # The name of the file. + "media_id": "A String", # Media ID in-case of image citations, if applicable. + "page_number": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "place_citation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "place_id": "A String", # The ID of the place, in `places/{place_id}` format. + "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "review_id": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "start_index": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "url_citation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mime_type": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "end_index": 42, # End of the attributed segment, exclusive. + "file_citation": { # A file citation annotation. # A file citation annotation. + "custom_metadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiValue + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiStruct # Represents a structured value. + }, + }, ], }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiStruct # Represents a structured value. + "document_uri": "A String", # The URI of the file. + "file_name": "A String", # The name of the file. + "media_id": "A String", # Media ID in-case of image citations, if applicable. + "page_number": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "place_citation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "place_id": "A String", # The ID of the place, in `places/{place_id}` format. + "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "review_id": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "start_index": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "url_citation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, }, ], + "text": "A String", # Required. The text content. }, - "document_uri": "A String", # The URI of the file. - "file_name": "A String", # The name of the file. - "media_id": "A String", # Media ID in-case of image citations, if applicable. - "page_number": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. }, - "place_citation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "place_id": "A String", # The ID of the place, in `places/{place_id}` format. - "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "review_id": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiValue + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiStruct # Represents a structured value. + }, }, ], - "url": "A String", # URI reference of the place. }, - "start_index": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "url_citation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], }, }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mime_type": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "end_index": 42, # End of the attributed segment, exclusive. - "file_citation": { # A file citation annotation. # A file citation annotation. - "custom_metadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiValue - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiStruct # Represents a structured value. + "search_type": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiValue + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiStruct # Represents a structured value. + }, + }, + ], + }, + "name": "A String", # Required. The name of the tool which was called. + "server_name": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "call_id": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "is_error": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mime_type": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "end_index": 42, # End of the attributed segment, exclusive. + "file_citation": { # A file citation annotation. # A file citation annotation. + "custom_metadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiValue + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiStruct # Represents a structured value. + }, + }, + ], }, + "document_uri": "A String", # The URI of the file. + "file_name": "A String", # The name of the file. + "media_id": "A String", # Media ID in-case of image citations, if applicable. + "page_number": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "place_citation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "place_id": "A String", # The ID of the place, in `places/{place_id}` format. + "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "review_id": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "start_index": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "url_citation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "is_error": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiValue ], }, - "document_uri": "A String", # The URI of the file. - "file_name": "A String", # The name of the file. - "media_id": "A String", # Media ID in-case of image citations, if applicable. - "page_number": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiStruct # Represents a structured value. }, - "place_citation": { # A place citation annotation. # A place citation annotation. + }, + ], + }, + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { "name": "A String", # Title of the place. "place_id": "A String", # The ID of the place, in `places/{place_id}` format. "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. @@ -8532,331 +8788,127 @@

Method Details

], "url": "A String", # URI reference of the place. }, - "start_index": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "url_citation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. + ], + "widget_context_token": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "is_error": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "search_suggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mime_type": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "end_index": 42, # End of the attributed segment, exclusive. + "file_citation": { # A file citation annotation. # A file citation annotation. + "custom_metadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiValue + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiStruct # Represents a structured value. + }, + }, + ], + }, + "document_uri": "A String", # The URI of the file. + "file_name": "A String", # The name of the file. + "media_id": "A String", # Media ID in-case of image citations, if applicable. + "page_number": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "place_citation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "place_id": "A String", # The ID of the place, in `places/{place_id}` format. + "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "review_id": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "start_index": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "url_citation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "server_name": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiValue + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiStruct # Represents a structured value. }, }, ], - "text": "A String", # Required. The text content. }, }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "is_error": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], }, }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiValue - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiStruct # Represents a structured value. - }, - }, - ], - }, - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "search_type": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiValue - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiStruct # Represents a structured value. - }, - }, - ], - }, - "name": "A String", # Required. The name of the tool which was called. - "server_name": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, - }, - "toolResult": { # Tool result content. - "call_id": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "is_error": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mime_type": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "end_index": 42, # End of the attributed segment, exclusive. - "file_citation": { # A file citation annotation. # A file citation annotation. - "custom_metadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiValue - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiStruct # Represents a structured value. - }, - }, - ], - }, - "document_uri": "A String", # The URI of the file. - "file_name": "A String", # The name of the file. - "media_id": "A String", # Media ID in-case of image citations, if applicable. - "page_number": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "place_citation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "place_id": "A String", # The ID of the place, in `places/{place_id}` format. - "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "review_id": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "start_index": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "url_citation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "is_error": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiValue - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiStruct # Represents a structured value. - }, - }, - ], - }, - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "place_id": "A String", # The ID of the place, in `places/{place_id}` format. - "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "review_id": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - ], - "widget_context_token": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "is_error": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "search_suggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mime_type": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "end_index": 42, # End of the attributed segment, exclusive. - "file_citation": { # A file citation annotation. # A file citation annotation. - "custom_metadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiValue - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiStruct # Represents a structured value. - }, - }, - ], - }, - "document_uri": "A String", # The URI of the file. - "file_name": "A String", # The name of the file. - "media_id": "A String", # Media ID in-case of image citations, if applicable. - "page_number": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "place_citation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "place_id": "A String", # The ID of the place, in `places/{place_id}` format. - "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "review_id": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "start_index": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "url_citation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "server_name": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiValue - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiStruct # Represents a structured value. - }, - }, - ], - }, - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "is_error": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], + "video": { # A video content block. + "data": "A String", # The video content. + "mime_type": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. }, }, - "video": { # A video content block. - "data": "A String", # The video content. - "mime_type": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - ], + ], + }, + "contentString": "A String", # The content of the step. A single string. }, }, ], @@ -10374,6 +10426,8 @@

Method Details

], }, "created": "A String", # Required. Output only. The time at which the response was created in ISO 8601 format (YYYY-MM-DDThh:mm:ssZ). + "env_id": "A String", # The environment ID for the interaction. Can be 'remote' for default environment. + "environment_id": "A String", # Output only. The environment ID for the interaction. Only populated if environment config is set in the request. "id": "A String", # Required. Output only. A unique identifier for the interaction completion. "modelInteraction": { # Interaction for generating the completion using models. # Interaction for generating the completion using models. "generation_config": { # Configuration parameters for model interactions. # Input only. Configuration parameters for the model interaction. @@ -10858,6 +10912,28 @@

Method Details

}, ], "previous_interaction_id": "A String", # The ID of the previous interaction, if any. + "remoteEnvironment": { # Configuration for a custom environment. + "networkAllowlist": { # Network egress configuration for the environment. # Allow only specific domains. + "allowlist": [ # List of allowed domains and their configurations. + { # A network egress rule that controls which external domains the environment is allowed to reach. Each rule identifies a target domain and, optionally, a set of HTTP headers to inject into every matching outbound request. + "domain": "A String", # The domain pattern to match for this rule. Use an exact hostname (e.g., `github.com`), a wildcard prefix (e.g., `*.googleapis.com`), or `*` to match all domains. + "transform": { # Headers to inject into requests matching this rule. Key: header name (e.g., "Authorization"). Value: header value (e.g., "Bearer your-token"). + "a_key": "A String", + }, + }, + ], + }, + "networkMode": "A String", # Network egress mode. + "sources": [ + { # A source to be mounted into the environment. + "content": "A String", # The inline content if `type` is `INLINE`. + "encoding": "A String", # Optional encoding for inline content (e.g. `base64`). + "source": "A String", # The source of the environment. For GCS, this is the GCS path. For GitHub, this is the GitHub path. + "target": "A String", # Where the source should appear in the environment. + "type": "A String", + }, + ], + }, "responseFormatList": { "response_formats": [ { @@ -10914,8 +10990,6 @@

Method Details

], }, }, - "video": { # Configuration for video output format. - }, }, ], }, @@ -10973,8 +11047,6 @@

Method Details

], }, }, - "video": { # Configuration for video output format. - }, }, "response_format": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. # Enforces that the generated response is a JSON object that complies with the JSON schema specified in this field. "boolValue": True or False, # Represents a boolean value. @@ -11813,118 +11885,325 @@

Method Details

}, }, "userInput": { # Input provided by the user. - "content": [ - { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mime_type": "A String", # The mime type of the audio. - "sample_rate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mime_type": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mime_type": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "end_index": 42, # End of the attributed segment, exclusive. - "file_citation": { # A file citation annotation. # A file citation annotation. - "custom_metadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiValue + "contentList": { # A list of Content. # The content of the step. An array of Content objects. + "contents": [ # The contents of the list. + { # The content of the response. + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mime_type": "A String", # The mime type of the audio. + "sample_rate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mime_type": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mime_type": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "end_index": 42, # End of the attributed segment, exclusive. + "file_citation": { # A file citation annotation. # A file citation annotation. + "custom_metadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiValue + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiStruct # Represents a structured value. + }, + }, + ], + }, + "document_uri": "A String", # The URI of the file. + "file_name": "A String", # The name of the file. + "media_id": "A String", # Media ID in-case of image citations, if applicable. + "page_number": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "place_citation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "place_id": "A String", # The ID of the place, in `places/{place_id}` format. + "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "review_id": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "start_index": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "url_citation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mime_type": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "end_index": 42, # End of the attributed segment, exclusive. + "file_citation": { # A file citation annotation. # A file citation annotation. + "custom_metadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiValue + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiStruct # Represents a structured value. + }, + }, ], }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiStruct # Represents a structured value. + "document_uri": "A String", # The URI of the file. + "file_name": "A String", # The name of the file. + "media_id": "A String", # Media ID in-case of image citations, if applicable. + "page_number": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "place_citation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "place_id": "A String", # The ID of the place, in `places/{place_id}` format. + "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "review_id": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "start_index": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "url_citation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, }, ], + "text": "A String", # Required. The text content. }, - "document_uri": "A String", # The URI of the file. - "file_name": "A String", # The name of the file. - "media_id": "A String", # Media ID in-case of image citations, if applicable. - "page_number": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. }, - "place_citation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "place_id": "A String", # The ID of the place, in `places/{place_id}` format. - "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "review_id": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiValue + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiStruct # Represents a structured value. + }, }, ], - "url": "A String", # URI reference of the place. }, - "start_index": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "url_citation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], }, }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mime_type": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "end_index": 42, # End of the attributed segment, exclusive. - "file_citation": { # A file citation annotation. # A file citation annotation. - "custom_metadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiValue - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiStruct # Represents a structured value. + "search_type": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiValue + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiStruct # Represents a structured value. + }, + }, + ], + }, + "name": "A String", # Required. The name of the tool which was called. + "server_name": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "call_id": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "is_error": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mime_type": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "end_index": 42, # End of the attributed segment, exclusive. + "file_citation": { # A file citation annotation. # A file citation annotation. + "custom_metadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiValue + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiStruct # Represents a structured value. + }, + }, + ], }, + "document_uri": "A String", # The URI of the file. + "file_name": "A String", # The name of the file. + "media_id": "A String", # Media ID in-case of image citations, if applicable. + "page_number": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "place_citation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "place_id": "A String", # The ID of the place, in `places/{place_id}` format. + "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "review_id": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "start_index": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "url_citation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "is_error": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiValue ], }, - "document_uri": "A String", # The URI of the file. - "file_name": "A String", # The name of the file. - "media_id": "A String", # Media ID in-case of image citations, if applicable. - "page_number": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiStruct # Represents a structured value. }, - "place_citation": { # A place citation annotation. # A place citation annotation. + }, + ], + }, + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { "name": "A String", # Title of the place. "place_id": "A String", # The ID of the place, in `places/{place_id}` format. "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. @@ -11936,336 +12215,132 @@

Method Details

], "url": "A String", # URI reference of the place. }, - "start_index": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "url_citation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiValue - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiStruct # Represents a structured value. - }, + ], + "widget_context_token": "A String", # Resource name of the Google Maps widget context token. }, ], }, - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "search_type": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiValue - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiStruct # Represents a structured value. - }, + "googleSearchResult": { # Google Search result content. + "is_error": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "search_suggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. }, ], }, - "name": "A String", # Required. The name of the tool which was called. - "server_name": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, - }, - "toolResult": { # Tool result content. - "call_id": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "is_error": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mime_type": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "end_index": 42, # End of the attributed segment, exclusive. - "file_citation": { # A file citation annotation. # A file citation annotation. - "custom_metadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiValue - ], + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mime_type": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "end_index": 42, # End of the attributed segment, exclusive. + "file_citation": { # A file citation annotation. # A file citation annotation. + "custom_metadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiValue + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiStruct # Represents a structured value. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiStruct # Represents a structured value. }, + ], + }, + "document_uri": "A String", # The URI of the file. + "file_name": "A String", # The name of the file. + "media_id": "A String", # Media ID in-case of image citations, if applicable. + "page_number": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "place_citation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "place_id": "A String", # The ID of the place, in `places/{place_id}` format. + "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "review_id": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, ], + "url": "A String", # URI reference of the place. + }, + "start_index": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "url_citation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, - "document_uri": "A String", # The URI of the file. - "file_name": "A String", # The name of the file. - "media_id": "A String", # Media ID in-case of image citations, if applicable. - "page_number": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "place_citation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "place_id": "A String", # The ID of the place, in `places/{place_id}` format. - "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "review_id": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "start_index": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "url_citation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "is_error": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiValue ], + "text": "A String", # Required. The text content. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiStruct # Represents a structured value. - }, - }, - ], - }, - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "place_id": "A String", # The ID of the place, in `places/{place_id}` format. - "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "review_id": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. }, ], - "widget_context_token": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "is_error": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "search_suggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mime_type": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "end_index": 42, # End of the attributed segment, exclusive. - "file_citation": { # A file citation annotation. # A file citation annotation. - "custom_metadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiValue - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiStruct # Represents a structured value. - }, - }, - ], - }, - "document_uri": "A String", # The URI of the file. - "file_name": "A String", # The name of the file. - "media_id": "A String", # Media ID in-case of image citations, if applicable. - "page_number": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "place_citation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "place_id": "A String", # The ID of the place, in `places/{place_id}` format. - "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "review_id": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "start_index": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "url_citation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "server_name": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiValue + ], }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "server_name": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiValue - ], + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiStruct # Represents a structured value. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiStruct # Represents a structured value. }, + ], + }, + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "is_error": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. }, ], }, }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "is_error": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], + "video": { # A video content block. + "data": "A String", # The video content. + "mime_type": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. }, }, - "video": { # A video content block. - "data": "A String", # The video content. - "mime_type": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - ], + ], + }, + "contentString": "A String", # The content of the step. A single string. }, }, ], }, - "steps": [ # Output only. The steps that make up the interaction. + "steps": [ # Required. Output only. The steps that make up the interaction. { # A step in the interaction. "modelOutput": { # Output generated by the model. "content": [ @@ -13083,118 +13158,325 @@

Method Details

}, }, "userInput": { # Input provided by the user. - "content": [ - { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mime_type": "A String", # The mime type of the audio. - "sample_rate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mime_type": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mime_type": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "end_index": 42, # End of the attributed segment, exclusive. - "file_citation": { # A file citation annotation. # A file citation annotation. - "custom_metadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiValue + "contentList": { # A list of Content. # The content of the step. An array of Content objects. + "contents": [ # The contents of the list. + { # The content of the response. + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mime_type": "A String", # The mime type of the audio. + "sample_rate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mime_type": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mime_type": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "end_index": 42, # End of the attributed segment, exclusive. + "file_citation": { # A file citation annotation. # A file citation annotation. + "custom_metadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiValue + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiStruct # Represents a structured value. + }, + }, + ], + }, + "document_uri": "A String", # The URI of the file. + "file_name": "A String", # The name of the file. + "media_id": "A String", # Media ID in-case of image citations, if applicable. + "page_number": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "place_citation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "place_id": "A String", # The ID of the place, in `places/{place_id}` format. + "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "review_id": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "start_index": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "url_citation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mime_type": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "end_index": 42, # End of the attributed segment, exclusive. + "file_citation": { # A file citation annotation. # A file citation annotation. + "custom_metadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiValue + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiStruct # Represents a structured value. + }, + }, ], }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiStruct # Represents a structured value. + "document_uri": "A String", # The URI of the file. + "file_name": "A String", # The name of the file. + "media_id": "A String", # Media ID in-case of image citations, if applicable. + "page_number": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "place_citation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "place_id": "A String", # The ID of the place, in `places/{place_id}` format. + "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "review_id": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "start_index": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "url_citation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, }, ], + "text": "A String", # Required. The text content. }, - "document_uri": "A String", # The URI of the file. - "file_name": "A String", # The name of the file. - "media_id": "A String", # Media ID in-case of image citations, if applicable. - "page_number": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. }, - "place_citation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "place_id": "A String", # The ID of the place, in `places/{place_id}` format. - "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "review_id": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiValue + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiStruct # Represents a structured value. + }, }, ], - "url": "A String", # URI reference of the place. }, - "start_index": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "url_citation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], }, }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mime_type": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "end_index": 42, # End of the attributed segment, exclusive. - "file_citation": { # A file citation annotation. # A file citation annotation. - "custom_metadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiValue - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiStruct # Represents a structured value. + "search_type": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiValue + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiStruct # Represents a structured value. + }, + }, + ], + }, + "name": "A String", # Required. The name of the tool which was called. + "server_name": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "call_id": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "is_error": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mime_type": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "end_index": 42, # End of the attributed segment, exclusive. + "file_citation": { # A file citation annotation. # A file citation annotation. + "custom_metadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiValue + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiStruct # Represents a structured value. + }, + }, + ], }, + "document_uri": "A String", # The URI of the file. + "file_name": "A String", # The name of the file. + "media_id": "A String", # Media ID in-case of image citations, if applicable. + "page_number": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "place_citation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "place_id": "A String", # The ID of the place, in `places/{place_id}` format. + "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "review_id": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "start_index": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "url_citation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "is_error": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiValue ], }, - "document_uri": "A String", # The URI of the file. - "file_name": "A String", # The name of the file. - "media_id": "A String", # Media ID in-case of image citations, if applicable. - "page_number": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiStruct # Represents a structured value. }, - "place_citation": { # A place citation annotation. # A place citation annotation. + }, + ], + }, + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { "name": "A String", # Title of the place. "place_id": "A String", # The ID of the place, in `places/{place_id}` format. "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. @@ -13206,331 +13488,127 @@

Method Details

], "url": "A String", # URI reference of the place. }, - "start_index": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "url_citation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. + ], + "widget_context_token": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "is_error": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "search_suggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mime_type": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "end_index": 42, # End of the attributed segment, exclusive. + "file_citation": { # A file citation annotation. # A file citation annotation. + "custom_metadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiValue + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiStruct # Represents a structured value. + }, + }, + ], + }, + "document_uri": "A String", # The URI of the file. + "file_name": "A String", # The name of the file. + "media_id": "A String", # Media ID in-case of image citations, if applicable. + "page_number": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "place_citation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "place_id": "A String", # The ID of the place, in `places/{place_id}` format. + "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "review_id": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "start_index": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "url_citation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "server_name": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiValue + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiStruct # Represents a structured value. }, }, ], - "text": "A String", # Required. The text content. }, }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "is_error": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], }, }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiValue - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiStruct # Represents a structured value. - }, - }, - ], - }, - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "search_type": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiValue - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiStruct # Represents a structured value. - }, - }, - ], - }, - "name": "A String", # Required. The name of the tool which was called. - "server_name": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, - }, - "toolResult": { # Tool result content. - "call_id": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "is_error": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mime_type": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "end_index": 42, # End of the attributed segment, exclusive. - "file_citation": { # A file citation annotation. # A file citation annotation. - "custom_metadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiValue - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiStruct # Represents a structured value. - }, - }, - ], - }, - "document_uri": "A String", # The URI of the file. - "file_name": "A String", # The name of the file. - "media_id": "A String", # Media ID in-case of image citations, if applicable. - "page_number": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "place_citation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "place_id": "A String", # The ID of the place, in `places/{place_id}` format. - "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "review_id": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "start_index": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "url_citation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "is_error": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiValue - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiStruct # Represents a structured value. - }, - }, - ], - }, - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "place_id": "A String", # The ID of the place, in `places/{place_id}` format. - "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "review_id": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - ], - "widget_context_token": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "is_error": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "search_suggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mime_type": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "end_index": 42, # End of the attributed segment, exclusive. - "file_citation": { # A file citation annotation. # A file citation annotation. - "custom_metadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiValue - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiStruct # Represents a structured value. - }, - }, - ], - }, - "document_uri": "A String", # The URI of the file. - "file_name": "A String", # The name of the file. - "media_id": "A String", # Media ID in-case of image citations, if applicable. - "page_number": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "place_citation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "place_id": "A String", # The ID of the place, in `places/{place_id}` format. - "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "review_id": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "start_index": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "url_citation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "server_name": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiValue - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiStruct # Represents a structured value. - }, - }, - ], - }, - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "is_error": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], + "video": { # A video content block. + "data": "A String", # The video content. + "mime_type": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. }, }, - "video": { # A video content block. - "data": "A String", # The video content. - "mime_type": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - ], + ], + }, + "contentString": "A String", # The content of the step. A single string. }, }, ], @@ -15958,6 +16036,8 @@

Method Details

], }, "created": "A String", # Required. Output only. The time at which the response was created in ISO 8601 format (YYYY-MM-DDThh:mm:ssZ). + "env_id": "A String", # The environment ID for the interaction. Can be 'remote' for default environment. + "environment_id": "A String", # Output only. The environment ID for the interaction. Only populated if environment config is set in the request. "id": "A String", # Required. Output only. A unique identifier for the interaction completion. "modelInteraction": { # Interaction for generating the completion using models. # Interaction for generating the completion using models. "generation_config": { # Configuration parameters for model interactions. # Input only. Configuration parameters for the model interaction. @@ -16442,6 +16522,28 @@

Method Details

}, ], "previous_interaction_id": "A String", # The ID of the previous interaction, if any. + "remoteEnvironment": { # Configuration for a custom environment. + "networkAllowlist": { # Network egress configuration for the environment. # Allow only specific domains. + "allowlist": [ # List of allowed domains and their configurations. + { # A network egress rule that controls which external domains the environment is allowed to reach. Each rule identifies a target domain and, optionally, a set of HTTP headers to inject into every matching outbound request. + "domain": "A String", # The domain pattern to match for this rule. Use an exact hostname (e.g., `github.com`), a wildcard prefix (e.g., `*.googleapis.com`), or `*` to match all domains. + "transform": { # Headers to inject into requests matching this rule. Key: header name (e.g., "Authorization"). Value: header value (e.g., "Bearer your-token"). + "a_key": "A String", + }, + }, + ], + }, + "networkMode": "A String", # Network egress mode. + "sources": [ + { # A source to be mounted into the environment. + "content": "A String", # The inline content if `type` is `INLINE`. + "encoding": "A String", # Optional encoding for inline content (e.g. `base64`). + "source": "A String", # The source of the environment. For GCS, this is the GCS path. For GitHub, this is the GitHub path. + "target": "A String", # Where the source should appear in the environment. + "type": "A String", + }, + ], + }, "responseFormatList": { "response_formats": [ { @@ -16498,8 +16600,6 @@

Method Details

], }, }, - "video": { # Configuration for video output format. - }, }, ], }, @@ -16557,8 +16657,6 @@

Method Details

], }, }, - "video": { # Configuration for video output format. - }, }, "response_format": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. # Enforces that the generated response is a JSON object that complies with the JSON schema specified in this field. "boolValue": True or False, # Represents a boolean value. @@ -17397,118 +17495,325 @@

Method Details

}, }, "userInput": { # Input provided by the user. - "content": [ - { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mime_type": "A String", # The mime type of the audio. - "sample_rate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mime_type": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mime_type": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "end_index": 42, # End of the attributed segment, exclusive. - "file_citation": { # A file citation annotation. # A file citation annotation. - "custom_metadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiValue + "contentList": { # A list of Content. # The content of the step. An array of Content objects. + "contents": [ # The contents of the list. + { # The content of the response. + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mime_type": "A String", # The mime type of the audio. + "sample_rate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mime_type": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mime_type": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "end_index": 42, # End of the attributed segment, exclusive. + "file_citation": { # A file citation annotation. # A file citation annotation. + "custom_metadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiValue + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiStruct # Represents a structured value. + }, + }, + ], + }, + "document_uri": "A String", # The URI of the file. + "file_name": "A String", # The name of the file. + "media_id": "A String", # Media ID in-case of image citations, if applicable. + "page_number": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "place_citation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "place_id": "A String", # The ID of the place, in `places/{place_id}` format. + "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "review_id": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "start_index": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "url_citation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mime_type": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "end_index": 42, # End of the attributed segment, exclusive. + "file_citation": { # A file citation annotation. # A file citation annotation. + "custom_metadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiValue + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiStruct # Represents a structured value. + }, + }, ], }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiStruct # Represents a structured value. + "document_uri": "A String", # The URI of the file. + "file_name": "A String", # The name of the file. + "media_id": "A String", # Media ID in-case of image citations, if applicable. + "page_number": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "place_citation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "place_id": "A String", # The ID of the place, in `places/{place_id}` format. + "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "review_id": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "start_index": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "url_citation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, }, ], + "text": "A String", # Required. The text content. }, - "document_uri": "A String", # The URI of the file. - "file_name": "A String", # The name of the file. - "media_id": "A String", # Media ID in-case of image citations, if applicable. - "page_number": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. }, - "place_citation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "place_id": "A String", # The ID of the place, in `places/{place_id}` format. - "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "review_id": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiValue + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiStruct # Represents a structured value. + }, }, ], - "url": "A String", # URI reference of the place. }, - "start_index": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "url_citation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], }, }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mime_type": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "end_index": 42, # End of the attributed segment, exclusive. - "file_citation": { # A file citation annotation. # A file citation annotation. - "custom_metadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiValue - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiStruct # Represents a structured value. + "search_type": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiValue + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiStruct # Represents a structured value. + }, + }, + ], + }, + "name": "A String", # Required. The name of the tool which was called. + "server_name": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "call_id": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "is_error": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mime_type": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "end_index": 42, # End of the attributed segment, exclusive. + "file_citation": { # A file citation annotation. # A file citation annotation. + "custom_metadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiValue + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiStruct # Represents a structured value. + }, + }, + ], }, + "document_uri": "A String", # The URI of the file. + "file_name": "A String", # The name of the file. + "media_id": "A String", # Media ID in-case of image citations, if applicable. + "page_number": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "place_citation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "place_id": "A String", # The ID of the place, in `places/{place_id}` format. + "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "review_id": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "start_index": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "url_citation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "is_error": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiValue ], }, - "document_uri": "A String", # The URI of the file. - "file_name": "A String", # The name of the file. - "media_id": "A String", # Media ID in-case of image citations, if applicable. - "page_number": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiStruct # Represents a structured value. }, - "place_citation": { # A place citation annotation. # A place citation annotation. + }, + ], + }, + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { "name": "A String", # Title of the place. "place_id": "A String", # The ID of the place, in `places/{place_id}` format. "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. @@ -17520,336 +17825,132 @@

Method Details

], "url": "A String", # URI reference of the place. }, - "start_index": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "url_citation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiValue - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiStruct # Represents a structured value. - }, + ], + "widget_context_token": "A String", # Resource name of the Google Maps widget context token. }, ], }, - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "search_type": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiValue - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiStruct # Represents a structured value. - }, + "googleSearchResult": { # Google Search result content. + "is_error": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "search_suggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. }, ], }, - "name": "A String", # Required. The name of the tool which was called. - "server_name": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, - }, - "toolResult": { # Tool result content. - "call_id": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "is_error": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mime_type": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "end_index": 42, # End of the attributed segment, exclusive. - "file_citation": { # A file citation annotation. # A file citation annotation. - "custom_metadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiValue - ], + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mime_type": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "end_index": 42, # End of the attributed segment, exclusive. + "file_citation": { # A file citation annotation. # A file citation annotation. + "custom_metadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiValue + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiStruct # Represents a structured value. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiStruct # Represents a structured value. }, + ], + }, + "document_uri": "A String", # The URI of the file. + "file_name": "A String", # The name of the file. + "media_id": "A String", # Media ID in-case of image citations, if applicable. + "page_number": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "place_citation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "place_id": "A String", # The ID of the place, in `places/{place_id}` format. + "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "review_id": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, ], + "url": "A String", # URI reference of the place. + }, + "start_index": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "url_citation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, - "document_uri": "A String", # The URI of the file. - "file_name": "A String", # The name of the file. - "media_id": "A String", # Media ID in-case of image citations, if applicable. - "page_number": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "place_citation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "place_id": "A String", # The ID of the place, in `places/{place_id}` format. - "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "review_id": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "start_index": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "url_citation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "is_error": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiValue ], + "text": "A String", # Required. The text content. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiStruct # Represents a structured value. }, - }, - ], - }, - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "place_id": "A String", # The ID of the place, in `places/{place_id}` format. - "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "review_id": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "server_name": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiValue + ], }, - ], - "url": "A String", # URI reference of the place. + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiStruct # Represents a structured value. + }, }, ], - "widget_context_token": "A String", # Resource name of the Google Maps widget context token. }, - ], + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "is_error": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, }, - "googleSearchResult": { # Google Search result content. - "is_error": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "search_suggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mime_type": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "end_index": 42, # End of the attributed segment, exclusive. - "file_citation": { # A file citation annotation. # A file citation annotation. - "custom_metadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiValue - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiStruct # Represents a structured value. - }, - }, - ], - }, - "document_uri": "A String", # The URI of the file. - "file_name": "A String", # The name of the file. - "media_id": "A String", # Media ID in-case of image citations, if applicable. - "page_number": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "place_citation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "place_id": "A String", # The ID of the place, in `places/{place_id}` format. - "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "review_id": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "start_index": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "url_citation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "server_name": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiValue - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiStruct # Represents a structured value. - }, - }, - ], - }, - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "is_error": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], + "video": { # A video content block. + "data": "A String", # The video content. + "mime_type": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. }, }, - "video": { # A video content block. - "data": "A String", # The video content. - "mime_type": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - ], + ], + }, + "contentString": "A String", # The content of the step. A single string. }, }, ], }, - "steps": [ # Output only. The steps that make up the interaction. + "steps": [ # Required. Output only. The steps that make up the interaction. { # A step in the interaction. "modelOutput": { # Output generated by the model. "content": [ @@ -18667,118 +18768,325 @@

Method Details

}, }, "userInput": { # Input provided by the user. - "content": [ - { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mime_type": "A String", # The mime type of the audio. - "sample_rate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mime_type": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mime_type": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "end_index": 42, # End of the attributed segment, exclusive. - "file_citation": { # A file citation annotation. # A file citation annotation. - "custom_metadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiValue + "contentList": { # A list of Content. # The content of the step. An array of Content objects. + "contents": [ # The contents of the list. + { # The content of the response. + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mime_type": "A String", # The mime type of the audio. + "sample_rate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mime_type": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mime_type": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "end_index": 42, # End of the attributed segment, exclusive. + "file_citation": { # A file citation annotation. # A file citation annotation. + "custom_metadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiValue + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiStruct # Represents a structured value. + }, + }, + ], + }, + "document_uri": "A String", # The URI of the file. + "file_name": "A String", # The name of the file. + "media_id": "A String", # Media ID in-case of image citations, if applicable. + "page_number": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "place_citation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "place_id": "A String", # The ID of the place, in `places/{place_id}` format. + "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "review_id": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "start_index": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "url_citation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mime_type": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "end_index": 42, # End of the attributed segment, exclusive. + "file_citation": { # A file citation annotation. # A file citation annotation. + "custom_metadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiValue + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiStruct # Represents a structured value. + }, + }, ], }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiStruct # Represents a structured value. + "document_uri": "A String", # The URI of the file. + "file_name": "A String", # The name of the file. + "media_id": "A String", # Media ID in-case of image citations, if applicable. + "page_number": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "place_citation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "place_id": "A String", # The ID of the place, in `places/{place_id}` format. + "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "review_id": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "start_index": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "url_citation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, }, ], + "text": "A String", # Required. The text content. }, - "document_uri": "A String", # The URI of the file. - "file_name": "A String", # The name of the file. - "media_id": "A String", # Media ID in-case of image citations, if applicable. - "page_number": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. }, - "place_citation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "place_id": "A String", # The ID of the place, in `places/{place_id}` format. - "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "review_id": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiValue + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiStruct # Represents a structured value. + }, }, ], - "url": "A String", # URI reference of the place. }, - "start_index": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "url_citation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], }, }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mime_type": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "end_index": 42, # End of the attributed segment, exclusive. - "file_citation": { # A file citation annotation. # A file citation annotation. - "custom_metadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiValue - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiStruct # Represents a structured value. + "search_type": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiValue + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiStruct # Represents a structured value. + }, + }, + ], + }, + "name": "A String", # Required. The name of the tool which was called. + "server_name": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "call_id": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "is_error": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mime_type": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "end_index": 42, # End of the attributed segment, exclusive. + "file_citation": { # A file citation annotation. # A file citation annotation. + "custom_metadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiValue + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiStruct # Represents a structured value. + }, + }, + ], }, + "document_uri": "A String", # The URI of the file. + "file_name": "A String", # The name of the file. + "media_id": "A String", # Media ID in-case of image citations, if applicable. + "page_number": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "place_citation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "place_id": "A String", # The ID of the place, in `places/{place_id}` format. + "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "review_id": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "start_index": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "url_citation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "is_error": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiValue ], }, - "document_uri": "A String", # The URI of the file. - "file_name": "A String", # The name of the file. - "media_id": "A String", # Media ID in-case of image citations, if applicable. - "page_number": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiStruct # Represents a structured value. }, - "place_citation": { # A place citation annotation. # A place citation annotation. + }, + ], + }, + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { "name": "A String", # Title of the place. "place_id": "A String", # The ID of the place, in `places/{place_id}` format. "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. @@ -18790,331 +19098,127 @@

Method Details

], "url": "A String", # URI reference of the place. }, - "start_index": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "url_citation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiValue - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiStruct # Represents a structured value. - }, + ], + "widget_context_token": "A String", # Resource name of the Google Maps widget context token. }, ], }, - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "search_type": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiValue - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiStruct # Represents a structured value. - }, + "googleSearchResult": { # Google Search result content. + "is_error": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "search_suggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. }, ], }, - "name": "A String", # Required. The name of the tool which was called. - "server_name": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, - }, - "toolResult": { # Tool result content. - "call_id": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "is_error": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mime_type": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "end_index": 42, # End of the attributed segment, exclusive. - "file_citation": { # A file citation annotation. # A file citation annotation. - "custom_metadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiValue - ], + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mime_type": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "end_index": 42, # End of the attributed segment, exclusive. + "file_citation": { # A file citation annotation. # A file citation annotation. + "custom_metadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiValue + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiStruct # Represents a structured value. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiStruct # Represents a structured value. }, + ], + }, + "document_uri": "A String", # The URI of the file. + "file_name": "A String", # The name of the file. + "media_id": "A String", # Media ID in-case of image citations, if applicable. + "page_number": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "place_citation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "place_id": "A String", # The ID of the place, in `places/{place_id}` format. + "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "review_id": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, ], + "url": "A String", # URI reference of the place. + }, + "start_index": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "url_citation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, - "document_uri": "A String", # The URI of the file. - "file_name": "A String", # The name of the file. - "media_id": "A String", # Media ID in-case of image citations, if applicable. - "page_number": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "place_citation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "place_id": "A String", # The ID of the place, in `places/{place_id}` format. - "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "review_id": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "start_index": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "url_citation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "is_error": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiValue ], + "text": "A String", # Required. The text content. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiStruct # Represents a structured value. - }, - }, - ], - }, - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "place_id": "A String", # The ID of the place, in `places/{place_id}` format. - "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "review_id": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. }, ], - "widget_context_token": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "is_error": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "search_suggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mime_type": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "end_index": 42, # End of the attributed segment, exclusive. - "file_citation": { # A file citation annotation. # A file citation annotation. - "custom_metadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiValue - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiStruct # Represents a structured value. - }, - }, - ], - }, - "document_uri": "A String", # The URI of the file. - "file_name": "A String", # The name of the file. - "media_id": "A String", # Media ID in-case of image citations, if applicable. - "page_number": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "place_citation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "place_id": "A String", # The ID of the place, in `places/{place_id}` format. - "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "review_id": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "start_index": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "url_citation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "server_name": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiValue + ], }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "server_name": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiValue - ], + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiStruct # Represents a structured value. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiStruct # Represents a structured value. }, + ], + }, + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "is_error": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. }, ], }, }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "is_error": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], + "video": { # A video content block. + "data": "A String", # The video content. + "mime_type": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. }, }, - "video": { # A video content block. - "data": "A String", # The video content. - "mime_type": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - ], + ], + }, + "contentString": "A String", # The content of the step. A single string. }, }, ], @@ -20620,6 +20724,8 @@

Method Details

], }, "created": "A String", # Required. Output only. The time at which the response was created in ISO 8601 format (YYYY-MM-DDThh:mm:ssZ). + "env_id": "A String", # The environment ID for the interaction. Can be 'remote' for default environment. + "environment_id": "A String", # Output only. The environment ID for the interaction. Only populated if environment config is set in the request. "id": "A String", # Required. Output only. A unique identifier for the interaction completion. "modelInteraction": { # Interaction for generating the completion using models. # Interaction for generating the completion using models. "generation_config": { # Configuration parameters for model interactions. # Input only. Configuration parameters for the model interaction. @@ -21104,6 +21210,28 @@

Method Details

}, ], "previous_interaction_id": "A String", # The ID of the previous interaction, if any. + "remoteEnvironment": { # Configuration for a custom environment. + "networkAllowlist": { # Network egress configuration for the environment. # Allow only specific domains. + "allowlist": [ # List of allowed domains and their configurations. + { # A network egress rule that controls which external domains the environment is allowed to reach. Each rule identifies a target domain and, optionally, a set of HTTP headers to inject into every matching outbound request. + "domain": "A String", # The domain pattern to match for this rule. Use an exact hostname (e.g., `github.com`), a wildcard prefix (e.g., `*.googleapis.com`), or `*` to match all domains. + "transform": { # Headers to inject into requests matching this rule. Key: header name (e.g., "Authorization"). Value: header value (e.g., "Bearer your-token"). + "a_key": "A String", + }, + }, + ], + }, + "networkMode": "A String", # Network egress mode. + "sources": [ + { # A source to be mounted into the environment. + "content": "A String", # The inline content if `type` is `INLINE`. + "encoding": "A String", # Optional encoding for inline content (e.g. `base64`). + "source": "A String", # The source of the environment. For GCS, this is the GCS path. For GitHub, this is the GitHub path. + "target": "A String", # Where the source should appear in the environment. + "type": "A String", + }, + ], + }, "responseFormatList": { "response_formats": [ { @@ -21160,8 +21288,6 @@

Method Details

], }, }, - "video": { # Configuration for video output format. - }, }, ], }, @@ -21219,8 +21345,6 @@

Method Details

], }, }, - "video": { # Configuration for video output format. - }, }, "response_format": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. # Enforces that the generated response is a JSON object that complies with the JSON schema specified in this field. "boolValue": True or False, # Represents a boolean value. @@ -22059,118 +22183,325 @@

Method Details

}, }, "userInput": { # Input provided by the user. - "content": [ - { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mime_type": "A String", # The mime type of the audio. - "sample_rate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mime_type": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mime_type": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "end_index": 42, # End of the attributed segment, exclusive. - "file_citation": { # A file citation annotation. # A file citation annotation. - "custom_metadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiValue + "contentList": { # A list of Content. # The content of the step. An array of Content objects. + "contents": [ # The contents of the list. + { # The content of the response. + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mime_type": "A String", # The mime type of the audio. + "sample_rate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mime_type": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mime_type": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "end_index": 42, # End of the attributed segment, exclusive. + "file_citation": { # A file citation annotation. # A file citation annotation. + "custom_metadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiValue + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiStruct # Represents a structured value. + }, + }, + ], + }, + "document_uri": "A String", # The URI of the file. + "file_name": "A String", # The name of the file. + "media_id": "A String", # Media ID in-case of image citations, if applicable. + "page_number": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "place_citation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "place_id": "A String", # The ID of the place, in `places/{place_id}` format. + "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "review_id": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "start_index": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "url_citation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mime_type": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "end_index": 42, # End of the attributed segment, exclusive. + "file_citation": { # A file citation annotation. # A file citation annotation. + "custom_metadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiValue + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiStruct # Represents a structured value. + }, + }, ], }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiStruct # Represents a structured value. + "document_uri": "A String", # The URI of the file. + "file_name": "A String", # The name of the file. + "media_id": "A String", # Media ID in-case of image citations, if applicable. + "page_number": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "place_citation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "place_id": "A String", # The ID of the place, in `places/{place_id}` format. + "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "review_id": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "start_index": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "url_citation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, }, ], + "text": "A String", # Required. The text content. }, - "document_uri": "A String", # The URI of the file. - "file_name": "A String", # The name of the file. - "media_id": "A String", # Media ID in-case of image citations, if applicable. - "page_number": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. }, - "place_citation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "place_id": "A String", # The ID of the place, in `places/{place_id}` format. - "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "review_id": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiValue + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiStruct # Represents a structured value. + }, }, ], - "url": "A String", # URI reference of the place. }, - "start_index": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "url_citation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], }, }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mime_type": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "end_index": 42, # End of the attributed segment, exclusive. - "file_citation": { # A file citation annotation. # A file citation annotation. - "custom_metadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiValue - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiStruct # Represents a structured value. + "search_type": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiValue + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiStruct # Represents a structured value. + }, + }, + ], + }, + "name": "A String", # Required. The name of the tool which was called. + "server_name": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "call_id": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "is_error": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mime_type": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "end_index": 42, # End of the attributed segment, exclusive. + "file_citation": { # A file citation annotation. # A file citation annotation. + "custom_metadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiValue + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiStruct # Represents a structured value. + }, + }, + ], }, + "document_uri": "A String", # The URI of the file. + "file_name": "A String", # The name of the file. + "media_id": "A String", # Media ID in-case of image citations, if applicable. + "page_number": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "place_citation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "place_id": "A String", # The ID of the place, in `places/{place_id}` format. + "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "review_id": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "start_index": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "url_citation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "is_error": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiValue ], }, - "document_uri": "A String", # The URI of the file. - "file_name": "A String", # The name of the file. - "media_id": "A String", # Media ID in-case of image citations, if applicable. - "page_number": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiStruct # Represents a structured value. }, - "place_citation": { # A place citation annotation. # A place citation annotation. + }, + ], + }, + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { "name": "A String", # Title of the place. "place_id": "A String", # The ID of the place, in `places/{place_id}` format. "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. @@ -22182,336 +22513,132 @@

Method Details

], "url": "A String", # URI reference of the place. }, - "start_index": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "url_citation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiValue - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiStruct # Represents a structured value. - }, + ], + "widget_context_token": "A String", # Resource name of the Google Maps widget context token. }, ], }, - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "search_type": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiValue - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiStruct # Represents a structured value. - }, + "googleSearchResult": { # Google Search result content. + "is_error": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "search_suggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. }, ], }, - "name": "A String", # Required. The name of the tool which was called. - "server_name": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, - }, - "toolResult": { # Tool result content. - "call_id": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "is_error": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mime_type": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "end_index": 42, # End of the attributed segment, exclusive. - "file_citation": { # A file citation annotation. # A file citation annotation. - "custom_metadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiValue - ], + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mime_type": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "end_index": 42, # End of the attributed segment, exclusive. + "file_citation": { # A file citation annotation. # A file citation annotation. + "custom_metadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiValue + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiStruct # Represents a structured value. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiStruct # Represents a structured value. }, + ], + }, + "document_uri": "A String", # The URI of the file. + "file_name": "A String", # The name of the file. + "media_id": "A String", # Media ID in-case of image citations, if applicable. + "page_number": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "place_citation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "place_id": "A String", # The ID of the place, in `places/{place_id}` format. + "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "review_id": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, ], + "url": "A String", # URI reference of the place. + }, + "start_index": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "url_citation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, - "document_uri": "A String", # The URI of the file. - "file_name": "A String", # The name of the file. - "media_id": "A String", # Media ID in-case of image citations, if applicable. - "page_number": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "place_citation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "place_id": "A String", # The ID of the place, in `places/{place_id}` format. - "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "review_id": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "start_index": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "url_citation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "is_error": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiValue ], + "text": "A String", # Required. The text content. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiStruct # Represents a structured value. }, - }, - ], - }, - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "place_id": "A String", # The ID of the place, in `places/{place_id}` format. - "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "review_id": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "server_name": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiValue + ], }, - ], - "url": "A String", # URI reference of the place. + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiStruct # Represents a structured value. + }, }, ], - "widget_context_token": "A String", # Resource name of the Google Maps widget context token. }, - ], + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "is_error": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, }, - "googleSearchResult": { # Google Search result content. - "is_error": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "search_suggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mime_type": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "end_index": 42, # End of the attributed segment, exclusive. - "file_citation": { # A file citation annotation. # A file citation annotation. - "custom_metadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiValue - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiStruct # Represents a structured value. - }, - }, - ], - }, - "document_uri": "A String", # The URI of the file. - "file_name": "A String", # The name of the file. - "media_id": "A String", # Media ID in-case of image citations, if applicable. - "page_number": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "place_citation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "place_id": "A String", # The ID of the place, in `places/{place_id}` format. - "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "review_id": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "start_index": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "url_citation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "server_name": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiValue - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiStruct # Represents a structured value. - }, - }, - ], - }, - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "is_error": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], + "video": { # A video content block. + "data": "A String", # The video content. + "mime_type": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. }, }, - "video": { # A video content block. - "data": "A String", # The video content. - "mime_type": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - ], + ], + }, + "contentString": "A String", # The content of the step. A single string. }, }, ], }, - "steps": [ # Output only. The steps that make up the interaction. + "steps": [ # Required. Output only. The steps that make up the interaction. { # A step in the interaction. "modelOutput": { # Output generated by the model. "content": [ @@ -23329,118 +23456,325 @@

Method Details

}, }, "userInput": { # Input provided by the user. - "content": [ - { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mime_type": "A String", # The mime type of the audio. - "sample_rate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mime_type": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mime_type": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "end_index": 42, # End of the attributed segment, exclusive. - "file_citation": { # A file citation annotation. # A file citation annotation. - "custom_metadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiValue + "contentList": { # A list of Content. # The content of the step. An array of Content objects. + "contents": [ # The contents of the list. + { # The content of the response. + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mime_type": "A String", # The mime type of the audio. + "sample_rate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mime_type": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mime_type": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "end_index": 42, # End of the attributed segment, exclusive. + "file_citation": { # A file citation annotation. # A file citation annotation. + "custom_metadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiValue + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiStruct # Represents a structured value. + }, + }, + ], + }, + "document_uri": "A String", # The URI of the file. + "file_name": "A String", # The name of the file. + "media_id": "A String", # Media ID in-case of image citations, if applicable. + "page_number": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "place_citation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "place_id": "A String", # The ID of the place, in `places/{place_id}` format. + "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "review_id": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "start_index": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "url_citation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mime_type": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "end_index": 42, # End of the attributed segment, exclusive. + "file_citation": { # A file citation annotation. # A file citation annotation. + "custom_metadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiValue + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiStruct # Represents a structured value. + }, + }, ], }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiStruct # Represents a structured value. + "document_uri": "A String", # The URI of the file. + "file_name": "A String", # The name of the file. + "media_id": "A String", # Media ID in-case of image citations, if applicable. + "page_number": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "place_citation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "place_id": "A String", # The ID of the place, in `places/{place_id}` format. + "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "review_id": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "start_index": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "url_citation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, }, ], + "text": "A String", # Required. The text content. }, - "document_uri": "A String", # The URI of the file. - "file_name": "A String", # The name of the file. - "media_id": "A String", # Media ID in-case of image citations, if applicable. - "page_number": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. }, - "place_citation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "place_id": "A String", # The ID of the place, in `places/{place_id}` format. - "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "review_id": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiValue + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiStruct # Represents a structured value. + }, }, ], - "url": "A String", # URI reference of the place. }, - "start_index": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "url_citation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], }, }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mime_type": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "end_index": 42, # End of the attributed segment, exclusive. - "file_citation": { # A file citation annotation. # A file citation annotation. - "custom_metadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiValue - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiStruct # Represents a structured value. + "search_type": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiValue + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiStruct # Represents a structured value. + }, + }, + ], + }, + "name": "A String", # Required. The name of the tool which was called. + "server_name": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "call_id": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "is_error": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mime_type": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "end_index": 42, # End of the attributed segment, exclusive. + "file_citation": { # A file citation annotation. # A file citation annotation. + "custom_metadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiValue + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiStruct # Represents a structured value. + }, + }, + ], }, + "document_uri": "A String", # The URI of the file. + "file_name": "A String", # The name of the file. + "media_id": "A String", # Media ID in-case of image citations, if applicable. + "page_number": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "place_citation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "place_id": "A String", # The ID of the place, in `places/{place_id}` format. + "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "review_id": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "start_index": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "url_citation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "is_error": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiValue ], }, - "document_uri": "A String", # The URI of the file. - "file_name": "A String", # The name of the file. - "media_id": "A String", # Media ID in-case of image citations, if applicable. - "page_number": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiStruct # Represents a structured value. }, - "place_citation": { # A place citation annotation. # A place citation annotation. + }, + ], + }, + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { "name": "A String", # Title of the place. "place_id": "A String", # The ID of the place, in `places/{place_id}` format. "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. @@ -23452,331 +23786,127 @@

Method Details

], "url": "A String", # URI reference of the place. }, - "start_index": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "url_citation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiValue - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiStruct # Represents a structured value. - }, + ], + "widget_context_token": "A String", # Resource name of the Google Maps widget context token. }, ], }, - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "search_type": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiValue - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiStruct # Represents a structured value. - }, + "googleSearchResult": { # Google Search result content. + "is_error": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "search_suggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. }, ], }, - "name": "A String", # Required. The name of the tool which was called. - "server_name": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, - }, - "toolResult": { # Tool result content. - "call_id": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "is_error": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mime_type": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "end_index": 42, # End of the attributed segment, exclusive. - "file_citation": { # A file citation annotation. # A file citation annotation. - "custom_metadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiValue - ], + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mime_type": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "end_index": 42, # End of the attributed segment, exclusive. + "file_citation": { # A file citation annotation. # A file citation annotation. + "custom_metadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiValue + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiStruct # Represents a structured value. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiStruct # Represents a structured value. }, + ], + }, + "document_uri": "A String", # The URI of the file. + "file_name": "A String", # The name of the file. + "media_id": "A String", # Media ID in-case of image citations, if applicable. + "page_number": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "place_citation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "place_id": "A String", # The ID of the place, in `places/{place_id}` format. + "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "review_id": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, ], + "url": "A String", # URI reference of the place. + }, + "start_index": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "url_citation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, - "document_uri": "A String", # The URI of the file. - "file_name": "A String", # The name of the file. - "media_id": "A String", # Media ID in-case of image citations, if applicable. - "page_number": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "place_citation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "place_id": "A String", # The ID of the place, in `places/{place_id}` format. - "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "review_id": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "start_index": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "url_citation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "is_error": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiValue ], + "text": "A String", # Required. The text content. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiStruct # Represents a structured value. - }, - }, - ], - }, - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "place_id": "A String", # The ID of the place, in `places/{place_id}` format. - "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "review_id": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. }, ], - "widget_context_token": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "is_error": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "search_suggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mime_type": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "end_index": 42, # End of the attributed segment, exclusive. - "file_citation": { # A file citation annotation. # A file citation annotation. - "custom_metadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiValue - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiStruct # Represents a structured value. - }, - }, - ], - }, - "document_uri": "A String", # The URI of the file. - "file_name": "A String", # The name of the file. - "media_id": "A String", # Media ID in-case of image citations, if applicable. - "page_number": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "place_citation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "place_id": "A String", # The ID of the place, in `places/{place_id}` format. - "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "review_id": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "start_index": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "url_citation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "server_name": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiValue + ], }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "server_name": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiValue - ], + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiStruct # Represents a structured value. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiStruct # Represents a structured value. }, + ], + }, + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "is_error": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. }, ], }, }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "is_error": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], + "video": { # A video content block. + "data": "A String", # The video content. + "mime_type": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. }, }, - "video": { # A video content block. - "data": "A String", # The video content. - "mime_type": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - ], + ], + }, + "contentString": "A String", # The content of the step. A single string. }, }, ], @@ -25282,6 +25412,8 @@

Method Details

], }, "created": "A String", # Required. Output only. The time at which the response was created in ISO 8601 format (YYYY-MM-DDThh:mm:ssZ). + "env_id": "A String", # The environment ID for the interaction. Can be 'remote' for default environment. + "environment_id": "A String", # Output only. The environment ID for the interaction. Only populated if environment config is set in the request. "id": "A String", # Required. Output only. A unique identifier for the interaction completion. "modelInteraction": { # Interaction for generating the completion using models. # Interaction for generating the completion using models. "generation_config": { # Configuration parameters for model interactions. # Input only. Configuration parameters for the model interaction. @@ -25766,6 +25898,28 @@

Method Details

}, ], "previous_interaction_id": "A String", # The ID of the previous interaction, if any. + "remoteEnvironment": { # Configuration for a custom environment. + "networkAllowlist": { # Network egress configuration for the environment. # Allow only specific domains. + "allowlist": [ # List of allowed domains and their configurations. + { # A network egress rule that controls which external domains the environment is allowed to reach. Each rule identifies a target domain and, optionally, a set of HTTP headers to inject into every matching outbound request. + "domain": "A String", # The domain pattern to match for this rule. Use an exact hostname (e.g., `github.com`), a wildcard prefix (e.g., `*.googleapis.com`), or `*` to match all domains. + "transform": { # Headers to inject into requests matching this rule. Key: header name (e.g., "Authorization"). Value: header value (e.g., "Bearer your-token"). + "a_key": "A String", + }, + }, + ], + }, + "networkMode": "A String", # Network egress mode. + "sources": [ + { # A source to be mounted into the environment. + "content": "A String", # The inline content if `type` is `INLINE`. + "encoding": "A String", # Optional encoding for inline content (e.g. `base64`). + "source": "A String", # The source of the environment. For GCS, this is the GCS path. For GitHub, this is the GitHub path. + "target": "A String", # Where the source should appear in the environment. + "type": "A String", + }, + ], + }, "responseFormatList": { "response_formats": [ { @@ -25822,8 +25976,6 @@

Method Details

], }, }, - "video": { # Configuration for video output format. - }, }, ], }, @@ -25881,8 +26033,6 @@

Method Details

], }, }, - "video": { # Configuration for video output format. - }, }, "response_format": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. # Enforces that the generated response is a JSON object that complies with the JSON schema specified in this field. "boolValue": True or False, # Represents a boolean value. @@ -26721,118 +26871,325 @@

Method Details

}, }, "userInput": { # Input provided by the user. - "content": [ - { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mime_type": "A String", # The mime type of the audio. - "sample_rate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mime_type": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mime_type": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "end_index": 42, # End of the attributed segment, exclusive. - "file_citation": { # A file citation annotation. # A file citation annotation. - "custom_metadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiValue + "contentList": { # A list of Content. # The content of the step. An array of Content objects. + "contents": [ # The contents of the list. + { # The content of the response. + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mime_type": "A String", # The mime type of the audio. + "sample_rate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mime_type": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mime_type": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "end_index": 42, # End of the attributed segment, exclusive. + "file_citation": { # A file citation annotation. # A file citation annotation. + "custom_metadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiValue + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiStruct # Represents a structured value. + }, + }, + ], + }, + "document_uri": "A String", # The URI of the file. + "file_name": "A String", # The name of the file. + "media_id": "A String", # Media ID in-case of image citations, if applicable. + "page_number": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "place_citation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "place_id": "A String", # The ID of the place, in `places/{place_id}` format. + "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "review_id": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "start_index": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "url_citation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mime_type": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "end_index": 42, # End of the attributed segment, exclusive. + "file_citation": { # A file citation annotation. # A file citation annotation. + "custom_metadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiValue + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiStruct # Represents a structured value. + }, + }, ], }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiStruct # Represents a structured value. + "document_uri": "A String", # The URI of the file. + "file_name": "A String", # The name of the file. + "media_id": "A String", # Media ID in-case of image citations, if applicable. + "page_number": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "place_citation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "place_id": "A String", # The ID of the place, in `places/{place_id}` format. + "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "review_id": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "start_index": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "url_citation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, }, ], + "text": "A String", # Required. The text content. }, - "document_uri": "A String", # The URI of the file. - "file_name": "A String", # The name of the file. - "media_id": "A String", # Media ID in-case of image citations, if applicable. - "page_number": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. }, - "place_citation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "place_id": "A String", # The ID of the place, in `places/{place_id}` format. - "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "review_id": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiValue + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiStruct # Represents a structured value. + }, }, ], - "url": "A String", # URI reference of the place. }, - "start_index": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "url_citation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], }, }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mime_type": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "end_index": 42, # End of the attributed segment, exclusive. - "file_citation": { # A file citation annotation. # A file citation annotation. - "custom_metadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiValue - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiStruct # Represents a structured value. + "search_type": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiValue + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiStruct # Represents a structured value. + }, + }, + ], + }, + "name": "A String", # Required. The name of the tool which was called. + "server_name": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "call_id": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "is_error": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mime_type": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "end_index": 42, # End of the attributed segment, exclusive. + "file_citation": { # A file citation annotation. # A file citation annotation. + "custom_metadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiValue + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiStruct # Represents a structured value. + }, + }, + ], }, + "document_uri": "A String", # The URI of the file. + "file_name": "A String", # The name of the file. + "media_id": "A String", # Media ID in-case of image citations, if applicable. + "page_number": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "place_citation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "place_id": "A String", # The ID of the place, in `places/{place_id}` format. + "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "review_id": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "start_index": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "url_citation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "is_error": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiValue ], }, - "document_uri": "A String", # The URI of the file. - "file_name": "A String", # The name of the file. - "media_id": "A String", # Media ID in-case of image citations, if applicable. - "page_number": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiStruct # Represents a structured value. }, - "place_citation": { # A place citation annotation. # A place citation annotation. + }, + ], + }, + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { "name": "A String", # Title of the place. "place_id": "A String", # The ID of the place, in `places/{place_id}` format. "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. @@ -26844,336 +27201,132 @@

Method Details

], "url": "A String", # URI reference of the place. }, - "start_index": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "url_citation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiValue - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiStruct # Represents a structured value. - }, + ], + "widget_context_token": "A String", # Resource name of the Google Maps widget context token. }, ], }, - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "search_type": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiValue - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiStruct # Represents a structured value. - }, + "googleSearchResult": { # Google Search result content. + "is_error": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "search_suggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. }, ], }, - "name": "A String", # Required. The name of the tool which was called. - "server_name": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, - }, - "toolResult": { # Tool result content. - "call_id": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "is_error": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mime_type": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "end_index": 42, # End of the attributed segment, exclusive. - "file_citation": { # A file citation annotation. # A file citation annotation. - "custom_metadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiValue - ], + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mime_type": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "end_index": 42, # End of the attributed segment, exclusive. + "file_citation": { # A file citation annotation. # A file citation annotation. + "custom_metadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiValue + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiStruct # Represents a structured value. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiStruct # Represents a structured value. }, + ], + }, + "document_uri": "A String", # The URI of the file. + "file_name": "A String", # The name of the file. + "media_id": "A String", # Media ID in-case of image citations, if applicable. + "page_number": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "place_citation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "place_id": "A String", # The ID of the place, in `places/{place_id}` format. + "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "review_id": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, ], + "url": "A String", # URI reference of the place. + }, + "start_index": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "url_citation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, - "document_uri": "A String", # The URI of the file. - "file_name": "A String", # The name of the file. - "media_id": "A String", # Media ID in-case of image citations, if applicable. - "page_number": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "place_citation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "place_id": "A String", # The ID of the place, in `places/{place_id}` format. - "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "review_id": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "start_index": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "url_citation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "is_error": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiValue ], + "text": "A String", # Required. The text content. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiStruct # Represents a structured value. }, - }, - ], - }, - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "place_id": "A String", # The ID of the place, in `places/{place_id}` format. - "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "review_id": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "server_name": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiValue + ], }, - ], - "url": "A String", # URI reference of the place. + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiStruct # Represents a structured value. + }, }, ], - "widget_context_token": "A String", # Resource name of the Google Maps widget context token. }, - ], + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "is_error": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, }, - "googleSearchResult": { # Google Search result content. - "is_error": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "search_suggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mime_type": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "end_index": 42, # End of the attributed segment, exclusive. - "file_citation": { # A file citation annotation. # A file citation annotation. - "custom_metadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiValue - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiStruct # Represents a structured value. - }, - }, - ], - }, - "document_uri": "A String", # The URI of the file. - "file_name": "A String", # The name of the file. - "media_id": "A String", # Media ID in-case of image citations, if applicable. - "page_number": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "place_citation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "place_id": "A String", # The ID of the place, in `places/{place_id}` format. - "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "review_id": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "start_index": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "url_citation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "server_name": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiValue - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiStruct # Represents a structured value. - }, - }, - ], - }, - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "is_error": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], + "video": { # A video content block. + "data": "A String", # The video content. + "mime_type": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. }, }, - "video": { # A video content block. - "data": "A String", # The video content. - "mime_type": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - ], + ], + }, + "contentString": "A String", # The content of the step. A single string. }, }, ], }, - "steps": [ # Output only. The steps that make up the interaction. + "steps": [ # Required. Output only. The steps that make up the interaction. { # A step in the interaction. "modelOutput": { # Output generated by the model. "content": [ @@ -27991,118 +28144,325 @@

Method Details

}, }, "userInput": { # Input provided by the user. - "content": [ - { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mime_type": "A String", # The mime type of the audio. - "sample_rate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mime_type": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mime_type": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "end_index": 42, # End of the attributed segment, exclusive. - "file_citation": { # A file citation annotation. # A file citation annotation. - "custom_metadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiValue + "contentList": { # A list of Content. # The content of the step. An array of Content objects. + "contents": [ # The contents of the list. + { # The content of the response. + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mime_type": "A String", # The mime type of the audio. + "sample_rate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mime_type": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mime_type": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "end_index": 42, # End of the attributed segment, exclusive. + "file_citation": { # A file citation annotation. # A file citation annotation. + "custom_metadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiValue + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiStruct # Represents a structured value. + }, + }, + ], + }, + "document_uri": "A String", # The URI of the file. + "file_name": "A String", # The name of the file. + "media_id": "A String", # Media ID in-case of image citations, if applicable. + "page_number": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "place_citation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "place_id": "A String", # The ID of the place, in `places/{place_id}` format. + "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "review_id": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "start_index": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "url_citation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mime_type": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "end_index": 42, # End of the attributed segment, exclusive. + "file_citation": { # A file citation annotation. # A file citation annotation. + "custom_metadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiValue + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiStruct # Represents a structured value. + }, + }, ], }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiStruct # Represents a structured value. + "document_uri": "A String", # The URI of the file. + "file_name": "A String", # The name of the file. + "media_id": "A String", # Media ID in-case of image citations, if applicable. + "page_number": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "place_citation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "place_id": "A String", # The ID of the place, in `places/{place_id}` format. + "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "review_id": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "start_index": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "url_citation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, }, ], + "text": "A String", # Required. The text content. }, - "document_uri": "A String", # The URI of the file. - "file_name": "A String", # The name of the file. - "media_id": "A String", # Media ID in-case of image citations, if applicable. - "page_number": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. }, - "place_citation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "place_id": "A String", # The ID of the place, in `places/{place_id}` format. - "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "review_id": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiValue + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiStruct # Represents a structured value. + }, }, ], - "url": "A String", # URI reference of the place. }, - "start_index": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "url_citation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], }, }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mime_type": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "end_index": 42, # End of the attributed segment, exclusive. - "file_citation": { # A file citation annotation. # A file citation annotation. - "custom_metadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiValue - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiStruct # Represents a structured value. + "search_type": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiValue + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiStruct # Represents a structured value. + }, + }, + ], + }, + "name": "A String", # Required. The name of the tool which was called. + "server_name": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "call_id": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "is_error": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mime_type": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "end_index": 42, # End of the attributed segment, exclusive. + "file_citation": { # A file citation annotation. # A file citation annotation. + "custom_metadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiValue + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiStruct # Represents a structured value. + }, + }, + ], }, + "document_uri": "A String", # The URI of the file. + "file_name": "A String", # The name of the file. + "media_id": "A String", # Media ID in-case of image citations, if applicable. + "page_number": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "place_citation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "place_id": "A String", # The ID of the place, in `places/{place_id}` format. + "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "review_id": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "start_index": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "url_citation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "is_error": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiValue ], }, - "document_uri": "A String", # The URI of the file. - "file_name": "A String", # The name of the file. - "media_id": "A String", # Media ID in-case of image citations, if applicable. - "page_number": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiStruct # Represents a structured value. }, - "place_citation": { # A place citation annotation. # A place citation annotation. + }, + ], + }, + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { "name": "A String", # Title of the place. "place_id": "A String", # The ID of the place, in `places/{place_id}` format. "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. @@ -28114,331 +28474,127 @@

Method Details

], "url": "A String", # URI reference of the place. }, - "start_index": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "url_citation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiValue - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiStruct # Represents a structured value. - }, + ], + "widget_context_token": "A String", # Resource name of the Google Maps widget context token. }, ], }, - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "search_type": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiValue - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiStruct # Represents a structured value. - }, + "googleSearchResult": { # Google Search result content. + "is_error": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "search_suggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. }, ], }, - "name": "A String", # Required. The name of the tool which was called. - "server_name": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, - }, - "toolResult": { # Tool result content. - "call_id": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "is_error": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mime_type": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "end_index": 42, # End of the attributed segment, exclusive. - "file_citation": { # A file citation annotation. # A file citation annotation. - "custom_metadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiValue - ], + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mime_type": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "end_index": 42, # End of the attributed segment, exclusive. + "file_citation": { # A file citation annotation. # A file citation annotation. + "custom_metadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiValue + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiStruct # Represents a structured value. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiStruct # Represents a structured value. }, + ], + }, + "document_uri": "A String", # The URI of the file. + "file_name": "A String", # The name of the file. + "media_id": "A String", # Media ID in-case of image citations, if applicable. + "page_number": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "place_citation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "place_id": "A String", # The ID of the place, in `places/{place_id}` format. + "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "review_id": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, ], + "url": "A String", # URI reference of the place. + }, + "start_index": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "url_citation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, - "document_uri": "A String", # The URI of the file. - "file_name": "A String", # The name of the file. - "media_id": "A String", # Media ID in-case of image citations, if applicable. - "page_number": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "place_citation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "place_id": "A String", # The ID of the place, in `places/{place_id}` format. - "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "review_id": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "start_index": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "url_citation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "is_error": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiValue ], + "text": "A String", # Required. The text content. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiStruct # Represents a structured value. - }, - }, - ], - }, - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "place_id": "A String", # The ID of the place, in `places/{place_id}` format. - "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "review_id": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. }, ], - "widget_context_token": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "is_error": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "search_suggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mime_type": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "end_index": 42, # End of the attributed segment, exclusive. - "file_citation": { # A file citation annotation. # A file citation annotation. - "custom_metadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiValue - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiStruct # Represents a structured value. - }, - }, - ], - }, - "document_uri": "A String", # The URI of the file. - "file_name": "A String", # The name of the file. - "media_id": "A String", # Media ID in-case of image citations, if applicable. - "page_number": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "place_citation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "place_id": "A String", # The ID of the place, in `places/{place_id}` format. - "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "review_id": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "start_index": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "url_citation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "server_name": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiValue + ], }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "server_name": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiValue - ], + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiStruct # Represents a structured value. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiStruct # Represents a structured value. }, + ], + }, + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "is_error": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. }, ], }, }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "is_error": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], + "video": { # A video content block. + "data": "A String", # The video content. + "mime_type": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. }, }, - "video": { # A video content block. - "data": "A String", # The video content. - "mime_type": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - ], + ], + }, + "contentString": "A String", # The content of the step. A single string. }, }, ], @@ -29944,6 +30100,8 @@

Method Details

], }, "created": "A String", # Required. Output only. The time at which the response was created in ISO 8601 format (YYYY-MM-DDThh:mm:ssZ). + "env_id": "A String", # The environment ID for the interaction. Can be 'remote' for default environment. + "environment_id": "A String", # Output only. The environment ID for the interaction. Only populated if environment config is set in the request. "id": "A String", # Required. Output only. A unique identifier for the interaction completion. "modelInteraction": { # Interaction for generating the completion using models. # Interaction for generating the completion using models. "generation_config": { # Configuration parameters for model interactions. # Input only. Configuration parameters for the model interaction. @@ -30428,6 +30586,28 @@

Method Details

}, ], "previous_interaction_id": "A String", # The ID of the previous interaction, if any. + "remoteEnvironment": { # Configuration for a custom environment. + "networkAllowlist": { # Network egress configuration for the environment. # Allow only specific domains. + "allowlist": [ # List of allowed domains and their configurations. + { # A network egress rule that controls which external domains the environment is allowed to reach. Each rule identifies a target domain and, optionally, a set of HTTP headers to inject into every matching outbound request. + "domain": "A String", # The domain pattern to match for this rule. Use an exact hostname (e.g., `github.com`), a wildcard prefix (e.g., `*.googleapis.com`), or `*` to match all domains. + "transform": { # Headers to inject into requests matching this rule. Key: header name (e.g., "Authorization"). Value: header value (e.g., "Bearer your-token"). + "a_key": "A String", + }, + }, + ], + }, + "networkMode": "A String", # Network egress mode. + "sources": [ + { # A source to be mounted into the environment. + "content": "A String", # The inline content if `type` is `INLINE`. + "encoding": "A String", # Optional encoding for inline content (e.g. `base64`). + "source": "A String", # The source of the environment. For GCS, this is the GCS path. For GitHub, this is the GitHub path. + "target": "A String", # Where the source should appear in the environment. + "type": "A String", + }, + ], + }, "responseFormatList": { "response_formats": [ { @@ -30484,8 +30664,6 @@

Method Details

], }, }, - "video": { # Configuration for video output format. - }, }, ], }, @@ -30543,8 +30721,6 @@

Method Details

], }, }, - "video": { # Configuration for video output format. - }, }, "response_format": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. # Enforces that the generated response is a JSON object that complies with the JSON schema specified in this field. "boolValue": True or False, # Represents a boolean value. @@ -31383,118 +31559,325 @@

Method Details

}, }, "userInput": { # Input provided by the user. - "content": [ - { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mime_type": "A String", # The mime type of the audio. - "sample_rate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mime_type": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mime_type": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "end_index": 42, # End of the attributed segment, exclusive. - "file_citation": { # A file citation annotation. # A file citation annotation. - "custom_metadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiValue + "contentList": { # A list of Content. # The content of the step. An array of Content objects. + "contents": [ # The contents of the list. + { # The content of the response. + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mime_type": "A String", # The mime type of the audio. + "sample_rate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mime_type": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mime_type": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "end_index": 42, # End of the attributed segment, exclusive. + "file_citation": { # A file citation annotation. # A file citation annotation. + "custom_metadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiValue + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiStruct # Represents a structured value. + }, + }, + ], + }, + "document_uri": "A String", # The URI of the file. + "file_name": "A String", # The name of the file. + "media_id": "A String", # Media ID in-case of image citations, if applicable. + "page_number": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "place_citation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "place_id": "A String", # The ID of the place, in `places/{place_id}` format. + "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "review_id": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "start_index": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "url_citation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mime_type": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "end_index": 42, # End of the attributed segment, exclusive. + "file_citation": { # A file citation annotation. # A file citation annotation. + "custom_metadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiValue + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiStruct # Represents a structured value. + }, + }, ], }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiStruct # Represents a structured value. + "document_uri": "A String", # The URI of the file. + "file_name": "A String", # The name of the file. + "media_id": "A String", # Media ID in-case of image citations, if applicable. + "page_number": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "place_citation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "place_id": "A String", # The ID of the place, in `places/{place_id}` format. + "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "review_id": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "start_index": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "url_citation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, }, ], + "text": "A String", # Required. The text content. }, - "document_uri": "A String", # The URI of the file. - "file_name": "A String", # The name of the file. - "media_id": "A String", # Media ID in-case of image citations, if applicable. - "page_number": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. }, - "place_citation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "place_id": "A String", # The ID of the place, in `places/{place_id}` format. - "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "review_id": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiValue + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiStruct # Represents a structured value. + }, }, ], - "url": "A String", # URI reference of the place. }, - "start_index": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "url_citation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], }, }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mime_type": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "end_index": 42, # End of the attributed segment, exclusive. - "file_citation": { # A file citation annotation. # A file citation annotation. - "custom_metadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiValue - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiStruct # Represents a structured value. + "search_type": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiValue + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiStruct # Represents a structured value. + }, + }, + ], + }, + "name": "A String", # Required. The name of the tool which was called. + "server_name": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "call_id": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "is_error": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mime_type": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "end_index": 42, # End of the attributed segment, exclusive. + "file_citation": { # A file citation annotation. # A file citation annotation. + "custom_metadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiValue + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiStruct # Represents a structured value. + }, + }, + ], }, + "document_uri": "A String", # The URI of the file. + "file_name": "A String", # The name of the file. + "media_id": "A String", # Media ID in-case of image citations, if applicable. + "page_number": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "place_citation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "place_id": "A String", # The ID of the place, in `places/{place_id}` format. + "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "review_id": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "start_index": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "url_citation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "is_error": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiValue ], }, - "document_uri": "A String", # The URI of the file. - "file_name": "A String", # The name of the file. - "media_id": "A String", # Media ID in-case of image citations, if applicable. - "page_number": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiStruct # Represents a structured value. }, - "place_citation": { # A place citation annotation. # A place citation annotation. + }, + ], + }, + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { "name": "A String", # Title of the place. "place_id": "A String", # The ID of the place, in `places/{place_id}` format. "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. @@ -31506,336 +31889,132 @@

Method Details

], "url": "A String", # URI reference of the place. }, - "start_index": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "url_citation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiValue - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiStruct # Represents a structured value. - }, + ], + "widget_context_token": "A String", # Resource name of the Google Maps widget context token. }, ], }, - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "search_type": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiValue - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiStruct # Represents a structured value. - }, + "googleSearchResult": { # Google Search result content. + "is_error": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "search_suggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. }, ], }, - "name": "A String", # Required. The name of the tool which was called. - "server_name": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, - }, - "toolResult": { # Tool result content. - "call_id": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "is_error": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mime_type": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "end_index": 42, # End of the attributed segment, exclusive. - "file_citation": { # A file citation annotation. # A file citation annotation. - "custom_metadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiValue - ], + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mime_type": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "end_index": 42, # End of the attributed segment, exclusive. + "file_citation": { # A file citation annotation. # A file citation annotation. + "custom_metadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiValue + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiStruct # Represents a structured value. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiStruct # Represents a structured value. }, + ], + }, + "document_uri": "A String", # The URI of the file. + "file_name": "A String", # The name of the file. + "media_id": "A String", # Media ID in-case of image citations, if applicable. + "page_number": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "place_citation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "place_id": "A String", # The ID of the place, in `places/{place_id}` format. + "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "review_id": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, ], + "url": "A String", # URI reference of the place. + }, + "start_index": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "url_citation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, - "document_uri": "A String", # The URI of the file. - "file_name": "A String", # The name of the file. - "media_id": "A String", # Media ID in-case of image citations, if applicable. - "page_number": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "place_citation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "place_id": "A String", # The ID of the place, in `places/{place_id}` format. - "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "review_id": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "start_index": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "url_citation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "is_error": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiValue ], + "text": "A String", # Required. The text content. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiStruct # Represents a structured value. }, - }, - ], - }, - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "place_id": "A String", # The ID of the place, in `places/{place_id}` format. - "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "review_id": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "server_name": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiValue + ], }, - ], - "url": "A String", # URI reference of the place. + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiStruct # Represents a structured value. + }, }, ], - "widget_context_token": "A String", # Resource name of the Google Maps widget context token. }, - ], + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "is_error": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, }, - "googleSearchResult": { # Google Search result content. - "is_error": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "search_suggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mime_type": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "end_index": 42, # End of the attributed segment, exclusive. - "file_citation": { # A file citation annotation. # A file citation annotation. - "custom_metadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiValue - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiStruct # Represents a structured value. - }, - }, - ], - }, - "document_uri": "A String", # The URI of the file. - "file_name": "A String", # The name of the file. - "media_id": "A String", # Media ID in-case of image citations, if applicable. - "page_number": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "place_citation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "place_id": "A String", # The ID of the place, in `places/{place_id}` format. - "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "review_id": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "start_index": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "url_citation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "server_name": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiValue - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiStruct # Represents a structured value. - }, - }, - ], - }, - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "is_error": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], + "video": { # A video content block. + "data": "A String", # The video content. + "mime_type": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. }, }, - "video": { # A video content block. - "data": "A String", # The video content. - "mime_type": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - ], + ], + }, + "contentString": "A String", # The content of the step. A single string. }, }, ], }, - "steps": [ # Output only. The steps that make up the interaction. + "steps": [ # Required. Output only. The steps that make up the interaction. { # A step in the interaction. "modelOutput": { # Output generated by the model. "content": [ @@ -32653,454 +32832,457 @@

Method Details

}, }, "userInput": { # Input provided by the user. - "content": [ - { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mime_type": "A String", # The mime type of the audio. - "sample_rate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mime_type": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mime_type": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "end_index": 42, # End of the attributed segment, exclusive. - "file_citation": { # A file citation annotation. # A file citation annotation. - "custom_metadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiValue - ], + "contentList": { # A list of Content. # The content of the step. An array of Content objects. + "contents": [ # The contents of the list. + { # The content of the response. + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mime_type": "A String", # The mime type of the audio. + "sample_rate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mime_type": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mime_type": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "end_index": 42, # End of the attributed segment, exclusive. + "file_citation": { # A file citation annotation. # A file citation annotation. + "custom_metadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiValue + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiStruct # Represents a structured value. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiStruct # Represents a structured value. }, + ], + }, + "document_uri": "A String", # The URI of the file. + "file_name": "A String", # The name of the file. + "media_id": "A String", # Media ID in-case of image citations, if applicable. + "page_number": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "place_citation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "place_id": "A String", # The ID of the place, in `places/{place_id}` format. + "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "review_id": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, ], + "url": "A String", # URI reference of the place. + }, + "start_index": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "url_citation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, - "document_uri": "A String", # The URI of the file. - "file_name": "A String", # The name of the file. - "media_id": "A String", # Media ID in-case of image citations, if applicable. - "page_number": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "place_citation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "place_id": "A String", # The ID of the place, in `places/{place_id}` format. - "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "review_id": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "start_index": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "url_citation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mime_type": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "end_index": 42, # End of the attributed segment, exclusive. - "file_citation": { # A file citation annotation. # A file citation annotation. - "custom_metadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiValue - ], + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mime_type": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "end_index": 42, # End of the attributed segment, exclusive. + "file_citation": { # A file citation annotation. # A file citation annotation. + "custom_metadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiValue + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiStruct # Represents a structured value. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiStruct # Represents a structured value. }, + ], + }, + "document_uri": "A String", # The URI of the file. + "file_name": "A String", # The name of the file. + "media_id": "A String", # Media ID in-case of image citations, if applicable. + "page_number": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "place_citation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "place_id": "A String", # The ID of the place, in `places/{place_id}` format. + "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "review_id": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, ], + "url": "A String", # URI reference of the place. + }, + "start_index": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "url_citation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, - "document_uri": "A String", # The URI of the file. - "file_name": "A String", # The name of the file. - "media_id": "A String", # Media ID in-case of image citations, if applicable. - "page_number": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "place_citation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "place_id": "A String", # The ID of the place, in `places/{place_id}` format. - "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "review_id": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "start_index": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "url_citation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. }, - }, - ], - "text": "A String", # Required. The text content. + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. }, }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. + "fileSearchCall": { # File Search content. }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiValue - ], + "functionCall": { # A function tool call content block. + "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiValue + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiStruct # Represents a structured value. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiStruct # Represents a structured value. }, - }, - ], + ], + }, + "name": "A String", # Required. The name of the tool to call. }, - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "search_type": "A String", # The type of search grounding enabled. }, - "search_type": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiValue - ], + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiValue + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiStruct # Represents a structured value. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiStruct # Represents a structured value. }, - }, - ], - }, - "name": "A String", # Required. The name of the tool which was called. - "server_name": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], + ], + }, + "name": "A String", # Required. The name of the tool which was called. + "server_name": "A String", # Required. The name of the used MCP server. }, - }, - }, - "toolResult": { # Tool result content. - "call_id": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "is_error": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], }, - ], + }, }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mime_type": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "end_index": 42, # End of the attributed segment, exclusive. - "file_citation": { # A file citation annotation. # A file citation annotation. - "custom_metadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiValue - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiStruct # Represents a structured value. - }, - }, - ], - }, - "document_uri": "A String", # The URI of the file. - "file_name": "A String", # The name of the file. - "media_id": "A String", # Media ID in-case of image citations, if applicable. - "page_number": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "place_citation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "place_id": "A String", # The ID of the place, in `places/{place_id}` format. - "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "review_id": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "start_index": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "url_citation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], + "toolResult": { # Tool result content. + "call_id": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "is_error": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. }, - "is_error": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiValue - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiStruct # Represents a structured value. - }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. }, ], }, - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ { - "name": "A String", # Title of the place. - "place_id": "A String", # The ID of the place, in `places/{place_id}` format. - "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "review_id": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - ], - "widget_context_token": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "is_error": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "search_suggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mime_type": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "end_index": 42, # End of the attributed segment, exclusive. - "file_citation": { # A file citation annotation. # A file citation annotation. - "custom_metadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiValue - ], + "image": { # An image content block. + "data": "A String", # The image content. + "mime_type": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "end_index": 42, # End of the attributed segment, exclusive. + "file_citation": { # A file citation annotation. # A file citation annotation. + "custom_metadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiValue + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiStruct # Represents a structured value. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiStruct # Represents a structured value. }, - }, - ], - }, - "document_uri": "A String", # The URI of the file. - "file_name": "A String", # The name of the file. - "media_id": "A String", # Media ID in-case of image citations, if applicable. - "page_number": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "place_citation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "place_id": "A String", # The ID of the place, in `places/{place_id}` format. - "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "review_id": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. + ], }, - ], - "url": "A String", # URI reference of the place. - }, - "start_index": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "url_citation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. + "document_uri": "A String", # The URI of the file. + "file_name": "A String", # The name of the file. + "media_id": "A String", # Media ID in-case of image citations, if applicable. + "page_number": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "place_citation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "place_id": "A String", # The ID of the place, in `places/{place_id}` format. + "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "review_id": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "start_index": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "url_citation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "is_error": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiValue + ], }, - ], - "text": "A String", # Required. The text content. + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiStruct # Represents a structured value. + }, }, + ], + }, + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "place_id": "A String", # The ID of the place, in `places/{place_id}` format. + "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "review_id": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widget_context_token": "A String", # Resource name of the Google Maps widget context token. }, ], }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "server_name": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiValue + "googleSearchResult": { # Google Search result content. + "is_error": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "search_suggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mime_type": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "end_index": 42, # End of the attributed segment, exclusive. + "file_citation": { # A file citation annotation. # A file citation annotation. + "custom_metadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiValue + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiStruct # Represents a structured value. + }, + }, + ], + }, + "document_uri": "A String", # The URI of the file. + "file_name": "A String", # The name of the file. + "media_id": "A String", # Media ID in-case of image citations, if applicable. + "page_number": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "place_citation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "place_id": "A String", # The ID of the place, in `places/{place_id}` format. + "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "review_id": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "start_index": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "url_citation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "server_name": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiValue + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiStruct # Represents a structured value. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiStruct # Represents a structured value. }, + ], + }, + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "is_error": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. }, ], }, }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "is_error": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], + "video": { # A video content block. + "data": "A String", # The video content. + "mime_type": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. }, }, - "video": { # A video content block. - "data": "A String", # The video content. - "mime_type": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - ], + ], + }, + "contentString": "A String", # The content of the step. A single string. }, }, ], @@ -33682,10 +33864,50 @@

Method Details

"interaction_id": "A String", "status": "A String", }, + "metadata": { # Optional metadata accompanying ANY streamed event. + "usage": { # Statistics on the interaction request's token usage. + "cached_tokens_by_modality": [ # A breakdown of cached token usage by modality. + { # The token count for a single response modality. + "modality": "A String", # The modality associated with the token count. + "tokens": 42, # Number of tokens for the modality. + }, + ], + "grounding_tool_count": [ # Grounding tool count. + { # The number of grounding tool counts. + "count": 42, # The number of grounding tool counts. + "type": "A String", # The grounding tool type associated with the count. + }, + ], + "input_tokens_by_modality": [ # A breakdown of input token usage by modality. + { # The token count for a single response modality. + "modality": "A String", # The modality associated with the token count. + "tokens": 42, # Number of tokens for the modality. + }, + ], + "output_tokens_by_modality": [ # A breakdown of output token usage by modality. + { # The token count for a single response modality. + "modality": "A String", # The modality associated with the token count. + "tokens": 42, # Number of tokens for the modality. + }, + ], + "tool_use_tokens_by_modality": [ # A breakdown of tool-use token usage by modality. + { # The token count for a single response modality. + "modality": "A String", # The modality associated with the token count. + "tokens": 42, # Number of tokens for the modality. + }, + ], + "total_cached_tokens": 42, # Number of tokens in the cached part of the prompt (the cached content). + "total_input_tokens": 42, # Number of tokens in the prompt (context). + "total_output_tokens": 42, # Total number of tokens across all the generated responses. + "total_thought_tokens": 42, # Number of tokens of thoughts for thinking models. + "total_tokens": 42, # Total token count for the interaction request (prompt + responses + other internal tokens). + "total_tool_use_tokens": 42, # Number of tokens present in tool-use prompt(s). + }, + }, "stepDelta": { # The step delta data, used for step.delta events. "delta": { "argumentsDelta": { - "partial_arguments": "A String", + "arguments": "A String", }, "audio": { "channels": 42, # The number of audio channels. @@ -33700,12 +33922,292 @@

Method Details

"mime_type": "A String", "uri": "A String", }, + "functionResult": { + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mime_type": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "end_index": 42, # End of the attributed segment, exclusive. + "file_citation": { # A file citation annotation. # A file citation annotation. + "custom_metadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiValue + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiStruct # Represents a structured value. + }, + }, + ], + }, + "document_uri": "A String", # The URI of the file. + "file_name": "A String", # The name of the file. + "media_id": "A String", # Media ID in-case of image citations, if applicable. + "page_number": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "place_citation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "place_id": "A String", # The ID of the place, in `places/{place_id}` format. + "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "review_id": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "start_index": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "url_citation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "is_error": True or False, + "name": "A String", + "stringResult": "A String", + "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiValue + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiStruct # Represents a structured value. + }, + }, + ], + }, + }, "image": { "data": "A String", "mime_type": "A String", "resolution": "A String", # The resolution of the media. "uri": "A String", }, + "serverToolCall": { + "codeExecutionCall": { + "arguments": { # The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { + }, + "googleMapsCall": { + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { + "arguments": { # The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + }, + "mcpServerToolCall": { + "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiValue + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiStruct # Represents a structured value. + }, + }, + ], + }, + "name": "A String", + "server_name": "A String", + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { + "arguments": { # The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "serverToolResult": { + "codeExecutionResult": { + "is_error": True or False, + "result": "A String", + }, + "fileSearchResult": { + "result": [ + { # The result of the File Search. + }, + ], + }, + "googleMapsResult": { + "result": [ # The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "place_id": "A String", # The ID of the place, in `places/{place_id}` format. + "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "review_id": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widget_context_token": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { + "is_error": True or False, + "result": [ + { # The result of the Google Search. + "search_suggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mime_type": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "end_index": 42, # End of the attributed segment, exclusive. + "file_citation": { # A file citation annotation. # A file citation annotation. + "custom_metadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiValue + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiStruct # Represents a structured value. + }, + }, + ], + }, + "document_uri": "A String", # The URI of the file. + "file_name": "A String", # The name of the file. + "media_id": "A String", # Media ID in-case of image citations, if applicable. + "page_number": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "place_citation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "place_id": "A String", # The ID of the place, in `places/{place_id}` format. + "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "review_id": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "start_index": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "url_citation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "name": "A String", + "server_name": "A String", + "stringResult": "A String", + "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiValue + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiStruct # Represents a structured value. + }, + }, + ], + }, + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { + "is_error": True or False, + "result": [ + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, + }, "text": { "text": "A String", }, @@ -34651,118 +35153,325 @@

Method Details

}, }, "userInput": { # Input provided by the user. - "content": [ - { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mime_type": "A String", # The mime type of the audio. - "sample_rate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mime_type": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mime_type": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "end_index": 42, # End of the attributed segment, exclusive. - "file_citation": { # A file citation annotation. # A file citation annotation. - "custom_metadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiValue + "contentList": { # A list of Content. # The content of the step. An array of Content objects. + "contents": [ # The contents of the list. + { # The content of the response. + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mime_type": "A String", # The mime type of the audio. + "sample_rate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mime_type": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mime_type": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "end_index": 42, # End of the attributed segment, exclusive. + "file_citation": { # A file citation annotation. # A file citation annotation. + "custom_metadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiValue + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiStruct # Represents a structured value. + }, + }, + ], + }, + "document_uri": "A String", # The URI of the file. + "file_name": "A String", # The name of the file. + "media_id": "A String", # Media ID in-case of image citations, if applicable. + "page_number": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "place_citation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "place_id": "A String", # The ID of the place, in `places/{place_id}` format. + "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "review_id": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "start_index": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "url_citation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mime_type": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "end_index": 42, # End of the attributed segment, exclusive. + "file_citation": { # A file citation annotation. # A file citation annotation. + "custom_metadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiValue + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiStruct # Represents a structured value. + }, + }, ], }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiStruct # Represents a structured value. - }, + "document_uri": "A String", # The URI of the file. + "file_name": "A String", # The name of the file. + "media_id": "A String", # Media ID in-case of image citations, if applicable. + "page_number": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "place_citation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "place_id": "A String", # The ID of the place, in `places/{place_id}` format. + "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "review_id": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "start_index": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "url_citation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiValue + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiStruct # Represents a structured value. + }, + }, + ], + }, + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "search_type": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiValue + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiStruct # Represents a structured value. + }, + }, + ], + }, + "name": "A String", # Required. The name of the tool which was called. + "server_name": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "call_id": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "is_error": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mime_type": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "end_index": 42, # End of the attributed segment, exclusive. + "file_citation": { # A file citation annotation. # A file citation annotation. + "custom_metadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiValue + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiStruct # Represents a structured value. + }, + }, + ], + }, + "document_uri": "A String", # The URI of the file. + "file_name": "A String", # The name of the file. + "media_id": "A String", # Media ID in-case of image citations, if applicable. + "page_number": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "place_citation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "place_id": "A String", # The ID of the place, in `places/{place_id}` format. + "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "review_id": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "start_index": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "url_citation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. }, - ], - }, - "document_uri": "A String", # The URI of the file. - "file_name": "A String", # The name of the file. - "media_id": "A String", # Media ID in-case of image citations, if applicable. - "page_number": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "place_citation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "place_id": "A String", # The ID of the place, in `places/{place_id}` format. - "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "review_id": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. }, ], - "url": "A String", # URI reference of the place. - }, - "start_index": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "url_citation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mime_type": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "end_index": 42, # End of the attributed segment, exclusive. - "file_citation": { # A file citation annotation. # A file citation annotation. - "custom_metadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiValue - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiStruct # Represents a structured value. - }, - }, + "is_error": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiValue ], }, - "document_uri": "A String", # The URI of the file. - "file_name": "A String", # The name of the file. - "media_id": "A String", # Media ID in-case of image citations, if applicable. - "page_number": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiStruct # Represents a structured value. }, - "place_citation": { # A place citation annotation. # A place citation annotation. + }, + ], + }, + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { "name": "A String", # Title of the place. "place_id": "A String", # The ID of the place, in `places/{place_id}` format. "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. @@ -34774,331 +35483,127 @@

Method Details

], "url": "A String", # URI reference of the place. }, - "start_index": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "url_citation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiValue - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiStruct # Represents a structured value. - }, + ], + "widget_context_token": "A String", # Resource name of the Google Maps widget context token. }, ], }, - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "search_type": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiValue - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiStruct # Represents a structured value. - }, + "googleSearchResult": { # Google Search result content. + "is_error": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "search_suggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. }, ], }, - "name": "A String", # Required. The name of the tool which was called. - "server_name": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, - }, - "toolResult": { # Tool result content. - "call_id": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "is_error": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mime_type": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "end_index": 42, # End of the attributed segment, exclusive. - "file_citation": { # A file citation annotation. # A file citation annotation. - "custom_metadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiValue - ], + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mime_type": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "end_index": 42, # End of the attributed segment, exclusive. + "file_citation": { # A file citation annotation. # A file citation annotation. + "custom_metadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiValue + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiStruct # Represents a structured value. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiStruct # Represents a structured value. }, + ], + }, + "document_uri": "A String", # The URI of the file. + "file_name": "A String", # The name of the file. + "media_id": "A String", # Media ID in-case of image citations, if applicable. + "page_number": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "place_citation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "place_id": "A String", # The ID of the place, in `places/{place_id}` format. + "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "review_id": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, ], + "url": "A String", # URI reference of the place. + }, + "start_index": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "url_citation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, - "document_uri": "A String", # The URI of the file. - "file_name": "A String", # The name of the file. - "media_id": "A String", # Media ID in-case of image citations, if applicable. - "page_number": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "place_citation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "place_id": "A String", # The ID of the place, in `places/{place_id}` format. - "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "review_id": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "start_index": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "url_citation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "is_error": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiValue ], + "text": "A String", # Required. The text content. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiStruct # Represents a structured value. - }, - }, - ], - }, - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "place_id": "A String", # The ID of the place, in `places/{place_id}` format. - "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "review_id": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. }, ], - "widget_context_token": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "is_error": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "search_suggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mime_type": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "end_index": 42, # End of the attributed segment, exclusive. - "file_citation": { # A file citation annotation. # A file citation annotation. - "custom_metadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiValue - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiStruct # Represents a structured value. - }, - }, - ], - }, - "document_uri": "A String", # The URI of the file. - "file_name": "A String", # The name of the file. - "media_id": "A String", # Media ID in-case of image citations, if applicable. - "page_number": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "place_citation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "place_id": "A String", # The ID of the place, in `places/{place_id}` format. - "review_snippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "review_id": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "start_index": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "url_citation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "server_name": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiValue + ], }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "server_name": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiValue - ], + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiStruct # Represents a structured value. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiStruct # Represents a structured value. }, + ], + }, + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "is_error": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. }, ], }, }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "is_error": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], + "video": { # A video content block. + "data": "A String", # The video content. + "mime_type": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. }, }, - "video": { # A video content block. - "data": "A String", # The video content. - "mime_type": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - ], + ], + }, + "contentString": "A String", # The content of the step. A single string. }, }, }, diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.notebookExecutionJobs.html b/docs/dyn/aiplatform_v1beta1.projects.locations.notebookExecutionJobs.html index a02b210c63..edba17bb77 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.notebookExecutionJobs.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.notebookExecutionJobs.html @@ -142,9 +142,9 @@

Method Details

"network": "A String", # The full name of the Google Compute Engine [network](https://cloud.google.com//compute/docs/networks-and-firewalls#networks) "subnetwork": "A String", # The name of the subnet that this instance is in. Format: `projects/{project_id_or_number}/regions/{region}/subnetworks/{subnetwork_id}` }, - "persistentDiskSpec": { # Represents the spec of persistent disk options. # The specification of a persistent disk to attach for the execution job. + "persistentDiskSpec": { # Represents the spec of persistent disk and hyperdisk options. # The specification of a persistent disk to attach for the execution job. "diskSizeGb": "A String", # Size in GB of the disk (default is 100GB). - "diskType": "A String", # Type of the disk (default is "pd-standard"). Valid values: "pd-ssd" (Persistent Disk Solid State Drive) "pd-standard" (Persistent Disk Hard Disk Drive) "pd-balanced" (Balanced Persistent Disk) "pd-extreme" (Extreme Persistent Disk) + "diskType": "A String", # Type of the disk (default is "pd-standard"). Valid values: "pd-ssd" (Persistent Disk Solid State Drive) "pd-standard" (Persistent Disk Hard Disk Drive) "pd-balanced" (Balanced Persistent Disk) "pd-extreme" (Extreme Persistent Disk) "hyperdisk-balanced" (Hyperdisk Balanced) "hyperdisk-extreme" (Hyperdisk Extreme) "hyperdisk-balanced-high-availability" (Hyperdisk Balanced High Availability) "hyperdisk-ml" (Hyperdisk ML) "hyperdisk-throughput" (Hyperdisk Throughput) }, }, "dataformRepositorySource": { # The Dataform Repository containing the input notebook. # The Dataform Repository pointing to a single file notebook repository. @@ -325,9 +325,9 @@

Method Details

"network": "A String", # The full name of the Google Compute Engine [network](https://cloud.google.com//compute/docs/networks-and-firewalls#networks) "subnetwork": "A String", # The name of the subnet that this instance is in. Format: `projects/{project_id_or_number}/regions/{region}/subnetworks/{subnetwork_id}` }, - "persistentDiskSpec": { # Represents the spec of persistent disk options. # The specification of a persistent disk to attach for the execution job. + "persistentDiskSpec": { # Represents the spec of persistent disk and hyperdisk options. # The specification of a persistent disk to attach for the execution job. "diskSizeGb": "A String", # Size in GB of the disk (default is 100GB). - "diskType": "A String", # Type of the disk (default is "pd-standard"). Valid values: "pd-ssd" (Persistent Disk Solid State Drive) "pd-standard" (Persistent Disk Hard Disk Drive) "pd-balanced" (Balanced Persistent Disk) "pd-extreme" (Extreme Persistent Disk) + "diskType": "A String", # Type of the disk (default is "pd-standard"). Valid values: "pd-ssd" (Persistent Disk Solid State Drive) "pd-standard" (Persistent Disk Hard Disk Drive) "pd-balanced" (Balanced Persistent Disk) "pd-extreme" (Extreme Persistent Disk) "hyperdisk-balanced" (Hyperdisk Balanced) "hyperdisk-extreme" (Hyperdisk Extreme) "hyperdisk-balanced-high-availability" (Hyperdisk Balanced High Availability) "hyperdisk-ml" (Hyperdisk ML) "hyperdisk-throughput" (Hyperdisk Throughput) }, }, "dataformRepositorySource": { # The Dataform Repository containing the input notebook. # The Dataform Repository pointing to a single file notebook repository. @@ -422,9 +422,9 @@

Method Details

"network": "A String", # The full name of the Google Compute Engine [network](https://cloud.google.com//compute/docs/networks-and-firewalls#networks) "subnetwork": "A String", # The name of the subnet that this instance is in. Format: `projects/{project_id_or_number}/regions/{region}/subnetworks/{subnetwork_id}` }, - "persistentDiskSpec": { # Represents the spec of persistent disk options. # The specification of a persistent disk to attach for the execution job. + "persistentDiskSpec": { # Represents the spec of persistent disk and hyperdisk options. # The specification of a persistent disk to attach for the execution job. "diskSizeGb": "A String", # Size in GB of the disk (default is 100GB). - "diskType": "A String", # Type of the disk (default is "pd-standard"). Valid values: "pd-ssd" (Persistent Disk Solid State Drive) "pd-standard" (Persistent Disk Hard Disk Drive) "pd-balanced" (Balanced Persistent Disk) "pd-extreme" (Extreme Persistent Disk) + "diskType": "A String", # Type of the disk (default is "pd-standard"). Valid values: "pd-ssd" (Persistent Disk Solid State Drive) "pd-standard" (Persistent Disk Hard Disk Drive) "pd-balanced" (Balanced Persistent Disk) "pd-extreme" (Extreme Persistent Disk) "hyperdisk-balanced" (Hyperdisk Balanced) "hyperdisk-extreme" (Hyperdisk Extreme) "hyperdisk-balanced-high-availability" (Hyperdisk Balanced High Availability) "hyperdisk-ml" (Hyperdisk ML) "hyperdisk-throughput" (Hyperdisk Throughput) }, }, "dataformRepositorySource": { # The Dataform Repository containing the input notebook. # The Dataform Repository pointing to a single file notebook repository. diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.notebookRuntimeTemplates.html b/docs/dyn/aiplatform_v1beta1.projects.locations.notebookRuntimeTemplates.html index 44ac99f59a..55ad1af697 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.notebookRuntimeTemplates.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.notebookRuntimeTemplates.html @@ -126,9 +126,9 @@

Method Details

{ # A template that specifies runtime configurations such as machine type, runtime version, network configurations, etc. Multiple runtimes can be created from a runtime template. "createTime": "A String", # Output only. Timestamp when this NotebookRuntimeTemplate was created. - "dataPersistentDiskSpec": { # Represents the spec of persistent disk options. # Optional. The specification of persistent disk attached to the runtime as data disk storage. + "dataPersistentDiskSpec": { # Represents the spec of persistent disk and hyperdisk options. # Optional. The specification of persistent disk attached to the runtime as data disk storage. "diskSizeGb": "A String", # Size in GB of the disk (default is 100GB). - "diskType": "A String", # Type of the disk (default is "pd-standard"). Valid values: "pd-ssd" (Persistent Disk Solid State Drive) "pd-standard" (Persistent Disk Hard Disk Drive) "pd-balanced" (Balanced Persistent Disk) "pd-extreme" (Extreme Persistent Disk) + "diskType": "A String", # Type of the disk (default is "pd-standard"). Valid values: "pd-ssd" (Persistent Disk Solid State Drive) "pd-standard" (Persistent Disk Hard Disk Drive) "pd-balanced" (Balanced Persistent Disk) "pd-extreme" (Extreme Persistent Disk) "hyperdisk-balanced" (Hyperdisk Balanced) "hyperdisk-extreme" (Hyperdisk Extreme) "hyperdisk-balanced-high-availability" (Hyperdisk Balanced High Availability) "hyperdisk-ml" (Hyperdisk ML) "hyperdisk-throughput" (Hyperdisk Throughput) }, "description": "A String", # The description of the NotebookRuntimeTemplate. "displayName": "A String", # Required. The display name of the NotebookRuntimeTemplate. The name can be up to 128 characters long and can consist of any UTF-8 characters. @@ -286,9 +286,9 @@

Method Details

{ # A template that specifies runtime configurations such as machine type, runtime version, network configurations, etc. Multiple runtimes can be created from a runtime template. "createTime": "A String", # Output only. Timestamp when this NotebookRuntimeTemplate was created. - "dataPersistentDiskSpec": { # Represents the spec of persistent disk options. # Optional. The specification of persistent disk attached to the runtime as data disk storage. + "dataPersistentDiskSpec": { # Represents the spec of persistent disk and hyperdisk options. # Optional. The specification of persistent disk attached to the runtime as data disk storage. "diskSizeGb": "A String", # Size in GB of the disk (default is 100GB). - "diskType": "A String", # Type of the disk (default is "pd-standard"). Valid values: "pd-ssd" (Persistent Disk Solid State Drive) "pd-standard" (Persistent Disk Hard Disk Drive) "pd-balanced" (Balanced Persistent Disk) "pd-extreme" (Extreme Persistent Disk) + "diskType": "A String", # Type of the disk (default is "pd-standard"). Valid values: "pd-ssd" (Persistent Disk Solid State Drive) "pd-standard" (Persistent Disk Hard Disk Drive) "pd-balanced" (Balanced Persistent Disk) "pd-extreme" (Extreme Persistent Disk) "hyperdisk-balanced" (Hyperdisk Balanced) "hyperdisk-extreme" (Hyperdisk Extreme) "hyperdisk-balanced-high-availability" (Hyperdisk Balanced High Availability) "hyperdisk-ml" (Hyperdisk ML) "hyperdisk-throughput" (Hyperdisk Throughput) }, "description": "A String", # The description of the NotebookRuntimeTemplate. "displayName": "A String", # Required. The display name of the NotebookRuntimeTemplate. The name can be up to 128 characters long and can consist of any UTF-8 characters. @@ -425,9 +425,9 @@

Method Details

"notebookRuntimeTemplates": [ # List of NotebookRuntimeTemplates in the requested page. { # A template that specifies runtime configurations such as machine type, runtime version, network configurations, etc. Multiple runtimes can be created from a runtime template. "createTime": "A String", # Output only. Timestamp when this NotebookRuntimeTemplate was created. - "dataPersistentDiskSpec": { # Represents the spec of persistent disk options. # Optional. The specification of persistent disk attached to the runtime as data disk storage. + "dataPersistentDiskSpec": { # Represents the spec of persistent disk and hyperdisk options. # Optional. The specification of persistent disk attached to the runtime as data disk storage. "diskSizeGb": "A String", # Size in GB of the disk (default is 100GB). - "diskType": "A String", # Type of the disk (default is "pd-standard"). Valid values: "pd-ssd" (Persistent Disk Solid State Drive) "pd-standard" (Persistent Disk Hard Disk Drive) "pd-balanced" (Balanced Persistent Disk) "pd-extreme" (Extreme Persistent Disk) + "diskType": "A String", # Type of the disk (default is "pd-standard"). Valid values: "pd-ssd" (Persistent Disk Solid State Drive) "pd-standard" (Persistent Disk Hard Disk Drive) "pd-balanced" (Balanced Persistent Disk) "pd-extreme" (Extreme Persistent Disk) "hyperdisk-balanced" (Hyperdisk Balanced) "hyperdisk-extreme" (Hyperdisk Extreme) "hyperdisk-balanced-high-availability" (Hyperdisk Balanced High Availability) "hyperdisk-ml" (Hyperdisk ML) "hyperdisk-throughput" (Hyperdisk Throughput) }, "description": "A String", # The description of the NotebookRuntimeTemplate. "displayName": "A String", # Required. The display name of the NotebookRuntimeTemplate. The name can be up to 128 characters long and can consist of any UTF-8 characters. @@ -532,9 +532,9 @@

Method Details

{ # A template that specifies runtime configurations such as machine type, runtime version, network configurations, etc. Multiple runtimes can be created from a runtime template. "createTime": "A String", # Output only. Timestamp when this NotebookRuntimeTemplate was created. - "dataPersistentDiskSpec": { # Represents the spec of persistent disk options. # Optional. The specification of persistent disk attached to the runtime as data disk storage. + "dataPersistentDiskSpec": { # Represents the spec of persistent disk and hyperdisk options. # Optional. The specification of persistent disk attached to the runtime as data disk storage. "diskSizeGb": "A String", # Size in GB of the disk (default is 100GB). - "diskType": "A String", # Type of the disk (default is "pd-standard"). Valid values: "pd-ssd" (Persistent Disk Solid State Drive) "pd-standard" (Persistent Disk Hard Disk Drive) "pd-balanced" (Balanced Persistent Disk) "pd-extreme" (Extreme Persistent Disk) + "diskType": "A String", # Type of the disk (default is "pd-standard"). Valid values: "pd-ssd" (Persistent Disk Solid State Drive) "pd-standard" (Persistent Disk Hard Disk Drive) "pd-balanced" (Balanced Persistent Disk) "pd-extreme" (Extreme Persistent Disk) "hyperdisk-balanced" (Hyperdisk Balanced) "hyperdisk-extreme" (Hyperdisk Extreme) "hyperdisk-balanced-high-availability" (Hyperdisk Balanced High Availability) "hyperdisk-ml" (Hyperdisk ML) "hyperdisk-throughput" (Hyperdisk Throughput) }, "description": "A String", # The description of the NotebookRuntimeTemplate. "displayName": "A String", # Required. The display name of the NotebookRuntimeTemplate. The name can be up to 128 characters long and can consist of any UTF-8 characters. @@ -622,9 +622,9 @@

Method Details

{ # A template that specifies runtime configurations such as machine type, runtime version, network configurations, etc. Multiple runtimes can be created from a runtime template. "createTime": "A String", # Output only. Timestamp when this NotebookRuntimeTemplate was created. - "dataPersistentDiskSpec": { # Represents the spec of persistent disk options. # Optional. The specification of persistent disk attached to the runtime as data disk storage. + "dataPersistentDiskSpec": { # Represents the spec of persistent disk and hyperdisk options. # Optional. The specification of persistent disk attached to the runtime as data disk storage. "diskSizeGb": "A String", # Size in GB of the disk (default is 100GB). - "diskType": "A String", # Type of the disk (default is "pd-standard"). Valid values: "pd-ssd" (Persistent Disk Solid State Drive) "pd-standard" (Persistent Disk Hard Disk Drive) "pd-balanced" (Balanced Persistent Disk) "pd-extreme" (Extreme Persistent Disk) + "diskType": "A String", # Type of the disk (default is "pd-standard"). Valid values: "pd-ssd" (Persistent Disk Solid State Drive) "pd-standard" (Persistent Disk Hard Disk Drive) "pd-balanced" (Balanced Persistent Disk) "pd-extreme" (Extreme Persistent Disk) "hyperdisk-balanced" (Hyperdisk Balanced) "hyperdisk-extreme" (Hyperdisk Extreme) "hyperdisk-balanced-high-availability" (Hyperdisk Balanced High Availability) "hyperdisk-ml" (Hyperdisk ML) "hyperdisk-throughput" (Hyperdisk Throughput) }, "description": "A String", # The description of the NotebookRuntimeTemplate. "displayName": "A String", # Required. The display name of the NotebookRuntimeTemplate. The name can be up to 128 characters long and can consist of any UTF-8 characters. diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.notebookRuntimes.html b/docs/dyn/aiplatform_v1beta1.projects.locations.notebookRuntimes.html index f249538d30..8c3c0881a2 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.notebookRuntimes.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.notebookRuntimes.html @@ -125,9 +125,9 @@

Method Details

{ # Request message for NotebookService.AssignNotebookRuntime. "notebookRuntime": { # A runtime is a virtual machine allocated to a particular user for a particular Notebook file on temporary basis with lifetime. Default runtimes have a lifetime of 18 hours, while custom runtimes last for 6 months from their creation or last upgrade. # Required. Provide runtime specific information (e.g. runtime owner, notebook id) used for NotebookRuntime assignment. "createTime": "A String", # Output only. Timestamp when this NotebookRuntime was created. - "dataPersistentDiskSpec": { # Represents the spec of persistent disk options. # Output only. The specification of persistent disk attached to the notebook runtime as data disk storage. + "dataPersistentDiskSpec": { # Represents the spec of persistent disk and hyperdisk options. # Output only. The specification of persistent disk attached to the notebook runtime as data disk storage. "diskSizeGb": "A String", # Size in GB of the disk (default is 100GB). - "diskType": "A String", # Type of the disk (default is "pd-standard"). Valid values: "pd-ssd" (Persistent Disk Solid State Drive) "pd-standard" (Persistent Disk Hard Disk Drive) "pd-balanced" (Balanced Persistent Disk) "pd-extreme" (Extreme Persistent Disk) + "diskType": "A String", # Type of the disk (default is "pd-standard"). Valid values: "pd-ssd" (Persistent Disk Solid State Drive) "pd-standard" (Persistent Disk Hard Disk Drive) "pd-balanced" (Balanced Persistent Disk) "pd-extreme" (Extreme Persistent Disk) "hyperdisk-balanced" (Hyperdisk Balanced) "hyperdisk-extreme" (Hyperdisk Extreme) "hyperdisk-balanced-high-availability" (Hyperdisk Balanced High Availability) "hyperdisk-ml" (Hyperdisk ML) "hyperdisk-throughput" (Hyperdisk Throughput) }, "description": "A String", # The description of the NotebookRuntime. "displayName": "A String", # Required. The display name of the NotebookRuntime. The name can be up to 128 characters long and can consist of any UTF-8 characters. @@ -331,9 +331,9 @@

Method Details

{ # A runtime is a virtual machine allocated to a particular user for a particular Notebook file on temporary basis with lifetime. Default runtimes have a lifetime of 18 hours, while custom runtimes last for 6 months from their creation or last upgrade. "createTime": "A String", # Output only. Timestamp when this NotebookRuntime was created. - "dataPersistentDiskSpec": { # Represents the spec of persistent disk options. # Output only. The specification of persistent disk attached to the notebook runtime as data disk storage. + "dataPersistentDiskSpec": { # Represents the spec of persistent disk and hyperdisk options. # Output only. The specification of persistent disk attached to the notebook runtime as data disk storage. "diskSizeGb": "A String", # Size in GB of the disk (default is 100GB). - "diskType": "A String", # Type of the disk (default is "pd-standard"). Valid values: "pd-ssd" (Persistent Disk Solid State Drive) "pd-standard" (Persistent Disk Hard Disk Drive) "pd-balanced" (Balanced Persistent Disk) "pd-extreme" (Extreme Persistent Disk) + "diskType": "A String", # Type of the disk (default is "pd-standard"). Valid values: "pd-ssd" (Persistent Disk Solid State Drive) "pd-standard" (Persistent Disk Hard Disk Drive) "pd-balanced" (Balanced Persistent Disk) "pd-extreme" (Extreme Persistent Disk) "hyperdisk-balanced" (Hyperdisk Balanced) "hyperdisk-extreme" (Hyperdisk Extreme) "hyperdisk-balanced-high-availability" (Hyperdisk Balanced High Availability) "hyperdisk-ml" (Hyperdisk ML) "hyperdisk-throughput" (Hyperdisk Throughput) }, "description": "A String", # The description of the NotebookRuntime. "displayName": "A String", # Required. The display name of the NotebookRuntime. The name can be up to 128 characters long and can consist of any UTF-8 characters. @@ -445,9 +445,9 @@

Method Details

"notebookRuntimes": [ # List of NotebookRuntimes in the requested page. { # A runtime is a virtual machine allocated to a particular user for a particular Notebook file on temporary basis with lifetime. Default runtimes have a lifetime of 18 hours, while custom runtimes last for 6 months from their creation or last upgrade. "createTime": "A String", # Output only. Timestamp when this NotebookRuntime was created. - "dataPersistentDiskSpec": { # Represents the spec of persistent disk options. # Output only. The specification of persistent disk attached to the notebook runtime as data disk storage. + "dataPersistentDiskSpec": { # Represents the spec of persistent disk and hyperdisk options. # Output only. The specification of persistent disk attached to the notebook runtime as data disk storage. "diskSizeGb": "A String", # Size in GB of the disk (default is 100GB). - "diskType": "A String", # Type of the disk (default is "pd-standard"). Valid values: "pd-ssd" (Persistent Disk Solid State Drive) "pd-standard" (Persistent Disk Hard Disk Drive) "pd-balanced" (Balanced Persistent Disk) "pd-extreme" (Extreme Persistent Disk) + "diskType": "A String", # Type of the disk (default is "pd-standard"). Valid values: "pd-ssd" (Persistent Disk Solid State Drive) "pd-standard" (Persistent Disk Hard Disk Drive) "pd-balanced" (Balanced Persistent Disk) "pd-extreme" (Extreme Persistent Disk) "hyperdisk-balanced" (Hyperdisk Balanced) "hyperdisk-extreme" (Hyperdisk Extreme) "hyperdisk-balanced-high-availability" (Hyperdisk Balanced High Availability) "hyperdisk-ml" (Hyperdisk ML) "hyperdisk-throughput" (Hyperdisk Throughput) }, "description": "A String", # The description of the NotebookRuntime. "displayName": "A String", # Required. The display name of the NotebookRuntime. The name can be up to 128 characters long and can consist of any UTF-8 characters. diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.publishers.models.html b/docs/dyn/aiplatform_v1beta1.projects.locations.publishers.models.html index 8770daf260..5dba3ad01a 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.publishers.models.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.publishers.models.html @@ -550,6 +550,12 @@

Method Details

"A String", ], }, + "exaAiSearch": { # ExaAiSearch tool type. A tool that uses the Exa.ai search engine for grounding. # Optional. Uses Exa.ai to search for information to answer user queries. The search results will be grounded on Exa.ai and presented to the model for response generation + "apiKey": "A String", # Required. The API key for ExaAiSearch. + "customConfigs": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. + "a_key": "", # Properties of the object. + }, + }, "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "behavior": "A String", # Optional. Specifies the function Behavior. If not specified, the system keeps the current function call behavior. This field is currently only supported by the BidiGenerateContent method. @@ -1373,6 +1379,12 @@

Method Details

"A String", ], }, + "exaAiSearch": { # ExaAiSearch tool type. A tool that uses the Exa.ai search engine for grounding. # Optional. Uses Exa.ai to search for information to answer user queries. The search results will be grounded on Exa.ai and presented to the model for response generation + "apiKey": "A String", # Required. The API key for ExaAiSearch. + "customConfigs": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. + "a_key": "", # Properties of the object. + }, + }, "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "behavior": "A String", # Optional. Specifies the function Behavior. If not specified, the system keeps the current function call behavior. This field is currently only supported by the BidiGenerateContent method. @@ -2609,6 +2621,12 @@

Method Details

"A String", ], }, + "exaAiSearch": { # ExaAiSearch tool type. A tool that uses the Exa.ai search engine for grounding. # Optional. Uses Exa.ai to search for information to answer user queries. The search results will be grounded on Exa.ai and presented to the model for response generation + "apiKey": "A String", # Required. The API key for ExaAiSearch. + "customConfigs": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. + "a_key": "", # Properties of the object. + }, + }, "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "behavior": "A String", # Optional. Specifies the function Behavior. If not specified, the system keeps the current function call behavior. This field is currently only supported by the BidiGenerateContent method. diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.memories.html b/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.memories.html index 4052fad68e..a80db69a68 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.memories.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.memories.html @@ -732,7 +732,7 @@

Method Details

"updateTime": "A String", # Output only. Represents the timestamp when this Memory was most recently updated. } - updateMask: string, Optional. Mask specifying which fields to update. Supported fields: * `display_name` * `description` * `fact` + updateMask: string, Optional. Mask specifying which fields to update. The following fields are immutable: * `scope` * `memory_type` x__xgafv: string, V1 error format. Allowed values 1 - v1 error format diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.sandboxEnvironmentTemplates.html b/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.sandboxEnvironmentTemplates.html index 25cae42c24..84247618b8 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.sandboxEnvironmentTemplates.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.sandboxEnvironmentTemplates.html @@ -135,6 +135,14 @@

Method Details

}, "defaultContainerEnvironment": { # The default sandbox runtime environment for default container workloads. # The sandbox environment for default container workloads. "defaultContainerCategory": "A String", # Required. The category of the default container image. + "resources": { # Message to define resource requests and limits (mirroring Kubernetes) for each sandbox instance created from this template. # Optional. Resource requests and limits for the default container. + "limits": { # Optional. The maximum amounts of compute resources allowed. Keys are resource names (e.g., "cpu", "memory"). Values are quantities (e.g., "500m", "1Gi"). + "a_key": "A String", + }, + "requests": { # Optional. The requested amounts of compute resources. Keys are resource names (e.g., "cpu", "memory"). Values are quantities (e.g., "250m", "512Mi"). + "a_key": "A String", + }, + }, }, "displayName": "A String", # Required. The display name of the SandboxEnvironmentTemplate. "egressControlConfig": { # Configuration for egress control of sandbox instances. # Optional. The configuration for egress control of this template. @@ -246,6 +254,14 @@

Method Details

}, "defaultContainerEnvironment": { # The default sandbox runtime environment for default container workloads. # The sandbox environment for default container workloads. "defaultContainerCategory": "A String", # Required. The category of the default container image. + "resources": { # Message to define resource requests and limits (mirroring Kubernetes) for each sandbox instance created from this template. # Optional. Resource requests and limits for the default container. + "limits": { # Optional. The maximum amounts of compute resources allowed. Keys are resource names (e.g., "cpu", "memory"). Values are quantities (e.g., "500m", "1Gi"). + "a_key": "A String", + }, + "requests": { # Optional. The requested amounts of compute resources. Keys are resource names (e.g., "cpu", "memory"). Values are quantities (e.g., "250m", "512Mi"). + "a_key": "A String", + }, + }, }, "displayName": "A String", # Required. The display name of the SandboxEnvironmentTemplate. "egressControlConfig": { # Configuration for egress control of sandbox instances. # Optional. The configuration for egress control of this template. @@ -300,6 +316,14 @@

Method Details

}, "defaultContainerEnvironment": { # The default sandbox runtime environment for default container workloads. # The sandbox environment for default container workloads. "defaultContainerCategory": "A String", # Required. The category of the default container image. + "resources": { # Message to define resource requests and limits (mirroring Kubernetes) for each sandbox instance created from this template. # Optional. Resource requests and limits for the default container. + "limits": { # Optional. The maximum amounts of compute resources allowed. Keys are resource names (e.g., "cpu", "memory"). Values are quantities (e.g., "500m", "1Gi"). + "a_key": "A String", + }, + "requests": { # Optional. The requested amounts of compute resources. Keys are resource names (e.g., "cpu", "memory"). Values are quantities (e.g., "250m", "512Mi"). + "a_key": "A String", + }, + }, }, "displayName": "A String", # Required. The display name of the SandboxEnvironmentTemplate. "egressControlConfig": { # Configuration for egress control of sandbox instances. # Optional. The configuration for egress control of this template. diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.schedules.html b/docs/dyn/aiplatform_v1beta1.projects.locations.schedules.html index ca06daae5f..07e36b5131 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.schedules.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.schedules.html @@ -472,9 +472,9 @@

Method Details

"network": "A String", # The full name of the Google Compute Engine [network](https://cloud.google.com//compute/docs/networks-and-firewalls#networks) "subnetwork": "A String", # The name of the subnet that this instance is in. Format: `projects/{project_id_or_number}/regions/{region}/subnetworks/{subnetwork_id}` }, - "persistentDiskSpec": { # Represents the spec of persistent disk options. # The specification of a persistent disk to attach for the execution job. + "persistentDiskSpec": { # Represents the spec of persistent disk and hyperdisk options. # The specification of a persistent disk to attach for the execution job. "diskSizeGb": "A String", # Size in GB of the disk (default is 100GB). - "diskType": "A String", # Type of the disk (default is "pd-standard"). Valid values: "pd-ssd" (Persistent Disk Solid State Drive) "pd-standard" (Persistent Disk Hard Disk Drive) "pd-balanced" (Balanced Persistent Disk) "pd-extreme" (Extreme Persistent Disk) + "diskType": "A String", # Type of the disk (default is "pd-standard"). Valid values: "pd-ssd" (Persistent Disk Solid State Drive) "pd-standard" (Persistent Disk Hard Disk Drive) "pd-balanced" (Balanced Persistent Disk) "pd-extreme" (Extreme Persistent Disk) "hyperdisk-balanced" (Hyperdisk Balanced) "hyperdisk-extreme" (Hyperdisk Extreme) "hyperdisk-balanced-high-availability" (Hyperdisk Balanced High Availability) "hyperdisk-ml" (Hyperdisk ML) "hyperdisk-throughput" (Hyperdisk Throughput) }, }, "dataformRepositorySource": { # The Dataform Repository containing the input notebook. # The Dataform Repository pointing to a single file notebook repository. @@ -1186,9 +1186,9 @@

Method Details

"network": "A String", # The full name of the Google Compute Engine [network](https://cloud.google.com//compute/docs/networks-and-firewalls#networks) "subnetwork": "A String", # The name of the subnet that this instance is in. Format: `projects/{project_id_or_number}/regions/{region}/subnetworks/{subnetwork_id}` }, - "persistentDiskSpec": { # Represents the spec of persistent disk options. # The specification of a persistent disk to attach for the execution job. + "persistentDiskSpec": { # Represents the spec of persistent disk and hyperdisk options. # The specification of a persistent disk to attach for the execution job. "diskSizeGb": "A String", # Size in GB of the disk (default is 100GB). - "diskType": "A String", # Type of the disk (default is "pd-standard"). Valid values: "pd-ssd" (Persistent Disk Solid State Drive) "pd-standard" (Persistent Disk Hard Disk Drive) "pd-balanced" (Balanced Persistent Disk) "pd-extreme" (Extreme Persistent Disk) + "diskType": "A String", # Type of the disk (default is "pd-standard"). Valid values: "pd-ssd" (Persistent Disk Solid State Drive) "pd-standard" (Persistent Disk Hard Disk Drive) "pd-balanced" (Balanced Persistent Disk) "pd-extreme" (Extreme Persistent Disk) "hyperdisk-balanced" (Hyperdisk Balanced) "hyperdisk-extreme" (Hyperdisk Extreme) "hyperdisk-balanced-high-availability" (Hyperdisk Balanced High Availability) "hyperdisk-ml" (Hyperdisk ML) "hyperdisk-throughput" (Hyperdisk Throughput) }, }, "dataformRepositorySource": { # The Dataform Repository containing the input notebook. # The Dataform Repository pointing to a single file notebook repository. @@ -1942,9 +1942,9 @@

Method Details

"network": "A String", # The full name of the Google Compute Engine [network](https://cloud.google.com//compute/docs/networks-and-firewalls#networks) "subnetwork": "A String", # The name of the subnet that this instance is in. Format: `projects/{project_id_or_number}/regions/{region}/subnetworks/{subnetwork_id}` }, - "persistentDiskSpec": { # Represents the spec of persistent disk options. # The specification of a persistent disk to attach for the execution job. + "persistentDiskSpec": { # Represents the spec of persistent disk and hyperdisk options. # The specification of a persistent disk to attach for the execution job. "diskSizeGb": "A String", # Size in GB of the disk (default is 100GB). - "diskType": "A String", # Type of the disk (default is "pd-standard"). Valid values: "pd-ssd" (Persistent Disk Solid State Drive) "pd-standard" (Persistent Disk Hard Disk Drive) "pd-balanced" (Balanced Persistent Disk) "pd-extreme" (Extreme Persistent Disk) + "diskType": "A String", # Type of the disk (default is "pd-standard"). Valid values: "pd-ssd" (Persistent Disk Solid State Drive) "pd-standard" (Persistent Disk Hard Disk Drive) "pd-balanced" (Balanced Persistent Disk) "pd-extreme" (Extreme Persistent Disk) "hyperdisk-balanced" (Hyperdisk Balanced) "hyperdisk-extreme" (Hyperdisk Extreme) "hyperdisk-balanced-high-availability" (Hyperdisk Balanced High Availability) "hyperdisk-ml" (Hyperdisk ML) "hyperdisk-throughput" (Hyperdisk Throughput) }, }, "dataformRepositorySource": { # The Dataform Repository containing the input notebook. # The Dataform Repository pointing to a single file notebook repository. @@ -2670,9 +2670,9 @@

Method Details

"network": "A String", # The full name of the Google Compute Engine [network](https://cloud.google.com//compute/docs/networks-and-firewalls#networks) "subnetwork": "A String", # The name of the subnet that this instance is in. Format: `projects/{project_id_or_number}/regions/{region}/subnetworks/{subnetwork_id}` }, - "persistentDiskSpec": { # Represents the spec of persistent disk options. # The specification of a persistent disk to attach for the execution job. + "persistentDiskSpec": { # Represents the spec of persistent disk and hyperdisk options. # The specification of a persistent disk to attach for the execution job. "diskSizeGb": "A String", # Size in GB of the disk (default is 100GB). - "diskType": "A String", # Type of the disk (default is "pd-standard"). Valid values: "pd-ssd" (Persistent Disk Solid State Drive) "pd-standard" (Persistent Disk Hard Disk Drive) "pd-balanced" (Balanced Persistent Disk) "pd-extreme" (Extreme Persistent Disk) + "diskType": "A String", # Type of the disk (default is "pd-standard"). Valid values: "pd-ssd" (Persistent Disk Solid State Drive) "pd-standard" (Persistent Disk Hard Disk Drive) "pd-balanced" (Balanced Persistent Disk) "pd-extreme" (Extreme Persistent Disk) "hyperdisk-balanced" (Hyperdisk Balanced) "hyperdisk-extreme" (Hyperdisk Extreme) "hyperdisk-balanced-high-availability" (Hyperdisk Balanced High Availability) "hyperdisk-ml" (Hyperdisk ML) "hyperdisk-throughput" (Hyperdisk Throughput) }, }, "dataformRepositorySource": { # The Dataform Repository containing the input notebook. # The Dataform Repository pointing to a single file notebook repository. @@ -3402,9 +3402,9 @@

Method Details

"network": "A String", # The full name of the Google Compute Engine [network](https://cloud.google.com//compute/docs/networks-and-firewalls#networks) "subnetwork": "A String", # The name of the subnet that this instance is in. Format: `projects/{project_id_or_number}/regions/{region}/subnetworks/{subnetwork_id}` }, - "persistentDiskSpec": { # Represents the spec of persistent disk options. # The specification of a persistent disk to attach for the execution job. + "persistentDiskSpec": { # Represents the spec of persistent disk and hyperdisk options. # The specification of a persistent disk to attach for the execution job. "diskSizeGb": "A String", # Size in GB of the disk (default is 100GB). - "diskType": "A String", # Type of the disk (default is "pd-standard"). Valid values: "pd-ssd" (Persistent Disk Solid State Drive) "pd-standard" (Persistent Disk Hard Disk Drive) "pd-balanced" (Balanced Persistent Disk) "pd-extreme" (Extreme Persistent Disk) + "diskType": "A String", # Type of the disk (default is "pd-standard"). Valid values: "pd-ssd" (Persistent Disk Solid State Drive) "pd-standard" (Persistent Disk Hard Disk Drive) "pd-balanced" (Balanced Persistent Disk) "pd-extreme" (Extreme Persistent Disk) "hyperdisk-balanced" (Hyperdisk Balanced) "hyperdisk-extreme" (Hyperdisk Extreme) "hyperdisk-balanced-high-availability" (Hyperdisk Balanced High Availability) "hyperdisk-ml" (Hyperdisk ML) "hyperdisk-throughput" (Hyperdisk Throughput) }, }, "dataformRepositorySource": { # The Dataform Repository containing the input notebook. # The Dataform Repository pointing to a single file notebook repository. @@ -4117,9 +4117,9 @@

Method Details

"network": "A String", # The full name of the Google Compute Engine [network](https://cloud.google.com//compute/docs/networks-and-firewalls#networks) "subnetwork": "A String", # The name of the subnet that this instance is in. Format: `projects/{project_id_or_number}/regions/{region}/subnetworks/{subnetwork_id}` }, - "persistentDiskSpec": { # Represents the spec of persistent disk options. # The specification of a persistent disk to attach for the execution job. + "persistentDiskSpec": { # Represents the spec of persistent disk and hyperdisk options. # The specification of a persistent disk to attach for the execution job. "diskSizeGb": "A String", # Size in GB of the disk (default is 100GB). - "diskType": "A String", # Type of the disk (default is "pd-standard"). Valid values: "pd-ssd" (Persistent Disk Solid State Drive) "pd-standard" (Persistent Disk Hard Disk Drive) "pd-balanced" (Balanced Persistent Disk) "pd-extreme" (Extreme Persistent Disk) + "diskType": "A String", # Type of the disk (default is "pd-standard"). Valid values: "pd-ssd" (Persistent Disk Solid State Drive) "pd-standard" (Persistent Disk Hard Disk Drive) "pd-balanced" (Balanced Persistent Disk) "pd-extreme" (Extreme Persistent Disk) "hyperdisk-balanced" (Hyperdisk Balanced) "hyperdisk-extreme" (Hyperdisk Extreme) "hyperdisk-balanced-high-availability" (Hyperdisk Balanced High Availability) "hyperdisk-ml" (Hyperdisk ML) "hyperdisk-throughput" (Hyperdisk Throughput) }, }, "dataformRepositorySource": { # The Dataform Repository containing the input notebook. # The Dataform Repository pointing to a single file notebook repository. diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.semanticGovernancePolicies.html b/docs/dyn/aiplatform_v1beta1.projects.locations.semanticGovernancePolicies.html index afb895ede4..93bd68d797 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.semanticGovernancePolicies.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.semanticGovernancePolicies.html @@ -82,10 +82,273 @@

Instance Methods

close()

Close httplib2 connections.

+

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

+

Creates a SemanticGovernancePolicy.

+

+ delete(name, etag=None, x__xgafv=None)

+

Deletes a SemanticGovernancePolicy.

+

+ get(name, x__xgafv=None)

+

Gets a SemanticGovernancePolicy.

+

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

+

Lists SemanticGovernancePolicies in a given location.

+

+ list_next()

+

Retrieves the next page of results.

+

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

+

Updates a SemanticGovernancePolicy.

Method Details

close()
Close httplib2 connections.
+
+ create(parent, body=None, semanticGovernancePolicyId=None, x__xgafv=None) +
Creates a SemanticGovernancePolicy.
+
+Args:
+  parent: string, Required. The resource name of the Location into which to create the SemanticGovernancePolicy. Format: `projects/{project}/locations/{location}` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Represents a governance policy applied to a specific Agent and optionally a specific Tool within that Agent.
+  "agent": "A String", # Required. The name of the agent in Agent Registry that is affected by this policy.
+  "agentIdentity": "A String", # Output only. Represents the principal of the agent, used by the Policy Decision Point (PDP) for governance checks. For more information, see https://docs.cloud.google.com/agent-builder/agent-engine/agent-identity Format: `principal://TRUST_DOMAIN/NAMESPACE/AGENT_NAME` Example: `principal://agents.global.org-ORGANIZATION_ID.system.id.goog/resources/aiplatform/projects/PROJECT_NUMBER/locations/LOCATION/reasoningEngines/AGENT_ENGINE_ID`
+  "createTime": "A String", # Output only. Timestamp when this SemanticGovernancePolicy was created.
+  "description": "A String", # Optional. The description of the SemanticGovernancePolicy.
+  "displayName": "A String", # Optional. The user-defined name of the SemanticGovernancePolicy.
+  "etag": "A String", # Optional. Used to perform consistent read-modify-write transactions. If provided, the request will only succeed if the etag matches the current value. Otherwise, an ABORTED error will be returned.
+  "mcpTools": [ # Optional. The McpTools that are affected by this policy.
+    { # Represents a governance policy applied to MCP tools used by an Agent.
+      "mcpServer": "A String", # Required. The resource name of the McpServer in Agent Registry that is affected by this policy. Format: `projects/{project}/locations/{location}/mcpServers/{mcp_server}`
+      "tools": [ # Optional. The resource names of the McpTools used by the Agent that is affected by this policy. If not specified, the policy applies to all McpTools in the McpServer.
+        "A String",
+      ],
+    },
+  ],
+  "name": "A String", # Identifier. Resource name of the SemanticGovernancePolicy.
+  "naturalLanguageConstraint": "A String", # Required. The natural language constraint of the SemanticGovernancePolicy.
+  "updateTime": "A String", # Output only. Timestamp when this SemanticGovernancePolicy was last updated.
+}
+
+  semanticGovernancePolicyId: string, Required. The ID to use for the SemanticGovernancePolicy, which will become the final component of the SemanticGovernancePolicy's resource name. This value may be up to 63 characters, and valid characters are `[a-z0-9-]`. The first character cannot be a number or hyphen. The last character must be a letter or a number.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ delete(name, etag=None, x__xgafv=None) +
Deletes a SemanticGovernancePolicy.
+
+Args:
+  name: string, Required. The name of the SemanticGovernancePolicy resource to be deleted. Format: `projects/{project}/locations/{location}/semanticGovernancePolicies/{semantic_governance_policy}` (required)
+  etag: string, Optional. The etag of the SemanticGovernancePolicy. If an etag is provided and does not match the current etag of the SemanticGovernancePolicy, deletion will be blocked and an ABORTED error will be returned.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # 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 a SemanticGovernancePolicy.
+
+Args:
+  name: string, Required. The name of the SemanticGovernancePolicy resource. Format: `projects/{project}/locations/{location}/semanticGovernancePolicies/{semantic_governance_policy}` (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Represents a governance policy applied to a specific Agent and optionally a specific Tool within that Agent.
+  "agent": "A String", # Required. The name of the agent in Agent Registry that is affected by this policy.
+  "agentIdentity": "A String", # Output only. Represents the principal of the agent, used by the Policy Decision Point (PDP) for governance checks. For more information, see https://docs.cloud.google.com/agent-builder/agent-engine/agent-identity Format: `principal://TRUST_DOMAIN/NAMESPACE/AGENT_NAME` Example: `principal://agents.global.org-ORGANIZATION_ID.system.id.goog/resources/aiplatform/projects/PROJECT_NUMBER/locations/LOCATION/reasoningEngines/AGENT_ENGINE_ID`
+  "createTime": "A String", # Output only. Timestamp when this SemanticGovernancePolicy was created.
+  "description": "A String", # Optional. The description of the SemanticGovernancePolicy.
+  "displayName": "A String", # Optional. The user-defined name of the SemanticGovernancePolicy.
+  "etag": "A String", # Optional. Used to perform consistent read-modify-write transactions. If provided, the request will only succeed if the etag matches the current value. Otherwise, an ABORTED error will be returned.
+  "mcpTools": [ # Optional. The McpTools that are affected by this policy.
+    { # Represents a governance policy applied to MCP tools used by an Agent.
+      "mcpServer": "A String", # Required. The resource name of the McpServer in Agent Registry that is affected by this policy. Format: `projects/{project}/locations/{location}/mcpServers/{mcp_server}`
+      "tools": [ # Optional. The resource names of the McpTools used by the Agent that is affected by this policy. If not specified, the policy applies to all McpTools in the McpServer.
+        "A String",
+      ],
+    },
+  ],
+  "name": "A String", # Identifier. Resource name of the SemanticGovernancePolicy.
+  "naturalLanguageConstraint": "A String", # Required. The natural language constraint of the SemanticGovernancePolicy.
+  "updateTime": "A String", # Output only. Timestamp when this SemanticGovernancePolicy was last updated.
+}
+
+ +
+ list(parent, pageSize=None, pageToken=None, x__xgafv=None) +
Lists SemanticGovernancePolicies in a given location.
+
+Args:
+  parent: string, Required. The resource name of the Location from which to list the SemanticGovernancePolicies. Format: `projects/{project}/locations/{location}` (required)
+  pageSize: integer, Optional. The list page size. If zero, a default page size of 10 is used.
+  pageToken: string, Optional. The standard list page token.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response message for SemanticGovernancePolicyService.ListSemanticGovernancePolicies.
+  "nextPageToken": "A String", # A token to retrieve the next page of results. Pass to ListSemanticGovernancePoliciesRequest.page_token to obtain that page.
+  "semanticGovernancePolicies": [ # The list of SemanticGovernancePolicies.
+    { # Represents a governance policy applied to a specific Agent and optionally a specific Tool within that Agent.
+      "agent": "A String", # Required. The name of the agent in Agent Registry that is affected by this policy.
+      "agentIdentity": "A String", # Output only. Represents the principal of the agent, used by the Policy Decision Point (PDP) for governance checks. For more information, see https://docs.cloud.google.com/agent-builder/agent-engine/agent-identity Format: `principal://TRUST_DOMAIN/NAMESPACE/AGENT_NAME` Example: `principal://agents.global.org-ORGANIZATION_ID.system.id.goog/resources/aiplatform/projects/PROJECT_NUMBER/locations/LOCATION/reasoningEngines/AGENT_ENGINE_ID`
+      "createTime": "A String", # Output only. Timestamp when this SemanticGovernancePolicy was created.
+      "description": "A String", # Optional. The description of the SemanticGovernancePolicy.
+      "displayName": "A String", # Optional. The user-defined name of the SemanticGovernancePolicy.
+      "etag": "A String", # Optional. Used to perform consistent read-modify-write transactions. If provided, the request will only succeed if the etag matches the current value. Otherwise, an ABORTED error will be returned.
+      "mcpTools": [ # Optional. The McpTools that are affected by this policy.
+        { # Represents a governance policy applied to MCP tools used by an Agent.
+          "mcpServer": "A String", # Required. The resource name of the McpServer in Agent Registry that is affected by this policy. Format: `projects/{project}/locations/{location}/mcpServers/{mcp_server}`
+          "tools": [ # Optional. The resource names of the McpTools used by the Agent that is affected by this policy. If not specified, the policy applies to all McpTools in the McpServer.
+            "A String",
+          ],
+        },
+      ],
+      "name": "A String", # Identifier. Resource name of the SemanticGovernancePolicy.
+      "naturalLanguageConstraint": "A String", # Required. The natural language constraint of the SemanticGovernancePolicy.
+      "updateTime": "A String", # Output only. Timestamp when this SemanticGovernancePolicy was last updated.
+    },
+  ],
+}
+
+ +
+ list_next() +
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+        
+
+ +
+ patch(name, body=None, updateMask=None, x__xgafv=None) +
Updates a SemanticGovernancePolicy.
+
+Args:
+  name: string, Identifier. Resource name of the SemanticGovernancePolicy. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Represents a governance policy applied to a specific Agent and optionally a specific Tool within that Agent.
+  "agent": "A String", # Required. The name of the agent in Agent Registry that is affected by this policy.
+  "agentIdentity": "A String", # Output only. Represents the principal of the agent, used by the Policy Decision Point (PDP) for governance checks. For more information, see https://docs.cloud.google.com/agent-builder/agent-engine/agent-identity Format: `principal://TRUST_DOMAIN/NAMESPACE/AGENT_NAME` Example: `principal://agents.global.org-ORGANIZATION_ID.system.id.goog/resources/aiplatform/projects/PROJECT_NUMBER/locations/LOCATION/reasoningEngines/AGENT_ENGINE_ID`
+  "createTime": "A String", # Output only. Timestamp when this SemanticGovernancePolicy was created.
+  "description": "A String", # Optional. The description of the SemanticGovernancePolicy.
+  "displayName": "A String", # Optional. The user-defined name of the SemanticGovernancePolicy.
+  "etag": "A String", # Optional. Used to perform consistent read-modify-write transactions. If provided, the request will only succeed if the etag matches the current value. Otherwise, an ABORTED error will be returned.
+  "mcpTools": [ # Optional. The McpTools that are affected by this policy.
+    { # Represents a governance policy applied to MCP tools used by an Agent.
+      "mcpServer": "A String", # Required. The resource name of the McpServer in Agent Registry that is affected by this policy. Format: `projects/{project}/locations/{location}/mcpServers/{mcp_server}`
+      "tools": [ # Optional. The resource names of the McpTools used by the Agent that is affected by this policy. If not specified, the policy applies to all McpTools in the McpServer.
+        "A String",
+      ],
+    },
+  ],
+  "name": "A String", # Identifier. Resource name of the SemanticGovernancePolicy.
+  "naturalLanguageConstraint": "A String", # Required. The natural language constraint of the SemanticGovernancePolicy.
+  "updateTime": "A String", # Output only. Timestamp when this SemanticGovernancePolicy was last updated.
+}
+
+  updateMask: string, Optional. `update_mask` is used to specify the fields to be overwritten in the SemanticGovernancePolicy resource by the update. The fields specified in the `update_mask` are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the mask is not present, then all fields that are populated in the request message will be overwritten. Set the `update_mask` to `*` to override all fields.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.semanticGovernancePolicyEngine.html b/docs/dyn/aiplatform_v1beta1.projects.locations.semanticGovernancePolicyEngine.html index 07893b5f3e..b6caa0094b 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.semanticGovernancePolicyEngine.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.semanticGovernancePolicyEngine.html @@ -74,18 +74,57 @@

Agent Platform API . projects . locations . semanticGovernancePolicyEngine

Instance Methods

-

- operations() -

-

Returns the operations Resource.

-

close()

Close httplib2 connections.

+

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

+

Deprovisions the SemanticGovernancePolicyEngine, tearing down the associated tenant project, GKE cluster, and PSC service attachments. This operation is irreversible. Returns a long-running operation; poll for completion. The response contains the SemanticGovernancePolicyEngine in DEPROVISIONING state.

Method Details

close()
Close httplib2 connections.
+
+ deprovision(name, body=None, x__xgafv=None) +
Deprovisions the SemanticGovernancePolicyEngine, tearing down the associated tenant project, GKE cluster, and PSC service attachments. This operation is irreversible. Returns a long-running operation; poll for completion. The response contains the SemanticGovernancePolicyEngine in DEPROVISIONING state.
+
+Args:
+  name: string, Required. The resource name of the SemanticGovernancePolicyEngine to deprovision. Format: projects/{project}/locations/{location}/semanticGovernancePolicyEngine (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for SemanticGovernancePolicyEngineService.DeprovisionSemanticGovernancePolicyEngine.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.skills.html b/docs/dyn/aiplatform_v1beta1.projects.locations.skills.html index be0d000cdb..05a1b2ec7b 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.skills.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.skills.html @@ -140,7 +140,7 @@

Method Details

"zippedFilesystem": "A String", # Required. Provides the zipped filesystem of the Skill. This should contain the `SKILL.md` file at the root of the zip and optional directories for scripts, references, and assets. Directory should align with the directory structure specified at https://agentskills.io/specification#directory-structure. } - skillId: string, Optional. The ID to use for the Skill, which will become the final component of the Skill's resource name. If not provided, a system-generated ID will be used. This value must be 1-63 characters. Valid characters are lowercase letters, numbers, and hyphens. The first character must be a lowercase letter, and the last character must be a lowercase letter or a number. Specifically, the ID must match the regular expression: `^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$` See [AIP-122](https://aip.dev/122#resource-id-segments) for more details. + skillId: string, Required. The ID to use for the Skill, which will become the final component of the Skill's resource name. If not provided, a system-generated ID will be used. This value must be 1-63 characters. Valid characters are lowercase letters, numbers, and hyphens. The first character must be a lowercase letter, and the last character must be a lowercase letter or a number. Specifically, the ID must match the regular expression: `^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$` See [AIP-122](https://aip.dev/122#resource-id-segments) for more details. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.skills.revisions.html b/docs/dyn/aiplatform_v1beta1.projects.locations.skills.revisions.html index ca8fa2b445..f691dd9f9f 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.skills.revisions.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.skills.revisions.html @@ -109,7 +109,7 @@

Method Details

{ # A revision of a Skill. "createTime": "A String", # Output only. Timestamp when this Skill Revision was created. "name": "A String", # Identifier. The resource name of the Skill Revision. Format: `projects/{project}/locations/{location}/skills/{skill}/revisions/{revision}` - "skill": { # A skill. # Output only. The state of the Skill at this revision. TODO(b/503772996) Use a different proto for skill data included in skill revision + "skill": { # A skill. # Output only. The state of the Skill at this revision. "compatibility": "A String", # Optional. Specifies the compatibility of the Skill. Indicates environment requirements (intended product, system packages, network access, etc.). This should align with `compatibility` in the `SKILL.md` file. "createTime": "A String", # Output only. Timestamp when this Skill was created. "description": "A String", # Required. Describes the Skill. Should describe both what the skill does and when to use it. Should include specific keywords that help agents identify relevant tasks. This should align with `description` in the `SKILL.md` file. @@ -152,7 +152,7 @@

Method Details

{ # A revision of a Skill. "createTime": "A String", # Output only. Timestamp when this Skill Revision was created. "name": "A String", # Identifier. The resource name of the Skill Revision. Format: `projects/{project}/locations/{location}/skills/{skill}/revisions/{revision}` - "skill": { # A skill. # Output only. The state of the Skill at this revision. TODO(b/503772996) Use a different proto for skill data included in skill revision + "skill": { # A skill. # Output only. The state of the Skill at this revision. "compatibility": "A String", # Optional. Specifies the compatibility of the Skill. Indicates environment requirements (intended product, system packages, network access, etc.). This should align with `compatibility` in the `SKILL.md` file. "createTime": "A String", # Output only. Timestamp when this Skill was created. "description": "A String", # Required. Describes the Skill. Should describe both what the skill does and when to use it. Should include specific keywords that help agents identify relevant tasks. This should align with `description` in the `SKILL.md` file. diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.tuningJobs.html b/docs/dyn/aiplatform_v1beta1.projects.locations.tuningJobs.html index f0ac2009b2..1af3a30c34 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.tuningJobs.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.tuningJobs.html @@ -100,6 +100,9 @@

Instance Methods

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

Optimizes a prompt. Given a prompt, this method returns a stream of optimized prompts expanded from the original prompt.

+

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

+

Processes data from a user's Cloud Storage bucket and saves the result to a destination Cloud Storage bucket. This method returns a long-running operation, and the `ProcessDataResponse` will be returned upon completion.

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

Rebase a tuned model. A rebase operation takes a model that was previously tuned on a base model version, and retunes it on a new base model version. The rebase operation creates a new tuning job and a new tuned model.

@@ -5632,6 +5635,58 @@

Method Details

}
+
+ processData(parent, body=None, x__xgafv=None) +
Processes data from a user's Cloud Storage bucket and saves the result to a destination Cloud Storage bucket. This method returns a long-running operation, and the `ProcessDataResponse` will be returned upon completion.
+
+Args:
+  parent: string, Required. The resource name of the Location to process the data in. Format: `projects/{project}/locations/{location}` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for GenAiTuningService.ProcessData.
+  "gcsDestination": { # The Google Cloud Storage location where the output is to be written to. # Optional. The GCS bucket to store the processed videos and captions data.
+    "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.
+  },
+  "gcsSource": { # The Google Cloud Storage location for the input content. # Optional. A JSONL file containing a list of files to process stored in the user's GCS bucket.
+    "uris": [ # Required. Google Cloud Storage URI(-s) to the input file(s). May contain wildcards. For more information on wildcards, see https://cloud.google.com/storage/docs/wildcards.
+      "A String",
+    ],
+  },
+  "veoSpec": { # Spec for Veo data processing. # Optional. Spec for Veo data processing.
+    "processType": "A String", # Optional. The type of data processing to perform.
+  },
+}
+
+  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.
+  },
+}
+
+
rebaseTunedModel(parent, body=None, x__xgafv=None)
Rebase a tuned model. A rebase operation takes a model that was previously tuned on a base model version, and retunes it on a new base model version. The rebase operation creates a new tuning job and a new tuned model.
diff --git a/docs/dyn/aiplatform_v1beta1.publishers.models.html b/docs/dyn/aiplatform_v1beta1.publishers.models.html
index e28dbd445e..bdc5965468 100644
--- a/docs/dyn/aiplatform_v1beta1.publishers.models.html
+++ b/docs/dyn/aiplatform_v1beta1.publishers.models.html
@@ -530,6 +530,12 @@ 

Method Details

"A String", ], }, + "exaAiSearch": { # ExaAiSearch tool type. A tool that uses the Exa.ai search engine for grounding. # Optional. Uses Exa.ai to search for information to answer user queries. The search results will be grounded on Exa.ai and presented to the model for response generation + "apiKey": "A String", # Required. The API key for ExaAiSearch. + "customConfigs": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. + "a_key": "", # Properties of the object. + }, + }, "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "behavior": "A String", # Optional. Specifies the function Behavior. If not specified, the system keeps the current function call behavior. This field is currently only supported by the BidiGenerateContent method. @@ -1129,6 +1135,12 @@

Method Details

"A String", ], }, + "exaAiSearch": { # ExaAiSearch tool type. A tool that uses the Exa.ai search engine for grounding. # Optional. Uses Exa.ai to search for information to answer user queries. The search results will be grounded on Exa.ai and presented to the model for response generation + "apiKey": "A String", # Required. The API key for ExaAiSearch. + "customConfigs": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. + "a_key": "", # Properties of the object. + }, + }, "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "behavior": "A String", # Optional. Specifies the function Behavior. If not specified, the system keeps the current function call behavior. This field is currently only supported by the BidiGenerateContent method. @@ -3292,6 +3304,12 @@

Method Details

"A String", ], }, + "exaAiSearch": { # ExaAiSearch tool type. A tool that uses the Exa.ai search engine for grounding. # Optional. Uses Exa.ai to search for information to answer user queries. The search results will be grounded on Exa.ai and presented to the model for response generation + "apiKey": "A String", # Required. The API key for ExaAiSearch. + "customConfigs": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. + "a_key": "", # Properties of the object. + }, + }, "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "behavior": "A String", # Optional. Specifies the function Behavior. If not specified, the system keeps the current function call behavior. This field is currently only supported by the BidiGenerateContent method. diff --git a/docs/dyn/aiplatform_v1beta1.reasoningEngines.memories.html b/docs/dyn/aiplatform_v1beta1.reasoningEngines.memories.html index bbda6cbc8e..52cbb8003a 100644 --- a/docs/dyn/aiplatform_v1beta1.reasoningEngines.memories.html +++ b/docs/dyn/aiplatform_v1beta1.reasoningEngines.memories.html @@ -732,7 +732,7 @@

Method Details

"updateTime": "A String", # Output only. Represents the timestamp when this Memory was most recently updated. } - updateMask: string, Optional. Mask specifying which fields to update. Supported fields: * `display_name` * `description` * `fact` + updateMask: string, Optional. Mask specifying which fields to update. The following fields are immutable: * `scope` * `memory_type` x__xgafv: string, V1 error format. Allowed values 1 - v1 error format diff --git a/docs/dyn/aiplatform_v1beta1.reasoningEngines.sandboxEnvironmentTemplates.html b/docs/dyn/aiplatform_v1beta1.reasoningEngines.sandboxEnvironmentTemplates.html index 6a3f447a52..8d5df403ca 100644 --- a/docs/dyn/aiplatform_v1beta1.reasoningEngines.sandboxEnvironmentTemplates.html +++ b/docs/dyn/aiplatform_v1beta1.reasoningEngines.sandboxEnvironmentTemplates.html @@ -135,6 +135,14 @@

Method Details

}, "defaultContainerEnvironment": { # The default sandbox runtime environment for default container workloads. # The sandbox environment for default container workloads. "defaultContainerCategory": "A String", # Required. The category of the default container image. + "resources": { # Message to define resource requests and limits (mirroring Kubernetes) for each sandbox instance created from this template. # Optional. Resource requests and limits for the default container. + "limits": { # Optional. The maximum amounts of compute resources allowed. Keys are resource names (e.g., "cpu", "memory"). Values are quantities (e.g., "500m", "1Gi"). + "a_key": "A String", + }, + "requests": { # Optional. The requested amounts of compute resources. Keys are resource names (e.g., "cpu", "memory"). Values are quantities (e.g., "250m", "512Mi"). + "a_key": "A String", + }, + }, }, "displayName": "A String", # Required. The display name of the SandboxEnvironmentTemplate. "egressControlConfig": { # Configuration for egress control of sandbox instances. # Optional. The configuration for egress control of this template. @@ -246,6 +254,14 @@

Method Details

}, "defaultContainerEnvironment": { # The default sandbox runtime environment for default container workloads. # The sandbox environment for default container workloads. "defaultContainerCategory": "A String", # Required. The category of the default container image. + "resources": { # Message to define resource requests and limits (mirroring Kubernetes) for each sandbox instance created from this template. # Optional. Resource requests and limits for the default container. + "limits": { # Optional. The maximum amounts of compute resources allowed. Keys are resource names (e.g., "cpu", "memory"). Values are quantities (e.g., "500m", "1Gi"). + "a_key": "A String", + }, + "requests": { # Optional. The requested amounts of compute resources. Keys are resource names (e.g., "cpu", "memory"). Values are quantities (e.g., "250m", "512Mi"). + "a_key": "A String", + }, + }, }, "displayName": "A String", # Required. The display name of the SandboxEnvironmentTemplate. "egressControlConfig": { # Configuration for egress control of sandbox instances. # Optional. The configuration for egress control of this template. @@ -300,6 +316,14 @@

Method Details

}, "defaultContainerEnvironment": { # The default sandbox runtime environment for default container workloads. # The sandbox environment for default container workloads. "defaultContainerCategory": "A String", # Required. The category of the default container image. + "resources": { # Message to define resource requests and limits (mirroring Kubernetes) for each sandbox instance created from this template. # Optional. Resource requests and limits for the default container. + "limits": { # Optional. The maximum amounts of compute resources allowed. Keys are resource names (e.g., "cpu", "memory"). Values are quantities (e.g., "500m", "1Gi"). + "a_key": "A String", + }, + "requests": { # Optional. The requested amounts of compute resources. Keys are resource names (e.g., "cpu", "memory"). Values are quantities (e.g., "250m", "512Mi"). + "a_key": "A String", + }, + }, }, "displayName": "A String", # Required. The display name of the SandboxEnvironmentTemplate. "egressControlConfig": { # Configuration for egress control of sandbox instances. # Optional. The configuration for egress control of this template. diff --git a/docs/dyn/aiplatform_v1beta1.v1beta1.html b/docs/dyn/aiplatform_v1beta1.v1beta1.html index 607a7de3e8..09c954c05b 100644 --- a/docs/dyn/aiplatform_v1beta1.v1beta1.html +++ b/docs/dyn/aiplatform_v1beta1.v1beta1.html @@ -903,6 +903,12 @@

Method Details

"A String", ], }, + "exaAiSearch": { # ExaAiSearch tool type. A tool that uses the Exa.ai search engine for grounding. # Optional. Uses Exa.ai to search for information to answer user queries. The search results will be grounded on Exa.ai and presented to the model for response generation + "apiKey": "A String", # Required. The API key for ExaAiSearch. + "customConfigs": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. + "a_key": "", # Properties of the object. + }, + }, "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "behavior": "A String", # Optional. Specifies the function Behavior. If not specified, the system keeps the current function call behavior. This field is currently only supported by the BidiGenerateContent method. @@ -1222,6 +1228,12 @@

Method Details

"A String", ], }, + "exaAiSearch": { # ExaAiSearch tool type. A tool that uses the Exa.ai search engine for grounding. # Optional. Uses Exa.ai to search for information to answer user queries. The search results will be grounded on Exa.ai and presented to the model for response generation + "apiKey": "A String", # Required. The API key for ExaAiSearch. + "customConfigs": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. + "a_key": "", # Properties of the object. + }, + }, "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "behavior": "A String", # Optional. Specifies the function Behavior. If not specified, the system keeps the current function call behavior. This field is currently only supported by the BidiGenerateContent method. @@ -1614,6 +1626,12 @@

Method Details

"A String", ], }, + "exaAiSearch": { # ExaAiSearch tool type. A tool that uses the Exa.ai search engine for grounding. # Optional. Uses Exa.ai to search for information to answer user queries. The search results will be grounded on Exa.ai and presented to the model for response generation + "apiKey": "A String", # Required. The API key for ExaAiSearch. + "customConfigs": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. + "a_key": "", # Properties of the object. + }, + }, "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "behavior": "A String", # Optional. Specifies the function Behavior. If not specified, the system keeps the current function call behavior. This field is currently only supported by the BidiGenerateContent method. @@ -1844,6 +1862,12 @@

Method Details

"A String", ], }, + "exaAiSearch": { # ExaAiSearch tool type. A tool that uses the Exa.ai search engine for grounding. # Optional. Uses Exa.ai to search for information to answer user queries. The search results will be grounded on Exa.ai and presented to the model for response generation + "apiKey": "A String", # Required. The API key for ExaAiSearch. + "customConfigs": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. + "a_key": "", # Properties of the object. + }, + }, "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "behavior": "A String", # Optional. Specifies the function Behavior. If not specified, the system keeps the current function call behavior. This field is currently only supported by the BidiGenerateContent method. @@ -2166,6 +2190,12 @@

Method Details

"A String", ], }, + "exaAiSearch": { # ExaAiSearch tool type. A tool that uses the Exa.ai search engine for grounding. # Optional. Uses Exa.ai to search for information to answer user queries. The search results will be grounded on Exa.ai and presented to the model for response generation + "apiKey": "A String", # Required. The API key for ExaAiSearch. + "customConfigs": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. + "a_key": "", # Properties of the object. + }, + }, "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "behavior": "A String", # Optional. Specifies the function Behavior. If not specified, the system keeps the current function call behavior. This field is currently only supported by the BidiGenerateContent method. @@ -2396,6 +2426,12 @@

Method Details

"A String", ], }, + "exaAiSearch": { # ExaAiSearch tool type. A tool that uses the Exa.ai search engine for grounding. # Optional. Uses Exa.ai to search for information to answer user queries. The search results will be grounded on Exa.ai and presented to the model for response generation + "apiKey": "A String", # Required. The API key for ExaAiSearch. + "customConfigs": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. + "a_key": "", # Properties of the object. + }, + }, "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "behavior": "A String", # Optional. Specifies the function Behavior. If not specified, the system keeps the current function call behavior. This field is currently only supported by the BidiGenerateContent method. @@ -4588,6 +4624,12 @@

Method Details

"A String", ], }, + "exaAiSearch": { # ExaAiSearch tool type. A tool that uses the Exa.ai search engine for grounding. # Optional. Uses Exa.ai to search for information to answer user queries. The search results will be grounded on Exa.ai and presented to the model for response generation + "apiKey": "A String", # Required. The API key for ExaAiSearch. + "customConfigs": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. + "a_key": "", # Properties of the object. + }, + }, "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "behavior": "A String", # Optional. Specifies the function Behavior. If not specified, the system keeps the current function call behavior. This field is currently only supported by the BidiGenerateContent method. diff --git a/docs/dyn/androidmanagement_v1.enterprises.devices.html b/docs/dyn/androidmanagement_v1.enterprises.devices.html index 80d47d3e0c..a44635518d 100644 --- a/docs/dyn/androidmanagement_v1.enterprises.devices.html +++ b/docs/dyn/androidmanagement_v1.enterprises.devices.html @@ -170,9 +170,14 @@

Method Details

], "packageName": "A String", # Package name of the app. "packageSha256Hash": "A String", # The SHA-256 hash of the app's APK file, which can be used to verify the app hasn't been modified. Each byte of the hash value is represented as a two-digit hexadecimal number. - "signingKeyCertFingerprints": [ # The SHA-1 hash of each android.content.pm.Signature (https://developer.android.com/reference/android/content/pm/Signature.html) associated with the app package. Each byte of each hash value is represented as a two-digit hexadecimal number. + "signingKeyCertFingerprints": [ # Deprecated. Use signingKeyCerts instead. The SHA-1 hash of each android.content.pm.Signature (https://developer.android.com/reference/android/content/pm/Signature.html) associated with the app package. Each byte of each hash value is represented as a two-digit hexadecimal number. "A String", ], + "signingKeyCerts": [ # Output only. Signing key certificates of the app. + { # The application signing key certificate. + "signingKeyCertFingerprintSha256": "A String", # Required. The SHA-256 hash value of the signing key certificate of the app. This must be a valid SHA-256 hash value, i.e. 32 bytes. + }, + ], "state": "A String", # Application state. "userFacingType": "A String", # Whether the app is user facing. "versionCode": 42, # The app version code, which can be used to determine whether one version is more recent than another. @@ -602,9 +607,14 @@

Method Details

], "packageName": "A String", # Package name of the app. "packageSha256Hash": "A String", # The SHA-256 hash of the app's APK file, which can be used to verify the app hasn't been modified. Each byte of the hash value is represented as a two-digit hexadecimal number. - "signingKeyCertFingerprints": [ # The SHA-1 hash of each android.content.pm.Signature (https://developer.android.com/reference/android/content/pm/Signature.html) associated with the app package. Each byte of each hash value is represented as a two-digit hexadecimal number. + "signingKeyCertFingerprints": [ # Deprecated. Use signingKeyCerts instead. The SHA-1 hash of each android.content.pm.Signature (https://developer.android.com/reference/android/content/pm/Signature.html) associated with the app package. Each byte of each hash value is represented as a two-digit hexadecimal number. "A String", ], + "signingKeyCerts": [ # Output only. Signing key certificates of the app. + { # The application signing key certificate. + "signingKeyCertFingerprintSha256": "A String", # Required. The SHA-256 hash value of the signing key certificate of the app. This must be a valid SHA-256 hash value, i.e. 32 bytes. + }, + ], "state": "A String", # Application state. "userFacingType": "A String", # Whether the app is user facing. "versionCode": 42, # The app version code, which can be used to determine whether one version is more recent than another. @@ -902,9 +912,14 @@

Method Details

], "packageName": "A String", # Package name of the app. "packageSha256Hash": "A String", # The SHA-256 hash of the app's APK file, which can be used to verify the app hasn't been modified. Each byte of the hash value is represented as a two-digit hexadecimal number. - "signingKeyCertFingerprints": [ # The SHA-1 hash of each android.content.pm.Signature (https://developer.android.com/reference/android/content/pm/Signature.html) associated with the app package. Each byte of each hash value is represented as a two-digit hexadecimal number. + "signingKeyCertFingerprints": [ # Deprecated. Use signingKeyCerts instead. The SHA-1 hash of each android.content.pm.Signature (https://developer.android.com/reference/android/content/pm/Signature.html) associated with the app package. Each byte of each hash value is represented as a two-digit hexadecimal number. "A String", ], + "signingKeyCerts": [ # Output only. Signing key certificates of the app. + { # The application signing key certificate. + "signingKeyCertFingerprintSha256": "A String", # Required. The SHA-256 hash value of the signing key certificate of the app. This must be a valid SHA-256 hash value, i.e. 32 bytes. + }, + ], "state": "A String", # Application state. "userFacingType": "A String", # Whether the app is user facing. "versionCode": 42, # The app version code, which can be used to determine whether one version is more recent than another. @@ -1184,9 +1199,14 @@

Method Details

], "packageName": "A String", # Package name of the app. "packageSha256Hash": "A String", # The SHA-256 hash of the app's APK file, which can be used to verify the app hasn't been modified. Each byte of the hash value is represented as a two-digit hexadecimal number. - "signingKeyCertFingerprints": [ # The SHA-1 hash of each android.content.pm.Signature (https://developer.android.com/reference/android/content/pm/Signature.html) associated with the app package. Each byte of each hash value is represented as a two-digit hexadecimal number. + "signingKeyCertFingerprints": [ # Deprecated. Use signingKeyCerts instead. The SHA-1 hash of each android.content.pm.Signature (https://developer.android.com/reference/android/content/pm/Signature.html) associated with the app package. Each byte of each hash value is represented as a two-digit hexadecimal number. "A String", ], + "signingKeyCerts": [ # Output only. Signing key certificates of the app. + { # The application signing key certificate. + "signingKeyCertFingerprintSha256": "A String", # Required. The SHA-256 hash value of the signing key certificate of the app. This must be a valid SHA-256 hash value, i.e. 32 bytes. + }, + ], "state": "A String", # Application state. "userFacingType": "A String", # Whether the app is user facing. "versionCode": 42, # The app version code, which can be used to determine whether one version is more recent than another. diff --git a/docs/dyn/androidpublisher_v3.generatedapks.html b/docs/dyn/androidpublisher_v3.generatedapks.html index 05f8bad958..51493ed238 100644 --- a/docs/dyn/androidpublisher_v3.generatedapks.html +++ b/docs/dyn/androidpublisher_v3.generatedapks.html @@ -139,7 +139,7 @@

Method Details

{ # Response to list generated APKs. "generatedApks": [ # All generated APKs, grouped by the APK signing key. - { # Download metadata for split, standalone and universal APKs, as well as asset pack slices, signed with a given key. Next ID: 10 + { # Download metadata for split, standalone and universal APKs, as well as asset pack slices, signed with a given key. "certificateSha256Hash": "A String", # SHA256 hash of the APK signing public key certificate. "generatedAssetPackSlices": [ # List of asset pack slices which will be served for this app bundle, signed with a key corresponding to certificate_sha256_hash. { # Download metadata for an asset pack slice. diff --git a/docs/dyn/androidpublisher_v3.orders.html b/docs/dyn/androidpublisher_v3.orders.html index ce8992b4bb..1f6fb447e0 100644 --- a/docs/dyn/androidpublisher_v3.orders.html +++ b/docs/dyn/androidpublisher_v3.orders.html @@ -140,7 +140,7 @@

Method Details

"subscriptionDetails": { # Details of a subscription purchase. # Details of a subscription purchase. "basePlanId": "A String", # The base plan ID of the subscription. "offerId": "A String", # The offer ID for the current subscription offer. - "offerPhase": "A String", # The pricing phase for the billing period funded by this order. Deprecated. Use offer_phase_details instead. + "offerPhase": "A String", # Deprecated: Use offer_phase_details instead. The pricing phase for the billing period funded by this order. "offerPhaseDetails": { # Details of a pricing phase for the entitlement period funded by this order. # The pricing phase details for the entitlement period funded by this order. "baseDetails": { # Details of a base price pricing phase. # The order funds a base price period. }, @@ -298,7 +298,7 @@

Method Details

"subscriptionDetails": { # Details of a subscription purchase. # Details of a subscription purchase. "basePlanId": "A String", # The base plan ID of the subscription. "offerId": "A String", # The offer ID for the current subscription offer. - "offerPhase": "A String", # The pricing phase for the billing period funded by this order. Deprecated. Use offer_phase_details instead. + "offerPhase": "A String", # Deprecated: Use offer_phase_details instead. The pricing phase for the billing period funded by this order. "offerPhaseDetails": { # Details of a pricing phase for the entitlement period funded by this order. # The pricing phase details for the entitlement period funded by this order. "baseDetails": { # Details of a base price pricing phase. # The order funds a base price period. }, diff --git a/docs/dyn/androidpublisher_v3.purchases.subscriptions.html b/docs/dyn/androidpublisher_v3.purchases.subscriptions.html index 585b31d7b0..d55a5df645 100644 --- a/docs/dyn/androidpublisher_v3.purchases.subscriptions.html +++ b/docs/dyn/androidpublisher_v3.purchases.subscriptions.html @@ -79,13 +79,13 @@

Instance Methods

Acknowledges a subscription purchase.

cancel(packageName, subscriptionId, token, x__xgafv=None)

-

Cancels a user's subscription purchase. The subscription remains valid until its expiration time. Newer version is available at purchases.subscriptionsv2.cancel for better client library support.

+

Deprecated: Use purchases.subscriptionsv2.cancel instead. Cancels a user's subscription purchase. The subscription remains valid until its expiration time. Newer version is available at purchases.subscriptionsv2.cancel for better client library support.

close()

Close httplib2 connections.

defer(packageName, subscriptionId, token, body=None, x__xgafv=None)

-

Defers a user's subscription purchase until a specified future expiration time.

+

Deprecated: Use purchases.subscriptionsv2.defer instead. Defers a user's subscription purchase until a specified future expiration time.

get(packageName, subscriptionId, token, x__xgafv=None)

Deprecated: Use purchases.subscriptionsv2.get instead. Checks whether a user's subscription purchase is valid and returns its expiry time.

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

Method Details

cancel(packageName, subscriptionId, token, x__xgafv=None) -
Cancels a user's subscription purchase. The subscription remains valid until its expiration time. Newer version is available at purchases.subscriptionsv2.cancel for better client library support.
+  
Deprecated: Use purchases.subscriptionsv2.cancel instead. Cancels a user's subscription purchase. The subscription remains valid until its expiration time. Newer version is available at purchases.subscriptionsv2.cancel for better client library support.
 
 Args:
   packageName: string, The package name of the application for which this subscription was purchased (for example, 'com.some.thing'). (required)
@@ -144,7 +144,7 @@ 

Method Details

defer(packageName, subscriptionId, token, body=None, x__xgafv=None) -
Defers a user's subscription purchase until a specified future expiration time.
+  
Deprecated: Use purchases.subscriptionsv2.defer instead. Defers a user's subscription purchase until a specified future expiration time.
 
 Args:
   packageName: string, The package name of the application for which this subscription was purchased (for example, 'com.some.thing'). (required)
@@ -189,7 +189,7 @@ 

Method Details

Returns: An object of the form: - { # A SubscriptionPurchase resource indicates the status of a user's subscription purchase. + { # Deprecated: Use SubscriptionPurchaseV2 instead. A SubscriptionPurchase resource indicates the status of a user's subscription purchase. "acknowledgementState": 42, # The acknowledgement state of the subscription product. Possible values are: 0. Yet to be acknowledged 1. Acknowledged "autoRenewing": True or False, # Whether the subscription will automatically be renewed when it reaches its current expiry time. "autoResumeTimeMillis": "A String", # Time at which the subscription will be automatically resumed, in milliseconds since the Epoch. Only present if the user has requested to pause the subscription. diff --git a/docs/dyn/androidpublisher_v3.purchases.subscriptionsv2.html b/docs/dyn/androidpublisher_v3.purchases.subscriptionsv2.html index 9eda747c72..6f2274eb03 100644 --- a/docs/dyn/androidpublisher_v3.purchases.subscriptionsv2.html +++ b/docs/dyn/androidpublisher_v3.purchases.subscriptionsv2.html @@ -197,6 +197,11 @@

Method Details

"obfuscatedExternalAccountId": "A String", # An obfuscated version of the id that is uniquely associated with the user's account in your app. Present for the following purchases: * If account linking happened as part of the subscription purchase flow. * It was specified using https://developer.android.com/reference/com/android/billingclient/api/BillingFlowParams.Builder#setobfuscatedaccountid when the purchase was made. "obfuscatedExternalProfileId": "A String", # An obfuscated version of the id that is uniquely associated with the user's profile in your app. Only present if specified using https://developer.android.com/reference/com/android/billingclient/api/BillingFlowParams.Builder#setobfuscatedprofileid when the purchase was made. }, + "inGracePeriodStateContext": { # Additional context around subscriptions in IN_GRACE_PERIOD state. # Optional. Additional context around subscriptions in IN_GRACE_PERIOD state. Only present if the subscription currently has subscription_state SUBSCRIPTION_STATE_IN_GRACE_PERIOD. + "renewalDeclined": { # Context related to renewal declined scenario. # Optional. The payment for the renewal was declined. + "pendingOrderId": "A String", # Required. The ID of the pending or failed order causing the state. + }, + }, "kind": "A String", # This kind represents a SubscriptionPurchaseV2 object in the androidpublisher service. "latestOrderId": "A String", # Deprecated: Use line_items.latest_successful_order_id instead. The order id of the latest order associated with the purchase of the subscription. For autoRenewing subscription, this is the order id of signup order if it is not renewed yet, or the last recurring order id (success, pending, or declined order). For prepaid subscription, this is the order id associated with the queried purchase token. "lineItems": [ # Item-level info for a subscription purchase. The items in the same purchase should be either all with AutoRenewingPlan or all with PrepaidPlan. @@ -280,6 +285,11 @@

Method Details

}, ], "linkedPurchaseToken": "A String", # The purchase token of the old subscription if this subscription is one of the following: * Re-signup of a canceled but non-lapsed subscription * Upgrade/downgrade from a previous subscription. * Convert from prepaid to auto renewing subscription. * Convert from an auto renewing subscription to prepaid. * Topup a prepaid subscription. + "onHoldStateContext": { # Additional context around subscriptions in ON_HOLD state. # Optional. Additional context around subscriptions in ON_HOLD state. Only present if the subscription currently has subscription_state SUBSCRIPTION_STATE_ON_HOLD. + "renewalDeclined": { # Context related to renewal declined scenario. # Optional. The payment for the renewal was declined. + "pendingOrderId": "A String", # Required. The ID of the pending or failed order causing the state. + }, + }, "outOfAppPurchaseContext": { # Information specific to an out of app purchase. # Additional context for out of app purchases. This information is only present for re-subscription purchases (subscription purchases made after the previous subscription of the same product has expired) made through the Google Play subscriptions center. This field will be removed after you acknowledge the subscription. "expiredExternalAccountIdentifiers": { # User account identifier in the third-party service. # User account identifier from the last expired subscription for this SKU. "externalAccountId": "A String", # User account identifier in the third-party service. Only present if account linking happened as part of the subscription purchase flow. diff --git a/docs/dyn/apphub_v1.projects.locations.applications.html b/docs/dyn/apphub_v1.projects.locations.applications.html index 091cf0750f..c94e2a82fd 100644 --- a/docs/dyn/apphub_v1.projects.locations.applications.html +++ b/docs/dyn/apphub_v1.projects.locations.applications.html @@ -466,7 +466,7 @@

Method Details

} requestId: string, Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). - updateMask: string, Required. Field mask is used to specify the fields to be overwritten in the Application resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. The API changes the values of the fields as specified in the update_mask. The API ignores the values of all fields not covered by the update_mask. You can also unset a field by not specifying it in the updated message, but adding the field to the mask. This clears whatever value the field previously had. + updateMask: string, Optional. Field mask is used to specify the fields to be overwritten in the Application resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. The API changes the values of the fields as specified in the update_mask. The API ignores the values of all fields not covered by the update_mask. You can also unset a field by not specifying it in the updated message, but adding the field to the mask. This clears whatever value the field previously had. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format diff --git a/docs/dyn/apphub_v1.projects.locations.applications.services.html b/docs/dyn/apphub_v1.projects.locations.applications.services.html index fbd3d66499..3c1ed75af5 100644 --- a/docs/dyn/apphub_v1.projects.locations.applications.services.html +++ b/docs/dyn/apphub_v1.projects.locations.applications.services.html @@ -487,7 +487,7 @@

Method Details

} requestId: string, Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). - updateMask: string, Required. Field mask is used to specify the fields to be overwritten in the Service resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. The API changes the values of the fields as specified in the update_mask. The API ignores the values of all fields not covered by the update_mask. You can also unset a field by not specifying it in the updated message, but adding the field to the mask. This clears whatever value the field previously had. + updateMask: string, Optional. Field mask is used to specify the fields to be overwritten in the Service resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. The API changes the values of the fields as specified in the update_mask. The API ignores the values of all fields not covered by the update_mask. You can also unset a field by not specifying it in the updated message, but adding the field to the mask. This clears whatever value the field previously had. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format diff --git a/docs/dyn/apphub_v1.projects.locations.applications.workloads.html b/docs/dyn/apphub_v1.projects.locations.applications.workloads.html index 993dd8e168..6818dd6334 100644 --- a/docs/dyn/apphub_v1.projects.locations.applications.workloads.html +++ b/docs/dyn/apphub_v1.projects.locations.applications.workloads.html @@ -475,7 +475,7 @@

Method Details

} requestId: string, Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). - updateMask: string, Required. Field mask is used to specify the fields to be overwritten in the Workload resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. The API changes the values of the fields as specified in the update_mask. The API ignores the values of all fields not covered by the update_mask. You can also unset a field by not specifying it in the updated message, but adding the field to the mask. This clears whatever value the field previously had. + updateMask: string, Optional. Field mask is used to specify the fields to be overwritten in the Workload resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. The API changes the values of the fields as specified in the update_mask. The API ignores the values of all fields not covered by the update_mask. You can also unset a field by not specifying it in the updated message, but adding the field to the mask. This clears whatever value the field previously had. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format diff --git a/docs/dyn/apphub_v1.projects.locations.html b/docs/dyn/apphub_v1.projects.locations.html index 18552be9ed..59b7614d3c 100644 --- a/docs/dyn/apphub_v1.projects.locations.html +++ b/docs/dyn/apphub_v1.projects.locations.html @@ -301,7 +301,7 @@

Method Details

} requestId: string, Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). - updateMask: string, Required. Field mask is used to specify the fields to be overwritten in the Boundary resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten. + updateMask: string, Optional. Field mask is used to specify the fields to be overwritten in the Boundary resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format diff --git a/docs/dyn/apphub_v1alpha.projects.locations.applications.html b/docs/dyn/apphub_v1alpha.projects.locations.applications.html index a8918cdce7..3c3299db50 100644 --- a/docs/dyn/apphub_v1alpha.projects.locations.applications.html +++ b/docs/dyn/apphub_v1alpha.projects.locations.applications.html @@ -514,7 +514,7 @@

Method Details

} requestId: string, Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). - updateMask: string, Required. Field mask is used to specify the fields to be overwritten in the Application resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. The API changes the values of the fields as specified in the update_mask. The API ignores the values of all fields not covered by the update_mask. You can also unset a field by not specifying it in the updated message, but adding the field to the mask. This clears whatever value the field previously had. + updateMask: string, Optional. Field mask is used to specify the fields to be overwritten in the Application resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. The API changes the values of the fields as specified in the update_mask. The API ignores the values of all fields not covered by the update_mask. You can also unset a field by not specifying it in the updated message, but adding the field to the mask. This clears whatever value the field previously had. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format diff --git a/docs/dyn/apphub_v1alpha.projects.locations.applications.services.html b/docs/dyn/apphub_v1alpha.projects.locations.applications.services.html index cc0f0508df..02bbf8d3fb 100644 --- a/docs/dyn/apphub_v1alpha.projects.locations.applications.services.html +++ b/docs/dyn/apphub_v1alpha.projects.locations.applications.services.html @@ -539,7 +539,7 @@

Method Details

} requestId: string, Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). - updateMask: string, Required. Field mask is used to specify the fields to be overwritten in the Service resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. The API changes the values of the fields as specified in the update_mask. The API ignores the values of all fields not covered by the update_mask. You can also unset a field by not specifying it in the updated message, but adding the field to the mask. This clears whatever value the field previously had. + updateMask: string, Optional. Field mask is used to specify the fields to be overwritten in the Service resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. The API changes the values of the fields as specified in the update_mask. The API ignores the values of all fields not covered by the update_mask. You can also unset a field by not specifying it in the updated message, but adding the field to the mask. This clears whatever value the field previously had. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format diff --git a/docs/dyn/apphub_v1alpha.projects.locations.applications.workloads.html b/docs/dyn/apphub_v1alpha.projects.locations.applications.workloads.html index 7f95d45e20..38c617b8bb 100644 --- a/docs/dyn/apphub_v1alpha.projects.locations.applications.workloads.html +++ b/docs/dyn/apphub_v1alpha.projects.locations.applications.workloads.html @@ -523,7 +523,7 @@

Method Details

} requestId: string, Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). - updateMask: string, Required. Field mask is used to specify the fields to be overwritten in the Workload resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. The API changes the values of the fields as specified in the update_mask. The API ignores the values of all fields not covered by the update_mask. You can also unset a field by not specifying it in the updated message, but adding the field to the mask. This clears whatever value the field previously had. + updateMask: string, Optional. Field mask is used to specify the fields to be overwritten in the Workload resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. The API changes the values of the fields as specified in the update_mask. The API ignores the values of all fields not covered by the update_mask. You can also unset a field by not specifying it in the updated message, but adding the field to the mask. This clears whatever value the field previously had. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format diff --git a/docs/dyn/apphub_v1alpha.projects.locations.html b/docs/dyn/apphub_v1alpha.projects.locations.html index 0930a657f9..e7d9c06e94 100644 --- a/docs/dyn/apphub_v1alpha.projects.locations.html +++ b/docs/dyn/apphub_v1alpha.projects.locations.html @@ -301,7 +301,7 @@

Method Details

} requestId: string, Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). - updateMask: string, Required. Field mask is used to specify the fields to be overwritten in the Boundary resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten. + updateMask: string, Optional. Field mask is used to specify the fields to be overwritten in the Boundary resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format diff --git a/docs/dyn/artifactregistry_v1.projects.locations.html b/docs/dyn/artifactregistry_v1.projects.locations.html index 4446667285..0bda179824 100644 --- a/docs/dyn/artifactregistry_v1.projects.locations.html +++ b/docs/dyn/artifactregistry_v1.projects.locations.html @@ -98,7 +98,7 @@

Instance Methods

Retrieves the VPCSC Config for the Project.

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

-

Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the [ListLocationsRequest.name] field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.

+

Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the ListLocationsRequest.name field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.

list_next()

Retrieves the next page of results.

@@ -186,11 +186,11 @@

Method Details

list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None) -
Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the [ListLocationsRequest.name] field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.
+  
Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the ListLocationsRequest.name field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.
 
 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. Do not use this field 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/artifactregistry_v1.projects.locations.repositories.html b/docs/dyn/artifactregistry_v1.projects.locations.repositories.html
index fc6e5ec206..63f304fcd2 100644
--- a/docs/dyn/artifactregistry_v1.projects.locations.repositories.html
+++ b/docs/dyn/artifactregistry_v1.projects.locations.repositories.html
@@ -129,6 +129,11 @@ 

Instance Methods

Returns the packages Resource.

+

+ prewarmedArtifacts() +

+

Returns the prewarmedArtifacts Resource.

+

pythonPackages()

@@ -144,6 +149,9 @@

Instance Methods

Returns the yumArtifacts Resource.

+

+ checkPrewarmedArtifact(repository, body=None, x__xgafv=None)

+

Checks an artifact streaming.

close()

Close httplib2 connections.

@@ -171,6 +179,12 @@

Instance Methods

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

Updates a repository.

+

+ prewarmArtifact(repository, body=None, x__xgafv=None)

+

Prewarms an artifact for streaming.

+

+ removePrewarmedArtifact(repository, body=None, x__xgafv=None)

+

Removes an artifact from streaming.

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

Updates the IAM policy for a given resource.

@@ -178,6 +192,38 @@

Instance Methods

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

Tests if the caller has a list of permissions on a resource.

Method Details

+
+ checkPrewarmedArtifact(repository, body=None, x__xgafv=None) +
Checks an artifact streaming.
+
+Args:
+  repository: string, Required. The name of the repository, for example: `projects/p1/locations/us-central1/repositories/repo1`. If the package or version ID parts contain slashes, the slashes are escaped. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # The request for checking an artifact for streaming.
+  "streamLocation": "A String", # Optional. The location of the prewarmed artifact. multi-region is not supported for this field.
+  "tag": "A String", # Optional. The artifact tag Format:projects/{project}/locations/{location}/repositories/{repository}/packages/{package}/tags/{tag}
+  "version": "A String", # Optional. The artifact version Format: projects/{project}/locations/{location}/repositories/{repository}/packages/{package}/versions/{version}
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The response for checking an artifact for streaming.
+  "prewarmedArtifact": { # PrewarmedArtifact represents a streamed artifact. # The prewarmed artifact that was checked.
+    "expirationTime": "A String", # The expiration time of the prewarmed artifact.
+    "location": "A String", # The location of the prewarmed artifact.
+    "uri": "A String", # URL to access the image. Example: us-west4-docker.pkg.dev/test-project/test-repo/nginx@sha256:e9954c1fc875017be1c3e36eca16be2d9e9bccc4bf072163515467d6a823c7cf
+  },
+}
+
+
close()
Close httplib2 connections.
@@ -1038,6 +1084,84 @@

Method Details

}
+
+ prewarmArtifact(repository, body=None, x__xgafv=None) +
Prewarms an artifact for streaming.
+
+Args:
+  repository: string, Required. The repository name, for example: `projects/p1/locations/us-central1/repositories/repo1`. If the package or version ID parts contain slashes, the slashes are escaped. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # The request for prewarming an artifact for streaming.
+  "force": True or False, # Optional. If true, old artifact will be evicted to make room for the new artifact.
+  "retentionDays": "A String", # Optional. The retention days of the prewarmed artifact. If not specified, the artifact will be cached for 3 days.
+  "streamLocation": "A String", # Optional. The location to cache the artifact in. If not specified, the artifact will be cached in the same location as the artifact. multi-region is not supported for this field.
+  "tag": "A String", # Optional. The artifact tag Format:projects/{project}/locations/{location}/repositories/{repository}/packages/{package}/tags/{tag}
+  "version": "A String", # Optional. The artifact version Format: projects/{project}/locations/{location}/repositories/{repository}/packages/{package}/versions/{version}
+}
+
+  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.
+  },
+}
+
+ +
+ removePrewarmedArtifact(repository, body=None, x__xgafv=None) +
Removes an artifact from streaming.
+
+Args:
+  repository: string, Required. The repository name, for example: `projects/p1/locations/us-central1/repositories/repo1`. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # The request for removing an artifact from streaming.
+  "streamLocation": "A String", # Optional. The location of the prewarmed artifact. multi-region is not supported for this field.
+  "tag": "A String", # Optional. The artifact tag Format:projects/{project}/locations/{location}/repositories/{repository}/packages/{package}/tags/{tag}
+  "version": "A String", # Optional. The artifact version Format: projects/{project}/locations/{location}/repositories/{repository}/packages/{package}/versions/{version}
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The response for removing an artifact from streaming.
+  "prewarmedArtifact": { # PrewarmedArtifact represents a streamed artifact. # The prewarmed artifact that was removed.
+    "expirationTime": "A String", # The expiration time of the prewarmed artifact.
+    "location": "A String", # The location of the prewarmed artifact.
+    "uri": "A String", # URL to access the image. Example: us-west4-docker.pkg.dev/test-project/test-repo/nginx@sha256:e9954c1fc875017be1c3e36eca16be2d9e9bccc4bf072163515467d6a823c7cf
+  },
+}
+
+
setIamPolicy(resource, body=None, x__xgafv=None)
Updates the IAM policy for a given resource.
diff --git a/docs/dyn/artifactregistry_v1.projects.locations.repositories.prewarmedArtifacts.html b/docs/dyn/artifactregistry_v1.projects.locations.repositories.prewarmedArtifacts.html
new file mode 100644
index 0000000000..7fc563a880
--- /dev/null
+++ b/docs/dyn/artifactregistry_v1.projects.locations.repositories.prewarmedArtifacts.html
@@ -0,0 +1,135 @@
+
+
+
+

Artifact Registry API . projects . locations . repositories . prewarmedArtifacts

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

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

+

Lists all streamed artifacts in a repository.

+

+ list_next()

+

Retrieves the next page of results.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None) +
Lists all streamed artifacts in a repository.
+
+Args:
+  parent: string, Required. The repository of the artifact to list. Format: projects/{project}/locations/{location}/repositories/{repository} (required)
+  filter: string, Optional. Filter should only support The location of the prewarmed artifacts. multi-region is not supported for this field.
+  pageSize: integer, Optional. The maximum number of prewarmed artifacts to return. Maximum page size is 1,000. Default page size is 100.
+  pageToken: string, Optional. The next_page_token value returned from a previous list request, if any.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The response for listing artifacts for streaming.
+  "nextPageToken": "A String", # The token to retrieve the next page of prewarmed artifacts, or empty if there are no more streamings to return.
+  "prewarmedArtifacts": [ # The prewarmed artifacts.
+    { # PrewarmedArtifact represents a streamed artifact.
+      "expirationTime": "A String", # The expiration time of the prewarmed artifact.
+      "location": "A String", # The location of the prewarmed artifact.
+      "uri": "A String", # URL to access the image. Example: us-west4-docker.pkg.dev/test-project/test-repo/nginx@sha256:e9954c1fc875017be1c3e36eca16be2d9e9bccc4bf072163515467d6a823c7cf
+    },
+  ],
+}
+
+ +
+ 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/artifactregistry_v1beta1.projects.locations.html b/docs/dyn/artifactregistry_v1beta1.projects.locations.html index 9f3ce173f8..85a63bf71c 100644 --- a/docs/dyn/artifactregistry_v1beta1.projects.locations.html +++ b/docs/dyn/artifactregistry_v1beta1.projects.locations.html @@ -92,7 +92,7 @@

Instance Methods

Gets information about a location.

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

-

Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the [ListLocationsRequest.name] field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.

+

Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the ListLocationsRequest.name field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.

list_next()

Retrieves the next page of results.

@@ -131,11 +131,11 @@

Method Details

list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None) -
Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the [ListLocationsRequest.name] field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.
+  
Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the ListLocationsRequest.name field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.
 
 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. Do not use this field 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/backupdr_v1.projects.locations.backupVaults.dataSources.backups.html b/docs/dyn/backupdr_v1.projects.locations.backupVaults.dataSources.backups.html
index 97718e7bf7..0f2194663b 100644
--- a/docs/dyn/backupdr_v1.projects.locations.backupVaults.dataSources.backups.html
+++ b/docs/dyn/backupdr_v1.projects.locations.backupVaults.dataSources.backups.html
@@ -1530,6 +1530,7 @@ 

Method Details

}, "computeInstanceTargetEnvironment": { # ComputeInstanceTargetEnvironment represents Compute Engine target environment to be used during restore. # Compute Engine target environment to be used during restore. "project": "A String", # Required. Target project for the Compute Engine instance. + "useProjectServiceAccount": True or False, # Optional. Whether to use the project service account for the Compute Engine instance. "zone": "A String", # Required. The zone of the Compute Engine instance. }, "diskRestoreProperties": { # DiskRestoreProperties represents the properties of a Disk restore. # Disk properties to be overridden during restore. @@ -1570,6 +1571,7 @@

Method Details

}, "diskTargetEnvironment": { # DiskTargetEnvironment represents the target environment for the disk. # Disk target environment to be used during restore. "project": "A String", # Required. Target project for the disk. + "useProjectServiceAccount": True or False, # Optional. Whether to use the project service account for the disk. "zone": "A String", # Required. Target zone for the disk. }, "regionDiskTargetEnvironment": { # RegionDiskTargetEnvironment represents the target environment for the disk. # Region disk target environment to be used during restore. @@ -1578,6 +1580,7 @@

Method Details

"replicaZones": [ # Required. Target URLs of the replica zones for the disk. "A String", ], + "useProjectServiceAccount": True or False, # Optional. Whether to use the project service account for the disk. }, "requestId": "A String", # Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). } diff --git a/docs/dyn/bigquery_v2.jobs.html b/docs/dyn/bigquery_v2.jobs.html index 3d7ff425bd..3dc8134086 100644 --- a/docs/dyn/bigquery_v2.jobs.html +++ b/docs/dyn/bigquery_v2.jobs.html @@ -266,11 +266,23 @@

Method Details

], }, "collation": "A String", # Optional. Field collation can be set only when the type of field is STRING. The following values are supported: * 'und:ci': undetermined locale, case insensitive. * '': empty string. Default to case-sensitive behavior. + "dataGovernanceTagsInfo": { # Optional. Specifies the data governance tags on this field. This field works with other column-level security fields as follows: - Precedence: If a data governance tag is attached to a column, it takes precedence over the policy tag attached to the column. However, if a data policy is attached to a column, it takes precedence over the data governance tag. - Patching behavior (how this field behaves during a `Table.patch` schema update): - Unset: If the `data_governance_tags_info` field is omitted from the update request, the existing tags on the column are preserved. - Empty Field: To clear data governance tags from a column, send the `data_governance_tags_info` field as an empty object. This will remove all tags from the column. - Updating tags: To replace existing tag, send the field with the new tag. + "dataGovernanceTags": { # Optional. The data governance tags added to this field are used for field-level access control. Only one data governance tag is currently supported on a field. Tag keys are globally unique. Tag key is expected to be in the namespaced format, for example "123456789012/pii" where 123456789012 is the ID of the parent organization or project resource for this tag key. Tag value is expected to be the short name, for example "sensitive". See [Tag definitions](https://cloud.google.com/iam/docs/tags-access-control#definitions) for more details. For example: "123456789012/pii": "sensitive", "myProject/cost_center": "sales" + "a_key": "A String", + }, + }, "dataPolicies": [ # Optional. Data policies attached to this field, used for field-level access control. { # Data policy option. For more information, see [Mask data by applying data policies to a column](https://docs.cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column). "name": "A String", # Data policy resource name in the form of projects/project_id/locations/location_id/dataPolicies/data_policy_id. }, ], + "dataPolicyList": { # A list of data policy options. For more information, see [Mask data by applying data policies to a column](https://docs.cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column). # Optional. Specifies data policies attached to this field, used for field-level access control. When set, this will be the source of truth for data policy information. + "dataPolicies": [ # Contains a list of data policy options. At most 9 data policies are allowed per field. + { # Data policy option. For more information, see [Mask data by applying data policies to a column](https://docs.cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column). + "name": "A String", # Data policy resource name in the form of projects/project_id/locations/location_id/dataPolicies/data_policy_id. + }, + ], + }, "defaultValueExpression": "A String", # Optional. A SQL expression to specify the [default value] (https://cloud.google.com/bigquery/docs/default-values) for this field. "description": "A String", # Optional. The field description. The maximum length is 1,024 characters. "fields": [ # Optional. Describes the nested schema fields if the type property is set to RECORD. @@ -530,11 +542,23 @@

Method Details

], }, "collation": "A String", # Optional. Field collation can be set only when the type of field is STRING. The following values are supported: * 'und:ci': undetermined locale, case insensitive. * '': empty string. Default to case-sensitive behavior. + "dataGovernanceTagsInfo": { # Optional. Specifies the data governance tags on this field. This field works with other column-level security fields as follows: - Precedence: If a data governance tag is attached to a column, it takes precedence over the policy tag attached to the column. However, if a data policy is attached to a column, it takes precedence over the data governance tag. - Patching behavior (how this field behaves during a `Table.patch` schema update): - Unset: If the `data_governance_tags_info` field is omitted from the update request, the existing tags on the column are preserved. - Empty Field: To clear data governance tags from a column, send the `data_governance_tags_info` field as an empty object. This will remove all tags from the column. - Updating tags: To replace existing tag, send the field with the new tag. + "dataGovernanceTags": { # Optional. The data governance tags added to this field are used for field-level access control. Only one data governance tag is currently supported on a field. Tag keys are globally unique. Tag key is expected to be in the namespaced format, for example "123456789012/pii" where 123456789012 is the ID of the parent organization or project resource for this tag key. Tag value is expected to be the short name, for example "sensitive". See [Tag definitions](https://cloud.google.com/iam/docs/tags-access-control#definitions) for more details. For example: "123456789012/pii": "sensitive", "myProject/cost_center": "sales" + "a_key": "A String", + }, + }, "dataPolicies": [ # Optional. Data policies attached to this field, used for field-level access control. { # Data policy option. For more information, see [Mask data by applying data policies to a column](https://docs.cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column). "name": "A String", # Data policy resource name in the form of projects/project_id/locations/location_id/dataPolicies/data_policy_id. }, ], + "dataPolicyList": { # A list of data policy options. For more information, see [Mask data by applying data policies to a column](https://docs.cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column). # Optional. Specifies data policies attached to this field, used for field-level access control. When set, this will be the source of truth for data policy information. + "dataPolicies": [ # Contains a list of data policy options. At most 9 data policies are allowed per field. + { # Data policy option. For more information, see [Mask data by applying data policies to a column](https://docs.cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column). + "name": "A String", # Data policy resource name in the form of projects/project_id/locations/location_id/dataPolicies/data_policy_id. + }, + ], + }, "defaultValueExpression": "A String", # Optional. A SQL expression to specify the [default value] (https://cloud.google.com/bigquery/docs/default-values) for this field. "description": "A String", # Optional. The field description. The maximum length is 1,024 characters. "fields": [ # Optional. Describes the nested schema fields if the type property is set to RECORD. @@ -749,6 +773,9 @@

Method Details

}, "functionStats": [ # Function level stats for GenAi Functions. See https://docs.cloud.google.com/bigquery/docs/generative-ai-overview { # Provides statistics for each Ai function call within a query. + "cacheStats": { # Provides cache statistics for a GenAi function call. # Cache stats for the function. + "numCacheHitRows": "A String", # Number of rows served from cache. + }, "costOptimizationStats": { # Provides cost optimization statistics for a GenAi function call. # Cost optimization stats if applied on the rows processed by the function. "message": "A String", # System generated message to provide insights into cost optimization state. "numCostOptimizedRows": "A String", # Number of rows inferred via cost optimized workflow. @@ -1355,6 +1382,20 @@

Method Details

"stageId": "A String", # Output only. The stage id that the insight mapped to. }, ], + "tableChangeInsights": [ # Output only. Performance insights for table-level attributes that changed compared to previous runs. + { # Table-level performance insights compared to previous runs. These insights don't apply to specific query stages, rather they apply to the whole table. + "metadataCacheNotUsedButUsedPreviously": True or False, # Output only. True if the table's column metadata index was not used in the current job, but was used in a previous job with the same query hash. + "metadataCacheStalenessInsight": { # Column Metadata Index staleness detailed infnormation. # Output only. If present, indicates that the table's metadata column index staleness has increased significantly compared to previous jobs with the same query hash. + "avgPreviousStalenessMs": "A String", # Output only. Average column metadata index staleness of previous runs with the same query hash. + "stalenessPercentageIncrease": 3.14, # Output only. The percent increase in staleness between the current job and the average staleness of previous jobs with the same query hash. + }, + "tableReference": { # Output only. The table that was queried. + "datasetId": "A String", # Required. The ID of the dataset containing this table. + "projectId": "A String", # Required. The ID of the project containing this table. + "tableId": "A String", # Required. The ID of the table. The ID can contain Unicode characters in category L (letter), M (mark), N (number), Pc (connector, including underscore), Pd (dash), and Zs (space). For more information, see [General Category](https://wikipedia.org/wiki/Unicode_character_property#General_Category). The maximum length is 1,024 characters. Certain operations allow suffixing of the table ID with a partition decorator, such as `sample_table$20190123`. + }, + }, + ], }, "queryInfo": { # Query optimization information for a QUERY job. # Output only. Query optimization information for a QUERY job. "optimizationDetails": { # Output only. Information about query optimizations. @@ -1441,11 +1482,23 @@

Method Details

], }, "collation": "A String", # Optional. Field collation can be set only when the type of field is STRING. The following values are supported: * 'und:ci': undetermined locale, case insensitive. * '': empty string. Default to case-sensitive behavior. + "dataGovernanceTagsInfo": { # Optional. Specifies the data governance tags on this field. This field works with other column-level security fields as follows: - Precedence: If a data governance tag is attached to a column, it takes precedence over the policy tag attached to the column. However, if a data policy is attached to a column, it takes precedence over the data governance tag. - Patching behavior (how this field behaves during a `Table.patch` schema update): - Unset: If the `data_governance_tags_info` field is omitted from the update request, the existing tags on the column are preserved. - Empty Field: To clear data governance tags from a column, send the `data_governance_tags_info` field as an empty object. This will remove all tags from the column. - Updating tags: To replace existing tag, send the field with the new tag. + "dataGovernanceTags": { # Optional. The data governance tags added to this field are used for field-level access control. Only one data governance tag is currently supported on a field. Tag keys are globally unique. Tag key is expected to be in the namespaced format, for example "123456789012/pii" where 123456789012 is the ID of the parent organization or project resource for this tag key. Tag value is expected to be the short name, for example "sensitive". See [Tag definitions](https://cloud.google.com/iam/docs/tags-access-control#definitions) for more details. For example: "123456789012/pii": "sensitive", "myProject/cost_center": "sales" + "a_key": "A String", + }, + }, "dataPolicies": [ # Optional. Data policies attached to this field, used for field-level access control. { # Data policy option. For more information, see [Mask data by applying data policies to a column](https://docs.cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column). "name": "A String", # Data policy resource name in the form of projects/project_id/locations/location_id/dataPolicies/data_policy_id. }, ], + "dataPolicyList": { # A list of data policy options. For more information, see [Mask data by applying data policies to a column](https://docs.cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column). # Optional. Specifies data policies attached to this field, used for field-level access control. When set, this will be the source of truth for data policy information. + "dataPolicies": [ # Contains a list of data policy options. At most 9 data policies are allowed per field. + { # Data policy option. For more information, see [Mask data by applying data policies to a column](https://docs.cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column). + "name": "A String", # Data policy resource name in the form of projects/project_id/locations/location_id/dataPolicies/data_policy_id. + }, + ], + }, "defaultValueExpression": "A String", # Optional. A SQL expression to specify the [default value] (https://cloud.google.com/bigquery/docs/default-values) for this field. "description": "A String", # Optional. The field description. The maximum length is 1,024 characters. "fields": [ # Optional. Describes the nested schema fields if the type property is set to RECORD. @@ -1849,11 +1902,23 @@

Method Details

], }, "collation": "A String", # Optional. Field collation can be set only when the type of field is STRING. The following values are supported: * 'und:ci': undetermined locale, case insensitive. * '': empty string. Default to case-sensitive behavior. + "dataGovernanceTagsInfo": { # Optional. Specifies the data governance tags on this field. This field works with other column-level security fields as follows: - Precedence: If a data governance tag is attached to a column, it takes precedence over the policy tag attached to the column. However, if a data policy is attached to a column, it takes precedence over the data governance tag. - Patching behavior (how this field behaves during a `Table.patch` schema update): - Unset: If the `data_governance_tags_info` field is omitted from the update request, the existing tags on the column are preserved. - Empty Field: To clear data governance tags from a column, send the `data_governance_tags_info` field as an empty object. This will remove all tags from the column. - Updating tags: To replace existing tag, send the field with the new tag. + "dataGovernanceTags": { # Optional. The data governance tags added to this field are used for field-level access control. Only one data governance tag is currently supported on a field. Tag keys are globally unique. Tag key is expected to be in the namespaced format, for example "123456789012/pii" where 123456789012 is the ID of the parent organization or project resource for this tag key. Tag value is expected to be the short name, for example "sensitive". See [Tag definitions](https://cloud.google.com/iam/docs/tags-access-control#definitions) for more details. For example: "123456789012/pii": "sensitive", "myProject/cost_center": "sales" + "a_key": "A String", + }, + }, "dataPolicies": [ # Optional. Data policies attached to this field, used for field-level access control. { # Data policy option. For more information, see [Mask data by applying data policies to a column](https://docs.cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column). "name": "A String", # Data policy resource name in the form of projects/project_id/locations/location_id/dataPolicies/data_policy_id. }, ], + "dataPolicyList": { # A list of data policy options. For more information, see [Mask data by applying data policies to a column](https://docs.cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column). # Optional. Specifies data policies attached to this field, used for field-level access control. When set, this will be the source of truth for data policy information. + "dataPolicies": [ # Contains a list of data policy options. At most 9 data policies are allowed per field. + { # Data policy option. For more information, see [Mask data by applying data policies to a column](https://docs.cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column). + "name": "A String", # Data policy resource name in the form of projects/project_id/locations/location_id/dataPolicies/data_policy_id. + }, + ], + }, "defaultValueExpression": "A String", # Optional. A SQL expression to specify the [default value] (https://cloud.google.com/bigquery/docs/default-values) for this field. "description": "A String", # Optional. The field description. The maximum length is 1,024 characters. "fields": [ # Optional. Describes the nested schema fields if the type property is set to RECORD. @@ -2113,11 +2178,23 @@

Method Details

], }, "collation": "A String", # Optional. Field collation can be set only when the type of field is STRING. The following values are supported: * 'und:ci': undetermined locale, case insensitive. * '': empty string. Default to case-sensitive behavior. + "dataGovernanceTagsInfo": { # Optional. Specifies the data governance tags on this field. This field works with other column-level security fields as follows: - Precedence: If a data governance tag is attached to a column, it takes precedence over the policy tag attached to the column. However, if a data policy is attached to a column, it takes precedence over the data governance tag. - Patching behavior (how this field behaves during a `Table.patch` schema update): - Unset: If the `data_governance_tags_info` field is omitted from the update request, the existing tags on the column are preserved. - Empty Field: To clear data governance tags from a column, send the `data_governance_tags_info` field as an empty object. This will remove all tags from the column. - Updating tags: To replace existing tag, send the field with the new tag. + "dataGovernanceTags": { # Optional. The data governance tags added to this field are used for field-level access control. Only one data governance tag is currently supported on a field. Tag keys are globally unique. Tag key is expected to be in the namespaced format, for example "123456789012/pii" where 123456789012 is the ID of the parent organization or project resource for this tag key. Tag value is expected to be the short name, for example "sensitive". See [Tag definitions](https://cloud.google.com/iam/docs/tags-access-control#definitions) for more details. For example: "123456789012/pii": "sensitive", "myProject/cost_center": "sales" + "a_key": "A String", + }, + }, "dataPolicies": [ # Optional. Data policies attached to this field, used for field-level access control. { # Data policy option. For more information, see [Mask data by applying data policies to a column](https://docs.cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column). "name": "A String", # Data policy resource name in the form of projects/project_id/locations/location_id/dataPolicies/data_policy_id. }, ], + "dataPolicyList": { # A list of data policy options. For more information, see [Mask data by applying data policies to a column](https://docs.cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column). # Optional. Specifies data policies attached to this field, used for field-level access control. When set, this will be the source of truth for data policy information. + "dataPolicies": [ # Contains a list of data policy options. At most 9 data policies are allowed per field. + { # Data policy option. For more information, see [Mask data by applying data policies to a column](https://docs.cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column). + "name": "A String", # Data policy resource name in the form of projects/project_id/locations/location_id/dataPolicies/data_policy_id. + }, + ], + }, "defaultValueExpression": "A String", # Optional. A SQL expression to specify the [default value] (https://cloud.google.com/bigquery/docs/default-values) for this field. "description": "A String", # Optional. The field description. The maximum length is 1,024 characters. "fields": [ # Optional. Describes the nested schema fields if the type property is set to RECORD. @@ -2332,6 +2409,9 @@

Method Details

}, "functionStats": [ # Function level stats for GenAi Functions. See https://docs.cloud.google.com/bigquery/docs/generative-ai-overview { # Provides statistics for each Ai function call within a query. + "cacheStats": { # Provides cache statistics for a GenAi function call. # Cache stats for the function. + "numCacheHitRows": "A String", # Number of rows served from cache. + }, "costOptimizationStats": { # Provides cost optimization statistics for a GenAi function call. # Cost optimization stats if applied on the rows processed by the function. "message": "A String", # System generated message to provide insights into cost optimization state. "numCostOptimizedRows": "A String", # Number of rows inferred via cost optimized workflow. @@ -2938,6 +3018,20 @@

Method Details

"stageId": "A String", # Output only. The stage id that the insight mapped to. }, ], + "tableChangeInsights": [ # Output only. Performance insights for table-level attributes that changed compared to previous runs. + { # Table-level performance insights compared to previous runs. These insights don't apply to specific query stages, rather they apply to the whole table. + "metadataCacheNotUsedButUsedPreviously": True or False, # Output only. True if the table's column metadata index was not used in the current job, but was used in a previous job with the same query hash. + "metadataCacheStalenessInsight": { # Column Metadata Index staleness detailed infnormation. # Output only. If present, indicates that the table's metadata column index staleness has increased significantly compared to previous jobs with the same query hash. + "avgPreviousStalenessMs": "A String", # Output only. Average column metadata index staleness of previous runs with the same query hash. + "stalenessPercentageIncrease": 3.14, # Output only. The percent increase in staleness between the current job and the average staleness of previous jobs with the same query hash. + }, + "tableReference": { # Output only. The table that was queried. + "datasetId": "A String", # Required. The ID of the dataset containing this table. + "projectId": "A String", # Required. The ID of the project containing this table. + "tableId": "A String", # Required. The ID of the table. The ID can contain Unicode characters in category L (letter), M (mark), N (number), Pc (connector, including underscore), Pd (dash), and Zs (space). For more information, see [General Category](https://wikipedia.org/wiki/Unicode_character_property#General_Category). The maximum length is 1,024 characters. Certain operations allow suffixing of the table ID with a partition decorator, such as `sample_table$20190123`. + }, + }, + ], }, "queryInfo": { # Query optimization information for a QUERY job. # Output only. Query optimization information for a QUERY job. "optimizationDetails": { # Output only. Information about query optimizations. @@ -3024,11 +3118,23 @@

Method Details

], }, "collation": "A String", # Optional. Field collation can be set only when the type of field is STRING. The following values are supported: * 'und:ci': undetermined locale, case insensitive. * '': empty string. Default to case-sensitive behavior. + "dataGovernanceTagsInfo": { # Optional. Specifies the data governance tags on this field. This field works with other column-level security fields as follows: - Precedence: If a data governance tag is attached to a column, it takes precedence over the policy tag attached to the column. However, if a data policy is attached to a column, it takes precedence over the data governance tag. - Patching behavior (how this field behaves during a `Table.patch` schema update): - Unset: If the `data_governance_tags_info` field is omitted from the update request, the existing tags on the column are preserved. - Empty Field: To clear data governance tags from a column, send the `data_governance_tags_info` field as an empty object. This will remove all tags from the column. - Updating tags: To replace existing tag, send the field with the new tag. + "dataGovernanceTags": { # Optional. The data governance tags added to this field are used for field-level access control. Only one data governance tag is currently supported on a field. Tag keys are globally unique. Tag key is expected to be in the namespaced format, for example "123456789012/pii" where 123456789012 is the ID of the parent organization or project resource for this tag key. Tag value is expected to be the short name, for example "sensitive". See [Tag definitions](https://cloud.google.com/iam/docs/tags-access-control#definitions) for more details. For example: "123456789012/pii": "sensitive", "myProject/cost_center": "sales" + "a_key": "A String", + }, + }, "dataPolicies": [ # Optional. Data policies attached to this field, used for field-level access control. { # Data policy option. For more information, see [Mask data by applying data policies to a column](https://docs.cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column). "name": "A String", # Data policy resource name in the form of projects/project_id/locations/location_id/dataPolicies/data_policy_id. }, ], + "dataPolicyList": { # A list of data policy options. For more information, see [Mask data by applying data policies to a column](https://docs.cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column). # Optional. Specifies data policies attached to this field, used for field-level access control. When set, this will be the source of truth for data policy information. + "dataPolicies": [ # Contains a list of data policy options. At most 9 data policies are allowed per field. + { # Data policy option. For more information, see [Mask data by applying data policies to a column](https://docs.cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column). + "name": "A String", # Data policy resource name in the form of projects/project_id/locations/location_id/dataPolicies/data_policy_id. + }, + ], + }, "defaultValueExpression": "A String", # Optional. A SQL expression to specify the [default value] (https://cloud.google.com/bigquery/docs/default-values) for this field. "description": "A String", # Optional. The field description. The maximum length is 1,024 characters. "fields": [ # Optional. Describes the nested schema fields if the type property is set to RECORD. @@ -3315,11 +3421,23 @@

Method Details

], }, "collation": "A String", # Optional. Field collation can be set only when the type of field is STRING. The following values are supported: * 'und:ci': undetermined locale, case insensitive. * '': empty string. Default to case-sensitive behavior. + "dataGovernanceTagsInfo": { # Optional. Specifies the data governance tags on this field. This field works with other column-level security fields as follows: - Precedence: If a data governance tag is attached to a column, it takes precedence over the policy tag attached to the column. However, if a data policy is attached to a column, it takes precedence over the data governance tag. - Patching behavior (how this field behaves during a `Table.patch` schema update): - Unset: If the `data_governance_tags_info` field is omitted from the update request, the existing tags on the column are preserved. - Empty Field: To clear data governance tags from a column, send the `data_governance_tags_info` field as an empty object. This will remove all tags from the column. - Updating tags: To replace existing tag, send the field with the new tag. + "dataGovernanceTags": { # Optional. The data governance tags added to this field are used for field-level access control. Only one data governance tag is currently supported on a field. Tag keys are globally unique. Tag key is expected to be in the namespaced format, for example "123456789012/pii" where 123456789012 is the ID of the parent organization or project resource for this tag key. Tag value is expected to be the short name, for example "sensitive". See [Tag definitions](https://cloud.google.com/iam/docs/tags-access-control#definitions) for more details. For example: "123456789012/pii": "sensitive", "myProject/cost_center": "sales" + "a_key": "A String", + }, + }, "dataPolicies": [ # Optional. Data policies attached to this field, used for field-level access control. { # Data policy option. For more information, see [Mask data by applying data policies to a column](https://docs.cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column). "name": "A String", # Data policy resource name in the form of projects/project_id/locations/location_id/dataPolicies/data_policy_id. }, ], + "dataPolicyList": { # A list of data policy options. For more information, see [Mask data by applying data policies to a column](https://docs.cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column). # Optional. Specifies data policies attached to this field, used for field-level access control. When set, this will be the source of truth for data policy information. + "dataPolicies": [ # Contains a list of data policy options. At most 9 data policies are allowed per field. + { # Data policy option. For more information, see [Mask data by applying data policies to a column](https://docs.cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column). + "name": "A String", # Data policy resource name in the form of projects/project_id/locations/location_id/dataPolicies/data_policy_id. + }, + ], + }, "defaultValueExpression": "A String", # Optional. A SQL expression to specify the [default value] (https://cloud.google.com/bigquery/docs/default-values) for this field. "description": "A String", # Optional. The field description. The maximum length is 1,024 characters. "fields": [ # Optional. Describes the nested schema fields if the type property is set to RECORD. @@ -3528,11 +3646,23 @@

Method Details

], }, "collation": "A String", # Optional. Field collation can be set only when the type of field is STRING. The following values are supported: * 'und:ci': undetermined locale, case insensitive. * '': empty string. Default to case-sensitive behavior. + "dataGovernanceTagsInfo": { # Optional. Specifies the data governance tags on this field. This field works with other column-level security fields as follows: - Precedence: If a data governance tag is attached to a column, it takes precedence over the policy tag attached to the column. However, if a data policy is attached to a column, it takes precedence over the data governance tag. - Patching behavior (how this field behaves during a `Table.patch` schema update): - Unset: If the `data_governance_tags_info` field is omitted from the update request, the existing tags on the column are preserved. - Empty Field: To clear data governance tags from a column, send the `data_governance_tags_info` field as an empty object. This will remove all tags from the column. - Updating tags: To replace existing tag, send the field with the new tag. + "dataGovernanceTags": { # Optional. The data governance tags added to this field are used for field-level access control. Only one data governance tag is currently supported on a field. Tag keys are globally unique. Tag key is expected to be in the namespaced format, for example "123456789012/pii" where 123456789012 is the ID of the parent organization or project resource for this tag key. Tag value is expected to be the short name, for example "sensitive". See [Tag definitions](https://cloud.google.com/iam/docs/tags-access-control#definitions) for more details. For example: "123456789012/pii": "sensitive", "myProject/cost_center": "sales" + "a_key": "A String", + }, + }, "dataPolicies": [ # Optional. Data policies attached to this field, used for field-level access control. { # Data policy option. For more information, see [Mask data by applying data policies to a column](https://docs.cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column). "name": "A String", # Data policy resource name in the form of projects/project_id/locations/location_id/dataPolicies/data_policy_id. }, ], + "dataPolicyList": { # A list of data policy options. For more information, see [Mask data by applying data policies to a column](https://docs.cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column). # Optional. Specifies data policies attached to this field, used for field-level access control. When set, this will be the source of truth for data policy information. + "dataPolicies": [ # Contains a list of data policy options. At most 9 data policies are allowed per field. + { # Data policy option. For more information, see [Mask data by applying data policies to a column](https://docs.cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column). + "name": "A String", # Data policy resource name in the form of projects/project_id/locations/location_id/dataPolicies/data_policy_id. + }, + ], + }, "defaultValueExpression": "A String", # Optional. A SQL expression to specify the [default value] (https://cloud.google.com/bigquery/docs/default-values) for this field. "description": "A String", # Optional. The field description. The maximum length is 1,024 characters. "fields": [ # Optional. Describes the nested schema fields if the type property is set to RECORD. @@ -3792,11 +3922,23 @@

Method Details

], }, "collation": "A String", # Optional. Field collation can be set only when the type of field is STRING. The following values are supported: * 'und:ci': undetermined locale, case insensitive. * '': empty string. Default to case-sensitive behavior. + "dataGovernanceTagsInfo": { # Optional. Specifies the data governance tags on this field. This field works with other column-level security fields as follows: - Precedence: If a data governance tag is attached to a column, it takes precedence over the policy tag attached to the column. However, if a data policy is attached to a column, it takes precedence over the data governance tag. - Patching behavior (how this field behaves during a `Table.patch` schema update): - Unset: If the `data_governance_tags_info` field is omitted from the update request, the existing tags on the column are preserved. - Empty Field: To clear data governance tags from a column, send the `data_governance_tags_info` field as an empty object. This will remove all tags from the column. - Updating tags: To replace existing tag, send the field with the new tag. + "dataGovernanceTags": { # Optional. The data governance tags added to this field are used for field-level access control. Only one data governance tag is currently supported on a field. Tag keys are globally unique. Tag key is expected to be in the namespaced format, for example "123456789012/pii" where 123456789012 is the ID of the parent organization or project resource for this tag key. Tag value is expected to be the short name, for example "sensitive". See [Tag definitions](https://cloud.google.com/iam/docs/tags-access-control#definitions) for more details. For example: "123456789012/pii": "sensitive", "myProject/cost_center": "sales" + "a_key": "A String", + }, + }, "dataPolicies": [ # Optional. Data policies attached to this field, used for field-level access control. { # Data policy option. For more information, see [Mask data by applying data policies to a column](https://docs.cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column). "name": "A String", # Data policy resource name in the form of projects/project_id/locations/location_id/dataPolicies/data_policy_id. }, ], + "dataPolicyList": { # A list of data policy options. For more information, see [Mask data by applying data policies to a column](https://docs.cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column). # Optional. Specifies data policies attached to this field, used for field-level access control. When set, this will be the source of truth for data policy information. + "dataPolicies": [ # Contains a list of data policy options. At most 9 data policies are allowed per field. + { # Data policy option. For more information, see [Mask data by applying data policies to a column](https://docs.cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column). + "name": "A String", # Data policy resource name in the form of projects/project_id/locations/location_id/dataPolicies/data_policy_id. + }, + ], + }, "defaultValueExpression": "A String", # Optional. A SQL expression to specify the [default value] (https://cloud.google.com/bigquery/docs/default-values) for this field. "description": "A String", # Optional. The field description. The maximum length is 1,024 characters. "fields": [ # Optional. Describes the nested schema fields if the type property is set to RECORD. @@ -4011,6 +4153,9 @@

Method Details

}, "functionStats": [ # Function level stats for GenAi Functions. See https://docs.cloud.google.com/bigquery/docs/generative-ai-overview { # Provides statistics for each Ai function call within a query. + "cacheStats": { # Provides cache statistics for a GenAi function call. # Cache stats for the function. + "numCacheHitRows": "A String", # Number of rows served from cache. + }, "costOptimizationStats": { # Provides cost optimization statistics for a GenAi function call. # Cost optimization stats if applied on the rows processed by the function. "message": "A String", # System generated message to provide insights into cost optimization state. "numCostOptimizedRows": "A String", # Number of rows inferred via cost optimized workflow. @@ -4617,6 +4762,20 @@

Method Details

"stageId": "A String", # Output only. The stage id that the insight mapped to. }, ], + "tableChangeInsights": [ # Output only. Performance insights for table-level attributes that changed compared to previous runs. + { # Table-level performance insights compared to previous runs. These insights don't apply to specific query stages, rather they apply to the whole table. + "metadataCacheNotUsedButUsedPreviously": True or False, # Output only. True if the table's column metadata index was not used in the current job, but was used in a previous job with the same query hash. + "metadataCacheStalenessInsight": { # Column Metadata Index staleness detailed infnormation. # Output only. If present, indicates that the table's metadata column index staleness has increased significantly compared to previous jobs with the same query hash. + "avgPreviousStalenessMs": "A String", # Output only. Average column metadata index staleness of previous runs with the same query hash. + "stalenessPercentageIncrease": 3.14, # Output only. The percent increase in staleness between the current job and the average staleness of previous jobs with the same query hash. + }, + "tableReference": { # Output only. The table that was queried. + "datasetId": "A String", # Required. The ID of the dataset containing this table. + "projectId": "A String", # Required. The ID of the project containing this table. + "tableId": "A String", # Required. The ID of the table. The ID can contain Unicode characters in category L (letter), M (mark), N (number), Pc (connector, including underscore), Pd (dash), and Zs (space). For more information, see [General Category](https://wikipedia.org/wiki/Unicode_character_property#General_Category). The maximum length is 1,024 characters. Certain operations allow suffixing of the table ID with a partition decorator, such as `sample_table$20190123`. + }, + }, + ], }, "queryInfo": { # Query optimization information for a QUERY job. # Output only. Query optimization information for a QUERY job. "optimizationDetails": { # Output only. Information about query optimizations. @@ -4703,11 +4862,23 @@

Method Details

], }, "collation": "A String", # Optional. Field collation can be set only when the type of field is STRING. The following values are supported: * 'und:ci': undetermined locale, case insensitive. * '': empty string. Default to case-sensitive behavior. + "dataGovernanceTagsInfo": { # Optional. Specifies the data governance tags on this field. This field works with other column-level security fields as follows: - Precedence: If a data governance tag is attached to a column, it takes precedence over the policy tag attached to the column. However, if a data policy is attached to a column, it takes precedence over the data governance tag. - Patching behavior (how this field behaves during a `Table.patch` schema update): - Unset: If the `data_governance_tags_info` field is omitted from the update request, the existing tags on the column are preserved. - Empty Field: To clear data governance tags from a column, send the `data_governance_tags_info` field as an empty object. This will remove all tags from the column. - Updating tags: To replace existing tag, send the field with the new tag. + "dataGovernanceTags": { # Optional. The data governance tags added to this field are used for field-level access control. Only one data governance tag is currently supported on a field. Tag keys are globally unique. Tag key is expected to be in the namespaced format, for example "123456789012/pii" where 123456789012 is the ID of the parent organization or project resource for this tag key. Tag value is expected to be the short name, for example "sensitive". See [Tag definitions](https://cloud.google.com/iam/docs/tags-access-control#definitions) for more details. For example: "123456789012/pii": "sensitive", "myProject/cost_center": "sales" + "a_key": "A String", + }, + }, "dataPolicies": [ # Optional. Data policies attached to this field, used for field-level access control. { # Data policy option. For more information, see [Mask data by applying data policies to a column](https://docs.cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column). "name": "A String", # Data policy resource name in the form of projects/project_id/locations/location_id/dataPolicies/data_policy_id. }, ], + "dataPolicyList": { # A list of data policy options. For more information, see [Mask data by applying data policies to a column](https://docs.cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column). # Optional. Specifies data policies attached to this field, used for field-level access control. When set, this will be the source of truth for data policy information. + "dataPolicies": [ # Contains a list of data policy options. At most 9 data policies are allowed per field. + { # Data policy option. For more information, see [Mask data by applying data policies to a column](https://docs.cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column). + "name": "A String", # Data policy resource name in the form of projects/project_id/locations/location_id/dataPolicies/data_policy_id. + }, + ], + }, "defaultValueExpression": "A String", # Optional. A SQL expression to specify the [default value] (https://cloud.google.com/bigquery/docs/default-values) for this field. "description": "A String", # Optional. The field description. The maximum length is 1,024 characters. "fields": [ # Optional. Describes the nested schema fields if the type property is set to RECORD. @@ -5082,11 +5253,23 @@

Method Details

], }, "collation": "A String", # Optional. Field collation can be set only when the type of field is STRING. The following values are supported: * 'und:ci': undetermined locale, case insensitive. * '': empty string. Default to case-sensitive behavior. + "dataGovernanceTagsInfo": { # Optional. Specifies the data governance tags on this field. This field works with other column-level security fields as follows: - Precedence: If a data governance tag is attached to a column, it takes precedence over the policy tag attached to the column. However, if a data policy is attached to a column, it takes precedence over the data governance tag. - Patching behavior (how this field behaves during a `Table.patch` schema update): - Unset: If the `data_governance_tags_info` field is omitted from the update request, the existing tags on the column are preserved. - Empty Field: To clear data governance tags from a column, send the `data_governance_tags_info` field as an empty object. This will remove all tags from the column. - Updating tags: To replace existing tag, send the field with the new tag. + "dataGovernanceTags": { # Optional. The data governance tags added to this field are used for field-level access control. Only one data governance tag is currently supported on a field. Tag keys are globally unique. Tag key is expected to be in the namespaced format, for example "123456789012/pii" where 123456789012 is the ID of the parent organization or project resource for this tag key. Tag value is expected to be the short name, for example "sensitive". See [Tag definitions](https://cloud.google.com/iam/docs/tags-access-control#definitions) for more details. For example: "123456789012/pii": "sensitive", "myProject/cost_center": "sales" + "a_key": "A String", + }, + }, "dataPolicies": [ # Optional. Data policies attached to this field, used for field-level access control. { # Data policy option. For more information, see [Mask data by applying data policies to a column](https://docs.cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column). "name": "A String", # Data policy resource name in the form of projects/project_id/locations/location_id/dataPolicies/data_policy_id. }, ], + "dataPolicyList": { # A list of data policy options. For more information, see [Mask data by applying data policies to a column](https://docs.cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column). # Optional. Specifies data policies attached to this field, used for field-level access control. When set, this will be the source of truth for data policy information. + "dataPolicies": [ # Contains a list of data policy options. At most 9 data policies are allowed per field. + { # Data policy option. For more information, see [Mask data by applying data policies to a column](https://docs.cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column). + "name": "A String", # Data policy resource name in the form of projects/project_id/locations/location_id/dataPolicies/data_policy_id. + }, + ], + }, "defaultValueExpression": "A String", # Optional. A SQL expression to specify the [default value] (https://cloud.google.com/bigquery/docs/default-values) for this field. "description": "A String", # Optional. The field description. The maximum length is 1,024 characters. "fields": [ # Optional. Describes the nested schema fields if the type property is set to RECORD. @@ -5346,11 +5529,23 @@

Method Details

], }, "collation": "A String", # Optional. Field collation can be set only when the type of field is STRING. The following values are supported: * 'und:ci': undetermined locale, case insensitive. * '': empty string. Default to case-sensitive behavior. + "dataGovernanceTagsInfo": { # Optional. Specifies the data governance tags on this field. This field works with other column-level security fields as follows: - Precedence: If a data governance tag is attached to a column, it takes precedence over the policy tag attached to the column. However, if a data policy is attached to a column, it takes precedence over the data governance tag. - Patching behavior (how this field behaves during a `Table.patch` schema update): - Unset: If the `data_governance_tags_info` field is omitted from the update request, the existing tags on the column are preserved. - Empty Field: To clear data governance tags from a column, send the `data_governance_tags_info` field as an empty object. This will remove all tags from the column. - Updating tags: To replace existing tag, send the field with the new tag. + "dataGovernanceTags": { # Optional. The data governance tags added to this field are used for field-level access control. Only one data governance tag is currently supported on a field. Tag keys are globally unique. Tag key is expected to be in the namespaced format, for example "123456789012/pii" where 123456789012 is the ID of the parent organization or project resource for this tag key. Tag value is expected to be the short name, for example "sensitive". See [Tag definitions](https://cloud.google.com/iam/docs/tags-access-control#definitions) for more details. For example: "123456789012/pii": "sensitive", "myProject/cost_center": "sales" + "a_key": "A String", + }, + }, "dataPolicies": [ # Optional. Data policies attached to this field, used for field-level access control. { # Data policy option. For more information, see [Mask data by applying data policies to a column](https://docs.cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column). "name": "A String", # Data policy resource name in the form of projects/project_id/locations/location_id/dataPolicies/data_policy_id. }, ], + "dataPolicyList": { # A list of data policy options. For more information, see [Mask data by applying data policies to a column](https://docs.cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column). # Optional. Specifies data policies attached to this field, used for field-level access control. When set, this will be the source of truth for data policy information. + "dataPolicies": [ # Contains a list of data policy options. At most 9 data policies are allowed per field. + { # Data policy option. For more information, see [Mask data by applying data policies to a column](https://docs.cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column). + "name": "A String", # Data policy resource name in the form of projects/project_id/locations/location_id/dataPolicies/data_policy_id. + }, + ], + }, "defaultValueExpression": "A String", # Optional. A SQL expression to specify the [default value] (https://cloud.google.com/bigquery/docs/default-values) for this field. "description": "A String", # Optional. The field description. The maximum length is 1,024 characters. "fields": [ # Optional. Describes the nested schema fields if the type property is set to RECORD. @@ -5565,6 +5760,9 @@

Method Details

}, "functionStats": [ # Function level stats for GenAi Functions. See https://docs.cloud.google.com/bigquery/docs/generative-ai-overview { # Provides statistics for each Ai function call within a query. + "cacheStats": { # Provides cache statistics for a GenAi function call. # Cache stats for the function. + "numCacheHitRows": "A String", # Number of rows served from cache. + }, "costOptimizationStats": { # Provides cost optimization statistics for a GenAi function call. # Cost optimization stats if applied on the rows processed by the function. "message": "A String", # System generated message to provide insights into cost optimization state. "numCostOptimizedRows": "A String", # Number of rows inferred via cost optimized workflow. @@ -6171,6 +6369,20 @@

Method Details

"stageId": "A String", # Output only. The stage id that the insight mapped to. }, ], + "tableChangeInsights": [ # Output only. Performance insights for table-level attributes that changed compared to previous runs. + { # Table-level performance insights compared to previous runs. These insights don't apply to specific query stages, rather they apply to the whole table. + "metadataCacheNotUsedButUsedPreviously": True or False, # Output only. True if the table's column metadata index was not used in the current job, but was used in a previous job with the same query hash. + "metadataCacheStalenessInsight": { # Column Metadata Index staleness detailed infnormation. # Output only. If present, indicates that the table's metadata column index staleness has increased significantly compared to previous jobs with the same query hash. + "avgPreviousStalenessMs": "A String", # Output only. Average column metadata index staleness of previous runs with the same query hash. + "stalenessPercentageIncrease": 3.14, # Output only. The percent increase in staleness between the current job and the average staleness of previous jobs with the same query hash. + }, + "tableReference": { # Output only. The table that was queried. + "datasetId": "A String", # Required. The ID of the dataset containing this table. + "projectId": "A String", # Required. The ID of the project containing this table. + "tableId": "A String", # Required. The ID of the table. The ID can contain Unicode characters in category L (letter), M (mark), N (number), Pc (connector, including underscore), Pd (dash), and Zs (space). For more information, see [General Category](https://wikipedia.org/wiki/Unicode_character_property#General_Category). The maximum length is 1,024 characters. Certain operations allow suffixing of the table ID with a partition decorator, such as `sample_table$20190123`. + }, + }, + ], }, "queryInfo": { # Query optimization information for a QUERY job. # Output only. Query optimization information for a QUERY job. "optimizationDetails": { # Output only. Information about query optimizations. @@ -6257,11 +6469,23 @@

Method Details

], }, "collation": "A String", # Optional. Field collation can be set only when the type of field is STRING. The following values are supported: * 'und:ci': undetermined locale, case insensitive. * '': empty string. Default to case-sensitive behavior. + "dataGovernanceTagsInfo": { # Optional. Specifies the data governance tags on this field. This field works with other column-level security fields as follows: - Precedence: If a data governance tag is attached to a column, it takes precedence over the policy tag attached to the column. However, if a data policy is attached to a column, it takes precedence over the data governance tag. - Patching behavior (how this field behaves during a `Table.patch` schema update): - Unset: If the `data_governance_tags_info` field is omitted from the update request, the existing tags on the column are preserved. - Empty Field: To clear data governance tags from a column, send the `data_governance_tags_info` field as an empty object. This will remove all tags from the column. - Updating tags: To replace existing tag, send the field with the new tag. + "dataGovernanceTags": { # Optional. The data governance tags added to this field are used for field-level access control. Only one data governance tag is currently supported on a field. Tag keys are globally unique. Tag key is expected to be in the namespaced format, for example "123456789012/pii" where 123456789012 is the ID of the parent organization or project resource for this tag key. Tag value is expected to be the short name, for example "sensitive". See [Tag definitions](https://cloud.google.com/iam/docs/tags-access-control#definitions) for more details. For example: "123456789012/pii": "sensitive", "myProject/cost_center": "sales" + "a_key": "A String", + }, + }, "dataPolicies": [ # Optional. Data policies attached to this field, used for field-level access control. { # Data policy option. For more information, see [Mask data by applying data policies to a column](https://docs.cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column). "name": "A String", # Data policy resource name in the form of projects/project_id/locations/location_id/dataPolicies/data_policy_id. }, ], + "dataPolicyList": { # A list of data policy options. For more information, see [Mask data by applying data policies to a column](https://docs.cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column). # Optional. Specifies data policies attached to this field, used for field-level access control. When set, this will be the source of truth for data policy information. + "dataPolicies": [ # Contains a list of data policy options. At most 9 data policies are allowed per field. + { # Data policy option. For more information, see [Mask data by applying data policies to a column](https://docs.cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column). + "name": "A String", # Data policy resource name in the form of projects/project_id/locations/location_id/dataPolicies/data_policy_id. + }, + ], + }, "defaultValueExpression": "A String", # Optional. A SQL expression to specify the [default value] (https://cloud.google.com/bigquery/docs/default-values) for this field. "description": "A String", # Optional. The field description. The maximum length is 1,024 characters. "fields": [ # Optional. Describes the nested schema fields if the type property is set to RECORD. @@ -6659,11 +6883,23 @@

Method Details

], }, "collation": "A String", # Optional. Field collation can be set only when the type of field is STRING. The following values are supported: * 'und:ci': undetermined locale, case insensitive. * '': empty string. Default to case-sensitive behavior. + "dataGovernanceTagsInfo": { # Optional. Specifies the data governance tags on this field. This field works with other column-level security fields as follows: - Precedence: If a data governance tag is attached to a column, it takes precedence over the policy tag attached to the column. However, if a data policy is attached to a column, it takes precedence over the data governance tag. - Patching behavior (how this field behaves during a `Table.patch` schema update): - Unset: If the `data_governance_tags_info` field is omitted from the update request, the existing tags on the column are preserved. - Empty Field: To clear data governance tags from a column, send the `data_governance_tags_info` field as an empty object. This will remove all tags from the column. - Updating tags: To replace existing tag, send the field with the new tag. + "dataGovernanceTags": { # Optional. The data governance tags added to this field are used for field-level access control. Only one data governance tag is currently supported on a field. Tag keys are globally unique. Tag key is expected to be in the namespaced format, for example "123456789012/pii" where 123456789012 is the ID of the parent organization or project resource for this tag key. Tag value is expected to be the short name, for example "sensitive". See [Tag definitions](https://cloud.google.com/iam/docs/tags-access-control#definitions) for more details. For example: "123456789012/pii": "sensitive", "myProject/cost_center": "sales" + "a_key": "A String", + }, + }, "dataPolicies": [ # Optional. Data policies attached to this field, used for field-level access control. { # Data policy option. For more information, see [Mask data by applying data policies to a column](https://docs.cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column). "name": "A String", # Data policy resource name in the form of projects/project_id/locations/location_id/dataPolicies/data_policy_id. }, ], + "dataPolicyList": { # A list of data policy options. For more information, see [Mask data by applying data policies to a column](https://docs.cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column). # Optional. Specifies data policies attached to this field, used for field-level access control. When set, this will be the source of truth for data policy information. + "dataPolicies": [ # Contains a list of data policy options. At most 9 data policies are allowed per field. + { # Data policy option. For more information, see [Mask data by applying data policies to a column](https://docs.cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column). + "name": "A String", # Data policy resource name in the form of projects/project_id/locations/location_id/dataPolicies/data_policy_id. + }, + ], + }, "defaultValueExpression": "A String", # Optional. A SQL expression to specify the [default value] (https://cloud.google.com/bigquery/docs/default-values) for this field. "description": "A String", # Optional. The field description. The maximum length is 1,024 characters. "fields": [ # Optional. Describes the nested schema fields if the type property is set to RECORD. @@ -6923,11 +7159,23 @@

Method Details

], }, "collation": "A String", # Optional. Field collation can be set only when the type of field is STRING. The following values are supported: * 'und:ci': undetermined locale, case insensitive. * '': empty string. Default to case-sensitive behavior. + "dataGovernanceTagsInfo": { # Optional. Specifies the data governance tags on this field. This field works with other column-level security fields as follows: - Precedence: If a data governance tag is attached to a column, it takes precedence over the policy tag attached to the column. However, if a data policy is attached to a column, it takes precedence over the data governance tag. - Patching behavior (how this field behaves during a `Table.patch` schema update): - Unset: If the `data_governance_tags_info` field is omitted from the update request, the existing tags on the column are preserved. - Empty Field: To clear data governance tags from a column, send the `data_governance_tags_info` field as an empty object. This will remove all tags from the column. - Updating tags: To replace existing tag, send the field with the new tag. + "dataGovernanceTags": { # Optional. The data governance tags added to this field are used for field-level access control. Only one data governance tag is currently supported on a field. Tag keys are globally unique. Tag key is expected to be in the namespaced format, for example "123456789012/pii" where 123456789012 is the ID of the parent organization or project resource for this tag key. Tag value is expected to be the short name, for example "sensitive". See [Tag definitions](https://cloud.google.com/iam/docs/tags-access-control#definitions) for more details. For example: "123456789012/pii": "sensitive", "myProject/cost_center": "sales" + "a_key": "A String", + }, + }, "dataPolicies": [ # Optional. Data policies attached to this field, used for field-level access control. { # Data policy option. For more information, see [Mask data by applying data policies to a column](https://docs.cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column). "name": "A String", # Data policy resource name in the form of projects/project_id/locations/location_id/dataPolicies/data_policy_id. }, ], + "dataPolicyList": { # A list of data policy options. For more information, see [Mask data by applying data policies to a column](https://docs.cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column). # Optional. Specifies data policies attached to this field, used for field-level access control. When set, this will be the source of truth for data policy information. + "dataPolicies": [ # Contains a list of data policy options. At most 9 data policies are allowed per field. + { # Data policy option. For more information, see [Mask data by applying data policies to a column](https://docs.cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column). + "name": "A String", # Data policy resource name in the form of projects/project_id/locations/location_id/dataPolicies/data_policy_id. + }, + ], + }, "defaultValueExpression": "A String", # Optional. A SQL expression to specify the [default value] (https://cloud.google.com/bigquery/docs/default-values) for this field. "description": "A String", # Optional. The field description. The maximum length is 1,024 characters. "fields": [ # Optional. Describes the nested schema fields if the type property is set to RECORD. @@ -7144,6 +7392,9 @@

Method Details

}, "functionStats": [ # Function level stats for GenAi Functions. See https://docs.cloud.google.com/bigquery/docs/generative-ai-overview { # Provides statistics for each Ai function call within a query. + "cacheStats": { # Provides cache statistics for a GenAi function call. # Cache stats for the function. + "numCacheHitRows": "A String", # Number of rows served from cache. + }, "costOptimizationStats": { # Provides cost optimization statistics for a GenAi function call. # Cost optimization stats if applied on the rows processed by the function. "message": "A String", # System generated message to provide insights into cost optimization state. "numCostOptimizedRows": "A String", # Number of rows inferred via cost optimized workflow. @@ -7750,6 +8001,20 @@

Method Details

"stageId": "A String", # Output only. The stage id that the insight mapped to. }, ], + "tableChangeInsights": [ # Output only. Performance insights for table-level attributes that changed compared to previous runs. + { # Table-level performance insights compared to previous runs. These insights don't apply to specific query stages, rather they apply to the whole table. + "metadataCacheNotUsedButUsedPreviously": True or False, # Output only. True if the table's column metadata index was not used in the current job, but was used in a previous job with the same query hash. + "metadataCacheStalenessInsight": { # Column Metadata Index staleness detailed infnormation. # Output only. If present, indicates that the table's metadata column index staleness has increased significantly compared to previous jobs with the same query hash. + "avgPreviousStalenessMs": "A String", # Output only. Average column metadata index staleness of previous runs with the same query hash. + "stalenessPercentageIncrease": 3.14, # Output only. The percent increase in staleness between the current job and the average staleness of previous jobs with the same query hash. + }, + "tableReference": { # Output only. The table that was queried. + "datasetId": "A String", # Required. The ID of the dataset containing this table. + "projectId": "A String", # Required. The ID of the project containing this table. + "tableId": "A String", # Required. The ID of the table. The ID can contain Unicode characters in category L (letter), M (mark), N (number), Pc (connector, including underscore), Pd (dash), and Zs (space). For more information, see [General Category](https://wikipedia.org/wiki/Unicode_character_property#General_Category). The maximum length is 1,024 characters. Certain operations allow suffixing of the table ID with a partition decorator, such as `sample_table$20190123`. + }, + }, + ], }, "queryInfo": { # Query optimization information for a QUERY job. # Output only. Query optimization information for a QUERY job. "optimizationDetails": { # Output only. Information about query optimizations. @@ -7836,11 +8101,23 @@

Method Details

], }, "collation": "A String", # Optional. Field collation can be set only when the type of field is STRING. The following values are supported: * 'und:ci': undetermined locale, case insensitive. * '': empty string. Default to case-sensitive behavior. + "dataGovernanceTagsInfo": { # Optional. Specifies the data governance tags on this field. This field works with other column-level security fields as follows: - Precedence: If a data governance tag is attached to a column, it takes precedence over the policy tag attached to the column. However, if a data policy is attached to a column, it takes precedence over the data governance tag. - Patching behavior (how this field behaves during a `Table.patch` schema update): - Unset: If the `data_governance_tags_info` field is omitted from the update request, the existing tags on the column are preserved. - Empty Field: To clear data governance tags from a column, send the `data_governance_tags_info` field as an empty object. This will remove all tags from the column. - Updating tags: To replace existing tag, send the field with the new tag. + "dataGovernanceTags": { # Optional. The data governance tags added to this field are used for field-level access control. Only one data governance tag is currently supported on a field. Tag keys are globally unique. Tag key is expected to be in the namespaced format, for example "123456789012/pii" where 123456789012 is the ID of the parent organization or project resource for this tag key. Tag value is expected to be the short name, for example "sensitive". See [Tag definitions](https://cloud.google.com/iam/docs/tags-access-control#definitions) for more details. For example: "123456789012/pii": "sensitive", "myProject/cost_center": "sales" + "a_key": "A String", + }, + }, "dataPolicies": [ # Optional. Data policies attached to this field, used for field-level access control. { # Data policy option. For more information, see [Mask data by applying data policies to a column](https://docs.cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column). "name": "A String", # Data policy resource name in the form of projects/project_id/locations/location_id/dataPolicies/data_policy_id. }, ], + "dataPolicyList": { # A list of data policy options. For more information, see [Mask data by applying data policies to a column](https://docs.cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column). # Optional. Specifies data policies attached to this field, used for field-level access control. When set, this will be the source of truth for data policy information. + "dataPolicies": [ # Contains a list of data policy options. At most 9 data policies are allowed per field. + { # Data policy option. For more information, see [Mask data by applying data policies to a column](https://docs.cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column). + "name": "A String", # Data policy resource name in the form of projects/project_id/locations/location_id/dataPolicies/data_policy_id. + }, + ], + }, "defaultValueExpression": "A String", # Optional. A SQL expression to specify the [default value] (https://cloud.google.com/bigquery/docs/default-values) for this field. "description": "A String", # Optional. The field description. The maximum length is 1,024 characters. "fields": [ # Optional. Describes the nested schema fields if the type property is set to RECORD. @@ -8224,11 +8501,23 @@

Method Details

], }, "collation": "A String", # Optional. Field collation can be set only when the type of field is STRING. The following values are supported: * 'und:ci': undetermined locale, case insensitive. * '': empty string. Default to case-sensitive behavior. + "dataGovernanceTagsInfo": { # Optional. Specifies the data governance tags on this field. This field works with other column-level security fields as follows: - Precedence: If a data governance tag is attached to a column, it takes precedence over the policy tag attached to the column. However, if a data policy is attached to a column, it takes precedence over the data governance tag. - Patching behavior (how this field behaves during a `Table.patch` schema update): - Unset: If the `data_governance_tags_info` field is omitted from the update request, the existing tags on the column are preserved. - Empty Field: To clear data governance tags from a column, send the `data_governance_tags_info` field as an empty object. This will remove all tags from the column. - Updating tags: To replace existing tag, send the field with the new tag. + "dataGovernanceTags": { # Optional. The data governance tags added to this field are used for field-level access control. Only one data governance tag is currently supported on a field. Tag keys are globally unique. Tag key is expected to be in the namespaced format, for example "123456789012/pii" where 123456789012 is the ID of the parent organization or project resource for this tag key. Tag value is expected to be the short name, for example "sensitive". See [Tag definitions](https://cloud.google.com/iam/docs/tags-access-control#definitions) for more details. For example: "123456789012/pii": "sensitive", "myProject/cost_center": "sales" + "a_key": "A String", + }, + }, "dataPolicies": [ # Optional. Data policies attached to this field, used for field-level access control. { # Data policy option. For more information, see [Mask data by applying data policies to a column](https://docs.cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column). "name": "A String", # Data policy resource name in the form of projects/project_id/locations/location_id/dataPolicies/data_policy_id. }, ], + "dataPolicyList": { # A list of data policy options. For more information, see [Mask data by applying data policies to a column](https://docs.cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column). # Optional. Specifies data policies attached to this field, used for field-level access control. When set, this will be the source of truth for data policy information. + "dataPolicies": [ # Contains a list of data policy options. At most 9 data policies are allowed per field. + { # Data policy option. For more information, see [Mask data by applying data policies to a column](https://docs.cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column). + "name": "A String", # Data policy resource name in the form of projects/project_id/locations/location_id/dataPolicies/data_policy_id. + }, + ], + }, "defaultValueExpression": "A String", # Optional. A SQL expression to specify the [default value] (https://cloud.google.com/bigquery/docs/default-values) for this field. "description": "A String", # Optional. The field description. The maximum length is 1,024 characters. "fields": [ # Optional. Describes the nested schema fields if the type property is set to RECORD. diff --git a/docs/dyn/bigquery_v2.routines.html b/docs/dyn/bigquery_v2.routines.html index 8e9090dba6..67a38c32e9 100644 --- a/docs/dyn/bigquery_v2.routines.html +++ b/docs/dyn/bigquery_v2.routines.html @@ -185,6 +185,7 @@

Method Details

"externalRuntimeOptions": { # Options for the runtime of the external system. # Optional. Options for the runtime of the external system executing the routine. This field is only applicable for Python UDFs. [Preview](https://cloud.google.com/products/#product-launch-stages) "containerCpu": 3.14, # Optional. Amount of CPU provisioned for a Python UDF container instance. For more information, see [Configure container limits for Python UDFs](https://cloud.google.com/bigquery/docs/user-defined-functions-python#configure-container-limits) "containerMemory": "A String", # Optional. Amount of memory provisioned for a Python UDF container instance. Format: {number}{unit} where unit is one of "M", "G", "Mi" and "Gi" (e.g. 1G, 512Mi). If not specified, the default value is 512Mi. For more information, see [Configure container limits for Python UDFs](https://cloud.google.com/bigquery/docs/user-defined-functions-python#configure-container-limits) + "containerRequestConcurrency": "A String", # Optional. Maximum number of requests that a Cloud Run instance can handle concurrently. If absent or if `0`, a default concurrency is used. "maxBatchingRows": "A String", # Optional. Maximum number of rows in each batch sent to the external runtime. If absent or if 0, BigQuery dynamically decides the number of rows in a batch. "runtimeConnection": "A String", # Optional. Fully qualified name of the connection whose service account will be used to execute the code in the container. Format: ```"projects/{project_id}/locations/{location_id}/connections/{connection_id}"``` "runtimeVersion": "A String", # Optional. Language runtime version. Example: `python-3.11`. @@ -371,6 +372,7 @@

Method Details

"externalRuntimeOptions": { # Options for the runtime of the external system. # Optional. Options for the runtime of the external system executing the routine. This field is only applicable for Python UDFs. [Preview](https://cloud.google.com/products/#product-launch-stages) "containerCpu": 3.14, # Optional. Amount of CPU provisioned for a Python UDF container instance. For more information, see [Configure container limits for Python UDFs](https://cloud.google.com/bigquery/docs/user-defined-functions-python#configure-container-limits) "containerMemory": "A String", # Optional. Amount of memory provisioned for a Python UDF container instance. Format: {number}{unit} where unit is one of "M", "G", "Mi" and "Gi" (e.g. 1G, 512Mi). If not specified, the default value is 512Mi. For more information, see [Configure container limits for Python UDFs](https://cloud.google.com/bigquery/docs/user-defined-functions-python#configure-container-limits) + "containerRequestConcurrency": "A String", # Optional. Maximum number of requests that a Cloud Run instance can handle concurrently. If absent or if `0`, a default concurrency is used. "maxBatchingRows": "A String", # Optional. Maximum number of rows in each batch sent to the external runtime. If absent or if 0, BigQuery dynamically decides the number of rows in a batch. "runtimeConnection": "A String", # Optional. Fully qualified name of the connection whose service account will be used to execute the code in the container. Format: ```"projects/{project_id}/locations/{location_id}/connections/{connection_id}"``` "runtimeVersion": "A String", # Optional. Language runtime version. Example: `python-3.11`. @@ -498,6 +500,7 @@

Method Details

"externalRuntimeOptions": { # Options for the runtime of the external system. # Optional. Options for the runtime of the external system executing the routine. This field is only applicable for Python UDFs. [Preview](https://cloud.google.com/products/#product-launch-stages) "containerCpu": 3.14, # Optional. Amount of CPU provisioned for a Python UDF container instance. For more information, see [Configure container limits for Python UDFs](https://cloud.google.com/bigquery/docs/user-defined-functions-python#configure-container-limits) "containerMemory": "A String", # Optional. Amount of memory provisioned for a Python UDF container instance. Format: {number}{unit} where unit is one of "M", "G", "Mi" and "Gi" (e.g. 1G, 512Mi). If not specified, the default value is 512Mi. For more information, see [Configure container limits for Python UDFs](https://cloud.google.com/bigquery/docs/user-defined-functions-python#configure-container-limits) + "containerRequestConcurrency": "A String", # Optional. Maximum number of requests that a Cloud Run instance can handle concurrently. If absent or if `0`, a default concurrency is used. "maxBatchingRows": "A String", # Optional. Maximum number of rows in each batch sent to the external runtime. If absent or if 0, BigQuery dynamically decides the number of rows in a batch. "runtimeConnection": "A String", # Optional. Fully qualified name of the connection whose service account will be used to execute the code in the container. Format: ```"projects/{project_id}/locations/{location_id}/connections/{connection_id}"``` "runtimeVersion": "A String", # Optional. Language runtime version. Example: `python-3.11`. @@ -640,6 +643,7 @@

Method Details

"externalRuntimeOptions": { # Options for the runtime of the external system. # Optional. Options for the runtime of the external system executing the routine. This field is only applicable for Python UDFs. [Preview](https://cloud.google.com/products/#product-launch-stages) "containerCpu": 3.14, # Optional. Amount of CPU provisioned for a Python UDF container instance. For more information, see [Configure container limits for Python UDFs](https://cloud.google.com/bigquery/docs/user-defined-functions-python#configure-container-limits) "containerMemory": "A String", # Optional. Amount of memory provisioned for a Python UDF container instance. Format: {number}{unit} where unit is one of "M", "G", "Mi" and "Gi" (e.g. 1G, 512Mi). If not specified, the default value is 512Mi. For more information, see [Configure container limits for Python UDFs](https://cloud.google.com/bigquery/docs/user-defined-functions-python#configure-container-limits) + "containerRequestConcurrency": "A String", # Optional. Maximum number of requests that a Cloud Run instance can handle concurrently. If absent or if `0`, a default concurrency is used. "maxBatchingRows": "A String", # Optional. Maximum number of rows in each batch sent to the external runtime. If absent or if 0, BigQuery dynamically decides the number of rows in a batch. "runtimeConnection": "A String", # Optional. Fully qualified name of the connection whose service account will be used to execute the code in the container. Format: ```"projects/{project_id}/locations/{location_id}/connections/{connection_id}"``` "runtimeVersion": "A String", # Optional. Language runtime version. Example: `python-3.11`. @@ -902,6 +906,7 @@

Method Details

"externalRuntimeOptions": { # Options for the runtime of the external system. # Optional. Options for the runtime of the external system executing the routine. This field is only applicable for Python UDFs. [Preview](https://cloud.google.com/products/#product-launch-stages) "containerCpu": 3.14, # Optional. Amount of CPU provisioned for a Python UDF container instance. For more information, see [Configure container limits for Python UDFs](https://cloud.google.com/bigquery/docs/user-defined-functions-python#configure-container-limits) "containerMemory": "A String", # Optional. Amount of memory provisioned for a Python UDF container instance. Format: {number}{unit} where unit is one of "M", "G", "Mi" and "Gi" (e.g. 1G, 512Mi). If not specified, the default value is 512Mi. For more information, see [Configure container limits for Python UDFs](https://cloud.google.com/bigquery/docs/user-defined-functions-python#configure-container-limits) + "containerRequestConcurrency": "A String", # Optional. Maximum number of requests that a Cloud Run instance can handle concurrently. If absent or if `0`, a default concurrency is used. "maxBatchingRows": "A String", # Optional. Maximum number of rows in each batch sent to the external runtime. If absent or if 0, BigQuery dynamically decides the number of rows in a batch. "runtimeConnection": "A String", # Optional. Fully qualified name of the connection whose service account will be used to execute the code in the container. Format: ```"projects/{project_id}/locations/{location_id}/connections/{connection_id}"``` "runtimeVersion": "A String", # Optional. Language runtime version. Example: `python-3.11`. @@ -1029,6 +1034,7 @@

Method Details

"externalRuntimeOptions": { # Options for the runtime of the external system. # Optional. Options for the runtime of the external system executing the routine. This field is only applicable for Python UDFs. [Preview](https://cloud.google.com/products/#product-launch-stages) "containerCpu": 3.14, # Optional. Amount of CPU provisioned for a Python UDF container instance. For more information, see [Configure container limits for Python UDFs](https://cloud.google.com/bigquery/docs/user-defined-functions-python#configure-container-limits) "containerMemory": "A String", # Optional. Amount of memory provisioned for a Python UDF container instance. Format: {number}{unit} where unit is one of "M", "G", "Mi" and "Gi" (e.g. 1G, 512Mi). If not specified, the default value is 512Mi. For more information, see [Configure container limits for Python UDFs](https://cloud.google.com/bigquery/docs/user-defined-functions-python#configure-container-limits) + "containerRequestConcurrency": "A String", # Optional. Maximum number of requests that a Cloud Run instance can handle concurrently. If absent or if `0`, a default concurrency is used. "maxBatchingRows": "A String", # Optional. Maximum number of rows in each batch sent to the external runtime. If absent or if 0, BigQuery dynamically decides the number of rows in a batch. "runtimeConnection": "A String", # Optional. Fully qualified name of the connection whose service account will be used to execute the code in the container. Format: ```"projects/{project_id}/locations/{location_id}/connections/{connection_id}"``` "runtimeVersion": "A String", # Optional. Language runtime version. Example: `python-3.11`. diff --git a/docs/dyn/bigquery_v2.tables.html b/docs/dyn/bigquery_v2.tables.html index a43b26573c..885c4ec298 100644 --- a/docs/dyn/bigquery_v2.tables.html +++ b/docs/dyn/bigquery_v2.tables.html @@ -291,11 +291,23 @@

Method Details

], }, "collation": "A String", # Optional. Field collation can be set only when the type of field is STRING. The following values are supported: * 'und:ci': undetermined locale, case insensitive. * '': empty string. Default to case-sensitive behavior. + "dataGovernanceTagsInfo": { # Optional. Specifies the data governance tags on this field. This field works with other column-level security fields as follows: - Precedence: If a data governance tag is attached to a column, it takes precedence over the policy tag attached to the column. However, if a data policy is attached to a column, it takes precedence over the data governance tag. - Patching behavior (how this field behaves during a `Table.patch` schema update): - Unset: If the `data_governance_tags_info` field is omitted from the update request, the existing tags on the column are preserved. - Empty Field: To clear data governance tags from a column, send the `data_governance_tags_info` field as an empty object. This will remove all tags from the column. - Updating tags: To replace existing tag, send the field with the new tag. + "dataGovernanceTags": { # Optional. The data governance tags added to this field are used for field-level access control. Only one data governance tag is currently supported on a field. Tag keys are globally unique. Tag key is expected to be in the namespaced format, for example "123456789012/pii" where 123456789012 is the ID of the parent organization or project resource for this tag key. Tag value is expected to be the short name, for example "sensitive". See [Tag definitions](https://cloud.google.com/iam/docs/tags-access-control#definitions) for more details. For example: "123456789012/pii": "sensitive", "myProject/cost_center": "sales" + "a_key": "A String", + }, + }, "dataPolicies": [ # Optional. Data policies attached to this field, used for field-level access control. { # Data policy option. For more information, see [Mask data by applying data policies to a column](https://docs.cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column). "name": "A String", # Data policy resource name in the form of projects/project_id/locations/location_id/dataPolicies/data_policy_id. }, ], + "dataPolicyList": { # A list of data policy options. For more information, see [Mask data by applying data policies to a column](https://docs.cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column). # Optional. Specifies data policies attached to this field, used for field-level access control. When set, this will be the source of truth for data policy information. + "dataPolicies": [ # Contains a list of data policy options. At most 9 data policies are allowed per field. + { # Data policy option. For more information, see [Mask data by applying data policies to a column](https://docs.cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column). + "name": "A String", # Data policy resource name in the form of projects/project_id/locations/location_id/dataPolicies/data_policy_id. + }, + ], + }, "defaultValueExpression": "A String", # Optional. A SQL expression to specify the [default value] (https://cloud.google.com/bigquery/docs/default-values) for this field. "description": "A String", # Optional. The field description. The maximum length is 1,024 characters. "fields": [ # Optional. Describes the nested schema fields if the type property is set to RECORD. @@ -456,11 +468,23 @@

Method Details

], }, "collation": "A String", # Optional. Field collation can be set only when the type of field is STRING. The following values are supported: * 'und:ci': undetermined locale, case insensitive. * '': empty string. Default to case-sensitive behavior. + "dataGovernanceTagsInfo": { # Optional. Specifies the data governance tags on this field. This field works with other column-level security fields as follows: - Precedence: If a data governance tag is attached to a column, it takes precedence over the policy tag attached to the column. However, if a data policy is attached to a column, it takes precedence over the data governance tag. - Patching behavior (how this field behaves during a `Table.patch` schema update): - Unset: If the `data_governance_tags_info` field is omitted from the update request, the existing tags on the column are preserved. - Empty Field: To clear data governance tags from a column, send the `data_governance_tags_info` field as an empty object. This will remove all tags from the column. - Updating tags: To replace existing tag, send the field with the new tag. + "dataGovernanceTags": { # Optional. The data governance tags added to this field are used for field-level access control. Only one data governance tag is currently supported on a field. Tag keys are globally unique. Tag key is expected to be in the namespaced format, for example "123456789012/pii" where 123456789012 is the ID of the parent organization or project resource for this tag key. Tag value is expected to be the short name, for example "sensitive". See [Tag definitions](https://cloud.google.com/iam/docs/tags-access-control#definitions) for more details. For example: "123456789012/pii": "sensitive", "myProject/cost_center": "sales" + "a_key": "A String", + }, + }, "dataPolicies": [ # Optional. Data policies attached to this field, used for field-level access control. { # Data policy option. For more information, see [Mask data by applying data policies to a column](https://docs.cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column). "name": "A String", # Data policy resource name in the form of projects/project_id/locations/location_id/dataPolicies/data_policy_id. }, ], + "dataPolicyList": { # A list of data policy options. For more information, see [Mask data by applying data policies to a column](https://docs.cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column). # Optional. Specifies data policies attached to this field, used for field-level access control. When set, this will be the source of truth for data policy information. + "dataPolicies": [ # Contains a list of data policy options. At most 9 data policies are allowed per field. + { # Data policy option. For more information, see [Mask data by applying data policies to a column](https://docs.cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column). + "name": "A String", # Data policy resource name in the form of projects/project_id/locations/location_id/dataPolicies/data_policy_id. + }, + ], + }, "defaultValueExpression": "A String", # Optional. A SQL expression to specify the [default value] (https://cloud.google.com/bigquery/docs/default-values) for this field. "description": "A String", # Optional. The field description. The maximum length is 1,024 characters. "fields": [ # Optional. Describes the nested schema fields if the type property is set to RECORD. @@ -812,11 +836,23 @@

Method Details

], }, "collation": "A String", # Optional. Field collation can be set only when the type of field is STRING. The following values are supported: * 'und:ci': undetermined locale, case insensitive. * '': empty string. Default to case-sensitive behavior. + "dataGovernanceTagsInfo": { # Optional. Specifies the data governance tags on this field. This field works with other column-level security fields as follows: - Precedence: If a data governance tag is attached to a column, it takes precedence over the policy tag attached to the column. However, if a data policy is attached to a column, it takes precedence over the data governance tag. - Patching behavior (how this field behaves during a `Table.patch` schema update): - Unset: If the `data_governance_tags_info` field is omitted from the update request, the existing tags on the column are preserved. - Empty Field: To clear data governance tags from a column, send the `data_governance_tags_info` field as an empty object. This will remove all tags from the column. - Updating tags: To replace existing tag, send the field with the new tag. + "dataGovernanceTags": { # Optional. The data governance tags added to this field are used for field-level access control. Only one data governance tag is currently supported on a field. Tag keys are globally unique. Tag key is expected to be in the namespaced format, for example "123456789012/pii" where 123456789012 is the ID of the parent organization or project resource for this tag key. Tag value is expected to be the short name, for example "sensitive". See [Tag definitions](https://cloud.google.com/iam/docs/tags-access-control#definitions) for more details. For example: "123456789012/pii": "sensitive", "myProject/cost_center": "sales" + "a_key": "A String", + }, + }, "dataPolicies": [ # Optional. Data policies attached to this field, used for field-level access control. { # Data policy option. For more information, see [Mask data by applying data policies to a column](https://docs.cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column). "name": "A String", # Data policy resource name in the form of projects/project_id/locations/location_id/dataPolicies/data_policy_id. }, ], + "dataPolicyList": { # A list of data policy options. For more information, see [Mask data by applying data policies to a column](https://docs.cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column). # Optional. Specifies data policies attached to this field, used for field-level access control. When set, this will be the source of truth for data policy information. + "dataPolicies": [ # Contains a list of data policy options. At most 9 data policies are allowed per field. + { # Data policy option. For more information, see [Mask data by applying data policies to a column](https://docs.cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column). + "name": "A String", # Data policy resource name in the form of projects/project_id/locations/location_id/dataPolicies/data_policy_id. + }, + ], + }, "defaultValueExpression": "A String", # Optional. A SQL expression to specify the [default value] (https://cloud.google.com/bigquery/docs/default-values) for this field. "description": "A String", # Optional. The field description. The maximum length is 1,024 characters. "fields": [ # Optional. Describes the nested schema fields if the type property is set to RECORD. @@ -977,11 +1013,23 @@

Method Details

], }, "collation": "A String", # Optional. Field collation can be set only when the type of field is STRING. The following values are supported: * 'und:ci': undetermined locale, case insensitive. * '': empty string. Default to case-sensitive behavior. + "dataGovernanceTagsInfo": { # Optional. Specifies the data governance tags on this field. This field works with other column-level security fields as follows: - Precedence: If a data governance tag is attached to a column, it takes precedence over the policy tag attached to the column. However, if a data policy is attached to a column, it takes precedence over the data governance tag. - Patching behavior (how this field behaves during a `Table.patch` schema update): - Unset: If the `data_governance_tags_info` field is omitted from the update request, the existing tags on the column are preserved. - Empty Field: To clear data governance tags from a column, send the `data_governance_tags_info` field as an empty object. This will remove all tags from the column. - Updating tags: To replace existing tag, send the field with the new tag. + "dataGovernanceTags": { # Optional. The data governance tags added to this field are used for field-level access control. Only one data governance tag is currently supported on a field. Tag keys are globally unique. Tag key is expected to be in the namespaced format, for example "123456789012/pii" where 123456789012 is the ID of the parent organization or project resource for this tag key. Tag value is expected to be the short name, for example "sensitive". See [Tag definitions](https://cloud.google.com/iam/docs/tags-access-control#definitions) for more details. For example: "123456789012/pii": "sensitive", "myProject/cost_center": "sales" + "a_key": "A String", + }, + }, "dataPolicies": [ # Optional. Data policies attached to this field, used for field-level access control. { # Data policy option. For more information, see [Mask data by applying data policies to a column](https://docs.cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column). "name": "A String", # Data policy resource name in the form of projects/project_id/locations/location_id/dataPolicies/data_policy_id. }, ], + "dataPolicyList": { # A list of data policy options. For more information, see [Mask data by applying data policies to a column](https://docs.cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column). # Optional. Specifies data policies attached to this field, used for field-level access control. When set, this will be the source of truth for data policy information. + "dataPolicies": [ # Contains a list of data policy options. At most 9 data policies are allowed per field. + { # Data policy option. For more information, see [Mask data by applying data policies to a column](https://docs.cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column). + "name": "A String", # Data policy resource name in the form of projects/project_id/locations/location_id/dataPolicies/data_policy_id. + }, + ], + }, "defaultValueExpression": "A String", # Optional. A SQL expression to specify the [default value] (https://cloud.google.com/bigquery/docs/default-values) for this field. "description": "A String", # Optional. The field description. The maximum length is 1,024 characters. "fields": [ # Optional. Describes the nested schema fields if the type property is set to RECORD. @@ -1274,11 +1322,23 @@

Method Details

], }, "collation": "A String", # Optional. Field collation can be set only when the type of field is STRING. The following values are supported: * 'und:ci': undetermined locale, case insensitive. * '': empty string. Default to case-sensitive behavior. + "dataGovernanceTagsInfo": { # Optional. Specifies the data governance tags on this field. This field works with other column-level security fields as follows: - Precedence: If a data governance tag is attached to a column, it takes precedence over the policy tag attached to the column. However, if a data policy is attached to a column, it takes precedence over the data governance tag. - Patching behavior (how this field behaves during a `Table.patch` schema update): - Unset: If the `data_governance_tags_info` field is omitted from the update request, the existing tags on the column are preserved. - Empty Field: To clear data governance tags from a column, send the `data_governance_tags_info` field as an empty object. This will remove all tags from the column. - Updating tags: To replace existing tag, send the field with the new tag. + "dataGovernanceTags": { # Optional. The data governance tags added to this field are used for field-level access control. Only one data governance tag is currently supported on a field. Tag keys are globally unique. Tag key is expected to be in the namespaced format, for example "123456789012/pii" where 123456789012 is the ID of the parent organization or project resource for this tag key. Tag value is expected to be the short name, for example "sensitive". See [Tag definitions](https://cloud.google.com/iam/docs/tags-access-control#definitions) for more details. For example: "123456789012/pii": "sensitive", "myProject/cost_center": "sales" + "a_key": "A String", + }, + }, "dataPolicies": [ # Optional. Data policies attached to this field, used for field-level access control. { # Data policy option. For more information, see [Mask data by applying data policies to a column](https://docs.cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column). "name": "A String", # Data policy resource name in the form of projects/project_id/locations/location_id/dataPolicies/data_policy_id. }, ], + "dataPolicyList": { # A list of data policy options. For more information, see [Mask data by applying data policies to a column](https://docs.cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column). # Optional. Specifies data policies attached to this field, used for field-level access control. When set, this will be the source of truth for data policy information. + "dataPolicies": [ # Contains a list of data policy options. At most 9 data policies are allowed per field. + { # Data policy option. For more information, see [Mask data by applying data policies to a column](https://docs.cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column). + "name": "A String", # Data policy resource name in the form of projects/project_id/locations/location_id/dataPolicies/data_policy_id. + }, + ], + }, "defaultValueExpression": "A String", # Optional. A SQL expression to specify the [default value] (https://cloud.google.com/bigquery/docs/default-values) for this field. "description": "A String", # Optional. The field description. The maximum length is 1,024 characters. "fields": [ # Optional. Describes the nested schema fields if the type property is set to RECORD. @@ -1439,11 +1499,23 @@

Method Details

], }, "collation": "A String", # Optional. Field collation can be set only when the type of field is STRING. The following values are supported: * 'und:ci': undetermined locale, case insensitive. * '': empty string. Default to case-sensitive behavior. + "dataGovernanceTagsInfo": { # Optional. Specifies the data governance tags on this field. This field works with other column-level security fields as follows: - Precedence: If a data governance tag is attached to a column, it takes precedence over the policy tag attached to the column. However, if a data policy is attached to a column, it takes precedence over the data governance tag. - Patching behavior (how this field behaves during a `Table.patch` schema update): - Unset: If the `data_governance_tags_info` field is omitted from the update request, the existing tags on the column are preserved. - Empty Field: To clear data governance tags from a column, send the `data_governance_tags_info` field as an empty object. This will remove all tags from the column. - Updating tags: To replace existing tag, send the field with the new tag. + "dataGovernanceTags": { # Optional. The data governance tags added to this field are used for field-level access control. Only one data governance tag is currently supported on a field. Tag keys are globally unique. Tag key is expected to be in the namespaced format, for example "123456789012/pii" where 123456789012 is the ID of the parent organization or project resource for this tag key. Tag value is expected to be the short name, for example "sensitive". See [Tag definitions](https://cloud.google.com/iam/docs/tags-access-control#definitions) for more details. For example: "123456789012/pii": "sensitive", "myProject/cost_center": "sales" + "a_key": "A String", + }, + }, "dataPolicies": [ # Optional. Data policies attached to this field, used for field-level access control. { # Data policy option. For more information, see [Mask data by applying data policies to a column](https://docs.cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column). "name": "A String", # Data policy resource name in the form of projects/project_id/locations/location_id/dataPolicies/data_policy_id. }, ], + "dataPolicyList": { # A list of data policy options. For more information, see [Mask data by applying data policies to a column](https://docs.cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column). # Optional. Specifies data policies attached to this field, used for field-level access control. When set, this will be the source of truth for data policy information. + "dataPolicies": [ # Contains a list of data policy options. At most 9 data policies are allowed per field. + { # Data policy option. For more information, see [Mask data by applying data policies to a column](https://docs.cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column). + "name": "A String", # Data policy resource name in the form of projects/project_id/locations/location_id/dataPolicies/data_policy_id. + }, + ], + }, "defaultValueExpression": "A String", # Optional. A SQL expression to specify the [default value] (https://cloud.google.com/bigquery/docs/default-values) for this field. "description": "A String", # Optional. The field description. The maximum length is 1,024 characters. "fields": [ # Optional. Describes the nested schema fields if the type property is set to RECORD. @@ -1844,11 +1916,23 @@

Method Details

], }, "collation": "A String", # Optional. Field collation can be set only when the type of field is STRING. The following values are supported: * 'und:ci': undetermined locale, case insensitive. * '': empty string. Default to case-sensitive behavior. + "dataGovernanceTagsInfo": { # Optional. Specifies the data governance tags on this field. This field works with other column-level security fields as follows: - Precedence: If a data governance tag is attached to a column, it takes precedence over the policy tag attached to the column. However, if a data policy is attached to a column, it takes precedence over the data governance tag. - Patching behavior (how this field behaves during a `Table.patch` schema update): - Unset: If the `data_governance_tags_info` field is omitted from the update request, the existing tags on the column are preserved. - Empty Field: To clear data governance tags from a column, send the `data_governance_tags_info` field as an empty object. This will remove all tags from the column. - Updating tags: To replace existing tag, send the field with the new tag. + "dataGovernanceTags": { # Optional. The data governance tags added to this field are used for field-level access control. Only one data governance tag is currently supported on a field. Tag keys are globally unique. Tag key is expected to be in the namespaced format, for example "123456789012/pii" where 123456789012 is the ID of the parent organization or project resource for this tag key. Tag value is expected to be the short name, for example "sensitive". See [Tag definitions](https://cloud.google.com/iam/docs/tags-access-control#definitions) for more details. For example: "123456789012/pii": "sensitive", "myProject/cost_center": "sales" + "a_key": "A String", + }, + }, "dataPolicies": [ # Optional. Data policies attached to this field, used for field-level access control. { # Data policy option. For more information, see [Mask data by applying data policies to a column](https://docs.cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column). "name": "A String", # Data policy resource name in the form of projects/project_id/locations/location_id/dataPolicies/data_policy_id. }, ], + "dataPolicyList": { # A list of data policy options. For more information, see [Mask data by applying data policies to a column](https://docs.cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column). # Optional. Specifies data policies attached to this field, used for field-level access control. When set, this will be the source of truth for data policy information. + "dataPolicies": [ # Contains a list of data policy options. At most 9 data policies are allowed per field. + { # Data policy option. For more information, see [Mask data by applying data policies to a column](https://docs.cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column). + "name": "A String", # Data policy resource name in the form of projects/project_id/locations/location_id/dataPolicies/data_policy_id. + }, + ], + }, "defaultValueExpression": "A String", # Optional. A SQL expression to specify the [default value] (https://cloud.google.com/bigquery/docs/default-values) for this field. "description": "A String", # Optional. The field description. The maximum length is 1,024 characters. "fields": [ # Optional. Describes the nested schema fields if the type property is set to RECORD. @@ -2009,11 +2093,23 @@

Method Details

], }, "collation": "A String", # Optional. Field collation can be set only when the type of field is STRING. The following values are supported: * 'und:ci': undetermined locale, case insensitive. * '': empty string. Default to case-sensitive behavior. + "dataGovernanceTagsInfo": { # Optional. Specifies the data governance tags on this field. This field works with other column-level security fields as follows: - Precedence: If a data governance tag is attached to a column, it takes precedence over the policy tag attached to the column. However, if a data policy is attached to a column, it takes precedence over the data governance tag. - Patching behavior (how this field behaves during a `Table.patch` schema update): - Unset: If the `data_governance_tags_info` field is omitted from the update request, the existing tags on the column are preserved. - Empty Field: To clear data governance tags from a column, send the `data_governance_tags_info` field as an empty object. This will remove all tags from the column. - Updating tags: To replace existing tag, send the field with the new tag. + "dataGovernanceTags": { # Optional. The data governance tags added to this field are used for field-level access control. Only one data governance tag is currently supported on a field. Tag keys are globally unique. Tag key is expected to be in the namespaced format, for example "123456789012/pii" where 123456789012 is the ID of the parent organization or project resource for this tag key. Tag value is expected to be the short name, for example "sensitive". See [Tag definitions](https://cloud.google.com/iam/docs/tags-access-control#definitions) for more details. For example: "123456789012/pii": "sensitive", "myProject/cost_center": "sales" + "a_key": "A String", + }, + }, "dataPolicies": [ # Optional. Data policies attached to this field, used for field-level access control. { # Data policy option. For more information, see [Mask data by applying data policies to a column](https://docs.cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column). "name": "A String", # Data policy resource name in the form of projects/project_id/locations/location_id/dataPolicies/data_policy_id. }, ], + "dataPolicyList": { # A list of data policy options. For more information, see [Mask data by applying data policies to a column](https://docs.cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column). # Optional. Specifies data policies attached to this field, used for field-level access control. When set, this will be the source of truth for data policy information. + "dataPolicies": [ # Contains a list of data policy options. At most 9 data policies are allowed per field. + { # Data policy option. For more information, see [Mask data by applying data policies to a column](https://docs.cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column). + "name": "A String", # Data policy resource name in the form of projects/project_id/locations/location_id/dataPolicies/data_policy_id. + }, + ], + }, "defaultValueExpression": "A String", # Optional. A SQL expression to specify the [default value] (https://cloud.google.com/bigquery/docs/default-values) for this field. "description": "A String", # Optional. The field description. The maximum length is 1,024 characters. "fields": [ # Optional. Describes the nested schema fields if the type property is set to RECORD. @@ -2307,11 +2403,23 @@

Method Details

], }, "collation": "A String", # Optional. Field collation can be set only when the type of field is STRING. The following values are supported: * 'und:ci': undetermined locale, case insensitive. * '': empty string. Default to case-sensitive behavior. + "dataGovernanceTagsInfo": { # Optional. Specifies the data governance tags on this field. This field works with other column-level security fields as follows: - Precedence: If a data governance tag is attached to a column, it takes precedence over the policy tag attached to the column. However, if a data policy is attached to a column, it takes precedence over the data governance tag. - Patching behavior (how this field behaves during a `Table.patch` schema update): - Unset: If the `data_governance_tags_info` field is omitted from the update request, the existing tags on the column are preserved. - Empty Field: To clear data governance tags from a column, send the `data_governance_tags_info` field as an empty object. This will remove all tags from the column. - Updating tags: To replace existing tag, send the field with the new tag. + "dataGovernanceTags": { # Optional. The data governance tags added to this field are used for field-level access control. Only one data governance tag is currently supported on a field. Tag keys are globally unique. Tag key is expected to be in the namespaced format, for example "123456789012/pii" where 123456789012 is the ID of the parent organization or project resource for this tag key. Tag value is expected to be the short name, for example "sensitive". See [Tag definitions](https://cloud.google.com/iam/docs/tags-access-control#definitions) for more details. For example: "123456789012/pii": "sensitive", "myProject/cost_center": "sales" + "a_key": "A String", + }, + }, "dataPolicies": [ # Optional. Data policies attached to this field, used for field-level access control. { # Data policy option. For more information, see [Mask data by applying data policies to a column](https://docs.cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column). "name": "A String", # Data policy resource name in the form of projects/project_id/locations/location_id/dataPolicies/data_policy_id. }, ], + "dataPolicyList": { # A list of data policy options. For more information, see [Mask data by applying data policies to a column](https://docs.cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column). # Optional. Specifies data policies attached to this field, used for field-level access control. When set, this will be the source of truth for data policy information. + "dataPolicies": [ # Contains a list of data policy options. At most 9 data policies are allowed per field. + { # Data policy option. For more information, see [Mask data by applying data policies to a column](https://docs.cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column). + "name": "A String", # Data policy resource name in the form of projects/project_id/locations/location_id/dataPolicies/data_policy_id. + }, + ], + }, "defaultValueExpression": "A String", # Optional. A SQL expression to specify the [default value] (https://cloud.google.com/bigquery/docs/default-values) for this field. "description": "A String", # Optional. The field description. The maximum length is 1,024 characters. "fields": [ # Optional. Describes the nested schema fields if the type property is set to RECORD. @@ -2472,11 +2580,23 @@

Method Details

], }, "collation": "A String", # Optional. Field collation can be set only when the type of field is STRING. The following values are supported: * 'und:ci': undetermined locale, case insensitive. * '': empty string. Default to case-sensitive behavior. + "dataGovernanceTagsInfo": { # Optional. Specifies the data governance tags on this field. This field works with other column-level security fields as follows: - Precedence: If a data governance tag is attached to a column, it takes precedence over the policy tag attached to the column. However, if a data policy is attached to a column, it takes precedence over the data governance tag. - Patching behavior (how this field behaves during a `Table.patch` schema update): - Unset: If the `data_governance_tags_info` field is omitted from the update request, the existing tags on the column are preserved. - Empty Field: To clear data governance tags from a column, send the `data_governance_tags_info` field as an empty object. This will remove all tags from the column. - Updating tags: To replace existing tag, send the field with the new tag. + "dataGovernanceTags": { # Optional. The data governance tags added to this field are used for field-level access control. Only one data governance tag is currently supported on a field. Tag keys are globally unique. Tag key is expected to be in the namespaced format, for example "123456789012/pii" where 123456789012 is the ID of the parent organization or project resource for this tag key. Tag value is expected to be the short name, for example "sensitive". See [Tag definitions](https://cloud.google.com/iam/docs/tags-access-control#definitions) for more details. For example: "123456789012/pii": "sensitive", "myProject/cost_center": "sales" + "a_key": "A String", + }, + }, "dataPolicies": [ # Optional. Data policies attached to this field, used for field-level access control. { # Data policy option. For more information, see [Mask data by applying data policies to a column](https://docs.cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column). "name": "A String", # Data policy resource name in the form of projects/project_id/locations/location_id/dataPolicies/data_policy_id. }, ], + "dataPolicyList": { # A list of data policy options. For more information, see [Mask data by applying data policies to a column](https://docs.cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column). # Optional. Specifies data policies attached to this field, used for field-level access control. When set, this will be the source of truth for data policy information. + "dataPolicies": [ # Contains a list of data policy options. At most 9 data policies are allowed per field. + { # Data policy option. For more information, see [Mask data by applying data policies to a column](https://docs.cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column). + "name": "A String", # Data policy resource name in the form of projects/project_id/locations/location_id/dataPolicies/data_policy_id. + }, + ], + }, "defaultValueExpression": "A String", # Optional. A SQL expression to specify the [default value] (https://cloud.google.com/bigquery/docs/default-values) for this field. "description": "A String", # Optional. The field description. The maximum length is 1,024 characters. "fields": [ # Optional. Describes the nested schema fields if the type property is set to RECORD. @@ -2888,11 +3008,23 @@

Method Details

], }, "collation": "A String", # Optional. Field collation can be set only when the type of field is STRING. The following values are supported: * 'und:ci': undetermined locale, case insensitive. * '': empty string. Default to case-sensitive behavior. + "dataGovernanceTagsInfo": { # Optional. Specifies the data governance tags on this field. This field works with other column-level security fields as follows: - Precedence: If a data governance tag is attached to a column, it takes precedence over the policy tag attached to the column. However, if a data policy is attached to a column, it takes precedence over the data governance tag. - Patching behavior (how this field behaves during a `Table.patch` schema update): - Unset: If the `data_governance_tags_info` field is omitted from the update request, the existing tags on the column are preserved. - Empty Field: To clear data governance tags from a column, send the `data_governance_tags_info` field as an empty object. This will remove all tags from the column. - Updating tags: To replace existing tag, send the field with the new tag. + "dataGovernanceTags": { # Optional. The data governance tags added to this field are used for field-level access control. Only one data governance tag is currently supported on a field. Tag keys are globally unique. Tag key is expected to be in the namespaced format, for example "123456789012/pii" where 123456789012 is the ID of the parent organization or project resource for this tag key. Tag value is expected to be the short name, for example "sensitive". See [Tag definitions](https://cloud.google.com/iam/docs/tags-access-control#definitions) for more details. For example: "123456789012/pii": "sensitive", "myProject/cost_center": "sales" + "a_key": "A String", + }, + }, "dataPolicies": [ # Optional. Data policies attached to this field, used for field-level access control. { # Data policy option. For more information, see [Mask data by applying data policies to a column](https://docs.cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column). "name": "A String", # Data policy resource name in the form of projects/project_id/locations/location_id/dataPolicies/data_policy_id. }, ], + "dataPolicyList": { # A list of data policy options. For more information, see [Mask data by applying data policies to a column](https://docs.cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column). # Optional. Specifies data policies attached to this field, used for field-level access control. When set, this will be the source of truth for data policy information. + "dataPolicies": [ # Contains a list of data policy options. At most 9 data policies are allowed per field. + { # Data policy option. For more information, see [Mask data by applying data policies to a column](https://docs.cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column). + "name": "A String", # Data policy resource name in the form of projects/project_id/locations/location_id/dataPolicies/data_policy_id. + }, + ], + }, "defaultValueExpression": "A String", # Optional. A SQL expression to specify the [default value] (https://cloud.google.com/bigquery/docs/default-values) for this field. "description": "A String", # Optional. The field description. The maximum length is 1,024 characters. "fields": [ # Optional. Describes the nested schema fields if the type property is set to RECORD. @@ -3053,11 +3185,23 @@

Method Details

], }, "collation": "A String", # Optional. Field collation can be set only when the type of field is STRING. The following values are supported: * 'und:ci': undetermined locale, case insensitive. * '': empty string. Default to case-sensitive behavior. + "dataGovernanceTagsInfo": { # Optional. Specifies the data governance tags on this field. This field works with other column-level security fields as follows: - Precedence: If a data governance tag is attached to a column, it takes precedence over the policy tag attached to the column. However, if a data policy is attached to a column, it takes precedence over the data governance tag. - Patching behavior (how this field behaves during a `Table.patch` schema update): - Unset: If the `data_governance_tags_info` field is omitted from the update request, the existing tags on the column are preserved. - Empty Field: To clear data governance tags from a column, send the `data_governance_tags_info` field as an empty object. This will remove all tags from the column. - Updating tags: To replace existing tag, send the field with the new tag. + "dataGovernanceTags": { # Optional. The data governance tags added to this field are used for field-level access control. Only one data governance tag is currently supported on a field. Tag keys are globally unique. Tag key is expected to be in the namespaced format, for example "123456789012/pii" where 123456789012 is the ID of the parent organization or project resource for this tag key. Tag value is expected to be the short name, for example "sensitive". See [Tag definitions](https://cloud.google.com/iam/docs/tags-access-control#definitions) for more details. For example: "123456789012/pii": "sensitive", "myProject/cost_center": "sales" + "a_key": "A String", + }, + }, "dataPolicies": [ # Optional. Data policies attached to this field, used for field-level access control. { # Data policy option. For more information, see [Mask data by applying data policies to a column](https://docs.cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column). "name": "A String", # Data policy resource name in the form of projects/project_id/locations/location_id/dataPolicies/data_policy_id. }, ], + "dataPolicyList": { # A list of data policy options. For more information, see [Mask data by applying data policies to a column](https://docs.cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column). # Optional. Specifies data policies attached to this field, used for field-level access control. When set, this will be the source of truth for data policy information. + "dataPolicies": [ # Contains a list of data policy options. At most 9 data policies are allowed per field. + { # Data policy option. For more information, see [Mask data by applying data policies to a column](https://docs.cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column). + "name": "A String", # Data policy resource name in the form of projects/project_id/locations/location_id/dataPolicies/data_policy_id. + }, + ], + }, "defaultValueExpression": "A String", # Optional. A SQL expression to specify the [default value] (https://cloud.google.com/bigquery/docs/default-values) for this field. "description": "A String", # Optional. The field description. The maximum length is 1,024 characters. "fields": [ # Optional. Describes the nested schema fields if the type property is set to RECORD. @@ -3351,11 +3495,23 @@

Method Details

], }, "collation": "A String", # Optional. Field collation can be set only when the type of field is STRING. The following values are supported: * 'und:ci': undetermined locale, case insensitive. * '': empty string. Default to case-sensitive behavior. + "dataGovernanceTagsInfo": { # Optional. Specifies the data governance tags on this field. This field works with other column-level security fields as follows: - Precedence: If a data governance tag is attached to a column, it takes precedence over the policy tag attached to the column. However, if a data policy is attached to a column, it takes precedence over the data governance tag. - Patching behavior (how this field behaves during a `Table.patch` schema update): - Unset: If the `data_governance_tags_info` field is omitted from the update request, the existing tags on the column are preserved. - Empty Field: To clear data governance tags from a column, send the `data_governance_tags_info` field as an empty object. This will remove all tags from the column. - Updating tags: To replace existing tag, send the field with the new tag. + "dataGovernanceTags": { # Optional. The data governance tags added to this field are used for field-level access control. Only one data governance tag is currently supported on a field. Tag keys are globally unique. Tag key is expected to be in the namespaced format, for example "123456789012/pii" where 123456789012 is the ID of the parent organization or project resource for this tag key. Tag value is expected to be the short name, for example "sensitive". See [Tag definitions](https://cloud.google.com/iam/docs/tags-access-control#definitions) for more details. For example: "123456789012/pii": "sensitive", "myProject/cost_center": "sales" + "a_key": "A String", + }, + }, "dataPolicies": [ # Optional. Data policies attached to this field, used for field-level access control. { # Data policy option. For more information, see [Mask data by applying data policies to a column](https://docs.cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column). "name": "A String", # Data policy resource name in the form of projects/project_id/locations/location_id/dataPolicies/data_policy_id. }, ], + "dataPolicyList": { # A list of data policy options. For more information, see [Mask data by applying data policies to a column](https://docs.cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column). # Optional. Specifies data policies attached to this field, used for field-level access control. When set, this will be the source of truth for data policy information. + "dataPolicies": [ # Contains a list of data policy options. At most 9 data policies are allowed per field. + { # Data policy option. For more information, see [Mask data by applying data policies to a column](https://docs.cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column). + "name": "A String", # Data policy resource name in the form of projects/project_id/locations/location_id/dataPolicies/data_policy_id. + }, + ], + }, "defaultValueExpression": "A String", # Optional. A SQL expression to specify the [default value] (https://cloud.google.com/bigquery/docs/default-values) for this field. "description": "A String", # Optional. The field description. The maximum length is 1,024 characters. "fields": [ # Optional. Describes the nested schema fields if the type property is set to RECORD. @@ -3516,11 +3672,23 @@

Method Details

], }, "collation": "A String", # Optional. Field collation can be set only when the type of field is STRING. The following values are supported: * 'und:ci': undetermined locale, case insensitive. * '': empty string. Default to case-sensitive behavior. + "dataGovernanceTagsInfo": { # Optional. Specifies the data governance tags on this field. This field works with other column-level security fields as follows: - Precedence: If a data governance tag is attached to a column, it takes precedence over the policy tag attached to the column. However, if a data policy is attached to a column, it takes precedence over the data governance tag. - Patching behavior (how this field behaves during a `Table.patch` schema update): - Unset: If the `data_governance_tags_info` field is omitted from the update request, the existing tags on the column are preserved. - Empty Field: To clear data governance tags from a column, send the `data_governance_tags_info` field as an empty object. This will remove all tags from the column. - Updating tags: To replace existing tag, send the field with the new tag. + "dataGovernanceTags": { # Optional. The data governance tags added to this field are used for field-level access control. Only one data governance tag is currently supported on a field. Tag keys are globally unique. Tag key is expected to be in the namespaced format, for example "123456789012/pii" where 123456789012 is the ID of the parent organization or project resource for this tag key. Tag value is expected to be the short name, for example "sensitive". See [Tag definitions](https://cloud.google.com/iam/docs/tags-access-control#definitions) for more details. For example: "123456789012/pii": "sensitive", "myProject/cost_center": "sales" + "a_key": "A String", + }, + }, "dataPolicies": [ # Optional. Data policies attached to this field, used for field-level access control. { # Data policy option. For more information, see [Mask data by applying data policies to a column](https://docs.cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column). "name": "A String", # Data policy resource name in the form of projects/project_id/locations/location_id/dataPolicies/data_policy_id. }, ], + "dataPolicyList": { # A list of data policy options. For more information, see [Mask data by applying data policies to a column](https://docs.cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column). # Optional. Specifies data policies attached to this field, used for field-level access control. When set, this will be the source of truth for data policy information. + "dataPolicies": [ # Contains a list of data policy options. At most 9 data policies are allowed per field. + { # Data policy option. For more information, see [Mask data by applying data policies to a column](https://docs.cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column). + "name": "A String", # Data policy resource name in the form of projects/project_id/locations/location_id/dataPolicies/data_policy_id. + }, + ], + }, "defaultValueExpression": "A String", # Optional. A SQL expression to specify the [default value] (https://cloud.google.com/bigquery/docs/default-values) for this field. "description": "A String", # Optional. The field description. The maximum length is 1,024 characters. "fields": [ # Optional. Describes the nested schema fields if the type property is set to RECORD. diff --git a/docs/dyn/bigtableadmin_v2.projects.instances.tables.html b/docs/dyn/bigtableadmin_v2.projects.instances.tables.html index c899763fac..52018bcb2f 100644 --- a/docs/dyn/bigtableadmin_v2.projects.instances.tables.html +++ b/docs/dyn/bigtableadmin_v2.projects.instances.tables.html @@ -186,7 +186,7 @@

Method Details

"table": { # A collection of user data indexed by row, column, and timestamp. Each table is served using the resources of its parent cluster. # Required. The Table to create. "automatedBackupPolicy": { # Defines an automated backup policy for a table # If specified, automated backups are enabled for this table. Otherwise, automated backups are disabled. "frequency": "A String", # How frequently automated backups should occur. The only supported value at this time is 24 hours. An undefined frequency is treated as 24 hours. - "locations": [ # Optional. A list of Cloud Bigtable zones where automated backups are allowed to be created. If empty, automated backups will be created in all zones of the instance. Locations are in the format `projects/{project}/locations/{zone}`. This field can only set for tables in Enterprise Plus instances. + "locations": [ # Optional. A list of Cloud Bigtable zones where automated backups are allowed to be created. If empty, automated backups will be created in all zones of the instance. Locations are in the format `projects/{project}/locations/{zone}`. You can set this field only for tables in Enterprise Plus instances. "A String", ], "retentionPeriod": "A String", # Required. How long the automated backups should be retained. Values must be at least 3 days and at most 90 days. @@ -407,7 +407,7 @@

Method Details

{ # A collection of user data indexed by row, column, and timestamp. Each table is served using the resources of its parent cluster. "automatedBackupPolicy": { # Defines an automated backup policy for a table # If specified, automated backups are enabled for this table. Otherwise, automated backups are disabled. "frequency": "A String", # How frequently automated backups should occur. The only supported value at this time is 24 hours. An undefined frequency is treated as 24 hours. - "locations": [ # Optional. A list of Cloud Bigtable zones where automated backups are allowed to be created. If empty, automated backups will be created in all zones of the instance. Locations are in the format `projects/{project}/locations/{zone}`. This field can only set for tables in Enterprise Plus instances. + "locations": [ # Optional. A list of Cloud Bigtable zones where automated backups are allowed to be created. If empty, automated backups will be created in all zones of the instance. Locations are in the format `projects/{project}/locations/{zone}`. You can set this field only for tables in Enterprise Plus instances. "A String", ], "retentionPeriod": "A String", # Required. How long the automated backups should be retained. Values must be at least 3 days and at most 90 days. @@ -711,7 +711,7 @@

Method Details

{ # A collection of user data indexed by row, column, and timestamp. Each table is served using the resources of its parent cluster. "automatedBackupPolicy": { # Defines an automated backup policy for a table # If specified, automated backups are enabled for this table. Otherwise, automated backups are disabled. "frequency": "A String", # How frequently automated backups should occur. The only supported value at this time is 24 hours. An undefined frequency is treated as 24 hours. - "locations": [ # Optional. A list of Cloud Bigtable zones where automated backups are allowed to be created. If empty, automated backups will be created in all zones of the instance. Locations are in the format `projects/{project}/locations/{zone}`. This field can only set for tables in Enterprise Plus instances. + "locations": [ # Optional. A list of Cloud Bigtable zones where automated backups are allowed to be created. If empty, automated backups will be created in all zones of the instance. Locations are in the format `projects/{project}/locations/{zone}`. You can set this field only for tables in Enterprise Plus instances. "A String", ], "retentionPeriod": "A String", # Required. How long the automated backups should be retained. Values must be at least 3 days and at most 90 days. @@ -1007,7 +1007,7 @@

Method Details

{ # A collection of user data indexed by row, column, and timestamp. Each table is served using the resources of its parent cluster. "automatedBackupPolicy": { # Defines an automated backup policy for a table # If specified, automated backups are enabled for this table. Otherwise, automated backups are disabled. "frequency": "A String", # How frequently automated backups should occur. The only supported value at this time is 24 hours. An undefined frequency is treated as 24 hours. - "locations": [ # Optional. A list of Cloud Bigtable zones where automated backups are allowed to be created. If empty, automated backups will be created in all zones of the instance. Locations are in the format `projects/{project}/locations/{zone}`. This field can only set for tables in Enterprise Plus instances. + "locations": [ # Optional. A list of Cloud Bigtable zones where automated backups are allowed to be created. If empty, automated backups will be created in all zones of the instance. Locations are in the format `projects/{project}/locations/{zone}`. You can set this field only for tables in Enterprise Plus instances. "A String", ], "retentionPeriod": "A String", # Required. How long the automated backups should be retained. Values must be at least 3 days and at most 90 days. @@ -1533,7 +1533,7 @@

Method Details

{ # A collection of user data indexed by row, column, and timestamp. Each table is served using the resources of its parent cluster. "automatedBackupPolicy": { # Defines an automated backup policy for a table # If specified, automated backups are enabled for this table. Otherwise, automated backups are disabled. "frequency": "A String", # How frequently automated backups should occur. The only supported value at this time is 24 hours. An undefined frequency is treated as 24 hours. - "locations": [ # Optional. A list of Cloud Bigtable zones where automated backups are allowed to be created. If empty, automated backups will be created in all zones of the instance. Locations are in the format `projects/{project}/locations/{zone}`. This field can only set for tables in Enterprise Plus instances. + "locations": [ # Optional. A list of Cloud Bigtable zones where automated backups are allowed to be created. If empty, automated backups will be created in all zones of the instance. Locations are in the format `projects/{project}/locations/{zone}`. You can set this field only for tables in Enterprise Plus instances. "A String", ], "retentionPeriod": "A String", # Required. How long the automated backups should be retained. Values must be at least 3 days and at most 90 days. @@ -1754,7 +1754,7 @@

Method Details

{ # A collection of user data indexed by row, column, and timestamp. Each table is served using the resources of its parent cluster. "automatedBackupPolicy": { # Defines an automated backup policy for a table # If specified, automated backups are enabled for this table. Otherwise, automated backups are disabled. "frequency": "A String", # How frequently automated backups should occur. The only supported value at this time is 24 hours. An undefined frequency is treated as 24 hours. - "locations": [ # Optional. A list of Cloud Bigtable zones where automated backups are allowed to be created. If empty, automated backups will be created in all zones of the instance. Locations are in the format `projects/{project}/locations/{zone}`. This field can only set for tables in Enterprise Plus instances. + "locations": [ # Optional. A list of Cloud Bigtable zones where automated backups are allowed to be created. If empty, automated backups will be created in all zones of the instance. Locations are in the format `projects/{project}/locations/{zone}`. You can set this field only for tables in Enterprise Plus instances. "A String", ], "retentionPeriod": "A String", # Required. How long the automated backups should be retained. Values must be at least 3 days and at most 90 days. diff --git a/docs/dyn/bigtableadmin_v2.projects.instances.tables.schemaBundles.html b/docs/dyn/bigtableadmin_v2.projects.instances.tables.schemaBundles.html index 0febadc908..83367f7658 100644 --- a/docs/dyn/bigtableadmin_v2.projects.instances.tables.schemaBundles.html +++ b/docs/dyn/bigtableadmin_v2.projects.instances.tables.schemaBundles.html @@ -122,7 +122,7 @@

Method Details

{ # A named collection of related schemas. "etag": "A String", # Optional. The etag for this schema bundle. This may be sent on update and delete requests to ensure 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 identifying this schema bundle. Values are of the form `projects/{project}/instances/{instance}/tables/{table}/schemaBundles/{schema_bundle}` - "protoSchema": { # Represents a protobuf schema. # Schema for Protobufs. + "protoSchema": { # Represents a collection of protobuf schemas. # Schema for Protobufs. "protoDescriptors": "A String", # Required. Contains a protobuf-serialized [google.protobuf.FileDescriptorSet](https://github.com/protocolbuffers/protobuf/blob/main/src/google/protobuf/descriptor.proto), which could include multiple proto files. To generate it, [install](https://grpc.io/docs/protoc-installation/) and run `protoc` with `--include_imports` and `--descriptor_set_out`. For example, to generate for moon/shot/app.proto, run ``` $protoc --proto_path=/app_path --proto_path=/lib_path \ --include_imports \ --descriptor_set_out=descriptors.pb \ moon/shot/app.proto ``` For more details, see protobuffer [self description](https://developers.google.com/protocol-buffers/docs/techniques#self-description). }, } @@ -193,7 +193,7 @@

Method Details

{ # A named collection of related schemas. "etag": "A String", # Optional. The etag for this schema bundle. This may be sent on update and delete requests to ensure 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 identifying this schema bundle. Values are of the form `projects/{project}/instances/{instance}/tables/{table}/schemaBundles/{schema_bundle}` - "protoSchema": { # Represents a protobuf schema. # Schema for Protobufs. + "protoSchema": { # Represents a collection of protobuf schemas. # Schema for Protobufs. "protoDescriptors": "A String", # Required. Contains a protobuf-serialized [google.protobuf.FileDescriptorSet](https://github.com/protocolbuffers/protobuf/blob/main/src/google/protobuf/descriptor.proto), which could include multiple proto files. To generate it, [install](https://grpc.io/docs/protoc-installation/) and run `protoc` with `--include_imports` and `--descriptor_set_out`. For example, to generate for moon/shot/app.proto, run ``` $protoc --proto_path=/app_path --proto_path=/lib_path \ --include_imports \ --descriptor_set_out=descriptors.pb \ moon/shot/app.proto ``` For more details, see protobuffer [self description](https://developers.google.com/protocol-buffers/docs/techniques#self-description). }, }
@@ -283,7 +283,7 @@

Method Details

{ # A named collection of related schemas. "etag": "A String", # Optional. The etag for this schema bundle. This may be sent on update and delete requests to ensure 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 identifying this schema bundle. Values are of the form `projects/{project}/instances/{instance}/tables/{table}/schemaBundles/{schema_bundle}` - "protoSchema": { # Represents a protobuf schema. # Schema for Protobufs. + "protoSchema": { # Represents a collection of protobuf schemas. # Schema for Protobufs. "protoDescriptors": "A String", # Required. Contains a protobuf-serialized [google.protobuf.FileDescriptorSet](https://github.com/protocolbuffers/protobuf/blob/main/src/google/protobuf/descriptor.proto), which could include multiple proto files. To generate it, [install](https://grpc.io/docs/protoc-installation/) and run `protoc` with `--include_imports` and `--descriptor_set_out`. For example, to generate for moon/shot/app.proto, run ``` $protoc --proto_path=/app_path --proto_path=/lib_path \ --include_imports \ --descriptor_set_out=descriptors.pb \ moon/shot/app.proto ``` For more details, see protobuffer [self description](https://developers.google.com/protocol-buffers/docs/techniques#self-description). }, }, @@ -317,7 +317,7 @@

Method Details

{ # A named collection of related schemas. "etag": "A String", # Optional. The etag for this schema bundle. This may be sent on update and delete requests to ensure 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 identifying this schema bundle. Values are of the form `projects/{project}/instances/{instance}/tables/{table}/schemaBundles/{schema_bundle}` - "protoSchema": { # Represents a protobuf schema. # Schema for Protobufs. + "protoSchema": { # Represents a collection of protobuf schemas. # Schema for Protobufs. "protoDescriptors": "A String", # Required. Contains a protobuf-serialized [google.protobuf.FileDescriptorSet](https://github.com/protocolbuffers/protobuf/blob/main/src/google/protobuf/descriptor.proto), which could include multiple proto files. To generate it, [install](https://grpc.io/docs/protoc-installation/) and run `protoc` with `--include_imports` and `--descriptor_set_out`. For example, to generate for moon/shot/app.proto, run ``` $protoc --proto_path=/app_path --proto_path=/lib_path \ --include_imports \ --descriptor_set_out=descriptors.pb \ moon/shot/app.proto ``` For more details, see protobuffer [self description](https://developers.google.com/protocol-buffers/docs/techniques#self-description). }, } diff --git a/docs/dyn/blogger_v3.blogUserInfos.html b/docs/dyn/blogger_v3.blogUserInfos.html index ae83467953..0ae0d2a9ef 100644 --- a/docs/dyn/blogger_v3.blogUserInfos.html +++ b/docs/dyn/blogger_v3.blogUserInfos.html @@ -72,7 +72,7 @@ -

Blogger API . blogUserInfos

+

blogger API . blogUserInfos

Instance Methods

close()

diff --git a/docs/dyn/blogger_v3.blogs.html b/docs/dyn/blogger_v3.blogs.html index 2652132339..00783a7f28 100644 --- a/docs/dyn/blogger_v3.blogs.html +++ b/docs/dyn/blogger_v3.blogs.html @@ -72,7 +72,7 @@ -

Blogger API . blogs

+

blogger API . blogs

Instance Methods

close()

diff --git a/docs/dyn/blogger_v3.comments.html b/docs/dyn/blogger_v3.comments.html index 880f66cf76..0759b2a0ec 100644 --- a/docs/dyn/blogger_v3.comments.html +++ b/docs/dyn/blogger_v3.comments.html @@ -72,7 +72,7 @@ -

Blogger API . comments

+

blogger API . comments

Instance Methods

approve(blogId, postId, commentId, x__xgafv=None)

diff --git a/docs/dyn/blogger_v3.html b/docs/dyn/blogger_v3.html index 9f14da132f..7fa99faec2 100644 --- a/docs/dyn/blogger_v3.html +++ b/docs/dyn/blogger_v3.html @@ -72,7 +72,7 @@ -

Blogger API

+

blogger API

Instance Methods

blogUserInfos() diff --git a/docs/dyn/blogger_v3.pageViews.html b/docs/dyn/blogger_v3.pageViews.html index 81fc3cd4dd..bf73a5e101 100644 --- a/docs/dyn/blogger_v3.pageViews.html +++ b/docs/dyn/blogger_v3.pageViews.html @@ -72,7 +72,7 @@ -

Blogger API . pageViews

+

blogger API . pageViews

Instance Methods

close()

diff --git a/docs/dyn/blogger_v3.pages.html b/docs/dyn/blogger_v3.pages.html index 6ee70433c0..306cd8055c 100644 --- a/docs/dyn/blogger_v3.pages.html +++ b/docs/dyn/blogger_v3.pages.html @@ -72,7 +72,7 @@ -

Blogger API . pages

+

blogger API . pages

Instance Methods

close()

diff --git a/docs/dyn/blogger_v3.postUserInfos.html b/docs/dyn/blogger_v3.postUserInfos.html index 3a32ba2537..bea92d50de 100644 --- a/docs/dyn/blogger_v3.postUserInfos.html +++ b/docs/dyn/blogger_v3.postUserInfos.html @@ -72,7 +72,7 @@ -

Blogger API . postUserInfos

+

blogger API . postUserInfos

Instance Methods

close()

diff --git a/docs/dyn/blogger_v3.posts.html b/docs/dyn/blogger_v3.posts.html index ffd9d2ccf1..44b7c59757 100644 --- a/docs/dyn/blogger_v3.posts.html +++ b/docs/dyn/blogger_v3.posts.html @@ -72,7 +72,7 @@ -

Blogger API . posts

+

blogger API . posts

Instance Methods

close()

diff --git a/docs/dyn/blogger_v3.users.html b/docs/dyn/blogger_v3.users.html index f92fa607c9..ebbe88e38b 100644 --- a/docs/dyn/blogger_v3.users.html +++ b/docs/dyn/blogger_v3.users.html @@ -72,7 +72,7 @@ -

Blogger API . users

+

blogger API . users

Instance Methods

close()

diff --git a/docs/dyn/calendar_v3.events.html b/docs/dyn/calendar_v3.events.html index 8f1e38099a..f19b7eec7c 100644 --- a/docs/dyn/calendar_v3.events.html +++ b/docs/dyn/calendar_v3.events.html @@ -173,6 +173,10 @@

Method Details

"attendees": [ # The attendees of the event. See the Events with attendees guide for more information on scheduling events with other calendar users. Service accounts need to use domain-wide delegation of authority to populate the attendee list. { "additionalGuests": 0, # Number of additional guests. Optional. The default is 0. + "asyncOperation": "", # If present, indicates the status of an asynchronous operation ongoing for this attendee (e.g. listing of members of large attendee groups). Read-only. The default is to not be present. + # Possible values are: + # - "inProgress" - The asynchronous operation is in progress. + # - (not present) - Otherwise. "comment": "A String", # The attendee's response comment. Optional. "displayName": "A String", # The attendee's name, if available. Optional. "email": "A String", # The attendee's email address, if available. This field must be present when adding an attendee. It must be a valid email address as per RFC5322. @@ -480,6 +484,10 @@

Method Details

"attendees": [ # The attendees of the event. See the Events with attendees guide for more information on scheduling events with other calendar users. Service accounts need to use domain-wide delegation of authority to populate the attendee list. { "additionalGuests": 0, # Number of additional guests. Optional. The default is 0. + "asyncOperation": "", # If present, indicates the status of an asynchronous operation ongoing for this attendee (e.g. listing of members of large attendee groups). Read-only. The default is to not be present. + # Possible values are: + # - "inProgress" - The asynchronous operation is in progress. + # - (not present) - Otherwise. "comment": "A String", # The attendee's response comment. Optional. "displayName": "A String", # The attendee's name, if available. Optional. "email": "A String", # The attendee's email address, if available. This field must be present when adding an attendee. It must be a valid email address as per RFC5322. @@ -782,6 +790,10 @@

Method Details

"attendees": [ # The attendees of the event. See the Events with attendees guide for more information on scheduling events with other calendar users. Service accounts need to use domain-wide delegation of authority to populate the attendee list. { "additionalGuests": 0, # Number of additional guests. Optional. The default is 0. + "asyncOperation": "", # If present, indicates the status of an asynchronous operation ongoing for this attendee (e.g. listing of members of large attendee groups). Read-only. The default is to not be present. + # Possible values are: + # - "inProgress" - The asynchronous operation is in progress. + # - (not present) - Otherwise. "comment": "A String", # The attendee's response comment. Optional. "displayName": "A String", # The attendee's name, if available. Optional. "email": "A String", # The attendee's email address, if available. This field must be present when adding an attendee. It must be a valid email address as per RFC5322. @@ -1088,6 +1100,10 @@

Method Details

"attendees": [ # The attendees of the event. See the Events with attendees guide for more information on scheduling events with other calendar users. Service accounts need to use domain-wide delegation of authority to populate the attendee list. { "additionalGuests": 0, # Number of additional guests. Optional. The default is 0. + "asyncOperation": "", # If present, indicates the status of an asynchronous operation ongoing for this attendee (e.g. listing of members of large attendee groups). Read-only. The default is to not be present. + # Possible values are: + # - "inProgress" - The asynchronous operation is in progress. + # - (not present) - Otherwise. "comment": "A String", # The attendee's response comment. Optional. "displayName": "A String", # The attendee's name, if available. Optional. "email": "A String", # The attendee's email address, if available. This field must be present when adding an attendee. It must be a valid email address as per RFC5322. @@ -1399,6 +1415,10 @@

Method Details

"attendees": [ # The attendees of the event. See the Events with attendees guide for more information on scheduling events with other calendar users. Service accounts need to use domain-wide delegation of authority to populate the attendee list. { "additionalGuests": 0, # Number of additional guests. Optional. The default is 0. + "asyncOperation": "", # If present, indicates the status of an asynchronous operation ongoing for this attendee (e.g. listing of members of large attendee groups). Read-only. The default is to not be present. + # Possible values are: + # - "inProgress" - The asynchronous operation is in progress. + # - (not present) - Otherwise. "comment": "A String", # The attendee's response comment. Optional. "displayName": "A String", # The attendee's name, if available. Optional. "email": "A String", # The attendee's email address, if available. This field must be present when adding an attendee. It must be a valid email address as per RFC5322. @@ -1737,6 +1757,10 @@

Method Details

"attendees": [ # The attendees of the event. See the Events with attendees guide for more information on scheduling events with other calendar users. Service accounts need to use domain-wide delegation of authority to populate the attendee list. { "additionalGuests": 0, # Number of additional guests. Optional. The default is 0. + "asyncOperation": "", # If present, indicates the status of an asynchronous operation ongoing for this attendee (e.g. listing of members of large attendee groups). Read-only. The default is to not be present. + # Possible values are: + # - "inProgress" - The asynchronous operation is in progress. + # - (not present) - Otherwise. "comment": "A String", # The attendee's response comment. Optional. "displayName": "A String", # The attendee's name, if available. Optional. "email": "A String", # The attendee's email address, if available. This field must be present when adding an attendee. It must be a valid email address as per RFC5322. @@ -2141,6 +2165,10 @@

Method Details

"attendees": [ # The attendees of the event. See the Events with attendees guide for more information on scheduling events with other calendar users. Service accounts need to use domain-wide delegation of authority to populate the attendee list. { "additionalGuests": 0, # Number of additional guests. Optional. The default is 0. + "asyncOperation": "", # If present, indicates the status of an asynchronous operation ongoing for this attendee (e.g. listing of members of large attendee groups). Read-only. The default is to not be present. + # Possible values are: + # - "inProgress" - The asynchronous operation is in progress. + # - (not present) - Otherwise. "comment": "A String", # The attendee's response comment. Optional. "displayName": "A String", # The attendee's name, if available. Optional. "email": "A String", # The attendee's email address, if available. This field must be present when adding an attendee. It must be a valid email address as per RFC5322. @@ -2480,6 +2508,10 @@

Method Details

"attendees": [ # The attendees of the event. See the Events with attendees guide for more information on scheduling events with other calendar users. Service accounts need to use domain-wide delegation of authority to populate the attendee list. { "additionalGuests": 0, # Number of additional guests. Optional. The default is 0. + "asyncOperation": "", # If present, indicates the status of an asynchronous operation ongoing for this attendee (e.g. listing of members of large attendee groups). Read-only. The default is to not be present. + # Possible values are: + # - "inProgress" - The asynchronous operation is in progress. + # - (not present) - Otherwise. "comment": "A String", # The attendee's response comment. Optional. "displayName": "A String", # The attendee's name, if available. Optional. "email": "A String", # The attendee's email address, if available. This field must be present when adding an attendee. It must be a valid email address as per RFC5322. @@ -2787,6 +2819,10 @@

Method Details

"attendees": [ # The attendees of the event. See the Events with attendees guide for more information on scheduling events with other calendar users. Service accounts need to use domain-wide delegation of authority to populate the attendee list. { "additionalGuests": 0, # Number of additional guests. Optional. The default is 0. + "asyncOperation": "", # If present, indicates the status of an asynchronous operation ongoing for this attendee (e.g. listing of members of large attendee groups). Read-only. The default is to not be present. + # Possible values are: + # - "inProgress" - The asynchronous operation is in progress. + # - (not present) - Otherwise. "comment": "A String", # The attendee's response comment. Optional. "displayName": "A String", # The attendee's name, if available. Optional. "email": "A String", # The attendee's email address, if available. This field must be present when adding an attendee. It must be a valid email address as per RFC5322. @@ -3099,6 +3135,10 @@

Method Details

"attendees": [ # The attendees of the event. See the Events with attendees guide for more information on scheduling events with other calendar users. Service accounts need to use domain-wide delegation of authority to populate the attendee list. { "additionalGuests": 0, # Number of additional guests. Optional. The default is 0. + "asyncOperation": "", # If present, indicates the status of an asynchronous operation ongoing for this attendee (e.g. listing of members of large attendee groups). Read-only. The default is to not be present. + # Possible values are: + # - "inProgress" - The asynchronous operation is in progress. + # - (not present) - Otherwise. "comment": "A String", # The attendee's response comment. Optional. "displayName": "A String", # The attendee's name, if available. Optional. "email": "A String", # The attendee's email address, if available. This field must be present when adding an attendee. It must be a valid email address as per RFC5322. @@ -3415,6 +3455,10 @@

Method Details

"attendees": [ # The attendees of the event. See the Events with attendees guide for more information on scheduling events with other calendar users. Service accounts need to use domain-wide delegation of authority to populate the attendee list. { "additionalGuests": 0, # Number of additional guests. Optional. The default is 0. + "asyncOperation": "", # If present, indicates the status of an asynchronous operation ongoing for this attendee (e.g. listing of members of large attendee groups). Read-only. The default is to not be present. + # Possible values are: + # - "inProgress" - The asynchronous operation is in progress. + # - (not present) - Otherwise. "comment": "A String", # The attendee's response comment. Optional. "displayName": "A String", # The attendee's name, if available. Optional. "email": "A String", # The attendee's email address, if available. This field must be present when adding an attendee. It must be a valid email address as per RFC5322. @@ -3722,6 +3766,10 @@

Method Details

"attendees": [ # The attendees of the event. See the Events with attendees guide for more information on scheduling events with other calendar users. Service accounts need to use domain-wide delegation of authority to populate the attendee list. { "additionalGuests": 0, # Number of additional guests. Optional. The default is 0. + "asyncOperation": "", # If present, indicates the status of an asynchronous operation ongoing for this attendee (e.g. listing of members of large attendee groups). Read-only. The default is to not be present. + # Possible values are: + # - "inProgress" - The asynchronous operation is in progress. + # - (not present) - Otherwise. "comment": "A String", # The attendee's response comment. Optional. "displayName": "A String", # The attendee's name, if available. Optional. "email": "A String", # The attendee's email address, if available. This field must be present when adding an attendee. It must be a valid email address as per RFC5322. @@ -4034,6 +4082,10 @@

Method Details

"attendees": [ # The attendees of the event. See the Events with attendees guide for more information on scheduling events with other calendar users. Service accounts need to use domain-wide delegation of authority to populate the attendee list. { "additionalGuests": 0, # Number of additional guests. Optional. The default is 0. + "asyncOperation": "", # If present, indicates the status of an asynchronous operation ongoing for this attendee (e.g. listing of members of large attendee groups). Read-only. The default is to not be present. + # Possible values are: + # - "inProgress" - The asynchronous operation is in progress. + # - (not present) - Otherwise. "comment": "A String", # The attendee's response comment. Optional. "displayName": "A String", # The attendee's name, if available. Optional. "email": "A String", # The attendee's email address, if available. This field must be present when adding an attendee. It must be a valid email address as per RFC5322. diff --git a/docs/dyn/ces_v1.projects.locations.apps.agents.html b/docs/dyn/ces_v1.projects.locations.apps.agents.html index 079cc020bc..609365d4d6 100644 --- a/docs/dyn/ces_v1.projects.locations.apps.agents.html +++ b/docs/dyn/ces_v1.projects.locations.apps.agents.html @@ -185,6 +185,7 @@

Method Details

"inputVariableMapping": { # Optional. The mapping of the app variables names to the Dialogflow session parameters names to be sent to the Dialogflow agent as input. "a_key": "A String", }, + "languageCodeVariable": "A String", # Optional. The name of the variable that contains the language code to be used for the Dialogflow session. If unspecified, the default language code of the Dialogflow agent will be used. "outputVariableMapping": { # Optional. The mapping of the Dialogflow session parameters names to the app variables names to be sent back to the CES agent after the Dialogflow agent execution ends. "a_key": "A String", }, @@ -310,6 +311,7 @@

Method Details

"inputVariableMapping": { # Optional. The mapping of the app variables names to the Dialogflow session parameters names to be sent to the Dialogflow agent as input. "a_key": "A String", }, + "languageCodeVariable": "A String", # Optional. The name of the variable that contains the language code to be used for the Dialogflow session. If unspecified, the default language code of the Dialogflow agent will be used. "outputVariableMapping": { # Optional. The mapping of the Dialogflow session parameters names to the app variables names to be sent back to the CES agent after the Dialogflow agent execution ends. "a_key": "A String", }, @@ -461,6 +463,7 @@

Method Details

"inputVariableMapping": { # Optional. The mapping of the app variables names to the Dialogflow session parameters names to be sent to the Dialogflow agent as input. "a_key": "A String", }, + "languageCodeVariable": "A String", # Optional. The name of the variable that contains the language code to be used for the Dialogflow session. If unspecified, the default language code of the Dialogflow agent will be used. "outputVariableMapping": { # Optional. The mapping of the Dialogflow session parameters names to the app variables names to be sent back to the CES agent after the Dialogflow agent execution ends. "a_key": "A String", }, @@ -598,6 +601,7 @@

Method Details

"inputVariableMapping": { # Optional. The mapping of the app variables names to the Dialogflow session parameters names to be sent to the Dialogflow agent as input. "a_key": "A String", }, + "languageCodeVariable": "A String", # Optional. The name of the variable that contains the language code to be used for the Dialogflow session. If unspecified, the default language code of the Dialogflow agent will be used. "outputVariableMapping": { # Optional. The mapping of the Dialogflow session parameters names to the app variables names to be sent back to the CES agent after the Dialogflow agent execution ends. "a_key": "A String", }, @@ -741,6 +745,7 @@

Method Details

"inputVariableMapping": { # Optional. The mapping of the app variables names to the Dialogflow session parameters names to be sent to the Dialogflow agent as input. "a_key": "A String", }, + "languageCodeVariable": "A String", # Optional. The name of the variable that contains the language code to be used for the Dialogflow session. If unspecified, the default language code of the Dialogflow agent will be used. "outputVariableMapping": { # Optional. The mapping of the Dialogflow session parameters names to the app variables names to be sent back to the CES agent after the Dialogflow agent execution ends. "a_key": "A String", }, @@ -866,6 +871,7 @@

Method Details

"inputVariableMapping": { # Optional. The mapping of the app variables names to the Dialogflow session parameters names to be sent to the Dialogflow agent as input. "a_key": "A String", }, + "languageCodeVariable": "A String", # Optional. The name of the variable that contains the language code to be used for the Dialogflow session. If unspecified, the default language code of the Dialogflow agent will be used. "outputVariableMapping": { # Optional. The mapping of the Dialogflow session parameters names to the app variables names to be sent back to the CES agent after the Dialogflow agent execution ends. "a_key": "A String", }, diff --git a/docs/dyn/ces_v1.projects.locations.apps.html b/docs/dyn/ces_v1.projects.locations.apps.html index a5ac1d9dad..1a291b4fc0 100644 --- a/docs/dyn/ces_v1.projects.locations.apps.html +++ b/docs/dyn/ces_v1.projects.locations.apps.html @@ -104,6 +104,11 @@

Instance Methods

Returns the guardrails Resource.

+

+ message() +

+

Returns the message Resource.

+

sessions()

@@ -277,11 +282,11 @@

Method Details

}, "locked": True or False, # Optional. Indicates whether the app is locked for changes. If the app is locked, modifications to the app resources will be rejected. "loggingSettings": { # Settings to describe the logging behaviors for the app. # Optional. Logging settings of the app. - "audioRecordingConfig": { # Configuration for how the audio interactions should be recorded. # Optional. Configuration for how audio interactions should be recorded. + "audioRecordingConfig": { # Configuration for how the audio interactions should be recorded. # Optional. Configuration for how audio interactions should be recorded. The audio is subject to redaction as configured in RedactionConfig. "gcsBucket": "A String", # Optional. The [Cloud Storage](https://cloud.google.com/storage) bucket to store the session audio recordings. The URI must start with "gs://". Please choose a bucket location that meets your data residency requirements. Note: If the Cloud Storage bucket is in a different project from the app, you should grant `storage.objects.create` permission to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`. "gcsPathPrefix": "A String", # Optional. The Cloud Storage path prefix for audio recordings. This prefix can include the following placeholders, which will be dynamically substituted at serving time: - $project: project ID - $location: app location - $app: app ID - $date: session date in YYYY-MM-DD format - $session: session ID If the path prefix is not specified, the default prefix `$project/$location/$app/$date/$session/` will be used. }, - "bigqueryExportSettings": { # Settings to describe the BigQuery export behaviors for the app. # Optional. Settings to describe the BigQuery export behaviors for the app. The conversation data will be exported to BigQuery tables if it is enabled. + "bigqueryExportSettings": { # Settings to describe the BigQuery export behaviors for the app. # Optional. Configures the BigQuery export behaviors for the app. The conversation data is subject to redaction as configured in RedactionConfig. "dataset": "A String", # Optional. The BigQuery **dataset ID** to export the data to. "enabled": True or False, # Optional. Indicates whether the BigQuery export is enabled. "project": "A String", # Optional. The **project ID** of the BigQuery dataset to export the data to. Note: If the BigQuery dataset is in a different project from the app, you should grant `roles/bigquery.admin` role to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`. @@ -305,7 +310,7 @@

Method Details

"enableRedaction": True or False, # Optional. If true, redaction will be applied in various logging scenarios, including conversation history, Cloud Logging and audio recording. "inspectTemplate": "A String", # Optional. [DLP](https://cloud.google.com/dlp/docs) inspect template name to configure detection of sensitive data types. Format: `projects/{project}/locations/{location}/inspectTemplates/{inspect_template}` }, - "unredactedAudioRecordingConfig": { # Configuration for how the audio interactions should be recorded. # Optional. Configures recording of unredacted audio. Use this to maintain a raw backup with restricted access when audio redaction is enabled, typically for auditing or monitoring purposes. + "unredactedAudioRecordingConfig": { # Configuration for how the audio interactions should be recorded. # Optional. Configures an additional recording of unredacted audio. This can be used to maintain a raw audio copy when audio redaction is enabled, typically for auditing or monitoring purposes. "gcsBucket": "A String", # Optional. The [Cloud Storage](https://cloud.google.com/storage) bucket to store the session audio recordings. The URI must start with "gs://". Please choose a bucket location that meets your data residency requirements. Note: If the Cloud Storage bucket is in a different project from the app, you should grant `storage.objects.create` permission to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`. "gcsPathPrefix": "A String", # Optional. The Cloud Storage path prefix for audio recordings. This prefix can include the following placeholders, which will be dynamically substituted at serving time: - $project: project ID - $location: app location - $app: app ID - $date: session date in YYYY-MM-DD format - $session: session ID If the path prefix is not specified, the default prefix `$project/$location/$app/$date/$session/` will be used. }, @@ -710,11 +715,11 @@

Method Details

}, "locked": True or False, # Optional. Indicates whether the app is locked for changes. If the app is locked, modifications to the app resources will be rejected. "loggingSettings": { # Settings to describe the logging behaviors for the app. # Optional. Logging settings of the app. - "audioRecordingConfig": { # Configuration for how the audio interactions should be recorded. # Optional. Configuration for how audio interactions should be recorded. + "audioRecordingConfig": { # Configuration for how the audio interactions should be recorded. # Optional. Configuration for how audio interactions should be recorded. The audio is subject to redaction as configured in RedactionConfig. "gcsBucket": "A String", # Optional. The [Cloud Storage](https://cloud.google.com/storage) bucket to store the session audio recordings. The URI must start with "gs://". Please choose a bucket location that meets your data residency requirements. Note: If the Cloud Storage bucket is in a different project from the app, you should grant `storage.objects.create` permission to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`. "gcsPathPrefix": "A String", # Optional. The Cloud Storage path prefix for audio recordings. This prefix can include the following placeholders, which will be dynamically substituted at serving time: - $project: project ID - $location: app location - $app: app ID - $date: session date in YYYY-MM-DD format - $session: session ID If the path prefix is not specified, the default prefix `$project/$location/$app/$date/$session/` will be used. }, - "bigqueryExportSettings": { # Settings to describe the BigQuery export behaviors for the app. # Optional. Settings to describe the BigQuery export behaviors for the app. The conversation data will be exported to BigQuery tables if it is enabled. + "bigqueryExportSettings": { # Settings to describe the BigQuery export behaviors for the app. # Optional. Configures the BigQuery export behaviors for the app. The conversation data is subject to redaction as configured in RedactionConfig. "dataset": "A String", # Optional. The BigQuery **dataset ID** to export the data to. "enabled": True or False, # Optional. Indicates whether the BigQuery export is enabled. "project": "A String", # Optional. The **project ID** of the BigQuery dataset to export the data to. Note: If the BigQuery dataset is in a different project from the app, you should grant `roles/bigquery.admin` role to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`. @@ -738,7 +743,7 @@

Method Details

"enableRedaction": True or False, # Optional. If true, redaction will be applied in various logging scenarios, including conversation history, Cloud Logging and audio recording. "inspectTemplate": "A String", # Optional. [DLP](https://cloud.google.com/dlp/docs) inspect template name to configure detection of sensitive data types. Format: `projects/{project}/locations/{location}/inspectTemplates/{inspect_template}` }, - "unredactedAudioRecordingConfig": { # Configuration for how the audio interactions should be recorded. # Optional. Configures recording of unredacted audio. Use this to maintain a raw backup with restricted access when audio redaction is enabled, typically for auditing or monitoring purposes. + "unredactedAudioRecordingConfig": { # Configuration for how the audio interactions should be recorded. # Optional. Configures an additional recording of unredacted audio. This can be used to maintain a raw audio copy when audio redaction is enabled, typically for auditing or monitoring purposes. "gcsBucket": "A String", # Optional. The [Cloud Storage](https://cloud.google.com/storage) bucket to store the session audio recordings. The URI must start with "gs://". Please choose a bucket location that meets your data residency requirements. Note: If the Cloud Storage bucket is in a different project from the app, you should grant `storage.objects.create` permission to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`. "gcsPathPrefix": "A String", # Optional. The Cloud Storage path prefix for audio recordings. This prefix can include the following placeholders, which will be dynamically substituted at serving time: - $project: project ID - $location: app location - $app: app ID - $date: session date in YYYY-MM-DD format - $session: session ID If the path prefix is not specified, the default prefix `$project/$location/$app/$date/$session/` will be used. }, @@ -1021,11 +1026,11 @@

Method Details

}, "locked": True or False, # Optional. Indicates whether the app is locked for changes. If the app is locked, modifications to the app resources will be rejected. "loggingSettings": { # Settings to describe the logging behaviors for the app. # Optional. Logging settings of the app. - "audioRecordingConfig": { # Configuration for how the audio interactions should be recorded. # Optional. Configuration for how audio interactions should be recorded. + "audioRecordingConfig": { # Configuration for how the audio interactions should be recorded. # Optional. Configuration for how audio interactions should be recorded. The audio is subject to redaction as configured in RedactionConfig. "gcsBucket": "A String", # Optional. The [Cloud Storage](https://cloud.google.com/storage) bucket to store the session audio recordings. The URI must start with "gs://". Please choose a bucket location that meets your data residency requirements. Note: If the Cloud Storage bucket is in a different project from the app, you should grant `storage.objects.create` permission to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`. "gcsPathPrefix": "A String", # Optional. The Cloud Storage path prefix for audio recordings. This prefix can include the following placeholders, which will be dynamically substituted at serving time: - $project: project ID - $location: app location - $app: app ID - $date: session date in YYYY-MM-DD format - $session: session ID If the path prefix is not specified, the default prefix `$project/$location/$app/$date/$session/` will be used. }, - "bigqueryExportSettings": { # Settings to describe the BigQuery export behaviors for the app. # Optional. Settings to describe the BigQuery export behaviors for the app. The conversation data will be exported to BigQuery tables if it is enabled. + "bigqueryExportSettings": { # Settings to describe the BigQuery export behaviors for the app. # Optional. Configures the BigQuery export behaviors for the app. The conversation data is subject to redaction as configured in RedactionConfig. "dataset": "A String", # Optional. The BigQuery **dataset ID** to export the data to. "enabled": True or False, # Optional. Indicates whether the BigQuery export is enabled. "project": "A String", # Optional. The **project ID** of the BigQuery dataset to export the data to. Note: If the BigQuery dataset is in a different project from the app, you should grant `roles/bigquery.admin` role to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`. @@ -1049,7 +1054,7 @@

Method Details

"enableRedaction": True or False, # Optional. If true, redaction will be applied in various logging scenarios, including conversation history, Cloud Logging and audio recording. "inspectTemplate": "A String", # Optional. [DLP](https://cloud.google.com/dlp/docs) inspect template name to configure detection of sensitive data types. Format: `projects/{project}/locations/{location}/inspectTemplates/{inspect_template}` }, - "unredactedAudioRecordingConfig": { # Configuration for how the audio interactions should be recorded. # Optional. Configures recording of unredacted audio. Use this to maintain a raw backup with restricted access when audio redaction is enabled, typically for auditing or monitoring purposes. + "unredactedAudioRecordingConfig": { # Configuration for how the audio interactions should be recorded. # Optional. Configures an additional recording of unredacted audio. This can be used to maintain a raw audio copy when audio redaction is enabled, typically for auditing or monitoring purposes. "gcsBucket": "A String", # Optional. The [Cloud Storage](https://cloud.google.com/storage) bucket to store the session audio recordings. The URI must start with "gs://". Please choose a bucket location that meets your data residency requirements. Note: If the Cloud Storage bucket is in a different project from the app, you should grant `storage.objects.create` permission to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`. "gcsPathPrefix": "A String", # Optional. The Cloud Storage path prefix for audio recordings. This prefix can include the following placeholders, which will be dynamically substituted at serving time: - $project: project ID - $location: app location - $app: app ID - $date: session date in YYYY-MM-DD format - $session: session ID If the path prefix is not specified, the default prefix `$project/$location/$app/$date/$session/` will be used. }, @@ -1292,11 +1297,11 @@

Method Details

}, "locked": True or False, # Optional. Indicates whether the app is locked for changes. If the app is locked, modifications to the app resources will be rejected. "loggingSettings": { # Settings to describe the logging behaviors for the app. # Optional. Logging settings of the app. - "audioRecordingConfig": { # Configuration for how the audio interactions should be recorded. # Optional. Configuration for how audio interactions should be recorded. + "audioRecordingConfig": { # Configuration for how the audio interactions should be recorded. # Optional. Configuration for how audio interactions should be recorded. The audio is subject to redaction as configured in RedactionConfig. "gcsBucket": "A String", # Optional. The [Cloud Storage](https://cloud.google.com/storage) bucket to store the session audio recordings. The URI must start with "gs://". Please choose a bucket location that meets your data residency requirements. Note: If the Cloud Storage bucket is in a different project from the app, you should grant `storage.objects.create` permission to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`. "gcsPathPrefix": "A String", # Optional. The Cloud Storage path prefix for audio recordings. This prefix can include the following placeholders, which will be dynamically substituted at serving time: - $project: project ID - $location: app location - $app: app ID - $date: session date in YYYY-MM-DD format - $session: session ID If the path prefix is not specified, the default prefix `$project/$location/$app/$date/$session/` will be used. }, - "bigqueryExportSettings": { # Settings to describe the BigQuery export behaviors for the app. # Optional. Settings to describe the BigQuery export behaviors for the app. The conversation data will be exported to BigQuery tables if it is enabled. + "bigqueryExportSettings": { # Settings to describe the BigQuery export behaviors for the app. # Optional. Configures the BigQuery export behaviors for the app. The conversation data is subject to redaction as configured in RedactionConfig. "dataset": "A String", # Optional. The BigQuery **dataset ID** to export the data to. "enabled": True or False, # Optional. Indicates whether the BigQuery export is enabled. "project": "A String", # Optional. The **project ID** of the BigQuery dataset to export the data to. Note: If the BigQuery dataset is in a different project from the app, you should grant `roles/bigquery.admin` role to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`. @@ -1320,7 +1325,7 @@

Method Details

"enableRedaction": True or False, # Optional. If true, redaction will be applied in various logging scenarios, including conversation history, Cloud Logging and audio recording. "inspectTemplate": "A String", # Optional. [DLP](https://cloud.google.com/dlp/docs) inspect template name to configure detection of sensitive data types. Format: `projects/{project}/locations/{location}/inspectTemplates/{inspect_template}` }, - "unredactedAudioRecordingConfig": { # Configuration for how the audio interactions should be recorded. # Optional. Configures recording of unredacted audio. Use this to maintain a raw backup with restricted access when audio redaction is enabled, typically for auditing or monitoring purposes. + "unredactedAudioRecordingConfig": { # Configuration for how the audio interactions should be recorded. # Optional. Configures an additional recording of unredacted audio. This can be used to maintain a raw audio copy when audio redaction is enabled, typically for auditing or monitoring purposes. "gcsBucket": "A String", # Optional. The [Cloud Storage](https://cloud.google.com/storage) bucket to store the session audio recordings. The URI must start with "gs://". Please choose a bucket location that meets your data residency requirements. Note: If the Cloud Storage bucket is in a different project from the app, you should grant `storage.objects.create` permission to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`. "gcsPathPrefix": "A String", # Optional. The Cloud Storage path prefix for audio recordings. This prefix can include the following placeholders, which will be dynamically substituted at serving time: - $project: project ID - $location: app location - $app: app ID - $date: session date in YYYY-MM-DD format - $session: session ID If the path prefix is not specified, the default prefix `$project/$location/$app/$date/$session/` will be used. }, @@ -1542,11 +1547,11 @@

Method Details

}, "locked": True or False, # Optional. Indicates whether the app is locked for changes. If the app is locked, modifications to the app resources will be rejected. "loggingSettings": { # Settings to describe the logging behaviors for the app. # Optional. Logging settings of the app. - "audioRecordingConfig": { # Configuration for how the audio interactions should be recorded. # Optional. Configuration for how audio interactions should be recorded. + "audioRecordingConfig": { # Configuration for how the audio interactions should be recorded. # Optional. Configuration for how audio interactions should be recorded. The audio is subject to redaction as configured in RedactionConfig. "gcsBucket": "A String", # Optional. The [Cloud Storage](https://cloud.google.com/storage) bucket to store the session audio recordings. The URI must start with "gs://". Please choose a bucket location that meets your data residency requirements. Note: If the Cloud Storage bucket is in a different project from the app, you should grant `storage.objects.create` permission to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`. "gcsPathPrefix": "A String", # Optional. The Cloud Storage path prefix for audio recordings. This prefix can include the following placeholders, which will be dynamically substituted at serving time: - $project: project ID - $location: app location - $app: app ID - $date: session date in YYYY-MM-DD format - $session: session ID If the path prefix is not specified, the default prefix `$project/$location/$app/$date/$session/` will be used. }, - "bigqueryExportSettings": { # Settings to describe the BigQuery export behaviors for the app. # Optional. Settings to describe the BigQuery export behaviors for the app. The conversation data will be exported to BigQuery tables if it is enabled. + "bigqueryExportSettings": { # Settings to describe the BigQuery export behaviors for the app. # Optional. Configures the BigQuery export behaviors for the app. The conversation data is subject to redaction as configured in RedactionConfig. "dataset": "A String", # Optional. The BigQuery **dataset ID** to export the data to. "enabled": True or False, # Optional. Indicates whether the BigQuery export is enabled. "project": "A String", # Optional. The **project ID** of the BigQuery dataset to export the data to. Note: If the BigQuery dataset is in a different project from the app, you should grant `roles/bigquery.admin` role to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`. @@ -1570,7 +1575,7 @@

Method Details

"enableRedaction": True or False, # Optional. If true, redaction will be applied in various logging scenarios, including conversation history, Cloud Logging and audio recording. "inspectTemplate": "A String", # Optional. [DLP](https://cloud.google.com/dlp/docs) inspect template name to configure detection of sensitive data types. Format: `projects/{project}/locations/{location}/inspectTemplates/{inspect_template}` }, - "unredactedAudioRecordingConfig": { # Configuration for how the audio interactions should be recorded. # Optional. Configures recording of unredacted audio. Use this to maintain a raw backup with restricted access when audio redaction is enabled, typically for auditing or monitoring purposes. + "unredactedAudioRecordingConfig": { # Configuration for how the audio interactions should be recorded. # Optional. Configures an additional recording of unredacted audio. This can be used to maintain a raw audio copy when audio redaction is enabled, typically for auditing or monitoring purposes. "gcsBucket": "A String", # Optional. The [Cloud Storage](https://cloud.google.com/storage) bucket to store the session audio recordings. The URI must start with "gs://". Please choose a bucket location that meets your data residency requirements. Note: If the Cloud Storage bucket is in a different project from the app, you should grant `storage.objects.create` permission to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`. "gcsPathPrefix": "A String", # Optional. The Cloud Storage path prefix for audio recordings. This prefix can include the following placeholders, which will be dynamically substituted at serving time: - $project: project ID - $location: app location - $app: app ID - $date: session date in YYYY-MM-DD format - $session: session ID If the path prefix is not specified, the default prefix `$project/$location/$app/$date/$session/` will be used. }, diff --git a/docs/dyn/ces_v1.projects.locations.apps.message.html b/docs/dyn/ces_v1.projects.locations.apps.message.html new file mode 100644 index 0000000000..2020f5e79d --- /dev/null +++ b/docs/dyn/ces_v1.projects.locations.apps.message.html @@ -0,0 +1,285 @@ + + + +

Gemini Enterprise for Customer Experience API . projects . locations . apps . message

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ send(tenant, body=None, x__xgafv=None)

+

Sends a message to an agent.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ send(tenant, body=None, x__xgafv=None) +
Sends a message to an agent.
+
+Args:
+  tenant: string, Optional. Tenant ID, provided as a path parameter. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Represents a request for the `SendMessage` method.
+  "configuration": { # Configuration of a send message request. # Configuration for the send request.
+    "acceptedOutputModes": [ # A list of media types the client is prepared to accept for response parts. Agents SHOULD use this to tailor their output.
+      "A String",
+    ],
+    "historyLength": 42, # The maximum number of most recent messages from the task's history to retrieve in the response. An unset value means the client does not impose any limit. A value of zero is a request to not include any messages. The server MUST NOT return more messages than the provided value, but MAY apply a lower limit.
+    "returnImmediately": True or False, # If `true`, the operation returns immediately after creating the task, even if processing is still in progress. If `false` (default), the operation MUST wait until the task reaches a terminal (`COMPLETED`, `FAILED`, `CANCELED`, `REJECTED`) or interrupted (`INPUT_REQUIRED`, `AUTH_REQUIRED`) state before returning.
+    "taskPushNotificationConfig": { # A container associating a push notification configuration with a specific task. # Configuration for the agent to send push notifications for task updates. Task id should be empty when sending this configuration in a `SendMessage` request.
+      "authentication": { # Defines authentication details, used for push notifications. # Authentication information required to send the notification.
+        "credentials": "A String", # Push Notification credentials. Format depends on the scheme (e.g., token for Bearer).
+        "scheme": "A String", # Required. HTTP Authentication Scheme from the [IANA registry](https://www.iana.org/assignments/http-authschemes/). Examples: `Bearer`, `Basic`, `Digest`. Scheme names are case-insensitive per [RFC 9110 Section 11.1](https://www.rfc-editor.org/rfc/rfc9110#section-11.1).
+      },
+      "id": "A String", # The push notification configuration details. A unique identifier (e.g. UUID) for this push notification configuration.
+      "taskId": "A String", # The ID of the task this configuration is associated with.
+      "tenant": "A String", # Optional. Tenant ID.
+      "token": "A String", # A token unique for this task or session.
+      "url": "A String", # Required. The URL where the notification should be sent.
+    },
+  },
+  "message": { # `Message` is one unit of communication between client and server. It can be associated with a context and/or a task. For server messages, `context_id` must be provided, and `task_id` only if a task was created. For client messages, both fields are optional, with the caveat that if both are provided, they have to match (the `context_id` has to be the one that is set on the task). If only `task_id` is provided, the server will infer `context_id` from it. # Required. The message to send to the agent.
+    "contextId": "A String", # Optional. The context id of the message. If set, the message will be associated with the given context.
+    "extensions": [ # The URIs of extensions that are present or contributed to this Message.
+      "A String",
+    ],
+    "messageId": "A String", # Required. The unique identifier (e.g. UUID) of the message. This is created by the message creator.
+    "metadata": { # Optional. Any metadata to provide along with the message.
+      "a_key": "", # Properties of the object.
+    },
+    "parts": [ # Required. Parts is the container of the message content.
+      { # `Part` represents a container for a section of communication content. Parts can be purely textual, some sort of file (image, video, etc) or a structured data blob (i.e. JSON).
+        "data": "", # Arbitrary structured `data` as a JSON value (object, array, string, number, boolean, or null).
+        "filename": "A String", # An optional `filename` for the file (e.g., "document.pdf").
+        "mediaType": "A String", # The `media_type` (MIME type) of the part content (e.g., "text/plain", "application/json", "image/png"). This field is available for all part types.
+        "metadata": { # Optional. metadata associated with this part.
+          "a_key": "", # Properties of the object.
+        },
+        "raw": "A String", # The `raw` byte content of a file. In JSON serialization, this is encoded as a base64 string.
+        "text": "A String", # The string content of the `text` part.
+        "url": "A String", # A `url` pointing to the file's content.
+      },
+    ],
+    "referenceTaskIds": [ # A list of task IDs that this message references for additional context.
+      "A String",
+    ],
+    "role": "A String", # Required. Identifies the sender of the message.
+    "taskId": "A String", # Optional. The task id of the message. If set, the message will be associated with the given task.
+  },
+  "metadata": { # A flexible key-value map for passing additional context or parameters.
+    "a_key": "", # Properties of the object.
+  },
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Represents the response for the `SendMessage` method.
+  "message": { # `Message` is one unit of communication between client and server. It can be associated with a context and/or a task. For server messages, `context_id` must be provided, and `task_id` only if a task was created. For client messages, both fields are optional, with the caveat that if both are provided, they have to match (the `context_id` has to be the one that is set on the task). If only `task_id` is provided, the server will infer `context_id` from it. # A message from the agent.
+    "contextId": "A String", # Optional. The context id of the message. If set, the message will be associated with the given context.
+    "extensions": [ # The URIs of extensions that are present or contributed to this Message.
+      "A String",
+    ],
+    "messageId": "A String", # Required. The unique identifier (e.g. UUID) of the message. This is created by the message creator.
+    "metadata": { # Optional. Any metadata to provide along with the message.
+      "a_key": "", # Properties of the object.
+    },
+    "parts": [ # Required. Parts is the container of the message content.
+      { # `Part` represents a container for a section of communication content. Parts can be purely textual, some sort of file (image, video, etc) or a structured data blob (i.e. JSON).
+        "data": "", # Arbitrary structured `data` as a JSON value (object, array, string, number, boolean, or null).
+        "filename": "A String", # An optional `filename` for the file (e.g., "document.pdf").
+        "mediaType": "A String", # The `media_type` (MIME type) of the part content (e.g., "text/plain", "application/json", "image/png"). This field is available for all part types.
+        "metadata": { # Optional. metadata associated with this part.
+          "a_key": "", # Properties of the object.
+        },
+        "raw": "A String", # The `raw` byte content of a file. In JSON serialization, this is encoded as a base64 string.
+        "text": "A String", # The string content of the `text` part.
+        "url": "A String", # A `url` pointing to the file's content.
+      },
+    ],
+    "referenceTaskIds": [ # A list of task IDs that this message references for additional context.
+      "A String",
+    ],
+    "role": "A String", # Required. Identifies the sender of the message.
+    "taskId": "A String", # Optional. The task id of the message. If set, the message will be associated with the given task.
+  },
+  "task": { # `Task` is the core unit of action for A2A. It has a current status and when results are created for the task they are stored in the artifact. If there are multiple turns for a task, these are stored in history. # The task created or updated by the message.
+    "artifacts": [ # A set of output artifacts for a `Task`.
+      { # Artifacts represent task outputs.
+        "artifactId": "A String", # Required. Unique identifier (e.g. UUID) for the artifact. It must be unique within a task.
+        "description": "A String", # Optional. A human readable description of the artifact.
+        "extensions": [ # The URIs of extensions that are present or contributed to this Artifact.
+          "A String",
+        ],
+        "metadata": { # Optional. Metadata included with the artifact.
+          "a_key": "", # Properties of the object.
+        },
+        "name": "A String", # A human readable name for the artifact.
+        "parts": [ # Required. The content of the artifact. Must contain at least one part.
+          { # `Part` represents a container for a section of communication content. Parts can be purely textual, some sort of file (image, video, etc) or a structured data blob (i.e. JSON).
+            "data": "", # Arbitrary structured `data` as a JSON value (object, array, string, number, boolean, or null).
+            "filename": "A String", # An optional `filename` for the file (e.g., "document.pdf").
+            "mediaType": "A String", # The `media_type` (MIME type) of the part content (e.g., "text/plain", "application/json", "image/png"). This field is available for all part types.
+            "metadata": { # Optional. metadata associated with this part.
+              "a_key": "", # Properties of the object.
+            },
+            "raw": "A String", # The `raw` byte content of a file. In JSON serialization, this is encoded as a base64 string.
+            "text": "A String", # The string content of the `text` part.
+            "url": "A String", # A `url` pointing to the file's content.
+          },
+        ],
+      },
+    ],
+    "contextId": "A String", # Unique identifier (e.g. UUID) for the contextual collection of interactions (tasks and messages).
+    "history": [ # protolint:disable REPEATED_FIELD_NAMES_PLURALIZED The history of interactions from a `Task`.
+      { # `Message` is one unit of communication between client and server. It can be associated with a context and/or a task. For server messages, `context_id` must be provided, and `task_id` only if a task was created. For client messages, both fields are optional, with the caveat that if both are provided, they have to match (the `context_id` has to be the one that is set on the task). If only `task_id` is provided, the server will infer `context_id` from it.
+        "contextId": "A String", # Optional. The context id of the message. If set, the message will be associated with the given context.
+        "extensions": [ # The URIs of extensions that are present or contributed to this Message.
+          "A String",
+        ],
+        "messageId": "A String", # Required. The unique identifier (e.g. UUID) of the message. This is created by the message creator.
+        "metadata": { # Optional. Any metadata to provide along with the message.
+          "a_key": "", # Properties of the object.
+        },
+        "parts": [ # Required. Parts is the container of the message content.
+          { # `Part` represents a container for a section of communication content. Parts can be purely textual, some sort of file (image, video, etc) or a structured data blob (i.e. JSON).
+            "data": "", # Arbitrary structured `data` as a JSON value (object, array, string, number, boolean, or null).
+            "filename": "A String", # An optional `filename` for the file (e.g., "document.pdf").
+            "mediaType": "A String", # The `media_type` (MIME type) of the part content (e.g., "text/plain", "application/json", "image/png"). This field is available for all part types.
+            "metadata": { # Optional. metadata associated with this part.
+              "a_key": "", # Properties of the object.
+            },
+            "raw": "A String", # The `raw` byte content of a file. In JSON serialization, this is encoded as a base64 string.
+            "text": "A String", # The string content of the `text` part.
+            "url": "A String", # A `url` pointing to the file's content.
+          },
+        ],
+        "referenceTaskIds": [ # A list of task IDs that this message references for additional context.
+          "A String",
+        ],
+        "role": "A String", # Required. Identifies the sender of the message.
+        "taskId": "A String", # Optional. The task id of the message. If set, the message will be associated with the given task.
+      },
+    ],
+    "id": "A String", # Required. Unique identifier (e.g. UUID) for the task, generated by the server for a new task.
+    "metadata": { # protolint:enable REPEATED_FIELD_NAMES_PLURALIZED A key/value object to store custom metadata about a task.
+      "a_key": "", # Properties of the object.
+    },
+    "status": { # A container for the status of a task # Required. The current status of a `Task`, including `state` and a `message`.
+      "message": { # `Message` is one unit of communication between client and server. It can be associated with a context and/or a task. For server messages, `context_id` must be provided, and `task_id` only if a task was created. For client messages, both fields are optional, with the caveat that if both are provided, they have to match (the `context_id` has to be the one that is set on the task). If only `task_id` is provided, the server will infer `context_id` from it. # A message associated with the status.
+        "contextId": "A String", # Optional. The context id of the message. If set, the message will be associated with the given context.
+        "extensions": [ # The URIs of extensions that are present or contributed to this Message.
+          "A String",
+        ],
+        "messageId": "A String", # Required. The unique identifier (e.g. UUID) of the message. This is created by the message creator.
+        "metadata": { # Optional. Any metadata to provide along with the message.
+          "a_key": "", # Properties of the object.
+        },
+        "parts": [ # Required. Parts is the container of the message content.
+          { # `Part` represents a container for a section of communication content. Parts can be purely textual, some sort of file (image, video, etc) or a structured data blob (i.e. JSON).
+            "data": "", # Arbitrary structured `data` as a JSON value (object, array, string, number, boolean, or null).
+            "filename": "A String", # An optional `filename` for the file (e.g., "document.pdf").
+            "mediaType": "A String", # The `media_type` (MIME type) of the part content (e.g., "text/plain", "application/json", "image/png"). This field is available for all part types.
+            "metadata": { # Optional. metadata associated with this part.
+              "a_key": "", # Properties of the object.
+            },
+            "raw": "A String", # The `raw` byte content of a file. In JSON serialization, this is encoded as a base64 string.
+            "text": "A String", # The string content of the `text` part.
+            "url": "A String", # A `url` pointing to the file's content.
+          },
+        ],
+        "referenceTaskIds": [ # A list of task IDs that this message references for additional context.
+          "A String",
+        ],
+        "role": "A String", # Required. Identifies the sender of the message.
+        "taskId": "A String", # Optional. The task id of the message. If set, the message will be associated with the given task.
+      },
+      "state": "A String", # Required. The current state of this task.
+      "timestamp": "A String", # ISO 8601 Timestamp when the status was recorded. Example: "2023-10-27T10:00:00Z"
+    },
+  },
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/ces_v1.projects.locations.apps.tools.html b/docs/dyn/ces_v1.projects.locations.apps.tools.html index 47017a728b..0b8c21dc97 100644 --- a/docs/dyn/ces_v1.projects.locations.apps.tools.html +++ b/docs/dyn/ces_v1.projects.locations.apps.tools.html @@ -403,6 +403,7 @@

Method Details

"uniqueItems": True or False, # Optional. Indicate the items in the array must be unique. Only applies to TYPE.ARRAY. }, "name": "A String", # Required. The name of the MCP tool. + "nameOverride": "A String", # Optional. The name override of the MCP tool. This is populated if the name was overridden by a Toolset override. "outputSchema": { # Represents a select subset of an OpenAPI 3.0 schema object. # Optional. The schema of the output arguments of the MCP tool. "additionalProperties": # Object with schema name: Schema # Optional. Can either be a boolean or an object, controls the presence of additional properties. "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. @@ -440,6 +441,7 @@

Method Details

"serviceDirectoryConfig": { # Configuration for tools using Service Directory. # Optional. Service Directory configuration for VPC-SC, used to resolve service names within a perimeter. "service": "A String", # Required. The name of [Service Directory](https://cloud.google.com/service-directory) service. Format: `projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}`. Location of the service directory must be the same as the location of the app. }, + "state": "A String", # Output only. The dynamic availability state of the tool on the external server. "tlsConfig": { # The TLS configuration. # Optional. The TLS configuration. Includes the custom server certificates that the client should trust. "caCerts": [ # Required. Specifies a list of allowed custom CA certificates for HTTPS verification. { # The CA certificate. @@ -499,6 +501,9 @@

Method Details

"description": "A String", # Output only. The description of the Python function, parsed from the python code's docstring. "name": "A String", # Optional. The name of the Python function to execute. Must match a Python function name defined in the python code. Case sensitive. If the name is not provided, the first function defined in the python code will be used. "pythonCode": "A String", # Optional. The Python code to execute for the tool. + "serviceDirectoryConfig": { # Configuration for tools using Service Directory. # Optional. Service Directory configuration for the tool. + "service": "A String", # Required. The name of [Service Directory](https://cloud.google.com/service-directory) service. Format: `projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}`. Location of the service directory must be the same as the location of the app. + }, }, "remoteAgentTool": { # Represents a tool that allows the agent to call another remote agent. # Optional. The remote agent tool. "agentCard": { # AgentCard conveys key information about a remote agent. It is a trimmed version of the AgentCard defined in the A2A protocol https://a2a-protocol.org/dev/specification/#441-agentcard # Required. The agent card of the remote agent that this tool invokes. @@ -558,6 +563,9 @@

Method Details

"description": "A String", # Output only. The description of the Python function, parsed from the python code's docstring. "name": "A String", # Optional. The name of the Python function to execute. Must match a Python function name defined in the python code. Case sensitive. If the name is not provided, the first function defined in the python code will be used. "pythonCode": "A String", # Optional. The Python code to execute for the tool. + "serviceDirectoryConfig": { # Configuration for tools using Service Directory. # Optional. Service Directory configuration for the tool. + "service": "A String", # Required. The name of [Service Directory](https://cloud.google.com/service-directory) service. Format: `projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}`. Location of the service directory must be the same as the location of the app. + }, }, "pythonScript": "A String", # Deprecated: Use `python_function` instead. "sourceToolName": "A String", # Optional. The resource name of the tool that provides the data for the widget (e.g., a search tool or a custom function). Format: `projects/{project}/locations/{location}/agents/{agent}/tools/{tool}` @@ -911,6 +919,7 @@

Method Details

"uniqueItems": True or False, # Optional. Indicate the items in the array must be unique. Only applies to TYPE.ARRAY. }, "name": "A String", # Required. The name of the MCP tool. + "nameOverride": "A String", # Optional. The name override of the MCP tool. This is populated if the name was overridden by a Toolset override. "outputSchema": { # Represents a select subset of an OpenAPI 3.0 schema object. # Optional. The schema of the output arguments of the MCP tool. "additionalProperties": # Object with schema name: Schema # Optional. Can either be a boolean or an object, controls the presence of additional properties. "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. @@ -948,6 +957,7 @@

Method Details

"serviceDirectoryConfig": { # Configuration for tools using Service Directory. # Optional. Service Directory configuration for VPC-SC, used to resolve service names within a perimeter. "service": "A String", # Required. The name of [Service Directory](https://cloud.google.com/service-directory) service. Format: `projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}`. Location of the service directory must be the same as the location of the app. }, + "state": "A String", # Output only. The dynamic availability state of the tool on the external server. "tlsConfig": { # The TLS configuration. # Optional. The TLS configuration. Includes the custom server certificates that the client should trust. "caCerts": [ # Required. Specifies a list of allowed custom CA certificates for HTTPS verification. { # The CA certificate. @@ -1007,6 +1017,9 @@

Method Details

"description": "A String", # Output only. The description of the Python function, parsed from the python code's docstring. "name": "A String", # Optional. The name of the Python function to execute. Must match a Python function name defined in the python code. Case sensitive. If the name is not provided, the first function defined in the python code will be used. "pythonCode": "A String", # Optional. The Python code to execute for the tool. + "serviceDirectoryConfig": { # Configuration for tools using Service Directory. # Optional. Service Directory configuration for the tool. + "service": "A String", # Required. The name of [Service Directory](https://cloud.google.com/service-directory) service. Format: `projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}`. Location of the service directory must be the same as the location of the app. + }, }, "remoteAgentTool": { # Represents a tool that allows the agent to call another remote agent. # Optional. The remote agent tool. "agentCard": { # AgentCard conveys key information about a remote agent. It is a trimmed version of the AgentCard defined in the A2A protocol https://a2a-protocol.org/dev/specification/#441-agentcard # Required. The agent card of the remote agent that this tool invokes. @@ -1066,6 +1079,9 @@

Method Details

"description": "A String", # Output only. The description of the Python function, parsed from the python code's docstring. "name": "A String", # Optional. The name of the Python function to execute. Must match a Python function name defined in the python code. Case sensitive. If the name is not provided, the first function defined in the python code will be used. "pythonCode": "A String", # Optional. The Python code to execute for the tool. + "serviceDirectoryConfig": { # Configuration for tools using Service Directory. # Optional. Service Directory configuration for the tool. + "service": "A String", # Required. The name of [Service Directory](https://cloud.google.com/service-directory) service. Format: `projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}`. Location of the service directory must be the same as the location of the app. + }, }, "pythonScript": "A String", # Deprecated: Use `python_function` instead. "sourceToolName": "A String", # Optional. The resource name of the tool that provides the data for the widget (e.g., a search tool or a custom function). Format: `projects/{project}/locations/{location}/agents/{agent}/tools/{tool}` @@ -1445,6 +1461,7 @@

Method Details

"uniqueItems": True or False, # Optional. Indicate the items in the array must be unique. Only applies to TYPE.ARRAY. }, "name": "A String", # Required. The name of the MCP tool. + "nameOverride": "A String", # Optional. The name override of the MCP tool. This is populated if the name was overridden by a Toolset override. "outputSchema": { # Represents a select subset of an OpenAPI 3.0 schema object. # Optional. The schema of the output arguments of the MCP tool. "additionalProperties": # Object with schema name: Schema # Optional. Can either be a boolean or an object, controls the presence of additional properties. "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. @@ -1482,6 +1499,7 @@

Method Details

"serviceDirectoryConfig": { # Configuration for tools using Service Directory. # Optional. Service Directory configuration for VPC-SC, used to resolve service names within a perimeter. "service": "A String", # Required. The name of [Service Directory](https://cloud.google.com/service-directory) service. Format: `projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}`. Location of the service directory must be the same as the location of the app. }, + "state": "A String", # Output only. The dynamic availability state of the tool on the external server. "tlsConfig": { # The TLS configuration. # Optional. The TLS configuration. Includes the custom server certificates that the client should trust. "caCerts": [ # Required. Specifies a list of allowed custom CA certificates for HTTPS verification. { # The CA certificate. @@ -1541,6 +1559,9 @@

Method Details

"description": "A String", # Output only. The description of the Python function, parsed from the python code's docstring. "name": "A String", # Optional. The name of the Python function to execute. Must match a Python function name defined in the python code. Case sensitive. If the name is not provided, the first function defined in the python code will be used. "pythonCode": "A String", # Optional. The Python code to execute for the tool. + "serviceDirectoryConfig": { # Configuration for tools using Service Directory. # Optional. Service Directory configuration for the tool. + "service": "A String", # Required. The name of [Service Directory](https://cloud.google.com/service-directory) service. Format: `projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}`. Location of the service directory must be the same as the location of the app. + }, }, "remoteAgentTool": { # Represents a tool that allows the agent to call another remote agent. # Optional. The remote agent tool. "agentCard": { # AgentCard conveys key information about a remote agent. It is a trimmed version of the AgentCard defined in the A2A protocol https://a2a-protocol.org/dev/specification/#441-agentcard # Required. The agent card of the remote agent that this tool invokes. @@ -1600,6 +1621,9 @@

Method Details

"description": "A String", # Output only. The description of the Python function, parsed from the python code's docstring. "name": "A String", # Optional. The name of the Python function to execute. Must match a Python function name defined in the python code. Case sensitive. If the name is not provided, the first function defined in the python code will be used. "pythonCode": "A String", # Optional. The Python code to execute for the tool. + "serviceDirectoryConfig": { # Configuration for tools using Service Directory. # Optional. Service Directory configuration for the tool. + "service": "A String", # Required. The name of [Service Directory](https://cloud.google.com/service-directory) service. Format: `projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}`. Location of the service directory must be the same as the location of the app. + }, }, "pythonScript": "A String", # Deprecated: Use `python_function` instead. "sourceToolName": "A String", # Optional. The resource name of the tool that provides the data for the widget (e.g., a search tool or a custom function). Format: `projects/{project}/locations/{location}/agents/{agent}/tools/{tool}` @@ -1966,6 +1990,7 @@

Method Details

"uniqueItems": True or False, # Optional. Indicate the items in the array must be unique. Only applies to TYPE.ARRAY. }, "name": "A String", # Required. The name of the MCP tool. + "nameOverride": "A String", # Optional. The name override of the MCP tool. This is populated if the name was overridden by a Toolset override. "outputSchema": { # Represents a select subset of an OpenAPI 3.0 schema object. # Optional. The schema of the output arguments of the MCP tool. "additionalProperties": # Object with schema name: Schema # Optional. Can either be a boolean or an object, controls the presence of additional properties. "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. @@ -2003,6 +2028,7 @@

Method Details

"serviceDirectoryConfig": { # Configuration for tools using Service Directory. # Optional. Service Directory configuration for VPC-SC, used to resolve service names within a perimeter. "service": "A String", # Required. The name of [Service Directory](https://cloud.google.com/service-directory) service. Format: `projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}`. Location of the service directory must be the same as the location of the app. }, + "state": "A String", # Output only. The dynamic availability state of the tool on the external server. "tlsConfig": { # The TLS configuration. # Optional. The TLS configuration. Includes the custom server certificates that the client should trust. "caCerts": [ # Required. Specifies a list of allowed custom CA certificates for HTTPS verification. { # The CA certificate. @@ -2062,6 +2088,9 @@

Method Details

"description": "A String", # Output only. The description of the Python function, parsed from the python code's docstring. "name": "A String", # Optional. The name of the Python function to execute. Must match a Python function name defined in the python code. Case sensitive. If the name is not provided, the first function defined in the python code will be used. "pythonCode": "A String", # Optional. The Python code to execute for the tool. + "serviceDirectoryConfig": { # Configuration for tools using Service Directory. # Optional. Service Directory configuration for the tool. + "service": "A String", # Required. The name of [Service Directory](https://cloud.google.com/service-directory) service. Format: `projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}`. Location of the service directory must be the same as the location of the app. + }, }, "remoteAgentTool": { # Represents a tool that allows the agent to call another remote agent. # Optional. The remote agent tool. "agentCard": { # AgentCard conveys key information about a remote agent. It is a trimmed version of the AgentCard defined in the A2A protocol https://a2a-protocol.org/dev/specification/#441-agentcard # Required. The agent card of the remote agent that this tool invokes. @@ -2121,6 +2150,9 @@

Method Details

"description": "A String", # Output only. The description of the Python function, parsed from the python code's docstring. "name": "A String", # Optional. The name of the Python function to execute. Must match a Python function name defined in the python code. Case sensitive. If the name is not provided, the first function defined in the python code will be used. "pythonCode": "A String", # Optional. The Python code to execute for the tool. + "serviceDirectoryConfig": { # Configuration for tools using Service Directory. # Optional. Service Directory configuration for the tool. + "service": "A String", # Required. The name of [Service Directory](https://cloud.google.com/service-directory) service. Format: `projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}`. Location of the service directory must be the same as the location of the app. + }, }, "pythonScript": "A String", # Deprecated: Use `python_function` instead. "sourceToolName": "A String", # Optional. The resource name of the tool that provides the data for the widget (e.g., a search tool or a custom function). Format: `projects/{project}/locations/{location}/agents/{agent}/tools/{tool}` @@ -2491,6 +2523,7 @@

Method Details

"uniqueItems": True or False, # Optional. Indicate the items in the array must be unique. Only applies to TYPE.ARRAY. }, "name": "A String", # Required. The name of the MCP tool. + "nameOverride": "A String", # Optional. The name override of the MCP tool. This is populated if the name was overridden by a Toolset override. "outputSchema": { # Represents a select subset of an OpenAPI 3.0 schema object. # Optional. The schema of the output arguments of the MCP tool. "additionalProperties": # Object with schema name: Schema # Optional. Can either be a boolean or an object, controls the presence of additional properties. "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. @@ -2528,6 +2561,7 @@

Method Details

"serviceDirectoryConfig": { # Configuration for tools using Service Directory. # Optional. Service Directory configuration for VPC-SC, used to resolve service names within a perimeter. "service": "A String", # Required. The name of [Service Directory](https://cloud.google.com/service-directory) service. Format: `projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}`. Location of the service directory must be the same as the location of the app. }, + "state": "A String", # Output only. The dynamic availability state of the tool on the external server. "tlsConfig": { # The TLS configuration. # Optional. The TLS configuration. Includes the custom server certificates that the client should trust. "caCerts": [ # Required. Specifies a list of allowed custom CA certificates for HTTPS verification. { # The CA certificate. @@ -2587,6 +2621,9 @@

Method Details

"description": "A String", # Output only. The description of the Python function, parsed from the python code's docstring. "name": "A String", # Optional. The name of the Python function to execute. Must match a Python function name defined in the python code. Case sensitive. If the name is not provided, the first function defined in the python code will be used. "pythonCode": "A String", # Optional. The Python code to execute for the tool. + "serviceDirectoryConfig": { # Configuration for tools using Service Directory. # Optional. Service Directory configuration for the tool. + "service": "A String", # Required. The name of [Service Directory](https://cloud.google.com/service-directory) service. Format: `projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}`. Location of the service directory must be the same as the location of the app. + }, }, "remoteAgentTool": { # Represents a tool that allows the agent to call another remote agent. # Optional. The remote agent tool. "agentCard": { # AgentCard conveys key information about a remote agent. It is a trimmed version of the AgentCard defined in the A2A protocol https://a2a-protocol.org/dev/specification/#441-agentcard # Required. The agent card of the remote agent that this tool invokes. @@ -2646,6 +2683,9 @@

Method Details

"description": "A String", # Output only. The description of the Python function, parsed from the python code's docstring. "name": "A String", # Optional. The name of the Python function to execute. Must match a Python function name defined in the python code. Case sensitive. If the name is not provided, the first function defined in the python code will be used. "pythonCode": "A String", # Optional. The Python code to execute for the tool. + "serviceDirectoryConfig": { # Configuration for tools using Service Directory. # Optional. Service Directory configuration for the tool. + "service": "A String", # Required. The name of [Service Directory](https://cloud.google.com/service-directory) service. Format: `projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}`. Location of the service directory must be the same as the location of the app. + }, }, "pythonScript": "A String", # Deprecated: Use `python_function` instead. "sourceToolName": "A String", # Optional. The resource name of the tool that provides the data for the widget (e.g., a search tool or a custom function). Format: `projects/{project}/locations/{location}/agents/{agent}/tools/{tool}` @@ -2999,6 +3039,7 @@

Method Details

"uniqueItems": True or False, # Optional. Indicate the items in the array must be unique. Only applies to TYPE.ARRAY. }, "name": "A String", # Required. The name of the MCP tool. + "nameOverride": "A String", # Optional. The name override of the MCP tool. This is populated if the name was overridden by a Toolset override. "outputSchema": { # Represents a select subset of an OpenAPI 3.0 schema object. # Optional. The schema of the output arguments of the MCP tool. "additionalProperties": # Object with schema name: Schema # Optional. Can either be a boolean or an object, controls the presence of additional properties. "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. @@ -3036,6 +3077,7 @@

Method Details

"serviceDirectoryConfig": { # Configuration for tools using Service Directory. # Optional. Service Directory configuration for VPC-SC, used to resolve service names within a perimeter. "service": "A String", # Required. The name of [Service Directory](https://cloud.google.com/service-directory) service. Format: `projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}`. Location of the service directory must be the same as the location of the app. }, + "state": "A String", # Output only. The dynamic availability state of the tool on the external server. "tlsConfig": { # The TLS configuration. # Optional. The TLS configuration. Includes the custom server certificates that the client should trust. "caCerts": [ # Required. Specifies a list of allowed custom CA certificates for HTTPS verification. { # The CA certificate. @@ -3095,6 +3137,9 @@

Method Details

"description": "A String", # Output only. The description of the Python function, parsed from the python code's docstring. "name": "A String", # Optional. The name of the Python function to execute. Must match a Python function name defined in the python code. Case sensitive. If the name is not provided, the first function defined in the python code will be used. "pythonCode": "A String", # Optional. The Python code to execute for the tool. + "serviceDirectoryConfig": { # Configuration for tools using Service Directory. # Optional. Service Directory configuration for the tool. + "service": "A String", # Required. The name of [Service Directory](https://cloud.google.com/service-directory) service. Format: `projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}`. Location of the service directory must be the same as the location of the app. + }, }, "remoteAgentTool": { # Represents a tool that allows the agent to call another remote agent. # Optional. The remote agent tool. "agentCard": { # AgentCard conveys key information about a remote agent. It is a trimmed version of the AgentCard defined in the A2A protocol https://a2a-protocol.org/dev/specification/#441-agentcard # Required. The agent card of the remote agent that this tool invokes. @@ -3154,6 +3199,9 @@

Method Details

"description": "A String", # Output only. The description of the Python function, parsed from the python code's docstring. "name": "A String", # Optional. The name of the Python function to execute. Must match a Python function name defined in the python code. Case sensitive. If the name is not provided, the first function defined in the python code will be used. "pythonCode": "A String", # Optional. The Python code to execute for the tool. + "serviceDirectoryConfig": { # Configuration for tools using Service Directory. # Optional. Service Directory configuration for the tool. + "service": "A String", # Required. The name of [Service Directory](https://cloud.google.com/service-directory) service. Format: `projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}`. Location of the service directory must be the same as the location of the app. + }, }, "pythonScript": "A String", # Deprecated: Use `python_function` instead. "sourceToolName": "A String", # Optional. The resource name of the tool that provides the data for the widget (e.g., a search tool or a custom function). Format: `projects/{project}/locations/{location}/agents/{agent}/tools/{tool}` diff --git a/docs/dyn/ces_v1.projects.locations.apps.toolsets.html b/docs/dyn/ces_v1.projects.locations.apps.toolsets.html index d212b41072..68534ad20d 100644 --- a/docs/dyn/ces_v1.projects.locations.apps.toolsets.html +++ b/docs/dyn/ces_v1.projects.locations.apps.toolsets.html @@ -190,6 +190,82 @@

Method Details

}, ], }, + "toolOverrides": [ # Optional. Overrides for individual tools within this toolset. This allows overriding specific details like descriptions, names, or pinning the tools' states so they aren't fully dynamic. + { # Overrides associated with a given tool in a Toolset. This enables "pinning" or "overriding" of tool definitions from the external dynamic server. + "descriptionOverride": "A String", # Optional. If present, this tool uses this description instead of the original description from the server. + "nameOverride": "A String", # Optional. If present, this tool uses this name in the Agent instead of the original name. This is primarily used as an alias if the MCP server offers poorly named tools. + "snapshot": { # Container for a tool's core definition elements that are snapshot. Schemas in the snapshot are used as-is and cannot be overridden. # Output only. If present, this tool is "Pinned" and uses the snapshot values as fallbacks if the server becomes temporarily unavailable or if no Override is present. + "description": "A String", # Output only. The description of the MCP tool. This can be overridden by `description_override` in `McpToolOverride`. + "inputSchema": { # Represents a select subset of an OpenAPI 3.0 schema object. # Output only. The schema of the input arguments of the MCP tool. + "additionalProperties": # Object with schema name: Schema # Optional. Can either be a boolean or an object, controls the presence of additional properties. + "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. + # Object with schema name: Schema + ], + "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: Schema + }, + "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", + ], + "items": # Object with schema name: Schema # Optional. Schema of the elements of Type.ARRAY. + "maxItems": "A String", # Optional. Maximum number of the elements for Type.ARRAY. + "maximum": 3.14, # Optional. Maximum value for Type.INTEGER and Type.NUMBER. + "minItems": "A String", # Optional. Minimum number of the elements for Type.ARRAY. + "minimum": 3.14, # Optional. Minimum value for Type.INTEGER and Type.NUMBER. + "nullable": True or False, # Optional. Indicates if the value may be null. + "prefixItems": [ # Optional. Schemas of initial elements of Type.ARRAY. + # Object with schema name: Schema + ], + "properties": { # Optional. Properties of Type.OBJECT. + "a_key": # Object with schema name: Schema + }, + "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", # Required. The type of the data. + "uniqueItems": True or False, # Optional. Indicate the items in the array must be unique. Only applies to TYPE.ARRAY. + }, + "outputSchema": { # Represents a select subset of an OpenAPI 3.0 schema object. # Output only. The schema of the output arguments of the MCP tool. + "additionalProperties": # Object with schema name: Schema # Optional. Can either be a boolean or an object, controls the presence of additional properties. + "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. + # Object with schema name: Schema + ], + "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: Schema + }, + "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", + ], + "items": # Object with schema name: Schema # Optional. Schema of the elements of Type.ARRAY. + "maxItems": "A String", # Optional. Maximum number of the elements for Type.ARRAY. + "maximum": 3.14, # Optional. Maximum value for Type.INTEGER and Type.NUMBER. + "minItems": "A String", # Optional. Minimum number of the elements for Type.ARRAY. + "minimum": 3.14, # Optional. Minimum value for Type.INTEGER and Type.NUMBER. + "nullable": True or False, # Optional. Indicates if the value may be null. + "prefixItems": [ # Optional. Schemas of initial elements of Type.ARRAY. + # Object with schema name: Schema + ], + "properties": { # Optional. Properties of Type.OBJECT. + "a_key": # Object with schema name: Schema + }, + "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", # Required. The type of the data. + "uniqueItems": True or False, # Optional. Indicate the items in the array must be unique. Only applies to TYPE.ARRAY. + }, + }, + "tool": "A String", # Required. The original name of the tool as it is emitted by the MCP server. + }, + ], }, "name": "A String", # Identifier. The unique identifier of the toolset. Format: `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}` "openApiToolset": { # A toolset that contains a list of tools that are defined by an OpenAPI schema. # Optional. A toolset that contains a list of tools that are defined by an OpenAPI schema. @@ -330,6 +406,82 @@

Method Details

}, ], }, + "toolOverrides": [ # Optional. Overrides for individual tools within this toolset. This allows overriding specific details like descriptions, names, or pinning the tools' states so they aren't fully dynamic. + { # Overrides associated with a given tool in a Toolset. This enables "pinning" or "overriding" of tool definitions from the external dynamic server. + "descriptionOverride": "A String", # Optional. If present, this tool uses this description instead of the original description from the server. + "nameOverride": "A String", # Optional. If present, this tool uses this name in the Agent instead of the original name. This is primarily used as an alias if the MCP server offers poorly named tools. + "snapshot": { # Container for a tool's core definition elements that are snapshot. Schemas in the snapshot are used as-is and cannot be overridden. # Output only. If present, this tool is "Pinned" and uses the snapshot values as fallbacks if the server becomes temporarily unavailable or if no Override is present. + "description": "A String", # Output only. The description of the MCP tool. This can be overridden by `description_override` in `McpToolOverride`. + "inputSchema": { # Represents a select subset of an OpenAPI 3.0 schema object. # Output only. The schema of the input arguments of the MCP tool. + "additionalProperties": # Object with schema name: Schema # Optional. Can either be a boolean or an object, controls the presence of additional properties. + "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. + # Object with schema name: Schema + ], + "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: Schema + }, + "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", + ], + "items": # Object with schema name: Schema # Optional. Schema of the elements of Type.ARRAY. + "maxItems": "A String", # Optional. Maximum number of the elements for Type.ARRAY. + "maximum": 3.14, # Optional. Maximum value for Type.INTEGER and Type.NUMBER. + "minItems": "A String", # Optional. Minimum number of the elements for Type.ARRAY. + "minimum": 3.14, # Optional. Minimum value for Type.INTEGER and Type.NUMBER. + "nullable": True or False, # Optional. Indicates if the value may be null. + "prefixItems": [ # Optional. Schemas of initial elements of Type.ARRAY. + # Object with schema name: Schema + ], + "properties": { # Optional. Properties of Type.OBJECT. + "a_key": # Object with schema name: Schema + }, + "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", # Required. The type of the data. + "uniqueItems": True or False, # Optional. Indicate the items in the array must be unique. Only applies to TYPE.ARRAY. + }, + "outputSchema": { # Represents a select subset of an OpenAPI 3.0 schema object. # Output only. The schema of the output arguments of the MCP tool. + "additionalProperties": # Object with schema name: Schema # Optional. Can either be a boolean or an object, controls the presence of additional properties. + "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. + # Object with schema name: Schema + ], + "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: Schema + }, + "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", + ], + "items": # Object with schema name: Schema # Optional. Schema of the elements of Type.ARRAY. + "maxItems": "A String", # Optional. Maximum number of the elements for Type.ARRAY. + "maximum": 3.14, # Optional. Maximum value for Type.INTEGER and Type.NUMBER. + "minItems": "A String", # Optional. Minimum number of the elements for Type.ARRAY. + "minimum": 3.14, # Optional. Minimum value for Type.INTEGER and Type.NUMBER. + "nullable": True or False, # Optional. Indicates if the value may be null. + "prefixItems": [ # Optional. Schemas of initial elements of Type.ARRAY. + # Object with schema name: Schema + ], + "properties": { # Optional. Properties of Type.OBJECT. + "a_key": # Object with schema name: Schema + }, + "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", # Required. The type of the data. + "uniqueItems": True or False, # Optional. Indicate the items in the array must be unique. Only applies to TYPE.ARRAY. + }, + }, + "tool": "A String", # Required. The original name of the tool as it is emitted by the MCP server. + }, + ], }, "name": "A String", # Identifier. The unique identifier of the toolset. Format: `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}` "openApiToolset": { # A toolset that contains a list of tools that are defined by an OpenAPI schema. # Optional. A toolset that contains a list of tools that are defined by an OpenAPI schema. @@ -496,6 +648,82 @@

Method Details

}, ], }, + "toolOverrides": [ # Optional. Overrides for individual tools within this toolset. This allows overriding specific details like descriptions, names, or pinning the tools' states so they aren't fully dynamic. + { # Overrides associated with a given tool in a Toolset. This enables "pinning" or "overriding" of tool definitions from the external dynamic server. + "descriptionOverride": "A String", # Optional. If present, this tool uses this description instead of the original description from the server. + "nameOverride": "A String", # Optional. If present, this tool uses this name in the Agent instead of the original name. This is primarily used as an alias if the MCP server offers poorly named tools. + "snapshot": { # Container for a tool's core definition elements that are snapshot. Schemas in the snapshot are used as-is and cannot be overridden. # Output only. If present, this tool is "Pinned" and uses the snapshot values as fallbacks if the server becomes temporarily unavailable or if no Override is present. + "description": "A String", # Output only. The description of the MCP tool. This can be overridden by `description_override` in `McpToolOverride`. + "inputSchema": { # Represents a select subset of an OpenAPI 3.0 schema object. # Output only. The schema of the input arguments of the MCP tool. + "additionalProperties": # Object with schema name: Schema # Optional. Can either be a boolean or an object, controls the presence of additional properties. + "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. + # Object with schema name: Schema + ], + "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: Schema + }, + "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", + ], + "items": # Object with schema name: Schema # Optional. Schema of the elements of Type.ARRAY. + "maxItems": "A String", # Optional. Maximum number of the elements for Type.ARRAY. + "maximum": 3.14, # Optional. Maximum value for Type.INTEGER and Type.NUMBER. + "minItems": "A String", # Optional. Minimum number of the elements for Type.ARRAY. + "minimum": 3.14, # Optional. Minimum value for Type.INTEGER and Type.NUMBER. + "nullable": True or False, # Optional. Indicates if the value may be null. + "prefixItems": [ # Optional. Schemas of initial elements of Type.ARRAY. + # Object with schema name: Schema + ], + "properties": { # Optional. Properties of Type.OBJECT. + "a_key": # Object with schema name: Schema + }, + "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", # Required. The type of the data. + "uniqueItems": True or False, # Optional. Indicate the items in the array must be unique. Only applies to TYPE.ARRAY. + }, + "outputSchema": { # Represents a select subset of an OpenAPI 3.0 schema object. # Output only. The schema of the output arguments of the MCP tool. + "additionalProperties": # Object with schema name: Schema # Optional. Can either be a boolean or an object, controls the presence of additional properties. + "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. + # Object with schema name: Schema + ], + "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: Schema + }, + "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", + ], + "items": # Object with schema name: Schema # Optional. Schema of the elements of Type.ARRAY. + "maxItems": "A String", # Optional. Maximum number of the elements for Type.ARRAY. + "maximum": 3.14, # Optional. Maximum value for Type.INTEGER and Type.NUMBER. + "minItems": "A String", # Optional. Minimum number of the elements for Type.ARRAY. + "minimum": 3.14, # Optional. Minimum value for Type.INTEGER and Type.NUMBER. + "nullable": True or False, # Optional. Indicates if the value may be null. + "prefixItems": [ # Optional. Schemas of initial elements of Type.ARRAY. + # Object with schema name: Schema + ], + "properties": { # Optional. Properties of Type.OBJECT. + "a_key": # Object with schema name: Schema + }, + "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", # Required. The type of the data. + "uniqueItems": True or False, # Optional. Indicate the items in the array must be unique. Only applies to TYPE.ARRAY. + }, + }, + "tool": "A String", # Required. The original name of the tool as it is emitted by the MCP server. + }, + ], }, "name": "A String", # Identifier. The unique identifier of the toolset. Format: `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}` "openApiToolset": { # A toolset that contains a list of tools that are defined by an OpenAPI schema. # Optional. A toolset that contains a list of tools that are defined by an OpenAPI schema. @@ -649,6 +877,82 @@

Method Details

}, ], }, + "toolOverrides": [ # Optional. Overrides for individual tools within this toolset. This allows overriding specific details like descriptions, names, or pinning the tools' states so they aren't fully dynamic. + { # Overrides associated with a given tool in a Toolset. This enables "pinning" or "overriding" of tool definitions from the external dynamic server. + "descriptionOverride": "A String", # Optional. If present, this tool uses this description instead of the original description from the server. + "nameOverride": "A String", # Optional. If present, this tool uses this name in the Agent instead of the original name. This is primarily used as an alias if the MCP server offers poorly named tools. + "snapshot": { # Container for a tool's core definition elements that are snapshot. Schemas in the snapshot are used as-is and cannot be overridden. # Output only. If present, this tool is "Pinned" and uses the snapshot values as fallbacks if the server becomes temporarily unavailable or if no Override is present. + "description": "A String", # Output only. The description of the MCP tool. This can be overridden by `description_override` in `McpToolOverride`. + "inputSchema": { # Represents a select subset of an OpenAPI 3.0 schema object. # Output only. The schema of the input arguments of the MCP tool. + "additionalProperties": # Object with schema name: Schema # Optional. Can either be a boolean or an object, controls the presence of additional properties. + "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. + # Object with schema name: Schema + ], + "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: Schema + }, + "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", + ], + "items": # Object with schema name: Schema # Optional. Schema of the elements of Type.ARRAY. + "maxItems": "A String", # Optional. Maximum number of the elements for Type.ARRAY. + "maximum": 3.14, # Optional. Maximum value for Type.INTEGER and Type.NUMBER. + "minItems": "A String", # Optional. Minimum number of the elements for Type.ARRAY. + "minimum": 3.14, # Optional. Minimum value for Type.INTEGER and Type.NUMBER. + "nullable": True or False, # Optional. Indicates if the value may be null. + "prefixItems": [ # Optional. Schemas of initial elements of Type.ARRAY. + # Object with schema name: Schema + ], + "properties": { # Optional. Properties of Type.OBJECT. + "a_key": # Object with schema name: Schema + }, + "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", # Required. The type of the data. + "uniqueItems": True or False, # Optional. Indicate the items in the array must be unique. Only applies to TYPE.ARRAY. + }, + "outputSchema": { # Represents a select subset of an OpenAPI 3.0 schema object. # Output only. The schema of the output arguments of the MCP tool. + "additionalProperties": # Object with schema name: Schema # Optional. Can either be a boolean or an object, controls the presence of additional properties. + "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. + # Object with schema name: Schema + ], + "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: Schema + }, + "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", + ], + "items": # Object with schema name: Schema # Optional. Schema of the elements of Type.ARRAY. + "maxItems": "A String", # Optional. Maximum number of the elements for Type.ARRAY. + "maximum": 3.14, # Optional. Maximum value for Type.INTEGER and Type.NUMBER. + "minItems": "A String", # Optional. Minimum number of the elements for Type.ARRAY. + "minimum": 3.14, # Optional. Minimum value for Type.INTEGER and Type.NUMBER. + "nullable": True or False, # Optional. Indicates if the value may be null. + "prefixItems": [ # Optional. Schemas of initial elements of Type.ARRAY. + # Object with schema name: Schema + ], + "properties": { # Optional. Properties of Type.OBJECT. + "a_key": # Object with schema name: Schema + }, + "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", # Required. The type of the data. + "uniqueItems": True or False, # Optional. Indicate the items in the array must be unique. Only applies to TYPE.ARRAY. + }, + }, + "tool": "A String", # Required. The original name of the tool as it is emitted by the MCP server. + }, + ], }, "name": "A String", # Identifier. The unique identifier of the toolset. Format: `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}` "openApiToolset": { # A toolset that contains a list of tools that are defined by an OpenAPI schema. # Optional. A toolset that contains a list of tools that are defined by an OpenAPI schema. @@ -806,6 +1110,82 @@

Method Details

}, ], }, + "toolOverrides": [ # Optional. Overrides for individual tools within this toolset. This allows overriding specific details like descriptions, names, or pinning the tools' states so they aren't fully dynamic. + { # Overrides associated with a given tool in a Toolset. This enables "pinning" or "overriding" of tool definitions from the external dynamic server. + "descriptionOverride": "A String", # Optional. If present, this tool uses this description instead of the original description from the server. + "nameOverride": "A String", # Optional. If present, this tool uses this name in the Agent instead of the original name. This is primarily used as an alias if the MCP server offers poorly named tools. + "snapshot": { # Container for a tool's core definition elements that are snapshot. Schemas in the snapshot are used as-is and cannot be overridden. # Output only. If present, this tool is "Pinned" and uses the snapshot values as fallbacks if the server becomes temporarily unavailable or if no Override is present. + "description": "A String", # Output only. The description of the MCP tool. This can be overridden by `description_override` in `McpToolOverride`. + "inputSchema": { # Represents a select subset of an OpenAPI 3.0 schema object. # Output only. The schema of the input arguments of the MCP tool. + "additionalProperties": # Object with schema name: Schema # Optional. Can either be a boolean or an object, controls the presence of additional properties. + "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. + # Object with schema name: Schema + ], + "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: Schema + }, + "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", + ], + "items": # Object with schema name: Schema # Optional. Schema of the elements of Type.ARRAY. + "maxItems": "A String", # Optional. Maximum number of the elements for Type.ARRAY. + "maximum": 3.14, # Optional. Maximum value for Type.INTEGER and Type.NUMBER. + "minItems": "A String", # Optional. Minimum number of the elements for Type.ARRAY. + "minimum": 3.14, # Optional. Minimum value for Type.INTEGER and Type.NUMBER. + "nullable": True or False, # Optional. Indicates if the value may be null. + "prefixItems": [ # Optional. Schemas of initial elements of Type.ARRAY. + # Object with schema name: Schema + ], + "properties": { # Optional. Properties of Type.OBJECT. + "a_key": # Object with schema name: Schema + }, + "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", # Required. The type of the data. + "uniqueItems": True or False, # Optional. Indicate the items in the array must be unique. Only applies to TYPE.ARRAY. + }, + "outputSchema": { # Represents a select subset of an OpenAPI 3.0 schema object. # Output only. The schema of the output arguments of the MCP tool. + "additionalProperties": # Object with schema name: Schema # Optional. Can either be a boolean or an object, controls the presence of additional properties. + "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. + # Object with schema name: Schema + ], + "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: Schema + }, + "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", + ], + "items": # Object with schema name: Schema # Optional. Schema of the elements of Type.ARRAY. + "maxItems": "A String", # Optional. Maximum number of the elements for Type.ARRAY. + "maximum": 3.14, # Optional. Maximum value for Type.INTEGER and Type.NUMBER. + "minItems": "A String", # Optional. Minimum number of the elements for Type.ARRAY. + "minimum": 3.14, # Optional. Minimum value for Type.INTEGER and Type.NUMBER. + "nullable": True or False, # Optional. Indicates if the value may be null. + "prefixItems": [ # Optional. Schemas of initial elements of Type.ARRAY. + # Object with schema name: Schema + ], + "properties": { # Optional. Properties of Type.OBJECT. + "a_key": # Object with schema name: Schema + }, + "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", # Required. The type of the data. + "uniqueItems": True or False, # Optional. Indicate the items in the array must be unique. Only applies to TYPE.ARRAY. + }, + }, + "tool": "A String", # Required. The original name of the tool as it is emitted by the MCP server. + }, + ], }, "name": "A String", # Identifier. The unique identifier of the toolset. Format: `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}` "openApiToolset": { # A toolset that contains a list of tools that are defined by an OpenAPI schema. # Optional. A toolset that contains a list of tools that are defined by an OpenAPI schema. @@ -946,6 +1326,82 @@

Method Details

}, ], }, + "toolOverrides": [ # Optional. Overrides for individual tools within this toolset. This allows overriding specific details like descriptions, names, or pinning the tools' states so they aren't fully dynamic. + { # Overrides associated with a given tool in a Toolset. This enables "pinning" or "overriding" of tool definitions from the external dynamic server. + "descriptionOverride": "A String", # Optional. If present, this tool uses this description instead of the original description from the server. + "nameOverride": "A String", # Optional. If present, this tool uses this name in the Agent instead of the original name. This is primarily used as an alias if the MCP server offers poorly named tools. + "snapshot": { # Container for a tool's core definition elements that are snapshot. Schemas in the snapshot are used as-is and cannot be overridden. # Output only. If present, this tool is "Pinned" and uses the snapshot values as fallbacks if the server becomes temporarily unavailable or if no Override is present. + "description": "A String", # Output only. The description of the MCP tool. This can be overridden by `description_override` in `McpToolOverride`. + "inputSchema": { # Represents a select subset of an OpenAPI 3.0 schema object. # Output only. The schema of the input arguments of the MCP tool. + "additionalProperties": # Object with schema name: Schema # Optional. Can either be a boolean or an object, controls the presence of additional properties. + "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. + # Object with schema name: Schema + ], + "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: Schema + }, + "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", + ], + "items": # Object with schema name: Schema # Optional. Schema of the elements of Type.ARRAY. + "maxItems": "A String", # Optional. Maximum number of the elements for Type.ARRAY. + "maximum": 3.14, # Optional. Maximum value for Type.INTEGER and Type.NUMBER. + "minItems": "A String", # Optional. Minimum number of the elements for Type.ARRAY. + "minimum": 3.14, # Optional. Minimum value for Type.INTEGER and Type.NUMBER. + "nullable": True or False, # Optional. Indicates if the value may be null. + "prefixItems": [ # Optional. Schemas of initial elements of Type.ARRAY. + # Object with schema name: Schema + ], + "properties": { # Optional. Properties of Type.OBJECT. + "a_key": # Object with schema name: Schema + }, + "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", # Required. The type of the data. + "uniqueItems": True or False, # Optional. Indicate the items in the array must be unique. Only applies to TYPE.ARRAY. + }, + "outputSchema": { # Represents a select subset of an OpenAPI 3.0 schema object. # Output only. The schema of the output arguments of the MCP tool. + "additionalProperties": # Object with schema name: Schema # Optional. Can either be a boolean or an object, controls the presence of additional properties. + "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. + # Object with schema name: Schema + ], + "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: Schema + }, + "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", + ], + "items": # Object with schema name: Schema # Optional. Schema of the elements of Type.ARRAY. + "maxItems": "A String", # Optional. Maximum number of the elements for Type.ARRAY. + "maximum": 3.14, # Optional. Maximum value for Type.INTEGER and Type.NUMBER. + "minItems": "A String", # Optional. Minimum number of the elements for Type.ARRAY. + "minimum": 3.14, # Optional. Minimum value for Type.INTEGER and Type.NUMBER. + "nullable": True or False, # Optional. Indicates if the value may be null. + "prefixItems": [ # Optional. Schemas of initial elements of Type.ARRAY. + # Object with schema name: Schema + ], + "properties": { # Optional. Properties of Type.OBJECT. + "a_key": # Object with schema name: Schema + }, + "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", # Required. The type of the data. + "uniqueItems": True or False, # Optional. Indicate the items in the array must be unique. Only applies to TYPE.ARRAY. + }, + }, + "tool": "A String", # Required. The original name of the tool as it is emitted by the MCP server. + }, + ], }, "name": "A String", # Identifier. The unique identifier of the toolset. Format: `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}` "openApiToolset": { # A toolset that contains a list of tools that are defined by an OpenAPI schema. # Optional. A toolset that contains a list of tools that are defined by an OpenAPI schema. @@ -1011,6 +1467,7 @@

Method Details

The object takes the form of: { # Request message for ToolService.RetrieveTools. + "bypassPersistenceConfig": True or False, # Optional. If true, the returned tools will contain raw descriptions and schemas directly from the server, bypassing any stored persistence configurations (overrides/snapshots). "toolIds": [ # Optional. The identifiers of the tools to retrieve from the toolset. If empty, all tools in the toolset will be returned. "A String", ], @@ -1319,6 +1776,7 @@

Method Details

"uniqueItems": True or False, # Optional. Indicate the items in the array must be unique. Only applies to TYPE.ARRAY. }, "name": "A String", # Required. The name of the MCP tool. + "nameOverride": "A String", # Optional. The name override of the MCP tool. This is populated if the name was overridden by a Toolset override. "outputSchema": { # Represents a select subset of an OpenAPI 3.0 schema object. # Optional. The schema of the output arguments of the MCP tool. "additionalProperties": # Object with schema name: Schema # Optional. Can either be a boolean or an object, controls the presence of additional properties. "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. @@ -1356,6 +1814,7 @@

Method Details

"serviceDirectoryConfig": { # Configuration for tools using Service Directory. # Optional. Service Directory configuration for VPC-SC, used to resolve service names within a perimeter. "service": "A String", # Required. The name of [Service Directory](https://cloud.google.com/service-directory) service. Format: `projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}`. Location of the service directory must be the same as the location of the app. }, + "state": "A String", # Output only. The dynamic availability state of the tool on the external server. "tlsConfig": { # The TLS configuration. # Optional. The TLS configuration. Includes the custom server certificates that the client should trust. "caCerts": [ # Required. Specifies a list of allowed custom CA certificates for HTTPS verification. { # The CA certificate. @@ -1415,6 +1874,9 @@

Method Details

"description": "A String", # Output only. The description of the Python function, parsed from the python code's docstring. "name": "A String", # Optional. The name of the Python function to execute. Must match a Python function name defined in the python code. Case sensitive. If the name is not provided, the first function defined in the python code will be used. "pythonCode": "A String", # Optional. The Python code to execute for the tool. + "serviceDirectoryConfig": { # Configuration for tools using Service Directory. # Optional. Service Directory configuration for the tool. + "service": "A String", # Required. The name of [Service Directory](https://cloud.google.com/service-directory) service. Format: `projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}`. Location of the service directory must be the same as the location of the app. + }, }, "remoteAgentTool": { # Represents a tool that allows the agent to call another remote agent. # Optional. The remote agent tool. "agentCard": { # AgentCard conveys key information about a remote agent. It is a trimmed version of the AgentCard defined in the A2A protocol https://a2a-protocol.org/dev/specification/#441-agentcard # Required. The agent card of the remote agent that this tool invokes. @@ -1474,6 +1936,9 @@

Method Details

"description": "A String", # Output only. The description of the Python function, parsed from the python code's docstring. "name": "A String", # Optional. The name of the Python function to execute. Must match a Python function name defined in the python code. Case sensitive. If the name is not provided, the first function defined in the python code will be used. "pythonCode": "A String", # Optional. The Python code to execute for the tool. + "serviceDirectoryConfig": { # Configuration for tools using Service Directory. # Optional. Service Directory configuration for the tool. + "service": "A String", # Required. The name of [Service Directory](https://cloud.google.com/service-directory) service. Format: `projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}`. Location of the service directory must be the same as the location of the app. + }, }, "pythonScript": "A String", # Deprecated: Use `python_function` instead. "sourceToolName": "A String", # Optional. The resource name of the tool that provides the data for the widget (e.g., a search tool or a custom function). Format: `projects/{project}/locations/{location}/agents/{agent}/tools/{tool}` diff --git a/docs/dyn/ces_v1.projects.locations.apps.versions.html b/docs/dyn/ces_v1.projects.locations.apps.versions.html index 147f6b987b..cad1bc4cb7 100644 --- a/docs/dyn/ces_v1.projects.locations.apps.versions.html +++ b/docs/dyn/ces_v1.projects.locations.apps.versions.html @@ -194,6 +194,7 @@

Method Details

"inputVariableMapping": { # Optional. The mapping of the app variables names to the Dialogflow session parameters names to be sent to the Dialogflow agent as input. "a_key": "A String", }, + "languageCodeVariable": "A String", # Optional. The name of the variable that contains the language code to be used for the Dialogflow session. If unspecified, the default language code of the Dialogflow agent will be used. "outputVariableMapping": { # Optional. The mapping of the Dialogflow session parameters names to the app variables names to be sent back to the CES agent after the Dialogflow agent execution ends. "a_key": "A String", }, @@ -340,11 +341,11 @@

Method Details

}, "locked": True or False, # Optional. Indicates whether the app is locked for changes. If the app is locked, modifications to the app resources will be rejected. "loggingSettings": { # Settings to describe the logging behaviors for the app. # Optional. Logging settings of the app. - "audioRecordingConfig": { # Configuration for how the audio interactions should be recorded. # Optional. Configuration for how audio interactions should be recorded. + "audioRecordingConfig": { # Configuration for how the audio interactions should be recorded. # Optional. Configuration for how audio interactions should be recorded. The audio is subject to redaction as configured in RedactionConfig. "gcsBucket": "A String", # Optional. The [Cloud Storage](https://cloud.google.com/storage) bucket to store the session audio recordings. The URI must start with "gs://". Please choose a bucket location that meets your data residency requirements. Note: If the Cloud Storage bucket is in a different project from the app, you should grant `storage.objects.create` permission to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`. "gcsPathPrefix": "A String", # Optional. The Cloud Storage path prefix for audio recordings. This prefix can include the following placeholders, which will be dynamically substituted at serving time: - $project: project ID - $location: app location - $app: app ID - $date: session date in YYYY-MM-DD format - $session: session ID If the path prefix is not specified, the default prefix `$project/$location/$app/$date/$session/` will be used. }, - "bigqueryExportSettings": { # Settings to describe the BigQuery export behaviors for the app. # Optional. Settings to describe the BigQuery export behaviors for the app. The conversation data will be exported to BigQuery tables if it is enabled. + "bigqueryExportSettings": { # Settings to describe the BigQuery export behaviors for the app. # Optional. Configures the BigQuery export behaviors for the app. The conversation data is subject to redaction as configured in RedactionConfig. "dataset": "A String", # Optional. The BigQuery **dataset ID** to export the data to. "enabled": True or False, # Optional. Indicates whether the BigQuery export is enabled. "project": "A String", # Optional. The **project ID** of the BigQuery dataset to export the data to. Note: If the BigQuery dataset is in a different project from the app, you should grant `roles/bigquery.admin` role to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`. @@ -368,7 +369,7 @@

Method Details

"enableRedaction": True or False, # Optional. If true, redaction will be applied in various logging scenarios, including conversation history, Cloud Logging and audio recording. "inspectTemplate": "A String", # Optional. [DLP](https://cloud.google.com/dlp/docs) inspect template name to configure detection of sensitive data types. Format: `projects/{project}/locations/{location}/inspectTemplates/{inspect_template}` }, - "unredactedAudioRecordingConfig": { # Configuration for how the audio interactions should be recorded. # Optional. Configures recording of unredacted audio. Use this to maintain a raw backup with restricted access when audio redaction is enabled, typically for auditing or monitoring purposes. + "unredactedAudioRecordingConfig": { # Configuration for how the audio interactions should be recorded. # Optional. Configures an additional recording of unredacted audio. This can be used to maintain a raw audio copy when audio redaction is enabled, typically for auditing or monitoring purposes. "gcsBucket": "A String", # Optional. The [Cloud Storage](https://cloud.google.com/storage) bucket to store the session audio recordings. The URI must start with "gs://". Please choose a bucket location that meets your data residency requirements. Note: If the Cloud Storage bucket is in a different project from the app, you should grant `storage.objects.create` permission to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`. "gcsPathPrefix": "A String", # Optional. The Cloud Storage path prefix for audio recordings. This prefix can include the following placeholders, which will be dynamically substituted at serving time: - $project: project ID - $location: app location - $app: app ID - $date: session date in YYYY-MM-DD format - $session: session ID If the path prefix is not specified, the default prefix `$project/$location/$app/$date/$session/` will be used. }, @@ -940,6 +941,7 @@

Method Details

"uniqueItems": True or False, # Optional. Indicate the items in the array must be unique. Only applies to TYPE.ARRAY. }, "name": "A String", # Required. The name of the MCP tool. + "nameOverride": "A String", # Optional. The name override of the MCP tool. This is populated if the name was overridden by a Toolset override. "outputSchema": { # Represents a select subset of an OpenAPI 3.0 schema object. # Optional. The schema of the output arguments of the MCP tool. "additionalProperties": # Object with schema name: Schema # Optional. Can either be a boolean or an object, controls the presence of additional properties. "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. @@ -977,6 +979,7 @@

Method Details

"serviceDirectoryConfig": { # Configuration for tools using Service Directory. # Optional. Service Directory configuration for VPC-SC, used to resolve service names within a perimeter. "service": "A String", # Required. The name of [Service Directory](https://cloud.google.com/service-directory) service. Format: `projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}`. Location of the service directory must be the same as the location of the app. }, + "state": "A String", # Output only. The dynamic availability state of the tool on the external server. "tlsConfig": { # The TLS configuration. # Optional. The TLS configuration. Includes the custom server certificates that the client should trust. "caCerts": [ # Required. Specifies a list of allowed custom CA certificates for HTTPS verification. { # The CA certificate. @@ -1036,6 +1039,9 @@

Method Details

"description": "A String", # Output only. The description of the Python function, parsed from the python code's docstring. "name": "A String", # Optional. The name of the Python function to execute. Must match a Python function name defined in the python code. Case sensitive. If the name is not provided, the first function defined in the python code will be used. "pythonCode": "A String", # Optional. The Python code to execute for the tool. + "serviceDirectoryConfig": { # Configuration for tools using Service Directory. # Optional. Service Directory configuration for the tool. + "service": "A String", # Required. The name of [Service Directory](https://cloud.google.com/service-directory) service. Format: `projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}`. Location of the service directory must be the same as the location of the app. + }, }, "remoteAgentTool": { # Represents a tool that allows the agent to call another remote agent. # Optional. The remote agent tool. "agentCard": { # AgentCard conveys key information about a remote agent. It is a trimmed version of the AgentCard defined in the A2A protocol https://a2a-protocol.org/dev/specification/#441-agentcard # Required. The agent card of the remote agent that this tool invokes. @@ -1095,6 +1101,9 @@

Method Details

"description": "A String", # Output only. The description of the Python function, parsed from the python code's docstring. "name": "A String", # Optional. The name of the Python function to execute. Must match a Python function name defined in the python code. Case sensitive. If the name is not provided, the first function defined in the python code will be used. "pythonCode": "A String", # Optional. The Python code to execute for the tool. + "serviceDirectoryConfig": { # Configuration for tools using Service Directory. # Optional. Service Directory configuration for the tool. + "service": "A String", # Required. The name of [Service Directory](https://cloud.google.com/service-directory) service. Format: `projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}`. Location of the service directory must be the same as the location of the app. + }, }, "pythonScript": "A String", # Deprecated: Use `python_function` instead. "sourceToolName": "A String", # Optional. The resource name of the tool that provides the data for the widget (e.g., a search tool or a custom function). Format: `projects/{project}/locations/{location}/agents/{agent}/tools/{tool}` @@ -1224,6 +1233,82 @@

Method Details

}, ], }, + "toolOverrides": [ # Optional. Overrides for individual tools within this toolset. This allows overriding specific details like descriptions, names, or pinning the tools' states so they aren't fully dynamic. + { # Overrides associated with a given tool in a Toolset. This enables "pinning" or "overriding" of tool definitions from the external dynamic server. + "descriptionOverride": "A String", # Optional. If present, this tool uses this description instead of the original description from the server. + "nameOverride": "A String", # Optional. If present, this tool uses this name in the Agent instead of the original name. This is primarily used as an alias if the MCP server offers poorly named tools. + "snapshot": { # Container for a tool's core definition elements that are snapshot. Schemas in the snapshot are used as-is and cannot be overridden. # Output only. If present, this tool is "Pinned" and uses the snapshot values as fallbacks if the server becomes temporarily unavailable or if no Override is present. + "description": "A String", # Output only. The description of the MCP tool. This can be overridden by `description_override` in `McpToolOverride`. + "inputSchema": { # Represents a select subset of an OpenAPI 3.0 schema object. # Output only. The schema of the input arguments of the MCP tool. + "additionalProperties": # Object with schema name: Schema # Optional. Can either be a boolean or an object, controls the presence of additional properties. + "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. + # Object with schema name: Schema + ], + "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: Schema + }, + "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", + ], + "items": # Object with schema name: Schema # Optional. Schema of the elements of Type.ARRAY. + "maxItems": "A String", # Optional. Maximum number of the elements for Type.ARRAY. + "maximum": 3.14, # Optional. Maximum value for Type.INTEGER and Type.NUMBER. + "minItems": "A String", # Optional. Minimum number of the elements for Type.ARRAY. + "minimum": 3.14, # Optional. Minimum value for Type.INTEGER and Type.NUMBER. + "nullable": True or False, # Optional. Indicates if the value may be null. + "prefixItems": [ # Optional. Schemas of initial elements of Type.ARRAY. + # Object with schema name: Schema + ], + "properties": { # Optional. Properties of Type.OBJECT. + "a_key": # Object with schema name: Schema + }, + "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", # Required. The type of the data. + "uniqueItems": True or False, # Optional. Indicate the items in the array must be unique. Only applies to TYPE.ARRAY. + }, + "outputSchema": { # Represents a select subset of an OpenAPI 3.0 schema object. # Output only. The schema of the output arguments of the MCP tool. + "additionalProperties": # Object with schema name: Schema # Optional. Can either be a boolean or an object, controls the presence of additional properties. + "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. + # Object with schema name: Schema + ], + "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: Schema + }, + "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", + ], + "items": # Object with schema name: Schema # Optional. Schema of the elements of Type.ARRAY. + "maxItems": "A String", # Optional. Maximum number of the elements for Type.ARRAY. + "maximum": 3.14, # Optional. Maximum value for Type.INTEGER and Type.NUMBER. + "minItems": "A String", # Optional. Minimum number of the elements for Type.ARRAY. + "minimum": 3.14, # Optional. Minimum value for Type.INTEGER and Type.NUMBER. + "nullable": True or False, # Optional. Indicates if the value may be null. + "prefixItems": [ # Optional. Schemas of initial elements of Type.ARRAY. + # Object with schema name: Schema + ], + "properties": { # Optional. Properties of Type.OBJECT. + "a_key": # Object with schema name: Schema + }, + "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", # Required. The type of the data. + "uniqueItems": True or False, # Optional. Indicate the items in the array must be unique. Only applies to TYPE.ARRAY. + }, + }, + "tool": "A String", # Required. The original name of the tool as it is emitted by the MCP server. + }, + ], }, "name": "A String", # Identifier. The unique identifier of the toolset. Format: `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}` "openApiToolset": { # A toolset that contains a list of tools that are defined by an OpenAPI schema. # Optional. A toolset that contains a list of tools that are defined by an OpenAPI schema. @@ -1374,6 +1459,7 @@

Method Details

"inputVariableMapping": { # Optional. The mapping of the app variables names to the Dialogflow session parameters names to be sent to the Dialogflow agent as input. "a_key": "A String", }, + "languageCodeVariable": "A String", # Optional. The name of the variable that contains the language code to be used for the Dialogflow session. If unspecified, the default language code of the Dialogflow agent will be used. "outputVariableMapping": { # Optional. The mapping of the Dialogflow session parameters names to the app variables names to be sent back to the CES agent after the Dialogflow agent execution ends. "a_key": "A String", }, @@ -1520,11 +1606,11 @@

Method Details

}, "locked": True or False, # Optional. Indicates whether the app is locked for changes. If the app is locked, modifications to the app resources will be rejected. "loggingSettings": { # Settings to describe the logging behaviors for the app. # Optional. Logging settings of the app. - "audioRecordingConfig": { # Configuration for how the audio interactions should be recorded. # Optional. Configuration for how audio interactions should be recorded. + "audioRecordingConfig": { # Configuration for how the audio interactions should be recorded. # Optional. Configuration for how audio interactions should be recorded. The audio is subject to redaction as configured in RedactionConfig. "gcsBucket": "A String", # Optional. The [Cloud Storage](https://cloud.google.com/storage) bucket to store the session audio recordings. The URI must start with "gs://". Please choose a bucket location that meets your data residency requirements. Note: If the Cloud Storage bucket is in a different project from the app, you should grant `storage.objects.create` permission to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`. "gcsPathPrefix": "A String", # Optional. The Cloud Storage path prefix for audio recordings. This prefix can include the following placeholders, which will be dynamically substituted at serving time: - $project: project ID - $location: app location - $app: app ID - $date: session date in YYYY-MM-DD format - $session: session ID If the path prefix is not specified, the default prefix `$project/$location/$app/$date/$session/` will be used. }, - "bigqueryExportSettings": { # Settings to describe the BigQuery export behaviors for the app. # Optional. Settings to describe the BigQuery export behaviors for the app. The conversation data will be exported to BigQuery tables if it is enabled. + "bigqueryExportSettings": { # Settings to describe the BigQuery export behaviors for the app. # Optional. Configures the BigQuery export behaviors for the app. The conversation data is subject to redaction as configured in RedactionConfig. "dataset": "A String", # Optional. The BigQuery **dataset ID** to export the data to. "enabled": True or False, # Optional. Indicates whether the BigQuery export is enabled. "project": "A String", # Optional. The **project ID** of the BigQuery dataset to export the data to. Note: If the BigQuery dataset is in a different project from the app, you should grant `roles/bigquery.admin` role to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`. @@ -1548,7 +1634,7 @@

Method Details

"enableRedaction": True or False, # Optional. If true, redaction will be applied in various logging scenarios, including conversation history, Cloud Logging and audio recording. "inspectTemplate": "A String", # Optional. [DLP](https://cloud.google.com/dlp/docs) inspect template name to configure detection of sensitive data types. Format: `projects/{project}/locations/{location}/inspectTemplates/{inspect_template}` }, - "unredactedAudioRecordingConfig": { # Configuration for how the audio interactions should be recorded. # Optional. Configures recording of unredacted audio. Use this to maintain a raw backup with restricted access when audio redaction is enabled, typically for auditing or monitoring purposes. + "unredactedAudioRecordingConfig": { # Configuration for how the audio interactions should be recorded. # Optional. Configures an additional recording of unredacted audio. This can be used to maintain a raw audio copy when audio redaction is enabled, typically for auditing or monitoring purposes. "gcsBucket": "A String", # Optional. The [Cloud Storage](https://cloud.google.com/storage) bucket to store the session audio recordings. The URI must start with "gs://". Please choose a bucket location that meets your data residency requirements. Note: If the Cloud Storage bucket is in a different project from the app, you should grant `storage.objects.create` permission to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`. "gcsPathPrefix": "A String", # Optional. The Cloud Storage path prefix for audio recordings. This prefix can include the following placeholders, which will be dynamically substituted at serving time: - $project: project ID - $location: app location - $app: app ID - $date: session date in YYYY-MM-DD format - $session: session ID If the path prefix is not specified, the default prefix `$project/$location/$app/$date/$session/` will be used. }, @@ -2120,6 +2206,7 @@

Method Details

"uniqueItems": True or False, # Optional. Indicate the items in the array must be unique. Only applies to TYPE.ARRAY. }, "name": "A String", # Required. The name of the MCP tool. + "nameOverride": "A String", # Optional. The name override of the MCP tool. This is populated if the name was overridden by a Toolset override. "outputSchema": { # Represents a select subset of an OpenAPI 3.0 schema object. # Optional. The schema of the output arguments of the MCP tool. "additionalProperties": # Object with schema name: Schema # Optional. Can either be a boolean or an object, controls the presence of additional properties. "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. @@ -2157,6 +2244,7 @@

Method Details

"serviceDirectoryConfig": { # Configuration for tools using Service Directory. # Optional. Service Directory configuration for VPC-SC, used to resolve service names within a perimeter. "service": "A String", # Required. The name of [Service Directory](https://cloud.google.com/service-directory) service. Format: `projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}`. Location of the service directory must be the same as the location of the app. }, + "state": "A String", # Output only. The dynamic availability state of the tool on the external server. "tlsConfig": { # The TLS configuration. # Optional. The TLS configuration. Includes the custom server certificates that the client should trust. "caCerts": [ # Required. Specifies a list of allowed custom CA certificates for HTTPS verification. { # The CA certificate. @@ -2216,6 +2304,9 @@

Method Details

"description": "A String", # Output only. The description of the Python function, parsed from the python code's docstring. "name": "A String", # Optional. The name of the Python function to execute. Must match a Python function name defined in the python code. Case sensitive. If the name is not provided, the first function defined in the python code will be used. "pythonCode": "A String", # Optional. The Python code to execute for the tool. + "serviceDirectoryConfig": { # Configuration for tools using Service Directory. # Optional. Service Directory configuration for the tool. + "service": "A String", # Required. The name of [Service Directory](https://cloud.google.com/service-directory) service. Format: `projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}`. Location of the service directory must be the same as the location of the app. + }, }, "remoteAgentTool": { # Represents a tool that allows the agent to call another remote agent. # Optional. The remote agent tool. "agentCard": { # AgentCard conveys key information about a remote agent. It is a trimmed version of the AgentCard defined in the A2A protocol https://a2a-protocol.org/dev/specification/#441-agentcard # Required. The agent card of the remote agent that this tool invokes. @@ -2275,6 +2366,9 @@

Method Details

"description": "A String", # Output only. The description of the Python function, parsed from the python code's docstring. "name": "A String", # Optional. The name of the Python function to execute. Must match a Python function name defined in the python code. Case sensitive. If the name is not provided, the first function defined in the python code will be used. "pythonCode": "A String", # Optional. The Python code to execute for the tool. + "serviceDirectoryConfig": { # Configuration for tools using Service Directory. # Optional. Service Directory configuration for the tool. + "service": "A String", # Required. The name of [Service Directory](https://cloud.google.com/service-directory) service. Format: `projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}`. Location of the service directory must be the same as the location of the app. + }, }, "pythonScript": "A String", # Deprecated: Use `python_function` instead. "sourceToolName": "A String", # Optional. The resource name of the tool that provides the data for the widget (e.g., a search tool or a custom function). Format: `projects/{project}/locations/{location}/agents/{agent}/tools/{tool}` @@ -2404,6 +2498,82 @@

Method Details

}, ], }, + "toolOverrides": [ # Optional. Overrides for individual tools within this toolset. This allows overriding specific details like descriptions, names, or pinning the tools' states so they aren't fully dynamic. + { # Overrides associated with a given tool in a Toolset. This enables "pinning" or "overriding" of tool definitions from the external dynamic server. + "descriptionOverride": "A String", # Optional. If present, this tool uses this description instead of the original description from the server. + "nameOverride": "A String", # Optional. If present, this tool uses this name in the Agent instead of the original name. This is primarily used as an alias if the MCP server offers poorly named tools. + "snapshot": { # Container for a tool's core definition elements that are snapshot. Schemas in the snapshot are used as-is and cannot be overridden. # Output only. If present, this tool is "Pinned" and uses the snapshot values as fallbacks if the server becomes temporarily unavailable or if no Override is present. + "description": "A String", # Output only. The description of the MCP tool. This can be overridden by `description_override` in `McpToolOverride`. + "inputSchema": { # Represents a select subset of an OpenAPI 3.0 schema object. # Output only. The schema of the input arguments of the MCP tool. + "additionalProperties": # Object with schema name: Schema # Optional. Can either be a boolean or an object, controls the presence of additional properties. + "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. + # Object with schema name: Schema + ], + "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: Schema + }, + "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", + ], + "items": # Object with schema name: Schema # Optional. Schema of the elements of Type.ARRAY. + "maxItems": "A String", # Optional. Maximum number of the elements for Type.ARRAY. + "maximum": 3.14, # Optional. Maximum value for Type.INTEGER and Type.NUMBER. + "minItems": "A String", # Optional. Minimum number of the elements for Type.ARRAY. + "minimum": 3.14, # Optional. Minimum value for Type.INTEGER and Type.NUMBER. + "nullable": True or False, # Optional. Indicates if the value may be null. + "prefixItems": [ # Optional. Schemas of initial elements of Type.ARRAY. + # Object with schema name: Schema + ], + "properties": { # Optional. Properties of Type.OBJECT. + "a_key": # Object with schema name: Schema + }, + "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", # Required. The type of the data. + "uniqueItems": True or False, # Optional. Indicate the items in the array must be unique. Only applies to TYPE.ARRAY. + }, + "outputSchema": { # Represents a select subset of an OpenAPI 3.0 schema object. # Output only. The schema of the output arguments of the MCP tool. + "additionalProperties": # Object with schema name: Schema # Optional. Can either be a boolean or an object, controls the presence of additional properties. + "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. + # Object with schema name: Schema + ], + "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: Schema + }, + "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", + ], + "items": # Object with schema name: Schema # Optional. Schema of the elements of Type.ARRAY. + "maxItems": "A String", # Optional. Maximum number of the elements for Type.ARRAY. + "maximum": 3.14, # Optional. Maximum value for Type.INTEGER and Type.NUMBER. + "minItems": "A String", # Optional. Minimum number of the elements for Type.ARRAY. + "minimum": 3.14, # Optional. Minimum value for Type.INTEGER and Type.NUMBER. + "nullable": True or False, # Optional. Indicates if the value may be null. + "prefixItems": [ # Optional. Schemas of initial elements of Type.ARRAY. + # Object with schema name: Schema + ], + "properties": { # Optional. Properties of Type.OBJECT. + "a_key": # Object with schema name: Schema + }, + "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", # Required. The type of the data. + "uniqueItems": True or False, # Optional. Indicate the items in the array must be unique. Only applies to TYPE.ARRAY. + }, + }, + "tool": "A String", # Required. The original name of the tool as it is emitted by the MCP server. + }, + ], }, "name": "A String", # Identifier. The unique identifier of the toolset. Format: `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}` "openApiToolset": { # A toolset that contains a list of tools that are defined by an OpenAPI schema. # Optional. A toolset that contains a list of tools that are defined by an OpenAPI schema. @@ -2579,6 +2749,7 @@

Method Details

"inputVariableMapping": { # Optional. The mapping of the app variables names to the Dialogflow session parameters names to be sent to the Dialogflow agent as input. "a_key": "A String", }, + "languageCodeVariable": "A String", # Optional. The name of the variable that contains the language code to be used for the Dialogflow session. If unspecified, the default language code of the Dialogflow agent will be used. "outputVariableMapping": { # Optional. The mapping of the Dialogflow session parameters names to the app variables names to be sent back to the CES agent after the Dialogflow agent execution ends. "a_key": "A String", }, @@ -2725,11 +2896,11 @@

Method Details

}, "locked": True or False, # Optional. Indicates whether the app is locked for changes. If the app is locked, modifications to the app resources will be rejected. "loggingSettings": { # Settings to describe the logging behaviors for the app. # Optional. Logging settings of the app. - "audioRecordingConfig": { # Configuration for how the audio interactions should be recorded. # Optional. Configuration for how audio interactions should be recorded. + "audioRecordingConfig": { # Configuration for how the audio interactions should be recorded. # Optional. Configuration for how audio interactions should be recorded. The audio is subject to redaction as configured in RedactionConfig. "gcsBucket": "A String", # Optional. The [Cloud Storage](https://cloud.google.com/storage) bucket to store the session audio recordings. The URI must start with "gs://". Please choose a bucket location that meets your data residency requirements. Note: If the Cloud Storage bucket is in a different project from the app, you should grant `storage.objects.create` permission to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`. "gcsPathPrefix": "A String", # Optional. The Cloud Storage path prefix for audio recordings. This prefix can include the following placeholders, which will be dynamically substituted at serving time: - $project: project ID - $location: app location - $app: app ID - $date: session date in YYYY-MM-DD format - $session: session ID If the path prefix is not specified, the default prefix `$project/$location/$app/$date/$session/` will be used. }, - "bigqueryExportSettings": { # Settings to describe the BigQuery export behaviors for the app. # Optional. Settings to describe the BigQuery export behaviors for the app. The conversation data will be exported to BigQuery tables if it is enabled. + "bigqueryExportSettings": { # Settings to describe the BigQuery export behaviors for the app. # Optional. Configures the BigQuery export behaviors for the app. The conversation data is subject to redaction as configured in RedactionConfig. "dataset": "A String", # Optional. The BigQuery **dataset ID** to export the data to. "enabled": True or False, # Optional. Indicates whether the BigQuery export is enabled. "project": "A String", # Optional. The **project ID** of the BigQuery dataset to export the data to. Note: If the BigQuery dataset is in a different project from the app, you should grant `roles/bigquery.admin` role to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`. @@ -2753,7 +2924,7 @@

Method Details

"enableRedaction": True or False, # Optional. If true, redaction will be applied in various logging scenarios, including conversation history, Cloud Logging and audio recording. "inspectTemplate": "A String", # Optional. [DLP](https://cloud.google.com/dlp/docs) inspect template name to configure detection of sensitive data types. Format: `projects/{project}/locations/{location}/inspectTemplates/{inspect_template}` }, - "unredactedAudioRecordingConfig": { # Configuration for how the audio interactions should be recorded. # Optional. Configures recording of unredacted audio. Use this to maintain a raw backup with restricted access when audio redaction is enabled, typically for auditing or monitoring purposes. + "unredactedAudioRecordingConfig": { # Configuration for how the audio interactions should be recorded. # Optional. Configures an additional recording of unredacted audio. This can be used to maintain a raw audio copy when audio redaction is enabled, typically for auditing or monitoring purposes. "gcsBucket": "A String", # Optional. The [Cloud Storage](https://cloud.google.com/storage) bucket to store the session audio recordings. The URI must start with "gs://". Please choose a bucket location that meets your data residency requirements. Note: If the Cloud Storage bucket is in a different project from the app, you should grant `storage.objects.create` permission to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`. "gcsPathPrefix": "A String", # Optional. The Cloud Storage path prefix for audio recordings. This prefix can include the following placeholders, which will be dynamically substituted at serving time: - $project: project ID - $location: app location - $app: app ID - $date: session date in YYYY-MM-DD format - $session: session ID If the path prefix is not specified, the default prefix `$project/$location/$app/$date/$session/` will be used. }, @@ -3325,6 +3496,7 @@

Method Details

"uniqueItems": True or False, # Optional. Indicate the items in the array must be unique. Only applies to TYPE.ARRAY. }, "name": "A String", # Required. The name of the MCP tool. + "nameOverride": "A String", # Optional. The name override of the MCP tool. This is populated if the name was overridden by a Toolset override. "outputSchema": { # Represents a select subset of an OpenAPI 3.0 schema object. # Optional. The schema of the output arguments of the MCP tool. "additionalProperties": # Object with schema name: Schema # Optional. Can either be a boolean or an object, controls the presence of additional properties. "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. @@ -3362,6 +3534,7 @@

Method Details

"serviceDirectoryConfig": { # Configuration for tools using Service Directory. # Optional. Service Directory configuration for VPC-SC, used to resolve service names within a perimeter. "service": "A String", # Required. The name of [Service Directory](https://cloud.google.com/service-directory) service. Format: `projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}`. Location of the service directory must be the same as the location of the app. }, + "state": "A String", # Output only. The dynamic availability state of the tool on the external server. "tlsConfig": { # The TLS configuration. # Optional. The TLS configuration. Includes the custom server certificates that the client should trust. "caCerts": [ # Required. Specifies a list of allowed custom CA certificates for HTTPS verification. { # The CA certificate. @@ -3421,6 +3594,9 @@

Method Details

"description": "A String", # Output only. The description of the Python function, parsed from the python code's docstring. "name": "A String", # Optional. The name of the Python function to execute. Must match a Python function name defined in the python code. Case sensitive. If the name is not provided, the first function defined in the python code will be used. "pythonCode": "A String", # Optional. The Python code to execute for the tool. + "serviceDirectoryConfig": { # Configuration for tools using Service Directory. # Optional. Service Directory configuration for the tool. + "service": "A String", # Required. The name of [Service Directory](https://cloud.google.com/service-directory) service. Format: `projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}`. Location of the service directory must be the same as the location of the app. + }, }, "remoteAgentTool": { # Represents a tool that allows the agent to call another remote agent. # Optional. The remote agent tool. "agentCard": { # AgentCard conveys key information about a remote agent. It is a trimmed version of the AgentCard defined in the A2A protocol https://a2a-protocol.org/dev/specification/#441-agentcard # Required. The agent card of the remote agent that this tool invokes. @@ -3480,6 +3656,9 @@

Method Details

"description": "A String", # Output only. The description of the Python function, parsed from the python code's docstring. "name": "A String", # Optional. The name of the Python function to execute. Must match a Python function name defined in the python code. Case sensitive. If the name is not provided, the first function defined in the python code will be used. "pythonCode": "A String", # Optional. The Python code to execute for the tool. + "serviceDirectoryConfig": { # Configuration for tools using Service Directory. # Optional. Service Directory configuration for the tool. + "service": "A String", # Required. The name of [Service Directory](https://cloud.google.com/service-directory) service. Format: `projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}`. Location of the service directory must be the same as the location of the app. + }, }, "pythonScript": "A String", # Deprecated: Use `python_function` instead. "sourceToolName": "A String", # Optional. The resource name of the tool that provides the data for the widget (e.g., a search tool or a custom function). Format: `projects/{project}/locations/{location}/agents/{agent}/tools/{tool}` @@ -3609,6 +3788,82 @@

Method Details

}, ], }, + "toolOverrides": [ # Optional. Overrides for individual tools within this toolset. This allows overriding specific details like descriptions, names, or pinning the tools' states so they aren't fully dynamic. + { # Overrides associated with a given tool in a Toolset. This enables "pinning" or "overriding" of tool definitions from the external dynamic server. + "descriptionOverride": "A String", # Optional. If present, this tool uses this description instead of the original description from the server. + "nameOverride": "A String", # Optional. If present, this tool uses this name in the Agent instead of the original name. This is primarily used as an alias if the MCP server offers poorly named tools. + "snapshot": { # Container for a tool's core definition elements that are snapshot. Schemas in the snapshot are used as-is and cannot be overridden. # Output only. If present, this tool is "Pinned" and uses the snapshot values as fallbacks if the server becomes temporarily unavailable or if no Override is present. + "description": "A String", # Output only. The description of the MCP tool. This can be overridden by `description_override` in `McpToolOverride`. + "inputSchema": { # Represents a select subset of an OpenAPI 3.0 schema object. # Output only. The schema of the input arguments of the MCP tool. + "additionalProperties": # Object with schema name: Schema # Optional. Can either be a boolean or an object, controls the presence of additional properties. + "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. + # Object with schema name: Schema + ], + "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: Schema + }, + "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", + ], + "items": # Object with schema name: Schema # Optional. Schema of the elements of Type.ARRAY. + "maxItems": "A String", # Optional. Maximum number of the elements for Type.ARRAY. + "maximum": 3.14, # Optional. Maximum value for Type.INTEGER and Type.NUMBER. + "minItems": "A String", # Optional. Minimum number of the elements for Type.ARRAY. + "minimum": 3.14, # Optional. Minimum value for Type.INTEGER and Type.NUMBER. + "nullable": True or False, # Optional. Indicates if the value may be null. + "prefixItems": [ # Optional. Schemas of initial elements of Type.ARRAY. + # Object with schema name: Schema + ], + "properties": { # Optional. Properties of Type.OBJECT. + "a_key": # Object with schema name: Schema + }, + "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", # Required. The type of the data. + "uniqueItems": True or False, # Optional. Indicate the items in the array must be unique. Only applies to TYPE.ARRAY. + }, + "outputSchema": { # Represents a select subset of an OpenAPI 3.0 schema object. # Output only. The schema of the output arguments of the MCP tool. + "additionalProperties": # Object with schema name: Schema # Optional. Can either be a boolean or an object, controls the presence of additional properties. + "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. + # Object with schema name: Schema + ], + "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: Schema + }, + "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", + ], + "items": # Object with schema name: Schema # Optional. Schema of the elements of Type.ARRAY. + "maxItems": "A String", # Optional. Maximum number of the elements for Type.ARRAY. + "maximum": 3.14, # Optional. Maximum value for Type.INTEGER and Type.NUMBER. + "minItems": "A String", # Optional. Minimum number of the elements for Type.ARRAY. + "minimum": 3.14, # Optional. Minimum value for Type.INTEGER and Type.NUMBER. + "nullable": True or False, # Optional. Indicates if the value may be null. + "prefixItems": [ # Optional. Schemas of initial elements of Type.ARRAY. + # Object with schema name: Schema + ], + "properties": { # Optional. Properties of Type.OBJECT. + "a_key": # Object with schema name: Schema + }, + "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", # Required. The type of the data. + "uniqueItems": True or False, # Optional. Indicate the items in the array must be unique. Only applies to TYPE.ARRAY. + }, + }, + "tool": "A String", # Required. The original name of the tool as it is emitted by the MCP server. + }, + ], }, "name": "A String", # Identifier. The unique identifier of the toolset. Format: `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}` "openApiToolset": { # A toolset that contains a list of tools that are defined by an OpenAPI schema. # Optional. A toolset that contains a list of tools that are defined by an OpenAPI schema. @@ -3771,6 +4026,7 @@

Method Details

"inputVariableMapping": { # Optional. The mapping of the app variables names to the Dialogflow session parameters names to be sent to the Dialogflow agent as input. "a_key": "A String", }, + "languageCodeVariable": "A String", # Optional. The name of the variable that contains the language code to be used for the Dialogflow session. If unspecified, the default language code of the Dialogflow agent will be used. "outputVariableMapping": { # Optional. The mapping of the Dialogflow session parameters names to the app variables names to be sent back to the CES agent after the Dialogflow agent execution ends. "a_key": "A String", }, @@ -3917,11 +4173,11 @@

Method Details

}, "locked": True or False, # Optional. Indicates whether the app is locked for changes. If the app is locked, modifications to the app resources will be rejected. "loggingSettings": { # Settings to describe the logging behaviors for the app. # Optional. Logging settings of the app. - "audioRecordingConfig": { # Configuration for how the audio interactions should be recorded. # Optional. Configuration for how audio interactions should be recorded. + "audioRecordingConfig": { # Configuration for how the audio interactions should be recorded. # Optional. Configuration for how audio interactions should be recorded. The audio is subject to redaction as configured in RedactionConfig. "gcsBucket": "A String", # Optional. The [Cloud Storage](https://cloud.google.com/storage) bucket to store the session audio recordings. The URI must start with "gs://". Please choose a bucket location that meets your data residency requirements. Note: If the Cloud Storage bucket is in a different project from the app, you should grant `storage.objects.create` permission to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`. "gcsPathPrefix": "A String", # Optional. The Cloud Storage path prefix for audio recordings. This prefix can include the following placeholders, which will be dynamically substituted at serving time: - $project: project ID - $location: app location - $app: app ID - $date: session date in YYYY-MM-DD format - $session: session ID If the path prefix is not specified, the default prefix `$project/$location/$app/$date/$session/` will be used. }, - "bigqueryExportSettings": { # Settings to describe the BigQuery export behaviors for the app. # Optional. Settings to describe the BigQuery export behaviors for the app. The conversation data will be exported to BigQuery tables if it is enabled. + "bigqueryExportSettings": { # Settings to describe the BigQuery export behaviors for the app. # Optional. Configures the BigQuery export behaviors for the app. The conversation data is subject to redaction as configured in RedactionConfig. "dataset": "A String", # Optional. The BigQuery **dataset ID** to export the data to. "enabled": True or False, # Optional. Indicates whether the BigQuery export is enabled. "project": "A String", # Optional. The **project ID** of the BigQuery dataset to export the data to. Note: If the BigQuery dataset is in a different project from the app, you should grant `roles/bigquery.admin` role to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`. @@ -3945,7 +4201,7 @@

Method Details

"enableRedaction": True or False, # Optional. If true, redaction will be applied in various logging scenarios, including conversation history, Cloud Logging and audio recording. "inspectTemplate": "A String", # Optional. [DLP](https://cloud.google.com/dlp/docs) inspect template name to configure detection of sensitive data types. Format: `projects/{project}/locations/{location}/inspectTemplates/{inspect_template}` }, - "unredactedAudioRecordingConfig": { # Configuration for how the audio interactions should be recorded. # Optional. Configures recording of unredacted audio. Use this to maintain a raw backup with restricted access when audio redaction is enabled, typically for auditing or monitoring purposes. + "unredactedAudioRecordingConfig": { # Configuration for how the audio interactions should be recorded. # Optional. Configures an additional recording of unredacted audio. This can be used to maintain a raw audio copy when audio redaction is enabled, typically for auditing or monitoring purposes. "gcsBucket": "A String", # Optional. The [Cloud Storage](https://cloud.google.com/storage) bucket to store the session audio recordings. The URI must start with "gs://". Please choose a bucket location that meets your data residency requirements. Note: If the Cloud Storage bucket is in a different project from the app, you should grant `storage.objects.create` permission to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`. "gcsPathPrefix": "A String", # Optional. The Cloud Storage path prefix for audio recordings. This prefix can include the following placeholders, which will be dynamically substituted at serving time: - $project: project ID - $location: app location - $app: app ID - $date: session date in YYYY-MM-DD format - $session: session ID If the path prefix is not specified, the default prefix `$project/$location/$app/$date/$session/` will be used. }, @@ -4517,6 +4773,7 @@

Method Details

"uniqueItems": True or False, # Optional. Indicate the items in the array must be unique. Only applies to TYPE.ARRAY. }, "name": "A String", # Required. The name of the MCP tool. + "nameOverride": "A String", # Optional. The name override of the MCP tool. This is populated if the name was overridden by a Toolset override. "outputSchema": { # Represents a select subset of an OpenAPI 3.0 schema object. # Optional. The schema of the output arguments of the MCP tool. "additionalProperties": # Object with schema name: Schema # Optional. Can either be a boolean or an object, controls the presence of additional properties. "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. @@ -4554,6 +4811,7 @@

Method Details

"serviceDirectoryConfig": { # Configuration for tools using Service Directory. # Optional. Service Directory configuration for VPC-SC, used to resolve service names within a perimeter. "service": "A String", # Required. The name of [Service Directory](https://cloud.google.com/service-directory) service. Format: `projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}`. Location of the service directory must be the same as the location of the app. }, + "state": "A String", # Output only. The dynamic availability state of the tool on the external server. "tlsConfig": { # The TLS configuration. # Optional. The TLS configuration. Includes the custom server certificates that the client should trust. "caCerts": [ # Required. Specifies a list of allowed custom CA certificates for HTTPS verification. { # The CA certificate. @@ -4613,6 +4871,9 @@

Method Details

"description": "A String", # Output only. The description of the Python function, parsed from the python code's docstring. "name": "A String", # Optional. The name of the Python function to execute. Must match a Python function name defined in the python code. Case sensitive. If the name is not provided, the first function defined in the python code will be used. "pythonCode": "A String", # Optional. The Python code to execute for the tool. + "serviceDirectoryConfig": { # Configuration for tools using Service Directory. # Optional. Service Directory configuration for the tool. + "service": "A String", # Required. The name of [Service Directory](https://cloud.google.com/service-directory) service. Format: `projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}`. Location of the service directory must be the same as the location of the app. + }, }, "remoteAgentTool": { # Represents a tool that allows the agent to call another remote agent. # Optional. The remote agent tool. "agentCard": { # AgentCard conveys key information about a remote agent. It is a trimmed version of the AgentCard defined in the A2A protocol https://a2a-protocol.org/dev/specification/#441-agentcard # Required. The agent card of the remote agent that this tool invokes. @@ -4672,6 +4933,9 @@

Method Details

"description": "A String", # Output only. The description of the Python function, parsed from the python code's docstring. "name": "A String", # Optional. The name of the Python function to execute. Must match a Python function name defined in the python code. Case sensitive. If the name is not provided, the first function defined in the python code will be used. "pythonCode": "A String", # Optional. The Python code to execute for the tool. + "serviceDirectoryConfig": { # Configuration for tools using Service Directory. # Optional. Service Directory configuration for the tool. + "service": "A String", # Required. The name of [Service Directory](https://cloud.google.com/service-directory) service. Format: `projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}`. Location of the service directory must be the same as the location of the app. + }, }, "pythonScript": "A String", # Deprecated: Use `python_function` instead. "sourceToolName": "A String", # Optional. The resource name of the tool that provides the data for the widget (e.g., a search tool or a custom function). Format: `projects/{project}/locations/{location}/agents/{agent}/tools/{tool}` @@ -4801,6 +5065,82 @@

Method Details

}, ], }, + "toolOverrides": [ # Optional. Overrides for individual tools within this toolset. This allows overriding specific details like descriptions, names, or pinning the tools' states so they aren't fully dynamic. + { # Overrides associated with a given tool in a Toolset. This enables "pinning" or "overriding" of tool definitions from the external dynamic server. + "descriptionOverride": "A String", # Optional. If present, this tool uses this description instead of the original description from the server. + "nameOverride": "A String", # Optional. If present, this tool uses this name in the Agent instead of the original name. This is primarily used as an alias if the MCP server offers poorly named tools. + "snapshot": { # Container for a tool's core definition elements that are snapshot. Schemas in the snapshot are used as-is and cannot be overridden. # Output only. If present, this tool is "Pinned" and uses the snapshot values as fallbacks if the server becomes temporarily unavailable or if no Override is present. + "description": "A String", # Output only. The description of the MCP tool. This can be overridden by `description_override` in `McpToolOverride`. + "inputSchema": { # Represents a select subset of an OpenAPI 3.0 schema object. # Output only. The schema of the input arguments of the MCP tool. + "additionalProperties": # Object with schema name: Schema # Optional. Can either be a boolean or an object, controls the presence of additional properties. + "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. + # Object with schema name: Schema + ], + "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: Schema + }, + "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", + ], + "items": # Object with schema name: Schema # Optional. Schema of the elements of Type.ARRAY. + "maxItems": "A String", # Optional. Maximum number of the elements for Type.ARRAY. + "maximum": 3.14, # Optional. Maximum value for Type.INTEGER and Type.NUMBER. + "minItems": "A String", # Optional. Minimum number of the elements for Type.ARRAY. + "minimum": 3.14, # Optional. Minimum value for Type.INTEGER and Type.NUMBER. + "nullable": True or False, # Optional. Indicates if the value may be null. + "prefixItems": [ # Optional. Schemas of initial elements of Type.ARRAY. + # Object with schema name: Schema + ], + "properties": { # Optional. Properties of Type.OBJECT. + "a_key": # Object with schema name: Schema + }, + "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", # Required. The type of the data. + "uniqueItems": True or False, # Optional. Indicate the items in the array must be unique. Only applies to TYPE.ARRAY. + }, + "outputSchema": { # Represents a select subset of an OpenAPI 3.0 schema object. # Output only. The schema of the output arguments of the MCP tool. + "additionalProperties": # Object with schema name: Schema # Optional. Can either be a boolean or an object, controls the presence of additional properties. + "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. + # Object with schema name: Schema + ], + "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: Schema + }, + "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", + ], + "items": # Object with schema name: Schema # Optional. Schema of the elements of Type.ARRAY. + "maxItems": "A String", # Optional. Maximum number of the elements for Type.ARRAY. + "maximum": 3.14, # Optional. Maximum value for Type.INTEGER and Type.NUMBER. + "minItems": "A String", # Optional. Minimum number of the elements for Type.ARRAY. + "minimum": 3.14, # Optional. Minimum value for Type.INTEGER and Type.NUMBER. + "nullable": True or False, # Optional. Indicates if the value may be null. + "prefixItems": [ # Optional. Schemas of initial elements of Type.ARRAY. + # Object with schema name: Schema + ], + "properties": { # Optional. Properties of Type.OBJECT. + "a_key": # Object with schema name: Schema + }, + "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", # Required. The type of the data. + "uniqueItems": True or False, # Optional. Indicate the items in the array must be unique. Only applies to TYPE.ARRAY. + }, + }, + "tool": "A String", # Required. The original name of the tool as it is emitted by the MCP server. + }, + ], }, "name": "A String", # Identifier. The unique identifier of the toolset. Format: `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}` "openApiToolset": { # A toolset that contains a list of tools that are defined by an OpenAPI schema. # Optional. A toolset that contains a list of tools that are defined by an OpenAPI schema. diff --git a/docs/dyn/ces_v1beta.projects.locations.apps.agents.html b/docs/dyn/ces_v1beta.projects.locations.apps.agents.html index 7423a7d144..204ef8a141 100644 --- a/docs/dyn/ces_v1beta.projects.locations.apps.agents.html +++ b/docs/dyn/ces_v1beta.projects.locations.apps.agents.html @@ -185,6 +185,7 @@

Method Details

"inputVariableMapping": { # Optional. The mapping of the app variables names to the Dialogflow session parameters names to be sent to the Dialogflow agent as input. "a_key": "A String", }, + "languageCodeVariable": "A String", # Optional. The name of the variable that contains the language code to be used for the Dialogflow session. If unspecified, the default language code of the Dialogflow agent will be used. "outputVariableMapping": { # Optional. The mapping of the Dialogflow session parameters names to the app variables names to be sent back to the CES agent after the Dialogflow agent execution ends. "a_key": "A String", }, @@ -310,6 +311,7 @@

Method Details

"inputVariableMapping": { # Optional. The mapping of the app variables names to the Dialogflow session parameters names to be sent to the Dialogflow agent as input. "a_key": "A String", }, + "languageCodeVariable": "A String", # Optional. The name of the variable that contains the language code to be used for the Dialogflow session. If unspecified, the default language code of the Dialogflow agent will be used. "outputVariableMapping": { # Optional. The mapping of the Dialogflow session parameters names to the app variables names to be sent back to the CES agent after the Dialogflow agent execution ends. "a_key": "A String", }, @@ -461,6 +463,7 @@

Method Details

"inputVariableMapping": { # Optional. The mapping of the app variables names to the Dialogflow session parameters names to be sent to the Dialogflow agent as input. "a_key": "A String", }, + "languageCodeVariable": "A String", # Optional. The name of the variable that contains the language code to be used for the Dialogflow session. If unspecified, the default language code of the Dialogflow agent will be used. "outputVariableMapping": { # Optional. The mapping of the Dialogflow session parameters names to the app variables names to be sent back to the CES agent after the Dialogflow agent execution ends. "a_key": "A String", }, @@ -598,6 +601,7 @@

Method Details

"inputVariableMapping": { # Optional. The mapping of the app variables names to the Dialogflow session parameters names to be sent to the Dialogflow agent as input. "a_key": "A String", }, + "languageCodeVariable": "A String", # Optional. The name of the variable that contains the language code to be used for the Dialogflow session. If unspecified, the default language code of the Dialogflow agent will be used. "outputVariableMapping": { # Optional. The mapping of the Dialogflow session parameters names to the app variables names to be sent back to the CES agent after the Dialogflow agent execution ends. "a_key": "A String", }, @@ -741,6 +745,7 @@

Method Details

"inputVariableMapping": { # Optional. The mapping of the app variables names to the Dialogflow session parameters names to be sent to the Dialogflow agent as input. "a_key": "A String", }, + "languageCodeVariable": "A String", # Optional. The name of the variable that contains the language code to be used for the Dialogflow session. If unspecified, the default language code of the Dialogflow agent will be used. "outputVariableMapping": { # Optional. The mapping of the Dialogflow session parameters names to the app variables names to be sent back to the CES agent after the Dialogflow agent execution ends. "a_key": "A String", }, @@ -866,6 +871,7 @@

Method Details

"inputVariableMapping": { # Optional. The mapping of the app variables names to the Dialogflow session parameters names to be sent to the Dialogflow agent as input. "a_key": "A String", }, + "languageCodeVariable": "A String", # Optional. The name of the variable that contains the language code to be used for the Dialogflow session. If unspecified, the default language code of the Dialogflow agent will be used. "outputVariableMapping": { # Optional. The mapping of the Dialogflow session parameters names to the app variables names to be sent back to the CES agent after the Dialogflow agent execution ends. "a_key": "A String", }, diff --git a/docs/dyn/ces_v1beta.projects.locations.apps.evaluationRuns.html b/docs/dyn/ces_v1beta.projects.locations.apps.evaluationRuns.html index 57b352d4dc..98d9e46d85 100644 --- a/docs/dyn/ces_v1beta.projects.locations.apps.evaluationRuns.html +++ b/docs/dyn/ces_v1beta.projects.locations.apps.evaluationRuns.html @@ -228,6 +228,7 @@

Method Details

"errorMessage": "A String", # Output only. The error message. "errorType": "A String", # Output only. The type of error. "sessionId": "A String", # Output only. The session ID for the conversation that caused the error. + "userFacingErrorMessage": "A String", # Output only. The user facing error message. }, "evaluationDataset": "A String", # Output only. The evaluation dataset that this run is associated with. This field is mutually exclusive with `evaluations`. Format: `projects/{project}/locations/{location}/apps/{app}/evaluationDatasets/{evaluationDataset}` "evaluationResults": [ # Output only. The evaluation results that are part of this run. Format: `projects/{project}/locations/{location}/apps/{app}/evaluations/{evaluation}/results/{result}` @@ -300,6 +301,7 @@

Method Details

], }, "name": "A String", # Identifier. The unique identifier of the evaluation run. Format: `projects/{project}/locations/{location}/apps/{app}/evaluationRuns/{evaluationRun}` + "operation": "A String", # Output only. The operation that created this evaluation run. Format: `projects/{project}/locations/{location}/operations/{operation}` "optimizationConfig": { # Configuration for running the optimization step after the evaluation run. # Optional. Configuration for running the optimization step after the evaluation run. If not set, the optimization step will not be run. "assistantSession": "A String", # Output only. The assistant session to use for the optimization based on this evaluation run. Format: `projects/{project}/locations/{location}/apps/{app}/assistantSessions/{assistantSession}` "errorMessage": "A String", # Output only. The error message if the optimization run failed. @@ -383,6 +385,7 @@

Method Details

"errorMessage": "A String", # Output only. The error message. "errorType": "A String", # Output only. The type of error. "sessionId": "A String", # Output only. The session ID for the conversation that caused the error. + "userFacingErrorMessage": "A String", # Output only. The user facing error message. }, "evaluationDataset": "A String", # Output only. The evaluation dataset that this run is associated with. This field is mutually exclusive with `evaluations`. Format: `projects/{project}/locations/{location}/apps/{app}/evaluationDatasets/{evaluationDataset}` "evaluationResults": [ # Output only. The evaluation results that are part of this run. Format: `projects/{project}/locations/{location}/apps/{app}/evaluations/{evaluation}/results/{result}` @@ -455,6 +458,7 @@

Method Details

], }, "name": "A String", # Identifier. The unique identifier of the evaluation run. Format: `projects/{project}/locations/{location}/apps/{app}/evaluationRuns/{evaluationRun}` + "operation": "A String", # Output only. The operation that created this evaluation run. Format: `projects/{project}/locations/{location}/operations/{operation}` "optimizationConfig": { # Configuration for running the optimization step after the evaluation run. # Optional. Configuration for running the optimization step after the evaluation run. If not set, the optimization step will not be run. "assistantSession": "A String", # Output only. The assistant session to use for the optimization based on this evaluation run. Format: `projects/{project}/locations/{location}/apps/{app}/assistantSessions/{assistantSession}` "errorMessage": "A String", # Output only. The error message if the optimization run failed. diff --git a/docs/dyn/ces_v1beta.projects.locations.apps.evaluations.html b/docs/dyn/ces_v1beta.projects.locations.apps.evaluations.html index b6bca7bc5f..60549d12de 100644 --- a/docs/dyn/ces_v1beta.projects.locations.apps.evaluations.html +++ b/docs/dyn/ces_v1beta.projects.locations.apps.evaluations.html @@ -458,6 +458,7 @@

Method Details

"errorMessage": "A String", # Output only. The error message. "errorType": "A String", # Output only. The type of error. "sessionId": "A String", # Output only. The session ID for the conversation that caused the error. + "userFacingErrorMessage": "A String", # Output only. The user facing error message. }, "evaluationMetricsThresholds": { # Threshold settings for metrics in an Evaluation. # Output only. The evaluation thresholds for the result. "goldenEvaluationMetricsThresholds": { # Settings for golden evaluations. # Optional. The golden evaluation metrics thresholds. @@ -496,6 +497,7 @@

Method Details

"errorMessage": "A String", # Output only. The error message. "errorType": "A String", # Output only. The type of error. "sessionId": "A String", # Output only. The session ID for the conversation that caused the error. + "userFacingErrorMessage": "A String", # Output only. The user facing error message. }, "expectationOutcome": [ # Output only. The outcome of each expectation. { # Specifies the expectation and the result of that expectation. @@ -1043,6 +1045,7 @@

Method Details

"errorMessage": "A String", # Output only. The error message. "errorType": "A String", # Output only. The type of error. "sessionId": "A String", # Output only. The session ID for the conversation that caused the error. + "userFacingErrorMessage": "A String", # Output only. The user facing error message. }, "evaluationMetricsThresholds": { # Threshold settings for metrics in an Evaluation. # Output only. The evaluation thresholds for the result. "goldenEvaluationMetricsThresholds": { # Settings for golden evaluations. # Optional. The golden evaluation metrics thresholds. @@ -1081,6 +1084,7 @@

Method Details

"errorMessage": "A String", # Output only. The error message. "errorType": "A String", # Output only. The type of error. "sessionId": "A String", # Output only. The session ID for the conversation that caused the error. + "userFacingErrorMessage": "A String", # Output only. The user facing error message. }, "expectationOutcome": [ # Output only. The outcome of each expectation. { # Specifies the expectation and the result of that expectation. @@ -2055,6 +2059,7 @@

Method Details

"errorMessage": "A String", # Output only. The error message. "errorType": "A String", # Output only. The type of error. "sessionId": "A String", # Output only. The session ID for the conversation that caused the error. + "userFacingErrorMessage": "A String", # Output only. The user facing error message. }, "evaluationMetricsThresholds": { # Threshold settings for metrics in an Evaluation. # Output only. The evaluation thresholds for the result. "goldenEvaluationMetricsThresholds": { # Settings for golden evaluations. # Optional. The golden evaluation metrics thresholds. @@ -2093,6 +2098,7 @@

Method Details

"errorMessage": "A String", # Output only. The error message. "errorType": "A String", # Output only. The type of error. "sessionId": "A String", # Output only. The session ID for the conversation that caused the error. + "userFacingErrorMessage": "A String", # Output only. The user facing error message. }, "expectationOutcome": [ # Output only. The outcome of each expectation. { # Specifies the expectation and the result of that expectation. @@ -2640,6 +2646,7 @@

Method Details

"errorMessage": "A String", # Output only. The error message. "errorType": "A String", # Output only. The type of error. "sessionId": "A String", # Output only. The session ID for the conversation that caused the error. + "userFacingErrorMessage": "A String", # Output only. The user facing error message. }, "evaluationMetricsThresholds": { # Threshold settings for metrics in an Evaluation. # Output only. The evaluation thresholds for the result. "goldenEvaluationMetricsThresholds": { # Settings for golden evaluations. # Optional. The golden evaluation metrics thresholds. @@ -2678,6 +2685,7 @@

Method Details

"errorMessage": "A String", # Output only. The error message. "errorType": "A String", # Output only. The type of error. "sessionId": "A String", # Output only. The session ID for the conversation that caused the error. + "userFacingErrorMessage": "A String", # Output only. The user facing error message. }, "expectationOutcome": [ # Output only. The outcome of each expectation. { # Specifies the expectation and the result of that expectation. @@ -3728,6 +3736,7 @@

Method Details

"errorMessage": "A String", # Output only. The error message. "errorType": "A String", # Output only. The type of error. "sessionId": "A String", # Output only. The session ID for the conversation that caused the error. + "userFacingErrorMessage": "A String", # Output only. The user facing error message. }, "evaluationMetricsThresholds": { # Threshold settings for metrics in an Evaluation. # Output only. The evaluation thresholds for the result. "goldenEvaluationMetricsThresholds": { # Settings for golden evaluations. # Optional. The golden evaluation metrics thresholds. @@ -3766,6 +3775,7 @@

Method Details

"errorMessage": "A String", # Output only. The error message. "errorType": "A String", # Output only. The type of error. "sessionId": "A String", # Output only. The session ID for the conversation that caused the error. + "userFacingErrorMessage": "A String", # Output only. The user facing error message. }, "expectationOutcome": [ # Output only. The outcome of each expectation. { # Specifies the expectation and the result of that expectation. @@ -4313,6 +4323,7 @@

Method Details

"errorMessage": "A String", # Output only. The error message. "errorType": "A String", # Output only. The type of error. "sessionId": "A String", # Output only. The session ID for the conversation that caused the error. + "userFacingErrorMessage": "A String", # Output only. The user facing error message. }, "evaluationMetricsThresholds": { # Threshold settings for metrics in an Evaluation. # Output only. The evaluation thresholds for the result. "goldenEvaluationMetricsThresholds": { # Settings for golden evaluations. # Optional. The golden evaluation metrics thresholds. @@ -4351,6 +4362,7 @@

Method Details

"errorMessage": "A String", # Output only. The error message. "errorType": "A String", # Output only. The type of error. "sessionId": "A String", # Output only. The session ID for the conversation that caused the error. + "userFacingErrorMessage": "A String", # Output only. The user facing error message. }, "expectationOutcome": [ # Output only. The outcome of each expectation. { # Specifies the expectation and the result of that expectation. @@ -5340,6 +5352,7 @@

Method Details

"errorMessage": "A String", # Output only. The error message. "errorType": "A String", # Output only. The type of error. "sessionId": "A String", # Output only. The session ID for the conversation that caused the error. + "userFacingErrorMessage": "A String", # Output only. The user facing error message. }, "evaluationMetricsThresholds": { # Threshold settings for metrics in an Evaluation. # Output only. The evaluation thresholds for the result. "goldenEvaluationMetricsThresholds": { # Settings for golden evaluations. # Optional. The golden evaluation metrics thresholds. @@ -5378,6 +5391,7 @@

Method Details

"errorMessage": "A String", # Output only. The error message. "errorType": "A String", # Output only. The type of error. "sessionId": "A String", # Output only. The session ID for the conversation that caused the error. + "userFacingErrorMessage": "A String", # Output only. The user facing error message. }, "expectationOutcome": [ # Output only. The outcome of each expectation. { # Specifies the expectation and the result of that expectation. @@ -5925,6 +5939,7 @@

Method Details

"errorMessage": "A String", # Output only. The error message. "errorType": "A String", # Output only. The type of error. "sessionId": "A String", # Output only. The session ID for the conversation that caused the error. + "userFacingErrorMessage": "A String", # Output only. The user facing error message. }, "evaluationMetricsThresholds": { # Threshold settings for metrics in an Evaluation. # Output only. The evaluation thresholds for the result. "goldenEvaluationMetricsThresholds": { # Settings for golden evaluations. # Optional. The golden evaluation metrics thresholds. @@ -5963,6 +5978,7 @@

Method Details

"errorMessage": "A String", # Output only. The error message. "errorType": "A String", # Output only. The type of error. "sessionId": "A String", # Output only. The session ID for the conversation that caused the error. + "userFacingErrorMessage": "A String", # Output only. The user facing error message. }, "expectationOutcome": [ # Output only. The outcome of each expectation. { # Specifies the expectation and the result of that expectation. @@ -6955,6 +6971,7 @@

Method Details

"errorMessage": "A String", # Output only. The error message. "errorType": "A String", # Output only. The type of error. "sessionId": "A String", # Output only. The session ID for the conversation that caused the error. + "userFacingErrorMessage": "A String", # Output only. The user facing error message. }, "evaluationMetricsThresholds": { # Threshold settings for metrics in an Evaluation. # Output only. The evaluation thresholds for the result. "goldenEvaluationMetricsThresholds": { # Settings for golden evaluations. # Optional. The golden evaluation metrics thresholds. @@ -6993,6 +7010,7 @@

Method Details

"errorMessage": "A String", # Output only. The error message. "errorType": "A String", # Output only. The type of error. "sessionId": "A String", # Output only. The session ID for the conversation that caused the error. + "userFacingErrorMessage": "A String", # Output only. The user facing error message. }, "expectationOutcome": [ # Output only. The outcome of each expectation. { # Specifies the expectation and the result of that expectation. @@ -7540,6 +7558,7 @@

Method Details

"errorMessage": "A String", # Output only. The error message. "errorType": "A String", # Output only. The type of error. "sessionId": "A String", # Output only. The session ID for the conversation that caused the error. + "userFacingErrorMessage": "A String", # Output only. The user facing error message. }, "evaluationMetricsThresholds": { # Threshold settings for metrics in an Evaluation. # Output only. The evaluation thresholds for the result. "goldenEvaluationMetricsThresholds": { # Settings for golden evaluations. # Optional. The golden evaluation metrics thresholds. @@ -7578,6 +7597,7 @@

Method Details

"errorMessage": "A String", # Output only. The error message. "errorType": "A String", # Output only. The type of error. "sessionId": "A String", # Output only. The session ID for the conversation that caused the error. + "userFacingErrorMessage": "A String", # Output only. The user facing error message. }, "expectationOutcome": [ # Output only. The outcome of each expectation. { # Specifies the expectation and the result of that expectation. @@ -8552,6 +8572,7 @@

Method Details

"errorMessage": "A String", # Output only. The error message. "errorType": "A String", # Output only. The type of error. "sessionId": "A String", # Output only. The session ID for the conversation that caused the error. + "userFacingErrorMessage": "A String", # Output only. The user facing error message. }, "evaluationMetricsThresholds": { # Threshold settings for metrics in an Evaluation. # Output only. The evaluation thresholds for the result. "goldenEvaluationMetricsThresholds": { # Settings for golden evaluations. # Optional. The golden evaluation metrics thresholds. @@ -8590,6 +8611,7 @@

Method Details

"errorMessage": "A String", # Output only. The error message. "errorType": "A String", # Output only. The type of error. "sessionId": "A String", # Output only. The session ID for the conversation that caused the error. + "userFacingErrorMessage": "A String", # Output only. The user facing error message. }, "expectationOutcome": [ # Output only. The outcome of each expectation. { # Specifies the expectation and the result of that expectation. @@ -9137,6 +9159,7 @@

Method Details

"errorMessage": "A String", # Output only. The error message. "errorType": "A String", # Output only. The type of error. "sessionId": "A String", # Output only. The session ID for the conversation that caused the error. + "userFacingErrorMessage": "A String", # Output only. The user facing error message. }, "evaluationMetricsThresholds": { # Threshold settings for metrics in an Evaluation. # Output only. The evaluation thresholds for the result. "goldenEvaluationMetricsThresholds": { # Settings for golden evaluations. # Optional. The golden evaluation metrics thresholds. @@ -9175,6 +9198,7 @@

Method Details

"errorMessage": "A String", # Output only. The error message. "errorType": "A String", # Output only. The type of error. "sessionId": "A String", # Output only. The session ID for the conversation that caused the error. + "userFacingErrorMessage": "A String", # Output only. The user facing error message. }, "expectationOutcome": [ # Output only. The outcome of each expectation. { # Specifies the expectation and the result of that expectation. diff --git a/docs/dyn/ces_v1beta.projects.locations.apps.evaluations.results.html b/docs/dyn/ces_v1beta.projects.locations.apps.evaluations.results.html index 7b995601eb..1506eec291 100644 --- a/docs/dyn/ces_v1beta.projects.locations.apps.evaluations.results.html +++ b/docs/dyn/ces_v1beta.projects.locations.apps.evaluations.results.html @@ -211,6 +211,7 @@

Method Details

"errorMessage": "A String", # Output only. The error message. "errorType": "A String", # Output only. The type of error. "sessionId": "A String", # Output only. The session ID for the conversation that caused the error. + "userFacingErrorMessage": "A String", # Output only. The user facing error message. }, "evaluationMetricsThresholds": { # Threshold settings for metrics in an Evaluation. # Output only. The evaluation thresholds for the result. "goldenEvaluationMetricsThresholds": { # Settings for golden evaluations. # Optional. The golden evaluation metrics thresholds. @@ -249,6 +250,7 @@

Method Details

"errorMessage": "A String", # Output only. The error message. "errorType": "A String", # Output only. The type of error. "sessionId": "A String", # Output only. The session ID for the conversation that caused the error. + "userFacingErrorMessage": "A String", # Output only. The user facing error message. }, "expectationOutcome": [ # Output only. The outcome of each expectation. { # Specifies the expectation and the result of that expectation. @@ -817,6 +819,7 @@

Method Details

"errorMessage": "A String", # Output only. The error message. "errorType": "A String", # Output only. The type of error. "sessionId": "A String", # Output only. The session ID for the conversation that caused the error. + "userFacingErrorMessage": "A String", # Output only. The user facing error message. }, "evaluationMetricsThresholds": { # Threshold settings for metrics in an Evaluation. # Output only. The evaluation thresholds for the result. "goldenEvaluationMetricsThresholds": { # Settings for golden evaluations. # Optional. The golden evaluation metrics thresholds. @@ -855,6 +858,7 @@

Method Details

"errorMessage": "A String", # Output only. The error message. "errorType": "A String", # Output only. The type of error. "sessionId": "A String", # Output only. The session ID for the conversation that caused the error. + "userFacingErrorMessage": "A String", # Output only. The user facing error message. }, "expectationOutcome": [ # Output only. The outcome of each expectation. { # Specifies the expectation and the result of that expectation. diff --git a/docs/dyn/ces_v1beta.projects.locations.apps.html b/docs/dyn/ces_v1beta.projects.locations.apps.html index 312890b074..8657932d4e 100644 --- a/docs/dyn/ces_v1beta.projects.locations.apps.html +++ b/docs/dyn/ces_v1beta.projects.locations.apps.html @@ -124,6 +124,11 @@

Instance Methods

Returns the guardrails Resource.

+

+ message() +

+

Returns the message Resource.

+

scheduledEvaluationRuns()

@@ -354,11 +359,11 @@

Method Details

}, "locked": True or False, # Optional. Indicates whether the app is locked for changes. If the app is locked, modifications to the app resources will be rejected. "loggingSettings": { # Settings to describe the logging behaviors for the app. # Optional. Logging settings of the app. - "audioRecordingConfig": { # Configuration for how the audio interactions should be recorded. # Optional. Configuration for how audio interactions should be recorded. + "audioRecordingConfig": { # Configuration for how the audio interactions should be recorded. # Optional. Configuration for how audio interactions should be recorded. The audio is subject to redaction as configured in RedactionConfig. "gcsBucket": "A String", # Optional. The [Cloud Storage](https://cloud.google.com/storage) bucket to store the session audio recordings. The URI must start with "gs://". Please choose a bucket location that meets your data residency requirements. Note: If the Cloud Storage bucket is in a different project from the app, you should grant `storage.objects.create` permission to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`. "gcsPathPrefix": "A String", # Optional. The Cloud Storage path prefix for audio recordings. This prefix can include the following placeholders, which will be dynamically substituted at serving time: - $project: project ID - $location: app location - $app: app ID - $date: session date in YYYY-MM-DD format - $session: session ID If the path prefix is not specified, the default prefix `$project/$location/$app/$date/$session/` will be used. }, - "bigqueryExportSettings": { # Settings to describe the BigQuery export behaviors for the app. # Optional. Settings to describe the BigQuery export behaviors for the app. The conversation data will be exported to BigQuery tables if it is enabled. + "bigqueryExportSettings": { # Settings to describe the BigQuery export behaviors for the app. # Optional. Configures the BigQuery export behaviors for the app. The conversation data is subject to redaction as configured in RedactionConfig. "dataset": "A String", # Optional. The BigQuery **dataset ID** to export the data to. "enabled": True or False, # Optional. Indicates whether the BigQuery export is enabled. "project": "A String", # Optional. The **project ID** of the BigQuery dataset to export the data to. Note: If the BigQuery dataset is in a different project from the app, you should grant `roles/bigquery.admin` role to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`. @@ -382,7 +387,7 @@

Method Details

"enableRedaction": True or False, # Optional. If true, redaction will be applied in various logging scenarios, including conversation history, Cloud Logging and audio recording. "inspectTemplate": "A String", # Optional. [DLP](https://cloud.google.com/dlp/docs) inspect template name to configure detection of sensitive data types. Format: `projects/{project}/locations/{location}/inspectTemplates/{inspect_template}` }, - "unredactedAudioRecordingConfig": { # Configuration for how the audio interactions should be recorded. # Optional. Configures recording of unredacted audio. Use this to maintain a raw backup with restricted access when audio redaction is enabled, typically for auditing or monitoring purposes. + "unredactedAudioRecordingConfig": { # Configuration for how the audio interactions should be recorded. # Optional. Configures an additional recording of unredacted audio. This can be used to maintain a raw audio copy when audio redaction is enabled, typically for auditing or monitoring purposes. "gcsBucket": "A String", # Optional. The [Cloud Storage](https://cloud.google.com/storage) bucket to store the session audio recordings. The URI must start with "gs://". Please choose a bucket location that meets your data residency requirements. Note: If the Cloud Storage bucket is in a different project from the app, you should grant `storage.objects.create` permission to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`. "gcsPathPrefix": "A String", # Optional. The Cloud Storage path prefix for audio recordings. This prefix can include the following placeholders, which will be dynamically substituted at serving time: - $project: project ID - $location: app location - $app: app ID - $date: session date in YYYY-MM-DD format - $session: session ID If the path prefix is not specified, the default prefix `$project/$location/$app/$date/$session/` will be used. }, @@ -753,6 +758,7 @@

Method Details

"inputVariableMapping": { # Optional. The mapping of the app variables names to the Dialogflow session parameters names to be sent to the Dialogflow agent as input. "a_key": "A String", }, + "languageCodeVariable": "A String", # Optional. The name of the variable that contains the language code to be used for the Dialogflow session. If unspecified, the default language code of the Dialogflow agent will be used. "outputVariableMapping": { # Optional. The mapping of the Dialogflow session parameters names to the app variables names to be sent back to the CES agent after the Dialogflow agent execution ends. "a_key": "A String", }, @@ -1143,6 +1149,7 @@

Method Details

"uniqueItems": True or False, # Optional. Indicate the items in the array must be unique. Only applies to TYPE.ARRAY. }, "name": "A String", # Required. The name of the MCP tool. + "nameOverride": "A String", # Optional. The name override of the MCP tool. This is populated if the name was overridden by a Toolset override. "outputSchema": { # Represents a select subset of an OpenAPI 3.0 schema object. # Optional. The schema of the output arguments of the MCP tool. "additionalProperties": # Object with schema name: Schema # Optional. Can either be a boolean or an object, controls the presence of additional properties. "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. @@ -1180,6 +1187,7 @@

Method Details

"serviceDirectoryConfig": { # Configuration for tools using Service Directory. # Optional. Service Directory configuration for VPC-SC, used to resolve service names within a perimeter. "service": "A String", # Required. The name of [Service Directory](https://cloud.google.com/service-directory) service. Format: `projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}`. Location of the service directory must be the same as the location of the app. }, + "state": "A String", # Output only. The dynamic availability state of the tool on the external server. "tlsConfig": { # The TLS configuration. # Optional. The TLS configuration. Includes the custom server certificates that the client should trust. "caCerts": [ # Required. Specifies a list of allowed custom CA certificates for HTTPS verification. { # The CA certificate. @@ -1239,6 +1247,9 @@

Method Details

"description": "A String", # Output only. The description of the Python function, parsed from the python code's docstring. "name": "A String", # Optional. The name of the Python function to execute. Must match a Python function name defined in the python code. Case sensitive. If the name is not provided, the first function defined in the python code will be used. "pythonCode": "A String", # Optional. The Python code to execute for the tool. + "serviceDirectoryConfig": { # Configuration for tools using Service Directory. # Optional. Service Directory configuration for the tool. + "service": "A String", # Required. The name of [Service Directory](https://cloud.google.com/service-directory) service. Format: `projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}`. Location of the service directory must be the same as the location of the app. + }, }, "remoteAgentTool": { # Represents a tool that allows the agent to call another remote agent. # Optional. The remote agent tool. "agentCard": { # AgentCard conveys key information about a remote agent. It is a trimmed version of the AgentCard defined in the A2A protocol https://a2a-protocol.org/dev/specification/#441-agentcard # Required. The agent card of the remote agent that this tool invokes. @@ -1298,6 +1309,9 @@

Method Details

"description": "A String", # Output only. The description of the Python function, parsed from the python code's docstring. "name": "A String", # Optional. The name of the Python function to execute. Must match a Python function name defined in the python code. Case sensitive. If the name is not provided, the first function defined in the python code will be used. "pythonCode": "A String", # Optional. The Python code to execute for the tool. + "serviceDirectoryConfig": { # Configuration for tools using Service Directory. # Optional. Service Directory configuration for the tool. + "service": "A String", # Required. The name of [Service Directory](https://cloud.google.com/service-directory) service. Format: `projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}`. Location of the service directory must be the same as the location of the app. + }, }, "pythonScript": "A String", # Deprecated: Use `python_function` instead. "sourceToolName": "A String", # Optional. The resource name of the tool that provides the data for the widget (e.g., a search tool or a custom function). Format: `projects/{project}/locations/{location}/agents/{agent}/tools/{tool}` @@ -1448,6 +1462,82 @@

Method Details

}, ], }, + "toolOverrides": [ # Optional. Overrides for individual tools within this toolset. This allows overriding specific details like descriptions, names, or pinning the tools' states so they aren't fully dynamic. + { # Overrides associated with a given tool in a Toolset. This enables "pinning" or "overriding" of tool definitions from the external dynamic server. + "descriptionOverride": "A String", # Optional. If present, this tool uses this description instead of the original description from the server. + "nameOverride": "A String", # Optional. If present, this tool uses this name in the Agent instead of the original name. This is primarily used as an alias if the MCP server offers poorly named tools. + "snapshot": { # Container for a tool's core definition elements that are snapshot. Schemas in the snapshot are used as-is and cannot be overridden. # Output only. If present, this tool is "Pinned" and uses the snapshot values as fallbacks if the server becomes temporarily unavailable or if no Override is present. + "description": "A String", # Output only. The description of the MCP tool. This can be overridden by `description_override` in `McpToolOverride`. + "inputSchema": { # Represents a select subset of an OpenAPI 3.0 schema object. # Output only. The schema of the input arguments of the MCP tool. + "additionalProperties": # Object with schema name: Schema # Optional. Can either be a boolean or an object, controls the presence of additional properties. + "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. + # Object with schema name: Schema + ], + "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: Schema + }, + "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", + ], + "items": # Object with schema name: Schema # Optional. Schema of the elements of Type.ARRAY. + "maxItems": "A String", # Optional. Maximum number of the elements for Type.ARRAY. + "maximum": 3.14, # Optional. Maximum value for Type.INTEGER and Type.NUMBER. + "minItems": "A String", # Optional. Minimum number of the elements for Type.ARRAY. + "minimum": 3.14, # Optional. Minimum value for Type.INTEGER and Type.NUMBER. + "nullable": True or False, # Optional. Indicates if the value may be null. + "prefixItems": [ # Optional. Schemas of initial elements of Type.ARRAY. + # Object with schema name: Schema + ], + "properties": { # Optional. Properties of Type.OBJECT. + "a_key": # Object with schema name: Schema + }, + "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", # Required. The type of the data. + "uniqueItems": True or False, # Optional. Indicate the items in the array must be unique. Only applies to TYPE.ARRAY. + }, + "outputSchema": { # Represents a select subset of an OpenAPI 3.0 schema object. # Output only. The schema of the output arguments of the MCP tool. + "additionalProperties": # Object with schema name: Schema # Optional. Can either be a boolean or an object, controls the presence of additional properties. + "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. + # Object with schema name: Schema + ], + "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: Schema + }, + "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", + ], + "items": # Object with schema name: Schema # Optional. Schema of the elements of Type.ARRAY. + "maxItems": "A String", # Optional. Maximum number of the elements for Type.ARRAY. + "maximum": 3.14, # Optional. Maximum value for Type.INTEGER and Type.NUMBER. + "minItems": "A String", # Optional. Minimum number of the elements for Type.ARRAY. + "minimum": 3.14, # Optional. Minimum value for Type.INTEGER and Type.NUMBER. + "nullable": True or False, # Optional. Indicates if the value may be null. + "prefixItems": [ # Optional. Schemas of initial elements of Type.ARRAY. + # Object with schema name: Schema + ], + "properties": { # Optional. Properties of Type.OBJECT. + "a_key": # Object with schema name: Schema + }, + "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", # Required. The type of the data. + "uniqueItems": True or False, # Optional. Indicate the items in the array must be unique. Only applies to TYPE.ARRAY. + }, + }, + "tool": "A String", # Required. The original name of the tool as it is emitted by the MCP server. + }, + ], }, "name": "A String", # Identifier. The unique identifier of the toolset. Format: `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}` "openApiToolset": { # A toolset that contains a list of tools that are defined by an OpenAPI schema. # Optional. A toolset that contains a list of tools that are defined by an OpenAPI schema. @@ -1691,11 +1781,11 @@

Method Details

}, "locked": True or False, # Optional. Indicates whether the app is locked for changes. If the app is locked, modifications to the app resources will be rejected. "loggingSettings": { # Settings to describe the logging behaviors for the app. # Optional. Logging settings of the app. - "audioRecordingConfig": { # Configuration for how the audio interactions should be recorded. # Optional. Configuration for how audio interactions should be recorded. + "audioRecordingConfig": { # Configuration for how the audio interactions should be recorded. # Optional. Configuration for how audio interactions should be recorded. The audio is subject to redaction as configured in RedactionConfig. "gcsBucket": "A String", # Optional. The [Cloud Storage](https://cloud.google.com/storage) bucket to store the session audio recordings. The URI must start with "gs://". Please choose a bucket location that meets your data residency requirements. Note: If the Cloud Storage bucket is in a different project from the app, you should grant `storage.objects.create` permission to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`. "gcsPathPrefix": "A String", # Optional. The Cloud Storage path prefix for audio recordings. This prefix can include the following placeholders, which will be dynamically substituted at serving time: - $project: project ID - $location: app location - $app: app ID - $date: session date in YYYY-MM-DD format - $session: session ID If the path prefix is not specified, the default prefix `$project/$location/$app/$date/$session/` will be used. }, - "bigqueryExportSettings": { # Settings to describe the BigQuery export behaviors for the app. # Optional. Settings to describe the BigQuery export behaviors for the app. The conversation data will be exported to BigQuery tables if it is enabled. + "bigqueryExportSettings": { # Settings to describe the BigQuery export behaviors for the app. # Optional. Configures the BigQuery export behaviors for the app. The conversation data is subject to redaction as configured in RedactionConfig. "dataset": "A String", # Optional. The BigQuery **dataset ID** to export the data to. "enabled": True or False, # Optional. Indicates whether the BigQuery export is enabled. "project": "A String", # Optional. The **project ID** of the BigQuery dataset to export the data to. Note: If the BigQuery dataset is in a different project from the app, you should grant `roles/bigquery.admin` role to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`. @@ -1719,7 +1809,7 @@

Method Details

"enableRedaction": True or False, # Optional. If true, redaction will be applied in various logging scenarios, including conversation history, Cloud Logging and audio recording. "inspectTemplate": "A String", # Optional. [DLP](https://cloud.google.com/dlp/docs) inspect template name to configure detection of sensitive data types. Format: `projects/{project}/locations/{location}/inspectTemplates/{inspect_template}` }, - "unredactedAudioRecordingConfig": { # Configuration for how the audio interactions should be recorded. # Optional. Configures recording of unredacted audio. Use this to maintain a raw backup with restricted access when audio redaction is enabled, typically for auditing or monitoring purposes. + "unredactedAudioRecordingConfig": { # Configuration for how the audio interactions should be recorded. # Optional. Configures an additional recording of unredacted audio. This can be used to maintain a raw audio copy when audio redaction is enabled, typically for auditing or monitoring purposes. "gcsBucket": "A String", # Optional. The [Cloud Storage](https://cloud.google.com/storage) bucket to store the session audio recordings. The URI must start with "gs://". Please choose a bucket location that meets your data residency requirements. Note: If the Cloud Storage bucket is in a different project from the app, you should grant `storage.objects.create` permission to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`. "gcsPathPrefix": "A String", # Optional. The Cloud Storage path prefix for audio recordings. This prefix can include the following placeholders, which will be dynamically substituted at serving time: - $project: project ID - $location: app location - $app: app ID - $date: session date in YYYY-MM-DD format - $session: session ID If the path prefix is not specified, the default prefix `$project/$location/$app/$date/$session/` will be used. }, @@ -2093,11 +2183,11 @@

Method Details

}, "locked": True or False, # Optional. Indicates whether the app is locked for changes. If the app is locked, modifications to the app resources will be rejected. "loggingSettings": { # Settings to describe the logging behaviors for the app. # Optional. Logging settings of the app. - "audioRecordingConfig": { # Configuration for how the audio interactions should be recorded. # Optional. Configuration for how audio interactions should be recorded. + "audioRecordingConfig": { # Configuration for how the audio interactions should be recorded. # Optional. Configuration for how audio interactions should be recorded. The audio is subject to redaction as configured in RedactionConfig. "gcsBucket": "A String", # Optional. The [Cloud Storage](https://cloud.google.com/storage) bucket to store the session audio recordings. The URI must start with "gs://". Please choose a bucket location that meets your data residency requirements. Note: If the Cloud Storage bucket is in a different project from the app, you should grant `storage.objects.create` permission to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`. "gcsPathPrefix": "A String", # Optional. The Cloud Storage path prefix for audio recordings. This prefix can include the following placeholders, which will be dynamically substituted at serving time: - $project: project ID - $location: app location - $app: app ID - $date: session date in YYYY-MM-DD format - $session: session ID If the path prefix is not specified, the default prefix `$project/$location/$app/$date/$session/` will be used. }, - "bigqueryExportSettings": { # Settings to describe the BigQuery export behaviors for the app. # Optional. Settings to describe the BigQuery export behaviors for the app. The conversation data will be exported to BigQuery tables if it is enabled. + "bigqueryExportSettings": { # Settings to describe the BigQuery export behaviors for the app. # Optional. Configures the BigQuery export behaviors for the app. The conversation data is subject to redaction as configured in RedactionConfig. "dataset": "A String", # Optional. The BigQuery **dataset ID** to export the data to. "enabled": True or False, # Optional. Indicates whether the BigQuery export is enabled. "project": "A String", # Optional. The **project ID** of the BigQuery dataset to export the data to. Note: If the BigQuery dataset is in a different project from the app, you should grant `roles/bigquery.admin` role to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`. @@ -2121,7 +2211,7 @@

Method Details

"enableRedaction": True or False, # Optional. If true, redaction will be applied in various logging scenarios, including conversation history, Cloud Logging and audio recording. "inspectTemplate": "A String", # Optional. [DLP](https://cloud.google.com/dlp/docs) inspect template name to configure detection of sensitive data types. Format: `projects/{project}/locations/{location}/inspectTemplates/{inspect_template}` }, - "unredactedAudioRecordingConfig": { # Configuration for how the audio interactions should be recorded. # Optional. Configures recording of unredacted audio. Use this to maintain a raw backup with restricted access when audio redaction is enabled, typically for auditing or monitoring purposes. + "unredactedAudioRecordingConfig": { # Configuration for how the audio interactions should be recorded. # Optional. Configures an additional recording of unredacted audio. This can be used to maintain a raw audio copy when audio redaction is enabled, typically for auditing or monitoring purposes. "gcsBucket": "A String", # Optional. The [Cloud Storage](https://cloud.google.com/storage) bucket to store the session audio recordings. The URI must start with "gs://". Please choose a bucket location that meets your data residency requirements. Note: If the Cloud Storage bucket is in a different project from the app, you should grant `storage.objects.create` permission to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`. "gcsPathPrefix": "A String", # Optional. The Cloud Storage path prefix for audio recordings. This prefix can include the following placeholders, which will be dynamically substituted at serving time: - $project: project ID - $location: app location - $app: app ID - $date: session date in YYYY-MM-DD format - $session: session ID If the path prefix is not specified, the default prefix `$project/$location/$app/$date/$session/` will be used. }, @@ -2404,11 +2494,11 @@

Method Details

}, "locked": True or False, # Optional. Indicates whether the app is locked for changes. If the app is locked, modifications to the app resources will be rejected. "loggingSettings": { # Settings to describe the logging behaviors for the app. # Optional. Logging settings of the app. - "audioRecordingConfig": { # Configuration for how the audio interactions should be recorded. # Optional. Configuration for how audio interactions should be recorded. + "audioRecordingConfig": { # Configuration for how the audio interactions should be recorded. # Optional. Configuration for how audio interactions should be recorded. The audio is subject to redaction as configured in RedactionConfig. "gcsBucket": "A String", # Optional. The [Cloud Storage](https://cloud.google.com/storage) bucket to store the session audio recordings. The URI must start with "gs://". Please choose a bucket location that meets your data residency requirements. Note: If the Cloud Storage bucket is in a different project from the app, you should grant `storage.objects.create` permission to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`. "gcsPathPrefix": "A String", # Optional. The Cloud Storage path prefix for audio recordings. This prefix can include the following placeholders, which will be dynamically substituted at serving time: - $project: project ID - $location: app location - $app: app ID - $date: session date in YYYY-MM-DD format - $session: session ID If the path prefix is not specified, the default prefix `$project/$location/$app/$date/$session/` will be used. }, - "bigqueryExportSettings": { # Settings to describe the BigQuery export behaviors for the app. # Optional. Settings to describe the BigQuery export behaviors for the app. The conversation data will be exported to BigQuery tables if it is enabled. + "bigqueryExportSettings": { # Settings to describe the BigQuery export behaviors for the app. # Optional. Configures the BigQuery export behaviors for the app. The conversation data is subject to redaction as configured in RedactionConfig. "dataset": "A String", # Optional. The BigQuery **dataset ID** to export the data to. "enabled": True or False, # Optional. Indicates whether the BigQuery export is enabled. "project": "A String", # Optional. The **project ID** of the BigQuery dataset to export the data to. Note: If the BigQuery dataset is in a different project from the app, you should grant `roles/bigquery.admin` role to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`. @@ -2432,7 +2522,7 @@

Method Details

"enableRedaction": True or False, # Optional. If true, redaction will be applied in various logging scenarios, including conversation history, Cloud Logging and audio recording. "inspectTemplate": "A String", # Optional. [DLP](https://cloud.google.com/dlp/docs) inspect template name to configure detection of sensitive data types. Format: `projects/{project}/locations/{location}/inspectTemplates/{inspect_template}` }, - "unredactedAudioRecordingConfig": { # Configuration for how the audio interactions should be recorded. # Optional. Configures recording of unredacted audio. Use this to maintain a raw backup with restricted access when audio redaction is enabled, typically for auditing or monitoring purposes. + "unredactedAudioRecordingConfig": { # Configuration for how the audio interactions should be recorded. # Optional. Configures an additional recording of unredacted audio. This can be used to maintain a raw audio copy when audio redaction is enabled, typically for auditing or monitoring purposes. "gcsBucket": "A String", # Optional. The [Cloud Storage](https://cloud.google.com/storage) bucket to store the session audio recordings. The URI must start with "gs://". Please choose a bucket location that meets your data residency requirements. Note: If the Cloud Storage bucket is in a different project from the app, you should grant `storage.objects.create` permission to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`. "gcsPathPrefix": "A String", # Optional. The Cloud Storage path prefix for audio recordings. This prefix can include the following placeholders, which will be dynamically substituted at serving time: - $project: project ID - $location: app location - $app: app ID - $date: session date in YYYY-MM-DD format - $session: session ID If the path prefix is not specified, the default prefix `$project/$location/$app/$date/$session/` will be used. }, @@ -2694,11 +2784,11 @@

Method Details

}, "locked": True or False, # Optional. Indicates whether the app is locked for changes. If the app is locked, modifications to the app resources will be rejected. "loggingSettings": { # Settings to describe the logging behaviors for the app. # Optional. Logging settings of the app. - "audioRecordingConfig": { # Configuration for how the audio interactions should be recorded. # Optional. Configuration for how audio interactions should be recorded. + "audioRecordingConfig": { # Configuration for how the audio interactions should be recorded. # Optional. Configuration for how audio interactions should be recorded. The audio is subject to redaction as configured in RedactionConfig. "gcsBucket": "A String", # Optional. The [Cloud Storage](https://cloud.google.com/storage) bucket to store the session audio recordings. The URI must start with "gs://". Please choose a bucket location that meets your data residency requirements. Note: If the Cloud Storage bucket is in a different project from the app, you should grant `storage.objects.create` permission to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`. "gcsPathPrefix": "A String", # Optional. The Cloud Storage path prefix for audio recordings. This prefix can include the following placeholders, which will be dynamically substituted at serving time: - $project: project ID - $location: app location - $app: app ID - $date: session date in YYYY-MM-DD format - $session: session ID If the path prefix is not specified, the default prefix `$project/$location/$app/$date/$session/` will be used. }, - "bigqueryExportSettings": { # Settings to describe the BigQuery export behaviors for the app. # Optional. Settings to describe the BigQuery export behaviors for the app. The conversation data will be exported to BigQuery tables if it is enabled. + "bigqueryExportSettings": { # Settings to describe the BigQuery export behaviors for the app. # Optional. Configures the BigQuery export behaviors for the app. The conversation data is subject to redaction as configured in RedactionConfig. "dataset": "A String", # Optional. The BigQuery **dataset ID** to export the data to. "enabled": True or False, # Optional. Indicates whether the BigQuery export is enabled. "project": "A String", # Optional. The **project ID** of the BigQuery dataset to export the data to. Note: If the BigQuery dataset is in a different project from the app, you should grant `roles/bigquery.admin` role to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`. @@ -2722,7 +2812,7 @@

Method Details

"enableRedaction": True or False, # Optional. If true, redaction will be applied in various logging scenarios, including conversation history, Cloud Logging and audio recording. "inspectTemplate": "A String", # Optional. [DLP](https://cloud.google.com/dlp/docs) inspect template name to configure detection of sensitive data types. Format: `projects/{project}/locations/{location}/inspectTemplates/{inspect_template}` }, - "unredactedAudioRecordingConfig": { # Configuration for how the audio interactions should be recorded. # Optional. Configures recording of unredacted audio. Use this to maintain a raw backup with restricted access when audio redaction is enabled, typically for auditing or monitoring purposes. + "unredactedAudioRecordingConfig": { # Configuration for how the audio interactions should be recorded. # Optional. Configures an additional recording of unredacted audio. This can be used to maintain a raw audio copy when audio redaction is enabled, typically for auditing or monitoring purposes. "gcsBucket": "A String", # Optional. The [Cloud Storage](https://cloud.google.com/storage) bucket to store the session audio recordings. The URI must start with "gs://". Please choose a bucket location that meets your data residency requirements. Note: If the Cloud Storage bucket is in a different project from the app, you should grant `storage.objects.create` permission to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`. "gcsPathPrefix": "A String", # Optional. The Cloud Storage path prefix for audio recordings. This prefix can include the following placeholders, which will be dynamically substituted at serving time: - $project: project ID - $location: app location - $app: app ID - $date: session date in YYYY-MM-DD format - $session: session ID If the path prefix is not specified, the default prefix `$project/$location/$app/$date/$session/` will be used. }, diff --git a/docs/dyn/ces_v1beta.projects.locations.apps.message.html b/docs/dyn/ces_v1beta.projects.locations.apps.message.html new file mode 100644 index 0000000000..c0742277a5 --- /dev/null +++ b/docs/dyn/ces_v1beta.projects.locations.apps.message.html @@ -0,0 +1,285 @@ + + + +

Gemini Enterprise for Customer Experience API . projects . locations . apps . message

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ send(tenant, body=None, x__xgafv=None)

+

Sends a message to an agent.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ send(tenant, body=None, x__xgafv=None) +
Sends a message to an agent.
+
+Args:
+  tenant: string, Optional. Tenant ID, provided as a path parameter. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Represents a request for the `SendMessage` method.
+  "configuration": { # Configuration of a send message request. # Configuration for the send request.
+    "acceptedOutputModes": [ # A list of media types the client is prepared to accept for response parts. Agents SHOULD use this to tailor their output.
+      "A String",
+    ],
+    "historyLength": 42, # The maximum number of most recent messages from the task's history to retrieve in the response. An unset value means the client does not impose any limit. A value of zero is a request to not include any messages. The server MUST NOT return more messages than the provided value, but MAY apply a lower limit.
+    "returnImmediately": True or False, # If `true`, the operation returns immediately after creating the task, even if processing is still in progress. If `false` (default), the operation MUST wait until the task reaches a terminal (`COMPLETED`, `FAILED`, `CANCELED`, `REJECTED`) or interrupted (`INPUT_REQUIRED`, `AUTH_REQUIRED`) state before returning.
+    "taskPushNotificationConfig": { # A container associating a push notification configuration with a specific task. # Configuration for the agent to send push notifications for task updates. Task id should be empty when sending this configuration in a `SendMessage` request.
+      "authentication": { # Defines authentication details, used for push notifications. # Authentication information required to send the notification.
+        "credentials": "A String", # Push Notification credentials. Format depends on the scheme (e.g., token for Bearer).
+        "scheme": "A String", # Required. HTTP Authentication Scheme from the [IANA registry](https://www.iana.org/assignments/http-authschemes/). Examples: `Bearer`, `Basic`, `Digest`. Scheme names are case-insensitive per [RFC 9110 Section 11.1](https://www.rfc-editor.org/rfc/rfc9110#section-11.1).
+      },
+      "id": "A String", # The push notification configuration details. A unique identifier (e.g. UUID) for this push notification configuration.
+      "taskId": "A String", # The ID of the task this configuration is associated with.
+      "tenant": "A String", # Optional. Tenant ID.
+      "token": "A String", # A token unique for this task or session.
+      "url": "A String", # Required. The URL where the notification should be sent.
+    },
+  },
+  "message": { # `Message` is one unit of communication between client and server. It can be associated with a context and/or a task. For server messages, `context_id` must be provided, and `task_id` only if a task was created. For client messages, both fields are optional, with the caveat that if both are provided, they have to match (the `context_id` has to be the one that is set on the task). If only `task_id` is provided, the server will infer `context_id` from it. # Required. The message to send to the agent.
+    "contextId": "A String", # Optional. The context id of the message. If set, the message will be associated with the given context.
+    "extensions": [ # The URIs of extensions that are present or contributed to this Message.
+      "A String",
+    ],
+    "messageId": "A String", # Required. The unique identifier (e.g. UUID) of the message. This is created by the message creator.
+    "metadata": { # Optional. Any metadata to provide along with the message.
+      "a_key": "", # Properties of the object.
+    },
+    "parts": [ # Required. Parts is the container of the message content.
+      { # `Part` represents a container for a section of communication content. Parts can be purely textual, some sort of file (image, video, etc) or a structured data blob (i.e. JSON).
+        "data": "", # Arbitrary structured `data` as a JSON value (object, array, string, number, boolean, or null).
+        "filename": "A String", # An optional `filename` for the file (e.g., "document.pdf").
+        "mediaType": "A String", # The `media_type` (MIME type) of the part content (e.g., "text/plain", "application/json", "image/png"). This field is available for all part types.
+        "metadata": { # Optional. metadata associated with this part.
+          "a_key": "", # Properties of the object.
+        },
+        "raw": "A String", # The `raw` byte content of a file. In JSON serialization, this is encoded as a base64 string.
+        "text": "A String", # The string content of the `text` part.
+        "url": "A String", # A `url` pointing to the file's content.
+      },
+    ],
+    "referenceTaskIds": [ # A list of task IDs that this message references for additional context.
+      "A String",
+    ],
+    "role": "A String", # Required. Identifies the sender of the message.
+    "taskId": "A String", # Optional. The task id of the message. If set, the message will be associated with the given task.
+  },
+  "metadata": { # A flexible key-value map for passing additional context or parameters.
+    "a_key": "", # Properties of the object.
+  },
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Represents the response for the `SendMessage` method.
+  "message": { # `Message` is one unit of communication between client and server. It can be associated with a context and/or a task. For server messages, `context_id` must be provided, and `task_id` only if a task was created. For client messages, both fields are optional, with the caveat that if both are provided, they have to match (the `context_id` has to be the one that is set on the task). If only `task_id` is provided, the server will infer `context_id` from it. # A message from the agent.
+    "contextId": "A String", # Optional. The context id of the message. If set, the message will be associated with the given context.
+    "extensions": [ # The URIs of extensions that are present or contributed to this Message.
+      "A String",
+    ],
+    "messageId": "A String", # Required. The unique identifier (e.g. UUID) of the message. This is created by the message creator.
+    "metadata": { # Optional. Any metadata to provide along with the message.
+      "a_key": "", # Properties of the object.
+    },
+    "parts": [ # Required. Parts is the container of the message content.
+      { # `Part` represents a container for a section of communication content. Parts can be purely textual, some sort of file (image, video, etc) or a structured data blob (i.e. JSON).
+        "data": "", # Arbitrary structured `data` as a JSON value (object, array, string, number, boolean, or null).
+        "filename": "A String", # An optional `filename` for the file (e.g., "document.pdf").
+        "mediaType": "A String", # The `media_type` (MIME type) of the part content (e.g., "text/plain", "application/json", "image/png"). This field is available for all part types.
+        "metadata": { # Optional. metadata associated with this part.
+          "a_key": "", # Properties of the object.
+        },
+        "raw": "A String", # The `raw` byte content of a file. In JSON serialization, this is encoded as a base64 string.
+        "text": "A String", # The string content of the `text` part.
+        "url": "A String", # A `url` pointing to the file's content.
+      },
+    ],
+    "referenceTaskIds": [ # A list of task IDs that this message references for additional context.
+      "A String",
+    ],
+    "role": "A String", # Required. Identifies the sender of the message.
+    "taskId": "A String", # Optional. The task id of the message. If set, the message will be associated with the given task.
+  },
+  "task": { # `Task` is the core unit of action for A2A. It has a current status and when results are created for the task they are stored in the artifact. If there are multiple turns for a task, these are stored in history. # The task created or updated by the message.
+    "artifacts": [ # A set of output artifacts for a `Task`.
+      { # Artifacts represent task outputs.
+        "artifactId": "A String", # Required. Unique identifier (e.g. UUID) for the artifact. It must be unique within a task.
+        "description": "A String", # Optional. A human readable description of the artifact.
+        "extensions": [ # The URIs of extensions that are present or contributed to this Artifact.
+          "A String",
+        ],
+        "metadata": { # Optional. Metadata included with the artifact.
+          "a_key": "", # Properties of the object.
+        },
+        "name": "A String", # A human readable name for the artifact.
+        "parts": [ # Required. The content of the artifact. Must contain at least one part.
+          { # `Part` represents a container for a section of communication content. Parts can be purely textual, some sort of file (image, video, etc) or a structured data blob (i.e. JSON).
+            "data": "", # Arbitrary structured `data` as a JSON value (object, array, string, number, boolean, or null).
+            "filename": "A String", # An optional `filename` for the file (e.g., "document.pdf").
+            "mediaType": "A String", # The `media_type` (MIME type) of the part content (e.g., "text/plain", "application/json", "image/png"). This field is available for all part types.
+            "metadata": { # Optional. metadata associated with this part.
+              "a_key": "", # Properties of the object.
+            },
+            "raw": "A String", # The `raw` byte content of a file. In JSON serialization, this is encoded as a base64 string.
+            "text": "A String", # The string content of the `text` part.
+            "url": "A String", # A `url` pointing to the file's content.
+          },
+        ],
+      },
+    ],
+    "contextId": "A String", # Unique identifier (e.g. UUID) for the contextual collection of interactions (tasks and messages).
+    "history": [ # protolint:disable REPEATED_FIELD_NAMES_PLURALIZED The history of interactions from a `Task`.
+      { # `Message` is one unit of communication between client and server. It can be associated with a context and/or a task. For server messages, `context_id` must be provided, and `task_id` only if a task was created. For client messages, both fields are optional, with the caveat that if both are provided, they have to match (the `context_id` has to be the one that is set on the task). If only `task_id` is provided, the server will infer `context_id` from it.
+        "contextId": "A String", # Optional. The context id of the message. If set, the message will be associated with the given context.
+        "extensions": [ # The URIs of extensions that are present or contributed to this Message.
+          "A String",
+        ],
+        "messageId": "A String", # Required. The unique identifier (e.g. UUID) of the message. This is created by the message creator.
+        "metadata": { # Optional. Any metadata to provide along with the message.
+          "a_key": "", # Properties of the object.
+        },
+        "parts": [ # Required. Parts is the container of the message content.
+          { # `Part` represents a container for a section of communication content. Parts can be purely textual, some sort of file (image, video, etc) or a structured data blob (i.e. JSON).
+            "data": "", # Arbitrary structured `data` as a JSON value (object, array, string, number, boolean, or null).
+            "filename": "A String", # An optional `filename` for the file (e.g., "document.pdf").
+            "mediaType": "A String", # The `media_type` (MIME type) of the part content (e.g., "text/plain", "application/json", "image/png"). This field is available for all part types.
+            "metadata": { # Optional. metadata associated with this part.
+              "a_key": "", # Properties of the object.
+            },
+            "raw": "A String", # The `raw` byte content of a file. In JSON serialization, this is encoded as a base64 string.
+            "text": "A String", # The string content of the `text` part.
+            "url": "A String", # A `url` pointing to the file's content.
+          },
+        ],
+        "referenceTaskIds": [ # A list of task IDs that this message references for additional context.
+          "A String",
+        ],
+        "role": "A String", # Required. Identifies the sender of the message.
+        "taskId": "A String", # Optional. The task id of the message. If set, the message will be associated with the given task.
+      },
+    ],
+    "id": "A String", # Required. Unique identifier (e.g. UUID) for the task, generated by the server for a new task.
+    "metadata": { # protolint:enable REPEATED_FIELD_NAMES_PLURALIZED A key/value object to store custom metadata about a task.
+      "a_key": "", # Properties of the object.
+    },
+    "status": { # A container for the status of a task # Required. The current status of a `Task`, including `state` and a `message`.
+      "message": { # `Message` is one unit of communication between client and server. It can be associated with a context and/or a task. For server messages, `context_id` must be provided, and `task_id` only if a task was created. For client messages, both fields are optional, with the caveat that if both are provided, they have to match (the `context_id` has to be the one that is set on the task). If only `task_id` is provided, the server will infer `context_id` from it. # A message associated with the status.
+        "contextId": "A String", # Optional. The context id of the message. If set, the message will be associated with the given context.
+        "extensions": [ # The URIs of extensions that are present or contributed to this Message.
+          "A String",
+        ],
+        "messageId": "A String", # Required. The unique identifier (e.g. UUID) of the message. This is created by the message creator.
+        "metadata": { # Optional. Any metadata to provide along with the message.
+          "a_key": "", # Properties of the object.
+        },
+        "parts": [ # Required. Parts is the container of the message content.
+          { # `Part` represents a container for a section of communication content. Parts can be purely textual, some sort of file (image, video, etc) or a structured data blob (i.e. JSON).
+            "data": "", # Arbitrary structured `data` as a JSON value (object, array, string, number, boolean, or null).
+            "filename": "A String", # An optional `filename` for the file (e.g., "document.pdf").
+            "mediaType": "A String", # The `media_type` (MIME type) of the part content (e.g., "text/plain", "application/json", "image/png"). This field is available for all part types.
+            "metadata": { # Optional. metadata associated with this part.
+              "a_key": "", # Properties of the object.
+            },
+            "raw": "A String", # The `raw` byte content of a file. In JSON serialization, this is encoded as a base64 string.
+            "text": "A String", # The string content of the `text` part.
+            "url": "A String", # A `url` pointing to the file's content.
+          },
+        ],
+        "referenceTaskIds": [ # A list of task IDs that this message references for additional context.
+          "A String",
+        ],
+        "role": "A String", # Required. Identifies the sender of the message.
+        "taskId": "A String", # Optional. The task id of the message. If set, the message will be associated with the given task.
+      },
+      "state": "A String", # Required. The current state of this task.
+      "timestamp": "A String", # ISO 8601 Timestamp when the status was recorded. Example: "2023-10-27T10:00:00Z"
+    },
+  },
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/ces_v1beta.projects.locations.apps.tools.html b/docs/dyn/ces_v1beta.projects.locations.apps.tools.html index 211c230b68..256b01a495 100644 --- a/docs/dyn/ces_v1beta.projects.locations.apps.tools.html +++ b/docs/dyn/ces_v1beta.projects.locations.apps.tools.html @@ -403,6 +403,7 @@

Method Details

"uniqueItems": True or False, # Optional. Indicate the items in the array must be unique. Only applies to TYPE.ARRAY. }, "name": "A String", # Required. The name of the MCP tool. + "nameOverride": "A String", # Optional. The name override of the MCP tool. This is populated if the name was overridden by a Toolset override. "outputSchema": { # Represents a select subset of an OpenAPI 3.0 schema object. # Optional. The schema of the output arguments of the MCP tool. "additionalProperties": # Object with schema name: Schema # Optional. Can either be a boolean or an object, controls the presence of additional properties. "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. @@ -440,6 +441,7 @@

Method Details

"serviceDirectoryConfig": { # Configuration for tools using Service Directory. # Optional. Service Directory configuration for VPC-SC, used to resolve service names within a perimeter. "service": "A String", # Required. The name of [Service Directory](https://cloud.google.com/service-directory) service. Format: `projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}`. Location of the service directory must be the same as the location of the app. }, + "state": "A String", # Output only. The dynamic availability state of the tool on the external server. "tlsConfig": { # The TLS configuration. # Optional. The TLS configuration. Includes the custom server certificates that the client should trust. "caCerts": [ # Required. Specifies a list of allowed custom CA certificates for HTTPS verification. { # The CA certificate. @@ -499,6 +501,9 @@

Method Details

"description": "A String", # Output only. The description of the Python function, parsed from the python code's docstring. "name": "A String", # Optional. The name of the Python function to execute. Must match a Python function name defined in the python code. Case sensitive. If the name is not provided, the first function defined in the python code will be used. "pythonCode": "A String", # Optional. The Python code to execute for the tool. + "serviceDirectoryConfig": { # Configuration for tools using Service Directory. # Optional. Service Directory configuration for the tool. + "service": "A String", # Required. The name of [Service Directory](https://cloud.google.com/service-directory) service. Format: `projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}`. Location of the service directory must be the same as the location of the app. + }, }, "remoteAgentTool": { # Represents a tool that allows the agent to call another remote agent. # Optional. The remote agent tool. "agentCard": { # AgentCard conveys key information about a remote agent. It is a trimmed version of the AgentCard defined in the A2A protocol https://a2a-protocol.org/dev/specification/#441-agentcard # Required. The agent card of the remote agent that this tool invokes. @@ -558,6 +563,9 @@

Method Details

"description": "A String", # Output only. The description of the Python function, parsed from the python code's docstring. "name": "A String", # Optional. The name of the Python function to execute. Must match a Python function name defined in the python code. Case sensitive. If the name is not provided, the first function defined in the python code will be used. "pythonCode": "A String", # Optional. The Python code to execute for the tool. + "serviceDirectoryConfig": { # Configuration for tools using Service Directory. # Optional. Service Directory configuration for the tool. + "service": "A String", # Required. The name of [Service Directory](https://cloud.google.com/service-directory) service. Format: `projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}`. Location of the service directory must be the same as the location of the app. + }, }, "pythonScript": "A String", # Deprecated: Use `python_function` instead. "sourceToolName": "A String", # Optional. The resource name of the tool that provides the data for the widget (e.g., a search tool or a custom function). Format: `projects/{project}/locations/{location}/agents/{agent}/tools/{tool}` @@ -911,6 +919,7 @@

Method Details

"uniqueItems": True or False, # Optional. Indicate the items in the array must be unique. Only applies to TYPE.ARRAY. }, "name": "A String", # Required. The name of the MCP tool. + "nameOverride": "A String", # Optional. The name override of the MCP tool. This is populated if the name was overridden by a Toolset override. "outputSchema": { # Represents a select subset of an OpenAPI 3.0 schema object. # Optional. The schema of the output arguments of the MCP tool. "additionalProperties": # Object with schema name: Schema # Optional. Can either be a boolean or an object, controls the presence of additional properties. "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. @@ -948,6 +957,7 @@

Method Details

"serviceDirectoryConfig": { # Configuration for tools using Service Directory. # Optional. Service Directory configuration for VPC-SC, used to resolve service names within a perimeter. "service": "A String", # Required. The name of [Service Directory](https://cloud.google.com/service-directory) service. Format: `projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}`. Location of the service directory must be the same as the location of the app. }, + "state": "A String", # Output only. The dynamic availability state of the tool on the external server. "tlsConfig": { # The TLS configuration. # Optional. The TLS configuration. Includes the custom server certificates that the client should trust. "caCerts": [ # Required. Specifies a list of allowed custom CA certificates for HTTPS verification. { # The CA certificate. @@ -1007,6 +1017,9 @@

Method Details

"description": "A String", # Output only. The description of the Python function, parsed from the python code's docstring. "name": "A String", # Optional. The name of the Python function to execute. Must match a Python function name defined in the python code. Case sensitive. If the name is not provided, the first function defined in the python code will be used. "pythonCode": "A String", # Optional. The Python code to execute for the tool. + "serviceDirectoryConfig": { # Configuration for tools using Service Directory. # Optional. Service Directory configuration for the tool. + "service": "A String", # Required. The name of [Service Directory](https://cloud.google.com/service-directory) service. Format: `projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}`. Location of the service directory must be the same as the location of the app. + }, }, "remoteAgentTool": { # Represents a tool that allows the agent to call another remote agent. # Optional. The remote agent tool. "agentCard": { # AgentCard conveys key information about a remote agent. It is a trimmed version of the AgentCard defined in the A2A protocol https://a2a-protocol.org/dev/specification/#441-agentcard # Required. The agent card of the remote agent that this tool invokes. @@ -1066,6 +1079,9 @@

Method Details

"description": "A String", # Output only. The description of the Python function, parsed from the python code's docstring. "name": "A String", # Optional. The name of the Python function to execute. Must match a Python function name defined in the python code. Case sensitive. If the name is not provided, the first function defined in the python code will be used. "pythonCode": "A String", # Optional. The Python code to execute for the tool. + "serviceDirectoryConfig": { # Configuration for tools using Service Directory. # Optional. Service Directory configuration for the tool. + "service": "A String", # Required. The name of [Service Directory](https://cloud.google.com/service-directory) service. Format: `projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}`. Location of the service directory must be the same as the location of the app. + }, }, "pythonScript": "A String", # Deprecated: Use `python_function` instead. "sourceToolName": "A String", # Optional. The resource name of the tool that provides the data for the widget (e.g., a search tool or a custom function). Format: `projects/{project}/locations/{location}/agents/{agent}/tools/{tool}` @@ -1445,6 +1461,7 @@

Method Details

"uniqueItems": True or False, # Optional. Indicate the items in the array must be unique. Only applies to TYPE.ARRAY. }, "name": "A String", # Required. The name of the MCP tool. + "nameOverride": "A String", # Optional. The name override of the MCP tool. This is populated if the name was overridden by a Toolset override. "outputSchema": { # Represents a select subset of an OpenAPI 3.0 schema object. # Optional. The schema of the output arguments of the MCP tool. "additionalProperties": # Object with schema name: Schema # Optional. Can either be a boolean or an object, controls the presence of additional properties. "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. @@ -1482,6 +1499,7 @@

Method Details

"serviceDirectoryConfig": { # Configuration for tools using Service Directory. # Optional. Service Directory configuration for VPC-SC, used to resolve service names within a perimeter. "service": "A String", # Required. The name of [Service Directory](https://cloud.google.com/service-directory) service. Format: `projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}`. Location of the service directory must be the same as the location of the app. }, + "state": "A String", # Output only. The dynamic availability state of the tool on the external server. "tlsConfig": { # The TLS configuration. # Optional. The TLS configuration. Includes the custom server certificates that the client should trust. "caCerts": [ # Required. Specifies a list of allowed custom CA certificates for HTTPS verification. { # The CA certificate. @@ -1541,6 +1559,9 @@

Method Details

"description": "A String", # Output only. The description of the Python function, parsed from the python code's docstring. "name": "A String", # Optional. The name of the Python function to execute. Must match a Python function name defined in the python code. Case sensitive. If the name is not provided, the first function defined in the python code will be used. "pythonCode": "A String", # Optional. The Python code to execute for the tool. + "serviceDirectoryConfig": { # Configuration for tools using Service Directory. # Optional. Service Directory configuration for the tool. + "service": "A String", # Required. The name of [Service Directory](https://cloud.google.com/service-directory) service. Format: `projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}`. Location of the service directory must be the same as the location of the app. + }, }, "remoteAgentTool": { # Represents a tool that allows the agent to call another remote agent. # Optional. The remote agent tool. "agentCard": { # AgentCard conveys key information about a remote agent. It is a trimmed version of the AgentCard defined in the A2A protocol https://a2a-protocol.org/dev/specification/#441-agentcard # Required. The agent card of the remote agent that this tool invokes. @@ -1600,6 +1621,9 @@

Method Details

"description": "A String", # Output only. The description of the Python function, parsed from the python code's docstring. "name": "A String", # Optional. The name of the Python function to execute. Must match a Python function name defined in the python code. Case sensitive. If the name is not provided, the first function defined in the python code will be used. "pythonCode": "A String", # Optional. The Python code to execute for the tool. + "serviceDirectoryConfig": { # Configuration for tools using Service Directory. # Optional. Service Directory configuration for the tool. + "service": "A String", # Required. The name of [Service Directory](https://cloud.google.com/service-directory) service. Format: `projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}`. Location of the service directory must be the same as the location of the app. + }, }, "pythonScript": "A String", # Deprecated: Use `python_function` instead. "sourceToolName": "A String", # Optional. The resource name of the tool that provides the data for the widget (e.g., a search tool or a custom function). Format: `projects/{project}/locations/{location}/agents/{agent}/tools/{tool}` @@ -1966,6 +1990,7 @@

Method Details

"uniqueItems": True or False, # Optional. Indicate the items in the array must be unique. Only applies to TYPE.ARRAY. }, "name": "A String", # Required. The name of the MCP tool. + "nameOverride": "A String", # Optional. The name override of the MCP tool. This is populated if the name was overridden by a Toolset override. "outputSchema": { # Represents a select subset of an OpenAPI 3.0 schema object. # Optional. The schema of the output arguments of the MCP tool. "additionalProperties": # Object with schema name: Schema # Optional. Can either be a boolean or an object, controls the presence of additional properties. "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. @@ -2003,6 +2028,7 @@

Method Details

"serviceDirectoryConfig": { # Configuration for tools using Service Directory. # Optional. Service Directory configuration for VPC-SC, used to resolve service names within a perimeter. "service": "A String", # Required. The name of [Service Directory](https://cloud.google.com/service-directory) service. Format: `projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}`. Location of the service directory must be the same as the location of the app. }, + "state": "A String", # Output only. The dynamic availability state of the tool on the external server. "tlsConfig": { # The TLS configuration. # Optional. The TLS configuration. Includes the custom server certificates that the client should trust. "caCerts": [ # Required. Specifies a list of allowed custom CA certificates for HTTPS verification. { # The CA certificate. @@ -2062,6 +2088,9 @@

Method Details

"description": "A String", # Output only. The description of the Python function, parsed from the python code's docstring. "name": "A String", # Optional. The name of the Python function to execute. Must match a Python function name defined in the python code. Case sensitive. If the name is not provided, the first function defined in the python code will be used. "pythonCode": "A String", # Optional. The Python code to execute for the tool. + "serviceDirectoryConfig": { # Configuration for tools using Service Directory. # Optional. Service Directory configuration for the tool. + "service": "A String", # Required. The name of [Service Directory](https://cloud.google.com/service-directory) service. Format: `projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}`. Location of the service directory must be the same as the location of the app. + }, }, "remoteAgentTool": { # Represents a tool that allows the agent to call another remote agent. # Optional. The remote agent tool. "agentCard": { # AgentCard conveys key information about a remote agent. It is a trimmed version of the AgentCard defined in the A2A protocol https://a2a-protocol.org/dev/specification/#441-agentcard # Required. The agent card of the remote agent that this tool invokes. @@ -2121,6 +2150,9 @@

Method Details

"description": "A String", # Output only. The description of the Python function, parsed from the python code's docstring. "name": "A String", # Optional. The name of the Python function to execute. Must match a Python function name defined in the python code. Case sensitive. If the name is not provided, the first function defined in the python code will be used. "pythonCode": "A String", # Optional. The Python code to execute for the tool. + "serviceDirectoryConfig": { # Configuration for tools using Service Directory. # Optional. Service Directory configuration for the tool. + "service": "A String", # Required. The name of [Service Directory](https://cloud.google.com/service-directory) service. Format: `projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}`. Location of the service directory must be the same as the location of the app. + }, }, "pythonScript": "A String", # Deprecated: Use `python_function` instead. "sourceToolName": "A String", # Optional. The resource name of the tool that provides the data for the widget (e.g., a search tool or a custom function). Format: `projects/{project}/locations/{location}/agents/{agent}/tools/{tool}` @@ -2491,6 +2523,7 @@

Method Details

"uniqueItems": True or False, # Optional. Indicate the items in the array must be unique. Only applies to TYPE.ARRAY. }, "name": "A String", # Required. The name of the MCP tool. + "nameOverride": "A String", # Optional. The name override of the MCP tool. This is populated if the name was overridden by a Toolset override. "outputSchema": { # Represents a select subset of an OpenAPI 3.0 schema object. # Optional. The schema of the output arguments of the MCP tool. "additionalProperties": # Object with schema name: Schema # Optional. Can either be a boolean or an object, controls the presence of additional properties. "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. @@ -2528,6 +2561,7 @@

Method Details

"serviceDirectoryConfig": { # Configuration for tools using Service Directory. # Optional. Service Directory configuration for VPC-SC, used to resolve service names within a perimeter. "service": "A String", # Required. The name of [Service Directory](https://cloud.google.com/service-directory) service. Format: `projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}`. Location of the service directory must be the same as the location of the app. }, + "state": "A String", # Output only. The dynamic availability state of the tool on the external server. "tlsConfig": { # The TLS configuration. # Optional. The TLS configuration. Includes the custom server certificates that the client should trust. "caCerts": [ # Required. Specifies a list of allowed custom CA certificates for HTTPS verification. { # The CA certificate. @@ -2587,6 +2621,9 @@

Method Details

"description": "A String", # Output only. The description of the Python function, parsed from the python code's docstring. "name": "A String", # Optional. The name of the Python function to execute. Must match a Python function name defined in the python code. Case sensitive. If the name is not provided, the first function defined in the python code will be used. "pythonCode": "A String", # Optional. The Python code to execute for the tool. + "serviceDirectoryConfig": { # Configuration for tools using Service Directory. # Optional. Service Directory configuration for the tool. + "service": "A String", # Required. The name of [Service Directory](https://cloud.google.com/service-directory) service. Format: `projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}`. Location of the service directory must be the same as the location of the app. + }, }, "remoteAgentTool": { # Represents a tool that allows the agent to call another remote agent. # Optional. The remote agent tool. "agentCard": { # AgentCard conveys key information about a remote agent. It is a trimmed version of the AgentCard defined in the A2A protocol https://a2a-protocol.org/dev/specification/#441-agentcard # Required. The agent card of the remote agent that this tool invokes. @@ -2646,6 +2683,9 @@

Method Details

"description": "A String", # Output only. The description of the Python function, parsed from the python code's docstring. "name": "A String", # Optional. The name of the Python function to execute. Must match a Python function name defined in the python code. Case sensitive. If the name is not provided, the first function defined in the python code will be used. "pythonCode": "A String", # Optional. The Python code to execute for the tool. + "serviceDirectoryConfig": { # Configuration for tools using Service Directory. # Optional. Service Directory configuration for the tool. + "service": "A String", # Required. The name of [Service Directory](https://cloud.google.com/service-directory) service. Format: `projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}`. Location of the service directory must be the same as the location of the app. + }, }, "pythonScript": "A String", # Deprecated: Use `python_function` instead. "sourceToolName": "A String", # Optional. The resource name of the tool that provides the data for the widget (e.g., a search tool or a custom function). Format: `projects/{project}/locations/{location}/agents/{agent}/tools/{tool}` @@ -2999,6 +3039,7 @@

Method Details

"uniqueItems": True or False, # Optional. Indicate the items in the array must be unique. Only applies to TYPE.ARRAY. }, "name": "A String", # Required. The name of the MCP tool. + "nameOverride": "A String", # Optional. The name override of the MCP tool. This is populated if the name was overridden by a Toolset override. "outputSchema": { # Represents a select subset of an OpenAPI 3.0 schema object. # Optional. The schema of the output arguments of the MCP tool. "additionalProperties": # Object with schema name: Schema # Optional. Can either be a boolean or an object, controls the presence of additional properties. "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. @@ -3036,6 +3077,7 @@

Method Details

"serviceDirectoryConfig": { # Configuration for tools using Service Directory. # Optional. Service Directory configuration for VPC-SC, used to resolve service names within a perimeter. "service": "A String", # Required. The name of [Service Directory](https://cloud.google.com/service-directory) service. Format: `projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}`. Location of the service directory must be the same as the location of the app. }, + "state": "A String", # Output only. The dynamic availability state of the tool on the external server. "tlsConfig": { # The TLS configuration. # Optional. The TLS configuration. Includes the custom server certificates that the client should trust. "caCerts": [ # Required. Specifies a list of allowed custom CA certificates for HTTPS verification. { # The CA certificate. @@ -3095,6 +3137,9 @@

Method Details

"description": "A String", # Output only. The description of the Python function, parsed from the python code's docstring. "name": "A String", # Optional. The name of the Python function to execute. Must match a Python function name defined in the python code. Case sensitive. If the name is not provided, the first function defined in the python code will be used. "pythonCode": "A String", # Optional. The Python code to execute for the tool. + "serviceDirectoryConfig": { # Configuration for tools using Service Directory. # Optional. Service Directory configuration for the tool. + "service": "A String", # Required. The name of [Service Directory](https://cloud.google.com/service-directory) service. Format: `projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}`. Location of the service directory must be the same as the location of the app. + }, }, "remoteAgentTool": { # Represents a tool that allows the agent to call another remote agent. # Optional. The remote agent tool. "agentCard": { # AgentCard conveys key information about a remote agent. It is a trimmed version of the AgentCard defined in the A2A protocol https://a2a-protocol.org/dev/specification/#441-agentcard # Required. The agent card of the remote agent that this tool invokes. @@ -3154,6 +3199,9 @@

Method Details

"description": "A String", # Output only. The description of the Python function, parsed from the python code's docstring. "name": "A String", # Optional. The name of the Python function to execute. Must match a Python function name defined in the python code. Case sensitive. If the name is not provided, the first function defined in the python code will be used. "pythonCode": "A String", # Optional. The Python code to execute for the tool. + "serviceDirectoryConfig": { # Configuration for tools using Service Directory. # Optional. Service Directory configuration for the tool. + "service": "A String", # Required. The name of [Service Directory](https://cloud.google.com/service-directory) service. Format: `projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}`. Location of the service directory must be the same as the location of the app. + }, }, "pythonScript": "A String", # Deprecated: Use `python_function` instead. "sourceToolName": "A String", # Optional. The resource name of the tool that provides the data for the widget (e.g., a search tool or a custom function). Format: `projects/{project}/locations/{location}/agents/{agent}/tools/{tool}` diff --git a/docs/dyn/ces_v1beta.projects.locations.apps.toolsets.html b/docs/dyn/ces_v1beta.projects.locations.apps.toolsets.html index 77db71a499..747e2560bb 100644 --- a/docs/dyn/ces_v1beta.projects.locations.apps.toolsets.html +++ b/docs/dyn/ces_v1beta.projects.locations.apps.toolsets.html @@ -190,6 +190,82 @@

Method Details

}, ], }, + "toolOverrides": [ # Optional. Overrides for individual tools within this toolset. This allows overriding specific details like descriptions, names, or pinning the tools' states so they aren't fully dynamic. + { # Overrides associated with a given tool in a Toolset. This enables "pinning" or "overriding" of tool definitions from the external dynamic server. + "descriptionOverride": "A String", # Optional. If present, this tool uses this description instead of the original description from the server. + "nameOverride": "A String", # Optional. If present, this tool uses this name in the Agent instead of the original name. This is primarily used as an alias if the MCP server offers poorly named tools. + "snapshot": { # Container for a tool's core definition elements that are snapshot. Schemas in the snapshot are used as-is and cannot be overridden. # Output only. If present, this tool is "Pinned" and uses the snapshot values as fallbacks if the server becomes temporarily unavailable or if no Override is present. + "description": "A String", # Output only. The description of the MCP tool. This can be overridden by `description_override` in `McpToolOverride`. + "inputSchema": { # Represents a select subset of an OpenAPI 3.0 schema object. # Output only. The schema of the input arguments of the MCP tool. + "additionalProperties": # Object with schema name: Schema # Optional. Can either be a boolean or an object, controls the presence of additional properties. + "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. + # Object with schema name: Schema + ], + "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: Schema + }, + "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", + ], + "items": # Object with schema name: Schema # Optional. Schema of the elements of Type.ARRAY. + "maxItems": "A String", # Optional. Maximum number of the elements for Type.ARRAY. + "maximum": 3.14, # Optional. Maximum value for Type.INTEGER and Type.NUMBER. + "minItems": "A String", # Optional. Minimum number of the elements for Type.ARRAY. + "minimum": 3.14, # Optional. Minimum value for Type.INTEGER and Type.NUMBER. + "nullable": True or False, # Optional. Indicates if the value may be null. + "prefixItems": [ # Optional. Schemas of initial elements of Type.ARRAY. + # Object with schema name: Schema + ], + "properties": { # Optional. Properties of Type.OBJECT. + "a_key": # Object with schema name: Schema + }, + "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", # Required. The type of the data. + "uniqueItems": True or False, # Optional. Indicate the items in the array must be unique. Only applies to TYPE.ARRAY. + }, + "outputSchema": { # Represents a select subset of an OpenAPI 3.0 schema object. # Output only. The schema of the output arguments of the MCP tool. + "additionalProperties": # Object with schema name: Schema # Optional. Can either be a boolean or an object, controls the presence of additional properties. + "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. + # Object with schema name: Schema + ], + "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: Schema + }, + "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", + ], + "items": # Object with schema name: Schema # Optional. Schema of the elements of Type.ARRAY. + "maxItems": "A String", # Optional. Maximum number of the elements for Type.ARRAY. + "maximum": 3.14, # Optional. Maximum value for Type.INTEGER and Type.NUMBER. + "minItems": "A String", # Optional. Minimum number of the elements for Type.ARRAY. + "minimum": 3.14, # Optional. Minimum value for Type.INTEGER and Type.NUMBER. + "nullable": True or False, # Optional. Indicates if the value may be null. + "prefixItems": [ # Optional. Schemas of initial elements of Type.ARRAY. + # Object with schema name: Schema + ], + "properties": { # Optional. Properties of Type.OBJECT. + "a_key": # Object with schema name: Schema + }, + "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", # Required. The type of the data. + "uniqueItems": True or False, # Optional. Indicate the items in the array must be unique. Only applies to TYPE.ARRAY. + }, + }, + "tool": "A String", # Required. The original name of the tool as it is emitted by the MCP server. + }, + ], }, "name": "A String", # Identifier. The unique identifier of the toolset. Format: `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}` "openApiToolset": { # A toolset that contains a list of tools that are defined by an OpenAPI schema. # Optional. A toolset that contains a list of tools that are defined by an OpenAPI schema. @@ -330,6 +406,82 @@

Method Details

}, ], }, + "toolOverrides": [ # Optional. Overrides for individual tools within this toolset. This allows overriding specific details like descriptions, names, or pinning the tools' states so they aren't fully dynamic. + { # Overrides associated with a given tool in a Toolset. This enables "pinning" or "overriding" of tool definitions from the external dynamic server. + "descriptionOverride": "A String", # Optional. If present, this tool uses this description instead of the original description from the server. + "nameOverride": "A String", # Optional. If present, this tool uses this name in the Agent instead of the original name. This is primarily used as an alias if the MCP server offers poorly named tools. + "snapshot": { # Container for a tool's core definition elements that are snapshot. Schemas in the snapshot are used as-is and cannot be overridden. # Output only. If present, this tool is "Pinned" and uses the snapshot values as fallbacks if the server becomes temporarily unavailable or if no Override is present. + "description": "A String", # Output only. The description of the MCP tool. This can be overridden by `description_override` in `McpToolOverride`. + "inputSchema": { # Represents a select subset of an OpenAPI 3.0 schema object. # Output only. The schema of the input arguments of the MCP tool. + "additionalProperties": # Object with schema name: Schema # Optional. Can either be a boolean or an object, controls the presence of additional properties. + "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. + # Object with schema name: Schema + ], + "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: Schema + }, + "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", + ], + "items": # Object with schema name: Schema # Optional. Schema of the elements of Type.ARRAY. + "maxItems": "A String", # Optional. Maximum number of the elements for Type.ARRAY. + "maximum": 3.14, # Optional. Maximum value for Type.INTEGER and Type.NUMBER. + "minItems": "A String", # Optional. Minimum number of the elements for Type.ARRAY. + "minimum": 3.14, # Optional. Minimum value for Type.INTEGER and Type.NUMBER. + "nullable": True or False, # Optional. Indicates if the value may be null. + "prefixItems": [ # Optional. Schemas of initial elements of Type.ARRAY. + # Object with schema name: Schema + ], + "properties": { # Optional. Properties of Type.OBJECT. + "a_key": # Object with schema name: Schema + }, + "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", # Required. The type of the data. + "uniqueItems": True or False, # Optional. Indicate the items in the array must be unique. Only applies to TYPE.ARRAY. + }, + "outputSchema": { # Represents a select subset of an OpenAPI 3.0 schema object. # Output only. The schema of the output arguments of the MCP tool. + "additionalProperties": # Object with schema name: Schema # Optional. Can either be a boolean or an object, controls the presence of additional properties. + "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. + # Object with schema name: Schema + ], + "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: Schema + }, + "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", + ], + "items": # Object with schema name: Schema # Optional. Schema of the elements of Type.ARRAY. + "maxItems": "A String", # Optional. Maximum number of the elements for Type.ARRAY. + "maximum": 3.14, # Optional. Maximum value for Type.INTEGER and Type.NUMBER. + "minItems": "A String", # Optional. Minimum number of the elements for Type.ARRAY. + "minimum": 3.14, # Optional. Minimum value for Type.INTEGER and Type.NUMBER. + "nullable": True or False, # Optional. Indicates if the value may be null. + "prefixItems": [ # Optional. Schemas of initial elements of Type.ARRAY. + # Object with schema name: Schema + ], + "properties": { # Optional. Properties of Type.OBJECT. + "a_key": # Object with schema name: Schema + }, + "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", # Required. The type of the data. + "uniqueItems": True or False, # Optional. Indicate the items in the array must be unique. Only applies to TYPE.ARRAY. + }, + }, + "tool": "A String", # Required. The original name of the tool as it is emitted by the MCP server. + }, + ], }, "name": "A String", # Identifier. The unique identifier of the toolset. Format: `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}` "openApiToolset": { # A toolset that contains a list of tools that are defined by an OpenAPI schema. # Optional. A toolset that contains a list of tools that are defined by an OpenAPI schema. @@ -496,6 +648,82 @@

Method Details

}, ], }, + "toolOverrides": [ # Optional. Overrides for individual tools within this toolset. This allows overriding specific details like descriptions, names, or pinning the tools' states so they aren't fully dynamic. + { # Overrides associated with a given tool in a Toolset. This enables "pinning" or "overriding" of tool definitions from the external dynamic server. + "descriptionOverride": "A String", # Optional. If present, this tool uses this description instead of the original description from the server. + "nameOverride": "A String", # Optional. If present, this tool uses this name in the Agent instead of the original name. This is primarily used as an alias if the MCP server offers poorly named tools. + "snapshot": { # Container for a tool's core definition elements that are snapshot. Schemas in the snapshot are used as-is and cannot be overridden. # Output only. If present, this tool is "Pinned" and uses the snapshot values as fallbacks if the server becomes temporarily unavailable or if no Override is present. + "description": "A String", # Output only. The description of the MCP tool. This can be overridden by `description_override` in `McpToolOverride`. + "inputSchema": { # Represents a select subset of an OpenAPI 3.0 schema object. # Output only. The schema of the input arguments of the MCP tool. + "additionalProperties": # Object with schema name: Schema # Optional. Can either be a boolean or an object, controls the presence of additional properties. + "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. + # Object with schema name: Schema + ], + "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: Schema + }, + "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", + ], + "items": # Object with schema name: Schema # Optional. Schema of the elements of Type.ARRAY. + "maxItems": "A String", # Optional. Maximum number of the elements for Type.ARRAY. + "maximum": 3.14, # Optional. Maximum value for Type.INTEGER and Type.NUMBER. + "minItems": "A String", # Optional. Minimum number of the elements for Type.ARRAY. + "minimum": 3.14, # Optional. Minimum value for Type.INTEGER and Type.NUMBER. + "nullable": True or False, # Optional. Indicates if the value may be null. + "prefixItems": [ # Optional. Schemas of initial elements of Type.ARRAY. + # Object with schema name: Schema + ], + "properties": { # Optional. Properties of Type.OBJECT. + "a_key": # Object with schema name: Schema + }, + "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", # Required. The type of the data. + "uniqueItems": True or False, # Optional. Indicate the items in the array must be unique. Only applies to TYPE.ARRAY. + }, + "outputSchema": { # Represents a select subset of an OpenAPI 3.0 schema object. # Output only. The schema of the output arguments of the MCP tool. + "additionalProperties": # Object with schema name: Schema # Optional. Can either be a boolean or an object, controls the presence of additional properties. + "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. + # Object with schema name: Schema + ], + "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: Schema + }, + "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", + ], + "items": # Object with schema name: Schema # Optional. Schema of the elements of Type.ARRAY. + "maxItems": "A String", # Optional. Maximum number of the elements for Type.ARRAY. + "maximum": 3.14, # Optional. Maximum value for Type.INTEGER and Type.NUMBER. + "minItems": "A String", # Optional. Minimum number of the elements for Type.ARRAY. + "minimum": 3.14, # Optional. Minimum value for Type.INTEGER and Type.NUMBER. + "nullable": True or False, # Optional. Indicates if the value may be null. + "prefixItems": [ # Optional. Schemas of initial elements of Type.ARRAY. + # Object with schema name: Schema + ], + "properties": { # Optional. Properties of Type.OBJECT. + "a_key": # Object with schema name: Schema + }, + "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", # Required. The type of the data. + "uniqueItems": True or False, # Optional. Indicate the items in the array must be unique. Only applies to TYPE.ARRAY. + }, + }, + "tool": "A String", # Required. The original name of the tool as it is emitted by the MCP server. + }, + ], }, "name": "A String", # Identifier. The unique identifier of the toolset. Format: `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}` "openApiToolset": { # A toolset that contains a list of tools that are defined by an OpenAPI schema. # Optional. A toolset that contains a list of tools that are defined by an OpenAPI schema. @@ -649,6 +877,82 @@

Method Details

}, ], }, + "toolOverrides": [ # Optional. Overrides for individual tools within this toolset. This allows overriding specific details like descriptions, names, or pinning the tools' states so they aren't fully dynamic. + { # Overrides associated with a given tool in a Toolset. This enables "pinning" or "overriding" of tool definitions from the external dynamic server. + "descriptionOverride": "A String", # Optional. If present, this tool uses this description instead of the original description from the server. + "nameOverride": "A String", # Optional. If present, this tool uses this name in the Agent instead of the original name. This is primarily used as an alias if the MCP server offers poorly named tools. + "snapshot": { # Container for a tool's core definition elements that are snapshot. Schemas in the snapshot are used as-is and cannot be overridden. # Output only. If present, this tool is "Pinned" and uses the snapshot values as fallbacks if the server becomes temporarily unavailable or if no Override is present. + "description": "A String", # Output only. The description of the MCP tool. This can be overridden by `description_override` in `McpToolOverride`. + "inputSchema": { # Represents a select subset of an OpenAPI 3.0 schema object. # Output only. The schema of the input arguments of the MCP tool. + "additionalProperties": # Object with schema name: Schema # Optional. Can either be a boolean or an object, controls the presence of additional properties. + "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. + # Object with schema name: Schema + ], + "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: Schema + }, + "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", + ], + "items": # Object with schema name: Schema # Optional. Schema of the elements of Type.ARRAY. + "maxItems": "A String", # Optional. Maximum number of the elements for Type.ARRAY. + "maximum": 3.14, # Optional. Maximum value for Type.INTEGER and Type.NUMBER. + "minItems": "A String", # Optional. Minimum number of the elements for Type.ARRAY. + "minimum": 3.14, # Optional. Minimum value for Type.INTEGER and Type.NUMBER. + "nullable": True or False, # Optional. Indicates if the value may be null. + "prefixItems": [ # Optional. Schemas of initial elements of Type.ARRAY. + # Object with schema name: Schema + ], + "properties": { # Optional. Properties of Type.OBJECT. + "a_key": # Object with schema name: Schema + }, + "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", # Required. The type of the data. + "uniqueItems": True or False, # Optional. Indicate the items in the array must be unique. Only applies to TYPE.ARRAY. + }, + "outputSchema": { # Represents a select subset of an OpenAPI 3.0 schema object. # Output only. The schema of the output arguments of the MCP tool. + "additionalProperties": # Object with schema name: Schema # Optional. Can either be a boolean or an object, controls the presence of additional properties. + "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. + # Object with schema name: Schema + ], + "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: Schema + }, + "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", + ], + "items": # Object with schema name: Schema # Optional. Schema of the elements of Type.ARRAY. + "maxItems": "A String", # Optional. Maximum number of the elements for Type.ARRAY. + "maximum": 3.14, # Optional. Maximum value for Type.INTEGER and Type.NUMBER. + "minItems": "A String", # Optional. Minimum number of the elements for Type.ARRAY. + "minimum": 3.14, # Optional. Minimum value for Type.INTEGER and Type.NUMBER. + "nullable": True or False, # Optional. Indicates if the value may be null. + "prefixItems": [ # Optional. Schemas of initial elements of Type.ARRAY. + # Object with schema name: Schema + ], + "properties": { # Optional. Properties of Type.OBJECT. + "a_key": # Object with schema name: Schema + }, + "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", # Required. The type of the data. + "uniqueItems": True or False, # Optional. Indicate the items in the array must be unique. Only applies to TYPE.ARRAY. + }, + }, + "tool": "A String", # Required. The original name of the tool as it is emitted by the MCP server. + }, + ], }, "name": "A String", # Identifier. The unique identifier of the toolset. Format: `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}` "openApiToolset": { # A toolset that contains a list of tools that are defined by an OpenAPI schema. # Optional. A toolset that contains a list of tools that are defined by an OpenAPI schema. @@ -806,6 +1110,82 @@

Method Details

}, ], }, + "toolOverrides": [ # Optional. Overrides for individual tools within this toolset. This allows overriding specific details like descriptions, names, or pinning the tools' states so they aren't fully dynamic. + { # Overrides associated with a given tool in a Toolset. This enables "pinning" or "overriding" of tool definitions from the external dynamic server. + "descriptionOverride": "A String", # Optional. If present, this tool uses this description instead of the original description from the server. + "nameOverride": "A String", # Optional. If present, this tool uses this name in the Agent instead of the original name. This is primarily used as an alias if the MCP server offers poorly named tools. + "snapshot": { # Container for a tool's core definition elements that are snapshot. Schemas in the snapshot are used as-is and cannot be overridden. # Output only. If present, this tool is "Pinned" and uses the snapshot values as fallbacks if the server becomes temporarily unavailable or if no Override is present. + "description": "A String", # Output only. The description of the MCP tool. This can be overridden by `description_override` in `McpToolOverride`. + "inputSchema": { # Represents a select subset of an OpenAPI 3.0 schema object. # Output only. The schema of the input arguments of the MCP tool. + "additionalProperties": # Object with schema name: Schema # Optional. Can either be a boolean or an object, controls the presence of additional properties. + "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. + # Object with schema name: Schema + ], + "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: Schema + }, + "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", + ], + "items": # Object with schema name: Schema # Optional. Schema of the elements of Type.ARRAY. + "maxItems": "A String", # Optional. Maximum number of the elements for Type.ARRAY. + "maximum": 3.14, # Optional. Maximum value for Type.INTEGER and Type.NUMBER. + "minItems": "A String", # Optional. Minimum number of the elements for Type.ARRAY. + "minimum": 3.14, # Optional. Minimum value for Type.INTEGER and Type.NUMBER. + "nullable": True or False, # Optional. Indicates if the value may be null. + "prefixItems": [ # Optional. Schemas of initial elements of Type.ARRAY. + # Object with schema name: Schema + ], + "properties": { # Optional. Properties of Type.OBJECT. + "a_key": # Object with schema name: Schema + }, + "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", # Required. The type of the data. + "uniqueItems": True or False, # Optional. Indicate the items in the array must be unique. Only applies to TYPE.ARRAY. + }, + "outputSchema": { # Represents a select subset of an OpenAPI 3.0 schema object. # Output only. The schema of the output arguments of the MCP tool. + "additionalProperties": # Object with schema name: Schema # Optional. Can either be a boolean or an object, controls the presence of additional properties. + "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. + # Object with schema name: Schema + ], + "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: Schema + }, + "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", + ], + "items": # Object with schema name: Schema # Optional. Schema of the elements of Type.ARRAY. + "maxItems": "A String", # Optional. Maximum number of the elements for Type.ARRAY. + "maximum": 3.14, # Optional. Maximum value for Type.INTEGER and Type.NUMBER. + "minItems": "A String", # Optional. Minimum number of the elements for Type.ARRAY. + "minimum": 3.14, # Optional. Minimum value for Type.INTEGER and Type.NUMBER. + "nullable": True or False, # Optional. Indicates if the value may be null. + "prefixItems": [ # Optional. Schemas of initial elements of Type.ARRAY. + # Object with schema name: Schema + ], + "properties": { # Optional. Properties of Type.OBJECT. + "a_key": # Object with schema name: Schema + }, + "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", # Required. The type of the data. + "uniqueItems": True or False, # Optional. Indicate the items in the array must be unique. Only applies to TYPE.ARRAY. + }, + }, + "tool": "A String", # Required. The original name of the tool as it is emitted by the MCP server. + }, + ], }, "name": "A String", # Identifier. The unique identifier of the toolset. Format: `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}` "openApiToolset": { # A toolset that contains a list of tools that are defined by an OpenAPI schema. # Optional. A toolset that contains a list of tools that are defined by an OpenAPI schema. @@ -946,6 +1326,82 @@

Method Details

}, ], }, + "toolOverrides": [ # Optional. Overrides for individual tools within this toolset. This allows overriding specific details like descriptions, names, or pinning the tools' states so they aren't fully dynamic. + { # Overrides associated with a given tool in a Toolset. This enables "pinning" or "overriding" of tool definitions from the external dynamic server. + "descriptionOverride": "A String", # Optional. If present, this tool uses this description instead of the original description from the server. + "nameOverride": "A String", # Optional. If present, this tool uses this name in the Agent instead of the original name. This is primarily used as an alias if the MCP server offers poorly named tools. + "snapshot": { # Container for a tool's core definition elements that are snapshot. Schemas in the snapshot are used as-is and cannot be overridden. # Output only. If present, this tool is "Pinned" and uses the snapshot values as fallbacks if the server becomes temporarily unavailable or if no Override is present. + "description": "A String", # Output only. The description of the MCP tool. This can be overridden by `description_override` in `McpToolOverride`. + "inputSchema": { # Represents a select subset of an OpenAPI 3.0 schema object. # Output only. The schema of the input arguments of the MCP tool. + "additionalProperties": # Object with schema name: Schema # Optional. Can either be a boolean or an object, controls the presence of additional properties. + "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. + # Object with schema name: Schema + ], + "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: Schema + }, + "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", + ], + "items": # Object with schema name: Schema # Optional. Schema of the elements of Type.ARRAY. + "maxItems": "A String", # Optional. Maximum number of the elements for Type.ARRAY. + "maximum": 3.14, # Optional. Maximum value for Type.INTEGER and Type.NUMBER. + "minItems": "A String", # Optional. Minimum number of the elements for Type.ARRAY. + "minimum": 3.14, # Optional. Minimum value for Type.INTEGER and Type.NUMBER. + "nullable": True or False, # Optional. Indicates if the value may be null. + "prefixItems": [ # Optional. Schemas of initial elements of Type.ARRAY. + # Object with schema name: Schema + ], + "properties": { # Optional. Properties of Type.OBJECT. + "a_key": # Object with schema name: Schema + }, + "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", # Required. The type of the data. + "uniqueItems": True or False, # Optional. Indicate the items in the array must be unique. Only applies to TYPE.ARRAY. + }, + "outputSchema": { # Represents a select subset of an OpenAPI 3.0 schema object. # Output only. The schema of the output arguments of the MCP tool. + "additionalProperties": # Object with schema name: Schema # Optional. Can either be a boolean or an object, controls the presence of additional properties. + "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. + # Object with schema name: Schema + ], + "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: Schema + }, + "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", + ], + "items": # Object with schema name: Schema # Optional. Schema of the elements of Type.ARRAY. + "maxItems": "A String", # Optional. Maximum number of the elements for Type.ARRAY. + "maximum": 3.14, # Optional. Maximum value for Type.INTEGER and Type.NUMBER. + "minItems": "A String", # Optional. Minimum number of the elements for Type.ARRAY. + "minimum": 3.14, # Optional. Minimum value for Type.INTEGER and Type.NUMBER. + "nullable": True or False, # Optional. Indicates if the value may be null. + "prefixItems": [ # Optional. Schemas of initial elements of Type.ARRAY. + # Object with schema name: Schema + ], + "properties": { # Optional. Properties of Type.OBJECT. + "a_key": # Object with schema name: Schema + }, + "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", # Required. The type of the data. + "uniqueItems": True or False, # Optional. Indicate the items in the array must be unique. Only applies to TYPE.ARRAY. + }, + }, + "tool": "A String", # Required. The original name of the tool as it is emitted by the MCP server. + }, + ], }, "name": "A String", # Identifier. The unique identifier of the toolset. Format: `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}` "openApiToolset": { # A toolset that contains a list of tools that are defined by an OpenAPI schema. # Optional. A toolset that contains a list of tools that are defined by an OpenAPI schema. @@ -1011,6 +1467,7 @@

Method Details

The object takes the form of: { # Request message for ToolService.RetrieveTools. + "bypassPersistenceConfig": True or False, # Optional. If true, the returned tools will contain raw descriptions and schemas directly from the server, bypassing any stored persistence configurations (overrides/snapshots). "toolIds": [ # Optional. The identifiers of the tools to retrieve from the toolset. If empty, all tools in the toolset will be returned. "A String", ], @@ -1319,6 +1776,7 @@

Method Details

"uniqueItems": True or False, # Optional. Indicate the items in the array must be unique. Only applies to TYPE.ARRAY. }, "name": "A String", # Required. The name of the MCP tool. + "nameOverride": "A String", # Optional. The name override of the MCP tool. This is populated if the name was overridden by a Toolset override. "outputSchema": { # Represents a select subset of an OpenAPI 3.0 schema object. # Optional. The schema of the output arguments of the MCP tool. "additionalProperties": # Object with schema name: Schema # Optional. Can either be a boolean or an object, controls the presence of additional properties. "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. @@ -1356,6 +1814,7 @@

Method Details

"serviceDirectoryConfig": { # Configuration for tools using Service Directory. # Optional. Service Directory configuration for VPC-SC, used to resolve service names within a perimeter. "service": "A String", # Required. The name of [Service Directory](https://cloud.google.com/service-directory) service. Format: `projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}`. Location of the service directory must be the same as the location of the app. }, + "state": "A String", # Output only. The dynamic availability state of the tool on the external server. "tlsConfig": { # The TLS configuration. # Optional. The TLS configuration. Includes the custom server certificates that the client should trust. "caCerts": [ # Required. Specifies a list of allowed custom CA certificates for HTTPS verification. { # The CA certificate. @@ -1415,6 +1874,9 @@

Method Details

"description": "A String", # Output only. The description of the Python function, parsed from the python code's docstring. "name": "A String", # Optional. The name of the Python function to execute. Must match a Python function name defined in the python code. Case sensitive. If the name is not provided, the first function defined in the python code will be used. "pythonCode": "A String", # Optional. The Python code to execute for the tool. + "serviceDirectoryConfig": { # Configuration for tools using Service Directory. # Optional. Service Directory configuration for the tool. + "service": "A String", # Required. The name of [Service Directory](https://cloud.google.com/service-directory) service. Format: `projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}`. Location of the service directory must be the same as the location of the app. + }, }, "remoteAgentTool": { # Represents a tool that allows the agent to call another remote agent. # Optional. The remote agent tool. "agentCard": { # AgentCard conveys key information about a remote agent. It is a trimmed version of the AgentCard defined in the A2A protocol https://a2a-protocol.org/dev/specification/#441-agentcard # Required. The agent card of the remote agent that this tool invokes. @@ -1474,6 +1936,9 @@

Method Details

"description": "A String", # Output only. The description of the Python function, parsed from the python code's docstring. "name": "A String", # Optional. The name of the Python function to execute. Must match a Python function name defined in the python code. Case sensitive. If the name is not provided, the first function defined in the python code will be used. "pythonCode": "A String", # Optional. The Python code to execute for the tool. + "serviceDirectoryConfig": { # Configuration for tools using Service Directory. # Optional. Service Directory configuration for the tool. + "service": "A String", # Required. The name of [Service Directory](https://cloud.google.com/service-directory) service. Format: `projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}`. Location of the service directory must be the same as the location of the app. + }, }, "pythonScript": "A String", # Deprecated: Use `python_function` instead. "sourceToolName": "A String", # Optional. The resource name of the tool that provides the data for the widget (e.g., a search tool or a custom function). Format: `projects/{project}/locations/{location}/agents/{agent}/tools/{tool}` diff --git a/docs/dyn/ces_v1beta.projects.locations.apps.versions.html b/docs/dyn/ces_v1beta.projects.locations.apps.versions.html index fb79646571..3dab947b2d 100644 --- a/docs/dyn/ces_v1beta.projects.locations.apps.versions.html +++ b/docs/dyn/ces_v1beta.projects.locations.apps.versions.html @@ -194,6 +194,7 @@

Method Details

"inputVariableMapping": { # Optional. The mapping of the app variables names to the Dialogflow session parameters names to be sent to the Dialogflow agent as input. "a_key": "A String", }, + "languageCodeVariable": "A String", # Optional. The name of the variable that contains the language code to be used for the Dialogflow session. If unspecified, the default language code of the Dialogflow agent will be used. "outputVariableMapping": { # Optional. The mapping of the Dialogflow session parameters names to the app variables names to be sent back to the CES agent after the Dialogflow agent execution ends. "a_key": "A String", }, @@ -380,11 +381,11 @@

Method Details

}, "locked": True or False, # Optional. Indicates whether the app is locked for changes. If the app is locked, modifications to the app resources will be rejected. "loggingSettings": { # Settings to describe the logging behaviors for the app. # Optional. Logging settings of the app. - "audioRecordingConfig": { # Configuration for how the audio interactions should be recorded. # Optional. Configuration for how audio interactions should be recorded. + "audioRecordingConfig": { # Configuration for how the audio interactions should be recorded. # Optional. Configuration for how audio interactions should be recorded. The audio is subject to redaction as configured in RedactionConfig. "gcsBucket": "A String", # Optional. The [Cloud Storage](https://cloud.google.com/storage) bucket to store the session audio recordings. The URI must start with "gs://". Please choose a bucket location that meets your data residency requirements. Note: If the Cloud Storage bucket is in a different project from the app, you should grant `storage.objects.create` permission to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`. "gcsPathPrefix": "A String", # Optional. The Cloud Storage path prefix for audio recordings. This prefix can include the following placeholders, which will be dynamically substituted at serving time: - $project: project ID - $location: app location - $app: app ID - $date: session date in YYYY-MM-DD format - $session: session ID If the path prefix is not specified, the default prefix `$project/$location/$app/$date/$session/` will be used. }, - "bigqueryExportSettings": { # Settings to describe the BigQuery export behaviors for the app. # Optional. Settings to describe the BigQuery export behaviors for the app. The conversation data will be exported to BigQuery tables if it is enabled. + "bigqueryExportSettings": { # Settings to describe the BigQuery export behaviors for the app. # Optional. Configures the BigQuery export behaviors for the app. The conversation data is subject to redaction as configured in RedactionConfig. "dataset": "A String", # Optional. The BigQuery **dataset ID** to export the data to. "enabled": True or False, # Optional. Indicates whether the BigQuery export is enabled. "project": "A String", # Optional. The **project ID** of the BigQuery dataset to export the data to. Note: If the BigQuery dataset is in a different project from the app, you should grant `roles/bigquery.admin` role to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`. @@ -408,7 +409,7 @@

Method Details

"enableRedaction": True or False, # Optional. If true, redaction will be applied in various logging scenarios, including conversation history, Cloud Logging and audio recording. "inspectTemplate": "A String", # Optional. [DLP](https://cloud.google.com/dlp/docs) inspect template name to configure detection of sensitive data types. Format: `projects/{project}/locations/{location}/inspectTemplates/{inspect_template}` }, - "unredactedAudioRecordingConfig": { # Configuration for how the audio interactions should be recorded. # Optional. Configures recording of unredacted audio. Use this to maintain a raw backup with restricted access when audio redaction is enabled, typically for auditing or monitoring purposes. + "unredactedAudioRecordingConfig": { # Configuration for how the audio interactions should be recorded. # Optional. Configures an additional recording of unredacted audio. This can be used to maintain a raw audio copy when audio redaction is enabled, typically for auditing or monitoring purposes. "gcsBucket": "A String", # Optional. The [Cloud Storage](https://cloud.google.com/storage) bucket to store the session audio recordings. The URI must start with "gs://". Please choose a bucket location that meets your data residency requirements. Note: If the Cloud Storage bucket is in a different project from the app, you should grant `storage.objects.create` permission to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`. "gcsPathPrefix": "A String", # Optional. The Cloud Storage path prefix for audio recordings. This prefix can include the following placeholders, which will be dynamically substituted at serving time: - $project: project ID - $location: app location - $app: app ID - $date: session date in YYYY-MM-DD format - $session: session ID If the path prefix is not specified, the default prefix `$project/$location/$app/$date/$session/` will be used. }, @@ -980,6 +981,7 @@

Method Details

"uniqueItems": True or False, # Optional. Indicate the items in the array must be unique. Only applies to TYPE.ARRAY. }, "name": "A String", # Required. The name of the MCP tool. + "nameOverride": "A String", # Optional. The name override of the MCP tool. This is populated if the name was overridden by a Toolset override. "outputSchema": { # Represents a select subset of an OpenAPI 3.0 schema object. # Optional. The schema of the output arguments of the MCP tool. "additionalProperties": # Object with schema name: Schema # Optional. Can either be a boolean or an object, controls the presence of additional properties. "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. @@ -1017,6 +1019,7 @@

Method Details

"serviceDirectoryConfig": { # Configuration for tools using Service Directory. # Optional. Service Directory configuration for VPC-SC, used to resolve service names within a perimeter. "service": "A String", # Required. The name of [Service Directory](https://cloud.google.com/service-directory) service. Format: `projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}`. Location of the service directory must be the same as the location of the app. }, + "state": "A String", # Output only. The dynamic availability state of the tool on the external server. "tlsConfig": { # The TLS configuration. # Optional. The TLS configuration. Includes the custom server certificates that the client should trust. "caCerts": [ # Required. Specifies a list of allowed custom CA certificates for HTTPS verification. { # The CA certificate. @@ -1076,6 +1079,9 @@

Method Details

"description": "A String", # Output only. The description of the Python function, parsed from the python code's docstring. "name": "A String", # Optional. The name of the Python function to execute. Must match a Python function name defined in the python code. Case sensitive. If the name is not provided, the first function defined in the python code will be used. "pythonCode": "A String", # Optional. The Python code to execute for the tool. + "serviceDirectoryConfig": { # Configuration for tools using Service Directory. # Optional. Service Directory configuration for the tool. + "service": "A String", # Required. The name of [Service Directory](https://cloud.google.com/service-directory) service. Format: `projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}`. Location of the service directory must be the same as the location of the app. + }, }, "remoteAgentTool": { # Represents a tool that allows the agent to call another remote agent. # Optional. The remote agent tool. "agentCard": { # AgentCard conveys key information about a remote agent. It is a trimmed version of the AgentCard defined in the A2A protocol https://a2a-protocol.org/dev/specification/#441-agentcard # Required. The agent card of the remote agent that this tool invokes. @@ -1135,6 +1141,9 @@

Method Details

"description": "A String", # Output only. The description of the Python function, parsed from the python code's docstring. "name": "A String", # Optional. The name of the Python function to execute. Must match a Python function name defined in the python code. Case sensitive. If the name is not provided, the first function defined in the python code will be used. "pythonCode": "A String", # Optional. The Python code to execute for the tool. + "serviceDirectoryConfig": { # Configuration for tools using Service Directory. # Optional. Service Directory configuration for the tool. + "service": "A String", # Required. The name of [Service Directory](https://cloud.google.com/service-directory) service. Format: `projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}`. Location of the service directory must be the same as the location of the app. + }, }, "pythonScript": "A String", # Deprecated: Use `python_function` instead. "sourceToolName": "A String", # Optional. The resource name of the tool that provides the data for the widget (e.g., a search tool or a custom function). Format: `projects/{project}/locations/{location}/agents/{agent}/tools/{tool}` @@ -1264,6 +1273,82 @@

Method Details

}, ], }, + "toolOverrides": [ # Optional. Overrides for individual tools within this toolset. This allows overriding specific details like descriptions, names, or pinning the tools' states so they aren't fully dynamic. + { # Overrides associated with a given tool in a Toolset. This enables "pinning" or "overriding" of tool definitions from the external dynamic server. + "descriptionOverride": "A String", # Optional. If present, this tool uses this description instead of the original description from the server. + "nameOverride": "A String", # Optional. If present, this tool uses this name in the Agent instead of the original name. This is primarily used as an alias if the MCP server offers poorly named tools. + "snapshot": { # Container for a tool's core definition elements that are snapshot. Schemas in the snapshot are used as-is and cannot be overridden. # Output only. If present, this tool is "Pinned" and uses the snapshot values as fallbacks if the server becomes temporarily unavailable or if no Override is present. + "description": "A String", # Output only. The description of the MCP tool. This can be overridden by `description_override` in `McpToolOverride`. + "inputSchema": { # Represents a select subset of an OpenAPI 3.0 schema object. # Output only. The schema of the input arguments of the MCP tool. + "additionalProperties": # Object with schema name: Schema # Optional. Can either be a boolean or an object, controls the presence of additional properties. + "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. + # Object with schema name: Schema + ], + "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: Schema + }, + "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", + ], + "items": # Object with schema name: Schema # Optional. Schema of the elements of Type.ARRAY. + "maxItems": "A String", # Optional. Maximum number of the elements for Type.ARRAY. + "maximum": 3.14, # Optional. Maximum value for Type.INTEGER and Type.NUMBER. + "minItems": "A String", # Optional. Minimum number of the elements for Type.ARRAY. + "minimum": 3.14, # Optional. Minimum value for Type.INTEGER and Type.NUMBER. + "nullable": True or False, # Optional. Indicates if the value may be null. + "prefixItems": [ # Optional. Schemas of initial elements of Type.ARRAY. + # Object with schema name: Schema + ], + "properties": { # Optional. Properties of Type.OBJECT. + "a_key": # Object with schema name: Schema + }, + "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", # Required. The type of the data. + "uniqueItems": True or False, # Optional. Indicate the items in the array must be unique. Only applies to TYPE.ARRAY. + }, + "outputSchema": { # Represents a select subset of an OpenAPI 3.0 schema object. # Output only. The schema of the output arguments of the MCP tool. + "additionalProperties": # Object with schema name: Schema # Optional. Can either be a boolean or an object, controls the presence of additional properties. + "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. + # Object with schema name: Schema + ], + "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: Schema + }, + "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", + ], + "items": # Object with schema name: Schema # Optional. Schema of the elements of Type.ARRAY. + "maxItems": "A String", # Optional. Maximum number of the elements for Type.ARRAY. + "maximum": 3.14, # Optional. Maximum value for Type.INTEGER and Type.NUMBER. + "minItems": "A String", # Optional. Minimum number of the elements for Type.ARRAY. + "minimum": 3.14, # Optional. Minimum value for Type.INTEGER and Type.NUMBER. + "nullable": True or False, # Optional. Indicates if the value may be null. + "prefixItems": [ # Optional. Schemas of initial elements of Type.ARRAY. + # Object with schema name: Schema + ], + "properties": { # Optional. Properties of Type.OBJECT. + "a_key": # Object with schema name: Schema + }, + "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", # Required. The type of the data. + "uniqueItems": True or False, # Optional. Indicate the items in the array must be unique. Only applies to TYPE.ARRAY. + }, + }, + "tool": "A String", # Required. The original name of the tool as it is emitted by the MCP server. + }, + ], }, "name": "A String", # Identifier. The unique identifier of the toolset. Format: `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}` "openApiToolset": { # A toolset that contains a list of tools that are defined by an OpenAPI schema. # Optional. A toolset that contains a list of tools that are defined by an OpenAPI schema. @@ -1414,6 +1499,7 @@

Method Details

"inputVariableMapping": { # Optional. The mapping of the app variables names to the Dialogflow session parameters names to be sent to the Dialogflow agent as input. "a_key": "A String", }, + "languageCodeVariable": "A String", # Optional. The name of the variable that contains the language code to be used for the Dialogflow session. If unspecified, the default language code of the Dialogflow agent will be used. "outputVariableMapping": { # Optional. The mapping of the Dialogflow session parameters names to the app variables names to be sent back to the CES agent after the Dialogflow agent execution ends. "a_key": "A String", }, @@ -1600,11 +1686,11 @@

Method Details

}, "locked": True or False, # Optional. Indicates whether the app is locked for changes. If the app is locked, modifications to the app resources will be rejected. "loggingSettings": { # Settings to describe the logging behaviors for the app. # Optional. Logging settings of the app. - "audioRecordingConfig": { # Configuration for how the audio interactions should be recorded. # Optional. Configuration for how audio interactions should be recorded. + "audioRecordingConfig": { # Configuration for how the audio interactions should be recorded. # Optional. Configuration for how audio interactions should be recorded. The audio is subject to redaction as configured in RedactionConfig. "gcsBucket": "A String", # Optional. The [Cloud Storage](https://cloud.google.com/storage) bucket to store the session audio recordings. The URI must start with "gs://". Please choose a bucket location that meets your data residency requirements. Note: If the Cloud Storage bucket is in a different project from the app, you should grant `storage.objects.create` permission to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`. "gcsPathPrefix": "A String", # Optional. The Cloud Storage path prefix for audio recordings. This prefix can include the following placeholders, which will be dynamically substituted at serving time: - $project: project ID - $location: app location - $app: app ID - $date: session date in YYYY-MM-DD format - $session: session ID If the path prefix is not specified, the default prefix `$project/$location/$app/$date/$session/` will be used. }, - "bigqueryExportSettings": { # Settings to describe the BigQuery export behaviors for the app. # Optional. Settings to describe the BigQuery export behaviors for the app. The conversation data will be exported to BigQuery tables if it is enabled. + "bigqueryExportSettings": { # Settings to describe the BigQuery export behaviors for the app. # Optional. Configures the BigQuery export behaviors for the app. The conversation data is subject to redaction as configured in RedactionConfig. "dataset": "A String", # Optional. The BigQuery **dataset ID** to export the data to. "enabled": True or False, # Optional. Indicates whether the BigQuery export is enabled. "project": "A String", # Optional. The **project ID** of the BigQuery dataset to export the data to. Note: If the BigQuery dataset is in a different project from the app, you should grant `roles/bigquery.admin` role to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`. @@ -1628,7 +1714,7 @@

Method Details

"enableRedaction": True or False, # Optional. If true, redaction will be applied in various logging scenarios, including conversation history, Cloud Logging and audio recording. "inspectTemplate": "A String", # Optional. [DLP](https://cloud.google.com/dlp/docs) inspect template name to configure detection of sensitive data types. Format: `projects/{project}/locations/{location}/inspectTemplates/{inspect_template}` }, - "unredactedAudioRecordingConfig": { # Configuration for how the audio interactions should be recorded. # Optional. Configures recording of unredacted audio. Use this to maintain a raw backup with restricted access when audio redaction is enabled, typically for auditing or monitoring purposes. + "unredactedAudioRecordingConfig": { # Configuration for how the audio interactions should be recorded. # Optional. Configures an additional recording of unredacted audio. This can be used to maintain a raw audio copy when audio redaction is enabled, typically for auditing or monitoring purposes. "gcsBucket": "A String", # Optional. The [Cloud Storage](https://cloud.google.com/storage) bucket to store the session audio recordings. The URI must start with "gs://". Please choose a bucket location that meets your data residency requirements. Note: If the Cloud Storage bucket is in a different project from the app, you should grant `storage.objects.create` permission to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`. "gcsPathPrefix": "A String", # Optional. The Cloud Storage path prefix for audio recordings. This prefix can include the following placeholders, which will be dynamically substituted at serving time: - $project: project ID - $location: app location - $app: app ID - $date: session date in YYYY-MM-DD format - $session: session ID If the path prefix is not specified, the default prefix `$project/$location/$app/$date/$session/` will be used. }, @@ -2200,6 +2286,7 @@

Method Details

"uniqueItems": True or False, # Optional. Indicate the items in the array must be unique. Only applies to TYPE.ARRAY. }, "name": "A String", # Required. The name of the MCP tool. + "nameOverride": "A String", # Optional. The name override of the MCP tool. This is populated if the name was overridden by a Toolset override. "outputSchema": { # Represents a select subset of an OpenAPI 3.0 schema object. # Optional. The schema of the output arguments of the MCP tool. "additionalProperties": # Object with schema name: Schema # Optional. Can either be a boolean or an object, controls the presence of additional properties. "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. @@ -2237,6 +2324,7 @@

Method Details

"serviceDirectoryConfig": { # Configuration for tools using Service Directory. # Optional. Service Directory configuration for VPC-SC, used to resolve service names within a perimeter. "service": "A String", # Required. The name of [Service Directory](https://cloud.google.com/service-directory) service. Format: `projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}`. Location of the service directory must be the same as the location of the app. }, + "state": "A String", # Output only. The dynamic availability state of the tool on the external server. "tlsConfig": { # The TLS configuration. # Optional. The TLS configuration. Includes the custom server certificates that the client should trust. "caCerts": [ # Required. Specifies a list of allowed custom CA certificates for HTTPS verification. { # The CA certificate. @@ -2296,6 +2384,9 @@

Method Details

"description": "A String", # Output only. The description of the Python function, parsed from the python code's docstring. "name": "A String", # Optional. The name of the Python function to execute. Must match a Python function name defined in the python code. Case sensitive. If the name is not provided, the first function defined in the python code will be used. "pythonCode": "A String", # Optional. The Python code to execute for the tool. + "serviceDirectoryConfig": { # Configuration for tools using Service Directory. # Optional. Service Directory configuration for the tool. + "service": "A String", # Required. The name of [Service Directory](https://cloud.google.com/service-directory) service. Format: `projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}`. Location of the service directory must be the same as the location of the app. + }, }, "remoteAgentTool": { # Represents a tool that allows the agent to call another remote agent. # Optional. The remote agent tool. "agentCard": { # AgentCard conveys key information about a remote agent. It is a trimmed version of the AgentCard defined in the A2A protocol https://a2a-protocol.org/dev/specification/#441-agentcard # Required. The agent card of the remote agent that this tool invokes. @@ -2355,6 +2446,9 @@

Method Details

"description": "A String", # Output only. The description of the Python function, parsed from the python code's docstring. "name": "A String", # Optional. The name of the Python function to execute. Must match a Python function name defined in the python code. Case sensitive. If the name is not provided, the first function defined in the python code will be used. "pythonCode": "A String", # Optional. The Python code to execute for the tool. + "serviceDirectoryConfig": { # Configuration for tools using Service Directory. # Optional. Service Directory configuration for the tool. + "service": "A String", # Required. The name of [Service Directory](https://cloud.google.com/service-directory) service. Format: `projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}`. Location of the service directory must be the same as the location of the app. + }, }, "pythonScript": "A String", # Deprecated: Use `python_function` instead. "sourceToolName": "A String", # Optional. The resource name of the tool that provides the data for the widget (e.g., a search tool or a custom function). Format: `projects/{project}/locations/{location}/agents/{agent}/tools/{tool}` @@ -2484,6 +2578,82 @@

Method Details

}, ], }, + "toolOverrides": [ # Optional. Overrides for individual tools within this toolset. This allows overriding specific details like descriptions, names, or pinning the tools' states so they aren't fully dynamic. + { # Overrides associated with a given tool in a Toolset. This enables "pinning" or "overriding" of tool definitions from the external dynamic server. + "descriptionOverride": "A String", # Optional. If present, this tool uses this description instead of the original description from the server. + "nameOverride": "A String", # Optional. If present, this tool uses this name in the Agent instead of the original name. This is primarily used as an alias if the MCP server offers poorly named tools. + "snapshot": { # Container for a tool's core definition elements that are snapshot. Schemas in the snapshot are used as-is and cannot be overridden. # Output only. If present, this tool is "Pinned" and uses the snapshot values as fallbacks if the server becomes temporarily unavailable or if no Override is present. + "description": "A String", # Output only. The description of the MCP tool. This can be overridden by `description_override` in `McpToolOverride`. + "inputSchema": { # Represents a select subset of an OpenAPI 3.0 schema object. # Output only. The schema of the input arguments of the MCP tool. + "additionalProperties": # Object with schema name: Schema # Optional. Can either be a boolean or an object, controls the presence of additional properties. + "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. + # Object with schema name: Schema + ], + "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: Schema + }, + "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", + ], + "items": # Object with schema name: Schema # Optional. Schema of the elements of Type.ARRAY. + "maxItems": "A String", # Optional. Maximum number of the elements for Type.ARRAY. + "maximum": 3.14, # Optional. Maximum value for Type.INTEGER and Type.NUMBER. + "minItems": "A String", # Optional. Minimum number of the elements for Type.ARRAY. + "minimum": 3.14, # Optional. Minimum value for Type.INTEGER and Type.NUMBER. + "nullable": True or False, # Optional. Indicates if the value may be null. + "prefixItems": [ # Optional. Schemas of initial elements of Type.ARRAY. + # Object with schema name: Schema + ], + "properties": { # Optional. Properties of Type.OBJECT. + "a_key": # Object with schema name: Schema + }, + "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", # Required. The type of the data. + "uniqueItems": True or False, # Optional. Indicate the items in the array must be unique. Only applies to TYPE.ARRAY. + }, + "outputSchema": { # Represents a select subset of an OpenAPI 3.0 schema object. # Output only. The schema of the output arguments of the MCP tool. + "additionalProperties": # Object with schema name: Schema # Optional. Can either be a boolean or an object, controls the presence of additional properties. + "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. + # Object with schema name: Schema + ], + "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: Schema + }, + "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", + ], + "items": # Object with schema name: Schema # Optional. Schema of the elements of Type.ARRAY. + "maxItems": "A String", # Optional. Maximum number of the elements for Type.ARRAY. + "maximum": 3.14, # Optional. Maximum value for Type.INTEGER and Type.NUMBER. + "minItems": "A String", # Optional. Minimum number of the elements for Type.ARRAY. + "minimum": 3.14, # Optional. Minimum value for Type.INTEGER and Type.NUMBER. + "nullable": True or False, # Optional. Indicates if the value may be null. + "prefixItems": [ # Optional. Schemas of initial elements of Type.ARRAY. + # Object with schema name: Schema + ], + "properties": { # Optional. Properties of Type.OBJECT. + "a_key": # Object with schema name: Schema + }, + "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", # Required. The type of the data. + "uniqueItems": True or False, # Optional. Indicate the items in the array must be unique. Only applies to TYPE.ARRAY. + }, + }, + "tool": "A String", # Required. The original name of the tool as it is emitted by the MCP server. + }, + ], }, "name": "A String", # Identifier. The unique identifier of the toolset. Format: `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}` "openApiToolset": { # A toolset that contains a list of tools that are defined by an OpenAPI schema. # Optional. A toolset that contains a list of tools that are defined by an OpenAPI schema. @@ -2659,6 +2829,7 @@

Method Details

"inputVariableMapping": { # Optional. The mapping of the app variables names to the Dialogflow session parameters names to be sent to the Dialogflow agent as input. "a_key": "A String", }, + "languageCodeVariable": "A String", # Optional. The name of the variable that contains the language code to be used for the Dialogflow session. If unspecified, the default language code of the Dialogflow agent will be used. "outputVariableMapping": { # Optional. The mapping of the Dialogflow session parameters names to the app variables names to be sent back to the CES agent after the Dialogflow agent execution ends. "a_key": "A String", }, @@ -2845,11 +3016,11 @@

Method Details

}, "locked": True or False, # Optional. Indicates whether the app is locked for changes. If the app is locked, modifications to the app resources will be rejected. "loggingSettings": { # Settings to describe the logging behaviors for the app. # Optional. Logging settings of the app. - "audioRecordingConfig": { # Configuration for how the audio interactions should be recorded. # Optional. Configuration for how audio interactions should be recorded. + "audioRecordingConfig": { # Configuration for how the audio interactions should be recorded. # Optional. Configuration for how audio interactions should be recorded. The audio is subject to redaction as configured in RedactionConfig. "gcsBucket": "A String", # Optional. The [Cloud Storage](https://cloud.google.com/storage) bucket to store the session audio recordings. The URI must start with "gs://". Please choose a bucket location that meets your data residency requirements. Note: If the Cloud Storage bucket is in a different project from the app, you should grant `storage.objects.create` permission to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`. "gcsPathPrefix": "A String", # Optional. The Cloud Storage path prefix for audio recordings. This prefix can include the following placeholders, which will be dynamically substituted at serving time: - $project: project ID - $location: app location - $app: app ID - $date: session date in YYYY-MM-DD format - $session: session ID If the path prefix is not specified, the default prefix `$project/$location/$app/$date/$session/` will be used. }, - "bigqueryExportSettings": { # Settings to describe the BigQuery export behaviors for the app. # Optional. Settings to describe the BigQuery export behaviors for the app. The conversation data will be exported to BigQuery tables if it is enabled. + "bigqueryExportSettings": { # Settings to describe the BigQuery export behaviors for the app. # Optional. Configures the BigQuery export behaviors for the app. The conversation data is subject to redaction as configured in RedactionConfig. "dataset": "A String", # Optional. The BigQuery **dataset ID** to export the data to. "enabled": True or False, # Optional. Indicates whether the BigQuery export is enabled. "project": "A String", # Optional. The **project ID** of the BigQuery dataset to export the data to. Note: If the BigQuery dataset is in a different project from the app, you should grant `roles/bigquery.admin` role to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`. @@ -2873,7 +3044,7 @@

Method Details

"enableRedaction": True or False, # Optional. If true, redaction will be applied in various logging scenarios, including conversation history, Cloud Logging and audio recording. "inspectTemplate": "A String", # Optional. [DLP](https://cloud.google.com/dlp/docs) inspect template name to configure detection of sensitive data types. Format: `projects/{project}/locations/{location}/inspectTemplates/{inspect_template}` }, - "unredactedAudioRecordingConfig": { # Configuration for how the audio interactions should be recorded. # Optional. Configures recording of unredacted audio. Use this to maintain a raw backup with restricted access when audio redaction is enabled, typically for auditing or monitoring purposes. + "unredactedAudioRecordingConfig": { # Configuration for how the audio interactions should be recorded. # Optional. Configures an additional recording of unredacted audio. This can be used to maintain a raw audio copy when audio redaction is enabled, typically for auditing or monitoring purposes. "gcsBucket": "A String", # Optional. The [Cloud Storage](https://cloud.google.com/storage) bucket to store the session audio recordings. The URI must start with "gs://". Please choose a bucket location that meets your data residency requirements. Note: If the Cloud Storage bucket is in a different project from the app, you should grant `storage.objects.create` permission to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`. "gcsPathPrefix": "A String", # Optional. The Cloud Storage path prefix for audio recordings. This prefix can include the following placeholders, which will be dynamically substituted at serving time: - $project: project ID - $location: app location - $app: app ID - $date: session date in YYYY-MM-DD format - $session: session ID If the path prefix is not specified, the default prefix `$project/$location/$app/$date/$session/` will be used. }, @@ -3445,6 +3616,7 @@

Method Details

"uniqueItems": True or False, # Optional. Indicate the items in the array must be unique. Only applies to TYPE.ARRAY. }, "name": "A String", # Required. The name of the MCP tool. + "nameOverride": "A String", # Optional. The name override of the MCP tool. This is populated if the name was overridden by a Toolset override. "outputSchema": { # Represents a select subset of an OpenAPI 3.0 schema object. # Optional. The schema of the output arguments of the MCP tool. "additionalProperties": # Object with schema name: Schema # Optional. Can either be a boolean or an object, controls the presence of additional properties. "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. @@ -3482,6 +3654,7 @@

Method Details

"serviceDirectoryConfig": { # Configuration for tools using Service Directory. # Optional. Service Directory configuration for VPC-SC, used to resolve service names within a perimeter. "service": "A String", # Required. The name of [Service Directory](https://cloud.google.com/service-directory) service. Format: `projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}`. Location of the service directory must be the same as the location of the app. }, + "state": "A String", # Output only. The dynamic availability state of the tool on the external server. "tlsConfig": { # The TLS configuration. # Optional. The TLS configuration. Includes the custom server certificates that the client should trust. "caCerts": [ # Required. Specifies a list of allowed custom CA certificates for HTTPS verification. { # The CA certificate. @@ -3541,6 +3714,9 @@

Method Details

"description": "A String", # Output only. The description of the Python function, parsed from the python code's docstring. "name": "A String", # Optional. The name of the Python function to execute. Must match a Python function name defined in the python code. Case sensitive. If the name is not provided, the first function defined in the python code will be used. "pythonCode": "A String", # Optional. The Python code to execute for the tool. + "serviceDirectoryConfig": { # Configuration for tools using Service Directory. # Optional. Service Directory configuration for the tool. + "service": "A String", # Required. The name of [Service Directory](https://cloud.google.com/service-directory) service. Format: `projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}`. Location of the service directory must be the same as the location of the app. + }, }, "remoteAgentTool": { # Represents a tool that allows the agent to call another remote agent. # Optional. The remote agent tool. "agentCard": { # AgentCard conveys key information about a remote agent. It is a trimmed version of the AgentCard defined in the A2A protocol https://a2a-protocol.org/dev/specification/#441-agentcard # Required. The agent card of the remote agent that this tool invokes. @@ -3600,6 +3776,9 @@

Method Details

"description": "A String", # Output only. The description of the Python function, parsed from the python code's docstring. "name": "A String", # Optional. The name of the Python function to execute. Must match a Python function name defined in the python code. Case sensitive. If the name is not provided, the first function defined in the python code will be used. "pythonCode": "A String", # Optional. The Python code to execute for the tool. + "serviceDirectoryConfig": { # Configuration for tools using Service Directory. # Optional. Service Directory configuration for the tool. + "service": "A String", # Required. The name of [Service Directory](https://cloud.google.com/service-directory) service. Format: `projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}`. Location of the service directory must be the same as the location of the app. + }, }, "pythonScript": "A String", # Deprecated: Use `python_function` instead. "sourceToolName": "A String", # Optional. The resource name of the tool that provides the data for the widget (e.g., a search tool or a custom function). Format: `projects/{project}/locations/{location}/agents/{agent}/tools/{tool}` @@ -3729,6 +3908,82 @@

Method Details

}, ], }, + "toolOverrides": [ # Optional. Overrides for individual tools within this toolset. This allows overriding specific details like descriptions, names, or pinning the tools' states so they aren't fully dynamic. + { # Overrides associated with a given tool in a Toolset. This enables "pinning" or "overriding" of tool definitions from the external dynamic server. + "descriptionOverride": "A String", # Optional. If present, this tool uses this description instead of the original description from the server. + "nameOverride": "A String", # Optional. If present, this tool uses this name in the Agent instead of the original name. This is primarily used as an alias if the MCP server offers poorly named tools. + "snapshot": { # Container for a tool's core definition elements that are snapshot. Schemas in the snapshot are used as-is and cannot be overridden. # Output only. If present, this tool is "Pinned" and uses the snapshot values as fallbacks if the server becomes temporarily unavailable or if no Override is present. + "description": "A String", # Output only. The description of the MCP tool. This can be overridden by `description_override` in `McpToolOverride`. + "inputSchema": { # Represents a select subset of an OpenAPI 3.0 schema object. # Output only. The schema of the input arguments of the MCP tool. + "additionalProperties": # Object with schema name: Schema # Optional. Can either be a boolean or an object, controls the presence of additional properties. + "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. + # Object with schema name: Schema + ], + "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: Schema + }, + "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", + ], + "items": # Object with schema name: Schema # Optional. Schema of the elements of Type.ARRAY. + "maxItems": "A String", # Optional. Maximum number of the elements for Type.ARRAY. + "maximum": 3.14, # Optional. Maximum value for Type.INTEGER and Type.NUMBER. + "minItems": "A String", # Optional. Minimum number of the elements for Type.ARRAY. + "minimum": 3.14, # Optional. Minimum value for Type.INTEGER and Type.NUMBER. + "nullable": True or False, # Optional. Indicates if the value may be null. + "prefixItems": [ # Optional. Schemas of initial elements of Type.ARRAY. + # Object with schema name: Schema + ], + "properties": { # Optional. Properties of Type.OBJECT. + "a_key": # Object with schema name: Schema + }, + "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", # Required. The type of the data. + "uniqueItems": True or False, # Optional. Indicate the items in the array must be unique. Only applies to TYPE.ARRAY. + }, + "outputSchema": { # Represents a select subset of an OpenAPI 3.0 schema object. # Output only. The schema of the output arguments of the MCP tool. + "additionalProperties": # Object with schema name: Schema # Optional. Can either be a boolean or an object, controls the presence of additional properties. + "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. + # Object with schema name: Schema + ], + "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: Schema + }, + "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", + ], + "items": # Object with schema name: Schema # Optional. Schema of the elements of Type.ARRAY. + "maxItems": "A String", # Optional. Maximum number of the elements for Type.ARRAY. + "maximum": 3.14, # Optional. Maximum value for Type.INTEGER and Type.NUMBER. + "minItems": "A String", # Optional. Minimum number of the elements for Type.ARRAY. + "minimum": 3.14, # Optional. Minimum value for Type.INTEGER and Type.NUMBER. + "nullable": True or False, # Optional. Indicates if the value may be null. + "prefixItems": [ # Optional. Schemas of initial elements of Type.ARRAY. + # Object with schema name: Schema + ], + "properties": { # Optional. Properties of Type.OBJECT. + "a_key": # Object with schema name: Schema + }, + "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", # Required. The type of the data. + "uniqueItems": True or False, # Optional. Indicate the items in the array must be unique. Only applies to TYPE.ARRAY. + }, + }, + "tool": "A String", # Required. The original name of the tool as it is emitted by the MCP server. + }, + ], }, "name": "A String", # Identifier. The unique identifier of the toolset. Format: `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}` "openApiToolset": { # A toolset that contains a list of tools that are defined by an OpenAPI schema. # Optional. A toolset that contains a list of tools that are defined by an OpenAPI schema. @@ -3891,6 +4146,7 @@

Method Details

"inputVariableMapping": { # Optional. The mapping of the app variables names to the Dialogflow session parameters names to be sent to the Dialogflow agent as input. "a_key": "A String", }, + "languageCodeVariable": "A String", # Optional. The name of the variable that contains the language code to be used for the Dialogflow session. If unspecified, the default language code of the Dialogflow agent will be used. "outputVariableMapping": { # Optional. The mapping of the Dialogflow session parameters names to the app variables names to be sent back to the CES agent after the Dialogflow agent execution ends. "a_key": "A String", }, @@ -4077,11 +4333,11 @@

Method Details

}, "locked": True or False, # Optional. Indicates whether the app is locked for changes. If the app is locked, modifications to the app resources will be rejected. "loggingSettings": { # Settings to describe the logging behaviors for the app. # Optional. Logging settings of the app. - "audioRecordingConfig": { # Configuration for how the audio interactions should be recorded. # Optional. Configuration for how audio interactions should be recorded. + "audioRecordingConfig": { # Configuration for how the audio interactions should be recorded. # Optional. Configuration for how audio interactions should be recorded. The audio is subject to redaction as configured in RedactionConfig. "gcsBucket": "A String", # Optional. The [Cloud Storage](https://cloud.google.com/storage) bucket to store the session audio recordings. The URI must start with "gs://". Please choose a bucket location that meets your data residency requirements. Note: If the Cloud Storage bucket is in a different project from the app, you should grant `storage.objects.create` permission to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`. "gcsPathPrefix": "A String", # Optional. The Cloud Storage path prefix for audio recordings. This prefix can include the following placeholders, which will be dynamically substituted at serving time: - $project: project ID - $location: app location - $app: app ID - $date: session date in YYYY-MM-DD format - $session: session ID If the path prefix is not specified, the default prefix `$project/$location/$app/$date/$session/` will be used. }, - "bigqueryExportSettings": { # Settings to describe the BigQuery export behaviors for the app. # Optional. Settings to describe the BigQuery export behaviors for the app. The conversation data will be exported to BigQuery tables if it is enabled. + "bigqueryExportSettings": { # Settings to describe the BigQuery export behaviors for the app. # Optional. Configures the BigQuery export behaviors for the app. The conversation data is subject to redaction as configured in RedactionConfig. "dataset": "A String", # Optional. The BigQuery **dataset ID** to export the data to. "enabled": True or False, # Optional. Indicates whether the BigQuery export is enabled. "project": "A String", # Optional. The **project ID** of the BigQuery dataset to export the data to. Note: If the BigQuery dataset is in a different project from the app, you should grant `roles/bigquery.admin` role to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`. @@ -4105,7 +4361,7 @@

Method Details

"enableRedaction": True or False, # Optional. If true, redaction will be applied in various logging scenarios, including conversation history, Cloud Logging and audio recording. "inspectTemplate": "A String", # Optional. [DLP](https://cloud.google.com/dlp/docs) inspect template name to configure detection of sensitive data types. Format: `projects/{project}/locations/{location}/inspectTemplates/{inspect_template}` }, - "unredactedAudioRecordingConfig": { # Configuration for how the audio interactions should be recorded. # Optional. Configures recording of unredacted audio. Use this to maintain a raw backup with restricted access when audio redaction is enabled, typically for auditing or monitoring purposes. + "unredactedAudioRecordingConfig": { # Configuration for how the audio interactions should be recorded. # Optional. Configures an additional recording of unredacted audio. This can be used to maintain a raw audio copy when audio redaction is enabled, typically for auditing or monitoring purposes. "gcsBucket": "A String", # Optional. The [Cloud Storage](https://cloud.google.com/storage) bucket to store the session audio recordings. The URI must start with "gs://". Please choose a bucket location that meets your data residency requirements. Note: If the Cloud Storage bucket is in a different project from the app, you should grant `storage.objects.create` permission to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`. "gcsPathPrefix": "A String", # Optional. The Cloud Storage path prefix for audio recordings. This prefix can include the following placeholders, which will be dynamically substituted at serving time: - $project: project ID - $location: app location - $app: app ID - $date: session date in YYYY-MM-DD format - $session: session ID If the path prefix is not specified, the default prefix `$project/$location/$app/$date/$session/` will be used. }, @@ -4677,6 +4933,7 @@

Method Details

"uniqueItems": True or False, # Optional. Indicate the items in the array must be unique. Only applies to TYPE.ARRAY. }, "name": "A String", # Required. The name of the MCP tool. + "nameOverride": "A String", # Optional. The name override of the MCP tool. This is populated if the name was overridden by a Toolset override. "outputSchema": { # Represents a select subset of an OpenAPI 3.0 schema object. # Optional. The schema of the output arguments of the MCP tool. "additionalProperties": # Object with schema name: Schema # Optional. Can either be a boolean or an object, controls the presence of additional properties. "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. @@ -4714,6 +4971,7 @@

Method Details

"serviceDirectoryConfig": { # Configuration for tools using Service Directory. # Optional. Service Directory configuration for VPC-SC, used to resolve service names within a perimeter. "service": "A String", # Required. The name of [Service Directory](https://cloud.google.com/service-directory) service. Format: `projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}`. Location of the service directory must be the same as the location of the app. }, + "state": "A String", # Output only. The dynamic availability state of the tool on the external server. "tlsConfig": { # The TLS configuration. # Optional. The TLS configuration. Includes the custom server certificates that the client should trust. "caCerts": [ # Required. Specifies a list of allowed custom CA certificates for HTTPS verification. { # The CA certificate. @@ -4773,6 +5031,9 @@

Method Details

"description": "A String", # Output only. The description of the Python function, parsed from the python code's docstring. "name": "A String", # Optional. The name of the Python function to execute. Must match a Python function name defined in the python code. Case sensitive. If the name is not provided, the first function defined in the python code will be used. "pythonCode": "A String", # Optional. The Python code to execute for the tool. + "serviceDirectoryConfig": { # Configuration for tools using Service Directory. # Optional. Service Directory configuration for the tool. + "service": "A String", # Required. The name of [Service Directory](https://cloud.google.com/service-directory) service. Format: `projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}`. Location of the service directory must be the same as the location of the app. + }, }, "remoteAgentTool": { # Represents a tool that allows the agent to call another remote agent. # Optional. The remote agent tool. "agentCard": { # AgentCard conveys key information about a remote agent. It is a trimmed version of the AgentCard defined in the A2A protocol https://a2a-protocol.org/dev/specification/#441-agentcard # Required. The agent card of the remote agent that this tool invokes. @@ -4832,6 +5093,9 @@

Method Details

"description": "A String", # Output only. The description of the Python function, parsed from the python code's docstring. "name": "A String", # Optional. The name of the Python function to execute. Must match a Python function name defined in the python code. Case sensitive. If the name is not provided, the first function defined in the python code will be used. "pythonCode": "A String", # Optional. The Python code to execute for the tool. + "serviceDirectoryConfig": { # Configuration for tools using Service Directory. # Optional. Service Directory configuration for the tool. + "service": "A String", # Required. The name of [Service Directory](https://cloud.google.com/service-directory) service. Format: `projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}`. Location of the service directory must be the same as the location of the app. + }, }, "pythonScript": "A String", # Deprecated: Use `python_function` instead. "sourceToolName": "A String", # Optional. The resource name of the tool that provides the data for the widget (e.g., a search tool or a custom function). Format: `projects/{project}/locations/{location}/agents/{agent}/tools/{tool}` @@ -4961,6 +5225,82 @@

Method Details

}, ], }, + "toolOverrides": [ # Optional. Overrides for individual tools within this toolset. This allows overriding specific details like descriptions, names, or pinning the tools' states so they aren't fully dynamic. + { # Overrides associated with a given tool in a Toolset. This enables "pinning" or "overriding" of tool definitions from the external dynamic server. + "descriptionOverride": "A String", # Optional. If present, this tool uses this description instead of the original description from the server. + "nameOverride": "A String", # Optional. If present, this tool uses this name in the Agent instead of the original name. This is primarily used as an alias if the MCP server offers poorly named tools. + "snapshot": { # Container for a tool's core definition elements that are snapshot. Schemas in the snapshot are used as-is and cannot be overridden. # Output only. If present, this tool is "Pinned" and uses the snapshot values as fallbacks if the server becomes temporarily unavailable or if no Override is present. + "description": "A String", # Output only. The description of the MCP tool. This can be overridden by `description_override` in `McpToolOverride`. + "inputSchema": { # Represents a select subset of an OpenAPI 3.0 schema object. # Output only. The schema of the input arguments of the MCP tool. + "additionalProperties": # Object with schema name: Schema # Optional. Can either be a boolean or an object, controls the presence of additional properties. + "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. + # Object with schema name: Schema + ], + "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: Schema + }, + "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", + ], + "items": # Object with schema name: Schema # Optional. Schema of the elements of Type.ARRAY. + "maxItems": "A String", # Optional. Maximum number of the elements for Type.ARRAY. + "maximum": 3.14, # Optional. Maximum value for Type.INTEGER and Type.NUMBER. + "minItems": "A String", # Optional. Minimum number of the elements for Type.ARRAY. + "minimum": 3.14, # Optional. Minimum value for Type.INTEGER and Type.NUMBER. + "nullable": True or False, # Optional. Indicates if the value may be null. + "prefixItems": [ # Optional. Schemas of initial elements of Type.ARRAY. + # Object with schema name: Schema + ], + "properties": { # Optional. Properties of Type.OBJECT. + "a_key": # Object with schema name: Schema + }, + "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", # Required. The type of the data. + "uniqueItems": True or False, # Optional. Indicate the items in the array must be unique. Only applies to TYPE.ARRAY. + }, + "outputSchema": { # Represents a select subset of an OpenAPI 3.0 schema object. # Output only. The schema of the output arguments of the MCP tool. + "additionalProperties": # Object with schema name: Schema # Optional. Can either be a boolean or an object, controls the presence of additional properties. + "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. + # Object with schema name: Schema + ], + "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: Schema + }, + "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", + ], + "items": # Object with schema name: Schema # Optional. Schema of the elements of Type.ARRAY. + "maxItems": "A String", # Optional. Maximum number of the elements for Type.ARRAY. + "maximum": 3.14, # Optional. Maximum value for Type.INTEGER and Type.NUMBER. + "minItems": "A String", # Optional. Minimum number of the elements for Type.ARRAY. + "minimum": 3.14, # Optional. Minimum value for Type.INTEGER and Type.NUMBER. + "nullable": True or False, # Optional. Indicates if the value may be null. + "prefixItems": [ # Optional. Schemas of initial elements of Type.ARRAY. + # Object with schema name: Schema + ], + "properties": { # Optional. Properties of Type.OBJECT. + "a_key": # Object with schema name: Schema + }, + "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", # Required. The type of the data. + "uniqueItems": True or False, # Optional. Indicate the items in the array must be unique. Only applies to TYPE.ARRAY. + }, + }, + "tool": "A String", # Required. The original name of the tool as it is emitted by the MCP server. + }, + ], }, "name": "A String", # Identifier. The unique identifier of the toolset. Format: `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}` "openApiToolset": { # A toolset that contains a list of tools that are defined by an OpenAPI schema. # Optional. A toolset that contains a list of tools that are defined by an OpenAPI schema. diff --git a/docs/dyn/chromemanagement_v1.customers.enterprise.html b/docs/dyn/chromemanagement_v1.customers.enterprise.html new file mode 100644 index 0000000000..7927d0602e --- /dev/null +++ b/docs/dyn/chromemanagement_v1.customers.enterprise.html @@ -0,0 +1,91 @@ + + + +

Chrome Management API . customers . enterprise

+

Instance Methods

+

+ securityInsights() +

+

Returns the securityInsights Resource.

+ +

+ close()

+

Close httplib2 connections.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ + \ No newline at end of file diff --git a/docs/dyn/chromemanagement_v1.customers.enterprise.securityInsights.html b/docs/dyn/chromemanagement_v1.customers.enterprise.securityInsights.html new file mode 100644 index 0000000000..16c4a16f44 --- /dev/null +++ b/docs/dyn/chromemanagement_v1.customers.enterprise.securityInsights.html @@ -0,0 +1,167 @@ + + + +

Chrome Management API . customers . enterprise . securityInsights

+

Instance Methods

+

+ checkEnablementStatus(customer, x__xgafv=None)

+

Gets the setting state of the insights feature for the customer.

+

+ close()

+

Close httplib2 connections.

+

+ disable(customer, body=None, x__xgafv=None)

+

Disables insights for the customer.

+

+ enable(customer, body=None, x__xgafv=None)

+

Enables insights for the customer and sets up required chrome connectors.

+

Method Details

+
+ checkEnablementStatus(customer, x__xgafv=None) +
Gets the setting state of the insights feature for the customer.
+
+Args:
+  customer: string, Required. The customer to check the enablement status for. Format: customers/{customer_id} (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response from checking the enablement status of insights for the customer.
+  "insightsState": "A String", # The state of the insights feature.
+}
+
+ +
+ close() +
Close httplib2 connections.
+
+ +
+ disable(customer, body=None, x__xgafv=None) +
Disables insights for the customer.
+
+Args:
+  customer: string, Required. The customer to disable insights for. Format: customers/{customer} (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request to disable insights for the customer.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response from disabling insights for the customer.
+  "insightsState": "A String", # The state of the insights feature.
+}
+
+ +
+ enable(customer, body=None, x__xgafv=None) +
Enables insights for the customer and sets up required chrome connectors.
+
+Args:
+  customer: string, Required. The customer to enable insights for. Format: customers/{customer} (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request to enable insights for the customer.
+  "targetOus": [ # Optional. The Organizational Units to set up required connectors for. Organizational Units are provided as paths relative to root. If this field is not set, connectors will be set up at root OU (as if it were set to ["/"]). Example: ["/corp/sales", "/eng"]
+    "A String",
+  ],
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response from enabling insights for the customer.
+  "insightsState": "A String", # The state of the insights feature.
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/chromemanagement_v1.customers.html b/docs/dyn/chromemanagement_v1.customers.html index 3ae579587a..af370e4627 100644 --- a/docs/dyn/chromemanagement_v1.customers.html +++ b/docs/dyn/chromemanagement_v1.customers.html @@ -89,6 +89,11 @@

Instance Methods

Returns the connectorConfigs Resource.

+

+ enterprise() +

+

Returns the enterprise Resource.

+

profiles()

diff --git a/docs/dyn/chromemanagement_v1.customers.reports.html b/docs/dyn/chromemanagement_v1.customers.reports.html index 971c672850..640cba3fef 100644 --- a/docs/dyn/chromemanagement_v1.customers.reports.html +++ b/docs/dyn/chromemanagement_v1.customers.reports.html @@ -95,6 +95,12 @@

Instance Methods

countChromeHardwareFleetDevices(customer, orgUnitId=None, readMask=None, x__xgafv=None)

Counts of devices with a specific hardware specification from the requested hardware type (for example model name, processor type). Further information can be found here https://support.google.com/chrome/a/answer/10564947

+

+ countChromeProfileVersions(customer, filter=None, orgUnitId=None, pageSize=None, pageToken=None, x__xgafv=None)

+

Generate report of installed Chrome versions on managed profiles.

+

+ countChromeProfileVersions_next()

+

Retrieves the next page of results.

countChromeVersions(customer, filter=None, orgUnitId=None, pageSize=None, pageToken=None, x__xgafv=None)

Generate report of installed Chrome versions.

@@ -325,6 +331,53 @@

Method Details

}
+
+ countChromeProfileVersions(customer, filter=None, orgUnitId=None, pageSize=None, pageToken=None, x__xgafv=None) +
Generate report of installed Chrome versions on managed profiles.
+
+Args:
+  customer: string, Required. Customer id or "my_customer" to use the customer associated to the account making the request. (required)
+  filter: string, Optional. Query string to filter results, AND-separated fields in EBNF syntax. Note: OR operations are not supported in this filter. Supported filter fields: * last_active_date
+  orgUnitId: string, The ID of the organizational unit. If omitted, all data will be returned.
+  pageSize: integer, Optional. Maximum number of results to return. Maximum and default are 100.
+  pageToken: string, Optional. Token to specify the page of the request to be returned.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response containing requested managed profile versions details and counts.
+  "nextPageToken": "A String", # Token to specify the next page of the request.
+  "profileBrowserVersions": [ # List of all browser versions reported for profiles and their install counts.
+    { # Describes a browser version and its install count.
+      "channel": "A String", # Output only. The release channel of the installed browser.
+      "count": "A String", # Output only. Count grouped by device_system and major version
+      "deviceOsVersion": "A String", # Output only. Version of the system-specified operating system.
+      "system": "A String", # Output only. The device operating system.
+      "version": "A String", # Output only. The full version of the installed browser.
+    },
+  ],
+  "totalSize": 42, # Total number browser versions matching request.
+}
+
+ +
+ countChromeProfileVersions_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.
+        
+
+
countChromeVersions(customer, filter=None, orgUnitId=None, pageSize=None, pageToken=None, x__xgafv=None)
Generate report of installed Chrome versions.
diff --git a/docs/dyn/chromewebstore_v2.publishers.items.html b/docs/dyn/chromewebstore_v2.publishers.items.html
index 4602342485..301e0adc07 100644
--- a/docs/dyn/chromewebstore_v2.publishers.items.html
+++ b/docs/dyn/chromewebstore_v2.publishers.items.html
@@ -171,6 +171,7 @@ 

Method Details

The object takes the form of: { # Request message for PublishItem. + "blockOnWarnings": True or False, # Optional. When set to true the request will fail if there are any warnings during validation and the details will be included in the error_details. Otherwise warnings are treated as non-blocking and will be ignored for validation but will be included in the response for inspection. Defaults to `false` if unset. "deployInfos": [ # Optional. Additional deploy information including the desired initial percentage rollout. Defaults to the current value saved in the developer dashboard if unset. { # Deployment information for a specific release channel. Used in requests to update deployment parameters. "deployPercentage": 42, # Required. The current deploy percentage for the release channel (nonnegative number between 0 and 100). @@ -192,6 +193,14 @@

Method Details

"itemId": "A String", # Output only. The ID of the item. "name": "A String", # The name of the item that was submitted "state": "A String", # Output only. The current state of the submission. + "warningInfo": { # Message containing details on warnings encountered during PublishItem. # Output only. Non-blocking warnings encountered during the request. + "warnings": [ # All warnings encountered during the request. + { # Represents a single warning encountered during the request. + "description": "A String", # A description of the warning. Developers should use this message to understand the warning and take appropriate action to resolve the issue. + "reason": "A String", # The reason for the warning. This is a constant value that identifies the proximate cause of the warning. This should be at most 63 characters and match a regular expression of `A-Z+[A-Z0-9]`, which represents UPPER_SNAKE_CASE. + }, + ], + }, }
diff --git a/docs/dyn/cloudbuild_v1.projects.builds.html b/docs/dyn/cloudbuild_v1.projects.builds.html index fd24f87902..6c76399f5c 100644 --- a/docs/dyn/cloudbuild_v1.projects.builds.html +++ b/docs/dyn/cloudbuild_v1.projects.builds.html @@ -349,6 +349,13 @@

Method Details

"buildStepOutputs": [ # List of build step outputs, produced by builder images, in the order corresponding to build step indices. [Cloud Builders](https://cloud.google.com/cloud-build/docs/cloud-builders) can produce this output by writing to `$BUILDER_OUTPUT/output`. Only the first 50KB of data is stored. Note that the `$BUILDER_OUTPUT` variable is read-only and can't be substituted. "A String", ], + "buildStepResults": { # Results for build steps. step_id -> + "a_key": { # Results for a build step. + "results": { # Results for a build step. + "a_key": "A String", + }, + }, + }, "genericArtifacts": [ # Output only. Generic artifacts uploaded to Artifact Registry at the end of the build. { # A generic artifact uploaded to Artifact Registry using the GenericArtifact directive. "artifactFingerprint": { # Container message for hashes of byte content of files, used in SourceProvenance messages to verify integrity of source input to the build. # Output only. The hash of the whole artifact. @@ -582,6 +589,13 @@

Method Details

"endTime": "A String", # End of time span. "startTime": "A String", # Start of time span. }, + "results": [ # Declaration of results for this build step. + { # StepResult is the declaration of a result for a build step. + "attestationContent": "A String", # Optional. The content of the attestation to be generated. + "attestationType": "A String", # Optional. The type of attestation to be generated. + "name": "A String", # Required. The name of the result. + }, + ], "script": "A String", # A shell script to be executed in the step. When script is provided, the user cannot specify the entrypoint or args. "secretEnv": [ # A list of environment variables which are encrypted using a Cloud Key Management Service crypto key. These values must be specified in the build's `Secret`. "A String", @@ -817,6 +831,13 @@

Method Details

"buildStepOutputs": [ # List of build step outputs, produced by builder images, in the order corresponding to build step indices. [Cloud Builders](https://cloud.google.com/cloud-build/docs/cloud-builders) can produce this output by writing to `$BUILDER_OUTPUT/output`. Only the first 50KB of data is stored. Note that the `$BUILDER_OUTPUT` variable is read-only and can't be substituted. "A String", ], + "buildStepResults": { # Results for build steps. step_id -> + "a_key": { # Results for a build step. + "results": { # Results for a build step. + "a_key": "A String", + }, + }, + }, "genericArtifacts": [ # Output only. Generic artifacts uploaded to Artifact Registry at the end of the build. { # A generic artifact uploaded to Artifact Registry using the GenericArtifact directive. "artifactFingerprint": { # Container message for hashes of byte content of files, used in SourceProvenance messages to verify integrity of source input to the build. # Output only. The hash of the whole artifact. @@ -1050,6 +1071,13 @@

Method Details

"endTime": "A String", # End of time span. "startTime": "A String", # Start of time span. }, + "results": [ # Declaration of results for this build step. + { # StepResult is the declaration of a result for a build step. + "attestationContent": "A String", # Optional. The content of the attestation to be generated. + "attestationType": "A String", # Optional. The type of attestation to be generated. + "name": "A String", # Required. The name of the result. + }, + ], "script": "A String", # A shell script to be executed in the step. When script is provided, the user cannot specify the entrypoint or args. "secretEnv": [ # A list of environment variables which are encrypted using a Cloud Key Management Service crypto key. These values must be specified in the build's `Secret`. "A String", @@ -1316,6 +1344,13 @@

Method Details

"buildStepOutputs": [ # List of build step outputs, produced by builder images, in the order corresponding to build step indices. [Cloud Builders](https://cloud.google.com/cloud-build/docs/cloud-builders) can produce this output by writing to `$BUILDER_OUTPUT/output`. Only the first 50KB of data is stored. Note that the `$BUILDER_OUTPUT` variable is read-only and can't be substituted. "A String", ], + "buildStepResults": { # Results for build steps. step_id -> + "a_key": { # Results for a build step. + "results": { # Results for a build step. + "a_key": "A String", + }, + }, + }, "genericArtifacts": [ # Output only. Generic artifacts uploaded to Artifact Registry at the end of the build. { # A generic artifact uploaded to Artifact Registry using the GenericArtifact directive. "artifactFingerprint": { # Container message for hashes of byte content of files, used in SourceProvenance messages to verify integrity of source input to the build. # Output only. The hash of the whole artifact. @@ -1549,6 +1584,13 @@

Method Details

"endTime": "A String", # End of time span. "startTime": "A String", # Start of time span. }, + "results": [ # Declaration of results for this build step. + { # StepResult is the declaration of a result for a build step. + "attestationContent": "A String", # Optional. The content of the attestation to be generated. + "attestationType": "A String", # Optional. The type of attestation to be generated. + "name": "A String", # Required. The name of the result. + }, + ], "script": "A String", # A shell script to be executed in the step. When script is provided, the user cannot specify the entrypoint or args. "secretEnv": [ # A list of environment variables which are encrypted using a Cloud Key Management Service crypto key. These values must be specified in the build's `Secret`. "A String", @@ -1790,6 +1832,13 @@

Method Details

"buildStepOutputs": [ # List of build step outputs, produced by builder images, in the order corresponding to build step indices. [Cloud Builders](https://cloud.google.com/cloud-build/docs/cloud-builders) can produce this output by writing to `$BUILDER_OUTPUT/output`. Only the first 50KB of data is stored. Note that the `$BUILDER_OUTPUT` variable is read-only and can't be substituted. "A String", ], + "buildStepResults": { # Results for build steps. step_id -> + "a_key": { # Results for a build step. + "results": { # Results for a build step. + "a_key": "A String", + }, + }, + }, "genericArtifacts": [ # Output only. Generic artifacts uploaded to Artifact Registry at the end of the build. { # A generic artifact uploaded to Artifact Registry using the GenericArtifact directive. "artifactFingerprint": { # Container message for hashes of byte content of files, used in SourceProvenance messages to verify integrity of source input to the build. # Output only. The hash of the whole artifact. @@ -2023,6 +2072,13 @@

Method Details

"endTime": "A String", # End of time span. "startTime": "A String", # Start of time span. }, + "results": [ # Declaration of results for this build step. + { # StepResult is the declaration of a result for a build step. + "attestationContent": "A String", # Optional. The content of the attestation to be generated. + "attestationType": "A String", # Optional. The type of attestation to be generated. + "name": "A String", # Required. The name of the result. + }, + ], "script": "A String", # A shell script to be executed in the step. When script is provided, the user cannot specify the entrypoint or args. "secretEnv": [ # A list of environment variables which are encrypted using a Cloud Key Management Service crypto key. These values must be specified in the build's `Secret`. "A String", diff --git a/docs/dyn/cloudbuild_v1.projects.locations.builds.html b/docs/dyn/cloudbuild_v1.projects.locations.builds.html index 1369e52572..cf86ac8393 100644 --- a/docs/dyn/cloudbuild_v1.projects.locations.builds.html +++ b/docs/dyn/cloudbuild_v1.projects.locations.builds.html @@ -348,6 +348,13 @@

Method Details

"buildStepOutputs": [ # List of build step outputs, produced by builder images, in the order corresponding to build step indices. [Cloud Builders](https://cloud.google.com/cloud-build/docs/cloud-builders) can produce this output by writing to `$BUILDER_OUTPUT/output`. Only the first 50KB of data is stored. Note that the `$BUILDER_OUTPUT` variable is read-only and can't be substituted. "A String", ], + "buildStepResults": { # Results for build steps. step_id -> + "a_key": { # Results for a build step. + "results": { # Results for a build step. + "a_key": "A String", + }, + }, + }, "genericArtifacts": [ # Output only. Generic artifacts uploaded to Artifact Registry at the end of the build. { # A generic artifact uploaded to Artifact Registry using the GenericArtifact directive. "artifactFingerprint": { # Container message for hashes of byte content of files, used in SourceProvenance messages to verify integrity of source input to the build. # Output only. The hash of the whole artifact. @@ -581,6 +588,13 @@

Method Details

"endTime": "A String", # End of time span. "startTime": "A String", # Start of time span. }, + "results": [ # Declaration of results for this build step. + { # StepResult is the declaration of a result for a build step. + "attestationContent": "A String", # Optional. The content of the attestation to be generated. + "attestationType": "A String", # Optional. The type of attestation to be generated. + "name": "A String", # Required. The name of the result. + }, + ], "script": "A String", # A shell script to be executed in the step. When script is provided, the user cannot specify the entrypoint or args. "secretEnv": [ # A list of environment variables which are encrypted using a Cloud Key Management Service crypto key. These values must be specified in the build's `Secret`. "A String", @@ -816,6 +830,13 @@

Method Details

"buildStepOutputs": [ # List of build step outputs, produced by builder images, in the order corresponding to build step indices. [Cloud Builders](https://cloud.google.com/cloud-build/docs/cloud-builders) can produce this output by writing to `$BUILDER_OUTPUT/output`. Only the first 50KB of data is stored. Note that the `$BUILDER_OUTPUT` variable is read-only and can't be substituted. "A String", ], + "buildStepResults": { # Results for build steps. step_id -> + "a_key": { # Results for a build step. + "results": { # Results for a build step. + "a_key": "A String", + }, + }, + }, "genericArtifacts": [ # Output only. Generic artifacts uploaded to Artifact Registry at the end of the build. { # A generic artifact uploaded to Artifact Registry using the GenericArtifact directive. "artifactFingerprint": { # Container message for hashes of byte content of files, used in SourceProvenance messages to verify integrity of source input to the build. # Output only. The hash of the whole artifact. @@ -1049,6 +1070,13 @@

Method Details

"endTime": "A String", # End of time span. "startTime": "A String", # Start of time span. }, + "results": [ # Declaration of results for this build step. + { # StepResult is the declaration of a result for a build step. + "attestationContent": "A String", # Optional. The content of the attestation to be generated. + "attestationType": "A String", # Optional. The type of attestation to be generated. + "name": "A String", # Required. The name of the result. + }, + ], "script": "A String", # A shell script to be executed in the step. When script is provided, the user cannot specify the entrypoint or args. "secretEnv": [ # A list of environment variables which are encrypted using a Cloud Key Management Service crypto key. These values must be specified in the build's `Secret`. "A String", @@ -1315,6 +1343,13 @@

Method Details

"buildStepOutputs": [ # List of build step outputs, produced by builder images, in the order corresponding to build step indices. [Cloud Builders](https://cloud.google.com/cloud-build/docs/cloud-builders) can produce this output by writing to `$BUILDER_OUTPUT/output`. Only the first 50KB of data is stored. Note that the `$BUILDER_OUTPUT` variable is read-only and can't be substituted. "A String", ], + "buildStepResults": { # Results for build steps. step_id -> + "a_key": { # Results for a build step. + "results": { # Results for a build step. + "a_key": "A String", + }, + }, + }, "genericArtifacts": [ # Output only. Generic artifacts uploaded to Artifact Registry at the end of the build. { # A generic artifact uploaded to Artifact Registry using the GenericArtifact directive. "artifactFingerprint": { # Container message for hashes of byte content of files, used in SourceProvenance messages to verify integrity of source input to the build. # Output only. The hash of the whole artifact. @@ -1548,6 +1583,13 @@

Method Details

"endTime": "A String", # End of time span. "startTime": "A String", # Start of time span. }, + "results": [ # Declaration of results for this build step. + { # StepResult is the declaration of a result for a build step. + "attestationContent": "A String", # Optional. The content of the attestation to be generated. + "attestationType": "A String", # Optional. The type of attestation to be generated. + "name": "A String", # Required. The name of the result. + }, + ], "script": "A String", # A shell script to be executed in the step. When script is provided, the user cannot specify the entrypoint or args. "secretEnv": [ # A list of environment variables which are encrypted using a Cloud Key Management Service crypto key. These values must be specified in the build's `Secret`. "A String", @@ -1789,6 +1831,13 @@

Method Details

"buildStepOutputs": [ # List of build step outputs, produced by builder images, in the order corresponding to build step indices. [Cloud Builders](https://cloud.google.com/cloud-build/docs/cloud-builders) can produce this output by writing to `$BUILDER_OUTPUT/output`. Only the first 50KB of data is stored. Note that the `$BUILDER_OUTPUT` variable is read-only and can't be substituted. "A String", ], + "buildStepResults": { # Results for build steps. step_id -> + "a_key": { # Results for a build step. + "results": { # Results for a build step. + "a_key": "A String", + }, + }, + }, "genericArtifacts": [ # Output only. Generic artifacts uploaded to Artifact Registry at the end of the build. { # A generic artifact uploaded to Artifact Registry using the GenericArtifact directive. "artifactFingerprint": { # Container message for hashes of byte content of files, used in SourceProvenance messages to verify integrity of source input to the build. # Output only. The hash of the whole artifact. @@ -2022,6 +2071,13 @@

Method Details

"endTime": "A String", # End of time span. "startTime": "A String", # Start of time span. }, + "results": [ # Declaration of results for this build step. + { # StepResult is the declaration of a result for a build step. + "attestationContent": "A String", # Optional. The content of the attestation to be generated. + "attestationType": "A String", # Optional. The type of attestation to be generated. + "name": "A String", # Required. The name of the result. + }, + ], "script": "A String", # A shell script to be executed in the step. When script is provided, the user cannot specify the entrypoint or args. "secretEnv": [ # A list of environment variables which are encrypted using a Cloud Key Management Service crypto key. These values must be specified in the build's `Secret`. "A String", diff --git a/docs/dyn/cloudbuild_v1.projects.locations.triggers.html b/docs/dyn/cloudbuild_v1.projects.locations.triggers.html index a364db7cb5..f570cf5ce4 100644 --- a/docs/dyn/cloudbuild_v1.projects.locations.triggers.html +++ b/docs/dyn/cloudbuild_v1.projects.locations.triggers.html @@ -337,6 +337,13 @@

Method Details

"buildStepOutputs": [ # List of build step outputs, produced by builder images, in the order corresponding to build step indices. [Cloud Builders](https://cloud.google.com/cloud-build/docs/cloud-builders) can produce this output by writing to `$BUILDER_OUTPUT/output`. Only the first 50KB of data is stored. Note that the `$BUILDER_OUTPUT` variable is read-only and can't be substituted. "A String", ], + "buildStepResults": { # Results for build steps. step_id -> + "a_key": { # Results for a build step. + "results": { # Results for a build step. + "a_key": "A String", + }, + }, + }, "genericArtifacts": [ # Output only. Generic artifacts uploaded to Artifact Registry at the end of the build. { # A generic artifact uploaded to Artifact Registry using the GenericArtifact directive. "artifactFingerprint": { # Container message for hashes of byte content of files, used in SourceProvenance messages to verify integrity of source input to the build. # Output only. The hash of the whole artifact. @@ -570,6 +577,13 @@

Method Details

"endTime": "A String", # End of time span. "startTime": "A String", # Start of time span. }, + "results": [ # Declaration of results for this build step. + { # StepResult is the declaration of a result for a build step. + "attestationContent": "A String", # Optional. The content of the attestation to be generated. + "attestationType": "A String", # Optional. The type of attestation to be generated. + "name": "A String", # Required. The name of the result. + }, + ], "script": "A String", # A shell script to be executed in the step. When script is provided, the user cannot specify the entrypoint or args. "secretEnv": [ # A list of environment variables which are encrypted using a Cloud Key Management Service crypto key. These values must be specified in the build's `Secret`. "A String", @@ -988,6 +1002,13 @@

Method Details

"buildStepOutputs": [ # List of build step outputs, produced by builder images, in the order corresponding to build step indices. [Cloud Builders](https://cloud.google.com/cloud-build/docs/cloud-builders) can produce this output by writing to `$BUILDER_OUTPUT/output`. Only the first 50KB of data is stored. Note that the `$BUILDER_OUTPUT` variable is read-only and can't be substituted. "A String", ], + "buildStepResults": { # Results for build steps. step_id -> + "a_key": { # Results for a build step. + "results": { # Results for a build step. + "a_key": "A String", + }, + }, + }, "genericArtifacts": [ # Output only. Generic artifacts uploaded to Artifact Registry at the end of the build. { # A generic artifact uploaded to Artifact Registry using the GenericArtifact directive. "artifactFingerprint": { # Container message for hashes of byte content of files, used in SourceProvenance messages to verify integrity of source input to the build. # Output only. The hash of the whole artifact. @@ -1221,6 +1242,13 @@

Method Details

"endTime": "A String", # End of time span. "startTime": "A String", # Start of time span. }, + "results": [ # Declaration of results for this build step. + { # StepResult is the declaration of a result for a build step. + "attestationContent": "A String", # Optional. The content of the attestation to be generated. + "attestationType": "A String", # Optional. The type of attestation to be generated. + "name": "A String", # Required. The name of the result. + }, + ], "script": "A String", # A shell script to be executed in the step. When script is provided, the user cannot specify the entrypoint or args. "secretEnv": [ # A list of environment variables which are encrypted using a Cloud Key Management Service crypto key. These values must be specified in the build's `Secret`. "A String", @@ -1667,6 +1695,13 @@

Method Details

"buildStepOutputs": [ # List of build step outputs, produced by builder images, in the order corresponding to build step indices. [Cloud Builders](https://cloud.google.com/cloud-build/docs/cloud-builders) can produce this output by writing to `$BUILDER_OUTPUT/output`. Only the first 50KB of data is stored. Note that the `$BUILDER_OUTPUT` variable is read-only and can't be substituted. "A String", ], + "buildStepResults": { # Results for build steps. step_id -> + "a_key": { # Results for a build step. + "results": { # Results for a build step. + "a_key": "A String", + }, + }, + }, "genericArtifacts": [ # Output only. Generic artifacts uploaded to Artifact Registry at the end of the build. { # A generic artifact uploaded to Artifact Registry using the GenericArtifact directive. "artifactFingerprint": { # Container message for hashes of byte content of files, used in SourceProvenance messages to verify integrity of source input to the build. # Output only. The hash of the whole artifact. @@ -1900,6 +1935,13 @@

Method Details

"endTime": "A String", # End of time span. "startTime": "A String", # Start of time span. }, + "results": [ # Declaration of results for this build step. + { # StepResult is the declaration of a result for a build step. + "attestationContent": "A String", # Optional. The content of the attestation to be generated. + "attestationType": "A String", # Optional. The type of attestation to be generated. + "name": "A String", # Required. The name of the result. + }, + ], "script": "A String", # A shell script to be executed in the step. When script is provided, the user cannot specify the entrypoint or args. "secretEnv": [ # A list of environment variables which are encrypted using a Cloud Key Management Service crypto key. These values must be specified in the build's `Secret`. "A String", @@ -2330,6 +2372,13 @@

Method Details

"buildStepOutputs": [ # List of build step outputs, produced by builder images, in the order corresponding to build step indices. [Cloud Builders](https://cloud.google.com/cloud-build/docs/cloud-builders) can produce this output by writing to `$BUILDER_OUTPUT/output`. Only the first 50KB of data is stored. Note that the `$BUILDER_OUTPUT` variable is read-only and can't be substituted. "A String", ], + "buildStepResults": { # Results for build steps. step_id -> + "a_key": { # Results for a build step. + "results": { # Results for a build step. + "a_key": "A String", + }, + }, + }, "genericArtifacts": [ # Output only. Generic artifacts uploaded to Artifact Registry at the end of the build. { # A generic artifact uploaded to Artifact Registry using the GenericArtifact directive. "artifactFingerprint": { # Container message for hashes of byte content of files, used in SourceProvenance messages to verify integrity of source input to the build. # Output only. The hash of the whole artifact. @@ -2563,6 +2612,13 @@

Method Details

"endTime": "A String", # End of time span. "startTime": "A String", # Start of time span. }, + "results": [ # Declaration of results for this build step. + { # StepResult is the declaration of a result for a build step. + "attestationContent": "A String", # Optional. The content of the attestation to be generated. + "attestationType": "A String", # Optional. The type of attestation to be generated. + "name": "A String", # Required. The name of the result. + }, + ], "script": "A String", # A shell script to be executed in the step. When script is provided, the user cannot specify the entrypoint or args. "secretEnv": [ # A list of environment variables which are encrypted using a Cloud Key Management Service crypto key. These values must be specified in the build's `Secret`. "A String", @@ -2998,6 +3054,13 @@

Method Details

"buildStepOutputs": [ # List of build step outputs, produced by builder images, in the order corresponding to build step indices. [Cloud Builders](https://cloud.google.com/cloud-build/docs/cloud-builders) can produce this output by writing to `$BUILDER_OUTPUT/output`. Only the first 50KB of data is stored. Note that the `$BUILDER_OUTPUT` variable is read-only and can't be substituted. "A String", ], + "buildStepResults": { # Results for build steps. step_id -> + "a_key": { # Results for a build step. + "results": { # Results for a build step. + "a_key": "A String", + }, + }, + }, "genericArtifacts": [ # Output only. Generic artifacts uploaded to Artifact Registry at the end of the build. { # A generic artifact uploaded to Artifact Registry using the GenericArtifact directive. "artifactFingerprint": { # Container message for hashes of byte content of files, used in SourceProvenance messages to verify integrity of source input to the build. # Output only. The hash of the whole artifact. @@ -3231,6 +3294,13 @@

Method Details

"endTime": "A String", # End of time span. "startTime": "A String", # Start of time span. }, + "results": [ # Declaration of results for this build step. + { # StepResult is the declaration of a result for a build step. + "attestationContent": "A String", # Optional. The content of the attestation to be generated. + "attestationType": "A String", # Optional. The type of attestation to be generated. + "name": "A String", # Required. The name of the result. + }, + ], "script": "A String", # A shell script to be executed in the step. When script is provided, the user cannot specify the entrypoint or args. "secretEnv": [ # A list of environment variables which are encrypted using a Cloud Key Management Service crypto key. These values must be specified in the build's `Secret`. "A String", @@ -3651,6 +3721,13 @@

Method Details

"buildStepOutputs": [ # List of build step outputs, produced by builder images, in the order corresponding to build step indices. [Cloud Builders](https://cloud.google.com/cloud-build/docs/cloud-builders) can produce this output by writing to `$BUILDER_OUTPUT/output`. Only the first 50KB of data is stored. Note that the `$BUILDER_OUTPUT` variable is read-only and can't be substituted. "A String", ], + "buildStepResults": { # Results for build steps. step_id -> + "a_key": { # Results for a build step. + "results": { # Results for a build step. + "a_key": "A String", + }, + }, + }, "genericArtifacts": [ # Output only. Generic artifacts uploaded to Artifact Registry at the end of the build. { # A generic artifact uploaded to Artifact Registry using the GenericArtifact directive. "artifactFingerprint": { # Container message for hashes of byte content of files, used in SourceProvenance messages to verify integrity of source input to the build. # Output only. The hash of the whole artifact. @@ -3884,6 +3961,13 @@

Method Details

"endTime": "A String", # End of time span. "startTime": "A String", # Start of time span. }, + "results": [ # Declaration of results for this build step. + { # StepResult is the declaration of a result for a build step. + "attestationContent": "A String", # Optional. The content of the attestation to be generated. + "attestationType": "A String", # Optional. The type of attestation to be generated. + "name": "A String", # Required. The name of the result. + }, + ], "script": "A String", # A shell script to be executed in the step. When script is provided, the user cannot specify the entrypoint or args. "secretEnv": [ # A list of environment variables which are encrypted using a Cloud Key Management Service crypto key. These values must be specified in the build's `Secret`. "A String", diff --git a/docs/dyn/cloudbuild_v1.projects.triggers.html b/docs/dyn/cloudbuild_v1.projects.triggers.html index 98b5b8689e..e65a4d2c9e 100644 --- a/docs/dyn/cloudbuild_v1.projects.triggers.html +++ b/docs/dyn/cloudbuild_v1.projects.triggers.html @@ -337,6 +337,13 @@

Method Details

"buildStepOutputs": [ # List of build step outputs, produced by builder images, in the order corresponding to build step indices. [Cloud Builders](https://cloud.google.com/cloud-build/docs/cloud-builders) can produce this output by writing to `$BUILDER_OUTPUT/output`. Only the first 50KB of data is stored. Note that the `$BUILDER_OUTPUT` variable is read-only and can't be substituted. "A String", ], + "buildStepResults": { # Results for build steps. step_id -> + "a_key": { # Results for a build step. + "results": { # Results for a build step. + "a_key": "A String", + }, + }, + }, "genericArtifacts": [ # Output only. Generic artifacts uploaded to Artifact Registry at the end of the build. { # A generic artifact uploaded to Artifact Registry using the GenericArtifact directive. "artifactFingerprint": { # Container message for hashes of byte content of files, used in SourceProvenance messages to verify integrity of source input to the build. # Output only. The hash of the whole artifact. @@ -570,6 +577,13 @@

Method Details

"endTime": "A String", # End of time span. "startTime": "A String", # Start of time span. }, + "results": [ # Declaration of results for this build step. + { # StepResult is the declaration of a result for a build step. + "attestationContent": "A String", # Optional. The content of the attestation to be generated. + "attestationType": "A String", # Optional. The type of attestation to be generated. + "name": "A String", # Required. The name of the result. + }, + ], "script": "A String", # A shell script to be executed in the step. When script is provided, the user cannot specify the entrypoint or args. "secretEnv": [ # A list of environment variables which are encrypted using a Cloud Key Management Service crypto key. These values must be specified in the build's `Secret`. "A String", @@ -988,6 +1002,13 @@

Method Details

"buildStepOutputs": [ # List of build step outputs, produced by builder images, in the order corresponding to build step indices. [Cloud Builders](https://cloud.google.com/cloud-build/docs/cloud-builders) can produce this output by writing to `$BUILDER_OUTPUT/output`. Only the first 50KB of data is stored. Note that the `$BUILDER_OUTPUT` variable is read-only and can't be substituted. "A String", ], + "buildStepResults": { # Results for build steps. step_id -> + "a_key": { # Results for a build step. + "results": { # Results for a build step. + "a_key": "A String", + }, + }, + }, "genericArtifacts": [ # Output only. Generic artifacts uploaded to Artifact Registry at the end of the build. { # A generic artifact uploaded to Artifact Registry using the GenericArtifact directive. "artifactFingerprint": { # Container message for hashes of byte content of files, used in SourceProvenance messages to verify integrity of source input to the build. # Output only. The hash of the whole artifact. @@ -1221,6 +1242,13 @@

Method Details

"endTime": "A String", # End of time span. "startTime": "A String", # Start of time span. }, + "results": [ # Declaration of results for this build step. + { # StepResult is the declaration of a result for a build step. + "attestationContent": "A String", # Optional. The content of the attestation to be generated. + "attestationType": "A String", # Optional. The type of attestation to be generated. + "name": "A String", # Required. The name of the result. + }, + ], "script": "A String", # A shell script to be executed in the step. When script is provided, the user cannot specify the entrypoint or args. "secretEnv": [ # A list of environment variables which are encrypted using a Cloud Key Management Service crypto key. These values must be specified in the build's `Secret`. "A String", @@ -1667,6 +1695,13 @@

Method Details

"buildStepOutputs": [ # List of build step outputs, produced by builder images, in the order corresponding to build step indices. [Cloud Builders](https://cloud.google.com/cloud-build/docs/cloud-builders) can produce this output by writing to `$BUILDER_OUTPUT/output`. Only the first 50KB of data is stored. Note that the `$BUILDER_OUTPUT` variable is read-only and can't be substituted. "A String", ], + "buildStepResults": { # Results for build steps. step_id -> + "a_key": { # Results for a build step. + "results": { # Results for a build step. + "a_key": "A String", + }, + }, + }, "genericArtifacts": [ # Output only. Generic artifacts uploaded to Artifact Registry at the end of the build. { # A generic artifact uploaded to Artifact Registry using the GenericArtifact directive. "artifactFingerprint": { # Container message for hashes of byte content of files, used in SourceProvenance messages to verify integrity of source input to the build. # Output only. The hash of the whole artifact. @@ -1900,6 +1935,13 @@

Method Details

"endTime": "A String", # End of time span. "startTime": "A String", # Start of time span. }, + "results": [ # Declaration of results for this build step. + { # StepResult is the declaration of a result for a build step. + "attestationContent": "A String", # Optional. The content of the attestation to be generated. + "attestationType": "A String", # Optional. The type of attestation to be generated. + "name": "A String", # Required. The name of the result. + }, + ], "script": "A String", # A shell script to be executed in the step. When script is provided, the user cannot specify the entrypoint or args. "secretEnv": [ # A list of environment variables which are encrypted using a Cloud Key Management Service crypto key. These values must be specified in the build's `Secret`. "A String", @@ -2330,6 +2372,13 @@

Method Details

"buildStepOutputs": [ # List of build step outputs, produced by builder images, in the order corresponding to build step indices. [Cloud Builders](https://cloud.google.com/cloud-build/docs/cloud-builders) can produce this output by writing to `$BUILDER_OUTPUT/output`. Only the first 50KB of data is stored. Note that the `$BUILDER_OUTPUT` variable is read-only and can't be substituted. "A String", ], + "buildStepResults": { # Results for build steps. step_id -> + "a_key": { # Results for a build step. + "results": { # Results for a build step. + "a_key": "A String", + }, + }, + }, "genericArtifacts": [ # Output only. Generic artifacts uploaded to Artifact Registry at the end of the build. { # A generic artifact uploaded to Artifact Registry using the GenericArtifact directive. "artifactFingerprint": { # Container message for hashes of byte content of files, used in SourceProvenance messages to verify integrity of source input to the build. # Output only. The hash of the whole artifact. @@ -2563,6 +2612,13 @@

Method Details

"endTime": "A String", # End of time span. "startTime": "A String", # Start of time span. }, + "results": [ # Declaration of results for this build step. + { # StepResult is the declaration of a result for a build step. + "attestationContent": "A String", # Optional. The content of the attestation to be generated. + "attestationType": "A String", # Optional. The type of attestation to be generated. + "name": "A String", # Required. The name of the result. + }, + ], "script": "A String", # A shell script to be executed in the step. When script is provided, the user cannot specify the entrypoint or args. "secretEnv": [ # A list of environment variables which are encrypted using a Cloud Key Management Service crypto key. These values must be specified in the build's `Secret`. "A String", @@ -2999,6 +3055,13 @@

Method Details

"buildStepOutputs": [ # List of build step outputs, produced by builder images, in the order corresponding to build step indices. [Cloud Builders](https://cloud.google.com/cloud-build/docs/cloud-builders) can produce this output by writing to `$BUILDER_OUTPUT/output`. Only the first 50KB of data is stored. Note that the `$BUILDER_OUTPUT` variable is read-only and can't be substituted. "A String", ], + "buildStepResults": { # Results for build steps. step_id -> + "a_key": { # Results for a build step. + "results": { # Results for a build step. + "a_key": "A String", + }, + }, + }, "genericArtifacts": [ # Output only. Generic artifacts uploaded to Artifact Registry at the end of the build. { # A generic artifact uploaded to Artifact Registry using the GenericArtifact directive. "artifactFingerprint": { # Container message for hashes of byte content of files, used in SourceProvenance messages to verify integrity of source input to the build. # Output only. The hash of the whole artifact. @@ -3232,6 +3295,13 @@

Method Details

"endTime": "A String", # End of time span. "startTime": "A String", # Start of time span. }, + "results": [ # Declaration of results for this build step. + { # StepResult is the declaration of a result for a build step. + "attestationContent": "A String", # Optional. The content of the attestation to be generated. + "attestationType": "A String", # Optional. The type of attestation to be generated. + "name": "A String", # Required. The name of the result. + }, + ], "script": "A String", # A shell script to be executed in the step. When script is provided, the user cannot specify the entrypoint or args. "secretEnv": [ # A list of environment variables which are encrypted using a Cloud Key Management Service crypto key. These values must be specified in the build's `Secret`. "A String", @@ -3650,6 +3720,13 @@

Method Details

"buildStepOutputs": [ # List of build step outputs, produced by builder images, in the order corresponding to build step indices. [Cloud Builders](https://cloud.google.com/cloud-build/docs/cloud-builders) can produce this output by writing to `$BUILDER_OUTPUT/output`. Only the first 50KB of data is stored. Note that the `$BUILDER_OUTPUT` variable is read-only and can't be substituted. "A String", ], + "buildStepResults": { # Results for build steps. step_id -> + "a_key": { # Results for a build step. + "results": { # Results for a build step. + "a_key": "A String", + }, + }, + }, "genericArtifacts": [ # Output only. Generic artifacts uploaded to Artifact Registry at the end of the build. { # A generic artifact uploaded to Artifact Registry using the GenericArtifact directive. "artifactFingerprint": { # Container message for hashes of byte content of files, used in SourceProvenance messages to verify integrity of source input to the build. # Output only. The hash of the whole artifact. @@ -3883,6 +3960,13 @@

Method Details

"endTime": "A String", # End of time span. "startTime": "A String", # Start of time span. }, + "results": [ # Declaration of results for this build step. + { # StepResult is the declaration of a result for a build step. + "attestationContent": "A String", # Optional. The content of the attestation to be generated. + "attestationType": "A String", # Optional. The type of attestation to be generated. + "name": "A String", # Required. The name of the result. + }, + ], "script": "A String", # A shell script to be executed in the step. When script is provided, the user cannot specify the entrypoint or args. "secretEnv": [ # A list of environment variables which are encrypted using a Cloud Key Management Service crypto key. These values must be specified in the build's `Secret`. "A String", diff --git a/docs/dyn/cloudbuild_v2.projects.locations.html b/docs/dyn/cloudbuild_v2.projects.locations.html index 812834db18..a05e85e9a7 100644 --- a/docs/dyn/cloudbuild_v2.projects.locations.html +++ b/docs/dyn/cloudbuild_v2.projects.locations.html @@ -92,7 +92,7 @@

Instance Methods

Gets information about a location.

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

-

Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the [ListLocationsRequest.name] field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.

+

Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the ListLocationsRequest.name field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.

list_next()

Retrieves the next page of results.

@@ -131,11 +131,11 @@

Method Details

list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None) -
Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the [ListLocationsRequest.name] field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.
+  
Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the ListLocationsRequest.name field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.
 
 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. Do not use this field 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/clouddeploy_v1.projects.locations.customTargetTypes.html b/docs/dyn/clouddeploy_v1.projects.locations.customTargetTypes.html
index cdaab116e4..463fc7c17d 100644
--- a/docs/dyn/clouddeploy_v1.projects.locations.customTargetTypes.html
+++ b/docs/dyn/clouddeploy_v1.projects.locations.customTargetTypes.html
@@ -166,7 +166,6 @@ 

Method Details

"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, "render": { # A Task represents a unit of work that is executed as part of a Job. # Optional. The task responsible for render operations. If not provided then Cloud Deploy will perform its default rendering operation. @@ -181,7 +180,6 @@

Method Details

"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, }, @@ -324,7 +322,6 @@

Method Details

"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, "render": { # A Task represents a unit of work that is executed as part of a Job. # Optional. The task responsible for render operations. If not provided then Cloud Deploy will perform its default rendering operation. @@ -339,7 +336,6 @@

Method Details

"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, }, @@ -466,7 +462,6 @@

Method Details

"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, "render": { # A Task represents a unit of work that is executed as part of a Job. # Optional. The task responsible for render operations. If not provided then Cloud Deploy will perform its default rendering operation. @@ -481,7 +476,6 @@

Method Details

"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, }, @@ -569,7 +563,6 @@

Method Details

"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, "render": { # A Task represents a unit of work that is executed as part of a Job. # Optional. The task responsible for render operations. If not provided then Cloud Deploy will perform its default rendering operation. @@ -584,7 +577,6 @@

Method Details

"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, }, diff --git a/docs/dyn/clouddeploy_v1.projects.locations.deliveryPipelines.html b/docs/dyn/clouddeploy_v1.projects.locations.deliveryPipelines.html index 7e6a60fb38..abacf1bafd 100644 --- a/docs/dyn/clouddeploy_v1.projects.locations.deliveryPipelines.html +++ b/docs/dyn/clouddeploy_v1.projects.locations.deliveryPipelines.html @@ -161,7 +161,7 @@

Method Details

"createTime": "A String", # Output only. Time at which the pipeline was created. "description": "A String", # Optional. Description of the `DeliveryPipeline`. Max length is 255 characters. "etag": "A String", # This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. - "labels": { # Labels are attributes that can be set and used by both the user and by Cloud Deploy. Labels must meet the following constraints: * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. * All characters must use UTF-8 encoding, and international characters are allowed. * Keys must start with a lowercase letter or international character. * Each resource is limited to a maximum of 64 labels. Both keys and values are additionally constrained to be <= 128 bytes. + "labels": { # Optional. Labels are attributes that can be set and used by both the user and by Cloud Deploy. Labels must meet the following constraints: * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. * All characters must use UTF-8 encoding, and international characters are allowed. * Keys must start with a lowercase letter or international character. * Each resource is limited to a maximum of 64 labels. Both keys and values are additionally constrained to be <= 128 bytes. "a_key": "A String", }, "name": "A String", # Identifier. Name of the `DeliveryPipeline`. Format is `projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}`. The `deliveryPipeline` component must match `[a-z]([a-z0-9-]{0,61}[a-z0-9])?` @@ -201,7 +201,6 @@

Method Details

"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, }, @@ -241,7 +240,6 @@

Method Details

"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -263,7 +261,6 @@

Method Details

"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -283,7 +280,6 @@

Method Details

"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -309,7 +305,6 @@

Method Details

"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, }, @@ -348,7 +343,6 @@

Method Details

"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -370,7 +364,6 @@

Method Details

"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -393,7 +386,6 @@

Method Details

"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -456,7 +448,6 @@

Method Details

"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, }, @@ -493,7 +484,6 @@

Method Details

"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -515,7 +505,6 @@

Method Details

"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -535,7 +524,6 @@

Method Details

"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -661,7 +649,7 @@

Method Details

"createTime": "A String", # Output only. Time at which the pipeline was created. "description": "A String", # Optional. Description of the `DeliveryPipeline`. Max length is 255 characters. "etag": "A String", # This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. - "labels": { # Labels are attributes that can be set and used by both the user and by Cloud Deploy. Labels must meet the following constraints: * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. * All characters must use UTF-8 encoding, and international characters are allowed. * Keys must start with a lowercase letter or international character. * Each resource is limited to a maximum of 64 labels. Both keys and values are additionally constrained to be <= 128 bytes. + "labels": { # Optional. Labels are attributes that can be set and used by both the user and by Cloud Deploy. Labels must meet the following constraints: * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. * All characters must use UTF-8 encoding, and international characters are allowed. * Keys must start with a lowercase letter or international character. * Each resource is limited to a maximum of 64 labels. Both keys and values are additionally constrained to be <= 128 bytes. "a_key": "A String", }, "name": "A String", # Identifier. Name of the `DeliveryPipeline`. Format is `projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}`. The `deliveryPipeline` component must match `[a-z]([a-z0-9-]{0,61}[a-z0-9])?` @@ -701,7 +689,6 @@

Method Details

"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, }, @@ -741,7 +728,6 @@

Method Details

"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -763,7 +749,6 @@

Method Details

"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -783,7 +768,6 @@

Method Details

"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -809,7 +793,6 @@

Method Details

"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, }, @@ -848,7 +831,6 @@

Method Details

"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -870,7 +852,6 @@

Method Details

"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -893,7 +874,6 @@

Method Details

"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -956,7 +936,6 @@

Method Details

"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, }, @@ -993,7 +972,6 @@

Method Details

"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -1015,7 +993,6 @@

Method Details

"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -1035,7 +1012,6 @@

Method Details

"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -1144,7 +1120,7 @@

Method Details

"createTime": "A String", # Output only. Time at which the pipeline was created. "description": "A String", # Optional. Description of the `DeliveryPipeline`. Max length is 255 characters. "etag": "A String", # This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. - "labels": { # Labels are attributes that can be set and used by both the user and by Cloud Deploy. Labels must meet the following constraints: * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. * All characters must use UTF-8 encoding, and international characters are allowed. * Keys must start with a lowercase letter or international character. * Each resource is limited to a maximum of 64 labels. Both keys and values are additionally constrained to be <= 128 bytes. + "labels": { # Optional. Labels are attributes that can be set and used by both the user and by Cloud Deploy. Labels must meet the following constraints: * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. * All characters must use UTF-8 encoding, and international characters are allowed. * Keys must start with a lowercase letter or international character. * Each resource is limited to a maximum of 64 labels. Both keys and values are additionally constrained to be <= 128 bytes. "a_key": "A String", }, "name": "A String", # Identifier. Name of the `DeliveryPipeline`. Format is `projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}`. The `deliveryPipeline` component must match `[a-z]([a-z0-9-]{0,61}[a-z0-9])?` @@ -1184,7 +1160,6 @@

Method Details

"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, }, @@ -1224,7 +1199,6 @@

Method Details

"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -1246,7 +1220,6 @@

Method Details

"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -1266,7 +1239,6 @@

Method Details

"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -1292,7 +1264,6 @@

Method Details

"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, }, @@ -1331,7 +1302,6 @@

Method Details

"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -1353,7 +1323,6 @@

Method Details

"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -1376,7 +1345,6 @@

Method Details

"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -1439,7 +1407,6 @@

Method Details

"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, }, @@ -1476,7 +1443,6 @@

Method Details

"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -1498,7 +1464,6 @@

Method Details

"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -1518,7 +1483,6 @@

Method Details

"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -1588,7 +1552,7 @@

Method Details

"createTime": "A String", # Output only. Time at which the pipeline was created. "description": "A String", # Optional. Description of the `DeliveryPipeline`. Max length is 255 characters. "etag": "A String", # This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. - "labels": { # Labels are attributes that can be set and used by both the user and by Cloud Deploy. Labels must meet the following constraints: * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. * All characters must use UTF-8 encoding, and international characters are allowed. * Keys must start with a lowercase letter or international character. * Each resource is limited to a maximum of 64 labels. Both keys and values are additionally constrained to be <= 128 bytes. + "labels": { # Optional. Labels are attributes that can be set and used by both the user and by Cloud Deploy. Labels must meet the following constraints: * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. * All characters must use UTF-8 encoding, and international characters are allowed. * Keys must start with a lowercase letter or international character. * Each resource is limited to a maximum of 64 labels. Both keys and values are additionally constrained to be <= 128 bytes. "a_key": "A String", }, "name": "A String", # Identifier. Name of the `DeliveryPipeline`. Format is `projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}`. The `deliveryPipeline` component must match `[a-z]([a-z0-9-]{0,61}[a-z0-9])?` @@ -1628,7 +1592,6 @@

Method Details

"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, }, @@ -1668,7 +1631,6 @@

Method Details

"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -1690,7 +1652,6 @@

Method Details

"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -1710,7 +1671,6 @@

Method Details

"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -1736,7 +1696,6 @@

Method Details

"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, }, @@ -1775,7 +1734,6 @@

Method Details

"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -1797,7 +1755,6 @@

Method Details

"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -1820,7 +1777,6 @@

Method Details

"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -1883,7 +1839,6 @@

Method Details

"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, }, @@ -1920,7 +1875,6 @@

Method Details

"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -1942,7 +1896,6 @@

Method Details

"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -1962,7 +1915,6 @@

Method Details

"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -2097,7 +2049,6 @@

Method Details

"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, }, @@ -2140,7 +2091,6 @@

Method Details

"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -2162,7 +2112,6 @@

Method Details

"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -2183,7 +2132,6 @@

Method Details

"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -2211,7 +2159,6 @@

Method Details

"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, }, @@ -2254,7 +2201,6 @@

Method Details

"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -2276,7 +2222,6 @@

Method Details

"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -2297,7 +2242,6 @@

Method Details

"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -2326,7 +2270,6 @@

Method Details

"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, }, @@ -2369,7 +2312,6 @@

Method Details

"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -2391,7 +2333,6 @@

Method Details

"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -2412,7 +2353,6 @@

Method Details

"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -2438,7 +2378,6 @@

Method Details

"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, }, @@ -2481,7 +2420,6 @@

Method Details

"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -2503,7 +2441,6 @@

Method Details

"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -2524,7 +2461,6 @@

Method Details

"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -2550,7 +2486,6 @@

Method Details

"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, }, @@ -2593,7 +2528,6 @@

Method Details

"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -2615,7 +2549,6 @@

Method Details

"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -2636,7 +2569,6 @@

Method Details

"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -2662,7 +2594,6 @@

Method Details

"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, }, @@ -2705,7 +2636,6 @@

Method Details

"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -2727,7 +2657,6 @@

Method Details

"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -2748,7 +2677,6 @@

Method Details

"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -2774,7 +2702,6 @@

Method Details

"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, }, @@ -2817,7 +2744,6 @@

Method Details

"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -2839,7 +2765,6 @@

Method Details

"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -2860,7 +2785,6 @@

Method Details

"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -2969,7 +2893,6 @@

Method Details

"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, }, @@ -3012,7 +2935,6 @@

Method Details

"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -3034,7 +2956,6 @@

Method Details

"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -3055,7 +2976,6 @@

Method Details

"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -3083,7 +3003,6 @@

Method Details

"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, }, @@ -3126,7 +3045,6 @@

Method Details

"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -3148,7 +3066,6 @@

Method Details

"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -3169,7 +3086,6 @@

Method Details

"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -3198,7 +3114,6 @@

Method Details

"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, }, @@ -3241,7 +3156,6 @@

Method Details

"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -3263,7 +3177,6 @@

Method Details

"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -3284,7 +3197,6 @@

Method Details

"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -3310,7 +3222,6 @@

Method Details

"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, }, @@ -3353,7 +3264,6 @@

Method Details

"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -3375,7 +3285,6 @@

Method Details

"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -3396,7 +3305,6 @@

Method Details

"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -3422,7 +3330,6 @@

Method Details

"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, }, @@ -3465,7 +3372,6 @@

Method Details

"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -3487,7 +3393,6 @@

Method Details

"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -3508,7 +3413,6 @@

Method Details

"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -3534,7 +3438,6 @@

Method Details

"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, }, @@ -3577,7 +3480,6 @@

Method Details

"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -3599,7 +3501,6 @@

Method Details

"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -3620,7 +3521,6 @@

Method Details

"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -3646,7 +3546,6 @@

Method Details

"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, }, @@ -3689,7 +3588,6 @@

Method Details

"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -3711,7 +3609,6 @@

Method Details

"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -3732,7 +3629,6 @@

Method Details

"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], diff --git a/docs/dyn/clouddeploy_v1.projects.locations.deliveryPipelines.releases.html b/docs/dyn/clouddeploy_v1.projects.locations.deliveryPipelines.releases.html index 77495399b5..5f64c934b4 100644 --- a/docs/dyn/clouddeploy_v1.projects.locations.deliveryPipelines.releases.html +++ b/docs/dyn/clouddeploy_v1.projects.locations.deliveryPipelines.releases.html @@ -246,7 +246,6 @@

Method Details

"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, "render": { # A Task represents a unit of work that is executed as part of a Job. # Optional. The task responsible for render operations. If not provided then Cloud Deploy will perform its default rendering operation. @@ -261,7 +260,6 @@

Method Details

"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, }, @@ -293,7 +291,7 @@

Method Details

"createTime": "A String", # Output only. Time at which the pipeline was created. "description": "A String", # Optional. Description of the `DeliveryPipeline`. Max length is 255 characters. "etag": "A String", # This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. - "labels": { # Labels are attributes that can be set and used by both the user and by Cloud Deploy. Labels must meet the following constraints: * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. * All characters must use UTF-8 encoding, and international characters are allowed. * Keys must start with a lowercase letter or international character. * Each resource is limited to a maximum of 64 labels. Both keys and values are additionally constrained to be <= 128 bytes. + "labels": { # Optional. Labels are attributes that can be set and used by both the user and by Cloud Deploy. Labels must meet the following constraints: * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. * All characters must use UTF-8 encoding, and international characters are allowed. * Keys must start with a lowercase letter or international character. * Each resource is limited to a maximum of 64 labels. Both keys and values are additionally constrained to be <= 128 bytes. "a_key": "A String", }, "name": "A String", # Identifier. Name of the `DeliveryPipeline`. Format is `projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}`. The `deliveryPipeline` component must match `[a-z]([a-z0-9-]{0,61}[a-z0-9])?` @@ -333,7 +331,6 @@

Method Details

"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, }, @@ -373,7 +370,6 @@

Method Details

"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -395,7 +391,6 @@

Method Details

"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -415,7 +410,6 @@

Method Details

"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -441,7 +435,6 @@

Method Details

"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, }, @@ -480,7 +473,6 @@

Method Details

"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -502,7 +494,6 @@

Method Details

"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -525,7 +516,6 @@

Method Details

"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -588,7 +578,6 @@

Method Details

"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, }, @@ -625,7 +614,6 @@

Method Details

"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -647,7 +635,6 @@

Method Details

"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -667,7 +654,6 @@

Method Details

"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -687,7 +673,7 @@

Method Details

}, "description": "A String", # Optional. Description of the `Release`. Max length is 255 characters. "etag": "A String", # This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. - "labels": { # Labels are attributes that can be set and used by both the user and by Cloud Deploy. Labels must meet the following constraints: * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. * All characters must use UTF-8 encoding, and international characters are allowed. * Keys must start with a lowercase letter or international character. * Each resource is limited to a maximum of 64 labels. Both keys and values are additionally constrained to be <= 128 bytes. + "labels": { # Optional. Labels are attributes that can be set and used by both the user and by Cloud Deploy. Labels must meet the following constraints: * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. * All characters must use UTF-8 encoding, and international characters are allowed. * Keys must start with a lowercase letter or international character. * Each resource is limited to a maximum of 64 labels. Both keys and values are additionally constrained to be <= 128 bytes. "a_key": "A String", }, "name": "A String", # Identifier. Name of the `Release`. Format is `projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/releases/{release}`. The `release` component must match `[a-z]([a-z0-9-]{0,61}[a-z0-9])?` @@ -984,7 +970,6 @@

Method Details

"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, "render": { # A Task represents a unit of work that is executed as part of a Job. # Optional. The task responsible for render operations. If not provided then Cloud Deploy will perform its default rendering operation. @@ -999,7 +984,6 @@

Method Details

"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, }, @@ -1031,7 +1015,7 @@

Method Details

"createTime": "A String", # Output only. Time at which the pipeline was created. "description": "A String", # Optional. Description of the `DeliveryPipeline`. Max length is 255 characters. "etag": "A String", # This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. - "labels": { # Labels are attributes that can be set and used by both the user and by Cloud Deploy. Labels must meet the following constraints: * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. * All characters must use UTF-8 encoding, and international characters are allowed. * Keys must start with a lowercase letter or international character. * Each resource is limited to a maximum of 64 labels. Both keys and values are additionally constrained to be <= 128 bytes. + "labels": { # Optional. Labels are attributes that can be set and used by both the user and by Cloud Deploy. Labels must meet the following constraints: * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. * All characters must use UTF-8 encoding, and international characters are allowed. * Keys must start with a lowercase letter or international character. * Each resource is limited to a maximum of 64 labels. Both keys and values are additionally constrained to be <= 128 bytes. "a_key": "A String", }, "name": "A String", # Identifier. Name of the `DeliveryPipeline`. Format is `projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}`. The `deliveryPipeline` component must match `[a-z]([a-z0-9-]{0,61}[a-z0-9])?` @@ -1071,7 +1055,6 @@

Method Details

"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, }, @@ -1111,7 +1094,6 @@

Method Details

"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -1133,7 +1115,6 @@

Method Details

"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -1153,7 +1134,6 @@

Method Details

"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -1179,7 +1159,6 @@

Method Details

"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, }, @@ -1218,7 +1197,6 @@

Method Details

"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -1240,7 +1218,6 @@

Method Details

"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -1263,7 +1240,6 @@

Method Details

"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -1326,7 +1302,6 @@

Method Details

"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, }, @@ -1363,7 +1338,6 @@

Method Details

"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -1385,7 +1359,6 @@

Method Details

"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -1405,7 +1378,6 @@

Method Details

"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -1425,7 +1397,7 @@

Method Details

}, "description": "A String", # Optional. Description of the `Release`. Max length is 255 characters. "etag": "A String", # This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. - "labels": { # Labels are attributes that can be set and used by both the user and by Cloud Deploy. Labels must meet the following constraints: * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. * All characters must use UTF-8 encoding, and international characters are allowed. * Keys must start with a lowercase letter or international character. * Each resource is limited to a maximum of 64 labels. Both keys and values are additionally constrained to be <= 128 bytes. + "labels": { # Optional. Labels are attributes that can be set and used by both the user and by Cloud Deploy. Labels must meet the following constraints: * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. * All characters must use UTF-8 encoding, and international characters are allowed. * Keys must start with a lowercase letter or international character. * Each resource is limited to a maximum of 64 labels. Both keys and values are additionally constrained to be <= 128 bytes. "a_key": "A String", }, "name": "A String", # Identifier. Name of the `Release`. Format is `projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/releases/{release}`. The `release` component must match `[a-z]([a-z0-9-]{0,61}[a-z0-9])?` @@ -1697,7 +1669,6 @@

Method Details

"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, "render": { # A Task represents a unit of work that is executed as part of a Job. # Optional. The task responsible for render operations. If not provided then Cloud Deploy will perform its default rendering operation. @@ -1712,7 +1683,6 @@

Method Details

"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, }, @@ -1744,7 +1714,7 @@

Method Details

"createTime": "A String", # Output only. Time at which the pipeline was created. "description": "A String", # Optional. Description of the `DeliveryPipeline`. Max length is 255 characters. "etag": "A String", # This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. - "labels": { # Labels are attributes that can be set and used by both the user and by Cloud Deploy. Labels must meet the following constraints: * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. * All characters must use UTF-8 encoding, and international characters are allowed. * Keys must start with a lowercase letter or international character. * Each resource is limited to a maximum of 64 labels. Both keys and values are additionally constrained to be <= 128 bytes. + "labels": { # Optional. Labels are attributes that can be set and used by both the user and by Cloud Deploy. Labels must meet the following constraints: * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. * All characters must use UTF-8 encoding, and international characters are allowed. * Keys must start with a lowercase letter or international character. * Each resource is limited to a maximum of 64 labels. Both keys and values are additionally constrained to be <= 128 bytes. "a_key": "A String", }, "name": "A String", # Identifier. Name of the `DeliveryPipeline`. Format is `projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}`. The `deliveryPipeline` component must match `[a-z]([a-z0-9-]{0,61}[a-z0-9])?` @@ -1784,7 +1754,6 @@

Method Details

"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, }, @@ -1824,7 +1793,6 @@

Method Details

"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -1846,7 +1814,6 @@

Method Details

"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -1866,7 +1833,6 @@

Method Details

"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -1892,7 +1858,6 @@

Method Details

"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, }, @@ -1931,7 +1896,6 @@

Method Details

"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -1953,7 +1917,6 @@

Method Details

"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -1976,7 +1939,6 @@

Method Details

"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -2039,7 +2001,6 @@

Method Details

"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, }, @@ -2076,7 +2037,6 @@

Method Details

"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -2098,7 +2058,6 @@

Method Details

"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -2118,7 +2077,6 @@

Method Details

"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -2138,7 +2096,7 @@

Method Details

}, "description": "A String", # Optional. Description of the `Release`. Max length is 255 characters. "etag": "A String", # This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. - "labels": { # Labels are attributes that can be set and used by both the user and by Cloud Deploy. Labels must meet the following constraints: * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. * All characters must use UTF-8 encoding, and international characters are allowed. * Keys must start with a lowercase letter or international character. * Each resource is limited to a maximum of 64 labels. Both keys and values are additionally constrained to be <= 128 bytes. + "labels": { # Optional. Labels are attributes that can be set and used by both the user and by Cloud Deploy. Labels must meet the following constraints: * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. * All characters must use UTF-8 encoding, and international characters are allowed. * Keys must start with a lowercase letter or international character. * Each resource is limited to a maximum of 64 labels. Both keys and values are additionally constrained to be <= 128 bytes. "a_key": "A String", }, "name": "A String", # Identifier. Name of the `Release`. Format is `projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/releases/{release}`. The `release` component must match `[a-z]([a-z0-9-]{0,61}[a-z0-9])?` diff --git a/docs/dyn/clouddeploy_v1.projects.locations.deliveryPipelines.releases.rollouts.html b/docs/dyn/clouddeploy_v1.projects.locations.deliveryPipelines.releases.rollouts.html index 2f976afbe5..7bd2324c7d 100644 --- a/docs/dyn/clouddeploy_v1.projects.locations.deliveryPipelines.releases.rollouts.html +++ b/docs/dyn/clouddeploy_v1.projects.locations.deliveryPipelines.releases.rollouts.html @@ -278,7 +278,6 @@

Method Details

"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, }, @@ -321,7 +320,6 @@

Method Details

"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -343,7 +341,6 @@

Method Details

"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -364,7 +361,6 @@

Method Details

"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -392,7 +388,6 @@

Method Details

"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, }, @@ -435,7 +430,6 @@

Method Details

"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -457,7 +451,6 @@

Method Details

"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -478,7 +471,6 @@

Method Details

"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -507,7 +499,6 @@

Method Details

"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, }, @@ -550,7 +541,6 @@

Method Details

"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -572,7 +562,6 @@

Method Details

"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -593,7 +582,6 @@

Method Details

"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -619,7 +607,6 @@

Method Details

"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, }, @@ -662,7 +649,6 @@

Method Details

"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -684,7 +670,6 @@

Method Details

"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -705,7 +690,6 @@

Method Details

"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -731,7 +715,6 @@

Method Details

"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, }, @@ -774,7 +757,6 @@

Method Details

"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -796,7 +778,6 @@

Method Details

"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -817,7 +798,6 @@

Method Details

"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -843,7 +823,6 @@

Method Details

"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, }, @@ -886,7 +865,6 @@

Method Details

"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -908,7 +886,6 @@

Method Details

"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -929,7 +906,6 @@

Method Details

"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -955,7 +931,6 @@

Method Details

"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, }, @@ -998,7 +973,6 @@

Method Details

"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -1020,7 +994,6 @@

Method Details

"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -1041,7 +1014,6 @@

Method Details

"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -1181,7 +1153,6 @@

Method Details

"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, }, @@ -1224,7 +1195,6 @@

Method Details

"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -1246,7 +1216,6 @@

Method Details

"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -1267,7 +1236,6 @@

Method Details

"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -1295,7 +1263,6 @@

Method Details

"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, }, @@ -1338,7 +1305,6 @@

Method Details

"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -1360,7 +1326,6 @@

Method Details

"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -1381,7 +1346,6 @@

Method Details

"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -1410,7 +1374,6 @@

Method Details

"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, }, @@ -1453,7 +1416,6 @@

Method Details

"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -1475,7 +1437,6 @@

Method Details

"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -1496,7 +1457,6 @@

Method Details

"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -1522,7 +1482,6 @@

Method Details

"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, }, @@ -1565,7 +1524,6 @@

Method Details

"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -1587,7 +1545,6 @@

Method Details

"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -1608,7 +1565,6 @@

Method Details

"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -1634,7 +1590,6 @@

Method Details

"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, }, @@ -1677,7 +1632,6 @@

Method Details

"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -1699,7 +1653,6 @@

Method Details

"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -1720,7 +1673,6 @@

Method Details

"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -1746,7 +1698,6 @@

Method Details

"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, }, @@ -1789,7 +1740,6 @@

Method Details

"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -1811,7 +1761,6 @@

Method Details

"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -1832,7 +1781,6 @@

Method Details

"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -1858,7 +1806,6 @@

Method Details

"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, }, @@ -1901,7 +1848,6 @@

Method Details

"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -1923,7 +1869,6 @@

Method Details

"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -1944,7 +1889,6 @@

Method Details

"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -2087,7 +2031,6 @@

Method Details

"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, }, @@ -2130,7 +2073,6 @@

Method Details

"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -2152,7 +2094,6 @@

Method Details

"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -2173,7 +2114,6 @@

Method Details

"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -2201,7 +2141,6 @@

Method Details

"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, }, @@ -2244,7 +2183,6 @@

Method Details

"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -2266,7 +2204,6 @@

Method Details

"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -2287,7 +2224,6 @@

Method Details

"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -2316,7 +2252,6 @@

Method Details

"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, }, @@ -2359,7 +2294,6 @@

Method Details

"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -2381,7 +2315,6 @@

Method Details

"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -2402,7 +2335,6 @@

Method Details

"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -2428,7 +2360,6 @@

Method Details

"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, }, @@ -2471,7 +2402,6 @@

Method Details

"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -2493,7 +2423,6 @@

Method Details

"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -2514,7 +2443,6 @@

Method Details

"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -2540,7 +2468,6 @@

Method Details

"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, }, @@ -2583,7 +2510,6 @@

Method Details

"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -2605,7 +2531,6 @@

Method Details

"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -2626,7 +2551,6 @@

Method Details

"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -2652,7 +2576,6 @@

Method Details

"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, }, @@ -2695,7 +2618,6 @@

Method Details

"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -2717,7 +2639,6 @@

Method Details

"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -2738,7 +2659,6 @@

Method Details

"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -2764,7 +2684,6 @@

Method Details

"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, }, @@ -2807,7 +2726,6 @@

Method Details

"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -2829,7 +2747,6 @@

Method Details

"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -2850,7 +2767,6 @@

Method Details

"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], diff --git a/docs/dyn/clouddeploy_v1.projects.locations.deliveryPipelines.releases.rollouts.jobRuns.html b/docs/dyn/clouddeploy_v1.projects.locations.deliveryPipelines.releases.rollouts.jobRuns.html index 175365a62d..7cbec0284c 100644 --- a/docs/dyn/clouddeploy_v1.projects.locations.deliveryPipelines.releases.rollouts.jobRuns.html +++ b/docs/dyn/clouddeploy_v1.projects.locations.deliveryPipelines.releases.rollouts.jobRuns.html @@ -159,7 +159,6 @@

Method Details

"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, }, @@ -321,7 +320,6 @@

Method Details

"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, }, diff --git a/docs/dyn/cloudidentity_v1.policies.html b/docs/dyn/cloudidentity_v1.policies.html index dbd1ec446f..7159aa3a63 100644 --- a/docs/dyn/cloudidentity_v1.policies.html +++ b/docs/dyn/cloudidentity_v1.policies.html @@ -115,7 +115,7 @@

Method Details

"policyQuery": { # PolicyQuery # Required. The PolicyQuery the Setting applies to. "group": "A String", # Immutable. The group that the query applies to. This field is only set if there is a single value for group that satisfies all clauses of the query. If no group applies, this will be the empty string. "orgUnit": "A String", # Required. Immutable. Non-empty default. The OrgUnit the query applies to. This field is only set if there is a single value for org_unit that satisfies all clauses of the query. - "query": "A String", # Immutable. The CEL query that defines which entities the Policy applies to (ex. a User entity). For details about CEL see https://opensource.google.com/projects/cel. The OrgUnits the Policy applies to are represented by a clause like so: entity.org_units.exists(org_unit, org_unit.org_unit_id == orgUnitId('{orgUnitId}')) The Group the Policy applies to are represented by a clause like so: entity.groups.exists(group, group.group_id == groupId('{groupId}')) The Licenses the Policy applies to are represented by a clause like so: entity.licenses.exists(license, license in ['/product/{productId}/sku/{skuId}']) The above clauses can be present in any combination, and used in conjunction with the &&, || and ! operators. The org_unit and group fields below are helper fields that contain the corresponding value(s) as the query to make the query easier to use. + "query": "A String", # Immutable. The CEL query that defines which entities the Policy applies to (ex. a User entity). For details about CEL see https://opensource.google.com/projects/cel. The OrgUnits the Policy applies to are represented by a clause like so: entity.org_units.exists(org_unit, org_unit.org_unit_id == orgUnitId('{orgUnitId}')) The Group the Policy applies to are represented by a clause like so: entity.groups.exists(group, group.group_id == groupId('{groupId}')) The Licenses the Policy applies to are represented by a clause like so: entity.licenses.exists(license, license in ['/product/{productId}/sku/{skuId}']) **Note:** The licenses clause is not supported in mutate endpoints. The above clauses can be present in any combination, and used in conjunction with the &&, || and ! operators. The org_unit and group fields below are helper fields that contain the corresponding value(s) as the query to make the query easier to use. "sortOrder": 3.14, # Output only. The decimal sort order of this PolicyQuery. The value is relative to all other policies with the same setting type for the customer. (There are no duplicates within this set). }, "setting": { # Setting # Required. The Setting configured by this Policy. @@ -211,7 +211,7 @@

Method Details

"policyQuery": { # PolicyQuery # Required. The PolicyQuery the Setting applies to. "group": "A String", # Immutable. The group that the query applies to. This field is only set if there is a single value for group that satisfies all clauses of the query. If no group applies, this will be the empty string. "orgUnit": "A String", # Required. Immutable. Non-empty default. The OrgUnit the query applies to. This field is only set if there is a single value for org_unit that satisfies all clauses of the query. - "query": "A String", # Immutable. The CEL query that defines which entities the Policy applies to (ex. a User entity). For details about CEL see https://opensource.google.com/projects/cel. The OrgUnits the Policy applies to are represented by a clause like so: entity.org_units.exists(org_unit, org_unit.org_unit_id == orgUnitId('{orgUnitId}')) The Group the Policy applies to are represented by a clause like so: entity.groups.exists(group, group.group_id == groupId('{groupId}')) The Licenses the Policy applies to are represented by a clause like so: entity.licenses.exists(license, license in ['/product/{productId}/sku/{skuId}']) The above clauses can be present in any combination, and used in conjunction with the &&, || and ! operators. The org_unit and group fields below are helper fields that contain the corresponding value(s) as the query to make the query easier to use. + "query": "A String", # Immutable. The CEL query that defines which entities the Policy applies to (ex. a User entity). For details about CEL see https://opensource.google.com/projects/cel. The OrgUnits the Policy applies to are represented by a clause like so: entity.org_units.exists(org_unit, org_unit.org_unit_id == orgUnitId('{orgUnitId}')) The Group the Policy applies to are represented by a clause like so: entity.groups.exists(group, group.group_id == groupId('{groupId}')) The Licenses the Policy applies to are represented by a clause like so: entity.licenses.exists(license, license in ['/product/{productId}/sku/{skuId}']) **Note:** The licenses clause is not supported in mutate endpoints. The above clauses can be present in any combination, and used in conjunction with the &&, || and ! operators. The org_unit and group fields below are helper fields that contain the corresponding value(s) as the query to make the query easier to use. "sortOrder": 3.14, # Output only. The decimal sort order of this PolicyQuery. The value is relative to all other policies with the same setting type for the customer. (There are no duplicates within this set). }, "setting": { # Setting # Required. The Setting configured by this Policy. @@ -229,7 +229,7 @@

Method Details

List policies.
 
 Args:
-  filter: string, Optional. A CEL expression for filtering the results. Policies can be filtered by application with this expression: setting.type.matches('^settings/gmail\\..*$') Policies can be filtered by setting type with this expression: setting.type.matches('^.*\\.service_status$') A maximum of one of the above setting.type clauses can be used. Policies can be filtered by customer with this expression: customer == "customers/{customer}" Where `customer` is the `id` from the [Admin SDK `Customer` resource](https://developers.google.com/admin-sdk/directory/reference/rest/v1/customers). You may use `customers/my_customer` to specify your own organization. When no customer is mentioned it will be default to customers/my_customer. A maximum of one customer clause can be used. The above clauses can only be combined together in a single filter expression with the `&&` operator.
+  filter: string, Optional. A CEL expression for filtering the results. Policies can be filtered by application with this expression: setting.type.matches('^settings/gmail\\..*$') Policies can be filtered by setting type with this expression: setting.type.matches('^.*\\.service_status$') Policies can be filtered by customer with this expression: customer == "customers/{customer}" Where `customer` is the `id` from the [Admin SDK `Customer` resource](https://developers.google.com/admin-sdk/directory/reference/rest/v1/customers). You may use `customers/my_customer` to specify your own organization. When no customer is mentioned it will be default to customers/my_customer. You may only filter on policies for a single customer at a time. The above clauses can be combined together in a single filter expression with the `&&` and `||` operators, like in the following example: customer == "customers/my_customer" && ( setting.type.matches('^settings/gmail\\..*$') || setting.type.matches('^.*\\.service_status$') )
   pageSize: integer, Optional. The maximum number of results to return. The service can return fewer than this number. If omitted or set to 0, the default is 50 results per page. The maximum allowed value is 100. `page_size` values greater than 100 default to 100.
   pageToken: string, Optional. The pagination token received from a prior call to PoliciesService.ListPolicies to retrieve the next page of results. When paginating, all other parameters provided to `ListPoliciesRequest` must match the call that provided the page token.
   x__xgafv: string, V1 error format.
@@ -249,7 +249,7 @@ 

Method Details

"policyQuery": { # PolicyQuery # Required. The PolicyQuery the Setting applies to. "group": "A String", # Immutable. The group that the query applies to. This field is only set if there is a single value for group that satisfies all clauses of the query. If no group applies, this will be the empty string. "orgUnit": "A String", # Required. Immutable. Non-empty default. The OrgUnit the query applies to. This field is only set if there is a single value for org_unit that satisfies all clauses of the query. - "query": "A String", # Immutable. The CEL query that defines which entities the Policy applies to (ex. a User entity). For details about CEL see https://opensource.google.com/projects/cel. The OrgUnits the Policy applies to are represented by a clause like so: entity.org_units.exists(org_unit, org_unit.org_unit_id == orgUnitId('{orgUnitId}')) The Group the Policy applies to are represented by a clause like so: entity.groups.exists(group, group.group_id == groupId('{groupId}')) The Licenses the Policy applies to are represented by a clause like so: entity.licenses.exists(license, license in ['/product/{productId}/sku/{skuId}']) The above clauses can be present in any combination, and used in conjunction with the &&, || and ! operators. The org_unit and group fields below are helper fields that contain the corresponding value(s) as the query to make the query easier to use. + "query": "A String", # Immutable. The CEL query that defines which entities the Policy applies to (ex. a User entity). For details about CEL see https://opensource.google.com/projects/cel. The OrgUnits the Policy applies to are represented by a clause like so: entity.org_units.exists(org_unit, org_unit.org_unit_id == orgUnitId('{orgUnitId}')) The Group the Policy applies to are represented by a clause like so: entity.groups.exists(group, group.group_id == groupId('{groupId}')) The Licenses the Policy applies to are represented by a clause like so: entity.licenses.exists(license, license in ['/product/{productId}/sku/{skuId}']) **Note:** The licenses clause is not supported in mutate endpoints. The above clauses can be present in any combination, and used in conjunction with the &&, || and ! operators. The org_unit and group fields below are helper fields that contain the corresponding value(s) as the query to make the query easier to use. "sortOrder": 3.14, # Output only. The decimal sort order of this PolicyQuery. The value is relative to all other policies with the same setting type for the customer. (There are no duplicates within this set). }, "setting": { # Setting # Required. The Setting configured by this Policy. @@ -293,7 +293,7 @@

Method Details

"policyQuery": { # PolicyQuery # Required. The PolicyQuery the Setting applies to. "group": "A String", # Immutable. The group that the query applies to. This field is only set if there is a single value for group that satisfies all clauses of the query. If no group applies, this will be the empty string. "orgUnit": "A String", # Required. Immutable. Non-empty default. The OrgUnit the query applies to. This field is only set if there is a single value for org_unit that satisfies all clauses of the query. - "query": "A String", # Immutable. The CEL query that defines which entities the Policy applies to (ex. a User entity). For details about CEL see https://opensource.google.com/projects/cel. The OrgUnits the Policy applies to are represented by a clause like so: entity.org_units.exists(org_unit, org_unit.org_unit_id == orgUnitId('{orgUnitId}')) The Group the Policy applies to are represented by a clause like so: entity.groups.exists(group, group.group_id == groupId('{groupId}')) The Licenses the Policy applies to are represented by a clause like so: entity.licenses.exists(license, license in ['/product/{productId}/sku/{skuId}']) The above clauses can be present in any combination, and used in conjunction with the &&, || and ! operators. The org_unit and group fields below are helper fields that contain the corresponding value(s) as the query to make the query easier to use. + "query": "A String", # Immutable. The CEL query that defines which entities the Policy applies to (ex. a User entity). For details about CEL see https://opensource.google.com/projects/cel. The OrgUnits the Policy applies to are represented by a clause like so: entity.org_units.exists(org_unit, org_unit.org_unit_id == orgUnitId('{orgUnitId}')) The Group the Policy applies to are represented by a clause like so: entity.groups.exists(group, group.group_id == groupId('{groupId}')) The Licenses the Policy applies to are represented by a clause like so: entity.licenses.exists(license, license in ['/product/{productId}/sku/{skuId}']) **Note:** The licenses clause is not supported in mutate endpoints. The above clauses can be present in any combination, and used in conjunction with the &&, || and ! operators. The org_unit and group fields below are helper fields that contain the corresponding value(s) as the query to make the query easier to use. "sortOrder": 3.14, # Output only. The decimal sort order of this PolicyQuery. The value is relative to all other policies with the same setting type for the customer. (There are no duplicates within this set). }, "setting": { # Setting # Required. The Setting configured by this Policy. diff --git a/docs/dyn/cloudidentity_v1beta1.policies.html b/docs/dyn/cloudidentity_v1beta1.policies.html index 962675c3f9..0336f73df8 100644 --- a/docs/dyn/cloudidentity_v1beta1.policies.html +++ b/docs/dyn/cloudidentity_v1beta1.policies.html @@ -115,7 +115,7 @@

Method Details

"policyQuery": { # PolicyQuery # Required. The PolicyQuery the Setting applies to. "group": "A String", # Immutable. The group that the query applies to. This field is only set if there is a single value for group that satisfies all clauses of the query. If no group applies, this will be the empty string. "orgUnit": "A String", # Required. Immutable. Non-empty default. The OrgUnit the query applies to. This field is only set if there is a single value for org_unit that satisfies all clauses of the query. - "query": "A String", # Immutable. The CEL query that defines which entities the Policy applies to (ex. a User entity). For details about CEL see https://opensource.google.com/projects/cel. The OrgUnits the Policy applies to are represented by a clause like so: entity.org_units.exists(org_unit, org_unit.org_unit_id == orgUnitId('{orgUnitId}')) The Group the Policy applies to are represented by a clause like so: entity.groups.exists(group, group.group_id == groupId('{groupId}')) The Licenses the Policy applies to are represented by a clause like so: entity.licenses.exists(license, license in ['/product/{productId}/sku/{skuId}']) The above clauses can be present in any combination, and used in conjunction with the &&, || and ! operators. The org_unit and group fields below are helper fields that contain the corresponding value(s) as the query to make the query easier to use. + "query": "A String", # Immutable. The CEL query that defines which entities the Policy applies to (ex. a User entity). For details about CEL see https://opensource.google.com/projects/cel. The OrgUnits the Policy applies to are represented by a clause like so: entity.org_units.exists(org_unit, org_unit.org_unit_id == orgUnitId('{orgUnitId}')) The Group the Policy applies to are represented by a clause like so: entity.groups.exists(group, group.group_id == groupId('{groupId}')) The Licenses the Policy applies to are represented by a clause like so: entity.licenses.exists(license, license in ['/product/{productId}/sku/{skuId}']) **Note:** The licenses clause is not supported in mutate endpoints. The above clauses can be present in any combination, and used in conjunction with the &&, || and ! operators. The org_unit and group fields below are helper fields that contain the corresponding value(s) as the query to make the query easier to use. "sortOrder": 3.14, # Output only. The decimal sort order of this PolicyQuery. The value is relative to all other policies with the same setting type for the customer. (There are no duplicates within this set). }, "setting": { # Setting # Required. The Setting configured by this Policy. @@ -211,7 +211,7 @@

Method Details

"policyQuery": { # PolicyQuery # Required. The PolicyQuery the Setting applies to. "group": "A String", # Immutable. The group that the query applies to. This field is only set if there is a single value for group that satisfies all clauses of the query. If no group applies, this will be the empty string. "orgUnit": "A String", # Required. Immutable. Non-empty default. The OrgUnit the query applies to. This field is only set if there is a single value for org_unit that satisfies all clauses of the query. - "query": "A String", # Immutable. The CEL query that defines which entities the Policy applies to (ex. a User entity). For details about CEL see https://opensource.google.com/projects/cel. The OrgUnits the Policy applies to are represented by a clause like so: entity.org_units.exists(org_unit, org_unit.org_unit_id == orgUnitId('{orgUnitId}')) The Group the Policy applies to are represented by a clause like so: entity.groups.exists(group, group.group_id == groupId('{groupId}')) The Licenses the Policy applies to are represented by a clause like so: entity.licenses.exists(license, license in ['/product/{productId}/sku/{skuId}']) The above clauses can be present in any combination, and used in conjunction with the &&, || and ! operators. The org_unit and group fields below are helper fields that contain the corresponding value(s) as the query to make the query easier to use. + "query": "A String", # Immutable. The CEL query that defines which entities the Policy applies to (ex. a User entity). For details about CEL see https://opensource.google.com/projects/cel. The OrgUnits the Policy applies to are represented by a clause like so: entity.org_units.exists(org_unit, org_unit.org_unit_id == orgUnitId('{orgUnitId}')) The Group the Policy applies to are represented by a clause like so: entity.groups.exists(group, group.group_id == groupId('{groupId}')) The Licenses the Policy applies to are represented by a clause like so: entity.licenses.exists(license, license in ['/product/{productId}/sku/{skuId}']) **Note:** The licenses clause is not supported in mutate endpoints. The above clauses can be present in any combination, and used in conjunction with the &&, || and ! operators. The org_unit and group fields below are helper fields that contain the corresponding value(s) as the query to make the query easier to use. "sortOrder": 3.14, # Output only. The decimal sort order of this PolicyQuery. The value is relative to all other policies with the same setting type for the customer. (There are no duplicates within this set). }, "setting": { # Setting # Required. The Setting configured by this Policy. @@ -229,7 +229,7 @@

Method Details

List policies.
 
 Args:
-  filter: string, Optional. A CEL expression for filtering the results. Policies can be filtered by application with this expression: setting.type.matches('^settings/gmail\\..*$') Policies can be filtered by setting type with this expression: setting.type.matches('^.*\\.service_status$') A maximum of one of the above setting.type clauses can be used. Policies can be filtered by customer with this expression: customer == "customers/{customer}" Where `customer` is the `id` from the [Admin SDK `Customer` resource](https://developers.google.com/admin-sdk/directory/reference/rest/v1/customers). You may use `customers/my_customer` to specify your own organization. When no customer is mentioned it will be default to customers/my_customer. A maximum of one customer clause can be used. The above clauses can only be combined together in a single filter expression with the `&&` operator.
+  filter: string, Optional. A CEL expression for filtering the results. Policies can be filtered by application with this expression: setting.type.matches('^settings/gmail\\..*$') Policies can be filtered by setting type with this expression: setting.type.matches('^.*\\.service_status$') Policies can be filtered by customer with this expression: customer == "customers/{customer}" Where `customer` is the `id` from the [Admin SDK `Customer` resource](https://developers.google.com/admin-sdk/directory/reference/rest/v1/customers). You may use `customers/my_customer` to specify your own organization. When no customer is mentioned it will be default to customers/my_customer. You may only filter on policies for a single customer at a time. The above clauses can be combined together in a single filter expression with the `&&` and `||` operators, like in the following example: customer == "customers/my_customer" && ( setting.type.matches('^settings/gmail\\..*$') || setting.type.matches('^.*\\.service_status$') )
   pageSize: integer, Optional. The maximum number of results to return. The service can return fewer than this number. If omitted or set to 0, the default is 50 results per page. The maximum allowed value is 100. `page_size` values greater than 100 default to 100.
   pageToken: string, Optional. The pagination token received from a prior call to PoliciesService.ListPolicies to retrieve the next page of results. When paginating, all other parameters provided to `ListPoliciesRequest` must match the call that provided the page token.
   x__xgafv: string, V1 error format.
@@ -249,7 +249,7 @@ 

Method Details

"policyQuery": { # PolicyQuery # Required. The PolicyQuery the Setting applies to. "group": "A String", # Immutable. The group that the query applies to. This field is only set if there is a single value for group that satisfies all clauses of the query. If no group applies, this will be the empty string. "orgUnit": "A String", # Required. Immutable. Non-empty default. The OrgUnit the query applies to. This field is only set if there is a single value for org_unit that satisfies all clauses of the query. - "query": "A String", # Immutable. The CEL query that defines which entities the Policy applies to (ex. a User entity). For details about CEL see https://opensource.google.com/projects/cel. The OrgUnits the Policy applies to are represented by a clause like so: entity.org_units.exists(org_unit, org_unit.org_unit_id == orgUnitId('{orgUnitId}')) The Group the Policy applies to are represented by a clause like so: entity.groups.exists(group, group.group_id == groupId('{groupId}')) The Licenses the Policy applies to are represented by a clause like so: entity.licenses.exists(license, license in ['/product/{productId}/sku/{skuId}']) The above clauses can be present in any combination, and used in conjunction with the &&, || and ! operators. The org_unit and group fields below are helper fields that contain the corresponding value(s) as the query to make the query easier to use. + "query": "A String", # Immutable. The CEL query that defines which entities the Policy applies to (ex. a User entity). For details about CEL see https://opensource.google.com/projects/cel. The OrgUnits the Policy applies to are represented by a clause like so: entity.org_units.exists(org_unit, org_unit.org_unit_id == orgUnitId('{orgUnitId}')) The Group the Policy applies to are represented by a clause like so: entity.groups.exists(group, group.group_id == groupId('{groupId}')) The Licenses the Policy applies to are represented by a clause like so: entity.licenses.exists(license, license in ['/product/{productId}/sku/{skuId}']) **Note:** The licenses clause is not supported in mutate endpoints. The above clauses can be present in any combination, and used in conjunction with the &&, || and ! operators. The org_unit and group fields below are helper fields that contain the corresponding value(s) as the query to make the query easier to use. "sortOrder": 3.14, # Output only. The decimal sort order of this PolicyQuery. The value is relative to all other policies with the same setting type for the customer. (There are no duplicates within this set). }, "setting": { # Setting # Required. The Setting configured by this Policy. @@ -293,7 +293,7 @@

Method Details

"policyQuery": { # PolicyQuery # Required. The PolicyQuery the Setting applies to. "group": "A String", # Immutable. The group that the query applies to. This field is only set if there is a single value for group that satisfies all clauses of the query. If no group applies, this will be the empty string. "orgUnit": "A String", # Required. Immutable. Non-empty default. The OrgUnit the query applies to. This field is only set if there is a single value for org_unit that satisfies all clauses of the query. - "query": "A String", # Immutable. The CEL query that defines which entities the Policy applies to (ex. a User entity). For details about CEL see https://opensource.google.com/projects/cel. The OrgUnits the Policy applies to are represented by a clause like so: entity.org_units.exists(org_unit, org_unit.org_unit_id == orgUnitId('{orgUnitId}')) The Group the Policy applies to are represented by a clause like so: entity.groups.exists(group, group.group_id == groupId('{groupId}')) The Licenses the Policy applies to are represented by a clause like so: entity.licenses.exists(license, license in ['/product/{productId}/sku/{skuId}']) The above clauses can be present in any combination, and used in conjunction with the &&, || and ! operators. The org_unit and group fields below are helper fields that contain the corresponding value(s) as the query to make the query easier to use. + "query": "A String", # Immutable. The CEL query that defines which entities the Policy applies to (ex. a User entity). For details about CEL see https://opensource.google.com/projects/cel. The OrgUnits the Policy applies to are represented by a clause like so: entity.org_units.exists(org_unit, org_unit.org_unit_id == orgUnitId('{orgUnitId}')) The Group the Policy applies to are represented by a clause like so: entity.groups.exists(group, group.group_id == groupId('{groupId}')) The Licenses the Policy applies to are represented by a clause like so: entity.licenses.exists(license, license in ['/product/{productId}/sku/{skuId}']) **Note:** The licenses clause is not supported in mutate endpoints. The above clauses can be present in any combination, and used in conjunction with the &&, || and ! operators. The org_unit and group fields below are helper fields that contain the corresponding value(s) as the query to make the query easier to use. "sortOrder": 3.14, # Output only. The decimal sort order of this PolicyQuery. The value is relative to all other policies with the same setting type for the customer. (There are no duplicates within this set). }, "setting": { # Setting # Required. The Setting configured by this Policy. diff --git a/docs/dyn/cloudkms_v1.folders.html b/docs/dyn/cloudkms_v1.folders.html index dece1463c1..87534408e1 100644 --- a/docs/dyn/cloudkms_v1.folders.html +++ b/docs/dyn/cloudkms_v1.folders.html @@ -100,7 +100,7 @@

Method Details

Returns the AutokeyConfig for a folder or project.
 
 Args:
-  name: string, Required. Name of the AutokeyConfig resource, e.g. `folders/{FOLDER_NUMBER}/autokeyConfig` or `projects/{PROJECT_NUMBER}/autokeyConfig`. (required)
+  name: string, Required. Name of the AutokeyConfig resource, e.g. `folders/{FOLDER_NUMBER}/autokeyConfig`, `projects/{PROJECT_NUMBER}/autokeyConfig`, or `projects/{PROJECT_ID}/autokeyConfig`. (required)
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -113,7 +113,7 @@ 

Method Details

"etag": "A String", # Optional. A checksum computed by the server based on the value of other fields. This may be sent on update requests to ensure that the client has an up-to-date value before proceeding. The request will be rejected with an ABORTED error on a mismatched etag. "keyProject": "A String", # Optional. Name of the key project, e.g. `projects/{PROJECT_ID}` or `projects/{PROJECT_NUMBER}`, where Cloud KMS Autokey will provision a new CryptoKey when a KeyHandle is created. On UpdateAutokeyConfig, the caller will require `cloudkms.cryptoKeys.setIamPolicy` permission on this key project. Once configured, for Cloud KMS Autokey to function properly, this key project must have the Cloud KMS API activated and the Cloud KMS Service Agent for this key project must be granted the `cloudkms.admin` role (or pertinent permissions). A request with an empty key project field will clear the configuration. "keyProjectResolutionMode": "A String", # Optional. KeyProjectResolutionMode for the AutokeyConfig. Valid values are `DEDICATED_KEY_PROJECT`, `RESOURCE_PROJECT`, or `DISABLED`. - "name": "A String", # Identifier. Name of the AutokeyConfig resource, e.g. `folders/{FOLDER_NUMBER}/autokeyConfig` or `projects/{PROJECT_NUMBER}/autokeyConfig`. + "name": "A String", # Identifier. Name of the AutokeyConfig resource, e.g. `folders/{FOLDER_NUMBER}/autokeyConfig`, `projects/{PROJECT_NUMBER}/autokeyConfig`, or `projects/{PROJECT_ID}/autokeyConfig`. "state": "A String", # Output only. The state for the AutokeyConfig. }
@@ -148,7 +148,7 @@

Method Details

Updates the AutokeyConfig for a folder or a project. The caller must have both `cloudkms.autokeyConfigs.update` permission on the parent folder and `cloudkms.cryptoKeys.setIamPolicy` permission on the provided key project. A KeyHandle creation in the folder's descendant projects will use this configuration to determine where to create the resulting CryptoKey.
 
 Args:
-  name: string, Identifier. Name of the AutokeyConfig resource, e.g. `folders/{FOLDER_NUMBER}/autokeyConfig` or `projects/{PROJECT_NUMBER}/autokeyConfig`. (required)
+  name: string, Identifier. Name of the AutokeyConfig resource, e.g. `folders/{FOLDER_NUMBER}/autokeyConfig`, `projects/{PROJECT_NUMBER}/autokeyConfig`, or `projects/{PROJECT_ID}/autokeyConfig`. (required)
   body: object, The request body.
     The object takes the form of:
 
@@ -156,7 +156,7 @@ 

Method Details

"etag": "A String", # Optional. A checksum computed by the server based on the value of other fields. This may be sent on update requests to ensure that the client has an up-to-date value before proceeding. The request will be rejected with an ABORTED error on a mismatched etag. "keyProject": "A String", # Optional. Name of the key project, e.g. `projects/{PROJECT_ID}` or `projects/{PROJECT_NUMBER}`, where Cloud KMS Autokey will provision a new CryptoKey when a KeyHandle is created. On UpdateAutokeyConfig, the caller will require `cloudkms.cryptoKeys.setIamPolicy` permission on this key project. Once configured, for Cloud KMS Autokey to function properly, this key project must have the Cloud KMS API activated and the Cloud KMS Service Agent for this key project must be granted the `cloudkms.admin` role (or pertinent permissions). A request with an empty key project field will clear the configuration. "keyProjectResolutionMode": "A String", # Optional. KeyProjectResolutionMode for the AutokeyConfig. Valid values are `DEDICATED_KEY_PROJECT`, `RESOURCE_PROJECT`, or `DISABLED`. - "name": "A String", # Identifier. Name of the AutokeyConfig resource, e.g. `folders/{FOLDER_NUMBER}/autokeyConfig` or `projects/{PROJECT_NUMBER}/autokeyConfig`. + "name": "A String", # Identifier. Name of the AutokeyConfig resource, e.g. `folders/{FOLDER_NUMBER}/autokeyConfig`, `projects/{PROJECT_NUMBER}/autokeyConfig`, or `projects/{PROJECT_ID}/autokeyConfig`. "state": "A String", # Output only. The state for the AutokeyConfig. } @@ -173,7 +173,7 @@

Method Details

"etag": "A String", # Optional. A checksum computed by the server based on the value of other fields. This may be sent on update requests to ensure that the client has an up-to-date value before proceeding. The request will be rejected with an ABORTED error on a mismatched etag. "keyProject": "A String", # Optional. Name of the key project, e.g. `projects/{PROJECT_ID}` or `projects/{PROJECT_NUMBER}`, where Cloud KMS Autokey will provision a new CryptoKey when a KeyHandle is created. On UpdateAutokeyConfig, the caller will require `cloudkms.cryptoKeys.setIamPolicy` permission on this key project. Once configured, for Cloud KMS Autokey to function properly, this key project must have the Cloud KMS API activated and the Cloud KMS Service Agent for this key project must be granted the `cloudkms.admin` role (or pertinent permissions). A request with an empty key project field will clear the configuration. "keyProjectResolutionMode": "A String", # Optional. KeyProjectResolutionMode for the AutokeyConfig. Valid values are `DEDICATED_KEY_PROJECT`, `RESOURCE_PROJECT`, or `DISABLED`. - "name": "A String", # Identifier. Name of the AutokeyConfig resource, e.g. `folders/{FOLDER_NUMBER}/autokeyConfig` or `projects/{PROJECT_NUMBER}/autokeyConfig`. + "name": "A String", # Identifier. Name of the AutokeyConfig resource, e.g. `folders/{FOLDER_NUMBER}/autokeyConfig`, `projects/{PROJECT_NUMBER}/autokeyConfig`, or `projects/{PROJECT_ID}/autokeyConfig`. "state": "A String", # Output only. The state for the AutokeyConfig. }
diff --git a/docs/dyn/cloudkms_v1.projects.html b/docs/dyn/cloudkms_v1.projects.html index 2c62a4d2dc..c7cca8d64f 100644 --- a/docs/dyn/cloudkms_v1.projects.html +++ b/docs/dyn/cloudkms_v1.projects.html @@ -114,7 +114,7 @@

Method Details

Returns the AutokeyConfig for a folder or project.
 
 Args:
-  name: string, Required. Name of the AutokeyConfig resource, e.g. `folders/{FOLDER_NUMBER}/autokeyConfig` or `projects/{PROJECT_NUMBER}/autokeyConfig`. (required)
+  name: string, Required. Name of the AutokeyConfig resource, e.g. `folders/{FOLDER_NUMBER}/autokeyConfig`, `projects/{PROJECT_NUMBER}/autokeyConfig`, or `projects/{PROJECT_ID}/autokeyConfig`. (required)
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -127,7 +127,7 @@ 

Method Details

"etag": "A String", # Optional. A checksum computed by the server based on the value of other fields. This may be sent on update requests to ensure that the client has an up-to-date value before proceeding. The request will be rejected with an ABORTED error on a mismatched etag. "keyProject": "A String", # Optional. Name of the key project, e.g. `projects/{PROJECT_ID}` or `projects/{PROJECT_NUMBER}`, where Cloud KMS Autokey will provision a new CryptoKey when a KeyHandle is created. On UpdateAutokeyConfig, the caller will require `cloudkms.cryptoKeys.setIamPolicy` permission on this key project. Once configured, for Cloud KMS Autokey to function properly, this key project must have the Cloud KMS API activated and the Cloud KMS Service Agent for this key project must be granted the `cloudkms.admin` role (or pertinent permissions). A request with an empty key project field will clear the configuration. "keyProjectResolutionMode": "A String", # Optional. KeyProjectResolutionMode for the AutokeyConfig. Valid values are `DEDICATED_KEY_PROJECT`, `RESOURCE_PROJECT`, or `DISABLED`. - "name": "A String", # Identifier. Name of the AutokeyConfig resource, e.g. `folders/{FOLDER_NUMBER}/autokeyConfig` or `projects/{PROJECT_NUMBER}/autokeyConfig`. + "name": "A String", # Identifier. Name of the AutokeyConfig resource, e.g. `folders/{FOLDER_NUMBER}/autokeyConfig`, `projects/{PROJECT_NUMBER}/autokeyConfig`, or `projects/{PROJECT_ID}/autokeyConfig`. "state": "A String", # Output only. The state for the AutokeyConfig. }
@@ -238,7 +238,7 @@

Method Details

Updates the AutokeyConfig for a folder or a project. The caller must have both `cloudkms.autokeyConfigs.update` permission on the parent folder and `cloudkms.cryptoKeys.setIamPolicy` permission on the provided key project. A KeyHandle creation in the folder's descendant projects will use this configuration to determine where to create the resulting CryptoKey.
 
 Args:
-  name: string, Identifier. Name of the AutokeyConfig resource, e.g. `folders/{FOLDER_NUMBER}/autokeyConfig` or `projects/{PROJECT_NUMBER}/autokeyConfig`. (required)
+  name: string, Identifier. Name of the AutokeyConfig resource, e.g. `folders/{FOLDER_NUMBER}/autokeyConfig`, `projects/{PROJECT_NUMBER}/autokeyConfig`, or `projects/{PROJECT_ID}/autokeyConfig`. (required)
   body: object, The request body.
     The object takes the form of:
 
@@ -246,7 +246,7 @@ 

Method Details

"etag": "A String", # Optional. A checksum computed by the server based on the value of other fields. This may be sent on update requests to ensure that the client has an up-to-date value before proceeding. The request will be rejected with an ABORTED error on a mismatched etag. "keyProject": "A String", # Optional. Name of the key project, e.g. `projects/{PROJECT_ID}` or `projects/{PROJECT_NUMBER}`, where Cloud KMS Autokey will provision a new CryptoKey when a KeyHandle is created. On UpdateAutokeyConfig, the caller will require `cloudkms.cryptoKeys.setIamPolicy` permission on this key project. Once configured, for Cloud KMS Autokey to function properly, this key project must have the Cloud KMS API activated and the Cloud KMS Service Agent for this key project must be granted the `cloudkms.admin` role (or pertinent permissions). A request with an empty key project field will clear the configuration. "keyProjectResolutionMode": "A String", # Optional. KeyProjectResolutionMode for the AutokeyConfig. Valid values are `DEDICATED_KEY_PROJECT`, `RESOURCE_PROJECT`, or `DISABLED`. - "name": "A String", # Identifier. Name of the AutokeyConfig resource, e.g. `folders/{FOLDER_NUMBER}/autokeyConfig` or `projects/{PROJECT_NUMBER}/autokeyConfig`. + "name": "A String", # Identifier. Name of the AutokeyConfig resource, e.g. `folders/{FOLDER_NUMBER}/autokeyConfig`, `projects/{PROJECT_NUMBER}/autokeyConfig`, or `projects/{PROJECT_ID}/autokeyConfig`. "state": "A String", # Output only. The state for the AutokeyConfig. } @@ -263,7 +263,7 @@

Method Details

"etag": "A String", # Optional. A checksum computed by the server based on the value of other fields. This may be sent on update requests to ensure that the client has an up-to-date value before proceeding. The request will be rejected with an ABORTED error on a mismatched etag. "keyProject": "A String", # Optional. Name of the key project, e.g. `projects/{PROJECT_ID}` or `projects/{PROJECT_NUMBER}`, where Cloud KMS Autokey will provision a new CryptoKey when a KeyHandle is created. On UpdateAutokeyConfig, the caller will require `cloudkms.cryptoKeys.setIamPolicy` permission on this key project. Once configured, for Cloud KMS Autokey to function properly, this key project must have the Cloud KMS API activated and the Cloud KMS Service Agent for this key project must be granted the `cloudkms.admin` role (or pertinent permissions). A request with an empty key project field will clear the configuration. "keyProjectResolutionMode": "A String", # Optional. KeyProjectResolutionMode for the AutokeyConfig. Valid values are `DEDICATED_KEY_PROJECT`, `RESOURCE_PROJECT`, or `DISABLED`. - "name": "A String", # Identifier. Name of the AutokeyConfig resource, e.g. `folders/{FOLDER_NUMBER}/autokeyConfig` or `projects/{PROJECT_NUMBER}/autokeyConfig`. + "name": "A String", # Identifier. Name of the AutokeyConfig resource, e.g. `folders/{FOLDER_NUMBER}/autokeyConfig`, `projects/{PROJECT_NUMBER}/autokeyConfig`, or `projects/{PROJECT_ID}/autokeyConfig`. "state": "A String", # Output only. The state for the AutokeyConfig. }
diff --git a/docs/dyn/cloudkms_v1.projects.locations.keyRings.importJobs.html b/docs/dyn/cloudkms_v1.projects.locations.keyRings.importJobs.html index c8087e05ef..1a9457bb34 100644 --- a/docs/dyn/cloudkms_v1.projects.locations.keyRings.importJobs.html +++ b/docs/dyn/cloudkms_v1.projects.locations.keyRings.importJobs.html @@ -81,7 +81,7 @@

Instance Methods

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

Create a new ImportJob within a KeyRing. ImportJob.import_method is required.

- get(name, x__xgafv=None)

+ get(name, publicKeyFormat=None, x__xgafv=None)

Returns metadata for a given ImportJob.

getIamPolicy(resource, options_requestedPolicyVersion=None, x__xgafv=None)

@@ -138,8 +138,10 @@

Method Details

"name": "A String", # Output only. The resource name for this ImportJob in the format `projects/*/locations/*/keyRings/*/importJobs/*`. "protectionLevel": "A String", # Required. Immutable. The protection level of the ImportJob. This must match the protection_level of the version_template on the CryptoKey you attempt to import into. "publicKey": { # The public key component of the wrapping key. For details of the type of key this public key corresponds to, see the ImportMethod. # Output only. The public key with which to wrap key material prior to import. Only returned if state is ACTIVE. - "pem": "A String", # The public key, encoded in PEM format. For more information, see the [RFC 7468](https://tools.ietf.org/html/rfc7468) sections for [General Considerations](https://tools.ietf.org/html/rfc7468#section-2) and [Textual Encoding of Subject Public Key Info] (https://tools.ietf.org/html/rfc7468#section-13). + "data": "A String", # Output only. Contains the public key, formatted according to the PublicKey.PublicKeyFormat specified in the KeyManagementService.GetImportJob request. + "pem": "A String", # The public key, encoded in PEM format. For more information, see the [RFC 7468](https://tools.ietf.org/html/rfc7468) sections for [General Considerations](https://tools.ietf.org/html/rfc7468#section-2) and [Textual Encoding of Subject Public Key Info] (https://tools.ietf.org/html/rfc7468#section-13). This field gets populated by default for RSA-based import methods, if no public_key_format is specified in the request. If you want to retrieve the wrapping key of an ImportJob in some other format, use KeyManagementService.GetImportJob and set the public_key_format to the desired public key format. }, + "publicKeyFormat": "A String", # Output only. Specifies the WrappingPublicKey format provided by the customer in the KeyManagementService.GetImportJob request. "state": "A String", # Output only. The current state of the ImportJob, indicating if it can be used. } @@ -177,18 +179,27 @@

Method Details

"name": "A String", # Output only. The resource name for this ImportJob in the format `projects/*/locations/*/keyRings/*/importJobs/*`. "protectionLevel": "A String", # Required. Immutable. The protection level of the ImportJob. This must match the protection_level of the version_template on the CryptoKey you attempt to import into. "publicKey": { # The public key component of the wrapping key. For details of the type of key this public key corresponds to, see the ImportMethod. # Output only. The public key with which to wrap key material prior to import. Only returned if state is ACTIVE. - "pem": "A String", # The public key, encoded in PEM format. For more information, see the [RFC 7468](https://tools.ietf.org/html/rfc7468) sections for [General Considerations](https://tools.ietf.org/html/rfc7468#section-2) and [Textual Encoding of Subject Public Key Info] (https://tools.ietf.org/html/rfc7468#section-13). + "data": "A String", # Output only. Contains the public key, formatted according to the PublicKey.PublicKeyFormat specified in the KeyManagementService.GetImportJob request. + "pem": "A String", # The public key, encoded in PEM format. For more information, see the [RFC 7468](https://tools.ietf.org/html/rfc7468) sections for [General Considerations](https://tools.ietf.org/html/rfc7468#section-2) and [Textual Encoding of Subject Public Key Info] (https://tools.ietf.org/html/rfc7468#section-13). This field gets populated by default for RSA-based import methods, if no public_key_format is specified in the request. If you want to retrieve the wrapping key of an ImportJob in some other format, use KeyManagementService.GetImportJob and set the public_key_format to the desired public key format. }, + "publicKeyFormat": "A String", # Output only. Specifies the WrappingPublicKey format provided by the customer in the KeyManagementService.GetImportJob request. "state": "A String", # Output only. The current state of the ImportJob, indicating if it can be used. }
- get(name, x__xgafv=None) + get(name, publicKeyFormat=None, x__xgafv=None)
Returns metadata for a given ImportJob.
 
 Args:
   name: string, Required. The name of the ImportJob to get. (required)
+  publicKeyFormat: string, Optional. Specifies the WrappingPublicKey format. If not specified: * For RSA-based import methods, the wrapping key will be returned in PEM format * For pure ML-KEM-based import methods, the wrapping key will be returned in the raw bytes format specified in FIPS-203 * For X-Wing-based import methods, the wrapping key will be returned in the raw bytes format specified in https://datatracker.ietf.org/doc/draft-connolly-cfrg-xwing-kem.
+    Allowed values
+      PUBLIC_KEY_FORMAT_UNSPECIFIED - If the public_key_format field is not specified: - For PQC algorithms, an error will be returned. - For non-PQC algorithms, the default format is PEM, and the field pem will be populated. Otherwise, the public key will be exported through the public_key field in the requested format.
+      PEM - The returned public key will be encoded in PEM format. See the [RFC7468](https://tools.ietf.org/html/rfc7468) sections for [General Considerations](https://tools.ietf.org/html/rfc7468#section-2) and [Textual Encoding of Subject Public Key Info] (https://tools.ietf.org/html/rfc7468#section-13) for more information.
+      DER - The returned public key will be encoded in DER format (the PrivateKeyInfo structure from RFC 5208).
+      NIST_PQC - This is supported only for PQC algorithms. The key material is returned in the format defined by NIST PQC standards (FIPS 203, FIPS 204, and FIPS 205).
+      XWING_RAW_BYTES - The returned public key is in raw bytes format defined in its standard https://datatracker.ietf.org/doc/draft-connolly-cfrg-xwing-kem.
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -222,8 +233,10 @@ 

Method Details

"name": "A String", # Output only. The resource name for this ImportJob in the format `projects/*/locations/*/keyRings/*/importJobs/*`. "protectionLevel": "A String", # Required. Immutable. The protection level of the ImportJob. This must match the protection_level of the version_template on the CryptoKey you attempt to import into. "publicKey": { # The public key component of the wrapping key. For details of the type of key this public key corresponds to, see the ImportMethod. # Output only. The public key with which to wrap key material prior to import. Only returned if state is ACTIVE. - "pem": "A String", # The public key, encoded in PEM format. For more information, see the [RFC 7468](https://tools.ietf.org/html/rfc7468) sections for [General Considerations](https://tools.ietf.org/html/rfc7468#section-2) and [Textual Encoding of Subject Public Key Info] (https://tools.ietf.org/html/rfc7468#section-13). + "data": "A String", # Output only. Contains the public key, formatted according to the PublicKey.PublicKeyFormat specified in the KeyManagementService.GetImportJob request. + "pem": "A String", # The public key, encoded in PEM format. For more information, see the [RFC 7468](https://tools.ietf.org/html/rfc7468) sections for [General Considerations](https://tools.ietf.org/html/rfc7468#section-2) and [Textual Encoding of Subject Public Key Info] (https://tools.ietf.org/html/rfc7468#section-13). This field gets populated by default for RSA-based import methods, if no public_key_format is specified in the request. If you want to retrieve the wrapping key of an ImportJob in some other format, use KeyManagementService.GetImportJob and set the public_key_format to the desired public key format. }, + "publicKeyFormat": "A String", # Output only. Specifies the WrappingPublicKey format provided by the customer in the KeyManagementService.GetImportJob request. "state": "A String", # Output only. The current state of the ImportJob, indicating if it can be used. }
@@ -321,8 +334,10 @@

Method Details

"name": "A String", # Output only. The resource name for this ImportJob in the format `projects/*/locations/*/keyRings/*/importJobs/*`. "protectionLevel": "A String", # Required. Immutable. The protection level of the ImportJob. This must match the protection_level of the version_template on the CryptoKey you attempt to import into. "publicKey": { # The public key component of the wrapping key. For details of the type of key this public key corresponds to, see the ImportMethod. # Output only. The public key with which to wrap key material prior to import. Only returned if state is ACTIVE. - "pem": "A String", # The public key, encoded in PEM format. For more information, see the [RFC 7468](https://tools.ietf.org/html/rfc7468) sections for [General Considerations](https://tools.ietf.org/html/rfc7468#section-2) and [Textual Encoding of Subject Public Key Info] (https://tools.ietf.org/html/rfc7468#section-13). + "data": "A String", # Output only. Contains the public key, formatted according to the PublicKey.PublicKeyFormat specified in the KeyManagementService.GetImportJob request. + "pem": "A String", # The public key, encoded in PEM format. For more information, see the [RFC 7468](https://tools.ietf.org/html/rfc7468) sections for [General Considerations](https://tools.ietf.org/html/rfc7468#section-2) and [Textual Encoding of Subject Public Key Info] (https://tools.ietf.org/html/rfc7468#section-13). This field gets populated by default for RSA-based import methods, if no public_key_format is specified in the request. If you want to retrieve the wrapping key of an ImportJob in some other format, use KeyManagementService.GetImportJob and set the public_key_format to the desired public key format. }, + "publicKeyFormat": "A String", # Output only. Specifies the WrappingPublicKey format provided by the customer in the KeyManagementService.GetImportJob request. "state": "A String", # Output only. The current state of the ImportJob, indicating if it can be used. }, ], diff --git a/docs/dyn/cloudsupport_v2.cases.attachments.html b/docs/dyn/cloudsupport_v2.cases.attachments.html index 3bfad47568..d73f6f2ec2 100644 --- a/docs/dyn/cloudsupport_v2.cases.attachments.html +++ b/docs/dyn/cloudsupport_v2.cases.attachments.html @@ -77,6 +77,9 @@

Instance Methods

close()

Close httplib2 connections.

+

+ get(name, x__xgafv=None)

+

Retrieve an attachment associated with a support case. EXAMPLES: cURL: ```shell attachment="projects/some-project/cases/23598314/attachments/0684M00000P3h1fQAB" curl \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ "https://cloudsupport.googleapis.com/v2/$attachment" ``` Python: ```python import googleapiclient.discovery api_version = "v2" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", ) request = ( supportApiService.cases() .attachments() .get(name="projects/some-project/cases/43595344/attachments/0684M00000P3h1fQAB") ) print(request.execute()) ```

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

List all the attachments associated with a support case. EXAMPLES: cURL: ```shell case="projects/some-project/cases/23598314" curl \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ "https://cloudsupport.googleapis.com/v2/$case/attachments" ``` Python: ```python import googleapiclient.discovery api_version = "v2" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", ) request = ( supportApiService.cases() .attachments() .list(parent="projects/some-project/cases/43595344") ) print(request.execute()) ```

@@ -89,6 +92,35 @@

Method Details

Close httplib2 connections.
+
+ get(name, x__xgafv=None) +
Retrieve an attachment associated with a support case. EXAMPLES: cURL: ```shell attachment="projects/some-project/cases/23598314/attachments/0684M00000P3h1fQAB" curl \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ "https://cloudsupport.googleapis.com/v2/$attachment" ``` Python: ```python import googleapiclient.discovery api_version = "v2" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", ) request = ( supportApiService.cases() .attachments() .get(name="projects/some-project/cases/43595344/attachments/0684M00000P3h1fQAB") ) print(request.execute()) ```
+
+Args:
+  name: string, Required. The name of the attachment to get. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # An Attachment contains metadata about a file that was uploaded to a case - it is NOT a file itself. That being said, the name of an Attachment object can be used to download its accompanying file through the `media.download` endpoint. While attachments can be uploaded in the console at the same time as a comment, they're associated on a "case" level, not a "comment" level.
+  "createTime": "A String", # Output only. The time at which the attachment was created.
+  "creator": { # An Actor represents an entity that performed an action. For example, an actor could be a user who posted a comment on a support case, a user who uploaded an attachment, or a service account that created a support case. # Output only. The user who uploaded the attachment. Note, the name and email will be obfuscated if the attachment was uploaded by Google support.
+    "displayName": "A String", # The name to display for the actor. If not provided, it is inferred from credentials supplied during case creation. When an email is provided, a display name must also be provided. This will be obfuscated if the user is a Google Support agent.
+    "email": "A String", # The email address of the actor. If not provided, it is inferred from the credentials supplied during case creation. When a name is provided, an email must also be provided. If the user is a Google Support agent, this is obfuscated. This field is deprecated. Use `username` instead.
+    "googleSupport": True or False, # Output only. Whether the actor is a Google support actor.
+    "username": "A String", # Output only. The username of the actor. It may look like an email or other format provided by the identity provider. If not provided, it is inferred from the credentials supplied. When a name is provided, a username must also be provided. If the user is a Google Support agent, this will not be set.
+  },
+  "filename": "A String", # The filename of the attachment (e.g. `"graph.jpg"`).
+  "mimeType": "A String", # Output only. The MIME type of the attachment (e.g. text/plain).
+  "name": "A String", # Output only. Identifier. The resource name of the attachment.
+  "sizeBytes": "A String", # Output only. The size of the attachment in bytes.
+}
+
+
list(parent, pageSize=None, pageToken=None, x__xgafv=None)
List all the attachments associated with a support case. EXAMPLES: cURL: ```shell case="projects/some-project/cases/23598314" curl \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ "https://cloudsupport.googleapis.com/v2/$case/attachments" ``` Python: ```python import googleapiclient.discovery api_version = "v2" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", ) request = ( supportApiService.cases() .attachments() .list(parent="projects/some-project/cases/43595344") ) print(request.execute()) ```
diff --git a/docs/dyn/cloudsupport_v2.cases.comments.html b/docs/dyn/cloudsupport_v2.cases.comments.html
index 5d5ff70b9d..776bf57deb 100644
--- a/docs/dyn/cloudsupport_v2.cases.comments.html
+++ b/docs/dyn/cloudsupport_v2.cases.comments.html
@@ -80,6 +80,9 @@ 

Instance Methods

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

Add a new comment to a case. The comment must have the following fields set: `body`. EXAMPLES: cURL: ```shell case="projects/some-project/cases/43591344" curl \ --request POST \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ --header 'Content-Type: application/json' \ --data '{ "body": "This is a test comment." }' \ "https://cloudsupport.googleapis.com/v2/$case/comments" ``` Python: ```python import googleapiclient.discovery api_version = "v2" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", ) request = ( supportApiService.cases() .comments() .create( parent="projects/some-project/cases/43595344", body={"body": "This is a test comment."}, ) ) print(request.execute()) ```

+

+ get(name, x__xgafv=None)

+

Retrieve a comment. EXAMPLES: cURL: ```shell comment="projects/some-project/cases/43595344/comments/234567890" curl \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ "https://cloudsupport.googleapis.com/v2/$comment" ``` Python: ```python import googleapiclient.discovery api_version = "v2" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", ) request = supportApiService.cases().comments().get( name="projects/some-project/cases/43595344/comments/234567890", ) print(request.execute()) ```

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

List all the comments associated with a case. EXAMPLES: cURL: ```shell case="projects/some-project/cases/43595344" curl \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ "https://cloudsupport.googleapis.com/v2/$case/comments" ``` Python: ```python import googleapiclient.discovery api_version = "v2" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", ) request = ( supportApiService.cases() .comments() .list(parent="projects/some-project/cases/43595344") ) print(request.execute()) ```

@@ -136,6 +139,34 @@

Method Details

}
+
+ get(name, x__xgafv=None) +
Retrieve a comment. EXAMPLES: cURL: ```shell comment="projects/some-project/cases/43595344/comments/234567890" curl \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ "https://cloudsupport.googleapis.com/v2/$comment" ``` Python: ```python import googleapiclient.discovery api_version = "v2" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", ) request = supportApiService.cases().comments().get( name="projects/some-project/cases/43595344/comments/234567890", ) print(request.execute()) ```
+
+Args:
+  name: string, Required. The name of the comment to retrieve. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A comment associated with a support case. Case comments are the primary way for Google Support to communicate with a user who has opened a case. When a user responds to Google Support, the user's responses also appear as comments.
+  "body": "A String", # The full comment body. Maximum of 12800 characters.
+  "createTime": "A String", # Output only. The time when the comment was created.
+  "creator": { # An Actor represents an entity that performed an action. For example, an actor could be a user who posted a comment on a support case, a user who uploaded an attachment, or a service account that created a support case. # Output only. The user or Google Support agent who created the comment.
+    "displayName": "A String", # The name to display for the actor. If not provided, it is inferred from credentials supplied during case creation. When an email is provided, a display name must also be provided. This will be obfuscated if the user is a Google Support agent.
+    "email": "A String", # The email address of the actor. If not provided, it is inferred from the credentials supplied during case creation. When a name is provided, an email must also be provided. If the user is a Google Support agent, this is obfuscated. This field is deprecated. Use `username` instead.
+    "googleSupport": True or False, # Output only. Whether the actor is a Google support actor.
+    "username": "A String", # Output only. The username of the actor. It may look like an email or other format provided by the identity provider. If not provided, it is inferred from the credentials supplied. When a name is provided, a username must also be provided. If the user is a Google Support agent, this will not be set.
+  },
+  "name": "A String", # Output only. Identifier. The resource name of the comment.
+  "plainTextBody": "A String", # Output only. DEPRECATED. DO NOT USE. A duplicate of the `body` field. This field is only present for legacy reasons.
+}
+
+
list(parent, pageSize=None, pageToken=None, x__xgafv=None)
List all the comments associated with a case. EXAMPLES: cURL: ```shell case="projects/some-project/cases/43595344" curl \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ "https://cloudsupport.googleapis.com/v2/$case/comments" ``` Python: ```python import googleapiclient.discovery api_version = "v2" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", ) request = ( supportApiService.cases() .comments() .list(parent="projects/some-project/cases/43595344") ) print(request.execute()) ```
diff --git a/docs/dyn/cloudsupport_v2.media.html b/docs/dyn/cloudsupport_v2.media.html
index 89b422bf83..67f7447c46 100644
--- a/docs/dyn/cloudsupport_v2.media.html
+++ b/docs/dyn/cloudsupport_v2.media.html
@@ -85,7 +85,7 @@ 

Instance Methods

Download a file attached to a case. When this endpoint is called, no "response body" will be returned. Instead, the attachment's blob will be returned. Note: HTTP requests must append "?alt=media" to the URL. EXAMPLES: cURL: ```shell name="projects/some-project/cases/43594844/attachments/0674M00000WijAnZAJ" curl \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ "https://cloudsupport.googleapis.com/v2/$name:download?alt=media" ``` Python: ```python import googleapiclient.discovery api_version = "v2" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", ) request = supportApiService.media().download( name="projects/some-project/cases/43595344/attachments/0684M00000Pw6pHQAR" ) request.uri = request.uri.split("?")[0] + "?alt=media" print(request.execute()) ```

upload(parent, body=None, media_body=None, media_mime_type=None, x__xgafv=None)

-

Create a file attachment on a case or Cloud resource. The attachment must have the following fields set: `filename`. EXAMPLES: cURL: ```shell echo "This text is in a file I'm uploading using CSAPI." \ > "./example_file.txt" case="projects/some-project/cases/43594844" curl \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ --data-binary @"./example_file.txt" \ "https://cloudsupport.googleapis.com/upload/v2beta/$case/attachments?attachment.filename=uploaded_via_curl.txt" ``` Python: ```python import googleapiclient.discovery api_version = "v2" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", ) file_path = "./example_file.txt" with open(file_path, "w") as file: file.write( "This text is inside a file I'm going to upload using the Cloud Support API.", ) request = supportApiService.media().upload( parent="projects/some-project/cases/43595344", media_body=file_path ) request.uri = request.uri.split("?")[0] + "?attachment.filename=uploaded_via_python.txt" print(request.execute()) ```

+

Create a file attachment on a case or Cloud resource. The attachment must have the following fields set: `filename`. EXAMPLES: cURL: ```shell echo "This text is in a file I'm uploading using CSAPI." \ > "./example_file.txt" case="projects/some-project/cases/43594844" curl \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ --data-binary @"./example_file.txt" \ "https://cloudsupport.googleapis.com/upload/v2/$case/attachments?attachment.filename=uploaded_via_curl.txt" ``` Python: ```python import googleapiclient.discovery api_version = "v2" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", ) file_path = "./example_file.txt" with open(file_path, "w") as file: file.write( "This text is inside a file I'm going to upload using the Cloud Support API.", ) request = supportApiService.media().upload( parent="projects/some-project/cases/43595344", media_body=file_path ) request.uri = request.uri.split("?")[0] + "?attachment.filename=uploaded_via_python.txt" print(request.execute()) ```

Method Details

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

Method Details

"referenceType": "A String", # # gdata.* are outside protos with mising documentation "sha1Hash": "A String", # # gdata.* are outside protos with mising documentation "sha256Hash": "A String", # # gdata.* are outside protos with mising documentation + "sha512Hash": "A String", # # gdata.* are outside protos with mising documentation "timestamp": "A String", # # gdata.* are outside protos with mising documentation "token": "A String", # # gdata.* are outside protos with mising documentation }
@@ -370,7 +371,7 @@

Method Details

upload(parent, body=None, media_body=None, media_mime_type=None, x__xgafv=None) -
Create a file attachment on a case or Cloud resource. The attachment must have the following fields set: `filename`. EXAMPLES: cURL: ```shell echo "This text is in a file I'm uploading using CSAPI." \ > "./example_file.txt" case="projects/some-project/cases/43594844" curl \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ --data-binary @"./example_file.txt" \ "https://cloudsupport.googleapis.com/upload/v2beta/$case/attachments?attachment.filename=uploaded_via_curl.txt" ``` Python: ```python import googleapiclient.discovery api_version = "v2" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", ) file_path = "./example_file.txt" with open(file_path, "w") as file: file.write( "This text is inside a file I'm going to upload using the Cloud Support API.", ) request = supportApiService.media().upload( parent="projects/some-project/cases/43595344", media_body=file_path ) request.uri = request.uri.split("?")[0] + "?attachment.filename=uploaded_via_python.txt" print(request.execute()) ```
+  
Create a file attachment on a case or Cloud resource. The attachment must have the following fields set: `filename`. EXAMPLES: cURL: ```shell echo "This text is in a file I'm uploading using CSAPI." \ > "./example_file.txt" case="projects/some-project/cases/43594844" curl \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ --data-binary @"./example_file.txt" \ "https://cloudsupport.googleapis.com/upload/v2/$case/attachments?attachment.filename=uploaded_via_curl.txt" ``` Python: ```python import googleapiclient.discovery api_version = "v2" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", ) file_path = "./example_file.txt" with open(file_path, "w") as file: file.write( "This text is inside a file I'm going to upload using the Cloud Support API.", ) request = supportApiService.media().upload( parent="projects/some-project/cases/43595344", media_body=file_path ) request.uri = request.uri.split("?")[0] + "?attachment.filename=uploaded_via_python.txt" print(request.execute()) ```
 
 Args:
   parent: string, Required. The name of the case or Cloud resource to which the attachment should be attached. (required)
diff --git a/docs/dyn/cloudsupport_v2beta.caseClassifications.html b/docs/dyn/cloudsupport_v2beta.caseClassifications.html
index 94a83a4556..8d9cd46da5 100644
--- a/docs/dyn/cloudsupport_v2beta.caseClassifications.html
+++ b/docs/dyn/cloudsupport_v2beta.caseClassifications.html
@@ -79,7 +79,7 @@ 

Instance Methods

Close httplib2 connections.

search(pageSize=None, pageToken=None, product_productLine=None, query=None, x__xgafv=None)

-

Retrieve valid classifications to use when creating a support case. Classifications are hierarchical. Each classification is a string containing all levels of the hierarchy separated by `" > "`. For example, `"Technical Issue > Compute > Compute Engine"`. Classification IDs returned by this endpoint are valid for at least six months. When a classification is deactivated, this endpoint immediately stops returning it. After six months, `case.create` requests using the classification will fail. EXAMPLES: cURL: ```shell curl \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ 'https://cloudsupport.googleapis.com/v2/caseClassifications:search?query=display_name:"*Compute%20Engine*"' ``` Python: ```python import googleapiclient.discovery supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version="v2", discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version=v2", ) request = supportApiService.caseClassifications().search( query='display_name:"*Compute Engine*"' ) print(request.execute()) ```

+

Retrieve valid classifications to use when creating a support case. Classifications are hierarchical. Each classification is a string containing all levels of the hierarchy separated by `" > "`. For example, `"Technical Issue > Compute > Compute Engine"`. Classification IDs returned by this endpoint are valid for at least six months. When a classification is deactivated, this endpoint immediately stops returning it. After six months, `case.create` requests using the classification will fail. EXAMPLES: cURL: ```shell curl \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ 'https://cloudsupport.googleapis.com/v2beta/caseClassifications:search?query=display_name:"*Compute%20Engine*"' ``` Python: ```python import googleapiclient.discovery supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version="v2beta", discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version=v2", ) request = supportApiService.caseClassifications().search( query='display_name:"*Compute Engine*"' ) print(request.execute()) ```

search_next()

Retrieves the next page of results.

@@ -91,7 +91,7 @@

Method Details

search(pageSize=None, pageToken=None, product_productLine=None, query=None, x__xgafv=None) -
Retrieve valid classifications to use when creating a support case. Classifications are hierarchical. Each classification is a string containing all levels of the hierarchy separated by `" > "`. For example, `"Technical Issue > Compute > Compute Engine"`. Classification IDs returned by this endpoint are valid for at least six months. When a classification is deactivated, this endpoint immediately stops returning it. After six months, `case.create` requests using the classification will fail. EXAMPLES: cURL: ```shell curl \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ 'https://cloudsupport.googleapis.com/v2/caseClassifications:search?query=display_name:"*Compute%20Engine*"' ``` Python: ```python import googleapiclient.discovery supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version="v2", discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version=v2", ) request = supportApiService.caseClassifications().search( query='display_name:"*Compute Engine*"' ) print(request.execute()) ```
+  
Retrieve valid classifications to use when creating a support case. Classifications are hierarchical. Each classification is a string containing all levels of the hierarchy separated by `" > "`. For example, `"Technical Issue > Compute > Compute Engine"`. Classification IDs returned by this endpoint are valid for at least six months. When a classification is deactivated, this endpoint immediately stops returning it. After six months, `case.create` requests using the classification will fail. EXAMPLES: cURL: ```shell curl \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ 'https://cloudsupport.googleapis.com/v2beta/caseClassifications:search?query=display_name:"*Compute%20Engine*"' ``` Python: ```python import googleapiclient.discovery supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version="v2beta", discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version=v2", ) request = supportApiService.caseClassifications().search( query='display_name:"*Compute Engine*"' ) print(request.execute()) ```
 
 Args:
   pageSize: integer, The maximum number of classifications fetched with each request.
diff --git a/docs/dyn/cloudsupport_v2beta.cases.attachments.html b/docs/dyn/cloudsupport_v2beta.cases.attachments.html
index 336e9f6b01..d7eb7ea96d 100644
--- a/docs/dyn/cloudsupport_v2beta.cases.attachments.html
+++ b/docs/dyn/cloudsupport_v2beta.cases.attachments.html
@@ -79,10 +79,10 @@ 

Instance Methods

Close httplib2 connections.

get(name, x__xgafv=None)

-

Retrieve an attachment associated with a support case. EXAMPLES: cURL: ```shell attachment="projects/some-project/cases/23598314/attachments/0684M00000P3h1fQAB" curl \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ "https://cloudsupport.googleapis.com/v2/$attachment" ``` Python: ```python import googleapiclient.discovery api_version = "v2beta" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", ) request = ( supportApiService.cases() .attachments() .get(name="projects/some-project/cases/43595344/attachments/0684M00000P3h1fQAB") ) print(request.execute()) ```

+

Retrieve an attachment associated with a support case. EXAMPLES: cURL: ```shell attachment="projects/some-project/cases/23598314/attachments/0684M00000P3h1fQAB" curl \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ "https://cloudsupport.googleapis.com/v2beta/$attachment" ``` Python: ```python import googleapiclient.discovery api_version = "v2beta" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", ) request = ( supportApiService.cases() .attachments() .get(name="projects/some-project/cases/43595344/attachments/0684M00000P3h1fQAB") ) print(request.execute()) ```

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

-

List all the attachments associated with a support case. EXAMPLES: cURL: ```shell case="projects/some-project/cases/23598314" curl \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ "https://cloudsupport.googleapis.com/v2/$case/attachments" ``` Python: ```python import googleapiclient.discovery api_version = "v2" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", ) request = ( supportApiService.cases() .attachments() .list(parent="projects/some-project/cases/43595344") ) print(request.execute()) ```

+

List all the attachments associated with a support case. EXAMPLES: cURL: ```shell case="projects/some-project/cases/23598314" curl \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ "https://cloudsupport.googleapis.com/v2beta/$case/attachments" ``` Python: ```python import googleapiclient.discovery api_version = "v2beta" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", ) request = ( supportApiService.cases() .attachments() .list(parent="projects/some-project/cases/43595344") ) print(request.execute()) ```

list_next()

Retrieves the next page of results.

@@ -94,7 +94,7 @@

Method Details

get(name, x__xgafv=None) -
Retrieve an attachment associated with a support case. EXAMPLES: cURL: ```shell attachment="projects/some-project/cases/23598314/attachments/0684M00000P3h1fQAB" curl \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ "https://cloudsupport.googleapis.com/v2/$attachment" ``` Python: ```python import googleapiclient.discovery api_version = "v2beta" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", ) request = ( supportApiService.cases() .attachments() .get(name="projects/some-project/cases/43595344/attachments/0684M00000P3h1fQAB") ) print(request.execute()) ```
+  
Retrieve an attachment associated with a support case. EXAMPLES: cURL: ```shell attachment="projects/some-project/cases/23598314/attachments/0684M00000P3h1fQAB" curl \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ "https://cloudsupport.googleapis.com/v2beta/$attachment" ``` Python: ```python import googleapiclient.discovery api_version = "v2beta" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", ) request = ( supportApiService.cases() .attachments() .get(name="projects/some-project/cases/43595344/attachments/0684M00000P3h1fQAB") ) print(request.execute()) ```
 
 Args:
   name: string, Required. The name of the attachment to get. (required)
@@ -123,7 +123,7 @@ 

Method Details

list(parent, pageSize=None, pageToken=None, x__xgafv=None) -
List all the attachments associated with a support case. EXAMPLES: cURL: ```shell case="projects/some-project/cases/23598314" curl \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ "https://cloudsupport.googleapis.com/v2/$case/attachments" ``` Python: ```python import googleapiclient.discovery api_version = "v2" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", ) request = ( supportApiService.cases() .attachments() .list(parent="projects/some-project/cases/43595344") ) print(request.execute()) ```
+  
List all the attachments associated with a support case. EXAMPLES: cURL: ```shell case="projects/some-project/cases/23598314" curl \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ "https://cloudsupport.googleapis.com/v2beta/$case/attachments" ``` Python: ```python import googleapiclient.discovery api_version = "v2beta" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", ) request = ( supportApiService.cases() .attachments() .list(parent="projects/some-project/cases/43595344") ) print(request.execute()) ```
 
 Args:
   parent: string, Required. The name of the case for which attachments should be listed. (required)
diff --git a/docs/dyn/cloudsupport_v2beta.cases.comments.html b/docs/dyn/cloudsupport_v2beta.cases.comments.html
index 69eb6b78a0..71ee5135e6 100644
--- a/docs/dyn/cloudsupport_v2beta.cases.comments.html
+++ b/docs/dyn/cloudsupport_v2beta.cases.comments.html
@@ -79,13 +79,13 @@ 

Instance Methods

Close httplib2 connections.

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

-

Add a new comment to a case. The comment must have the following fields set: `body`. EXAMPLES: cURL: ```shell case="projects/some-project/cases/43591344" curl \ --request POST \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ --header 'Content-Type: application/json' \ --data '{ "body": "This is a test comment." }' \ "https://cloudsupport.googleapis.com/v2/$case/comments" ``` Python: ```python import googleapiclient.discovery api_version = "v2" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", ) request = ( supportApiService.cases() .comments() .create( parent="projects/some-project/cases/43595344", body={"body": "This is a test comment."}, ) ) print(request.execute()) ```

+

Add a new comment to a case. The comment must have the following fields set: `body`. EXAMPLES: cURL: ```shell case="projects/some-project/cases/43591344" curl \ --request POST \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ --header 'Content-Type: application/json' \ --data '{ "body": "This is a test comment." }' \ "https://cloudsupport.googleapis.com/v2beta/$case/comments" ``` Python: ```python import googleapiclient.discovery api_version = "v2beta" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", ) request = ( supportApiService.cases() .comments() .create( parent="projects/some-project/cases/43595344", body={"body": "This is a test comment."}, ) ) print(request.execute()) ```

get(name, x__xgafv=None)

-

Retrieve a comment. EXAMPLES: cURL: ```shell comment="projects/some-project/cases/43595344/comments/234567890" curl \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ "https://cloudsupport.googleapis.com/v2/$comment" ``` Python: ```python import googleapiclient.discovery api_version = "v2beta" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", ) request = supportApiService.cases().comments().get( name="projects/some-project/cases/43595344/comments/234567890", ) print(request.execute()) ```

+

Retrieve a comment. EXAMPLES: cURL: ```shell comment="projects/some-project/cases/43595344/comments/234567890" curl \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ "https://cloudsupport.googleapis.com/v2beta/$comment" ``` Python: ```python import googleapiclient.discovery api_version = "v2beta" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", ) request = supportApiService.cases().comments().get( name="projects/some-project/cases/43595344/comments/234567890", ) print(request.execute()) ```

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

-

List all the comments associated with a case. EXAMPLES: cURL: ```shell case="projects/some-project/cases/43595344" curl \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ "https://cloudsupport.googleapis.com/v2/$case/comments" ``` Python: ```python import googleapiclient.discovery api_version = "v2" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", ) request = ( supportApiService.cases() .comments() .list(parent="projects/some-project/cases/43595344") ) print(request.execute()) ```

+

List all the comments associated with a case. EXAMPLES: cURL: ```shell case="projects/some-project/cases/43595344" curl \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ "https://cloudsupport.googleapis.com/v2beta/$case/comments" ``` Python: ```python import googleapiclient.discovery api_version = "v2beta" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", ) request = ( supportApiService.cases() .comments() .list(parent="projects/some-project/cases/43595344") ) print(request.execute()) ```

list_next()

Retrieves the next page of results.

@@ -97,7 +97,7 @@

Method Details

create(parent, body=None, x__xgafv=None) -
Add a new comment to a case. The comment must have the following fields set: `body`. EXAMPLES: cURL: ```shell case="projects/some-project/cases/43591344" curl \ --request POST \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ --header 'Content-Type: application/json' \ --data '{ "body": "This is a test comment." }' \ "https://cloudsupport.googleapis.com/v2/$case/comments" ``` Python: ```python import googleapiclient.discovery api_version = "v2" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", ) request = ( supportApiService.cases() .comments() .create( parent="projects/some-project/cases/43595344", body={"body": "This is a test comment."}, ) ) print(request.execute()) ```
+  
Add a new comment to a case. The comment must have the following fields set: `body`. EXAMPLES: cURL: ```shell case="projects/some-project/cases/43591344" curl \ --request POST \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ --header 'Content-Type: application/json' \ --data '{ "body": "This is a test comment." }' \ "https://cloudsupport.googleapis.com/v2beta/$case/comments" ``` Python: ```python import googleapiclient.discovery api_version = "v2beta" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", ) request = ( supportApiService.cases() .comments() .create( parent="projects/some-project/cases/43595344", body={"body": "This is a test comment."}, ) ) print(request.execute()) ```
 
 Args:
   parent: string, Required. The name of the case to which the comment should be added. (required)
@@ -141,7 +141,7 @@ 

Method Details

get(name, x__xgafv=None) -
Retrieve a comment. EXAMPLES: cURL: ```shell comment="projects/some-project/cases/43595344/comments/234567890" curl \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ "https://cloudsupport.googleapis.com/v2/$comment" ``` Python: ```python import googleapiclient.discovery api_version = "v2beta" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", ) request = supportApiService.cases().comments().get( name="projects/some-project/cases/43595344/comments/234567890", ) print(request.execute()) ```
+  
Retrieve a comment. EXAMPLES: cURL: ```shell comment="projects/some-project/cases/43595344/comments/234567890" curl \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ "https://cloudsupport.googleapis.com/v2beta/$comment" ``` Python: ```python import googleapiclient.discovery api_version = "v2beta" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", ) request = supportApiService.cases().comments().get( name="projects/some-project/cases/43595344/comments/234567890", ) print(request.execute()) ```
 
 Args:
   name: string, Required. The name of the comment to retrieve. (required)
@@ -169,7 +169,7 @@ 

Method Details

list(parent, pageSize=None, pageToken=None, x__xgafv=None) -
List all the comments associated with a case. EXAMPLES: cURL: ```shell case="projects/some-project/cases/43595344" curl \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ "https://cloudsupport.googleapis.com/v2/$case/comments" ``` Python: ```python import googleapiclient.discovery api_version = "v2" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", ) request = ( supportApiService.cases() .comments() .list(parent="projects/some-project/cases/43595344") ) print(request.execute()) ```
+  
List all the comments associated with a case. EXAMPLES: cURL: ```shell case="projects/some-project/cases/43595344" curl \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ "https://cloudsupport.googleapis.com/v2beta/$case/comments" ``` Python: ```python import googleapiclient.discovery api_version = "v2beta" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", ) request = ( supportApiService.cases() .comments() .list(parent="projects/some-project/cases/43595344") ) print(request.execute()) ```
 
 Args:
   parent: string, Required. The name of the case for which to list comments. (required)
diff --git a/docs/dyn/cloudsupport_v2beta.cases.html b/docs/dyn/cloudsupport_v2beta.cases.html
index 5e0b02c8f7..842c33d41c 100644
--- a/docs/dyn/cloudsupport_v2beta.cases.html
+++ b/docs/dyn/cloudsupport_v2beta.cases.html
@@ -86,28 +86,28 @@ 

Instance Methods

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

-

Close a case. EXAMPLES: cURL: ```shell case="projects/some-project/cases/43595344" curl \ --request POST \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ "https://cloudsupport.googleapis.com/v2/$case:close" ``` Python: ```python import googleapiclient.discovery api_version = "v2" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", ) request = supportApiService.cases().close( name="projects/some-project/cases/43595344" ) print(request.execute()) ```

+

Close a case. EXAMPLES: cURL: ```shell case="projects/some-project/cases/43595344" curl \ --request POST \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ "https://cloudsupport.googleapis.com/v2beta/$case:close" ``` Python: ```python import googleapiclient.discovery api_version = "v2beta" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", ) request = supportApiService.cases().close( name="projects/some-project/cases/43595344" ) print(request.execute()) ```

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

-

Create a new case and associate it with a parent. It must have the following fields set: `display_name`, `description`, `classification`, and `priority`. If you're just testing the API and don't want to route your case to an agent, set `testCase=true`. EXAMPLES: cURL: ```shell parent="projects/some-project" curl \ --request POST \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ --header 'Content-Type: application/json' \ --data '{ "display_name": "Test case created by me.", "description": "a random test case, feel free to close", "classification": { "id": "100IK2AKCLHMGRJ9CDGMOCGP8DM6UTB4BT262T31BT1M2T31DHNMENPO6KS36CPJ786L2TBFEHGN6NPI64R3CDHN8880G08I1H3MURR7DHII0GRCDTQM8" }, "time_zone": "-07:00", "subscriber_email_addresses": [ "foo@domain.com", "bar@domain.com" ], "testCase": true, "priority": "P3" }' \ "https://cloudsupport.googleapis.com/v2/$parent/cases" ``` Python: ```python import googleapiclient.discovery api_version = "v2" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", ) request = supportApiService.cases().create( parent="projects/some-project", body={ "displayName": "A Test Case", "description": "This is a test case.", "testCase": True, "priority": "P2", "classification": { "id": "100IK2AKCLHMGRJ9CDGMOCGP8DM6UTB4BT262T31BT1M2T31DHNMENPO6KS36CPJ786L2TBFEHGN6NPI64R3CDHN8880G08I1H3MURR7DHII0GRCDTQM8" }, }, ) print(request.execute()) ```

+

Create a new case and associate it with a parent. It must have the following fields set: `display_name`, `description`, `classification`, and `priority`. If you're just testing the API and don't want to route your case to an agent, set `testCase=true`. EXAMPLES: cURL: ```shell parent="projects/some-project" curl \ --request POST \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ --header 'Content-Type: application/json' \ --data '{ "display_name": "Test case created by me.", "description": "a random test case, feel free to close", "classification": { "id": "100IK2AKCLHMGRJ9CDGMOCGP8DM6UTB4BT262T31BT1M2T31DHNMENPO6KS36CPJ786L2TBFEHGN6NPI64R3CDHN8880G08I1H3MURR7DHII0GRCDTQM8" }, "time_zone": "-07:00", "subscriber_email_addresses": [ "foo@domain.com", "bar@domain.com" ], "testCase": true, "priority": "P3" }' \ "https://cloudsupport.googleapis.com/v2beta/$parent/cases" ``` Python: ```python import googleapiclient.discovery api_version = "v2beta" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", ) request = supportApiService.cases().create( parent="projects/some-project", body={ "displayName": "A Test Case", "description": "This is a test case.", "testCase": True, "priority": "P2", "classification": { "id": "100IK2AKCLHMGRJ9CDGMOCGP8DM6UTB4BT262T31BT1M2T31DHNMENPO6KS36CPJ786L2TBFEHGN6NPI64R3CDHN8880G08I1H3MURR7DHII0GRCDTQM8" }, }, ) print(request.execute()) ```

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

-

Escalate a case, starting the Google Cloud Support escalation management process. This operation is only available for some support services. Go to https://cloud.google.com/support and look for 'Technical support escalations' in the feature list to find out which ones let you do that. EXAMPLES: cURL: ```shell case="projects/some-project/cases/43595344" curl \ --request POST \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ --header "Content-Type: application/json" \ --data '{ "escalation": { "reason": "BUSINESS_IMPACT", "justification": "This is a test escalation." } }' \ "https://cloudsupport.googleapis.com/v2/$case:escalate" ``` Python: ```python import googleapiclient.discovery api_version = "v2" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", ) request = supportApiService.cases().escalate( name="projects/some-project/cases/43595344", body={ "escalation": { "reason": "BUSINESS_IMPACT", "justification": "This is a test escalation.", }, }, ) print(request.execute()) ```

+

Escalate a case, starting the Google Cloud Support escalation management process. This operation is only available for some support services. Go to https://cloud.google.com/support and look for 'Technical support escalations' in the feature list to find out which ones let you do that. EXAMPLES: cURL: ```shell case="projects/some-project/cases/43595344" curl \ --request POST \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ --header "Content-Type: application/json" \ --data '{ "escalation": { "reason": "BUSINESS_IMPACT", "justification": "This is a test escalation." } }' \ "https://cloudsupport.googleapis.com/v2beta/$case:escalate" ``` Python: ```python import googleapiclient.discovery api_version = "v2beta" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", ) request = supportApiService.cases().escalate( name="projects/some-project/cases/43595344", body={ "escalation": { "reason": "BUSINESS_IMPACT", "justification": "This is a test escalation.", }, }, ) print(request.execute()) ```

get(name, x__xgafv=None)

-

Retrieve a case. EXAMPLES: cURL: ```shell case="projects/some-project/cases/16033687" curl \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ "https://cloudsupport.googleapis.com/v2/$case" ``` Python: ```python import googleapiclient.discovery api_version = "v2" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", ) request = supportApiService.cases().get( name="projects/some-project/cases/43595344", ) print(request.execute()) ```

+

Retrieve a case. EXAMPLES: cURL: ```shell case="projects/some-project/cases/16033687" curl \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ "https://cloudsupport.googleapis.com/v2beta/$case" ``` Python: ```python import googleapiclient.discovery api_version = "v2beta" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", ) request = supportApiService.cases().get( name="projects/some-project/cases/43595344", ) print(request.execute()) ```

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

-

Retrieve all cases under a parent, but not its children. For example, listing cases under an organization only returns the cases that are directly parented by that organization. To retrieve cases under an organization and its projects, use `cases.search`. EXAMPLES: cURL: ```shell parent="projects/some-project" curl \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ "https://cloudsupport.googleapis.com/v2/$parent/cases" ``` Python: ```python import googleapiclient.discovery api_version = "v2" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", ) request = supportApiService.cases().list(parent="projects/some-project") print(request.execute()) ```

+

Retrieve all cases under a parent, but not its children. For example, listing cases under an organization only returns the cases that are directly parented by that organization. To retrieve cases under an organization and its projects, use `cases.search`. EXAMPLES: cURL: ```shell parent="projects/some-project" curl \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ "https://cloudsupport.googleapis.com/v2beta/$parent/cases" ``` Python: ```python import googleapiclient.discovery api_version = "v2beta" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", ) request = supportApiService.cases().list(parent="projects/some-project") print(request.execute()) ```

list_next()

Retrieves the next page of results.

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

-

Update a case. Only some fields can be updated. EXAMPLES: cURL: ```shell case="projects/some-project/cases/43595344" curl \ --request PATCH \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ --header "Content-Type: application/json" \ --data '{ "priority": "P1" }' \ "https://cloudsupport.googleapis.com/v2/$case?updateMask=priority" ``` Python: ```python import googleapiclient.discovery api_version = "v2" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", ) request = supportApiService.cases().patch( name="projects/some-project/cases/43112854", body={ "displayName": "This is Now a New Title", "priority": "P2", }, ) print(request.execute()) ```

+

Update a case. Only some fields can be updated. EXAMPLES: cURL: ```shell case="projects/some-project/cases/43595344" curl \ --request PATCH \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ --header "Content-Type: application/json" \ --data '{ "priority": "P1" }' \ "https://cloudsupport.googleapis.com/v2beta/$case?updateMask=priority" ``` Python: ```python import googleapiclient.discovery api_version = "v2beta" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", ) request = supportApiService.cases().patch( name="projects/some-project/cases/43112854", body={ "displayName": "This is Now a New Title", "priority": "P2", }, ) print(request.execute()) ```

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

-

Search for cases using a query. EXAMPLES: cURL: ```shell parent="projects/some-project" curl \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ "https://cloudsupport.googleapis.com/v2/$parent/cases:search" ``` Python: ```python import googleapiclient.discovery api_version = "v2" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", ) request = supportApiService.cases().search( parent="projects/some-project", query="state=OPEN" ) print(request.execute()) ```

+

Search for cases using a query. EXAMPLES: cURL: ```shell parent="projects/some-project" curl \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ "https://cloudsupport.googleapis.com/v2beta/$parent/cases:search" ``` Python: ```python import googleapiclient.discovery api_version = "v2beta" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", ) request = supportApiService.cases().search( parent="projects/some-project", query="state=OPEN" ) print(request.execute()) ```

search_next()

Retrieves the next page of results.

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

Instance Methods

Method Details

close(name, body=None, x__xgafv=None) -
Close a case. EXAMPLES: cURL: ```shell case="projects/some-project/cases/43595344" curl \ --request POST \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ "https://cloudsupport.googleapis.com/v2/$case:close" ``` Python: ```python import googleapiclient.discovery api_version = "v2" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", ) request = supportApiService.cases().close( name="projects/some-project/cases/43595344" ) print(request.execute()) ```
+  
Close a case. EXAMPLES: cURL: ```shell case="projects/some-project/cases/43595344" curl \ --request POST \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ "https://cloudsupport.googleapis.com/v2beta/$case:close" ``` Python: ```python import googleapiclient.discovery api_version = "v2beta" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", ) request = supportApiService.cases().close( name="projects/some-project/cases/43595344" ) print(request.execute()) ```
 
 Args:
   name: string, Required. The name of the case to close. (required)
@@ -173,7 +173,7 @@ 

Method Details

create(parent, body=None, x__xgafv=None) -
Create a new case and associate it with a parent. It must have the following fields set: `display_name`, `description`, `classification`, and `priority`. If you're just testing the API and don't want to route your case to an agent, set `testCase=true`. EXAMPLES: cURL: ```shell parent="projects/some-project" curl \ --request POST \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ --header 'Content-Type: application/json' \ --data '{ "display_name": "Test case created by me.", "description": "a random test case, feel free to close", "classification": { "id": "100IK2AKCLHMGRJ9CDGMOCGP8DM6UTB4BT262T31BT1M2T31DHNMENPO6KS36CPJ786L2TBFEHGN6NPI64R3CDHN8880G08I1H3MURR7DHII0GRCDTQM8" }, "time_zone": "-07:00", "subscriber_email_addresses": [ "foo@domain.com", "bar@domain.com" ], "testCase": true, "priority": "P3" }' \ "https://cloudsupport.googleapis.com/v2/$parent/cases" ``` Python: ```python import googleapiclient.discovery api_version = "v2" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", ) request = supportApiService.cases().create( parent="projects/some-project", body={ "displayName": "A Test Case", "description": "This is a test case.", "testCase": True, "priority": "P2", "classification": { "id": "100IK2AKCLHMGRJ9CDGMOCGP8DM6UTB4BT262T31BT1M2T31DHNMENPO6KS36CPJ786L2TBFEHGN6NPI64R3CDHN8880G08I1H3MURR7DHII0GRCDTQM8" }, }, ) print(request.execute()) ```
+  
Create a new case and associate it with a parent. It must have the following fields set: `display_name`, `description`, `classification`, and `priority`. If you're just testing the API and don't want to route your case to an agent, set `testCase=true`. EXAMPLES: cURL: ```shell parent="projects/some-project" curl \ --request POST \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ --header 'Content-Type: application/json' \ --data '{ "display_name": "Test case created by me.", "description": "a random test case, feel free to close", "classification": { "id": "100IK2AKCLHMGRJ9CDGMOCGP8DM6UTB4BT262T31BT1M2T31DHNMENPO6KS36CPJ786L2TBFEHGN6NPI64R3CDHN8880G08I1H3MURR7DHII0GRCDTQM8" }, "time_zone": "-07:00", "subscriber_email_addresses": [ "foo@domain.com", "bar@domain.com" ], "testCase": true, "priority": "P3" }' \ "https://cloudsupport.googleapis.com/v2beta/$parent/cases" ``` Python: ```python import googleapiclient.discovery api_version = "v2beta" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", ) request = supportApiService.cases().create( parent="projects/some-project", body={ "displayName": "A Test Case", "description": "This is a test case.", "testCase": True, "priority": "P2", "classification": { "id": "100IK2AKCLHMGRJ9CDGMOCGP8DM6UTB4BT262T31BT1M2T31DHNMENPO6KS36CPJ786L2TBFEHGN6NPI64R3CDHN8880G08I1H3MURR7DHII0GRCDTQM8" }, }, ) print(request.execute()) ```
 
 Args:
   parent: string, Required. The name of the parent under which the case should be created. (required)
@@ -255,7 +255,7 @@ 

Method Details

escalate(name, body=None, x__xgafv=None) -
Escalate a case, starting the Google Cloud Support escalation management process. This operation is only available for some support services. Go to https://cloud.google.com/support and look for 'Technical support escalations' in the feature list to find out which ones let you do that. EXAMPLES: cURL: ```shell case="projects/some-project/cases/43595344" curl \ --request POST \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ --header "Content-Type: application/json" \ --data '{ "escalation": { "reason": "BUSINESS_IMPACT", "justification": "This is a test escalation." } }' \ "https://cloudsupport.googleapis.com/v2/$case:escalate" ``` Python: ```python import googleapiclient.discovery api_version = "v2" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", ) request = supportApiService.cases().escalate( name="projects/some-project/cases/43595344", body={ "escalation": { "reason": "BUSINESS_IMPACT", "justification": "This is a test escalation.", }, }, ) print(request.execute()) ```
+  
Escalate a case, starting the Google Cloud Support escalation management process. This operation is only available for some support services. Go to https://cloud.google.com/support and look for 'Technical support escalations' in the feature list to find out which ones let you do that. EXAMPLES: cURL: ```shell case="projects/some-project/cases/43595344" curl \ --request POST \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ --header "Content-Type: application/json" \ --data '{ "escalation": { "reason": "BUSINESS_IMPACT", "justification": "This is a test escalation." } }' \ "https://cloudsupport.googleapis.com/v2beta/$case:escalate" ``` Python: ```python import googleapiclient.discovery api_version = "v2beta" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", ) request = supportApiService.cases().escalate( name="projects/some-project/cases/43595344", body={ "escalation": { "reason": "BUSINESS_IMPACT", "justification": "This is a test escalation.", }, }, ) print(request.execute()) ```
 
 Args:
   name: string, Required. The name of the case to be escalated. (required)
@@ -312,7 +312,7 @@ 

Method Details

get(name, x__xgafv=None) -
Retrieve a case. EXAMPLES: cURL: ```shell case="projects/some-project/cases/16033687" curl \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ "https://cloudsupport.googleapis.com/v2/$case" ``` Python: ```python import googleapiclient.discovery api_version = "v2" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", ) request = supportApiService.cases().get( name="projects/some-project/cases/43595344", ) print(request.execute()) ```
+  
Retrieve a case. EXAMPLES: cURL: ```shell case="projects/some-project/cases/16033687" curl \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ "https://cloudsupport.googleapis.com/v2beta/$case" ``` Python: ```python import googleapiclient.discovery api_version = "v2beta" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", ) request = supportApiService.cases().get( name="projects/some-project/cases/43595344", ) print(request.execute()) ```
 
 Args:
   name: string, Required. The full name of a case to be retrieved. (required)
@@ -359,7 +359,7 @@ 

Method Details

list(parent, filter=None, pageSize=None, pageToken=None, productLine=None, x__xgafv=None) -
Retrieve all cases under a parent, but not its children. For example, listing cases under an organization only returns the cases that are directly parented by that organization. To retrieve cases under an organization and its projects, use `cases.search`. EXAMPLES: cURL: ```shell parent="projects/some-project" curl \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ "https://cloudsupport.googleapis.com/v2/$parent/cases" ``` Python: ```python import googleapiclient.discovery api_version = "v2" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", ) request = supportApiService.cases().list(parent="projects/some-project") print(request.execute()) ```
+  
Retrieve all cases under a parent, but not its children. For example, listing cases under an organization only returns the cases that are directly parented by that organization. To retrieve cases under an organization and its projects, use `cases.search`. EXAMPLES: cURL: ```shell parent="projects/some-project" curl \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ "https://cloudsupport.googleapis.com/v2beta/$parent/cases" ``` Python: ```python import googleapiclient.discovery api_version = "v2beta" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", ) request = supportApiService.cases().list(parent="projects/some-project") print(request.execute()) ```
 
 Args:
   parent: string, Required. The name of a parent to list cases under. (required)
@@ -433,7 +433,7 @@ 

Method Details

patch(name, body=None, updateMask=None, x__xgafv=None) -
Update a case. Only some fields can be updated. EXAMPLES: cURL: ```shell case="projects/some-project/cases/43595344" curl \ --request PATCH \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ --header "Content-Type: application/json" \ --data '{ "priority": "P1" }' \ "https://cloudsupport.googleapis.com/v2/$case?updateMask=priority" ``` Python: ```python import googleapiclient.discovery api_version = "v2" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", ) request = supportApiService.cases().patch( name="projects/some-project/cases/43112854", body={ "displayName": "This is Now a New Title", "priority": "P2", }, ) print(request.execute()) ```
+  
Update a case. Only some fields can be updated. EXAMPLES: cURL: ```shell case="projects/some-project/cases/43595344" curl \ --request PATCH \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ --header "Content-Type: application/json" \ --data '{ "priority": "P1" }' \ "https://cloudsupport.googleapis.com/v2beta/$case?updateMask=priority" ``` Python: ```python import googleapiclient.discovery api_version = "v2beta" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", ) request = supportApiService.cases().patch( name="projects/some-project/cases/43112854", body={ "displayName": "This is Now a New Title", "priority": "P2", }, ) print(request.execute()) ```
 
 Args:
   name: string, Identifier. The resource name for the case. (required)
@@ -516,7 +516,7 @@ 

Method Details

search(pageSize=None, pageToken=None, parent=None, query=None, x__xgafv=None) -
Search for cases using a query. EXAMPLES: cURL: ```shell parent="projects/some-project" curl \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ "https://cloudsupport.googleapis.com/v2/$parent/cases:search" ``` Python: ```python import googleapiclient.discovery api_version = "v2" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", ) request = supportApiService.cases().search( parent="projects/some-project", query="state=OPEN" ) print(request.execute()) ```
+  
Search for cases using a query. EXAMPLES: cURL: ```shell parent="projects/some-project" curl \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ "https://cloudsupport.googleapis.com/v2beta/$parent/cases:search" ``` Python: ```python import googleapiclient.discovery api_version = "v2beta" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", ) request = supportApiService.cases().search( parent="projects/some-project", query="state=OPEN" ) print(request.execute()) ```
 
 Args:
   pageSize: integer, The maximum number of cases fetched with each request. The default page size is 10.
diff --git a/docs/dyn/cloudsupport_v2beta.media.html b/docs/dyn/cloudsupport_v2beta.media.html
index f6f9d11636..49dcacf3e9 100644
--- a/docs/dyn/cloudsupport_v2beta.media.html
+++ b/docs/dyn/cloudsupport_v2beta.media.html
@@ -79,13 +79,13 @@ 

Instance Methods

Close httplib2 connections.

download(name, x__xgafv=None)

-

Download a file attached to a case. When this endpoint is called, no "response body" will be returned. Instead, the attachment's blob will be returned. Note: HTTP requests must append "?alt=media" to the URL. EXAMPLES: cURL: ```shell name="projects/some-project/cases/43594844/attachments/0674M00000WijAnZAJ" curl \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ "https://cloudsupport.googleapis.com/v2/$name:download?alt=media" ``` Python: ```python import googleapiclient.discovery api_version = "v2" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", ) request = supportApiService.media().download( name="projects/some-project/cases/43595344/attachments/0684M00000Pw6pHQAR" ) request.uri = request.uri.split("?")[0] + "?alt=media" print(request.execute()) ```

+

Download a file attached to a case. When this endpoint is called, no "response body" will be returned. Instead, the attachment's blob will be returned. Note: HTTP requests must append "?alt=media" to the URL. EXAMPLES: cURL: ```shell name="projects/some-project/cases/43594844/attachments/0674M00000WijAnZAJ" curl \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ "https://cloudsupport.googleapis.com/v2beta/$name:download?alt=media" ``` Python: ```python import googleapiclient.discovery api_version = "v2beta" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", ) request = supportApiService.media().download( name="projects/some-project/cases/43595344/attachments/0684M00000Pw6pHQAR" ) request.uri = request.uri.split("?")[0] + "?alt=media" print(request.execute()) ```

download_media(name, x__xgafv=None)

-

Download a file attached to a case. When this endpoint is called, no "response body" will be returned. Instead, the attachment's blob will be returned. Note: HTTP requests must append "?alt=media" to the URL. EXAMPLES: cURL: ```shell name="projects/some-project/cases/43594844/attachments/0674M00000WijAnZAJ" curl \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ "https://cloudsupport.googleapis.com/v2/$name:download?alt=media" ``` Python: ```python import googleapiclient.discovery api_version = "v2" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", ) request = supportApiService.media().download( name="projects/some-project/cases/43595344/attachments/0684M00000Pw6pHQAR" ) request.uri = request.uri.split("?")[0] + "?alt=media" print(request.execute()) ```

+

Download a file attached to a case. When this endpoint is called, no "response body" will be returned. Instead, the attachment's blob will be returned. Note: HTTP requests must append "?alt=media" to the URL. EXAMPLES: cURL: ```shell name="projects/some-project/cases/43594844/attachments/0674M00000WijAnZAJ" curl \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ "https://cloudsupport.googleapis.com/v2beta/$name:download?alt=media" ``` Python: ```python import googleapiclient.discovery api_version = "v2beta" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", ) request = supportApiService.media().download( name="projects/some-project/cases/43595344/attachments/0684M00000Pw6pHQAR" ) request.uri = request.uri.split("?")[0] + "?alt=media" print(request.execute()) ```

upload(parent, body=None, media_body=None, media_mime_type=None, x__xgafv=None)

-

Create a file attachment on a case or Cloud resource. The attachment must have the following fields set: `filename`. EXAMPLES: cURL: ```shell echo "This text is in a file I'm uploading using CSAPI." \ > "./example_file.txt" case="projects/some-project/cases/43594844" curl \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ --data-binary @"./example_file.txt" \ "https://cloudsupport.googleapis.com/upload/v2beta/$case/attachments?attachment.filename=uploaded_via_curl.txt" ``` Python: ```python import googleapiclient.discovery api_version = "v2" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", ) file_path = "./example_file.txt" with open(file_path, "w") as file: file.write( "This text is inside a file I'm going to upload using the Cloud Support API.", ) request = supportApiService.media().upload( parent="projects/some-project/cases/43595344", media_body=file_path ) request.uri = request.uri.split("?")[0] + "?attachment.filename=uploaded_via_python.txt" print(request.execute()) ```

+

Create a file attachment on a case or Cloud resource. The attachment must have the following fields set: `filename`. EXAMPLES: cURL: ```shell echo "This text is in a file I'm uploading using CSAPI." \ > "./example_file.txt" case="projects/some-project/cases/43594844" curl \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ --data-binary @"./example_file.txt" \ "https://cloudsupport.googleapis.com/upload/v2beta/$case/attachments?attachment.filename=uploaded_via_curl.txt" ``` Python: ```python import googleapiclient.discovery api_version = "v2beta" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", ) file_path = "./example_file.txt" with open(file_path, "w") as file: file.write( "This text is inside a file I'm going to upload using the Cloud Support API.", ) request = supportApiService.media().upload( parent="projects/some-project/cases/43595344", media_body=file_path ) request.uri = request.uri.split("?")[0] + "?attachment.filename=uploaded_via_python.txt" print(request.execute()) ```

Method Details

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

Method Details

download(name, x__xgafv=None) -
Download a file attached to a case. When this endpoint is called, no "response body" will be returned. Instead, the attachment's blob will be returned. Note: HTTP requests must append "?alt=media" to the URL. EXAMPLES: cURL: ```shell name="projects/some-project/cases/43594844/attachments/0674M00000WijAnZAJ" curl \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ "https://cloudsupport.googleapis.com/v2/$name:download?alt=media" ``` Python: ```python import googleapiclient.discovery api_version = "v2" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", ) request = supportApiService.media().download( name="projects/some-project/cases/43595344/attachments/0684M00000Pw6pHQAR" ) request.uri = request.uri.split("?")[0] + "?alt=media" print(request.execute()) ```
+  
Download a file attached to a case. When this endpoint is called, no "response body" will be returned. Instead, the attachment's blob will be returned. Note: HTTP requests must append "?alt=media" to the URL. EXAMPLES: cURL: ```shell name="projects/some-project/cases/43594844/attachments/0674M00000WijAnZAJ" curl \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ "https://cloudsupport.googleapis.com/v2beta/$name:download?alt=media" ``` Python: ```python import googleapiclient.discovery api_version = "v2beta" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", ) request = supportApiService.media().download( name="projects/some-project/cases/43595344/attachments/0684M00000Pw6pHQAR" ) request.uri = request.uri.split("?")[0] + "?alt=media" print(request.execute()) ```
 
 Args:
   name: string, The name of the file attachment to download. (required)
@@ -346,6 +346,7 @@ 

Method Details

"referenceType": "A String", # # gdata.* are outside protos with mising documentation "sha1Hash": "A String", # # gdata.* are outside protos with mising documentation "sha256Hash": "A String", # # gdata.* are outside protos with mising documentation + "sha512Hash": "A String", # # gdata.* are outside protos with mising documentation "timestamp": "A String", # # gdata.* are outside protos with mising documentation "token": "A String", # # gdata.* are outside protos with mising documentation }
@@ -353,7 +354,7 @@

Method Details

download_media(name, x__xgafv=None) -
Download a file attached to a case. When this endpoint is called, no "response body" will be returned. Instead, the attachment's blob will be returned. Note: HTTP requests must append "?alt=media" to the URL. EXAMPLES: cURL: ```shell name="projects/some-project/cases/43594844/attachments/0674M00000WijAnZAJ" curl \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ "https://cloudsupport.googleapis.com/v2/$name:download?alt=media" ``` Python: ```python import googleapiclient.discovery api_version = "v2" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", ) request = supportApiService.media().download( name="projects/some-project/cases/43595344/attachments/0684M00000Pw6pHQAR" ) request.uri = request.uri.split("?")[0] + "?alt=media" print(request.execute()) ```
+  
Download a file attached to a case. When this endpoint is called, no "response body" will be returned. Instead, the attachment's blob will be returned. Note: HTTP requests must append "?alt=media" to the URL. EXAMPLES: cURL: ```shell name="projects/some-project/cases/43594844/attachments/0674M00000WijAnZAJ" curl \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ "https://cloudsupport.googleapis.com/v2beta/$name:download?alt=media" ``` Python: ```python import googleapiclient.discovery api_version = "v2beta" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", ) request = supportApiService.media().download( name="projects/some-project/cases/43595344/attachments/0684M00000Pw6pHQAR" ) request.uri = request.uri.split("?")[0] + "?alt=media" print(request.execute()) ```
 
 Args:
   name: string, The name of the file attachment to download. (required)
@@ -370,7 +371,7 @@ 

Method Details

upload(parent, body=None, media_body=None, media_mime_type=None, x__xgafv=None) -
Create a file attachment on a case or Cloud resource. The attachment must have the following fields set: `filename`. EXAMPLES: cURL: ```shell echo "This text is in a file I'm uploading using CSAPI." \ > "./example_file.txt" case="projects/some-project/cases/43594844" curl \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ --data-binary @"./example_file.txt" \ "https://cloudsupport.googleapis.com/upload/v2beta/$case/attachments?attachment.filename=uploaded_via_curl.txt" ``` Python: ```python import googleapiclient.discovery api_version = "v2" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", ) file_path = "./example_file.txt" with open(file_path, "w") as file: file.write( "This text is inside a file I'm going to upload using the Cloud Support API.", ) request = supportApiService.media().upload( parent="projects/some-project/cases/43595344", media_body=file_path ) request.uri = request.uri.split("?")[0] + "?attachment.filename=uploaded_via_python.txt" print(request.execute()) ```
+  
Create a file attachment on a case or Cloud resource. The attachment must have the following fields set: `filename`. EXAMPLES: cURL: ```shell echo "This text is in a file I'm uploading using CSAPI." \ > "./example_file.txt" case="projects/some-project/cases/43594844" curl \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ --data-binary @"./example_file.txt" \ "https://cloudsupport.googleapis.com/upload/v2beta/$case/attachments?attachment.filename=uploaded_via_curl.txt" ``` Python: ```python import googleapiclient.discovery api_version = "v2beta" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", ) file_path = "./example_file.txt" with open(file_path, "w") as file: file.write( "This text is inside a file I'm going to upload using the Cloud Support API.", ) request = supportApiService.media().upload( parent="projects/some-project/cases/43595344", media_body=file_path ) request.uri = request.uri.split("?")[0] + "?attachment.filename=uploaded_via_python.txt" print(request.execute()) ```
 
 Args:
   parent: string, Required. The name of the case or Cloud resource to which the attachment should be attached. (required)
diff --git a/docs/dyn/cloudtasks_v2.projects.locations.queues.html b/docs/dyn/cloudtasks_v2.projects.locations.queues.html
index aca4be3c13..d51b0ef6d4 100644
--- a/docs/dyn/cloudtasks_v2.projects.locations.queues.html
+++ b/docs/dyn/cloudtasks_v2.projects.locations.queues.html
@@ -176,14 +176,14 @@ 

Method Details

"rateLimits": { # Rate limits. This message determines the maximum rate that tasks can be dispatched by a queue, regardless of whether the dispatch is a first task attempt or a retry. Note: The debugging command, RunTask, will run a task even if the queue has reached its RateLimits. # Rate limits for task dispatches. rate_limits and retry_config are related because they both control task attempts. However they control task attempts in different ways: * rate_limits controls the total rate of dispatches from a queue (i.e. all traffic dispatched from the queue, regardless of whether the dispatch is from a first attempt or a retry). * retry_config controls what happens to particular a task after its first attempt fails. That is, retry_config controls task retries (the second attempt, third attempt, etc). The queue's actual dispatch rate is the result of: * Number of tasks in the queue * User-specified throttling: rate_limits, retry_config, and the queue's state. * System throttling due to `429` (Too Many Requests) or `503` (Service Unavailable) responses from the worker, high error rates, or to smooth sudden large traffic spikes. "maxBurstSize": 42, # Output only. The max burst size. Max burst size limits how fast tasks in queue are processed when many tasks are in the queue and the rate is high. This field allows the queue to have a high rate so processing starts shortly after a task is enqueued, but still limits resource usage when many tasks are enqueued in a short period of time. The [token bucket](https://wikipedia.org/wiki/Token_Bucket) algorithm is used to control the rate of task dispatches. Each queue has a token bucket that holds tokens, up to the maximum specified by `max_burst_size`. Each time a task is dispatched, a token is removed from the bucket. Tasks will be dispatched until the queue's bucket runs out of tokens. The bucket will be continuously refilled with new tokens based on `max_dispatches_per_second`. Cloud Tasks automatically sets an appropriate `max_burst_size` based on the value of `max_dispatches_per_second`. The value is dynamically optimized to ensure queue stability and throughput. It is generally at least equal to `max_dispatches_per_second` but might be higher to accommodate bursts of traffic. For queues that were created or updated using `queue.yaml/xml`, `max_burst_size` is equal to [bucket_size](https://cloud.google.com/appengine/docs/standard/python/config/queueref#bucket_size). Since `max_burst_size` is output only, if UpdateQueue is called on a queue created by `queue.yaml/xml`, `max_burst_size` will be reset based on the value of `max_dispatches_per_second`, regardless of whether `max_dispatches_per_second` is updated. "maxConcurrentDispatches": 42, # The maximum number of concurrent tasks that Cloud Tasks allows to be dispatched for this queue. After this threshold has been reached, Cloud Tasks stops dispatching tasks until the number of concurrent requests decreases. If unspecified when the queue is created, Cloud Tasks will pick the default. The maximum allowed value is 5,000. This field has the same meaning as [max_concurrent_requests in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#max_concurrent_requests). - "maxDispatchesPerSecond": 3.14, # The maximum rate at which tasks are dispatched from this queue. If unspecified when the queue is created, Cloud Tasks will pick the default. * The maximum allowed value is 500. This field has the same meaning as [rate in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#rate). + "maxDispatchesPerSecond": 3.14, # The maximum rate at which tasks are dispatched from this queue. If unspecified when the queue is created, Cloud Tasks will pick the default. The maximum allowed value is 500. This field has the same meaning as [rate in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#rate). }, "retryConfig": { # Retry config. These settings determine when a failed task attempt is retried. # Settings that determine the retry behavior. * For tasks created using Cloud Tasks: the queue-level retry settings apply to all tasks in the queue that were created using Cloud Tasks. Retry settings cannot be set on individual tasks. * For tasks created using the App Engine SDK: the queue-level retry settings apply to all tasks in the queue which do not have retry settings explicitly set on the task and were created by the App Engine SDK. See [App Engine documentation](https://cloud.google.com/appengine/docs/standard/python/taskqueue/push/retrying-tasks). - "maxAttempts": 42, # Number of attempts per task. Cloud Tasks will attempt the task `max_attempts` times (that is, if the first attempt fails, then there will be `max_attempts - 1` retries). Must be >= -1. If unspecified when the queue is created, Cloud Tasks will pick the default. -1 indicates unlimited attempts. This field has the same meaning as [task_retry_limit in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). Note: Cloud Tasks stops retrying only when `max_attempts` and `max_retry_duration` are both satisfied. When the task has been attempted `max_attempts` times and when the `max_retry_duration` time has passed, no further attempts are made, and the task is deleted. If you want your task to retry infinitely, you must set `max_attempts` to -1 and `max_retry_duration` to 0. - "maxBackoff": "A String", # A task will be scheduled for retry between min_backoff and max_backoff duration after it fails, if the queue's RetryConfig specifies that the task should be retried. If unspecified when the queue is created, Cloud Tasks will pick the default. The value must be given as a string that indicates the length of time (in seconds) followed by `s` (for "seconds"). For more information on the format, see the documentation for [Duration](https://protobuf.dev/reference/protobuf/google.protobuf/#duration). `max_backoff` will be truncated to the nearest second. This field has the same meaning as [max_backoff_seconds in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). + "maxAttempts": 42, # Number of attempts per task, including the first attempt. (If the first attempt fails, there will be `max_attempts - 1` retries.) Must be greater than or equal to -1, which indicates unlimited attempts. Cloud Tasks stops retrying only when `max_attempts` and `max_retry_duration` are both satisfied, or when the task is successfully executed. When the task has been attempted `max_attempts` times and when the `max_retry_duration` time has passed, no further attempts are made, and the task is deleted. If `max_attempts` is set to -1 and `max_retry_duration` is set to 0, the task is retried until the [maximum task retention](https://docs.cloud.google.com/tasks/docs/quotas#limits) limit is reached. If unspecified when the queue is created, Cloud Tasks will pick the default. This field has the same meaning as [task_retry_limit in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). + "maxBackoff": "A String", # A task will be scheduled for retry between min_backoff and max_backoff duration after it fails, if the queue's RetryConfig specifies that the task should be retried. The value must be given as a string that indicates the length of time (in seconds) followed by `s` (for "seconds"). For more information on the format, see the documentation for [Duration](https://protobuf.dev/reference/protobuf/google.protobuf/#duration). `max_backoff` will be truncated to the nearest second. If unspecified when the queue is created, Cloud Tasks will pick the default. This field has the same meaning as [max_backoff_seconds in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). "maxDoublings": 42, # The time between retries will double `max_doublings` times. A task's retry interval starts at min_backoff, then doubles `max_doublings` times, then increases linearly, and finally retries at intervals of max_backoff up to max_attempts times. For example, if min_backoff is 10s, max_backoff is 300s, and `max_doublings` is 3, then the a task will first be retried in 10s. The retry interval will double three times, and then increase linearly by 2^3 * 10s. Finally, the task will retry at intervals of max_backoff until the task has been attempted max_attempts times. Thus, the requests will retry at 10s, 20s, 40s, 80s, 160s, 240s, 300s, 300s, .... If unspecified when the queue is created, Cloud Tasks will pick the default. This field has the same meaning as [max_doublings in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). - "maxRetryDuration": "A String", # If positive, `max_retry_duration` specifies the time limit for retrying a failed task, measured from when the task was first attempted. Once `max_retry_duration` time has passed *and* the task has been attempted max_attempts times, no further attempts will be made and the task will be deleted. If zero, then the task age is unlimited. If unspecified when the queue is created, Cloud Tasks will pick the default. The value must be given as a string that indicates the length of time (in seconds) followed by `s` (for "seconds"). For the maximum possible value or the format, see the documentation for [Duration](https://protobuf.dev/reference/protobuf/google.protobuf/#duration). `max_retry_duration` will be truncated to the nearest second. This field has the same meaning as [task_age_limit in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). - "minBackoff": "A String", # A task will be scheduled for retry between min_backoff and max_backoff duration after it fails, if the queue's RetryConfig specifies that the task should be retried. If unspecified when the queue is created, Cloud Tasks will pick the default. The value must be given as a string that indicates the length of time (in seconds) followed by `s` (for "seconds"). For more information on the format, see the documentation for [Duration](https://protobuf.dev/reference/protobuf/google.protobuf/#duration). `min_backoff` will be truncated to the nearest second. This field has the same meaning as [min_backoff_seconds in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). + "maxRetryDuration": "A String", # If positive, `max_retry_duration` specifies the time limit for retrying a failed task, measured from when the task was first attempted. Once `max_retry_duration` time has passed *and* the task has been attempted max_attempts times, no further attempts are made and the task is deleted. A zero (0) indicates an unlimited duration, up to the [maximum task retention](https://docs.cloud.google.com/tasks/docs/quotas#limits) limit. The value must be given as a string that indicates the length of time (in seconds) followed by `s` (for "seconds"). For the maximum possible value or the format, see the documentation for [Duration](https://protobuf.dev/reference/protobuf/google.protobuf/#duration). `max_retry_duration` will be truncated to the nearest second. If unspecified when the queue is created, Cloud Tasks will pick the default. This field has the same meaning as [task_age_limit in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). + "minBackoff": "A String", # A task will be scheduled for retry between min_backoff and max_backoff duration after it fails, if the queue's RetryConfig specifies that the task should be retried. The value must be given as a string that indicates the length of time (in seconds) followed by `s` (for "seconds"). For more information on the format, see the documentation for [Duration](https://protobuf.dev/reference/protobuf/google.protobuf/#duration). `min_backoff` will be truncated to the nearest second. If unspecified when the queue is created, Cloud Tasks will pick the default. This field has the same meaning as [min_backoff_seconds in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). }, "stackdriverLoggingConfig": { # Configuration options for writing logs to [Stackdriver Logging](https://cloud.google.com/logging/docs/). # Configuration options for writing logs to [Stackdriver Logging](https://cloud.google.com/logging/docs/). If this field is unset, then no logs are written. "samplingRatio": 3.14, # Specifies the fraction of operations to write to [Stackdriver Logging](https://cloud.google.com/logging/docs/). This field may contain any value between 0.0 and 1.0, inclusive. 0.0 is the default and means that no operations are logged. @@ -242,14 +242,14 @@

Method Details

"rateLimits": { # Rate limits. This message determines the maximum rate that tasks can be dispatched by a queue, regardless of whether the dispatch is a first task attempt or a retry. Note: The debugging command, RunTask, will run a task even if the queue has reached its RateLimits. # Rate limits for task dispatches. rate_limits and retry_config are related because they both control task attempts. However they control task attempts in different ways: * rate_limits controls the total rate of dispatches from a queue (i.e. all traffic dispatched from the queue, regardless of whether the dispatch is from a first attempt or a retry). * retry_config controls what happens to particular a task after its first attempt fails. That is, retry_config controls task retries (the second attempt, third attempt, etc). The queue's actual dispatch rate is the result of: * Number of tasks in the queue * User-specified throttling: rate_limits, retry_config, and the queue's state. * System throttling due to `429` (Too Many Requests) or `503` (Service Unavailable) responses from the worker, high error rates, or to smooth sudden large traffic spikes. "maxBurstSize": 42, # Output only. The max burst size. Max burst size limits how fast tasks in queue are processed when many tasks are in the queue and the rate is high. This field allows the queue to have a high rate so processing starts shortly after a task is enqueued, but still limits resource usage when many tasks are enqueued in a short period of time. The [token bucket](https://wikipedia.org/wiki/Token_Bucket) algorithm is used to control the rate of task dispatches. Each queue has a token bucket that holds tokens, up to the maximum specified by `max_burst_size`. Each time a task is dispatched, a token is removed from the bucket. Tasks will be dispatched until the queue's bucket runs out of tokens. The bucket will be continuously refilled with new tokens based on `max_dispatches_per_second`. Cloud Tasks automatically sets an appropriate `max_burst_size` based on the value of `max_dispatches_per_second`. The value is dynamically optimized to ensure queue stability and throughput. It is generally at least equal to `max_dispatches_per_second` but might be higher to accommodate bursts of traffic. For queues that were created or updated using `queue.yaml/xml`, `max_burst_size` is equal to [bucket_size](https://cloud.google.com/appengine/docs/standard/python/config/queueref#bucket_size). Since `max_burst_size` is output only, if UpdateQueue is called on a queue created by `queue.yaml/xml`, `max_burst_size` will be reset based on the value of `max_dispatches_per_second`, regardless of whether `max_dispatches_per_second` is updated. "maxConcurrentDispatches": 42, # The maximum number of concurrent tasks that Cloud Tasks allows to be dispatched for this queue. After this threshold has been reached, Cloud Tasks stops dispatching tasks until the number of concurrent requests decreases. If unspecified when the queue is created, Cloud Tasks will pick the default. The maximum allowed value is 5,000. This field has the same meaning as [max_concurrent_requests in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#max_concurrent_requests). - "maxDispatchesPerSecond": 3.14, # The maximum rate at which tasks are dispatched from this queue. If unspecified when the queue is created, Cloud Tasks will pick the default. * The maximum allowed value is 500. This field has the same meaning as [rate in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#rate). + "maxDispatchesPerSecond": 3.14, # The maximum rate at which tasks are dispatched from this queue. If unspecified when the queue is created, Cloud Tasks will pick the default. The maximum allowed value is 500. This field has the same meaning as [rate in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#rate). }, "retryConfig": { # Retry config. These settings determine when a failed task attempt is retried. # Settings that determine the retry behavior. * For tasks created using Cloud Tasks: the queue-level retry settings apply to all tasks in the queue that were created using Cloud Tasks. Retry settings cannot be set on individual tasks. * For tasks created using the App Engine SDK: the queue-level retry settings apply to all tasks in the queue which do not have retry settings explicitly set on the task and were created by the App Engine SDK. See [App Engine documentation](https://cloud.google.com/appengine/docs/standard/python/taskqueue/push/retrying-tasks). - "maxAttempts": 42, # Number of attempts per task. Cloud Tasks will attempt the task `max_attempts` times (that is, if the first attempt fails, then there will be `max_attempts - 1` retries). Must be >= -1. If unspecified when the queue is created, Cloud Tasks will pick the default. -1 indicates unlimited attempts. This field has the same meaning as [task_retry_limit in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). Note: Cloud Tasks stops retrying only when `max_attempts` and `max_retry_duration` are both satisfied. When the task has been attempted `max_attempts` times and when the `max_retry_duration` time has passed, no further attempts are made, and the task is deleted. If you want your task to retry infinitely, you must set `max_attempts` to -1 and `max_retry_duration` to 0. - "maxBackoff": "A String", # A task will be scheduled for retry between min_backoff and max_backoff duration after it fails, if the queue's RetryConfig specifies that the task should be retried. If unspecified when the queue is created, Cloud Tasks will pick the default. The value must be given as a string that indicates the length of time (in seconds) followed by `s` (for "seconds"). For more information on the format, see the documentation for [Duration](https://protobuf.dev/reference/protobuf/google.protobuf/#duration). `max_backoff` will be truncated to the nearest second. This field has the same meaning as [max_backoff_seconds in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). + "maxAttempts": 42, # Number of attempts per task, including the first attempt. (If the first attempt fails, there will be `max_attempts - 1` retries.) Must be greater than or equal to -1, which indicates unlimited attempts. Cloud Tasks stops retrying only when `max_attempts` and `max_retry_duration` are both satisfied, or when the task is successfully executed. When the task has been attempted `max_attempts` times and when the `max_retry_duration` time has passed, no further attempts are made, and the task is deleted. If `max_attempts` is set to -1 and `max_retry_duration` is set to 0, the task is retried until the [maximum task retention](https://docs.cloud.google.com/tasks/docs/quotas#limits) limit is reached. If unspecified when the queue is created, Cloud Tasks will pick the default. This field has the same meaning as [task_retry_limit in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). + "maxBackoff": "A String", # A task will be scheduled for retry between min_backoff and max_backoff duration after it fails, if the queue's RetryConfig specifies that the task should be retried. The value must be given as a string that indicates the length of time (in seconds) followed by `s` (for "seconds"). For more information on the format, see the documentation for [Duration](https://protobuf.dev/reference/protobuf/google.protobuf/#duration). `max_backoff` will be truncated to the nearest second. If unspecified when the queue is created, Cloud Tasks will pick the default. This field has the same meaning as [max_backoff_seconds in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). "maxDoublings": 42, # The time between retries will double `max_doublings` times. A task's retry interval starts at min_backoff, then doubles `max_doublings` times, then increases linearly, and finally retries at intervals of max_backoff up to max_attempts times. For example, if min_backoff is 10s, max_backoff is 300s, and `max_doublings` is 3, then the a task will first be retried in 10s. The retry interval will double three times, and then increase linearly by 2^3 * 10s. Finally, the task will retry at intervals of max_backoff until the task has been attempted max_attempts times. Thus, the requests will retry at 10s, 20s, 40s, 80s, 160s, 240s, 300s, 300s, .... If unspecified when the queue is created, Cloud Tasks will pick the default. This field has the same meaning as [max_doublings in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). - "maxRetryDuration": "A String", # If positive, `max_retry_duration` specifies the time limit for retrying a failed task, measured from when the task was first attempted. Once `max_retry_duration` time has passed *and* the task has been attempted max_attempts times, no further attempts will be made and the task will be deleted. If zero, then the task age is unlimited. If unspecified when the queue is created, Cloud Tasks will pick the default. The value must be given as a string that indicates the length of time (in seconds) followed by `s` (for "seconds"). For the maximum possible value or the format, see the documentation for [Duration](https://protobuf.dev/reference/protobuf/google.protobuf/#duration). `max_retry_duration` will be truncated to the nearest second. This field has the same meaning as [task_age_limit in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). - "minBackoff": "A String", # A task will be scheduled for retry between min_backoff and max_backoff duration after it fails, if the queue's RetryConfig specifies that the task should be retried. If unspecified when the queue is created, Cloud Tasks will pick the default. The value must be given as a string that indicates the length of time (in seconds) followed by `s` (for "seconds"). For more information on the format, see the documentation for [Duration](https://protobuf.dev/reference/protobuf/google.protobuf/#duration). `min_backoff` will be truncated to the nearest second. This field has the same meaning as [min_backoff_seconds in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). + "maxRetryDuration": "A String", # If positive, `max_retry_duration` specifies the time limit for retrying a failed task, measured from when the task was first attempted. Once `max_retry_duration` time has passed *and* the task has been attempted max_attempts times, no further attempts are made and the task is deleted. A zero (0) indicates an unlimited duration, up to the [maximum task retention](https://docs.cloud.google.com/tasks/docs/quotas#limits) limit. The value must be given as a string that indicates the length of time (in seconds) followed by `s` (for "seconds"). For the maximum possible value or the format, see the documentation for [Duration](https://protobuf.dev/reference/protobuf/google.protobuf/#duration). `max_retry_duration` will be truncated to the nearest second. If unspecified when the queue is created, Cloud Tasks will pick the default. This field has the same meaning as [task_age_limit in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). + "minBackoff": "A String", # A task will be scheduled for retry between min_backoff and max_backoff duration after it fails, if the queue's RetryConfig specifies that the task should be retried. The value must be given as a string that indicates the length of time (in seconds) followed by `s` (for "seconds"). For more information on the format, see the documentation for [Duration](https://protobuf.dev/reference/protobuf/google.protobuf/#duration). `min_backoff` will be truncated to the nearest second. If unspecified when the queue is created, Cloud Tasks will pick the default. This field has the same meaning as [min_backoff_seconds in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). }, "stackdriverLoggingConfig": { # Configuration options for writing logs to [Stackdriver Logging](https://cloud.google.com/logging/docs/). # Configuration options for writing logs to [Stackdriver Logging](https://cloud.google.com/logging/docs/). If this field is unset, then no logs are written. "samplingRatio": 3.14, # Specifies the fraction of operations to write to [Stackdriver Logging](https://cloud.google.com/logging/docs/). This field may contain any value between 0.0 and 1.0, inclusive. 0.0 is the default and means that no operations are logged. @@ -333,14 +333,14 @@

Method Details

"rateLimits": { # Rate limits. This message determines the maximum rate that tasks can be dispatched by a queue, regardless of whether the dispatch is a first task attempt or a retry. Note: The debugging command, RunTask, will run a task even if the queue has reached its RateLimits. # Rate limits for task dispatches. rate_limits and retry_config are related because they both control task attempts. However they control task attempts in different ways: * rate_limits controls the total rate of dispatches from a queue (i.e. all traffic dispatched from the queue, regardless of whether the dispatch is from a first attempt or a retry). * retry_config controls what happens to particular a task after its first attempt fails. That is, retry_config controls task retries (the second attempt, third attempt, etc). The queue's actual dispatch rate is the result of: * Number of tasks in the queue * User-specified throttling: rate_limits, retry_config, and the queue's state. * System throttling due to `429` (Too Many Requests) or `503` (Service Unavailable) responses from the worker, high error rates, or to smooth sudden large traffic spikes. "maxBurstSize": 42, # Output only. The max burst size. Max burst size limits how fast tasks in queue are processed when many tasks are in the queue and the rate is high. This field allows the queue to have a high rate so processing starts shortly after a task is enqueued, but still limits resource usage when many tasks are enqueued in a short period of time. The [token bucket](https://wikipedia.org/wiki/Token_Bucket) algorithm is used to control the rate of task dispatches. Each queue has a token bucket that holds tokens, up to the maximum specified by `max_burst_size`. Each time a task is dispatched, a token is removed from the bucket. Tasks will be dispatched until the queue's bucket runs out of tokens. The bucket will be continuously refilled with new tokens based on `max_dispatches_per_second`. Cloud Tasks automatically sets an appropriate `max_burst_size` based on the value of `max_dispatches_per_second`. The value is dynamically optimized to ensure queue stability and throughput. It is generally at least equal to `max_dispatches_per_second` but might be higher to accommodate bursts of traffic. For queues that were created or updated using `queue.yaml/xml`, `max_burst_size` is equal to [bucket_size](https://cloud.google.com/appengine/docs/standard/python/config/queueref#bucket_size). Since `max_burst_size` is output only, if UpdateQueue is called on a queue created by `queue.yaml/xml`, `max_burst_size` will be reset based on the value of `max_dispatches_per_second`, regardless of whether `max_dispatches_per_second` is updated. "maxConcurrentDispatches": 42, # The maximum number of concurrent tasks that Cloud Tasks allows to be dispatched for this queue. After this threshold has been reached, Cloud Tasks stops dispatching tasks until the number of concurrent requests decreases. If unspecified when the queue is created, Cloud Tasks will pick the default. The maximum allowed value is 5,000. This field has the same meaning as [max_concurrent_requests in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#max_concurrent_requests). - "maxDispatchesPerSecond": 3.14, # The maximum rate at which tasks are dispatched from this queue. If unspecified when the queue is created, Cloud Tasks will pick the default. * The maximum allowed value is 500. This field has the same meaning as [rate in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#rate). + "maxDispatchesPerSecond": 3.14, # The maximum rate at which tasks are dispatched from this queue. If unspecified when the queue is created, Cloud Tasks will pick the default. The maximum allowed value is 500. This field has the same meaning as [rate in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#rate). }, "retryConfig": { # Retry config. These settings determine when a failed task attempt is retried. # Settings that determine the retry behavior. * For tasks created using Cloud Tasks: the queue-level retry settings apply to all tasks in the queue that were created using Cloud Tasks. Retry settings cannot be set on individual tasks. * For tasks created using the App Engine SDK: the queue-level retry settings apply to all tasks in the queue which do not have retry settings explicitly set on the task and were created by the App Engine SDK. See [App Engine documentation](https://cloud.google.com/appengine/docs/standard/python/taskqueue/push/retrying-tasks). - "maxAttempts": 42, # Number of attempts per task. Cloud Tasks will attempt the task `max_attempts` times (that is, if the first attempt fails, then there will be `max_attempts - 1` retries). Must be >= -1. If unspecified when the queue is created, Cloud Tasks will pick the default. -1 indicates unlimited attempts. This field has the same meaning as [task_retry_limit in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). Note: Cloud Tasks stops retrying only when `max_attempts` and `max_retry_duration` are both satisfied. When the task has been attempted `max_attempts` times and when the `max_retry_duration` time has passed, no further attempts are made, and the task is deleted. If you want your task to retry infinitely, you must set `max_attempts` to -1 and `max_retry_duration` to 0. - "maxBackoff": "A String", # A task will be scheduled for retry between min_backoff and max_backoff duration after it fails, if the queue's RetryConfig specifies that the task should be retried. If unspecified when the queue is created, Cloud Tasks will pick the default. The value must be given as a string that indicates the length of time (in seconds) followed by `s` (for "seconds"). For more information on the format, see the documentation for [Duration](https://protobuf.dev/reference/protobuf/google.protobuf/#duration). `max_backoff` will be truncated to the nearest second. This field has the same meaning as [max_backoff_seconds in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). + "maxAttempts": 42, # Number of attempts per task, including the first attempt. (If the first attempt fails, there will be `max_attempts - 1` retries.) Must be greater than or equal to -1, which indicates unlimited attempts. Cloud Tasks stops retrying only when `max_attempts` and `max_retry_duration` are both satisfied, or when the task is successfully executed. When the task has been attempted `max_attempts` times and when the `max_retry_duration` time has passed, no further attempts are made, and the task is deleted. If `max_attempts` is set to -1 and `max_retry_duration` is set to 0, the task is retried until the [maximum task retention](https://docs.cloud.google.com/tasks/docs/quotas#limits) limit is reached. If unspecified when the queue is created, Cloud Tasks will pick the default. This field has the same meaning as [task_retry_limit in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). + "maxBackoff": "A String", # A task will be scheduled for retry between min_backoff and max_backoff duration after it fails, if the queue's RetryConfig specifies that the task should be retried. The value must be given as a string that indicates the length of time (in seconds) followed by `s` (for "seconds"). For more information on the format, see the documentation for [Duration](https://protobuf.dev/reference/protobuf/google.protobuf/#duration). `max_backoff` will be truncated to the nearest second. If unspecified when the queue is created, Cloud Tasks will pick the default. This field has the same meaning as [max_backoff_seconds in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). "maxDoublings": 42, # The time between retries will double `max_doublings` times. A task's retry interval starts at min_backoff, then doubles `max_doublings` times, then increases linearly, and finally retries at intervals of max_backoff up to max_attempts times. For example, if min_backoff is 10s, max_backoff is 300s, and `max_doublings` is 3, then the a task will first be retried in 10s. The retry interval will double three times, and then increase linearly by 2^3 * 10s. Finally, the task will retry at intervals of max_backoff until the task has been attempted max_attempts times. Thus, the requests will retry at 10s, 20s, 40s, 80s, 160s, 240s, 300s, 300s, .... If unspecified when the queue is created, Cloud Tasks will pick the default. This field has the same meaning as [max_doublings in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). - "maxRetryDuration": "A String", # If positive, `max_retry_duration` specifies the time limit for retrying a failed task, measured from when the task was first attempted. Once `max_retry_duration` time has passed *and* the task has been attempted max_attempts times, no further attempts will be made and the task will be deleted. If zero, then the task age is unlimited. If unspecified when the queue is created, Cloud Tasks will pick the default. The value must be given as a string that indicates the length of time (in seconds) followed by `s` (for "seconds"). For the maximum possible value or the format, see the documentation for [Duration](https://protobuf.dev/reference/protobuf/google.protobuf/#duration). `max_retry_duration` will be truncated to the nearest second. This field has the same meaning as [task_age_limit in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). - "minBackoff": "A String", # A task will be scheduled for retry between min_backoff and max_backoff duration after it fails, if the queue's RetryConfig specifies that the task should be retried. If unspecified when the queue is created, Cloud Tasks will pick the default. The value must be given as a string that indicates the length of time (in seconds) followed by `s` (for "seconds"). For more information on the format, see the documentation for [Duration](https://protobuf.dev/reference/protobuf/google.protobuf/#duration). `min_backoff` will be truncated to the nearest second. This field has the same meaning as [min_backoff_seconds in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). + "maxRetryDuration": "A String", # If positive, `max_retry_duration` specifies the time limit for retrying a failed task, measured from when the task was first attempted. Once `max_retry_duration` time has passed *and* the task has been attempted max_attempts times, no further attempts are made and the task is deleted. A zero (0) indicates an unlimited duration, up to the [maximum task retention](https://docs.cloud.google.com/tasks/docs/quotas#limits) limit. The value must be given as a string that indicates the length of time (in seconds) followed by `s` (for "seconds"). For the maximum possible value or the format, see the documentation for [Duration](https://protobuf.dev/reference/protobuf/google.protobuf/#duration). `max_retry_duration` will be truncated to the nearest second. If unspecified when the queue is created, Cloud Tasks will pick the default. This field has the same meaning as [task_age_limit in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). + "minBackoff": "A String", # A task will be scheduled for retry between min_backoff and max_backoff duration after it fails, if the queue's RetryConfig specifies that the task should be retried. The value must be given as a string that indicates the length of time (in seconds) followed by `s` (for "seconds"). For more information on the format, see the documentation for [Duration](https://protobuf.dev/reference/protobuf/google.protobuf/#duration). `min_backoff` will be truncated to the nearest second. If unspecified when the queue is created, Cloud Tasks will pick the default. This field has the same meaning as [min_backoff_seconds in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). }, "stackdriverLoggingConfig": { # Configuration options for writing logs to [Stackdriver Logging](https://cloud.google.com/logging/docs/). # Configuration options for writing logs to [Stackdriver Logging](https://cloud.google.com/logging/docs/). If this field is unset, then no logs are written. "samplingRatio": 3.14, # Specifies the fraction of operations to write to [Stackdriver Logging](https://cloud.google.com/logging/docs/). This field may contain any value between 0.0 and 1.0, inclusive. 0.0 is the default and means that no operations are logged. @@ -455,14 +455,14 @@

Method Details

"rateLimits": { # Rate limits. This message determines the maximum rate that tasks can be dispatched by a queue, regardless of whether the dispatch is a first task attempt or a retry. Note: The debugging command, RunTask, will run a task even if the queue has reached its RateLimits. # Rate limits for task dispatches. rate_limits and retry_config are related because they both control task attempts. However they control task attempts in different ways: * rate_limits controls the total rate of dispatches from a queue (i.e. all traffic dispatched from the queue, regardless of whether the dispatch is from a first attempt or a retry). * retry_config controls what happens to particular a task after its first attempt fails. That is, retry_config controls task retries (the second attempt, third attempt, etc). The queue's actual dispatch rate is the result of: * Number of tasks in the queue * User-specified throttling: rate_limits, retry_config, and the queue's state. * System throttling due to `429` (Too Many Requests) or `503` (Service Unavailable) responses from the worker, high error rates, or to smooth sudden large traffic spikes. "maxBurstSize": 42, # Output only. The max burst size. Max burst size limits how fast tasks in queue are processed when many tasks are in the queue and the rate is high. This field allows the queue to have a high rate so processing starts shortly after a task is enqueued, but still limits resource usage when many tasks are enqueued in a short period of time. The [token bucket](https://wikipedia.org/wiki/Token_Bucket) algorithm is used to control the rate of task dispatches. Each queue has a token bucket that holds tokens, up to the maximum specified by `max_burst_size`. Each time a task is dispatched, a token is removed from the bucket. Tasks will be dispatched until the queue's bucket runs out of tokens. The bucket will be continuously refilled with new tokens based on `max_dispatches_per_second`. Cloud Tasks automatically sets an appropriate `max_burst_size` based on the value of `max_dispatches_per_second`. The value is dynamically optimized to ensure queue stability and throughput. It is generally at least equal to `max_dispatches_per_second` but might be higher to accommodate bursts of traffic. For queues that were created or updated using `queue.yaml/xml`, `max_burst_size` is equal to [bucket_size](https://cloud.google.com/appengine/docs/standard/python/config/queueref#bucket_size). Since `max_burst_size` is output only, if UpdateQueue is called on a queue created by `queue.yaml/xml`, `max_burst_size` will be reset based on the value of `max_dispatches_per_second`, regardless of whether `max_dispatches_per_second` is updated. "maxConcurrentDispatches": 42, # The maximum number of concurrent tasks that Cloud Tasks allows to be dispatched for this queue. After this threshold has been reached, Cloud Tasks stops dispatching tasks until the number of concurrent requests decreases. If unspecified when the queue is created, Cloud Tasks will pick the default. The maximum allowed value is 5,000. This field has the same meaning as [max_concurrent_requests in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#max_concurrent_requests). - "maxDispatchesPerSecond": 3.14, # The maximum rate at which tasks are dispatched from this queue. If unspecified when the queue is created, Cloud Tasks will pick the default. * The maximum allowed value is 500. This field has the same meaning as [rate in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#rate). + "maxDispatchesPerSecond": 3.14, # The maximum rate at which tasks are dispatched from this queue. If unspecified when the queue is created, Cloud Tasks will pick the default. The maximum allowed value is 500. This field has the same meaning as [rate in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#rate). }, "retryConfig": { # Retry config. These settings determine when a failed task attempt is retried. # Settings that determine the retry behavior. * For tasks created using Cloud Tasks: the queue-level retry settings apply to all tasks in the queue that were created using Cloud Tasks. Retry settings cannot be set on individual tasks. * For tasks created using the App Engine SDK: the queue-level retry settings apply to all tasks in the queue which do not have retry settings explicitly set on the task and were created by the App Engine SDK. See [App Engine documentation](https://cloud.google.com/appengine/docs/standard/python/taskqueue/push/retrying-tasks). - "maxAttempts": 42, # Number of attempts per task. Cloud Tasks will attempt the task `max_attempts` times (that is, if the first attempt fails, then there will be `max_attempts - 1` retries). Must be >= -1. If unspecified when the queue is created, Cloud Tasks will pick the default. -1 indicates unlimited attempts. This field has the same meaning as [task_retry_limit in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). Note: Cloud Tasks stops retrying only when `max_attempts` and `max_retry_duration` are both satisfied. When the task has been attempted `max_attempts` times and when the `max_retry_duration` time has passed, no further attempts are made, and the task is deleted. If you want your task to retry infinitely, you must set `max_attempts` to -1 and `max_retry_duration` to 0. - "maxBackoff": "A String", # A task will be scheduled for retry between min_backoff and max_backoff duration after it fails, if the queue's RetryConfig specifies that the task should be retried. If unspecified when the queue is created, Cloud Tasks will pick the default. The value must be given as a string that indicates the length of time (in seconds) followed by `s` (for "seconds"). For more information on the format, see the documentation for [Duration](https://protobuf.dev/reference/protobuf/google.protobuf/#duration). `max_backoff` will be truncated to the nearest second. This field has the same meaning as [max_backoff_seconds in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). + "maxAttempts": 42, # Number of attempts per task, including the first attempt. (If the first attempt fails, there will be `max_attempts - 1` retries.) Must be greater than or equal to -1, which indicates unlimited attempts. Cloud Tasks stops retrying only when `max_attempts` and `max_retry_duration` are both satisfied, or when the task is successfully executed. When the task has been attempted `max_attempts` times and when the `max_retry_duration` time has passed, no further attempts are made, and the task is deleted. If `max_attempts` is set to -1 and `max_retry_duration` is set to 0, the task is retried until the [maximum task retention](https://docs.cloud.google.com/tasks/docs/quotas#limits) limit is reached. If unspecified when the queue is created, Cloud Tasks will pick the default. This field has the same meaning as [task_retry_limit in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). + "maxBackoff": "A String", # A task will be scheduled for retry between min_backoff and max_backoff duration after it fails, if the queue's RetryConfig specifies that the task should be retried. The value must be given as a string that indicates the length of time (in seconds) followed by `s` (for "seconds"). For more information on the format, see the documentation for [Duration](https://protobuf.dev/reference/protobuf/google.protobuf/#duration). `max_backoff` will be truncated to the nearest second. If unspecified when the queue is created, Cloud Tasks will pick the default. This field has the same meaning as [max_backoff_seconds in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). "maxDoublings": 42, # The time between retries will double `max_doublings` times. A task's retry interval starts at min_backoff, then doubles `max_doublings` times, then increases linearly, and finally retries at intervals of max_backoff up to max_attempts times. For example, if min_backoff is 10s, max_backoff is 300s, and `max_doublings` is 3, then the a task will first be retried in 10s. The retry interval will double three times, and then increase linearly by 2^3 * 10s. Finally, the task will retry at intervals of max_backoff until the task has been attempted max_attempts times. Thus, the requests will retry at 10s, 20s, 40s, 80s, 160s, 240s, 300s, 300s, .... If unspecified when the queue is created, Cloud Tasks will pick the default. This field has the same meaning as [max_doublings in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). - "maxRetryDuration": "A String", # If positive, `max_retry_duration` specifies the time limit for retrying a failed task, measured from when the task was first attempted. Once `max_retry_duration` time has passed *and* the task has been attempted max_attempts times, no further attempts will be made and the task will be deleted. If zero, then the task age is unlimited. If unspecified when the queue is created, Cloud Tasks will pick the default. The value must be given as a string that indicates the length of time (in seconds) followed by `s` (for "seconds"). For the maximum possible value or the format, see the documentation for [Duration](https://protobuf.dev/reference/protobuf/google.protobuf/#duration). `max_retry_duration` will be truncated to the nearest second. This field has the same meaning as [task_age_limit in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). - "minBackoff": "A String", # A task will be scheduled for retry between min_backoff and max_backoff duration after it fails, if the queue's RetryConfig specifies that the task should be retried. If unspecified when the queue is created, Cloud Tasks will pick the default. The value must be given as a string that indicates the length of time (in seconds) followed by `s` (for "seconds"). For more information on the format, see the documentation for [Duration](https://protobuf.dev/reference/protobuf/google.protobuf/#duration). `min_backoff` will be truncated to the nearest second. This field has the same meaning as [min_backoff_seconds in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). + "maxRetryDuration": "A String", # If positive, `max_retry_duration` specifies the time limit for retrying a failed task, measured from when the task was first attempted. Once `max_retry_duration` time has passed *and* the task has been attempted max_attempts times, no further attempts are made and the task is deleted. A zero (0) indicates an unlimited duration, up to the [maximum task retention](https://docs.cloud.google.com/tasks/docs/quotas#limits) limit. The value must be given as a string that indicates the length of time (in seconds) followed by `s` (for "seconds"). For the maximum possible value or the format, see the documentation for [Duration](https://protobuf.dev/reference/protobuf/google.protobuf/#duration). `max_retry_duration` will be truncated to the nearest second. If unspecified when the queue is created, Cloud Tasks will pick the default. This field has the same meaning as [task_age_limit in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). + "minBackoff": "A String", # A task will be scheduled for retry between min_backoff and max_backoff duration after it fails, if the queue's RetryConfig specifies that the task should be retried. The value must be given as a string that indicates the length of time (in seconds) followed by `s` (for "seconds"). For more information on the format, see the documentation for [Duration](https://protobuf.dev/reference/protobuf/google.protobuf/#duration). `min_backoff` will be truncated to the nearest second. If unspecified when the queue is created, Cloud Tasks will pick the default. This field has the same meaning as [min_backoff_seconds in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). }, "stackdriverLoggingConfig": { # Configuration options for writing logs to [Stackdriver Logging](https://cloud.google.com/logging/docs/). # Configuration options for writing logs to [Stackdriver Logging](https://cloud.google.com/logging/docs/). If this field is unset, then no logs are written. "samplingRatio": 3.14, # Specifies the fraction of operations to write to [Stackdriver Logging](https://cloud.google.com/logging/docs/). This field may contain any value between 0.0 and 1.0, inclusive. 0.0 is the default and means that no operations are logged. @@ -539,14 +539,14 @@

Method Details

"rateLimits": { # Rate limits. This message determines the maximum rate that tasks can be dispatched by a queue, regardless of whether the dispatch is a first task attempt or a retry. Note: The debugging command, RunTask, will run a task even if the queue has reached its RateLimits. # Rate limits for task dispatches. rate_limits and retry_config are related because they both control task attempts. However they control task attempts in different ways: * rate_limits controls the total rate of dispatches from a queue (i.e. all traffic dispatched from the queue, regardless of whether the dispatch is from a first attempt or a retry). * retry_config controls what happens to particular a task after its first attempt fails. That is, retry_config controls task retries (the second attempt, third attempt, etc). The queue's actual dispatch rate is the result of: * Number of tasks in the queue * User-specified throttling: rate_limits, retry_config, and the queue's state. * System throttling due to `429` (Too Many Requests) or `503` (Service Unavailable) responses from the worker, high error rates, or to smooth sudden large traffic spikes. "maxBurstSize": 42, # Output only. The max burst size. Max burst size limits how fast tasks in queue are processed when many tasks are in the queue and the rate is high. This field allows the queue to have a high rate so processing starts shortly after a task is enqueued, but still limits resource usage when many tasks are enqueued in a short period of time. The [token bucket](https://wikipedia.org/wiki/Token_Bucket) algorithm is used to control the rate of task dispatches. Each queue has a token bucket that holds tokens, up to the maximum specified by `max_burst_size`. Each time a task is dispatched, a token is removed from the bucket. Tasks will be dispatched until the queue's bucket runs out of tokens. The bucket will be continuously refilled with new tokens based on `max_dispatches_per_second`. Cloud Tasks automatically sets an appropriate `max_burst_size` based on the value of `max_dispatches_per_second`. The value is dynamically optimized to ensure queue stability and throughput. It is generally at least equal to `max_dispatches_per_second` but might be higher to accommodate bursts of traffic. For queues that were created or updated using `queue.yaml/xml`, `max_burst_size` is equal to [bucket_size](https://cloud.google.com/appengine/docs/standard/python/config/queueref#bucket_size). Since `max_burst_size` is output only, if UpdateQueue is called on a queue created by `queue.yaml/xml`, `max_burst_size` will be reset based on the value of `max_dispatches_per_second`, regardless of whether `max_dispatches_per_second` is updated. "maxConcurrentDispatches": 42, # The maximum number of concurrent tasks that Cloud Tasks allows to be dispatched for this queue. After this threshold has been reached, Cloud Tasks stops dispatching tasks until the number of concurrent requests decreases. If unspecified when the queue is created, Cloud Tasks will pick the default. The maximum allowed value is 5,000. This field has the same meaning as [max_concurrent_requests in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#max_concurrent_requests). - "maxDispatchesPerSecond": 3.14, # The maximum rate at which tasks are dispatched from this queue. If unspecified when the queue is created, Cloud Tasks will pick the default. * The maximum allowed value is 500. This field has the same meaning as [rate in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#rate). + "maxDispatchesPerSecond": 3.14, # The maximum rate at which tasks are dispatched from this queue. If unspecified when the queue is created, Cloud Tasks will pick the default. The maximum allowed value is 500. This field has the same meaning as [rate in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#rate). }, "retryConfig": { # Retry config. These settings determine when a failed task attempt is retried. # Settings that determine the retry behavior. * For tasks created using Cloud Tasks: the queue-level retry settings apply to all tasks in the queue that were created using Cloud Tasks. Retry settings cannot be set on individual tasks. * For tasks created using the App Engine SDK: the queue-level retry settings apply to all tasks in the queue which do not have retry settings explicitly set on the task and were created by the App Engine SDK. See [App Engine documentation](https://cloud.google.com/appengine/docs/standard/python/taskqueue/push/retrying-tasks). - "maxAttempts": 42, # Number of attempts per task. Cloud Tasks will attempt the task `max_attempts` times (that is, if the first attempt fails, then there will be `max_attempts - 1` retries). Must be >= -1. If unspecified when the queue is created, Cloud Tasks will pick the default. -1 indicates unlimited attempts. This field has the same meaning as [task_retry_limit in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). Note: Cloud Tasks stops retrying only when `max_attempts` and `max_retry_duration` are both satisfied. When the task has been attempted `max_attempts` times and when the `max_retry_duration` time has passed, no further attempts are made, and the task is deleted. If you want your task to retry infinitely, you must set `max_attempts` to -1 and `max_retry_duration` to 0. - "maxBackoff": "A String", # A task will be scheduled for retry between min_backoff and max_backoff duration after it fails, if the queue's RetryConfig specifies that the task should be retried. If unspecified when the queue is created, Cloud Tasks will pick the default. The value must be given as a string that indicates the length of time (in seconds) followed by `s` (for "seconds"). For more information on the format, see the documentation for [Duration](https://protobuf.dev/reference/protobuf/google.protobuf/#duration). `max_backoff` will be truncated to the nearest second. This field has the same meaning as [max_backoff_seconds in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). + "maxAttempts": 42, # Number of attempts per task, including the first attempt. (If the first attempt fails, there will be `max_attempts - 1` retries.) Must be greater than or equal to -1, which indicates unlimited attempts. Cloud Tasks stops retrying only when `max_attempts` and `max_retry_duration` are both satisfied, or when the task is successfully executed. When the task has been attempted `max_attempts` times and when the `max_retry_duration` time has passed, no further attempts are made, and the task is deleted. If `max_attempts` is set to -1 and `max_retry_duration` is set to 0, the task is retried until the [maximum task retention](https://docs.cloud.google.com/tasks/docs/quotas#limits) limit is reached. If unspecified when the queue is created, Cloud Tasks will pick the default. This field has the same meaning as [task_retry_limit in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). + "maxBackoff": "A String", # A task will be scheduled for retry between min_backoff and max_backoff duration after it fails, if the queue's RetryConfig specifies that the task should be retried. The value must be given as a string that indicates the length of time (in seconds) followed by `s` (for "seconds"). For more information on the format, see the documentation for [Duration](https://protobuf.dev/reference/protobuf/google.protobuf/#duration). `max_backoff` will be truncated to the nearest second. If unspecified when the queue is created, Cloud Tasks will pick the default. This field has the same meaning as [max_backoff_seconds in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). "maxDoublings": 42, # The time between retries will double `max_doublings` times. A task's retry interval starts at min_backoff, then doubles `max_doublings` times, then increases linearly, and finally retries at intervals of max_backoff up to max_attempts times. For example, if min_backoff is 10s, max_backoff is 300s, and `max_doublings` is 3, then the a task will first be retried in 10s. The retry interval will double three times, and then increase linearly by 2^3 * 10s. Finally, the task will retry at intervals of max_backoff until the task has been attempted max_attempts times. Thus, the requests will retry at 10s, 20s, 40s, 80s, 160s, 240s, 300s, 300s, .... If unspecified when the queue is created, Cloud Tasks will pick the default. This field has the same meaning as [max_doublings in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). - "maxRetryDuration": "A String", # If positive, `max_retry_duration` specifies the time limit for retrying a failed task, measured from when the task was first attempted. Once `max_retry_duration` time has passed *and* the task has been attempted max_attempts times, no further attempts will be made and the task will be deleted. If zero, then the task age is unlimited. If unspecified when the queue is created, Cloud Tasks will pick the default. The value must be given as a string that indicates the length of time (in seconds) followed by `s` (for "seconds"). For the maximum possible value or the format, see the documentation for [Duration](https://protobuf.dev/reference/protobuf/google.protobuf/#duration). `max_retry_duration` will be truncated to the nearest second. This field has the same meaning as [task_age_limit in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). - "minBackoff": "A String", # A task will be scheduled for retry between min_backoff and max_backoff duration after it fails, if the queue's RetryConfig specifies that the task should be retried. If unspecified when the queue is created, Cloud Tasks will pick the default. The value must be given as a string that indicates the length of time (in seconds) followed by `s` (for "seconds"). For more information on the format, see the documentation for [Duration](https://protobuf.dev/reference/protobuf/google.protobuf/#duration). `min_backoff` will be truncated to the nearest second. This field has the same meaning as [min_backoff_seconds in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). + "maxRetryDuration": "A String", # If positive, `max_retry_duration` specifies the time limit for retrying a failed task, measured from when the task was first attempted. Once `max_retry_duration` time has passed *and* the task has been attempted max_attempts times, no further attempts are made and the task is deleted. A zero (0) indicates an unlimited duration, up to the [maximum task retention](https://docs.cloud.google.com/tasks/docs/quotas#limits) limit. The value must be given as a string that indicates the length of time (in seconds) followed by `s` (for "seconds"). For the maximum possible value or the format, see the documentation for [Duration](https://protobuf.dev/reference/protobuf/google.protobuf/#duration). `max_retry_duration` will be truncated to the nearest second. If unspecified when the queue is created, Cloud Tasks will pick the default. This field has the same meaning as [task_age_limit in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). + "minBackoff": "A String", # A task will be scheduled for retry between min_backoff and max_backoff duration after it fails, if the queue's RetryConfig specifies that the task should be retried. The value must be given as a string that indicates the length of time (in seconds) followed by `s` (for "seconds"). For more information on the format, see the documentation for [Duration](https://protobuf.dev/reference/protobuf/google.protobuf/#duration). `min_backoff` will be truncated to the nearest second. If unspecified when the queue is created, Cloud Tasks will pick the default. This field has the same meaning as [min_backoff_seconds in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). }, "stackdriverLoggingConfig": { # Configuration options for writing logs to [Stackdriver Logging](https://cloud.google.com/logging/docs/). # Configuration options for writing logs to [Stackdriver Logging](https://cloud.google.com/logging/docs/). If this field is unset, then no logs are written. "samplingRatio": 3.14, # Specifies the fraction of operations to write to [Stackdriver Logging](https://cloud.google.com/logging/docs/). This field may contain any value between 0.0 and 1.0, inclusive. 0.0 is the default and means that no operations are logged. @@ -606,14 +606,14 @@

Method Details

"rateLimits": { # Rate limits. This message determines the maximum rate that tasks can be dispatched by a queue, regardless of whether the dispatch is a first task attempt or a retry. Note: The debugging command, RunTask, will run a task even if the queue has reached its RateLimits. # Rate limits for task dispatches. rate_limits and retry_config are related because they both control task attempts. However they control task attempts in different ways: * rate_limits controls the total rate of dispatches from a queue (i.e. all traffic dispatched from the queue, regardless of whether the dispatch is from a first attempt or a retry). * retry_config controls what happens to particular a task after its first attempt fails. That is, retry_config controls task retries (the second attempt, third attempt, etc). The queue's actual dispatch rate is the result of: * Number of tasks in the queue * User-specified throttling: rate_limits, retry_config, and the queue's state. * System throttling due to `429` (Too Many Requests) or `503` (Service Unavailable) responses from the worker, high error rates, or to smooth sudden large traffic spikes. "maxBurstSize": 42, # Output only. The max burst size. Max burst size limits how fast tasks in queue are processed when many tasks are in the queue and the rate is high. This field allows the queue to have a high rate so processing starts shortly after a task is enqueued, but still limits resource usage when many tasks are enqueued in a short period of time. The [token bucket](https://wikipedia.org/wiki/Token_Bucket) algorithm is used to control the rate of task dispatches. Each queue has a token bucket that holds tokens, up to the maximum specified by `max_burst_size`. Each time a task is dispatched, a token is removed from the bucket. Tasks will be dispatched until the queue's bucket runs out of tokens. The bucket will be continuously refilled with new tokens based on `max_dispatches_per_second`. Cloud Tasks automatically sets an appropriate `max_burst_size` based on the value of `max_dispatches_per_second`. The value is dynamically optimized to ensure queue stability and throughput. It is generally at least equal to `max_dispatches_per_second` but might be higher to accommodate bursts of traffic. For queues that were created or updated using `queue.yaml/xml`, `max_burst_size` is equal to [bucket_size](https://cloud.google.com/appengine/docs/standard/python/config/queueref#bucket_size). Since `max_burst_size` is output only, if UpdateQueue is called on a queue created by `queue.yaml/xml`, `max_burst_size` will be reset based on the value of `max_dispatches_per_second`, regardless of whether `max_dispatches_per_second` is updated. "maxConcurrentDispatches": 42, # The maximum number of concurrent tasks that Cloud Tasks allows to be dispatched for this queue. After this threshold has been reached, Cloud Tasks stops dispatching tasks until the number of concurrent requests decreases. If unspecified when the queue is created, Cloud Tasks will pick the default. The maximum allowed value is 5,000. This field has the same meaning as [max_concurrent_requests in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#max_concurrent_requests). - "maxDispatchesPerSecond": 3.14, # The maximum rate at which tasks are dispatched from this queue. If unspecified when the queue is created, Cloud Tasks will pick the default. * The maximum allowed value is 500. This field has the same meaning as [rate in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#rate). + "maxDispatchesPerSecond": 3.14, # The maximum rate at which tasks are dispatched from this queue. If unspecified when the queue is created, Cloud Tasks will pick the default. The maximum allowed value is 500. This field has the same meaning as [rate in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#rate). }, "retryConfig": { # Retry config. These settings determine when a failed task attempt is retried. # Settings that determine the retry behavior. * For tasks created using Cloud Tasks: the queue-level retry settings apply to all tasks in the queue that were created using Cloud Tasks. Retry settings cannot be set on individual tasks. * For tasks created using the App Engine SDK: the queue-level retry settings apply to all tasks in the queue which do not have retry settings explicitly set on the task and were created by the App Engine SDK. See [App Engine documentation](https://cloud.google.com/appengine/docs/standard/python/taskqueue/push/retrying-tasks). - "maxAttempts": 42, # Number of attempts per task. Cloud Tasks will attempt the task `max_attempts` times (that is, if the first attempt fails, then there will be `max_attempts - 1` retries). Must be >= -1. If unspecified when the queue is created, Cloud Tasks will pick the default. -1 indicates unlimited attempts. This field has the same meaning as [task_retry_limit in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). Note: Cloud Tasks stops retrying only when `max_attempts` and `max_retry_duration` are both satisfied. When the task has been attempted `max_attempts` times and when the `max_retry_duration` time has passed, no further attempts are made, and the task is deleted. If you want your task to retry infinitely, you must set `max_attempts` to -1 and `max_retry_duration` to 0. - "maxBackoff": "A String", # A task will be scheduled for retry between min_backoff and max_backoff duration after it fails, if the queue's RetryConfig specifies that the task should be retried. If unspecified when the queue is created, Cloud Tasks will pick the default. The value must be given as a string that indicates the length of time (in seconds) followed by `s` (for "seconds"). For more information on the format, see the documentation for [Duration](https://protobuf.dev/reference/protobuf/google.protobuf/#duration). `max_backoff` will be truncated to the nearest second. This field has the same meaning as [max_backoff_seconds in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). + "maxAttempts": 42, # Number of attempts per task, including the first attempt. (If the first attempt fails, there will be `max_attempts - 1` retries.) Must be greater than or equal to -1, which indicates unlimited attempts. Cloud Tasks stops retrying only when `max_attempts` and `max_retry_duration` are both satisfied, or when the task is successfully executed. When the task has been attempted `max_attempts` times and when the `max_retry_duration` time has passed, no further attempts are made, and the task is deleted. If `max_attempts` is set to -1 and `max_retry_duration` is set to 0, the task is retried until the [maximum task retention](https://docs.cloud.google.com/tasks/docs/quotas#limits) limit is reached. If unspecified when the queue is created, Cloud Tasks will pick the default. This field has the same meaning as [task_retry_limit in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). + "maxBackoff": "A String", # A task will be scheduled for retry between min_backoff and max_backoff duration after it fails, if the queue's RetryConfig specifies that the task should be retried. The value must be given as a string that indicates the length of time (in seconds) followed by `s` (for "seconds"). For more information on the format, see the documentation for [Duration](https://protobuf.dev/reference/protobuf/google.protobuf/#duration). `max_backoff` will be truncated to the nearest second. If unspecified when the queue is created, Cloud Tasks will pick the default. This field has the same meaning as [max_backoff_seconds in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). "maxDoublings": 42, # The time between retries will double `max_doublings` times. A task's retry interval starts at min_backoff, then doubles `max_doublings` times, then increases linearly, and finally retries at intervals of max_backoff up to max_attempts times. For example, if min_backoff is 10s, max_backoff is 300s, and `max_doublings` is 3, then the a task will first be retried in 10s. The retry interval will double three times, and then increase linearly by 2^3 * 10s. Finally, the task will retry at intervals of max_backoff until the task has been attempted max_attempts times. Thus, the requests will retry at 10s, 20s, 40s, 80s, 160s, 240s, 300s, 300s, .... If unspecified when the queue is created, Cloud Tasks will pick the default. This field has the same meaning as [max_doublings in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). - "maxRetryDuration": "A String", # If positive, `max_retry_duration` specifies the time limit for retrying a failed task, measured from when the task was first attempted. Once `max_retry_duration` time has passed *and* the task has been attempted max_attempts times, no further attempts will be made and the task will be deleted. If zero, then the task age is unlimited. If unspecified when the queue is created, Cloud Tasks will pick the default. The value must be given as a string that indicates the length of time (in seconds) followed by `s` (for "seconds"). For the maximum possible value or the format, see the documentation for [Duration](https://protobuf.dev/reference/protobuf/google.protobuf/#duration). `max_retry_duration` will be truncated to the nearest second. This field has the same meaning as [task_age_limit in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). - "minBackoff": "A String", # A task will be scheduled for retry between min_backoff and max_backoff duration after it fails, if the queue's RetryConfig specifies that the task should be retried. If unspecified when the queue is created, Cloud Tasks will pick the default. The value must be given as a string that indicates the length of time (in seconds) followed by `s` (for "seconds"). For more information on the format, see the documentation for [Duration](https://protobuf.dev/reference/protobuf/google.protobuf/#duration). `min_backoff` will be truncated to the nearest second. This field has the same meaning as [min_backoff_seconds in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). + "maxRetryDuration": "A String", # If positive, `max_retry_duration` specifies the time limit for retrying a failed task, measured from when the task was first attempted. Once `max_retry_duration` time has passed *and* the task has been attempted max_attempts times, no further attempts are made and the task is deleted. A zero (0) indicates an unlimited duration, up to the [maximum task retention](https://docs.cloud.google.com/tasks/docs/quotas#limits) limit. The value must be given as a string that indicates the length of time (in seconds) followed by `s` (for "seconds"). For the maximum possible value or the format, see the documentation for [Duration](https://protobuf.dev/reference/protobuf/google.protobuf/#duration). `max_retry_duration` will be truncated to the nearest second. If unspecified when the queue is created, Cloud Tasks will pick the default. This field has the same meaning as [task_age_limit in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). + "minBackoff": "A String", # A task will be scheduled for retry between min_backoff and max_backoff duration after it fails, if the queue's RetryConfig specifies that the task should be retried. The value must be given as a string that indicates the length of time (in seconds) followed by `s` (for "seconds"). For more information on the format, see the documentation for [Duration](https://protobuf.dev/reference/protobuf/google.protobuf/#duration). `min_backoff` will be truncated to the nearest second. If unspecified when the queue is created, Cloud Tasks will pick the default. This field has the same meaning as [min_backoff_seconds in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). }, "stackdriverLoggingConfig": { # Configuration options for writing logs to [Stackdriver Logging](https://cloud.google.com/logging/docs/). # Configuration options for writing logs to [Stackdriver Logging](https://cloud.google.com/logging/docs/). If this field is unset, then no logs are written. "samplingRatio": 3.14, # Specifies the fraction of operations to write to [Stackdriver Logging](https://cloud.google.com/logging/docs/). This field may contain any value between 0.0 and 1.0, inclusive. 0.0 is the default and means that no operations are logged. @@ -685,14 +685,14 @@

Method Details

"rateLimits": { # Rate limits. This message determines the maximum rate that tasks can be dispatched by a queue, regardless of whether the dispatch is a first task attempt or a retry. Note: The debugging command, RunTask, will run a task even if the queue has reached its RateLimits. # Rate limits for task dispatches. rate_limits and retry_config are related because they both control task attempts. However they control task attempts in different ways: * rate_limits controls the total rate of dispatches from a queue (i.e. all traffic dispatched from the queue, regardless of whether the dispatch is from a first attempt or a retry). * retry_config controls what happens to particular a task after its first attempt fails. That is, retry_config controls task retries (the second attempt, third attempt, etc). The queue's actual dispatch rate is the result of: * Number of tasks in the queue * User-specified throttling: rate_limits, retry_config, and the queue's state. * System throttling due to `429` (Too Many Requests) or `503` (Service Unavailable) responses from the worker, high error rates, or to smooth sudden large traffic spikes. "maxBurstSize": 42, # Output only. The max burst size. Max burst size limits how fast tasks in queue are processed when many tasks are in the queue and the rate is high. This field allows the queue to have a high rate so processing starts shortly after a task is enqueued, but still limits resource usage when many tasks are enqueued in a short period of time. The [token bucket](https://wikipedia.org/wiki/Token_Bucket) algorithm is used to control the rate of task dispatches. Each queue has a token bucket that holds tokens, up to the maximum specified by `max_burst_size`. Each time a task is dispatched, a token is removed from the bucket. Tasks will be dispatched until the queue's bucket runs out of tokens. The bucket will be continuously refilled with new tokens based on `max_dispatches_per_second`. Cloud Tasks automatically sets an appropriate `max_burst_size` based on the value of `max_dispatches_per_second`. The value is dynamically optimized to ensure queue stability and throughput. It is generally at least equal to `max_dispatches_per_second` but might be higher to accommodate bursts of traffic. For queues that were created or updated using `queue.yaml/xml`, `max_burst_size` is equal to [bucket_size](https://cloud.google.com/appengine/docs/standard/python/config/queueref#bucket_size). Since `max_burst_size` is output only, if UpdateQueue is called on a queue created by `queue.yaml/xml`, `max_burst_size` will be reset based on the value of `max_dispatches_per_second`, regardless of whether `max_dispatches_per_second` is updated. "maxConcurrentDispatches": 42, # The maximum number of concurrent tasks that Cloud Tasks allows to be dispatched for this queue. After this threshold has been reached, Cloud Tasks stops dispatching tasks until the number of concurrent requests decreases. If unspecified when the queue is created, Cloud Tasks will pick the default. The maximum allowed value is 5,000. This field has the same meaning as [max_concurrent_requests in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#max_concurrent_requests). - "maxDispatchesPerSecond": 3.14, # The maximum rate at which tasks are dispatched from this queue. If unspecified when the queue is created, Cloud Tasks will pick the default. * The maximum allowed value is 500. This field has the same meaning as [rate in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#rate). + "maxDispatchesPerSecond": 3.14, # The maximum rate at which tasks are dispatched from this queue. If unspecified when the queue is created, Cloud Tasks will pick the default. The maximum allowed value is 500. This field has the same meaning as [rate in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#rate). }, "retryConfig": { # Retry config. These settings determine when a failed task attempt is retried. # Settings that determine the retry behavior. * For tasks created using Cloud Tasks: the queue-level retry settings apply to all tasks in the queue that were created using Cloud Tasks. Retry settings cannot be set on individual tasks. * For tasks created using the App Engine SDK: the queue-level retry settings apply to all tasks in the queue which do not have retry settings explicitly set on the task and were created by the App Engine SDK. See [App Engine documentation](https://cloud.google.com/appengine/docs/standard/python/taskqueue/push/retrying-tasks). - "maxAttempts": 42, # Number of attempts per task. Cloud Tasks will attempt the task `max_attempts` times (that is, if the first attempt fails, then there will be `max_attempts - 1` retries). Must be >= -1. If unspecified when the queue is created, Cloud Tasks will pick the default. -1 indicates unlimited attempts. This field has the same meaning as [task_retry_limit in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). Note: Cloud Tasks stops retrying only when `max_attempts` and `max_retry_duration` are both satisfied. When the task has been attempted `max_attempts` times and when the `max_retry_duration` time has passed, no further attempts are made, and the task is deleted. If you want your task to retry infinitely, you must set `max_attempts` to -1 and `max_retry_duration` to 0. - "maxBackoff": "A String", # A task will be scheduled for retry between min_backoff and max_backoff duration after it fails, if the queue's RetryConfig specifies that the task should be retried. If unspecified when the queue is created, Cloud Tasks will pick the default. The value must be given as a string that indicates the length of time (in seconds) followed by `s` (for "seconds"). For more information on the format, see the documentation for [Duration](https://protobuf.dev/reference/protobuf/google.protobuf/#duration). `max_backoff` will be truncated to the nearest second. This field has the same meaning as [max_backoff_seconds in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). + "maxAttempts": 42, # Number of attempts per task, including the first attempt. (If the first attempt fails, there will be `max_attempts - 1` retries.) Must be greater than or equal to -1, which indicates unlimited attempts. Cloud Tasks stops retrying only when `max_attempts` and `max_retry_duration` are both satisfied, or when the task is successfully executed. When the task has been attempted `max_attempts` times and when the `max_retry_duration` time has passed, no further attempts are made, and the task is deleted. If `max_attempts` is set to -1 and `max_retry_duration` is set to 0, the task is retried until the [maximum task retention](https://docs.cloud.google.com/tasks/docs/quotas#limits) limit is reached. If unspecified when the queue is created, Cloud Tasks will pick the default. This field has the same meaning as [task_retry_limit in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). + "maxBackoff": "A String", # A task will be scheduled for retry between min_backoff and max_backoff duration after it fails, if the queue's RetryConfig specifies that the task should be retried. The value must be given as a string that indicates the length of time (in seconds) followed by `s` (for "seconds"). For more information on the format, see the documentation for [Duration](https://protobuf.dev/reference/protobuf/google.protobuf/#duration). `max_backoff` will be truncated to the nearest second. If unspecified when the queue is created, Cloud Tasks will pick the default. This field has the same meaning as [max_backoff_seconds in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). "maxDoublings": 42, # The time between retries will double `max_doublings` times. A task's retry interval starts at min_backoff, then doubles `max_doublings` times, then increases linearly, and finally retries at intervals of max_backoff up to max_attempts times. For example, if min_backoff is 10s, max_backoff is 300s, and `max_doublings` is 3, then the a task will first be retried in 10s. The retry interval will double three times, and then increase linearly by 2^3 * 10s. Finally, the task will retry at intervals of max_backoff until the task has been attempted max_attempts times. Thus, the requests will retry at 10s, 20s, 40s, 80s, 160s, 240s, 300s, 300s, .... If unspecified when the queue is created, Cloud Tasks will pick the default. This field has the same meaning as [max_doublings in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). - "maxRetryDuration": "A String", # If positive, `max_retry_duration` specifies the time limit for retrying a failed task, measured from when the task was first attempted. Once `max_retry_duration` time has passed *and* the task has been attempted max_attempts times, no further attempts will be made and the task will be deleted. If zero, then the task age is unlimited. If unspecified when the queue is created, Cloud Tasks will pick the default. The value must be given as a string that indicates the length of time (in seconds) followed by `s` (for "seconds"). For the maximum possible value or the format, see the documentation for [Duration](https://protobuf.dev/reference/protobuf/google.protobuf/#duration). `max_retry_duration` will be truncated to the nearest second. This field has the same meaning as [task_age_limit in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). - "minBackoff": "A String", # A task will be scheduled for retry between min_backoff and max_backoff duration after it fails, if the queue's RetryConfig specifies that the task should be retried. If unspecified when the queue is created, Cloud Tasks will pick the default. The value must be given as a string that indicates the length of time (in seconds) followed by `s` (for "seconds"). For more information on the format, see the documentation for [Duration](https://protobuf.dev/reference/protobuf/google.protobuf/#duration). `min_backoff` will be truncated to the nearest second. This field has the same meaning as [min_backoff_seconds in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). + "maxRetryDuration": "A String", # If positive, `max_retry_duration` specifies the time limit for retrying a failed task, measured from when the task was first attempted. Once `max_retry_duration` time has passed *and* the task has been attempted max_attempts times, no further attempts are made and the task is deleted. A zero (0) indicates an unlimited duration, up to the [maximum task retention](https://docs.cloud.google.com/tasks/docs/quotas#limits) limit. The value must be given as a string that indicates the length of time (in seconds) followed by `s` (for "seconds"). For the maximum possible value or the format, see the documentation for [Duration](https://protobuf.dev/reference/protobuf/google.protobuf/#duration). `max_retry_duration` will be truncated to the nearest second. If unspecified when the queue is created, Cloud Tasks will pick the default. This field has the same meaning as [task_age_limit in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). + "minBackoff": "A String", # A task will be scheduled for retry between min_backoff and max_backoff duration after it fails, if the queue's RetryConfig specifies that the task should be retried. The value must be given as a string that indicates the length of time (in seconds) followed by `s` (for "seconds"). For more information on the format, see the documentation for [Duration](https://protobuf.dev/reference/protobuf/google.protobuf/#duration). `min_backoff` will be truncated to the nearest second. If unspecified when the queue is created, Cloud Tasks will pick the default. This field has the same meaning as [min_backoff_seconds in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). }, "stackdriverLoggingConfig": { # Configuration options for writing logs to [Stackdriver Logging](https://cloud.google.com/logging/docs/). # Configuration options for writing logs to [Stackdriver Logging](https://cloud.google.com/logging/docs/). If this field is unset, then no logs are written. "samplingRatio": 3.14, # Specifies the fraction of operations to write to [Stackdriver Logging](https://cloud.google.com/logging/docs/). This field may contain any value between 0.0 and 1.0, inclusive. 0.0 is the default and means that no operations are logged. @@ -764,14 +764,14 @@

Method Details

"rateLimits": { # Rate limits. This message determines the maximum rate that tasks can be dispatched by a queue, regardless of whether the dispatch is a first task attempt or a retry. Note: The debugging command, RunTask, will run a task even if the queue has reached its RateLimits. # Rate limits for task dispatches. rate_limits and retry_config are related because they both control task attempts. However they control task attempts in different ways: * rate_limits controls the total rate of dispatches from a queue (i.e. all traffic dispatched from the queue, regardless of whether the dispatch is from a first attempt or a retry). * retry_config controls what happens to particular a task after its first attempt fails. That is, retry_config controls task retries (the second attempt, third attempt, etc). The queue's actual dispatch rate is the result of: * Number of tasks in the queue * User-specified throttling: rate_limits, retry_config, and the queue's state. * System throttling due to `429` (Too Many Requests) or `503` (Service Unavailable) responses from the worker, high error rates, or to smooth sudden large traffic spikes. "maxBurstSize": 42, # Output only. The max burst size. Max burst size limits how fast tasks in queue are processed when many tasks are in the queue and the rate is high. This field allows the queue to have a high rate so processing starts shortly after a task is enqueued, but still limits resource usage when many tasks are enqueued in a short period of time. The [token bucket](https://wikipedia.org/wiki/Token_Bucket) algorithm is used to control the rate of task dispatches. Each queue has a token bucket that holds tokens, up to the maximum specified by `max_burst_size`. Each time a task is dispatched, a token is removed from the bucket. Tasks will be dispatched until the queue's bucket runs out of tokens. The bucket will be continuously refilled with new tokens based on `max_dispatches_per_second`. Cloud Tasks automatically sets an appropriate `max_burst_size` based on the value of `max_dispatches_per_second`. The value is dynamically optimized to ensure queue stability and throughput. It is generally at least equal to `max_dispatches_per_second` but might be higher to accommodate bursts of traffic. For queues that were created or updated using `queue.yaml/xml`, `max_burst_size` is equal to [bucket_size](https://cloud.google.com/appengine/docs/standard/python/config/queueref#bucket_size). Since `max_burst_size` is output only, if UpdateQueue is called on a queue created by `queue.yaml/xml`, `max_burst_size` will be reset based on the value of `max_dispatches_per_second`, regardless of whether `max_dispatches_per_second` is updated. "maxConcurrentDispatches": 42, # The maximum number of concurrent tasks that Cloud Tasks allows to be dispatched for this queue. After this threshold has been reached, Cloud Tasks stops dispatching tasks until the number of concurrent requests decreases. If unspecified when the queue is created, Cloud Tasks will pick the default. The maximum allowed value is 5,000. This field has the same meaning as [max_concurrent_requests in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#max_concurrent_requests). - "maxDispatchesPerSecond": 3.14, # The maximum rate at which tasks are dispatched from this queue. If unspecified when the queue is created, Cloud Tasks will pick the default. * The maximum allowed value is 500. This field has the same meaning as [rate in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#rate). + "maxDispatchesPerSecond": 3.14, # The maximum rate at which tasks are dispatched from this queue. If unspecified when the queue is created, Cloud Tasks will pick the default. The maximum allowed value is 500. This field has the same meaning as [rate in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#rate). }, "retryConfig": { # Retry config. These settings determine when a failed task attempt is retried. # Settings that determine the retry behavior. * For tasks created using Cloud Tasks: the queue-level retry settings apply to all tasks in the queue that were created using Cloud Tasks. Retry settings cannot be set on individual tasks. * For tasks created using the App Engine SDK: the queue-level retry settings apply to all tasks in the queue which do not have retry settings explicitly set on the task and were created by the App Engine SDK. See [App Engine documentation](https://cloud.google.com/appengine/docs/standard/python/taskqueue/push/retrying-tasks). - "maxAttempts": 42, # Number of attempts per task. Cloud Tasks will attempt the task `max_attempts` times (that is, if the first attempt fails, then there will be `max_attempts - 1` retries). Must be >= -1. If unspecified when the queue is created, Cloud Tasks will pick the default. -1 indicates unlimited attempts. This field has the same meaning as [task_retry_limit in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). Note: Cloud Tasks stops retrying only when `max_attempts` and `max_retry_duration` are both satisfied. When the task has been attempted `max_attempts` times and when the `max_retry_duration` time has passed, no further attempts are made, and the task is deleted. If you want your task to retry infinitely, you must set `max_attempts` to -1 and `max_retry_duration` to 0. - "maxBackoff": "A String", # A task will be scheduled for retry between min_backoff and max_backoff duration after it fails, if the queue's RetryConfig specifies that the task should be retried. If unspecified when the queue is created, Cloud Tasks will pick the default. The value must be given as a string that indicates the length of time (in seconds) followed by `s` (for "seconds"). For more information on the format, see the documentation for [Duration](https://protobuf.dev/reference/protobuf/google.protobuf/#duration). `max_backoff` will be truncated to the nearest second. This field has the same meaning as [max_backoff_seconds in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). + "maxAttempts": 42, # Number of attempts per task, including the first attempt. (If the first attempt fails, there will be `max_attempts - 1` retries.) Must be greater than or equal to -1, which indicates unlimited attempts. Cloud Tasks stops retrying only when `max_attempts` and `max_retry_duration` are both satisfied, or when the task is successfully executed. When the task has been attempted `max_attempts` times and when the `max_retry_duration` time has passed, no further attempts are made, and the task is deleted. If `max_attempts` is set to -1 and `max_retry_duration` is set to 0, the task is retried until the [maximum task retention](https://docs.cloud.google.com/tasks/docs/quotas#limits) limit is reached. If unspecified when the queue is created, Cloud Tasks will pick the default. This field has the same meaning as [task_retry_limit in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). + "maxBackoff": "A String", # A task will be scheduled for retry between min_backoff and max_backoff duration after it fails, if the queue's RetryConfig specifies that the task should be retried. The value must be given as a string that indicates the length of time (in seconds) followed by `s` (for "seconds"). For more information on the format, see the documentation for [Duration](https://protobuf.dev/reference/protobuf/google.protobuf/#duration). `max_backoff` will be truncated to the nearest second. If unspecified when the queue is created, Cloud Tasks will pick the default. This field has the same meaning as [max_backoff_seconds in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). "maxDoublings": 42, # The time between retries will double `max_doublings` times. A task's retry interval starts at min_backoff, then doubles `max_doublings` times, then increases linearly, and finally retries at intervals of max_backoff up to max_attempts times. For example, if min_backoff is 10s, max_backoff is 300s, and `max_doublings` is 3, then the a task will first be retried in 10s. The retry interval will double three times, and then increase linearly by 2^3 * 10s. Finally, the task will retry at intervals of max_backoff until the task has been attempted max_attempts times. Thus, the requests will retry at 10s, 20s, 40s, 80s, 160s, 240s, 300s, 300s, .... If unspecified when the queue is created, Cloud Tasks will pick the default. This field has the same meaning as [max_doublings in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). - "maxRetryDuration": "A String", # If positive, `max_retry_duration` specifies the time limit for retrying a failed task, measured from when the task was first attempted. Once `max_retry_duration` time has passed *and* the task has been attempted max_attempts times, no further attempts will be made and the task will be deleted. If zero, then the task age is unlimited. If unspecified when the queue is created, Cloud Tasks will pick the default. The value must be given as a string that indicates the length of time (in seconds) followed by `s` (for "seconds"). For the maximum possible value or the format, see the documentation for [Duration](https://protobuf.dev/reference/protobuf/google.protobuf/#duration). `max_retry_duration` will be truncated to the nearest second. This field has the same meaning as [task_age_limit in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). - "minBackoff": "A String", # A task will be scheduled for retry between min_backoff and max_backoff duration after it fails, if the queue's RetryConfig specifies that the task should be retried. If unspecified when the queue is created, Cloud Tasks will pick the default. The value must be given as a string that indicates the length of time (in seconds) followed by `s` (for "seconds"). For more information on the format, see the documentation for [Duration](https://protobuf.dev/reference/protobuf/google.protobuf/#duration). `min_backoff` will be truncated to the nearest second. This field has the same meaning as [min_backoff_seconds in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). + "maxRetryDuration": "A String", # If positive, `max_retry_duration` specifies the time limit for retrying a failed task, measured from when the task was first attempted. Once `max_retry_duration` time has passed *and* the task has been attempted max_attempts times, no further attempts are made and the task is deleted. A zero (0) indicates an unlimited duration, up to the [maximum task retention](https://docs.cloud.google.com/tasks/docs/quotas#limits) limit. The value must be given as a string that indicates the length of time (in seconds) followed by `s` (for "seconds"). For the maximum possible value or the format, see the documentation for [Duration](https://protobuf.dev/reference/protobuf/google.protobuf/#duration). `max_retry_duration` will be truncated to the nearest second. If unspecified when the queue is created, Cloud Tasks will pick the default. This field has the same meaning as [task_age_limit in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). + "minBackoff": "A String", # A task will be scheduled for retry between min_backoff and max_backoff duration after it fails, if the queue's RetryConfig specifies that the task should be retried. The value must be given as a string that indicates the length of time (in seconds) followed by `s` (for "seconds"). For more information on the format, see the documentation for [Duration](https://protobuf.dev/reference/protobuf/google.protobuf/#duration). `min_backoff` will be truncated to the nearest second. If unspecified when the queue is created, Cloud Tasks will pick the default. This field has the same meaning as [min_backoff_seconds in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). }, "stackdriverLoggingConfig": { # Configuration options for writing logs to [Stackdriver Logging](https://cloud.google.com/logging/docs/). # Configuration options for writing logs to [Stackdriver Logging](https://cloud.google.com/logging/docs/). If this field is unset, then no logs are written. "samplingRatio": 3.14, # Specifies the fraction of operations to write to [Stackdriver Logging](https://cloud.google.com/logging/docs/). This field may contain any value between 0.0 and 1.0, inclusive. 0.0 is the default and means that no operations are logged. @@ -843,14 +843,14 @@

Method Details

"rateLimits": { # Rate limits. This message determines the maximum rate that tasks can be dispatched by a queue, regardless of whether the dispatch is a first task attempt or a retry. Note: The debugging command, RunTask, will run a task even if the queue has reached its RateLimits. # Rate limits for task dispatches. rate_limits and retry_config are related because they both control task attempts. However they control task attempts in different ways: * rate_limits controls the total rate of dispatches from a queue (i.e. all traffic dispatched from the queue, regardless of whether the dispatch is from a first attempt or a retry). * retry_config controls what happens to particular a task after its first attempt fails. That is, retry_config controls task retries (the second attempt, third attempt, etc). The queue's actual dispatch rate is the result of: * Number of tasks in the queue * User-specified throttling: rate_limits, retry_config, and the queue's state. * System throttling due to `429` (Too Many Requests) or `503` (Service Unavailable) responses from the worker, high error rates, or to smooth sudden large traffic spikes. "maxBurstSize": 42, # Output only. The max burst size. Max burst size limits how fast tasks in queue are processed when many tasks are in the queue and the rate is high. This field allows the queue to have a high rate so processing starts shortly after a task is enqueued, but still limits resource usage when many tasks are enqueued in a short period of time. The [token bucket](https://wikipedia.org/wiki/Token_Bucket) algorithm is used to control the rate of task dispatches. Each queue has a token bucket that holds tokens, up to the maximum specified by `max_burst_size`. Each time a task is dispatched, a token is removed from the bucket. Tasks will be dispatched until the queue's bucket runs out of tokens. The bucket will be continuously refilled with new tokens based on `max_dispatches_per_second`. Cloud Tasks automatically sets an appropriate `max_burst_size` based on the value of `max_dispatches_per_second`. The value is dynamically optimized to ensure queue stability and throughput. It is generally at least equal to `max_dispatches_per_second` but might be higher to accommodate bursts of traffic. For queues that were created or updated using `queue.yaml/xml`, `max_burst_size` is equal to [bucket_size](https://cloud.google.com/appengine/docs/standard/python/config/queueref#bucket_size). Since `max_burst_size` is output only, if UpdateQueue is called on a queue created by `queue.yaml/xml`, `max_burst_size` will be reset based on the value of `max_dispatches_per_second`, regardless of whether `max_dispatches_per_second` is updated. "maxConcurrentDispatches": 42, # The maximum number of concurrent tasks that Cloud Tasks allows to be dispatched for this queue. After this threshold has been reached, Cloud Tasks stops dispatching tasks until the number of concurrent requests decreases. If unspecified when the queue is created, Cloud Tasks will pick the default. The maximum allowed value is 5,000. This field has the same meaning as [max_concurrent_requests in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#max_concurrent_requests). - "maxDispatchesPerSecond": 3.14, # The maximum rate at which tasks are dispatched from this queue. If unspecified when the queue is created, Cloud Tasks will pick the default. * The maximum allowed value is 500. This field has the same meaning as [rate in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#rate). + "maxDispatchesPerSecond": 3.14, # The maximum rate at which tasks are dispatched from this queue. If unspecified when the queue is created, Cloud Tasks will pick the default. The maximum allowed value is 500. This field has the same meaning as [rate in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#rate). }, "retryConfig": { # Retry config. These settings determine when a failed task attempt is retried. # Settings that determine the retry behavior. * For tasks created using Cloud Tasks: the queue-level retry settings apply to all tasks in the queue that were created using Cloud Tasks. Retry settings cannot be set on individual tasks. * For tasks created using the App Engine SDK: the queue-level retry settings apply to all tasks in the queue which do not have retry settings explicitly set on the task and were created by the App Engine SDK. See [App Engine documentation](https://cloud.google.com/appengine/docs/standard/python/taskqueue/push/retrying-tasks). - "maxAttempts": 42, # Number of attempts per task. Cloud Tasks will attempt the task `max_attempts` times (that is, if the first attempt fails, then there will be `max_attempts - 1` retries). Must be >= -1. If unspecified when the queue is created, Cloud Tasks will pick the default. -1 indicates unlimited attempts. This field has the same meaning as [task_retry_limit in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). Note: Cloud Tasks stops retrying only when `max_attempts` and `max_retry_duration` are both satisfied. When the task has been attempted `max_attempts` times and when the `max_retry_duration` time has passed, no further attempts are made, and the task is deleted. If you want your task to retry infinitely, you must set `max_attempts` to -1 and `max_retry_duration` to 0. - "maxBackoff": "A String", # A task will be scheduled for retry between min_backoff and max_backoff duration after it fails, if the queue's RetryConfig specifies that the task should be retried. If unspecified when the queue is created, Cloud Tasks will pick the default. The value must be given as a string that indicates the length of time (in seconds) followed by `s` (for "seconds"). For more information on the format, see the documentation for [Duration](https://protobuf.dev/reference/protobuf/google.protobuf/#duration). `max_backoff` will be truncated to the nearest second. This field has the same meaning as [max_backoff_seconds in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). + "maxAttempts": 42, # Number of attempts per task, including the first attempt. (If the first attempt fails, there will be `max_attempts - 1` retries.) Must be greater than or equal to -1, which indicates unlimited attempts. Cloud Tasks stops retrying only when `max_attempts` and `max_retry_duration` are both satisfied, or when the task is successfully executed. When the task has been attempted `max_attempts` times and when the `max_retry_duration` time has passed, no further attempts are made, and the task is deleted. If `max_attempts` is set to -1 and `max_retry_duration` is set to 0, the task is retried until the [maximum task retention](https://docs.cloud.google.com/tasks/docs/quotas#limits) limit is reached. If unspecified when the queue is created, Cloud Tasks will pick the default. This field has the same meaning as [task_retry_limit in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). + "maxBackoff": "A String", # A task will be scheduled for retry between min_backoff and max_backoff duration after it fails, if the queue's RetryConfig specifies that the task should be retried. The value must be given as a string that indicates the length of time (in seconds) followed by `s` (for "seconds"). For more information on the format, see the documentation for [Duration](https://protobuf.dev/reference/protobuf/google.protobuf/#duration). `max_backoff` will be truncated to the nearest second. If unspecified when the queue is created, Cloud Tasks will pick the default. This field has the same meaning as [max_backoff_seconds in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). "maxDoublings": 42, # The time between retries will double `max_doublings` times. A task's retry interval starts at min_backoff, then doubles `max_doublings` times, then increases linearly, and finally retries at intervals of max_backoff up to max_attempts times. For example, if min_backoff is 10s, max_backoff is 300s, and `max_doublings` is 3, then the a task will first be retried in 10s. The retry interval will double three times, and then increase linearly by 2^3 * 10s. Finally, the task will retry at intervals of max_backoff until the task has been attempted max_attempts times. Thus, the requests will retry at 10s, 20s, 40s, 80s, 160s, 240s, 300s, 300s, .... If unspecified when the queue is created, Cloud Tasks will pick the default. This field has the same meaning as [max_doublings in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). - "maxRetryDuration": "A String", # If positive, `max_retry_duration` specifies the time limit for retrying a failed task, measured from when the task was first attempted. Once `max_retry_duration` time has passed *and* the task has been attempted max_attempts times, no further attempts will be made and the task will be deleted. If zero, then the task age is unlimited. If unspecified when the queue is created, Cloud Tasks will pick the default. The value must be given as a string that indicates the length of time (in seconds) followed by `s` (for "seconds"). For the maximum possible value or the format, see the documentation for [Duration](https://protobuf.dev/reference/protobuf/google.protobuf/#duration). `max_retry_duration` will be truncated to the nearest second. This field has the same meaning as [task_age_limit in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). - "minBackoff": "A String", # A task will be scheduled for retry between min_backoff and max_backoff duration after it fails, if the queue's RetryConfig specifies that the task should be retried. If unspecified when the queue is created, Cloud Tasks will pick the default. The value must be given as a string that indicates the length of time (in seconds) followed by `s` (for "seconds"). For more information on the format, see the documentation for [Duration](https://protobuf.dev/reference/protobuf/google.protobuf/#duration). `min_backoff` will be truncated to the nearest second. This field has the same meaning as [min_backoff_seconds in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). + "maxRetryDuration": "A String", # If positive, `max_retry_duration` specifies the time limit for retrying a failed task, measured from when the task was first attempted. Once `max_retry_duration` time has passed *and* the task has been attempted max_attempts times, no further attempts are made and the task is deleted. A zero (0) indicates an unlimited duration, up to the [maximum task retention](https://docs.cloud.google.com/tasks/docs/quotas#limits) limit. The value must be given as a string that indicates the length of time (in seconds) followed by `s` (for "seconds"). For the maximum possible value or the format, see the documentation for [Duration](https://protobuf.dev/reference/protobuf/google.protobuf/#duration). `max_retry_duration` will be truncated to the nearest second. If unspecified when the queue is created, Cloud Tasks will pick the default. This field has the same meaning as [task_age_limit in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). + "minBackoff": "A String", # A task will be scheduled for retry between min_backoff and max_backoff duration after it fails, if the queue's RetryConfig specifies that the task should be retried. The value must be given as a string that indicates the length of time (in seconds) followed by `s` (for "seconds"). For more information on the format, see the documentation for [Duration](https://protobuf.dev/reference/protobuf/google.protobuf/#duration). `min_backoff` will be truncated to the nearest second. If unspecified when the queue is created, Cloud Tasks will pick the default. This field has the same meaning as [min_backoff_seconds in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). }, "stackdriverLoggingConfig": { # Configuration options for writing logs to [Stackdriver Logging](https://cloud.google.com/logging/docs/). # Configuration options for writing logs to [Stackdriver Logging](https://cloud.google.com/logging/docs/). If this field is unset, then no logs are written. "samplingRatio": 3.14, # Specifies the fraction of operations to write to [Stackdriver Logging](https://cloud.google.com/logging/docs/). This field may contain any value between 0.0 and 1.0, inclusive. 0.0 is the default and means that no operations are logged. diff --git a/docs/dyn/cloudtasks_v2beta3.projects.locations.queues.html b/docs/dyn/cloudtasks_v2beta3.projects.locations.queues.html index e77281eca8..2469fb39c2 100644 --- a/docs/dyn/cloudtasks_v2beta3.projects.locations.queues.html +++ b/docs/dyn/cloudtasks_v2beta3.projects.locations.queues.html @@ -178,14 +178,14 @@

Method Details

"rateLimits": { # Rate limits. This message determines the maximum rate that tasks can be dispatched by a queue, regardless of whether the dispatch is a first task attempt or a retry. Note: The debugging command, RunTask, will run a task even if the queue has reached its RateLimits. # Rate limits for task dispatches. rate_limits and retry_config are related because they both control task attempts. However they control task attempts in different ways: * rate_limits controls the total rate of dispatches from a queue (i.e. all traffic dispatched from the queue, regardless of whether the dispatch is from a first attempt or a retry). * retry_config controls what happens to particular a task after its first attempt fails. That is, retry_config controls task retries (the second attempt, third attempt, etc). The queue's actual dispatch rate is the result of: * Number of tasks in the queue * User-specified throttling: rate_limits, retry_config, and the queue's state. * System throttling due to `429` (Too Many Requests) or `503` (Service Unavailable) responses from the worker, high error rates, or to smooth sudden large traffic spikes. "maxBurstSize": 42, # The max burst size. Max burst size limits how fast tasks in queue are processed when many tasks are in the queue and the rate is high. This field allows the queue to have a high rate so processing starts shortly after a task is enqueued, but still limits resource usage when many tasks are enqueued in a short period of time. The [token bucket](https://wikipedia.org/wiki/Token_Bucket) algorithm is used to control the rate of task dispatches. Each queue has a token bucket that holds tokens, up to the maximum specified by `max_burst_size`. Each time a task is dispatched, a token is removed from the bucket. Tasks will be dispatched until the queue's bucket runs out of tokens. The bucket will be continuously refilled with new tokens based on max_dispatches_per_second. The default value of `max_burst_size` is picked by Cloud Tasks based on the value of max_dispatches_per_second. The maximum value of `max_burst_size` is 500. For App Engine queues that were created or updated using `queue.yaml/xml`, `max_burst_size` is equal to [bucket_size](https://cloud.google.com/appengine/docs/standard/python/config/queueref#bucket_size). If UpdateQueue is called on a queue without explicitly setting a value for `max_burst_size`, `max_burst_size` value will get updated if UpdateQueue is updating max_dispatches_per_second. "maxConcurrentDispatches": 42, # The maximum number of concurrent tasks that Cloud Tasks allows to be dispatched for this queue. After this threshold has been reached, Cloud Tasks stops dispatching tasks until the number of concurrent requests decreases. If unspecified when the queue is created, Cloud Tasks will pick the default. The maximum allowed value is 5,000. This field has the same meaning as [max_concurrent_requests in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#max_concurrent_requests). - "maxDispatchesPerSecond": 3.14, # The maximum rate at which tasks are dispatched from this queue. If unspecified when the queue is created, Cloud Tasks will pick the default. * For App Engine queues, the maximum allowed value is 500. This field has the same meaning as [rate in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#rate). + "maxDispatchesPerSecond": 3.14, # The maximum rate at which tasks are dispatched from this queue. If unspecified when the queue is created, Cloud Tasks will pick the default. For App Engine queues, the maximum allowed value is 500. This field has the same meaning as [rate in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#rate). }, "retryConfig": { # Retry config. These settings determine when a failed task attempt is retried. # Settings that determine the retry behavior. * For tasks created using Cloud Tasks: the queue-level retry settings apply to all tasks in the queue that were created using Cloud Tasks. Retry settings cannot be set on individual tasks. * For tasks created using the App Engine SDK: the queue-level retry settings apply to all tasks in the queue which do not have retry settings explicitly set on the task and were created by the App Engine SDK. See [App Engine documentation](https://cloud.google.com/appengine/docs/standard/python/taskqueue/push/retrying-tasks). - "maxAttempts": 42, # Number of attempts per task. Cloud Tasks will attempt the task `max_attempts` times (that is, if the first attempt fails, then there will be `max_attempts - 1` retries). Must be >= -1. If unspecified when the queue is created, Cloud Tasks will pick the default. -1 indicates unlimited attempts. This field has the same meaning as [task_retry_limit in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). Note: Cloud Tasks stops retrying only when `max_attempts` and `max_retry_duration` are both satisfied. When the task has been attempted `max_attempts` times and when the `max_retry_duration` time has passed, no further attempts are made, and the task is deleted. If you want your task to retry infinitely, you must set `max_attempts` to -1 and `max_retry_duration` to 0. - "maxBackoff": "A String", # A task will be scheduled for retry between min_backoff and max_backoff duration after it fails, if the queue's RetryConfig specifies that the task should be retried. If unspecified when the queue is created, Cloud Tasks will pick the default. The value must be given as a string that indicates the length of time (in seconds) followed by `s` (for "seconds"). For more information on the format, see the documentation for [Duration](https://protobuf.dev/reference/protobuf/google.protobuf/#duration). `max_backoff` will be truncated to the nearest second. This field has the same meaning as [max_backoff_seconds in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). + "maxAttempts": 42, # Number of attempts per task, including the first attempt. (If the first attempt fails, there will be `max_attempts - 1` retries.) Must be greater than or equal to -1, which indicates unlimited attempts. Cloud Tasks stops retrying only when `max_attempts` and `max_retry_duration` are both satisfied, or when the task is successfully executed. When the task has been attempted `max_attempts` times and when the `max_retry_duration` time has passed, no further attempts are made, and the task is deleted. If `max_attempts` is set to -1 and `max_retry_duration` is set to 0, the task is retried until the [maximum task retention](https://docs.cloud.google.com/tasks/docs/quotas#limits) limit is reached. If unspecified when the queue is created, Cloud Tasks will pick the default. This field has the same meaning as [task_retry_limit in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). + "maxBackoff": "A String", # A task will be scheduled for retry between min_backoff and max_backoff duration after it fails, if the queue's RetryConfig specifies that the task should be retried. The value must be given as a string that indicates the length of time (in seconds) followed by `s` (for "seconds"). For more information on the format, see the documentation for [Duration](https://protobuf.dev/reference/protobuf/google.protobuf/#duration). `max_backoff` will be truncated to the nearest second. If unspecified when the queue is created, Cloud Tasks will pick the default. This field has the same meaning as [max_backoff_seconds in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). "maxDoublings": 42, # The time between retries will double `max_doublings` times. A task's retry interval starts at min_backoff, then doubles `max_doublings` times, then increases linearly, and finally retries at intervals of max_backoff up to max_attempts times. For example, if min_backoff is 10s, max_backoff is 300s, and `max_doublings` is 3, then the a task will first be retried in 10s. The retry interval will double three times, and then increase linearly by 2^3 * 10s. Finally, the task will retry at intervals of max_backoff until the task has been attempted max_attempts times. Thus, the requests will retry at 10s, 20s, 40s, 80s, 160s, 240s, 300s, 300s, .... If unspecified when the queue is created, Cloud Tasks will pick the default. This field has the same meaning as [max_doublings in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). - "maxRetryDuration": "A String", # If positive, `max_retry_duration` specifies the time limit for retrying a failed task, measured from when the task was first attempted. Once `max_retry_duration` time has passed *and* the task has been attempted max_attempts times, no further attempts will be made and the task will be deleted. If zero, then the task age is unlimited. If unspecified when the queue is created, Cloud Tasks will pick the default. The value must be given as a string that indicates the length of time (in seconds) followed by `s` (for "seconds"). For the maximum possible value or the format, see the documentation for [Duration](https://protobuf.dev/reference/protobuf/google.protobuf/#duration). `max_retry_duration` will be truncated to the nearest second. This field has the same meaning as [task_age_limit in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). - "minBackoff": "A String", # A task will be scheduled for retry between min_backoff and max_backoff duration after it fails, if the queue's RetryConfig specifies that the task should be retried. If unspecified when the queue is created, Cloud Tasks will pick the default. The value must be given as a string that indicates the length of time (in seconds) followed by `s` (for "seconds"). For more information on the format, see the documentation for [Duration](https://protobuf.dev/reference/protobuf/google.protobuf/#duration). `min_backoff` will be truncated to the nearest second. This field has the same meaning as [min_backoff_seconds in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). + "maxRetryDuration": "A String", # If positive, `max_retry_duration` specifies the time limit for retrying a failed task, measured from when the task was first attempted. Once `max_retry_duration` time has passed *and* the task has been attempted max_attempts times, no further attempts are made and the task is deleted. A zero (0) indicates an unlimited duration, up to the [maximum task retention](https://docs.cloud.google.com/tasks/docs/quotas#limits) limit. The value must be given as a string that indicates the length of time (in seconds) followed by `s` (for "seconds"). For the maximum possible value or the format, see the documentation for [Duration](https://protobuf.dev/reference/protobuf/google.protobuf/#duration). `max_retry_duration` will be truncated to the nearest second. If unspecified when the queue is created, Cloud Tasks will pick the default. This field has the same meaning as [task_age_limit in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). + "minBackoff": "A String", # A task will be scheduled for retry between min_backoff and max_backoff duration after it fails, if the queue's RetryConfig specifies that the task should be retried. The value must be given as a string that indicates the length of time (in seconds) followed by `s` (for "seconds"). For more information on the format, see the documentation for [Duration](https://protobuf.dev/reference/protobuf/google.protobuf/#duration). `min_backoff` will be truncated to the nearest second. If unspecified when the queue is created, Cloud Tasks will pick the default. This field has the same meaning as [min_backoff_seconds in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). }, "stackdriverLoggingConfig": { # Configuration options for writing logs to [Stackdriver Logging](https://cloud.google.com/logging/docs/). # Configuration options for writing logs to [Stackdriver Logging](https://cloud.google.com/logging/docs/). If this field is unset, then no logs are written. "samplingRatio": 3.14, # Specifies the fraction of operations to write to [Stackdriver Logging](https://cloud.google.com/logging/docs/). This field may contain any value between 0.0 and 1.0, inclusive. 0.0 is the default and means that no operations are logged. @@ -256,14 +256,14 @@

Method Details

"rateLimits": { # Rate limits. This message determines the maximum rate that tasks can be dispatched by a queue, regardless of whether the dispatch is a first task attempt or a retry. Note: The debugging command, RunTask, will run a task even if the queue has reached its RateLimits. # Rate limits for task dispatches. rate_limits and retry_config are related because they both control task attempts. However they control task attempts in different ways: * rate_limits controls the total rate of dispatches from a queue (i.e. all traffic dispatched from the queue, regardless of whether the dispatch is from a first attempt or a retry). * retry_config controls what happens to particular a task after its first attempt fails. That is, retry_config controls task retries (the second attempt, third attempt, etc). The queue's actual dispatch rate is the result of: * Number of tasks in the queue * User-specified throttling: rate_limits, retry_config, and the queue's state. * System throttling due to `429` (Too Many Requests) or `503` (Service Unavailable) responses from the worker, high error rates, or to smooth sudden large traffic spikes. "maxBurstSize": 42, # The max burst size. Max burst size limits how fast tasks in queue are processed when many tasks are in the queue and the rate is high. This field allows the queue to have a high rate so processing starts shortly after a task is enqueued, but still limits resource usage when many tasks are enqueued in a short period of time. The [token bucket](https://wikipedia.org/wiki/Token_Bucket) algorithm is used to control the rate of task dispatches. Each queue has a token bucket that holds tokens, up to the maximum specified by `max_burst_size`. Each time a task is dispatched, a token is removed from the bucket. Tasks will be dispatched until the queue's bucket runs out of tokens. The bucket will be continuously refilled with new tokens based on max_dispatches_per_second. The default value of `max_burst_size` is picked by Cloud Tasks based on the value of max_dispatches_per_second. The maximum value of `max_burst_size` is 500. For App Engine queues that were created or updated using `queue.yaml/xml`, `max_burst_size` is equal to [bucket_size](https://cloud.google.com/appengine/docs/standard/python/config/queueref#bucket_size). If UpdateQueue is called on a queue without explicitly setting a value for `max_burst_size`, `max_burst_size` value will get updated if UpdateQueue is updating max_dispatches_per_second. "maxConcurrentDispatches": 42, # The maximum number of concurrent tasks that Cloud Tasks allows to be dispatched for this queue. After this threshold has been reached, Cloud Tasks stops dispatching tasks until the number of concurrent requests decreases. If unspecified when the queue is created, Cloud Tasks will pick the default. The maximum allowed value is 5,000. This field has the same meaning as [max_concurrent_requests in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#max_concurrent_requests). - "maxDispatchesPerSecond": 3.14, # The maximum rate at which tasks are dispatched from this queue. If unspecified when the queue is created, Cloud Tasks will pick the default. * For App Engine queues, the maximum allowed value is 500. This field has the same meaning as [rate in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#rate). + "maxDispatchesPerSecond": 3.14, # The maximum rate at which tasks are dispatched from this queue. If unspecified when the queue is created, Cloud Tasks will pick the default. For App Engine queues, the maximum allowed value is 500. This field has the same meaning as [rate in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#rate). }, "retryConfig": { # Retry config. These settings determine when a failed task attempt is retried. # Settings that determine the retry behavior. * For tasks created using Cloud Tasks: the queue-level retry settings apply to all tasks in the queue that were created using Cloud Tasks. Retry settings cannot be set on individual tasks. * For tasks created using the App Engine SDK: the queue-level retry settings apply to all tasks in the queue which do not have retry settings explicitly set on the task and were created by the App Engine SDK. See [App Engine documentation](https://cloud.google.com/appengine/docs/standard/python/taskqueue/push/retrying-tasks). - "maxAttempts": 42, # Number of attempts per task. Cloud Tasks will attempt the task `max_attempts` times (that is, if the first attempt fails, then there will be `max_attempts - 1` retries). Must be >= -1. If unspecified when the queue is created, Cloud Tasks will pick the default. -1 indicates unlimited attempts. This field has the same meaning as [task_retry_limit in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). Note: Cloud Tasks stops retrying only when `max_attempts` and `max_retry_duration` are both satisfied. When the task has been attempted `max_attempts` times and when the `max_retry_duration` time has passed, no further attempts are made, and the task is deleted. If you want your task to retry infinitely, you must set `max_attempts` to -1 and `max_retry_duration` to 0. - "maxBackoff": "A String", # A task will be scheduled for retry between min_backoff and max_backoff duration after it fails, if the queue's RetryConfig specifies that the task should be retried. If unspecified when the queue is created, Cloud Tasks will pick the default. The value must be given as a string that indicates the length of time (in seconds) followed by `s` (for "seconds"). For more information on the format, see the documentation for [Duration](https://protobuf.dev/reference/protobuf/google.protobuf/#duration). `max_backoff` will be truncated to the nearest second. This field has the same meaning as [max_backoff_seconds in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). + "maxAttempts": 42, # Number of attempts per task, including the first attempt. (If the first attempt fails, there will be `max_attempts - 1` retries.) Must be greater than or equal to -1, which indicates unlimited attempts. Cloud Tasks stops retrying only when `max_attempts` and `max_retry_duration` are both satisfied, or when the task is successfully executed. When the task has been attempted `max_attempts` times and when the `max_retry_duration` time has passed, no further attempts are made, and the task is deleted. If `max_attempts` is set to -1 and `max_retry_duration` is set to 0, the task is retried until the [maximum task retention](https://docs.cloud.google.com/tasks/docs/quotas#limits) limit is reached. If unspecified when the queue is created, Cloud Tasks will pick the default. This field has the same meaning as [task_retry_limit in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). + "maxBackoff": "A String", # A task will be scheduled for retry between min_backoff and max_backoff duration after it fails, if the queue's RetryConfig specifies that the task should be retried. The value must be given as a string that indicates the length of time (in seconds) followed by `s` (for "seconds"). For more information on the format, see the documentation for [Duration](https://protobuf.dev/reference/protobuf/google.protobuf/#duration). `max_backoff` will be truncated to the nearest second. If unspecified when the queue is created, Cloud Tasks will pick the default. This field has the same meaning as [max_backoff_seconds in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). "maxDoublings": 42, # The time between retries will double `max_doublings` times. A task's retry interval starts at min_backoff, then doubles `max_doublings` times, then increases linearly, and finally retries at intervals of max_backoff up to max_attempts times. For example, if min_backoff is 10s, max_backoff is 300s, and `max_doublings` is 3, then the a task will first be retried in 10s. The retry interval will double three times, and then increase linearly by 2^3 * 10s. Finally, the task will retry at intervals of max_backoff until the task has been attempted max_attempts times. Thus, the requests will retry at 10s, 20s, 40s, 80s, 160s, 240s, 300s, 300s, .... If unspecified when the queue is created, Cloud Tasks will pick the default. This field has the same meaning as [max_doublings in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). - "maxRetryDuration": "A String", # If positive, `max_retry_duration` specifies the time limit for retrying a failed task, measured from when the task was first attempted. Once `max_retry_duration` time has passed *and* the task has been attempted max_attempts times, no further attempts will be made and the task will be deleted. If zero, then the task age is unlimited. If unspecified when the queue is created, Cloud Tasks will pick the default. The value must be given as a string that indicates the length of time (in seconds) followed by `s` (for "seconds"). For the maximum possible value or the format, see the documentation for [Duration](https://protobuf.dev/reference/protobuf/google.protobuf/#duration). `max_retry_duration` will be truncated to the nearest second. This field has the same meaning as [task_age_limit in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). - "minBackoff": "A String", # A task will be scheduled for retry between min_backoff and max_backoff duration after it fails, if the queue's RetryConfig specifies that the task should be retried. If unspecified when the queue is created, Cloud Tasks will pick the default. The value must be given as a string that indicates the length of time (in seconds) followed by `s` (for "seconds"). For more information on the format, see the documentation for [Duration](https://protobuf.dev/reference/protobuf/google.protobuf/#duration). `min_backoff` will be truncated to the nearest second. This field has the same meaning as [min_backoff_seconds in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). + "maxRetryDuration": "A String", # If positive, `max_retry_duration` specifies the time limit for retrying a failed task, measured from when the task was first attempted. Once `max_retry_duration` time has passed *and* the task has been attempted max_attempts times, no further attempts are made and the task is deleted. A zero (0) indicates an unlimited duration, up to the [maximum task retention](https://docs.cloud.google.com/tasks/docs/quotas#limits) limit. The value must be given as a string that indicates the length of time (in seconds) followed by `s` (for "seconds"). For the maximum possible value or the format, see the documentation for [Duration](https://protobuf.dev/reference/protobuf/google.protobuf/#duration). `max_retry_duration` will be truncated to the nearest second. If unspecified when the queue is created, Cloud Tasks will pick the default. This field has the same meaning as [task_age_limit in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). + "minBackoff": "A String", # A task will be scheduled for retry between min_backoff and max_backoff duration after it fails, if the queue's RetryConfig specifies that the task should be retried. The value must be given as a string that indicates the length of time (in seconds) followed by `s` (for "seconds"). For more information on the format, see the documentation for [Duration](https://protobuf.dev/reference/protobuf/google.protobuf/#duration). `min_backoff` will be truncated to the nearest second. If unspecified when the queue is created, Cloud Tasks will pick the default. This field has the same meaning as [min_backoff_seconds in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). }, "stackdriverLoggingConfig": { # Configuration options for writing logs to [Stackdriver Logging](https://cloud.google.com/logging/docs/). # Configuration options for writing logs to [Stackdriver Logging](https://cloud.google.com/logging/docs/). If this field is unset, then no logs are written. "samplingRatio": 3.14, # Specifies the fraction of operations to write to [Stackdriver Logging](https://cloud.google.com/logging/docs/). This field may contain any value between 0.0 and 1.0, inclusive. 0.0 is the default and means that no operations are logged. @@ -360,14 +360,14 @@

Method Details

"rateLimits": { # Rate limits. This message determines the maximum rate that tasks can be dispatched by a queue, regardless of whether the dispatch is a first task attempt or a retry. Note: The debugging command, RunTask, will run a task even if the queue has reached its RateLimits. # Rate limits for task dispatches. rate_limits and retry_config are related because they both control task attempts. However they control task attempts in different ways: * rate_limits controls the total rate of dispatches from a queue (i.e. all traffic dispatched from the queue, regardless of whether the dispatch is from a first attempt or a retry). * retry_config controls what happens to particular a task after its first attempt fails. That is, retry_config controls task retries (the second attempt, third attempt, etc). The queue's actual dispatch rate is the result of: * Number of tasks in the queue * User-specified throttling: rate_limits, retry_config, and the queue's state. * System throttling due to `429` (Too Many Requests) or `503` (Service Unavailable) responses from the worker, high error rates, or to smooth sudden large traffic spikes. "maxBurstSize": 42, # The max burst size. Max burst size limits how fast tasks in queue are processed when many tasks are in the queue and the rate is high. This field allows the queue to have a high rate so processing starts shortly after a task is enqueued, but still limits resource usage when many tasks are enqueued in a short period of time. The [token bucket](https://wikipedia.org/wiki/Token_Bucket) algorithm is used to control the rate of task dispatches. Each queue has a token bucket that holds tokens, up to the maximum specified by `max_burst_size`. Each time a task is dispatched, a token is removed from the bucket. Tasks will be dispatched until the queue's bucket runs out of tokens. The bucket will be continuously refilled with new tokens based on max_dispatches_per_second. The default value of `max_burst_size` is picked by Cloud Tasks based on the value of max_dispatches_per_second. The maximum value of `max_burst_size` is 500. For App Engine queues that were created or updated using `queue.yaml/xml`, `max_burst_size` is equal to [bucket_size](https://cloud.google.com/appengine/docs/standard/python/config/queueref#bucket_size). If UpdateQueue is called on a queue without explicitly setting a value for `max_burst_size`, `max_burst_size` value will get updated if UpdateQueue is updating max_dispatches_per_second. "maxConcurrentDispatches": 42, # The maximum number of concurrent tasks that Cloud Tasks allows to be dispatched for this queue. After this threshold has been reached, Cloud Tasks stops dispatching tasks until the number of concurrent requests decreases. If unspecified when the queue is created, Cloud Tasks will pick the default. The maximum allowed value is 5,000. This field has the same meaning as [max_concurrent_requests in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#max_concurrent_requests). - "maxDispatchesPerSecond": 3.14, # The maximum rate at which tasks are dispatched from this queue. If unspecified when the queue is created, Cloud Tasks will pick the default. * For App Engine queues, the maximum allowed value is 500. This field has the same meaning as [rate in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#rate). + "maxDispatchesPerSecond": 3.14, # The maximum rate at which tasks are dispatched from this queue. If unspecified when the queue is created, Cloud Tasks will pick the default. For App Engine queues, the maximum allowed value is 500. This field has the same meaning as [rate in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#rate). }, "retryConfig": { # Retry config. These settings determine when a failed task attempt is retried. # Settings that determine the retry behavior. * For tasks created using Cloud Tasks: the queue-level retry settings apply to all tasks in the queue that were created using Cloud Tasks. Retry settings cannot be set on individual tasks. * For tasks created using the App Engine SDK: the queue-level retry settings apply to all tasks in the queue which do not have retry settings explicitly set on the task and were created by the App Engine SDK. See [App Engine documentation](https://cloud.google.com/appengine/docs/standard/python/taskqueue/push/retrying-tasks). - "maxAttempts": 42, # Number of attempts per task. Cloud Tasks will attempt the task `max_attempts` times (that is, if the first attempt fails, then there will be `max_attempts - 1` retries). Must be >= -1. If unspecified when the queue is created, Cloud Tasks will pick the default. -1 indicates unlimited attempts. This field has the same meaning as [task_retry_limit in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). Note: Cloud Tasks stops retrying only when `max_attempts` and `max_retry_duration` are both satisfied. When the task has been attempted `max_attempts` times and when the `max_retry_duration` time has passed, no further attempts are made, and the task is deleted. If you want your task to retry infinitely, you must set `max_attempts` to -1 and `max_retry_duration` to 0. - "maxBackoff": "A String", # A task will be scheduled for retry between min_backoff and max_backoff duration after it fails, if the queue's RetryConfig specifies that the task should be retried. If unspecified when the queue is created, Cloud Tasks will pick the default. The value must be given as a string that indicates the length of time (in seconds) followed by `s` (for "seconds"). For more information on the format, see the documentation for [Duration](https://protobuf.dev/reference/protobuf/google.protobuf/#duration). `max_backoff` will be truncated to the nearest second. This field has the same meaning as [max_backoff_seconds in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). + "maxAttempts": 42, # Number of attempts per task, including the first attempt. (If the first attempt fails, there will be `max_attempts - 1` retries.) Must be greater than or equal to -1, which indicates unlimited attempts. Cloud Tasks stops retrying only when `max_attempts` and `max_retry_duration` are both satisfied, or when the task is successfully executed. When the task has been attempted `max_attempts` times and when the `max_retry_duration` time has passed, no further attempts are made, and the task is deleted. If `max_attempts` is set to -1 and `max_retry_duration` is set to 0, the task is retried until the [maximum task retention](https://docs.cloud.google.com/tasks/docs/quotas#limits) limit is reached. If unspecified when the queue is created, Cloud Tasks will pick the default. This field has the same meaning as [task_retry_limit in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). + "maxBackoff": "A String", # A task will be scheduled for retry between min_backoff and max_backoff duration after it fails, if the queue's RetryConfig specifies that the task should be retried. The value must be given as a string that indicates the length of time (in seconds) followed by `s` (for "seconds"). For more information on the format, see the documentation for [Duration](https://protobuf.dev/reference/protobuf/google.protobuf/#duration). `max_backoff` will be truncated to the nearest second. If unspecified when the queue is created, Cloud Tasks will pick the default. This field has the same meaning as [max_backoff_seconds in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). "maxDoublings": 42, # The time between retries will double `max_doublings` times. A task's retry interval starts at min_backoff, then doubles `max_doublings` times, then increases linearly, and finally retries at intervals of max_backoff up to max_attempts times. For example, if min_backoff is 10s, max_backoff is 300s, and `max_doublings` is 3, then the a task will first be retried in 10s. The retry interval will double three times, and then increase linearly by 2^3 * 10s. Finally, the task will retry at intervals of max_backoff until the task has been attempted max_attempts times. Thus, the requests will retry at 10s, 20s, 40s, 80s, 160s, 240s, 300s, 300s, .... If unspecified when the queue is created, Cloud Tasks will pick the default. This field has the same meaning as [max_doublings in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). - "maxRetryDuration": "A String", # If positive, `max_retry_duration` specifies the time limit for retrying a failed task, measured from when the task was first attempted. Once `max_retry_duration` time has passed *and* the task has been attempted max_attempts times, no further attempts will be made and the task will be deleted. If zero, then the task age is unlimited. If unspecified when the queue is created, Cloud Tasks will pick the default. The value must be given as a string that indicates the length of time (in seconds) followed by `s` (for "seconds"). For the maximum possible value or the format, see the documentation for [Duration](https://protobuf.dev/reference/protobuf/google.protobuf/#duration). `max_retry_duration` will be truncated to the nearest second. This field has the same meaning as [task_age_limit in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). - "minBackoff": "A String", # A task will be scheduled for retry between min_backoff and max_backoff duration after it fails, if the queue's RetryConfig specifies that the task should be retried. If unspecified when the queue is created, Cloud Tasks will pick the default. The value must be given as a string that indicates the length of time (in seconds) followed by `s` (for "seconds"). For more information on the format, see the documentation for [Duration](https://protobuf.dev/reference/protobuf/google.protobuf/#duration). `min_backoff` will be truncated to the nearest second. This field has the same meaning as [min_backoff_seconds in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). + "maxRetryDuration": "A String", # If positive, `max_retry_duration` specifies the time limit for retrying a failed task, measured from when the task was first attempted. Once `max_retry_duration` time has passed *and* the task has been attempted max_attempts times, no further attempts are made and the task is deleted. A zero (0) indicates an unlimited duration, up to the [maximum task retention](https://docs.cloud.google.com/tasks/docs/quotas#limits) limit. The value must be given as a string that indicates the length of time (in seconds) followed by `s` (for "seconds"). For the maximum possible value or the format, see the documentation for [Duration](https://protobuf.dev/reference/protobuf/google.protobuf/#duration). `max_retry_duration` will be truncated to the nearest second. If unspecified when the queue is created, Cloud Tasks will pick the default. This field has the same meaning as [task_age_limit in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). + "minBackoff": "A String", # A task will be scheduled for retry between min_backoff and max_backoff duration after it fails, if the queue's RetryConfig specifies that the task should be retried. The value must be given as a string that indicates the length of time (in seconds) followed by `s` (for "seconds"). For more information on the format, see the documentation for [Duration](https://protobuf.dev/reference/protobuf/google.protobuf/#duration). `min_backoff` will be truncated to the nearest second. If unspecified when the queue is created, Cloud Tasks will pick the default. This field has the same meaning as [min_backoff_seconds in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). }, "stackdriverLoggingConfig": { # Configuration options for writing logs to [Stackdriver Logging](https://cloud.google.com/logging/docs/). # Configuration options for writing logs to [Stackdriver Logging](https://cloud.google.com/logging/docs/). If this field is unset, then no logs are written. "samplingRatio": 3.14, # Specifies the fraction of operations to write to [Stackdriver Logging](https://cloud.google.com/logging/docs/). This field may contain any value between 0.0 and 1.0, inclusive. 0.0 is the default and means that no operations are logged. @@ -495,14 +495,14 @@

Method Details

"rateLimits": { # Rate limits. This message determines the maximum rate that tasks can be dispatched by a queue, regardless of whether the dispatch is a first task attempt or a retry. Note: The debugging command, RunTask, will run a task even if the queue has reached its RateLimits. # Rate limits for task dispatches. rate_limits and retry_config are related because they both control task attempts. However they control task attempts in different ways: * rate_limits controls the total rate of dispatches from a queue (i.e. all traffic dispatched from the queue, regardless of whether the dispatch is from a first attempt or a retry). * retry_config controls what happens to particular a task after its first attempt fails. That is, retry_config controls task retries (the second attempt, third attempt, etc). The queue's actual dispatch rate is the result of: * Number of tasks in the queue * User-specified throttling: rate_limits, retry_config, and the queue's state. * System throttling due to `429` (Too Many Requests) or `503` (Service Unavailable) responses from the worker, high error rates, or to smooth sudden large traffic spikes. "maxBurstSize": 42, # The max burst size. Max burst size limits how fast tasks in queue are processed when many tasks are in the queue and the rate is high. This field allows the queue to have a high rate so processing starts shortly after a task is enqueued, but still limits resource usage when many tasks are enqueued in a short period of time. The [token bucket](https://wikipedia.org/wiki/Token_Bucket) algorithm is used to control the rate of task dispatches. Each queue has a token bucket that holds tokens, up to the maximum specified by `max_burst_size`. Each time a task is dispatched, a token is removed from the bucket. Tasks will be dispatched until the queue's bucket runs out of tokens. The bucket will be continuously refilled with new tokens based on max_dispatches_per_second. The default value of `max_burst_size` is picked by Cloud Tasks based on the value of max_dispatches_per_second. The maximum value of `max_burst_size` is 500. For App Engine queues that were created or updated using `queue.yaml/xml`, `max_burst_size` is equal to [bucket_size](https://cloud.google.com/appengine/docs/standard/python/config/queueref#bucket_size). If UpdateQueue is called on a queue without explicitly setting a value for `max_burst_size`, `max_burst_size` value will get updated if UpdateQueue is updating max_dispatches_per_second. "maxConcurrentDispatches": 42, # The maximum number of concurrent tasks that Cloud Tasks allows to be dispatched for this queue. After this threshold has been reached, Cloud Tasks stops dispatching tasks until the number of concurrent requests decreases. If unspecified when the queue is created, Cloud Tasks will pick the default. The maximum allowed value is 5,000. This field has the same meaning as [max_concurrent_requests in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#max_concurrent_requests). - "maxDispatchesPerSecond": 3.14, # The maximum rate at which tasks are dispatched from this queue. If unspecified when the queue is created, Cloud Tasks will pick the default. * For App Engine queues, the maximum allowed value is 500. This field has the same meaning as [rate in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#rate). + "maxDispatchesPerSecond": 3.14, # The maximum rate at which tasks are dispatched from this queue. If unspecified when the queue is created, Cloud Tasks will pick the default. For App Engine queues, the maximum allowed value is 500. This field has the same meaning as [rate in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#rate). }, "retryConfig": { # Retry config. These settings determine when a failed task attempt is retried. # Settings that determine the retry behavior. * For tasks created using Cloud Tasks: the queue-level retry settings apply to all tasks in the queue that were created using Cloud Tasks. Retry settings cannot be set on individual tasks. * For tasks created using the App Engine SDK: the queue-level retry settings apply to all tasks in the queue which do not have retry settings explicitly set on the task and were created by the App Engine SDK. See [App Engine documentation](https://cloud.google.com/appengine/docs/standard/python/taskqueue/push/retrying-tasks). - "maxAttempts": 42, # Number of attempts per task. Cloud Tasks will attempt the task `max_attempts` times (that is, if the first attempt fails, then there will be `max_attempts - 1` retries). Must be >= -1. If unspecified when the queue is created, Cloud Tasks will pick the default. -1 indicates unlimited attempts. This field has the same meaning as [task_retry_limit in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). Note: Cloud Tasks stops retrying only when `max_attempts` and `max_retry_duration` are both satisfied. When the task has been attempted `max_attempts` times and when the `max_retry_duration` time has passed, no further attempts are made, and the task is deleted. If you want your task to retry infinitely, you must set `max_attempts` to -1 and `max_retry_duration` to 0. - "maxBackoff": "A String", # A task will be scheduled for retry between min_backoff and max_backoff duration after it fails, if the queue's RetryConfig specifies that the task should be retried. If unspecified when the queue is created, Cloud Tasks will pick the default. The value must be given as a string that indicates the length of time (in seconds) followed by `s` (for "seconds"). For more information on the format, see the documentation for [Duration](https://protobuf.dev/reference/protobuf/google.protobuf/#duration). `max_backoff` will be truncated to the nearest second. This field has the same meaning as [max_backoff_seconds in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). + "maxAttempts": 42, # Number of attempts per task, including the first attempt. (If the first attempt fails, there will be `max_attempts - 1` retries.) Must be greater than or equal to -1, which indicates unlimited attempts. Cloud Tasks stops retrying only when `max_attempts` and `max_retry_duration` are both satisfied, or when the task is successfully executed. When the task has been attempted `max_attempts` times and when the `max_retry_duration` time has passed, no further attempts are made, and the task is deleted. If `max_attempts` is set to -1 and `max_retry_duration` is set to 0, the task is retried until the [maximum task retention](https://docs.cloud.google.com/tasks/docs/quotas#limits) limit is reached. If unspecified when the queue is created, Cloud Tasks will pick the default. This field has the same meaning as [task_retry_limit in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). + "maxBackoff": "A String", # A task will be scheduled for retry between min_backoff and max_backoff duration after it fails, if the queue's RetryConfig specifies that the task should be retried. The value must be given as a string that indicates the length of time (in seconds) followed by `s` (for "seconds"). For more information on the format, see the documentation for [Duration](https://protobuf.dev/reference/protobuf/google.protobuf/#duration). `max_backoff` will be truncated to the nearest second. If unspecified when the queue is created, Cloud Tasks will pick the default. This field has the same meaning as [max_backoff_seconds in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). "maxDoublings": 42, # The time between retries will double `max_doublings` times. A task's retry interval starts at min_backoff, then doubles `max_doublings` times, then increases linearly, and finally retries at intervals of max_backoff up to max_attempts times. For example, if min_backoff is 10s, max_backoff is 300s, and `max_doublings` is 3, then the a task will first be retried in 10s. The retry interval will double three times, and then increase linearly by 2^3 * 10s. Finally, the task will retry at intervals of max_backoff until the task has been attempted max_attempts times. Thus, the requests will retry at 10s, 20s, 40s, 80s, 160s, 240s, 300s, 300s, .... If unspecified when the queue is created, Cloud Tasks will pick the default. This field has the same meaning as [max_doublings in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). - "maxRetryDuration": "A String", # If positive, `max_retry_duration` specifies the time limit for retrying a failed task, measured from when the task was first attempted. Once `max_retry_duration` time has passed *and* the task has been attempted max_attempts times, no further attempts will be made and the task will be deleted. If zero, then the task age is unlimited. If unspecified when the queue is created, Cloud Tasks will pick the default. The value must be given as a string that indicates the length of time (in seconds) followed by `s` (for "seconds"). For the maximum possible value or the format, see the documentation for [Duration](https://protobuf.dev/reference/protobuf/google.protobuf/#duration). `max_retry_duration` will be truncated to the nearest second. This field has the same meaning as [task_age_limit in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). - "minBackoff": "A String", # A task will be scheduled for retry between min_backoff and max_backoff duration after it fails, if the queue's RetryConfig specifies that the task should be retried. If unspecified when the queue is created, Cloud Tasks will pick the default. The value must be given as a string that indicates the length of time (in seconds) followed by `s` (for "seconds"). For more information on the format, see the documentation for [Duration](https://protobuf.dev/reference/protobuf/google.protobuf/#duration). `min_backoff` will be truncated to the nearest second. This field has the same meaning as [min_backoff_seconds in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). + "maxRetryDuration": "A String", # If positive, `max_retry_duration` specifies the time limit for retrying a failed task, measured from when the task was first attempted. Once `max_retry_duration` time has passed *and* the task has been attempted max_attempts times, no further attempts are made and the task is deleted. A zero (0) indicates an unlimited duration, up to the [maximum task retention](https://docs.cloud.google.com/tasks/docs/quotas#limits) limit. The value must be given as a string that indicates the length of time (in seconds) followed by `s` (for "seconds"). For the maximum possible value or the format, see the documentation for [Duration](https://protobuf.dev/reference/protobuf/google.protobuf/#duration). `max_retry_duration` will be truncated to the nearest second. If unspecified when the queue is created, Cloud Tasks will pick the default. This field has the same meaning as [task_age_limit in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). + "minBackoff": "A String", # A task will be scheduled for retry between min_backoff and max_backoff duration after it fails, if the queue's RetryConfig specifies that the task should be retried. The value must be given as a string that indicates the length of time (in seconds) followed by `s` (for "seconds"). For more information on the format, see the documentation for [Duration](https://protobuf.dev/reference/protobuf/google.protobuf/#duration). `min_backoff` will be truncated to the nearest second. If unspecified when the queue is created, Cloud Tasks will pick the default. This field has the same meaning as [min_backoff_seconds in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). }, "stackdriverLoggingConfig": { # Configuration options for writing logs to [Stackdriver Logging](https://cloud.google.com/logging/docs/). # Configuration options for writing logs to [Stackdriver Logging](https://cloud.google.com/logging/docs/). If this field is unset, then no logs are written. "samplingRatio": 3.14, # Specifies the fraction of operations to write to [Stackdriver Logging](https://cloud.google.com/logging/docs/). This field may contain any value between 0.0 and 1.0, inclusive. 0.0 is the default and means that no operations are logged. @@ -591,14 +591,14 @@

Method Details

"rateLimits": { # Rate limits. This message determines the maximum rate that tasks can be dispatched by a queue, regardless of whether the dispatch is a first task attempt or a retry. Note: The debugging command, RunTask, will run a task even if the queue has reached its RateLimits. # Rate limits for task dispatches. rate_limits and retry_config are related because they both control task attempts. However they control task attempts in different ways: * rate_limits controls the total rate of dispatches from a queue (i.e. all traffic dispatched from the queue, regardless of whether the dispatch is from a first attempt or a retry). * retry_config controls what happens to particular a task after its first attempt fails. That is, retry_config controls task retries (the second attempt, third attempt, etc). The queue's actual dispatch rate is the result of: * Number of tasks in the queue * User-specified throttling: rate_limits, retry_config, and the queue's state. * System throttling due to `429` (Too Many Requests) or `503` (Service Unavailable) responses from the worker, high error rates, or to smooth sudden large traffic spikes. "maxBurstSize": 42, # The max burst size. Max burst size limits how fast tasks in queue are processed when many tasks are in the queue and the rate is high. This field allows the queue to have a high rate so processing starts shortly after a task is enqueued, but still limits resource usage when many tasks are enqueued in a short period of time. The [token bucket](https://wikipedia.org/wiki/Token_Bucket) algorithm is used to control the rate of task dispatches. Each queue has a token bucket that holds tokens, up to the maximum specified by `max_burst_size`. Each time a task is dispatched, a token is removed from the bucket. Tasks will be dispatched until the queue's bucket runs out of tokens. The bucket will be continuously refilled with new tokens based on max_dispatches_per_second. The default value of `max_burst_size` is picked by Cloud Tasks based on the value of max_dispatches_per_second. The maximum value of `max_burst_size` is 500. For App Engine queues that were created or updated using `queue.yaml/xml`, `max_burst_size` is equal to [bucket_size](https://cloud.google.com/appengine/docs/standard/python/config/queueref#bucket_size). If UpdateQueue is called on a queue without explicitly setting a value for `max_burst_size`, `max_burst_size` value will get updated if UpdateQueue is updating max_dispatches_per_second. "maxConcurrentDispatches": 42, # The maximum number of concurrent tasks that Cloud Tasks allows to be dispatched for this queue. After this threshold has been reached, Cloud Tasks stops dispatching tasks until the number of concurrent requests decreases. If unspecified when the queue is created, Cloud Tasks will pick the default. The maximum allowed value is 5,000. This field has the same meaning as [max_concurrent_requests in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#max_concurrent_requests). - "maxDispatchesPerSecond": 3.14, # The maximum rate at which tasks are dispatched from this queue. If unspecified when the queue is created, Cloud Tasks will pick the default. * For App Engine queues, the maximum allowed value is 500. This field has the same meaning as [rate in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#rate). + "maxDispatchesPerSecond": 3.14, # The maximum rate at which tasks are dispatched from this queue. If unspecified when the queue is created, Cloud Tasks will pick the default. For App Engine queues, the maximum allowed value is 500. This field has the same meaning as [rate in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#rate). }, "retryConfig": { # Retry config. These settings determine when a failed task attempt is retried. # Settings that determine the retry behavior. * For tasks created using Cloud Tasks: the queue-level retry settings apply to all tasks in the queue that were created using Cloud Tasks. Retry settings cannot be set on individual tasks. * For tasks created using the App Engine SDK: the queue-level retry settings apply to all tasks in the queue which do not have retry settings explicitly set on the task and were created by the App Engine SDK. See [App Engine documentation](https://cloud.google.com/appengine/docs/standard/python/taskqueue/push/retrying-tasks). - "maxAttempts": 42, # Number of attempts per task. Cloud Tasks will attempt the task `max_attempts` times (that is, if the first attempt fails, then there will be `max_attempts - 1` retries). Must be >= -1. If unspecified when the queue is created, Cloud Tasks will pick the default. -1 indicates unlimited attempts. This field has the same meaning as [task_retry_limit in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). Note: Cloud Tasks stops retrying only when `max_attempts` and `max_retry_duration` are both satisfied. When the task has been attempted `max_attempts` times and when the `max_retry_duration` time has passed, no further attempts are made, and the task is deleted. If you want your task to retry infinitely, you must set `max_attempts` to -1 and `max_retry_duration` to 0. - "maxBackoff": "A String", # A task will be scheduled for retry between min_backoff and max_backoff duration after it fails, if the queue's RetryConfig specifies that the task should be retried. If unspecified when the queue is created, Cloud Tasks will pick the default. The value must be given as a string that indicates the length of time (in seconds) followed by `s` (for "seconds"). For more information on the format, see the documentation for [Duration](https://protobuf.dev/reference/protobuf/google.protobuf/#duration). `max_backoff` will be truncated to the nearest second. This field has the same meaning as [max_backoff_seconds in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). + "maxAttempts": 42, # Number of attempts per task, including the first attempt. (If the first attempt fails, there will be `max_attempts - 1` retries.) Must be greater than or equal to -1, which indicates unlimited attempts. Cloud Tasks stops retrying only when `max_attempts` and `max_retry_duration` are both satisfied, or when the task is successfully executed. When the task has been attempted `max_attempts` times and when the `max_retry_duration` time has passed, no further attempts are made, and the task is deleted. If `max_attempts` is set to -1 and `max_retry_duration` is set to 0, the task is retried until the [maximum task retention](https://docs.cloud.google.com/tasks/docs/quotas#limits) limit is reached. If unspecified when the queue is created, Cloud Tasks will pick the default. This field has the same meaning as [task_retry_limit in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). + "maxBackoff": "A String", # A task will be scheduled for retry between min_backoff and max_backoff duration after it fails, if the queue's RetryConfig specifies that the task should be retried. The value must be given as a string that indicates the length of time (in seconds) followed by `s` (for "seconds"). For more information on the format, see the documentation for [Duration](https://protobuf.dev/reference/protobuf/google.protobuf/#duration). `max_backoff` will be truncated to the nearest second. If unspecified when the queue is created, Cloud Tasks will pick the default. This field has the same meaning as [max_backoff_seconds in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). "maxDoublings": 42, # The time between retries will double `max_doublings` times. A task's retry interval starts at min_backoff, then doubles `max_doublings` times, then increases linearly, and finally retries at intervals of max_backoff up to max_attempts times. For example, if min_backoff is 10s, max_backoff is 300s, and `max_doublings` is 3, then the a task will first be retried in 10s. The retry interval will double three times, and then increase linearly by 2^3 * 10s. Finally, the task will retry at intervals of max_backoff until the task has been attempted max_attempts times. Thus, the requests will retry at 10s, 20s, 40s, 80s, 160s, 240s, 300s, 300s, .... If unspecified when the queue is created, Cloud Tasks will pick the default. This field has the same meaning as [max_doublings in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). - "maxRetryDuration": "A String", # If positive, `max_retry_duration` specifies the time limit for retrying a failed task, measured from when the task was first attempted. Once `max_retry_duration` time has passed *and* the task has been attempted max_attempts times, no further attempts will be made and the task will be deleted. If zero, then the task age is unlimited. If unspecified when the queue is created, Cloud Tasks will pick the default. The value must be given as a string that indicates the length of time (in seconds) followed by `s` (for "seconds"). For the maximum possible value or the format, see the documentation for [Duration](https://protobuf.dev/reference/protobuf/google.protobuf/#duration). `max_retry_duration` will be truncated to the nearest second. This field has the same meaning as [task_age_limit in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). - "minBackoff": "A String", # A task will be scheduled for retry between min_backoff and max_backoff duration after it fails, if the queue's RetryConfig specifies that the task should be retried. If unspecified when the queue is created, Cloud Tasks will pick the default. The value must be given as a string that indicates the length of time (in seconds) followed by `s` (for "seconds"). For more information on the format, see the documentation for [Duration](https://protobuf.dev/reference/protobuf/google.protobuf/#duration). `min_backoff` will be truncated to the nearest second. This field has the same meaning as [min_backoff_seconds in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). + "maxRetryDuration": "A String", # If positive, `max_retry_duration` specifies the time limit for retrying a failed task, measured from when the task was first attempted. Once `max_retry_duration` time has passed *and* the task has been attempted max_attempts times, no further attempts are made and the task is deleted. A zero (0) indicates an unlimited duration, up to the [maximum task retention](https://docs.cloud.google.com/tasks/docs/quotas#limits) limit. The value must be given as a string that indicates the length of time (in seconds) followed by `s` (for "seconds"). For the maximum possible value or the format, see the documentation for [Duration](https://protobuf.dev/reference/protobuf/google.protobuf/#duration). `max_retry_duration` will be truncated to the nearest second. If unspecified when the queue is created, Cloud Tasks will pick the default. This field has the same meaning as [task_age_limit in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). + "minBackoff": "A String", # A task will be scheduled for retry between min_backoff and max_backoff duration after it fails, if the queue's RetryConfig specifies that the task should be retried. The value must be given as a string that indicates the length of time (in seconds) followed by `s` (for "seconds"). For more information on the format, see the documentation for [Duration](https://protobuf.dev/reference/protobuf/google.protobuf/#duration). `min_backoff` will be truncated to the nearest second. If unspecified when the queue is created, Cloud Tasks will pick the default. This field has the same meaning as [min_backoff_seconds in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). }, "stackdriverLoggingConfig": { # Configuration options for writing logs to [Stackdriver Logging](https://cloud.google.com/logging/docs/). # Configuration options for writing logs to [Stackdriver Logging](https://cloud.google.com/logging/docs/). If this field is unset, then no logs are written. "samplingRatio": 3.14, # Specifies the fraction of operations to write to [Stackdriver Logging](https://cloud.google.com/logging/docs/). This field may contain any value between 0.0 and 1.0, inclusive. 0.0 is the default and means that no operations are logged. @@ -670,14 +670,14 @@

Method Details

"rateLimits": { # Rate limits. This message determines the maximum rate that tasks can be dispatched by a queue, regardless of whether the dispatch is a first task attempt or a retry. Note: The debugging command, RunTask, will run a task even if the queue has reached its RateLimits. # Rate limits for task dispatches. rate_limits and retry_config are related because they both control task attempts. However they control task attempts in different ways: * rate_limits controls the total rate of dispatches from a queue (i.e. all traffic dispatched from the queue, regardless of whether the dispatch is from a first attempt or a retry). * retry_config controls what happens to particular a task after its first attempt fails. That is, retry_config controls task retries (the second attempt, third attempt, etc). The queue's actual dispatch rate is the result of: * Number of tasks in the queue * User-specified throttling: rate_limits, retry_config, and the queue's state. * System throttling due to `429` (Too Many Requests) or `503` (Service Unavailable) responses from the worker, high error rates, or to smooth sudden large traffic spikes. "maxBurstSize": 42, # The max burst size. Max burst size limits how fast tasks in queue are processed when many tasks are in the queue and the rate is high. This field allows the queue to have a high rate so processing starts shortly after a task is enqueued, but still limits resource usage when many tasks are enqueued in a short period of time. The [token bucket](https://wikipedia.org/wiki/Token_Bucket) algorithm is used to control the rate of task dispatches. Each queue has a token bucket that holds tokens, up to the maximum specified by `max_burst_size`. Each time a task is dispatched, a token is removed from the bucket. Tasks will be dispatched until the queue's bucket runs out of tokens. The bucket will be continuously refilled with new tokens based on max_dispatches_per_second. The default value of `max_burst_size` is picked by Cloud Tasks based on the value of max_dispatches_per_second. The maximum value of `max_burst_size` is 500. For App Engine queues that were created or updated using `queue.yaml/xml`, `max_burst_size` is equal to [bucket_size](https://cloud.google.com/appengine/docs/standard/python/config/queueref#bucket_size). If UpdateQueue is called on a queue without explicitly setting a value for `max_burst_size`, `max_burst_size` value will get updated if UpdateQueue is updating max_dispatches_per_second. "maxConcurrentDispatches": 42, # The maximum number of concurrent tasks that Cloud Tasks allows to be dispatched for this queue. After this threshold has been reached, Cloud Tasks stops dispatching tasks until the number of concurrent requests decreases. If unspecified when the queue is created, Cloud Tasks will pick the default. The maximum allowed value is 5,000. This field has the same meaning as [max_concurrent_requests in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#max_concurrent_requests). - "maxDispatchesPerSecond": 3.14, # The maximum rate at which tasks are dispatched from this queue. If unspecified when the queue is created, Cloud Tasks will pick the default. * For App Engine queues, the maximum allowed value is 500. This field has the same meaning as [rate in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#rate). + "maxDispatchesPerSecond": 3.14, # The maximum rate at which tasks are dispatched from this queue. If unspecified when the queue is created, Cloud Tasks will pick the default. For App Engine queues, the maximum allowed value is 500. This field has the same meaning as [rate in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#rate). }, "retryConfig": { # Retry config. These settings determine when a failed task attempt is retried. # Settings that determine the retry behavior. * For tasks created using Cloud Tasks: the queue-level retry settings apply to all tasks in the queue that were created using Cloud Tasks. Retry settings cannot be set on individual tasks. * For tasks created using the App Engine SDK: the queue-level retry settings apply to all tasks in the queue which do not have retry settings explicitly set on the task and were created by the App Engine SDK. See [App Engine documentation](https://cloud.google.com/appengine/docs/standard/python/taskqueue/push/retrying-tasks). - "maxAttempts": 42, # Number of attempts per task. Cloud Tasks will attempt the task `max_attempts` times (that is, if the first attempt fails, then there will be `max_attempts - 1` retries). Must be >= -1. If unspecified when the queue is created, Cloud Tasks will pick the default. -1 indicates unlimited attempts. This field has the same meaning as [task_retry_limit in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). Note: Cloud Tasks stops retrying only when `max_attempts` and `max_retry_duration` are both satisfied. When the task has been attempted `max_attempts` times and when the `max_retry_duration` time has passed, no further attempts are made, and the task is deleted. If you want your task to retry infinitely, you must set `max_attempts` to -1 and `max_retry_duration` to 0. - "maxBackoff": "A String", # A task will be scheduled for retry between min_backoff and max_backoff duration after it fails, if the queue's RetryConfig specifies that the task should be retried. If unspecified when the queue is created, Cloud Tasks will pick the default. The value must be given as a string that indicates the length of time (in seconds) followed by `s` (for "seconds"). For more information on the format, see the documentation for [Duration](https://protobuf.dev/reference/protobuf/google.protobuf/#duration). `max_backoff` will be truncated to the nearest second. This field has the same meaning as [max_backoff_seconds in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). + "maxAttempts": 42, # Number of attempts per task, including the first attempt. (If the first attempt fails, there will be `max_attempts - 1` retries.) Must be greater than or equal to -1, which indicates unlimited attempts. Cloud Tasks stops retrying only when `max_attempts` and `max_retry_duration` are both satisfied, or when the task is successfully executed. When the task has been attempted `max_attempts` times and when the `max_retry_duration` time has passed, no further attempts are made, and the task is deleted. If `max_attempts` is set to -1 and `max_retry_duration` is set to 0, the task is retried until the [maximum task retention](https://docs.cloud.google.com/tasks/docs/quotas#limits) limit is reached. If unspecified when the queue is created, Cloud Tasks will pick the default. This field has the same meaning as [task_retry_limit in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). + "maxBackoff": "A String", # A task will be scheduled for retry between min_backoff and max_backoff duration after it fails, if the queue's RetryConfig specifies that the task should be retried. The value must be given as a string that indicates the length of time (in seconds) followed by `s` (for "seconds"). For more information on the format, see the documentation for [Duration](https://protobuf.dev/reference/protobuf/google.protobuf/#duration). `max_backoff` will be truncated to the nearest second. If unspecified when the queue is created, Cloud Tasks will pick the default. This field has the same meaning as [max_backoff_seconds in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). "maxDoublings": 42, # The time between retries will double `max_doublings` times. A task's retry interval starts at min_backoff, then doubles `max_doublings` times, then increases linearly, and finally retries at intervals of max_backoff up to max_attempts times. For example, if min_backoff is 10s, max_backoff is 300s, and `max_doublings` is 3, then the a task will first be retried in 10s. The retry interval will double three times, and then increase linearly by 2^3 * 10s. Finally, the task will retry at intervals of max_backoff until the task has been attempted max_attempts times. Thus, the requests will retry at 10s, 20s, 40s, 80s, 160s, 240s, 300s, 300s, .... If unspecified when the queue is created, Cloud Tasks will pick the default. This field has the same meaning as [max_doublings in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). - "maxRetryDuration": "A String", # If positive, `max_retry_duration` specifies the time limit for retrying a failed task, measured from when the task was first attempted. Once `max_retry_duration` time has passed *and* the task has been attempted max_attempts times, no further attempts will be made and the task will be deleted. If zero, then the task age is unlimited. If unspecified when the queue is created, Cloud Tasks will pick the default. The value must be given as a string that indicates the length of time (in seconds) followed by `s` (for "seconds"). For the maximum possible value or the format, see the documentation for [Duration](https://protobuf.dev/reference/protobuf/google.protobuf/#duration). `max_retry_duration` will be truncated to the nearest second. This field has the same meaning as [task_age_limit in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). - "minBackoff": "A String", # A task will be scheduled for retry between min_backoff and max_backoff duration after it fails, if the queue's RetryConfig specifies that the task should be retried. If unspecified when the queue is created, Cloud Tasks will pick the default. The value must be given as a string that indicates the length of time (in seconds) followed by `s` (for "seconds"). For more information on the format, see the documentation for [Duration](https://protobuf.dev/reference/protobuf/google.protobuf/#duration). `min_backoff` will be truncated to the nearest second. This field has the same meaning as [min_backoff_seconds in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). + "maxRetryDuration": "A String", # If positive, `max_retry_duration` specifies the time limit for retrying a failed task, measured from when the task was first attempted. Once `max_retry_duration` time has passed *and* the task has been attempted max_attempts times, no further attempts are made and the task is deleted. A zero (0) indicates an unlimited duration, up to the [maximum task retention](https://docs.cloud.google.com/tasks/docs/quotas#limits) limit. The value must be given as a string that indicates the length of time (in seconds) followed by `s` (for "seconds"). For the maximum possible value or the format, see the documentation for [Duration](https://protobuf.dev/reference/protobuf/google.protobuf/#duration). `max_retry_duration` will be truncated to the nearest second. If unspecified when the queue is created, Cloud Tasks will pick the default. This field has the same meaning as [task_age_limit in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). + "minBackoff": "A String", # A task will be scheduled for retry between min_backoff and max_backoff duration after it fails, if the queue's RetryConfig specifies that the task should be retried. The value must be given as a string that indicates the length of time (in seconds) followed by `s` (for "seconds"). For more information on the format, see the documentation for [Duration](https://protobuf.dev/reference/protobuf/google.protobuf/#duration). `min_backoff` will be truncated to the nearest second. If unspecified when the queue is created, Cloud Tasks will pick the default. This field has the same meaning as [min_backoff_seconds in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). }, "stackdriverLoggingConfig": { # Configuration options for writing logs to [Stackdriver Logging](https://cloud.google.com/logging/docs/). # Configuration options for writing logs to [Stackdriver Logging](https://cloud.google.com/logging/docs/). If this field is unset, then no logs are written. "samplingRatio": 3.14, # Specifies the fraction of operations to write to [Stackdriver Logging](https://cloud.google.com/logging/docs/). This field may contain any value between 0.0 and 1.0, inclusive. 0.0 is the default and means that no operations are logged. @@ -761,14 +761,14 @@

Method Details

"rateLimits": { # Rate limits. This message determines the maximum rate that tasks can be dispatched by a queue, regardless of whether the dispatch is a first task attempt or a retry. Note: The debugging command, RunTask, will run a task even if the queue has reached its RateLimits. # Rate limits for task dispatches. rate_limits and retry_config are related because they both control task attempts. However they control task attempts in different ways: * rate_limits controls the total rate of dispatches from a queue (i.e. all traffic dispatched from the queue, regardless of whether the dispatch is from a first attempt or a retry). * retry_config controls what happens to particular a task after its first attempt fails. That is, retry_config controls task retries (the second attempt, third attempt, etc). The queue's actual dispatch rate is the result of: * Number of tasks in the queue * User-specified throttling: rate_limits, retry_config, and the queue's state. * System throttling due to `429` (Too Many Requests) or `503` (Service Unavailable) responses from the worker, high error rates, or to smooth sudden large traffic spikes. "maxBurstSize": 42, # The max burst size. Max burst size limits how fast tasks in queue are processed when many tasks are in the queue and the rate is high. This field allows the queue to have a high rate so processing starts shortly after a task is enqueued, but still limits resource usage when many tasks are enqueued in a short period of time. The [token bucket](https://wikipedia.org/wiki/Token_Bucket) algorithm is used to control the rate of task dispatches. Each queue has a token bucket that holds tokens, up to the maximum specified by `max_burst_size`. Each time a task is dispatched, a token is removed from the bucket. Tasks will be dispatched until the queue's bucket runs out of tokens. The bucket will be continuously refilled with new tokens based on max_dispatches_per_second. The default value of `max_burst_size` is picked by Cloud Tasks based on the value of max_dispatches_per_second. The maximum value of `max_burst_size` is 500. For App Engine queues that were created or updated using `queue.yaml/xml`, `max_burst_size` is equal to [bucket_size](https://cloud.google.com/appengine/docs/standard/python/config/queueref#bucket_size). If UpdateQueue is called on a queue without explicitly setting a value for `max_burst_size`, `max_burst_size` value will get updated if UpdateQueue is updating max_dispatches_per_second. "maxConcurrentDispatches": 42, # The maximum number of concurrent tasks that Cloud Tasks allows to be dispatched for this queue. After this threshold has been reached, Cloud Tasks stops dispatching tasks until the number of concurrent requests decreases. If unspecified when the queue is created, Cloud Tasks will pick the default. The maximum allowed value is 5,000. This field has the same meaning as [max_concurrent_requests in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#max_concurrent_requests). - "maxDispatchesPerSecond": 3.14, # The maximum rate at which tasks are dispatched from this queue. If unspecified when the queue is created, Cloud Tasks will pick the default. * For App Engine queues, the maximum allowed value is 500. This field has the same meaning as [rate in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#rate). + "maxDispatchesPerSecond": 3.14, # The maximum rate at which tasks are dispatched from this queue. If unspecified when the queue is created, Cloud Tasks will pick the default. For App Engine queues, the maximum allowed value is 500. This field has the same meaning as [rate in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#rate). }, "retryConfig": { # Retry config. These settings determine when a failed task attempt is retried. # Settings that determine the retry behavior. * For tasks created using Cloud Tasks: the queue-level retry settings apply to all tasks in the queue that were created using Cloud Tasks. Retry settings cannot be set on individual tasks. * For tasks created using the App Engine SDK: the queue-level retry settings apply to all tasks in the queue which do not have retry settings explicitly set on the task and were created by the App Engine SDK. See [App Engine documentation](https://cloud.google.com/appengine/docs/standard/python/taskqueue/push/retrying-tasks). - "maxAttempts": 42, # Number of attempts per task. Cloud Tasks will attempt the task `max_attempts` times (that is, if the first attempt fails, then there will be `max_attempts - 1` retries). Must be >= -1. If unspecified when the queue is created, Cloud Tasks will pick the default. -1 indicates unlimited attempts. This field has the same meaning as [task_retry_limit in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). Note: Cloud Tasks stops retrying only when `max_attempts` and `max_retry_duration` are both satisfied. When the task has been attempted `max_attempts` times and when the `max_retry_duration` time has passed, no further attempts are made, and the task is deleted. If you want your task to retry infinitely, you must set `max_attempts` to -1 and `max_retry_duration` to 0. - "maxBackoff": "A String", # A task will be scheduled for retry between min_backoff and max_backoff duration after it fails, if the queue's RetryConfig specifies that the task should be retried. If unspecified when the queue is created, Cloud Tasks will pick the default. The value must be given as a string that indicates the length of time (in seconds) followed by `s` (for "seconds"). For more information on the format, see the documentation for [Duration](https://protobuf.dev/reference/protobuf/google.protobuf/#duration). `max_backoff` will be truncated to the nearest second. This field has the same meaning as [max_backoff_seconds in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). + "maxAttempts": 42, # Number of attempts per task, including the first attempt. (If the first attempt fails, there will be `max_attempts - 1` retries.) Must be greater than or equal to -1, which indicates unlimited attempts. Cloud Tasks stops retrying only when `max_attempts` and `max_retry_duration` are both satisfied, or when the task is successfully executed. When the task has been attempted `max_attempts` times and when the `max_retry_duration` time has passed, no further attempts are made, and the task is deleted. If `max_attempts` is set to -1 and `max_retry_duration` is set to 0, the task is retried until the [maximum task retention](https://docs.cloud.google.com/tasks/docs/quotas#limits) limit is reached. If unspecified when the queue is created, Cloud Tasks will pick the default. This field has the same meaning as [task_retry_limit in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). + "maxBackoff": "A String", # A task will be scheduled for retry between min_backoff and max_backoff duration after it fails, if the queue's RetryConfig specifies that the task should be retried. The value must be given as a string that indicates the length of time (in seconds) followed by `s` (for "seconds"). For more information on the format, see the documentation for [Duration](https://protobuf.dev/reference/protobuf/google.protobuf/#duration). `max_backoff` will be truncated to the nearest second. If unspecified when the queue is created, Cloud Tasks will pick the default. This field has the same meaning as [max_backoff_seconds in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). "maxDoublings": 42, # The time between retries will double `max_doublings` times. A task's retry interval starts at min_backoff, then doubles `max_doublings` times, then increases linearly, and finally retries at intervals of max_backoff up to max_attempts times. For example, if min_backoff is 10s, max_backoff is 300s, and `max_doublings` is 3, then the a task will first be retried in 10s. The retry interval will double three times, and then increase linearly by 2^3 * 10s. Finally, the task will retry at intervals of max_backoff until the task has been attempted max_attempts times. Thus, the requests will retry at 10s, 20s, 40s, 80s, 160s, 240s, 300s, 300s, .... If unspecified when the queue is created, Cloud Tasks will pick the default. This field has the same meaning as [max_doublings in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). - "maxRetryDuration": "A String", # If positive, `max_retry_duration` specifies the time limit for retrying a failed task, measured from when the task was first attempted. Once `max_retry_duration` time has passed *and* the task has been attempted max_attempts times, no further attempts will be made and the task will be deleted. If zero, then the task age is unlimited. If unspecified when the queue is created, Cloud Tasks will pick the default. The value must be given as a string that indicates the length of time (in seconds) followed by `s` (for "seconds"). For the maximum possible value or the format, see the documentation for [Duration](https://protobuf.dev/reference/protobuf/google.protobuf/#duration). `max_retry_duration` will be truncated to the nearest second. This field has the same meaning as [task_age_limit in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). - "minBackoff": "A String", # A task will be scheduled for retry between min_backoff and max_backoff duration after it fails, if the queue's RetryConfig specifies that the task should be retried. If unspecified when the queue is created, Cloud Tasks will pick the default. The value must be given as a string that indicates the length of time (in seconds) followed by `s` (for "seconds"). For more information on the format, see the documentation for [Duration](https://protobuf.dev/reference/protobuf/google.protobuf/#duration). `min_backoff` will be truncated to the nearest second. This field has the same meaning as [min_backoff_seconds in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). + "maxRetryDuration": "A String", # If positive, `max_retry_duration` specifies the time limit for retrying a failed task, measured from when the task was first attempted. Once `max_retry_duration` time has passed *and* the task has been attempted max_attempts times, no further attempts are made and the task is deleted. A zero (0) indicates an unlimited duration, up to the [maximum task retention](https://docs.cloud.google.com/tasks/docs/quotas#limits) limit. The value must be given as a string that indicates the length of time (in seconds) followed by `s` (for "seconds"). For the maximum possible value or the format, see the documentation for [Duration](https://protobuf.dev/reference/protobuf/google.protobuf/#duration). `max_retry_duration` will be truncated to the nearest second. If unspecified when the queue is created, Cloud Tasks will pick the default. This field has the same meaning as [task_age_limit in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). + "minBackoff": "A String", # A task will be scheduled for retry between min_backoff and max_backoff duration after it fails, if the queue's RetryConfig specifies that the task should be retried. The value must be given as a string that indicates the length of time (in seconds) followed by `s` (for "seconds"). For more information on the format, see the documentation for [Duration](https://protobuf.dev/reference/protobuf/google.protobuf/#duration). `min_backoff` will be truncated to the nearest second. If unspecified when the queue is created, Cloud Tasks will pick the default. This field has the same meaning as [min_backoff_seconds in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). }, "stackdriverLoggingConfig": { # Configuration options for writing logs to [Stackdriver Logging](https://cloud.google.com/logging/docs/). # Configuration options for writing logs to [Stackdriver Logging](https://cloud.google.com/logging/docs/). If this field is unset, then no logs are written. "samplingRatio": 3.14, # Specifies the fraction of operations to write to [Stackdriver Logging](https://cloud.google.com/logging/docs/). This field may contain any value between 0.0 and 1.0, inclusive. 0.0 is the default and means that no operations are logged. @@ -852,14 +852,14 @@

Method Details

"rateLimits": { # Rate limits. This message determines the maximum rate that tasks can be dispatched by a queue, regardless of whether the dispatch is a first task attempt or a retry. Note: The debugging command, RunTask, will run a task even if the queue has reached its RateLimits. # Rate limits for task dispatches. rate_limits and retry_config are related because they both control task attempts. However they control task attempts in different ways: * rate_limits controls the total rate of dispatches from a queue (i.e. all traffic dispatched from the queue, regardless of whether the dispatch is from a first attempt or a retry). * retry_config controls what happens to particular a task after its first attempt fails. That is, retry_config controls task retries (the second attempt, third attempt, etc). The queue's actual dispatch rate is the result of: * Number of tasks in the queue * User-specified throttling: rate_limits, retry_config, and the queue's state. * System throttling due to `429` (Too Many Requests) or `503` (Service Unavailable) responses from the worker, high error rates, or to smooth sudden large traffic spikes. "maxBurstSize": 42, # The max burst size. Max burst size limits how fast tasks in queue are processed when many tasks are in the queue and the rate is high. This field allows the queue to have a high rate so processing starts shortly after a task is enqueued, but still limits resource usage when many tasks are enqueued in a short period of time. The [token bucket](https://wikipedia.org/wiki/Token_Bucket) algorithm is used to control the rate of task dispatches. Each queue has a token bucket that holds tokens, up to the maximum specified by `max_burst_size`. Each time a task is dispatched, a token is removed from the bucket. Tasks will be dispatched until the queue's bucket runs out of tokens. The bucket will be continuously refilled with new tokens based on max_dispatches_per_second. The default value of `max_burst_size` is picked by Cloud Tasks based on the value of max_dispatches_per_second. The maximum value of `max_burst_size` is 500. For App Engine queues that were created or updated using `queue.yaml/xml`, `max_burst_size` is equal to [bucket_size](https://cloud.google.com/appengine/docs/standard/python/config/queueref#bucket_size). If UpdateQueue is called on a queue without explicitly setting a value for `max_burst_size`, `max_burst_size` value will get updated if UpdateQueue is updating max_dispatches_per_second. "maxConcurrentDispatches": 42, # The maximum number of concurrent tasks that Cloud Tasks allows to be dispatched for this queue. After this threshold has been reached, Cloud Tasks stops dispatching tasks until the number of concurrent requests decreases. If unspecified when the queue is created, Cloud Tasks will pick the default. The maximum allowed value is 5,000. This field has the same meaning as [max_concurrent_requests in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#max_concurrent_requests). - "maxDispatchesPerSecond": 3.14, # The maximum rate at which tasks are dispatched from this queue. If unspecified when the queue is created, Cloud Tasks will pick the default. * For App Engine queues, the maximum allowed value is 500. This field has the same meaning as [rate in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#rate). + "maxDispatchesPerSecond": 3.14, # The maximum rate at which tasks are dispatched from this queue. If unspecified when the queue is created, Cloud Tasks will pick the default. For App Engine queues, the maximum allowed value is 500. This field has the same meaning as [rate in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#rate). }, "retryConfig": { # Retry config. These settings determine when a failed task attempt is retried. # Settings that determine the retry behavior. * For tasks created using Cloud Tasks: the queue-level retry settings apply to all tasks in the queue that were created using Cloud Tasks. Retry settings cannot be set on individual tasks. * For tasks created using the App Engine SDK: the queue-level retry settings apply to all tasks in the queue which do not have retry settings explicitly set on the task and were created by the App Engine SDK. See [App Engine documentation](https://cloud.google.com/appengine/docs/standard/python/taskqueue/push/retrying-tasks). - "maxAttempts": 42, # Number of attempts per task. Cloud Tasks will attempt the task `max_attempts` times (that is, if the first attempt fails, then there will be `max_attempts - 1` retries). Must be >= -1. If unspecified when the queue is created, Cloud Tasks will pick the default. -1 indicates unlimited attempts. This field has the same meaning as [task_retry_limit in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). Note: Cloud Tasks stops retrying only when `max_attempts` and `max_retry_duration` are both satisfied. When the task has been attempted `max_attempts` times and when the `max_retry_duration` time has passed, no further attempts are made, and the task is deleted. If you want your task to retry infinitely, you must set `max_attempts` to -1 and `max_retry_duration` to 0. - "maxBackoff": "A String", # A task will be scheduled for retry between min_backoff and max_backoff duration after it fails, if the queue's RetryConfig specifies that the task should be retried. If unspecified when the queue is created, Cloud Tasks will pick the default. The value must be given as a string that indicates the length of time (in seconds) followed by `s` (for "seconds"). For more information on the format, see the documentation for [Duration](https://protobuf.dev/reference/protobuf/google.protobuf/#duration). `max_backoff` will be truncated to the nearest second. This field has the same meaning as [max_backoff_seconds in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). + "maxAttempts": 42, # Number of attempts per task, including the first attempt. (If the first attempt fails, there will be `max_attempts - 1` retries.) Must be greater than or equal to -1, which indicates unlimited attempts. Cloud Tasks stops retrying only when `max_attempts` and `max_retry_duration` are both satisfied, or when the task is successfully executed. When the task has been attempted `max_attempts` times and when the `max_retry_duration` time has passed, no further attempts are made, and the task is deleted. If `max_attempts` is set to -1 and `max_retry_duration` is set to 0, the task is retried until the [maximum task retention](https://docs.cloud.google.com/tasks/docs/quotas#limits) limit is reached. If unspecified when the queue is created, Cloud Tasks will pick the default. This field has the same meaning as [task_retry_limit in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). + "maxBackoff": "A String", # A task will be scheduled for retry between min_backoff and max_backoff duration after it fails, if the queue's RetryConfig specifies that the task should be retried. The value must be given as a string that indicates the length of time (in seconds) followed by `s` (for "seconds"). For more information on the format, see the documentation for [Duration](https://protobuf.dev/reference/protobuf/google.protobuf/#duration). `max_backoff` will be truncated to the nearest second. If unspecified when the queue is created, Cloud Tasks will pick the default. This field has the same meaning as [max_backoff_seconds in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). "maxDoublings": 42, # The time between retries will double `max_doublings` times. A task's retry interval starts at min_backoff, then doubles `max_doublings` times, then increases linearly, and finally retries at intervals of max_backoff up to max_attempts times. For example, if min_backoff is 10s, max_backoff is 300s, and `max_doublings` is 3, then the a task will first be retried in 10s. The retry interval will double three times, and then increase linearly by 2^3 * 10s. Finally, the task will retry at intervals of max_backoff until the task has been attempted max_attempts times. Thus, the requests will retry at 10s, 20s, 40s, 80s, 160s, 240s, 300s, 300s, .... If unspecified when the queue is created, Cloud Tasks will pick the default. This field has the same meaning as [max_doublings in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). - "maxRetryDuration": "A String", # If positive, `max_retry_duration` specifies the time limit for retrying a failed task, measured from when the task was first attempted. Once `max_retry_duration` time has passed *and* the task has been attempted max_attempts times, no further attempts will be made and the task will be deleted. If zero, then the task age is unlimited. If unspecified when the queue is created, Cloud Tasks will pick the default. The value must be given as a string that indicates the length of time (in seconds) followed by `s` (for "seconds"). For the maximum possible value or the format, see the documentation for [Duration](https://protobuf.dev/reference/protobuf/google.protobuf/#duration). `max_retry_duration` will be truncated to the nearest second. This field has the same meaning as [task_age_limit in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). - "minBackoff": "A String", # A task will be scheduled for retry between min_backoff and max_backoff duration after it fails, if the queue's RetryConfig specifies that the task should be retried. If unspecified when the queue is created, Cloud Tasks will pick the default. The value must be given as a string that indicates the length of time (in seconds) followed by `s` (for "seconds"). For more information on the format, see the documentation for [Duration](https://protobuf.dev/reference/protobuf/google.protobuf/#duration). `min_backoff` will be truncated to the nearest second. This field has the same meaning as [min_backoff_seconds in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). + "maxRetryDuration": "A String", # If positive, `max_retry_duration` specifies the time limit for retrying a failed task, measured from when the task was first attempted. Once `max_retry_duration` time has passed *and* the task has been attempted max_attempts times, no further attempts are made and the task is deleted. A zero (0) indicates an unlimited duration, up to the [maximum task retention](https://docs.cloud.google.com/tasks/docs/quotas#limits) limit. The value must be given as a string that indicates the length of time (in seconds) followed by `s` (for "seconds"). For the maximum possible value or the format, see the documentation for [Duration](https://protobuf.dev/reference/protobuf/google.protobuf/#duration). `max_retry_duration` will be truncated to the nearest second. If unspecified when the queue is created, Cloud Tasks will pick the default. This field has the same meaning as [task_age_limit in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). + "minBackoff": "A String", # A task will be scheduled for retry between min_backoff and max_backoff duration after it fails, if the queue's RetryConfig specifies that the task should be retried. The value must be given as a string that indicates the length of time (in seconds) followed by `s` (for "seconds"). For more information on the format, see the documentation for [Duration](https://protobuf.dev/reference/protobuf/google.protobuf/#duration). `min_backoff` will be truncated to the nearest second. If unspecified when the queue is created, Cloud Tasks will pick the default. This field has the same meaning as [min_backoff_seconds in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). }, "stackdriverLoggingConfig": { # Configuration options for writing logs to [Stackdriver Logging](https://cloud.google.com/logging/docs/). # Configuration options for writing logs to [Stackdriver Logging](https://cloud.google.com/logging/docs/). If this field is unset, then no logs are written. "samplingRatio": 3.14, # Specifies the fraction of operations to write to [Stackdriver Logging](https://cloud.google.com/logging/docs/). This field may contain any value between 0.0 and 1.0, inclusive. 0.0 is the default and means that no operations are logged. @@ -943,14 +943,14 @@

Method Details

"rateLimits": { # Rate limits. This message determines the maximum rate that tasks can be dispatched by a queue, regardless of whether the dispatch is a first task attempt or a retry. Note: The debugging command, RunTask, will run a task even if the queue has reached its RateLimits. # Rate limits for task dispatches. rate_limits and retry_config are related because they both control task attempts. However they control task attempts in different ways: * rate_limits controls the total rate of dispatches from a queue (i.e. all traffic dispatched from the queue, regardless of whether the dispatch is from a first attempt or a retry). * retry_config controls what happens to particular a task after its first attempt fails. That is, retry_config controls task retries (the second attempt, third attempt, etc). The queue's actual dispatch rate is the result of: * Number of tasks in the queue * User-specified throttling: rate_limits, retry_config, and the queue's state. * System throttling due to `429` (Too Many Requests) or `503` (Service Unavailable) responses from the worker, high error rates, or to smooth sudden large traffic spikes. "maxBurstSize": 42, # The max burst size. Max burst size limits how fast tasks in queue are processed when many tasks are in the queue and the rate is high. This field allows the queue to have a high rate so processing starts shortly after a task is enqueued, but still limits resource usage when many tasks are enqueued in a short period of time. The [token bucket](https://wikipedia.org/wiki/Token_Bucket) algorithm is used to control the rate of task dispatches. Each queue has a token bucket that holds tokens, up to the maximum specified by `max_burst_size`. Each time a task is dispatched, a token is removed from the bucket. Tasks will be dispatched until the queue's bucket runs out of tokens. The bucket will be continuously refilled with new tokens based on max_dispatches_per_second. The default value of `max_burst_size` is picked by Cloud Tasks based on the value of max_dispatches_per_second. The maximum value of `max_burst_size` is 500. For App Engine queues that were created or updated using `queue.yaml/xml`, `max_burst_size` is equal to [bucket_size](https://cloud.google.com/appengine/docs/standard/python/config/queueref#bucket_size). If UpdateQueue is called on a queue without explicitly setting a value for `max_burst_size`, `max_burst_size` value will get updated if UpdateQueue is updating max_dispatches_per_second. "maxConcurrentDispatches": 42, # The maximum number of concurrent tasks that Cloud Tasks allows to be dispatched for this queue. After this threshold has been reached, Cloud Tasks stops dispatching tasks until the number of concurrent requests decreases. If unspecified when the queue is created, Cloud Tasks will pick the default. The maximum allowed value is 5,000. This field has the same meaning as [max_concurrent_requests in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#max_concurrent_requests). - "maxDispatchesPerSecond": 3.14, # The maximum rate at which tasks are dispatched from this queue. If unspecified when the queue is created, Cloud Tasks will pick the default. * For App Engine queues, the maximum allowed value is 500. This field has the same meaning as [rate in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#rate). + "maxDispatchesPerSecond": 3.14, # The maximum rate at which tasks are dispatched from this queue. If unspecified when the queue is created, Cloud Tasks will pick the default. For App Engine queues, the maximum allowed value is 500. This field has the same meaning as [rate in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#rate). }, "retryConfig": { # Retry config. These settings determine when a failed task attempt is retried. # Settings that determine the retry behavior. * For tasks created using Cloud Tasks: the queue-level retry settings apply to all tasks in the queue that were created using Cloud Tasks. Retry settings cannot be set on individual tasks. * For tasks created using the App Engine SDK: the queue-level retry settings apply to all tasks in the queue which do not have retry settings explicitly set on the task and were created by the App Engine SDK. See [App Engine documentation](https://cloud.google.com/appengine/docs/standard/python/taskqueue/push/retrying-tasks). - "maxAttempts": 42, # Number of attempts per task. Cloud Tasks will attempt the task `max_attempts` times (that is, if the first attempt fails, then there will be `max_attempts - 1` retries). Must be >= -1. If unspecified when the queue is created, Cloud Tasks will pick the default. -1 indicates unlimited attempts. This field has the same meaning as [task_retry_limit in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). Note: Cloud Tasks stops retrying only when `max_attempts` and `max_retry_duration` are both satisfied. When the task has been attempted `max_attempts` times and when the `max_retry_duration` time has passed, no further attempts are made, and the task is deleted. If you want your task to retry infinitely, you must set `max_attempts` to -1 and `max_retry_duration` to 0. - "maxBackoff": "A String", # A task will be scheduled for retry between min_backoff and max_backoff duration after it fails, if the queue's RetryConfig specifies that the task should be retried. If unspecified when the queue is created, Cloud Tasks will pick the default. The value must be given as a string that indicates the length of time (in seconds) followed by `s` (for "seconds"). For more information on the format, see the documentation for [Duration](https://protobuf.dev/reference/protobuf/google.protobuf/#duration). `max_backoff` will be truncated to the nearest second. This field has the same meaning as [max_backoff_seconds in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). + "maxAttempts": 42, # Number of attempts per task, including the first attempt. (If the first attempt fails, there will be `max_attempts - 1` retries.) Must be greater than or equal to -1, which indicates unlimited attempts. Cloud Tasks stops retrying only when `max_attempts` and `max_retry_duration` are both satisfied, or when the task is successfully executed. When the task has been attempted `max_attempts` times and when the `max_retry_duration` time has passed, no further attempts are made, and the task is deleted. If `max_attempts` is set to -1 and `max_retry_duration` is set to 0, the task is retried until the [maximum task retention](https://docs.cloud.google.com/tasks/docs/quotas#limits) limit is reached. If unspecified when the queue is created, Cloud Tasks will pick the default. This field has the same meaning as [task_retry_limit in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). + "maxBackoff": "A String", # A task will be scheduled for retry between min_backoff and max_backoff duration after it fails, if the queue's RetryConfig specifies that the task should be retried. The value must be given as a string that indicates the length of time (in seconds) followed by `s` (for "seconds"). For more information on the format, see the documentation for [Duration](https://protobuf.dev/reference/protobuf/google.protobuf/#duration). `max_backoff` will be truncated to the nearest second. If unspecified when the queue is created, Cloud Tasks will pick the default. This field has the same meaning as [max_backoff_seconds in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). "maxDoublings": 42, # The time between retries will double `max_doublings` times. A task's retry interval starts at min_backoff, then doubles `max_doublings` times, then increases linearly, and finally retries at intervals of max_backoff up to max_attempts times. For example, if min_backoff is 10s, max_backoff is 300s, and `max_doublings` is 3, then the a task will first be retried in 10s. The retry interval will double three times, and then increase linearly by 2^3 * 10s. Finally, the task will retry at intervals of max_backoff until the task has been attempted max_attempts times. Thus, the requests will retry at 10s, 20s, 40s, 80s, 160s, 240s, 300s, 300s, .... If unspecified when the queue is created, Cloud Tasks will pick the default. This field has the same meaning as [max_doublings in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). - "maxRetryDuration": "A String", # If positive, `max_retry_duration` specifies the time limit for retrying a failed task, measured from when the task was first attempted. Once `max_retry_duration` time has passed *and* the task has been attempted max_attempts times, no further attempts will be made and the task will be deleted. If zero, then the task age is unlimited. If unspecified when the queue is created, Cloud Tasks will pick the default. The value must be given as a string that indicates the length of time (in seconds) followed by `s` (for "seconds"). For the maximum possible value or the format, see the documentation for [Duration](https://protobuf.dev/reference/protobuf/google.protobuf/#duration). `max_retry_duration` will be truncated to the nearest second. This field has the same meaning as [task_age_limit in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). - "minBackoff": "A String", # A task will be scheduled for retry between min_backoff and max_backoff duration after it fails, if the queue's RetryConfig specifies that the task should be retried. If unspecified when the queue is created, Cloud Tasks will pick the default. The value must be given as a string that indicates the length of time (in seconds) followed by `s` (for "seconds"). For more information on the format, see the documentation for [Duration](https://protobuf.dev/reference/protobuf/google.protobuf/#duration). `min_backoff` will be truncated to the nearest second. This field has the same meaning as [min_backoff_seconds in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). + "maxRetryDuration": "A String", # If positive, `max_retry_duration` specifies the time limit for retrying a failed task, measured from when the task was first attempted. Once `max_retry_duration` time has passed *and* the task has been attempted max_attempts times, no further attempts are made and the task is deleted. A zero (0) indicates an unlimited duration, up to the [maximum task retention](https://docs.cloud.google.com/tasks/docs/quotas#limits) limit. The value must be given as a string that indicates the length of time (in seconds) followed by `s` (for "seconds"). For the maximum possible value or the format, see the documentation for [Duration](https://protobuf.dev/reference/protobuf/google.protobuf/#duration). `max_retry_duration` will be truncated to the nearest second. If unspecified when the queue is created, Cloud Tasks will pick the default. This field has the same meaning as [task_age_limit in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). + "minBackoff": "A String", # A task will be scheduled for retry between min_backoff and max_backoff duration after it fails, if the queue's RetryConfig specifies that the task should be retried. The value must be given as a string that indicates the length of time (in seconds) followed by `s` (for "seconds"). For more information on the format, see the documentation for [Duration](https://protobuf.dev/reference/protobuf/google.protobuf/#duration). `min_backoff` will be truncated to the nearest second. If unspecified when the queue is created, Cloud Tasks will pick the default. This field has the same meaning as [min_backoff_seconds in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). }, "stackdriverLoggingConfig": { # Configuration options for writing logs to [Stackdriver Logging](https://cloud.google.com/logging/docs/). # Configuration options for writing logs to [Stackdriver Logging](https://cloud.google.com/logging/docs/). If this field is unset, then no logs are written. "samplingRatio": 3.14, # Specifies the fraction of operations to write to [Stackdriver Logging](https://cloud.google.com/logging/docs/). This field may contain any value between 0.0 and 1.0, inclusive. 0.0 is the default and means that no operations are logged. diff --git a/docs/dyn/composer_v1beta1.projects.locations.environments.userWorkloadsSecrets.html b/docs/dyn/composer_v1beta1.projects.locations.environments.userWorkloadsSecrets.html index 2fc09929c5..0bb879987c 100644 --- a/docs/dyn/composer_v1beta1.projects.locations.environments.userWorkloadsSecrets.html +++ b/docs/dyn/composer_v1beta1.projects.locations.environments.userWorkloadsSecrets.html @@ -115,6 +115,7 @@

Method Details

"a_key": "A String", }, "name": "A String", # Identifier. The resource name of the Secret, in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}/userWorkloadsSecrets/{userWorkloadsSecretId}" + "type": "A String", # Optional. The "type" field of Kubernetes Secret. For details see: https://kubernetes.io/docs/concepts/configuration/secret/#secret-types } x__xgafv: string, V1 error format. @@ -130,6 +131,7 @@

Method Details

"a_key": "A String", }, "name": "A String", # Identifier. The resource name of the Secret, in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}/userWorkloadsSecrets/{userWorkloadsSecretId}" + "type": "A String", # Optional. The "type" field of Kubernetes Secret. For details see: https://kubernetes.io/docs/concepts/configuration/secret/#secret-types }
@@ -170,6 +172,7 @@

Method Details

"a_key": "A String", }, "name": "A String", # Identifier. The resource name of the Secret, in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}/userWorkloadsSecrets/{userWorkloadsSecretId}" + "type": "A String", # Optional. The "type" field of Kubernetes Secret. For details see: https://kubernetes.io/docs/concepts/configuration/secret/#secret-types }
@@ -197,6 +200,7 @@

Method Details

"a_key": "A String", }, "name": "A String", # Identifier. The resource name of the Secret, in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}/userWorkloadsSecrets/{userWorkloadsSecretId}" + "type": "A String", # Optional. The "type" field of Kubernetes Secret. For details see: https://kubernetes.io/docs/concepts/configuration/secret/#secret-types }, ], }
@@ -230,6 +234,7 @@

Method Details

"a_key": "A String", }, "name": "A String", # Identifier. The resource name of the Secret, in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}/userWorkloadsSecrets/{userWorkloadsSecretId}" + "type": "A String", # Optional. The "type" field of Kubernetes Secret. For details see: https://kubernetes.io/docs/concepts/configuration/secret/#secret-types } x__xgafv: string, V1 error format. @@ -245,6 +250,7 @@

Method Details

"a_key": "A String", }, "name": "A String", # Identifier. The resource name of the Secret, in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}/userWorkloadsSecrets/{userWorkloadsSecretId}" + "type": "A String", # Optional. The "type" field of Kubernetes Secret. For details see: https://kubernetes.io/docs/concepts/configuration/secret/#secret-types }
diff --git a/docs/dyn/compute_alpha.backendServices.html b/docs/dyn/compute_alpha.backendServices.html index 248ce180e5..7e8f9898e2 100644 --- a/docs/dyn/compute_alpha.backendServices.html +++ b/docs/dyn/compute_alpha.backendServices.html @@ -1459,6 +1459,16 @@

Method Details

# backend service. "enable": True or False, # Denotes whether to enable logging for the load balancer # traffic served by this backend service. The default value is false. + "loggingHttpRequestHeaders": [ # The list of request headers that will be logged to Stackdriver. + { # Determines which HTTP headers will be logged to Stackdriver. + "headerName": "A String", # The name of the header to be logged. + }, + ], + "loggingHttpResponseHeaders": [ # The list of response headers that will be logged to Stackdriver. + { # Determines which HTTP headers will be logged to Stackdriver. + "headerName": "A String", # The name of the header to be logged. + }, + ], "optional": "A String", # Deprecated in favor of optionalMode. # This field can only be specified if logging is enabled for this backend # service. Configures whether all, none or a subset of optional fields @@ -3899,6 +3909,16 @@

Method Details

# backend service. "enable": True or False, # Denotes whether to enable logging for the load balancer # traffic served by this backend service. The default value is false. + "loggingHttpRequestHeaders": [ # The list of request headers that will be logged to Stackdriver. + { # Determines which HTTP headers will be logged to Stackdriver. + "headerName": "A String", # The name of the header to be logged. + }, + ], + "loggingHttpResponseHeaders": [ # The list of response headers that will be logged to Stackdriver. + { # Determines which HTTP headers will be logged to Stackdriver. + "headerName": "A String", # The name of the header to be logged. + }, + ], "optional": "A String", # Deprecated in favor of optionalMode. # This field can only be specified if logging is enabled for this backend # service. Configures whether all, none or a subset of optional fields @@ -6861,6 +6881,16 @@

Method Details

# backend service. "enable": True or False, # Denotes whether to enable logging for the load balancer # traffic served by this backend service. The default value is false. + "loggingHttpRequestHeaders": [ # The list of request headers that will be logged to Stackdriver. + { # Determines which HTTP headers will be logged to Stackdriver. + "headerName": "A String", # The name of the header to be logged. + }, + ], + "loggingHttpResponseHeaders": [ # The list of response headers that will be logged to Stackdriver. + { # Determines which HTTP headers will be logged to Stackdriver. + "headerName": "A String", # The name of the header to be logged. + }, + ], "optional": "A String", # Deprecated in favor of optionalMode. # This field can only be specified if logging is enabled for this backend # service. Configures whether all, none or a subset of optional fields @@ -8999,6 +9029,16 @@

Method Details

# backend service. "enable": True or False, # Denotes whether to enable logging for the load balancer # traffic served by this backend service. The default value is false. + "loggingHttpRequestHeaders": [ # The list of request headers that will be logged to Stackdriver. + { # Determines which HTTP headers will be logged to Stackdriver. + "headerName": "A String", # The name of the header to be logged. + }, + ], + "loggingHttpResponseHeaders": [ # The list of response headers that will be logged to Stackdriver. + { # Determines which HTTP headers will be logged to Stackdriver. + "headerName": "A String", # The name of the header to be logged. + }, + ], "optional": "A String", # Deprecated in favor of optionalMode. # This field can only be specified if logging is enabled for this backend # service. Configures whether all, none or a subset of optional fields @@ -10885,6 +10925,16 @@

Method Details

# backend service. "enable": True or False, # Denotes whether to enable logging for the load balancer # traffic served by this backend service. The default value is false. + "loggingHttpRequestHeaders": [ # The list of request headers that will be logged to Stackdriver. + { # Determines which HTTP headers will be logged to Stackdriver. + "headerName": "A String", # The name of the header to be logged. + }, + ], + "loggingHttpResponseHeaders": [ # The list of response headers that will be logged to Stackdriver. + { # Determines which HTTP headers will be logged to Stackdriver. + "headerName": "A String", # The name of the header to be logged. + }, + ], "optional": "A String", # Deprecated in favor of optionalMode. # This field can only be specified if logging is enabled for this backend # service. Configures whether all, none or a subset of optional fields @@ -12714,6 +12764,16 @@

Method Details

# backend service. "enable": True or False, # Denotes whether to enable logging for the load balancer # traffic served by this backend service. The default value is false. + "loggingHttpRequestHeaders": [ # The list of request headers that will be logged to Stackdriver. + { # Determines which HTTP headers will be logged to Stackdriver. + "headerName": "A String", # The name of the header to be logged. + }, + ], + "loggingHttpResponseHeaders": [ # The list of response headers that will be logged to Stackdriver. + { # Determines which HTTP headers will be logged to Stackdriver. + "headerName": "A String", # The name of the header to be logged. + }, + ], "optional": "A String", # Deprecated in favor of optionalMode. # This field can only be specified if logging is enabled for this backend # service. Configures whether all, none or a subset of optional fields @@ -16274,6 +16334,16 @@

Method Details

# backend service. "enable": True or False, # Denotes whether to enable logging for the load balancer # traffic served by this backend service. The default value is false. + "loggingHttpRequestHeaders": [ # The list of request headers that will be logged to Stackdriver. + { # Determines which HTTP headers will be logged to Stackdriver. + "headerName": "A String", # The name of the header to be logged. + }, + ], + "loggingHttpResponseHeaders": [ # The list of response headers that will be logged to Stackdriver. + { # Determines which HTTP headers will be logged to Stackdriver. + "headerName": "A String", # The name of the header to be logged. + }, + ], "optional": "A String", # Deprecated in favor of optionalMode. # This field can only be specified if logging is enabled for this backend # service. Configures whether all, none or a subset of optional fields diff --git a/docs/dyn/compute_alpha.folderZoneVmExtensionPolicies.html b/docs/dyn/compute_alpha.folderZoneVmExtensionPolicies.html new file mode 100644 index 0000000000..4892272bed --- /dev/null +++ b/docs/dyn/compute_alpha.folderZoneVmExtensionPolicies.html @@ -0,0 +1,1605 @@ + + + +

Compute Engine API . folderZoneVmExtensionPolicies

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ delete(folder, zone, vmExtensionPolicy, requestId=None, x__xgafv=None)

+

Deletes a specified zone VM extension policy within a folder.

+

+ get(folder, zone, vmExtensionPolicy, x__xgafv=None)

+

Retrieves details of a specific zone VM extension policy within a folder.

+

+ getVmExtension(folder, zone, extensionName, x__xgafv=None)

+

Retrieves details of a specific VM extension within a folder.

+

+ insert(folder, zone, body=None, requestId=None, x__xgafv=None)

+

Creates a new zone-level VM extension policy within a folder.

+

+ list(folder, zone, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

+

Lists all VM extension policies within a specific zone for a folder.

+

+ listVmExtensions(folder, zone, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

+

Lists all VM extensions within a specific zone for a folder.

+

+ listVmExtensions_next()

+

Retrieves the next page of results.

+

+ list_next()

+

Retrieves the next page of results.

+

+ update(folder, zone, vmExtensionPolicy, body=None, requestId=None, x__xgafv=None)

+

Modifies an existing zone VM extension policy within a folder.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ delete(folder, zone, vmExtensionPolicy, requestId=None, x__xgafv=None) +
Deletes a specified zone VM extension policy within a folder.
+
+Args:
+  folder: string, Folder ID for this request. (required)
+  zone: string, Name of the zone for this request. (required)
+  vmExtensionPolicy: string, Name of the zone VM extension policy to delete. (required)
+  requestId: string, An optional request ID to identify requests. Specify a unique request ID so
+that if you must retry your request, the server will know to ignore the
+request if it has already been completed.
+
+For example, consider a situation where you make an initial request and
+the request times out. If you make the request again with the same
+request ID, the server can check if original operation with the same
+request ID was received, and if so, will ignore the second request. This
+prevents clients from accidentally creating duplicate commitments.
+
+The request ID must be
+a valid UUID with the exception that zero UUID is not supported
+(00000000-0000-0000-0000-000000000000).
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Represents an Operation resource.
+    #
+    # Google Compute Engine has three Operation resources:
+    #
+    # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
+    # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
+    # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
+    #
+    # You can use an operation resource to manage asynchronous API requests.
+    # For more information, readHandling
+    # API responses.
+    #
+    # Operations can be global, regional or zonal.
+    #
+    #    - For global operations, use the `globalOperations`
+    #    resource.
+    #    - For regional operations, use the
+    #    `regionOperations` resource.
+    #    - For zonal operations, use
+    #    the `zoneOperations` resource.
+    #
+    #
+    #
+    # For more information, read
+    # Global, Regional, and Zonal Resources.
+    #
+    # Note that completed Operation resources have a limited
+    # retention period.
+  "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request.
+      # Not present otherwise.
+  "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
+  "description": "A String", # [Output Only] A textual description of the operation, which is
+      # set when the operation is created.
+  "endTime": "A String", # [Output Only] The time that this operation was completed. This value is inRFC3339
+      # text format.
+  "error": { # [Output Only] If errors are generated during processing of the operation,
+      # this field will be populated.
+    "errors": [ # [Output Only] The array of errors encountered while processing this
+        # operation.
+      {
+        "code": "A String", # [Output Only] The error type identifier for this error.
+        "errorDetails": [ # [Output Only] An optional list of messages that contain the error
+            # details. There is a set of defined message types to use for providing
+            # details.The syntax depends on the error code. For example,
+            # QuotaExceededInfo will have details when the error code is
+            # QUOTA_EXCEEDED.
+          {
+            "errorInfo": { # Describes the cause of the error with structured details.
+                #
+                # Example of an error when contacting the "pubsub.googleapis.com" API when it
+                # is not enabled:
+                #
+                #     { "reason": "API_DISABLED"
+                #       "domain": "googleapis.com"
+                #       "metadata": {
+                #         "resource": "projects/123",
+                #         "service": "pubsub.googleapis.com"
+                #       }
+                #     }
+                #
+                # This response indicates that the pubsub.googleapis.com API is not enabled.
+                #
+                # Example of an error that is returned when attempting to create a Spanner
+                # instance in a region that is out of stock:
+                #
+                #     { "reason": "STOCKOUT"
+                #       "domain": "spanner.googleapis.com",
+                #       "metadata": {
+                #         "availableRegions": "us-central1,us-east2"
+                #       }
+                #     }
+              "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain
+                  # is typically the registered service name of the tool or product that
+                  # generates the error. Example: "pubsub.googleapis.com". If the error is
+                  # generated by some common infrastructure, the error domain must be a
+                  # globally unique value that identifies the infrastructure. For Google API
+                  # infrastructure, the error domain is "googleapis.com".
+              "metadatas": { # Additional structured details about this error.
+                  #
+                  # Keys must match a regular expression of `a-z+` but should
+                  # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
+                  # length. When identifying the current value of an exceeded limit, the units
+                  # should be contained in the key, not the value.  For example, rather than
+                  # `{"instanceLimit": "100/request"}`, should be returned as,
+                  # `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of
+                  # instances that can be created in a single (batch) request.
+                "a_key": "A String",
+              },
+              "reason": "A String", # The reason of the error. This is a constant value that identifies the
+                  # proximate cause of the error. Error reasons are unique within a particular
+                  # domain of errors. This should be at most 63 characters and match a
+                  # regular expression of `A-Z+[A-Z0-9]`, which represents
+                  # UPPER_SNAKE_CASE.
+            },
+            "help": { # Provides links to documentation or for performing an out of band action.
+                #
+                # For example, if a quota check failed with an error indicating the calling
+                # project hasn't enabled the accessed service, this can contain a URL pointing
+                # directly to the right place in the developer console to flip the bit.
+              "links": [ # URL(s) pointing to additional information on handling the current error.
+                { # Describes a URL link.
+                  "description": "A String", # Describes what the link offers.
+                  "url": "A String", # The URL of the link.
+                },
+              ],
+            },
+            "localizedMessage": { # Provides a localized error message that is safe to return to the user
+                # which can be attached to an RPC error.
+              "locale": "A String", # The locale used following the specification defined at
+                  # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
+                  # Examples are: "en-US", "fr-CH", "es-MX"
+              "message": "A String", # The localized error message in the above locale.
+            },
+            "quotaInfo": { # Additional details for quota exceeded error for resource quota.
+              "dimensions": { # The map holding related quota dimensions.
+                "a_key": "A String",
+              },
+              "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota
+                  #  type or metric.
+              "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type
+                  # or metric.
+              "limitName": "A String", # The name of the quota limit.
+              "metricName": "A String", # The Compute Engine quota metric name.
+              "rolloutStatus": "A String", # Rollout status of the future quota limit.
+            },
+          },
+        ],
+        "location": "A String", # [Output Only] Indicates the field in the request that caused the error.
+            # This property is optional.
+        "message": "A String", # [Output Only] An optional, human-readable error message.
+      },
+    ],
+  },
+  "getVersionOperationMetadata": {
+    "inlineSbomInfo": {
+      "currentComponentVersions": { # A mapping of components to their currently-applied versions or other
+          # appropriate identifiers.
+        "a_key": "A String",
+      },
+      "targetComponentVersions": { # A mapping of components to their target versions or other appropriate
+          # identifiers.
+        "a_key": "A String",
+      },
+    },
+  },
+  "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
+      # message that was returned, such as `NOT FOUND`.
+  "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
+      # status code that was returned. For example, a `404` means the
+      # resource was not found.
+  "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is
+      # defined by the server.
+  "insertTime": "A String", # [Output Only] The time that this operation was requested.
+      # This value is inRFC3339
+      # text format.
+  "instancesBulkInsertOperationMetadata": {
+    "perLocationStatus": { # Status information per location (location name is key).
+        # Example key: zones/us-central1-a
+      "a_key": {
+        "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far.
+        "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback.
+        "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an
+            # error.
+        "status": "A String", # [Output Only] Creation status of BulkInsert operation - information
+            # if the flow is rolling forward or rolling back.
+        "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created.
+      },
+    },
+  },
+  "kind": "compute#operation", # Output only. [Output Only] Type of the resource. Always `compute#operation` for
+      # Operation resources.
+  "name": "A String", # [Output Only] Name of the operation.
+  "operationGroupId": "A String", # Output only. [Output Only] An ID that represents a group of operations, such as when a
+      # group of operations results from a `bulkInsert` API request.
+  "operationType": "A String", # [Output Only] The type of operation, such as `insert`,
+      # `update`, or `delete`, and so on.
+  "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
+      # There is no requirement that this be linear or support any granularity of
+      # operations. This should not be used to guess when the operation will be
+      # complete. This number should monotonically increase as the operation
+      # progresses.
+  "region": "A String", # [Output Only] The URL of the region where the operation resides. Only
+      # applicable when performing regional operations.
+  "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+  "selfLinkWithId": "A String", # Output only. [Output Only] Server-defined URL for this resource with the resource id.
+  "setCommonInstanceMetadataOperationMetadata": { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
+      # this field will contain information on all underlying zonal actions and
+      # their state.
+    "clientOperationId": "A String", # [Output Only] The client operation id.
+    "perLocationOperations": { # [Output Only] Status information per location (location name is key).
+        # Example key: zones/us-central1-a
+      "a_key": {
+        "error": { # The `Status` type defines a logical error model that is suitable for # [Output Only] If state is `ABANDONED` or `FAILED`, this field is
+            # populated.
+            # different programming environments, including REST APIs and RPC APIs. It is
+            # used by [gRPC](https://github.com/grpc). Each `Status` message contains
+            # three pieces of data: error code, error message, and error details.
+            #
+            # You can find out more about this error model and how to work with it in the
+            # [API Design Guide](https://cloud.google.com/apis/design/errors).
+          "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+          "details": [ # A list of messages that carry the error details.  There is a common set of
+              # message types for APIs to use.
+            {
+              "a_key": "", # Properties of the object. Contains field @type with type URL.
+            },
+          ],
+          "message": "A String", # A developer-facing error message, which should be in English. Any
+              # user-facing error message should be localized and sent in the
+              # google.rpc.Status.details field, or localized by the client.
+        },
+        "state": "A String", # [Output Only] Status of the action, which can be one of the following:
+            # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
+      },
+    },
+  },
+  "startTime": "A String", # [Output Only] The time that this operation was started by the server.
+      # This value is inRFC3339
+      # text format.
+  "status": "A String", # [Output Only] The status of the operation, which can be one of the
+      # following:
+      # `PENDING`, `RUNNING`, or `DONE`.
+  "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the
+      # operation.
+  "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation
+      # of the target resource.
+  "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For
+      # operations related to creating a snapshot, this points to the disk
+      # that the snapshot was created from.
+  "user": "A String", # [Output Only] User who requested the operation, for example:
+      # `user@example.com` or
+      # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
+  "warnings": [ # [Output Only] If warning messages are generated during processing of the
+      # operation, this field will be populated.
+    {
+      "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute
+          # Engine returns NO_RESULTS_ON_PAGE if there
+          # are no results in the response.
+      "data": [ # [Output Only] Metadata about this warning in key:
+          # value format. For example:
+          #
+          # "data": [
+          #   {
+          #    "key": "scope",
+          #    "value": "zones/us-east1-d"
+          #   }
+        {
+          "key": "A String", # [Output Only] A key that provides more detail on the warning being
+              # returned. For example, for warnings where there are no results in a list
+              # request for a particular zone, this key might be scope and
+              # the key value might be the zone name. Other examples might be a key
+              # indicating a deprecated resource and a suggested replacement, or a
+              # warning about invalid network settings (for example, if an instance
+              # attempts to perform IP forwarding but is not enabled for IP forwarding).
+          "value": "A String", # [Output Only] A warning data value corresponding to the key.
+        },
+      ],
+      "message": "A String", # [Output Only] A human-readable description of the warning code.
+    },
+  ],
+  "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only
+      # applicable when performing per-zone operations.
+}
+
+ +
+ get(folder, zone, vmExtensionPolicy, x__xgafv=None) +
Retrieves details of a specific zone VM extension policy within a folder.
+
+Args:
+  folder: string, Folder ID for this request. (required)
+  zone: string, Name of the zone for this request. (required)
+  vmExtensionPolicy: string, Name of the VM extension policy resource to return. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Represents a VM extension policy.
+  "creationTimestamp": "A String", # Output only. [Output Only] Creation timestamp inRFC3339
+      # text format.
+  "description": "A String", # An optional description of this resource.
+  "extensionPolicies": { # Required. A map of extension names (for example, "ops-agent") to their corresponding
+      # policy configurations.
+    "a_key": { # Configuration for a specific VM extension.
+      "pinnedVersion": "A String", # Optional. The specific version of the extension to install. If not set, the latest
+          # version is used.
+      "stringConfig": "A String", # Optional. String-based configuration data for the extension.
+    },
+  },
+  "globalResourceLink": "A String", # Optional. Output only. [Output Only] Link to the global policy that manages this zone policy, if
+      # applicable.
+  "id": "A String", # Output only. [Output Only] The unique identifier for the resource. This identifier is
+      # defined by the server.
+  "instanceSelectors": [ # Optional. Selectors to target VMs for this policy. VMs are selected if they match
+      # *any* of the provided selectors (logical OR). If this list is empty, the
+      # policy applies to all VMs.
+    { # Defines how to select VMs to apply a zone VM extension policy.
+      "labelSelector": { # A LabelSelector is applied to a VM only if it matches all the specified # Optional. LabelSelector selects VMs based on their labels.
+          # labels.
+        "inclusionLabels": { # Optional. A map of key-value pairs representing VM labels.
+            # VMs must have all of the labels specified in this map to be selected
+            # (logical AND).
+            #
+            # e.g. If the `inclusion_labels` are {("key1", "value1"), ("key2",
+            # "value2")}, the VM labels must contain both ("key1", "value1") and
+            # ("key2", "value2") to be selected. If the VM labels are ("key1",
+            # "value1") and ("something", "else"), it will not be selected.
+            #
+            # If the map is empty, it's considered a match.
+          "a_key": "A String",
+        },
+      },
+    },
+  ],
+  "kind": "compute#vmExtensionPolicy", # Output only. [Output Only] Type of the resource. Alwayscompute#vmExtensionPolicy.
+  "managedByGlobal": True or False, # Optional. Output only. [Output Only] Indicates if this policy is managed by a global policy.
+  "name": "A String", # Name of the resource. Provided by the client when the resource is created.
+      # The name must be 1-63 characters long, and comply withRFC1035.
+      # Specifically, the name must be 1-63 characters long and match the regular
+      # expression `[a-z]([-a-z0-9]*[a-z0-9])?`
+      # which means the first character must be a lowercase letter, and all
+      # following characters must be a dash, lowercase letter, or digit, except
+      # the last character, which cannot be a dash.
+  "priority": 42, # Optional. Priority of this policy. Used to resolve conflicts when multiple policies
+      # apply to the same extension.
+      # The policy priority is an integer from 0 to 65535, inclusive. Lower
+      # integers indicate higher priorities. If you do not specify a priority when
+      # creating a rule, it is assigned a priority of 1000. If priorities are
+      # equal, the policy with the most recent creation timestamp takes precedence.
+  "selfLink": "A String", # Output only. [Output Only] Server-defined fully-qualified URL for this resource.
+  "selfLinkWithId": "A String", # Output only. [Output Only] Server-defined URL for this resource's resource id.
+  "state": "A String", # Optional. Output only. [Output Only] Current state of the policy: ACTIVE or DELETING.
+  "updateTimestamp": "A String", # Output only. [Output Only] Update timestamp inRFC3339
+      # text format.
+}
+
+ +
+ getVmExtension(folder, zone, extensionName, x__xgafv=None) +
Retrieves details of a specific VM extension within a folder.
+
+Args:
+  folder: string, Folder ID for this request. (required)
+  zone: string, Name of the zone for this request. (required)
+  extensionName: string, A parameter (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A VM extension that can be installed on a VM.
+  "name": "A String", # The name of the vm extension.
+  "versions": [ # The latest 10 versions of the vm extension.
+    "A String",
+  ],
+}
+
+ +
+ insert(folder, zone, body=None, requestId=None, x__xgafv=None) +
Creates a new zone-level VM extension policy within a folder.
+
+Args:
+  folder: string, Folder ID for this request. (required)
+  zone: string, Name of the zone for this request. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Represents a VM extension policy.
+  "creationTimestamp": "A String", # Output only. [Output Only] Creation timestamp inRFC3339
+      # text format.
+  "description": "A String", # An optional description of this resource.
+  "extensionPolicies": { # Required. A map of extension names (for example, "ops-agent") to their corresponding
+      # policy configurations.
+    "a_key": { # Configuration for a specific VM extension.
+      "pinnedVersion": "A String", # Optional. The specific version of the extension to install. If not set, the latest
+          # version is used.
+      "stringConfig": "A String", # Optional. String-based configuration data for the extension.
+    },
+  },
+  "globalResourceLink": "A String", # Optional. Output only. [Output Only] Link to the global policy that manages this zone policy, if
+      # applicable.
+  "id": "A String", # Output only. [Output Only] The unique identifier for the resource. This identifier is
+      # defined by the server.
+  "instanceSelectors": [ # Optional. Selectors to target VMs for this policy. VMs are selected if they match
+      # *any* of the provided selectors (logical OR). If this list is empty, the
+      # policy applies to all VMs.
+    { # Defines how to select VMs to apply a zone VM extension policy.
+      "labelSelector": { # A LabelSelector is applied to a VM only if it matches all the specified # Optional. LabelSelector selects VMs based on their labels.
+          # labels.
+        "inclusionLabels": { # Optional. A map of key-value pairs representing VM labels.
+            # VMs must have all of the labels specified in this map to be selected
+            # (logical AND).
+            #
+            # e.g. If the `inclusion_labels` are {("key1", "value1"), ("key2",
+            # "value2")}, the VM labels must contain both ("key1", "value1") and
+            # ("key2", "value2") to be selected. If the VM labels are ("key1",
+            # "value1") and ("something", "else"), it will not be selected.
+            #
+            # If the map is empty, it's considered a match.
+          "a_key": "A String",
+        },
+      },
+    },
+  ],
+  "kind": "compute#vmExtensionPolicy", # Output only. [Output Only] Type of the resource. Alwayscompute#vmExtensionPolicy.
+  "managedByGlobal": True or False, # Optional. Output only. [Output Only] Indicates if this policy is managed by a global policy.
+  "name": "A String", # Name of the resource. Provided by the client when the resource is created.
+      # The name must be 1-63 characters long, and comply withRFC1035.
+      # Specifically, the name must be 1-63 characters long and match the regular
+      # expression `[a-z]([-a-z0-9]*[a-z0-9])?`
+      # which means the first character must be a lowercase letter, and all
+      # following characters must be a dash, lowercase letter, or digit, except
+      # the last character, which cannot be a dash.
+  "priority": 42, # Optional. Priority of this policy. Used to resolve conflicts when multiple policies
+      # apply to the same extension.
+      # The policy priority is an integer from 0 to 65535, inclusive. Lower
+      # integers indicate higher priorities. If you do not specify a priority when
+      # creating a rule, it is assigned a priority of 1000. If priorities are
+      # equal, the policy with the most recent creation timestamp takes precedence.
+  "selfLink": "A String", # Output only. [Output Only] Server-defined fully-qualified URL for this resource.
+  "selfLinkWithId": "A String", # Output only. [Output Only] Server-defined URL for this resource's resource id.
+  "state": "A String", # Optional. Output only. [Output Only] Current state of the policy: ACTIVE or DELETING.
+  "updateTimestamp": "A String", # Output only. [Output Only] Update timestamp inRFC3339
+      # text format.
+}
+
+  requestId: string, An optional request ID to identify requests. Specify a unique request ID so
+that if you must retry your request, the server will know to ignore the
+request if it has already been completed.
+
+For example, consider a situation where you make an initial request and
+the request times out. If you make the request again with the same
+request ID, the server can check if original operation with the same
+request ID was received, and if so, will ignore the second request. This
+prevents clients from accidentally creating duplicate commitments.
+
+The request ID must be
+a valid UUID with the exception that zero UUID is not supported
+(00000000-0000-0000-0000-000000000000).
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Represents an Operation resource.
+    #
+    # Google Compute Engine has three Operation resources:
+    #
+    # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
+    # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
+    # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
+    #
+    # You can use an operation resource to manage asynchronous API requests.
+    # For more information, readHandling
+    # API responses.
+    #
+    # Operations can be global, regional or zonal.
+    #
+    #    - For global operations, use the `globalOperations`
+    #    resource.
+    #    - For regional operations, use the
+    #    `regionOperations` resource.
+    #    - For zonal operations, use
+    #    the `zoneOperations` resource.
+    #
+    #
+    #
+    # For more information, read
+    # Global, Regional, and Zonal Resources.
+    #
+    # Note that completed Operation resources have a limited
+    # retention period.
+  "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request.
+      # Not present otherwise.
+  "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
+  "description": "A String", # [Output Only] A textual description of the operation, which is
+      # set when the operation is created.
+  "endTime": "A String", # [Output Only] The time that this operation was completed. This value is inRFC3339
+      # text format.
+  "error": { # [Output Only] If errors are generated during processing of the operation,
+      # this field will be populated.
+    "errors": [ # [Output Only] The array of errors encountered while processing this
+        # operation.
+      {
+        "code": "A String", # [Output Only] The error type identifier for this error.
+        "errorDetails": [ # [Output Only] An optional list of messages that contain the error
+            # details. There is a set of defined message types to use for providing
+            # details.The syntax depends on the error code. For example,
+            # QuotaExceededInfo will have details when the error code is
+            # QUOTA_EXCEEDED.
+          {
+            "errorInfo": { # Describes the cause of the error with structured details.
+                #
+                # Example of an error when contacting the "pubsub.googleapis.com" API when it
+                # is not enabled:
+                #
+                #     { "reason": "API_DISABLED"
+                #       "domain": "googleapis.com"
+                #       "metadata": {
+                #         "resource": "projects/123",
+                #         "service": "pubsub.googleapis.com"
+                #       }
+                #     }
+                #
+                # This response indicates that the pubsub.googleapis.com API is not enabled.
+                #
+                # Example of an error that is returned when attempting to create a Spanner
+                # instance in a region that is out of stock:
+                #
+                #     { "reason": "STOCKOUT"
+                #       "domain": "spanner.googleapis.com",
+                #       "metadata": {
+                #         "availableRegions": "us-central1,us-east2"
+                #       }
+                #     }
+              "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain
+                  # is typically the registered service name of the tool or product that
+                  # generates the error. Example: "pubsub.googleapis.com". If the error is
+                  # generated by some common infrastructure, the error domain must be a
+                  # globally unique value that identifies the infrastructure. For Google API
+                  # infrastructure, the error domain is "googleapis.com".
+              "metadatas": { # Additional structured details about this error.
+                  #
+                  # Keys must match a regular expression of `a-z+` but should
+                  # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
+                  # length. When identifying the current value of an exceeded limit, the units
+                  # should be contained in the key, not the value.  For example, rather than
+                  # `{"instanceLimit": "100/request"}`, should be returned as,
+                  # `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of
+                  # instances that can be created in a single (batch) request.
+                "a_key": "A String",
+              },
+              "reason": "A String", # The reason of the error. This is a constant value that identifies the
+                  # proximate cause of the error. Error reasons are unique within a particular
+                  # domain of errors. This should be at most 63 characters and match a
+                  # regular expression of `A-Z+[A-Z0-9]`, which represents
+                  # UPPER_SNAKE_CASE.
+            },
+            "help": { # Provides links to documentation or for performing an out of band action.
+                #
+                # For example, if a quota check failed with an error indicating the calling
+                # project hasn't enabled the accessed service, this can contain a URL pointing
+                # directly to the right place in the developer console to flip the bit.
+              "links": [ # URL(s) pointing to additional information on handling the current error.
+                { # Describes a URL link.
+                  "description": "A String", # Describes what the link offers.
+                  "url": "A String", # The URL of the link.
+                },
+              ],
+            },
+            "localizedMessage": { # Provides a localized error message that is safe to return to the user
+                # which can be attached to an RPC error.
+              "locale": "A String", # The locale used following the specification defined at
+                  # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
+                  # Examples are: "en-US", "fr-CH", "es-MX"
+              "message": "A String", # The localized error message in the above locale.
+            },
+            "quotaInfo": { # Additional details for quota exceeded error for resource quota.
+              "dimensions": { # The map holding related quota dimensions.
+                "a_key": "A String",
+              },
+              "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota
+                  #  type or metric.
+              "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type
+                  # or metric.
+              "limitName": "A String", # The name of the quota limit.
+              "metricName": "A String", # The Compute Engine quota metric name.
+              "rolloutStatus": "A String", # Rollout status of the future quota limit.
+            },
+          },
+        ],
+        "location": "A String", # [Output Only] Indicates the field in the request that caused the error.
+            # This property is optional.
+        "message": "A String", # [Output Only] An optional, human-readable error message.
+      },
+    ],
+  },
+  "getVersionOperationMetadata": {
+    "inlineSbomInfo": {
+      "currentComponentVersions": { # A mapping of components to their currently-applied versions or other
+          # appropriate identifiers.
+        "a_key": "A String",
+      },
+      "targetComponentVersions": { # A mapping of components to their target versions or other appropriate
+          # identifiers.
+        "a_key": "A String",
+      },
+    },
+  },
+  "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
+      # message that was returned, such as `NOT FOUND`.
+  "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
+      # status code that was returned. For example, a `404` means the
+      # resource was not found.
+  "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is
+      # defined by the server.
+  "insertTime": "A String", # [Output Only] The time that this operation was requested.
+      # This value is inRFC3339
+      # text format.
+  "instancesBulkInsertOperationMetadata": {
+    "perLocationStatus": { # Status information per location (location name is key).
+        # Example key: zones/us-central1-a
+      "a_key": {
+        "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far.
+        "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback.
+        "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an
+            # error.
+        "status": "A String", # [Output Only] Creation status of BulkInsert operation - information
+            # if the flow is rolling forward or rolling back.
+        "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created.
+      },
+    },
+  },
+  "kind": "compute#operation", # Output only. [Output Only] Type of the resource. Always `compute#operation` for
+      # Operation resources.
+  "name": "A String", # [Output Only] Name of the operation.
+  "operationGroupId": "A String", # Output only. [Output Only] An ID that represents a group of operations, such as when a
+      # group of operations results from a `bulkInsert` API request.
+  "operationType": "A String", # [Output Only] The type of operation, such as `insert`,
+      # `update`, or `delete`, and so on.
+  "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
+      # There is no requirement that this be linear or support any granularity of
+      # operations. This should not be used to guess when the operation will be
+      # complete. This number should monotonically increase as the operation
+      # progresses.
+  "region": "A String", # [Output Only] The URL of the region where the operation resides. Only
+      # applicable when performing regional operations.
+  "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+  "selfLinkWithId": "A String", # Output only. [Output Only] Server-defined URL for this resource with the resource id.
+  "setCommonInstanceMetadataOperationMetadata": { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
+      # this field will contain information on all underlying zonal actions and
+      # their state.
+    "clientOperationId": "A String", # [Output Only] The client operation id.
+    "perLocationOperations": { # [Output Only] Status information per location (location name is key).
+        # Example key: zones/us-central1-a
+      "a_key": {
+        "error": { # The `Status` type defines a logical error model that is suitable for # [Output Only] If state is `ABANDONED` or `FAILED`, this field is
+            # populated.
+            # different programming environments, including REST APIs and RPC APIs. It is
+            # used by [gRPC](https://github.com/grpc). Each `Status` message contains
+            # three pieces of data: error code, error message, and error details.
+            #
+            # You can find out more about this error model and how to work with it in the
+            # [API Design Guide](https://cloud.google.com/apis/design/errors).
+          "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+          "details": [ # A list of messages that carry the error details.  There is a common set of
+              # message types for APIs to use.
+            {
+              "a_key": "", # Properties of the object. Contains field @type with type URL.
+            },
+          ],
+          "message": "A String", # A developer-facing error message, which should be in English. Any
+              # user-facing error message should be localized and sent in the
+              # google.rpc.Status.details field, or localized by the client.
+        },
+        "state": "A String", # [Output Only] Status of the action, which can be one of the following:
+            # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
+      },
+    },
+  },
+  "startTime": "A String", # [Output Only] The time that this operation was started by the server.
+      # This value is inRFC3339
+      # text format.
+  "status": "A String", # [Output Only] The status of the operation, which can be one of the
+      # following:
+      # `PENDING`, `RUNNING`, or `DONE`.
+  "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the
+      # operation.
+  "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation
+      # of the target resource.
+  "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For
+      # operations related to creating a snapshot, this points to the disk
+      # that the snapshot was created from.
+  "user": "A String", # [Output Only] User who requested the operation, for example:
+      # `user@example.com` or
+      # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
+  "warnings": [ # [Output Only] If warning messages are generated during processing of the
+      # operation, this field will be populated.
+    {
+      "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute
+          # Engine returns NO_RESULTS_ON_PAGE if there
+          # are no results in the response.
+      "data": [ # [Output Only] Metadata about this warning in key:
+          # value format. For example:
+          #
+          # "data": [
+          #   {
+          #    "key": "scope",
+          #    "value": "zones/us-east1-d"
+          #   }
+        {
+          "key": "A String", # [Output Only] A key that provides more detail on the warning being
+              # returned. For example, for warnings where there are no results in a list
+              # request for a particular zone, this key might be scope and
+              # the key value might be the zone name. Other examples might be a key
+              # indicating a deprecated resource and a suggested replacement, or a
+              # warning about invalid network settings (for example, if an instance
+              # attempts to perform IP forwarding but is not enabled for IP forwarding).
+          "value": "A String", # [Output Only] A warning data value corresponding to the key.
+        },
+      ],
+      "message": "A String", # [Output Only] A human-readable description of the warning code.
+    },
+  ],
+  "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only
+      # applicable when performing per-zone operations.
+}
+
+ +
+ list(folder, zone, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None) +
Lists all VM extension policies within a specific zone for a folder.
+
+Args:
+  folder: string, Folder ID for this request. (required)
+  zone: string, Name of the zone for this request. (required)
+  filter: string, A filter expression that filters resources listed in the response. Most
+Compute resources support two types of filter expressions:
+expressions that support regular expressions and expressions that follow
+API improvement proposal AIP-160.
+These two types of filter expressions cannot be mixed in one request.
+
+If you want to use AIP-160, your expression must specify the field name, an
+operator, and the value that you want to use for filtering. The value
+must be a string, a number, or a boolean. The operator
+must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.
+
+For example, if you are filtering Compute Engine instances, you can
+exclude instances named `example-instance` by specifying
+`name != example-instance`.
+
+The `:*` comparison can be used to test whether a key has been defined.
+For example, to find all objects with `owner` label use:
+```
+labels.owner:*
+```
+
+You can also filter nested fields. For example, you could specify
+`scheduling.automaticRestart = false` to include instances only
+if they are not scheduled for automatic restarts. You can use filtering
+on nested fields to filter based onresource labels.
+
+To filter on multiple expressions, provide each separate expression within
+parentheses. For example:
+```
+(scheduling.automaticRestart = true)
+(cpuPlatform = "Intel Skylake")
+```
+By default, each expression is an `AND` expression. However, you
+can include `AND` and `OR` expressions explicitly.
+For example:
+```
+(cpuPlatform = "Intel Skylake") OR
+(cpuPlatform = "Intel Broadwell") AND
+(scheduling.automaticRestart = true)
+```
+
+If you want to use a regular expression, use the `eq` (equal) or `ne`
+(not equal) operator against a single un-parenthesized expression with or
+without quotes or against multiple parenthesized expressions. Examples:
+
+`fieldname eq unquoted literal`
+`fieldname eq 'single quoted literal'`
+`fieldname eq "double quoted literal"`
+`(fieldname1 eq literal) (fieldname2 ne "literal")`
+
+The literal value is interpreted as a regular expression using GoogleRE2 library syntax.
+The literal value must match the entire field.
+
+For example, to filter for instances that do not end with name "instance",
+you would use `name ne .*instance`.
+
+You cannot combine constraints on multiple fields using regular
+expressions.
+  maxResults: integer, The maximum number of results per page that should be returned.
+If the number of available results is larger than `maxResults`,
+Compute Engine returns a `nextPageToken` that can be used to get
+the next page of results in subsequent list requests. Acceptable values are
+`0` to `500`, inclusive. (Default: `500`)
+  orderBy: string, Sorts list results by a certain order. By default, results
+are returned in alphanumerical order based on the resource name.
+
+You can also sort results in descending order based on the creation
+timestamp using `orderBy="creationTimestamp desc"`. This sorts
+results based on the `creationTimestamp` field in
+reverse chronological order (newest result first). Use this to sort
+resources like operations so that the newest operation is returned first.
+
+Currently, only sorting by `name` or
+`creationTimestamp desc` is supported.
+  pageToken: string, Specifies a page token to use. Set `pageToken` to the
+`nextPageToken` returned by a previous list request to get
+the next page of results.
+  returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case
+of failure. The default value is false.
+
+For example, when partial success behavior is enabled, aggregatedList for a
+single zone scope either returns all resources in the zone or no resources,
+with an error code.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    {
+  "etag": "A String", # Output only. [Output Only] Fingerprint of this resource. A hash of the contents stored
+      # in this object. This field is used in optimistic locking. This field will
+      # be ignored when inserting a VmExtensionPolicy. An up-to-date
+      # fingerprint must be provided in order to update the VmExtensionPolicy.
+      #
+      # To see the latest value of the fingerprint, make a get() request to
+      # retrieve a VmExtensionPolicy.
+  "id": "A String", # Output only. [Output Only] Unique identifier for the resource; defined by the server.
+  "items": [ # Output only. [Output Only] A list of VM extension policy resources.
+    { # Represents a VM extension policy.
+      "creationTimestamp": "A String", # Output only. [Output Only] Creation timestamp inRFC3339
+          # text format.
+      "description": "A String", # An optional description of this resource.
+      "extensionPolicies": { # Required. A map of extension names (for example, "ops-agent") to their corresponding
+          # policy configurations.
+        "a_key": { # Configuration for a specific VM extension.
+          "pinnedVersion": "A String", # Optional. The specific version of the extension to install. If not set, the latest
+              # version is used.
+          "stringConfig": "A String", # Optional. String-based configuration data for the extension.
+        },
+      },
+      "globalResourceLink": "A String", # Optional. Output only. [Output Only] Link to the global policy that manages this zone policy, if
+          # applicable.
+      "id": "A String", # Output only. [Output Only] The unique identifier for the resource. This identifier is
+          # defined by the server.
+      "instanceSelectors": [ # Optional. Selectors to target VMs for this policy. VMs are selected if they match
+          # *any* of the provided selectors (logical OR). If this list is empty, the
+          # policy applies to all VMs.
+        { # Defines how to select VMs to apply a zone VM extension policy.
+          "labelSelector": { # A LabelSelector is applied to a VM only if it matches all the specified # Optional. LabelSelector selects VMs based on their labels.
+              # labels.
+            "inclusionLabels": { # Optional. A map of key-value pairs representing VM labels.
+                # VMs must have all of the labels specified in this map to be selected
+                # (logical AND).
+                #
+                # e.g. If the `inclusion_labels` are {("key1", "value1"), ("key2",
+                # "value2")}, the VM labels must contain both ("key1", "value1") and
+                # ("key2", "value2") to be selected. If the VM labels are ("key1",
+                # "value1") and ("something", "else"), it will not be selected.
+                #
+                # If the map is empty, it's considered a match.
+              "a_key": "A String",
+            },
+          },
+        },
+      ],
+      "kind": "compute#vmExtensionPolicy", # Output only. [Output Only] Type of the resource. Alwayscompute#vmExtensionPolicy.
+      "managedByGlobal": True or False, # Optional. Output only. [Output Only] Indicates if this policy is managed by a global policy.
+      "name": "A String", # Name of the resource. Provided by the client when the resource is created.
+          # The name must be 1-63 characters long, and comply withRFC1035.
+          # Specifically, the name must be 1-63 characters long and match the regular
+          # expression `[a-z]([-a-z0-9]*[a-z0-9])?`
+          # which means the first character must be a lowercase letter, and all
+          # following characters must be a dash, lowercase letter, or digit, except
+          # the last character, which cannot be a dash.
+      "priority": 42, # Optional. Priority of this policy. Used to resolve conflicts when multiple policies
+          # apply to the same extension.
+          # The policy priority is an integer from 0 to 65535, inclusive. Lower
+          # integers indicate higher priorities. If you do not specify a priority when
+          # creating a rule, it is assigned a priority of 1000. If priorities are
+          # equal, the policy with the most recent creation timestamp takes precedence.
+      "selfLink": "A String", # Output only. [Output Only] Server-defined fully-qualified URL for this resource.
+      "selfLinkWithId": "A String", # Output only. [Output Only] Server-defined URL for this resource's resource id.
+      "state": "A String", # Optional. Output only. [Output Only] Current state of the policy: ACTIVE or DELETING.
+      "updateTimestamp": "A String", # Output only. [Output Only] Update timestamp inRFC3339
+          # text format.
+    },
+  ],
+  "kind": "compute#vmExtensionPolicyList", # Output only. Type of resource.
+  "nextPageToken": "A String", # Output only. [Output Only] This token allows you to get the next page of results for
+      # list requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for
+      # the query parameter pageToken in the next list request.
+      # Subsequent list requests will have their own nextPageToken to
+      # continue paging through the results.
+  "selfLink": "A String", # Output only. [Output Only] Server-defined URL for this resource.
+  "unreachables": [ # Output only. [Output Only] Unreachable resources.
+    "A String",
+  ],
+  "warning": { # Output only. [Output Only] Informational warning message.
+    "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute
+        # Engine returns NO_RESULTS_ON_PAGE if there
+        # are no results in the response.
+    "data": [ # [Output Only] Metadata about this warning in key:
+        # value format. For example:
+        #
+        # "data": [
+        #   {
+        #    "key": "scope",
+        #    "value": "zones/us-east1-d"
+        #   }
+      {
+        "key": "A String", # [Output Only] A key that provides more detail on the warning being
+            # returned. For example, for warnings where there are no results in a list
+            # request for a particular zone, this key might be scope and
+            # the key value might be the zone name. Other examples might be a key
+            # indicating a deprecated resource and a suggested replacement, or a
+            # warning about invalid network settings (for example, if an instance
+            # attempts to perform IP forwarding but is not enabled for IP forwarding).
+        "value": "A String", # [Output Only] A warning data value corresponding to the key.
+      },
+    ],
+    "message": "A String", # [Output Only] A human-readable description of the warning code.
+  },
+}
+
+ +
+ listVmExtensions(folder, zone, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None) +
Lists all VM extensions within a specific zone for a folder.
+This is a read-only API.
+
+Args:
+  folder: string, Folder ID for this request. (required)
+  zone: string, Name of the zone for this request. (required)
+  filter: string, A filter expression that filters resources listed in the response. Most
+Compute resources support two types of filter expressions:
+expressions that support regular expressions and expressions that follow
+API improvement proposal AIP-160.
+These two types of filter expressions cannot be mixed in one request.
+
+If you want to use AIP-160, your expression must specify the field name, an
+operator, and the value that you want to use for filtering. The value
+must be a string, a number, or a boolean. The operator
+must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.
+
+For example, if you are filtering Compute Engine instances, you can
+exclude instances named `example-instance` by specifying
+`name != example-instance`.
+
+The `:*` comparison can be used to test whether a key has been defined.
+For example, to find all objects with `owner` label use:
+```
+labels.owner:*
+```
+
+You can also filter nested fields. For example, you could specify
+`scheduling.automaticRestart = false` to include instances only
+if they are not scheduled for automatic restarts. You can use filtering
+on nested fields to filter based onresource labels.
+
+To filter on multiple expressions, provide each separate expression within
+parentheses. For example:
+```
+(scheduling.automaticRestart = true)
+(cpuPlatform = "Intel Skylake")
+```
+By default, each expression is an `AND` expression. However, you
+can include `AND` and `OR` expressions explicitly.
+For example:
+```
+(cpuPlatform = "Intel Skylake") OR
+(cpuPlatform = "Intel Broadwell") AND
+(scheduling.automaticRestart = true)
+```
+
+If you want to use a regular expression, use the `eq` (equal) or `ne`
+(not equal) operator against a single un-parenthesized expression with or
+without quotes or against multiple parenthesized expressions. Examples:
+
+`fieldname eq unquoted literal`
+`fieldname eq 'single quoted literal'`
+`fieldname eq "double quoted literal"`
+`(fieldname1 eq literal) (fieldname2 ne "literal")`
+
+The literal value is interpreted as a regular expression using GoogleRE2 library syntax.
+The literal value must match the entire field.
+
+For example, to filter for instances that do not end with name "instance",
+you would use `name ne .*instance`.
+
+You cannot combine constraints on multiple fields using regular
+expressions.
+  maxResults: integer, The maximum number of results per page that should be returned.
+If the number of available results is larger than `maxResults`,
+Compute Engine returns a `nextPageToken` that can be used to get
+the next page of results in subsequent list requests. Acceptable values are
+`0` to `500`, inclusive. (Default: `500`)
+  orderBy: string, Sorts list results by a certain order. By default, results
+are returned in alphanumerical order based on the resource name.
+
+You can also sort results in descending order based on the creation
+timestamp using `orderBy="creationTimestamp desc"`. This sorts
+results based on the `creationTimestamp` field in
+reverse chronological order (newest result first). Use this to sort
+resources like operations so that the newest operation is returned first.
+
+Currently, only sorting by `name` or
+`creationTimestamp desc` is supported.
+  pageToken: string, Specifies a page token to use. Set `pageToken` to the
+`nextPageToken` returned by a previous list request to get
+the next page of results.
+  returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case
+of failure. The default value is false.
+
+For example, when partial success behavior is enabled, aggregatedList for a
+single zone scope either returns all resources in the zone or no resources,
+with an error code.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    {
+  "etag": "A String", # Output only. Fingerprint of this resource. A hash of the contents stored
+      # in this object. This field is used in optimistic locking. This field will
+      # be ignored when inserting a VmExtensionPolicy. An up-to-date
+      # fingerprint must be provided in order to update the VmExtensionPolicy.
+      #
+      # To see the latest value of the fingerprint, make a get() request to
+      # retrieve a VmExtensionPolicy.
+  "id": "A String", # Output only. Unique identifier for the resource; defined by the server.
+  "items": [ # Output only. A list of VM extensions.
+    { # A VM extension that can be installed on a VM.
+      "name": "A String", # The name of the vm extension.
+      "versions": [ # The latest 10 versions of the vm extension.
+        "A String",
+      ],
+    },
+  ],
+  "kind": "compute#vmExtensionList", # Output only. Type of resource.
+  "nextPageToken": "A String", # Output only. This token allows you to get the next page of results for
+      # list requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for
+      # the query parameter pageToken in the next list request.
+      # Subsequent list requests will have their own nextPageToken to
+      # continue paging through the results.
+  "selfLink": "A String", # Output only. Server-defined URL for this resource.
+  "unreachables": [ # Output only. Unreachable resources.
+    "A String",
+  ],
+  "warning": { # Output only. Informational warning message.
+    "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute
+        # Engine returns NO_RESULTS_ON_PAGE if there
+        # are no results in the response.
+    "data": [ # [Output Only] Metadata about this warning in key:
+        # value format. For example:
+        #
+        # "data": [
+        #   {
+        #    "key": "scope",
+        #    "value": "zones/us-east1-d"
+        #   }
+      {
+        "key": "A String", # [Output Only] A key that provides more detail on the warning being
+            # returned. For example, for warnings where there are no results in a list
+            # request for a particular zone, this key might be scope and
+            # the key value might be the zone name. Other examples might be a key
+            # indicating a deprecated resource and a suggested replacement, or a
+            # warning about invalid network settings (for example, if an instance
+            # attempts to perform IP forwarding but is not enabled for IP forwarding).
+        "value": "A String", # [Output Only] A warning data value corresponding to the key.
+      },
+    ],
+    "message": "A String", # [Output Only] A human-readable description of the warning code.
+  },
+}
+
+ +
+ listVmExtensions_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.
+        
+
+ +
+ list_next() +
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+        
+
+ +
+ update(folder, zone, vmExtensionPolicy, body=None, requestId=None, x__xgafv=None) +
Modifies an existing zone VM extension policy within a folder.
+
+Args:
+  folder: string, Folder ID for this request. (required)
+  zone: string, Name of the zone for this request. (required)
+  vmExtensionPolicy: string, Name of the zone VM extension policy to update. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Represents a VM extension policy.
+  "creationTimestamp": "A String", # Output only. [Output Only] Creation timestamp inRFC3339
+      # text format.
+  "description": "A String", # An optional description of this resource.
+  "extensionPolicies": { # Required. A map of extension names (for example, "ops-agent") to their corresponding
+      # policy configurations.
+    "a_key": { # Configuration for a specific VM extension.
+      "pinnedVersion": "A String", # Optional. The specific version of the extension to install. If not set, the latest
+          # version is used.
+      "stringConfig": "A String", # Optional. String-based configuration data for the extension.
+    },
+  },
+  "globalResourceLink": "A String", # Optional. Output only. [Output Only] Link to the global policy that manages this zone policy, if
+      # applicable.
+  "id": "A String", # Output only. [Output Only] The unique identifier for the resource. This identifier is
+      # defined by the server.
+  "instanceSelectors": [ # Optional. Selectors to target VMs for this policy. VMs are selected if they match
+      # *any* of the provided selectors (logical OR). If this list is empty, the
+      # policy applies to all VMs.
+    { # Defines how to select VMs to apply a zone VM extension policy.
+      "labelSelector": { # A LabelSelector is applied to a VM only if it matches all the specified # Optional. LabelSelector selects VMs based on their labels.
+          # labels.
+        "inclusionLabels": { # Optional. A map of key-value pairs representing VM labels.
+            # VMs must have all of the labels specified in this map to be selected
+            # (logical AND).
+            #
+            # e.g. If the `inclusion_labels` are {("key1", "value1"), ("key2",
+            # "value2")}, the VM labels must contain both ("key1", "value1") and
+            # ("key2", "value2") to be selected. If the VM labels are ("key1",
+            # "value1") and ("something", "else"), it will not be selected.
+            #
+            # If the map is empty, it's considered a match.
+          "a_key": "A String",
+        },
+      },
+    },
+  ],
+  "kind": "compute#vmExtensionPolicy", # Output only. [Output Only] Type of the resource. Alwayscompute#vmExtensionPolicy.
+  "managedByGlobal": True or False, # Optional. Output only. [Output Only] Indicates if this policy is managed by a global policy.
+  "name": "A String", # Name of the resource. Provided by the client when the resource is created.
+      # The name must be 1-63 characters long, and comply withRFC1035.
+      # Specifically, the name must be 1-63 characters long and match the regular
+      # expression `[a-z]([-a-z0-9]*[a-z0-9])?`
+      # which means the first character must be a lowercase letter, and all
+      # following characters must be a dash, lowercase letter, or digit, except
+      # the last character, which cannot be a dash.
+  "priority": 42, # Optional. Priority of this policy. Used to resolve conflicts when multiple policies
+      # apply to the same extension.
+      # The policy priority is an integer from 0 to 65535, inclusive. Lower
+      # integers indicate higher priorities. If you do not specify a priority when
+      # creating a rule, it is assigned a priority of 1000. If priorities are
+      # equal, the policy with the most recent creation timestamp takes precedence.
+  "selfLink": "A String", # Output only. [Output Only] Server-defined fully-qualified URL for this resource.
+  "selfLinkWithId": "A String", # Output only. [Output Only] Server-defined URL for this resource's resource id.
+  "state": "A String", # Optional. Output only. [Output Only] Current state of the policy: ACTIVE or DELETING.
+  "updateTimestamp": "A String", # Output only. [Output Only] Update timestamp inRFC3339
+      # text format.
+}
+
+  requestId: string, An optional request ID to identify requests. Specify a unique request ID so
+that if you must retry your request, the server will know to ignore the
+request if it has already been completed.
+
+For example, consider a situation where you make an initial request and
+the request times out. If you make the request again with the same
+request ID, the server can check if original operation with the same
+request ID was received, and if so, will ignore the second request. This
+prevents clients from accidentally creating duplicate commitments.
+
+The request ID must be
+a valid UUID with the exception that zero UUID is not supported
+(00000000-0000-0000-0000-000000000000).
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Represents an Operation resource.
+    #
+    # Google Compute Engine has three Operation resources:
+    #
+    # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
+    # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
+    # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
+    #
+    # You can use an operation resource to manage asynchronous API requests.
+    # For more information, readHandling
+    # API responses.
+    #
+    # Operations can be global, regional or zonal.
+    #
+    #    - For global operations, use the `globalOperations`
+    #    resource.
+    #    - For regional operations, use the
+    #    `regionOperations` resource.
+    #    - For zonal operations, use
+    #    the `zoneOperations` resource.
+    #
+    #
+    #
+    # For more information, read
+    # Global, Regional, and Zonal Resources.
+    #
+    # Note that completed Operation resources have a limited
+    # retention period.
+  "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request.
+      # Not present otherwise.
+  "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
+  "description": "A String", # [Output Only] A textual description of the operation, which is
+      # set when the operation is created.
+  "endTime": "A String", # [Output Only] The time that this operation was completed. This value is inRFC3339
+      # text format.
+  "error": { # [Output Only] If errors are generated during processing of the operation,
+      # this field will be populated.
+    "errors": [ # [Output Only] The array of errors encountered while processing this
+        # operation.
+      {
+        "code": "A String", # [Output Only] The error type identifier for this error.
+        "errorDetails": [ # [Output Only] An optional list of messages that contain the error
+            # details. There is a set of defined message types to use for providing
+            # details.The syntax depends on the error code. For example,
+            # QuotaExceededInfo will have details when the error code is
+            # QUOTA_EXCEEDED.
+          {
+            "errorInfo": { # Describes the cause of the error with structured details.
+                #
+                # Example of an error when contacting the "pubsub.googleapis.com" API when it
+                # is not enabled:
+                #
+                #     { "reason": "API_DISABLED"
+                #       "domain": "googleapis.com"
+                #       "metadata": {
+                #         "resource": "projects/123",
+                #         "service": "pubsub.googleapis.com"
+                #       }
+                #     }
+                #
+                # This response indicates that the pubsub.googleapis.com API is not enabled.
+                #
+                # Example of an error that is returned when attempting to create a Spanner
+                # instance in a region that is out of stock:
+                #
+                #     { "reason": "STOCKOUT"
+                #       "domain": "spanner.googleapis.com",
+                #       "metadata": {
+                #         "availableRegions": "us-central1,us-east2"
+                #       }
+                #     }
+              "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain
+                  # is typically the registered service name of the tool or product that
+                  # generates the error. Example: "pubsub.googleapis.com". If the error is
+                  # generated by some common infrastructure, the error domain must be a
+                  # globally unique value that identifies the infrastructure. For Google API
+                  # infrastructure, the error domain is "googleapis.com".
+              "metadatas": { # Additional structured details about this error.
+                  #
+                  # Keys must match a regular expression of `a-z+` but should
+                  # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
+                  # length. When identifying the current value of an exceeded limit, the units
+                  # should be contained in the key, not the value.  For example, rather than
+                  # `{"instanceLimit": "100/request"}`, should be returned as,
+                  # `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of
+                  # instances that can be created in a single (batch) request.
+                "a_key": "A String",
+              },
+              "reason": "A String", # The reason of the error. This is a constant value that identifies the
+                  # proximate cause of the error. Error reasons are unique within a particular
+                  # domain of errors. This should be at most 63 characters and match a
+                  # regular expression of `A-Z+[A-Z0-9]`, which represents
+                  # UPPER_SNAKE_CASE.
+            },
+            "help": { # Provides links to documentation or for performing an out of band action.
+                #
+                # For example, if a quota check failed with an error indicating the calling
+                # project hasn't enabled the accessed service, this can contain a URL pointing
+                # directly to the right place in the developer console to flip the bit.
+              "links": [ # URL(s) pointing to additional information on handling the current error.
+                { # Describes a URL link.
+                  "description": "A String", # Describes what the link offers.
+                  "url": "A String", # The URL of the link.
+                },
+              ],
+            },
+            "localizedMessage": { # Provides a localized error message that is safe to return to the user
+                # which can be attached to an RPC error.
+              "locale": "A String", # The locale used following the specification defined at
+                  # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
+                  # Examples are: "en-US", "fr-CH", "es-MX"
+              "message": "A String", # The localized error message in the above locale.
+            },
+            "quotaInfo": { # Additional details for quota exceeded error for resource quota.
+              "dimensions": { # The map holding related quota dimensions.
+                "a_key": "A String",
+              },
+              "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota
+                  #  type or metric.
+              "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type
+                  # or metric.
+              "limitName": "A String", # The name of the quota limit.
+              "metricName": "A String", # The Compute Engine quota metric name.
+              "rolloutStatus": "A String", # Rollout status of the future quota limit.
+            },
+          },
+        ],
+        "location": "A String", # [Output Only] Indicates the field in the request that caused the error.
+            # This property is optional.
+        "message": "A String", # [Output Only] An optional, human-readable error message.
+      },
+    ],
+  },
+  "getVersionOperationMetadata": {
+    "inlineSbomInfo": {
+      "currentComponentVersions": { # A mapping of components to their currently-applied versions or other
+          # appropriate identifiers.
+        "a_key": "A String",
+      },
+      "targetComponentVersions": { # A mapping of components to their target versions or other appropriate
+          # identifiers.
+        "a_key": "A String",
+      },
+    },
+  },
+  "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
+      # message that was returned, such as `NOT FOUND`.
+  "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
+      # status code that was returned. For example, a `404` means the
+      # resource was not found.
+  "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is
+      # defined by the server.
+  "insertTime": "A String", # [Output Only] The time that this operation was requested.
+      # This value is inRFC3339
+      # text format.
+  "instancesBulkInsertOperationMetadata": {
+    "perLocationStatus": { # Status information per location (location name is key).
+        # Example key: zones/us-central1-a
+      "a_key": {
+        "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far.
+        "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback.
+        "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an
+            # error.
+        "status": "A String", # [Output Only] Creation status of BulkInsert operation - information
+            # if the flow is rolling forward or rolling back.
+        "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created.
+      },
+    },
+  },
+  "kind": "compute#operation", # Output only. [Output Only] Type of the resource. Always `compute#operation` for
+      # Operation resources.
+  "name": "A String", # [Output Only] Name of the operation.
+  "operationGroupId": "A String", # Output only. [Output Only] An ID that represents a group of operations, such as when a
+      # group of operations results from a `bulkInsert` API request.
+  "operationType": "A String", # [Output Only] The type of operation, such as `insert`,
+      # `update`, or `delete`, and so on.
+  "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
+      # There is no requirement that this be linear or support any granularity of
+      # operations. This should not be used to guess when the operation will be
+      # complete. This number should monotonically increase as the operation
+      # progresses.
+  "region": "A String", # [Output Only] The URL of the region where the operation resides. Only
+      # applicable when performing regional operations.
+  "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+  "selfLinkWithId": "A String", # Output only. [Output Only] Server-defined URL for this resource with the resource id.
+  "setCommonInstanceMetadataOperationMetadata": { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
+      # this field will contain information on all underlying zonal actions and
+      # their state.
+    "clientOperationId": "A String", # [Output Only] The client operation id.
+    "perLocationOperations": { # [Output Only] Status information per location (location name is key).
+        # Example key: zones/us-central1-a
+      "a_key": {
+        "error": { # The `Status` type defines a logical error model that is suitable for # [Output Only] If state is `ABANDONED` or `FAILED`, this field is
+            # populated.
+            # different programming environments, including REST APIs and RPC APIs. It is
+            # used by [gRPC](https://github.com/grpc). Each `Status` message contains
+            # three pieces of data: error code, error message, and error details.
+            #
+            # You can find out more about this error model and how to work with it in the
+            # [API Design Guide](https://cloud.google.com/apis/design/errors).
+          "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+          "details": [ # A list of messages that carry the error details.  There is a common set of
+              # message types for APIs to use.
+            {
+              "a_key": "", # Properties of the object. Contains field @type with type URL.
+            },
+          ],
+          "message": "A String", # A developer-facing error message, which should be in English. Any
+              # user-facing error message should be localized and sent in the
+              # google.rpc.Status.details field, or localized by the client.
+        },
+        "state": "A String", # [Output Only] Status of the action, which can be one of the following:
+            # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
+      },
+    },
+  },
+  "startTime": "A String", # [Output Only] The time that this operation was started by the server.
+      # This value is inRFC3339
+      # text format.
+  "status": "A String", # [Output Only] The status of the operation, which can be one of the
+      # following:
+      # `PENDING`, `RUNNING`, or `DONE`.
+  "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the
+      # operation.
+  "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation
+      # of the target resource.
+  "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For
+      # operations related to creating a snapshot, this points to the disk
+      # that the snapshot was created from.
+  "user": "A String", # [Output Only] User who requested the operation, for example:
+      # `user@example.com` or
+      # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
+  "warnings": [ # [Output Only] If warning messages are generated during processing of the
+      # operation, this field will be populated.
+    {
+      "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute
+          # Engine returns NO_RESULTS_ON_PAGE if there
+          # are no results in the response.
+      "data": [ # [Output Only] Metadata about this warning in key:
+          # value format. For example:
+          #
+          # "data": [
+          #   {
+          #    "key": "scope",
+          #    "value": "zones/us-east1-d"
+          #   }
+        {
+          "key": "A String", # [Output Only] A key that provides more detail on the warning being
+              # returned. For example, for warnings where there are no results in a list
+              # request for a particular zone, this key might be scope and
+              # the key value might be the zone name. Other examples might be a key
+              # indicating a deprecated resource and a suggested replacement, or a
+              # warning about invalid network settings (for example, if an instance
+              # attempts to perform IP forwarding but is not enabled for IP forwarding).
+          "value": "A String", # [Output Only] A warning data value corresponding to the key.
+        },
+      ],
+      "message": "A String", # [Output Only] A human-readable description of the warning code.
+    },
+  ],
+  "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only
+      # applicable when performing per-zone operations.
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/compute_alpha.haControllers.html b/docs/dyn/compute_alpha.haControllers.html index e1650c7236..f7a9038ba0 100644 --- a/docs/dyn/compute_alpha.haControllers.html +++ b/docs/dyn/compute_alpha.haControllers.html @@ -1039,8 +1039,6 @@

Method Details

{ "failoverToZone": "A String", # Name of the destination zone for the failover. - "primaryZone": "A String", # Name of the destination zone for the failover. - # Deprecated: use failover_to_zone instead. } requestId: string, An optional request ID to identify requests. Specify a unique request ID so diff --git a/docs/dyn/compute_alpha.html b/docs/dyn/compute_alpha.html index 7304786232..fa43da115e 100644 --- a/docs/dyn/compute_alpha.html +++ b/docs/dyn/compute_alpha.html @@ -139,6 +139,11 @@

Instance Methods

Returns the firewalls Resource.

+

+ folderZoneVmExtensionPolicies() +

+

Returns the folderZoneVmExtensionPolicies Resource.

+

forwardingRules()

@@ -364,6 +369,21 @@

Instance Methods

Returns the nodeTypes Resource.

+

+ orgVmExtensionPolicies() +

+

Returns the orgVmExtensionPolicies Resource.

+ +

+ organizationRolloutPlans() +

+

Returns the organizationRolloutPlans Resource.

+ +

+ organizationRollouts() +

+

Returns the organizationRollouts Resource.

+

organizationSecurityPolicies()

@@ -374,6 +394,11 @@

Instance Methods

Returns the organizationSnapshotRecycleBinPolicy Resource.

+

+ organizationZoneVmExtensionPolicies() +

+

Returns the organizationZoneVmExtensionPolicies Resource.

+

packetMirrorings()

diff --git a/docs/dyn/compute_alpha.imageViews.html b/docs/dyn/compute_alpha.imageViews.html index f942bdaec2..c685e21067 100644 --- a/docs/dyn/compute_alpha.imageViews.html +++ b/docs/dyn/compute_alpha.imageViews.html @@ -79,10 +79,10 @@

Instance Methods

Close httplib2 connections.

get(project, region, resourceId, x__xgafv=None)

-

Returns the specified global Image resource by providing a regional

+

Returns the specified global ImageView resource, with a regional

list(project, region, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

-

Retrieves the list of global Image resources available to the project by

+

Returns a list of global ImageView resources, with a regional

list_next()

Retrieves the next page of results.

@@ -94,8 +94,8 @@

Method Details

get(project, region, resourceId, x__xgafv=None) -
Returns the specified global Image resource by providing a regional
-context to read the metadata from the Global Clone in the region.
+  
Returns the specified global ImageView resource, with a regional
+context.
 
 Args:
   project: string, Required. Project ID for this request. (required)
@@ -651,9 +651,8 @@ 

Method Details

list(project, region, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None) -
Retrieves the list of global Image resources available to the project by
-providing a regional context to read the metadata from the Global Clone in
-the region.
+  
Returns a list of global ImageView resources, with a regional
+context.
 
 Args:
   project: string, Required. Project ID for this request. (required)
diff --git a/docs/dyn/compute_alpha.instanceGroupManagers.html b/docs/dyn/compute_alpha.instanceGroupManagers.html
index 141c71c05c..131645ac9b 100644
--- a/docs/dyn/compute_alpha.instanceGroupManagers.html
+++ b/docs/dyn/compute_alpha.instanceGroupManagers.html
@@ -2260,6 +2260,9 @@ 

Method Details

# - Manually change the targetSuspendedSize using the update # method. "updatePolicy": { # The update policy for this managed instance group. + "allowedActions": [ # Actions that are allowed to update instances within MIG. + "A String", + ], "disruptionMode": "A String", # Whether the boot disk is allowed to be updated with restart. "instanceRedistributionType": "A String", # The # instance redistribution policy for regional managed instance groups. @@ -2515,6 +2518,9 @@

Method Details

"allInstances": True or False, # Flag to update all instances instead of specified list of “instances”. # If the flag is set to true then the instances may not be specified # in the request. + "allowedActions": [ # Actions that are allowed to update instances within MIG. + "A String", + ], "disruptionMode": "A String", # Whether the boot disk is allowed to be updated with restart. "instances": [ # The list of URLs of one or more instances for which you want to apply # updates. Each URL can be a full URL or a partial URL, such aszones/[ZONE]/instances/[INSTANCE_NAME]. @@ -6119,6 +6125,9 @@

Method Details

# - Manually change the targetSuspendedSize using the update # method. "updatePolicy": { # The update policy for this managed instance group. + "allowedActions": [ # Actions that are allowed to update instances within MIG. + "A String", + ], "disruptionMode": "A String", # Whether the boot disk is allowed to be updated with restart. "instanceRedistributionType": "A String", # The # instance redistribution policy for regional managed instance groups. @@ -8081,6 +8090,9 @@

Method Details

# - Manually change the targetSuspendedSize using the update # method. "updatePolicy": { # The update policy for this managed instance group. + "allowedActions": [ # Actions that are allowed to update instances within MIG. + "A String", + ], "disruptionMode": "A String", # Whether the boot disk is allowed to be updated with restart. "instanceRedistributionType": "A String", # The # instance redistribution policy for regional managed instance groups. @@ -10270,6 +10282,9 @@

Method Details

# - Manually change the targetSuspendedSize using the update # method. "updatePolicy": { # The update policy for this managed instance group. + "allowedActions": [ # Actions that are allowed to update instances within MIG. + "A String", + ], "disruptionMode": "A String", # Whether the boot disk is allowed to be updated with restart. "instanceRedistributionType": "A String", # The # instance redistribution policy for regional managed instance groups. @@ -10572,18 +10587,18 @@

Method Details

{ "items": [ # Output only. [Output Only] The list of errors of the managed instance group. { - "error": { # Output only. [Output Only] Contents of the error. - "code": "A String", # Output only. [Output Only] Error code. - "message": "A String", # Output only. [Output Only] Error message. + "error": { # Output only. Contents of the error. + "code": "A String", # Output only. Error code. + "message": "A String", # Output only. Error message. }, - "instanceActionDetails": { # Output only. [Output Only] Details of the instance action that triggered this error. + "instanceActionDetails": { # Output only. Details of the instance action that triggered this error. # May be null, if the error was not caused by an action on an instance. # This field is optional. - "action": "A String", # Output only. [Output Only] Action that managed instance group was executing on - # the instance when the error occurred. Possible values: - "instance": "A String", # Output only. [Output Only] The URL of the instance. - # The URL can be set even if the instance has not yet been created. - "version": { # Output only. [Output Only] Version this instance was created from, or was being + "action": "A String", # Output only. Action that managed instance group was executing on the instance when the + # error occurred. Possible values: + "instance": "A String", # Output only. The URL of the instance. The URL can be set even if the instance has not + # yet been created. + "version": { # Output only. Version this instance was created from, or was being # created from, but the creation failed. Corresponds to one of the versions # that were set on the Instance Group Manager resource at the time this # instance was being created. @@ -10592,8 +10607,7 @@

Method Details

"name": "A String", # Output only. [Output Only] Name of the version. }, }, - "timestamp": "A String", # Output only. [Output Only] The time that this error occurred. - # This value is in RFC3339 text format. + "timestamp": "A String", # Output only. The time that this error occurred. This value is in RFC3339 text format. }, ], "nextPageToken": "A String", # Output only. [Output Only] This token allows you to get the next page of results for @@ -13919,6 +13933,9 @@

Method Details

# - Manually change the targetSuspendedSize using the update # method. "updatePolicy": { # The update policy for this managed instance group. + "allowedActions": [ # Actions that are allowed to update instances within MIG. + "A String", + ], "disruptionMode": "A String", # Whether the boot disk is allowed to be updated with restart. "instanceRedistributionType": "A String", # The # instance redistribution policy for regional managed instance groups. @@ -19703,6 +19720,9 @@

Method Details

# - Manually change the targetSuspendedSize using the update # method. "updatePolicy": { # The update policy for this managed instance group. + "allowedActions": [ # Actions that are allowed to update instances within MIG. + "A String", + ], "disruptionMode": "A String", # Whether the boot disk is allowed to be updated with restart. "instanceRedistributionType": "A String", # The # instance redistribution policy for regional managed instance groups. diff --git a/docs/dyn/compute_alpha.instances.html b/docs/dyn/compute_alpha.instances.html index ac25eb5875..0b85288b51 100644 --- a/docs/dyn/compute_alpha.instances.html +++ b/docs/dyn/compute_alpha.instances.html @@ -2600,6 +2600,14 @@

Method Details

# Engine cluster, as well as the ID of the block, sub-block, and host on # which the running instance is located. # running. + "additionalAttributes": { # Additional location information of the running instance. # Output only. [Output Only] Additional location information of the running instance. + "acceleratorTopologyIds": { # Output only. The IDs of the accelerator topologies the instance belongs to. For + # example + # The key will be topologies like "4x4", "2x2x2" and the value will be + # the location ID of the topologies. + "a_key": "A String", + }, + }, "block": "A String", # [Output Only] The ID of the block in which the running instance is # located. Instances within the same block experience low network latency. "cluster": "A String", # [Output Only] The global name of the Compute Engine cluster where the @@ -8067,6 +8075,14 @@

Method Details

# Engine cluster, as well as the ID of the block, sub-block, and host on # which the running instance is located. # running. + "additionalAttributes": { # Additional location information of the running instance. # Output only. [Output Only] Additional location information of the running instance. + "acceleratorTopologyIds": { # Output only. The IDs of the accelerator topologies the instance belongs to. For + # example + # The key will be topologies like "4x4", "2x2x2" and the value will be + # the location ID of the topologies. + "a_key": "A String", + }, + }, "block": "A String", # [Output Only] The ID of the block in which the running instance is # located. Instances within the same block experience low network latency. "cluster": "A String", # [Output Only] The global name of the Compute Engine cluster where the @@ -11248,6 +11264,14 @@

Method Details

# Engine cluster, as well as the ID of the block, sub-block, and host on # which the running instance is located. # running. + "additionalAttributes": { # Additional location information of the running instance. # Output only. [Output Only] Additional location information of the running instance. + "acceleratorTopologyIds": { # Output only. The IDs of the accelerator topologies the instance belongs to. For + # example + # The key will be topologies like "4x4", "2x2x2" and the value will be + # the location ID of the topologies. + "a_key": "A String", + }, + }, "block": "A String", # [Output Only] The ID of the block in which the running instance is # located. Instances within the same block experience low network latency. "cluster": "A String", # [Output Only] The global name of the Compute Engine cluster where the @@ -13121,6 +13145,14 @@

Method Details

# Engine cluster, as well as the ID of the block, sub-block, and host on # which the running instance is located. # running. + "additionalAttributes": { # Additional location information of the running instance. # Output only. [Output Only] Additional location information of the running instance. + "acceleratorTopologyIds": { # Output only. The IDs of the accelerator topologies the instance belongs to. For + # example + # The key will be topologies like "4x4", "2x2x2" and the value will be + # the location ID of the topologies. + "a_key": "A String", + }, + }, "block": "A String", # [Output Only] The ID of the block in which the running instance is # located. Instances within the same block experience low network latency. "cluster": "A String", # [Output Only] The global name of the Compute Engine cluster where the @@ -23929,6 +23961,14 @@

Method Details

# Engine cluster, as well as the ID of the block, sub-block, and host on # which the running instance is located. # running. + "additionalAttributes": { # Additional location information of the running instance. # Output only. [Output Only] Additional location information of the running instance. + "acceleratorTopologyIds": { # Output only. The IDs of the accelerator topologies the instance belongs to. For + # example + # The key will be topologies like "4x4", "2x2x2" and the value will be + # the location ID of the topologies. + "a_key": "A String", + }, + }, "block": "A String", # [Output Only] The ID of the block in which the running instance is # located. Instances within the same block experience low network latency. "cluster": "A String", # [Output Only] The global name of the Compute Engine cluster where the diff --git a/docs/dyn/compute_alpha.orgVmExtensionPolicies.html b/docs/dyn/compute_alpha.orgVmExtensionPolicies.html new file mode 100644 index 0000000000..cc10a14e71 --- /dev/null +++ b/docs/dyn/compute_alpha.orgVmExtensionPolicies.html @@ -0,0 +1,383 @@ + + + +

Compute Engine API . orgVmExtensionPolicies

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ delete(organization, zone, vmExtensionPolicy, requestId=None, x__xgafv=None)

+

Deletes a specified zone VM extension policy within an organization.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ delete(organization, zone, vmExtensionPolicy, requestId=None, x__xgafv=None) +
Deletes a specified zone VM extension policy within an organization.
+
+Args:
+  organization: string, Organization ID for this request. (required)
+  zone: string, Name of the zone for this request. (required)
+  vmExtensionPolicy: string, Name of the zone VM extension policy to delete. (required)
+  requestId: string, An optional request ID to identify requests. Specify a unique request ID so
+that if you must retry your request, the server will know to ignore the
+request if it has already been completed.
+
+For example, consider a situation where you make an initial request and
+the request times out. If you make the request again with the same
+request ID, the server can check if original operation with the same
+request ID was received, and if so, will ignore the second request. This
+prevents clients from accidentally creating duplicate commitments.
+
+The request ID must be
+a valid UUID with the exception that zero UUID is not supported
+(00000000-0000-0000-0000-000000000000).
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Represents an Operation resource.
+    #
+    # Google Compute Engine has three Operation resources:
+    #
+    # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
+    # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
+    # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
+    #
+    # You can use an operation resource to manage asynchronous API requests.
+    # For more information, readHandling
+    # API responses.
+    #
+    # Operations can be global, regional or zonal.
+    #
+    #    - For global operations, use the `globalOperations`
+    #    resource.
+    #    - For regional operations, use the
+    #    `regionOperations` resource.
+    #    - For zonal operations, use
+    #    the `zoneOperations` resource.
+    #
+    #
+    #
+    # For more information, read
+    # Global, Regional, and Zonal Resources.
+    #
+    # Note that completed Operation resources have a limited
+    # retention period.
+  "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request.
+      # Not present otherwise.
+  "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
+  "description": "A String", # [Output Only] A textual description of the operation, which is
+      # set when the operation is created.
+  "endTime": "A String", # [Output Only] The time that this operation was completed. This value is inRFC3339
+      # text format.
+  "error": { # [Output Only] If errors are generated during processing of the operation,
+      # this field will be populated.
+    "errors": [ # [Output Only] The array of errors encountered while processing this
+        # operation.
+      {
+        "code": "A String", # [Output Only] The error type identifier for this error.
+        "errorDetails": [ # [Output Only] An optional list of messages that contain the error
+            # details. There is a set of defined message types to use for providing
+            # details.The syntax depends on the error code. For example,
+            # QuotaExceededInfo will have details when the error code is
+            # QUOTA_EXCEEDED.
+          {
+            "errorInfo": { # Describes the cause of the error with structured details.
+                #
+                # Example of an error when contacting the "pubsub.googleapis.com" API when it
+                # is not enabled:
+                #
+                #     { "reason": "API_DISABLED"
+                #       "domain": "googleapis.com"
+                #       "metadata": {
+                #         "resource": "projects/123",
+                #         "service": "pubsub.googleapis.com"
+                #       }
+                #     }
+                #
+                # This response indicates that the pubsub.googleapis.com API is not enabled.
+                #
+                # Example of an error that is returned when attempting to create a Spanner
+                # instance in a region that is out of stock:
+                #
+                #     { "reason": "STOCKOUT"
+                #       "domain": "spanner.googleapis.com",
+                #       "metadata": {
+                #         "availableRegions": "us-central1,us-east2"
+                #       }
+                #     }
+              "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain
+                  # is typically the registered service name of the tool or product that
+                  # generates the error. Example: "pubsub.googleapis.com". If the error is
+                  # generated by some common infrastructure, the error domain must be a
+                  # globally unique value that identifies the infrastructure. For Google API
+                  # infrastructure, the error domain is "googleapis.com".
+              "metadatas": { # Additional structured details about this error.
+                  #
+                  # Keys must match a regular expression of `a-z+` but should
+                  # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
+                  # length. When identifying the current value of an exceeded limit, the units
+                  # should be contained in the key, not the value.  For example, rather than
+                  # `{"instanceLimit": "100/request"}`, should be returned as,
+                  # `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of
+                  # instances that can be created in a single (batch) request.
+                "a_key": "A String",
+              },
+              "reason": "A String", # The reason of the error. This is a constant value that identifies the
+                  # proximate cause of the error. Error reasons are unique within a particular
+                  # domain of errors. This should be at most 63 characters and match a
+                  # regular expression of `A-Z+[A-Z0-9]`, which represents
+                  # UPPER_SNAKE_CASE.
+            },
+            "help": { # Provides links to documentation or for performing an out of band action.
+                #
+                # For example, if a quota check failed with an error indicating the calling
+                # project hasn't enabled the accessed service, this can contain a URL pointing
+                # directly to the right place in the developer console to flip the bit.
+              "links": [ # URL(s) pointing to additional information on handling the current error.
+                { # Describes a URL link.
+                  "description": "A String", # Describes what the link offers.
+                  "url": "A String", # The URL of the link.
+                },
+              ],
+            },
+            "localizedMessage": { # Provides a localized error message that is safe to return to the user
+                # which can be attached to an RPC error.
+              "locale": "A String", # The locale used following the specification defined at
+                  # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
+                  # Examples are: "en-US", "fr-CH", "es-MX"
+              "message": "A String", # The localized error message in the above locale.
+            },
+            "quotaInfo": { # Additional details for quota exceeded error for resource quota.
+              "dimensions": { # The map holding related quota dimensions.
+                "a_key": "A String",
+              },
+              "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota
+                  #  type or metric.
+              "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type
+                  # or metric.
+              "limitName": "A String", # The name of the quota limit.
+              "metricName": "A String", # The Compute Engine quota metric name.
+              "rolloutStatus": "A String", # Rollout status of the future quota limit.
+            },
+          },
+        ],
+        "location": "A String", # [Output Only] Indicates the field in the request that caused the error.
+            # This property is optional.
+        "message": "A String", # [Output Only] An optional, human-readable error message.
+      },
+    ],
+  },
+  "getVersionOperationMetadata": {
+    "inlineSbomInfo": {
+      "currentComponentVersions": { # A mapping of components to their currently-applied versions or other
+          # appropriate identifiers.
+        "a_key": "A String",
+      },
+      "targetComponentVersions": { # A mapping of components to their target versions or other appropriate
+          # identifiers.
+        "a_key": "A String",
+      },
+    },
+  },
+  "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
+      # message that was returned, such as `NOT FOUND`.
+  "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
+      # status code that was returned. For example, a `404` means the
+      # resource was not found.
+  "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is
+      # defined by the server.
+  "insertTime": "A String", # [Output Only] The time that this operation was requested.
+      # This value is inRFC3339
+      # text format.
+  "instancesBulkInsertOperationMetadata": {
+    "perLocationStatus": { # Status information per location (location name is key).
+        # Example key: zones/us-central1-a
+      "a_key": {
+        "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far.
+        "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback.
+        "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an
+            # error.
+        "status": "A String", # [Output Only] Creation status of BulkInsert operation - information
+            # if the flow is rolling forward or rolling back.
+        "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created.
+      },
+    },
+  },
+  "kind": "compute#operation", # Output only. [Output Only] Type of the resource. Always `compute#operation` for
+      # Operation resources.
+  "name": "A String", # [Output Only] Name of the operation.
+  "operationGroupId": "A String", # Output only. [Output Only] An ID that represents a group of operations, such as when a
+      # group of operations results from a `bulkInsert` API request.
+  "operationType": "A String", # [Output Only] The type of operation, such as `insert`,
+      # `update`, or `delete`, and so on.
+  "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
+      # There is no requirement that this be linear or support any granularity of
+      # operations. This should not be used to guess when the operation will be
+      # complete. This number should monotonically increase as the operation
+      # progresses.
+  "region": "A String", # [Output Only] The URL of the region where the operation resides. Only
+      # applicable when performing regional operations.
+  "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+  "selfLinkWithId": "A String", # Output only. [Output Only] Server-defined URL for this resource with the resource id.
+  "setCommonInstanceMetadataOperationMetadata": { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
+      # this field will contain information on all underlying zonal actions and
+      # their state.
+    "clientOperationId": "A String", # [Output Only] The client operation id.
+    "perLocationOperations": { # [Output Only] Status information per location (location name is key).
+        # Example key: zones/us-central1-a
+      "a_key": {
+        "error": { # The `Status` type defines a logical error model that is suitable for # [Output Only] If state is `ABANDONED` or `FAILED`, this field is
+            # populated.
+            # different programming environments, including REST APIs and RPC APIs. It is
+            # used by [gRPC](https://github.com/grpc). Each `Status` message contains
+            # three pieces of data: error code, error message, and error details.
+            #
+            # You can find out more about this error model and how to work with it in the
+            # [API Design Guide](https://cloud.google.com/apis/design/errors).
+          "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+          "details": [ # A list of messages that carry the error details.  There is a common set of
+              # message types for APIs to use.
+            {
+              "a_key": "", # Properties of the object. Contains field @type with type URL.
+            },
+          ],
+          "message": "A String", # A developer-facing error message, which should be in English. Any
+              # user-facing error message should be localized and sent in the
+              # google.rpc.Status.details field, or localized by the client.
+        },
+        "state": "A String", # [Output Only] Status of the action, which can be one of the following:
+            # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
+      },
+    },
+  },
+  "startTime": "A String", # [Output Only] The time that this operation was started by the server.
+      # This value is inRFC3339
+      # text format.
+  "status": "A String", # [Output Only] The status of the operation, which can be one of the
+      # following:
+      # `PENDING`, `RUNNING`, or `DONE`.
+  "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the
+      # operation.
+  "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation
+      # of the target resource.
+  "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For
+      # operations related to creating a snapshot, this points to the disk
+      # that the snapshot was created from.
+  "user": "A String", # [Output Only] User who requested the operation, for example:
+      # `user@example.com` or
+      # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
+  "warnings": [ # [Output Only] If warning messages are generated during processing of the
+      # operation, this field will be populated.
+    {
+      "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute
+          # Engine returns NO_RESULTS_ON_PAGE if there
+          # are no results in the response.
+      "data": [ # [Output Only] Metadata about this warning in key:
+          # value format. For example:
+          #
+          # "data": [
+          #   {
+          #    "key": "scope",
+          #    "value": "zones/us-east1-d"
+          #   }
+        {
+          "key": "A String", # [Output Only] A key that provides more detail on the warning being
+              # returned. For example, for warnings where there are no results in a list
+              # request for a particular zone, this key might be scope and
+              # the key value might be the zone name. Other examples might be a key
+              # indicating a deprecated resource and a suggested replacement, or a
+              # warning about invalid network settings (for example, if an instance
+              # attempts to perform IP forwarding but is not enabled for IP forwarding).
+          "value": "A String", # [Output Only] A warning data value corresponding to the key.
+        },
+      ],
+      "message": "A String", # [Output Only] A human-readable description of the warning code.
+    },
+  ],
+  "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only
+      # applicable when performing per-zone operations.
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/compute_alpha.organizationRolloutPlans.html b/docs/dyn/compute_alpha.organizationRolloutPlans.html new file mode 100644 index 0000000000..610096509c --- /dev/null +++ b/docs/dyn/compute_alpha.organizationRolloutPlans.html @@ -0,0 +1,1146 @@ + + + +

Compute Engine API . organizationRolloutPlans

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ delete(organization, rolloutPlan, requestId=None, x__xgafv=None)

+

Deletes an OrganizationRolloutPlan.

+

+ get(organization, rolloutPlan, x__xgafv=None)

+

Gets details of a single organization-scoped RolloutPlan.

+

+ insert(organization, body=None, requestId=None, x__xgafv=None)

+

Creates a new RolloutPlan in a given organization and location.

+

+ list(organization, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

+

Lists OrganizationRolloutPlans in a given organization and location.

+

+ list_next()

+

Retrieves the next page of results.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ delete(organization, rolloutPlan, requestId=None, x__xgafv=None) +
Deletes an OrganizationRolloutPlan.
+
+Args:
+  organization: string, Organization ID for this request. (required)
+  rolloutPlan: string, Name of the OrganizationRolloutPlan resource to delete. (required)
+  requestId: string, An optional request ID to identify requests. Specify a unique request ID so
+that if you must retry your request, the server will know to ignore the
+request if it has already been completed.
+
+For example, consider a situation where you make an initial request and
+the request times out. If you make the request again with the same
+request ID, the server can check if original operation with the same
+request ID was received, and if so, will ignore the second request. This
+prevents clients from accidentally creating duplicate commitments.
+
+The request ID must be
+a valid UUID with the exception that zero UUID is not supported
+(00000000-0000-0000-0000-000000000000).
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Represents an Operation resource.
+    #
+    # Google Compute Engine has three Operation resources:
+    #
+    # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
+    # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
+    # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
+    #
+    # You can use an operation resource to manage asynchronous API requests.
+    # For more information, readHandling
+    # API responses.
+    #
+    # Operations can be global, regional or zonal.
+    #
+    #    - For global operations, use the `globalOperations`
+    #    resource.
+    #    - For regional operations, use the
+    #    `regionOperations` resource.
+    #    - For zonal operations, use
+    #    the `zoneOperations` resource.
+    #
+    #
+    #
+    # For more information, read
+    # Global, Regional, and Zonal Resources.
+    #
+    # Note that completed Operation resources have a limited
+    # retention period.
+  "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request.
+      # Not present otherwise.
+  "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
+  "description": "A String", # [Output Only] A textual description of the operation, which is
+      # set when the operation is created.
+  "endTime": "A String", # [Output Only] The time that this operation was completed. This value is inRFC3339
+      # text format.
+  "error": { # [Output Only] If errors are generated during processing of the operation,
+      # this field will be populated.
+    "errors": [ # [Output Only] The array of errors encountered while processing this
+        # operation.
+      {
+        "code": "A String", # [Output Only] The error type identifier for this error.
+        "errorDetails": [ # [Output Only] An optional list of messages that contain the error
+            # details. There is a set of defined message types to use for providing
+            # details.The syntax depends on the error code. For example,
+            # QuotaExceededInfo will have details when the error code is
+            # QUOTA_EXCEEDED.
+          {
+            "errorInfo": { # Describes the cause of the error with structured details.
+                #
+                # Example of an error when contacting the "pubsub.googleapis.com" API when it
+                # is not enabled:
+                #
+                #     { "reason": "API_DISABLED"
+                #       "domain": "googleapis.com"
+                #       "metadata": {
+                #         "resource": "projects/123",
+                #         "service": "pubsub.googleapis.com"
+                #       }
+                #     }
+                #
+                # This response indicates that the pubsub.googleapis.com API is not enabled.
+                #
+                # Example of an error that is returned when attempting to create a Spanner
+                # instance in a region that is out of stock:
+                #
+                #     { "reason": "STOCKOUT"
+                #       "domain": "spanner.googleapis.com",
+                #       "metadata": {
+                #         "availableRegions": "us-central1,us-east2"
+                #       }
+                #     }
+              "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain
+                  # is typically the registered service name of the tool or product that
+                  # generates the error. Example: "pubsub.googleapis.com". If the error is
+                  # generated by some common infrastructure, the error domain must be a
+                  # globally unique value that identifies the infrastructure. For Google API
+                  # infrastructure, the error domain is "googleapis.com".
+              "metadatas": { # Additional structured details about this error.
+                  #
+                  # Keys must match a regular expression of `a-z+` but should
+                  # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
+                  # length. When identifying the current value of an exceeded limit, the units
+                  # should be contained in the key, not the value.  For example, rather than
+                  # `{"instanceLimit": "100/request"}`, should be returned as,
+                  # `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of
+                  # instances that can be created in a single (batch) request.
+                "a_key": "A String",
+              },
+              "reason": "A String", # The reason of the error. This is a constant value that identifies the
+                  # proximate cause of the error. Error reasons are unique within a particular
+                  # domain of errors. This should be at most 63 characters and match a
+                  # regular expression of `A-Z+[A-Z0-9]`, which represents
+                  # UPPER_SNAKE_CASE.
+            },
+            "help": { # Provides links to documentation or for performing an out of band action.
+                #
+                # For example, if a quota check failed with an error indicating the calling
+                # project hasn't enabled the accessed service, this can contain a URL pointing
+                # directly to the right place in the developer console to flip the bit.
+              "links": [ # URL(s) pointing to additional information on handling the current error.
+                { # Describes a URL link.
+                  "description": "A String", # Describes what the link offers.
+                  "url": "A String", # The URL of the link.
+                },
+              ],
+            },
+            "localizedMessage": { # Provides a localized error message that is safe to return to the user
+                # which can be attached to an RPC error.
+              "locale": "A String", # The locale used following the specification defined at
+                  # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
+                  # Examples are: "en-US", "fr-CH", "es-MX"
+              "message": "A String", # The localized error message in the above locale.
+            },
+            "quotaInfo": { # Additional details for quota exceeded error for resource quota.
+              "dimensions": { # The map holding related quota dimensions.
+                "a_key": "A String",
+              },
+              "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota
+                  #  type or metric.
+              "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type
+                  # or metric.
+              "limitName": "A String", # The name of the quota limit.
+              "metricName": "A String", # The Compute Engine quota metric name.
+              "rolloutStatus": "A String", # Rollout status of the future quota limit.
+            },
+          },
+        ],
+        "location": "A String", # [Output Only] Indicates the field in the request that caused the error.
+            # This property is optional.
+        "message": "A String", # [Output Only] An optional, human-readable error message.
+      },
+    ],
+  },
+  "getVersionOperationMetadata": {
+    "inlineSbomInfo": {
+      "currentComponentVersions": { # A mapping of components to their currently-applied versions or other
+          # appropriate identifiers.
+        "a_key": "A String",
+      },
+      "targetComponentVersions": { # A mapping of components to their target versions or other appropriate
+          # identifiers.
+        "a_key": "A String",
+      },
+    },
+  },
+  "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
+      # message that was returned, such as `NOT FOUND`.
+  "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
+      # status code that was returned. For example, a `404` means the
+      # resource was not found.
+  "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is
+      # defined by the server.
+  "insertTime": "A String", # [Output Only] The time that this operation was requested.
+      # This value is inRFC3339
+      # text format.
+  "instancesBulkInsertOperationMetadata": {
+    "perLocationStatus": { # Status information per location (location name is key).
+        # Example key: zones/us-central1-a
+      "a_key": {
+        "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far.
+        "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback.
+        "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an
+            # error.
+        "status": "A String", # [Output Only] Creation status of BulkInsert operation - information
+            # if the flow is rolling forward or rolling back.
+        "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created.
+      },
+    },
+  },
+  "kind": "compute#operation", # Output only. [Output Only] Type of the resource. Always `compute#operation` for
+      # Operation resources.
+  "name": "A String", # [Output Only] Name of the operation.
+  "operationGroupId": "A String", # Output only. [Output Only] An ID that represents a group of operations, such as when a
+      # group of operations results from a `bulkInsert` API request.
+  "operationType": "A String", # [Output Only] The type of operation, such as `insert`,
+      # `update`, or `delete`, and so on.
+  "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
+      # There is no requirement that this be linear or support any granularity of
+      # operations. This should not be used to guess when the operation will be
+      # complete. This number should monotonically increase as the operation
+      # progresses.
+  "region": "A String", # [Output Only] The URL of the region where the operation resides. Only
+      # applicable when performing regional operations.
+  "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+  "selfLinkWithId": "A String", # Output only. [Output Only] Server-defined URL for this resource with the resource id.
+  "setCommonInstanceMetadataOperationMetadata": { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
+      # this field will contain information on all underlying zonal actions and
+      # their state.
+    "clientOperationId": "A String", # [Output Only] The client operation id.
+    "perLocationOperations": { # [Output Only] Status information per location (location name is key).
+        # Example key: zones/us-central1-a
+      "a_key": {
+        "error": { # The `Status` type defines a logical error model that is suitable for # [Output Only] If state is `ABANDONED` or `FAILED`, this field is
+            # populated.
+            # different programming environments, including REST APIs and RPC APIs. It is
+            # used by [gRPC](https://github.com/grpc). Each `Status` message contains
+            # three pieces of data: error code, error message, and error details.
+            #
+            # You can find out more about this error model and how to work with it in the
+            # [API Design Guide](https://cloud.google.com/apis/design/errors).
+          "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+          "details": [ # A list of messages that carry the error details.  There is a common set of
+              # message types for APIs to use.
+            {
+              "a_key": "", # Properties of the object. Contains field @type with type URL.
+            },
+          ],
+          "message": "A String", # A developer-facing error message, which should be in English. Any
+              # user-facing error message should be localized and sent in the
+              # google.rpc.Status.details field, or localized by the client.
+        },
+        "state": "A String", # [Output Only] Status of the action, which can be one of the following:
+            # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
+      },
+    },
+  },
+  "startTime": "A String", # [Output Only] The time that this operation was started by the server.
+      # This value is inRFC3339
+      # text format.
+  "status": "A String", # [Output Only] The status of the operation, which can be one of the
+      # following:
+      # `PENDING`, `RUNNING`, or `DONE`.
+  "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the
+      # operation.
+  "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation
+      # of the target resource.
+  "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For
+      # operations related to creating a snapshot, this points to the disk
+      # that the snapshot was created from.
+  "user": "A String", # [Output Only] User who requested the operation, for example:
+      # `user@example.com` or
+      # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
+  "warnings": [ # [Output Only] If warning messages are generated during processing of the
+      # operation, this field will be populated.
+    {
+      "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute
+          # Engine returns NO_RESULTS_ON_PAGE if there
+          # are no results in the response.
+      "data": [ # [Output Only] Metadata about this warning in key:
+          # value format. For example:
+          #
+          # "data": [
+          #   {
+          #    "key": "scope",
+          #    "value": "zones/us-east1-d"
+          #   }
+        {
+          "key": "A String", # [Output Only] A key that provides more detail on the warning being
+              # returned. For example, for warnings where there are no results in a list
+              # request for a particular zone, this key might be scope and
+              # the key value might be the zone name. Other examples might be a key
+              # indicating a deprecated resource and a suggested replacement, or a
+              # warning about invalid network settings (for example, if an instance
+              # attempts to perform IP forwarding but is not enabled for IP forwarding).
+          "value": "A String", # [Output Only] A warning data value corresponding to the key.
+        },
+      ],
+      "message": "A String", # [Output Only] A human-readable description of the warning code.
+    },
+  ],
+  "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only
+      # applicable when performing per-zone operations.
+}
+
+ +
+ get(organization, rolloutPlan, x__xgafv=None) +
Gets details of a single organization-scoped RolloutPlan.
+
+Args:
+  organization: string, Organization ID for this request. (required)
+  rolloutPlan: string, Name of the persistent rollout plan to return. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # RolloutPlan resource.
+    #
+    # A RolloutPlan is the customer-defined strategy to divide a large-scale change
+    # into smaller increments, referred to as "waves". Each wave targets a specific
+    # portion of the overall affected area and defines criteria that must be met
+    # before progressing to the subsequent wave.
+  "creationTimestamp": "A String", # Output only. [Output Only] Creation timestamp inRFC3339
+      # text format.
+  "description": "A String", # An optional description of this resource. Provide this property when you
+      # create the resource.
+  "id": "A String", # Output only. [Output Only] The unique identifier for the resource. This identifier is
+      # defined by the server.
+  "kind": "compute#rolloutPlan", # Output only. [Output Only] Type of the resource. Always compute#rolloutPlan
+      # for rolloutPlans.
+  "locationScope": "A String", # The location scope of the rollout plan. If not specified, the location
+      # scope is considered as ZONAL.
+  "name": "A String", # Name of the resource. Provided by the client when the resource is created.
+      # The name must be 1-63 characters long, and comply withRFC1035.
+      # Specifically, the name must be 1-63 characters long and match the regular
+      # expression `[a-z]([-a-z0-9]*[a-z0-9])?`
+      # which means the first character must be a lowercase letter, and all
+      # following characters must be a dash, lowercase letter, or digit, except
+      # the last character, which cannot be a dash.
+  "selfLink": "A String", # Output only. [Output Only] Server-defined fully-qualified URL for this resource.
+  "selfLinkWithId": "A String", # Output only. [Output Only] Server-defined URL for this resource's resource id.
+  "waves": [ # Required. The waves included in this rollout plan.
+    { # A single wave in a rollout plan.
+      "displayName": "A String", # Optional. The display name of this wave of the rollout plan.
+      "number": "A String", # Output only. The wave number.
+      "orchestrationOptions": { # Options to control the pace of orchestration of a wave. These options are # Optional. The orchestration options for this wave.
+          # required only if the resource being rolled out follows the Orchestrated
+          # pattern.
+        "delays": [ # Optional. Delays, if any, to be added between batches of projects. We allow
+            # multiple Delays to be specified, letting users set separate delays
+            # between batches of projects corresponding to different locations and
+            # batches of projects corresponding to the same location.
+          { # Options to control the delay, if any, between batches of projects.
+            "delimiter": "A String", # Optional. Controls whether the delay should only be added between batches of
+                # projects corresponding to different locations, or also between
+                # batches of projects corresponding to the same location.
+                #
+                # Must be set to DELIMITER_UNSPECIFIED if no delay is to be added.
+            "duration": "A String", # Optional. The duration of the delay, if any, to be added between batches of
+                # projects. A zero duration corresponds to no delay.
+            "type": "A String", # Optional. Controls whether the specified duration is to be added at the end of
+                # each batch, or if the total processing time for each batch will be
+                # padded if needed to meet the specified duration.
+                #
+                # Must be set to TYPE_UNSPECIFIED if no delay is to be added.
+          },
+        ],
+        "maxConcurrentLocations": "A String", # Optional. Maximum number of locations to be orchestrated in parallel.
+        "maxConcurrentResourcesPerLocation": "A String", # Optional. Maximum number of resources to be orchestrated per location in
+            # parallel.
+      },
+      "selectors": [ # Required. The selectors for this wave. There is a logical AND between each selector
+          # defined in a wave, so a resource must satisfy the criteria of *all* the
+          # specified selectors to be in scope for the wave.
+        { # A selector which specifies what resource(s) are included in a given wave.
+          "locationSelector": { # Roll out to resources by location. # Optional. Roll out to resources by Cloud locations.
+            "includedLocations": [ # Optional. Example: "us-central1-a"
+              "A String",
+            ],
+          },
+          "resourceHierarchySelector": { # Roll out to resources by Cloud Resource Manager resource hierarchy # Optional. Roll out to resources by Cloud Resource Manager resource hierarchy.
+              # nodes such as projects, folders, orgs.
+            "includedFolders": [ # Optional. Format: "folders/{folder_id}"
+              "A String",
+            ],
+            "includedOrganizations": [ # Optional. Format: "organizations/{organization_id}"
+              "A String",
+            ],
+            "includedProjects": [ # Optional. Format: "projects/{project_id}"
+              "A String",
+            ],
+          },
+        },
+      ],
+      "validation": { # The validation to be performed before progressing to the next wave. # Required. The validation to be performed at the end of this wave.
+        "timeBasedValidationMetadata": { # Metadata required if type = "time". # Optional. Metadata required if type = "time".
+          "waitDuration": "A String", # Optional. The duration that the system waits in between waves. This wait starts
+              # after all changes in the wave are rolled out.
+        },
+        "type": "A String", # Required. The type of the validation. If a type of validation is associated with
+            # a metadata object, the appropriate metadata field mapping to the
+            # validation type must be provided in the validation message. Possible
+            # values are in quotes below alongside an explanation:
+            #   "manual": The system waits for an end-user approval API before
+            #     progressing to the next wave.
+            #   "time": The system waits for a user specified duration before
+            #     progressing to the next wave. TimeBasedValidation must be provided.
+      },
+    },
+  ],
+}
+
+ +
+ insert(organization, body=None, requestId=None, x__xgafv=None) +
Creates a new RolloutPlan in a given organization and location.
+
+Args:
+  organization: string, Organization ID for this request. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # RolloutPlan resource.
+    # 
+    # A RolloutPlan is the customer-defined strategy to divide a large-scale change
+    # into smaller increments, referred to as "waves". Each wave targets a specific
+    # portion of the overall affected area and defines criteria that must be met
+    # before progressing to the subsequent wave.
+  "creationTimestamp": "A String", # Output only. [Output Only] Creation timestamp inRFC3339
+      # text format.
+  "description": "A String", # An optional description of this resource. Provide this property when you
+      # create the resource.
+  "id": "A String", # Output only. [Output Only] The unique identifier for the resource. This identifier is
+      # defined by the server.
+  "kind": "compute#rolloutPlan", # Output only. [Output Only] Type of the resource. Always compute#rolloutPlan
+      # for rolloutPlans.
+  "locationScope": "A String", # The location scope of the rollout plan. If not specified, the location
+      # scope is considered as ZONAL.
+  "name": "A String", # Name of the resource. Provided by the client when the resource is created.
+      # The name must be 1-63 characters long, and comply withRFC1035.
+      # Specifically, the name must be 1-63 characters long and match the regular
+      # expression `[a-z]([-a-z0-9]*[a-z0-9])?`
+      # which means the first character must be a lowercase letter, and all
+      # following characters must be a dash, lowercase letter, or digit, except
+      # the last character, which cannot be a dash.
+  "selfLink": "A String", # Output only. [Output Only] Server-defined fully-qualified URL for this resource.
+  "selfLinkWithId": "A String", # Output only. [Output Only] Server-defined URL for this resource's resource id.
+  "waves": [ # Required. The waves included in this rollout plan.
+    { # A single wave in a rollout plan.
+      "displayName": "A String", # Optional. The display name of this wave of the rollout plan.
+      "number": "A String", # Output only. The wave number.
+      "orchestrationOptions": { # Options to control the pace of orchestration of a wave. These options are # Optional. The orchestration options for this wave.
+          # required only if the resource being rolled out follows the Orchestrated
+          # pattern.
+        "delays": [ # Optional. Delays, if any, to be added between batches of projects. We allow
+            # multiple Delays to be specified, letting users set separate delays
+            # between batches of projects corresponding to different locations and
+            # batches of projects corresponding to the same location.
+          { # Options to control the delay, if any, between batches of projects.
+            "delimiter": "A String", # Optional. Controls whether the delay should only be added between batches of
+                # projects corresponding to different locations, or also between
+                # batches of projects corresponding to the same location.
+                #
+                # Must be set to DELIMITER_UNSPECIFIED if no delay is to be added.
+            "duration": "A String", # Optional. The duration of the delay, if any, to be added between batches of
+                # projects. A zero duration corresponds to no delay.
+            "type": "A String", # Optional. Controls whether the specified duration is to be added at the end of
+                # each batch, or if the total processing time for each batch will be
+                # padded if needed to meet the specified duration.
+                #
+                # Must be set to TYPE_UNSPECIFIED if no delay is to be added.
+          },
+        ],
+        "maxConcurrentLocations": "A String", # Optional. Maximum number of locations to be orchestrated in parallel.
+        "maxConcurrentResourcesPerLocation": "A String", # Optional. Maximum number of resources to be orchestrated per location in
+            # parallel.
+      },
+      "selectors": [ # Required. The selectors for this wave. There is a logical AND between each selector
+          # defined in a wave, so a resource must satisfy the criteria of *all* the
+          # specified selectors to be in scope for the wave.
+        { # A selector which specifies what resource(s) are included in a given wave.
+          "locationSelector": { # Roll out to resources by location. # Optional. Roll out to resources by Cloud locations.
+            "includedLocations": [ # Optional. Example: "us-central1-a"
+              "A String",
+            ],
+          },
+          "resourceHierarchySelector": { # Roll out to resources by Cloud Resource Manager resource hierarchy # Optional. Roll out to resources by Cloud Resource Manager resource hierarchy.
+              # nodes such as projects, folders, orgs.
+            "includedFolders": [ # Optional. Format: "folders/{folder_id}"
+              "A String",
+            ],
+            "includedOrganizations": [ # Optional. Format: "organizations/{organization_id}"
+              "A String",
+            ],
+            "includedProjects": [ # Optional. Format: "projects/{project_id}"
+              "A String",
+            ],
+          },
+        },
+      ],
+      "validation": { # The validation to be performed before progressing to the next wave. # Required. The validation to be performed at the end of this wave.
+        "timeBasedValidationMetadata": { # Metadata required if type = "time". # Optional. Metadata required if type = "time".
+          "waitDuration": "A String", # Optional. The duration that the system waits in between waves. This wait starts
+              # after all changes in the wave are rolled out.
+        },
+        "type": "A String", # Required. The type of the validation. If a type of validation is associated with
+            # a metadata object, the appropriate metadata field mapping to the
+            # validation type must be provided in the validation message. Possible
+            # values are in quotes below alongside an explanation:
+            #   "manual": The system waits for an end-user approval API before
+            #     progressing to the next wave.
+            #   "time": The system waits for a user specified duration before
+            #     progressing to the next wave. TimeBasedValidation must be provided.
+      },
+    },
+  ],
+}
+
+  requestId: string, An optional request ID to identify requests. Specify a unique request ID so
+that if you must retry your request, the server will know to ignore the
+request if it has already been completed.
+
+For example, consider a situation where you make an initial request and
+the request times out. If you make the request again with the same
+request ID, the server can check if original operation with the same
+request ID was received, and if so, will ignore the second request. This
+prevents clients from accidentally creating duplicate commitments.
+
+The request ID must be
+a valid UUID with the exception that zero UUID is not supported
+(00000000-0000-0000-0000-000000000000).
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Represents an Operation resource.
+    #
+    # Google Compute Engine has three Operation resources:
+    #
+    # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
+    # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
+    # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
+    #
+    # You can use an operation resource to manage asynchronous API requests.
+    # For more information, readHandling
+    # API responses.
+    #
+    # Operations can be global, regional or zonal.
+    #
+    #    - For global operations, use the `globalOperations`
+    #    resource.
+    #    - For regional operations, use the
+    #    `regionOperations` resource.
+    #    - For zonal operations, use
+    #    the `zoneOperations` resource.
+    #
+    #
+    #
+    # For more information, read
+    # Global, Regional, and Zonal Resources.
+    #
+    # Note that completed Operation resources have a limited
+    # retention period.
+  "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request.
+      # Not present otherwise.
+  "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
+  "description": "A String", # [Output Only] A textual description of the operation, which is
+      # set when the operation is created.
+  "endTime": "A String", # [Output Only] The time that this operation was completed. This value is inRFC3339
+      # text format.
+  "error": { # [Output Only] If errors are generated during processing of the operation,
+      # this field will be populated.
+    "errors": [ # [Output Only] The array of errors encountered while processing this
+        # operation.
+      {
+        "code": "A String", # [Output Only] The error type identifier for this error.
+        "errorDetails": [ # [Output Only] An optional list of messages that contain the error
+            # details. There is a set of defined message types to use for providing
+            # details.The syntax depends on the error code. For example,
+            # QuotaExceededInfo will have details when the error code is
+            # QUOTA_EXCEEDED.
+          {
+            "errorInfo": { # Describes the cause of the error with structured details.
+                #
+                # Example of an error when contacting the "pubsub.googleapis.com" API when it
+                # is not enabled:
+                #
+                #     { "reason": "API_DISABLED"
+                #       "domain": "googleapis.com"
+                #       "metadata": {
+                #         "resource": "projects/123",
+                #         "service": "pubsub.googleapis.com"
+                #       }
+                #     }
+                #
+                # This response indicates that the pubsub.googleapis.com API is not enabled.
+                #
+                # Example of an error that is returned when attempting to create a Spanner
+                # instance in a region that is out of stock:
+                #
+                #     { "reason": "STOCKOUT"
+                #       "domain": "spanner.googleapis.com",
+                #       "metadata": {
+                #         "availableRegions": "us-central1,us-east2"
+                #       }
+                #     }
+              "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain
+                  # is typically the registered service name of the tool or product that
+                  # generates the error. Example: "pubsub.googleapis.com". If the error is
+                  # generated by some common infrastructure, the error domain must be a
+                  # globally unique value that identifies the infrastructure. For Google API
+                  # infrastructure, the error domain is "googleapis.com".
+              "metadatas": { # Additional structured details about this error.
+                  #
+                  # Keys must match a regular expression of `a-z+` but should
+                  # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
+                  # length. When identifying the current value of an exceeded limit, the units
+                  # should be contained in the key, not the value.  For example, rather than
+                  # `{"instanceLimit": "100/request"}`, should be returned as,
+                  # `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of
+                  # instances that can be created in a single (batch) request.
+                "a_key": "A String",
+              },
+              "reason": "A String", # The reason of the error. This is a constant value that identifies the
+                  # proximate cause of the error. Error reasons are unique within a particular
+                  # domain of errors. This should be at most 63 characters and match a
+                  # regular expression of `A-Z+[A-Z0-9]`, which represents
+                  # UPPER_SNAKE_CASE.
+            },
+            "help": { # Provides links to documentation or for performing an out of band action.
+                #
+                # For example, if a quota check failed with an error indicating the calling
+                # project hasn't enabled the accessed service, this can contain a URL pointing
+                # directly to the right place in the developer console to flip the bit.
+              "links": [ # URL(s) pointing to additional information on handling the current error.
+                { # Describes a URL link.
+                  "description": "A String", # Describes what the link offers.
+                  "url": "A String", # The URL of the link.
+                },
+              ],
+            },
+            "localizedMessage": { # Provides a localized error message that is safe to return to the user
+                # which can be attached to an RPC error.
+              "locale": "A String", # The locale used following the specification defined at
+                  # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
+                  # Examples are: "en-US", "fr-CH", "es-MX"
+              "message": "A String", # The localized error message in the above locale.
+            },
+            "quotaInfo": { # Additional details for quota exceeded error for resource quota.
+              "dimensions": { # The map holding related quota dimensions.
+                "a_key": "A String",
+              },
+              "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota
+                  #  type or metric.
+              "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type
+                  # or metric.
+              "limitName": "A String", # The name of the quota limit.
+              "metricName": "A String", # The Compute Engine quota metric name.
+              "rolloutStatus": "A String", # Rollout status of the future quota limit.
+            },
+          },
+        ],
+        "location": "A String", # [Output Only] Indicates the field in the request that caused the error.
+            # This property is optional.
+        "message": "A String", # [Output Only] An optional, human-readable error message.
+      },
+    ],
+  },
+  "getVersionOperationMetadata": {
+    "inlineSbomInfo": {
+      "currentComponentVersions": { # A mapping of components to their currently-applied versions or other
+          # appropriate identifiers.
+        "a_key": "A String",
+      },
+      "targetComponentVersions": { # A mapping of components to their target versions or other appropriate
+          # identifiers.
+        "a_key": "A String",
+      },
+    },
+  },
+  "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
+      # message that was returned, such as `NOT FOUND`.
+  "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
+      # status code that was returned. For example, a `404` means the
+      # resource was not found.
+  "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is
+      # defined by the server.
+  "insertTime": "A String", # [Output Only] The time that this operation was requested.
+      # This value is inRFC3339
+      # text format.
+  "instancesBulkInsertOperationMetadata": {
+    "perLocationStatus": { # Status information per location (location name is key).
+        # Example key: zones/us-central1-a
+      "a_key": {
+        "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far.
+        "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback.
+        "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an
+            # error.
+        "status": "A String", # [Output Only] Creation status of BulkInsert operation - information
+            # if the flow is rolling forward or rolling back.
+        "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created.
+      },
+    },
+  },
+  "kind": "compute#operation", # Output only. [Output Only] Type of the resource. Always `compute#operation` for
+      # Operation resources.
+  "name": "A String", # [Output Only] Name of the operation.
+  "operationGroupId": "A String", # Output only. [Output Only] An ID that represents a group of operations, such as when a
+      # group of operations results from a `bulkInsert` API request.
+  "operationType": "A String", # [Output Only] The type of operation, such as `insert`,
+      # `update`, or `delete`, and so on.
+  "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
+      # There is no requirement that this be linear or support any granularity of
+      # operations. This should not be used to guess when the operation will be
+      # complete. This number should monotonically increase as the operation
+      # progresses.
+  "region": "A String", # [Output Only] The URL of the region where the operation resides. Only
+      # applicable when performing regional operations.
+  "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+  "selfLinkWithId": "A String", # Output only. [Output Only] Server-defined URL for this resource with the resource id.
+  "setCommonInstanceMetadataOperationMetadata": { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
+      # this field will contain information on all underlying zonal actions and
+      # their state.
+    "clientOperationId": "A String", # [Output Only] The client operation id.
+    "perLocationOperations": { # [Output Only] Status information per location (location name is key).
+        # Example key: zones/us-central1-a
+      "a_key": {
+        "error": { # The `Status` type defines a logical error model that is suitable for # [Output Only] If state is `ABANDONED` or `FAILED`, this field is
+            # populated.
+            # different programming environments, including REST APIs and RPC APIs. It is
+            # used by [gRPC](https://github.com/grpc). Each `Status` message contains
+            # three pieces of data: error code, error message, and error details.
+            #
+            # You can find out more about this error model and how to work with it in the
+            # [API Design Guide](https://cloud.google.com/apis/design/errors).
+          "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+          "details": [ # A list of messages that carry the error details.  There is a common set of
+              # message types for APIs to use.
+            {
+              "a_key": "", # Properties of the object. Contains field @type with type URL.
+            },
+          ],
+          "message": "A String", # A developer-facing error message, which should be in English. Any
+              # user-facing error message should be localized and sent in the
+              # google.rpc.Status.details field, or localized by the client.
+        },
+        "state": "A String", # [Output Only] Status of the action, which can be one of the following:
+            # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
+      },
+    },
+  },
+  "startTime": "A String", # [Output Only] The time that this operation was started by the server.
+      # This value is inRFC3339
+      # text format.
+  "status": "A String", # [Output Only] The status of the operation, which can be one of the
+      # following:
+      # `PENDING`, `RUNNING`, or `DONE`.
+  "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the
+      # operation.
+  "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation
+      # of the target resource.
+  "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For
+      # operations related to creating a snapshot, this points to the disk
+      # that the snapshot was created from.
+  "user": "A String", # [Output Only] User who requested the operation, for example:
+      # `user@example.com` or
+      # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
+  "warnings": [ # [Output Only] If warning messages are generated during processing of the
+      # operation, this field will be populated.
+    {
+      "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute
+          # Engine returns NO_RESULTS_ON_PAGE if there
+          # are no results in the response.
+      "data": [ # [Output Only] Metadata about this warning in key:
+          # value format. For example:
+          #
+          # "data": [
+          #   {
+          #    "key": "scope",
+          #    "value": "zones/us-east1-d"
+          #   }
+        {
+          "key": "A String", # [Output Only] A key that provides more detail on the warning being
+              # returned. For example, for warnings where there are no results in a list
+              # request for a particular zone, this key might be scope and
+              # the key value might be the zone name. Other examples might be a key
+              # indicating a deprecated resource and a suggested replacement, or a
+              # warning about invalid network settings (for example, if an instance
+              # attempts to perform IP forwarding but is not enabled for IP forwarding).
+          "value": "A String", # [Output Only] A warning data value corresponding to the key.
+        },
+      ],
+      "message": "A String", # [Output Only] A human-readable description of the warning code.
+    },
+  ],
+  "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only
+      # applicable when performing per-zone operations.
+}
+
+ +
+ list(organization, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None) +
Lists OrganizationRolloutPlans in a given organization and location.
+
+Args:
+  organization: string, Organization ID for this request. (required)
+  filter: string, A filter expression that filters resources listed in the response. Most
+Compute resources support two types of filter expressions:
+expressions that support regular expressions and expressions that follow
+API improvement proposal AIP-160.
+These two types of filter expressions cannot be mixed in one request.
+
+If you want to use AIP-160, your expression must specify the field name, an
+operator, and the value that you want to use for filtering. The value
+must be a string, a number, or a boolean. The operator
+must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.
+
+For example, if you are filtering Compute Engine instances, you can
+exclude instances named `example-instance` by specifying
+`name != example-instance`.
+
+The `:*` comparison can be used to test whether a key has been defined.
+For example, to find all objects with `owner` label use:
+```
+labels.owner:*
+```
+
+You can also filter nested fields. For example, you could specify
+`scheduling.automaticRestart = false` to include instances only
+if they are not scheduled for automatic restarts. You can use filtering
+on nested fields to filter based onresource labels.
+
+To filter on multiple expressions, provide each separate expression within
+parentheses. For example:
+```
+(scheduling.automaticRestart = true)
+(cpuPlatform = "Intel Skylake")
+```
+By default, each expression is an `AND` expression. However, you
+can include `AND` and `OR` expressions explicitly.
+For example:
+```
+(cpuPlatform = "Intel Skylake") OR
+(cpuPlatform = "Intel Broadwell") AND
+(scheduling.automaticRestart = true)
+```
+
+If you want to use a regular expression, use the `eq` (equal) or `ne`
+(not equal) operator against a single un-parenthesized expression with or
+without quotes or against multiple parenthesized expressions. Examples:
+
+`fieldname eq unquoted literal`
+`fieldname eq 'single quoted literal'`
+`fieldname eq "double quoted literal"`
+`(fieldname1 eq literal) (fieldname2 ne "literal")`
+
+The literal value is interpreted as a regular expression using GoogleRE2 library syntax.
+The literal value must match the entire field.
+
+For example, to filter for instances that do not end with name "instance",
+you would use `name ne .*instance`.
+
+You cannot combine constraints on multiple fields using regular
+expressions.
+  maxResults: integer, The maximum number of results per page that should be returned.
+If the number of available results is larger than `maxResults`,
+Compute Engine returns a `nextPageToken` that can be used to get
+the next page of results in subsequent list requests. Acceptable values are
+`0` to `500`, inclusive. (Default: `500`)
+  orderBy: string, Sorts list results by a certain order. By default, results
+are returned in alphanumerical order based on the resource name.
+
+You can also sort results in descending order based on the creation
+timestamp using `orderBy="creationTimestamp desc"`. This sorts
+results based on the `creationTimestamp` field in
+reverse chronological order (newest result first). Use this to sort
+resources like operations so that the newest operation is returned first.
+
+Currently, only sorting by `name` or
+`creationTimestamp desc` is supported.
+  pageToken: string, Specifies a page token to use. Set `pageToken` to the
+`nextPageToken` returned by a previous list request to get
+the next page of results.
+  returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case
+of failure. The default value is false.
+
+For example, when partial success behavior is enabled, aggregatedList for a
+single zone scope either returns all resources in the zone or no resources,
+with an error code.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Contains a list of RolloutPlan resources.
+  "etag": "A String",
+  "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
+  "items": [ # A list of RolloutPlan resources.
+    { # RolloutPlan resource.
+        #
+        # A RolloutPlan is the customer-defined strategy to divide a large-scale change
+        # into smaller increments, referred to as "waves". Each wave targets a specific
+        # portion of the overall affected area and defines criteria that must be met
+        # before progressing to the subsequent wave.
+      "creationTimestamp": "A String", # Output only. [Output Only] Creation timestamp inRFC3339
+          # text format.
+      "description": "A String", # An optional description of this resource. Provide this property when you
+          # create the resource.
+      "id": "A String", # Output only. [Output Only] The unique identifier for the resource. This identifier is
+          # defined by the server.
+      "kind": "compute#rolloutPlan", # Output only. [Output Only] Type of the resource. Always compute#rolloutPlan
+          # for rolloutPlans.
+      "locationScope": "A String", # The location scope of the rollout plan. If not specified, the location
+          # scope is considered as ZONAL.
+      "name": "A String", # Name of the resource. Provided by the client when the resource is created.
+          # The name must be 1-63 characters long, and comply withRFC1035.
+          # Specifically, the name must be 1-63 characters long and match the regular
+          # expression `[a-z]([-a-z0-9]*[a-z0-9])?`
+          # which means the first character must be a lowercase letter, and all
+          # following characters must be a dash, lowercase letter, or digit, except
+          # the last character, which cannot be a dash.
+      "selfLink": "A String", # Output only. [Output Only] Server-defined fully-qualified URL for this resource.
+      "selfLinkWithId": "A String", # Output only. [Output Only] Server-defined URL for this resource's resource id.
+      "waves": [ # Required. The waves included in this rollout plan.
+        { # A single wave in a rollout plan.
+          "displayName": "A String", # Optional. The display name of this wave of the rollout plan.
+          "number": "A String", # Output only. The wave number.
+          "orchestrationOptions": { # Options to control the pace of orchestration of a wave. These options are # Optional. The orchestration options for this wave.
+              # required only if the resource being rolled out follows the Orchestrated
+              # pattern.
+            "delays": [ # Optional. Delays, if any, to be added between batches of projects. We allow
+                # multiple Delays to be specified, letting users set separate delays
+                # between batches of projects corresponding to different locations and
+                # batches of projects corresponding to the same location.
+              { # Options to control the delay, if any, between batches of projects.
+                "delimiter": "A String", # Optional. Controls whether the delay should only be added between batches of
+                    # projects corresponding to different locations, or also between
+                    # batches of projects corresponding to the same location.
+                    #
+                    # Must be set to DELIMITER_UNSPECIFIED if no delay is to be added.
+                "duration": "A String", # Optional. The duration of the delay, if any, to be added between batches of
+                    # projects. A zero duration corresponds to no delay.
+                "type": "A String", # Optional. Controls whether the specified duration is to be added at the end of
+                    # each batch, or if the total processing time for each batch will be
+                    # padded if needed to meet the specified duration.
+                    #
+                    # Must be set to TYPE_UNSPECIFIED if no delay is to be added.
+              },
+            ],
+            "maxConcurrentLocations": "A String", # Optional. Maximum number of locations to be orchestrated in parallel.
+            "maxConcurrentResourcesPerLocation": "A String", # Optional. Maximum number of resources to be orchestrated per location in
+                # parallel.
+          },
+          "selectors": [ # Required. The selectors for this wave. There is a logical AND between each selector
+              # defined in a wave, so a resource must satisfy the criteria of *all* the
+              # specified selectors to be in scope for the wave.
+            { # A selector which specifies what resource(s) are included in a given wave.
+              "locationSelector": { # Roll out to resources by location. # Optional. Roll out to resources by Cloud locations.
+                "includedLocations": [ # Optional. Example: "us-central1-a"
+                  "A String",
+                ],
+              },
+              "resourceHierarchySelector": { # Roll out to resources by Cloud Resource Manager resource hierarchy # Optional. Roll out to resources by Cloud Resource Manager resource hierarchy.
+                  # nodes such as projects, folders, orgs.
+                "includedFolders": [ # Optional. Format: "folders/{folder_id}"
+                  "A String",
+                ],
+                "includedOrganizations": [ # Optional. Format: "organizations/{organization_id}"
+                  "A String",
+                ],
+                "includedProjects": [ # Optional. Format: "projects/{project_id}"
+                  "A String",
+                ],
+              },
+            },
+          ],
+          "validation": { # The validation to be performed before progressing to the next wave. # Required. The validation to be performed at the end of this wave.
+            "timeBasedValidationMetadata": { # Metadata required if type = "time". # Optional. Metadata required if type = "time".
+              "waitDuration": "A String", # Optional. The duration that the system waits in between waves. This wait starts
+                  # after all changes in the wave are rolled out.
+            },
+            "type": "A String", # Required. The type of the validation. If a type of validation is associated with
+                # a metadata object, the appropriate metadata field mapping to the
+                # validation type must be provided in the validation message. Possible
+                # values are in quotes below alongside an explanation:
+                #   "manual": The system waits for an end-user approval API before
+                #     progressing to the next wave.
+                #   "time": The system waits for a user specified duration before
+                #     progressing to the next wave. TimeBasedValidation must be provided.
+          },
+        },
+      ],
+    },
+  ],
+  "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for
+      # list requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for
+      # the query parameter pageToken in the next list request.
+      # Subsequent list requests will have their own nextPageToken to
+      # continue paging through the results.
+  "selfLink": "A String", # Output only. [Output Only] Server-defined URL for this resource.
+  "unreachables": [ # Output only. [Output Only] Unreachable resources.
+      # end_interface: MixerListResponseWithEtagBuilder
+    "A String",
+  ],
+  "warning": { # [Output Only] Informational warning message.
+    "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute
+        # Engine returns NO_RESULTS_ON_PAGE if there
+        # are no results in the response.
+    "data": [ # [Output Only] Metadata about this warning in key:
+        # value format. For example:
+        #
+        # "data": [
+        #   {
+        #    "key": "scope",
+        #    "value": "zones/us-east1-d"
+        #   }
+      {
+        "key": "A String", # [Output Only] A key that provides more detail on the warning being
+            # returned. For example, for warnings where there are no results in a list
+            # request for a particular zone, this key might be scope and
+            # the key value might be the zone name. Other examples might be a key
+            # indicating a deprecated resource and a suggested replacement, or a
+            # warning about invalid network settings (for example, if an instance
+            # attempts to perform IP forwarding but is not enabled for IP forwarding).
+        "value": "A String", # [Output Only] A warning data value corresponding to the key.
+      },
+    ],
+    "message": "A String", # [Output Only] A human-readable description of the warning code.
+  },
+}
+
+ +
+ list_next() +
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+        
+
+ + \ No newline at end of file diff --git a/docs/dyn/compute_alpha.organizationRollouts.html b/docs/dyn/compute_alpha.organizationRollouts.html new file mode 100644 index 0000000000..77795513d9 --- /dev/null +++ b/docs/dyn/compute_alpha.organizationRollouts.html @@ -0,0 +1,1927 @@ + + + +

Compute Engine API . organizationRollouts

+

Instance Methods

+

+ advance(organization, rollout, currentWaveNumber=None, requestId=None, x__xgafv=None)

+

Advances a Rollout to the next wave, or completes it if no waves remain.

+

+ cancel(organization, rollout, requestId=None, rollback=None, x__xgafv=None)

+

Cancels a Rollout.

+

+ close()

+

Close httplib2 connections.

+

+ delete(organization, rollout, requestId=None, x__xgafv=None)

+

Deletes a Rollout.

+

+ get(organization, rollout, x__xgafv=None)

+

Gets details of a single organization-scoped Rollout.

+

+ list(organization, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

+

Lists Rollouts in a given organization and location.

+

+ list_next()

+

Retrieves the next page of results.

+

+ pause(organization, rollout, etag=None, requestId=None, x__xgafv=None)

+

Pauses a Rollout.

+

+ resume(organization, rollout, etag=None, requestId=None, x__xgafv=None)

+

Resumes a Rollout.

+

Method Details

+
+ advance(organization, rollout, currentWaveNumber=None, requestId=None, x__xgafv=None) +
Advances a Rollout to the next wave, or completes it if no waves remain.
+
+Args:
+  organization: string, Required. Organization ID for this request. (required)
+  rollout: string, Required. Name of the Rollout resource to advance. (required)
+  currentWaveNumber: string, Required. Wave number of the current wave.
+  requestId: string, An optional request ID to identify requests. Specify a unique request ID so
+that if you must retry your request, the server will know to ignore the
+request if it has already been completed.
+
+For example, consider a situation where you make an initial request and
+the request times out. If you make the request again with the same
+request ID, the server can check if original operation with the same
+request ID was received, and if so, will ignore the second request. This
+prevents clients from accidentally creating duplicate commitments.
+
+The request ID must be
+a valid UUID with the exception that zero UUID is not supported
+(00000000-0000-0000-0000-000000000000).
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Represents an Operation resource.
+    #
+    # Google Compute Engine has three Operation resources:
+    #
+    # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
+    # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
+    # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
+    #
+    # You can use an operation resource to manage asynchronous API requests.
+    # For more information, readHandling
+    # API responses.
+    #
+    # Operations can be global, regional or zonal.
+    #
+    #    - For global operations, use the `globalOperations`
+    #    resource.
+    #    - For regional operations, use the
+    #    `regionOperations` resource.
+    #    - For zonal operations, use
+    #    the `zoneOperations` resource.
+    #
+    #
+    #
+    # For more information, read
+    # Global, Regional, and Zonal Resources.
+    #
+    # Note that completed Operation resources have a limited
+    # retention period.
+  "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request.
+      # Not present otherwise.
+  "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
+  "description": "A String", # [Output Only] A textual description of the operation, which is
+      # set when the operation is created.
+  "endTime": "A String", # [Output Only] The time that this operation was completed. This value is inRFC3339
+      # text format.
+  "error": { # [Output Only] If errors are generated during processing of the operation,
+      # this field will be populated.
+    "errors": [ # [Output Only] The array of errors encountered while processing this
+        # operation.
+      {
+        "code": "A String", # [Output Only] The error type identifier for this error.
+        "errorDetails": [ # [Output Only] An optional list of messages that contain the error
+            # details. There is a set of defined message types to use for providing
+            # details.The syntax depends on the error code. For example,
+            # QuotaExceededInfo will have details when the error code is
+            # QUOTA_EXCEEDED.
+          {
+            "errorInfo": { # Describes the cause of the error with structured details.
+                #
+                # Example of an error when contacting the "pubsub.googleapis.com" API when it
+                # is not enabled:
+                #
+                #     { "reason": "API_DISABLED"
+                #       "domain": "googleapis.com"
+                #       "metadata": {
+                #         "resource": "projects/123",
+                #         "service": "pubsub.googleapis.com"
+                #       }
+                #     }
+                #
+                # This response indicates that the pubsub.googleapis.com API is not enabled.
+                #
+                # Example of an error that is returned when attempting to create a Spanner
+                # instance in a region that is out of stock:
+                #
+                #     { "reason": "STOCKOUT"
+                #       "domain": "spanner.googleapis.com",
+                #       "metadata": {
+                #         "availableRegions": "us-central1,us-east2"
+                #       }
+                #     }
+              "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain
+                  # is typically the registered service name of the tool or product that
+                  # generates the error. Example: "pubsub.googleapis.com". If the error is
+                  # generated by some common infrastructure, the error domain must be a
+                  # globally unique value that identifies the infrastructure. For Google API
+                  # infrastructure, the error domain is "googleapis.com".
+              "metadatas": { # Additional structured details about this error.
+                  #
+                  # Keys must match a regular expression of `a-z+` but should
+                  # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
+                  # length. When identifying the current value of an exceeded limit, the units
+                  # should be contained in the key, not the value.  For example, rather than
+                  # `{"instanceLimit": "100/request"}`, should be returned as,
+                  # `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of
+                  # instances that can be created in a single (batch) request.
+                "a_key": "A String",
+              },
+              "reason": "A String", # The reason of the error. This is a constant value that identifies the
+                  # proximate cause of the error. Error reasons are unique within a particular
+                  # domain of errors. This should be at most 63 characters and match a
+                  # regular expression of `A-Z+[A-Z0-9]`, which represents
+                  # UPPER_SNAKE_CASE.
+            },
+            "help": { # Provides links to documentation or for performing an out of band action.
+                #
+                # For example, if a quota check failed with an error indicating the calling
+                # project hasn't enabled the accessed service, this can contain a URL pointing
+                # directly to the right place in the developer console to flip the bit.
+              "links": [ # URL(s) pointing to additional information on handling the current error.
+                { # Describes a URL link.
+                  "description": "A String", # Describes what the link offers.
+                  "url": "A String", # The URL of the link.
+                },
+              ],
+            },
+            "localizedMessage": { # Provides a localized error message that is safe to return to the user
+                # which can be attached to an RPC error.
+              "locale": "A String", # The locale used following the specification defined at
+                  # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
+                  # Examples are: "en-US", "fr-CH", "es-MX"
+              "message": "A String", # The localized error message in the above locale.
+            },
+            "quotaInfo": { # Additional details for quota exceeded error for resource quota.
+              "dimensions": { # The map holding related quota dimensions.
+                "a_key": "A String",
+              },
+              "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota
+                  #  type or metric.
+              "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type
+                  # or metric.
+              "limitName": "A String", # The name of the quota limit.
+              "metricName": "A String", # The Compute Engine quota metric name.
+              "rolloutStatus": "A String", # Rollout status of the future quota limit.
+            },
+          },
+        ],
+        "location": "A String", # [Output Only] Indicates the field in the request that caused the error.
+            # This property is optional.
+        "message": "A String", # [Output Only] An optional, human-readable error message.
+      },
+    ],
+  },
+  "getVersionOperationMetadata": {
+    "inlineSbomInfo": {
+      "currentComponentVersions": { # A mapping of components to their currently-applied versions or other
+          # appropriate identifiers.
+        "a_key": "A String",
+      },
+      "targetComponentVersions": { # A mapping of components to their target versions or other appropriate
+          # identifiers.
+        "a_key": "A String",
+      },
+    },
+  },
+  "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
+      # message that was returned, such as `NOT FOUND`.
+  "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
+      # status code that was returned. For example, a `404` means the
+      # resource was not found.
+  "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is
+      # defined by the server.
+  "insertTime": "A String", # [Output Only] The time that this operation was requested.
+      # This value is inRFC3339
+      # text format.
+  "instancesBulkInsertOperationMetadata": {
+    "perLocationStatus": { # Status information per location (location name is key).
+        # Example key: zones/us-central1-a
+      "a_key": {
+        "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far.
+        "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback.
+        "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an
+            # error.
+        "status": "A String", # [Output Only] Creation status of BulkInsert operation - information
+            # if the flow is rolling forward or rolling back.
+        "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created.
+      },
+    },
+  },
+  "kind": "compute#operation", # Output only. [Output Only] Type of the resource. Always `compute#operation` for
+      # Operation resources.
+  "name": "A String", # [Output Only] Name of the operation.
+  "operationGroupId": "A String", # Output only. [Output Only] An ID that represents a group of operations, such as when a
+      # group of operations results from a `bulkInsert` API request.
+  "operationType": "A String", # [Output Only] The type of operation, such as `insert`,
+      # `update`, or `delete`, and so on.
+  "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
+      # There is no requirement that this be linear or support any granularity of
+      # operations. This should not be used to guess when the operation will be
+      # complete. This number should monotonically increase as the operation
+      # progresses.
+  "region": "A String", # [Output Only] The URL of the region where the operation resides. Only
+      # applicable when performing regional operations.
+  "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+  "selfLinkWithId": "A String", # Output only. [Output Only] Server-defined URL for this resource with the resource id.
+  "setCommonInstanceMetadataOperationMetadata": { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
+      # this field will contain information on all underlying zonal actions and
+      # their state.
+    "clientOperationId": "A String", # [Output Only] The client operation id.
+    "perLocationOperations": { # [Output Only] Status information per location (location name is key).
+        # Example key: zones/us-central1-a
+      "a_key": {
+        "error": { # The `Status` type defines a logical error model that is suitable for # [Output Only] If state is `ABANDONED` or `FAILED`, this field is
+            # populated.
+            # different programming environments, including REST APIs and RPC APIs. It is
+            # used by [gRPC](https://github.com/grpc). Each `Status` message contains
+            # three pieces of data: error code, error message, and error details.
+            #
+            # You can find out more about this error model and how to work with it in the
+            # [API Design Guide](https://cloud.google.com/apis/design/errors).
+          "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+          "details": [ # A list of messages that carry the error details.  There is a common set of
+              # message types for APIs to use.
+            {
+              "a_key": "", # Properties of the object. Contains field @type with type URL.
+            },
+          ],
+          "message": "A String", # A developer-facing error message, which should be in English. Any
+              # user-facing error message should be localized and sent in the
+              # google.rpc.Status.details field, or localized by the client.
+        },
+        "state": "A String", # [Output Only] Status of the action, which can be one of the following:
+            # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
+      },
+    },
+  },
+  "startTime": "A String", # [Output Only] The time that this operation was started by the server.
+      # This value is inRFC3339
+      # text format.
+  "status": "A String", # [Output Only] The status of the operation, which can be one of the
+      # following:
+      # `PENDING`, `RUNNING`, or `DONE`.
+  "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the
+      # operation.
+  "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation
+      # of the target resource.
+  "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For
+      # operations related to creating a snapshot, this points to the disk
+      # that the snapshot was created from.
+  "user": "A String", # [Output Only] User who requested the operation, for example:
+      # `user@example.com` or
+      # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
+  "warnings": [ # [Output Only] If warning messages are generated during processing of the
+      # operation, this field will be populated.
+    {
+      "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute
+          # Engine returns NO_RESULTS_ON_PAGE if there
+          # are no results in the response.
+      "data": [ # [Output Only] Metadata about this warning in key:
+          # value format. For example:
+          #
+          # "data": [
+          #   {
+          #    "key": "scope",
+          #    "value": "zones/us-east1-d"
+          #   }
+        {
+          "key": "A String", # [Output Only] A key that provides more detail on the warning being
+              # returned. For example, for warnings where there are no results in a list
+              # request for a particular zone, this key might be scope and
+              # the key value might be the zone name. Other examples might be a key
+              # indicating a deprecated resource and a suggested replacement, or a
+              # warning about invalid network settings (for example, if an instance
+              # attempts to perform IP forwarding but is not enabled for IP forwarding).
+          "value": "A String", # [Output Only] A warning data value corresponding to the key.
+        },
+      ],
+      "message": "A String", # [Output Only] A human-readable description of the warning code.
+    },
+  ],
+  "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only
+      # applicable when performing per-zone operations.
+}
+
+ +
+ cancel(organization, rollout, requestId=None, rollback=None, x__xgafv=None) +
Cancels a Rollout.
+
+Args:
+  organization: string, Required. Organization ID for this request. (required)
+  rollout: string, Name of the Rollout resource to cancel. (required)
+  requestId: string, An optional request ID to identify requests. Specify a unique request ID so
+that if you must retry your request, the server will know to ignore the
+request if it has already been completed.
+
+For example, consider a situation where you make an initial request and
+the request times out. If you make the request again with the same
+request ID, the server can check if original operation with the same
+request ID was received, and if so, will ignore the second request. This
+prevents clients from accidentally creating duplicate commitments.
+
+The request ID must be
+a valid UUID with the exception that zero UUID is not supported
+(00000000-0000-0000-0000-000000000000).
+  rollback: boolean, Optional. If true, then the ongoing rollout must be rolled back. Else, just cancel
+the rollout without taking any further actions. Note that products must
+support at least one of these options, however, it does not need to support
+both.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Represents an Operation resource.
+    #
+    # Google Compute Engine has three Operation resources:
+    #
+    # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
+    # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
+    # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
+    #
+    # You can use an operation resource to manage asynchronous API requests.
+    # For more information, readHandling
+    # API responses.
+    #
+    # Operations can be global, regional or zonal.
+    #
+    #    - For global operations, use the `globalOperations`
+    #    resource.
+    #    - For regional operations, use the
+    #    `regionOperations` resource.
+    #    - For zonal operations, use
+    #    the `zoneOperations` resource.
+    #
+    #
+    #
+    # For more information, read
+    # Global, Regional, and Zonal Resources.
+    #
+    # Note that completed Operation resources have a limited
+    # retention period.
+  "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request.
+      # Not present otherwise.
+  "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
+  "description": "A String", # [Output Only] A textual description of the operation, which is
+      # set when the operation is created.
+  "endTime": "A String", # [Output Only] The time that this operation was completed. This value is inRFC3339
+      # text format.
+  "error": { # [Output Only] If errors are generated during processing of the operation,
+      # this field will be populated.
+    "errors": [ # [Output Only] The array of errors encountered while processing this
+        # operation.
+      {
+        "code": "A String", # [Output Only] The error type identifier for this error.
+        "errorDetails": [ # [Output Only] An optional list of messages that contain the error
+            # details. There is a set of defined message types to use for providing
+            # details.The syntax depends on the error code. For example,
+            # QuotaExceededInfo will have details when the error code is
+            # QUOTA_EXCEEDED.
+          {
+            "errorInfo": { # Describes the cause of the error with structured details.
+                #
+                # Example of an error when contacting the "pubsub.googleapis.com" API when it
+                # is not enabled:
+                #
+                #     { "reason": "API_DISABLED"
+                #       "domain": "googleapis.com"
+                #       "metadata": {
+                #         "resource": "projects/123",
+                #         "service": "pubsub.googleapis.com"
+                #       }
+                #     }
+                #
+                # This response indicates that the pubsub.googleapis.com API is not enabled.
+                #
+                # Example of an error that is returned when attempting to create a Spanner
+                # instance in a region that is out of stock:
+                #
+                #     { "reason": "STOCKOUT"
+                #       "domain": "spanner.googleapis.com",
+                #       "metadata": {
+                #         "availableRegions": "us-central1,us-east2"
+                #       }
+                #     }
+              "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain
+                  # is typically the registered service name of the tool or product that
+                  # generates the error. Example: "pubsub.googleapis.com". If the error is
+                  # generated by some common infrastructure, the error domain must be a
+                  # globally unique value that identifies the infrastructure. For Google API
+                  # infrastructure, the error domain is "googleapis.com".
+              "metadatas": { # Additional structured details about this error.
+                  #
+                  # Keys must match a regular expression of `a-z+` but should
+                  # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
+                  # length. When identifying the current value of an exceeded limit, the units
+                  # should be contained in the key, not the value.  For example, rather than
+                  # `{"instanceLimit": "100/request"}`, should be returned as,
+                  # `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of
+                  # instances that can be created in a single (batch) request.
+                "a_key": "A String",
+              },
+              "reason": "A String", # The reason of the error. This is a constant value that identifies the
+                  # proximate cause of the error. Error reasons are unique within a particular
+                  # domain of errors. This should be at most 63 characters and match a
+                  # regular expression of `A-Z+[A-Z0-9]`, which represents
+                  # UPPER_SNAKE_CASE.
+            },
+            "help": { # Provides links to documentation or for performing an out of band action.
+                #
+                # For example, if a quota check failed with an error indicating the calling
+                # project hasn't enabled the accessed service, this can contain a URL pointing
+                # directly to the right place in the developer console to flip the bit.
+              "links": [ # URL(s) pointing to additional information on handling the current error.
+                { # Describes a URL link.
+                  "description": "A String", # Describes what the link offers.
+                  "url": "A String", # The URL of the link.
+                },
+              ],
+            },
+            "localizedMessage": { # Provides a localized error message that is safe to return to the user
+                # which can be attached to an RPC error.
+              "locale": "A String", # The locale used following the specification defined at
+                  # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
+                  # Examples are: "en-US", "fr-CH", "es-MX"
+              "message": "A String", # The localized error message in the above locale.
+            },
+            "quotaInfo": { # Additional details for quota exceeded error for resource quota.
+              "dimensions": { # The map holding related quota dimensions.
+                "a_key": "A String",
+              },
+              "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota
+                  #  type or metric.
+              "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type
+                  # or metric.
+              "limitName": "A String", # The name of the quota limit.
+              "metricName": "A String", # The Compute Engine quota metric name.
+              "rolloutStatus": "A String", # Rollout status of the future quota limit.
+            },
+          },
+        ],
+        "location": "A String", # [Output Only] Indicates the field in the request that caused the error.
+            # This property is optional.
+        "message": "A String", # [Output Only] An optional, human-readable error message.
+      },
+    ],
+  },
+  "getVersionOperationMetadata": {
+    "inlineSbomInfo": {
+      "currentComponentVersions": { # A mapping of components to their currently-applied versions or other
+          # appropriate identifiers.
+        "a_key": "A String",
+      },
+      "targetComponentVersions": { # A mapping of components to their target versions or other appropriate
+          # identifiers.
+        "a_key": "A String",
+      },
+    },
+  },
+  "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
+      # message that was returned, such as `NOT FOUND`.
+  "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
+      # status code that was returned. For example, a `404` means the
+      # resource was not found.
+  "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is
+      # defined by the server.
+  "insertTime": "A String", # [Output Only] The time that this operation was requested.
+      # This value is inRFC3339
+      # text format.
+  "instancesBulkInsertOperationMetadata": {
+    "perLocationStatus": { # Status information per location (location name is key).
+        # Example key: zones/us-central1-a
+      "a_key": {
+        "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far.
+        "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback.
+        "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an
+            # error.
+        "status": "A String", # [Output Only] Creation status of BulkInsert operation - information
+            # if the flow is rolling forward or rolling back.
+        "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created.
+      },
+    },
+  },
+  "kind": "compute#operation", # Output only. [Output Only] Type of the resource. Always `compute#operation` for
+      # Operation resources.
+  "name": "A String", # [Output Only] Name of the operation.
+  "operationGroupId": "A String", # Output only. [Output Only] An ID that represents a group of operations, such as when a
+      # group of operations results from a `bulkInsert` API request.
+  "operationType": "A String", # [Output Only] The type of operation, such as `insert`,
+      # `update`, or `delete`, and so on.
+  "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
+      # There is no requirement that this be linear or support any granularity of
+      # operations. This should not be used to guess when the operation will be
+      # complete. This number should monotonically increase as the operation
+      # progresses.
+  "region": "A String", # [Output Only] The URL of the region where the operation resides. Only
+      # applicable when performing regional operations.
+  "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+  "selfLinkWithId": "A String", # Output only. [Output Only] Server-defined URL for this resource with the resource id.
+  "setCommonInstanceMetadataOperationMetadata": { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
+      # this field will contain information on all underlying zonal actions and
+      # their state.
+    "clientOperationId": "A String", # [Output Only] The client operation id.
+    "perLocationOperations": { # [Output Only] Status information per location (location name is key).
+        # Example key: zones/us-central1-a
+      "a_key": {
+        "error": { # The `Status` type defines a logical error model that is suitable for # [Output Only] If state is `ABANDONED` or `FAILED`, this field is
+            # populated.
+            # different programming environments, including REST APIs and RPC APIs. It is
+            # used by [gRPC](https://github.com/grpc). Each `Status` message contains
+            # three pieces of data: error code, error message, and error details.
+            #
+            # You can find out more about this error model and how to work with it in the
+            # [API Design Guide](https://cloud.google.com/apis/design/errors).
+          "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+          "details": [ # A list of messages that carry the error details.  There is a common set of
+              # message types for APIs to use.
+            {
+              "a_key": "", # Properties of the object. Contains field @type with type URL.
+            },
+          ],
+          "message": "A String", # A developer-facing error message, which should be in English. Any
+              # user-facing error message should be localized and sent in the
+              # google.rpc.Status.details field, or localized by the client.
+        },
+        "state": "A String", # [Output Only] Status of the action, which can be one of the following:
+            # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
+      },
+    },
+  },
+  "startTime": "A String", # [Output Only] The time that this operation was started by the server.
+      # This value is inRFC3339
+      # text format.
+  "status": "A String", # [Output Only] The status of the operation, which can be one of the
+      # following:
+      # `PENDING`, `RUNNING`, or `DONE`.
+  "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the
+      # operation.
+  "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation
+      # of the target resource.
+  "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For
+      # operations related to creating a snapshot, this points to the disk
+      # that the snapshot was created from.
+  "user": "A String", # [Output Only] User who requested the operation, for example:
+      # `user@example.com` or
+      # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
+  "warnings": [ # [Output Only] If warning messages are generated during processing of the
+      # operation, this field will be populated.
+    {
+      "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute
+          # Engine returns NO_RESULTS_ON_PAGE if there
+          # are no results in the response.
+      "data": [ # [Output Only] Metadata about this warning in key:
+          # value format. For example:
+          #
+          # "data": [
+          #   {
+          #    "key": "scope",
+          #    "value": "zones/us-east1-d"
+          #   }
+        {
+          "key": "A String", # [Output Only] A key that provides more detail on the warning being
+              # returned. For example, for warnings where there are no results in a list
+              # request for a particular zone, this key might be scope and
+              # the key value might be the zone name. Other examples might be a key
+              # indicating a deprecated resource and a suggested replacement, or a
+              # warning about invalid network settings (for example, if an instance
+              # attempts to perform IP forwarding but is not enabled for IP forwarding).
+          "value": "A String", # [Output Only] A warning data value corresponding to the key.
+        },
+      ],
+      "message": "A String", # [Output Only] A human-readable description of the warning code.
+    },
+  ],
+  "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only
+      # applicable when performing per-zone operations.
+}
+
+ +
+ close() +
Close httplib2 connections.
+
+ +
+ delete(organization, rollout, requestId=None, x__xgafv=None) +
Deletes a Rollout.
+
+Args:
+  organization: string, Required. Organization ID for this request. (required)
+  rollout: string, Name of the Rollout resource to delete. (required)
+  requestId: string, An optional request ID to identify requests. Specify a unique request ID so
+that if you must retry your request, the server will know to ignore the
+request if it has already been completed.
+
+For example, consider a situation where you make an initial request and
+the request times out. If you make the request again with the same
+request ID, the server can check if original operation with the same
+request ID was received, and if so, will ignore the second request. This
+prevents clients from accidentally creating duplicate commitments.
+
+The request ID must be
+a valid UUID with the exception that zero UUID is not supported
+(00000000-0000-0000-0000-000000000000).
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Represents an Operation resource.
+    #
+    # Google Compute Engine has three Operation resources:
+    #
+    # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
+    # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
+    # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
+    #
+    # You can use an operation resource to manage asynchronous API requests.
+    # For more information, readHandling
+    # API responses.
+    #
+    # Operations can be global, regional or zonal.
+    #
+    #    - For global operations, use the `globalOperations`
+    #    resource.
+    #    - For regional operations, use the
+    #    `regionOperations` resource.
+    #    - For zonal operations, use
+    #    the `zoneOperations` resource.
+    #
+    #
+    #
+    # For more information, read
+    # Global, Regional, and Zonal Resources.
+    #
+    # Note that completed Operation resources have a limited
+    # retention period.
+  "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request.
+      # Not present otherwise.
+  "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
+  "description": "A String", # [Output Only] A textual description of the operation, which is
+      # set when the operation is created.
+  "endTime": "A String", # [Output Only] The time that this operation was completed. This value is inRFC3339
+      # text format.
+  "error": { # [Output Only] If errors are generated during processing of the operation,
+      # this field will be populated.
+    "errors": [ # [Output Only] The array of errors encountered while processing this
+        # operation.
+      {
+        "code": "A String", # [Output Only] The error type identifier for this error.
+        "errorDetails": [ # [Output Only] An optional list of messages that contain the error
+            # details. There is a set of defined message types to use for providing
+            # details.The syntax depends on the error code. For example,
+            # QuotaExceededInfo will have details when the error code is
+            # QUOTA_EXCEEDED.
+          {
+            "errorInfo": { # Describes the cause of the error with structured details.
+                #
+                # Example of an error when contacting the "pubsub.googleapis.com" API when it
+                # is not enabled:
+                #
+                #     { "reason": "API_DISABLED"
+                #       "domain": "googleapis.com"
+                #       "metadata": {
+                #         "resource": "projects/123",
+                #         "service": "pubsub.googleapis.com"
+                #       }
+                #     }
+                #
+                # This response indicates that the pubsub.googleapis.com API is not enabled.
+                #
+                # Example of an error that is returned when attempting to create a Spanner
+                # instance in a region that is out of stock:
+                #
+                #     { "reason": "STOCKOUT"
+                #       "domain": "spanner.googleapis.com",
+                #       "metadata": {
+                #         "availableRegions": "us-central1,us-east2"
+                #       }
+                #     }
+              "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain
+                  # is typically the registered service name of the tool or product that
+                  # generates the error. Example: "pubsub.googleapis.com". If the error is
+                  # generated by some common infrastructure, the error domain must be a
+                  # globally unique value that identifies the infrastructure. For Google API
+                  # infrastructure, the error domain is "googleapis.com".
+              "metadatas": { # Additional structured details about this error.
+                  #
+                  # Keys must match a regular expression of `a-z+` but should
+                  # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
+                  # length. When identifying the current value of an exceeded limit, the units
+                  # should be contained in the key, not the value.  For example, rather than
+                  # `{"instanceLimit": "100/request"}`, should be returned as,
+                  # `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of
+                  # instances that can be created in a single (batch) request.
+                "a_key": "A String",
+              },
+              "reason": "A String", # The reason of the error. This is a constant value that identifies the
+                  # proximate cause of the error. Error reasons are unique within a particular
+                  # domain of errors. This should be at most 63 characters and match a
+                  # regular expression of `A-Z+[A-Z0-9]`, which represents
+                  # UPPER_SNAKE_CASE.
+            },
+            "help": { # Provides links to documentation or for performing an out of band action.
+                #
+                # For example, if a quota check failed with an error indicating the calling
+                # project hasn't enabled the accessed service, this can contain a URL pointing
+                # directly to the right place in the developer console to flip the bit.
+              "links": [ # URL(s) pointing to additional information on handling the current error.
+                { # Describes a URL link.
+                  "description": "A String", # Describes what the link offers.
+                  "url": "A String", # The URL of the link.
+                },
+              ],
+            },
+            "localizedMessage": { # Provides a localized error message that is safe to return to the user
+                # which can be attached to an RPC error.
+              "locale": "A String", # The locale used following the specification defined at
+                  # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
+                  # Examples are: "en-US", "fr-CH", "es-MX"
+              "message": "A String", # The localized error message in the above locale.
+            },
+            "quotaInfo": { # Additional details for quota exceeded error for resource quota.
+              "dimensions": { # The map holding related quota dimensions.
+                "a_key": "A String",
+              },
+              "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota
+                  #  type or metric.
+              "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type
+                  # or metric.
+              "limitName": "A String", # The name of the quota limit.
+              "metricName": "A String", # The Compute Engine quota metric name.
+              "rolloutStatus": "A String", # Rollout status of the future quota limit.
+            },
+          },
+        ],
+        "location": "A String", # [Output Only] Indicates the field in the request that caused the error.
+            # This property is optional.
+        "message": "A String", # [Output Only] An optional, human-readable error message.
+      },
+    ],
+  },
+  "getVersionOperationMetadata": {
+    "inlineSbomInfo": {
+      "currentComponentVersions": { # A mapping of components to their currently-applied versions or other
+          # appropriate identifiers.
+        "a_key": "A String",
+      },
+      "targetComponentVersions": { # A mapping of components to their target versions or other appropriate
+          # identifiers.
+        "a_key": "A String",
+      },
+    },
+  },
+  "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
+      # message that was returned, such as `NOT FOUND`.
+  "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
+      # status code that was returned. For example, a `404` means the
+      # resource was not found.
+  "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is
+      # defined by the server.
+  "insertTime": "A String", # [Output Only] The time that this operation was requested.
+      # This value is inRFC3339
+      # text format.
+  "instancesBulkInsertOperationMetadata": {
+    "perLocationStatus": { # Status information per location (location name is key).
+        # Example key: zones/us-central1-a
+      "a_key": {
+        "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far.
+        "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback.
+        "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an
+            # error.
+        "status": "A String", # [Output Only] Creation status of BulkInsert operation - information
+            # if the flow is rolling forward or rolling back.
+        "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created.
+      },
+    },
+  },
+  "kind": "compute#operation", # Output only. [Output Only] Type of the resource. Always `compute#operation` for
+      # Operation resources.
+  "name": "A String", # [Output Only] Name of the operation.
+  "operationGroupId": "A String", # Output only. [Output Only] An ID that represents a group of operations, such as when a
+      # group of operations results from a `bulkInsert` API request.
+  "operationType": "A String", # [Output Only] The type of operation, such as `insert`,
+      # `update`, or `delete`, and so on.
+  "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
+      # There is no requirement that this be linear or support any granularity of
+      # operations. This should not be used to guess when the operation will be
+      # complete. This number should monotonically increase as the operation
+      # progresses.
+  "region": "A String", # [Output Only] The URL of the region where the operation resides. Only
+      # applicable when performing regional operations.
+  "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+  "selfLinkWithId": "A String", # Output only. [Output Only] Server-defined URL for this resource with the resource id.
+  "setCommonInstanceMetadataOperationMetadata": { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
+      # this field will contain information on all underlying zonal actions and
+      # their state.
+    "clientOperationId": "A String", # [Output Only] The client operation id.
+    "perLocationOperations": { # [Output Only] Status information per location (location name is key).
+        # Example key: zones/us-central1-a
+      "a_key": {
+        "error": { # The `Status` type defines a logical error model that is suitable for # [Output Only] If state is `ABANDONED` or `FAILED`, this field is
+            # populated.
+            # different programming environments, including REST APIs and RPC APIs. It is
+            # used by [gRPC](https://github.com/grpc). Each `Status` message contains
+            # three pieces of data: error code, error message, and error details.
+            #
+            # You can find out more about this error model and how to work with it in the
+            # [API Design Guide](https://cloud.google.com/apis/design/errors).
+          "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+          "details": [ # A list of messages that carry the error details.  There is a common set of
+              # message types for APIs to use.
+            {
+              "a_key": "", # Properties of the object. Contains field @type with type URL.
+            },
+          ],
+          "message": "A String", # A developer-facing error message, which should be in English. Any
+              # user-facing error message should be localized and sent in the
+              # google.rpc.Status.details field, or localized by the client.
+        },
+        "state": "A String", # [Output Only] Status of the action, which can be one of the following:
+            # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
+      },
+    },
+  },
+  "startTime": "A String", # [Output Only] The time that this operation was started by the server.
+      # This value is inRFC3339
+      # text format.
+  "status": "A String", # [Output Only] The status of the operation, which can be one of the
+      # following:
+      # `PENDING`, `RUNNING`, or `DONE`.
+  "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the
+      # operation.
+  "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation
+      # of the target resource.
+  "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For
+      # operations related to creating a snapshot, this points to the disk
+      # that the snapshot was created from.
+  "user": "A String", # [Output Only] User who requested the operation, for example:
+      # `user@example.com` or
+      # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
+  "warnings": [ # [Output Only] If warning messages are generated during processing of the
+      # operation, this field will be populated.
+    {
+      "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute
+          # Engine returns NO_RESULTS_ON_PAGE if there
+          # are no results in the response.
+      "data": [ # [Output Only] Metadata about this warning in key:
+          # value format. For example:
+          #
+          # "data": [
+          #   {
+          #    "key": "scope",
+          #    "value": "zones/us-east1-d"
+          #   }
+        {
+          "key": "A String", # [Output Only] A key that provides more detail on the warning being
+              # returned. For example, for warnings where there are no results in a list
+              # request for a particular zone, this key might be scope and
+              # the key value might be the zone name. Other examples might be a key
+              # indicating a deprecated resource and a suggested replacement, or a
+              # warning about invalid network settings (for example, if an instance
+              # attempts to perform IP forwarding but is not enabled for IP forwarding).
+          "value": "A String", # [Output Only] A warning data value corresponding to the key.
+        },
+      ],
+      "message": "A String", # [Output Only] A human-readable description of the warning code.
+    },
+  ],
+  "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only
+      # applicable when performing per-zone operations.
+}
+
+ +
+ get(organization, rollout, x__xgafv=None) +
Gets details of a single organization-scoped Rollout.
+
+Args:
+  organization: string, Organization ID for this request. (required)
+  rollout: string, Name of the persistent rollout to return. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Rollout resource.
+    #
+    # A Rollout is a specific instance of a RolloutPlan. It represents a single
+    # execution of a strategy to roll out a specific resource. It also provides
+    # APIs to interact with the rollout.
+  "cancellationTime": "A String", # Output only. The timestamp at which the Rollout was cancelled.
+  "completionTime": "A String", # Output only. The timestamp at which the Rollout was completed.
+  "creationTimestamp": "A String", # Output only. [Output Only] Creation timestamp inRFC3339
+      # text format.
+  "currentWaveNumber": "A String", # Output only. The number of the currently running wave.
+      # Ex. 1
+  "description": "A String", # An optional description of this resource. Provide this property when you
+      # create the resource.
+  "etag": "A String", # Output only. etag of the Rollout
+      # Ex. abc1234
+  "id": "A String", # Output only. [Output Only] The unique identifier for the resource. This identifier is
+      # defined by the server.
+  "kind": "compute#rollout", # Output only. [Output Only] Type of the resource. Always compute#rollout
+      # for rollouts.
+  "name": "A String", # Name of the resource. Provided by the client when the resource is created.
+      # The name must be 1-63 characters long, and comply withRFC1035.
+      # Specifically, the name must be 1-63 characters long and match the regular
+      # expression `[a-z]([-a-z0-9]*[a-z0-9])?`
+      # which means the first character must be a lowercase letter, and all
+      # following characters must be a dash, lowercase letter, or digit, except
+      # the last character, which cannot be a dash.
+  "pauseTime": "A String", # Output only. The timestamp at which the Rollout was paused.
+  "resumeTime": "A String", # Output only. The timestamp at which the Rollout was resumed.
+  "rolloutEntity": { # Specifications of the resource to roll out. # Required. The resource being rolled out.
+    "orchestratedEntity": { # This message is used if the resource type follows the Orchestrated # Optional. Entity details for products using the Orchestrated Integration model.
+        # integration model with ProgressiveRollout.
+      "conflictBehavior": "A String", # Required. Specifies the behavior of the Rollout if an out of band update is
+          # detected in a project during a Rollout. It can be one of the following
+          # values:
+          # 1) overwrite : Overwrite the local value with the rollout value.
+          # 2) no_overwrite : Do not overwrite the local value with the rollout
+          # value.
+      "orchestrationAction": "A String", # Required. Orchestration action during the Rollout. It can be one of the following
+          # values:
+          # 1) "update": Resources will be updated by the rollout.
+          # 2) "delete": Resources will be deleted by the rollout.
+      "orchestrationSource": "A String", # Required. Fully qualified resource name of the resource which contains the source
+          # of truth of the configuration being rolled out across
+          # locations/projects. For example, in the case of a global Rollout which
+          # is applied across regions, this contains the name of the global
+          # resource created by the user which contains a payload for a resource
+          # that is orchestrated across regions. This follows the following format:
+          # //.googleapis.com/projects//locations/global//
+          # e.g.
+          # //osconfig.googleapis.com/projects/1/locations/global/policyOrchestrators/po1
+    },
+  },
+  "rolloutPlan": "A String", # Required. Rollout Plan used to model the Rollout.
+      # Ex. compute.googleapis.com/v1/projects/1234/rolloutPlans/rp1
+  "selfLink": "A String", # Output only. [Output Only] Server-defined fully-qualified URL for this resource.
+  "selfLinkWithId": "A String", # Output only. [Output Only] Server-defined URL for this resource's resource id.
+  "state": "A String", # Output only. The current state of the Rollout.
+  "waveDetails": [ # Output only. Details about each wave of the rollout.
+    { # Additional metadata about the status of each wave provided by the server.
+      "orchestratedWaveDetails": { # Details of the wave for products using the Orchestrated integration # Output only. Additional details of the wave for products using the Orchestrated
+          # Integration model.
+          # model.
+        "completedResourcesCount": "A String", # Output only. Resource completed so far.
+        "estimatedCompletionTime": "A String", # Output only. Estimated timestamp at which the wave will complete. Extrapolated from
+            # current progress.
+        "estimatedTotalResourcesCount": "A String", # Output only. Estimated total count of resources.
+        "failedLocations": [ # Output only. Locations that failed during orchestration, and ProgressiveRollout
+            # stopped retrying. There may be some successful resources rolled out in
+            # the wave as the location may have failed later in the Rollout.
+          "A String",
+        ],
+        "failedResourcesCount": "A String", # Output only. Resources failed.
+        "locationStatus": { # Output only. Status of each location in the wave. Map keys (locations) must be
+            # specified like "us-east1" or "asia-west1-a".
+          "a_key": { # Represents the status of a location in a wave.
+            "state": "A String", # Output only. Location state of the wave.
+          },
+        },
+      },
+      "waveDisplayName": "A String", # Output only. Wave name.
+          # Ex. wave1
+      "waveNumber": "A String", # Output only. System generated number for the wave.
+    },
+  ],
+}
+
+ +
+ list(organization, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None) +
Lists Rollouts in a given organization and location.
+
+Args:
+  organization: string, Required. Organization ID for this request. (required)
+  filter: string, A filter expression that filters resources listed in the response. Most
+Compute resources support two types of filter expressions:
+expressions that support regular expressions and expressions that follow
+API improvement proposal AIP-160.
+These two types of filter expressions cannot be mixed in one request.
+
+If you want to use AIP-160, your expression must specify the field name, an
+operator, and the value that you want to use for filtering. The value
+must be a string, a number, or a boolean. The operator
+must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.
+
+For example, if you are filtering Compute Engine instances, you can
+exclude instances named `example-instance` by specifying
+`name != example-instance`.
+
+The `:*` comparison can be used to test whether a key has been defined.
+For example, to find all objects with `owner` label use:
+```
+labels.owner:*
+```
+
+You can also filter nested fields. For example, you could specify
+`scheduling.automaticRestart = false` to include instances only
+if they are not scheduled for automatic restarts. You can use filtering
+on nested fields to filter based onresource labels.
+
+To filter on multiple expressions, provide each separate expression within
+parentheses. For example:
+```
+(scheduling.automaticRestart = true)
+(cpuPlatform = "Intel Skylake")
+```
+By default, each expression is an `AND` expression. However, you
+can include `AND` and `OR` expressions explicitly.
+For example:
+```
+(cpuPlatform = "Intel Skylake") OR
+(cpuPlatform = "Intel Broadwell") AND
+(scheduling.automaticRestart = true)
+```
+
+If you want to use a regular expression, use the `eq` (equal) or `ne`
+(not equal) operator against a single un-parenthesized expression with or
+without quotes or against multiple parenthesized expressions. Examples:
+
+`fieldname eq unquoted literal`
+`fieldname eq 'single quoted literal'`
+`fieldname eq "double quoted literal"`
+`(fieldname1 eq literal) (fieldname2 ne "literal")`
+
+The literal value is interpreted as a regular expression using GoogleRE2 library syntax.
+The literal value must match the entire field.
+
+For example, to filter for instances that do not end with name "instance",
+you would use `name ne .*instance`.
+
+You cannot combine constraints on multiple fields using regular
+expressions.
+  maxResults: integer, The maximum number of results per page that should be returned.
+If the number of available results is larger than `maxResults`,
+Compute Engine returns a `nextPageToken` that can be used to get
+the next page of results in subsequent list requests. Acceptable values are
+`0` to `500`, inclusive. (Default: `500`)
+  orderBy: string, Sorts list results by a certain order. By default, results
+are returned in alphanumerical order based on the resource name.
+
+You can also sort results in descending order based on the creation
+timestamp using `orderBy="creationTimestamp desc"`. This sorts
+results based on the `creationTimestamp` field in
+reverse chronological order (newest result first). Use this to sort
+resources like operations so that the newest operation is returned first.
+
+Currently, only sorting by `name` or
+`creationTimestamp desc` is supported.
+  pageToken: string, Specifies a page token to use. Set `pageToken` to the
+`nextPageToken` returned by a previous list request to get
+the next page of results.
+  returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case
+of failure. The default value is false.
+
+For example, when partial success behavior is enabled, aggregatedList for a
+single zone scope either returns all resources in the zone or no resources,
+with an error code.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    {
+  "etag": "A String",
+  "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
+  "items": [ # A list of Rollout resources.
+    { # Rollout resource.
+        #
+        # A Rollout is a specific instance of a RolloutPlan. It represents a single
+        # execution of a strategy to roll out a specific resource. It also provides
+        # APIs to interact with the rollout.
+      "cancellationTime": "A String", # Output only. The timestamp at which the Rollout was cancelled.
+      "completionTime": "A String", # Output only. The timestamp at which the Rollout was completed.
+      "creationTimestamp": "A String", # Output only. [Output Only] Creation timestamp inRFC3339
+          # text format.
+      "currentWaveNumber": "A String", # Output only. The number of the currently running wave.
+          # Ex. 1
+      "description": "A String", # An optional description of this resource. Provide this property when you
+          # create the resource.
+      "etag": "A String", # Output only. etag of the Rollout
+          # Ex. abc1234
+      "id": "A String", # Output only. [Output Only] The unique identifier for the resource. This identifier is
+          # defined by the server.
+      "kind": "compute#rollout", # Output only. [Output Only] Type of the resource. Always compute#rollout
+          # for rollouts.
+      "name": "A String", # Name of the resource. Provided by the client when the resource is created.
+          # The name must be 1-63 characters long, and comply withRFC1035.
+          # Specifically, the name must be 1-63 characters long and match the regular
+          # expression `[a-z]([-a-z0-9]*[a-z0-9])?`
+          # which means the first character must be a lowercase letter, and all
+          # following characters must be a dash, lowercase letter, or digit, except
+          # the last character, which cannot be a dash.
+      "pauseTime": "A String", # Output only. The timestamp at which the Rollout was paused.
+      "resumeTime": "A String", # Output only. The timestamp at which the Rollout was resumed.
+      "rolloutEntity": { # Specifications of the resource to roll out. # Required. The resource being rolled out.
+        "orchestratedEntity": { # This message is used if the resource type follows the Orchestrated # Optional. Entity details for products using the Orchestrated Integration model.
+            # integration model with ProgressiveRollout.
+          "conflictBehavior": "A String", # Required. Specifies the behavior of the Rollout if an out of band update is
+              # detected in a project during a Rollout. It can be one of the following
+              # values:
+              # 1) overwrite : Overwrite the local value with the rollout value.
+              # 2) no_overwrite : Do not overwrite the local value with the rollout
+              # value.
+          "orchestrationAction": "A String", # Required. Orchestration action during the Rollout. It can be one of the following
+              # values:
+              # 1) "update": Resources will be updated by the rollout.
+              # 2) "delete": Resources will be deleted by the rollout.
+          "orchestrationSource": "A String", # Required. Fully qualified resource name of the resource which contains the source
+              # of truth of the configuration being rolled out across
+              # locations/projects. For example, in the case of a global Rollout which
+              # is applied across regions, this contains the name of the global
+              # resource created by the user which contains a payload for a resource
+              # that is orchestrated across regions. This follows the following format:
+              # //.googleapis.com/projects//locations/global//
+              # e.g.
+              # //osconfig.googleapis.com/projects/1/locations/global/policyOrchestrators/po1
+        },
+      },
+      "rolloutPlan": "A String", # Required. Rollout Plan used to model the Rollout.
+          # Ex. compute.googleapis.com/v1/projects/1234/rolloutPlans/rp1
+      "selfLink": "A String", # Output only. [Output Only] Server-defined fully-qualified URL for this resource.
+      "selfLinkWithId": "A String", # Output only. [Output Only] Server-defined URL for this resource's resource id.
+      "state": "A String", # Output only. The current state of the Rollout.
+      "waveDetails": [ # Output only. Details about each wave of the rollout.
+        { # Additional metadata about the status of each wave provided by the server.
+          "orchestratedWaveDetails": { # Details of the wave for products using the Orchestrated integration # Output only. Additional details of the wave for products using the Orchestrated
+              # Integration model.
+              # model.
+            "completedResourcesCount": "A String", # Output only. Resource completed so far.
+            "estimatedCompletionTime": "A String", # Output only. Estimated timestamp at which the wave will complete. Extrapolated from
+                # current progress.
+            "estimatedTotalResourcesCount": "A String", # Output only. Estimated total count of resources.
+            "failedLocations": [ # Output only. Locations that failed during orchestration, and ProgressiveRollout
+                # stopped retrying. There may be some successful resources rolled out in
+                # the wave as the location may have failed later in the Rollout.
+              "A String",
+            ],
+            "failedResourcesCount": "A String", # Output only. Resources failed.
+            "locationStatus": { # Output only. Status of each location in the wave. Map keys (locations) must be
+                # specified like "us-east1" or "asia-west1-a".
+              "a_key": { # Represents the status of a location in a wave.
+                "state": "A String", # Output only. Location state of the wave.
+              },
+            },
+          },
+          "waveDisplayName": "A String", # Output only. Wave name.
+              # Ex. wave1
+          "waveNumber": "A String", # Output only. System generated number for the wave.
+        },
+      ],
+    },
+  ],
+  "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for
+      # list requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for
+      # the query parameter pageToken in the next list request.
+      # Subsequent list requests will have their own nextPageToken to
+      # continue paging through the results.
+  "selfLink": "A String", # Output only. [Output Only] Server-defined URL for this resource.
+  "unreachables": [ # Output only. [Output Only] Unreachable resources.
+      # end_interface: MixerListResponseWithEtagBuilder
+    "A String",
+  ],
+  "warning": { # [Output Only] Informational warning message.
+    "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute
+        # Engine returns NO_RESULTS_ON_PAGE if there
+        # are no results in the response.
+    "data": [ # [Output Only] Metadata about this warning in key:
+        # value format. For example:
+        #
+        # "data": [
+        #   {
+        #    "key": "scope",
+        #    "value": "zones/us-east1-d"
+        #   }
+      {
+        "key": "A String", # [Output Only] A key that provides more detail on the warning being
+            # returned. For example, for warnings where there are no results in a list
+            # request for a particular zone, this key might be scope and
+            # the key value might be the zone name. Other examples might be a key
+            # indicating a deprecated resource and a suggested replacement, or a
+            # warning about invalid network settings (for example, if an instance
+            # attempts to perform IP forwarding but is not enabled for IP forwarding).
+        "value": "A String", # [Output Only] A warning data value corresponding to the key.
+      },
+    ],
+    "message": "A String", # [Output Only] A human-readable description of the warning code.
+  },
+}
+
+ +
+ 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.
+        
+
+ +
+ pause(organization, rollout, etag=None, requestId=None, x__xgafv=None) +
Pauses a Rollout.
+
+Args:
+  organization: string, Required. Organization ID for this request. (required)
+  rollout: string, Required. Name of the Rollout resource to pause. (required)
+  etag: string, The etag of the Rollout.
+If this is provided, the request will only succeed if the etag matches
+the current etag of the Rollout.
+  requestId: string, An optional request ID to identify requests. Specify a unique request ID so
+that if you must retry your request, the server will know to ignore the
+request if it has already been completed.
+
+For example, consider a situation where you make an initial request and
+the request times out. If you make the request again with the same
+request ID, the server can check if original operation with the same
+request ID was received, and if so, will ignore the second request. This
+prevents clients from accidentally creating duplicate commitments.
+
+The request ID must be
+a valid UUID with the exception that zero UUID is not supported
+(00000000-0000-0000-0000-000000000000).
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Represents an Operation resource.
+    #
+    # Google Compute Engine has three Operation resources:
+    #
+    # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
+    # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
+    # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
+    #
+    # You can use an operation resource to manage asynchronous API requests.
+    # For more information, readHandling
+    # API responses.
+    #
+    # Operations can be global, regional or zonal.
+    #
+    #    - For global operations, use the `globalOperations`
+    #    resource.
+    #    - For regional operations, use the
+    #    `regionOperations` resource.
+    #    - For zonal operations, use
+    #    the `zoneOperations` resource.
+    #
+    #
+    #
+    # For more information, read
+    # Global, Regional, and Zonal Resources.
+    #
+    # Note that completed Operation resources have a limited
+    # retention period.
+  "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request.
+      # Not present otherwise.
+  "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
+  "description": "A String", # [Output Only] A textual description of the operation, which is
+      # set when the operation is created.
+  "endTime": "A String", # [Output Only] The time that this operation was completed. This value is inRFC3339
+      # text format.
+  "error": { # [Output Only] If errors are generated during processing of the operation,
+      # this field will be populated.
+    "errors": [ # [Output Only] The array of errors encountered while processing this
+        # operation.
+      {
+        "code": "A String", # [Output Only] The error type identifier for this error.
+        "errorDetails": [ # [Output Only] An optional list of messages that contain the error
+            # details. There is a set of defined message types to use for providing
+            # details.The syntax depends on the error code. For example,
+            # QuotaExceededInfo will have details when the error code is
+            # QUOTA_EXCEEDED.
+          {
+            "errorInfo": { # Describes the cause of the error with structured details.
+                #
+                # Example of an error when contacting the "pubsub.googleapis.com" API when it
+                # is not enabled:
+                #
+                #     { "reason": "API_DISABLED"
+                #       "domain": "googleapis.com"
+                #       "metadata": {
+                #         "resource": "projects/123",
+                #         "service": "pubsub.googleapis.com"
+                #       }
+                #     }
+                #
+                # This response indicates that the pubsub.googleapis.com API is not enabled.
+                #
+                # Example of an error that is returned when attempting to create a Spanner
+                # instance in a region that is out of stock:
+                #
+                #     { "reason": "STOCKOUT"
+                #       "domain": "spanner.googleapis.com",
+                #       "metadata": {
+                #         "availableRegions": "us-central1,us-east2"
+                #       }
+                #     }
+              "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain
+                  # is typically the registered service name of the tool or product that
+                  # generates the error. Example: "pubsub.googleapis.com". If the error is
+                  # generated by some common infrastructure, the error domain must be a
+                  # globally unique value that identifies the infrastructure. For Google API
+                  # infrastructure, the error domain is "googleapis.com".
+              "metadatas": { # Additional structured details about this error.
+                  #
+                  # Keys must match a regular expression of `a-z+` but should
+                  # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
+                  # length. When identifying the current value of an exceeded limit, the units
+                  # should be contained in the key, not the value.  For example, rather than
+                  # `{"instanceLimit": "100/request"}`, should be returned as,
+                  # `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of
+                  # instances that can be created in a single (batch) request.
+                "a_key": "A String",
+              },
+              "reason": "A String", # The reason of the error. This is a constant value that identifies the
+                  # proximate cause of the error. Error reasons are unique within a particular
+                  # domain of errors. This should be at most 63 characters and match a
+                  # regular expression of `A-Z+[A-Z0-9]`, which represents
+                  # UPPER_SNAKE_CASE.
+            },
+            "help": { # Provides links to documentation or for performing an out of band action.
+                #
+                # For example, if a quota check failed with an error indicating the calling
+                # project hasn't enabled the accessed service, this can contain a URL pointing
+                # directly to the right place in the developer console to flip the bit.
+              "links": [ # URL(s) pointing to additional information on handling the current error.
+                { # Describes a URL link.
+                  "description": "A String", # Describes what the link offers.
+                  "url": "A String", # The URL of the link.
+                },
+              ],
+            },
+            "localizedMessage": { # Provides a localized error message that is safe to return to the user
+                # which can be attached to an RPC error.
+              "locale": "A String", # The locale used following the specification defined at
+                  # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
+                  # Examples are: "en-US", "fr-CH", "es-MX"
+              "message": "A String", # The localized error message in the above locale.
+            },
+            "quotaInfo": { # Additional details for quota exceeded error for resource quota.
+              "dimensions": { # The map holding related quota dimensions.
+                "a_key": "A String",
+              },
+              "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota
+                  #  type or metric.
+              "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type
+                  # or metric.
+              "limitName": "A String", # The name of the quota limit.
+              "metricName": "A String", # The Compute Engine quota metric name.
+              "rolloutStatus": "A String", # Rollout status of the future quota limit.
+            },
+          },
+        ],
+        "location": "A String", # [Output Only] Indicates the field in the request that caused the error.
+            # This property is optional.
+        "message": "A String", # [Output Only] An optional, human-readable error message.
+      },
+    ],
+  },
+  "getVersionOperationMetadata": {
+    "inlineSbomInfo": {
+      "currentComponentVersions": { # A mapping of components to their currently-applied versions or other
+          # appropriate identifiers.
+        "a_key": "A String",
+      },
+      "targetComponentVersions": { # A mapping of components to their target versions or other appropriate
+          # identifiers.
+        "a_key": "A String",
+      },
+    },
+  },
+  "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
+      # message that was returned, such as `NOT FOUND`.
+  "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
+      # status code that was returned. For example, a `404` means the
+      # resource was not found.
+  "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is
+      # defined by the server.
+  "insertTime": "A String", # [Output Only] The time that this operation was requested.
+      # This value is inRFC3339
+      # text format.
+  "instancesBulkInsertOperationMetadata": {
+    "perLocationStatus": { # Status information per location (location name is key).
+        # Example key: zones/us-central1-a
+      "a_key": {
+        "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far.
+        "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback.
+        "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an
+            # error.
+        "status": "A String", # [Output Only] Creation status of BulkInsert operation - information
+            # if the flow is rolling forward or rolling back.
+        "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created.
+      },
+    },
+  },
+  "kind": "compute#operation", # Output only. [Output Only] Type of the resource. Always `compute#operation` for
+      # Operation resources.
+  "name": "A String", # [Output Only] Name of the operation.
+  "operationGroupId": "A String", # Output only. [Output Only] An ID that represents a group of operations, such as when a
+      # group of operations results from a `bulkInsert` API request.
+  "operationType": "A String", # [Output Only] The type of operation, such as `insert`,
+      # `update`, or `delete`, and so on.
+  "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
+      # There is no requirement that this be linear or support any granularity of
+      # operations. This should not be used to guess when the operation will be
+      # complete. This number should monotonically increase as the operation
+      # progresses.
+  "region": "A String", # [Output Only] The URL of the region where the operation resides. Only
+      # applicable when performing regional operations.
+  "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+  "selfLinkWithId": "A String", # Output only. [Output Only] Server-defined URL for this resource with the resource id.
+  "setCommonInstanceMetadataOperationMetadata": { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
+      # this field will contain information on all underlying zonal actions and
+      # their state.
+    "clientOperationId": "A String", # [Output Only] The client operation id.
+    "perLocationOperations": { # [Output Only] Status information per location (location name is key).
+        # Example key: zones/us-central1-a
+      "a_key": {
+        "error": { # The `Status` type defines a logical error model that is suitable for # [Output Only] If state is `ABANDONED` or `FAILED`, this field is
+            # populated.
+            # different programming environments, including REST APIs and RPC APIs. It is
+            # used by [gRPC](https://github.com/grpc). Each `Status` message contains
+            # three pieces of data: error code, error message, and error details.
+            #
+            # You can find out more about this error model and how to work with it in the
+            # [API Design Guide](https://cloud.google.com/apis/design/errors).
+          "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+          "details": [ # A list of messages that carry the error details.  There is a common set of
+              # message types for APIs to use.
+            {
+              "a_key": "", # Properties of the object. Contains field @type with type URL.
+            },
+          ],
+          "message": "A String", # A developer-facing error message, which should be in English. Any
+              # user-facing error message should be localized and sent in the
+              # google.rpc.Status.details field, or localized by the client.
+        },
+        "state": "A String", # [Output Only] Status of the action, which can be one of the following:
+            # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
+      },
+    },
+  },
+  "startTime": "A String", # [Output Only] The time that this operation was started by the server.
+      # This value is inRFC3339
+      # text format.
+  "status": "A String", # [Output Only] The status of the operation, which can be one of the
+      # following:
+      # `PENDING`, `RUNNING`, or `DONE`.
+  "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the
+      # operation.
+  "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation
+      # of the target resource.
+  "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For
+      # operations related to creating a snapshot, this points to the disk
+      # that the snapshot was created from.
+  "user": "A String", # [Output Only] User who requested the operation, for example:
+      # `user@example.com` or
+      # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
+  "warnings": [ # [Output Only] If warning messages are generated during processing of the
+      # operation, this field will be populated.
+    {
+      "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute
+          # Engine returns NO_RESULTS_ON_PAGE if there
+          # are no results in the response.
+      "data": [ # [Output Only] Metadata about this warning in key:
+          # value format. For example:
+          #
+          # "data": [
+          #   {
+          #    "key": "scope",
+          #    "value": "zones/us-east1-d"
+          #   }
+        {
+          "key": "A String", # [Output Only] A key that provides more detail on the warning being
+              # returned. For example, for warnings where there are no results in a list
+              # request for a particular zone, this key might be scope and
+              # the key value might be the zone name. Other examples might be a key
+              # indicating a deprecated resource and a suggested replacement, or a
+              # warning about invalid network settings (for example, if an instance
+              # attempts to perform IP forwarding but is not enabled for IP forwarding).
+          "value": "A String", # [Output Only] A warning data value corresponding to the key.
+        },
+      ],
+      "message": "A String", # [Output Only] A human-readable description of the warning code.
+    },
+  ],
+  "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only
+      # applicable when performing per-zone operations.
+}
+
+ +
+ resume(organization, rollout, etag=None, requestId=None, x__xgafv=None) +
Resumes a Rollout.
+
+Args:
+  organization: string, Required. Organization ID for this request. (required)
+  rollout: string, Required. Name of the Rollout resource to resume. (required)
+  etag: string, The etag of the Rollout.
+If this is provided, the request will only succeed if the etag matches
+the current etag of the Rollout.
+  requestId: string, An optional request ID to identify requests. Specify a unique request ID so
+that if you must retry your request, the server will know to ignore the
+request if it has already been completed.
+
+For example, consider a situation where you make an initial request and
+the request times out. If you make the request again with the same
+request ID, the server can check if original operation with the same
+request ID was received, and if so, will ignore the second request. This
+prevents clients from accidentally creating duplicate commitments.
+
+The request ID must be
+a valid UUID with the exception that zero UUID is not supported
+(00000000-0000-0000-0000-000000000000).
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Represents an Operation resource.
+    #
+    # Google Compute Engine has three Operation resources:
+    #
+    # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
+    # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
+    # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
+    #
+    # You can use an operation resource to manage asynchronous API requests.
+    # For more information, readHandling
+    # API responses.
+    #
+    # Operations can be global, regional or zonal.
+    #
+    #    - For global operations, use the `globalOperations`
+    #    resource.
+    #    - For regional operations, use the
+    #    `regionOperations` resource.
+    #    - For zonal operations, use
+    #    the `zoneOperations` resource.
+    #
+    #
+    #
+    # For more information, read
+    # Global, Regional, and Zonal Resources.
+    #
+    # Note that completed Operation resources have a limited
+    # retention period.
+  "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request.
+      # Not present otherwise.
+  "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
+  "description": "A String", # [Output Only] A textual description of the operation, which is
+      # set when the operation is created.
+  "endTime": "A String", # [Output Only] The time that this operation was completed. This value is inRFC3339
+      # text format.
+  "error": { # [Output Only] If errors are generated during processing of the operation,
+      # this field will be populated.
+    "errors": [ # [Output Only] The array of errors encountered while processing this
+        # operation.
+      {
+        "code": "A String", # [Output Only] The error type identifier for this error.
+        "errorDetails": [ # [Output Only] An optional list of messages that contain the error
+            # details. There is a set of defined message types to use for providing
+            # details.The syntax depends on the error code. For example,
+            # QuotaExceededInfo will have details when the error code is
+            # QUOTA_EXCEEDED.
+          {
+            "errorInfo": { # Describes the cause of the error with structured details.
+                #
+                # Example of an error when contacting the "pubsub.googleapis.com" API when it
+                # is not enabled:
+                #
+                #     { "reason": "API_DISABLED"
+                #       "domain": "googleapis.com"
+                #       "metadata": {
+                #         "resource": "projects/123",
+                #         "service": "pubsub.googleapis.com"
+                #       }
+                #     }
+                #
+                # This response indicates that the pubsub.googleapis.com API is not enabled.
+                #
+                # Example of an error that is returned when attempting to create a Spanner
+                # instance in a region that is out of stock:
+                #
+                #     { "reason": "STOCKOUT"
+                #       "domain": "spanner.googleapis.com",
+                #       "metadata": {
+                #         "availableRegions": "us-central1,us-east2"
+                #       }
+                #     }
+              "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain
+                  # is typically the registered service name of the tool or product that
+                  # generates the error. Example: "pubsub.googleapis.com". If the error is
+                  # generated by some common infrastructure, the error domain must be a
+                  # globally unique value that identifies the infrastructure. For Google API
+                  # infrastructure, the error domain is "googleapis.com".
+              "metadatas": { # Additional structured details about this error.
+                  #
+                  # Keys must match a regular expression of `a-z+` but should
+                  # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
+                  # length. When identifying the current value of an exceeded limit, the units
+                  # should be contained in the key, not the value.  For example, rather than
+                  # `{"instanceLimit": "100/request"}`, should be returned as,
+                  # `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of
+                  # instances that can be created in a single (batch) request.
+                "a_key": "A String",
+              },
+              "reason": "A String", # The reason of the error. This is a constant value that identifies the
+                  # proximate cause of the error. Error reasons are unique within a particular
+                  # domain of errors. This should be at most 63 characters and match a
+                  # regular expression of `A-Z+[A-Z0-9]`, which represents
+                  # UPPER_SNAKE_CASE.
+            },
+            "help": { # Provides links to documentation or for performing an out of band action.
+                #
+                # For example, if a quota check failed with an error indicating the calling
+                # project hasn't enabled the accessed service, this can contain a URL pointing
+                # directly to the right place in the developer console to flip the bit.
+              "links": [ # URL(s) pointing to additional information on handling the current error.
+                { # Describes a URL link.
+                  "description": "A String", # Describes what the link offers.
+                  "url": "A String", # The URL of the link.
+                },
+              ],
+            },
+            "localizedMessage": { # Provides a localized error message that is safe to return to the user
+                # which can be attached to an RPC error.
+              "locale": "A String", # The locale used following the specification defined at
+                  # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
+                  # Examples are: "en-US", "fr-CH", "es-MX"
+              "message": "A String", # The localized error message in the above locale.
+            },
+            "quotaInfo": { # Additional details for quota exceeded error for resource quota.
+              "dimensions": { # The map holding related quota dimensions.
+                "a_key": "A String",
+              },
+              "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota
+                  #  type or metric.
+              "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type
+                  # or metric.
+              "limitName": "A String", # The name of the quota limit.
+              "metricName": "A String", # The Compute Engine quota metric name.
+              "rolloutStatus": "A String", # Rollout status of the future quota limit.
+            },
+          },
+        ],
+        "location": "A String", # [Output Only] Indicates the field in the request that caused the error.
+            # This property is optional.
+        "message": "A String", # [Output Only] An optional, human-readable error message.
+      },
+    ],
+  },
+  "getVersionOperationMetadata": {
+    "inlineSbomInfo": {
+      "currentComponentVersions": { # A mapping of components to their currently-applied versions or other
+          # appropriate identifiers.
+        "a_key": "A String",
+      },
+      "targetComponentVersions": { # A mapping of components to their target versions or other appropriate
+          # identifiers.
+        "a_key": "A String",
+      },
+    },
+  },
+  "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
+      # message that was returned, such as `NOT FOUND`.
+  "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
+      # status code that was returned. For example, a `404` means the
+      # resource was not found.
+  "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is
+      # defined by the server.
+  "insertTime": "A String", # [Output Only] The time that this operation was requested.
+      # This value is inRFC3339
+      # text format.
+  "instancesBulkInsertOperationMetadata": {
+    "perLocationStatus": { # Status information per location (location name is key).
+        # Example key: zones/us-central1-a
+      "a_key": {
+        "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far.
+        "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback.
+        "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an
+            # error.
+        "status": "A String", # [Output Only] Creation status of BulkInsert operation - information
+            # if the flow is rolling forward or rolling back.
+        "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created.
+      },
+    },
+  },
+  "kind": "compute#operation", # Output only. [Output Only] Type of the resource. Always `compute#operation` for
+      # Operation resources.
+  "name": "A String", # [Output Only] Name of the operation.
+  "operationGroupId": "A String", # Output only. [Output Only] An ID that represents a group of operations, such as when a
+      # group of operations results from a `bulkInsert` API request.
+  "operationType": "A String", # [Output Only] The type of operation, such as `insert`,
+      # `update`, or `delete`, and so on.
+  "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
+      # There is no requirement that this be linear or support any granularity of
+      # operations. This should not be used to guess when the operation will be
+      # complete. This number should monotonically increase as the operation
+      # progresses.
+  "region": "A String", # [Output Only] The URL of the region where the operation resides. Only
+      # applicable when performing regional operations.
+  "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+  "selfLinkWithId": "A String", # Output only. [Output Only] Server-defined URL for this resource with the resource id.
+  "setCommonInstanceMetadataOperationMetadata": { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
+      # this field will contain information on all underlying zonal actions and
+      # their state.
+    "clientOperationId": "A String", # [Output Only] The client operation id.
+    "perLocationOperations": { # [Output Only] Status information per location (location name is key).
+        # Example key: zones/us-central1-a
+      "a_key": {
+        "error": { # The `Status` type defines a logical error model that is suitable for # [Output Only] If state is `ABANDONED` or `FAILED`, this field is
+            # populated.
+            # different programming environments, including REST APIs and RPC APIs. It is
+            # used by [gRPC](https://github.com/grpc). Each `Status` message contains
+            # three pieces of data: error code, error message, and error details.
+            #
+            # You can find out more about this error model and how to work with it in the
+            # [API Design Guide](https://cloud.google.com/apis/design/errors).
+          "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+          "details": [ # A list of messages that carry the error details.  There is a common set of
+              # message types for APIs to use.
+            {
+              "a_key": "", # Properties of the object. Contains field @type with type URL.
+            },
+          ],
+          "message": "A String", # A developer-facing error message, which should be in English. Any
+              # user-facing error message should be localized and sent in the
+              # google.rpc.Status.details field, or localized by the client.
+        },
+        "state": "A String", # [Output Only] Status of the action, which can be one of the following:
+            # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
+      },
+    },
+  },
+  "startTime": "A String", # [Output Only] The time that this operation was started by the server.
+      # This value is inRFC3339
+      # text format.
+  "status": "A String", # [Output Only] The status of the operation, which can be one of the
+      # following:
+      # `PENDING`, `RUNNING`, or `DONE`.
+  "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the
+      # operation.
+  "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation
+      # of the target resource.
+  "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For
+      # operations related to creating a snapshot, this points to the disk
+      # that the snapshot was created from.
+  "user": "A String", # [Output Only] User who requested the operation, for example:
+      # `user@example.com` or
+      # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
+  "warnings": [ # [Output Only] If warning messages are generated during processing of the
+      # operation, this field will be populated.
+    {
+      "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute
+          # Engine returns NO_RESULTS_ON_PAGE if there
+          # are no results in the response.
+      "data": [ # [Output Only] Metadata about this warning in key:
+          # value format. For example:
+          #
+          # "data": [
+          #   {
+          #    "key": "scope",
+          #    "value": "zones/us-east1-d"
+          #   }
+        {
+          "key": "A String", # [Output Only] A key that provides more detail on the warning being
+              # returned. For example, for warnings where there are no results in a list
+              # request for a particular zone, this key might be scope and
+              # the key value might be the zone name. Other examples might be a key
+              # indicating a deprecated resource and a suggested replacement, or a
+              # warning about invalid network settings (for example, if an instance
+              # attempts to perform IP forwarding but is not enabled for IP forwarding).
+          "value": "A String", # [Output Only] A warning data value corresponding to the key.
+        },
+      ],
+      "message": "A String", # [Output Only] A human-readable description of the warning code.
+    },
+  ],
+  "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only
+      # applicable when performing per-zone operations.
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/compute_alpha.organizationSnapshotRecycleBinPolicy.html b/docs/dyn/compute_alpha.organizationSnapshotRecycleBinPolicy.html index 196d3980be..2332d736a7 100644 --- a/docs/dyn/compute_alpha.organizationSnapshotRecycleBinPolicy.html +++ b/docs/dyn/compute_alpha.organizationSnapshotRecycleBinPolicy.html @@ -126,6 +126,15 @@

Method Details

}, }, }, + "systemRules": { # Output only. The system rules for snapshot recycle bin policy. + # Defines the default rule that applies if no customer-defined rule matches. + "a_key": { # A rule that defines the retention policy for snapshots in the recycle bin. + "standardSnapshots": { # The rule config for snapshots in the recycle bin. # The rule config for standard snapshots. + "retentionDurationDays": "A String", # The retention duration for snapshots in the recycle bin after which the + # snapshots are automatically deleted from recycle bin. + }, + }, + }, }
@@ -161,6 +170,15 @@

Method Details

}, }, }, + "systemRules": { # Output only. The system rules for snapshot recycle bin policy. + # Defines the default rule that applies if no customer-defined rule matches. + "a_key": { # A rule that defines the retention policy for snapshots in the recycle bin. + "standardSnapshots": { # The rule config for snapshots in the recycle bin. # The rule config for standard snapshots. + "retentionDurationDays": "A String", # The retention duration for snapshots in the recycle bin after which the + # snapshots are automatically deleted from recycle bin. + }, + }, + }, } requestId: string, An optional request ID to identify requests. Specify a unique request ID so diff --git a/docs/dyn/compute_alpha.organizationZoneVmExtensionPolicies.html b/docs/dyn/compute_alpha.organizationZoneVmExtensionPolicies.html new file mode 100644 index 0000000000..39b6c50a02 --- /dev/null +++ b/docs/dyn/compute_alpha.organizationZoneVmExtensionPolicies.html @@ -0,0 +1,1309 @@ + + + +

Compute Engine API . organizationZoneVmExtensionPolicies

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ get(organization, zone, vmExtensionPolicy, x__xgafv=None)

+

Retrieves details of a specific zone VM extension policy within an

+

+ getVmExtension(organization, zone, extensionName, x__xgafv=None)

+

Retrieves details of a specific VM extension within an organization.

+

+ insert(organization, zone, body=None, requestId=None, x__xgafv=None)

+

Creates a new zone-level VM extension policy within an organization.

+

+ list(organization, zone, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

+

Lists all VM extension policies within a specific zone for an organization.

+

+ listVmExtensions(organization, zone, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

+

Lists all VM extensions within a specific zone for an organization.

+

+ listVmExtensions_next()

+

Retrieves the next page of results.

+

+ list_next()

+

Retrieves the next page of results.

+

+ update(organization, zone, vmExtensionPolicy, body=None, requestId=None, x__xgafv=None)

+

Modifies an existing zone VM extension policy within an organization.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ get(organization, zone, vmExtensionPolicy, x__xgafv=None) +
Retrieves details of a specific zone VM extension policy within an
+organization.
+
+Args:
+  organization: string, Organization ID for this request. (required)
+  zone: string, Name of the zone for this request. (required)
+  vmExtensionPolicy: string, Name of the VM extension policy resource to return. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Represents a VM extension policy.
+  "creationTimestamp": "A String", # Output only. [Output Only] Creation timestamp inRFC3339
+      # text format.
+  "description": "A String", # An optional description of this resource.
+  "extensionPolicies": { # Required. A map of extension names (for example, "ops-agent") to their corresponding
+      # policy configurations.
+    "a_key": { # Configuration for a specific VM extension.
+      "pinnedVersion": "A String", # Optional. The specific version of the extension to install. If not set, the latest
+          # version is used.
+      "stringConfig": "A String", # Optional. String-based configuration data for the extension.
+    },
+  },
+  "globalResourceLink": "A String", # Optional. Output only. [Output Only] Link to the global policy that manages this zone policy, if
+      # applicable.
+  "id": "A String", # Output only. [Output Only] The unique identifier for the resource. This identifier is
+      # defined by the server.
+  "instanceSelectors": [ # Optional. Selectors to target VMs for this policy. VMs are selected if they match
+      # *any* of the provided selectors (logical OR). If this list is empty, the
+      # policy applies to all VMs.
+    { # Defines how to select VMs to apply a zone VM extension policy.
+      "labelSelector": { # A LabelSelector is applied to a VM only if it matches all the specified # Optional. LabelSelector selects VMs based on their labels.
+          # labels.
+        "inclusionLabels": { # Optional. A map of key-value pairs representing VM labels.
+            # VMs must have all of the labels specified in this map to be selected
+            # (logical AND).
+            #
+            # e.g. If the `inclusion_labels` are {("key1", "value1"), ("key2",
+            # "value2")}, the VM labels must contain both ("key1", "value1") and
+            # ("key2", "value2") to be selected. If the VM labels are ("key1",
+            # "value1") and ("something", "else"), it will not be selected.
+            #
+            # If the map is empty, it's considered a match.
+          "a_key": "A String",
+        },
+      },
+    },
+  ],
+  "kind": "compute#vmExtensionPolicy", # Output only. [Output Only] Type of the resource. Alwayscompute#vmExtensionPolicy.
+  "managedByGlobal": True or False, # Optional. Output only. [Output Only] Indicates if this policy is managed by a global policy.
+  "name": "A String", # Name of the resource. Provided by the client when the resource is created.
+      # The name must be 1-63 characters long, and comply withRFC1035.
+      # Specifically, the name must be 1-63 characters long and match the regular
+      # expression `[a-z]([-a-z0-9]*[a-z0-9])?`
+      # which means the first character must be a lowercase letter, and all
+      # following characters must be a dash, lowercase letter, or digit, except
+      # the last character, which cannot be a dash.
+  "priority": 42, # Optional. Priority of this policy. Used to resolve conflicts when multiple policies
+      # apply to the same extension.
+      # The policy priority is an integer from 0 to 65535, inclusive. Lower
+      # integers indicate higher priorities. If you do not specify a priority when
+      # creating a rule, it is assigned a priority of 1000. If priorities are
+      # equal, the policy with the most recent creation timestamp takes precedence.
+  "selfLink": "A String", # Output only. [Output Only] Server-defined fully-qualified URL for this resource.
+  "selfLinkWithId": "A String", # Output only. [Output Only] Server-defined URL for this resource's resource id.
+  "state": "A String", # Optional. Output only. [Output Only] Current state of the policy: ACTIVE or DELETING.
+  "updateTimestamp": "A String", # Output only. [Output Only] Update timestamp inRFC3339
+      # text format.
+}
+
+ +
+ getVmExtension(organization, zone, extensionName, x__xgafv=None) +
Retrieves details of a specific VM extension within an organization.
+
+Args:
+  organization: string, Organization ID for this request. (required)
+  zone: string, Name of the zone for this request. (required)
+  extensionName: string, A parameter (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A VM extension that can be installed on a VM.
+  "name": "A String", # The name of the vm extension.
+  "versions": [ # The latest 10 versions of the vm extension.
+    "A String",
+  ],
+}
+
+ +
+ insert(organization, zone, body=None, requestId=None, x__xgafv=None) +
Creates a new zone-level VM extension policy within an organization.
+
+Args:
+  organization: string, Organization ID for this request. (required)
+  zone: string, Name of the zone for this request. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Represents a VM extension policy.
+  "creationTimestamp": "A String", # Output only. [Output Only] Creation timestamp inRFC3339
+      # text format.
+  "description": "A String", # An optional description of this resource.
+  "extensionPolicies": { # Required. A map of extension names (for example, "ops-agent") to their corresponding
+      # policy configurations.
+    "a_key": { # Configuration for a specific VM extension.
+      "pinnedVersion": "A String", # Optional. The specific version of the extension to install. If not set, the latest
+          # version is used.
+      "stringConfig": "A String", # Optional. String-based configuration data for the extension.
+    },
+  },
+  "globalResourceLink": "A String", # Optional. Output only. [Output Only] Link to the global policy that manages this zone policy, if
+      # applicable.
+  "id": "A String", # Output only. [Output Only] The unique identifier for the resource. This identifier is
+      # defined by the server.
+  "instanceSelectors": [ # Optional. Selectors to target VMs for this policy. VMs are selected if they match
+      # *any* of the provided selectors (logical OR). If this list is empty, the
+      # policy applies to all VMs.
+    { # Defines how to select VMs to apply a zone VM extension policy.
+      "labelSelector": { # A LabelSelector is applied to a VM only if it matches all the specified # Optional. LabelSelector selects VMs based on their labels.
+          # labels.
+        "inclusionLabels": { # Optional. A map of key-value pairs representing VM labels.
+            # VMs must have all of the labels specified in this map to be selected
+            # (logical AND).
+            #
+            # e.g. If the `inclusion_labels` are {("key1", "value1"), ("key2",
+            # "value2")}, the VM labels must contain both ("key1", "value1") and
+            # ("key2", "value2") to be selected. If the VM labels are ("key1",
+            # "value1") and ("something", "else"), it will not be selected.
+            #
+            # If the map is empty, it's considered a match.
+          "a_key": "A String",
+        },
+      },
+    },
+  ],
+  "kind": "compute#vmExtensionPolicy", # Output only. [Output Only] Type of the resource. Alwayscompute#vmExtensionPolicy.
+  "managedByGlobal": True or False, # Optional. Output only. [Output Only] Indicates if this policy is managed by a global policy.
+  "name": "A String", # Name of the resource. Provided by the client when the resource is created.
+      # The name must be 1-63 characters long, and comply withRFC1035.
+      # Specifically, the name must be 1-63 characters long and match the regular
+      # expression `[a-z]([-a-z0-9]*[a-z0-9])?`
+      # which means the first character must be a lowercase letter, and all
+      # following characters must be a dash, lowercase letter, or digit, except
+      # the last character, which cannot be a dash.
+  "priority": 42, # Optional. Priority of this policy. Used to resolve conflicts when multiple policies
+      # apply to the same extension.
+      # The policy priority is an integer from 0 to 65535, inclusive. Lower
+      # integers indicate higher priorities. If you do not specify a priority when
+      # creating a rule, it is assigned a priority of 1000. If priorities are
+      # equal, the policy with the most recent creation timestamp takes precedence.
+  "selfLink": "A String", # Output only. [Output Only] Server-defined fully-qualified URL for this resource.
+  "selfLinkWithId": "A String", # Output only. [Output Only] Server-defined URL for this resource's resource id.
+  "state": "A String", # Optional. Output only. [Output Only] Current state of the policy: ACTIVE or DELETING.
+  "updateTimestamp": "A String", # Output only. [Output Only] Update timestamp inRFC3339
+      # text format.
+}
+
+  requestId: string, An optional request ID to identify requests. Specify a unique request ID so
+that if you must retry your request, the server will know to ignore the
+request if it has already been completed.
+
+For example, consider a situation where you make an initial request and
+the request times out. If you make the request again with the same
+request ID, the server can check if original operation with the same
+request ID was received, and if so, will ignore the second request. This
+prevents clients from accidentally creating duplicate commitments.
+
+The request ID must be
+a valid UUID with the exception that zero UUID is not supported
+(00000000-0000-0000-0000-000000000000).
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Represents an Operation resource.
+    #
+    # Google Compute Engine has three Operation resources:
+    #
+    # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
+    # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
+    # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
+    #
+    # You can use an operation resource to manage asynchronous API requests.
+    # For more information, readHandling
+    # API responses.
+    #
+    # Operations can be global, regional or zonal.
+    #
+    #    - For global operations, use the `globalOperations`
+    #    resource.
+    #    - For regional operations, use the
+    #    `regionOperations` resource.
+    #    - For zonal operations, use
+    #    the `zoneOperations` resource.
+    #
+    #
+    #
+    # For more information, read
+    # Global, Regional, and Zonal Resources.
+    #
+    # Note that completed Operation resources have a limited
+    # retention period.
+  "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request.
+      # Not present otherwise.
+  "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
+  "description": "A String", # [Output Only] A textual description of the operation, which is
+      # set when the operation is created.
+  "endTime": "A String", # [Output Only] The time that this operation was completed. This value is inRFC3339
+      # text format.
+  "error": { # [Output Only] If errors are generated during processing of the operation,
+      # this field will be populated.
+    "errors": [ # [Output Only] The array of errors encountered while processing this
+        # operation.
+      {
+        "code": "A String", # [Output Only] The error type identifier for this error.
+        "errorDetails": [ # [Output Only] An optional list of messages that contain the error
+            # details. There is a set of defined message types to use for providing
+            # details.The syntax depends on the error code. For example,
+            # QuotaExceededInfo will have details when the error code is
+            # QUOTA_EXCEEDED.
+          {
+            "errorInfo": { # Describes the cause of the error with structured details.
+                #
+                # Example of an error when contacting the "pubsub.googleapis.com" API when it
+                # is not enabled:
+                #
+                #     { "reason": "API_DISABLED"
+                #       "domain": "googleapis.com"
+                #       "metadata": {
+                #         "resource": "projects/123",
+                #         "service": "pubsub.googleapis.com"
+                #       }
+                #     }
+                #
+                # This response indicates that the pubsub.googleapis.com API is not enabled.
+                #
+                # Example of an error that is returned when attempting to create a Spanner
+                # instance in a region that is out of stock:
+                #
+                #     { "reason": "STOCKOUT"
+                #       "domain": "spanner.googleapis.com",
+                #       "metadata": {
+                #         "availableRegions": "us-central1,us-east2"
+                #       }
+                #     }
+              "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain
+                  # is typically the registered service name of the tool or product that
+                  # generates the error. Example: "pubsub.googleapis.com". If the error is
+                  # generated by some common infrastructure, the error domain must be a
+                  # globally unique value that identifies the infrastructure. For Google API
+                  # infrastructure, the error domain is "googleapis.com".
+              "metadatas": { # Additional structured details about this error.
+                  #
+                  # Keys must match a regular expression of `a-z+` but should
+                  # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
+                  # length. When identifying the current value of an exceeded limit, the units
+                  # should be contained in the key, not the value.  For example, rather than
+                  # `{"instanceLimit": "100/request"}`, should be returned as,
+                  # `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of
+                  # instances that can be created in a single (batch) request.
+                "a_key": "A String",
+              },
+              "reason": "A String", # The reason of the error. This is a constant value that identifies the
+                  # proximate cause of the error. Error reasons are unique within a particular
+                  # domain of errors. This should be at most 63 characters and match a
+                  # regular expression of `A-Z+[A-Z0-9]`, which represents
+                  # UPPER_SNAKE_CASE.
+            },
+            "help": { # Provides links to documentation or for performing an out of band action.
+                #
+                # For example, if a quota check failed with an error indicating the calling
+                # project hasn't enabled the accessed service, this can contain a URL pointing
+                # directly to the right place in the developer console to flip the bit.
+              "links": [ # URL(s) pointing to additional information on handling the current error.
+                { # Describes a URL link.
+                  "description": "A String", # Describes what the link offers.
+                  "url": "A String", # The URL of the link.
+                },
+              ],
+            },
+            "localizedMessage": { # Provides a localized error message that is safe to return to the user
+                # which can be attached to an RPC error.
+              "locale": "A String", # The locale used following the specification defined at
+                  # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
+                  # Examples are: "en-US", "fr-CH", "es-MX"
+              "message": "A String", # The localized error message in the above locale.
+            },
+            "quotaInfo": { # Additional details for quota exceeded error for resource quota.
+              "dimensions": { # The map holding related quota dimensions.
+                "a_key": "A String",
+              },
+              "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota
+                  #  type or metric.
+              "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type
+                  # or metric.
+              "limitName": "A String", # The name of the quota limit.
+              "metricName": "A String", # The Compute Engine quota metric name.
+              "rolloutStatus": "A String", # Rollout status of the future quota limit.
+            },
+          },
+        ],
+        "location": "A String", # [Output Only] Indicates the field in the request that caused the error.
+            # This property is optional.
+        "message": "A String", # [Output Only] An optional, human-readable error message.
+      },
+    ],
+  },
+  "getVersionOperationMetadata": {
+    "inlineSbomInfo": {
+      "currentComponentVersions": { # A mapping of components to their currently-applied versions or other
+          # appropriate identifiers.
+        "a_key": "A String",
+      },
+      "targetComponentVersions": { # A mapping of components to their target versions or other appropriate
+          # identifiers.
+        "a_key": "A String",
+      },
+    },
+  },
+  "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
+      # message that was returned, such as `NOT FOUND`.
+  "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
+      # status code that was returned. For example, a `404` means the
+      # resource was not found.
+  "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is
+      # defined by the server.
+  "insertTime": "A String", # [Output Only] The time that this operation was requested.
+      # This value is inRFC3339
+      # text format.
+  "instancesBulkInsertOperationMetadata": {
+    "perLocationStatus": { # Status information per location (location name is key).
+        # Example key: zones/us-central1-a
+      "a_key": {
+        "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far.
+        "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback.
+        "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an
+            # error.
+        "status": "A String", # [Output Only] Creation status of BulkInsert operation - information
+            # if the flow is rolling forward or rolling back.
+        "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created.
+      },
+    },
+  },
+  "kind": "compute#operation", # Output only. [Output Only] Type of the resource. Always `compute#operation` for
+      # Operation resources.
+  "name": "A String", # [Output Only] Name of the operation.
+  "operationGroupId": "A String", # Output only. [Output Only] An ID that represents a group of operations, such as when a
+      # group of operations results from a `bulkInsert` API request.
+  "operationType": "A String", # [Output Only] The type of operation, such as `insert`,
+      # `update`, or `delete`, and so on.
+  "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
+      # There is no requirement that this be linear or support any granularity of
+      # operations. This should not be used to guess when the operation will be
+      # complete. This number should monotonically increase as the operation
+      # progresses.
+  "region": "A String", # [Output Only] The URL of the region where the operation resides. Only
+      # applicable when performing regional operations.
+  "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+  "selfLinkWithId": "A String", # Output only. [Output Only] Server-defined URL for this resource with the resource id.
+  "setCommonInstanceMetadataOperationMetadata": { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
+      # this field will contain information on all underlying zonal actions and
+      # their state.
+    "clientOperationId": "A String", # [Output Only] The client operation id.
+    "perLocationOperations": { # [Output Only] Status information per location (location name is key).
+        # Example key: zones/us-central1-a
+      "a_key": {
+        "error": { # The `Status` type defines a logical error model that is suitable for # [Output Only] If state is `ABANDONED` or `FAILED`, this field is
+            # populated.
+            # different programming environments, including REST APIs and RPC APIs. It is
+            # used by [gRPC](https://github.com/grpc). Each `Status` message contains
+            # three pieces of data: error code, error message, and error details.
+            #
+            # You can find out more about this error model and how to work with it in the
+            # [API Design Guide](https://cloud.google.com/apis/design/errors).
+          "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+          "details": [ # A list of messages that carry the error details.  There is a common set of
+              # message types for APIs to use.
+            {
+              "a_key": "", # Properties of the object. Contains field @type with type URL.
+            },
+          ],
+          "message": "A String", # A developer-facing error message, which should be in English. Any
+              # user-facing error message should be localized and sent in the
+              # google.rpc.Status.details field, or localized by the client.
+        },
+        "state": "A String", # [Output Only] Status of the action, which can be one of the following:
+            # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
+      },
+    },
+  },
+  "startTime": "A String", # [Output Only] The time that this operation was started by the server.
+      # This value is inRFC3339
+      # text format.
+  "status": "A String", # [Output Only] The status of the operation, which can be one of the
+      # following:
+      # `PENDING`, `RUNNING`, or `DONE`.
+  "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the
+      # operation.
+  "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation
+      # of the target resource.
+  "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For
+      # operations related to creating a snapshot, this points to the disk
+      # that the snapshot was created from.
+  "user": "A String", # [Output Only] User who requested the operation, for example:
+      # `user@example.com` or
+      # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
+  "warnings": [ # [Output Only] If warning messages are generated during processing of the
+      # operation, this field will be populated.
+    {
+      "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute
+          # Engine returns NO_RESULTS_ON_PAGE if there
+          # are no results in the response.
+      "data": [ # [Output Only] Metadata about this warning in key:
+          # value format. For example:
+          #
+          # "data": [
+          #   {
+          #    "key": "scope",
+          #    "value": "zones/us-east1-d"
+          #   }
+        {
+          "key": "A String", # [Output Only] A key that provides more detail on the warning being
+              # returned. For example, for warnings where there are no results in a list
+              # request for a particular zone, this key might be scope and
+              # the key value might be the zone name. Other examples might be a key
+              # indicating a deprecated resource and a suggested replacement, or a
+              # warning about invalid network settings (for example, if an instance
+              # attempts to perform IP forwarding but is not enabled for IP forwarding).
+          "value": "A String", # [Output Only] A warning data value corresponding to the key.
+        },
+      ],
+      "message": "A String", # [Output Only] A human-readable description of the warning code.
+    },
+  ],
+  "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only
+      # applicable when performing per-zone operations.
+}
+
+ +
+ list(organization, zone, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None) +
Lists all VM extension policies within a specific zone for an organization.
+
+Args:
+  organization: string, Organization ID for this request. (required)
+  zone: string, Name of the zone for this request. (required)
+  filter: string, A filter expression that filters resources listed in the response. Most
+Compute resources support two types of filter expressions:
+expressions that support regular expressions and expressions that follow
+API improvement proposal AIP-160.
+These two types of filter expressions cannot be mixed in one request.
+
+If you want to use AIP-160, your expression must specify the field name, an
+operator, and the value that you want to use for filtering. The value
+must be a string, a number, or a boolean. The operator
+must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.
+
+For example, if you are filtering Compute Engine instances, you can
+exclude instances named `example-instance` by specifying
+`name != example-instance`.
+
+The `:*` comparison can be used to test whether a key has been defined.
+For example, to find all objects with `owner` label use:
+```
+labels.owner:*
+```
+
+You can also filter nested fields. For example, you could specify
+`scheduling.automaticRestart = false` to include instances only
+if they are not scheduled for automatic restarts. You can use filtering
+on nested fields to filter based onresource labels.
+
+To filter on multiple expressions, provide each separate expression within
+parentheses. For example:
+```
+(scheduling.automaticRestart = true)
+(cpuPlatform = "Intel Skylake")
+```
+By default, each expression is an `AND` expression. However, you
+can include `AND` and `OR` expressions explicitly.
+For example:
+```
+(cpuPlatform = "Intel Skylake") OR
+(cpuPlatform = "Intel Broadwell") AND
+(scheduling.automaticRestart = true)
+```
+
+If you want to use a regular expression, use the `eq` (equal) or `ne`
+(not equal) operator against a single un-parenthesized expression with or
+without quotes or against multiple parenthesized expressions. Examples:
+
+`fieldname eq unquoted literal`
+`fieldname eq 'single quoted literal'`
+`fieldname eq "double quoted literal"`
+`(fieldname1 eq literal) (fieldname2 ne "literal")`
+
+The literal value is interpreted as a regular expression using GoogleRE2 library syntax.
+The literal value must match the entire field.
+
+For example, to filter for instances that do not end with name "instance",
+you would use `name ne .*instance`.
+
+You cannot combine constraints on multiple fields using regular
+expressions.
+  maxResults: integer, The maximum number of results per page that should be returned.
+If the number of available results is larger than `maxResults`,
+Compute Engine returns a `nextPageToken` that can be used to get
+the next page of results in subsequent list requests. Acceptable values are
+`0` to `500`, inclusive. (Default: `500`)
+  orderBy: string, Sorts list results by a certain order. By default, results
+are returned in alphanumerical order based on the resource name.
+
+You can also sort results in descending order based on the creation
+timestamp using `orderBy="creationTimestamp desc"`. This sorts
+results based on the `creationTimestamp` field in
+reverse chronological order (newest result first). Use this to sort
+resources like operations so that the newest operation is returned first.
+
+Currently, only sorting by `name` or
+`creationTimestamp desc` is supported.
+  pageToken: string, Specifies a page token to use. Set `pageToken` to the
+`nextPageToken` returned by a previous list request to get
+the next page of results.
+  returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case
+of failure. The default value is false.
+
+For example, when partial success behavior is enabled, aggregatedList for a
+single zone scope either returns all resources in the zone or no resources,
+with an error code.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    {
+  "etag": "A String", # Output only. [Output Only] Fingerprint of this resource. A hash of the contents stored
+      # in this object. This field is used in optimistic locking. This field will
+      # be ignored when inserting a VmExtensionPolicy. An up-to-date
+      # fingerprint must be provided in order to update the VmExtensionPolicy.
+      #
+      # To see the latest value of the fingerprint, make a get() request to
+      # retrieve a VmExtensionPolicy.
+  "id": "A String", # Output only. [Output Only] Unique identifier for the resource; defined by the server.
+  "items": [ # Output only. [Output Only] A list of VM extension policy resources.
+    { # Represents a VM extension policy.
+      "creationTimestamp": "A String", # Output only. [Output Only] Creation timestamp inRFC3339
+          # text format.
+      "description": "A String", # An optional description of this resource.
+      "extensionPolicies": { # Required. A map of extension names (for example, "ops-agent") to their corresponding
+          # policy configurations.
+        "a_key": { # Configuration for a specific VM extension.
+          "pinnedVersion": "A String", # Optional. The specific version of the extension to install. If not set, the latest
+              # version is used.
+          "stringConfig": "A String", # Optional. String-based configuration data for the extension.
+        },
+      },
+      "globalResourceLink": "A String", # Optional. Output only. [Output Only] Link to the global policy that manages this zone policy, if
+          # applicable.
+      "id": "A String", # Output only. [Output Only] The unique identifier for the resource. This identifier is
+          # defined by the server.
+      "instanceSelectors": [ # Optional. Selectors to target VMs for this policy. VMs are selected if they match
+          # *any* of the provided selectors (logical OR). If this list is empty, the
+          # policy applies to all VMs.
+        { # Defines how to select VMs to apply a zone VM extension policy.
+          "labelSelector": { # A LabelSelector is applied to a VM only if it matches all the specified # Optional. LabelSelector selects VMs based on their labels.
+              # labels.
+            "inclusionLabels": { # Optional. A map of key-value pairs representing VM labels.
+                # VMs must have all of the labels specified in this map to be selected
+                # (logical AND).
+                #
+                # e.g. If the `inclusion_labels` are {("key1", "value1"), ("key2",
+                # "value2")}, the VM labels must contain both ("key1", "value1") and
+                # ("key2", "value2") to be selected. If the VM labels are ("key1",
+                # "value1") and ("something", "else"), it will not be selected.
+                #
+                # If the map is empty, it's considered a match.
+              "a_key": "A String",
+            },
+          },
+        },
+      ],
+      "kind": "compute#vmExtensionPolicy", # Output only. [Output Only] Type of the resource. Alwayscompute#vmExtensionPolicy.
+      "managedByGlobal": True or False, # Optional. Output only. [Output Only] Indicates if this policy is managed by a global policy.
+      "name": "A String", # Name of the resource. Provided by the client when the resource is created.
+          # The name must be 1-63 characters long, and comply withRFC1035.
+          # Specifically, the name must be 1-63 characters long and match the regular
+          # expression `[a-z]([-a-z0-9]*[a-z0-9])?`
+          # which means the first character must be a lowercase letter, and all
+          # following characters must be a dash, lowercase letter, or digit, except
+          # the last character, which cannot be a dash.
+      "priority": 42, # Optional. Priority of this policy. Used to resolve conflicts when multiple policies
+          # apply to the same extension.
+          # The policy priority is an integer from 0 to 65535, inclusive. Lower
+          # integers indicate higher priorities. If you do not specify a priority when
+          # creating a rule, it is assigned a priority of 1000. If priorities are
+          # equal, the policy with the most recent creation timestamp takes precedence.
+      "selfLink": "A String", # Output only. [Output Only] Server-defined fully-qualified URL for this resource.
+      "selfLinkWithId": "A String", # Output only. [Output Only] Server-defined URL for this resource's resource id.
+      "state": "A String", # Optional. Output only. [Output Only] Current state of the policy: ACTIVE or DELETING.
+      "updateTimestamp": "A String", # Output only. [Output Only] Update timestamp inRFC3339
+          # text format.
+    },
+  ],
+  "kind": "compute#vmExtensionPolicyList", # Output only. Type of resource.
+  "nextPageToken": "A String", # Output only. [Output Only] This token allows you to get the next page of results for
+      # list requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for
+      # the query parameter pageToken in the next list request.
+      # Subsequent list requests will have their own nextPageToken to
+      # continue paging through the results.
+  "selfLink": "A String", # Output only. [Output Only] Server-defined URL for this resource.
+  "unreachables": [ # Output only. [Output Only] Unreachable resources.
+    "A String",
+  ],
+  "warning": { # Output only. [Output Only] Informational warning message.
+    "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute
+        # Engine returns NO_RESULTS_ON_PAGE if there
+        # are no results in the response.
+    "data": [ # [Output Only] Metadata about this warning in key:
+        # value format. For example:
+        #
+        # "data": [
+        #   {
+        #    "key": "scope",
+        #    "value": "zones/us-east1-d"
+        #   }
+      {
+        "key": "A String", # [Output Only] A key that provides more detail on the warning being
+            # returned. For example, for warnings where there are no results in a list
+            # request for a particular zone, this key might be scope and
+            # the key value might be the zone name. Other examples might be a key
+            # indicating a deprecated resource and a suggested replacement, or a
+            # warning about invalid network settings (for example, if an instance
+            # attempts to perform IP forwarding but is not enabled for IP forwarding).
+        "value": "A String", # [Output Only] A warning data value corresponding to the key.
+      },
+    ],
+    "message": "A String", # [Output Only] A human-readable description of the warning code.
+  },
+}
+
+ +
+ listVmExtensions(organization, zone, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None) +
Lists all VM extensions within a specific zone for an organization.
+This is a read-only API.
+
+Args:
+  organization: string, Organization ID for this request. (required)
+  zone: string, Name of the zone for this request. (required)
+  filter: string, A filter expression that filters resources listed in the response. Most
+Compute resources support two types of filter expressions:
+expressions that support regular expressions and expressions that follow
+API improvement proposal AIP-160.
+These two types of filter expressions cannot be mixed in one request.
+
+If you want to use AIP-160, your expression must specify the field name, an
+operator, and the value that you want to use for filtering. The value
+must be a string, a number, or a boolean. The operator
+must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.
+
+For example, if you are filtering Compute Engine instances, you can
+exclude instances named `example-instance` by specifying
+`name != example-instance`.
+
+The `:*` comparison can be used to test whether a key has been defined.
+For example, to find all objects with `owner` label use:
+```
+labels.owner:*
+```
+
+You can also filter nested fields. For example, you could specify
+`scheduling.automaticRestart = false` to include instances only
+if they are not scheduled for automatic restarts. You can use filtering
+on nested fields to filter based onresource labels.
+
+To filter on multiple expressions, provide each separate expression within
+parentheses. For example:
+```
+(scheduling.automaticRestart = true)
+(cpuPlatform = "Intel Skylake")
+```
+By default, each expression is an `AND` expression. However, you
+can include `AND` and `OR` expressions explicitly.
+For example:
+```
+(cpuPlatform = "Intel Skylake") OR
+(cpuPlatform = "Intel Broadwell") AND
+(scheduling.automaticRestart = true)
+```
+
+If you want to use a regular expression, use the `eq` (equal) or `ne`
+(not equal) operator against a single un-parenthesized expression with or
+without quotes or against multiple parenthesized expressions. Examples:
+
+`fieldname eq unquoted literal`
+`fieldname eq 'single quoted literal'`
+`fieldname eq "double quoted literal"`
+`(fieldname1 eq literal) (fieldname2 ne "literal")`
+
+The literal value is interpreted as a regular expression using GoogleRE2 library syntax.
+The literal value must match the entire field.
+
+For example, to filter for instances that do not end with name "instance",
+you would use `name ne .*instance`.
+
+You cannot combine constraints on multiple fields using regular
+expressions.
+  maxResults: integer, The maximum number of results per page that should be returned.
+If the number of available results is larger than `maxResults`,
+Compute Engine returns a `nextPageToken` that can be used to get
+the next page of results in subsequent list requests. Acceptable values are
+`0` to `500`, inclusive. (Default: `500`)
+  orderBy: string, Sorts list results by a certain order. By default, results
+are returned in alphanumerical order based on the resource name.
+
+You can also sort results in descending order based on the creation
+timestamp using `orderBy="creationTimestamp desc"`. This sorts
+results based on the `creationTimestamp` field in
+reverse chronological order (newest result first). Use this to sort
+resources like operations so that the newest operation is returned first.
+
+Currently, only sorting by `name` or
+`creationTimestamp desc` is supported.
+  pageToken: string, Specifies a page token to use. Set `pageToken` to the
+`nextPageToken` returned by a previous list request to get
+the next page of results.
+  returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case
+of failure. The default value is false.
+
+For example, when partial success behavior is enabled, aggregatedList for a
+single zone scope either returns all resources in the zone or no resources,
+with an error code.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    {
+  "etag": "A String", # Output only. Fingerprint of this resource. A hash of the contents stored
+      # in this object. This field is used in optimistic locking. This field will
+      # be ignored when inserting a VmExtensionPolicy. An up-to-date
+      # fingerprint must be provided in order to update the VmExtensionPolicy.
+      #
+      # To see the latest value of the fingerprint, make a get() request to
+      # retrieve a VmExtensionPolicy.
+  "id": "A String", # Output only. Unique identifier for the resource; defined by the server.
+  "items": [ # Output only. A list of VM extensions.
+    { # A VM extension that can be installed on a VM.
+      "name": "A String", # The name of the vm extension.
+      "versions": [ # The latest 10 versions of the vm extension.
+        "A String",
+      ],
+    },
+  ],
+  "kind": "compute#vmExtensionList", # Output only. Type of resource.
+  "nextPageToken": "A String", # Output only. This token allows you to get the next page of results for
+      # list requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for
+      # the query parameter pageToken in the next list request.
+      # Subsequent list requests will have their own nextPageToken to
+      # continue paging through the results.
+  "selfLink": "A String", # Output only. Server-defined URL for this resource.
+  "unreachables": [ # Output only. Unreachable resources.
+    "A String",
+  ],
+  "warning": { # Output only. Informational warning message.
+    "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute
+        # Engine returns NO_RESULTS_ON_PAGE if there
+        # are no results in the response.
+    "data": [ # [Output Only] Metadata about this warning in key:
+        # value format. For example:
+        #
+        # "data": [
+        #   {
+        #    "key": "scope",
+        #    "value": "zones/us-east1-d"
+        #   }
+      {
+        "key": "A String", # [Output Only] A key that provides more detail on the warning being
+            # returned. For example, for warnings where there are no results in a list
+            # request for a particular zone, this key might be scope and
+            # the key value might be the zone name. Other examples might be a key
+            # indicating a deprecated resource and a suggested replacement, or a
+            # warning about invalid network settings (for example, if an instance
+            # attempts to perform IP forwarding but is not enabled for IP forwarding).
+        "value": "A String", # [Output Only] A warning data value corresponding to the key.
+      },
+    ],
+    "message": "A String", # [Output Only] A human-readable description of the warning code.
+  },
+}
+
+ +
+ listVmExtensions_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.
+        
+
+ +
+ list_next() +
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+        
+
+ +
+ update(organization, zone, vmExtensionPolicy, body=None, requestId=None, x__xgafv=None) +
Modifies an existing zone VM extension policy within an organization.
+
+Args:
+  organization: string, Organization ID for this request. (required)
+  zone: string, Name of the zone for this request. (required)
+  vmExtensionPolicy: string, Name of the zone VM extension policy to update. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Represents a VM extension policy.
+  "creationTimestamp": "A String", # Output only. [Output Only] Creation timestamp inRFC3339
+      # text format.
+  "description": "A String", # An optional description of this resource.
+  "extensionPolicies": { # Required. A map of extension names (for example, "ops-agent") to their corresponding
+      # policy configurations.
+    "a_key": { # Configuration for a specific VM extension.
+      "pinnedVersion": "A String", # Optional. The specific version of the extension to install. If not set, the latest
+          # version is used.
+      "stringConfig": "A String", # Optional. String-based configuration data for the extension.
+    },
+  },
+  "globalResourceLink": "A String", # Optional. Output only. [Output Only] Link to the global policy that manages this zone policy, if
+      # applicable.
+  "id": "A String", # Output only. [Output Only] The unique identifier for the resource. This identifier is
+      # defined by the server.
+  "instanceSelectors": [ # Optional. Selectors to target VMs for this policy. VMs are selected if they match
+      # *any* of the provided selectors (logical OR). If this list is empty, the
+      # policy applies to all VMs.
+    { # Defines how to select VMs to apply a zone VM extension policy.
+      "labelSelector": { # A LabelSelector is applied to a VM only if it matches all the specified # Optional. LabelSelector selects VMs based on their labels.
+          # labels.
+        "inclusionLabels": { # Optional. A map of key-value pairs representing VM labels.
+            # VMs must have all of the labels specified in this map to be selected
+            # (logical AND).
+            #
+            # e.g. If the `inclusion_labels` are {("key1", "value1"), ("key2",
+            # "value2")}, the VM labels must contain both ("key1", "value1") and
+            # ("key2", "value2") to be selected. If the VM labels are ("key1",
+            # "value1") and ("something", "else"), it will not be selected.
+            #
+            # If the map is empty, it's considered a match.
+          "a_key": "A String",
+        },
+      },
+    },
+  ],
+  "kind": "compute#vmExtensionPolicy", # Output only. [Output Only] Type of the resource. Alwayscompute#vmExtensionPolicy.
+  "managedByGlobal": True or False, # Optional. Output only. [Output Only] Indicates if this policy is managed by a global policy.
+  "name": "A String", # Name of the resource. Provided by the client when the resource is created.
+      # The name must be 1-63 characters long, and comply withRFC1035.
+      # Specifically, the name must be 1-63 characters long and match the regular
+      # expression `[a-z]([-a-z0-9]*[a-z0-9])?`
+      # which means the first character must be a lowercase letter, and all
+      # following characters must be a dash, lowercase letter, or digit, except
+      # the last character, which cannot be a dash.
+  "priority": 42, # Optional. Priority of this policy. Used to resolve conflicts when multiple policies
+      # apply to the same extension.
+      # The policy priority is an integer from 0 to 65535, inclusive. Lower
+      # integers indicate higher priorities. If you do not specify a priority when
+      # creating a rule, it is assigned a priority of 1000. If priorities are
+      # equal, the policy with the most recent creation timestamp takes precedence.
+  "selfLink": "A String", # Output only. [Output Only] Server-defined fully-qualified URL for this resource.
+  "selfLinkWithId": "A String", # Output only. [Output Only] Server-defined URL for this resource's resource id.
+  "state": "A String", # Optional. Output only. [Output Only] Current state of the policy: ACTIVE or DELETING.
+  "updateTimestamp": "A String", # Output only. [Output Only] Update timestamp inRFC3339
+      # text format.
+}
+
+  requestId: string, An optional request ID to identify requests. Specify a unique request ID so
+that if you must retry your request, the server will know to ignore the
+request if it has already been completed.
+
+For example, consider a situation where you make an initial request and
+the request times out. If you make the request again with the same
+request ID, the server can check if original operation with the same
+request ID was received, and if so, will ignore the second request. This
+prevents clients from accidentally creating duplicate commitments.
+
+The request ID must be
+a valid UUID with the exception that zero UUID is not supported
+(00000000-0000-0000-0000-000000000000).
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Represents an Operation resource.
+    #
+    # Google Compute Engine has three Operation resources:
+    #
+    # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
+    # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
+    # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
+    #
+    # You can use an operation resource to manage asynchronous API requests.
+    # For more information, readHandling
+    # API responses.
+    #
+    # Operations can be global, regional or zonal.
+    #
+    #    - For global operations, use the `globalOperations`
+    #    resource.
+    #    - For regional operations, use the
+    #    `regionOperations` resource.
+    #    - For zonal operations, use
+    #    the `zoneOperations` resource.
+    #
+    #
+    #
+    # For more information, read
+    # Global, Regional, and Zonal Resources.
+    #
+    # Note that completed Operation resources have a limited
+    # retention period.
+  "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request.
+      # Not present otherwise.
+  "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
+  "description": "A String", # [Output Only] A textual description of the operation, which is
+      # set when the operation is created.
+  "endTime": "A String", # [Output Only] The time that this operation was completed. This value is inRFC3339
+      # text format.
+  "error": { # [Output Only] If errors are generated during processing of the operation,
+      # this field will be populated.
+    "errors": [ # [Output Only] The array of errors encountered while processing this
+        # operation.
+      {
+        "code": "A String", # [Output Only] The error type identifier for this error.
+        "errorDetails": [ # [Output Only] An optional list of messages that contain the error
+            # details. There is a set of defined message types to use for providing
+            # details.The syntax depends on the error code. For example,
+            # QuotaExceededInfo will have details when the error code is
+            # QUOTA_EXCEEDED.
+          {
+            "errorInfo": { # Describes the cause of the error with structured details.
+                #
+                # Example of an error when contacting the "pubsub.googleapis.com" API when it
+                # is not enabled:
+                #
+                #     { "reason": "API_DISABLED"
+                #       "domain": "googleapis.com"
+                #       "metadata": {
+                #         "resource": "projects/123",
+                #         "service": "pubsub.googleapis.com"
+                #       }
+                #     }
+                #
+                # This response indicates that the pubsub.googleapis.com API is not enabled.
+                #
+                # Example of an error that is returned when attempting to create a Spanner
+                # instance in a region that is out of stock:
+                #
+                #     { "reason": "STOCKOUT"
+                #       "domain": "spanner.googleapis.com",
+                #       "metadata": {
+                #         "availableRegions": "us-central1,us-east2"
+                #       }
+                #     }
+              "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain
+                  # is typically the registered service name of the tool or product that
+                  # generates the error. Example: "pubsub.googleapis.com". If the error is
+                  # generated by some common infrastructure, the error domain must be a
+                  # globally unique value that identifies the infrastructure. For Google API
+                  # infrastructure, the error domain is "googleapis.com".
+              "metadatas": { # Additional structured details about this error.
+                  #
+                  # Keys must match a regular expression of `a-z+` but should
+                  # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
+                  # length. When identifying the current value of an exceeded limit, the units
+                  # should be contained in the key, not the value.  For example, rather than
+                  # `{"instanceLimit": "100/request"}`, should be returned as,
+                  # `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of
+                  # instances that can be created in a single (batch) request.
+                "a_key": "A String",
+              },
+              "reason": "A String", # The reason of the error. This is a constant value that identifies the
+                  # proximate cause of the error. Error reasons are unique within a particular
+                  # domain of errors. This should be at most 63 characters and match a
+                  # regular expression of `A-Z+[A-Z0-9]`, which represents
+                  # UPPER_SNAKE_CASE.
+            },
+            "help": { # Provides links to documentation or for performing an out of band action.
+                #
+                # For example, if a quota check failed with an error indicating the calling
+                # project hasn't enabled the accessed service, this can contain a URL pointing
+                # directly to the right place in the developer console to flip the bit.
+              "links": [ # URL(s) pointing to additional information on handling the current error.
+                { # Describes a URL link.
+                  "description": "A String", # Describes what the link offers.
+                  "url": "A String", # The URL of the link.
+                },
+              ],
+            },
+            "localizedMessage": { # Provides a localized error message that is safe to return to the user
+                # which can be attached to an RPC error.
+              "locale": "A String", # The locale used following the specification defined at
+                  # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
+                  # Examples are: "en-US", "fr-CH", "es-MX"
+              "message": "A String", # The localized error message in the above locale.
+            },
+            "quotaInfo": { # Additional details for quota exceeded error for resource quota.
+              "dimensions": { # The map holding related quota dimensions.
+                "a_key": "A String",
+              },
+              "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota
+                  #  type or metric.
+              "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type
+                  # or metric.
+              "limitName": "A String", # The name of the quota limit.
+              "metricName": "A String", # The Compute Engine quota metric name.
+              "rolloutStatus": "A String", # Rollout status of the future quota limit.
+            },
+          },
+        ],
+        "location": "A String", # [Output Only] Indicates the field in the request that caused the error.
+            # This property is optional.
+        "message": "A String", # [Output Only] An optional, human-readable error message.
+      },
+    ],
+  },
+  "getVersionOperationMetadata": {
+    "inlineSbomInfo": {
+      "currentComponentVersions": { # A mapping of components to their currently-applied versions or other
+          # appropriate identifiers.
+        "a_key": "A String",
+      },
+      "targetComponentVersions": { # A mapping of components to their target versions or other appropriate
+          # identifiers.
+        "a_key": "A String",
+      },
+    },
+  },
+  "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
+      # message that was returned, such as `NOT FOUND`.
+  "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
+      # status code that was returned. For example, a `404` means the
+      # resource was not found.
+  "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is
+      # defined by the server.
+  "insertTime": "A String", # [Output Only] The time that this operation was requested.
+      # This value is inRFC3339
+      # text format.
+  "instancesBulkInsertOperationMetadata": {
+    "perLocationStatus": { # Status information per location (location name is key).
+        # Example key: zones/us-central1-a
+      "a_key": {
+        "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far.
+        "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback.
+        "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an
+            # error.
+        "status": "A String", # [Output Only] Creation status of BulkInsert operation - information
+            # if the flow is rolling forward or rolling back.
+        "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created.
+      },
+    },
+  },
+  "kind": "compute#operation", # Output only. [Output Only] Type of the resource. Always `compute#operation` for
+      # Operation resources.
+  "name": "A String", # [Output Only] Name of the operation.
+  "operationGroupId": "A String", # Output only. [Output Only] An ID that represents a group of operations, such as when a
+      # group of operations results from a `bulkInsert` API request.
+  "operationType": "A String", # [Output Only] The type of operation, such as `insert`,
+      # `update`, or `delete`, and so on.
+  "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
+      # There is no requirement that this be linear or support any granularity of
+      # operations. This should not be used to guess when the operation will be
+      # complete. This number should monotonically increase as the operation
+      # progresses.
+  "region": "A String", # [Output Only] The URL of the region where the operation resides. Only
+      # applicable when performing regional operations.
+  "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+  "selfLinkWithId": "A String", # Output only. [Output Only] Server-defined URL for this resource with the resource id.
+  "setCommonInstanceMetadataOperationMetadata": { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
+      # this field will contain information on all underlying zonal actions and
+      # their state.
+    "clientOperationId": "A String", # [Output Only] The client operation id.
+    "perLocationOperations": { # [Output Only] Status information per location (location name is key).
+        # Example key: zones/us-central1-a
+      "a_key": {
+        "error": { # The `Status` type defines a logical error model that is suitable for # [Output Only] If state is `ABANDONED` or `FAILED`, this field is
+            # populated.
+            # different programming environments, including REST APIs and RPC APIs. It is
+            # used by [gRPC](https://github.com/grpc). Each `Status` message contains
+            # three pieces of data: error code, error message, and error details.
+            #
+            # You can find out more about this error model and how to work with it in the
+            # [API Design Guide](https://cloud.google.com/apis/design/errors).
+          "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+          "details": [ # A list of messages that carry the error details.  There is a common set of
+              # message types for APIs to use.
+            {
+              "a_key": "", # Properties of the object. Contains field @type with type URL.
+            },
+          ],
+          "message": "A String", # A developer-facing error message, which should be in English. Any
+              # user-facing error message should be localized and sent in the
+              # google.rpc.Status.details field, or localized by the client.
+        },
+        "state": "A String", # [Output Only] Status of the action, which can be one of the following:
+            # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
+      },
+    },
+  },
+  "startTime": "A String", # [Output Only] The time that this operation was started by the server.
+      # This value is inRFC3339
+      # text format.
+  "status": "A String", # [Output Only] The status of the operation, which can be one of the
+      # following:
+      # `PENDING`, `RUNNING`, or `DONE`.
+  "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the
+      # operation.
+  "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation
+      # of the target resource.
+  "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For
+      # operations related to creating a snapshot, this points to the disk
+      # that the snapshot was created from.
+  "user": "A String", # [Output Only] User who requested the operation, for example:
+      # `user@example.com` or
+      # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
+  "warnings": [ # [Output Only] If warning messages are generated during processing of the
+      # operation, this field will be populated.
+    {
+      "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute
+          # Engine returns NO_RESULTS_ON_PAGE if there
+          # are no results in the response.
+      "data": [ # [Output Only] Metadata about this warning in key:
+          # value format. For example:
+          #
+          # "data": [
+          #   {
+          #    "key": "scope",
+          #    "value": "zones/us-east1-d"
+          #   }
+        {
+          "key": "A String", # [Output Only] A key that provides more detail on the warning being
+              # returned. For example, for warnings where there are no results in a list
+              # request for a particular zone, this key might be scope and
+              # the key value might be the zone name. Other examples might be a key
+              # indicating a deprecated resource and a suggested replacement, or a
+              # warning about invalid network settings (for example, if an instance
+              # attempts to perform IP forwarding but is not enabled for IP forwarding).
+          "value": "A String", # [Output Only] A warning data value corresponding to the key.
+        },
+      ],
+      "message": "A String", # [Output Only] A human-readable description of the warning code.
+    },
+  ],
+  "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only
+      # applicable when performing per-zone operations.
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/compute_alpha.regionBackendServices.html b/docs/dyn/compute_alpha.regionBackendServices.html index eca423dc05..9a1147cc79 100644 --- a/docs/dyn/compute_alpha.regionBackendServices.html +++ b/docs/dyn/compute_alpha.regionBackendServices.html @@ -1332,6 +1332,16 @@

Method Details

# backend service. "enable": True or False, # Denotes whether to enable logging for the load balancer # traffic served by this backend service. The default value is false. + "loggingHttpRequestHeaders": [ # The list of request headers that will be logged to Stackdriver. + { # Determines which HTTP headers will be logged to Stackdriver. + "headerName": "A String", # The name of the header to be logged. + }, + ], + "loggingHttpResponseHeaders": [ # The list of response headers that will be logged to Stackdriver. + { # Determines which HTTP headers will be logged to Stackdriver. + "headerName": "A String", # The name of the header to be logged. + }, + ], "optional": "A String", # Deprecated in favor of optionalMode. # This field can only be specified if logging is enabled for this backend # service. Configures whether all, none or a subset of optional fields @@ -3521,6 +3531,16 @@

Method Details

# backend service. "enable": True or False, # Denotes whether to enable logging for the load balancer # traffic served by this backend service. The default value is false. + "loggingHttpRequestHeaders": [ # The list of request headers that will be logged to Stackdriver. + { # Determines which HTTP headers will be logged to Stackdriver. + "headerName": "A String", # The name of the header to be logged. + }, + ], + "loggingHttpResponseHeaders": [ # The list of response headers that will be logged to Stackdriver. + { # Determines which HTTP headers will be logged to Stackdriver. + "headerName": "A String", # The name of the header to be logged. + }, + ], "optional": "A String", # Deprecated in favor of optionalMode. # This field can only be specified if logging is enabled for this backend # service. Configures whether all, none or a subset of optional fields @@ -5660,6 +5680,16 @@

Method Details

# backend service. "enable": True or False, # Denotes whether to enable logging for the load balancer # traffic served by this backend service. The default value is false. + "loggingHttpRequestHeaders": [ # The list of request headers that will be logged to Stackdriver. + { # Determines which HTTP headers will be logged to Stackdriver. + "headerName": "A String", # The name of the header to be logged. + }, + ], + "loggingHttpResponseHeaders": [ # The list of response headers that will be logged to Stackdriver. + { # Determines which HTTP headers will be logged to Stackdriver. + "headerName": "A String", # The name of the header to be logged. + }, + ], "optional": "A String", # Deprecated in favor of optionalMode. # This field can only be specified if logging is enabled for this backend # service. Configures whether all, none or a subset of optional fields @@ -7549,6 +7579,16 @@

Method Details

# backend service. "enable": True or False, # Denotes whether to enable logging for the load balancer # traffic served by this backend service. The default value is false. + "loggingHttpRequestHeaders": [ # The list of request headers that will be logged to Stackdriver. + { # Determines which HTTP headers will be logged to Stackdriver. + "headerName": "A String", # The name of the header to be logged. + }, + ], + "loggingHttpResponseHeaders": [ # The list of response headers that will be logged to Stackdriver. + { # Determines which HTTP headers will be logged to Stackdriver. + "headerName": "A String", # The name of the header to be logged. + }, + ], "optional": "A String", # Deprecated in favor of optionalMode. # This field can only be specified if logging is enabled for this backend # service. Configures whether all, none or a subset of optional fields @@ -9379,6 +9419,16 @@

Method Details

# backend service. "enable": True or False, # Denotes whether to enable logging for the load balancer # traffic served by this backend service. The default value is false. + "loggingHttpRequestHeaders": [ # The list of request headers that will be logged to Stackdriver. + { # Determines which HTTP headers will be logged to Stackdriver. + "headerName": "A String", # The name of the header to be logged. + }, + ], + "loggingHttpResponseHeaders": [ # The list of response headers that will be logged to Stackdriver. + { # Determines which HTTP headers will be logged to Stackdriver. + "headerName": "A String", # The name of the header to be logged. + }, + ], "optional": "A String", # Deprecated in favor of optionalMode. # This field can only be specified if logging is enabled for this backend # service. Configures whether all, none or a subset of optional fields @@ -12643,6 +12693,16 @@

Method Details

# backend service. "enable": True or False, # Denotes whether to enable logging for the load balancer # traffic served by this backend service. The default value is false. + "loggingHttpRequestHeaders": [ # The list of request headers that will be logged to Stackdriver. + { # Determines which HTTP headers will be logged to Stackdriver. + "headerName": "A String", # The name of the header to be logged. + }, + ], + "loggingHttpResponseHeaders": [ # The list of response headers that will be logged to Stackdriver. + { # Determines which HTTP headers will be logged to Stackdriver. + "headerName": "A String", # The name of the header to be logged. + }, + ], "optional": "A String", # Deprecated in favor of optionalMode. # This field can only be specified if logging is enabled for this backend # service. Configures whether all, none or a subset of optional fields diff --git a/docs/dyn/compute_alpha.regionInstanceGroupManagers.html b/docs/dyn/compute_alpha.regionInstanceGroupManagers.html index 6ca4ef568f..230a84f45f 100644 --- a/docs/dyn/compute_alpha.regionInstanceGroupManagers.html +++ b/docs/dyn/compute_alpha.regionInstanceGroupManagers.html @@ -883,6 +883,9 @@

Method Details

"allInstances": True or False, # Flag to update all instances instead of specified list of “instances”. # If the flag is set to true then the instances may not be specified # in the request. + "allowedActions": [ # Actions that are allowed to update instances within MIG. + "A String", + ], "disruptionMode": "A String", # Whether the boot disk is allowed to be updated with restart. "instances": [ # The list of URLs of one or more instances for which you want to apply # updates. Each URL can be a full URL or a partial URL, such aszones/[ZONE]/instances/[INSTANCE_NAME]. @@ -4153,6 +4156,9 @@

Method Details

# - Manually change the targetSuspendedSize using the update # method. "updatePolicy": { # The update policy for this managed instance group. + "allowedActions": [ # Actions that are allowed to update instances within MIG. + "A String", + ], "disruptionMode": "A String", # Whether the boot disk is allowed to be updated with restart. "instanceRedistributionType": "A String", # The # instance redistribution policy for regional managed instance groups. @@ -5972,6 +5978,9 @@

Method Details

# - Manually change the targetSuspendedSize using the update # method. "updatePolicy": { # The update policy for this managed instance group. + "allowedActions": [ # Actions that are allowed to update instances within MIG. + "A String", + ], "disruptionMode": "A String", # Whether the boot disk is allowed to be updated with restart. "instanceRedistributionType": "A String", # The # instance redistribution policy for regional managed instance groups. @@ -8160,6 +8169,9 @@

Method Details

# - Manually change the targetSuspendedSize using the update # method. "updatePolicy": { # The update policy for this managed instance group. + "allowedActions": [ # Actions that are allowed to update instances within MIG. + "A String", + ], "disruptionMode": "A String", # Whether the boot disk is allowed to be updated with restart. "instanceRedistributionType": "A String", # The # instance redistribution policy for regional managed instance groups. @@ -8460,18 +8472,18 @@

Method Details

{ "items": [ # [Output Only] The list of errors of the managed instance group. { - "error": { # Output only. [Output Only] Contents of the error. - "code": "A String", # Output only. [Output Only] Error code. - "message": "A String", # Output only. [Output Only] Error message. + "error": { # Output only. Contents of the error. + "code": "A String", # Output only. Error code. + "message": "A String", # Output only. Error message. }, - "instanceActionDetails": { # Output only. [Output Only] Details of the instance action that triggered this error. + "instanceActionDetails": { # Output only. Details of the instance action that triggered this error. # May be null, if the error was not caused by an action on an instance. # This field is optional. - "action": "A String", # Output only. [Output Only] Action that managed instance group was executing on - # the instance when the error occurred. Possible values: - "instance": "A String", # Output only. [Output Only] The URL of the instance. - # The URL can be set even if the instance has not yet been created. - "version": { # Output only. [Output Only] Version this instance was created from, or was being + "action": "A String", # Output only. Action that managed instance group was executing on the instance when the + # error occurred. Possible values: + "instance": "A String", # Output only. The URL of the instance. The URL can be set even if the instance has not + # yet been created. + "version": { # Output only. Version this instance was created from, or was being # created from, but the creation failed. Corresponds to one of the versions # that were set on the Instance Group Manager resource at the time this # instance was being created. @@ -8480,8 +8492,7 @@

Method Details

"name": "A String", # Output only. [Output Only] Name of the version. }, }, - "timestamp": "A String", # Output only. [Output Only] The time that this error occurred. - # This value is in RFC3339 text format. + "timestamp": "A String", # Output only. The time that this error occurred. This value is in RFC3339 text format. }, ], "nextPageToken": "A String", # Output only. [Output Only] This token allows you to get the next page of results for @@ -11800,6 +11811,9 @@

Method Details

# - Manually change the targetSuspendedSize using the update # method. "updatePolicy": { # The update policy for this managed instance group. + "allowedActions": [ # Actions that are allowed to update instances within MIG. + "A String", + ], "disruptionMode": "A String", # Whether the boot disk is allowed to be updated with restart. "instanceRedistributionType": "A String", # The # instance redistribution policy for regional managed instance groups. @@ -17550,6 +17564,9 @@

Method Details

# - Manually change the targetSuspendedSize using the update # method. "updatePolicy": { # The update policy for this managed instance group. + "allowedActions": [ # Actions that are allowed to update instances within MIG. + "A String", + ], "disruptionMode": "A String", # Whether the boot disk is allowed to be updated with restart. "instanceRedistributionType": "A String", # The # instance redistribution policy for regional managed instance groups. diff --git a/docs/dyn/compute_alpha.routers.html b/docs/dyn/compute_alpha.routers.html index 0f3e2f13a3..e6aa3bc476 100644 --- a/docs/dyn/compute_alpha.routers.html +++ b/docs/dyn/compute_alpha.routers.html @@ -607,6 +607,9 @@

Method Details

# These IPs should be used for updating/patching a NAT only. "A String", ], + "effectiveTcpTimeWaitTimeoutSec": 42, # Output only. Effective timeout (in seconds) for TCP connections that are in TIME_WAIT + # state. This value is equal to tcp_time_wait_timeout_sec if it is set, + # otherwise it is equal to 120s. The field is output only. "enableDynamicPortAllocation": True or False, # Enable Dynamic Port Allocation. # # @@ -2130,6 +2133,9 @@

Method Details

# These IPs should be used for updating/patching a NAT only. "A String", ], + "effectiveTcpTimeWaitTimeoutSec": 42, # Output only. Effective timeout (in seconds) for TCP connections that are in TIME_WAIT + # state. This value is equal to tcp_time_wait_timeout_sec if it is set, + # otherwise it is equal to 120s. The field is output only. "enableDynamicPortAllocation": True or False, # Enable Dynamic Port Allocation. # # @@ -3897,6 +3903,9 @@

Method Details

# These IPs should be used for updating/patching a NAT only. "A String", ], + "effectiveTcpTimeWaitTimeoutSec": 42, # Output only. Effective timeout (in seconds) for TCP connections that are in TIME_WAIT + # state. This value is equal to tcp_time_wait_timeout_sec if it is set, + # otherwise it is equal to 120s. The field is output only. "enableDynamicPortAllocation": True or False, # Enable Dynamic Port Allocation. # # @@ -4822,6 +4831,9 @@

Method Details

# These IPs should be used for updating/patching a NAT only. "A String", ], + "effectiveTcpTimeWaitTimeoutSec": 42, # Output only. Effective timeout (in seconds) for TCP connections that are in TIME_WAIT + # state. This value is equal to tcp_time_wait_timeout_sec if it is set, + # otherwise it is equal to 120s. The field is output only. "enableDynamicPortAllocation": True or False, # Enable Dynamic Port Allocation. # # @@ -6111,6 +6123,9 @@

Method Details

# These IPs should be used for updating/patching a NAT only. "A String", ], + "effectiveTcpTimeWaitTimeoutSec": 42, # Output only. Effective timeout (in seconds) for TCP connections that are in TIME_WAIT + # state. This value is equal to tcp_time_wait_timeout_sec if it is set, + # otherwise it is equal to 120s. The field is output only. "enableDynamicPortAllocation": True or False, # Enable Dynamic Port Allocation. # # @@ -7711,6 +7726,9 @@

Method Details

# These IPs should be used for updating/patching a NAT only. "A String", ], + "effectiveTcpTimeWaitTimeoutSec": 42, # Output only. Effective timeout (in seconds) for TCP connections that are in TIME_WAIT + # state. This value is equal to tcp_time_wait_timeout_sec if it is set, + # otherwise it is equal to 120s. The field is output only. "enableDynamicPortAllocation": True or False, # Enable Dynamic Port Allocation. # # @@ -8258,6 +8276,9 @@

Method Details

# These IPs should be used for updating/patching a NAT only. "A String", ], + "effectiveTcpTimeWaitTimeoutSec": 42, # Output only. Effective timeout (in seconds) for TCP connections that are in TIME_WAIT + # state. This value is equal to tcp_time_wait_timeout_sec if it is set, + # otherwise it is equal to 120s. The field is output only. "enableDynamicPortAllocation": True or False, # Enable Dynamic Port Allocation. # # @@ -8846,6 +8867,9 @@

Method Details

# These IPs should be used for updating/patching a NAT only. "A String", ], + "effectiveTcpTimeWaitTimeoutSec": 42, # Output only. Effective timeout (in seconds) for TCP connections that are in TIME_WAIT + # state. This value is equal to tcp_time_wait_timeout_sec if it is set, + # otherwise it is equal to 120s. The field is output only. "enableDynamicPortAllocation": True or False, # Enable Dynamic Port Allocation. # # diff --git a/docs/dyn/compute_alpha.snapshotRecycleBinPolicy.html b/docs/dyn/compute_alpha.snapshotRecycleBinPolicy.html index 40160ef7e7..7a94d16cff 100644 --- a/docs/dyn/compute_alpha.snapshotRecycleBinPolicy.html +++ b/docs/dyn/compute_alpha.snapshotRecycleBinPolicy.html @@ -126,6 +126,15 @@

Method Details

}, }, }, + "systemRules": { # Output only. The system rules for snapshot recycle bin policy. + # Defines the default rule that applies if no customer-defined rule matches. + "a_key": { # A rule that defines the retention policy for snapshots in the recycle bin. + "standardSnapshots": { # The rule config for snapshots in the recycle bin. # The rule config for standard snapshots. + "retentionDurationDays": "A String", # The retention duration for snapshots in the recycle bin after which the + # snapshots are automatically deleted from recycle bin. + }, + }, + }, }
@@ -161,6 +170,15 @@

Method Details

}, }, }, + "systemRules": { # Output only. The system rules for snapshot recycle bin policy. + # Defines the default rule that applies if no customer-defined rule matches. + "a_key": { # A rule that defines the retention policy for snapshots in the recycle bin. + "standardSnapshots": { # The rule config for snapshots in the recycle bin. # The rule config for standard snapshots. + "retentionDurationDays": "A String", # The retention duration for snapshots in the recycle bin after which the + # snapshots are automatically deleted from recycle bin. + }, + }, + }, } requestId: string, An optional request ID to identify requests. Specify a unique request ID so diff --git a/docs/dyn/compute_beta.backendServices.html b/docs/dyn/compute_beta.backendServices.html index 358f597eab..ae5d6bf6e1 100644 --- a/docs/dyn/compute_beta.backendServices.html +++ b/docs/dyn/compute_beta.backendServices.html @@ -1448,6 +1448,16 @@

Method Details

# backend service. "enable": True or False, # Denotes whether to enable logging for the load balancer # traffic served by this backend service. The default value is false. + "loggingHttpRequestHeaders": [ # The list of request headers that will be logged to Stackdriver. + { # Determines which HTTP headers will be logged to Stackdriver. + "headerName": "A String", # The name of the header to be logged. + }, + ], + "loggingHttpResponseHeaders": [ # The list of response headers that will be logged to Stackdriver. + { # Determines which HTTP headers will be logged to Stackdriver. + "headerName": "A String", # The name of the header to be logged. + }, + ], "optionalFields": [ # This field can only be specified if logging is enabled for this backend # service and "logConfig.optionalMode" was set to CUSTOM. Contains a list # of optional fields you want to include in the logs. For example: @@ -3481,6 +3491,16 @@

Method Details

# backend service. "enable": True or False, # Denotes whether to enable logging for the load balancer # traffic served by this backend service. The default value is false. + "loggingHttpRequestHeaders": [ # The list of request headers that will be logged to Stackdriver. + { # Determines which HTTP headers will be logged to Stackdriver. + "headerName": "A String", # The name of the header to be logged. + }, + ], + "loggingHttpResponseHeaders": [ # The list of response headers that will be logged to Stackdriver. + { # Determines which HTTP headers will be logged to Stackdriver. + "headerName": "A String", # The name of the header to be logged. + }, + ], "optionalFields": [ # This field can only be specified if logging is enabled for this backend # service and "logConfig.optionalMode" was set to CUSTOM. Contains a list # of optional fields you want to include in the logs. For example: @@ -6002,6 +6022,16 @@

Method Details

# backend service. "enable": True or False, # Denotes whether to enable logging for the load balancer # traffic served by this backend service. The default value is false. + "loggingHttpRequestHeaders": [ # The list of request headers that will be logged to Stackdriver. + { # Determines which HTTP headers will be logged to Stackdriver. + "headerName": "A String", # The name of the header to be logged. + }, + ], + "loggingHttpResponseHeaders": [ # The list of response headers that will be logged to Stackdriver. + { # Determines which HTTP headers will be logged to Stackdriver. + "headerName": "A String", # The name of the header to be logged. + }, + ], "optionalFields": [ # This field can only be specified if logging is enabled for this backend # service and "logConfig.optionalMode" was set to CUSTOM. Contains a list # of optional fields you want to include in the logs. For example: @@ -7734,6 +7764,16 @@

Method Details

# backend service. "enable": True or False, # Denotes whether to enable logging for the load balancer # traffic served by this backend service. The default value is false. + "loggingHttpRequestHeaders": [ # The list of request headers that will be logged to Stackdriver. + { # Determines which HTTP headers will be logged to Stackdriver. + "headerName": "A String", # The name of the header to be logged. + }, + ], + "loggingHttpResponseHeaders": [ # The list of response headers that will be logged to Stackdriver. + { # Determines which HTTP headers will be logged to Stackdriver. + "headerName": "A String", # The name of the header to be logged. + }, + ], "optionalFields": [ # This field can only be specified if logging is enabled for this backend # service and "logConfig.optionalMode" was set to CUSTOM. Contains a list # of optional fields you want to include in the logs. For example: @@ -9215,6 +9255,16 @@

Method Details

# backend service. "enable": True or False, # Denotes whether to enable logging for the load balancer # traffic served by this backend service. The default value is false. + "loggingHttpRequestHeaders": [ # The list of request headers that will be logged to Stackdriver. + { # Determines which HTTP headers will be logged to Stackdriver. + "headerName": "A String", # The name of the header to be logged. + }, + ], + "loggingHttpResponseHeaders": [ # The list of response headers that will be logged to Stackdriver. + { # Determines which HTTP headers will be logged to Stackdriver. + "headerName": "A String", # The name of the header to be logged. + }, + ], "optionalFields": [ # This field can only be specified if logging is enabled for this backend # service and "logConfig.optionalMode" was set to CUSTOM. Contains a list # of optional fields you want to include in the logs. For example: @@ -10639,6 +10689,16 @@

Method Details

# backend service. "enable": True or False, # Denotes whether to enable logging for the load balancer # traffic served by this backend service. The default value is false. + "loggingHttpRequestHeaders": [ # The list of request headers that will be logged to Stackdriver. + { # Determines which HTTP headers will be logged to Stackdriver. + "headerName": "A String", # The name of the header to be logged. + }, + ], + "loggingHttpResponseHeaders": [ # The list of response headers that will be logged to Stackdriver. + { # Determines which HTTP headers will be logged to Stackdriver. + "headerName": "A String", # The name of the header to be logged. + }, + ], "optionalFields": [ # This field can only be specified if logging is enabled for this backend # service and "logConfig.optionalMode" was set to CUSTOM. Contains a list # of optional fields you want to include in the logs. For example: @@ -13791,6 +13851,16 @@

Method Details

# backend service. "enable": True or False, # Denotes whether to enable logging for the load balancer # traffic served by this backend service. The default value is false. + "loggingHttpRequestHeaders": [ # The list of request headers that will be logged to Stackdriver. + { # Determines which HTTP headers will be logged to Stackdriver. + "headerName": "A String", # The name of the header to be logged. + }, + ], + "loggingHttpResponseHeaders": [ # The list of response headers that will be logged to Stackdriver. + { # Determines which HTTP headers will be logged to Stackdriver. + "headerName": "A String", # The name of the header to be logged. + }, + ], "optionalFields": [ # This field can only be specified if logging is enabled for this backend # service and "logConfig.optionalMode" was set to CUSTOM. Contains a list # of optional fields you want to include in the logs. For example: diff --git a/docs/dyn/compute_beta.html b/docs/dyn/compute_beta.html index 3289f237e2..733cfa130e 100644 --- a/docs/dyn/compute_beta.html +++ b/docs/dyn/compute_beta.html @@ -344,6 +344,16 @@

Instance Methods

Returns the nodeTypes Resource.

+

+ organizationRolloutPlans() +

+

Returns the organizationRolloutPlans Resource.

+ +

+ organizationRollouts() +

+

Returns the organizationRollouts Resource.

+

organizationSecurityPolicies()

diff --git a/docs/dyn/compute_beta.instanceGroupManagers.html b/docs/dyn/compute_beta.instanceGroupManagers.html index fe58956f02..0ac834bfc9 100644 --- a/docs/dyn/compute_beta.instanceGroupManagers.html +++ b/docs/dyn/compute_beta.instanceGroupManagers.html @@ -705,6 +705,8 @@

Method Details

# pools for the instance. "restarting": 42, # Output only. The number of instances in the managed instance group that # are scheduled to be restarted or are currently being restarted. + "restartingInPlace": 42, # Output only. The number of instances in the managed instance group that + # are scheduled to be restarted or are currently being restarted. "resuming": 42, # Output only. The number of instances in the managed instance group that # are scheduled to be resumed or are currently being resumed. "starting": 42, # Output only. The number of instances in the managed instance group that @@ -1702,6 +1704,9 @@

Method Details

# - Manually change the targetSuspendedSize using the update # method. "updatePolicy": { # The update policy for this managed instance group. + "allowedActions": [ # Actions that are allowed to update instances within MIG. + "A String", + ], "instanceRedistributionType": "A String", # The # instance redistribution policy for regional managed instance groups. # Valid values are: @@ -1953,6 +1958,9 @@

Method Details

"allInstances": True or False, # Flag to update all instances instead of specified list of “instances”. # If the flag is set to true then the instances may not be specified # in the request. + "allowedActions": [ # Actions that are allowed to update instances within MIG. + "A String", + ], "instances": [ # The list of URLs of one or more instances for which you want to apply # updates. Each URL can be a full URL or a partial URL, such aszones/[ZONE]/instances/[INSTANCE_NAME]. "A String", @@ -3988,6 +3996,8 @@

Method Details

# pools for the instance. "restarting": 42, # Output only. The number of instances in the managed instance group that # are scheduled to be restarted or are currently being restarted. + "restartingInPlace": 42, # Output only. The number of instances in the managed instance group that + # are scheduled to be restarted or are currently being restarted. "resuming": 42, # Output only. The number of instances in the managed instance group that # are scheduled to be resumed or are currently being resumed. "starting": 42, # Output only. The number of instances in the managed instance group that @@ -4985,6 +4995,9 @@

Method Details

# - Manually change the targetSuspendedSize using the update # method. "updatePolicy": { # The update policy for this managed instance group. + "allowedActions": [ # Actions that are allowed to update instances within MIG. + "A String", + ], "instanceRedistributionType": "A String", # The # instance redistribution policy for regional managed instance groups. # Valid values are: @@ -5389,6 +5402,8 @@

Method Details

# pools for the instance. "restarting": 42, # Output only. The number of instances in the managed instance group that # are scheduled to be restarted or are currently being restarted. + "restartingInPlace": 42, # Output only. The number of instances in the managed instance group that + # are scheduled to be restarted or are currently being restarted. "resuming": 42, # Output only. The number of instances in the managed instance group that # are scheduled to be resumed or are currently being resumed. "starting": 42, # Output only. The number of instances in the managed instance group that @@ -6386,6 +6401,9 @@

Method Details

# - Manually change the targetSuspendedSize using the update # method. "updatePolicy": { # The update policy for this managed instance group. + "allowedActions": [ # Actions that are allowed to update instances within MIG. + "A String", + ], "instanceRedistributionType": "A String", # The # instance redistribution policy for regional managed instance groups. # Valid values are: @@ -7016,6 +7034,8 @@

Method Details

# pools for the instance. "restarting": 42, # Output only. The number of instances in the managed instance group that # are scheduled to be restarted or are currently being restarted. + "restartingInPlace": 42, # Output only. The number of instances in the managed instance group that + # are scheduled to be restarted or are currently being restarted. "resuming": 42, # Output only. The number of instances in the managed instance group that # are scheduled to be resumed or are currently being resumed. "starting": 42, # Output only. The number of instances in the managed instance group that @@ -8013,6 +8033,9 @@

Method Details

# - Manually change the targetSuspendedSize using the update # method. "updatePolicy": { # The update policy for this managed instance group. + "allowedActions": [ # Actions that are allowed to update instances within MIG. + "A String", + ], "instanceRedistributionType": "A String", # The # instance redistribution policy for regional managed instance groups. # Valid values are: @@ -8311,18 +8334,18 @@

Method Details

{ "items": [ # Output only. [Output Only] The list of errors of the managed instance group. { - "error": { # Output only. [Output Only] Contents of the error. - "code": "A String", # Output only. [Output Only] Error code. - "message": "A String", # Output only. [Output Only] Error message. + "error": { # Output only. Contents of the error. + "code": "A String", # Output only. Error code. + "message": "A String", # Output only. Error message. }, - "instanceActionDetails": { # Output only. [Output Only] Details of the instance action that triggered this error. + "instanceActionDetails": { # Output only. Details of the instance action that triggered this error. # May be null, if the error was not caused by an action on an instance. # This field is optional. - "action": "A String", # Output only. [Output Only] Action that managed instance group was executing on - # the instance when the error occurred. Possible values: - "instance": "A String", # Output only. [Output Only] The URL of the instance. - # The URL can be set even if the instance has not yet been created. - "version": { # Output only. [Output Only] Version this instance was created from, or was being + "action": "A String", # Output only. Action that managed instance group was executing on the instance when the + # error occurred. Possible values: + "instance": "A String", # Output only. The URL of the instance. The URL can be set even if the instance has not + # yet been created. + "version": { # Output only. Version this instance was created from, or was being # created from, but the creation failed. Corresponds to one of the versions # that were set on the Instance Group Manager resource at the time this # instance was being created. @@ -8331,8 +8354,7 @@

Method Details

"name": "A String", # Output only. [Output Only] Name of the version. }, }, - "timestamp": "A String", # Output only. [Output Only] The time that this error occurred. - # This value is in RFC3339 text format. + "timestamp": "A String", # Output only. The time that this error occurred. This value is in RFC3339 text format. }, ], "nextPageToken": "A String", # Output only. [Output Only] This token allows you to get the next page of results for @@ -9587,6 +9609,8 @@

Method Details

# pools for the instance. "restarting": 42, # Output only. The number of instances in the managed instance group that # are scheduled to be restarted or are currently being restarted. + "restartingInPlace": 42, # Output only. The number of instances in the managed instance group that + # are scheduled to be restarted or are currently being restarted. "resuming": 42, # Output only. The number of instances in the managed instance group that # are scheduled to be resumed or are currently being resumed. "starting": 42, # Output only. The number of instances in the managed instance group that @@ -10584,6 +10608,9 @@

Method Details

# - Manually change the targetSuspendedSize using the update # method. "updatePolicy": { # The update policy for this managed instance group. + "allowedActions": [ # Actions that are allowed to update instances within MIG. + "A String", + ], "instanceRedistributionType": "A String", # The # instance redistribution policy for regional managed instance groups. # Valid values are: @@ -14753,6 +14780,8 @@

Method Details

# pools for the instance. "restarting": 42, # Output only. The number of instances in the managed instance group that # are scheduled to be restarted or are currently being restarted. + "restartingInPlace": 42, # Output only. The number of instances in the managed instance group that + # are scheduled to be restarted or are currently being restarted. "resuming": 42, # Output only. The number of instances in the managed instance group that # are scheduled to be resumed or are currently being resumed. "starting": 42, # Output only. The number of instances in the managed instance group that @@ -15750,6 +15779,9 @@

Method Details

# - Manually change the targetSuspendedSize using the update # method. "updatePolicy": { # The update policy for this managed instance group. + "allowedActions": [ # Actions that are allowed to update instances within MIG. + "A String", + ], "instanceRedistributionType": "A String", # The # instance redistribution policy for regional managed instance groups. # Valid values are: diff --git a/docs/dyn/compute_beta.instances.html b/docs/dyn/compute_beta.instances.html index 4f8daaa545..26f49ee56f 100644 --- a/docs/dyn/compute_beta.instances.html +++ b/docs/dyn/compute_beta.instances.html @@ -2461,6 +2461,14 @@

Method Details

# Engine cluster, as well as the ID of the block, sub-block, and host on # which the running instance is located. # running. + "additionalAttributes": { # Additional location information of the running instance. # Output only. [Output Only] Additional location information of the running instance. + "acceleratorTopologyIds": { # Output only. The IDs of the accelerator topologies the instance belongs to. For + # example + # The key will be topologies like "4x4", "2x2x2" and the value will be + # the location ID of the topologies. + "a_key": "A String", + }, + }, "block": "A String", # [Output Only] The ID of the block in which the running instance is # located. Instances within the same block experience low network latency. "cluster": "A String", # [Output Only] The global name of the Compute Engine cluster where the @@ -2475,6 +2483,10 @@

Method Details

"reservationConsumptionInfo": { # Reservation consumption information that the instance is consuming from. # Output only. [Output Only] Reservation information that the instance is consuming from. "consumedReservation": "A String", # Output only. [Output Only] The full resource name of the reservation that this # instance is consuming from. + "consumedReservationBlock": "A String", # Output only. [Output Only] The full resource name of the reservation block that this + # instance is consuming from. + "consumedReservationSubBlock": "A String", # Output only. [Output Only] The full resource name of the reservation sub-block that + # this instance is consuming from. }, "scheduling": { "availabilityDomain": 42, # Specifies the availability domain to place the instance in. The value @@ -7603,6 +7615,14 @@

Method Details

# Engine cluster, as well as the ID of the block, sub-block, and host on # which the running instance is located. # running. + "additionalAttributes": { # Additional location information of the running instance. # Output only. [Output Only] Additional location information of the running instance. + "acceleratorTopologyIds": { # Output only. The IDs of the accelerator topologies the instance belongs to. For + # example + # The key will be topologies like "4x4", "2x2x2" and the value will be + # the location ID of the topologies. + "a_key": "A String", + }, + }, "block": "A String", # [Output Only] The ID of the block in which the running instance is # located. Instances within the same block experience low network latency. "cluster": "A String", # [Output Only] The global name of the Compute Engine cluster where the @@ -7617,6 +7637,10 @@

Method Details

"reservationConsumptionInfo": { # Reservation consumption information that the instance is consuming from. # Output only. [Output Only] Reservation information that the instance is consuming from. "consumedReservation": "A String", # Output only. [Output Only] The full resource name of the reservation that this # instance is consuming from. + "consumedReservationBlock": "A String", # Output only. [Output Only] The full resource name of the reservation block that this + # instance is consuming from. + "consumedReservationSubBlock": "A String", # Output only. [Output Only] The full resource name of the reservation sub-block that + # this instance is consuming from. }, "scheduling": { "availabilityDomain": 42, # Specifies the availability domain to place the instance in. The value @@ -10512,6 +10536,14 @@

Method Details

# Engine cluster, as well as the ID of the block, sub-block, and host on # which the running instance is located. # running. + "additionalAttributes": { # Additional location information of the running instance. # Output only. [Output Only] Additional location information of the running instance. + "acceleratorTopologyIds": { # Output only. The IDs of the accelerator topologies the instance belongs to. For + # example + # The key will be topologies like "4x4", "2x2x2" and the value will be + # the location ID of the topologies. + "a_key": "A String", + }, + }, "block": "A String", # [Output Only] The ID of the block in which the running instance is # located. Instances within the same block experience low network latency. "cluster": "A String", # [Output Only] The global name of the Compute Engine cluster where the @@ -10526,6 +10558,10 @@

Method Details

"reservationConsumptionInfo": { # Reservation consumption information that the instance is consuming from. # Output only. [Output Only] Reservation information that the instance is consuming from. "consumedReservation": "A String", # Output only. [Output Only] The full resource name of the reservation that this # instance is consuming from. + "consumedReservationBlock": "A String", # Output only. [Output Only] The full resource name of the reservation block that this + # instance is consuming from. + "consumedReservationSubBlock": "A String", # Output only. [Output Only] The full resource name of the reservation sub-block that + # this instance is consuming from. }, "scheduling": { "availabilityDomain": 42, # Specifies the availability domain to place the instance in. The value @@ -12177,6 +12213,14 @@

Method Details

# Engine cluster, as well as the ID of the block, sub-block, and host on # which the running instance is located. # running. + "additionalAttributes": { # Additional location information of the running instance. # Output only. [Output Only] Additional location information of the running instance. + "acceleratorTopologyIds": { # Output only. The IDs of the accelerator topologies the instance belongs to. For + # example + # The key will be topologies like "4x4", "2x2x2" and the value will be + # the location ID of the topologies. + "a_key": "A String", + }, + }, "block": "A String", # [Output Only] The ID of the block in which the running instance is # located. Instances within the same block experience low network latency. "cluster": "A String", # [Output Only] The global name of the Compute Engine cluster where the @@ -12191,6 +12235,10 @@

Method Details

"reservationConsumptionInfo": { # Reservation consumption information that the instance is consuming from. # Output only. [Output Only] Reservation information that the instance is consuming from. "consumedReservation": "A String", # Output only. [Output Only] The full resource name of the reservation that this # instance is consuming from. + "consumedReservationBlock": "A String", # Output only. [Output Only] The full resource name of the reservation block that this + # instance is consuming from. + "consumedReservationSubBlock": "A String", # Output only. [Output Only] The full resource name of the reservation sub-block that + # this instance is consuming from. }, "scheduling": { "availabilityDomain": 42, # Specifies the availability domain to place the instance in. The value @@ -22490,6 +22538,14 @@

Method Details

# Engine cluster, as well as the ID of the block, sub-block, and host on # which the running instance is located. # running. + "additionalAttributes": { # Additional location information of the running instance. # Output only. [Output Only] Additional location information of the running instance. + "acceleratorTopologyIds": { # Output only. The IDs of the accelerator topologies the instance belongs to. For + # example + # The key will be topologies like "4x4", "2x2x2" and the value will be + # the location ID of the topologies. + "a_key": "A String", + }, + }, "block": "A String", # [Output Only] The ID of the block in which the running instance is # located. Instances within the same block experience low network latency. "cluster": "A String", # [Output Only] The global name of the Compute Engine cluster where the @@ -22504,6 +22560,10 @@

Method Details

"reservationConsumptionInfo": { # Reservation consumption information that the instance is consuming from. # Output only. [Output Only] Reservation information that the instance is consuming from. "consumedReservation": "A String", # Output only. [Output Only] The full resource name of the reservation that this # instance is consuming from. + "consumedReservationBlock": "A String", # Output only. [Output Only] The full resource name of the reservation block that this + # instance is consuming from. + "consumedReservationSubBlock": "A String", # Output only. [Output Only] The full resource name of the reservation sub-block that + # this instance is consuming from. }, "scheduling": { "availabilityDomain": 42, # Specifies the availability domain to place the instance in. The value diff --git a/docs/dyn/compute_beta.organizationRolloutPlans.html b/docs/dyn/compute_beta.organizationRolloutPlans.html new file mode 100644 index 0000000000..cde835cef8 --- /dev/null +++ b/docs/dyn/compute_beta.organizationRolloutPlans.html @@ -0,0 +1,1144 @@ + + + +

Compute Engine API . organizationRolloutPlans

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ delete(organization, rolloutPlan, requestId=None, x__xgafv=None)

+

Deletes an OrganizationRolloutPlan.

+

+ get(organization, rolloutPlan, x__xgafv=None)

+

Gets details of a single organization-scoped RolloutPlan.

+

+ insert(organization, body=None, requestId=None, x__xgafv=None)

+

Creates a new RolloutPlan in a given organization and location.

+

+ list(organization, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

+

Lists OrganizationRolloutPlans in a given organization and location.

+

+ list_next()

+

Retrieves the next page of results.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ delete(organization, rolloutPlan, requestId=None, x__xgafv=None) +
Deletes an OrganizationRolloutPlan.
+
+Args:
+  organization: string, Organization ID for this request. (required)
+  rolloutPlan: string, Name of the OrganizationRolloutPlan resource to delete. (required)
+  requestId: string, An optional request ID to identify requests. Specify a unique request ID so
+that if you must retry your request, the server will know to ignore the
+request if it has already been completed.
+
+For example, consider a situation where you make an initial request and
+the request times out. If you make the request again with the same
+request ID, the server can check if original operation with the same
+request ID was received, and if so, will ignore the second request. This
+prevents clients from accidentally creating duplicate commitments.
+
+The request ID must be
+a valid UUID with the exception that zero UUID is not supported
+(00000000-0000-0000-0000-000000000000).
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Represents an Operation resource.
+    #
+    # Google Compute Engine has three Operation resources:
+    #
+    # * [Global](/compute/docs/reference/rest/beta/globalOperations)
+    # * [Regional](/compute/docs/reference/rest/beta/regionOperations)
+    # * [Zonal](/compute/docs/reference/rest/beta/zoneOperations)
+    #
+    # You can use an operation resource to manage asynchronous API requests.
+    # For more information, readHandling
+    # API responses.
+    #
+    # Operations can be global, regional or zonal.
+    #
+    #    - For global operations, use the `globalOperations`
+    #    resource.
+    #    - For regional operations, use the
+    #    `regionOperations` resource.
+    #    - For zonal operations, use
+    #    the `zoneOperations` resource.
+    #
+    #
+    #
+    # For more information, read
+    # Global, Regional, and Zonal Resources.
+    #
+    # Note that completed Operation resources have a limited
+    # retention period.
+  "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request.
+      # Not present otherwise.
+  "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
+  "description": "A String", # [Output Only] A textual description of the operation, which is
+      # set when the operation is created.
+  "endTime": "A String", # [Output Only] The time that this operation was completed. This value is inRFC3339
+      # text format.
+  "error": { # [Output Only] If errors are generated during processing of the operation,
+      # this field will be populated.
+    "errors": [ # [Output Only] The array of errors encountered while processing this
+        # operation.
+      {
+        "code": "A String", # [Output Only] The error type identifier for this error.
+        "errorDetails": [ # [Output Only] An optional list of messages that contain the error
+            # details. There is a set of defined message types to use for providing
+            # details.The syntax depends on the error code. For example,
+            # QuotaExceededInfo will have details when the error code is
+            # QUOTA_EXCEEDED.
+          {
+            "errorInfo": { # Describes the cause of the error with structured details.
+                #
+                # Example of an error when contacting the "pubsub.googleapis.com" API when it
+                # is not enabled:
+                #
+                #     { "reason": "API_DISABLED"
+                #       "domain": "googleapis.com"
+                #       "metadata": {
+                #         "resource": "projects/123",
+                #         "service": "pubsub.googleapis.com"
+                #       }
+                #     }
+                #
+                # This response indicates that the pubsub.googleapis.com API is not enabled.
+                #
+                # Example of an error that is returned when attempting to create a Spanner
+                # instance in a region that is out of stock:
+                #
+                #     { "reason": "STOCKOUT"
+                #       "domain": "spanner.googleapis.com",
+                #       "metadata": {
+                #         "availableRegions": "us-central1,us-east2"
+                #       }
+                #     }
+              "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain
+                  # is typically the registered service name of the tool or product that
+                  # generates the error. Example: "pubsub.googleapis.com". If the error is
+                  # generated by some common infrastructure, the error domain must be a
+                  # globally unique value that identifies the infrastructure. For Google API
+                  # infrastructure, the error domain is "googleapis.com".
+              "metadatas": { # Additional structured details about this error.
+                  #
+                  # Keys must match a regular expression of `a-z+` but should
+                  # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
+                  # length. When identifying the current value of an exceeded limit, the units
+                  # should be contained in the key, not the value.  For example, rather than
+                  # `{"instanceLimit": "100/request"}`, should be returned as,
+                  # `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of
+                  # instances that can be created in a single (batch) request.
+                "a_key": "A String",
+              },
+              "reason": "A String", # The reason of the error. This is a constant value that identifies the
+                  # proximate cause of the error. Error reasons are unique within a particular
+                  # domain of errors. This should be at most 63 characters and match a
+                  # regular expression of `A-Z+[A-Z0-9]`, which represents
+                  # UPPER_SNAKE_CASE.
+            },
+            "help": { # Provides links to documentation or for performing an out of band action.
+                #
+                # For example, if a quota check failed with an error indicating the calling
+                # project hasn't enabled the accessed service, this can contain a URL pointing
+                # directly to the right place in the developer console to flip the bit.
+              "links": [ # URL(s) pointing to additional information on handling the current error.
+                { # Describes a URL link.
+                  "description": "A String", # Describes what the link offers.
+                  "url": "A String", # The URL of the link.
+                },
+              ],
+            },
+            "localizedMessage": { # Provides a localized error message that is safe to return to the user
+                # which can be attached to an RPC error.
+              "locale": "A String", # The locale used following the specification defined at
+                  # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
+                  # Examples are: "en-US", "fr-CH", "es-MX"
+              "message": "A String", # The localized error message in the above locale.
+            },
+            "quotaInfo": { # Additional details for quota exceeded error for resource quota.
+              "dimensions": { # The map holding related quota dimensions.
+                "a_key": "A String",
+              },
+              "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota
+                  #  type or metric.
+              "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type
+                  # or metric.
+              "limitName": "A String", # The name of the quota limit.
+              "metricName": "A String", # The Compute Engine quota metric name.
+              "rolloutStatus": "A String", # Rollout status of the future quota limit.
+            },
+          },
+        ],
+        "location": "A String", # [Output Only] Indicates the field in the request that caused the error.
+            # This property is optional.
+        "message": "A String", # [Output Only] An optional, human-readable error message.
+      },
+    ],
+  },
+  "getVersionOperationMetadata": {
+    "inlineSbomInfo": {
+      "currentComponentVersions": { # A mapping of components to their currently-applied versions or other
+          # appropriate identifiers.
+        "a_key": "A String",
+      },
+      "targetComponentVersions": { # A mapping of components to their target versions or other appropriate
+          # identifiers.
+        "a_key": "A String",
+      },
+    },
+  },
+  "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
+      # message that was returned, such as `NOT FOUND`.
+  "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
+      # status code that was returned. For example, a `404` means the
+      # resource was not found.
+  "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is
+      # defined by the server.
+  "insertTime": "A String", # [Output Only] The time that this operation was requested.
+      # This value is inRFC3339
+      # text format.
+  "instancesBulkInsertOperationMetadata": {
+    "perLocationStatus": { # Status information per location (location name is key).
+        # Example key: zones/us-central1-a
+      "a_key": {
+        "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far.
+        "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback.
+        "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an
+            # error.
+        "status": "A String", # [Output Only] Creation status of BulkInsert operation - information
+            # if the flow is rolling forward or rolling back.
+        "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created.
+      },
+    },
+  },
+  "kind": "compute#operation", # Output only. [Output Only] Type of the resource. Always `compute#operation` for
+      # Operation resources.
+  "name": "A String", # [Output Only] Name of the operation.
+  "operationGroupId": "A String", # Output only. [Output Only] An ID that represents a group of operations, such as when a
+      # group of operations results from a `bulkInsert` API request.
+  "operationType": "A String", # [Output Only] The type of operation, such as `insert`,
+      # `update`, or `delete`, and so on.
+  "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
+      # There is no requirement that this be linear or support any granularity of
+      # operations. This should not be used to guess when the operation will be
+      # complete. This number should monotonically increase as the operation
+      # progresses.
+  "region": "A String", # [Output Only] The URL of the region where the operation resides. Only
+      # applicable when performing regional operations.
+  "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+  "setCommonInstanceMetadataOperationMetadata": { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
+      # this field will contain information on all underlying zonal actions and
+      # their state.
+    "clientOperationId": "A String", # [Output Only] The client operation id.
+    "perLocationOperations": { # [Output Only] Status information per location (location name is key).
+        # Example key: zones/us-central1-a
+      "a_key": {
+        "error": { # The `Status` type defines a logical error model that is suitable for # [Output Only] If state is `ABANDONED` or `FAILED`, this field is
+            # populated.
+            # different programming environments, including REST APIs and RPC APIs. It is
+            # used by [gRPC](https://github.com/grpc). Each `Status` message contains
+            # three pieces of data: error code, error message, and error details.
+            #
+            # You can find out more about this error model and how to work with it in the
+            # [API Design Guide](https://cloud.google.com/apis/design/errors).
+          "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+          "details": [ # A list of messages that carry the error details.  There is a common set of
+              # message types for APIs to use.
+            {
+              "a_key": "", # Properties of the object. Contains field @type with type URL.
+            },
+          ],
+          "message": "A String", # A developer-facing error message, which should be in English. Any
+              # user-facing error message should be localized and sent in the
+              # google.rpc.Status.details field, or localized by the client.
+        },
+        "state": "A String", # [Output Only] Status of the action, which can be one of the following:
+            # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
+      },
+    },
+  },
+  "startTime": "A String", # [Output Only] The time that this operation was started by the server.
+      # This value is inRFC3339
+      # text format.
+  "status": "A String", # [Output Only] The status of the operation, which can be one of the
+      # following:
+      # `PENDING`, `RUNNING`, or `DONE`.
+  "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the
+      # operation.
+  "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation
+      # of the target resource.
+  "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For
+      # operations related to creating a snapshot, this points to the disk
+      # that the snapshot was created from.
+  "user": "A String", # [Output Only] User who requested the operation, for example:
+      # `user@example.com` or
+      # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
+  "warnings": [ # [Output Only] If warning messages are generated during processing of the
+      # operation, this field will be populated.
+    {
+      "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute
+          # Engine returns NO_RESULTS_ON_PAGE if there
+          # are no results in the response.
+      "data": [ # [Output Only] Metadata about this warning in key:
+          # value format. For example:
+          #
+          # "data": [
+          #   {
+          #    "key": "scope",
+          #    "value": "zones/us-east1-d"
+          #   }
+        {
+          "key": "A String", # [Output Only] A key that provides more detail on the warning being
+              # returned. For example, for warnings where there are no results in a list
+              # request for a particular zone, this key might be scope and
+              # the key value might be the zone name. Other examples might be a key
+              # indicating a deprecated resource and a suggested replacement, or a
+              # warning about invalid network settings (for example, if an instance
+              # attempts to perform IP forwarding but is not enabled for IP forwarding).
+          "value": "A String", # [Output Only] A warning data value corresponding to the key.
+        },
+      ],
+      "message": "A String", # [Output Only] A human-readable description of the warning code.
+    },
+  ],
+  "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only
+      # applicable when performing per-zone operations.
+}
+
+ +
+ get(organization, rolloutPlan, x__xgafv=None) +
Gets details of a single organization-scoped RolloutPlan.
+
+Args:
+  organization: string, Organization ID for this request. (required)
+  rolloutPlan: string, Name of the persistent rollout plan to return. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # RolloutPlan resource.
+    #
+    # A RolloutPlan is the customer-defined strategy to divide a large-scale change
+    # into smaller increments, referred to as "waves". Each wave targets a specific
+    # portion of the overall affected area and defines criteria that must be met
+    # before progressing to the subsequent wave.
+  "creationTimestamp": "A String", # Output only. [Output Only] Creation timestamp inRFC3339
+      # text format.
+  "description": "A String", # An optional description of this resource. Provide this property when you
+      # create the resource.
+  "id": "A String", # Output only. [Output Only] The unique identifier for the resource. This identifier is
+      # defined by the server.
+  "kind": "compute#rolloutPlan", # Output only. [Output Only] Type of the resource. Always compute#rolloutPlan
+      # for rolloutPlans.
+  "locationScope": "A String", # The location scope of the rollout plan. If not specified, the location
+      # scope is considered as ZONAL.
+  "name": "A String", # Name of the resource. Provided by the client when the resource is created.
+      # The name must be 1-63 characters long, and comply withRFC1035.
+      # Specifically, the name must be 1-63 characters long and match the regular
+      # expression `[a-z]([-a-z0-9]*[a-z0-9])?`
+      # which means the first character must be a lowercase letter, and all
+      # following characters must be a dash, lowercase letter, or digit, except
+      # the last character, which cannot be a dash.
+  "selfLink": "A String", # Output only. [Output Only] Server-defined fully-qualified URL for this resource.
+  "selfLinkWithId": "A String", # Output only. [Output Only] Server-defined URL for this resource's resource id.
+  "waves": [ # Required. The waves included in this rollout plan.
+    { # A single wave in a rollout plan.
+      "displayName": "A String", # Optional. The display name of this wave of the rollout plan.
+      "number": "A String", # Output only. The wave number.
+      "orchestrationOptions": { # Options to control the pace of orchestration of a wave. These options are # Optional. The orchestration options for this wave.
+          # required only if the resource being rolled out follows the Orchestrated
+          # pattern.
+        "delays": [ # Optional. Delays, if any, to be added between batches of projects. We allow
+            # multiple Delays to be specified, letting users set separate delays
+            # between batches of projects corresponding to different locations and
+            # batches of projects corresponding to the same location.
+          { # Options to control the delay, if any, between batches of projects.
+            "delimiter": "A String", # Optional. Controls whether the delay should only be added between batches of
+                # projects corresponding to different locations, or also between
+                # batches of projects corresponding to the same location.
+                #
+                # Must be set to DELIMITER_UNSPECIFIED if no delay is to be added.
+            "duration": "A String", # Optional. The duration of the delay, if any, to be added between batches of
+                # projects. A zero duration corresponds to no delay.
+            "type": "A String", # Optional. Controls whether the specified duration is to be added at the end of
+                # each batch, or if the total processing time for each batch will be
+                # padded if needed to meet the specified duration.
+                #
+                # Must be set to TYPE_UNSPECIFIED if no delay is to be added.
+          },
+        ],
+        "maxConcurrentLocations": "A String", # Optional. Maximum number of locations to be orchestrated in parallel.
+        "maxConcurrentResourcesPerLocation": "A String", # Optional. Maximum number of resources to be orchestrated per location in
+            # parallel.
+      },
+      "selectors": [ # Required. The selectors for this wave. There is a logical AND between each selector
+          # defined in a wave, so a resource must satisfy the criteria of *all* the
+          # specified selectors to be in scope for the wave.
+        { # A selector which specifies what resource(s) are included in a given wave.
+          "locationSelector": { # Roll out to resources by location. # Optional. Roll out to resources by Cloud locations.
+            "includedLocations": [ # Optional. Example: "us-central1-a"
+              "A String",
+            ],
+          },
+          "resourceHierarchySelector": { # Roll out to resources by Cloud Resource Manager resource hierarchy # Optional. Roll out to resources by Cloud Resource Manager resource hierarchy.
+              # nodes such as projects, folders, orgs.
+            "includedFolders": [ # Optional. Format: "folders/{folder_id}"
+              "A String",
+            ],
+            "includedOrganizations": [ # Optional. Format: "organizations/{organization_id}"
+              "A String",
+            ],
+            "includedProjects": [ # Optional. Format: "projects/{project_id}"
+              "A String",
+            ],
+          },
+        },
+      ],
+      "validation": { # The validation to be performed before progressing to the next wave. # Required. The validation to be performed at the end of this wave.
+        "timeBasedValidationMetadata": { # Metadata required if type = "time". # Optional. Metadata required if type = "time".
+          "waitDuration": "A String", # Optional. The duration that the system waits in between waves. This wait starts
+              # after all changes in the wave are rolled out.
+        },
+        "type": "A String", # Required. The type of the validation. If a type of validation is associated with
+            # a metadata object, the appropriate metadata field mapping to the
+            # validation type must be provided in the validation message. Possible
+            # values are in quotes below alongside an explanation:
+            #   "manual": The system waits for an end-user approval API before
+            #     progressing to the next wave.
+            #   "time": The system waits for a user specified duration before
+            #     progressing to the next wave. TimeBasedValidation must be provided.
+      },
+    },
+  ],
+}
+
+ +
+ insert(organization, body=None, requestId=None, x__xgafv=None) +
Creates a new RolloutPlan in a given organization and location.
+
+Args:
+  organization: string, Organization ID for this request. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # RolloutPlan resource.
+    # 
+    # A RolloutPlan is the customer-defined strategy to divide a large-scale change
+    # into smaller increments, referred to as "waves". Each wave targets a specific
+    # portion of the overall affected area and defines criteria that must be met
+    # before progressing to the subsequent wave.
+  "creationTimestamp": "A String", # Output only. [Output Only] Creation timestamp inRFC3339
+      # text format.
+  "description": "A String", # An optional description of this resource. Provide this property when you
+      # create the resource.
+  "id": "A String", # Output only. [Output Only] The unique identifier for the resource. This identifier is
+      # defined by the server.
+  "kind": "compute#rolloutPlan", # Output only. [Output Only] Type of the resource. Always compute#rolloutPlan
+      # for rolloutPlans.
+  "locationScope": "A String", # The location scope of the rollout plan. If not specified, the location
+      # scope is considered as ZONAL.
+  "name": "A String", # Name of the resource. Provided by the client when the resource is created.
+      # The name must be 1-63 characters long, and comply withRFC1035.
+      # Specifically, the name must be 1-63 characters long and match the regular
+      # expression `[a-z]([-a-z0-9]*[a-z0-9])?`
+      # which means the first character must be a lowercase letter, and all
+      # following characters must be a dash, lowercase letter, or digit, except
+      # the last character, which cannot be a dash.
+  "selfLink": "A String", # Output only. [Output Only] Server-defined fully-qualified URL for this resource.
+  "selfLinkWithId": "A String", # Output only. [Output Only] Server-defined URL for this resource's resource id.
+  "waves": [ # Required. The waves included in this rollout plan.
+    { # A single wave in a rollout plan.
+      "displayName": "A String", # Optional. The display name of this wave of the rollout plan.
+      "number": "A String", # Output only. The wave number.
+      "orchestrationOptions": { # Options to control the pace of orchestration of a wave. These options are # Optional. The orchestration options for this wave.
+          # required only if the resource being rolled out follows the Orchestrated
+          # pattern.
+        "delays": [ # Optional. Delays, if any, to be added between batches of projects. We allow
+            # multiple Delays to be specified, letting users set separate delays
+            # between batches of projects corresponding to different locations and
+            # batches of projects corresponding to the same location.
+          { # Options to control the delay, if any, between batches of projects.
+            "delimiter": "A String", # Optional. Controls whether the delay should only be added between batches of
+                # projects corresponding to different locations, or also between
+                # batches of projects corresponding to the same location.
+                #
+                # Must be set to DELIMITER_UNSPECIFIED if no delay is to be added.
+            "duration": "A String", # Optional. The duration of the delay, if any, to be added between batches of
+                # projects. A zero duration corresponds to no delay.
+            "type": "A String", # Optional. Controls whether the specified duration is to be added at the end of
+                # each batch, or if the total processing time for each batch will be
+                # padded if needed to meet the specified duration.
+                #
+                # Must be set to TYPE_UNSPECIFIED if no delay is to be added.
+          },
+        ],
+        "maxConcurrentLocations": "A String", # Optional. Maximum number of locations to be orchestrated in parallel.
+        "maxConcurrentResourcesPerLocation": "A String", # Optional. Maximum number of resources to be orchestrated per location in
+            # parallel.
+      },
+      "selectors": [ # Required. The selectors for this wave. There is a logical AND between each selector
+          # defined in a wave, so a resource must satisfy the criteria of *all* the
+          # specified selectors to be in scope for the wave.
+        { # A selector which specifies what resource(s) are included in a given wave.
+          "locationSelector": { # Roll out to resources by location. # Optional. Roll out to resources by Cloud locations.
+            "includedLocations": [ # Optional. Example: "us-central1-a"
+              "A String",
+            ],
+          },
+          "resourceHierarchySelector": { # Roll out to resources by Cloud Resource Manager resource hierarchy # Optional. Roll out to resources by Cloud Resource Manager resource hierarchy.
+              # nodes such as projects, folders, orgs.
+            "includedFolders": [ # Optional. Format: "folders/{folder_id}"
+              "A String",
+            ],
+            "includedOrganizations": [ # Optional. Format: "organizations/{organization_id}"
+              "A String",
+            ],
+            "includedProjects": [ # Optional. Format: "projects/{project_id}"
+              "A String",
+            ],
+          },
+        },
+      ],
+      "validation": { # The validation to be performed before progressing to the next wave. # Required. The validation to be performed at the end of this wave.
+        "timeBasedValidationMetadata": { # Metadata required if type = "time". # Optional. Metadata required if type = "time".
+          "waitDuration": "A String", # Optional. The duration that the system waits in between waves. This wait starts
+              # after all changes in the wave are rolled out.
+        },
+        "type": "A String", # Required. The type of the validation. If a type of validation is associated with
+            # a metadata object, the appropriate metadata field mapping to the
+            # validation type must be provided in the validation message. Possible
+            # values are in quotes below alongside an explanation:
+            #   "manual": The system waits for an end-user approval API before
+            #     progressing to the next wave.
+            #   "time": The system waits for a user specified duration before
+            #     progressing to the next wave. TimeBasedValidation must be provided.
+      },
+    },
+  ],
+}
+
+  requestId: string, An optional request ID to identify requests. Specify a unique request ID so
+that if you must retry your request, the server will know to ignore the
+request if it has already been completed.
+
+For example, consider a situation where you make an initial request and
+the request times out. If you make the request again with the same
+request ID, the server can check if original operation with the same
+request ID was received, and if so, will ignore the second request. This
+prevents clients from accidentally creating duplicate commitments.
+
+The request ID must be
+a valid UUID with the exception that zero UUID is not supported
+(00000000-0000-0000-0000-000000000000).
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Represents an Operation resource.
+    #
+    # Google Compute Engine has three Operation resources:
+    #
+    # * [Global](/compute/docs/reference/rest/beta/globalOperations)
+    # * [Regional](/compute/docs/reference/rest/beta/regionOperations)
+    # * [Zonal](/compute/docs/reference/rest/beta/zoneOperations)
+    #
+    # You can use an operation resource to manage asynchronous API requests.
+    # For more information, readHandling
+    # API responses.
+    #
+    # Operations can be global, regional or zonal.
+    #
+    #    - For global operations, use the `globalOperations`
+    #    resource.
+    #    - For regional operations, use the
+    #    `regionOperations` resource.
+    #    - For zonal operations, use
+    #    the `zoneOperations` resource.
+    #
+    #
+    #
+    # For more information, read
+    # Global, Regional, and Zonal Resources.
+    #
+    # Note that completed Operation resources have a limited
+    # retention period.
+  "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request.
+      # Not present otherwise.
+  "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
+  "description": "A String", # [Output Only] A textual description of the operation, which is
+      # set when the operation is created.
+  "endTime": "A String", # [Output Only] The time that this operation was completed. This value is inRFC3339
+      # text format.
+  "error": { # [Output Only] If errors are generated during processing of the operation,
+      # this field will be populated.
+    "errors": [ # [Output Only] The array of errors encountered while processing this
+        # operation.
+      {
+        "code": "A String", # [Output Only] The error type identifier for this error.
+        "errorDetails": [ # [Output Only] An optional list of messages that contain the error
+            # details. There is a set of defined message types to use for providing
+            # details.The syntax depends on the error code. For example,
+            # QuotaExceededInfo will have details when the error code is
+            # QUOTA_EXCEEDED.
+          {
+            "errorInfo": { # Describes the cause of the error with structured details.
+                #
+                # Example of an error when contacting the "pubsub.googleapis.com" API when it
+                # is not enabled:
+                #
+                #     { "reason": "API_DISABLED"
+                #       "domain": "googleapis.com"
+                #       "metadata": {
+                #         "resource": "projects/123",
+                #         "service": "pubsub.googleapis.com"
+                #       }
+                #     }
+                #
+                # This response indicates that the pubsub.googleapis.com API is not enabled.
+                #
+                # Example of an error that is returned when attempting to create a Spanner
+                # instance in a region that is out of stock:
+                #
+                #     { "reason": "STOCKOUT"
+                #       "domain": "spanner.googleapis.com",
+                #       "metadata": {
+                #         "availableRegions": "us-central1,us-east2"
+                #       }
+                #     }
+              "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain
+                  # is typically the registered service name of the tool or product that
+                  # generates the error. Example: "pubsub.googleapis.com". If the error is
+                  # generated by some common infrastructure, the error domain must be a
+                  # globally unique value that identifies the infrastructure. For Google API
+                  # infrastructure, the error domain is "googleapis.com".
+              "metadatas": { # Additional structured details about this error.
+                  #
+                  # Keys must match a regular expression of `a-z+` but should
+                  # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
+                  # length. When identifying the current value of an exceeded limit, the units
+                  # should be contained in the key, not the value.  For example, rather than
+                  # `{"instanceLimit": "100/request"}`, should be returned as,
+                  # `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of
+                  # instances that can be created in a single (batch) request.
+                "a_key": "A String",
+              },
+              "reason": "A String", # The reason of the error. This is a constant value that identifies the
+                  # proximate cause of the error. Error reasons are unique within a particular
+                  # domain of errors. This should be at most 63 characters and match a
+                  # regular expression of `A-Z+[A-Z0-9]`, which represents
+                  # UPPER_SNAKE_CASE.
+            },
+            "help": { # Provides links to documentation or for performing an out of band action.
+                #
+                # For example, if a quota check failed with an error indicating the calling
+                # project hasn't enabled the accessed service, this can contain a URL pointing
+                # directly to the right place in the developer console to flip the bit.
+              "links": [ # URL(s) pointing to additional information on handling the current error.
+                { # Describes a URL link.
+                  "description": "A String", # Describes what the link offers.
+                  "url": "A String", # The URL of the link.
+                },
+              ],
+            },
+            "localizedMessage": { # Provides a localized error message that is safe to return to the user
+                # which can be attached to an RPC error.
+              "locale": "A String", # The locale used following the specification defined at
+                  # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
+                  # Examples are: "en-US", "fr-CH", "es-MX"
+              "message": "A String", # The localized error message in the above locale.
+            },
+            "quotaInfo": { # Additional details for quota exceeded error for resource quota.
+              "dimensions": { # The map holding related quota dimensions.
+                "a_key": "A String",
+              },
+              "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota
+                  #  type or metric.
+              "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type
+                  # or metric.
+              "limitName": "A String", # The name of the quota limit.
+              "metricName": "A String", # The Compute Engine quota metric name.
+              "rolloutStatus": "A String", # Rollout status of the future quota limit.
+            },
+          },
+        ],
+        "location": "A String", # [Output Only] Indicates the field in the request that caused the error.
+            # This property is optional.
+        "message": "A String", # [Output Only] An optional, human-readable error message.
+      },
+    ],
+  },
+  "getVersionOperationMetadata": {
+    "inlineSbomInfo": {
+      "currentComponentVersions": { # A mapping of components to their currently-applied versions or other
+          # appropriate identifiers.
+        "a_key": "A String",
+      },
+      "targetComponentVersions": { # A mapping of components to their target versions or other appropriate
+          # identifiers.
+        "a_key": "A String",
+      },
+    },
+  },
+  "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
+      # message that was returned, such as `NOT FOUND`.
+  "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
+      # status code that was returned. For example, a `404` means the
+      # resource was not found.
+  "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is
+      # defined by the server.
+  "insertTime": "A String", # [Output Only] The time that this operation was requested.
+      # This value is inRFC3339
+      # text format.
+  "instancesBulkInsertOperationMetadata": {
+    "perLocationStatus": { # Status information per location (location name is key).
+        # Example key: zones/us-central1-a
+      "a_key": {
+        "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far.
+        "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback.
+        "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an
+            # error.
+        "status": "A String", # [Output Only] Creation status of BulkInsert operation - information
+            # if the flow is rolling forward or rolling back.
+        "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created.
+      },
+    },
+  },
+  "kind": "compute#operation", # Output only. [Output Only] Type of the resource. Always `compute#operation` for
+      # Operation resources.
+  "name": "A String", # [Output Only] Name of the operation.
+  "operationGroupId": "A String", # Output only. [Output Only] An ID that represents a group of operations, such as when a
+      # group of operations results from a `bulkInsert` API request.
+  "operationType": "A String", # [Output Only] The type of operation, such as `insert`,
+      # `update`, or `delete`, and so on.
+  "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
+      # There is no requirement that this be linear or support any granularity of
+      # operations. This should not be used to guess when the operation will be
+      # complete. This number should monotonically increase as the operation
+      # progresses.
+  "region": "A String", # [Output Only] The URL of the region where the operation resides. Only
+      # applicable when performing regional operations.
+  "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+  "setCommonInstanceMetadataOperationMetadata": { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
+      # this field will contain information on all underlying zonal actions and
+      # their state.
+    "clientOperationId": "A String", # [Output Only] The client operation id.
+    "perLocationOperations": { # [Output Only] Status information per location (location name is key).
+        # Example key: zones/us-central1-a
+      "a_key": {
+        "error": { # The `Status` type defines a logical error model that is suitable for # [Output Only] If state is `ABANDONED` or `FAILED`, this field is
+            # populated.
+            # different programming environments, including REST APIs and RPC APIs. It is
+            # used by [gRPC](https://github.com/grpc). Each `Status` message contains
+            # three pieces of data: error code, error message, and error details.
+            #
+            # You can find out more about this error model and how to work with it in the
+            # [API Design Guide](https://cloud.google.com/apis/design/errors).
+          "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+          "details": [ # A list of messages that carry the error details.  There is a common set of
+              # message types for APIs to use.
+            {
+              "a_key": "", # Properties of the object. Contains field @type with type URL.
+            },
+          ],
+          "message": "A String", # A developer-facing error message, which should be in English. Any
+              # user-facing error message should be localized and sent in the
+              # google.rpc.Status.details field, or localized by the client.
+        },
+        "state": "A String", # [Output Only] Status of the action, which can be one of the following:
+            # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
+      },
+    },
+  },
+  "startTime": "A String", # [Output Only] The time that this operation was started by the server.
+      # This value is inRFC3339
+      # text format.
+  "status": "A String", # [Output Only] The status of the operation, which can be one of the
+      # following:
+      # `PENDING`, `RUNNING`, or `DONE`.
+  "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the
+      # operation.
+  "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation
+      # of the target resource.
+  "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For
+      # operations related to creating a snapshot, this points to the disk
+      # that the snapshot was created from.
+  "user": "A String", # [Output Only] User who requested the operation, for example:
+      # `user@example.com` or
+      # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
+  "warnings": [ # [Output Only] If warning messages are generated during processing of the
+      # operation, this field will be populated.
+    {
+      "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute
+          # Engine returns NO_RESULTS_ON_PAGE if there
+          # are no results in the response.
+      "data": [ # [Output Only] Metadata about this warning in key:
+          # value format. For example:
+          #
+          # "data": [
+          #   {
+          #    "key": "scope",
+          #    "value": "zones/us-east1-d"
+          #   }
+        {
+          "key": "A String", # [Output Only] A key that provides more detail on the warning being
+              # returned. For example, for warnings where there are no results in a list
+              # request for a particular zone, this key might be scope and
+              # the key value might be the zone name. Other examples might be a key
+              # indicating a deprecated resource and a suggested replacement, or a
+              # warning about invalid network settings (for example, if an instance
+              # attempts to perform IP forwarding but is not enabled for IP forwarding).
+          "value": "A String", # [Output Only] A warning data value corresponding to the key.
+        },
+      ],
+      "message": "A String", # [Output Only] A human-readable description of the warning code.
+    },
+  ],
+  "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only
+      # applicable when performing per-zone operations.
+}
+
+ +
+ list(organization, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None) +
Lists OrganizationRolloutPlans in a given organization and location.
+
+Args:
+  organization: string, Organization ID for this request. (required)
+  filter: string, A filter expression that filters resources listed in the response. Most
+Compute resources support two types of filter expressions:
+expressions that support regular expressions and expressions that follow
+API improvement proposal AIP-160.
+These two types of filter expressions cannot be mixed in one request.
+
+If you want to use AIP-160, your expression must specify the field name, an
+operator, and the value that you want to use for filtering. The value
+must be a string, a number, or a boolean. The operator
+must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.
+
+For example, if you are filtering Compute Engine instances, you can
+exclude instances named `example-instance` by specifying
+`name != example-instance`.
+
+The `:*` comparison can be used to test whether a key has been defined.
+For example, to find all objects with `owner` label use:
+```
+labels.owner:*
+```
+
+You can also filter nested fields. For example, you could specify
+`scheduling.automaticRestart = false` to include instances only
+if they are not scheduled for automatic restarts. You can use filtering
+on nested fields to filter based onresource labels.
+
+To filter on multiple expressions, provide each separate expression within
+parentheses. For example:
+```
+(scheduling.automaticRestart = true)
+(cpuPlatform = "Intel Skylake")
+```
+By default, each expression is an `AND` expression. However, you
+can include `AND` and `OR` expressions explicitly.
+For example:
+```
+(cpuPlatform = "Intel Skylake") OR
+(cpuPlatform = "Intel Broadwell") AND
+(scheduling.automaticRestart = true)
+```
+
+If you want to use a regular expression, use the `eq` (equal) or `ne`
+(not equal) operator against a single un-parenthesized expression with or
+without quotes or against multiple parenthesized expressions. Examples:
+
+`fieldname eq unquoted literal`
+`fieldname eq 'single quoted literal'`
+`fieldname eq "double quoted literal"`
+`(fieldname1 eq literal) (fieldname2 ne "literal")`
+
+The literal value is interpreted as a regular expression using GoogleRE2 library syntax.
+The literal value must match the entire field.
+
+For example, to filter for instances that do not end with name "instance",
+you would use `name ne .*instance`.
+
+You cannot combine constraints on multiple fields using regular
+expressions.
+  maxResults: integer, The maximum number of results per page that should be returned.
+If the number of available results is larger than `maxResults`,
+Compute Engine returns a `nextPageToken` that can be used to get
+the next page of results in subsequent list requests. Acceptable values are
+`0` to `500`, inclusive. (Default: `500`)
+  orderBy: string, Sorts list results by a certain order. By default, results
+are returned in alphanumerical order based on the resource name.
+
+You can also sort results in descending order based on the creation
+timestamp using `orderBy="creationTimestamp desc"`. This sorts
+results based on the `creationTimestamp` field in
+reverse chronological order (newest result first). Use this to sort
+resources like operations so that the newest operation is returned first.
+
+Currently, only sorting by `name` or
+`creationTimestamp desc` is supported.
+  pageToken: string, Specifies a page token to use. Set `pageToken` to the
+`nextPageToken` returned by a previous list request to get
+the next page of results.
+  returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case
+of failure. The default value is false.
+
+For example, when partial success behavior is enabled, aggregatedList for a
+single zone scope either returns all resources in the zone or no resources,
+with an error code.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Contains a list of RolloutPlan resources.
+  "etag": "A String",
+  "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
+  "items": [ # A list of RolloutPlan resources.
+    { # RolloutPlan resource.
+        #
+        # A RolloutPlan is the customer-defined strategy to divide a large-scale change
+        # into smaller increments, referred to as "waves". Each wave targets a specific
+        # portion of the overall affected area and defines criteria that must be met
+        # before progressing to the subsequent wave.
+      "creationTimestamp": "A String", # Output only. [Output Only] Creation timestamp inRFC3339
+          # text format.
+      "description": "A String", # An optional description of this resource. Provide this property when you
+          # create the resource.
+      "id": "A String", # Output only. [Output Only] The unique identifier for the resource. This identifier is
+          # defined by the server.
+      "kind": "compute#rolloutPlan", # Output only. [Output Only] Type of the resource. Always compute#rolloutPlan
+          # for rolloutPlans.
+      "locationScope": "A String", # The location scope of the rollout plan. If not specified, the location
+          # scope is considered as ZONAL.
+      "name": "A String", # Name of the resource. Provided by the client when the resource is created.
+          # The name must be 1-63 characters long, and comply withRFC1035.
+          # Specifically, the name must be 1-63 characters long and match the regular
+          # expression `[a-z]([-a-z0-9]*[a-z0-9])?`
+          # which means the first character must be a lowercase letter, and all
+          # following characters must be a dash, lowercase letter, or digit, except
+          # the last character, which cannot be a dash.
+      "selfLink": "A String", # Output only. [Output Only] Server-defined fully-qualified URL for this resource.
+      "selfLinkWithId": "A String", # Output only. [Output Only] Server-defined URL for this resource's resource id.
+      "waves": [ # Required. The waves included in this rollout plan.
+        { # A single wave in a rollout plan.
+          "displayName": "A String", # Optional. The display name of this wave of the rollout plan.
+          "number": "A String", # Output only. The wave number.
+          "orchestrationOptions": { # Options to control the pace of orchestration of a wave. These options are # Optional. The orchestration options for this wave.
+              # required only if the resource being rolled out follows the Orchestrated
+              # pattern.
+            "delays": [ # Optional. Delays, if any, to be added between batches of projects. We allow
+                # multiple Delays to be specified, letting users set separate delays
+                # between batches of projects corresponding to different locations and
+                # batches of projects corresponding to the same location.
+              { # Options to control the delay, if any, between batches of projects.
+                "delimiter": "A String", # Optional. Controls whether the delay should only be added between batches of
+                    # projects corresponding to different locations, or also between
+                    # batches of projects corresponding to the same location.
+                    #
+                    # Must be set to DELIMITER_UNSPECIFIED if no delay is to be added.
+                "duration": "A String", # Optional. The duration of the delay, if any, to be added between batches of
+                    # projects. A zero duration corresponds to no delay.
+                "type": "A String", # Optional. Controls whether the specified duration is to be added at the end of
+                    # each batch, or if the total processing time for each batch will be
+                    # padded if needed to meet the specified duration.
+                    #
+                    # Must be set to TYPE_UNSPECIFIED if no delay is to be added.
+              },
+            ],
+            "maxConcurrentLocations": "A String", # Optional. Maximum number of locations to be orchestrated in parallel.
+            "maxConcurrentResourcesPerLocation": "A String", # Optional. Maximum number of resources to be orchestrated per location in
+                # parallel.
+          },
+          "selectors": [ # Required. The selectors for this wave. There is a logical AND between each selector
+              # defined in a wave, so a resource must satisfy the criteria of *all* the
+              # specified selectors to be in scope for the wave.
+            { # A selector which specifies what resource(s) are included in a given wave.
+              "locationSelector": { # Roll out to resources by location. # Optional. Roll out to resources by Cloud locations.
+                "includedLocations": [ # Optional. Example: "us-central1-a"
+                  "A String",
+                ],
+              },
+              "resourceHierarchySelector": { # Roll out to resources by Cloud Resource Manager resource hierarchy # Optional. Roll out to resources by Cloud Resource Manager resource hierarchy.
+                  # nodes such as projects, folders, orgs.
+                "includedFolders": [ # Optional. Format: "folders/{folder_id}"
+                  "A String",
+                ],
+                "includedOrganizations": [ # Optional. Format: "organizations/{organization_id}"
+                  "A String",
+                ],
+                "includedProjects": [ # Optional. Format: "projects/{project_id}"
+                  "A String",
+                ],
+              },
+            },
+          ],
+          "validation": { # The validation to be performed before progressing to the next wave. # Required. The validation to be performed at the end of this wave.
+            "timeBasedValidationMetadata": { # Metadata required if type = "time". # Optional. Metadata required if type = "time".
+              "waitDuration": "A String", # Optional. The duration that the system waits in between waves. This wait starts
+                  # after all changes in the wave are rolled out.
+            },
+            "type": "A String", # Required. The type of the validation. If a type of validation is associated with
+                # a metadata object, the appropriate metadata field mapping to the
+                # validation type must be provided in the validation message. Possible
+                # values are in quotes below alongside an explanation:
+                #   "manual": The system waits for an end-user approval API before
+                #     progressing to the next wave.
+                #   "time": The system waits for a user specified duration before
+                #     progressing to the next wave. TimeBasedValidation must be provided.
+          },
+        },
+      ],
+    },
+  ],
+  "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for
+      # list requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for
+      # the query parameter pageToken in the next list request.
+      # Subsequent list requests will have their own nextPageToken to
+      # continue paging through the results.
+  "selfLink": "A String", # Output only. [Output Only] Server-defined URL for this resource.
+  "unreachables": [ # Output only. [Output Only] Unreachable resources.
+      # end_interface: MixerListResponseWithEtagBuilder
+    "A String",
+  ],
+  "warning": { # [Output Only] Informational warning message.
+    "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute
+        # Engine returns NO_RESULTS_ON_PAGE if there
+        # are no results in the response.
+    "data": [ # [Output Only] Metadata about this warning in key:
+        # value format. For example:
+        #
+        # "data": [
+        #   {
+        #    "key": "scope",
+        #    "value": "zones/us-east1-d"
+        #   }
+      {
+        "key": "A String", # [Output Only] A key that provides more detail on the warning being
+            # returned. For example, for warnings where there are no results in a list
+            # request for a particular zone, this key might be scope and
+            # the key value might be the zone name. Other examples might be a key
+            # indicating a deprecated resource and a suggested replacement, or a
+            # warning about invalid network settings (for example, if an instance
+            # attempts to perform IP forwarding but is not enabled for IP forwarding).
+        "value": "A String", # [Output Only] A warning data value corresponding to the key.
+      },
+    ],
+    "message": "A String", # [Output Only] A human-readable description of the warning code.
+  },
+}
+
+ +
+ list_next() +
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+        
+
+ + \ No newline at end of file diff --git a/docs/dyn/compute_beta.organizationRollouts.html b/docs/dyn/compute_beta.organizationRollouts.html new file mode 100644 index 0000000000..f5d3319efd --- /dev/null +++ b/docs/dyn/compute_beta.organizationRollouts.html @@ -0,0 +1,1922 @@ + + + +

Compute Engine API . organizationRollouts

+

Instance Methods

+

+ advance(organization, rollout, currentWaveNumber=None, requestId=None, x__xgafv=None)

+

Advances a Rollout to the next wave, or completes it if no waves remain.

+

+ cancel(organization, rollout, requestId=None, rollback=None, x__xgafv=None)

+

Cancels a Rollout.

+

+ close()

+

Close httplib2 connections.

+

+ delete(organization, rollout, requestId=None, x__xgafv=None)

+

Deletes a Rollout.

+

+ get(organization, rollout, x__xgafv=None)

+

Gets details of a single organization-scoped Rollout.

+

+ list(organization, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

+

Lists Rollouts in a given organization and location.

+

+ list_next()

+

Retrieves the next page of results.

+

+ pause(organization, rollout, etag=None, requestId=None, x__xgafv=None)

+

Pauses a Rollout.

+

+ resume(organization, rollout, etag=None, requestId=None, x__xgafv=None)

+

Resumes a Rollout.

+

Method Details

+
+ advance(organization, rollout, currentWaveNumber=None, requestId=None, x__xgafv=None) +
Advances a Rollout to the next wave, or completes it if no waves remain.
+
+Args:
+  organization: string, Required. Organization ID for this request. (required)
+  rollout: string, Required. Name of the Rollout resource to advance. (required)
+  currentWaveNumber: string, Required. Wave number of the current wave.
+  requestId: string, An optional request ID to identify requests. Specify a unique request ID so
+that if you must retry your request, the server will know to ignore the
+request if it has already been completed.
+
+For example, consider a situation where you make an initial request and
+the request times out. If you make the request again with the same
+request ID, the server can check if original operation with the same
+request ID was received, and if so, will ignore the second request. This
+prevents clients from accidentally creating duplicate commitments.
+
+The request ID must be
+a valid UUID with the exception that zero UUID is not supported
+(00000000-0000-0000-0000-000000000000).
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Represents an Operation resource.
+    #
+    # Google Compute Engine has three Operation resources:
+    #
+    # * [Global](/compute/docs/reference/rest/beta/globalOperations)
+    # * [Regional](/compute/docs/reference/rest/beta/regionOperations)
+    # * [Zonal](/compute/docs/reference/rest/beta/zoneOperations)
+    #
+    # You can use an operation resource to manage asynchronous API requests.
+    # For more information, readHandling
+    # API responses.
+    #
+    # Operations can be global, regional or zonal.
+    #
+    #    - For global operations, use the `globalOperations`
+    #    resource.
+    #    - For regional operations, use the
+    #    `regionOperations` resource.
+    #    - For zonal operations, use
+    #    the `zoneOperations` resource.
+    #
+    #
+    #
+    # For more information, read
+    # Global, Regional, and Zonal Resources.
+    #
+    # Note that completed Operation resources have a limited
+    # retention period.
+  "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request.
+      # Not present otherwise.
+  "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
+  "description": "A String", # [Output Only] A textual description of the operation, which is
+      # set when the operation is created.
+  "endTime": "A String", # [Output Only] The time that this operation was completed. This value is inRFC3339
+      # text format.
+  "error": { # [Output Only] If errors are generated during processing of the operation,
+      # this field will be populated.
+    "errors": [ # [Output Only] The array of errors encountered while processing this
+        # operation.
+      {
+        "code": "A String", # [Output Only] The error type identifier for this error.
+        "errorDetails": [ # [Output Only] An optional list of messages that contain the error
+            # details. There is a set of defined message types to use for providing
+            # details.The syntax depends on the error code. For example,
+            # QuotaExceededInfo will have details when the error code is
+            # QUOTA_EXCEEDED.
+          {
+            "errorInfo": { # Describes the cause of the error with structured details.
+                #
+                # Example of an error when contacting the "pubsub.googleapis.com" API when it
+                # is not enabled:
+                #
+                #     { "reason": "API_DISABLED"
+                #       "domain": "googleapis.com"
+                #       "metadata": {
+                #         "resource": "projects/123",
+                #         "service": "pubsub.googleapis.com"
+                #       }
+                #     }
+                #
+                # This response indicates that the pubsub.googleapis.com API is not enabled.
+                #
+                # Example of an error that is returned when attempting to create a Spanner
+                # instance in a region that is out of stock:
+                #
+                #     { "reason": "STOCKOUT"
+                #       "domain": "spanner.googleapis.com",
+                #       "metadata": {
+                #         "availableRegions": "us-central1,us-east2"
+                #       }
+                #     }
+              "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain
+                  # is typically the registered service name of the tool or product that
+                  # generates the error. Example: "pubsub.googleapis.com". If the error is
+                  # generated by some common infrastructure, the error domain must be a
+                  # globally unique value that identifies the infrastructure. For Google API
+                  # infrastructure, the error domain is "googleapis.com".
+              "metadatas": { # Additional structured details about this error.
+                  #
+                  # Keys must match a regular expression of `a-z+` but should
+                  # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
+                  # length. When identifying the current value of an exceeded limit, the units
+                  # should be contained in the key, not the value.  For example, rather than
+                  # `{"instanceLimit": "100/request"}`, should be returned as,
+                  # `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of
+                  # instances that can be created in a single (batch) request.
+                "a_key": "A String",
+              },
+              "reason": "A String", # The reason of the error. This is a constant value that identifies the
+                  # proximate cause of the error. Error reasons are unique within a particular
+                  # domain of errors. This should be at most 63 characters and match a
+                  # regular expression of `A-Z+[A-Z0-9]`, which represents
+                  # UPPER_SNAKE_CASE.
+            },
+            "help": { # Provides links to documentation or for performing an out of band action.
+                #
+                # For example, if a quota check failed with an error indicating the calling
+                # project hasn't enabled the accessed service, this can contain a URL pointing
+                # directly to the right place in the developer console to flip the bit.
+              "links": [ # URL(s) pointing to additional information on handling the current error.
+                { # Describes a URL link.
+                  "description": "A String", # Describes what the link offers.
+                  "url": "A String", # The URL of the link.
+                },
+              ],
+            },
+            "localizedMessage": { # Provides a localized error message that is safe to return to the user
+                # which can be attached to an RPC error.
+              "locale": "A String", # The locale used following the specification defined at
+                  # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
+                  # Examples are: "en-US", "fr-CH", "es-MX"
+              "message": "A String", # The localized error message in the above locale.
+            },
+            "quotaInfo": { # Additional details for quota exceeded error for resource quota.
+              "dimensions": { # The map holding related quota dimensions.
+                "a_key": "A String",
+              },
+              "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota
+                  #  type or metric.
+              "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type
+                  # or metric.
+              "limitName": "A String", # The name of the quota limit.
+              "metricName": "A String", # The Compute Engine quota metric name.
+              "rolloutStatus": "A String", # Rollout status of the future quota limit.
+            },
+          },
+        ],
+        "location": "A String", # [Output Only] Indicates the field in the request that caused the error.
+            # This property is optional.
+        "message": "A String", # [Output Only] An optional, human-readable error message.
+      },
+    ],
+  },
+  "getVersionOperationMetadata": {
+    "inlineSbomInfo": {
+      "currentComponentVersions": { # A mapping of components to their currently-applied versions or other
+          # appropriate identifiers.
+        "a_key": "A String",
+      },
+      "targetComponentVersions": { # A mapping of components to their target versions or other appropriate
+          # identifiers.
+        "a_key": "A String",
+      },
+    },
+  },
+  "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
+      # message that was returned, such as `NOT FOUND`.
+  "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
+      # status code that was returned. For example, a `404` means the
+      # resource was not found.
+  "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is
+      # defined by the server.
+  "insertTime": "A String", # [Output Only] The time that this operation was requested.
+      # This value is inRFC3339
+      # text format.
+  "instancesBulkInsertOperationMetadata": {
+    "perLocationStatus": { # Status information per location (location name is key).
+        # Example key: zones/us-central1-a
+      "a_key": {
+        "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far.
+        "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback.
+        "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an
+            # error.
+        "status": "A String", # [Output Only] Creation status of BulkInsert operation - information
+            # if the flow is rolling forward or rolling back.
+        "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created.
+      },
+    },
+  },
+  "kind": "compute#operation", # Output only. [Output Only] Type of the resource. Always `compute#operation` for
+      # Operation resources.
+  "name": "A String", # [Output Only] Name of the operation.
+  "operationGroupId": "A String", # Output only. [Output Only] An ID that represents a group of operations, such as when a
+      # group of operations results from a `bulkInsert` API request.
+  "operationType": "A String", # [Output Only] The type of operation, such as `insert`,
+      # `update`, or `delete`, and so on.
+  "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
+      # There is no requirement that this be linear or support any granularity of
+      # operations. This should not be used to guess when the operation will be
+      # complete. This number should monotonically increase as the operation
+      # progresses.
+  "region": "A String", # [Output Only] The URL of the region where the operation resides. Only
+      # applicable when performing regional operations.
+  "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+  "setCommonInstanceMetadataOperationMetadata": { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
+      # this field will contain information on all underlying zonal actions and
+      # their state.
+    "clientOperationId": "A String", # [Output Only] The client operation id.
+    "perLocationOperations": { # [Output Only] Status information per location (location name is key).
+        # Example key: zones/us-central1-a
+      "a_key": {
+        "error": { # The `Status` type defines a logical error model that is suitable for # [Output Only] If state is `ABANDONED` or `FAILED`, this field is
+            # populated.
+            # different programming environments, including REST APIs and RPC APIs. It is
+            # used by [gRPC](https://github.com/grpc). Each `Status` message contains
+            # three pieces of data: error code, error message, and error details.
+            #
+            # You can find out more about this error model and how to work with it in the
+            # [API Design Guide](https://cloud.google.com/apis/design/errors).
+          "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+          "details": [ # A list of messages that carry the error details.  There is a common set of
+              # message types for APIs to use.
+            {
+              "a_key": "", # Properties of the object. Contains field @type with type URL.
+            },
+          ],
+          "message": "A String", # A developer-facing error message, which should be in English. Any
+              # user-facing error message should be localized and sent in the
+              # google.rpc.Status.details field, or localized by the client.
+        },
+        "state": "A String", # [Output Only] Status of the action, which can be one of the following:
+            # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
+      },
+    },
+  },
+  "startTime": "A String", # [Output Only] The time that this operation was started by the server.
+      # This value is inRFC3339
+      # text format.
+  "status": "A String", # [Output Only] The status of the operation, which can be one of the
+      # following:
+      # `PENDING`, `RUNNING`, or `DONE`.
+  "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the
+      # operation.
+  "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation
+      # of the target resource.
+  "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For
+      # operations related to creating a snapshot, this points to the disk
+      # that the snapshot was created from.
+  "user": "A String", # [Output Only] User who requested the operation, for example:
+      # `user@example.com` or
+      # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
+  "warnings": [ # [Output Only] If warning messages are generated during processing of the
+      # operation, this field will be populated.
+    {
+      "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute
+          # Engine returns NO_RESULTS_ON_PAGE if there
+          # are no results in the response.
+      "data": [ # [Output Only] Metadata about this warning in key:
+          # value format. For example:
+          #
+          # "data": [
+          #   {
+          #    "key": "scope",
+          #    "value": "zones/us-east1-d"
+          #   }
+        {
+          "key": "A String", # [Output Only] A key that provides more detail on the warning being
+              # returned. For example, for warnings where there are no results in a list
+              # request for a particular zone, this key might be scope and
+              # the key value might be the zone name. Other examples might be a key
+              # indicating a deprecated resource and a suggested replacement, or a
+              # warning about invalid network settings (for example, if an instance
+              # attempts to perform IP forwarding but is not enabled for IP forwarding).
+          "value": "A String", # [Output Only] A warning data value corresponding to the key.
+        },
+      ],
+      "message": "A String", # [Output Only] A human-readable description of the warning code.
+    },
+  ],
+  "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only
+      # applicable when performing per-zone operations.
+}
+
+ +
+ cancel(organization, rollout, requestId=None, rollback=None, x__xgafv=None) +
Cancels a Rollout.
+
+Args:
+  organization: string, Required. Organization ID for this request. (required)
+  rollout: string, Name of the Rollout resource to cancel. (required)
+  requestId: string, An optional request ID to identify requests. Specify a unique request ID so
+that if you must retry your request, the server will know to ignore the
+request if it has already been completed.
+
+For example, consider a situation where you make an initial request and
+the request times out. If you make the request again with the same
+request ID, the server can check if original operation with the same
+request ID was received, and if so, will ignore the second request. This
+prevents clients from accidentally creating duplicate commitments.
+
+The request ID must be
+a valid UUID with the exception that zero UUID is not supported
+(00000000-0000-0000-0000-000000000000).
+  rollback: boolean, Optional. If true, then the ongoing rollout must be rolled back. Else, just cancel
+the rollout without taking any further actions. Note that products must
+support at least one of these options, however, it does not need to support
+both.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Represents an Operation resource.
+    #
+    # Google Compute Engine has three Operation resources:
+    #
+    # * [Global](/compute/docs/reference/rest/beta/globalOperations)
+    # * [Regional](/compute/docs/reference/rest/beta/regionOperations)
+    # * [Zonal](/compute/docs/reference/rest/beta/zoneOperations)
+    #
+    # You can use an operation resource to manage asynchronous API requests.
+    # For more information, readHandling
+    # API responses.
+    #
+    # Operations can be global, regional or zonal.
+    #
+    #    - For global operations, use the `globalOperations`
+    #    resource.
+    #    - For regional operations, use the
+    #    `regionOperations` resource.
+    #    - For zonal operations, use
+    #    the `zoneOperations` resource.
+    #
+    #
+    #
+    # For more information, read
+    # Global, Regional, and Zonal Resources.
+    #
+    # Note that completed Operation resources have a limited
+    # retention period.
+  "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request.
+      # Not present otherwise.
+  "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
+  "description": "A String", # [Output Only] A textual description of the operation, which is
+      # set when the operation is created.
+  "endTime": "A String", # [Output Only] The time that this operation was completed. This value is inRFC3339
+      # text format.
+  "error": { # [Output Only] If errors are generated during processing of the operation,
+      # this field will be populated.
+    "errors": [ # [Output Only] The array of errors encountered while processing this
+        # operation.
+      {
+        "code": "A String", # [Output Only] The error type identifier for this error.
+        "errorDetails": [ # [Output Only] An optional list of messages that contain the error
+            # details. There is a set of defined message types to use for providing
+            # details.The syntax depends on the error code. For example,
+            # QuotaExceededInfo will have details when the error code is
+            # QUOTA_EXCEEDED.
+          {
+            "errorInfo": { # Describes the cause of the error with structured details.
+                #
+                # Example of an error when contacting the "pubsub.googleapis.com" API when it
+                # is not enabled:
+                #
+                #     { "reason": "API_DISABLED"
+                #       "domain": "googleapis.com"
+                #       "metadata": {
+                #         "resource": "projects/123",
+                #         "service": "pubsub.googleapis.com"
+                #       }
+                #     }
+                #
+                # This response indicates that the pubsub.googleapis.com API is not enabled.
+                #
+                # Example of an error that is returned when attempting to create a Spanner
+                # instance in a region that is out of stock:
+                #
+                #     { "reason": "STOCKOUT"
+                #       "domain": "spanner.googleapis.com",
+                #       "metadata": {
+                #         "availableRegions": "us-central1,us-east2"
+                #       }
+                #     }
+              "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain
+                  # is typically the registered service name of the tool or product that
+                  # generates the error. Example: "pubsub.googleapis.com". If the error is
+                  # generated by some common infrastructure, the error domain must be a
+                  # globally unique value that identifies the infrastructure. For Google API
+                  # infrastructure, the error domain is "googleapis.com".
+              "metadatas": { # Additional structured details about this error.
+                  #
+                  # Keys must match a regular expression of `a-z+` but should
+                  # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
+                  # length. When identifying the current value of an exceeded limit, the units
+                  # should be contained in the key, not the value.  For example, rather than
+                  # `{"instanceLimit": "100/request"}`, should be returned as,
+                  # `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of
+                  # instances that can be created in a single (batch) request.
+                "a_key": "A String",
+              },
+              "reason": "A String", # The reason of the error. This is a constant value that identifies the
+                  # proximate cause of the error. Error reasons are unique within a particular
+                  # domain of errors. This should be at most 63 characters and match a
+                  # regular expression of `A-Z+[A-Z0-9]`, which represents
+                  # UPPER_SNAKE_CASE.
+            },
+            "help": { # Provides links to documentation or for performing an out of band action.
+                #
+                # For example, if a quota check failed with an error indicating the calling
+                # project hasn't enabled the accessed service, this can contain a URL pointing
+                # directly to the right place in the developer console to flip the bit.
+              "links": [ # URL(s) pointing to additional information on handling the current error.
+                { # Describes a URL link.
+                  "description": "A String", # Describes what the link offers.
+                  "url": "A String", # The URL of the link.
+                },
+              ],
+            },
+            "localizedMessage": { # Provides a localized error message that is safe to return to the user
+                # which can be attached to an RPC error.
+              "locale": "A String", # The locale used following the specification defined at
+                  # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
+                  # Examples are: "en-US", "fr-CH", "es-MX"
+              "message": "A String", # The localized error message in the above locale.
+            },
+            "quotaInfo": { # Additional details for quota exceeded error for resource quota.
+              "dimensions": { # The map holding related quota dimensions.
+                "a_key": "A String",
+              },
+              "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota
+                  #  type or metric.
+              "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type
+                  # or metric.
+              "limitName": "A String", # The name of the quota limit.
+              "metricName": "A String", # The Compute Engine quota metric name.
+              "rolloutStatus": "A String", # Rollout status of the future quota limit.
+            },
+          },
+        ],
+        "location": "A String", # [Output Only] Indicates the field in the request that caused the error.
+            # This property is optional.
+        "message": "A String", # [Output Only] An optional, human-readable error message.
+      },
+    ],
+  },
+  "getVersionOperationMetadata": {
+    "inlineSbomInfo": {
+      "currentComponentVersions": { # A mapping of components to their currently-applied versions or other
+          # appropriate identifiers.
+        "a_key": "A String",
+      },
+      "targetComponentVersions": { # A mapping of components to their target versions or other appropriate
+          # identifiers.
+        "a_key": "A String",
+      },
+    },
+  },
+  "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
+      # message that was returned, such as `NOT FOUND`.
+  "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
+      # status code that was returned. For example, a `404` means the
+      # resource was not found.
+  "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is
+      # defined by the server.
+  "insertTime": "A String", # [Output Only] The time that this operation was requested.
+      # This value is inRFC3339
+      # text format.
+  "instancesBulkInsertOperationMetadata": {
+    "perLocationStatus": { # Status information per location (location name is key).
+        # Example key: zones/us-central1-a
+      "a_key": {
+        "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far.
+        "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback.
+        "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an
+            # error.
+        "status": "A String", # [Output Only] Creation status of BulkInsert operation - information
+            # if the flow is rolling forward or rolling back.
+        "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created.
+      },
+    },
+  },
+  "kind": "compute#operation", # Output only. [Output Only] Type of the resource. Always `compute#operation` for
+      # Operation resources.
+  "name": "A String", # [Output Only] Name of the operation.
+  "operationGroupId": "A String", # Output only. [Output Only] An ID that represents a group of operations, such as when a
+      # group of operations results from a `bulkInsert` API request.
+  "operationType": "A String", # [Output Only] The type of operation, such as `insert`,
+      # `update`, or `delete`, and so on.
+  "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
+      # There is no requirement that this be linear or support any granularity of
+      # operations. This should not be used to guess when the operation will be
+      # complete. This number should monotonically increase as the operation
+      # progresses.
+  "region": "A String", # [Output Only] The URL of the region where the operation resides. Only
+      # applicable when performing regional operations.
+  "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+  "setCommonInstanceMetadataOperationMetadata": { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
+      # this field will contain information on all underlying zonal actions and
+      # their state.
+    "clientOperationId": "A String", # [Output Only] The client operation id.
+    "perLocationOperations": { # [Output Only] Status information per location (location name is key).
+        # Example key: zones/us-central1-a
+      "a_key": {
+        "error": { # The `Status` type defines a logical error model that is suitable for # [Output Only] If state is `ABANDONED` or `FAILED`, this field is
+            # populated.
+            # different programming environments, including REST APIs and RPC APIs. It is
+            # used by [gRPC](https://github.com/grpc). Each `Status` message contains
+            # three pieces of data: error code, error message, and error details.
+            #
+            # You can find out more about this error model and how to work with it in the
+            # [API Design Guide](https://cloud.google.com/apis/design/errors).
+          "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+          "details": [ # A list of messages that carry the error details.  There is a common set of
+              # message types for APIs to use.
+            {
+              "a_key": "", # Properties of the object. Contains field @type with type URL.
+            },
+          ],
+          "message": "A String", # A developer-facing error message, which should be in English. Any
+              # user-facing error message should be localized and sent in the
+              # google.rpc.Status.details field, or localized by the client.
+        },
+        "state": "A String", # [Output Only] Status of the action, which can be one of the following:
+            # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
+      },
+    },
+  },
+  "startTime": "A String", # [Output Only] The time that this operation was started by the server.
+      # This value is inRFC3339
+      # text format.
+  "status": "A String", # [Output Only] The status of the operation, which can be one of the
+      # following:
+      # `PENDING`, `RUNNING`, or `DONE`.
+  "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the
+      # operation.
+  "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation
+      # of the target resource.
+  "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For
+      # operations related to creating a snapshot, this points to the disk
+      # that the snapshot was created from.
+  "user": "A String", # [Output Only] User who requested the operation, for example:
+      # `user@example.com` or
+      # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
+  "warnings": [ # [Output Only] If warning messages are generated during processing of the
+      # operation, this field will be populated.
+    {
+      "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute
+          # Engine returns NO_RESULTS_ON_PAGE if there
+          # are no results in the response.
+      "data": [ # [Output Only] Metadata about this warning in key:
+          # value format. For example:
+          #
+          # "data": [
+          #   {
+          #    "key": "scope",
+          #    "value": "zones/us-east1-d"
+          #   }
+        {
+          "key": "A String", # [Output Only] A key that provides more detail on the warning being
+              # returned. For example, for warnings where there are no results in a list
+              # request for a particular zone, this key might be scope and
+              # the key value might be the zone name. Other examples might be a key
+              # indicating a deprecated resource and a suggested replacement, or a
+              # warning about invalid network settings (for example, if an instance
+              # attempts to perform IP forwarding but is not enabled for IP forwarding).
+          "value": "A String", # [Output Only] A warning data value corresponding to the key.
+        },
+      ],
+      "message": "A String", # [Output Only] A human-readable description of the warning code.
+    },
+  ],
+  "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only
+      # applicable when performing per-zone operations.
+}
+
+ +
+ close() +
Close httplib2 connections.
+
+ +
+ delete(organization, rollout, requestId=None, x__xgafv=None) +
Deletes a Rollout.
+
+Args:
+  organization: string, Required. Organization ID for this request. (required)
+  rollout: string, Name of the Rollout resource to delete. (required)
+  requestId: string, An optional request ID to identify requests. Specify a unique request ID so
+that if you must retry your request, the server will know to ignore the
+request if it has already been completed.
+
+For example, consider a situation where you make an initial request and
+the request times out. If you make the request again with the same
+request ID, the server can check if original operation with the same
+request ID was received, and if so, will ignore the second request. This
+prevents clients from accidentally creating duplicate commitments.
+
+The request ID must be
+a valid UUID with the exception that zero UUID is not supported
+(00000000-0000-0000-0000-000000000000).
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Represents an Operation resource.
+    #
+    # Google Compute Engine has three Operation resources:
+    #
+    # * [Global](/compute/docs/reference/rest/beta/globalOperations)
+    # * [Regional](/compute/docs/reference/rest/beta/regionOperations)
+    # * [Zonal](/compute/docs/reference/rest/beta/zoneOperations)
+    #
+    # You can use an operation resource to manage asynchronous API requests.
+    # For more information, readHandling
+    # API responses.
+    #
+    # Operations can be global, regional or zonal.
+    #
+    #    - For global operations, use the `globalOperations`
+    #    resource.
+    #    - For regional operations, use the
+    #    `regionOperations` resource.
+    #    - For zonal operations, use
+    #    the `zoneOperations` resource.
+    #
+    #
+    #
+    # For more information, read
+    # Global, Regional, and Zonal Resources.
+    #
+    # Note that completed Operation resources have a limited
+    # retention period.
+  "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request.
+      # Not present otherwise.
+  "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
+  "description": "A String", # [Output Only] A textual description of the operation, which is
+      # set when the operation is created.
+  "endTime": "A String", # [Output Only] The time that this operation was completed. This value is inRFC3339
+      # text format.
+  "error": { # [Output Only] If errors are generated during processing of the operation,
+      # this field will be populated.
+    "errors": [ # [Output Only] The array of errors encountered while processing this
+        # operation.
+      {
+        "code": "A String", # [Output Only] The error type identifier for this error.
+        "errorDetails": [ # [Output Only] An optional list of messages that contain the error
+            # details. There is a set of defined message types to use for providing
+            # details.The syntax depends on the error code. For example,
+            # QuotaExceededInfo will have details when the error code is
+            # QUOTA_EXCEEDED.
+          {
+            "errorInfo": { # Describes the cause of the error with structured details.
+                #
+                # Example of an error when contacting the "pubsub.googleapis.com" API when it
+                # is not enabled:
+                #
+                #     { "reason": "API_DISABLED"
+                #       "domain": "googleapis.com"
+                #       "metadata": {
+                #         "resource": "projects/123",
+                #         "service": "pubsub.googleapis.com"
+                #       }
+                #     }
+                #
+                # This response indicates that the pubsub.googleapis.com API is not enabled.
+                #
+                # Example of an error that is returned when attempting to create a Spanner
+                # instance in a region that is out of stock:
+                #
+                #     { "reason": "STOCKOUT"
+                #       "domain": "spanner.googleapis.com",
+                #       "metadata": {
+                #         "availableRegions": "us-central1,us-east2"
+                #       }
+                #     }
+              "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain
+                  # is typically the registered service name of the tool or product that
+                  # generates the error. Example: "pubsub.googleapis.com". If the error is
+                  # generated by some common infrastructure, the error domain must be a
+                  # globally unique value that identifies the infrastructure. For Google API
+                  # infrastructure, the error domain is "googleapis.com".
+              "metadatas": { # Additional structured details about this error.
+                  #
+                  # Keys must match a regular expression of `a-z+` but should
+                  # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
+                  # length. When identifying the current value of an exceeded limit, the units
+                  # should be contained in the key, not the value.  For example, rather than
+                  # `{"instanceLimit": "100/request"}`, should be returned as,
+                  # `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of
+                  # instances that can be created in a single (batch) request.
+                "a_key": "A String",
+              },
+              "reason": "A String", # The reason of the error. This is a constant value that identifies the
+                  # proximate cause of the error. Error reasons are unique within a particular
+                  # domain of errors. This should be at most 63 characters and match a
+                  # regular expression of `A-Z+[A-Z0-9]`, which represents
+                  # UPPER_SNAKE_CASE.
+            },
+            "help": { # Provides links to documentation or for performing an out of band action.
+                #
+                # For example, if a quota check failed with an error indicating the calling
+                # project hasn't enabled the accessed service, this can contain a URL pointing
+                # directly to the right place in the developer console to flip the bit.
+              "links": [ # URL(s) pointing to additional information on handling the current error.
+                { # Describes a URL link.
+                  "description": "A String", # Describes what the link offers.
+                  "url": "A String", # The URL of the link.
+                },
+              ],
+            },
+            "localizedMessage": { # Provides a localized error message that is safe to return to the user
+                # which can be attached to an RPC error.
+              "locale": "A String", # The locale used following the specification defined at
+                  # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
+                  # Examples are: "en-US", "fr-CH", "es-MX"
+              "message": "A String", # The localized error message in the above locale.
+            },
+            "quotaInfo": { # Additional details for quota exceeded error for resource quota.
+              "dimensions": { # The map holding related quota dimensions.
+                "a_key": "A String",
+              },
+              "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota
+                  #  type or metric.
+              "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type
+                  # or metric.
+              "limitName": "A String", # The name of the quota limit.
+              "metricName": "A String", # The Compute Engine quota metric name.
+              "rolloutStatus": "A String", # Rollout status of the future quota limit.
+            },
+          },
+        ],
+        "location": "A String", # [Output Only] Indicates the field in the request that caused the error.
+            # This property is optional.
+        "message": "A String", # [Output Only] An optional, human-readable error message.
+      },
+    ],
+  },
+  "getVersionOperationMetadata": {
+    "inlineSbomInfo": {
+      "currentComponentVersions": { # A mapping of components to their currently-applied versions or other
+          # appropriate identifiers.
+        "a_key": "A String",
+      },
+      "targetComponentVersions": { # A mapping of components to their target versions or other appropriate
+          # identifiers.
+        "a_key": "A String",
+      },
+    },
+  },
+  "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
+      # message that was returned, such as `NOT FOUND`.
+  "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
+      # status code that was returned. For example, a `404` means the
+      # resource was not found.
+  "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is
+      # defined by the server.
+  "insertTime": "A String", # [Output Only] The time that this operation was requested.
+      # This value is inRFC3339
+      # text format.
+  "instancesBulkInsertOperationMetadata": {
+    "perLocationStatus": { # Status information per location (location name is key).
+        # Example key: zones/us-central1-a
+      "a_key": {
+        "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far.
+        "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback.
+        "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an
+            # error.
+        "status": "A String", # [Output Only] Creation status of BulkInsert operation - information
+            # if the flow is rolling forward or rolling back.
+        "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created.
+      },
+    },
+  },
+  "kind": "compute#operation", # Output only. [Output Only] Type of the resource. Always `compute#operation` for
+      # Operation resources.
+  "name": "A String", # [Output Only] Name of the operation.
+  "operationGroupId": "A String", # Output only. [Output Only] An ID that represents a group of operations, such as when a
+      # group of operations results from a `bulkInsert` API request.
+  "operationType": "A String", # [Output Only] The type of operation, such as `insert`,
+      # `update`, or `delete`, and so on.
+  "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
+      # There is no requirement that this be linear or support any granularity of
+      # operations. This should not be used to guess when the operation will be
+      # complete. This number should monotonically increase as the operation
+      # progresses.
+  "region": "A String", # [Output Only] The URL of the region where the operation resides. Only
+      # applicable when performing regional operations.
+  "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+  "setCommonInstanceMetadataOperationMetadata": { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
+      # this field will contain information on all underlying zonal actions and
+      # their state.
+    "clientOperationId": "A String", # [Output Only] The client operation id.
+    "perLocationOperations": { # [Output Only] Status information per location (location name is key).
+        # Example key: zones/us-central1-a
+      "a_key": {
+        "error": { # The `Status` type defines a logical error model that is suitable for # [Output Only] If state is `ABANDONED` or `FAILED`, this field is
+            # populated.
+            # different programming environments, including REST APIs and RPC APIs. It is
+            # used by [gRPC](https://github.com/grpc). Each `Status` message contains
+            # three pieces of data: error code, error message, and error details.
+            #
+            # You can find out more about this error model and how to work with it in the
+            # [API Design Guide](https://cloud.google.com/apis/design/errors).
+          "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+          "details": [ # A list of messages that carry the error details.  There is a common set of
+              # message types for APIs to use.
+            {
+              "a_key": "", # Properties of the object. Contains field @type with type URL.
+            },
+          ],
+          "message": "A String", # A developer-facing error message, which should be in English. Any
+              # user-facing error message should be localized and sent in the
+              # google.rpc.Status.details field, or localized by the client.
+        },
+        "state": "A String", # [Output Only] Status of the action, which can be one of the following:
+            # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
+      },
+    },
+  },
+  "startTime": "A String", # [Output Only] The time that this operation was started by the server.
+      # This value is inRFC3339
+      # text format.
+  "status": "A String", # [Output Only] The status of the operation, which can be one of the
+      # following:
+      # `PENDING`, `RUNNING`, or `DONE`.
+  "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the
+      # operation.
+  "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation
+      # of the target resource.
+  "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For
+      # operations related to creating a snapshot, this points to the disk
+      # that the snapshot was created from.
+  "user": "A String", # [Output Only] User who requested the operation, for example:
+      # `user@example.com` or
+      # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
+  "warnings": [ # [Output Only] If warning messages are generated during processing of the
+      # operation, this field will be populated.
+    {
+      "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute
+          # Engine returns NO_RESULTS_ON_PAGE if there
+          # are no results in the response.
+      "data": [ # [Output Only] Metadata about this warning in key:
+          # value format. For example:
+          #
+          # "data": [
+          #   {
+          #    "key": "scope",
+          #    "value": "zones/us-east1-d"
+          #   }
+        {
+          "key": "A String", # [Output Only] A key that provides more detail on the warning being
+              # returned. For example, for warnings where there are no results in a list
+              # request for a particular zone, this key might be scope and
+              # the key value might be the zone name. Other examples might be a key
+              # indicating a deprecated resource and a suggested replacement, or a
+              # warning about invalid network settings (for example, if an instance
+              # attempts to perform IP forwarding but is not enabled for IP forwarding).
+          "value": "A String", # [Output Only] A warning data value corresponding to the key.
+        },
+      ],
+      "message": "A String", # [Output Only] A human-readable description of the warning code.
+    },
+  ],
+  "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only
+      # applicable when performing per-zone operations.
+}
+
+ +
+ get(organization, rollout, x__xgafv=None) +
Gets details of a single organization-scoped Rollout.
+
+Args:
+  organization: string, Organization ID for this request. (required)
+  rollout: string, Name of the persistent rollout to return. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Rollout resource.
+    #
+    # A Rollout is a specific instance of a RolloutPlan. It represents a single
+    # execution of a strategy to roll out a specific resource. It also provides
+    # APIs to interact with the rollout.
+  "cancellationTime": "A String", # Output only. The timestamp at which the Rollout was cancelled.
+  "completionTime": "A String", # Output only. The timestamp at which the Rollout was completed.
+  "creationTimestamp": "A String", # Output only. [Output Only] Creation timestamp inRFC3339
+      # text format.
+  "currentWaveNumber": "A String", # Output only. The number of the currently running wave.
+      # Ex. 1
+  "description": "A String", # An optional description of this resource. Provide this property when you
+      # create the resource.
+  "etag": "A String", # Output only. etag of the Rollout
+      # Ex. abc1234
+  "id": "A String", # Output only. [Output Only] The unique identifier for the resource. This identifier is
+      # defined by the server.
+  "kind": "compute#rollout", # Output only. [Output Only] Type of the resource. Always compute#rollout
+      # for rollouts.
+  "name": "A String", # Name of the resource. Provided by the client when the resource is created.
+      # The name must be 1-63 characters long, and comply withRFC1035.
+      # Specifically, the name must be 1-63 characters long and match the regular
+      # expression `[a-z]([-a-z0-9]*[a-z0-9])?`
+      # which means the first character must be a lowercase letter, and all
+      # following characters must be a dash, lowercase letter, or digit, except
+      # the last character, which cannot be a dash.
+  "pauseTime": "A String", # Output only. The timestamp at which the Rollout was paused.
+  "resumeTime": "A String", # Output only. The timestamp at which the Rollout was resumed.
+  "rolloutEntity": { # Specifications of the resource to roll out. # Required. The resource being rolled out.
+    "orchestratedEntity": { # This message is used if the resource type follows the Orchestrated # Optional. Entity details for products using the Orchestrated Integration model.
+        # integration model with ProgressiveRollout.
+      "conflictBehavior": "A String", # Required. Specifies the behavior of the Rollout if an out of band update is
+          # detected in a project during a Rollout. It can be one of the following
+          # values:
+          # 1) overwrite : Overwrite the local value with the rollout value.
+          # 2) no_overwrite : Do not overwrite the local value with the rollout
+          # value.
+      "orchestrationAction": "A String", # Required. Orchestration action during the Rollout. It can be one of the following
+          # values:
+          # 1) "update": Resources will be updated by the rollout.
+          # 2) "delete": Resources will be deleted by the rollout.
+      "orchestrationSource": "A String", # Required. Fully qualified resource name of the resource which contains the source
+          # of truth of the configuration being rolled out across
+          # locations/projects. For example, in the case of a global Rollout which
+          # is applied across regions, this contains the name of the global
+          # resource created by the user which contains a payload for a resource
+          # that is orchestrated across regions. This follows the following format:
+          # //.googleapis.com/projects//locations/global//
+          # e.g.
+          # //osconfig.googleapis.com/projects/1/locations/global/policyOrchestrators/po1
+    },
+  },
+  "rolloutPlan": "A String", # Required. Rollout Plan used to model the Rollout.
+      # Ex. compute.googleapis.com/v1/projects/1234/rolloutPlans/rp1
+  "selfLink": "A String", # Output only. [Output Only] Server-defined fully-qualified URL for this resource.
+  "selfLinkWithId": "A String", # Output only. [Output Only] Server-defined URL for this resource's resource id.
+  "state": "A String", # Output only. The current state of the Rollout.
+  "waveDetails": [ # Output only. Details about each wave of the rollout.
+    { # Additional metadata about the status of each wave provided by the server.
+      "orchestratedWaveDetails": { # Details of the wave for products using the Orchestrated integration # Output only. Additional details of the wave for products using the Orchestrated
+          # Integration model.
+          # model.
+        "completedResourcesCount": "A String", # Output only. Resource completed so far.
+        "estimatedCompletionTime": "A String", # Output only. Estimated timestamp at which the wave will complete. Extrapolated from
+            # current progress.
+        "estimatedTotalResourcesCount": "A String", # Output only. Estimated total count of resources.
+        "failedLocations": [ # Output only. Locations that failed during orchestration, and ProgressiveRollout
+            # stopped retrying. There may be some successful resources rolled out in
+            # the wave as the location may have failed later in the Rollout.
+          "A String",
+        ],
+        "failedResourcesCount": "A String", # Output only. Resources failed.
+        "locationStatus": { # Output only. Status of each location in the wave. Map keys (locations) must be
+            # specified like "us-east1" or "asia-west1-a".
+          "a_key": { # Represents the status of a location in a wave.
+            "state": "A String", # Output only. Location state of the wave.
+          },
+        },
+      },
+      "waveDisplayName": "A String", # Output only. Wave name.
+          # Ex. wave1
+      "waveNumber": "A String", # Output only. System generated number for the wave.
+    },
+  ],
+}
+
+ +
+ list(organization, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None) +
Lists Rollouts in a given organization and location.
+
+Args:
+  organization: string, Required. Organization ID for this request. (required)
+  filter: string, A filter expression that filters resources listed in the response. Most
+Compute resources support two types of filter expressions:
+expressions that support regular expressions and expressions that follow
+API improvement proposal AIP-160.
+These two types of filter expressions cannot be mixed in one request.
+
+If you want to use AIP-160, your expression must specify the field name, an
+operator, and the value that you want to use for filtering. The value
+must be a string, a number, or a boolean. The operator
+must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.
+
+For example, if you are filtering Compute Engine instances, you can
+exclude instances named `example-instance` by specifying
+`name != example-instance`.
+
+The `:*` comparison can be used to test whether a key has been defined.
+For example, to find all objects with `owner` label use:
+```
+labels.owner:*
+```
+
+You can also filter nested fields. For example, you could specify
+`scheduling.automaticRestart = false` to include instances only
+if they are not scheduled for automatic restarts. You can use filtering
+on nested fields to filter based onresource labels.
+
+To filter on multiple expressions, provide each separate expression within
+parentheses. For example:
+```
+(scheduling.automaticRestart = true)
+(cpuPlatform = "Intel Skylake")
+```
+By default, each expression is an `AND` expression. However, you
+can include `AND` and `OR` expressions explicitly.
+For example:
+```
+(cpuPlatform = "Intel Skylake") OR
+(cpuPlatform = "Intel Broadwell") AND
+(scheduling.automaticRestart = true)
+```
+
+If you want to use a regular expression, use the `eq` (equal) or `ne`
+(not equal) operator against a single un-parenthesized expression with or
+without quotes or against multiple parenthesized expressions. Examples:
+
+`fieldname eq unquoted literal`
+`fieldname eq 'single quoted literal'`
+`fieldname eq "double quoted literal"`
+`(fieldname1 eq literal) (fieldname2 ne "literal")`
+
+The literal value is interpreted as a regular expression using GoogleRE2 library syntax.
+The literal value must match the entire field.
+
+For example, to filter for instances that do not end with name "instance",
+you would use `name ne .*instance`.
+
+You cannot combine constraints on multiple fields using regular
+expressions.
+  maxResults: integer, The maximum number of results per page that should be returned.
+If the number of available results is larger than `maxResults`,
+Compute Engine returns a `nextPageToken` that can be used to get
+the next page of results in subsequent list requests. Acceptable values are
+`0` to `500`, inclusive. (Default: `500`)
+  orderBy: string, Sorts list results by a certain order. By default, results
+are returned in alphanumerical order based on the resource name.
+
+You can also sort results in descending order based on the creation
+timestamp using `orderBy="creationTimestamp desc"`. This sorts
+results based on the `creationTimestamp` field in
+reverse chronological order (newest result first). Use this to sort
+resources like operations so that the newest operation is returned first.
+
+Currently, only sorting by `name` or
+`creationTimestamp desc` is supported.
+  pageToken: string, Specifies a page token to use. Set `pageToken` to the
+`nextPageToken` returned by a previous list request to get
+the next page of results.
+  returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case
+of failure. The default value is false.
+
+For example, when partial success behavior is enabled, aggregatedList for a
+single zone scope either returns all resources in the zone or no resources,
+with an error code.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    {
+  "etag": "A String",
+  "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
+  "items": [ # A list of Rollout resources.
+    { # Rollout resource.
+        #
+        # A Rollout is a specific instance of a RolloutPlan. It represents a single
+        # execution of a strategy to roll out a specific resource. It also provides
+        # APIs to interact with the rollout.
+      "cancellationTime": "A String", # Output only. The timestamp at which the Rollout was cancelled.
+      "completionTime": "A String", # Output only. The timestamp at which the Rollout was completed.
+      "creationTimestamp": "A String", # Output only. [Output Only] Creation timestamp inRFC3339
+          # text format.
+      "currentWaveNumber": "A String", # Output only. The number of the currently running wave.
+          # Ex. 1
+      "description": "A String", # An optional description of this resource. Provide this property when you
+          # create the resource.
+      "etag": "A String", # Output only. etag of the Rollout
+          # Ex. abc1234
+      "id": "A String", # Output only. [Output Only] The unique identifier for the resource. This identifier is
+          # defined by the server.
+      "kind": "compute#rollout", # Output only. [Output Only] Type of the resource. Always compute#rollout
+          # for rollouts.
+      "name": "A String", # Name of the resource. Provided by the client when the resource is created.
+          # The name must be 1-63 characters long, and comply withRFC1035.
+          # Specifically, the name must be 1-63 characters long and match the regular
+          # expression `[a-z]([-a-z0-9]*[a-z0-9])?`
+          # which means the first character must be a lowercase letter, and all
+          # following characters must be a dash, lowercase letter, or digit, except
+          # the last character, which cannot be a dash.
+      "pauseTime": "A String", # Output only. The timestamp at which the Rollout was paused.
+      "resumeTime": "A String", # Output only. The timestamp at which the Rollout was resumed.
+      "rolloutEntity": { # Specifications of the resource to roll out. # Required. The resource being rolled out.
+        "orchestratedEntity": { # This message is used if the resource type follows the Orchestrated # Optional. Entity details for products using the Orchestrated Integration model.
+            # integration model with ProgressiveRollout.
+          "conflictBehavior": "A String", # Required. Specifies the behavior of the Rollout if an out of band update is
+              # detected in a project during a Rollout. It can be one of the following
+              # values:
+              # 1) overwrite : Overwrite the local value with the rollout value.
+              # 2) no_overwrite : Do not overwrite the local value with the rollout
+              # value.
+          "orchestrationAction": "A String", # Required. Orchestration action during the Rollout. It can be one of the following
+              # values:
+              # 1) "update": Resources will be updated by the rollout.
+              # 2) "delete": Resources will be deleted by the rollout.
+          "orchestrationSource": "A String", # Required. Fully qualified resource name of the resource which contains the source
+              # of truth of the configuration being rolled out across
+              # locations/projects. For example, in the case of a global Rollout which
+              # is applied across regions, this contains the name of the global
+              # resource created by the user which contains a payload for a resource
+              # that is orchestrated across regions. This follows the following format:
+              # //.googleapis.com/projects//locations/global//
+              # e.g.
+              # //osconfig.googleapis.com/projects/1/locations/global/policyOrchestrators/po1
+        },
+      },
+      "rolloutPlan": "A String", # Required. Rollout Plan used to model the Rollout.
+          # Ex. compute.googleapis.com/v1/projects/1234/rolloutPlans/rp1
+      "selfLink": "A String", # Output only. [Output Only] Server-defined fully-qualified URL for this resource.
+      "selfLinkWithId": "A String", # Output only. [Output Only] Server-defined URL for this resource's resource id.
+      "state": "A String", # Output only. The current state of the Rollout.
+      "waveDetails": [ # Output only. Details about each wave of the rollout.
+        { # Additional metadata about the status of each wave provided by the server.
+          "orchestratedWaveDetails": { # Details of the wave for products using the Orchestrated integration # Output only. Additional details of the wave for products using the Orchestrated
+              # Integration model.
+              # model.
+            "completedResourcesCount": "A String", # Output only. Resource completed so far.
+            "estimatedCompletionTime": "A String", # Output only. Estimated timestamp at which the wave will complete. Extrapolated from
+                # current progress.
+            "estimatedTotalResourcesCount": "A String", # Output only. Estimated total count of resources.
+            "failedLocations": [ # Output only. Locations that failed during orchestration, and ProgressiveRollout
+                # stopped retrying. There may be some successful resources rolled out in
+                # the wave as the location may have failed later in the Rollout.
+              "A String",
+            ],
+            "failedResourcesCount": "A String", # Output only. Resources failed.
+            "locationStatus": { # Output only. Status of each location in the wave. Map keys (locations) must be
+                # specified like "us-east1" or "asia-west1-a".
+              "a_key": { # Represents the status of a location in a wave.
+                "state": "A String", # Output only. Location state of the wave.
+              },
+            },
+          },
+          "waveDisplayName": "A String", # Output only. Wave name.
+              # Ex. wave1
+          "waveNumber": "A String", # Output only. System generated number for the wave.
+        },
+      ],
+    },
+  ],
+  "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for
+      # list requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for
+      # the query parameter pageToken in the next list request.
+      # Subsequent list requests will have their own nextPageToken to
+      # continue paging through the results.
+  "selfLink": "A String", # Output only. [Output Only] Server-defined URL for this resource.
+  "unreachables": [ # Output only. [Output Only] Unreachable resources.
+      # end_interface: MixerListResponseWithEtagBuilder
+    "A String",
+  ],
+  "warning": { # [Output Only] Informational warning message.
+    "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute
+        # Engine returns NO_RESULTS_ON_PAGE if there
+        # are no results in the response.
+    "data": [ # [Output Only] Metadata about this warning in key:
+        # value format. For example:
+        #
+        # "data": [
+        #   {
+        #    "key": "scope",
+        #    "value": "zones/us-east1-d"
+        #   }
+      {
+        "key": "A String", # [Output Only] A key that provides more detail on the warning being
+            # returned. For example, for warnings where there are no results in a list
+            # request for a particular zone, this key might be scope and
+            # the key value might be the zone name. Other examples might be a key
+            # indicating a deprecated resource and a suggested replacement, or a
+            # warning about invalid network settings (for example, if an instance
+            # attempts to perform IP forwarding but is not enabled for IP forwarding).
+        "value": "A String", # [Output Only] A warning data value corresponding to the key.
+      },
+    ],
+    "message": "A String", # [Output Only] A human-readable description of the warning code.
+  },
+}
+
+ +
+ 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.
+        
+
+ +
+ pause(organization, rollout, etag=None, requestId=None, x__xgafv=None) +
Pauses a Rollout.
+
+Args:
+  organization: string, Required. Organization ID for this request. (required)
+  rollout: string, Required. Name of the Rollout resource to pause. (required)
+  etag: string, The etag of the Rollout.
+If this is provided, the request will only succeed if the etag matches
+the current etag of the Rollout.
+  requestId: string, An optional request ID to identify requests. Specify a unique request ID so
+that if you must retry your request, the server will know to ignore the
+request if it has already been completed.
+
+For example, consider a situation where you make an initial request and
+the request times out. If you make the request again with the same
+request ID, the server can check if original operation with the same
+request ID was received, and if so, will ignore the second request. This
+prevents clients from accidentally creating duplicate commitments.
+
+The request ID must be
+a valid UUID with the exception that zero UUID is not supported
+(00000000-0000-0000-0000-000000000000).
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Represents an Operation resource.
+    #
+    # Google Compute Engine has three Operation resources:
+    #
+    # * [Global](/compute/docs/reference/rest/beta/globalOperations)
+    # * [Regional](/compute/docs/reference/rest/beta/regionOperations)
+    # * [Zonal](/compute/docs/reference/rest/beta/zoneOperations)
+    #
+    # You can use an operation resource to manage asynchronous API requests.
+    # For more information, readHandling
+    # API responses.
+    #
+    # Operations can be global, regional or zonal.
+    #
+    #    - For global operations, use the `globalOperations`
+    #    resource.
+    #    - For regional operations, use the
+    #    `regionOperations` resource.
+    #    - For zonal operations, use
+    #    the `zoneOperations` resource.
+    #
+    #
+    #
+    # For more information, read
+    # Global, Regional, and Zonal Resources.
+    #
+    # Note that completed Operation resources have a limited
+    # retention period.
+  "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request.
+      # Not present otherwise.
+  "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
+  "description": "A String", # [Output Only] A textual description of the operation, which is
+      # set when the operation is created.
+  "endTime": "A String", # [Output Only] The time that this operation was completed. This value is inRFC3339
+      # text format.
+  "error": { # [Output Only] If errors are generated during processing of the operation,
+      # this field will be populated.
+    "errors": [ # [Output Only] The array of errors encountered while processing this
+        # operation.
+      {
+        "code": "A String", # [Output Only] The error type identifier for this error.
+        "errorDetails": [ # [Output Only] An optional list of messages that contain the error
+            # details. There is a set of defined message types to use for providing
+            # details.The syntax depends on the error code. For example,
+            # QuotaExceededInfo will have details when the error code is
+            # QUOTA_EXCEEDED.
+          {
+            "errorInfo": { # Describes the cause of the error with structured details.
+                #
+                # Example of an error when contacting the "pubsub.googleapis.com" API when it
+                # is not enabled:
+                #
+                #     { "reason": "API_DISABLED"
+                #       "domain": "googleapis.com"
+                #       "metadata": {
+                #         "resource": "projects/123",
+                #         "service": "pubsub.googleapis.com"
+                #       }
+                #     }
+                #
+                # This response indicates that the pubsub.googleapis.com API is not enabled.
+                #
+                # Example of an error that is returned when attempting to create a Spanner
+                # instance in a region that is out of stock:
+                #
+                #     { "reason": "STOCKOUT"
+                #       "domain": "spanner.googleapis.com",
+                #       "metadata": {
+                #         "availableRegions": "us-central1,us-east2"
+                #       }
+                #     }
+              "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain
+                  # is typically the registered service name of the tool or product that
+                  # generates the error. Example: "pubsub.googleapis.com". If the error is
+                  # generated by some common infrastructure, the error domain must be a
+                  # globally unique value that identifies the infrastructure. For Google API
+                  # infrastructure, the error domain is "googleapis.com".
+              "metadatas": { # Additional structured details about this error.
+                  #
+                  # Keys must match a regular expression of `a-z+` but should
+                  # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
+                  # length. When identifying the current value of an exceeded limit, the units
+                  # should be contained in the key, not the value.  For example, rather than
+                  # `{"instanceLimit": "100/request"}`, should be returned as,
+                  # `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of
+                  # instances that can be created in a single (batch) request.
+                "a_key": "A String",
+              },
+              "reason": "A String", # The reason of the error. This is a constant value that identifies the
+                  # proximate cause of the error. Error reasons are unique within a particular
+                  # domain of errors. This should be at most 63 characters and match a
+                  # regular expression of `A-Z+[A-Z0-9]`, which represents
+                  # UPPER_SNAKE_CASE.
+            },
+            "help": { # Provides links to documentation or for performing an out of band action.
+                #
+                # For example, if a quota check failed with an error indicating the calling
+                # project hasn't enabled the accessed service, this can contain a URL pointing
+                # directly to the right place in the developer console to flip the bit.
+              "links": [ # URL(s) pointing to additional information on handling the current error.
+                { # Describes a URL link.
+                  "description": "A String", # Describes what the link offers.
+                  "url": "A String", # The URL of the link.
+                },
+              ],
+            },
+            "localizedMessage": { # Provides a localized error message that is safe to return to the user
+                # which can be attached to an RPC error.
+              "locale": "A String", # The locale used following the specification defined at
+                  # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
+                  # Examples are: "en-US", "fr-CH", "es-MX"
+              "message": "A String", # The localized error message in the above locale.
+            },
+            "quotaInfo": { # Additional details for quota exceeded error for resource quota.
+              "dimensions": { # The map holding related quota dimensions.
+                "a_key": "A String",
+              },
+              "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota
+                  #  type or metric.
+              "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type
+                  # or metric.
+              "limitName": "A String", # The name of the quota limit.
+              "metricName": "A String", # The Compute Engine quota metric name.
+              "rolloutStatus": "A String", # Rollout status of the future quota limit.
+            },
+          },
+        ],
+        "location": "A String", # [Output Only] Indicates the field in the request that caused the error.
+            # This property is optional.
+        "message": "A String", # [Output Only] An optional, human-readable error message.
+      },
+    ],
+  },
+  "getVersionOperationMetadata": {
+    "inlineSbomInfo": {
+      "currentComponentVersions": { # A mapping of components to their currently-applied versions or other
+          # appropriate identifiers.
+        "a_key": "A String",
+      },
+      "targetComponentVersions": { # A mapping of components to their target versions or other appropriate
+          # identifiers.
+        "a_key": "A String",
+      },
+    },
+  },
+  "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
+      # message that was returned, such as `NOT FOUND`.
+  "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
+      # status code that was returned. For example, a `404` means the
+      # resource was not found.
+  "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is
+      # defined by the server.
+  "insertTime": "A String", # [Output Only] The time that this operation was requested.
+      # This value is inRFC3339
+      # text format.
+  "instancesBulkInsertOperationMetadata": {
+    "perLocationStatus": { # Status information per location (location name is key).
+        # Example key: zones/us-central1-a
+      "a_key": {
+        "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far.
+        "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback.
+        "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an
+            # error.
+        "status": "A String", # [Output Only] Creation status of BulkInsert operation - information
+            # if the flow is rolling forward or rolling back.
+        "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created.
+      },
+    },
+  },
+  "kind": "compute#operation", # Output only. [Output Only] Type of the resource. Always `compute#operation` for
+      # Operation resources.
+  "name": "A String", # [Output Only] Name of the operation.
+  "operationGroupId": "A String", # Output only. [Output Only] An ID that represents a group of operations, such as when a
+      # group of operations results from a `bulkInsert` API request.
+  "operationType": "A String", # [Output Only] The type of operation, such as `insert`,
+      # `update`, or `delete`, and so on.
+  "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
+      # There is no requirement that this be linear or support any granularity of
+      # operations. This should not be used to guess when the operation will be
+      # complete. This number should monotonically increase as the operation
+      # progresses.
+  "region": "A String", # [Output Only] The URL of the region where the operation resides. Only
+      # applicable when performing regional operations.
+  "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+  "setCommonInstanceMetadataOperationMetadata": { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
+      # this field will contain information on all underlying zonal actions and
+      # their state.
+    "clientOperationId": "A String", # [Output Only] The client operation id.
+    "perLocationOperations": { # [Output Only] Status information per location (location name is key).
+        # Example key: zones/us-central1-a
+      "a_key": {
+        "error": { # The `Status` type defines a logical error model that is suitable for # [Output Only] If state is `ABANDONED` or `FAILED`, this field is
+            # populated.
+            # different programming environments, including REST APIs and RPC APIs. It is
+            # used by [gRPC](https://github.com/grpc). Each `Status` message contains
+            # three pieces of data: error code, error message, and error details.
+            #
+            # You can find out more about this error model and how to work with it in the
+            # [API Design Guide](https://cloud.google.com/apis/design/errors).
+          "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+          "details": [ # A list of messages that carry the error details.  There is a common set of
+              # message types for APIs to use.
+            {
+              "a_key": "", # Properties of the object. Contains field @type with type URL.
+            },
+          ],
+          "message": "A String", # A developer-facing error message, which should be in English. Any
+              # user-facing error message should be localized and sent in the
+              # google.rpc.Status.details field, or localized by the client.
+        },
+        "state": "A String", # [Output Only] Status of the action, which can be one of the following:
+            # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
+      },
+    },
+  },
+  "startTime": "A String", # [Output Only] The time that this operation was started by the server.
+      # This value is inRFC3339
+      # text format.
+  "status": "A String", # [Output Only] The status of the operation, which can be one of the
+      # following:
+      # `PENDING`, `RUNNING`, or `DONE`.
+  "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the
+      # operation.
+  "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation
+      # of the target resource.
+  "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For
+      # operations related to creating a snapshot, this points to the disk
+      # that the snapshot was created from.
+  "user": "A String", # [Output Only] User who requested the operation, for example:
+      # `user@example.com` or
+      # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
+  "warnings": [ # [Output Only] If warning messages are generated during processing of the
+      # operation, this field will be populated.
+    {
+      "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute
+          # Engine returns NO_RESULTS_ON_PAGE if there
+          # are no results in the response.
+      "data": [ # [Output Only] Metadata about this warning in key:
+          # value format. For example:
+          #
+          # "data": [
+          #   {
+          #    "key": "scope",
+          #    "value": "zones/us-east1-d"
+          #   }
+        {
+          "key": "A String", # [Output Only] A key that provides more detail on the warning being
+              # returned. For example, for warnings where there are no results in a list
+              # request for a particular zone, this key might be scope and
+              # the key value might be the zone name. Other examples might be a key
+              # indicating a deprecated resource and a suggested replacement, or a
+              # warning about invalid network settings (for example, if an instance
+              # attempts to perform IP forwarding but is not enabled for IP forwarding).
+          "value": "A String", # [Output Only] A warning data value corresponding to the key.
+        },
+      ],
+      "message": "A String", # [Output Only] A human-readable description of the warning code.
+    },
+  ],
+  "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only
+      # applicable when performing per-zone operations.
+}
+
+ +
+ resume(organization, rollout, etag=None, requestId=None, x__xgafv=None) +
Resumes a Rollout.
+
+Args:
+  organization: string, Required. Organization ID for this request. (required)
+  rollout: string, Required. Name of the Rollout resource to resume. (required)
+  etag: string, The etag of the Rollout.
+If this is provided, the request will only succeed if the etag matches
+the current etag of the Rollout.
+  requestId: string, An optional request ID to identify requests. Specify a unique request ID so
+that if you must retry your request, the server will know to ignore the
+request if it has already been completed.
+
+For example, consider a situation where you make an initial request and
+the request times out. If you make the request again with the same
+request ID, the server can check if original operation with the same
+request ID was received, and if so, will ignore the second request. This
+prevents clients from accidentally creating duplicate commitments.
+
+The request ID must be
+a valid UUID with the exception that zero UUID is not supported
+(00000000-0000-0000-0000-000000000000).
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Represents an Operation resource.
+    #
+    # Google Compute Engine has three Operation resources:
+    #
+    # * [Global](/compute/docs/reference/rest/beta/globalOperations)
+    # * [Regional](/compute/docs/reference/rest/beta/regionOperations)
+    # * [Zonal](/compute/docs/reference/rest/beta/zoneOperations)
+    #
+    # You can use an operation resource to manage asynchronous API requests.
+    # For more information, readHandling
+    # API responses.
+    #
+    # Operations can be global, regional or zonal.
+    #
+    #    - For global operations, use the `globalOperations`
+    #    resource.
+    #    - For regional operations, use the
+    #    `regionOperations` resource.
+    #    - For zonal operations, use
+    #    the `zoneOperations` resource.
+    #
+    #
+    #
+    # For more information, read
+    # Global, Regional, and Zonal Resources.
+    #
+    # Note that completed Operation resources have a limited
+    # retention period.
+  "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request.
+      # Not present otherwise.
+  "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
+  "description": "A String", # [Output Only] A textual description of the operation, which is
+      # set when the operation is created.
+  "endTime": "A String", # [Output Only] The time that this operation was completed. This value is inRFC3339
+      # text format.
+  "error": { # [Output Only] If errors are generated during processing of the operation,
+      # this field will be populated.
+    "errors": [ # [Output Only] The array of errors encountered while processing this
+        # operation.
+      {
+        "code": "A String", # [Output Only] The error type identifier for this error.
+        "errorDetails": [ # [Output Only] An optional list of messages that contain the error
+            # details. There is a set of defined message types to use for providing
+            # details.The syntax depends on the error code. For example,
+            # QuotaExceededInfo will have details when the error code is
+            # QUOTA_EXCEEDED.
+          {
+            "errorInfo": { # Describes the cause of the error with structured details.
+                #
+                # Example of an error when contacting the "pubsub.googleapis.com" API when it
+                # is not enabled:
+                #
+                #     { "reason": "API_DISABLED"
+                #       "domain": "googleapis.com"
+                #       "metadata": {
+                #         "resource": "projects/123",
+                #         "service": "pubsub.googleapis.com"
+                #       }
+                #     }
+                #
+                # This response indicates that the pubsub.googleapis.com API is not enabled.
+                #
+                # Example of an error that is returned when attempting to create a Spanner
+                # instance in a region that is out of stock:
+                #
+                #     { "reason": "STOCKOUT"
+                #       "domain": "spanner.googleapis.com",
+                #       "metadata": {
+                #         "availableRegions": "us-central1,us-east2"
+                #       }
+                #     }
+              "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain
+                  # is typically the registered service name of the tool or product that
+                  # generates the error. Example: "pubsub.googleapis.com". If the error is
+                  # generated by some common infrastructure, the error domain must be a
+                  # globally unique value that identifies the infrastructure. For Google API
+                  # infrastructure, the error domain is "googleapis.com".
+              "metadatas": { # Additional structured details about this error.
+                  #
+                  # Keys must match a regular expression of `a-z+` but should
+                  # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
+                  # length. When identifying the current value of an exceeded limit, the units
+                  # should be contained in the key, not the value.  For example, rather than
+                  # `{"instanceLimit": "100/request"}`, should be returned as,
+                  # `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of
+                  # instances that can be created in a single (batch) request.
+                "a_key": "A String",
+              },
+              "reason": "A String", # The reason of the error. This is a constant value that identifies the
+                  # proximate cause of the error. Error reasons are unique within a particular
+                  # domain of errors. This should be at most 63 characters and match a
+                  # regular expression of `A-Z+[A-Z0-9]`, which represents
+                  # UPPER_SNAKE_CASE.
+            },
+            "help": { # Provides links to documentation or for performing an out of band action.
+                #
+                # For example, if a quota check failed with an error indicating the calling
+                # project hasn't enabled the accessed service, this can contain a URL pointing
+                # directly to the right place in the developer console to flip the bit.
+              "links": [ # URL(s) pointing to additional information on handling the current error.
+                { # Describes a URL link.
+                  "description": "A String", # Describes what the link offers.
+                  "url": "A String", # The URL of the link.
+                },
+              ],
+            },
+            "localizedMessage": { # Provides a localized error message that is safe to return to the user
+                # which can be attached to an RPC error.
+              "locale": "A String", # The locale used following the specification defined at
+                  # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
+                  # Examples are: "en-US", "fr-CH", "es-MX"
+              "message": "A String", # The localized error message in the above locale.
+            },
+            "quotaInfo": { # Additional details for quota exceeded error for resource quota.
+              "dimensions": { # The map holding related quota dimensions.
+                "a_key": "A String",
+              },
+              "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota
+                  #  type or metric.
+              "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type
+                  # or metric.
+              "limitName": "A String", # The name of the quota limit.
+              "metricName": "A String", # The Compute Engine quota metric name.
+              "rolloutStatus": "A String", # Rollout status of the future quota limit.
+            },
+          },
+        ],
+        "location": "A String", # [Output Only] Indicates the field in the request that caused the error.
+            # This property is optional.
+        "message": "A String", # [Output Only] An optional, human-readable error message.
+      },
+    ],
+  },
+  "getVersionOperationMetadata": {
+    "inlineSbomInfo": {
+      "currentComponentVersions": { # A mapping of components to their currently-applied versions or other
+          # appropriate identifiers.
+        "a_key": "A String",
+      },
+      "targetComponentVersions": { # A mapping of components to their target versions or other appropriate
+          # identifiers.
+        "a_key": "A String",
+      },
+    },
+  },
+  "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
+      # message that was returned, such as `NOT FOUND`.
+  "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
+      # status code that was returned. For example, a `404` means the
+      # resource was not found.
+  "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is
+      # defined by the server.
+  "insertTime": "A String", # [Output Only] The time that this operation was requested.
+      # This value is inRFC3339
+      # text format.
+  "instancesBulkInsertOperationMetadata": {
+    "perLocationStatus": { # Status information per location (location name is key).
+        # Example key: zones/us-central1-a
+      "a_key": {
+        "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far.
+        "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback.
+        "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an
+            # error.
+        "status": "A String", # [Output Only] Creation status of BulkInsert operation - information
+            # if the flow is rolling forward or rolling back.
+        "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created.
+      },
+    },
+  },
+  "kind": "compute#operation", # Output only. [Output Only] Type of the resource. Always `compute#operation` for
+      # Operation resources.
+  "name": "A String", # [Output Only] Name of the operation.
+  "operationGroupId": "A String", # Output only. [Output Only] An ID that represents a group of operations, such as when a
+      # group of operations results from a `bulkInsert` API request.
+  "operationType": "A String", # [Output Only] The type of operation, such as `insert`,
+      # `update`, or `delete`, and so on.
+  "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
+      # There is no requirement that this be linear or support any granularity of
+      # operations. This should not be used to guess when the operation will be
+      # complete. This number should monotonically increase as the operation
+      # progresses.
+  "region": "A String", # [Output Only] The URL of the region where the operation resides. Only
+      # applicable when performing regional operations.
+  "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+  "setCommonInstanceMetadataOperationMetadata": { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
+      # this field will contain information on all underlying zonal actions and
+      # their state.
+    "clientOperationId": "A String", # [Output Only] The client operation id.
+    "perLocationOperations": { # [Output Only] Status information per location (location name is key).
+        # Example key: zones/us-central1-a
+      "a_key": {
+        "error": { # The `Status` type defines a logical error model that is suitable for # [Output Only] If state is `ABANDONED` or `FAILED`, this field is
+            # populated.
+            # different programming environments, including REST APIs and RPC APIs. It is
+            # used by [gRPC](https://github.com/grpc). Each `Status` message contains
+            # three pieces of data: error code, error message, and error details.
+            #
+            # You can find out more about this error model and how to work with it in the
+            # [API Design Guide](https://cloud.google.com/apis/design/errors).
+          "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+          "details": [ # A list of messages that carry the error details.  There is a common set of
+              # message types for APIs to use.
+            {
+              "a_key": "", # Properties of the object. Contains field @type with type URL.
+            },
+          ],
+          "message": "A String", # A developer-facing error message, which should be in English. Any
+              # user-facing error message should be localized and sent in the
+              # google.rpc.Status.details field, or localized by the client.
+        },
+        "state": "A String", # [Output Only] Status of the action, which can be one of the following:
+            # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
+      },
+    },
+  },
+  "startTime": "A String", # [Output Only] The time that this operation was started by the server.
+      # This value is inRFC3339
+      # text format.
+  "status": "A String", # [Output Only] The status of the operation, which can be one of the
+      # following:
+      # `PENDING`, `RUNNING`, or `DONE`.
+  "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the
+      # operation.
+  "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation
+      # of the target resource.
+  "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For
+      # operations related to creating a snapshot, this points to the disk
+      # that the snapshot was created from.
+  "user": "A String", # [Output Only] User who requested the operation, for example:
+      # `user@example.com` or
+      # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
+  "warnings": [ # [Output Only] If warning messages are generated during processing of the
+      # operation, this field will be populated.
+    {
+      "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute
+          # Engine returns NO_RESULTS_ON_PAGE if there
+          # are no results in the response.
+      "data": [ # [Output Only] Metadata about this warning in key:
+          # value format. For example:
+          #
+          # "data": [
+          #   {
+          #    "key": "scope",
+          #    "value": "zones/us-east1-d"
+          #   }
+        {
+          "key": "A String", # [Output Only] A key that provides more detail on the warning being
+              # returned. For example, for warnings where there are no results in a list
+              # request for a particular zone, this key might be scope and
+              # the key value might be the zone name. Other examples might be a key
+              # indicating a deprecated resource and a suggested replacement, or a
+              # warning about invalid network settings (for example, if an instance
+              # attempts to perform IP forwarding but is not enabled for IP forwarding).
+          "value": "A String", # [Output Only] A warning data value corresponding to the key.
+        },
+      ],
+      "message": "A String", # [Output Only] A human-readable description of the warning code.
+    },
+  ],
+  "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only
+      # applicable when performing per-zone operations.
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/compute_beta.regionBackendServices.html b/docs/dyn/compute_beta.regionBackendServices.html index 13dcbe3f0a..ce5530bd09 100644 --- a/docs/dyn/compute_beta.regionBackendServices.html +++ b/docs/dyn/compute_beta.regionBackendServices.html @@ -1321,6 +1321,16 @@

Method Details

# backend service. "enable": True or False, # Denotes whether to enable logging for the load balancer # traffic served by this backend service. The default value is false. + "loggingHttpRequestHeaders": [ # The list of request headers that will be logged to Stackdriver. + { # Determines which HTTP headers will be logged to Stackdriver. + "headerName": "A String", # The name of the header to be logged. + }, + ], + "loggingHttpResponseHeaders": [ # The list of response headers that will be logged to Stackdriver. + { # Determines which HTTP headers will be logged to Stackdriver. + "headerName": "A String", # The name of the header to be logged. + }, + ], "optionalFields": [ # This field can only be specified if logging is enabled for this backend # service and "logConfig.optionalMode" was set to CUSTOM. Contains a list # of optional fields you want to include in the logs. For example: @@ -3105,6 +3115,16 @@

Method Details

# backend service. "enable": True or False, # Denotes whether to enable logging for the load balancer # traffic served by this backend service. The default value is false. + "loggingHttpRequestHeaders": [ # The list of request headers that will be logged to Stackdriver. + { # Determines which HTTP headers will be logged to Stackdriver. + "headerName": "A String", # The name of the header to be logged. + }, + ], + "loggingHttpResponseHeaders": [ # The list of response headers that will be logged to Stackdriver. + { # Determines which HTTP headers will be logged to Stackdriver. + "headerName": "A String", # The name of the header to be logged. + }, + ], "optionalFields": [ # This field can only be specified if logging is enabled for this backend # service and "logConfig.optionalMode" was set to CUSTOM. Contains a list # of optional fields you want to include in the logs. For example: @@ -4838,6 +4858,16 @@

Method Details

# backend service. "enable": True or False, # Denotes whether to enable logging for the load balancer # traffic served by this backend service. The default value is false. + "loggingHttpRequestHeaders": [ # The list of request headers that will be logged to Stackdriver. + { # Determines which HTTP headers will be logged to Stackdriver. + "headerName": "A String", # The name of the header to be logged. + }, + ], + "loggingHttpResponseHeaders": [ # The list of response headers that will be logged to Stackdriver. + { # Determines which HTTP headers will be logged to Stackdriver. + "headerName": "A String", # The name of the header to be logged. + }, + ], "optionalFields": [ # This field can only be specified if logging is enabled for this backend # service and "logConfig.optionalMode" was set to CUSTOM. Contains a list # of optional fields you want to include in the logs. For example: @@ -6322,6 +6352,16 @@

Method Details

# backend service. "enable": True or False, # Denotes whether to enable logging for the load balancer # traffic served by this backend service. The default value is false. + "loggingHttpRequestHeaders": [ # The list of request headers that will be logged to Stackdriver. + { # Determines which HTTP headers will be logged to Stackdriver. + "headerName": "A String", # The name of the header to be logged. + }, + ], + "loggingHttpResponseHeaders": [ # The list of response headers that will be logged to Stackdriver. + { # Determines which HTTP headers will be logged to Stackdriver. + "headerName": "A String", # The name of the header to be logged. + }, + ], "optionalFields": [ # This field can only be specified if logging is enabled for this backend # service and "logConfig.optionalMode" was set to CUSTOM. Contains a list # of optional fields you want to include in the logs. For example: @@ -7747,6 +7787,16 @@

Method Details

# backend service. "enable": True or False, # Denotes whether to enable logging for the load balancer # traffic served by this backend service. The default value is false. + "loggingHttpRequestHeaders": [ # The list of request headers that will be logged to Stackdriver. + { # Determines which HTTP headers will be logged to Stackdriver. + "headerName": "A String", # The name of the header to be logged. + }, + ], + "loggingHttpResponseHeaders": [ # The list of response headers that will be logged to Stackdriver. + { # Determines which HTTP headers will be logged to Stackdriver. + "headerName": "A String", # The name of the header to be logged. + }, + ], "optionalFields": [ # This field can only be specified if logging is enabled for this backend # service and "logConfig.optionalMode" was set to CUSTOM. Contains a list # of optional fields you want to include in the logs. For example: @@ -10604,6 +10654,16 @@

Method Details

# backend service. "enable": True or False, # Denotes whether to enable logging for the load balancer # traffic served by this backend service. The default value is false. + "loggingHttpRequestHeaders": [ # The list of request headers that will be logged to Stackdriver. + { # Determines which HTTP headers will be logged to Stackdriver. + "headerName": "A String", # The name of the header to be logged. + }, + ], + "loggingHttpResponseHeaders": [ # The list of response headers that will be logged to Stackdriver. + { # Determines which HTTP headers will be logged to Stackdriver. + "headerName": "A String", # The name of the header to be logged. + }, + ], "optionalFields": [ # This field can only be specified if logging is enabled for this backend # service and "logConfig.optionalMode" was set to CUSTOM. Contains a list # of optional fields you want to include in the logs. For example: diff --git a/docs/dyn/compute_beta.regionInstanceGroupManagers.html b/docs/dyn/compute_beta.regionInstanceGroupManagers.html index ebe8ad2cbb..61ae601694 100644 --- a/docs/dyn/compute_beta.regionInstanceGroupManagers.html +++ b/docs/dyn/compute_beta.regionInstanceGroupManagers.html @@ -881,6 +881,9 @@

Method Details

"allInstances": True or False, # Flag to update all instances instead of specified list of “instances”. # If the flag is set to true then the instances may not be specified # in the request. + "allowedActions": [ # Actions that are allowed to update instances within MIG. + "A String", + ], "instances": [ # The list of URLs of one or more instances for which you want to apply # updates. Each URL can be a full URL or a partial URL, such aszones/[ZONE]/instances/[INSTANCE_NAME]. "A String", @@ -2588,6 +2591,8 @@

Method Details

# pools for the instance. "restarting": 42, # Output only. The number of instances in the managed instance group that # are scheduled to be restarted or are currently being restarted. + "restartingInPlace": 42, # Output only. The number of instances in the managed instance group that + # are scheduled to be restarted or are currently being restarted. "resuming": 42, # Output only. The number of instances in the managed instance group that # are scheduled to be resumed or are currently being resumed. "starting": 42, # Output only. The number of instances in the managed instance group that @@ -3585,6 +3590,9 @@

Method Details

# - Manually change the targetSuspendedSize using the update # method. "updatePolicy": { # The update policy for this managed instance group. + "allowedActions": [ # Actions that are allowed to update instances within MIG. + "A String", + ], "instanceRedistributionType": "A String", # The # instance redistribution policy for regional managed instance groups. # Valid values are: @@ -3846,6 +3854,8 @@

Method Details

# pools for the instance. "restarting": 42, # Output only. The number of instances in the managed instance group that # are scheduled to be restarted or are currently being restarted. + "restartingInPlace": 42, # Output only. The number of instances in the managed instance group that + # are scheduled to be restarted or are currently being restarted. "resuming": 42, # Output only. The number of instances in the managed instance group that # are scheduled to be resumed or are currently being resumed. "starting": 42, # Output only. The number of instances in the managed instance group that @@ -4843,6 +4853,9 @@

Method Details

# - Manually change the targetSuspendedSize using the update # method. "updatePolicy": { # The update policy for this managed instance group. + "allowedActions": [ # Actions that are allowed to update instances within MIG. + "A String", + ], "instanceRedistributionType": "A String", # The # instance redistribution policy for regional managed instance groups. # Valid values are: @@ -5472,6 +5485,8 @@

Method Details

# pools for the instance. "restarting": 42, # Output only. The number of instances in the managed instance group that # are scheduled to be restarted or are currently being restarted. + "restartingInPlace": 42, # Output only. The number of instances in the managed instance group that + # are scheduled to be restarted or are currently being restarted. "resuming": 42, # Output only. The number of instances in the managed instance group that # are scheduled to be resumed or are currently being resumed. "starting": 42, # Output only. The number of instances in the managed instance group that @@ -6469,6 +6484,9 @@

Method Details

# - Manually change the targetSuspendedSize using the update # method. "updatePolicy": { # The update policy for this managed instance group. + "allowedActions": [ # Actions that are allowed to update instances within MIG. + "A String", + ], "instanceRedistributionType": "A String", # The # instance redistribution policy for regional managed instance groups. # Valid values are: @@ -6765,18 +6783,18 @@

Method Details

{ "items": [ # [Output Only] The list of errors of the managed instance group. { - "error": { # Output only. [Output Only] Contents of the error. - "code": "A String", # Output only. [Output Only] Error code. - "message": "A String", # Output only. [Output Only] Error message. + "error": { # Output only. Contents of the error. + "code": "A String", # Output only. Error code. + "message": "A String", # Output only. Error message. }, - "instanceActionDetails": { # Output only. [Output Only] Details of the instance action that triggered this error. + "instanceActionDetails": { # Output only. Details of the instance action that triggered this error. # May be null, if the error was not caused by an action on an instance. # This field is optional. - "action": "A String", # Output only. [Output Only] Action that managed instance group was executing on - # the instance when the error occurred. Possible values: - "instance": "A String", # Output only. [Output Only] The URL of the instance. - # The URL can be set even if the instance has not yet been created. - "version": { # Output only. [Output Only] Version this instance was created from, or was being + "action": "A String", # Output only. Action that managed instance group was executing on the instance when the + # error occurred. Possible values: + "instance": "A String", # Output only. The URL of the instance. The URL can be set even if the instance has not + # yet been created. + "version": { # Output only. Version this instance was created from, or was being # created from, but the creation failed. Corresponds to one of the versions # that were set on the Instance Group Manager resource at the time this # instance was being created. @@ -6785,8 +6803,7 @@

Method Details

"name": "A String", # Output only. [Output Only] Name of the version. }, }, - "timestamp": "A String", # Output only. [Output Only] The time that this error occurred. - # This value is in RFC3339 text format. + "timestamp": "A String", # Output only. The time that this error occurred. This value is in RFC3339 text format. }, ], "nextPageToken": "A String", # Output only. [Output Only] This token allows you to get the next page of results for @@ -8034,6 +8051,8 @@

Method Details

# pools for the instance. "restarting": 42, # Output only. The number of instances in the managed instance group that # are scheduled to be restarted or are currently being restarted. + "restartingInPlace": 42, # Output only. The number of instances in the managed instance group that + # are scheduled to be restarted or are currently being restarted. "resuming": 42, # Output only. The number of instances in the managed instance group that # are scheduled to be resumed or are currently being resumed. "starting": 42, # Output only. The number of instances in the managed instance group that @@ -9031,6 +9050,9 @@

Method Details

# - Manually change the targetSuspendedSize using the update # method. "updatePolicy": { # The update policy for this managed instance group. + "allowedActions": [ # Actions that are allowed to update instances within MIG. + "A String", + ], "instanceRedistributionType": "A String", # The # instance redistribution policy for regional managed instance groups. # Valid values are: @@ -13166,6 +13188,8 @@

Method Details

# pools for the instance. "restarting": 42, # Output only. The number of instances in the managed instance group that # are scheduled to be restarted or are currently being restarted. + "restartingInPlace": 42, # Output only. The number of instances in the managed instance group that + # are scheduled to be restarted or are currently being restarted. "resuming": 42, # Output only. The number of instances in the managed instance group that # are scheduled to be resumed or are currently being resumed. "starting": 42, # Output only. The number of instances in the managed instance group that @@ -14163,6 +14187,9 @@

Method Details

# - Manually change the targetSuspendedSize using the update # method. "updatePolicy": { # The update policy for this managed instance group. + "allowedActions": [ # Actions that are allowed to update instances within MIG. + "A String", + ], "instanceRedistributionType": "A String", # The # instance redistribution policy for regional managed instance groups. # Valid values are: diff --git a/docs/dyn/compute_beta.regionUrlMaps.html b/docs/dyn/compute_beta.regionUrlMaps.html index f917bf45ed..55a1235fd2 100644 --- a/docs/dyn/compute_beta.regionUrlMaps.html +++ b/docs/dyn/compute_beta.regionUrlMaps.html @@ -868,6 +868,17 @@

Method Details

# The value must be from 0.0 to 100.0 inclusive. }, }, + "imageOptimizationPolicy": { # The configuration for Cloud CDN's image optimization feature. This feature # Image optimization policy for this URL Map's route. Available only for + # Global EXTERNAL_MANAGED load balancer schemes. + # Either Cloud CDN must be enabled on the backend service or backend bucket + # serving the route, or cache policy must be configured on the same route + # dynamically processes and delivers images from the network edge. + # Image Optimization is only available for Global External Application Load + # Balancers. + # Either Cloud CDN must be enabled on the backend service or backend bucket + # serving the route, or cache policy must be configured on the same route. + "queryParameterInterpretation": "A String", # Specifies whether to interpret query parameters for image optimization. + }, "maxStreamDuration": { # A Duration represents a fixed-length span of time represented # Specifies the maximum duration (timeout) for streams on the selected route. # Unlike the timeout field where the timeout duration starts # from the time the request has been fully processed (known as*end-of-stream*), @@ -1714,6 +1725,17 @@

Method Details

# The value must be from 0.0 to 100.0 inclusive. }, }, + "imageOptimizationPolicy": { # The configuration for Cloud CDN's image optimization feature. This feature # Image optimization policy for this URL Map's route. Available only for + # Global EXTERNAL_MANAGED load balancer schemes. + # Either Cloud CDN must be enabled on the backend service or backend bucket + # serving the route, or cache policy must be configured on the same route + # dynamically processes and delivers images from the network edge. + # Image Optimization is only available for Global External Application Load + # Balancers. + # Either Cloud CDN must be enabled on the backend service or backend bucket + # serving the route, or cache policy must be configured on the same route. + "queryParameterInterpretation": "A String", # Specifies whether to interpret query parameters for image optimization. + }, "maxStreamDuration": { # A Duration represents a fixed-length span of time represented # Specifies the maximum duration (timeout) for streams on the selected route. # Unlike the timeout field where the timeout duration starts # from the time the request has been fully processed (known as*end-of-stream*), @@ -2541,6 +2563,17 @@

Method Details

# The value must be from 0.0 to 100.0 inclusive. }, }, + "imageOptimizationPolicy": { # The configuration for Cloud CDN's image optimization feature. This feature # Image optimization policy for this URL Map's route. Available only for + # Global EXTERNAL_MANAGED load balancer schemes. + # Either Cloud CDN must be enabled on the backend service or backend bucket + # serving the route, or cache policy must be configured on the same route + # dynamically processes and delivers images from the network edge. + # Image Optimization is only available for Global External Application Load + # Balancers. + # Either Cloud CDN must be enabled on the backend service or backend bucket + # serving the route, or cache policy must be configured on the same route. + "queryParameterInterpretation": "A String", # Specifies whether to interpret query parameters for image optimization. + }, "maxStreamDuration": { # A Duration represents a fixed-length span of time represented # Specifies the maximum duration (timeout) for streams on the selected route. # Unlike the timeout field where the timeout duration starts # from the time the request has been fully processed (known as*end-of-stream*), @@ -3630,6 +3663,17 @@

Method Details

# The value must be from 0.0 to 100.0 inclusive. }, }, + "imageOptimizationPolicy": { # The configuration for Cloud CDN's image optimization feature. This feature # Image optimization policy for this URL Map's route. Available only for + # Global EXTERNAL_MANAGED load balancer schemes. + # Either Cloud CDN must be enabled on the backend service or backend bucket + # serving the route, or cache policy must be configured on the same route + # dynamically processes and delivers images from the network edge. + # Image Optimization is only available for Global External Application Load + # Balancers. + # Either Cloud CDN must be enabled on the backend service or backend bucket + # serving the route, or cache policy must be configured on the same route. + "queryParameterInterpretation": "A String", # Specifies whether to interpret query parameters for image optimization. + }, "maxStreamDuration": { # A Duration represents a fixed-length span of time represented # Specifies the maximum duration (timeout) for streams on the selected route. # Unlike the timeout field where the timeout duration starts # from the time the request has been fully processed (known as*end-of-stream*), @@ -4476,6 +4520,17 @@

Method Details

# The value must be from 0.0 to 100.0 inclusive. }, }, + "imageOptimizationPolicy": { # The configuration for Cloud CDN's image optimization feature. This feature # Image optimization policy for this URL Map's route. Available only for + # Global EXTERNAL_MANAGED load balancer schemes. + # Either Cloud CDN must be enabled on the backend service or backend bucket + # serving the route, or cache policy must be configured on the same route + # dynamically processes and delivers images from the network edge. + # Image Optimization is only available for Global External Application Load + # Balancers. + # Either Cloud CDN must be enabled on the backend service or backend bucket + # serving the route, or cache policy must be configured on the same route. + "queryParameterInterpretation": "A String", # Specifies whether to interpret query parameters for image optimization. + }, "maxStreamDuration": { # A Duration represents a fixed-length span of time represented # Specifies the maximum duration (timeout) for streams on the selected route. # Unlike the timeout field where the timeout duration starts # from the time the request has been fully processed (known as*end-of-stream*), @@ -5322,6 +5377,17 @@

Method Details

# The value must be from 0.0 to 100.0 inclusive. }, }, + "imageOptimizationPolicy": { # The configuration for Cloud CDN's image optimization feature. This feature # Image optimization policy for this URL Map's route. Available only for + # Global EXTERNAL_MANAGED load balancer schemes. + # Either Cloud CDN must be enabled on the backend service or backend bucket + # serving the route, or cache policy must be configured on the same route + # dynamically processes and delivers images from the network edge. + # Image Optimization is only available for Global External Application Load + # Balancers. + # Either Cloud CDN must be enabled on the backend service or backend bucket + # serving the route, or cache policy must be configured on the same route. + "queryParameterInterpretation": "A String", # Specifies whether to interpret query parameters for image optimization. + }, "maxStreamDuration": { # A Duration represents a fixed-length span of time represented # Specifies the maximum duration (timeout) for streams on the selected route. # Unlike the timeout field where the timeout duration starts # from the time the request has been fully processed (known as*end-of-stream*), @@ -6149,6 +6215,17 @@

Method Details

# The value must be from 0.0 to 100.0 inclusive. }, }, + "imageOptimizationPolicy": { # The configuration for Cloud CDN's image optimization feature. This feature # Image optimization policy for this URL Map's route. Available only for + # Global EXTERNAL_MANAGED load balancer schemes. + # Either Cloud CDN must be enabled on the backend service or backend bucket + # serving the route, or cache policy must be configured on the same route + # dynamically processes and delivers images from the network edge. + # Image Optimization is only available for Global External Application Load + # Balancers. + # Either Cloud CDN must be enabled on the backend service or backend bucket + # serving the route, or cache policy must be configured on the same route. + "queryParameterInterpretation": "A String", # Specifies whether to interpret query parameters for image optimization. + }, "maxStreamDuration": { # A Duration represents a fixed-length span of time represented # Specifies the maximum duration (timeout) for streams on the selected route. # Unlike the timeout field where the timeout duration starts # from the time the request has been fully processed (known as*end-of-stream*), @@ -7238,6 +7315,17 @@

Method Details

# The value must be from 0.0 to 100.0 inclusive. }, }, + "imageOptimizationPolicy": { # The configuration for Cloud CDN's image optimization feature. This feature # Image optimization policy for this URL Map's route. Available only for + # Global EXTERNAL_MANAGED load balancer schemes. + # Either Cloud CDN must be enabled on the backend service or backend bucket + # serving the route, or cache policy must be configured on the same route + # dynamically processes and delivers images from the network edge. + # Image Optimization is only available for Global External Application Load + # Balancers. + # Either Cloud CDN must be enabled on the backend service or backend bucket + # serving the route, or cache policy must be configured on the same route. + "queryParameterInterpretation": "A String", # Specifies whether to interpret query parameters for image optimization. + }, "maxStreamDuration": { # A Duration represents a fixed-length span of time represented # Specifies the maximum duration (timeout) for streams on the selected route. # Unlike the timeout field where the timeout duration starts # from the time the request has been fully processed (known as*end-of-stream*), @@ -8757,6 +8845,17 @@

Method Details

# The value must be from 0.0 to 100.0 inclusive. }, }, + "imageOptimizationPolicy": { # The configuration for Cloud CDN's image optimization feature. This feature # Image optimization policy for this URL Map's route. Available only for + # Global EXTERNAL_MANAGED load balancer schemes. + # Either Cloud CDN must be enabled on the backend service or backend bucket + # serving the route, or cache policy must be configured on the same route + # dynamically processes and delivers images from the network edge. + # Image Optimization is only available for Global External Application Load + # Balancers. + # Either Cloud CDN must be enabled on the backend service or backend bucket + # serving the route, or cache policy must be configured on the same route. + "queryParameterInterpretation": "A String", # Specifies whether to interpret query parameters for image optimization. + }, "maxStreamDuration": { # A Duration represents a fixed-length span of time represented # Specifies the maximum duration (timeout) for streams on the selected route. # Unlike the timeout field where the timeout duration starts # from the time the request has been fully processed (known as*end-of-stream*), @@ -9603,6 +9702,17 @@

Method Details

# The value must be from 0.0 to 100.0 inclusive. }, }, + "imageOptimizationPolicy": { # The configuration for Cloud CDN's image optimization feature. This feature # Image optimization policy for this URL Map's route. Available only for + # Global EXTERNAL_MANAGED load balancer schemes. + # Either Cloud CDN must be enabled on the backend service or backend bucket + # serving the route, or cache policy must be configured on the same route + # dynamically processes and delivers images from the network edge. + # Image Optimization is only available for Global External Application Load + # Balancers. + # Either Cloud CDN must be enabled on the backend service or backend bucket + # serving the route, or cache policy must be configured on the same route. + "queryParameterInterpretation": "A String", # Specifies whether to interpret query parameters for image optimization. + }, "maxStreamDuration": { # A Duration represents a fixed-length span of time represented # Specifies the maximum duration (timeout) for streams on the selected route. # Unlike the timeout field where the timeout duration starts # from the time the request has been fully processed (known as*end-of-stream*), @@ -10430,6 +10540,17 @@

Method Details

# The value must be from 0.0 to 100.0 inclusive. }, }, + "imageOptimizationPolicy": { # The configuration for Cloud CDN's image optimization feature. This feature # Image optimization policy for this URL Map's route. Available only for + # Global EXTERNAL_MANAGED load balancer schemes. + # Either Cloud CDN must be enabled on the backend service or backend bucket + # serving the route, or cache policy must be configured on the same route + # dynamically processes and delivers images from the network edge. + # Image Optimization is only available for Global External Application Load + # Balancers. + # Either Cloud CDN must be enabled on the backend service or backend bucket + # serving the route, or cache policy must be configured on the same route. + "queryParameterInterpretation": "A String", # Specifies whether to interpret query parameters for image optimization. + }, "maxStreamDuration": { # A Duration represents a fixed-length span of time represented # Specifies the maximum duration (timeout) for streams on the selected route. # Unlike the timeout field where the timeout duration starts # from the time the request has been fully processed (known as*end-of-stream*), @@ -11519,6 +11640,17 @@

Method Details

# The value must be from 0.0 to 100.0 inclusive. }, }, + "imageOptimizationPolicy": { # The configuration for Cloud CDN's image optimization feature. This feature # Image optimization policy for this URL Map's route. Available only for + # Global EXTERNAL_MANAGED load balancer schemes. + # Either Cloud CDN must be enabled on the backend service or backend bucket + # serving the route, or cache policy must be configured on the same route + # dynamically processes and delivers images from the network edge. + # Image Optimization is only available for Global External Application Load + # Balancers. + # Either Cloud CDN must be enabled on the backend service or backend bucket + # serving the route, or cache policy must be configured on the same route. + "queryParameterInterpretation": "A String", # Specifies whether to interpret query parameters for image optimization. + }, "maxStreamDuration": { # A Duration represents a fixed-length span of time represented # Specifies the maximum duration (timeout) for streams on the selected route. # Unlike the timeout field where the timeout duration starts # from the time the request has been fully processed (known as*end-of-stream*), @@ -12416,6 +12548,17 @@

Method Details

# The value must be from 0.0 to 100.0 inclusive. }, }, + "imageOptimizationPolicy": { # The configuration for Cloud CDN's image optimization feature. This feature # Image optimization policy for this URL Map's route. Available only for + # Global EXTERNAL_MANAGED load balancer schemes. + # Either Cloud CDN must be enabled on the backend service or backend bucket + # serving the route, or cache policy must be configured on the same route + # dynamically processes and delivers images from the network edge. + # Image Optimization is only available for Global External Application Load + # Balancers. + # Either Cloud CDN must be enabled on the backend service or backend bucket + # serving the route, or cache policy must be configured on the same route. + "queryParameterInterpretation": "A String", # Specifies whether to interpret query parameters for image optimization. + }, "maxStreamDuration": { # A Duration represents a fixed-length span of time represented # Specifies the maximum duration (timeout) for streams on the selected route. # Unlike the timeout field where the timeout duration starts # from the time the request has been fully processed (known as*end-of-stream*), @@ -13262,6 +13405,17 @@

Method Details

# The value must be from 0.0 to 100.0 inclusive. }, }, + "imageOptimizationPolicy": { # The configuration for Cloud CDN's image optimization feature. This feature # Image optimization policy for this URL Map's route. Available only for + # Global EXTERNAL_MANAGED load balancer schemes. + # Either Cloud CDN must be enabled on the backend service or backend bucket + # serving the route, or cache policy must be configured on the same route + # dynamically processes and delivers images from the network edge. + # Image Optimization is only available for Global External Application Load + # Balancers. + # Either Cloud CDN must be enabled on the backend service or backend bucket + # serving the route, or cache policy must be configured on the same route. + "queryParameterInterpretation": "A String", # Specifies whether to interpret query parameters for image optimization. + }, "maxStreamDuration": { # A Duration represents a fixed-length span of time represented # Specifies the maximum duration (timeout) for streams on the selected route. # Unlike the timeout field where the timeout duration starts # from the time the request has been fully processed (known as*end-of-stream*), @@ -14089,6 +14243,17 @@

Method Details

# The value must be from 0.0 to 100.0 inclusive. }, }, + "imageOptimizationPolicy": { # The configuration for Cloud CDN's image optimization feature. This feature # Image optimization policy for this URL Map's route. Available only for + # Global EXTERNAL_MANAGED load balancer schemes. + # Either Cloud CDN must be enabled on the backend service or backend bucket + # serving the route, or cache policy must be configured on the same route + # dynamically processes and delivers images from the network edge. + # Image Optimization is only available for Global External Application Load + # Balancers. + # Either Cloud CDN must be enabled on the backend service or backend bucket + # serving the route, or cache policy must be configured on the same route. + "queryParameterInterpretation": "A String", # Specifies whether to interpret query parameters for image optimization. + }, "maxStreamDuration": { # A Duration represents a fixed-length span of time represented # Specifies the maximum duration (timeout) for streams on the selected route. # Unlike the timeout field where the timeout duration starts # from the time the request has been fully processed (known as*end-of-stream*), @@ -15178,6 +15343,17 @@

Method Details

# The value must be from 0.0 to 100.0 inclusive. }, }, + "imageOptimizationPolicy": { # The configuration for Cloud CDN's image optimization feature. This feature # Image optimization policy for this URL Map's route. Available only for + # Global EXTERNAL_MANAGED load balancer schemes. + # Either Cloud CDN must be enabled on the backend service or backend bucket + # serving the route, or cache policy must be configured on the same route + # dynamically processes and delivers images from the network edge. + # Image Optimization is only available for Global External Application Load + # Balancers. + # Either Cloud CDN must be enabled on the backend service or backend bucket + # serving the route, or cache policy must be configured on the same route. + "queryParameterInterpretation": "A String", # Specifies whether to interpret query parameters for image optimization. + }, "maxStreamDuration": { # A Duration represents a fixed-length span of time represented # Specifies the maximum duration (timeout) for streams on the selected route. # Unlike the timeout field where the timeout duration starts # from the time the request has been fully processed (known as*end-of-stream*), @@ -16332,6 +16508,17 @@

Method Details

# The value must be from 0.0 to 100.0 inclusive. }, }, + "imageOptimizationPolicy": { # The configuration for Cloud CDN's image optimization feature. This feature # Image optimization policy for this URL Map's route. Available only for + # Global EXTERNAL_MANAGED load balancer schemes. + # Either Cloud CDN must be enabled on the backend service or backend bucket + # serving the route, or cache policy must be configured on the same route + # dynamically processes and delivers images from the network edge. + # Image Optimization is only available for Global External Application Load + # Balancers. + # Either Cloud CDN must be enabled on the backend service or backend bucket + # serving the route, or cache policy must be configured on the same route. + "queryParameterInterpretation": "A String", # Specifies whether to interpret query parameters for image optimization. + }, "maxStreamDuration": { # A Duration represents a fixed-length span of time represented # Specifies the maximum duration (timeout) for streams on the selected route. # Unlike the timeout field where the timeout duration starts # from the time the request has been fully processed (known as*end-of-stream*), @@ -17178,6 +17365,17 @@

Method Details

# The value must be from 0.0 to 100.0 inclusive. }, }, + "imageOptimizationPolicy": { # The configuration for Cloud CDN's image optimization feature. This feature # Image optimization policy for this URL Map's route. Available only for + # Global EXTERNAL_MANAGED load balancer schemes. + # Either Cloud CDN must be enabled on the backend service or backend bucket + # serving the route, or cache policy must be configured on the same route + # dynamically processes and delivers images from the network edge. + # Image Optimization is only available for Global External Application Load + # Balancers. + # Either Cloud CDN must be enabled on the backend service or backend bucket + # serving the route, or cache policy must be configured on the same route. + "queryParameterInterpretation": "A String", # Specifies whether to interpret query parameters for image optimization. + }, "maxStreamDuration": { # A Duration represents a fixed-length span of time represented # Specifies the maximum duration (timeout) for streams on the selected route. # Unlike the timeout field where the timeout duration starts # from the time the request has been fully processed (known as*end-of-stream*), @@ -18005,6 +18203,17 @@

Method Details

# The value must be from 0.0 to 100.0 inclusive. }, }, + "imageOptimizationPolicy": { # The configuration for Cloud CDN's image optimization feature. This feature # Image optimization policy for this URL Map's route. Available only for + # Global EXTERNAL_MANAGED load balancer schemes. + # Either Cloud CDN must be enabled on the backend service or backend bucket + # serving the route, or cache policy must be configured on the same route + # dynamically processes and delivers images from the network edge. + # Image Optimization is only available for Global External Application Load + # Balancers. + # Either Cloud CDN must be enabled on the backend service or backend bucket + # serving the route, or cache policy must be configured on the same route. + "queryParameterInterpretation": "A String", # Specifies whether to interpret query parameters for image optimization. + }, "maxStreamDuration": { # A Duration represents a fixed-length span of time represented # Specifies the maximum duration (timeout) for streams on the selected route. # Unlike the timeout field where the timeout duration starts # from the time the request has been fully processed (known as*end-of-stream*), @@ -19094,6 +19303,17 @@

Method Details

# The value must be from 0.0 to 100.0 inclusive. }, }, + "imageOptimizationPolicy": { # The configuration for Cloud CDN's image optimization feature. This feature # Image optimization policy for this URL Map's route. Available only for + # Global EXTERNAL_MANAGED load balancer schemes. + # Either Cloud CDN must be enabled on the backend service or backend bucket + # serving the route, or cache policy must be configured on the same route + # dynamically processes and delivers images from the network edge. + # Image Optimization is only available for Global External Application Load + # Balancers. + # Either Cloud CDN must be enabled on the backend service or backend bucket + # serving the route, or cache policy must be configured on the same route. + "queryParameterInterpretation": "A String", # Specifies whether to interpret query parameters for image optimization. + }, "maxStreamDuration": { # A Duration represents a fixed-length span of time represented # Specifies the maximum duration (timeout) for streams on the selected route. # Unlike the timeout field where the timeout duration starts # from the time the request has been fully processed (known as*end-of-stream*), @@ -20216,6 +20436,17 @@

Method Details

# The value must be from 0.0 to 100.0 inclusive. }, }, + "imageOptimizationPolicy": { # The configuration for Cloud CDN's image optimization feature. This feature # Image optimization policy for this URL Map's route. Available only for + # Global EXTERNAL_MANAGED load balancer schemes. + # Either Cloud CDN must be enabled on the backend service or backend bucket + # serving the route, or cache policy must be configured on the same route + # dynamically processes and delivers images from the network edge. + # Image Optimization is only available for Global External Application Load + # Balancers. + # Either Cloud CDN must be enabled on the backend service or backend bucket + # serving the route, or cache policy must be configured on the same route. + "queryParameterInterpretation": "A String", # Specifies whether to interpret query parameters for image optimization. + }, "maxStreamDuration": { # A Duration represents a fixed-length span of time represented # Specifies the maximum duration (timeout) for streams on the selected route. # Unlike the timeout field where the timeout duration starts # from the time the request has been fully processed (known as*end-of-stream*), @@ -21062,6 +21293,17 @@

Method Details

# The value must be from 0.0 to 100.0 inclusive. }, }, + "imageOptimizationPolicy": { # The configuration for Cloud CDN's image optimization feature. This feature # Image optimization policy for this URL Map's route. Available only for + # Global EXTERNAL_MANAGED load balancer schemes. + # Either Cloud CDN must be enabled on the backend service or backend bucket + # serving the route, or cache policy must be configured on the same route + # dynamically processes and delivers images from the network edge. + # Image Optimization is only available for Global External Application Load + # Balancers. + # Either Cloud CDN must be enabled on the backend service or backend bucket + # serving the route, or cache policy must be configured on the same route. + "queryParameterInterpretation": "A String", # Specifies whether to interpret query parameters for image optimization. + }, "maxStreamDuration": { # A Duration represents a fixed-length span of time represented # Specifies the maximum duration (timeout) for streams on the selected route. # Unlike the timeout field where the timeout duration starts # from the time the request has been fully processed (known as*end-of-stream*), @@ -21889,6 +22131,17 @@

Method Details

# The value must be from 0.0 to 100.0 inclusive. }, }, + "imageOptimizationPolicy": { # The configuration for Cloud CDN's image optimization feature. This feature # Image optimization policy for this URL Map's route. Available only for + # Global EXTERNAL_MANAGED load balancer schemes. + # Either Cloud CDN must be enabled on the backend service or backend bucket + # serving the route, or cache policy must be configured on the same route + # dynamically processes and delivers images from the network edge. + # Image Optimization is only available for Global External Application Load + # Balancers. + # Either Cloud CDN must be enabled on the backend service or backend bucket + # serving the route, or cache policy must be configured on the same route. + "queryParameterInterpretation": "A String", # Specifies whether to interpret query parameters for image optimization. + }, "maxStreamDuration": { # A Duration represents a fixed-length span of time represented # Specifies the maximum duration (timeout) for streams on the selected route. # Unlike the timeout field where the timeout duration starts # from the time the request has been fully processed (known as*end-of-stream*), @@ -22978,6 +23231,17 @@

Method Details

# The value must be from 0.0 to 100.0 inclusive. }, }, + "imageOptimizationPolicy": { # The configuration for Cloud CDN's image optimization feature. This feature # Image optimization policy for this URL Map's route. Available only for + # Global EXTERNAL_MANAGED load balancer schemes. + # Either Cloud CDN must be enabled on the backend service or backend bucket + # serving the route, or cache policy must be configured on the same route + # dynamically processes and delivers images from the network edge. + # Image Optimization is only available for Global External Application Load + # Balancers. + # Either Cloud CDN must be enabled on the backend service or backend bucket + # serving the route, or cache policy must be configured on the same route. + "queryParameterInterpretation": "A String", # Specifies whether to interpret query parameters for image optimization. + }, "maxStreamDuration": { # A Duration represents a fixed-length span of time represented # Specifies the maximum duration (timeout) for streams on the selected route. # Unlike the timeout field where the timeout duration starts # from the time the request has been fully processed (known as*end-of-stream*), diff --git a/docs/dyn/compute_beta.regionZones.html b/docs/dyn/compute_beta.regionZones.html index f690e40dac..42ca22ead6 100644 --- a/docs/dyn/compute_beta.regionZones.html +++ b/docs/dyn/compute_beta.regionZones.html @@ -250,6 +250,114 @@

Method Details

# zones. "name": "A String", # [Output Only] Name of the resource. "region": "A String", # [Output Only] Full URL reference to the region which hosts the zone. + "resourceStatus": { + "upcomingMaintenances": [ # Output only. [Output Only] The upcoming maintenance schedule. + { # The periodic partial maintenance schedule includes 52 weeks worth of + # maintenance windows. + # LINT.IfChange(PeriodicPartialMaintenanceSchedule) + "subType": "A String", # The maintenance type in which the zone is during the given window. + "targetResource": "A String", # The target resource that the maintenance window is for. + # For example, "projects/my-project/zones/us-central1-a". + "type": "A String", + "windowEndTime": { # Represents civil time (or occasionally physical time). # The end civil timestamp of the window (not inclusive). + # This contains a time zone. + # + # This type can represent a civil time in one of a few possible ways: + # + # * When utc_offset is set and time_zone is unset: a civil time on a calendar + # day with a particular offset from UTC. + # * When time_zone is set and utc_offset is unset: a civil time on a calendar + # day in a particular time zone. + # * When neither time_zone nor utc_offset is set: a civil time on a calendar + # day in local time. + # + # The date is relative to the Proleptic Gregorian Calendar. + # + # If year, month, or day are 0, the DateTime is considered not to have a + # specific year, month, or day respectively. + # + # This type may also be used to represent a physical time if all the date and + # time fields are set and either case of the `time_offset` oneof is set. + # Consider using `Timestamp` message for physical time instead. If your use + # case also would like to store the user's timezone, that can be done in + # another field. + # + # This type is more flexible than some applications may want. Make sure to + # document and validate your application's limitations. + "day": 42, # Optional. Day of month. Must be from 1 to 31 and valid for the year and + # month, or 0 if specifying a datetime without a day. + "hours": 42, # Optional. Hours of day in 24 hour format. Should be from 0 to 23, defaults + # to 0 (midnight). An API may choose to allow the value "24:00:00" for + # scenarios like business closing time. + "minutes": 42, # Optional. Minutes of hour of day. Must be from 0 to 59, defaults to 0. + "month": 42, # Optional. Month of year. Must be from 1 to 12, or 0 if specifying a + # datetime without a month. + "nanos": 42, # Optional. Fractions of seconds in nanoseconds. Must be from 0 to + # 999,999,999, defaults to 0. + "seconds": 42, # Optional. Seconds of minutes of the time. Must normally be from 0 to 59, + # defaults to 0. An API may allow the value 60 if it allows leap-seconds. + "timeZone": { # Represents a time zone from the # Time zone. + # [IANA Time Zone Database](https://www.iana.org/time-zones). + "id": "A String", # IANA Time Zone Database time zone. For example "America/New_York". + "version": "A String", # Optional. IANA Time Zone Database version number. For example "2019a". + }, + "utcOffset": "A String", # UTC offset. Must be whole seconds, between -18 hours and +18 hours. + # For example, a UTC offset of -4:00 would be represented as + # { seconds: -14400 }. + "year": 42, # Optional. Year of date. Must be from 1 to 9999, or 0 if specifying a + # datetime without a year. + }, + "windowStartTime": { # Represents civil time (or occasionally physical time). # The start civil timestamp of the window. + # This contains a time zone. + # + # This type can represent a civil time in one of a few possible ways: + # + # * When utc_offset is set and time_zone is unset: a civil time on a calendar + # day with a particular offset from UTC. + # * When time_zone is set and utc_offset is unset: a civil time on a calendar + # day in a particular time zone. + # * When neither time_zone nor utc_offset is set: a civil time on a calendar + # day in local time. + # + # The date is relative to the Proleptic Gregorian Calendar. + # + # If year, month, or day are 0, the DateTime is considered not to have a + # specific year, month, or day respectively. + # + # This type may also be used to represent a physical time if all the date and + # time fields are set and either case of the `time_offset` oneof is set. + # Consider using `Timestamp` message for physical time instead. If your use + # case also would like to store the user's timezone, that can be done in + # another field. + # + # This type is more flexible than some applications may want. Make sure to + # document and validate your application's limitations. + "day": 42, # Optional. Day of month. Must be from 1 to 31 and valid for the year and + # month, or 0 if specifying a datetime without a day. + "hours": 42, # Optional. Hours of day in 24 hour format. Should be from 0 to 23, defaults + # to 0 (midnight). An API may choose to allow the value "24:00:00" for + # scenarios like business closing time. + "minutes": 42, # Optional. Minutes of hour of day. Must be from 0 to 59, defaults to 0. + "month": 42, # Optional. Month of year. Must be from 1 to 12, or 0 if specifying a + # datetime without a month. + "nanos": 42, # Optional. Fractions of seconds in nanoseconds. Must be from 0 to + # 999,999,999, defaults to 0. + "seconds": 42, # Optional. Seconds of minutes of the time. Must normally be from 0 to 59, + # defaults to 0. An API may allow the value 60 if it allows leap-seconds. + "timeZone": { # Represents a time zone from the # Time zone. + # [IANA Time Zone Database](https://www.iana.org/time-zones). + "id": "A String", # IANA Time Zone Database time zone. For example "America/New_York". + "version": "A String", # Optional. IANA Time Zone Database version number. For example "2019a". + }, + "utcOffset": "A String", # UTC offset. Must be whole seconds, between -18 hours and +18 hours. + # For example, a UTC offset of -4:00 would be represented as + # { seconds: -14400 }. + "year": 42, # Optional. Year of date. Must be from 1 to 9999, or 0 if specifying a + # datetime without a year. + }, + }, + ], + }, "selfLink": "A String", # [Output Only] Server-defined URL for the resource. "status": "A String", # [Output Only] Status of the zone, either UP orDOWN. "supportsPzs": True or False, # Output only. [Output Only] Reserved for future use. diff --git a/docs/dyn/compute_beta.rollouts.html b/docs/dyn/compute_beta.rollouts.html index 81877db62b..7769e7a7ce 100644 --- a/docs/dyn/compute_beta.rollouts.html +++ b/docs/dyn/compute_beta.rollouts.html @@ -1029,6 +1029,8 @@

Method Details

# which means the first character must be a lowercase letter, and all # following characters must be a dash, lowercase letter, or digit, except # the last character, which cannot be a dash. + "pauseTime": "A String", # Output only. The timestamp at which the Rollout was paused. + "resumeTime": "A String", # Output only. The timestamp at which the Rollout was resumed. "rolloutEntity": { # Specifications of the resource to roll out. # Required. The resource being rolled out. "orchestratedEntity": { # This message is used if the resource type follows the Orchestrated # Optional. Entity details for products using the Orchestrated Integration model. # integration model with ProgressiveRollout. @@ -1215,6 +1217,8 @@

Method Details

# which means the first character must be a lowercase letter, and all # following characters must be a dash, lowercase letter, or digit, except # the last character, which cannot be a dash. + "pauseTime": "A String", # Output only. The timestamp at which the Rollout was paused. + "resumeTime": "A String", # Output only. The timestamp at which the Rollout was resumed. "rolloutEntity": { # Specifications of the resource to roll out. # Required. The resource being rolled out. "orchestratedEntity": { # This message is used if the resource type follows the Orchestrated # Optional. Entity details for products using the Orchestrated Integration model. # integration model with ProgressiveRollout. diff --git a/docs/dyn/compute_beta.routers.html b/docs/dyn/compute_beta.routers.html index 674ce76a52..c99808e059 100644 --- a/docs/dyn/compute_beta.routers.html +++ b/docs/dyn/compute_beta.routers.html @@ -581,6 +581,9 @@

Method Details

# These IPs should be used for updating/patching a NAT only. "A String", ], + "effectiveTcpTimeWaitTimeoutSec": 42, # Output only. Effective timeout (in seconds) for TCP connections that are in TIME_WAIT + # state. This value is equal to tcp_time_wait_timeout_sec if it is set, + # otherwise it is equal to 120s. The field is output only. "enableDynamicPortAllocation": True or False, # Enable Dynamic Port Allocation. # # @@ -2074,6 +2077,9 @@

Method Details

# These IPs should be used for updating/patching a NAT only. "A String", ], + "effectiveTcpTimeWaitTimeoutSec": 42, # Output only. Effective timeout (in seconds) for TCP connections that are in TIME_WAIT + # state. This value is equal to tcp_time_wait_timeout_sec if it is set, + # otherwise it is equal to 120s. The field is output only. "enableDynamicPortAllocation": True or False, # Enable Dynamic Port Allocation. # # @@ -3770,6 +3776,9 @@

Method Details

# These IPs should be used for updating/patching a NAT only. "A String", ], + "effectiveTcpTimeWaitTimeoutSec": 42, # Output only. Effective timeout (in seconds) for TCP connections that are in TIME_WAIT + # state. This value is equal to tcp_time_wait_timeout_sec if it is set, + # otherwise it is equal to 120s. The field is output only. "enableDynamicPortAllocation": True or False, # Enable Dynamic Port Allocation. # # @@ -4667,6 +4676,9 @@

Method Details

# These IPs should be used for updating/patching a NAT only. "A String", ], + "effectiveTcpTimeWaitTimeoutSec": 42, # Output only. Effective timeout (in seconds) for TCP connections that are in TIME_WAIT + # state. This value is equal to tcp_time_wait_timeout_sec if it is set, + # otherwise it is equal to 120s. The field is output only. "enableDynamicPortAllocation": True or False, # Enable Dynamic Port Allocation. # # @@ -5929,6 +5941,9 @@

Method Details

# These IPs should be used for updating/patching a NAT only. "A String", ], + "effectiveTcpTimeWaitTimeoutSec": 42, # Output only. Effective timeout (in seconds) for TCP connections that are in TIME_WAIT + # state. This value is equal to tcp_time_wait_timeout_sec if it is set, + # otherwise it is equal to 120s. The field is output only. "enableDynamicPortAllocation": True or False, # Enable Dynamic Port Allocation. # # @@ -7499,6 +7514,9 @@

Method Details

# These IPs should be used for updating/patching a NAT only. "A String", ], + "effectiveTcpTimeWaitTimeoutSec": 42, # Output only. Effective timeout (in seconds) for TCP connections that are in TIME_WAIT + # state. This value is equal to tcp_time_wait_timeout_sec if it is set, + # otherwise it is equal to 120s. The field is output only. "enableDynamicPortAllocation": True or False, # Enable Dynamic Port Allocation. # # @@ -8019,6 +8037,9 @@

Method Details

# These IPs should be used for updating/patching a NAT only. "A String", ], + "effectiveTcpTimeWaitTimeoutSec": 42, # Output only. Effective timeout (in seconds) for TCP connections that are in TIME_WAIT + # state. This value is equal to tcp_time_wait_timeout_sec if it is set, + # otherwise it is equal to 120s. The field is output only. "enableDynamicPortAllocation": True or False, # Enable Dynamic Port Allocation. # # @@ -8580,6 +8601,9 @@

Method Details

# These IPs should be used for updating/patching a NAT only. "A String", ], + "effectiveTcpTimeWaitTimeoutSec": 42, # Output only. Effective timeout (in seconds) for TCP connections that are in TIME_WAIT + # state. This value is equal to tcp_time_wait_timeout_sec if it is set, + # otherwise it is equal to 120s. The field is output only. "enableDynamicPortAllocation": True or False, # Enable Dynamic Port Allocation. # # diff --git a/docs/dyn/compute_beta.urlMaps.html b/docs/dyn/compute_beta.urlMaps.html index de2c86b19d..c339db6d03 100644 --- a/docs/dyn/compute_beta.urlMaps.html +++ b/docs/dyn/compute_beta.urlMaps.html @@ -686,6 +686,17 @@

Method Details

# The value must be from 0.0 to 100.0 inclusive. }, }, + "imageOptimizationPolicy": { # The configuration for Cloud CDN's image optimization feature. This feature # Image optimization policy for this URL Map's route. Available only for + # Global EXTERNAL_MANAGED load balancer schemes. + # Either Cloud CDN must be enabled on the backend service or backend bucket + # serving the route, or cache policy must be configured on the same route + # dynamically processes and delivers images from the network edge. + # Image Optimization is only available for Global External Application Load + # Balancers. + # Either Cloud CDN must be enabled on the backend service or backend bucket + # serving the route, or cache policy must be configured on the same route. + "queryParameterInterpretation": "A String", # Specifies whether to interpret query parameters for image optimization. + }, "maxStreamDuration": { # A Duration represents a fixed-length span of time represented # Specifies the maximum duration (timeout) for streams on the selected route. # Unlike the timeout field where the timeout duration starts # from the time the request has been fully processed (known as*end-of-stream*), @@ -1532,6 +1543,17 @@

Method Details

# The value must be from 0.0 to 100.0 inclusive. }, }, + "imageOptimizationPolicy": { # The configuration for Cloud CDN's image optimization feature. This feature # Image optimization policy for this URL Map's route. Available only for + # Global EXTERNAL_MANAGED load balancer schemes. + # Either Cloud CDN must be enabled on the backend service or backend bucket + # serving the route, or cache policy must be configured on the same route + # dynamically processes and delivers images from the network edge. + # Image Optimization is only available for Global External Application Load + # Balancers. + # Either Cloud CDN must be enabled on the backend service or backend bucket + # serving the route, or cache policy must be configured on the same route. + "queryParameterInterpretation": "A String", # Specifies whether to interpret query parameters for image optimization. + }, "maxStreamDuration": { # A Duration represents a fixed-length span of time represented # Specifies the maximum duration (timeout) for streams on the selected route. # Unlike the timeout field where the timeout duration starts # from the time the request has been fully processed (known as*end-of-stream*), @@ -2359,6 +2381,17 @@

Method Details

# The value must be from 0.0 to 100.0 inclusive. }, }, + "imageOptimizationPolicy": { # The configuration for Cloud CDN's image optimization feature. This feature # Image optimization policy for this URL Map's route. Available only for + # Global EXTERNAL_MANAGED load balancer schemes. + # Either Cloud CDN must be enabled on the backend service or backend bucket + # serving the route, or cache policy must be configured on the same route + # dynamically processes and delivers images from the network edge. + # Image Optimization is only available for Global External Application Load + # Balancers. + # Either Cloud CDN must be enabled on the backend service or backend bucket + # serving the route, or cache policy must be configured on the same route. + "queryParameterInterpretation": "A String", # Specifies whether to interpret query parameters for image optimization. + }, "maxStreamDuration": { # A Duration represents a fixed-length span of time represented # Specifies the maximum duration (timeout) for streams on the selected route. # Unlike the timeout field where the timeout duration starts # from the time the request has been fully processed (known as*end-of-stream*), @@ -3448,6 +3481,17 @@

Method Details

# The value must be from 0.0 to 100.0 inclusive. }, }, + "imageOptimizationPolicy": { # The configuration for Cloud CDN's image optimization feature. This feature # Image optimization policy for this URL Map's route. Available only for + # Global EXTERNAL_MANAGED load balancer schemes. + # Either Cloud CDN must be enabled on the backend service or backend bucket + # serving the route, or cache policy must be configured on the same route + # dynamically processes and delivers images from the network edge. + # Image Optimization is only available for Global External Application Load + # Balancers. + # Either Cloud CDN must be enabled on the backend service or backend bucket + # serving the route, or cache policy must be configured on the same route. + "queryParameterInterpretation": "A String", # Specifies whether to interpret query parameters for image optimization. + }, "maxStreamDuration": { # A Duration represents a fixed-length span of time represented # Specifies the maximum duration (timeout) for streams on the selected route. # Unlike the timeout field where the timeout duration starts # from the time the request has been fully processed (known as*end-of-stream*), @@ -4674,6 +4718,17 @@

Method Details

# The value must be from 0.0 to 100.0 inclusive. }, }, + "imageOptimizationPolicy": { # The configuration for Cloud CDN's image optimization feature. This feature # Image optimization policy for this URL Map's route. Available only for + # Global EXTERNAL_MANAGED load balancer schemes. + # Either Cloud CDN must be enabled on the backend service or backend bucket + # serving the route, or cache policy must be configured on the same route + # dynamically processes and delivers images from the network edge. + # Image Optimization is only available for Global External Application Load + # Balancers. + # Either Cloud CDN must be enabled on the backend service or backend bucket + # serving the route, or cache policy must be configured on the same route. + "queryParameterInterpretation": "A String", # Specifies whether to interpret query parameters for image optimization. + }, "maxStreamDuration": { # A Duration represents a fixed-length span of time represented # Specifies the maximum duration (timeout) for streams on the selected route. # Unlike the timeout field where the timeout duration starts # from the time the request has been fully processed (known as*end-of-stream*), @@ -5520,6 +5575,17 @@

Method Details

# The value must be from 0.0 to 100.0 inclusive. }, }, + "imageOptimizationPolicy": { # The configuration for Cloud CDN's image optimization feature. This feature # Image optimization policy for this URL Map's route. Available only for + # Global EXTERNAL_MANAGED load balancer schemes. + # Either Cloud CDN must be enabled on the backend service or backend bucket + # serving the route, or cache policy must be configured on the same route + # dynamically processes and delivers images from the network edge. + # Image Optimization is only available for Global External Application Load + # Balancers. + # Either Cloud CDN must be enabled on the backend service or backend bucket + # serving the route, or cache policy must be configured on the same route. + "queryParameterInterpretation": "A String", # Specifies whether to interpret query parameters for image optimization. + }, "maxStreamDuration": { # A Duration represents a fixed-length span of time represented # Specifies the maximum duration (timeout) for streams on the selected route. # Unlike the timeout field where the timeout duration starts # from the time the request has been fully processed (known as*end-of-stream*), @@ -6347,6 +6413,17 @@

Method Details

# The value must be from 0.0 to 100.0 inclusive. }, }, + "imageOptimizationPolicy": { # The configuration for Cloud CDN's image optimization feature. This feature # Image optimization policy for this URL Map's route. Available only for + # Global EXTERNAL_MANAGED load balancer schemes. + # Either Cloud CDN must be enabled on the backend service or backend bucket + # serving the route, or cache policy must be configured on the same route + # dynamically processes and delivers images from the network edge. + # Image Optimization is only available for Global External Application Load + # Balancers. + # Either Cloud CDN must be enabled on the backend service or backend bucket + # serving the route, or cache policy must be configured on the same route. + "queryParameterInterpretation": "A String", # Specifies whether to interpret query parameters for image optimization. + }, "maxStreamDuration": { # A Duration represents a fixed-length span of time represented # Specifies the maximum duration (timeout) for streams on the selected route. # Unlike the timeout field where the timeout duration starts # from the time the request has been fully processed (known as*end-of-stream*), @@ -7436,6 +7513,17 @@

Method Details

# The value must be from 0.0 to 100.0 inclusive. }, }, + "imageOptimizationPolicy": { # The configuration for Cloud CDN's image optimization feature. This feature # Image optimization policy for this URL Map's route. Available only for + # Global EXTERNAL_MANAGED load balancer schemes. + # Either Cloud CDN must be enabled on the backend service or backend bucket + # serving the route, or cache policy must be configured on the same route + # dynamically processes and delivers images from the network edge. + # Image Optimization is only available for Global External Application Load + # Balancers. + # Either Cloud CDN must be enabled on the backend service or backend bucket + # serving the route, or cache policy must be configured on the same route. + "queryParameterInterpretation": "A String", # Specifies whether to interpret query parameters for image optimization. + }, "maxStreamDuration": { # A Duration represents a fixed-length span of time represented # Specifies the maximum duration (timeout) for streams on the selected route. # Unlike the timeout field where the timeout duration starts # from the time the request has been fully processed (known as*end-of-stream*), @@ -8281,6 +8369,17 @@

Method Details

# The value must be from 0.0 to 100.0 inclusive. }, }, + "imageOptimizationPolicy": { # The configuration for Cloud CDN's image optimization feature. This feature # Image optimization policy for this URL Map's route. Available only for + # Global EXTERNAL_MANAGED load balancer schemes. + # Either Cloud CDN must be enabled on the backend service or backend bucket + # serving the route, or cache policy must be configured on the same route + # dynamically processes and delivers images from the network edge. + # Image Optimization is only available for Global External Application Load + # Balancers. + # Either Cloud CDN must be enabled on the backend service or backend bucket + # serving the route, or cache policy must be configured on the same route. + "queryParameterInterpretation": "A String", # Specifies whether to interpret query parameters for image optimization. + }, "maxStreamDuration": { # A Duration represents a fixed-length span of time represented # Specifies the maximum duration (timeout) for streams on the selected route. # Unlike the timeout field where the timeout duration starts # from the time the request has been fully processed (known as*end-of-stream*), @@ -9127,6 +9226,17 @@

Method Details

# The value must be from 0.0 to 100.0 inclusive. }, }, + "imageOptimizationPolicy": { # The configuration for Cloud CDN's image optimization feature. This feature # Image optimization policy for this URL Map's route. Available only for + # Global EXTERNAL_MANAGED load balancer schemes. + # Either Cloud CDN must be enabled on the backend service or backend bucket + # serving the route, or cache policy must be configured on the same route + # dynamically processes and delivers images from the network edge. + # Image Optimization is only available for Global External Application Load + # Balancers. + # Either Cloud CDN must be enabled on the backend service or backend bucket + # serving the route, or cache policy must be configured on the same route. + "queryParameterInterpretation": "A String", # Specifies whether to interpret query parameters for image optimization. + }, "maxStreamDuration": { # A Duration represents a fixed-length span of time represented # Specifies the maximum duration (timeout) for streams on the selected route. # Unlike the timeout field where the timeout duration starts # from the time the request has been fully processed (known as*end-of-stream*), @@ -9954,6 +10064,17 @@

Method Details

# The value must be from 0.0 to 100.0 inclusive. }, }, + "imageOptimizationPolicy": { # The configuration for Cloud CDN's image optimization feature. This feature # Image optimization policy for this URL Map's route. Available only for + # Global EXTERNAL_MANAGED load balancer schemes. + # Either Cloud CDN must be enabled on the backend service or backend bucket + # serving the route, or cache policy must be configured on the same route + # dynamically processes and delivers images from the network edge. + # Image Optimization is only available for Global External Application Load + # Balancers. + # Either Cloud CDN must be enabled on the backend service or backend bucket + # serving the route, or cache policy must be configured on the same route. + "queryParameterInterpretation": "A String", # Specifies whether to interpret query parameters for image optimization. + }, "maxStreamDuration": { # A Duration represents a fixed-length span of time represented # Specifies the maximum duration (timeout) for streams on the selected route. # Unlike the timeout field where the timeout duration starts # from the time the request has been fully processed (known as*end-of-stream*), @@ -11043,6 +11164,17 @@

Method Details

# The value must be from 0.0 to 100.0 inclusive. }, }, + "imageOptimizationPolicy": { # The configuration for Cloud CDN's image optimization feature. This feature # Image optimization policy for this URL Map's route. Available only for + # Global EXTERNAL_MANAGED load balancer schemes. + # Either Cloud CDN must be enabled on the backend service or backend bucket + # serving the route, or cache policy must be configured on the same route + # dynamically processes and delivers images from the network edge. + # Image Optimization is only available for Global External Application Load + # Balancers. + # Either Cloud CDN must be enabled on the backend service or backend bucket + # serving the route, or cache policy must be configured on the same route. + "queryParameterInterpretation": "A String", # Specifies whether to interpret query parameters for image optimization. + }, "maxStreamDuration": { # A Duration represents a fixed-length span of time represented # Specifies the maximum duration (timeout) for streams on the selected route. # Unlike the timeout field where the timeout duration starts # from the time the request has been fully processed (known as*end-of-stream*), @@ -12582,6 +12714,17 @@

Method Details

# The value must be from 0.0 to 100.0 inclusive. }, }, + "imageOptimizationPolicy": { # The configuration for Cloud CDN's image optimization feature. This feature # Image optimization policy for this URL Map's route. Available only for + # Global EXTERNAL_MANAGED load balancer schemes. + # Either Cloud CDN must be enabled on the backend service or backend bucket + # serving the route, or cache policy must be configured on the same route + # dynamically processes and delivers images from the network edge. + # Image Optimization is only available for Global External Application Load + # Balancers. + # Either Cloud CDN must be enabled on the backend service or backend bucket + # serving the route, or cache policy must be configured on the same route. + "queryParameterInterpretation": "A String", # Specifies whether to interpret query parameters for image optimization. + }, "maxStreamDuration": { # A Duration represents a fixed-length span of time represented # Specifies the maximum duration (timeout) for streams on the selected route. # Unlike the timeout field where the timeout duration starts # from the time the request has been fully processed (known as*end-of-stream*), @@ -13428,6 +13571,17 @@

Method Details

# The value must be from 0.0 to 100.0 inclusive. }, }, + "imageOptimizationPolicy": { # The configuration for Cloud CDN's image optimization feature. This feature # Image optimization policy for this URL Map's route. Available only for + # Global EXTERNAL_MANAGED load balancer schemes. + # Either Cloud CDN must be enabled on the backend service or backend bucket + # serving the route, or cache policy must be configured on the same route + # dynamically processes and delivers images from the network edge. + # Image Optimization is only available for Global External Application Load + # Balancers. + # Either Cloud CDN must be enabled on the backend service or backend bucket + # serving the route, or cache policy must be configured on the same route. + "queryParameterInterpretation": "A String", # Specifies whether to interpret query parameters for image optimization. + }, "maxStreamDuration": { # A Duration represents a fixed-length span of time represented # Specifies the maximum duration (timeout) for streams on the selected route. # Unlike the timeout field where the timeout duration starts # from the time the request has been fully processed (known as*end-of-stream*), @@ -14255,6 +14409,17 @@

Method Details

# The value must be from 0.0 to 100.0 inclusive. }, }, + "imageOptimizationPolicy": { # The configuration for Cloud CDN's image optimization feature. This feature # Image optimization policy for this URL Map's route. Available only for + # Global EXTERNAL_MANAGED load balancer schemes. + # Either Cloud CDN must be enabled on the backend service or backend bucket + # serving the route, or cache policy must be configured on the same route + # dynamically processes and delivers images from the network edge. + # Image Optimization is only available for Global External Application Load + # Balancers. + # Either Cloud CDN must be enabled on the backend service or backend bucket + # serving the route, or cache policy must be configured on the same route. + "queryParameterInterpretation": "A String", # Specifies whether to interpret query parameters for image optimization. + }, "maxStreamDuration": { # A Duration represents a fixed-length span of time represented # Specifies the maximum duration (timeout) for streams on the selected route. # Unlike the timeout field where the timeout duration starts # from the time the request has been fully processed (known as*end-of-stream*), @@ -15344,6 +15509,17 @@

Method Details

# The value must be from 0.0 to 100.0 inclusive. }, }, + "imageOptimizationPolicy": { # The configuration for Cloud CDN's image optimization feature. This feature # Image optimization policy for this URL Map's route. Available only for + # Global EXTERNAL_MANAGED load balancer schemes. + # Either Cloud CDN must be enabled on the backend service or backend bucket + # serving the route, or cache policy must be configured on the same route + # dynamically processes and delivers images from the network edge. + # Image Optimization is only available for Global External Application Load + # Balancers. + # Either Cloud CDN must be enabled on the backend service or backend bucket + # serving the route, or cache policy must be configured on the same route. + "queryParameterInterpretation": "A String", # Specifies whether to interpret query parameters for image optimization. + }, "maxStreamDuration": { # A Duration represents a fixed-length span of time represented # Specifies the maximum duration (timeout) for streams on the selected route. # Unlike the timeout field where the timeout duration starts # from the time the request has been fully processed (known as*end-of-stream*), @@ -16240,6 +16416,17 @@

Method Details

# The value must be from 0.0 to 100.0 inclusive. }, }, + "imageOptimizationPolicy": { # The configuration for Cloud CDN's image optimization feature. This feature # Image optimization policy for this URL Map's route. Available only for + # Global EXTERNAL_MANAGED load balancer schemes. + # Either Cloud CDN must be enabled on the backend service or backend bucket + # serving the route, or cache policy must be configured on the same route + # dynamically processes and delivers images from the network edge. + # Image Optimization is only available for Global External Application Load + # Balancers. + # Either Cloud CDN must be enabled on the backend service or backend bucket + # serving the route, or cache policy must be configured on the same route. + "queryParameterInterpretation": "A String", # Specifies whether to interpret query parameters for image optimization. + }, "maxStreamDuration": { # A Duration represents a fixed-length span of time represented # Specifies the maximum duration (timeout) for streams on the selected route. # Unlike the timeout field where the timeout duration starts # from the time the request has been fully processed (known as*end-of-stream*), @@ -17086,6 +17273,17 @@

Method Details

# The value must be from 0.0 to 100.0 inclusive. }, }, + "imageOptimizationPolicy": { # The configuration for Cloud CDN's image optimization feature. This feature # Image optimization policy for this URL Map's route. Available only for + # Global EXTERNAL_MANAGED load balancer schemes. + # Either Cloud CDN must be enabled on the backend service or backend bucket + # serving the route, or cache policy must be configured on the same route + # dynamically processes and delivers images from the network edge. + # Image Optimization is only available for Global External Application Load + # Balancers. + # Either Cloud CDN must be enabled on the backend service or backend bucket + # serving the route, or cache policy must be configured on the same route. + "queryParameterInterpretation": "A String", # Specifies whether to interpret query parameters for image optimization. + }, "maxStreamDuration": { # A Duration represents a fixed-length span of time represented # Specifies the maximum duration (timeout) for streams on the selected route. # Unlike the timeout field where the timeout duration starts # from the time the request has been fully processed (known as*end-of-stream*), @@ -17913,6 +18111,17 @@

Method Details

# The value must be from 0.0 to 100.0 inclusive. }, }, + "imageOptimizationPolicy": { # The configuration for Cloud CDN's image optimization feature. This feature # Image optimization policy for this URL Map's route. Available only for + # Global EXTERNAL_MANAGED load balancer schemes. + # Either Cloud CDN must be enabled on the backend service or backend bucket + # serving the route, or cache policy must be configured on the same route + # dynamically processes and delivers images from the network edge. + # Image Optimization is only available for Global External Application Load + # Balancers. + # Either Cloud CDN must be enabled on the backend service or backend bucket + # serving the route, or cache policy must be configured on the same route. + "queryParameterInterpretation": "A String", # Specifies whether to interpret query parameters for image optimization. + }, "maxStreamDuration": { # A Duration represents a fixed-length span of time represented # Specifies the maximum duration (timeout) for streams on the selected route. # Unlike the timeout field where the timeout duration starts # from the time the request has been fully processed (known as*end-of-stream*), @@ -19002,6 +19211,17 @@

Method Details

# The value must be from 0.0 to 100.0 inclusive. }, }, + "imageOptimizationPolicy": { # The configuration for Cloud CDN's image optimization feature. This feature # Image optimization policy for this URL Map's route. Available only for + # Global EXTERNAL_MANAGED load balancer schemes. + # Either Cloud CDN must be enabled on the backend service or backend bucket + # serving the route, or cache policy must be configured on the same route + # dynamically processes and delivers images from the network edge. + # Image Optimization is only available for Global External Application Load + # Balancers. + # Either Cloud CDN must be enabled on the backend service or backend bucket + # serving the route, or cache policy must be configured on the same route. + "queryParameterInterpretation": "A String", # Specifies whether to interpret query parameters for image optimization. + }, "maxStreamDuration": { # A Duration represents a fixed-length span of time represented # Specifies the maximum duration (timeout) for streams on the selected route. # Unlike the timeout field where the timeout duration starts # from the time the request has been fully processed (known as*end-of-stream*), @@ -20165,6 +20385,17 @@

Method Details

# The value must be from 0.0 to 100.0 inclusive. }, }, + "imageOptimizationPolicy": { # The configuration for Cloud CDN's image optimization feature. This feature # Image optimization policy for this URL Map's route. Available only for + # Global EXTERNAL_MANAGED load balancer schemes. + # Either Cloud CDN must be enabled on the backend service or backend bucket + # serving the route, or cache policy must be configured on the same route + # dynamically processes and delivers images from the network edge. + # Image Optimization is only available for Global External Application Load + # Balancers. + # Either Cloud CDN must be enabled on the backend service or backend bucket + # serving the route, or cache policy must be configured on the same route. + "queryParameterInterpretation": "A String", # Specifies whether to interpret query parameters for image optimization. + }, "maxStreamDuration": { # A Duration represents a fixed-length span of time represented # Specifies the maximum duration (timeout) for streams on the selected route. # Unlike the timeout field where the timeout duration starts # from the time the request has been fully processed (known as*end-of-stream*), @@ -21011,6 +21242,17 @@

Method Details

# The value must be from 0.0 to 100.0 inclusive. }, }, + "imageOptimizationPolicy": { # The configuration for Cloud CDN's image optimization feature. This feature # Image optimization policy for this URL Map's route. Available only for + # Global EXTERNAL_MANAGED load balancer schemes. + # Either Cloud CDN must be enabled on the backend service or backend bucket + # serving the route, or cache policy must be configured on the same route + # dynamically processes and delivers images from the network edge. + # Image Optimization is only available for Global External Application Load + # Balancers. + # Either Cloud CDN must be enabled on the backend service or backend bucket + # serving the route, or cache policy must be configured on the same route. + "queryParameterInterpretation": "A String", # Specifies whether to interpret query parameters for image optimization. + }, "maxStreamDuration": { # A Duration represents a fixed-length span of time represented # Specifies the maximum duration (timeout) for streams on the selected route. # Unlike the timeout field where the timeout duration starts # from the time the request has been fully processed (known as*end-of-stream*), @@ -21838,6 +22080,17 @@

Method Details

# The value must be from 0.0 to 100.0 inclusive. }, }, + "imageOptimizationPolicy": { # The configuration for Cloud CDN's image optimization feature. This feature # Image optimization policy for this URL Map's route. Available only for + # Global EXTERNAL_MANAGED load balancer schemes. + # Either Cloud CDN must be enabled on the backend service or backend bucket + # serving the route, or cache policy must be configured on the same route + # dynamically processes and delivers images from the network edge. + # Image Optimization is only available for Global External Application Load + # Balancers. + # Either Cloud CDN must be enabled on the backend service or backend bucket + # serving the route, or cache policy must be configured on the same route. + "queryParameterInterpretation": "A String", # Specifies whether to interpret query parameters for image optimization. + }, "maxStreamDuration": { # A Duration represents a fixed-length span of time represented # Specifies the maximum duration (timeout) for streams on the selected route. # Unlike the timeout field where the timeout duration starts # from the time the request has been fully processed (known as*end-of-stream*), @@ -22927,6 +23180,17 @@

Method Details

# The value must be from 0.0 to 100.0 inclusive. }, }, + "imageOptimizationPolicy": { # The configuration for Cloud CDN's image optimization feature. This feature # Image optimization policy for this URL Map's route. Available only for + # Global EXTERNAL_MANAGED load balancer schemes. + # Either Cloud CDN must be enabled on the backend service or backend bucket + # serving the route, or cache policy must be configured on the same route + # dynamically processes and delivers images from the network edge. + # Image Optimization is only available for Global External Application Load + # Balancers. + # Either Cloud CDN must be enabled on the backend service or backend bucket + # serving the route, or cache policy must be configured on the same route. + "queryParameterInterpretation": "A String", # Specifies whether to interpret query parameters for image optimization. + }, "maxStreamDuration": { # A Duration represents a fixed-length span of time represented # Specifies the maximum duration (timeout) for streams on the selected route. # Unlike the timeout field where the timeout duration starts # from the time the request has been fully processed (known as*end-of-stream*), @@ -24076,6 +24340,17 @@

Method Details

# The value must be from 0.0 to 100.0 inclusive. }, }, + "imageOptimizationPolicy": { # The configuration for Cloud CDN's image optimization feature. This feature # Image optimization policy for this URL Map's route. Available only for + # Global EXTERNAL_MANAGED load balancer schemes. + # Either Cloud CDN must be enabled on the backend service or backend bucket + # serving the route, or cache policy must be configured on the same route + # dynamically processes and delivers images from the network edge. + # Image Optimization is only available for Global External Application Load + # Balancers. + # Either Cloud CDN must be enabled on the backend service or backend bucket + # serving the route, or cache policy must be configured on the same route. + "queryParameterInterpretation": "A String", # Specifies whether to interpret query parameters for image optimization. + }, "maxStreamDuration": { # A Duration represents a fixed-length span of time represented # Specifies the maximum duration (timeout) for streams on the selected route. # Unlike the timeout field where the timeout duration starts # from the time the request has been fully processed (known as*end-of-stream*), @@ -24922,6 +25197,17 @@

Method Details

# The value must be from 0.0 to 100.0 inclusive. }, }, + "imageOptimizationPolicy": { # The configuration for Cloud CDN's image optimization feature. This feature # Image optimization policy for this URL Map's route. Available only for + # Global EXTERNAL_MANAGED load balancer schemes. + # Either Cloud CDN must be enabled on the backend service or backend bucket + # serving the route, or cache policy must be configured on the same route + # dynamically processes and delivers images from the network edge. + # Image Optimization is only available for Global External Application Load + # Balancers. + # Either Cloud CDN must be enabled on the backend service or backend bucket + # serving the route, or cache policy must be configured on the same route. + "queryParameterInterpretation": "A String", # Specifies whether to interpret query parameters for image optimization. + }, "maxStreamDuration": { # A Duration represents a fixed-length span of time represented # Specifies the maximum duration (timeout) for streams on the selected route. # Unlike the timeout field where the timeout duration starts # from the time the request has been fully processed (known as*end-of-stream*), @@ -25749,6 +26035,17 @@

Method Details

# The value must be from 0.0 to 100.0 inclusive. }, }, + "imageOptimizationPolicy": { # The configuration for Cloud CDN's image optimization feature. This feature # Image optimization policy for this URL Map's route. Available only for + # Global EXTERNAL_MANAGED load balancer schemes. + # Either Cloud CDN must be enabled on the backend service or backend bucket + # serving the route, or cache policy must be configured on the same route + # dynamically processes and delivers images from the network edge. + # Image Optimization is only available for Global External Application Load + # Balancers. + # Either Cloud CDN must be enabled on the backend service or backend bucket + # serving the route, or cache policy must be configured on the same route. + "queryParameterInterpretation": "A String", # Specifies whether to interpret query parameters for image optimization. + }, "maxStreamDuration": { # A Duration represents a fixed-length span of time represented # Specifies the maximum duration (timeout) for streams on the selected route. # Unlike the timeout field where the timeout duration starts # from the time the request has been fully processed (known as*end-of-stream*), @@ -26838,6 +27135,17 @@

Method Details

# The value must be from 0.0 to 100.0 inclusive. }, }, + "imageOptimizationPolicy": { # The configuration for Cloud CDN's image optimization feature. This feature # Image optimization policy for this URL Map's route. Available only for + # Global EXTERNAL_MANAGED load balancer schemes. + # Either Cloud CDN must be enabled on the backend service or backend bucket + # serving the route, or cache policy must be configured on the same route + # dynamically processes and delivers images from the network edge. + # Image Optimization is only available for Global External Application Load + # Balancers. + # Either Cloud CDN must be enabled on the backend service or backend bucket + # serving the route, or cache policy must be configured on the same route. + "queryParameterInterpretation": "A String", # Specifies whether to interpret query parameters for image optimization. + }, "maxStreamDuration": { # A Duration represents a fixed-length span of time represented # Specifies the maximum duration (timeout) for streams on the selected route. # Unlike the timeout field where the timeout duration starts # from the time the request has been fully processed (known as*end-of-stream*), diff --git a/docs/dyn/compute_beta.zones.html b/docs/dyn/compute_beta.zones.html index b96f321498..60dbcc17c5 100644 --- a/docs/dyn/compute_beta.zones.html +++ b/docs/dyn/compute_beta.zones.html @@ -166,6 +166,114 @@

Method Details

# zones. "name": "A String", # [Output Only] Name of the resource. "region": "A String", # [Output Only] Full URL reference to the region which hosts the zone. + "resourceStatus": { + "upcomingMaintenances": [ # Output only. [Output Only] The upcoming maintenance schedule. + { # The periodic partial maintenance schedule includes 52 weeks worth of + # maintenance windows. + # LINT.IfChange(PeriodicPartialMaintenanceSchedule) + "subType": "A String", # The maintenance type in which the zone is during the given window. + "targetResource": "A String", # The target resource that the maintenance window is for. + # For example, "projects/my-project/zones/us-central1-a". + "type": "A String", + "windowEndTime": { # Represents civil time (or occasionally physical time). # The end civil timestamp of the window (not inclusive). + # This contains a time zone. + # + # This type can represent a civil time in one of a few possible ways: + # + # * When utc_offset is set and time_zone is unset: a civil time on a calendar + # day with a particular offset from UTC. + # * When time_zone is set and utc_offset is unset: a civil time on a calendar + # day in a particular time zone. + # * When neither time_zone nor utc_offset is set: a civil time on a calendar + # day in local time. + # + # The date is relative to the Proleptic Gregorian Calendar. + # + # If year, month, or day are 0, the DateTime is considered not to have a + # specific year, month, or day respectively. + # + # This type may also be used to represent a physical time if all the date and + # time fields are set and either case of the `time_offset` oneof is set. + # Consider using `Timestamp` message for physical time instead. If your use + # case also would like to store the user's timezone, that can be done in + # another field. + # + # This type is more flexible than some applications may want. Make sure to + # document and validate your application's limitations. + "day": 42, # Optional. Day of month. Must be from 1 to 31 and valid for the year and + # month, or 0 if specifying a datetime without a day. + "hours": 42, # Optional. Hours of day in 24 hour format. Should be from 0 to 23, defaults + # to 0 (midnight). An API may choose to allow the value "24:00:00" for + # scenarios like business closing time. + "minutes": 42, # Optional. Minutes of hour of day. Must be from 0 to 59, defaults to 0. + "month": 42, # Optional. Month of year. Must be from 1 to 12, or 0 if specifying a + # datetime without a month. + "nanos": 42, # Optional. Fractions of seconds in nanoseconds. Must be from 0 to + # 999,999,999, defaults to 0. + "seconds": 42, # Optional. Seconds of minutes of the time. Must normally be from 0 to 59, + # defaults to 0. An API may allow the value 60 if it allows leap-seconds. + "timeZone": { # Represents a time zone from the # Time zone. + # [IANA Time Zone Database](https://www.iana.org/time-zones). + "id": "A String", # IANA Time Zone Database time zone. For example "America/New_York". + "version": "A String", # Optional. IANA Time Zone Database version number. For example "2019a". + }, + "utcOffset": "A String", # UTC offset. Must be whole seconds, between -18 hours and +18 hours. + # For example, a UTC offset of -4:00 would be represented as + # { seconds: -14400 }. + "year": 42, # Optional. Year of date. Must be from 1 to 9999, or 0 if specifying a + # datetime without a year. + }, + "windowStartTime": { # Represents civil time (or occasionally physical time). # The start civil timestamp of the window. + # This contains a time zone. + # + # This type can represent a civil time in one of a few possible ways: + # + # * When utc_offset is set and time_zone is unset: a civil time on a calendar + # day with a particular offset from UTC. + # * When time_zone is set and utc_offset is unset: a civil time on a calendar + # day in a particular time zone. + # * When neither time_zone nor utc_offset is set: a civil time on a calendar + # day in local time. + # + # The date is relative to the Proleptic Gregorian Calendar. + # + # If year, month, or day are 0, the DateTime is considered not to have a + # specific year, month, or day respectively. + # + # This type may also be used to represent a physical time if all the date and + # time fields are set and either case of the `time_offset` oneof is set. + # Consider using `Timestamp` message for physical time instead. If your use + # case also would like to store the user's timezone, that can be done in + # another field. + # + # This type is more flexible than some applications may want. Make sure to + # document and validate your application's limitations. + "day": 42, # Optional. Day of month. Must be from 1 to 31 and valid for the year and + # month, or 0 if specifying a datetime without a day. + "hours": 42, # Optional. Hours of day in 24 hour format. Should be from 0 to 23, defaults + # to 0 (midnight). An API may choose to allow the value "24:00:00" for + # scenarios like business closing time. + "minutes": 42, # Optional. Minutes of hour of day. Must be from 0 to 59, defaults to 0. + "month": 42, # Optional. Month of year. Must be from 1 to 12, or 0 if specifying a + # datetime without a month. + "nanos": 42, # Optional. Fractions of seconds in nanoseconds. Must be from 0 to + # 999,999,999, defaults to 0. + "seconds": 42, # Optional. Seconds of minutes of the time. Must normally be from 0 to 59, + # defaults to 0. An API may allow the value 60 if it allows leap-seconds. + "timeZone": { # Represents a time zone from the # Time zone. + # [IANA Time Zone Database](https://www.iana.org/time-zones). + "id": "A String", # IANA Time Zone Database time zone. For example "America/New_York". + "version": "A String", # Optional. IANA Time Zone Database version number. For example "2019a". + }, + "utcOffset": "A String", # UTC offset. Must be whole seconds, between -18 hours and +18 hours. + # For example, a UTC offset of -4:00 would be represented as + # { seconds: -14400 }. + "year": 42, # Optional. Year of date. Must be from 1 to 9999, or 0 if specifying a + # datetime without a year. + }, + }, + ], + }, "selfLink": "A String", # [Output Only] Server-defined URL for the resource. "status": "A String", # [Output Only] Status of the zone, either UP orDOWN. "supportsPzs": True or False, # Output only. [Output Only] Reserved for future use. @@ -331,6 +439,114 @@

Method Details

# zones. "name": "A String", # [Output Only] Name of the resource. "region": "A String", # [Output Only] Full URL reference to the region which hosts the zone. + "resourceStatus": { + "upcomingMaintenances": [ # Output only. [Output Only] The upcoming maintenance schedule. + { # The periodic partial maintenance schedule includes 52 weeks worth of + # maintenance windows. + # LINT.IfChange(PeriodicPartialMaintenanceSchedule) + "subType": "A String", # The maintenance type in which the zone is during the given window. + "targetResource": "A String", # The target resource that the maintenance window is for. + # For example, "projects/my-project/zones/us-central1-a". + "type": "A String", + "windowEndTime": { # Represents civil time (or occasionally physical time). # The end civil timestamp of the window (not inclusive). + # This contains a time zone. + # + # This type can represent a civil time in one of a few possible ways: + # + # * When utc_offset is set and time_zone is unset: a civil time on a calendar + # day with a particular offset from UTC. + # * When time_zone is set and utc_offset is unset: a civil time on a calendar + # day in a particular time zone. + # * When neither time_zone nor utc_offset is set: a civil time on a calendar + # day in local time. + # + # The date is relative to the Proleptic Gregorian Calendar. + # + # If year, month, or day are 0, the DateTime is considered not to have a + # specific year, month, or day respectively. + # + # This type may also be used to represent a physical time if all the date and + # time fields are set and either case of the `time_offset` oneof is set. + # Consider using `Timestamp` message for physical time instead. If your use + # case also would like to store the user's timezone, that can be done in + # another field. + # + # This type is more flexible than some applications may want. Make sure to + # document and validate your application's limitations. + "day": 42, # Optional. Day of month. Must be from 1 to 31 and valid for the year and + # month, or 0 if specifying a datetime without a day. + "hours": 42, # Optional. Hours of day in 24 hour format. Should be from 0 to 23, defaults + # to 0 (midnight). An API may choose to allow the value "24:00:00" for + # scenarios like business closing time. + "minutes": 42, # Optional. Minutes of hour of day. Must be from 0 to 59, defaults to 0. + "month": 42, # Optional. Month of year. Must be from 1 to 12, or 0 if specifying a + # datetime without a month. + "nanos": 42, # Optional. Fractions of seconds in nanoseconds. Must be from 0 to + # 999,999,999, defaults to 0. + "seconds": 42, # Optional. Seconds of minutes of the time. Must normally be from 0 to 59, + # defaults to 0. An API may allow the value 60 if it allows leap-seconds. + "timeZone": { # Represents a time zone from the # Time zone. + # [IANA Time Zone Database](https://www.iana.org/time-zones). + "id": "A String", # IANA Time Zone Database time zone. For example "America/New_York". + "version": "A String", # Optional. IANA Time Zone Database version number. For example "2019a". + }, + "utcOffset": "A String", # UTC offset. Must be whole seconds, between -18 hours and +18 hours. + # For example, a UTC offset of -4:00 would be represented as + # { seconds: -14400 }. + "year": 42, # Optional. Year of date. Must be from 1 to 9999, or 0 if specifying a + # datetime without a year. + }, + "windowStartTime": { # Represents civil time (or occasionally physical time). # The start civil timestamp of the window. + # This contains a time zone. + # + # This type can represent a civil time in one of a few possible ways: + # + # * When utc_offset is set and time_zone is unset: a civil time on a calendar + # day with a particular offset from UTC. + # * When time_zone is set and utc_offset is unset: a civil time on a calendar + # day in a particular time zone. + # * When neither time_zone nor utc_offset is set: a civil time on a calendar + # day in local time. + # + # The date is relative to the Proleptic Gregorian Calendar. + # + # If year, month, or day are 0, the DateTime is considered not to have a + # specific year, month, or day respectively. + # + # This type may also be used to represent a physical time if all the date and + # time fields are set and either case of the `time_offset` oneof is set. + # Consider using `Timestamp` message for physical time instead. If your use + # case also would like to store the user's timezone, that can be done in + # another field. + # + # This type is more flexible than some applications may want. Make sure to + # document and validate your application's limitations. + "day": 42, # Optional. Day of month. Must be from 1 to 31 and valid for the year and + # month, or 0 if specifying a datetime without a day. + "hours": 42, # Optional. Hours of day in 24 hour format. Should be from 0 to 23, defaults + # to 0 (midnight). An API may choose to allow the value "24:00:00" for + # scenarios like business closing time. + "minutes": 42, # Optional. Minutes of hour of day. Must be from 0 to 59, defaults to 0. + "month": 42, # Optional. Month of year. Must be from 1 to 12, or 0 if specifying a + # datetime without a month. + "nanos": 42, # Optional. Fractions of seconds in nanoseconds. Must be from 0 to + # 999,999,999, defaults to 0. + "seconds": 42, # Optional. Seconds of minutes of the time. Must normally be from 0 to 59, + # defaults to 0. An API may allow the value 60 if it allows leap-seconds. + "timeZone": { # Represents a time zone from the # Time zone. + # [IANA Time Zone Database](https://www.iana.org/time-zones). + "id": "A String", # IANA Time Zone Database time zone. For example "America/New_York". + "version": "A String", # Optional. IANA Time Zone Database version number. For example "2019a". + }, + "utcOffset": "A String", # UTC offset. Must be whole seconds, between -18 hours and +18 hours. + # For example, a UTC offset of -4:00 would be represented as + # { seconds: -14400 }. + "year": 42, # Optional. Year of date. Must be from 1 to 9999, or 0 if specifying a + # datetime without a year. + }, + }, + ], + }, "selfLink": "A String", # [Output Only] Server-defined URL for the resource. "status": "A String", # [Output Only] Status of the zone, either UP orDOWN. "supportsPzs": True or False, # Output only. [Output Only] Reserved for future use. diff --git a/docs/dyn/connectors_v2.projects.locations.connections.tools.html b/docs/dyn/connectors_v2.projects.locations.connections.tools.html index bf5be37c04..70eba3dd41 100644 --- a/docs/dyn/connectors_v2.projects.locations.connections.tools.html +++ b/docs/dyn/connectors_v2.projects.locations.connections.tools.html @@ -81,7 +81,7 @@

Instance Methods

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

Executes a specific tool.

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

+ list(parent, executionConfig_headers=None, pageSize=None, pageToken=None, toolNames=None, x__xgafv=None)

Lists all available tools.

list_next()

@@ -137,7 +137,7 @@

Method Details

- list(parent, executionConfig_headers=None, pageSize=None, pageToken=None, x__xgafv=None) + list(parent, executionConfig_headers=None, pageSize=None, pageToken=None, toolNames=None, x__xgafv=None)
Lists all available tools.
 
 Args:
@@ -145,6 +145,7 @@ 

Method Details

executionConfig_headers: string, headers to be used for the request. For example: headers:'{"x-integration-connectors-managed-connection-id":"conn-id","x-integration-connectors-runtime-config":"runtime-cfg"}' pageSize: integer, Page size. pageToken: string, Page token. + toolNames: string, List of tool names for selective tool fetching. (repeated) x__xgafv: string, V1 error format. Allowed values 1 - v1 error format diff --git a/docs/dyn/contactcenterinsights_v1.projects.locations.authorizedViewSets.authorizedViews.conversations.assessments.html b/docs/dyn/contactcenterinsights_v1.projects.locations.authorizedViewSets.authorizedViews.conversations.assessments.html index 119943597c..fef581ed25 100644 --- a/docs/dyn/contactcenterinsights_v1.projects.locations.authorizedViewSets.authorizedViews.conversations.assessments.html +++ b/docs/dyn/contactcenterinsights_v1.projects.locations.authorizedViewSets.authorizedViews.conversations.assessments.html @@ -136,6 +136,7 @@

Method Details

"displayName": "A String", # The agent's name. "dispositionCode": "A String", # A user-provided string indicating the outcome of the agent's segment of the call. "entrySubagentDisplayName": "A String", # The entry subagent's display name. + "entrySubagentId": "A String", # The entry subagent's ID. "location": "A String", # The agent's location. "team": "A String", # A user-specified string representing the agent's team. Deprecated in favor of the `teams` field. "teams": [ # User-specified strings representing the agent's teams. @@ -174,6 +175,7 @@

Method Details

"displayName": "A String", # The agent's name. "dispositionCode": "A String", # A user-provided string indicating the outcome of the agent's segment of the call. "entrySubagentDisplayName": "A String", # The entry subagent's display name. + "entrySubagentId": "A String", # The entry subagent's ID. "location": "A String", # The agent's location. "team": "A String", # A user-specified string representing the agent's team. Deprecated in favor of the `teams` field. "teams": [ # User-specified strings representing the agent's teams. @@ -205,6 +207,7 @@

Method Details

"displayName": "A String", # The agent's name. "dispositionCode": "A String", # A user-provided string indicating the outcome of the agent's segment of the call. "entrySubagentDisplayName": "A String", # The entry subagent's display name. + "entrySubagentId": "A String", # The entry subagent's ID. "location": "A String", # The agent's location. "team": "A String", # A user-specified string representing the agent's team. Deprecated in favor of the `teams` field. "teams": [ # User-specified strings representing the agent's teams. @@ -268,6 +271,7 @@

Method Details

"displayName": "A String", # The agent's name. "dispositionCode": "A String", # A user-provided string indicating the outcome of the agent's segment of the call. "entrySubagentDisplayName": "A String", # The entry subagent's display name. + "entrySubagentId": "A String", # The entry subagent's ID. "location": "A String", # The agent's location. "team": "A String", # A user-specified string representing the agent's team. Deprecated in favor of the `teams` field. "teams": [ # User-specified strings representing the agent's teams. @@ -306,6 +310,7 @@

Method Details

"displayName": "A String", # The agent's name. "dispositionCode": "A String", # A user-provided string indicating the outcome of the agent's segment of the call. "entrySubagentDisplayName": "A String", # The entry subagent's display name. + "entrySubagentId": "A String", # The entry subagent's ID. "location": "A String", # The agent's location. "team": "A String", # A user-specified string representing the agent's team. Deprecated in favor of the `teams` field. "teams": [ # User-specified strings representing the agent's teams. @@ -349,6 +354,7 @@

Method Details

"displayName": "A String", # The agent's name. "dispositionCode": "A String", # A user-provided string indicating the outcome of the agent's segment of the call. "entrySubagentDisplayName": "A String", # The entry subagent's display name. + "entrySubagentId": "A String", # The entry subagent's ID. "location": "A String", # The agent's location. "team": "A String", # A user-specified string representing the agent's team. Deprecated in favor of the `teams` field. "teams": [ # User-specified strings representing the agent's teams. @@ -410,6 +416,7 @@

Method Details

"displayName": "A String", # The agent's name. "dispositionCode": "A String", # A user-provided string indicating the outcome of the agent's segment of the call. "entrySubagentDisplayName": "A String", # The entry subagent's display name. + "entrySubagentId": "A String", # The entry subagent's ID. "location": "A String", # The agent's location. "team": "A String", # A user-specified string representing the agent's team. Deprecated in favor of the `teams` field. "teams": [ # User-specified strings representing the agent's teams. diff --git a/docs/dyn/contactcenterinsights_v1.projects.locations.authorizedViewSets.authorizedViews.conversations.html b/docs/dyn/contactcenterinsights_v1.projects.locations.authorizedViewSets.authorizedViews.conversations.html index 0e138ffeff..0b0d7f0c6e 100644 --- a/docs/dyn/contactcenterinsights_v1.projects.locations.authorizedViewSets.authorizedViews.conversations.html +++ b/docs/dyn/contactcenterinsights_v1.projects.locations.authorizedViewSets.authorizedViews.conversations.html @@ -500,6 +500,7 @@

Method Details

"displayName": "A String", # The agent's name. "dispositionCode": "A String", # A user-provided string indicating the outcome of the agent's segment of the call. "entrySubagentDisplayName": "A String", # The entry subagent's display name. + "entrySubagentId": "A String", # The entry subagent's ID. "location": "A String", # The agent's location. "team": "A String", # A user-specified string representing the agent's team. Deprecated in favor of the `teams` field. "teams": [ # User-specified strings representing the agent's teams. @@ -1033,6 +1034,7 @@

Method Details

"displayName": "A String", # The agent's name. "dispositionCode": "A String", # A user-provided string indicating the outcome of the agent's segment of the call. "entrySubagentDisplayName": "A String", # The entry subagent's display name. + "entrySubagentId": "A String", # The entry subagent's ID. "location": "A String", # The agent's location. "team": "A String", # A user-specified string representing the agent's team. Deprecated in favor of the `teams` field. "teams": [ # User-specified strings representing the agent's teams. diff --git a/docs/dyn/contactcenterinsights_v1.projects.locations.autoLabelingRules.html b/docs/dyn/contactcenterinsights_v1.projects.locations.autoLabelingRules.html index b23d81b549..bcb63cfb0f 100644 --- a/docs/dyn/contactcenterinsights_v1.projects.locations.autoLabelingRules.html +++ b/docs/dyn/contactcenterinsights_v1.projects.locations.autoLabelingRules.html @@ -615,6 +615,7 @@

Method Details

"displayName": "A String", # The agent's name. "dispositionCode": "A String", # A user-provided string indicating the outcome of the agent's segment of the call. "entrySubagentDisplayName": "A String", # The entry subagent's display name. + "entrySubagentId": "A String", # The entry subagent's ID. "location": "A String", # The agent's location. "team": "A String", # A user-specified string representing the agent's team. Deprecated in favor of the `teams` field. "teams": [ # User-specified strings representing the agent's teams. diff --git a/docs/dyn/contactcenterinsights_v1.projects.locations.conversations.assessments.html b/docs/dyn/contactcenterinsights_v1.projects.locations.conversations.assessments.html index 656a75046e..962c05a7e2 100644 --- a/docs/dyn/contactcenterinsights_v1.projects.locations.conversations.assessments.html +++ b/docs/dyn/contactcenterinsights_v1.projects.locations.conversations.assessments.html @@ -136,6 +136,7 @@

Method Details

"displayName": "A String", # The agent's name. "dispositionCode": "A String", # A user-provided string indicating the outcome of the agent's segment of the call. "entrySubagentDisplayName": "A String", # The entry subagent's display name. + "entrySubagentId": "A String", # The entry subagent's ID. "location": "A String", # The agent's location. "team": "A String", # A user-specified string representing the agent's team. Deprecated in favor of the `teams` field. "teams": [ # User-specified strings representing the agent's teams. @@ -174,6 +175,7 @@

Method Details

"displayName": "A String", # The agent's name. "dispositionCode": "A String", # A user-provided string indicating the outcome of the agent's segment of the call. "entrySubagentDisplayName": "A String", # The entry subagent's display name. + "entrySubagentId": "A String", # The entry subagent's ID. "location": "A String", # The agent's location. "team": "A String", # A user-specified string representing the agent's team. Deprecated in favor of the `teams` field. "teams": [ # User-specified strings representing the agent's teams. @@ -205,6 +207,7 @@

Method Details

"displayName": "A String", # The agent's name. "dispositionCode": "A String", # A user-provided string indicating the outcome of the agent's segment of the call. "entrySubagentDisplayName": "A String", # The entry subagent's display name. + "entrySubagentId": "A String", # The entry subagent's ID. "location": "A String", # The agent's location. "team": "A String", # A user-specified string representing the agent's team. Deprecated in favor of the `teams` field. "teams": [ # User-specified strings representing the agent's teams. @@ -268,6 +271,7 @@

Method Details

"displayName": "A String", # The agent's name. "dispositionCode": "A String", # A user-provided string indicating the outcome of the agent's segment of the call. "entrySubagentDisplayName": "A String", # The entry subagent's display name. + "entrySubagentId": "A String", # The entry subagent's ID. "location": "A String", # The agent's location. "team": "A String", # A user-specified string representing the agent's team. Deprecated in favor of the `teams` field. "teams": [ # User-specified strings representing the agent's teams. @@ -306,6 +310,7 @@

Method Details

"displayName": "A String", # The agent's name. "dispositionCode": "A String", # A user-provided string indicating the outcome of the agent's segment of the call. "entrySubagentDisplayName": "A String", # The entry subagent's display name. + "entrySubagentId": "A String", # The entry subagent's ID. "location": "A String", # The agent's location. "team": "A String", # A user-specified string representing the agent's team. Deprecated in favor of the `teams` field. "teams": [ # User-specified strings representing the agent's teams. @@ -349,6 +354,7 @@

Method Details

"displayName": "A String", # The agent's name. "dispositionCode": "A String", # A user-provided string indicating the outcome of the agent's segment of the call. "entrySubagentDisplayName": "A String", # The entry subagent's display name. + "entrySubagentId": "A String", # The entry subagent's ID. "location": "A String", # The agent's location. "team": "A String", # A user-specified string representing the agent's team. Deprecated in favor of the `teams` field. "teams": [ # User-specified strings representing the agent's teams. @@ -410,6 +416,7 @@

Method Details

"displayName": "A String", # The agent's name. "dispositionCode": "A String", # A user-provided string indicating the outcome of the agent's segment of the call. "entrySubagentDisplayName": "A String", # The entry subagent's display name. + "entrySubagentId": "A String", # The entry subagent's ID. "location": "A String", # The agent's location. "team": "A String", # A user-specified string representing the agent's team. Deprecated in favor of the `teams` field. "teams": [ # User-specified strings representing the agent's teams. diff --git a/docs/dyn/contactcenterinsights_v1.projects.locations.conversations.html b/docs/dyn/contactcenterinsights_v1.projects.locations.conversations.html index a85c061334..23589ed188 100644 --- a/docs/dyn/contactcenterinsights_v1.projects.locations.conversations.html +++ b/docs/dyn/contactcenterinsights_v1.projects.locations.conversations.html @@ -594,6 +594,7 @@

Method Details

"displayName": "A String", # The agent's name. "dispositionCode": "A String", # A user-provided string indicating the outcome of the agent's segment of the call. "entrySubagentDisplayName": "A String", # The entry subagent's display name. + "entrySubagentId": "A String", # The entry subagent's ID. "location": "A String", # The agent's location. "team": "A String", # A user-specified string representing the agent's team. Deprecated in favor of the `teams` field. "teams": [ # User-specified strings representing the agent's teams. @@ -1110,6 +1111,7 @@

Method Details

"displayName": "A String", # The agent's name. "dispositionCode": "A String", # A user-provided string indicating the outcome of the agent's segment of the call. "entrySubagentDisplayName": "A String", # The entry subagent's display name. + "entrySubagentId": "A String", # The entry subagent's ID. "location": "A String", # The agent's location. "team": "A String", # A user-specified string representing the agent's team. Deprecated in favor of the `teams` field. "teams": [ # User-specified strings representing the agent's teams. @@ -1684,6 +1686,7 @@

Method Details

"displayName": "A String", # The agent's name. "dispositionCode": "A String", # A user-provided string indicating the outcome of the agent's segment of the call. "entrySubagentDisplayName": "A String", # The entry subagent's display name. + "entrySubagentId": "A String", # The entry subagent's ID. "location": "A String", # The agent's location. "team": "A String", # A user-specified string representing the agent's team. Deprecated in favor of the `teams` field. "teams": [ # User-specified strings representing the agent's teams. @@ -2286,6 +2289,7 @@

Method Details

"displayName": "A String", # The agent's name. "dispositionCode": "A String", # A user-provided string indicating the outcome of the agent's segment of the call. "entrySubagentDisplayName": "A String", # The entry subagent's display name. + "entrySubagentId": "A String", # The entry subagent's ID. "location": "A String", # The agent's location. "team": "A String", # A user-specified string representing the agent's team. Deprecated in favor of the `teams` field. "teams": [ # User-specified strings representing the agent's teams. @@ -2820,6 +2824,7 @@

Method Details

"displayName": "A String", # The agent's name. "dispositionCode": "A String", # A user-provided string indicating the outcome of the agent's segment of the call. "entrySubagentDisplayName": "A String", # The entry subagent's display name. + "entrySubagentId": "A String", # The entry subagent's ID. "location": "A String", # The agent's location. "team": "A String", # A user-specified string representing the agent's team. Deprecated in favor of the `teams` field. "teams": [ # User-specified strings representing the agent's teams. @@ -3338,6 +3343,7 @@

Method Details

"displayName": "A String", # The agent's name. "dispositionCode": "A String", # A user-provided string indicating the outcome of the agent's segment of the call. "entrySubagentDisplayName": "A String", # The entry subagent's display name. + "entrySubagentId": "A String", # The entry subagent's ID. "location": "A String", # The agent's location. "team": "A String", # A user-specified string representing the agent's team. Deprecated in favor of the `teams` field. "teams": [ # User-specified strings representing the agent's teams. @@ -3913,6 +3919,7 @@

Method Details

"displayName": "A String", # The agent's name. "dispositionCode": "A String", # A user-provided string indicating the outcome of the agent's segment of the call. "entrySubagentDisplayName": "A String", # The entry subagent's display name. + "entrySubagentId": "A String", # The entry subagent's ID. "location": "A String", # The agent's location. "team": "A String", # A user-specified string representing the agent's team. Deprecated in favor of the `teams` field. "teams": [ # User-specified strings representing the agent's teams. diff --git a/docs/dyn/contactcenterinsights_v1.projects.locations.datasets.conversations.html b/docs/dyn/contactcenterinsights_v1.projects.locations.datasets.conversations.html index dcbef8ef2b..ed88c4c1e3 100644 --- a/docs/dyn/contactcenterinsights_v1.projects.locations.datasets.conversations.html +++ b/docs/dyn/contactcenterinsights_v1.projects.locations.datasets.conversations.html @@ -555,6 +555,7 @@

Method Details

"displayName": "A String", # The agent's name. "dispositionCode": "A String", # A user-provided string indicating the outcome of the agent's segment of the call. "entrySubagentDisplayName": "A String", # The entry subagent's display name. + "entrySubagentId": "A String", # The entry subagent's ID. "location": "A String", # The agent's location. "team": "A String", # A user-specified string representing the agent's team. Deprecated in favor of the `teams` field. "teams": [ # User-specified strings representing the agent's teams. @@ -1157,6 +1158,7 @@

Method Details

"displayName": "A String", # The agent's name. "dispositionCode": "A String", # A user-provided string indicating the outcome of the agent's segment of the call. "entrySubagentDisplayName": "A String", # The entry subagent's display name. + "entrySubagentId": "A String", # The entry subagent's ID. "location": "A String", # The agent's location. "team": "A String", # A user-specified string representing the agent's team. Deprecated in favor of the `teams` field. "teams": [ # User-specified strings representing the agent's teams. diff --git a/docs/dyn/contactcenterinsights_v1.projects.locations.diagnostics.html b/docs/dyn/contactcenterinsights_v1.projects.locations.diagnostics.html index 5601d9aae4..929bc3f8c4 100644 --- a/docs/dyn/contactcenterinsights_v1.projects.locations.diagnostics.html +++ b/docs/dyn/contactcenterinsights_v1.projects.locations.diagnostics.html @@ -84,7 +84,7 @@

Instance Methods

get(name, x__xgafv=None)

Gets a diagnostic.

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

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

Lists diagnostics.

list_next()

@@ -128,11 +128,16 @@

Method Details

An object of the form: { # The diagnostic resource. + "agentDisplayName": "A String", # Output only. The display name of the agent associated with the diagnostic. + "agentId": "A String", # Output only. The ID of the agent associated with the diagnostic. "analysisSummary": "A String", # Output only. The complete sequence of thoughts and actions taken by the agent. + "appId": "A String", # Output only. The application ID associated with the diagnostic. + "appVersion": "A String", # Output only. The application version associated with the diagnostic. "conversationFilter": "A String", # Output only. The filter used to select the conversations that were included in the diagnostic. "createTime": "A String", # Output only. The time at which the diagnostic was created. + "groupCreateTime": "A String", # Output only. The timestamp when the group was created. "name": "A String", # Immutable. Identifier. The resource name of the diagnostic. - "report": { # A diagnostic report containing aggregate metrics and intent breakdowns. # Output only. The report containing the findings of the diagnostic. + "report": { # A diagnostic report containing loss patterns and problematic slice stats. # Output only. The report containing the findings of the diagnostic. "conversationSlices": { # Output only. A map of conversation slices used in the report. "a_key": { # Output only. A map of conversation slices used in the report. "conversationIds": [ # The list of conversation IDs that match this slice. @@ -237,11 +242,13 @@

Method Details

- list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None) + list(parent, appId=None, appVersion=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
Lists diagnostics.
 
 Args:
   parent: string, Required. The parent resource of the diagnostics. (required)
+  appId: string, Optional. The CES App ID to filter diagnostics by.
+  appVersion: string, Optional. The CES App version to filter diagnostics by. Setting to "-" filters to diagnostics created using "-" (the latest draft version). Note that reports created at different times may correspond to different draft instructions. Setting to "" (empty) retrieves all diagnostics for the app_id regardless of version.
   filter: string, Optional. A filter to apply to the list (e.g. `create_time > "2023-01-01T00:00:00Z"`).
   pageSize: integer, Optional. The maximum number of diagnostics to return. The service may return fewer than this value. If unspecified, at most 100 diagnostics will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
   pageToken: string, Optional. A page token, received from a previous `ListDiagnostics` call. Provide this to retrieve the subsequent page.
@@ -256,11 +263,16 @@ 

Method Details

{ # The response from a ListDiagnostics request. "diagnostics": [ # Optional. The diagnostics that match the request. { # The diagnostic resource. + "agentDisplayName": "A String", # Output only. The display name of the agent associated with the diagnostic. + "agentId": "A String", # Output only. The ID of the agent associated with the diagnostic. "analysisSummary": "A String", # Output only. The complete sequence of thoughts and actions taken by the agent. + "appId": "A String", # Output only. The application ID associated with the diagnostic. + "appVersion": "A String", # Output only. The application version associated with the diagnostic. "conversationFilter": "A String", # Output only. The filter used to select the conversations that were included in the diagnostic. "createTime": "A String", # Output only. The time at which the diagnostic was created. + "groupCreateTime": "A String", # Output only. The timestamp when the group was created. "name": "A String", # Immutable. Identifier. The resource name of the diagnostic. - "report": { # A diagnostic report containing aggregate metrics and intent breakdowns. # Output only. The report containing the findings of the diagnostic. + "report": { # A diagnostic report containing loss patterns and problematic slice stats. # Output only. The report containing the findings of the diagnostic. "conversationSlices": { # Output only. A map of conversation slices used in the report. "a_key": { # Output only. A map of conversation slices used in the report. "conversationIds": [ # The list of conversation IDs that match this slice. diff --git a/docs/dyn/contactcenterinsights_v1.projects.locations.html b/docs/dyn/contactcenterinsights_v1.projects.locations.html index 85361d5482..32bb17a51c 100644 --- a/docs/dyn/contactcenterinsights_v1.projects.locations.html +++ b/docs/dyn/contactcenterinsights_v1.projects.locations.html @@ -370,10 +370,15 @@

Method Details

The object takes the form of: { # The request to analyze conversation data using agentic workflows. This RPC triggers a complex analysis process that may involve several steps of reasoning and tool execution. + "agentDisplayName": "A String", # ces agent display name (e.g., "Steering", "Billing"). + "agentId": "A String", # ces agent id to diagnose. + "appId": "A String", # Required. The CES App ID. + "appVersion": "A String", # Required. The CES App version of the agent. Setting to "-" uses the latest draft version. Note that the agent active during the conversation history may have different instructions or tool definitions compared with the latest draft version. "dryRun": True or False, # Optional. Deprecated: If true, the request will be validated and a simulation of the analysis will be performed without actually executing the task. This field is unused. Use validate_only instead. "filter": "A String", # Optional. AIP-160 compliant filter for selecting target conversations. "fullReport": True or False, # Optional. Deprecated: If true, the agent will generate a full diagnostic report for all sub-agents. Subagent reporting configuration is unused. The final diagnostic details are already persisted inside the Diagnostic resource instead. - "instructions": "A String", # Optional. Specific instructions for the agent. + "groupId": "A String", # Optional. A unique identifier used to group multiple diagnostic requests triggered under the same run batch or cron job. + "instructions": "A String", # Optional. Deprecated: Specific instructions for the agent. Use app_id and subagent fields instead. "maxSteps": 42, # Optional. The maximum number of steps the agent can take during the execution of the task. Defaults to 10. "metricType": "A String", # Optional. The type of metric being diagnosed. "outputConfig": { # Configuration for where to export or return the analysis findings. # Optional. Deprecated: The configuration for the output of the task. The export destination is unused. Detailed markdown and conversation slices are already persisted inside the Diagnostic resource instead. @@ -1101,6 +1106,7 @@

Method Details

"displayName": "A String", # The agent's name. "dispositionCode": "A String", # A user-provided string indicating the outcome of the agent's segment of the call. "entrySubagentDisplayName": "A String", # The entry subagent's display name. + "entrySubagentId": "A String", # The entry subagent's ID. "location": "A String", # The agent's location. "team": "A String", # A user-specified string representing the agent's team. Deprecated in favor of the `teams` field. "teams": [ # User-specified strings representing the agent's teams. diff --git a/docs/dyn/container_v1.projects.locations.clusters.html b/docs/dyn/container_v1.projects.locations.clusters.html index 796aed6d43..1d1c3f58da 100644 --- a/docs/dyn/container_v1.projects.locations.clusters.html +++ b/docs/dyn/container_v1.projects.locations.clusters.html @@ -273,6 +273,9 @@

Method Details

{ # CreateClusterRequest creates a cluster. "cluster": { # A Google Kubernetes Engine cluster. # Required. A [cluster resource](https://cloud.google.com/container-engine/reference/rest/v1/projects.locations.clusters) "addonsConfig": { # Configuration for the addons that can be automatically spun up in the cluster, enabling additional functionality. # Configurations for the various addons available to run in the cluster. + "agentSandboxConfig": { # Configuration for the AgentSandbox addon. # Optional. Configuration for the AgentSandbox addon. + "enabled": True or False, # Optional. Whether AgentSandbox is enabled for this cluster. + }, "cloudRunConfig": { # Configuration options for the Cloud Run feature. # Configuration for the Cloud Run addon, which allows the user to use a managed Knative service. "disabled": True or False, # Whether Cloud Run addon is enabled for this cluster. "loadBalancerType": "A String", # Which load balancer type is installed for Cloud Run. @@ -710,6 +713,9 @@

Method Details

"network": "A String", # The name of the Google Compute Engine [network](https://cloud.google.com/compute/docs/networks-and-firewalls#networks) to which the cluster is connected. If left unspecified, the `default` network will be used. "networkConfig": { # NetworkConfig reports the relative names of network & subnetwork. # Configuration for cluster networking. "datapathProvider": "A String", # The desired datapath provider for this cluster. By default, uses the IPTables-based kube-proxy implementation. + "dataplaneV2Config": { # DataplaneV2Config is the configuration for DPv2. # Optional. DataplaneV2Config specifies the DPv2 configuration. + "scalabilityMode": "A String", # Optional. Scalability mode for the cluster. + }, "defaultEnablePrivateNodes": True or False, # Controls whether by default nodes have private IP addresses only. It is invalid to specify both PrivateClusterConfig.enablePrivateNodes and this field at the same time. To update the default setting, use ClusterUpdate.desired_default_enable_private_nodes "defaultSnatStatus": { # DefaultSnatStatus contains the desired state of whether default sNAT should be disabled on the cluster. # Whether the cluster disables default in-node sNAT rules. In-node sNAT rules will be disabled when default_snat_status is disabled. When disabled is set to false, default IP masquerade rules will be applied to the nodes to prevent sNAT on cluster internal traffic. "disabled": True or False, # Disables cluster default sNAT rules. @@ -951,7 +957,7 @@

Method Details

"swapSizePercent": 42, # Specifies the size of the swap space as a percentage of the ephemeral local SSD capacity. }, }, - "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_mtu_probing net.ipv4.tcp_max_orphans net.ipv4.tcp_max_tw_buckets net.ipv4.tcp_syn_retries net.ipv4.tcp_ecn net.ipv4.tcp_congestion_control net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.shmmni kernel.shmmax kernel.shmall kernel.perf_event_paranoid kernel.sched_rt_runtime_us kernel.softlockup_panic kernel.yama.ptrace_scope kernel.kptr_restrict kernel.dmesg_restrict kernel.sysrq fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_background_bytes vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_bytes vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes + "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.neigh.default.gc_thresh1 net.ipv4.neigh.default.gc_thresh2 net.ipv4.neigh.default.gc_thresh3 net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_mtu_probing net.ipv4.tcp_max_orphans net.ipv4.tcp_max_tw_buckets net.ipv4.tcp_syn_retries net.ipv4.tcp_ecn net.ipv4.tcp_congestion_control net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.keys.maxkeys kernel.keys.maxbytes kernel.shmmni kernel.shmmax kernel.shmall kernel.perf_event_paranoid kernel.sched_rt_runtime_us kernel.softlockup_panic kernel.yama.ptrace_scope kernel.kptr_restrict kernel.dmesg_restrict kernel.sysrq fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_background_bytes vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_bytes vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes "a_key": "A String", }, "transparentHugepageDefrag": "A String", # Optional. Defines the transparent hugepage defrag configuration on the node. VM hugepage allocation can be managed by either limiting defragmentation for delayed allocation or skipping it entirely for immediate allocation only. See https://docs.kernel.org/admin-guide/mm/transhuge.html for more details. @@ -974,6 +980,11 @@

Method Details

}, "minCpuPlatform": "A String", # Minimum CPU platform to be used by this instance. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as `minCpuPlatform: "Intel Haswell"` or `minCpuPlatform: "Intel Sandy Bridge"`. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform) "nodeGroup": "A String", # Setting this field will assign instances of this pool to run on the specified node group. This is useful for running workloads on [sole tenant nodes](https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes). + "nodeImageConfig": { # CustomImageConfig contains the information r # The node image configuration to use for this node pool. Note that this is only applicable for node pools using image_type=CUSTOM. + "image": "A String", # The name of the image to use for this node. + "imageFamily": "A String", # The name of the image family to use for this node. + "imageProject": "A String", # The project containing the image to use for this node. + }, "oauthScopes": [ # The set of Google API scopes to be made available on all of the node VMs under the "default" service account. The following scopes are recommended, but not required, and by default are not included: * `https://www.googleapis.com/auth/compute` is required for mounting persistent storage on your nodes. * `https://www.googleapis.com/auth/devstorage.read_only` is required for communicating with **gcr.io** (the [Artifact Registry](https://cloud.google.com/artifact-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added. "A String", ], @@ -1045,6 +1056,9 @@

Method Details

"mode": "A String", # Mode is the configuration for how to expose metadata to workloads running on the node pool. }, }, + "nodeCreationConfig": { # NodeCreationConfig defines the settings of node creation mode. # Optional. Configuration for Node Creation Mode. + "nodeCreationMode": "A String", # The mode of node creation. + }, "nodeIpv4CidrSize": 42, # Output only. The size of the address space on each node for hosting containers. This is provisioned from within the `container_ipv4_cidr` range. This field will only be set when cluster is in route-based network mode. "nodePoolAutoConfig": { # Node pool configs that apply to all auto-provisioned node pools in autopilot clusters and node auto-provisioning enabled clusters. # Node pool configs that apply to all auto-provisioned node pools in autopilot clusters and node auto-provisioning enabled clusters. "linuxNodeConfig": { # Parameters that can be configured on Linux nodes. # Output only. Configuration options for Linux nodes. @@ -1086,7 +1100,7 @@

Method Details

"swapSizePercent": 42, # Specifies the size of the swap space as a percentage of the ephemeral local SSD capacity. }, }, - "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_mtu_probing net.ipv4.tcp_max_orphans net.ipv4.tcp_max_tw_buckets net.ipv4.tcp_syn_retries net.ipv4.tcp_ecn net.ipv4.tcp_congestion_control net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.shmmni kernel.shmmax kernel.shmall kernel.perf_event_paranoid kernel.sched_rt_runtime_us kernel.softlockup_panic kernel.yama.ptrace_scope kernel.kptr_restrict kernel.dmesg_restrict kernel.sysrq fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_background_bytes vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_bytes vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes + "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.neigh.default.gc_thresh1 net.ipv4.neigh.default.gc_thresh2 net.ipv4.neigh.default.gc_thresh3 net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_mtu_probing net.ipv4.tcp_max_orphans net.ipv4.tcp_max_tw_buckets net.ipv4.tcp_syn_retries net.ipv4.tcp_ecn net.ipv4.tcp_congestion_control net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.keys.maxkeys kernel.keys.maxbytes kernel.shmmni kernel.shmmax kernel.shmall kernel.perf_event_paranoid kernel.sched_rt_runtime_us kernel.softlockup_panic kernel.yama.ptrace_scope kernel.kptr_restrict kernel.dmesg_restrict kernel.sysrq fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_background_bytes vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_bytes vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes "a_key": "A String", }, "transparentHugepageDefrag": "A String", # Optional. Defines the transparent hugepage defrag configuration on the node. VM hugepage allocation can be managed by either limiting defragmentation for delayed allocation or skipping it entirely for immediate allocation only. See https://docs.kernel.org/admin-guide/mm/transhuge.html for more details. @@ -1513,7 +1527,7 @@

Method Details

"swapSizePercent": 42, # Specifies the size of the swap space as a percentage of the ephemeral local SSD capacity. }, }, - "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_mtu_probing net.ipv4.tcp_max_orphans net.ipv4.tcp_max_tw_buckets net.ipv4.tcp_syn_retries net.ipv4.tcp_ecn net.ipv4.tcp_congestion_control net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.shmmni kernel.shmmax kernel.shmall kernel.perf_event_paranoid kernel.sched_rt_runtime_us kernel.softlockup_panic kernel.yama.ptrace_scope kernel.kptr_restrict kernel.dmesg_restrict kernel.sysrq fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_background_bytes vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_bytes vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes + "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.neigh.default.gc_thresh1 net.ipv4.neigh.default.gc_thresh2 net.ipv4.neigh.default.gc_thresh3 net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_mtu_probing net.ipv4.tcp_max_orphans net.ipv4.tcp_max_tw_buckets net.ipv4.tcp_syn_retries net.ipv4.tcp_ecn net.ipv4.tcp_congestion_control net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.keys.maxkeys kernel.keys.maxbytes kernel.shmmni kernel.shmmax kernel.shmall kernel.perf_event_paranoid kernel.sched_rt_runtime_us kernel.softlockup_panic kernel.yama.ptrace_scope kernel.kptr_restrict kernel.dmesg_restrict kernel.sysrq fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_background_bytes vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_bytes vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes "a_key": "A String", }, "transparentHugepageDefrag": "A String", # Optional. Defines the transparent hugepage defrag configuration on the node. VM hugepage allocation can be managed by either limiting defragmentation for delayed allocation or skipping it entirely for immediate allocation only. See https://docs.kernel.org/admin-guide/mm/transhuge.html for more details. @@ -1536,6 +1550,11 @@

Method Details

}, "minCpuPlatform": "A String", # Minimum CPU platform to be used by this instance. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as `minCpuPlatform: "Intel Haswell"` or `minCpuPlatform: "Intel Sandy Bridge"`. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform) "nodeGroup": "A String", # Setting this field will assign instances of this pool to run on the specified node group. This is useful for running workloads on [sole tenant nodes](https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes). + "nodeImageConfig": { # CustomImageConfig contains the information r # The node image configuration to use for this node pool. Note that this is only applicable for node pools using image_type=CUSTOM. + "image": "A String", # The name of the image to use for this node. + "imageFamily": "A String", # The name of the image family to use for this node. + "imageProject": "A String", # The project containing the image to use for this node. + }, "oauthScopes": [ # The set of Google API scopes to be made available on all of the node VMs under the "default" service account. The following scopes are recommended, but not required, and by default are not included: * `https://www.googleapis.com/auth/compute` is required for mounting persistent storage on your nodes. * `https://www.googleapis.com/auth/devstorage.read_only` is required for communicating with **gcr.io** (the [Artifact Registry](https://cloud.google.com/artifact-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added. "A String", ], @@ -1615,6 +1634,13 @@

Method Details

"locations": [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the NodePool's nodes should be located. If this value is unspecified during node pool creation, the [Cluster.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters#Cluster.FIELDS.locations) value will be used, instead. Warning: changing node pool locations will result in nodes being added and/or removed. "A String", ], + "maintenancePolicy": { # Defines the maintenance policy for the node pool. # Optional. Specifies the maintenance policy for the node pool. + "exclusionUntilEndOfSupport": { # Defines the maintenance exclusion for the node pool. # Optional. The exclusion until end of support for the node pool. + "enabled": True or False, # Optional. Indicates whether the exclusion is enabled. + "endTime": "A String", # Output only. The end time of the maintenance exclusion. It is output only. It is the cluster control plane version's end of support time, or end of extended support time when the cluster is on extended support channel. + "startTime": "A String", # Output only. The start time of the maintenance exclusion. It is output only. It is the exclusion creation time. + }, + }, "management": { # NodeManagement defines the set of node management services turned on for the node pool. # NodeManagement configuration for this NodePool. "autoRepair": True or False, # A flag that specifies whether the node auto-repair is enabled for the node pool. If enabled, the nodes in this node pool will be monitored and, if they fail health checks too many times, an automatic repair action will be triggered. "autoUpgrade": True or False, # A flag that specifies whether node auto-upgrade is enabled for the node pool. If enabled, node auto-upgrade helps keep the nodes in your node pool up to date with the latest release version of Kubernetes. @@ -1647,6 +1673,7 @@

Method Details

], "createPodRange": True or False, # Input only. Whether to create a new range for pod IPs in this node pool. Defaults are provided for `pod_range` and `pod_ipv4_cidr_block` if they are not specified. If neither `create_pod_range` or `pod_range` are specified, the cluster-level default (`ip_allocation_policy.cluster_ipv4_cidr_block`) is used. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created. "enablePrivateNodes": True or False, # Whether nodes have internal IP addresses only. If enable_private_nodes is not specified, then the value is derived from Cluster.NetworkConfig.default_enable_private_nodes + "network": "A String", # Optional. Immutable. The VPC network for the node pool. "networkPerformanceConfig": { # Configuration of all network bandwidth tiers # Network bandwidth tier configuration. "totalEgressBandwidthTier": "A String", # Specifies the total network bandwidth tier for the NodePool. }, @@ -1662,6 +1689,8 @@

Method Details

"subnetwork": "A String", # Optional. The subnetwork name/path for the node pool. Format: projects/{project}/regions/{region}/subnetworks/{subnetwork} If the cluster is associated with multiple subnetworks, the subnetwork can be either: - A user supplied subnetwork name during node pool creation (e.g., `my-subnet`). The name must be between 1 and 63 characters long, start with a letter, contain only letters, numbers, and hyphens, and end with a letter or a number. - A full subnetwork path during node pool creation, such as `projects/gke-project/regions/us-central1/subnetworks/my-subnet` - A subnetwork path picked based on the IP utilization during node pool creation and is immutable. }, "nodeDrainConfig": { # NodeDrainConfig contains the node drain related configurations for this node pool. # Specifies the node drain configuration for this node pool. + "graceTerminationDuration": "A String", # The duration of the grace termination period for node drain. + "pdbTimeoutDuration": "A String", # The duration of the PDB timeout period for node drain. "respectPdbDuringNodePoolDeletion": True or False, # Whether to respect PDB during node pool deletion. }, "placementPolicy": { # PlacementPolicy defines the placement policy used by the node pool. # Specifies the node placement policy. @@ -2010,6 +2039,9 @@

Method Details

{ # A Google Kubernetes Engine cluster. "addonsConfig": { # Configuration for the addons that can be automatically spun up in the cluster, enabling additional functionality. # Configurations for the various addons available to run in the cluster. + "agentSandboxConfig": { # Configuration for the AgentSandbox addon. # Optional. Configuration for the AgentSandbox addon. + "enabled": True or False, # Optional. Whether AgentSandbox is enabled for this cluster. + }, "cloudRunConfig": { # Configuration options for the Cloud Run feature. # Configuration for the Cloud Run addon, which allows the user to use a managed Knative service. "disabled": True or False, # Whether Cloud Run addon is enabled for this cluster. "loadBalancerType": "A String", # Which load balancer type is installed for Cloud Run. @@ -2447,6 +2479,9 @@

Method Details

"network": "A String", # The name of the Google Compute Engine [network](https://cloud.google.com/compute/docs/networks-and-firewalls#networks) to which the cluster is connected. If left unspecified, the `default` network will be used. "networkConfig": { # NetworkConfig reports the relative names of network & subnetwork. # Configuration for cluster networking. "datapathProvider": "A String", # The desired datapath provider for this cluster. By default, uses the IPTables-based kube-proxy implementation. + "dataplaneV2Config": { # DataplaneV2Config is the configuration for DPv2. # Optional. DataplaneV2Config specifies the DPv2 configuration. + "scalabilityMode": "A String", # Optional. Scalability mode for the cluster. + }, "defaultEnablePrivateNodes": True or False, # Controls whether by default nodes have private IP addresses only. It is invalid to specify both PrivateClusterConfig.enablePrivateNodes and this field at the same time. To update the default setting, use ClusterUpdate.desired_default_enable_private_nodes "defaultSnatStatus": { # DefaultSnatStatus contains the desired state of whether default sNAT should be disabled on the cluster. # Whether the cluster disables default in-node sNAT rules. In-node sNAT rules will be disabled when default_snat_status is disabled. When disabled is set to false, default IP masquerade rules will be applied to the nodes to prevent sNAT on cluster internal traffic. "disabled": True or False, # Disables cluster default sNAT rules. @@ -2688,7 +2723,7 @@

Method Details

"swapSizePercent": 42, # Specifies the size of the swap space as a percentage of the ephemeral local SSD capacity. }, }, - "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_mtu_probing net.ipv4.tcp_max_orphans net.ipv4.tcp_max_tw_buckets net.ipv4.tcp_syn_retries net.ipv4.tcp_ecn net.ipv4.tcp_congestion_control net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.shmmni kernel.shmmax kernel.shmall kernel.perf_event_paranoid kernel.sched_rt_runtime_us kernel.softlockup_panic kernel.yama.ptrace_scope kernel.kptr_restrict kernel.dmesg_restrict kernel.sysrq fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_background_bytes vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_bytes vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes + "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.neigh.default.gc_thresh1 net.ipv4.neigh.default.gc_thresh2 net.ipv4.neigh.default.gc_thresh3 net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_mtu_probing net.ipv4.tcp_max_orphans net.ipv4.tcp_max_tw_buckets net.ipv4.tcp_syn_retries net.ipv4.tcp_ecn net.ipv4.tcp_congestion_control net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.keys.maxkeys kernel.keys.maxbytes kernel.shmmni kernel.shmmax kernel.shmall kernel.perf_event_paranoid kernel.sched_rt_runtime_us kernel.softlockup_panic kernel.yama.ptrace_scope kernel.kptr_restrict kernel.dmesg_restrict kernel.sysrq fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_background_bytes vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_bytes vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes "a_key": "A String", }, "transparentHugepageDefrag": "A String", # Optional. Defines the transparent hugepage defrag configuration on the node. VM hugepage allocation can be managed by either limiting defragmentation for delayed allocation or skipping it entirely for immediate allocation only. See https://docs.kernel.org/admin-guide/mm/transhuge.html for more details. @@ -2711,6 +2746,11 @@

Method Details

}, "minCpuPlatform": "A String", # Minimum CPU platform to be used by this instance. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as `minCpuPlatform: "Intel Haswell"` or `minCpuPlatform: "Intel Sandy Bridge"`. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform) "nodeGroup": "A String", # Setting this field will assign instances of this pool to run on the specified node group. This is useful for running workloads on [sole tenant nodes](https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes). + "nodeImageConfig": { # CustomImageConfig contains the information r # The node image configuration to use for this node pool. Note that this is only applicable for node pools using image_type=CUSTOM. + "image": "A String", # The name of the image to use for this node. + "imageFamily": "A String", # The name of the image family to use for this node. + "imageProject": "A String", # The project containing the image to use for this node. + }, "oauthScopes": [ # The set of Google API scopes to be made available on all of the node VMs under the "default" service account. The following scopes are recommended, but not required, and by default are not included: * `https://www.googleapis.com/auth/compute` is required for mounting persistent storage on your nodes. * `https://www.googleapis.com/auth/devstorage.read_only` is required for communicating with **gcr.io** (the [Artifact Registry](https://cloud.google.com/artifact-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added. "A String", ], @@ -2782,6 +2822,9 @@

Method Details

"mode": "A String", # Mode is the configuration for how to expose metadata to workloads running on the node pool. }, }, + "nodeCreationConfig": { # NodeCreationConfig defines the settings of node creation mode. # Optional. Configuration for Node Creation Mode. + "nodeCreationMode": "A String", # The mode of node creation. + }, "nodeIpv4CidrSize": 42, # Output only. The size of the address space on each node for hosting containers. This is provisioned from within the `container_ipv4_cidr` range. This field will only be set when cluster is in route-based network mode. "nodePoolAutoConfig": { # Node pool configs that apply to all auto-provisioned node pools in autopilot clusters and node auto-provisioning enabled clusters. # Node pool configs that apply to all auto-provisioned node pools in autopilot clusters and node auto-provisioning enabled clusters. "linuxNodeConfig": { # Parameters that can be configured on Linux nodes. # Output only. Configuration options for Linux nodes. @@ -2823,7 +2866,7 @@

Method Details

"swapSizePercent": 42, # Specifies the size of the swap space as a percentage of the ephemeral local SSD capacity. }, }, - "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_mtu_probing net.ipv4.tcp_max_orphans net.ipv4.tcp_max_tw_buckets net.ipv4.tcp_syn_retries net.ipv4.tcp_ecn net.ipv4.tcp_congestion_control net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.shmmni kernel.shmmax kernel.shmall kernel.perf_event_paranoid kernel.sched_rt_runtime_us kernel.softlockup_panic kernel.yama.ptrace_scope kernel.kptr_restrict kernel.dmesg_restrict kernel.sysrq fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_background_bytes vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_bytes vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes + "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.neigh.default.gc_thresh1 net.ipv4.neigh.default.gc_thresh2 net.ipv4.neigh.default.gc_thresh3 net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_mtu_probing net.ipv4.tcp_max_orphans net.ipv4.tcp_max_tw_buckets net.ipv4.tcp_syn_retries net.ipv4.tcp_ecn net.ipv4.tcp_congestion_control net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.keys.maxkeys kernel.keys.maxbytes kernel.shmmni kernel.shmmax kernel.shmall kernel.perf_event_paranoid kernel.sched_rt_runtime_us kernel.softlockup_panic kernel.yama.ptrace_scope kernel.kptr_restrict kernel.dmesg_restrict kernel.sysrq fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_background_bytes vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_bytes vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes "a_key": "A String", }, "transparentHugepageDefrag": "A String", # Optional. Defines the transparent hugepage defrag configuration on the node. VM hugepage allocation can be managed by either limiting defragmentation for delayed allocation or skipping it entirely for immediate allocation only. See https://docs.kernel.org/admin-guide/mm/transhuge.html for more details. @@ -3250,7 +3293,7 @@

Method Details

"swapSizePercent": 42, # Specifies the size of the swap space as a percentage of the ephemeral local SSD capacity. }, }, - "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_mtu_probing net.ipv4.tcp_max_orphans net.ipv4.tcp_max_tw_buckets net.ipv4.tcp_syn_retries net.ipv4.tcp_ecn net.ipv4.tcp_congestion_control net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.shmmni kernel.shmmax kernel.shmall kernel.perf_event_paranoid kernel.sched_rt_runtime_us kernel.softlockup_panic kernel.yama.ptrace_scope kernel.kptr_restrict kernel.dmesg_restrict kernel.sysrq fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_background_bytes vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_bytes vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes + "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.neigh.default.gc_thresh1 net.ipv4.neigh.default.gc_thresh2 net.ipv4.neigh.default.gc_thresh3 net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_mtu_probing net.ipv4.tcp_max_orphans net.ipv4.tcp_max_tw_buckets net.ipv4.tcp_syn_retries net.ipv4.tcp_ecn net.ipv4.tcp_congestion_control net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.keys.maxkeys kernel.keys.maxbytes kernel.shmmni kernel.shmmax kernel.shmall kernel.perf_event_paranoid kernel.sched_rt_runtime_us kernel.softlockup_panic kernel.yama.ptrace_scope kernel.kptr_restrict kernel.dmesg_restrict kernel.sysrq fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_background_bytes vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_bytes vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes "a_key": "A String", }, "transparentHugepageDefrag": "A String", # Optional. Defines the transparent hugepage defrag configuration on the node. VM hugepage allocation can be managed by either limiting defragmentation for delayed allocation or skipping it entirely for immediate allocation only. See https://docs.kernel.org/admin-guide/mm/transhuge.html for more details. @@ -3273,6 +3316,11 @@

Method Details

}, "minCpuPlatform": "A String", # Minimum CPU platform to be used by this instance. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as `minCpuPlatform: "Intel Haswell"` or `minCpuPlatform: "Intel Sandy Bridge"`. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform) "nodeGroup": "A String", # Setting this field will assign instances of this pool to run on the specified node group. This is useful for running workloads on [sole tenant nodes](https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes). + "nodeImageConfig": { # CustomImageConfig contains the information r # The node image configuration to use for this node pool. Note that this is only applicable for node pools using image_type=CUSTOM. + "image": "A String", # The name of the image to use for this node. + "imageFamily": "A String", # The name of the image family to use for this node. + "imageProject": "A String", # The project containing the image to use for this node. + }, "oauthScopes": [ # The set of Google API scopes to be made available on all of the node VMs under the "default" service account. The following scopes are recommended, but not required, and by default are not included: * `https://www.googleapis.com/auth/compute` is required for mounting persistent storage on your nodes. * `https://www.googleapis.com/auth/devstorage.read_only` is required for communicating with **gcr.io** (the [Artifact Registry](https://cloud.google.com/artifact-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added. "A String", ], @@ -3352,6 +3400,13 @@

Method Details

"locations": [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the NodePool's nodes should be located. If this value is unspecified during node pool creation, the [Cluster.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters#Cluster.FIELDS.locations) value will be used, instead. Warning: changing node pool locations will result in nodes being added and/or removed. "A String", ], + "maintenancePolicy": { # Defines the maintenance policy for the node pool. # Optional. Specifies the maintenance policy for the node pool. + "exclusionUntilEndOfSupport": { # Defines the maintenance exclusion for the node pool. # Optional. The exclusion until end of support for the node pool. + "enabled": True or False, # Optional. Indicates whether the exclusion is enabled. + "endTime": "A String", # Output only. The end time of the maintenance exclusion. It is output only. It is the cluster control plane version's end of support time, or end of extended support time when the cluster is on extended support channel. + "startTime": "A String", # Output only. The start time of the maintenance exclusion. It is output only. It is the exclusion creation time. + }, + }, "management": { # NodeManagement defines the set of node management services turned on for the node pool. # NodeManagement configuration for this NodePool. "autoRepair": True or False, # A flag that specifies whether the node auto-repair is enabled for the node pool. If enabled, the nodes in this node pool will be monitored and, if they fail health checks too many times, an automatic repair action will be triggered. "autoUpgrade": True or False, # A flag that specifies whether node auto-upgrade is enabled for the node pool. If enabled, node auto-upgrade helps keep the nodes in your node pool up to date with the latest release version of Kubernetes. @@ -3384,6 +3439,7 @@

Method Details

], "createPodRange": True or False, # Input only. Whether to create a new range for pod IPs in this node pool. Defaults are provided for `pod_range` and `pod_ipv4_cidr_block` if they are not specified. If neither `create_pod_range` or `pod_range` are specified, the cluster-level default (`ip_allocation_policy.cluster_ipv4_cidr_block`) is used. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created. "enablePrivateNodes": True or False, # Whether nodes have internal IP addresses only. If enable_private_nodes is not specified, then the value is derived from Cluster.NetworkConfig.default_enable_private_nodes + "network": "A String", # Optional. Immutable. The VPC network for the node pool. "networkPerformanceConfig": { # Configuration of all network bandwidth tiers # Network bandwidth tier configuration. "totalEgressBandwidthTier": "A String", # Specifies the total network bandwidth tier for the NodePool. }, @@ -3399,6 +3455,8 @@

Method Details

"subnetwork": "A String", # Optional. The subnetwork name/path for the node pool. Format: projects/{project}/regions/{region}/subnetworks/{subnetwork} If the cluster is associated with multiple subnetworks, the subnetwork can be either: - A user supplied subnetwork name during node pool creation (e.g., `my-subnet`). The name must be between 1 and 63 characters long, start with a letter, contain only letters, numbers, and hyphens, and end with a letter or a number. - A full subnetwork path during node pool creation, such as `projects/gke-project/regions/us-central1/subnetworks/my-subnet` - A subnetwork path picked based on the IP utilization during node pool creation and is immutable. }, "nodeDrainConfig": { # NodeDrainConfig contains the node drain related configurations for this node pool. # Specifies the node drain configuration for this node pool. + "graceTerminationDuration": "A String", # The duration of the grace termination period for node drain. + "pdbTimeoutDuration": "A String", # The duration of the PDB timeout period for node drain. "respectPdbDuringNodePoolDeletion": True or False, # Whether to respect PDB during node pool deletion. }, "placementPolicy": { # PlacementPolicy defines the placement policy used by the node pool. # Specifies the node placement policy. @@ -3611,6 +3669,9 @@

Method Details

"clusters": [ # A list of clusters in the project in the specified zone, or across all ones. { # A Google Kubernetes Engine cluster. "addonsConfig": { # Configuration for the addons that can be automatically spun up in the cluster, enabling additional functionality. # Configurations for the various addons available to run in the cluster. + "agentSandboxConfig": { # Configuration for the AgentSandbox addon. # Optional. Configuration for the AgentSandbox addon. + "enabled": True or False, # Optional. Whether AgentSandbox is enabled for this cluster. + }, "cloudRunConfig": { # Configuration options for the Cloud Run feature. # Configuration for the Cloud Run addon, which allows the user to use a managed Knative service. "disabled": True or False, # Whether Cloud Run addon is enabled for this cluster. "loadBalancerType": "A String", # Which load balancer type is installed for Cloud Run. @@ -4048,6 +4109,9 @@

Method Details

"network": "A String", # The name of the Google Compute Engine [network](https://cloud.google.com/compute/docs/networks-and-firewalls#networks) to which the cluster is connected. If left unspecified, the `default` network will be used. "networkConfig": { # NetworkConfig reports the relative names of network & subnetwork. # Configuration for cluster networking. "datapathProvider": "A String", # The desired datapath provider for this cluster. By default, uses the IPTables-based kube-proxy implementation. + "dataplaneV2Config": { # DataplaneV2Config is the configuration for DPv2. # Optional. DataplaneV2Config specifies the DPv2 configuration. + "scalabilityMode": "A String", # Optional. Scalability mode for the cluster. + }, "defaultEnablePrivateNodes": True or False, # Controls whether by default nodes have private IP addresses only. It is invalid to specify both PrivateClusterConfig.enablePrivateNodes and this field at the same time. To update the default setting, use ClusterUpdate.desired_default_enable_private_nodes "defaultSnatStatus": { # DefaultSnatStatus contains the desired state of whether default sNAT should be disabled on the cluster. # Whether the cluster disables default in-node sNAT rules. In-node sNAT rules will be disabled when default_snat_status is disabled. When disabled is set to false, default IP masquerade rules will be applied to the nodes to prevent sNAT on cluster internal traffic. "disabled": True or False, # Disables cluster default sNAT rules. @@ -4289,7 +4353,7 @@

Method Details

"swapSizePercent": 42, # Specifies the size of the swap space as a percentage of the ephemeral local SSD capacity. }, }, - "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_mtu_probing net.ipv4.tcp_max_orphans net.ipv4.tcp_max_tw_buckets net.ipv4.tcp_syn_retries net.ipv4.tcp_ecn net.ipv4.tcp_congestion_control net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.shmmni kernel.shmmax kernel.shmall kernel.perf_event_paranoid kernel.sched_rt_runtime_us kernel.softlockup_panic kernel.yama.ptrace_scope kernel.kptr_restrict kernel.dmesg_restrict kernel.sysrq fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_background_bytes vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_bytes vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes + "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.neigh.default.gc_thresh1 net.ipv4.neigh.default.gc_thresh2 net.ipv4.neigh.default.gc_thresh3 net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_mtu_probing net.ipv4.tcp_max_orphans net.ipv4.tcp_max_tw_buckets net.ipv4.tcp_syn_retries net.ipv4.tcp_ecn net.ipv4.tcp_congestion_control net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.keys.maxkeys kernel.keys.maxbytes kernel.shmmni kernel.shmmax kernel.shmall kernel.perf_event_paranoid kernel.sched_rt_runtime_us kernel.softlockup_panic kernel.yama.ptrace_scope kernel.kptr_restrict kernel.dmesg_restrict kernel.sysrq fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_background_bytes vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_bytes vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes "a_key": "A String", }, "transparentHugepageDefrag": "A String", # Optional. Defines the transparent hugepage defrag configuration on the node. VM hugepage allocation can be managed by either limiting defragmentation for delayed allocation or skipping it entirely for immediate allocation only. See https://docs.kernel.org/admin-guide/mm/transhuge.html for more details. @@ -4312,6 +4376,11 @@

Method Details

}, "minCpuPlatform": "A String", # Minimum CPU platform to be used by this instance. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as `minCpuPlatform: "Intel Haswell"` or `minCpuPlatform: "Intel Sandy Bridge"`. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform) "nodeGroup": "A String", # Setting this field will assign instances of this pool to run on the specified node group. This is useful for running workloads on [sole tenant nodes](https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes). + "nodeImageConfig": { # CustomImageConfig contains the information r # The node image configuration to use for this node pool. Note that this is only applicable for node pools using image_type=CUSTOM. + "image": "A String", # The name of the image to use for this node. + "imageFamily": "A String", # The name of the image family to use for this node. + "imageProject": "A String", # The project containing the image to use for this node. + }, "oauthScopes": [ # The set of Google API scopes to be made available on all of the node VMs under the "default" service account. The following scopes are recommended, but not required, and by default are not included: * `https://www.googleapis.com/auth/compute` is required for mounting persistent storage on your nodes. * `https://www.googleapis.com/auth/devstorage.read_only` is required for communicating with **gcr.io** (the [Artifact Registry](https://cloud.google.com/artifact-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added. "A String", ], @@ -4383,6 +4452,9 @@

Method Details

"mode": "A String", # Mode is the configuration for how to expose metadata to workloads running on the node pool. }, }, + "nodeCreationConfig": { # NodeCreationConfig defines the settings of node creation mode. # Optional. Configuration for Node Creation Mode. + "nodeCreationMode": "A String", # The mode of node creation. + }, "nodeIpv4CidrSize": 42, # Output only. The size of the address space on each node for hosting containers. This is provisioned from within the `container_ipv4_cidr` range. This field will only be set when cluster is in route-based network mode. "nodePoolAutoConfig": { # Node pool configs that apply to all auto-provisioned node pools in autopilot clusters and node auto-provisioning enabled clusters. # Node pool configs that apply to all auto-provisioned node pools in autopilot clusters and node auto-provisioning enabled clusters. "linuxNodeConfig": { # Parameters that can be configured on Linux nodes. # Output only. Configuration options for Linux nodes. @@ -4424,7 +4496,7 @@

Method Details

"swapSizePercent": 42, # Specifies the size of the swap space as a percentage of the ephemeral local SSD capacity. }, }, - "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_mtu_probing net.ipv4.tcp_max_orphans net.ipv4.tcp_max_tw_buckets net.ipv4.tcp_syn_retries net.ipv4.tcp_ecn net.ipv4.tcp_congestion_control net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.shmmni kernel.shmmax kernel.shmall kernel.perf_event_paranoid kernel.sched_rt_runtime_us kernel.softlockup_panic kernel.yama.ptrace_scope kernel.kptr_restrict kernel.dmesg_restrict kernel.sysrq fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_background_bytes vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_bytes vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes + "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.neigh.default.gc_thresh1 net.ipv4.neigh.default.gc_thresh2 net.ipv4.neigh.default.gc_thresh3 net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_mtu_probing net.ipv4.tcp_max_orphans net.ipv4.tcp_max_tw_buckets net.ipv4.tcp_syn_retries net.ipv4.tcp_ecn net.ipv4.tcp_congestion_control net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.keys.maxkeys kernel.keys.maxbytes kernel.shmmni kernel.shmmax kernel.shmall kernel.perf_event_paranoid kernel.sched_rt_runtime_us kernel.softlockup_panic kernel.yama.ptrace_scope kernel.kptr_restrict kernel.dmesg_restrict kernel.sysrq fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_background_bytes vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_bytes vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes "a_key": "A String", }, "transparentHugepageDefrag": "A String", # Optional. Defines the transparent hugepage defrag configuration on the node. VM hugepage allocation can be managed by either limiting defragmentation for delayed allocation or skipping it entirely for immediate allocation only. See https://docs.kernel.org/admin-guide/mm/transhuge.html for more details. @@ -4851,7 +4923,7 @@

Method Details

"swapSizePercent": 42, # Specifies the size of the swap space as a percentage of the ephemeral local SSD capacity. }, }, - "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_mtu_probing net.ipv4.tcp_max_orphans net.ipv4.tcp_max_tw_buckets net.ipv4.tcp_syn_retries net.ipv4.tcp_ecn net.ipv4.tcp_congestion_control net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.shmmni kernel.shmmax kernel.shmall kernel.perf_event_paranoid kernel.sched_rt_runtime_us kernel.softlockup_panic kernel.yama.ptrace_scope kernel.kptr_restrict kernel.dmesg_restrict kernel.sysrq fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_background_bytes vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_bytes vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes + "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.neigh.default.gc_thresh1 net.ipv4.neigh.default.gc_thresh2 net.ipv4.neigh.default.gc_thresh3 net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_mtu_probing net.ipv4.tcp_max_orphans net.ipv4.tcp_max_tw_buckets net.ipv4.tcp_syn_retries net.ipv4.tcp_ecn net.ipv4.tcp_congestion_control net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.keys.maxkeys kernel.keys.maxbytes kernel.shmmni kernel.shmmax kernel.shmall kernel.perf_event_paranoid kernel.sched_rt_runtime_us kernel.softlockup_panic kernel.yama.ptrace_scope kernel.kptr_restrict kernel.dmesg_restrict kernel.sysrq fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_background_bytes vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_bytes vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes "a_key": "A String", }, "transparentHugepageDefrag": "A String", # Optional. Defines the transparent hugepage defrag configuration on the node. VM hugepage allocation can be managed by either limiting defragmentation for delayed allocation or skipping it entirely for immediate allocation only. See https://docs.kernel.org/admin-guide/mm/transhuge.html for more details. @@ -4874,6 +4946,11 @@

Method Details

}, "minCpuPlatform": "A String", # Minimum CPU platform to be used by this instance. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as `minCpuPlatform: "Intel Haswell"` or `minCpuPlatform: "Intel Sandy Bridge"`. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform) "nodeGroup": "A String", # Setting this field will assign instances of this pool to run on the specified node group. This is useful for running workloads on [sole tenant nodes](https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes). + "nodeImageConfig": { # CustomImageConfig contains the information r # The node image configuration to use for this node pool. Note that this is only applicable for node pools using image_type=CUSTOM. + "image": "A String", # The name of the image to use for this node. + "imageFamily": "A String", # The name of the image family to use for this node. + "imageProject": "A String", # The project containing the image to use for this node. + }, "oauthScopes": [ # The set of Google API scopes to be made available on all of the node VMs under the "default" service account. The following scopes are recommended, but not required, and by default are not included: * `https://www.googleapis.com/auth/compute` is required for mounting persistent storage on your nodes. * `https://www.googleapis.com/auth/devstorage.read_only` is required for communicating with **gcr.io** (the [Artifact Registry](https://cloud.google.com/artifact-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added. "A String", ], @@ -4953,6 +5030,13 @@

Method Details

"locations": [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the NodePool's nodes should be located. If this value is unspecified during node pool creation, the [Cluster.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters#Cluster.FIELDS.locations) value will be used, instead. Warning: changing node pool locations will result in nodes being added and/or removed. "A String", ], + "maintenancePolicy": { # Defines the maintenance policy for the node pool. # Optional. Specifies the maintenance policy for the node pool. + "exclusionUntilEndOfSupport": { # Defines the maintenance exclusion for the node pool. # Optional. The exclusion until end of support for the node pool. + "enabled": True or False, # Optional. Indicates whether the exclusion is enabled. + "endTime": "A String", # Output only. The end time of the maintenance exclusion. It is output only. It is the cluster control plane version's end of support time, or end of extended support time when the cluster is on extended support channel. + "startTime": "A String", # Output only. The start time of the maintenance exclusion. It is output only. It is the exclusion creation time. + }, + }, "management": { # NodeManagement defines the set of node management services turned on for the node pool. # NodeManagement configuration for this NodePool. "autoRepair": True or False, # A flag that specifies whether the node auto-repair is enabled for the node pool. If enabled, the nodes in this node pool will be monitored and, if they fail health checks too many times, an automatic repair action will be triggered. "autoUpgrade": True or False, # A flag that specifies whether node auto-upgrade is enabled for the node pool. If enabled, node auto-upgrade helps keep the nodes in your node pool up to date with the latest release version of Kubernetes. @@ -4985,6 +5069,7 @@

Method Details

], "createPodRange": True or False, # Input only. Whether to create a new range for pod IPs in this node pool. Defaults are provided for `pod_range` and `pod_ipv4_cidr_block` if they are not specified. If neither `create_pod_range` or `pod_range` are specified, the cluster-level default (`ip_allocation_policy.cluster_ipv4_cidr_block`) is used. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created. "enablePrivateNodes": True or False, # Whether nodes have internal IP addresses only. If enable_private_nodes is not specified, then the value is derived from Cluster.NetworkConfig.default_enable_private_nodes + "network": "A String", # Optional. Immutable. The VPC network for the node pool. "networkPerformanceConfig": { # Configuration of all network bandwidth tiers # Network bandwidth tier configuration. "totalEgressBandwidthTier": "A String", # Specifies the total network bandwidth tier for the NodePool. }, @@ -5000,6 +5085,8 @@

Method Details

"subnetwork": "A String", # Optional. The subnetwork name/path for the node pool. Format: projects/{project}/regions/{region}/subnetworks/{subnetwork} If the cluster is associated with multiple subnetworks, the subnetwork can be either: - A user supplied subnetwork name during node pool creation (e.g., `my-subnet`). The name must be between 1 and 63 characters long, start with a letter, contain only letters, numbers, and hyphens, and end with a letter or a number. - A full subnetwork path during node pool creation, such as `projects/gke-project/regions/us-central1/subnetworks/my-subnet` - A subnetwork path picked based on the IP utilization during node pool creation and is immutable. }, "nodeDrainConfig": { # NodeDrainConfig contains the node drain related configurations for this node pool. # Specifies the node drain configuration for this node pool. + "graceTerminationDuration": "A String", # The duration of the grace termination period for node drain. + "pdbTimeoutDuration": "A String", # The duration of the PDB timeout period for node drain. "respectPdbDuringNodePoolDeletion": True or False, # Whether to respect PDB during node pool deletion. }, "placementPolicy": { # PlacementPolicy defines the placement policy used by the node pool. # Specifies the node placement policy. @@ -5172,6 +5259,9 @@

Method Details

{ # SetAddonsConfigRequest sets the addons associated with the cluster. "addonsConfig": { # Configuration for the addons that can be automatically spun up in the cluster, enabling additional functionality. # Required. The desired configurations for the various addons available to run in the cluster. + "agentSandboxConfig": { # Configuration for the AgentSandbox addon. # Optional. Configuration for the AgentSandbox addon. + "enabled": True or False, # Optional. Whether AgentSandbox is enabled for this cluster. + }, "cloudRunConfig": { # Configuration options for the Cloud Run feature. # Configuration for the Cloud Run addon, which allows the user to use a managed Knative service. "disabled": True or False, # Whether Cloud Run addon is enabled for this cluster. "loadBalancerType": "A String", # Which load balancer type is installed for Cloud Run. @@ -6116,6 +6206,9 @@

Method Details

], }, "desiredAddonsConfig": { # Configuration for the addons that can be automatically spun up in the cluster, enabling additional functionality. # Configurations for the various addons available to run in the cluster. + "agentSandboxConfig": { # Configuration for the AgentSandbox addon. # Optional. Configuration for the AgentSandbox addon. + "enabled": True or False, # Optional. Whether AgentSandbox is enabled for this cluster. + }, "cloudRunConfig": { # Configuration options for the Cloud Run feature. # Configuration for the Cloud Run addon, which allows the user to use a managed Knative service. "disabled": True or False, # Whether Cloud Run addon is enabled for this cluster. "loadBalancerType": "A String", # Which load balancer type is installed for Cloud Run. @@ -6414,6 +6507,8 @@

Method Details

"desiredIdentityServiceConfig": { # IdentityServiceConfig is configuration for Identity Service which allows customers to use external identity providers with the K8S API # The desired Identity Service component configuration. "enabled": True or False, # Whether to enable the Identity Service component }, + "desiredImage": "A String", # The desired name of the image to use for this node. This is used to create clusters using a custom image. NOTE: Set the "desired_node_pool" field as well. + "desiredImageProject": "A String", # The project containing the desired image to use for this node. This is used to create clusters using a custom image. NOTE: Set the "desired_node_pool" field as well. "desiredImageType": "A String", # The desired image type for the node pool. NOTE: Set the "desired_node_pool" field as well. "desiredInTransitEncryptionConfig": "A String", # Specify the details of in-transit encryption. "desiredIntraNodeVisibilityConfig": { # IntraNodeVisibilityConfig contains the desired config of the intra-node visibility on this cluster. # The desired config of Intra-node visibility. @@ -6484,6 +6579,9 @@

Method Details

"desiredNetworkTierConfig": { # NetworkTierConfig contains network tier information. # The desired network tier configuration for the cluster. "networkTier": "A String", # Network tier configuration. }, + "desiredNodeCreationConfig": { # NodeCreationConfig defines the settings of node creation mode. # Optional. The desired NodeCreationConfig for the cluster. + "nodeCreationMode": "A String", # The mode of node creation. + }, "desiredNodeKubeletConfig": { # Node kubelet configs. # The desired node kubelet config for the cluster. "allowedUnsafeSysctls": [ # Optional. Defines a comma-separated allowlist of unsafe sysctls or sysctl patterns (ending in `*`). The unsafe namespaced sysctl groups are `kernel.shm*`, `kernel.msg*`, `kernel.sem`, `fs.mqueue.*`, and `net.*`. Leaving this allowlist empty means they cannot be set on Pods. To allow certain sysctls or sysctl patterns to be set on Pods, list them separated by commas. For example: `kernel.msg*,net.ipv4.route.min_pmtu`. See https://kubernetes.io/docs/tasks/administer-cluster/sysctl-cluster/ for more details. "A String", @@ -6633,7 +6731,7 @@

Method Details

"swapSizePercent": 42, # Specifies the size of the swap space as a percentage of the ephemeral local SSD capacity. }, }, - "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_mtu_probing net.ipv4.tcp_max_orphans net.ipv4.tcp_max_tw_buckets net.ipv4.tcp_syn_retries net.ipv4.tcp_ecn net.ipv4.tcp_congestion_control net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.shmmni kernel.shmmax kernel.shmall kernel.perf_event_paranoid kernel.sched_rt_runtime_us kernel.softlockup_panic kernel.yama.ptrace_scope kernel.kptr_restrict kernel.dmesg_restrict kernel.sysrq fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_background_bytes vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_bytes vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes + "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.neigh.default.gc_thresh1 net.ipv4.neigh.default.gc_thresh2 net.ipv4.neigh.default.gc_thresh3 net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_mtu_probing net.ipv4.tcp_max_orphans net.ipv4.tcp_max_tw_buckets net.ipv4.tcp_syn_retries net.ipv4.tcp_ecn net.ipv4.tcp_congestion_control net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.keys.maxkeys kernel.keys.maxbytes kernel.shmmni kernel.shmmax kernel.shmall kernel.perf_event_paranoid kernel.sched_rt_runtime_us kernel.softlockup_panic kernel.yama.ptrace_scope kernel.kptr_restrict kernel.dmesg_restrict kernel.sysrq fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_background_bytes vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_bytes vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes "a_key": "A String", }, "transparentHugepageDefrag": "A String", # Optional. Defines the transparent hugepage defrag configuration on the node. VM hugepage allocation can be managed by either limiting defragmentation for delayed allocation or skipping it entirely for immediate allocation only. See https://docs.kernel.org/admin-guide/mm/transhuge.html for more details. diff --git a/docs/dyn/container_v1.projects.locations.clusters.nodePools.html b/docs/dyn/container_v1.projects.locations.clusters.nodePools.html index 173bc7f6d0..7498052019 100644 --- a/docs/dyn/container_v1.projects.locations.clusters.nodePools.html +++ b/docs/dyn/container_v1.projects.locations.clusters.nodePools.html @@ -382,7 +382,7 @@

Method Details

"swapSizePercent": 42, # Specifies the size of the swap space as a percentage of the ephemeral local SSD capacity. }, }, - "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_mtu_probing net.ipv4.tcp_max_orphans net.ipv4.tcp_max_tw_buckets net.ipv4.tcp_syn_retries net.ipv4.tcp_ecn net.ipv4.tcp_congestion_control net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.shmmni kernel.shmmax kernel.shmall kernel.perf_event_paranoid kernel.sched_rt_runtime_us kernel.softlockup_panic kernel.yama.ptrace_scope kernel.kptr_restrict kernel.dmesg_restrict kernel.sysrq fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_background_bytes vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_bytes vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes + "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.neigh.default.gc_thresh1 net.ipv4.neigh.default.gc_thresh2 net.ipv4.neigh.default.gc_thresh3 net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_mtu_probing net.ipv4.tcp_max_orphans net.ipv4.tcp_max_tw_buckets net.ipv4.tcp_syn_retries net.ipv4.tcp_ecn net.ipv4.tcp_congestion_control net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.keys.maxkeys kernel.keys.maxbytes kernel.shmmni kernel.shmmax kernel.shmall kernel.perf_event_paranoid kernel.sched_rt_runtime_us kernel.softlockup_panic kernel.yama.ptrace_scope kernel.kptr_restrict kernel.dmesg_restrict kernel.sysrq fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_background_bytes vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_bytes vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes "a_key": "A String", }, "transparentHugepageDefrag": "A String", # Optional. Defines the transparent hugepage defrag configuration on the node. VM hugepage allocation can be managed by either limiting defragmentation for delayed allocation or skipping it entirely for immediate allocation only. See https://docs.kernel.org/admin-guide/mm/transhuge.html for more details. @@ -405,6 +405,11 @@

Method Details

}, "minCpuPlatform": "A String", # Minimum CPU platform to be used by this instance. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as `minCpuPlatform: "Intel Haswell"` or `minCpuPlatform: "Intel Sandy Bridge"`. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform) "nodeGroup": "A String", # Setting this field will assign instances of this pool to run on the specified node group. This is useful for running workloads on [sole tenant nodes](https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes). + "nodeImageConfig": { # CustomImageConfig contains the information r # The node image configuration to use for this node pool. Note that this is only applicable for node pools using image_type=CUSTOM. + "image": "A String", # The name of the image to use for this node. + "imageFamily": "A String", # The name of the image family to use for this node. + "imageProject": "A String", # The project containing the image to use for this node. + }, "oauthScopes": [ # The set of Google API scopes to be made available on all of the node VMs under the "default" service account. The following scopes are recommended, but not required, and by default are not included: * `https://www.googleapis.com/auth/compute` is required for mounting persistent storage on your nodes. * `https://www.googleapis.com/auth/devstorage.read_only` is required for communicating with **gcr.io** (the [Artifact Registry](https://cloud.google.com/artifact-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added. "A String", ], @@ -484,6 +489,13 @@

Method Details

"locations": [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the NodePool's nodes should be located. If this value is unspecified during node pool creation, the [Cluster.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters#Cluster.FIELDS.locations) value will be used, instead. Warning: changing node pool locations will result in nodes being added and/or removed. "A String", ], + "maintenancePolicy": { # Defines the maintenance policy for the node pool. # Optional. Specifies the maintenance policy for the node pool. + "exclusionUntilEndOfSupport": { # Defines the maintenance exclusion for the node pool. # Optional. The exclusion until end of support for the node pool. + "enabled": True or False, # Optional. Indicates whether the exclusion is enabled. + "endTime": "A String", # Output only. The end time of the maintenance exclusion. It is output only. It is the cluster control plane version's end of support time, or end of extended support time when the cluster is on extended support channel. + "startTime": "A String", # Output only. The start time of the maintenance exclusion. It is output only. It is the exclusion creation time. + }, + }, "management": { # NodeManagement defines the set of node management services turned on for the node pool. # NodeManagement configuration for this NodePool. "autoRepair": True or False, # A flag that specifies whether the node auto-repair is enabled for the node pool. If enabled, the nodes in this node pool will be monitored and, if they fail health checks too many times, an automatic repair action will be triggered. "autoUpgrade": True or False, # A flag that specifies whether node auto-upgrade is enabled for the node pool. If enabled, node auto-upgrade helps keep the nodes in your node pool up to date with the latest release version of Kubernetes. @@ -516,6 +528,7 @@

Method Details

], "createPodRange": True or False, # Input only. Whether to create a new range for pod IPs in this node pool. Defaults are provided for `pod_range` and `pod_ipv4_cidr_block` if they are not specified. If neither `create_pod_range` or `pod_range` are specified, the cluster-level default (`ip_allocation_policy.cluster_ipv4_cidr_block`) is used. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created. "enablePrivateNodes": True or False, # Whether nodes have internal IP addresses only. If enable_private_nodes is not specified, then the value is derived from Cluster.NetworkConfig.default_enable_private_nodes + "network": "A String", # Optional. Immutable. The VPC network for the node pool. "networkPerformanceConfig": { # Configuration of all network bandwidth tiers # Network bandwidth tier configuration. "totalEgressBandwidthTier": "A String", # Specifies the total network bandwidth tier for the NodePool. }, @@ -531,6 +544,8 @@

Method Details

"subnetwork": "A String", # Optional. The subnetwork name/path for the node pool. Format: projects/{project}/regions/{region}/subnetworks/{subnetwork} If the cluster is associated with multiple subnetworks, the subnetwork can be either: - A user supplied subnetwork name during node pool creation (e.g., `my-subnet`). The name must be between 1 and 63 characters long, start with a letter, contain only letters, numbers, and hyphens, and end with a letter or a number. - A full subnetwork path during node pool creation, such as `projects/gke-project/regions/us-central1/subnetworks/my-subnet` - A subnetwork path picked based on the IP utilization during node pool creation and is immutable. }, "nodeDrainConfig": { # NodeDrainConfig contains the node drain related configurations for this node pool. # Specifies the node drain configuration for this node pool. + "graceTerminationDuration": "A String", # The duration of the grace termination period for node drain. + "pdbTimeoutDuration": "A String", # The duration of the PDB timeout period for node drain. "respectPdbDuringNodePoolDeletion": True or False, # Whether to respect PDB during node pool deletion. }, "placementPolicy": { # PlacementPolicy defines the placement policy used by the node pool. # Specifies the node placement policy. @@ -1001,7 +1016,7 @@

Method Details

"swapSizePercent": 42, # Specifies the size of the swap space as a percentage of the ephemeral local SSD capacity. }, }, - "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_mtu_probing net.ipv4.tcp_max_orphans net.ipv4.tcp_max_tw_buckets net.ipv4.tcp_syn_retries net.ipv4.tcp_ecn net.ipv4.tcp_congestion_control net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.shmmni kernel.shmmax kernel.shmall kernel.perf_event_paranoid kernel.sched_rt_runtime_us kernel.softlockup_panic kernel.yama.ptrace_scope kernel.kptr_restrict kernel.dmesg_restrict kernel.sysrq fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_background_bytes vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_bytes vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes + "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.neigh.default.gc_thresh1 net.ipv4.neigh.default.gc_thresh2 net.ipv4.neigh.default.gc_thresh3 net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_mtu_probing net.ipv4.tcp_max_orphans net.ipv4.tcp_max_tw_buckets net.ipv4.tcp_syn_retries net.ipv4.tcp_ecn net.ipv4.tcp_congestion_control net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.keys.maxkeys kernel.keys.maxbytes kernel.shmmni kernel.shmmax kernel.shmall kernel.perf_event_paranoid kernel.sched_rt_runtime_us kernel.softlockup_panic kernel.yama.ptrace_scope kernel.kptr_restrict kernel.dmesg_restrict kernel.sysrq fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_background_bytes vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_bytes vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes "a_key": "A String", }, "transparentHugepageDefrag": "A String", # Optional. Defines the transparent hugepage defrag configuration on the node. VM hugepage allocation can be managed by either limiting defragmentation for delayed allocation or skipping it entirely for immediate allocation only. See https://docs.kernel.org/admin-guide/mm/transhuge.html for more details. @@ -1024,6 +1039,11 @@

Method Details

}, "minCpuPlatform": "A String", # Minimum CPU platform to be used by this instance. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as `minCpuPlatform: "Intel Haswell"` or `minCpuPlatform: "Intel Sandy Bridge"`. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform) "nodeGroup": "A String", # Setting this field will assign instances of this pool to run on the specified node group. This is useful for running workloads on [sole tenant nodes](https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes). + "nodeImageConfig": { # CustomImageConfig contains the information r # The node image configuration to use for this node pool. Note that this is only applicable for node pools using image_type=CUSTOM. + "image": "A String", # The name of the image to use for this node. + "imageFamily": "A String", # The name of the image family to use for this node. + "imageProject": "A String", # The project containing the image to use for this node. + }, "oauthScopes": [ # The set of Google API scopes to be made available on all of the node VMs under the "default" service account. The following scopes are recommended, but not required, and by default are not included: * `https://www.googleapis.com/auth/compute` is required for mounting persistent storage on your nodes. * `https://www.googleapis.com/auth/devstorage.read_only` is required for communicating with **gcr.io** (the [Artifact Registry](https://cloud.google.com/artifact-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added. "A String", ], @@ -1103,6 +1123,13 @@

Method Details

"locations": [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the NodePool's nodes should be located. If this value is unspecified during node pool creation, the [Cluster.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters#Cluster.FIELDS.locations) value will be used, instead. Warning: changing node pool locations will result in nodes being added and/or removed. "A String", ], + "maintenancePolicy": { # Defines the maintenance policy for the node pool. # Optional. Specifies the maintenance policy for the node pool. + "exclusionUntilEndOfSupport": { # Defines the maintenance exclusion for the node pool. # Optional. The exclusion until end of support for the node pool. + "enabled": True or False, # Optional. Indicates whether the exclusion is enabled. + "endTime": "A String", # Output only. The end time of the maintenance exclusion. It is output only. It is the cluster control plane version's end of support time, or end of extended support time when the cluster is on extended support channel. + "startTime": "A String", # Output only. The start time of the maintenance exclusion. It is output only. It is the exclusion creation time. + }, + }, "management": { # NodeManagement defines the set of node management services turned on for the node pool. # NodeManagement configuration for this NodePool. "autoRepair": True or False, # A flag that specifies whether the node auto-repair is enabled for the node pool. If enabled, the nodes in this node pool will be monitored and, if they fail health checks too many times, an automatic repair action will be triggered. "autoUpgrade": True or False, # A flag that specifies whether node auto-upgrade is enabled for the node pool. If enabled, node auto-upgrade helps keep the nodes in your node pool up to date with the latest release version of Kubernetes. @@ -1135,6 +1162,7 @@

Method Details

], "createPodRange": True or False, # Input only. Whether to create a new range for pod IPs in this node pool. Defaults are provided for `pod_range` and `pod_ipv4_cidr_block` if they are not specified. If neither `create_pod_range` or `pod_range` are specified, the cluster-level default (`ip_allocation_policy.cluster_ipv4_cidr_block`) is used. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created. "enablePrivateNodes": True or False, # Whether nodes have internal IP addresses only. If enable_private_nodes is not specified, then the value is derived from Cluster.NetworkConfig.default_enable_private_nodes + "network": "A String", # Optional. Immutable. The VPC network for the node pool. "networkPerformanceConfig": { # Configuration of all network bandwidth tiers # Network bandwidth tier configuration. "totalEgressBandwidthTier": "A String", # Specifies the total network bandwidth tier for the NodePool. }, @@ -1150,6 +1178,8 @@

Method Details

"subnetwork": "A String", # Optional. The subnetwork name/path for the node pool. Format: projects/{project}/regions/{region}/subnetworks/{subnetwork} If the cluster is associated with multiple subnetworks, the subnetwork can be either: - A user supplied subnetwork name during node pool creation (e.g., `my-subnet`). The name must be between 1 and 63 characters long, start with a letter, contain only letters, numbers, and hyphens, and end with a letter or a number. - A full subnetwork path during node pool creation, such as `projects/gke-project/regions/us-central1/subnetworks/my-subnet` - A subnetwork path picked based on the IP utilization during node pool creation and is immutable. }, "nodeDrainConfig": { # NodeDrainConfig contains the node drain related configurations for this node pool. # Specifies the node drain configuration for this node pool. + "graceTerminationDuration": "A String", # The duration of the grace termination period for node drain. + "pdbTimeoutDuration": "A String", # The duration of the PDB timeout period for node drain. "respectPdbDuringNodePoolDeletion": True or False, # Whether to respect PDB during node pool deletion. }, "placementPolicy": { # PlacementPolicy defines the placement policy used by the node pool. # Specifies the node placement policy. @@ -1447,7 +1477,7 @@

Method Details

"swapSizePercent": 42, # Specifies the size of the swap space as a percentage of the ephemeral local SSD capacity. }, }, - "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_mtu_probing net.ipv4.tcp_max_orphans net.ipv4.tcp_max_tw_buckets net.ipv4.tcp_syn_retries net.ipv4.tcp_ecn net.ipv4.tcp_congestion_control net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.shmmni kernel.shmmax kernel.shmall kernel.perf_event_paranoid kernel.sched_rt_runtime_us kernel.softlockup_panic kernel.yama.ptrace_scope kernel.kptr_restrict kernel.dmesg_restrict kernel.sysrq fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_background_bytes vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_bytes vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes + "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.neigh.default.gc_thresh1 net.ipv4.neigh.default.gc_thresh2 net.ipv4.neigh.default.gc_thresh3 net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_mtu_probing net.ipv4.tcp_max_orphans net.ipv4.tcp_max_tw_buckets net.ipv4.tcp_syn_retries net.ipv4.tcp_ecn net.ipv4.tcp_congestion_control net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.keys.maxkeys kernel.keys.maxbytes kernel.shmmni kernel.shmmax kernel.shmall kernel.perf_event_paranoid kernel.sched_rt_runtime_us kernel.softlockup_panic kernel.yama.ptrace_scope kernel.kptr_restrict kernel.dmesg_restrict kernel.sysrq fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_background_bytes vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_bytes vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes "a_key": "A String", }, "transparentHugepageDefrag": "A String", # Optional. Defines the transparent hugepage defrag configuration on the node. VM hugepage allocation can be managed by either limiting defragmentation for delayed allocation or skipping it entirely for immediate allocation only. See https://docs.kernel.org/admin-guide/mm/transhuge.html for more details. @@ -1470,6 +1500,11 @@

Method Details

}, "minCpuPlatform": "A String", # Minimum CPU platform to be used by this instance. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as `minCpuPlatform: "Intel Haswell"` or `minCpuPlatform: "Intel Sandy Bridge"`. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform) "nodeGroup": "A String", # Setting this field will assign instances of this pool to run on the specified node group. This is useful for running workloads on [sole tenant nodes](https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes). + "nodeImageConfig": { # CustomImageConfig contains the information r # The node image configuration to use for this node pool. Note that this is only applicable for node pools using image_type=CUSTOM. + "image": "A String", # The name of the image to use for this node. + "imageFamily": "A String", # The name of the image family to use for this node. + "imageProject": "A String", # The project containing the image to use for this node. + }, "oauthScopes": [ # The set of Google API scopes to be made available on all of the node VMs under the "default" service account. The following scopes are recommended, but not required, and by default are not included: * `https://www.googleapis.com/auth/compute` is required for mounting persistent storage on your nodes. * `https://www.googleapis.com/auth/devstorage.read_only` is required for communicating with **gcr.io** (the [Artifact Registry](https://cloud.google.com/artifact-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added. "A String", ], @@ -1549,6 +1584,13 @@

Method Details

"locations": [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the NodePool's nodes should be located. If this value is unspecified during node pool creation, the [Cluster.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters#Cluster.FIELDS.locations) value will be used, instead. Warning: changing node pool locations will result in nodes being added and/or removed. "A String", ], + "maintenancePolicy": { # Defines the maintenance policy for the node pool. # Optional. Specifies the maintenance policy for the node pool. + "exclusionUntilEndOfSupport": { # Defines the maintenance exclusion for the node pool. # Optional. The exclusion until end of support for the node pool. + "enabled": True or False, # Optional. Indicates whether the exclusion is enabled. + "endTime": "A String", # Output only. The end time of the maintenance exclusion. It is output only. It is the cluster control plane version's end of support time, or end of extended support time when the cluster is on extended support channel. + "startTime": "A String", # Output only. The start time of the maintenance exclusion. It is output only. It is the exclusion creation time. + }, + }, "management": { # NodeManagement defines the set of node management services turned on for the node pool. # NodeManagement configuration for this NodePool. "autoRepair": True or False, # A flag that specifies whether the node auto-repair is enabled for the node pool. If enabled, the nodes in this node pool will be monitored and, if they fail health checks too many times, an automatic repair action will be triggered. "autoUpgrade": True or False, # A flag that specifies whether node auto-upgrade is enabled for the node pool. If enabled, node auto-upgrade helps keep the nodes in your node pool up to date with the latest release version of Kubernetes. @@ -1581,6 +1623,7 @@

Method Details

], "createPodRange": True or False, # Input only. Whether to create a new range for pod IPs in this node pool. Defaults are provided for `pod_range` and `pod_ipv4_cidr_block` if they are not specified. If neither `create_pod_range` or `pod_range` are specified, the cluster-level default (`ip_allocation_policy.cluster_ipv4_cidr_block`) is used. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created. "enablePrivateNodes": True or False, # Whether nodes have internal IP addresses only. If enable_private_nodes is not specified, then the value is derived from Cluster.NetworkConfig.default_enable_private_nodes + "network": "A String", # Optional. Immutable. The VPC network for the node pool. "networkPerformanceConfig": { # Configuration of all network bandwidth tiers # Network bandwidth tier configuration. "totalEgressBandwidthTier": "A String", # Specifies the total network bandwidth tier for the NodePool. }, @@ -1596,6 +1639,8 @@

Method Details

"subnetwork": "A String", # Optional. The subnetwork name/path for the node pool. Format: projects/{project}/regions/{region}/subnetworks/{subnetwork} If the cluster is associated with multiple subnetworks, the subnetwork can be either: - A user supplied subnetwork name during node pool creation (e.g., `my-subnet`). The name must be between 1 and 63 characters long, start with a letter, contain only letters, numbers, and hyphens, and end with a letter or a number. - A full subnetwork path during node pool creation, such as `projects/gke-project/regions/us-central1/subnetworks/my-subnet` - A subnetwork path picked based on the IP utilization during node pool creation and is immutable. }, "nodeDrainConfig": { # NodeDrainConfig contains the node drain related configurations for this node pool. # Specifies the node drain configuration for this node pool. + "graceTerminationDuration": "A String", # The duration of the grace termination period for node drain. + "pdbTimeoutDuration": "A String", # The duration of the PDB timeout period for node drain. "respectPdbDuringNodePoolDeletion": True or False, # Whether to respect PDB during node pool deletion. }, "placementPolicy": { # PlacementPolicy defines the placement policy used by the node pool. # Specifies the node placement policy. @@ -2081,6 +2126,8 @@

Method Details

"gvnic": { # Configuration of gVNIC feature. # Enable or disable gvnic on the node pool. "enabled": True or False, # Whether gVNIC features are enabled in the node pool. }, + "image": "A String", # The desired name of the image name to use for this node. This is used to create clusters using a custom image. + "imageProject": "A String", # The project containing the desired image to use for this node pool. This is used to create clusters using a custom image. "imageType": "A String", # Required. The desired image type for the node pool. Please see https://cloud.google.com/kubernetes-engine/docs/concepts/node-images for available image types. "kubeletConfig": { # Node kubelet configs. # Node kubelet configs. "allowedUnsafeSysctls": [ # Optional. Defines a comma-separated allowlist of unsafe sysctls or sysctl patterns (ending in `*`). The unsafe namespaced sysctl groups are `kernel.shm*`, `kernel.msg*`, `kernel.sem`, `fs.mqueue.*`, and `net.*`. Leaving this allowlist empty means they cannot be set on Pods. To allow certain sysctls or sysctl patterns to be set on Pods, list them separated by commas. For example: `kernel.msg*,net.ipv4.route.min_pmtu`. See https://kubernetes.io/docs/tasks/administer-cluster/sysctl-cluster/ for more details. @@ -2181,7 +2228,7 @@

Method Details

"swapSizePercent": 42, # Specifies the size of the swap space as a percentage of the ephemeral local SSD capacity. }, }, - "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_mtu_probing net.ipv4.tcp_max_orphans net.ipv4.tcp_max_tw_buckets net.ipv4.tcp_syn_retries net.ipv4.tcp_ecn net.ipv4.tcp_congestion_control net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.shmmni kernel.shmmax kernel.shmall kernel.perf_event_paranoid kernel.sched_rt_runtime_us kernel.softlockup_panic kernel.yama.ptrace_scope kernel.kptr_restrict kernel.dmesg_restrict kernel.sysrq fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_background_bytes vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_bytes vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes + "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.neigh.default.gc_thresh1 net.ipv4.neigh.default.gc_thresh2 net.ipv4.neigh.default.gc_thresh3 net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_mtu_probing net.ipv4.tcp_max_orphans net.ipv4.tcp_max_tw_buckets net.ipv4.tcp_syn_retries net.ipv4.tcp_ecn net.ipv4.tcp_congestion_control net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.keys.maxkeys kernel.keys.maxbytes kernel.shmmni kernel.shmmax kernel.shmall kernel.perf_event_paranoid kernel.sched_rt_runtime_us kernel.softlockup_panic kernel.yama.ptrace_scope kernel.kptr_restrict kernel.dmesg_restrict kernel.sysrq fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_background_bytes vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_bytes vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes "a_key": "A String", }, "transparentHugepageDefrag": "A String", # Optional. Defines the transparent hugepage defrag configuration on the node. VM hugepage allocation can be managed by either limiting defragmentation for delayed allocation or skipping it entirely for immediate allocation only. See https://docs.kernel.org/admin-guide/mm/transhuge.html for more details. @@ -2199,6 +2246,8 @@

Method Details

"maxRunDuration": "A String", # The maximum duration for the nodes to exist. If unspecified, the nodes can exist indefinitely. "name": "A String", # The name (project, location, cluster, node pool) of the node pool to update. Specified in the format `projects/*/locations/*/clusters/*/nodePools/*`. "nodeDrainConfig": { # NodeDrainConfig contains the node drain related configurations for this node pool. # The desired node drain configuration for nodes in the node pool. + "graceTerminationDuration": "A String", # The duration of the grace termination period for node drain. + "pdbTimeoutDuration": "A String", # The duration of the PDB timeout period for node drain. "respectPdbDuringNodePoolDeletion": True or False, # Whether to respect PDB during node pool deletion. }, "nodeNetworkConfig": { # Parameters for node pool-level network config. # Node network config. @@ -2221,6 +2270,7 @@

Method Details

], "createPodRange": True or False, # Input only. Whether to create a new range for pod IPs in this node pool. Defaults are provided for `pod_range` and `pod_ipv4_cidr_block` if they are not specified. If neither `create_pod_range` or `pod_range` are specified, the cluster-level default (`ip_allocation_policy.cluster_ipv4_cidr_block`) is used. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created. "enablePrivateNodes": True or False, # Whether nodes have internal IP addresses only. If enable_private_nodes is not specified, then the value is derived from Cluster.NetworkConfig.default_enable_private_nodes + "network": "A String", # Optional. Immutable. The VPC network for the node pool. "networkPerformanceConfig": { # Configuration of all network bandwidth tiers # Network bandwidth tier configuration. "totalEgressBandwidthTier": "A String", # Specifies the total network bandwidth tier for the NodePool. }, diff --git a/docs/dyn/container_v1.projects.zones.clusters.html b/docs/dyn/container_v1.projects.zones.clusters.html index 43bacbbfab..8be01c73aa 100644 --- a/docs/dyn/container_v1.projects.zones.clusters.html +++ b/docs/dyn/container_v1.projects.zones.clusters.html @@ -150,6 +150,9 @@

Method Details

{ # SetAddonsConfigRequest sets the addons associated with the cluster. "addonsConfig": { # Configuration for the addons that can be automatically spun up in the cluster, enabling additional functionality. # Required. The desired configurations for the various addons available to run in the cluster. + "agentSandboxConfig": { # Configuration for the AgentSandbox addon. # Optional. Configuration for the AgentSandbox addon. + "enabled": True or False, # Optional. Whether AgentSandbox is enabled for this cluster. + }, "cloudRunConfig": { # Configuration options for the Cloud Run feature. # Configuration for the Cloud Run addon, which allows the user to use a managed Knative service. "disabled": True or False, # Whether Cloud Run addon is enabled for this cluster. "loadBalancerType": "A String", # Which load balancer type is installed for Cloud Run. @@ -384,6 +387,9 @@

Method Details

{ # CreateClusterRequest creates a cluster. "cluster": { # A Google Kubernetes Engine cluster. # Required. A [cluster resource](https://cloud.google.com/container-engine/reference/rest/v1/projects.locations.clusters) "addonsConfig": { # Configuration for the addons that can be automatically spun up in the cluster, enabling additional functionality. # Configurations for the various addons available to run in the cluster. + "agentSandboxConfig": { # Configuration for the AgentSandbox addon. # Optional. Configuration for the AgentSandbox addon. + "enabled": True or False, # Optional. Whether AgentSandbox is enabled for this cluster. + }, "cloudRunConfig": { # Configuration options for the Cloud Run feature. # Configuration for the Cloud Run addon, which allows the user to use a managed Knative service. "disabled": True or False, # Whether Cloud Run addon is enabled for this cluster. "loadBalancerType": "A String", # Which load balancer type is installed for Cloud Run. @@ -821,6 +827,9 @@

Method Details

"network": "A String", # The name of the Google Compute Engine [network](https://cloud.google.com/compute/docs/networks-and-firewalls#networks) to which the cluster is connected. If left unspecified, the `default` network will be used. "networkConfig": { # NetworkConfig reports the relative names of network & subnetwork. # Configuration for cluster networking. "datapathProvider": "A String", # The desired datapath provider for this cluster. By default, uses the IPTables-based kube-proxy implementation. + "dataplaneV2Config": { # DataplaneV2Config is the configuration for DPv2. # Optional. DataplaneV2Config specifies the DPv2 configuration. + "scalabilityMode": "A String", # Optional. Scalability mode for the cluster. + }, "defaultEnablePrivateNodes": True or False, # Controls whether by default nodes have private IP addresses only. It is invalid to specify both PrivateClusterConfig.enablePrivateNodes and this field at the same time. To update the default setting, use ClusterUpdate.desired_default_enable_private_nodes "defaultSnatStatus": { # DefaultSnatStatus contains the desired state of whether default sNAT should be disabled on the cluster. # Whether the cluster disables default in-node sNAT rules. In-node sNAT rules will be disabled when default_snat_status is disabled. When disabled is set to false, default IP masquerade rules will be applied to the nodes to prevent sNAT on cluster internal traffic. "disabled": True or False, # Disables cluster default sNAT rules. @@ -1062,7 +1071,7 @@

Method Details

"swapSizePercent": 42, # Specifies the size of the swap space as a percentage of the ephemeral local SSD capacity. }, }, - "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_mtu_probing net.ipv4.tcp_max_orphans net.ipv4.tcp_max_tw_buckets net.ipv4.tcp_syn_retries net.ipv4.tcp_ecn net.ipv4.tcp_congestion_control net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.shmmni kernel.shmmax kernel.shmall kernel.perf_event_paranoid kernel.sched_rt_runtime_us kernel.softlockup_panic kernel.yama.ptrace_scope kernel.kptr_restrict kernel.dmesg_restrict kernel.sysrq fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_background_bytes vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_bytes vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes + "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.neigh.default.gc_thresh1 net.ipv4.neigh.default.gc_thresh2 net.ipv4.neigh.default.gc_thresh3 net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_mtu_probing net.ipv4.tcp_max_orphans net.ipv4.tcp_max_tw_buckets net.ipv4.tcp_syn_retries net.ipv4.tcp_ecn net.ipv4.tcp_congestion_control net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.keys.maxkeys kernel.keys.maxbytes kernel.shmmni kernel.shmmax kernel.shmall kernel.perf_event_paranoid kernel.sched_rt_runtime_us kernel.softlockup_panic kernel.yama.ptrace_scope kernel.kptr_restrict kernel.dmesg_restrict kernel.sysrq fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_background_bytes vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_bytes vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes "a_key": "A String", }, "transparentHugepageDefrag": "A String", # Optional. Defines the transparent hugepage defrag configuration on the node. VM hugepage allocation can be managed by either limiting defragmentation for delayed allocation or skipping it entirely for immediate allocation only. See https://docs.kernel.org/admin-guide/mm/transhuge.html for more details. @@ -1085,6 +1094,11 @@

Method Details

}, "minCpuPlatform": "A String", # Minimum CPU platform to be used by this instance. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as `minCpuPlatform: "Intel Haswell"` or `minCpuPlatform: "Intel Sandy Bridge"`. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform) "nodeGroup": "A String", # Setting this field will assign instances of this pool to run on the specified node group. This is useful for running workloads on [sole tenant nodes](https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes). + "nodeImageConfig": { # CustomImageConfig contains the information r # The node image configuration to use for this node pool. Note that this is only applicable for node pools using image_type=CUSTOM. + "image": "A String", # The name of the image to use for this node. + "imageFamily": "A String", # The name of the image family to use for this node. + "imageProject": "A String", # The project containing the image to use for this node. + }, "oauthScopes": [ # The set of Google API scopes to be made available on all of the node VMs under the "default" service account. The following scopes are recommended, but not required, and by default are not included: * `https://www.googleapis.com/auth/compute` is required for mounting persistent storage on your nodes. * `https://www.googleapis.com/auth/devstorage.read_only` is required for communicating with **gcr.io** (the [Artifact Registry](https://cloud.google.com/artifact-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added. "A String", ], @@ -1156,6 +1170,9 @@

Method Details

"mode": "A String", # Mode is the configuration for how to expose metadata to workloads running on the node pool. }, }, + "nodeCreationConfig": { # NodeCreationConfig defines the settings of node creation mode. # Optional. Configuration for Node Creation Mode. + "nodeCreationMode": "A String", # The mode of node creation. + }, "nodeIpv4CidrSize": 42, # Output only. The size of the address space on each node for hosting containers. This is provisioned from within the `container_ipv4_cidr` range. This field will only be set when cluster is in route-based network mode. "nodePoolAutoConfig": { # Node pool configs that apply to all auto-provisioned node pools in autopilot clusters and node auto-provisioning enabled clusters. # Node pool configs that apply to all auto-provisioned node pools in autopilot clusters and node auto-provisioning enabled clusters. "linuxNodeConfig": { # Parameters that can be configured on Linux nodes. # Output only. Configuration options for Linux nodes. @@ -1197,7 +1214,7 @@

Method Details

"swapSizePercent": 42, # Specifies the size of the swap space as a percentage of the ephemeral local SSD capacity. }, }, - "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_mtu_probing net.ipv4.tcp_max_orphans net.ipv4.tcp_max_tw_buckets net.ipv4.tcp_syn_retries net.ipv4.tcp_ecn net.ipv4.tcp_congestion_control net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.shmmni kernel.shmmax kernel.shmall kernel.perf_event_paranoid kernel.sched_rt_runtime_us kernel.softlockup_panic kernel.yama.ptrace_scope kernel.kptr_restrict kernel.dmesg_restrict kernel.sysrq fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_background_bytes vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_bytes vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes + "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.neigh.default.gc_thresh1 net.ipv4.neigh.default.gc_thresh2 net.ipv4.neigh.default.gc_thresh3 net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_mtu_probing net.ipv4.tcp_max_orphans net.ipv4.tcp_max_tw_buckets net.ipv4.tcp_syn_retries net.ipv4.tcp_ecn net.ipv4.tcp_congestion_control net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.keys.maxkeys kernel.keys.maxbytes kernel.shmmni kernel.shmmax kernel.shmall kernel.perf_event_paranoid kernel.sched_rt_runtime_us kernel.softlockup_panic kernel.yama.ptrace_scope kernel.kptr_restrict kernel.dmesg_restrict kernel.sysrq fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_background_bytes vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_bytes vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes "a_key": "A String", }, "transparentHugepageDefrag": "A String", # Optional. Defines the transparent hugepage defrag configuration on the node. VM hugepage allocation can be managed by either limiting defragmentation for delayed allocation or skipping it entirely for immediate allocation only. See https://docs.kernel.org/admin-guide/mm/transhuge.html for more details. @@ -1624,7 +1641,7 @@

Method Details

"swapSizePercent": 42, # Specifies the size of the swap space as a percentage of the ephemeral local SSD capacity. }, }, - "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_mtu_probing net.ipv4.tcp_max_orphans net.ipv4.tcp_max_tw_buckets net.ipv4.tcp_syn_retries net.ipv4.tcp_ecn net.ipv4.tcp_congestion_control net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.shmmni kernel.shmmax kernel.shmall kernel.perf_event_paranoid kernel.sched_rt_runtime_us kernel.softlockup_panic kernel.yama.ptrace_scope kernel.kptr_restrict kernel.dmesg_restrict kernel.sysrq fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_background_bytes vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_bytes vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes + "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.neigh.default.gc_thresh1 net.ipv4.neigh.default.gc_thresh2 net.ipv4.neigh.default.gc_thresh3 net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_mtu_probing net.ipv4.tcp_max_orphans net.ipv4.tcp_max_tw_buckets net.ipv4.tcp_syn_retries net.ipv4.tcp_ecn net.ipv4.tcp_congestion_control net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.keys.maxkeys kernel.keys.maxbytes kernel.shmmni kernel.shmmax kernel.shmall kernel.perf_event_paranoid kernel.sched_rt_runtime_us kernel.softlockup_panic kernel.yama.ptrace_scope kernel.kptr_restrict kernel.dmesg_restrict kernel.sysrq fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_background_bytes vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_bytes vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes "a_key": "A String", }, "transparentHugepageDefrag": "A String", # Optional. Defines the transparent hugepage defrag configuration on the node. VM hugepage allocation can be managed by either limiting defragmentation for delayed allocation or skipping it entirely for immediate allocation only. See https://docs.kernel.org/admin-guide/mm/transhuge.html for more details. @@ -1647,6 +1664,11 @@

Method Details

}, "minCpuPlatform": "A String", # Minimum CPU platform to be used by this instance. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as `minCpuPlatform: "Intel Haswell"` or `minCpuPlatform: "Intel Sandy Bridge"`. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform) "nodeGroup": "A String", # Setting this field will assign instances of this pool to run on the specified node group. This is useful for running workloads on [sole tenant nodes](https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes). + "nodeImageConfig": { # CustomImageConfig contains the information r # The node image configuration to use for this node pool. Note that this is only applicable for node pools using image_type=CUSTOM. + "image": "A String", # The name of the image to use for this node. + "imageFamily": "A String", # The name of the image family to use for this node. + "imageProject": "A String", # The project containing the image to use for this node. + }, "oauthScopes": [ # The set of Google API scopes to be made available on all of the node VMs under the "default" service account. The following scopes are recommended, but not required, and by default are not included: * `https://www.googleapis.com/auth/compute` is required for mounting persistent storage on your nodes. * `https://www.googleapis.com/auth/devstorage.read_only` is required for communicating with **gcr.io** (the [Artifact Registry](https://cloud.google.com/artifact-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added. "A String", ], @@ -1726,6 +1748,13 @@

Method Details

"locations": [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the NodePool's nodes should be located. If this value is unspecified during node pool creation, the [Cluster.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters#Cluster.FIELDS.locations) value will be used, instead. Warning: changing node pool locations will result in nodes being added and/or removed. "A String", ], + "maintenancePolicy": { # Defines the maintenance policy for the node pool. # Optional. Specifies the maintenance policy for the node pool. + "exclusionUntilEndOfSupport": { # Defines the maintenance exclusion for the node pool. # Optional. The exclusion until end of support for the node pool. + "enabled": True or False, # Optional. Indicates whether the exclusion is enabled. + "endTime": "A String", # Output only. The end time of the maintenance exclusion. It is output only. It is the cluster control plane version's end of support time, or end of extended support time when the cluster is on extended support channel. + "startTime": "A String", # Output only. The start time of the maintenance exclusion. It is output only. It is the exclusion creation time. + }, + }, "management": { # NodeManagement defines the set of node management services turned on for the node pool. # NodeManagement configuration for this NodePool. "autoRepair": True or False, # A flag that specifies whether the node auto-repair is enabled for the node pool. If enabled, the nodes in this node pool will be monitored and, if they fail health checks too many times, an automatic repair action will be triggered. "autoUpgrade": True or False, # A flag that specifies whether node auto-upgrade is enabled for the node pool. If enabled, node auto-upgrade helps keep the nodes in your node pool up to date with the latest release version of Kubernetes. @@ -1758,6 +1787,7 @@

Method Details

], "createPodRange": True or False, # Input only. Whether to create a new range for pod IPs in this node pool. Defaults are provided for `pod_range` and `pod_ipv4_cidr_block` if they are not specified. If neither `create_pod_range` or `pod_range` are specified, the cluster-level default (`ip_allocation_policy.cluster_ipv4_cidr_block`) is used. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created. "enablePrivateNodes": True or False, # Whether nodes have internal IP addresses only. If enable_private_nodes is not specified, then the value is derived from Cluster.NetworkConfig.default_enable_private_nodes + "network": "A String", # Optional. Immutable. The VPC network for the node pool. "networkPerformanceConfig": { # Configuration of all network bandwidth tiers # Network bandwidth tier configuration. "totalEgressBandwidthTier": "A String", # Specifies the total network bandwidth tier for the NodePool. }, @@ -1773,6 +1803,8 @@

Method Details

"subnetwork": "A String", # Optional. The subnetwork name/path for the node pool. Format: projects/{project}/regions/{region}/subnetworks/{subnetwork} If the cluster is associated with multiple subnetworks, the subnetwork can be either: - A user supplied subnetwork name during node pool creation (e.g., `my-subnet`). The name must be between 1 and 63 characters long, start with a letter, contain only letters, numbers, and hyphens, and end with a letter or a number. - A full subnetwork path during node pool creation, such as `projects/gke-project/regions/us-central1/subnetworks/my-subnet` - A subnetwork path picked based on the IP utilization during node pool creation and is immutable. }, "nodeDrainConfig": { # NodeDrainConfig contains the node drain related configurations for this node pool. # Specifies the node drain configuration for this node pool. + "graceTerminationDuration": "A String", # The duration of the grace termination period for node drain. + "pdbTimeoutDuration": "A String", # The duration of the PDB timeout period for node drain. "respectPdbDuringNodePoolDeletion": True or False, # Whether to respect PDB during node pool deletion. }, "placementPolicy": { # PlacementPolicy defines the placement policy used by the node pool. # Specifies the node placement policy. @@ -2121,6 +2153,9 @@

Method Details

{ # A Google Kubernetes Engine cluster. "addonsConfig": { # Configuration for the addons that can be automatically spun up in the cluster, enabling additional functionality. # Configurations for the various addons available to run in the cluster. + "agentSandboxConfig": { # Configuration for the AgentSandbox addon. # Optional. Configuration for the AgentSandbox addon. + "enabled": True or False, # Optional. Whether AgentSandbox is enabled for this cluster. + }, "cloudRunConfig": { # Configuration options for the Cloud Run feature. # Configuration for the Cloud Run addon, which allows the user to use a managed Knative service. "disabled": True or False, # Whether Cloud Run addon is enabled for this cluster. "loadBalancerType": "A String", # Which load balancer type is installed for Cloud Run. @@ -2558,6 +2593,9 @@

Method Details

"network": "A String", # The name of the Google Compute Engine [network](https://cloud.google.com/compute/docs/networks-and-firewalls#networks) to which the cluster is connected. If left unspecified, the `default` network will be used. "networkConfig": { # NetworkConfig reports the relative names of network & subnetwork. # Configuration for cluster networking. "datapathProvider": "A String", # The desired datapath provider for this cluster. By default, uses the IPTables-based kube-proxy implementation. + "dataplaneV2Config": { # DataplaneV2Config is the configuration for DPv2. # Optional. DataplaneV2Config specifies the DPv2 configuration. + "scalabilityMode": "A String", # Optional. Scalability mode for the cluster. + }, "defaultEnablePrivateNodes": True or False, # Controls whether by default nodes have private IP addresses only. It is invalid to specify both PrivateClusterConfig.enablePrivateNodes and this field at the same time. To update the default setting, use ClusterUpdate.desired_default_enable_private_nodes "defaultSnatStatus": { # DefaultSnatStatus contains the desired state of whether default sNAT should be disabled on the cluster. # Whether the cluster disables default in-node sNAT rules. In-node sNAT rules will be disabled when default_snat_status is disabled. When disabled is set to false, default IP masquerade rules will be applied to the nodes to prevent sNAT on cluster internal traffic. "disabled": True or False, # Disables cluster default sNAT rules. @@ -2799,7 +2837,7 @@

Method Details

"swapSizePercent": 42, # Specifies the size of the swap space as a percentage of the ephemeral local SSD capacity. }, }, - "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_mtu_probing net.ipv4.tcp_max_orphans net.ipv4.tcp_max_tw_buckets net.ipv4.tcp_syn_retries net.ipv4.tcp_ecn net.ipv4.tcp_congestion_control net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.shmmni kernel.shmmax kernel.shmall kernel.perf_event_paranoid kernel.sched_rt_runtime_us kernel.softlockup_panic kernel.yama.ptrace_scope kernel.kptr_restrict kernel.dmesg_restrict kernel.sysrq fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_background_bytes vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_bytes vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes + "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.neigh.default.gc_thresh1 net.ipv4.neigh.default.gc_thresh2 net.ipv4.neigh.default.gc_thresh3 net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_mtu_probing net.ipv4.tcp_max_orphans net.ipv4.tcp_max_tw_buckets net.ipv4.tcp_syn_retries net.ipv4.tcp_ecn net.ipv4.tcp_congestion_control net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.keys.maxkeys kernel.keys.maxbytes kernel.shmmni kernel.shmmax kernel.shmall kernel.perf_event_paranoid kernel.sched_rt_runtime_us kernel.softlockup_panic kernel.yama.ptrace_scope kernel.kptr_restrict kernel.dmesg_restrict kernel.sysrq fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_background_bytes vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_bytes vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes "a_key": "A String", }, "transparentHugepageDefrag": "A String", # Optional. Defines the transparent hugepage defrag configuration on the node. VM hugepage allocation can be managed by either limiting defragmentation for delayed allocation or skipping it entirely for immediate allocation only. See https://docs.kernel.org/admin-guide/mm/transhuge.html for more details. @@ -2822,6 +2860,11 @@

Method Details

}, "minCpuPlatform": "A String", # Minimum CPU platform to be used by this instance. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as `minCpuPlatform: "Intel Haswell"` or `minCpuPlatform: "Intel Sandy Bridge"`. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform) "nodeGroup": "A String", # Setting this field will assign instances of this pool to run on the specified node group. This is useful for running workloads on [sole tenant nodes](https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes). + "nodeImageConfig": { # CustomImageConfig contains the information r # The node image configuration to use for this node pool. Note that this is only applicable for node pools using image_type=CUSTOM. + "image": "A String", # The name of the image to use for this node. + "imageFamily": "A String", # The name of the image family to use for this node. + "imageProject": "A String", # The project containing the image to use for this node. + }, "oauthScopes": [ # The set of Google API scopes to be made available on all of the node VMs under the "default" service account. The following scopes are recommended, but not required, and by default are not included: * `https://www.googleapis.com/auth/compute` is required for mounting persistent storage on your nodes. * `https://www.googleapis.com/auth/devstorage.read_only` is required for communicating with **gcr.io** (the [Artifact Registry](https://cloud.google.com/artifact-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added. "A String", ], @@ -2893,6 +2936,9 @@

Method Details

"mode": "A String", # Mode is the configuration for how to expose metadata to workloads running on the node pool. }, }, + "nodeCreationConfig": { # NodeCreationConfig defines the settings of node creation mode. # Optional. Configuration for Node Creation Mode. + "nodeCreationMode": "A String", # The mode of node creation. + }, "nodeIpv4CidrSize": 42, # Output only. The size of the address space on each node for hosting containers. This is provisioned from within the `container_ipv4_cidr` range. This field will only be set when cluster is in route-based network mode. "nodePoolAutoConfig": { # Node pool configs that apply to all auto-provisioned node pools in autopilot clusters and node auto-provisioning enabled clusters. # Node pool configs that apply to all auto-provisioned node pools in autopilot clusters and node auto-provisioning enabled clusters. "linuxNodeConfig": { # Parameters that can be configured on Linux nodes. # Output only. Configuration options for Linux nodes. @@ -2934,7 +2980,7 @@

Method Details

"swapSizePercent": 42, # Specifies the size of the swap space as a percentage of the ephemeral local SSD capacity. }, }, - "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_mtu_probing net.ipv4.tcp_max_orphans net.ipv4.tcp_max_tw_buckets net.ipv4.tcp_syn_retries net.ipv4.tcp_ecn net.ipv4.tcp_congestion_control net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.shmmni kernel.shmmax kernel.shmall kernel.perf_event_paranoid kernel.sched_rt_runtime_us kernel.softlockup_panic kernel.yama.ptrace_scope kernel.kptr_restrict kernel.dmesg_restrict kernel.sysrq fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_background_bytes vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_bytes vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes + "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.neigh.default.gc_thresh1 net.ipv4.neigh.default.gc_thresh2 net.ipv4.neigh.default.gc_thresh3 net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_mtu_probing net.ipv4.tcp_max_orphans net.ipv4.tcp_max_tw_buckets net.ipv4.tcp_syn_retries net.ipv4.tcp_ecn net.ipv4.tcp_congestion_control net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.keys.maxkeys kernel.keys.maxbytes kernel.shmmni kernel.shmmax kernel.shmall kernel.perf_event_paranoid kernel.sched_rt_runtime_us kernel.softlockup_panic kernel.yama.ptrace_scope kernel.kptr_restrict kernel.dmesg_restrict kernel.sysrq fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_background_bytes vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_bytes vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes "a_key": "A String", }, "transparentHugepageDefrag": "A String", # Optional. Defines the transparent hugepage defrag configuration on the node. VM hugepage allocation can be managed by either limiting defragmentation for delayed allocation or skipping it entirely for immediate allocation only. See https://docs.kernel.org/admin-guide/mm/transhuge.html for more details. @@ -3361,7 +3407,7 @@

Method Details

"swapSizePercent": 42, # Specifies the size of the swap space as a percentage of the ephemeral local SSD capacity. }, }, - "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_mtu_probing net.ipv4.tcp_max_orphans net.ipv4.tcp_max_tw_buckets net.ipv4.tcp_syn_retries net.ipv4.tcp_ecn net.ipv4.tcp_congestion_control net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.shmmni kernel.shmmax kernel.shmall kernel.perf_event_paranoid kernel.sched_rt_runtime_us kernel.softlockup_panic kernel.yama.ptrace_scope kernel.kptr_restrict kernel.dmesg_restrict kernel.sysrq fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_background_bytes vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_bytes vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes + "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.neigh.default.gc_thresh1 net.ipv4.neigh.default.gc_thresh2 net.ipv4.neigh.default.gc_thresh3 net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_mtu_probing net.ipv4.tcp_max_orphans net.ipv4.tcp_max_tw_buckets net.ipv4.tcp_syn_retries net.ipv4.tcp_ecn net.ipv4.tcp_congestion_control net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.keys.maxkeys kernel.keys.maxbytes kernel.shmmni kernel.shmmax kernel.shmall kernel.perf_event_paranoid kernel.sched_rt_runtime_us kernel.softlockup_panic kernel.yama.ptrace_scope kernel.kptr_restrict kernel.dmesg_restrict kernel.sysrq fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_background_bytes vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_bytes vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes "a_key": "A String", }, "transparentHugepageDefrag": "A String", # Optional. Defines the transparent hugepage defrag configuration on the node. VM hugepage allocation can be managed by either limiting defragmentation for delayed allocation or skipping it entirely for immediate allocation only. See https://docs.kernel.org/admin-guide/mm/transhuge.html for more details. @@ -3384,6 +3430,11 @@

Method Details

}, "minCpuPlatform": "A String", # Minimum CPU platform to be used by this instance. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as `minCpuPlatform: "Intel Haswell"` or `minCpuPlatform: "Intel Sandy Bridge"`. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform) "nodeGroup": "A String", # Setting this field will assign instances of this pool to run on the specified node group. This is useful for running workloads on [sole tenant nodes](https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes). + "nodeImageConfig": { # CustomImageConfig contains the information r # The node image configuration to use for this node pool. Note that this is only applicable for node pools using image_type=CUSTOM. + "image": "A String", # The name of the image to use for this node. + "imageFamily": "A String", # The name of the image family to use for this node. + "imageProject": "A String", # The project containing the image to use for this node. + }, "oauthScopes": [ # The set of Google API scopes to be made available on all of the node VMs under the "default" service account. The following scopes are recommended, but not required, and by default are not included: * `https://www.googleapis.com/auth/compute` is required for mounting persistent storage on your nodes. * `https://www.googleapis.com/auth/devstorage.read_only` is required for communicating with **gcr.io** (the [Artifact Registry](https://cloud.google.com/artifact-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added. "A String", ], @@ -3463,6 +3514,13 @@

Method Details

"locations": [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the NodePool's nodes should be located. If this value is unspecified during node pool creation, the [Cluster.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters#Cluster.FIELDS.locations) value will be used, instead. Warning: changing node pool locations will result in nodes being added and/or removed. "A String", ], + "maintenancePolicy": { # Defines the maintenance policy for the node pool. # Optional. Specifies the maintenance policy for the node pool. + "exclusionUntilEndOfSupport": { # Defines the maintenance exclusion for the node pool. # Optional. The exclusion until end of support for the node pool. + "enabled": True or False, # Optional. Indicates whether the exclusion is enabled. + "endTime": "A String", # Output only. The end time of the maintenance exclusion. It is output only. It is the cluster control plane version's end of support time, or end of extended support time when the cluster is on extended support channel. + "startTime": "A String", # Output only. The start time of the maintenance exclusion. It is output only. It is the exclusion creation time. + }, + }, "management": { # NodeManagement defines the set of node management services turned on for the node pool. # NodeManagement configuration for this NodePool. "autoRepair": True or False, # A flag that specifies whether the node auto-repair is enabled for the node pool. If enabled, the nodes in this node pool will be monitored and, if they fail health checks too many times, an automatic repair action will be triggered. "autoUpgrade": True or False, # A flag that specifies whether node auto-upgrade is enabled for the node pool. If enabled, node auto-upgrade helps keep the nodes in your node pool up to date with the latest release version of Kubernetes. @@ -3495,6 +3553,7 @@

Method Details

], "createPodRange": True or False, # Input only. Whether to create a new range for pod IPs in this node pool. Defaults are provided for `pod_range` and `pod_ipv4_cidr_block` if they are not specified. If neither `create_pod_range` or `pod_range` are specified, the cluster-level default (`ip_allocation_policy.cluster_ipv4_cidr_block`) is used. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created. "enablePrivateNodes": True or False, # Whether nodes have internal IP addresses only. If enable_private_nodes is not specified, then the value is derived from Cluster.NetworkConfig.default_enable_private_nodes + "network": "A String", # Optional. Immutable. The VPC network for the node pool. "networkPerformanceConfig": { # Configuration of all network bandwidth tiers # Network bandwidth tier configuration. "totalEgressBandwidthTier": "A String", # Specifies the total network bandwidth tier for the NodePool. }, @@ -3510,6 +3569,8 @@

Method Details

"subnetwork": "A String", # Optional. The subnetwork name/path for the node pool. Format: projects/{project}/regions/{region}/subnetworks/{subnetwork} If the cluster is associated with multiple subnetworks, the subnetwork can be either: - A user supplied subnetwork name during node pool creation (e.g., `my-subnet`). The name must be between 1 and 63 characters long, start with a letter, contain only letters, numbers, and hyphens, and end with a letter or a number. - A full subnetwork path during node pool creation, such as `projects/gke-project/regions/us-central1/subnetworks/my-subnet` - A subnetwork path picked based on the IP utilization during node pool creation and is immutable. }, "nodeDrainConfig": { # NodeDrainConfig contains the node drain related configurations for this node pool. # Specifies the node drain configuration for this node pool. + "graceTerminationDuration": "A String", # The duration of the grace termination period for node drain. + "pdbTimeoutDuration": "A String", # The duration of the PDB timeout period for node drain. "respectPdbDuringNodePoolDeletion": True or False, # Whether to respect PDB during node pool deletion. }, "placementPolicy": { # PlacementPolicy defines the placement policy used by the node pool. # Specifies the node placement policy. @@ -3766,6 +3827,9 @@

Method Details

"clusters": [ # A list of clusters in the project in the specified zone, or across all ones. { # A Google Kubernetes Engine cluster. "addonsConfig": { # Configuration for the addons that can be automatically spun up in the cluster, enabling additional functionality. # Configurations for the various addons available to run in the cluster. + "agentSandboxConfig": { # Configuration for the AgentSandbox addon. # Optional. Configuration for the AgentSandbox addon. + "enabled": True or False, # Optional. Whether AgentSandbox is enabled for this cluster. + }, "cloudRunConfig": { # Configuration options for the Cloud Run feature. # Configuration for the Cloud Run addon, which allows the user to use a managed Knative service. "disabled": True or False, # Whether Cloud Run addon is enabled for this cluster. "loadBalancerType": "A String", # Which load balancer type is installed for Cloud Run. @@ -4203,6 +4267,9 @@

Method Details

"network": "A String", # The name of the Google Compute Engine [network](https://cloud.google.com/compute/docs/networks-and-firewalls#networks) to which the cluster is connected. If left unspecified, the `default` network will be used. "networkConfig": { # NetworkConfig reports the relative names of network & subnetwork. # Configuration for cluster networking. "datapathProvider": "A String", # The desired datapath provider for this cluster. By default, uses the IPTables-based kube-proxy implementation. + "dataplaneV2Config": { # DataplaneV2Config is the configuration for DPv2. # Optional. DataplaneV2Config specifies the DPv2 configuration. + "scalabilityMode": "A String", # Optional. Scalability mode for the cluster. + }, "defaultEnablePrivateNodes": True or False, # Controls whether by default nodes have private IP addresses only. It is invalid to specify both PrivateClusterConfig.enablePrivateNodes and this field at the same time. To update the default setting, use ClusterUpdate.desired_default_enable_private_nodes "defaultSnatStatus": { # DefaultSnatStatus contains the desired state of whether default sNAT should be disabled on the cluster. # Whether the cluster disables default in-node sNAT rules. In-node sNAT rules will be disabled when default_snat_status is disabled. When disabled is set to false, default IP masquerade rules will be applied to the nodes to prevent sNAT on cluster internal traffic. "disabled": True or False, # Disables cluster default sNAT rules. @@ -4444,7 +4511,7 @@

Method Details

"swapSizePercent": 42, # Specifies the size of the swap space as a percentage of the ephemeral local SSD capacity. }, }, - "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_mtu_probing net.ipv4.tcp_max_orphans net.ipv4.tcp_max_tw_buckets net.ipv4.tcp_syn_retries net.ipv4.tcp_ecn net.ipv4.tcp_congestion_control net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.shmmni kernel.shmmax kernel.shmall kernel.perf_event_paranoid kernel.sched_rt_runtime_us kernel.softlockup_panic kernel.yama.ptrace_scope kernel.kptr_restrict kernel.dmesg_restrict kernel.sysrq fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_background_bytes vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_bytes vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes + "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.neigh.default.gc_thresh1 net.ipv4.neigh.default.gc_thresh2 net.ipv4.neigh.default.gc_thresh3 net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_mtu_probing net.ipv4.tcp_max_orphans net.ipv4.tcp_max_tw_buckets net.ipv4.tcp_syn_retries net.ipv4.tcp_ecn net.ipv4.tcp_congestion_control net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.keys.maxkeys kernel.keys.maxbytes kernel.shmmni kernel.shmmax kernel.shmall kernel.perf_event_paranoid kernel.sched_rt_runtime_us kernel.softlockup_panic kernel.yama.ptrace_scope kernel.kptr_restrict kernel.dmesg_restrict kernel.sysrq fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_background_bytes vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_bytes vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes "a_key": "A String", }, "transparentHugepageDefrag": "A String", # Optional. Defines the transparent hugepage defrag configuration on the node. VM hugepage allocation can be managed by either limiting defragmentation for delayed allocation or skipping it entirely for immediate allocation only. See https://docs.kernel.org/admin-guide/mm/transhuge.html for more details. @@ -4467,6 +4534,11 @@

Method Details

}, "minCpuPlatform": "A String", # Minimum CPU platform to be used by this instance. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as `minCpuPlatform: "Intel Haswell"` or `minCpuPlatform: "Intel Sandy Bridge"`. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform) "nodeGroup": "A String", # Setting this field will assign instances of this pool to run on the specified node group. This is useful for running workloads on [sole tenant nodes](https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes). + "nodeImageConfig": { # CustomImageConfig contains the information r # The node image configuration to use for this node pool. Note that this is only applicable for node pools using image_type=CUSTOM. + "image": "A String", # The name of the image to use for this node. + "imageFamily": "A String", # The name of the image family to use for this node. + "imageProject": "A String", # The project containing the image to use for this node. + }, "oauthScopes": [ # The set of Google API scopes to be made available on all of the node VMs under the "default" service account. The following scopes are recommended, but not required, and by default are not included: * `https://www.googleapis.com/auth/compute` is required for mounting persistent storage on your nodes. * `https://www.googleapis.com/auth/devstorage.read_only` is required for communicating with **gcr.io** (the [Artifact Registry](https://cloud.google.com/artifact-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added. "A String", ], @@ -4538,6 +4610,9 @@

Method Details

"mode": "A String", # Mode is the configuration for how to expose metadata to workloads running on the node pool. }, }, + "nodeCreationConfig": { # NodeCreationConfig defines the settings of node creation mode. # Optional. Configuration for Node Creation Mode. + "nodeCreationMode": "A String", # The mode of node creation. + }, "nodeIpv4CidrSize": 42, # Output only. The size of the address space on each node for hosting containers. This is provisioned from within the `container_ipv4_cidr` range. This field will only be set when cluster is in route-based network mode. "nodePoolAutoConfig": { # Node pool configs that apply to all auto-provisioned node pools in autopilot clusters and node auto-provisioning enabled clusters. # Node pool configs that apply to all auto-provisioned node pools in autopilot clusters and node auto-provisioning enabled clusters. "linuxNodeConfig": { # Parameters that can be configured on Linux nodes. # Output only. Configuration options for Linux nodes. @@ -4579,7 +4654,7 @@

Method Details

"swapSizePercent": 42, # Specifies the size of the swap space as a percentage of the ephemeral local SSD capacity. }, }, - "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_mtu_probing net.ipv4.tcp_max_orphans net.ipv4.tcp_max_tw_buckets net.ipv4.tcp_syn_retries net.ipv4.tcp_ecn net.ipv4.tcp_congestion_control net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.shmmni kernel.shmmax kernel.shmall kernel.perf_event_paranoid kernel.sched_rt_runtime_us kernel.softlockup_panic kernel.yama.ptrace_scope kernel.kptr_restrict kernel.dmesg_restrict kernel.sysrq fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_background_bytes vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_bytes vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes + "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.neigh.default.gc_thresh1 net.ipv4.neigh.default.gc_thresh2 net.ipv4.neigh.default.gc_thresh3 net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_mtu_probing net.ipv4.tcp_max_orphans net.ipv4.tcp_max_tw_buckets net.ipv4.tcp_syn_retries net.ipv4.tcp_ecn net.ipv4.tcp_congestion_control net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.keys.maxkeys kernel.keys.maxbytes kernel.shmmni kernel.shmmax kernel.shmall kernel.perf_event_paranoid kernel.sched_rt_runtime_us kernel.softlockup_panic kernel.yama.ptrace_scope kernel.kptr_restrict kernel.dmesg_restrict kernel.sysrq fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_background_bytes vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_bytes vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes "a_key": "A String", }, "transparentHugepageDefrag": "A String", # Optional. Defines the transparent hugepage defrag configuration on the node. VM hugepage allocation can be managed by either limiting defragmentation for delayed allocation or skipping it entirely for immediate allocation only. See https://docs.kernel.org/admin-guide/mm/transhuge.html for more details. @@ -5006,7 +5081,7 @@

Method Details

"swapSizePercent": 42, # Specifies the size of the swap space as a percentage of the ephemeral local SSD capacity. }, }, - "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_mtu_probing net.ipv4.tcp_max_orphans net.ipv4.tcp_max_tw_buckets net.ipv4.tcp_syn_retries net.ipv4.tcp_ecn net.ipv4.tcp_congestion_control net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.shmmni kernel.shmmax kernel.shmall kernel.perf_event_paranoid kernel.sched_rt_runtime_us kernel.softlockup_panic kernel.yama.ptrace_scope kernel.kptr_restrict kernel.dmesg_restrict kernel.sysrq fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_background_bytes vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_bytes vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes + "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.neigh.default.gc_thresh1 net.ipv4.neigh.default.gc_thresh2 net.ipv4.neigh.default.gc_thresh3 net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_mtu_probing net.ipv4.tcp_max_orphans net.ipv4.tcp_max_tw_buckets net.ipv4.tcp_syn_retries net.ipv4.tcp_ecn net.ipv4.tcp_congestion_control net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.keys.maxkeys kernel.keys.maxbytes kernel.shmmni kernel.shmmax kernel.shmall kernel.perf_event_paranoid kernel.sched_rt_runtime_us kernel.softlockup_panic kernel.yama.ptrace_scope kernel.kptr_restrict kernel.dmesg_restrict kernel.sysrq fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_background_bytes vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_bytes vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes "a_key": "A String", }, "transparentHugepageDefrag": "A String", # Optional. Defines the transparent hugepage defrag configuration on the node. VM hugepage allocation can be managed by either limiting defragmentation for delayed allocation or skipping it entirely for immediate allocation only. See https://docs.kernel.org/admin-guide/mm/transhuge.html for more details. @@ -5029,6 +5104,11 @@

Method Details

}, "minCpuPlatform": "A String", # Minimum CPU platform to be used by this instance. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as `minCpuPlatform: "Intel Haswell"` or `minCpuPlatform: "Intel Sandy Bridge"`. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform) "nodeGroup": "A String", # Setting this field will assign instances of this pool to run on the specified node group. This is useful for running workloads on [sole tenant nodes](https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes). + "nodeImageConfig": { # CustomImageConfig contains the information r # The node image configuration to use for this node pool. Note that this is only applicable for node pools using image_type=CUSTOM. + "image": "A String", # The name of the image to use for this node. + "imageFamily": "A String", # The name of the image family to use for this node. + "imageProject": "A String", # The project containing the image to use for this node. + }, "oauthScopes": [ # The set of Google API scopes to be made available on all of the node VMs under the "default" service account. The following scopes are recommended, but not required, and by default are not included: * `https://www.googleapis.com/auth/compute` is required for mounting persistent storage on your nodes. * `https://www.googleapis.com/auth/devstorage.read_only` is required for communicating with **gcr.io** (the [Artifact Registry](https://cloud.google.com/artifact-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added. "A String", ], @@ -5108,6 +5188,13 @@

Method Details

"locations": [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the NodePool's nodes should be located. If this value is unspecified during node pool creation, the [Cluster.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters#Cluster.FIELDS.locations) value will be used, instead. Warning: changing node pool locations will result in nodes being added and/or removed. "A String", ], + "maintenancePolicy": { # Defines the maintenance policy for the node pool. # Optional. Specifies the maintenance policy for the node pool. + "exclusionUntilEndOfSupport": { # Defines the maintenance exclusion for the node pool. # Optional. The exclusion until end of support for the node pool. + "enabled": True or False, # Optional. Indicates whether the exclusion is enabled. + "endTime": "A String", # Output only. The end time of the maintenance exclusion. It is output only. It is the cluster control plane version's end of support time, or end of extended support time when the cluster is on extended support channel. + "startTime": "A String", # Output only. The start time of the maintenance exclusion. It is output only. It is the exclusion creation time. + }, + }, "management": { # NodeManagement defines the set of node management services turned on for the node pool. # NodeManagement configuration for this NodePool. "autoRepair": True or False, # A flag that specifies whether the node auto-repair is enabled for the node pool. If enabled, the nodes in this node pool will be monitored and, if they fail health checks too many times, an automatic repair action will be triggered. "autoUpgrade": True or False, # A flag that specifies whether node auto-upgrade is enabled for the node pool. If enabled, node auto-upgrade helps keep the nodes in your node pool up to date with the latest release version of Kubernetes. @@ -5140,6 +5227,7 @@

Method Details

], "createPodRange": True or False, # Input only. Whether to create a new range for pod IPs in this node pool. Defaults are provided for `pod_range` and `pod_ipv4_cidr_block` if they are not specified. If neither `create_pod_range` or `pod_range` are specified, the cluster-level default (`ip_allocation_policy.cluster_ipv4_cidr_block`) is used. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created. "enablePrivateNodes": True or False, # Whether nodes have internal IP addresses only. If enable_private_nodes is not specified, then the value is derived from Cluster.NetworkConfig.default_enable_private_nodes + "network": "A String", # Optional. Immutable. The VPC network for the node pool. "networkPerformanceConfig": { # Configuration of all network bandwidth tiers # Network bandwidth tier configuration. "totalEgressBandwidthTier": "A String", # Specifies the total network bandwidth tier for the NodePool. }, @@ -5155,6 +5243,8 @@

Method Details

"subnetwork": "A String", # Optional. The subnetwork name/path for the node pool. Format: projects/{project}/regions/{region}/subnetworks/{subnetwork} If the cluster is associated with multiple subnetworks, the subnetwork can be either: - A user supplied subnetwork name during node pool creation (e.g., `my-subnet`). The name must be between 1 and 63 characters long, start with a letter, contain only letters, numbers, and hyphens, and end with a letter or a number. - A full subnetwork path during node pool creation, such as `projects/gke-project/regions/us-central1/subnetworks/my-subnet` - A subnetwork path picked based on the IP utilization during node pool creation and is immutable. }, "nodeDrainConfig": { # NodeDrainConfig contains the node drain related configurations for this node pool. # Specifies the node drain configuration for this node pool. + "graceTerminationDuration": "A String", # The duration of the grace termination period for node drain. + "pdbTimeoutDuration": "A String", # The duration of the PDB timeout period for node drain. "respectPdbDuringNodePoolDeletion": True or False, # Whether to respect PDB during node pool deletion. }, "placementPolicy": { # PlacementPolicy defines the placement policy used by the node pool. # Specifies the node placement policy. @@ -6143,6 +6233,9 @@

Method Details

], }, "desiredAddonsConfig": { # Configuration for the addons that can be automatically spun up in the cluster, enabling additional functionality. # Configurations for the various addons available to run in the cluster. + "agentSandboxConfig": { # Configuration for the AgentSandbox addon. # Optional. Configuration for the AgentSandbox addon. + "enabled": True or False, # Optional. Whether AgentSandbox is enabled for this cluster. + }, "cloudRunConfig": { # Configuration options for the Cloud Run feature. # Configuration for the Cloud Run addon, which allows the user to use a managed Knative service. "disabled": True or False, # Whether Cloud Run addon is enabled for this cluster. "loadBalancerType": "A String", # Which load balancer type is installed for Cloud Run. @@ -6441,6 +6534,8 @@

Method Details

"desiredIdentityServiceConfig": { # IdentityServiceConfig is configuration for Identity Service which allows customers to use external identity providers with the K8S API # The desired Identity Service component configuration. "enabled": True or False, # Whether to enable the Identity Service component }, + "desiredImage": "A String", # The desired name of the image to use for this node. This is used to create clusters using a custom image. NOTE: Set the "desired_node_pool" field as well. + "desiredImageProject": "A String", # The project containing the desired image to use for this node. This is used to create clusters using a custom image. NOTE: Set the "desired_node_pool" field as well. "desiredImageType": "A String", # The desired image type for the node pool. NOTE: Set the "desired_node_pool" field as well. "desiredInTransitEncryptionConfig": "A String", # Specify the details of in-transit encryption. "desiredIntraNodeVisibilityConfig": { # IntraNodeVisibilityConfig contains the desired config of the intra-node visibility on this cluster. # The desired config of Intra-node visibility. @@ -6511,6 +6606,9 @@

Method Details

"desiredNetworkTierConfig": { # NetworkTierConfig contains network tier information. # The desired network tier configuration for the cluster. "networkTier": "A String", # Network tier configuration. }, + "desiredNodeCreationConfig": { # NodeCreationConfig defines the settings of node creation mode. # Optional. The desired NodeCreationConfig for the cluster. + "nodeCreationMode": "A String", # The mode of node creation. + }, "desiredNodeKubeletConfig": { # Node kubelet configs. # The desired node kubelet config for the cluster. "allowedUnsafeSysctls": [ # Optional. Defines a comma-separated allowlist of unsafe sysctls or sysctl patterns (ending in `*`). The unsafe namespaced sysctl groups are `kernel.shm*`, `kernel.msg*`, `kernel.sem`, `fs.mqueue.*`, and `net.*`. Leaving this allowlist empty means they cannot be set on Pods. To allow certain sysctls or sysctl patterns to be set on Pods, list them separated by commas. For example: `kernel.msg*,net.ipv4.route.min_pmtu`. See https://kubernetes.io/docs/tasks/administer-cluster/sysctl-cluster/ for more details. "A String", @@ -6660,7 +6758,7 @@

Method Details

"swapSizePercent": 42, # Specifies the size of the swap space as a percentage of the ephemeral local SSD capacity. }, }, - "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_mtu_probing net.ipv4.tcp_max_orphans net.ipv4.tcp_max_tw_buckets net.ipv4.tcp_syn_retries net.ipv4.tcp_ecn net.ipv4.tcp_congestion_control net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.shmmni kernel.shmmax kernel.shmall kernel.perf_event_paranoid kernel.sched_rt_runtime_us kernel.softlockup_panic kernel.yama.ptrace_scope kernel.kptr_restrict kernel.dmesg_restrict kernel.sysrq fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_background_bytes vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_bytes vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes + "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.neigh.default.gc_thresh1 net.ipv4.neigh.default.gc_thresh2 net.ipv4.neigh.default.gc_thresh3 net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_mtu_probing net.ipv4.tcp_max_orphans net.ipv4.tcp_max_tw_buckets net.ipv4.tcp_syn_retries net.ipv4.tcp_ecn net.ipv4.tcp_congestion_control net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.keys.maxkeys kernel.keys.maxbytes kernel.shmmni kernel.shmmax kernel.shmall kernel.perf_event_paranoid kernel.sched_rt_runtime_us kernel.softlockup_panic kernel.yama.ptrace_scope kernel.kptr_restrict kernel.dmesg_restrict kernel.sysrq fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_background_bytes vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_bytes vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes "a_key": "A String", }, "transparentHugepageDefrag": "A String", # Optional. Defines the transparent hugepage defrag configuration on the node. VM hugepage allocation can be managed by either limiting defragmentation for delayed allocation or skipping it entirely for immediate allocation only. See https://docs.kernel.org/admin-guide/mm/transhuge.html for more details. diff --git a/docs/dyn/container_v1.projects.zones.clusters.nodePools.html b/docs/dyn/container_v1.projects.zones.clusters.nodePools.html index 0f3f6daeaf..fc39e400e4 100644 --- a/docs/dyn/container_v1.projects.zones.clusters.nodePools.html +++ b/docs/dyn/container_v1.projects.zones.clusters.nodePools.html @@ -447,7 +447,7 @@

Method Details

"swapSizePercent": 42, # Specifies the size of the swap space as a percentage of the ephemeral local SSD capacity. }, }, - "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_mtu_probing net.ipv4.tcp_max_orphans net.ipv4.tcp_max_tw_buckets net.ipv4.tcp_syn_retries net.ipv4.tcp_ecn net.ipv4.tcp_congestion_control net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.shmmni kernel.shmmax kernel.shmall kernel.perf_event_paranoid kernel.sched_rt_runtime_us kernel.softlockup_panic kernel.yama.ptrace_scope kernel.kptr_restrict kernel.dmesg_restrict kernel.sysrq fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_background_bytes vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_bytes vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes + "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.neigh.default.gc_thresh1 net.ipv4.neigh.default.gc_thresh2 net.ipv4.neigh.default.gc_thresh3 net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_mtu_probing net.ipv4.tcp_max_orphans net.ipv4.tcp_max_tw_buckets net.ipv4.tcp_syn_retries net.ipv4.tcp_ecn net.ipv4.tcp_congestion_control net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.keys.maxkeys kernel.keys.maxbytes kernel.shmmni kernel.shmmax kernel.shmall kernel.perf_event_paranoid kernel.sched_rt_runtime_us kernel.softlockup_panic kernel.yama.ptrace_scope kernel.kptr_restrict kernel.dmesg_restrict kernel.sysrq fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_background_bytes vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_bytes vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes "a_key": "A String", }, "transparentHugepageDefrag": "A String", # Optional. Defines the transparent hugepage defrag configuration on the node. VM hugepage allocation can be managed by either limiting defragmentation for delayed allocation or skipping it entirely for immediate allocation only. See https://docs.kernel.org/admin-guide/mm/transhuge.html for more details. @@ -470,6 +470,11 @@

Method Details

}, "minCpuPlatform": "A String", # Minimum CPU platform to be used by this instance. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as `minCpuPlatform: "Intel Haswell"` or `minCpuPlatform: "Intel Sandy Bridge"`. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform) "nodeGroup": "A String", # Setting this field will assign instances of this pool to run on the specified node group. This is useful for running workloads on [sole tenant nodes](https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes). + "nodeImageConfig": { # CustomImageConfig contains the information r # The node image configuration to use for this node pool. Note that this is only applicable for node pools using image_type=CUSTOM. + "image": "A String", # The name of the image to use for this node. + "imageFamily": "A String", # The name of the image family to use for this node. + "imageProject": "A String", # The project containing the image to use for this node. + }, "oauthScopes": [ # The set of Google API scopes to be made available on all of the node VMs under the "default" service account. The following scopes are recommended, but not required, and by default are not included: * `https://www.googleapis.com/auth/compute` is required for mounting persistent storage on your nodes. * `https://www.googleapis.com/auth/devstorage.read_only` is required for communicating with **gcr.io** (the [Artifact Registry](https://cloud.google.com/artifact-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added. "A String", ], @@ -549,6 +554,13 @@

Method Details

"locations": [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the NodePool's nodes should be located. If this value is unspecified during node pool creation, the [Cluster.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters#Cluster.FIELDS.locations) value will be used, instead. Warning: changing node pool locations will result in nodes being added and/or removed. "A String", ], + "maintenancePolicy": { # Defines the maintenance policy for the node pool. # Optional. Specifies the maintenance policy for the node pool. + "exclusionUntilEndOfSupport": { # Defines the maintenance exclusion for the node pool. # Optional. The exclusion until end of support for the node pool. + "enabled": True or False, # Optional. Indicates whether the exclusion is enabled. + "endTime": "A String", # Output only. The end time of the maintenance exclusion. It is output only. It is the cluster control plane version's end of support time, or end of extended support time when the cluster is on extended support channel. + "startTime": "A String", # Output only. The start time of the maintenance exclusion. It is output only. It is the exclusion creation time. + }, + }, "management": { # NodeManagement defines the set of node management services turned on for the node pool. # NodeManagement configuration for this NodePool. "autoRepair": True or False, # A flag that specifies whether the node auto-repair is enabled for the node pool. If enabled, the nodes in this node pool will be monitored and, if they fail health checks too many times, an automatic repair action will be triggered. "autoUpgrade": True or False, # A flag that specifies whether node auto-upgrade is enabled for the node pool. If enabled, node auto-upgrade helps keep the nodes in your node pool up to date with the latest release version of Kubernetes. @@ -581,6 +593,7 @@

Method Details

], "createPodRange": True or False, # Input only. Whether to create a new range for pod IPs in this node pool. Defaults are provided for `pod_range` and `pod_ipv4_cidr_block` if they are not specified. If neither `create_pod_range` or `pod_range` are specified, the cluster-level default (`ip_allocation_policy.cluster_ipv4_cidr_block`) is used. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created. "enablePrivateNodes": True or False, # Whether nodes have internal IP addresses only. If enable_private_nodes is not specified, then the value is derived from Cluster.NetworkConfig.default_enable_private_nodes + "network": "A String", # Optional. Immutable. The VPC network for the node pool. "networkPerformanceConfig": { # Configuration of all network bandwidth tiers # Network bandwidth tier configuration. "totalEgressBandwidthTier": "A String", # Specifies the total network bandwidth tier for the NodePool. }, @@ -596,6 +609,8 @@

Method Details

"subnetwork": "A String", # Optional. The subnetwork name/path for the node pool. Format: projects/{project}/regions/{region}/subnetworks/{subnetwork} If the cluster is associated with multiple subnetworks, the subnetwork can be either: - A user supplied subnetwork name during node pool creation (e.g., `my-subnet`). The name must be between 1 and 63 characters long, start with a letter, contain only letters, numbers, and hyphens, and end with a letter or a number. - A full subnetwork path during node pool creation, such as `projects/gke-project/regions/us-central1/subnetworks/my-subnet` - A subnetwork path picked based on the IP utilization during node pool creation and is immutable. }, "nodeDrainConfig": { # NodeDrainConfig contains the node drain related configurations for this node pool. # Specifies the node drain configuration for this node pool. + "graceTerminationDuration": "A String", # The duration of the grace termination period for node drain. + "pdbTimeoutDuration": "A String", # The duration of the PDB timeout period for node drain. "respectPdbDuringNodePoolDeletion": True or False, # Whether to respect PDB during node pool deletion. }, "placementPolicy": { # PlacementPolicy defines the placement policy used by the node pool. # Specifies the node placement policy. @@ -1066,7 +1081,7 @@

Method Details

"swapSizePercent": 42, # Specifies the size of the swap space as a percentage of the ephemeral local SSD capacity. }, }, - "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_mtu_probing net.ipv4.tcp_max_orphans net.ipv4.tcp_max_tw_buckets net.ipv4.tcp_syn_retries net.ipv4.tcp_ecn net.ipv4.tcp_congestion_control net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.shmmni kernel.shmmax kernel.shmall kernel.perf_event_paranoid kernel.sched_rt_runtime_us kernel.softlockup_panic kernel.yama.ptrace_scope kernel.kptr_restrict kernel.dmesg_restrict kernel.sysrq fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_background_bytes vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_bytes vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes + "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.neigh.default.gc_thresh1 net.ipv4.neigh.default.gc_thresh2 net.ipv4.neigh.default.gc_thresh3 net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_mtu_probing net.ipv4.tcp_max_orphans net.ipv4.tcp_max_tw_buckets net.ipv4.tcp_syn_retries net.ipv4.tcp_ecn net.ipv4.tcp_congestion_control net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.keys.maxkeys kernel.keys.maxbytes kernel.shmmni kernel.shmmax kernel.shmall kernel.perf_event_paranoid kernel.sched_rt_runtime_us kernel.softlockup_panic kernel.yama.ptrace_scope kernel.kptr_restrict kernel.dmesg_restrict kernel.sysrq fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_background_bytes vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_bytes vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes "a_key": "A String", }, "transparentHugepageDefrag": "A String", # Optional. Defines the transparent hugepage defrag configuration on the node. VM hugepage allocation can be managed by either limiting defragmentation for delayed allocation or skipping it entirely for immediate allocation only. See https://docs.kernel.org/admin-guide/mm/transhuge.html for more details. @@ -1089,6 +1104,11 @@

Method Details

}, "minCpuPlatform": "A String", # Minimum CPU platform to be used by this instance. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as `minCpuPlatform: "Intel Haswell"` or `minCpuPlatform: "Intel Sandy Bridge"`. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform) "nodeGroup": "A String", # Setting this field will assign instances of this pool to run on the specified node group. This is useful for running workloads on [sole tenant nodes](https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes). + "nodeImageConfig": { # CustomImageConfig contains the information r # The node image configuration to use for this node pool. Note that this is only applicable for node pools using image_type=CUSTOM. + "image": "A String", # The name of the image to use for this node. + "imageFamily": "A String", # The name of the image family to use for this node. + "imageProject": "A String", # The project containing the image to use for this node. + }, "oauthScopes": [ # The set of Google API scopes to be made available on all of the node VMs under the "default" service account. The following scopes are recommended, but not required, and by default are not included: * `https://www.googleapis.com/auth/compute` is required for mounting persistent storage on your nodes. * `https://www.googleapis.com/auth/devstorage.read_only` is required for communicating with **gcr.io** (the [Artifact Registry](https://cloud.google.com/artifact-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added. "A String", ], @@ -1168,6 +1188,13 @@

Method Details

"locations": [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the NodePool's nodes should be located. If this value is unspecified during node pool creation, the [Cluster.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters#Cluster.FIELDS.locations) value will be used, instead. Warning: changing node pool locations will result in nodes being added and/or removed. "A String", ], + "maintenancePolicy": { # Defines the maintenance policy for the node pool. # Optional. Specifies the maintenance policy for the node pool. + "exclusionUntilEndOfSupport": { # Defines the maintenance exclusion for the node pool. # Optional. The exclusion until end of support for the node pool. + "enabled": True or False, # Optional. Indicates whether the exclusion is enabled. + "endTime": "A String", # Output only. The end time of the maintenance exclusion. It is output only. It is the cluster control plane version's end of support time, or end of extended support time when the cluster is on extended support channel. + "startTime": "A String", # Output only. The start time of the maintenance exclusion. It is output only. It is the exclusion creation time. + }, + }, "management": { # NodeManagement defines the set of node management services turned on for the node pool. # NodeManagement configuration for this NodePool. "autoRepair": True or False, # A flag that specifies whether the node auto-repair is enabled for the node pool. If enabled, the nodes in this node pool will be monitored and, if they fail health checks too many times, an automatic repair action will be triggered. "autoUpgrade": True or False, # A flag that specifies whether node auto-upgrade is enabled for the node pool. If enabled, node auto-upgrade helps keep the nodes in your node pool up to date with the latest release version of Kubernetes. @@ -1200,6 +1227,7 @@

Method Details

], "createPodRange": True or False, # Input only. Whether to create a new range for pod IPs in this node pool. Defaults are provided for `pod_range` and `pod_ipv4_cidr_block` if they are not specified. If neither `create_pod_range` or `pod_range` are specified, the cluster-level default (`ip_allocation_policy.cluster_ipv4_cidr_block`) is used. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created. "enablePrivateNodes": True or False, # Whether nodes have internal IP addresses only. If enable_private_nodes is not specified, then the value is derived from Cluster.NetworkConfig.default_enable_private_nodes + "network": "A String", # Optional. Immutable. The VPC network for the node pool. "networkPerformanceConfig": { # Configuration of all network bandwidth tiers # Network bandwidth tier configuration. "totalEgressBandwidthTier": "A String", # Specifies the total network bandwidth tier for the NodePool. }, @@ -1215,6 +1243,8 @@

Method Details

"subnetwork": "A String", # Optional. The subnetwork name/path for the node pool. Format: projects/{project}/regions/{region}/subnetworks/{subnetwork} If the cluster is associated with multiple subnetworks, the subnetwork can be either: - A user supplied subnetwork name during node pool creation (e.g., `my-subnet`). The name must be between 1 and 63 characters long, start with a letter, contain only letters, numbers, and hyphens, and end with a letter or a number. - A full subnetwork path during node pool creation, such as `projects/gke-project/regions/us-central1/subnetworks/my-subnet` - A subnetwork path picked based on the IP utilization during node pool creation and is immutable. }, "nodeDrainConfig": { # NodeDrainConfig contains the node drain related configurations for this node pool. # Specifies the node drain configuration for this node pool. + "graceTerminationDuration": "A String", # The duration of the grace termination period for node drain. + "pdbTimeoutDuration": "A String", # The duration of the PDB timeout period for node drain. "respectPdbDuringNodePoolDeletion": True or False, # Whether to respect PDB during node pool deletion. }, "placementPolicy": { # PlacementPolicy defines the placement policy used by the node pool. # Specifies the node placement policy. @@ -1512,7 +1542,7 @@

Method Details

"swapSizePercent": 42, # Specifies the size of the swap space as a percentage of the ephemeral local SSD capacity. }, }, - "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_mtu_probing net.ipv4.tcp_max_orphans net.ipv4.tcp_max_tw_buckets net.ipv4.tcp_syn_retries net.ipv4.tcp_ecn net.ipv4.tcp_congestion_control net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.shmmni kernel.shmmax kernel.shmall kernel.perf_event_paranoid kernel.sched_rt_runtime_us kernel.softlockup_panic kernel.yama.ptrace_scope kernel.kptr_restrict kernel.dmesg_restrict kernel.sysrq fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_background_bytes vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_bytes vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes + "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.neigh.default.gc_thresh1 net.ipv4.neigh.default.gc_thresh2 net.ipv4.neigh.default.gc_thresh3 net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_mtu_probing net.ipv4.tcp_max_orphans net.ipv4.tcp_max_tw_buckets net.ipv4.tcp_syn_retries net.ipv4.tcp_ecn net.ipv4.tcp_congestion_control net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.keys.maxkeys kernel.keys.maxbytes kernel.shmmni kernel.shmmax kernel.shmall kernel.perf_event_paranoid kernel.sched_rt_runtime_us kernel.softlockup_panic kernel.yama.ptrace_scope kernel.kptr_restrict kernel.dmesg_restrict kernel.sysrq fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_background_bytes vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_bytes vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes "a_key": "A String", }, "transparentHugepageDefrag": "A String", # Optional. Defines the transparent hugepage defrag configuration on the node. VM hugepage allocation can be managed by either limiting defragmentation for delayed allocation or skipping it entirely for immediate allocation only. See https://docs.kernel.org/admin-guide/mm/transhuge.html for more details. @@ -1535,6 +1565,11 @@

Method Details

}, "minCpuPlatform": "A String", # Minimum CPU platform to be used by this instance. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as `minCpuPlatform: "Intel Haswell"` or `minCpuPlatform: "Intel Sandy Bridge"`. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform) "nodeGroup": "A String", # Setting this field will assign instances of this pool to run on the specified node group. This is useful for running workloads on [sole tenant nodes](https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes). + "nodeImageConfig": { # CustomImageConfig contains the information r # The node image configuration to use for this node pool. Note that this is only applicable for node pools using image_type=CUSTOM. + "image": "A String", # The name of the image to use for this node. + "imageFamily": "A String", # The name of the image family to use for this node. + "imageProject": "A String", # The project containing the image to use for this node. + }, "oauthScopes": [ # The set of Google API scopes to be made available on all of the node VMs under the "default" service account. The following scopes are recommended, but not required, and by default are not included: * `https://www.googleapis.com/auth/compute` is required for mounting persistent storage on your nodes. * `https://www.googleapis.com/auth/devstorage.read_only` is required for communicating with **gcr.io** (the [Artifact Registry](https://cloud.google.com/artifact-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added. "A String", ], @@ -1614,6 +1649,13 @@

Method Details

"locations": [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the NodePool's nodes should be located. If this value is unspecified during node pool creation, the [Cluster.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters#Cluster.FIELDS.locations) value will be used, instead. Warning: changing node pool locations will result in nodes being added and/or removed. "A String", ], + "maintenancePolicy": { # Defines the maintenance policy for the node pool. # Optional. Specifies the maintenance policy for the node pool. + "exclusionUntilEndOfSupport": { # Defines the maintenance exclusion for the node pool. # Optional. The exclusion until end of support for the node pool. + "enabled": True or False, # Optional. Indicates whether the exclusion is enabled. + "endTime": "A String", # Output only. The end time of the maintenance exclusion. It is output only. It is the cluster control plane version's end of support time, or end of extended support time when the cluster is on extended support channel. + "startTime": "A String", # Output only. The start time of the maintenance exclusion. It is output only. It is the exclusion creation time. + }, + }, "management": { # NodeManagement defines the set of node management services turned on for the node pool. # NodeManagement configuration for this NodePool. "autoRepair": True or False, # A flag that specifies whether the node auto-repair is enabled for the node pool. If enabled, the nodes in this node pool will be monitored and, if they fail health checks too many times, an automatic repair action will be triggered. "autoUpgrade": True or False, # A flag that specifies whether node auto-upgrade is enabled for the node pool. If enabled, node auto-upgrade helps keep the nodes in your node pool up to date with the latest release version of Kubernetes. @@ -1646,6 +1688,7 @@

Method Details

], "createPodRange": True or False, # Input only. Whether to create a new range for pod IPs in this node pool. Defaults are provided for `pod_range` and `pod_ipv4_cidr_block` if they are not specified. If neither `create_pod_range` or `pod_range` are specified, the cluster-level default (`ip_allocation_policy.cluster_ipv4_cidr_block`) is used. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created. "enablePrivateNodes": True or False, # Whether nodes have internal IP addresses only. If enable_private_nodes is not specified, then the value is derived from Cluster.NetworkConfig.default_enable_private_nodes + "network": "A String", # Optional. Immutable. The VPC network for the node pool. "networkPerformanceConfig": { # Configuration of all network bandwidth tiers # Network bandwidth tier configuration. "totalEgressBandwidthTier": "A String", # Specifies the total network bandwidth tier for the NodePool. }, @@ -1661,6 +1704,8 @@

Method Details

"subnetwork": "A String", # Optional. The subnetwork name/path for the node pool. Format: projects/{project}/regions/{region}/subnetworks/{subnetwork} If the cluster is associated with multiple subnetworks, the subnetwork can be either: - A user supplied subnetwork name during node pool creation (e.g., `my-subnet`). The name must be between 1 and 63 characters long, start with a letter, contain only letters, numbers, and hyphens, and end with a letter or a number. - A full subnetwork path during node pool creation, such as `projects/gke-project/regions/us-central1/subnetworks/my-subnet` - A subnetwork path picked based on the IP utilization during node pool creation and is immutable. }, "nodeDrainConfig": { # NodeDrainConfig contains the node drain related configurations for this node pool. # Specifies the node drain configuration for this node pool. + "graceTerminationDuration": "A String", # The duration of the grace termination period for node drain. + "pdbTimeoutDuration": "A String", # The duration of the PDB timeout period for node drain. "respectPdbDuringNodePoolDeletion": True or False, # Whether to respect PDB during node pool deletion. }, "placementPolicy": { # PlacementPolicy defines the placement policy used by the node pool. # Specifies the node placement policy. @@ -2071,6 +2116,8 @@

Method Details

"gvnic": { # Configuration of gVNIC feature. # Enable or disable gvnic on the node pool. "enabled": True or False, # Whether gVNIC features are enabled in the node pool. }, + "image": "A String", # The desired name of the image name to use for this node. This is used to create clusters using a custom image. + "imageProject": "A String", # The project containing the desired image to use for this node pool. This is used to create clusters using a custom image. "imageType": "A String", # Required. The desired image type for the node pool. Please see https://cloud.google.com/kubernetes-engine/docs/concepts/node-images for available image types. "kubeletConfig": { # Node kubelet configs. # Node kubelet configs. "allowedUnsafeSysctls": [ # Optional. Defines a comma-separated allowlist of unsafe sysctls or sysctl patterns (ending in `*`). The unsafe namespaced sysctl groups are `kernel.shm*`, `kernel.msg*`, `kernel.sem`, `fs.mqueue.*`, and `net.*`. Leaving this allowlist empty means they cannot be set on Pods. To allow certain sysctls or sysctl patterns to be set on Pods, list them separated by commas. For example: `kernel.msg*,net.ipv4.route.min_pmtu`. See https://kubernetes.io/docs/tasks/administer-cluster/sysctl-cluster/ for more details. @@ -2171,7 +2218,7 @@

Method Details

"swapSizePercent": 42, # Specifies the size of the swap space as a percentage of the ephemeral local SSD capacity. }, }, - "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_mtu_probing net.ipv4.tcp_max_orphans net.ipv4.tcp_max_tw_buckets net.ipv4.tcp_syn_retries net.ipv4.tcp_ecn net.ipv4.tcp_congestion_control net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.shmmni kernel.shmmax kernel.shmall kernel.perf_event_paranoid kernel.sched_rt_runtime_us kernel.softlockup_panic kernel.yama.ptrace_scope kernel.kptr_restrict kernel.dmesg_restrict kernel.sysrq fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_background_bytes vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_bytes vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes + "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.neigh.default.gc_thresh1 net.ipv4.neigh.default.gc_thresh2 net.ipv4.neigh.default.gc_thresh3 net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_mtu_probing net.ipv4.tcp_max_orphans net.ipv4.tcp_max_tw_buckets net.ipv4.tcp_syn_retries net.ipv4.tcp_ecn net.ipv4.tcp_congestion_control net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.keys.maxkeys kernel.keys.maxbytes kernel.shmmni kernel.shmmax kernel.shmall kernel.perf_event_paranoid kernel.sched_rt_runtime_us kernel.softlockup_panic kernel.yama.ptrace_scope kernel.kptr_restrict kernel.dmesg_restrict kernel.sysrq fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_background_bytes vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_bytes vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes "a_key": "A String", }, "transparentHugepageDefrag": "A String", # Optional. Defines the transparent hugepage defrag configuration on the node. VM hugepage allocation can be managed by either limiting defragmentation for delayed allocation or skipping it entirely for immediate allocation only. See https://docs.kernel.org/admin-guide/mm/transhuge.html for more details. @@ -2189,6 +2236,8 @@

Method Details

"maxRunDuration": "A String", # The maximum duration for the nodes to exist. If unspecified, the nodes can exist indefinitely. "name": "A String", # The name (project, location, cluster, node pool) of the node pool to update. Specified in the format `projects/*/locations/*/clusters/*/nodePools/*`. "nodeDrainConfig": { # NodeDrainConfig contains the node drain related configurations for this node pool. # The desired node drain configuration for nodes in the node pool. + "graceTerminationDuration": "A String", # The duration of the grace termination period for node drain. + "pdbTimeoutDuration": "A String", # The duration of the PDB timeout period for node drain. "respectPdbDuringNodePoolDeletion": True or False, # Whether to respect PDB during node pool deletion. }, "nodeNetworkConfig": { # Parameters for node pool-level network config. # Node network config. @@ -2211,6 +2260,7 @@

Method Details

], "createPodRange": True or False, # Input only. Whether to create a new range for pod IPs in this node pool. Defaults are provided for `pod_range` and `pod_ipv4_cidr_block` if they are not specified. If neither `create_pod_range` or `pod_range` are specified, the cluster-level default (`ip_allocation_policy.cluster_ipv4_cidr_block`) is used. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created. "enablePrivateNodes": True or False, # Whether nodes have internal IP addresses only. If enable_private_nodes is not specified, then the value is derived from Cluster.NetworkConfig.default_enable_private_nodes + "network": "A String", # Optional. Immutable. The VPC network for the node pool. "networkPerformanceConfig": { # Configuration of all network bandwidth tiers # Network bandwidth tier configuration. "totalEgressBandwidthTier": "A String", # Specifies the total network bandwidth tier for the NodePool. }, diff --git a/docs/dyn/container_v1beta1.projects.locations.clusters.html b/docs/dyn/container_v1beta1.projects.locations.clusters.html index 79b82754e4..dee704cd54 100644 --- a/docs/dyn/container_v1beta1.projects.locations.clusters.html +++ b/docs/dyn/container_v1beta1.projects.locations.clusters.html @@ -817,6 +817,9 @@

Method Details

"network": "A String", # The name of the Google Compute Engine [network](https://cloud.google.com/compute/docs/networks-and-firewalls#networks) to which the cluster is connected. If left unspecified, the `default` network will be used. On output this shows the network ID instead of the name. "networkConfig": { # NetworkConfig reports the relative names of network & subnetwork. # Configuration for cluster networking. "datapathProvider": "A String", # The desired datapath provider for this cluster. By default, uses the IPTables-based kube-proxy implementation. + "dataplaneV2Config": { # DataplaneV2Config is the configuration for DPv2. # Optional. DataplaneV2Config specifies the DPv2 configuration. + "scalabilityMode": "A String", # Optional. Scalability mode for the cluster. + }, "defaultEnablePrivateNodes": True or False, # Controls whether by default nodes have private IP addresses only. It is invalid to specify both PrivateClusterConfig.enablePrivateNodes and this field at the same time. To update the default setting, use ClusterUpdate.desired_default_enable_private_nodes "defaultSnatStatus": { # DefaultSnatStatus contains the desired state of whether default sNAT should be disabled on the cluster. # Whether the cluster disables default in-node sNAT rules. In-node sNAT rules will be disabled when default_snat_status is disabled. When disabled is set to false, default IP masquerade rules will be applied to the nodes to prevent sNAT on cluster internal traffic. "disabled": True or False, # Disables cluster default sNAT rules. @@ -1070,7 +1073,7 @@

Method Details

"swapSizePercent": 42, # Specifies the size of the swap space as a percentage of the ephemeral local SSD capacity. }, }, - "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_mtu_probing net.ipv4.tcp_max_orphans net.ipv4.tcp_max_tw_buckets net.ipv4.tcp_syn_retries net.ipv4.tcp_ecn net.ipv4.tcp_congestion_control net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.shmmni kernel.shmmax kernel.shmall kernel.perf_event_paranoid kernel.sched_rt_runtime_us kernel.softlockup_panic kernel.yama.ptrace_scope kernel.kptr_restrict kernel.dmesg_restrict kernel.sysrq fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_background_bytes vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_bytes vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes + "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.neigh.default.gc_thresh1 net.ipv4.neigh.default.gc_thresh2 net.ipv4.neigh.default.gc_thresh3 net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_mtu_probing net.ipv4.tcp_max_orphans net.ipv4.tcp_max_tw_buckets net.ipv4.tcp_syn_retries net.ipv4.tcp_ecn net.ipv4.tcp_congestion_control net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.keys.maxkeys kernel.keys.maxbytes kernel.shmmni kernel.shmmax kernel.shmall kernel.perf_event_paranoid kernel.sched_rt_runtime_us kernel.softlockup_panic kernel.yama.ptrace_scope kernel.kptr_restrict kernel.dmesg_restrict kernel.sysrq fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_background_bytes vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_bytes vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes "a_key": "A String", }, "transparentHugepageDefrag": "A String", # Optional. Defines the transparent hugepage defrag configuration on the node. VM hugepage allocation can be managed by either limiting defragmentation for delayed allocation or skipping it entirely for immediate allocation only. See https://docs.kernel.org/admin-guide/mm/transhuge.html for more details. @@ -1093,6 +1096,11 @@

Method Details

}, "minCpuPlatform": "A String", # Minimum CPU platform to be used by this instance. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as `minCpuPlatform: "Intel Haswell"` or `minCpuPlatform: "Intel Sandy Bridge"`. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform). "nodeGroup": "A String", # Setting this field will assign instances of this pool to run on the specified node group. This is useful for running workloads on [sole tenant nodes](https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes). + "nodeImageConfig": { # CustomImageConfig contains the information r # The node image configuration to use for this node pool. Note that this is only applicable for node pools using image_type=CUSTOM. + "image": "A String", # The name of the image to use for this node. + "imageFamily": "A String", # The name of the image family to use for this node. + "imageProject": "A String", # The project containing the image to use for this node. + }, "oauthScopes": [ # The set of Google API scopes to be made available on all of the node VMs under the "default" service account. The following scopes are recommended, but not required, and by default are not included: * `https://www.googleapis.com/auth/compute` is required for mounting persistent storage on your nodes. * `https://www.googleapis.com/auth/devstorage.read_only` is required for communicating with **gcr.io** (the [Artifact Registry](https://cloud.google.com/artifact-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added. "A String", ], @@ -1166,6 +1174,9 @@

Method Details

"nodeMetadata": "A String", # NodeMetadata is the configuration for how to expose metadata to the workloads running on the node. }, }, + "nodeCreationConfig": { # NodeCreationConfig defines the settings of node creation mode. # Optional. Configuration for Node Creation Mode. + "nodeCreationMode": "A String", # The mode of node creation. + }, "nodeIpv4CidrSize": 42, # Output only. The size of the address space on each node for hosting containers. This is provisioned from within the `container_ipv4_cidr` range. This field will only be set when cluster is in route-based network mode. "nodePoolAutoConfig": { # node pool configs that apply to all auto-provisioned node pools in autopilot clusters and node auto-provisioning enabled clusters # Node pool configs that apply to all auto-provisioned node pools in autopilot clusters and node auto-provisioning enabled clusters. "linuxNodeConfig": { # Parameters that can be configured on Linux nodes. # Output only. Configuration options for Linux nodes. @@ -1207,7 +1218,7 @@

Method Details

"swapSizePercent": 42, # Specifies the size of the swap space as a percentage of the ephemeral local SSD capacity. }, }, - "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_mtu_probing net.ipv4.tcp_max_orphans net.ipv4.tcp_max_tw_buckets net.ipv4.tcp_syn_retries net.ipv4.tcp_ecn net.ipv4.tcp_congestion_control net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.shmmni kernel.shmmax kernel.shmall kernel.perf_event_paranoid kernel.sched_rt_runtime_us kernel.softlockup_panic kernel.yama.ptrace_scope kernel.kptr_restrict kernel.dmesg_restrict kernel.sysrq fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_background_bytes vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_bytes vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes + "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.neigh.default.gc_thresh1 net.ipv4.neigh.default.gc_thresh2 net.ipv4.neigh.default.gc_thresh3 net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_mtu_probing net.ipv4.tcp_max_orphans net.ipv4.tcp_max_tw_buckets net.ipv4.tcp_syn_retries net.ipv4.tcp_ecn net.ipv4.tcp_congestion_control net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.keys.maxkeys kernel.keys.maxbytes kernel.shmmni kernel.shmmax kernel.shmall kernel.perf_event_paranoid kernel.sched_rt_runtime_us kernel.softlockup_panic kernel.yama.ptrace_scope kernel.kptr_restrict kernel.dmesg_restrict kernel.sysrq fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_background_bytes vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_bytes vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes "a_key": "A String", }, "transparentHugepageDefrag": "A String", # Optional. Defines the transparent hugepage defrag configuration on the node. VM hugepage allocation can be managed by either limiting defragmentation for delayed allocation or skipping it entirely for immediate allocation only. See https://docs.kernel.org/admin-guide/mm/transhuge.html for more details. @@ -1657,7 +1668,7 @@

Method Details

"swapSizePercent": 42, # Specifies the size of the swap space as a percentage of the ephemeral local SSD capacity. }, }, - "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_mtu_probing net.ipv4.tcp_max_orphans net.ipv4.tcp_max_tw_buckets net.ipv4.tcp_syn_retries net.ipv4.tcp_ecn net.ipv4.tcp_congestion_control net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.shmmni kernel.shmmax kernel.shmall kernel.perf_event_paranoid kernel.sched_rt_runtime_us kernel.softlockup_panic kernel.yama.ptrace_scope kernel.kptr_restrict kernel.dmesg_restrict kernel.sysrq fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_background_bytes vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_bytes vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes + "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.neigh.default.gc_thresh1 net.ipv4.neigh.default.gc_thresh2 net.ipv4.neigh.default.gc_thresh3 net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_mtu_probing net.ipv4.tcp_max_orphans net.ipv4.tcp_max_tw_buckets net.ipv4.tcp_syn_retries net.ipv4.tcp_ecn net.ipv4.tcp_congestion_control net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.keys.maxkeys kernel.keys.maxbytes kernel.shmmni kernel.shmmax kernel.shmall kernel.perf_event_paranoid kernel.sched_rt_runtime_us kernel.softlockup_panic kernel.yama.ptrace_scope kernel.kptr_restrict kernel.dmesg_restrict kernel.sysrq fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_background_bytes vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_bytes vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes "a_key": "A String", }, "transparentHugepageDefrag": "A String", # Optional. Defines the transparent hugepage defrag configuration on the node. VM hugepage allocation can be managed by either limiting defragmentation for delayed allocation or skipping it entirely for immediate allocation only. See https://docs.kernel.org/admin-guide/mm/transhuge.html for more details. @@ -1680,6 +1691,11 @@

Method Details

}, "minCpuPlatform": "A String", # Minimum CPU platform to be used by this instance. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as `minCpuPlatform: "Intel Haswell"` or `minCpuPlatform: "Intel Sandy Bridge"`. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform). "nodeGroup": "A String", # Setting this field will assign instances of this pool to run on the specified node group. This is useful for running workloads on [sole tenant nodes](https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes). + "nodeImageConfig": { # CustomImageConfig contains the information r # The node image configuration to use for this node pool. Note that this is only applicable for node pools using image_type=CUSTOM. + "image": "A String", # The name of the image to use for this node. + "imageFamily": "A String", # The name of the image family to use for this node. + "imageProject": "A String", # The project containing the image to use for this node. + }, "oauthScopes": [ # The set of Google API scopes to be made available on all of the node VMs under the "default" service account. The following scopes are recommended, but not required, and by default are not included: * `https://www.googleapis.com/auth/compute` is required for mounting persistent storage on your nodes. * `https://www.googleapis.com/auth/devstorage.read_only` is required for communicating with **gcr.io** (the [Artifact Registry](https://cloud.google.com/artifact-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added. "A String", ], @@ -1761,6 +1777,13 @@

Method Details

"locations": [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the NodePool's nodes should be located. If this value is unspecified during node pool creation, the [Cluster.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters#Cluster.FIELDS.locations) value will be used, instead. Warning: changing node pool locations will result in nodes being added and/or removed. "A String", ], + "maintenancePolicy": { # Defines the maintenance policy for the node pool. # Optional. Specifies the maintenance policy for the node pool. + "exclusionUntilEndOfSupport": { # Defines the maintenance exclusion for the node pool. # Optional. The exclusion until end of support for the node pool. + "enabled": True or False, # Optional. Indicates whether the exclusion is enabled. + "endTime": "A String", # Output only. The end time of the maintenance exclusion. It is output only. It is the cluster control plane version's end of support time, or end of extended support time when the cluster is on extended support channel. + "startTime": "A String", # Output only. The start time of the maintenance exclusion. It is output only. It is the exclusion creation time. + }, + }, "management": { # NodeManagement defines the set of node management services turned on for the node pool. # NodeManagement configuration for this NodePool. "autoRepair": True or False, # Whether the nodes will be automatically repaired. "autoUpgrade": True or False, # Whether the nodes will be automatically upgraded. @@ -1793,6 +1816,7 @@

Method Details

], "createPodRange": True or False, # Input only. Whether to create a new range for pod IPs in this node pool. Defaults are provided for `pod_range` and `pod_ipv4_cidr_block` if they are not specified. If neither `create_pod_range` or `pod_range` are specified, the cluster-level default (`ip_allocation_policy.cluster_ipv4_cidr_block`) is used. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created. "enablePrivateNodes": True or False, # Whether nodes have internal IP addresses only. If enable_private_nodes is not specified, then the value is derived from Cluster.NetworkConfig.default_enable_private_nodes + "network": "A String", # Optional. Immutable. The VPC network for the node pool. "networkPerformanceConfig": { # Configuration of all network bandwidth tiers # Network bandwidth tier configuration. "externalIpEgressBandwidthTier": "A String", # Specifies the network bandwidth tier for the NodePool for traffic to external/public IP addresses. "totalEgressBandwidthTier": "A String", # Specifies the total network bandwidth tier for the NodePool. @@ -1809,6 +1833,8 @@

Method Details

"subnetwork": "A String", # Optional. The subnetwork name/path for the node pool. Format: projects/{project}/regions/{region}/subnetworks/{subnetwork} If the cluster is associated with multiple subnetworks, the subnetwork can be either: - A user supplied subnetwork name during node pool creation (e.g., `my-subnet`). The name must be between 1 and 63 characters long, start with a letter, contain only letters, numbers, and hyphens, and end with a letter or a number. - A full subnetwork path during node pool creation, such as `projects/gke-project/regions/us-central1/subnetworks/my-subnet` - A subnetwork path picked based on the IP utilization during node pool creation and is immutable. }, "nodeDrainConfig": { # NodeDrainConfig contains the node drain related configurations for this node pool. # Specifies the node drain configuration for this node pool. + "graceTerminationDuration": "A String", # The duration of the grace termination period for node drain. + "pdbTimeoutDuration": "A String", # The duration of the PDB timeout period for node drain. "respectPdbDuringNodePoolDeletion": True or False, # Whether to respect PDB during node pool deletion. }, "placementPolicy": { # PlacementPolicy defines the placement policy used by the node pool. # Specifies the node placement policy. @@ -2657,6 +2683,9 @@

Method Details

"network": "A String", # The name of the Google Compute Engine [network](https://cloud.google.com/compute/docs/networks-and-firewalls#networks) to which the cluster is connected. If left unspecified, the `default` network will be used. On output this shows the network ID instead of the name. "networkConfig": { # NetworkConfig reports the relative names of network & subnetwork. # Configuration for cluster networking. "datapathProvider": "A String", # The desired datapath provider for this cluster. By default, uses the IPTables-based kube-proxy implementation. + "dataplaneV2Config": { # DataplaneV2Config is the configuration for DPv2. # Optional. DataplaneV2Config specifies the DPv2 configuration. + "scalabilityMode": "A String", # Optional. Scalability mode for the cluster. + }, "defaultEnablePrivateNodes": True or False, # Controls whether by default nodes have private IP addresses only. It is invalid to specify both PrivateClusterConfig.enablePrivateNodes and this field at the same time. To update the default setting, use ClusterUpdate.desired_default_enable_private_nodes "defaultSnatStatus": { # DefaultSnatStatus contains the desired state of whether default sNAT should be disabled on the cluster. # Whether the cluster disables default in-node sNAT rules. In-node sNAT rules will be disabled when default_snat_status is disabled. When disabled is set to false, default IP masquerade rules will be applied to the nodes to prevent sNAT on cluster internal traffic. "disabled": True or False, # Disables cluster default sNAT rules. @@ -2910,7 +2939,7 @@

Method Details

"swapSizePercent": 42, # Specifies the size of the swap space as a percentage of the ephemeral local SSD capacity. }, }, - "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_mtu_probing net.ipv4.tcp_max_orphans net.ipv4.tcp_max_tw_buckets net.ipv4.tcp_syn_retries net.ipv4.tcp_ecn net.ipv4.tcp_congestion_control net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.shmmni kernel.shmmax kernel.shmall kernel.perf_event_paranoid kernel.sched_rt_runtime_us kernel.softlockup_panic kernel.yama.ptrace_scope kernel.kptr_restrict kernel.dmesg_restrict kernel.sysrq fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_background_bytes vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_bytes vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes + "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.neigh.default.gc_thresh1 net.ipv4.neigh.default.gc_thresh2 net.ipv4.neigh.default.gc_thresh3 net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_mtu_probing net.ipv4.tcp_max_orphans net.ipv4.tcp_max_tw_buckets net.ipv4.tcp_syn_retries net.ipv4.tcp_ecn net.ipv4.tcp_congestion_control net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.keys.maxkeys kernel.keys.maxbytes kernel.shmmni kernel.shmmax kernel.shmall kernel.perf_event_paranoid kernel.sched_rt_runtime_us kernel.softlockup_panic kernel.yama.ptrace_scope kernel.kptr_restrict kernel.dmesg_restrict kernel.sysrq fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_background_bytes vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_bytes vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes "a_key": "A String", }, "transparentHugepageDefrag": "A String", # Optional. Defines the transparent hugepage defrag configuration on the node. VM hugepage allocation can be managed by either limiting defragmentation for delayed allocation or skipping it entirely for immediate allocation only. See https://docs.kernel.org/admin-guide/mm/transhuge.html for more details. @@ -2933,6 +2962,11 @@

Method Details

}, "minCpuPlatform": "A String", # Minimum CPU platform to be used by this instance. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as `minCpuPlatform: "Intel Haswell"` or `minCpuPlatform: "Intel Sandy Bridge"`. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform). "nodeGroup": "A String", # Setting this field will assign instances of this pool to run on the specified node group. This is useful for running workloads on [sole tenant nodes](https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes). + "nodeImageConfig": { # CustomImageConfig contains the information r # The node image configuration to use for this node pool. Note that this is only applicable for node pools using image_type=CUSTOM. + "image": "A String", # The name of the image to use for this node. + "imageFamily": "A String", # The name of the image family to use for this node. + "imageProject": "A String", # The project containing the image to use for this node. + }, "oauthScopes": [ # The set of Google API scopes to be made available on all of the node VMs under the "default" service account. The following scopes are recommended, but not required, and by default are not included: * `https://www.googleapis.com/auth/compute` is required for mounting persistent storage on your nodes. * `https://www.googleapis.com/auth/devstorage.read_only` is required for communicating with **gcr.io** (the [Artifact Registry](https://cloud.google.com/artifact-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added. "A String", ], @@ -3006,6 +3040,9 @@

Method Details

"nodeMetadata": "A String", # NodeMetadata is the configuration for how to expose metadata to the workloads running on the node. }, }, + "nodeCreationConfig": { # NodeCreationConfig defines the settings of node creation mode. # Optional. Configuration for Node Creation Mode. + "nodeCreationMode": "A String", # The mode of node creation. + }, "nodeIpv4CidrSize": 42, # Output only. The size of the address space on each node for hosting containers. This is provisioned from within the `container_ipv4_cidr` range. This field will only be set when cluster is in route-based network mode. "nodePoolAutoConfig": { # node pool configs that apply to all auto-provisioned node pools in autopilot clusters and node auto-provisioning enabled clusters # Node pool configs that apply to all auto-provisioned node pools in autopilot clusters and node auto-provisioning enabled clusters. "linuxNodeConfig": { # Parameters that can be configured on Linux nodes. # Output only. Configuration options for Linux nodes. @@ -3047,7 +3084,7 @@

Method Details

"swapSizePercent": 42, # Specifies the size of the swap space as a percentage of the ephemeral local SSD capacity. }, }, - "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_mtu_probing net.ipv4.tcp_max_orphans net.ipv4.tcp_max_tw_buckets net.ipv4.tcp_syn_retries net.ipv4.tcp_ecn net.ipv4.tcp_congestion_control net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.shmmni kernel.shmmax kernel.shmall kernel.perf_event_paranoid kernel.sched_rt_runtime_us kernel.softlockup_panic kernel.yama.ptrace_scope kernel.kptr_restrict kernel.dmesg_restrict kernel.sysrq fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_background_bytes vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_bytes vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes + "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.neigh.default.gc_thresh1 net.ipv4.neigh.default.gc_thresh2 net.ipv4.neigh.default.gc_thresh3 net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_mtu_probing net.ipv4.tcp_max_orphans net.ipv4.tcp_max_tw_buckets net.ipv4.tcp_syn_retries net.ipv4.tcp_ecn net.ipv4.tcp_congestion_control net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.keys.maxkeys kernel.keys.maxbytes kernel.shmmni kernel.shmmax kernel.shmall kernel.perf_event_paranoid kernel.sched_rt_runtime_us kernel.softlockup_panic kernel.yama.ptrace_scope kernel.kptr_restrict kernel.dmesg_restrict kernel.sysrq fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_background_bytes vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_bytes vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes "a_key": "A String", }, "transparentHugepageDefrag": "A String", # Optional. Defines the transparent hugepage defrag configuration on the node. VM hugepage allocation can be managed by either limiting defragmentation for delayed allocation or skipping it entirely for immediate allocation only. See https://docs.kernel.org/admin-guide/mm/transhuge.html for more details. @@ -3497,7 +3534,7 @@

Method Details

"swapSizePercent": 42, # Specifies the size of the swap space as a percentage of the ephemeral local SSD capacity. }, }, - "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_mtu_probing net.ipv4.tcp_max_orphans net.ipv4.tcp_max_tw_buckets net.ipv4.tcp_syn_retries net.ipv4.tcp_ecn net.ipv4.tcp_congestion_control net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.shmmni kernel.shmmax kernel.shmall kernel.perf_event_paranoid kernel.sched_rt_runtime_us kernel.softlockup_panic kernel.yama.ptrace_scope kernel.kptr_restrict kernel.dmesg_restrict kernel.sysrq fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_background_bytes vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_bytes vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes + "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.neigh.default.gc_thresh1 net.ipv4.neigh.default.gc_thresh2 net.ipv4.neigh.default.gc_thresh3 net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_mtu_probing net.ipv4.tcp_max_orphans net.ipv4.tcp_max_tw_buckets net.ipv4.tcp_syn_retries net.ipv4.tcp_ecn net.ipv4.tcp_congestion_control net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.keys.maxkeys kernel.keys.maxbytes kernel.shmmni kernel.shmmax kernel.shmall kernel.perf_event_paranoid kernel.sched_rt_runtime_us kernel.softlockup_panic kernel.yama.ptrace_scope kernel.kptr_restrict kernel.dmesg_restrict kernel.sysrq fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_background_bytes vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_bytes vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes "a_key": "A String", }, "transparentHugepageDefrag": "A String", # Optional. Defines the transparent hugepage defrag configuration on the node. VM hugepage allocation can be managed by either limiting defragmentation for delayed allocation or skipping it entirely for immediate allocation only. See https://docs.kernel.org/admin-guide/mm/transhuge.html for more details. @@ -3520,6 +3557,11 @@

Method Details

}, "minCpuPlatform": "A String", # Minimum CPU platform to be used by this instance. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as `minCpuPlatform: "Intel Haswell"` or `minCpuPlatform: "Intel Sandy Bridge"`. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform). "nodeGroup": "A String", # Setting this field will assign instances of this pool to run on the specified node group. This is useful for running workloads on [sole tenant nodes](https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes). + "nodeImageConfig": { # CustomImageConfig contains the information r # The node image configuration to use for this node pool. Note that this is only applicable for node pools using image_type=CUSTOM. + "image": "A String", # The name of the image to use for this node. + "imageFamily": "A String", # The name of the image family to use for this node. + "imageProject": "A String", # The project containing the image to use for this node. + }, "oauthScopes": [ # The set of Google API scopes to be made available on all of the node VMs under the "default" service account. The following scopes are recommended, but not required, and by default are not included: * `https://www.googleapis.com/auth/compute` is required for mounting persistent storage on your nodes. * `https://www.googleapis.com/auth/devstorage.read_only` is required for communicating with **gcr.io** (the [Artifact Registry](https://cloud.google.com/artifact-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added. "A String", ], @@ -3601,6 +3643,13 @@

Method Details

"locations": [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the NodePool's nodes should be located. If this value is unspecified during node pool creation, the [Cluster.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters#Cluster.FIELDS.locations) value will be used, instead. Warning: changing node pool locations will result in nodes being added and/or removed. "A String", ], + "maintenancePolicy": { # Defines the maintenance policy for the node pool. # Optional. Specifies the maintenance policy for the node pool. + "exclusionUntilEndOfSupport": { # Defines the maintenance exclusion for the node pool. # Optional. The exclusion until end of support for the node pool. + "enabled": True or False, # Optional. Indicates whether the exclusion is enabled. + "endTime": "A String", # Output only. The end time of the maintenance exclusion. It is output only. It is the cluster control plane version's end of support time, or end of extended support time when the cluster is on extended support channel. + "startTime": "A String", # Output only. The start time of the maintenance exclusion. It is output only. It is the exclusion creation time. + }, + }, "management": { # NodeManagement defines the set of node management services turned on for the node pool. # NodeManagement configuration for this NodePool. "autoRepair": True or False, # Whether the nodes will be automatically repaired. "autoUpgrade": True or False, # Whether the nodes will be automatically upgraded. @@ -3633,6 +3682,7 @@

Method Details

], "createPodRange": True or False, # Input only. Whether to create a new range for pod IPs in this node pool. Defaults are provided for `pod_range` and `pod_ipv4_cidr_block` if they are not specified. If neither `create_pod_range` or `pod_range` are specified, the cluster-level default (`ip_allocation_policy.cluster_ipv4_cidr_block`) is used. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created. "enablePrivateNodes": True or False, # Whether nodes have internal IP addresses only. If enable_private_nodes is not specified, then the value is derived from Cluster.NetworkConfig.default_enable_private_nodes + "network": "A String", # Optional. Immutable. The VPC network for the node pool. "networkPerformanceConfig": { # Configuration of all network bandwidth tiers # Network bandwidth tier configuration. "externalIpEgressBandwidthTier": "A String", # Specifies the network bandwidth tier for the NodePool for traffic to external/public IP addresses. "totalEgressBandwidthTier": "A String", # Specifies the total network bandwidth tier for the NodePool. @@ -3649,6 +3699,8 @@

Method Details

"subnetwork": "A String", # Optional. The subnetwork name/path for the node pool. Format: projects/{project}/regions/{region}/subnetworks/{subnetwork} If the cluster is associated with multiple subnetworks, the subnetwork can be either: - A user supplied subnetwork name during node pool creation (e.g., `my-subnet`). The name must be between 1 and 63 characters long, start with a letter, contain only letters, numbers, and hyphens, and end with a letter or a number. - A full subnetwork path during node pool creation, such as `projects/gke-project/regions/us-central1/subnetworks/my-subnet` - A subnetwork path picked based on the IP utilization during node pool creation and is immutable. }, "nodeDrainConfig": { # NodeDrainConfig contains the node drain related configurations for this node pool. # Specifies the node drain configuration for this node pool. + "graceTerminationDuration": "A String", # The duration of the grace termination period for node drain. + "pdbTimeoutDuration": "A String", # The duration of the PDB timeout period for node drain. "respectPdbDuringNodePoolDeletion": True or False, # Whether to respect PDB during node pool deletion. }, "placementPolicy": { # PlacementPolicy defines the placement policy used by the node pool. # Specifies the node placement policy. @@ -4354,6 +4406,9 @@

Method Details

"network": "A String", # The name of the Google Compute Engine [network](https://cloud.google.com/compute/docs/networks-and-firewalls#networks) to which the cluster is connected. If left unspecified, the `default` network will be used. On output this shows the network ID instead of the name. "networkConfig": { # NetworkConfig reports the relative names of network & subnetwork. # Configuration for cluster networking. "datapathProvider": "A String", # The desired datapath provider for this cluster. By default, uses the IPTables-based kube-proxy implementation. + "dataplaneV2Config": { # DataplaneV2Config is the configuration for DPv2. # Optional. DataplaneV2Config specifies the DPv2 configuration. + "scalabilityMode": "A String", # Optional. Scalability mode for the cluster. + }, "defaultEnablePrivateNodes": True or False, # Controls whether by default nodes have private IP addresses only. It is invalid to specify both PrivateClusterConfig.enablePrivateNodes and this field at the same time. To update the default setting, use ClusterUpdate.desired_default_enable_private_nodes "defaultSnatStatus": { # DefaultSnatStatus contains the desired state of whether default sNAT should be disabled on the cluster. # Whether the cluster disables default in-node sNAT rules. In-node sNAT rules will be disabled when default_snat_status is disabled. When disabled is set to false, default IP masquerade rules will be applied to the nodes to prevent sNAT on cluster internal traffic. "disabled": True or False, # Disables cluster default sNAT rules. @@ -4607,7 +4662,7 @@

Method Details

"swapSizePercent": 42, # Specifies the size of the swap space as a percentage of the ephemeral local SSD capacity. }, }, - "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_mtu_probing net.ipv4.tcp_max_orphans net.ipv4.tcp_max_tw_buckets net.ipv4.tcp_syn_retries net.ipv4.tcp_ecn net.ipv4.tcp_congestion_control net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.shmmni kernel.shmmax kernel.shmall kernel.perf_event_paranoid kernel.sched_rt_runtime_us kernel.softlockup_panic kernel.yama.ptrace_scope kernel.kptr_restrict kernel.dmesg_restrict kernel.sysrq fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_background_bytes vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_bytes vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes + "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.neigh.default.gc_thresh1 net.ipv4.neigh.default.gc_thresh2 net.ipv4.neigh.default.gc_thresh3 net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_mtu_probing net.ipv4.tcp_max_orphans net.ipv4.tcp_max_tw_buckets net.ipv4.tcp_syn_retries net.ipv4.tcp_ecn net.ipv4.tcp_congestion_control net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.keys.maxkeys kernel.keys.maxbytes kernel.shmmni kernel.shmmax kernel.shmall kernel.perf_event_paranoid kernel.sched_rt_runtime_us kernel.softlockup_panic kernel.yama.ptrace_scope kernel.kptr_restrict kernel.dmesg_restrict kernel.sysrq fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_background_bytes vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_bytes vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes "a_key": "A String", }, "transparentHugepageDefrag": "A String", # Optional. Defines the transparent hugepage defrag configuration on the node. VM hugepage allocation can be managed by either limiting defragmentation for delayed allocation or skipping it entirely for immediate allocation only. See https://docs.kernel.org/admin-guide/mm/transhuge.html for more details. @@ -4630,6 +4685,11 @@

Method Details

}, "minCpuPlatform": "A String", # Minimum CPU platform to be used by this instance. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as `minCpuPlatform: "Intel Haswell"` or `minCpuPlatform: "Intel Sandy Bridge"`. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform). "nodeGroup": "A String", # Setting this field will assign instances of this pool to run on the specified node group. This is useful for running workloads on [sole tenant nodes](https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes). + "nodeImageConfig": { # CustomImageConfig contains the information r # The node image configuration to use for this node pool. Note that this is only applicable for node pools using image_type=CUSTOM. + "image": "A String", # The name of the image to use for this node. + "imageFamily": "A String", # The name of the image family to use for this node. + "imageProject": "A String", # The project containing the image to use for this node. + }, "oauthScopes": [ # The set of Google API scopes to be made available on all of the node VMs under the "default" service account. The following scopes are recommended, but not required, and by default are not included: * `https://www.googleapis.com/auth/compute` is required for mounting persistent storage on your nodes. * `https://www.googleapis.com/auth/devstorage.read_only` is required for communicating with **gcr.io** (the [Artifact Registry](https://cloud.google.com/artifact-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added. "A String", ], @@ -4703,6 +4763,9 @@

Method Details

"nodeMetadata": "A String", # NodeMetadata is the configuration for how to expose metadata to the workloads running on the node. }, }, + "nodeCreationConfig": { # NodeCreationConfig defines the settings of node creation mode. # Optional. Configuration for Node Creation Mode. + "nodeCreationMode": "A String", # The mode of node creation. + }, "nodeIpv4CidrSize": 42, # Output only. The size of the address space on each node for hosting containers. This is provisioned from within the `container_ipv4_cidr` range. This field will only be set when cluster is in route-based network mode. "nodePoolAutoConfig": { # node pool configs that apply to all auto-provisioned node pools in autopilot clusters and node auto-provisioning enabled clusters # Node pool configs that apply to all auto-provisioned node pools in autopilot clusters and node auto-provisioning enabled clusters. "linuxNodeConfig": { # Parameters that can be configured on Linux nodes. # Output only. Configuration options for Linux nodes. @@ -4744,7 +4807,7 @@

Method Details

"swapSizePercent": 42, # Specifies the size of the swap space as a percentage of the ephemeral local SSD capacity. }, }, - "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_mtu_probing net.ipv4.tcp_max_orphans net.ipv4.tcp_max_tw_buckets net.ipv4.tcp_syn_retries net.ipv4.tcp_ecn net.ipv4.tcp_congestion_control net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.shmmni kernel.shmmax kernel.shmall kernel.perf_event_paranoid kernel.sched_rt_runtime_us kernel.softlockup_panic kernel.yama.ptrace_scope kernel.kptr_restrict kernel.dmesg_restrict kernel.sysrq fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_background_bytes vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_bytes vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes + "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.neigh.default.gc_thresh1 net.ipv4.neigh.default.gc_thresh2 net.ipv4.neigh.default.gc_thresh3 net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_mtu_probing net.ipv4.tcp_max_orphans net.ipv4.tcp_max_tw_buckets net.ipv4.tcp_syn_retries net.ipv4.tcp_ecn net.ipv4.tcp_congestion_control net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.keys.maxkeys kernel.keys.maxbytes kernel.shmmni kernel.shmmax kernel.shmall kernel.perf_event_paranoid kernel.sched_rt_runtime_us kernel.softlockup_panic kernel.yama.ptrace_scope kernel.kptr_restrict kernel.dmesg_restrict kernel.sysrq fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_background_bytes vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_bytes vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes "a_key": "A String", }, "transparentHugepageDefrag": "A String", # Optional. Defines the transparent hugepage defrag configuration on the node. VM hugepage allocation can be managed by either limiting defragmentation for delayed allocation or skipping it entirely for immediate allocation only. See https://docs.kernel.org/admin-guide/mm/transhuge.html for more details. @@ -5194,7 +5257,7 @@

Method Details

"swapSizePercent": 42, # Specifies the size of the swap space as a percentage of the ephemeral local SSD capacity. }, }, - "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_mtu_probing net.ipv4.tcp_max_orphans net.ipv4.tcp_max_tw_buckets net.ipv4.tcp_syn_retries net.ipv4.tcp_ecn net.ipv4.tcp_congestion_control net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.shmmni kernel.shmmax kernel.shmall kernel.perf_event_paranoid kernel.sched_rt_runtime_us kernel.softlockup_panic kernel.yama.ptrace_scope kernel.kptr_restrict kernel.dmesg_restrict kernel.sysrq fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_background_bytes vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_bytes vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes + "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.neigh.default.gc_thresh1 net.ipv4.neigh.default.gc_thresh2 net.ipv4.neigh.default.gc_thresh3 net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_mtu_probing net.ipv4.tcp_max_orphans net.ipv4.tcp_max_tw_buckets net.ipv4.tcp_syn_retries net.ipv4.tcp_ecn net.ipv4.tcp_congestion_control net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.keys.maxkeys kernel.keys.maxbytes kernel.shmmni kernel.shmmax kernel.shmall kernel.perf_event_paranoid kernel.sched_rt_runtime_us kernel.softlockup_panic kernel.yama.ptrace_scope kernel.kptr_restrict kernel.dmesg_restrict kernel.sysrq fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_background_bytes vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_bytes vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes "a_key": "A String", }, "transparentHugepageDefrag": "A String", # Optional. Defines the transparent hugepage defrag configuration on the node. VM hugepage allocation can be managed by either limiting defragmentation for delayed allocation or skipping it entirely for immediate allocation only. See https://docs.kernel.org/admin-guide/mm/transhuge.html for more details. @@ -5217,6 +5280,11 @@

Method Details

}, "minCpuPlatform": "A String", # Minimum CPU platform to be used by this instance. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as `minCpuPlatform: "Intel Haswell"` or `minCpuPlatform: "Intel Sandy Bridge"`. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform). "nodeGroup": "A String", # Setting this field will assign instances of this pool to run on the specified node group. This is useful for running workloads on [sole tenant nodes](https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes). + "nodeImageConfig": { # CustomImageConfig contains the information r # The node image configuration to use for this node pool. Note that this is only applicable for node pools using image_type=CUSTOM. + "image": "A String", # The name of the image to use for this node. + "imageFamily": "A String", # The name of the image family to use for this node. + "imageProject": "A String", # The project containing the image to use for this node. + }, "oauthScopes": [ # The set of Google API scopes to be made available on all of the node VMs under the "default" service account. The following scopes are recommended, but not required, and by default are not included: * `https://www.googleapis.com/auth/compute` is required for mounting persistent storage on your nodes. * `https://www.googleapis.com/auth/devstorage.read_only` is required for communicating with **gcr.io** (the [Artifact Registry](https://cloud.google.com/artifact-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added. "A String", ], @@ -5298,6 +5366,13 @@

Method Details

"locations": [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the NodePool's nodes should be located. If this value is unspecified during node pool creation, the [Cluster.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters#Cluster.FIELDS.locations) value will be used, instead. Warning: changing node pool locations will result in nodes being added and/or removed. "A String", ], + "maintenancePolicy": { # Defines the maintenance policy for the node pool. # Optional. Specifies the maintenance policy for the node pool. + "exclusionUntilEndOfSupport": { # Defines the maintenance exclusion for the node pool. # Optional. The exclusion until end of support for the node pool. + "enabled": True or False, # Optional. Indicates whether the exclusion is enabled. + "endTime": "A String", # Output only. The end time of the maintenance exclusion. It is output only. It is the cluster control plane version's end of support time, or end of extended support time when the cluster is on extended support channel. + "startTime": "A String", # Output only. The start time of the maintenance exclusion. It is output only. It is the exclusion creation time. + }, + }, "management": { # NodeManagement defines the set of node management services turned on for the node pool. # NodeManagement configuration for this NodePool. "autoRepair": True or False, # Whether the nodes will be automatically repaired. "autoUpgrade": True or False, # Whether the nodes will be automatically upgraded. @@ -5330,6 +5405,7 @@

Method Details

], "createPodRange": True or False, # Input only. Whether to create a new range for pod IPs in this node pool. Defaults are provided for `pod_range` and `pod_ipv4_cidr_block` if they are not specified. If neither `create_pod_range` or `pod_range` are specified, the cluster-level default (`ip_allocation_policy.cluster_ipv4_cidr_block`) is used. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created. "enablePrivateNodes": True or False, # Whether nodes have internal IP addresses only. If enable_private_nodes is not specified, then the value is derived from Cluster.NetworkConfig.default_enable_private_nodes + "network": "A String", # Optional. Immutable. The VPC network for the node pool. "networkPerformanceConfig": { # Configuration of all network bandwidth tiers # Network bandwidth tier configuration. "externalIpEgressBandwidthTier": "A String", # Specifies the network bandwidth tier for the NodePool for traffic to external/public IP addresses. "totalEgressBandwidthTier": "A String", # Specifies the total network bandwidth tier for the NodePool. @@ -5346,6 +5422,8 @@

Method Details

"subnetwork": "A String", # Optional. The subnetwork name/path for the node pool. Format: projects/{project}/regions/{region}/subnetworks/{subnetwork} If the cluster is associated with multiple subnetworks, the subnetwork can be either: - A user supplied subnetwork name during node pool creation (e.g., `my-subnet`). The name must be between 1 and 63 characters long, start with a letter, contain only letters, numbers, and hyphens, and end with a letter or a number. - A full subnetwork path during node pool creation, such as `projects/gke-project/regions/us-central1/subnetworks/my-subnet` - A subnetwork path picked based on the IP utilization during node pool creation and is immutable. }, "nodeDrainConfig": { # NodeDrainConfig contains the node drain related configurations for this node pool. # Specifies the node drain configuration for this node pool. + "graceTerminationDuration": "A String", # The duration of the grace termination period for node drain. + "pdbTimeoutDuration": "A String", # The duration of the PDB timeout period for node drain. "respectPdbDuringNodePoolDeletion": True or False, # Whether to respect PDB during node pool deletion. }, "placementPolicy": { # PlacementPolicy defines the placement policy used by the node pool. # Specifies the node placement policy. @@ -6822,6 +6900,8 @@

Method Details

"desiredIdentityServiceConfig": { # IdentityServiceConfig is configuration for Identity Service which allows customers to use external identity providers with the K8S API # The desired Identity Service component configuration. "enabled": True or False, # Whether to enable the Identity Service component }, + "desiredImage": "A String", # The desired name of the image to use for this node. This is used to create clusters using a custom image. + "desiredImageProject": "A String", # The project containing the desired image to use for this node. This is used to create clusters using a custom image. "desiredImageType": "A String", # The desired image type for the node pool. NOTE: Set the "desired_node_pool" field as well. "desiredInTransitEncryptionConfig": "A String", # Specify the details of in-transit encryption. Now named inter-node transparent encryption. "desiredIntraNodeVisibilityConfig": { # IntraNodeVisibilityConfig contains the desired config of the intra-node visibility on this cluster. # The desired config of Intra-node visibility. @@ -6898,6 +6978,9 @@

Method Details

"desiredNetworkTierConfig": { # NetworkTierConfig contains network tier information. # The desired network tier configuration for the cluster. "networkTier": "A String", # Network tier configuration. }, + "desiredNodeCreationConfig": { # NodeCreationConfig defines the settings of node creation mode. # Optional. The desired NodeCreationConfig for the cluster. + "nodeCreationMode": "A String", # The mode of node creation. + }, "desiredNodeKubeletConfig": { # Node kubelet configs. # The desired node kubelet config for the cluster. "allowedUnsafeSysctls": [ # Optional. Defines a comma-separated allowlist of unsafe sysctls or sysctl patterns (ending in `*`). The unsafe namespaced sysctl groups are `kernel.shm*`, `kernel.msg*`, `kernel.sem`, `fs.mqueue.*`, and `net.*`. Leaving this allowlist empty means they cannot be set on Pods. To allow certain sysctls or sysctl patterns to be set on Pods, list them separated by commas. For example: `kernel.msg*,net.ipv4.route.min_pmtu`. See https://kubernetes.io/docs/tasks/administer-cluster/sysctl-cluster/ for more details. "A String", @@ -7047,7 +7130,7 @@

Method Details

"swapSizePercent": 42, # Specifies the size of the swap space as a percentage of the ephemeral local SSD capacity. }, }, - "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_mtu_probing net.ipv4.tcp_max_orphans net.ipv4.tcp_max_tw_buckets net.ipv4.tcp_syn_retries net.ipv4.tcp_ecn net.ipv4.tcp_congestion_control net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.shmmni kernel.shmmax kernel.shmall kernel.perf_event_paranoid kernel.sched_rt_runtime_us kernel.softlockup_panic kernel.yama.ptrace_scope kernel.kptr_restrict kernel.dmesg_restrict kernel.sysrq fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_background_bytes vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_bytes vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes + "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.neigh.default.gc_thresh1 net.ipv4.neigh.default.gc_thresh2 net.ipv4.neigh.default.gc_thresh3 net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_mtu_probing net.ipv4.tcp_max_orphans net.ipv4.tcp_max_tw_buckets net.ipv4.tcp_syn_retries net.ipv4.tcp_ecn net.ipv4.tcp_congestion_control net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.keys.maxkeys kernel.keys.maxbytes kernel.shmmni kernel.shmmax kernel.shmall kernel.perf_event_paranoid kernel.sched_rt_runtime_us kernel.softlockup_panic kernel.yama.ptrace_scope kernel.kptr_restrict kernel.dmesg_restrict kernel.sysrq fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_background_bytes vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_bytes vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes "a_key": "A String", }, "transparentHugepageDefrag": "A String", # Optional. Defines the transparent hugepage defrag configuration on the node. VM hugepage allocation can be managed by either limiting defragmentation for delayed allocation or skipping it entirely for immediate allocation only. See https://docs.kernel.org/admin-guide/mm/transhuge.html for more details. diff --git a/docs/dyn/container_v1beta1.projects.locations.clusters.nodePools.html b/docs/dyn/container_v1beta1.projects.locations.clusters.nodePools.html index 0c776b7bd8..e18adb2f3f 100644 --- a/docs/dyn/container_v1beta1.projects.locations.clusters.nodePools.html +++ b/docs/dyn/container_v1beta1.projects.locations.clusters.nodePools.html @@ -394,7 +394,7 @@

Method Details

"swapSizePercent": 42, # Specifies the size of the swap space as a percentage of the ephemeral local SSD capacity. }, }, - "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_mtu_probing net.ipv4.tcp_max_orphans net.ipv4.tcp_max_tw_buckets net.ipv4.tcp_syn_retries net.ipv4.tcp_ecn net.ipv4.tcp_congestion_control net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.shmmni kernel.shmmax kernel.shmall kernel.perf_event_paranoid kernel.sched_rt_runtime_us kernel.softlockup_panic kernel.yama.ptrace_scope kernel.kptr_restrict kernel.dmesg_restrict kernel.sysrq fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_background_bytes vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_bytes vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes + "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.neigh.default.gc_thresh1 net.ipv4.neigh.default.gc_thresh2 net.ipv4.neigh.default.gc_thresh3 net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_mtu_probing net.ipv4.tcp_max_orphans net.ipv4.tcp_max_tw_buckets net.ipv4.tcp_syn_retries net.ipv4.tcp_ecn net.ipv4.tcp_congestion_control net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.keys.maxkeys kernel.keys.maxbytes kernel.shmmni kernel.shmmax kernel.shmall kernel.perf_event_paranoid kernel.sched_rt_runtime_us kernel.softlockup_panic kernel.yama.ptrace_scope kernel.kptr_restrict kernel.dmesg_restrict kernel.sysrq fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_background_bytes vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_bytes vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes "a_key": "A String", }, "transparentHugepageDefrag": "A String", # Optional. Defines the transparent hugepage defrag configuration on the node. VM hugepage allocation can be managed by either limiting defragmentation for delayed allocation or skipping it entirely for immediate allocation only. See https://docs.kernel.org/admin-guide/mm/transhuge.html for more details. @@ -417,6 +417,11 @@

Method Details

}, "minCpuPlatform": "A String", # Minimum CPU platform to be used by this instance. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as `minCpuPlatform: "Intel Haswell"` or `minCpuPlatform: "Intel Sandy Bridge"`. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform). "nodeGroup": "A String", # Setting this field will assign instances of this pool to run on the specified node group. This is useful for running workloads on [sole tenant nodes](https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes). + "nodeImageConfig": { # CustomImageConfig contains the information r # The node image configuration to use for this node pool. Note that this is only applicable for node pools using image_type=CUSTOM. + "image": "A String", # The name of the image to use for this node. + "imageFamily": "A String", # The name of the image family to use for this node. + "imageProject": "A String", # The project containing the image to use for this node. + }, "oauthScopes": [ # The set of Google API scopes to be made available on all of the node VMs under the "default" service account. The following scopes are recommended, but not required, and by default are not included: * `https://www.googleapis.com/auth/compute` is required for mounting persistent storage on your nodes. * `https://www.googleapis.com/auth/devstorage.read_only` is required for communicating with **gcr.io** (the [Artifact Registry](https://cloud.google.com/artifact-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added. "A String", ], @@ -498,6 +503,13 @@

Method Details

"locations": [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the NodePool's nodes should be located. If this value is unspecified during node pool creation, the [Cluster.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters#Cluster.FIELDS.locations) value will be used, instead. Warning: changing node pool locations will result in nodes being added and/or removed. "A String", ], + "maintenancePolicy": { # Defines the maintenance policy for the node pool. # Optional. Specifies the maintenance policy for the node pool. + "exclusionUntilEndOfSupport": { # Defines the maintenance exclusion for the node pool. # Optional. The exclusion until end of support for the node pool. + "enabled": True or False, # Optional. Indicates whether the exclusion is enabled. + "endTime": "A String", # Output only. The end time of the maintenance exclusion. It is output only. It is the cluster control plane version's end of support time, or end of extended support time when the cluster is on extended support channel. + "startTime": "A String", # Output only. The start time of the maintenance exclusion. It is output only. It is the exclusion creation time. + }, + }, "management": { # NodeManagement defines the set of node management services turned on for the node pool. # NodeManagement configuration for this NodePool. "autoRepair": True or False, # Whether the nodes will be automatically repaired. "autoUpgrade": True or False, # Whether the nodes will be automatically upgraded. @@ -530,6 +542,7 @@

Method Details

], "createPodRange": True or False, # Input only. Whether to create a new range for pod IPs in this node pool. Defaults are provided for `pod_range` and `pod_ipv4_cidr_block` if they are not specified. If neither `create_pod_range` or `pod_range` are specified, the cluster-level default (`ip_allocation_policy.cluster_ipv4_cidr_block`) is used. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created. "enablePrivateNodes": True or False, # Whether nodes have internal IP addresses only. If enable_private_nodes is not specified, then the value is derived from Cluster.NetworkConfig.default_enable_private_nodes + "network": "A String", # Optional. Immutable. The VPC network for the node pool. "networkPerformanceConfig": { # Configuration of all network bandwidth tiers # Network bandwidth tier configuration. "externalIpEgressBandwidthTier": "A String", # Specifies the network bandwidth tier for the NodePool for traffic to external/public IP addresses. "totalEgressBandwidthTier": "A String", # Specifies the total network bandwidth tier for the NodePool. @@ -546,6 +559,8 @@

Method Details

"subnetwork": "A String", # Optional. The subnetwork name/path for the node pool. Format: projects/{project}/regions/{region}/subnetworks/{subnetwork} If the cluster is associated with multiple subnetworks, the subnetwork can be either: - A user supplied subnetwork name during node pool creation (e.g., `my-subnet`). The name must be between 1 and 63 characters long, start with a letter, contain only letters, numbers, and hyphens, and end with a letter or a number. - A full subnetwork path during node pool creation, such as `projects/gke-project/regions/us-central1/subnetworks/my-subnet` - A subnetwork path picked based on the IP utilization during node pool creation and is immutable. }, "nodeDrainConfig": { # NodeDrainConfig contains the node drain related configurations for this node pool. # Specifies the node drain configuration for this node pool. + "graceTerminationDuration": "A String", # The duration of the grace termination period for node drain. + "pdbTimeoutDuration": "A String", # The duration of the PDB timeout period for node drain. "respectPdbDuringNodePoolDeletion": True or False, # Whether to respect PDB during node pool deletion. }, "placementPolicy": { # PlacementPolicy defines the placement policy used by the node pool. # Specifies the node placement policy. @@ -1030,7 +1045,7 @@

Method Details

"swapSizePercent": 42, # Specifies the size of the swap space as a percentage of the ephemeral local SSD capacity. }, }, - "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_mtu_probing net.ipv4.tcp_max_orphans net.ipv4.tcp_max_tw_buckets net.ipv4.tcp_syn_retries net.ipv4.tcp_ecn net.ipv4.tcp_congestion_control net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.shmmni kernel.shmmax kernel.shmall kernel.perf_event_paranoid kernel.sched_rt_runtime_us kernel.softlockup_panic kernel.yama.ptrace_scope kernel.kptr_restrict kernel.dmesg_restrict kernel.sysrq fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_background_bytes vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_bytes vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes + "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.neigh.default.gc_thresh1 net.ipv4.neigh.default.gc_thresh2 net.ipv4.neigh.default.gc_thresh3 net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_mtu_probing net.ipv4.tcp_max_orphans net.ipv4.tcp_max_tw_buckets net.ipv4.tcp_syn_retries net.ipv4.tcp_ecn net.ipv4.tcp_congestion_control net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.keys.maxkeys kernel.keys.maxbytes kernel.shmmni kernel.shmmax kernel.shmall kernel.perf_event_paranoid kernel.sched_rt_runtime_us kernel.softlockup_panic kernel.yama.ptrace_scope kernel.kptr_restrict kernel.dmesg_restrict kernel.sysrq fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_background_bytes vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_bytes vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes "a_key": "A String", }, "transparentHugepageDefrag": "A String", # Optional. Defines the transparent hugepage defrag configuration on the node. VM hugepage allocation can be managed by either limiting defragmentation for delayed allocation or skipping it entirely for immediate allocation only. See https://docs.kernel.org/admin-guide/mm/transhuge.html for more details. @@ -1053,6 +1068,11 @@

Method Details

}, "minCpuPlatform": "A String", # Minimum CPU platform to be used by this instance. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as `minCpuPlatform: "Intel Haswell"` or `minCpuPlatform: "Intel Sandy Bridge"`. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform). "nodeGroup": "A String", # Setting this field will assign instances of this pool to run on the specified node group. This is useful for running workloads on [sole tenant nodes](https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes). + "nodeImageConfig": { # CustomImageConfig contains the information r # The node image configuration to use for this node pool. Note that this is only applicable for node pools using image_type=CUSTOM. + "image": "A String", # The name of the image to use for this node. + "imageFamily": "A String", # The name of the image family to use for this node. + "imageProject": "A String", # The project containing the image to use for this node. + }, "oauthScopes": [ # The set of Google API scopes to be made available on all of the node VMs under the "default" service account. The following scopes are recommended, but not required, and by default are not included: * `https://www.googleapis.com/auth/compute` is required for mounting persistent storage on your nodes. * `https://www.googleapis.com/auth/devstorage.read_only` is required for communicating with **gcr.io** (the [Artifact Registry](https://cloud.google.com/artifact-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added. "A String", ], @@ -1134,6 +1154,13 @@

Method Details

"locations": [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the NodePool's nodes should be located. If this value is unspecified during node pool creation, the [Cluster.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters#Cluster.FIELDS.locations) value will be used, instead. Warning: changing node pool locations will result in nodes being added and/or removed. "A String", ], + "maintenancePolicy": { # Defines the maintenance policy for the node pool. # Optional. Specifies the maintenance policy for the node pool. + "exclusionUntilEndOfSupport": { # Defines the maintenance exclusion for the node pool. # Optional. The exclusion until end of support for the node pool. + "enabled": True or False, # Optional. Indicates whether the exclusion is enabled. + "endTime": "A String", # Output only. The end time of the maintenance exclusion. It is output only. It is the cluster control plane version's end of support time, or end of extended support time when the cluster is on extended support channel. + "startTime": "A String", # Output only. The start time of the maintenance exclusion. It is output only. It is the exclusion creation time. + }, + }, "management": { # NodeManagement defines the set of node management services turned on for the node pool. # NodeManagement configuration for this NodePool. "autoRepair": True or False, # Whether the nodes will be automatically repaired. "autoUpgrade": True or False, # Whether the nodes will be automatically upgraded. @@ -1166,6 +1193,7 @@

Method Details

], "createPodRange": True or False, # Input only. Whether to create a new range for pod IPs in this node pool. Defaults are provided for `pod_range` and `pod_ipv4_cidr_block` if they are not specified. If neither `create_pod_range` or `pod_range` are specified, the cluster-level default (`ip_allocation_policy.cluster_ipv4_cidr_block`) is used. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created. "enablePrivateNodes": True or False, # Whether nodes have internal IP addresses only. If enable_private_nodes is not specified, then the value is derived from Cluster.NetworkConfig.default_enable_private_nodes + "network": "A String", # Optional. Immutable. The VPC network for the node pool. "networkPerformanceConfig": { # Configuration of all network bandwidth tiers # Network bandwidth tier configuration. "externalIpEgressBandwidthTier": "A String", # Specifies the network bandwidth tier for the NodePool for traffic to external/public IP addresses. "totalEgressBandwidthTier": "A String", # Specifies the total network bandwidth tier for the NodePool. @@ -1182,6 +1210,8 @@

Method Details

"subnetwork": "A String", # Optional. The subnetwork name/path for the node pool. Format: projects/{project}/regions/{region}/subnetworks/{subnetwork} If the cluster is associated with multiple subnetworks, the subnetwork can be either: - A user supplied subnetwork name during node pool creation (e.g., `my-subnet`). The name must be between 1 and 63 characters long, start with a letter, contain only letters, numbers, and hyphens, and end with a letter or a number. - A full subnetwork path during node pool creation, such as `projects/gke-project/regions/us-central1/subnetworks/my-subnet` - A subnetwork path picked based on the IP utilization during node pool creation and is immutable. }, "nodeDrainConfig": { # NodeDrainConfig contains the node drain related configurations for this node pool. # Specifies the node drain configuration for this node pool. + "graceTerminationDuration": "A String", # The duration of the grace termination period for node drain. + "pdbTimeoutDuration": "A String", # The duration of the PDB timeout period for node drain. "respectPdbDuringNodePoolDeletion": True or False, # Whether to respect PDB during node pool deletion. }, "placementPolicy": { # PlacementPolicy defines the placement policy used by the node pool. # Specifies the node placement policy. @@ -1491,7 +1521,7 @@

Method Details

"swapSizePercent": 42, # Specifies the size of the swap space as a percentage of the ephemeral local SSD capacity. }, }, - "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_mtu_probing net.ipv4.tcp_max_orphans net.ipv4.tcp_max_tw_buckets net.ipv4.tcp_syn_retries net.ipv4.tcp_ecn net.ipv4.tcp_congestion_control net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.shmmni kernel.shmmax kernel.shmall kernel.perf_event_paranoid kernel.sched_rt_runtime_us kernel.softlockup_panic kernel.yama.ptrace_scope kernel.kptr_restrict kernel.dmesg_restrict kernel.sysrq fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_background_bytes vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_bytes vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes + "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.neigh.default.gc_thresh1 net.ipv4.neigh.default.gc_thresh2 net.ipv4.neigh.default.gc_thresh3 net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_mtu_probing net.ipv4.tcp_max_orphans net.ipv4.tcp_max_tw_buckets net.ipv4.tcp_syn_retries net.ipv4.tcp_ecn net.ipv4.tcp_congestion_control net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.keys.maxkeys kernel.keys.maxbytes kernel.shmmni kernel.shmmax kernel.shmall kernel.perf_event_paranoid kernel.sched_rt_runtime_us kernel.softlockup_panic kernel.yama.ptrace_scope kernel.kptr_restrict kernel.dmesg_restrict kernel.sysrq fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_background_bytes vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_bytes vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes "a_key": "A String", }, "transparentHugepageDefrag": "A String", # Optional. Defines the transparent hugepage defrag configuration on the node. VM hugepage allocation can be managed by either limiting defragmentation for delayed allocation or skipping it entirely for immediate allocation only. See https://docs.kernel.org/admin-guide/mm/transhuge.html for more details. @@ -1514,6 +1544,11 @@

Method Details

}, "minCpuPlatform": "A String", # Minimum CPU platform to be used by this instance. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as `minCpuPlatform: "Intel Haswell"` or `minCpuPlatform: "Intel Sandy Bridge"`. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform). "nodeGroup": "A String", # Setting this field will assign instances of this pool to run on the specified node group. This is useful for running workloads on [sole tenant nodes](https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes). + "nodeImageConfig": { # CustomImageConfig contains the information r # The node image configuration to use for this node pool. Note that this is only applicable for node pools using image_type=CUSTOM. + "image": "A String", # The name of the image to use for this node. + "imageFamily": "A String", # The name of the image family to use for this node. + "imageProject": "A String", # The project containing the image to use for this node. + }, "oauthScopes": [ # The set of Google API scopes to be made available on all of the node VMs under the "default" service account. The following scopes are recommended, but not required, and by default are not included: * `https://www.googleapis.com/auth/compute` is required for mounting persistent storage on your nodes. * `https://www.googleapis.com/auth/devstorage.read_only` is required for communicating with **gcr.io** (the [Artifact Registry](https://cloud.google.com/artifact-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added. "A String", ], @@ -1595,6 +1630,13 @@

Method Details

"locations": [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the NodePool's nodes should be located. If this value is unspecified during node pool creation, the [Cluster.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters#Cluster.FIELDS.locations) value will be used, instead. Warning: changing node pool locations will result in nodes being added and/or removed. "A String", ], + "maintenancePolicy": { # Defines the maintenance policy for the node pool. # Optional. Specifies the maintenance policy for the node pool. + "exclusionUntilEndOfSupport": { # Defines the maintenance exclusion for the node pool. # Optional. The exclusion until end of support for the node pool. + "enabled": True or False, # Optional. Indicates whether the exclusion is enabled. + "endTime": "A String", # Output only. The end time of the maintenance exclusion. It is output only. It is the cluster control plane version's end of support time, or end of extended support time when the cluster is on extended support channel. + "startTime": "A String", # Output only. The start time of the maintenance exclusion. It is output only. It is the exclusion creation time. + }, + }, "management": { # NodeManagement defines the set of node management services turned on for the node pool. # NodeManagement configuration for this NodePool. "autoRepair": True or False, # Whether the nodes will be automatically repaired. "autoUpgrade": True or False, # Whether the nodes will be automatically upgraded. @@ -1627,6 +1669,7 @@

Method Details

], "createPodRange": True or False, # Input only. Whether to create a new range for pod IPs in this node pool. Defaults are provided for `pod_range` and `pod_ipv4_cidr_block` if they are not specified. If neither `create_pod_range` or `pod_range` are specified, the cluster-level default (`ip_allocation_policy.cluster_ipv4_cidr_block`) is used. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created. "enablePrivateNodes": True or False, # Whether nodes have internal IP addresses only. If enable_private_nodes is not specified, then the value is derived from Cluster.NetworkConfig.default_enable_private_nodes + "network": "A String", # Optional. Immutable. The VPC network for the node pool. "networkPerformanceConfig": { # Configuration of all network bandwidth tiers # Network bandwidth tier configuration. "externalIpEgressBandwidthTier": "A String", # Specifies the network bandwidth tier for the NodePool for traffic to external/public IP addresses. "totalEgressBandwidthTier": "A String", # Specifies the total network bandwidth tier for the NodePool. @@ -1643,6 +1686,8 @@

Method Details

"subnetwork": "A String", # Optional. The subnetwork name/path for the node pool. Format: projects/{project}/regions/{region}/subnetworks/{subnetwork} If the cluster is associated with multiple subnetworks, the subnetwork can be either: - A user supplied subnetwork name during node pool creation (e.g., `my-subnet`). The name must be between 1 and 63 characters long, start with a letter, contain only letters, numbers, and hyphens, and end with a letter or a number. - A full subnetwork path during node pool creation, such as `projects/gke-project/regions/us-central1/subnetworks/my-subnet` - A subnetwork path picked based on the IP utilization during node pool creation and is immutable. }, "nodeDrainConfig": { # NodeDrainConfig contains the node drain related configurations for this node pool. # Specifies the node drain configuration for this node pool. + "graceTerminationDuration": "A String", # The duration of the grace termination period for node drain. + "pdbTimeoutDuration": "A String", # The duration of the PDB timeout period for node drain. "respectPdbDuringNodePoolDeletion": True or False, # Whether to respect PDB during node pool deletion. }, "placementPolicy": { # PlacementPolicy defines the placement policy used by the node pool. # Specifies the node placement policy. @@ -2129,6 +2174,8 @@

Method Details

"gvnic": { # Configuration of gVNIC feature. # Enable or disable gvnic on the node pool. "enabled": True or False, # Whether gVNIC features are enabled in the node pool. }, + "image": "A String", # The desired name of the image name to use for this node. This is used to create clusters using a custom image. + "imageProject": "A String", # The project containing the desired image to use for this node pool. This is used to create clusters using a custom image. "imageType": "A String", # Required. The desired image type for the node pool. Please see https://cloud.google.com/kubernetes-engine/docs/concepts/node-images for available image types. "kubeletConfig": { # Node kubelet configs. # Node kubelet configs. "allowedUnsafeSysctls": [ # Optional. Defines a comma-separated allowlist of unsafe sysctls or sysctl patterns (ending in `*`). The unsafe namespaced sysctl groups are `kernel.shm*`, `kernel.msg*`, `kernel.sem`, `fs.mqueue.*`, and `net.*`. Leaving this allowlist empty means they cannot be set on Pods. To allow certain sysctls or sysctl patterns to be set on Pods, list them separated by commas. For example: `kernel.msg*,net.ipv4.route.min_pmtu`. See https://kubernetes.io/docs/tasks/administer-cluster/sysctl-cluster/ for more details. @@ -2229,7 +2276,7 @@

Method Details

"swapSizePercent": 42, # Specifies the size of the swap space as a percentage of the ephemeral local SSD capacity. }, }, - "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_mtu_probing net.ipv4.tcp_max_orphans net.ipv4.tcp_max_tw_buckets net.ipv4.tcp_syn_retries net.ipv4.tcp_ecn net.ipv4.tcp_congestion_control net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.shmmni kernel.shmmax kernel.shmall kernel.perf_event_paranoid kernel.sched_rt_runtime_us kernel.softlockup_panic kernel.yama.ptrace_scope kernel.kptr_restrict kernel.dmesg_restrict kernel.sysrq fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_background_bytes vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_bytes vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes + "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.neigh.default.gc_thresh1 net.ipv4.neigh.default.gc_thresh2 net.ipv4.neigh.default.gc_thresh3 net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_mtu_probing net.ipv4.tcp_max_orphans net.ipv4.tcp_max_tw_buckets net.ipv4.tcp_syn_retries net.ipv4.tcp_ecn net.ipv4.tcp_congestion_control net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.keys.maxkeys kernel.keys.maxbytes kernel.shmmni kernel.shmmax kernel.shmall kernel.perf_event_paranoid kernel.sched_rt_runtime_us kernel.softlockup_panic kernel.yama.ptrace_scope kernel.kptr_restrict kernel.dmesg_restrict kernel.sysrq fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_background_bytes vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_bytes vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes "a_key": "A String", }, "transparentHugepageDefrag": "A String", # Optional. Defines the transparent hugepage defrag configuration on the node. VM hugepage allocation can be managed by either limiting defragmentation for delayed allocation or skipping it entirely for immediate allocation only. See https://docs.kernel.org/admin-guide/mm/transhuge.html for more details. @@ -2247,6 +2294,8 @@

Method Details

"maxRunDuration": "A String", # The maximum duration for the nodes to exist. If unspecified, the nodes can exist indefinitely. "name": "A String", # The name (project, location, cluster, node pool) of the node pool to update. Specified in the format `projects/*/locations/*/clusters/*/nodePools/*`. "nodeDrainConfig": { # NodeDrainConfig contains the node drain related configurations for this node pool. # The desired node drain configuration for nodes in the node pool. + "graceTerminationDuration": "A String", # The duration of the grace termination period for node drain. + "pdbTimeoutDuration": "A String", # The duration of the PDB timeout period for node drain. "respectPdbDuringNodePoolDeletion": True or False, # Whether to respect PDB during node pool deletion. }, "nodeNetworkConfig": { # Parameters for node pool-level network config. # Node network config. @@ -2269,6 +2318,7 @@

Method Details

], "createPodRange": True or False, # Input only. Whether to create a new range for pod IPs in this node pool. Defaults are provided for `pod_range` and `pod_ipv4_cidr_block` if they are not specified. If neither `create_pod_range` or `pod_range` are specified, the cluster-level default (`ip_allocation_policy.cluster_ipv4_cidr_block`) is used. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created. "enablePrivateNodes": True or False, # Whether nodes have internal IP addresses only. If enable_private_nodes is not specified, then the value is derived from Cluster.NetworkConfig.default_enable_private_nodes + "network": "A String", # Optional. Immutable. The VPC network for the node pool. "networkPerformanceConfig": { # Configuration of all network bandwidth tiers # Network bandwidth tier configuration. "externalIpEgressBandwidthTier": "A String", # Specifies the network bandwidth tier for the NodePool for traffic to external/public IP addresses. "totalEgressBandwidthTier": "A String", # Specifies the total network bandwidth tier for the NodePool. diff --git a/docs/dyn/container_v1beta1.projects.zones.clusters.html b/docs/dyn/container_v1beta1.projects.zones.clusters.html index 97da4d5096..b3b156e443 100644 --- a/docs/dyn/container_v1beta1.projects.zones.clusters.html +++ b/docs/dyn/container_v1beta1.projects.zones.clusters.html @@ -938,6 +938,9 @@

Method Details

"network": "A String", # The name of the Google Compute Engine [network](https://cloud.google.com/compute/docs/networks-and-firewalls#networks) to which the cluster is connected. If left unspecified, the `default` network will be used. On output this shows the network ID instead of the name. "networkConfig": { # NetworkConfig reports the relative names of network & subnetwork. # Configuration for cluster networking. "datapathProvider": "A String", # The desired datapath provider for this cluster. By default, uses the IPTables-based kube-proxy implementation. + "dataplaneV2Config": { # DataplaneV2Config is the configuration for DPv2. # Optional. DataplaneV2Config specifies the DPv2 configuration. + "scalabilityMode": "A String", # Optional. Scalability mode for the cluster. + }, "defaultEnablePrivateNodes": True or False, # Controls whether by default nodes have private IP addresses only. It is invalid to specify both PrivateClusterConfig.enablePrivateNodes and this field at the same time. To update the default setting, use ClusterUpdate.desired_default_enable_private_nodes "defaultSnatStatus": { # DefaultSnatStatus contains the desired state of whether default sNAT should be disabled on the cluster. # Whether the cluster disables default in-node sNAT rules. In-node sNAT rules will be disabled when default_snat_status is disabled. When disabled is set to false, default IP masquerade rules will be applied to the nodes to prevent sNAT on cluster internal traffic. "disabled": True or False, # Disables cluster default sNAT rules. @@ -1191,7 +1194,7 @@

Method Details

"swapSizePercent": 42, # Specifies the size of the swap space as a percentage of the ephemeral local SSD capacity. }, }, - "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_mtu_probing net.ipv4.tcp_max_orphans net.ipv4.tcp_max_tw_buckets net.ipv4.tcp_syn_retries net.ipv4.tcp_ecn net.ipv4.tcp_congestion_control net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.shmmni kernel.shmmax kernel.shmall kernel.perf_event_paranoid kernel.sched_rt_runtime_us kernel.softlockup_panic kernel.yama.ptrace_scope kernel.kptr_restrict kernel.dmesg_restrict kernel.sysrq fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_background_bytes vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_bytes vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes + "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.neigh.default.gc_thresh1 net.ipv4.neigh.default.gc_thresh2 net.ipv4.neigh.default.gc_thresh3 net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_mtu_probing net.ipv4.tcp_max_orphans net.ipv4.tcp_max_tw_buckets net.ipv4.tcp_syn_retries net.ipv4.tcp_ecn net.ipv4.tcp_congestion_control net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.keys.maxkeys kernel.keys.maxbytes kernel.shmmni kernel.shmmax kernel.shmall kernel.perf_event_paranoid kernel.sched_rt_runtime_us kernel.softlockup_panic kernel.yama.ptrace_scope kernel.kptr_restrict kernel.dmesg_restrict kernel.sysrq fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_background_bytes vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_bytes vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes "a_key": "A String", }, "transparentHugepageDefrag": "A String", # Optional. Defines the transparent hugepage defrag configuration on the node. VM hugepage allocation can be managed by either limiting defragmentation for delayed allocation or skipping it entirely for immediate allocation only. See https://docs.kernel.org/admin-guide/mm/transhuge.html for more details. @@ -1214,6 +1217,11 @@

Method Details

}, "minCpuPlatform": "A String", # Minimum CPU platform to be used by this instance. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as `minCpuPlatform: "Intel Haswell"` or `minCpuPlatform: "Intel Sandy Bridge"`. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform). "nodeGroup": "A String", # Setting this field will assign instances of this pool to run on the specified node group. This is useful for running workloads on [sole tenant nodes](https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes). + "nodeImageConfig": { # CustomImageConfig contains the information r # The node image configuration to use for this node pool. Note that this is only applicable for node pools using image_type=CUSTOM. + "image": "A String", # The name of the image to use for this node. + "imageFamily": "A String", # The name of the image family to use for this node. + "imageProject": "A String", # The project containing the image to use for this node. + }, "oauthScopes": [ # The set of Google API scopes to be made available on all of the node VMs under the "default" service account. The following scopes are recommended, but not required, and by default are not included: * `https://www.googleapis.com/auth/compute` is required for mounting persistent storage on your nodes. * `https://www.googleapis.com/auth/devstorage.read_only` is required for communicating with **gcr.io** (the [Artifact Registry](https://cloud.google.com/artifact-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added. "A String", ], @@ -1287,6 +1295,9 @@

Method Details

"nodeMetadata": "A String", # NodeMetadata is the configuration for how to expose metadata to the workloads running on the node. }, }, + "nodeCreationConfig": { # NodeCreationConfig defines the settings of node creation mode. # Optional. Configuration for Node Creation Mode. + "nodeCreationMode": "A String", # The mode of node creation. + }, "nodeIpv4CidrSize": 42, # Output only. The size of the address space on each node for hosting containers. This is provisioned from within the `container_ipv4_cidr` range. This field will only be set when cluster is in route-based network mode. "nodePoolAutoConfig": { # node pool configs that apply to all auto-provisioned node pools in autopilot clusters and node auto-provisioning enabled clusters # Node pool configs that apply to all auto-provisioned node pools in autopilot clusters and node auto-provisioning enabled clusters. "linuxNodeConfig": { # Parameters that can be configured on Linux nodes. # Output only. Configuration options for Linux nodes. @@ -1328,7 +1339,7 @@

Method Details

"swapSizePercent": 42, # Specifies the size of the swap space as a percentage of the ephemeral local SSD capacity. }, }, - "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_mtu_probing net.ipv4.tcp_max_orphans net.ipv4.tcp_max_tw_buckets net.ipv4.tcp_syn_retries net.ipv4.tcp_ecn net.ipv4.tcp_congestion_control net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.shmmni kernel.shmmax kernel.shmall kernel.perf_event_paranoid kernel.sched_rt_runtime_us kernel.softlockup_panic kernel.yama.ptrace_scope kernel.kptr_restrict kernel.dmesg_restrict kernel.sysrq fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_background_bytes vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_bytes vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes + "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.neigh.default.gc_thresh1 net.ipv4.neigh.default.gc_thresh2 net.ipv4.neigh.default.gc_thresh3 net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_mtu_probing net.ipv4.tcp_max_orphans net.ipv4.tcp_max_tw_buckets net.ipv4.tcp_syn_retries net.ipv4.tcp_ecn net.ipv4.tcp_congestion_control net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.keys.maxkeys kernel.keys.maxbytes kernel.shmmni kernel.shmmax kernel.shmall kernel.perf_event_paranoid kernel.sched_rt_runtime_us kernel.softlockup_panic kernel.yama.ptrace_scope kernel.kptr_restrict kernel.dmesg_restrict kernel.sysrq fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_background_bytes vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_bytes vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes "a_key": "A String", }, "transparentHugepageDefrag": "A String", # Optional. Defines the transparent hugepage defrag configuration on the node. VM hugepage allocation can be managed by either limiting defragmentation for delayed allocation or skipping it entirely for immediate allocation only. See https://docs.kernel.org/admin-guide/mm/transhuge.html for more details. @@ -1778,7 +1789,7 @@

Method Details

"swapSizePercent": 42, # Specifies the size of the swap space as a percentage of the ephemeral local SSD capacity. }, }, - "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_mtu_probing net.ipv4.tcp_max_orphans net.ipv4.tcp_max_tw_buckets net.ipv4.tcp_syn_retries net.ipv4.tcp_ecn net.ipv4.tcp_congestion_control net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.shmmni kernel.shmmax kernel.shmall kernel.perf_event_paranoid kernel.sched_rt_runtime_us kernel.softlockup_panic kernel.yama.ptrace_scope kernel.kptr_restrict kernel.dmesg_restrict kernel.sysrq fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_background_bytes vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_bytes vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes + "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.neigh.default.gc_thresh1 net.ipv4.neigh.default.gc_thresh2 net.ipv4.neigh.default.gc_thresh3 net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_mtu_probing net.ipv4.tcp_max_orphans net.ipv4.tcp_max_tw_buckets net.ipv4.tcp_syn_retries net.ipv4.tcp_ecn net.ipv4.tcp_congestion_control net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.keys.maxkeys kernel.keys.maxbytes kernel.shmmni kernel.shmmax kernel.shmall kernel.perf_event_paranoid kernel.sched_rt_runtime_us kernel.softlockup_panic kernel.yama.ptrace_scope kernel.kptr_restrict kernel.dmesg_restrict kernel.sysrq fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_background_bytes vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_bytes vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes "a_key": "A String", }, "transparentHugepageDefrag": "A String", # Optional. Defines the transparent hugepage defrag configuration on the node. VM hugepage allocation can be managed by either limiting defragmentation for delayed allocation or skipping it entirely for immediate allocation only. See https://docs.kernel.org/admin-guide/mm/transhuge.html for more details. @@ -1801,6 +1812,11 @@

Method Details

}, "minCpuPlatform": "A String", # Minimum CPU platform to be used by this instance. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as `minCpuPlatform: "Intel Haswell"` or `minCpuPlatform: "Intel Sandy Bridge"`. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform). "nodeGroup": "A String", # Setting this field will assign instances of this pool to run on the specified node group. This is useful for running workloads on [sole tenant nodes](https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes). + "nodeImageConfig": { # CustomImageConfig contains the information r # The node image configuration to use for this node pool. Note that this is only applicable for node pools using image_type=CUSTOM. + "image": "A String", # The name of the image to use for this node. + "imageFamily": "A String", # The name of the image family to use for this node. + "imageProject": "A String", # The project containing the image to use for this node. + }, "oauthScopes": [ # The set of Google API scopes to be made available on all of the node VMs under the "default" service account. The following scopes are recommended, but not required, and by default are not included: * `https://www.googleapis.com/auth/compute` is required for mounting persistent storage on your nodes. * `https://www.googleapis.com/auth/devstorage.read_only` is required for communicating with **gcr.io** (the [Artifact Registry](https://cloud.google.com/artifact-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added. "A String", ], @@ -1882,6 +1898,13 @@

Method Details

"locations": [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the NodePool's nodes should be located. If this value is unspecified during node pool creation, the [Cluster.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters#Cluster.FIELDS.locations) value will be used, instead. Warning: changing node pool locations will result in nodes being added and/or removed. "A String", ], + "maintenancePolicy": { # Defines the maintenance policy for the node pool. # Optional. Specifies the maintenance policy for the node pool. + "exclusionUntilEndOfSupport": { # Defines the maintenance exclusion for the node pool. # Optional. The exclusion until end of support for the node pool. + "enabled": True or False, # Optional. Indicates whether the exclusion is enabled. + "endTime": "A String", # Output only. The end time of the maintenance exclusion. It is output only. It is the cluster control plane version's end of support time, or end of extended support time when the cluster is on extended support channel. + "startTime": "A String", # Output only. The start time of the maintenance exclusion. It is output only. It is the exclusion creation time. + }, + }, "management": { # NodeManagement defines the set of node management services turned on for the node pool. # NodeManagement configuration for this NodePool. "autoRepair": True or False, # Whether the nodes will be automatically repaired. "autoUpgrade": True or False, # Whether the nodes will be automatically upgraded. @@ -1914,6 +1937,7 @@

Method Details

], "createPodRange": True or False, # Input only. Whether to create a new range for pod IPs in this node pool. Defaults are provided for `pod_range` and `pod_ipv4_cidr_block` if they are not specified. If neither `create_pod_range` or `pod_range` are specified, the cluster-level default (`ip_allocation_policy.cluster_ipv4_cidr_block`) is used. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created. "enablePrivateNodes": True or False, # Whether nodes have internal IP addresses only. If enable_private_nodes is not specified, then the value is derived from Cluster.NetworkConfig.default_enable_private_nodes + "network": "A String", # Optional. Immutable. The VPC network for the node pool. "networkPerformanceConfig": { # Configuration of all network bandwidth tiers # Network bandwidth tier configuration. "externalIpEgressBandwidthTier": "A String", # Specifies the network bandwidth tier for the NodePool for traffic to external/public IP addresses. "totalEgressBandwidthTier": "A String", # Specifies the total network bandwidth tier for the NodePool. @@ -1930,6 +1954,8 @@

Method Details

"subnetwork": "A String", # Optional. The subnetwork name/path for the node pool. Format: projects/{project}/regions/{region}/subnetworks/{subnetwork} If the cluster is associated with multiple subnetworks, the subnetwork can be either: - A user supplied subnetwork name during node pool creation (e.g., `my-subnet`). The name must be between 1 and 63 characters long, start with a letter, contain only letters, numbers, and hyphens, and end with a letter or a number. - A full subnetwork path during node pool creation, such as `projects/gke-project/regions/us-central1/subnetworks/my-subnet` - A subnetwork path picked based on the IP utilization during node pool creation and is immutable. }, "nodeDrainConfig": { # NodeDrainConfig contains the node drain related configurations for this node pool. # Specifies the node drain configuration for this node pool. + "graceTerminationDuration": "A String", # The duration of the grace termination period for node drain. + "pdbTimeoutDuration": "A String", # The duration of the PDB timeout period for node drain. "respectPdbDuringNodePoolDeletion": True or False, # Whether to respect PDB during node pool deletion. }, "placementPolicy": { # PlacementPolicy defines the placement policy used by the node pool. # Specifies the node placement policy. @@ -2778,6 +2804,9 @@

Method Details

"network": "A String", # The name of the Google Compute Engine [network](https://cloud.google.com/compute/docs/networks-and-firewalls#networks) to which the cluster is connected. If left unspecified, the `default` network will be used. On output this shows the network ID instead of the name. "networkConfig": { # NetworkConfig reports the relative names of network & subnetwork. # Configuration for cluster networking. "datapathProvider": "A String", # The desired datapath provider for this cluster. By default, uses the IPTables-based kube-proxy implementation. + "dataplaneV2Config": { # DataplaneV2Config is the configuration for DPv2. # Optional. DataplaneV2Config specifies the DPv2 configuration. + "scalabilityMode": "A String", # Optional. Scalability mode for the cluster. + }, "defaultEnablePrivateNodes": True or False, # Controls whether by default nodes have private IP addresses only. It is invalid to specify both PrivateClusterConfig.enablePrivateNodes and this field at the same time. To update the default setting, use ClusterUpdate.desired_default_enable_private_nodes "defaultSnatStatus": { # DefaultSnatStatus contains the desired state of whether default sNAT should be disabled on the cluster. # Whether the cluster disables default in-node sNAT rules. In-node sNAT rules will be disabled when default_snat_status is disabled. When disabled is set to false, default IP masquerade rules will be applied to the nodes to prevent sNAT on cluster internal traffic. "disabled": True or False, # Disables cluster default sNAT rules. @@ -3031,7 +3060,7 @@

Method Details

"swapSizePercent": 42, # Specifies the size of the swap space as a percentage of the ephemeral local SSD capacity. }, }, - "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_mtu_probing net.ipv4.tcp_max_orphans net.ipv4.tcp_max_tw_buckets net.ipv4.tcp_syn_retries net.ipv4.tcp_ecn net.ipv4.tcp_congestion_control net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.shmmni kernel.shmmax kernel.shmall kernel.perf_event_paranoid kernel.sched_rt_runtime_us kernel.softlockup_panic kernel.yama.ptrace_scope kernel.kptr_restrict kernel.dmesg_restrict kernel.sysrq fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_background_bytes vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_bytes vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes + "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.neigh.default.gc_thresh1 net.ipv4.neigh.default.gc_thresh2 net.ipv4.neigh.default.gc_thresh3 net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_mtu_probing net.ipv4.tcp_max_orphans net.ipv4.tcp_max_tw_buckets net.ipv4.tcp_syn_retries net.ipv4.tcp_ecn net.ipv4.tcp_congestion_control net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.keys.maxkeys kernel.keys.maxbytes kernel.shmmni kernel.shmmax kernel.shmall kernel.perf_event_paranoid kernel.sched_rt_runtime_us kernel.softlockup_panic kernel.yama.ptrace_scope kernel.kptr_restrict kernel.dmesg_restrict kernel.sysrq fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_background_bytes vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_bytes vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes "a_key": "A String", }, "transparentHugepageDefrag": "A String", # Optional. Defines the transparent hugepage defrag configuration on the node. VM hugepage allocation can be managed by either limiting defragmentation for delayed allocation or skipping it entirely for immediate allocation only. See https://docs.kernel.org/admin-guide/mm/transhuge.html for more details. @@ -3054,6 +3083,11 @@

Method Details

}, "minCpuPlatform": "A String", # Minimum CPU platform to be used by this instance. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as `minCpuPlatform: "Intel Haswell"` or `minCpuPlatform: "Intel Sandy Bridge"`. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform). "nodeGroup": "A String", # Setting this field will assign instances of this pool to run on the specified node group. This is useful for running workloads on [sole tenant nodes](https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes). + "nodeImageConfig": { # CustomImageConfig contains the information r # The node image configuration to use for this node pool. Note that this is only applicable for node pools using image_type=CUSTOM. + "image": "A String", # The name of the image to use for this node. + "imageFamily": "A String", # The name of the image family to use for this node. + "imageProject": "A String", # The project containing the image to use for this node. + }, "oauthScopes": [ # The set of Google API scopes to be made available on all of the node VMs under the "default" service account. The following scopes are recommended, but not required, and by default are not included: * `https://www.googleapis.com/auth/compute` is required for mounting persistent storage on your nodes. * `https://www.googleapis.com/auth/devstorage.read_only` is required for communicating with **gcr.io** (the [Artifact Registry](https://cloud.google.com/artifact-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added. "A String", ], @@ -3127,6 +3161,9 @@

Method Details

"nodeMetadata": "A String", # NodeMetadata is the configuration for how to expose metadata to the workloads running on the node. }, }, + "nodeCreationConfig": { # NodeCreationConfig defines the settings of node creation mode. # Optional. Configuration for Node Creation Mode. + "nodeCreationMode": "A String", # The mode of node creation. + }, "nodeIpv4CidrSize": 42, # Output only. The size of the address space on each node for hosting containers. This is provisioned from within the `container_ipv4_cidr` range. This field will only be set when cluster is in route-based network mode. "nodePoolAutoConfig": { # node pool configs that apply to all auto-provisioned node pools in autopilot clusters and node auto-provisioning enabled clusters # Node pool configs that apply to all auto-provisioned node pools in autopilot clusters and node auto-provisioning enabled clusters. "linuxNodeConfig": { # Parameters that can be configured on Linux nodes. # Output only. Configuration options for Linux nodes. @@ -3168,7 +3205,7 @@

Method Details

"swapSizePercent": 42, # Specifies the size of the swap space as a percentage of the ephemeral local SSD capacity. }, }, - "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_mtu_probing net.ipv4.tcp_max_orphans net.ipv4.tcp_max_tw_buckets net.ipv4.tcp_syn_retries net.ipv4.tcp_ecn net.ipv4.tcp_congestion_control net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.shmmni kernel.shmmax kernel.shmall kernel.perf_event_paranoid kernel.sched_rt_runtime_us kernel.softlockup_panic kernel.yama.ptrace_scope kernel.kptr_restrict kernel.dmesg_restrict kernel.sysrq fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_background_bytes vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_bytes vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes + "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.neigh.default.gc_thresh1 net.ipv4.neigh.default.gc_thresh2 net.ipv4.neigh.default.gc_thresh3 net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_mtu_probing net.ipv4.tcp_max_orphans net.ipv4.tcp_max_tw_buckets net.ipv4.tcp_syn_retries net.ipv4.tcp_ecn net.ipv4.tcp_congestion_control net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.keys.maxkeys kernel.keys.maxbytes kernel.shmmni kernel.shmmax kernel.shmall kernel.perf_event_paranoid kernel.sched_rt_runtime_us kernel.softlockup_panic kernel.yama.ptrace_scope kernel.kptr_restrict kernel.dmesg_restrict kernel.sysrq fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_background_bytes vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_bytes vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes "a_key": "A String", }, "transparentHugepageDefrag": "A String", # Optional. Defines the transparent hugepage defrag configuration on the node. VM hugepage allocation can be managed by either limiting defragmentation for delayed allocation or skipping it entirely for immediate allocation only. See https://docs.kernel.org/admin-guide/mm/transhuge.html for more details. @@ -3618,7 +3655,7 @@

Method Details

"swapSizePercent": 42, # Specifies the size of the swap space as a percentage of the ephemeral local SSD capacity. }, }, - "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_mtu_probing net.ipv4.tcp_max_orphans net.ipv4.tcp_max_tw_buckets net.ipv4.tcp_syn_retries net.ipv4.tcp_ecn net.ipv4.tcp_congestion_control net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.shmmni kernel.shmmax kernel.shmall kernel.perf_event_paranoid kernel.sched_rt_runtime_us kernel.softlockup_panic kernel.yama.ptrace_scope kernel.kptr_restrict kernel.dmesg_restrict kernel.sysrq fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_background_bytes vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_bytes vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes + "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.neigh.default.gc_thresh1 net.ipv4.neigh.default.gc_thresh2 net.ipv4.neigh.default.gc_thresh3 net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_mtu_probing net.ipv4.tcp_max_orphans net.ipv4.tcp_max_tw_buckets net.ipv4.tcp_syn_retries net.ipv4.tcp_ecn net.ipv4.tcp_congestion_control net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.keys.maxkeys kernel.keys.maxbytes kernel.shmmni kernel.shmmax kernel.shmall kernel.perf_event_paranoid kernel.sched_rt_runtime_us kernel.softlockup_panic kernel.yama.ptrace_scope kernel.kptr_restrict kernel.dmesg_restrict kernel.sysrq fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_background_bytes vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_bytes vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes "a_key": "A String", }, "transparentHugepageDefrag": "A String", # Optional. Defines the transparent hugepage defrag configuration on the node. VM hugepage allocation can be managed by either limiting defragmentation for delayed allocation or skipping it entirely for immediate allocation only. See https://docs.kernel.org/admin-guide/mm/transhuge.html for more details. @@ -3641,6 +3678,11 @@

Method Details

}, "minCpuPlatform": "A String", # Minimum CPU platform to be used by this instance. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as `minCpuPlatform: "Intel Haswell"` or `minCpuPlatform: "Intel Sandy Bridge"`. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform). "nodeGroup": "A String", # Setting this field will assign instances of this pool to run on the specified node group. This is useful for running workloads on [sole tenant nodes](https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes). + "nodeImageConfig": { # CustomImageConfig contains the information r # The node image configuration to use for this node pool. Note that this is only applicable for node pools using image_type=CUSTOM. + "image": "A String", # The name of the image to use for this node. + "imageFamily": "A String", # The name of the image family to use for this node. + "imageProject": "A String", # The project containing the image to use for this node. + }, "oauthScopes": [ # The set of Google API scopes to be made available on all of the node VMs under the "default" service account. The following scopes are recommended, but not required, and by default are not included: * `https://www.googleapis.com/auth/compute` is required for mounting persistent storage on your nodes. * `https://www.googleapis.com/auth/devstorage.read_only` is required for communicating with **gcr.io** (the [Artifact Registry](https://cloud.google.com/artifact-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added. "A String", ], @@ -3722,6 +3764,13 @@

Method Details

"locations": [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the NodePool's nodes should be located. If this value is unspecified during node pool creation, the [Cluster.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters#Cluster.FIELDS.locations) value will be used, instead. Warning: changing node pool locations will result in nodes being added and/or removed. "A String", ], + "maintenancePolicy": { # Defines the maintenance policy for the node pool. # Optional. Specifies the maintenance policy for the node pool. + "exclusionUntilEndOfSupport": { # Defines the maintenance exclusion for the node pool. # Optional. The exclusion until end of support for the node pool. + "enabled": True or False, # Optional. Indicates whether the exclusion is enabled. + "endTime": "A String", # Output only. The end time of the maintenance exclusion. It is output only. It is the cluster control plane version's end of support time, or end of extended support time when the cluster is on extended support channel. + "startTime": "A String", # Output only. The start time of the maintenance exclusion. It is output only. It is the exclusion creation time. + }, + }, "management": { # NodeManagement defines the set of node management services turned on for the node pool. # NodeManagement configuration for this NodePool. "autoRepair": True or False, # Whether the nodes will be automatically repaired. "autoUpgrade": True or False, # Whether the nodes will be automatically upgraded. @@ -3754,6 +3803,7 @@

Method Details

], "createPodRange": True or False, # Input only. Whether to create a new range for pod IPs in this node pool. Defaults are provided for `pod_range` and `pod_ipv4_cidr_block` if they are not specified. If neither `create_pod_range` or `pod_range` are specified, the cluster-level default (`ip_allocation_policy.cluster_ipv4_cidr_block`) is used. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created. "enablePrivateNodes": True or False, # Whether nodes have internal IP addresses only. If enable_private_nodes is not specified, then the value is derived from Cluster.NetworkConfig.default_enable_private_nodes + "network": "A String", # Optional. Immutable. The VPC network for the node pool. "networkPerformanceConfig": { # Configuration of all network bandwidth tiers # Network bandwidth tier configuration. "externalIpEgressBandwidthTier": "A String", # Specifies the network bandwidth tier for the NodePool for traffic to external/public IP addresses. "totalEgressBandwidthTier": "A String", # Specifies the total network bandwidth tier for the NodePool. @@ -3770,6 +3820,8 @@

Method Details

"subnetwork": "A String", # Optional. The subnetwork name/path for the node pool. Format: projects/{project}/regions/{region}/subnetworks/{subnetwork} If the cluster is associated with multiple subnetworks, the subnetwork can be either: - A user supplied subnetwork name during node pool creation (e.g., `my-subnet`). The name must be between 1 and 63 characters long, start with a letter, contain only letters, numbers, and hyphens, and end with a letter or a number. - A full subnetwork path during node pool creation, such as `projects/gke-project/regions/us-central1/subnetworks/my-subnet` - A subnetwork path picked based on the IP utilization during node pool creation and is immutable. }, "nodeDrainConfig": { # NodeDrainConfig contains the node drain related configurations for this node pool. # Specifies the node drain configuration for this node pool. + "graceTerminationDuration": "A String", # The duration of the grace termination period for node drain. + "pdbTimeoutDuration": "A String", # The duration of the PDB timeout period for node drain. "respectPdbDuringNodePoolDeletion": True or False, # Whether to respect PDB during node pool deletion. }, "placementPolicy": { # PlacementPolicy defines the placement policy used by the node pool. # Specifies the node placement policy. @@ -4519,6 +4571,9 @@

Method Details

"network": "A String", # The name of the Google Compute Engine [network](https://cloud.google.com/compute/docs/networks-and-firewalls#networks) to which the cluster is connected. If left unspecified, the `default` network will be used. On output this shows the network ID instead of the name. "networkConfig": { # NetworkConfig reports the relative names of network & subnetwork. # Configuration for cluster networking. "datapathProvider": "A String", # The desired datapath provider for this cluster. By default, uses the IPTables-based kube-proxy implementation. + "dataplaneV2Config": { # DataplaneV2Config is the configuration for DPv2. # Optional. DataplaneV2Config specifies the DPv2 configuration. + "scalabilityMode": "A String", # Optional. Scalability mode for the cluster. + }, "defaultEnablePrivateNodes": True or False, # Controls whether by default nodes have private IP addresses only. It is invalid to specify both PrivateClusterConfig.enablePrivateNodes and this field at the same time. To update the default setting, use ClusterUpdate.desired_default_enable_private_nodes "defaultSnatStatus": { # DefaultSnatStatus contains the desired state of whether default sNAT should be disabled on the cluster. # Whether the cluster disables default in-node sNAT rules. In-node sNAT rules will be disabled when default_snat_status is disabled. When disabled is set to false, default IP masquerade rules will be applied to the nodes to prevent sNAT on cluster internal traffic. "disabled": True or False, # Disables cluster default sNAT rules. @@ -4772,7 +4827,7 @@

Method Details

"swapSizePercent": 42, # Specifies the size of the swap space as a percentage of the ephemeral local SSD capacity. }, }, - "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_mtu_probing net.ipv4.tcp_max_orphans net.ipv4.tcp_max_tw_buckets net.ipv4.tcp_syn_retries net.ipv4.tcp_ecn net.ipv4.tcp_congestion_control net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.shmmni kernel.shmmax kernel.shmall kernel.perf_event_paranoid kernel.sched_rt_runtime_us kernel.softlockup_panic kernel.yama.ptrace_scope kernel.kptr_restrict kernel.dmesg_restrict kernel.sysrq fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_background_bytes vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_bytes vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes + "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.neigh.default.gc_thresh1 net.ipv4.neigh.default.gc_thresh2 net.ipv4.neigh.default.gc_thresh3 net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_mtu_probing net.ipv4.tcp_max_orphans net.ipv4.tcp_max_tw_buckets net.ipv4.tcp_syn_retries net.ipv4.tcp_ecn net.ipv4.tcp_congestion_control net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.keys.maxkeys kernel.keys.maxbytes kernel.shmmni kernel.shmmax kernel.shmall kernel.perf_event_paranoid kernel.sched_rt_runtime_us kernel.softlockup_panic kernel.yama.ptrace_scope kernel.kptr_restrict kernel.dmesg_restrict kernel.sysrq fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_background_bytes vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_bytes vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes "a_key": "A String", }, "transparentHugepageDefrag": "A String", # Optional. Defines the transparent hugepage defrag configuration on the node. VM hugepage allocation can be managed by either limiting defragmentation for delayed allocation or skipping it entirely for immediate allocation only. See https://docs.kernel.org/admin-guide/mm/transhuge.html for more details. @@ -4795,6 +4850,11 @@

Method Details

}, "minCpuPlatform": "A String", # Minimum CPU platform to be used by this instance. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as `minCpuPlatform: "Intel Haswell"` or `minCpuPlatform: "Intel Sandy Bridge"`. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform). "nodeGroup": "A String", # Setting this field will assign instances of this pool to run on the specified node group. This is useful for running workloads on [sole tenant nodes](https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes). + "nodeImageConfig": { # CustomImageConfig contains the information r # The node image configuration to use for this node pool. Note that this is only applicable for node pools using image_type=CUSTOM. + "image": "A String", # The name of the image to use for this node. + "imageFamily": "A String", # The name of the image family to use for this node. + "imageProject": "A String", # The project containing the image to use for this node. + }, "oauthScopes": [ # The set of Google API scopes to be made available on all of the node VMs under the "default" service account. The following scopes are recommended, but not required, and by default are not included: * `https://www.googleapis.com/auth/compute` is required for mounting persistent storage on your nodes. * `https://www.googleapis.com/auth/devstorage.read_only` is required for communicating with **gcr.io** (the [Artifact Registry](https://cloud.google.com/artifact-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added. "A String", ], @@ -4868,6 +4928,9 @@

Method Details

"nodeMetadata": "A String", # NodeMetadata is the configuration for how to expose metadata to the workloads running on the node. }, }, + "nodeCreationConfig": { # NodeCreationConfig defines the settings of node creation mode. # Optional. Configuration for Node Creation Mode. + "nodeCreationMode": "A String", # The mode of node creation. + }, "nodeIpv4CidrSize": 42, # Output only. The size of the address space on each node for hosting containers. This is provisioned from within the `container_ipv4_cidr` range. This field will only be set when cluster is in route-based network mode. "nodePoolAutoConfig": { # node pool configs that apply to all auto-provisioned node pools in autopilot clusters and node auto-provisioning enabled clusters # Node pool configs that apply to all auto-provisioned node pools in autopilot clusters and node auto-provisioning enabled clusters. "linuxNodeConfig": { # Parameters that can be configured on Linux nodes. # Output only. Configuration options for Linux nodes. @@ -4909,7 +4972,7 @@

Method Details

"swapSizePercent": 42, # Specifies the size of the swap space as a percentage of the ephemeral local SSD capacity. }, }, - "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_mtu_probing net.ipv4.tcp_max_orphans net.ipv4.tcp_max_tw_buckets net.ipv4.tcp_syn_retries net.ipv4.tcp_ecn net.ipv4.tcp_congestion_control net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.shmmni kernel.shmmax kernel.shmall kernel.perf_event_paranoid kernel.sched_rt_runtime_us kernel.softlockup_panic kernel.yama.ptrace_scope kernel.kptr_restrict kernel.dmesg_restrict kernel.sysrq fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_background_bytes vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_bytes vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes + "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.neigh.default.gc_thresh1 net.ipv4.neigh.default.gc_thresh2 net.ipv4.neigh.default.gc_thresh3 net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_mtu_probing net.ipv4.tcp_max_orphans net.ipv4.tcp_max_tw_buckets net.ipv4.tcp_syn_retries net.ipv4.tcp_ecn net.ipv4.tcp_congestion_control net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.keys.maxkeys kernel.keys.maxbytes kernel.shmmni kernel.shmmax kernel.shmall kernel.perf_event_paranoid kernel.sched_rt_runtime_us kernel.softlockup_panic kernel.yama.ptrace_scope kernel.kptr_restrict kernel.dmesg_restrict kernel.sysrq fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_background_bytes vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_bytes vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes "a_key": "A String", }, "transparentHugepageDefrag": "A String", # Optional. Defines the transparent hugepage defrag configuration on the node. VM hugepage allocation can be managed by either limiting defragmentation for delayed allocation or skipping it entirely for immediate allocation only. See https://docs.kernel.org/admin-guide/mm/transhuge.html for more details. @@ -5359,7 +5422,7 @@

Method Details

"swapSizePercent": 42, # Specifies the size of the swap space as a percentage of the ephemeral local SSD capacity. }, }, - "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_mtu_probing net.ipv4.tcp_max_orphans net.ipv4.tcp_max_tw_buckets net.ipv4.tcp_syn_retries net.ipv4.tcp_ecn net.ipv4.tcp_congestion_control net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.shmmni kernel.shmmax kernel.shmall kernel.perf_event_paranoid kernel.sched_rt_runtime_us kernel.softlockup_panic kernel.yama.ptrace_scope kernel.kptr_restrict kernel.dmesg_restrict kernel.sysrq fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_background_bytes vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_bytes vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes + "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.neigh.default.gc_thresh1 net.ipv4.neigh.default.gc_thresh2 net.ipv4.neigh.default.gc_thresh3 net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_mtu_probing net.ipv4.tcp_max_orphans net.ipv4.tcp_max_tw_buckets net.ipv4.tcp_syn_retries net.ipv4.tcp_ecn net.ipv4.tcp_congestion_control net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.keys.maxkeys kernel.keys.maxbytes kernel.shmmni kernel.shmmax kernel.shmall kernel.perf_event_paranoid kernel.sched_rt_runtime_us kernel.softlockup_panic kernel.yama.ptrace_scope kernel.kptr_restrict kernel.dmesg_restrict kernel.sysrq fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_background_bytes vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_bytes vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes "a_key": "A String", }, "transparentHugepageDefrag": "A String", # Optional. Defines the transparent hugepage defrag configuration on the node. VM hugepage allocation can be managed by either limiting defragmentation for delayed allocation or skipping it entirely for immediate allocation only. See https://docs.kernel.org/admin-guide/mm/transhuge.html for more details. @@ -5382,6 +5445,11 @@

Method Details

}, "minCpuPlatform": "A String", # Minimum CPU platform to be used by this instance. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as `minCpuPlatform: "Intel Haswell"` or `minCpuPlatform: "Intel Sandy Bridge"`. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform). "nodeGroup": "A String", # Setting this field will assign instances of this pool to run on the specified node group. This is useful for running workloads on [sole tenant nodes](https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes). + "nodeImageConfig": { # CustomImageConfig contains the information r # The node image configuration to use for this node pool. Note that this is only applicable for node pools using image_type=CUSTOM. + "image": "A String", # The name of the image to use for this node. + "imageFamily": "A String", # The name of the image family to use for this node. + "imageProject": "A String", # The project containing the image to use for this node. + }, "oauthScopes": [ # The set of Google API scopes to be made available on all of the node VMs under the "default" service account. The following scopes are recommended, but not required, and by default are not included: * `https://www.googleapis.com/auth/compute` is required for mounting persistent storage on your nodes. * `https://www.googleapis.com/auth/devstorage.read_only` is required for communicating with **gcr.io** (the [Artifact Registry](https://cloud.google.com/artifact-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added. "A String", ], @@ -5463,6 +5531,13 @@

Method Details

"locations": [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the NodePool's nodes should be located. If this value is unspecified during node pool creation, the [Cluster.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters#Cluster.FIELDS.locations) value will be used, instead. Warning: changing node pool locations will result in nodes being added and/or removed. "A String", ], + "maintenancePolicy": { # Defines the maintenance policy for the node pool. # Optional. Specifies the maintenance policy for the node pool. + "exclusionUntilEndOfSupport": { # Defines the maintenance exclusion for the node pool. # Optional. The exclusion until end of support for the node pool. + "enabled": True or False, # Optional. Indicates whether the exclusion is enabled. + "endTime": "A String", # Output only. The end time of the maintenance exclusion. It is output only. It is the cluster control plane version's end of support time, or end of extended support time when the cluster is on extended support channel. + "startTime": "A String", # Output only. The start time of the maintenance exclusion. It is output only. It is the exclusion creation time. + }, + }, "management": { # NodeManagement defines the set of node management services turned on for the node pool. # NodeManagement configuration for this NodePool. "autoRepair": True or False, # Whether the nodes will be automatically repaired. "autoUpgrade": True or False, # Whether the nodes will be automatically upgraded. @@ -5495,6 +5570,7 @@

Method Details

], "createPodRange": True or False, # Input only. Whether to create a new range for pod IPs in this node pool. Defaults are provided for `pod_range` and `pod_ipv4_cidr_block` if they are not specified. If neither `create_pod_range` or `pod_range` are specified, the cluster-level default (`ip_allocation_policy.cluster_ipv4_cidr_block`) is used. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created. "enablePrivateNodes": True or False, # Whether nodes have internal IP addresses only. If enable_private_nodes is not specified, then the value is derived from Cluster.NetworkConfig.default_enable_private_nodes + "network": "A String", # Optional. Immutable. The VPC network for the node pool. "networkPerformanceConfig": { # Configuration of all network bandwidth tiers # Network bandwidth tier configuration. "externalIpEgressBandwidthTier": "A String", # Specifies the network bandwidth tier for the NodePool for traffic to external/public IP addresses. "totalEgressBandwidthTier": "A String", # Specifies the total network bandwidth tier for the NodePool. @@ -5511,6 +5587,8 @@

Method Details

"subnetwork": "A String", # Optional. The subnetwork name/path for the node pool. Format: projects/{project}/regions/{region}/subnetworks/{subnetwork} If the cluster is associated with multiple subnetworks, the subnetwork can be either: - A user supplied subnetwork name during node pool creation (e.g., `my-subnet`). The name must be between 1 and 63 characters long, start with a letter, contain only letters, numbers, and hyphens, and end with a letter or a number. - A full subnetwork path during node pool creation, such as `projects/gke-project/regions/us-central1/subnetworks/my-subnet` - A subnetwork path picked based on the IP utilization during node pool creation and is immutable. }, "nodeDrainConfig": { # NodeDrainConfig contains the node drain related configurations for this node pool. # Specifies the node drain configuration for this node pool. + "graceTerminationDuration": "A String", # The duration of the grace termination period for node drain. + "pdbTimeoutDuration": "A String", # The duration of the PDB timeout period for node drain. "respectPdbDuringNodePoolDeletion": True or False, # Whether to respect PDB during node pool deletion. }, "placementPolicy": { # PlacementPolicy defines the placement policy used by the node pool. # Specifies the node placement policy. @@ -6849,6 +6927,8 @@

Method Details

"desiredIdentityServiceConfig": { # IdentityServiceConfig is configuration for Identity Service which allows customers to use external identity providers with the K8S API # The desired Identity Service component configuration. "enabled": True or False, # Whether to enable the Identity Service component }, + "desiredImage": "A String", # The desired name of the image to use for this node. This is used to create clusters using a custom image. + "desiredImageProject": "A String", # The project containing the desired image to use for this node. This is used to create clusters using a custom image. "desiredImageType": "A String", # The desired image type for the node pool. NOTE: Set the "desired_node_pool" field as well. "desiredInTransitEncryptionConfig": "A String", # Specify the details of in-transit encryption. Now named inter-node transparent encryption. "desiredIntraNodeVisibilityConfig": { # IntraNodeVisibilityConfig contains the desired config of the intra-node visibility on this cluster. # The desired config of Intra-node visibility. @@ -6925,6 +7005,9 @@

Method Details

"desiredNetworkTierConfig": { # NetworkTierConfig contains network tier information. # The desired network tier configuration for the cluster. "networkTier": "A String", # Network tier configuration. }, + "desiredNodeCreationConfig": { # NodeCreationConfig defines the settings of node creation mode. # Optional. The desired NodeCreationConfig for the cluster. + "nodeCreationMode": "A String", # The mode of node creation. + }, "desiredNodeKubeletConfig": { # Node kubelet configs. # The desired node kubelet config for the cluster. "allowedUnsafeSysctls": [ # Optional. Defines a comma-separated allowlist of unsafe sysctls or sysctl patterns (ending in `*`). The unsafe namespaced sysctl groups are `kernel.shm*`, `kernel.msg*`, `kernel.sem`, `fs.mqueue.*`, and `net.*`. Leaving this allowlist empty means they cannot be set on Pods. To allow certain sysctls or sysctl patterns to be set on Pods, list them separated by commas. For example: `kernel.msg*,net.ipv4.route.min_pmtu`. See https://kubernetes.io/docs/tasks/administer-cluster/sysctl-cluster/ for more details. "A String", @@ -7074,7 +7157,7 @@

Method Details

"swapSizePercent": 42, # Specifies the size of the swap space as a percentage of the ephemeral local SSD capacity. }, }, - "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_mtu_probing net.ipv4.tcp_max_orphans net.ipv4.tcp_max_tw_buckets net.ipv4.tcp_syn_retries net.ipv4.tcp_ecn net.ipv4.tcp_congestion_control net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.shmmni kernel.shmmax kernel.shmall kernel.perf_event_paranoid kernel.sched_rt_runtime_us kernel.softlockup_panic kernel.yama.ptrace_scope kernel.kptr_restrict kernel.dmesg_restrict kernel.sysrq fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_background_bytes vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_bytes vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes + "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.neigh.default.gc_thresh1 net.ipv4.neigh.default.gc_thresh2 net.ipv4.neigh.default.gc_thresh3 net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_mtu_probing net.ipv4.tcp_max_orphans net.ipv4.tcp_max_tw_buckets net.ipv4.tcp_syn_retries net.ipv4.tcp_ecn net.ipv4.tcp_congestion_control net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.keys.maxkeys kernel.keys.maxbytes kernel.shmmni kernel.shmmax kernel.shmall kernel.perf_event_paranoid kernel.sched_rt_runtime_us kernel.softlockup_panic kernel.yama.ptrace_scope kernel.kptr_restrict kernel.dmesg_restrict kernel.sysrq fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_background_bytes vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_bytes vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes "a_key": "A String", }, "transparentHugepageDefrag": "A String", # Optional. Defines the transparent hugepage defrag configuration on the node. VM hugepage allocation can be managed by either limiting defragmentation for delayed allocation or skipping it entirely for immediate allocation only. See https://docs.kernel.org/admin-guide/mm/transhuge.html for more details. diff --git a/docs/dyn/container_v1beta1.projects.zones.clusters.nodePools.html b/docs/dyn/container_v1beta1.projects.zones.clusters.nodePools.html index 64c6017989..9cd682ac3c 100644 --- a/docs/dyn/container_v1beta1.projects.zones.clusters.nodePools.html +++ b/docs/dyn/container_v1beta1.projects.zones.clusters.nodePools.html @@ -459,7 +459,7 @@

Method Details

"swapSizePercent": 42, # Specifies the size of the swap space as a percentage of the ephemeral local SSD capacity. }, }, - "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_mtu_probing net.ipv4.tcp_max_orphans net.ipv4.tcp_max_tw_buckets net.ipv4.tcp_syn_retries net.ipv4.tcp_ecn net.ipv4.tcp_congestion_control net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.shmmni kernel.shmmax kernel.shmall kernel.perf_event_paranoid kernel.sched_rt_runtime_us kernel.softlockup_panic kernel.yama.ptrace_scope kernel.kptr_restrict kernel.dmesg_restrict kernel.sysrq fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_background_bytes vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_bytes vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes + "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.neigh.default.gc_thresh1 net.ipv4.neigh.default.gc_thresh2 net.ipv4.neigh.default.gc_thresh3 net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_mtu_probing net.ipv4.tcp_max_orphans net.ipv4.tcp_max_tw_buckets net.ipv4.tcp_syn_retries net.ipv4.tcp_ecn net.ipv4.tcp_congestion_control net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.keys.maxkeys kernel.keys.maxbytes kernel.shmmni kernel.shmmax kernel.shmall kernel.perf_event_paranoid kernel.sched_rt_runtime_us kernel.softlockup_panic kernel.yama.ptrace_scope kernel.kptr_restrict kernel.dmesg_restrict kernel.sysrq fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_background_bytes vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_bytes vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes "a_key": "A String", }, "transparentHugepageDefrag": "A String", # Optional. Defines the transparent hugepage defrag configuration on the node. VM hugepage allocation can be managed by either limiting defragmentation for delayed allocation or skipping it entirely for immediate allocation only. See https://docs.kernel.org/admin-guide/mm/transhuge.html for more details. @@ -482,6 +482,11 @@

Method Details

}, "minCpuPlatform": "A String", # Minimum CPU platform to be used by this instance. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as `minCpuPlatform: "Intel Haswell"` or `minCpuPlatform: "Intel Sandy Bridge"`. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform). "nodeGroup": "A String", # Setting this field will assign instances of this pool to run on the specified node group. This is useful for running workloads on [sole tenant nodes](https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes). + "nodeImageConfig": { # CustomImageConfig contains the information r # The node image configuration to use for this node pool. Note that this is only applicable for node pools using image_type=CUSTOM. + "image": "A String", # The name of the image to use for this node. + "imageFamily": "A String", # The name of the image family to use for this node. + "imageProject": "A String", # The project containing the image to use for this node. + }, "oauthScopes": [ # The set of Google API scopes to be made available on all of the node VMs under the "default" service account. The following scopes are recommended, but not required, and by default are not included: * `https://www.googleapis.com/auth/compute` is required for mounting persistent storage on your nodes. * `https://www.googleapis.com/auth/devstorage.read_only` is required for communicating with **gcr.io** (the [Artifact Registry](https://cloud.google.com/artifact-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added. "A String", ], @@ -563,6 +568,13 @@

Method Details

"locations": [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the NodePool's nodes should be located. If this value is unspecified during node pool creation, the [Cluster.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters#Cluster.FIELDS.locations) value will be used, instead. Warning: changing node pool locations will result in nodes being added and/or removed. "A String", ], + "maintenancePolicy": { # Defines the maintenance policy for the node pool. # Optional. Specifies the maintenance policy for the node pool. + "exclusionUntilEndOfSupport": { # Defines the maintenance exclusion for the node pool. # Optional. The exclusion until end of support for the node pool. + "enabled": True or False, # Optional. Indicates whether the exclusion is enabled. + "endTime": "A String", # Output only. The end time of the maintenance exclusion. It is output only. It is the cluster control plane version's end of support time, or end of extended support time when the cluster is on extended support channel. + "startTime": "A String", # Output only. The start time of the maintenance exclusion. It is output only. It is the exclusion creation time. + }, + }, "management": { # NodeManagement defines the set of node management services turned on for the node pool. # NodeManagement configuration for this NodePool. "autoRepair": True or False, # Whether the nodes will be automatically repaired. "autoUpgrade": True or False, # Whether the nodes will be automatically upgraded. @@ -595,6 +607,7 @@

Method Details

], "createPodRange": True or False, # Input only. Whether to create a new range for pod IPs in this node pool. Defaults are provided for `pod_range` and `pod_ipv4_cidr_block` if they are not specified. If neither `create_pod_range` or `pod_range` are specified, the cluster-level default (`ip_allocation_policy.cluster_ipv4_cidr_block`) is used. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created. "enablePrivateNodes": True or False, # Whether nodes have internal IP addresses only. If enable_private_nodes is not specified, then the value is derived from Cluster.NetworkConfig.default_enable_private_nodes + "network": "A String", # Optional. Immutable. The VPC network for the node pool. "networkPerformanceConfig": { # Configuration of all network bandwidth tiers # Network bandwidth tier configuration. "externalIpEgressBandwidthTier": "A String", # Specifies the network bandwidth tier for the NodePool for traffic to external/public IP addresses. "totalEgressBandwidthTier": "A String", # Specifies the total network bandwidth tier for the NodePool. @@ -611,6 +624,8 @@

Method Details

"subnetwork": "A String", # Optional. The subnetwork name/path for the node pool. Format: projects/{project}/regions/{region}/subnetworks/{subnetwork} If the cluster is associated with multiple subnetworks, the subnetwork can be either: - A user supplied subnetwork name during node pool creation (e.g., `my-subnet`). The name must be between 1 and 63 characters long, start with a letter, contain only letters, numbers, and hyphens, and end with a letter or a number. - A full subnetwork path during node pool creation, such as `projects/gke-project/regions/us-central1/subnetworks/my-subnet` - A subnetwork path picked based on the IP utilization during node pool creation and is immutable. }, "nodeDrainConfig": { # NodeDrainConfig contains the node drain related configurations for this node pool. # Specifies the node drain configuration for this node pool. + "graceTerminationDuration": "A String", # The duration of the grace termination period for node drain. + "pdbTimeoutDuration": "A String", # The duration of the PDB timeout period for node drain. "respectPdbDuringNodePoolDeletion": True or False, # Whether to respect PDB during node pool deletion. }, "placementPolicy": { # PlacementPolicy defines the placement policy used by the node pool. # Specifies the node placement policy. @@ -1095,7 +1110,7 @@

Method Details

"swapSizePercent": 42, # Specifies the size of the swap space as a percentage of the ephemeral local SSD capacity. }, }, - "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_mtu_probing net.ipv4.tcp_max_orphans net.ipv4.tcp_max_tw_buckets net.ipv4.tcp_syn_retries net.ipv4.tcp_ecn net.ipv4.tcp_congestion_control net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.shmmni kernel.shmmax kernel.shmall kernel.perf_event_paranoid kernel.sched_rt_runtime_us kernel.softlockup_panic kernel.yama.ptrace_scope kernel.kptr_restrict kernel.dmesg_restrict kernel.sysrq fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_background_bytes vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_bytes vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes + "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.neigh.default.gc_thresh1 net.ipv4.neigh.default.gc_thresh2 net.ipv4.neigh.default.gc_thresh3 net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_mtu_probing net.ipv4.tcp_max_orphans net.ipv4.tcp_max_tw_buckets net.ipv4.tcp_syn_retries net.ipv4.tcp_ecn net.ipv4.tcp_congestion_control net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.keys.maxkeys kernel.keys.maxbytes kernel.shmmni kernel.shmmax kernel.shmall kernel.perf_event_paranoid kernel.sched_rt_runtime_us kernel.softlockup_panic kernel.yama.ptrace_scope kernel.kptr_restrict kernel.dmesg_restrict kernel.sysrq fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_background_bytes vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_bytes vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes "a_key": "A String", }, "transparentHugepageDefrag": "A String", # Optional. Defines the transparent hugepage defrag configuration on the node. VM hugepage allocation can be managed by either limiting defragmentation for delayed allocation or skipping it entirely for immediate allocation only. See https://docs.kernel.org/admin-guide/mm/transhuge.html for more details. @@ -1118,6 +1133,11 @@

Method Details

}, "minCpuPlatform": "A String", # Minimum CPU platform to be used by this instance. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as `minCpuPlatform: "Intel Haswell"` or `minCpuPlatform: "Intel Sandy Bridge"`. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform). "nodeGroup": "A String", # Setting this field will assign instances of this pool to run on the specified node group. This is useful for running workloads on [sole tenant nodes](https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes). + "nodeImageConfig": { # CustomImageConfig contains the information r # The node image configuration to use for this node pool. Note that this is only applicable for node pools using image_type=CUSTOM. + "image": "A String", # The name of the image to use for this node. + "imageFamily": "A String", # The name of the image family to use for this node. + "imageProject": "A String", # The project containing the image to use for this node. + }, "oauthScopes": [ # The set of Google API scopes to be made available on all of the node VMs under the "default" service account. The following scopes are recommended, but not required, and by default are not included: * `https://www.googleapis.com/auth/compute` is required for mounting persistent storage on your nodes. * `https://www.googleapis.com/auth/devstorage.read_only` is required for communicating with **gcr.io** (the [Artifact Registry](https://cloud.google.com/artifact-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added. "A String", ], @@ -1199,6 +1219,13 @@

Method Details

"locations": [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the NodePool's nodes should be located. If this value is unspecified during node pool creation, the [Cluster.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters#Cluster.FIELDS.locations) value will be used, instead. Warning: changing node pool locations will result in nodes being added and/or removed. "A String", ], + "maintenancePolicy": { # Defines the maintenance policy for the node pool. # Optional. Specifies the maintenance policy for the node pool. + "exclusionUntilEndOfSupport": { # Defines the maintenance exclusion for the node pool. # Optional. The exclusion until end of support for the node pool. + "enabled": True or False, # Optional. Indicates whether the exclusion is enabled. + "endTime": "A String", # Output only. The end time of the maintenance exclusion. It is output only. It is the cluster control plane version's end of support time, or end of extended support time when the cluster is on extended support channel. + "startTime": "A String", # Output only. The start time of the maintenance exclusion. It is output only. It is the exclusion creation time. + }, + }, "management": { # NodeManagement defines the set of node management services turned on for the node pool. # NodeManagement configuration for this NodePool. "autoRepair": True or False, # Whether the nodes will be automatically repaired. "autoUpgrade": True or False, # Whether the nodes will be automatically upgraded. @@ -1231,6 +1258,7 @@

Method Details

], "createPodRange": True or False, # Input only. Whether to create a new range for pod IPs in this node pool. Defaults are provided for `pod_range` and `pod_ipv4_cidr_block` if they are not specified. If neither `create_pod_range` or `pod_range` are specified, the cluster-level default (`ip_allocation_policy.cluster_ipv4_cidr_block`) is used. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created. "enablePrivateNodes": True or False, # Whether nodes have internal IP addresses only. If enable_private_nodes is not specified, then the value is derived from Cluster.NetworkConfig.default_enable_private_nodes + "network": "A String", # Optional. Immutable. The VPC network for the node pool. "networkPerformanceConfig": { # Configuration of all network bandwidth tiers # Network bandwidth tier configuration. "externalIpEgressBandwidthTier": "A String", # Specifies the network bandwidth tier for the NodePool for traffic to external/public IP addresses. "totalEgressBandwidthTier": "A String", # Specifies the total network bandwidth tier for the NodePool. @@ -1247,6 +1275,8 @@

Method Details

"subnetwork": "A String", # Optional. The subnetwork name/path for the node pool. Format: projects/{project}/regions/{region}/subnetworks/{subnetwork} If the cluster is associated with multiple subnetworks, the subnetwork can be either: - A user supplied subnetwork name during node pool creation (e.g., `my-subnet`). The name must be between 1 and 63 characters long, start with a letter, contain only letters, numbers, and hyphens, and end with a letter or a number. - A full subnetwork path during node pool creation, such as `projects/gke-project/regions/us-central1/subnetworks/my-subnet` - A subnetwork path picked based on the IP utilization during node pool creation and is immutable. }, "nodeDrainConfig": { # NodeDrainConfig contains the node drain related configurations for this node pool. # Specifies the node drain configuration for this node pool. + "graceTerminationDuration": "A String", # The duration of the grace termination period for node drain. + "pdbTimeoutDuration": "A String", # The duration of the PDB timeout period for node drain. "respectPdbDuringNodePoolDeletion": True or False, # Whether to respect PDB during node pool deletion. }, "placementPolicy": { # PlacementPolicy defines the placement policy used by the node pool. # Specifies the node placement policy. @@ -1556,7 +1586,7 @@

Method Details

"swapSizePercent": 42, # Specifies the size of the swap space as a percentage of the ephemeral local SSD capacity. }, }, - "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_mtu_probing net.ipv4.tcp_max_orphans net.ipv4.tcp_max_tw_buckets net.ipv4.tcp_syn_retries net.ipv4.tcp_ecn net.ipv4.tcp_congestion_control net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.shmmni kernel.shmmax kernel.shmall kernel.perf_event_paranoid kernel.sched_rt_runtime_us kernel.softlockup_panic kernel.yama.ptrace_scope kernel.kptr_restrict kernel.dmesg_restrict kernel.sysrq fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_background_bytes vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_bytes vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes + "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.neigh.default.gc_thresh1 net.ipv4.neigh.default.gc_thresh2 net.ipv4.neigh.default.gc_thresh3 net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_mtu_probing net.ipv4.tcp_max_orphans net.ipv4.tcp_max_tw_buckets net.ipv4.tcp_syn_retries net.ipv4.tcp_ecn net.ipv4.tcp_congestion_control net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.keys.maxkeys kernel.keys.maxbytes kernel.shmmni kernel.shmmax kernel.shmall kernel.perf_event_paranoid kernel.sched_rt_runtime_us kernel.softlockup_panic kernel.yama.ptrace_scope kernel.kptr_restrict kernel.dmesg_restrict kernel.sysrq fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_background_bytes vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_bytes vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes "a_key": "A String", }, "transparentHugepageDefrag": "A String", # Optional. Defines the transparent hugepage defrag configuration on the node. VM hugepage allocation can be managed by either limiting defragmentation for delayed allocation or skipping it entirely for immediate allocation only. See https://docs.kernel.org/admin-guide/mm/transhuge.html for more details. @@ -1579,6 +1609,11 @@

Method Details

}, "minCpuPlatform": "A String", # Minimum CPU platform to be used by this instance. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as `minCpuPlatform: "Intel Haswell"` or `minCpuPlatform: "Intel Sandy Bridge"`. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform). "nodeGroup": "A String", # Setting this field will assign instances of this pool to run on the specified node group. This is useful for running workloads on [sole tenant nodes](https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes). + "nodeImageConfig": { # CustomImageConfig contains the information r # The node image configuration to use for this node pool. Note that this is only applicable for node pools using image_type=CUSTOM. + "image": "A String", # The name of the image to use for this node. + "imageFamily": "A String", # The name of the image family to use for this node. + "imageProject": "A String", # The project containing the image to use for this node. + }, "oauthScopes": [ # The set of Google API scopes to be made available on all of the node VMs under the "default" service account. The following scopes are recommended, but not required, and by default are not included: * `https://www.googleapis.com/auth/compute` is required for mounting persistent storage on your nodes. * `https://www.googleapis.com/auth/devstorage.read_only` is required for communicating with **gcr.io** (the [Artifact Registry](https://cloud.google.com/artifact-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added. "A String", ], @@ -1660,6 +1695,13 @@

Method Details

"locations": [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the NodePool's nodes should be located. If this value is unspecified during node pool creation, the [Cluster.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters#Cluster.FIELDS.locations) value will be used, instead. Warning: changing node pool locations will result in nodes being added and/or removed. "A String", ], + "maintenancePolicy": { # Defines the maintenance policy for the node pool. # Optional. Specifies the maintenance policy for the node pool. + "exclusionUntilEndOfSupport": { # Defines the maintenance exclusion for the node pool. # Optional. The exclusion until end of support for the node pool. + "enabled": True or False, # Optional. Indicates whether the exclusion is enabled. + "endTime": "A String", # Output only. The end time of the maintenance exclusion. It is output only. It is the cluster control plane version's end of support time, or end of extended support time when the cluster is on extended support channel. + "startTime": "A String", # Output only. The start time of the maintenance exclusion. It is output only. It is the exclusion creation time. + }, + }, "management": { # NodeManagement defines the set of node management services turned on for the node pool. # NodeManagement configuration for this NodePool. "autoRepair": True or False, # Whether the nodes will be automatically repaired. "autoUpgrade": True or False, # Whether the nodes will be automatically upgraded. @@ -1692,6 +1734,7 @@

Method Details

], "createPodRange": True or False, # Input only. Whether to create a new range for pod IPs in this node pool. Defaults are provided for `pod_range` and `pod_ipv4_cidr_block` if they are not specified. If neither `create_pod_range` or `pod_range` are specified, the cluster-level default (`ip_allocation_policy.cluster_ipv4_cidr_block`) is used. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created. "enablePrivateNodes": True or False, # Whether nodes have internal IP addresses only. If enable_private_nodes is not specified, then the value is derived from Cluster.NetworkConfig.default_enable_private_nodes + "network": "A String", # Optional. Immutable. The VPC network for the node pool. "networkPerformanceConfig": { # Configuration of all network bandwidth tiers # Network bandwidth tier configuration. "externalIpEgressBandwidthTier": "A String", # Specifies the network bandwidth tier for the NodePool for traffic to external/public IP addresses. "totalEgressBandwidthTier": "A String", # Specifies the total network bandwidth tier for the NodePool. @@ -1708,6 +1751,8 @@

Method Details

"subnetwork": "A String", # Optional. The subnetwork name/path for the node pool. Format: projects/{project}/regions/{region}/subnetworks/{subnetwork} If the cluster is associated with multiple subnetworks, the subnetwork can be either: - A user supplied subnetwork name during node pool creation (e.g., `my-subnet`). The name must be between 1 and 63 characters long, start with a letter, contain only letters, numbers, and hyphens, and end with a letter or a number. - A full subnetwork path during node pool creation, such as `projects/gke-project/regions/us-central1/subnetworks/my-subnet` - A subnetwork path picked based on the IP utilization during node pool creation and is immutable. }, "nodeDrainConfig": { # NodeDrainConfig contains the node drain related configurations for this node pool. # Specifies the node drain configuration for this node pool. + "graceTerminationDuration": "A String", # The duration of the grace termination period for node drain. + "pdbTimeoutDuration": "A String", # The duration of the PDB timeout period for node drain. "respectPdbDuringNodePoolDeletion": True or False, # Whether to respect PDB during node pool deletion. }, "placementPolicy": { # PlacementPolicy defines the placement policy used by the node pool. # Specifies the node placement policy. @@ -2119,6 +2164,8 @@

Method Details

"gvnic": { # Configuration of gVNIC feature. # Enable or disable gvnic on the node pool. "enabled": True or False, # Whether gVNIC features are enabled in the node pool. }, + "image": "A String", # The desired name of the image name to use for this node. This is used to create clusters using a custom image. + "imageProject": "A String", # The project containing the desired image to use for this node pool. This is used to create clusters using a custom image. "imageType": "A String", # Required. The desired image type for the node pool. Please see https://cloud.google.com/kubernetes-engine/docs/concepts/node-images for available image types. "kubeletConfig": { # Node kubelet configs. # Node kubelet configs. "allowedUnsafeSysctls": [ # Optional. Defines a comma-separated allowlist of unsafe sysctls or sysctl patterns (ending in `*`). The unsafe namespaced sysctl groups are `kernel.shm*`, `kernel.msg*`, `kernel.sem`, `fs.mqueue.*`, and `net.*`. Leaving this allowlist empty means they cannot be set on Pods. To allow certain sysctls or sysctl patterns to be set on Pods, list them separated by commas. For example: `kernel.msg*,net.ipv4.route.min_pmtu`. See https://kubernetes.io/docs/tasks/administer-cluster/sysctl-cluster/ for more details. @@ -2219,7 +2266,7 @@

Method Details

"swapSizePercent": 42, # Specifies the size of the swap space as a percentage of the ephemeral local SSD capacity. }, }, - "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_mtu_probing net.ipv4.tcp_max_orphans net.ipv4.tcp_max_tw_buckets net.ipv4.tcp_syn_retries net.ipv4.tcp_ecn net.ipv4.tcp_congestion_control net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.shmmni kernel.shmmax kernel.shmall kernel.perf_event_paranoid kernel.sched_rt_runtime_us kernel.softlockup_panic kernel.yama.ptrace_scope kernel.kptr_restrict kernel.dmesg_restrict kernel.sysrq fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_background_bytes vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_bytes vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes + "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.neigh.default.gc_thresh1 net.ipv4.neigh.default.gc_thresh2 net.ipv4.neigh.default.gc_thresh3 net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_mtu_probing net.ipv4.tcp_max_orphans net.ipv4.tcp_max_tw_buckets net.ipv4.tcp_syn_retries net.ipv4.tcp_ecn net.ipv4.tcp_congestion_control net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.keys.maxkeys kernel.keys.maxbytes kernel.shmmni kernel.shmmax kernel.shmall kernel.perf_event_paranoid kernel.sched_rt_runtime_us kernel.softlockup_panic kernel.yama.ptrace_scope kernel.kptr_restrict kernel.dmesg_restrict kernel.sysrq fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_background_bytes vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_bytes vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes "a_key": "A String", }, "transparentHugepageDefrag": "A String", # Optional. Defines the transparent hugepage defrag configuration on the node. VM hugepage allocation can be managed by either limiting defragmentation for delayed allocation or skipping it entirely for immediate allocation only. See https://docs.kernel.org/admin-guide/mm/transhuge.html for more details. @@ -2237,6 +2284,8 @@

Method Details

"maxRunDuration": "A String", # The maximum duration for the nodes to exist. If unspecified, the nodes can exist indefinitely. "name": "A String", # The name (project, location, cluster, node pool) of the node pool to update. Specified in the format `projects/*/locations/*/clusters/*/nodePools/*`. "nodeDrainConfig": { # NodeDrainConfig contains the node drain related configurations for this node pool. # The desired node drain configuration for nodes in the node pool. + "graceTerminationDuration": "A String", # The duration of the grace termination period for node drain. + "pdbTimeoutDuration": "A String", # The duration of the PDB timeout period for node drain. "respectPdbDuringNodePoolDeletion": True or False, # Whether to respect PDB during node pool deletion. }, "nodeNetworkConfig": { # Parameters for node pool-level network config. # Node network config. @@ -2259,6 +2308,7 @@

Method Details

], "createPodRange": True or False, # Input only. Whether to create a new range for pod IPs in this node pool. Defaults are provided for `pod_range` and `pod_ipv4_cidr_block` if they are not specified. If neither `create_pod_range` or `pod_range` are specified, the cluster-level default (`ip_allocation_policy.cluster_ipv4_cidr_block`) is used. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created. "enablePrivateNodes": True or False, # Whether nodes have internal IP addresses only. If enable_private_nodes is not specified, then the value is derived from Cluster.NetworkConfig.default_enable_private_nodes + "network": "A String", # Optional. Immutable. The VPC network for the node pool. "networkPerformanceConfig": { # Configuration of all network bandwidth tiers # Network bandwidth tier configuration. "externalIpEgressBandwidthTier": "A String", # Specifies the network bandwidth tier for the NodePool for traffic to external/public IP addresses. "totalEgressBandwidthTier": "A String", # Specifies the total network bandwidth tier for the NodePool. diff --git a/docs/dyn/containeranalysis_v1.projects.locations.notes.html b/docs/dyn/containeranalysis_v1.projects.locations.notes.html index 5e25f6ea8c..29b7255d5f 100644 --- a/docs/dyn/containeranalysis_v1.projects.locations.notes.html +++ b/docs/dyn/containeranalysis_v1.projects.locations.notes.html @@ -287,18 +287,25 @@

Method Details

"advisoryPublishTime": "A String", # The time this advisory was published by the source. "cvssScore": 3.14, # The CVSS score of this vulnerability. CVSS score is on a scale of 0 - 10 where 0 indicates low severity and 10 indicates high severity. "cvssV2": { # Common Vulnerability Scoring System. For details, see https://www.first.org/cvss/specification-document This is a message we will try to use for storing various versions of CVSS rather than making a separate proto for storing a specific version. # The full description of the v2 CVSS for this vulnerability. - "attackComplexity": "A String", - "attackVector": "A String", # Base Metrics Represents the intrinsic characteristics of a vulnerability that are constant over time and across user environments. - "authentication": "A String", - "availabilityImpact": "A String", + "attackComplexity": "A String", # Attack Complexity (AC). Defined in CVSS v2, v3, v4. + "attackRequirements": "A String", # Attack Requirements (AT). Defined in CVSS v4. + "attackVector": "A String", # Attack Vector (AV). Defined in CVSS v2, v3, v4. + "authentication": "A String", # Authentication (Au). Defined in CVSS v2. + "availabilityImpact": "A String", # Availability Impact (A). Defined in CVSS v2, v3. "baseScore": 3.14, # The base score is a function of the base metric scores. - "confidentialityImpact": "A String", + "confidentialityImpact": "A String", # Confidentiality Impact (C). Defined in CVSS v2, v3. "exploitabilityScore": 3.14, "impactScore": 3.14, - "integrityImpact": "A String", - "privilegesRequired": "A String", - "scope": "A String", - "userInteraction": "A String", + "integrityImpact": "A String", # Integrity Impact (I). Defined in CVSS v2, v3. + "privilegesRequired": "A String", # Privileges Required (PR). Defined in CVSS v3, v4. + "scope": "A String", # Scope (S). Defined in CVSS v3. + "subsequentSystemAvailabilityImpact": "A String", # Subsequent System Availability Impact (SA). Defined in CVSS v4. + "subsequentSystemConfidentialityImpact": "A String", # Subsequent System Confidentiality Impact (SC). Defined in CVSS v4. + "subsequentSystemIntegrityImpact": "A String", # Subsequent System Integrity Impact (SI). Defined in CVSS v4. + "userInteraction": "A String", # User Interaction (UI). Defined in CVSS v3, v4. + "vulnerableSystemAvailabilityImpact": "A String", # Vulnerable System Availability Impact (VA). Defined in CVSS v4. + "vulnerableSystemConfidentialityImpact": "A String", # Vulnerable System Confidentiality Impact (VC). Defined in CVSS v4. + "vulnerableSystemIntegrityImpact": "A String", # Vulnerable System Integrity Impact (VI). Defined in CVSS v4. }, "cvssV3": { # Common Vulnerability Scoring System version 3. For details, see https://www.first.org/cvss/specification-document # The full description of the CVSSv3 for this vulnerability. "attackComplexity": "A String", @@ -592,18 +599,25 @@

Method Details

"advisoryPublishTime": "A String", # The time this advisory was published by the source. "cvssScore": 3.14, # The CVSS score of this vulnerability. CVSS score is on a scale of 0 - 10 where 0 indicates low severity and 10 indicates high severity. "cvssV2": { # Common Vulnerability Scoring System. For details, see https://www.first.org/cvss/specification-document This is a message we will try to use for storing various versions of CVSS rather than making a separate proto for storing a specific version. # The full description of the v2 CVSS for this vulnerability. - "attackComplexity": "A String", - "attackVector": "A String", # Base Metrics Represents the intrinsic characteristics of a vulnerability that are constant over time and across user environments. - "authentication": "A String", - "availabilityImpact": "A String", + "attackComplexity": "A String", # Attack Complexity (AC). Defined in CVSS v2, v3, v4. + "attackRequirements": "A String", # Attack Requirements (AT). Defined in CVSS v4. + "attackVector": "A String", # Attack Vector (AV). Defined in CVSS v2, v3, v4. + "authentication": "A String", # Authentication (Au). Defined in CVSS v2. + "availabilityImpact": "A String", # Availability Impact (A). Defined in CVSS v2, v3. "baseScore": 3.14, # The base score is a function of the base metric scores. - "confidentialityImpact": "A String", + "confidentialityImpact": "A String", # Confidentiality Impact (C). Defined in CVSS v2, v3. "exploitabilityScore": 3.14, "impactScore": 3.14, - "integrityImpact": "A String", - "privilegesRequired": "A String", - "scope": "A String", - "userInteraction": "A String", + "integrityImpact": "A String", # Integrity Impact (I). Defined in CVSS v2, v3. + "privilegesRequired": "A String", # Privileges Required (PR). Defined in CVSS v3, v4. + "scope": "A String", # Scope (S). Defined in CVSS v3. + "subsequentSystemAvailabilityImpact": "A String", # Subsequent System Availability Impact (SA). Defined in CVSS v4. + "subsequentSystemConfidentialityImpact": "A String", # Subsequent System Confidentiality Impact (SC). Defined in CVSS v4. + "subsequentSystemIntegrityImpact": "A String", # Subsequent System Integrity Impact (SI). Defined in CVSS v4. + "userInteraction": "A String", # User Interaction (UI). Defined in CVSS v3, v4. + "vulnerableSystemAvailabilityImpact": "A String", # Vulnerable System Availability Impact (VA). Defined in CVSS v4. + "vulnerableSystemConfidentialityImpact": "A String", # Vulnerable System Confidentiality Impact (VC). Defined in CVSS v4. + "vulnerableSystemIntegrityImpact": "A String", # Vulnerable System Integrity Impact (VI). Defined in CVSS v4. }, "cvssV3": { # Common Vulnerability Scoring System version 3. For details, see https://www.first.org/cvss/specification-document # The full description of the CVSSv3 for this vulnerability. "attackComplexity": "A String", @@ -902,18 +916,25 @@

Method Details

"advisoryPublishTime": "A String", # The time this advisory was published by the source. "cvssScore": 3.14, # The CVSS score of this vulnerability. CVSS score is on a scale of 0 - 10 where 0 indicates low severity and 10 indicates high severity. "cvssV2": { # Common Vulnerability Scoring System. For details, see https://www.first.org/cvss/specification-document This is a message we will try to use for storing various versions of CVSS rather than making a separate proto for storing a specific version. # The full description of the v2 CVSS for this vulnerability. - "attackComplexity": "A String", - "attackVector": "A String", # Base Metrics Represents the intrinsic characteristics of a vulnerability that are constant over time and across user environments. - "authentication": "A String", - "availabilityImpact": "A String", + "attackComplexity": "A String", # Attack Complexity (AC). Defined in CVSS v2, v3, v4. + "attackRequirements": "A String", # Attack Requirements (AT). Defined in CVSS v4. + "attackVector": "A String", # Attack Vector (AV). Defined in CVSS v2, v3, v4. + "authentication": "A String", # Authentication (Au). Defined in CVSS v2. + "availabilityImpact": "A String", # Availability Impact (A). Defined in CVSS v2, v3. "baseScore": 3.14, # The base score is a function of the base metric scores. - "confidentialityImpact": "A String", + "confidentialityImpact": "A String", # Confidentiality Impact (C). Defined in CVSS v2, v3. "exploitabilityScore": 3.14, "impactScore": 3.14, - "integrityImpact": "A String", - "privilegesRequired": "A String", - "scope": "A String", - "userInteraction": "A String", + "integrityImpact": "A String", # Integrity Impact (I). Defined in CVSS v2, v3. + "privilegesRequired": "A String", # Privileges Required (PR). Defined in CVSS v3, v4. + "scope": "A String", # Scope (S). Defined in CVSS v3. + "subsequentSystemAvailabilityImpact": "A String", # Subsequent System Availability Impact (SA). Defined in CVSS v4. + "subsequentSystemConfidentialityImpact": "A String", # Subsequent System Confidentiality Impact (SC). Defined in CVSS v4. + "subsequentSystemIntegrityImpact": "A String", # Subsequent System Integrity Impact (SI). Defined in CVSS v4. + "userInteraction": "A String", # User Interaction (UI). Defined in CVSS v3, v4. + "vulnerableSystemAvailabilityImpact": "A String", # Vulnerable System Availability Impact (VA). Defined in CVSS v4. + "vulnerableSystemConfidentialityImpact": "A String", # Vulnerable System Confidentiality Impact (VC). Defined in CVSS v4. + "vulnerableSystemIntegrityImpact": "A String", # Vulnerable System Integrity Impact (VI). Defined in CVSS v4. }, "cvssV3": { # Common Vulnerability Scoring System version 3. For details, see https://www.first.org/cvss/specification-document # The full description of the CVSSv3 for this vulnerability. "attackComplexity": "A String", @@ -1204,18 +1225,25 @@

Method Details

"advisoryPublishTime": "A String", # The time this advisory was published by the source. "cvssScore": 3.14, # The CVSS score of this vulnerability. CVSS score is on a scale of 0 - 10 where 0 indicates low severity and 10 indicates high severity. "cvssV2": { # Common Vulnerability Scoring System. For details, see https://www.first.org/cvss/specification-document This is a message we will try to use for storing various versions of CVSS rather than making a separate proto for storing a specific version. # The full description of the v2 CVSS for this vulnerability. - "attackComplexity": "A String", - "attackVector": "A String", # Base Metrics Represents the intrinsic characteristics of a vulnerability that are constant over time and across user environments. - "authentication": "A String", - "availabilityImpact": "A String", + "attackComplexity": "A String", # Attack Complexity (AC). Defined in CVSS v2, v3, v4. + "attackRequirements": "A String", # Attack Requirements (AT). Defined in CVSS v4. + "attackVector": "A String", # Attack Vector (AV). Defined in CVSS v2, v3, v4. + "authentication": "A String", # Authentication (Au). Defined in CVSS v2. + "availabilityImpact": "A String", # Availability Impact (A). Defined in CVSS v2, v3. "baseScore": 3.14, # The base score is a function of the base metric scores. - "confidentialityImpact": "A String", + "confidentialityImpact": "A String", # Confidentiality Impact (C). Defined in CVSS v2, v3. "exploitabilityScore": 3.14, "impactScore": 3.14, - "integrityImpact": "A String", - "privilegesRequired": "A String", - "scope": "A String", - "userInteraction": "A String", + "integrityImpact": "A String", # Integrity Impact (I). Defined in CVSS v2, v3. + "privilegesRequired": "A String", # Privileges Required (PR). Defined in CVSS v3, v4. + "scope": "A String", # Scope (S). Defined in CVSS v3. + "subsequentSystemAvailabilityImpact": "A String", # Subsequent System Availability Impact (SA). Defined in CVSS v4. + "subsequentSystemConfidentialityImpact": "A String", # Subsequent System Confidentiality Impact (SC). Defined in CVSS v4. + "subsequentSystemIntegrityImpact": "A String", # Subsequent System Integrity Impact (SI). Defined in CVSS v4. + "userInteraction": "A String", # User Interaction (UI). Defined in CVSS v3, v4. + "vulnerableSystemAvailabilityImpact": "A String", # Vulnerable System Availability Impact (VA). Defined in CVSS v4. + "vulnerableSystemConfidentialityImpact": "A String", # Vulnerable System Confidentiality Impact (VC). Defined in CVSS v4. + "vulnerableSystemIntegrityImpact": "A String", # Vulnerable System Integrity Impact (VI). Defined in CVSS v4. }, "cvssV3": { # Common Vulnerability Scoring System version 3. For details, see https://www.first.org/cvss/specification-document # The full description of the CVSSv3 for this vulnerability. "attackComplexity": "A String", @@ -1530,18 +1558,25 @@

Method Details

"advisoryPublishTime": "A String", # The time this advisory was published by the source. "cvssScore": 3.14, # The CVSS score of this vulnerability. CVSS score is on a scale of 0 - 10 where 0 indicates low severity and 10 indicates high severity. "cvssV2": { # Common Vulnerability Scoring System. For details, see https://www.first.org/cvss/specification-document This is a message we will try to use for storing various versions of CVSS rather than making a separate proto for storing a specific version. # The full description of the v2 CVSS for this vulnerability. - "attackComplexity": "A String", - "attackVector": "A String", # Base Metrics Represents the intrinsic characteristics of a vulnerability that are constant over time and across user environments. - "authentication": "A String", - "availabilityImpact": "A String", + "attackComplexity": "A String", # Attack Complexity (AC). Defined in CVSS v2, v3, v4. + "attackRequirements": "A String", # Attack Requirements (AT). Defined in CVSS v4. + "attackVector": "A String", # Attack Vector (AV). Defined in CVSS v2, v3, v4. + "authentication": "A String", # Authentication (Au). Defined in CVSS v2. + "availabilityImpact": "A String", # Availability Impact (A). Defined in CVSS v2, v3. "baseScore": 3.14, # The base score is a function of the base metric scores. - "confidentialityImpact": "A String", + "confidentialityImpact": "A String", # Confidentiality Impact (C). Defined in CVSS v2, v3. "exploitabilityScore": 3.14, "impactScore": 3.14, - "integrityImpact": "A String", - "privilegesRequired": "A String", - "scope": "A String", - "userInteraction": "A String", + "integrityImpact": "A String", # Integrity Impact (I). Defined in CVSS v2, v3. + "privilegesRequired": "A String", # Privileges Required (PR). Defined in CVSS v3, v4. + "scope": "A String", # Scope (S). Defined in CVSS v3. + "subsequentSystemAvailabilityImpact": "A String", # Subsequent System Availability Impact (SA). Defined in CVSS v4. + "subsequentSystemConfidentialityImpact": "A String", # Subsequent System Confidentiality Impact (SC). Defined in CVSS v4. + "subsequentSystemIntegrityImpact": "A String", # Subsequent System Integrity Impact (SI). Defined in CVSS v4. + "userInteraction": "A String", # User Interaction (UI). Defined in CVSS v3, v4. + "vulnerableSystemAvailabilityImpact": "A String", # Vulnerable System Availability Impact (VA). Defined in CVSS v4. + "vulnerableSystemConfidentialityImpact": "A String", # Vulnerable System Confidentiality Impact (VC). Defined in CVSS v4. + "vulnerableSystemIntegrityImpact": "A String", # Vulnerable System Integrity Impact (VI). Defined in CVSS v4. }, "cvssV3": { # Common Vulnerability Scoring System version 3. For details, see https://www.first.org/cvss/specification-document # The full description of the CVSSv3 for this vulnerability. "attackComplexity": "A String", @@ -1888,18 +1923,25 @@

Method Details

"advisoryPublishTime": "A String", # The time this advisory was published by the source. "cvssScore": 3.14, # The CVSS score of this vulnerability. CVSS score is on a scale of 0 - 10 where 0 indicates low severity and 10 indicates high severity. "cvssV2": { # Common Vulnerability Scoring System. For details, see https://www.first.org/cvss/specification-document This is a message we will try to use for storing various versions of CVSS rather than making a separate proto for storing a specific version. # The full description of the v2 CVSS for this vulnerability. - "attackComplexity": "A String", - "attackVector": "A String", # Base Metrics Represents the intrinsic characteristics of a vulnerability that are constant over time and across user environments. - "authentication": "A String", - "availabilityImpact": "A String", + "attackComplexity": "A String", # Attack Complexity (AC). Defined in CVSS v2, v3, v4. + "attackRequirements": "A String", # Attack Requirements (AT). Defined in CVSS v4. + "attackVector": "A String", # Attack Vector (AV). Defined in CVSS v2, v3, v4. + "authentication": "A String", # Authentication (Au). Defined in CVSS v2. + "availabilityImpact": "A String", # Availability Impact (A). Defined in CVSS v2, v3. "baseScore": 3.14, # The base score is a function of the base metric scores. - "confidentialityImpact": "A String", + "confidentialityImpact": "A String", # Confidentiality Impact (C). Defined in CVSS v2, v3. "exploitabilityScore": 3.14, "impactScore": 3.14, - "integrityImpact": "A String", - "privilegesRequired": "A String", - "scope": "A String", - "userInteraction": "A String", + "integrityImpact": "A String", # Integrity Impact (I). Defined in CVSS v2, v3. + "privilegesRequired": "A String", # Privileges Required (PR). Defined in CVSS v3, v4. + "scope": "A String", # Scope (S). Defined in CVSS v3. + "subsequentSystemAvailabilityImpact": "A String", # Subsequent System Availability Impact (SA). Defined in CVSS v4. + "subsequentSystemConfidentialityImpact": "A String", # Subsequent System Confidentiality Impact (SC). Defined in CVSS v4. + "subsequentSystemIntegrityImpact": "A String", # Subsequent System Integrity Impact (SI). Defined in CVSS v4. + "userInteraction": "A String", # User Interaction (UI). Defined in CVSS v3, v4. + "vulnerableSystemAvailabilityImpact": "A String", # Vulnerable System Availability Impact (VA). Defined in CVSS v4. + "vulnerableSystemConfidentialityImpact": "A String", # Vulnerable System Confidentiality Impact (VC). Defined in CVSS v4. + "vulnerableSystemIntegrityImpact": "A String", # Vulnerable System Integrity Impact (VI). Defined in CVSS v4. }, "cvssV3": { # Common Vulnerability Scoring System version 3. For details, see https://www.first.org/cvss/specification-document # The full description of the CVSSv3 for this vulnerability. "attackComplexity": "A String", @@ -2210,18 +2252,25 @@

Method Details

"advisoryPublishTime": "A String", # The time this advisory was published by the source. "cvssScore": 3.14, # The CVSS score of this vulnerability. CVSS score is on a scale of 0 - 10 where 0 indicates low severity and 10 indicates high severity. "cvssV2": { # Common Vulnerability Scoring System. For details, see https://www.first.org/cvss/specification-document This is a message we will try to use for storing various versions of CVSS rather than making a separate proto for storing a specific version. # The full description of the v2 CVSS for this vulnerability. - "attackComplexity": "A String", - "attackVector": "A String", # Base Metrics Represents the intrinsic characteristics of a vulnerability that are constant over time and across user environments. - "authentication": "A String", - "availabilityImpact": "A String", + "attackComplexity": "A String", # Attack Complexity (AC). Defined in CVSS v2, v3, v4. + "attackRequirements": "A String", # Attack Requirements (AT). Defined in CVSS v4. + "attackVector": "A String", # Attack Vector (AV). Defined in CVSS v2, v3, v4. + "authentication": "A String", # Authentication (Au). Defined in CVSS v2. + "availabilityImpact": "A String", # Availability Impact (A). Defined in CVSS v2, v3. "baseScore": 3.14, # The base score is a function of the base metric scores. - "confidentialityImpact": "A String", + "confidentialityImpact": "A String", # Confidentiality Impact (C). Defined in CVSS v2, v3. "exploitabilityScore": 3.14, "impactScore": 3.14, - "integrityImpact": "A String", - "privilegesRequired": "A String", - "scope": "A String", - "userInteraction": "A String", + "integrityImpact": "A String", # Integrity Impact (I). Defined in CVSS v2, v3. + "privilegesRequired": "A String", # Privileges Required (PR). Defined in CVSS v3, v4. + "scope": "A String", # Scope (S). Defined in CVSS v3. + "subsequentSystemAvailabilityImpact": "A String", # Subsequent System Availability Impact (SA). Defined in CVSS v4. + "subsequentSystemConfidentialityImpact": "A String", # Subsequent System Confidentiality Impact (SC). Defined in CVSS v4. + "subsequentSystemIntegrityImpact": "A String", # Subsequent System Integrity Impact (SI). Defined in CVSS v4. + "userInteraction": "A String", # User Interaction (UI). Defined in CVSS v3, v4. + "vulnerableSystemAvailabilityImpact": "A String", # Vulnerable System Availability Impact (VA). Defined in CVSS v4. + "vulnerableSystemConfidentialityImpact": "A String", # Vulnerable System Confidentiality Impact (VC). Defined in CVSS v4. + "vulnerableSystemIntegrityImpact": "A String", # Vulnerable System Integrity Impact (VI). Defined in CVSS v4. }, "cvssV3": { # Common Vulnerability Scoring System version 3. For details, see https://www.first.org/cvss/specification-document # The full description of the CVSSv3 for this vulnerability. "attackComplexity": "A String", @@ -2512,18 +2561,25 @@

Method Details

"advisoryPublishTime": "A String", # The time this advisory was published by the source. "cvssScore": 3.14, # The CVSS score of this vulnerability. CVSS score is on a scale of 0 - 10 where 0 indicates low severity and 10 indicates high severity. "cvssV2": { # Common Vulnerability Scoring System. For details, see https://www.first.org/cvss/specification-document This is a message we will try to use for storing various versions of CVSS rather than making a separate proto for storing a specific version. # The full description of the v2 CVSS for this vulnerability. - "attackComplexity": "A String", - "attackVector": "A String", # Base Metrics Represents the intrinsic characteristics of a vulnerability that are constant over time and across user environments. - "authentication": "A String", - "availabilityImpact": "A String", + "attackComplexity": "A String", # Attack Complexity (AC). Defined in CVSS v2, v3, v4. + "attackRequirements": "A String", # Attack Requirements (AT). Defined in CVSS v4. + "attackVector": "A String", # Attack Vector (AV). Defined in CVSS v2, v3, v4. + "authentication": "A String", # Authentication (Au). Defined in CVSS v2. + "availabilityImpact": "A String", # Availability Impact (A). Defined in CVSS v2, v3. "baseScore": 3.14, # The base score is a function of the base metric scores. - "confidentialityImpact": "A String", + "confidentialityImpact": "A String", # Confidentiality Impact (C). Defined in CVSS v2, v3. "exploitabilityScore": 3.14, "impactScore": 3.14, - "integrityImpact": "A String", - "privilegesRequired": "A String", - "scope": "A String", - "userInteraction": "A String", + "integrityImpact": "A String", # Integrity Impact (I). Defined in CVSS v2, v3. + "privilegesRequired": "A String", # Privileges Required (PR). Defined in CVSS v3, v4. + "scope": "A String", # Scope (S). Defined in CVSS v3. + "subsequentSystemAvailabilityImpact": "A String", # Subsequent System Availability Impact (SA). Defined in CVSS v4. + "subsequentSystemConfidentialityImpact": "A String", # Subsequent System Confidentiality Impact (SC). Defined in CVSS v4. + "subsequentSystemIntegrityImpact": "A String", # Subsequent System Integrity Impact (SI). Defined in CVSS v4. + "userInteraction": "A String", # User Interaction (UI). Defined in CVSS v3, v4. + "vulnerableSystemAvailabilityImpact": "A String", # Vulnerable System Availability Impact (VA). Defined in CVSS v4. + "vulnerableSystemConfidentialityImpact": "A String", # Vulnerable System Confidentiality Impact (VC). Defined in CVSS v4. + "vulnerableSystemIntegrityImpact": "A String", # Vulnerable System Integrity Impact (VI). Defined in CVSS v4. }, "cvssV3": { # Common Vulnerability Scoring System version 3. For details, see https://www.first.org/cvss/specification-document # The full description of the CVSSv3 for this vulnerability. "attackComplexity": "A String", diff --git a/docs/dyn/containeranalysis_v1.projects.locations.notes.occurrences.html b/docs/dyn/containeranalysis_v1.projects.locations.notes.occurrences.html index 343ecf51e7..e7f22ccea1 100644 --- a/docs/dyn/containeranalysis_v1.projects.locations.notes.occurrences.html +++ b/docs/dyn/containeranalysis_v1.projects.locations.notes.occurrences.html @@ -875,33 +875,47 @@

Method Details

"vulnerability": { # An occurrence of a severity vulnerability on a resource. # Describes a security vulnerability. "cvssScore": 3.14, # Output only. The CVSS score of this vulnerability. CVSS score is on a scale of 0 - 10 where 0 indicates low severity and 10 indicates high severity. "cvssV2": { # Common Vulnerability Scoring System. For details, see https://www.first.org/cvss/specification-document This is a message we will try to use for storing various versions of CVSS rather than making a separate proto for storing a specific version. # The cvss v2 score for the vulnerability. - "attackComplexity": "A String", - "attackVector": "A String", # Base Metrics Represents the intrinsic characteristics of a vulnerability that are constant over time and across user environments. - "authentication": "A String", - "availabilityImpact": "A String", + "attackComplexity": "A String", # Attack Complexity (AC). Defined in CVSS v2, v3, v4. + "attackRequirements": "A String", # Attack Requirements (AT). Defined in CVSS v4. + "attackVector": "A String", # Attack Vector (AV). Defined in CVSS v2, v3, v4. + "authentication": "A String", # Authentication (Au). Defined in CVSS v2. + "availabilityImpact": "A String", # Availability Impact (A). Defined in CVSS v2, v3. "baseScore": 3.14, # The base score is a function of the base metric scores. - "confidentialityImpact": "A String", + "confidentialityImpact": "A String", # Confidentiality Impact (C). Defined in CVSS v2, v3. "exploitabilityScore": 3.14, "impactScore": 3.14, - "integrityImpact": "A String", - "privilegesRequired": "A String", - "scope": "A String", - "userInteraction": "A String", + "integrityImpact": "A String", # Integrity Impact (I). Defined in CVSS v2, v3. + "privilegesRequired": "A String", # Privileges Required (PR). Defined in CVSS v3, v4. + "scope": "A String", # Scope (S). Defined in CVSS v3. + "subsequentSystemAvailabilityImpact": "A String", # Subsequent System Availability Impact (SA). Defined in CVSS v4. + "subsequentSystemConfidentialityImpact": "A String", # Subsequent System Confidentiality Impact (SC). Defined in CVSS v4. + "subsequentSystemIntegrityImpact": "A String", # Subsequent System Integrity Impact (SI). Defined in CVSS v4. + "userInteraction": "A String", # User Interaction (UI). Defined in CVSS v3, v4. + "vulnerableSystemAvailabilityImpact": "A String", # Vulnerable System Availability Impact (VA). Defined in CVSS v4. + "vulnerableSystemConfidentialityImpact": "A String", # Vulnerable System Confidentiality Impact (VC). Defined in CVSS v4. + "vulnerableSystemIntegrityImpact": "A String", # Vulnerable System Integrity Impact (VI). Defined in CVSS v4. }, "cvssVersion": "A String", # Output only. CVSS version used to populate cvss_score and severity. "cvssv3": { # Common Vulnerability Scoring System. For details, see https://www.first.org/cvss/specification-document This is a message we will try to use for storing various versions of CVSS rather than making a separate proto for storing a specific version. # The cvss v3 score for the vulnerability. - "attackComplexity": "A String", - "attackVector": "A String", # Base Metrics Represents the intrinsic characteristics of a vulnerability that are constant over time and across user environments. - "authentication": "A String", - "availabilityImpact": "A String", + "attackComplexity": "A String", # Attack Complexity (AC). Defined in CVSS v2, v3, v4. + "attackRequirements": "A String", # Attack Requirements (AT). Defined in CVSS v4. + "attackVector": "A String", # Attack Vector (AV). Defined in CVSS v2, v3, v4. + "authentication": "A String", # Authentication (Au). Defined in CVSS v2. + "availabilityImpact": "A String", # Availability Impact (A). Defined in CVSS v2, v3. "baseScore": 3.14, # The base score is a function of the base metric scores. - "confidentialityImpact": "A String", + "confidentialityImpact": "A String", # Confidentiality Impact (C). Defined in CVSS v2, v3. "exploitabilityScore": 3.14, "impactScore": 3.14, - "integrityImpact": "A String", - "privilegesRequired": "A String", - "scope": "A String", - "userInteraction": "A String", + "integrityImpact": "A String", # Integrity Impact (I). Defined in CVSS v2, v3. + "privilegesRequired": "A String", # Privileges Required (PR). Defined in CVSS v3, v4. + "scope": "A String", # Scope (S). Defined in CVSS v3. + "subsequentSystemAvailabilityImpact": "A String", # Subsequent System Availability Impact (SA). Defined in CVSS v4. + "subsequentSystemConfidentialityImpact": "A String", # Subsequent System Confidentiality Impact (SC). Defined in CVSS v4. + "subsequentSystemIntegrityImpact": "A String", # Subsequent System Integrity Impact (SI). Defined in CVSS v4. + "userInteraction": "A String", # User Interaction (UI). Defined in CVSS v3, v4. + "vulnerableSystemAvailabilityImpact": "A String", # Vulnerable System Availability Impact (VA). Defined in CVSS v4. + "vulnerableSystemConfidentialityImpact": "A String", # Vulnerable System Confidentiality Impact (VC). Defined in CVSS v4. + "vulnerableSystemIntegrityImpact": "A String", # Vulnerable System Integrity Impact (VI). Defined in CVSS v4. }, "effectiveSeverity": "A String", # The distro assigned severity for this vulnerability when it is available, otherwise this is the note provider assigned severity. When there are multiple PackageIssues for this vulnerability, they can have different effective severities because some might be provided by the distro while others are provided by the language ecosystem for a language pack. For this reason, it is advised to use the effective severity on the PackageIssue level. In the case where multiple PackageIssues have differing effective severities, this field should be the highest severity for any of the PackageIssues. "extraDetails": "A String", # Occurrence-specific extra details about the vulnerability. diff --git a/docs/dyn/containeranalysis_v1.projects.locations.occurrences.html b/docs/dyn/containeranalysis_v1.projects.locations.occurrences.html index 1a6b3ca753..b54921dbbb 100644 --- a/docs/dyn/containeranalysis_v1.projects.locations.occurrences.html +++ b/docs/dyn/containeranalysis_v1.projects.locations.occurrences.html @@ -891,33 +891,47 @@

Method Details

"vulnerability": { # An occurrence of a severity vulnerability on a resource. # Describes a security vulnerability. "cvssScore": 3.14, # Output only. The CVSS score of this vulnerability. CVSS score is on a scale of 0 - 10 where 0 indicates low severity and 10 indicates high severity. "cvssV2": { # Common Vulnerability Scoring System. For details, see https://www.first.org/cvss/specification-document This is a message we will try to use for storing various versions of CVSS rather than making a separate proto for storing a specific version. # The cvss v2 score for the vulnerability. - "attackComplexity": "A String", - "attackVector": "A String", # Base Metrics Represents the intrinsic characteristics of a vulnerability that are constant over time and across user environments. - "authentication": "A String", - "availabilityImpact": "A String", + "attackComplexity": "A String", # Attack Complexity (AC). Defined in CVSS v2, v3, v4. + "attackRequirements": "A String", # Attack Requirements (AT). Defined in CVSS v4. + "attackVector": "A String", # Attack Vector (AV). Defined in CVSS v2, v3, v4. + "authentication": "A String", # Authentication (Au). Defined in CVSS v2. + "availabilityImpact": "A String", # Availability Impact (A). Defined in CVSS v2, v3. "baseScore": 3.14, # The base score is a function of the base metric scores. - "confidentialityImpact": "A String", + "confidentialityImpact": "A String", # Confidentiality Impact (C). Defined in CVSS v2, v3. "exploitabilityScore": 3.14, "impactScore": 3.14, - "integrityImpact": "A String", - "privilegesRequired": "A String", - "scope": "A String", - "userInteraction": "A String", + "integrityImpact": "A String", # Integrity Impact (I). Defined in CVSS v2, v3. + "privilegesRequired": "A String", # Privileges Required (PR). Defined in CVSS v3, v4. + "scope": "A String", # Scope (S). Defined in CVSS v3. + "subsequentSystemAvailabilityImpact": "A String", # Subsequent System Availability Impact (SA). Defined in CVSS v4. + "subsequentSystemConfidentialityImpact": "A String", # Subsequent System Confidentiality Impact (SC). Defined in CVSS v4. + "subsequentSystemIntegrityImpact": "A String", # Subsequent System Integrity Impact (SI). Defined in CVSS v4. + "userInteraction": "A String", # User Interaction (UI). Defined in CVSS v3, v4. + "vulnerableSystemAvailabilityImpact": "A String", # Vulnerable System Availability Impact (VA). Defined in CVSS v4. + "vulnerableSystemConfidentialityImpact": "A String", # Vulnerable System Confidentiality Impact (VC). Defined in CVSS v4. + "vulnerableSystemIntegrityImpact": "A String", # Vulnerable System Integrity Impact (VI). Defined in CVSS v4. }, "cvssVersion": "A String", # Output only. CVSS version used to populate cvss_score and severity. "cvssv3": { # Common Vulnerability Scoring System. For details, see https://www.first.org/cvss/specification-document This is a message we will try to use for storing various versions of CVSS rather than making a separate proto for storing a specific version. # The cvss v3 score for the vulnerability. - "attackComplexity": "A String", - "attackVector": "A String", # Base Metrics Represents the intrinsic characteristics of a vulnerability that are constant over time and across user environments. - "authentication": "A String", - "availabilityImpact": "A String", + "attackComplexity": "A String", # Attack Complexity (AC). Defined in CVSS v2, v3, v4. + "attackRequirements": "A String", # Attack Requirements (AT). Defined in CVSS v4. + "attackVector": "A String", # Attack Vector (AV). Defined in CVSS v2, v3, v4. + "authentication": "A String", # Authentication (Au). Defined in CVSS v2. + "availabilityImpact": "A String", # Availability Impact (A). Defined in CVSS v2, v3. "baseScore": 3.14, # The base score is a function of the base metric scores. - "confidentialityImpact": "A String", + "confidentialityImpact": "A String", # Confidentiality Impact (C). Defined in CVSS v2, v3. "exploitabilityScore": 3.14, "impactScore": 3.14, - "integrityImpact": "A String", - "privilegesRequired": "A String", - "scope": "A String", - "userInteraction": "A String", + "integrityImpact": "A String", # Integrity Impact (I). Defined in CVSS v2, v3. + "privilegesRequired": "A String", # Privileges Required (PR). Defined in CVSS v3, v4. + "scope": "A String", # Scope (S). Defined in CVSS v3. + "subsequentSystemAvailabilityImpact": "A String", # Subsequent System Availability Impact (SA). Defined in CVSS v4. + "subsequentSystemConfidentialityImpact": "A String", # Subsequent System Confidentiality Impact (SC). Defined in CVSS v4. + "subsequentSystemIntegrityImpact": "A String", # Subsequent System Integrity Impact (SI). Defined in CVSS v4. + "userInteraction": "A String", # User Interaction (UI). Defined in CVSS v3, v4. + "vulnerableSystemAvailabilityImpact": "A String", # Vulnerable System Availability Impact (VA). Defined in CVSS v4. + "vulnerableSystemConfidentialityImpact": "A String", # Vulnerable System Confidentiality Impact (VC). Defined in CVSS v4. + "vulnerableSystemIntegrityImpact": "A String", # Vulnerable System Integrity Impact (VI). Defined in CVSS v4. }, "effectiveSeverity": "A String", # The distro assigned severity for this vulnerability when it is available, otherwise this is the note provider assigned severity. When there are multiple PackageIssues for this vulnerability, they can have different effective severities because some might be provided by the distro while others are provided by the language ecosystem for a language pack. For this reason, it is advised to use the effective severity on the PackageIssue level. In the case where multiple PackageIssues have differing effective severities, this field should be the highest severity for any of the PackageIssues. "extraDetails": "A String", # Occurrence-specific extra details about the vulnerability. @@ -1798,33 +1812,47 @@

Method Details

"vulnerability": { # An occurrence of a severity vulnerability on a resource. # Describes a security vulnerability. "cvssScore": 3.14, # Output only. The CVSS score of this vulnerability. CVSS score is on a scale of 0 - 10 where 0 indicates low severity and 10 indicates high severity. "cvssV2": { # Common Vulnerability Scoring System. For details, see https://www.first.org/cvss/specification-document This is a message we will try to use for storing various versions of CVSS rather than making a separate proto for storing a specific version. # The cvss v2 score for the vulnerability. - "attackComplexity": "A String", - "attackVector": "A String", # Base Metrics Represents the intrinsic characteristics of a vulnerability that are constant over time and across user environments. - "authentication": "A String", - "availabilityImpact": "A String", + "attackComplexity": "A String", # Attack Complexity (AC). Defined in CVSS v2, v3, v4. + "attackRequirements": "A String", # Attack Requirements (AT). Defined in CVSS v4. + "attackVector": "A String", # Attack Vector (AV). Defined in CVSS v2, v3, v4. + "authentication": "A String", # Authentication (Au). Defined in CVSS v2. + "availabilityImpact": "A String", # Availability Impact (A). Defined in CVSS v2, v3. "baseScore": 3.14, # The base score is a function of the base metric scores. - "confidentialityImpact": "A String", + "confidentialityImpact": "A String", # Confidentiality Impact (C). Defined in CVSS v2, v3. "exploitabilityScore": 3.14, "impactScore": 3.14, - "integrityImpact": "A String", - "privilegesRequired": "A String", - "scope": "A String", - "userInteraction": "A String", + "integrityImpact": "A String", # Integrity Impact (I). Defined in CVSS v2, v3. + "privilegesRequired": "A String", # Privileges Required (PR). Defined in CVSS v3, v4. + "scope": "A String", # Scope (S). Defined in CVSS v3. + "subsequentSystemAvailabilityImpact": "A String", # Subsequent System Availability Impact (SA). Defined in CVSS v4. + "subsequentSystemConfidentialityImpact": "A String", # Subsequent System Confidentiality Impact (SC). Defined in CVSS v4. + "subsequentSystemIntegrityImpact": "A String", # Subsequent System Integrity Impact (SI). Defined in CVSS v4. + "userInteraction": "A String", # User Interaction (UI). Defined in CVSS v3, v4. + "vulnerableSystemAvailabilityImpact": "A String", # Vulnerable System Availability Impact (VA). Defined in CVSS v4. + "vulnerableSystemConfidentialityImpact": "A String", # Vulnerable System Confidentiality Impact (VC). Defined in CVSS v4. + "vulnerableSystemIntegrityImpact": "A String", # Vulnerable System Integrity Impact (VI). Defined in CVSS v4. }, "cvssVersion": "A String", # Output only. CVSS version used to populate cvss_score and severity. "cvssv3": { # Common Vulnerability Scoring System. For details, see https://www.first.org/cvss/specification-document This is a message we will try to use for storing various versions of CVSS rather than making a separate proto for storing a specific version. # The cvss v3 score for the vulnerability. - "attackComplexity": "A String", - "attackVector": "A String", # Base Metrics Represents the intrinsic characteristics of a vulnerability that are constant over time and across user environments. - "authentication": "A String", - "availabilityImpact": "A String", + "attackComplexity": "A String", # Attack Complexity (AC). Defined in CVSS v2, v3, v4. + "attackRequirements": "A String", # Attack Requirements (AT). Defined in CVSS v4. + "attackVector": "A String", # Attack Vector (AV). Defined in CVSS v2, v3, v4. + "authentication": "A String", # Authentication (Au). Defined in CVSS v2. + "availabilityImpact": "A String", # Availability Impact (A). Defined in CVSS v2, v3. "baseScore": 3.14, # The base score is a function of the base metric scores. - "confidentialityImpact": "A String", + "confidentialityImpact": "A String", # Confidentiality Impact (C). Defined in CVSS v2, v3. "exploitabilityScore": 3.14, "impactScore": 3.14, - "integrityImpact": "A String", - "privilegesRequired": "A String", - "scope": "A String", - "userInteraction": "A String", + "integrityImpact": "A String", # Integrity Impact (I). Defined in CVSS v2, v3. + "privilegesRequired": "A String", # Privileges Required (PR). Defined in CVSS v3, v4. + "scope": "A String", # Scope (S). Defined in CVSS v3. + "subsequentSystemAvailabilityImpact": "A String", # Subsequent System Availability Impact (SA). Defined in CVSS v4. + "subsequentSystemConfidentialityImpact": "A String", # Subsequent System Confidentiality Impact (SC). Defined in CVSS v4. + "subsequentSystemIntegrityImpact": "A String", # Subsequent System Integrity Impact (SI). Defined in CVSS v4. + "userInteraction": "A String", # User Interaction (UI). Defined in CVSS v3, v4. + "vulnerableSystemAvailabilityImpact": "A String", # Vulnerable System Availability Impact (VA). Defined in CVSS v4. + "vulnerableSystemConfidentialityImpact": "A String", # Vulnerable System Confidentiality Impact (VC). Defined in CVSS v4. + "vulnerableSystemIntegrityImpact": "A String", # Vulnerable System Integrity Impact (VI). Defined in CVSS v4. }, "effectiveSeverity": "A String", # The distro assigned severity for this vulnerability when it is available, otherwise this is the note provider assigned severity. When there are multiple PackageIssues for this vulnerability, they can have different effective severities because some might be provided by the distro while others are provided by the language ecosystem for a language pack. For this reason, it is advised to use the effective severity on the PackageIssue level. In the case where multiple PackageIssues have differing effective severities, this field should be the highest severity for any of the PackageIssues. "extraDetails": "A String", # Occurrence-specific extra details about the vulnerability. @@ -2710,33 +2738,47 @@

Method Details

"vulnerability": { # An occurrence of a severity vulnerability on a resource. # Describes a security vulnerability. "cvssScore": 3.14, # Output only. The CVSS score of this vulnerability. CVSS score is on a scale of 0 - 10 where 0 indicates low severity and 10 indicates high severity. "cvssV2": { # Common Vulnerability Scoring System. For details, see https://www.first.org/cvss/specification-document This is a message we will try to use for storing various versions of CVSS rather than making a separate proto for storing a specific version. # The cvss v2 score for the vulnerability. - "attackComplexity": "A String", - "attackVector": "A String", # Base Metrics Represents the intrinsic characteristics of a vulnerability that are constant over time and across user environments. - "authentication": "A String", - "availabilityImpact": "A String", + "attackComplexity": "A String", # Attack Complexity (AC). Defined in CVSS v2, v3, v4. + "attackRequirements": "A String", # Attack Requirements (AT). Defined in CVSS v4. + "attackVector": "A String", # Attack Vector (AV). Defined in CVSS v2, v3, v4. + "authentication": "A String", # Authentication (Au). Defined in CVSS v2. + "availabilityImpact": "A String", # Availability Impact (A). Defined in CVSS v2, v3. "baseScore": 3.14, # The base score is a function of the base metric scores. - "confidentialityImpact": "A String", + "confidentialityImpact": "A String", # Confidentiality Impact (C). Defined in CVSS v2, v3. "exploitabilityScore": 3.14, "impactScore": 3.14, - "integrityImpact": "A String", - "privilegesRequired": "A String", - "scope": "A String", - "userInteraction": "A String", + "integrityImpact": "A String", # Integrity Impact (I). Defined in CVSS v2, v3. + "privilegesRequired": "A String", # Privileges Required (PR). Defined in CVSS v3, v4. + "scope": "A String", # Scope (S). Defined in CVSS v3. + "subsequentSystemAvailabilityImpact": "A String", # Subsequent System Availability Impact (SA). Defined in CVSS v4. + "subsequentSystemConfidentialityImpact": "A String", # Subsequent System Confidentiality Impact (SC). Defined in CVSS v4. + "subsequentSystemIntegrityImpact": "A String", # Subsequent System Integrity Impact (SI). Defined in CVSS v4. + "userInteraction": "A String", # User Interaction (UI). Defined in CVSS v3, v4. + "vulnerableSystemAvailabilityImpact": "A String", # Vulnerable System Availability Impact (VA). Defined in CVSS v4. + "vulnerableSystemConfidentialityImpact": "A String", # Vulnerable System Confidentiality Impact (VC). Defined in CVSS v4. + "vulnerableSystemIntegrityImpact": "A String", # Vulnerable System Integrity Impact (VI). Defined in CVSS v4. }, "cvssVersion": "A String", # Output only. CVSS version used to populate cvss_score and severity. "cvssv3": { # Common Vulnerability Scoring System. For details, see https://www.first.org/cvss/specification-document This is a message we will try to use for storing various versions of CVSS rather than making a separate proto for storing a specific version. # The cvss v3 score for the vulnerability. - "attackComplexity": "A String", - "attackVector": "A String", # Base Metrics Represents the intrinsic characteristics of a vulnerability that are constant over time and across user environments. - "authentication": "A String", - "availabilityImpact": "A String", + "attackComplexity": "A String", # Attack Complexity (AC). Defined in CVSS v2, v3, v4. + "attackRequirements": "A String", # Attack Requirements (AT). Defined in CVSS v4. + "attackVector": "A String", # Attack Vector (AV). Defined in CVSS v2, v3, v4. + "authentication": "A String", # Authentication (Au). Defined in CVSS v2. + "availabilityImpact": "A String", # Availability Impact (A). Defined in CVSS v2, v3. "baseScore": 3.14, # The base score is a function of the base metric scores. - "confidentialityImpact": "A String", + "confidentialityImpact": "A String", # Confidentiality Impact (C). Defined in CVSS v2, v3. "exploitabilityScore": 3.14, "impactScore": 3.14, - "integrityImpact": "A String", - "privilegesRequired": "A String", - "scope": "A String", - "userInteraction": "A String", + "integrityImpact": "A String", # Integrity Impact (I). Defined in CVSS v2, v3. + "privilegesRequired": "A String", # Privileges Required (PR). Defined in CVSS v3, v4. + "scope": "A String", # Scope (S). Defined in CVSS v3. + "subsequentSystemAvailabilityImpact": "A String", # Subsequent System Availability Impact (SA). Defined in CVSS v4. + "subsequentSystemConfidentialityImpact": "A String", # Subsequent System Confidentiality Impact (SC). Defined in CVSS v4. + "subsequentSystemIntegrityImpact": "A String", # Subsequent System Integrity Impact (SI). Defined in CVSS v4. + "userInteraction": "A String", # User Interaction (UI). Defined in CVSS v3, v4. + "vulnerableSystemAvailabilityImpact": "A String", # Vulnerable System Availability Impact (VA). Defined in CVSS v4. + "vulnerableSystemConfidentialityImpact": "A String", # Vulnerable System Confidentiality Impact (VC). Defined in CVSS v4. + "vulnerableSystemIntegrityImpact": "A String", # Vulnerable System Integrity Impact (VI). Defined in CVSS v4. }, "effectiveSeverity": "A String", # The distro assigned severity for this vulnerability when it is available, otherwise this is the note provider assigned severity. When there are multiple PackageIssues for this vulnerability, they can have different effective severities because some might be provided by the distro while others are provided by the language ecosystem for a language pack. For this reason, it is advised to use the effective severity on the PackageIssue level. In the case where multiple PackageIssues have differing effective severities, this field should be the highest severity for any of the PackageIssues. "extraDetails": "A String", # Occurrence-specific extra details about the vulnerability. @@ -3613,33 +3655,47 @@

Method Details

"vulnerability": { # An occurrence of a severity vulnerability on a resource. # Describes a security vulnerability. "cvssScore": 3.14, # Output only. The CVSS score of this vulnerability. CVSS score is on a scale of 0 - 10 where 0 indicates low severity and 10 indicates high severity. "cvssV2": { # Common Vulnerability Scoring System. For details, see https://www.first.org/cvss/specification-document This is a message we will try to use for storing various versions of CVSS rather than making a separate proto for storing a specific version. # The cvss v2 score for the vulnerability. - "attackComplexity": "A String", - "attackVector": "A String", # Base Metrics Represents the intrinsic characteristics of a vulnerability that are constant over time and across user environments. - "authentication": "A String", - "availabilityImpact": "A String", + "attackComplexity": "A String", # Attack Complexity (AC). Defined in CVSS v2, v3, v4. + "attackRequirements": "A String", # Attack Requirements (AT). Defined in CVSS v4. + "attackVector": "A String", # Attack Vector (AV). Defined in CVSS v2, v3, v4. + "authentication": "A String", # Authentication (Au). Defined in CVSS v2. + "availabilityImpact": "A String", # Availability Impact (A). Defined in CVSS v2, v3. "baseScore": 3.14, # The base score is a function of the base metric scores. - "confidentialityImpact": "A String", + "confidentialityImpact": "A String", # Confidentiality Impact (C). Defined in CVSS v2, v3. "exploitabilityScore": 3.14, "impactScore": 3.14, - "integrityImpact": "A String", - "privilegesRequired": "A String", - "scope": "A String", - "userInteraction": "A String", + "integrityImpact": "A String", # Integrity Impact (I). Defined in CVSS v2, v3. + "privilegesRequired": "A String", # Privileges Required (PR). Defined in CVSS v3, v4. + "scope": "A String", # Scope (S). Defined in CVSS v3. + "subsequentSystemAvailabilityImpact": "A String", # Subsequent System Availability Impact (SA). Defined in CVSS v4. + "subsequentSystemConfidentialityImpact": "A String", # Subsequent System Confidentiality Impact (SC). Defined in CVSS v4. + "subsequentSystemIntegrityImpact": "A String", # Subsequent System Integrity Impact (SI). Defined in CVSS v4. + "userInteraction": "A String", # User Interaction (UI). Defined in CVSS v3, v4. + "vulnerableSystemAvailabilityImpact": "A String", # Vulnerable System Availability Impact (VA). Defined in CVSS v4. + "vulnerableSystemConfidentialityImpact": "A String", # Vulnerable System Confidentiality Impact (VC). Defined in CVSS v4. + "vulnerableSystemIntegrityImpact": "A String", # Vulnerable System Integrity Impact (VI). Defined in CVSS v4. }, "cvssVersion": "A String", # Output only. CVSS version used to populate cvss_score and severity. "cvssv3": { # Common Vulnerability Scoring System. For details, see https://www.first.org/cvss/specification-document This is a message we will try to use for storing various versions of CVSS rather than making a separate proto for storing a specific version. # The cvss v3 score for the vulnerability. - "attackComplexity": "A String", - "attackVector": "A String", # Base Metrics Represents the intrinsic characteristics of a vulnerability that are constant over time and across user environments. - "authentication": "A String", - "availabilityImpact": "A String", + "attackComplexity": "A String", # Attack Complexity (AC). Defined in CVSS v2, v3, v4. + "attackRequirements": "A String", # Attack Requirements (AT). Defined in CVSS v4. + "attackVector": "A String", # Attack Vector (AV). Defined in CVSS v2, v3, v4. + "authentication": "A String", # Authentication (Au). Defined in CVSS v2. + "availabilityImpact": "A String", # Availability Impact (A). Defined in CVSS v2, v3. "baseScore": 3.14, # The base score is a function of the base metric scores. - "confidentialityImpact": "A String", + "confidentialityImpact": "A String", # Confidentiality Impact (C). Defined in CVSS v2, v3. "exploitabilityScore": 3.14, "impactScore": 3.14, - "integrityImpact": "A String", - "privilegesRequired": "A String", - "scope": "A String", - "userInteraction": "A String", + "integrityImpact": "A String", # Integrity Impact (I). Defined in CVSS v2, v3. + "privilegesRequired": "A String", # Privileges Required (PR). Defined in CVSS v3, v4. + "scope": "A String", # Scope (S). Defined in CVSS v3. + "subsequentSystemAvailabilityImpact": "A String", # Subsequent System Availability Impact (SA). Defined in CVSS v4. + "subsequentSystemConfidentialityImpact": "A String", # Subsequent System Confidentiality Impact (SC). Defined in CVSS v4. + "subsequentSystemIntegrityImpact": "A String", # Subsequent System Integrity Impact (SI). Defined in CVSS v4. + "userInteraction": "A String", # User Interaction (UI). Defined in CVSS v3, v4. + "vulnerableSystemAvailabilityImpact": "A String", # Vulnerable System Availability Impact (VA). Defined in CVSS v4. + "vulnerableSystemConfidentialityImpact": "A String", # Vulnerable System Confidentiality Impact (VC). Defined in CVSS v4. + "vulnerableSystemIntegrityImpact": "A String", # Vulnerable System Integrity Impact (VI). Defined in CVSS v4. }, "effectiveSeverity": "A String", # The distro assigned severity for this vulnerability when it is available, otherwise this is the note provider assigned severity. When there are multiple PackageIssues for this vulnerability, they can have different effective severities because some might be provided by the distro while others are provided by the language ecosystem for a language pack. For this reason, it is advised to use the effective severity on the PackageIssue level. In the case where multiple PackageIssues have differing effective severities, this field should be the highest severity for any of the PackageIssues. "extraDetails": "A String", # Occurrence-specific extra details about the vulnerability. @@ -4541,33 +4597,47 @@

Method Details

"vulnerability": { # An occurrence of a severity vulnerability on a resource. # Describes a security vulnerability. "cvssScore": 3.14, # Output only. The CVSS score of this vulnerability. CVSS score is on a scale of 0 - 10 where 0 indicates low severity and 10 indicates high severity. "cvssV2": { # Common Vulnerability Scoring System. For details, see https://www.first.org/cvss/specification-document This is a message we will try to use for storing various versions of CVSS rather than making a separate proto for storing a specific version. # The cvss v2 score for the vulnerability. - "attackComplexity": "A String", - "attackVector": "A String", # Base Metrics Represents the intrinsic characteristics of a vulnerability that are constant over time and across user environments. - "authentication": "A String", - "availabilityImpact": "A String", + "attackComplexity": "A String", # Attack Complexity (AC). Defined in CVSS v2, v3, v4. + "attackRequirements": "A String", # Attack Requirements (AT). Defined in CVSS v4. + "attackVector": "A String", # Attack Vector (AV). Defined in CVSS v2, v3, v4. + "authentication": "A String", # Authentication (Au). Defined in CVSS v2. + "availabilityImpact": "A String", # Availability Impact (A). Defined in CVSS v2, v3. "baseScore": 3.14, # The base score is a function of the base metric scores. - "confidentialityImpact": "A String", + "confidentialityImpact": "A String", # Confidentiality Impact (C). Defined in CVSS v2, v3. "exploitabilityScore": 3.14, "impactScore": 3.14, - "integrityImpact": "A String", - "privilegesRequired": "A String", - "scope": "A String", - "userInteraction": "A String", + "integrityImpact": "A String", # Integrity Impact (I). Defined in CVSS v2, v3. + "privilegesRequired": "A String", # Privileges Required (PR). Defined in CVSS v3, v4. + "scope": "A String", # Scope (S). Defined in CVSS v3. + "subsequentSystemAvailabilityImpact": "A String", # Subsequent System Availability Impact (SA). Defined in CVSS v4. + "subsequentSystemConfidentialityImpact": "A String", # Subsequent System Confidentiality Impact (SC). Defined in CVSS v4. + "subsequentSystemIntegrityImpact": "A String", # Subsequent System Integrity Impact (SI). Defined in CVSS v4. + "userInteraction": "A String", # User Interaction (UI). Defined in CVSS v3, v4. + "vulnerableSystemAvailabilityImpact": "A String", # Vulnerable System Availability Impact (VA). Defined in CVSS v4. + "vulnerableSystemConfidentialityImpact": "A String", # Vulnerable System Confidentiality Impact (VC). Defined in CVSS v4. + "vulnerableSystemIntegrityImpact": "A String", # Vulnerable System Integrity Impact (VI). Defined in CVSS v4. }, "cvssVersion": "A String", # Output only. CVSS version used to populate cvss_score and severity. "cvssv3": { # Common Vulnerability Scoring System. For details, see https://www.first.org/cvss/specification-document This is a message we will try to use for storing various versions of CVSS rather than making a separate proto for storing a specific version. # The cvss v3 score for the vulnerability. - "attackComplexity": "A String", - "attackVector": "A String", # Base Metrics Represents the intrinsic characteristics of a vulnerability that are constant over time and across user environments. - "authentication": "A String", - "availabilityImpact": "A String", + "attackComplexity": "A String", # Attack Complexity (AC). Defined in CVSS v2, v3, v4. + "attackRequirements": "A String", # Attack Requirements (AT). Defined in CVSS v4. + "attackVector": "A String", # Attack Vector (AV). Defined in CVSS v2, v3, v4. + "authentication": "A String", # Authentication (Au). Defined in CVSS v2. + "availabilityImpact": "A String", # Availability Impact (A). Defined in CVSS v2, v3. "baseScore": 3.14, # The base score is a function of the base metric scores. - "confidentialityImpact": "A String", + "confidentialityImpact": "A String", # Confidentiality Impact (C). Defined in CVSS v2, v3. "exploitabilityScore": 3.14, "impactScore": 3.14, - "integrityImpact": "A String", - "privilegesRequired": "A String", - "scope": "A String", - "userInteraction": "A String", + "integrityImpact": "A String", # Integrity Impact (I). Defined in CVSS v2, v3. + "privilegesRequired": "A String", # Privileges Required (PR). Defined in CVSS v3, v4. + "scope": "A String", # Scope (S). Defined in CVSS v3. + "subsequentSystemAvailabilityImpact": "A String", # Subsequent System Availability Impact (SA). Defined in CVSS v4. + "subsequentSystemConfidentialityImpact": "A String", # Subsequent System Confidentiality Impact (SC). Defined in CVSS v4. + "subsequentSystemIntegrityImpact": "A String", # Subsequent System Integrity Impact (SI). Defined in CVSS v4. + "userInteraction": "A String", # User Interaction (UI). Defined in CVSS v3, v4. + "vulnerableSystemAvailabilityImpact": "A String", # Vulnerable System Availability Impact (VA). Defined in CVSS v4. + "vulnerableSystemConfidentialityImpact": "A String", # Vulnerable System Confidentiality Impact (VC). Defined in CVSS v4. + "vulnerableSystemIntegrityImpact": "A String", # Vulnerable System Integrity Impact (VI). Defined in CVSS v4. }, "effectiveSeverity": "A String", # The distro assigned severity for this vulnerability when it is available, otherwise this is the note provider assigned severity. When there are multiple PackageIssues for this vulnerability, they can have different effective severities because some might be provided by the distro while others are provided by the language ecosystem for a language pack. For this reason, it is advised to use the effective severity on the PackageIssue level. In the case where multiple PackageIssues have differing effective severities, this field should be the highest severity for any of the PackageIssues. "extraDetails": "A String", # Occurrence-specific extra details about the vulnerability. @@ -4891,18 +4961,25 @@

Method Details

"advisoryPublishTime": "A String", # The time this advisory was published by the source. "cvssScore": 3.14, # The CVSS score of this vulnerability. CVSS score is on a scale of 0 - 10 where 0 indicates low severity and 10 indicates high severity. "cvssV2": { # Common Vulnerability Scoring System. For details, see https://www.first.org/cvss/specification-document This is a message we will try to use for storing various versions of CVSS rather than making a separate proto for storing a specific version. # The full description of the v2 CVSS for this vulnerability. - "attackComplexity": "A String", - "attackVector": "A String", # Base Metrics Represents the intrinsic characteristics of a vulnerability that are constant over time and across user environments. - "authentication": "A String", - "availabilityImpact": "A String", + "attackComplexity": "A String", # Attack Complexity (AC). Defined in CVSS v2, v3, v4. + "attackRequirements": "A String", # Attack Requirements (AT). Defined in CVSS v4. + "attackVector": "A String", # Attack Vector (AV). Defined in CVSS v2, v3, v4. + "authentication": "A String", # Authentication (Au). Defined in CVSS v2. + "availabilityImpact": "A String", # Availability Impact (A). Defined in CVSS v2, v3. "baseScore": 3.14, # The base score is a function of the base metric scores. - "confidentialityImpact": "A String", + "confidentialityImpact": "A String", # Confidentiality Impact (C). Defined in CVSS v2, v3. "exploitabilityScore": 3.14, "impactScore": 3.14, - "integrityImpact": "A String", - "privilegesRequired": "A String", - "scope": "A String", - "userInteraction": "A String", + "integrityImpact": "A String", # Integrity Impact (I). Defined in CVSS v2, v3. + "privilegesRequired": "A String", # Privileges Required (PR). Defined in CVSS v3, v4. + "scope": "A String", # Scope (S). Defined in CVSS v3. + "subsequentSystemAvailabilityImpact": "A String", # Subsequent System Availability Impact (SA). Defined in CVSS v4. + "subsequentSystemConfidentialityImpact": "A String", # Subsequent System Confidentiality Impact (SC). Defined in CVSS v4. + "subsequentSystemIntegrityImpact": "A String", # Subsequent System Integrity Impact (SI). Defined in CVSS v4. + "userInteraction": "A String", # User Interaction (UI). Defined in CVSS v3, v4. + "vulnerableSystemAvailabilityImpact": "A String", # Vulnerable System Availability Impact (VA). Defined in CVSS v4. + "vulnerableSystemConfidentialityImpact": "A String", # Vulnerable System Confidentiality Impact (VC). Defined in CVSS v4. + "vulnerableSystemIntegrityImpact": "A String", # Vulnerable System Integrity Impact (VI). Defined in CVSS v4. }, "cvssV3": { # Common Vulnerability Scoring System version 3. For details, see https://www.first.org/cvss/specification-document # The full description of the CVSSv3 for this vulnerability. "attackComplexity": "A String", @@ -5840,33 +5917,47 @@

Method Details

"vulnerability": { # An occurrence of a severity vulnerability on a resource. # Describes a security vulnerability. "cvssScore": 3.14, # Output only. The CVSS score of this vulnerability. CVSS score is on a scale of 0 - 10 where 0 indicates low severity and 10 indicates high severity. "cvssV2": { # Common Vulnerability Scoring System. For details, see https://www.first.org/cvss/specification-document This is a message we will try to use for storing various versions of CVSS rather than making a separate proto for storing a specific version. # The cvss v2 score for the vulnerability. - "attackComplexity": "A String", - "attackVector": "A String", # Base Metrics Represents the intrinsic characteristics of a vulnerability that are constant over time and across user environments. - "authentication": "A String", - "availabilityImpact": "A String", + "attackComplexity": "A String", # Attack Complexity (AC). Defined in CVSS v2, v3, v4. + "attackRequirements": "A String", # Attack Requirements (AT). Defined in CVSS v4. + "attackVector": "A String", # Attack Vector (AV). Defined in CVSS v2, v3, v4. + "authentication": "A String", # Authentication (Au). Defined in CVSS v2. + "availabilityImpact": "A String", # Availability Impact (A). Defined in CVSS v2, v3. "baseScore": 3.14, # The base score is a function of the base metric scores. - "confidentialityImpact": "A String", + "confidentialityImpact": "A String", # Confidentiality Impact (C). Defined in CVSS v2, v3. "exploitabilityScore": 3.14, "impactScore": 3.14, - "integrityImpact": "A String", - "privilegesRequired": "A String", - "scope": "A String", - "userInteraction": "A String", + "integrityImpact": "A String", # Integrity Impact (I). Defined in CVSS v2, v3. + "privilegesRequired": "A String", # Privileges Required (PR). Defined in CVSS v3, v4. + "scope": "A String", # Scope (S). Defined in CVSS v3. + "subsequentSystemAvailabilityImpact": "A String", # Subsequent System Availability Impact (SA). Defined in CVSS v4. + "subsequentSystemConfidentialityImpact": "A String", # Subsequent System Confidentiality Impact (SC). Defined in CVSS v4. + "subsequentSystemIntegrityImpact": "A String", # Subsequent System Integrity Impact (SI). Defined in CVSS v4. + "userInteraction": "A String", # User Interaction (UI). Defined in CVSS v3, v4. + "vulnerableSystemAvailabilityImpact": "A String", # Vulnerable System Availability Impact (VA). Defined in CVSS v4. + "vulnerableSystemConfidentialityImpact": "A String", # Vulnerable System Confidentiality Impact (VC). Defined in CVSS v4. + "vulnerableSystemIntegrityImpact": "A String", # Vulnerable System Integrity Impact (VI). Defined in CVSS v4. }, "cvssVersion": "A String", # Output only. CVSS version used to populate cvss_score and severity. "cvssv3": { # Common Vulnerability Scoring System. For details, see https://www.first.org/cvss/specification-document This is a message we will try to use for storing various versions of CVSS rather than making a separate proto for storing a specific version. # The cvss v3 score for the vulnerability. - "attackComplexity": "A String", - "attackVector": "A String", # Base Metrics Represents the intrinsic characteristics of a vulnerability that are constant over time and across user environments. - "authentication": "A String", - "availabilityImpact": "A String", + "attackComplexity": "A String", # Attack Complexity (AC). Defined in CVSS v2, v3, v4. + "attackRequirements": "A String", # Attack Requirements (AT). Defined in CVSS v4. + "attackVector": "A String", # Attack Vector (AV). Defined in CVSS v2, v3, v4. + "authentication": "A String", # Authentication (Au). Defined in CVSS v2. + "availabilityImpact": "A String", # Availability Impact (A). Defined in CVSS v2, v3. "baseScore": 3.14, # The base score is a function of the base metric scores. - "confidentialityImpact": "A String", + "confidentialityImpact": "A String", # Confidentiality Impact (C). Defined in CVSS v2, v3. "exploitabilityScore": 3.14, "impactScore": 3.14, - "integrityImpact": "A String", - "privilegesRequired": "A String", - "scope": "A String", - "userInteraction": "A String", + "integrityImpact": "A String", # Integrity Impact (I). Defined in CVSS v2, v3. + "privilegesRequired": "A String", # Privileges Required (PR). Defined in CVSS v3, v4. + "scope": "A String", # Scope (S). Defined in CVSS v3. + "subsequentSystemAvailabilityImpact": "A String", # Subsequent System Availability Impact (SA). Defined in CVSS v4. + "subsequentSystemConfidentialityImpact": "A String", # Subsequent System Confidentiality Impact (SC). Defined in CVSS v4. + "subsequentSystemIntegrityImpact": "A String", # Subsequent System Integrity Impact (SI). Defined in CVSS v4. + "userInteraction": "A String", # User Interaction (UI). Defined in CVSS v3, v4. + "vulnerableSystemAvailabilityImpact": "A String", # Vulnerable System Availability Impact (VA). Defined in CVSS v4. + "vulnerableSystemConfidentialityImpact": "A String", # Vulnerable System Confidentiality Impact (VC). Defined in CVSS v4. + "vulnerableSystemIntegrityImpact": "A String", # Vulnerable System Integrity Impact (VI). Defined in CVSS v4. }, "effectiveSeverity": "A String", # The distro assigned severity for this vulnerability when it is available, otherwise this is the note provider assigned severity. When there are multiple PackageIssues for this vulnerability, they can have different effective severities because some might be provided by the distro while others are provided by the language ecosystem for a language pack. For this reason, it is advised to use the effective severity on the PackageIssue level. In the case where multiple PackageIssues have differing effective severities, this field should be the highest severity for any of the PackageIssues. "extraDetails": "A String", # Occurrence-specific extra details about the vulnerability. @@ -6764,33 +6855,47 @@

Method Details

"vulnerability": { # An occurrence of a severity vulnerability on a resource. # Describes a security vulnerability. "cvssScore": 3.14, # Output only. The CVSS score of this vulnerability. CVSS score is on a scale of 0 - 10 where 0 indicates low severity and 10 indicates high severity. "cvssV2": { # Common Vulnerability Scoring System. For details, see https://www.first.org/cvss/specification-document This is a message we will try to use for storing various versions of CVSS rather than making a separate proto for storing a specific version. # The cvss v2 score for the vulnerability. - "attackComplexity": "A String", - "attackVector": "A String", # Base Metrics Represents the intrinsic characteristics of a vulnerability that are constant over time and across user environments. - "authentication": "A String", - "availabilityImpact": "A String", + "attackComplexity": "A String", # Attack Complexity (AC). Defined in CVSS v2, v3, v4. + "attackRequirements": "A String", # Attack Requirements (AT). Defined in CVSS v4. + "attackVector": "A String", # Attack Vector (AV). Defined in CVSS v2, v3, v4. + "authentication": "A String", # Authentication (Au). Defined in CVSS v2. + "availabilityImpact": "A String", # Availability Impact (A). Defined in CVSS v2, v3. "baseScore": 3.14, # The base score is a function of the base metric scores. - "confidentialityImpact": "A String", + "confidentialityImpact": "A String", # Confidentiality Impact (C). Defined in CVSS v2, v3. "exploitabilityScore": 3.14, "impactScore": 3.14, - "integrityImpact": "A String", - "privilegesRequired": "A String", - "scope": "A String", - "userInteraction": "A String", + "integrityImpact": "A String", # Integrity Impact (I). Defined in CVSS v2, v3. + "privilegesRequired": "A String", # Privileges Required (PR). Defined in CVSS v3, v4. + "scope": "A String", # Scope (S). Defined in CVSS v3. + "subsequentSystemAvailabilityImpact": "A String", # Subsequent System Availability Impact (SA). Defined in CVSS v4. + "subsequentSystemConfidentialityImpact": "A String", # Subsequent System Confidentiality Impact (SC). Defined in CVSS v4. + "subsequentSystemIntegrityImpact": "A String", # Subsequent System Integrity Impact (SI). Defined in CVSS v4. + "userInteraction": "A String", # User Interaction (UI). Defined in CVSS v3, v4. + "vulnerableSystemAvailabilityImpact": "A String", # Vulnerable System Availability Impact (VA). Defined in CVSS v4. + "vulnerableSystemConfidentialityImpact": "A String", # Vulnerable System Confidentiality Impact (VC). Defined in CVSS v4. + "vulnerableSystemIntegrityImpact": "A String", # Vulnerable System Integrity Impact (VI). Defined in CVSS v4. }, "cvssVersion": "A String", # Output only. CVSS version used to populate cvss_score and severity. "cvssv3": { # Common Vulnerability Scoring System. For details, see https://www.first.org/cvss/specification-document This is a message we will try to use for storing various versions of CVSS rather than making a separate proto for storing a specific version. # The cvss v3 score for the vulnerability. - "attackComplexity": "A String", - "attackVector": "A String", # Base Metrics Represents the intrinsic characteristics of a vulnerability that are constant over time and across user environments. - "authentication": "A String", - "availabilityImpact": "A String", + "attackComplexity": "A String", # Attack Complexity (AC). Defined in CVSS v2, v3, v4. + "attackRequirements": "A String", # Attack Requirements (AT). Defined in CVSS v4. + "attackVector": "A String", # Attack Vector (AV). Defined in CVSS v2, v3, v4. + "authentication": "A String", # Authentication (Au). Defined in CVSS v2. + "availabilityImpact": "A String", # Availability Impact (A). Defined in CVSS v2, v3. "baseScore": 3.14, # The base score is a function of the base metric scores. - "confidentialityImpact": "A String", + "confidentialityImpact": "A String", # Confidentiality Impact (C). Defined in CVSS v2, v3. "exploitabilityScore": 3.14, "impactScore": 3.14, - "integrityImpact": "A String", - "privilegesRequired": "A String", - "scope": "A String", - "userInteraction": "A String", + "integrityImpact": "A String", # Integrity Impact (I). Defined in CVSS v2, v3. + "privilegesRequired": "A String", # Privileges Required (PR). Defined in CVSS v3, v4. + "scope": "A String", # Scope (S). Defined in CVSS v3. + "subsequentSystemAvailabilityImpact": "A String", # Subsequent System Availability Impact (SA). Defined in CVSS v4. + "subsequentSystemConfidentialityImpact": "A String", # Subsequent System Confidentiality Impact (SC). Defined in CVSS v4. + "subsequentSystemIntegrityImpact": "A String", # Subsequent System Integrity Impact (SI). Defined in CVSS v4. + "userInteraction": "A String", # User Interaction (UI). Defined in CVSS v3, v4. + "vulnerableSystemAvailabilityImpact": "A String", # Vulnerable System Availability Impact (VA). Defined in CVSS v4. + "vulnerableSystemConfidentialityImpact": "A String", # Vulnerable System Confidentiality Impact (VC). Defined in CVSS v4. + "vulnerableSystemIntegrityImpact": "A String", # Vulnerable System Integrity Impact (VI). Defined in CVSS v4. }, "effectiveSeverity": "A String", # The distro assigned severity for this vulnerability when it is available, otherwise this is the note provider assigned severity. When there are multiple PackageIssues for this vulnerability, they can have different effective severities because some might be provided by the distro while others are provided by the language ecosystem for a language pack. For this reason, it is advised to use the effective severity on the PackageIssue level. In the case where multiple PackageIssues have differing effective severities, this field should be the highest severity for any of the PackageIssues. "extraDetails": "A String", # Occurrence-specific extra details about the vulnerability. @@ -7668,33 +7773,47 @@

Method Details

"vulnerability": { # An occurrence of a severity vulnerability on a resource. # Describes a security vulnerability. "cvssScore": 3.14, # Output only. The CVSS score of this vulnerability. CVSS score is on a scale of 0 - 10 where 0 indicates low severity and 10 indicates high severity. "cvssV2": { # Common Vulnerability Scoring System. For details, see https://www.first.org/cvss/specification-document This is a message we will try to use for storing various versions of CVSS rather than making a separate proto for storing a specific version. # The cvss v2 score for the vulnerability. - "attackComplexity": "A String", - "attackVector": "A String", # Base Metrics Represents the intrinsic characteristics of a vulnerability that are constant over time and across user environments. - "authentication": "A String", - "availabilityImpact": "A String", + "attackComplexity": "A String", # Attack Complexity (AC). Defined in CVSS v2, v3, v4. + "attackRequirements": "A String", # Attack Requirements (AT). Defined in CVSS v4. + "attackVector": "A String", # Attack Vector (AV). Defined in CVSS v2, v3, v4. + "authentication": "A String", # Authentication (Au). Defined in CVSS v2. + "availabilityImpact": "A String", # Availability Impact (A). Defined in CVSS v2, v3. "baseScore": 3.14, # The base score is a function of the base metric scores. - "confidentialityImpact": "A String", + "confidentialityImpact": "A String", # Confidentiality Impact (C). Defined in CVSS v2, v3. "exploitabilityScore": 3.14, "impactScore": 3.14, - "integrityImpact": "A String", - "privilegesRequired": "A String", - "scope": "A String", - "userInteraction": "A String", + "integrityImpact": "A String", # Integrity Impact (I). Defined in CVSS v2, v3. + "privilegesRequired": "A String", # Privileges Required (PR). Defined in CVSS v3, v4. + "scope": "A String", # Scope (S). Defined in CVSS v3. + "subsequentSystemAvailabilityImpact": "A String", # Subsequent System Availability Impact (SA). Defined in CVSS v4. + "subsequentSystemConfidentialityImpact": "A String", # Subsequent System Confidentiality Impact (SC). Defined in CVSS v4. + "subsequentSystemIntegrityImpact": "A String", # Subsequent System Integrity Impact (SI). Defined in CVSS v4. + "userInteraction": "A String", # User Interaction (UI). Defined in CVSS v3, v4. + "vulnerableSystemAvailabilityImpact": "A String", # Vulnerable System Availability Impact (VA). Defined in CVSS v4. + "vulnerableSystemConfidentialityImpact": "A String", # Vulnerable System Confidentiality Impact (VC). Defined in CVSS v4. + "vulnerableSystemIntegrityImpact": "A String", # Vulnerable System Integrity Impact (VI). Defined in CVSS v4. }, "cvssVersion": "A String", # Output only. CVSS version used to populate cvss_score and severity. "cvssv3": { # Common Vulnerability Scoring System. For details, see https://www.first.org/cvss/specification-document This is a message we will try to use for storing various versions of CVSS rather than making a separate proto for storing a specific version. # The cvss v3 score for the vulnerability. - "attackComplexity": "A String", - "attackVector": "A String", # Base Metrics Represents the intrinsic characteristics of a vulnerability that are constant over time and across user environments. - "authentication": "A String", - "availabilityImpact": "A String", + "attackComplexity": "A String", # Attack Complexity (AC). Defined in CVSS v2, v3, v4. + "attackRequirements": "A String", # Attack Requirements (AT). Defined in CVSS v4. + "attackVector": "A String", # Attack Vector (AV). Defined in CVSS v2, v3, v4. + "authentication": "A String", # Authentication (Au). Defined in CVSS v2. + "availabilityImpact": "A String", # Availability Impact (A). Defined in CVSS v2, v3. "baseScore": 3.14, # The base score is a function of the base metric scores. - "confidentialityImpact": "A String", + "confidentialityImpact": "A String", # Confidentiality Impact (C). Defined in CVSS v2, v3. "exploitabilityScore": 3.14, "impactScore": 3.14, - "integrityImpact": "A String", - "privilegesRequired": "A String", - "scope": "A String", - "userInteraction": "A String", + "integrityImpact": "A String", # Integrity Impact (I). Defined in CVSS v2, v3. + "privilegesRequired": "A String", # Privileges Required (PR). Defined in CVSS v3, v4. + "scope": "A String", # Scope (S). Defined in CVSS v3. + "subsequentSystemAvailabilityImpact": "A String", # Subsequent System Availability Impact (SA). Defined in CVSS v4. + "subsequentSystemConfidentialityImpact": "A String", # Subsequent System Confidentiality Impact (SC). Defined in CVSS v4. + "subsequentSystemIntegrityImpact": "A String", # Subsequent System Integrity Impact (SI). Defined in CVSS v4. + "userInteraction": "A String", # User Interaction (UI). Defined in CVSS v3, v4. + "vulnerableSystemAvailabilityImpact": "A String", # Vulnerable System Availability Impact (VA). Defined in CVSS v4. + "vulnerableSystemConfidentialityImpact": "A String", # Vulnerable System Confidentiality Impact (VC). Defined in CVSS v4. + "vulnerableSystemIntegrityImpact": "A String", # Vulnerable System Integrity Impact (VI). Defined in CVSS v4. }, "effectiveSeverity": "A String", # The distro assigned severity for this vulnerability when it is available, otherwise this is the note provider assigned severity. When there are multiple PackageIssues for this vulnerability, they can have different effective severities because some might be provided by the distro while others are provided by the language ecosystem for a language pack. For this reason, it is advised to use the effective severity on the PackageIssue level. In the case where multiple PackageIssues have differing effective severities, this field should be the highest severity for any of the PackageIssues. "extraDetails": "A String", # Occurrence-specific extra details about the vulnerability. diff --git a/docs/dyn/containeranalysis_v1.projects.notes.html b/docs/dyn/containeranalysis_v1.projects.notes.html index 79d5c93d89..116148afea 100644 --- a/docs/dyn/containeranalysis_v1.projects.notes.html +++ b/docs/dyn/containeranalysis_v1.projects.notes.html @@ -287,18 +287,25 @@

Method Details

"advisoryPublishTime": "A String", # The time this advisory was published by the source. "cvssScore": 3.14, # The CVSS score of this vulnerability. CVSS score is on a scale of 0 - 10 where 0 indicates low severity and 10 indicates high severity. "cvssV2": { # Common Vulnerability Scoring System. For details, see https://www.first.org/cvss/specification-document This is a message we will try to use for storing various versions of CVSS rather than making a separate proto for storing a specific version. # The full description of the v2 CVSS for this vulnerability. - "attackComplexity": "A String", - "attackVector": "A String", # Base Metrics Represents the intrinsic characteristics of a vulnerability that are constant over time and across user environments. - "authentication": "A String", - "availabilityImpact": "A String", + "attackComplexity": "A String", # Attack Complexity (AC). Defined in CVSS v2, v3, v4. + "attackRequirements": "A String", # Attack Requirements (AT). Defined in CVSS v4. + "attackVector": "A String", # Attack Vector (AV). Defined in CVSS v2, v3, v4. + "authentication": "A String", # Authentication (Au). Defined in CVSS v2. + "availabilityImpact": "A String", # Availability Impact (A). Defined in CVSS v2, v3. "baseScore": 3.14, # The base score is a function of the base metric scores. - "confidentialityImpact": "A String", + "confidentialityImpact": "A String", # Confidentiality Impact (C). Defined in CVSS v2, v3. "exploitabilityScore": 3.14, "impactScore": 3.14, - "integrityImpact": "A String", - "privilegesRequired": "A String", - "scope": "A String", - "userInteraction": "A String", + "integrityImpact": "A String", # Integrity Impact (I). Defined in CVSS v2, v3. + "privilegesRequired": "A String", # Privileges Required (PR). Defined in CVSS v3, v4. + "scope": "A String", # Scope (S). Defined in CVSS v3. + "subsequentSystemAvailabilityImpact": "A String", # Subsequent System Availability Impact (SA). Defined in CVSS v4. + "subsequentSystemConfidentialityImpact": "A String", # Subsequent System Confidentiality Impact (SC). Defined in CVSS v4. + "subsequentSystemIntegrityImpact": "A String", # Subsequent System Integrity Impact (SI). Defined in CVSS v4. + "userInteraction": "A String", # User Interaction (UI). Defined in CVSS v3, v4. + "vulnerableSystemAvailabilityImpact": "A String", # Vulnerable System Availability Impact (VA). Defined in CVSS v4. + "vulnerableSystemConfidentialityImpact": "A String", # Vulnerable System Confidentiality Impact (VC). Defined in CVSS v4. + "vulnerableSystemIntegrityImpact": "A String", # Vulnerable System Integrity Impact (VI). Defined in CVSS v4. }, "cvssV3": { # Common Vulnerability Scoring System version 3. For details, see https://www.first.org/cvss/specification-document # The full description of the CVSSv3 for this vulnerability. "attackComplexity": "A String", @@ -592,18 +599,25 @@

Method Details

"advisoryPublishTime": "A String", # The time this advisory was published by the source. "cvssScore": 3.14, # The CVSS score of this vulnerability. CVSS score is on a scale of 0 - 10 where 0 indicates low severity and 10 indicates high severity. "cvssV2": { # Common Vulnerability Scoring System. For details, see https://www.first.org/cvss/specification-document This is a message we will try to use for storing various versions of CVSS rather than making a separate proto for storing a specific version. # The full description of the v2 CVSS for this vulnerability. - "attackComplexity": "A String", - "attackVector": "A String", # Base Metrics Represents the intrinsic characteristics of a vulnerability that are constant over time and across user environments. - "authentication": "A String", - "availabilityImpact": "A String", + "attackComplexity": "A String", # Attack Complexity (AC). Defined in CVSS v2, v3, v4. + "attackRequirements": "A String", # Attack Requirements (AT). Defined in CVSS v4. + "attackVector": "A String", # Attack Vector (AV). Defined in CVSS v2, v3, v4. + "authentication": "A String", # Authentication (Au). Defined in CVSS v2. + "availabilityImpact": "A String", # Availability Impact (A). Defined in CVSS v2, v3. "baseScore": 3.14, # The base score is a function of the base metric scores. - "confidentialityImpact": "A String", + "confidentialityImpact": "A String", # Confidentiality Impact (C). Defined in CVSS v2, v3. "exploitabilityScore": 3.14, "impactScore": 3.14, - "integrityImpact": "A String", - "privilegesRequired": "A String", - "scope": "A String", - "userInteraction": "A String", + "integrityImpact": "A String", # Integrity Impact (I). Defined in CVSS v2, v3. + "privilegesRequired": "A String", # Privileges Required (PR). Defined in CVSS v3, v4. + "scope": "A String", # Scope (S). Defined in CVSS v3. + "subsequentSystemAvailabilityImpact": "A String", # Subsequent System Availability Impact (SA). Defined in CVSS v4. + "subsequentSystemConfidentialityImpact": "A String", # Subsequent System Confidentiality Impact (SC). Defined in CVSS v4. + "subsequentSystemIntegrityImpact": "A String", # Subsequent System Integrity Impact (SI). Defined in CVSS v4. + "userInteraction": "A String", # User Interaction (UI). Defined in CVSS v3, v4. + "vulnerableSystemAvailabilityImpact": "A String", # Vulnerable System Availability Impact (VA). Defined in CVSS v4. + "vulnerableSystemConfidentialityImpact": "A String", # Vulnerable System Confidentiality Impact (VC). Defined in CVSS v4. + "vulnerableSystemIntegrityImpact": "A String", # Vulnerable System Integrity Impact (VI). Defined in CVSS v4. }, "cvssV3": { # Common Vulnerability Scoring System version 3. For details, see https://www.first.org/cvss/specification-document # The full description of the CVSSv3 for this vulnerability. "attackComplexity": "A String", @@ -902,18 +916,25 @@

Method Details

"advisoryPublishTime": "A String", # The time this advisory was published by the source. "cvssScore": 3.14, # The CVSS score of this vulnerability. CVSS score is on a scale of 0 - 10 where 0 indicates low severity and 10 indicates high severity. "cvssV2": { # Common Vulnerability Scoring System. For details, see https://www.first.org/cvss/specification-document This is a message we will try to use for storing various versions of CVSS rather than making a separate proto for storing a specific version. # The full description of the v2 CVSS for this vulnerability. - "attackComplexity": "A String", - "attackVector": "A String", # Base Metrics Represents the intrinsic characteristics of a vulnerability that are constant over time and across user environments. - "authentication": "A String", - "availabilityImpact": "A String", + "attackComplexity": "A String", # Attack Complexity (AC). Defined in CVSS v2, v3, v4. + "attackRequirements": "A String", # Attack Requirements (AT). Defined in CVSS v4. + "attackVector": "A String", # Attack Vector (AV). Defined in CVSS v2, v3, v4. + "authentication": "A String", # Authentication (Au). Defined in CVSS v2. + "availabilityImpact": "A String", # Availability Impact (A). Defined in CVSS v2, v3. "baseScore": 3.14, # The base score is a function of the base metric scores. - "confidentialityImpact": "A String", + "confidentialityImpact": "A String", # Confidentiality Impact (C). Defined in CVSS v2, v3. "exploitabilityScore": 3.14, "impactScore": 3.14, - "integrityImpact": "A String", - "privilegesRequired": "A String", - "scope": "A String", - "userInteraction": "A String", + "integrityImpact": "A String", # Integrity Impact (I). Defined in CVSS v2, v3. + "privilegesRequired": "A String", # Privileges Required (PR). Defined in CVSS v3, v4. + "scope": "A String", # Scope (S). Defined in CVSS v3. + "subsequentSystemAvailabilityImpact": "A String", # Subsequent System Availability Impact (SA). Defined in CVSS v4. + "subsequentSystemConfidentialityImpact": "A String", # Subsequent System Confidentiality Impact (SC). Defined in CVSS v4. + "subsequentSystemIntegrityImpact": "A String", # Subsequent System Integrity Impact (SI). Defined in CVSS v4. + "userInteraction": "A String", # User Interaction (UI). Defined in CVSS v3, v4. + "vulnerableSystemAvailabilityImpact": "A String", # Vulnerable System Availability Impact (VA). Defined in CVSS v4. + "vulnerableSystemConfidentialityImpact": "A String", # Vulnerable System Confidentiality Impact (VC). Defined in CVSS v4. + "vulnerableSystemIntegrityImpact": "A String", # Vulnerable System Integrity Impact (VI). Defined in CVSS v4. }, "cvssV3": { # Common Vulnerability Scoring System version 3. For details, see https://www.first.org/cvss/specification-document # The full description of the CVSSv3 for this vulnerability. "attackComplexity": "A String", @@ -1204,18 +1225,25 @@

Method Details

"advisoryPublishTime": "A String", # The time this advisory was published by the source. "cvssScore": 3.14, # The CVSS score of this vulnerability. CVSS score is on a scale of 0 - 10 where 0 indicates low severity and 10 indicates high severity. "cvssV2": { # Common Vulnerability Scoring System. For details, see https://www.first.org/cvss/specification-document This is a message we will try to use for storing various versions of CVSS rather than making a separate proto for storing a specific version. # The full description of the v2 CVSS for this vulnerability. - "attackComplexity": "A String", - "attackVector": "A String", # Base Metrics Represents the intrinsic characteristics of a vulnerability that are constant over time and across user environments. - "authentication": "A String", - "availabilityImpact": "A String", + "attackComplexity": "A String", # Attack Complexity (AC). Defined in CVSS v2, v3, v4. + "attackRequirements": "A String", # Attack Requirements (AT). Defined in CVSS v4. + "attackVector": "A String", # Attack Vector (AV). Defined in CVSS v2, v3, v4. + "authentication": "A String", # Authentication (Au). Defined in CVSS v2. + "availabilityImpact": "A String", # Availability Impact (A). Defined in CVSS v2, v3. "baseScore": 3.14, # The base score is a function of the base metric scores. - "confidentialityImpact": "A String", + "confidentialityImpact": "A String", # Confidentiality Impact (C). Defined in CVSS v2, v3. "exploitabilityScore": 3.14, "impactScore": 3.14, - "integrityImpact": "A String", - "privilegesRequired": "A String", - "scope": "A String", - "userInteraction": "A String", + "integrityImpact": "A String", # Integrity Impact (I). Defined in CVSS v2, v3. + "privilegesRequired": "A String", # Privileges Required (PR). Defined in CVSS v3, v4. + "scope": "A String", # Scope (S). Defined in CVSS v3. + "subsequentSystemAvailabilityImpact": "A String", # Subsequent System Availability Impact (SA). Defined in CVSS v4. + "subsequentSystemConfidentialityImpact": "A String", # Subsequent System Confidentiality Impact (SC). Defined in CVSS v4. + "subsequentSystemIntegrityImpact": "A String", # Subsequent System Integrity Impact (SI). Defined in CVSS v4. + "userInteraction": "A String", # User Interaction (UI). Defined in CVSS v3, v4. + "vulnerableSystemAvailabilityImpact": "A String", # Vulnerable System Availability Impact (VA). Defined in CVSS v4. + "vulnerableSystemConfidentialityImpact": "A String", # Vulnerable System Confidentiality Impact (VC). Defined in CVSS v4. + "vulnerableSystemIntegrityImpact": "A String", # Vulnerable System Integrity Impact (VI). Defined in CVSS v4. }, "cvssV3": { # Common Vulnerability Scoring System version 3. For details, see https://www.first.org/cvss/specification-document # The full description of the CVSSv3 for this vulnerability. "attackComplexity": "A String", @@ -1530,18 +1558,25 @@

Method Details

"advisoryPublishTime": "A String", # The time this advisory was published by the source. "cvssScore": 3.14, # The CVSS score of this vulnerability. CVSS score is on a scale of 0 - 10 where 0 indicates low severity and 10 indicates high severity. "cvssV2": { # Common Vulnerability Scoring System. For details, see https://www.first.org/cvss/specification-document This is a message we will try to use for storing various versions of CVSS rather than making a separate proto for storing a specific version. # The full description of the v2 CVSS for this vulnerability. - "attackComplexity": "A String", - "attackVector": "A String", # Base Metrics Represents the intrinsic characteristics of a vulnerability that are constant over time and across user environments. - "authentication": "A String", - "availabilityImpact": "A String", + "attackComplexity": "A String", # Attack Complexity (AC). Defined in CVSS v2, v3, v4. + "attackRequirements": "A String", # Attack Requirements (AT). Defined in CVSS v4. + "attackVector": "A String", # Attack Vector (AV). Defined in CVSS v2, v3, v4. + "authentication": "A String", # Authentication (Au). Defined in CVSS v2. + "availabilityImpact": "A String", # Availability Impact (A). Defined in CVSS v2, v3. "baseScore": 3.14, # The base score is a function of the base metric scores. - "confidentialityImpact": "A String", + "confidentialityImpact": "A String", # Confidentiality Impact (C). Defined in CVSS v2, v3. "exploitabilityScore": 3.14, "impactScore": 3.14, - "integrityImpact": "A String", - "privilegesRequired": "A String", - "scope": "A String", - "userInteraction": "A String", + "integrityImpact": "A String", # Integrity Impact (I). Defined in CVSS v2, v3. + "privilegesRequired": "A String", # Privileges Required (PR). Defined in CVSS v3, v4. + "scope": "A String", # Scope (S). Defined in CVSS v3. + "subsequentSystemAvailabilityImpact": "A String", # Subsequent System Availability Impact (SA). Defined in CVSS v4. + "subsequentSystemConfidentialityImpact": "A String", # Subsequent System Confidentiality Impact (SC). Defined in CVSS v4. + "subsequentSystemIntegrityImpact": "A String", # Subsequent System Integrity Impact (SI). Defined in CVSS v4. + "userInteraction": "A String", # User Interaction (UI). Defined in CVSS v3, v4. + "vulnerableSystemAvailabilityImpact": "A String", # Vulnerable System Availability Impact (VA). Defined in CVSS v4. + "vulnerableSystemConfidentialityImpact": "A String", # Vulnerable System Confidentiality Impact (VC). Defined in CVSS v4. + "vulnerableSystemIntegrityImpact": "A String", # Vulnerable System Integrity Impact (VI). Defined in CVSS v4. }, "cvssV3": { # Common Vulnerability Scoring System version 3. For details, see https://www.first.org/cvss/specification-document # The full description of the CVSSv3 for this vulnerability. "attackComplexity": "A String", @@ -1888,18 +1923,25 @@

Method Details

"advisoryPublishTime": "A String", # The time this advisory was published by the source. "cvssScore": 3.14, # The CVSS score of this vulnerability. CVSS score is on a scale of 0 - 10 where 0 indicates low severity and 10 indicates high severity. "cvssV2": { # Common Vulnerability Scoring System. For details, see https://www.first.org/cvss/specification-document This is a message we will try to use for storing various versions of CVSS rather than making a separate proto for storing a specific version. # The full description of the v2 CVSS for this vulnerability. - "attackComplexity": "A String", - "attackVector": "A String", # Base Metrics Represents the intrinsic characteristics of a vulnerability that are constant over time and across user environments. - "authentication": "A String", - "availabilityImpact": "A String", + "attackComplexity": "A String", # Attack Complexity (AC). Defined in CVSS v2, v3, v4. + "attackRequirements": "A String", # Attack Requirements (AT). Defined in CVSS v4. + "attackVector": "A String", # Attack Vector (AV). Defined in CVSS v2, v3, v4. + "authentication": "A String", # Authentication (Au). Defined in CVSS v2. + "availabilityImpact": "A String", # Availability Impact (A). Defined in CVSS v2, v3. "baseScore": 3.14, # The base score is a function of the base metric scores. - "confidentialityImpact": "A String", + "confidentialityImpact": "A String", # Confidentiality Impact (C). Defined in CVSS v2, v3. "exploitabilityScore": 3.14, "impactScore": 3.14, - "integrityImpact": "A String", - "privilegesRequired": "A String", - "scope": "A String", - "userInteraction": "A String", + "integrityImpact": "A String", # Integrity Impact (I). Defined in CVSS v2, v3. + "privilegesRequired": "A String", # Privileges Required (PR). Defined in CVSS v3, v4. + "scope": "A String", # Scope (S). Defined in CVSS v3. + "subsequentSystemAvailabilityImpact": "A String", # Subsequent System Availability Impact (SA). Defined in CVSS v4. + "subsequentSystemConfidentialityImpact": "A String", # Subsequent System Confidentiality Impact (SC). Defined in CVSS v4. + "subsequentSystemIntegrityImpact": "A String", # Subsequent System Integrity Impact (SI). Defined in CVSS v4. + "userInteraction": "A String", # User Interaction (UI). Defined in CVSS v3, v4. + "vulnerableSystemAvailabilityImpact": "A String", # Vulnerable System Availability Impact (VA). Defined in CVSS v4. + "vulnerableSystemConfidentialityImpact": "A String", # Vulnerable System Confidentiality Impact (VC). Defined in CVSS v4. + "vulnerableSystemIntegrityImpact": "A String", # Vulnerable System Integrity Impact (VI). Defined in CVSS v4. }, "cvssV3": { # Common Vulnerability Scoring System version 3. For details, see https://www.first.org/cvss/specification-document # The full description of the CVSSv3 for this vulnerability. "attackComplexity": "A String", @@ -2210,18 +2252,25 @@

Method Details

"advisoryPublishTime": "A String", # The time this advisory was published by the source. "cvssScore": 3.14, # The CVSS score of this vulnerability. CVSS score is on a scale of 0 - 10 where 0 indicates low severity and 10 indicates high severity. "cvssV2": { # Common Vulnerability Scoring System. For details, see https://www.first.org/cvss/specification-document This is a message we will try to use for storing various versions of CVSS rather than making a separate proto for storing a specific version. # The full description of the v2 CVSS for this vulnerability. - "attackComplexity": "A String", - "attackVector": "A String", # Base Metrics Represents the intrinsic characteristics of a vulnerability that are constant over time and across user environments. - "authentication": "A String", - "availabilityImpact": "A String", + "attackComplexity": "A String", # Attack Complexity (AC). Defined in CVSS v2, v3, v4. + "attackRequirements": "A String", # Attack Requirements (AT). Defined in CVSS v4. + "attackVector": "A String", # Attack Vector (AV). Defined in CVSS v2, v3, v4. + "authentication": "A String", # Authentication (Au). Defined in CVSS v2. + "availabilityImpact": "A String", # Availability Impact (A). Defined in CVSS v2, v3. "baseScore": 3.14, # The base score is a function of the base metric scores. - "confidentialityImpact": "A String", + "confidentialityImpact": "A String", # Confidentiality Impact (C). Defined in CVSS v2, v3. "exploitabilityScore": 3.14, "impactScore": 3.14, - "integrityImpact": "A String", - "privilegesRequired": "A String", - "scope": "A String", - "userInteraction": "A String", + "integrityImpact": "A String", # Integrity Impact (I). Defined in CVSS v2, v3. + "privilegesRequired": "A String", # Privileges Required (PR). Defined in CVSS v3, v4. + "scope": "A String", # Scope (S). Defined in CVSS v3. + "subsequentSystemAvailabilityImpact": "A String", # Subsequent System Availability Impact (SA). Defined in CVSS v4. + "subsequentSystemConfidentialityImpact": "A String", # Subsequent System Confidentiality Impact (SC). Defined in CVSS v4. + "subsequentSystemIntegrityImpact": "A String", # Subsequent System Integrity Impact (SI). Defined in CVSS v4. + "userInteraction": "A String", # User Interaction (UI). Defined in CVSS v3, v4. + "vulnerableSystemAvailabilityImpact": "A String", # Vulnerable System Availability Impact (VA). Defined in CVSS v4. + "vulnerableSystemConfidentialityImpact": "A String", # Vulnerable System Confidentiality Impact (VC). Defined in CVSS v4. + "vulnerableSystemIntegrityImpact": "A String", # Vulnerable System Integrity Impact (VI). Defined in CVSS v4. }, "cvssV3": { # Common Vulnerability Scoring System version 3. For details, see https://www.first.org/cvss/specification-document # The full description of the CVSSv3 for this vulnerability. "attackComplexity": "A String", @@ -2512,18 +2561,25 @@

Method Details

"advisoryPublishTime": "A String", # The time this advisory was published by the source. "cvssScore": 3.14, # The CVSS score of this vulnerability. CVSS score is on a scale of 0 - 10 where 0 indicates low severity and 10 indicates high severity. "cvssV2": { # Common Vulnerability Scoring System. For details, see https://www.first.org/cvss/specification-document This is a message we will try to use for storing various versions of CVSS rather than making a separate proto for storing a specific version. # The full description of the v2 CVSS for this vulnerability. - "attackComplexity": "A String", - "attackVector": "A String", # Base Metrics Represents the intrinsic characteristics of a vulnerability that are constant over time and across user environments. - "authentication": "A String", - "availabilityImpact": "A String", + "attackComplexity": "A String", # Attack Complexity (AC). Defined in CVSS v2, v3, v4. + "attackRequirements": "A String", # Attack Requirements (AT). Defined in CVSS v4. + "attackVector": "A String", # Attack Vector (AV). Defined in CVSS v2, v3, v4. + "authentication": "A String", # Authentication (Au). Defined in CVSS v2. + "availabilityImpact": "A String", # Availability Impact (A). Defined in CVSS v2, v3. "baseScore": 3.14, # The base score is a function of the base metric scores. - "confidentialityImpact": "A String", + "confidentialityImpact": "A String", # Confidentiality Impact (C). Defined in CVSS v2, v3. "exploitabilityScore": 3.14, "impactScore": 3.14, - "integrityImpact": "A String", - "privilegesRequired": "A String", - "scope": "A String", - "userInteraction": "A String", + "integrityImpact": "A String", # Integrity Impact (I). Defined in CVSS v2, v3. + "privilegesRequired": "A String", # Privileges Required (PR). Defined in CVSS v3, v4. + "scope": "A String", # Scope (S). Defined in CVSS v3. + "subsequentSystemAvailabilityImpact": "A String", # Subsequent System Availability Impact (SA). Defined in CVSS v4. + "subsequentSystemConfidentialityImpact": "A String", # Subsequent System Confidentiality Impact (SC). Defined in CVSS v4. + "subsequentSystemIntegrityImpact": "A String", # Subsequent System Integrity Impact (SI). Defined in CVSS v4. + "userInteraction": "A String", # User Interaction (UI). Defined in CVSS v3, v4. + "vulnerableSystemAvailabilityImpact": "A String", # Vulnerable System Availability Impact (VA). Defined in CVSS v4. + "vulnerableSystemConfidentialityImpact": "A String", # Vulnerable System Confidentiality Impact (VC). Defined in CVSS v4. + "vulnerableSystemIntegrityImpact": "A String", # Vulnerable System Integrity Impact (VI). Defined in CVSS v4. }, "cvssV3": { # Common Vulnerability Scoring System version 3. For details, see https://www.first.org/cvss/specification-document # The full description of the CVSSv3 for this vulnerability. "attackComplexity": "A String", diff --git a/docs/dyn/containeranalysis_v1.projects.notes.occurrences.html b/docs/dyn/containeranalysis_v1.projects.notes.occurrences.html index 778b570417..64de4621ac 100644 --- a/docs/dyn/containeranalysis_v1.projects.notes.occurrences.html +++ b/docs/dyn/containeranalysis_v1.projects.notes.occurrences.html @@ -875,33 +875,47 @@

Method Details

"vulnerability": { # An occurrence of a severity vulnerability on a resource. # Describes a security vulnerability. "cvssScore": 3.14, # Output only. The CVSS score of this vulnerability. CVSS score is on a scale of 0 - 10 where 0 indicates low severity and 10 indicates high severity. "cvssV2": { # Common Vulnerability Scoring System. For details, see https://www.first.org/cvss/specification-document This is a message we will try to use for storing various versions of CVSS rather than making a separate proto for storing a specific version. # The cvss v2 score for the vulnerability. - "attackComplexity": "A String", - "attackVector": "A String", # Base Metrics Represents the intrinsic characteristics of a vulnerability that are constant over time and across user environments. - "authentication": "A String", - "availabilityImpact": "A String", + "attackComplexity": "A String", # Attack Complexity (AC). Defined in CVSS v2, v3, v4. + "attackRequirements": "A String", # Attack Requirements (AT). Defined in CVSS v4. + "attackVector": "A String", # Attack Vector (AV). Defined in CVSS v2, v3, v4. + "authentication": "A String", # Authentication (Au). Defined in CVSS v2. + "availabilityImpact": "A String", # Availability Impact (A). Defined in CVSS v2, v3. "baseScore": 3.14, # The base score is a function of the base metric scores. - "confidentialityImpact": "A String", + "confidentialityImpact": "A String", # Confidentiality Impact (C). Defined in CVSS v2, v3. "exploitabilityScore": 3.14, "impactScore": 3.14, - "integrityImpact": "A String", - "privilegesRequired": "A String", - "scope": "A String", - "userInteraction": "A String", + "integrityImpact": "A String", # Integrity Impact (I). Defined in CVSS v2, v3. + "privilegesRequired": "A String", # Privileges Required (PR). Defined in CVSS v3, v4. + "scope": "A String", # Scope (S). Defined in CVSS v3. + "subsequentSystemAvailabilityImpact": "A String", # Subsequent System Availability Impact (SA). Defined in CVSS v4. + "subsequentSystemConfidentialityImpact": "A String", # Subsequent System Confidentiality Impact (SC). Defined in CVSS v4. + "subsequentSystemIntegrityImpact": "A String", # Subsequent System Integrity Impact (SI). Defined in CVSS v4. + "userInteraction": "A String", # User Interaction (UI). Defined in CVSS v3, v4. + "vulnerableSystemAvailabilityImpact": "A String", # Vulnerable System Availability Impact (VA). Defined in CVSS v4. + "vulnerableSystemConfidentialityImpact": "A String", # Vulnerable System Confidentiality Impact (VC). Defined in CVSS v4. + "vulnerableSystemIntegrityImpact": "A String", # Vulnerable System Integrity Impact (VI). Defined in CVSS v4. }, "cvssVersion": "A String", # Output only. CVSS version used to populate cvss_score and severity. "cvssv3": { # Common Vulnerability Scoring System. For details, see https://www.first.org/cvss/specification-document This is a message we will try to use for storing various versions of CVSS rather than making a separate proto for storing a specific version. # The cvss v3 score for the vulnerability. - "attackComplexity": "A String", - "attackVector": "A String", # Base Metrics Represents the intrinsic characteristics of a vulnerability that are constant over time and across user environments. - "authentication": "A String", - "availabilityImpact": "A String", + "attackComplexity": "A String", # Attack Complexity (AC). Defined in CVSS v2, v3, v4. + "attackRequirements": "A String", # Attack Requirements (AT). Defined in CVSS v4. + "attackVector": "A String", # Attack Vector (AV). Defined in CVSS v2, v3, v4. + "authentication": "A String", # Authentication (Au). Defined in CVSS v2. + "availabilityImpact": "A String", # Availability Impact (A). Defined in CVSS v2, v3. "baseScore": 3.14, # The base score is a function of the base metric scores. - "confidentialityImpact": "A String", + "confidentialityImpact": "A String", # Confidentiality Impact (C). Defined in CVSS v2, v3. "exploitabilityScore": 3.14, "impactScore": 3.14, - "integrityImpact": "A String", - "privilegesRequired": "A String", - "scope": "A String", - "userInteraction": "A String", + "integrityImpact": "A String", # Integrity Impact (I). Defined in CVSS v2, v3. + "privilegesRequired": "A String", # Privileges Required (PR). Defined in CVSS v3, v4. + "scope": "A String", # Scope (S). Defined in CVSS v3. + "subsequentSystemAvailabilityImpact": "A String", # Subsequent System Availability Impact (SA). Defined in CVSS v4. + "subsequentSystemConfidentialityImpact": "A String", # Subsequent System Confidentiality Impact (SC). Defined in CVSS v4. + "subsequentSystemIntegrityImpact": "A String", # Subsequent System Integrity Impact (SI). Defined in CVSS v4. + "userInteraction": "A String", # User Interaction (UI). Defined in CVSS v3, v4. + "vulnerableSystemAvailabilityImpact": "A String", # Vulnerable System Availability Impact (VA). Defined in CVSS v4. + "vulnerableSystemConfidentialityImpact": "A String", # Vulnerable System Confidentiality Impact (VC). Defined in CVSS v4. + "vulnerableSystemIntegrityImpact": "A String", # Vulnerable System Integrity Impact (VI). Defined in CVSS v4. }, "effectiveSeverity": "A String", # The distro assigned severity for this vulnerability when it is available, otherwise this is the note provider assigned severity. When there are multiple PackageIssues for this vulnerability, they can have different effective severities because some might be provided by the distro while others are provided by the language ecosystem for a language pack. For this reason, it is advised to use the effective severity on the PackageIssue level. In the case where multiple PackageIssues have differing effective severities, this field should be the highest severity for any of the PackageIssues. "extraDetails": "A String", # Occurrence-specific extra details about the vulnerability. diff --git a/docs/dyn/containeranalysis_v1.projects.occurrences.html b/docs/dyn/containeranalysis_v1.projects.occurrences.html index 7135fafa17..639cb23ee2 100644 --- a/docs/dyn/containeranalysis_v1.projects.occurrences.html +++ b/docs/dyn/containeranalysis_v1.projects.occurrences.html @@ -891,33 +891,47 @@

Method Details

"vulnerability": { # An occurrence of a severity vulnerability on a resource. # Describes a security vulnerability. "cvssScore": 3.14, # Output only. The CVSS score of this vulnerability. CVSS score is on a scale of 0 - 10 where 0 indicates low severity and 10 indicates high severity. "cvssV2": { # Common Vulnerability Scoring System. For details, see https://www.first.org/cvss/specification-document This is a message we will try to use for storing various versions of CVSS rather than making a separate proto for storing a specific version. # The cvss v2 score for the vulnerability. - "attackComplexity": "A String", - "attackVector": "A String", # Base Metrics Represents the intrinsic characteristics of a vulnerability that are constant over time and across user environments. - "authentication": "A String", - "availabilityImpact": "A String", + "attackComplexity": "A String", # Attack Complexity (AC). Defined in CVSS v2, v3, v4. + "attackRequirements": "A String", # Attack Requirements (AT). Defined in CVSS v4. + "attackVector": "A String", # Attack Vector (AV). Defined in CVSS v2, v3, v4. + "authentication": "A String", # Authentication (Au). Defined in CVSS v2. + "availabilityImpact": "A String", # Availability Impact (A). Defined in CVSS v2, v3. "baseScore": 3.14, # The base score is a function of the base metric scores. - "confidentialityImpact": "A String", + "confidentialityImpact": "A String", # Confidentiality Impact (C). Defined in CVSS v2, v3. "exploitabilityScore": 3.14, "impactScore": 3.14, - "integrityImpact": "A String", - "privilegesRequired": "A String", - "scope": "A String", - "userInteraction": "A String", + "integrityImpact": "A String", # Integrity Impact (I). Defined in CVSS v2, v3. + "privilegesRequired": "A String", # Privileges Required (PR). Defined in CVSS v3, v4. + "scope": "A String", # Scope (S). Defined in CVSS v3. + "subsequentSystemAvailabilityImpact": "A String", # Subsequent System Availability Impact (SA). Defined in CVSS v4. + "subsequentSystemConfidentialityImpact": "A String", # Subsequent System Confidentiality Impact (SC). Defined in CVSS v4. + "subsequentSystemIntegrityImpact": "A String", # Subsequent System Integrity Impact (SI). Defined in CVSS v4. + "userInteraction": "A String", # User Interaction (UI). Defined in CVSS v3, v4. + "vulnerableSystemAvailabilityImpact": "A String", # Vulnerable System Availability Impact (VA). Defined in CVSS v4. + "vulnerableSystemConfidentialityImpact": "A String", # Vulnerable System Confidentiality Impact (VC). Defined in CVSS v4. + "vulnerableSystemIntegrityImpact": "A String", # Vulnerable System Integrity Impact (VI). Defined in CVSS v4. }, "cvssVersion": "A String", # Output only. CVSS version used to populate cvss_score and severity. "cvssv3": { # Common Vulnerability Scoring System. For details, see https://www.first.org/cvss/specification-document This is a message we will try to use for storing various versions of CVSS rather than making a separate proto for storing a specific version. # The cvss v3 score for the vulnerability. - "attackComplexity": "A String", - "attackVector": "A String", # Base Metrics Represents the intrinsic characteristics of a vulnerability that are constant over time and across user environments. - "authentication": "A String", - "availabilityImpact": "A String", + "attackComplexity": "A String", # Attack Complexity (AC). Defined in CVSS v2, v3, v4. + "attackRequirements": "A String", # Attack Requirements (AT). Defined in CVSS v4. + "attackVector": "A String", # Attack Vector (AV). Defined in CVSS v2, v3, v4. + "authentication": "A String", # Authentication (Au). Defined in CVSS v2. + "availabilityImpact": "A String", # Availability Impact (A). Defined in CVSS v2, v3. "baseScore": 3.14, # The base score is a function of the base metric scores. - "confidentialityImpact": "A String", + "confidentialityImpact": "A String", # Confidentiality Impact (C). Defined in CVSS v2, v3. "exploitabilityScore": 3.14, "impactScore": 3.14, - "integrityImpact": "A String", - "privilegesRequired": "A String", - "scope": "A String", - "userInteraction": "A String", + "integrityImpact": "A String", # Integrity Impact (I). Defined in CVSS v2, v3. + "privilegesRequired": "A String", # Privileges Required (PR). Defined in CVSS v3, v4. + "scope": "A String", # Scope (S). Defined in CVSS v3. + "subsequentSystemAvailabilityImpact": "A String", # Subsequent System Availability Impact (SA). Defined in CVSS v4. + "subsequentSystemConfidentialityImpact": "A String", # Subsequent System Confidentiality Impact (SC). Defined in CVSS v4. + "subsequentSystemIntegrityImpact": "A String", # Subsequent System Integrity Impact (SI). Defined in CVSS v4. + "userInteraction": "A String", # User Interaction (UI). Defined in CVSS v3, v4. + "vulnerableSystemAvailabilityImpact": "A String", # Vulnerable System Availability Impact (VA). Defined in CVSS v4. + "vulnerableSystemConfidentialityImpact": "A String", # Vulnerable System Confidentiality Impact (VC). Defined in CVSS v4. + "vulnerableSystemIntegrityImpact": "A String", # Vulnerable System Integrity Impact (VI). Defined in CVSS v4. }, "effectiveSeverity": "A String", # The distro assigned severity for this vulnerability when it is available, otherwise this is the note provider assigned severity. When there are multiple PackageIssues for this vulnerability, they can have different effective severities because some might be provided by the distro while others are provided by the language ecosystem for a language pack. For this reason, it is advised to use the effective severity on the PackageIssue level. In the case where multiple PackageIssues have differing effective severities, this field should be the highest severity for any of the PackageIssues. "extraDetails": "A String", # Occurrence-specific extra details about the vulnerability. @@ -1798,33 +1812,47 @@

Method Details

"vulnerability": { # An occurrence of a severity vulnerability on a resource. # Describes a security vulnerability. "cvssScore": 3.14, # Output only. The CVSS score of this vulnerability. CVSS score is on a scale of 0 - 10 where 0 indicates low severity and 10 indicates high severity. "cvssV2": { # Common Vulnerability Scoring System. For details, see https://www.first.org/cvss/specification-document This is a message we will try to use for storing various versions of CVSS rather than making a separate proto for storing a specific version. # The cvss v2 score for the vulnerability. - "attackComplexity": "A String", - "attackVector": "A String", # Base Metrics Represents the intrinsic characteristics of a vulnerability that are constant over time and across user environments. - "authentication": "A String", - "availabilityImpact": "A String", + "attackComplexity": "A String", # Attack Complexity (AC). Defined in CVSS v2, v3, v4. + "attackRequirements": "A String", # Attack Requirements (AT). Defined in CVSS v4. + "attackVector": "A String", # Attack Vector (AV). Defined in CVSS v2, v3, v4. + "authentication": "A String", # Authentication (Au). Defined in CVSS v2. + "availabilityImpact": "A String", # Availability Impact (A). Defined in CVSS v2, v3. "baseScore": 3.14, # The base score is a function of the base metric scores. - "confidentialityImpact": "A String", + "confidentialityImpact": "A String", # Confidentiality Impact (C). Defined in CVSS v2, v3. "exploitabilityScore": 3.14, "impactScore": 3.14, - "integrityImpact": "A String", - "privilegesRequired": "A String", - "scope": "A String", - "userInteraction": "A String", + "integrityImpact": "A String", # Integrity Impact (I). Defined in CVSS v2, v3. + "privilegesRequired": "A String", # Privileges Required (PR). Defined in CVSS v3, v4. + "scope": "A String", # Scope (S). Defined in CVSS v3. + "subsequentSystemAvailabilityImpact": "A String", # Subsequent System Availability Impact (SA). Defined in CVSS v4. + "subsequentSystemConfidentialityImpact": "A String", # Subsequent System Confidentiality Impact (SC). Defined in CVSS v4. + "subsequentSystemIntegrityImpact": "A String", # Subsequent System Integrity Impact (SI). Defined in CVSS v4. + "userInteraction": "A String", # User Interaction (UI). Defined in CVSS v3, v4. + "vulnerableSystemAvailabilityImpact": "A String", # Vulnerable System Availability Impact (VA). Defined in CVSS v4. + "vulnerableSystemConfidentialityImpact": "A String", # Vulnerable System Confidentiality Impact (VC). Defined in CVSS v4. + "vulnerableSystemIntegrityImpact": "A String", # Vulnerable System Integrity Impact (VI). Defined in CVSS v4. }, "cvssVersion": "A String", # Output only. CVSS version used to populate cvss_score and severity. "cvssv3": { # Common Vulnerability Scoring System. For details, see https://www.first.org/cvss/specification-document This is a message we will try to use for storing various versions of CVSS rather than making a separate proto for storing a specific version. # The cvss v3 score for the vulnerability. - "attackComplexity": "A String", - "attackVector": "A String", # Base Metrics Represents the intrinsic characteristics of a vulnerability that are constant over time and across user environments. - "authentication": "A String", - "availabilityImpact": "A String", + "attackComplexity": "A String", # Attack Complexity (AC). Defined in CVSS v2, v3, v4. + "attackRequirements": "A String", # Attack Requirements (AT). Defined in CVSS v4. + "attackVector": "A String", # Attack Vector (AV). Defined in CVSS v2, v3, v4. + "authentication": "A String", # Authentication (Au). Defined in CVSS v2. + "availabilityImpact": "A String", # Availability Impact (A). Defined in CVSS v2, v3. "baseScore": 3.14, # The base score is a function of the base metric scores. - "confidentialityImpact": "A String", + "confidentialityImpact": "A String", # Confidentiality Impact (C). Defined in CVSS v2, v3. "exploitabilityScore": 3.14, "impactScore": 3.14, - "integrityImpact": "A String", - "privilegesRequired": "A String", - "scope": "A String", - "userInteraction": "A String", + "integrityImpact": "A String", # Integrity Impact (I). Defined in CVSS v2, v3. + "privilegesRequired": "A String", # Privileges Required (PR). Defined in CVSS v3, v4. + "scope": "A String", # Scope (S). Defined in CVSS v3. + "subsequentSystemAvailabilityImpact": "A String", # Subsequent System Availability Impact (SA). Defined in CVSS v4. + "subsequentSystemConfidentialityImpact": "A String", # Subsequent System Confidentiality Impact (SC). Defined in CVSS v4. + "subsequentSystemIntegrityImpact": "A String", # Subsequent System Integrity Impact (SI). Defined in CVSS v4. + "userInteraction": "A String", # User Interaction (UI). Defined in CVSS v3, v4. + "vulnerableSystemAvailabilityImpact": "A String", # Vulnerable System Availability Impact (VA). Defined in CVSS v4. + "vulnerableSystemConfidentialityImpact": "A String", # Vulnerable System Confidentiality Impact (VC). Defined in CVSS v4. + "vulnerableSystemIntegrityImpact": "A String", # Vulnerable System Integrity Impact (VI). Defined in CVSS v4. }, "effectiveSeverity": "A String", # The distro assigned severity for this vulnerability when it is available, otherwise this is the note provider assigned severity. When there are multiple PackageIssues for this vulnerability, they can have different effective severities because some might be provided by the distro while others are provided by the language ecosystem for a language pack. For this reason, it is advised to use the effective severity on the PackageIssue level. In the case where multiple PackageIssues have differing effective severities, this field should be the highest severity for any of the PackageIssues. "extraDetails": "A String", # Occurrence-specific extra details about the vulnerability. @@ -2710,33 +2738,47 @@

Method Details

"vulnerability": { # An occurrence of a severity vulnerability on a resource. # Describes a security vulnerability. "cvssScore": 3.14, # Output only. The CVSS score of this vulnerability. CVSS score is on a scale of 0 - 10 where 0 indicates low severity and 10 indicates high severity. "cvssV2": { # Common Vulnerability Scoring System. For details, see https://www.first.org/cvss/specification-document This is a message we will try to use for storing various versions of CVSS rather than making a separate proto for storing a specific version. # The cvss v2 score for the vulnerability. - "attackComplexity": "A String", - "attackVector": "A String", # Base Metrics Represents the intrinsic characteristics of a vulnerability that are constant over time and across user environments. - "authentication": "A String", - "availabilityImpact": "A String", + "attackComplexity": "A String", # Attack Complexity (AC). Defined in CVSS v2, v3, v4. + "attackRequirements": "A String", # Attack Requirements (AT). Defined in CVSS v4. + "attackVector": "A String", # Attack Vector (AV). Defined in CVSS v2, v3, v4. + "authentication": "A String", # Authentication (Au). Defined in CVSS v2. + "availabilityImpact": "A String", # Availability Impact (A). Defined in CVSS v2, v3. "baseScore": 3.14, # The base score is a function of the base metric scores. - "confidentialityImpact": "A String", + "confidentialityImpact": "A String", # Confidentiality Impact (C). Defined in CVSS v2, v3. "exploitabilityScore": 3.14, "impactScore": 3.14, - "integrityImpact": "A String", - "privilegesRequired": "A String", - "scope": "A String", - "userInteraction": "A String", + "integrityImpact": "A String", # Integrity Impact (I). Defined in CVSS v2, v3. + "privilegesRequired": "A String", # Privileges Required (PR). Defined in CVSS v3, v4. + "scope": "A String", # Scope (S). Defined in CVSS v3. + "subsequentSystemAvailabilityImpact": "A String", # Subsequent System Availability Impact (SA). Defined in CVSS v4. + "subsequentSystemConfidentialityImpact": "A String", # Subsequent System Confidentiality Impact (SC). Defined in CVSS v4. + "subsequentSystemIntegrityImpact": "A String", # Subsequent System Integrity Impact (SI). Defined in CVSS v4. + "userInteraction": "A String", # User Interaction (UI). Defined in CVSS v3, v4. + "vulnerableSystemAvailabilityImpact": "A String", # Vulnerable System Availability Impact (VA). Defined in CVSS v4. + "vulnerableSystemConfidentialityImpact": "A String", # Vulnerable System Confidentiality Impact (VC). Defined in CVSS v4. + "vulnerableSystemIntegrityImpact": "A String", # Vulnerable System Integrity Impact (VI). Defined in CVSS v4. }, "cvssVersion": "A String", # Output only. CVSS version used to populate cvss_score and severity. "cvssv3": { # Common Vulnerability Scoring System. For details, see https://www.first.org/cvss/specification-document This is a message we will try to use for storing various versions of CVSS rather than making a separate proto for storing a specific version. # The cvss v3 score for the vulnerability. - "attackComplexity": "A String", - "attackVector": "A String", # Base Metrics Represents the intrinsic characteristics of a vulnerability that are constant over time and across user environments. - "authentication": "A String", - "availabilityImpact": "A String", + "attackComplexity": "A String", # Attack Complexity (AC). Defined in CVSS v2, v3, v4. + "attackRequirements": "A String", # Attack Requirements (AT). Defined in CVSS v4. + "attackVector": "A String", # Attack Vector (AV). Defined in CVSS v2, v3, v4. + "authentication": "A String", # Authentication (Au). Defined in CVSS v2. + "availabilityImpact": "A String", # Availability Impact (A). Defined in CVSS v2, v3. "baseScore": 3.14, # The base score is a function of the base metric scores. - "confidentialityImpact": "A String", + "confidentialityImpact": "A String", # Confidentiality Impact (C). Defined in CVSS v2, v3. "exploitabilityScore": 3.14, "impactScore": 3.14, - "integrityImpact": "A String", - "privilegesRequired": "A String", - "scope": "A String", - "userInteraction": "A String", + "integrityImpact": "A String", # Integrity Impact (I). Defined in CVSS v2, v3. + "privilegesRequired": "A String", # Privileges Required (PR). Defined in CVSS v3, v4. + "scope": "A String", # Scope (S). Defined in CVSS v3. + "subsequentSystemAvailabilityImpact": "A String", # Subsequent System Availability Impact (SA). Defined in CVSS v4. + "subsequentSystemConfidentialityImpact": "A String", # Subsequent System Confidentiality Impact (SC). Defined in CVSS v4. + "subsequentSystemIntegrityImpact": "A String", # Subsequent System Integrity Impact (SI). Defined in CVSS v4. + "userInteraction": "A String", # User Interaction (UI). Defined in CVSS v3, v4. + "vulnerableSystemAvailabilityImpact": "A String", # Vulnerable System Availability Impact (VA). Defined in CVSS v4. + "vulnerableSystemConfidentialityImpact": "A String", # Vulnerable System Confidentiality Impact (VC). Defined in CVSS v4. + "vulnerableSystemIntegrityImpact": "A String", # Vulnerable System Integrity Impact (VI). Defined in CVSS v4. }, "effectiveSeverity": "A String", # The distro assigned severity for this vulnerability when it is available, otherwise this is the note provider assigned severity. When there are multiple PackageIssues for this vulnerability, they can have different effective severities because some might be provided by the distro while others are provided by the language ecosystem for a language pack. For this reason, it is advised to use the effective severity on the PackageIssue level. In the case where multiple PackageIssues have differing effective severities, this field should be the highest severity for any of the PackageIssues. "extraDetails": "A String", # Occurrence-specific extra details about the vulnerability. @@ -3613,33 +3655,47 @@

Method Details

"vulnerability": { # An occurrence of a severity vulnerability on a resource. # Describes a security vulnerability. "cvssScore": 3.14, # Output only. The CVSS score of this vulnerability. CVSS score is on a scale of 0 - 10 where 0 indicates low severity and 10 indicates high severity. "cvssV2": { # Common Vulnerability Scoring System. For details, see https://www.first.org/cvss/specification-document This is a message we will try to use for storing various versions of CVSS rather than making a separate proto for storing a specific version. # The cvss v2 score for the vulnerability. - "attackComplexity": "A String", - "attackVector": "A String", # Base Metrics Represents the intrinsic characteristics of a vulnerability that are constant over time and across user environments. - "authentication": "A String", - "availabilityImpact": "A String", + "attackComplexity": "A String", # Attack Complexity (AC). Defined in CVSS v2, v3, v4. + "attackRequirements": "A String", # Attack Requirements (AT). Defined in CVSS v4. + "attackVector": "A String", # Attack Vector (AV). Defined in CVSS v2, v3, v4. + "authentication": "A String", # Authentication (Au). Defined in CVSS v2. + "availabilityImpact": "A String", # Availability Impact (A). Defined in CVSS v2, v3. "baseScore": 3.14, # The base score is a function of the base metric scores. - "confidentialityImpact": "A String", + "confidentialityImpact": "A String", # Confidentiality Impact (C). Defined in CVSS v2, v3. "exploitabilityScore": 3.14, "impactScore": 3.14, - "integrityImpact": "A String", - "privilegesRequired": "A String", - "scope": "A String", - "userInteraction": "A String", + "integrityImpact": "A String", # Integrity Impact (I). Defined in CVSS v2, v3. + "privilegesRequired": "A String", # Privileges Required (PR). Defined in CVSS v3, v4. + "scope": "A String", # Scope (S). Defined in CVSS v3. + "subsequentSystemAvailabilityImpact": "A String", # Subsequent System Availability Impact (SA). Defined in CVSS v4. + "subsequentSystemConfidentialityImpact": "A String", # Subsequent System Confidentiality Impact (SC). Defined in CVSS v4. + "subsequentSystemIntegrityImpact": "A String", # Subsequent System Integrity Impact (SI). Defined in CVSS v4. + "userInteraction": "A String", # User Interaction (UI). Defined in CVSS v3, v4. + "vulnerableSystemAvailabilityImpact": "A String", # Vulnerable System Availability Impact (VA). Defined in CVSS v4. + "vulnerableSystemConfidentialityImpact": "A String", # Vulnerable System Confidentiality Impact (VC). Defined in CVSS v4. + "vulnerableSystemIntegrityImpact": "A String", # Vulnerable System Integrity Impact (VI). Defined in CVSS v4. }, "cvssVersion": "A String", # Output only. CVSS version used to populate cvss_score and severity. "cvssv3": { # Common Vulnerability Scoring System. For details, see https://www.first.org/cvss/specification-document This is a message we will try to use for storing various versions of CVSS rather than making a separate proto for storing a specific version. # The cvss v3 score for the vulnerability. - "attackComplexity": "A String", - "attackVector": "A String", # Base Metrics Represents the intrinsic characteristics of a vulnerability that are constant over time and across user environments. - "authentication": "A String", - "availabilityImpact": "A String", + "attackComplexity": "A String", # Attack Complexity (AC). Defined in CVSS v2, v3, v4. + "attackRequirements": "A String", # Attack Requirements (AT). Defined in CVSS v4. + "attackVector": "A String", # Attack Vector (AV). Defined in CVSS v2, v3, v4. + "authentication": "A String", # Authentication (Au). Defined in CVSS v2. + "availabilityImpact": "A String", # Availability Impact (A). Defined in CVSS v2, v3. "baseScore": 3.14, # The base score is a function of the base metric scores. - "confidentialityImpact": "A String", + "confidentialityImpact": "A String", # Confidentiality Impact (C). Defined in CVSS v2, v3. "exploitabilityScore": 3.14, "impactScore": 3.14, - "integrityImpact": "A String", - "privilegesRequired": "A String", - "scope": "A String", - "userInteraction": "A String", + "integrityImpact": "A String", # Integrity Impact (I). Defined in CVSS v2, v3. + "privilegesRequired": "A String", # Privileges Required (PR). Defined in CVSS v3, v4. + "scope": "A String", # Scope (S). Defined in CVSS v3. + "subsequentSystemAvailabilityImpact": "A String", # Subsequent System Availability Impact (SA). Defined in CVSS v4. + "subsequentSystemConfidentialityImpact": "A String", # Subsequent System Confidentiality Impact (SC). Defined in CVSS v4. + "subsequentSystemIntegrityImpact": "A String", # Subsequent System Integrity Impact (SI). Defined in CVSS v4. + "userInteraction": "A String", # User Interaction (UI). Defined in CVSS v3, v4. + "vulnerableSystemAvailabilityImpact": "A String", # Vulnerable System Availability Impact (VA). Defined in CVSS v4. + "vulnerableSystemConfidentialityImpact": "A String", # Vulnerable System Confidentiality Impact (VC). Defined in CVSS v4. + "vulnerableSystemIntegrityImpact": "A String", # Vulnerable System Integrity Impact (VI). Defined in CVSS v4. }, "effectiveSeverity": "A String", # The distro assigned severity for this vulnerability when it is available, otherwise this is the note provider assigned severity. When there are multiple PackageIssues for this vulnerability, they can have different effective severities because some might be provided by the distro while others are provided by the language ecosystem for a language pack. For this reason, it is advised to use the effective severity on the PackageIssue level. In the case where multiple PackageIssues have differing effective severities, this field should be the highest severity for any of the PackageIssues. "extraDetails": "A String", # Occurrence-specific extra details about the vulnerability. @@ -4541,33 +4597,47 @@

Method Details

"vulnerability": { # An occurrence of a severity vulnerability on a resource. # Describes a security vulnerability. "cvssScore": 3.14, # Output only. The CVSS score of this vulnerability. CVSS score is on a scale of 0 - 10 where 0 indicates low severity and 10 indicates high severity. "cvssV2": { # Common Vulnerability Scoring System. For details, see https://www.first.org/cvss/specification-document This is a message we will try to use for storing various versions of CVSS rather than making a separate proto for storing a specific version. # The cvss v2 score for the vulnerability. - "attackComplexity": "A String", - "attackVector": "A String", # Base Metrics Represents the intrinsic characteristics of a vulnerability that are constant over time and across user environments. - "authentication": "A String", - "availabilityImpact": "A String", + "attackComplexity": "A String", # Attack Complexity (AC). Defined in CVSS v2, v3, v4. + "attackRequirements": "A String", # Attack Requirements (AT). Defined in CVSS v4. + "attackVector": "A String", # Attack Vector (AV). Defined in CVSS v2, v3, v4. + "authentication": "A String", # Authentication (Au). Defined in CVSS v2. + "availabilityImpact": "A String", # Availability Impact (A). Defined in CVSS v2, v3. "baseScore": 3.14, # The base score is a function of the base metric scores. - "confidentialityImpact": "A String", + "confidentialityImpact": "A String", # Confidentiality Impact (C). Defined in CVSS v2, v3. "exploitabilityScore": 3.14, "impactScore": 3.14, - "integrityImpact": "A String", - "privilegesRequired": "A String", - "scope": "A String", - "userInteraction": "A String", + "integrityImpact": "A String", # Integrity Impact (I). Defined in CVSS v2, v3. + "privilegesRequired": "A String", # Privileges Required (PR). Defined in CVSS v3, v4. + "scope": "A String", # Scope (S). Defined in CVSS v3. + "subsequentSystemAvailabilityImpact": "A String", # Subsequent System Availability Impact (SA). Defined in CVSS v4. + "subsequentSystemConfidentialityImpact": "A String", # Subsequent System Confidentiality Impact (SC). Defined in CVSS v4. + "subsequentSystemIntegrityImpact": "A String", # Subsequent System Integrity Impact (SI). Defined in CVSS v4. + "userInteraction": "A String", # User Interaction (UI). Defined in CVSS v3, v4. + "vulnerableSystemAvailabilityImpact": "A String", # Vulnerable System Availability Impact (VA). Defined in CVSS v4. + "vulnerableSystemConfidentialityImpact": "A String", # Vulnerable System Confidentiality Impact (VC). Defined in CVSS v4. + "vulnerableSystemIntegrityImpact": "A String", # Vulnerable System Integrity Impact (VI). Defined in CVSS v4. }, "cvssVersion": "A String", # Output only. CVSS version used to populate cvss_score and severity. "cvssv3": { # Common Vulnerability Scoring System. For details, see https://www.first.org/cvss/specification-document This is a message we will try to use for storing various versions of CVSS rather than making a separate proto for storing a specific version. # The cvss v3 score for the vulnerability. - "attackComplexity": "A String", - "attackVector": "A String", # Base Metrics Represents the intrinsic characteristics of a vulnerability that are constant over time and across user environments. - "authentication": "A String", - "availabilityImpact": "A String", + "attackComplexity": "A String", # Attack Complexity (AC). Defined in CVSS v2, v3, v4. + "attackRequirements": "A String", # Attack Requirements (AT). Defined in CVSS v4. + "attackVector": "A String", # Attack Vector (AV). Defined in CVSS v2, v3, v4. + "authentication": "A String", # Authentication (Au). Defined in CVSS v2. + "availabilityImpact": "A String", # Availability Impact (A). Defined in CVSS v2, v3. "baseScore": 3.14, # The base score is a function of the base metric scores. - "confidentialityImpact": "A String", + "confidentialityImpact": "A String", # Confidentiality Impact (C). Defined in CVSS v2, v3. "exploitabilityScore": 3.14, "impactScore": 3.14, - "integrityImpact": "A String", - "privilegesRequired": "A String", - "scope": "A String", - "userInteraction": "A String", + "integrityImpact": "A String", # Integrity Impact (I). Defined in CVSS v2, v3. + "privilegesRequired": "A String", # Privileges Required (PR). Defined in CVSS v3, v4. + "scope": "A String", # Scope (S). Defined in CVSS v3. + "subsequentSystemAvailabilityImpact": "A String", # Subsequent System Availability Impact (SA). Defined in CVSS v4. + "subsequentSystemConfidentialityImpact": "A String", # Subsequent System Confidentiality Impact (SC). Defined in CVSS v4. + "subsequentSystemIntegrityImpact": "A String", # Subsequent System Integrity Impact (SI). Defined in CVSS v4. + "userInteraction": "A String", # User Interaction (UI). Defined in CVSS v3, v4. + "vulnerableSystemAvailabilityImpact": "A String", # Vulnerable System Availability Impact (VA). Defined in CVSS v4. + "vulnerableSystemConfidentialityImpact": "A String", # Vulnerable System Confidentiality Impact (VC). Defined in CVSS v4. + "vulnerableSystemIntegrityImpact": "A String", # Vulnerable System Integrity Impact (VI). Defined in CVSS v4. }, "effectiveSeverity": "A String", # The distro assigned severity for this vulnerability when it is available, otherwise this is the note provider assigned severity. When there are multiple PackageIssues for this vulnerability, they can have different effective severities because some might be provided by the distro while others are provided by the language ecosystem for a language pack. For this reason, it is advised to use the effective severity on the PackageIssue level. In the case where multiple PackageIssues have differing effective severities, this field should be the highest severity for any of the PackageIssues. "extraDetails": "A String", # Occurrence-specific extra details about the vulnerability. @@ -4891,18 +4961,25 @@

Method Details

"advisoryPublishTime": "A String", # The time this advisory was published by the source. "cvssScore": 3.14, # The CVSS score of this vulnerability. CVSS score is on a scale of 0 - 10 where 0 indicates low severity and 10 indicates high severity. "cvssV2": { # Common Vulnerability Scoring System. For details, see https://www.first.org/cvss/specification-document This is a message we will try to use for storing various versions of CVSS rather than making a separate proto for storing a specific version. # The full description of the v2 CVSS for this vulnerability. - "attackComplexity": "A String", - "attackVector": "A String", # Base Metrics Represents the intrinsic characteristics of a vulnerability that are constant over time and across user environments. - "authentication": "A String", - "availabilityImpact": "A String", + "attackComplexity": "A String", # Attack Complexity (AC). Defined in CVSS v2, v3, v4. + "attackRequirements": "A String", # Attack Requirements (AT). Defined in CVSS v4. + "attackVector": "A String", # Attack Vector (AV). Defined in CVSS v2, v3, v4. + "authentication": "A String", # Authentication (Au). Defined in CVSS v2. + "availabilityImpact": "A String", # Availability Impact (A). Defined in CVSS v2, v3. "baseScore": 3.14, # The base score is a function of the base metric scores. - "confidentialityImpact": "A String", + "confidentialityImpact": "A String", # Confidentiality Impact (C). Defined in CVSS v2, v3. "exploitabilityScore": 3.14, "impactScore": 3.14, - "integrityImpact": "A String", - "privilegesRequired": "A String", - "scope": "A String", - "userInteraction": "A String", + "integrityImpact": "A String", # Integrity Impact (I). Defined in CVSS v2, v3. + "privilegesRequired": "A String", # Privileges Required (PR). Defined in CVSS v3, v4. + "scope": "A String", # Scope (S). Defined in CVSS v3. + "subsequentSystemAvailabilityImpact": "A String", # Subsequent System Availability Impact (SA). Defined in CVSS v4. + "subsequentSystemConfidentialityImpact": "A String", # Subsequent System Confidentiality Impact (SC). Defined in CVSS v4. + "subsequentSystemIntegrityImpact": "A String", # Subsequent System Integrity Impact (SI). Defined in CVSS v4. + "userInteraction": "A String", # User Interaction (UI). Defined in CVSS v3, v4. + "vulnerableSystemAvailabilityImpact": "A String", # Vulnerable System Availability Impact (VA). Defined in CVSS v4. + "vulnerableSystemConfidentialityImpact": "A String", # Vulnerable System Confidentiality Impact (VC). Defined in CVSS v4. + "vulnerableSystemIntegrityImpact": "A String", # Vulnerable System Integrity Impact (VI). Defined in CVSS v4. }, "cvssV3": { # Common Vulnerability Scoring System version 3. For details, see https://www.first.org/cvss/specification-document # The full description of the CVSSv3 for this vulnerability. "attackComplexity": "A String", @@ -5840,33 +5917,47 @@

Method Details

"vulnerability": { # An occurrence of a severity vulnerability on a resource. # Describes a security vulnerability. "cvssScore": 3.14, # Output only. The CVSS score of this vulnerability. CVSS score is on a scale of 0 - 10 where 0 indicates low severity and 10 indicates high severity. "cvssV2": { # Common Vulnerability Scoring System. For details, see https://www.first.org/cvss/specification-document This is a message we will try to use for storing various versions of CVSS rather than making a separate proto for storing a specific version. # The cvss v2 score for the vulnerability. - "attackComplexity": "A String", - "attackVector": "A String", # Base Metrics Represents the intrinsic characteristics of a vulnerability that are constant over time and across user environments. - "authentication": "A String", - "availabilityImpact": "A String", + "attackComplexity": "A String", # Attack Complexity (AC). Defined in CVSS v2, v3, v4. + "attackRequirements": "A String", # Attack Requirements (AT). Defined in CVSS v4. + "attackVector": "A String", # Attack Vector (AV). Defined in CVSS v2, v3, v4. + "authentication": "A String", # Authentication (Au). Defined in CVSS v2. + "availabilityImpact": "A String", # Availability Impact (A). Defined in CVSS v2, v3. "baseScore": 3.14, # The base score is a function of the base metric scores. - "confidentialityImpact": "A String", + "confidentialityImpact": "A String", # Confidentiality Impact (C). Defined in CVSS v2, v3. "exploitabilityScore": 3.14, "impactScore": 3.14, - "integrityImpact": "A String", - "privilegesRequired": "A String", - "scope": "A String", - "userInteraction": "A String", + "integrityImpact": "A String", # Integrity Impact (I). Defined in CVSS v2, v3. + "privilegesRequired": "A String", # Privileges Required (PR). Defined in CVSS v3, v4. + "scope": "A String", # Scope (S). Defined in CVSS v3. + "subsequentSystemAvailabilityImpact": "A String", # Subsequent System Availability Impact (SA). Defined in CVSS v4. + "subsequentSystemConfidentialityImpact": "A String", # Subsequent System Confidentiality Impact (SC). Defined in CVSS v4. + "subsequentSystemIntegrityImpact": "A String", # Subsequent System Integrity Impact (SI). Defined in CVSS v4. + "userInteraction": "A String", # User Interaction (UI). Defined in CVSS v3, v4. + "vulnerableSystemAvailabilityImpact": "A String", # Vulnerable System Availability Impact (VA). Defined in CVSS v4. + "vulnerableSystemConfidentialityImpact": "A String", # Vulnerable System Confidentiality Impact (VC). Defined in CVSS v4. + "vulnerableSystemIntegrityImpact": "A String", # Vulnerable System Integrity Impact (VI). Defined in CVSS v4. }, "cvssVersion": "A String", # Output only. CVSS version used to populate cvss_score and severity. "cvssv3": { # Common Vulnerability Scoring System. For details, see https://www.first.org/cvss/specification-document This is a message we will try to use for storing various versions of CVSS rather than making a separate proto for storing a specific version. # The cvss v3 score for the vulnerability. - "attackComplexity": "A String", - "attackVector": "A String", # Base Metrics Represents the intrinsic characteristics of a vulnerability that are constant over time and across user environments. - "authentication": "A String", - "availabilityImpact": "A String", + "attackComplexity": "A String", # Attack Complexity (AC). Defined in CVSS v2, v3, v4. + "attackRequirements": "A String", # Attack Requirements (AT). Defined in CVSS v4. + "attackVector": "A String", # Attack Vector (AV). Defined in CVSS v2, v3, v4. + "authentication": "A String", # Authentication (Au). Defined in CVSS v2. + "availabilityImpact": "A String", # Availability Impact (A). Defined in CVSS v2, v3. "baseScore": 3.14, # The base score is a function of the base metric scores. - "confidentialityImpact": "A String", + "confidentialityImpact": "A String", # Confidentiality Impact (C). Defined in CVSS v2, v3. "exploitabilityScore": 3.14, "impactScore": 3.14, - "integrityImpact": "A String", - "privilegesRequired": "A String", - "scope": "A String", - "userInteraction": "A String", + "integrityImpact": "A String", # Integrity Impact (I). Defined in CVSS v2, v3. + "privilegesRequired": "A String", # Privileges Required (PR). Defined in CVSS v3, v4. + "scope": "A String", # Scope (S). Defined in CVSS v3. + "subsequentSystemAvailabilityImpact": "A String", # Subsequent System Availability Impact (SA). Defined in CVSS v4. + "subsequentSystemConfidentialityImpact": "A String", # Subsequent System Confidentiality Impact (SC). Defined in CVSS v4. + "subsequentSystemIntegrityImpact": "A String", # Subsequent System Integrity Impact (SI). Defined in CVSS v4. + "userInteraction": "A String", # User Interaction (UI). Defined in CVSS v3, v4. + "vulnerableSystemAvailabilityImpact": "A String", # Vulnerable System Availability Impact (VA). Defined in CVSS v4. + "vulnerableSystemConfidentialityImpact": "A String", # Vulnerable System Confidentiality Impact (VC). Defined in CVSS v4. + "vulnerableSystemIntegrityImpact": "A String", # Vulnerable System Integrity Impact (VI). Defined in CVSS v4. }, "effectiveSeverity": "A String", # The distro assigned severity for this vulnerability when it is available, otherwise this is the note provider assigned severity. When there are multiple PackageIssues for this vulnerability, they can have different effective severities because some might be provided by the distro while others are provided by the language ecosystem for a language pack. For this reason, it is advised to use the effective severity on the PackageIssue level. In the case where multiple PackageIssues have differing effective severities, this field should be the highest severity for any of the PackageIssues. "extraDetails": "A String", # Occurrence-specific extra details about the vulnerability. @@ -6764,33 +6855,47 @@

Method Details

"vulnerability": { # An occurrence of a severity vulnerability on a resource. # Describes a security vulnerability. "cvssScore": 3.14, # Output only. The CVSS score of this vulnerability. CVSS score is on a scale of 0 - 10 where 0 indicates low severity and 10 indicates high severity. "cvssV2": { # Common Vulnerability Scoring System. For details, see https://www.first.org/cvss/specification-document This is a message we will try to use for storing various versions of CVSS rather than making a separate proto for storing a specific version. # The cvss v2 score for the vulnerability. - "attackComplexity": "A String", - "attackVector": "A String", # Base Metrics Represents the intrinsic characteristics of a vulnerability that are constant over time and across user environments. - "authentication": "A String", - "availabilityImpact": "A String", + "attackComplexity": "A String", # Attack Complexity (AC). Defined in CVSS v2, v3, v4. + "attackRequirements": "A String", # Attack Requirements (AT). Defined in CVSS v4. + "attackVector": "A String", # Attack Vector (AV). Defined in CVSS v2, v3, v4. + "authentication": "A String", # Authentication (Au). Defined in CVSS v2. + "availabilityImpact": "A String", # Availability Impact (A). Defined in CVSS v2, v3. "baseScore": 3.14, # The base score is a function of the base metric scores. - "confidentialityImpact": "A String", + "confidentialityImpact": "A String", # Confidentiality Impact (C). Defined in CVSS v2, v3. "exploitabilityScore": 3.14, "impactScore": 3.14, - "integrityImpact": "A String", - "privilegesRequired": "A String", - "scope": "A String", - "userInteraction": "A String", + "integrityImpact": "A String", # Integrity Impact (I). Defined in CVSS v2, v3. + "privilegesRequired": "A String", # Privileges Required (PR). Defined in CVSS v3, v4. + "scope": "A String", # Scope (S). Defined in CVSS v3. + "subsequentSystemAvailabilityImpact": "A String", # Subsequent System Availability Impact (SA). Defined in CVSS v4. + "subsequentSystemConfidentialityImpact": "A String", # Subsequent System Confidentiality Impact (SC). Defined in CVSS v4. + "subsequentSystemIntegrityImpact": "A String", # Subsequent System Integrity Impact (SI). Defined in CVSS v4. + "userInteraction": "A String", # User Interaction (UI). Defined in CVSS v3, v4. + "vulnerableSystemAvailabilityImpact": "A String", # Vulnerable System Availability Impact (VA). Defined in CVSS v4. + "vulnerableSystemConfidentialityImpact": "A String", # Vulnerable System Confidentiality Impact (VC). Defined in CVSS v4. + "vulnerableSystemIntegrityImpact": "A String", # Vulnerable System Integrity Impact (VI). Defined in CVSS v4. }, "cvssVersion": "A String", # Output only. CVSS version used to populate cvss_score and severity. "cvssv3": { # Common Vulnerability Scoring System. For details, see https://www.first.org/cvss/specification-document This is a message we will try to use for storing various versions of CVSS rather than making a separate proto for storing a specific version. # The cvss v3 score for the vulnerability. - "attackComplexity": "A String", - "attackVector": "A String", # Base Metrics Represents the intrinsic characteristics of a vulnerability that are constant over time and across user environments. - "authentication": "A String", - "availabilityImpact": "A String", + "attackComplexity": "A String", # Attack Complexity (AC). Defined in CVSS v2, v3, v4. + "attackRequirements": "A String", # Attack Requirements (AT). Defined in CVSS v4. + "attackVector": "A String", # Attack Vector (AV). Defined in CVSS v2, v3, v4. + "authentication": "A String", # Authentication (Au). Defined in CVSS v2. + "availabilityImpact": "A String", # Availability Impact (A). Defined in CVSS v2, v3. "baseScore": 3.14, # The base score is a function of the base metric scores. - "confidentialityImpact": "A String", + "confidentialityImpact": "A String", # Confidentiality Impact (C). Defined in CVSS v2, v3. "exploitabilityScore": 3.14, "impactScore": 3.14, - "integrityImpact": "A String", - "privilegesRequired": "A String", - "scope": "A String", - "userInteraction": "A String", + "integrityImpact": "A String", # Integrity Impact (I). Defined in CVSS v2, v3. + "privilegesRequired": "A String", # Privileges Required (PR). Defined in CVSS v3, v4. + "scope": "A String", # Scope (S). Defined in CVSS v3. + "subsequentSystemAvailabilityImpact": "A String", # Subsequent System Availability Impact (SA). Defined in CVSS v4. + "subsequentSystemConfidentialityImpact": "A String", # Subsequent System Confidentiality Impact (SC). Defined in CVSS v4. + "subsequentSystemIntegrityImpact": "A String", # Subsequent System Integrity Impact (SI). Defined in CVSS v4. + "userInteraction": "A String", # User Interaction (UI). Defined in CVSS v3, v4. + "vulnerableSystemAvailabilityImpact": "A String", # Vulnerable System Availability Impact (VA). Defined in CVSS v4. + "vulnerableSystemConfidentialityImpact": "A String", # Vulnerable System Confidentiality Impact (VC). Defined in CVSS v4. + "vulnerableSystemIntegrityImpact": "A String", # Vulnerable System Integrity Impact (VI). Defined in CVSS v4. }, "effectiveSeverity": "A String", # The distro assigned severity for this vulnerability when it is available, otherwise this is the note provider assigned severity. When there are multiple PackageIssues for this vulnerability, they can have different effective severities because some might be provided by the distro while others are provided by the language ecosystem for a language pack. For this reason, it is advised to use the effective severity on the PackageIssue level. In the case where multiple PackageIssues have differing effective severities, this field should be the highest severity for any of the PackageIssues. "extraDetails": "A String", # Occurrence-specific extra details about the vulnerability. @@ -7668,33 +7773,47 @@

Method Details

"vulnerability": { # An occurrence of a severity vulnerability on a resource. # Describes a security vulnerability. "cvssScore": 3.14, # Output only. The CVSS score of this vulnerability. CVSS score is on a scale of 0 - 10 where 0 indicates low severity and 10 indicates high severity. "cvssV2": { # Common Vulnerability Scoring System. For details, see https://www.first.org/cvss/specification-document This is a message we will try to use for storing various versions of CVSS rather than making a separate proto for storing a specific version. # The cvss v2 score for the vulnerability. - "attackComplexity": "A String", - "attackVector": "A String", # Base Metrics Represents the intrinsic characteristics of a vulnerability that are constant over time and across user environments. - "authentication": "A String", - "availabilityImpact": "A String", + "attackComplexity": "A String", # Attack Complexity (AC). Defined in CVSS v2, v3, v4. + "attackRequirements": "A String", # Attack Requirements (AT). Defined in CVSS v4. + "attackVector": "A String", # Attack Vector (AV). Defined in CVSS v2, v3, v4. + "authentication": "A String", # Authentication (Au). Defined in CVSS v2. + "availabilityImpact": "A String", # Availability Impact (A). Defined in CVSS v2, v3. "baseScore": 3.14, # The base score is a function of the base metric scores. - "confidentialityImpact": "A String", + "confidentialityImpact": "A String", # Confidentiality Impact (C). Defined in CVSS v2, v3. "exploitabilityScore": 3.14, "impactScore": 3.14, - "integrityImpact": "A String", - "privilegesRequired": "A String", - "scope": "A String", - "userInteraction": "A String", + "integrityImpact": "A String", # Integrity Impact (I). Defined in CVSS v2, v3. + "privilegesRequired": "A String", # Privileges Required (PR). Defined in CVSS v3, v4. + "scope": "A String", # Scope (S). Defined in CVSS v3. + "subsequentSystemAvailabilityImpact": "A String", # Subsequent System Availability Impact (SA). Defined in CVSS v4. + "subsequentSystemConfidentialityImpact": "A String", # Subsequent System Confidentiality Impact (SC). Defined in CVSS v4. + "subsequentSystemIntegrityImpact": "A String", # Subsequent System Integrity Impact (SI). Defined in CVSS v4. + "userInteraction": "A String", # User Interaction (UI). Defined in CVSS v3, v4. + "vulnerableSystemAvailabilityImpact": "A String", # Vulnerable System Availability Impact (VA). Defined in CVSS v4. + "vulnerableSystemConfidentialityImpact": "A String", # Vulnerable System Confidentiality Impact (VC). Defined in CVSS v4. + "vulnerableSystemIntegrityImpact": "A String", # Vulnerable System Integrity Impact (VI). Defined in CVSS v4. }, "cvssVersion": "A String", # Output only. CVSS version used to populate cvss_score and severity. "cvssv3": { # Common Vulnerability Scoring System. For details, see https://www.first.org/cvss/specification-document This is a message we will try to use for storing various versions of CVSS rather than making a separate proto for storing a specific version. # The cvss v3 score for the vulnerability. - "attackComplexity": "A String", - "attackVector": "A String", # Base Metrics Represents the intrinsic characteristics of a vulnerability that are constant over time and across user environments. - "authentication": "A String", - "availabilityImpact": "A String", + "attackComplexity": "A String", # Attack Complexity (AC). Defined in CVSS v2, v3, v4. + "attackRequirements": "A String", # Attack Requirements (AT). Defined in CVSS v4. + "attackVector": "A String", # Attack Vector (AV). Defined in CVSS v2, v3, v4. + "authentication": "A String", # Authentication (Au). Defined in CVSS v2. + "availabilityImpact": "A String", # Availability Impact (A). Defined in CVSS v2, v3. "baseScore": 3.14, # The base score is a function of the base metric scores. - "confidentialityImpact": "A String", + "confidentialityImpact": "A String", # Confidentiality Impact (C). Defined in CVSS v2, v3. "exploitabilityScore": 3.14, "impactScore": 3.14, - "integrityImpact": "A String", - "privilegesRequired": "A String", - "scope": "A String", - "userInteraction": "A String", + "integrityImpact": "A String", # Integrity Impact (I). Defined in CVSS v2, v3. + "privilegesRequired": "A String", # Privileges Required (PR). Defined in CVSS v3, v4. + "scope": "A String", # Scope (S). Defined in CVSS v3. + "subsequentSystemAvailabilityImpact": "A String", # Subsequent System Availability Impact (SA). Defined in CVSS v4. + "subsequentSystemConfidentialityImpact": "A String", # Subsequent System Confidentiality Impact (SC). Defined in CVSS v4. + "subsequentSystemIntegrityImpact": "A String", # Subsequent System Integrity Impact (SI). Defined in CVSS v4. + "userInteraction": "A String", # User Interaction (UI). Defined in CVSS v3, v4. + "vulnerableSystemAvailabilityImpact": "A String", # Vulnerable System Availability Impact (VA). Defined in CVSS v4. + "vulnerableSystemConfidentialityImpact": "A String", # Vulnerable System Confidentiality Impact (VC). Defined in CVSS v4. + "vulnerableSystemIntegrityImpact": "A String", # Vulnerable System Integrity Impact (VI). Defined in CVSS v4. }, "effectiveSeverity": "A String", # The distro assigned severity for this vulnerability when it is available, otherwise this is the note provider assigned severity. When there are multiple PackageIssues for this vulnerability, they can have different effective severities because some might be provided by the distro while others are provided by the language ecosystem for a language pack. For this reason, it is advised to use the effective severity on the PackageIssue level. In the case where multiple PackageIssues have differing effective severities, this field should be the highest severity for any of the PackageIssues. "extraDetails": "A String", # Occurrence-specific extra details about the vulnerability. diff --git a/docs/dyn/containeranalysis_v1beta1.projects.locations.notes.html b/docs/dyn/containeranalysis_v1beta1.projects.locations.notes.html index aef0033dca..377d621204 100644 --- a/docs/dyn/containeranalysis_v1beta1.projects.locations.notes.html +++ b/docs/dyn/containeranalysis_v1beta1.projects.locations.notes.html @@ -300,19 +300,26 @@

Method Details

"vulnerability": { # Vulnerability provides metadata about a security vulnerability in a Note. # A note describing a package vulnerability. "advisoryPublishTime": "A String", # The time this advisory was published by the source. "cvssScore": 3.14, # The CVSS score for this vulnerability. - "cvssV2": { # Common Vulnerability Scoring System. This message is compatible with CVSS v2 and v3. For CVSS v2 details, see https://www.first.org/cvss/v2/guide CVSS v2 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v2-calculator For CVSS v3 details, see https://www.first.org/cvss/specification-document CVSS v3 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v3-calculator # The full description of the CVSS for version 2. - "attackComplexity": "A String", # Defined in CVSS v3, CVSS v2 - "attackVector": "A String", # Base Metrics Represents the intrinsic characteristics of a vulnerability that are constant over time and across user environments. Defined in CVSS v3, CVSS v2 - "authentication": "A String", # Defined in CVSS v2 - "availabilityImpact": "A String", # Defined in CVSS v3, CVSS v2 + "cvssV2": { # Common Vulnerability Scoring System. This message is compatible with CVSS v2, v3, and v4. For CVSS v2 details, see https://www.first.org/cvss/v2/guide CVSS v2 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v2-calculator For CVSS v3 details, see https://www.first.org/cvss/specification-document CVSS v3 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v3-calculator For CVSS v4 details, see https://www.first.org/cvss/v4.0/user-guide CVSS v4 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v4-calculator # The full description of the CVSS for version 2. + "attackComplexity": "A String", # Attack Complexity (AC). Defined in CVSS v2, v3, v4. + "attackRequirements": "A String", # Attack Requirements (AT). Defined in CVSS v4. + "attackVector": "A String", # Attack Vector (AV). Defined in CVSS v2, v3, v4. + "authentication": "A String", # Authentication (Au). Defined in CVSS v2. + "availabilityImpact": "A String", # Availability Impact (A). Defined in CVSS v2, v3. "baseScore": 3.14, # The base score is a function of the base metric scores. - "confidentialityImpact": "A String", # Defined in CVSS v3, CVSS v2 + "confidentialityImpact": "A String", # Confidentiality Impact (C). Defined in CVSS v2, v3. "exploitabilityScore": 3.14, "impactScore": 3.14, - "integrityImpact": "A String", # Defined in CVSS v3, CVSS v2 - "privilegesRequired": "A String", # Defined in CVSS v3 - "scope": "A String", # Defined in CVSS v3 - "userInteraction": "A String", # Defined in CVSS v3 + "integrityImpact": "A String", # Integrity Impact (I). Defined in CVSS v2, v3. + "privilegesRequired": "A String", # Privileges Required (PR). Defined in CVSS v3, v4. + "scope": "A String", # Scope (S). Defined in CVSS v3. + "subsequentSystemAvailabilityImpact": "A String", # Subsequent System Availability Impact (SA). Defined in CVSS v4. + "subsequentSystemConfidentialityImpact": "A String", # Subsequent System Confidentiality Impact (SC). Defined in CVSS v4. + "subsequentSystemIntegrityImpact": "A String", # Subsequent System Integrity Impact (SI). Defined in CVSS v4. + "userInteraction": "A String", # User Interaction (UI). Defined in CVSS v3, v4. + "vulnerableSystemAvailabilityImpact": "A String", # Vulnerable System Availability Impact (VA). Defined in CVSS v4. + "vulnerableSystemConfidentialityImpact": "A String", # Vulnerable System Confidentiality Impact (VC). Defined in CVSS v4. + "vulnerableSystemIntegrityImpact": "A String", # Vulnerable System Integrity Impact (VI). Defined in CVSS v4. }, "cvssV3": { # Deprecated. Common Vulnerability Scoring System version 3. For details, see https://www.first.org/cvss/specification-document # The full description of the CVSS for version 3. "attackComplexity": "A String", @@ -621,19 +628,26 @@

Method Details

"vulnerability": { # Vulnerability provides metadata about a security vulnerability in a Note. # A note describing a package vulnerability. "advisoryPublishTime": "A String", # The time this advisory was published by the source. "cvssScore": 3.14, # The CVSS score for this vulnerability. - "cvssV2": { # Common Vulnerability Scoring System. This message is compatible with CVSS v2 and v3. For CVSS v2 details, see https://www.first.org/cvss/v2/guide CVSS v2 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v2-calculator For CVSS v3 details, see https://www.first.org/cvss/specification-document CVSS v3 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v3-calculator # The full description of the CVSS for version 2. - "attackComplexity": "A String", # Defined in CVSS v3, CVSS v2 - "attackVector": "A String", # Base Metrics Represents the intrinsic characteristics of a vulnerability that are constant over time and across user environments. Defined in CVSS v3, CVSS v2 - "authentication": "A String", # Defined in CVSS v2 - "availabilityImpact": "A String", # Defined in CVSS v3, CVSS v2 + "cvssV2": { # Common Vulnerability Scoring System. This message is compatible with CVSS v2, v3, and v4. For CVSS v2 details, see https://www.first.org/cvss/v2/guide CVSS v2 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v2-calculator For CVSS v3 details, see https://www.first.org/cvss/specification-document CVSS v3 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v3-calculator For CVSS v4 details, see https://www.first.org/cvss/v4.0/user-guide CVSS v4 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v4-calculator # The full description of the CVSS for version 2. + "attackComplexity": "A String", # Attack Complexity (AC). Defined in CVSS v2, v3, v4. + "attackRequirements": "A String", # Attack Requirements (AT). Defined in CVSS v4. + "attackVector": "A String", # Attack Vector (AV). Defined in CVSS v2, v3, v4. + "authentication": "A String", # Authentication (Au). Defined in CVSS v2. + "availabilityImpact": "A String", # Availability Impact (A). Defined in CVSS v2, v3. "baseScore": 3.14, # The base score is a function of the base metric scores. - "confidentialityImpact": "A String", # Defined in CVSS v3, CVSS v2 + "confidentialityImpact": "A String", # Confidentiality Impact (C). Defined in CVSS v2, v3. "exploitabilityScore": 3.14, "impactScore": 3.14, - "integrityImpact": "A String", # Defined in CVSS v3, CVSS v2 - "privilegesRequired": "A String", # Defined in CVSS v3 - "scope": "A String", # Defined in CVSS v3 - "userInteraction": "A String", # Defined in CVSS v3 + "integrityImpact": "A String", # Integrity Impact (I). Defined in CVSS v2, v3. + "privilegesRequired": "A String", # Privileges Required (PR). Defined in CVSS v3, v4. + "scope": "A String", # Scope (S). Defined in CVSS v3. + "subsequentSystemAvailabilityImpact": "A String", # Subsequent System Availability Impact (SA). Defined in CVSS v4. + "subsequentSystemConfidentialityImpact": "A String", # Subsequent System Confidentiality Impact (SC). Defined in CVSS v4. + "subsequentSystemIntegrityImpact": "A String", # Subsequent System Integrity Impact (SI). Defined in CVSS v4. + "userInteraction": "A String", # User Interaction (UI). Defined in CVSS v3, v4. + "vulnerableSystemAvailabilityImpact": "A String", # Vulnerable System Availability Impact (VA). Defined in CVSS v4. + "vulnerableSystemConfidentialityImpact": "A String", # Vulnerable System Confidentiality Impact (VC). Defined in CVSS v4. + "vulnerableSystemIntegrityImpact": "A String", # Vulnerable System Integrity Impact (VI). Defined in CVSS v4. }, "cvssV3": { # Deprecated. Common Vulnerability Scoring System version 3. For details, see https://www.first.org/cvss/specification-document # The full description of the CVSS for version 3. "attackComplexity": "A String", @@ -947,19 +961,26 @@

Method Details

"vulnerability": { # Vulnerability provides metadata about a security vulnerability in a Note. # A note describing a package vulnerability. "advisoryPublishTime": "A String", # The time this advisory was published by the source. "cvssScore": 3.14, # The CVSS score for this vulnerability. - "cvssV2": { # Common Vulnerability Scoring System. This message is compatible with CVSS v2 and v3. For CVSS v2 details, see https://www.first.org/cvss/v2/guide CVSS v2 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v2-calculator For CVSS v3 details, see https://www.first.org/cvss/specification-document CVSS v3 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v3-calculator # The full description of the CVSS for version 2. - "attackComplexity": "A String", # Defined in CVSS v3, CVSS v2 - "attackVector": "A String", # Base Metrics Represents the intrinsic characteristics of a vulnerability that are constant over time and across user environments. Defined in CVSS v3, CVSS v2 - "authentication": "A String", # Defined in CVSS v2 - "availabilityImpact": "A String", # Defined in CVSS v3, CVSS v2 + "cvssV2": { # Common Vulnerability Scoring System. This message is compatible with CVSS v2, v3, and v4. For CVSS v2 details, see https://www.first.org/cvss/v2/guide CVSS v2 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v2-calculator For CVSS v3 details, see https://www.first.org/cvss/specification-document CVSS v3 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v3-calculator For CVSS v4 details, see https://www.first.org/cvss/v4.0/user-guide CVSS v4 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v4-calculator # The full description of the CVSS for version 2. + "attackComplexity": "A String", # Attack Complexity (AC). Defined in CVSS v2, v3, v4. + "attackRequirements": "A String", # Attack Requirements (AT). Defined in CVSS v4. + "attackVector": "A String", # Attack Vector (AV). Defined in CVSS v2, v3, v4. + "authentication": "A String", # Authentication (Au). Defined in CVSS v2. + "availabilityImpact": "A String", # Availability Impact (A). Defined in CVSS v2, v3. "baseScore": 3.14, # The base score is a function of the base metric scores. - "confidentialityImpact": "A String", # Defined in CVSS v3, CVSS v2 + "confidentialityImpact": "A String", # Confidentiality Impact (C). Defined in CVSS v2, v3. "exploitabilityScore": 3.14, "impactScore": 3.14, - "integrityImpact": "A String", # Defined in CVSS v3, CVSS v2 - "privilegesRequired": "A String", # Defined in CVSS v3 - "scope": "A String", # Defined in CVSS v3 - "userInteraction": "A String", # Defined in CVSS v3 + "integrityImpact": "A String", # Integrity Impact (I). Defined in CVSS v2, v3. + "privilegesRequired": "A String", # Privileges Required (PR). Defined in CVSS v3, v4. + "scope": "A String", # Scope (S). Defined in CVSS v3. + "subsequentSystemAvailabilityImpact": "A String", # Subsequent System Availability Impact (SA). Defined in CVSS v4. + "subsequentSystemConfidentialityImpact": "A String", # Subsequent System Confidentiality Impact (SC). Defined in CVSS v4. + "subsequentSystemIntegrityImpact": "A String", # Subsequent System Integrity Impact (SI). Defined in CVSS v4. + "userInteraction": "A String", # User Interaction (UI). Defined in CVSS v3, v4. + "vulnerableSystemAvailabilityImpact": "A String", # Vulnerable System Availability Impact (VA). Defined in CVSS v4. + "vulnerableSystemConfidentialityImpact": "A String", # Vulnerable System Confidentiality Impact (VC). Defined in CVSS v4. + "vulnerableSystemIntegrityImpact": "A String", # Vulnerable System Integrity Impact (VI). Defined in CVSS v4. }, "cvssV3": { # Deprecated. Common Vulnerability Scoring System version 3. For details, see https://www.first.org/cvss/specification-document # The full description of the CVSS for version 3. "attackComplexity": "A String", @@ -1265,19 +1286,26 @@

Method Details

"vulnerability": { # Vulnerability provides metadata about a security vulnerability in a Note. # A note describing a package vulnerability. "advisoryPublishTime": "A String", # The time this advisory was published by the source. "cvssScore": 3.14, # The CVSS score for this vulnerability. - "cvssV2": { # Common Vulnerability Scoring System. This message is compatible with CVSS v2 and v3. For CVSS v2 details, see https://www.first.org/cvss/v2/guide CVSS v2 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v2-calculator For CVSS v3 details, see https://www.first.org/cvss/specification-document CVSS v3 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v3-calculator # The full description of the CVSS for version 2. - "attackComplexity": "A String", # Defined in CVSS v3, CVSS v2 - "attackVector": "A String", # Base Metrics Represents the intrinsic characteristics of a vulnerability that are constant over time and across user environments. Defined in CVSS v3, CVSS v2 - "authentication": "A String", # Defined in CVSS v2 - "availabilityImpact": "A String", # Defined in CVSS v3, CVSS v2 + "cvssV2": { # Common Vulnerability Scoring System. This message is compatible with CVSS v2, v3, and v4. For CVSS v2 details, see https://www.first.org/cvss/v2/guide CVSS v2 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v2-calculator For CVSS v3 details, see https://www.first.org/cvss/specification-document CVSS v3 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v3-calculator For CVSS v4 details, see https://www.first.org/cvss/v4.0/user-guide CVSS v4 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v4-calculator # The full description of the CVSS for version 2. + "attackComplexity": "A String", # Attack Complexity (AC). Defined in CVSS v2, v3, v4. + "attackRequirements": "A String", # Attack Requirements (AT). Defined in CVSS v4. + "attackVector": "A String", # Attack Vector (AV). Defined in CVSS v2, v3, v4. + "authentication": "A String", # Authentication (Au). Defined in CVSS v2. + "availabilityImpact": "A String", # Availability Impact (A). Defined in CVSS v2, v3. "baseScore": 3.14, # The base score is a function of the base metric scores. - "confidentialityImpact": "A String", # Defined in CVSS v3, CVSS v2 + "confidentialityImpact": "A String", # Confidentiality Impact (C). Defined in CVSS v2, v3. "exploitabilityScore": 3.14, "impactScore": 3.14, - "integrityImpact": "A String", # Defined in CVSS v3, CVSS v2 - "privilegesRequired": "A String", # Defined in CVSS v3 - "scope": "A String", # Defined in CVSS v3 - "userInteraction": "A String", # Defined in CVSS v3 + "integrityImpact": "A String", # Integrity Impact (I). Defined in CVSS v2, v3. + "privilegesRequired": "A String", # Privileges Required (PR). Defined in CVSS v3, v4. + "scope": "A String", # Scope (S). Defined in CVSS v3. + "subsequentSystemAvailabilityImpact": "A String", # Subsequent System Availability Impact (SA). Defined in CVSS v4. + "subsequentSystemConfidentialityImpact": "A String", # Subsequent System Confidentiality Impact (SC). Defined in CVSS v4. + "subsequentSystemIntegrityImpact": "A String", # Subsequent System Integrity Impact (SI). Defined in CVSS v4. + "userInteraction": "A String", # User Interaction (UI). Defined in CVSS v3, v4. + "vulnerableSystemAvailabilityImpact": "A String", # Vulnerable System Availability Impact (VA). Defined in CVSS v4. + "vulnerableSystemConfidentialityImpact": "A String", # Vulnerable System Confidentiality Impact (VC). Defined in CVSS v4. + "vulnerableSystemIntegrityImpact": "A String", # Vulnerable System Integrity Impact (VI). Defined in CVSS v4. }, "cvssV3": { # Deprecated. Common Vulnerability Scoring System version 3. For details, see https://www.first.org/cvss/specification-document # The full description of the CVSS for version 3. "attackComplexity": "A String", @@ -1607,19 +1635,26 @@

Method Details

"vulnerability": { # Vulnerability provides metadata about a security vulnerability in a Note. # A note describing a package vulnerability. "advisoryPublishTime": "A String", # The time this advisory was published by the source. "cvssScore": 3.14, # The CVSS score for this vulnerability. - "cvssV2": { # Common Vulnerability Scoring System. This message is compatible with CVSS v2 and v3. For CVSS v2 details, see https://www.first.org/cvss/v2/guide CVSS v2 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v2-calculator For CVSS v3 details, see https://www.first.org/cvss/specification-document CVSS v3 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v3-calculator # The full description of the CVSS for version 2. - "attackComplexity": "A String", # Defined in CVSS v3, CVSS v2 - "attackVector": "A String", # Base Metrics Represents the intrinsic characteristics of a vulnerability that are constant over time and across user environments. Defined in CVSS v3, CVSS v2 - "authentication": "A String", # Defined in CVSS v2 - "availabilityImpact": "A String", # Defined in CVSS v3, CVSS v2 + "cvssV2": { # Common Vulnerability Scoring System. This message is compatible with CVSS v2, v3, and v4. For CVSS v2 details, see https://www.first.org/cvss/v2/guide CVSS v2 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v2-calculator For CVSS v3 details, see https://www.first.org/cvss/specification-document CVSS v3 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v3-calculator For CVSS v4 details, see https://www.first.org/cvss/v4.0/user-guide CVSS v4 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v4-calculator # The full description of the CVSS for version 2. + "attackComplexity": "A String", # Attack Complexity (AC). Defined in CVSS v2, v3, v4. + "attackRequirements": "A String", # Attack Requirements (AT). Defined in CVSS v4. + "attackVector": "A String", # Attack Vector (AV). Defined in CVSS v2, v3, v4. + "authentication": "A String", # Authentication (Au). Defined in CVSS v2. + "availabilityImpact": "A String", # Availability Impact (A). Defined in CVSS v2, v3. "baseScore": 3.14, # The base score is a function of the base metric scores. - "confidentialityImpact": "A String", # Defined in CVSS v3, CVSS v2 + "confidentialityImpact": "A String", # Confidentiality Impact (C). Defined in CVSS v2, v3. "exploitabilityScore": 3.14, "impactScore": 3.14, - "integrityImpact": "A String", # Defined in CVSS v3, CVSS v2 - "privilegesRequired": "A String", # Defined in CVSS v3 - "scope": "A String", # Defined in CVSS v3 - "userInteraction": "A String", # Defined in CVSS v3 + "integrityImpact": "A String", # Integrity Impact (I). Defined in CVSS v2, v3. + "privilegesRequired": "A String", # Privileges Required (PR). Defined in CVSS v3, v4. + "scope": "A String", # Scope (S). Defined in CVSS v3. + "subsequentSystemAvailabilityImpact": "A String", # Subsequent System Availability Impact (SA). Defined in CVSS v4. + "subsequentSystemConfidentialityImpact": "A String", # Subsequent System Confidentiality Impact (SC). Defined in CVSS v4. + "subsequentSystemIntegrityImpact": "A String", # Subsequent System Integrity Impact (SI). Defined in CVSS v4. + "userInteraction": "A String", # User Interaction (UI). Defined in CVSS v3, v4. + "vulnerableSystemAvailabilityImpact": "A String", # Vulnerable System Availability Impact (VA). Defined in CVSS v4. + "vulnerableSystemConfidentialityImpact": "A String", # Vulnerable System Confidentiality Impact (VC). Defined in CVSS v4. + "vulnerableSystemIntegrityImpact": "A String", # Vulnerable System Integrity Impact (VI). Defined in CVSS v4. }, "cvssV3": { # Deprecated. Common Vulnerability Scoring System version 3. For details, see https://www.first.org/cvss/specification-document # The full description of the CVSS for version 3. "attackComplexity": "A String", @@ -1981,19 +2016,26 @@

Method Details

"vulnerability": { # Vulnerability provides metadata about a security vulnerability in a Note. # A note describing a package vulnerability. "advisoryPublishTime": "A String", # The time this advisory was published by the source. "cvssScore": 3.14, # The CVSS score for this vulnerability. - "cvssV2": { # Common Vulnerability Scoring System. This message is compatible with CVSS v2 and v3. For CVSS v2 details, see https://www.first.org/cvss/v2/guide CVSS v2 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v2-calculator For CVSS v3 details, see https://www.first.org/cvss/specification-document CVSS v3 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v3-calculator # The full description of the CVSS for version 2. - "attackComplexity": "A String", # Defined in CVSS v3, CVSS v2 - "attackVector": "A String", # Base Metrics Represents the intrinsic characteristics of a vulnerability that are constant over time and across user environments. Defined in CVSS v3, CVSS v2 - "authentication": "A String", # Defined in CVSS v2 - "availabilityImpact": "A String", # Defined in CVSS v3, CVSS v2 + "cvssV2": { # Common Vulnerability Scoring System. This message is compatible with CVSS v2, v3, and v4. For CVSS v2 details, see https://www.first.org/cvss/v2/guide CVSS v2 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v2-calculator For CVSS v3 details, see https://www.first.org/cvss/specification-document CVSS v3 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v3-calculator For CVSS v4 details, see https://www.first.org/cvss/v4.0/user-guide CVSS v4 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v4-calculator # The full description of the CVSS for version 2. + "attackComplexity": "A String", # Attack Complexity (AC). Defined in CVSS v2, v3, v4. + "attackRequirements": "A String", # Attack Requirements (AT). Defined in CVSS v4. + "attackVector": "A String", # Attack Vector (AV). Defined in CVSS v2, v3, v4. + "authentication": "A String", # Authentication (Au). Defined in CVSS v2. + "availabilityImpact": "A String", # Availability Impact (A). Defined in CVSS v2, v3. "baseScore": 3.14, # The base score is a function of the base metric scores. - "confidentialityImpact": "A String", # Defined in CVSS v3, CVSS v2 + "confidentialityImpact": "A String", # Confidentiality Impact (C). Defined in CVSS v2, v3. "exploitabilityScore": 3.14, "impactScore": 3.14, - "integrityImpact": "A String", # Defined in CVSS v3, CVSS v2 - "privilegesRequired": "A String", # Defined in CVSS v3 - "scope": "A String", # Defined in CVSS v3 - "userInteraction": "A String", # Defined in CVSS v3 + "integrityImpact": "A String", # Integrity Impact (I). Defined in CVSS v2, v3. + "privilegesRequired": "A String", # Privileges Required (PR). Defined in CVSS v3, v4. + "scope": "A String", # Scope (S). Defined in CVSS v3. + "subsequentSystemAvailabilityImpact": "A String", # Subsequent System Availability Impact (SA). Defined in CVSS v4. + "subsequentSystemConfidentialityImpact": "A String", # Subsequent System Confidentiality Impact (SC). Defined in CVSS v4. + "subsequentSystemIntegrityImpact": "A String", # Subsequent System Integrity Impact (SI). Defined in CVSS v4. + "userInteraction": "A String", # User Interaction (UI). Defined in CVSS v3, v4. + "vulnerableSystemAvailabilityImpact": "A String", # Vulnerable System Availability Impact (VA). Defined in CVSS v4. + "vulnerableSystemConfidentialityImpact": "A String", # Vulnerable System Confidentiality Impact (VC). Defined in CVSS v4. + "vulnerableSystemIntegrityImpact": "A String", # Vulnerable System Integrity Impact (VI). Defined in CVSS v4. }, "cvssV3": { # Deprecated. Common Vulnerability Scoring System version 3. For details, see https://www.first.org/cvss/specification-document # The full description of the CVSS for version 3. "attackComplexity": "A String", @@ -2319,19 +2361,26 @@

Method Details

"vulnerability": { # Vulnerability provides metadata about a security vulnerability in a Note. # A note describing a package vulnerability. "advisoryPublishTime": "A String", # The time this advisory was published by the source. "cvssScore": 3.14, # The CVSS score for this vulnerability. - "cvssV2": { # Common Vulnerability Scoring System. This message is compatible with CVSS v2 and v3. For CVSS v2 details, see https://www.first.org/cvss/v2/guide CVSS v2 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v2-calculator For CVSS v3 details, see https://www.first.org/cvss/specification-document CVSS v3 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v3-calculator # The full description of the CVSS for version 2. - "attackComplexity": "A String", # Defined in CVSS v3, CVSS v2 - "attackVector": "A String", # Base Metrics Represents the intrinsic characteristics of a vulnerability that are constant over time and across user environments. Defined in CVSS v3, CVSS v2 - "authentication": "A String", # Defined in CVSS v2 - "availabilityImpact": "A String", # Defined in CVSS v3, CVSS v2 + "cvssV2": { # Common Vulnerability Scoring System. This message is compatible with CVSS v2, v3, and v4. For CVSS v2 details, see https://www.first.org/cvss/v2/guide CVSS v2 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v2-calculator For CVSS v3 details, see https://www.first.org/cvss/specification-document CVSS v3 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v3-calculator For CVSS v4 details, see https://www.first.org/cvss/v4.0/user-guide CVSS v4 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v4-calculator # The full description of the CVSS for version 2. + "attackComplexity": "A String", # Attack Complexity (AC). Defined in CVSS v2, v3, v4. + "attackRequirements": "A String", # Attack Requirements (AT). Defined in CVSS v4. + "attackVector": "A String", # Attack Vector (AV). Defined in CVSS v2, v3, v4. + "authentication": "A String", # Authentication (Au). Defined in CVSS v2. + "availabilityImpact": "A String", # Availability Impact (A). Defined in CVSS v2, v3. "baseScore": 3.14, # The base score is a function of the base metric scores. - "confidentialityImpact": "A String", # Defined in CVSS v3, CVSS v2 + "confidentialityImpact": "A String", # Confidentiality Impact (C). Defined in CVSS v2, v3. "exploitabilityScore": 3.14, "impactScore": 3.14, - "integrityImpact": "A String", # Defined in CVSS v3, CVSS v2 - "privilegesRequired": "A String", # Defined in CVSS v3 - "scope": "A String", # Defined in CVSS v3 - "userInteraction": "A String", # Defined in CVSS v3 + "integrityImpact": "A String", # Integrity Impact (I). Defined in CVSS v2, v3. + "privilegesRequired": "A String", # Privileges Required (PR). Defined in CVSS v3, v4. + "scope": "A String", # Scope (S). Defined in CVSS v3. + "subsequentSystemAvailabilityImpact": "A String", # Subsequent System Availability Impact (SA). Defined in CVSS v4. + "subsequentSystemConfidentialityImpact": "A String", # Subsequent System Confidentiality Impact (SC). Defined in CVSS v4. + "subsequentSystemIntegrityImpact": "A String", # Subsequent System Integrity Impact (SI). Defined in CVSS v4. + "userInteraction": "A String", # User Interaction (UI). Defined in CVSS v3, v4. + "vulnerableSystemAvailabilityImpact": "A String", # Vulnerable System Availability Impact (VA). Defined in CVSS v4. + "vulnerableSystemConfidentialityImpact": "A String", # Vulnerable System Confidentiality Impact (VC). Defined in CVSS v4. + "vulnerableSystemIntegrityImpact": "A String", # Vulnerable System Integrity Impact (VI). Defined in CVSS v4. }, "cvssV3": { # Deprecated. Common Vulnerability Scoring System version 3. For details, see https://www.first.org/cvss/specification-document # The full description of the CVSS for version 3. "attackComplexity": "A String", @@ -2637,19 +2686,26 @@

Method Details

"vulnerability": { # Vulnerability provides metadata about a security vulnerability in a Note. # A note describing a package vulnerability. "advisoryPublishTime": "A String", # The time this advisory was published by the source. "cvssScore": 3.14, # The CVSS score for this vulnerability. - "cvssV2": { # Common Vulnerability Scoring System. This message is compatible with CVSS v2 and v3. For CVSS v2 details, see https://www.first.org/cvss/v2/guide CVSS v2 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v2-calculator For CVSS v3 details, see https://www.first.org/cvss/specification-document CVSS v3 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v3-calculator # The full description of the CVSS for version 2. - "attackComplexity": "A String", # Defined in CVSS v3, CVSS v2 - "attackVector": "A String", # Base Metrics Represents the intrinsic characteristics of a vulnerability that are constant over time and across user environments. Defined in CVSS v3, CVSS v2 - "authentication": "A String", # Defined in CVSS v2 - "availabilityImpact": "A String", # Defined in CVSS v3, CVSS v2 + "cvssV2": { # Common Vulnerability Scoring System. This message is compatible with CVSS v2, v3, and v4. For CVSS v2 details, see https://www.first.org/cvss/v2/guide CVSS v2 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v2-calculator For CVSS v3 details, see https://www.first.org/cvss/specification-document CVSS v3 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v3-calculator For CVSS v4 details, see https://www.first.org/cvss/v4.0/user-guide CVSS v4 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v4-calculator # The full description of the CVSS for version 2. + "attackComplexity": "A String", # Attack Complexity (AC). Defined in CVSS v2, v3, v4. + "attackRequirements": "A String", # Attack Requirements (AT). Defined in CVSS v4. + "attackVector": "A String", # Attack Vector (AV). Defined in CVSS v2, v3, v4. + "authentication": "A String", # Authentication (Au). Defined in CVSS v2. + "availabilityImpact": "A String", # Availability Impact (A). Defined in CVSS v2, v3. "baseScore": 3.14, # The base score is a function of the base metric scores. - "confidentialityImpact": "A String", # Defined in CVSS v3, CVSS v2 + "confidentialityImpact": "A String", # Confidentiality Impact (C). Defined in CVSS v2, v3. "exploitabilityScore": 3.14, "impactScore": 3.14, - "integrityImpact": "A String", # Defined in CVSS v3, CVSS v2 - "privilegesRequired": "A String", # Defined in CVSS v3 - "scope": "A String", # Defined in CVSS v3 - "userInteraction": "A String", # Defined in CVSS v3 + "integrityImpact": "A String", # Integrity Impact (I). Defined in CVSS v2, v3. + "privilegesRequired": "A String", # Privileges Required (PR). Defined in CVSS v3, v4. + "scope": "A String", # Scope (S). Defined in CVSS v3. + "subsequentSystemAvailabilityImpact": "A String", # Subsequent System Availability Impact (SA). Defined in CVSS v4. + "subsequentSystemConfidentialityImpact": "A String", # Subsequent System Confidentiality Impact (SC). Defined in CVSS v4. + "subsequentSystemIntegrityImpact": "A String", # Subsequent System Integrity Impact (SI). Defined in CVSS v4. + "userInteraction": "A String", # User Interaction (UI). Defined in CVSS v3, v4. + "vulnerableSystemAvailabilityImpact": "A String", # Vulnerable System Availability Impact (VA). Defined in CVSS v4. + "vulnerableSystemConfidentialityImpact": "A String", # Vulnerable System Confidentiality Impact (VC). Defined in CVSS v4. + "vulnerableSystemIntegrityImpact": "A String", # Vulnerable System Integrity Impact (VI). Defined in CVSS v4. }, "cvssV3": { # Deprecated. Common Vulnerability Scoring System version 3. For details, see https://www.first.org/cvss/specification-document # The full description of the CVSS for version 3. "attackComplexity": "A String", diff --git a/docs/dyn/containeranalysis_v1beta1.projects.locations.notes.occurrences.html b/docs/dyn/containeranalysis_v1beta1.projects.locations.notes.occurrences.html index d24f80d5fa..08b8a7abbc 100644 --- a/docs/dyn/containeranalysis_v1beta1.projects.locations.notes.occurrences.html +++ b/docs/dyn/containeranalysis_v1beta1.projects.locations.notes.occurrences.html @@ -622,33 +622,47 @@

Method Details

"updateTime": "A String", # Output only. The time this occurrence was last updated. "vulnerability": { # Details of a vulnerability Occurrence. # Describes a security vulnerability. "cvssScore": 3.14, # Output only. The CVSS score of this vulnerability. CVSS score is on a scale of 0-10 where 0 indicates low severity and 10 indicates high severity. - "cvssV2": { # Common Vulnerability Scoring System. This message is compatible with CVSS v2 and v3. For CVSS v2 details, see https://www.first.org/cvss/v2/guide CVSS v2 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v2-calculator For CVSS v3 details, see https://www.first.org/cvss/specification-document CVSS v3 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v3-calculator # The cvss v2 score for the vulnerability. - "attackComplexity": "A String", # Defined in CVSS v3, CVSS v2 - "attackVector": "A String", # Base Metrics Represents the intrinsic characteristics of a vulnerability that are constant over time and across user environments. Defined in CVSS v3, CVSS v2 - "authentication": "A String", # Defined in CVSS v2 - "availabilityImpact": "A String", # Defined in CVSS v3, CVSS v2 + "cvssV2": { # Common Vulnerability Scoring System. This message is compatible with CVSS v2, v3, and v4. For CVSS v2 details, see https://www.first.org/cvss/v2/guide CVSS v2 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v2-calculator For CVSS v3 details, see https://www.first.org/cvss/specification-document CVSS v3 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v3-calculator For CVSS v4 details, see https://www.first.org/cvss/v4.0/user-guide CVSS v4 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v4-calculator # The cvss v2 score for the vulnerability. + "attackComplexity": "A String", # Attack Complexity (AC). Defined in CVSS v2, v3, v4. + "attackRequirements": "A String", # Attack Requirements (AT). Defined in CVSS v4. + "attackVector": "A String", # Attack Vector (AV). Defined in CVSS v2, v3, v4. + "authentication": "A String", # Authentication (Au). Defined in CVSS v2. + "availabilityImpact": "A String", # Availability Impact (A). Defined in CVSS v2, v3. "baseScore": 3.14, # The base score is a function of the base metric scores. - "confidentialityImpact": "A String", # Defined in CVSS v3, CVSS v2 + "confidentialityImpact": "A String", # Confidentiality Impact (C). Defined in CVSS v2, v3. "exploitabilityScore": 3.14, "impactScore": 3.14, - "integrityImpact": "A String", # Defined in CVSS v3, CVSS v2 - "privilegesRequired": "A String", # Defined in CVSS v3 - "scope": "A String", # Defined in CVSS v3 - "userInteraction": "A String", # Defined in CVSS v3 + "integrityImpact": "A String", # Integrity Impact (I). Defined in CVSS v2, v3. + "privilegesRequired": "A String", # Privileges Required (PR). Defined in CVSS v3, v4. + "scope": "A String", # Scope (S). Defined in CVSS v3. + "subsequentSystemAvailabilityImpact": "A String", # Subsequent System Availability Impact (SA). Defined in CVSS v4. + "subsequentSystemConfidentialityImpact": "A String", # Subsequent System Confidentiality Impact (SC). Defined in CVSS v4. + "subsequentSystemIntegrityImpact": "A String", # Subsequent System Integrity Impact (SI). Defined in CVSS v4. + "userInteraction": "A String", # User Interaction (UI). Defined in CVSS v3, v4. + "vulnerableSystemAvailabilityImpact": "A String", # Vulnerable System Availability Impact (VA). Defined in CVSS v4. + "vulnerableSystemConfidentialityImpact": "A String", # Vulnerable System Confidentiality Impact (VC). Defined in CVSS v4. + "vulnerableSystemIntegrityImpact": "A String", # Vulnerable System Integrity Impact (VI). Defined in CVSS v4. }, - "cvssV3": { # Common Vulnerability Scoring System. This message is compatible with CVSS v2 and v3. For CVSS v2 details, see https://www.first.org/cvss/v2/guide CVSS v2 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v2-calculator For CVSS v3 details, see https://www.first.org/cvss/specification-document CVSS v3 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v3-calculator # The cvss v3 score for the vulnerability. - "attackComplexity": "A String", # Defined in CVSS v3, CVSS v2 - "attackVector": "A String", # Base Metrics Represents the intrinsic characteristics of a vulnerability that are constant over time and across user environments. Defined in CVSS v3, CVSS v2 - "authentication": "A String", # Defined in CVSS v2 - "availabilityImpact": "A String", # Defined in CVSS v3, CVSS v2 + "cvssV3": { # Common Vulnerability Scoring System. This message is compatible with CVSS v2, v3, and v4. For CVSS v2 details, see https://www.first.org/cvss/v2/guide CVSS v2 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v2-calculator For CVSS v3 details, see https://www.first.org/cvss/specification-document CVSS v3 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v3-calculator For CVSS v4 details, see https://www.first.org/cvss/v4.0/user-guide CVSS v4 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v4-calculator # The cvss v3 score for the vulnerability. + "attackComplexity": "A String", # Attack Complexity (AC). Defined in CVSS v2, v3, v4. + "attackRequirements": "A String", # Attack Requirements (AT). Defined in CVSS v4. + "attackVector": "A String", # Attack Vector (AV). Defined in CVSS v2, v3, v4. + "authentication": "A String", # Authentication (Au). Defined in CVSS v2. + "availabilityImpact": "A String", # Availability Impact (A). Defined in CVSS v2, v3. "baseScore": 3.14, # The base score is a function of the base metric scores. - "confidentialityImpact": "A String", # Defined in CVSS v3, CVSS v2 + "confidentialityImpact": "A String", # Confidentiality Impact (C). Defined in CVSS v2, v3. "exploitabilityScore": 3.14, "impactScore": 3.14, - "integrityImpact": "A String", # Defined in CVSS v3, CVSS v2 - "privilegesRequired": "A String", # Defined in CVSS v3 - "scope": "A String", # Defined in CVSS v3 - "userInteraction": "A String", # Defined in CVSS v3 + "integrityImpact": "A String", # Integrity Impact (I). Defined in CVSS v2, v3. + "privilegesRequired": "A String", # Privileges Required (PR). Defined in CVSS v3, v4. + "scope": "A String", # Scope (S). Defined in CVSS v3. + "subsequentSystemAvailabilityImpact": "A String", # Subsequent System Availability Impact (SA). Defined in CVSS v4. + "subsequentSystemConfidentialityImpact": "A String", # Subsequent System Confidentiality Impact (SC). Defined in CVSS v4. + "subsequentSystemIntegrityImpact": "A String", # Subsequent System Integrity Impact (SI). Defined in CVSS v4. + "userInteraction": "A String", # User Interaction (UI). Defined in CVSS v3, v4. + "vulnerableSystemAvailabilityImpact": "A String", # Vulnerable System Availability Impact (VA). Defined in CVSS v4. + "vulnerableSystemConfidentialityImpact": "A String", # Vulnerable System Confidentiality Impact (VC). Defined in CVSS v4. + "vulnerableSystemIntegrityImpact": "A String", # Vulnerable System Integrity Impact (VI). Defined in CVSS v4. }, "cvssVersion": "A String", # Output only. CVSS version used to populate cvss_score and severity. "effectiveSeverity": "A String", # The distro assigned severity for this vulnerability when it is available, and note provider assigned severity when distro has not yet assigned a severity for this vulnerability. When there are multiple PackageIssues for this vulnerability, they can have different effective severities because some might be provided by the distro while others are provided by the language ecosystem for a language pack. For this reason, it is advised to use the effective severity on the PackageIssue level. In the case where multiple PackageIssues have differing effective severities, this field should be the highest severity for any of the PackageIssues. diff --git a/docs/dyn/containeranalysis_v1beta1.projects.locations.occurrences.html b/docs/dyn/containeranalysis_v1beta1.projects.locations.occurrences.html index 67ba1b339c..d4dc74ec0f 100644 --- a/docs/dyn/containeranalysis_v1beta1.projects.locations.occurrences.html +++ b/docs/dyn/containeranalysis_v1beta1.projects.locations.occurrences.html @@ -638,33 +638,47 @@

Method Details

"updateTime": "A String", # Output only. The time this occurrence was last updated. "vulnerability": { # Details of a vulnerability Occurrence. # Describes a security vulnerability. "cvssScore": 3.14, # Output only. The CVSS score of this vulnerability. CVSS score is on a scale of 0-10 where 0 indicates low severity and 10 indicates high severity. - "cvssV2": { # Common Vulnerability Scoring System. This message is compatible with CVSS v2 and v3. For CVSS v2 details, see https://www.first.org/cvss/v2/guide CVSS v2 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v2-calculator For CVSS v3 details, see https://www.first.org/cvss/specification-document CVSS v3 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v3-calculator # The cvss v2 score for the vulnerability. - "attackComplexity": "A String", # Defined in CVSS v3, CVSS v2 - "attackVector": "A String", # Base Metrics Represents the intrinsic characteristics of a vulnerability that are constant over time and across user environments. Defined in CVSS v3, CVSS v2 - "authentication": "A String", # Defined in CVSS v2 - "availabilityImpact": "A String", # Defined in CVSS v3, CVSS v2 + "cvssV2": { # Common Vulnerability Scoring System. This message is compatible with CVSS v2, v3, and v4. For CVSS v2 details, see https://www.first.org/cvss/v2/guide CVSS v2 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v2-calculator For CVSS v3 details, see https://www.first.org/cvss/specification-document CVSS v3 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v3-calculator For CVSS v4 details, see https://www.first.org/cvss/v4.0/user-guide CVSS v4 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v4-calculator # The cvss v2 score for the vulnerability. + "attackComplexity": "A String", # Attack Complexity (AC). Defined in CVSS v2, v3, v4. + "attackRequirements": "A String", # Attack Requirements (AT). Defined in CVSS v4. + "attackVector": "A String", # Attack Vector (AV). Defined in CVSS v2, v3, v4. + "authentication": "A String", # Authentication (Au). Defined in CVSS v2. + "availabilityImpact": "A String", # Availability Impact (A). Defined in CVSS v2, v3. "baseScore": 3.14, # The base score is a function of the base metric scores. - "confidentialityImpact": "A String", # Defined in CVSS v3, CVSS v2 + "confidentialityImpact": "A String", # Confidentiality Impact (C). Defined in CVSS v2, v3. "exploitabilityScore": 3.14, "impactScore": 3.14, - "integrityImpact": "A String", # Defined in CVSS v3, CVSS v2 - "privilegesRequired": "A String", # Defined in CVSS v3 - "scope": "A String", # Defined in CVSS v3 - "userInteraction": "A String", # Defined in CVSS v3 - }, - "cvssV3": { # Common Vulnerability Scoring System. This message is compatible with CVSS v2 and v3. For CVSS v2 details, see https://www.first.org/cvss/v2/guide CVSS v2 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v2-calculator For CVSS v3 details, see https://www.first.org/cvss/specification-document CVSS v3 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v3-calculator # The cvss v3 score for the vulnerability. - "attackComplexity": "A String", # Defined in CVSS v3, CVSS v2 - "attackVector": "A String", # Base Metrics Represents the intrinsic characteristics of a vulnerability that are constant over time and across user environments. Defined in CVSS v3, CVSS v2 - "authentication": "A String", # Defined in CVSS v2 - "availabilityImpact": "A String", # Defined in CVSS v3, CVSS v2 + "integrityImpact": "A String", # Integrity Impact (I). Defined in CVSS v2, v3. + "privilegesRequired": "A String", # Privileges Required (PR). Defined in CVSS v3, v4. + "scope": "A String", # Scope (S). Defined in CVSS v3. + "subsequentSystemAvailabilityImpact": "A String", # Subsequent System Availability Impact (SA). Defined in CVSS v4. + "subsequentSystemConfidentialityImpact": "A String", # Subsequent System Confidentiality Impact (SC). Defined in CVSS v4. + "subsequentSystemIntegrityImpact": "A String", # Subsequent System Integrity Impact (SI). Defined in CVSS v4. + "userInteraction": "A String", # User Interaction (UI). Defined in CVSS v3, v4. + "vulnerableSystemAvailabilityImpact": "A String", # Vulnerable System Availability Impact (VA). Defined in CVSS v4. + "vulnerableSystemConfidentialityImpact": "A String", # Vulnerable System Confidentiality Impact (VC). Defined in CVSS v4. + "vulnerableSystemIntegrityImpact": "A String", # Vulnerable System Integrity Impact (VI). Defined in CVSS v4. + }, + "cvssV3": { # Common Vulnerability Scoring System. This message is compatible with CVSS v2, v3, and v4. For CVSS v2 details, see https://www.first.org/cvss/v2/guide CVSS v2 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v2-calculator For CVSS v3 details, see https://www.first.org/cvss/specification-document CVSS v3 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v3-calculator For CVSS v4 details, see https://www.first.org/cvss/v4.0/user-guide CVSS v4 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v4-calculator # The cvss v3 score for the vulnerability. + "attackComplexity": "A String", # Attack Complexity (AC). Defined in CVSS v2, v3, v4. + "attackRequirements": "A String", # Attack Requirements (AT). Defined in CVSS v4. + "attackVector": "A String", # Attack Vector (AV). Defined in CVSS v2, v3, v4. + "authentication": "A String", # Authentication (Au). Defined in CVSS v2. + "availabilityImpact": "A String", # Availability Impact (A). Defined in CVSS v2, v3. "baseScore": 3.14, # The base score is a function of the base metric scores. - "confidentialityImpact": "A String", # Defined in CVSS v3, CVSS v2 + "confidentialityImpact": "A String", # Confidentiality Impact (C). Defined in CVSS v2, v3. "exploitabilityScore": 3.14, "impactScore": 3.14, - "integrityImpact": "A String", # Defined in CVSS v3, CVSS v2 - "privilegesRequired": "A String", # Defined in CVSS v3 - "scope": "A String", # Defined in CVSS v3 - "userInteraction": "A String", # Defined in CVSS v3 + "integrityImpact": "A String", # Integrity Impact (I). Defined in CVSS v2, v3. + "privilegesRequired": "A String", # Privileges Required (PR). Defined in CVSS v3, v4. + "scope": "A String", # Scope (S). Defined in CVSS v3. + "subsequentSystemAvailabilityImpact": "A String", # Subsequent System Availability Impact (SA). Defined in CVSS v4. + "subsequentSystemConfidentialityImpact": "A String", # Subsequent System Confidentiality Impact (SC). Defined in CVSS v4. + "subsequentSystemIntegrityImpact": "A String", # Subsequent System Integrity Impact (SI). Defined in CVSS v4. + "userInteraction": "A String", # User Interaction (UI). Defined in CVSS v3, v4. + "vulnerableSystemAvailabilityImpact": "A String", # Vulnerable System Availability Impact (VA). Defined in CVSS v4. + "vulnerableSystemConfidentialityImpact": "A String", # Vulnerable System Confidentiality Impact (VC). Defined in CVSS v4. + "vulnerableSystemIntegrityImpact": "A String", # Vulnerable System Integrity Impact (VI). Defined in CVSS v4. }, "cvssVersion": "A String", # Output only. CVSS version used to populate cvss_score and severity. "effectiveSeverity": "A String", # The distro assigned severity for this vulnerability when it is available, and note provider assigned severity when distro has not yet assigned a severity for this vulnerability. When there are multiple PackageIssues for this vulnerability, they can have different effective severities because some might be provided by the distro while others are provided by the language ecosystem for a language pack. For this reason, it is advised to use the effective severity on the PackageIssue level. In the case where multiple PackageIssues have differing effective severities, this field should be the highest severity for any of the PackageIssues. @@ -1265,33 +1279,47 @@

Method Details

"updateTime": "A String", # Output only. The time this occurrence was last updated. "vulnerability": { # Details of a vulnerability Occurrence. # Describes a security vulnerability. "cvssScore": 3.14, # Output only. The CVSS score of this vulnerability. CVSS score is on a scale of 0-10 where 0 indicates low severity and 10 indicates high severity. - "cvssV2": { # Common Vulnerability Scoring System. This message is compatible with CVSS v2 and v3. For CVSS v2 details, see https://www.first.org/cvss/v2/guide CVSS v2 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v2-calculator For CVSS v3 details, see https://www.first.org/cvss/specification-document CVSS v3 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v3-calculator # The cvss v2 score for the vulnerability. - "attackComplexity": "A String", # Defined in CVSS v3, CVSS v2 - "attackVector": "A String", # Base Metrics Represents the intrinsic characteristics of a vulnerability that are constant over time and across user environments. Defined in CVSS v3, CVSS v2 - "authentication": "A String", # Defined in CVSS v2 - "availabilityImpact": "A String", # Defined in CVSS v3, CVSS v2 + "cvssV2": { # Common Vulnerability Scoring System. This message is compatible with CVSS v2, v3, and v4. For CVSS v2 details, see https://www.first.org/cvss/v2/guide CVSS v2 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v2-calculator For CVSS v3 details, see https://www.first.org/cvss/specification-document CVSS v3 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v3-calculator For CVSS v4 details, see https://www.first.org/cvss/v4.0/user-guide CVSS v4 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v4-calculator # The cvss v2 score for the vulnerability. + "attackComplexity": "A String", # Attack Complexity (AC). Defined in CVSS v2, v3, v4. + "attackRequirements": "A String", # Attack Requirements (AT). Defined in CVSS v4. + "attackVector": "A String", # Attack Vector (AV). Defined in CVSS v2, v3, v4. + "authentication": "A String", # Authentication (Au). Defined in CVSS v2. + "availabilityImpact": "A String", # Availability Impact (A). Defined in CVSS v2, v3. "baseScore": 3.14, # The base score is a function of the base metric scores. - "confidentialityImpact": "A String", # Defined in CVSS v3, CVSS v2 + "confidentialityImpact": "A String", # Confidentiality Impact (C). Defined in CVSS v2, v3. "exploitabilityScore": 3.14, "impactScore": 3.14, - "integrityImpact": "A String", # Defined in CVSS v3, CVSS v2 - "privilegesRequired": "A String", # Defined in CVSS v3 - "scope": "A String", # Defined in CVSS v3 - "userInteraction": "A String", # Defined in CVSS v3 - }, - "cvssV3": { # Common Vulnerability Scoring System. This message is compatible with CVSS v2 and v3. For CVSS v2 details, see https://www.first.org/cvss/v2/guide CVSS v2 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v2-calculator For CVSS v3 details, see https://www.first.org/cvss/specification-document CVSS v3 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v3-calculator # The cvss v3 score for the vulnerability. - "attackComplexity": "A String", # Defined in CVSS v3, CVSS v2 - "attackVector": "A String", # Base Metrics Represents the intrinsic characteristics of a vulnerability that are constant over time and across user environments. Defined in CVSS v3, CVSS v2 - "authentication": "A String", # Defined in CVSS v2 - "availabilityImpact": "A String", # Defined in CVSS v3, CVSS v2 + "integrityImpact": "A String", # Integrity Impact (I). Defined in CVSS v2, v3. + "privilegesRequired": "A String", # Privileges Required (PR). Defined in CVSS v3, v4. + "scope": "A String", # Scope (S). Defined in CVSS v3. + "subsequentSystemAvailabilityImpact": "A String", # Subsequent System Availability Impact (SA). Defined in CVSS v4. + "subsequentSystemConfidentialityImpact": "A String", # Subsequent System Confidentiality Impact (SC). Defined in CVSS v4. + "subsequentSystemIntegrityImpact": "A String", # Subsequent System Integrity Impact (SI). Defined in CVSS v4. + "userInteraction": "A String", # User Interaction (UI). Defined in CVSS v3, v4. + "vulnerableSystemAvailabilityImpact": "A String", # Vulnerable System Availability Impact (VA). Defined in CVSS v4. + "vulnerableSystemConfidentialityImpact": "A String", # Vulnerable System Confidentiality Impact (VC). Defined in CVSS v4. + "vulnerableSystemIntegrityImpact": "A String", # Vulnerable System Integrity Impact (VI). Defined in CVSS v4. + }, + "cvssV3": { # Common Vulnerability Scoring System. This message is compatible with CVSS v2, v3, and v4. For CVSS v2 details, see https://www.first.org/cvss/v2/guide CVSS v2 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v2-calculator For CVSS v3 details, see https://www.first.org/cvss/specification-document CVSS v3 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v3-calculator For CVSS v4 details, see https://www.first.org/cvss/v4.0/user-guide CVSS v4 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v4-calculator # The cvss v3 score for the vulnerability. + "attackComplexity": "A String", # Attack Complexity (AC). Defined in CVSS v2, v3, v4. + "attackRequirements": "A String", # Attack Requirements (AT). Defined in CVSS v4. + "attackVector": "A String", # Attack Vector (AV). Defined in CVSS v2, v3, v4. + "authentication": "A String", # Authentication (Au). Defined in CVSS v2. + "availabilityImpact": "A String", # Availability Impact (A). Defined in CVSS v2, v3. "baseScore": 3.14, # The base score is a function of the base metric scores. - "confidentialityImpact": "A String", # Defined in CVSS v3, CVSS v2 + "confidentialityImpact": "A String", # Confidentiality Impact (C). Defined in CVSS v2, v3. "exploitabilityScore": 3.14, "impactScore": 3.14, - "integrityImpact": "A String", # Defined in CVSS v3, CVSS v2 - "privilegesRequired": "A String", # Defined in CVSS v3 - "scope": "A String", # Defined in CVSS v3 - "userInteraction": "A String", # Defined in CVSS v3 + "integrityImpact": "A String", # Integrity Impact (I). Defined in CVSS v2, v3. + "privilegesRequired": "A String", # Privileges Required (PR). Defined in CVSS v3, v4. + "scope": "A String", # Scope (S). Defined in CVSS v3. + "subsequentSystemAvailabilityImpact": "A String", # Subsequent System Availability Impact (SA). Defined in CVSS v4. + "subsequentSystemConfidentialityImpact": "A String", # Subsequent System Confidentiality Impact (SC). Defined in CVSS v4. + "subsequentSystemIntegrityImpact": "A String", # Subsequent System Integrity Impact (SI). Defined in CVSS v4. + "userInteraction": "A String", # User Interaction (UI). Defined in CVSS v3, v4. + "vulnerableSystemAvailabilityImpact": "A String", # Vulnerable System Availability Impact (VA). Defined in CVSS v4. + "vulnerableSystemConfidentialityImpact": "A String", # Vulnerable System Confidentiality Impact (VC). Defined in CVSS v4. + "vulnerableSystemIntegrityImpact": "A String", # Vulnerable System Integrity Impact (VI). Defined in CVSS v4. }, "cvssVersion": "A String", # Output only. CVSS version used to populate cvss_score and severity. "effectiveSeverity": "A String", # The distro assigned severity for this vulnerability when it is available, and note provider assigned severity when distro has not yet assigned a severity for this vulnerability. When there are multiple PackageIssues for this vulnerability, they can have different effective severities because some might be provided by the distro while others are provided by the language ecosystem for a language pack. For this reason, it is advised to use the effective severity on the PackageIssue level. In the case where multiple PackageIssues have differing effective severities, this field should be the highest severity for any of the PackageIssues. @@ -1897,33 +1925,47 @@

Method Details

"updateTime": "A String", # Output only. The time this occurrence was last updated. "vulnerability": { # Details of a vulnerability Occurrence. # Describes a security vulnerability. "cvssScore": 3.14, # Output only. The CVSS score of this vulnerability. CVSS score is on a scale of 0-10 where 0 indicates low severity and 10 indicates high severity. - "cvssV2": { # Common Vulnerability Scoring System. This message is compatible with CVSS v2 and v3. For CVSS v2 details, see https://www.first.org/cvss/v2/guide CVSS v2 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v2-calculator For CVSS v3 details, see https://www.first.org/cvss/specification-document CVSS v3 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v3-calculator # The cvss v2 score for the vulnerability. - "attackComplexity": "A String", # Defined in CVSS v3, CVSS v2 - "attackVector": "A String", # Base Metrics Represents the intrinsic characteristics of a vulnerability that are constant over time and across user environments. Defined in CVSS v3, CVSS v2 - "authentication": "A String", # Defined in CVSS v2 - "availabilityImpact": "A String", # Defined in CVSS v3, CVSS v2 + "cvssV2": { # Common Vulnerability Scoring System. This message is compatible with CVSS v2, v3, and v4. For CVSS v2 details, see https://www.first.org/cvss/v2/guide CVSS v2 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v2-calculator For CVSS v3 details, see https://www.first.org/cvss/specification-document CVSS v3 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v3-calculator For CVSS v4 details, see https://www.first.org/cvss/v4.0/user-guide CVSS v4 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v4-calculator # The cvss v2 score for the vulnerability. + "attackComplexity": "A String", # Attack Complexity (AC). Defined in CVSS v2, v3, v4. + "attackRequirements": "A String", # Attack Requirements (AT). Defined in CVSS v4. + "attackVector": "A String", # Attack Vector (AV). Defined in CVSS v2, v3, v4. + "authentication": "A String", # Authentication (Au). Defined in CVSS v2. + "availabilityImpact": "A String", # Availability Impact (A). Defined in CVSS v2, v3. "baseScore": 3.14, # The base score is a function of the base metric scores. - "confidentialityImpact": "A String", # Defined in CVSS v3, CVSS v2 + "confidentialityImpact": "A String", # Confidentiality Impact (C). Defined in CVSS v2, v3. "exploitabilityScore": 3.14, "impactScore": 3.14, - "integrityImpact": "A String", # Defined in CVSS v3, CVSS v2 - "privilegesRequired": "A String", # Defined in CVSS v3 - "scope": "A String", # Defined in CVSS v3 - "userInteraction": "A String", # Defined in CVSS v3 + "integrityImpact": "A String", # Integrity Impact (I). Defined in CVSS v2, v3. + "privilegesRequired": "A String", # Privileges Required (PR). Defined in CVSS v3, v4. + "scope": "A String", # Scope (S). Defined in CVSS v3. + "subsequentSystemAvailabilityImpact": "A String", # Subsequent System Availability Impact (SA). Defined in CVSS v4. + "subsequentSystemConfidentialityImpact": "A String", # Subsequent System Confidentiality Impact (SC). Defined in CVSS v4. + "subsequentSystemIntegrityImpact": "A String", # Subsequent System Integrity Impact (SI). Defined in CVSS v4. + "userInteraction": "A String", # User Interaction (UI). Defined in CVSS v3, v4. + "vulnerableSystemAvailabilityImpact": "A String", # Vulnerable System Availability Impact (VA). Defined in CVSS v4. + "vulnerableSystemConfidentialityImpact": "A String", # Vulnerable System Confidentiality Impact (VC). Defined in CVSS v4. + "vulnerableSystemIntegrityImpact": "A String", # Vulnerable System Integrity Impact (VI). Defined in CVSS v4. }, - "cvssV3": { # Common Vulnerability Scoring System. This message is compatible with CVSS v2 and v3. For CVSS v2 details, see https://www.first.org/cvss/v2/guide CVSS v2 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v2-calculator For CVSS v3 details, see https://www.first.org/cvss/specification-document CVSS v3 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v3-calculator # The cvss v3 score for the vulnerability. - "attackComplexity": "A String", # Defined in CVSS v3, CVSS v2 - "attackVector": "A String", # Base Metrics Represents the intrinsic characteristics of a vulnerability that are constant over time and across user environments. Defined in CVSS v3, CVSS v2 - "authentication": "A String", # Defined in CVSS v2 - "availabilityImpact": "A String", # Defined in CVSS v3, CVSS v2 + "cvssV3": { # Common Vulnerability Scoring System. This message is compatible with CVSS v2, v3, and v4. For CVSS v2 details, see https://www.first.org/cvss/v2/guide CVSS v2 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v2-calculator For CVSS v3 details, see https://www.first.org/cvss/specification-document CVSS v3 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v3-calculator For CVSS v4 details, see https://www.first.org/cvss/v4.0/user-guide CVSS v4 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v4-calculator # The cvss v3 score for the vulnerability. + "attackComplexity": "A String", # Attack Complexity (AC). Defined in CVSS v2, v3, v4. + "attackRequirements": "A String", # Attack Requirements (AT). Defined in CVSS v4. + "attackVector": "A String", # Attack Vector (AV). Defined in CVSS v2, v3, v4. + "authentication": "A String", # Authentication (Au). Defined in CVSS v2. + "availabilityImpact": "A String", # Availability Impact (A). Defined in CVSS v2, v3. "baseScore": 3.14, # The base score is a function of the base metric scores. - "confidentialityImpact": "A String", # Defined in CVSS v3, CVSS v2 + "confidentialityImpact": "A String", # Confidentiality Impact (C). Defined in CVSS v2, v3. "exploitabilityScore": 3.14, "impactScore": 3.14, - "integrityImpact": "A String", # Defined in CVSS v3, CVSS v2 - "privilegesRequired": "A String", # Defined in CVSS v3 - "scope": "A String", # Defined in CVSS v3 - "userInteraction": "A String", # Defined in CVSS v3 + "integrityImpact": "A String", # Integrity Impact (I). Defined in CVSS v2, v3. + "privilegesRequired": "A String", # Privileges Required (PR). Defined in CVSS v3, v4. + "scope": "A String", # Scope (S). Defined in CVSS v3. + "subsequentSystemAvailabilityImpact": "A String", # Subsequent System Availability Impact (SA). Defined in CVSS v4. + "subsequentSystemConfidentialityImpact": "A String", # Subsequent System Confidentiality Impact (SC). Defined in CVSS v4. + "subsequentSystemIntegrityImpact": "A String", # Subsequent System Integrity Impact (SI). Defined in CVSS v4. + "userInteraction": "A String", # User Interaction (UI). Defined in CVSS v3, v4. + "vulnerableSystemAvailabilityImpact": "A String", # Vulnerable System Availability Impact (VA). Defined in CVSS v4. + "vulnerableSystemConfidentialityImpact": "A String", # Vulnerable System Confidentiality Impact (VC). Defined in CVSS v4. + "vulnerableSystemIntegrityImpact": "A String", # Vulnerable System Integrity Impact (VI). Defined in CVSS v4. }, "cvssVersion": "A String", # Output only. CVSS version used to populate cvss_score and severity. "effectiveSeverity": "A String", # The distro assigned severity for this vulnerability when it is available, and note provider assigned severity when distro has not yet assigned a severity for this vulnerability. When there are multiple PackageIssues for this vulnerability, they can have different effective severities because some might be provided by the distro while others are provided by the language ecosystem for a language pack. For this reason, it is advised to use the effective severity on the PackageIssue level. In the case where multiple PackageIssues have differing effective severities, this field should be the highest severity for any of the PackageIssues. @@ -2520,33 +2562,47 @@

Method Details

"updateTime": "A String", # Output only. The time this occurrence was last updated. "vulnerability": { # Details of a vulnerability Occurrence. # Describes a security vulnerability. "cvssScore": 3.14, # Output only. The CVSS score of this vulnerability. CVSS score is on a scale of 0-10 where 0 indicates low severity and 10 indicates high severity. - "cvssV2": { # Common Vulnerability Scoring System. This message is compatible with CVSS v2 and v3. For CVSS v2 details, see https://www.first.org/cvss/v2/guide CVSS v2 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v2-calculator For CVSS v3 details, see https://www.first.org/cvss/specification-document CVSS v3 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v3-calculator # The cvss v2 score for the vulnerability. - "attackComplexity": "A String", # Defined in CVSS v3, CVSS v2 - "attackVector": "A String", # Base Metrics Represents the intrinsic characteristics of a vulnerability that are constant over time and across user environments. Defined in CVSS v3, CVSS v2 - "authentication": "A String", # Defined in CVSS v2 - "availabilityImpact": "A String", # Defined in CVSS v3, CVSS v2 + "cvssV2": { # Common Vulnerability Scoring System. This message is compatible with CVSS v2, v3, and v4. For CVSS v2 details, see https://www.first.org/cvss/v2/guide CVSS v2 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v2-calculator For CVSS v3 details, see https://www.first.org/cvss/specification-document CVSS v3 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v3-calculator For CVSS v4 details, see https://www.first.org/cvss/v4.0/user-guide CVSS v4 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v4-calculator # The cvss v2 score for the vulnerability. + "attackComplexity": "A String", # Attack Complexity (AC). Defined in CVSS v2, v3, v4. + "attackRequirements": "A String", # Attack Requirements (AT). Defined in CVSS v4. + "attackVector": "A String", # Attack Vector (AV). Defined in CVSS v2, v3, v4. + "authentication": "A String", # Authentication (Au). Defined in CVSS v2. + "availabilityImpact": "A String", # Availability Impact (A). Defined in CVSS v2, v3. "baseScore": 3.14, # The base score is a function of the base metric scores. - "confidentialityImpact": "A String", # Defined in CVSS v3, CVSS v2 + "confidentialityImpact": "A String", # Confidentiality Impact (C). Defined in CVSS v2, v3. "exploitabilityScore": 3.14, "impactScore": 3.14, - "integrityImpact": "A String", # Defined in CVSS v3, CVSS v2 - "privilegesRequired": "A String", # Defined in CVSS v3 - "scope": "A String", # Defined in CVSS v3 - "userInteraction": "A String", # Defined in CVSS v3 + "integrityImpact": "A String", # Integrity Impact (I). Defined in CVSS v2, v3. + "privilegesRequired": "A String", # Privileges Required (PR). Defined in CVSS v3, v4. + "scope": "A String", # Scope (S). Defined in CVSS v3. + "subsequentSystemAvailabilityImpact": "A String", # Subsequent System Availability Impact (SA). Defined in CVSS v4. + "subsequentSystemConfidentialityImpact": "A String", # Subsequent System Confidentiality Impact (SC). Defined in CVSS v4. + "subsequentSystemIntegrityImpact": "A String", # Subsequent System Integrity Impact (SI). Defined in CVSS v4. + "userInteraction": "A String", # User Interaction (UI). Defined in CVSS v3, v4. + "vulnerableSystemAvailabilityImpact": "A String", # Vulnerable System Availability Impact (VA). Defined in CVSS v4. + "vulnerableSystemConfidentialityImpact": "A String", # Vulnerable System Confidentiality Impact (VC). Defined in CVSS v4. + "vulnerableSystemIntegrityImpact": "A String", # Vulnerable System Integrity Impact (VI). Defined in CVSS v4. }, - "cvssV3": { # Common Vulnerability Scoring System. This message is compatible with CVSS v2 and v3. For CVSS v2 details, see https://www.first.org/cvss/v2/guide CVSS v2 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v2-calculator For CVSS v3 details, see https://www.first.org/cvss/specification-document CVSS v3 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v3-calculator # The cvss v3 score for the vulnerability. - "attackComplexity": "A String", # Defined in CVSS v3, CVSS v2 - "attackVector": "A String", # Base Metrics Represents the intrinsic characteristics of a vulnerability that are constant over time and across user environments. Defined in CVSS v3, CVSS v2 - "authentication": "A String", # Defined in CVSS v2 - "availabilityImpact": "A String", # Defined in CVSS v3, CVSS v2 + "cvssV3": { # Common Vulnerability Scoring System. This message is compatible with CVSS v2, v3, and v4. For CVSS v2 details, see https://www.first.org/cvss/v2/guide CVSS v2 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v2-calculator For CVSS v3 details, see https://www.first.org/cvss/specification-document CVSS v3 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v3-calculator For CVSS v4 details, see https://www.first.org/cvss/v4.0/user-guide CVSS v4 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v4-calculator # The cvss v3 score for the vulnerability. + "attackComplexity": "A String", # Attack Complexity (AC). Defined in CVSS v2, v3, v4. + "attackRequirements": "A String", # Attack Requirements (AT). Defined in CVSS v4. + "attackVector": "A String", # Attack Vector (AV). Defined in CVSS v2, v3, v4. + "authentication": "A String", # Authentication (Au). Defined in CVSS v2. + "availabilityImpact": "A String", # Availability Impact (A). Defined in CVSS v2, v3. "baseScore": 3.14, # The base score is a function of the base metric scores. - "confidentialityImpact": "A String", # Defined in CVSS v3, CVSS v2 + "confidentialityImpact": "A String", # Confidentiality Impact (C). Defined in CVSS v2, v3. "exploitabilityScore": 3.14, "impactScore": 3.14, - "integrityImpact": "A String", # Defined in CVSS v3, CVSS v2 - "privilegesRequired": "A String", # Defined in CVSS v3 - "scope": "A String", # Defined in CVSS v3 - "userInteraction": "A String", # Defined in CVSS v3 + "integrityImpact": "A String", # Integrity Impact (I). Defined in CVSS v2, v3. + "privilegesRequired": "A String", # Privileges Required (PR). Defined in CVSS v3, v4. + "scope": "A String", # Scope (S). Defined in CVSS v3. + "subsequentSystemAvailabilityImpact": "A String", # Subsequent System Availability Impact (SA). Defined in CVSS v4. + "subsequentSystemConfidentialityImpact": "A String", # Subsequent System Confidentiality Impact (SC). Defined in CVSS v4. + "subsequentSystemIntegrityImpact": "A String", # Subsequent System Integrity Impact (SI). Defined in CVSS v4. + "userInteraction": "A String", # User Interaction (UI). Defined in CVSS v3, v4. + "vulnerableSystemAvailabilityImpact": "A String", # Vulnerable System Availability Impact (VA). Defined in CVSS v4. + "vulnerableSystemConfidentialityImpact": "A String", # Vulnerable System Confidentiality Impact (VC). Defined in CVSS v4. + "vulnerableSystemIntegrityImpact": "A String", # Vulnerable System Integrity Impact (VI). Defined in CVSS v4. }, "cvssVersion": "A String", # Output only. CVSS version used to populate cvss_score and severity. "effectiveSeverity": "A String", # The distro assigned severity for this vulnerability when it is available, and note provider assigned severity when distro has not yet assigned a severity for this vulnerability. When there are multiple PackageIssues for this vulnerability, they can have different effective severities because some might be provided by the distro while others are provided by the language ecosystem for a language pack. For this reason, it is advised to use the effective severity on the PackageIssue level. In the case where multiple PackageIssues have differing effective severities, this field should be the highest severity for any of the PackageIssues. @@ -3168,33 +3224,47 @@

Method Details

"updateTime": "A String", # Output only. The time this occurrence was last updated. "vulnerability": { # Details of a vulnerability Occurrence. # Describes a security vulnerability. "cvssScore": 3.14, # Output only. The CVSS score of this vulnerability. CVSS score is on a scale of 0-10 where 0 indicates low severity and 10 indicates high severity. - "cvssV2": { # Common Vulnerability Scoring System. This message is compatible with CVSS v2 and v3. For CVSS v2 details, see https://www.first.org/cvss/v2/guide CVSS v2 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v2-calculator For CVSS v3 details, see https://www.first.org/cvss/specification-document CVSS v3 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v3-calculator # The cvss v2 score for the vulnerability. - "attackComplexity": "A String", # Defined in CVSS v3, CVSS v2 - "attackVector": "A String", # Base Metrics Represents the intrinsic characteristics of a vulnerability that are constant over time and across user environments. Defined in CVSS v3, CVSS v2 - "authentication": "A String", # Defined in CVSS v2 - "availabilityImpact": "A String", # Defined in CVSS v3, CVSS v2 + "cvssV2": { # Common Vulnerability Scoring System. This message is compatible with CVSS v2, v3, and v4. For CVSS v2 details, see https://www.first.org/cvss/v2/guide CVSS v2 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v2-calculator For CVSS v3 details, see https://www.first.org/cvss/specification-document CVSS v3 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v3-calculator For CVSS v4 details, see https://www.first.org/cvss/v4.0/user-guide CVSS v4 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v4-calculator # The cvss v2 score for the vulnerability. + "attackComplexity": "A String", # Attack Complexity (AC). Defined in CVSS v2, v3, v4. + "attackRequirements": "A String", # Attack Requirements (AT). Defined in CVSS v4. + "attackVector": "A String", # Attack Vector (AV). Defined in CVSS v2, v3, v4. + "authentication": "A String", # Authentication (Au). Defined in CVSS v2. + "availabilityImpact": "A String", # Availability Impact (A). Defined in CVSS v2, v3. "baseScore": 3.14, # The base score is a function of the base metric scores. - "confidentialityImpact": "A String", # Defined in CVSS v3, CVSS v2 + "confidentialityImpact": "A String", # Confidentiality Impact (C). Defined in CVSS v2, v3. "exploitabilityScore": 3.14, "impactScore": 3.14, - "integrityImpact": "A String", # Defined in CVSS v3, CVSS v2 - "privilegesRequired": "A String", # Defined in CVSS v3 - "scope": "A String", # Defined in CVSS v3 - "userInteraction": "A String", # Defined in CVSS v3 + "integrityImpact": "A String", # Integrity Impact (I). Defined in CVSS v2, v3. + "privilegesRequired": "A String", # Privileges Required (PR). Defined in CVSS v3, v4. + "scope": "A String", # Scope (S). Defined in CVSS v3. + "subsequentSystemAvailabilityImpact": "A String", # Subsequent System Availability Impact (SA). Defined in CVSS v4. + "subsequentSystemConfidentialityImpact": "A String", # Subsequent System Confidentiality Impact (SC). Defined in CVSS v4. + "subsequentSystemIntegrityImpact": "A String", # Subsequent System Integrity Impact (SI). Defined in CVSS v4. + "userInteraction": "A String", # User Interaction (UI). Defined in CVSS v3, v4. + "vulnerableSystemAvailabilityImpact": "A String", # Vulnerable System Availability Impact (VA). Defined in CVSS v4. + "vulnerableSystemConfidentialityImpact": "A String", # Vulnerable System Confidentiality Impact (VC). Defined in CVSS v4. + "vulnerableSystemIntegrityImpact": "A String", # Vulnerable System Integrity Impact (VI). Defined in CVSS v4. }, - "cvssV3": { # Common Vulnerability Scoring System. This message is compatible with CVSS v2 and v3. For CVSS v2 details, see https://www.first.org/cvss/v2/guide CVSS v2 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v2-calculator For CVSS v3 details, see https://www.first.org/cvss/specification-document CVSS v3 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v3-calculator # The cvss v3 score for the vulnerability. - "attackComplexity": "A String", # Defined in CVSS v3, CVSS v2 - "attackVector": "A String", # Base Metrics Represents the intrinsic characteristics of a vulnerability that are constant over time and across user environments. Defined in CVSS v3, CVSS v2 - "authentication": "A String", # Defined in CVSS v2 - "availabilityImpact": "A String", # Defined in CVSS v3, CVSS v2 + "cvssV3": { # Common Vulnerability Scoring System. This message is compatible with CVSS v2, v3, and v4. For CVSS v2 details, see https://www.first.org/cvss/v2/guide CVSS v2 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v2-calculator For CVSS v3 details, see https://www.first.org/cvss/specification-document CVSS v3 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v3-calculator For CVSS v4 details, see https://www.first.org/cvss/v4.0/user-guide CVSS v4 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v4-calculator # The cvss v3 score for the vulnerability. + "attackComplexity": "A String", # Attack Complexity (AC). Defined in CVSS v2, v3, v4. + "attackRequirements": "A String", # Attack Requirements (AT). Defined in CVSS v4. + "attackVector": "A String", # Attack Vector (AV). Defined in CVSS v2, v3, v4. + "authentication": "A String", # Authentication (Au). Defined in CVSS v2. + "availabilityImpact": "A String", # Availability Impact (A). Defined in CVSS v2, v3. "baseScore": 3.14, # The base score is a function of the base metric scores. - "confidentialityImpact": "A String", # Defined in CVSS v3, CVSS v2 + "confidentialityImpact": "A String", # Confidentiality Impact (C). Defined in CVSS v2, v3. "exploitabilityScore": 3.14, "impactScore": 3.14, - "integrityImpact": "A String", # Defined in CVSS v3, CVSS v2 - "privilegesRequired": "A String", # Defined in CVSS v3 - "scope": "A String", # Defined in CVSS v3 - "userInteraction": "A String", # Defined in CVSS v3 + "integrityImpact": "A String", # Integrity Impact (I). Defined in CVSS v2, v3. + "privilegesRequired": "A String", # Privileges Required (PR). Defined in CVSS v3, v4. + "scope": "A String", # Scope (S). Defined in CVSS v3. + "subsequentSystemAvailabilityImpact": "A String", # Subsequent System Availability Impact (SA). Defined in CVSS v4. + "subsequentSystemConfidentialityImpact": "A String", # Subsequent System Confidentiality Impact (SC). Defined in CVSS v4. + "subsequentSystemIntegrityImpact": "A String", # Subsequent System Integrity Impact (SI). Defined in CVSS v4. + "userInteraction": "A String", # User Interaction (UI). Defined in CVSS v3, v4. + "vulnerableSystemAvailabilityImpact": "A String", # Vulnerable System Availability Impact (VA). Defined in CVSS v4. + "vulnerableSystemConfidentialityImpact": "A String", # Vulnerable System Confidentiality Impact (VC). Defined in CVSS v4. + "vulnerableSystemIntegrityImpact": "A String", # Vulnerable System Integrity Impact (VI). Defined in CVSS v4. }, "cvssVersion": "A String", # Output only. CVSS version used to populate cvss_score and severity. "effectiveSeverity": "A String", # The distro assigned severity for this vulnerability when it is available, and note provider assigned severity when distro has not yet assigned a severity for this vulnerability. When there are multiple PackageIssues for this vulnerability, they can have different effective severities because some might be provided by the distro while others are provided by the language ecosystem for a language pack. For this reason, it is advised to use the effective severity on the PackageIssue level. In the case where multiple PackageIssues have differing effective severities, this field should be the highest severity for any of the PackageIssues. @@ -3504,19 +3574,26 @@

Method Details

"vulnerability": { # Vulnerability provides metadata about a security vulnerability in a Note. # A note describing a package vulnerability. "advisoryPublishTime": "A String", # The time this advisory was published by the source. "cvssScore": 3.14, # The CVSS score for this vulnerability. - "cvssV2": { # Common Vulnerability Scoring System. This message is compatible with CVSS v2 and v3. For CVSS v2 details, see https://www.first.org/cvss/v2/guide CVSS v2 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v2-calculator For CVSS v3 details, see https://www.first.org/cvss/specification-document CVSS v3 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v3-calculator # The full description of the CVSS for version 2. - "attackComplexity": "A String", # Defined in CVSS v3, CVSS v2 - "attackVector": "A String", # Base Metrics Represents the intrinsic characteristics of a vulnerability that are constant over time and across user environments. Defined in CVSS v3, CVSS v2 - "authentication": "A String", # Defined in CVSS v2 - "availabilityImpact": "A String", # Defined in CVSS v3, CVSS v2 + "cvssV2": { # Common Vulnerability Scoring System. This message is compatible with CVSS v2, v3, and v4. For CVSS v2 details, see https://www.first.org/cvss/v2/guide CVSS v2 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v2-calculator For CVSS v3 details, see https://www.first.org/cvss/specification-document CVSS v3 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v3-calculator For CVSS v4 details, see https://www.first.org/cvss/v4.0/user-guide CVSS v4 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v4-calculator # The full description of the CVSS for version 2. + "attackComplexity": "A String", # Attack Complexity (AC). Defined in CVSS v2, v3, v4. + "attackRequirements": "A String", # Attack Requirements (AT). Defined in CVSS v4. + "attackVector": "A String", # Attack Vector (AV). Defined in CVSS v2, v3, v4. + "authentication": "A String", # Authentication (Au). Defined in CVSS v2. + "availabilityImpact": "A String", # Availability Impact (A). Defined in CVSS v2, v3. "baseScore": 3.14, # The base score is a function of the base metric scores. - "confidentialityImpact": "A String", # Defined in CVSS v3, CVSS v2 + "confidentialityImpact": "A String", # Confidentiality Impact (C). Defined in CVSS v2, v3. "exploitabilityScore": 3.14, "impactScore": 3.14, - "integrityImpact": "A String", # Defined in CVSS v3, CVSS v2 - "privilegesRequired": "A String", # Defined in CVSS v3 - "scope": "A String", # Defined in CVSS v3 - "userInteraction": "A String", # Defined in CVSS v3 + "integrityImpact": "A String", # Integrity Impact (I). Defined in CVSS v2, v3. + "privilegesRequired": "A String", # Privileges Required (PR). Defined in CVSS v3, v4. + "scope": "A String", # Scope (S). Defined in CVSS v3. + "subsequentSystemAvailabilityImpact": "A String", # Subsequent System Availability Impact (SA). Defined in CVSS v4. + "subsequentSystemConfidentialityImpact": "A String", # Subsequent System Confidentiality Impact (SC). Defined in CVSS v4. + "subsequentSystemIntegrityImpact": "A String", # Subsequent System Integrity Impact (SI). Defined in CVSS v4. + "userInteraction": "A String", # User Interaction (UI). Defined in CVSS v3, v4. + "vulnerableSystemAvailabilityImpact": "A String", # Vulnerable System Availability Impact (VA). Defined in CVSS v4. + "vulnerableSystemConfidentialityImpact": "A String", # Vulnerable System Confidentiality Impact (VC). Defined in CVSS v4. + "vulnerableSystemIntegrityImpact": "A String", # Vulnerable System Integrity Impact (VI). Defined in CVSS v4. }, "cvssV3": { # Deprecated. Common Vulnerability Scoring System version 3. For details, see https://www.first.org/cvss/specification-document # The full description of the CVSS for version 3. "attackComplexity": "A String", @@ -4210,33 +4287,47 @@

Method Details

"updateTime": "A String", # Output only. The time this occurrence was last updated. "vulnerability": { # Details of a vulnerability Occurrence. # Describes a security vulnerability. "cvssScore": 3.14, # Output only. The CVSS score of this vulnerability. CVSS score is on a scale of 0-10 where 0 indicates low severity and 10 indicates high severity. - "cvssV2": { # Common Vulnerability Scoring System. This message is compatible with CVSS v2 and v3. For CVSS v2 details, see https://www.first.org/cvss/v2/guide CVSS v2 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v2-calculator For CVSS v3 details, see https://www.first.org/cvss/specification-document CVSS v3 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v3-calculator # The cvss v2 score for the vulnerability. - "attackComplexity": "A String", # Defined in CVSS v3, CVSS v2 - "attackVector": "A String", # Base Metrics Represents the intrinsic characteristics of a vulnerability that are constant over time and across user environments. Defined in CVSS v3, CVSS v2 - "authentication": "A String", # Defined in CVSS v2 - "availabilityImpact": "A String", # Defined in CVSS v3, CVSS v2 + "cvssV2": { # Common Vulnerability Scoring System. This message is compatible with CVSS v2, v3, and v4. For CVSS v2 details, see https://www.first.org/cvss/v2/guide CVSS v2 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v2-calculator For CVSS v3 details, see https://www.first.org/cvss/specification-document CVSS v3 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v3-calculator For CVSS v4 details, see https://www.first.org/cvss/v4.0/user-guide CVSS v4 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v4-calculator # The cvss v2 score for the vulnerability. + "attackComplexity": "A String", # Attack Complexity (AC). Defined in CVSS v2, v3, v4. + "attackRequirements": "A String", # Attack Requirements (AT). Defined in CVSS v4. + "attackVector": "A String", # Attack Vector (AV). Defined in CVSS v2, v3, v4. + "authentication": "A String", # Authentication (Au). Defined in CVSS v2. + "availabilityImpact": "A String", # Availability Impact (A). Defined in CVSS v2, v3. "baseScore": 3.14, # The base score is a function of the base metric scores. - "confidentialityImpact": "A String", # Defined in CVSS v3, CVSS v2 + "confidentialityImpact": "A String", # Confidentiality Impact (C). Defined in CVSS v2, v3. "exploitabilityScore": 3.14, "impactScore": 3.14, - "integrityImpact": "A String", # Defined in CVSS v3, CVSS v2 - "privilegesRequired": "A String", # Defined in CVSS v3 - "scope": "A String", # Defined in CVSS v3 - "userInteraction": "A String", # Defined in CVSS v3 - }, - "cvssV3": { # Common Vulnerability Scoring System. This message is compatible with CVSS v2 and v3. For CVSS v2 details, see https://www.first.org/cvss/v2/guide CVSS v2 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v2-calculator For CVSS v3 details, see https://www.first.org/cvss/specification-document CVSS v3 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v3-calculator # The cvss v3 score for the vulnerability. - "attackComplexity": "A String", # Defined in CVSS v3, CVSS v2 - "attackVector": "A String", # Base Metrics Represents the intrinsic characteristics of a vulnerability that are constant over time and across user environments. Defined in CVSS v3, CVSS v2 - "authentication": "A String", # Defined in CVSS v2 - "availabilityImpact": "A String", # Defined in CVSS v3, CVSS v2 + "integrityImpact": "A String", # Integrity Impact (I). Defined in CVSS v2, v3. + "privilegesRequired": "A String", # Privileges Required (PR). Defined in CVSS v3, v4. + "scope": "A String", # Scope (S). Defined in CVSS v3. + "subsequentSystemAvailabilityImpact": "A String", # Subsequent System Availability Impact (SA). Defined in CVSS v4. + "subsequentSystemConfidentialityImpact": "A String", # Subsequent System Confidentiality Impact (SC). Defined in CVSS v4. + "subsequentSystemIntegrityImpact": "A String", # Subsequent System Integrity Impact (SI). Defined in CVSS v4. + "userInteraction": "A String", # User Interaction (UI). Defined in CVSS v3, v4. + "vulnerableSystemAvailabilityImpact": "A String", # Vulnerable System Availability Impact (VA). Defined in CVSS v4. + "vulnerableSystemConfidentialityImpact": "A String", # Vulnerable System Confidentiality Impact (VC). Defined in CVSS v4. + "vulnerableSystemIntegrityImpact": "A String", # Vulnerable System Integrity Impact (VI). Defined in CVSS v4. + }, + "cvssV3": { # Common Vulnerability Scoring System. This message is compatible with CVSS v2, v3, and v4. For CVSS v2 details, see https://www.first.org/cvss/v2/guide CVSS v2 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v2-calculator For CVSS v3 details, see https://www.first.org/cvss/specification-document CVSS v3 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v3-calculator For CVSS v4 details, see https://www.first.org/cvss/v4.0/user-guide CVSS v4 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v4-calculator # The cvss v3 score for the vulnerability. + "attackComplexity": "A String", # Attack Complexity (AC). Defined in CVSS v2, v3, v4. + "attackRequirements": "A String", # Attack Requirements (AT). Defined in CVSS v4. + "attackVector": "A String", # Attack Vector (AV). Defined in CVSS v2, v3, v4. + "authentication": "A String", # Authentication (Au). Defined in CVSS v2. + "availabilityImpact": "A String", # Availability Impact (A). Defined in CVSS v2, v3. "baseScore": 3.14, # The base score is a function of the base metric scores. - "confidentialityImpact": "A String", # Defined in CVSS v3, CVSS v2 + "confidentialityImpact": "A String", # Confidentiality Impact (C). Defined in CVSS v2, v3. "exploitabilityScore": 3.14, "impactScore": 3.14, - "integrityImpact": "A String", # Defined in CVSS v3, CVSS v2 - "privilegesRequired": "A String", # Defined in CVSS v3 - "scope": "A String", # Defined in CVSS v3 - "userInteraction": "A String", # Defined in CVSS v3 + "integrityImpact": "A String", # Integrity Impact (I). Defined in CVSS v2, v3. + "privilegesRequired": "A String", # Privileges Required (PR). Defined in CVSS v3, v4. + "scope": "A String", # Scope (S). Defined in CVSS v3. + "subsequentSystemAvailabilityImpact": "A String", # Subsequent System Availability Impact (SA). Defined in CVSS v4. + "subsequentSystemConfidentialityImpact": "A String", # Subsequent System Confidentiality Impact (SC). Defined in CVSS v4. + "subsequentSystemIntegrityImpact": "A String", # Subsequent System Integrity Impact (SI). Defined in CVSS v4. + "userInteraction": "A String", # User Interaction (UI). Defined in CVSS v3, v4. + "vulnerableSystemAvailabilityImpact": "A String", # Vulnerable System Availability Impact (VA). Defined in CVSS v4. + "vulnerableSystemConfidentialityImpact": "A String", # Vulnerable System Confidentiality Impact (VC). Defined in CVSS v4. + "vulnerableSystemIntegrityImpact": "A String", # Vulnerable System Integrity Impact (VI). Defined in CVSS v4. }, "cvssVersion": "A String", # Output only. CVSS version used to populate cvss_score and severity. "effectiveSeverity": "A String", # The distro assigned severity for this vulnerability when it is available, and note provider assigned severity when distro has not yet assigned a severity for this vulnerability. When there are multiple PackageIssues for this vulnerability, they can have different effective severities because some might be provided by the distro while others are provided by the language ecosystem for a language pack. For this reason, it is advised to use the effective severity on the PackageIssue level. In the case where multiple PackageIssues have differing effective severities, this field should be the highest severity for any of the PackageIssues. @@ -4854,33 +4945,47 @@

Method Details

"updateTime": "A String", # Output only. The time this occurrence was last updated. "vulnerability": { # Details of a vulnerability Occurrence. # Describes a security vulnerability. "cvssScore": 3.14, # Output only. The CVSS score of this vulnerability. CVSS score is on a scale of 0-10 where 0 indicates low severity and 10 indicates high severity. - "cvssV2": { # Common Vulnerability Scoring System. This message is compatible with CVSS v2 and v3. For CVSS v2 details, see https://www.first.org/cvss/v2/guide CVSS v2 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v2-calculator For CVSS v3 details, see https://www.first.org/cvss/specification-document CVSS v3 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v3-calculator # The cvss v2 score for the vulnerability. - "attackComplexity": "A String", # Defined in CVSS v3, CVSS v2 - "attackVector": "A String", # Base Metrics Represents the intrinsic characteristics of a vulnerability that are constant over time and across user environments. Defined in CVSS v3, CVSS v2 - "authentication": "A String", # Defined in CVSS v2 - "availabilityImpact": "A String", # Defined in CVSS v3, CVSS v2 + "cvssV2": { # Common Vulnerability Scoring System. This message is compatible with CVSS v2, v3, and v4. For CVSS v2 details, see https://www.first.org/cvss/v2/guide CVSS v2 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v2-calculator For CVSS v3 details, see https://www.first.org/cvss/specification-document CVSS v3 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v3-calculator For CVSS v4 details, see https://www.first.org/cvss/v4.0/user-guide CVSS v4 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v4-calculator # The cvss v2 score for the vulnerability. + "attackComplexity": "A String", # Attack Complexity (AC). Defined in CVSS v2, v3, v4. + "attackRequirements": "A String", # Attack Requirements (AT). Defined in CVSS v4. + "attackVector": "A String", # Attack Vector (AV). Defined in CVSS v2, v3, v4. + "authentication": "A String", # Authentication (Au). Defined in CVSS v2. + "availabilityImpact": "A String", # Availability Impact (A). Defined in CVSS v2, v3. "baseScore": 3.14, # The base score is a function of the base metric scores. - "confidentialityImpact": "A String", # Defined in CVSS v3, CVSS v2 + "confidentialityImpact": "A String", # Confidentiality Impact (C). Defined in CVSS v2, v3. "exploitabilityScore": 3.14, "impactScore": 3.14, - "integrityImpact": "A String", # Defined in CVSS v3, CVSS v2 - "privilegesRequired": "A String", # Defined in CVSS v3 - "scope": "A String", # Defined in CVSS v3 - "userInteraction": "A String", # Defined in CVSS v3 + "integrityImpact": "A String", # Integrity Impact (I). Defined in CVSS v2, v3. + "privilegesRequired": "A String", # Privileges Required (PR). Defined in CVSS v3, v4. + "scope": "A String", # Scope (S). Defined in CVSS v3. + "subsequentSystemAvailabilityImpact": "A String", # Subsequent System Availability Impact (SA). Defined in CVSS v4. + "subsequentSystemConfidentialityImpact": "A String", # Subsequent System Confidentiality Impact (SC). Defined in CVSS v4. + "subsequentSystemIntegrityImpact": "A String", # Subsequent System Integrity Impact (SI). Defined in CVSS v4. + "userInteraction": "A String", # User Interaction (UI). Defined in CVSS v3, v4. + "vulnerableSystemAvailabilityImpact": "A String", # Vulnerable System Availability Impact (VA). Defined in CVSS v4. + "vulnerableSystemConfidentialityImpact": "A String", # Vulnerable System Confidentiality Impact (VC). Defined in CVSS v4. + "vulnerableSystemIntegrityImpact": "A String", # Vulnerable System Integrity Impact (VI). Defined in CVSS v4. }, - "cvssV3": { # Common Vulnerability Scoring System. This message is compatible with CVSS v2 and v3. For CVSS v2 details, see https://www.first.org/cvss/v2/guide CVSS v2 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v2-calculator For CVSS v3 details, see https://www.first.org/cvss/specification-document CVSS v3 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v3-calculator # The cvss v3 score for the vulnerability. - "attackComplexity": "A String", # Defined in CVSS v3, CVSS v2 - "attackVector": "A String", # Base Metrics Represents the intrinsic characteristics of a vulnerability that are constant over time and across user environments. Defined in CVSS v3, CVSS v2 - "authentication": "A String", # Defined in CVSS v2 - "availabilityImpact": "A String", # Defined in CVSS v3, CVSS v2 + "cvssV3": { # Common Vulnerability Scoring System. This message is compatible with CVSS v2, v3, and v4. For CVSS v2 details, see https://www.first.org/cvss/v2/guide CVSS v2 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v2-calculator For CVSS v3 details, see https://www.first.org/cvss/specification-document CVSS v3 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v3-calculator For CVSS v4 details, see https://www.first.org/cvss/v4.0/user-guide CVSS v4 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v4-calculator # The cvss v3 score for the vulnerability. + "attackComplexity": "A String", # Attack Complexity (AC). Defined in CVSS v2, v3, v4. + "attackRequirements": "A String", # Attack Requirements (AT). Defined in CVSS v4. + "attackVector": "A String", # Attack Vector (AV). Defined in CVSS v2, v3, v4. + "authentication": "A String", # Authentication (Au). Defined in CVSS v2. + "availabilityImpact": "A String", # Availability Impact (A). Defined in CVSS v2, v3. "baseScore": 3.14, # The base score is a function of the base metric scores. - "confidentialityImpact": "A String", # Defined in CVSS v3, CVSS v2 + "confidentialityImpact": "A String", # Confidentiality Impact (C). Defined in CVSS v2, v3. "exploitabilityScore": 3.14, "impactScore": 3.14, - "integrityImpact": "A String", # Defined in CVSS v3, CVSS v2 - "privilegesRequired": "A String", # Defined in CVSS v3 - "scope": "A String", # Defined in CVSS v3 - "userInteraction": "A String", # Defined in CVSS v3 + "integrityImpact": "A String", # Integrity Impact (I). Defined in CVSS v2, v3. + "privilegesRequired": "A String", # Privileges Required (PR). Defined in CVSS v3, v4. + "scope": "A String", # Scope (S). Defined in CVSS v3. + "subsequentSystemAvailabilityImpact": "A String", # Subsequent System Availability Impact (SA). Defined in CVSS v4. + "subsequentSystemConfidentialityImpact": "A String", # Subsequent System Confidentiality Impact (SC). Defined in CVSS v4. + "subsequentSystemIntegrityImpact": "A String", # Subsequent System Integrity Impact (SI). Defined in CVSS v4. + "userInteraction": "A String", # User Interaction (UI). Defined in CVSS v3, v4. + "vulnerableSystemAvailabilityImpact": "A String", # Vulnerable System Availability Impact (VA). Defined in CVSS v4. + "vulnerableSystemConfidentialityImpact": "A String", # Vulnerable System Confidentiality Impact (VC). Defined in CVSS v4. + "vulnerableSystemIntegrityImpact": "A String", # Vulnerable System Integrity Impact (VI). Defined in CVSS v4. }, "cvssVersion": "A String", # Output only. CVSS version used to populate cvss_score and severity. "effectiveSeverity": "A String", # The distro assigned severity for this vulnerability when it is available, and note provider assigned severity when distro has not yet assigned a severity for this vulnerability. When there are multiple PackageIssues for this vulnerability, they can have different effective severities because some might be provided by the distro while others are provided by the language ecosystem for a language pack. For this reason, it is advised to use the effective severity on the PackageIssue level. In the case where multiple PackageIssues have differing effective severities, this field should be the highest severity for any of the PackageIssues. @@ -5478,33 +5583,47 @@

Method Details

"updateTime": "A String", # Output only. The time this occurrence was last updated. "vulnerability": { # Details of a vulnerability Occurrence. # Describes a security vulnerability. "cvssScore": 3.14, # Output only. The CVSS score of this vulnerability. CVSS score is on a scale of 0-10 where 0 indicates low severity and 10 indicates high severity. - "cvssV2": { # Common Vulnerability Scoring System. This message is compatible with CVSS v2 and v3. For CVSS v2 details, see https://www.first.org/cvss/v2/guide CVSS v2 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v2-calculator For CVSS v3 details, see https://www.first.org/cvss/specification-document CVSS v3 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v3-calculator # The cvss v2 score for the vulnerability. - "attackComplexity": "A String", # Defined in CVSS v3, CVSS v2 - "attackVector": "A String", # Base Metrics Represents the intrinsic characteristics of a vulnerability that are constant over time and across user environments. Defined in CVSS v3, CVSS v2 - "authentication": "A String", # Defined in CVSS v2 - "availabilityImpact": "A String", # Defined in CVSS v3, CVSS v2 + "cvssV2": { # Common Vulnerability Scoring System. This message is compatible with CVSS v2, v3, and v4. For CVSS v2 details, see https://www.first.org/cvss/v2/guide CVSS v2 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v2-calculator For CVSS v3 details, see https://www.first.org/cvss/specification-document CVSS v3 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v3-calculator For CVSS v4 details, see https://www.first.org/cvss/v4.0/user-guide CVSS v4 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v4-calculator # The cvss v2 score for the vulnerability. + "attackComplexity": "A String", # Attack Complexity (AC). Defined in CVSS v2, v3, v4. + "attackRequirements": "A String", # Attack Requirements (AT). Defined in CVSS v4. + "attackVector": "A String", # Attack Vector (AV). Defined in CVSS v2, v3, v4. + "authentication": "A String", # Authentication (Au). Defined in CVSS v2. + "availabilityImpact": "A String", # Availability Impact (A). Defined in CVSS v2, v3. "baseScore": 3.14, # The base score is a function of the base metric scores. - "confidentialityImpact": "A String", # Defined in CVSS v3, CVSS v2 + "confidentialityImpact": "A String", # Confidentiality Impact (C). Defined in CVSS v2, v3. "exploitabilityScore": 3.14, "impactScore": 3.14, - "integrityImpact": "A String", # Defined in CVSS v3, CVSS v2 - "privilegesRequired": "A String", # Defined in CVSS v3 - "scope": "A String", # Defined in CVSS v3 - "userInteraction": "A String", # Defined in CVSS v3 + "integrityImpact": "A String", # Integrity Impact (I). Defined in CVSS v2, v3. + "privilegesRequired": "A String", # Privileges Required (PR). Defined in CVSS v3, v4. + "scope": "A String", # Scope (S). Defined in CVSS v3. + "subsequentSystemAvailabilityImpact": "A String", # Subsequent System Availability Impact (SA). Defined in CVSS v4. + "subsequentSystemConfidentialityImpact": "A String", # Subsequent System Confidentiality Impact (SC). Defined in CVSS v4. + "subsequentSystemIntegrityImpact": "A String", # Subsequent System Integrity Impact (SI). Defined in CVSS v4. + "userInteraction": "A String", # User Interaction (UI). Defined in CVSS v3, v4. + "vulnerableSystemAvailabilityImpact": "A String", # Vulnerable System Availability Impact (VA). Defined in CVSS v4. + "vulnerableSystemConfidentialityImpact": "A String", # Vulnerable System Confidentiality Impact (VC). Defined in CVSS v4. + "vulnerableSystemIntegrityImpact": "A String", # Vulnerable System Integrity Impact (VI). Defined in CVSS v4. }, - "cvssV3": { # Common Vulnerability Scoring System. This message is compatible with CVSS v2 and v3. For CVSS v2 details, see https://www.first.org/cvss/v2/guide CVSS v2 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v2-calculator For CVSS v3 details, see https://www.first.org/cvss/specification-document CVSS v3 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v3-calculator # The cvss v3 score for the vulnerability. - "attackComplexity": "A String", # Defined in CVSS v3, CVSS v2 - "attackVector": "A String", # Base Metrics Represents the intrinsic characteristics of a vulnerability that are constant over time and across user environments. Defined in CVSS v3, CVSS v2 - "authentication": "A String", # Defined in CVSS v2 - "availabilityImpact": "A String", # Defined in CVSS v3, CVSS v2 + "cvssV3": { # Common Vulnerability Scoring System. This message is compatible with CVSS v2, v3, and v4. For CVSS v2 details, see https://www.first.org/cvss/v2/guide CVSS v2 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v2-calculator For CVSS v3 details, see https://www.first.org/cvss/specification-document CVSS v3 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v3-calculator For CVSS v4 details, see https://www.first.org/cvss/v4.0/user-guide CVSS v4 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v4-calculator # The cvss v3 score for the vulnerability. + "attackComplexity": "A String", # Attack Complexity (AC). Defined in CVSS v2, v3, v4. + "attackRequirements": "A String", # Attack Requirements (AT). Defined in CVSS v4. + "attackVector": "A String", # Attack Vector (AV). Defined in CVSS v2, v3, v4. + "authentication": "A String", # Authentication (Au). Defined in CVSS v2. + "availabilityImpact": "A String", # Availability Impact (A). Defined in CVSS v2, v3. "baseScore": 3.14, # The base score is a function of the base metric scores. - "confidentialityImpact": "A String", # Defined in CVSS v3, CVSS v2 + "confidentialityImpact": "A String", # Confidentiality Impact (C). Defined in CVSS v2, v3. "exploitabilityScore": 3.14, "impactScore": 3.14, - "integrityImpact": "A String", # Defined in CVSS v3, CVSS v2 - "privilegesRequired": "A String", # Defined in CVSS v3 - "scope": "A String", # Defined in CVSS v3 - "userInteraction": "A String", # Defined in CVSS v3 + "integrityImpact": "A String", # Integrity Impact (I). Defined in CVSS v2, v3. + "privilegesRequired": "A String", # Privileges Required (PR). Defined in CVSS v3, v4. + "scope": "A String", # Scope (S). Defined in CVSS v3. + "subsequentSystemAvailabilityImpact": "A String", # Subsequent System Availability Impact (SA). Defined in CVSS v4. + "subsequentSystemConfidentialityImpact": "A String", # Subsequent System Confidentiality Impact (SC). Defined in CVSS v4. + "subsequentSystemIntegrityImpact": "A String", # Subsequent System Integrity Impact (SI). Defined in CVSS v4. + "userInteraction": "A String", # User Interaction (UI). Defined in CVSS v3, v4. + "vulnerableSystemAvailabilityImpact": "A String", # Vulnerable System Availability Impact (VA). Defined in CVSS v4. + "vulnerableSystemConfidentialityImpact": "A String", # Vulnerable System Confidentiality Impact (VC). Defined in CVSS v4. + "vulnerableSystemIntegrityImpact": "A String", # Vulnerable System Integrity Impact (VI). Defined in CVSS v4. }, "cvssVersion": "A String", # Output only. CVSS version used to populate cvss_score and severity. "effectiveSeverity": "A String", # The distro assigned severity for this vulnerability when it is available, and note provider assigned severity when distro has not yet assigned a severity for this vulnerability. When there are multiple PackageIssues for this vulnerability, they can have different effective severities because some might be provided by the distro while others are provided by the language ecosystem for a language pack. For this reason, it is advised to use the effective severity on the PackageIssue level. In the case where multiple PackageIssues have differing effective severities, this field should be the highest severity for any of the PackageIssues. diff --git a/docs/dyn/containeranalysis_v1beta1.projects.notes.html b/docs/dyn/containeranalysis_v1beta1.projects.notes.html index 1c7445d4b1..6fbd61e2b5 100644 --- a/docs/dyn/containeranalysis_v1beta1.projects.notes.html +++ b/docs/dyn/containeranalysis_v1beta1.projects.notes.html @@ -300,19 +300,26 @@

Method Details

"vulnerability": { # Vulnerability provides metadata about a security vulnerability in a Note. # A note describing a package vulnerability. "advisoryPublishTime": "A String", # The time this advisory was published by the source. "cvssScore": 3.14, # The CVSS score for this vulnerability. - "cvssV2": { # Common Vulnerability Scoring System. This message is compatible with CVSS v2 and v3. For CVSS v2 details, see https://www.first.org/cvss/v2/guide CVSS v2 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v2-calculator For CVSS v3 details, see https://www.first.org/cvss/specification-document CVSS v3 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v3-calculator # The full description of the CVSS for version 2. - "attackComplexity": "A String", # Defined in CVSS v3, CVSS v2 - "attackVector": "A String", # Base Metrics Represents the intrinsic characteristics of a vulnerability that are constant over time and across user environments. Defined in CVSS v3, CVSS v2 - "authentication": "A String", # Defined in CVSS v2 - "availabilityImpact": "A String", # Defined in CVSS v3, CVSS v2 + "cvssV2": { # Common Vulnerability Scoring System. This message is compatible with CVSS v2, v3, and v4. For CVSS v2 details, see https://www.first.org/cvss/v2/guide CVSS v2 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v2-calculator For CVSS v3 details, see https://www.first.org/cvss/specification-document CVSS v3 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v3-calculator For CVSS v4 details, see https://www.first.org/cvss/v4.0/user-guide CVSS v4 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v4-calculator # The full description of the CVSS for version 2. + "attackComplexity": "A String", # Attack Complexity (AC). Defined in CVSS v2, v3, v4. + "attackRequirements": "A String", # Attack Requirements (AT). Defined in CVSS v4. + "attackVector": "A String", # Attack Vector (AV). Defined in CVSS v2, v3, v4. + "authentication": "A String", # Authentication (Au). Defined in CVSS v2. + "availabilityImpact": "A String", # Availability Impact (A). Defined in CVSS v2, v3. "baseScore": 3.14, # The base score is a function of the base metric scores. - "confidentialityImpact": "A String", # Defined in CVSS v3, CVSS v2 + "confidentialityImpact": "A String", # Confidentiality Impact (C). Defined in CVSS v2, v3. "exploitabilityScore": 3.14, "impactScore": 3.14, - "integrityImpact": "A String", # Defined in CVSS v3, CVSS v2 - "privilegesRequired": "A String", # Defined in CVSS v3 - "scope": "A String", # Defined in CVSS v3 - "userInteraction": "A String", # Defined in CVSS v3 + "integrityImpact": "A String", # Integrity Impact (I). Defined in CVSS v2, v3. + "privilegesRequired": "A String", # Privileges Required (PR). Defined in CVSS v3, v4. + "scope": "A String", # Scope (S). Defined in CVSS v3. + "subsequentSystemAvailabilityImpact": "A String", # Subsequent System Availability Impact (SA). Defined in CVSS v4. + "subsequentSystemConfidentialityImpact": "A String", # Subsequent System Confidentiality Impact (SC). Defined in CVSS v4. + "subsequentSystemIntegrityImpact": "A String", # Subsequent System Integrity Impact (SI). Defined in CVSS v4. + "userInteraction": "A String", # User Interaction (UI). Defined in CVSS v3, v4. + "vulnerableSystemAvailabilityImpact": "A String", # Vulnerable System Availability Impact (VA). Defined in CVSS v4. + "vulnerableSystemConfidentialityImpact": "A String", # Vulnerable System Confidentiality Impact (VC). Defined in CVSS v4. + "vulnerableSystemIntegrityImpact": "A String", # Vulnerable System Integrity Impact (VI). Defined in CVSS v4. }, "cvssV3": { # Deprecated. Common Vulnerability Scoring System version 3. For details, see https://www.first.org/cvss/specification-document # The full description of the CVSS for version 3. "attackComplexity": "A String", @@ -621,19 +628,26 @@

Method Details

"vulnerability": { # Vulnerability provides metadata about a security vulnerability in a Note. # A note describing a package vulnerability. "advisoryPublishTime": "A String", # The time this advisory was published by the source. "cvssScore": 3.14, # The CVSS score for this vulnerability. - "cvssV2": { # Common Vulnerability Scoring System. This message is compatible with CVSS v2 and v3. For CVSS v2 details, see https://www.first.org/cvss/v2/guide CVSS v2 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v2-calculator For CVSS v3 details, see https://www.first.org/cvss/specification-document CVSS v3 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v3-calculator # The full description of the CVSS for version 2. - "attackComplexity": "A String", # Defined in CVSS v3, CVSS v2 - "attackVector": "A String", # Base Metrics Represents the intrinsic characteristics of a vulnerability that are constant over time and across user environments. Defined in CVSS v3, CVSS v2 - "authentication": "A String", # Defined in CVSS v2 - "availabilityImpact": "A String", # Defined in CVSS v3, CVSS v2 + "cvssV2": { # Common Vulnerability Scoring System. This message is compatible with CVSS v2, v3, and v4. For CVSS v2 details, see https://www.first.org/cvss/v2/guide CVSS v2 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v2-calculator For CVSS v3 details, see https://www.first.org/cvss/specification-document CVSS v3 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v3-calculator For CVSS v4 details, see https://www.first.org/cvss/v4.0/user-guide CVSS v4 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v4-calculator # The full description of the CVSS for version 2. + "attackComplexity": "A String", # Attack Complexity (AC). Defined in CVSS v2, v3, v4. + "attackRequirements": "A String", # Attack Requirements (AT). Defined in CVSS v4. + "attackVector": "A String", # Attack Vector (AV). Defined in CVSS v2, v3, v4. + "authentication": "A String", # Authentication (Au). Defined in CVSS v2. + "availabilityImpact": "A String", # Availability Impact (A). Defined in CVSS v2, v3. "baseScore": 3.14, # The base score is a function of the base metric scores. - "confidentialityImpact": "A String", # Defined in CVSS v3, CVSS v2 + "confidentialityImpact": "A String", # Confidentiality Impact (C). Defined in CVSS v2, v3. "exploitabilityScore": 3.14, "impactScore": 3.14, - "integrityImpact": "A String", # Defined in CVSS v3, CVSS v2 - "privilegesRequired": "A String", # Defined in CVSS v3 - "scope": "A String", # Defined in CVSS v3 - "userInteraction": "A String", # Defined in CVSS v3 + "integrityImpact": "A String", # Integrity Impact (I). Defined in CVSS v2, v3. + "privilegesRequired": "A String", # Privileges Required (PR). Defined in CVSS v3, v4. + "scope": "A String", # Scope (S). Defined in CVSS v3. + "subsequentSystemAvailabilityImpact": "A String", # Subsequent System Availability Impact (SA). Defined in CVSS v4. + "subsequentSystemConfidentialityImpact": "A String", # Subsequent System Confidentiality Impact (SC). Defined in CVSS v4. + "subsequentSystemIntegrityImpact": "A String", # Subsequent System Integrity Impact (SI). Defined in CVSS v4. + "userInteraction": "A String", # User Interaction (UI). Defined in CVSS v3, v4. + "vulnerableSystemAvailabilityImpact": "A String", # Vulnerable System Availability Impact (VA). Defined in CVSS v4. + "vulnerableSystemConfidentialityImpact": "A String", # Vulnerable System Confidentiality Impact (VC). Defined in CVSS v4. + "vulnerableSystemIntegrityImpact": "A String", # Vulnerable System Integrity Impact (VI). Defined in CVSS v4. }, "cvssV3": { # Deprecated. Common Vulnerability Scoring System version 3. For details, see https://www.first.org/cvss/specification-document # The full description of the CVSS for version 3. "attackComplexity": "A String", @@ -947,19 +961,26 @@

Method Details

"vulnerability": { # Vulnerability provides metadata about a security vulnerability in a Note. # A note describing a package vulnerability. "advisoryPublishTime": "A String", # The time this advisory was published by the source. "cvssScore": 3.14, # The CVSS score for this vulnerability. - "cvssV2": { # Common Vulnerability Scoring System. This message is compatible with CVSS v2 and v3. For CVSS v2 details, see https://www.first.org/cvss/v2/guide CVSS v2 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v2-calculator For CVSS v3 details, see https://www.first.org/cvss/specification-document CVSS v3 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v3-calculator # The full description of the CVSS for version 2. - "attackComplexity": "A String", # Defined in CVSS v3, CVSS v2 - "attackVector": "A String", # Base Metrics Represents the intrinsic characteristics of a vulnerability that are constant over time and across user environments. Defined in CVSS v3, CVSS v2 - "authentication": "A String", # Defined in CVSS v2 - "availabilityImpact": "A String", # Defined in CVSS v3, CVSS v2 + "cvssV2": { # Common Vulnerability Scoring System. This message is compatible with CVSS v2, v3, and v4. For CVSS v2 details, see https://www.first.org/cvss/v2/guide CVSS v2 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v2-calculator For CVSS v3 details, see https://www.first.org/cvss/specification-document CVSS v3 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v3-calculator For CVSS v4 details, see https://www.first.org/cvss/v4.0/user-guide CVSS v4 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v4-calculator # The full description of the CVSS for version 2. + "attackComplexity": "A String", # Attack Complexity (AC). Defined in CVSS v2, v3, v4. + "attackRequirements": "A String", # Attack Requirements (AT). Defined in CVSS v4. + "attackVector": "A String", # Attack Vector (AV). Defined in CVSS v2, v3, v4. + "authentication": "A String", # Authentication (Au). Defined in CVSS v2. + "availabilityImpact": "A String", # Availability Impact (A). Defined in CVSS v2, v3. "baseScore": 3.14, # The base score is a function of the base metric scores. - "confidentialityImpact": "A String", # Defined in CVSS v3, CVSS v2 + "confidentialityImpact": "A String", # Confidentiality Impact (C). Defined in CVSS v2, v3. "exploitabilityScore": 3.14, "impactScore": 3.14, - "integrityImpact": "A String", # Defined in CVSS v3, CVSS v2 - "privilegesRequired": "A String", # Defined in CVSS v3 - "scope": "A String", # Defined in CVSS v3 - "userInteraction": "A String", # Defined in CVSS v3 + "integrityImpact": "A String", # Integrity Impact (I). Defined in CVSS v2, v3. + "privilegesRequired": "A String", # Privileges Required (PR). Defined in CVSS v3, v4. + "scope": "A String", # Scope (S). Defined in CVSS v3. + "subsequentSystemAvailabilityImpact": "A String", # Subsequent System Availability Impact (SA). Defined in CVSS v4. + "subsequentSystemConfidentialityImpact": "A String", # Subsequent System Confidentiality Impact (SC). Defined in CVSS v4. + "subsequentSystemIntegrityImpact": "A String", # Subsequent System Integrity Impact (SI). Defined in CVSS v4. + "userInteraction": "A String", # User Interaction (UI). Defined in CVSS v3, v4. + "vulnerableSystemAvailabilityImpact": "A String", # Vulnerable System Availability Impact (VA). Defined in CVSS v4. + "vulnerableSystemConfidentialityImpact": "A String", # Vulnerable System Confidentiality Impact (VC). Defined in CVSS v4. + "vulnerableSystemIntegrityImpact": "A String", # Vulnerable System Integrity Impact (VI). Defined in CVSS v4. }, "cvssV3": { # Deprecated. Common Vulnerability Scoring System version 3. For details, see https://www.first.org/cvss/specification-document # The full description of the CVSS for version 3. "attackComplexity": "A String", @@ -1265,19 +1286,26 @@

Method Details

"vulnerability": { # Vulnerability provides metadata about a security vulnerability in a Note. # A note describing a package vulnerability. "advisoryPublishTime": "A String", # The time this advisory was published by the source. "cvssScore": 3.14, # The CVSS score for this vulnerability. - "cvssV2": { # Common Vulnerability Scoring System. This message is compatible with CVSS v2 and v3. For CVSS v2 details, see https://www.first.org/cvss/v2/guide CVSS v2 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v2-calculator For CVSS v3 details, see https://www.first.org/cvss/specification-document CVSS v3 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v3-calculator # The full description of the CVSS for version 2. - "attackComplexity": "A String", # Defined in CVSS v3, CVSS v2 - "attackVector": "A String", # Base Metrics Represents the intrinsic characteristics of a vulnerability that are constant over time and across user environments. Defined in CVSS v3, CVSS v2 - "authentication": "A String", # Defined in CVSS v2 - "availabilityImpact": "A String", # Defined in CVSS v3, CVSS v2 + "cvssV2": { # Common Vulnerability Scoring System. This message is compatible with CVSS v2, v3, and v4. For CVSS v2 details, see https://www.first.org/cvss/v2/guide CVSS v2 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v2-calculator For CVSS v3 details, see https://www.first.org/cvss/specification-document CVSS v3 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v3-calculator For CVSS v4 details, see https://www.first.org/cvss/v4.0/user-guide CVSS v4 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v4-calculator # The full description of the CVSS for version 2. + "attackComplexity": "A String", # Attack Complexity (AC). Defined in CVSS v2, v3, v4. + "attackRequirements": "A String", # Attack Requirements (AT). Defined in CVSS v4. + "attackVector": "A String", # Attack Vector (AV). Defined in CVSS v2, v3, v4. + "authentication": "A String", # Authentication (Au). Defined in CVSS v2. + "availabilityImpact": "A String", # Availability Impact (A). Defined in CVSS v2, v3. "baseScore": 3.14, # The base score is a function of the base metric scores. - "confidentialityImpact": "A String", # Defined in CVSS v3, CVSS v2 + "confidentialityImpact": "A String", # Confidentiality Impact (C). Defined in CVSS v2, v3. "exploitabilityScore": 3.14, "impactScore": 3.14, - "integrityImpact": "A String", # Defined in CVSS v3, CVSS v2 - "privilegesRequired": "A String", # Defined in CVSS v3 - "scope": "A String", # Defined in CVSS v3 - "userInteraction": "A String", # Defined in CVSS v3 + "integrityImpact": "A String", # Integrity Impact (I). Defined in CVSS v2, v3. + "privilegesRequired": "A String", # Privileges Required (PR). Defined in CVSS v3, v4. + "scope": "A String", # Scope (S). Defined in CVSS v3. + "subsequentSystemAvailabilityImpact": "A String", # Subsequent System Availability Impact (SA). Defined in CVSS v4. + "subsequentSystemConfidentialityImpact": "A String", # Subsequent System Confidentiality Impact (SC). Defined in CVSS v4. + "subsequentSystemIntegrityImpact": "A String", # Subsequent System Integrity Impact (SI). Defined in CVSS v4. + "userInteraction": "A String", # User Interaction (UI). Defined in CVSS v3, v4. + "vulnerableSystemAvailabilityImpact": "A String", # Vulnerable System Availability Impact (VA). Defined in CVSS v4. + "vulnerableSystemConfidentialityImpact": "A String", # Vulnerable System Confidentiality Impact (VC). Defined in CVSS v4. + "vulnerableSystemIntegrityImpact": "A String", # Vulnerable System Integrity Impact (VI). Defined in CVSS v4. }, "cvssV3": { # Deprecated. Common Vulnerability Scoring System version 3. For details, see https://www.first.org/cvss/specification-document # The full description of the CVSS for version 3. "attackComplexity": "A String", @@ -1607,19 +1635,26 @@

Method Details

"vulnerability": { # Vulnerability provides metadata about a security vulnerability in a Note. # A note describing a package vulnerability. "advisoryPublishTime": "A String", # The time this advisory was published by the source. "cvssScore": 3.14, # The CVSS score for this vulnerability. - "cvssV2": { # Common Vulnerability Scoring System. This message is compatible with CVSS v2 and v3. For CVSS v2 details, see https://www.first.org/cvss/v2/guide CVSS v2 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v2-calculator For CVSS v3 details, see https://www.first.org/cvss/specification-document CVSS v3 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v3-calculator # The full description of the CVSS for version 2. - "attackComplexity": "A String", # Defined in CVSS v3, CVSS v2 - "attackVector": "A String", # Base Metrics Represents the intrinsic characteristics of a vulnerability that are constant over time and across user environments. Defined in CVSS v3, CVSS v2 - "authentication": "A String", # Defined in CVSS v2 - "availabilityImpact": "A String", # Defined in CVSS v3, CVSS v2 + "cvssV2": { # Common Vulnerability Scoring System. This message is compatible with CVSS v2, v3, and v4. For CVSS v2 details, see https://www.first.org/cvss/v2/guide CVSS v2 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v2-calculator For CVSS v3 details, see https://www.first.org/cvss/specification-document CVSS v3 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v3-calculator For CVSS v4 details, see https://www.first.org/cvss/v4.0/user-guide CVSS v4 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v4-calculator # The full description of the CVSS for version 2. + "attackComplexity": "A String", # Attack Complexity (AC). Defined in CVSS v2, v3, v4. + "attackRequirements": "A String", # Attack Requirements (AT). Defined in CVSS v4. + "attackVector": "A String", # Attack Vector (AV). Defined in CVSS v2, v3, v4. + "authentication": "A String", # Authentication (Au). Defined in CVSS v2. + "availabilityImpact": "A String", # Availability Impact (A). Defined in CVSS v2, v3. "baseScore": 3.14, # The base score is a function of the base metric scores. - "confidentialityImpact": "A String", # Defined in CVSS v3, CVSS v2 + "confidentialityImpact": "A String", # Confidentiality Impact (C). Defined in CVSS v2, v3. "exploitabilityScore": 3.14, "impactScore": 3.14, - "integrityImpact": "A String", # Defined in CVSS v3, CVSS v2 - "privilegesRequired": "A String", # Defined in CVSS v3 - "scope": "A String", # Defined in CVSS v3 - "userInteraction": "A String", # Defined in CVSS v3 + "integrityImpact": "A String", # Integrity Impact (I). Defined in CVSS v2, v3. + "privilegesRequired": "A String", # Privileges Required (PR). Defined in CVSS v3, v4. + "scope": "A String", # Scope (S). Defined in CVSS v3. + "subsequentSystemAvailabilityImpact": "A String", # Subsequent System Availability Impact (SA). Defined in CVSS v4. + "subsequentSystemConfidentialityImpact": "A String", # Subsequent System Confidentiality Impact (SC). Defined in CVSS v4. + "subsequentSystemIntegrityImpact": "A String", # Subsequent System Integrity Impact (SI). Defined in CVSS v4. + "userInteraction": "A String", # User Interaction (UI). Defined in CVSS v3, v4. + "vulnerableSystemAvailabilityImpact": "A String", # Vulnerable System Availability Impact (VA). Defined in CVSS v4. + "vulnerableSystemConfidentialityImpact": "A String", # Vulnerable System Confidentiality Impact (VC). Defined in CVSS v4. + "vulnerableSystemIntegrityImpact": "A String", # Vulnerable System Integrity Impact (VI). Defined in CVSS v4. }, "cvssV3": { # Deprecated. Common Vulnerability Scoring System version 3. For details, see https://www.first.org/cvss/specification-document # The full description of the CVSS for version 3. "attackComplexity": "A String", @@ -1981,19 +2016,26 @@

Method Details

"vulnerability": { # Vulnerability provides metadata about a security vulnerability in a Note. # A note describing a package vulnerability. "advisoryPublishTime": "A String", # The time this advisory was published by the source. "cvssScore": 3.14, # The CVSS score for this vulnerability. - "cvssV2": { # Common Vulnerability Scoring System. This message is compatible with CVSS v2 and v3. For CVSS v2 details, see https://www.first.org/cvss/v2/guide CVSS v2 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v2-calculator For CVSS v3 details, see https://www.first.org/cvss/specification-document CVSS v3 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v3-calculator # The full description of the CVSS for version 2. - "attackComplexity": "A String", # Defined in CVSS v3, CVSS v2 - "attackVector": "A String", # Base Metrics Represents the intrinsic characteristics of a vulnerability that are constant over time and across user environments. Defined in CVSS v3, CVSS v2 - "authentication": "A String", # Defined in CVSS v2 - "availabilityImpact": "A String", # Defined in CVSS v3, CVSS v2 + "cvssV2": { # Common Vulnerability Scoring System. This message is compatible with CVSS v2, v3, and v4. For CVSS v2 details, see https://www.first.org/cvss/v2/guide CVSS v2 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v2-calculator For CVSS v3 details, see https://www.first.org/cvss/specification-document CVSS v3 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v3-calculator For CVSS v4 details, see https://www.first.org/cvss/v4.0/user-guide CVSS v4 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v4-calculator # The full description of the CVSS for version 2. + "attackComplexity": "A String", # Attack Complexity (AC). Defined in CVSS v2, v3, v4. + "attackRequirements": "A String", # Attack Requirements (AT). Defined in CVSS v4. + "attackVector": "A String", # Attack Vector (AV). Defined in CVSS v2, v3, v4. + "authentication": "A String", # Authentication (Au). Defined in CVSS v2. + "availabilityImpact": "A String", # Availability Impact (A). Defined in CVSS v2, v3. "baseScore": 3.14, # The base score is a function of the base metric scores. - "confidentialityImpact": "A String", # Defined in CVSS v3, CVSS v2 + "confidentialityImpact": "A String", # Confidentiality Impact (C). Defined in CVSS v2, v3. "exploitabilityScore": 3.14, "impactScore": 3.14, - "integrityImpact": "A String", # Defined in CVSS v3, CVSS v2 - "privilegesRequired": "A String", # Defined in CVSS v3 - "scope": "A String", # Defined in CVSS v3 - "userInteraction": "A String", # Defined in CVSS v3 + "integrityImpact": "A String", # Integrity Impact (I). Defined in CVSS v2, v3. + "privilegesRequired": "A String", # Privileges Required (PR). Defined in CVSS v3, v4. + "scope": "A String", # Scope (S). Defined in CVSS v3. + "subsequentSystemAvailabilityImpact": "A String", # Subsequent System Availability Impact (SA). Defined in CVSS v4. + "subsequentSystemConfidentialityImpact": "A String", # Subsequent System Confidentiality Impact (SC). Defined in CVSS v4. + "subsequentSystemIntegrityImpact": "A String", # Subsequent System Integrity Impact (SI). Defined in CVSS v4. + "userInteraction": "A String", # User Interaction (UI). Defined in CVSS v3, v4. + "vulnerableSystemAvailabilityImpact": "A String", # Vulnerable System Availability Impact (VA). Defined in CVSS v4. + "vulnerableSystemConfidentialityImpact": "A String", # Vulnerable System Confidentiality Impact (VC). Defined in CVSS v4. + "vulnerableSystemIntegrityImpact": "A String", # Vulnerable System Integrity Impact (VI). Defined in CVSS v4. }, "cvssV3": { # Deprecated. Common Vulnerability Scoring System version 3. For details, see https://www.first.org/cvss/specification-document # The full description of the CVSS for version 3. "attackComplexity": "A String", @@ -2319,19 +2361,26 @@

Method Details

"vulnerability": { # Vulnerability provides metadata about a security vulnerability in a Note. # A note describing a package vulnerability. "advisoryPublishTime": "A String", # The time this advisory was published by the source. "cvssScore": 3.14, # The CVSS score for this vulnerability. - "cvssV2": { # Common Vulnerability Scoring System. This message is compatible with CVSS v2 and v3. For CVSS v2 details, see https://www.first.org/cvss/v2/guide CVSS v2 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v2-calculator For CVSS v3 details, see https://www.first.org/cvss/specification-document CVSS v3 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v3-calculator # The full description of the CVSS for version 2. - "attackComplexity": "A String", # Defined in CVSS v3, CVSS v2 - "attackVector": "A String", # Base Metrics Represents the intrinsic characteristics of a vulnerability that are constant over time and across user environments. Defined in CVSS v3, CVSS v2 - "authentication": "A String", # Defined in CVSS v2 - "availabilityImpact": "A String", # Defined in CVSS v3, CVSS v2 + "cvssV2": { # Common Vulnerability Scoring System. This message is compatible with CVSS v2, v3, and v4. For CVSS v2 details, see https://www.first.org/cvss/v2/guide CVSS v2 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v2-calculator For CVSS v3 details, see https://www.first.org/cvss/specification-document CVSS v3 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v3-calculator For CVSS v4 details, see https://www.first.org/cvss/v4.0/user-guide CVSS v4 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v4-calculator # The full description of the CVSS for version 2. + "attackComplexity": "A String", # Attack Complexity (AC). Defined in CVSS v2, v3, v4. + "attackRequirements": "A String", # Attack Requirements (AT). Defined in CVSS v4. + "attackVector": "A String", # Attack Vector (AV). Defined in CVSS v2, v3, v4. + "authentication": "A String", # Authentication (Au). Defined in CVSS v2. + "availabilityImpact": "A String", # Availability Impact (A). Defined in CVSS v2, v3. "baseScore": 3.14, # The base score is a function of the base metric scores. - "confidentialityImpact": "A String", # Defined in CVSS v3, CVSS v2 + "confidentialityImpact": "A String", # Confidentiality Impact (C). Defined in CVSS v2, v3. "exploitabilityScore": 3.14, "impactScore": 3.14, - "integrityImpact": "A String", # Defined in CVSS v3, CVSS v2 - "privilegesRequired": "A String", # Defined in CVSS v3 - "scope": "A String", # Defined in CVSS v3 - "userInteraction": "A String", # Defined in CVSS v3 + "integrityImpact": "A String", # Integrity Impact (I). Defined in CVSS v2, v3. + "privilegesRequired": "A String", # Privileges Required (PR). Defined in CVSS v3, v4. + "scope": "A String", # Scope (S). Defined in CVSS v3. + "subsequentSystemAvailabilityImpact": "A String", # Subsequent System Availability Impact (SA). Defined in CVSS v4. + "subsequentSystemConfidentialityImpact": "A String", # Subsequent System Confidentiality Impact (SC). Defined in CVSS v4. + "subsequentSystemIntegrityImpact": "A String", # Subsequent System Integrity Impact (SI). Defined in CVSS v4. + "userInteraction": "A String", # User Interaction (UI). Defined in CVSS v3, v4. + "vulnerableSystemAvailabilityImpact": "A String", # Vulnerable System Availability Impact (VA). Defined in CVSS v4. + "vulnerableSystemConfidentialityImpact": "A String", # Vulnerable System Confidentiality Impact (VC). Defined in CVSS v4. + "vulnerableSystemIntegrityImpact": "A String", # Vulnerable System Integrity Impact (VI). Defined in CVSS v4. }, "cvssV3": { # Deprecated. Common Vulnerability Scoring System version 3. For details, see https://www.first.org/cvss/specification-document # The full description of the CVSS for version 3. "attackComplexity": "A String", @@ -2637,19 +2686,26 @@

Method Details

"vulnerability": { # Vulnerability provides metadata about a security vulnerability in a Note. # A note describing a package vulnerability. "advisoryPublishTime": "A String", # The time this advisory was published by the source. "cvssScore": 3.14, # The CVSS score for this vulnerability. - "cvssV2": { # Common Vulnerability Scoring System. This message is compatible with CVSS v2 and v3. For CVSS v2 details, see https://www.first.org/cvss/v2/guide CVSS v2 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v2-calculator For CVSS v3 details, see https://www.first.org/cvss/specification-document CVSS v3 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v3-calculator # The full description of the CVSS for version 2. - "attackComplexity": "A String", # Defined in CVSS v3, CVSS v2 - "attackVector": "A String", # Base Metrics Represents the intrinsic characteristics of a vulnerability that are constant over time and across user environments. Defined in CVSS v3, CVSS v2 - "authentication": "A String", # Defined in CVSS v2 - "availabilityImpact": "A String", # Defined in CVSS v3, CVSS v2 + "cvssV2": { # Common Vulnerability Scoring System. This message is compatible with CVSS v2, v3, and v4. For CVSS v2 details, see https://www.first.org/cvss/v2/guide CVSS v2 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v2-calculator For CVSS v3 details, see https://www.first.org/cvss/specification-document CVSS v3 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v3-calculator For CVSS v4 details, see https://www.first.org/cvss/v4.0/user-guide CVSS v4 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v4-calculator # The full description of the CVSS for version 2. + "attackComplexity": "A String", # Attack Complexity (AC). Defined in CVSS v2, v3, v4. + "attackRequirements": "A String", # Attack Requirements (AT). Defined in CVSS v4. + "attackVector": "A String", # Attack Vector (AV). Defined in CVSS v2, v3, v4. + "authentication": "A String", # Authentication (Au). Defined in CVSS v2. + "availabilityImpact": "A String", # Availability Impact (A). Defined in CVSS v2, v3. "baseScore": 3.14, # The base score is a function of the base metric scores. - "confidentialityImpact": "A String", # Defined in CVSS v3, CVSS v2 + "confidentialityImpact": "A String", # Confidentiality Impact (C). Defined in CVSS v2, v3. "exploitabilityScore": 3.14, "impactScore": 3.14, - "integrityImpact": "A String", # Defined in CVSS v3, CVSS v2 - "privilegesRequired": "A String", # Defined in CVSS v3 - "scope": "A String", # Defined in CVSS v3 - "userInteraction": "A String", # Defined in CVSS v3 + "integrityImpact": "A String", # Integrity Impact (I). Defined in CVSS v2, v3. + "privilegesRequired": "A String", # Privileges Required (PR). Defined in CVSS v3, v4. + "scope": "A String", # Scope (S). Defined in CVSS v3. + "subsequentSystemAvailabilityImpact": "A String", # Subsequent System Availability Impact (SA). Defined in CVSS v4. + "subsequentSystemConfidentialityImpact": "A String", # Subsequent System Confidentiality Impact (SC). Defined in CVSS v4. + "subsequentSystemIntegrityImpact": "A String", # Subsequent System Integrity Impact (SI). Defined in CVSS v4. + "userInteraction": "A String", # User Interaction (UI). Defined in CVSS v3, v4. + "vulnerableSystemAvailabilityImpact": "A String", # Vulnerable System Availability Impact (VA). Defined in CVSS v4. + "vulnerableSystemConfidentialityImpact": "A String", # Vulnerable System Confidentiality Impact (VC). Defined in CVSS v4. + "vulnerableSystemIntegrityImpact": "A String", # Vulnerable System Integrity Impact (VI). Defined in CVSS v4. }, "cvssV3": { # Deprecated. Common Vulnerability Scoring System version 3. For details, see https://www.first.org/cvss/specification-document # The full description of the CVSS for version 3. "attackComplexity": "A String", diff --git a/docs/dyn/containeranalysis_v1beta1.projects.notes.occurrences.html b/docs/dyn/containeranalysis_v1beta1.projects.notes.occurrences.html index 98f57eacd9..187b06221a 100644 --- a/docs/dyn/containeranalysis_v1beta1.projects.notes.occurrences.html +++ b/docs/dyn/containeranalysis_v1beta1.projects.notes.occurrences.html @@ -622,33 +622,47 @@

Method Details

"updateTime": "A String", # Output only. The time this occurrence was last updated. "vulnerability": { # Details of a vulnerability Occurrence. # Describes a security vulnerability. "cvssScore": 3.14, # Output only. The CVSS score of this vulnerability. CVSS score is on a scale of 0-10 where 0 indicates low severity and 10 indicates high severity. - "cvssV2": { # Common Vulnerability Scoring System. This message is compatible with CVSS v2 and v3. For CVSS v2 details, see https://www.first.org/cvss/v2/guide CVSS v2 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v2-calculator For CVSS v3 details, see https://www.first.org/cvss/specification-document CVSS v3 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v3-calculator # The cvss v2 score for the vulnerability. - "attackComplexity": "A String", # Defined in CVSS v3, CVSS v2 - "attackVector": "A String", # Base Metrics Represents the intrinsic characteristics of a vulnerability that are constant over time and across user environments. Defined in CVSS v3, CVSS v2 - "authentication": "A String", # Defined in CVSS v2 - "availabilityImpact": "A String", # Defined in CVSS v3, CVSS v2 + "cvssV2": { # Common Vulnerability Scoring System. This message is compatible with CVSS v2, v3, and v4. For CVSS v2 details, see https://www.first.org/cvss/v2/guide CVSS v2 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v2-calculator For CVSS v3 details, see https://www.first.org/cvss/specification-document CVSS v3 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v3-calculator For CVSS v4 details, see https://www.first.org/cvss/v4.0/user-guide CVSS v4 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v4-calculator # The cvss v2 score for the vulnerability. + "attackComplexity": "A String", # Attack Complexity (AC). Defined in CVSS v2, v3, v4. + "attackRequirements": "A String", # Attack Requirements (AT). Defined in CVSS v4. + "attackVector": "A String", # Attack Vector (AV). Defined in CVSS v2, v3, v4. + "authentication": "A String", # Authentication (Au). Defined in CVSS v2. + "availabilityImpact": "A String", # Availability Impact (A). Defined in CVSS v2, v3. "baseScore": 3.14, # The base score is a function of the base metric scores. - "confidentialityImpact": "A String", # Defined in CVSS v3, CVSS v2 + "confidentialityImpact": "A String", # Confidentiality Impact (C). Defined in CVSS v2, v3. "exploitabilityScore": 3.14, "impactScore": 3.14, - "integrityImpact": "A String", # Defined in CVSS v3, CVSS v2 - "privilegesRequired": "A String", # Defined in CVSS v3 - "scope": "A String", # Defined in CVSS v3 - "userInteraction": "A String", # Defined in CVSS v3 + "integrityImpact": "A String", # Integrity Impact (I). Defined in CVSS v2, v3. + "privilegesRequired": "A String", # Privileges Required (PR). Defined in CVSS v3, v4. + "scope": "A String", # Scope (S). Defined in CVSS v3. + "subsequentSystemAvailabilityImpact": "A String", # Subsequent System Availability Impact (SA). Defined in CVSS v4. + "subsequentSystemConfidentialityImpact": "A String", # Subsequent System Confidentiality Impact (SC). Defined in CVSS v4. + "subsequentSystemIntegrityImpact": "A String", # Subsequent System Integrity Impact (SI). Defined in CVSS v4. + "userInteraction": "A String", # User Interaction (UI). Defined in CVSS v3, v4. + "vulnerableSystemAvailabilityImpact": "A String", # Vulnerable System Availability Impact (VA). Defined in CVSS v4. + "vulnerableSystemConfidentialityImpact": "A String", # Vulnerable System Confidentiality Impact (VC). Defined in CVSS v4. + "vulnerableSystemIntegrityImpact": "A String", # Vulnerable System Integrity Impact (VI). Defined in CVSS v4. }, - "cvssV3": { # Common Vulnerability Scoring System. This message is compatible with CVSS v2 and v3. For CVSS v2 details, see https://www.first.org/cvss/v2/guide CVSS v2 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v2-calculator For CVSS v3 details, see https://www.first.org/cvss/specification-document CVSS v3 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v3-calculator # The cvss v3 score for the vulnerability. - "attackComplexity": "A String", # Defined in CVSS v3, CVSS v2 - "attackVector": "A String", # Base Metrics Represents the intrinsic characteristics of a vulnerability that are constant over time and across user environments. Defined in CVSS v3, CVSS v2 - "authentication": "A String", # Defined in CVSS v2 - "availabilityImpact": "A String", # Defined in CVSS v3, CVSS v2 + "cvssV3": { # Common Vulnerability Scoring System. This message is compatible with CVSS v2, v3, and v4. For CVSS v2 details, see https://www.first.org/cvss/v2/guide CVSS v2 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v2-calculator For CVSS v3 details, see https://www.first.org/cvss/specification-document CVSS v3 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v3-calculator For CVSS v4 details, see https://www.first.org/cvss/v4.0/user-guide CVSS v4 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v4-calculator # The cvss v3 score for the vulnerability. + "attackComplexity": "A String", # Attack Complexity (AC). Defined in CVSS v2, v3, v4. + "attackRequirements": "A String", # Attack Requirements (AT). Defined in CVSS v4. + "attackVector": "A String", # Attack Vector (AV). Defined in CVSS v2, v3, v4. + "authentication": "A String", # Authentication (Au). Defined in CVSS v2. + "availabilityImpact": "A String", # Availability Impact (A). Defined in CVSS v2, v3. "baseScore": 3.14, # The base score is a function of the base metric scores. - "confidentialityImpact": "A String", # Defined in CVSS v3, CVSS v2 + "confidentialityImpact": "A String", # Confidentiality Impact (C). Defined in CVSS v2, v3. "exploitabilityScore": 3.14, "impactScore": 3.14, - "integrityImpact": "A String", # Defined in CVSS v3, CVSS v2 - "privilegesRequired": "A String", # Defined in CVSS v3 - "scope": "A String", # Defined in CVSS v3 - "userInteraction": "A String", # Defined in CVSS v3 + "integrityImpact": "A String", # Integrity Impact (I). Defined in CVSS v2, v3. + "privilegesRequired": "A String", # Privileges Required (PR). Defined in CVSS v3, v4. + "scope": "A String", # Scope (S). Defined in CVSS v3. + "subsequentSystemAvailabilityImpact": "A String", # Subsequent System Availability Impact (SA). Defined in CVSS v4. + "subsequentSystemConfidentialityImpact": "A String", # Subsequent System Confidentiality Impact (SC). Defined in CVSS v4. + "subsequentSystemIntegrityImpact": "A String", # Subsequent System Integrity Impact (SI). Defined in CVSS v4. + "userInteraction": "A String", # User Interaction (UI). Defined in CVSS v3, v4. + "vulnerableSystemAvailabilityImpact": "A String", # Vulnerable System Availability Impact (VA). Defined in CVSS v4. + "vulnerableSystemConfidentialityImpact": "A String", # Vulnerable System Confidentiality Impact (VC). Defined in CVSS v4. + "vulnerableSystemIntegrityImpact": "A String", # Vulnerable System Integrity Impact (VI). Defined in CVSS v4. }, "cvssVersion": "A String", # Output only. CVSS version used to populate cvss_score and severity. "effectiveSeverity": "A String", # The distro assigned severity for this vulnerability when it is available, and note provider assigned severity when distro has not yet assigned a severity for this vulnerability. When there are multiple PackageIssues for this vulnerability, they can have different effective severities because some might be provided by the distro while others are provided by the language ecosystem for a language pack. For this reason, it is advised to use the effective severity on the PackageIssue level. In the case where multiple PackageIssues have differing effective severities, this field should be the highest severity for any of the PackageIssues. diff --git a/docs/dyn/containeranalysis_v1beta1.projects.occurrences.html b/docs/dyn/containeranalysis_v1beta1.projects.occurrences.html index 4b92f4f16d..955217cdab 100644 --- a/docs/dyn/containeranalysis_v1beta1.projects.occurrences.html +++ b/docs/dyn/containeranalysis_v1beta1.projects.occurrences.html @@ -638,33 +638,47 @@

Method Details

"updateTime": "A String", # Output only. The time this occurrence was last updated. "vulnerability": { # Details of a vulnerability Occurrence. # Describes a security vulnerability. "cvssScore": 3.14, # Output only. The CVSS score of this vulnerability. CVSS score is on a scale of 0-10 where 0 indicates low severity and 10 indicates high severity. - "cvssV2": { # Common Vulnerability Scoring System. This message is compatible with CVSS v2 and v3. For CVSS v2 details, see https://www.first.org/cvss/v2/guide CVSS v2 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v2-calculator For CVSS v3 details, see https://www.first.org/cvss/specification-document CVSS v3 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v3-calculator # The cvss v2 score for the vulnerability. - "attackComplexity": "A String", # Defined in CVSS v3, CVSS v2 - "attackVector": "A String", # Base Metrics Represents the intrinsic characteristics of a vulnerability that are constant over time and across user environments. Defined in CVSS v3, CVSS v2 - "authentication": "A String", # Defined in CVSS v2 - "availabilityImpact": "A String", # Defined in CVSS v3, CVSS v2 + "cvssV2": { # Common Vulnerability Scoring System. This message is compatible with CVSS v2, v3, and v4. For CVSS v2 details, see https://www.first.org/cvss/v2/guide CVSS v2 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v2-calculator For CVSS v3 details, see https://www.first.org/cvss/specification-document CVSS v3 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v3-calculator For CVSS v4 details, see https://www.first.org/cvss/v4.0/user-guide CVSS v4 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v4-calculator # The cvss v2 score for the vulnerability. + "attackComplexity": "A String", # Attack Complexity (AC). Defined in CVSS v2, v3, v4. + "attackRequirements": "A String", # Attack Requirements (AT). Defined in CVSS v4. + "attackVector": "A String", # Attack Vector (AV). Defined in CVSS v2, v3, v4. + "authentication": "A String", # Authentication (Au). Defined in CVSS v2. + "availabilityImpact": "A String", # Availability Impact (A). Defined in CVSS v2, v3. "baseScore": 3.14, # The base score is a function of the base metric scores. - "confidentialityImpact": "A String", # Defined in CVSS v3, CVSS v2 + "confidentialityImpact": "A String", # Confidentiality Impact (C). Defined in CVSS v2, v3. "exploitabilityScore": 3.14, "impactScore": 3.14, - "integrityImpact": "A String", # Defined in CVSS v3, CVSS v2 - "privilegesRequired": "A String", # Defined in CVSS v3 - "scope": "A String", # Defined in CVSS v3 - "userInteraction": "A String", # Defined in CVSS v3 - }, - "cvssV3": { # Common Vulnerability Scoring System. This message is compatible with CVSS v2 and v3. For CVSS v2 details, see https://www.first.org/cvss/v2/guide CVSS v2 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v2-calculator For CVSS v3 details, see https://www.first.org/cvss/specification-document CVSS v3 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v3-calculator # The cvss v3 score for the vulnerability. - "attackComplexity": "A String", # Defined in CVSS v3, CVSS v2 - "attackVector": "A String", # Base Metrics Represents the intrinsic characteristics of a vulnerability that are constant over time and across user environments. Defined in CVSS v3, CVSS v2 - "authentication": "A String", # Defined in CVSS v2 - "availabilityImpact": "A String", # Defined in CVSS v3, CVSS v2 + "integrityImpact": "A String", # Integrity Impact (I). Defined in CVSS v2, v3. + "privilegesRequired": "A String", # Privileges Required (PR). Defined in CVSS v3, v4. + "scope": "A String", # Scope (S). Defined in CVSS v3. + "subsequentSystemAvailabilityImpact": "A String", # Subsequent System Availability Impact (SA). Defined in CVSS v4. + "subsequentSystemConfidentialityImpact": "A String", # Subsequent System Confidentiality Impact (SC). Defined in CVSS v4. + "subsequentSystemIntegrityImpact": "A String", # Subsequent System Integrity Impact (SI). Defined in CVSS v4. + "userInteraction": "A String", # User Interaction (UI). Defined in CVSS v3, v4. + "vulnerableSystemAvailabilityImpact": "A String", # Vulnerable System Availability Impact (VA). Defined in CVSS v4. + "vulnerableSystemConfidentialityImpact": "A String", # Vulnerable System Confidentiality Impact (VC). Defined in CVSS v4. + "vulnerableSystemIntegrityImpact": "A String", # Vulnerable System Integrity Impact (VI). Defined in CVSS v4. + }, + "cvssV3": { # Common Vulnerability Scoring System. This message is compatible with CVSS v2, v3, and v4. For CVSS v2 details, see https://www.first.org/cvss/v2/guide CVSS v2 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v2-calculator For CVSS v3 details, see https://www.first.org/cvss/specification-document CVSS v3 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v3-calculator For CVSS v4 details, see https://www.first.org/cvss/v4.0/user-guide CVSS v4 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v4-calculator # The cvss v3 score for the vulnerability. + "attackComplexity": "A String", # Attack Complexity (AC). Defined in CVSS v2, v3, v4. + "attackRequirements": "A String", # Attack Requirements (AT). Defined in CVSS v4. + "attackVector": "A String", # Attack Vector (AV). Defined in CVSS v2, v3, v4. + "authentication": "A String", # Authentication (Au). Defined in CVSS v2. + "availabilityImpact": "A String", # Availability Impact (A). Defined in CVSS v2, v3. "baseScore": 3.14, # The base score is a function of the base metric scores. - "confidentialityImpact": "A String", # Defined in CVSS v3, CVSS v2 + "confidentialityImpact": "A String", # Confidentiality Impact (C). Defined in CVSS v2, v3. "exploitabilityScore": 3.14, "impactScore": 3.14, - "integrityImpact": "A String", # Defined in CVSS v3, CVSS v2 - "privilegesRequired": "A String", # Defined in CVSS v3 - "scope": "A String", # Defined in CVSS v3 - "userInteraction": "A String", # Defined in CVSS v3 + "integrityImpact": "A String", # Integrity Impact (I). Defined in CVSS v2, v3. + "privilegesRequired": "A String", # Privileges Required (PR). Defined in CVSS v3, v4. + "scope": "A String", # Scope (S). Defined in CVSS v3. + "subsequentSystemAvailabilityImpact": "A String", # Subsequent System Availability Impact (SA). Defined in CVSS v4. + "subsequentSystemConfidentialityImpact": "A String", # Subsequent System Confidentiality Impact (SC). Defined in CVSS v4. + "subsequentSystemIntegrityImpact": "A String", # Subsequent System Integrity Impact (SI). Defined in CVSS v4. + "userInteraction": "A String", # User Interaction (UI). Defined in CVSS v3, v4. + "vulnerableSystemAvailabilityImpact": "A String", # Vulnerable System Availability Impact (VA). Defined in CVSS v4. + "vulnerableSystemConfidentialityImpact": "A String", # Vulnerable System Confidentiality Impact (VC). Defined in CVSS v4. + "vulnerableSystemIntegrityImpact": "A String", # Vulnerable System Integrity Impact (VI). Defined in CVSS v4. }, "cvssVersion": "A String", # Output only. CVSS version used to populate cvss_score and severity. "effectiveSeverity": "A String", # The distro assigned severity for this vulnerability when it is available, and note provider assigned severity when distro has not yet assigned a severity for this vulnerability. When there are multiple PackageIssues for this vulnerability, they can have different effective severities because some might be provided by the distro while others are provided by the language ecosystem for a language pack. For this reason, it is advised to use the effective severity on the PackageIssue level. In the case where multiple PackageIssues have differing effective severities, this field should be the highest severity for any of the PackageIssues. @@ -1265,33 +1279,47 @@

Method Details

"updateTime": "A String", # Output only. The time this occurrence was last updated. "vulnerability": { # Details of a vulnerability Occurrence. # Describes a security vulnerability. "cvssScore": 3.14, # Output only. The CVSS score of this vulnerability. CVSS score is on a scale of 0-10 where 0 indicates low severity and 10 indicates high severity. - "cvssV2": { # Common Vulnerability Scoring System. This message is compatible with CVSS v2 and v3. For CVSS v2 details, see https://www.first.org/cvss/v2/guide CVSS v2 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v2-calculator For CVSS v3 details, see https://www.first.org/cvss/specification-document CVSS v3 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v3-calculator # The cvss v2 score for the vulnerability. - "attackComplexity": "A String", # Defined in CVSS v3, CVSS v2 - "attackVector": "A String", # Base Metrics Represents the intrinsic characteristics of a vulnerability that are constant over time and across user environments. Defined in CVSS v3, CVSS v2 - "authentication": "A String", # Defined in CVSS v2 - "availabilityImpact": "A String", # Defined in CVSS v3, CVSS v2 + "cvssV2": { # Common Vulnerability Scoring System. This message is compatible with CVSS v2, v3, and v4. For CVSS v2 details, see https://www.first.org/cvss/v2/guide CVSS v2 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v2-calculator For CVSS v3 details, see https://www.first.org/cvss/specification-document CVSS v3 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v3-calculator For CVSS v4 details, see https://www.first.org/cvss/v4.0/user-guide CVSS v4 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v4-calculator # The cvss v2 score for the vulnerability. + "attackComplexity": "A String", # Attack Complexity (AC). Defined in CVSS v2, v3, v4. + "attackRequirements": "A String", # Attack Requirements (AT). Defined in CVSS v4. + "attackVector": "A String", # Attack Vector (AV). Defined in CVSS v2, v3, v4. + "authentication": "A String", # Authentication (Au). Defined in CVSS v2. + "availabilityImpact": "A String", # Availability Impact (A). Defined in CVSS v2, v3. "baseScore": 3.14, # The base score is a function of the base metric scores. - "confidentialityImpact": "A String", # Defined in CVSS v3, CVSS v2 + "confidentialityImpact": "A String", # Confidentiality Impact (C). Defined in CVSS v2, v3. "exploitabilityScore": 3.14, "impactScore": 3.14, - "integrityImpact": "A String", # Defined in CVSS v3, CVSS v2 - "privilegesRequired": "A String", # Defined in CVSS v3 - "scope": "A String", # Defined in CVSS v3 - "userInteraction": "A String", # Defined in CVSS v3 - }, - "cvssV3": { # Common Vulnerability Scoring System. This message is compatible with CVSS v2 and v3. For CVSS v2 details, see https://www.first.org/cvss/v2/guide CVSS v2 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v2-calculator For CVSS v3 details, see https://www.first.org/cvss/specification-document CVSS v3 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v3-calculator # The cvss v3 score for the vulnerability. - "attackComplexity": "A String", # Defined in CVSS v3, CVSS v2 - "attackVector": "A String", # Base Metrics Represents the intrinsic characteristics of a vulnerability that are constant over time and across user environments. Defined in CVSS v3, CVSS v2 - "authentication": "A String", # Defined in CVSS v2 - "availabilityImpact": "A String", # Defined in CVSS v3, CVSS v2 + "integrityImpact": "A String", # Integrity Impact (I). Defined in CVSS v2, v3. + "privilegesRequired": "A String", # Privileges Required (PR). Defined in CVSS v3, v4. + "scope": "A String", # Scope (S). Defined in CVSS v3. + "subsequentSystemAvailabilityImpact": "A String", # Subsequent System Availability Impact (SA). Defined in CVSS v4. + "subsequentSystemConfidentialityImpact": "A String", # Subsequent System Confidentiality Impact (SC). Defined in CVSS v4. + "subsequentSystemIntegrityImpact": "A String", # Subsequent System Integrity Impact (SI). Defined in CVSS v4. + "userInteraction": "A String", # User Interaction (UI). Defined in CVSS v3, v4. + "vulnerableSystemAvailabilityImpact": "A String", # Vulnerable System Availability Impact (VA). Defined in CVSS v4. + "vulnerableSystemConfidentialityImpact": "A String", # Vulnerable System Confidentiality Impact (VC). Defined in CVSS v4. + "vulnerableSystemIntegrityImpact": "A String", # Vulnerable System Integrity Impact (VI). Defined in CVSS v4. + }, + "cvssV3": { # Common Vulnerability Scoring System. This message is compatible with CVSS v2, v3, and v4. For CVSS v2 details, see https://www.first.org/cvss/v2/guide CVSS v2 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v2-calculator For CVSS v3 details, see https://www.first.org/cvss/specification-document CVSS v3 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v3-calculator For CVSS v4 details, see https://www.first.org/cvss/v4.0/user-guide CVSS v4 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v4-calculator # The cvss v3 score for the vulnerability. + "attackComplexity": "A String", # Attack Complexity (AC). Defined in CVSS v2, v3, v4. + "attackRequirements": "A String", # Attack Requirements (AT). Defined in CVSS v4. + "attackVector": "A String", # Attack Vector (AV). Defined in CVSS v2, v3, v4. + "authentication": "A String", # Authentication (Au). Defined in CVSS v2. + "availabilityImpact": "A String", # Availability Impact (A). Defined in CVSS v2, v3. "baseScore": 3.14, # The base score is a function of the base metric scores. - "confidentialityImpact": "A String", # Defined in CVSS v3, CVSS v2 + "confidentialityImpact": "A String", # Confidentiality Impact (C). Defined in CVSS v2, v3. "exploitabilityScore": 3.14, "impactScore": 3.14, - "integrityImpact": "A String", # Defined in CVSS v3, CVSS v2 - "privilegesRequired": "A String", # Defined in CVSS v3 - "scope": "A String", # Defined in CVSS v3 - "userInteraction": "A String", # Defined in CVSS v3 + "integrityImpact": "A String", # Integrity Impact (I). Defined in CVSS v2, v3. + "privilegesRequired": "A String", # Privileges Required (PR). Defined in CVSS v3, v4. + "scope": "A String", # Scope (S). Defined in CVSS v3. + "subsequentSystemAvailabilityImpact": "A String", # Subsequent System Availability Impact (SA). Defined in CVSS v4. + "subsequentSystemConfidentialityImpact": "A String", # Subsequent System Confidentiality Impact (SC). Defined in CVSS v4. + "subsequentSystemIntegrityImpact": "A String", # Subsequent System Integrity Impact (SI). Defined in CVSS v4. + "userInteraction": "A String", # User Interaction (UI). Defined in CVSS v3, v4. + "vulnerableSystemAvailabilityImpact": "A String", # Vulnerable System Availability Impact (VA). Defined in CVSS v4. + "vulnerableSystemConfidentialityImpact": "A String", # Vulnerable System Confidentiality Impact (VC). Defined in CVSS v4. + "vulnerableSystemIntegrityImpact": "A String", # Vulnerable System Integrity Impact (VI). Defined in CVSS v4. }, "cvssVersion": "A String", # Output only. CVSS version used to populate cvss_score and severity. "effectiveSeverity": "A String", # The distro assigned severity for this vulnerability when it is available, and note provider assigned severity when distro has not yet assigned a severity for this vulnerability. When there are multiple PackageIssues for this vulnerability, they can have different effective severities because some might be provided by the distro while others are provided by the language ecosystem for a language pack. For this reason, it is advised to use the effective severity on the PackageIssue level. In the case where multiple PackageIssues have differing effective severities, this field should be the highest severity for any of the PackageIssues. @@ -1897,33 +1925,47 @@

Method Details

"updateTime": "A String", # Output only. The time this occurrence was last updated. "vulnerability": { # Details of a vulnerability Occurrence. # Describes a security vulnerability. "cvssScore": 3.14, # Output only. The CVSS score of this vulnerability. CVSS score is on a scale of 0-10 where 0 indicates low severity and 10 indicates high severity. - "cvssV2": { # Common Vulnerability Scoring System. This message is compatible with CVSS v2 and v3. For CVSS v2 details, see https://www.first.org/cvss/v2/guide CVSS v2 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v2-calculator For CVSS v3 details, see https://www.first.org/cvss/specification-document CVSS v3 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v3-calculator # The cvss v2 score for the vulnerability. - "attackComplexity": "A String", # Defined in CVSS v3, CVSS v2 - "attackVector": "A String", # Base Metrics Represents the intrinsic characteristics of a vulnerability that are constant over time and across user environments. Defined in CVSS v3, CVSS v2 - "authentication": "A String", # Defined in CVSS v2 - "availabilityImpact": "A String", # Defined in CVSS v3, CVSS v2 + "cvssV2": { # Common Vulnerability Scoring System. This message is compatible with CVSS v2, v3, and v4. For CVSS v2 details, see https://www.first.org/cvss/v2/guide CVSS v2 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v2-calculator For CVSS v3 details, see https://www.first.org/cvss/specification-document CVSS v3 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v3-calculator For CVSS v4 details, see https://www.first.org/cvss/v4.0/user-guide CVSS v4 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v4-calculator # The cvss v2 score for the vulnerability. + "attackComplexity": "A String", # Attack Complexity (AC). Defined in CVSS v2, v3, v4. + "attackRequirements": "A String", # Attack Requirements (AT). Defined in CVSS v4. + "attackVector": "A String", # Attack Vector (AV). Defined in CVSS v2, v3, v4. + "authentication": "A String", # Authentication (Au). Defined in CVSS v2. + "availabilityImpact": "A String", # Availability Impact (A). Defined in CVSS v2, v3. "baseScore": 3.14, # The base score is a function of the base metric scores. - "confidentialityImpact": "A String", # Defined in CVSS v3, CVSS v2 + "confidentialityImpact": "A String", # Confidentiality Impact (C). Defined in CVSS v2, v3. "exploitabilityScore": 3.14, "impactScore": 3.14, - "integrityImpact": "A String", # Defined in CVSS v3, CVSS v2 - "privilegesRequired": "A String", # Defined in CVSS v3 - "scope": "A String", # Defined in CVSS v3 - "userInteraction": "A String", # Defined in CVSS v3 + "integrityImpact": "A String", # Integrity Impact (I). Defined in CVSS v2, v3. + "privilegesRequired": "A String", # Privileges Required (PR). Defined in CVSS v3, v4. + "scope": "A String", # Scope (S). Defined in CVSS v3. + "subsequentSystemAvailabilityImpact": "A String", # Subsequent System Availability Impact (SA). Defined in CVSS v4. + "subsequentSystemConfidentialityImpact": "A String", # Subsequent System Confidentiality Impact (SC). Defined in CVSS v4. + "subsequentSystemIntegrityImpact": "A String", # Subsequent System Integrity Impact (SI). Defined in CVSS v4. + "userInteraction": "A String", # User Interaction (UI). Defined in CVSS v3, v4. + "vulnerableSystemAvailabilityImpact": "A String", # Vulnerable System Availability Impact (VA). Defined in CVSS v4. + "vulnerableSystemConfidentialityImpact": "A String", # Vulnerable System Confidentiality Impact (VC). Defined in CVSS v4. + "vulnerableSystemIntegrityImpact": "A String", # Vulnerable System Integrity Impact (VI). Defined in CVSS v4. }, - "cvssV3": { # Common Vulnerability Scoring System. This message is compatible with CVSS v2 and v3. For CVSS v2 details, see https://www.first.org/cvss/v2/guide CVSS v2 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v2-calculator For CVSS v3 details, see https://www.first.org/cvss/specification-document CVSS v3 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v3-calculator # The cvss v3 score for the vulnerability. - "attackComplexity": "A String", # Defined in CVSS v3, CVSS v2 - "attackVector": "A String", # Base Metrics Represents the intrinsic characteristics of a vulnerability that are constant over time and across user environments. Defined in CVSS v3, CVSS v2 - "authentication": "A String", # Defined in CVSS v2 - "availabilityImpact": "A String", # Defined in CVSS v3, CVSS v2 + "cvssV3": { # Common Vulnerability Scoring System. This message is compatible with CVSS v2, v3, and v4. For CVSS v2 details, see https://www.first.org/cvss/v2/guide CVSS v2 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v2-calculator For CVSS v3 details, see https://www.first.org/cvss/specification-document CVSS v3 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v3-calculator For CVSS v4 details, see https://www.first.org/cvss/v4.0/user-guide CVSS v4 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v4-calculator # The cvss v3 score for the vulnerability. + "attackComplexity": "A String", # Attack Complexity (AC). Defined in CVSS v2, v3, v4. + "attackRequirements": "A String", # Attack Requirements (AT). Defined in CVSS v4. + "attackVector": "A String", # Attack Vector (AV). Defined in CVSS v2, v3, v4. + "authentication": "A String", # Authentication (Au). Defined in CVSS v2. + "availabilityImpact": "A String", # Availability Impact (A). Defined in CVSS v2, v3. "baseScore": 3.14, # The base score is a function of the base metric scores. - "confidentialityImpact": "A String", # Defined in CVSS v3, CVSS v2 + "confidentialityImpact": "A String", # Confidentiality Impact (C). Defined in CVSS v2, v3. "exploitabilityScore": 3.14, "impactScore": 3.14, - "integrityImpact": "A String", # Defined in CVSS v3, CVSS v2 - "privilegesRequired": "A String", # Defined in CVSS v3 - "scope": "A String", # Defined in CVSS v3 - "userInteraction": "A String", # Defined in CVSS v3 + "integrityImpact": "A String", # Integrity Impact (I). Defined in CVSS v2, v3. + "privilegesRequired": "A String", # Privileges Required (PR). Defined in CVSS v3, v4. + "scope": "A String", # Scope (S). Defined in CVSS v3. + "subsequentSystemAvailabilityImpact": "A String", # Subsequent System Availability Impact (SA). Defined in CVSS v4. + "subsequentSystemConfidentialityImpact": "A String", # Subsequent System Confidentiality Impact (SC). Defined in CVSS v4. + "subsequentSystemIntegrityImpact": "A String", # Subsequent System Integrity Impact (SI). Defined in CVSS v4. + "userInteraction": "A String", # User Interaction (UI). Defined in CVSS v3, v4. + "vulnerableSystemAvailabilityImpact": "A String", # Vulnerable System Availability Impact (VA). Defined in CVSS v4. + "vulnerableSystemConfidentialityImpact": "A String", # Vulnerable System Confidentiality Impact (VC). Defined in CVSS v4. + "vulnerableSystemIntegrityImpact": "A String", # Vulnerable System Integrity Impact (VI). Defined in CVSS v4. }, "cvssVersion": "A String", # Output only. CVSS version used to populate cvss_score and severity. "effectiveSeverity": "A String", # The distro assigned severity for this vulnerability when it is available, and note provider assigned severity when distro has not yet assigned a severity for this vulnerability. When there are multiple PackageIssues for this vulnerability, they can have different effective severities because some might be provided by the distro while others are provided by the language ecosystem for a language pack. For this reason, it is advised to use the effective severity on the PackageIssue level. In the case where multiple PackageIssues have differing effective severities, this field should be the highest severity for any of the PackageIssues. @@ -2520,33 +2562,47 @@

Method Details

"updateTime": "A String", # Output only. The time this occurrence was last updated. "vulnerability": { # Details of a vulnerability Occurrence. # Describes a security vulnerability. "cvssScore": 3.14, # Output only. The CVSS score of this vulnerability. CVSS score is on a scale of 0-10 where 0 indicates low severity and 10 indicates high severity. - "cvssV2": { # Common Vulnerability Scoring System. This message is compatible with CVSS v2 and v3. For CVSS v2 details, see https://www.first.org/cvss/v2/guide CVSS v2 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v2-calculator For CVSS v3 details, see https://www.first.org/cvss/specification-document CVSS v3 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v3-calculator # The cvss v2 score for the vulnerability. - "attackComplexity": "A String", # Defined in CVSS v3, CVSS v2 - "attackVector": "A String", # Base Metrics Represents the intrinsic characteristics of a vulnerability that are constant over time and across user environments. Defined in CVSS v3, CVSS v2 - "authentication": "A String", # Defined in CVSS v2 - "availabilityImpact": "A String", # Defined in CVSS v3, CVSS v2 + "cvssV2": { # Common Vulnerability Scoring System. This message is compatible with CVSS v2, v3, and v4. For CVSS v2 details, see https://www.first.org/cvss/v2/guide CVSS v2 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v2-calculator For CVSS v3 details, see https://www.first.org/cvss/specification-document CVSS v3 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v3-calculator For CVSS v4 details, see https://www.first.org/cvss/v4.0/user-guide CVSS v4 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v4-calculator # The cvss v2 score for the vulnerability. + "attackComplexity": "A String", # Attack Complexity (AC). Defined in CVSS v2, v3, v4. + "attackRequirements": "A String", # Attack Requirements (AT). Defined in CVSS v4. + "attackVector": "A String", # Attack Vector (AV). Defined in CVSS v2, v3, v4. + "authentication": "A String", # Authentication (Au). Defined in CVSS v2. + "availabilityImpact": "A String", # Availability Impact (A). Defined in CVSS v2, v3. "baseScore": 3.14, # The base score is a function of the base metric scores. - "confidentialityImpact": "A String", # Defined in CVSS v3, CVSS v2 + "confidentialityImpact": "A String", # Confidentiality Impact (C). Defined in CVSS v2, v3. "exploitabilityScore": 3.14, "impactScore": 3.14, - "integrityImpact": "A String", # Defined in CVSS v3, CVSS v2 - "privilegesRequired": "A String", # Defined in CVSS v3 - "scope": "A String", # Defined in CVSS v3 - "userInteraction": "A String", # Defined in CVSS v3 + "integrityImpact": "A String", # Integrity Impact (I). Defined in CVSS v2, v3. + "privilegesRequired": "A String", # Privileges Required (PR). Defined in CVSS v3, v4. + "scope": "A String", # Scope (S). Defined in CVSS v3. + "subsequentSystemAvailabilityImpact": "A String", # Subsequent System Availability Impact (SA). Defined in CVSS v4. + "subsequentSystemConfidentialityImpact": "A String", # Subsequent System Confidentiality Impact (SC). Defined in CVSS v4. + "subsequentSystemIntegrityImpact": "A String", # Subsequent System Integrity Impact (SI). Defined in CVSS v4. + "userInteraction": "A String", # User Interaction (UI). Defined in CVSS v3, v4. + "vulnerableSystemAvailabilityImpact": "A String", # Vulnerable System Availability Impact (VA). Defined in CVSS v4. + "vulnerableSystemConfidentialityImpact": "A String", # Vulnerable System Confidentiality Impact (VC). Defined in CVSS v4. + "vulnerableSystemIntegrityImpact": "A String", # Vulnerable System Integrity Impact (VI). Defined in CVSS v4. }, - "cvssV3": { # Common Vulnerability Scoring System. This message is compatible with CVSS v2 and v3. For CVSS v2 details, see https://www.first.org/cvss/v2/guide CVSS v2 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v2-calculator For CVSS v3 details, see https://www.first.org/cvss/specification-document CVSS v3 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v3-calculator # The cvss v3 score for the vulnerability. - "attackComplexity": "A String", # Defined in CVSS v3, CVSS v2 - "attackVector": "A String", # Base Metrics Represents the intrinsic characteristics of a vulnerability that are constant over time and across user environments. Defined in CVSS v3, CVSS v2 - "authentication": "A String", # Defined in CVSS v2 - "availabilityImpact": "A String", # Defined in CVSS v3, CVSS v2 + "cvssV3": { # Common Vulnerability Scoring System. This message is compatible with CVSS v2, v3, and v4. For CVSS v2 details, see https://www.first.org/cvss/v2/guide CVSS v2 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v2-calculator For CVSS v3 details, see https://www.first.org/cvss/specification-document CVSS v3 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v3-calculator For CVSS v4 details, see https://www.first.org/cvss/v4.0/user-guide CVSS v4 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v4-calculator # The cvss v3 score for the vulnerability. + "attackComplexity": "A String", # Attack Complexity (AC). Defined in CVSS v2, v3, v4. + "attackRequirements": "A String", # Attack Requirements (AT). Defined in CVSS v4. + "attackVector": "A String", # Attack Vector (AV). Defined in CVSS v2, v3, v4. + "authentication": "A String", # Authentication (Au). Defined in CVSS v2. + "availabilityImpact": "A String", # Availability Impact (A). Defined in CVSS v2, v3. "baseScore": 3.14, # The base score is a function of the base metric scores. - "confidentialityImpact": "A String", # Defined in CVSS v3, CVSS v2 + "confidentialityImpact": "A String", # Confidentiality Impact (C). Defined in CVSS v2, v3. "exploitabilityScore": 3.14, "impactScore": 3.14, - "integrityImpact": "A String", # Defined in CVSS v3, CVSS v2 - "privilegesRequired": "A String", # Defined in CVSS v3 - "scope": "A String", # Defined in CVSS v3 - "userInteraction": "A String", # Defined in CVSS v3 + "integrityImpact": "A String", # Integrity Impact (I). Defined in CVSS v2, v3. + "privilegesRequired": "A String", # Privileges Required (PR). Defined in CVSS v3, v4. + "scope": "A String", # Scope (S). Defined in CVSS v3. + "subsequentSystemAvailabilityImpact": "A String", # Subsequent System Availability Impact (SA). Defined in CVSS v4. + "subsequentSystemConfidentialityImpact": "A String", # Subsequent System Confidentiality Impact (SC). Defined in CVSS v4. + "subsequentSystemIntegrityImpact": "A String", # Subsequent System Integrity Impact (SI). Defined in CVSS v4. + "userInteraction": "A String", # User Interaction (UI). Defined in CVSS v3, v4. + "vulnerableSystemAvailabilityImpact": "A String", # Vulnerable System Availability Impact (VA). Defined in CVSS v4. + "vulnerableSystemConfidentialityImpact": "A String", # Vulnerable System Confidentiality Impact (VC). Defined in CVSS v4. + "vulnerableSystemIntegrityImpact": "A String", # Vulnerable System Integrity Impact (VI). Defined in CVSS v4. }, "cvssVersion": "A String", # Output only. CVSS version used to populate cvss_score and severity. "effectiveSeverity": "A String", # The distro assigned severity for this vulnerability when it is available, and note provider assigned severity when distro has not yet assigned a severity for this vulnerability. When there are multiple PackageIssues for this vulnerability, they can have different effective severities because some might be provided by the distro while others are provided by the language ecosystem for a language pack. For this reason, it is advised to use the effective severity on the PackageIssue level. In the case where multiple PackageIssues have differing effective severities, this field should be the highest severity for any of the PackageIssues. @@ -3168,33 +3224,47 @@

Method Details

"updateTime": "A String", # Output only. The time this occurrence was last updated. "vulnerability": { # Details of a vulnerability Occurrence. # Describes a security vulnerability. "cvssScore": 3.14, # Output only. The CVSS score of this vulnerability. CVSS score is on a scale of 0-10 where 0 indicates low severity and 10 indicates high severity. - "cvssV2": { # Common Vulnerability Scoring System. This message is compatible with CVSS v2 and v3. For CVSS v2 details, see https://www.first.org/cvss/v2/guide CVSS v2 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v2-calculator For CVSS v3 details, see https://www.first.org/cvss/specification-document CVSS v3 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v3-calculator # The cvss v2 score for the vulnerability. - "attackComplexity": "A String", # Defined in CVSS v3, CVSS v2 - "attackVector": "A String", # Base Metrics Represents the intrinsic characteristics of a vulnerability that are constant over time and across user environments. Defined in CVSS v3, CVSS v2 - "authentication": "A String", # Defined in CVSS v2 - "availabilityImpact": "A String", # Defined in CVSS v3, CVSS v2 + "cvssV2": { # Common Vulnerability Scoring System. This message is compatible with CVSS v2, v3, and v4. For CVSS v2 details, see https://www.first.org/cvss/v2/guide CVSS v2 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v2-calculator For CVSS v3 details, see https://www.first.org/cvss/specification-document CVSS v3 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v3-calculator For CVSS v4 details, see https://www.first.org/cvss/v4.0/user-guide CVSS v4 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v4-calculator # The cvss v2 score for the vulnerability. + "attackComplexity": "A String", # Attack Complexity (AC). Defined in CVSS v2, v3, v4. + "attackRequirements": "A String", # Attack Requirements (AT). Defined in CVSS v4. + "attackVector": "A String", # Attack Vector (AV). Defined in CVSS v2, v3, v4. + "authentication": "A String", # Authentication (Au). Defined in CVSS v2. + "availabilityImpact": "A String", # Availability Impact (A). Defined in CVSS v2, v3. "baseScore": 3.14, # The base score is a function of the base metric scores. - "confidentialityImpact": "A String", # Defined in CVSS v3, CVSS v2 + "confidentialityImpact": "A String", # Confidentiality Impact (C). Defined in CVSS v2, v3. "exploitabilityScore": 3.14, "impactScore": 3.14, - "integrityImpact": "A String", # Defined in CVSS v3, CVSS v2 - "privilegesRequired": "A String", # Defined in CVSS v3 - "scope": "A String", # Defined in CVSS v3 - "userInteraction": "A String", # Defined in CVSS v3 + "integrityImpact": "A String", # Integrity Impact (I). Defined in CVSS v2, v3. + "privilegesRequired": "A String", # Privileges Required (PR). Defined in CVSS v3, v4. + "scope": "A String", # Scope (S). Defined in CVSS v3. + "subsequentSystemAvailabilityImpact": "A String", # Subsequent System Availability Impact (SA). Defined in CVSS v4. + "subsequentSystemConfidentialityImpact": "A String", # Subsequent System Confidentiality Impact (SC). Defined in CVSS v4. + "subsequentSystemIntegrityImpact": "A String", # Subsequent System Integrity Impact (SI). Defined in CVSS v4. + "userInteraction": "A String", # User Interaction (UI). Defined in CVSS v3, v4. + "vulnerableSystemAvailabilityImpact": "A String", # Vulnerable System Availability Impact (VA). Defined in CVSS v4. + "vulnerableSystemConfidentialityImpact": "A String", # Vulnerable System Confidentiality Impact (VC). Defined in CVSS v4. + "vulnerableSystemIntegrityImpact": "A String", # Vulnerable System Integrity Impact (VI). Defined in CVSS v4. }, - "cvssV3": { # Common Vulnerability Scoring System. This message is compatible with CVSS v2 and v3. For CVSS v2 details, see https://www.first.org/cvss/v2/guide CVSS v2 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v2-calculator For CVSS v3 details, see https://www.first.org/cvss/specification-document CVSS v3 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v3-calculator # The cvss v3 score for the vulnerability. - "attackComplexity": "A String", # Defined in CVSS v3, CVSS v2 - "attackVector": "A String", # Base Metrics Represents the intrinsic characteristics of a vulnerability that are constant over time and across user environments. Defined in CVSS v3, CVSS v2 - "authentication": "A String", # Defined in CVSS v2 - "availabilityImpact": "A String", # Defined in CVSS v3, CVSS v2 + "cvssV3": { # Common Vulnerability Scoring System. This message is compatible with CVSS v2, v3, and v4. For CVSS v2 details, see https://www.first.org/cvss/v2/guide CVSS v2 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v2-calculator For CVSS v3 details, see https://www.first.org/cvss/specification-document CVSS v3 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v3-calculator For CVSS v4 details, see https://www.first.org/cvss/v4.0/user-guide CVSS v4 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v4-calculator # The cvss v3 score for the vulnerability. + "attackComplexity": "A String", # Attack Complexity (AC). Defined in CVSS v2, v3, v4. + "attackRequirements": "A String", # Attack Requirements (AT). Defined in CVSS v4. + "attackVector": "A String", # Attack Vector (AV). Defined in CVSS v2, v3, v4. + "authentication": "A String", # Authentication (Au). Defined in CVSS v2. + "availabilityImpact": "A String", # Availability Impact (A). Defined in CVSS v2, v3. "baseScore": 3.14, # The base score is a function of the base metric scores. - "confidentialityImpact": "A String", # Defined in CVSS v3, CVSS v2 + "confidentialityImpact": "A String", # Confidentiality Impact (C). Defined in CVSS v2, v3. "exploitabilityScore": 3.14, "impactScore": 3.14, - "integrityImpact": "A String", # Defined in CVSS v3, CVSS v2 - "privilegesRequired": "A String", # Defined in CVSS v3 - "scope": "A String", # Defined in CVSS v3 - "userInteraction": "A String", # Defined in CVSS v3 + "integrityImpact": "A String", # Integrity Impact (I). Defined in CVSS v2, v3. + "privilegesRequired": "A String", # Privileges Required (PR). Defined in CVSS v3, v4. + "scope": "A String", # Scope (S). Defined in CVSS v3. + "subsequentSystemAvailabilityImpact": "A String", # Subsequent System Availability Impact (SA). Defined in CVSS v4. + "subsequentSystemConfidentialityImpact": "A String", # Subsequent System Confidentiality Impact (SC). Defined in CVSS v4. + "subsequentSystemIntegrityImpact": "A String", # Subsequent System Integrity Impact (SI). Defined in CVSS v4. + "userInteraction": "A String", # User Interaction (UI). Defined in CVSS v3, v4. + "vulnerableSystemAvailabilityImpact": "A String", # Vulnerable System Availability Impact (VA). Defined in CVSS v4. + "vulnerableSystemConfidentialityImpact": "A String", # Vulnerable System Confidentiality Impact (VC). Defined in CVSS v4. + "vulnerableSystemIntegrityImpact": "A String", # Vulnerable System Integrity Impact (VI). Defined in CVSS v4. }, "cvssVersion": "A String", # Output only. CVSS version used to populate cvss_score and severity. "effectiveSeverity": "A String", # The distro assigned severity for this vulnerability when it is available, and note provider assigned severity when distro has not yet assigned a severity for this vulnerability. When there are multiple PackageIssues for this vulnerability, they can have different effective severities because some might be provided by the distro while others are provided by the language ecosystem for a language pack. For this reason, it is advised to use the effective severity on the PackageIssue level. In the case where multiple PackageIssues have differing effective severities, this field should be the highest severity for any of the PackageIssues. @@ -3504,19 +3574,26 @@

Method Details

"vulnerability": { # Vulnerability provides metadata about a security vulnerability in a Note. # A note describing a package vulnerability. "advisoryPublishTime": "A String", # The time this advisory was published by the source. "cvssScore": 3.14, # The CVSS score for this vulnerability. - "cvssV2": { # Common Vulnerability Scoring System. This message is compatible with CVSS v2 and v3. For CVSS v2 details, see https://www.first.org/cvss/v2/guide CVSS v2 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v2-calculator For CVSS v3 details, see https://www.first.org/cvss/specification-document CVSS v3 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v3-calculator # The full description of the CVSS for version 2. - "attackComplexity": "A String", # Defined in CVSS v3, CVSS v2 - "attackVector": "A String", # Base Metrics Represents the intrinsic characteristics of a vulnerability that are constant over time and across user environments. Defined in CVSS v3, CVSS v2 - "authentication": "A String", # Defined in CVSS v2 - "availabilityImpact": "A String", # Defined in CVSS v3, CVSS v2 + "cvssV2": { # Common Vulnerability Scoring System. This message is compatible with CVSS v2, v3, and v4. For CVSS v2 details, see https://www.first.org/cvss/v2/guide CVSS v2 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v2-calculator For CVSS v3 details, see https://www.first.org/cvss/specification-document CVSS v3 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v3-calculator For CVSS v4 details, see https://www.first.org/cvss/v4.0/user-guide CVSS v4 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v4-calculator # The full description of the CVSS for version 2. + "attackComplexity": "A String", # Attack Complexity (AC). Defined in CVSS v2, v3, v4. + "attackRequirements": "A String", # Attack Requirements (AT). Defined in CVSS v4. + "attackVector": "A String", # Attack Vector (AV). Defined in CVSS v2, v3, v4. + "authentication": "A String", # Authentication (Au). Defined in CVSS v2. + "availabilityImpact": "A String", # Availability Impact (A). Defined in CVSS v2, v3. "baseScore": 3.14, # The base score is a function of the base metric scores. - "confidentialityImpact": "A String", # Defined in CVSS v3, CVSS v2 + "confidentialityImpact": "A String", # Confidentiality Impact (C). Defined in CVSS v2, v3. "exploitabilityScore": 3.14, "impactScore": 3.14, - "integrityImpact": "A String", # Defined in CVSS v3, CVSS v2 - "privilegesRequired": "A String", # Defined in CVSS v3 - "scope": "A String", # Defined in CVSS v3 - "userInteraction": "A String", # Defined in CVSS v3 + "integrityImpact": "A String", # Integrity Impact (I). Defined in CVSS v2, v3. + "privilegesRequired": "A String", # Privileges Required (PR). Defined in CVSS v3, v4. + "scope": "A String", # Scope (S). Defined in CVSS v3. + "subsequentSystemAvailabilityImpact": "A String", # Subsequent System Availability Impact (SA). Defined in CVSS v4. + "subsequentSystemConfidentialityImpact": "A String", # Subsequent System Confidentiality Impact (SC). Defined in CVSS v4. + "subsequentSystemIntegrityImpact": "A String", # Subsequent System Integrity Impact (SI). Defined in CVSS v4. + "userInteraction": "A String", # User Interaction (UI). Defined in CVSS v3, v4. + "vulnerableSystemAvailabilityImpact": "A String", # Vulnerable System Availability Impact (VA). Defined in CVSS v4. + "vulnerableSystemConfidentialityImpact": "A String", # Vulnerable System Confidentiality Impact (VC). Defined in CVSS v4. + "vulnerableSystemIntegrityImpact": "A String", # Vulnerable System Integrity Impact (VI). Defined in CVSS v4. }, "cvssV3": { # Deprecated. Common Vulnerability Scoring System version 3. For details, see https://www.first.org/cvss/specification-document # The full description of the CVSS for version 3. "attackComplexity": "A String", @@ -4210,33 +4287,47 @@

Method Details

"updateTime": "A String", # Output only. The time this occurrence was last updated. "vulnerability": { # Details of a vulnerability Occurrence. # Describes a security vulnerability. "cvssScore": 3.14, # Output only. The CVSS score of this vulnerability. CVSS score is on a scale of 0-10 where 0 indicates low severity and 10 indicates high severity. - "cvssV2": { # Common Vulnerability Scoring System. This message is compatible with CVSS v2 and v3. For CVSS v2 details, see https://www.first.org/cvss/v2/guide CVSS v2 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v2-calculator For CVSS v3 details, see https://www.first.org/cvss/specification-document CVSS v3 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v3-calculator # The cvss v2 score for the vulnerability. - "attackComplexity": "A String", # Defined in CVSS v3, CVSS v2 - "attackVector": "A String", # Base Metrics Represents the intrinsic characteristics of a vulnerability that are constant over time and across user environments. Defined in CVSS v3, CVSS v2 - "authentication": "A String", # Defined in CVSS v2 - "availabilityImpact": "A String", # Defined in CVSS v3, CVSS v2 + "cvssV2": { # Common Vulnerability Scoring System. This message is compatible with CVSS v2, v3, and v4. For CVSS v2 details, see https://www.first.org/cvss/v2/guide CVSS v2 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v2-calculator For CVSS v3 details, see https://www.first.org/cvss/specification-document CVSS v3 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v3-calculator For CVSS v4 details, see https://www.first.org/cvss/v4.0/user-guide CVSS v4 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v4-calculator # The cvss v2 score for the vulnerability. + "attackComplexity": "A String", # Attack Complexity (AC). Defined in CVSS v2, v3, v4. + "attackRequirements": "A String", # Attack Requirements (AT). Defined in CVSS v4. + "attackVector": "A String", # Attack Vector (AV). Defined in CVSS v2, v3, v4. + "authentication": "A String", # Authentication (Au). Defined in CVSS v2. + "availabilityImpact": "A String", # Availability Impact (A). Defined in CVSS v2, v3. "baseScore": 3.14, # The base score is a function of the base metric scores. - "confidentialityImpact": "A String", # Defined in CVSS v3, CVSS v2 + "confidentialityImpact": "A String", # Confidentiality Impact (C). Defined in CVSS v2, v3. "exploitabilityScore": 3.14, "impactScore": 3.14, - "integrityImpact": "A String", # Defined in CVSS v3, CVSS v2 - "privilegesRequired": "A String", # Defined in CVSS v3 - "scope": "A String", # Defined in CVSS v3 - "userInteraction": "A String", # Defined in CVSS v3 - }, - "cvssV3": { # Common Vulnerability Scoring System. This message is compatible with CVSS v2 and v3. For CVSS v2 details, see https://www.first.org/cvss/v2/guide CVSS v2 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v2-calculator For CVSS v3 details, see https://www.first.org/cvss/specification-document CVSS v3 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v3-calculator # The cvss v3 score for the vulnerability. - "attackComplexity": "A String", # Defined in CVSS v3, CVSS v2 - "attackVector": "A String", # Base Metrics Represents the intrinsic characteristics of a vulnerability that are constant over time and across user environments. Defined in CVSS v3, CVSS v2 - "authentication": "A String", # Defined in CVSS v2 - "availabilityImpact": "A String", # Defined in CVSS v3, CVSS v2 + "integrityImpact": "A String", # Integrity Impact (I). Defined in CVSS v2, v3. + "privilegesRequired": "A String", # Privileges Required (PR). Defined in CVSS v3, v4. + "scope": "A String", # Scope (S). Defined in CVSS v3. + "subsequentSystemAvailabilityImpact": "A String", # Subsequent System Availability Impact (SA). Defined in CVSS v4. + "subsequentSystemConfidentialityImpact": "A String", # Subsequent System Confidentiality Impact (SC). Defined in CVSS v4. + "subsequentSystemIntegrityImpact": "A String", # Subsequent System Integrity Impact (SI). Defined in CVSS v4. + "userInteraction": "A String", # User Interaction (UI). Defined in CVSS v3, v4. + "vulnerableSystemAvailabilityImpact": "A String", # Vulnerable System Availability Impact (VA). Defined in CVSS v4. + "vulnerableSystemConfidentialityImpact": "A String", # Vulnerable System Confidentiality Impact (VC). Defined in CVSS v4. + "vulnerableSystemIntegrityImpact": "A String", # Vulnerable System Integrity Impact (VI). Defined in CVSS v4. + }, + "cvssV3": { # Common Vulnerability Scoring System. This message is compatible with CVSS v2, v3, and v4. For CVSS v2 details, see https://www.first.org/cvss/v2/guide CVSS v2 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v2-calculator For CVSS v3 details, see https://www.first.org/cvss/specification-document CVSS v3 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v3-calculator For CVSS v4 details, see https://www.first.org/cvss/v4.0/user-guide CVSS v4 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v4-calculator # The cvss v3 score for the vulnerability. + "attackComplexity": "A String", # Attack Complexity (AC). Defined in CVSS v2, v3, v4. + "attackRequirements": "A String", # Attack Requirements (AT). Defined in CVSS v4. + "attackVector": "A String", # Attack Vector (AV). Defined in CVSS v2, v3, v4. + "authentication": "A String", # Authentication (Au). Defined in CVSS v2. + "availabilityImpact": "A String", # Availability Impact (A). Defined in CVSS v2, v3. "baseScore": 3.14, # The base score is a function of the base metric scores. - "confidentialityImpact": "A String", # Defined in CVSS v3, CVSS v2 + "confidentialityImpact": "A String", # Confidentiality Impact (C). Defined in CVSS v2, v3. "exploitabilityScore": 3.14, "impactScore": 3.14, - "integrityImpact": "A String", # Defined in CVSS v3, CVSS v2 - "privilegesRequired": "A String", # Defined in CVSS v3 - "scope": "A String", # Defined in CVSS v3 - "userInteraction": "A String", # Defined in CVSS v3 + "integrityImpact": "A String", # Integrity Impact (I). Defined in CVSS v2, v3. + "privilegesRequired": "A String", # Privileges Required (PR). Defined in CVSS v3, v4. + "scope": "A String", # Scope (S). Defined in CVSS v3. + "subsequentSystemAvailabilityImpact": "A String", # Subsequent System Availability Impact (SA). Defined in CVSS v4. + "subsequentSystemConfidentialityImpact": "A String", # Subsequent System Confidentiality Impact (SC). Defined in CVSS v4. + "subsequentSystemIntegrityImpact": "A String", # Subsequent System Integrity Impact (SI). Defined in CVSS v4. + "userInteraction": "A String", # User Interaction (UI). Defined in CVSS v3, v4. + "vulnerableSystemAvailabilityImpact": "A String", # Vulnerable System Availability Impact (VA). Defined in CVSS v4. + "vulnerableSystemConfidentialityImpact": "A String", # Vulnerable System Confidentiality Impact (VC). Defined in CVSS v4. + "vulnerableSystemIntegrityImpact": "A String", # Vulnerable System Integrity Impact (VI). Defined in CVSS v4. }, "cvssVersion": "A String", # Output only. CVSS version used to populate cvss_score and severity. "effectiveSeverity": "A String", # The distro assigned severity for this vulnerability when it is available, and note provider assigned severity when distro has not yet assigned a severity for this vulnerability. When there are multiple PackageIssues for this vulnerability, they can have different effective severities because some might be provided by the distro while others are provided by the language ecosystem for a language pack. For this reason, it is advised to use the effective severity on the PackageIssue level. In the case where multiple PackageIssues have differing effective severities, this field should be the highest severity for any of the PackageIssues. @@ -4854,33 +4945,47 @@

Method Details

"updateTime": "A String", # Output only. The time this occurrence was last updated. "vulnerability": { # Details of a vulnerability Occurrence. # Describes a security vulnerability. "cvssScore": 3.14, # Output only. The CVSS score of this vulnerability. CVSS score is on a scale of 0-10 where 0 indicates low severity and 10 indicates high severity. - "cvssV2": { # Common Vulnerability Scoring System. This message is compatible with CVSS v2 and v3. For CVSS v2 details, see https://www.first.org/cvss/v2/guide CVSS v2 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v2-calculator For CVSS v3 details, see https://www.first.org/cvss/specification-document CVSS v3 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v3-calculator # The cvss v2 score for the vulnerability. - "attackComplexity": "A String", # Defined in CVSS v3, CVSS v2 - "attackVector": "A String", # Base Metrics Represents the intrinsic characteristics of a vulnerability that are constant over time and across user environments. Defined in CVSS v3, CVSS v2 - "authentication": "A String", # Defined in CVSS v2 - "availabilityImpact": "A String", # Defined in CVSS v3, CVSS v2 + "cvssV2": { # Common Vulnerability Scoring System. This message is compatible with CVSS v2, v3, and v4. For CVSS v2 details, see https://www.first.org/cvss/v2/guide CVSS v2 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v2-calculator For CVSS v3 details, see https://www.first.org/cvss/specification-document CVSS v3 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v3-calculator For CVSS v4 details, see https://www.first.org/cvss/v4.0/user-guide CVSS v4 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v4-calculator # The cvss v2 score for the vulnerability. + "attackComplexity": "A String", # Attack Complexity (AC). Defined in CVSS v2, v3, v4. + "attackRequirements": "A String", # Attack Requirements (AT). Defined in CVSS v4. + "attackVector": "A String", # Attack Vector (AV). Defined in CVSS v2, v3, v4. + "authentication": "A String", # Authentication (Au). Defined in CVSS v2. + "availabilityImpact": "A String", # Availability Impact (A). Defined in CVSS v2, v3. "baseScore": 3.14, # The base score is a function of the base metric scores. - "confidentialityImpact": "A String", # Defined in CVSS v3, CVSS v2 + "confidentialityImpact": "A String", # Confidentiality Impact (C). Defined in CVSS v2, v3. "exploitabilityScore": 3.14, "impactScore": 3.14, - "integrityImpact": "A String", # Defined in CVSS v3, CVSS v2 - "privilegesRequired": "A String", # Defined in CVSS v3 - "scope": "A String", # Defined in CVSS v3 - "userInteraction": "A String", # Defined in CVSS v3 + "integrityImpact": "A String", # Integrity Impact (I). Defined in CVSS v2, v3. + "privilegesRequired": "A String", # Privileges Required (PR). Defined in CVSS v3, v4. + "scope": "A String", # Scope (S). Defined in CVSS v3. + "subsequentSystemAvailabilityImpact": "A String", # Subsequent System Availability Impact (SA). Defined in CVSS v4. + "subsequentSystemConfidentialityImpact": "A String", # Subsequent System Confidentiality Impact (SC). Defined in CVSS v4. + "subsequentSystemIntegrityImpact": "A String", # Subsequent System Integrity Impact (SI). Defined in CVSS v4. + "userInteraction": "A String", # User Interaction (UI). Defined in CVSS v3, v4. + "vulnerableSystemAvailabilityImpact": "A String", # Vulnerable System Availability Impact (VA). Defined in CVSS v4. + "vulnerableSystemConfidentialityImpact": "A String", # Vulnerable System Confidentiality Impact (VC). Defined in CVSS v4. + "vulnerableSystemIntegrityImpact": "A String", # Vulnerable System Integrity Impact (VI). Defined in CVSS v4. }, - "cvssV3": { # Common Vulnerability Scoring System. This message is compatible with CVSS v2 and v3. For CVSS v2 details, see https://www.first.org/cvss/v2/guide CVSS v2 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v2-calculator For CVSS v3 details, see https://www.first.org/cvss/specification-document CVSS v3 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v3-calculator # The cvss v3 score for the vulnerability. - "attackComplexity": "A String", # Defined in CVSS v3, CVSS v2 - "attackVector": "A String", # Base Metrics Represents the intrinsic characteristics of a vulnerability that are constant over time and across user environments. Defined in CVSS v3, CVSS v2 - "authentication": "A String", # Defined in CVSS v2 - "availabilityImpact": "A String", # Defined in CVSS v3, CVSS v2 + "cvssV3": { # Common Vulnerability Scoring System. This message is compatible with CVSS v2, v3, and v4. For CVSS v2 details, see https://www.first.org/cvss/v2/guide CVSS v2 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v2-calculator For CVSS v3 details, see https://www.first.org/cvss/specification-document CVSS v3 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v3-calculator For CVSS v4 details, see https://www.first.org/cvss/v4.0/user-guide CVSS v4 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v4-calculator # The cvss v3 score for the vulnerability. + "attackComplexity": "A String", # Attack Complexity (AC). Defined in CVSS v2, v3, v4. + "attackRequirements": "A String", # Attack Requirements (AT). Defined in CVSS v4. + "attackVector": "A String", # Attack Vector (AV). Defined in CVSS v2, v3, v4. + "authentication": "A String", # Authentication (Au). Defined in CVSS v2. + "availabilityImpact": "A String", # Availability Impact (A). Defined in CVSS v2, v3. "baseScore": 3.14, # The base score is a function of the base metric scores. - "confidentialityImpact": "A String", # Defined in CVSS v3, CVSS v2 + "confidentialityImpact": "A String", # Confidentiality Impact (C). Defined in CVSS v2, v3. "exploitabilityScore": 3.14, "impactScore": 3.14, - "integrityImpact": "A String", # Defined in CVSS v3, CVSS v2 - "privilegesRequired": "A String", # Defined in CVSS v3 - "scope": "A String", # Defined in CVSS v3 - "userInteraction": "A String", # Defined in CVSS v3 + "integrityImpact": "A String", # Integrity Impact (I). Defined in CVSS v2, v3. + "privilegesRequired": "A String", # Privileges Required (PR). Defined in CVSS v3, v4. + "scope": "A String", # Scope (S). Defined in CVSS v3. + "subsequentSystemAvailabilityImpact": "A String", # Subsequent System Availability Impact (SA). Defined in CVSS v4. + "subsequentSystemConfidentialityImpact": "A String", # Subsequent System Confidentiality Impact (SC). Defined in CVSS v4. + "subsequentSystemIntegrityImpact": "A String", # Subsequent System Integrity Impact (SI). Defined in CVSS v4. + "userInteraction": "A String", # User Interaction (UI). Defined in CVSS v3, v4. + "vulnerableSystemAvailabilityImpact": "A String", # Vulnerable System Availability Impact (VA). Defined in CVSS v4. + "vulnerableSystemConfidentialityImpact": "A String", # Vulnerable System Confidentiality Impact (VC). Defined in CVSS v4. + "vulnerableSystemIntegrityImpact": "A String", # Vulnerable System Integrity Impact (VI). Defined in CVSS v4. }, "cvssVersion": "A String", # Output only. CVSS version used to populate cvss_score and severity. "effectiveSeverity": "A String", # The distro assigned severity for this vulnerability when it is available, and note provider assigned severity when distro has not yet assigned a severity for this vulnerability. When there are multiple PackageIssues for this vulnerability, they can have different effective severities because some might be provided by the distro while others are provided by the language ecosystem for a language pack. For this reason, it is advised to use the effective severity on the PackageIssue level. In the case where multiple PackageIssues have differing effective severities, this field should be the highest severity for any of the PackageIssues. @@ -5478,33 +5583,47 @@

Method Details

"updateTime": "A String", # Output only. The time this occurrence was last updated. "vulnerability": { # Details of a vulnerability Occurrence. # Describes a security vulnerability. "cvssScore": 3.14, # Output only. The CVSS score of this vulnerability. CVSS score is on a scale of 0-10 where 0 indicates low severity and 10 indicates high severity. - "cvssV2": { # Common Vulnerability Scoring System. This message is compatible with CVSS v2 and v3. For CVSS v2 details, see https://www.first.org/cvss/v2/guide CVSS v2 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v2-calculator For CVSS v3 details, see https://www.first.org/cvss/specification-document CVSS v3 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v3-calculator # The cvss v2 score for the vulnerability. - "attackComplexity": "A String", # Defined in CVSS v3, CVSS v2 - "attackVector": "A String", # Base Metrics Represents the intrinsic characteristics of a vulnerability that are constant over time and across user environments. Defined in CVSS v3, CVSS v2 - "authentication": "A String", # Defined in CVSS v2 - "availabilityImpact": "A String", # Defined in CVSS v3, CVSS v2 + "cvssV2": { # Common Vulnerability Scoring System. This message is compatible with CVSS v2, v3, and v4. For CVSS v2 details, see https://www.first.org/cvss/v2/guide CVSS v2 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v2-calculator For CVSS v3 details, see https://www.first.org/cvss/specification-document CVSS v3 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v3-calculator For CVSS v4 details, see https://www.first.org/cvss/v4.0/user-guide CVSS v4 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v4-calculator # The cvss v2 score for the vulnerability. + "attackComplexity": "A String", # Attack Complexity (AC). Defined in CVSS v2, v3, v4. + "attackRequirements": "A String", # Attack Requirements (AT). Defined in CVSS v4. + "attackVector": "A String", # Attack Vector (AV). Defined in CVSS v2, v3, v4. + "authentication": "A String", # Authentication (Au). Defined in CVSS v2. + "availabilityImpact": "A String", # Availability Impact (A). Defined in CVSS v2, v3. "baseScore": 3.14, # The base score is a function of the base metric scores. - "confidentialityImpact": "A String", # Defined in CVSS v3, CVSS v2 + "confidentialityImpact": "A String", # Confidentiality Impact (C). Defined in CVSS v2, v3. "exploitabilityScore": 3.14, "impactScore": 3.14, - "integrityImpact": "A String", # Defined in CVSS v3, CVSS v2 - "privilegesRequired": "A String", # Defined in CVSS v3 - "scope": "A String", # Defined in CVSS v3 - "userInteraction": "A String", # Defined in CVSS v3 + "integrityImpact": "A String", # Integrity Impact (I). Defined in CVSS v2, v3. + "privilegesRequired": "A String", # Privileges Required (PR). Defined in CVSS v3, v4. + "scope": "A String", # Scope (S). Defined in CVSS v3. + "subsequentSystemAvailabilityImpact": "A String", # Subsequent System Availability Impact (SA). Defined in CVSS v4. + "subsequentSystemConfidentialityImpact": "A String", # Subsequent System Confidentiality Impact (SC). Defined in CVSS v4. + "subsequentSystemIntegrityImpact": "A String", # Subsequent System Integrity Impact (SI). Defined in CVSS v4. + "userInteraction": "A String", # User Interaction (UI). Defined in CVSS v3, v4. + "vulnerableSystemAvailabilityImpact": "A String", # Vulnerable System Availability Impact (VA). Defined in CVSS v4. + "vulnerableSystemConfidentialityImpact": "A String", # Vulnerable System Confidentiality Impact (VC). Defined in CVSS v4. + "vulnerableSystemIntegrityImpact": "A String", # Vulnerable System Integrity Impact (VI). Defined in CVSS v4. }, - "cvssV3": { # Common Vulnerability Scoring System. This message is compatible with CVSS v2 and v3. For CVSS v2 details, see https://www.first.org/cvss/v2/guide CVSS v2 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v2-calculator For CVSS v3 details, see https://www.first.org/cvss/specification-document CVSS v3 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v3-calculator # The cvss v3 score for the vulnerability. - "attackComplexity": "A String", # Defined in CVSS v3, CVSS v2 - "attackVector": "A String", # Base Metrics Represents the intrinsic characteristics of a vulnerability that are constant over time and across user environments. Defined in CVSS v3, CVSS v2 - "authentication": "A String", # Defined in CVSS v2 - "availabilityImpact": "A String", # Defined in CVSS v3, CVSS v2 + "cvssV3": { # Common Vulnerability Scoring System. This message is compatible with CVSS v2, v3, and v4. For CVSS v2 details, see https://www.first.org/cvss/v2/guide CVSS v2 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v2-calculator For CVSS v3 details, see https://www.first.org/cvss/specification-document CVSS v3 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v3-calculator For CVSS v4 details, see https://www.first.org/cvss/v4.0/user-guide CVSS v4 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v4-calculator # The cvss v3 score for the vulnerability. + "attackComplexity": "A String", # Attack Complexity (AC). Defined in CVSS v2, v3, v4. + "attackRequirements": "A String", # Attack Requirements (AT). Defined in CVSS v4. + "attackVector": "A String", # Attack Vector (AV). Defined in CVSS v2, v3, v4. + "authentication": "A String", # Authentication (Au). Defined in CVSS v2. + "availabilityImpact": "A String", # Availability Impact (A). Defined in CVSS v2, v3. "baseScore": 3.14, # The base score is a function of the base metric scores. - "confidentialityImpact": "A String", # Defined in CVSS v3, CVSS v2 + "confidentialityImpact": "A String", # Confidentiality Impact (C). Defined in CVSS v2, v3. "exploitabilityScore": 3.14, "impactScore": 3.14, - "integrityImpact": "A String", # Defined in CVSS v3, CVSS v2 - "privilegesRequired": "A String", # Defined in CVSS v3 - "scope": "A String", # Defined in CVSS v3 - "userInteraction": "A String", # Defined in CVSS v3 + "integrityImpact": "A String", # Integrity Impact (I). Defined in CVSS v2, v3. + "privilegesRequired": "A String", # Privileges Required (PR). Defined in CVSS v3, v4. + "scope": "A String", # Scope (S). Defined in CVSS v3. + "subsequentSystemAvailabilityImpact": "A String", # Subsequent System Availability Impact (SA). Defined in CVSS v4. + "subsequentSystemConfidentialityImpact": "A String", # Subsequent System Confidentiality Impact (SC). Defined in CVSS v4. + "subsequentSystemIntegrityImpact": "A String", # Subsequent System Integrity Impact (SI). Defined in CVSS v4. + "userInteraction": "A String", # User Interaction (UI). Defined in CVSS v3, v4. + "vulnerableSystemAvailabilityImpact": "A String", # Vulnerable System Availability Impact (VA). Defined in CVSS v4. + "vulnerableSystemConfidentialityImpact": "A String", # Vulnerable System Confidentiality Impact (VC). Defined in CVSS v4. + "vulnerableSystemIntegrityImpact": "A String", # Vulnerable System Integrity Impact (VI). Defined in CVSS v4. }, "cvssVersion": "A String", # Output only. CVSS version used to populate cvss_score and severity. "effectiveSeverity": "A String", # The distro assigned severity for this vulnerability when it is available, and note provider assigned severity when distro has not yet assigned a severity for this vulnerability. When there are multiple PackageIssues for this vulnerability, they can have different effective severities because some might be provided by the distro while others are provided by the language ecosystem for a language pack. For this reason, it is advised to use the effective severity on the PackageIssue level. In the case where multiple PackageIssues have differing effective severities, this field should be the highest severity for any of the PackageIssues. diff --git a/docs/dyn/dataform_v1.projects.locations.folders.html b/docs/dyn/dataform_v1.projects.locations.folders.html index fde514afb3..3fb464aae5 100644 --- a/docs/dyn/dataform_v1.projects.locations.folders.html +++ b/docs/dyn/dataform_v1.projects.locations.folders.html @@ -400,7 +400,8 @@

Method Details

"displayName": "A String", # Optional. The repository's user-friendly name. "gitRemoteSettings": { # Controls Git remote configuration for a repository. # Optional. If set, configures this repository to be linked to a Git remote. "authenticationTokenSecretVersion": "A String", # Optional. The name of the Secret Manager secret version to use as an authentication token for Git operations. Must be in the format `projects/*/secrets/*/versions/*`. - "defaultBranch": "A String", # Required. The Git remote's default branch name. If not set, `main` will be used and stored for the repository. + "defaultBranch": "A String", # Optional. The Git remote's default branch name. If not set `main` will be used. + "effectiveDefaultBranch": "A String", # Output only. The Git remote's effective default branch name. This is the default branch name of the Git remote if it is set, otherwise it is `main`. "sshAuthenticationConfig": { # Configures fields for performing SSH authentication. # Optional. Authentication fields for remote uris using SSH protocol. "hostPublicKey": "A String", # Required. Content of a public SSH key to verify an identity of a remote Git host. "userPrivateKeySecretVersion": "A String", # Required. The name of the Secret Manager secret version to use as a ssh private key for Git operations. Must be in the format `projects/*/secrets/*/versions/*`. diff --git a/docs/dyn/dataform_v1.projects.locations.html b/docs/dyn/dataform_v1.projects.locations.html index cf87052997..614f434c17 100644 --- a/docs/dyn/dataform_v1.projects.locations.html +++ b/docs/dyn/dataform_v1.projects.locations.html @@ -262,7 +262,8 @@

Method Details

"displayName": "A String", # Optional. The repository's user-friendly name. "gitRemoteSettings": { # Controls Git remote configuration for a repository. # Optional. If set, configures this repository to be linked to a Git remote. "authenticationTokenSecretVersion": "A String", # Optional. The name of the Secret Manager secret version to use as an authentication token for Git operations. Must be in the format `projects/*/secrets/*/versions/*`. - "defaultBranch": "A String", # Required. The Git remote's default branch name. If not set, `main` will be used and stored for the repository. + "defaultBranch": "A String", # Optional. The Git remote's default branch name. If not set `main` will be used. + "effectiveDefaultBranch": "A String", # Output only. The Git remote's effective default branch name. This is the default branch name of the Git remote if it is set, otherwise it is `main`. "sshAuthenticationConfig": { # Configures fields for performing SSH authentication. # Optional. Authentication fields for remote uris using SSH protocol. "hostPublicKey": "A String", # Required. Content of a public SSH key to verify an identity of a remote Git host. "userPrivateKeySecretVersion": "A String", # Required. The name of the Secret Manager secret version to use as a ssh private key for Git operations. Must be in the format `projects/*/secrets/*/versions/*`. diff --git a/docs/dyn/dataform_v1.projects.locations.repositories.html b/docs/dyn/dataform_v1.projects.locations.repositories.html index 6f73a82a0a..6a40fe7dd0 100644 --- a/docs/dyn/dataform_v1.projects.locations.repositories.html +++ b/docs/dyn/dataform_v1.projects.locations.repositories.html @@ -241,7 +241,8 @@

Method Details

"displayName": "A String", # Optional. The repository's user-friendly name. "gitRemoteSettings": { # Controls Git remote configuration for a repository. # Optional. If set, configures this repository to be linked to a Git remote. "authenticationTokenSecretVersion": "A String", # Optional. The name of the Secret Manager secret version to use as an authentication token for Git operations. Must be in the format `projects/*/secrets/*/versions/*`. - "defaultBranch": "A String", # Required. The Git remote's default branch name. If not set, `main` will be used and stored for the repository. + "defaultBranch": "A String", # Optional. The Git remote's default branch name. If not set `main` will be used. + "effectiveDefaultBranch": "A String", # Output only. The Git remote's effective default branch name. This is the default branch name of the Git remote if it is set, otherwise it is `main`. "sshAuthenticationConfig": { # Configures fields for performing SSH authentication. # Optional. Authentication fields for remote uris using SSH protocol. "hostPublicKey": "A String", # Required. Content of a public SSH key to verify an identity of a remote Git host. "userPrivateKeySecretVersion": "A String", # Required. The name of the Secret Manager secret version to use as a ssh private key for Git operations. Must be in the format `projects/*/secrets/*/versions/*`. @@ -284,7 +285,8 @@

Method Details

"displayName": "A String", # Optional. The repository's user-friendly name. "gitRemoteSettings": { # Controls Git remote configuration for a repository. # Optional. If set, configures this repository to be linked to a Git remote. "authenticationTokenSecretVersion": "A String", # Optional. The name of the Secret Manager secret version to use as an authentication token for Git operations. Must be in the format `projects/*/secrets/*/versions/*`. - "defaultBranch": "A String", # Required. The Git remote's default branch name. If not set, `main` will be used and stored for the repository. + "defaultBranch": "A String", # Optional. The Git remote's default branch name. If not set `main` will be used. + "effectiveDefaultBranch": "A String", # Output only. The Git remote's effective default branch name. This is the default branch name of the Git remote if it is set, otherwise it is `main`. "sshAuthenticationConfig": { # Configures fields for performing SSH authentication. # Optional. Authentication fields for remote uris using SSH protocol. "hostPublicKey": "A String", # Required. Content of a public SSH key to verify an identity of a remote Git host. "userPrivateKeySecretVersion": "A String", # Required. The name of the Secret Manager secret version to use as a ssh private key for Git operations. Must be in the format `projects/*/secrets/*/versions/*`. @@ -419,7 +421,8 @@

Method Details

"displayName": "A String", # Optional. The repository's user-friendly name. "gitRemoteSettings": { # Controls Git remote configuration for a repository. # Optional. If set, configures this repository to be linked to a Git remote. "authenticationTokenSecretVersion": "A String", # Optional. The name of the Secret Manager secret version to use as an authentication token for Git operations. Must be in the format `projects/*/secrets/*/versions/*`. - "defaultBranch": "A String", # Required. The Git remote's default branch name. If not set, `main` will be used and stored for the repository. + "defaultBranch": "A String", # Optional. The Git remote's default branch name. If not set `main` will be used. + "effectiveDefaultBranch": "A String", # Output only. The Git remote's effective default branch name. This is the default branch name of the Git remote if it is set, otherwise it is `main`. "sshAuthenticationConfig": { # Configures fields for performing SSH authentication. # Optional. Authentication fields for remote uris using SSH protocol. "hostPublicKey": "A String", # Required. Content of a public SSH key to verify an identity of a remote Git host. "userPrivateKeySecretVersion": "A String", # Required. The name of the Secret Manager secret version to use as a ssh private key for Git operations. Must be in the format `projects/*/secrets/*/versions/*`. @@ -510,7 +513,8 @@

Method Details

"displayName": "A String", # Optional. The repository's user-friendly name. "gitRemoteSettings": { # Controls Git remote configuration for a repository. # Optional. If set, configures this repository to be linked to a Git remote. "authenticationTokenSecretVersion": "A String", # Optional. The name of the Secret Manager secret version to use as an authentication token for Git operations. Must be in the format `projects/*/secrets/*/versions/*`. - "defaultBranch": "A String", # Required. The Git remote's default branch name. If not set, `main` will be used and stored for the repository. + "defaultBranch": "A String", # Optional. The Git remote's default branch name. If not set `main` will be used. + "effectiveDefaultBranch": "A String", # Output only. The Git remote's effective default branch name. This is the default branch name of the Git remote if it is set, otherwise it is `main`. "sshAuthenticationConfig": { # Configures fields for performing SSH authentication. # Optional. Authentication fields for remote uris using SSH protocol. "hostPublicKey": "A String", # Required. Content of a public SSH key to verify an identity of a remote Git host. "userPrivateKeySecretVersion": "A String", # Required. The name of the Secret Manager secret version to use as a ssh private key for Git operations. Must be in the format `projects/*/secrets/*/versions/*`. @@ -615,7 +619,8 @@

Method Details

"displayName": "A String", # Optional. The repository's user-friendly name. "gitRemoteSettings": { # Controls Git remote configuration for a repository. # Optional. If set, configures this repository to be linked to a Git remote. "authenticationTokenSecretVersion": "A String", # Optional. The name of the Secret Manager secret version to use as an authentication token for Git operations. Must be in the format `projects/*/secrets/*/versions/*`. - "defaultBranch": "A String", # Required. The Git remote's default branch name. If not set, `main` will be used and stored for the repository. + "defaultBranch": "A String", # Optional. The Git remote's default branch name. If not set `main` will be used. + "effectiveDefaultBranch": "A String", # Output only. The Git remote's effective default branch name. This is the default branch name of the Git remote if it is set, otherwise it is `main`. "sshAuthenticationConfig": { # Configures fields for performing SSH authentication. # Optional. Authentication fields for remote uris using SSH protocol. "hostPublicKey": "A String", # Required. Content of a public SSH key to verify an identity of a remote Git host. "userPrivateKeySecretVersion": "A String", # Required. The name of the Secret Manager secret version to use as a ssh private key for Git operations. Must be in the format `projects/*/secrets/*/versions/*`. @@ -658,7 +663,8 @@

Method Details

"displayName": "A String", # Optional. The repository's user-friendly name. "gitRemoteSettings": { # Controls Git remote configuration for a repository. # Optional. If set, configures this repository to be linked to a Git remote. "authenticationTokenSecretVersion": "A String", # Optional. The name of the Secret Manager secret version to use as an authentication token for Git operations. Must be in the format `projects/*/secrets/*/versions/*`. - "defaultBranch": "A String", # Required. The Git remote's default branch name. If not set, `main` will be used and stored for the repository. + "defaultBranch": "A String", # Optional. The Git remote's default branch name. If not set `main` will be used. + "effectiveDefaultBranch": "A String", # Output only. The Git remote's effective default branch name. This is the default branch name of the Git remote if it is set, otherwise it is `main`. "sshAuthenticationConfig": { # Configures fields for performing SSH authentication. # Optional. Authentication fields for remote uris using SSH protocol. "hostPublicKey": "A String", # Required. Content of a public SSH key to verify an identity of a remote Git host. "userPrivateKeySecretVersion": "A String", # Required. The name of the Secret Manager secret version to use as a ssh private key for Git operations. Must be in the format `projects/*/secrets/*/versions/*`. @@ -705,8 +711,8 @@

Method Details

{ # `QueryRepositoryDirectoryContents` response message. "directoryEntries": [ # List of entries in the directory. { # Represents a single entry in a directory. - "directory": "A String", # A child directory in the directory. - "file": "A String", # A file in the directory. + "directory": "A String", # A child directory in the directory. The path is returned including the full folder structure from the root. + "file": "A String", # A file in the directory. The path is returned including the full folder structure from the root. "metadata": { # Represents metadata for a single entry in a filesystem. # Entry with metadata. "sizeBytes": "A String", # Output only. Provides the size of the entry in bytes. For directories, this will be 0. "updateTime": "A String", # Output only. Represents the time of the last modification of the entry. diff --git a/docs/dyn/dataform_v1.projects.locations.repositories.workspaces.html b/docs/dyn/dataform_v1.projects.locations.repositories.workspaces.html index b8dcbd64d2..823a8ccb68 100644 --- a/docs/dyn/dataform_v1.projects.locations.repositories.workspaces.html +++ b/docs/dyn/dataform_v1.projects.locations.repositories.workspaces.html @@ -621,8 +621,8 @@

Method Details

{ # `QueryDirectoryContents` response message. "directoryEntries": [ # List of entries in the directory. { # Represents a single entry in a directory. - "directory": "A String", # A child directory in the directory. - "file": "A String", # A file in the directory. + "directory": "A String", # A child directory in the directory. The path is returned including the full folder structure from the root. + "file": "A String", # A file in the directory. The path is returned including the full folder structure from the root. "metadata": { # Represents metadata for a single entry in a filesystem. # Entry with metadata. "sizeBytes": "A String", # Output only. Provides the size of the entry in bytes. For directories, this will be 0. "updateTime": "A String", # Output only. Represents the time of the last modification of the entry. diff --git a/docs/dyn/dataform_v1.projects.locations.teamFolders.html b/docs/dyn/dataform_v1.projects.locations.teamFolders.html index 8d388c465a..932905ce72 100644 --- a/docs/dyn/dataform_v1.projects.locations.teamFolders.html +++ b/docs/dyn/dataform_v1.projects.locations.teamFolders.html @@ -351,7 +351,8 @@

Method Details

"displayName": "A String", # Optional. The repository's user-friendly name. "gitRemoteSettings": { # Controls Git remote configuration for a repository. # Optional. If set, configures this repository to be linked to a Git remote. "authenticationTokenSecretVersion": "A String", # Optional. The name of the Secret Manager secret version to use as an authentication token for Git operations. Must be in the format `projects/*/secrets/*/versions/*`. - "defaultBranch": "A String", # Required. The Git remote's default branch name. If not set, `main` will be used and stored for the repository. + "defaultBranch": "A String", # Optional. The Git remote's default branch name. If not set `main` will be used. + "effectiveDefaultBranch": "A String", # Output only. The Git remote's effective default branch name. This is the default branch name of the Git remote if it is set, otherwise it is `main`. "sshAuthenticationConfig": { # Configures fields for performing SSH authentication. # Optional. Authentication fields for remote uris using SSH protocol. "hostPublicKey": "A String", # Required. Content of a public SSH key to verify an identity of a remote Git host. "userPrivateKeySecretVersion": "A String", # Required. The name of the Secret Manager secret version to use as a ssh private key for Git operations. Must be in the format `projects/*/secrets/*/versions/*`. @@ -403,7 +404,7 @@

Method Details

location: string, Required. Location in which to query TeamFolders. Format: `projects/*/locations/*`. (required) filter: string, Optional. Optional filtering for the returned list. Filtering is currently only supported on the `display_name` field. Example: * `filter="display_name="MyFolder""` orderBy: string, Optional. Field to additionally sort results by. Supported keywords: `display_name` (default), `create_time`, `last_modified_time`. Examples: * `orderBy="display_name"` * `orderBy="display_name desc"` - pageSize: integer, Optional. Maximum number of TeamFolders to return. The server may return fewer items than requested. If unspecified, the server will pick an appropriate default. + pageSize: integer, Optional. Maximum number of TeamFolders to return. The server may return fewer items than requested. If unspecified, the server will pick a default of page_size = 50. pageToken: string, Optional. Page token received from a previous `SearchTeamFolders` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `SearchTeamFolders`, with the exception of `page_size`, must match the call that provided the page token. x__xgafv: string, V1 error format. Allowed values diff --git a/docs/dyn/dataform_v1beta1.projects.locations.folders.html b/docs/dyn/dataform_v1beta1.projects.locations.folders.html index 1bf6634f0c..b4a47a61c3 100644 --- a/docs/dyn/dataform_v1beta1.projects.locations.folders.html +++ b/docs/dyn/dataform_v1beta1.projects.locations.folders.html @@ -401,7 +401,8 @@

Method Details

"displayName": "A String", # Optional. The repository's user-friendly name. "gitRemoteSettings": { # Controls Git remote configuration for a repository. # Optional. If set, configures this repository to be linked to a Git remote. "authenticationTokenSecretVersion": "A String", # Optional. The name of the Secret Manager secret version to use as an authentication token for Git operations. Must be in the format `projects/*/secrets/*/versions/*`. - "defaultBranch": "A String", # Required. The Git remote's default branch name. If not set, `main` will be used and stored for the repository. + "defaultBranch": "A String", # Optional. The Git remote's default branch name. If not set `main` will be used. + "effectiveDefaultBranch": "A String", # Output only. The Git remote's effective default branch name. This is the default branch name of the Git remote if it is set, otherwise it is `main`. "sshAuthenticationConfig": { # Configures fields for performing SSH authentication. # Optional. Authentication fields for remote uris using SSH protocol. "hostPublicKey": "A String", # Required. Content of a public SSH key to verify an identity of a remote Git host. "userPrivateKeySecretVersion": "A String", # Required. The name of the Secret Manager secret version to use as a ssh private key for Git operations. Must be in the format `projects/*/secrets/*/versions/*`. diff --git a/docs/dyn/dataform_v1beta1.projects.locations.html b/docs/dyn/dataform_v1beta1.projects.locations.html index a1ae6fd098..a647498163 100644 --- a/docs/dyn/dataform_v1beta1.projects.locations.html +++ b/docs/dyn/dataform_v1beta1.projects.locations.html @@ -262,7 +262,8 @@

Method Details

"displayName": "A String", # Optional. The repository's user-friendly name. "gitRemoteSettings": { # Controls Git remote configuration for a repository. # Optional. If set, configures this repository to be linked to a Git remote. "authenticationTokenSecretVersion": "A String", # Optional. The name of the Secret Manager secret version to use as an authentication token for Git operations. Must be in the format `projects/*/secrets/*/versions/*`. - "defaultBranch": "A String", # Required. The Git remote's default branch name. If not set, `main` will be used and stored for the repository. + "defaultBranch": "A String", # Optional. The Git remote's default branch name. If not set `main` will be used. + "effectiveDefaultBranch": "A String", # Output only. The Git remote's effective default branch name. This is the default branch name of the Git remote if it is set, otherwise it is `main`. "sshAuthenticationConfig": { # Configures fields for performing SSH authentication. # Optional. Authentication fields for remote uris using SSH protocol. "hostPublicKey": "A String", # Required. Content of a public SSH key to verify an identity of a remote Git host. "userPrivateKeySecretVersion": "A String", # Required. The name of the Secret Manager secret version to use as a ssh private key for Git operations. Must be in the format `projects/*/secrets/*/versions/*`. diff --git a/docs/dyn/dataform_v1beta1.projects.locations.repositories.html b/docs/dyn/dataform_v1beta1.projects.locations.repositories.html index 287c834e77..ab4fccbdbb 100644 --- a/docs/dyn/dataform_v1beta1.projects.locations.repositories.html +++ b/docs/dyn/dataform_v1beta1.projects.locations.repositories.html @@ -114,6 +114,9 @@

Instance Methods

delete(name, force=None, x__xgafv=None)

Deletes a single Repository.

+

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

+

Deletes a single Repository asynchronously.

fetchHistory(name, pageSize=None, pageToken=None, x__xgafv=None)

Fetches a Repository's history of commits. The Repository must not have a value for `git_remote_settings.url`.

@@ -241,7 +244,8 @@

Method Details

"displayName": "A String", # Optional. The repository's user-friendly name. "gitRemoteSettings": { # Controls Git remote configuration for a repository. # Optional. If set, configures this repository to be linked to a Git remote. "authenticationTokenSecretVersion": "A String", # Optional. The name of the Secret Manager secret version to use as an authentication token for Git operations. Must be in the format `projects/*/secrets/*/versions/*`. - "defaultBranch": "A String", # Required. The Git remote's default branch name. If not set, `main` will be used and stored for the repository. + "defaultBranch": "A String", # Optional. The Git remote's default branch name. If not set `main` will be used. + "effectiveDefaultBranch": "A String", # Output only. The Git remote's effective default branch name. This is the default branch name of the Git remote if it is set, otherwise it is `main`. "sshAuthenticationConfig": { # Configures fields for performing SSH authentication. # Optional. Authentication fields for remote uris using SSH protocol. "hostPublicKey": "A String", # Required. Content of a public SSH key to verify an identity of a remote Git host. "userPrivateKeySecretVersion": "A String", # Required. The name of the Secret Manager secret version to use as a ssh private key for Git operations. Must be in the format `projects/*/secrets/*/versions/*`. @@ -284,7 +288,8 @@

Method Details

"displayName": "A String", # Optional. The repository's user-friendly name. "gitRemoteSettings": { # Controls Git remote configuration for a repository. # Optional. If set, configures this repository to be linked to a Git remote. "authenticationTokenSecretVersion": "A String", # Optional. The name of the Secret Manager secret version to use as an authentication token for Git operations. Must be in the format `projects/*/secrets/*/versions/*`. - "defaultBranch": "A String", # Required. The Git remote's default branch name. If not set, `main` will be used and stored for the repository. + "defaultBranch": "A String", # Optional. The Git remote's default branch name. If not set `main` will be used. + "effectiveDefaultBranch": "A String", # Output only. The Git remote's effective default branch name. This is the default branch name of the Git remote if it is set, otherwise it is `main`. "sshAuthenticationConfig": { # Configures fields for performing SSH authentication. # Optional. Authentication fields for remote uris using SSH protocol. "hostPublicKey": "A String", # Required. Content of a public SSH key to verify an identity of a remote Git host. "userPrivateKeySecretVersion": "A String", # Required. The name of the Secret Manager secret version to use as a ssh private key for Git operations. Must be in the format `projects/*/secrets/*/versions/*`. @@ -329,6 +334,48 @@

Method Details

}
+
+ deleteLongRunning(name, body=None, x__xgafv=None) +
Deletes a single Repository asynchronously.
+
+Args:
+  name: string, Required. The repository's name. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # `DeleteRepositoryLongRunning` request message.
+  "force": True or False, # Optional. If set to true, child resources of this repository (compilation results and workflow invocations) will also be deleted. Otherwise, the request will only succeed if the repository has no child resources. **Note:** *This flag doesn't support deletion of workspaces, release configs or workflow configs. If any of such resources exists in the repository, the request will fail.*
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # 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.
+  },
+}
+
+
fetchHistory(name, pageSize=None, pageToken=None, x__xgafv=None)
Fetches a Repository's history of commits. The Repository must not have a value for `git_remote_settings.url`.
@@ -419,7 +466,8 @@ 

Method Details

"displayName": "A String", # Optional. The repository's user-friendly name. "gitRemoteSettings": { # Controls Git remote configuration for a repository. # Optional. If set, configures this repository to be linked to a Git remote. "authenticationTokenSecretVersion": "A String", # Optional. The name of the Secret Manager secret version to use as an authentication token for Git operations. Must be in the format `projects/*/secrets/*/versions/*`. - "defaultBranch": "A String", # Required. The Git remote's default branch name. If not set, `main` will be used and stored for the repository. + "defaultBranch": "A String", # Optional. The Git remote's default branch name. If not set `main` will be used. + "effectiveDefaultBranch": "A String", # Output only. The Git remote's effective default branch name. This is the default branch name of the Git remote if it is set, otherwise it is `main`. "sshAuthenticationConfig": { # Configures fields for performing SSH authentication. # Optional. Authentication fields for remote uris using SSH protocol. "hostPublicKey": "A String", # Required. Content of a public SSH key to verify an identity of a remote Git host. "userPrivateKeySecretVersion": "A String", # Required. The name of the Secret Manager secret version to use as a ssh private key for Git operations. Must be in the format `projects/*/secrets/*/versions/*`. @@ -510,7 +558,8 @@

Method Details

"displayName": "A String", # Optional. The repository's user-friendly name. "gitRemoteSettings": { # Controls Git remote configuration for a repository. # Optional. If set, configures this repository to be linked to a Git remote. "authenticationTokenSecretVersion": "A String", # Optional. The name of the Secret Manager secret version to use as an authentication token for Git operations. Must be in the format `projects/*/secrets/*/versions/*`. - "defaultBranch": "A String", # Required. The Git remote's default branch name. If not set, `main` will be used and stored for the repository. + "defaultBranch": "A String", # Optional. The Git remote's default branch name. If not set `main` will be used. + "effectiveDefaultBranch": "A String", # Output only. The Git remote's effective default branch name. This is the default branch name of the Git remote if it is set, otherwise it is `main`. "sshAuthenticationConfig": { # Configures fields for performing SSH authentication. # Optional. Authentication fields for remote uris using SSH protocol. "hostPublicKey": "A String", # Required. Content of a public SSH key to verify an identity of a remote Git host. "userPrivateKeySecretVersion": "A String", # Required. The name of the Secret Manager secret version to use as a ssh private key for Git operations. Must be in the format `projects/*/secrets/*/versions/*`. @@ -615,7 +664,8 @@

Method Details

"displayName": "A String", # Optional. The repository's user-friendly name. "gitRemoteSettings": { # Controls Git remote configuration for a repository. # Optional. If set, configures this repository to be linked to a Git remote. "authenticationTokenSecretVersion": "A String", # Optional. The name of the Secret Manager secret version to use as an authentication token for Git operations. Must be in the format `projects/*/secrets/*/versions/*`. - "defaultBranch": "A String", # Required. The Git remote's default branch name. If not set, `main` will be used and stored for the repository. + "defaultBranch": "A String", # Optional. The Git remote's default branch name. If not set `main` will be used. + "effectiveDefaultBranch": "A String", # Output only. The Git remote's effective default branch name. This is the default branch name of the Git remote if it is set, otherwise it is `main`. "sshAuthenticationConfig": { # Configures fields for performing SSH authentication. # Optional. Authentication fields for remote uris using SSH protocol. "hostPublicKey": "A String", # Required. Content of a public SSH key to verify an identity of a remote Git host. "userPrivateKeySecretVersion": "A String", # Required. The name of the Secret Manager secret version to use as a ssh private key for Git operations. Must be in the format `projects/*/secrets/*/versions/*`. @@ -658,7 +708,8 @@

Method Details

"displayName": "A String", # Optional. The repository's user-friendly name. "gitRemoteSettings": { # Controls Git remote configuration for a repository. # Optional. If set, configures this repository to be linked to a Git remote. "authenticationTokenSecretVersion": "A String", # Optional. The name of the Secret Manager secret version to use as an authentication token for Git operations. Must be in the format `projects/*/secrets/*/versions/*`. - "defaultBranch": "A String", # Required. The Git remote's default branch name. If not set, `main` will be used and stored for the repository. + "defaultBranch": "A String", # Optional. The Git remote's default branch name. If not set `main` will be used. + "effectiveDefaultBranch": "A String", # Output only. The Git remote's effective default branch name. This is the default branch name of the Git remote if it is set, otherwise it is `main`. "sshAuthenticationConfig": { # Configures fields for performing SSH authentication. # Optional. Authentication fields for remote uris using SSH protocol. "hostPublicKey": "A String", # Required. Content of a public SSH key to verify an identity of a remote Git host. "userPrivateKeySecretVersion": "A String", # Required. The name of the Secret Manager secret version to use as a ssh private key for Git operations. Must be in the format `projects/*/secrets/*/versions/*`. @@ -705,8 +756,8 @@

Method Details

{ # `QueryRepositoryDirectoryContents` response message. "directoryEntries": [ # List of entries in the directory. { # Represents a single entry in a directory. - "directory": "A String", # A child directory in the directory. - "file": "A String", # A file in the directory. + "directory": "A String", # A child directory in the directory. The path is returned including the full folder structure from the root. + "file": "A String", # A file in the directory. The path is returned including the full folder structure from the root. "metadata": { # Represents metadata for a single entry in a filesystem. # Entry with metadata. "sizeBytes": "A String", # Output only. Provides the size of the entry in bytes. For directories, this will be 0. "updateTime": "A String", # Output only. Represents the time of the last modification of the entry. diff --git a/docs/dyn/dataform_v1beta1.projects.locations.repositories.workspaces.html b/docs/dyn/dataform_v1beta1.projects.locations.repositories.workspaces.html index fc40fd8956..75ca5ac304 100644 --- a/docs/dyn/dataform_v1beta1.projects.locations.repositories.workspaces.html +++ b/docs/dyn/dataform_v1beta1.projects.locations.repositories.workspaces.html @@ -621,8 +621,8 @@

Method Details

{ # `QueryDirectoryContents` response message. "directoryEntries": [ # List of entries in the directory. { # Represents a single entry in a directory. - "directory": "A String", # A child directory in the directory. - "file": "A String", # A file in the directory. + "directory": "A String", # A child directory in the directory. The path is returned including the full folder structure from the root. + "file": "A String", # A file in the directory. The path is returned including the full folder structure from the root. "metadata": { # Represents metadata for a single entry in a filesystem. # Entry with metadata. "sizeBytes": "A String", # Output only. Provides the size of the entry in bytes. For directories, this will be 0. "updateTime": "A String", # Output only. Represents the time of the last modification of the entry. diff --git a/docs/dyn/dataform_v1beta1.projects.locations.teamFolders.html b/docs/dyn/dataform_v1beta1.projects.locations.teamFolders.html index 899c63a353..2aabfb1854 100644 --- a/docs/dyn/dataform_v1beta1.projects.locations.teamFolders.html +++ b/docs/dyn/dataform_v1beta1.projects.locations.teamFolders.html @@ -352,7 +352,8 @@

Method Details

"displayName": "A String", # Optional. The repository's user-friendly name. "gitRemoteSettings": { # Controls Git remote configuration for a repository. # Optional. If set, configures this repository to be linked to a Git remote. "authenticationTokenSecretVersion": "A String", # Optional. The name of the Secret Manager secret version to use as an authentication token for Git operations. Must be in the format `projects/*/secrets/*/versions/*`. - "defaultBranch": "A String", # Required. The Git remote's default branch name. If not set, `main` will be used and stored for the repository. + "defaultBranch": "A String", # Optional. The Git remote's default branch name. If not set `main` will be used. + "effectiveDefaultBranch": "A String", # Output only. The Git remote's effective default branch name. This is the default branch name of the Git remote if it is set, otherwise it is `main`. "sshAuthenticationConfig": { # Configures fields for performing SSH authentication. # Optional. Authentication fields for remote uris using SSH protocol. "hostPublicKey": "A String", # Required. Content of a public SSH key to verify an identity of a remote Git host. "userPrivateKeySecretVersion": "A String", # Required. The name of the Secret Manager secret version to use as a ssh private key for Git operations. Must be in the format `projects/*/secrets/*/versions/*`. @@ -404,7 +405,7 @@

Method Details

location: string, Required. Location in which to query TeamFolders. Format: `projects/*/locations/*`. (required) filter: string, Optional. Optional filtering for the returned list. Filtering is currently only supported on the `display_name` field. Example: * `filter="display_name="MyFolder""` orderBy: string, Optional. Field to additionally sort results by. Supported keywords: `display_name` (default), `create_time`, `last_modified_time`. Examples: * `orderBy="display_name"` * `orderBy="display_name desc"` - pageSize: integer, Optional. Maximum number of TeamFolders to return. The server may return fewer items than requested. If unspecified, the server will pick an appropriate default. + pageSize: integer, Optional. Maximum number of TeamFolders to return. The server may return fewer items than requested. If unspecified, the server will pick a default of page_size = 50. pageToken: string, Optional. Page token received from a previous `SearchTeamFolders` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `SearchTeamFolders`, with the exception of `page_size`, must match the call that provided the page token. x__xgafv: string, V1 error format. Allowed values diff --git a/docs/dyn/datalineage_v1.projects.locations.html b/docs/dyn/datalineage_v1.projects.locations.html index 5c174c7189..ea1f563034 100644 --- a/docs/dyn/datalineage_v1.projects.locations.html +++ b/docs/dyn/datalineage_v1.projects.locations.html @@ -223,7 +223,7 @@

Method Details

"maxProcessPerLink": 42, # Optional. The maximum number of processes to return per link. The default value is 0 and the maximum value is 100. If this value is non-zero, the response will contain process names for the links. To retrieve full process details in the response, include `links.processes.process` in the [FieldMask](https://developers.google.com/workspace/docs/api/how-tos/field-masks#read_with_a_field_mask). "maxResults": 42, # Optional. The maximum number of links to return in the response. The default value is 1_000 and the maximum value is 10_000. }, - "locations": [ # Required. The locations to search in. + "locations": [ # Required. The locations to search in. This list should contain the location from the `parent` field. "A String", ], "rootCriteria": { # Criteria for the root of the search. # Required. Criteria for the root of the search. diff --git a/docs/dyn/datamanager_v1.audienceMembers.html b/docs/dyn/datamanager_v1.audienceMembers.html index bf38e52c4c..2d058dae5a 100644 --- a/docs/dyn/datamanager_v1.audienceMembers.html +++ b/docs/dyn/datamanager_v1.audienceMembers.html @@ -100,6 +100,29 @@

Method Details

{ # Request to upload audience members to the provided destinations. Returns an IngestAudienceMembersResponse. "audienceMembers": [ # Required. The list of users to send to the specified destinations. At most 10000 AudienceMember resources can be sent in a single request. { # The audience member to be operated on. + "compositeData": { # Composite data holding identifiers and associated data for a user. At least one of `user_data` or `ip_data` is required. # Group of multiple identifier types. + "ipData": [ # Optional. IP address data representing customer interaction used to build the audience. + { # IP address information for a user. We recommend including observe_start_time and observe_end_time to help improve Customer Match match rates. + "ipAddress": "A String", # Required. IP address captured at the time of customer interaction. Accepts standard string formats for both IPv4 and IPv6. + "observeEndTime": "A String", # Optional. Last recorded interaction time from this IP address in a session. + "observeStartTime": "A String", # Optional. First recorded interaction time from this IP address in a session. + }, + ], + "userData": { # Data that identifies the user. At least one identifier is required. # Optional. User-provided data that identifies the user. + "userIdentifiers": [ # Required. The identifiers for the user. It's possible to provide multiple instances of the same type of data (for example, multiple email addresses). To increase the likelihood of a match, provide as many identifiers as possible. At most 10 `userIdentifiers` can be provided in a single AudienceMember or Event. + { # A single identifier for the user. + "address": { # Address information for the user. # The known components of a user's address. Holds a grouping of identifiers that are matched all at once. + "familyName": "A String", # Required. Family (last) name of the user, all lowercase, with no punctuation, no leading or trailing whitespace, and hashed as SHA-256. + "givenName": "A String", # Required. Given (first) name of the user, all lowercase, with no punctuation, no leading or trailing whitespace, and hashed as SHA-256. + "postalCode": "A String", # Required. The postal code of the user's address. + "regionCode": "A String", # Required. The 2-letter region code in ISO-3166-1 alpha-2 of the user's address. + }, + "emailAddress": "A String", # Hashed email address using SHA-256 hash function after normalization. + "phoneNumber": "A String", # Hashed phone number using SHA-256 hash function after normalization (E164 standard). + }, + ], + }, + }, "consent": { # [Digital Markets Act (DMA)](//digital-markets-act.ec.europa.eu/index_en) consent settings for the user. # Optional. The consent setting for the user. "adPersonalization": "A String", # Optional. Represents if the user consents to ad personalization. "adUserData": "A String", # Optional. Represents if the user consents to ad user data. @@ -211,6 +234,29 @@

Method Details

{ # Request to remove users from an audience in the provided destinations. Returns a RemoveAudienceMembersResponse. "audienceMembers": [ # Required. The list of users to remove. { # The audience member to be operated on. + "compositeData": { # Composite data holding identifiers and associated data for a user. At least one of `user_data` or `ip_data` is required. # Group of multiple identifier types. + "ipData": [ # Optional. IP address data representing customer interaction used to build the audience. + { # IP address information for a user. We recommend including observe_start_time and observe_end_time to help improve Customer Match match rates. + "ipAddress": "A String", # Required. IP address captured at the time of customer interaction. Accepts standard string formats for both IPv4 and IPv6. + "observeEndTime": "A String", # Optional. Last recorded interaction time from this IP address in a session. + "observeStartTime": "A String", # Optional. First recorded interaction time from this IP address in a session. + }, + ], + "userData": { # Data that identifies the user. At least one identifier is required. # Optional. User-provided data that identifies the user. + "userIdentifiers": [ # Required. The identifiers for the user. It's possible to provide multiple instances of the same type of data (for example, multiple email addresses). To increase the likelihood of a match, provide as many identifiers as possible. At most 10 `userIdentifiers` can be provided in a single AudienceMember or Event. + { # A single identifier for the user. + "address": { # Address information for the user. # The known components of a user's address. Holds a grouping of identifiers that are matched all at once. + "familyName": "A String", # Required. Family (last) name of the user, all lowercase, with no punctuation, no leading or trailing whitespace, and hashed as SHA-256. + "givenName": "A String", # Required. Given (first) name of the user, all lowercase, with no punctuation, no leading or trailing whitespace, and hashed as SHA-256. + "postalCode": "A String", # Required. The postal code of the user's address. + "regionCode": "A String", # Required. The 2-letter region code in ISO-3166-1 alpha-2 of the user's address. + }, + "emailAddress": "A String", # Hashed email address using SHA-256 hash function after normalization. + "phoneNumber": "A String", # Hashed phone number using SHA-256 hash function after normalization (E164 standard). + }, + ], + }, + }, "consent": { # [Digital Markets Act (DMA)](//digital-markets-act.ec.europa.eu/index_en) consent settings for the user. # Optional. The consent setting for the user. "adPersonalization": "A String", # Optional. Represents if the user consents to ad personalization. "adUserData": "A String", # Optional. Represents if the user consents to ad user data. diff --git a/docs/dyn/datamanager_v1.events.html b/docs/dyn/datamanager_v1.events.html index d67f4a0f7f..28c6dd41a6 100644 --- a/docs/dyn/datamanager_v1.events.html +++ b/docs/dyn/datamanager_v1.events.html @@ -138,8 +138,18 @@

Method Details

"events": [ # Required. The list of events to send to the specified destinations. At most 2000 Event resources can be sent in a single request. { # An event representing a user interaction with an advertiser's website or app. "adIdentifiers": { # Identifiers and other information used to match the conversion event with other online activity (such as ad clicks). # Optional. Identifiers and other information used to match the conversion event with other online activity (such as ad clicks). + "dclid": "A String", # Optional. The display click ID associated with this event. + "encryptedUserIds": [ # Optional. Any number of encrypted user IDs. + { # A user identifier issued to be used for attribution. All fields are required if this is used. + "encryptedId": "A String", # Required. The alphanumeric encrypted id. + "entityId": "A String", # Required. The encryption entity ID. This should match the encryption configuration for ad serving or Data Transfer. + "entityType": "A String", # Required. The encryption entity type. This should match the encryption configuration for ad serving or Data Transfer. + "source": "A String", # Required. Describes whether the encrypted cookie was received from ad serving (the %m macro) or from Data Transfer. + }, + ], "gbraid": "A String", # Optional. The click identifier for clicks associated with app events and originating from iOS devices starting with iOS14. "gclid": "A String", # Optional. The Google click ID (gclid) associated with this event. + "impressionId": "A String", # Optional. The impression ID associated with this event. "landingPageDeviceInfo": { # Information about the device being used (if any) when the event happened. # Optional. Information gathered about the device being used (if any) at the time of landing onto the advertiser’s site after interacting with the ad. "brand": "A String", # Optional. The brand of the device. "browser": "A String", # Optional. The brand or type of the browser. @@ -154,6 +164,7 @@

Method Details

"screenWidth": 42, # Optional. The width of the screen in pixels. "userAgent": "A String", # Optional. The user-agent string of the device for the given context. }, + "matchId": "A String", # Optional. The match ID field used to join this event with a previous event. "mobileDeviceId": "A String", # Optional. The mobile identifier for advertisers. This would be IDFA on iOS, AdID on Android, or other platforms’ identifiers for advertisers. "sessionAttributes": "A String", # Optional. Session attributes for event attribution and modeling. "wbraid": "A String", # Optional. The click identifier for clicks associated with web events and originating from iOS devices starting with iOS14. @@ -206,6 +217,7 @@

Method Details

"adPersonalization": "A String", # Optional. Represents if the user consents to ad personalization. "adUserData": "A String", # Optional. Represents if the user consents to ad user data. }, + "conversionCount": 3.14, # Optional. The conversion quantity associated with the event, for counting-based conversions. "conversionValue": 3.14, # Optional. The conversion value associated with the event, for value-based conversions. "currency": "A String", # Optional. The currency code associated with all monetary values within this event. "customVariables": [ # Optional. Additional key/value pair information to send to the conversion containers (conversion action or FL activity). diff --git a/docs/dyn/datamanager_v1.requestStatus.html b/docs/dyn/datamanager_v1.requestStatus.html index 18d45a22f4..6d1bec5bc4 100644 --- a/docs/dyn/datamanager_v1.requestStatus.html +++ b/docs/dyn/datamanager_v1.requestStatus.html @@ -104,6 +104,16 @@

Method Details

"requestStatusPerDestination": [ # A list of request statuses per destination. The order of the statuses matches the order of the destinations in the original request. { # A request status per destination. "audienceMembersIngestionStatus": { # The status of the ingest audience members request. # The status of the ingest audience members request. + "compositeDataIngestionStatus": { # The status of the composite data ingestion to the destination containing stats related to the ingestion. # The status of the composite data ingestion to the destination. + "dataTypeCounts": [ # The total count of data types sent in the upload request for the destination, broken down by data type. Includes all data types in the request, regardless of whether they were successfully ingested or not. + { # The count for a specific data type. + "count": "A String", # The count for this data type. + "type": "A String", # The type of data. + }, + ], + "recordCount": "A String", # The total count of audience members sent in the upload request for the destination. Includes all audience members in the request, regardless of whether they were successfully ingested or not. + "uploadMatchRateRange": "A String", # The match rate range of the upload. + }, "mobileDataIngestionStatus": { # The status of the mobile data ingestion to the destination containing stats related to the ingestion. # The status of the mobile data ingestion to the destination. "mobileIdCount": "A String", # The total count of mobile ids sent in the upload request for the destination. Includes all mobile ids in the request, regardless of whether they were successfully ingested or not. "recordCount": "A String", # The total count of audience members sent in the upload request for the destination. Includes all audience members in the request, regardless of whether they were successfully ingested or not. @@ -127,6 +137,15 @@

Method Details

}, }, "audienceMembersRemovalStatus": { # The status of the remove audience members request. # The status of the remove audience members request. + "compositeDataRemovalStatus": { # The status of the composite data removal from the destination. # The status of the composite data removal from the destination. + "dataTypeCounts": [ # The total count of data types sent in the removal request, broken down by data type. Includes all data types in the request, regardless of whether they were successfully removed or not. + { # The count for a specific data type. + "count": "A String", # The count for this data type. + "type": "A String", # The type of data. + }, + ], + "recordCount": "A String", # The total count of audience members sent in the removal request. Includes all audience members in the request, regardless of whether they were successfully removed or not. + }, "mobileDataRemovalStatus": { # The status of the mobile data removal from the destination. # The status of the mobile data removal from the destination. "mobileIdCount": "A String", # The total count of mobile Ids sent in the removal request. Includes all mobile ids in the request, regardless of whether they were successfully removed or not. "recordCount": "A String", # The total count of audience members sent in the removal request. Includes all audience members in the request, regardless of whether they were successfully removed or not. diff --git a/docs/dyn/dataplex_v1.projects.locations.changeRequests.html b/docs/dyn/dataplex_v1.projects.locations.changeRequests.html index 40d72cb394..57f298fe24 100644 --- a/docs/dyn/dataplex_v1.projects.locations.changeRequests.html +++ b/docs/dyn/dataplex_v1.projects.locations.changeRequests.html @@ -74,12 +74,33 @@

Cloud Dataplex API . projects . locations . changeRequests

Instance Methods

+

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

+

Approves a ChangeRequest.

close()

Close httplib2 connections.

+

+ delete(name, etag=None, x__xgafv=None)

+

Deletes a ChangeRequest.Behavior depends on the caller's permissions and the resource's state: 1. Callers with dataplex.changeRequests.delete can only delete ChangeRequests in the NEW state. 2. Callers with the dataplex.changeRequests.adminDelete permission can delete ChangeRequests regardless of their state.

+

+ get(name, x__xgafv=None)

+

Gets a ChangeRequest.

getIamPolicy(resource, options_requestedPolicyVersion=None, x__xgafv=None)

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

+

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

+

Lists ChangeRequests.

+

+ list_next()

+

Retrieves the next page of results.

+

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

+

Updates a ChangeRequest. Only allowed when the state is NEW.

+

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

+

Rejects a ChangeRequest.

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

Sets the access control policy on the specified resource. Replaces any existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.

@@ -87,11 +108,607 @@

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.

Method Details

+
+ approve(name, body=None, x__xgafv=None) +
Approves a ChangeRequest.
+
+Args:
+  name: string, Required. The name of the ChangeRequest to approve. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for ApproveChangeRequest.
+  "etag": "A String", # Optional. The etag of the ChangeRequest.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Represents a proposed change to a metadata resource.
+  "approver": "A String", # Output only. The email address of the user who approved/rejected the ChangeRequest.
+  "author": "A String", # Output only. The email address of the user who created the ChangeRequest.
+  "changeType": "A String", # Output only. The type of change represented by the change_payload. This field is derived from the populated field in the change_payload oneof.
+  "createEntry": { # Create Entry request. # Payload for creating an Entry.
+    "entry": { # An entry is a representation of a data resource that can be described by various metadata. # Required. Entry resource.
+      "aspects": { # Optional. The aspects that are attached to the entry. Depending on how the aspect is attached to the entry, the format of the aspect key can be one of the following: If the aspect is attached directly to the entry: {project_id_or_number}.{location_id}.{aspect_type_id} If the aspect is attached to an entry's path: {project_id_or_number}.{location_id}.{aspect_type_id}@{path}
+        "a_key": { # Represents a single piece of metadata describing an entry or entry link.
+          "aspectSource": { # Information related to the source system of the aspect. # Optional. Information related to the source system of the aspect.
+            "createTime": "A String", # The time the aspect was created in the source system.
+            "dataVersion": "A String", # The version of the data format used to produce this data. This field is used to indicated when the underlying data format changes (e.g., schema modifications, changes to the source URL format definition, etc).
+            "updateTime": "A String", # The time the aspect was last updated in the source system.
+          },
+          "aspectType": "A String", # Output only. The resource name of the type used to create this Aspect.
+          "createTime": "A String", # Output only. The time when the Aspect was created.
+          "data": { # Required. The content of the aspect, according to its aspect type schema. The maximum size of the field is 120KB (encoded as UTF-8).
+            "a_key": "", # Properties of the object.
+          },
+          "path": "A String", # Output only. The path in the entry under which the aspect is attached.
+          "updateTime": "A String", # Output only. The time when the Aspect was last updated.
+        },
+      },
+      "createTime": "A String", # Output only. The time when the entry was created in Dataplex Universal Catalog.
+      "entrySource": { # Information related to the source system of the data resource that is represented by the entry. # Optional. Information related to the source system of the data resource that is represented by the entry.
+        "ancestors": [ # Immutable. The entries representing the ancestors of the data resource in the source system.
+          { # Information about individual items in the hierarchy that is associated with the data resource.
+            "name": "A String", # Optional. The name of the ancestor resource.
+            "type": "A String", # Optional. The type of the ancestor resource.
+          },
+        ],
+        "createTime": "A String", # The time when the resource was created in the source system.
+        "description": "A String", # A description of the data resource. Maximum length is 2,000 characters.
+        "displayName": "A String", # A user-friendly display name. Maximum length is 500 characters.
+        "labels": { # User-defined labels. The maximum size of keys and values is 128 characters each.
+          "a_key": "A String",
+        },
+        "location": "A String", # Output only. Location of the resource in the source system. You can search the entry by this location. By default, this should match the location of the entry group containing this entry. A different value allows capturing the source location for data external to Google Cloud.
+        "platform": "A String", # The platform containing the source system. Maximum length is 64 characters.
+        "resource": "A String", # The name of the resource in the source system. Maximum length is 4,000 characters.
+        "system": "A String", # The name of the source system. Maximum length is 64 characters.
+        "updateTime": "A String", # The time when the resource was last updated in the source system. If the entry exists in the system and its EntrySource has update_time populated, further updates to the EntrySource of the entry must provide incremental updates to its update_time.
+      },
+      "entryType": "A String", # Required. Immutable. The relative resource name of the entry type that was used to create this entry, in the format projects/{project_id_or_number}/locations/{location_id}/entryTypes/{entry_type_id}.
+      "fullyQualifiedName": "A String", # Optional. A name for the entry that can be referenced by an external system. For more information, see Fully qualified names (https://cloud.google.com/data-catalog/docs/fully-qualified-names). The maximum size of the field is 4000 characters.
+      "name": "A String", # Identifier. The relative resource name of the entry, in the format projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id}.
+      "parentEntry": "A String", # Optional. Immutable. The resource name of the parent entry, in the format projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id}.
+      "updateTime": "A String", # Output only. The time when the entry was last updated in Dataplex Universal Catalog.
+    },
+    "entryId": "A String", # Required. Entry identifier. It has to be unique within an Entry Group.Entries corresponding to Google Cloud resources use an Entry ID format based on full resource names (https://cloud.google.com/apis/design/resource_names#full_resource_name). The format is a full resource name of the resource without the prefix double slashes in the API service name part of the full resource name. This allows retrieval of entries using their associated resource name.For example, if the full resource name of a resource is //library.googleapis.com/shelves/shelf1/books/book2, then the suggested entry_id is library.googleapis.com/shelves/shelf1/books/book2.It is also suggested to follow the same convention for entries corresponding to resources from providers or systems other than Google Cloud.The maximum size of the field is 4000 characters.
+    "parent": "A String", # Required. The resource name of the parent Entry Group: projects/{project}/locations/{location}/entryGroups/{entry_group}.
+  },
+  "createEntryLink": { # Request message for CreateEntryLink. # Payload for creating an EntryLink.
+    "entryLink": { # EntryLink represents a link between two Entries. # Required. Entry Link resource.
+      "aspects": { # Optional. The aspects that are attached to the entry link. The format of the aspect key has to be the following: {project_id_or_number}.{location_id}.{aspect_type_id} Currently, only a single aspect of a Dataplex-owned Aspect Type is allowed.
+        "a_key": { # Represents a single piece of metadata describing an entry or entry link.
+          "aspectSource": { # Information related to the source system of the aspect. # Optional. Information related to the source system of the aspect.
+            "createTime": "A String", # The time the aspect was created in the source system.
+            "dataVersion": "A String", # The version of the data format used to produce this data. This field is used to indicated when the underlying data format changes (e.g., schema modifications, changes to the source URL format definition, etc).
+            "updateTime": "A String", # The time the aspect was last updated in the source system.
+          },
+          "aspectType": "A String", # Output only. The resource name of the type used to create this Aspect.
+          "createTime": "A String", # Output only. The time when the Aspect was created.
+          "data": { # Required. The content of the aspect, according to its aspect type schema. The maximum size of the field is 120KB (encoded as UTF-8).
+            "a_key": "", # Properties of the object.
+          },
+          "path": "A String", # Output only. The path in the entry under which the aspect is attached.
+          "updateTime": "A String", # Output only. The time when the Aspect was last updated.
+        },
+      },
+      "createTime": "A String", # Output only. The time when the Entry Link was created.
+      "entryLinkType": "A String", # Required. Immutable. Relative resource name of the Entry Link Type used to create this Entry Link. For example: Entry link between synonym terms in a glossary: projects/dataplex-types/locations/global/entryLinkTypes/synonym Entry link between related terms in a glossary: projects/dataplex-types/locations/global/entryLinkTypes/related Entry link between glossary terms and data assets: projects/dataplex-types/locations/global/entryLinkTypes/definition
+      "entryReferences": [ # Required. Immutable. Specifies the Entries referenced in the Entry Link. There should be exactly two entry references.
+        { # Reference to the Entry that is linked through the Entry Link.
+          "name": "A String", # Required. Immutable. The relative resource name of the referenced Entry, of the form: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id}
+          "path": "A String", # Immutable. The path in the Entry that is referenced in the Entry Link. Empty path denotes that the Entry itself is referenced in the Entry Link.
+          "type": "A String", # Required. Immutable. The reference type of the Entry.
+        },
+      ],
+      "name": "A String", # Output only. Immutable. Identifier. The relative resource name of the Entry Link, of the form: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entryLinks/{entry_link_id}
+      "updateTime": "A String", # Output only. The time when the Entry Link was last updated.
+    },
+    "entryLinkId": "A String", # Required. Entry Link identifier * Must contain only lowercase letters, numbers and hyphens. * Must start with a letter. * Must be between 1-63 characters. * Must end with a number or a letter. * Must be unique within the EntryGroup.
+    "parent": "A String", # Required. The resource name of the parent Entry Group: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}.
+  },
+  "createGlossary": { # Create Glossary Request # Payload for creating a Glossary.
+    "glossary": { # A Glossary represents a collection of GlossaryCategories and GlossaryTerms defined by the user. Glossary is a top level resource and is the Google Cloud parent resource of all the GlossaryCategories and GlossaryTerms within it. # Required. The Glossary to create.
+      "categoryCount": 42, # Output only. The number of GlossaryCategories in the Glossary.
+      "createTime": "A String", # Output only. The time at which the Glossary was created.
+      "description": "A String", # Optional. The user-mutable description of the Glossary.
+      "displayName": "A String", # Optional. User friendly display name of the Glossary. This is user-mutable. This will be same as the GlossaryId, if not specified.
+      "etag": "A String", # Optional. Needed for resource freshness validation. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.
+      "labels": { # Optional. User-defined labels for the Glossary.
+        "a_key": "A String",
+      },
+      "name": "A String", # Output only. Identifier. The resource name of the Glossary. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}
+      "termCount": 42, # Output only. The number of GlossaryTerms in the Glossary.
+      "uid": "A String", # Output only. System generated unique id for the Glossary. This ID will be different if the Glossary is deleted and re-created with the same name.
+      "updateTime": "A String", # Output only. The time at which the Glossary was last updated.
+    },
+    "glossaryId": "A String", # Required. Glossary ID: Glossary identifier.
+    "parent": "A String", # Required. The parent resource where this Glossary will be created. Format: projects/{project_id_or_number}/locations/{location_id} where location_id refers to a Google Cloud region.
+    "validateOnly": True or False, # Optional. Validates the request without actually creating the Glossary. Default: false.
+  },
+  "createGlossaryCategory": { # Creates a new GlossaryCategory under the specified Glossary. # Payload for creating a GlossaryCategory.
+    "category": { # A GlossaryCategory represents a collection of GlossaryCategories and GlossaryTerms within a Glossary that are related to each other. # Required. The GlossaryCategory to create.
+      "createTime": "A String", # Output only. The time at which the GlossaryCategory was created.
+      "description": "A String", # Optional. The user-mutable description of the GlossaryCategory.
+      "displayName": "A String", # Optional. User friendly display name of the GlossaryCategory. This is user-mutable. This will be same as the GlossaryCategoryId, if not specified.
+      "labels": { # Optional. User-defined labels for the GlossaryCategory.
+        "a_key": "A String",
+      },
+      "name": "A String", # Output only. Identifier. The resource name of the GlossaryCategory. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}/categories/{category_id}
+      "parent": "A String", # Required. The immediate parent of the GlossaryCategory in the resource-hierarchy. It can either be a Glossary or a GlossaryCategory. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id} OR projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}/categories/{category_id}
+      "uid": "A String", # Output only. System generated unique id for the GlossaryCategory. This ID will be different if the GlossaryCategory is deleted and re-created with the same name.
+      "updateTime": "A String", # Output only. The time at which the GlossaryCategory was last updated.
+    },
+    "categoryId": "A String", # Required. GlossaryCategory identifier.
+    "parent": "A String", # Required. The parent resource where this GlossaryCategory will be created. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id} where locationId refers to a Google Cloud region.
+  },
+  "createGlossaryTerm": { # Creates a new GlossaryTerm under the specified Glossary. # Payload for creating a GlossaryTerm.
+    "parent": "A String", # Required. The parent resource where the GlossaryTerm will be created. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id} where location_id refers to a Google Cloud region.
+    "term": { # GlossaryTerms are the core of Glossary. A GlossaryTerm holds a rich text description that can be attached to Entries or specific columns to enrich them. # Required. The GlossaryTerm to create.
+      "createTime": "A String", # Output only. The time at which the GlossaryTerm was created.
+      "description": "A String", # Optional. The user-mutable description of the GlossaryTerm.
+      "displayName": "A String", # Optional. User friendly display name of the GlossaryTerm. This is user-mutable. This will be same as the GlossaryTermId, if not specified.
+      "labels": { # Optional. User-defined labels for the GlossaryTerm.
+        "a_key": "A String",
+      },
+      "name": "A String", # Output only. Identifier. The resource name of the GlossaryTerm. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}/terms/{term_id}
+      "parent": "A String", # Required. The immediate parent of the GlossaryTerm in the resource-hierarchy. It can either be a Glossary or a GlossaryCategory. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id} OR projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}/categories/{category_id}
+      "uid": "A String", # Output only. System generated unique id for the GlossaryTerm. This ID will be different if the GlossaryTerm is deleted and re-created with the same name.
+      "updateTime": "A String", # Output only. The time at which the GlossaryTerm was last updated.
+    },
+    "termId": "A String", # Required. GlossaryTerm identifier.
+  },
+  "createTime": "A String", # Output only. The time when the ChangeRequest was created.
+  "dataProductAccessRequest": { # Message for requesting access to a Data Product. This will be used to create a ChangeRequest of type REQUEST_DATA_PRODUCT_ACCESS. # Payload for Data Product access request.
+    "accessGroupDisplayName": "A String", # Output only. The display name of the access group defined in the Data Product for which access is being requested.
+    "accessGroupId": "A String", # Required. The ID of the access group for which access is being requested. This corresponds to the unique identifier of the AccessGroup defined in the Data Product.
+    "parent": "A String", # Required. The resource name of the data product. Format: projects/{project_number}/locations/{location_id}/dataProducts/{data_product_id}
+    "requestedPrincipal": "A String", # Optional. The principal for which access is being requested in IAM format. If not specified, the requestor's principal will be used. Example: serviceAccount:my-sa@my-project.iam.gserviceaccount.com. Only service account principals are currently supported. https://cloud.google.com/iam/docs/principal-identifiers
+  },
+  "deleteEntry": { # Delete Entry request. # Payload for deleting an Entry.
+    "name": "A String", # Required. The resource name of the Entry: projects/{project}/locations/{location}/entryGroups/{entry_group}/entries/{entry}.
+  },
+  "deleteEntryLink": { # Request message for DeleteEntryLink. # Payload for deleting an EntryLink.
+    "name": "A String", # Required. The resource name of the Entry Link: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entryLinks/{entry_link_id}.
+  },
+  "deleteGlossary": { # Delete Glossary Request # Payload for deleting a Glossary.
+    "etag": "A String", # Optional. The etag of the Glossary. If this is provided, it must match the server's etag. If the etag is provided and does not match the server-computed etag, the request must fail with a ABORTED error code.
+    "name": "A String", # Required. The name of the Glossary to delete. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}
+  },
+  "deleteGlossaryCategory": { # Delete GlossaryCategory Request # Payload for deleting a GlossaryCategory.
+    "name": "A String", # Required. The name of the GlossaryCategory to delete. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}/categories/{category_id}
+  },
+  "deleteGlossaryTerm": { # Delete GlossaryTerm Request # Payload for deleting a GlossaryTerm.
+    "name": "A String", # Required. The name of the GlossaryTerm to delete. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}/terms/{term_id}
+  },
+  "etag": "A String", # Optional. This checksum is computed by the service. It can be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.
+  "justification": "A String", # Optional. Justification of the ChangeRequest. This should explain why the change is needed or why it should be approved.
+  "labels": { # Optional. User-defined labels for the ChangeRequest.
+    "a_key": "A String",
+  },
+  "name": "A String", # Identifier. The relative resource name of the ChangeRequest, of the form: projects/{project_number}/locations/{location_id}/changeRequests/{change_request_id}
+  "rejectionComment": "A String", # Output only. The reason provided for rejecting the ChangeRequest.
+  "resource": "A String", # Output only. The full resource name of the target resource to be modified. Example: //dataplex.googleapis.com/projects/my-project/locations/us-central1/entryGroups/my-group/entries/my-entry
+  "state": "A String", # Output only. The current state of the ChangeRequest.
+  "uid": "A String", # Output only. System generated globally unique ID for the ChangeRequest.
+  "updateEntry": { # Update Entry request. # Payload for updating an Entry.
+    "allowMissing": True or False, # Optional. If set to true and the entry doesn't exist, the service will create it.
+    "aspectKeys": [ # Optional. The map keys of the Aspects which the service should modify. It supports the following syntaxes: - matches an aspect of the given type and empty path. @path - matches an aspect of the given type and specified path. For example, to attach an aspect to a field that is specified by the schema aspect, the path should have the format Schema.. @* - matches aspects of the given type for all paths. *@path - matches aspects of all types on the given path.The service will not remove existing aspects matching the syntax unless delete_missing_aspects is set to true.If this field is left empty, the service treats it as specifying exactly those Aspects present in the request.
+      "A String",
+    ],
+    "deleteMissingAspects": True or False, # Optional. If set to true and the aspect_keys specify aspect ranges, the service deletes any existing aspects from that range that weren't provided in the request.
+    "entry": { # An entry is a representation of a data resource that can be described by various metadata. # Required. Entry resource.
+      "aspects": { # Optional. The aspects that are attached to the entry. Depending on how the aspect is attached to the entry, the format of the aspect key can be one of the following: If the aspect is attached directly to the entry: {project_id_or_number}.{location_id}.{aspect_type_id} If the aspect is attached to an entry's path: {project_id_or_number}.{location_id}.{aspect_type_id}@{path}
+        "a_key": { # Represents a single piece of metadata describing an entry or entry link.
+          "aspectSource": { # Information related to the source system of the aspect. # Optional. Information related to the source system of the aspect.
+            "createTime": "A String", # The time the aspect was created in the source system.
+            "dataVersion": "A String", # The version of the data format used to produce this data. This field is used to indicated when the underlying data format changes (e.g., schema modifications, changes to the source URL format definition, etc).
+            "updateTime": "A String", # The time the aspect was last updated in the source system.
+          },
+          "aspectType": "A String", # Output only. The resource name of the type used to create this Aspect.
+          "createTime": "A String", # Output only. The time when the Aspect was created.
+          "data": { # Required. The content of the aspect, according to its aspect type schema. The maximum size of the field is 120KB (encoded as UTF-8).
+            "a_key": "", # Properties of the object.
+          },
+          "path": "A String", # Output only. The path in the entry under which the aspect is attached.
+          "updateTime": "A String", # Output only. The time when the Aspect was last updated.
+        },
+      },
+      "createTime": "A String", # Output only. The time when the entry was created in Dataplex Universal Catalog.
+      "entrySource": { # Information related to the source system of the data resource that is represented by the entry. # Optional. Information related to the source system of the data resource that is represented by the entry.
+        "ancestors": [ # Immutable. The entries representing the ancestors of the data resource in the source system.
+          { # Information about individual items in the hierarchy that is associated with the data resource.
+            "name": "A String", # Optional. The name of the ancestor resource.
+            "type": "A String", # Optional. The type of the ancestor resource.
+          },
+        ],
+        "createTime": "A String", # The time when the resource was created in the source system.
+        "description": "A String", # A description of the data resource. Maximum length is 2,000 characters.
+        "displayName": "A String", # A user-friendly display name. Maximum length is 500 characters.
+        "labels": { # User-defined labels. The maximum size of keys and values is 128 characters each.
+          "a_key": "A String",
+        },
+        "location": "A String", # Output only. Location of the resource in the source system. You can search the entry by this location. By default, this should match the location of the entry group containing this entry. A different value allows capturing the source location for data external to Google Cloud.
+        "platform": "A String", # The platform containing the source system. Maximum length is 64 characters.
+        "resource": "A String", # The name of the resource in the source system. Maximum length is 4,000 characters.
+        "system": "A String", # The name of the source system. Maximum length is 64 characters.
+        "updateTime": "A String", # The time when the resource was last updated in the source system. If the entry exists in the system and its EntrySource has update_time populated, further updates to the EntrySource of the entry must provide incremental updates to its update_time.
+      },
+      "entryType": "A String", # Required. Immutable. The relative resource name of the entry type that was used to create this entry, in the format projects/{project_id_or_number}/locations/{location_id}/entryTypes/{entry_type_id}.
+      "fullyQualifiedName": "A String", # Optional. A name for the entry that can be referenced by an external system. For more information, see Fully qualified names (https://cloud.google.com/data-catalog/docs/fully-qualified-names). The maximum size of the field is 4000 characters.
+      "name": "A String", # Identifier. The relative resource name of the entry, in the format projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id}.
+      "parentEntry": "A String", # Optional. Immutable. The resource name of the parent entry, in the format projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id}.
+      "updateTime": "A String", # Output only. The time when the entry was last updated in Dataplex Universal Catalog.
+    },
+    "updateMask": "A String", # Optional. Mask of fields to update. To update Aspects, the update_mask must contain the value "aspects".If the update_mask is empty, the service will update all modifiable fields present in the request.
+  },
+  "updateGlossary": { # Update Glossary Request # Payload for updating a Glossary.
+    "glossary": { # A Glossary represents a collection of GlossaryCategories and GlossaryTerms defined by the user. Glossary is a top level resource and is the Google Cloud parent resource of all the GlossaryCategories and GlossaryTerms within it. # Required. The Glossary to update. The Glossary's name field is used to identify the Glossary to update. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}
+      "categoryCount": 42, # Output only. The number of GlossaryCategories in the Glossary.
+      "createTime": "A String", # Output only. The time at which the Glossary was created.
+      "description": "A String", # Optional. The user-mutable description of the Glossary.
+      "displayName": "A String", # Optional. User friendly display name of the Glossary. This is user-mutable. This will be same as the GlossaryId, if not specified.
+      "etag": "A String", # Optional. Needed for resource freshness validation. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.
+      "labels": { # Optional. User-defined labels for the Glossary.
+        "a_key": "A String",
+      },
+      "name": "A String", # Output only. Identifier. The resource name of the Glossary. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}
+      "termCount": 42, # Output only. The number of GlossaryTerms in the Glossary.
+      "uid": "A String", # Output only. System generated unique id for the Glossary. This ID will be different if the Glossary is deleted and re-created with the same name.
+      "updateTime": "A String", # Output only. The time at which the Glossary was last updated.
+    },
+    "updateMask": "A String", # Required. The list of fields to update.
+    "validateOnly": True or False, # Optional. Validates the request without actually updating the Glossary. Default: false.
+  },
+  "updateGlossaryCategory": { # Update GlossaryCategory Request # Payload for updating a GlossaryCategory.
+    "category": { # A GlossaryCategory represents a collection of GlossaryCategories and GlossaryTerms within a Glossary that are related to each other. # Required. The GlossaryCategory to update. The GlossaryCategory's name field is used to identify the GlossaryCategory to update. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}/categories/{category_id}
+      "createTime": "A String", # Output only. The time at which the GlossaryCategory was created.
+      "description": "A String", # Optional. The user-mutable description of the GlossaryCategory.
+      "displayName": "A String", # Optional. User friendly display name of the GlossaryCategory. This is user-mutable. This will be same as the GlossaryCategoryId, if not specified.
+      "labels": { # Optional. User-defined labels for the GlossaryCategory.
+        "a_key": "A String",
+      },
+      "name": "A String", # Output only. Identifier. The resource name of the GlossaryCategory. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}/categories/{category_id}
+      "parent": "A String", # Required. The immediate parent of the GlossaryCategory in the resource-hierarchy. It can either be a Glossary or a GlossaryCategory. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id} OR projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}/categories/{category_id}
+      "uid": "A String", # Output only. System generated unique id for the GlossaryCategory. This ID will be different if the GlossaryCategory is deleted and re-created with the same name.
+      "updateTime": "A String", # Output only. The time at which the GlossaryCategory was last updated.
+    },
+    "updateMask": "A String", # Required. The list of fields to update.
+  },
+  "updateGlossaryTerm": { # Update GlossaryTerm Request # Payload for updating a GlossaryTerm.
+    "term": { # GlossaryTerms are the core of Glossary. A GlossaryTerm holds a rich text description that can be attached to Entries or specific columns to enrich them. # Required. The GlossaryTerm to update. The GlossaryTerm's name field is used to identify the GlossaryTerm to update. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}/terms/{term_id}
+      "createTime": "A String", # Output only. The time at which the GlossaryTerm was created.
+      "description": "A String", # Optional. The user-mutable description of the GlossaryTerm.
+      "displayName": "A String", # Optional. User friendly display name of the GlossaryTerm. This is user-mutable. This will be same as the GlossaryTermId, if not specified.
+      "labels": { # Optional. User-defined labels for the GlossaryTerm.
+        "a_key": "A String",
+      },
+      "name": "A String", # Output only. Identifier. The resource name of the GlossaryTerm. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}/terms/{term_id}
+      "parent": "A String", # Required. The immediate parent of the GlossaryTerm in the resource-hierarchy. It can either be a Glossary or a GlossaryCategory. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id} OR projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}/categories/{category_id}
+      "uid": "A String", # Output only. System generated unique id for the GlossaryTerm. This ID will be different if the GlossaryTerm is deleted and re-created with the same name.
+      "updateTime": "A String", # Output only. The time at which the GlossaryTerm was last updated.
+    },
+    "updateMask": "A String", # Required. The list of fields to update.
+  },
+  "updateTime": "A String", # Output only. The time when the ChangeRequest was last updated.
+}
+
+
close()
Close httplib2 connections.
+
+ delete(name, etag=None, x__xgafv=None) +
Deletes a ChangeRequest.Behavior depends on the caller's permissions and the resource's state: 1. Callers with dataplex.changeRequests.delete can only delete ChangeRequests in the NEW state. 2. Callers with the dataplex.changeRequests.adminDelete permission can delete ChangeRequests regardless of their state.
+
+Args:
+  name: string, Required. The name of the ChangeRequest to delete. Format: projects/{project_number}/locations/{location_id}/changeRequests/{change_request_id} (required)
+  etag: string, Optional. The etag of the ChangeRequest.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ get(name, x__xgafv=None) +
Gets a ChangeRequest.
+
+Args:
+  name: string, Required. The name of the ChangeRequest to retrieve. Format: projects/{project_number}/locations/{location_id}/changeRequests/{change_request_id} (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Represents a proposed change to a metadata resource.
+  "approver": "A String", # Output only. The email address of the user who approved/rejected the ChangeRequest.
+  "author": "A String", # Output only. The email address of the user who created the ChangeRequest.
+  "changeType": "A String", # Output only. The type of change represented by the change_payload. This field is derived from the populated field in the change_payload oneof.
+  "createEntry": { # Create Entry request. # Payload for creating an Entry.
+    "entry": { # An entry is a representation of a data resource that can be described by various metadata. # Required. Entry resource.
+      "aspects": { # Optional. The aspects that are attached to the entry. Depending on how the aspect is attached to the entry, the format of the aspect key can be one of the following: If the aspect is attached directly to the entry: {project_id_or_number}.{location_id}.{aspect_type_id} If the aspect is attached to an entry's path: {project_id_or_number}.{location_id}.{aspect_type_id}@{path}
+        "a_key": { # Represents a single piece of metadata describing an entry or entry link.
+          "aspectSource": { # Information related to the source system of the aspect. # Optional. Information related to the source system of the aspect.
+            "createTime": "A String", # The time the aspect was created in the source system.
+            "dataVersion": "A String", # The version of the data format used to produce this data. This field is used to indicated when the underlying data format changes (e.g., schema modifications, changes to the source URL format definition, etc).
+            "updateTime": "A String", # The time the aspect was last updated in the source system.
+          },
+          "aspectType": "A String", # Output only. The resource name of the type used to create this Aspect.
+          "createTime": "A String", # Output only. The time when the Aspect was created.
+          "data": { # Required. The content of the aspect, according to its aspect type schema. The maximum size of the field is 120KB (encoded as UTF-8).
+            "a_key": "", # Properties of the object.
+          },
+          "path": "A String", # Output only. The path in the entry under which the aspect is attached.
+          "updateTime": "A String", # Output only. The time when the Aspect was last updated.
+        },
+      },
+      "createTime": "A String", # Output only. The time when the entry was created in Dataplex Universal Catalog.
+      "entrySource": { # Information related to the source system of the data resource that is represented by the entry. # Optional. Information related to the source system of the data resource that is represented by the entry.
+        "ancestors": [ # Immutable. The entries representing the ancestors of the data resource in the source system.
+          { # Information about individual items in the hierarchy that is associated with the data resource.
+            "name": "A String", # Optional. The name of the ancestor resource.
+            "type": "A String", # Optional. The type of the ancestor resource.
+          },
+        ],
+        "createTime": "A String", # The time when the resource was created in the source system.
+        "description": "A String", # A description of the data resource. Maximum length is 2,000 characters.
+        "displayName": "A String", # A user-friendly display name. Maximum length is 500 characters.
+        "labels": { # User-defined labels. The maximum size of keys and values is 128 characters each.
+          "a_key": "A String",
+        },
+        "location": "A String", # Output only. Location of the resource in the source system. You can search the entry by this location. By default, this should match the location of the entry group containing this entry. A different value allows capturing the source location for data external to Google Cloud.
+        "platform": "A String", # The platform containing the source system. Maximum length is 64 characters.
+        "resource": "A String", # The name of the resource in the source system. Maximum length is 4,000 characters.
+        "system": "A String", # The name of the source system. Maximum length is 64 characters.
+        "updateTime": "A String", # The time when the resource was last updated in the source system. If the entry exists in the system and its EntrySource has update_time populated, further updates to the EntrySource of the entry must provide incremental updates to its update_time.
+      },
+      "entryType": "A String", # Required. Immutable. The relative resource name of the entry type that was used to create this entry, in the format projects/{project_id_or_number}/locations/{location_id}/entryTypes/{entry_type_id}.
+      "fullyQualifiedName": "A String", # Optional. A name for the entry that can be referenced by an external system. For more information, see Fully qualified names (https://cloud.google.com/data-catalog/docs/fully-qualified-names). The maximum size of the field is 4000 characters.
+      "name": "A String", # Identifier. The relative resource name of the entry, in the format projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id}.
+      "parentEntry": "A String", # Optional. Immutable. The resource name of the parent entry, in the format projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id}.
+      "updateTime": "A String", # Output only. The time when the entry was last updated in Dataplex Universal Catalog.
+    },
+    "entryId": "A String", # Required. Entry identifier. It has to be unique within an Entry Group.Entries corresponding to Google Cloud resources use an Entry ID format based on full resource names (https://cloud.google.com/apis/design/resource_names#full_resource_name). The format is a full resource name of the resource without the prefix double slashes in the API service name part of the full resource name. This allows retrieval of entries using their associated resource name.For example, if the full resource name of a resource is //library.googleapis.com/shelves/shelf1/books/book2, then the suggested entry_id is library.googleapis.com/shelves/shelf1/books/book2.It is also suggested to follow the same convention for entries corresponding to resources from providers or systems other than Google Cloud.The maximum size of the field is 4000 characters.
+    "parent": "A String", # Required. The resource name of the parent Entry Group: projects/{project}/locations/{location}/entryGroups/{entry_group}.
+  },
+  "createEntryLink": { # Request message for CreateEntryLink. # Payload for creating an EntryLink.
+    "entryLink": { # EntryLink represents a link between two Entries. # Required. Entry Link resource.
+      "aspects": { # Optional. The aspects that are attached to the entry link. The format of the aspect key has to be the following: {project_id_or_number}.{location_id}.{aspect_type_id} Currently, only a single aspect of a Dataplex-owned Aspect Type is allowed.
+        "a_key": { # Represents a single piece of metadata describing an entry or entry link.
+          "aspectSource": { # Information related to the source system of the aspect. # Optional. Information related to the source system of the aspect.
+            "createTime": "A String", # The time the aspect was created in the source system.
+            "dataVersion": "A String", # The version of the data format used to produce this data. This field is used to indicated when the underlying data format changes (e.g., schema modifications, changes to the source URL format definition, etc).
+            "updateTime": "A String", # The time the aspect was last updated in the source system.
+          },
+          "aspectType": "A String", # Output only. The resource name of the type used to create this Aspect.
+          "createTime": "A String", # Output only. The time when the Aspect was created.
+          "data": { # Required. The content of the aspect, according to its aspect type schema. The maximum size of the field is 120KB (encoded as UTF-8).
+            "a_key": "", # Properties of the object.
+          },
+          "path": "A String", # Output only. The path in the entry under which the aspect is attached.
+          "updateTime": "A String", # Output only. The time when the Aspect was last updated.
+        },
+      },
+      "createTime": "A String", # Output only. The time when the Entry Link was created.
+      "entryLinkType": "A String", # Required. Immutable. Relative resource name of the Entry Link Type used to create this Entry Link. For example: Entry link between synonym terms in a glossary: projects/dataplex-types/locations/global/entryLinkTypes/synonym Entry link between related terms in a glossary: projects/dataplex-types/locations/global/entryLinkTypes/related Entry link between glossary terms and data assets: projects/dataplex-types/locations/global/entryLinkTypes/definition
+      "entryReferences": [ # Required. Immutable. Specifies the Entries referenced in the Entry Link. There should be exactly two entry references.
+        { # Reference to the Entry that is linked through the Entry Link.
+          "name": "A String", # Required. Immutable. The relative resource name of the referenced Entry, of the form: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id}
+          "path": "A String", # Immutable. The path in the Entry that is referenced in the Entry Link. Empty path denotes that the Entry itself is referenced in the Entry Link.
+          "type": "A String", # Required. Immutable. The reference type of the Entry.
+        },
+      ],
+      "name": "A String", # Output only. Immutable. Identifier. The relative resource name of the Entry Link, of the form: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entryLinks/{entry_link_id}
+      "updateTime": "A String", # Output only. The time when the Entry Link was last updated.
+    },
+    "entryLinkId": "A String", # Required. Entry Link identifier * Must contain only lowercase letters, numbers and hyphens. * Must start with a letter. * Must be between 1-63 characters. * Must end with a number or a letter. * Must be unique within the EntryGroup.
+    "parent": "A String", # Required. The resource name of the parent Entry Group: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}.
+  },
+  "createGlossary": { # Create Glossary Request # Payload for creating a Glossary.
+    "glossary": { # A Glossary represents a collection of GlossaryCategories and GlossaryTerms defined by the user. Glossary is a top level resource and is the Google Cloud parent resource of all the GlossaryCategories and GlossaryTerms within it. # Required. The Glossary to create.
+      "categoryCount": 42, # Output only. The number of GlossaryCategories in the Glossary.
+      "createTime": "A String", # Output only. The time at which the Glossary was created.
+      "description": "A String", # Optional. The user-mutable description of the Glossary.
+      "displayName": "A String", # Optional. User friendly display name of the Glossary. This is user-mutable. This will be same as the GlossaryId, if not specified.
+      "etag": "A String", # Optional. Needed for resource freshness validation. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.
+      "labels": { # Optional. User-defined labels for the Glossary.
+        "a_key": "A String",
+      },
+      "name": "A String", # Output only. Identifier. The resource name of the Glossary. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}
+      "termCount": 42, # Output only. The number of GlossaryTerms in the Glossary.
+      "uid": "A String", # Output only. System generated unique id for the Glossary. This ID will be different if the Glossary is deleted and re-created with the same name.
+      "updateTime": "A String", # Output only. The time at which the Glossary was last updated.
+    },
+    "glossaryId": "A String", # Required. Glossary ID: Glossary identifier.
+    "parent": "A String", # Required. The parent resource where this Glossary will be created. Format: projects/{project_id_or_number}/locations/{location_id} where location_id refers to a Google Cloud region.
+    "validateOnly": True or False, # Optional. Validates the request without actually creating the Glossary. Default: false.
+  },
+  "createGlossaryCategory": { # Creates a new GlossaryCategory under the specified Glossary. # Payload for creating a GlossaryCategory.
+    "category": { # A GlossaryCategory represents a collection of GlossaryCategories and GlossaryTerms within a Glossary that are related to each other. # Required. The GlossaryCategory to create.
+      "createTime": "A String", # Output only. The time at which the GlossaryCategory was created.
+      "description": "A String", # Optional. The user-mutable description of the GlossaryCategory.
+      "displayName": "A String", # Optional. User friendly display name of the GlossaryCategory. This is user-mutable. This will be same as the GlossaryCategoryId, if not specified.
+      "labels": { # Optional. User-defined labels for the GlossaryCategory.
+        "a_key": "A String",
+      },
+      "name": "A String", # Output only. Identifier. The resource name of the GlossaryCategory. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}/categories/{category_id}
+      "parent": "A String", # Required. The immediate parent of the GlossaryCategory in the resource-hierarchy. It can either be a Glossary or a GlossaryCategory. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id} OR projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}/categories/{category_id}
+      "uid": "A String", # Output only. System generated unique id for the GlossaryCategory. This ID will be different if the GlossaryCategory is deleted and re-created with the same name.
+      "updateTime": "A String", # Output only. The time at which the GlossaryCategory was last updated.
+    },
+    "categoryId": "A String", # Required. GlossaryCategory identifier.
+    "parent": "A String", # Required. The parent resource where this GlossaryCategory will be created. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id} where locationId refers to a Google Cloud region.
+  },
+  "createGlossaryTerm": { # Creates a new GlossaryTerm under the specified Glossary. # Payload for creating a GlossaryTerm.
+    "parent": "A String", # Required. The parent resource where the GlossaryTerm will be created. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id} where location_id refers to a Google Cloud region.
+    "term": { # GlossaryTerms are the core of Glossary. A GlossaryTerm holds a rich text description that can be attached to Entries or specific columns to enrich them. # Required. The GlossaryTerm to create.
+      "createTime": "A String", # Output only. The time at which the GlossaryTerm was created.
+      "description": "A String", # Optional. The user-mutable description of the GlossaryTerm.
+      "displayName": "A String", # Optional. User friendly display name of the GlossaryTerm. This is user-mutable. This will be same as the GlossaryTermId, if not specified.
+      "labels": { # Optional. User-defined labels for the GlossaryTerm.
+        "a_key": "A String",
+      },
+      "name": "A String", # Output only. Identifier. The resource name of the GlossaryTerm. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}/terms/{term_id}
+      "parent": "A String", # Required. The immediate parent of the GlossaryTerm in the resource-hierarchy. It can either be a Glossary or a GlossaryCategory. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id} OR projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}/categories/{category_id}
+      "uid": "A String", # Output only. System generated unique id for the GlossaryTerm. This ID will be different if the GlossaryTerm is deleted and re-created with the same name.
+      "updateTime": "A String", # Output only. The time at which the GlossaryTerm was last updated.
+    },
+    "termId": "A String", # Required. GlossaryTerm identifier.
+  },
+  "createTime": "A String", # Output only. The time when the ChangeRequest was created.
+  "dataProductAccessRequest": { # Message for requesting access to a Data Product. This will be used to create a ChangeRequest of type REQUEST_DATA_PRODUCT_ACCESS. # Payload for Data Product access request.
+    "accessGroupDisplayName": "A String", # Output only. The display name of the access group defined in the Data Product for which access is being requested.
+    "accessGroupId": "A String", # Required. The ID of the access group for which access is being requested. This corresponds to the unique identifier of the AccessGroup defined in the Data Product.
+    "parent": "A String", # Required. The resource name of the data product. Format: projects/{project_number}/locations/{location_id}/dataProducts/{data_product_id}
+    "requestedPrincipal": "A String", # Optional. The principal for which access is being requested in IAM format. If not specified, the requestor's principal will be used. Example: serviceAccount:my-sa@my-project.iam.gserviceaccount.com. Only service account principals are currently supported. https://cloud.google.com/iam/docs/principal-identifiers
+  },
+  "deleteEntry": { # Delete Entry request. # Payload for deleting an Entry.
+    "name": "A String", # Required. The resource name of the Entry: projects/{project}/locations/{location}/entryGroups/{entry_group}/entries/{entry}.
+  },
+  "deleteEntryLink": { # Request message for DeleteEntryLink. # Payload for deleting an EntryLink.
+    "name": "A String", # Required. The resource name of the Entry Link: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entryLinks/{entry_link_id}.
+  },
+  "deleteGlossary": { # Delete Glossary Request # Payload for deleting a Glossary.
+    "etag": "A String", # Optional. The etag of the Glossary. If this is provided, it must match the server's etag. If the etag is provided and does not match the server-computed etag, the request must fail with a ABORTED error code.
+    "name": "A String", # Required. The name of the Glossary to delete. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}
+  },
+  "deleteGlossaryCategory": { # Delete GlossaryCategory Request # Payload for deleting a GlossaryCategory.
+    "name": "A String", # Required. The name of the GlossaryCategory to delete. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}/categories/{category_id}
+  },
+  "deleteGlossaryTerm": { # Delete GlossaryTerm Request # Payload for deleting a GlossaryTerm.
+    "name": "A String", # Required. The name of the GlossaryTerm to delete. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}/terms/{term_id}
+  },
+  "etag": "A String", # Optional. This checksum is computed by the service. It can be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.
+  "justification": "A String", # Optional. Justification of the ChangeRequest. This should explain why the change is needed or why it should be approved.
+  "labels": { # Optional. User-defined labels for the ChangeRequest.
+    "a_key": "A String",
+  },
+  "name": "A String", # Identifier. The relative resource name of the ChangeRequest, of the form: projects/{project_number}/locations/{location_id}/changeRequests/{change_request_id}
+  "rejectionComment": "A String", # Output only. The reason provided for rejecting the ChangeRequest.
+  "resource": "A String", # Output only. The full resource name of the target resource to be modified. Example: //dataplex.googleapis.com/projects/my-project/locations/us-central1/entryGroups/my-group/entries/my-entry
+  "state": "A String", # Output only. The current state of the ChangeRequest.
+  "uid": "A String", # Output only. System generated globally unique ID for the ChangeRequest.
+  "updateEntry": { # Update Entry request. # Payload for updating an Entry.
+    "allowMissing": True or False, # Optional. If set to true and the entry doesn't exist, the service will create it.
+    "aspectKeys": [ # Optional. The map keys of the Aspects which the service should modify. It supports the following syntaxes: - matches an aspect of the given type and empty path. @path - matches an aspect of the given type and specified path. For example, to attach an aspect to a field that is specified by the schema aspect, the path should have the format Schema.. @* - matches aspects of the given type for all paths. *@path - matches aspects of all types on the given path.The service will not remove existing aspects matching the syntax unless delete_missing_aspects is set to true.If this field is left empty, the service treats it as specifying exactly those Aspects present in the request.
+      "A String",
+    ],
+    "deleteMissingAspects": True or False, # Optional. If set to true and the aspect_keys specify aspect ranges, the service deletes any existing aspects from that range that weren't provided in the request.
+    "entry": { # An entry is a representation of a data resource that can be described by various metadata. # Required. Entry resource.
+      "aspects": { # Optional. The aspects that are attached to the entry. Depending on how the aspect is attached to the entry, the format of the aspect key can be one of the following: If the aspect is attached directly to the entry: {project_id_or_number}.{location_id}.{aspect_type_id} If the aspect is attached to an entry's path: {project_id_or_number}.{location_id}.{aspect_type_id}@{path}
+        "a_key": { # Represents a single piece of metadata describing an entry or entry link.
+          "aspectSource": { # Information related to the source system of the aspect. # Optional. Information related to the source system of the aspect.
+            "createTime": "A String", # The time the aspect was created in the source system.
+            "dataVersion": "A String", # The version of the data format used to produce this data. This field is used to indicated when the underlying data format changes (e.g., schema modifications, changes to the source URL format definition, etc).
+            "updateTime": "A String", # The time the aspect was last updated in the source system.
+          },
+          "aspectType": "A String", # Output only. The resource name of the type used to create this Aspect.
+          "createTime": "A String", # Output only. The time when the Aspect was created.
+          "data": { # Required. The content of the aspect, according to its aspect type schema. The maximum size of the field is 120KB (encoded as UTF-8).
+            "a_key": "", # Properties of the object.
+          },
+          "path": "A String", # Output only. The path in the entry under which the aspect is attached.
+          "updateTime": "A String", # Output only. The time when the Aspect was last updated.
+        },
+      },
+      "createTime": "A String", # Output only. The time when the entry was created in Dataplex Universal Catalog.
+      "entrySource": { # Information related to the source system of the data resource that is represented by the entry. # Optional. Information related to the source system of the data resource that is represented by the entry.
+        "ancestors": [ # Immutable. The entries representing the ancestors of the data resource in the source system.
+          { # Information about individual items in the hierarchy that is associated with the data resource.
+            "name": "A String", # Optional. The name of the ancestor resource.
+            "type": "A String", # Optional. The type of the ancestor resource.
+          },
+        ],
+        "createTime": "A String", # The time when the resource was created in the source system.
+        "description": "A String", # A description of the data resource. Maximum length is 2,000 characters.
+        "displayName": "A String", # A user-friendly display name. Maximum length is 500 characters.
+        "labels": { # User-defined labels. The maximum size of keys and values is 128 characters each.
+          "a_key": "A String",
+        },
+        "location": "A String", # Output only. Location of the resource in the source system. You can search the entry by this location. By default, this should match the location of the entry group containing this entry. A different value allows capturing the source location for data external to Google Cloud.
+        "platform": "A String", # The platform containing the source system. Maximum length is 64 characters.
+        "resource": "A String", # The name of the resource in the source system. Maximum length is 4,000 characters.
+        "system": "A String", # The name of the source system. Maximum length is 64 characters.
+        "updateTime": "A String", # The time when the resource was last updated in the source system. If the entry exists in the system and its EntrySource has update_time populated, further updates to the EntrySource of the entry must provide incremental updates to its update_time.
+      },
+      "entryType": "A String", # Required. Immutable. The relative resource name of the entry type that was used to create this entry, in the format projects/{project_id_or_number}/locations/{location_id}/entryTypes/{entry_type_id}.
+      "fullyQualifiedName": "A String", # Optional. A name for the entry that can be referenced by an external system. For more information, see Fully qualified names (https://cloud.google.com/data-catalog/docs/fully-qualified-names). The maximum size of the field is 4000 characters.
+      "name": "A String", # Identifier. The relative resource name of the entry, in the format projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id}.
+      "parentEntry": "A String", # Optional. Immutable. The resource name of the parent entry, in the format projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id}.
+      "updateTime": "A String", # Output only. The time when the entry was last updated in Dataplex Universal Catalog.
+    },
+    "updateMask": "A String", # Optional. Mask of fields to update. To update Aspects, the update_mask must contain the value "aspects".If the update_mask is empty, the service will update all modifiable fields present in the request.
+  },
+  "updateGlossary": { # Update Glossary Request # Payload for updating a Glossary.
+    "glossary": { # A Glossary represents a collection of GlossaryCategories and GlossaryTerms defined by the user. Glossary is a top level resource and is the Google Cloud parent resource of all the GlossaryCategories and GlossaryTerms within it. # Required. The Glossary to update. The Glossary's name field is used to identify the Glossary to update. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}
+      "categoryCount": 42, # Output only. The number of GlossaryCategories in the Glossary.
+      "createTime": "A String", # Output only. The time at which the Glossary was created.
+      "description": "A String", # Optional. The user-mutable description of the Glossary.
+      "displayName": "A String", # Optional. User friendly display name of the Glossary. This is user-mutable. This will be same as the GlossaryId, if not specified.
+      "etag": "A String", # Optional. Needed for resource freshness validation. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.
+      "labels": { # Optional. User-defined labels for the Glossary.
+        "a_key": "A String",
+      },
+      "name": "A String", # Output only. Identifier. The resource name of the Glossary. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}
+      "termCount": 42, # Output only. The number of GlossaryTerms in the Glossary.
+      "uid": "A String", # Output only. System generated unique id for the Glossary. This ID will be different if the Glossary is deleted and re-created with the same name.
+      "updateTime": "A String", # Output only. The time at which the Glossary was last updated.
+    },
+    "updateMask": "A String", # Required. The list of fields to update.
+    "validateOnly": True or False, # Optional. Validates the request without actually updating the Glossary. Default: false.
+  },
+  "updateGlossaryCategory": { # Update GlossaryCategory Request # Payload for updating a GlossaryCategory.
+    "category": { # A GlossaryCategory represents a collection of GlossaryCategories and GlossaryTerms within a Glossary that are related to each other. # Required. The GlossaryCategory to update. The GlossaryCategory's name field is used to identify the GlossaryCategory to update. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}/categories/{category_id}
+      "createTime": "A String", # Output only. The time at which the GlossaryCategory was created.
+      "description": "A String", # Optional. The user-mutable description of the GlossaryCategory.
+      "displayName": "A String", # Optional. User friendly display name of the GlossaryCategory. This is user-mutable. This will be same as the GlossaryCategoryId, if not specified.
+      "labels": { # Optional. User-defined labels for the GlossaryCategory.
+        "a_key": "A String",
+      },
+      "name": "A String", # Output only. Identifier. The resource name of the GlossaryCategory. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}/categories/{category_id}
+      "parent": "A String", # Required. The immediate parent of the GlossaryCategory in the resource-hierarchy. It can either be a Glossary or a GlossaryCategory. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id} OR projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}/categories/{category_id}
+      "uid": "A String", # Output only. System generated unique id for the GlossaryCategory. This ID will be different if the GlossaryCategory is deleted and re-created with the same name.
+      "updateTime": "A String", # Output only. The time at which the GlossaryCategory was last updated.
+    },
+    "updateMask": "A String", # Required. The list of fields to update.
+  },
+  "updateGlossaryTerm": { # Update GlossaryTerm Request # Payload for updating a GlossaryTerm.
+    "term": { # GlossaryTerms are the core of Glossary. A GlossaryTerm holds a rich text description that can be attached to Entries or specific columns to enrich them. # Required. The GlossaryTerm to update. The GlossaryTerm's name field is used to identify the GlossaryTerm to update. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}/terms/{term_id}
+      "createTime": "A String", # Output only. The time at which the GlossaryTerm was created.
+      "description": "A String", # Optional. The user-mutable description of the GlossaryTerm.
+      "displayName": "A String", # Optional. User friendly display name of the GlossaryTerm. This is user-mutable. This will be same as the GlossaryTermId, if not specified.
+      "labels": { # Optional. User-defined labels for the GlossaryTerm.
+        "a_key": "A String",
+      },
+      "name": "A String", # Output only. Identifier. The resource name of the GlossaryTerm. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}/terms/{term_id}
+      "parent": "A String", # Required. The immediate parent of the GlossaryTerm in the resource-hierarchy. It can either be a Glossary or a GlossaryCategory. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id} OR projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}/categories/{category_id}
+      "uid": "A String", # Output only. System generated unique id for the GlossaryTerm. This ID will be different if the GlossaryTerm is deleted and re-created with the same name.
+      "updateTime": "A String", # Output only. The time at which the GlossaryTerm was last updated.
+    },
+    "updateMask": "A String", # Required. The list of fields to update.
+  },
+  "updateTime": "A String", # Output only. The time when the ChangeRequest was last updated.
+}
+
+
getIamPolicy(resource, options_requestedPolicyVersion=None, x__xgafv=None)
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
@@ -140,6 +757,1169 @@ 

Method Details

}
+
+ list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None) +
Lists ChangeRequests.
+
+Args:
+  parent: string, Required. The parent, which owns this collection of ChangeRequests. Format: projects/{project_number}/locations/{location_id} (required)
+  filter: string, Optional. Filter request. Supports filtering by: state, author, resource, create_time, update_time.
+  orderBy: string, Optional. Order by fields for the result.
+  pageSize: integer, Optional. Maximum number of ChangeRequests to return. The service may return fewer.
+  pageToken: string, Optional. Page token received from a previous ListChangeRequests call.
+  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 ListChangeRequests.
+  "changeRequests": [ # The ChangeRequests from the specified project and location.
+    { # Represents a proposed change to a metadata resource.
+      "approver": "A String", # Output only. The email address of the user who approved/rejected the ChangeRequest.
+      "author": "A String", # Output only. The email address of the user who created the ChangeRequest.
+      "changeType": "A String", # Output only. The type of change represented by the change_payload. This field is derived from the populated field in the change_payload oneof.
+      "createEntry": { # Create Entry request. # Payload for creating an Entry.
+        "entry": { # An entry is a representation of a data resource that can be described by various metadata. # Required. Entry resource.
+          "aspects": { # Optional. The aspects that are attached to the entry. Depending on how the aspect is attached to the entry, the format of the aspect key can be one of the following: If the aspect is attached directly to the entry: {project_id_or_number}.{location_id}.{aspect_type_id} If the aspect is attached to an entry's path: {project_id_or_number}.{location_id}.{aspect_type_id}@{path}
+            "a_key": { # Represents a single piece of metadata describing an entry or entry link.
+              "aspectSource": { # Information related to the source system of the aspect. # Optional. Information related to the source system of the aspect.
+                "createTime": "A String", # The time the aspect was created in the source system.
+                "dataVersion": "A String", # The version of the data format used to produce this data. This field is used to indicated when the underlying data format changes (e.g., schema modifications, changes to the source URL format definition, etc).
+                "updateTime": "A String", # The time the aspect was last updated in the source system.
+              },
+              "aspectType": "A String", # Output only. The resource name of the type used to create this Aspect.
+              "createTime": "A String", # Output only. The time when the Aspect was created.
+              "data": { # Required. The content of the aspect, according to its aspect type schema. The maximum size of the field is 120KB (encoded as UTF-8).
+                "a_key": "", # Properties of the object.
+              },
+              "path": "A String", # Output only. The path in the entry under which the aspect is attached.
+              "updateTime": "A String", # Output only. The time when the Aspect was last updated.
+            },
+          },
+          "createTime": "A String", # Output only. The time when the entry was created in Dataplex Universal Catalog.
+          "entrySource": { # Information related to the source system of the data resource that is represented by the entry. # Optional. Information related to the source system of the data resource that is represented by the entry.
+            "ancestors": [ # Immutable. The entries representing the ancestors of the data resource in the source system.
+              { # Information about individual items in the hierarchy that is associated with the data resource.
+                "name": "A String", # Optional. The name of the ancestor resource.
+                "type": "A String", # Optional. The type of the ancestor resource.
+              },
+            ],
+            "createTime": "A String", # The time when the resource was created in the source system.
+            "description": "A String", # A description of the data resource. Maximum length is 2,000 characters.
+            "displayName": "A String", # A user-friendly display name. Maximum length is 500 characters.
+            "labels": { # User-defined labels. The maximum size of keys and values is 128 characters each.
+              "a_key": "A String",
+            },
+            "location": "A String", # Output only. Location of the resource in the source system. You can search the entry by this location. By default, this should match the location of the entry group containing this entry. A different value allows capturing the source location for data external to Google Cloud.
+            "platform": "A String", # The platform containing the source system. Maximum length is 64 characters.
+            "resource": "A String", # The name of the resource in the source system. Maximum length is 4,000 characters.
+            "system": "A String", # The name of the source system. Maximum length is 64 characters.
+            "updateTime": "A String", # The time when the resource was last updated in the source system. If the entry exists in the system and its EntrySource has update_time populated, further updates to the EntrySource of the entry must provide incremental updates to its update_time.
+          },
+          "entryType": "A String", # Required. Immutable. The relative resource name of the entry type that was used to create this entry, in the format projects/{project_id_or_number}/locations/{location_id}/entryTypes/{entry_type_id}.
+          "fullyQualifiedName": "A String", # Optional. A name for the entry that can be referenced by an external system. For more information, see Fully qualified names (https://cloud.google.com/data-catalog/docs/fully-qualified-names). The maximum size of the field is 4000 characters.
+          "name": "A String", # Identifier. The relative resource name of the entry, in the format projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id}.
+          "parentEntry": "A String", # Optional. Immutable. The resource name of the parent entry, in the format projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id}.
+          "updateTime": "A String", # Output only. The time when the entry was last updated in Dataplex Universal Catalog.
+        },
+        "entryId": "A String", # Required. Entry identifier. It has to be unique within an Entry Group.Entries corresponding to Google Cloud resources use an Entry ID format based on full resource names (https://cloud.google.com/apis/design/resource_names#full_resource_name). The format is a full resource name of the resource without the prefix double slashes in the API service name part of the full resource name. This allows retrieval of entries using their associated resource name.For example, if the full resource name of a resource is //library.googleapis.com/shelves/shelf1/books/book2, then the suggested entry_id is library.googleapis.com/shelves/shelf1/books/book2.It is also suggested to follow the same convention for entries corresponding to resources from providers or systems other than Google Cloud.The maximum size of the field is 4000 characters.
+        "parent": "A String", # Required. The resource name of the parent Entry Group: projects/{project}/locations/{location}/entryGroups/{entry_group}.
+      },
+      "createEntryLink": { # Request message for CreateEntryLink. # Payload for creating an EntryLink.
+        "entryLink": { # EntryLink represents a link between two Entries. # Required. Entry Link resource.
+          "aspects": { # Optional. The aspects that are attached to the entry link. The format of the aspect key has to be the following: {project_id_or_number}.{location_id}.{aspect_type_id} Currently, only a single aspect of a Dataplex-owned Aspect Type is allowed.
+            "a_key": { # Represents a single piece of metadata describing an entry or entry link.
+              "aspectSource": { # Information related to the source system of the aspect. # Optional. Information related to the source system of the aspect.
+                "createTime": "A String", # The time the aspect was created in the source system.
+                "dataVersion": "A String", # The version of the data format used to produce this data. This field is used to indicated when the underlying data format changes (e.g., schema modifications, changes to the source URL format definition, etc).
+                "updateTime": "A String", # The time the aspect was last updated in the source system.
+              },
+              "aspectType": "A String", # Output only. The resource name of the type used to create this Aspect.
+              "createTime": "A String", # Output only. The time when the Aspect was created.
+              "data": { # Required. The content of the aspect, according to its aspect type schema. The maximum size of the field is 120KB (encoded as UTF-8).
+                "a_key": "", # Properties of the object.
+              },
+              "path": "A String", # Output only. The path in the entry under which the aspect is attached.
+              "updateTime": "A String", # Output only. The time when the Aspect was last updated.
+            },
+          },
+          "createTime": "A String", # Output only. The time when the Entry Link was created.
+          "entryLinkType": "A String", # Required. Immutable. Relative resource name of the Entry Link Type used to create this Entry Link. For example: Entry link between synonym terms in a glossary: projects/dataplex-types/locations/global/entryLinkTypes/synonym Entry link between related terms in a glossary: projects/dataplex-types/locations/global/entryLinkTypes/related Entry link between glossary terms and data assets: projects/dataplex-types/locations/global/entryLinkTypes/definition
+          "entryReferences": [ # Required. Immutable. Specifies the Entries referenced in the Entry Link. There should be exactly two entry references.
+            { # Reference to the Entry that is linked through the Entry Link.
+              "name": "A String", # Required. Immutable. The relative resource name of the referenced Entry, of the form: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id}
+              "path": "A String", # Immutable. The path in the Entry that is referenced in the Entry Link. Empty path denotes that the Entry itself is referenced in the Entry Link.
+              "type": "A String", # Required. Immutable. The reference type of the Entry.
+            },
+          ],
+          "name": "A String", # Output only. Immutable. Identifier. The relative resource name of the Entry Link, of the form: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entryLinks/{entry_link_id}
+          "updateTime": "A String", # Output only. The time when the Entry Link was last updated.
+        },
+        "entryLinkId": "A String", # Required. Entry Link identifier * Must contain only lowercase letters, numbers and hyphens. * Must start with a letter. * Must be between 1-63 characters. * Must end with a number or a letter. * Must be unique within the EntryGroup.
+        "parent": "A String", # Required. The resource name of the parent Entry Group: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}.
+      },
+      "createGlossary": { # Create Glossary Request # Payload for creating a Glossary.
+        "glossary": { # A Glossary represents a collection of GlossaryCategories and GlossaryTerms defined by the user. Glossary is a top level resource and is the Google Cloud parent resource of all the GlossaryCategories and GlossaryTerms within it. # Required. The Glossary to create.
+          "categoryCount": 42, # Output only. The number of GlossaryCategories in the Glossary.
+          "createTime": "A String", # Output only. The time at which the Glossary was created.
+          "description": "A String", # Optional. The user-mutable description of the Glossary.
+          "displayName": "A String", # Optional. User friendly display name of the Glossary. This is user-mutable. This will be same as the GlossaryId, if not specified.
+          "etag": "A String", # Optional. Needed for resource freshness validation. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.
+          "labels": { # Optional. User-defined labels for the Glossary.
+            "a_key": "A String",
+          },
+          "name": "A String", # Output only. Identifier. The resource name of the Glossary. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}
+          "termCount": 42, # Output only. The number of GlossaryTerms in the Glossary.
+          "uid": "A String", # Output only. System generated unique id for the Glossary. This ID will be different if the Glossary is deleted and re-created with the same name.
+          "updateTime": "A String", # Output only. The time at which the Glossary was last updated.
+        },
+        "glossaryId": "A String", # Required. Glossary ID: Glossary identifier.
+        "parent": "A String", # Required. The parent resource where this Glossary will be created. Format: projects/{project_id_or_number}/locations/{location_id} where location_id refers to a Google Cloud region.
+        "validateOnly": True or False, # Optional. Validates the request without actually creating the Glossary. Default: false.
+      },
+      "createGlossaryCategory": { # Creates a new GlossaryCategory under the specified Glossary. # Payload for creating a GlossaryCategory.
+        "category": { # A GlossaryCategory represents a collection of GlossaryCategories and GlossaryTerms within a Glossary that are related to each other. # Required. The GlossaryCategory to create.
+          "createTime": "A String", # Output only. The time at which the GlossaryCategory was created.
+          "description": "A String", # Optional. The user-mutable description of the GlossaryCategory.
+          "displayName": "A String", # Optional. User friendly display name of the GlossaryCategory. This is user-mutable. This will be same as the GlossaryCategoryId, if not specified.
+          "labels": { # Optional. User-defined labels for the GlossaryCategory.
+            "a_key": "A String",
+          },
+          "name": "A String", # Output only. Identifier. The resource name of the GlossaryCategory. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}/categories/{category_id}
+          "parent": "A String", # Required. The immediate parent of the GlossaryCategory in the resource-hierarchy. It can either be a Glossary or a GlossaryCategory. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id} OR projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}/categories/{category_id}
+          "uid": "A String", # Output only. System generated unique id for the GlossaryCategory. This ID will be different if the GlossaryCategory is deleted and re-created with the same name.
+          "updateTime": "A String", # Output only. The time at which the GlossaryCategory was last updated.
+        },
+        "categoryId": "A String", # Required. GlossaryCategory identifier.
+        "parent": "A String", # Required. The parent resource where this GlossaryCategory will be created. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id} where locationId refers to a Google Cloud region.
+      },
+      "createGlossaryTerm": { # Creates a new GlossaryTerm under the specified Glossary. # Payload for creating a GlossaryTerm.
+        "parent": "A String", # Required. The parent resource where the GlossaryTerm will be created. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id} where location_id refers to a Google Cloud region.
+        "term": { # GlossaryTerms are the core of Glossary. A GlossaryTerm holds a rich text description that can be attached to Entries or specific columns to enrich them. # Required. The GlossaryTerm to create.
+          "createTime": "A String", # Output only. The time at which the GlossaryTerm was created.
+          "description": "A String", # Optional. The user-mutable description of the GlossaryTerm.
+          "displayName": "A String", # Optional. User friendly display name of the GlossaryTerm. This is user-mutable. This will be same as the GlossaryTermId, if not specified.
+          "labels": { # Optional. User-defined labels for the GlossaryTerm.
+            "a_key": "A String",
+          },
+          "name": "A String", # Output only. Identifier. The resource name of the GlossaryTerm. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}/terms/{term_id}
+          "parent": "A String", # Required. The immediate parent of the GlossaryTerm in the resource-hierarchy. It can either be a Glossary or a GlossaryCategory. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id} OR projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}/categories/{category_id}
+          "uid": "A String", # Output only. System generated unique id for the GlossaryTerm. This ID will be different if the GlossaryTerm is deleted and re-created with the same name.
+          "updateTime": "A String", # Output only. The time at which the GlossaryTerm was last updated.
+        },
+        "termId": "A String", # Required. GlossaryTerm identifier.
+      },
+      "createTime": "A String", # Output only. The time when the ChangeRequest was created.
+      "dataProductAccessRequest": { # Message for requesting access to a Data Product. This will be used to create a ChangeRequest of type REQUEST_DATA_PRODUCT_ACCESS. # Payload for Data Product access request.
+        "accessGroupDisplayName": "A String", # Output only. The display name of the access group defined in the Data Product for which access is being requested.
+        "accessGroupId": "A String", # Required. The ID of the access group for which access is being requested. This corresponds to the unique identifier of the AccessGroup defined in the Data Product.
+        "parent": "A String", # Required. The resource name of the data product. Format: projects/{project_number}/locations/{location_id}/dataProducts/{data_product_id}
+        "requestedPrincipal": "A String", # Optional. The principal for which access is being requested in IAM format. If not specified, the requestor's principal will be used. Example: serviceAccount:my-sa@my-project.iam.gserviceaccount.com. Only service account principals are currently supported. https://cloud.google.com/iam/docs/principal-identifiers
+      },
+      "deleteEntry": { # Delete Entry request. # Payload for deleting an Entry.
+        "name": "A String", # Required. The resource name of the Entry: projects/{project}/locations/{location}/entryGroups/{entry_group}/entries/{entry}.
+      },
+      "deleteEntryLink": { # Request message for DeleteEntryLink. # Payload for deleting an EntryLink.
+        "name": "A String", # Required. The resource name of the Entry Link: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entryLinks/{entry_link_id}.
+      },
+      "deleteGlossary": { # Delete Glossary Request # Payload for deleting a Glossary.
+        "etag": "A String", # Optional. The etag of the Glossary. If this is provided, it must match the server's etag. If the etag is provided and does not match the server-computed etag, the request must fail with a ABORTED error code.
+        "name": "A String", # Required. The name of the Glossary to delete. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}
+      },
+      "deleteGlossaryCategory": { # Delete GlossaryCategory Request # Payload for deleting a GlossaryCategory.
+        "name": "A String", # Required. The name of the GlossaryCategory to delete. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}/categories/{category_id}
+      },
+      "deleteGlossaryTerm": { # Delete GlossaryTerm Request # Payload for deleting a GlossaryTerm.
+        "name": "A String", # Required. The name of the GlossaryTerm to delete. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}/terms/{term_id}
+      },
+      "etag": "A String", # Optional. This checksum is computed by the service. It can be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.
+      "justification": "A String", # Optional. Justification of the ChangeRequest. This should explain why the change is needed or why it should be approved.
+      "labels": { # Optional. User-defined labels for the ChangeRequest.
+        "a_key": "A String",
+      },
+      "name": "A String", # Identifier. The relative resource name of the ChangeRequest, of the form: projects/{project_number}/locations/{location_id}/changeRequests/{change_request_id}
+      "rejectionComment": "A String", # Output only. The reason provided for rejecting the ChangeRequest.
+      "resource": "A String", # Output only. The full resource name of the target resource to be modified. Example: //dataplex.googleapis.com/projects/my-project/locations/us-central1/entryGroups/my-group/entries/my-entry
+      "state": "A String", # Output only. The current state of the ChangeRequest.
+      "uid": "A String", # Output only. System generated globally unique ID for the ChangeRequest.
+      "updateEntry": { # Update Entry request. # Payload for updating an Entry.
+        "allowMissing": True or False, # Optional. If set to true and the entry doesn't exist, the service will create it.
+        "aspectKeys": [ # Optional. The map keys of the Aspects which the service should modify. It supports the following syntaxes: - matches an aspect of the given type and empty path. @path - matches an aspect of the given type and specified path. For example, to attach an aspect to a field that is specified by the schema aspect, the path should have the format Schema.. @* - matches aspects of the given type for all paths. *@path - matches aspects of all types on the given path.The service will not remove existing aspects matching the syntax unless delete_missing_aspects is set to true.If this field is left empty, the service treats it as specifying exactly those Aspects present in the request.
+          "A String",
+        ],
+        "deleteMissingAspects": True or False, # Optional. If set to true and the aspect_keys specify aspect ranges, the service deletes any existing aspects from that range that weren't provided in the request.
+        "entry": { # An entry is a representation of a data resource that can be described by various metadata. # Required. Entry resource.
+          "aspects": { # Optional. The aspects that are attached to the entry. Depending on how the aspect is attached to the entry, the format of the aspect key can be one of the following: If the aspect is attached directly to the entry: {project_id_or_number}.{location_id}.{aspect_type_id} If the aspect is attached to an entry's path: {project_id_or_number}.{location_id}.{aspect_type_id}@{path}
+            "a_key": { # Represents a single piece of metadata describing an entry or entry link.
+              "aspectSource": { # Information related to the source system of the aspect. # Optional. Information related to the source system of the aspect.
+                "createTime": "A String", # The time the aspect was created in the source system.
+                "dataVersion": "A String", # The version of the data format used to produce this data. This field is used to indicated when the underlying data format changes (e.g., schema modifications, changes to the source URL format definition, etc).
+                "updateTime": "A String", # The time the aspect was last updated in the source system.
+              },
+              "aspectType": "A String", # Output only. The resource name of the type used to create this Aspect.
+              "createTime": "A String", # Output only. The time when the Aspect was created.
+              "data": { # Required. The content of the aspect, according to its aspect type schema. The maximum size of the field is 120KB (encoded as UTF-8).
+                "a_key": "", # Properties of the object.
+              },
+              "path": "A String", # Output only. The path in the entry under which the aspect is attached.
+              "updateTime": "A String", # Output only. The time when the Aspect was last updated.
+            },
+          },
+          "createTime": "A String", # Output only. The time when the entry was created in Dataplex Universal Catalog.
+          "entrySource": { # Information related to the source system of the data resource that is represented by the entry. # Optional. Information related to the source system of the data resource that is represented by the entry.
+            "ancestors": [ # Immutable. The entries representing the ancestors of the data resource in the source system.
+              { # Information about individual items in the hierarchy that is associated with the data resource.
+                "name": "A String", # Optional. The name of the ancestor resource.
+                "type": "A String", # Optional. The type of the ancestor resource.
+              },
+            ],
+            "createTime": "A String", # The time when the resource was created in the source system.
+            "description": "A String", # A description of the data resource. Maximum length is 2,000 characters.
+            "displayName": "A String", # A user-friendly display name. Maximum length is 500 characters.
+            "labels": { # User-defined labels. The maximum size of keys and values is 128 characters each.
+              "a_key": "A String",
+            },
+            "location": "A String", # Output only. Location of the resource in the source system. You can search the entry by this location. By default, this should match the location of the entry group containing this entry. A different value allows capturing the source location for data external to Google Cloud.
+            "platform": "A String", # The platform containing the source system. Maximum length is 64 characters.
+            "resource": "A String", # The name of the resource in the source system. Maximum length is 4,000 characters.
+            "system": "A String", # The name of the source system. Maximum length is 64 characters.
+            "updateTime": "A String", # The time when the resource was last updated in the source system. If the entry exists in the system and its EntrySource has update_time populated, further updates to the EntrySource of the entry must provide incremental updates to its update_time.
+          },
+          "entryType": "A String", # Required. Immutable. The relative resource name of the entry type that was used to create this entry, in the format projects/{project_id_or_number}/locations/{location_id}/entryTypes/{entry_type_id}.
+          "fullyQualifiedName": "A String", # Optional. A name for the entry that can be referenced by an external system. For more information, see Fully qualified names (https://cloud.google.com/data-catalog/docs/fully-qualified-names). The maximum size of the field is 4000 characters.
+          "name": "A String", # Identifier. The relative resource name of the entry, in the format projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id}.
+          "parentEntry": "A String", # Optional. Immutable. The resource name of the parent entry, in the format projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id}.
+          "updateTime": "A String", # Output only. The time when the entry was last updated in Dataplex Universal Catalog.
+        },
+        "updateMask": "A String", # Optional. Mask of fields to update. To update Aspects, the update_mask must contain the value "aspects".If the update_mask is empty, the service will update all modifiable fields present in the request.
+      },
+      "updateGlossary": { # Update Glossary Request # Payload for updating a Glossary.
+        "glossary": { # A Glossary represents a collection of GlossaryCategories and GlossaryTerms defined by the user. Glossary is a top level resource and is the Google Cloud parent resource of all the GlossaryCategories and GlossaryTerms within it. # Required. The Glossary to update. The Glossary's name field is used to identify the Glossary to update. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}
+          "categoryCount": 42, # Output only. The number of GlossaryCategories in the Glossary.
+          "createTime": "A String", # Output only. The time at which the Glossary was created.
+          "description": "A String", # Optional. The user-mutable description of the Glossary.
+          "displayName": "A String", # Optional. User friendly display name of the Glossary. This is user-mutable. This will be same as the GlossaryId, if not specified.
+          "etag": "A String", # Optional. Needed for resource freshness validation. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.
+          "labels": { # Optional. User-defined labels for the Glossary.
+            "a_key": "A String",
+          },
+          "name": "A String", # Output only. Identifier. The resource name of the Glossary. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}
+          "termCount": 42, # Output only. The number of GlossaryTerms in the Glossary.
+          "uid": "A String", # Output only. System generated unique id for the Glossary. This ID will be different if the Glossary is deleted and re-created with the same name.
+          "updateTime": "A String", # Output only. The time at which the Glossary was last updated.
+        },
+        "updateMask": "A String", # Required. The list of fields to update.
+        "validateOnly": True or False, # Optional. Validates the request without actually updating the Glossary. Default: false.
+      },
+      "updateGlossaryCategory": { # Update GlossaryCategory Request # Payload for updating a GlossaryCategory.
+        "category": { # A GlossaryCategory represents a collection of GlossaryCategories and GlossaryTerms within a Glossary that are related to each other. # Required. The GlossaryCategory to update. The GlossaryCategory's name field is used to identify the GlossaryCategory to update. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}/categories/{category_id}
+          "createTime": "A String", # Output only. The time at which the GlossaryCategory was created.
+          "description": "A String", # Optional. The user-mutable description of the GlossaryCategory.
+          "displayName": "A String", # Optional. User friendly display name of the GlossaryCategory. This is user-mutable. This will be same as the GlossaryCategoryId, if not specified.
+          "labels": { # Optional. User-defined labels for the GlossaryCategory.
+            "a_key": "A String",
+          },
+          "name": "A String", # Output only. Identifier. The resource name of the GlossaryCategory. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}/categories/{category_id}
+          "parent": "A String", # Required. The immediate parent of the GlossaryCategory in the resource-hierarchy. It can either be a Glossary or a GlossaryCategory. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id} OR projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}/categories/{category_id}
+          "uid": "A String", # Output only. System generated unique id for the GlossaryCategory. This ID will be different if the GlossaryCategory is deleted and re-created with the same name.
+          "updateTime": "A String", # Output only. The time at which the GlossaryCategory was last updated.
+        },
+        "updateMask": "A String", # Required. The list of fields to update.
+      },
+      "updateGlossaryTerm": { # Update GlossaryTerm Request # Payload for updating a GlossaryTerm.
+        "term": { # GlossaryTerms are the core of Glossary. A GlossaryTerm holds a rich text description that can be attached to Entries or specific columns to enrich them. # Required. The GlossaryTerm to update. The GlossaryTerm's name field is used to identify the GlossaryTerm to update. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}/terms/{term_id}
+          "createTime": "A String", # Output only. The time at which the GlossaryTerm was created.
+          "description": "A String", # Optional. The user-mutable description of the GlossaryTerm.
+          "displayName": "A String", # Optional. User friendly display name of the GlossaryTerm. This is user-mutable. This will be same as the GlossaryTermId, if not specified.
+          "labels": { # Optional. User-defined labels for the GlossaryTerm.
+            "a_key": "A String",
+          },
+          "name": "A String", # Output only. Identifier. The resource name of the GlossaryTerm. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}/terms/{term_id}
+          "parent": "A String", # Required. The immediate parent of the GlossaryTerm in the resource-hierarchy. It can either be a Glossary or a GlossaryCategory. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id} OR projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}/categories/{category_id}
+          "uid": "A String", # Output only. System generated unique id for the GlossaryTerm. This ID will be different if the GlossaryTerm is deleted and re-created with the same name.
+          "updateTime": "A String", # Output only. The time at which the GlossaryTerm was last updated.
+        },
+        "updateMask": "A String", # Required. The list of fields to update.
+      },
+      "updateTime": "A String", # Output only. The time when the ChangeRequest was last updated.
+    },
+  ],
+  "nextPageToken": "A String", # A token, which can be sent as page_token to retrieve the next page.
+  "unreachable": [ # Locations that could not be reached.
+    "A String",
+  ],
+}
+
+ +
+ list_next() +
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+        
+
+ +
+ patch(name, body=None, updateMask=None, x__xgafv=None) +
Updates a ChangeRequest. Only allowed when the state is NEW.
+
+Args:
+  name: string, Identifier. The relative resource name of the ChangeRequest, of the form: projects/{project_number}/locations/{location_id}/changeRequests/{change_request_id} (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Represents a proposed change to a metadata resource.
+  "approver": "A String", # Output only. The email address of the user who approved/rejected the ChangeRequest.
+  "author": "A String", # Output only. The email address of the user who created the ChangeRequest.
+  "changeType": "A String", # Output only. The type of change represented by the change_payload. This field is derived from the populated field in the change_payload oneof.
+  "createEntry": { # Create Entry request. # Payload for creating an Entry.
+    "entry": { # An entry is a representation of a data resource that can be described by various metadata. # Required. Entry resource.
+      "aspects": { # Optional. The aspects that are attached to the entry. Depending on how the aspect is attached to the entry, the format of the aspect key can be one of the following: If the aspect is attached directly to the entry: {project_id_or_number}.{location_id}.{aspect_type_id} If the aspect is attached to an entry's path: {project_id_or_number}.{location_id}.{aspect_type_id}@{path}
+        "a_key": { # Represents a single piece of metadata describing an entry or entry link.
+          "aspectSource": { # Information related to the source system of the aspect. # Optional. Information related to the source system of the aspect.
+            "createTime": "A String", # The time the aspect was created in the source system.
+            "dataVersion": "A String", # The version of the data format used to produce this data. This field is used to indicated when the underlying data format changes (e.g., schema modifications, changes to the source URL format definition, etc).
+            "updateTime": "A String", # The time the aspect was last updated in the source system.
+          },
+          "aspectType": "A String", # Output only. The resource name of the type used to create this Aspect.
+          "createTime": "A String", # Output only. The time when the Aspect was created.
+          "data": { # Required. The content of the aspect, according to its aspect type schema. The maximum size of the field is 120KB (encoded as UTF-8).
+            "a_key": "", # Properties of the object.
+          },
+          "path": "A String", # Output only. The path in the entry under which the aspect is attached.
+          "updateTime": "A String", # Output only. The time when the Aspect was last updated.
+        },
+      },
+      "createTime": "A String", # Output only. The time when the entry was created in Dataplex Universal Catalog.
+      "entrySource": { # Information related to the source system of the data resource that is represented by the entry. # Optional. Information related to the source system of the data resource that is represented by the entry.
+        "ancestors": [ # Immutable. The entries representing the ancestors of the data resource in the source system.
+          { # Information about individual items in the hierarchy that is associated with the data resource.
+            "name": "A String", # Optional. The name of the ancestor resource.
+            "type": "A String", # Optional. The type of the ancestor resource.
+          },
+        ],
+        "createTime": "A String", # The time when the resource was created in the source system.
+        "description": "A String", # A description of the data resource. Maximum length is 2,000 characters.
+        "displayName": "A String", # A user-friendly display name. Maximum length is 500 characters.
+        "labels": { # User-defined labels. The maximum size of keys and values is 128 characters each.
+          "a_key": "A String",
+        },
+        "location": "A String", # Output only. Location of the resource in the source system. You can search the entry by this location. By default, this should match the location of the entry group containing this entry. A different value allows capturing the source location for data external to Google Cloud.
+        "platform": "A String", # The platform containing the source system. Maximum length is 64 characters.
+        "resource": "A String", # The name of the resource in the source system. Maximum length is 4,000 characters.
+        "system": "A String", # The name of the source system. Maximum length is 64 characters.
+        "updateTime": "A String", # The time when the resource was last updated in the source system. If the entry exists in the system and its EntrySource has update_time populated, further updates to the EntrySource of the entry must provide incremental updates to its update_time.
+      },
+      "entryType": "A String", # Required. Immutable. The relative resource name of the entry type that was used to create this entry, in the format projects/{project_id_or_number}/locations/{location_id}/entryTypes/{entry_type_id}.
+      "fullyQualifiedName": "A String", # Optional. A name for the entry that can be referenced by an external system. For more information, see Fully qualified names (https://cloud.google.com/data-catalog/docs/fully-qualified-names). The maximum size of the field is 4000 characters.
+      "name": "A String", # Identifier. The relative resource name of the entry, in the format projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id}.
+      "parentEntry": "A String", # Optional. Immutable. The resource name of the parent entry, in the format projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id}.
+      "updateTime": "A String", # Output only. The time when the entry was last updated in Dataplex Universal Catalog.
+    },
+    "entryId": "A String", # Required. Entry identifier. It has to be unique within an Entry Group.Entries corresponding to Google Cloud resources use an Entry ID format based on full resource names (https://cloud.google.com/apis/design/resource_names#full_resource_name). The format is a full resource name of the resource without the prefix double slashes in the API service name part of the full resource name. This allows retrieval of entries using their associated resource name.For example, if the full resource name of a resource is //library.googleapis.com/shelves/shelf1/books/book2, then the suggested entry_id is library.googleapis.com/shelves/shelf1/books/book2.It is also suggested to follow the same convention for entries corresponding to resources from providers or systems other than Google Cloud.The maximum size of the field is 4000 characters.
+    "parent": "A String", # Required. The resource name of the parent Entry Group: projects/{project}/locations/{location}/entryGroups/{entry_group}.
+  },
+  "createEntryLink": { # Request message for CreateEntryLink. # Payload for creating an EntryLink.
+    "entryLink": { # EntryLink represents a link between two Entries. # Required. Entry Link resource.
+      "aspects": { # Optional. The aspects that are attached to the entry link. The format of the aspect key has to be the following: {project_id_or_number}.{location_id}.{aspect_type_id} Currently, only a single aspect of a Dataplex-owned Aspect Type is allowed.
+        "a_key": { # Represents a single piece of metadata describing an entry or entry link.
+          "aspectSource": { # Information related to the source system of the aspect. # Optional. Information related to the source system of the aspect.
+            "createTime": "A String", # The time the aspect was created in the source system.
+            "dataVersion": "A String", # The version of the data format used to produce this data. This field is used to indicated when the underlying data format changes (e.g., schema modifications, changes to the source URL format definition, etc).
+            "updateTime": "A String", # The time the aspect was last updated in the source system.
+          },
+          "aspectType": "A String", # Output only. The resource name of the type used to create this Aspect.
+          "createTime": "A String", # Output only. The time when the Aspect was created.
+          "data": { # Required. The content of the aspect, according to its aspect type schema. The maximum size of the field is 120KB (encoded as UTF-8).
+            "a_key": "", # Properties of the object.
+          },
+          "path": "A String", # Output only. The path in the entry under which the aspect is attached.
+          "updateTime": "A String", # Output only. The time when the Aspect was last updated.
+        },
+      },
+      "createTime": "A String", # Output only. The time when the Entry Link was created.
+      "entryLinkType": "A String", # Required. Immutable. Relative resource name of the Entry Link Type used to create this Entry Link. For example: Entry link between synonym terms in a glossary: projects/dataplex-types/locations/global/entryLinkTypes/synonym Entry link between related terms in a glossary: projects/dataplex-types/locations/global/entryLinkTypes/related Entry link between glossary terms and data assets: projects/dataplex-types/locations/global/entryLinkTypes/definition
+      "entryReferences": [ # Required. Immutable. Specifies the Entries referenced in the Entry Link. There should be exactly two entry references.
+        { # Reference to the Entry that is linked through the Entry Link.
+          "name": "A String", # Required. Immutable. The relative resource name of the referenced Entry, of the form: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id}
+          "path": "A String", # Immutable. The path in the Entry that is referenced in the Entry Link. Empty path denotes that the Entry itself is referenced in the Entry Link.
+          "type": "A String", # Required. Immutable. The reference type of the Entry.
+        },
+      ],
+      "name": "A String", # Output only. Immutable. Identifier. The relative resource name of the Entry Link, of the form: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entryLinks/{entry_link_id}
+      "updateTime": "A String", # Output only. The time when the Entry Link was last updated.
+    },
+    "entryLinkId": "A String", # Required. Entry Link identifier * Must contain only lowercase letters, numbers and hyphens. * Must start with a letter. * Must be between 1-63 characters. * Must end with a number or a letter. * Must be unique within the EntryGroup.
+    "parent": "A String", # Required. The resource name of the parent Entry Group: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}.
+  },
+  "createGlossary": { # Create Glossary Request # Payload for creating a Glossary.
+    "glossary": { # A Glossary represents a collection of GlossaryCategories and GlossaryTerms defined by the user. Glossary is a top level resource and is the Google Cloud parent resource of all the GlossaryCategories and GlossaryTerms within it. # Required. The Glossary to create.
+      "categoryCount": 42, # Output only. The number of GlossaryCategories in the Glossary.
+      "createTime": "A String", # Output only. The time at which the Glossary was created.
+      "description": "A String", # Optional. The user-mutable description of the Glossary.
+      "displayName": "A String", # Optional. User friendly display name of the Glossary. This is user-mutable. This will be same as the GlossaryId, if not specified.
+      "etag": "A String", # Optional. Needed for resource freshness validation. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.
+      "labels": { # Optional. User-defined labels for the Glossary.
+        "a_key": "A String",
+      },
+      "name": "A String", # Output only. Identifier. The resource name of the Glossary. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}
+      "termCount": 42, # Output only. The number of GlossaryTerms in the Glossary.
+      "uid": "A String", # Output only. System generated unique id for the Glossary. This ID will be different if the Glossary is deleted and re-created with the same name.
+      "updateTime": "A String", # Output only. The time at which the Glossary was last updated.
+    },
+    "glossaryId": "A String", # Required. Glossary ID: Glossary identifier.
+    "parent": "A String", # Required. The parent resource where this Glossary will be created. Format: projects/{project_id_or_number}/locations/{location_id} where location_id refers to a Google Cloud region.
+    "validateOnly": True or False, # Optional. Validates the request without actually creating the Glossary. Default: false.
+  },
+  "createGlossaryCategory": { # Creates a new GlossaryCategory under the specified Glossary. # Payload for creating a GlossaryCategory.
+    "category": { # A GlossaryCategory represents a collection of GlossaryCategories and GlossaryTerms within a Glossary that are related to each other. # Required. The GlossaryCategory to create.
+      "createTime": "A String", # Output only. The time at which the GlossaryCategory was created.
+      "description": "A String", # Optional. The user-mutable description of the GlossaryCategory.
+      "displayName": "A String", # Optional. User friendly display name of the GlossaryCategory. This is user-mutable. This will be same as the GlossaryCategoryId, if not specified.
+      "labels": { # Optional. User-defined labels for the GlossaryCategory.
+        "a_key": "A String",
+      },
+      "name": "A String", # Output only. Identifier. The resource name of the GlossaryCategory. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}/categories/{category_id}
+      "parent": "A String", # Required. The immediate parent of the GlossaryCategory in the resource-hierarchy. It can either be a Glossary or a GlossaryCategory. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id} OR projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}/categories/{category_id}
+      "uid": "A String", # Output only. System generated unique id for the GlossaryCategory. This ID will be different if the GlossaryCategory is deleted and re-created with the same name.
+      "updateTime": "A String", # Output only. The time at which the GlossaryCategory was last updated.
+    },
+    "categoryId": "A String", # Required. GlossaryCategory identifier.
+    "parent": "A String", # Required. The parent resource where this GlossaryCategory will be created. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id} where locationId refers to a Google Cloud region.
+  },
+  "createGlossaryTerm": { # Creates a new GlossaryTerm under the specified Glossary. # Payload for creating a GlossaryTerm.
+    "parent": "A String", # Required. The parent resource where the GlossaryTerm will be created. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id} where location_id refers to a Google Cloud region.
+    "term": { # GlossaryTerms are the core of Glossary. A GlossaryTerm holds a rich text description that can be attached to Entries or specific columns to enrich them. # Required. The GlossaryTerm to create.
+      "createTime": "A String", # Output only. The time at which the GlossaryTerm was created.
+      "description": "A String", # Optional. The user-mutable description of the GlossaryTerm.
+      "displayName": "A String", # Optional. User friendly display name of the GlossaryTerm. This is user-mutable. This will be same as the GlossaryTermId, if not specified.
+      "labels": { # Optional. User-defined labels for the GlossaryTerm.
+        "a_key": "A String",
+      },
+      "name": "A String", # Output only. Identifier. The resource name of the GlossaryTerm. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}/terms/{term_id}
+      "parent": "A String", # Required. The immediate parent of the GlossaryTerm in the resource-hierarchy. It can either be a Glossary or a GlossaryCategory. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id} OR projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}/categories/{category_id}
+      "uid": "A String", # Output only. System generated unique id for the GlossaryTerm. This ID will be different if the GlossaryTerm is deleted and re-created with the same name.
+      "updateTime": "A String", # Output only. The time at which the GlossaryTerm was last updated.
+    },
+    "termId": "A String", # Required. GlossaryTerm identifier.
+  },
+  "createTime": "A String", # Output only. The time when the ChangeRequest was created.
+  "dataProductAccessRequest": { # Message for requesting access to a Data Product. This will be used to create a ChangeRequest of type REQUEST_DATA_PRODUCT_ACCESS. # Payload for Data Product access request.
+    "accessGroupDisplayName": "A String", # Output only. The display name of the access group defined in the Data Product for which access is being requested.
+    "accessGroupId": "A String", # Required. The ID of the access group for which access is being requested. This corresponds to the unique identifier of the AccessGroup defined in the Data Product.
+    "parent": "A String", # Required. The resource name of the data product. Format: projects/{project_number}/locations/{location_id}/dataProducts/{data_product_id}
+    "requestedPrincipal": "A String", # Optional. The principal for which access is being requested in IAM format. If not specified, the requestor's principal will be used. Example: serviceAccount:my-sa@my-project.iam.gserviceaccount.com. Only service account principals are currently supported. https://cloud.google.com/iam/docs/principal-identifiers
+  },
+  "deleteEntry": { # Delete Entry request. # Payload for deleting an Entry.
+    "name": "A String", # Required. The resource name of the Entry: projects/{project}/locations/{location}/entryGroups/{entry_group}/entries/{entry}.
+  },
+  "deleteEntryLink": { # Request message for DeleteEntryLink. # Payload for deleting an EntryLink.
+    "name": "A String", # Required. The resource name of the Entry Link: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entryLinks/{entry_link_id}.
+  },
+  "deleteGlossary": { # Delete Glossary Request # Payload for deleting a Glossary.
+    "etag": "A String", # Optional. The etag of the Glossary. If this is provided, it must match the server's etag. If the etag is provided and does not match the server-computed etag, the request must fail with a ABORTED error code.
+    "name": "A String", # Required. The name of the Glossary to delete. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}
+  },
+  "deleteGlossaryCategory": { # Delete GlossaryCategory Request # Payload for deleting a GlossaryCategory.
+    "name": "A String", # Required. The name of the GlossaryCategory to delete. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}/categories/{category_id}
+  },
+  "deleteGlossaryTerm": { # Delete GlossaryTerm Request # Payload for deleting a GlossaryTerm.
+    "name": "A String", # Required. The name of the GlossaryTerm to delete. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}/terms/{term_id}
+  },
+  "etag": "A String", # Optional. This checksum is computed by the service. It can be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.
+  "justification": "A String", # Optional. Justification of the ChangeRequest. This should explain why the change is needed or why it should be approved.
+  "labels": { # Optional. User-defined labels for the ChangeRequest.
+    "a_key": "A String",
+  },
+  "name": "A String", # Identifier. The relative resource name of the ChangeRequest, of the form: projects/{project_number}/locations/{location_id}/changeRequests/{change_request_id}
+  "rejectionComment": "A String", # Output only. The reason provided for rejecting the ChangeRequest.
+  "resource": "A String", # Output only. The full resource name of the target resource to be modified. Example: //dataplex.googleapis.com/projects/my-project/locations/us-central1/entryGroups/my-group/entries/my-entry
+  "state": "A String", # Output only. The current state of the ChangeRequest.
+  "uid": "A String", # Output only. System generated globally unique ID for the ChangeRequest.
+  "updateEntry": { # Update Entry request. # Payload for updating an Entry.
+    "allowMissing": True or False, # Optional. If set to true and the entry doesn't exist, the service will create it.
+    "aspectKeys": [ # Optional. The map keys of the Aspects which the service should modify. It supports the following syntaxes: - matches an aspect of the given type and empty path. @path - matches an aspect of the given type and specified path. For example, to attach an aspect to a field that is specified by the schema aspect, the path should have the format Schema.. @* - matches aspects of the given type for all paths. *@path - matches aspects of all types on the given path.The service will not remove existing aspects matching the syntax unless delete_missing_aspects is set to true.If this field is left empty, the service treats it as specifying exactly those Aspects present in the request.
+      "A String",
+    ],
+    "deleteMissingAspects": True or False, # Optional. If set to true and the aspect_keys specify aspect ranges, the service deletes any existing aspects from that range that weren't provided in the request.
+    "entry": { # An entry is a representation of a data resource that can be described by various metadata. # Required. Entry resource.
+      "aspects": { # Optional. The aspects that are attached to the entry. Depending on how the aspect is attached to the entry, the format of the aspect key can be one of the following: If the aspect is attached directly to the entry: {project_id_or_number}.{location_id}.{aspect_type_id} If the aspect is attached to an entry's path: {project_id_or_number}.{location_id}.{aspect_type_id}@{path}
+        "a_key": { # Represents a single piece of metadata describing an entry or entry link.
+          "aspectSource": { # Information related to the source system of the aspect. # Optional. Information related to the source system of the aspect.
+            "createTime": "A String", # The time the aspect was created in the source system.
+            "dataVersion": "A String", # The version of the data format used to produce this data. This field is used to indicated when the underlying data format changes (e.g., schema modifications, changes to the source URL format definition, etc).
+            "updateTime": "A String", # The time the aspect was last updated in the source system.
+          },
+          "aspectType": "A String", # Output only. The resource name of the type used to create this Aspect.
+          "createTime": "A String", # Output only. The time when the Aspect was created.
+          "data": { # Required. The content of the aspect, according to its aspect type schema. The maximum size of the field is 120KB (encoded as UTF-8).
+            "a_key": "", # Properties of the object.
+          },
+          "path": "A String", # Output only. The path in the entry under which the aspect is attached.
+          "updateTime": "A String", # Output only. The time when the Aspect was last updated.
+        },
+      },
+      "createTime": "A String", # Output only. The time when the entry was created in Dataplex Universal Catalog.
+      "entrySource": { # Information related to the source system of the data resource that is represented by the entry. # Optional. Information related to the source system of the data resource that is represented by the entry.
+        "ancestors": [ # Immutable. The entries representing the ancestors of the data resource in the source system.
+          { # Information about individual items in the hierarchy that is associated with the data resource.
+            "name": "A String", # Optional. The name of the ancestor resource.
+            "type": "A String", # Optional. The type of the ancestor resource.
+          },
+        ],
+        "createTime": "A String", # The time when the resource was created in the source system.
+        "description": "A String", # A description of the data resource. Maximum length is 2,000 characters.
+        "displayName": "A String", # A user-friendly display name. Maximum length is 500 characters.
+        "labels": { # User-defined labels. The maximum size of keys and values is 128 characters each.
+          "a_key": "A String",
+        },
+        "location": "A String", # Output only. Location of the resource in the source system. You can search the entry by this location. By default, this should match the location of the entry group containing this entry. A different value allows capturing the source location for data external to Google Cloud.
+        "platform": "A String", # The platform containing the source system. Maximum length is 64 characters.
+        "resource": "A String", # The name of the resource in the source system. Maximum length is 4,000 characters.
+        "system": "A String", # The name of the source system. Maximum length is 64 characters.
+        "updateTime": "A String", # The time when the resource was last updated in the source system. If the entry exists in the system and its EntrySource has update_time populated, further updates to the EntrySource of the entry must provide incremental updates to its update_time.
+      },
+      "entryType": "A String", # Required. Immutable. The relative resource name of the entry type that was used to create this entry, in the format projects/{project_id_or_number}/locations/{location_id}/entryTypes/{entry_type_id}.
+      "fullyQualifiedName": "A String", # Optional. A name for the entry that can be referenced by an external system. For more information, see Fully qualified names (https://cloud.google.com/data-catalog/docs/fully-qualified-names). The maximum size of the field is 4000 characters.
+      "name": "A String", # Identifier. The relative resource name of the entry, in the format projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id}.
+      "parentEntry": "A String", # Optional. Immutable. The resource name of the parent entry, in the format projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id}.
+      "updateTime": "A String", # Output only. The time when the entry was last updated in Dataplex Universal Catalog.
+    },
+    "updateMask": "A String", # Optional. Mask of fields to update. To update Aspects, the update_mask must contain the value "aspects".If the update_mask is empty, the service will update all modifiable fields present in the request.
+  },
+  "updateGlossary": { # Update Glossary Request # Payload for updating a Glossary.
+    "glossary": { # A Glossary represents a collection of GlossaryCategories and GlossaryTerms defined by the user. Glossary is a top level resource and is the Google Cloud parent resource of all the GlossaryCategories and GlossaryTerms within it. # Required. The Glossary to update. The Glossary's name field is used to identify the Glossary to update. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}
+      "categoryCount": 42, # Output only. The number of GlossaryCategories in the Glossary.
+      "createTime": "A String", # Output only. The time at which the Glossary was created.
+      "description": "A String", # Optional. The user-mutable description of the Glossary.
+      "displayName": "A String", # Optional. User friendly display name of the Glossary. This is user-mutable. This will be same as the GlossaryId, if not specified.
+      "etag": "A String", # Optional. Needed for resource freshness validation. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.
+      "labels": { # Optional. User-defined labels for the Glossary.
+        "a_key": "A String",
+      },
+      "name": "A String", # Output only. Identifier. The resource name of the Glossary. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}
+      "termCount": 42, # Output only. The number of GlossaryTerms in the Glossary.
+      "uid": "A String", # Output only. System generated unique id for the Glossary. This ID will be different if the Glossary is deleted and re-created with the same name.
+      "updateTime": "A String", # Output only. The time at which the Glossary was last updated.
+    },
+    "updateMask": "A String", # Required. The list of fields to update.
+    "validateOnly": True or False, # Optional. Validates the request without actually updating the Glossary. Default: false.
+  },
+  "updateGlossaryCategory": { # Update GlossaryCategory Request # Payload for updating a GlossaryCategory.
+    "category": { # A GlossaryCategory represents a collection of GlossaryCategories and GlossaryTerms within a Glossary that are related to each other. # Required. The GlossaryCategory to update. The GlossaryCategory's name field is used to identify the GlossaryCategory to update. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}/categories/{category_id}
+      "createTime": "A String", # Output only. The time at which the GlossaryCategory was created.
+      "description": "A String", # Optional. The user-mutable description of the GlossaryCategory.
+      "displayName": "A String", # Optional. User friendly display name of the GlossaryCategory. This is user-mutable. This will be same as the GlossaryCategoryId, if not specified.
+      "labels": { # Optional. User-defined labels for the GlossaryCategory.
+        "a_key": "A String",
+      },
+      "name": "A String", # Output only. Identifier. The resource name of the GlossaryCategory. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}/categories/{category_id}
+      "parent": "A String", # Required. The immediate parent of the GlossaryCategory in the resource-hierarchy. It can either be a Glossary or a GlossaryCategory. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id} OR projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}/categories/{category_id}
+      "uid": "A String", # Output only. System generated unique id for the GlossaryCategory. This ID will be different if the GlossaryCategory is deleted and re-created with the same name.
+      "updateTime": "A String", # Output only. The time at which the GlossaryCategory was last updated.
+    },
+    "updateMask": "A String", # Required. The list of fields to update.
+  },
+  "updateGlossaryTerm": { # Update GlossaryTerm Request # Payload for updating a GlossaryTerm.
+    "term": { # GlossaryTerms are the core of Glossary. A GlossaryTerm holds a rich text description that can be attached to Entries or specific columns to enrich them. # Required. The GlossaryTerm to update. The GlossaryTerm's name field is used to identify the GlossaryTerm to update. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}/terms/{term_id}
+      "createTime": "A String", # Output only. The time at which the GlossaryTerm was created.
+      "description": "A String", # Optional. The user-mutable description of the GlossaryTerm.
+      "displayName": "A String", # Optional. User friendly display name of the GlossaryTerm. This is user-mutable. This will be same as the GlossaryTermId, if not specified.
+      "labels": { # Optional. User-defined labels for the GlossaryTerm.
+        "a_key": "A String",
+      },
+      "name": "A String", # Output only. Identifier. The resource name of the GlossaryTerm. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}/terms/{term_id}
+      "parent": "A String", # Required. The immediate parent of the GlossaryTerm in the resource-hierarchy. It can either be a Glossary or a GlossaryCategory. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id} OR projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}/categories/{category_id}
+      "uid": "A String", # Output only. System generated unique id for the GlossaryTerm. This ID will be different if the GlossaryTerm is deleted and re-created with the same name.
+      "updateTime": "A String", # Output only. The time at which the GlossaryTerm was last updated.
+    },
+    "updateMask": "A String", # Required. The list of fields to update.
+  },
+  "updateTime": "A String", # Output only. The time when the ChangeRequest was last updated.
+}
+
+  updateMask: string, Optional. The list of fields to update.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Represents a proposed change to a metadata resource.
+  "approver": "A String", # Output only. The email address of the user who approved/rejected the ChangeRequest.
+  "author": "A String", # Output only. The email address of the user who created the ChangeRequest.
+  "changeType": "A String", # Output only. The type of change represented by the change_payload. This field is derived from the populated field in the change_payload oneof.
+  "createEntry": { # Create Entry request. # Payload for creating an Entry.
+    "entry": { # An entry is a representation of a data resource that can be described by various metadata. # Required. Entry resource.
+      "aspects": { # Optional. The aspects that are attached to the entry. Depending on how the aspect is attached to the entry, the format of the aspect key can be one of the following: If the aspect is attached directly to the entry: {project_id_or_number}.{location_id}.{aspect_type_id} If the aspect is attached to an entry's path: {project_id_or_number}.{location_id}.{aspect_type_id}@{path}
+        "a_key": { # Represents a single piece of metadata describing an entry or entry link.
+          "aspectSource": { # Information related to the source system of the aspect. # Optional. Information related to the source system of the aspect.
+            "createTime": "A String", # The time the aspect was created in the source system.
+            "dataVersion": "A String", # The version of the data format used to produce this data. This field is used to indicated when the underlying data format changes (e.g., schema modifications, changes to the source URL format definition, etc).
+            "updateTime": "A String", # The time the aspect was last updated in the source system.
+          },
+          "aspectType": "A String", # Output only. The resource name of the type used to create this Aspect.
+          "createTime": "A String", # Output only. The time when the Aspect was created.
+          "data": { # Required. The content of the aspect, according to its aspect type schema. The maximum size of the field is 120KB (encoded as UTF-8).
+            "a_key": "", # Properties of the object.
+          },
+          "path": "A String", # Output only. The path in the entry under which the aspect is attached.
+          "updateTime": "A String", # Output only. The time when the Aspect was last updated.
+        },
+      },
+      "createTime": "A String", # Output only. The time when the entry was created in Dataplex Universal Catalog.
+      "entrySource": { # Information related to the source system of the data resource that is represented by the entry. # Optional. Information related to the source system of the data resource that is represented by the entry.
+        "ancestors": [ # Immutable. The entries representing the ancestors of the data resource in the source system.
+          { # Information about individual items in the hierarchy that is associated with the data resource.
+            "name": "A String", # Optional. The name of the ancestor resource.
+            "type": "A String", # Optional. The type of the ancestor resource.
+          },
+        ],
+        "createTime": "A String", # The time when the resource was created in the source system.
+        "description": "A String", # A description of the data resource. Maximum length is 2,000 characters.
+        "displayName": "A String", # A user-friendly display name. Maximum length is 500 characters.
+        "labels": { # User-defined labels. The maximum size of keys and values is 128 characters each.
+          "a_key": "A String",
+        },
+        "location": "A String", # Output only. Location of the resource in the source system. You can search the entry by this location. By default, this should match the location of the entry group containing this entry. A different value allows capturing the source location for data external to Google Cloud.
+        "platform": "A String", # The platform containing the source system. Maximum length is 64 characters.
+        "resource": "A String", # The name of the resource in the source system. Maximum length is 4,000 characters.
+        "system": "A String", # The name of the source system. Maximum length is 64 characters.
+        "updateTime": "A String", # The time when the resource was last updated in the source system. If the entry exists in the system and its EntrySource has update_time populated, further updates to the EntrySource of the entry must provide incremental updates to its update_time.
+      },
+      "entryType": "A String", # Required. Immutable. The relative resource name of the entry type that was used to create this entry, in the format projects/{project_id_or_number}/locations/{location_id}/entryTypes/{entry_type_id}.
+      "fullyQualifiedName": "A String", # Optional. A name for the entry that can be referenced by an external system. For more information, see Fully qualified names (https://cloud.google.com/data-catalog/docs/fully-qualified-names). The maximum size of the field is 4000 characters.
+      "name": "A String", # Identifier. The relative resource name of the entry, in the format projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id}.
+      "parentEntry": "A String", # Optional. Immutable. The resource name of the parent entry, in the format projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id}.
+      "updateTime": "A String", # Output only. The time when the entry was last updated in Dataplex Universal Catalog.
+    },
+    "entryId": "A String", # Required. Entry identifier. It has to be unique within an Entry Group.Entries corresponding to Google Cloud resources use an Entry ID format based on full resource names (https://cloud.google.com/apis/design/resource_names#full_resource_name). The format is a full resource name of the resource without the prefix double slashes in the API service name part of the full resource name. This allows retrieval of entries using their associated resource name.For example, if the full resource name of a resource is //library.googleapis.com/shelves/shelf1/books/book2, then the suggested entry_id is library.googleapis.com/shelves/shelf1/books/book2.It is also suggested to follow the same convention for entries corresponding to resources from providers or systems other than Google Cloud.The maximum size of the field is 4000 characters.
+    "parent": "A String", # Required. The resource name of the parent Entry Group: projects/{project}/locations/{location}/entryGroups/{entry_group}.
+  },
+  "createEntryLink": { # Request message for CreateEntryLink. # Payload for creating an EntryLink.
+    "entryLink": { # EntryLink represents a link between two Entries. # Required. Entry Link resource.
+      "aspects": { # Optional. The aspects that are attached to the entry link. The format of the aspect key has to be the following: {project_id_or_number}.{location_id}.{aspect_type_id} Currently, only a single aspect of a Dataplex-owned Aspect Type is allowed.
+        "a_key": { # Represents a single piece of metadata describing an entry or entry link.
+          "aspectSource": { # Information related to the source system of the aspect. # Optional. Information related to the source system of the aspect.
+            "createTime": "A String", # The time the aspect was created in the source system.
+            "dataVersion": "A String", # The version of the data format used to produce this data. This field is used to indicated when the underlying data format changes (e.g., schema modifications, changes to the source URL format definition, etc).
+            "updateTime": "A String", # The time the aspect was last updated in the source system.
+          },
+          "aspectType": "A String", # Output only. The resource name of the type used to create this Aspect.
+          "createTime": "A String", # Output only. The time when the Aspect was created.
+          "data": { # Required. The content of the aspect, according to its aspect type schema. The maximum size of the field is 120KB (encoded as UTF-8).
+            "a_key": "", # Properties of the object.
+          },
+          "path": "A String", # Output only. The path in the entry under which the aspect is attached.
+          "updateTime": "A String", # Output only. The time when the Aspect was last updated.
+        },
+      },
+      "createTime": "A String", # Output only. The time when the Entry Link was created.
+      "entryLinkType": "A String", # Required. Immutable. Relative resource name of the Entry Link Type used to create this Entry Link. For example: Entry link between synonym terms in a glossary: projects/dataplex-types/locations/global/entryLinkTypes/synonym Entry link between related terms in a glossary: projects/dataplex-types/locations/global/entryLinkTypes/related Entry link between glossary terms and data assets: projects/dataplex-types/locations/global/entryLinkTypes/definition
+      "entryReferences": [ # Required. Immutable. Specifies the Entries referenced in the Entry Link. There should be exactly two entry references.
+        { # Reference to the Entry that is linked through the Entry Link.
+          "name": "A String", # Required. Immutable. The relative resource name of the referenced Entry, of the form: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id}
+          "path": "A String", # Immutable. The path in the Entry that is referenced in the Entry Link. Empty path denotes that the Entry itself is referenced in the Entry Link.
+          "type": "A String", # Required. Immutable. The reference type of the Entry.
+        },
+      ],
+      "name": "A String", # Output only. Immutable. Identifier. The relative resource name of the Entry Link, of the form: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entryLinks/{entry_link_id}
+      "updateTime": "A String", # Output only. The time when the Entry Link was last updated.
+    },
+    "entryLinkId": "A String", # Required. Entry Link identifier * Must contain only lowercase letters, numbers and hyphens. * Must start with a letter. * Must be between 1-63 characters. * Must end with a number or a letter. * Must be unique within the EntryGroup.
+    "parent": "A String", # Required. The resource name of the parent Entry Group: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}.
+  },
+  "createGlossary": { # Create Glossary Request # Payload for creating a Glossary.
+    "glossary": { # A Glossary represents a collection of GlossaryCategories and GlossaryTerms defined by the user. Glossary is a top level resource and is the Google Cloud parent resource of all the GlossaryCategories and GlossaryTerms within it. # Required. The Glossary to create.
+      "categoryCount": 42, # Output only. The number of GlossaryCategories in the Glossary.
+      "createTime": "A String", # Output only. The time at which the Glossary was created.
+      "description": "A String", # Optional. The user-mutable description of the Glossary.
+      "displayName": "A String", # Optional. User friendly display name of the Glossary. This is user-mutable. This will be same as the GlossaryId, if not specified.
+      "etag": "A String", # Optional. Needed for resource freshness validation. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.
+      "labels": { # Optional. User-defined labels for the Glossary.
+        "a_key": "A String",
+      },
+      "name": "A String", # Output only. Identifier. The resource name of the Glossary. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}
+      "termCount": 42, # Output only. The number of GlossaryTerms in the Glossary.
+      "uid": "A String", # Output only. System generated unique id for the Glossary. This ID will be different if the Glossary is deleted and re-created with the same name.
+      "updateTime": "A String", # Output only. The time at which the Glossary was last updated.
+    },
+    "glossaryId": "A String", # Required. Glossary ID: Glossary identifier.
+    "parent": "A String", # Required. The parent resource where this Glossary will be created. Format: projects/{project_id_or_number}/locations/{location_id} where location_id refers to a Google Cloud region.
+    "validateOnly": True or False, # Optional. Validates the request without actually creating the Glossary. Default: false.
+  },
+  "createGlossaryCategory": { # Creates a new GlossaryCategory under the specified Glossary. # Payload for creating a GlossaryCategory.
+    "category": { # A GlossaryCategory represents a collection of GlossaryCategories and GlossaryTerms within a Glossary that are related to each other. # Required. The GlossaryCategory to create.
+      "createTime": "A String", # Output only. The time at which the GlossaryCategory was created.
+      "description": "A String", # Optional. The user-mutable description of the GlossaryCategory.
+      "displayName": "A String", # Optional. User friendly display name of the GlossaryCategory. This is user-mutable. This will be same as the GlossaryCategoryId, if not specified.
+      "labels": { # Optional. User-defined labels for the GlossaryCategory.
+        "a_key": "A String",
+      },
+      "name": "A String", # Output only. Identifier. The resource name of the GlossaryCategory. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}/categories/{category_id}
+      "parent": "A String", # Required. The immediate parent of the GlossaryCategory in the resource-hierarchy. It can either be a Glossary or a GlossaryCategory. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id} OR projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}/categories/{category_id}
+      "uid": "A String", # Output only. System generated unique id for the GlossaryCategory. This ID will be different if the GlossaryCategory is deleted and re-created with the same name.
+      "updateTime": "A String", # Output only. The time at which the GlossaryCategory was last updated.
+    },
+    "categoryId": "A String", # Required. GlossaryCategory identifier.
+    "parent": "A String", # Required. The parent resource where this GlossaryCategory will be created. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id} where locationId refers to a Google Cloud region.
+  },
+  "createGlossaryTerm": { # Creates a new GlossaryTerm under the specified Glossary. # Payload for creating a GlossaryTerm.
+    "parent": "A String", # Required. The parent resource where the GlossaryTerm will be created. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id} where location_id refers to a Google Cloud region.
+    "term": { # GlossaryTerms are the core of Glossary. A GlossaryTerm holds a rich text description that can be attached to Entries or specific columns to enrich them. # Required. The GlossaryTerm to create.
+      "createTime": "A String", # Output only. The time at which the GlossaryTerm was created.
+      "description": "A String", # Optional. The user-mutable description of the GlossaryTerm.
+      "displayName": "A String", # Optional. User friendly display name of the GlossaryTerm. This is user-mutable. This will be same as the GlossaryTermId, if not specified.
+      "labels": { # Optional. User-defined labels for the GlossaryTerm.
+        "a_key": "A String",
+      },
+      "name": "A String", # Output only. Identifier. The resource name of the GlossaryTerm. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}/terms/{term_id}
+      "parent": "A String", # Required. The immediate parent of the GlossaryTerm in the resource-hierarchy. It can either be a Glossary or a GlossaryCategory. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id} OR projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}/categories/{category_id}
+      "uid": "A String", # Output only. System generated unique id for the GlossaryTerm. This ID will be different if the GlossaryTerm is deleted and re-created with the same name.
+      "updateTime": "A String", # Output only. The time at which the GlossaryTerm was last updated.
+    },
+    "termId": "A String", # Required. GlossaryTerm identifier.
+  },
+  "createTime": "A String", # Output only. The time when the ChangeRequest was created.
+  "dataProductAccessRequest": { # Message for requesting access to a Data Product. This will be used to create a ChangeRequest of type REQUEST_DATA_PRODUCT_ACCESS. # Payload for Data Product access request.
+    "accessGroupDisplayName": "A String", # Output only. The display name of the access group defined in the Data Product for which access is being requested.
+    "accessGroupId": "A String", # Required. The ID of the access group for which access is being requested. This corresponds to the unique identifier of the AccessGroup defined in the Data Product.
+    "parent": "A String", # Required. The resource name of the data product. Format: projects/{project_number}/locations/{location_id}/dataProducts/{data_product_id}
+    "requestedPrincipal": "A String", # Optional. The principal for which access is being requested in IAM format. If not specified, the requestor's principal will be used. Example: serviceAccount:my-sa@my-project.iam.gserviceaccount.com. Only service account principals are currently supported. https://cloud.google.com/iam/docs/principal-identifiers
+  },
+  "deleteEntry": { # Delete Entry request. # Payload for deleting an Entry.
+    "name": "A String", # Required. The resource name of the Entry: projects/{project}/locations/{location}/entryGroups/{entry_group}/entries/{entry}.
+  },
+  "deleteEntryLink": { # Request message for DeleteEntryLink. # Payload for deleting an EntryLink.
+    "name": "A String", # Required. The resource name of the Entry Link: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entryLinks/{entry_link_id}.
+  },
+  "deleteGlossary": { # Delete Glossary Request # Payload for deleting a Glossary.
+    "etag": "A String", # Optional. The etag of the Glossary. If this is provided, it must match the server's etag. If the etag is provided and does not match the server-computed etag, the request must fail with a ABORTED error code.
+    "name": "A String", # Required. The name of the Glossary to delete. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}
+  },
+  "deleteGlossaryCategory": { # Delete GlossaryCategory Request # Payload for deleting a GlossaryCategory.
+    "name": "A String", # Required. The name of the GlossaryCategory to delete. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}/categories/{category_id}
+  },
+  "deleteGlossaryTerm": { # Delete GlossaryTerm Request # Payload for deleting a GlossaryTerm.
+    "name": "A String", # Required. The name of the GlossaryTerm to delete. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}/terms/{term_id}
+  },
+  "etag": "A String", # Optional. This checksum is computed by the service. It can be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.
+  "justification": "A String", # Optional. Justification of the ChangeRequest. This should explain why the change is needed or why it should be approved.
+  "labels": { # Optional. User-defined labels for the ChangeRequest.
+    "a_key": "A String",
+  },
+  "name": "A String", # Identifier. The relative resource name of the ChangeRequest, of the form: projects/{project_number}/locations/{location_id}/changeRequests/{change_request_id}
+  "rejectionComment": "A String", # Output only. The reason provided for rejecting the ChangeRequest.
+  "resource": "A String", # Output only. The full resource name of the target resource to be modified. Example: //dataplex.googleapis.com/projects/my-project/locations/us-central1/entryGroups/my-group/entries/my-entry
+  "state": "A String", # Output only. The current state of the ChangeRequest.
+  "uid": "A String", # Output only. System generated globally unique ID for the ChangeRequest.
+  "updateEntry": { # Update Entry request. # Payload for updating an Entry.
+    "allowMissing": True or False, # Optional. If set to true and the entry doesn't exist, the service will create it.
+    "aspectKeys": [ # Optional. The map keys of the Aspects which the service should modify. It supports the following syntaxes: - matches an aspect of the given type and empty path. @path - matches an aspect of the given type and specified path. For example, to attach an aspect to a field that is specified by the schema aspect, the path should have the format Schema.. @* - matches aspects of the given type for all paths. *@path - matches aspects of all types on the given path.The service will not remove existing aspects matching the syntax unless delete_missing_aspects is set to true.If this field is left empty, the service treats it as specifying exactly those Aspects present in the request.
+      "A String",
+    ],
+    "deleteMissingAspects": True or False, # Optional. If set to true and the aspect_keys specify aspect ranges, the service deletes any existing aspects from that range that weren't provided in the request.
+    "entry": { # An entry is a representation of a data resource that can be described by various metadata. # Required. Entry resource.
+      "aspects": { # Optional. The aspects that are attached to the entry. Depending on how the aspect is attached to the entry, the format of the aspect key can be one of the following: If the aspect is attached directly to the entry: {project_id_or_number}.{location_id}.{aspect_type_id} If the aspect is attached to an entry's path: {project_id_or_number}.{location_id}.{aspect_type_id}@{path}
+        "a_key": { # Represents a single piece of metadata describing an entry or entry link.
+          "aspectSource": { # Information related to the source system of the aspect. # Optional. Information related to the source system of the aspect.
+            "createTime": "A String", # The time the aspect was created in the source system.
+            "dataVersion": "A String", # The version of the data format used to produce this data. This field is used to indicated when the underlying data format changes (e.g., schema modifications, changes to the source URL format definition, etc).
+            "updateTime": "A String", # The time the aspect was last updated in the source system.
+          },
+          "aspectType": "A String", # Output only. The resource name of the type used to create this Aspect.
+          "createTime": "A String", # Output only. The time when the Aspect was created.
+          "data": { # Required. The content of the aspect, according to its aspect type schema. The maximum size of the field is 120KB (encoded as UTF-8).
+            "a_key": "", # Properties of the object.
+          },
+          "path": "A String", # Output only. The path in the entry under which the aspect is attached.
+          "updateTime": "A String", # Output only. The time when the Aspect was last updated.
+        },
+      },
+      "createTime": "A String", # Output only. The time when the entry was created in Dataplex Universal Catalog.
+      "entrySource": { # Information related to the source system of the data resource that is represented by the entry. # Optional. Information related to the source system of the data resource that is represented by the entry.
+        "ancestors": [ # Immutable. The entries representing the ancestors of the data resource in the source system.
+          { # Information about individual items in the hierarchy that is associated with the data resource.
+            "name": "A String", # Optional. The name of the ancestor resource.
+            "type": "A String", # Optional. The type of the ancestor resource.
+          },
+        ],
+        "createTime": "A String", # The time when the resource was created in the source system.
+        "description": "A String", # A description of the data resource. Maximum length is 2,000 characters.
+        "displayName": "A String", # A user-friendly display name. Maximum length is 500 characters.
+        "labels": { # User-defined labels. The maximum size of keys and values is 128 characters each.
+          "a_key": "A String",
+        },
+        "location": "A String", # Output only. Location of the resource in the source system. You can search the entry by this location. By default, this should match the location of the entry group containing this entry. A different value allows capturing the source location for data external to Google Cloud.
+        "platform": "A String", # The platform containing the source system. Maximum length is 64 characters.
+        "resource": "A String", # The name of the resource in the source system. Maximum length is 4,000 characters.
+        "system": "A String", # The name of the source system. Maximum length is 64 characters.
+        "updateTime": "A String", # The time when the resource was last updated in the source system. If the entry exists in the system and its EntrySource has update_time populated, further updates to the EntrySource of the entry must provide incremental updates to its update_time.
+      },
+      "entryType": "A String", # Required. Immutable. The relative resource name of the entry type that was used to create this entry, in the format projects/{project_id_or_number}/locations/{location_id}/entryTypes/{entry_type_id}.
+      "fullyQualifiedName": "A String", # Optional. A name for the entry that can be referenced by an external system. For more information, see Fully qualified names (https://cloud.google.com/data-catalog/docs/fully-qualified-names). The maximum size of the field is 4000 characters.
+      "name": "A String", # Identifier. The relative resource name of the entry, in the format projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id}.
+      "parentEntry": "A String", # Optional. Immutable. The resource name of the parent entry, in the format projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id}.
+      "updateTime": "A String", # Output only. The time when the entry was last updated in Dataplex Universal Catalog.
+    },
+    "updateMask": "A String", # Optional. Mask of fields to update. To update Aspects, the update_mask must contain the value "aspects".If the update_mask is empty, the service will update all modifiable fields present in the request.
+  },
+  "updateGlossary": { # Update Glossary Request # Payload for updating a Glossary.
+    "glossary": { # A Glossary represents a collection of GlossaryCategories and GlossaryTerms defined by the user. Glossary is a top level resource and is the Google Cloud parent resource of all the GlossaryCategories and GlossaryTerms within it. # Required. The Glossary to update. The Glossary's name field is used to identify the Glossary to update. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}
+      "categoryCount": 42, # Output only. The number of GlossaryCategories in the Glossary.
+      "createTime": "A String", # Output only. The time at which the Glossary was created.
+      "description": "A String", # Optional. The user-mutable description of the Glossary.
+      "displayName": "A String", # Optional. User friendly display name of the Glossary. This is user-mutable. This will be same as the GlossaryId, if not specified.
+      "etag": "A String", # Optional. Needed for resource freshness validation. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.
+      "labels": { # Optional. User-defined labels for the Glossary.
+        "a_key": "A String",
+      },
+      "name": "A String", # Output only. Identifier. The resource name of the Glossary. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}
+      "termCount": 42, # Output only. The number of GlossaryTerms in the Glossary.
+      "uid": "A String", # Output only. System generated unique id for the Glossary. This ID will be different if the Glossary is deleted and re-created with the same name.
+      "updateTime": "A String", # Output only. The time at which the Glossary was last updated.
+    },
+    "updateMask": "A String", # Required. The list of fields to update.
+    "validateOnly": True or False, # Optional. Validates the request without actually updating the Glossary. Default: false.
+  },
+  "updateGlossaryCategory": { # Update GlossaryCategory Request # Payload for updating a GlossaryCategory.
+    "category": { # A GlossaryCategory represents a collection of GlossaryCategories and GlossaryTerms within a Glossary that are related to each other. # Required. The GlossaryCategory to update. The GlossaryCategory's name field is used to identify the GlossaryCategory to update. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}/categories/{category_id}
+      "createTime": "A String", # Output only. The time at which the GlossaryCategory was created.
+      "description": "A String", # Optional. The user-mutable description of the GlossaryCategory.
+      "displayName": "A String", # Optional. User friendly display name of the GlossaryCategory. This is user-mutable. This will be same as the GlossaryCategoryId, if not specified.
+      "labels": { # Optional. User-defined labels for the GlossaryCategory.
+        "a_key": "A String",
+      },
+      "name": "A String", # Output only. Identifier. The resource name of the GlossaryCategory. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}/categories/{category_id}
+      "parent": "A String", # Required. The immediate parent of the GlossaryCategory in the resource-hierarchy. It can either be a Glossary or a GlossaryCategory. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id} OR projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}/categories/{category_id}
+      "uid": "A String", # Output only. System generated unique id for the GlossaryCategory. This ID will be different if the GlossaryCategory is deleted and re-created with the same name.
+      "updateTime": "A String", # Output only. The time at which the GlossaryCategory was last updated.
+    },
+    "updateMask": "A String", # Required. The list of fields to update.
+  },
+  "updateGlossaryTerm": { # Update GlossaryTerm Request # Payload for updating a GlossaryTerm.
+    "term": { # GlossaryTerms are the core of Glossary. A GlossaryTerm holds a rich text description that can be attached to Entries or specific columns to enrich them. # Required. The GlossaryTerm to update. The GlossaryTerm's name field is used to identify the GlossaryTerm to update. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}/terms/{term_id}
+      "createTime": "A String", # Output only. The time at which the GlossaryTerm was created.
+      "description": "A String", # Optional. The user-mutable description of the GlossaryTerm.
+      "displayName": "A String", # Optional. User friendly display name of the GlossaryTerm. This is user-mutable. This will be same as the GlossaryTermId, if not specified.
+      "labels": { # Optional. User-defined labels for the GlossaryTerm.
+        "a_key": "A String",
+      },
+      "name": "A String", # Output only. Identifier. The resource name of the GlossaryTerm. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}/terms/{term_id}
+      "parent": "A String", # Required. The immediate parent of the GlossaryTerm in the resource-hierarchy. It can either be a Glossary or a GlossaryCategory. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id} OR projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}/categories/{category_id}
+      "uid": "A String", # Output only. System generated unique id for the GlossaryTerm. This ID will be different if the GlossaryTerm is deleted and re-created with the same name.
+      "updateTime": "A String", # Output only. The time at which the GlossaryTerm was last updated.
+    },
+    "updateMask": "A String", # Required. The list of fields to update.
+  },
+  "updateTime": "A String", # Output only. The time when the ChangeRequest was last updated.
+}
+
+ +
+ reject(name, body=None, x__xgafv=None) +
Rejects a ChangeRequest.
+
+Args:
+  name: string, Required. The name of the ChangeRequest to reject. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for RejectChangeRequest.
+  "comment": "A String", # Optional. The reason for rejecting the ChangeRequest.
+  "etag": "A String", # Optional. The etag of the ChangeRequest.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Represents a proposed change to a metadata resource.
+  "approver": "A String", # Output only. The email address of the user who approved/rejected the ChangeRequest.
+  "author": "A String", # Output only. The email address of the user who created the ChangeRequest.
+  "changeType": "A String", # Output only. The type of change represented by the change_payload. This field is derived from the populated field in the change_payload oneof.
+  "createEntry": { # Create Entry request. # Payload for creating an Entry.
+    "entry": { # An entry is a representation of a data resource that can be described by various metadata. # Required. Entry resource.
+      "aspects": { # Optional. The aspects that are attached to the entry. Depending on how the aspect is attached to the entry, the format of the aspect key can be one of the following: If the aspect is attached directly to the entry: {project_id_or_number}.{location_id}.{aspect_type_id} If the aspect is attached to an entry's path: {project_id_or_number}.{location_id}.{aspect_type_id}@{path}
+        "a_key": { # Represents a single piece of metadata describing an entry or entry link.
+          "aspectSource": { # Information related to the source system of the aspect. # Optional. Information related to the source system of the aspect.
+            "createTime": "A String", # The time the aspect was created in the source system.
+            "dataVersion": "A String", # The version of the data format used to produce this data. This field is used to indicated when the underlying data format changes (e.g., schema modifications, changes to the source URL format definition, etc).
+            "updateTime": "A String", # The time the aspect was last updated in the source system.
+          },
+          "aspectType": "A String", # Output only. The resource name of the type used to create this Aspect.
+          "createTime": "A String", # Output only. The time when the Aspect was created.
+          "data": { # Required. The content of the aspect, according to its aspect type schema. The maximum size of the field is 120KB (encoded as UTF-8).
+            "a_key": "", # Properties of the object.
+          },
+          "path": "A String", # Output only. The path in the entry under which the aspect is attached.
+          "updateTime": "A String", # Output only. The time when the Aspect was last updated.
+        },
+      },
+      "createTime": "A String", # Output only. The time when the entry was created in Dataplex Universal Catalog.
+      "entrySource": { # Information related to the source system of the data resource that is represented by the entry. # Optional. Information related to the source system of the data resource that is represented by the entry.
+        "ancestors": [ # Immutable. The entries representing the ancestors of the data resource in the source system.
+          { # Information about individual items in the hierarchy that is associated with the data resource.
+            "name": "A String", # Optional. The name of the ancestor resource.
+            "type": "A String", # Optional. The type of the ancestor resource.
+          },
+        ],
+        "createTime": "A String", # The time when the resource was created in the source system.
+        "description": "A String", # A description of the data resource. Maximum length is 2,000 characters.
+        "displayName": "A String", # A user-friendly display name. Maximum length is 500 characters.
+        "labels": { # User-defined labels. The maximum size of keys and values is 128 characters each.
+          "a_key": "A String",
+        },
+        "location": "A String", # Output only. Location of the resource in the source system. You can search the entry by this location. By default, this should match the location of the entry group containing this entry. A different value allows capturing the source location for data external to Google Cloud.
+        "platform": "A String", # The platform containing the source system. Maximum length is 64 characters.
+        "resource": "A String", # The name of the resource in the source system. Maximum length is 4,000 characters.
+        "system": "A String", # The name of the source system. Maximum length is 64 characters.
+        "updateTime": "A String", # The time when the resource was last updated in the source system. If the entry exists in the system and its EntrySource has update_time populated, further updates to the EntrySource of the entry must provide incremental updates to its update_time.
+      },
+      "entryType": "A String", # Required. Immutable. The relative resource name of the entry type that was used to create this entry, in the format projects/{project_id_or_number}/locations/{location_id}/entryTypes/{entry_type_id}.
+      "fullyQualifiedName": "A String", # Optional. A name for the entry that can be referenced by an external system. For more information, see Fully qualified names (https://cloud.google.com/data-catalog/docs/fully-qualified-names). The maximum size of the field is 4000 characters.
+      "name": "A String", # Identifier. The relative resource name of the entry, in the format projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id}.
+      "parentEntry": "A String", # Optional. Immutable. The resource name of the parent entry, in the format projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id}.
+      "updateTime": "A String", # Output only. The time when the entry was last updated in Dataplex Universal Catalog.
+    },
+    "entryId": "A String", # Required. Entry identifier. It has to be unique within an Entry Group.Entries corresponding to Google Cloud resources use an Entry ID format based on full resource names (https://cloud.google.com/apis/design/resource_names#full_resource_name). The format is a full resource name of the resource without the prefix double slashes in the API service name part of the full resource name. This allows retrieval of entries using their associated resource name.For example, if the full resource name of a resource is //library.googleapis.com/shelves/shelf1/books/book2, then the suggested entry_id is library.googleapis.com/shelves/shelf1/books/book2.It is also suggested to follow the same convention for entries corresponding to resources from providers or systems other than Google Cloud.The maximum size of the field is 4000 characters.
+    "parent": "A String", # Required. The resource name of the parent Entry Group: projects/{project}/locations/{location}/entryGroups/{entry_group}.
+  },
+  "createEntryLink": { # Request message for CreateEntryLink. # Payload for creating an EntryLink.
+    "entryLink": { # EntryLink represents a link between two Entries. # Required. Entry Link resource.
+      "aspects": { # Optional. The aspects that are attached to the entry link. The format of the aspect key has to be the following: {project_id_or_number}.{location_id}.{aspect_type_id} Currently, only a single aspect of a Dataplex-owned Aspect Type is allowed.
+        "a_key": { # Represents a single piece of metadata describing an entry or entry link.
+          "aspectSource": { # Information related to the source system of the aspect. # Optional. Information related to the source system of the aspect.
+            "createTime": "A String", # The time the aspect was created in the source system.
+            "dataVersion": "A String", # The version of the data format used to produce this data. This field is used to indicated when the underlying data format changes (e.g., schema modifications, changes to the source URL format definition, etc).
+            "updateTime": "A String", # The time the aspect was last updated in the source system.
+          },
+          "aspectType": "A String", # Output only. The resource name of the type used to create this Aspect.
+          "createTime": "A String", # Output only. The time when the Aspect was created.
+          "data": { # Required. The content of the aspect, according to its aspect type schema. The maximum size of the field is 120KB (encoded as UTF-8).
+            "a_key": "", # Properties of the object.
+          },
+          "path": "A String", # Output only. The path in the entry under which the aspect is attached.
+          "updateTime": "A String", # Output only. The time when the Aspect was last updated.
+        },
+      },
+      "createTime": "A String", # Output only. The time when the Entry Link was created.
+      "entryLinkType": "A String", # Required. Immutable. Relative resource name of the Entry Link Type used to create this Entry Link. For example: Entry link between synonym terms in a glossary: projects/dataplex-types/locations/global/entryLinkTypes/synonym Entry link between related terms in a glossary: projects/dataplex-types/locations/global/entryLinkTypes/related Entry link between glossary terms and data assets: projects/dataplex-types/locations/global/entryLinkTypes/definition
+      "entryReferences": [ # Required. Immutable. Specifies the Entries referenced in the Entry Link. There should be exactly two entry references.
+        { # Reference to the Entry that is linked through the Entry Link.
+          "name": "A String", # Required. Immutable. The relative resource name of the referenced Entry, of the form: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id}
+          "path": "A String", # Immutable. The path in the Entry that is referenced in the Entry Link. Empty path denotes that the Entry itself is referenced in the Entry Link.
+          "type": "A String", # Required. Immutable. The reference type of the Entry.
+        },
+      ],
+      "name": "A String", # Output only. Immutable. Identifier. The relative resource name of the Entry Link, of the form: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entryLinks/{entry_link_id}
+      "updateTime": "A String", # Output only. The time when the Entry Link was last updated.
+    },
+    "entryLinkId": "A String", # Required. Entry Link identifier * Must contain only lowercase letters, numbers and hyphens. * Must start with a letter. * Must be between 1-63 characters. * Must end with a number or a letter. * Must be unique within the EntryGroup.
+    "parent": "A String", # Required. The resource name of the parent Entry Group: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}.
+  },
+  "createGlossary": { # Create Glossary Request # Payload for creating a Glossary.
+    "glossary": { # A Glossary represents a collection of GlossaryCategories and GlossaryTerms defined by the user. Glossary is a top level resource and is the Google Cloud parent resource of all the GlossaryCategories and GlossaryTerms within it. # Required. The Glossary to create.
+      "categoryCount": 42, # Output only. The number of GlossaryCategories in the Glossary.
+      "createTime": "A String", # Output only. The time at which the Glossary was created.
+      "description": "A String", # Optional. The user-mutable description of the Glossary.
+      "displayName": "A String", # Optional. User friendly display name of the Glossary. This is user-mutable. This will be same as the GlossaryId, if not specified.
+      "etag": "A String", # Optional. Needed for resource freshness validation. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.
+      "labels": { # Optional. User-defined labels for the Glossary.
+        "a_key": "A String",
+      },
+      "name": "A String", # Output only. Identifier. The resource name of the Glossary. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}
+      "termCount": 42, # Output only. The number of GlossaryTerms in the Glossary.
+      "uid": "A String", # Output only. System generated unique id for the Glossary. This ID will be different if the Glossary is deleted and re-created with the same name.
+      "updateTime": "A String", # Output only. The time at which the Glossary was last updated.
+    },
+    "glossaryId": "A String", # Required. Glossary ID: Glossary identifier.
+    "parent": "A String", # Required. The parent resource where this Glossary will be created. Format: projects/{project_id_or_number}/locations/{location_id} where location_id refers to a Google Cloud region.
+    "validateOnly": True or False, # Optional. Validates the request without actually creating the Glossary. Default: false.
+  },
+  "createGlossaryCategory": { # Creates a new GlossaryCategory under the specified Glossary. # Payload for creating a GlossaryCategory.
+    "category": { # A GlossaryCategory represents a collection of GlossaryCategories and GlossaryTerms within a Glossary that are related to each other. # Required. The GlossaryCategory to create.
+      "createTime": "A String", # Output only. The time at which the GlossaryCategory was created.
+      "description": "A String", # Optional. The user-mutable description of the GlossaryCategory.
+      "displayName": "A String", # Optional. User friendly display name of the GlossaryCategory. This is user-mutable. This will be same as the GlossaryCategoryId, if not specified.
+      "labels": { # Optional. User-defined labels for the GlossaryCategory.
+        "a_key": "A String",
+      },
+      "name": "A String", # Output only. Identifier. The resource name of the GlossaryCategory. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}/categories/{category_id}
+      "parent": "A String", # Required. The immediate parent of the GlossaryCategory in the resource-hierarchy. It can either be a Glossary or a GlossaryCategory. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id} OR projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}/categories/{category_id}
+      "uid": "A String", # Output only. System generated unique id for the GlossaryCategory. This ID will be different if the GlossaryCategory is deleted and re-created with the same name.
+      "updateTime": "A String", # Output only. The time at which the GlossaryCategory was last updated.
+    },
+    "categoryId": "A String", # Required. GlossaryCategory identifier.
+    "parent": "A String", # Required. The parent resource where this GlossaryCategory will be created. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id} where locationId refers to a Google Cloud region.
+  },
+  "createGlossaryTerm": { # Creates a new GlossaryTerm under the specified Glossary. # Payload for creating a GlossaryTerm.
+    "parent": "A String", # Required. The parent resource where the GlossaryTerm will be created. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id} where location_id refers to a Google Cloud region.
+    "term": { # GlossaryTerms are the core of Glossary. A GlossaryTerm holds a rich text description that can be attached to Entries or specific columns to enrich them. # Required. The GlossaryTerm to create.
+      "createTime": "A String", # Output only. The time at which the GlossaryTerm was created.
+      "description": "A String", # Optional. The user-mutable description of the GlossaryTerm.
+      "displayName": "A String", # Optional. User friendly display name of the GlossaryTerm. This is user-mutable. This will be same as the GlossaryTermId, if not specified.
+      "labels": { # Optional. User-defined labels for the GlossaryTerm.
+        "a_key": "A String",
+      },
+      "name": "A String", # Output only. Identifier. The resource name of the GlossaryTerm. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}/terms/{term_id}
+      "parent": "A String", # Required. The immediate parent of the GlossaryTerm in the resource-hierarchy. It can either be a Glossary or a GlossaryCategory. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id} OR projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}/categories/{category_id}
+      "uid": "A String", # Output only. System generated unique id for the GlossaryTerm. This ID will be different if the GlossaryTerm is deleted and re-created with the same name.
+      "updateTime": "A String", # Output only. The time at which the GlossaryTerm was last updated.
+    },
+    "termId": "A String", # Required. GlossaryTerm identifier.
+  },
+  "createTime": "A String", # Output only. The time when the ChangeRequest was created.
+  "dataProductAccessRequest": { # Message for requesting access to a Data Product. This will be used to create a ChangeRequest of type REQUEST_DATA_PRODUCT_ACCESS. # Payload for Data Product access request.
+    "accessGroupDisplayName": "A String", # Output only. The display name of the access group defined in the Data Product for which access is being requested.
+    "accessGroupId": "A String", # Required. The ID of the access group for which access is being requested. This corresponds to the unique identifier of the AccessGroup defined in the Data Product.
+    "parent": "A String", # Required. The resource name of the data product. Format: projects/{project_number}/locations/{location_id}/dataProducts/{data_product_id}
+    "requestedPrincipal": "A String", # Optional. The principal for which access is being requested in IAM format. If not specified, the requestor's principal will be used. Example: serviceAccount:my-sa@my-project.iam.gserviceaccount.com. Only service account principals are currently supported. https://cloud.google.com/iam/docs/principal-identifiers
+  },
+  "deleteEntry": { # Delete Entry request. # Payload for deleting an Entry.
+    "name": "A String", # Required. The resource name of the Entry: projects/{project}/locations/{location}/entryGroups/{entry_group}/entries/{entry}.
+  },
+  "deleteEntryLink": { # Request message for DeleteEntryLink. # Payload for deleting an EntryLink.
+    "name": "A String", # Required. The resource name of the Entry Link: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entryLinks/{entry_link_id}.
+  },
+  "deleteGlossary": { # Delete Glossary Request # Payload for deleting a Glossary.
+    "etag": "A String", # Optional. The etag of the Glossary. If this is provided, it must match the server's etag. If the etag is provided and does not match the server-computed etag, the request must fail with a ABORTED error code.
+    "name": "A String", # Required. The name of the Glossary to delete. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}
+  },
+  "deleteGlossaryCategory": { # Delete GlossaryCategory Request # Payload for deleting a GlossaryCategory.
+    "name": "A String", # Required. The name of the GlossaryCategory to delete. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}/categories/{category_id}
+  },
+  "deleteGlossaryTerm": { # Delete GlossaryTerm Request # Payload for deleting a GlossaryTerm.
+    "name": "A String", # Required. The name of the GlossaryTerm to delete. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}/terms/{term_id}
+  },
+  "etag": "A String", # Optional. This checksum is computed by the service. It can be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.
+  "justification": "A String", # Optional. Justification of the ChangeRequest. This should explain why the change is needed or why it should be approved.
+  "labels": { # Optional. User-defined labels for the ChangeRequest.
+    "a_key": "A String",
+  },
+  "name": "A String", # Identifier. The relative resource name of the ChangeRequest, of the form: projects/{project_number}/locations/{location_id}/changeRequests/{change_request_id}
+  "rejectionComment": "A String", # Output only. The reason provided for rejecting the ChangeRequest.
+  "resource": "A String", # Output only. The full resource name of the target resource to be modified. Example: //dataplex.googleapis.com/projects/my-project/locations/us-central1/entryGroups/my-group/entries/my-entry
+  "state": "A String", # Output only. The current state of the ChangeRequest.
+  "uid": "A String", # Output only. System generated globally unique ID for the ChangeRequest.
+  "updateEntry": { # Update Entry request. # Payload for updating an Entry.
+    "allowMissing": True or False, # Optional. If set to true and the entry doesn't exist, the service will create it.
+    "aspectKeys": [ # Optional. The map keys of the Aspects which the service should modify. It supports the following syntaxes: - matches an aspect of the given type and empty path. @path - matches an aspect of the given type and specified path. For example, to attach an aspect to a field that is specified by the schema aspect, the path should have the format Schema.. @* - matches aspects of the given type for all paths. *@path - matches aspects of all types on the given path.The service will not remove existing aspects matching the syntax unless delete_missing_aspects is set to true.If this field is left empty, the service treats it as specifying exactly those Aspects present in the request.
+      "A String",
+    ],
+    "deleteMissingAspects": True or False, # Optional. If set to true and the aspect_keys specify aspect ranges, the service deletes any existing aspects from that range that weren't provided in the request.
+    "entry": { # An entry is a representation of a data resource that can be described by various metadata. # Required. Entry resource.
+      "aspects": { # Optional. The aspects that are attached to the entry. Depending on how the aspect is attached to the entry, the format of the aspect key can be one of the following: If the aspect is attached directly to the entry: {project_id_or_number}.{location_id}.{aspect_type_id} If the aspect is attached to an entry's path: {project_id_or_number}.{location_id}.{aspect_type_id}@{path}
+        "a_key": { # Represents a single piece of metadata describing an entry or entry link.
+          "aspectSource": { # Information related to the source system of the aspect. # Optional. Information related to the source system of the aspect.
+            "createTime": "A String", # The time the aspect was created in the source system.
+            "dataVersion": "A String", # The version of the data format used to produce this data. This field is used to indicated when the underlying data format changes (e.g., schema modifications, changes to the source URL format definition, etc).
+            "updateTime": "A String", # The time the aspect was last updated in the source system.
+          },
+          "aspectType": "A String", # Output only. The resource name of the type used to create this Aspect.
+          "createTime": "A String", # Output only. The time when the Aspect was created.
+          "data": { # Required. The content of the aspect, according to its aspect type schema. The maximum size of the field is 120KB (encoded as UTF-8).
+            "a_key": "", # Properties of the object.
+          },
+          "path": "A String", # Output only. The path in the entry under which the aspect is attached.
+          "updateTime": "A String", # Output only. The time when the Aspect was last updated.
+        },
+      },
+      "createTime": "A String", # Output only. The time when the entry was created in Dataplex Universal Catalog.
+      "entrySource": { # Information related to the source system of the data resource that is represented by the entry. # Optional. Information related to the source system of the data resource that is represented by the entry.
+        "ancestors": [ # Immutable. The entries representing the ancestors of the data resource in the source system.
+          { # Information about individual items in the hierarchy that is associated with the data resource.
+            "name": "A String", # Optional. The name of the ancestor resource.
+            "type": "A String", # Optional. The type of the ancestor resource.
+          },
+        ],
+        "createTime": "A String", # The time when the resource was created in the source system.
+        "description": "A String", # A description of the data resource. Maximum length is 2,000 characters.
+        "displayName": "A String", # A user-friendly display name. Maximum length is 500 characters.
+        "labels": { # User-defined labels. The maximum size of keys and values is 128 characters each.
+          "a_key": "A String",
+        },
+        "location": "A String", # Output only. Location of the resource in the source system. You can search the entry by this location. By default, this should match the location of the entry group containing this entry. A different value allows capturing the source location for data external to Google Cloud.
+        "platform": "A String", # The platform containing the source system. Maximum length is 64 characters.
+        "resource": "A String", # The name of the resource in the source system. Maximum length is 4,000 characters.
+        "system": "A String", # The name of the source system. Maximum length is 64 characters.
+        "updateTime": "A String", # The time when the resource was last updated in the source system. If the entry exists in the system and its EntrySource has update_time populated, further updates to the EntrySource of the entry must provide incremental updates to its update_time.
+      },
+      "entryType": "A String", # Required. Immutable. The relative resource name of the entry type that was used to create this entry, in the format projects/{project_id_or_number}/locations/{location_id}/entryTypes/{entry_type_id}.
+      "fullyQualifiedName": "A String", # Optional. A name for the entry that can be referenced by an external system. For more information, see Fully qualified names (https://cloud.google.com/data-catalog/docs/fully-qualified-names). The maximum size of the field is 4000 characters.
+      "name": "A String", # Identifier. The relative resource name of the entry, in the format projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id}.
+      "parentEntry": "A String", # Optional. Immutable. The resource name of the parent entry, in the format projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id}.
+      "updateTime": "A String", # Output only. The time when the entry was last updated in Dataplex Universal Catalog.
+    },
+    "updateMask": "A String", # Optional. Mask of fields to update. To update Aspects, the update_mask must contain the value "aspects".If the update_mask is empty, the service will update all modifiable fields present in the request.
+  },
+  "updateGlossary": { # Update Glossary Request # Payload for updating a Glossary.
+    "glossary": { # A Glossary represents a collection of GlossaryCategories and GlossaryTerms defined by the user. Glossary is a top level resource and is the Google Cloud parent resource of all the GlossaryCategories and GlossaryTerms within it. # Required. The Glossary to update. The Glossary's name field is used to identify the Glossary to update. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}
+      "categoryCount": 42, # Output only. The number of GlossaryCategories in the Glossary.
+      "createTime": "A String", # Output only. The time at which the Glossary was created.
+      "description": "A String", # Optional. The user-mutable description of the Glossary.
+      "displayName": "A String", # Optional. User friendly display name of the Glossary. This is user-mutable. This will be same as the GlossaryId, if not specified.
+      "etag": "A String", # Optional. Needed for resource freshness validation. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.
+      "labels": { # Optional. User-defined labels for the Glossary.
+        "a_key": "A String",
+      },
+      "name": "A String", # Output only. Identifier. The resource name of the Glossary. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}
+      "termCount": 42, # Output only. The number of GlossaryTerms in the Glossary.
+      "uid": "A String", # Output only. System generated unique id for the Glossary. This ID will be different if the Glossary is deleted and re-created with the same name.
+      "updateTime": "A String", # Output only. The time at which the Glossary was last updated.
+    },
+    "updateMask": "A String", # Required. The list of fields to update.
+    "validateOnly": True or False, # Optional. Validates the request without actually updating the Glossary. Default: false.
+  },
+  "updateGlossaryCategory": { # Update GlossaryCategory Request # Payload for updating a GlossaryCategory.
+    "category": { # A GlossaryCategory represents a collection of GlossaryCategories and GlossaryTerms within a Glossary that are related to each other. # Required. The GlossaryCategory to update. The GlossaryCategory's name field is used to identify the GlossaryCategory to update. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}/categories/{category_id}
+      "createTime": "A String", # Output only. The time at which the GlossaryCategory was created.
+      "description": "A String", # Optional. The user-mutable description of the GlossaryCategory.
+      "displayName": "A String", # Optional. User friendly display name of the GlossaryCategory. This is user-mutable. This will be same as the GlossaryCategoryId, if not specified.
+      "labels": { # Optional. User-defined labels for the GlossaryCategory.
+        "a_key": "A String",
+      },
+      "name": "A String", # Output only. Identifier. The resource name of the GlossaryCategory. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}/categories/{category_id}
+      "parent": "A String", # Required. The immediate parent of the GlossaryCategory in the resource-hierarchy. It can either be a Glossary or a GlossaryCategory. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id} OR projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}/categories/{category_id}
+      "uid": "A String", # Output only. System generated unique id for the GlossaryCategory. This ID will be different if the GlossaryCategory is deleted and re-created with the same name.
+      "updateTime": "A String", # Output only. The time at which the GlossaryCategory was last updated.
+    },
+    "updateMask": "A String", # Required. The list of fields to update.
+  },
+  "updateGlossaryTerm": { # Update GlossaryTerm Request # Payload for updating a GlossaryTerm.
+    "term": { # GlossaryTerms are the core of Glossary. A GlossaryTerm holds a rich text description that can be attached to Entries or specific columns to enrich them. # Required. The GlossaryTerm to update. The GlossaryTerm's name field is used to identify the GlossaryTerm to update. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}/terms/{term_id}
+      "createTime": "A String", # Output only. The time at which the GlossaryTerm was created.
+      "description": "A String", # Optional. The user-mutable description of the GlossaryTerm.
+      "displayName": "A String", # Optional. User friendly display name of the GlossaryTerm. This is user-mutable. This will be same as the GlossaryTermId, if not specified.
+      "labels": { # Optional. User-defined labels for the GlossaryTerm.
+        "a_key": "A String",
+      },
+      "name": "A String", # Output only. Identifier. The resource name of the GlossaryTerm. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}/terms/{term_id}
+      "parent": "A String", # Required. The immediate parent of the GlossaryTerm in the resource-hierarchy. It can either be a Glossary or a GlossaryCategory. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id} OR projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}/categories/{category_id}
+      "uid": "A String", # Output only. System generated unique id for the GlossaryTerm. This ID will be different if the GlossaryTerm is deleted and re-created with the same name.
+      "updateTime": "A String", # Output only. The time at which the GlossaryTerm was last updated.
+    },
+    "updateMask": "A String", # Required. The list of fields to update.
+  },
+  "updateTime": "A String", # Output only. The time when the ChangeRequest was last updated.
+}
+
+
setIamPolicy(resource, body=None, x__xgafv=None)
Sets the access control policy on the specified resource. Replaces any existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.
diff --git a/docs/dyn/dataplex_v1.projects.locations.dataProducts.html b/docs/dyn/dataplex_v1.projects.locations.dataProducts.html
index d60cb02e79..e2d48d7ffd 100644
--- a/docs/dyn/dataplex_v1.projects.locations.dataProducts.html
+++ b/docs/dyn/dataplex_v1.projects.locations.dataProducts.html
@@ -621,6 +621,12 @@ 

Method Details

"termId": "A String", # Required. GlossaryTerm identifier. }, "createTime": "A String", # Output only. The time when the ChangeRequest was created. + "dataProductAccessRequest": { # Message for requesting access to a Data Product. This will be used to create a ChangeRequest of type REQUEST_DATA_PRODUCT_ACCESS. # Payload for Data Product access request. + "accessGroupDisplayName": "A String", # Output only. The display name of the access group defined in the Data Product for which access is being requested. + "accessGroupId": "A String", # Required. The ID of the access group for which access is being requested. This corresponds to the unique identifier of the AccessGroup defined in the Data Product. + "parent": "A String", # Required. The resource name of the data product. Format: projects/{project_number}/locations/{location_id}/dataProducts/{data_product_id} + "requestedPrincipal": "A String", # Optional. The principal for which access is being requested in IAM format. If not specified, the requestor's principal will be used. Example: serviceAccount:my-sa@my-project.iam.gserviceaccount.com. Only service account principals are currently supported. https://cloud.google.com/iam/docs/principal-identifiers + }, "deleteEntry": { # Delete Entry request. # Payload for deleting an Entry. "name": "A String", # Required. The resource name of the Entry: projects/{project}/locations/{location}/entryGroups/{entry_group}/entries/{entry}. }, diff --git a/docs/dyn/dataplex_v1.projects.locations.dataScans.html b/docs/dyn/dataplex_v1.projects.locations.dataScans.html index 9963192cae..b8b7c65391 100644 --- a/docs/dyn/dataplex_v1.projects.locations.dataScans.html +++ b/docs/dyn/dataplex_v1.projects.locations.dataScans.html @@ -179,7 +179,6 @@

Method Details

"typeInferenceDisabled": True or False, # Optional. Whether to disable the inference of data types for JSON data. If true, all columns are registered as their primitive types (strings, number, or boolean). }, "unstructuredDataOptions": { # Describes options for unstructured data discovery. # Optional. Specifies configuration for unstructured data discovery. - "entityInferenceEnabled": True or False, # Optional. Deprecated: Use semantic_inference_enabled instead. Specifies whether deeper entity inference over the objects' contents using GenAI is enabled. "semanticInferenceEnabled": True or False, # Optional. Specifies whether deeper semantic inference over the objects' contents using GenAI is enabled. }, }, @@ -909,7 +908,6 @@

Method Details

"typeInferenceDisabled": True or False, # Optional. Whether to disable the inference of data types for JSON data. If true, all columns are registered as their primitive types (strings, number, or boolean). }, "unstructuredDataOptions": { # Describes options for unstructured data discovery. # Optional. Specifies configuration for unstructured data discovery. - "entityInferenceEnabled": True or False, # Optional. Deprecated: Use semantic_inference_enabled instead. Specifies whether deeper entity inference over the objects' contents using GenAI is enabled. "semanticInferenceEnabled": True or False, # Optional. Specifies whether deeper semantic inference over the objects' contents using GenAI is enabled. }, }, @@ -1502,7 +1500,6 @@

Method Details

"typeInferenceDisabled": True or False, # Optional. Whether to disable the inference of data types for JSON data. If true, all columns are registered as their primitive types (strings, number, or boolean). }, "unstructuredDataOptions": { # Describes options for unstructured data discovery. # Optional. Specifies configuration for unstructured data discovery. - "entityInferenceEnabled": True or False, # Optional. Deprecated: Use semantic_inference_enabled instead. Specifies whether deeper entity inference over the objects' contents using GenAI is enabled. "semanticInferenceEnabled": True or False, # Optional. Specifies whether deeper semantic inference over the objects' contents using GenAI is enabled. }, }, @@ -2056,7 +2053,6 @@

Method Details

"typeInferenceDisabled": True or False, # Optional. Whether to disable the inference of data types for JSON data. If true, all columns are registered as their primitive types (strings, number, or boolean). }, "unstructuredDataOptions": { # Describes options for unstructured data discovery. # Optional. Specifies configuration for unstructured data discovery. - "entityInferenceEnabled": True or False, # Optional. Deprecated: Use semantic_inference_enabled instead. Specifies whether deeper entity inference over the objects' contents using GenAI is enabled. "semanticInferenceEnabled": True or False, # Optional. Specifies whether deeper semantic inference over the objects' contents using GenAI is enabled. }, }, @@ -2628,7 +2624,6 @@

Method Details

"typeInferenceDisabled": True or False, # Optional. Whether to disable the inference of data types for JSON data. If true, all columns are registered as their primitive types (strings, number, or boolean). }, "unstructuredDataOptions": { # Describes options for unstructured data discovery. # Optional. Specifies configuration for unstructured data discovery. - "entityInferenceEnabled": True or False, # Optional. Deprecated: Use semantic_inference_enabled instead. Specifies whether deeper entity inference over the objects' contents using GenAI is enabled. "semanticInferenceEnabled": True or False, # Optional. Specifies whether deeper semantic inference over the objects' contents using GenAI is enabled. }, }, diff --git a/docs/dyn/dataplex_v1.projects.locations.dataScans.jobs.html b/docs/dyn/dataplex_v1.projects.locations.dataScans.jobs.html index 6bb99cc2b7..0a5fa0f0b4 100644 --- a/docs/dyn/dataplex_v1.projects.locations.dataScans.jobs.html +++ b/docs/dyn/dataplex_v1.projects.locations.dataScans.jobs.html @@ -306,7 +306,6 @@

Method Details

"typeInferenceDisabled": True or False, # Optional. Whether to disable the inference of data types for JSON data. If true, all columns are registered as their primitive types (strings, number, or boolean). }, "unstructuredDataOptions": { # Describes options for unstructured data discovery. # Optional. Specifies configuration for unstructured data discovery. - "entityInferenceEnabled": True or False, # Optional. Deprecated: Use semantic_inference_enabled instead. Specifies whether deeper entity inference over the objects' contents using GenAI is enabled. "semanticInferenceEnabled": True or False, # Optional. Specifies whether deeper semantic inference over the objects' contents using GenAI is enabled. }, }, @@ -817,7 +816,6 @@

Method Details

"typeInferenceDisabled": True or False, # Optional. Whether to disable the inference of data types for JSON data. If true, all columns are registered as their primitive types (strings, number, or boolean). }, "unstructuredDataOptions": { # Describes options for unstructured data discovery. # Optional. Specifies configuration for unstructured data discovery. - "entityInferenceEnabled": True or False, # Optional. Deprecated: Use semantic_inference_enabled instead. Specifies whether deeper entity inference over the objects' contents using GenAI is enabled. "semanticInferenceEnabled": True or False, # Optional. Specifies whether deeper semantic inference over the objects' contents using GenAI is enabled. }, }, diff --git a/docs/dyn/dataproc_v1.projects.locations.batches.html b/docs/dyn/dataproc_v1.projects.locations.batches.html index 2ce087277c..c767bd56e8 100644 --- a/docs/dyn/dataproc_v1.projects.locations.batches.html +++ b/docs/dyn/dataproc_v1.projects.locations.batches.html @@ -248,8 +248,11 @@

Method Details

}, "runtimeInfo": { # Runtime information about workload execution. # Output only. Runtime information about batch execution. "approximateUsage": { # Usage metrics represent approximate total resources consumed by a workload. # Output only. Approximate workload resource usage, calculated when the workload completes (see Dataproc Serverless pricing (https://cloud.google.com/dataproc-serverless/pricing)).Note: This metric calculation may change in the future, for example, to capture cumulative workload resource consumption during workload execution (see the Dataproc Serverless release notes (https://cloud.google.com/dataproc-serverless/docs/release-notes) for announcements, changes, fixes and other Dataproc developments). - "acceleratorType": "A String", # Optional. DEPRECATED Accelerator type being used, if any - "milliAcceleratorSeconds": "A String", # Optional. DEPRECATED Accelerator usage in (milliAccelerator x seconds) (see Dataproc Serverless pricing (https://cloud.google.com/dataproc-serverless/pricing)). + "acceleratorType": "A String", # Optional. Accelerator type being used, if any Deprecated: This field is only used in runtime versions below 3.0. + "milliAcceleratorSeconds": "A String", # Optional. Accelerator usage in (milliAccelerator x seconds) (see Dataproc Serverless pricing (https://cloud.google.com/dataproc-serverless/pricing)). Deprecated: This field is only used in runtime versions below 3.0. + "milliAcceleratorSecondsA10040": "A String", # Optional. A100-40 accelerator usage in (milliAccelerator x seconds) (see Dataproc Serverless pricing (https://cloud.google.com/dataproc-serverless/pricing)). + "milliAcceleratorSecondsA10080": "A String", # Optional. A100-80 accelerator usage in (milliAccelerator x seconds) (see Dataproc Serverless pricing (https://cloud.google.com/dataproc-serverless/pricing)). + "milliAcceleratorSecondsL4": "A String", # Optional. L4 accelerator usage in (milliAccelerator x seconds) (see Dataproc Serverless pricing (https://cloud.google.com/dataproc-serverless/pricing)). "milliDcuSeconds": "A String", # Optional. DCU (Dataproc Compute Units) usage in (milliDCU x seconds) (see Dataproc Serverless pricing (https://cloud.google.com/dataproc-serverless/pricing)). "shuffleStorageGbSeconds": "A String", # Optional. Shuffle storage usage in (GB x seconds) (see Dataproc Serverless pricing (https://cloud.google.com/dataproc-serverless/pricing)). "updateTime": "A String", # Optional. The timestamp of the usage metrics. @@ -259,8 +262,11 @@

Method Details

"cohortSource": "A String", # Output only. Source of the cohort. }, "currentUsage": { # The usage snapshot represents the resources consumed by a workload at a specified time. # Output only. Snapshot of current workload resource usage. - "acceleratorType": "A String", # Optional. Accelerator type being used, if any - "milliAccelerator": "A String", # Optional. Milli (one-thousandth) accelerator. (see Dataproc Serverless pricing (https://cloud.google.com/dataproc-serverless/pricing)) + "acceleratorType": "A String", # Optional. Accelerator type being used, if any Deprecated: This field is only used in runtime versions below 3.0. + "milliAccelerator": "A String", # Optional. Milli (one-thousandth) accelerator. (see Dataproc Serverless pricing (https://cloud.google.com/dataproc-serverless/pricing)) Deprecated: This field is only used in runtime versions below 3.0. + "milliAcceleratorA10040": "A String", # Optional. Milli (one-thousandth) accelerator for A100-40 accelerators. (see Dataproc Serverless pricing (https://cloud.google.com/dataproc-serverless/pricing)) + "milliAcceleratorA10080": "A String", # Optional. Milli (one-thousandth) accelerator for A100-80 accelerators. (see Dataproc Serverless pricing (https://cloud.google.com/dataproc-serverless/pricing)) + "milliAcceleratorL4": "A String", # Optional. Milli (one-thousandth) accelerator for L4 accelerators. (see Dataproc Serverless pricing (https://cloud.google.com/dataproc-serverless/pricing)) "milliDcu": "A String", # Optional. Milli (one-thousandth) Dataproc Compute Units (DCUs) (see Dataproc Serverless pricing (https://cloud.google.com/dataproc-serverless/pricing)). "milliDcuPremium": "A String", # Optional. Milli (one-thousandth) Dataproc Compute Units (DCUs) charged at premium tier (see Dataproc Serverless pricing (https://cloud.google.com/dataproc-serverless/pricing)). "shuffleStorageGb": "A String", # Optional. Shuffle Storage in gigabytes (GB). (see Dataproc Serverless pricing (https://cloud.google.com/dataproc-serverless/pricing)) @@ -485,8 +491,11 @@

Method Details

}, "runtimeInfo": { # Runtime information about workload execution. # Output only. Runtime information about batch execution. "approximateUsage": { # Usage metrics represent approximate total resources consumed by a workload. # Output only. Approximate workload resource usage, calculated when the workload completes (see Dataproc Serverless pricing (https://cloud.google.com/dataproc-serverless/pricing)).Note: This metric calculation may change in the future, for example, to capture cumulative workload resource consumption during workload execution (see the Dataproc Serverless release notes (https://cloud.google.com/dataproc-serverless/docs/release-notes) for announcements, changes, fixes and other Dataproc developments). - "acceleratorType": "A String", # Optional. DEPRECATED Accelerator type being used, if any - "milliAcceleratorSeconds": "A String", # Optional. DEPRECATED Accelerator usage in (milliAccelerator x seconds) (see Dataproc Serverless pricing (https://cloud.google.com/dataproc-serverless/pricing)). + "acceleratorType": "A String", # Optional. Accelerator type being used, if any Deprecated: This field is only used in runtime versions below 3.0. + "milliAcceleratorSeconds": "A String", # Optional. Accelerator usage in (milliAccelerator x seconds) (see Dataproc Serverless pricing (https://cloud.google.com/dataproc-serverless/pricing)). Deprecated: This field is only used in runtime versions below 3.0. + "milliAcceleratorSecondsA10040": "A String", # Optional. A100-40 accelerator usage in (milliAccelerator x seconds) (see Dataproc Serverless pricing (https://cloud.google.com/dataproc-serverless/pricing)). + "milliAcceleratorSecondsA10080": "A String", # Optional. A100-80 accelerator usage in (milliAccelerator x seconds) (see Dataproc Serverless pricing (https://cloud.google.com/dataproc-serverless/pricing)). + "milliAcceleratorSecondsL4": "A String", # Optional. L4 accelerator usage in (milliAccelerator x seconds) (see Dataproc Serverless pricing (https://cloud.google.com/dataproc-serverless/pricing)). "milliDcuSeconds": "A String", # Optional. DCU (Dataproc Compute Units) usage in (milliDCU x seconds) (see Dataproc Serverless pricing (https://cloud.google.com/dataproc-serverless/pricing)). "shuffleStorageGbSeconds": "A String", # Optional. Shuffle storage usage in (GB x seconds) (see Dataproc Serverless pricing (https://cloud.google.com/dataproc-serverless/pricing)). "updateTime": "A String", # Optional. The timestamp of the usage metrics. @@ -496,8 +505,11 @@

Method Details

"cohortSource": "A String", # Output only. Source of the cohort. }, "currentUsage": { # The usage snapshot represents the resources consumed by a workload at a specified time. # Output only. Snapshot of current workload resource usage. - "acceleratorType": "A String", # Optional. Accelerator type being used, if any - "milliAccelerator": "A String", # Optional. Milli (one-thousandth) accelerator. (see Dataproc Serverless pricing (https://cloud.google.com/dataproc-serverless/pricing)) + "acceleratorType": "A String", # Optional. Accelerator type being used, if any Deprecated: This field is only used in runtime versions below 3.0. + "milliAccelerator": "A String", # Optional. Milli (one-thousandth) accelerator. (see Dataproc Serverless pricing (https://cloud.google.com/dataproc-serverless/pricing)) Deprecated: This field is only used in runtime versions below 3.0. + "milliAcceleratorA10040": "A String", # Optional. Milli (one-thousandth) accelerator for A100-40 accelerators. (see Dataproc Serverless pricing (https://cloud.google.com/dataproc-serverless/pricing)) + "milliAcceleratorA10080": "A String", # Optional. Milli (one-thousandth) accelerator for A100-80 accelerators. (see Dataproc Serverless pricing (https://cloud.google.com/dataproc-serverless/pricing)) + "milliAcceleratorL4": "A String", # Optional. Milli (one-thousandth) accelerator for L4 accelerators. (see Dataproc Serverless pricing (https://cloud.google.com/dataproc-serverless/pricing)) "milliDcu": "A String", # Optional. Milli (one-thousandth) Dataproc Compute Units (DCUs) (see Dataproc Serverless pricing (https://cloud.google.com/dataproc-serverless/pricing)). "milliDcuPremium": "A String", # Optional. Milli (one-thousandth) Dataproc Compute Units (DCUs) charged at premium tier (see Dataproc Serverless pricing (https://cloud.google.com/dataproc-serverless/pricing)). "shuffleStorageGb": "A String", # Optional. Shuffle Storage in gigabytes (GB). (see Dataproc Serverless pricing (https://cloud.google.com/dataproc-serverless/pricing)) @@ -680,8 +692,11 @@

Method Details

}, "runtimeInfo": { # Runtime information about workload execution. # Output only. Runtime information about batch execution. "approximateUsage": { # Usage metrics represent approximate total resources consumed by a workload. # Output only. Approximate workload resource usage, calculated when the workload completes (see Dataproc Serverless pricing (https://cloud.google.com/dataproc-serverless/pricing)).Note: This metric calculation may change in the future, for example, to capture cumulative workload resource consumption during workload execution (see the Dataproc Serverless release notes (https://cloud.google.com/dataproc-serverless/docs/release-notes) for announcements, changes, fixes and other Dataproc developments). - "acceleratorType": "A String", # Optional. DEPRECATED Accelerator type being used, if any - "milliAcceleratorSeconds": "A String", # Optional. DEPRECATED Accelerator usage in (milliAccelerator x seconds) (see Dataproc Serverless pricing (https://cloud.google.com/dataproc-serverless/pricing)). + "acceleratorType": "A String", # Optional. Accelerator type being used, if any Deprecated: This field is only used in runtime versions below 3.0. + "milliAcceleratorSeconds": "A String", # Optional. Accelerator usage in (milliAccelerator x seconds) (see Dataproc Serverless pricing (https://cloud.google.com/dataproc-serverless/pricing)). Deprecated: This field is only used in runtime versions below 3.0. + "milliAcceleratorSecondsA10040": "A String", # Optional. A100-40 accelerator usage in (milliAccelerator x seconds) (see Dataproc Serverless pricing (https://cloud.google.com/dataproc-serverless/pricing)). + "milliAcceleratorSecondsA10080": "A String", # Optional. A100-80 accelerator usage in (milliAccelerator x seconds) (see Dataproc Serverless pricing (https://cloud.google.com/dataproc-serverless/pricing)). + "milliAcceleratorSecondsL4": "A String", # Optional. L4 accelerator usage in (milliAccelerator x seconds) (see Dataproc Serverless pricing (https://cloud.google.com/dataproc-serverless/pricing)). "milliDcuSeconds": "A String", # Optional. DCU (Dataproc Compute Units) usage in (milliDCU x seconds) (see Dataproc Serverless pricing (https://cloud.google.com/dataproc-serverless/pricing)). "shuffleStorageGbSeconds": "A String", # Optional. Shuffle storage usage in (GB x seconds) (see Dataproc Serverless pricing (https://cloud.google.com/dataproc-serverless/pricing)). "updateTime": "A String", # Optional. The timestamp of the usage metrics. @@ -691,8 +706,11 @@

Method Details

"cohortSource": "A String", # Output only. Source of the cohort. }, "currentUsage": { # The usage snapshot represents the resources consumed by a workload at a specified time. # Output only. Snapshot of current workload resource usage. - "acceleratorType": "A String", # Optional. Accelerator type being used, if any - "milliAccelerator": "A String", # Optional. Milli (one-thousandth) accelerator. (see Dataproc Serverless pricing (https://cloud.google.com/dataproc-serverless/pricing)) + "acceleratorType": "A String", # Optional. Accelerator type being used, if any Deprecated: This field is only used in runtime versions below 3.0. + "milliAccelerator": "A String", # Optional. Milli (one-thousandth) accelerator. (see Dataproc Serverless pricing (https://cloud.google.com/dataproc-serverless/pricing)) Deprecated: This field is only used in runtime versions below 3.0. + "milliAcceleratorA10040": "A String", # Optional. Milli (one-thousandth) accelerator for A100-40 accelerators. (see Dataproc Serverless pricing (https://cloud.google.com/dataproc-serverless/pricing)) + "milliAcceleratorA10080": "A String", # Optional. Milli (one-thousandth) accelerator for A100-80 accelerators. (see Dataproc Serverless pricing (https://cloud.google.com/dataproc-serverless/pricing)) + "milliAcceleratorL4": "A String", # Optional. Milli (one-thousandth) accelerator for L4 accelerators. (see Dataproc Serverless pricing (https://cloud.google.com/dataproc-serverless/pricing)) "milliDcu": "A String", # Optional. Milli (one-thousandth) Dataproc Compute Units (DCUs) (see Dataproc Serverless pricing (https://cloud.google.com/dataproc-serverless/pricing)). "milliDcuPremium": "A String", # Optional. Milli (one-thousandth) Dataproc Compute Units (DCUs) charged at premium tier (see Dataproc Serverless pricing (https://cloud.google.com/dataproc-serverless/pricing)). "shuffleStorageGb": "A String", # Optional. Shuffle Storage in gigabytes (GB). (see Dataproc Serverless pricing (https://cloud.google.com/dataproc-serverless/pricing)) diff --git a/docs/dyn/dataproc_v1.projects.locations.sessions.html b/docs/dyn/dataproc_v1.projects.locations.sessions.html index a20aaf393d..27fe0f69c3 100644 --- a/docs/dyn/dataproc_v1.projects.locations.sessions.html +++ b/docs/dyn/dataproc_v1.projects.locations.sessions.html @@ -172,8 +172,11 @@

Method Details

}, "runtimeInfo": { # Runtime information about workload execution. # Output only. Runtime information about session execution. "approximateUsage": { # Usage metrics represent approximate total resources consumed by a workload. # Output only. Approximate workload resource usage, calculated when the workload completes (see Dataproc Serverless pricing (https://cloud.google.com/dataproc-serverless/pricing)).Note: This metric calculation may change in the future, for example, to capture cumulative workload resource consumption during workload execution (see the Dataproc Serverless release notes (https://cloud.google.com/dataproc-serverless/docs/release-notes) for announcements, changes, fixes and other Dataproc developments). - "acceleratorType": "A String", # Optional. DEPRECATED Accelerator type being used, if any - "milliAcceleratorSeconds": "A String", # Optional. DEPRECATED Accelerator usage in (milliAccelerator x seconds) (see Dataproc Serverless pricing (https://cloud.google.com/dataproc-serverless/pricing)). + "acceleratorType": "A String", # Optional. Accelerator type being used, if any Deprecated: This field is only used in runtime versions below 3.0. + "milliAcceleratorSeconds": "A String", # Optional. Accelerator usage in (milliAccelerator x seconds) (see Dataproc Serverless pricing (https://cloud.google.com/dataproc-serverless/pricing)). Deprecated: This field is only used in runtime versions below 3.0. + "milliAcceleratorSecondsA10040": "A String", # Optional. A100-40 accelerator usage in (milliAccelerator x seconds) (see Dataproc Serverless pricing (https://cloud.google.com/dataproc-serverless/pricing)). + "milliAcceleratorSecondsA10080": "A String", # Optional. A100-80 accelerator usage in (milliAccelerator x seconds) (see Dataproc Serverless pricing (https://cloud.google.com/dataproc-serverless/pricing)). + "milliAcceleratorSecondsL4": "A String", # Optional. L4 accelerator usage in (milliAccelerator x seconds) (see Dataproc Serverless pricing (https://cloud.google.com/dataproc-serverless/pricing)). "milliDcuSeconds": "A String", # Optional. DCU (Dataproc Compute Units) usage in (milliDCU x seconds) (see Dataproc Serverless pricing (https://cloud.google.com/dataproc-serverless/pricing)). "shuffleStorageGbSeconds": "A String", # Optional. Shuffle storage usage in (GB x seconds) (see Dataproc Serverless pricing (https://cloud.google.com/dataproc-serverless/pricing)). "updateTime": "A String", # Optional. The timestamp of the usage metrics. @@ -183,8 +186,11 @@

Method Details

"cohortSource": "A String", # Output only. Source of the cohort. }, "currentUsage": { # The usage snapshot represents the resources consumed by a workload at a specified time. # Output only. Snapshot of current workload resource usage. - "acceleratorType": "A String", # Optional. Accelerator type being used, if any - "milliAccelerator": "A String", # Optional. Milli (one-thousandth) accelerator. (see Dataproc Serverless pricing (https://cloud.google.com/dataproc-serverless/pricing)) + "acceleratorType": "A String", # Optional. Accelerator type being used, if any Deprecated: This field is only used in runtime versions below 3.0. + "milliAccelerator": "A String", # Optional. Milli (one-thousandth) accelerator. (see Dataproc Serverless pricing (https://cloud.google.com/dataproc-serverless/pricing)) Deprecated: This field is only used in runtime versions below 3.0. + "milliAcceleratorA10040": "A String", # Optional. Milli (one-thousandth) accelerator for A100-40 accelerators. (see Dataproc Serverless pricing (https://cloud.google.com/dataproc-serverless/pricing)) + "milliAcceleratorA10080": "A String", # Optional. Milli (one-thousandth) accelerator for A100-80 accelerators. (see Dataproc Serverless pricing (https://cloud.google.com/dataproc-serverless/pricing)) + "milliAcceleratorL4": "A String", # Optional. Milli (one-thousandth) accelerator for L4 accelerators. (see Dataproc Serverless pricing (https://cloud.google.com/dataproc-serverless/pricing)) "milliDcu": "A String", # Optional. Milli (one-thousandth) Dataproc Compute Units (DCUs) (see Dataproc Serverless pricing (https://cloud.google.com/dataproc-serverless/pricing)). "milliDcuPremium": "A String", # Optional. Milli (one-thousandth) Dataproc Compute Units (DCUs) charged at premium tier (see Dataproc Serverless pricing (https://cloud.google.com/dataproc-serverless/pricing)). "shuffleStorageGb": "A String", # Optional. Shuffle Storage in gigabytes (GB). (see Dataproc Serverless pricing (https://cloud.google.com/dataproc-serverless/pricing)) @@ -361,8 +367,11 @@

Method Details

}, "runtimeInfo": { # Runtime information about workload execution. # Output only. Runtime information about session execution. "approximateUsage": { # Usage metrics represent approximate total resources consumed by a workload. # Output only. Approximate workload resource usage, calculated when the workload completes (see Dataproc Serverless pricing (https://cloud.google.com/dataproc-serverless/pricing)).Note: This metric calculation may change in the future, for example, to capture cumulative workload resource consumption during workload execution (see the Dataproc Serverless release notes (https://cloud.google.com/dataproc-serverless/docs/release-notes) for announcements, changes, fixes and other Dataproc developments). - "acceleratorType": "A String", # Optional. DEPRECATED Accelerator type being used, if any - "milliAcceleratorSeconds": "A String", # Optional. DEPRECATED Accelerator usage in (milliAccelerator x seconds) (see Dataproc Serverless pricing (https://cloud.google.com/dataproc-serverless/pricing)). + "acceleratorType": "A String", # Optional. Accelerator type being used, if any Deprecated: This field is only used in runtime versions below 3.0. + "milliAcceleratorSeconds": "A String", # Optional. Accelerator usage in (milliAccelerator x seconds) (see Dataproc Serverless pricing (https://cloud.google.com/dataproc-serverless/pricing)). Deprecated: This field is only used in runtime versions below 3.0. + "milliAcceleratorSecondsA10040": "A String", # Optional. A100-40 accelerator usage in (milliAccelerator x seconds) (see Dataproc Serverless pricing (https://cloud.google.com/dataproc-serverless/pricing)). + "milliAcceleratorSecondsA10080": "A String", # Optional. A100-80 accelerator usage in (milliAccelerator x seconds) (see Dataproc Serverless pricing (https://cloud.google.com/dataproc-serverless/pricing)). + "milliAcceleratorSecondsL4": "A String", # Optional. L4 accelerator usage in (milliAccelerator x seconds) (see Dataproc Serverless pricing (https://cloud.google.com/dataproc-serverless/pricing)). "milliDcuSeconds": "A String", # Optional. DCU (Dataproc Compute Units) usage in (milliDCU x seconds) (see Dataproc Serverless pricing (https://cloud.google.com/dataproc-serverless/pricing)). "shuffleStorageGbSeconds": "A String", # Optional. Shuffle storage usage in (GB x seconds) (see Dataproc Serverless pricing (https://cloud.google.com/dataproc-serverless/pricing)). "updateTime": "A String", # Optional. The timestamp of the usage metrics. @@ -372,8 +381,11 @@

Method Details

"cohortSource": "A String", # Output only. Source of the cohort. }, "currentUsage": { # The usage snapshot represents the resources consumed by a workload at a specified time. # Output only. Snapshot of current workload resource usage. - "acceleratorType": "A String", # Optional. Accelerator type being used, if any - "milliAccelerator": "A String", # Optional. Milli (one-thousandth) accelerator. (see Dataproc Serverless pricing (https://cloud.google.com/dataproc-serverless/pricing)) + "acceleratorType": "A String", # Optional. Accelerator type being used, if any Deprecated: This field is only used in runtime versions below 3.0. + "milliAccelerator": "A String", # Optional. Milli (one-thousandth) accelerator. (see Dataproc Serverless pricing (https://cloud.google.com/dataproc-serverless/pricing)) Deprecated: This field is only used in runtime versions below 3.0. + "milliAcceleratorA10040": "A String", # Optional. Milli (one-thousandth) accelerator for A100-40 accelerators. (see Dataproc Serverless pricing (https://cloud.google.com/dataproc-serverless/pricing)) + "milliAcceleratorA10080": "A String", # Optional. Milli (one-thousandth) accelerator for A100-80 accelerators. (see Dataproc Serverless pricing (https://cloud.google.com/dataproc-serverless/pricing)) + "milliAcceleratorL4": "A String", # Optional. Milli (one-thousandth) accelerator for L4 accelerators. (see Dataproc Serverless pricing (https://cloud.google.com/dataproc-serverless/pricing)) "milliDcu": "A String", # Optional. Milli (one-thousandth) Dataproc Compute Units (DCUs) (see Dataproc Serverless pricing (https://cloud.google.com/dataproc-serverless/pricing)). "milliDcuPremium": "A String", # Optional. Milli (one-thousandth) Dataproc Compute Units (DCUs) charged at premium tier (see Dataproc Serverless pricing (https://cloud.google.com/dataproc-serverless/pricing)). "shuffleStorageGb": "A String", # Optional. Shuffle Storage in gigabytes (GB). (see Dataproc Serverless pricing (https://cloud.google.com/dataproc-serverless/pricing)) @@ -490,8 +502,11 @@

Method Details

}, "runtimeInfo": { # Runtime information about workload execution. # Output only. Runtime information about session execution. "approximateUsage": { # Usage metrics represent approximate total resources consumed by a workload. # Output only. Approximate workload resource usage, calculated when the workload completes (see Dataproc Serverless pricing (https://cloud.google.com/dataproc-serverless/pricing)).Note: This metric calculation may change in the future, for example, to capture cumulative workload resource consumption during workload execution (see the Dataproc Serverless release notes (https://cloud.google.com/dataproc-serverless/docs/release-notes) for announcements, changes, fixes and other Dataproc developments). - "acceleratorType": "A String", # Optional. DEPRECATED Accelerator type being used, if any - "milliAcceleratorSeconds": "A String", # Optional. DEPRECATED Accelerator usage in (milliAccelerator x seconds) (see Dataproc Serverless pricing (https://cloud.google.com/dataproc-serverless/pricing)). + "acceleratorType": "A String", # Optional. Accelerator type being used, if any Deprecated: This field is only used in runtime versions below 3.0. + "milliAcceleratorSeconds": "A String", # Optional. Accelerator usage in (milliAccelerator x seconds) (see Dataproc Serverless pricing (https://cloud.google.com/dataproc-serverless/pricing)). Deprecated: This field is only used in runtime versions below 3.0. + "milliAcceleratorSecondsA10040": "A String", # Optional. A100-40 accelerator usage in (milliAccelerator x seconds) (see Dataproc Serverless pricing (https://cloud.google.com/dataproc-serverless/pricing)). + "milliAcceleratorSecondsA10080": "A String", # Optional. A100-80 accelerator usage in (milliAccelerator x seconds) (see Dataproc Serverless pricing (https://cloud.google.com/dataproc-serverless/pricing)). + "milliAcceleratorSecondsL4": "A String", # Optional. L4 accelerator usage in (milliAccelerator x seconds) (see Dataproc Serverless pricing (https://cloud.google.com/dataproc-serverless/pricing)). "milliDcuSeconds": "A String", # Optional. DCU (Dataproc Compute Units) usage in (milliDCU x seconds) (see Dataproc Serverless pricing (https://cloud.google.com/dataproc-serverless/pricing)). "shuffleStorageGbSeconds": "A String", # Optional. Shuffle storage usage in (GB x seconds) (see Dataproc Serverless pricing (https://cloud.google.com/dataproc-serverless/pricing)). "updateTime": "A String", # Optional. The timestamp of the usage metrics. @@ -501,8 +516,11 @@

Method Details

"cohortSource": "A String", # Output only. Source of the cohort. }, "currentUsage": { # The usage snapshot represents the resources consumed by a workload at a specified time. # Output only. Snapshot of current workload resource usage. - "acceleratorType": "A String", # Optional. Accelerator type being used, if any - "milliAccelerator": "A String", # Optional. Milli (one-thousandth) accelerator. (see Dataproc Serverless pricing (https://cloud.google.com/dataproc-serverless/pricing)) + "acceleratorType": "A String", # Optional. Accelerator type being used, if any Deprecated: This field is only used in runtime versions below 3.0. + "milliAccelerator": "A String", # Optional. Milli (one-thousandth) accelerator. (see Dataproc Serverless pricing (https://cloud.google.com/dataproc-serverless/pricing)) Deprecated: This field is only used in runtime versions below 3.0. + "milliAcceleratorA10040": "A String", # Optional. Milli (one-thousandth) accelerator for A100-40 accelerators. (see Dataproc Serverless pricing (https://cloud.google.com/dataproc-serverless/pricing)) + "milliAcceleratorA10080": "A String", # Optional. Milli (one-thousandth) accelerator for A100-80 accelerators. (see Dataproc Serverless pricing (https://cloud.google.com/dataproc-serverless/pricing)) + "milliAcceleratorL4": "A String", # Optional. Milli (one-thousandth) accelerator for L4 accelerators. (see Dataproc Serverless pricing (https://cloud.google.com/dataproc-serverless/pricing)) "milliDcu": "A String", # Optional. Milli (one-thousandth) Dataproc Compute Units (DCUs) (see Dataproc Serverless pricing (https://cloud.google.com/dataproc-serverless/pricing)). "milliDcuPremium": "A String", # Optional. Milli (one-thousandth) Dataproc Compute Units (DCUs) charged at premium tier (see Dataproc Serverless pricing (https://cloud.google.com/dataproc-serverless/pricing)). "shuffleStorageGb": "A String", # Optional. Shuffle Storage in gigabytes (GB). (see Dataproc Serverless pricing (https://cloud.google.com/dataproc-serverless/pricing)) diff --git a/docs/dyn/developerconnect_v1.projects.locations.insightsConfigs.deploymentEvents.html b/docs/dyn/developerconnect_v1.projects.locations.insightsConfigs.deploymentEvents.html index a4c5b6e4c5..2706a1962d 100644 --- a/docs/dyn/developerconnect_v1.projects.locations.insightsConfigs.deploymentEvents.html +++ b/docs/dyn/developerconnect_v1.projects.locations.insightsConfigs.deploymentEvents.html @@ -114,6 +114,9 @@

Method Details

"containerStatusSummary": "A String", # Output only. The summary of container status of the artifact deployment. Format as `ContainerStatusState-Reason : restartCount` e.g. "Waiting-ImagePullBackOff : 3" "deployTime": "A String", # Output only. The time at which the deployment was deployed. "id": "A String", # Output only. Unique identifier of `ArtifactDeployment`. + "sourceCodeUris": [ # Output only. The URIs of the source code, if available. For Cloud Run source deploy for example: `gs://my-bucket/my-folder/1234567890.abcde-fdbe.zip#1234567890` + "A String", + ], "sourceCommitUris": [ # Output only. The source commits at which this artifact was built. Extracted from provenance. "A String", ], @@ -178,6 +181,9 @@

Method Details

"containerStatusSummary": "A String", # Output only. The summary of container status of the artifact deployment. Format as `ContainerStatusState-Reason : restartCount` e.g. "Waiting-ImagePullBackOff : 3" "deployTime": "A String", # Output only. The time at which the deployment was deployed. "id": "A String", # Output only. Unique identifier of `ArtifactDeployment`. + "sourceCodeUris": [ # Output only. The URIs of the source code, if available. For Cloud Run source deploy for example: `gs://my-bucket/my-folder/1234567890.abcde-fdbe.zip#1234567890` + "A String", + ], "sourceCommitUris": [ # Output only. The source commits at which this artifact was built. Extracted from provenance. "A String", ], diff --git a/docs/dyn/developerknowledge_v1.documents.html b/docs/dyn/developerknowledge_v1.documents.html index 2669ba3801..0b6a9d2ffd 100644 --- a/docs/dyn/developerknowledge_v1.documents.html +++ b/docs/dyn/developerknowledge_v1.documents.html @@ -95,7 +95,7 @@

Method Details

Retrieves multiple documents, each with its full Markdown content.
 
 Args:
-  names: string, Required. Specifies the names of the documents to retrieve. A maximum of 20 documents can be retrieved in a batch. The documents are returned in the same order as the `names` in the request. Format: `documents/{uri_without_scheme}` Example: `documents/docs.cloud.google.com/storage/docs/creating-buckets` If you are changing the batch size, consider the value of `maxConcurrentGCSFetches` constant in the service implementation: http://cs///depot/google3/devrel/boq/developerknowledge/service/developerknowledge.go (repeated)
+  names: string, Required. Specifies the names of the documents to retrieve. A maximum of 20 documents can be retrieved in a batch. The documents are returned in the same order as the `names` in the request. Format: `documents/{uri_without_scheme}` Example: `documents/docs.cloud.google.com/storage/docs/creating-buckets`  (repeated)
   view: string, Optional. Specifies the DocumentView of the document. If unspecified, DeveloperKnowledge.BatchGetDocuments defaults to `DOCUMENT_VIEW_CONTENT`.
     Allowed values
       DOCUMENT_VIEW_UNSPECIFIED - The default / unset value. See each API method for its default value if DocumentView is not specified.
diff --git a/docs/dyn/developerknowledge_v1alpha.documents.html b/docs/dyn/developerknowledge_v1alpha.documents.html
index 0785d735c5..478f48da6d 100644
--- a/docs/dyn/developerknowledge_v1alpha.documents.html
+++ b/docs/dyn/developerknowledge_v1alpha.documents.html
@@ -95,7 +95,7 @@ 

Method Details

Retrieves multiple documents, each with its full Markdown content.
 
 Args:
-  names: string, Required. Specifies the names of the documents to retrieve. A maximum of 20 documents can be retrieved in a batch. The documents are returned in the same order as the `names` in the request. Format: `documents/{uri_without_scheme}` Example: `documents/docs.cloud.google.com/storage/docs/creating-buckets` If you are changing the batch size, consider the value of `maxConcurrentGCSFetches` constant in the service implementation: http://cs///depot/google3/devrel/boq/developerknowledge/service/developerknowledge.go (repeated)
+  names: string, Required. Specifies the names of the documents to retrieve. A maximum of 20 documents can be retrieved in a batch. The documents are returned in the same order as the `names` in the request. Format: `documents/{uri_without_scheme}` Example: `documents/docs.cloud.google.com/storage/docs/creating-buckets`  (repeated)
   view: string, Optional. Specifies the DocumentView of the document. If unspecified, DeveloperKnowledge.BatchGetDocuments defaults to `DOCUMENT_VIEW_CONTENT`.
     Allowed values
       DOCUMENT_VIEW_UNSPECIFIED - The default / unset value. See each API method for its default value if DocumentView is not specified.
diff --git a/docs/dyn/developerknowledge_v1alpha.v1alpha.html b/docs/dyn/developerknowledge_v1alpha.v1alpha.html
index 9d8883c0f6..285b8c8e8b 100644
--- a/docs/dyn/developerknowledge_v1alpha.v1alpha.html
+++ b/docs/dyn/developerknowledge_v1alpha.v1alpha.html
@@ -104,6 +104,38 @@ 

Method Details

{ # Response message for DeveloperKnowledge.AnswerQuery. "answer": { # An answer to a query. # The answer to the query. "answerText": "A String", # Contains the text of the answer. + "citations": [ # Output only. Contains citations for the answer. + { # Citation info for a segment. + "endIndex": 42, # Output only. Indicates the end of the segment, measured in bytes (UTF-8 unicode), exclusive. If there are multi-byte characters, such as non-ASCII characters, the index measurement is longer than the string length. + "sources": [ # Output only. Contains citation sources for the attributed segment. + { # Citation source. + "referenceIndex": 42, # Output only. Contains the index of the Answer.AnswerReference in the `references` repeated field. + }, + ], + "startIndex": 42, # Output only. Indicates the start of the segment, measured in bytes (UTF-8 unicode), inclusive. If there are multi-byte characters, such as non-ASCII characters, the index measurement is longer than the string length. + }, + ], + "references": [ # Output only. Contains references for the answer. + { # Represents a reference to a source. + "documentReference": { # Represents a reference to a document. # Output only. The reference document. + "documentChunk": { # A DocumentChunk represents a piece of content from a Document in the DeveloperKnowledge corpus. To fetch the entire document content, pass the `parent` to DeveloperKnowledge.GetDocument or DeveloperKnowledge.BatchGetDocuments. # Output only. Contains the document chunk. The `document_chunk.id` field is not set and will be empty. + "content": "A String", # Output only. Contains the content of the document chunk. + "document": { # A Document represents a piece of content from the Developer Knowledge corpus. # Output only. Represents metadata about the Document this chunk is from. The DocumentView of this Document message will be set to `DOCUMENT_VIEW_BASIC`. It is included here for convenience so that clients do not need to call DeveloperKnowledge.GetDocument or DeveloperKnowledge.BatchGetDocuments if they only need the metadata fields. Otherwise, clients should use DeveloperKnowledge.GetDocument or DeveloperKnowledge.BatchGetDocuments to fetch the full document content. + "content": "A String", # Output only. Contains the full content of the document in Markdown format. + "dataSource": "A String", # Output only. Specifies the data source of the document. Example data source: `firebase.google.com` + "description": "A String", # Output only. Provides a description of the document. + "name": "A String", # Identifier. Contains the resource name of the document. Format: `documents/{uri_without_scheme}` Example: `documents/docs.cloud.google.com/storage/docs/creating-buckets` + "title": "A String", # Output only. Provides the title of the document. + "updateTime": "A String", # Output only. Represents the timestamp when the content or metadata of the document was last updated. + "uri": "A String", # Output only. Provides the URI of the content, such as `docs.cloud.google.com/storage/docs/creating-buckets`. + "view": "A String", # Output only. Specifies the DocumentView of the document. + }, + "id": "A String", # Output only. Specifies the ID of this chunk within the document. The chunk ID is unique within a document, but not globally unique across documents. The chunk ID is not stable and may change over time. + "parent": "A String", # Output only. Contains the resource name of the document this chunk is from. Format: `documents/{uri_without_scheme}` Example: `documents/docs.cloud.google.com/storage/docs/creating-buckets` + }, + }, + }, + ], }, }
diff --git a/docs/dyn/dialogflow_v2.projects.conversationProfiles.html b/docs/dyn/dialogflow_v2.projects.conversationProfiles.html index 1f0dc60f51..87ee6fee1e 100644 --- a/docs/dyn/dialogflow_v2.projects.conversationProfiles.html +++ b/docs/dyn/dialogflow_v2.projects.conversationProfiles.html @@ -352,6 +352,17 @@

Method Details

"topic": "A String", }, "securitySettings": "A String", + "sipConfig": { + "allowVirtualAgentInteraction": True or False, + "copyInboundCallLegHeaders": [ + "A String", + ], + "createConversationOnTheFly": True or False, + "ignoreReinviteMediaDirection": True or False, + "inactiveStart": True or False, + "keepConversationRunning": True or False, + "maxAudioRecordingDuration": "A String", + }, "sttConfig": { "audioEncoding": "A String", "enableWordInfo": True or False, @@ -588,6 +599,17 @@

Method Details

"topic": "A String", }, "securitySettings": "A String", + "sipConfig": { + "allowVirtualAgentInteraction": True or False, + "copyInboundCallLegHeaders": [ + "A String", + ], + "createConversationOnTheFly": True or False, + "ignoreReinviteMediaDirection": True or False, + "inactiveStart": True or False, + "keepConversationRunning": True or False, + "maxAudioRecordingDuration": "A String", + }, "sttConfig": { "audioEncoding": "A String", "enableWordInfo": True or False, @@ -849,6 +871,17 @@

Method Details

"topic": "A String", }, "securitySettings": "A String", + "sipConfig": { + "allowVirtualAgentInteraction": True or False, + "copyInboundCallLegHeaders": [ + "A String", + ], + "createConversationOnTheFly": True or False, + "ignoreReinviteMediaDirection": True or False, + "inactiveStart": True or False, + "keepConversationRunning": True or False, + "maxAudioRecordingDuration": "A String", + }, "sttConfig": { "audioEncoding": "A String", "enableWordInfo": True or False, @@ -1096,6 +1129,17 @@

Method Details

"topic": "A String", }, "securitySettings": "A String", + "sipConfig": { + "allowVirtualAgentInteraction": True or False, + "copyInboundCallLegHeaders": [ + "A String", + ], + "createConversationOnTheFly": True or False, + "ignoreReinviteMediaDirection": True or False, + "inactiveStart": True or False, + "keepConversationRunning": True or False, + "maxAudioRecordingDuration": "A String", + }, "sttConfig": { "audioEncoding": "A String", "enableWordInfo": True or False, @@ -1351,6 +1395,17 @@

Method Details

"topic": "A String", }, "securitySettings": "A String", + "sipConfig": { + "allowVirtualAgentInteraction": True or False, + "copyInboundCallLegHeaders": [ + "A String", + ], + "createConversationOnTheFly": True or False, + "ignoreReinviteMediaDirection": True or False, + "inactiveStart": True or False, + "keepConversationRunning": True or False, + "maxAudioRecordingDuration": "A String", + }, "sttConfig": { "audioEncoding": "A String", "enableWordInfo": True or False, @@ -1588,6 +1643,17 @@

Method Details

"topic": "A String", }, "securitySettings": "A String", + "sipConfig": { + "allowVirtualAgentInteraction": True or False, + "copyInboundCallLegHeaders": [ + "A String", + ], + "createConversationOnTheFly": True or False, + "ignoreReinviteMediaDirection": True or False, + "inactiveStart": True or False, + "keepConversationRunning": True or False, + "maxAudioRecordingDuration": "A String", + }, "sttConfig": { "audioEncoding": "A String", "enableWordInfo": True or False, diff --git a/docs/dyn/dialogflow_v2.projects.conversations.html b/docs/dyn/dialogflow_v2.projects.conversations.html index 42a33bfc4d..2bd8c35b17 100644 --- a/docs/dyn/dialogflow_v2.projects.conversations.html +++ b/docs/dyn/dialogflow_v2.projects.conversations.html @@ -345,6 +345,17 @@

Method Details

"topic": "A String", }, "securitySettings": "A String", + "sipConfig": { + "allowVirtualAgentInteraction": True or False, + "copyInboundCallLegHeaders": [ + "A String", + ], + "createConversationOnTheFly": True or False, + "ignoreReinviteMediaDirection": True or False, + "inactiveStart": True or False, + "keepConversationRunning": True or False, + "maxAudioRecordingDuration": "A String", + }, "sttConfig": { "audioEncoding": "A String", "enableWordInfo": True or False, @@ -631,6 +642,17 @@

Method Details

"topic": "A String", }, "securitySettings": "A String", + "sipConfig": { + "allowVirtualAgentInteraction": True or False, + "copyInboundCallLegHeaders": [ + "A String", + ], + "createConversationOnTheFly": True or False, + "ignoreReinviteMediaDirection": True or False, + "inactiveStart": True or False, + "keepConversationRunning": True or False, + "maxAudioRecordingDuration": "A String", + }, "sttConfig": { "audioEncoding": "A String", "enableWordInfo": True or False, @@ -916,6 +938,17 @@

Method Details

"topic": "A String", }, "securitySettings": "A String", + "sipConfig": { + "allowVirtualAgentInteraction": True or False, + "copyInboundCallLegHeaders": [ + "A String", + ], + "createConversationOnTheFly": True or False, + "ignoreReinviteMediaDirection": True or False, + "inactiveStart": True or False, + "keepConversationRunning": True or False, + "maxAudioRecordingDuration": "A String", + }, "sttConfig": { "audioEncoding": "A String", "enableWordInfo": True or False, @@ -1207,6 +1240,17 @@

Method Details

"topic": "A String", }, "securitySettings": "A String", + "sipConfig": { + "allowVirtualAgentInteraction": True or False, + "copyInboundCallLegHeaders": [ + "A String", + ], + "createConversationOnTheFly": True or False, + "ignoreReinviteMediaDirection": True or False, + "inactiveStart": True or False, + "keepConversationRunning": True or False, + "maxAudioRecordingDuration": "A String", + }, "sttConfig": { "audioEncoding": "A String", "enableWordInfo": True or False, @@ -1503,6 +1547,17 @@

Method Details

"topic": "A String", }, "securitySettings": "A String", + "sipConfig": { + "allowVirtualAgentInteraction": True or False, + "copyInboundCallLegHeaders": [ + "A String", + ], + "createConversationOnTheFly": True or False, + "ignoreReinviteMediaDirection": True or False, + "inactiveStart": True or False, + "keepConversationRunning": True or False, + "maxAudioRecordingDuration": "A String", + }, "sttConfig": { "audioEncoding": "A String", "enableWordInfo": True or False, diff --git a/docs/dyn/dialogflow_v2.projects.conversations.participants.html b/docs/dyn/dialogflow_v2.projects.conversations.participants.html index 43fa007bbe..1f282603aa 100644 --- a/docs/dyn/dialogflow_v2.projects.conversations.participants.html +++ b/docs/dyn/dialogflow_v2.projects.conversations.participants.html @@ -917,6 +917,9 @@

Method Details

"knowledgeAssistAnswer": { "answerRecord": "A String", "knowledgeAssistDebugInfo": { + "cesDebugInfo": { + "a_key": "", # Properties of the object. + }, "datastoreResponseReason": "A String", "ingestedContextReferenceDebugInfo": { "contextReferenceRetrieved": True or False, @@ -948,6 +951,11 @@

Method Details

"useTranslatedMessage": True or False, }, "queryCategorizationFailureReason": "A String", + "queryGenerationDebugInfo": { + "candidatesTokenCount": 42, + "promptTokenCount": 42, + "totalTokenCount": 42, + }, "queryGenerationFailureReason": "A String", "serviceLatency": { "internalServiceLatencies": [ @@ -1198,6 +1206,9 @@

Method Details

"knowledgeAssistAnswer": { "answerRecord": "A String", "knowledgeAssistDebugInfo": { + "cesDebugInfo": { + "a_key": "", # Properties of the object. + }, "datastoreResponseReason": "A String", "ingestedContextReferenceDebugInfo": { "contextReferenceRetrieved": True or False, @@ -1229,6 +1240,11 @@

Method Details

"useTranslatedMessage": True or False, }, "queryCategorizationFailureReason": "A String", + "queryGenerationDebugInfo": { + "candidatesTokenCount": 42, + "promptTokenCount": 42, + "totalTokenCount": 42, + }, "queryGenerationFailureReason": "A String", "serviceLatency": { "internalServiceLatencies": [ diff --git a/docs/dyn/dialogflow_v2.projects.conversations.participants.suggestions.html b/docs/dyn/dialogflow_v2.projects.conversations.participants.suggestions.html index 9e93b15060..521002571a 100644 --- a/docs/dyn/dialogflow_v2.projects.conversations.participants.suggestions.html +++ b/docs/dyn/dialogflow_v2.projects.conversations.participants.suggestions.html @@ -215,6 +215,9 @@

Method Details

"knowledgeAssistAnswer": { "answerRecord": "A String", "knowledgeAssistDebugInfo": { + "cesDebugInfo": { + "a_key": "", # Properties of the object. + }, "datastoreResponseReason": "A String", "ingestedContextReferenceDebugInfo": { "contextReferenceRetrieved": True or False, @@ -246,6 +249,11 @@

Method Details

"useTranslatedMessage": True or False, }, "queryCategorizationFailureReason": "A String", + "queryGenerationDebugInfo": { + "candidatesTokenCount": 42, + "promptTokenCount": 42, + "totalTokenCount": 42, + }, "queryGenerationFailureReason": "A String", "serviceLatency": { "internalServiceLatencies": [ diff --git a/docs/dyn/dialogflow_v2.projects.locations.conversationProfiles.html b/docs/dyn/dialogflow_v2.projects.locations.conversationProfiles.html index c4fb802168..c917985466 100644 --- a/docs/dyn/dialogflow_v2.projects.locations.conversationProfiles.html +++ b/docs/dyn/dialogflow_v2.projects.locations.conversationProfiles.html @@ -352,6 +352,17 @@

Method Details

"topic": "A String", }, "securitySettings": "A String", + "sipConfig": { + "allowVirtualAgentInteraction": True or False, + "copyInboundCallLegHeaders": [ + "A String", + ], + "createConversationOnTheFly": True or False, + "ignoreReinviteMediaDirection": True or False, + "inactiveStart": True or False, + "keepConversationRunning": True or False, + "maxAudioRecordingDuration": "A String", + }, "sttConfig": { "audioEncoding": "A String", "enableWordInfo": True or False, @@ -588,6 +599,17 @@

Method Details

"topic": "A String", }, "securitySettings": "A String", + "sipConfig": { + "allowVirtualAgentInteraction": True or False, + "copyInboundCallLegHeaders": [ + "A String", + ], + "createConversationOnTheFly": True or False, + "ignoreReinviteMediaDirection": True or False, + "inactiveStart": True or False, + "keepConversationRunning": True or False, + "maxAudioRecordingDuration": "A String", + }, "sttConfig": { "audioEncoding": "A String", "enableWordInfo": True or False, @@ -849,6 +871,17 @@

Method Details

"topic": "A String", }, "securitySettings": "A String", + "sipConfig": { + "allowVirtualAgentInteraction": True or False, + "copyInboundCallLegHeaders": [ + "A String", + ], + "createConversationOnTheFly": True or False, + "ignoreReinviteMediaDirection": True or False, + "inactiveStart": True or False, + "keepConversationRunning": True or False, + "maxAudioRecordingDuration": "A String", + }, "sttConfig": { "audioEncoding": "A String", "enableWordInfo": True or False, @@ -1096,6 +1129,17 @@

Method Details

"topic": "A String", }, "securitySettings": "A String", + "sipConfig": { + "allowVirtualAgentInteraction": True or False, + "copyInboundCallLegHeaders": [ + "A String", + ], + "createConversationOnTheFly": True or False, + "ignoreReinviteMediaDirection": True or False, + "inactiveStart": True or False, + "keepConversationRunning": True or False, + "maxAudioRecordingDuration": "A String", + }, "sttConfig": { "audioEncoding": "A String", "enableWordInfo": True or False, @@ -1351,6 +1395,17 @@

Method Details

"topic": "A String", }, "securitySettings": "A String", + "sipConfig": { + "allowVirtualAgentInteraction": True or False, + "copyInboundCallLegHeaders": [ + "A String", + ], + "createConversationOnTheFly": True or False, + "ignoreReinviteMediaDirection": True or False, + "inactiveStart": True or False, + "keepConversationRunning": True or False, + "maxAudioRecordingDuration": "A String", + }, "sttConfig": { "audioEncoding": "A String", "enableWordInfo": True or False, @@ -1588,6 +1643,17 @@

Method Details

"topic": "A String", }, "securitySettings": "A String", + "sipConfig": { + "allowVirtualAgentInteraction": True or False, + "copyInboundCallLegHeaders": [ + "A String", + ], + "createConversationOnTheFly": True or False, + "ignoreReinviteMediaDirection": True or False, + "inactiveStart": True or False, + "keepConversationRunning": True or False, + "maxAudioRecordingDuration": "A String", + }, "sttConfig": { "audioEncoding": "A String", "enableWordInfo": True or False, diff --git a/docs/dyn/dialogflow_v2.projects.locations.conversations.html b/docs/dyn/dialogflow_v2.projects.locations.conversations.html index b1cb31273a..2976959761 100644 --- a/docs/dyn/dialogflow_v2.projects.locations.conversations.html +++ b/docs/dyn/dialogflow_v2.projects.locations.conversations.html @@ -348,6 +348,17 @@

Method Details

"topic": "A String", }, "securitySettings": "A String", + "sipConfig": { + "allowVirtualAgentInteraction": True or False, + "copyInboundCallLegHeaders": [ + "A String", + ], + "createConversationOnTheFly": True or False, + "ignoreReinviteMediaDirection": True or False, + "inactiveStart": True or False, + "keepConversationRunning": True or False, + "maxAudioRecordingDuration": "A String", + }, "sttConfig": { "audioEncoding": "A String", "enableWordInfo": True or False, @@ -634,6 +645,17 @@

Method Details

"topic": "A String", }, "securitySettings": "A String", + "sipConfig": { + "allowVirtualAgentInteraction": True or False, + "copyInboundCallLegHeaders": [ + "A String", + ], + "createConversationOnTheFly": True or False, + "ignoreReinviteMediaDirection": True or False, + "inactiveStart": True or False, + "keepConversationRunning": True or False, + "maxAudioRecordingDuration": "A String", + }, "sttConfig": { "audioEncoding": "A String", "enableWordInfo": True or False, @@ -919,6 +941,17 @@

Method Details

"topic": "A String", }, "securitySettings": "A String", + "sipConfig": { + "allowVirtualAgentInteraction": True or False, + "copyInboundCallLegHeaders": [ + "A String", + ], + "createConversationOnTheFly": True or False, + "ignoreReinviteMediaDirection": True or False, + "inactiveStart": True or False, + "keepConversationRunning": True or False, + "maxAudioRecordingDuration": "A String", + }, "sttConfig": { "audioEncoding": "A String", "enableWordInfo": True or False, @@ -1210,6 +1243,17 @@

Method Details

"topic": "A String", }, "securitySettings": "A String", + "sipConfig": { + "allowVirtualAgentInteraction": True or False, + "copyInboundCallLegHeaders": [ + "A String", + ], + "createConversationOnTheFly": True or False, + "ignoreReinviteMediaDirection": True or False, + "inactiveStart": True or False, + "keepConversationRunning": True or False, + "maxAudioRecordingDuration": "A String", + }, "sttConfig": { "audioEncoding": "A String", "enableWordInfo": True or False, @@ -1560,6 +1604,17 @@

Method Details

"topic": "A String", }, "securitySettings": "A String", + "sipConfig": { + "allowVirtualAgentInteraction": True or False, + "copyInboundCallLegHeaders": [ + "A String", + ], + "createConversationOnTheFly": True or False, + "ignoreReinviteMediaDirection": True or False, + "inactiveStart": True or False, + "keepConversationRunning": True or False, + "maxAudioRecordingDuration": "A String", + }, "sttConfig": { "audioEncoding": "A String", "enableWordInfo": True or False, diff --git a/docs/dyn/dialogflow_v2.projects.locations.conversations.participants.html b/docs/dyn/dialogflow_v2.projects.locations.conversations.participants.html index dcd6440c44..102420508c 100644 --- a/docs/dyn/dialogflow_v2.projects.locations.conversations.participants.html +++ b/docs/dyn/dialogflow_v2.projects.locations.conversations.participants.html @@ -917,6 +917,9 @@

Method Details

"knowledgeAssistAnswer": { "answerRecord": "A String", "knowledgeAssistDebugInfo": { + "cesDebugInfo": { + "a_key": "", # Properties of the object. + }, "datastoreResponseReason": "A String", "ingestedContextReferenceDebugInfo": { "contextReferenceRetrieved": True or False, @@ -948,6 +951,11 @@

Method Details

"useTranslatedMessage": True or False, }, "queryCategorizationFailureReason": "A String", + "queryGenerationDebugInfo": { + "candidatesTokenCount": 42, + "promptTokenCount": 42, + "totalTokenCount": 42, + }, "queryGenerationFailureReason": "A String", "serviceLatency": { "internalServiceLatencies": [ @@ -1198,6 +1206,9 @@

Method Details

"knowledgeAssistAnswer": { "answerRecord": "A String", "knowledgeAssistDebugInfo": { + "cesDebugInfo": { + "a_key": "", # Properties of the object. + }, "datastoreResponseReason": "A String", "ingestedContextReferenceDebugInfo": { "contextReferenceRetrieved": True or False, @@ -1229,6 +1240,11 @@

Method Details

"useTranslatedMessage": True or False, }, "queryCategorizationFailureReason": "A String", + "queryGenerationDebugInfo": { + "candidatesTokenCount": 42, + "promptTokenCount": 42, + "totalTokenCount": 42, + }, "queryGenerationFailureReason": "A String", "serviceLatency": { "internalServiceLatencies": [ diff --git a/docs/dyn/dialogflow_v2.projects.locations.conversations.participants.suggestions.html b/docs/dyn/dialogflow_v2.projects.locations.conversations.participants.suggestions.html index 722f531892..0c72b151dc 100644 --- a/docs/dyn/dialogflow_v2.projects.locations.conversations.participants.suggestions.html +++ b/docs/dyn/dialogflow_v2.projects.locations.conversations.participants.suggestions.html @@ -215,6 +215,9 @@

Method Details

"knowledgeAssistAnswer": { "answerRecord": "A String", "knowledgeAssistDebugInfo": { + "cesDebugInfo": { + "a_key": "", # Properties of the object. + }, "datastoreResponseReason": "A String", "ingestedContextReferenceDebugInfo": { "contextReferenceRetrieved": True or False, @@ -246,6 +249,11 @@

Method Details

"useTranslatedMessage": True or False, }, "queryCategorizationFailureReason": "A String", + "queryGenerationDebugInfo": { + "candidatesTokenCount": 42, + "promptTokenCount": 42, + "totalTokenCount": 42, + }, "queryGenerationFailureReason": "A String", "serviceLatency": { "internalServiceLatencies": [ diff --git a/docs/dyn/dialogflow_v2.projects.locations.suggestions.html b/docs/dyn/dialogflow_v2.projects.locations.suggestions.html index 884533a790..c010ce09d2 100644 --- a/docs/dyn/dialogflow_v2.projects.locations.suggestions.html +++ b/docs/dyn/dialogflow_v2.projects.locations.suggestions.html @@ -292,6 +292,17 @@

Method Details

"topic": "A String", }, "securitySettings": "A String", + "sipConfig": { + "allowVirtualAgentInteraction": True or False, + "copyInboundCallLegHeaders": [ + "A String", + ], + "createConversationOnTheFly": True or False, + "ignoreReinviteMediaDirection": True or False, + "inactiveStart": True or False, + "keepConversationRunning": True or False, + "maxAudioRecordingDuration": "A String", + }, "sttConfig": { "audioEncoding": "A String", "enableWordInfo": True or False, diff --git a/docs/dyn/dialogflow_v2.projects.suggestions.html b/docs/dyn/dialogflow_v2.projects.suggestions.html index 3a0dd3250c..c87f0c2b40 100644 --- a/docs/dyn/dialogflow_v2.projects.suggestions.html +++ b/docs/dyn/dialogflow_v2.projects.suggestions.html @@ -292,6 +292,17 @@

Method Details

"topic": "A String", }, "securitySettings": "A String", + "sipConfig": { + "allowVirtualAgentInteraction": True or False, + "copyInboundCallLegHeaders": [ + "A String", + ], + "createConversationOnTheFly": True or False, + "ignoreReinviteMediaDirection": True or False, + "inactiveStart": True or False, + "keepConversationRunning": True or False, + "maxAudioRecordingDuration": "A String", + }, "sttConfig": { "audioEncoding": "A String", "enableWordInfo": True or False, diff --git a/docs/dyn/dialogflow_v2beta1.projects.conversationProfiles.html b/docs/dyn/dialogflow_v2beta1.projects.conversationProfiles.html index 36366d41ae..d198e8ce9d 100644 --- a/docs/dyn/dialogflow_v2beta1.projects.conversationProfiles.html +++ b/docs/dyn/dialogflow_v2beta1.projects.conversationProfiles.html @@ -352,6 +352,17 @@

Method Details

"topic": "A String", }, "securitySettings": "A String", + "sipConfig": { + "allowVirtualAgentInteraction": True or False, + "copyInboundCallLegHeaders": [ + "A String", + ], + "createConversationOnTheFly": True or False, + "ignoreReinviteMediaDirection": True or False, + "inactiveStart": True or False, + "keepConversationRunning": True or False, + "maxAudioRecordingDuration": "A String", + }, "sttConfig": { "audioEncoding": "A String", "enableWordInfo": True or False, @@ -589,6 +600,17 @@

Method Details

"topic": "A String", }, "securitySettings": "A String", + "sipConfig": { + "allowVirtualAgentInteraction": True or False, + "copyInboundCallLegHeaders": [ + "A String", + ], + "createConversationOnTheFly": True or False, + "ignoreReinviteMediaDirection": True or False, + "inactiveStart": True or False, + "keepConversationRunning": True or False, + "maxAudioRecordingDuration": "A String", + }, "sttConfig": { "audioEncoding": "A String", "enableWordInfo": True or False, @@ -851,6 +873,17 @@

Method Details

"topic": "A String", }, "securitySettings": "A String", + "sipConfig": { + "allowVirtualAgentInteraction": True or False, + "copyInboundCallLegHeaders": [ + "A String", + ], + "createConversationOnTheFly": True or False, + "ignoreReinviteMediaDirection": True or False, + "inactiveStart": True or False, + "keepConversationRunning": True or False, + "maxAudioRecordingDuration": "A String", + }, "sttConfig": { "audioEncoding": "A String", "enableWordInfo": True or False, @@ -1099,6 +1132,17 @@

Method Details

"topic": "A String", }, "securitySettings": "A String", + "sipConfig": { + "allowVirtualAgentInteraction": True or False, + "copyInboundCallLegHeaders": [ + "A String", + ], + "createConversationOnTheFly": True or False, + "ignoreReinviteMediaDirection": True or False, + "inactiveStart": True or False, + "keepConversationRunning": True or False, + "maxAudioRecordingDuration": "A String", + }, "sttConfig": { "audioEncoding": "A String", "enableWordInfo": True or False, @@ -1355,6 +1399,17 @@

Method Details

"topic": "A String", }, "securitySettings": "A String", + "sipConfig": { + "allowVirtualAgentInteraction": True or False, + "copyInboundCallLegHeaders": [ + "A String", + ], + "createConversationOnTheFly": True or False, + "ignoreReinviteMediaDirection": True or False, + "inactiveStart": True or False, + "keepConversationRunning": True or False, + "maxAudioRecordingDuration": "A String", + }, "sttConfig": { "audioEncoding": "A String", "enableWordInfo": True or False, @@ -1593,6 +1648,17 @@

Method Details

"topic": "A String", }, "securitySettings": "A String", + "sipConfig": { + "allowVirtualAgentInteraction": True or False, + "copyInboundCallLegHeaders": [ + "A String", + ], + "createConversationOnTheFly": True or False, + "ignoreReinviteMediaDirection": True or False, + "inactiveStart": True or False, + "keepConversationRunning": True or False, + "maxAudioRecordingDuration": "A String", + }, "sttConfig": { "audioEncoding": "A String", "enableWordInfo": True or False, diff --git a/docs/dyn/dialogflow_v2beta1.projects.conversations.html b/docs/dyn/dialogflow_v2beta1.projects.conversations.html index e41b6a46ca..991bcebdb7 100644 --- a/docs/dyn/dialogflow_v2beta1.projects.conversations.html +++ b/docs/dyn/dialogflow_v2beta1.projects.conversations.html @@ -345,6 +345,17 @@

Method Details

"topic": "A String", }, "securitySettings": "A String", + "sipConfig": { + "allowVirtualAgentInteraction": True or False, + "copyInboundCallLegHeaders": [ + "A String", + ], + "createConversationOnTheFly": True or False, + "ignoreReinviteMediaDirection": True or False, + "inactiveStart": True or False, + "keepConversationRunning": True or False, + "maxAudioRecordingDuration": "A String", + }, "sttConfig": { "audioEncoding": "A String", "enableWordInfo": True or False, @@ -632,6 +643,17 @@

Method Details

"topic": "A String", }, "securitySettings": "A String", + "sipConfig": { + "allowVirtualAgentInteraction": True or False, + "copyInboundCallLegHeaders": [ + "A String", + ], + "createConversationOnTheFly": True or False, + "ignoreReinviteMediaDirection": True or False, + "inactiveStart": True or False, + "keepConversationRunning": True or False, + "maxAudioRecordingDuration": "A String", + }, "sttConfig": { "audioEncoding": "A String", "enableWordInfo": True or False, @@ -918,6 +940,17 @@

Method Details

"topic": "A String", }, "securitySettings": "A String", + "sipConfig": { + "allowVirtualAgentInteraction": True or False, + "copyInboundCallLegHeaders": [ + "A String", + ], + "createConversationOnTheFly": True or False, + "ignoreReinviteMediaDirection": True or False, + "inactiveStart": True or False, + "keepConversationRunning": True or False, + "maxAudioRecordingDuration": "A String", + }, "sttConfig": { "audioEncoding": "A String", "enableWordInfo": True or False, @@ -1210,6 +1243,17 @@

Method Details

"topic": "A String", }, "securitySettings": "A String", + "sipConfig": { + "allowVirtualAgentInteraction": True or False, + "copyInboundCallLegHeaders": [ + "A String", + ], + "createConversationOnTheFly": True or False, + "ignoreReinviteMediaDirection": True or False, + "inactiveStart": True or False, + "keepConversationRunning": True or False, + "maxAudioRecordingDuration": "A String", + }, "sttConfig": { "audioEncoding": "A String", "enableWordInfo": True or False, @@ -1507,6 +1551,17 @@

Method Details

"topic": "A String", }, "securitySettings": "A String", + "sipConfig": { + "allowVirtualAgentInteraction": True or False, + "copyInboundCallLegHeaders": [ + "A String", + ], + "createConversationOnTheFly": True or False, + "ignoreReinviteMediaDirection": True or False, + "inactiveStart": True or False, + "keepConversationRunning": True or False, + "maxAudioRecordingDuration": "A String", + }, "sttConfig": { "audioEncoding": "A String", "enableWordInfo": True or False, diff --git a/docs/dyn/dialogflow_v2beta1.projects.conversations.participants.html b/docs/dyn/dialogflow_v2beta1.projects.conversations.participants.html index b096bfe235..3626a28462 100644 --- a/docs/dyn/dialogflow_v2beta1.projects.conversations.participants.html +++ b/docs/dyn/dialogflow_v2beta1.projects.conversations.participants.html @@ -3232,6 +3232,9 @@

Method Details

"knowledgeAssistAnswer": { "answerRecord": "A String", "knowledgeAssistDebugInfo": { + "cesDebugInfo": { + "a_key": "", # Properties of the object. + }, "datastoreResponseReason": "A String", "ingestedContextReferenceDebugInfo": { "contextReferenceRetrieved": True or False, @@ -3263,6 +3266,11 @@

Method Details

"useTranslatedMessage": True or False, }, "queryCategorizationFailureReason": "A String", + "queryGenerationDebugInfo": { + "candidatesTokenCount": 42, + "promptTokenCount": 42, + "totalTokenCount": 42, + }, "queryGenerationFailureReason": "A String", "serviceLatency": { "internalServiceLatencies": [ @@ -4876,6 +4884,9 @@

Method Details

"knowledgeAssistAnswer": { "answerRecord": "A String", "knowledgeAssistDebugInfo": { + "cesDebugInfo": { + "a_key": "", # Properties of the object. + }, "datastoreResponseReason": "A String", "ingestedContextReferenceDebugInfo": { "contextReferenceRetrieved": True or False, @@ -4907,6 +4918,11 @@

Method Details

"useTranslatedMessage": True or False, }, "queryCategorizationFailureReason": "A String", + "queryGenerationDebugInfo": { + "candidatesTokenCount": 42, + "promptTokenCount": 42, + "totalTokenCount": 42, + }, "queryGenerationFailureReason": "A String", "serviceLatency": { "internalServiceLatencies": [ diff --git a/docs/dyn/dialogflow_v2beta1.projects.conversations.participants.suggestions.html b/docs/dyn/dialogflow_v2beta1.projects.conversations.participants.suggestions.html index c4c7cba907..119d169ba8 100644 --- a/docs/dyn/dialogflow_v2beta1.projects.conversations.participants.suggestions.html +++ b/docs/dyn/dialogflow_v2beta1.projects.conversations.participants.suggestions.html @@ -349,6 +349,9 @@

Method Details

"knowledgeAssistAnswer": { "answerRecord": "A String", "knowledgeAssistDebugInfo": { + "cesDebugInfo": { + "a_key": "", # Properties of the object. + }, "datastoreResponseReason": "A String", "ingestedContextReferenceDebugInfo": { "contextReferenceRetrieved": True or False, @@ -380,6 +383,11 @@

Method Details

"useTranslatedMessage": True or False, }, "queryCategorizationFailureReason": "A String", + "queryGenerationDebugInfo": { + "candidatesTokenCount": 42, + "promptTokenCount": 42, + "totalTokenCount": 42, + }, "queryGenerationFailureReason": "A String", "serviceLatency": { "internalServiceLatencies": [ diff --git a/docs/dyn/dialogflow_v2beta1.projects.locations.conversationProfiles.html b/docs/dyn/dialogflow_v2beta1.projects.locations.conversationProfiles.html index 9a4b9bc54e..93bb6715fd 100644 --- a/docs/dyn/dialogflow_v2beta1.projects.locations.conversationProfiles.html +++ b/docs/dyn/dialogflow_v2beta1.projects.locations.conversationProfiles.html @@ -352,6 +352,17 @@

Method Details

"topic": "A String", }, "securitySettings": "A String", + "sipConfig": { + "allowVirtualAgentInteraction": True or False, + "copyInboundCallLegHeaders": [ + "A String", + ], + "createConversationOnTheFly": True or False, + "ignoreReinviteMediaDirection": True or False, + "inactiveStart": True or False, + "keepConversationRunning": True or False, + "maxAudioRecordingDuration": "A String", + }, "sttConfig": { "audioEncoding": "A String", "enableWordInfo": True or False, @@ -589,6 +600,17 @@

Method Details

"topic": "A String", }, "securitySettings": "A String", + "sipConfig": { + "allowVirtualAgentInteraction": True or False, + "copyInboundCallLegHeaders": [ + "A String", + ], + "createConversationOnTheFly": True or False, + "ignoreReinviteMediaDirection": True or False, + "inactiveStart": True or False, + "keepConversationRunning": True or False, + "maxAudioRecordingDuration": "A String", + }, "sttConfig": { "audioEncoding": "A String", "enableWordInfo": True or False, @@ -851,6 +873,17 @@

Method Details

"topic": "A String", }, "securitySettings": "A String", + "sipConfig": { + "allowVirtualAgentInteraction": True or False, + "copyInboundCallLegHeaders": [ + "A String", + ], + "createConversationOnTheFly": True or False, + "ignoreReinviteMediaDirection": True or False, + "inactiveStart": True or False, + "keepConversationRunning": True or False, + "maxAudioRecordingDuration": "A String", + }, "sttConfig": { "audioEncoding": "A String", "enableWordInfo": True or False, @@ -1099,6 +1132,17 @@

Method Details

"topic": "A String", }, "securitySettings": "A String", + "sipConfig": { + "allowVirtualAgentInteraction": True or False, + "copyInboundCallLegHeaders": [ + "A String", + ], + "createConversationOnTheFly": True or False, + "ignoreReinviteMediaDirection": True or False, + "inactiveStart": True or False, + "keepConversationRunning": True or False, + "maxAudioRecordingDuration": "A String", + }, "sttConfig": { "audioEncoding": "A String", "enableWordInfo": True or False, @@ -1355,6 +1399,17 @@

Method Details

"topic": "A String", }, "securitySettings": "A String", + "sipConfig": { + "allowVirtualAgentInteraction": True or False, + "copyInboundCallLegHeaders": [ + "A String", + ], + "createConversationOnTheFly": True or False, + "ignoreReinviteMediaDirection": True or False, + "inactiveStart": True or False, + "keepConversationRunning": True or False, + "maxAudioRecordingDuration": "A String", + }, "sttConfig": { "audioEncoding": "A String", "enableWordInfo": True or False, @@ -1593,6 +1648,17 @@

Method Details

"topic": "A String", }, "securitySettings": "A String", + "sipConfig": { + "allowVirtualAgentInteraction": True or False, + "copyInboundCallLegHeaders": [ + "A String", + ], + "createConversationOnTheFly": True or False, + "ignoreReinviteMediaDirection": True or False, + "inactiveStart": True or False, + "keepConversationRunning": True or False, + "maxAudioRecordingDuration": "A String", + }, "sttConfig": { "audioEncoding": "A String", "enableWordInfo": True or False, diff --git a/docs/dyn/dialogflow_v2beta1.projects.locations.conversations.html b/docs/dyn/dialogflow_v2beta1.projects.locations.conversations.html index 0f1ddad56e..349b3948e3 100644 --- a/docs/dyn/dialogflow_v2beta1.projects.locations.conversations.html +++ b/docs/dyn/dialogflow_v2beta1.projects.locations.conversations.html @@ -348,6 +348,17 @@

Method Details

"topic": "A String", }, "securitySettings": "A String", + "sipConfig": { + "allowVirtualAgentInteraction": True or False, + "copyInboundCallLegHeaders": [ + "A String", + ], + "createConversationOnTheFly": True or False, + "ignoreReinviteMediaDirection": True or False, + "inactiveStart": True or False, + "keepConversationRunning": True or False, + "maxAudioRecordingDuration": "A String", + }, "sttConfig": { "audioEncoding": "A String", "enableWordInfo": True or False, @@ -635,6 +646,17 @@

Method Details

"topic": "A String", }, "securitySettings": "A String", + "sipConfig": { + "allowVirtualAgentInteraction": True or False, + "copyInboundCallLegHeaders": [ + "A String", + ], + "createConversationOnTheFly": True or False, + "ignoreReinviteMediaDirection": True or False, + "inactiveStart": True or False, + "keepConversationRunning": True or False, + "maxAudioRecordingDuration": "A String", + }, "sttConfig": { "audioEncoding": "A String", "enableWordInfo": True or False, @@ -921,6 +943,17 @@

Method Details

"topic": "A String", }, "securitySettings": "A String", + "sipConfig": { + "allowVirtualAgentInteraction": True or False, + "copyInboundCallLegHeaders": [ + "A String", + ], + "createConversationOnTheFly": True or False, + "ignoreReinviteMediaDirection": True or False, + "inactiveStart": True or False, + "keepConversationRunning": True or False, + "maxAudioRecordingDuration": "A String", + }, "sttConfig": { "audioEncoding": "A String", "enableWordInfo": True or False, @@ -1213,6 +1246,17 @@

Method Details

"topic": "A String", }, "securitySettings": "A String", + "sipConfig": { + "allowVirtualAgentInteraction": True or False, + "copyInboundCallLegHeaders": [ + "A String", + ], + "createConversationOnTheFly": True or False, + "ignoreReinviteMediaDirection": True or False, + "inactiveStart": True or False, + "keepConversationRunning": True or False, + "maxAudioRecordingDuration": "A String", + }, "sttConfig": { "audioEncoding": "A String", "enableWordInfo": True or False, @@ -1564,6 +1608,17 @@

Method Details

"topic": "A String", }, "securitySettings": "A String", + "sipConfig": { + "allowVirtualAgentInteraction": True or False, + "copyInboundCallLegHeaders": [ + "A String", + ], + "createConversationOnTheFly": True or False, + "ignoreReinviteMediaDirection": True or False, + "inactiveStart": True or False, + "keepConversationRunning": True or False, + "maxAudioRecordingDuration": "A String", + }, "sttConfig": { "audioEncoding": "A String", "enableWordInfo": True or False, diff --git a/docs/dyn/dialogflow_v2beta1.projects.locations.conversations.participants.html b/docs/dyn/dialogflow_v2beta1.projects.locations.conversations.participants.html index 3d9b0c436f..76848c7f44 100644 --- a/docs/dyn/dialogflow_v2beta1.projects.locations.conversations.participants.html +++ b/docs/dyn/dialogflow_v2beta1.projects.locations.conversations.participants.html @@ -3232,6 +3232,9 @@

Method Details

"knowledgeAssistAnswer": { "answerRecord": "A String", "knowledgeAssistDebugInfo": { + "cesDebugInfo": { + "a_key": "", # Properties of the object. + }, "datastoreResponseReason": "A String", "ingestedContextReferenceDebugInfo": { "contextReferenceRetrieved": True or False, @@ -3263,6 +3266,11 @@

Method Details

"useTranslatedMessage": True or False, }, "queryCategorizationFailureReason": "A String", + "queryGenerationDebugInfo": { + "candidatesTokenCount": 42, + "promptTokenCount": 42, + "totalTokenCount": 42, + }, "queryGenerationFailureReason": "A String", "serviceLatency": { "internalServiceLatencies": [ @@ -4876,6 +4884,9 @@

Method Details

"knowledgeAssistAnswer": { "answerRecord": "A String", "knowledgeAssistDebugInfo": { + "cesDebugInfo": { + "a_key": "", # Properties of the object. + }, "datastoreResponseReason": "A String", "ingestedContextReferenceDebugInfo": { "contextReferenceRetrieved": True or False, @@ -4907,6 +4918,11 @@

Method Details

"useTranslatedMessage": True or False, }, "queryCategorizationFailureReason": "A String", + "queryGenerationDebugInfo": { + "candidatesTokenCount": 42, + "promptTokenCount": 42, + "totalTokenCount": 42, + }, "queryGenerationFailureReason": "A String", "serviceLatency": { "internalServiceLatencies": [ diff --git a/docs/dyn/dialogflow_v2beta1.projects.locations.conversations.participants.suggestions.html b/docs/dyn/dialogflow_v2beta1.projects.locations.conversations.participants.suggestions.html index 803f272794..efe01107cf 100644 --- a/docs/dyn/dialogflow_v2beta1.projects.locations.conversations.participants.suggestions.html +++ b/docs/dyn/dialogflow_v2beta1.projects.locations.conversations.participants.suggestions.html @@ -214,6 +214,9 @@

Method Details

"knowledgeAssistAnswer": { "answerRecord": "A String", "knowledgeAssistDebugInfo": { + "cesDebugInfo": { + "a_key": "", # Properties of the object. + }, "datastoreResponseReason": "A String", "ingestedContextReferenceDebugInfo": { "contextReferenceRetrieved": True or False, @@ -245,6 +248,11 @@

Method Details

"useTranslatedMessage": True or False, }, "queryCategorizationFailureReason": "A String", + "queryGenerationDebugInfo": { + "candidatesTokenCount": 42, + "promptTokenCount": 42, + "totalTokenCount": 42, + }, "queryGenerationFailureReason": "A String", "serviceLatency": { "internalServiceLatencies": [ diff --git a/docs/dyn/dialogflow_v2beta1.projects.locations.suggestions.html b/docs/dyn/dialogflow_v2beta1.projects.locations.suggestions.html index bed1d493e2..d1a52ea531 100644 --- a/docs/dyn/dialogflow_v2beta1.projects.locations.suggestions.html +++ b/docs/dyn/dialogflow_v2beta1.projects.locations.suggestions.html @@ -292,6 +292,17 @@

Method Details

"topic": "A String", }, "securitySettings": "A String", + "sipConfig": { + "allowVirtualAgentInteraction": True or False, + "copyInboundCallLegHeaders": [ + "A String", + ], + "createConversationOnTheFly": True or False, + "ignoreReinviteMediaDirection": True or False, + "inactiveStart": True or False, + "keepConversationRunning": True or False, + "maxAudioRecordingDuration": "A String", + }, "sttConfig": { "audioEncoding": "A String", "enableWordInfo": True or False, diff --git a/docs/dyn/dialogflow_v2beta1.projects.suggestions.html b/docs/dyn/dialogflow_v2beta1.projects.suggestions.html index dd709997a9..dc035083b4 100644 --- a/docs/dyn/dialogflow_v2beta1.projects.suggestions.html +++ b/docs/dyn/dialogflow_v2beta1.projects.suggestions.html @@ -292,6 +292,17 @@

Method Details

"topic": "A String", }, "securitySettings": "A String", + "sipConfig": { + "allowVirtualAgentInteraction": True or False, + "copyInboundCallLegHeaders": [ + "A String", + ], + "createConversationOnTheFly": True or False, + "ignoreReinviteMediaDirection": True or False, + "inactiveStart": True or False, + "keepConversationRunning": True or False, + "maxAudioRecordingDuration": "A String", + }, "sttConfig": { "audioEncoding": "A String", "enableWordInfo": True or False, diff --git a/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.html b/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.html index 7cef2261ed..d658a83ae4 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.html @@ -380,7 +380,7 @@

Method Details

}, }, "workspaceConfig": { # Config to store data store type configuration for workspace data # Config to store data store type configuration for workspace data. This must be set when DataStore.content_config is set as DataStore.ContentConfig.GOOGLE_WORKSPACE. - "dasherCustomerId": "A String", # Obfuscated Dasher customer ID. + "dasherCustomerId": "A String", # Output only. Obfuscated Dasher customer ID. Derived by the server from the project's GCP organization at data store creation time; any value supplied in the request payload is ignored. "superAdminEmailAddress": "A String", # Optional. The super admin email address for the workspace that will be used for access token generation. For now we only use it for Native Google Drive connector data ingestion. "superAdminServiceAccount": "A String", # Optional. The super admin service account for the workspace that will be used for access token generation. For now we only use it for Native Google Drive connector data ingestion. "type": "A String", # The Google Workspace data source. @@ -625,7 +625,7 @@

Method Details

}, }, "workspaceConfig": { # Config to store data store type configuration for workspace data # Config to store data store type configuration for workspace data. This must be set when DataStore.content_config is set as DataStore.ContentConfig.GOOGLE_WORKSPACE. - "dasherCustomerId": "A String", # Obfuscated Dasher customer ID. + "dasherCustomerId": "A String", # Output only. Obfuscated Dasher customer ID. Derived by the server from the project's GCP organization at data store creation time; any value supplied in the request payload is ignored. "superAdminEmailAddress": "A String", # Optional. The super admin email address for the workspace that will be used for access token generation. For now we only use it for Native Google Drive connector data ingestion. "superAdminServiceAccount": "A String", # Optional. The super admin service account for the workspace that will be used for access token generation. For now we only use it for Native Google Drive connector data ingestion. "type": "A String", # The Google Workspace data source. @@ -826,7 +826,7 @@

Method Details

}, }, "workspaceConfig": { # Config to store data store type configuration for workspace data # Config to store data store type configuration for workspace data. This must be set when DataStore.content_config is set as DataStore.ContentConfig.GOOGLE_WORKSPACE. - "dasherCustomerId": "A String", # Obfuscated Dasher customer ID. + "dasherCustomerId": "A String", # Output only. Obfuscated Dasher customer ID. Derived by the server from the project's GCP organization at data store creation time; any value supplied in the request payload is ignored. "superAdminEmailAddress": "A String", # Optional. The super admin email address for the workspace that will be used for access token generation. For now we only use it for Native Google Drive connector data ingestion. "superAdminServiceAccount": "A String", # Optional. The super admin service account for the workspace that will be used for access token generation. For now we only use it for Native Google Drive connector data ingestion. "type": "A String", # The Google Workspace data source. @@ -1015,7 +1015,7 @@

Method Details

}, }, "workspaceConfig": { # Config to store data store type configuration for workspace data # Config to store data store type configuration for workspace data. This must be set when DataStore.content_config is set as DataStore.ContentConfig.GOOGLE_WORKSPACE. - "dasherCustomerId": "A String", # Obfuscated Dasher customer ID. + "dasherCustomerId": "A String", # Output only. Obfuscated Dasher customer ID. Derived by the server from the project's GCP organization at data store creation time; any value supplied in the request payload is ignored. "superAdminEmailAddress": "A String", # Optional. The super admin email address for the workspace that will be used for access token generation. For now we only use it for Native Google Drive connector data ingestion. "superAdminServiceAccount": "A String", # Optional. The super admin service account for the workspace that will be used for access token generation. For now we only use it for Native Google Drive connector data ingestion. "type": "A String", # The Google Workspace data source. @@ -1186,7 +1186,7 @@

Method Details

}, }, "workspaceConfig": { # Config to store data store type configuration for workspace data # Config to store data store type configuration for workspace data. This must be set when DataStore.content_config is set as DataStore.ContentConfig.GOOGLE_WORKSPACE. - "dasherCustomerId": "A String", # Obfuscated Dasher customer ID. + "dasherCustomerId": "A String", # Output only. Obfuscated Dasher customer ID. Derived by the server from the project's GCP organization at data store creation time; any value supplied in the request payload is ignored. "superAdminEmailAddress": "A String", # Optional. The super admin email address for the workspace that will be used for access token generation. For now we only use it for Native Google Drive connector data ingestion. "superAdminServiceAccount": "A String", # Optional. The super admin service account for the workspace that will be used for access token generation. For now we only use it for Native Google Drive connector data ingestion. "type": "A String", # The Google Workspace data source. diff --git a/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.servingConfigs.html b/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.servingConfigs.html index 2a65c7a645..cd96c68ab0 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.servingConfigs.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.servingConfigs.html @@ -1771,7 +1771,7 @@

Method Details

"condition": "A String", # The condition under which query expansion should occur. Default to Condition.DISABLED. "pinUnexpandedResults": True or False, # Whether to pin unexpanded results. If this field is set to true, unexpanded products are always at the top of the search results, followed by the expanded results. }, - "rankingExpression": "A String", # Optional. The ranking expression controls the customized ranking on retrieval documents. This overrides ServingConfig.ranking_expression. The syntax and supported features depend on the `ranking_expression_backend` value. If `ranking_expression_backend` is not provided, it defaults to `RANK_BY_EMBEDDING`. If ranking_expression_backend is not provided or set to `RANK_BY_EMBEDDING`, it should be a single function or multiple functions that are joined by "+". * ranking_expression = function, { " + ", function }; Supported functions: * double * relevance_score * double * dotProduct(embedding_field_path) Function variables: * `relevance_score`: pre-defined keywords, used for measure relevance between query and document. * `embedding_field_path`: the document embedding field used with query embedding vector. * `dotProduct`: embedding function between `embedding_field_path` and query embedding vector. Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`. If ranking_expression_backend is set to `RANK_BY_FORMULA`, the following expression types (and combinations of those chained using + or * operators) are supported: * `double` * `signal` * `log(signal)` * `exp(signal)` * `rr(signal, double > 0)` -- reciprocal rank transformation with second argument being a denominator constant. * `is_nan(signal)` -- returns 0 if signal is NaN, 1 otherwise. * `fill_nan(signal1, signal2 | double)` -- if signal1 is NaN, returns signal2 | double, else returns signal1. Here are a few examples of ranking formulas that use the supported ranking expression types: - `0.2 * semantic_similarity_score + 0.8 * log(keyword_similarity_score)` -- mostly rank by the logarithm of `keyword_similarity_score` with slight `semantic_smilarity_score` adjustment. - `0.2 * exp(fill_nan(semantic_similarity_score, 0)) + 0.3 * is_nan(keyword_similarity_score)` -- rank by the exponent of `semantic_similarity_score` filling the value with 0 if it's NaN, also add constant 0.3 adjustment to the final score if `semantic_similarity_score` is NaN. - `0.2 * rr(semantic_similarity_score, 16) + 0.8 * rr(keyword_similarity_score, 16)` -- mostly rank by the reciprocal rank of `keyword_similarity_score` with slight adjustment of reciprocal rank of `semantic_smilarity_score`. The following signals are supported: * `semantic_similarity_score`: semantic similarity adjustment that is calculated using the embeddings generated by a proprietary Google model. This score determines how semantically similar a search query is to a document. * `keyword_similarity_score`: keyword match adjustment uses the Best Match 25 (BM25) ranking function. This score is calculated using a probabilistic model to estimate the probability that a document is relevant to a given query. * `relevance_score`: semantic relevance adjustment that uses a proprietary Google model to determine the meaning and intent behind a user's query in context with the content in the documents. * `pctr_rank`: predicted conversion rate adjustment as a rank use predicted Click-through rate (pCTR) to gauge the relevance and attractiveness of a search result from a user's perspective. A higher pCTR suggests that the result is more likely to satisfy the user's query and intent, making it a valuable signal for ranking. * `freshness_rank`: freshness adjustment as a rank * `document_age`: The time in hours elapsed since the document was last updated, a floating-point number (e.g., 0.25 means 15 minutes). * `topicality_rank`: topicality adjustment as a rank. Uses proprietary Google model to determine the keyword-based overlap between the query and the document. * `base_rank`: the default rank of the result + "rankingExpression": "A String", # Optional. The ranking expression controls the customized ranking on retrieval documents. This overrides ServingConfig.ranking_expression. The syntax and supported features depend on the `ranking_expression_backend` value. If `ranking_expression_backend` is not provided, it defaults to `RANK_BY_EMBEDDING`. If ranking_expression_backend is not provided or set to `RANK_BY_EMBEDDING`, it should be a single function or multiple functions that are joined by "+". * ranking_expression = function, { " + ", function }; Supported functions: * double * relevance_score * double * dotProduct(embedding_field_path) Function variables: * `relevance_score`: pre-defined keywords, used for measure relevance between query and document. * `embedding_field_path`: the document embedding field used with query embedding vector. * `dotProduct`: embedding function between `embedding_field_path` and query embedding vector. Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`. If ranking_expression_backend is set to `RANK_BY_FORMULA`, the following expression types (and combinations of those chained using + or * operators) are supported: * `double` * `signal` * `log(signal)` * `exp(signal)` * `rr(signal, double > 0)` -- reciprocal rank transformation with second argument being a denominator constant. * `is_nan(signal)` -- returns 0 if signal is NaN, 1 otherwise. * `fill_nan(signal1, signal2 | double)` -- if signal1 is NaN, returns signal2 | double, else returns signal1. Here are a few examples of ranking formulas that use the supported ranking expression types: - `0.2 * semantic_similarity_score + 0.8 * log(keyword_similarity_score)` -- mostly rank by the logarithm of `keyword_similarity_score` with slight `semantic_smilarity_score` adjustment. - `0.2 * exp(fill_nan(semantic_similarity_score, 0)) + 0.3 * is_nan(keyword_similarity_score)` -- rank by the exponent of `semantic_similarity_score` filling the value with 0 if it's NaN, also add constant 0.3 adjustment to the final score if `semantic_similarity_score` is NaN. - `0.2 * rr(semantic_similarity_score, 16) + 0.8 * rr(keyword_similarity_score, 16)` -- mostly rank by the reciprocal rank of `keyword_similarity_score` with slight adjustment of reciprocal rank of `semantic_smilarity_score`. The following signals are supported: * `semantic_similarity_score`: semantic similarity adjustment that is calculated using the embeddings generated by a proprietary Google model. This score determines how semantically similar a search query is to a document. * `keyword_similarity_score`: keyword match adjustment uses the Best Match 25 (BM25) ranking function. This score is calculated using a probabilistic model to estimate the probability that a document is relevant to a given query. * `relevance_score`: semantic relevance adjustment that uses a proprietary Google model to determine the meaning and intent behind a user's query in context with the content in the documents. * `pctr_rank`: predicted conversion rate adjustment as a rank use predicted Click-through rate (pCTR) to gauge the relevance and attractiveness of a search result from a user's perspective. A higher pCTR suggests that the result is more likely to satisfy the user's query and intent, making it a valuable signal for ranking. * `freshness_rank`: freshness adjustment as a rank * `document_age`: The time in hours elapsed since the document was last updated, a floating-point number (e.g., 0.25 means 15 minutes). * `topicality_rank`: topicality adjustment as a rank. Uses proprietary Google model to determine the keyword-based overlap between the query and the document. * `base_rank`: the default rank of the result * `media_actor_match`: whether the media actor matches the query * `media_director_match`: whether the media director matches the query * `media_genre_match`: whether the media genre matches the query * `media_language_match`: whether the media language matches the query * `media_title_match`: whether the media title matches the query * `media_prefix_similarity_rank`: prefix similarity rank for media results * `media_semantic_similarity_rank`: semantic similarity rank for media results "rankingExpressionBackend": "A String", # Optional. The backend to use for the ranking expression evaluation. "relevanceScoreSpec": { # The specification for returning the document relevance score. # Optional. The specification for returning the relevance score. "returnRelevanceScore": True or False, # Optional. Whether to return the relevance score for search results. The higher the score, the more relevant the document is to the query. @@ -2240,7 +2240,7 @@

Method Details

"condition": "A String", # The condition under which query expansion should occur. Default to Condition.DISABLED. "pinUnexpandedResults": True or False, # Whether to pin unexpanded results. If this field is set to true, unexpanded products are always at the top of the search results, followed by the expanded results. }, - "rankingExpression": "A String", # Optional. The ranking expression controls the customized ranking on retrieval documents. This overrides ServingConfig.ranking_expression. The syntax and supported features depend on the `ranking_expression_backend` value. If `ranking_expression_backend` is not provided, it defaults to `RANK_BY_EMBEDDING`. If ranking_expression_backend is not provided or set to `RANK_BY_EMBEDDING`, it should be a single function or multiple functions that are joined by "+". * ranking_expression = function, { " + ", function }; Supported functions: * double * relevance_score * double * dotProduct(embedding_field_path) Function variables: * `relevance_score`: pre-defined keywords, used for measure relevance between query and document. * `embedding_field_path`: the document embedding field used with query embedding vector. * `dotProduct`: embedding function between `embedding_field_path` and query embedding vector. Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`. If ranking_expression_backend is set to `RANK_BY_FORMULA`, the following expression types (and combinations of those chained using + or * operators) are supported: * `double` * `signal` * `log(signal)` * `exp(signal)` * `rr(signal, double > 0)` -- reciprocal rank transformation with second argument being a denominator constant. * `is_nan(signal)` -- returns 0 if signal is NaN, 1 otherwise. * `fill_nan(signal1, signal2 | double)` -- if signal1 is NaN, returns signal2 | double, else returns signal1. Here are a few examples of ranking formulas that use the supported ranking expression types: - `0.2 * semantic_similarity_score + 0.8 * log(keyword_similarity_score)` -- mostly rank by the logarithm of `keyword_similarity_score` with slight `semantic_smilarity_score` adjustment. - `0.2 * exp(fill_nan(semantic_similarity_score, 0)) + 0.3 * is_nan(keyword_similarity_score)` -- rank by the exponent of `semantic_similarity_score` filling the value with 0 if it's NaN, also add constant 0.3 adjustment to the final score if `semantic_similarity_score` is NaN. - `0.2 * rr(semantic_similarity_score, 16) + 0.8 * rr(keyword_similarity_score, 16)` -- mostly rank by the reciprocal rank of `keyword_similarity_score` with slight adjustment of reciprocal rank of `semantic_smilarity_score`. The following signals are supported: * `semantic_similarity_score`: semantic similarity adjustment that is calculated using the embeddings generated by a proprietary Google model. This score determines how semantically similar a search query is to a document. * `keyword_similarity_score`: keyword match adjustment uses the Best Match 25 (BM25) ranking function. This score is calculated using a probabilistic model to estimate the probability that a document is relevant to a given query. * `relevance_score`: semantic relevance adjustment that uses a proprietary Google model to determine the meaning and intent behind a user's query in context with the content in the documents. * `pctr_rank`: predicted conversion rate adjustment as a rank use predicted Click-through rate (pCTR) to gauge the relevance and attractiveness of a search result from a user's perspective. A higher pCTR suggests that the result is more likely to satisfy the user's query and intent, making it a valuable signal for ranking. * `freshness_rank`: freshness adjustment as a rank * `document_age`: The time in hours elapsed since the document was last updated, a floating-point number (e.g., 0.25 means 15 minutes). * `topicality_rank`: topicality adjustment as a rank. Uses proprietary Google model to determine the keyword-based overlap between the query and the document. * `base_rank`: the default rank of the result + "rankingExpression": "A String", # Optional. The ranking expression controls the customized ranking on retrieval documents. This overrides ServingConfig.ranking_expression. The syntax and supported features depend on the `ranking_expression_backend` value. If `ranking_expression_backend` is not provided, it defaults to `RANK_BY_EMBEDDING`. If ranking_expression_backend is not provided or set to `RANK_BY_EMBEDDING`, it should be a single function or multiple functions that are joined by "+". * ranking_expression = function, { " + ", function }; Supported functions: * double * relevance_score * double * dotProduct(embedding_field_path) Function variables: * `relevance_score`: pre-defined keywords, used for measure relevance between query and document. * `embedding_field_path`: the document embedding field used with query embedding vector. * `dotProduct`: embedding function between `embedding_field_path` and query embedding vector. Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`. If ranking_expression_backend is set to `RANK_BY_FORMULA`, the following expression types (and combinations of those chained using + or * operators) are supported: * `double` * `signal` * `log(signal)` * `exp(signal)` * `rr(signal, double > 0)` -- reciprocal rank transformation with second argument being a denominator constant. * `is_nan(signal)` -- returns 0 if signal is NaN, 1 otherwise. * `fill_nan(signal1, signal2 | double)` -- if signal1 is NaN, returns signal2 | double, else returns signal1. Here are a few examples of ranking formulas that use the supported ranking expression types: - `0.2 * semantic_similarity_score + 0.8 * log(keyword_similarity_score)` -- mostly rank by the logarithm of `keyword_similarity_score` with slight `semantic_smilarity_score` adjustment. - `0.2 * exp(fill_nan(semantic_similarity_score, 0)) + 0.3 * is_nan(keyword_similarity_score)` -- rank by the exponent of `semantic_similarity_score` filling the value with 0 if it's NaN, also add constant 0.3 adjustment to the final score if `semantic_similarity_score` is NaN. - `0.2 * rr(semantic_similarity_score, 16) + 0.8 * rr(keyword_similarity_score, 16)` -- mostly rank by the reciprocal rank of `keyword_similarity_score` with slight adjustment of reciprocal rank of `semantic_smilarity_score`. The following signals are supported: * `semantic_similarity_score`: semantic similarity adjustment that is calculated using the embeddings generated by a proprietary Google model. This score determines how semantically similar a search query is to a document. * `keyword_similarity_score`: keyword match adjustment uses the Best Match 25 (BM25) ranking function. This score is calculated using a probabilistic model to estimate the probability that a document is relevant to a given query. * `relevance_score`: semantic relevance adjustment that uses a proprietary Google model to determine the meaning and intent behind a user's query in context with the content in the documents. * `pctr_rank`: predicted conversion rate adjustment as a rank use predicted Click-through rate (pCTR) to gauge the relevance and attractiveness of a search result from a user's perspective. A higher pCTR suggests that the result is more likely to satisfy the user's query and intent, making it a valuable signal for ranking. * `freshness_rank`: freshness adjustment as a rank * `document_age`: The time in hours elapsed since the document was last updated, a floating-point number (e.g., 0.25 means 15 minutes). * `topicality_rank`: topicality adjustment as a rank. Uses proprietary Google model to determine the keyword-based overlap between the query and the document. * `base_rank`: the default rank of the result * `media_actor_match`: whether the media actor matches the query * `media_director_match`: whether the media director matches the query * `media_genre_match`: whether the media genre matches the query * `media_language_match`: whether the media language matches the query * `media_title_match`: whether the media title matches the query * `media_prefix_similarity_rank`: prefix similarity rank for media results * `media_semantic_similarity_rank`: semantic similarity rank for media results "rankingExpressionBackend": "A String", # Optional. The backend to use for the ranking expression evaluation. "relevanceScoreSpec": { # The specification for returning the document relevance score. # Optional. The specification for returning the relevance score. "returnRelevanceScore": True or False, # Optional. Whether to return the relevance score for search results. The higher the score, the more relevant the document is to the query. diff --git a/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.sessions.html b/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.sessions.html index 0970358275..c2ae7d8760 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.sessions.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.sessions.html @@ -985,7 +985,7 @@

Method Details

Args: parent: string, Required. The data store resource name. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}` (required) filter: string, A comma-separated list of fields to filter by, in EBNF grammar. The supported fields are: * `user_pseudo_id` * `state` * `display_name` * `starred` * `is_pinned` * `labels` * `create_time` * `update_time` * `collaborative_project` Examples: * `user_pseudo_id = some_id` * `display_name = "some_name"` * `starred = true` * `is_pinned=true AND (NOT labels:hidden)` * `create_time > "1970-01-01T12:00:00Z"` * `collaborative_project = "projects/123/locations/global/collections/default_collection/engines/" "default_engine/collaborative_projects/cp1"` - orderBy: string, A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `update_time` * `create_time` * `session_name` * `is_pinned` Example: * `update_time desc` * `create_time` * `is_pinned desc,update_time desc`: list sessions by is_pinned first, then by update_time. + orderBy: string, A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `update_time` * `create_time` * `session_name` * `is_pinned` * `display_name` Example: * `update_time desc` * `create_time` * `is_pinned desc,update_time desc`: list sessions by is_pinned first, then by update_time. pageSize: integer, Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000. pageToken: string, A page token, received from a previous `ListSessions` call. Provide this to retrieve the subsequent page. x__xgafv: string, V1 error format. diff --git a/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.assistants.html b/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.assistants.html index 6a386658b2..cf49e94d54 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.assistants.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.assistants.html @@ -665,6 +665,12 @@

Method Details

"invocationTools": [ # The tool names of the tools that were invoked. "A String", ], + "invokedSkills": [ # The skills executed during the turn. + { # Represents a skill used during the assist call. + "displayName": "A String", # The display name of the skill. + "name": "A String", # The resource name of the skill. + }, + ], "sessionInfo": { # Information about the session. # Session information. Only included in the final StreamAssistResponse of the response stream. "session": "A String", # Name of the newly generated or continued session. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}`. }, diff --git a/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.servingConfigs.html b/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.servingConfigs.html index 98883fce20..8ffaecf2f7 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.servingConfigs.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.servingConfigs.html @@ -1771,7 +1771,7 @@

Method Details

"condition": "A String", # The condition under which query expansion should occur. Default to Condition.DISABLED. "pinUnexpandedResults": True or False, # Whether to pin unexpanded results. If this field is set to true, unexpanded products are always at the top of the search results, followed by the expanded results. }, - "rankingExpression": "A String", # Optional. The ranking expression controls the customized ranking on retrieval documents. This overrides ServingConfig.ranking_expression. The syntax and supported features depend on the `ranking_expression_backend` value. If `ranking_expression_backend` is not provided, it defaults to `RANK_BY_EMBEDDING`. If ranking_expression_backend is not provided or set to `RANK_BY_EMBEDDING`, it should be a single function or multiple functions that are joined by "+". * ranking_expression = function, { " + ", function }; Supported functions: * double * relevance_score * double * dotProduct(embedding_field_path) Function variables: * `relevance_score`: pre-defined keywords, used for measure relevance between query and document. * `embedding_field_path`: the document embedding field used with query embedding vector. * `dotProduct`: embedding function between `embedding_field_path` and query embedding vector. Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`. If ranking_expression_backend is set to `RANK_BY_FORMULA`, the following expression types (and combinations of those chained using + or * operators) are supported: * `double` * `signal` * `log(signal)` * `exp(signal)` * `rr(signal, double > 0)` -- reciprocal rank transformation with second argument being a denominator constant. * `is_nan(signal)` -- returns 0 if signal is NaN, 1 otherwise. * `fill_nan(signal1, signal2 | double)` -- if signal1 is NaN, returns signal2 | double, else returns signal1. Here are a few examples of ranking formulas that use the supported ranking expression types: - `0.2 * semantic_similarity_score + 0.8 * log(keyword_similarity_score)` -- mostly rank by the logarithm of `keyword_similarity_score` with slight `semantic_smilarity_score` adjustment. - `0.2 * exp(fill_nan(semantic_similarity_score, 0)) + 0.3 * is_nan(keyword_similarity_score)` -- rank by the exponent of `semantic_similarity_score` filling the value with 0 if it's NaN, also add constant 0.3 adjustment to the final score if `semantic_similarity_score` is NaN. - `0.2 * rr(semantic_similarity_score, 16) + 0.8 * rr(keyword_similarity_score, 16)` -- mostly rank by the reciprocal rank of `keyword_similarity_score` with slight adjustment of reciprocal rank of `semantic_smilarity_score`. The following signals are supported: * `semantic_similarity_score`: semantic similarity adjustment that is calculated using the embeddings generated by a proprietary Google model. This score determines how semantically similar a search query is to a document. * `keyword_similarity_score`: keyword match adjustment uses the Best Match 25 (BM25) ranking function. This score is calculated using a probabilistic model to estimate the probability that a document is relevant to a given query. * `relevance_score`: semantic relevance adjustment that uses a proprietary Google model to determine the meaning and intent behind a user's query in context with the content in the documents. * `pctr_rank`: predicted conversion rate adjustment as a rank use predicted Click-through rate (pCTR) to gauge the relevance and attractiveness of a search result from a user's perspective. A higher pCTR suggests that the result is more likely to satisfy the user's query and intent, making it a valuable signal for ranking. * `freshness_rank`: freshness adjustment as a rank * `document_age`: The time in hours elapsed since the document was last updated, a floating-point number (e.g., 0.25 means 15 minutes). * `topicality_rank`: topicality adjustment as a rank. Uses proprietary Google model to determine the keyword-based overlap between the query and the document. * `base_rank`: the default rank of the result + "rankingExpression": "A String", # Optional. The ranking expression controls the customized ranking on retrieval documents. This overrides ServingConfig.ranking_expression. The syntax and supported features depend on the `ranking_expression_backend` value. If `ranking_expression_backend` is not provided, it defaults to `RANK_BY_EMBEDDING`. If ranking_expression_backend is not provided or set to `RANK_BY_EMBEDDING`, it should be a single function or multiple functions that are joined by "+". * ranking_expression = function, { " + ", function }; Supported functions: * double * relevance_score * double * dotProduct(embedding_field_path) Function variables: * `relevance_score`: pre-defined keywords, used for measure relevance between query and document. * `embedding_field_path`: the document embedding field used with query embedding vector. * `dotProduct`: embedding function between `embedding_field_path` and query embedding vector. Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`. If ranking_expression_backend is set to `RANK_BY_FORMULA`, the following expression types (and combinations of those chained using + or * operators) are supported: * `double` * `signal` * `log(signal)` * `exp(signal)` * `rr(signal, double > 0)` -- reciprocal rank transformation with second argument being a denominator constant. * `is_nan(signal)` -- returns 0 if signal is NaN, 1 otherwise. * `fill_nan(signal1, signal2 | double)` -- if signal1 is NaN, returns signal2 | double, else returns signal1. Here are a few examples of ranking formulas that use the supported ranking expression types: - `0.2 * semantic_similarity_score + 0.8 * log(keyword_similarity_score)` -- mostly rank by the logarithm of `keyword_similarity_score` with slight `semantic_smilarity_score` adjustment. - `0.2 * exp(fill_nan(semantic_similarity_score, 0)) + 0.3 * is_nan(keyword_similarity_score)` -- rank by the exponent of `semantic_similarity_score` filling the value with 0 if it's NaN, also add constant 0.3 adjustment to the final score if `semantic_similarity_score` is NaN. - `0.2 * rr(semantic_similarity_score, 16) + 0.8 * rr(keyword_similarity_score, 16)` -- mostly rank by the reciprocal rank of `keyword_similarity_score` with slight adjustment of reciprocal rank of `semantic_smilarity_score`. The following signals are supported: * `semantic_similarity_score`: semantic similarity adjustment that is calculated using the embeddings generated by a proprietary Google model. This score determines how semantically similar a search query is to a document. * `keyword_similarity_score`: keyword match adjustment uses the Best Match 25 (BM25) ranking function. This score is calculated using a probabilistic model to estimate the probability that a document is relevant to a given query. * `relevance_score`: semantic relevance adjustment that uses a proprietary Google model to determine the meaning and intent behind a user's query in context with the content in the documents. * `pctr_rank`: predicted conversion rate adjustment as a rank use predicted Click-through rate (pCTR) to gauge the relevance and attractiveness of a search result from a user's perspective. A higher pCTR suggests that the result is more likely to satisfy the user's query and intent, making it a valuable signal for ranking. * `freshness_rank`: freshness adjustment as a rank * `document_age`: The time in hours elapsed since the document was last updated, a floating-point number (e.g., 0.25 means 15 minutes). * `topicality_rank`: topicality adjustment as a rank. Uses proprietary Google model to determine the keyword-based overlap between the query and the document. * `base_rank`: the default rank of the result * `media_actor_match`: whether the media actor matches the query * `media_director_match`: whether the media director matches the query * `media_genre_match`: whether the media genre matches the query * `media_language_match`: whether the media language matches the query * `media_title_match`: whether the media title matches the query * `media_prefix_similarity_rank`: prefix similarity rank for media results * `media_semantic_similarity_rank`: semantic similarity rank for media results "rankingExpressionBackend": "A String", # Optional. The backend to use for the ranking expression evaluation. "relevanceScoreSpec": { # The specification for returning the document relevance score. # Optional. The specification for returning the relevance score. "returnRelevanceScore": True or False, # Optional. Whether to return the relevance score for search results. The higher the score, the more relevant the document is to the query. @@ -2240,7 +2240,7 @@

Method Details

"condition": "A String", # The condition under which query expansion should occur. Default to Condition.DISABLED. "pinUnexpandedResults": True or False, # Whether to pin unexpanded results. If this field is set to true, unexpanded products are always at the top of the search results, followed by the expanded results. }, - "rankingExpression": "A String", # Optional. The ranking expression controls the customized ranking on retrieval documents. This overrides ServingConfig.ranking_expression. The syntax and supported features depend on the `ranking_expression_backend` value. If `ranking_expression_backend` is not provided, it defaults to `RANK_BY_EMBEDDING`. If ranking_expression_backend is not provided or set to `RANK_BY_EMBEDDING`, it should be a single function or multiple functions that are joined by "+". * ranking_expression = function, { " + ", function }; Supported functions: * double * relevance_score * double * dotProduct(embedding_field_path) Function variables: * `relevance_score`: pre-defined keywords, used for measure relevance between query and document. * `embedding_field_path`: the document embedding field used with query embedding vector. * `dotProduct`: embedding function between `embedding_field_path` and query embedding vector. Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`. If ranking_expression_backend is set to `RANK_BY_FORMULA`, the following expression types (and combinations of those chained using + or * operators) are supported: * `double` * `signal` * `log(signal)` * `exp(signal)` * `rr(signal, double > 0)` -- reciprocal rank transformation with second argument being a denominator constant. * `is_nan(signal)` -- returns 0 if signal is NaN, 1 otherwise. * `fill_nan(signal1, signal2 | double)` -- if signal1 is NaN, returns signal2 | double, else returns signal1. Here are a few examples of ranking formulas that use the supported ranking expression types: - `0.2 * semantic_similarity_score + 0.8 * log(keyword_similarity_score)` -- mostly rank by the logarithm of `keyword_similarity_score` with slight `semantic_smilarity_score` adjustment. - `0.2 * exp(fill_nan(semantic_similarity_score, 0)) + 0.3 * is_nan(keyword_similarity_score)` -- rank by the exponent of `semantic_similarity_score` filling the value with 0 if it's NaN, also add constant 0.3 adjustment to the final score if `semantic_similarity_score` is NaN. - `0.2 * rr(semantic_similarity_score, 16) + 0.8 * rr(keyword_similarity_score, 16)` -- mostly rank by the reciprocal rank of `keyword_similarity_score` with slight adjustment of reciprocal rank of `semantic_smilarity_score`. The following signals are supported: * `semantic_similarity_score`: semantic similarity adjustment that is calculated using the embeddings generated by a proprietary Google model. This score determines how semantically similar a search query is to a document. * `keyword_similarity_score`: keyword match adjustment uses the Best Match 25 (BM25) ranking function. This score is calculated using a probabilistic model to estimate the probability that a document is relevant to a given query. * `relevance_score`: semantic relevance adjustment that uses a proprietary Google model to determine the meaning and intent behind a user's query in context with the content in the documents. * `pctr_rank`: predicted conversion rate adjustment as a rank use predicted Click-through rate (pCTR) to gauge the relevance and attractiveness of a search result from a user's perspective. A higher pCTR suggests that the result is more likely to satisfy the user's query and intent, making it a valuable signal for ranking. * `freshness_rank`: freshness adjustment as a rank * `document_age`: The time in hours elapsed since the document was last updated, a floating-point number (e.g., 0.25 means 15 minutes). * `topicality_rank`: topicality adjustment as a rank. Uses proprietary Google model to determine the keyword-based overlap between the query and the document. * `base_rank`: the default rank of the result + "rankingExpression": "A String", # Optional. The ranking expression controls the customized ranking on retrieval documents. This overrides ServingConfig.ranking_expression. The syntax and supported features depend on the `ranking_expression_backend` value. If `ranking_expression_backend` is not provided, it defaults to `RANK_BY_EMBEDDING`. If ranking_expression_backend is not provided or set to `RANK_BY_EMBEDDING`, it should be a single function or multiple functions that are joined by "+". * ranking_expression = function, { " + ", function }; Supported functions: * double * relevance_score * double * dotProduct(embedding_field_path) Function variables: * `relevance_score`: pre-defined keywords, used for measure relevance between query and document. * `embedding_field_path`: the document embedding field used with query embedding vector. * `dotProduct`: embedding function between `embedding_field_path` and query embedding vector. Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`. If ranking_expression_backend is set to `RANK_BY_FORMULA`, the following expression types (and combinations of those chained using + or * operators) are supported: * `double` * `signal` * `log(signal)` * `exp(signal)` * `rr(signal, double > 0)` -- reciprocal rank transformation with second argument being a denominator constant. * `is_nan(signal)` -- returns 0 if signal is NaN, 1 otherwise. * `fill_nan(signal1, signal2 | double)` -- if signal1 is NaN, returns signal2 | double, else returns signal1. Here are a few examples of ranking formulas that use the supported ranking expression types: - `0.2 * semantic_similarity_score + 0.8 * log(keyword_similarity_score)` -- mostly rank by the logarithm of `keyword_similarity_score` with slight `semantic_smilarity_score` adjustment. - `0.2 * exp(fill_nan(semantic_similarity_score, 0)) + 0.3 * is_nan(keyword_similarity_score)` -- rank by the exponent of `semantic_similarity_score` filling the value with 0 if it's NaN, also add constant 0.3 adjustment to the final score if `semantic_similarity_score` is NaN. - `0.2 * rr(semantic_similarity_score, 16) + 0.8 * rr(keyword_similarity_score, 16)` -- mostly rank by the reciprocal rank of `keyword_similarity_score` with slight adjustment of reciprocal rank of `semantic_smilarity_score`. The following signals are supported: * `semantic_similarity_score`: semantic similarity adjustment that is calculated using the embeddings generated by a proprietary Google model. This score determines how semantically similar a search query is to a document. * `keyword_similarity_score`: keyword match adjustment uses the Best Match 25 (BM25) ranking function. This score is calculated using a probabilistic model to estimate the probability that a document is relevant to a given query. * `relevance_score`: semantic relevance adjustment that uses a proprietary Google model to determine the meaning and intent behind a user's query in context with the content in the documents. * `pctr_rank`: predicted conversion rate adjustment as a rank use predicted Click-through rate (pCTR) to gauge the relevance and attractiveness of a search result from a user's perspective. A higher pCTR suggests that the result is more likely to satisfy the user's query and intent, making it a valuable signal for ranking. * `freshness_rank`: freshness adjustment as a rank * `document_age`: The time in hours elapsed since the document was last updated, a floating-point number (e.g., 0.25 means 15 minutes). * `topicality_rank`: topicality adjustment as a rank. Uses proprietary Google model to determine the keyword-based overlap between the query and the document. * `base_rank`: the default rank of the result * `media_actor_match`: whether the media actor matches the query * `media_director_match`: whether the media director matches the query * `media_genre_match`: whether the media genre matches the query * `media_language_match`: whether the media language matches the query * `media_title_match`: whether the media title matches the query * `media_prefix_similarity_rank`: prefix similarity rank for media results * `media_semantic_similarity_rank`: semantic similarity rank for media results "rankingExpressionBackend": "A String", # Optional. The backend to use for the ranking expression evaluation. "relevanceScoreSpec": { # The specification for returning the document relevance score. # Optional. The specification for returning the relevance score. "returnRelevanceScore": True or False, # Optional. Whether to return the relevance score for search results. The higher the score, the more relevant the document is to the query. diff --git a/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.sessions.html b/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.sessions.html index b1024e61de..0b63d147da 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.sessions.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.sessions.html @@ -985,7 +985,7 @@

Method Details

Args: parent: string, Required. The data store resource name. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}` (required) filter: string, A comma-separated list of fields to filter by, in EBNF grammar. The supported fields are: * `user_pseudo_id` * `state` * `display_name` * `starred` * `is_pinned` * `labels` * `create_time` * `update_time` * `collaborative_project` Examples: * `user_pseudo_id = some_id` * `display_name = "some_name"` * `starred = true` * `is_pinned=true AND (NOT labels:hidden)` * `create_time > "1970-01-01T12:00:00Z"` * `collaborative_project = "projects/123/locations/global/collections/default_collection/engines/" "default_engine/collaborative_projects/cp1"` - orderBy: string, A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `update_time` * `create_time` * `session_name` * `is_pinned` Example: * `update_time desc` * `create_time` * `is_pinned desc,update_time desc`: list sessions by is_pinned first, then by update_time. + orderBy: string, A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `update_time` * `create_time` * `session_name` * `is_pinned` * `display_name` Example: * `update_time desc` * `create_time` * `is_pinned desc,update_time desc`: list sessions by is_pinned first, then by update_time. pageSize: integer, Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000. pageToken: string, A page token, received from a previous `ListSessions` call. Provide this to retrieve the subsequent page. x__xgafv: string, V1 error format. diff --git a/docs/dyn/discoveryengine_v1.projects.locations.dataStores.html b/docs/dyn/discoveryengine_v1.projects.locations.dataStores.html index 8977ac4a3e..be00561cb9 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.dataStores.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.dataStores.html @@ -372,7 +372,7 @@

Method Details

}, }, "workspaceConfig": { # Config to store data store type configuration for workspace data # Config to store data store type configuration for workspace data. This must be set when DataStore.content_config is set as DataStore.ContentConfig.GOOGLE_WORKSPACE. - "dasherCustomerId": "A String", # Obfuscated Dasher customer ID. + "dasherCustomerId": "A String", # Output only. Obfuscated Dasher customer ID. Derived by the server from the project's GCP organization at data store creation time; any value supplied in the request payload is ignored. "superAdminEmailAddress": "A String", # Optional. The super admin email address for the workspace that will be used for access token generation. For now we only use it for Native Google Drive connector data ingestion. "superAdminServiceAccount": "A String", # Optional. The super admin service account for the workspace that will be used for access token generation. For now we only use it for Native Google Drive connector data ingestion. "type": "A String", # The Google Workspace data source. @@ -617,7 +617,7 @@

Method Details

}, }, "workspaceConfig": { # Config to store data store type configuration for workspace data # Config to store data store type configuration for workspace data. This must be set when DataStore.content_config is set as DataStore.ContentConfig.GOOGLE_WORKSPACE. - "dasherCustomerId": "A String", # Obfuscated Dasher customer ID. + "dasherCustomerId": "A String", # Output only. Obfuscated Dasher customer ID. Derived by the server from the project's GCP organization at data store creation time; any value supplied in the request payload is ignored. "superAdminEmailAddress": "A String", # Optional. The super admin email address for the workspace that will be used for access token generation. For now we only use it for Native Google Drive connector data ingestion. "superAdminServiceAccount": "A String", # Optional. The super admin service account for the workspace that will be used for access token generation. For now we only use it for Native Google Drive connector data ingestion. "type": "A String", # The Google Workspace data source. @@ -818,7 +818,7 @@

Method Details

}, }, "workspaceConfig": { # Config to store data store type configuration for workspace data # Config to store data store type configuration for workspace data. This must be set when DataStore.content_config is set as DataStore.ContentConfig.GOOGLE_WORKSPACE. - "dasherCustomerId": "A String", # Obfuscated Dasher customer ID. + "dasherCustomerId": "A String", # Output only. Obfuscated Dasher customer ID. Derived by the server from the project's GCP organization at data store creation time; any value supplied in the request payload is ignored. "superAdminEmailAddress": "A String", # Optional. The super admin email address for the workspace that will be used for access token generation. For now we only use it for Native Google Drive connector data ingestion. "superAdminServiceAccount": "A String", # Optional. The super admin service account for the workspace that will be used for access token generation. For now we only use it for Native Google Drive connector data ingestion. "type": "A String", # The Google Workspace data source. @@ -1007,7 +1007,7 @@

Method Details

}, }, "workspaceConfig": { # Config to store data store type configuration for workspace data # Config to store data store type configuration for workspace data. This must be set when DataStore.content_config is set as DataStore.ContentConfig.GOOGLE_WORKSPACE. - "dasherCustomerId": "A String", # Obfuscated Dasher customer ID. + "dasherCustomerId": "A String", # Output only. Obfuscated Dasher customer ID. Derived by the server from the project's GCP organization at data store creation time; any value supplied in the request payload is ignored. "superAdminEmailAddress": "A String", # Optional. The super admin email address for the workspace that will be used for access token generation. For now we only use it for Native Google Drive connector data ingestion. "superAdminServiceAccount": "A String", # Optional. The super admin service account for the workspace that will be used for access token generation. For now we only use it for Native Google Drive connector data ingestion. "type": "A String", # The Google Workspace data source. @@ -1178,7 +1178,7 @@

Method Details

}, }, "workspaceConfig": { # Config to store data store type configuration for workspace data # Config to store data store type configuration for workspace data. This must be set when DataStore.content_config is set as DataStore.ContentConfig.GOOGLE_WORKSPACE. - "dasherCustomerId": "A String", # Obfuscated Dasher customer ID. + "dasherCustomerId": "A String", # Output only. Obfuscated Dasher customer ID. Derived by the server from the project's GCP organization at data store creation time; any value supplied in the request payload is ignored. "superAdminEmailAddress": "A String", # Optional. The super admin email address for the workspace that will be used for access token generation. For now we only use it for Native Google Drive connector data ingestion. "superAdminServiceAccount": "A String", # Optional. The super admin service account for the workspace that will be used for access token generation. For now we only use it for Native Google Drive connector data ingestion. "type": "A String", # The Google Workspace data source. diff --git a/docs/dyn/discoveryengine_v1.projects.locations.dataStores.servingConfigs.html b/docs/dyn/discoveryengine_v1.projects.locations.dataStores.servingConfigs.html index 9efedadac6..33c72895cb 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.dataStores.servingConfigs.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.dataStores.servingConfigs.html @@ -1771,7 +1771,7 @@

Method Details

"condition": "A String", # The condition under which query expansion should occur. Default to Condition.DISABLED. "pinUnexpandedResults": True or False, # Whether to pin unexpanded results. If this field is set to true, unexpanded products are always at the top of the search results, followed by the expanded results. }, - "rankingExpression": "A String", # Optional. The ranking expression controls the customized ranking on retrieval documents. This overrides ServingConfig.ranking_expression. The syntax and supported features depend on the `ranking_expression_backend` value. If `ranking_expression_backend` is not provided, it defaults to `RANK_BY_EMBEDDING`. If ranking_expression_backend is not provided or set to `RANK_BY_EMBEDDING`, it should be a single function or multiple functions that are joined by "+". * ranking_expression = function, { " + ", function }; Supported functions: * double * relevance_score * double * dotProduct(embedding_field_path) Function variables: * `relevance_score`: pre-defined keywords, used for measure relevance between query and document. * `embedding_field_path`: the document embedding field used with query embedding vector. * `dotProduct`: embedding function between `embedding_field_path` and query embedding vector. Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`. If ranking_expression_backend is set to `RANK_BY_FORMULA`, the following expression types (and combinations of those chained using + or * operators) are supported: * `double` * `signal` * `log(signal)` * `exp(signal)` * `rr(signal, double > 0)` -- reciprocal rank transformation with second argument being a denominator constant. * `is_nan(signal)` -- returns 0 if signal is NaN, 1 otherwise. * `fill_nan(signal1, signal2 | double)` -- if signal1 is NaN, returns signal2 | double, else returns signal1. Here are a few examples of ranking formulas that use the supported ranking expression types: - `0.2 * semantic_similarity_score + 0.8 * log(keyword_similarity_score)` -- mostly rank by the logarithm of `keyword_similarity_score` with slight `semantic_smilarity_score` adjustment. - `0.2 * exp(fill_nan(semantic_similarity_score, 0)) + 0.3 * is_nan(keyword_similarity_score)` -- rank by the exponent of `semantic_similarity_score` filling the value with 0 if it's NaN, also add constant 0.3 adjustment to the final score if `semantic_similarity_score` is NaN. - `0.2 * rr(semantic_similarity_score, 16) + 0.8 * rr(keyword_similarity_score, 16)` -- mostly rank by the reciprocal rank of `keyword_similarity_score` with slight adjustment of reciprocal rank of `semantic_smilarity_score`. The following signals are supported: * `semantic_similarity_score`: semantic similarity adjustment that is calculated using the embeddings generated by a proprietary Google model. This score determines how semantically similar a search query is to a document. * `keyword_similarity_score`: keyword match adjustment uses the Best Match 25 (BM25) ranking function. This score is calculated using a probabilistic model to estimate the probability that a document is relevant to a given query. * `relevance_score`: semantic relevance adjustment that uses a proprietary Google model to determine the meaning and intent behind a user's query in context with the content in the documents. * `pctr_rank`: predicted conversion rate adjustment as a rank use predicted Click-through rate (pCTR) to gauge the relevance and attractiveness of a search result from a user's perspective. A higher pCTR suggests that the result is more likely to satisfy the user's query and intent, making it a valuable signal for ranking. * `freshness_rank`: freshness adjustment as a rank * `document_age`: The time in hours elapsed since the document was last updated, a floating-point number (e.g., 0.25 means 15 minutes). * `topicality_rank`: topicality adjustment as a rank. Uses proprietary Google model to determine the keyword-based overlap between the query and the document. * `base_rank`: the default rank of the result + "rankingExpression": "A String", # Optional. The ranking expression controls the customized ranking on retrieval documents. This overrides ServingConfig.ranking_expression. The syntax and supported features depend on the `ranking_expression_backend` value. If `ranking_expression_backend` is not provided, it defaults to `RANK_BY_EMBEDDING`. If ranking_expression_backend is not provided or set to `RANK_BY_EMBEDDING`, it should be a single function or multiple functions that are joined by "+". * ranking_expression = function, { " + ", function }; Supported functions: * double * relevance_score * double * dotProduct(embedding_field_path) Function variables: * `relevance_score`: pre-defined keywords, used for measure relevance between query and document. * `embedding_field_path`: the document embedding field used with query embedding vector. * `dotProduct`: embedding function between `embedding_field_path` and query embedding vector. Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`. If ranking_expression_backend is set to `RANK_BY_FORMULA`, the following expression types (and combinations of those chained using + or * operators) are supported: * `double` * `signal` * `log(signal)` * `exp(signal)` * `rr(signal, double > 0)` -- reciprocal rank transformation with second argument being a denominator constant. * `is_nan(signal)` -- returns 0 if signal is NaN, 1 otherwise. * `fill_nan(signal1, signal2 | double)` -- if signal1 is NaN, returns signal2 | double, else returns signal1. Here are a few examples of ranking formulas that use the supported ranking expression types: - `0.2 * semantic_similarity_score + 0.8 * log(keyword_similarity_score)` -- mostly rank by the logarithm of `keyword_similarity_score` with slight `semantic_smilarity_score` adjustment. - `0.2 * exp(fill_nan(semantic_similarity_score, 0)) + 0.3 * is_nan(keyword_similarity_score)` -- rank by the exponent of `semantic_similarity_score` filling the value with 0 if it's NaN, also add constant 0.3 adjustment to the final score if `semantic_similarity_score` is NaN. - `0.2 * rr(semantic_similarity_score, 16) + 0.8 * rr(keyword_similarity_score, 16)` -- mostly rank by the reciprocal rank of `keyword_similarity_score` with slight adjustment of reciprocal rank of `semantic_smilarity_score`. The following signals are supported: * `semantic_similarity_score`: semantic similarity adjustment that is calculated using the embeddings generated by a proprietary Google model. This score determines how semantically similar a search query is to a document. * `keyword_similarity_score`: keyword match adjustment uses the Best Match 25 (BM25) ranking function. This score is calculated using a probabilistic model to estimate the probability that a document is relevant to a given query. * `relevance_score`: semantic relevance adjustment that uses a proprietary Google model to determine the meaning and intent behind a user's query in context with the content in the documents. * `pctr_rank`: predicted conversion rate adjustment as a rank use predicted Click-through rate (pCTR) to gauge the relevance and attractiveness of a search result from a user's perspective. A higher pCTR suggests that the result is more likely to satisfy the user's query and intent, making it a valuable signal for ranking. * `freshness_rank`: freshness adjustment as a rank * `document_age`: The time in hours elapsed since the document was last updated, a floating-point number (e.g., 0.25 means 15 minutes). * `topicality_rank`: topicality adjustment as a rank. Uses proprietary Google model to determine the keyword-based overlap between the query and the document. * `base_rank`: the default rank of the result * `media_actor_match`: whether the media actor matches the query * `media_director_match`: whether the media director matches the query * `media_genre_match`: whether the media genre matches the query * `media_language_match`: whether the media language matches the query * `media_title_match`: whether the media title matches the query * `media_prefix_similarity_rank`: prefix similarity rank for media results * `media_semantic_similarity_rank`: semantic similarity rank for media results "rankingExpressionBackend": "A String", # Optional. The backend to use for the ranking expression evaluation. "relevanceScoreSpec": { # The specification for returning the document relevance score. # Optional. The specification for returning the relevance score. "returnRelevanceScore": True or False, # Optional. Whether to return the relevance score for search results. The higher the score, the more relevant the document is to the query. @@ -2240,7 +2240,7 @@

Method Details

"condition": "A String", # The condition under which query expansion should occur. Default to Condition.DISABLED. "pinUnexpandedResults": True or False, # Whether to pin unexpanded results. If this field is set to true, unexpanded products are always at the top of the search results, followed by the expanded results. }, - "rankingExpression": "A String", # Optional. The ranking expression controls the customized ranking on retrieval documents. This overrides ServingConfig.ranking_expression. The syntax and supported features depend on the `ranking_expression_backend` value. If `ranking_expression_backend` is not provided, it defaults to `RANK_BY_EMBEDDING`. If ranking_expression_backend is not provided or set to `RANK_BY_EMBEDDING`, it should be a single function or multiple functions that are joined by "+". * ranking_expression = function, { " + ", function }; Supported functions: * double * relevance_score * double * dotProduct(embedding_field_path) Function variables: * `relevance_score`: pre-defined keywords, used for measure relevance between query and document. * `embedding_field_path`: the document embedding field used with query embedding vector. * `dotProduct`: embedding function between `embedding_field_path` and query embedding vector. Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`. If ranking_expression_backend is set to `RANK_BY_FORMULA`, the following expression types (and combinations of those chained using + or * operators) are supported: * `double` * `signal` * `log(signal)` * `exp(signal)` * `rr(signal, double > 0)` -- reciprocal rank transformation with second argument being a denominator constant. * `is_nan(signal)` -- returns 0 if signal is NaN, 1 otherwise. * `fill_nan(signal1, signal2 | double)` -- if signal1 is NaN, returns signal2 | double, else returns signal1. Here are a few examples of ranking formulas that use the supported ranking expression types: - `0.2 * semantic_similarity_score + 0.8 * log(keyword_similarity_score)` -- mostly rank by the logarithm of `keyword_similarity_score` with slight `semantic_smilarity_score` adjustment. - `0.2 * exp(fill_nan(semantic_similarity_score, 0)) + 0.3 * is_nan(keyword_similarity_score)` -- rank by the exponent of `semantic_similarity_score` filling the value with 0 if it's NaN, also add constant 0.3 adjustment to the final score if `semantic_similarity_score` is NaN. - `0.2 * rr(semantic_similarity_score, 16) + 0.8 * rr(keyword_similarity_score, 16)` -- mostly rank by the reciprocal rank of `keyword_similarity_score` with slight adjustment of reciprocal rank of `semantic_smilarity_score`. The following signals are supported: * `semantic_similarity_score`: semantic similarity adjustment that is calculated using the embeddings generated by a proprietary Google model. This score determines how semantically similar a search query is to a document. * `keyword_similarity_score`: keyword match adjustment uses the Best Match 25 (BM25) ranking function. This score is calculated using a probabilistic model to estimate the probability that a document is relevant to a given query. * `relevance_score`: semantic relevance adjustment that uses a proprietary Google model to determine the meaning and intent behind a user's query in context with the content in the documents. * `pctr_rank`: predicted conversion rate adjustment as a rank use predicted Click-through rate (pCTR) to gauge the relevance and attractiveness of a search result from a user's perspective. A higher pCTR suggests that the result is more likely to satisfy the user's query and intent, making it a valuable signal for ranking. * `freshness_rank`: freshness adjustment as a rank * `document_age`: The time in hours elapsed since the document was last updated, a floating-point number (e.g., 0.25 means 15 minutes). * `topicality_rank`: topicality adjustment as a rank. Uses proprietary Google model to determine the keyword-based overlap between the query and the document. * `base_rank`: the default rank of the result + "rankingExpression": "A String", # Optional. The ranking expression controls the customized ranking on retrieval documents. This overrides ServingConfig.ranking_expression. The syntax and supported features depend on the `ranking_expression_backend` value. If `ranking_expression_backend` is not provided, it defaults to `RANK_BY_EMBEDDING`. If ranking_expression_backend is not provided or set to `RANK_BY_EMBEDDING`, it should be a single function or multiple functions that are joined by "+". * ranking_expression = function, { " + ", function }; Supported functions: * double * relevance_score * double * dotProduct(embedding_field_path) Function variables: * `relevance_score`: pre-defined keywords, used for measure relevance between query and document. * `embedding_field_path`: the document embedding field used with query embedding vector. * `dotProduct`: embedding function between `embedding_field_path` and query embedding vector. Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`. If ranking_expression_backend is set to `RANK_BY_FORMULA`, the following expression types (and combinations of those chained using + or * operators) are supported: * `double` * `signal` * `log(signal)` * `exp(signal)` * `rr(signal, double > 0)` -- reciprocal rank transformation with second argument being a denominator constant. * `is_nan(signal)` -- returns 0 if signal is NaN, 1 otherwise. * `fill_nan(signal1, signal2 | double)` -- if signal1 is NaN, returns signal2 | double, else returns signal1. Here are a few examples of ranking formulas that use the supported ranking expression types: - `0.2 * semantic_similarity_score + 0.8 * log(keyword_similarity_score)` -- mostly rank by the logarithm of `keyword_similarity_score` with slight `semantic_smilarity_score` adjustment. - `0.2 * exp(fill_nan(semantic_similarity_score, 0)) + 0.3 * is_nan(keyword_similarity_score)` -- rank by the exponent of `semantic_similarity_score` filling the value with 0 if it's NaN, also add constant 0.3 adjustment to the final score if `semantic_similarity_score` is NaN. - `0.2 * rr(semantic_similarity_score, 16) + 0.8 * rr(keyword_similarity_score, 16)` -- mostly rank by the reciprocal rank of `keyword_similarity_score` with slight adjustment of reciprocal rank of `semantic_smilarity_score`. The following signals are supported: * `semantic_similarity_score`: semantic similarity adjustment that is calculated using the embeddings generated by a proprietary Google model. This score determines how semantically similar a search query is to a document. * `keyword_similarity_score`: keyword match adjustment uses the Best Match 25 (BM25) ranking function. This score is calculated using a probabilistic model to estimate the probability that a document is relevant to a given query. * `relevance_score`: semantic relevance adjustment that uses a proprietary Google model to determine the meaning and intent behind a user's query in context with the content in the documents. * `pctr_rank`: predicted conversion rate adjustment as a rank use predicted Click-through rate (pCTR) to gauge the relevance and attractiveness of a search result from a user's perspective. A higher pCTR suggests that the result is more likely to satisfy the user's query and intent, making it a valuable signal for ranking. * `freshness_rank`: freshness adjustment as a rank * `document_age`: The time in hours elapsed since the document was last updated, a floating-point number (e.g., 0.25 means 15 minutes). * `topicality_rank`: topicality adjustment as a rank. Uses proprietary Google model to determine the keyword-based overlap between the query and the document. * `base_rank`: the default rank of the result * `media_actor_match`: whether the media actor matches the query * `media_director_match`: whether the media director matches the query * `media_genre_match`: whether the media genre matches the query * `media_language_match`: whether the media language matches the query * `media_title_match`: whether the media title matches the query * `media_prefix_similarity_rank`: prefix similarity rank for media results * `media_semantic_similarity_rank`: semantic similarity rank for media results "rankingExpressionBackend": "A String", # Optional. The backend to use for the ranking expression evaluation. "relevanceScoreSpec": { # The specification for returning the document relevance score. # Optional. The specification for returning the relevance score. "returnRelevanceScore": True or False, # Optional. Whether to return the relevance score for search results. The higher the score, the more relevant the document is to the query. diff --git a/docs/dyn/discoveryengine_v1.projects.locations.dataStores.sessions.html b/docs/dyn/discoveryengine_v1.projects.locations.dataStores.sessions.html index e1c2d42296..8819062ae8 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.dataStores.sessions.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.dataStores.sessions.html @@ -985,7 +985,7 @@

Method Details

Args: parent: string, Required. The data store resource name. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}` (required) filter: string, A comma-separated list of fields to filter by, in EBNF grammar. The supported fields are: * `user_pseudo_id` * `state` * `display_name` * `starred` * `is_pinned` * `labels` * `create_time` * `update_time` * `collaborative_project` Examples: * `user_pseudo_id = some_id` * `display_name = "some_name"` * `starred = true` * `is_pinned=true AND (NOT labels:hidden)` * `create_time > "1970-01-01T12:00:00Z"` * `collaborative_project = "projects/123/locations/global/collections/default_collection/engines/" "default_engine/collaborative_projects/cp1"` - orderBy: string, A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `update_time` * `create_time` * `session_name` * `is_pinned` Example: * `update_time desc` * `create_time` * `is_pinned desc,update_time desc`: list sessions by is_pinned first, then by update_time. + orderBy: string, A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `update_time` * `create_time` * `session_name` * `is_pinned` * `display_name` Example: * `update_time desc` * `create_time` * `is_pinned desc,update_time desc`: list sessions by is_pinned first, then by update_time. pageSize: integer, Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000. pageToken: string, A page token, received from a previous `ListSessions` call. Provide this to retrieve the subsequent page. x__xgafv: string, V1 error format. diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.html index 0979c69a6f..8393c4fcdf 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.html @@ -470,7 +470,7 @@

Method Details

"schemaOrgPaths": [ # Field paths for indexing custom attribute from schema.org data. More details of schema.org and its defined types can be found at [schema.org](https://schema.org). It is only used on advanced site search schema. Currently only support full path from root. The full path to a field is constructed by concatenating field names, starting from `_root`, with a period `.` as the delimiter. Examples: * Publish date of the root: _root.datePublished * Publish date of the reviews: _root.review.datePublished "A String", ], - "searchableFieldImportance": "A String", # Optional. Specifies the importance of the field when `searchable_option` is `SEARCHABLE_ENABLED`. If `searchable_option` is `SEARCHABLE_DISABLED`, this field is ignored. If `searchable_option` is `SEARCHABLE_ENABLED` and this is `SEARCHABLE_FIELD_IMPORTANCE_UNSPECIFIED`, it behaves as `DEFAULT_IMPORTANCE`. + "searchableFieldImportance": "A String", # Optional. Specifies the importance of the field when `searchable_option` is `SEARCHABLE_ENABLED`. If `searchable_option` is `SEARCHABLE_DISABLED`, this field is ignored. If `searchable_option` is `SEARCHABLE_ENABLED` and this is `SEARCHABLE_FIELD_IMPORTANCE_UNSPECIFIED`, it behaves as `DEFAULT_IMPORTANCE`. For more information, see [Weight searchable fields](https://cloud.google.com/generative-ai-app-builder/docs/configure-field-settings#weight-search). "searchableOption": "A String", # If searchable_option is SEARCHABLE_ENABLED, field values are searchable by text queries in SearchService.Search. If SEARCHABLE_ENABLED but field type is numerical, field values will not be searchable by text queries in SearchService.Search, as there are no text values associated to numerical fields. If searchable_option is unset, the server behavior defaults to SEARCHABLE_DISABLED for fields that support setting searchable options. Only `string` fields that have no key property mapping support setting searchable_option. For those fields that do not support setting searchable options, the server will skip searchable option setting, and setting searchable_option for those fields will throw `INVALID_ARGUMENT` error. }, ], @@ -481,7 +481,7 @@

Method Details

}, }, "workspaceConfig": { # Config to store data store type configuration for workspace data # Config to store data store type configuration for workspace data. This must be set when DataStore.content_config is set as DataStore.ContentConfig.GOOGLE_WORKSPACE. - "dasherCustomerId": "A String", # Obfuscated Dasher customer ID. + "dasherCustomerId": "A String", # Output only. Obfuscated Dasher customer ID. Derived by the server from the project's GCP organization at data store creation time; any value supplied in the request payload is ignored. "superAdminEmailAddress": "A String", # Optional. The super admin email address for the workspace that will be used for access token generation. For now we only use it for Native Google Drive connector data ingestion. "superAdminServiceAccount": "A String", # Optional. The super admin service account for the workspace that will be used for access token generation. For now we only use it for Native Google Drive connector data ingestion. "type": "A String", # The Google Workspace data source. @@ -795,7 +795,7 @@

Method Details

"schemaOrgPaths": [ # Field paths for indexing custom attribute from schema.org data. More details of schema.org and its defined types can be found at [schema.org](https://schema.org). It is only used on advanced site search schema. Currently only support full path from root. The full path to a field is constructed by concatenating field names, starting from `_root`, with a period `.` as the delimiter. Examples: * Publish date of the root: _root.datePublished * Publish date of the reviews: _root.review.datePublished "A String", ], - "searchableFieldImportance": "A String", # Optional. Specifies the importance of the field when `searchable_option` is `SEARCHABLE_ENABLED`. If `searchable_option` is `SEARCHABLE_DISABLED`, this field is ignored. If `searchable_option` is `SEARCHABLE_ENABLED` and this is `SEARCHABLE_FIELD_IMPORTANCE_UNSPECIFIED`, it behaves as `DEFAULT_IMPORTANCE`. + "searchableFieldImportance": "A String", # Optional. Specifies the importance of the field when `searchable_option` is `SEARCHABLE_ENABLED`. If `searchable_option` is `SEARCHABLE_DISABLED`, this field is ignored. If `searchable_option` is `SEARCHABLE_ENABLED` and this is `SEARCHABLE_FIELD_IMPORTANCE_UNSPECIFIED`, it behaves as `DEFAULT_IMPORTANCE`. For more information, see [Weight searchable fields](https://cloud.google.com/generative-ai-app-builder/docs/configure-field-settings#weight-search). "searchableOption": "A String", # If searchable_option is SEARCHABLE_ENABLED, field values are searchable by text queries in SearchService.Search. If SEARCHABLE_ENABLED but field type is numerical, field values will not be searchable by text queries in SearchService.Search, as there are no text values associated to numerical fields. If searchable_option is unset, the server behavior defaults to SEARCHABLE_DISABLED for fields that support setting searchable options. Only `string` fields that have no key property mapping support setting searchable_option. For those fields that do not support setting searchable options, the server will skip searchable option setting, and setting searchable_option for those fields will throw `INVALID_ARGUMENT` error. }, ], @@ -806,7 +806,7 @@

Method Details

}, }, "workspaceConfig": { # Config to store data store type configuration for workspace data # Config to store data store type configuration for workspace data. This must be set when DataStore.content_config is set as DataStore.ContentConfig.GOOGLE_WORKSPACE. - "dasherCustomerId": "A String", # Obfuscated Dasher customer ID. + "dasherCustomerId": "A String", # Output only. Obfuscated Dasher customer ID. Derived by the server from the project's GCP organization at data store creation time; any value supplied in the request payload is ignored. "superAdminEmailAddress": "A String", # Optional. The super admin email address for the workspace that will be used for access token generation. For now we only use it for Native Google Drive connector data ingestion. "superAdminServiceAccount": "A String", # Optional. The super admin service account for the workspace that will be used for access token generation. For now we only use it for Native Google Drive connector data ingestion. "type": "A String", # The Google Workspace data source. @@ -1117,7 +1117,7 @@

Method Details

"schemaOrgPaths": [ # Field paths for indexing custom attribute from schema.org data. More details of schema.org and its defined types can be found at [schema.org](https://schema.org). It is only used on advanced site search schema. Currently only support full path from root. The full path to a field is constructed by concatenating field names, starting from `_root`, with a period `.` as the delimiter. Examples: * Publish date of the root: _root.datePublished * Publish date of the reviews: _root.review.datePublished "A String", ], - "searchableFieldImportance": "A String", # Optional. Specifies the importance of the field when `searchable_option` is `SEARCHABLE_ENABLED`. If `searchable_option` is `SEARCHABLE_DISABLED`, this field is ignored. If `searchable_option` is `SEARCHABLE_ENABLED` and this is `SEARCHABLE_FIELD_IMPORTANCE_UNSPECIFIED`, it behaves as `DEFAULT_IMPORTANCE`. + "searchableFieldImportance": "A String", # Optional. Specifies the importance of the field when `searchable_option` is `SEARCHABLE_ENABLED`. If `searchable_option` is `SEARCHABLE_DISABLED`, this field is ignored. If `searchable_option` is `SEARCHABLE_ENABLED` and this is `SEARCHABLE_FIELD_IMPORTANCE_UNSPECIFIED`, it behaves as `DEFAULT_IMPORTANCE`. For more information, see [Weight searchable fields](https://cloud.google.com/generative-ai-app-builder/docs/configure-field-settings#weight-search). "searchableOption": "A String", # If searchable_option is SEARCHABLE_ENABLED, field values are searchable by text queries in SearchService.Search. If SEARCHABLE_ENABLED but field type is numerical, field values will not be searchable by text queries in SearchService.Search, as there are no text values associated to numerical fields. If searchable_option is unset, the server behavior defaults to SEARCHABLE_DISABLED for fields that support setting searchable options. Only `string` fields that have no key property mapping support setting searchable_option. For those fields that do not support setting searchable options, the server will skip searchable option setting, and setting searchable_option for those fields will throw `INVALID_ARGUMENT` error. }, ], @@ -1128,7 +1128,7 @@

Method Details

}, }, "workspaceConfig": { # Config to store data store type configuration for workspace data # Config to store data store type configuration for workspace data. This must be set when DataStore.content_config is set as DataStore.ContentConfig.GOOGLE_WORKSPACE. - "dasherCustomerId": "A String", # Obfuscated Dasher customer ID. + "dasherCustomerId": "A String", # Output only. Obfuscated Dasher customer ID. Derived by the server from the project's GCP organization at data store creation time; any value supplied in the request payload is ignored. "superAdminEmailAddress": "A String", # Optional. The super admin email address for the workspace that will be used for access token generation. For now we only use it for Native Google Drive connector data ingestion. "superAdminServiceAccount": "A String", # Optional. The super admin service account for the workspace that will be used for access token generation. For now we only use it for Native Google Drive connector data ingestion. "type": "A String", # The Google Workspace data source. @@ -1344,7 +1344,7 @@

Method Details

"schemaOrgPaths": [ # Field paths for indexing custom attribute from schema.org data. More details of schema.org and its defined types can be found at [schema.org](https://schema.org). It is only used on advanced site search schema. Currently only support full path from root. The full path to a field is constructed by concatenating field names, starting from `_root`, with a period `.` as the delimiter. Examples: * Publish date of the root: _root.datePublished * Publish date of the reviews: _root.review.datePublished "A String", ], - "searchableFieldImportance": "A String", # Optional. Specifies the importance of the field when `searchable_option` is `SEARCHABLE_ENABLED`. If `searchable_option` is `SEARCHABLE_DISABLED`, this field is ignored. If `searchable_option` is `SEARCHABLE_ENABLED` and this is `SEARCHABLE_FIELD_IMPORTANCE_UNSPECIFIED`, it behaves as `DEFAULT_IMPORTANCE`. + "searchableFieldImportance": "A String", # Optional. Specifies the importance of the field when `searchable_option` is `SEARCHABLE_ENABLED`. If `searchable_option` is `SEARCHABLE_DISABLED`, this field is ignored. If `searchable_option` is `SEARCHABLE_ENABLED` and this is `SEARCHABLE_FIELD_IMPORTANCE_UNSPECIFIED`, it behaves as `DEFAULT_IMPORTANCE`. For more information, see [Weight searchable fields](https://cloud.google.com/generative-ai-app-builder/docs/configure-field-settings#weight-search). "searchableOption": "A String", # If searchable_option is SEARCHABLE_ENABLED, field values are searchable by text queries in SearchService.Search. If SEARCHABLE_ENABLED but field type is numerical, field values will not be searchable by text queries in SearchService.Search, as there are no text values associated to numerical fields. If searchable_option is unset, the server behavior defaults to SEARCHABLE_DISABLED for fields that support setting searchable options. Only `string` fields that have no key property mapping support setting searchable_option. For those fields that do not support setting searchable options, the server will skip searchable option setting, and setting searchable_option for those fields will throw `INVALID_ARGUMENT` error. }, ], @@ -1355,7 +1355,7 @@

Method Details

}, }, "workspaceConfig": { # Config to store data store type configuration for workspace data # Config to store data store type configuration for workspace data. This must be set when DataStore.content_config is set as DataStore.ContentConfig.GOOGLE_WORKSPACE. - "dasherCustomerId": "A String", # Obfuscated Dasher customer ID. + "dasherCustomerId": "A String", # Output only. Obfuscated Dasher customer ID. Derived by the server from the project's GCP organization at data store creation time; any value supplied in the request payload is ignored. "superAdminEmailAddress": "A String", # Optional. The super admin email address for the workspace that will be used for access token generation. For now we only use it for Native Google Drive connector data ingestion. "superAdminServiceAccount": "A String", # Optional. The super admin service account for the workspace that will be used for access token generation. For now we only use it for Native Google Drive connector data ingestion. "type": "A String", # The Google Workspace data source. @@ -1553,7 +1553,7 @@

Method Details

"schemaOrgPaths": [ # Field paths for indexing custom attribute from schema.org data. More details of schema.org and its defined types can be found at [schema.org](https://schema.org). It is only used on advanced site search schema. Currently only support full path from root. The full path to a field is constructed by concatenating field names, starting from `_root`, with a period `.` as the delimiter. Examples: * Publish date of the root: _root.datePublished * Publish date of the reviews: _root.review.datePublished "A String", ], - "searchableFieldImportance": "A String", # Optional. Specifies the importance of the field when `searchable_option` is `SEARCHABLE_ENABLED`. If `searchable_option` is `SEARCHABLE_DISABLED`, this field is ignored. If `searchable_option` is `SEARCHABLE_ENABLED` and this is `SEARCHABLE_FIELD_IMPORTANCE_UNSPECIFIED`, it behaves as `DEFAULT_IMPORTANCE`. + "searchableFieldImportance": "A String", # Optional. Specifies the importance of the field when `searchable_option` is `SEARCHABLE_ENABLED`. If `searchable_option` is `SEARCHABLE_DISABLED`, this field is ignored. If `searchable_option` is `SEARCHABLE_ENABLED` and this is `SEARCHABLE_FIELD_IMPORTANCE_UNSPECIFIED`, it behaves as `DEFAULT_IMPORTANCE`. For more information, see [Weight searchable fields](https://cloud.google.com/generative-ai-app-builder/docs/configure-field-settings#weight-search). "searchableOption": "A String", # If searchable_option is SEARCHABLE_ENABLED, field values are searchable by text queries in SearchService.Search. If SEARCHABLE_ENABLED but field type is numerical, field values will not be searchable by text queries in SearchService.Search, as there are no text values associated to numerical fields. If searchable_option is unset, the server behavior defaults to SEARCHABLE_DISABLED for fields that support setting searchable options. Only `string` fields that have no key property mapping support setting searchable_option. For those fields that do not support setting searchable options, the server will skip searchable option setting, and setting searchable_option for those fields will throw `INVALID_ARGUMENT` error. }, ], @@ -1564,7 +1564,7 @@

Method Details

}, }, "workspaceConfig": { # Config to store data store type configuration for workspace data # Config to store data store type configuration for workspace data. This must be set when DataStore.content_config is set as DataStore.ContentConfig.GOOGLE_WORKSPACE. - "dasherCustomerId": "A String", # Obfuscated Dasher customer ID. + "dasherCustomerId": "A String", # Output only. Obfuscated Dasher customer ID. Derived by the server from the project's GCP organization at data store creation time; any value supplied in the request payload is ignored. "superAdminEmailAddress": "A String", # Optional. The super admin email address for the workspace that will be used for access token generation. For now we only use it for Native Google Drive connector data ingestion. "superAdminServiceAccount": "A String", # Optional. The super admin service account for the workspace that will be used for access token generation. For now we only use it for Native Google Drive connector data ingestion. "type": "A String", # The Google Workspace data source. diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.schemas.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.schemas.html index 3484fa59ae..e9fc107d8e 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.schemas.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.schemas.html @@ -133,7 +133,7 @@

Method Details

"schemaOrgPaths": [ # Field paths for indexing custom attribute from schema.org data. More details of schema.org and its defined types can be found at [schema.org](https://schema.org). It is only used on advanced site search schema. Currently only support full path from root. The full path to a field is constructed by concatenating field names, starting from `_root`, with a period `.` as the delimiter. Examples: * Publish date of the root: _root.datePublished * Publish date of the reviews: _root.review.datePublished "A String", ], - "searchableFieldImportance": "A String", # Optional. Specifies the importance of the field when `searchable_option` is `SEARCHABLE_ENABLED`. If `searchable_option` is `SEARCHABLE_DISABLED`, this field is ignored. If `searchable_option` is `SEARCHABLE_ENABLED` and this is `SEARCHABLE_FIELD_IMPORTANCE_UNSPECIFIED`, it behaves as `DEFAULT_IMPORTANCE`. + "searchableFieldImportance": "A String", # Optional. Specifies the importance of the field when `searchable_option` is `SEARCHABLE_ENABLED`. If `searchable_option` is `SEARCHABLE_DISABLED`, this field is ignored. If `searchable_option` is `SEARCHABLE_ENABLED` and this is `SEARCHABLE_FIELD_IMPORTANCE_UNSPECIFIED`, it behaves as `DEFAULT_IMPORTANCE`. For more information, see [Weight searchable fields](https://cloud.google.com/generative-ai-app-builder/docs/configure-field-settings#weight-search). "searchableOption": "A String", # If searchable_option is SEARCHABLE_ENABLED, field values are searchable by text queries in SearchService.Search. If SEARCHABLE_ENABLED but field type is numerical, field values will not be searchable by text queries in SearchService.Search, as there are no text values associated to numerical fields. If searchable_option is unset, the server behavior defaults to SEARCHABLE_DISABLED for fields that support setting searchable options. Only `string` fields that have no key property mapping support setting searchable_option. For those fields that do not support setting searchable options, the server will skip searchable option setting, and setting searchable_option for those fields will throw `INVALID_ARGUMENT` error. }, ], @@ -241,7 +241,7 @@

Method Details

"schemaOrgPaths": [ # Field paths for indexing custom attribute from schema.org data. More details of schema.org and its defined types can be found at [schema.org](https://schema.org). It is only used on advanced site search schema. Currently only support full path from root. The full path to a field is constructed by concatenating field names, starting from `_root`, with a period `.` as the delimiter. Examples: * Publish date of the root: _root.datePublished * Publish date of the reviews: _root.review.datePublished "A String", ], - "searchableFieldImportance": "A String", # Optional. Specifies the importance of the field when `searchable_option` is `SEARCHABLE_ENABLED`. If `searchable_option` is `SEARCHABLE_DISABLED`, this field is ignored. If `searchable_option` is `SEARCHABLE_ENABLED` and this is `SEARCHABLE_FIELD_IMPORTANCE_UNSPECIFIED`, it behaves as `DEFAULT_IMPORTANCE`. + "searchableFieldImportance": "A String", # Optional. Specifies the importance of the field when `searchable_option` is `SEARCHABLE_ENABLED`. If `searchable_option` is `SEARCHABLE_DISABLED`, this field is ignored. If `searchable_option` is `SEARCHABLE_ENABLED` and this is `SEARCHABLE_FIELD_IMPORTANCE_UNSPECIFIED`, it behaves as `DEFAULT_IMPORTANCE`. For more information, see [Weight searchable fields](https://cloud.google.com/generative-ai-app-builder/docs/configure-field-settings#weight-search). "searchableOption": "A String", # If searchable_option is SEARCHABLE_ENABLED, field values are searchable by text queries in SearchService.Search. If SEARCHABLE_ENABLED but field type is numerical, field values will not be searchable by text queries in SearchService.Search, as there are no text values associated to numerical fields. If searchable_option is unset, the server behavior defaults to SEARCHABLE_DISABLED for fields that support setting searchable options. Only `string` fields that have no key property mapping support setting searchable_option. For those fields that do not support setting searchable options, the server will skip searchable option setting, and setting searchable_option for those fields will throw `INVALID_ARGUMENT` error. }, ], @@ -290,7 +290,7 @@

Method Details

"schemaOrgPaths": [ # Field paths for indexing custom attribute from schema.org data. More details of schema.org and its defined types can be found at [schema.org](https://schema.org). It is only used on advanced site search schema. Currently only support full path from root. The full path to a field is constructed by concatenating field names, starting from `_root`, with a period `.` as the delimiter. Examples: * Publish date of the root: _root.datePublished * Publish date of the reviews: _root.review.datePublished "A String", ], - "searchableFieldImportance": "A String", # Optional. Specifies the importance of the field when `searchable_option` is `SEARCHABLE_ENABLED`. If `searchable_option` is `SEARCHABLE_DISABLED`, this field is ignored. If `searchable_option` is `SEARCHABLE_ENABLED` and this is `SEARCHABLE_FIELD_IMPORTANCE_UNSPECIFIED`, it behaves as `DEFAULT_IMPORTANCE`. + "searchableFieldImportance": "A String", # Optional. Specifies the importance of the field when `searchable_option` is `SEARCHABLE_ENABLED`. If `searchable_option` is `SEARCHABLE_DISABLED`, this field is ignored. If `searchable_option` is `SEARCHABLE_ENABLED` and this is `SEARCHABLE_FIELD_IMPORTANCE_UNSPECIFIED`, it behaves as `DEFAULT_IMPORTANCE`. For more information, see [Weight searchable fields](https://cloud.google.com/generative-ai-app-builder/docs/configure-field-settings#weight-search). "searchableOption": "A String", # If searchable_option is SEARCHABLE_ENABLED, field values are searchable by text queries in SearchService.Search. If SEARCHABLE_ENABLED but field type is numerical, field values will not be searchable by text queries in SearchService.Search, as there are no text values associated to numerical fields. If searchable_option is unset, the server behavior defaults to SEARCHABLE_DISABLED for fields that support setting searchable options. Only `string` fields that have no key property mapping support setting searchable_option. For those fields that do not support setting searchable options, the server will skip searchable option setting, and setting searchable_option for those fields will throw `INVALID_ARGUMENT` error. }, ], @@ -345,7 +345,7 @@

Method Details

"schemaOrgPaths": [ # Field paths for indexing custom attribute from schema.org data. More details of schema.org and its defined types can be found at [schema.org](https://schema.org). It is only used on advanced site search schema. Currently only support full path from root. The full path to a field is constructed by concatenating field names, starting from `_root`, with a period `.` as the delimiter. Examples: * Publish date of the root: _root.datePublished * Publish date of the reviews: _root.review.datePublished "A String", ], - "searchableFieldImportance": "A String", # Optional. Specifies the importance of the field when `searchable_option` is `SEARCHABLE_ENABLED`. If `searchable_option` is `SEARCHABLE_DISABLED`, this field is ignored. If `searchable_option` is `SEARCHABLE_ENABLED` and this is `SEARCHABLE_FIELD_IMPORTANCE_UNSPECIFIED`, it behaves as `DEFAULT_IMPORTANCE`. + "searchableFieldImportance": "A String", # Optional. Specifies the importance of the field when `searchable_option` is `SEARCHABLE_ENABLED`. If `searchable_option` is `SEARCHABLE_DISABLED`, this field is ignored. If `searchable_option` is `SEARCHABLE_ENABLED` and this is `SEARCHABLE_FIELD_IMPORTANCE_UNSPECIFIED`, it behaves as `DEFAULT_IMPORTANCE`. For more information, see [Weight searchable fields](https://cloud.google.com/generative-ai-app-builder/docs/configure-field-settings#weight-search). "searchableOption": "A String", # If searchable_option is SEARCHABLE_ENABLED, field values are searchable by text queries in SearchService.Search. If SEARCHABLE_ENABLED but field type is numerical, field values will not be searchable by text queries in SearchService.Search, as there are no text values associated to numerical fields. If searchable_option is unset, the server behavior defaults to SEARCHABLE_DISABLED for fields that support setting searchable options. Only `string` fields that have no key property mapping support setting searchable_option. For those fields that do not support setting searchable options, the server will skip searchable option setting, and setting searchable_option for those fields will throw `INVALID_ARGUMENT` error. }, ], diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.servingConfigs.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.servingConfigs.html index ccd9735e1f..9642a3ab84 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.servingConfigs.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.servingConfigs.html @@ -2005,7 +2005,7 @@

Method Details

"condition": "A String", # The condition under which query expansion should occur. Default to Condition.DISABLED. "pinUnexpandedResults": True or False, # Whether to pin unexpanded results. If this field is set to true, unexpanded products are always at the top of the search results, followed by the expanded results. }, - "rankingExpression": "A String", # Optional. The ranking expression controls the customized ranking on retrieval documents. This overrides ServingConfig.ranking_expression. The syntax and supported features depend on the `ranking_expression_backend` value. If `ranking_expression_backend` is not provided, it defaults to `RANK_BY_EMBEDDING`. If ranking_expression_backend is not provided or set to `RANK_BY_EMBEDDING`, it should be a single function or multiple functions that are joined by "+". * ranking_expression = function, { " + ", function }; Supported functions: * double * relevance_score * double * dotProduct(embedding_field_path) Function variables: * `relevance_score`: pre-defined keywords, used for measure relevance between query and document. * `embedding_field_path`: the document embedding field used with query embedding vector. * `dotProduct`: embedding function between `embedding_field_path` and query embedding vector. Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`. If ranking_expression_backend is set to `RANK_BY_FORMULA`, the following expression types (and combinations of those chained using + or * operators) are supported: * `double` * `signal` * `log(signal)` * `exp(signal)` * `rr(signal, double > 0)` -- reciprocal rank transformation with second argument being a denominator constant. * `is_nan(signal)` -- returns 0 if signal is NaN, 1 otherwise. * `fill_nan(signal1, signal2 | double)` -- if signal1 is NaN, returns signal2 | double, else returns signal1. Here are a few examples of ranking formulas that use the supported ranking expression types: - `0.2 * semantic_similarity_score + 0.8 * log(keyword_similarity_score)` -- mostly rank by the logarithm of `keyword_similarity_score` with slight `semantic_smilarity_score` adjustment. - `0.2 * exp(fill_nan(semantic_similarity_score, 0)) + 0.3 * is_nan(keyword_similarity_score)` -- rank by the exponent of `semantic_similarity_score` filling the value with 0 if it's NaN, also add constant 0.3 adjustment to the final score if `semantic_similarity_score` is NaN. - `0.2 * rr(semantic_similarity_score, 16) + 0.8 * rr(keyword_similarity_score, 16)` -- mostly rank by the reciprocal rank of `keyword_similarity_score` with slight adjustment of reciprocal rank of `semantic_smilarity_score`. The following signals are supported: * `semantic_similarity_score`: semantic similarity adjustment that is calculated using the embeddings generated by a proprietary Google model. This score determines how semantically similar a search query is to a document. * `keyword_similarity_score`: keyword match adjustment uses the Best Match 25 (BM25) ranking function. This score is calculated using a probabilistic model to estimate the probability that a document is relevant to a given query. * `relevance_score`: semantic relevance adjustment that uses a proprietary Google model to determine the meaning and intent behind a user's query in context with the content in the documents. * `pctr_rank`: predicted conversion rate adjustment as a rank use predicted Click-through rate (pCTR) to gauge the relevance and attractiveness of a search result from a user's perspective. A higher pCTR suggests that the result is more likely to satisfy the user's query and intent, making it a valuable signal for ranking. * `freshness_rank`: freshness adjustment as a rank * `document_age`: The time in hours elapsed since the document was last updated, a floating-point number (e.g., 0.25 means 15 minutes). * `topicality_rank`: topicality adjustment as a rank. Uses proprietary Google model to determine the keyword-based overlap between the query and the document. * `base_rank`: the default rank of the result + "rankingExpression": "A String", # Optional. The ranking expression controls the customized ranking on retrieval documents. This overrides ServingConfig.ranking_expression. The syntax and supported features depend on the `ranking_expression_backend` value. If `ranking_expression_backend` is not provided, it defaults to `RANK_BY_EMBEDDING`. If ranking_expression_backend is not provided or set to `RANK_BY_EMBEDDING`, it should be a single function or multiple functions that are joined by "+". * ranking_expression = function, { " + ", function }; Supported functions: * double * relevance_score * double * dotProduct(embedding_field_path) Function variables: * `relevance_score`: pre-defined keywords, used for measure relevance between query and document. * `embedding_field_path`: the document embedding field used with query embedding vector. * `dotProduct`: embedding function between `embedding_field_path` and query embedding vector. Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`. If ranking_expression_backend is set to `RANK_BY_FORMULA`, the following expression types (and combinations of those chained using + or * operators) are supported: * `double` * `signal` * `log(signal)` * `exp(signal)` * `rr(signal, double > 0)` -- reciprocal rank transformation with second argument being a denominator constant. * `is_nan(signal)` -- returns 0 if signal is NaN, 1 otherwise. * `fill_nan(signal1, signal2 | double)` -- if signal1 is NaN, returns signal2 | double, else returns signal1. Here are a few examples of ranking formulas that use the supported ranking expression types: - `0.2 * semantic_similarity_score + 0.8 * log(keyword_similarity_score)` -- mostly rank by the logarithm of `keyword_similarity_score` with slight `semantic_smilarity_score` adjustment. - `0.2 * exp(fill_nan(semantic_similarity_score, 0)) + 0.3 * is_nan(keyword_similarity_score)` -- rank by the exponent of `semantic_similarity_score` filling the value with 0 if it's NaN, also add constant 0.3 adjustment to the final score if `semantic_similarity_score` is NaN. - `0.2 * rr(semantic_similarity_score, 16) + 0.8 * rr(keyword_similarity_score, 16)` -- mostly rank by the reciprocal rank of `keyword_similarity_score` with slight adjustment of reciprocal rank of `semantic_smilarity_score`. The following signals are supported: * `semantic_similarity_score`: semantic similarity adjustment that is calculated using the embeddings generated by a proprietary Google model. This score determines how semantically similar a search query is to a document. * `keyword_similarity_score`: keyword match adjustment uses the Best Match 25 (BM25) ranking function. This score is calculated using a probabilistic model to estimate the probability that a document is relevant to a given query. * `relevance_score`: semantic relevance adjustment that uses a proprietary Google model to determine the meaning and intent behind a user's query in context with the content in the documents. * `pctr_rank`: predicted conversion rate adjustment as a rank use predicted Click-through rate (pCTR) to gauge the relevance and attractiveness of a search result from a user's perspective. A higher pCTR suggests that the result is more likely to satisfy the user's query and intent, making it a valuable signal for ranking. * `freshness_rank`: freshness adjustment as a rank * `document_age`: The time in hours elapsed since the document was last updated, a floating-point number (e.g., 0.25 means 15 minutes). * `topicality_rank`: topicality adjustment as a rank. Uses proprietary Google model to determine the keyword-based overlap between the query and the document. * `base_rank`: the default rank of the result * `media_actor_match`: whether the media actor matches the query * `media_director_match`: whether the media director matches the query * `media_genre_match`: whether the media genre matches the query * `media_language_match`: whether the media language matches the query * `media_title_match`: whether the media title matches the query * `media_prefix_similarity_rank`: prefix similarity rank for media results * `media_semantic_similarity_rank`: semantic similarity rank for media results "rankingExpressionBackend": "A String", # Optional. The backend to use for the ranking expression evaluation. "regionCode": "A String", # The Unicode country/region code (CLDR) of a location, such as "US" and "419". For more information, see [Standard fields](https://cloud.google.com/apis/design/standard_fields). If set, then results will be boosted based on the region_code provided. "relevanceFilterSpec": { # Relevance filtering specification. # Optional. The granular relevance filtering specification. If not specified, the global `relevance_threshold` will be used for all sub-searches. If specified, this overrides the global `relevance_threshold` to use thresholds on a per sub-search basis. This feature is currently supported only for custom and site search. @@ -2672,7 +2672,7 @@

Method Details

"condition": "A String", # The condition under which query expansion should occur. Default to Condition.DISABLED. "pinUnexpandedResults": True or False, # Whether to pin unexpanded results. If this field is set to true, unexpanded products are always at the top of the search results, followed by the expanded results. }, - "rankingExpression": "A String", # Optional. The ranking expression controls the customized ranking on retrieval documents. This overrides ServingConfig.ranking_expression. The syntax and supported features depend on the `ranking_expression_backend` value. If `ranking_expression_backend` is not provided, it defaults to `RANK_BY_EMBEDDING`. If ranking_expression_backend is not provided or set to `RANK_BY_EMBEDDING`, it should be a single function or multiple functions that are joined by "+". * ranking_expression = function, { " + ", function }; Supported functions: * double * relevance_score * double * dotProduct(embedding_field_path) Function variables: * `relevance_score`: pre-defined keywords, used for measure relevance between query and document. * `embedding_field_path`: the document embedding field used with query embedding vector. * `dotProduct`: embedding function between `embedding_field_path` and query embedding vector. Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`. If ranking_expression_backend is set to `RANK_BY_FORMULA`, the following expression types (and combinations of those chained using + or * operators) are supported: * `double` * `signal` * `log(signal)` * `exp(signal)` * `rr(signal, double > 0)` -- reciprocal rank transformation with second argument being a denominator constant. * `is_nan(signal)` -- returns 0 if signal is NaN, 1 otherwise. * `fill_nan(signal1, signal2 | double)` -- if signal1 is NaN, returns signal2 | double, else returns signal1. Here are a few examples of ranking formulas that use the supported ranking expression types: - `0.2 * semantic_similarity_score + 0.8 * log(keyword_similarity_score)` -- mostly rank by the logarithm of `keyword_similarity_score` with slight `semantic_smilarity_score` adjustment. - `0.2 * exp(fill_nan(semantic_similarity_score, 0)) + 0.3 * is_nan(keyword_similarity_score)` -- rank by the exponent of `semantic_similarity_score` filling the value with 0 if it's NaN, also add constant 0.3 adjustment to the final score if `semantic_similarity_score` is NaN. - `0.2 * rr(semantic_similarity_score, 16) + 0.8 * rr(keyword_similarity_score, 16)` -- mostly rank by the reciprocal rank of `keyword_similarity_score` with slight adjustment of reciprocal rank of `semantic_smilarity_score`. The following signals are supported: * `semantic_similarity_score`: semantic similarity adjustment that is calculated using the embeddings generated by a proprietary Google model. This score determines how semantically similar a search query is to a document. * `keyword_similarity_score`: keyword match adjustment uses the Best Match 25 (BM25) ranking function. This score is calculated using a probabilistic model to estimate the probability that a document is relevant to a given query. * `relevance_score`: semantic relevance adjustment that uses a proprietary Google model to determine the meaning and intent behind a user's query in context with the content in the documents. * `pctr_rank`: predicted conversion rate adjustment as a rank use predicted Click-through rate (pCTR) to gauge the relevance and attractiveness of a search result from a user's perspective. A higher pCTR suggests that the result is more likely to satisfy the user's query and intent, making it a valuable signal for ranking. * `freshness_rank`: freshness adjustment as a rank * `document_age`: The time in hours elapsed since the document was last updated, a floating-point number (e.g., 0.25 means 15 minutes). * `topicality_rank`: topicality adjustment as a rank. Uses proprietary Google model to determine the keyword-based overlap between the query and the document. * `base_rank`: the default rank of the result + "rankingExpression": "A String", # Optional. The ranking expression controls the customized ranking on retrieval documents. This overrides ServingConfig.ranking_expression. The syntax and supported features depend on the `ranking_expression_backend` value. If `ranking_expression_backend` is not provided, it defaults to `RANK_BY_EMBEDDING`. If ranking_expression_backend is not provided or set to `RANK_BY_EMBEDDING`, it should be a single function or multiple functions that are joined by "+". * ranking_expression = function, { " + ", function }; Supported functions: * double * relevance_score * double * dotProduct(embedding_field_path) Function variables: * `relevance_score`: pre-defined keywords, used for measure relevance between query and document. * `embedding_field_path`: the document embedding field used with query embedding vector. * `dotProduct`: embedding function between `embedding_field_path` and query embedding vector. Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`. If ranking_expression_backend is set to `RANK_BY_FORMULA`, the following expression types (and combinations of those chained using + or * operators) are supported: * `double` * `signal` * `log(signal)` * `exp(signal)` * `rr(signal, double > 0)` -- reciprocal rank transformation with second argument being a denominator constant. * `is_nan(signal)` -- returns 0 if signal is NaN, 1 otherwise. * `fill_nan(signal1, signal2 | double)` -- if signal1 is NaN, returns signal2 | double, else returns signal1. Here are a few examples of ranking formulas that use the supported ranking expression types: - `0.2 * semantic_similarity_score + 0.8 * log(keyword_similarity_score)` -- mostly rank by the logarithm of `keyword_similarity_score` with slight `semantic_smilarity_score` adjustment. - `0.2 * exp(fill_nan(semantic_similarity_score, 0)) + 0.3 * is_nan(keyword_similarity_score)` -- rank by the exponent of `semantic_similarity_score` filling the value with 0 if it's NaN, also add constant 0.3 adjustment to the final score if `semantic_similarity_score` is NaN. - `0.2 * rr(semantic_similarity_score, 16) + 0.8 * rr(keyword_similarity_score, 16)` -- mostly rank by the reciprocal rank of `keyword_similarity_score` with slight adjustment of reciprocal rank of `semantic_smilarity_score`. The following signals are supported: * `semantic_similarity_score`: semantic similarity adjustment that is calculated using the embeddings generated by a proprietary Google model. This score determines how semantically similar a search query is to a document. * `keyword_similarity_score`: keyword match adjustment uses the Best Match 25 (BM25) ranking function. This score is calculated using a probabilistic model to estimate the probability that a document is relevant to a given query. * `relevance_score`: semantic relevance adjustment that uses a proprietary Google model to determine the meaning and intent behind a user's query in context with the content in the documents. * `pctr_rank`: predicted conversion rate adjustment as a rank use predicted Click-through rate (pCTR) to gauge the relevance and attractiveness of a search result from a user's perspective. A higher pCTR suggests that the result is more likely to satisfy the user's query and intent, making it a valuable signal for ranking. * `freshness_rank`: freshness adjustment as a rank * `document_age`: The time in hours elapsed since the document was last updated, a floating-point number (e.g., 0.25 means 15 minutes). * `topicality_rank`: topicality adjustment as a rank. Uses proprietary Google model to determine the keyword-based overlap between the query and the document. * `base_rank`: the default rank of the result * `media_actor_match`: whether the media actor matches the query * `media_director_match`: whether the media director matches the query * `media_genre_match`: whether the media genre matches the query * `media_language_match`: whether the media language matches the query * `media_title_match`: whether the media title matches the query * `media_prefix_similarity_rank`: prefix similarity rank for media results * `media_semantic_similarity_rank`: semantic similarity rank for media results "rankingExpressionBackend": "A String", # Optional. The backend to use for the ranking expression evaluation. "regionCode": "A String", # The Unicode country/region code (CLDR) of a location, such as "US" and "419". For more information, see [Standard fields](https://cloud.google.com/apis/design/standard_fields). If set, then results will be boosted based on the region_code provided. "relevanceFilterSpec": { # Relevance filtering specification. # Optional. The granular relevance filtering specification. If not specified, the global `relevance_threshold` will be used for all sub-searches. If specified, this overrides the global `relevance_threshold` to use thresholds on a per sub-search basis. This feature is currently supported only for custom and site search. diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.sessions.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.sessions.html index 48bd594106..320507ca3d 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.sessions.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.sessions.html @@ -1132,7 +1132,7 @@

Method Details

Args: parent: string, Required. The data store resource name. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}` (required) filter: string, A comma-separated list of fields to filter by, in EBNF grammar. The supported fields are: * `user_pseudo_id` * `state` * `display_name` * `starred` * `is_pinned` * `labels` * `create_time` * `update_time` * `collaborative_project` Examples: * `user_pseudo_id = some_id` * `display_name = "some_name"` * `starred = true` * `is_pinned=true AND (NOT labels:hidden)` * `create_time > "1970-01-01T12:00:00Z"` * `collaborative_project = "projects/123/locations/global/collections/default_collection/engines/" "default_engine/collaborative_projects/cp1"` - orderBy: string, A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `update_time` * `create_time` * `session_name` * `is_pinned` Example: * `update_time desc` * `create_time` * `is_pinned desc,update_time desc`: list sessions by is_pinned first, then by update_time. + orderBy: string, A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `update_time` * `create_time` * `session_name` * `is_pinned` * `display_name` Example: * `update_time desc` * `create_time` * `is_pinned desc,update_time desc`: list sessions by is_pinned first, then by update_time. pageSize: integer, Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000. pageToken: string, A page token, received from a previous `ListSessions` call. Provide this to retrieve the subsequent page. x__xgafv: string, V1 error format. diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.assistants.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.assistants.html index 766e643d99..cba2c0de08 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.assistants.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.assistants.html @@ -713,6 +713,12 @@

Method Details

"invocationTools": [ # The tool names of the tools that were invoked. "A String", ], + "invokedSkills": [ # The skills executed during the turn. + { # Represents a skill used during the assist call. + "displayName": "A String", # The display name of the skill. + "name": "A String", # The resource name of the skill. + }, + ], "sessionInfo": { # Information about the session. # Session information. Only included in the final StreamAssistResponse of the response stream. "session": "A String", # Name of the newly generated or continued session. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}`. }, diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.servingConfigs.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.servingConfigs.html index 0248c7dfe3..df17bc5357 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.servingConfigs.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.servingConfigs.html @@ -2005,7 +2005,7 @@

Method Details

"condition": "A String", # The condition under which query expansion should occur. Default to Condition.DISABLED. "pinUnexpandedResults": True or False, # Whether to pin unexpanded results. If this field is set to true, unexpanded products are always at the top of the search results, followed by the expanded results. }, - "rankingExpression": "A String", # Optional. The ranking expression controls the customized ranking on retrieval documents. This overrides ServingConfig.ranking_expression. The syntax and supported features depend on the `ranking_expression_backend` value. If `ranking_expression_backend` is not provided, it defaults to `RANK_BY_EMBEDDING`. If ranking_expression_backend is not provided or set to `RANK_BY_EMBEDDING`, it should be a single function or multiple functions that are joined by "+". * ranking_expression = function, { " + ", function }; Supported functions: * double * relevance_score * double * dotProduct(embedding_field_path) Function variables: * `relevance_score`: pre-defined keywords, used for measure relevance between query and document. * `embedding_field_path`: the document embedding field used with query embedding vector. * `dotProduct`: embedding function between `embedding_field_path` and query embedding vector. Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`. If ranking_expression_backend is set to `RANK_BY_FORMULA`, the following expression types (and combinations of those chained using + or * operators) are supported: * `double` * `signal` * `log(signal)` * `exp(signal)` * `rr(signal, double > 0)` -- reciprocal rank transformation with second argument being a denominator constant. * `is_nan(signal)` -- returns 0 if signal is NaN, 1 otherwise. * `fill_nan(signal1, signal2 | double)` -- if signal1 is NaN, returns signal2 | double, else returns signal1. Here are a few examples of ranking formulas that use the supported ranking expression types: - `0.2 * semantic_similarity_score + 0.8 * log(keyword_similarity_score)` -- mostly rank by the logarithm of `keyword_similarity_score` with slight `semantic_smilarity_score` adjustment. - `0.2 * exp(fill_nan(semantic_similarity_score, 0)) + 0.3 * is_nan(keyword_similarity_score)` -- rank by the exponent of `semantic_similarity_score` filling the value with 0 if it's NaN, also add constant 0.3 adjustment to the final score if `semantic_similarity_score` is NaN. - `0.2 * rr(semantic_similarity_score, 16) + 0.8 * rr(keyword_similarity_score, 16)` -- mostly rank by the reciprocal rank of `keyword_similarity_score` with slight adjustment of reciprocal rank of `semantic_smilarity_score`. The following signals are supported: * `semantic_similarity_score`: semantic similarity adjustment that is calculated using the embeddings generated by a proprietary Google model. This score determines how semantically similar a search query is to a document. * `keyword_similarity_score`: keyword match adjustment uses the Best Match 25 (BM25) ranking function. This score is calculated using a probabilistic model to estimate the probability that a document is relevant to a given query. * `relevance_score`: semantic relevance adjustment that uses a proprietary Google model to determine the meaning and intent behind a user's query in context with the content in the documents. * `pctr_rank`: predicted conversion rate adjustment as a rank use predicted Click-through rate (pCTR) to gauge the relevance and attractiveness of a search result from a user's perspective. A higher pCTR suggests that the result is more likely to satisfy the user's query and intent, making it a valuable signal for ranking. * `freshness_rank`: freshness adjustment as a rank * `document_age`: The time in hours elapsed since the document was last updated, a floating-point number (e.g., 0.25 means 15 minutes). * `topicality_rank`: topicality adjustment as a rank. Uses proprietary Google model to determine the keyword-based overlap between the query and the document. * `base_rank`: the default rank of the result + "rankingExpression": "A String", # Optional. The ranking expression controls the customized ranking on retrieval documents. This overrides ServingConfig.ranking_expression. The syntax and supported features depend on the `ranking_expression_backend` value. If `ranking_expression_backend` is not provided, it defaults to `RANK_BY_EMBEDDING`. If ranking_expression_backend is not provided or set to `RANK_BY_EMBEDDING`, it should be a single function or multiple functions that are joined by "+". * ranking_expression = function, { " + ", function }; Supported functions: * double * relevance_score * double * dotProduct(embedding_field_path) Function variables: * `relevance_score`: pre-defined keywords, used for measure relevance between query and document. * `embedding_field_path`: the document embedding field used with query embedding vector. * `dotProduct`: embedding function between `embedding_field_path` and query embedding vector. Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`. If ranking_expression_backend is set to `RANK_BY_FORMULA`, the following expression types (and combinations of those chained using + or * operators) are supported: * `double` * `signal` * `log(signal)` * `exp(signal)` * `rr(signal, double > 0)` -- reciprocal rank transformation with second argument being a denominator constant. * `is_nan(signal)` -- returns 0 if signal is NaN, 1 otherwise. * `fill_nan(signal1, signal2 | double)` -- if signal1 is NaN, returns signal2 | double, else returns signal1. Here are a few examples of ranking formulas that use the supported ranking expression types: - `0.2 * semantic_similarity_score + 0.8 * log(keyword_similarity_score)` -- mostly rank by the logarithm of `keyword_similarity_score` with slight `semantic_smilarity_score` adjustment. - `0.2 * exp(fill_nan(semantic_similarity_score, 0)) + 0.3 * is_nan(keyword_similarity_score)` -- rank by the exponent of `semantic_similarity_score` filling the value with 0 if it's NaN, also add constant 0.3 adjustment to the final score if `semantic_similarity_score` is NaN. - `0.2 * rr(semantic_similarity_score, 16) + 0.8 * rr(keyword_similarity_score, 16)` -- mostly rank by the reciprocal rank of `keyword_similarity_score` with slight adjustment of reciprocal rank of `semantic_smilarity_score`. The following signals are supported: * `semantic_similarity_score`: semantic similarity adjustment that is calculated using the embeddings generated by a proprietary Google model. This score determines how semantically similar a search query is to a document. * `keyword_similarity_score`: keyword match adjustment uses the Best Match 25 (BM25) ranking function. This score is calculated using a probabilistic model to estimate the probability that a document is relevant to a given query. * `relevance_score`: semantic relevance adjustment that uses a proprietary Google model to determine the meaning and intent behind a user's query in context with the content in the documents. * `pctr_rank`: predicted conversion rate adjustment as a rank use predicted Click-through rate (pCTR) to gauge the relevance and attractiveness of a search result from a user's perspective. A higher pCTR suggests that the result is more likely to satisfy the user's query and intent, making it a valuable signal for ranking. * `freshness_rank`: freshness adjustment as a rank * `document_age`: The time in hours elapsed since the document was last updated, a floating-point number (e.g., 0.25 means 15 minutes). * `topicality_rank`: topicality adjustment as a rank. Uses proprietary Google model to determine the keyword-based overlap between the query and the document. * `base_rank`: the default rank of the result * `media_actor_match`: whether the media actor matches the query * `media_director_match`: whether the media director matches the query * `media_genre_match`: whether the media genre matches the query * `media_language_match`: whether the media language matches the query * `media_title_match`: whether the media title matches the query * `media_prefix_similarity_rank`: prefix similarity rank for media results * `media_semantic_similarity_rank`: semantic similarity rank for media results "rankingExpressionBackend": "A String", # Optional. The backend to use for the ranking expression evaluation. "regionCode": "A String", # The Unicode country/region code (CLDR) of a location, such as "US" and "419". For more information, see [Standard fields](https://cloud.google.com/apis/design/standard_fields). If set, then results will be boosted based on the region_code provided. "relevanceFilterSpec": { # Relevance filtering specification. # Optional. The granular relevance filtering specification. If not specified, the global `relevance_threshold` will be used for all sub-searches. If specified, this overrides the global `relevance_threshold` to use thresholds on a per sub-search basis. This feature is currently supported only for custom and site search. @@ -2672,7 +2672,7 @@

Method Details

"condition": "A String", # The condition under which query expansion should occur. Default to Condition.DISABLED. "pinUnexpandedResults": True or False, # Whether to pin unexpanded results. If this field is set to true, unexpanded products are always at the top of the search results, followed by the expanded results. }, - "rankingExpression": "A String", # Optional. The ranking expression controls the customized ranking on retrieval documents. This overrides ServingConfig.ranking_expression. The syntax and supported features depend on the `ranking_expression_backend` value. If `ranking_expression_backend` is not provided, it defaults to `RANK_BY_EMBEDDING`. If ranking_expression_backend is not provided or set to `RANK_BY_EMBEDDING`, it should be a single function or multiple functions that are joined by "+". * ranking_expression = function, { " + ", function }; Supported functions: * double * relevance_score * double * dotProduct(embedding_field_path) Function variables: * `relevance_score`: pre-defined keywords, used for measure relevance between query and document. * `embedding_field_path`: the document embedding field used with query embedding vector. * `dotProduct`: embedding function between `embedding_field_path` and query embedding vector. Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`. If ranking_expression_backend is set to `RANK_BY_FORMULA`, the following expression types (and combinations of those chained using + or * operators) are supported: * `double` * `signal` * `log(signal)` * `exp(signal)` * `rr(signal, double > 0)` -- reciprocal rank transformation with second argument being a denominator constant. * `is_nan(signal)` -- returns 0 if signal is NaN, 1 otherwise. * `fill_nan(signal1, signal2 | double)` -- if signal1 is NaN, returns signal2 | double, else returns signal1. Here are a few examples of ranking formulas that use the supported ranking expression types: - `0.2 * semantic_similarity_score + 0.8 * log(keyword_similarity_score)` -- mostly rank by the logarithm of `keyword_similarity_score` with slight `semantic_smilarity_score` adjustment. - `0.2 * exp(fill_nan(semantic_similarity_score, 0)) + 0.3 * is_nan(keyword_similarity_score)` -- rank by the exponent of `semantic_similarity_score` filling the value with 0 if it's NaN, also add constant 0.3 adjustment to the final score if `semantic_similarity_score` is NaN. - `0.2 * rr(semantic_similarity_score, 16) + 0.8 * rr(keyword_similarity_score, 16)` -- mostly rank by the reciprocal rank of `keyword_similarity_score` with slight adjustment of reciprocal rank of `semantic_smilarity_score`. The following signals are supported: * `semantic_similarity_score`: semantic similarity adjustment that is calculated using the embeddings generated by a proprietary Google model. This score determines how semantically similar a search query is to a document. * `keyword_similarity_score`: keyword match adjustment uses the Best Match 25 (BM25) ranking function. This score is calculated using a probabilistic model to estimate the probability that a document is relevant to a given query. * `relevance_score`: semantic relevance adjustment that uses a proprietary Google model to determine the meaning and intent behind a user's query in context with the content in the documents. * `pctr_rank`: predicted conversion rate adjustment as a rank use predicted Click-through rate (pCTR) to gauge the relevance and attractiveness of a search result from a user's perspective. A higher pCTR suggests that the result is more likely to satisfy the user's query and intent, making it a valuable signal for ranking. * `freshness_rank`: freshness adjustment as a rank * `document_age`: The time in hours elapsed since the document was last updated, a floating-point number (e.g., 0.25 means 15 minutes). * `topicality_rank`: topicality adjustment as a rank. Uses proprietary Google model to determine the keyword-based overlap between the query and the document. * `base_rank`: the default rank of the result + "rankingExpression": "A String", # Optional. The ranking expression controls the customized ranking on retrieval documents. This overrides ServingConfig.ranking_expression. The syntax and supported features depend on the `ranking_expression_backend` value. If `ranking_expression_backend` is not provided, it defaults to `RANK_BY_EMBEDDING`. If ranking_expression_backend is not provided or set to `RANK_BY_EMBEDDING`, it should be a single function or multiple functions that are joined by "+". * ranking_expression = function, { " + ", function }; Supported functions: * double * relevance_score * double * dotProduct(embedding_field_path) Function variables: * `relevance_score`: pre-defined keywords, used for measure relevance between query and document. * `embedding_field_path`: the document embedding field used with query embedding vector. * `dotProduct`: embedding function between `embedding_field_path` and query embedding vector. Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`. If ranking_expression_backend is set to `RANK_BY_FORMULA`, the following expression types (and combinations of those chained using + or * operators) are supported: * `double` * `signal` * `log(signal)` * `exp(signal)` * `rr(signal, double > 0)` -- reciprocal rank transformation with second argument being a denominator constant. * `is_nan(signal)` -- returns 0 if signal is NaN, 1 otherwise. * `fill_nan(signal1, signal2 | double)` -- if signal1 is NaN, returns signal2 | double, else returns signal1. Here are a few examples of ranking formulas that use the supported ranking expression types: - `0.2 * semantic_similarity_score + 0.8 * log(keyword_similarity_score)` -- mostly rank by the logarithm of `keyword_similarity_score` with slight `semantic_smilarity_score` adjustment. - `0.2 * exp(fill_nan(semantic_similarity_score, 0)) + 0.3 * is_nan(keyword_similarity_score)` -- rank by the exponent of `semantic_similarity_score` filling the value with 0 if it's NaN, also add constant 0.3 adjustment to the final score if `semantic_similarity_score` is NaN. - `0.2 * rr(semantic_similarity_score, 16) + 0.8 * rr(keyword_similarity_score, 16)` -- mostly rank by the reciprocal rank of `keyword_similarity_score` with slight adjustment of reciprocal rank of `semantic_smilarity_score`. The following signals are supported: * `semantic_similarity_score`: semantic similarity adjustment that is calculated using the embeddings generated by a proprietary Google model. This score determines how semantically similar a search query is to a document. * `keyword_similarity_score`: keyword match adjustment uses the Best Match 25 (BM25) ranking function. This score is calculated using a probabilistic model to estimate the probability that a document is relevant to a given query. * `relevance_score`: semantic relevance adjustment that uses a proprietary Google model to determine the meaning and intent behind a user's query in context with the content in the documents. * `pctr_rank`: predicted conversion rate adjustment as a rank use predicted Click-through rate (pCTR) to gauge the relevance and attractiveness of a search result from a user's perspective. A higher pCTR suggests that the result is more likely to satisfy the user's query and intent, making it a valuable signal for ranking. * `freshness_rank`: freshness adjustment as a rank * `document_age`: The time in hours elapsed since the document was last updated, a floating-point number (e.g., 0.25 means 15 minutes). * `topicality_rank`: topicality adjustment as a rank. Uses proprietary Google model to determine the keyword-based overlap between the query and the document. * `base_rank`: the default rank of the result * `media_actor_match`: whether the media actor matches the query * `media_director_match`: whether the media director matches the query * `media_genre_match`: whether the media genre matches the query * `media_language_match`: whether the media language matches the query * `media_title_match`: whether the media title matches the query * `media_prefix_similarity_rank`: prefix similarity rank for media results * `media_semantic_similarity_rank`: semantic similarity rank for media results "rankingExpressionBackend": "A String", # Optional. The backend to use for the ranking expression evaluation. "regionCode": "A String", # The Unicode country/region code (CLDR) of a location, such as "US" and "419". For more information, see [Standard fields](https://cloud.google.com/apis/design/standard_fields). If set, then results will be boosted based on the region_code provided. "relevanceFilterSpec": { # Relevance filtering specification. # Optional. The granular relevance filtering specification. If not specified, the global `relevance_threshold` will be used for all sub-searches. If specified, this overrides the global `relevance_threshold` to use thresholds on a per sub-search basis. This feature is currently supported only for custom and site search. diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.sessions.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.sessions.html index 3852f26d2a..6a149770db 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.sessions.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.sessions.html @@ -1147,7 +1147,7 @@

Method Details

Args: parent: string, Required. The data store resource name. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}` (required) filter: string, A comma-separated list of fields to filter by, in EBNF grammar. The supported fields are: * `user_pseudo_id` * `state` * `display_name` * `starred` * `is_pinned` * `labels` * `create_time` * `update_time` * `collaborative_project` Examples: * `user_pseudo_id = some_id` * `display_name = "some_name"` * `starred = true` * `is_pinned=true AND (NOT labels:hidden)` * `create_time > "1970-01-01T12:00:00Z"` * `collaborative_project = "projects/123/locations/global/collections/default_collection/engines/" "default_engine/collaborative_projects/cp1"` - orderBy: string, A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `update_time` * `create_time` * `session_name` * `is_pinned` Example: * `update_time desc` * `create_time` * `is_pinned desc,update_time desc`: list sessions by is_pinned first, then by update_time. + orderBy: string, A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `update_time` * `create_time` * `session_name` * `is_pinned` * `display_name` Example: * `update_time desc` * `create_time` * `is_pinned desc,update_time desc`: list sessions by is_pinned first, then by update_time. pageSize: integer, Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000. pageToken: string, A page token, received from a previous `ListSessions` call. Provide this to retrieve the subsequent page. x__xgafv: string, V1 error format. diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.html index 253deadaa9..0db4064b33 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.html @@ -312,7 +312,7 @@

Method Details

"schemaOrgPaths": [ # Field paths for indexing custom attribute from schema.org data. More details of schema.org and its defined types can be found at [schema.org](https://schema.org). It is only used on advanced site search schema. Currently only support full path from root. The full path to a field is constructed by concatenating field names, starting from `_root`, with a period `.` as the delimiter. Examples: * Publish date of the root: _root.datePublished * Publish date of the reviews: _root.review.datePublished "A String", ], - "searchableFieldImportance": "A String", # Optional. Specifies the importance of the field when `searchable_option` is `SEARCHABLE_ENABLED`. If `searchable_option` is `SEARCHABLE_DISABLED`, this field is ignored. If `searchable_option` is `SEARCHABLE_ENABLED` and this is `SEARCHABLE_FIELD_IMPORTANCE_UNSPECIFIED`, it behaves as `DEFAULT_IMPORTANCE`. + "searchableFieldImportance": "A String", # Optional. Specifies the importance of the field when `searchable_option` is `SEARCHABLE_ENABLED`. If `searchable_option` is `SEARCHABLE_DISABLED`, this field is ignored. If `searchable_option` is `SEARCHABLE_ENABLED` and this is `SEARCHABLE_FIELD_IMPORTANCE_UNSPECIFIED`, it behaves as `DEFAULT_IMPORTANCE`. For more information, see [Weight searchable fields](https://cloud.google.com/generative-ai-app-builder/docs/configure-field-settings#weight-search). "searchableOption": "A String", # If searchable_option is SEARCHABLE_ENABLED, field values are searchable by text queries in SearchService.Search. If SEARCHABLE_ENABLED but field type is numerical, field values will not be searchable by text queries in SearchService.Search, as there are no text values associated to numerical fields. If searchable_option is unset, the server behavior defaults to SEARCHABLE_DISABLED for fields that support setting searchable options. Only `string` fields that have no key property mapping support setting searchable_option. For those fields that do not support setting searchable options, the server will skip searchable option setting, and setting searchable_option for those fields will throw `INVALID_ARGUMENT` error. }, ], @@ -574,7 +574,7 @@

Method Details

"schemaOrgPaths": [ # Field paths for indexing custom attribute from schema.org data. More details of schema.org and its defined types can be found at [schema.org](https://schema.org). It is only used on advanced site search schema. Currently only support full path from root. The full path to a field is constructed by concatenating field names, starting from `_root`, with a period `.` as the delimiter. Examples: * Publish date of the root: _root.datePublished * Publish date of the reviews: _root.review.datePublished "A String", ], - "searchableFieldImportance": "A String", # Optional. Specifies the importance of the field when `searchable_option` is `SEARCHABLE_ENABLED`. If `searchable_option` is `SEARCHABLE_DISABLED`, this field is ignored. If `searchable_option` is `SEARCHABLE_ENABLED` and this is `SEARCHABLE_FIELD_IMPORTANCE_UNSPECIFIED`, it behaves as `DEFAULT_IMPORTANCE`. + "searchableFieldImportance": "A String", # Optional. Specifies the importance of the field when `searchable_option` is `SEARCHABLE_ENABLED`. If `searchable_option` is `SEARCHABLE_DISABLED`, this field is ignored. If `searchable_option` is `SEARCHABLE_ENABLED` and this is `SEARCHABLE_FIELD_IMPORTANCE_UNSPECIFIED`, it behaves as `DEFAULT_IMPORTANCE`. For more information, see [Weight searchable fields](https://cloud.google.com/generative-ai-app-builder/docs/configure-field-settings#weight-search). "searchableOption": "A String", # If searchable_option is SEARCHABLE_ENABLED, field values are searchable by text queries in SearchService.Search. If SEARCHABLE_ENABLED but field type is numerical, field values will not be searchable by text queries in SearchService.Search, as there are no text values associated to numerical fields. If searchable_option is unset, the server behavior defaults to SEARCHABLE_DISABLED for fields that support setting searchable options. Only `string` fields that have no key property mapping support setting searchable_option. For those fields that do not support setting searchable options, the server will skip searchable option setting, and setting searchable_option for those fields will throw `INVALID_ARGUMENT` error. }, ], @@ -840,7 +840,7 @@

Method Details

"schemaOrgPaths": [ # Field paths for indexing custom attribute from schema.org data. More details of schema.org and its defined types can be found at [schema.org](https://schema.org). It is only used on advanced site search schema. Currently only support full path from root. The full path to a field is constructed by concatenating field names, starting from `_root`, with a period `.` as the delimiter. Examples: * Publish date of the root: _root.datePublished * Publish date of the reviews: _root.review.datePublished "A String", ], - "searchableFieldImportance": "A String", # Optional. Specifies the importance of the field when `searchable_option` is `SEARCHABLE_ENABLED`. If `searchable_option` is `SEARCHABLE_DISABLED`, this field is ignored. If `searchable_option` is `SEARCHABLE_ENABLED` and this is `SEARCHABLE_FIELD_IMPORTANCE_UNSPECIFIED`, it behaves as `DEFAULT_IMPORTANCE`. + "searchableFieldImportance": "A String", # Optional. Specifies the importance of the field when `searchable_option` is `SEARCHABLE_ENABLED`. If `searchable_option` is `SEARCHABLE_DISABLED`, this field is ignored. If `searchable_option` is `SEARCHABLE_ENABLED` and this is `SEARCHABLE_FIELD_IMPORTANCE_UNSPECIFIED`, it behaves as `DEFAULT_IMPORTANCE`. For more information, see [Weight searchable fields](https://cloud.google.com/generative-ai-app-builder/docs/configure-field-settings#weight-search). "searchableOption": "A String", # If searchable_option is SEARCHABLE_ENABLED, field values are searchable by text queries in SearchService.Search. If SEARCHABLE_ENABLED but field type is numerical, field values will not be searchable by text queries in SearchService.Search, as there are no text values associated to numerical fields. If searchable_option is unset, the server behavior defaults to SEARCHABLE_DISABLED for fields that support setting searchable options. Only `string` fields that have no key property mapping support setting searchable_option. For those fields that do not support setting searchable options, the server will skip searchable option setting, and setting searchable_option for those fields will throw `INVALID_ARGUMENT` error. }, ], @@ -1116,7 +1116,7 @@

Method Details

"schemaOrgPaths": [ # Field paths for indexing custom attribute from schema.org data. More details of schema.org and its defined types can be found at [schema.org](https://schema.org). It is only used on advanced site search schema. Currently only support full path from root. The full path to a field is constructed by concatenating field names, starting from `_root`, with a period `.` as the delimiter. Examples: * Publish date of the root: _root.datePublished * Publish date of the reviews: _root.review.datePublished "A String", ], - "searchableFieldImportance": "A String", # Optional. Specifies the importance of the field when `searchable_option` is `SEARCHABLE_ENABLED`. If `searchable_option` is `SEARCHABLE_DISABLED`, this field is ignored. If `searchable_option` is `SEARCHABLE_ENABLED` and this is `SEARCHABLE_FIELD_IMPORTANCE_UNSPECIFIED`, it behaves as `DEFAULT_IMPORTANCE`. + "searchableFieldImportance": "A String", # Optional. Specifies the importance of the field when `searchable_option` is `SEARCHABLE_ENABLED`. If `searchable_option` is `SEARCHABLE_DISABLED`, this field is ignored. If `searchable_option` is `SEARCHABLE_ENABLED` and this is `SEARCHABLE_FIELD_IMPORTANCE_UNSPECIFIED`, it behaves as `DEFAULT_IMPORTANCE`. For more information, see [Weight searchable fields](https://cloud.google.com/generative-ai-app-builder/docs/configure-field-settings#weight-search). "searchableOption": "A String", # If searchable_option is SEARCHABLE_ENABLED, field values are searchable by text queries in SearchService.Search. If SEARCHABLE_ENABLED but field type is numerical, field values will not be searchable by text queries in SearchService.Search, as there are no text values associated to numerical fields. If searchable_option is unset, the server behavior defaults to SEARCHABLE_DISABLED for fields that support setting searchable options. Only `string` fields that have no key property mapping support setting searchable_option. For those fields that do not support setting searchable options, the server will skip searchable option setting, and setting searchable_option for those fields will throw `INVALID_ARGUMENT` error. }, ], @@ -1402,7 +1402,7 @@

Method Details

"schemaOrgPaths": [ # Field paths for indexing custom attribute from schema.org data. More details of schema.org and its defined types can be found at [schema.org](https://schema.org). It is only used on advanced site search schema. Currently only support full path from root. The full path to a field is constructed by concatenating field names, starting from `_root`, with a period `.` as the delimiter. Examples: * Publish date of the root: _root.datePublished * Publish date of the reviews: _root.review.datePublished "A String", ], - "searchableFieldImportance": "A String", # Optional. Specifies the importance of the field when `searchable_option` is `SEARCHABLE_ENABLED`. If `searchable_option` is `SEARCHABLE_DISABLED`, this field is ignored. If `searchable_option` is `SEARCHABLE_ENABLED` and this is `SEARCHABLE_FIELD_IMPORTANCE_UNSPECIFIED`, it behaves as `DEFAULT_IMPORTANCE`. + "searchableFieldImportance": "A String", # Optional. Specifies the importance of the field when `searchable_option` is `SEARCHABLE_ENABLED`. If `searchable_option` is `SEARCHABLE_DISABLED`, this field is ignored. If `searchable_option` is `SEARCHABLE_ENABLED` and this is `SEARCHABLE_FIELD_IMPORTANCE_UNSPECIFIED`, it behaves as `DEFAULT_IMPORTANCE`. For more information, see [Weight searchable fields](https://cloud.google.com/generative-ai-app-builder/docs/configure-field-settings#weight-search). "searchableOption": "A String", # If searchable_option is SEARCHABLE_ENABLED, field values are searchable by text queries in SearchService.Search. If SEARCHABLE_ENABLED but field type is numerical, field values will not be searchable by text queries in SearchService.Search, as there are no text values associated to numerical fields. If searchable_option is unset, the server behavior defaults to SEARCHABLE_DISABLED for fields that support setting searchable options. Only `string` fields that have no key property mapping support setting searchable_option. For those fields that do not support setting searchable options, the server will skip searchable option setting, and setting searchable_option for those fields will throw `INVALID_ARGUMENT` error. }, ], @@ -1655,7 +1655,7 @@

Method Details

"schemaOrgPaths": [ # Field paths for indexing custom attribute from schema.org data. More details of schema.org and its defined types can be found at [schema.org](https://schema.org). It is only used on advanced site search schema. Currently only support full path from root. The full path to a field is constructed by concatenating field names, starting from `_root`, with a period `.` as the delimiter. Examples: * Publish date of the root: _root.datePublished * Publish date of the reviews: _root.review.datePublished "A String", ], - "searchableFieldImportance": "A String", # Optional. Specifies the importance of the field when `searchable_option` is `SEARCHABLE_ENABLED`. If `searchable_option` is `SEARCHABLE_DISABLED`, this field is ignored. If `searchable_option` is `SEARCHABLE_ENABLED` and this is `SEARCHABLE_FIELD_IMPORTANCE_UNSPECIFIED`, it behaves as `DEFAULT_IMPORTANCE`. + "searchableFieldImportance": "A String", # Optional. Specifies the importance of the field when `searchable_option` is `SEARCHABLE_ENABLED`. If `searchable_option` is `SEARCHABLE_DISABLED`, this field is ignored. If `searchable_option` is `SEARCHABLE_ENABLED` and this is `SEARCHABLE_FIELD_IMPORTANCE_UNSPECIFIED`, it behaves as `DEFAULT_IMPORTANCE`. For more information, see [Weight searchable fields](https://cloud.google.com/generative-ai-app-builder/docs/configure-field-settings#weight-search). "searchableOption": "A String", # If searchable_option is SEARCHABLE_ENABLED, field values are searchable by text queries in SearchService.Search. If SEARCHABLE_ENABLED but field type is numerical, field values will not be searchable by text queries in SearchService.Search, as there are no text values associated to numerical fields. If searchable_option is unset, the server behavior defaults to SEARCHABLE_DISABLED for fields that support setting searchable options. Only `string` fields that have no key property mapping support setting searchable_option. For those fields that do not support setting searchable options, the server will skip searchable option setting, and setting searchable_option for those fields will throw `INVALID_ARGUMENT` error. }, ], diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.html index e24820a542..403daef685 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.html @@ -462,7 +462,7 @@

Method Details

"schemaOrgPaths": [ # Field paths for indexing custom attribute from schema.org data. More details of schema.org and its defined types can be found at [schema.org](https://schema.org). It is only used on advanced site search schema. Currently only support full path from root. The full path to a field is constructed by concatenating field names, starting from `_root`, with a period `.` as the delimiter. Examples: * Publish date of the root: _root.datePublished * Publish date of the reviews: _root.review.datePublished "A String", ], - "searchableFieldImportance": "A String", # Optional. Specifies the importance of the field when `searchable_option` is `SEARCHABLE_ENABLED`. If `searchable_option` is `SEARCHABLE_DISABLED`, this field is ignored. If `searchable_option` is `SEARCHABLE_ENABLED` and this is `SEARCHABLE_FIELD_IMPORTANCE_UNSPECIFIED`, it behaves as `DEFAULT_IMPORTANCE`. + "searchableFieldImportance": "A String", # Optional. Specifies the importance of the field when `searchable_option` is `SEARCHABLE_ENABLED`. If `searchable_option` is `SEARCHABLE_DISABLED`, this field is ignored. If `searchable_option` is `SEARCHABLE_ENABLED` and this is `SEARCHABLE_FIELD_IMPORTANCE_UNSPECIFIED`, it behaves as `DEFAULT_IMPORTANCE`. For more information, see [Weight searchable fields](https://cloud.google.com/generative-ai-app-builder/docs/configure-field-settings#weight-search). "searchableOption": "A String", # If searchable_option is SEARCHABLE_ENABLED, field values are searchable by text queries in SearchService.Search. If SEARCHABLE_ENABLED but field type is numerical, field values will not be searchable by text queries in SearchService.Search, as there are no text values associated to numerical fields. If searchable_option is unset, the server behavior defaults to SEARCHABLE_DISABLED for fields that support setting searchable options. Only `string` fields that have no key property mapping support setting searchable_option. For those fields that do not support setting searchable options, the server will skip searchable option setting, and setting searchable_option for those fields will throw `INVALID_ARGUMENT` error. }, ], @@ -473,7 +473,7 @@

Method Details

}, }, "workspaceConfig": { # Config to store data store type configuration for workspace data # Config to store data store type configuration for workspace data. This must be set when DataStore.content_config is set as DataStore.ContentConfig.GOOGLE_WORKSPACE. - "dasherCustomerId": "A String", # Obfuscated Dasher customer ID. + "dasherCustomerId": "A String", # Output only. Obfuscated Dasher customer ID. Derived by the server from the project's GCP organization at data store creation time; any value supplied in the request payload is ignored. "superAdminEmailAddress": "A String", # Optional. The super admin email address for the workspace that will be used for access token generation. For now we only use it for Native Google Drive connector data ingestion. "superAdminServiceAccount": "A String", # Optional. The super admin service account for the workspace that will be used for access token generation. For now we only use it for Native Google Drive connector data ingestion. "type": "A String", # The Google Workspace data source. @@ -787,7 +787,7 @@

Method Details

"schemaOrgPaths": [ # Field paths for indexing custom attribute from schema.org data. More details of schema.org and its defined types can be found at [schema.org](https://schema.org). It is only used on advanced site search schema. Currently only support full path from root. The full path to a field is constructed by concatenating field names, starting from `_root`, with a period `.` as the delimiter. Examples: * Publish date of the root: _root.datePublished * Publish date of the reviews: _root.review.datePublished "A String", ], - "searchableFieldImportance": "A String", # Optional. Specifies the importance of the field when `searchable_option` is `SEARCHABLE_ENABLED`. If `searchable_option` is `SEARCHABLE_DISABLED`, this field is ignored. If `searchable_option` is `SEARCHABLE_ENABLED` and this is `SEARCHABLE_FIELD_IMPORTANCE_UNSPECIFIED`, it behaves as `DEFAULT_IMPORTANCE`. + "searchableFieldImportance": "A String", # Optional. Specifies the importance of the field when `searchable_option` is `SEARCHABLE_ENABLED`. If `searchable_option` is `SEARCHABLE_DISABLED`, this field is ignored. If `searchable_option` is `SEARCHABLE_ENABLED` and this is `SEARCHABLE_FIELD_IMPORTANCE_UNSPECIFIED`, it behaves as `DEFAULT_IMPORTANCE`. For more information, see [Weight searchable fields](https://cloud.google.com/generative-ai-app-builder/docs/configure-field-settings#weight-search). "searchableOption": "A String", # If searchable_option is SEARCHABLE_ENABLED, field values are searchable by text queries in SearchService.Search. If SEARCHABLE_ENABLED but field type is numerical, field values will not be searchable by text queries in SearchService.Search, as there are no text values associated to numerical fields. If searchable_option is unset, the server behavior defaults to SEARCHABLE_DISABLED for fields that support setting searchable options. Only `string` fields that have no key property mapping support setting searchable_option. For those fields that do not support setting searchable options, the server will skip searchable option setting, and setting searchable_option for those fields will throw `INVALID_ARGUMENT` error. }, ], @@ -798,7 +798,7 @@

Method Details

}, }, "workspaceConfig": { # Config to store data store type configuration for workspace data # Config to store data store type configuration for workspace data. This must be set when DataStore.content_config is set as DataStore.ContentConfig.GOOGLE_WORKSPACE. - "dasherCustomerId": "A String", # Obfuscated Dasher customer ID. + "dasherCustomerId": "A String", # Output only. Obfuscated Dasher customer ID. Derived by the server from the project's GCP organization at data store creation time; any value supplied in the request payload is ignored. "superAdminEmailAddress": "A String", # Optional. The super admin email address for the workspace that will be used for access token generation. For now we only use it for Native Google Drive connector data ingestion. "superAdminServiceAccount": "A String", # Optional. The super admin service account for the workspace that will be used for access token generation. For now we only use it for Native Google Drive connector data ingestion. "type": "A String", # The Google Workspace data source. @@ -1109,7 +1109,7 @@

Method Details

"schemaOrgPaths": [ # Field paths for indexing custom attribute from schema.org data. More details of schema.org and its defined types can be found at [schema.org](https://schema.org). It is only used on advanced site search schema. Currently only support full path from root. The full path to a field is constructed by concatenating field names, starting from `_root`, with a period `.` as the delimiter. Examples: * Publish date of the root: _root.datePublished * Publish date of the reviews: _root.review.datePublished "A String", ], - "searchableFieldImportance": "A String", # Optional. Specifies the importance of the field when `searchable_option` is `SEARCHABLE_ENABLED`. If `searchable_option` is `SEARCHABLE_DISABLED`, this field is ignored. If `searchable_option` is `SEARCHABLE_ENABLED` and this is `SEARCHABLE_FIELD_IMPORTANCE_UNSPECIFIED`, it behaves as `DEFAULT_IMPORTANCE`. + "searchableFieldImportance": "A String", # Optional. Specifies the importance of the field when `searchable_option` is `SEARCHABLE_ENABLED`. If `searchable_option` is `SEARCHABLE_DISABLED`, this field is ignored. If `searchable_option` is `SEARCHABLE_ENABLED` and this is `SEARCHABLE_FIELD_IMPORTANCE_UNSPECIFIED`, it behaves as `DEFAULT_IMPORTANCE`. For more information, see [Weight searchable fields](https://cloud.google.com/generative-ai-app-builder/docs/configure-field-settings#weight-search). "searchableOption": "A String", # If searchable_option is SEARCHABLE_ENABLED, field values are searchable by text queries in SearchService.Search. If SEARCHABLE_ENABLED but field type is numerical, field values will not be searchable by text queries in SearchService.Search, as there are no text values associated to numerical fields. If searchable_option is unset, the server behavior defaults to SEARCHABLE_DISABLED for fields that support setting searchable options. Only `string` fields that have no key property mapping support setting searchable_option. For those fields that do not support setting searchable options, the server will skip searchable option setting, and setting searchable_option for those fields will throw `INVALID_ARGUMENT` error. }, ], @@ -1120,7 +1120,7 @@

Method Details

}, }, "workspaceConfig": { # Config to store data store type configuration for workspace data # Config to store data store type configuration for workspace data. This must be set when DataStore.content_config is set as DataStore.ContentConfig.GOOGLE_WORKSPACE. - "dasherCustomerId": "A String", # Obfuscated Dasher customer ID. + "dasherCustomerId": "A String", # Output only. Obfuscated Dasher customer ID. Derived by the server from the project's GCP organization at data store creation time; any value supplied in the request payload is ignored. "superAdminEmailAddress": "A String", # Optional. The super admin email address for the workspace that will be used for access token generation. For now we only use it for Native Google Drive connector data ingestion. "superAdminServiceAccount": "A String", # Optional. The super admin service account for the workspace that will be used for access token generation. For now we only use it for Native Google Drive connector data ingestion. "type": "A String", # The Google Workspace data source. @@ -1336,7 +1336,7 @@

Method Details

"schemaOrgPaths": [ # Field paths for indexing custom attribute from schema.org data. More details of schema.org and its defined types can be found at [schema.org](https://schema.org). It is only used on advanced site search schema. Currently only support full path from root. The full path to a field is constructed by concatenating field names, starting from `_root`, with a period `.` as the delimiter. Examples: * Publish date of the root: _root.datePublished * Publish date of the reviews: _root.review.datePublished "A String", ], - "searchableFieldImportance": "A String", # Optional. Specifies the importance of the field when `searchable_option` is `SEARCHABLE_ENABLED`. If `searchable_option` is `SEARCHABLE_DISABLED`, this field is ignored. If `searchable_option` is `SEARCHABLE_ENABLED` and this is `SEARCHABLE_FIELD_IMPORTANCE_UNSPECIFIED`, it behaves as `DEFAULT_IMPORTANCE`. + "searchableFieldImportance": "A String", # Optional. Specifies the importance of the field when `searchable_option` is `SEARCHABLE_ENABLED`. If `searchable_option` is `SEARCHABLE_DISABLED`, this field is ignored. If `searchable_option` is `SEARCHABLE_ENABLED` and this is `SEARCHABLE_FIELD_IMPORTANCE_UNSPECIFIED`, it behaves as `DEFAULT_IMPORTANCE`. For more information, see [Weight searchable fields](https://cloud.google.com/generative-ai-app-builder/docs/configure-field-settings#weight-search). "searchableOption": "A String", # If searchable_option is SEARCHABLE_ENABLED, field values are searchable by text queries in SearchService.Search. If SEARCHABLE_ENABLED but field type is numerical, field values will not be searchable by text queries in SearchService.Search, as there are no text values associated to numerical fields. If searchable_option is unset, the server behavior defaults to SEARCHABLE_DISABLED for fields that support setting searchable options. Only `string` fields that have no key property mapping support setting searchable_option. For those fields that do not support setting searchable options, the server will skip searchable option setting, and setting searchable_option for those fields will throw `INVALID_ARGUMENT` error. }, ], @@ -1347,7 +1347,7 @@

Method Details

}, }, "workspaceConfig": { # Config to store data store type configuration for workspace data # Config to store data store type configuration for workspace data. This must be set when DataStore.content_config is set as DataStore.ContentConfig.GOOGLE_WORKSPACE. - "dasherCustomerId": "A String", # Obfuscated Dasher customer ID. + "dasherCustomerId": "A String", # Output only. Obfuscated Dasher customer ID. Derived by the server from the project's GCP organization at data store creation time; any value supplied in the request payload is ignored. "superAdminEmailAddress": "A String", # Optional. The super admin email address for the workspace that will be used for access token generation. For now we only use it for Native Google Drive connector data ingestion. "superAdminServiceAccount": "A String", # Optional. The super admin service account for the workspace that will be used for access token generation. For now we only use it for Native Google Drive connector data ingestion. "type": "A String", # The Google Workspace data source. @@ -1545,7 +1545,7 @@

Method Details

"schemaOrgPaths": [ # Field paths for indexing custom attribute from schema.org data. More details of schema.org and its defined types can be found at [schema.org](https://schema.org). It is only used on advanced site search schema. Currently only support full path from root. The full path to a field is constructed by concatenating field names, starting from `_root`, with a period `.` as the delimiter. Examples: * Publish date of the root: _root.datePublished * Publish date of the reviews: _root.review.datePublished "A String", ], - "searchableFieldImportance": "A String", # Optional. Specifies the importance of the field when `searchable_option` is `SEARCHABLE_ENABLED`. If `searchable_option` is `SEARCHABLE_DISABLED`, this field is ignored. If `searchable_option` is `SEARCHABLE_ENABLED` and this is `SEARCHABLE_FIELD_IMPORTANCE_UNSPECIFIED`, it behaves as `DEFAULT_IMPORTANCE`. + "searchableFieldImportance": "A String", # Optional. Specifies the importance of the field when `searchable_option` is `SEARCHABLE_ENABLED`. If `searchable_option` is `SEARCHABLE_DISABLED`, this field is ignored. If `searchable_option` is `SEARCHABLE_ENABLED` and this is `SEARCHABLE_FIELD_IMPORTANCE_UNSPECIFIED`, it behaves as `DEFAULT_IMPORTANCE`. For more information, see [Weight searchable fields](https://cloud.google.com/generative-ai-app-builder/docs/configure-field-settings#weight-search). "searchableOption": "A String", # If searchable_option is SEARCHABLE_ENABLED, field values are searchable by text queries in SearchService.Search. If SEARCHABLE_ENABLED but field type is numerical, field values will not be searchable by text queries in SearchService.Search, as there are no text values associated to numerical fields. If searchable_option is unset, the server behavior defaults to SEARCHABLE_DISABLED for fields that support setting searchable options. Only `string` fields that have no key property mapping support setting searchable_option. For those fields that do not support setting searchable options, the server will skip searchable option setting, and setting searchable_option for those fields will throw `INVALID_ARGUMENT` error. }, ], @@ -1556,7 +1556,7 @@

Method Details

}, }, "workspaceConfig": { # Config to store data store type configuration for workspace data # Config to store data store type configuration for workspace data. This must be set when DataStore.content_config is set as DataStore.ContentConfig.GOOGLE_WORKSPACE. - "dasherCustomerId": "A String", # Obfuscated Dasher customer ID. + "dasherCustomerId": "A String", # Output only. Obfuscated Dasher customer ID. Derived by the server from the project's GCP organization at data store creation time; any value supplied in the request payload is ignored. "superAdminEmailAddress": "A String", # Optional. The super admin email address for the workspace that will be used for access token generation. For now we only use it for Native Google Drive connector data ingestion. "superAdminServiceAccount": "A String", # Optional. The super admin service account for the workspace that will be used for access token generation. For now we only use it for Native Google Drive connector data ingestion. "type": "A String", # The Google Workspace data source. diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.schemas.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.schemas.html index 438c24c273..2be6571b80 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.schemas.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.schemas.html @@ -128,7 +128,7 @@

Method Details

"schemaOrgPaths": [ # Field paths for indexing custom attribute from schema.org data. More details of schema.org and its defined types can be found at [schema.org](https://schema.org). It is only used on advanced site search schema. Currently only support full path from root. The full path to a field is constructed by concatenating field names, starting from `_root`, with a period `.` as the delimiter. Examples: * Publish date of the root: _root.datePublished * Publish date of the reviews: _root.review.datePublished "A String", ], - "searchableFieldImportance": "A String", # Optional. Specifies the importance of the field when `searchable_option` is `SEARCHABLE_ENABLED`. If `searchable_option` is `SEARCHABLE_DISABLED`, this field is ignored. If `searchable_option` is `SEARCHABLE_ENABLED` and this is `SEARCHABLE_FIELD_IMPORTANCE_UNSPECIFIED`, it behaves as `DEFAULT_IMPORTANCE`. + "searchableFieldImportance": "A String", # Optional. Specifies the importance of the field when `searchable_option` is `SEARCHABLE_ENABLED`. If `searchable_option` is `SEARCHABLE_DISABLED`, this field is ignored. If `searchable_option` is `SEARCHABLE_ENABLED` and this is `SEARCHABLE_FIELD_IMPORTANCE_UNSPECIFIED`, it behaves as `DEFAULT_IMPORTANCE`. For more information, see [Weight searchable fields](https://cloud.google.com/generative-ai-app-builder/docs/configure-field-settings#weight-search). "searchableOption": "A String", # If searchable_option is SEARCHABLE_ENABLED, field values are searchable by text queries in SearchService.Search. If SEARCHABLE_ENABLED but field type is numerical, field values will not be searchable by text queries in SearchService.Search, as there are no text values associated to numerical fields. If searchable_option is unset, the server behavior defaults to SEARCHABLE_DISABLED for fields that support setting searchable options. Only `string` fields that have no key property mapping support setting searchable_option. For those fields that do not support setting searchable options, the server will skip searchable option setting, and setting searchable_option for those fields will throw `INVALID_ARGUMENT` error. }, ], @@ -236,7 +236,7 @@

Method Details

"schemaOrgPaths": [ # Field paths for indexing custom attribute from schema.org data. More details of schema.org and its defined types can be found at [schema.org](https://schema.org). It is only used on advanced site search schema. Currently only support full path from root. The full path to a field is constructed by concatenating field names, starting from `_root`, with a period `.` as the delimiter. Examples: * Publish date of the root: _root.datePublished * Publish date of the reviews: _root.review.datePublished "A String", ], - "searchableFieldImportance": "A String", # Optional. Specifies the importance of the field when `searchable_option` is `SEARCHABLE_ENABLED`. If `searchable_option` is `SEARCHABLE_DISABLED`, this field is ignored. If `searchable_option` is `SEARCHABLE_ENABLED` and this is `SEARCHABLE_FIELD_IMPORTANCE_UNSPECIFIED`, it behaves as `DEFAULT_IMPORTANCE`. + "searchableFieldImportance": "A String", # Optional. Specifies the importance of the field when `searchable_option` is `SEARCHABLE_ENABLED`. If `searchable_option` is `SEARCHABLE_DISABLED`, this field is ignored. If `searchable_option` is `SEARCHABLE_ENABLED` and this is `SEARCHABLE_FIELD_IMPORTANCE_UNSPECIFIED`, it behaves as `DEFAULT_IMPORTANCE`. For more information, see [Weight searchable fields](https://cloud.google.com/generative-ai-app-builder/docs/configure-field-settings#weight-search). "searchableOption": "A String", # If searchable_option is SEARCHABLE_ENABLED, field values are searchable by text queries in SearchService.Search. If SEARCHABLE_ENABLED but field type is numerical, field values will not be searchable by text queries in SearchService.Search, as there are no text values associated to numerical fields. If searchable_option is unset, the server behavior defaults to SEARCHABLE_DISABLED for fields that support setting searchable options. Only `string` fields that have no key property mapping support setting searchable_option. For those fields that do not support setting searchable options, the server will skip searchable option setting, and setting searchable_option for those fields will throw `INVALID_ARGUMENT` error. }, ], @@ -285,7 +285,7 @@

Method Details

"schemaOrgPaths": [ # Field paths for indexing custom attribute from schema.org data. More details of schema.org and its defined types can be found at [schema.org](https://schema.org). It is only used on advanced site search schema. Currently only support full path from root. The full path to a field is constructed by concatenating field names, starting from `_root`, with a period `.` as the delimiter. Examples: * Publish date of the root: _root.datePublished * Publish date of the reviews: _root.review.datePublished "A String", ], - "searchableFieldImportance": "A String", # Optional. Specifies the importance of the field when `searchable_option` is `SEARCHABLE_ENABLED`. If `searchable_option` is `SEARCHABLE_DISABLED`, this field is ignored. If `searchable_option` is `SEARCHABLE_ENABLED` and this is `SEARCHABLE_FIELD_IMPORTANCE_UNSPECIFIED`, it behaves as `DEFAULT_IMPORTANCE`. + "searchableFieldImportance": "A String", # Optional. Specifies the importance of the field when `searchable_option` is `SEARCHABLE_ENABLED`. If `searchable_option` is `SEARCHABLE_DISABLED`, this field is ignored. If `searchable_option` is `SEARCHABLE_ENABLED` and this is `SEARCHABLE_FIELD_IMPORTANCE_UNSPECIFIED`, it behaves as `DEFAULT_IMPORTANCE`. For more information, see [Weight searchable fields](https://cloud.google.com/generative-ai-app-builder/docs/configure-field-settings#weight-search). "searchableOption": "A String", # If searchable_option is SEARCHABLE_ENABLED, field values are searchable by text queries in SearchService.Search. If SEARCHABLE_ENABLED but field type is numerical, field values will not be searchable by text queries in SearchService.Search, as there are no text values associated to numerical fields. If searchable_option is unset, the server behavior defaults to SEARCHABLE_DISABLED for fields that support setting searchable options. Only `string` fields that have no key property mapping support setting searchable_option. For those fields that do not support setting searchable options, the server will skip searchable option setting, and setting searchable_option for those fields will throw `INVALID_ARGUMENT` error. }, ], @@ -340,7 +340,7 @@

Method Details

"schemaOrgPaths": [ # Field paths for indexing custom attribute from schema.org data. More details of schema.org and its defined types can be found at [schema.org](https://schema.org). It is only used on advanced site search schema. Currently only support full path from root. The full path to a field is constructed by concatenating field names, starting from `_root`, with a period `.` as the delimiter. Examples: * Publish date of the root: _root.datePublished * Publish date of the reviews: _root.review.datePublished "A String", ], - "searchableFieldImportance": "A String", # Optional. Specifies the importance of the field when `searchable_option` is `SEARCHABLE_ENABLED`. If `searchable_option` is `SEARCHABLE_DISABLED`, this field is ignored. If `searchable_option` is `SEARCHABLE_ENABLED` and this is `SEARCHABLE_FIELD_IMPORTANCE_UNSPECIFIED`, it behaves as `DEFAULT_IMPORTANCE`. + "searchableFieldImportance": "A String", # Optional. Specifies the importance of the field when `searchable_option` is `SEARCHABLE_ENABLED`. If `searchable_option` is `SEARCHABLE_DISABLED`, this field is ignored. If `searchable_option` is `SEARCHABLE_ENABLED` and this is `SEARCHABLE_FIELD_IMPORTANCE_UNSPECIFIED`, it behaves as `DEFAULT_IMPORTANCE`. For more information, see [Weight searchable fields](https://cloud.google.com/generative-ai-app-builder/docs/configure-field-settings#weight-search). "searchableOption": "A String", # If searchable_option is SEARCHABLE_ENABLED, field values are searchable by text queries in SearchService.Search. If SEARCHABLE_ENABLED but field type is numerical, field values will not be searchable by text queries in SearchService.Search, as there are no text values associated to numerical fields. If searchable_option is unset, the server behavior defaults to SEARCHABLE_DISABLED for fields that support setting searchable options. Only `string` fields that have no key property mapping support setting searchable_option. For those fields that do not support setting searchable options, the server will skip searchable option setting, and setting searchable_option for those fields will throw `INVALID_ARGUMENT` error. }, ], diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.servingConfigs.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.servingConfigs.html index 82c5948ab3..d96c9c923e 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.servingConfigs.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.servingConfigs.html @@ -2005,7 +2005,7 @@

Method Details

"condition": "A String", # The condition under which query expansion should occur. Default to Condition.DISABLED. "pinUnexpandedResults": True or False, # Whether to pin unexpanded results. If this field is set to true, unexpanded products are always at the top of the search results, followed by the expanded results. }, - "rankingExpression": "A String", # Optional. The ranking expression controls the customized ranking on retrieval documents. This overrides ServingConfig.ranking_expression. The syntax and supported features depend on the `ranking_expression_backend` value. If `ranking_expression_backend` is not provided, it defaults to `RANK_BY_EMBEDDING`. If ranking_expression_backend is not provided or set to `RANK_BY_EMBEDDING`, it should be a single function or multiple functions that are joined by "+". * ranking_expression = function, { " + ", function }; Supported functions: * double * relevance_score * double * dotProduct(embedding_field_path) Function variables: * `relevance_score`: pre-defined keywords, used for measure relevance between query and document. * `embedding_field_path`: the document embedding field used with query embedding vector. * `dotProduct`: embedding function between `embedding_field_path` and query embedding vector. Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`. If ranking_expression_backend is set to `RANK_BY_FORMULA`, the following expression types (and combinations of those chained using + or * operators) are supported: * `double` * `signal` * `log(signal)` * `exp(signal)` * `rr(signal, double > 0)` -- reciprocal rank transformation with second argument being a denominator constant. * `is_nan(signal)` -- returns 0 if signal is NaN, 1 otherwise. * `fill_nan(signal1, signal2 | double)` -- if signal1 is NaN, returns signal2 | double, else returns signal1. Here are a few examples of ranking formulas that use the supported ranking expression types: - `0.2 * semantic_similarity_score + 0.8 * log(keyword_similarity_score)` -- mostly rank by the logarithm of `keyword_similarity_score` with slight `semantic_smilarity_score` adjustment. - `0.2 * exp(fill_nan(semantic_similarity_score, 0)) + 0.3 * is_nan(keyword_similarity_score)` -- rank by the exponent of `semantic_similarity_score` filling the value with 0 if it's NaN, also add constant 0.3 adjustment to the final score if `semantic_similarity_score` is NaN. - `0.2 * rr(semantic_similarity_score, 16) + 0.8 * rr(keyword_similarity_score, 16)` -- mostly rank by the reciprocal rank of `keyword_similarity_score` with slight adjustment of reciprocal rank of `semantic_smilarity_score`. The following signals are supported: * `semantic_similarity_score`: semantic similarity adjustment that is calculated using the embeddings generated by a proprietary Google model. This score determines how semantically similar a search query is to a document. * `keyword_similarity_score`: keyword match adjustment uses the Best Match 25 (BM25) ranking function. This score is calculated using a probabilistic model to estimate the probability that a document is relevant to a given query. * `relevance_score`: semantic relevance adjustment that uses a proprietary Google model to determine the meaning and intent behind a user's query in context with the content in the documents. * `pctr_rank`: predicted conversion rate adjustment as a rank use predicted Click-through rate (pCTR) to gauge the relevance and attractiveness of a search result from a user's perspective. A higher pCTR suggests that the result is more likely to satisfy the user's query and intent, making it a valuable signal for ranking. * `freshness_rank`: freshness adjustment as a rank * `document_age`: The time in hours elapsed since the document was last updated, a floating-point number (e.g., 0.25 means 15 minutes). * `topicality_rank`: topicality adjustment as a rank. Uses proprietary Google model to determine the keyword-based overlap between the query and the document. * `base_rank`: the default rank of the result + "rankingExpression": "A String", # Optional. The ranking expression controls the customized ranking on retrieval documents. This overrides ServingConfig.ranking_expression. The syntax and supported features depend on the `ranking_expression_backend` value. If `ranking_expression_backend` is not provided, it defaults to `RANK_BY_EMBEDDING`. If ranking_expression_backend is not provided or set to `RANK_BY_EMBEDDING`, it should be a single function or multiple functions that are joined by "+". * ranking_expression = function, { " + ", function }; Supported functions: * double * relevance_score * double * dotProduct(embedding_field_path) Function variables: * `relevance_score`: pre-defined keywords, used for measure relevance between query and document. * `embedding_field_path`: the document embedding field used with query embedding vector. * `dotProduct`: embedding function between `embedding_field_path` and query embedding vector. Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`. If ranking_expression_backend is set to `RANK_BY_FORMULA`, the following expression types (and combinations of those chained using + or * operators) are supported: * `double` * `signal` * `log(signal)` * `exp(signal)` * `rr(signal, double > 0)` -- reciprocal rank transformation with second argument being a denominator constant. * `is_nan(signal)` -- returns 0 if signal is NaN, 1 otherwise. * `fill_nan(signal1, signal2 | double)` -- if signal1 is NaN, returns signal2 | double, else returns signal1. Here are a few examples of ranking formulas that use the supported ranking expression types: - `0.2 * semantic_similarity_score + 0.8 * log(keyword_similarity_score)` -- mostly rank by the logarithm of `keyword_similarity_score` with slight `semantic_smilarity_score` adjustment. - `0.2 * exp(fill_nan(semantic_similarity_score, 0)) + 0.3 * is_nan(keyword_similarity_score)` -- rank by the exponent of `semantic_similarity_score` filling the value with 0 if it's NaN, also add constant 0.3 adjustment to the final score if `semantic_similarity_score` is NaN. - `0.2 * rr(semantic_similarity_score, 16) + 0.8 * rr(keyword_similarity_score, 16)` -- mostly rank by the reciprocal rank of `keyword_similarity_score` with slight adjustment of reciprocal rank of `semantic_smilarity_score`. The following signals are supported: * `semantic_similarity_score`: semantic similarity adjustment that is calculated using the embeddings generated by a proprietary Google model. This score determines how semantically similar a search query is to a document. * `keyword_similarity_score`: keyword match adjustment uses the Best Match 25 (BM25) ranking function. This score is calculated using a probabilistic model to estimate the probability that a document is relevant to a given query. * `relevance_score`: semantic relevance adjustment that uses a proprietary Google model to determine the meaning and intent behind a user's query in context with the content in the documents. * `pctr_rank`: predicted conversion rate adjustment as a rank use predicted Click-through rate (pCTR) to gauge the relevance and attractiveness of a search result from a user's perspective. A higher pCTR suggests that the result is more likely to satisfy the user's query and intent, making it a valuable signal for ranking. * `freshness_rank`: freshness adjustment as a rank * `document_age`: The time in hours elapsed since the document was last updated, a floating-point number (e.g., 0.25 means 15 minutes). * `topicality_rank`: topicality adjustment as a rank. Uses proprietary Google model to determine the keyword-based overlap between the query and the document. * `base_rank`: the default rank of the result * `media_actor_match`: whether the media actor matches the query * `media_director_match`: whether the media director matches the query * `media_genre_match`: whether the media genre matches the query * `media_language_match`: whether the media language matches the query * `media_title_match`: whether the media title matches the query * `media_prefix_similarity_rank`: prefix similarity rank for media results * `media_semantic_similarity_rank`: semantic similarity rank for media results "rankingExpressionBackend": "A String", # Optional. The backend to use for the ranking expression evaluation. "regionCode": "A String", # The Unicode country/region code (CLDR) of a location, such as "US" and "419". For more information, see [Standard fields](https://cloud.google.com/apis/design/standard_fields). If set, then results will be boosted based on the region_code provided. "relevanceFilterSpec": { # Relevance filtering specification. # Optional. The granular relevance filtering specification. If not specified, the global `relevance_threshold` will be used for all sub-searches. If specified, this overrides the global `relevance_threshold` to use thresholds on a per sub-search basis. This feature is currently supported only for custom and site search. @@ -2672,7 +2672,7 @@

Method Details

"condition": "A String", # The condition under which query expansion should occur. Default to Condition.DISABLED. "pinUnexpandedResults": True or False, # Whether to pin unexpanded results. If this field is set to true, unexpanded products are always at the top of the search results, followed by the expanded results. }, - "rankingExpression": "A String", # Optional. The ranking expression controls the customized ranking on retrieval documents. This overrides ServingConfig.ranking_expression. The syntax and supported features depend on the `ranking_expression_backend` value. If `ranking_expression_backend` is not provided, it defaults to `RANK_BY_EMBEDDING`. If ranking_expression_backend is not provided or set to `RANK_BY_EMBEDDING`, it should be a single function or multiple functions that are joined by "+". * ranking_expression = function, { " + ", function }; Supported functions: * double * relevance_score * double * dotProduct(embedding_field_path) Function variables: * `relevance_score`: pre-defined keywords, used for measure relevance between query and document. * `embedding_field_path`: the document embedding field used with query embedding vector. * `dotProduct`: embedding function between `embedding_field_path` and query embedding vector. Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`. If ranking_expression_backend is set to `RANK_BY_FORMULA`, the following expression types (and combinations of those chained using + or * operators) are supported: * `double` * `signal` * `log(signal)` * `exp(signal)` * `rr(signal, double > 0)` -- reciprocal rank transformation with second argument being a denominator constant. * `is_nan(signal)` -- returns 0 if signal is NaN, 1 otherwise. * `fill_nan(signal1, signal2 | double)` -- if signal1 is NaN, returns signal2 | double, else returns signal1. Here are a few examples of ranking formulas that use the supported ranking expression types: - `0.2 * semantic_similarity_score + 0.8 * log(keyword_similarity_score)` -- mostly rank by the logarithm of `keyword_similarity_score` with slight `semantic_smilarity_score` adjustment. - `0.2 * exp(fill_nan(semantic_similarity_score, 0)) + 0.3 * is_nan(keyword_similarity_score)` -- rank by the exponent of `semantic_similarity_score` filling the value with 0 if it's NaN, also add constant 0.3 adjustment to the final score if `semantic_similarity_score` is NaN. - `0.2 * rr(semantic_similarity_score, 16) + 0.8 * rr(keyword_similarity_score, 16)` -- mostly rank by the reciprocal rank of `keyword_similarity_score` with slight adjustment of reciprocal rank of `semantic_smilarity_score`. The following signals are supported: * `semantic_similarity_score`: semantic similarity adjustment that is calculated using the embeddings generated by a proprietary Google model. This score determines how semantically similar a search query is to a document. * `keyword_similarity_score`: keyword match adjustment uses the Best Match 25 (BM25) ranking function. This score is calculated using a probabilistic model to estimate the probability that a document is relevant to a given query. * `relevance_score`: semantic relevance adjustment that uses a proprietary Google model to determine the meaning and intent behind a user's query in context with the content in the documents. * `pctr_rank`: predicted conversion rate adjustment as a rank use predicted Click-through rate (pCTR) to gauge the relevance and attractiveness of a search result from a user's perspective. A higher pCTR suggests that the result is more likely to satisfy the user's query and intent, making it a valuable signal for ranking. * `freshness_rank`: freshness adjustment as a rank * `document_age`: The time in hours elapsed since the document was last updated, a floating-point number (e.g., 0.25 means 15 minutes). * `topicality_rank`: topicality adjustment as a rank. Uses proprietary Google model to determine the keyword-based overlap between the query and the document. * `base_rank`: the default rank of the result + "rankingExpression": "A String", # Optional. The ranking expression controls the customized ranking on retrieval documents. This overrides ServingConfig.ranking_expression. The syntax and supported features depend on the `ranking_expression_backend` value. If `ranking_expression_backend` is not provided, it defaults to `RANK_BY_EMBEDDING`. If ranking_expression_backend is not provided or set to `RANK_BY_EMBEDDING`, it should be a single function or multiple functions that are joined by "+". * ranking_expression = function, { " + ", function }; Supported functions: * double * relevance_score * double * dotProduct(embedding_field_path) Function variables: * `relevance_score`: pre-defined keywords, used for measure relevance between query and document. * `embedding_field_path`: the document embedding field used with query embedding vector. * `dotProduct`: embedding function between `embedding_field_path` and query embedding vector. Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`. If ranking_expression_backend is set to `RANK_BY_FORMULA`, the following expression types (and combinations of those chained using + or * operators) are supported: * `double` * `signal` * `log(signal)` * `exp(signal)` * `rr(signal, double > 0)` -- reciprocal rank transformation with second argument being a denominator constant. * `is_nan(signal)` -- returns 0 if signal is NaN, 1 otherwise. * `fill_nan(signal1, signal2 | double)` -- if signal1 is NaN, returns signal2 | double, else returns signal1. Here are a few examples of ranking formulas that use the supported ranking expression types: - `0.2 * semantic_similarity_score + 0.8 * log(keyword_similarity_score)` -- mostly rank by the logarithm of `keyword_similarity_score` with slight `semantic_smilarity_score` adjustment. - `0.2 * exp(fill_nan(semantic_similarity_score, 0)) + 0.3 * is_nan(keyword_similarity_score)` -- rank by the exponent of `semantic_similarity_score` filling the value with 0 if it's NaN, also add constant 0.3 adjustment to the final score if `semantic_similarity_score` is NaN. - `0.2 * rr(semantic_similarity_score, 16) + 0.8 * rr(keyword_similarity_score, 16)` -- mostly rank by the reciprocal rank of `keyword_similarity_score` with slight adjustment of reciprocal rank of `semantic_smilarity_score`. The following signals are supported: * `semantic_similarity_score`: semantic similarity adjustment that is calculated using the embeddings generated by a proprietary Google model. This score determines how semantically similar a search query is to a document. * `keyword_similarity_score`: keyword match adjustment uses the Best Match 25 (BM25) ranking function. This score is calculated using a probabilistic model to estimate the probability that a document is relevant to a given query. * `relevance_score`: semantic relevance adjustment that uses a proprietary Google model to determine the meaning and intent behind a user's query in context with the content in the documents. * `pctr_rank`: predicted conversion rate adjustment as a rank use predicted Click-through rate (pCTR) to gauge the relevance and attractiveness of a search result from a user's perspective. A higher pCTR suggests that the result is more likely to satisfy the user's query and intent, making it a valuable signal for ranking. * `freshness_rank`: freshness adjustment as a rank * `document_age`: The time in hours elapsed since the document was last updated, a floating-point number (e.g., 0.25 means 15 minutes). * `topicality_rank`: topicality adjustment as a rank. Uses proprietary Google model to determine the keyword-based overlap between the query and the document. * `base_rank`: the default rank of the result * `media_actor_match`: whether the media actor matches the query * `media_director_match`: whether the media director matches the query * `media_genre_match`: whether the media genre matches the query * `media_language_match`: whether the media language matches the query * `media_title_match`: whether the media title matches the query * `media_prefix_similarity_rank`: prefix similarity rank for media results * `media_semantic_similarity_rank`: semantic similarity rank for media results "rankingExpressionBackend": "A String", # Optional. The backend to use for the ranking expression evaluation. "regionCode": "A String", # The Unicode country/region code (CLDR) of a location, such as "US" and "419". For more information, see [Standard fields](https://cloud.google.com/apis/design/standard_fields). If set, then results will be boosted based on the region_code provided. "relevanceFilterSpec": { # Relevance filtering specification. # Optional. The granular relevance filtering specification. If not specified, the global `relevance_threshold` will be used for all sub-searches. If specified, this overrides the global `relevance_threshold` to use thresholds on a per sub-search basis. This feature is currently supported only for custom and site search. diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.sessions.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.sessions.html index 12db55c051..44419fc064 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.sessions.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.sessions.html @@ -1132,7 +1132,7 @@

Method Details

Args: parent: string, Required. The data store resource name. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}` (required) filter: string, A comma-separated list of fields to filter by, in EBNF grammar. The supported fields are: * `user_pseudo_id` * `state` * `display_name` * `starred` * `is_pinned` * `labels` * `create_time` * `update_time` * `collaborative_project` Examples: * `user_pseudo_id = some_id` * `display_name = "some_name"` * `starred = true` * `is_pinned=true AND (NOT labels:hidden)` * `create_time > "1970-01-01T12:00:00Z"` * `collaborative_project = "projects/123/locations/global/collections/default_collection/engines/" "default_engine/collaborative_projects/cp1"` - orderBy: string, A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `update_time` * `create_time` * `session_name` * `is_pinned` Example: * `update_time desc` * `create_time` * `is_pinned desc,update_time desc`: list sessions by is_pinned first, then by update_time. + orderBy: string, A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `update_time` * `create_time` * `session_name` * `is_pinned` * `display_name` Example: * `update_time desc` * `create_time` * `is_pinned desc,update_time desc`: list sessions by is_pinned first, then by update_time. pageSize: integer, Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000. pageToken: string, A page token, received from a previous `ListSessions` call. Provide this to retrieve the subsequent page. x__xgafv: string, V1 error format. diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.evaluations.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.evaluations.html index ca8d59500d..d320263a7e 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.evaluations.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.evaluations.html @@ -324,7 +324,7 @@

Method Details

"condition": "A String", # The condition under which query expansion should occur. Default to Condition.DISABLED. "pinUnexpandedResults": True or False, # Whether to pin unexpanded results. If this field is set to true, unexpanded products are always at the top of the search results, followed by the expanded results. }, - "rankingExpression": "A String", # Optional. The ranking expression controls the customized ranking on retrieval documents. This overrides ServingConfig.ranking_expression. The syntax and supported features depend on the `ranking_expression_backend` value. If `ranking_expression_backend` is not provided, it defaults to `RANK_BY_EMBEDDING`. If ranking_expression_backend is not provided or set to `RANK_BY_EMBEDDING`, it should be a single function or multiple functions that are joined by "+". * ranking_expression = function, { " + ", function }; Supported functions: * double * relevance_score * double * dotProduct(embedding_field_path) Function variables: * `relevance_score`: pre-defined keywords, used for measure relevance between query and document. * `embedding_field_path`: the document embedding field used with query embedding vector. * `dotProduct`: embedding function between `embedding_field_path` and query embedding vector. Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`. If ranking_expression_backend is set to `RANK_BY_FORMULA`, the following expression types (and combinations of those chained using + or * operators) are supported: * `double` * `signal` * `log(signal)` * `exp(signal)` * `rr(signal, double > 0)` -- reciprocal rank transformation with second argument being a denominator constant. * `is_nan(signal)` -- returns 0 if signal is NaN, 1 otherwise. * `fill_nan(signal1, signal2 | double)` -- if signal1 is NaN, returns signal2 | double, else returns signal1. Here are a few examples of ranking formulas that use the supported ranking expression types: - `0.2 * semantic_similarity_score + 0.8 * log(keyword_similarity_score)` -- mostly rank by the logarithm of `keyword_similarity_score` with slight `semantic_smilarity_score` adjustment. - `0.2 * exp(fill_nan(semantic_similarity_score, 0)) + 0.3 * is_nan(keyword_similarity_score)` -- rank by the exponent of `semantic_similarity_score` filling the value with 0 if it's NaN, also add constant 0.3 adjustment to the final score if `semantic_similarity_score` is NaN. - `0.2 * rr(semantic_similarity_score, 16) + 0.8 * rr(keyword_similarity_score, 16)` -- mostly rank by the reciprocal rank of `keyword_similarity_score` with slight adjustment of reciprocal rank of `semantic_smilarity_score`. The following signals are supported: * `semantic_similarity_score`: semantic similarity adjustment that is calculated using the embeddings generated by a proprietary Google model. This score determines how semantically similar a search query is to a document. * `keyword_similarity_score`: keyword match adjustment uses the Best Match 25 (BM25) ranking function. This score is calculated using a probabilistic model to estimate the probability that a document is relevant to a given query. * `relevance_score`: semantic relevance adjustment that uses a proprietary Google model to determine the meaning and intent behind a user's query in context with the content in the documents. * `pctr_rank`: predicted conversion rate adjustment as a rank use predicted Click-through rate (pCTR) to gauge the relevance and attractiveness of a search result from a user's perspective. A higher pCTR suggests that the result is more likely to satisfy the user's query and intent, making it a valuable signal for ranking. * `freshness_rank`: freshness adjustment as a rank * `document_age`: The time in hours elapsed since the document was last updated, a floating-point number (e.g., 0.25 means 15 minutes). * `topicality_rank`: topicality adjustment as a rank. Uses proprietary Google model to determine the keyword-based overlap between the query and the document. * `base_rank`: the default rank of the result + "rankingExpression": "A String", # Optional. The ranking expression controls the customized ranking on retrieval documents. This overrides ServingConfig.ranking_expression. The syntax and supported features depend on the `ranking_expression_backend` value. If `ranking_expression_backend` is not provided, it defaults to `RANK_BY_EMBEDDING`. If ranking_expression_backend is not provided or set to `RANK_BY_EMBEDDING`, it should be a single function or multiple functions that are joined by "+". * ranking_expression = function, { " + ", function }; Supported functions: * double * relevance_score * double * dotProduct(embedding_field_path) Function variables: * `relevance_score`: pre-defined keywords, used for measure relevance between query and document. * `embedding_field_path`: the document embedding field used with query embedding vector. * `dotProduct`: embedding function between `embedding_field_path` and query embedding vector. Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`. If ranking_expression_backend is set to `RANK_BY_FORMULA`, the following expression types (and combinations of those chained using + or * operators) are supported: * `double` * `signal` * `log(signal)` * `exp(signal)` * `rr(signal, double > 0)` -- reciprocal rank transformation with second argument being a denominator constant. * `is_nan(signal)` -- returns 0 if signal is NaN, 1 otherwise. * `fill_nan(signal1, signal2 | double)` -- if signal1 is NaN, returns signal2 | double, else returns signal1. Here are a few examples of ranking formulas that use the supported ranking expression types: - `0.2 * semantic_similarity_score + 0.8 * log(keyword_similarity_score)` -- mostly rank by the logarithm of `keyword_similarity_score` with slight `semantic_smilarity_score` adjustment. - `0.2 * exp(fill_nan(semantic_similarity_score, 0)) + 0.3 * is_nan(keyword_similarity_score)` -- rank by the exponent of `semantic_similarity_score` filling the value with 0 if it's NaN, also add constant 0.3 adjustment to the final score if `semantic_similarity_score` is NaN. - `0.2 * rr(semantic_similarity_score, 16) + 0.8 * rr(keyword_similarity_score, 16)` -- mostly rank by the reciprocal rank of `keyword_similarity_score` with slight adjustment of reciprocal rank of `semantic_smilarity_score`. The following signals are supported: * `semantic_similarity_score`: semantic similarity adjustment that is calculated using the embeddings generated by a proprietary Google model. This score determines how semantically similar a search query is to a document. * `keyword_similarity_score`: keyword match adjustment uses the Best Match 25 (BM25) ranking function. This score is calculated using a probabilistic model to estimate the probability that a document is relevant to a given query. * `relevance_score`: semantic relevance adjustment that uses a proprietary Google model to determine the meaning and intent behind a user's query in context with the content in the documents. * `pctr_rank`: predicted conversion rate adjustment as a rank use predicted Click-through rate (pCTR) to gauge the relevance and attractiveness of a search result from a user's perspective. A higher pCTR suggests that the result is more likely to satisfy the user's query and intent, making it a valuable signal for ranking. * `freshness_rank`: freshness adjustment as a rank * `document_age`: The time in hours elapsed since the document was last updated, a floating-point number (e.g., 0.25 means 15 minutes). * `topicality_rank`: topicality adjustment as a rank. Uses proprietary Google model to determine the keyword-based overlap between the query and the document. * `base_rank`: the default rank of the result * `media_actor_match`: whether the media actor matches the query * `media_director_match`: whether the media director matches the query * `media_genre_match`: whether the media genre matches the query * `media_language_match`: whether the media language matches the query * `media_title_match`: whether the media title matches the query * `media_prefix_similarity_rank`: prefix similarity rank for media results * `media_semantic_similarity_rank`: semantic similarity rank for media results "rankingExpressionBackend": "A String", # Optional. The backend to use for the ranking expression evaluation. "regionCode": "A String", # The Unicode country/region code (CLDR) of a location, such as "US" and "419". For more information, see [Standard fields](https://cloud.google.com/apis/design/standard_fields). If set, then results will be boosted based on the region_code provided. "relevanceFilterSpec": { # Relevance filtering specification. # Optional. The granular relevance filtering specification. If not specified, the global `relevance_threshold` will be used for all sub-searches. If specified, this overrides the global `relevance_threshold` to use thresholds on a per sub-search basis. This feature is currently supported only for custom and site search. @@ -666,7 +666,7 @@

Method Details

"condition": "A String", # The condition under which query expansion should occur. Default to Condition.DISABLED. "pinUnexpandedResults": True or False, # Whether to pin unexpanded results. If this field is set to true, unexpanded products are always at the top of the search results, followed by the expanded results. }, - "rankingExpression": "A String", # Optional. The ranking expression controls the customized ranking on retrieval documents. This overrides ServingConfig.ranking_expression. The syntax and supported features depend on the `ranking_expression_backend` value. If `ranking_expression_backend` is not provided, it defaults to `RANK_BY_EMBEDDING`. If ranking_expression_backend is not provided or set to `RANK_BY_EMBEDDING`, it should be a single function or multiple functions that are joined by "+". * ranking_expression = function, { " + ", function }; Supported functions: * double * relevance_score * double * dotProduct(embedding_field_path) Function variables: * `relevance_score`: pre-defined keywords, used for measure relevance between query and document. * `embedding_field_path`: the document embedding field used with query embedding vector. * `dotProduct`: embedding function between `embedding_field_path` and query embedding vector. Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`. If ranking_expression_backend is set to `RANK_BY_FORMULA`, the following expression types (and combinations of those chained using + or * operators) are supported: * `double` * `signal` * `log(signal)` * `exp(signal)` * `rr(signal, double > 0)` -- reciprocal rank transformation with second argument being a denominator constant. * `is_nan(signal)` -- returns 0 if signal is NaN, 1 otherwise. * `fill_nan(signal1, signal2 | double)` -- if signal1 is NaN, returns signal2 | double, else returns signal1. Here are a few examples of ranking formulas that use the supported ranking expression types: - `0.2 * semantic_similarity_score + 0.8 * log(keyword_similarity_score)` -- mostly rank by the logarithm of `keyword_similarity_score` with slight `semantic_smilarity_score` adjustment. - `0.2 * exp(fill_nan(semantic_similarity_score, 0)) + 0.3 * is_nan(keyword_similarity_score)` -- rank by the exponent of `semantic_similarity_score` filling the value with 0 if it's NaN, also add constant 0.3 adjustment to the final score if `semantic_similarity_score` is NaN. - `0.2 * rr(semantic_similarity_score, 16) + 0.8 * rr(keyword_similarity_score, 16)` -- mostly rank by the reciprocal rank of `keyword_similarity_score` with slight adjustment of reciprocal rank of `semantic_smilarity_score`. The following signals are supported: * `semantic_similarity_score`: semantic similarity adjustment that is calculated using the embeddings generated by a proprietary Google model. This score determines how semantically similar a search query is to a document. * `keyword_similarity_score`: keyword match adjustment uses the Best Match 25 (BM25) ranking function. This score is calculated using a probabilistic model to estimate the probability that a document is relevant to a given query. * `relevance_score`: semantic relevance adjustment that uses a proprietary Google model to determine the meaning and intent behind a user's query in context with the content in the documents. * `pctr_rank`: predicted conversion rate adjustment as a rank use predicted Click-through rate (pCTR) to gauge the relevance and attractiveness of a search result from a user's perspective. A higher pCTR suggests that the result is more likely to satisfy the user's query and intent, making it a valuable signal for ranking. * `freshness_rank`: freshness adjustment as a rank * `document_age`: The time in hours elapsed since the document was last updated, a floating-point number (e.g., 0.25 means 15 minutes). * `topicality_rank`: topicality adjustment as a rank. Uses proprietary Google model to determine the keyword-based overlap between the query and the document. * `base_rank`: the default rank of the result + "rankingExpression": "A String", # Optional. The ranking expression controls the customized ranking on retrieval documents. This overrides ServingConfig.ranking_expression. The syntax and supported features depend on the `ranking_expression_backend` value. If `ranking_expression_backend` is not provided, it defaults to `RANK_BY_EMBEDDING`. If ranking_expression_backend is not provided or set to `RANK_BY_EMBEDDING`, it should be a single function or multiple functions that are joined by "+". * ranking_expression = function, { " + ", function }; Supported functions: * double * relevance_score * double * dotProduct(embedding_field_path) Function variables: * `relevance_score`: pre-defined keywords, used for measure relevance between query and document. * `embedding_field_path`: the document embedding field used with query embedding vector. * `dotProduct`: embedding function between `embedding_field_path` and query embedding vector. Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`. If ranking_expression_backend is set to `RANK_BY_FORMULA`, the following expression types (and combinations of those chained using + or * operators) are supported: * `double` * `signal` * `log(signal)` * `exp(signal)` * `rr(signal, double > 0)` -- reciprocal rank transformation with second argument being a denominator constant. * `is_nan(signal)` -- returns 0 if signal is NaN, 1 otherwise. * `fill_nan(signal1, signal2 | double)` -- if signal1 is NaN, returns signal2 | double, else returns signal1. Here are a few examples of ranking formulas that use the supported ranking expression types: - `0.2 * semantic_similarity_score + 0.8 * log(keyword_similarity_score)` -- mostly rank by the logarithm of `keyword_similarity_score` with slight `semantic_smilarity_score` adjustment. - `0.2 * exp(fill_nan(semantic_similarity_score, 0)) + 0.3 * is_nan(keyword_similarity_score)` -- rank by the exponent of `semantic_similarity_score` filling the value with 0 if it's NaN, also add constant 0.3 adjustment to the final score if `semantic_similarity_score` is NaN. - `0.2 * rr(semantic_similarity_score, 16) + 0.8 * rr(keyword_similarity_score, 16)` -- mostly rank by the reciprocal rank of `keyword_similarity_score` with slight adjustment of reciprocal rank of `semantic_smilarity_score`. The following signals are supported: * `semantic_similarity_score`: semantic similarity adjustment that is calculated using the embeddings generated by a proprietary Google model. This score determines how semantically similar a search query is to a document. * `keyword_similarity_score`: keyword match adjustment uses the Best Match 25 (BM25) ranking function. This score is calculated using a probabilistic model to estimate the probability that a document is relevant to a given query. * `relevance_score`: semantic relevance adjustment that uses a proprietary Google model to determine the meaning and intent behind a user's query in context with the content in the documents. * `pctr_rank`: predicted conversion rate adjustment as a rank use predicted Click-through rate (pCTR) to gauge the relevance and attractiveness of a search result from a user's perspective. A higher pCTR suggests that the result is more likely to satisfy the user's query and intent, making it a valuable signal for ranking. * `freshness_rank`: freshness adjustment as a rank * `document_age`: The time in hours elapsed since the document was last updated, a floating-point number (e.g., 0.25 means 15 minutes). * `topicality_rank`: topicality adjustment as a rank. Uses proprietary Google model to determine the keyword-based overlap between the query and the document. * `base_rank`: the default rank of the result * `media_actor_match`: whether the media actor matches the query * `media_director_match`: whether the media director matches the query * `media_genre_match`: whether the media genre matches the query * `media_language_match`: whether the media language matches the query * `media_title_match`: whether the media title matches the query * `media_prefix_similarity_rank`: prefix similarity rank for media results * `media_semantic_similarity_rank`: semantic similarity rank for media results "rankingExpressionBackend": "A String", # Optional. The backend to use for the ranking expression evaluation. "regionCode": "A String", # The Unicode country/region code (CLDR) of a location, such as "US" and "419". For more information, see [Standard fields](https://cloud.google.com/apis/design/standard_fields). If set, then results will be boosted based on the region_code provided. "relevanceFilterSpec": { # Relevance filtering specification. # Optional. The granular relevance filtering specification. If not specified, the global `relevance_threshold` will be used for all sub-searches. If specified, this overrides the global `relevance_threshold` to use thresholds on a per sub-search basis. This feature is currently supported only for custom and site search. @@ -984,7 +984,7 @@

Method Details

"condition": "A String", # The condition under which query expansion should occur. Default to Condition.DISABLED. "pinUnexpandedResults": True or False, # Whether to pin unexpanded results. If this field is set to true, unexpanded products are always at the top of the search results, followed by the expanded results. }, - "rankingExpression": "A String", # Optional. The ranking expression controls the customized ranking on retrieval documents. This overrides ServingConfig.ranking_expression. The syntax and supported features depend on the `ranking_expression_backend` value. If `ranking_expression_backend` is not provided, it defaults to `RANK_BY_EMBEDDING`. If ranking_expression_backend is not provided or set to `RANK_BY_EMBEDDING`, it should be a single function or multiple functions that are joined by "+". * ranking_expression = function, { " + ", function }; Supported functions: * double * relevance_score * double * dotProduct(embedding_field_path) Function variables: * `relevance_score`: pre-defined keywords, used for measure relevance between query and document. * `embedding_field_path`: the document embedding field used with query embedding vector. * `dotProduct`: embedding function between `embedding_field_path` and query embedding vector. Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`. If ranking_expression_backend is set to `RANK_BY_FORMULA`, the following expression types (and combinations of those chained using + or * operators) are supported: * `double` * `signal` * `log(signal)` * `exp(signal)` * `rr(signal, double > 0)` -- reciprocal rank transformation with second argument being a denominator constant. * `is_nan(signal)` -- returns 0 if signal is NaN, 1 otherwise. * `fill_nan(signal1, signal2 | double)` -- if signal1 is NaN, returns signal2 | double, else returns signal1. Here are a few examples of ranking formulas that use the supported ranking expression types: - `0.2 * semantic_similarity_score + 0.8 * log(keyword_similarity_score)` -- mostly rank by the logarithm of `keyword_similarity_score` with slight `semantic_smilarity_score` adjustment. - `0.2 * exp(fill_nan(semantic_similarity_score, 0)) + 0.3 * is_nan(keyword_similarity_score)` -- rank by the exponent of `semantic_similarity_score` filling the value with 0 if it's NaN, also add constant 0.3 adjustment to the final score if `semantic_similarity_score` is NaN. - `0.2 * rr(semantic_similarity_score, 16) + 0.8 * rr(keyword_similarity_score, 16)` -- mostly rank by the reciprocal rank of `keyword_similarity_score` with slight adjustment of reciprocal rank of `semantic_smilarity_score`. The following signals are supported: * `semantic_similarity_score`: semantic similarity adjustment that is calculated using the embeddings generated by a proprietary Google model. This score determines how semantically similar a search query is to a document. * `keyword_similarity_score`: keyword match adjustment uses the Best Match 25 (BM25) ranking function. This score is calculated using a probabilistic model to estimate the probability that a document is relevant to a given query. * `relevance_score`: semantic relevance adjustment that uses a proprietary Google model to determine the meaning and intent behind a user's query in context with the content in the documents. * `pctr_rank`: predicted conversion rate adjustment as a rank use predicted Click-through rate (pCTR) to gauge the relevance and attractiveness of a search result from a user's perspective. A higher pCTR suggests that the result is more likely to satisfy the user's query and intent, making it a valuable signal for ranking. * `freshness_rank`: freshness adjustment as a rank * `document_age`: The time in hours elapsed since the document was last updated, a floating-point number (e.g., 0.25 means 15 minutes). * `topicality_rank`: topicality adjustment as a rank. Uses proprietary Google model to determine the keyword-based overlap between the query and the document. * `base_rank`: the default rank of the result + "rankingExpression": "A String", # Optional. The ranking expression controls the customized ranking on retrieval documents. This overrides ServingConfig.ranking_expression. The syntax and supported features depend on the `ranking_expression_backend` value. If `ranking_expression_backend` is not provided, it defaults to `RANK_BY_EMBEDDING`. If ranking_expression_backend is not provided or set to `RANK_BY_EMBEDDING`, it should be a single function or multiple functions that are joined by "+". * ranking_expression = function, { " + ", function }; Supported functions: * double * relevance_score * double * dotProduct(embedding_field_path) Function variables: * `relevance_score`: pre-defined keywords, used for measure relevance between query and document. * `embedding_field_path`: the document embedding field used with query embedding vector. * `dotProduct`: embedding function between `embedding_field_path` and query embedding vector. Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`. If ranking_expression_backend is set to `RANK_BY_FORMULA`, the following expression types (and combinations of those chained using + or * operators) are supported: * `double` * `signal` * `log(signal)` * `exp(signal)` * `rr(signal, double > 0)` -- reciprocal rank transformation with second argument being a denominator constant. * `is_nan(signal)` -- returns 0 if signal is NaN, 1 otherwise. * `fill_nan(signal1, signal2 | double)` -- if signal1 is NaN, returns signal2 | double, else returns signal1. Here are a few examples of ranking formulas that use the supported ranking expression types: - `0.2 * semantic_similarity_score + 0.8 * log(keyword_similarity_score)` -- mostly rank by the logarithm of `keyword_similarity_score` with slight `semantic_smilarity_score` adjustment. - `0.2 * exp(fill_nan(semantic_similarity_score, 0)) + 0.3 * is_nan(keyword_similarity_score)` -- rank by the exponent of `semantic_similarity_score` filling the value with 0 if it's NaN, also add constant 0.3 adjustment to the final score if `semantic_similarity_score` is NaN. - `0.2 * rr(semantic_similarity_score, 16) + 0.8 * rr(keyword_similarity_score, 16)` -- mostly rank by the reciprocal rank of `keyword_similarity_score` with slight adjustment of reciprocal rank of `semantic_smilarity_score`. The following signals are supported: * `semantic_similarity_score`: semantic similarity adjustment that is calculated using the embeddings generated by a proprietary Google model. This score determines how semantically similar a search query is to a document. * `keyword_similarity_score`: keyword match adjustment uses the Best Match 25 (BM25) ranking function. This score is calculated using a probabilistic model to estimate the probability that a document is relevant to a given query. * `relevance_score`: semantic relevance adjustment that uses a proprietary Google model to determine the meaning and intent behind a user's query in context with the content in the documents. * `pctr_rank`: predicted conversion rate adjustment as a rank use predicted Click-through rate (pCTR) to gauge the relevance and attractiveness of a search result from a user's perspective. A higher pCTR suggests that the result is more likely to satisfy the user's query and intent, making it a valuable signal for ranking. * `freshness_rank`: freshness adjustment as a rank * `document_age`: The time in hours elapsed since the document was last updated, a floating-point number (e.g., 0.25 means 15 minutes). * `topicality_rank`: topicality adjustment as a rank. Uses proprietary Google model to determine the keyword-based overlap between the query and the document. * `base_rank`: the default rank of the result * `media_actor_match`: whether the media actor matches the query * `media_director_match`: whether the media director matches the query * `media_genre_match`: whether the media genre matches the query * `media_language_match`: whether the media language matches the query * `media_title_match`: whether the media title matches the query * `media_prefix_similarity_rank`: prefix similarity rank for media results * `media_semantic_similarity_rank`: semantic similarity rank for media results "rankingExpressionBackend": "A String", # Optional. The backend to use for the ranking expression evaluation. "regionCode": "A String", # The Unicode country/region code (CLDR) of a location, such as "US" and "419". For more information, see [Standard fields](https://cloud.google.com/apis/design/standard_fields). If set, then results will be boosted based on the region_code provided. "relevanceFilterSpec": { # Relevance filtering specification. # Optional. The granular relevance filtering specification. If not specified, the global `relevance_threshold` will be used for all sub-searches. If specified, this overrides the global `relevance_threshold` to use thresholds on a per sub-search basis. This feature is currently supported only for custom and site search. diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.html index a49d7bac1f..17b84f0ce0 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.html @@ -228,10 +228,11 @@

Method Details

"externalId": "A String", # The unique 3P ID(external_id) of the entity (user or group). "groupMetadata": { # Metadata corresponding to the external group. # Metadata corresponding to the external user. }, + "subject": "A String", # Output only. Represents the canonical IAM subject identifier (for users) or group identifier (for groups), derived from the workforce-pool claim mapping. Falls back to custom logic if not set. This must be used for IAM bindings. "userMetadata": { # Metadata corresponding to the external user. # Metadata corresponding to the external user. "familyName": "A String", # The user's family name. "givenName": "A String", # The user's given name. - "primaryEmail": "A String", # The user's primary email address. + "primaryEmail": "A String", # The user's primary email address. Do not use this for IAM bindings. Use ExternalIdentity.subject. }, }, ], @@ -1179,7 +1180,7 @@

Method Details

"schemaOrgPaths": [ # Field paths for indexing custom attribute from schema.org data. More details of schema.org and its defined types can be found at [schema.org](https://schema.org). It is only used on advanced site search schema. Currently only support full path from root. The full path to a field is constructed by concatenating field names, starting from `_root`, with a period `.` as the delimiter. Examples: * Publish date of the root: _root.datePublished * Publish date of the reviews: _root.review.datePublished "A String", ], - "searchableFieldImportance": "A String", # Optional. Specifies the importance of the field when `searchable_option` is `SEARCHABLE_ENABLED`. If `searchable_option` is `SEARCHABLE_DISABLED`, this field is ignored. If `searchable_option` is `SEARCHABLE_ENABLED` and this is `SEARCHABLE_FIELD_IMPORTANCE_UNSPECIFIED`, it behaves as `DEFAULT_IMPORTANCE`. + "searchableFieldImportance": "A String", # Optional. Specifies the importance of the field when `searchable_option` is `SEARCHABLE_ENABLED`. If `searchable_option` is `SEARCHABLE_DISABLED`, this field is ignored. If `searchable_option` is `SEARCHABLE_ENABLED` and this is `SEARCHABLE_FIELD_IMPORTANCE_UNSPECIFIED`, it behaves as `DEFAULT_IMPORTANCE`. For more information, see [Weight searchable fields](https://cloud.google.com/generative-ai-app-builder/docs/configure-field-settings#weight-search). "searchableOption": "A String", # If searchable_option is SEARCHABLE_ENABLED, field values are searchable by text queries in SearchService.Search. If SEARCHABLE_ENABLED but field type is numerical, field values will not be searchable by text queries in SearchService.Search, as there are no text values associated to numerical fields. If searchable_option is unset, the server behavior defaults to SEARCHABLE_DISABLED for fields that support setting searchable options. Only `string` fields that have no key property mapping support setting searchable_option. For those fields that do not support setting searchable options, the server will skip searchable option setting, and setting searchable_option for those fields will throw `INVALID_ARGUMENT` error. }, ], @@ -1462,7 +1463,7 @@

Method Details

"schemaOrgPaths": [ # Field paths for indexing custom attribute from schema.org data. More details of schema.org and its defined types can be found at [schema.org](https://schema.org). It is only used on advanced site search schema. Currently only support full path from root. The full path to a field is constructed by concatenating field names, starting from `_root`, with a period `.` as the delimiter. Examples: * Publish date of the root: _root.datePublished * Publish date of the reviews: _root.review.datePublished "A String", ], - "searchableFieldImportance": "A String", # Optional. Specifies the importance of the field when `searchable_option` is `SEARCHABLE_ENABLED`. If `searchable_option` is `SEARCHABLE_DISABLED`, this field is ignored. If `searchable_option` is `SEARCHABLE_ENABLED` and this is `SEARCHABLE_FIELD_IMPORTANCE_UNSPECIFIED`, it behaves as `DEFAULT_IMPORTANCE`. + "searchableFieldImportance": "A String", # Optional. Specifies the importance of the field when `searchable_option` is `SEARCHABLE_ENABLED`. If `searchable_option` is `SEARCHABLE_DISABLED`, this field is ignored. If `searchable_option` is `SEARCHABLE_ENABLED` and this is `SEARCHABLE_FIELD_IMPORTANCE_UNSPECIFIED`, it behaves as `DEFAULT_IMPORTANCE`. For more information, see [Weight searchable fields](https://cloud.google.com/generative-ai-app-builder/docs/configure-field-settings#weight-search). "searchableOption": "A String", # If searchable_option is SEARCHABLE_ENABLED, field values are searchable by text queries in SearchService.Search. If SEARCHABLE_ENABLED but field type is numerical, field values will not be searchable by text queries in SearchService.Search, as there are no text values associated to numerical fields. If searchable_option is unset, the server behavior defaults to SEARCHABLE_DISABLED for fields that support setting searchable options. Only `string` fields that have no key property mapping support setting searchable_option. For those fields that do not support setting searchable options, the server will skip searchable option setting, and setting searchable_option for those fields will throw `INVALID_ARGUMENT` error. }, ], diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.html b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.html index 4f74868d3f..3d66e459e5 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.html @@ -381,7 +381,7 @@

Method Details

}, }, "workspaceConfig": { # Config to store data store type configuration for workspace data # Config to store data store type configuration for workspace data. This must be set when DataStore.content_config is set as DataStore.ContentConfig.GOOGLE_WORKSPACE. - "dasherCustomerId": "A String", # Obfuscated Dasher customer ID. + "dasherCustomerId": "A String", # Output only. Obfuscated Dasher customer ID. Derived by the server from the project's GCP organization at data store creation time; any value supplied in the request payload is ignored. "superAdminEmailAddress": "A String", # Optional. The super admin email address for the workspace that will be used for access token generation. For now we only use it for Native Google Drive connector data ingestion. "superAdminServiceAccount": "A String", # Optional. The super admin service account for the workspace that will be used for access token generation. For now we only use it for Native Google Drive connector data ingestion. "type": "A String", # The Google Workspace data source. @@ -632,7 +632,7 @@

Method Details

}, }, "workspaceConfig": { # Config to store data store type configuration for workspace data # Config to store data store type configuration for workspace data. This must be set when DataStore.content_config is set as DataStore.ContentConfig.GOOGLE_WORKSPACE. - "dasherCustomerId": "A String", # Obfuscated Dasher customer ID. + "dasherCustomerId": "A String", # Output only. Obfuscated Dasher customer ID. Derived by the server from the project's GCP organization at data store creation time; any value supplied in the request payload is ignored. "superAdminEmailAddress": "A String", # Optional. The super admin email address for the workspace that will be used for access token generation. For now we only use it for Native Google Drive connector data ingestion. "superAdminServiceAccount": "A String", # Optional. The super admin service account for the workspace that will be used for access token generation. For now we only use it for Native Google Drive connector data ingestion. "type": "A String", # The Google Workspace data source. @@ -839,7 +839,7 @@

Method Details

}, }, "workspaceConfig": { # Config to store data store type configuration for workspace data # Config to store data store type configuration for workspace data. This must be set when DataStore.content_config is set as DataStore.ContentConfig.GOOGLE_WORKSPACE. - "dasherCustomerId": "A String", # Obfuscated Dasher customer ID. + "dasherCustomerId": "A String", # Output only. Obfuscated Dasher customer ID. Derived by the server from the project's GCP organization at data store creation time; any value supplied in the request payload is ignored. "superAdminEmailAddress": "A String", # Optional. The super admin email address for the workspace that will be used for access token generation. For now we only use it for Native Google Drive connector data ingestion. "superAdminServiceAccount": "A String", # Optional. The super admin service account for the workspace that will be used for access token generation. For now we only use it for Native Google Drive connector data ingestion. "type": "A String", # The Google Workspace data source. @@ -1034,7 +1034,7 @@

Method Details

}, }, "workspaceConfig": { # Config to store data store type configuration for workspace data # Config to store data store type configuration for workspace data. This must be set when DataStore.content_config is set as DataStore.ContentConfig.GOOGLE_WORKSPACE. - "dasherCustomerId": "A String", # Obfuscated Dasher customer ID. + "dasherCustomerId": "A String", # Output only. Obfuscated Dasher customer ID. Derived by the server from the project's GCP organization at data store creation time; any value supplied in the request payload is ignored. "superAdminEmailAddress": "A String", # Optional. The super admin email address for the workspace that will be used for access token generation. For now we only use it for Native Google Drive connector data ingestion. "superAdminServiceAccount": "A String", # Optional. The super admin service account for the workspace that will be used for access token generation. For now we only use it for Native Google Drive connector data ingestion. "type": "A String", # The Google Workspace data source. @@ -1211,7 +1211,7 @@

Method Details

}, }, "workspaceConfig": { # Config to store data store type configuration for workspace data # Config to store data store type configuration for workspace data. This must be set when DataStore.content_config is set as DataStore.ContentConfig.GOOGLE_WORKSPACE. - "dasherCustomerId": "A String", # Obfuscated Dasher customer ID. + "dasherCustomerId": "A String", # Output only. Obfuscated Dasher customer ID. Derived by the server from the project's GCP organization at data store creation time; any value supplied in the request payload is ignored. "superAdminEmailAddress": "A String", # Optional. The super admin email address for the workspace that will be used for access token generation. For now we only use it for Native Google Drive connector data ingestion. "superAdminServiceAccount": "A String", # Optional. The super admin service account for the workspace that will be used for access token generation. For now we only use it for Native Google Drive connector data ingestion. "type": "A String", # The Google Workspace data source. diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.servingConfigs.html b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.servingConfigs.html index 1f4589cce1..556f562cdd 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.servingConfigs.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.servingConfigs.html @@ -1884,7 +1884,7 @@

Method Details

"condition": "A String", # The condition under which query expansion should occur. Default to Condition.DISABLED. "pinUnexpandedResults": True or False, # Whether to pin unexpanded results. If this field is set to true, unexpanded products are always at the top of the search results, followed by the expanded results. }, - "rankingExpression": "A String", # Optional. The ranking expression controls the customized ranking on retrieval documents. This overrides ServingConfig.ranking_expression. The syntax and supported features depend on the `ranking_expression_backend` value. If `ranking_expression_backend` is not provided, it defaults to `RANK_BY_EMBEDDING`. If ranking_expression_backend is not provided or set to `RANK_BY_EMBEDDING`, it should be a single function or multiple functions that are joined by "+". * ranking_expression = function, { " + ", function }; Supported functions: * double * relevance_score * double * dotProduct(embedding_field_path) Function variables: * `relevance_score`: pre-defined keywords, used for measure relevance between query and document. * `embedding_field_path`: the document embedding field used with query embedding vector. * `dotProduct`: embedding function between `embedding_field_path` and query embedding vector. Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`. If ranking_expression_backend is set to `RANK_BY_FORMULA`, the following expression types (and combinations of those chained using + or * operators) are supported: * `double` * `signal` * `log(signal)` * `exp(signal)` * `rr(signal, double > 0)` -- reciprocal rank transformation with second argument being a denominator constant. * `is_nan(signal)` -- returns 0 if signal is NaN, 1 otherwise. * `fill_nan(signal1, signal2 | double)` -- if signal1 is NaN, returns signal2 | double, else returns signal1. Here are a few examples of ranking formulas that use the supported ranking expression types: - `0.2 * semantic_similarity_score + 0.8 * log(keyword_similarity_score)` -- mostly rank by the logarithm of `keyword_similarity_score` with slight `semantic_smilarity_score` adjustment. - `0.2 * exp(fill_nan(semantic_similarity_score, 0)) + 0.3 * is_nan(keyword_similarity_score)` -- rank by the exponent of `semantic_similarity_score` filling the value with 0 if it's NaN, also add constant 0.3 adjustment to the final score if `semantic_similarity_score` is NaN. - `0.2 * rr(semantic_similarity_score, 16) + 0.8 * rr(keyword_similarity_score, 16)` -- mostly rank by the reciprocal rank of `keyword_similarity_score` with slight adjustment of reciprocal rank of `semantic_smilarity_score`. The following signals are supported: * `semantic_similarity_score`: semantic similarity adjustment that is calculated using the embeddings generated by a proprietary Google model. This score determines how semantically similar a search query is to a document. * `keyword_similarity_score`: keyword match adjustment uses the Best Match 25 (BM25) ranking function. This score is calculated using a probabilistic model to estimate the probability that a document is relevant to a given query. * `relevance_score`: semantic relevance adjustment that uses a proprietary Google model to determine the meaning and intent behind a user's query in context with the content in the documents. * `pctr_rank`: predicted conversion rate adjustment as a rank use predicted Click-through rate (pCTR) to gauge the relevance and attractiveness of a search result from a user's perspective. A higher pCTR suggests that the result is more likely to satisfy the user's query and intent, making it a valuable signal for ranking. * `freshness_rank`: freshness adjustment as a rank * `document_age`: The time in hours elapsed since the document was last updated, a floating-point number (e.g., 0.25 means 15 minutes). * `topicality_rank`: topicality adjustment as a rank. Uses proprietary Google model to determine the keyword-based overlap between the query and the document. * `base_rank`: the default rank of the result + "rankingExpression": "A String", # Optional. The ranking expression controls the customized ranking on retrieval documents. This overrides ServingConfig.ranking_expression. The syntax and supported features depend on the `ranking_expression_backend` value. If `ranking_expression_backend` is not provided, it defaults to `RANK_BY_EMBEDDING`. If ranking_expression_backend is not provided or set to `RANK_BY_EMBEDDING`, it should be a single function or multiple functions that are joined by "+". * ranking_expression = function, { " + ", function }; Supported functions: * double * relevance_score * double * dotProduct(embedding_field_path) Function variables: * `relevance_score`: pre-defined keywords, used for measure relevance between query and document. * `embedding_field_path`: the document embedding field used with query embedding vector. * `dotProduct`: embedding function between `embedding_field_path` and query embedding vector. Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`. If ranking_expression_backend is set to `RANK_BY_FORMULA`, the following expression types (and combinations of those chained using + or * operators) are supported: * `double` * `signal` * `log(signal)` * `exp(signal)` * `rr(signal, double > 0)` -- reciprocal rank transformation with second argument being a denominator constant. * `is_nan(signal)` -- returns 0 if signal is NaN, 1 otherwise. * `fill_nan(signal1, signal2 | double)` -- if signal1 is NaN, returns signal2 | double, else returns signal1. Here are a few examples of ranking formulas that use the supported ranking expression types: - `0.2 * semantic_similarity_score + 0.8 * log(keyword_similarity_score)` -- mostly rank by the logarithm of `keyword_similarity_score` with slight `semantic_smilarity_score` adjustment. - `0.2 * exp(fill_nan(semantic_similarity_score, 0)) + 0.3 * is_nan(keyword_similarity_score)` -- rank by the exponent of `semantic_similarity_score` filling the value with 0 if it's NaN, also add constant 0.3 adjustment to the final score if `semantic_similarity_score` is NaN. - `0.2 * rr(semantic_similarity_score, 16) + 0.8 * rr(keyword_similarity_score, 16)` -- mostly rank by the reciprocal rank of `keyword_similarity_score` with slight adjustment of reciprocal rank of `semantic_smilarity_score`. The following signals are supported: * `semantic_similarity_score`: semantic similarity adjustment that is calculated using the embeddings generated by a proprietary Google model. This score determines how semantically similar a search query is to a document. * `keyword_similarity_score`: keyword match adjustment uses the Best Match 25 (BM25) ranking function. This score is calculated using a probabilistic model to estimate the probability that a document is relevant to a given query. * `relevance_score`: semantic relevance adjustment that uses a proprietary Google model to determine the meaning and intent behind a user's query in context with the content in the documents. * `pctr_rank`: predicted conversion rate adjustment as a rank use predicted Click-through rate (pCTR) to gauge the relevance and attractiveness of a search result from a user's perspective. A higher pCTR suggests that the result is more likely to satisfy the user's query and intent, making it a valuable signal for ranking. * `freshness_rank`: freshness adjustment as a rank * `document_age`: The time in hours elapsed since the document was last updated, a floating-point number (e.g., 0.25 means 15 minutes). * `topicality_rank`: topicality adjustment as a rank. Uses proprietary Google model to determine the keyword-based overlap between the query and the document. * `base_rank`: the default rank of the result * `media_actor_match`: whether the media actor matches the query * `media_director_match`: whether the media director matches the query * `media_genre_match`: whether the media genre matches the query * `media_language_match`: whether the media language matches the query * `media_title_match`: whether the media title matches the query * `media_prefix_similarity_rank`: prefix similarity rank for media results * `media_semantic_similarity_rank`: semantic similarity rank for media results "rankingExpressionBackend": "A String", # Optional. The backend to use for the ranking expression evaluation. "regionCode": "A String", # The Unicode country/region code (CLDR) of a location, such as "US" and "419". For more information, see [Standard fields](https://cloud.google.com/apis/design/standard_fields). If set, then results will be boosted based on the region_code provided. "relevanceFilterSpec": { # Relevance filtering specification. # Optional. The granular relevance filtering specification. If not specified, the global `relevance_threshold` will be used for all sub-searches. If specified, this overrides the global `relevance_threshold` to use thresholds on a per sub-search basis. This feature is currently supported only for custom and site search. @@ -2547,7 +2547,7 @@

Method Details

"condition": "A String", # The condition under which query expansion should occur. Default to Condition.DISABLED. "pinUnexpandedResults": True or False, # Whether to pin unexpanded results. If this field is set to true, unexpanded products are always at the top of the search results, followed by the expanded results. }, - "rankingExpression": "A String", # Optional. The ranking expression controls the customized ranking on retrieval documents. This overrides ServingConfig.ranking_expression. The syntax and supported features depend on the `ranking_expression_backend` value. If `ranking_expression_backend` is not provided, it defaults to `RANK_BY_EMBEDDING`. If ranking_expression_backend is not provided or set to `RANK_BY_EMBEDDING`, it should be a single function or multiple functions that are joined by "+". * ranking_expression = function, { " + ", function }; Supported functions: * double * relevance_score * double * dotProduct(embedding_field_path) Function variables: * `relevance_score`: pre-defined keywords, used for measure relevance between query and document. * `embedding_field_path`: the document embedding field used with query embedding vector. * `dotProduct`: embedding function between `embedding_field_path` and query embedding vector. Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`. If ranking_expression_backend is set to `RANK_BY_FORMULA`, the following expression types (and combinations of those chained using + or * operators) are supported: * `double` * `signal` * `log(signal)` * `exp(signal)` * `rr(signal, double > 0)` -- reciprocal rank transformation with second argument being a denominator constant. * `is_nan(signal)` -- returns 0 if signal is NaN, 1 otherwise. * `fill_nan(signal1, signal2 | double)` -- if signal1 is NaN, returns signal2 | double, else returns signal1. Here are a few examples of ranking formulas that use the supported ranking expression types: - `0.2 * semantic_similarity_score + 0.8 * log(keyword_similarity_score)` -- mostly rank by the logarithm of `keyword_similarity_score` with slight `semantic_smilarity_score` adjustment. - `0.2 * exp(fill_nan(semantic_similarity_score, 0)) + 0.3 * is_nan(keyword_similarity_score)` -- rank by the exponent of `semantic_similarity_score` filling the value with 0 if it's NaN, also add constant 0.3 adjustment to the final score if `semantic_similarity_score` is NaN. - `0.2 * rr(semantic_similarity_score, 16) + 0.8 * rr(keyword_similarity_score, 16)` -- mostly rank by the reciprocal rank of `keyword_similarity_score` with slight adjustment of reciprocal rank of `semantic_smilarity_score`. The following signals are supported: * `semantic_similarity_score`: semantic similarity adjustment that is calculated using the embeddings generated by a proprietary Google model. This score determines how semantically similar a search query is to a document. * `keyword_similarity_score`: keyword match adjustment uses the Best Match 25 (BM25) ranking function. This score is calculated using a probabilistic model to estimate the probability that a document is relevant to a given query. * `relevance_score`: semantic relevance adjustment that uses a proprietary Google model to determine the meaning and intent behind a user's query in context with the content in the documents. * `pctr_rank`: predicted conversion rate adjustment as a rank use predicted Click-through rate (pCTR) to gauge the relevance and attractiveness of a search result from a user's perspective. A higher pCTR suggests that the result is more likely to satisfy the user's query and intent, making it a valuable signal for ranking. * `freshness_rank`: freshness adjustment as a rank * `document_age`: The time in hours elapsed since the document was last updated, a floating-point number (e.g., 0.25 means 15 minutes). * `topicality_rank`: topicality adjustment as a rank. Uses proprietary Google model to determine the keyword-based overlap between the query and the document. * `base_rank`: the default rank of the result + "rankingExpression": "A String", # Optional. The ranking expression controls the customized ranking on retrieval documents. This overrides ServingConfig.ranking_expression. The syntax and supported features depend on the `ranking_expression_backend` value. If `ranking_expression_backend` is not provided, it defaults to `RANK_BY_EMBEDDING`. If ranking_expression_backend is not provided or set to `RANK_BY_EMBEDDING`, it should be a single function or multiple functions that are joined by "+". * ranking_expression = function, { " + ", function }; Supported functions: * double * relevance_score * double * dotProduct(embedding_field_path) Function variables: * `relevance_score`: pre-defined keywords, used for measure relevance between query and document. * `embedding_field_path`: the document embedding field used with query embedding vector. * `dotProduct`: embedding function between `embedding_field_path` and query embedding vector. Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`. If ranking_expression_backend is set to `RANK_BY_FORMULA`, the following expression types (and combinations of those chained using + or * operators) are supported: * `double` * `signal` * `log(signal)` * `exp(signal)` * `rr(signal, double > 0)` -- reciprocal rank transformation with second argument being a denominator constant. * `is_nan(signal)` -- returns 0 if signal is NaN, 1 otherwise. * `fill_nan(signal1, signal2 | double)` -- if signal1 is NaN, returns signal2 | double, else returns signal1. Here are a few examples of ranking formulas that use the supported ranking expression types: - `0.2 * semantic_similarity_score + 0.8 * log(keyword_similarity_score)` -- mostly rank by the logarithm of `keyword_similarity_score` with slight `semantic_smilarity_score` adjustment. - `0.2 * exp(fill_nan(semantic_similarity_score, 0)) + 0.3 * is_nan(keyword_similarity_score)` -- rank by the exponent of `semantic_similarity_score` filling the value with 0 if it's NaN, also add constant 0.3 adjustment to the final score if `semantic_similarity_score` is NaN. - `0.2 * rr(semantic_similarity_score, 16) + 0.8 * rr(keyword_similarity_score, 16)` -- mostly rank by the reciprocal rank of `keyword_similarity_score` with slight adjustment of reciprocal rank of `semantic_smilarity_score`. The following signals are supported: * `semantic_similarity_score`: semantic similarity adjustment that is calculated using the embeddings generated by a proprietary Google model. This score determines how semantically similar a search query is to a document. * `keyword_similarity_score`: keyword match adjustment uses the Best Match 25 (BM25) ranking function. This score is calculated using a probabilistic model to estimate the probability that a document is relevant to a given query. * `relevance_score`: semantic relevance adjustment that uses a proprietary Google model to determine the meaning and intent behind a user's query in context with the content in the documents. * `pctr_rank`: predicted conversion rate adjustment as a rank use predicted Click-through rate (pCTR) to gauge the relevance and attractiveness of a search result from a user's perspective. A higher pCTR suggests that the result is more likely to satisfy the user's query and intent, making it a valuable signal for ranking. * `freshness_rank`: freshness adjustment as a rank * `document_age`: The time in hours elapsed since the document was last updated, a floating-point number (e.g., 0.25 means 15 minutes). * `topicality_rank`: topicality adjustment as a rank. Uses proprietary Google model to determine the keyword-based overlap between the query and the document. * `base_rank`: the default rank of the result * `media_actor_match`: whether the media actor matches the query * `media_director_match`: whether the media director matches the query * `media_genre_match`: whether the media genre matches the query * `media_language_match`: whether the media language matches the query * `media_title_match`: whether the media title matches the query * `media_prefix_similarity_rank`: prefix similarity rank for media results * `media_semantic_similarity_rank`: semantic similarity rank for media results "rankingExpressionBackend": "A String", # Optional. The backend to use for the ranking expression evaluation. "regionCode": "A String", # The Unicode country/region code (CLDR) of a location, such as "US" and "419". For more information, see [Standard fields](https://cloud.google.com/apis/design/standard_fields). If set, then results will be boosted based on the region_code provided. "relevanceFilterSpec": { # Relevance filtering specification. # Optional. The granular relevance filtering specification. If not specified, the global `relevance_threshold` will be used for all sub-searches. If specified, this overrides the global `relevance_threshold` to use thresholds on a per sub-search basis. This feature is currently supported only for custom and site search. diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.sessions.html b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.sessions.html index 69997e59aa..ce77e13e5f 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.sessions.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.sessions.html @@ -1030,7 +1030,7 @@

Method Details

Args: parent: string, Required. The data store resource name. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}` (required) filter: string, A comma-separated list of fields to filter by, in EBNF grammar. The supported fields are: * `user_pseudo_id` * `state` * `display_name` * `starred` * `is_pinned` * `labels` * `create_time` * `update_time` * `collaborative_project` Examples: * `user_pseudo_id = some_id` * `display_name = "some_name"` * `starred = true` * `is_pinned=true AND (NOT labels:hidden)` * `create_time > "1970-01-01T12:00:00Z"` * `collaborative_project = "projects/123/locations/global/collections/default_collection/engines/" "default_engine/collaborative_projects/cp1"` - orderBy: string, A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `update_time` * `create_time` * `session_name` * `is_pinned` Example: * `update_time desc` * `create_time` * `is_pinned desc,update_time desc`: list sessions by is_pinned first, then by update_time. + orderBy: string, A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `update_time` * `create_time` * `session_name` * `is_pinned` * `display_name` Example: * `update_time desc` * `create_time` * `is_pinned desc,update_time desc`: list sessions by is_pinned first, then by update_time. pageSize: integer, Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000. pageToken: string, A page token, received from a previous `ListSessions` call. Provide this to retrieve the subsequent page. x__xgafv: string, V1 error format. diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.assistants.html b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.assistants.html index a60a6413f4..f4993e6d10 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.assistants.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.assistants.html @@ -665,6 +665,12 @@

Method Details

"invocationTools": [ # The tool names of the tools that were invoked. "A String", ], + "invokedSkills": [ # The skills executed during the turn. + { # Represents a skill used during the assist call. + "displayName": "A String", # The display name of the skill. + "name": "A String", # The resource name of the skill. + }, + ], "sessionInfo": { # Information about the session. # Session information. Only included in the final StreamAssistResponse of the response stream. "session": "A String", # Name of the newly generated or continued session. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}`. }, diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.servingConfigs.html b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.servingConfigs.html index 9aabe6e08c..f9375d9889 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.servingConfigs.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.servingConfigs.html @@ -1884,7 +1884,7 @@

Method Details

"condition": "A String", # The condition under which query expansion should occur. Default to Condition.DISABLED. "pinUnexpandedResults": True or False, # Whether to pin unexpanded results. If this field is set to true, unexpanded products are always at the top of the search results, followed by the expanded results. }, - "rankingExpression": "A String", # Optional. The ranking expression controls the customized ranking on retrieval documents. This overrides ServingConfig.ranking_expression. The syntax and supported features depend on the `ranking_expression_backend` value. If `ranking_expression_backend` is not provided, it defaults to `RANK_BY_EMBEDDING`. If ranking_expression_backend is not provided or set to `RANK_BY_EMBEDDING`, it should be a single function or multiple functions that are joined by "+". * ranking_expression = function, { " + ", function }; Supported functions: * double * relevance_score * double * dotProduct(embedding_field_path) Function variables: * `relevance_score`: pre-defined keywords, used for measure relevance between query and document. * `embedding_field_path`: the document embedding field used with query embedding vector. * `dotProduct`: embedding function between `embedding_field_path` and query embedding vector. Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`. If ranking_expression_backend is set to `RANK_BY_FORMULA`, the following expression types (and combinations of those chained using + or * operators) are supported: * `double` * `signal` * `log(signal)` * `exp(signal)` * `rr(signal, double > 0)` -- reciprocal rank transformation with second argument being a denominator constant. * `is_nan(signal)` -- returns 0 if signal is NaN, 1 otherwise. * `fill_nan(signal1, signal2 | double)` -- if signal1 is NaN, returns signal2 | double, else returns signal1. Here are a few examples of ranking formulas that use the supported ranking expression types: - `0.2 * semantic_similarity_score + 0.8 * log(keyword_similarity_score)` -- mostly rank by the logarithm of `keyword_similarity_score` with slight `semantic_smilarity_score` adjustment. - `0.2 * exp(fill_nan(semantic_similarity_score, 0)) + 0.3 * is_nan(keyword_similarity_score)` -- rank by the exponent of `semantic_similarity_score` filling the value with 0 if it's NaN, also add constant 0.3 adjustment to the final score if `semantic_similarity_score` is NaN. - `0.2 * rr(semantic_similarity_score, 16) + 0.8 * rr(keyword_similarity_score, 16)` -- mostly rank by the reciprocal rank of `keyword_similarity_score` with slight adjustment of reciprocal rank of `semantic_smilarity_score`. The following signals are supported: * `semantic_similarity_score`: semantic similarity adjustment that is calculated using the embeddings generated by a proprietary Google model. This score determines how semantically similar a search query is to a document. * `keyword_similarity_score`: keyword match adjustment uses the Best Match 25 (BM25) ranking function. This score is calculated using a probabilistic model to estimate the probability that a document is relevant to a given query. * `relevance_score`: semantic relevance adjustment that uses a proprietary Google model to determine the meaning and intent behind a user's query in context with the content in the documents. * `pctr_rank`: predicted conversion rate adjustment as a rank use predicted Click-through rate (pCTR) to gauge the relevance and attractiveness of a search result from a user's perspective. A higher pCTR suggests that the result is more likely to satisfy the user's query and intent, making it a valuable signal for ranking. * `freshness_rank`: freshness adjustment as a rank * `document_age`: The time in hours elapsed since the document was last updated, a floating-point number (e.g., 0.25 means 15 minutes). * `topicality_rank`: topicality adjustment as a rank. Uses proprietary Google model to determine the keyword-based overlap between the query and the document. * `base_rank`: the default rank of the result + "rankingExpression": "A String", # Optional. The ranking expression controls the customized ranking on retrieval documents. This overrides ServingConfig.ranking_expression. The syntax and supported features depend on the `ranking_expression_backend` value. If `ranking_expression_backend` is not provided, it defaults to `RANK_BY_EMBEDDING`. If ranking_expression_backend is not provided or set to `RANK_BY_EMBEDDING`, it should be a single function or multiple functions that are joined by "+". * ranking_expression = function, { " + ", function }; Supported functions: * double * relevance_score * double * dotProduct(embedding_field_path) Function variables: * `relevance_score`: pre-defined keywords, used for measure relevance between query and document. * `embedding_field_path`: the document embedding field used with query embedding vector. * `dotProduct`: embedding function between `embedding_field_path` and query embedding vector. Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`. If ranking_expression_backend is set to `RANK_BY_FORMULA`, the following expression types (and combinations of those chained using + or * operators) are supported: * `double` * `signal` * `log(signal)` * `exp(signal)` * `rr(signal, double > 0)` -- reciprocal rank transformation with second argument being a denominator constant. * `is_nan(signal)` -- returns 0 if signal is NaN, 1 otherwise. * `fill_nan(signal1, signal2 | double)` -- if signal1 is NaN, returns signal2 | double, else returns signal1. Here are a few examples of ranking formulas that use the supported ranking expression types: - `0.2 * semantic_similarity_score + 0.8 * log(keyword_similarity_score)` -- mostly rank by the logarithm of `keyword_similarity_score` with slight `semantic_smilarity_score` adjustment. - `0.2 * exp(fill_nan(semantic_similarity_score, 0)) + 0.3 * is_nan(keyword_similarity_score)` -- rank by the exponent of `semantic_similarity_score` filling the value with 0 if it's NaN, also add constant 0.3 adjustment to the final score if `semantic_similarity_score` is NaN. - `0.2 * rr(semantic_similarity_score, 16) + 0.8 * rr(keyword_similarity_score, 16)` -- mostly rank by the reciprocal rank of `keyword_similarity_score` with slight adjustment of reciprocal rank of `semantic_smilarity_score`. The following signals are supported: * `semantic_similarity_score`: semantic similarity adjustment that is calculated using the embeddings generated by a proprietary Google model. This score determines how semantically similar a search query is to a document. * `keyword_similarity_score`: keyword match adjustment uses the Best Match 25 (BM25) ranking function. This score is calculated using a probabilistic model to estimate the probability that a document is relevant to a given query. * `relevance_score`: semantic relevance adjustment that uses a proprietary Google model to determine the meaning and intent behind a user's query in context with the content in the documents. * `pctr_rank`: predicted conversion rate adjustment as a rank use predicted Click-through rate (pCTR) to gauge the relevance and attractiveness of a search result from a user's perspective. A higher pCTR suggests that the result is more likely to satisfy the user's query and intent, making it a valuable signal for ranking. * `freshness_rank`: freshness adjustment as a rank * `document_age`: The time in hours elapsed since the document was last updated, a floating-point number (e.g., 0.25 means 15 minutes). * `topicality_rank`: topicality adjustment as a rank. Uses proprietary Google model to determine the keyword-based overlap between the query and the document. * `base_rank`: the default rank of the result * `media_actor_match`: whether the media actor matches the query * `media_director_match`: whether the media director matches the query * `media_genre_match`: whether the media genre matches the query * `media_language_match`: whether the media language matches the query * `media_title_match`: whether the media title matches the query * `media_prefix_similarity_rank`: prefix similarity rank for media results * `media_semantic_similarity_rank`: semantic similarity rank for media results "rankingExpressionBackend": "A String", # Optional. The backend to use for the ranking expression evaluation. "regionCode": "A String", # The Unicode country/region code (CLDR) of a location, such as "US" and "419". For more information, see [Standard fields](https://cloud.google.com/apis/design/standard_fields). If set, then results will be boosted based on the region_code provided. "relevanceFilterSpec": { # Relevance filtering specification. # Optional. The granular relevance filtering specification. If not specified, the global `relevance_threshold` will be used for all sub-searches. If specified, this overrides the global `relevance_threshold` to use thresholds on a per sub-search basis. This feature is currently supported only for custom and site search. @@ -2547,7 +2547,7 @@

Method Details

"condition": "A String", # The condition under which query expansion should occur. Default to Condition.DISABLED. "pinUnexpandedResults": True or False, # Whether to pin unexpanded results. If this field is set to true, unexpanded products are always at the top of the search results, followed by the expanded results. }, - "rankingExpression": "A String", # Optional. The ranking expression controls the customized ranking on retrieval documents. This overrides ServingConfig.ranking_expression. The syntax and supported features depend on the `ranking_expression_backend` value. If `ranking_expression_backend` is not provided, it defaults to `RANK_BY_EMBEDDING`. If ranking_expression_backend is not provided or set to `RANK_BY_EMBEDDING`, it should be a single function or multiple functions that are joined by "+". * ranking_expression = function, { " + ", function }; Supported functions: * double * relevance_score * double * dotProduct(embedding_field_path) Function variables: * `relevance_score`: pre-defined keywords, used for measure relevance between query and document. * `embedding_field_path`: the document embedding field used with query embedding vector. * `dotProduct`: embedding function between `embedding_field_path` and query embedding vector. Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`. If ranking_expression_backend is set to `RANK_BY_FORMULA`, the following expression types (and combinations of those chained using + or * operators) are supported: * `double` * `signal` * `log(signal)` * `exp(signal)` * `rr(signal, double > 0)` -- reciprocal rank transformation with second argument being a denominator constant. * `is_nan(signal)` -- returns 0 if signal is NaN, 1 otherwise. * `fill_nan(signal1, signal2 | double)` -- if signal1 is NaN, returns signal2 | double, else returns signal1. Here are a few examples of ranking formulas that use the supported ranking expression types: - `0.2 * semantic_similarity_score + 0.8 * log(keyword_similarity_score)` -- mostly rank by the logarithm of `keyword_similarity_score` with slight `semantic_smilarity_score` adjustment. - `0.2 * exp(fill_nan(semantic_similarity_score, 0)) + 0.3 * is_nan(keyword_similarity_score)` -- rank by the exponent of `semantic_similarity_score` filling the value with 0 if it's NaN, also add constant 0.3 adjustment to the final score if `semantic_similarity_score` is NaN. - `0.2 * rr(semantic_similarity_score, 16) + 0.8 * rr(keyword_similarity_score, 16)` -- mostly rank by the reciprocal rank of `keyword_similarity_score` with slight adjustment of reciprocal rank of `semantic_smilarity_score`. The following signals are supported: * `semantic_similarity_score`: semantic similarity adjustment that is calculated using the embeddings generated by a proprietary Google model. This score determines how semantically similar a search query is to a document. * `keyword_similarity_score`: keyword match adjustment uses the Best Match 25 (BM25) ranking function. This score is calculated using a probabilistic model to estimate the probability that a document is relevant to a given query. * `relevance_score`: semantic relevance adjustment that uses a proprietary Google model to determine the meaning and intent behind a user's query in context with the content in the documents. * `pctr_rank`: predicted conversion rate adjustment as a rank use predicted Click-through rate (pCTR) to gauge the relevance and attractiveness of a search result from a user's perspective. A higher pCTR suggests that the result is more likely to satisfy the user's query and intent, making it a valuable signal for ranking. * `freshness_rank`: freshness adjustment as a rank * `document_age`: The time in hours elapsed since the document was last updated, a floating-point number (e.g., 0.25 means 15 minutes). * `topicality_rank`: topicality adjustment as a rank. Uses proprietary Google model to determine the keyword-based overlap between the query and the document. * `base_rank`: the default rank of the result + "rankingExpression": "A String", # Optional. The ranking expression controls the customized ranking on retrieval documents. This overrides ServingConfig.ranking_expression. The syntax and supported features depend on the `ranking_expression_backend` value. If `ranking_expression_backend` is not provided, it defaults to `RANK_BY_EMBEDDING`. If ranking_expression_backend is not provided or set to `RANK_BY_EMBEDDING`, it should be a single function or multiple functions that are joined by "+". * ranking_expression = function, { " + ", function }; Supported functions: * double * relevance_score * double * dotProduct(embedding_field_path) Function variables: * `relevance_score`: pre-defined keywords, used for measure relevance between query and document. * `embedding_field_path`: the document embedding field used with query embedding vector. * `dotProduct`: embedding function between `embedding_field_path` and query embedding vector. Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`. If ranking_expression_backend is set to `RANK_BY_FORMULA`, the following expression types (and combinations of those chained using + or * operators) are supported: * `double` * `signal` * `log(signal)` * `exp(signal)` * `rr(signal, double > 0)` -- reciprocal rank transformation with second argument being a denominator constant. * `is_nan(signal)` -- returns 0 if signal is NaN, 1 otherwise. * `fill_nan(signal1, signal2 | double)` -- if signal1 is NaN, returns signal2 | double, else returns signal1. Here are a few examples of ranking formulas that use the supported ranking expression types: - `0.2 * semantic_similarity_score + 0.8 * log(keyword_similarity_score)` -- mostly rank by the logarithm of `keyword_similarity_score` with slight `semantic_smilarity_score` adjustment. - `0.2 * exp(fill_nan(semantic_similarity_score, 0)) + 0.3 * is_nan(keyword_similarity_score)` -- rank by the exponent of `semantic_similarity_score` filling the value with 0 if it's NaN, also add constant 0.3 adjustment to the final score if `semantic_similarity_score` is NaN. - `0.2 * rr(semantic_similarity_score, 16) + 0.8 * rr(keyword_similarity_score, 16)` -- mostly rank by the reciprocal rank of `keyword_similarity_score` with slight adjustment of reciprocal rank of `semantic_smilarity_score`. The following signals are supported: * `semantic_similarity_score`: semantic similarity adjustment that is calculated using the embeddings generated by a proprietary Google model. This score determines how semantically similar a search query is to a document. * `keyword_similarity_score`: keyword match adjustment uses the Best Match 25 (BM25) ranking function. This score is calculated using a probabilistic model to estimate the probability that a document is relevant to a given query. * `relevance_score`: semantic relevance adjustment that uses a proprietary Google model to determine the meaning and intent behind a user's query in context with the content in the documents. * `pctr_rank`: predicted conversion rate adjustment as a rank use predicted Click-through rate (pCTR) to gauge the relevance and attractiveness of a search result from a user's perspective. A higher pCTR suggests that the result is more likely to satisfy the user's query and intent, making it a valuable signal for ranking. * `freshness_rank`: freshness adjustment as a rank * `document_age`: The time in hours elapsed since the document was last updated, a floating-point number (e.g., 0.25 means 15 minutes). * `topicality_rank`: topicality adjustment as a rank. Uses proprietary Google model to determine the keyword-based overlap between the query and the document. * `base_rank`: the default rank of the result * `media_actor_match`: whether the media actor matches the query * `media_director_match`: whether the media director matches the query * `media_genre_match`: whether the media genre matches the query * `media_language_match`: whether the media language matches the query * `media_title_match`: whether the media title matches the query * `media_prefix_similarity_rank`: prefix similarity rank for media results * `media_semantic_similarity_rank`: semantic similarity rank for media results "rankingExpressionBackend": "A String", # Optional. The backend to use for the ranking expression evaluation. "regionCode": "A String", # The Unicode country/region code (CLDR) of a location, such as "US" and "419". For more information, see [Standard fields](https://cloud.google.com/apis/design/standard_fields). If set, then results will be boosted based on the region_code provided. "relevanceFilterSpec": { # Relevance filtering specification. # Optional. The granular relevance filtering specification. If not specified, the global `relevance_threshold` will be used for all sub-searches. If specified, this overrides the global `relevance_threshold` to use thresholds on a per sub-search basis. This feature is currently supported only for custom and site search. diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.sessions.html b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.sessions.html index 662eb45dd8..f5afdb2400 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.sessions.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.sessions.html @@ -1030,7 +1030,7 @@

Method Details

Args: parent: string, Required. The data store resource name. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}` (required) filter: string, A comma-separated list of fields to filter by, in EBNF grammar. The supported fields are: * `user_pseudo_id` * `state` * `display_name` * `starred` * `is_pinned` * `labels` * `create_time` * `update_time` * `collaborative_project` Examples: * `user_pseudo_id = some_id` * `display_name = "some_name"` * `starred = true` * `is_pinned=true AND (NOT labels:hidden)` * `create_time > "1970-01-01T12:00:00Z"` * `collaborative_project = "projects/123/locations/global/collections/default_collection/engines/" "default_engine/collaborative_projects/cp1"` - orderBy: string, A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `update_time` * `create_time` * `session_name` * `is_pinned` Example: * `update_time desc` * `create_time` * `is_pinned desc,update_time desc`: list sessions by is_pinned first, then by update_time. + orderBy: string, A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `update_time` * `create_time` * `session_name` * `is_pinned` * `display_name` Example: * `update_time desc` * `create_time` * `is_pinned desc,update_time desc`: list sessions by is_pinned first, then by update_time. pageSize: integer, Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000. pageToken: string, A page token, received from a previous `ListSessions` call. Provide this to retrieve the subsequent page. x__xgafv: string, V1 error format. diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.html b/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.html index a29c57cab5..ef91643faa 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.html @@ -373,7 +373,7 @@

Method Details

}, }, "workspaceConfig": { # Config to store data store type configuration for workspace data # Config to store data store type configuration for workspace data. This must be set when DataStore.content_config is set as DataStore.ContentConfig.GOOGLE_WORKSPACE. - "dasherCustomerId": "A String", # Obfuscated Dasher customer ID. + "dasherCustomerId": "A String", # Output only. Obfuscated Dasher customer ID. Derived by the server from the project's GCP organization at data store creation time; any value supplied in the request payload is ignored. "superAdminEmailAddress": "A String", # Optional. The super admin email address for the workspace that will be used for access token generation. For now we only use it for Native Google Drive connector data ingestion. "superAdminServiceAccount": "A String", # Optional. The super admin service account for the workspace that will be used for access token generation. For now we only use it for Native Google Drive connector data ingestion. "type": "A String", # The Google Workspace data source. @@ -624,7 +624,7 @@

Method Details

}, }, "workspaceConfig": { # Config to store data store type configuration for workspace data # Config to store data store type configuration for workspace data. This must be set when DataStore.content_config is set as DataStore.ContentConfig.GOOGLE_WORKSPACE. - "dasherCustomerId": "A String", # Obfuscated Dasher customer ID. + "dasherCustomerId": "A String", # Output only. Obfuscated Dasher customer ID. Derived by the server from the project's GCP organization at data store creation time; any value supplied in the request payload is ignored. "superAdminEmailAddress": "A String", # Optional. The super admin email address for the workspace that will be used for access token generation. For now we only use it for Native Google Drive connector data ingestion. "superAdminServiceAccount": "A String", # Optional. The super admin service account for the workspace that will be used for access token generation. For now we only use it for Native Google Drive connector data ingestion. "type": "A String", # The Google Workspace data source. @@ -831,7 +831,7 @@

Method Details

}, }, "workspaceConfig": { # Config to store data store type configuration for workspace data # Config to store data store type configuration for workspace data. This must be set when DataStore.content_config is set as DataStore.ContentConfig.GOOGLE_WORKSPACE. - "dasherCustomerId": "A String", # Obfuscated Dasher customer ID. + "dasherCustomerId": "A String", # Output only. Obfuscated Dasher customer ID. Derived by the server from the project's GCP organization at data store creation time; any value supplied in the request payload is ignored. "superAdminEmailAddress": "A String", # Optional. The super admin email address for the workspace that will be used for access token generation. For now we only use it for Native Google Drive connector data ingestion. "superAdminServiceAccount": "A String", # Optional. The super admin service account for the workspace that will be used for access token generation. For now we only use it for Native Google Drive connector data ingestion. "type": "A String", # The Google Workspace data source. @@ -1026,7 +1026,7 @@

Method Details

}, }, "workspaceConfig": { # Config to store data store type configuration for workspace data # Config to store data store type configuration for workspace data. This must be set when DataStore.content_config is set as DataStore.ContentConfig.GOOGLE_WORKSPACE. - "dasherCustomerId": "A String", # Obfuscated Dasher customer ID. + "dasherCustomerId": "A String", # Output only. Obfuscated Dasher customer ID. Derived by the server from the project's GCP organization at data store creation time; any value supplied in the request payload is ignored. "superAdminEmailAddress": "A String", # Optional. The super admin email address for the workspace that will be used for access token generation. For now we only use it for Native Google Drive connector data ingestion. "superAdminServiceAccount": "A String", # Optional. The super admin service account for the workspace that will be used for access token generation. For now we only use it for Native Google Drive connector data ingestion. "type": "A String", # The Google Workspace data source. @@ -1203,7 +1203,7 @@

Method Details

}, }, "workspaceConfig": { # Config to store data store type configuration for workspace data # Config to store data store type configuration for workspace data. This must be set when DataStore.content_config is set as DataStore.ContentConfig.GOOGLE_WORKSPACE. - "dasherCustomerId": "A String", # Obfuscated Dasher customer ID. + "dasherCustomerId": "A String", # Output only. Obfuscated Dasher customer ID. Derived by the server from the project's GCP organization at data store creation time; any value supplied in the request payload is ignored. "superAdminEmailAddress": "A String", # Optional. The super admin email address for the workspace that will be used for access token generation. For now we only use it for Native Google Drive connector data ingestion. "superAdminServiceAccount": "A String", # Optional. The super admin service account for the workspace that will be used for access token generation. For now we only use it for Native Google Drive connector data ingestion. "type": "A String", # The Google Workspace data source. diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.servingConfigs.html b/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.servingConfigs.html index df191921b2..8101c88394 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.servingConfigs.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.servingConfigs.html @@ -1884,7 +1884,7 @@

Method Details

"condition": "A String", # The condition under which query expansion should occur. Default to Condition.DISABLED. "pinUnexpandedResults": True or False, # Whether to pin unexpanded results. If this field is set to true, unexpanded products are always at the top of the search results, followed by the expanded results. }, - "rankingExpression": "A String", # Optional. The ranking expression controls the customized ranking on retrieval documents. This overrides ServingConfig.ranking_expression. The syntax and supported features depend on the `ranking_expression_backend` value. If `ranking_expression_backend` is not provided, it defaults to `RANK_BY_EMBEDDING`. If ranking_expression_backend is not provided or set to `RANK_BY_EMBEDDING`, it should be a single function or multiple functions that are joined by "+". * ranking_expression = function, { " + ", function }; Supported functions: * double * relevance_score * double * dotProduct(embedding_field_path) Function variables: * `relevance_score`: pre-defined keywords, used for measure relevance between query and document. * `embedding_field_path`: the document embedding field used with query embedding vector. * `dotProduct`: embedding function between `embedding_field_path` and query embedding vector. Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`. If ranking_expression_backend is set to `RANK_BY_FORMULA`, the following expression types (and combinations of those chained using + or * operators) are supported: * `double` * `signal` * `log(signal)` * `exp(signal)` * `rr(signal, double > 0)` -- reciprocal rank transformation with second argument being a denominator constant. * `is_nan(signal)` -- returns 0 if signal is NaN, 1 otherwise. * `fill_nan(signal1, signal2 | double)` -- if signal1 is NaN, returns signal2 | double, else returns signal1. Here are a few examples of ranking formulas that use the supported ranking expression types: - `0.2 * semantic_similarity_score + 0.8 * log(keyword_similarity_score)` -- mostly rank by the logarithm of `keyword_similarity_score` with slight `semantic_smilarity_score` adjustment. - `0.2 * exp(fill_nan(semantic_similarity_score, 0)) + 0.3 * is_nan(keyword_similarity_score)` -- rank by the exponent of `semantic_similarity_score` filling the value with 0 if it's NaN, also add constant 0.3 adjustment to the final score if `semantic_similarity_score` is NaN. - `0.2 * rr(semantic_similarity_score, 16) + 0.8 * rr(keyword_similarity_score, 16)` -- mostly rank by the reciprocal rank of `keyword_similarity_score` with slight adjustment of reciprocal rank of `semantic_smilarity_score`. The following signals are supported: * `semantic_similarity_score`: semantic similarity adjustment that is calculated using the embeddings generated by a proprietary Google model. This score determines how semantically similar a search query is to a document. * `keyword_similarity_score`: keyword match adjustment uses the Best Match 25 (BM25) ranking function. This score is calculated using a probabilistic model to estimate the probability that a document is relevant to a given query. * `relevance_score`: semantic relevance adjustment that uses a proprietary Google model to determine the meaning and intent behind a user's query in context with the content in the documents. * `pctr_rank`: predicted conversion rate adjustment as a rank use predicted Click-through rate (pCTR) to gauge the relevance and attractiveness of a search result from a user's perspective. A higher pCTR suggests that the result is more likely to satisfy the user's query and intent, making it a valuable signal for ranking. * `freshness_rank`: freshness adjustment as a rank * `document_age`: The time in hours elapsed since the document was last updated, a floating-point number (e.g., 0.25 means 15 minutes). * `topicality_rank`: topicality adjustment as a rank. Uses proprietary Google model to determine the keyword-based overlap between the query and the document. * `base_rank`: the default rank of the result + "rankingExpression": "A String", # Optional. The ranking expression controls the customized ranking on retrieval documents. This overrides ServingConfig.ranking_expression. The syntax and supported features depend on the `ranking_expression_backend` value. If `ranking_expression_backend` is not provided, it defaults to `RANK_BY_EMBEDDING`. If ranking_expression_backend is not provided or set to `RANK_BY_EMBEDDING`, it should be a single function or multiple functions that are joined by "+". * ranking_expression = function, { " + ", function }; Supported functions: * double * relevance_score * double * dotProduct(embedding_field_path) Function variables: * `relevance_score`: pre-defined keywords, used for measure relevance between query and document. * `embedding_field_path`: the document embedding field used with query embedding vector. * `dotProduct`: embedding function between `embedding_field_path` and query embedding vector. Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`. If ranking_expression_backend is set to `RANK_BY_FORMULA`, the following expression types (and combinations of those chained using + or * operators) are supported: * `double` * `signal` * `log(signal)` * `exp(signal)` * `rr(signal, double > 0)` -- reciprocal rank transformation with second argument being a denominator constant. * `is_nan(signal)` -- returns 0 if signal is NaN, 1 otherwise. * `fill_nan(signal1, signal2 | double)` -- if signal1 is NaN, returns signal2 | double, else returns signal1. Here are a few examples of ranking formulas that use the supported ranking expression types: - `0.2 * semantic_similarity_score + 0.8 * log(keyword_similarity_score)` -- mostly rank by the logarithm of `keyword_similarity_score` with slight `semantic_smilarity_score` adjustment. - `0.2 * exp(fill_nan(semantic_similarity_score, 0)) + 0.3 * is_nan(keyword_similarity_score)` -- rank by the exponent of `semantic_similarity_score` filling the value with 0 if it's NaN, also add constant 0.3 adjustment to the final score if `semantic_similarity_score` is NaN. - `0.2 * rr(semantic_similarity_score, 16) + 0.8 * rr(keyword_similarity_score, 16)` -- mostly rank by the reciprocal rank of `keyword_similarity_score` with slight adjustment of reciprocal rank of `semantic_smilarity_score`. The following signals are supported: * `semantic_similarity_score`: semantic similarity adjustment that is calculated using the embeddings generated by a proprietary Google model. This score determines how semantically similar a search query is to a document. * `keyword_similarity_score`: keyword match adjustment uses the Best Match 25 (BM25) ranking function. This score is calculated using a probabilistic model to estimate the probability that a document is relevant to a given query. * `relevance_score`: semantic relevance adjustment that uses a proprietary Google model to determine the meaning and intent behind a user's query in context with the content in the documents. * `pctr_rank`: predicted conversion rate adjustment as a rank use predicted Click-through rate (pCTR) to gauge the relevance and attractiveness of a search result from a user's perspective. A higher pCTR suggests that the result is more likely to satisfy the user's query and intent, making it a valuable signal for ranking. * `freshness_rank`: freshness adjustment as a rank * `document_age`: The time in hours elapsed since the document was last updated, a floating-point number (e.g., 0.25 means 15 minutes). * `topicality_rank`: topicality adjustment as a rank. Uses proprietary Google model to determine the keyword-based overlap between the query and the document. * `base_rank`: the default rank of the result * `media_actor_match`: whether the media actor matches the query * `media_director_match`: whether the media director matches the query * `media_genre_match`: whether the media genre matches the query * `media_language_match`: whether the media language matches the query * `media_title_match`: whether the media title matches the query * `media_prefix_similarity_rank`: prefix similarity rank for media results * `media_semantic_similarity_rank`: semantic similarity rank for media results "rankingExpressionBackend": "A String", # Optional. The backend to use for the ranking expression evaluation. "regionCode": "A String", # The Unicode country/region code (CLDR) of a location, such as "US" and "419". For more information, see [Standard fields](https://cloud.google.com/apis/design/standard_fields). If set, then results will be boosted based on the region_code provided. "relevanceFilterSpec": { # Relevance filtering specification. # Optional. The granular relevance filtering specification. If not specified, the global `relevance_threshold` will be used for all sub-searches. If specified, this overrides the global `relevance_threshold` to use thresholds on a per sub-search basis. This feature is currently supported only for custom and site search. @@ -2547,7 +2547,7 @@

Method Details

"condition": "A String", # The condition under which query expansion should occur. Default to Condition.DISABLED. "pinUnexpandedResults": True or False, # Whether to pin unexpanded results. If this field is set to true, unexpanded products are always at the top of the search results, followed by the expanded results. }, - "rankingExpression": "A String", # Optional. The ranking expression controls the customized ranking on retrieval documents. This overrides ServingConfig.ranking_expression. The syntax and supported features depend on the `ranking_expression_backend` value. If `ranking_expression_backend` is not provided, it defaults to `RANK_BY_EMBEDDING`. If ranking_expression_backend is not provided or set to `RANK_BY_EMBEDDING`, it should be a single function or multiple functions that are joined by "+". * ranking_expression = function, { " + ", function }; Supported functions: * double * relevance_score * double * dotProduct(embedding_field_path) Function variables: * `relevance_score`: pre-defined keywords, used for measure relevance between query and document. * `embedding_field_path`: the document embedding field used with query embedding vector. * `dotProduct`: embedding function between `embedding_field_path` and query embedding vector. Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`. If ranking_expression_backend is set to `RANK_BY_FORMULA`, the following expression types (and combinations of those chained using + or * operators) are supported: * `double` * `signal` * `log(signal)` * `exp(signal)` * `rr(signal, double > 0)` -- reciprocal rank transformation with second argument being a denominator constant. * `is_nan(signal)` -- returns 0 if signal is NaN, 1 otherwise. * `fill_nan(signal1, signal2 | double)` -- if signal1 is NaN, returns signal2 | double, else returns signal1. Here are a few examples of ranking formulas that use the supported ranking expression types: - `0.2 * semantic_similarity_score + 0.8 * log(keyword_similarity_score)` -- mostly rank by the logarithm of `keyword_similarity_score` with slight `semantic_smilarity_score` adjustment. - `0.2 * exp(fill_nan(semantic_similarity_score, 0)) + 0.3 * is_nan(keyword_similarity_score)` -- rank by the exponent of `semantic_similarity_score` filling the value with 0 if it's NaN, also add constant 0.3 adjustment to the final score if `semantic_similarity_score` is NaN. - `0.2 * rr(semantic_similarity_score, 16) + 0.8 * rr(keyword_similarity_score, 16)` -- mostly rank by the reciprocal rank of `keyword_similarity_score` with slight adjustment of reciprocal rank of `semantic_smilarity_score`. The following signals are supported: * `semantic_similarity_score`: semantic similarity adjustment that is calculated using the embeddings generated by a proprietary Google model. This score determines how semantically similar a search query is to a document. * `keyword_similarity_score`: keyword match adjustment uses the Best Match 25 (BM25) ranking function. This score is calculated using a probabilistic model to estimate the probability that a document is relevant to a given query. * `relevance_score`: semantic relevance adjustment that uses a proprietary Google model to determine the meaning and intent behind a user's query in context with the content in the documents. * `pctr_rank`: predicted conversion rate adjustment as a rank use predicted Click-through rate (pCTR) to gauge the relevance and attractiveness of a search result from a user's perspective. A higher pCTR suggests that the result is more likely to satisfy the user's query and intent, making it a valuable signal for ranking. * `freshness_rank`: freshness adjustment as a rank * `document_age`: The time in hours elapsed since the document was last updated, a floating-point number (e.g., 0.25 means 15 minutes). * `topicality_rank`: topicality adjustment as a rank. Uses proprietary Google model to determine the keyword-based overlap between the query and the document. * `base_rank`: the default rank of the result + "rankingExpression": "A String", # Optional. The ranking expression controls the customized ranking on retrieval documents. This overrides ServingConfig.ranking_expression. The syntax and supported features depend on the `ranking_expression_backend` value. If `ranking_expression_backend` is not provided, it defaults to `RANK_BY_EMBEDDING`. If ranking_expression_backend is not provided or set to `RANK_BY_EMBEDDING`, it should be a single function or multiple functions that are joined by "+". * ranking_expression = function, { " + ", function }; Supported functions: * double * relevance_score * double * dotProduct(embedding_field_path) Function variables: * `relevance_score`: pre-defined keywords, used for measure relevance between query and document. * `embedding_field_path`: the document embedding field used with query embedding vector. * `dotProduct`: embedding function between `embedding_field_path` and query embedding vector. Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`. If ranking_expression_backend is set to `RANK_BY_FORMULA`, the following expression types (and combinations of those chained using + or * operators) are supported: * `double` * `signal` * `log(signal)` * `exp(signal)` * `rr(signal, double > 0)` -- reciprocal rank transformation with second argument being a denominator constant. * `is_nan(signal)` -- returns 0 if signal is NaN, 1 otherwise. * `fill_nan(signal1, signal2 | double)` -- if signal1 is NaN, returns signal2 | double, else returns signal1. Here are a few examples of ranking formulas that use the supported ranking expression types: - `0.2 * semantic_similarity_score + 0.8 * log(keyword_similarity_score)` -- mostly rank by the logarithm of `keyword_similarity_score` with slight `semantic_smilarity_score` adjustment. - `0.2 * exp(fill_nan(semantic_similarity_score, 0)) + 0.3 * is_nan(keyword_similarity_score)` -- rank by the exponent of `semantic_similarity_score` filling the value with 0 if it's NaN, also add constant 0.3 adjustment to the final score if `semantic_similarity_score` is NaN. - `0.2 * rr(semantic_similarity_score, 16) + 0.8 * rr(keyword_similarity_score, 16)` -- mostly rank by the reciprocal rank of `keyword_similarity_score` with slight adjustment of reciprocal rank of `semantic_smilarity_score`. The following signals are supported: * `semantic_similarity_score`: semantic similarity adjustment that is calculated using the embeddings generated by a proprietary Google model. This score determines how semantically similar a search query is to a document. * `keyword_similarity_score`: keyword match adjustment uses the Best Match 25 (BM25) ranking function. This score is calculated using a probabilistic model to estimate the probability that a document is relevant to a given query. * `relevance_score`: semantic relevance adjustment that uses a proprietary Google model to determine the meaning and intent behind a user's query in context with the content in the documents. * `pctr_rank`: predicted conversion rate adjustment as a rank use predicted Click-through rate (pCTR) to gauge the relevance and attractiveness of a search result from a user's perspective. A higher pCTR suggests that the result is more likely to satisfy the user's query and intent, making it a valuable signal for ranking. * `freshness_rank`: freshness adjustment as a rank * `document_age`: The time in hours elapsed since the document was last updated, a floating-point number (e.g., 0.25 means 15 minutes). * `topicality_rank`: topicality adjustment as a rank. Uses proprietary Google model to determine the keyword-based overlap between the query and the document. * `base_rank`: the default rank of the result * `media_actor_match`: whether the media actor matches the query * `media_director_match`: whether the media director matches the query * `media_genre_match`: whether the media genre matches the query * `media_language_match`: whether the media language matches the query * `media_title_match`: whether the media title matches the query * `media_prefix_similarity_rank`: prefix similarity rank for media results * `media_semantic_similarity_rank`: semantic similarity rank for media results "rankingExpressionBackend": "A String", # Optional. The backend to use for the ranking expression evaluation. "regionCode": "A String", # The Unicode country/region code (CLDR) of a location, such as "US" and "419". For more information, see [Standard fields](https://cloud.google.com/apis/design/standard_fields). If set, then results will be boosted based on the region_code provided. "relevanceFilterSpec": { # Relevance filtering specification. # Optional. The granular relevance filtering specification. If not specified, the global `relevance_threshold` will be used for all sub-searches. If specified, this overrides the global `relevance_threshold` to use thresholds on a per sub-search basis. This feature is currently supported only for custom and site search. diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.sessions.html b/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.sessions.html index 407d40755c..3f5ebecb55 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.sessions.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.sessions.html @@ -1030,7 +1030,7 @@

Method Details

Args: parent: string, Required. The data store resource name. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}` (required) filter: string, A comma-separated list of fields to filter by, in EBNF grammar. The supported fields are: * `user_pseudo_id` * `state` * `display_name` * `starred` * `is_pinned` * `labels` * `create_time` * `update_time` * `collaborative_project` Examples: * `user_pseudo_id = some_id` * `display_name = "some_name"` * `starred = true` * `is_pinned=true AND (NOT labels:hidden)` * `create_time > "1970-01-01T12:00:00Z"` * `collaborative_project = "projects/123/locations/global/collections/default_collection/engines/" "default_engine/collaborative_projects/cp1"` - orderBy: string, A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `update_time` * `create_time` * `session_name` * `is_pinned` Example: * `update_time desc` * `create_time` * `is_pinned desc,update_time desc`: list sessions by is_pinned first, then by update_time. + orderBy: string, A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `update_time` * `create_time` * `session_name` * `is_pinned` * `display_name` Example: * `update_time desc` * `create_time` * `is_pinned desc,update_time desc`: list sessions by is_pinned first, then by update_time. pageSize: integer, Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000. pageToken: string, A page token, received from a previous `ListSessions` call. Provide this to retrieve the subsequent page. x__xgafv: string, V1 error format. diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.evaluations.html b/docs/dyn/discoveryengine_v1beta.projects.locations.evaluations.html index c194bff6dd..2f278953bf 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.evaluations.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.evaluations.html @@ -321,7 +321,7 @@

Method Details

"condition": "A String", # The condition under which query expansion should occur. Default to Condition.DISABLED. "pinUnexpandedResults": True or False, # Whether to pin unexpanded results. If this field is set to true, unexpanded products are always at the top of the search results, followed by the expanded results. }, - "rankingExpression": "A String", # Optional. The ranking expression controls the customized ranking on retrieval documents. This overrides ServingConfig.ranking_expression. The syntax and supported features depend on the `ranking_expression_backend` value. If `ranking_expression_backend` is not provided, it defaults to `RANK_BY_EMBEDDING`. If ranking_expression_backend is not provided or set to `RANK_BY_EMBEDDING`, it should be a single function or multiple functions that are joined by "+". * ranking_expression = function, { " + ", function }; Supported functions: * double * relevance_score * double * dotProduct(embedding_field_path) Function variables: * `relevance_score`: pre-defined keywords, used for measure relevance between query and document. * `embedding_field_path`: the document embedding field used with query embedding vector. * `dotProduct`: embedding function between `embedding_field_path` and query embedding vector. Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`. If ranking_expression_backend is set to `RANK_BY_FORMULA`, the following expression types (and combinations of those chained using + or * operators) are supported: * `double` * `signal` * `log(signal)` * `exp(signal)` * `rr(signal, double > 0)` -- reciprocal rank transformation with second argument being a denominator constant. * `is_nan(signal)` -- returns 0 if signal is NaN, 1 otherwise. * `fill_nan(signal1, signal2 | double)` -- if signal1 is NaN, returns signal2 | double, else returns signal1. Here are a few examples of ranking formulas that use the supported ranking expression types: - `0.2 * semantic_similarity_score + 0.8 * log(keyword_similarity_score)` -- mostly rank by the logarithm of `keyword_similarity_score` with slight `semantic_smilarity_score` adjustment. - `0.2 * exp(fill_nan(semantic_similarity_score, 0)) + 0.3 * is_nan(keyword_similarity_score)` -- rank by the exponent of `semantic_similarity_score` filling the value with 0 if it's NaN, also add constant 0.3 adjustment to the final score if `semantic_similarity_score` is NaN. - `0.2 * rr(semantic_similarity_score, 16) + 0.8 * rr(keyword_similarity_score, 16)` -- mostly rank by the reciprocal rank of `keyword_similarity_score` with slight adjustment of reciprocal rank of `semantic_smilarity_score`. The following signals are supported: * `semantic_similarity_score`: semantic similarity adjustment that is calculated using the embeddings generated by a proprietary Google model. This score determines how semantically similar a search query is to a document. * `keyword_similarity_score`: keyword match adjustment uses the Best Match 25 (BM25) ranking function. This score is calculated using a probabilistic model to estimate the probability that a document is relevant to a given query. * `relevance_score`: semantic relevance adjustment that uses a proprietary Google model to determine the meaning and intent behind a user's query in context with the content in the documents. * `pctr_rank`: predicted conversion rate adjustment as a rank use predicted Click-through rate (pCTR) to gauge the relevance and attractiveness of a search result from a user's perspective. A higher pCTR suggests that the result is more likely to satisfy the user's query and intent, making it a valuable signal for ranking. * `freshness_rank`: freshness adjustment as a rank * `document_age`: The time in hours elapsed since the document was last updated, a floating-point number (e.g., 0.25 means 15 minutes). * `topicality_rank`: topicality adjustment as a rank. Uses proprietary Google model to determine the keyword-based overlap between the query and the document. * `base_rank`: the default rank of the result + "rankingExpression": "A String", # Optional. The ranking expression controls the customized ranking on retrieval documents. This overrides ServingConfig.ranking_expression. The syntax and supported features depend on the `ranking_expression_backend` value. If `ranking_expression_backend` is not provided, it defaults to `RANK_BY_EMBEDDING`. If ranking_expression_backend is not provided or set to `RANK_BY_EMBEDDING`, it should be a single function or multiple functions that are joined by "+". * ranking_expression = function, { " + ", function }; Supported functions: * double * relevance_score * double * dotProduct(embedding_field_path) Function variables: * `relevance_score`: pre-defined keywords, used for measure relevance between query and document. * `embedding_field_path`: the document embedding field used with query embedding vector. * `dotProduct`: embedding function between `embedding_field_path` and query embedding vector. Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`. If ranking_expression_backend is set to `RANK_BY_FORMULA`, the following expression types (and combinations of those chained using + or * operators) are supported: * `double` * `signal` * `log(signal)` * `exp(signal)` * `rr(signal, double > 0)` -- reciprocal rank transformation with second argument being a denominator constant. * `is_nan(signal)` -- returns 0 if signal is NaN, 1 otherwise. * `fill_nan(signal1, signal2 | double)` -- if signal1 is NaN, returns signal2 | double, else returns signal1. Here are a few examples of ranking formulas that use the supported ranking expression types: - `0.2 * semantic_similarity_score + 0.8 * log(keyword_similarity_score)` -- mostly rank by the logarithm of `keyword_similarity_score` with slight `semantic_smilarity_score` adjustment. - `0.2 * exp(fill_nan(semantic_similarity_score, 0)) + 0.3 * is_nan(keyword_similarity_score)` -- rank by the exponent of `semantic_similarity_score` filling the value with 0 if it's NaN, also add constant 0.3 adjustment to the final score if `semantic_similarity_score` is NaN. - `0.2 * rr(semantic_similarity_score, 16) + 0.8 * rr(keyword_similarity_score, 16)` -- mostly rank by the reciprocal rank of `keyword_similarity_score` with slight adjustment of reciprocal rank of `semantic_smilarity_score`. The following signals are supported: * `semantic_similarity_score`: semantic similarity adjustment that is calculated using the embeddings generated by a proprietary Google model. This score determines how semantically similar a search query is to a document. * `keyword_similarity_score`: keyword match adjustment uses the Best Match 25 (BM25) ranking function. This score is calculated using a probabilistic model to estimate the probability that a document is relevant to a given query. * `relevance_score`: semantic relevance adjustment that uses a proprietary Google model to determine the meaning and intent behind a user's query in context with the content in the documents. * `pctr_rank`: predicted conversion rate adjustment as a rank use predicted Click-through rate (pCTR) to gauge the relevance and attractiveness of a search result from a user's perspective. A higher pCTR suggests that the result is more likely to satisfy the user's query and intent, making it a valuable signal for ranking. * `freshness_rank`: freshness adjustment as a rank * `document_age`: The time in hours elapsed since the document was last updated, a floating-point number (e.g., 0.25 means 15 minutes). * `topicality_rank`: topicality adjustment as a rank. Uses proprietary Google model to determine the keyword-based overlap between the query and the document. * `base_rank`: the default rank of the result * `media_actor_match`: whether the media actor matches the query * `media_director_match`: whether the media director matches the query * `media_genre_match`: whether the media genre matches the query * `media_language_match`: whether the media language matches the query * `media_title_match`: whether the media title matches the query * `media_prefix_similarity_rank`: prefix similarity rank for media results * `media_semantic_similarity_rank`: semantic similarity rank for media results "rankingExpressionBackend": "A String", # Optional. The backend to use for the ranking expression evaluation. "regionCode": "A String", # The Unicode country/region code (CLDR) of a location, such as "US" and "419". For more information, see [Standard fields](https://cloud.google.com/apis/design/standard_fields). If set, then results will be boosted based on the region_code provided. "relevanceFilterSpec": { # Relevance filtering specification. # Optional. The granular relevance filtering specification. If not specified, the global `relevance_threshold` will be used for all sub-searches. If specified, this overrides the global `relevance_threshold` to use thresholds on a per sub-search basis. This feature is currently supported only for custom and site search. @@ -659,7 +659,7 @@

Method Details

"condition": "A String", # The condition under which query expansion should occur. Default to Condition.DISABLED. "pinUnexpandedResults": True or False, # Whether to pin unexpanded results. If this field is set to true, unexpanded products are always at the top of the search results, followed by the expanded results. }, - "rankingExpression": "A String", # Optional. The ranking expression controls the customized ranking on retrieval documents. This overrides ServingConfig.ranking_expression. The syntax and supported features depend on the `ranking_expression_backend` value. If `ranking_expression_backend` is not provided, it defaults to `RANK_BY_EMBEDDING`. If ranking_expression_backend is not provided or set to `RANK_BY_EMBEDDING`, it should be a single function or multiple functions that are joined by "+". * ranking_expression = function, { " + ", function }; Supported functions: * double * relevance_score * double * dotProduct(embedding_field_path) Function variables: * `relevance_score`: pre-defined keywords, used for measure relevance between query and document. * `embedding_field_path`: the document embedding field used with query embedding vector. * `dotProduct`: embedding function between `embedding_field_path` and query embedding vector. Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`. If ranking_expression_backend is set to `RANK_BY_FORMULA`, the following expression types (and combinations of those chained using + or * operators) are supported: * `double` * `signal` * `log(signal)` * `exp(signal)` * `rr(signal, double > 0)` -- reciprocal rank transformation with second argument being a denominator constant. * `is_nan(signal)` -- returns 0 if signal is NaN, 1 otherwise. * `fill_nan(signal1, signal2 | double)` -- if signal1 is NaN, returns signal2 | double, else returns signal1. Here are a few examples of ranking formulas that use the supported ranking expression types: - `0.2 * semantic_similarity_score + 0.8 * log(keyword_similarity_score)` -- mostly rank by the logarithm of `keyword_similarity_score` with slight `semantic_smilarity_score` adjustment. - `0.2 * exp(fill_nan(semantic_similarity_score, 0)) + 0.3 * is_nan(keyword_similarity_score)` -- rank by the exponent of `semantic_similarity_score` filling the value with 0 if it's NaN, also add constant 0.3 adjustment to the final score if `semantic_similarity_score` is NaN. - `0.2 * rr(semantic_similarity_score, 16) + 0.8 * rr(keyword_similarity_score, 16)` -- mostly rank by the reciprocal rank of `keyword_similarity_score` with slight adjustment of reciprocal rank of `semantic_smilarity_score`. The following signals are supported: * `semantic_similarity_score`: semantic similarity adjustment that is calculated using the embeddings generated by a proprietary Google model. This score determines how semantically similar a search query is to a document. * `keyword_similarity_score`: keyword match adjustment uses the Best Match 25 (BM25) ranking function. This score is calculated using a probabilistic model to estimate the probability that a document is relevant to a given query. * `relevance_score`: semantic relevance adjustment that uses a proprietary Google model to determine the meaning and intent behind a user's query in context with the content in the documents. * `pctr_rank`: predicted conversion rate adjustment as a rank use predicted Click-through rate (pCTR) to gauge the relevance and attractiveness of a search result from a user's perspective. A higher pCTR suggests that the result is more likely to satisfy the user's query and intent, making it a valuable signal for ranking. * `freshness_rank`: freshness adjustment as a rank * `document_age`: The time in hours elapsed since the document was last updated, a floating-point number (e.g., 0.25 means 15 minutes). * `topicality_rank`: topicality adjustment as a rank. Uses proprietary Google model to determine the keyword-based overlap between the query and the document. * `base_rank`: the default rank of the result + "rankingExpression": "A String", # Optional. The ranking expression controls the customized ranking on retrieval documents. This overrides ServingConfig.ranking_expression. The syntax and supported features depend on the `ranking_expression_backend` value. If `ranking_expression_backend` is not provided, it defaults to `RANK_BY_EMBEDDING`. If ranking_expression_backend is not provided or set to `RANK_BY_EMBEDDING`, it should be a single function or multiple functions that are joined by "+". * ranking_expression = function, { " + ", function }; Supported functions: * double * relevance_score * double * dotProduct(embedding_field_path) Function variables: * `relevance_score`: pre-defined keywords, used for measure relevance between query and document. * `embedding_field_path`: the document embedding field used with query embedding vector. * `dotProduct`: embedding function between `embedding_field_path` and query embedding vector. Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`. If ranking_expression_backend is set to `RANK_BY_FORMULA`, the following expression types (and combinations of those chained using + or * operators) are supported: * `double` * `signal` * `log(signal)` * `exp(signal)` * `rr(signal, double > 0)` -- reciprocal rank transformation with second argument being a denominator constant. * `is_nan(signal)` -- returns 0 if signal is NaN, 1 otherwise. * `fill_nan(signal1, signal2 | double)` -- if signal1 is NaN, returns signal2 | double, else returns signal1. Here are a few examples of ranking formulas that use the supported ranking expression types: - `0.2 * semantic_similarity_score + 0.8 * log(keyword_similarity_score)` -- mostly rank by the logarithm of `keyword_similarity_score` with slight `semantic_smilarity_score` adjustment. - `0.2 * exp(fill_nan(semantic_similarity_score, 0)) + 0.3 * is_nan(keyword_similarity_score)` -- rank by the exponent of `semantic_similarity_score` filling the value with 0 if it's NaN, also add constant 0.3 adjustment to the final score if `semantic_similarity_score` is NaN. - `0.2 * rr(semantic_similarity_score, 16) + 0.8 * rr(keyword_similarity_score, 16)` -- mostly rank by the reciprocal rank of `keyword_similarity_score` with slight adjustment of reciprocal rank of `semantic_smilarity_score`. The following signals are supported: * `semantic_similarity_score`: semantic similarity adjustment that is calculated using the embeddings generated by a proprietary Google model. This score determines how semantically similar a search query is to a document. * `keyword_similarity_score`: keyword match adjustment uses the Best Match 25 (BM25) ranking function. This score is calculated using a probabilistic model to estimate the probability that a document is relevant to a given query. * `relevance_score`: semantic relevance adjustment that uses a proprietary Google model to determine the meaning and intent behind a user's query in context with the content in the documents. * `pctr_rank`: predicted conversion rate adjustment as a rank use predicted Click-through rate (pCTR) to gauge the relevance and attractiveness of a search result from a user's perspective. A higher pCTR suggests that the result is more likely to satisfy the user's query and intent, making it a valuable signal for ranking. * `freshness_rank`: freshness adjustment as a rank * `document_age`: The time in hours elapsed since the document was last updated, a floating-point number (e.g., 0.25 means 15 minutes). * `topicality_rank`: topicality adjustment as a rank. Uses proprietary Google model to determine the keyword-based overlap between the query and the document. * `base_rank`: the default rank of the result * `media_actor_match`: whether the media actor matches the query * `media_director_match`: whether the media director matches the query * `media_genre_match`: whether the media genre matches the query * `media_language_match`: whether the media language matches the query * `media_title_match`: whether the media title matches the query * `media_prefix_similarity_rank`: prefix similarity rank for media results * `media_semantic_similarity_rank`: semantic similarity rank for media results "rankingExpressionBackend": "A String", # Optional. The backend to use for the ranking expression evaluation. "regionCode": "A String", # The Unicode country/region code (CLDR) of a location, such as "US" and "419". For more information, see [Standard fields](https://cloud.google.com/apis/design/standard_fields). If set, then results will be boosted based on the region_code provided. "relevanceFilterSpec": { # Relevance filtering specification. # Optional. The granular relevance filtering specification. If not specified, the global `relevance_threshold` will be used for all sub-searches. If specified, this overrides the global `relevance_threshold` to use thresholds on a per sub-search basis. This feature is currently supported only for custom and site search. @@ -973,7 +973,7 @@

Method Details

"condition": "A String", # The condition under which query expansion should occur. Default to Condition.DISABLED. "pinUnexpandedResults": True or False, # Whether to pin unexpanded results. If this field is set to true, unexpanded products are always at the top of the search results, followed by the expanded results. }, - "rankingExpression": "A String", # Optional. The ranking expression controls the customized ranking on retrieval documents. This overrides ServingConfig.ranking_expression. The syntax and supported features depend on the `ranking_expression_backend` value. If `ranking_expression_backend` is not provided, it defaults to `RANK_BY_EMBEDDING`. If ranking_expression_backend is not provided or set to `RANK_BY_EMBEDDING`, it should be a single function or multiple functions that are joined by "+". * ranking_expression = function, { " + ", function }; Supported functions: * double * relevance_score * double * dotProduct(embedding_field_path) Function variables: * `relevance_score`: pre-defined keywords, used for measure relevance between query and document. * `embedding_field_path`: the document embedding field used with query embedding vector. * `dotProduct`: embedding function between `embedding_field_path` and query embedding vector. Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`. If ranking_expression_backend is set to `RANK_BY_FORMULA`, the following expression types (and combinations of those chained using + or * operators) are supported: * `double` * `signal` * `log(signal)` * `exp(signal)` * `rr(signal, double > 0)` -- reciprocal rank transformation with second argument being a denominator constant. * `is_nan(signal)` -- returns 0 if signal is NaN, 1 otherwise. * `fill_nan(signal1, signal2 | double)` -- if signal1 is NaN, returns signal2 | double, else returns signal1. Here are a few examples of ranking formulas that use the supported ranking expression types: - `0.2 * semantic_similarity_score + 0.8 * log(keyword_similarity_score)` -- mostly rank by the logarithm of `keyword_similarity_score` with slight `semantic_smilarity_score` adjustment. - `0.2 * exp(fill_nan(semantic_similarity_score, 0)) + 0.3 * is_nan(keyword_similarity_score)` -- rank by the exponent of `semantic_similarity_score` filling the value with 0 if it's NaN, also add constant 0.3 adjustment to the final score if `semantic_similarity_score` is NaN. - `0.2 * rr(semantic_similarity_score, 16) + 0.8 * rr(keyword_similarity_score, 16)` -- mostly rank by the reciprocal rank of `keyword_similarity_score` with slight adjustment of reciprocal rank of `semantic_smilarity_score`. The following signals are supported: * `semantic_similarity_score`: semantic similarity adjustment that is calculated using the embeddings generated by a proprietary Google model. This score determines how semantically similar a search query is to a document. * `keyword_similarity_score`: keyword match adjustment uses the Best Match 25 (BM25) ranking function. This score is calculated using a probabilistic model to estimate the probability that a document is relevant to a given query. * `relevance_score`: semantic relevance adjustment that uses a proprietary Google model to determine the meaning and intent behind a user's query in context with the content in the documents. * `pctr_rank`: predicted conversion rate adjustment as a rank use predicted Click-through rate (pCTR) to gauge the relevance and attractiveness of a search result from a user's perspective. A higher pCTR suggests that the result is more likely to satisfy the user's query and intent, making it a valuable signal for ranking. * `freshness_rank`: freshness adjustment as a rank * `document_age`: The time in hours elapsed since the document was last updated, a floating-point number (e.g., 0.25 means 15 minutes). * `topicality_rank`: topicality adjustment as a rank. Uses proprietary Google model to determine the keyword-based overlap between the query and the document. * `base_rank`: the default rank of the result + "rankingExpression": "A String", # Optional. The ranking expression controls the customized ranking on retrieval documents. This overrides ServingConfig.ranking_expression. The syntax and supported features depend on the `ranking_expression_backend` value. If `ranking_expression_backend` is not provided, it defaults to `RANK_BY_EMBEDDING`. If ranking_expression_backend is not provided or set to `RANK_BY_EMBEDDING`, it should be a single function or multiple functions that are joined by "+". * ranking_expression = function, { " + ", function }; Supported functions: * double * relevance_score * double * dotProduct(embedding_field_path) Function variables: * `relevance_score`: pre-defined keywords, used for measure relevance between query and document. * `embedding_field_path`: the document embedding field used with query embedding vector. * `dotProduct`: embedding function between `embedding_field_path` and query embedding vector. Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`. If ranking_expression_backend is set to `RANK_BY_FORMULA`, the following expression types (and combinations of those chained using + or * operators) are supported: * `double` * `signal` * `log(signal)` * `exp(signal)` * `rr(signal, double > 0)` -- reciprocal rank transformation with second argument being a denominator constant. * `is_nan(signal)` -- returns 0 if signal is NaN, 1 otherwise. * `fill_nan(signal1, signal2 | double)` -- if signal1 is NaN, returns signal2 | double, else returns signal1. Here are a few examples of ranking formulas that use the supported ranking expression types: - `0.2 * semantic_similarity_score + 0.8 * log(keyword_similarity_score)` -- mostly rank by the logarithm of `keyword_similarity_score` with slight `semantic_smilarity_score` adjustment. - `0.2 * exp(fill_nan(semantic_similarity_score, 0)) + 0.3 * is_nan(keyword_similarity_score)` -- rank by the exponent of `semantic_similarity_score` filling the value with 0 if it's NaN, also add constant 0.3 adjustment to the final score if `semantic_similarity_score` is NaN. - `0.2 * rr(semantic_similarity_score, 16) + 0.8 * rr(keyword_similarity_score, 16)` -- mostly rank by the reciprocal rank of `keyword_similarity_score` with slight adjustment of reciprocal rank of `semantic_smilarity_score`. The following signals are supported: * `semantic_similarity_score`: semantic similarity adjustment that is calculated using the embeddings generated by a proprietary Google model. This score determines how semantically similar a search query is to a document. * `keyword_similarity_score`: keyword match adjustment uses the Best Match 25 (BM25) ranking function. This score is calculated using a probabilistic model to estimate the probability that a document is relevant to a given query. * `relevance_score`: semantic relevance adjustment that uses a proprietary Google model to determine the meaning and intent behind a user's query in context with the content in the documents. * `pctr_rank`: predicted conversion rate adjustment as a rank use predicted Click-through rate (pCTR) to gauge the relevance and attractiveness of a search result from a user's perspective. A higher pCTR suggests that the result is more likely to satisfy the user's query and intent, making it a valuable signal for ranking. * `freshness_rank`: freshness adjustment as a rank * `document_age`: The time in hours elapsed since the document was last updated, a floating-point number (e.g., 0.25 means 15 minutes). * `topicality_rank`: topicality adjustment as a rank. Uses proprietary Google model to determine the keyword-based overlap between the query and the document. * `base_rank`: the default rank of the result * `media_actor_match`: whether the media actor matches the query * `media_director_match`: whether the media director matches the query * `media_genre_match`: whether the media genre matches the query * `media_language_match`: whether the media language matches the query * `media_title_match`: whether the media title matches the query * `media_prefix_similarity_rank`: prefix similarity rank for media results * `media_semantic_similarity_rank`: semantic similarity rank for media results "rankingExpressionBackend": "A String", # Optional. The backend to use for the ranking expression evaluation. "regionCode": "A String", # The Unicode country/region code (CLDR) of a location, such as "US" and "419". For more information, see [Standard fields](https://cloud.google.com/apis/design/standard_fields). If set, then results will be boosted based on the region_code provided. "relevanceFilterSpec": { # Relevance filtering specification. # Optional. The granular relevance filtering specification. If not specified, the global `relevance_threshold` will be used for all sub-searches. If specified, this overrides the global `relevance_threshold` to use thresholds on a per sub-search basis. This feature is currently supported only for custom and site search. diff --git a/docs/dyn/dlp_v2.organizations.inspectTemplates.html b/docs/dyn/dlp_v2.organizations.inspectTemplates.html index 86824cb97b..5195a2b5c9 100644 --- a/docs/dyn/dlp_v2.organizations.inspectTemplates.html +++ b/docs/dyn/dlp_v2.organizations.inspectTemplates.html @@ -112,7 +112,7 @@

Method Details

{ # Request message for CreateInspectTemplate. "inspectTemplate": { # The inspectTemplate contains a configuration (set of types of sensitive data to be detected) to be used anywhere you otherwise would normally specify InspectConfig. See https://cloud.google.com/sensitive-data-protection/docs/concepts-templates to learn more. # Required. The InspectTemplate to create. - "allowLimitedAvailabilityInfoTypes": True or False, # Optional. Enables the use of limited-availability built-in infoTypes in inspect_config. These infoTypes are supported only in specific regions and can cause scanning errors if used elsewhere. For more information, see https://cloud.google.com/sensitive-data-protection/docs/locations#location-specific_limitations to learn more about location-specific limitations. + "allowLimitedAvailabilityInfoTypes": True or False, # Optional. Enables the use of [limited-availability built-in infoTypes](https://docs.cloud.google.com/sensitive-data-protection/docs/infotypes-reference#limited-availability-infotypes) in inspect_config. These infoTypes are supported only in specific regions and can cause scanning errors if used elsewhere. "createTime": "A String", # Output only. The creation timestamp of an inspectTemplate. "description": "A String", # Short description (max 256 chars). "displayName": "A String", # Display name (max 256 chars). @@ -372,7 +372,7 @@

Method Details

An object of the form: { # The inspectTemplate contains a configuration (set of types of sensitive data to be detected) to be used anywhere you otherwise would normally specify InspectConfig. See https://cloud.google.com/sensitive-data-protection/docs/concepts-templates to learn more. - "allowLimitedAvailabilityInfoTypes": True or False, # Optional. Enables the use of limited-availability built-in infoTypes in inspect_config. These infoTypes are supported only in specific regions and can cause scanning errors if used elsewhere. For more information, see https://cloud.google.com/sensitive-data-protection/docs/locations#location-specific_limitations to learn more about location-specific limitations. + "allowLimitedAvailabilityInfoTypes": True or False, # Optional. Enables the use of [limited-availability built-in infoTypes](https://docs.cloud.google.com/sensitive-data-protection/docs/infotypes-reference#limited-availability-infotypes) in inspect_config. These infoTypes are supported only in specific regions and can cause scanning errors if used elsewhere. "createTime": "A String", # Output only. The creation timestamp of an inspectTemplate. "description": "A String", # Short description (max 256 chars). "displayName": "A String", # Display name (max 256 chars). @@ -654,7 +654,7 @@

Method Details

An object of the form: { # The inspectTemplate contains a configuration (set of types of sensitive data to be detected) to be used anywhere you otherwise would normally specify InspectConfig. See https://cloud.google.com/sensitive-data-protection/docs/concepts-templates to learn more. - "allowLimitedAvailabilityInfoTypes": True or False, # Optional. Enables the use of limited-availability built-in infoTypes in inspect_config. These infoTypes are supported only in specific regions and can cause scanning errors if used elsewhere. For more information, see https://cloud.google.com/sensitive-data-protection/docs/locations#location-specific_limitations to learn more about location-specific limitations. + "allowLimitedAvailabilityInfoTypes": True or False, # Optional. Enables the use of [limited-availability built-in infoTypes](https://docs.cloud.google.com/sensitive-data-protection/docs/infotypes-reference#limited-availability-infotypes) in inspect_config. These infoTypes are supported only in specific regions and can cause scanning errors if used elsewhere. "createTime": "A String", # Output only. The creation timestamp of an inspectTemplate. "description": "A String", # Short description (max 256 chars). "displayName": "A String", # Display name (max 256 chars). @@ -924,7 +924,7 @@

Method Details

{ # Response message for ListInspectTemplates. "inspectTemplates": [ # List of inspectTemplates, up to page_size in ListInspectTemplatesRequest. { # The inspectTemplate contains a configuration (set of types of sensitive data to be detected) to be used anywhere you otherwise would normally specify InspectConfig. See https://cloud.google.com/sensitive-data-protection/docs/concepts-templates to learn more. - "allowLimitedAvailabilityInfoTypes": True or False, # Optional. Enables the use of limited-availability built-in infoTypes in inspect_config. These infoTypes are supported only in specific regions and can cause scanning errors if used elsewhere. For more information, see https://cloud.google.com/sensitive-data-protection/docs/locations#location-specific_limitations to learn more about location-specific limitations. + "allowLimitedAvailabilityInfoTypes": True or False, # Optional. Enables the use of [limited-availability built-in infoTypes](https://docs.cloud.google.com/sensitive-data-protection/docs/infotypes-reference#limited-availability-infotypes) in inspect_config. These infoTypes are supported only in specific regions and can cause scanning errors if used elsewhere. "createTime": "A String", # Output only. The creation timestamp of an inspectTemplate. "description": "A String", # Short description (max 256 chars). "displayName": "A String", # Display name (max 256 chars). @@ -1201,7 +1201,7 @@

Method Details

{ # Request message for UpdateInspectTemplate. "inspectTemplate": { # The inspectTemplate contains a configuration (set of types of sensitive data to be detected) to be used anywhere you otherwise would normally specify InspectConfig. See https://cloud.google.com/sensitive-data-protection/docs/concepts-templates to learn more. # New InspectTemplate value. - "allowLimitedAvailabilityInfoTypes": True or False, # Optional. Enables the use of limited-availability built-in infoTypes in inspect_config. These infoTypes are supported only in specific regions and can cause scanning errors if used elsewhere. For more information, see https://cloud.google.com/sensitive-data-protection/docs/locations#location-specific_limitations to learn more about location-specific limitations. + "allowLimitedAvailabilityInfoTypes": True or False, # Optional. Enables the use of [limited-availability built-in infoTypes](https://docs.cloud.google.com/sensitive-data-protection/docs/infotypes-reference#limited-availability-infotypes) in inspect_config. These infoTypes are supported only in specific regions and can cause scanning errors if used elsewhere. "createTime": "A String", # Output only. The creation timestamp of an inspectTemplate. "description": "A String", # Short description (max 256 chars). "displayName": "A String", # Display name (max 256 chars). @@ -1460,7 +1460,7 @@

Method Details

An object of the form: { # The inspectTemplate contains a configuration (set of types of sensitive data to be detected) to be used anywhere you otherwise would normally specify InspectConfig. See https://cloud.google.com/sensitive-data-protection/docs/concepts-templates to learn more. - "allowLimitedAvailabilityInfoTypes": True or False, # Optional. Enables the use of limited-availability built-in infoTypes in inspect_config. These infoTypes are supported only in specific regions and can cause scanning errors if used elsewhere. For more information, see https://cloud.google.com/sensitive-data-protection/docs/locations#location-specific_limitations to learn more about location-specific limitations. + "allowLimitedAvailabilityInfoTypes": True or False, # Optional. Enables the use of [limited-availability built-in infoTypes](https://docs.cloud.google.com/sensitive-data-protection/docs/infotypes-reference#limited-availability-infotypes) in inspect_config. These infoTypes are supported only in specific regions and can cause scanning errors if used elsewhere. "createTime": "A String", # Output only. The creation timestamp of an inspectTemplate. "description": "A String", # Short description (max 256 chars). "displayName": "A String", # Display name (max 256 chars). diff --git a/docs/dyn/dlp_v2.organizations.locations.dlpJobs.html b/docs/dyn/dlp_v2.organizations.locations.dlpJobs.html index e9170727dc..548f7b6b66 100644 --- a/docs/dyn/dlp_v2.organizations.locations.dlpJobs.html +++ b/docs/dyn/dlp_v2.organizations.locations.dlpJobs.html @@ -3109,7 +3109,7 @@

Method Details

}, }, "snapshotInspectTemplate": { # The inspectTemplate contains a configuration (set of types of sensitive data to be detected) to be used anywhere you otherwise would normally specify InspectConfig. See https://cloud.google.com/sensitive-data-protection/docs/concepts-templates to learn more. # If run with an InspectTemplate, a snapshot of its state at the time of this run. - "allowLimitedAvailabilityInfoTypes": True or False, # Optional. Enables the use of limited-availability built-in infoTypes in inspect_config. These infoTypes are supported only in specific regions and can cause scanning errors if used elsewhere. For more information, see https://cloud.google.com/sensitive-data-protection/docs/locations#location-specific_limitations to learn more about location-specific limitations. + "allowLimitedAvailabilityInfoTypes": True or False, # Optional. Enables the use of [limited-availability built-in infoTypes](https://docs.cloud.google.com/sensitive-data-protection/docs/infotypes-reference#limited-availability-infotypes) in inspect_config. These infoTypes are supported only in specific regions and can cause scanning errors if used elsewhere. "createTime": "A String", # Output only. The creation timestamp of an inspectTemplate. "description": "A String", # Short description (max 256 chars). "displayName": "A String", # Display name (max 256 chars). diff --git a/docs/dyn/dlp_v2.organizations.locations.inspectTemplates.html b/docs/dyn/dlp_v2.organizations.locations.inspectTemplates.html index 73fa4a7bb7..0399db6787 100644 --- a/docs/dyn/dlp_v2.organizations.locations.inspectTemplates.html +++ b/docs/dyn/dlp_v2.organizations.locations.inspectTemplates.html @@ -112,7 +112,7 @@

Method Details

{ # Request message for CreateInspectTemplate. "inspectTemplate": { # The inspectTemplate contains a configuration (set of types of sensitive data to be detected) to be used anywhere you otherwise would normally specify InspectConfig. See https://cloud.google.com/sensitive-data-protection/docs/concepts-templates to learn more. # Required. The InspectTemplate to create. - "allowLimitedAvailabilityInfoTypes": True or False, # Optional. Enables the use of limited-availability built-in infoTypes in inspect_config. These infoTypes are supported only in specific regions and can cause scanning errors if used elsewhere. For more information, see https://cloud.google.com/sensitive-data-protection/docs/locations#location-specific_limitations to learn more about location-specific limitations. + "allowLimitedAvailabilityInfoTypes": True or False, # Optional. Enables the use of [limited-availability built-in infoTypes](https://docs.cloud.google.com/sensitive-data-protection/docs/infotypes-reference#limited-availability-infotypes) in inspect_config. These infoTypes are supported only in specific regions and can cause scanning errors if used elsewhere. "createTime": "A String", # Output only. The creation timestamp of an inspectTemplate. "description": "A String", # Short description (max 256 chars). "displayName": "A String", # Display name (max 256 chars). @@ -372,7 +372,7 @@

Method Details

An object of the form: { # The inspectTemplate contains a configuration (set of types of sensitive data to be detected) to be used anywhere you otherwise would normally specify InspectConfig. See https://cloud.google.com/sensitive-data-protection/docs/concepts-templates to learn more. - "allowLimitedAvailabilityInfoTypes": True or False, # Optional. Enables the use of limited-availability built-in infoTypes in inspect_config. These infoTypes are supported only in specific regions and can cause scanning errors if used elsewhere. For more information, see https://cloud.google.com/sensitive-data-protection/docs/locations#location-specific_limitations to learn more about location-specific limitations. + "allowLimitedAvailabilityInfoTypes": True or False, # Optional. Enables the use of [limited-availability built-in infoTypes](https://docs.cloud.google.com/sensitive-data-protection/docs/infotypes-reference#limited-availability-infotypes) in inspect_config. These infoTypes are supported only in specific regions and can cause scanning errors if used elsewhere. "createTime": "A String", # Output only. The creation timestamp of an inspectTemplate. "description": "A String", # Short description (max 256 chars). "displayName": "A String", # Display name (max 256 chars). @@ -654,7 +654,7 @@

Method Details

An object of the form: { # The inspectTemplate contains a configuration (set of types of sensitive data to be detected) to be used anywhere you otherwise would normally specify InspectConfig. See https://cloud.google.com/sensitive-data-protection/docs/concepts-templates to learn more. - "allowLimitedAvailabilityInfoTypes": True or False, # Optional. Enables the use of limited-availability built-in infoTypes in inspect_config. These infoTypes are supported only in specific regions and can cause scanning errors if used elsewhere. For more information, see https://cloud.google.com/sensitive-data-protection/docs/locations#location-specific_limitations to learn more about location-specific limitations. + "allowLimitedAvailabilityInfoTypes": True or False, # Optional. Enables the use of [limited-availability built-in infoTypes](https://docs.cloud.google.com/sensitive-data-protection/docs/infotypes-reference#limited-availability-infotypes) in inspect_config. These infoTypes are supported only in specific regions and can cause scanning errors if used elsewhere. "createTime": "A String", # Output only. The creation timestamp of an inspectTemplate. "description": "A String", # Short description (max 256 chars). "displayName": "A String", # Display name (max 256 chars). @@ -924,7 +924,7 @@

Method Details

{ # Response message for ListInspectTemplates. "inspectTemplates": [ # List of inspectTemplates, up to page_size in ListInspectTemplatesRequest. { # The inspectTemplate contains a configuration (set of types of sensitive data to be detected) to be used anywhere you otherwise would normally specify InspectConfig. See https://cloud.google.com/sensitive-data-protection/docs/concepts-templates to learn more. - "allowLimitedAvailabilityInfoTypes": True or False, # Optional. Enables the use of limited-availability built-in infoTypes in inspect_config. These infoTypes are supported only in specific regions and can cause scanning errors if used elsewhere. For more information, see https://cloud.google.com/sensitive-data-protection/docs/locations#location-specific_limitations to learn more about location-specific limitations. + "allowLimitedAvailabilityInfoTypes": True or False, # Optional. Enables the use of [limited-availability built-in infoTypes](https://docs.cloud.google.com/sensitive-data-protection/docs/infotypes-reference#limited-availability-infotypes) in inspect_config. These infoTypes are supported only in specific regions and can cause scanning errors if used elsewhere. "createTime": "A String", # Output only. The creation timestamp of an inspectTemplate. "description": "A String", # Short description (max 256 chars). "displayName": "A String", # Display name (max 256 chars). @@ -1201,7 +1201,7 @@

Method Details

{ # Request message for UpdateInspectTemplate. "inspectTemplate": { # The inspectTemplate contains a configuration (set of types of sensitive data to be detected) to be used anywhere you otherwise would normally specify InspectConfig. See https://cloud.google.com/sensitive-data-protection/docs/concepts-templates to learn more. # New InspectTemplate value. - "allowLimitedAvailabilityInfoTypes": True or False, # Optional. Enables the use of limited-availability built-in infoTypes in inspect_config. These infoTypes are supported only in specific regions and can cause scanning errors if used elsewhere. For more information, see https://cloud.google.com/sensitive-data-protection/docs/locations#location-specific_limitations to learn more about location-specific limitations. + "allowLimitedAvailabilityInfoTypes": True or False, # Optional. Enables the use of [limited-availability built-in infoTypes](https://docs.cloud.google.com/sensitive-data-protection/docs/infotypes-reference#limited-availability-infotypes) in inspect_config. These infoTypes are supported only in specific regions and can cause scanning errors if used elsewhere. "createTime": "A String", # Output only. The creation timestamp of an inspectTemplate. "description": "A String", # Short description (max 256 chars). "displayName": "A String", # Display name (max 256 chars). @@ -1460,7 +1460,7 @@

Method Details

An object of the form: { # The inspectTemplate contains a configuration (set of types of sensitive data to be detected) to be used anywhere you otherwise would normally specify InspectConfig. See https://cloud.google.com/sensitive-data-protection/docs/concepts-templates to learn more. - "allowLimitedAvailabilityInfoTypes": True or False, # Optional. Enables the use of limited-availability built-in infoTypes in inspect_config. These infoTypes are supported only in specific regions and can cause scanning errors if used elsewhere. For more information, see https://cloud.google.com/sensitive-data-protection/docs/locations#location-specific_limitations to learn more about location-specific limitations. + "allowLimitedAvailabilityInfoTypes": True or False, # Optional. Enables the use of [limited-availability built-in infoTypes](https://docs.cloud.google.com/sensitive-data-protection/docs/infotypes-reference#limited-availability-infotypes) in inspect_config. These infoTypes are supported only in specific regions and can cause scanning errors if used elsewhere. "createTime": "A String", # Output only. The creation timestamp of an inspectTemplate. "description": "A String", # Short description (max 256 chars). "displayName": "A String", # Display name (max 256 chars). diff --git a/docs/dyn/dlp_v2.projects.content.html b/docs/dyn/dlp_v2.projects.content.html index 28394d1f3b..970ec01baa 100644 --- a/docs/dyn/dlp_v2.projects.content.html +++ b/docs/dyn/dlp_v2.projects.content.html @@ -1200,6 +1200,13 @@

Method Details

}, "inspectTemplateName": "A String", # Template to use. Any configuration directly specified in inspect_config will override those set in the template. Singular fields that are set in this request will replace their corresponding fields in the template. Repeated fields are appended. Singular sub-messages and groups are recursively merged. "item": { # Type of content to inspect. # The item to de-identify. Will be treated as text. This value must be of type Table if your deidentify_config is a RecordTransformations object. + "batchContentItem": { # Represents a batch of content to inspect or redact. # Represents a batch of items to inspect. + "stringValueBatch": { # Represents a batch of string values to inspect or redact. # Optional. Represents a batch of string values to inspect or redact. + "values": [ # Optional. Represents string data to inspect or redact. + "A String", + ], + }, + }, "byteItem": { # Container for bytes to inspect or redact. # Content data to inspect or redact. Replaces `type` and `data`. "data": "A String", # Content data to inspect or redact. "type": "A String", # The type of data stored in the bytes string. Default will be TEXT_UTF8. @@ -1212,6 +1219,15 @@

Method Details

}, ], }, + "conversation": { # Complete conversation or slice of a conversation. It is assumed that all included messages are contiguous and ordered in chronological order. # Represents a conversation (either complete or a slice). It is assumed that all included messages are contiguous and ordered in chronological order. + "messages": [ # Messages exchanged within this conversation. The maximum number of messages allowed is 50k. The order of the messages is assumed to be chronological and will be used to index findings in the response. + { # Single message in a conversation. + "content": "A String", # The contents of this message. + "messageType": "A String", # The type of message. + "participantId": "A String", # Optional. The identifier of the participant. For example 'test-user' or 'gemini'. The participant ID can contain lowercase letters, numbers, and hyphens; that is, it must match the regular expression: `^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$`. The maximum length is 63 characters. + }, + ], + }, "table": { # Structured content to inspect. Up to 50,000 `Value`s per request allowed. See https://cloud.google.com/sensitive-data-protection/docs/inspecting-structured-text#inspecting_a_table to learn more. # Structured content for inspection. See https://cloud.google.com/sensitive-data-protection/docs/inspecting-text#inspecting_a_table to learn more. "headers": [ # Headers of the table. { # General identifier of a data field in a storage service. @@ -1259,6 +1275,13 @@

Method Details

{ # Results of de-identifying a ContentItem. "item": { # Type of content to inspect. # The de-identified item. + "batchContentItem": { # Represents a batch of content to inspect or redact. # Represents a batch of items to inspect. + "stringValueBatch": { # Represents a batch of string values to inspect or redact. # Optional. Represents a batch of string values to inspect or redact. + "values": [ # Optional. Represents string data to inspect or redact. + "A String", + ], + }, + }, "byteItem": { # Container for bytes to inspect or redact. # Content data to inspect or redact. Replaces `type` and `data`. "data": "A String", # Content data to inspect or redact. "type": "A String", # The type of data stored in the bytes string. Default will be TEXT_UTF8. @@ -1271,6 +1294,15 @@

Method Details

}, ], }, + "conversation": { # Complete conversation or slice of a conversation. It is assumed that all included messages are contiguous and ordered in chronological order. # Represents a conversation (either complete or a slice). It is assumed that all included messages are contiguous and ordered in chronological order. + "messages": [ # Messages exchanged within this conversation. The maximum number of messages allowed is 50k. The order of the messages is assumed to be chronological and will be used to index findings in the response. + { # Single message in a conversation. + "content": "A String", # The contents of this message. + "messageType": "A String", # The type of message. + "participantId": "A String", # Optional. The identifier of the participant. For example 'test-user' or 'gemini'. The participant ID can contain lowercase letters, numbers, and hyphens; that is, it must match the regular expression: `^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$`. The maximum length is 63 characters. + }, + ], + }, "table": { # Structured content to inspect. Up to 50,000 `Value`s per request allowed. See https://cloud.google.com/sensitive-data-protection/docs/inspecting-structured-text#inspecting_a_table to learn more. # Structured content for inspection. See https://cloud.google.com/sensitive-data-protection/docs/inspecting-text#inspecting_a_table to learn more. "headers": [ # Headers of the table. { # General identifier of a data field in a storage service. @@ -2387,6 +2419,13 @@

Method Details

}, "inspectTemplateName": "A String", # Template to use. Any configuration directly specified in inspect_config will override those set in the template. Singular fields that are set in this request will replace their corresponding fields in the template. Repeated fields are appended. Singular sub-messages and groups are recursively merged. "item": { # Type of content to inspect. # The item to inspect. + "batchContentItem": { # Represents a batch of content to inspect or redact. # Represents a batch of items to inspect. + "stringValueBatch": { # Represents a batch of string values to inspect or redact. # Optional. Represents a batch of string values to inspect or redact. + "values": [ # Optional. Represents string data to inspect or redact. + "A String", + ], + }, + }, "byteItem": { # Container for bytes to inspect or redact. # Content data to inspect or redact. Replaces `type` and `data`. "data": "A String", # Content data to inspect or redact. "type": "A String", # The type of data stored in the bytes string. Default will be TEXT_UTF8. @@ -2399,6 +2438,15 @@

Method Details

}, ], }, + "conversation": { # Complete conversation or slice of a conversation. It is assumed that all included messages are contiguous and ordered in chronological order. # Represents a conversation (either complete or a slice). It is assumed that all included messages are contiguous and ordered in chronological order. + "messages": [ # Messages exchanged within this conversation. The maximum number of messages allowed is 50k. The order of the messages is assumed to be chronological and will be used to index findings in the response. + { # Single message in a conversation. + "content": "A String", # The contents of this message. + "messageType": "A String", # The type of message. + "participantId": "A String", # Optional. The identifier of the participant. For example 'test-user' or 'gemini'. The participant ID can contain lowercase letters, numbers, and hyphens; that is, it must match the regular expression: `^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$`. The maximum length is 63 characters. + }, + ], + }, "table": { # Structured content to inspect. Up to 50,000 `Value`s per request allowed. See https://cloud.google.com/sensitive-data-protection/docs/inspecting-structured-text#inspecting_a_table to learn more. # Structured content for inspection. See https://cloud.google.com/sensitive-data-protection/docs/inspecting-text#inspecting_a_table to learn more. "headers": [ # Headers of the table. { # General identifier of a data field in a storage service. @@ -2483,9 +2531,17 @@

Method Details

}, "contentLocations": [ # List of nested objects pointing to the precise location of the finding within the file or record. { # Precise location of the finding within a document, record, image, or metadata container. + "batchContentLocation": { # Location within a batch of content. # Location within a batch of content. + "itemIndex": 42, # Matches an index of a batch item in the batch provided in the request. + }, "containerName": "A String", # Name of the container where the finding is located. The top level name is the source file name or table name. Names of some common storage containers are formatted as follows: * BigQuery tables: `{project_id}:{dataset_id}.{table_id}` * Cloud Storage files: `gs://{bucket}/{path}` * Datastore namespace: {namespace} Nested names could be absent if the embedded object has no string identifier (for example, an image contained within a document). "containerTimestamp": "A String", # Finding container modification timestamp, if applicable. For Cloud Storage, this field contains the last file modification timestamp. For a BigQuery table, this field contains the last_modified_time property. For Datastore, this field isn't populated. "containerVersion": "A String", # Finding container version, if available ("generation" for Cloud Storage). + "conversationLocation": { # Location within a conversation. # Location within a conversation. + "allMessages": { # If set, indicates that the finding applies to all messages in the conversation. # If set, indicates that the finding applies to all messages in the conversation. + }, + "messageIndex": 42, # Matches an index of a message in the conversation provided in the request. + }, "documentLocation": { # Location of a finding within a document. # Location data for document files. "fileOffset": "A String", # Offset of the line, from the beginning of the file, where the finding is located. }, @@ -2829,6 +2885,13 @@

Method Details

}, "inspectTemplateName": "A String", # Template to use. Any configuration directly specified in `inspect_config` will override those set in the template. Singular fields that are set in this request will replace their corresponding fields in the template. Repeated fields are appended. Singular sub-messages and groups are recursively merged. "item": { # Type of content to inspect. # The item to re-identify. Will be treated as text. + "batchContentItem": { # Represents a batch of content to inspect or redact. # Represents a batch of items to inspect. + "stringValueBatch": { # Represents a batch of string values to inspect or redact. # Optional. Represents a batch of string values to inspect or redact. + "values": [ # Optional. Represents string data to inspect or redact. + "A String", + ], + }, + }, "byteItem": { # Container for bytes to inspect or redact. # Content data to inspect or redact. Replaces `type` and `data`. "data": "A String", # Content data to inspect or redact. "type": "A String", # The type of data stored in the bytes string. Default will be TEXT_UTF8. @@ -2841,6 +2904,15 @@

Method Details

}, ], }, + "conversation": { # Complete conversation or slice of a conversation. It is assumed that all included messages are contiguous and ordered in chronological order. # Represents a conversation (either complete or a slice). It is assumed that all included messages are contiguous and ordered in chronological order. + "messages": [ # Messages exchanged within this conversation. The maximum number of messages allowed is 50k. The order of the messages is assumed to be chronological and will be used to index findings in the response. + { # Single message in a conversation. + "content": "A String", # The contents of this message. + "messageType": "A String", # The type of message. + "participantId": "A String", # Optional. The identifier of the participant. For example 'test-user' or 'gemini'. The participant ID can contain lowercase letters, numbers, and hyphens; that is, it must match the regular expression: `^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$`. The maximum length is 63 characters. + }, + ], + }, "table": { # Structured content to inspect. Up to 50,000 `Value`s per request allowed. See https://cloud.google.com/sensitive-data-protection/docs/inspecting-structured-text#inspecting_a_table to learn more. # Structured content for inspection. See https://cloud.google.com/sensitive-data-protection/docs/inspecting-text#inspecting_a_table to learn more. "headers": [ # Headers of the table. { # General identifier of a data field in a storage service. @@ -3744,6 +3816,13 @@

Method Details

{ # Results of re-identifying an item. "item": { # Type of content to inspect. # The re-identified item. + "batchContentItem": { # Represents a batch of content to inspect or redact. # Represents a batch of items to inspect. + "stringValueBatch": { # Represents a batch of string values to inspect or redact. # Optional. Represents a batch of string values to inspect or redact. + "values": [ # Optional. Represents string data to inspect or redact. + "A String", + ], + }, + }, "byteItem": { # Container for bytes to inspect or redact. # Content data to inspect or redact. Replaces `type` and `data`. "data": "A String", # Content data to inspect or redact. "type": "A String", # The type of data stored in the bytes string. Default will be TEXT_UTF8. @@ -3756,6 +3835,15 @@

Method Details

}, ], }, + "conversation": { # Complete conversation or slice of a conversation. It is assumed that all included messages are contiguous and ordered in chronological order. # Represents a conversation (either complete or a slice). It is assumed that all included messages are contiguous and ordered in chronological order. + "messages": [ # Messages exchanged within this conversation. The maximum number of messages allowed is 50k. The order of the messages is assumed to be chronological and will be used to index findings in the response. + { # Single message in a conversation. + "content": "A String", # The contents of this message. + "messageType": "A String", # The type of message. + "participantId": "A String", # Optional. The identifier of the participant. For example 'test-user' or 'gemini'. The participant ID can contain lowercase letters, numbers, and hyphens; that is, it must match the regular expression: `^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$`. The maximum length is 63 characters. + }, + ], + }, "table": { # Structured content to inspect. Up to 50,000 `Value`s per request allowed. See https://cloud.google.com/sensitive-data-protection/docs/inspecting-structured-text#inspecting_a_table to learn more. # Structured content for inspection. See https://cloud.google.com/sensitive-data-protection/docs/inspecting-text#inspecting_a_table to learn more. "headers": [ # Headers of the table. { # General identifier of a data field in a storage service. diff --git a/docs/dyn/dlp_v2.projects.dlpJobs.html b/docs/dyn/dlp_v2.projects.dlpJobs.html index 0f9691975d..b63e93ecb4 100644 --- a/docs/dyn/dlp_v2.projects.dlpJobs.html +++ b/docs/dyn/dlp_v2.projects.dlpJobs.html @@ -3682,7 +3682,7 @@

Method Details

}, }, "snapshotInspectTemplate": { # The inspectTemplate contains a configuration (set of types of sensitive data to be detected) to be used anywhere you otherwise would normally specify InspectConfig. See https://cloud.google.com/sensitive-data-protection/docs/concepts-templates to learn more. # If run with an InspectTemplate, a snapshot of its state at the time of this run. - "allowLimitedAvailabilityInfoTypes": True or False, # Optional. Enables the use of limited-availability built-in infoTypes in inspect_config. These infoTypes are supported only in specific regions and can cause scanning errors if used elsewhere. For more information, see https://cloud.google.com/sensitive-data-protection/docs/locations#location-specific_limitations to learn more about location-specific limitations. + "allowLimitedAvailabilityInfoTypes": True or False, # Optional. Enables the use of [limited-availability built-in infoTypes](https://docs.cloud.google.com/sensitive-data-protection/docs/infotypes-reference#limited-availability-infotypes) in inspect_config. These infoTypes are supported only in specific regions and can cause scanning errors if used elsewhere. "createTime": "A String", # Output only. The creation timestamp of an inspectTemplate. "description": "A String", # Short description (max 256 chars). "displayName": "A String", # Display name (max 256 chars). @@ -7544,7 +7544,7 @@

Method Details

}, }, "snapshotInspectTemplate": { # The inspectTemplate contains a configuration (set of types of sensitive data to be detected) to be used anywhere you otherwise would normally specify InspectConfig. See https://cloud.google.com/sensitive-data-protection/docs/concepts-templates to learn more. # If run with an InspectTemplate, a snapshot of its state at the time of this run. - "allowLimitedAvailabilityInfoTypes": True or False, # Optional. Enables the use of limited-availability built-in infoTypes in inspect_config. These infoTypes are supported only in specific regions and can cause scanning errors if used elsewhere. For more information, see https://cloud.google.com/sensitive-data-protection/docs/locations#location-specific_limitations to learn more about location-specific limitations. + "allowLimitedAvailabilityInfoTypes": True or False, # Optional. Enables the use of [limited-availability built-in infoTypes](https://docs.cloud.google.com/sensitive-data-protection/docs/infotypes-reference#limited-availability-infotypes) in inspect_config. These infoTypes are supported only in specific regions and can cause scanning errors if used elsewhere. "createTime": "A String", # Output only. The creation timestamp of an inspectTemplate. "description": "A String", # Short description (max 256 chars). "displayName": "A String", # Display name (max 256 chars). @@ -11400,7 +11400,7 @@

Method Details

}, }, "snapshotInspectTemplate": { # The inspectTemplate contains a configuration (set of types of sensitive data to be detected) to be used anywhere you otherwise would normally specify InspectConfig. See https://cloud.google.com/sensitive-data-protection/docs/concepts-templates to learn more. # If run with an InspectTemplate, a snapshot of its state at the time of this run. - "allowLimitedAvailabilityInfoTypes": True or False, # Optional. Enables the use of limited-availability built-in infoTypes in inspect_config. These infoTypes are supported only in specific regions and can cause scanning errors if used elsewhere. For more information, see https://cloud.google.com/sensitive-data-protection/docs/locations#location-specific_limitations to learn more about location-specific limitations. + "allowLimitedAvailabilityInfoTypes": True or False, # Optional. Enables the use of [limited-availability built-in infoTypes](https://docs.cloud.google.com/sensitive-data-protection/docs/infotypes-reference#limited-availability-infotypes) in inspect_config. These infoTypes are supported only in specific regions and can cause scanning errors if used elsewhere. "createTime": "A String", # Output only. The creation timestamp of an inspectTemplate. "description": "A String", # Short description (max 256 chars). "displayName": "A String", # Display name (max 256 chars). diff --git a/docs/dyn/dlp_v2.projects.image.html b/docs/dyn/dlp_v2.projects.image.html index a51951e574..11dd7fff31 100644 --- a/docs/dyn/dlp_v2.projects.image.html +++ b/docs/dyn/dlp_v2.projects.image.html @@ -411,9 +411,17 @@

Method Details

}, "contentLocations": [ # List of nested objects pointing to the precise location of the finding within the file or record. { # Precise location of the finding within a document, record, image, or metadata container. + "batchContentLocation": { # Location within a batch of content. # Location within a batch of content. + "itemIndex": 42, # Matches an index of a batch item in the batch provided in the request. + }, "containerName": "A String", # Name of the container where the finding is located. The top level name is the source file name or table name. Names of some common storage containers are formatted as follows: * BigQuery tables: `{project_id}:{dataset_id}.{table_id}` * Cloud Storage files: `gs://{bucket}/{path}` * Datastore namespace: {namespace} Nested names could be absent if the embedded object has no string identifier (for example, an image contained within a document). "containerTimestamp": "A String", # Finding container modification timestamp, if applicable. For Cloud Storage, this field contains the last file modification timestamp. For a BigQuery table, this field contains the last_modified_time property. For Datastore, this field isn't populated. "containerVersion": "A String", # Finding container version, if available ("generation" for Cloud Storage). + "conversationLocation": { # Location within a conversation. # Location within a conversation. + "allMessages": { # If set, indicates that the finding applies to all messages in the conversation. # If set, indicates that the finding applies to all messages in the conversation. + }, + "messageIndex": 42, # Matches an index of a message in the conversation provided in the request. + }, "documentLocation": { # Location of a finding within a document. # Location data for document files. "fileOffset": "A String", # Offset of the line, from the beginning of the file, where the finding is located. }, diff --git a/docs/dyn/dlp_v2.projects.inspectTemplates.html b/docs/dyn/dlp_v2.projects.inspectTemplates.html index 9f89db71fc..6bfe934c4a 100644 --- a/docs/dyn/dlp_v2.projects.inspectTemplates.html +++ b/docs/dyn/dlp_v2.projects.inspectTemplates.html @@ -112,7 +112,7 @@

Method Details

{ # Request message for CreateInspectTemplate. "inspectTemplate": { # The inspectTemplate contains a configuration (set of types of sensitive data to be detected) to be used anywhere you otherwise would normally specify InspectConfig. See https://cloud.google.com/sensitive-data-protection/docs/concepts-templates to learn more. # Required. The InspectTemplate to create. - "allowLimitedAvailabilityInfoTypes": True or False, # Optional. Enables the use of limited-availability built-in infoTypes in inspect_config. These infoTypes are supported only in specific regions and can cause scanning errors if used elsewhere. For more information, see https://cloud.google.com/sensitive-data-protection/docs/locations#location-specific_limitations to learn more about location-specific limitations. + "allowLimitedAvailabilityInfoTypes": True or False, # Optional. Enables the use of [limited-availability built-in infoTypes](https://docs.cloud.google.com/sensitive-data-protection/docs/infotypes-reference#limited-availability-infotypes) in inspect_config. These infoTypes are supported only in specific regions and can cause scanning errors if used elsewhere. "createTime": "A String", # Output only. The creation timestamp of an inspectTemplate. "description": "A String", # Short description (max 256 chars). "displayName": "A String", # Display name (max 256 chars). @@ -372,7 +372,7 @@

Method Details

An object of the form: { # The inspectTemplate contains a configuration (set of types of sensitive data to be detected) to be used anywhere you otherwise would normally specify InspectConfig. See https://cloud.google.com/sensitive-data-protection/docs/concepts-templates to learn more. - "allowLimitedAvailabilityInfoTypes": True or False, # Optional. Enables the use of limited-availability built-in infoTypes in inspect_config. These infoTypes are supported only in specific regions and can cause scanning errors if used elsewhere. For more information, see https://cloud.google.com/sensitive-data-protection/docs/locations#location-specific_limitations to learn more about location-specific limitations. + "allowLimitedAvailabilityInfoTypes": True or False, # Optional. Enables the use of [limited-availability built-in infoTypes](https://docs.cloud.google.com/sensitive-data-protection/docs/infotypes-reference#limited-availability-infotypes) in inspect_config. These infoTypes are supported only in specific regions and can cause scanning errors if used elsewhere. "createTime": "A String", # Output only. The creation timestamp of an inspectTemplate. "description": "A String", # Short description (max 256 chars). "displayName": "A String", # Display name (max 256 chars). @@ -654,7 +654,7 @@

Method Details

An object of the form: { # The inspectTemplate contains a configuration (set of types of sensitive data to be detected) to be used anywhere you otherwise would normally specify InspectConfig. See https://cloud.google.com/sensitive-data-protection/docs/concepts-templates to learn more. - "allowLimitedAvailabilityInfoTypes": True or False, # Optional. Enables the use of limited-availability built-in infoTypes in inspect_config. These infoTypes are supported only in specific regions and can cause scanning errors if used elsewhere. For more information, see https://cloud.google.com/sensitive-data-protection/docs/locations#location-specific_limitations to learn more about location-specific limitations. + "allowLimitedAvailabilityInfoTypes": True or False, # Optional. Enables the use of [limited-availability built-in infoTypes](https://docs.cloud.google.com/sensitive-data-protection/docs/infotypes-reference#limited-availability-infotypes) in inspect_config. These infoTypes are supported only in specific regions and can cause scanning errors if used elsewhere. "createTime": "A String", # Output only. The creation timestamp of an inspectTemplate. "description": "A String", # Short description (max 256 chars). "displayName": "A String", # Display name (max 256 chars). @@ -924,7 +924,7 @@

Method Details

{ # Response message for ListInspectTemplates. "inspectTemplates": [ # List of inspectTemplates, up to page_size in ListInspectTemplatesRequest. { # The inspectTemplate contains a configuration (set of types of sensitive data to be detected) to be used anywhere you otherwise would normally specify InspectConfig. See https://cloud.google.com/sensitive-data-protection/docs/concepts-templates to learn more. - "allowLimitedAvailabilityInfoTypes": True or False, # Optional. Enables the use of limited-availability built-in infoTypes in inspect_config. These infoTypes are supported only in specific regions and can cause scanning errors if used elsewhere. For more information, see https://cloud.google.com/sensitive-data-protection/docs/locations#location-specific_limitations to learn more about location-specific limitations. + "allowLimitedAvailabilityInfoTypes": True or False, # Optional. Enables the use of [limited-availability built-in infoTypes](https://docs.cloud.google.com/sensitive-data-protection/docs/infotypes-reference#limited-availability-infotypes) in inspect_config. These infoTypes are supported only in specific regions and can cause scanning errors if used elsewhere. "createTime": "A String", # Output only. The creation timestamp of an inspectTemplate. "description": "A String", # Short description (max 256 chars). "displayName": "A String", # Display name (max 256 chars). @@ -1201,7 +1201,7 @@

Method Details

{ # Request message for UpdateInspectTemplate. "inspectTemplate": { # The inspectTemplate contains a configuration (set of types of sensitive data to be detected) to be used anywhere you otherwise would normally specify InspectConfig. See https://cloud.google.com/sensitive-data-protection/docs/concepts-templates to learn more. # New InspectTemplate value. - "allowLimitedAvailabilityInfoTypes": True or False, # Optional. Enables the use of limited-availability built-in infoTypes in inspect_config. These infoTypes are supported only in specific regions and can cause scanning errors if used elsewhere. For more information, see https://cloud.google.com/sensitive-data-protection/docs/locations#location-specific_limitations to learn more about location-specific limitations. + "allowLimitedAvailabilityInfoTypes": True or False, # Optional. Enables the use of [limited-availability built-in infoTypes](https://docs.cloud.google.com/sensitive-data-protection/docs/infotypes-reference#limited-availability-infotypes) in inspect_config. These infoTypes are supported only in specific regions and can cause scanning errors if used elsewhere. "createTime": "A String", # Output only. The creation timestamp of an inspectTemplate. "description": "A String", # Short description (max 256 chars). "displayName": "A String", # Display name (max 256 chars). @@ -1460,7 +1460,7 @@

Method Details

An object of the form: { # The inspectTemplate contains a configuration (set of types of sensitive data to be detected) to be used anywhere you otherwise would normally specify InspectConfig. See https://cloud.google.com/sensitive-data-protection/docs/concepts-templates to learn more. - "allowLimitedAvailabilityInfoTypes": True or False, # Optional. Enables the use of limited-availability built-in infoTypes in inspect_config. These infoTypes are supported only in specific regions and can cause scanning errors if used elsewhere. For more information, see https://cloud.google.com/sensitive-data-protection/docs/locations#location-specific_limitations to learn more about location-specific limitations. + "allowLimitedAvailabilityInfoTypes": True or False, # Optional. Enables the use of [limited-availability built-in infoTypes](https://docs.cloud.google.com/sensitive-data-protection/docs/infotypes-reference#limited-availability-infotypes) in inspect_config. These infoTypes are supported only in specific regions and can cause scanning errors if used elsewhere. "createTime": "A String", # Output only. The creation timestamp of an inspectTemplate. "description": "A String", # Short description (max 256 chars). "displayName": "A String", # Display name (max 256 chars). diff --git a/docs/dyn/dlp_v2.projects.jobTriggers.html b/docs/dyn/dlp_v2.projects.jobTriggers.html index f79f723ae6..b48b106fbc 100644 --- a/docs/dyn/dlp_v2.projects.jobTriggers.html +++ b/docs/dyn/dlp_v2.projects.jobTriggers.html @@ -3113,7 +3113,7 @@

Method Details

}, }, "snapshotInspectTemplate": { # The inspectTemplate contains a configuration (set of types of sensitive data to be detected) to be used anywhere you otherwise would normally specify InspectConfig. See https://cloud.google.com/sensitive-data-protection/docs/concepts-templates to learn more. # If run with an InspectTemplate, a snapshot of its state at the time of this run. - "allowLimitedAvailabilityInfoTypes": True or False, # Optional. Enables the use of limited-availability built-in infoTypes in inspect_config. These infoTypes are supported only in specific regions and can cause scanning errors if used elsewhere. For more information, see https://cloud.google.com/sensitive-data-protection/docs/locations#location-specific_limitations to learn more about location-specific limitations. + "allowLimitedAvailabilityInfoTypes": True or False, # Optional. Enables the use of [limited-availability built-in infoTypes](https://docs.cloud.google.com/sensitive-data-protection/docs/infotypes-reference#limited-availability-infotypes) in inspect_config. These infoTypes are supported only in specific regions and can cause scanning errors if used elsewhere. "createTime": "A String", # Output only. The creation timestamp of an inspectTemplate. "description": "A String", # Short description (max 256 chars). "displayName": "A String", # Display name (max 256 chars). diff --git a/docs/dyn/dlp_v2.projects.locations.content.html b/docs/dyn/dlp_v2.projects.locations.content.html index 965afc3d2d..284957c109 100644 --- a/docs/dyn/dlp_v2.projects.locations.content.html +++ b/docs/dyn/dlp_v2.projects.locations.content.html @@ -1200,6 +1200,13 @@

Method Details

}, "inspectTemplateName": "A String", # Template to use. Any configuration directly specified in inspect_config will override those set in the template. Singular fields that are set in this request will replace their corresponding fields in the template. Repeated fields are appended. Singular sub-messages and groups are recursively merged. "item": { # Type of content to inspect. # The item to de-identify. Will be treated as text. This value must be of type Table if your deidentify_config is a RecordTransformations object. + "batchContentItem": { # Represents a batch of content to inspect or redact. # Represents a batch of items to inspect. + "stringValueBatch": { # Represents a batch of string values to inspect or redact. # Optional. Represents a batch of string values to inspect or redact. + "values": [ # Optional. Represents string data to inspect or redact. + "A String", + ], + }, + }, "byteItem": { # Container for bytes to inspect or redact. # Content data to inspect or redact. Replaces `type` and `data`. "data": "A String", # Content data to inspect or redact. "type": "A String", # The type of data stored in the bytes string. Default will be TEXT_UTF8. @@ -1212,6 +1219,15 @@

Method Details

}, ], }, + "conversation": { # Complete conversation or slice of a conversation. It is assumed that all included messages are contiguous and ordered in chronological order. # Represents a conversation (either complete or a slice). It is assumed that all included messages are contiguous and ordered in chronological order. + "messages": [ # Messages exchanged within this conversation. The maximum number of messages allowed is 50k. The order of the messages is assumed to be chronological and will be used to index findings in the response. + { # Single message in a conversation. + "content": "A String", # The contents of this message. + "messageType": "A String", # The type of message. + "participantId": "A String", # Optional. The identifier of the participant. For example 'test-user' or 'gemini'. The participant ID can contain lowercase letters, numbers, and hyphens; that is, it must match the regular expression: `^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$`. The maximum length is 63 characters. + }, + ], + }, "table": { # Structured content to inspect. Up to 50,000 `Value`s per request allowed. See https://cloud.google.com/sensitive-data-protection/docs/inspecting-structured-text#inspecting_a_table to learn more. # Structured content for inspection. See https://cloud.google.com/sensitive-data-protection/docs/inspecting-text#inspecting_a_table to learn more. "headers": [ # Headers of the table. { # General identifier of a data field in a storage service. @@ -1259,6 +1275,13 @@

Method Details

{ # Results of de-identifying a ContentItem. "item": { # Type of content to inspect. # The de-identified item. + "batchContentItem": { # Represents a batch of content to inspect or redact. # Represents a batch of items to inspect. + "stringValueBatch": { # Represents a batch of string values to inspect or redact. # Optional. Represents a batch of string values to inspect or redact. + "values": [ # Optional. Represents string data to inspect or redact. + "A String", + ], + }, + }, "byteItem": { # Container for bytes to inspect or redact. # Content data to inspect or redact. Replaces `type` and `data`. "data": "A String", # Content data to inspect or redact. "type": "A String", # The type of data stored in the bytes string. Default will be TEXT_UTF8. @@ -1271,6 +1294,15 @@

Method Details

}, ], }, + "conversation": { # Complete conversation or slice of a conversation. It is assumed that all included messages are contiguous and ordered in chronological order. # Represents a conversation (either complete or a slice). It is assumed that all included messages are contiguous and ordered in chronological order. + "messages": [ # Messages exchanged within this conversation. The maximum number of messages allowed is 50k. The order of the messages is assumed to be chronological and will be used to index findings in the response. + { # Single message in a conversation. + "content": "A String", # The contents of this message. + "messageType": "A String", # The type of message. + "participantId": "A String", # Optional. The identifier of the participant. For example 'test-user' or 'gemini'. The participant ID can contain lowercase letters, numbers, and hyphens; that is, it must match the regular expression: `^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$`. The maximum length is 63 characters. + }, + ], + }, "table": { # Structured content to inspect. Up to 50,000 `Value`s per request allowed. See https://cloud.google.com/sensitive-data-protection/docs/inspecting-structured-text#inspecting_a_table to learn more. # Structured content for inspection. See https://cloud.google.com/sensitive-data-protection/docs/inspecting-text#inspecting_a_table to learn more. "headers": [ # Headers of the table. { # General identifier of a data field in a storage service. @@ -2387,6 +2419,13 @@

Method Details

}, "inspectTemplateName": "A String", # Template to use. Any configuration directly specified in inspect_config will override those set in the template. Singular fields that are set in this request will replace their corresponding fields in the template. Repeated fields are appended. Singular sub-messages and groups are recursively merged. "item": { # Type of content to inspect. # The item to inspect. + "batchContentItem": { # Represents a batch of content to inspect or redact. # Represents a batch of items to inspect. + "stringValueBatch": { # Represents a batch of string values to inspect or redact. # Optional. Represents a batch of string values to inspect or redact. + "values": [ # Optional. Represents string data to inspect or redact. + "A String", + ], + }, + }, "byteItem": { # Container for bytes to inspect or redact. # Content data to inspect or redact. Replaces `type` and `data`. "data": "A String", # Content data to inspect or redact. "type": "A String", # The type of data stored in the bytes string. Default will be TEXT_UTF8. @@ -2399,6 +2438,15 @@

Method Details

}, ], }, + "conversation": { # Complete conversation or slice of a conversation. It is assumed that all included messages are contiguous and ordered in chronological order. # Represents a conversation (either complete or a slice). It is assumed that all included messages are contiguous and ordered in chronological order. + "messages": [ # Messages exchanged within this conversation. The maximum number of messages allowed is 50k. The order of the messages is assumed to be chronological and will be used to index findings in the response. + { # Single message in a conversation. + "content": "A String", # The contents of this message. + "messageType": "A String", # The type of message. + "participantId": "A String", # Optional. The identifier of the participant. For example 'test-user' or 'gemini'. The participant ID can contain lowercase letters, numbers, and hyphens; that is, it must match the regular expression: `^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$`. The maximum length is 63 characters. + }, + ], + }, "table": { # Structured content to inspect. Up to 50,000 `Value`s per request allowed. See https://cloud.google.com/sensitive-data-protection/docs/inspecting-structured-text#inspecting_a_table to learn more. # Structured content for inspection. See https://cloud.google.com/sensitive-data-protection/docs/inspecting-text#inspecting_a_table to learn more. "headers": [ # Headers of the table. { # General identifier of a data field in a storage service. @@ -2483,9 +2531,17 @@

Method Details

}, "contentLocations": [ # List of nested objects pointing to the precise location of the finding within the file or record. { # Precise location of the finding within a document, record, image, or metadata container. + "batchContentLocation": { # Location within a batch of content. # Location within a batch of content. + "itemIndex": 42, # Matches an index of a batch item in the batch provided in the request. + }, "containerName": "A String", # Name of the container where the finding is located. The top level name is the source file name or table name. Names of some common storage containers are formatted as follows: * BigQuery tables: `{project_id}:{dataset_id}.{table_id}` * Cloud Storage files: `gs://{bucket}/{path}` * Datastore namespace: {namespace} Nested names could be absent if the embedded object has no string identifier (for example, an image contained within a document). "containerTimestamp": "A String", # Finding container modification timestamp, if applicable. For Cloud Storage, this field contains the last file modification timestamp. For a BigQuery table, this field contains the last_modified_time property. For Datastore, this field isn't populated. "containerVersion": "A String", # Finding container version, if available ("generation" for Cloud Storage). + "conversationLocation": { # Location within a conversation. # Location within a conversation. + "allMessages": { # If set, indicates that the finding applies to all messages in the conversation. # If set, indicates that the finding applies to all messages in the conversation. + }, + "messageIndex": 42, # Matches an index of a message in the conversation provided in the request. + }, "documentLocation": { # Location of a finding within a document. # Location data for document files. "fileOffset": "A String", # Offset of the line, from the beginning of the file, where the finding is located. }, @@ -2829,6 +2885,13 @@

Method Details

}, "inspectTemplateName": "A String", # Template to use. Any configuration directly specified in `inspect_config` will override those set in the template. Singular fields that are set in this request will replace their corresponding fields in the template. Repeated fields are appended. Singular sub-messages and groups are recursively merged. "item": { # Type of content to inspect. # The item to re-identify. Will be treated as text. + "batchContentItem": { # Represents a batch of content to inspect or redact. # Represents a batch of items to inspect. + "stringValueBatch": { # Represents a batch of string values to inspect or redact. # Optional. Represents a batch of string values to inspect or redact. + "values": [ # Optional. Represents string data to inspect or redact. + "A String", + ], + }, + }, "byteItem": { # Container for bytes to inspect or redact. # Content data to inspect or redact. Replaces `type` and `data`. "data": "A String", # Content data to inspect or redact. "type": "A String", # The type of data stored in the bytes string. Default will be TEXT_UTF8. @@ -2841,6 +2904,15 @@

Method Details

}, ], }, + "conversation": { # Complete conversation or slice of a conversation. It is assumed that all included messages are contiguous and ordered in chronological order. # Represents a conversation (either complete or a slice). It is assumed that all included messages are contiguous and ordered in chronological order. + "messages": [ # Messages exchanged within this conversation. The maximum number of messages allowed is 50k. The order of the messages is assumed to be chronological and will be used to index findings in the response. + { # Single message in a conversation. + "content": "A String", # The contents of this message. + "messageType": "A String", # The type of message. + "participantId": "A String", # Optional. The identifier of the participant. For example 'test-user' or 'gemini'. The participant ID can contain lowercase letters, numbers, and hyphens; that is, it must match the regular expression: `^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$`. The maximum length is 63 characters. + }, + ], + }, "table": { # Structured content to inspect. Up to 50,000 `Value`s per request allowed. See https://cloud.google.com/sensitive-data-protection/docs/inspecting-structured-text#inspecting_a_table to learn more. # Structured content for inspection. See https://cloud.google.com/sensitive-data-protection/docs/inspecting-text#inspecting_a_table to learn more. "headers": [ # Headers of the table. { # General identifier of a data field in a storage service. @@ -3744,6 +3816,13 @@

Method Details

{ # Results of re-identifying an item. "item": { # Type of content to inspect. # The re-identified item. + "batchContentItem": { # Represents a batch of content to inspect or redact. # Represents a batch of items to inspect. + "stringValueBatch": { # Represents a batch of string values to inspect or redact. # Optional. Represents a batch of string values to inspect or redact. + "values": [ # Optional. Represents string data to inspect or redact. + "A String", + ], + }, + }, "byteItem": { # Container for bytes to inspect or redact. # Content data to inspect or redact. Replaces `type` and `data`. "data": "A String", # Content data to inspect or redact. "type": "A String", # The type of data stored in the bytes string. Default will be TEXT_UTF8. @@ -3756,6 +3835,15 @@

Method Details

}, ], }, + "conversation": { # Complete conversation or slice of a conversation. It is assumed that all included messages are contiguous and ordered in chronological order. # Represents a conversation (either complete or a slice). It is assumed that all included messages are contiguous and ordered in chronological order. + "messages": [ # Messages exchanged within this conversation. The maximum number of messages allowed is 50k. The order of the messages is assumed to be chronological and will be used to index findings in the response. + { # Single message in a conversation. + "content": "A String", # The contents of this message. + "messageType": "A String", # The type of message. + "participantId": "A String", # Optional. The identifier of the participant. For example 'test-user' or 'gemini'. The participant ID can contain lowercase letters, numbers, and hyphens; that is, it must match the regular expression: `^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$`. The maximum length is 63 characters. + }, + ], + }, "table": { # Structured content to inspect. Up to 50,000 `Value`s per request allowed. See https://cloud.google.com/sensitive-data-protection/docs/inspecting-structured-text#inspecting_a_table to learn more. # Structured content for inspection. See https://cloud.google.com/sensitive-data-protection/docs/inspecting-text#inspecting_a_table to learn more. "headers": [ # Headers of the table. { # General identifier of a data field in a storage service. diff --git a/docs/dyn/dlp_v2.projects.locations.dlpJobs.html b/docs/dyn/dlp_v2.projects.locations.dlpJobs.html index 99ec71825c..0c7dd4fc45 100644 --- a/docs/dyn/dlp_v2.projects.locations.dlpJobs.html +++ b/docs/dyn/dlp_v2.projects.locations.dlpJobs.html @@ -3688,7 +3688,7 @@

Method Details

}, }, "snapshotInspectTemplate": { # The inspectTemplate contains a configuration (set of types of sensitive data to be detected) to be used anywhere you otherwise would normally specify InspectConfig. See https://cloud.google.com/sensitive-data-protection/docs/concepts-templates to learn more. # If run with an InspectTemplate, a snapshot of its state at the time of this run. - "allowLimitedAvailabilityInfoTypes": True or False, # Optional. Enables the use of limited-availability built-in infoTypes in inspect_config. These infoTypes are supported only in specific regions and can cause scanning errors if used elsewhere. For more information, see https://cloud.google.com/sensitive-data-protection/docs/locations#location-specific_limitations to learn more about location-specific limitations. + "allowLimitedAvailabilityInfoTypes": True or False, # Optional. Enables the use of [limited-availability built-in infoTypes](https://docs.cloud.google.com/sensitive-data-protection/docs/infotypes-reference#limited-availability-infotypes) in inspect_config. These infoTypes are supported only in specific regions and can cause scanning errors if used elsewhere. "createTime": "A String", # Output only. The creation timestamp of an inspectTemplate. "description": "A String", # Short description (max 256 chars). "displayName": "A String", # Display name (max 256 chars). @@ -7574,7 +7574,7 @@

Method Details

}, }, "snapshotInspectTemplate": { # The inspectTemplate contains a configuration (set of types of sensitive data to be detected) to be used anywhere you otherwise would normally specify InspectConfig. See https://cloud.google.com/sensitive-data-protection/docs/concepts-templates to learn more. # If run with an InspectTemplate, a snapshot of its state at the time of this run. - "allowLimitedAvailabilityInfoTypes": True or False, # Optional. Enables the use of limited-availability built-in infoTypes in inspect_config. These infoTypes are supported only in specific regions and can cause scanning errors if used elsewhere. For more information, see https://cloud.google.com/sensitive-data-protection/docs/locations#location-specific_limitations to learn more about location-specific limitations. + "allowLimitedAvailabilityInfoTypes": True or False, # Optional. Enables the use of [limited-availability built-in infoTypes](https://docs.cloud.google.com/sensitive-data-protection/docs/infotypes-reference#limited-availability-infotypes) in inspect_config. These infoTypes are supported only in specific regions and can cause scanning errors if used elsewhere. "createTime": "A String", # Output only. The creation timestamp of an inspectTemplate. "description": "A String", # Short description (max 256 chars). "displayName": "A String", # Display name (max 256 chars). @@ -8445,6 +8445,13 @@

Method Details

}, }, "item": { # Type of content to inspect. # The item to inspect. + "batchContentItem": { # Represents a batch of content to inspect or redact. # Represents a batch of items to inspect. + "stringValueBatch": { # Represents a batch of string values to inspect or redact. # Optional. Represents a batch of string values to inspect or redact. + "values": [ # Optional. Represents string data to inspect or redact. + "A String", + ], + }, + }, "byteItem": { # Container for bytes to inspect or redact. # Content data to inspect or redact. Replaces `type` and `data`. "data": "A String", # Content data to inspect or redact. "type": "A String", # The type of data stored in the bytes string. Default will be TEXT_UTF8. @@ -8457,6 +8464,15 @@

Method Details

}, ], }, + "conversation": { # Complete conversation or slice of a conversation. It is assumed that all included messages are contiguous and ordered in chronological order. # Represents a conversation (either complete or a slice). It is assumed that all included messages are contiguous and ordered in chronological order. + "messages": [ # Messages exchanged within this conversation. The maximum number of messages allowed is 50k. The order of the messages is assumed to be chronological and will be used to index findings in the response. + { # Single message in a conversation. + "content": "A String", # The contents of this message. + "messageType": "A String", # The type of message. + "participantId": "A String", # Optional. The identifier of the participant. For example 'test-user' or 'gemini'. The participant ID can contain lowercase letters, numbers, and hyphens; that is, it must match the regular expression: `^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$`. The maximum length is 63 characters. + }, + ], + }, "table": { # Structured content to inspect. Up to 50,000 `Value`s per request allowed. See https://cloud.google.com/sensitive-data-protection/docs/inspecting-structured-text#inspecting_a_table to learn more. # Structured content for inspection. See https://cloud.google.com/sensitive-data-protection/docs/inspecting-text#inspecting_a_table to learn more. "headers": [ # Headers of the table. { # General identifier of a data field in a storage service. @@ -11526,7 +11542,7 @@

Method Details

}, }, "snapshotInspectTemplate": { # The inspectTemplate contains a configuration (set of types of sensitive data to be detected) to be used anywhere you otherwise would normally specify InspectConfig. See https://cloud.google.com/sensitive-data-protection/docs/concepts-templates to learn more. # If run with an InspectTemplate, a snapshot of its state at the time of this run. - "allowLimitedAvailabilityInfoTypes": True or False, # Optional. Enables the use of limited-availability built-in infoTypes in inspect_config. These infoTypes are supported only in specific regions and can cause scanning errors if used elsewhere. For more information, see https://cloud.google.com/sensitive-data-protection/docs/locations#location-specific_limitations to learn more about location-specific limitations. + "allowLimitedAvailabilityInfoTypes": True or False, # Optional. Enables the use of [limited-availability built-in infoTypes](https://docs.cloud.google.com/sensitive-data-protection/docs/infotypes-reference#limited-availability-infotypes) in inspect_config. These infoTypes are supported only in specific regions and can cause scanning errors if used elsewhere. "createTime": "A String", # Output only. The creation timestamp of an inspectTemplate. "description": "A String", # Short description (max 256 chars). "displayName": "A String", # Display name (max 256 chars). diff --git a/docs/dyn/dlp_v2.projects.locations.image.html b/docs/dyn/dlp_v2.projects.locations.image.html index 982305be15..88854071a8 100644 --- a/docs/dyn/dlp_v2.projects.locations.image.html +++ b/docs/dyn/dlp_v2.projects.locations.image.html @@ -411,9 +411,17 @@

Method Details

}, "contentLocations": [ # List of nested objects pointing to the precise location of the finding within the file or record. { # Precise location of the finding within a document, record, image, or metadata container. + "batchContentLocation": { # Location within a batch of content. # Location within a batch of content. + "itemIndex": 42, # Matches an index of a batch item in the batch provided in the request. + }, "containerName": "A String", # Name of the container where the finding is located. The top level name is the source file name or table name. Names of some common storage containers are formatted as follows: * BigQuery tables: `{project_id}:{dataset_id}.{table_id}` * Cloud Storage files: `gs://{bucket}/{path}` * Datastore namespace: {namespace} Nested names could be absent if the embedded object has no string identifier (for example, an image contained within a document). "containerTimestamp": "A String", # Finding container modification timestamp, if applicable. For Cloud Storage, this field contains the last file modification timestamp. For a BigQuery table, this field contains the last_modified_time property. For Datastore, this field isn't populated. "containerVersion": "A String", # Finding container version, if available ("generation" for Cloud Storage). + "conversationLocation": { # Location within a conversation. # Location within a conversation. + "allMessages": { # If set, indicates that the finding applies to all messages in the conversation. # If set, indicates that the finding applies to all messages in the conversation. + }, + "messageIndex": 42, # Matches an index of a message in the conversation provided in the request. + }, "documentLocation": { # Location of a finding within a document. # Location data for document files. "fileOffset": "A String", # Offset of the line, from the beginning of the file, where the finding is located. }, diff --git a/docs/dyn/dlp_v2.projects.locations.inspectTemplates.html b/docs/dyn/dlp_v2.projects.locations.inspectTemplates.html index a1936fe8b6..a296f15e5d 100644 --- a/docs/dyn/dlp_v2.projects.locations.inspectTemplates.html +++ b/docs/dyn/dlp_v2.projects.locations.inspectTemplates.html @@ -112,7 +112,7 @@

Method Details

{ # Request message for CreateInspectTemplate. "inspectTemplate": { # The inspectTemplate contains a configuration (set of types of sensitive data to be detected) to be used anywhere you otherwise would normally specify InspectConfig. See https://cloud.google.com/sensitive-data-protection/docs/concepts-templates to learn more. # Required. The InspectTemplate to create. - "allowLimitedAvailabilityInfoTypes": True or False, # Optional. Enables the use of limited-availability built-in infoTypes in inspect_config. These infoTypes are supported only in specific regions and can cause scanning errors if used elsewhere. For more information, see https://cloud.google.com/sensitive-data-protection/docs/locations#location-specific_limitations to learn more about location-specific limitations. + "allowLimitedAvailabilityInfoTypes": True or False, # Optional. Enables the use of [limited-availability built-in infoTypes](https://docs.cloud.google.com/sensitive-data-protection/docs/infotypes-reference#limited-availability-infotypes) in inspect_config. These infoTypes are supported only in specific regions and can cause scanning errors if used elsewhere. "createTime": "A String", # Output only. The creation timestamp of an inspectTemplate. "description": "A String", # Short description (max 256 chars). "displayName": "A String", # Display name (max 256 chars). @@ -372,7 +372,7 @@

Method Details

An object of the form: { # The inspectTemplate contains a configuration (set of types of sensitive data to be detected) to be used anywhere you otherwise would normally specify InspectConfig. See https://cloud.google.com/sensitive-data-protection/docs/concepts-templates to learn more. - "allowLimitedAvailabilityInfoTypes": True or False, # Optional. Enables the use of limited-availability built-in infoTypes in inspect_config. These infoTypes are supported only in specific regions and can cause scanning errors if used elsewhere. For more information, see https://cloud.google.com/sensitive-data-protection/docs/locations#location-specific_limitations to learn more about location-specific limitations. + "allowLimitedAvailabilityInfoTypes": True or False, # Optional. Enables the use of [limited-availability built-in infoTypes](https://docs.cloud.google.com/sensitive-data-protection/docs/infotypes-reference#limited-availability-infotypes) in inspect_config. These infoTypes are supported only in specific regions and can cause scanning errors if used elsewhere. "createTime": "A String", # Output only. The creation timestamp of an inspectTemplate. "description": "A String", # Short description (max 256 chars). "displayName": "A String", # Display name (max 256 chars). @@ -654,7 +654,7 @@

Method Details

An object of the form: { # The inspectTemplate contains a configuration (set of types of sensitive data to be detected) to be used anywhere you otherwise would normally specify InspectConfig. See https://cloud.google.com/sensitive-data-protection/docs/concepts-templates to learn more. - "allowLimitedAvailabilityInfoTypes": True or False, # Optional. Enables the use of limited-availability built-in infoTypes in inspect_config. These infoTypes are supported only in specific regions and can cause scanning errors if used elsewhere. For more information, see https://cloud.google.com/sensitive-data-protection/docs/locations#location-specific_limitations to learn more about location-specific limitations. + "allowLimitedAvailabilityInfoTypes": True or False, # Optional. Enables the use of [limited-availability built-in infoTypes](https://docs.cloud.google.com/sensitive-data-protection/docs/infotypes-reference#limited-availability-infotypes) in inspect_config. These infoTypes are supported only in specific regions and can cause scanning errors if used elsewhere. "createTime": "A String", # Output only. The creation timestamp of an inspectTemplate. "description": "A String", # Short description (max 256 chars). "displayName": "A String", # Display name (max 256 chars). @@ -924,7 +924,7 @@

Method Details

{ # Response message for ListInspectTemplates. "inspectTemplates": [ # List of inspectTemplates, up to page_size in ListInspectTemplatesRequest. { # The inspectTemplate contains a configuration (set of types of sensitive data to be detected) to be used anywhere you otherwise would normally specify InspectConfig. See https://cloud.google.com/sensitive-data-protection/docs/concepts-templates to learn more. - "allowLimitedAvailabilityInfoTypes": True or False, # Optional. Enables the use of limited-availability built-in infoTypes in inspect_config. These infoTypes are supported only in specific regions and can cause scanning errors if used elsewhere. For more information, see https://cloud.google.com/sensitive-data-protection/docs/locations#location-specific_limitations to learn more about location-specific limitations. + "allowLimitedAvailabilityInfoTypes": True or False, # Optional. Enables the use of [limited-availability built-in infoTypes](https://docs.cloud.google.com/sensitive-data-protection/docs/infotypes-reference#limited-availability-infotypes) in inspect_config. These infoTypes are supported only in specific regions and can cause scanning errors if used elsewhere. "createTime": "A String", # Output only. The creation timestamp of an inspectTemplate. "description": "A String", # Short description (max 256 chars). "displayName": "A String", # Display name (max 256 chars). @@ -1201,7 +1201,7 @@

Method Details

{ # Request message for UpdateInspectTemplate. "inspectTemplate": { # The inspectTemplate contains a configuration (set of types of sensitive data to be detected) to be used anywhere you otherwise would normally specify InspectConfig. See https://cloud.google.com/sensitive-data-protection/docs/concepts-templates to learn more. # New InspectTemplate value. - "allowLimitedAvailabilityInfoTypes": True or False, # Optional. Enables the use of limited-availability built-in infoTypes in inspect_config. These infoTypes are supported only in specific regions and can cause scanning errors if used elsewhere. For more information, see https://cloud.google.com/sensitive-data-protection/docs/locations#location-specific_limitations to learn more about location-specific limitations. + "allowLimitedAvailabilityInfoTypes": True or False, # Optional. Enables the use of [limited-availability built-in infoTypes](https://docs.cloud.google.com/sensitive-data-protection/docs/infotypes-reference#limited-availability-infotypes) in inspect_config. These infoTypes are supported only in specific regions and can cause scanning errors if used elsewhere. "createTime": "A String", # Output only. The creation timestamp of an inspectTemplate. "description": "A String", # Short description (max 256 chars). "displayName": "A String", # Display name (max 256 chars). @@ -1460,7 +1460,7 @@

Method Details

An object of the form: { # The inspectTemplate contains a configuration (set of types of sensitive data to be detected) to be used anywhere you otherwise would normally specify InspectConfig. See https://cloud.google.com/sensitive-data-protection/docs/concepts-templates to learn more. - "allowLimitedAvailabilityInfoTypes": True or False, # Optional. Enables the use of limited-availability built-in infoTypes in inspect_config. These infoTypes are supported only in specific regions and can cause scanning errors if used elsewhere. For more information, see https://cloud.google.com/sensitive-data-protection/docs/locations#location-specific_limitations to learn more about location-specific limitations. + "allowLimitedAvailabilityInfoTypes": True or False, # Optional. Enables the use of [limited-availability built-in infoTypes](https://docs.cloud.google.com/sensitive-data-protection/docs/infotypes-reference#limited-availability-infotypes) in inspect_config. These infoTypes are supported only in specific regions and can cause scanning errors if used elsewhere. "createTime": "A String", # Output only. The creation timestamp of an inspectTemplate. "description": "A String", # Short description (max 256 chars). "displayName": "A String", # Display name (max 256 chars). diff --git a/docs/dyn/dlp_v2.projects.locations.jobTriggers.html b/docs/dyn/dlp_v2.projects.locations.jobTriggers.html index fbcaf047c7..20cbc4682d 100644 --- a/docs/dyn/dlp_v2.projects.locations.jobTriggers.html +++ b/docs/dyn/dlp_v2.projects.locations.jobTriggers.html @@ -3116,7 +3116,7 @@

Method Details

}, }, "snapshotInspectTemplate": { # The inspectTemplate contains a configuration (set of types of sensitive data to be detected) to be used anywhere you otherwise would normally specify InspectConfig. See https://cloud.google.com/sensitive-data-protection/docs/concepts-templates to learn more. # If run with an InspectTemplate, a snapshot of its state at the time of this run. - "allowLimitedAvailabilityInfoTypes": True or False, # Optional. Enables the use of limited-availability built-in infoTypes in inspect_config. These infoTypes are supported only in specific regions and can cause scanning errors if used elsewhere. For more information, see https://cloud.google.com/sensitive-data-protection/docs/locations#location-specific_limitations to learn more about location-specific limitations. + "allowLimitedAvailabilityInfoTypes": True or False, # Optional. Enables the use of [limited-availability built-in infoTypes](https://docs.cloud.google.com/sensitive-data-protection/docs/infotypes-reference#limited-availability-infotypes) in inspect_config. These infoTypes are supported only in specific regions and can cause scanning errors if used elsewhere. "createTime": "A String", # Output only. The creation timestamp of an inspectTemplate. "description": "A String", # Short description (max 256 chars). "displayName": "A String", # Display name (max 256 chars). @@ -5271,6 +5271,13 @@

Method Details

}, }, "item": { # Type of content to inspect. # The item to inspect. + "batchContentItem": { # Represents a batch of content to inspect or redact. # Represents a batch of items to inspect. + "stringValueBatch": { # Represents a batch of string values to inspect or redact. # Optional. Represents a batch of string values to inspect or redact. + "values": [ # Optional. Represents string data to inspect or redact. + "A String", + ], + }, + }, "byteItem": { # Container for bytes to inspect or redact. # Content data to inspect or redact. Replaces `type` and `data`. "data": "A String", # Content data to inspect or redact. "type": "A String", # The type of data stored in the bytes string. Default will be TEXT_UTF8. @@ -5283,6 +5290,15 @@

Method Details

}, ], }, + "conversation": { # Complete conversation or slice of a conversation. It is assumed that all included messages are contiguous and ordered in chronological order. # Represents a conversation (either complete or a slice). It is assumed that all included messages are contiguous and ordered in chronological order. + "messages": [ # Messages exchanged within this conversation. The maximum number of messages allowed is 50k. The order of the messages is assumed to be chronological and will be used to index findings in the response. + { # Single message in a conversation. + "content": "A String", # The contents of this message. + "messageType": "A String", # The type of message. + "participantId": "A String", # Optional. The identifier of the participant. For example 'test-user' or 'gemini'. The participant ID can contain lowercase letters, numbers, and hyphens; that is, it must match the regular expression: `^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$`. The maximum length is 63 characters. + }, + ], + }, "table": { # Structured content to inspect. Up to 50,000 `Value`s per request allowed. See https://cloud.google.com/sensitive-data-protection/docs/inspecting-structured-text#inspecting_a_table to learn more. # Structured content for inspection. See https://cloud.google.com/sensitive-data-protection/docs/inspecting-text#inspecting_a_table to learn more. "headers": [ # Headers of the table. { # General identifier of a data field in a storage service. diff --git a/docs/dyn/firebaseapphosting_v1.projects.locations.backends.traffic.html b/docs/dyn/firebaseapphosting_v1.projects.locations.backends.traffic.html index 6f4b451f90..c71b4be6f8 100644 --- a/docs/dyn/firebaseapphosting_v1.projects.locations.backends.traffic.html +++ b/docs/dyn/firebaseapphosting_v1.projects.locations.backends.traffic.html @@ -126,13 +126,13 @@

Method Details

"codebaseBranch": "A String", # If set, specifies a branch that triggers a new build to be started with this policy. Otherwise, no automatic rollouts will happen. "disabled": True or False, # Optional. A flag that, if true, prevents automatic rollouts from being created via this RolloutPolicy. "disabledTime": "A String", # Output only. If `disabled` is set, the time at which the automatic rollouts were disabled. - "ignoredPaths": [ # Optional. A list of file paths patterns to exclude from triggering a rollout. Patterns in this list take precedence over required_paths. **Note**: All paths must be in the ignored_paths in order for the rollout to be skipped. Limited to 100 paths. Example: ignored_paths: { pattern: "foo/bar/excluded/*” type: GLOB } + "ignoredPaths": [ # Optional. A list of file paths patterns to exclude from triggering a rollout. Patterns in this list take precedence over required_paths. **Note**: All paths must be in the ignored_paths in order for the rollout to be skipped. Limited to 100 paths. Example: ``` ignored_paths: { pattern: "foo/bar/excluded/*", type: "GLOB" } ``` { # A file path pattern to match against. "pattern": "A String", # Optional. The pattern to match against. "type": "A String", # Optional. The type of pattern to match against. }, ], - "requiredPaths": [ # Optional. A list of file paths patterns that trigger a build and rollout if at least one of the changed files in the commit are present in this list. This field is optional; the rollout policy will default to triggering on all paths if both ignored_paths and required_paths are not populated. Limited to 100 paths. Example: “required_paths: { pattern: "foo/bar/*” type: GLOB } + "requiredPaths": [ # Optional. A list of file paths patterns that trigger a build and rollout if at least one of the changed files in the commit are present in this list. This field is optional; the rollout policy will default to triggering on all paths if both ignored_paths and required_paths are not populated. Limited to 100 paths. Example: ``` required_paths: { pattern: "foo/bar/*", type: "GLOB" } ``` { # A file path pattern to match against. "pattern": "A String", # Optional. The pattern to match against. "type": "A String", # Optional. The type of pattern to match against. @@ -184,13 +184,13 @@

Method Details

"codebaseBranch": "A String", # If set, specifies a branch that triggers a new build to be started with this policy. Otherwise, no automatic rollouts will happen. "disabled": True or False, # Optional. A flag that, if true, prevents automatic rollouts from being created via this RolloutPolicy. "disabledTime": "A String", # Output only. If `disabled` is set, the time at which the automatic rollouts were disabled. - "ignoredPaths": [ # Optional. A list of file paths patterns to exclude from triggering a rollout. Patterns in this list take precedence over required_paths. **Note**: All paths must be in the ignored_paths in order for the rollout to be skipped. Limited to 100 paths. Example: ignored_paths: { pattern: "foo/bar/excluded/*” type: GLOB } + "ignoredPaths": [ # Optional. A list of file paths patterns to exclude from triggering a rollout. Patterns in this list take precedence over required_paths. **Note**: All paths must be in the ignored_paths in order for the rollout to be skipped. Limited to 100 paths. Example: ``` ignored_paths: { pattern: "foo/bar/excluded/*", type: "GLOB" } ``` { # A file path pattern to match against. "pattern": "A String", # Optional. The pattern to match against. "type": "A String", # Optional. The type of pattern to match against. }, ], - "requiredPaths": [ # Optional. A list of file paths patterns that trigger a build and rollout if at least one of the changed files in the commit are present in this list. This field is optional; the rollout policy will default to triggering on all paths if both ignored_paths and required_paths are not populated. Limited to 100 paths. Example: “required_paths: { pattern: "foo/bar/*” type: GLOB } + "requiredPaths": [ # Optional. A list of file paths patterns that trigger a build and rollout if at least one of the changed files in the commit are present in this list. This field is optional; the rollout policy will default to triggering on all paths if both ignored_paths and required_paths are not populated. Limited to 100 paths. Example: ``` required_paths: { pattern: "foo/bar/*", type: "GLOB" } ``` { # A file path pattern to match against. "pattern": "A String", # Optional. The pattern to match against. "type": "A String", # Optional. The type of pattern to match against. diff --git a/docs/dyn/firebaseapphosting_v1beta.projects.locations.backends.html b/docs/dyn/firebaseapphosting_v1beta.projects.locations.backends.html index e1aeba1802..efc5165513 100644 --- a/docs/dyn/firebaseapphosting_v1beta.projects.locations.backends.html +++ b/docs/dyn/firebaseapphosting_v1beta.projects.locations.backends.html @@ -135,6 +135,7 @@

Method Details

"a_key": "A String", }, "appId": "A String", # Optional. The [ID of a Web App](https://firebase.google.com/docs/reference/firebase-management/rest/v1beta1/projects.webApps#WebApp.FIELDS.app_id) associated with the backend. + "automaticBaseImageUpdatesDisabled": True or False, # Optional. automatic_base_image_updates_disabled acts as a way for users to opt out of ABIU. "codebase": { # The connection to an external source repository to watch for event-driven updates to the backend. # Optional. If specified, the connection to an external source repository to watch for event-driven updates to the backend. "repository": "A String", # Required. The resource name for the Developer Connect [`gitRepositoryLink`](https://cloud.google.com/developer-connect/docs/api/reference/rest/v1/projects.locations.connections.gitRepositoryLinks) connected to this backend, in the format: `projects/{project}/locations/{location}/connections/{connection}/gitRepositoryLinks/{repositoryLink}` The connection for the `gitRepositoryLink` must made be using the Firebase App Hosting GitHub App via the Firebase Console. "rootDirectory": "A String", # Optional. If `repository` is provided, the directory relative to the root of the repository to use as the root for the deployed web app. Defaults to use the root of the repository if not provided. If deploying a [monorepo](https://firebase.google.com/docs/app-hosting/monorepos), this should be the directory that contains the `package.json` or `apphosting.yaml` file. @@ -170,6 +171,9 @@

Method Details

], "reconciling": True or False, # Output only. A field that, if true, indicates that the system is working to make adjustments to the backend during a LRO. "requestLogsDisabled": True or False, # Optional. A field that, if true, indicates that incoming request logs are disabled for this backend. Incoming request logs are enabled by default. + "runtime": { # Runtime is a string that represents the runtime that is used to build the backend. Users can specify one of the following runtimes: nodejs20, nodejs22, nodejs24, nodejs. Runtime "nodejs" means that nodejs version will be determined at build time. If not specified or specified with a value that is not in the list above, the default runtime `nodejs` will be used and Automatic Base Image Updates will be disabled. # Optional. The runtime that the backend will be built on. A default base_image will be chosen for a given runtime. + "value": "A String", # Optional. The value of the runtime. + }, "serviceAccount": "A String", # Required. The name of the service account used for Cloud Build and Cloud Run. Should have the role roles/firebaseapphosting.computeRunner or equivalent permissions. "servingLocality": "A String", # Required. Immutable. Specifies how App Hosting will serve the content for this backend. It will either be contained to a single region (REGIONAL_STRICT) or allowed to use App Hosting's global-replicated serving infrastructure (GLOBAL_ACCESS). "uid": "A String", # Output only. System-assigned, unique identifier. @@ -267,6 +271,7 @@

Method Details

"a_key": "A String", }, "appId": "A String", # Optional. The [ID of a Web App](https://firebase.google.com/docs/reference/firebase-management/rest/v1beta1/projects.webApps#WebApp.FIELDS.app_id) associated with the backend. + "automaticBaseImageUpdatesDisabled": True or False, # Optional. automatic_base_image_updates_disabled acts as a way for users to opt out of ABIU. "codebase": { # The connection to an external source repository to watch for event-driven updates to the backend. # Optional. If specified, the connection to an external source repository to watch for event-driven updates to the backend. "repository": "A String", # Required. The resource name for the Developer Connect [`gitRepositoryLink`](https://cloud.google.com/developer-connect/docs/api/reference/rest/v1/projects.locations.connections.gitRepositoryLinks) connected to this backend, in the format: `projects/{project}/locations/{location}/connections/{connection}/gitRepositoryLinks/{repositoryLink}` The connection for the `gitRepositoryLink` must made be using the Firebase App Hosting GitHub App via the Firebase Console. "rootDirectory": "A String", # Optional. If `repository` is provided, the directory relative to the root of the repository to use as the root for the deployed web app. Defaults to use the root of the repository if not provided. If deploying a [monorepo](https://firebase.google.com/docs/app-hosting/monorepos), this should be the directory that contains the `package.json` or `apphosting.yaml` file. @@ -302,6 +307,9 @@

Method Details

], "reconciling": True or False, # Output only. A field that, if true, indicates that the system is working to make adjustments to the backend during a LRO. "requestLogsDisabled": True or False, # Optional. A field that, if true, indicates that incoming request logs are disabled for this backend. Incoming request logs are enabled by default. + "runtime": { # Runtime is a string that represents the runtime that is used to build the backend. Users can specify one of the following runtimes: nodejs20, nodejs22, nodejs24, nodejs. Runtime "nodejs" means that nodejs version will be determined at build time. If not specified or specified with a value that is not in the list above, the default runtime `nodejs` will be used and Automatic Base Image Updates will be disabled. # Optional. The runtime that the backend will be built on. A default base_image will be chosen for a given runtime. + "value": "A String", # Optional. The value of the runtime. + }, "serviceAccount": "A String", # Required. The name of the service account used for Cloud Build and Cloud Run. Should have the role roles/firebaseapphosting.computeRunner or equivalent permissions. "servingLocality": "A String", # Required. Immutable. Specifies how App Hosting will serve the content for this backend. It will either be contained to a single region (REGIONAL_STRICT) or allowed to use App Hosting's global-replicated serving infrastructure (GLOBAL_ACCESS). "uid": "A String", # Output only. System-assigned, unique identifier. @@ -336,6 +344,7 @@

Method Details

"a_key": "A String", }, "appId": "A String", # Optional. The [ID of a Web App](https://firebase.google.com/docs/reference/firebase-management/rest/v1beta1/projects.webApps#WebApp.FIELDS.app_id) associated with the backend. + "automaticBaseImageUpdatesDisabled": True or False, # Optional. automatic_base_image_updates_disabled acts as a way for users to opt out of ABIU. "codebase": { # The connection to an external source repository to watch for event-driven updates to the backend. # Optional. If specified, the connection to an external source repository to watch for event-driven updates to the backend. "repository": "A String", # Required. The resource name for the Developer Connect [`gitRepositoryLink`](https://cloud.google.com/developer-connect/docs/api/reference/rest/v1/projects.locations.connections.gitRepositoryLinks) connected to this backend, in the format: `projects/{project}/locations/{location}/connections/{connection}/gitRepositoryLinks/{repositoryLink}` The connection for the `gitRepositoryLink` must made be using the Firebase App Hosting GitHub App via the Firebase Console. "rootDirectory": "A String", # Optional. If `repository` is provided, the directory relative to the root of the repository to use as the root for the deployed web app. Defaults to use the root of the repository if not provided. If deploying a [monorepo](https://firebase.google.com/docs/app-hosting/monorepos), this should be the directory that contains the `package.json` or `apphosting.yaml` file. @@ -371,6 +380,9 @@

Method Details

], "reconciling": True or False, # Output only. A field that, if true, indicates that the system is working to make adjustments to the backend during a LRO. "requestLogsDisabled": True or False, # Optional. A field that, if true, indicates that incoming request logs are disabled for this backend. Incoming request logs are enabled by default. + "runtime": { # Runtime is a string that represents the runtime that is used to build the backend. Users can specify one of the following runtimes: nodejs20, nodejs22, nodejs24, nodejs. Runtime "nodejs" means that nodejs version will be determined at build time. If not specified or specified with a value that is not in the list above, the default runtime `nodejs` will be used and Automatic Base Image Updates will be disabled. # Optional. The runtime that the backend will be built on. A default base_image will be chosen for a given runtime. + "value": "A String", # Optional. The value of the runtime. + }, "serviceAccount": "A String", # Required. The name of the service account used for Cloud Build and Cloud Run. Should have the role roles/firebaseapphosting.computeRunner or equivalent permissions. "servingLocality": "A String", # Required. Immutable. Specifies how App Hosting will serve the content for this backend. It will either be contained to a single region (REGIONAL_STRICT) or allowed to use App Hosting's global-replicated serving infrastructure (GLOBAL_ACCESS). "uid": "A String", # Output only. System-assigned, unique identifier. @@ -413,6 +425,7 @@

Method Details

"a_key": "A String", }, "appId": "A String", # Optional. The [ID of a Web App](https://firebase.google.com/docs/reference/firebase-management/rest/v1beta1/projects.webApps#WebApp.FIELDS.app_id) associated with the backend. + "automaticBaseImageUpdatesDisabled": True or False, # Optional. automatic_base_image_updates_disabled acts as a way for users to opt out of ABIU. "codebase": { # The connection to an external source repository to watch for event-driven updates to the backend. # Optional. If specified, the connection to an external source repository to watch for event-driven updates to the backend. "repository": "A String", # Required. The resource name for the Developer Connect [`gitRepositoryLink`](https://cloud.google.com/developer-connect/docs/api/reference/rest/v1/projects.locations.connections.gitRepositoryLinks) connected to this backend, in the format: `projects/{project}/locations/{location}/connections/{connection}/gitRepositoryLinks/{repositoryLink}` The connection for the `gitRepositoryLink` must made be using the Firebase App Hosting GitHub App via the Firebase Console. "rootDirectory": "A String", # Optional. If `repository` is provided, the directory relative to the root of the repository to use as the root for the deployed web app. Defaults to use the root of the repository if not provided. If deploying a [monorepo](https://firebase.google.com/docs/app-hosting/monorepos), this should be the directory that contains the `package.json` or `apphosting.yaml` file. @@ -448,6 +461,9 @@

Method Details

], "reconciling": True or False, # Output only. A field that, if true, indicates that the system is working to make adjustments to the backend during a LRO. "requestLogsDisabled": True or False, # Optional. A field that, if true, indicates that incoming request logs are disabled for this backend. Incoming request logs are enabled by default. + "runtime": { # Runtime is a string that represents the runtime that is used to build the backend. Users can specify one of the following runtimes: nodejs20, nodejs22, nodejs24, nodejs. Runtime "nodejs" means that nodejs version will be determined at build time. If not specified or specified with a value that is not in the list above, the default runtime `nodejs` will be used and Automatic Base Image Updates will be disabled. # Optional. The runtime that the backend will be built on. A default base_image will be chosen for a given runtime. + "value": "A String", # Optional. The value of the runtime. + }, "serviceAccount": "A String", # Required. The name of the service account used for Cloud Build and Cloud Run. Should have the role roles/firebaseapphosting.computeRunner or equivalent permissions. "servingLocality": "A String", # Required. Immutable. Specifies how App Hosting will serve the content for this backend. It will either be contained to a single region (REGIONAL_STRICT) or allowed to use App Hosting's global-replicated serving infrastructure (GLOBAL_ACCESS). "uid": "A String", # Output only. System-assigned, unique identifier. diff --git a/docs/dyn/firebaseapphosting_v1beta.projects.locations.backends.traffic.html b/docs/dyn/firebaseapphosting_v1beta.projects.locations.backends.traffic.html index ffa801ec48..69f00b3eb5 100644 --- a/docs/dyn/firebaseapphosting_v1beta.projects.locations.backends.traffic.html +++ b/docs/dyn/firebaseapphosting_v1beta.projects.locations.backends.traffic.html @@ -126,13 +126,13 @@

Method Details

"codebaseBranch": "A String", # If set, specifies a branch that triggers a new build to be started with this policy. Otherwise, no automatic rollouts will happen. "disabled": True or False, # Optional. A flag that, if true, prevents automatic rollouts from being created via this RolloutPolicy. "disabledTime": "A String", # Output only. If `disabled` is set, the time at which the automatic rollouts were disabled. - "ignoredPaths": [ # Optional. A list of file paths patterns to exclude from triggering a rollout. Patterns in this list take precedence over required_paths. **Note**: All paths must be in the ignored_paths in order for the rollout to be skipped. Limited to 100 paths. Example: ignored_paths: { pattern: "foo/bar/excluded/*” type: GLOB } + "ignoredPaths": [ # Optional. A list of file paths patterns to exclude from triggering a rollout. Patterns in this list take precedence over required_paths. **Note**: All paths must be in the ignored_paths in order for the rollout to be skipped. Limited to 100 paths. Example: ``` ignored_paths: { pattern: "foo/bar/excluded/*", type: "GLOB" } ``` { # A file path pattern to match against. "pattern": "A String", # Optional. The pattern to match against. "type": "A String", # Optional. The type of pattern to match against. }, ], - "requiredPaths": [ # Optional. A list of file paths patterns that trigger a build and rollout if at least one of the changed files in the commit are present in this list. This field is optional; the rollout policy will default to triggering on all paths if both ignored_paths and required_paths are not populated. Limited to 100 paths. Example: “required_paths: { pattern: "foo/bar/*” type: GLOB } + "requiredPaths": [ # Optional. A list of file paths patterns that trigger a build and rollout if at least one of the changed files in the commit are present in this list. This field is optional; the rollout policy will default to triggering on all paths if both ignored_paths and required_paths are not populated. Limited to 100 paths. Example: ``` required_paths: { pattern: "foo/bar/*", type: "GLOB" } ``` { # A file path pattern to match against. "pattern": "A String", # Optional. The pattern to match against. "type": "A String", # Optional. The type of pattern to match against. @@ -184,13 +184,13 @@

Method Details

"codebaseBranch": "A String", # If set, specifies a branch that triggers a new build to be started with this policy. Otherwise, no automatic rollouts will happen. "disabled": True or False, # Optional. A flag that, if true, prevents automatic rollouts from being created via this RolloutPolicy. "disabledTime": "A String", # Output only. If `disabled` is set, the time at which the automatic rollouts were disabled. - "ignoredPaths": [ # Optional. A list of file paths patterns to exclude from triggering a rollout. Patterns in this list take precedence over required_paths. **Note**: All paths must be in the ignored_paths in order for the rollout to be skipped. Limited to 100 paths. Example: ignored_paths: { pattern: "foo/bar/excluded/*” type: GLOB } + "ignoredPaths": [ # Optional. A list of file paths patterns to exclude from triggering a rollout. Patterns in this list take precedence over required_paths. **Note**: All paths must be in the ignored_paths in order for the rollout to be skipped. Limited to 100 paths. Example: ``` ignored_paths: { pattern: "foo/bar/excluded/*", type: "GLOB" } ``` { # A file path pattern to match against. "pattern": "A String", # Optional. The pattern to match against. "type": "A String", # Optional. The type of pattern to match against. }, ], - "requiredPaths": [ # Optional. A list of file paths patterns that trigger a build and rollout if at least one of the changed files in the commit are present in this list. This field is optional; the rollout policy will default to triggering on all paths if both ignored_paths and required_paths are not populated. Limited to 100 paths. Example: “required_paths: { pattern: "foo/bar/*” type: GLOB } + "requiredPaths": [ # Optional. A list of file paths patterns that trigger a build and rollout if at least one of the changed files in the commit are present in this list. This field is optional; the rollout policy will default to triggering on all paths if both ignored_paths and required_paths are not populated. Limited to 100 paths. Example: ``` required_paths: { pattern: "foo/bar/*", type: "GLOB" } ``` { # A file path pattern to match against. "pattern": "A String", # Optional. The pattern to match against. "type": "A String", # Optional. The type of pattern to match against. diff --git a/docs/dyn/firebaseml_v2beta.projects.locations.publishers.models.html b/docs/dyn/firebaseml_v2beta.projects.locations.publishers.models.html index 3666708b60..99c99e190b 100644 --- a/docs/dyn/firebaseml_v2beta.projects.locations.publishers.models.html +++ b/docs/dyn/firebaseml_v2beta.projects.locations.publishers.models.html @@ -381,7 +381,6 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. - "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. "environment": "A String", # Required. The environment being operated. "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. "A String", @@ -393,6 +392,12 @@

Method Details

"A String", ], }, + "exaAiSearch": { # ExaAiSearch tool type. A tool that uses the Exa.ai search engine for grounding. # Optional. Uses Exa.ai to search for information to answer user queries. The search results will be grounded on Exa.ai and presented to the model for response generation + "apiKey": "A String", # Required. The API key for ExaAiSearch. + "customConfigs": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. + "a_key": "", # Properties of the object. + }, + }, "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "behavior": "A String", # Optional. Specifies the function Behavior. If not specified, the system keeps the current function call behavior. This field is currently only supported by the BidiGenerateContent method. @@ -939,7 +944,6 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. - "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. "environment": "A String", # Required. The environment being operated. "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. "A String", @@ -951,6 +955,12 @@

Method Details

"A String", ], }, + "exaAiSearch": { # ExaAiSearch tool type. A tool that uses the Exa.ai search engine for grounding. # Optional. Uses Exa.ai to search for information to answer user queries. The search results will be grounded on Exa.ai and presented to the model for response generation + "apiKey": "A String", # Required. The API key for ExaAiSearch. + "customConfigs": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. + "a_key": "", # Properties of the object. + }, + }, "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "behavior": "A String", # Optional. Specifies the function Behavior. If not specified, the system keeps the current function call behavior. This field is currently only supported by the BidiGenerateContent method. @@ -1773,7 +1783,6 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. - "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. "environment": "A String", # Required. The environment being operated. "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. "A String", @@ -1785,6 +1794,12 @@

Method Details

"A String", ], }, + "exaAiSearch": { # ExaAiSearch tool type. A tool that uses the Exa.ai search engine for grounding. # Optional. Uses Exa.ai to search for information to answer user queries. The search results will be grounded on Exa.ai and presented to the model for response generation + "apiKey": "A String", # Required. The API key for ExaAiSearch. + "customConfigs": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. + "a_key": "", # Properties of the object. + }, + }, "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "behavior": "A String", # Optional. Specifies the function Behavior. If not specified, the system keeps the current function call behavior. This field is currently only supported by the BidiGenerateContent method. diff --git a/docs/dyn/gmail_v1.users.drafts.html b/docs/dyn/gmail_v1.users.drafts.html index b98ce77b88..3be74a5aa2 100644 --- a/docs/dyn/gmail_v1.users.drafts.html +++ b/docs/dyn/gmail_v1.users.drafts.html @@ -152,7 +152,7 @@

Method Details

# Object with schema name: MessagePart ], }, - "raw": "A String", # The entire email message in an RFC 2822 formatted and base64url encoded string. Returned in `messages.get` and `drafts.get` responses when the `format=RAW` parameter is supplied. + "raw": "A String", # The entire email message in an RFC 2822 formatted and base64url encoded string. Returned in `messages.get` and `drafts.get` responses when the `format=RAW` parameter is supplied. @required gmail.users.drafts.create gmail.users.drafts.update "sizeEstimate": 42, # Estimated size in bytes of the message. "snippet": "A String", # A short part of the message text. "threadId": "A String", # The ID of the thread the message belongs to. To add a message or draft to a thread, the following criteria must be met: 1. The requested `threadId` must be specified on the `Message` or `Draft.Message` you supply with your request. 2. The `References` and `In-Reply-To` headers must be set in compliance with the [RFC 2822](https://tools.ietf.org/html/rfc2822) standard. 3. The `Subject` headers must match. @@ -208,7 +208,7 @@

Method Details

# Object with schema name: MessagePart ], }, - "raw": "A String", # The entire email message in an RFC 2822 formatted and base64url encoded string. Returned in `messages.get` and `drafts.get` responses when the `format=RAW` parameter is supplied. + "raw": "A String", # The entire email message in an RFC 2822 formatted and base64url encoded string. Returned in `messages.get` and `drafts.get` responses when the `format=RAW` parameter is supplied. @required gmail.users.drafts.create gmail.users.drafts.update "sizeEstimate": 42, # Estimated size in bytes of the message. "snippet": "A String", # A short part of the message text. "threadId": "A String", # The ID of the thread the message belongs to. To add a message or draft to a thread, the following criteria must be met: 1. The requested `threadId` must be specified on the `Message` or `Draft.Message` you supply with your request. 2. The `References` and `In-Reply-To` headers must be set in compliance with the [RFC 2822](https://tools.ietf.org/html/rfc2822) standard. 3. The `Subject` headers must match. @@ -290,7 +290,7 @@

Method Details

# Object with schema name: MessagePart ], }, - "raw": "A String", # The entire email message in an RFC 2822 formatted and base64url encoded string. Returned in `messages.get` and `drafts.get` responses when the `format=RAW` parameter is supplied. + "raw": "A String", # The entire email message in an RFC 2822 formatted and base64url encoded string. Returned in `messages.get` and `drafts.get` responses when the `format=RAW` parameter is supplied. @required gmail.users.drafts.create gmail.users.drafts.update "sizeEstimate": 42, # Estimated size in bytes of the message. "snippet": "A String", # A short part of the message text. "threadId": "A String", # The ID of the thread the message belongs to. To add a message or draft to a thread, the following criteria must be met: 1. The requested `threadId` must be specified on the `Message` or `Draft.Message` you supply with your request. 2. The `References` and `In-Reply-To` headers must be set in compliance with the [RFC 2822](https://tools.ietf.org/html/rfc2822) standard. 3. The `Subject` headers must match. @@ -357,7 +357,7 @@

Method Details

# Object with schema name: MessagePart ], }, - "raw": "A String", # The entire email message in an RFC 2822 formatted and base64url encoded string. Returned in `messages.get` and `drafts.get` responses when the `format=RAW` parameter is supplied. + "raw": "A String", # The entire email message in an RFC 2822 formatted and base64url encoded string. Returned in `messages.get` and `drafts.get` responses when the `format=RAW` parameter is supplied. @required gmail.users.drafts.create gmail.users.drafts.update "sizeEstimate": 42, # Estimated size in bytes of the message. "snippet": "A String", # A short part of the message text. "threadId": "A String", # The ID of the thread the message belongs to. To add a message or draft to a thread, the following criteria must be met: 1. The requested `threadId` must be specified on the `Message` or `Draft.Message` you supply with your request. 2. The `References` and `In-Reply-To` headers must be set in compliance with the [RFC 2822](https://tools.ietf.org/html/rfc2822) standard. 3. The `Subject` headers must match. @@ -431,7 +431,7 @@

Method Details

# Object with schema name: MessagePart ], }, - "raw": "A String", # The entire email message in an RFC 2822 formatted and base64url encoded string. Returned in `messages.get` and `drafts.get` responses when the `format=RAW` parameter is supplied. + "raw": "A String", # The entire email message in an RFC 2822 formatted and base64url encoded string. Returned in `messages.get` and `drafts.get` responses when the `format=RAW` parameter is supplied. @required gmail.users.drafts.create gmail.users.drafts.update "sizeEstimate": 42, # Estimated size in bytes of the message. "snippet": "A String", # A short part of the message text. "threadId": "A String", # The ID of the thread the message belongs to. To add a message or draft to a thread, the following criteria must be met: 1. The requested `threadId` must be specified on the `Message` or `Draft.Message` you supply with your request. 2. The `References` and `In-Reply-To` headers must be set in compliance with the [RFC 2822](https://tools.ietf.org/html/rfc2822) standard. 3. The `Subject` headers must match. @@ -485,7 +485,7 @@

Method Details

# Object with schema name: MessagePart ], }, - "raw": "A String", # The entire email message in an RFC 2822 formatted and base64url encoded string. Returned in `messages.get` and `drafts.get` responses when the `format=RAW` parameter is supplied. + "raw": "A String", # The entire email message in an RFC 2822 formatted and base64url encoded string. Returned in `messages.get` and `drafts.get` responses when the `format=RAW` parameter is supplied. @required gmail.users.drafts.create gmail.users.drafts.update "sizeEstimate": 42, # Estimated size in bytes of the message. "snippet": "A String", # A short part of the message text. "threadId": "A String", # The ID of the thread the message belongs to. To add a message or draft to a thread, the following criteria must be met: 1. The requested `threadId` must be specified on the `Message` or `Draft.Message` you supply with your request. 2. The `References` and `In-Reply-To` headers must be set in compliance with the [RFC 2822](https://tools.ietf.org/html/rfc2822) standard. 3. The `Subject` headers must match. @@ -541,7 +541,7 @@

Method Details

# Object with schema name: MessagePart ], }, - "raw": "A String", # The entire email message in an RFC 2822 formatted and base64url encoded string. Returned in `messages.get` and `drafts.get` responses when the `format=RAW` parameter is supplied. + "raw": "A String", # The entire email message in an RFC 2822 formatted and base64url encoded string. Returned in `messages.get` and `drafts.get` responses when the `format=RAW` parameter is supplied. @required gmail.users.drafts.create gmail.users.drafts.update "sizeEstimate": 42, # Estimated size in bytes of the message. "snippet": "A String", # A short part of the message text. "threadId": "A String", # The ID of the thread the message belongs to. To add a message or draft to a thread, the following criteria must be met: 1. The requested `threadId` must be specified on the `Message` or `Draft.Message` you supply with your request. 2. The `References` and `In-Reply-To` headers must be set in compliance with the [RFC 2822](https://tools.ietf.org/html/rfc2822) standard. 3. The `Subject` headers must match. @@ -597,7 +597,7 @@

Method Details

# Object with schema name: MessagePart ], }, - "raw": "A String", # The entire email message in an RFC 2822 formatted and base64url encoded string. Returned in `messages.get` and `drafts.get` responses when the `format=RAW` parameter is supplied. + "raw": "A String", # The entire email message in an RFC 2822 formatted and base64url encoded string. Returned in `messages.get` and `drafts.get` responses when the `format=RAW` parameter is supplied. @required gmail.users.drafts.create gmail.users.drafts.update "sizeEstimate": 42, # Estimated size in bytes of the message. "snippet": "A String", # A short part of the message text. "threadId": "A String", # The ID of the thread the message belongs to. To add a message or draft to a thread, the following criteria must be met: 1. The requested `threadId` must be specified on the `Message` or `Draft.Message` you supply with your request. 2. The `References` and `In-Reply-To` headers must be set in compliance with the [RFC 2822](https://tools.ietf.org/html/rfc2822) standard. 3. The `Subject` headers must match. diff --git a/docs/dyn/gmail_v1.users.history.html b/docs/dyn/gmail_v1.users.history.html index 94fc125d46..249018fd6f 100644 --- a/docs/dyn/gmail_v1.users.history.html +++ b/docs/dyn/gmail_v1.users.history.html @@ -159,7 +159,7 @@

Method Details

# Object with schema name: MessagePart ], }, - "raw": "A String", # The entire email message in an RFC 2822 formatted and base64url encoded string. Returned in `messages.get` and `drafts.get` responses when the `format=RAW` parameter is supplied. + "raw": "A String", # The entire email message in an RFC 2822 formatted and base64url encoded string. Returned in `messages.get` and `drafts.get` responses when the `format=RAW` parameter is supplied. @required gmail.users.drafts.create gmail.users.drafts.update "sizeEstimate": 42, # Estimated size in bytes of the message. "snippet": "A String", # A short part of the message text. "threadId": "A String", # The ID of the thread the message belongs to. To add a message or draft to a thread, the following criteria must be met: 1. The requested `threadId` must be specified on the `Message` or `Draft.Message` you supply with your request. 2. The `References` and `In-Reply-To` headers must be set in compliance with the [RFC 2822](https://tools.ietf.org/html/rfc2822) standard. 3. The `Subject` headers must match. @@ -208,7 +208,7 @@

Method Details

# Object with schema name: MessagePart ], }, - "raw": "A String", # The entire email message in an RFC 2822 formatted and base64url encoded string. Returned in `messages.get` and `drafts.get` responses when the `format=RAW` parameter is supplied. + "raw": "A String", # The entire email message in an RFC 2822 formatted and base64url encoded string. Returned in `messages.get` and `drafts.get` responses when the `format=RAW` parameter is supplied. @required gmail.users.drafts.create gmail.users.drafts.update "sizeEstimate": 42, # Estimated size in bytes of the message. "snippet": "A String", # A short part of the message text. "threadId": "A String", # The ID of the thread the message belongs to. To add a message or draft to a thread, the following criteria must be met: 1. The requested `threadId` must be specified on the `Message` or `Draft.Message` you supply with your request. 2. The `References` and `In-Reply-To` headers must be set in compliance with the [RFC 2822](https://tools.ietf.org/html/rfc2822) standard. 3. The `Subject` headers must match. @@ -253,7 +253,7 @@

Method Details

# Object with schema name: MessagePart ], }, - "raw": "A String", # The entire email message in an RFC 2822 formatted and base64url encoded string. Returned in `messages.get` and `drafts.get` responses when the `format=RAW` parameter is supplied. + "raw": "A String", # The entire email message in an RFC 2822 formatted and base64url encoded string. Returned in `messages.get` and `drafts.get` responses when the `format=RAW` parameter is supplied. @required gmail.users.drafts.create gmail.users.drafts.update "sizeEstimate": 42, # Estimated size in bytes of the message. "snippet": "A String", # A short part of the message text. "threadId": "A String", # The ID of the thread the message belongs to. To add a message or draft to a thread, the following criteria must be met: 1. The requested `threadId` must be specified on the `Message` or `Draft.Message` you supply with your request. 2. The `References` and `In-Reply-To` headers must be set in compliance with the [RFC 2822](https://tools.ietf.org/html/rfc2822) standard. 3. The `Subject` headers must match. @@ -298,7 +298,7 @@

Method Details

# Object with schema name: MessagePart ], }, - "raw": "A String", # The entire email message in an RFC 2822 formatted and base64url encoded string. Returned in `messages.get` and `drafts.get` responses when the `format=RAW` parameter is supplied. + "raw": "A String", # The entire email message in an RFC 2822 formatted and base64url encoded string. Returned in `messages.get` and `drafts.get` responses when the `format=RAW` parameter is supplied. @required gmail.users.drafts.create gmail.users.drafts.update "sizeEstimate": 42, # Estimated size in bytes of the message. "snippet": "A String", # A short part of the message text. "threadId": "A String", # The ID of the thread the message belongs to. To add a message or draft to a thread, the following criteria must be met: 1. The requested `threadId` must be specified on the `Message` or `Draft.Message` you supply with your request. 2. The `References` and `In-Reply-To` headers must be set in compliance with the [RFC 2822](https://tools.ietf.org/html/rfc2822) standard. 3. The `Subject` headers must match. @@ -344,7 +344,7 @@

Method Details

# Object with schema name: MessagePart ], }, - "raw": "A String", # The entire email message in an RFC 2822 formatted and base64url encoded string. Returned in `messages.get` and `drafts.get` responses when the `format=RAW` parameter is supplied. + "raw": "A String", # The entire email message in an RFC 2822 formatted and base64url encoded string. Returned in `messages.get` and `drafts.get` responses when the `format=RAW` parameter is supplied. @required gmail.users.drafts.create gmail.users.drafts.update "sizeEstimate": 42, # Estimated size in bytes of the message. "snippet": "A String", # A short part of the message text. "threadId": "A String", # The ID of the thread the message belongs to. To add a message or draft to a thread, the following criteria must be met: 1. The requested `threadId` must be specified on the `Message` or `Draft.Message` you supply with your request. 2. The `References` and `In-Reply-To` headers must be set in compliance with the [RFC 2822](https://tools.ietf.org/html/rfc2822) standard. 3. The `Subject` headers must match. diff --git a/docs/dyn/gmail_v1.users.labels.html b/docs/dyn/gmail_v1.users.labels.html index 3630422502..31281f33c4 100644 --- a/docs/dyn/gmail_v1.users.labels.html +++ b/docs/dyn/gmail_v1.users.labels.html @@ -112,8 +112,8 @@

Method Details

{ # Labels are used to categorize messages and threads within the user's mailbox. The maximum number of labels supported for a user's mailbox is 10,000. "color": { # The color to assign to the label. Color is only available for labels that have their `type` set to `user`. - "backgroundColor": "A String", # The background color represented as hex string #RRGGBB (ex #000000). This field is required in order to set the color of a label. Only the following predefined set of color values are allowed: \#000000, #434343, #666666, #999999, #cccccc, #efefef, #f3f3f3, #ffffff, \#fb4c2f, #ffad47, #fad165, #16a766, #43d692, #4a86e8, #a479e2, #f691b3, \#f6c5be, #ffe6c7, #fef1d1, #b9e4d0, #c6f3de, #c9daf8, #e4d7f5, #fcdee8, \#efa093, #ffd6a2, #fce8b3, #89d3b2, #a0eac9, #a4c2f4, #d0bcf1, #fbc8d9, \#e66550, #ffbc6b, #fcda83, #44b984, #68dfa9, #6d9eeb, #b694e8, #f7a7c0, \#cc3a21, #eaa041, #f2c960, #149e60, #3dc789, #3c78d8, #8e63ce, #e07798, \#ac2b16, #cf8933, #d5ae49, #0b804b, #2a9c68, #285bac, #653e9b, #b65775, \#822111, #a46a21, #aa8831, #076239, #1a764d, #1c4587, #41236d, #83334c, \#464646, #e7e7e7, #0d3472, #b6cff5, #0d3b44, #98d7e4, #3d188e, #e3d7ff, \#711a36, #fbd3e0, #8a1c0a, #f2b2a8, #7a2e0b, #ffc8af, #7a4706, #ffdeb5, \#594c05, #fbe983, #684e07, #fdedc1, #0b4f30, #b3efd3, #04502e, #a2dcc1, \#c2c2c2, #4986e7, #2da2bb, #b99aff, #994a64, #f691b2, #ff7537, #ffad46, \#662e37, #ebdbde, #cca6ac, #094228, #42d692, #16a765 - "textColor": "A String", # The text color of the label, represented as hex string. This field is required in order to set the color of a label. Only the following predefined set of color values are allowed: \#000000, #434343, #666666, #999999, #cccccc, #efefef, #f3f3f3, #ffffff, \#fb4c2f, #ffad47, #fad165, #16a766, #43d692, #4a86e8, #a479e2, #f691b3, \#f6c5be, #ffe6c7, #fef1d1, #b9e4d0, #c6f3de, #c9daf8, #e4d7f5, #fcdee8, \#efa093, #ffd6a2, #fce8b3, #89d3b2, #a0eac9, #a4c2f4, #d0bcf1, #fbc8d9, \#e66550, #ffbc6b, #fcda83, #44b984, #68dfa9, #6d9eeb, #b694e8, #f7a7c0, \#cc3a21, #eaa041, #f2c960, #149e60, #3dc789, #3c78d8, #8e63ce, #e07798, \#ac2b16, #cf8933, #d5ae49, #0b804b, #2a9c68, #285bac, #653e9b, #b65775, \#822111, #a46a21, #aa8831, #076239, #1a764d, #1c4587, #41236d, #83334c, \#464646, #e7e7e7, #0d3472, #b6cff5, #0d3b44, #98d7e4, #3d188e, #e3d7ff, \#711a36, #fbd3e0, #8a1c0a, #f2b2a8, #7a2e0b, #ffc8af, #7a4706, #ffdeb5, \#594c05, #fbe983, #684e07, #fdedc1, #0b4f30, #b3efd3, #04502e, #a2dcc1, \#c2c2c2, #4986e7, #2da2bb, #b99aff, #994a64, #f691b2, #ff7537, #ffad46, \#662e37, #ebdbde, #cca6ac, #094228, #42d692, #16a765 + "backgroundColor": "A String", # The background color represented as hex string #RRGGBB (ex #000000). This field is required in order to set the color of a label. Only the following predefined set of color values are allowed: \#000000, #434343, #666666, #999999, #cccccc, #efefef, #f3f3f3, #ffffff, \#fb4c2f, #ffad47, #fad165, #16a766, #43d692, #4a86e8, #a479e2, #f691b3, \#f6c5be, #ffe6c7, #fef1d1, #b9e4d0, #c6f3de, #c9daf8, #e4d7f5, #fcdee8, \#efa093, #ffd6a2, #fce8b3, #89d3b2, #a0eac9, #a4c2f4, #d0bcf1, #fbc8d9, \#e66550, #ffbc6b, #fcda83, #44b984, #68dfa9, #6d9eeb, #b694e8, #f7a7c0, \#cc3a21, #eaa041, #f2c960, #149e60, #3dc789, #3c78d8, #8e63ce, #e07798, \#ac2b16, #cf8933, #d5ae49, #0b804b, #2a9c68, #285bac, #653e9b, #b65775, \#822111, #a46a21, #aa8831, #076239, #1a764d, #1c4587, #41236d, #83334c, \#464646, #e7e7e7, #0d3472, #b6cff5, #0d3b44, #98d7e4, #3d188e, #e3d7ff, \#711a36, #fbd3e0, #8a1c0a, #f2b2a8, #7a2e0b, #ffc8af, #7a4706, #ffdeb5, \#594c05, #fbe983, #684e07, #fdedc1, #0b4f30, #b3efd3, #04502e, #a2dcc1, \#c2c2c2, #4986e7, #2da2bb, #b99aff, #994a64, #f691b2, #ff7537, #ffad46, \#662e37, #ebdbde, #cca6ac, #094228, #42d692, #16a765, #757575, #1e53b8, \#007286, #7858c3, #c2185b, #d93025, #54240e, #633e04, #521d28, #202124, \#083018 + "textColor": "A String", # The text color of the label, represented as hex string. This field is required in order to set the color of a label. Only the following predefined set of color values are allowed: \#000000, #434343, #666666, #999999, #cccccc, #efefef, #f3f3f3, #ffffff, \#fb4c2f, #ffad47, #fad165, #16a766, #43d692, #4a86e8, #a479e2, #f691b3, \#f6c5be, #ffe6c7, #fef1d1, #b9e4d0, #c6f3de, #c9daf8, #e4d7f5, #fcdee8, \#efa093, #ffd6a2, #fce8b3, #89d3b2, #a0eac9, #a4c2f4, #d0bcf1, #fbc8d9, \#e66550, #ffbc6b, #fcda83, #44b984, #68dfa9, #6d9eeb, #b694e8, #f7a7c0, \#cc3a21, #eaa041, #f2c960, #149e60, #3dc789, #3c78d8, #8e63ce, #e07798, \#ac2b16, #cf8933, #d5ae49, #0b804b, #2a9c68, #285bac, #653e9b, #b65775, \#822111, #a46a21, #aa8831, #076239, #1a764d, #1c4587, #41236d, #83334c, \#464646, #e7e7e7, #0d3472, #b6cff5, #0d3b44, #98d7e4, #3d188e, #e3d7ff, \#711a36, #fbd3e0, #8a1c0a, #f2b2a8, #7a2e0b, #ffc8af, #7a4706, #ffdeb5, \#594c05, #fbe983, #684e07, #fdedc1, #0b4f30, #b3efd3, #04502e, #a2dcc1, \#c2c2c2, #4986e7, #2da2bb, #b99aff, #994a64, #f691b2, #ff7537, #ffad46, \#662e37, #ebdbde, #cca6ac, #094228, #42d692, #16a765, #757575, #1e53b8, \#007286, #7858c3, #c2185b, #d93025, #54240e, #633e04, #521d28, #202124, \#083018 }, "id": "A String", # The immutable ID of the label. "labelListVisibility": "A String", # The visibility of the label in the label list in the Gmail web interface. @@ -136,8 +136,8 @@

Method Details

{ # Labels are used to categorize messages and threads within the user's mailbox. The maximum number of labels supported for a user's mailbox is 10,000. "color": { # The color to assign to the label. Color is only available for labels that have their `type` set to `user`. - "backgroundColor": "A String", # The background color represented as hex string #RRGGBB (ex #000000). This field is required in order to set the color of a label. Only the following predefined set of color values are allowed: \#000000, #434343, #666666, #999999, #cccccc, #efefef, #f3f3f3, #ffffff, \#fb4c2f, #ffad47, #fad165, #16a766, #43d692, #4a86e8, #a479e2, #f691b3, \#f6c5be, #ffe6c7, #fef1d1, #b9e4d0, #c6f3de, #c9daf8, #e4d7f5, #fcdee8, \#efa093, #ffd6a2, #fce8b3, #89d3b2, #a0eac9, #a4c2f4, #d0bcf1, #fbc8d9, \#e66550, #ffbc6b, #fcda83, #44b984, #68dfa9, #6d9eeb, #b694e8, #f7a7c0, \#cc3a21, #eaa041, #f2c960, #149e60, #3dc789, #3c78d8, #8e63ce, #e07798, \#ac2b16, #cf8933, #d5ae49, #0b804b, #2a9c68, #285bac, #653e9b, #b65775, \#822111, #a46a21, #aa8831, #076239, #1a764d, #1c4587, #41236d, #83334c, \#464646, #e7e7e7, #0d3472, #b6cff5, #0d3b44, #98d7e4, #3d188e, #e3d7ff, \#711a36, #fbd3e0, #8a1c0a, #f2b2a8, #7a2e0b, #ffc8af, #7a4706, #ffdeb5, \#594c05, #fbe983, #684e07, #fdedc1, #0b4f30, #b3efd3, #04502e, #a2dcc1, \#c2c2c2, #4986e7, #2da2bb, #b99aff, #994a64, #f691b2, #ff7537, #ffad46, \#662e37, #ebdbde, #cca6ac, #094228, #42d692, #16a765 - "textColor": "A String", # The text color of the label, represented as hex string. This field is required in order to set the color of a label. Only the following predefined set of color values are allowed: \#000000, #434343, #666666, #999999, #cccccc, #efefef, #f3f3f3, #ffffff, \#fb4c2f, #ffad47, #fad165, #16a766, #43d692, #4a86e8, #a479e2, #f691b3, \#f6c5be, #ffe6c7, #fef1d1, #b9e4d0, #c6f3de, #c9daf8, #e4d7f5, #fcdee8, \#efa093, #ffd6a2, #fce8b3, #89d3b2, #a0eac9, #a4c2f4, #d0bcf1, #fbc8d9, \#e66550, #ffbc6b, #fcda83, #44b984, #68dfa9, #6d9eeb, #b694e8, #f7a7c0, \#cc3a21, #eaa041, #f2c960, #149e60, #3dc789, #3c78d8, #8e63ce, #e07798, \#ac2b16, #cf8933, #d5ae49, #0b804b, #2a9c68, #285bac, #653e9b, #b65775, \#822111, #a46a21, #aa8831, #076239, #1a764d, #1c4587, #41236d, #83334c, \#464646, #e7e7e7, #0d3472, #b6cff5, #0d3b44, #98d7e4, #3d188e, #e3d7ff, \#711a36, #fbd3e0, #8a1c0a, #f2b2a8, #7a2e0b, #ffc8af, #7a4706, #ffdeb5, \#594c05, #fbe983, #684e07, #fdedc1, #0b4f30, #b3efd3, #04502e, #a2dcc1, \#c2c2c2, #4986e7, #2da2bb, #b99aff, #994a64, #f691b2, #ff7537, #ffad46, \#662e37, #ebdbde, #cca6ac, #094228, #42d692, #16a765 + "backgroundColor": "A String", # The background color represented as hex string #RRGGBB (ex #000000). This field is required in order to set the color of a label. Only the following predefined set of color values are allowed: \#000000, #434343, #666666, #999999, #cccccc, #efefef, #f3f3f3, #ffffff, \#fb4c2f, #ffad47, #fad165, #16a766, #43d692, #4a86e8, #a479e2, #f691b3, \#f6c5be, #ffe6c7, #fef1d1, #b9e4d0, #c6f3de, #c9daf8, #e4d7f5, #fcdee8, \#efa093, #ffd6a2, #fce8b3, #89d3b2, #a0eac9, #a4c2f4, #d0bcf1, #fbc8d9, \#e66550, #ffbc6b, #fcda83, #44b984, #68dfa9, #6d9eeb, #b694e8, #f7a7c0, \#cc3a21, #eaa041, #f2c960, #149e60, #3dc789, #3c78d8, #8e63ce, #e07798, \#ac2b16, #cf8933, #d5ae49, #0b804b, #2a9c68, #285bac, #653e9b, #b65775, \#822111, #a46a21, #aa8831, #076239, #1a764d, #1c4587, #41236d, #83334c, \#464646, #e7e7e7, #0d3472, #b6cff5, #0d3b44, #98d7e4, #3d188e, #e3d7ff, \#711a36, #fbd3e0, #8a1c0a, #f2b2a8, #7a2e0b, #ffc8af, #7a4706, #ffdeb5, \#594c05, #fbe983, #684e07, #fdedc1, #0b4f30, #b3efd3, #04502e, #a2dcc1, \#c2c2c2, #4986e7, #2da2bb, #b99aff, #994a64, #f691b2, #ff7537, #ffad46, \#662e37, #ebdbde, #cca6ac, #094228, #42d692, #16a765, #757575, #1e53b8, \#007286, #7858c3, #c2185b, #d93025, #54240e, #633e04, #521d28, #202124, \#083018 + "textColor": "A String", # The text color of the label, represented as hex string. This field is required in order to set the color of a label. Only the following predefined set of color values are allowed: \#000000, #434343, #666666, #999999, #cccccc, #efefef, #f3f3f3, #ffffff, \#fb4c2f, #ffad47, #fad165, #16a766, #43d692, #4a86e8, #a479e2, #f691b3, \#f6c5be, #ffe6c7, #fef1d1, #b9e4d0, #c6f3de, #c9daf8, #e4d7f5, #fcdee8, \#efa093, #ffd6a2, #fce8b3, #89d3b2, #a0eac9, #a4c2f4, #d0bcf1, #fbc8d9, \#e66550, #ffbc6b, #fcda83, #44b984, #68dfa9, #6d9eeb, #b694e8, #f7a7c0, \#cc3a21, #eaa041, #f2c960, #149e60, #3dc789, #3c78d8, #8e63ce, #e07798, \#ac2b16, #cf8933, #d5ae49, #0b804b, #2a9c68, #285bac, #653e9b, #b65775, \#822111, #a46a21, #aa8831, #076239, #1a764d, #1c4587, #41236d, #83334c, \#464646, #e7e7e7, #0d3472, #b6cff5, #0d3b44, #98d7e4, #3d188e, #e3d7ff, \#711a36, #fbd3e0, #8a1c0a, #f2b2a8, #7a2e0b, #ffc8af, #7a4706, #ffdeb5, \#594c05, #fbe983, #684e07, #fdedc1, #0b4f30, #b3efd3, #04502e, #a2dcc1, \#c2c2c2, #4986e7, #2da2bb, #b99aff, #994a64, #f691b2, #ff7537, #ffad46, \#662e37, #ebdbde, #cca6ac, #094228, #42d692, #16a765, #757575, #1e53b8, \#007286, #7858c3, #c2185b, #d93025, #54240e, #633e04, #521d28, #202124, \#083018 }, "id": "A String", # The immutable ID of the label. "labelListVisibility": "A String", # The visibility of the label in the label list in the Gmail web interface. @@ -182,8 +182,8 @@

Method Details

{ # Labels are used to categorize messages and threads within the user's mailbox. The maximum number of labels supported for a user's mailbox is 10,000. "color": { # The color to assign to the label. Color is only available for labels that have their `type` set to `user`. - "backgroundColor": "A String", # The background color represented as hex string #RRGGBB (ex #000000). This field is required in order to set the color of a label. Only the following predefined set of color values are allowed: \#000000, #434343, #666666, #999999, #cccccc, #efefef, #f3f3f3, #ffffff, \#fb4c2f, #ffad47, #fad165, #16a766, #43d692, #4a86e8, #a479e2, #f691b3, \#f6c5be, #ffe6c7, #fef1d1, #b9e4d0, #c6f3de, #c9daf8, #e4d7f5, #fcdee8, \#efa093, #ffd6a2, #fce8b3, #89d3b2, #a0eac9, #a4c2f4, #d0bcf1, #fbc8d9, \#e66550, #ffbc6b, #fcda83, #44b984, #68dfa9, #6d9eeb, #b694e8, #f7a7c0, \#cc3a21, #eaa041, #f2c960, #149e60, #3dc789, #3c78d8, #8e63ce, #e07798, \#ac2b16, #cf8933, #d5ae49, #0b804b, #2a9c68, #285bac, #653e9b, #b65775, \#822111, #a46a21, #aa8831, #076239, #1a764d, #1c4587, #41236d, #83334c, \#464646, #e7e7e7, #0d3472, #b6cff5, #0d3b44, #98d7e4, #3d188e, #e3d7ff, \#711a36, #fbd3e0, #8a1c0a, #f2b2a8, #7a2e0b, #ffc8af, #7a4706, #ffdeb5, \#594c05, #fbe983, #684e07, #fdedc1, #0b4f30, #b3efd3, #04502e, #a2dcc1, \#c2c2c2, #4986e7, #2da2bb, #b99aff, #994a64, #f691b2, #ff7537, #ffad46, \#662e37, #ebdbde, #cca6ac, #094228, #42d692, #16a765 - "textColor": "A String", # The text color of the label, represented as hex string. This field is required in order to set the color of a label. Only the following predefined set of color values are allowed: \#000000, #434343, #666666, #999999, #cccccc, #efefef, #f3f3f3, #ffffff, \#fb4c2f, #ffad47, #fad165, #16a766, #43d692, #4a86e8, #a479e2, #f691b3, \#f6c5be, #ffe6c7, #fef1d1, #b9e4d0, #c6f3de, #c9daf8, #e4d7f5, #fcdee8, \#efa093, #ffd6a2, #fce8b3, #89d3b2, #a0eac9, #a4c2f4, #d0bcf1, #fbc8d9, \#e66550, #ffbc6b, #fcda83, #44b984, #68dfa9, #6d9eeb, #b694e8, #f7a7c0, \#cc3a21, #eaa041, #f2c960, #149e60, #3dc789, #3c78d8, #8e63ce, #e07798, \#ac2b16, #cf8933, #d5ae49, #0b804b, #2a9c68, #285bac, #653e9b, #b65775, \#822111, #a46a21, #aa8831, #076239, #1a764d, #1c4587, #41236d, #83334c, \#464646, #e7e7e7, #0d3472, #b6cff5, #0d3b44, #98d7e4, #3d188e, #e3d7ff, \#711a36, #fbd3e0, #8a1c0a, #f2b2a8, #7a2e0b, #ffc8af, #7a4706, #ffdeb5, \#594c05, #fbe983, #684e07, #fdedc1, #0b4f30, #b3efd3, #04502e, #a2dcc1, \#c2c2c2, #4986e7, #2da2bb, #b99aff, #994a64, #f691b2, #ff7537, #ffad46, \#662e37, #ebdbde, #cca6ac, #094228, #42d692, #16a765 + "backgroundColor": "A String", # The background color represented as hex string #RRGGBB (ex #000000). This field is required in order to set the color of a label. Only the following predefined set of color values are allowed: \#000000, #434343, #666666, #999999, #cccccc, #efefef, #f3f3f3, #ffffff, \#fb4c2f, #ffad47, #fad165, #16a766, #43d692, #4a86e8, #a479e2, #f691b3, \#f6c5be, #ffe6c7, #fef1d1, #b9e4d0, #c6f3de, #c9daf8, #e4d7f5, #fcdee8, \#efa093, #ffd6a2, #fce8b3, #89d3b2, #a0eac9, #a4c2f4, #d0bcf1, #fbc8d9, \#e66550, #ffbc6b, #fcda83, #44b984, #68dfa9, #6d9eeb, #b694e8, #f7a7c0, \#cc3a21, #eaa041, #f2c960, #149e60, #3dc789, #3c78d8, #8e63ce, #e07798, \#ac2b16, #cf8933, #d5ae49, #0b804b, #2a9c68, #285bac, #653e9b, #b65775, \#822111, #a46a21, #aa8831, #076239, #1a764d, #1c4587, #41236d, #83334c, \#464646, #e7e7e7, #0d3472, #b6cff5, #0d3b44, #98d7e4, #3d188e, #e3d7ff, \#711a36, #fbd3e0, #8a1c0a, #f2b2a8, #7a2e0b, #ffc8af, #7a4706, #ffdeb5, \#594c05, #fbe983, #684e07, #fdedc1, #0b4f30, #b3efd3, #04502e, #a2dcc1, \#c2c2c2, #4986e7, #2da2bb, #b99aff, #994a64, #f691b2, #ff7537, #ffad46, \#662e37, #ebdbde, #cca6ac, #094228, #42d692, #16a765, #757575, #1e53b8, \#007286, #7858c3, #c2185b, #d93025, #54240e, #633e04, #521d28, #202124, \#083018 + "textColor": "A String", # The text color of the label, represented as hex string. This field is required in order to set the color of a label. Only the following predefined set of color values are allowed: \#000000, #434343, #666666, #999999, #cccccc, #efefef, #f3f3f3, #ffffff, \#fb4c2f, #ffad47, #fad165, #16a766, #43d692, #4a86e8, #a479e2, #f691b3, \#f6c5be, #ffe6c7, #fef1d1, #b9e4d0, #c6f3de, #c9daf8, #e4d7f5, #fcdee8, \#efa093, #ffd6a2, #fce8b3, #89d3b2, #a0eac9, #a4c2f4, #d0bcf1, #fbc8d9, \#e66550, #ffbc6b, #fcda83, #44b984, #68dfa9, #6d9eeb, #b694e8, #f7a7c0, \#cc3a21, #eaa041, #f2c960, #149e60, #3dc789, #3c78d8, #8e63ce, #e07798, \#ac2b16, #cf8933, #d5ae49, #0b804b, #2a9c68, #285bac, #653e9b, #b65775, \#822111, #a46a21, #aa8831, #076239, #1a764d, #1c4587, #41236d, #83334c, \#464646, #e7e7e7, #0d3472, #b6cff5, #0d3b44, #98d7e4, #3d188e, #e3d7ff, \#711a36, #fbd3e0, #8a1c0a, #f2b2a8, #7a2e0b, #ffc8af, #7a4706, #ffdeb5, \#594c05, #fbe983, #684e07, #fdedc1, #0b4f30, #b3efd3, #04502e, #a2dcc1, \#c2c2c2, #4986e7, #2da2bb, #b99aff, #994a64, #f691b2, #ff7537, #ffad46, \#662e37, #ebdbde, #cca6ac, #094228, #42d692, #16a765, #757575, #1e53b8, \#007286, #7858c3, #c2185b, #d93025, #54240e, #633e04, #521d28, #202124, \#083018 }, "id": "A String", # The immutable ID of the label. "labelListVisibility": "A String", # The visibility of the label in the label list in the Gmail web interface. @@ -215,8 +215,8 @@

Method Details

"labels": [ # List of labels. Note that each label resource only contains an `id`, `name`, `messageListVisibility`, `labelListVisibility`, and `type`. The [`labels.get`](https://developers.google.com/workspace/gmail/api/v1/reference/users/labels/get) method can fetch additional label details. { # Labels are used to categorize messages and threads within the user's mailbox. The maximum number of labels supported for a user's mailbox is 10,000. "color": { # The color to assign to the label. Color is only available for labels that have their `type` set to `user`. - "backgroundColor": "A String", # The background color represented as hex string #RRGGBB (ex #000000). This field is required in order to set the color of a label. Only the following predefined set of color values are allowed: \#000000, #434343, #666666, #999999, #cccccc, #efefef, #f3f3f3, #ffffff, \#fb4c2f, #ffad47, #fad165, #16a766, #43d692, #4a86e8, #a479e2, #f691b3, \#f6c5be, #ffe6c7, #fef1d1, #b9e4d0, #c6f3de, #c9daf8, #e4d7f5, #fcdee8, \#efa093, #ffd6a2, #fce8b3, #89d3b2, #a0eac9, #a4c2f4, #d0bcf1, #fbc8d9, \#e66550, #ffbc6b, #fcda83, #44b984, #68dfa9, #6d9eeb, #b694e8, #f7a7c0, \#cc3a21, #eaa041, #f2c960, #149e60, #3dc789, #3c78d8, #8e63ce, #e07798, \#ac2b16, #cf8933, #d5ae49, #0b804b, #2a9c68, #285bac, #653e9b, #b65775, \#822111, #a46a21, #aa8831, #076239, #1a764d, #1c4587, #41236d, #83334c, \#464646, #e7e7e7, #0d3472, #b6cff5, #0d3b44, #98d7e4, #3d188e, #e3d7ff, \#711a36, #fbd3e0, #8a1c0a, #f2b2a8, #7a2e0b, #ffc8af, #7a4706, #ffdeb5, \#594c05, #fbe983, #684e07, #fdedc1, #0b4f30, #b3efd3, #04502e, #a2dcc1, \#c2c2c2, #4986e7, #2da2bb, #b99aff, #994a64, #f691b2, #ff7537, #ffad46, \#662e37, #ebdbde, #cca6ac, #094228, #42d692, #16a765 - "textColor": "A String", # The text color of the label, represented as hex string. This field is required in order to set the color of a label. Only the following predefined set of color values are allowed: \#000000, #434343, #666666, #999999, #cccccc, #efefef, #f3f3f3, #ffffff, \#fb4c2f, #ffad47, #fad165, #16a766, #43d692, #4a86e8, #a479e2, #f691b3, \#f6c5be, #ffe6c7, #fef1d1, #b9e4d0, #c6f3de, #c9daf8, #e4d7f5, #fcdee8, \#efa093, #ffd6a2, #fce8b3, #89d3b2, #a0eac9, #a4c2f4, #d0bcf1, #fbc8d9, \#e66550, #ffbc6b, #fcda83, #44b984, #68dfa9, #6d9eeb, #b694e8, #f7a7c0, \#cc3a21, #eaa041, #f2c960, #149e60, #3dc789, #3c78d8, #8e63ce, #e07798, \#ac2b16, #cf8933, #d5ae49, #0b804b, #2a9c68, #285bac, #653e9b, #b65775, \#822111, #a46a21, #aa8831, #076239, #1a764d, #1c4587, #41236d, #83334c, \#464646, #e7e7e7, #0d3472, #b6cff5, #0d3b44, #98d7e4, #3d188e, #e3d7ff, \#711a36, #fbd3e0, #8a1c0a, #f2b2a8, #7a2e0b, #ffc8af, #7a4706, #ffdeb5, \#594c05, #fbe983, #684e07, #fdedc1, #0b4f30, #b3efd3, #04502e, #a2dcc1, \#c2c2c2, #4986e7, #2da2bb, #b99aff, #994a64, #f691b2, #ff7537, #ffad46, \#662e37, #ebdbde, #cca6ac, #094228, #42d692, #16a765 + "backgroundColor": "A String", # The background color represented as hex string #RRGGBB (ex #000000). This field is required in order to set the color of a label. Only the following predefined set of color values are allowed: \#000000, #434343, #666666, #999999, #cccccc, #efefef, #f3f3f3, #ffffff, \#fb4c2f, #ffad47, #fad165, #16a766, #43d692, #4a86e8, #a479e2, #f691b3, \#f6c5be, #ffe6c7, #fef1d1, #b9e4d0, #c6f3de, #c9daf8, #e4d7f5, #fcdee8, \#efa093, #ffd6a2, #fce8b3, #89d3b2, #a0eac9, #a4c2f4, #d0bcf1, #fbc8d9, \#e66550, #ffbc6b, #fcda83, #44b984, #68dfa9, #6d9eeb, #b694e8, #f7a7c0, \#cc3a21, #eaa041, #f2c960, #149e60, #3dc789, #3c78d8, #8e63ce, #e07798, \#ac2b16, #cf8933, #d5ae49, #0b804b, #2a9c68, #285bac, #653e9b, #b65775, \#822111, #a46a21, #aa8831, #076239, #1a764d, #1c4587, #41236d, #83334c, \#464646, #e7e7e7, #0d3472, #b6cff5, #0d3b44, #98d7e4, #3d188e, #e3d7ff, \#711a36, #fbd3e0, #8a1c0a, #f2b2a8, #7a2e0b, #ffc8af, #7a4706, #ffdeb5, \#594c05, #fbe983, #684e07, #fdedc1, #0b4f30, #b3efd3, #04502e, #a2dcc1, \#c2c2c2, #4986e7, #2da2bb, #b99aff, #994a64, #f691b2, #ff7537, #ffad46, \#662e37, #ebdbde, #cca6ac, #094228, #42d692, #16a765, #757575, #1e53b8, \#007286, #7858c3, #c2185b, #d93025, #54240e, #633e04, #521d28, #202124, \#083018 + "textColor": "A String", # The text color of the label, represented as hex string. This field is required in order to set the color of a label. Only the following predefined set of color values are allowed: \#000000, #434343, #666666, #999999, #cccccc, #efefef, #f3f3f3, #ffffff, \#fb4c2f, #ffad47, #fad165, #16a766, #43d692, #4a86e8, #a479e2, #f691b3, \#f6c5be, #ffe6c7, #fef1d1, #b9e4d0, #c6f3de, #c9daf8, #e4d7f5, #fcdee8, \#efa093, #ffd6a2, #fce8b3, #89d3b2, #a0eac9, #a4c2f4, #d0bcf1, #fbc8d9, \#e66550, #ffbc6b, #fcda83, #44b984, #68dfa9, #6d9eeb, #b694e8, #f7a7c0, \#cc3a21, #eaa041, #f2c960, #149e60, #3dc789, #3c78d8, #8e63ce, #e07798, \#ac2b16, #cf8933, #d5ae49, #0b804b, #2a9c68, #285bac, #653e9b, #b65775, \#822111, #a46a21, #aa8831, #076239, #1a764d, #1c4587, #41236d, #83334c, \#464646, #e7e7e7, #0d3472, #b6cff5, #0d3b44, #98d7e4, #3d188e, #e3d7ff, \#711a36, #fbd3e0, #8a1c0a, #f2b2a8, #7a2e0b, #ffc8af, #7a4706, #ffdeb5, \#594c05, #fbe983, #684e07, #fdedc1, #0b4f30, #b3efd3, #04502e, #a2dcc1, \#c2c2c2, #4986e7, #2da2bb, #b99aff, #994a64, #f691b2, #ff7537, #ffad46, \#662e37, #ebdbde, #cca6ac, #094228, #42d692, #16a765, #757575, #1e53b8, \#007286, #7858c3, #c2185b, #d93025, #54240e, #633e04, #521d28, #202124, \#083018 }, "id": "A String", # The immutable ID of the label. "labelListVisibility": "A String", # The visibility of the label in the label list in the Gmail web interface. @@ -244,8 +244,8 @@

Method Details

{ # Labels are used to categorize messages and threads within the user's mailbox. The maximum number of labels supported for a user's mailbox is 10,000. "color": { # The color to assign to the label. Color is only available for labels that have their `type` set to `user`. - "backgroundColor": "A String", # The background color represented as hex string #RRGGBB (ex #000000). This field is required in order to set the color of a label. Only the following predefined set of color values are allowed: \#000000, #434343, #666666, #999999, #cccccc, #efefef, #f3f3f3, #ffffff, \#fb4c2f, #ffad47, #fad165, #16a766, #43d692, #4a86e8, #a479e2, #f691b3, \#f6c5be, #ffe6c7, #fef1d1, #b9e4d0, #c6f3de, #c9daf8, #e4d7f5, #fcdee8, \#efa093, #ffd6a2, #fce8b3, #89d3b2, #a0eac9, #a4c2f4, #d0bcf1, #fbc8d9, \#e66550, #ffbc6b, #fcda83, #44b984, #68dfa9, #6d9eeb, #b694e8, #f7a7c0, \#cc3a21, #eaa041, #f2c960, #149e60, #3dc789, #3c78d8, #8e63ce, #e07798, \#ac2b16, #cf8933, #d5ae49, #0b804b, #2a9c68, #285bac, #653e9b, #b65775, \#822111, #a46a21, #aa8831, #076239, #1a764d, #1c4587, #41236d, #83334c, \#464646, #e7e7e7, #0d3472, #b6cff5, #0d3b44, #98d7e4, #3d188e, #e3d7ff, \#711a36, #fbd3e0, #8a1c0a, #f2b2a8, #7a2e0b, #ffc8af, #7a4706, #ffdeb5, \#594c05, #fbe983, #684e07, #fdedc1, #0b4f30, #b3efd3, #04502e, #a2dcc1, \#c2c2c2, #4986e7, #2da2bb, #b99aff, #994a64, #f691b2, #ff7537, #ffad46, \#662e37, #ebdbde, #cca6ac, #094228, #42d692, #16a765 - "textColor": "A String", # The text color of the label, represented as hex string. This field is required in order to set the color of a label. Only the following predefined set of color values are allowed: \#000000, #434343, #666666, #999999, #cccccc, #efefef, #f3f3f3, #ffffff, \#fb4c2f, #ffad47, #fad165, #16a766, #43d692, #4a86e8, #a479e2, #f691b3, \#f6c5be, #ffe6c7, #fef1d1, #b9e4d0, #c6f3de, #c9daf8, #e4d7f5, #fcdee8, \#efa093, #ffd6a2, #fce8b3, #89d3b2, #a0eac9, #a4c2f4, #d0bcf1, #fbc8d9, \#e66550, #ffbc6b, #fcda83, #44b984, #68dfa9, #6d9eeb, #b694e8, #f7a7c0, \#cc3a21, #eaa041, #f2c960, #149e60, #3dc789, #3c78d8, #8e63ce, #e07798, \#ac2b16, #cf8933, #d5ae49, #0b804b, #2a9c68, #285bac, #653e9b, #b65775, \#822111, #a46a21, #aa8831, #076239, #1a764d, #1c4587, #41236d, #83334c, \#464646, #e7e7e7, #0d3472, #b6cff5, #0d3b44, #98d7e4, #3d188e, #e3d7ff, \#711a36, #fbd3e0, #8a1c0a, #f2b2a8, #7a2e0b, #ffc8af, #7a4706, #ffdeb5, \#594c05, #fbe983, #684e07, #fdedc1, #0b4f30, #b3efd3, #04502e, #a2dcc1, \#c2c2c2, #4986e7, #2da2bb, #b99aff, #994a64, #f691b2, #ff7537, #ffad46, \#662e37, #ebdbde, #cca6ac, #094228, #42d692, #16a765 + "backgroundColor": "A String", # The background color represented as hex string #RRGGBB (ex #000000). This field is required in order to set the color of a label. Only the following predefined set of color values are allowed: \#000000, #434343, #666666, #999999, #cccccc, #efefef, #f3f3f3, #ffffff, \#fb4c2f, #ffad47, #fad165, #16a766, #43d692, #4a86e8, #a479e2, #f691b3, \#f6c5be, #ffe6c7, #fef1d1, #b9e4d0, #c6f3de, #c9daf8, #e4d7f5, #fcdee8, \#efa093, #ffd6a2, #fce8b3, #89d3b2, #a0eac9, #a4c2f4, #d0bcf1, #fbc8d9, \#e66550, #ffbc6b, #fcda83, #44b984, #68dfa9, #6d9eeb, #b694e8, #f7a7c0, \#cc3a21, #eaa041, #f2c960, #149e60, #3dc789, #3c78d8, #8e63ce, #e07798, \#ac2b16, #cf8933, #d5ae49, #0b804b, #2a9c68, #285bac, #653e9b, #b65775, \#822111, #a46a21, #aa8831, #076239, #1a764d, #1c4587, #41236d, #83334c, \#464646, #e7e7e7, #0d3472, #b6cff5, #0d3b44, #98d7e4, #3d188e, #e3d7ff, \#711a36, #fbd3e0, #8a1c0a, #f2b2a8, #7a2e0b, #ffc8af, #7a4706, #ffdeb5, \#594c05, #fbe983, #684e07, #fdedc1, #0b4f30, #b3efd3, #04502e, #a2dcc1, \#c2c2c2, #4986e7, #2da2bb, #b99aff, #994a64, #f691b2, #ff7537, #ffad46, \#662e37, #ebdbde, #cca6ac, #094228, #42d692, #16a765, #757575, #1e53b8, \#007286, #7858c3, #c2185b, #d93025, #54240e, #633e04, #521d28, #202124, \#083018 + "textColor": "A String", # The text color of the label, represented as hex string. This field is required in order to set the color of a label. Only the following predefined set of color values are allowed: \#000000, #434343, #666666, #999999, #cccccc, #efefef, #f3f3f3, #ffffff, \#fb4c2f, #ffad47, #fad165, #16a766, #43d692, #4a86e8, #a479e2, #f691b3, \#f6c5be, #ffe6c7, #fef1d1, #b9e4d0, #c6f3de, #c9daf8, #e4d7f5, #fcdee8, \#efa093, #ffd6a2, #fce8b3, #89d3b2, #a0eac9, #a4c2f4, #d0bcf1, #fbc8d9, \#e66550, #ffbc6b, #fcda83, #44b984, #68dfa9, #6d9eeb, #b694e8, #f7a7c0, \#cc3a21, #eaa041, #f2c960, #149e60, #3dc789, #3c78d8, #8e63ce, #e07798, \#ac2b16, #cf8933, #d5ae49, #0b804b, #2a9c68, #285bac, #653e9b, #b65775, \#822111, #a46a21, #aa8831, #076239, #1a764d, #1c4587, #41236d, #83334c, \#464646, #e7e7e7, #0d3472, #b6cff5, #0d3b44, #98d7e4, #3d188e, #e3d7ff, \#711a36, #fbd3e0, #8a1c0a, #f2b2a8, #7a2e0b, #ffc8af, #7a4706, #ffdeb5, \#594c05, #fbe983, #684e07, #fdedc1, #0b4f30, #b3efd3, #04502e, #a2dcc1, \#c2c2c2, #4986e7, #2da2bb, #b99aff, #994a64, #f691b2, #ff7537, #ffad46, \#662e37, #ebdbde, #cca6ac, #094228, #42d692, #16a765, #757575, #1e53b8, \#007286, #7858c3, #c2185b, #d93025, #54240e, #633e04, #521d28, #202124, \#083018 }, "id": "A String", # The immutable ID of the label. "labelListVisibility": "A String", # The visibility of the label in the label list in the Gmail web interface. @@ -268,8 +268,8 @@

Method Details

{ # Labels are used to categorize messages and threads within the user's mailbox. The maximum number of labels supported for a user's mailbox is 10,000. "color": { # The color to assign to the label. Color is only available for labels that have their `type` set to `user`. - "backgroundColor": "A String", # The background color represented as hex string #RRGGBB (ex #000000). This field is required in order to set the color of a label. Only the following predefined set of color values are allowed: \#000000, #434343, #666666, #999999, #cccccc, #efefef, #f3f3f3, #ffffff, \#fb4c2f, #ffad47, #fad165, #16a766, #43d692, #4a86e8, #a479e2, #f691b3, \#f6c5be, #ffe6c7, #fef1d1, #b9e4d0, #c6f3de, #c9daf8, #e4d7f5, #fcdee8, \#efa093, #ffd6a2, #fce8b3, #89d3b2, #a0eac9, #a4c2f4, #d0bcf1, #fbc8d9, \#e66550, #ffbc6b, #fcda83, #44b984, #68dfa9, #6d9eeb, #b694e8, #f7a7c0, \#cc3a21, #eaa041, #f2c960, #149e60, #3dc789, #3c78d8, #8e63ce, #e07798, \#ac2b16, #cf8933, #d5ae49, #0b804b, #2a9c68, #285bac, #653e9b, #b65775, \#822111, #a46a21, #aa8831, #076239, #1a764d, #1c4587, #41236d, #83334c, \#464646, #e7e7e7, #0d3472, #b6cff5, #0d3b44, #98d7e4, #3d188e, #e3d7ff, \#711a36, #fbd3e0, #8a1c0a, #f2b2a8, #7a2e0b, #ffc8af, #7a4706, #ffdeb5, \#594c05, #fbe983, #684e07, #fdedc1, #0b4f30, #b3efd3, #04502e, #a2dcc1, \#c2c2c2, #4986e7, #2da2bb, #b99aff, #994a64, #f691b2, #ff7537, #ffad46, \#662e37, #ebdbde, #cca6ac, #094228, #42d692, #16a765 - "textColor": "A String", # The text color of the label, represented as hex string. This field is required in order to set the color of a label. Only the following predefined set of color values are allowed: \#000000, #434343, #666666, #999999, #cccccc, #efefef, #f3f3f3, #ffffff, \#fb4c2f, #ffad47, #fad165, #16a766, #43d692, #4a86e8, #a479e2, #f691b3, \#f6c5be, #ffe6c7, #fef1d1, #b9e4d0, #c6f3de, #c9daf8, #e4d7f5, #fcdee8, \#efa093, #ffd6a2, #fce8b3, #89d3b2, #a0eac9, #a4c2f4, #d0bcf1, #fbc8d9, \#e66550, #ffbc6b, #fcda83, #44b984, #68dfa9, #6d9eeb, #b694e8, #f7a7c0, \#cc3a21, #eaa041, #f2c960, #149e60, #3dc789, #3c78d8, #8e63ce, #e07798, \#ac2b16, #cf8933, #d5ae49, #0b804b, #2a9c68, #285bac, #653e9b, #b65775, \#822111, #a46a21, #aa8831, #076239, #1a764d, #1c4587, #41236d, #83334c, \#464646, #e7e7e7, #0d3472, #b6cff5, #0d3b44, #98d7e4, #3d188e, #e3d7ff, \#711a36, #fbd3e0, #8a1c0a, #f2b2a8, #7a2e0b, #ffc8af, #7a4706, #ffdeb5, \#594c05, #fbe983, #684e07, #fdedc1, #0b4f30, #b3efd3, #04502e, #a2dcc1, \#c2c2c2, #4986e7, #2da2bb, #b99aff, #994a64, #f691b2, #ff7537, #ffad46, \#662e37, #ebdbde, #cca6ac, #094228, #42d692, #16a765 + "backgroundColor": "A String", # The background color represented as hex string #RRGGBB (ex #000000). This field is required in order to set the color of a label. Only the following predefined set of color values are allowed: \#000000, #434343, #666666, #999999, #cccccc, #efefef, #f3f3f3, #ffffff, \#fb4c2f, #ffad47, #fad165, #16a766, #43d692, #4a86e8, #a479e2, #f691b3, \#f6c5be, #ffe6c7, #fef1d1, #b9e4d0, #c6f3de, #c9daf8, #e4d7f5, #fcdee8, \#efa093, #ffd6a2, #fce8b3, #89d3b2, #a0eac9, #a4c2f4, #d0bcf1, #fbc8d9, \#e66550, #ffbc6b, #fcda83, #44b984, #68dfa9, #6d9eeb, #b694e8, #f7a7c0, \#cc3a21, #eaa041, #f2c960, #149e60, #3dc789, #3c78d8, #8e63ce, #e07798, \#ac2b16, #cf8933, #d5ae49, #0b804b, #2a9c68, #285bac, #653e9b, #b65775, \#822111, #a46a21, #aa8831, #076239, #1a764d, #1c4587, #41236d, #83334c, \#464646, #e7e7e7, #0d3472, #b6cff5, #0d3b44, #98d7e4, #3d188e, #e3d7ff, \#711a36, #fbd3e0, #8a1c0a, #f2b2a8, #7a2e0b, #ffc8af, #7a4706, #ffdeb5, \#594c05, #fbe983, #684e07, #fdedc1, #0b4f30, #b3efd3, #04502e, #a2dcc1, \#c2c2c2, #4986e7, #2da2bb, #b99aff, #994a64, #f691b2, #ff7537, #ffad46, \#662e37, #ebdbde, #cca6ac, #094228, #42d692, #16a765, #757575, #1e53b8, \#007286, #7858c3, #c2185b, #d93025, #54240e, #633e04, #521d28, #202124, \#083018 + "textColor": "A String", # The text color of the label, represented as hex string. This field is required in order to set the color of a label. Only the following predefined set of color values are allowed: \#000000, #434343, #666666, #999999, #cccccc, #efefef, #f3f3f3, #ffffff, \#fb4c2f, #ffad47, #fad165, #16a766, #43d692, #4a86e8, #a479e2, #f691b3, \#f6c5be, #ffe6c7, #fef1d1, #b9e4d0, #c6f3de, #c9daf8, #e4d7f5, #fcdee8, \#efa093, #ffd6a2, #fce8b3, #89d3b2, #a0eac9, #a4c2f4, #d0bcf1, #fbc8d9, \#e66550, #ffbc6b, #fcda83, #44b984, #68dfa9, #6d9eeb, #b694e8, #f7a7c0, \#cc3a21, #eaa041, #f2c960, #149e60, #3dc789, #3c78d8, #8e63ce, #e07798, \#ac2b16, #cf8933, #d5ae49, #0b804b, #2a9c68, #285bac, #653e9b, #b65775, \#822111, #a46a21, #aa8831, #076239, #1a764d, #1c4587, #41236d, #83334c, \#464646, #e7e7e7, #0d3472, #b6cff5, #0d3b44, #98d7e4, #3d188e, #e3d7ff, \#711a36, #fbd3e0, #8a1c0a, #f2b2a8, #7a2e0b, #ffc8af, #7a4706, #ffdeb5, \#594c05, #fbe983, #684e07, #fdedc1, #0b4f30, #b3efd3, #04502e, #a2dcc1, \#c2c2c2, #4986e7, #2da2bb, #b99aff, #994a64, #f691b2, #ff7537, #ffad46, \#662e37, #ebdbde, #cca6ac, #094228, #42d692, #16a765, #757575, #1e53b8, \#007286, #7858c3, #c2185b, #d93025, #54240e, #633e04, #521d28, #202124, \#083018 }, "id": "A String", # The immutable ID of the label. "labelListVisibility": "A String", # The visibility of the label in the label list in the Gmail web interface. @@ -295,8 +295,8 @@

Method Details

{ # Labels are used to categorize messages and threads within the user's mailbox. The maximum number of labels supported for a user's mailbox is 10,000. "color": { # The color to assign to the label. Color is only available for labels that have their `type` set to `user`. - "backgroundColor": "A String", # The background color represented as hex string #RRGGBB (ex #000000). This field is required in order to set the color of a label. Only the following predefined set of color values are allowed: \#000000, #434343, #666666, #999999, #cccccc, #efefef, #f3f3f3, #ffffff, \#fb4c2f, #ffad47, #fad165, #16a766, #43d692, #4a86e8, #a479e2, #f691b3, \#f6c5be, #ffe6c7, #fef1d1, #b9e4d0, #c6f3de, #c9daf8, #e4d7f5, #fcdee8, \#efa093, #ffd6a2, #fce8b3, #89d3b2, #a0eac9, #a4c2f4, #d0bcf1, #fbc8d9, \#e66550, #ffbc6b, #fcda83, #44b984, #68dfa9, #6d9eeb, #b694e8, #f7a7c0, \#cc3a21, #eaa041, #f2c960, #149e60, #3dc789, #3c78d8, #8e63ce, #e07798, \#ac2b16, #cf8933, #d5ae49, #0b804b, #2a9c68, #285bac, #653e9b, #b65775, \#822111, #a46a21, #aa8831, #076239, #1a764d, #1c4587, #41236d, #83334c, \#464646, #e7e7e7, #0d3472, #b6cff5, #0d3b44, #98d7e4, #3d188e, #e3d7ff, \#711a36, #fbd3e0, #8a1c0a, #f2b2a8, #7a2e0b, #ffc8af, #7a4706, #ffdeb5, \#594c05, #fbe983, #684e07, #fdedc1, #0b4f30, #b3efd3, #04502e, #a2dcc1, \#c2c2c2, #4986e7, #2da2bb, #b99aff, #994a64, #f691b2, #ff7537, #ffad46, \#662e37, #ebdbde, #cca6ac, #094228, #42d692, #16a765 - "textColor": "A String", # The text color of the label, represented as hex string. This field is required in order to set the color of a label. Only the following predefined set of color values are allowed: \#000000, #434343, #666666, #999999, #cccccc, #efefef, #f3f3f3, #ffffff, \#fb4c2f, #ffad47, #fad165, #16a766, #43d692, #4a86e8, #a479e2, #f691b3, \#f6c5be, #ffe6c7, #fef1d1, #b9e4d0, #c6f3de, #c9daf8, #e4d7f5, #fcdee8, \#efa093, #ffd6a2, #fce8b3, #89d3b2, #a0eac9, #a4c2f4, #d0bcf1, #fbc8d9, \#e66550, #ffbc6b, #fcda83, #44b984, #68dfa9, #6d9eeb, #b694e8, #f7a7c0, \#cc3a21, #eaa041, #f2c960, #149e60, #3dc789, #3c78d8, #8e63ce, #e07798, \#ac2b16, #cf8933, #d5ae49, #0b804b, #2a9c68, #285bac, #653e9b, #b65775, \#822111, #a46a21, #aa8831, #076239, #1a764d, #1c4587, #41236d, #83334c, \#464646, #e7e7e7, #0d3472, #b6cff5, #0d3b44, #98d7e4, #3d188e, #e3d7ff, \#711a36, #fbd3e0, #8a1c0a, #f2b2a8, #7a2e0b, #ffc8af, #7a4706, #ffdeb5, \#594c05, #fbe983, #684e07, #fdedc1, #0b4f30, #b3efd3, #04502e, #a2dcc1, \#c2c2c2, #4986e7, #2da2bb, #b99aff, #994a64, #f691b2, #ff7537, #ffad46, \#662e37, #ebdbde, #cca6ac, #094228, #42d692, #16a765 + "backgroundColor": "A String", # The background color represented as hex string #RRGGBB (ex #000000). This field is required in order to set the color of a label. Only the following predefined set of color values are allowed: \#000000, #434343, #666666, #999999, #cccccc, #efefef, #f3f3f3, #ffffff, \#fb4c2f, #ffad47, #fad165, #16a766, #43d692, #4a86e8, #a479e2, #f691b3, \#f6c5be, #ffe6c7, #fef1d1, #b9e4d0, #c6f3de, #c9daf8, #e4d7f5, #fcdee8, \#efa093, #ffd6a2, #fce8b3, #89d3b2, #a0eac9, #a4c2f4, #d0bcf1, #fbc8d9, \#e66550, #ffbc6b, #fcda83, #44b984, #68dfa9, #6d9eeb, #b694e8, #f7a7c0, \#cc3a21, #eaa041, #f2c960, #149e60, #3dc789, #3c78d8, #8e63ce, #e07798, \#ac2b16, #cf8933, #d5ae49, #0b804b, #2a9c68, #285bac, #653e9b, #b65775, \#822111, #a46a21, #aa8831, #076239, #1a764d, #1c4587, #41236d, #83334c, \#464646, #e7e7e7, #0d3472, #b6cff5, #0d3b44, #98d7e4, #3d188e, #e3d7ff, \#711a36, #fbd3e0, #8a1c0a, #f2b2a8, #7a2e0b, #ffc8af, #7a4706, #ffdeb5, \#594c05, #fbe983, #684e07, #fdedc1, #0b4f30, #b3efd3, #04502e, #a2dcc1, \#c2c2c2, #4986e7, #2da2bb, #b99aff, #994a64, #f691b2, #ff7537, #ffad46, \#662e37, #ebdbde, #cca6ac, #094228, #42d692, #16a765, #757575, #1e53b8, \#007286, #7858c3, #c2185b, #d93025, #54240e, #633e04, #521d28, #202124, \#083018 + "textColor": "A String", # The text color of the label, represented as hex string. This field is required in order to set the color of a label. Only the following predefined set of color values are allowed: \#000000, #434343, #666666, #999999, #cccccc, #efefef, #f3f3f3, #ffffff, \#fb4c2f, #ffad47, #fad165, #16a766, #43d692, #4a86e8, #a479e2, #f691b3, \#f6c5be, #ffe6c7, #fef1d1, #b9e4d0, #c6f3de, #c9daf8, #e4d7f5, #fcdee8, \#efa093, #ffd6a2, #fce8b3, #89d3b2, #a0eac9, #a4c2f4, #d0bcf1, #fbc8d9, \#e66550, #ffbc6b, #fcda83, #44b984, #68dfa9, #6d9eeb, #b694e8, #f7a7c0, \#cc3a21, #eaa041, #f2c960, #149e60, #3dc789, #3c78d8, #8e63ce, #e07798, \#ac2b16, #cf8933, #d5ae49, #0b804b, #2a9c68, #285bac, #653e9b, #b65775, \#822111, #a46a21, #aa8831, #076239, #1a764d, #1c4587, #41236d, #83334c, \#464646, #e7e7e7, #0d3472, #b6cff5, #0d3b44, #98d7e4, #3d188e, #e3d7ff, \#711a36, #fbd3e0, #8a1c0a, #f2b2a8, #7a2e0b, #ffc8af, #7a4706, #ffdeb5, \#594c05, #fbe983, #684e07, #fdedc1, #0b4f30, #b3efd3, #04502e, #a2dcc1, \#c2c2c2, #4986e7, #2da2bb, #b99aff, #994a64, #f691b2, #ff7537, #ffad46, \#662e37, #ebdbde, #cca6ac, #094228, #42d692, #16a765, #757575, #1e53b8, \#007286, #7858c3, #c2185b, #d93025, #54240e, #633e04, #521d28, #202124, \#083018 }, "id": "A String", # The immutable ID of the label. "labelListVisibility": "A String", # The visibility of the label in the label list in the Gmail web interface. @@ -319,8 +319,8 @@

Method Details

{ # Labels are used to categorize messages and threads within the user's mailbox. The maximum number of labels supported for a user's mailbox is 10,000. "color": { # The color to assign to the label. Color is only available for labels that have their `type` set to `user`. - "backgroundColor": "A String", # The background color represented as hex string #RRGGBB (ex #000000). This field is required in order to set the color of a label. Only the following predefined set of color values are allowed: \#000000, #434343, #666666, #999999, #cccccc, #efefef, #f3f3f3, #ffffff, \#fb4c2f, #ffad47, #fad165, #16a766, #43d692, #4a86e8, #a479e2, #f691b3, \#f6c5be, #ffe6c7, #fef1d1, #b9e4d0, #c6f3de, #c9daf8, #e4d7f5, #fcdee8, \#efa093, #ffd6a2, #fce8b3, #89d3b2, #a0eac9, #a4c2f4, #d0bcf1, #fbc8d9, \#e66550, #ffbc6b, #fcda83, #44b984, #68dfa9, #6d9eeb, #b694e8, #f7a7c0, \#cc3a21, #eaa041, #f2c960, #149e60, #3dc789, #3c78d8, #8e63ce, #e07798, \#ac2b16, #cf8933, #d5ae49, #0b804b, #2a9c68, #285bac, #653e9b, #b65775, \#822111, #a46a21, #aa8831, #076239, #1a764d, #1c4587, #41236d, #83334c, \#464646, #e7e7e7, #0d3472, #b6cff5, #0d3b44, #98d7e4, #3d188e, #e3d7ff, \#711a36, #fbd3e0, #8a1c0a, #f2b2a8, #7a2e0b, #ffc8af, #7a4706, #ffdeb5, \#594c05, #fbe983, #684e07, #fdedc1, #0b4f30, #b3efd3, #04502e, #a2dcc1, \#c2c2c2, #4986e7, #2da2bb, #b99aff, #994a64, #f691b2, #ff7537, #ffad46, \#662e37, #ebdbde, #cca6ac, #094228, #42d692, #16a765 - "textColor": "A String", # The text color of the label, represented as hex string. This field is required in order to set the color of a label. Only the following predefined set of color values are allowed: \#000000, #434343, #666666, #999999, #cccccc, #efefef, #f3f3f3, #ffffff, \#fb4c2f, #ffad47, #fad165, #16a766, #43d692, #4a86e8, #a479e2, #f691b3, \#f6c5be, #ffe6c7, #fef1d1, #b9e4d0, #c6f3de, #c9daf8, #e4d7f5, #fcdee8, \#efa093, #ffd6a2, #fce8b3, #89d3b2, #a0eac9, #a4c2f4, #d0bcf1, #fbc8d9, \#e66550, #ffbc6b, #fcda83, #44b984, #68dfa9, #6d9eeb, #b694e8, #f7a7c0, \#cc3a21, #eaa041, #f2c960, #149e60, #3dc789, #3c78d8, #8e63ce, #e07798, \#ac2b16, #cf8933, #d5ae49, #0b804b, #2a9c68, #285bac, #653e9b, #b65775, \#822111, #a46a21, #aa8831, #076239, #1a764d, #1c4587, #41236d, #83334c, \#464646, #e7e7e7, #0d3472, #b6cff5, #0d3b44, #98d7e4, #3d188e, #e3d7ff, \#711a36, #fbd3e0, #8a1c0a, #f2b2a8, #7a2e0b, #ffc8af, #7a4706, #ffdeb5, \#594c05, #fbe983, #684e07, #fdedc1, #0b4f30, #b3efd3, #04502e, #a2dcc1, \#c2c2c2, #4986e7, #2da2bb, #b99aff, #994a64, #f691b2, #ff7537, #ffad46, \#662e37, #ebdbde, #cca6ac, #094228, #42d692, #16a765 + "backgroundColor": "A String", # The background color represented as hex string #RRGGBB (ex #000000). This field is required in order to set the color of a label. Only the following predefined set of color values are allowed: \#000000, #434343, #666666, #999999, #cccccc, #efefef, #f3f3f3, #ffffff, \#fb4c2f, #ffad47, #fad165, #16a766, #43d692, #4a86e8, #a479e2, #f691b3, \#f6c5be, #ffe6c7, #fef1d1, #b9e4d0, #c6f3de, #c9daf8, #e4d7f5, #fcdee8, \#efa093, #ffd6a2, #fce8b3, #89d3b2, #a0eac9, #a4c2f4, #d0bcf1, #fbc8d9, \#e66550, #ffbc6b, #fcda83, #44b984, #68dfa9, #6d9eeb, #b694e8, #f7a7c0, \#cc3a21, #eaa041, #f2c960, #149e60, #3dc789, #3c78d8, #8e63ce, #e07798, \#ac2b16, #cf8933, #d5ae49, #0b804b, #2a9c68, #285bac, #653e9b, #b65775, \#822111, #a46a21, #aa8831, #076239, #1a764d, #1c4587, #41236d, #83334c, \#464646, #e7e7e7, #0d3472, #b6cff5, #0d3b44, #98d7e4, #3d188e, #e3d7ff, \#711a36, #fbd3e0, #8a1c0a, #f2b2a8, #7a2e0b, #ffc8af, #7a4706, #ffdeb5, \#594c05, #fbe983, #684e07, #fdedc1, #0b4f30, #b3efd3, #04502e, #a2dcc1, \#c2c2c2, #4986e7, #2da2bb, #b99aff, #994a64, #f691b2, #ff7537, #ffad46, \#662e37, #ebdbde, #cca6ac, #094228, #42d692, #16a765, #757575, #1e53b8, \#007286, #7858c3, #c2185b, #d93025, #54240e, #633e04, #521d28, #202124, \#083018 + "textColor": "A String", # The text color of the label, represented as hex string. This field is required in order to set the color of a label. Only the following predefined set of color values are allowed: \#000000, #434343, #666666, #999999, #cccccc, #efefef, #f3f3f3, #ffffff, \#fb4c2f, #ffad47, #fad165, #16a766, #43d692, #4a86e8, #a479e2, #f691b3, \#f6c5be, #ffe6c7, #fef1d1, #b9e4d0, #c6f3de, #c9daf8, #e4d7f5, #fcdee8, \#efa093, #ffd6a2, #fce8b3, #89d3b2, #a0eac9, #a4c2f4, #d0bcf1, #fbc8d9, \#e66550, #ffbc6b, #fcda83, #44b984, #68dfa9, #6d9eeb, #b694e8, #f7a7c0, \#cc3a21, #eaa041, #f2c960, #149e60, #3dc789, #3c78d8, #8e63ce, #e07798, \#ac2b16, #cf8933, #d5ae49, #0b804b, #2a9c68, #285bac, #653e9b, #b65775, \#822111, #a46a21, #aa8831, #076239, #1a764d, #1c4587, #41236d, #83334c, \#464646, #e7e7e7, #0d3472, #b6cff5, #0d3b44, #98d7e4, #3d188e, #e3d7ff, \#711a36, #fbd3e0, #8a1c0a, #f2b2a8, #7a2e0b, #ffc8af, #7a4706, #ffdeb5, \#594c05, #fbe983, #684e07, #fdedc1, #0b4f30, #b3efd3, #04502e, #a2dcc1, \#c2c2c2, #4986e7, #2da2bb, #b99aff, #994a64, #f691b2, #ff7537, #ffad46, \#662e37, #ebdbde, #cca6ac, #094228, #42d692, #16a765, #757575, #1e53b8, \#007286, #7858c3, #c2185b, #d93025, #54240e, #633e04, #521d28, #202124, \#083018 }, "id": "A String", # The immutable ID of the label. "labelListVisibility": "A String", # The visibility of the label in the label list in the Gmail web interface. diff --git a/docs/dyn/gmail_v1.users.messages.html b/docs/dyn/gmail_v1.users.messages.html index 964658154c..cc885653d8 100644 --- a/docs/dyn/gmail_v1.users.messages.html +++ b/docs/dyn/gmail_v1.users.messages.html @@ -261,7 +261,7 @@

Method Details

# Object with schema name: MessagePart ], }, - "raw": "A String", # The entire email message in an RFC 2822 formatted and base64url encoded string. Returned in `messages.get` and `drafts.get` responses when the `format=RAW` parameter is supplied. + "raw": "A String", # The entire email message in an RFC 2822 formatted and base64url encoded string. Returned in `messages.get` and `drafts.get` responses when the `format=RAW` parameter is supplied. @required gmail.users.drafts.create gmail.users.drafts.update "sizeEstimate": 42, # Estimated size in bytes of the message. "snippet": "A String", # A short part of the message text. "threadId": "A String", # The ID of the thread the message belongs to. To add a message or draft to a thread, the following criteria must be met: 1. The requested `threadId` must be specified on the `Message` or `Draft.Message` you supply with your request. 2. The `References` and `In-Reply-To` headers must be set in compliance with the [RFC 2822](https://tools.ietf.org/html/rfc2822) standard. 3. The `Subject` headers must match. @@ -314,7 +314,7 @@

Method Details

# Object with schema name: MessagePart ], }, - "raw": "A String", # The entire email message in an RFC 2822 formatted and base64url encoded string. Returned in `messages.get` and `drafts.get` responses when the `format=RAW` parameter is supplied. + "raw": "A String", # The entire email message in an RFC 2822 formatted and base64url encoded string. Returned in `messages.get` and `drafts.get` responses when the `format=RAW` parameter is supplied. @required gmail.users.drafts.create gmail.users.drafts.update "sizeEstimate": 42, # Estimated size in bytes of the message. "snippet": "A String", # A short part of the message text. "threadId": "A String", # The ID of the thread the message belongs to. To add a message or draft to a thread, the following criteria must be met: 1. The requested `threadId` must be specified on the `Message` or `Draft.Message` you supply with your request. 2. The `References` and `In-Reply-To` headers must be set in compliance with the [RFC 2822](https://tools.ietf.org/html/rfc2822) standard. 3. The `Subject` headers must match. @@ -374,7 +374,7 @@

Method Details

# Object with schema name: MessagePart ], }, - "raw": "A String", # The entire email message in an RFC 2822 formatted and base64url encoded string. Returned in `messages.get` and `drafts.get` responses when the `format=RAW` parameter is supplied. + "raw": "A String", # The entire email message in an RFC 2822 formatted and base64url encoded string. Returned in `messages.get` and `drafts.get` responses when the `format=RAW` parameter is supplied. @required gmail.users.drafts.create gmail.users.drafts.update "sizeEstimate": 42, # Estimated size in bytes of the message. "snippet": "A String", # A short part of the message text. "threadId": "A String", # The ID of the thread the message belongs to. To add a message or draft to a thread, the following criteria must be met: 1. The requested `threadId` must be specified on the `Message` or `Draft.Message` you supply with your request. 2. The `References` and `In-Reply-To` headers must be set in compliance with the [RFC 2822](https://tools.ietf.org/html/rfc2822) standard. 3. The `Subject` headers must match. @@ -427,7 +427,7 @@

Method Details

# Object with schema name: MessagePart ], }, - "raw": "A String", # The entire email message in an RFC 2822 formatted and base64url encoded string. Returned in `messages.get` and `drafts.get` responses when the `format=RAW` parameter is supplied. + "raw": "A String", # The entire email message in an RFC 2822 formatted and base64url encoded string. Returned in `messages.get` and `drafts.get` responses when the `format=RAW` parameter is supplied. @required gmail.users.drafts.create gmail.users.drafts.update "sizeEstimate": 42, # Estimated size in bytes of the message. "snippet": "A String", # A short part of the message text. "threadId": "A String", # The ID of the thread the message belongs to. To add a message or draft to a thread, the following criteria must be met: 1. The requested `threadId` must be specified on the `Message` or `Draft.Message` you supply with your request. 2. The `References` and `In-Reply-To` headers must be set in compliance with the [RFC 2822](https://tools.ietf.org/html/rfc2822) standard. 3. The `Subject` headers must match. @@ -485,7 +485,7 @@

Method Details

# Object with schema name: MessagePart ], }, - "raw": "A String", # The entire email message in an RFC 2822 formatted and base64url encoded string. Returned in `messages.get` and `drafts.get` responses when the `format=RAW` parameter is supplied. + "raw": "A String", # The entire email message in an RFC 2822 formatted and base64url encoded string. Returned in `messages.get` and `drafts.get` responses when the `format=RAW` parameter is supplied. @required gmail.users.drafts.create gmail.users.drafts.update "sizeEstimate": 42, # Estimated size in bytes of the message. "snippet": "A String", # A short part of the message text. "threadId": "A String", # The ID of the thread the message belongs to. To add a message or draft to a thread, the following criteria must be met: 1. The requested `threadId` must be specified on the `Message` or `Draft.Message` you supply with your request. 2. The `References` and `In-Reply-To` headers must be set in compliance with the [RFC 2822](https://tools.ietf.org/html/rfc2822) standard. 3. The `Subject` headers must match. @@ -550,7 +550,7 @@

Method Details

# Object with schema name: MessagePart ], }, - "raw": "A String", # The entire email message in an RFC 2822 formatted and base64url encoded string. Returned in `messages.get` and `drafts.get` responses when the `format=RAW` parameter is supplied. + "raw": "A String", # The entire email message in an RFC 2822 formatted and base64url encoded string. Returned in `messages.get` and `drafts.get` responses when the `format=RAW` parameter is supplied. @required gmail.users.drafts.create gmail.users.drafts.update "sizeEstimate": 42, # Estimated size in bytes of the message. "snippet": "A String", # A short part of the message text. "threadId": "A String", # The ID of the thread the message belongs to. To add a message or draft to a thread, the following criteria must be met: 1. The requested `threadId` must be specified on the `Message` or `Draft.Message` you supply with your request. 2. The `References` and `In-Reply-To` headers must be set in compliance with the [RFC 2822](https://tools.ietf.org/html/rfc2822) standard. 3. The `Subject` headers must match. @@ -653,7 +653,7 @@

Method Details

# Object with schema name: MessagePart ], }, - "raw": "A String", # The entire email message in an RFC 2822 formatted and base64url encoded string. Returned in `messages.get` and `drafts.get` responses when the `format=RAW` parameter is supplied. + "raw": "A String", # The entire email message in an RFC 2822 formatted and base64url encoded string. Returned in `messages.get` and `drafts.get` responses when the `format=RAW` parameter is supplied. @required gmail.users.drafts.create gmail.users.drafts.update "sizeEstimate": 42, # Estimated size in bytes of the message. "snippet": "A String", # A short part of the message text. "threadId": "A String", # The ID of the thread the message belongs to. To add a message or draft to a thread, the following criteria must be met: 1. The requested `threadId` must be specified on the `Message` or `Draft.Message` you supply with your request. 2. The `References` and `In-Reply-To` headers must be set in compliance with the [RFC 2822](https://tools.ietf.org/html/rfc2822) standard. 3. The `Subject` headers must match. @@ -706,7 +706,7 @@

Method Details

# Object with schema name: MessagePart ], }, - "raw": "A String", # The entire email message in an RFC 2822 formatted and base64url encoded string. Returned in `messages.get` and `drafts.get` responses when the `format=RAW` parameter is supplied. + "raw": "A String", # The entire email message in an RFC 2822 formatted and base64url encoded string. Returned in `messages.get` and `drafts.get` responses when the `format=RAW` parameter is supplied. @required gmail.users.drafts.create gmail.users.drafts.update "sizeEstimate": 42, # Estimated size in bytes of the message. "snippet": "A String", # A short part of the message text. "threadId": "A String", # The ID of the thread the message belongs to. To add a message or draft to a thread, the following criteria must be met: 1. The requested `threadId` must be specified on the `Message` or `Draft.Message` you supply with your request. 2. The `References` and `In-Reply-To` headers must be set in compliance with the [RFC 2822](https://tools.ietf.org/html/rfc2822) standard. 3. The `Subject` headers must match. @@ -759,7 +759,7 @@

Method Details

# Object with schema name: MessagePart ], }, - "raw": "A String", # The entire email message in an RFC 2822 formatted and base64url encoded string. Returned in `messages.get` and `drafts.get` responses when the `format=RAW` parameter is supplied. + "raw": "A String", # The entire email message in an RFC 2822 formatted and base64url encoded string. Returned in `messages.get` and `drafts.get` responses when the `format=RAW` parameter is supplied. @required gmail.users.drafts.create gmail.users.drafts.update "sizeEstimate": 42, # Estimated size in bytes of the message. "snippet": "A String", # A short part of the message text. "threadId": "A String", # The ID of the thread the message belongs to. To add a message or draft to a thread, the following criteria must be met: 1. The requested `threadId` must be specified on the `Message` or `Draft.Message` you supply with your request. 2. The `References` and `In-Reply-To` headers must be set in compliance with the [RFC 2822](https://tools.ietf.org/html/rfc2822) standard. 3. The `Subject` headers must match. @@ -818,7 +818,7 @@

Method Details

# Object with schema name: MessagePart ], }, - "raw": "A String", # The entire email message in an RFC 2822 formatted and base64url encoded string. Returned in `messages.get` and `drafts.get` responses when the `format=RAW` parameter is supplied. + "raw": "A String", # The entire email message in an RFC 2822 formatted and base64url encoded string. Returned in `messages.get` and `drafts.get` responses when the `format=RAW` parameter is supplied. @required gmail.users.drafts.create gmail.users.drafts.update "sizeEstimate": 42, # Estimated size in bytes of the message. "snippet": "A String", # A short part of the message text. "threadId": "A String", # The ID of the thread the message belongs to. To add a message or draft to a thread, the following criteria must be met: 1. The requested `threadId` must be specified on the `Message` or `Draft.Message` you supply with your request. 2. The `References` and `In-Reply-To` headers must be set in compliance with the [RFC 2822](https://tools.ietf.org/html/rfc2822) standard. 3. The `Subject` headers must match. @@ -877,7 +877,7 @@

Method Details

# Object with schema name: MessagePart ], }, - "raw": "A String", # The entire email message in an RFC 2822 formatted and base64url encoded string. Returned in `messages.get` and `drafts.get` responses when the `format=RAW` parameter is supplied. + "raw": "A String", # The entire email message in an RFC 2822 formatted and base64url encoded string. Returned in `messages.get` and `drafts.get` responses when the `format=RAW` parameter is supplied. @required gmail.users.drafts.create gmail.users.drafts.update "sizeEstimate": 42, # Estimated size in bytes of the message. "snippet": "A String", # A short part of the message text. "threadId": "A String", # The ID of the thread the message belongs to. To add a message or draft to a thread, the following criteria must be met: 1. The requested `threadId` must be specified on the `Message` or `Draft.Message` you supply with your request. 2. The `References` and `In-Reply-To` headers must be set in compliance with the [RFC 2822](https://tools.ietf.org/html/rfc2822) standard. 3. The `Subject` headers must match. diff --git a/docs/dyn/gmail_v1.users.threads.html b/docs/dyn/gmail_v1.users.threads.html index 9fcf4ef62e..34ba87017c 100644 --- a/docs/dyn/gmail_v1.users.threads.html +++ b/docs/dyn/gmail_v1.users.threads.html @@ -180,7 +180,7 @@

Method Details

# Object with schema name: MessagePart ], }, - "raw": "A String", # The entire email message in an RFC 2822 formatted and base64url encoded string. Returned in `messages.get` and `drafts.get` responses when the `format=RAW` parameter is supplied. + "raw": "A String", # The entire email message in an RFC 2822 formatted and base64url encoded string. Returned in `messages.get` and `drafts.get` responses when the `format=RAW` parameter is supplied. @required gmail.users.drafts.create gmail.users.drafts.update "sizeEstimate": 42, # Estimated size in bytes of the message. "snippet": "A String", # A short part of the message text. "threadId": "A String", # The ID of the thread the message belongs to. To add a message or draft to a thread, the following criteria must be met: 1. The requested `threadId` must be specified on the `Message` or `Draft.Message` you supply with your request. 2. The `References` and `In-Reply-To` headers must be set in compliance with the [RFC 2822](https://tools.ietf.org/html/rfc2822) standard. 3. The `Subject` headers must match. @@ -254,7 +254,7 @@

Method Details

# Object with schema name: MessagePart ], }, - "raw": "A String", # The entire email message in an RFC 2822 formatted and base64url encoded string. Returned in `messages.get` and `drafts.get` responses when the `format=RAW` parameter is supplied. + "raw": "A String", # The entire email message in an RFC 2822 formatted and base64url encoded string. Returned in `messages.get` and `drafts.get` responses when the `format=RAW` parameter is supplied. @required gmail.users.drafts.create gmail.users.drafts.update "sizeEstimate": 42, # Estimated size in bytes of the message. "snippet": "A String", # A short part of the message text. "threadId": "A String", # The ID of the thread the message belongs to. To add a message or draft to a thread, the following criteria must be met: 1. The requested `threadId` must be specified on the `Message` or `Draft.Message` you supply with your request. 2. The `References` and `In-Reply-To` headers must be set in compliance with the [RFC 2822](https://tools.ietf.org/html/rfc2822) standard. 3. The `Subject` headers must match. @@ -348,7 +348,7 @@

Method Details

# Object with schema name: MessagePart ], }, - "raw": "A String", # The entire email message in an RFC 2822 formatted and base64url encoded string. Returned in `messages.get` and `drafts.get` responses when the `format=RAW` parameter is supplied. + "raw": "A String", # The entire email message in an RFC 2822 formatted and base64url encoded string. Returned in `messages.get` and `drafts.get` responses when the `format=RAW` parameter is supplied. @required gmail.users.drafts.create gmail.users.drafts.update "sizeEstimate": 42, # Estimated size in bytes of the message. "snippet": "A String", # A short part of the message text. "threadId": "A String", # The ID of the thread the message belongs to. To add a message or draft to a thread, the following criteria must be met: 1. The requested `threadId` must be specified on the `Message` or `Draft.Message` you supply with your request. 2. The `References` and `In-Reply-To` headers must be set in compliance with the [RFC 2822](https://tools.ietf.org/html/rfc2822) standard. 3. The `Subject` headers must match. @@ -414,7 +414,7 @@

Method Details

# Object with schema name: MessagePart ], }, - "raw": "A String", # The entire email message in an RFC 2822 formatted and base64url encoded string. Returned in `messages.get` and `drafts.get` responses when the `format=RAW` parameter is supplied. + "raw": "A String", # The entire email message in an RFC 2822 formatted and base64url encoded string. Returned in `messages.get` and `drafts.get` responses when the `format=RAW` parameter is supplied. @required gmail.users.drafts.create gmail.users.drafts.update "sizeEstimate": 42, # Estimated size in bytes of the message. "snippet": "A String", # A short part of the message text. "threadId": "A String", # The ID of the thread the message belongs to. To add a message or draft to a thread, the following criteria must be met: 1. The requested `threadId` must be specified on the `Message` or `Draft.Message` you supply with your request. 2. The `References` and `In-Reply-To` headers must be set in compliance with the [RFC 2822](https://tools.ietf.org/html/rfc2822) standard. 3. The `Subject` headers must match. @@ -480,7 +480,7 @@

Method Details

# Object with schema name: MessagePart ], }, - "raw": "A String", # The entire email message in an RFC 2822 formatted and base64url encoded string. Returned in `messages.get` and `drafts.get` responses when the `format=RAW` parameter is supplied. + "raw": "A String", # The entire email message in an RFC 2822 formatted and base64url encoded string. Returned in `messages.get` and `drafts.get` responses when the `format=RAW` parameter is supplied. @required gmail.users.drafts.create gmail.users.drafts.update "sizeEstimate": 42, # Estimated size in bytes of the message. "snippet": "A String", # A short part of the message text. "threadId": "A String", # The ID of the thread the message belongs to. To add a message or draft to a thread, the following criteria must be met: 1. The requested `threadId` must be specified on the `Message` or `Draft.Message` you supply with your request. 2. The `References` and `In-Reply-To` headers must be set in compliance with the [RFC 2822](https://tools.ietf.org/html/rfc2822) standard. 3. The `Subject` headers must match. diff --git a/docs/dyn/health_v4.projects.subscribers.html b/docs/dyn/health_v4.projects.subscribers.html index 888e665dc0..b759ef5c42 100644 --- a/docs/dyn/health_v4.projects.subscribers.html +++ b/docs/dyn/health_v4.projects.subscribers.html @@ -74,6 +74,11 @@

Google Health API . projects . subscribers

Instance Methods

+

+ subscriptions() +

+

Returns the subscriptions Resource.

+

close()

Close httplib2 connections.

diff --git a/docs/dyn/health_v4.projects.subscribers.subscriptions.html b/docs/dyn/health_v4.projects.subscribers.subscriptions.html new file mode 100644 index 0000000000..c70b91cd2d --- /dev/null +++ b/docs/dyn/health_v4.projects.subscribers.subscriptions.html @@ -0,0 +1,233 @@ + + + +

Google Health API . projects . subscribers . subscriptions

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

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

+

Creates a subscription for a specific user to a specific subscriber. This method requires the subscriber to have a `SubscriptionCreatePolicy` set to `MANUAL` for the given data types.

+

+ delete(name, x__xgafv=None)

+

Deletes a specific user subscription, stopping notifications for this user to this subscriber.

+

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

+

Lists all active subscriptions for a given subscriber. This can be filtered, for example, by user or data type.

+

+ list_next()

+

Retrieves the next page of results.

+

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

+

Updates the data types for an existing user subscription.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ create(parent, body=None, subscriptionId=None, x__xgafv=None) +
Creates a subscription for a specific user to a specific subscriber. This method requires the subscriber to have a `SubscriptionCreatePolicy` set to `MANUAL` for the given data types.
+
+Args:
+  parent: string, Required. The parent subscriber. Format: projects/{project}/subscribers/{subscriber} The {subscriber} ID is user-settable (4-36 characters, matching /[a-z]([a-z0-9-]{2,34}[a-z0-9])/) if provided during creation, or system-generated otherwise. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Payload for creating a subscription.
+  "dataTypes": [ # Optional. Data types subscribed to.
+    "A String",
+  ],
+  "user": "A String", # Required. Immutable. The resource name of the user for whom this subscription is active. Format: `users/{user}` where `{user}` is the public `healthUserId` as returned by the `GetIdentity` action in the profile PAPI (see `google.devicesandservices.health.v4main.HealthProfileService.GetIdentity`).
+}
+
+  subscriptionId: string, Optional. The {subscription_id} is user-settable (4-36 chars, matching /[a-z]([a-z0-9-]{2,34}[a-z0-9])/) or system-generated otherwise. If provided, the ID must be unique within the parent subscriber.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A subscription to a data collection for a specific user, to be delivered to a subscriber.
+  "dataTypes": [ # Optional. Data types subscribed to. A subscriber will only receive notifications for data types that are declared here. A subscription can only subscribe to the data types of the subscriber. The values should be in the format "users/{health_user_id}/dataTypes/{data_type}" where `{data_type}` is one of "altitude", "distance", "floors", "sleep", "steps", "weight".
+    "A String",
+  ],
+  "name": "A String", # Identifier. The resource name of the Subscription. Format: `projects/{project}/subscribers/{subscriber}/subscriptions/{subscription}` Example: `projects/my-project/subscribers/my-subscriber-123/subscriptions/my-subscription-456` The {project} ID is mandatory (6-30 characters, matching /a-z{6,30}/) The {subscriber} ID is user-settable (4-36 characters, matching /[a-z]([a-z0-9-]{2,34}[a-z0-9])/) if provided during creation, or system-generated otherwise. The {subscription} ID is user-settable (4-36 chars, matching /[a-z]([a-z0-9-]{2,34}[a-z0-9])/) or system-generated otherwise.
+  "user": "A String", # Immutable. The resource name of the user for whom this subscription is active. Format: `users/{user}` where `{user}` is the public `healthUserId` as returned by the `GetIdentity` action in the profile PAPI (see `google.devicesandservices.health.v4main.HealthProfileService.GetIdentity`).
+}
+
+ +
+ delete(name, x__xgafv=None) +
Deletes a specific user subscription, stopping notifications for this user to this subscriber.
+
+Args:
+  name: string, Required. The resource name of the subscription to delete. Format: `projects/{project}/subscribers/{subscriber}/subscriptions/{subscription}` Example: `projects/my-project/subscribers/my-subscriber-123/subscriptions/my-subscription-456` The {subscriber} ID is user-settable (4-36 characters, matching /[a-z]([a-z0-9-]{2,34}[a-z0-9])/) if provided during creation, or system-generated otherwise. The {subscription} ID is user-settable (4-36 characters, matching /[a-z]([a-z0-9-]{2,34}[a-z0-9])/) or system-generated if not provided during creation. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None) +
Lists all active subscriptions for a given subscriber. This can be filtered, for example, by user or data type.
+
+Args:
+  parent: string, Required. The parent subscriber. Format: projects/{project}/subscribers/{subscriber} The {subscriber} ID is user-settable (4-36 characters, matching /[a-z]([a-z0-9-]{2,34}[a-z0-9])/) if provided during creation, or system-generated otherwise. (required)
+  filter: string, Optional. A filter to apply to the list of subscriptions. The filter syntax is described in https://google.aip.dev/160. The filter can be applied to the following fields: - `user` - `data_type` The `user` identifier (e.g., `user1` in `users/user1`) refers to the public `health_user_id` Example: user = "users/user1" Example: user = "users/user1" OR user = "users/user2" Example: user = "users/user1" AND (data_type = "sleep" OR data_type = "weight")
+  pageSize: integer, Optional. The maximum number of subscriptions to return. The service may return fewer than this value. If unspecified, at most 50 subscriptions will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
+  pageToken: string, Optional. A page token, received from a previous `ListSubscriptions` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListSubscriptions` must match the call that provided the page token.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response message for ListSubscriptions.
+  "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.
+  "subscriptions": [ # The subscriptions from the specified subscriber.
+    { # A subscription to a data collection for a specific user, to be delivered to a subscriber.
+      "dataTypes": [ # Optional. Data types subscribed to. A subscriber will only receive notifications for data types that are declared here. A subscription can only subscribe to the data types of the subscriber. The values should be in the format "users/{health_user_id}/dataTypes/{data_type}" where `{data_type}` is one of "altitude", "distance", "floors", "sleep", "steps", "weight".
+        "A String",
+      ],
+      "name": "A String", # Identifier. The resource name of the Subscription. Format: `projects/{project}/subscribers/{subscriber}/subscriptions/{subscription}` Example: `projects/my-project/subscribers/my-subscriber-123/subscriptions/my-subscription-456` The {project} ID is mandatory (6-30 characters, matching /a-z{6,30}/) The {subscriber} ID is user-settable (4-36 characters, matching /[a-z]([a-z0-9-]{2,34}[a-z0-9])/) if provided during creation, or system-generated otherwise. The {subscription} ID is user-settable (4-36 chars, matching /[a-z]([a-z0-9-]{2,34}[a-z0-9])/) or system-generated otherwise.
+      "user": "A String", # Immutable. The resource name of the user for whom this subscription is active. Format: `users/{user}` where `{user}` is the public `healthUserId` as returned by the `GetIdentity` action in the profile PAPI (see `google.devicesandservices.health.v4main.HealthProfileService.GetIdentity`).
+    },
+  ],
+}
+
+ +
+ 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 the data types for an existing user subscription.
+
+Args:
+  name: string, Identifier. The resource name of the Subscription. Format: `projects/{project}/subscribers/{subscriber}/subscriptions/{subscription}` Example: `projects/my-project/subscribers/my-subscriber-123/subscriptions/my-subscription-456` The {project} ID is mandatory (6-30 characters, matching /a-z{6,30}/) The {subscriber} ID is user-settable (4-36 characters, matching /[a-z]([a-z0-9-]{2,34}[a-z0-9])/) if provided during creation, or system-generated otherwise. The {subscription} ID is user-settable (4-36 chars, matching /[a-z]([a-z0-9-]{2,34}[a-z0-9])/) or system-generated otherwise. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # A subscription to a data collection for a specific user, to be delivered to a subscriber.
+  "dataTypes": [ # Optional. Data types subscribed to. A subscriber will only receive notifications for data types that are declared here. A subscription can only subscribe to the data types of the subscriber. The values should be in the format "users/{health_user_id}/dataTypes/{data_type}" where `{data_type}` is one of "altitude", "distance", "floors", "sleep", "steps", "weight".
+    "A String",
+  ],
+  "name": "A String", # Identifier. The resource name of the Subscription. Format: `projects/{project}/subscribers/{subscriber}/subscriptions/{subscription}` Example: `projects/my-project/subscribers/my-subscriber-123/subscriptions/my-subscription-456` The {project} ID is mandatory (6-30 characters, matching /a-z{6,30}/) The {subscriber} ID is user-settable (4-36 characters, matching /[a-z]([a-z0-9-]{2,34}[a-z0-9])/) if provided during creation, or system-generated otherwise. The {subscription} ID is user-settable (4-36 chars, matching /[a-z]([a-z0-9-]{2,34}[a-z0-9])/) or system-generated otherwise.
+  "user": "A String", # Immutable. The resource name of the user for whom this subscription is active. Format: `users/{user}` where `{user}` is the public `healthUserId` as returned by the `GetIdentity` action in the profile PAPI (see `google.devicesandservices.health.v4main.HealthProfileService.GetIdentity`).
+}
+
+  updateMask: string, Optional. The list of fields to update.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A subscription to a data collection for a specific user, to be delivered to a subscriber.
+  "dataTypes": [ # Optional. Data types subscribed to. A subscriber will only receive notifications for data types that are declared here. A subscription can only subscribe to the data types of the subscriber. The values should be in the format "users/{health_user_id}/dataTypes/{data_type}" where `{data_type}` is one of "altitude", "distance", "floors", "sleep", "steps", "weight".
+    "A String",
+  ],
+  "name": "A String", # Identifier. The resource name of the Subscription. Format: `projects/{project}/subscribers/{subscriber}/subscriptions/{subscription}` Example: `projects/my-project/subscribers/my-subscriber-123/subscriptions/my-subscription-456` The {project} ID is mandatory (6-30 characters, matching /a-z{6,30}/) The {subscriber} ID is user-settable (4-36 characters, matching /[a-z]([a-z0-9-]{2,34}[a-z0-9])/) if provided during creation, or system-generated otherwise. The {subscription} ID is user-settable (4-36 chars, matching /[a-z]([a-z0-9-]{2,34}[a-z0-9])/) or system-generated otherwise.
+  "user": "A String", # Immutable. The resource name of the user for whom this subscription is active. Format: `users/{user}` where `{user}` is the public `healthUserId` as returned by the `GetIdentity` action in the profile PAPI (see `google.devicesandservices.health.v4main.HealthProfileService.GetIdentity`).
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/health_v4.users.dataTypes.dataPoints.html b/docs/dyn/health_v4.users.dataTypes.dataPoints.html index b1dc903e93..e91b066b81 100644 --- a/docs/dyn/health_v4.users.dataTypes.dataPoints.html +++ b/docs/dyn/health_v4.users.dataTypes.dataPoints.html @@ -176,6 +176,41 @@

Method Details

The object takes the form of: { # A computed or recorded metric. + "activeEnergyBurned": { # Energy burned as part of an activity, excluding the basal energy burn. # Optional. Data for points in the `active-energy-burned` interval data type collection. + "interval": { # Represents a time interval of an observed data point. # Required. Observed interval + "civilEndTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. Observed interval end time in civil time in the timezone the subject is in at the end of the observed interval + "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date. + "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. + "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. + "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. + }, + "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted. + "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. + "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59. + "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999. + "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds. + }, + }, + "civilStartTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. Observed interval start time in civil time in the timezone the subject is in at the start of the observed interval + "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date. + "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. + "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. + "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. + }, + "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted. + "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. + "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59. + "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999. + "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds. + }, + }, + "endTime": "A String", # Required. Observed interval end time. + "endUtcOffset": "A String", # Required. The offset of the user's local time at the end of the observation relative to the Coordinated Universal Time (UTC). + "startTime": "A String", # Required. Observed interval start time. + "startUtcOffset": "A String", # Required. The offset of the user's local time at the start of the observation relative to the Coordinated Universal Time (UTC). + }, + "kcal": 3.14, # Required. Energy burned during an activity, measured in kilocalories. + }, "activeMinutes": { # Record of active minutes in a given time interval. # Optional. Data for points in the `active-minutes` interval data type collection. "activeMinutesByActivityLevel": [ # Required. Active minutes by activity level. At most one record per activity level is allowed. { # Active minutes at a given activity level. @@ -357,6 +392,31 @@

Method Details

}, "kcal": 3.14, # Required. Number of calories burned due to basal metabolic rate in kilocalories over the observed interval. }, + "bloodGlucose": { # Represents a blood glucose level measurement. LINT: LEGACY_NAMES # Optional. Data for points in the `blood-glucose` sample data type collection. + "bloodGlucoseMilligramsPerDeciliter": 3.14, # Required. Blood glucose level concentration in mg/dL. + "mealType": "A String", # Optional. Meal type of the measurement. + "measurementSource": "A String", # Optional. Source of the measurement. + "measurementTiming": "A String", # Optional. Timing of the measurement. + "notes": "A String", # Optional. Standard free-form notes captured at manual logging. + "sampleTime": { # Represents a sample time of an observed data point. # Required. The time at which blood glucose was measured. + "civilTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. The civil time in the timezone the subject is in at the time of the observation. + "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date. + "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. + "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. + "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. + }, + "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted. + "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. + "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59. + "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999. + "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds. + }, + }, + "physicalTime": "A String", # Required. The time of the observation. + "utcOffset": "A String", # Required. The offset of the user's local time during the observation relative to the Coordinated Universal Time (UTC). + }, + "specimen": "A String", # Optional. Type of body fluid used to measure the blood glucose. + }, "bodyFat": { # Body fat measurement. # Optional. Data for points in the `body-fat` sample data type collection. "percentage": 3.14, # Required. Body fat percentage, in range [0, 100]. "sampleTime": { # Represents a sample time of an observed data point. # Required. The time at which body fat was measured. @@ -377,6 +437,28 @@

Method Details

"utcOffset": "A String", # Required. The offset of the user's local time during the observation relative to the Coordinated Universal Time (UTC). }, }, + "coreBodyTemperature": { # Core body temperature measurement, distinct from peripheral body temperature, reflects the temperature of the body's internal organs. # Optional. Data for points in the `core-body-temperature` sample data type collection. + "id": "A String", # Optional. The unique identifier of the core body temperature measurement. + "measurementLocation": "A String", # Optional. The location of the core body temperature measurement. + "sampleTime": { # Represents a sample time of an observed data point. # Required. The time at which core body temperature was measured. + "civilTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. The civil time in the timezone the subject is in at the time of the observation. + "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date. + "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. + "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. + "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. + }, + "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted. + "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. + "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59. + "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999. + "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds. + }, + }, + "physicalTime": "A String", # Required. The time of the observation. + "utcOffset": "A String", # Required. The offset of the user's local time during the observation relative to the Coordinated Universal Time (UTC). + }, + "temperatureCelsius": 3.14, # Required. The core body temperature in Celsius. + }, "dailyHeartRateVariability": { # Represents the daily heart rate variability data type. At least one of the following fields must be set: - `average_heart_rate_variability_milliseconds` - `non_rem_heart_rate_beats_per_minute` - `entropy` - `deep_sleep_root_mean_square_of_successive_differences_milliseconds` # Optional. Data for points in the `daily-heart-rate-variability` daily data type collection. "averageHeartRateVariabilityMilliseconds": 3.14, # Optional. A user's average heart rate variability calculated using the root mean square of successive differences (RMSSD) in times between heartbeats. "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Date (in the user's timezone) of heart rate variability measurement. @@ -502,6 +584,55 @@

Method Details

}, "millimeters": "A String", # Required. Distance in millimeters over the observed interval. }, + "electrocardiogram": { # Represents an Electrocardiogram (ECG) measurement session. This data type is based on SaMD feature and any changes to it may require additional review. # Optional. Data for points in the `electrocardiogram` session data type collection. + "beatsPerMinuteAvg": "A String", # Optional. Average heart rate recorded during ECG reading in beats per minute. + "interval": { # Represents a time interval of session data point, which bundles multiple observed metrics together. # Required. Observed interval. NOTE: Historical ECG data lacks timezone offsets, so `start_utc_offset` and `end_utc_offset` will be missing or default to zero. As a result, the civil time fields within this interval will default to UTC. It is recommended to use physical time fields instead for accurate time referencing. NOTE: The `start_time` and `end_time` of the interval are equal, representing the reading time. + "civilEndTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. Session end time in civil time in the timezone the subject is in at the end of the session. + "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date. + "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. + "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. + "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. + }, + "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted. + "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. + "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59. + "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999. + "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds. + }, + }, + "civilStartTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. Session start time in civil time in the timezone the subject is in at the start of the session. + "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date. + "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. + "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. + "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. + }, + "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted. + "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. + "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59. + "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999. + "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds. + }, + }, + "endTime": "A String", # Required. The end time of the observed session. + "endUtcOffset": "A String", # Required. The offset of the user's local time at the end of the session relative to the Coordinated Universal Time (UTC). + "startTime": "A String", # Required. The start time of the observed session. + "startUtcOffset": "A String", # Required. The offset of the user's local time at the start of the session relative to the Coordinated Universal Time (UTC). + }, + "leadNumber": 42, # Optional. The number of leads used for ECG reading. + "medicalDeviceInfo": { # Software as Medical Device (SaMD) metadata. Used to construct the Unique Device Identifier (UDI). # Output only. The meta information for the compatible device used to conduct the measurement. ECG measurements typically populate `firmware_version`, `feature_version`, and `device_model`. + "algorithmVersion": "A String", # Output only. The algorithm version used by the feature. + "deviceModel": "A String", # Output only. The model name or device type of the compatible device used to collect the data. + "featureVersion": "A String", # Output only. The version of the feature/app running on the device. + "firmwareVersion": "A String", # Output only. The firmware version running on the compatible device used to collect the data. + "serviceVersion": "A String", # Output only. The service version used by the feature. + }, + "millivoltsScalingFactor": 42, # Optional. The factor by which to divide waveform samples to get voltage in millivolts: millivolts = waveform_sample / millivolts_scaling_factor. + "resultClassification": "A String", # Optional. The result classification of the ECG reading. + "samplingFrequencyHertz": 42, # Optional. The sampling frequency of waveform samples in hertz. + "waveformSamples": [ # Optional. An array of voltage values representing lead I ECG values. Each sample represents voltage difference in ECG graph. The first value in array corresponds to the start of the reading. + 42, + ], + }, "exercise": { # An exercise that stores information about a physical activity. # Optional. Data for points in the `exercise` session data type collection. "activeDuration": "A String", # Optional. Duration excluding pauses. "createTime": "A String", # Output only. Represents the timestamp of the creation of the exercise. @@ -683,6 +814,67 @@

Method Details

"startUtcOffset": "A String", # Required. The offset of the user's local time at the start of the observation relative to the Coordinated Universal Time (UTC). }, }, + "food": { # Represents a food item. # Optional. The food details. + "accessLevel": "A String", # Required. The access level of the food. + "brand": "A String", # Optional. The brand of the food. + "defaultServing": { # Represents different properties and information about the serving of a specific food. # Required. Value representing the default serving of the food. + "amount": 3.14, # Optional. Amount of food consumed, fractional values are supported. + "foodMeasurementUnit": "A String", # Required. Food measurement unit + "foodMeasurementUnitDisplayName": "A String", # Output only. Legacy measurement unit for serving size in singular form (e.g. "piece", "gram"). + "foodMeasurementUnitDisplayNamePlural": "A String", # Output only. Legacy measurement unit for serving size in plural form (e.g. "pieces", "grams"). + "multiplier": 3.14, # Optional. Value representing the multiplier used to compute the energy when using this serving instead of the default serving. + }, + "description": "A String", # Optional. The description of the food. + "displayName": "A String", # Required. The display name of the food. + "energyAvg": { # Represents the energy quantity. # Optional. Value representing the average energy of the food for the default serving. + "kcal": 3.14, # Required. Value representing the energy in kilocalories. + "userProvidedUnit": "A String", # Optional. Value representing the user provided unit. + }, + "energyFromFat": { # Represents the energy quantity. # Optional. Value representing the energy from fat of the food for the default serving. + "kcal": 3.14, # Required. Value representing the energy in kilocalories. + "userProvidedUnit": "A String", # Optional. Value representing the user provided unit. + }, + "energyMax": { # Represents the energy quantity. # Optional. Value representing the maximum energy of the food for the default serving. + "kcal": 3.14, # Required. Value representing the energy in kilocalories. + "userProvidedUnit": "A String", # Optional. Value representing the user provided unit. + }, + "energyMin": { # Represents the energy quantity. # Optional. Value representing the minimum energy of the food for the default serving. + "kcal": 3.14, # Required. Value representing the energy in kilocalories. + "userProvidedUnit": "A String", # Optional. Value representing the user provided unit. + }, + "languageCode": "A String", # Optional. The language code where the food is available in format xx-XX. Supported values are defined in Settings.food_language_code. + "mealType": "A String", # Optional. The meal type associated with this food. + "nutrients": [ # Optional. Value representing the nutrients of the food for the default serving. + { # Represents the quantity of a nutrient. + "nutrient": "A String", # Required. Value representing the nutrient. + "quantity": { # Represents the weight quantity. # Required. Value representing the quantity of the nutrient. + "grams": 3.14, # Required. Value representing the weight in grams. + "userProvidedUnit": "A String", # Optional. Value representing the user provided unit. + }, + }, + ], + "servings": [ # Optional. The serving of the food. + { # Represents different properties and information about the serving of a specific food. + "amount": 3.14, # Optional. Amount of food consumed, fractional values are supported. + "foodMeasurementUnit": "A String", # Required. Food measurement unit + "foodMeasurementUnitDisplayName": "A String", # Output only. Legacy measurement unit for serving size in singular form (e.g. "piece", "gram"). + "foodMeasurementUnitDisplayNamePlural": "A String", # Output only. Legacy measurement unit for serving size in plural form (e.g. "pieces", "grams"). + "multiplier": 3.14, # Optional. Value representing the multiplier used to compute the energy when using this serving instead of the default serving. + }, + ], + "totalCarbohydrate": { # Represents the weight quantity. # Optional. Value representing the total carbohydrate of the food for the default serving. + "grams": 3.14, # Required. Value representing the weight in grams. + "userProvidedUnit": "A String", # Optional. Value representing the user provided unit. + }, + "totalFat": { # Represents the weight quantity. # Optional. Value representing the total fat of the food for the default serving. + "grams": 3.14, # Required. Value representing the weight in grams. + "userProvidedUnit": "A String", # Optional. Value representing the user provided unit. + }, + }, + "foodMeasurementUnit": { # Represents a food measurement unit. # Optional. The food measurement unit details. + "displayName": "A String", # Required. The display name of the food measurement unit (e.g., "gram", "piece"). + "pluralDisplayName": "A String", # Optional. The plural display name of the food measurement unit (e.g., "grams", "pieces"). + }, "heartRate": { # A heart rate measurement. # Optional. Data for points in the `heart-rate` sample data type collection. "beatsPerMinute": "A String", # Required. The heart rate value in beats per minute. "metadata": { # Heart rate metadata. # Optional. Metadata about the heart rate sample. @@ -786,7 +978,170 @@

Method Details

"startUtcOffset": "A String", # Required. The offset of the user's local time at the start of the session relative to the Coordinated Universal Time (UTC). }, }, + "irregularRhythmNotification": { # Represents an Irregular Rhythm Notification alert, indicating a potential sign of atrial fibrillation (AFib). This data type is based on SaMD feature and any changes to it may require additional review. # Optional. Data for points in the `irregular-rhythm-notification` session data type collection. + "alertWindows": [ # Optional. The overlapping analysis windows that were used to evaluate rhythm for potential AFib, containing specific information about the user's heart rhythm. + { # An analysis window evaluated for AFib. Note: The current version of the algorithm will only produce alerts if all windows are positive. So anything returned from the API will always have the positive bit set to true. Internally, windows can be negative, however. We never save "inconclusive" windows (they aren't produced by the algorithm). + "civilEndTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. Observed interval end time in civil time in the timezone the subject is in at the end of the observed interval + "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date. + "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. + "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. + "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. + }, + "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted. + "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. + "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59. + "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999. + "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds. + }, + }, + "civilStartTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. Observed interval start time in civil time in the timezone the subject is in at the start of the observed interval + "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date. + "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. + "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. + "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. + }, + "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted. + "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. + "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59. + "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999. + "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds. + }, + }, + "endTime": "A String", # Required. The end time of the analysis window. + "endUtcOffset": "A String", # Required. The UTC offset of the user's timezone when the analysis window ended. + "heartBeats": [ # Optional. All heart beats in the interval contained in this analysis window. + { # A single heart beat measurement. + "beatsPerMinute": 42, # Required. The beats-per-minute value extrapolated from the time before the following heart beat. This is calculated as 60000 / rr, where rr is the gap between heart beats in milliseconds (IBI - Interbeat Interval). + "civilTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. The civil time in the timezone the subject is in at the time of the observation. + "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date. + "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. + "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. + "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. + }, + "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted. + "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. + "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59. + "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999. + "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds. + }, + }, + "physicalTime": "A String", # Required. The time of the heart beat measurement. + "utcOffset": "A String", # Required. The UTC offset of the user's timezone when the heart beat measurement occurred. + }, + ], + "positive": True or False, # Optional. Flag indicating whether the window was positive for AFib or not. A `true` value indicates that AFib was detected in this window. A `false` value means AFib was not detected, but does not guarantee the absence of AFib. + "startTime": "A String", # Required. Observed interval. The start time of the analysis window. + "startUtcOffset": "A String", # Required. The UTC offset of the user's timezone when the analysis window started. + }, + ], + "interval": { # Represents a time interval of session data point, which bundles multiple observed metrics together. # Required. Observed interval. + "civilEndTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. Session end time in civil time in the timezone the subject is in at the end of the session. + "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date. + "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. + "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. + "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. + }, + "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted. + "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. + "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59. + "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999. + "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds. + }, + }, + "civilStartTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. Session start time in civil time in the timezone the subject is in at the start of the session. + "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date. + "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. + "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. + "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. + }, + "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted. + "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. + "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59. + "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999. + "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds. + }, + }, + "endTime": "A String", # Required. The end time of the observed session. + "endUtcOffset": "A String", # Required. The offset of the user's local time at the end of the session relative to the Coordinated Universal Time (UTC). + "startTime": "A String", # Required. The start time of the observed session. + "startUtcOffset": "A String", # Required. The offset of the user's local time at the start of the session relative to the Coordinated Universal Time (UTC). + }, + "medicalDeviceInfo": { # Software as Medical Device (SaMD) metadata. Used to construct the Unique Device Identifier (UDI). # Output only. The meta information for the compatible device used to conduct the measurement. Irregular Rhythm Notification measurements typically populate `algorithm_version`, `service_version`, and `device_model`. + "algorithmVersion": "A String", # Output only. The algorithm version used by the feature. + "deviceModel": "A String", # Output only. The model name or device type of the compatible device used to collect the data. + "featureVersion": "A String", # Output only. The version of the feature/app running on the device. + "firmwareVersion": "A String", # Output only. The firmware version running on the compatible device used to collect the data. + "serviceVersion": "A String", # Output only. The service version used by the feature. + }, + }, "name": "A String", # Identifier. Data point name, only supported for the subset of identifiable data types. For the majority of the data types, individual data points do not need to be identified and this field would be empty. Format: `users/{user}/dataTypes/{data_type}/dataPoints/{data_point}` Example: `users/abcd1234/dataTypes/sleep/dataPoints/a1b2c3d4-e5f6-7890-1234-567890abcdef` The `{user}` ID is a system-generated identifier, as described in Identity.health_user_id. The `{data_type}` ID corresponds to the kebab-case version of the field names in the DataPoint data union field, e.g. `total-calories` for the `total_calories` field. The `{data_point}` ID can be client-provided or system-generated. If client-provided, it must be a string of 4-63 characters, containing only lowercase letters, numbers, and hyphens. + "nutritionLog": { # Holds information about a user logged food. There are two ways of creating a nutrition log based on the food type: 1. Identified food: Using the food field, which is a reference to a Food resource. In this case fields `nutrients`, `energy`, `energy_from_fat`, `total_carbohydrate`, `total_fat`, `food_display_name` will be populated based on the referenced food. 2. Anonymous food: Using the `food_display_name` field and setting the `nutrients`, `energy`, `energy_from_fat`, `total_carbohydrate`, `total_fat` fields manually. The identified food is preferred over the anonymous food. Nutrition logs created from anonymous food are not be editable. # Optional. Data for points in the `nutrition-log` session data type collection. + "energy": { # Represents the energy quantity. # Optional. Value representing the energy of the nutrition log. For nutrition logs created from an identified food, this field will be populated based on the referenced food. For anonymous food, this field will be populated manually. + "kcal": 3.14, # Required. Value representing the energy in kilocalories. + "userProvidedUnit": "A String", # Optional. Value representing the user provided unit. + }, + "energyFromFat": { # Represents the energy quantity. # Optional. Value representing the energy from fat of the nutrition log. For nutrition logs created from an identified food, this field will be populated based on the referenced food. For anonymous food, this field will be populated manually. + "kcal": 3.14, # Required. Value representing the energy in kilocalories. + "userProvidedUnit": "A String", # Optional. Value representing the user provided unit. + }, + "food": "A String", # Required. Represents the food ID. + "foodDisplayName": "A String", # Value representing the display name of the food. For nutrition logs created from an identified food, this field will be populated based on the referenced food. For anonymous food, this field will be populated manually. + "interval": { # Represents a time interval of session data point, which bundles multiple observed metrics together. # Required. Observed interval. + "civilEndTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. Session end time in civil time in the timezone the subject is in at the end of the session. + "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date. + "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. + "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. + "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. + }, + "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted. + "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. + "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59. + "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999. + "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds. + }, + }, + "civilStartTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. Session start time in civil time in the timezone the subject is in at the start of the session. + "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date. + "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. + "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. + "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. + }, + "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted. + "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. + "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59. + "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999. + "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds. + }, + }, + "endTime": "A String", # Required. The end time of the observed session. + "endUtcOffset": "A String", # Required. The offset of the user's local time at the end of the session relative to the Coordinated Universal Time (UTC). + "startTime": "A String", # Required. The start time of the observed session. + "startUtcOffset": "A String", # Required. The offset of the user's local time at the start of the session relative to the Coordinated Universal Time (UTC). + }, + "mealType": "A String", # Optional. Value representing the meal type of the nutrition log. + "nutrients": [ # Optional. Value representing the nutrients of the nutrition log. + { # Represents the quantity of a nutrient. + "nutrient": "A String", # Required. Value representing the nutrient. + "quantity": { # Represents the weight quantity. # Required. Value representing the quantity of the nutrient. + "grams": 3.14, # Required. Value representing the weight in grams. + "userProvidedUnit": "A String", # Optional. Value representing the user provided unit. + }, + }, + ], + "serving": { # Represents different properties and information about the serving of a specific food. # Optional. Value representing the nutrition log serving. + "amount": 3.14, # Optional. Amount of food consumed, fractional values are supported. + "foodMeasurementUnit": "A String", # Required. Food measurement unit + "foodMeasurementUnitDisplayName": "A String", # Output only. Legacy measurement unit for serving size in singular form (e.g. "piece", "gram"). + }, + "totalCarbohydrate": { # Represents the weight quantity. # Optional. Value representing the total carbohydrate of the nutrition log. For nutrition logs created from an identified food, this field will be populated based on the referenced food. For anonymous food, this field will be populated manually. + "grams": 3.14, # Required. Value representing the weight in grams. + "userProvidedUnit": "A String", # Optional. Value representing the user provided unit. + }, + "totalFat": { # Represents the weight quantity. # Optional. Value representing the total fat of the nutrition log. For nutrition logs created from an identified food, this field will be populated based on the referenced food. For anonymous food, this field will be populated manually. + "grams": 3.14, # Required. Value representing the weight in grams. + "userProvidedUnit": "A String", # Optional. Value representing the user provided unit. + }, + }, "oxygenSaturation": { # Captures the user's instantaneous oxygen saturation percentage (SpO2). # Optional. Data for points in the `oxygen-saturation` sample data type collection. "percentage": 3.14, # Required. The oxygen saturation percentage. Valid values are from 0 to 100. "sampleTime": { # Represents a sample time of an observed data point. # Required. The time at which oxygen saturation was measured. @@ -1211,6 +1566,9 @@

Method Details

{ # Response containing the list of rolled up data points. "rollupDataPoints": [ # Values for each aggregation time window. { # Value of a daily rollup for a single civil time interval (aggregation window) of reconciled data points from all data sources, excluding those data points that are identified as recorded by wearables in intervals when they were not actually worn. + "activeEnergyBurned": { # Represents the result of the rollup of active energy burned. # Returned by default when rolling up data points from the `active-energy-burned` data type. + "kcalSum": 3.14, # Output only. Sum of the active energy burned in kilocalories. + }, "activeMinutes": { # Represents the result of the rollup of the active minutes data type. # Returned by default when rolling up data points from the `active-minutes` data type, or when requested explicitly using the `active-minutes` rollup type identifier. "activeMinutesRollupByActivityLevel": [ # Active minutes by activity level. At most one record per activity level is allowed. { # Active minutes by activity level. @@ -1235,6 +1593,9 @@

Method Details

"altitude": { # Represents the result of the rollup of the user's altitude. # Returned by default when rolling up data points from the `altitude` data type, or when requested explicitly using the `altitude` rollup type identifier. "gainMillimetersSum": "A String", # Sum of the altitude gain in millimeters. }, + "bloodGlucose": { # Represents the result of the rollup of the blood glucose data type. LINT: LEGACY_NAMES # Returned by default when rolling up data points from the `blood-glucose` data type. + "bloodGlucoseMilligramsPerDeciliterAvg": 3.14, # Average blood glucose level in mg/dL. + }, "bodyFat": { # Represents the result of the rollup of the body fat data type. # Returned by default when rolling up data points from the `body-fat` data type, or when requested explicitly using the `body-fat` rollup type identifier. "bodyFatPercentageAvg": 3.14, # Average body fat percentage. }, @@ -1272,6 +1633,11 @@

Method Details

"seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds. }, }, + "coreBodyTemperature": { # Represents the result of the rollup of the core body temperature data type. # Returned by default when rolling up data points from the `core-body-temperature` data type, or when requested explicitly using the `core-body-temperature` rollup type identifier. + "temperatureCelsiusAvg": 3.14, # Average core body temperature in Celsius. + "temperatureCelsiusMax": 3.14, # Maximum core body temperature in Celsius. + "temperatureCelsiusMin": 3.14, # Minimum core body temperature in Celsius. + }, "distance": { # Result of the rollup of the user's distance. # Returned by default when rolling up data points from the `distance` data type, or when requested explicitly using the `distance` rollup type identifier. "millimetersSum": "A String", # Sum of the distance in millimeters. }, @@ -1293,6 +1659,33 @@

Method Details

"userProvidedUnitLast": "A String", # Optional. The user provided unit on the last element. }, }, + "nutritionLog": { # Represents the result of the rollup of the nutrition log data type. # Returned by default when rolling up data points from the `nutrition-log` data type, or when requested explicitly using the `nutrition-log` rollup type identifier. + "energy": { # Rollup for the energy quantity. # Energy rollup. + "kcalSum": 3.14, # Required. The sum of the energy in kilocalories. + "userProvidedUnitLast": "A String", # Optional. The user provided unit on the last element. + }, + "energyFromFat": { # Rollup for the energy quantity. # Value Energy from fat rollup. + "kcalSum": 3.14, # Required. The sum of the energy in kilocalories. + "userProvidedUnitLast": "A String", # Optional. The user provided unit on the last element. + }, + "nutrients": [ # List of the nutrient roll-ups by the nutrient type. + { # Nutrient quantity rollup. + "nutrient": "A String", # Required. Aggregated nutrient. + "quantity": { # Rollup for the weight. # Required. Aggregated nutrient weight. + "gramsSum": 3.14, # Required. The sum of the weight in grams. + "userProvidedUnitLast": "A String", # Optional. The user provided unit on the last element. + }, + }, + ], + "totalCarbohydrate": { # Rollup for the weight. # Total carbohydrate rollup. + "gramsSum": 3.14, # Required. The sum of the weight in grams. + "userProvidedUnitLast": "A String", # Optional. The user provided unit on the last element. + }, + "totalFat": { # Rollup for the weight. # Total fat rollup. + "gramsSum": 3.14, # Required. The sum of the weight in grams. + "userProvidedUnitLast": "A String", # Optional. The user provided unit on the last element. + }, + }, "restingHeartRatePersonalRange": { # Represents the rollup value for the daily resting heart rate data type. # Returned by default when rolling up data points from the `daily-resting-heart-rate` data type, or when requested explicitly using the `resting-heart-rate-personal-range` rollup type identifier. "beatsPerMinuteMax": 3.14, # The upper bound of the user's daily resting heart rate personal range. "beatsPerMinuteMin": 3.14, # The lower bound of the user's daily resting heart rate personal range. @@ -1383,6 +1776,41 @@

Method Details

An object of the form: { # A computed or recorded metric. + "activeEnergyBurned": { # Energy burned as part of an activity, excluding the basal energy burn. # Optional. Data for points in the `active-energy-burned` interval data type collection. + "interval": { # Represents a time interval of an observed data point. # Required. Observed interval + "civilEndTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. Observed interval end time in civil time in the timezone the subject is in at the end of the observed interval + "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date. + "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. + "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. + "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. + }, + "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted. + "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. + "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59. + "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999. + "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds. + }, + }, + "civilStartTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. Observed interval start time in civil time in the timezone the subject is in at the start of the observed interval + "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date. + "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. + "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. + "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. + }, + "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted. + "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. + "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59. + "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999. + "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds. + }, + }, + "endTime": "A String", # Required. Observed interval end time. + "endUtcOffset": "A String", # Required. The offset of the user's local time at the end of the observation relative to the Coordinated Universal Time (UTC). + "startTime": "A String", # Required. Observed interval start time. + "startUtcOffset": "A String", # Required. The offset of the user's local time at the start of the observation relative to the Coordinated Universal Time (UTC). + }, + "kcal": 3.14, # Required. Energy burned during an activity, measured in kilocalories. + }, "activeMinutes": { # Record of active minutes in a given time interval. # Optional. Data for points in the `active-minutes` interval data type collection. "activeMinutesByActivityLevel": [ # Required. Active minutes by activity level. At most one record per activity level is allowed. { # Active minutes at a given activity level. @@ -1564,9 +1992,13 @@

Method Details

}, "kcal": 3.14, # Required. Number of calories burned due to basal metabolic rate in kilocalories over the observed interval. }, - "bodyFat": { # Body fat measurement. # Optional. Data for points in the `body-fat` sample data type collection. - "percentage": 3.14, # Required. Body fat percentage, in range [0, 100]. - "sampleTime": { # Represents a sample time of an observed data point. # Required. The time at which body fat was measured. + "bloodGlucose": { # Represents a blood glucose level measurement. LINT: LEGACY_NAMES # Optional. Data for points in the `blood-glucose` sample data type collection. + "bloodGlucoseMilligramsPerDeciliter": 3.14, # Required. Blood glucose level concentration in mg/dL. + "mealType": "A String", # Optional. Meal type of the measurement. + "measurementSource": "A String", # Optional. Source of the measurement. + "measurementTiming": "A String", # Optional. Timing of the measurement. + "notes": "A String", # Optional. Standard free-form notes captured at manual logging. + "sampleTime": { # Represents a sample time of an observed data point. # Required. The time at which blood glucose was measured. "civilTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. The civil time in the timezone the subject is in at the time of the observation. "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date. "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. @@ -1583,13 +2015,56 @@

Method Details

"physicalTime": "A String", # Required. The time of the observation. "utcOffset": "A String", # Required. The offset of the user's local time during the observation relative to the Coordinated Universal Time (UTC). }, + "specimen": "A String", # Optional. Type of body fluid used to measure the blood glucose. }, - "dailyHeartRateVariability": { # Represents the daily heart rate variability data type. At least one of the following fields must be set: - `average_heart_rate_variability_milliseconds` - `non_rem_heart_rate_beats_per_minute` - `entropy` - `deep_sleep_root_mean_square_of_successive_differences_milliseconds` # Optional. Data for points in the `daily-heart-rate-variability` daily data type collection. - "averageHeartRateVariabilityMilliseconds": 3.14, # Optional. A user's average heart rate variability calculated using the root mean square of successive differences (RMSSD) in times between heartbeats. - "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Date (in the user's timezone) of heart rate variability measurement. - "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. - "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. - "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. + "bodyFat": { # Body fat measurement. # Optional. Data for points in the `body-fat` sample data type collection. + "percentage": 3.14, # Required. Body fat percentage, in range [0, 100]. + "sampleTime": { # Represents a sample time of an observed data point. # Required. The time at which body fat was measured. + "civilTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. The civil time in the timezone the subject is in at the time of the observation. + "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date. + "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. + "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. + "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. + }, + "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted. + "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. + "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59. + "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999. + "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds. + }, + }, + "physicalTime": "A String", # Required. The time of the observation. + "utcOffset": "A String", # Required. The offset of the user's local time during the observation relative to the Coordinated Universal Time (UTC). + }, + }, + "coreBodyTemperature": { # Core body temperature measurement, distinct from peripheral body temperature, reflects the temperature of the body's internal organs. # Optional. Data for points in the `core-body-temperature` sample data type collection. + "id": "A String", # Optional. The unique identifier of the core body temperature measurement. + "measurementLocation": "A String", # Optional. The location of the core body temperature measurement. + "sampleTime": { # Represents a sample time of an observed data point. # Required. The time at which core body temperature was measured. + "civilTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. The civil time in the timezone the subject is in at the time of the observation. + "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date. + "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. + "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. + "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. + }, + "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted. + "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. + "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59. + "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999. + "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds. + }, + }, + "physicalTime": "A String", # Required. The time of the observation. + "utcOffset": "A String", # Required. The offset of the user's local time during the observation relative to the Coordinated Universal Time (UTC). + }, + "temperatureCelsius": 3.14, # Required. The core body temperature in Celsius. + }, + "dailyHeartRateVariability": { # Represents the daily heart rate variability data type. At least one of the following fields must be set: - `average_heart_rate_variability_milliseconds` - `non_rem_heart_rate_beats_per_minute` - `entropy` - `deep_sleep_root_mean_square_of_successive_differences_milliseconds` # Optional. Data for points in the `daily-heart-rate-variability` daily data type collection. + "averageHeartRateVariabilityMilliseconds": 3.14, # Optional. A user's average heart rate variability calculated using the root mean square of successive differences (RMSSD) in times between heartbeats. + "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Date (in the user's timezone) of heart rate variability measurement. + "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. + "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. + "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. }, "deepSleepRootMeanSquareOfSuccessiveDifferencesMilliseconds": 3.14, # Optional. The root mean square of successive differences (RMSSD) value during deep sleep. "entropy": 3.14, # Optional. The Shanon entropy of heartbeat intervals. Entropy quantifies randomness or disorder in a system. High entropy indicates high HRV. Entropy is measured from the histogram of time interval between successive heart beats values measured during sleep. @@ -1709,6 +2184,55 @@

Method Details

}, "millimeters": "A String", # Required. Distance in millimeters over the observed interval. }, + "electrocardiogram": { # Represents an Electrocardiogram (ECG) measurement session. This data type is based on SaMD feature and any changes to it may require additional review. # Optional. Data for points in the `electrocardiogram` session data type collection. + "beatsPerMinuteAvg": "A String", # Optional. Average heart rate recorded during ECG reading in beats per minute. + "interval": { # Represents a time interval of session data point, which bundles multiple observed metrics together. # Required. Observed interval. NOTE: Historical ECG data lacks timezone offsets, so `start_utc_offset` and `end_utc_offset` will be missing or default to zero. As a result, the civil time fields within this interval will default to UTC. It is recommended to use physical time fields instead for accurate time referencing. NOTE: The `start_time` and `end_time` of the interval are equal, representing the reading time. + "civilEndTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. Session end time in civil time in the timezone the subject is in at the end of the session. + "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date. + "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. + "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. + "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. + }, + "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted. + "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. + "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59. + "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999. + "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds. + }, + }, + "civilStartTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. Session start time in civil time in the timezone the subject is in at the start of the session. + "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date. + "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. + "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. + "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. + }, + "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted. + "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. + "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59. + "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999. + "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds. + }, + }, + "endTime": "A String", # Required. The end time of the observed session. + "endUtcOffset": "A String", # Required. The offset of the user's local time at the end of the session relative to the Coordinated Universal Time (UTC). + "startTime": "A String", # Required. The start time of the observed session. + "startUtcOffset": "A String", # Required. The offset of the user's local time at the start of the session relative to the Coordinated Universal Time (UTC). + }, + "leadNumber": 42, # Optional. The number of leads used for ECG reading. + "medicalDeviceInfo": { # Software as Medical Device (SaMD) metadata. Used to construct the Unique Device Identifier (UDI). # Output only. The meta information for the compatible device used to conduct the measurement. ECG measurements typically populate `firmware_version`, `feature_version`, and `device_model`. + "algorithmVersion": "A String", # Output only. The algorithm version used by the feature. + "deviceModel": "A String", # Output only. The model name or device type of the compatible device used to collect the data. + "featureVersion": "A String", # Output only. The version of the feature/app running on the device. + "firmwareVersion": "A String", # Output only. The firmware version running on the compatible device used to collect the data. + "serviceVersion": "A String", # Output only. The service version used by the feature. + }, + "millivoltsScalingFactor": 42, # Optional. The factor by which to divide waveform samples to get voltage in millivolts: millivolts = waveform_sample / millivolts_scaling_factor. + "resultClassification": "A String", # Optional. The result classification of the ECG reading. + "samplingFrequencyHertz": 42, # Optional. The sampling frequency of waveform samples in hertz. + "waveformSamples": [ # Optional. An array of voltage values representing lead I ECG values. Each sample represents voltage difference in ECG graph. The first value in array corresponds to the start of the reading. + 42, + ], + }, "exercise": { # An exercise that stores information about a physical activity. # Optional. Data for points in the `exercise` session data type collection. "activeDuration": "A String", # Optional. Duration excluding pauses. "createTime": "A String", # Output only. Represents the timestamp of the creation of the exercise. @@ -1890,6 +2414,67 @@

Method Details

"startUtcOffset": "A String", # Required. The offset of the user's local time at the start of the observation relative to the Coordinated Universal Time (UTC). }, }, + "food": { # Represents a food item. # Optional. The food details. + "accessLevel": "A String", # Required. The access level of the food. + "brand": "A String", # Optional. The brand of the food. + "defaultServing": { # Represents different properties and information about the serving of a specific food. # Required. Value representing the default serving of the food. + "amount": 3.14, # Optional. Amount of food consumed, fractional values are supported. + "foodMeasurementUnit": "A String", # Required. Food measurement unit + "foodMeasurementUnitDisplayName": "A String", # Output only. Legacy measurement unit for serving size in singular form (e.g. "piece", "gram"). + "foodMeasurementUnitDisplayNamePlural": "A String", # Output only. Legacy measurement unit for serving size in plural form (e.g. "pieces", "grams"). + "multiplier": 3.14, # Optional. Value representing the multiplier used to compute the energy when using this serving instead of the default serving. + }, + "description": "A String", # Optional. The description of the food. + "displayName": "A String", # Required. The display name of the food. + "energyAvg": { # Represents the energy quantity. # Optional. Value representing the average energy of the food for the default serving. + "kcal": 3.14, # Required. Value representing the energy in kilocalories. + "userProvidedUnit": "A String", # Optional. Value representing the user provided unit. + }, + "energyFromFat": { # Represents the energy quantity. # Optional. Value representing the energy from fat of the food for the default serving. + "kcal": 3.14, # Required. Value representing the energy in kilocalories. + "userProvidedUnit": "A String", # Optional. Value representing the user provided unit. + }, + "energyMax": { # Represents the energy quantity. # Optional. Value representing the maximum energy of the food for the default serving. + "kcal": 3.14, # Required. Value representing the energy in kilocalories. + "userProvidedUnit": "A String", # Optional. Value representing the user provided unit. + }, + "energyMin": { # Represents the energy quantity. # Optional. Value representing the minimum energy of the food for the default serving. + "kcal": 3.14, # Required. Value representing the energy in kilocalories. + "userProvidedUnit": "A String", # Optional. Value representing the user provided unit. + }, + "languageCode": "A String", # Optional. The language code where the food is available in format xx-XX. Supported values are defined in Settings.food_language_code. + "mealType": "A String", # Optional. The meal type associated with this food. + "nutrients": [ # Optional. Value representing the nutrients of the food for the default serving. + { # Represents the quantity of a nutrient. + "nutrient": "A String", # Required. Value representing the nutrient. + "quantity": { # Represents the weight quantity. # Required. Value representing the quantity of the nutrient. + "grams": 3.14, # Required. Value representing the weight in grams. + "userProvidedUnit": "A String", # Optional. Value representing the user provided unit. + }, + }, + ], + "servings": [ # Optional. The serving of the food. + { # Represents different properties and information about the serving of a specific food. + "amount": 3.14, # Optional. Amount of food consumed, fractional values are supported. + "foodMeasurementUnit": "A String", # Required. Food measurement unit + "foodMeasurementUnitDisplayName": "A String", # Output only. Legacy measurement unit for serving size in singular form (e.g. "piece", "gram"). + "foodMeasurementUnitDisplayNamePlural": "A String", # Output only. Legacy measurement unit for serving size in plural form (e.g. "pieces", "grams"). + "multiplier": 3.14, # Optional. Value representing the multiplier used to compute the energy when using this serving instead of the default serving. + }, + ], + "totalCarbohydrate": { # Represents the weight quantity. # Optional. Value representing the total carbohydrate of the food for the default serving. + "grams": 3.14, # Required. Value representing the weight in grams. + "userProvidedUnit": "A String", # Optional. Value representing the user provided unit. + }, + "totalFat": { # Represents the weight quantity. # Optional. Value representing the total fat of the food for the default serving. + "grams": 3.14, # Required. Value representing the weight in grams. + "userProvidedUnit": "A String", # Optional. Value representing the user provided unit. + }, + }, + "foodMeasurementUnit": { # Represents a food measurement unit. # Optional. The food measurement unit details. + "displayName": "A String", # Required. The display name of the food measurement unit (e.g., "gram", "piece"). + "pluralDisplayName": "A String", # Optional. The plural display name of the food measurement unit (e.g., "grams", "pieces"). + }, "heartRate": { # A heart rate measurement. # Optional. Data for points in the `heart-rate` sample data type collection. "beatsPerMinute": "A String", # Required. The heart rate value in beats per minute. "metadata": { # Heart rate metadata. # Optional. Metadata about the heart rate sample. @@ -1993,7 +2578,170 @@

Method Details

"startUtcOffset": "A String", # Required. The offset of the user's local time at the start of the session relative to the Coordinated Universal Time (UTC). }, }, + "irregularRhythmNotification": { # Represents an Irregular Rhythm Notification alert, indicating a potential sign of atrial fibrillation (AFib). This data type is based on SaMD feature and any changes to it may require additional review. # Optional. Data for points in the `irregular-rhythm-notification` session data type collection. + "alertWindows": [ # Optional. The overlapping analysis windows that were used to evaluate rhythm for potential AFib, containing specific information about the user's heart rhythm. + { # An analysis window evaluated for AFib. Note: The current version of the algorithm will only produce alerts if all windows are positive. So anything returned from the API will always have the positive bit set to true. Internally, windows can be negative, however. We never save "inconclusive" windows (they aren't produced by the algorithm). + "civilEndTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. Observed interval end time in civil time in the timezone the subject is in at the end of the observed interval + "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date. + "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. + "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. + "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. + }, + "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted. + "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. + "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59. + "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999. + "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds. + }, + }, + "civilStartTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. Observed interval start time in civil time in the timezone the subject is in at the start of the observed interval + "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date. + "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. + "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. + "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. + }, + "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted. + "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. + "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59. + "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999. + "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds. + }, + }, + "endTime": "A String", # Required. The end time of the analysis window. + "endUtcOffset": "A String", # Required. The UTC offset of the user's timezone when the analysis window ended. + "heartBeats": [ # Optional. All heart beats in the interval contained in this analysis window. + { # A single heart beat measurement. + "beatsPerMinute": 42, # Required. The beats-per-minute value extrapolated from the time before the following heart beat. This is calculated as 60000 / rr, where rr is the gap between heart beats in milliseconds (IBI - Interbeat Interval). + "civilTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. The civil time in the timezone the subject is in at the time of the observation. + "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date. + "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. + "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. + "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. + }, + "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted. + "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. + "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59. + "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999. + "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds. + }, + }, + "physicalTime": "A String", # Required. The time of the heart beat measurement. + "utcOffset": "A String", # Required. The UTC offset of the user's timezone when the heart beat measurement occurred. + }, + ], + "positive": True or False, # Optional. Flag indicating whether the window was positive for AFib or not. A `true` value indicates that AFib was detected in this window. A `false` value means AFib was not detected, but does not guarantee the absence of AFib. + "startTime": "A String", # Required. Observed interval. The start time of the analysis window. + "startUtcOffset": "A String", # Required. The UTC offset of the user's timezone when the analysis window started. + }, + ], + "interval": { # Represents a time interval of session data point, which bundles multiple observed metrics together. # Required. Observed interval. + "civilEndTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. Session end time in civil time in the timezone the subject is in at the end of the session. + "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date. + "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. + "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. + "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. + }, + "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted. + "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. + "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59. + "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999. + "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds. + }, + }, + "civilStartTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. Session start time in civil time in the timezone the subject is in at the start of the session. + "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date. + "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. + "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. + "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. + }, + "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted. + "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. + "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59. + "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999. + "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds. + }, + }, + "endTime": "A String", # Required. The end time of the observed session. + "endUtcOffset": "A String", # Required. The offset of the user's local time at the end of the session relative to the Coordinated Universal Time (UTC). + "startTime": "A String", # Required. The start time of the observed session. + "startUtcOffset": "A String", # Required. The offset of the user's local time at the start of the session relative to the Coordinated Universal Time (UTC). + }, + "medicalDeviceInfo": { # Software as Medical Device (SaMD) metadata. Used to construct the Unique Device Identifier (UDI). # Output only. The meta information for the compatible device used to conduct the measurement. Irregular Rhythm Notification measurements typically populate `algorithm_version`, `service_version`, and `device_model`. + "algorithmVersion": "A String", # Output only. The algorithm version used by the feature. + "deviceModel": "A String", # Output only. The model name or device type of the compatible device used to collect the data. + "featureVersion": "A String", # Output only. The version of the feature/app running on the device. + "firmwareVersion": "A String", # Output only. The firmware version running on the compatible device used to collect the data. + "serviceVersion": "A String", # Output only. The service version used by the feature. + }, + }, "name": "A String", # Identifier. Data point name, only supported for the subset of identifiable data types. For the majority of the data types, individual data points do not need to be identified and this field would be empty. Format: `users/{user}/dataTypes/{data_type}/dataPoints/{data_point}` Example: `users/abcd1234/dataTypes/sleep/dataPoints/a1b2c3d4-e5f6-7890-1234-567890abcdef` The `{user}` ID is a system-generated identifier, as described in Identity.health_user_id. The `{data_type}` ID corresponds to the kebab-case version of the field names in the DataPoint data union field, e.g. `total-calories` for the `total_calories` field. The `{data_point}` ID can be client-provided or system-generated. If client-provided, it must be a string of 4-63 characters, containing only lowercase letters, numbers, and hyphens. + "nutritionLog": { # Holds information about a user logged food. There are two ways of creating a nutrition log based on the food type: 1. Identified food: Using the food field, which is a reference to a Food resource. In this case fields `nutrients`, `energy`, `energy_from_fat`, `total_carbohydrate`, `total_fat`, `food_display_name` will be populated based on the referenced food. 2. Anonymous food: Using the `food_display_name` field and setting the `nutrients`, `energy`, `energy_from_fat`, `total_carbohydrate`, `total_fat` fields manually. The identified food is preferred over the anonymous food. Nutrition logs created from anonymous food are not be editable. # Optional. Data for points in the `nutrition-log` session data type collection. + "energy": { # Represents the energy quantity. # Optional. Value representing the energy of the nutrition log. For nutrition logs created from an identified food, this field will be populated based on the referenced food. For anonymous food, this field will be populated manually. + "kcal": 3.14, # Required. Value representing the energy in kilocalories. + "userProvidedUnit": "A String", # Optional. Value representing the user provided unit. + }, + "energyFromFat": { # Represents the energy quantity. # Optional. Value representing the energy from fat of the nutrition log. For nutrition logs created from an identified food, this field will be populated based on the referenced food. For anonymous food, this field will be populated manually. + "kcal": 3.14, # Required. Value representing the energy in kilocalories. + "userProvidedUnit": "A String", # Optional. Value representing the user provided unit. + }, + "food": "A String", # Required. Represents the food ID. + "foodDisplayName": "A String", # Value representing the display name of the food. For nutrition logs created from an identified food, this field will be populated based on the referenced food. For anonymous food, this field will be populated manually. + "interval": { # Represents a time interval of session data point, which bundles multiple observed metrics together. # Required. Observed interval. + "civilEndTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. Session end time in civil time in the timezone the subject is in at the end of the session. + "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date. + "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. + "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. + "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. + }, + "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted. + "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. + "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59. + "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999. + "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds. + }, + }, + "civilStartTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. Session start time in civil time in the timezone the subject is in at the start of the session. + "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date. + "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. + "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. + "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. + }, + "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted. + "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. + "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59. + "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999. + "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds. + }, + }, + "endTime": "A String", # Required. The end time of the observed session. + "endUtcOffset": "A String", # Required. The offset of the user's local time at the end of the session relative to the Coordinated Universal Time (UTC). + "startTime": "A String", # Required. The start time of the observed session. + "startUtcOffset": "A String", # Required. The offset of the user's local time at the start of the session relative to the Coordinated Universal Time (UTC). + }, + "mealType": "A String", # Optional. Value representing the meal type of the nutrition log. + "nutrients": [ # Optional. Value representing the nutrients of the nutrition log. + { # Represents the quantity of a nutrient. + "nutrient": "A String", # Required. Value representing the nutrient. + "quantity": { # Represents the weight quantity. # Required. Value representing the quantity of the nutrient. + "grams": 3.14, # Required. Value representing the weight in grams. + "userProvidedUnit": "A String", # Optional. Value representing the user provided unit. + }, + }, + ], + "serving": { # Represents different properties and information about the serving of a specific food. # Optional. Value representing the nutrition log serving. + "amount": 3.14, # Optional. Amount of food consumed, fractional values are supported. + "foodMeasurementUnit": "A String", # Required. Food measurement unit + "foodMeasurementUnitDisplayName": "A String", # Output only. Legacy measurement unit for serving size in singular form (e.g. "piece", "gram"). + }, + "totalCarbohydrate": { # Represents the weight quantity. # Optional. Value representing the total carbohydrate of the nutrition log. For nutrition logs created from an identified food, this field will be populated based on the referenced food. For anonymous food, this field will be populated manually. + "grams": 3.14, # Required. Value representing the weight in grams. + "userProvidedUnit": "A String", # Optional. Value representing the user provided unit. + }, + "totalFat": { # Represents the weight quantity. # Optional. Value representing the total fat of the nutrition log. For nutrition logs created from an identified food, this field will be populated based on the referenced food. For anonymous food, this field will be populated manually. + "grams": 3.14, # Required. Value representing the weight in grams. + "userProvidedUnit": "A String", # Optional. Value representing the user provided unit. + }, + }, "oxygenSaturation": { # Captures the user's instantaneous oxygen saturation percentage (SpO2). # Optional. Data for points in the `oxygen-saturation` sample data type collection. "percentage": 3.14, # Required. The oxygen saturation percentage. Valid values are from 0 to 100. "sampleTime": { # Represents a sample time of an observed data point. # Required. The time at which oxygen saturation was measured. @@ -2341,7 +3089,7 @@

Method Details

Args: parent: string, Required. Parent data type of the Data Point collection. Format: `users/me/dataTypes/{data_type}`, e.g.: - `users/me/dataTypes/steps` - `users/me/dataTypes/weight` For a list of the supported data types see the DataPoint data union field. (required) - filter: string, Optional. Filter expression following https://google.aip.dev/160. A time range (either physical or civil) can be specified. The supported filter fields are: - Interval start time: - Pattern: `{interval_data_type}.interval.start_time` - Supported comparison operators: `>=`, `<` - Timestamp literal expected in RFC-3339 format - Supported logical operators: `AND` - Example: - `steps.interval.start_time >= "2023-11-24T00:00:00Z" AND steps.interval.start_time < "2023-11-25T00:00:00Z"` - `distance.interval.start_time >= "2024-08-14T12:34:56Z"` - Interval civil start time: - Pattern: `{interval_data_type}.interval.civil_start_time` - Supported comparison operators: `>=`, `<` - Date with optional time literal expected in ISO 8601 `YYYY-MM-DD[THH:mm:ss]` format - Supported logical operators: `AND` - Example: - `steps.interval.civil_start_time >= "2023-11-24" AND steps.interval.civil_start_time < "2023-11-25"` - `distance.interval.civil_start_time >= "2024-08-14T12:34:56"` - Sample observation physical time: - Pattern: `{sample_data_type}.sample_time.physical_time` - Supported comparison operators: `>=`, `<` - Timestamp literal expected in RFC-3339 format - Supported logical operators: `AND` - Example: - `weight.sample_time.physical_time >= "2023-11-24T00:00:00Z" AND weight.sample_time.physical_time < "2023-11-25T00:00:00Z"` - `weight.sample_time.physical_time >= "2024-08-14T12:34:56Z"` - Sample observation civil time: - Pattern: `{sample_data_type}.sample_time.civil_time` - Supported comparison operators: `>=`, `<` - Date with optional time literal expected in ISO 8601 `YYYY-MM-DD[THH:mm:ss]` format - Supported logical operators: `AND` - Example: - `weight.sample_time.civil_time >= "2023-11-24" AND weight.sample_time.civil_time < "2023-11-25"` - `weight.sample_time.civil_time >= "2024-08-14T12:34:56"` - Daily summary date: - Pattern: `{daily_summary_data_type}.date` - Supported comparison operators: `>=`, `<` - Date literal expected in ISO 8601 `YYYY-MM-DD` format - Supported logical operators: `AND` - Example: - `daily_heart_rate_variability.date < "2024-08-15"` - Session start time (**ECG specific**): - Pattern: `electrocardiogram.interval.start_time` - Supported comparison operators: `>=` - Timestamp literal expected in RFC-3339 format - Example: - `electrocardiogram.interval.start_time >= "2024-08-14T12:34:56Z"` - Note: Only filtering by start time is supported for ECG. Filtering by end time (e.g., `electrocardiogram.interval.end_time`) is not supported. - Session civil start time (**Excluding Sleep**): - Pattern: `{session_data_type}.interval.civil_start_time` - Supported comparison operators: `>=`, `<` - Date with optional time literal expected in ISO 8601 `YYYY-MM-DD[THH:mm:ss]` format - Supported logical operators: `AND` - Example: - `exercise.interval.civil_start_time >= "2023-11-24" AND exercise.interval.civil_start_time < "2023-11-25"` - `exercise.interval.civil_start_time >= "2024-08-14T12:34:56"` - Session end time (**Sleep specific**): - Pattern: `sleep.interval.end_time` - Supported comparison operators: `>=`, `<` - Timestamp literal expected in RFC-3339 format - Supported logical operators: `AND`, `OR` - Example: - `sleep.interval.end_time >= "2023-11-24T00:00:00Z" AND sleep.interval.end_time < "2023-11-25T00:00:00Z"` - Session civil end time (**Sleep specific**): - Pattern: `sleep.interval.civil_end_time` - Supported comparison operators: `>=`, `<` - Date with optional time literal expected in ISO 8601 `YYYY-MM-DD[THH:mm:ss]` format - Supported logical operators: `AND`, `OR` - Example: - `sleep.interval.civil_end_time >= "2023-11-24" AND sleep.interval.civil_end_time < "2023-11-25"` Data points in the response will be ordered by the interval start time in descending order. + filter: string, Optional. Filter expression following https://google.aip.dev/160. A time range (either physical or civil) can be specified. The supported filter fields are: - Interval start time: - Pattern: `{interval_data_type}.interval.start_time` - Supported comparison operators: `>=`, `<` - Timestamp literal expected in RFC-3339 format - Supported logical operators: `AND` - Example: - `steps.interval.start_time >= "2023-11-24T00:00:00Z" AND steps.interval.start_time < "2023-11-25T00:00:00Z"` - `distance.interval.start_time >= "2024-08-14T12:34:56Z"` - Interval civil start time: - Pattern: `{interval_data_type}.interval.civil_start_time` - Supported comparison operators: `>=`, `<` - Date with optional time literal expected in ISO 8601 `YYYY-MM-DD[THH:mm:ss]` format - Supported logical operators: `AND` - Example: - `steps.interval.civil_start_time >= "2023-11-24" AND steps.interval.civil_start_time < "2023-11-25"` - `distance.interval.civil_start_time >= "2024-08-14T12:34:56"` - Sample observation physical time: - Pattern: `{sample_data_type}.sample_time.physical_time` - Supported comparison operators: `>=`, `<` - Timestamp literal expected in RFC-3339 format - Supported logical operators: `AND` - Example: - `weight.sample_time.physical_time >= "2023-11-24T00:00:00Z" AND weight.sample_time.physical_time < "2023-11-25T00:00:00Z"` - `weight.sample_time.physical_time >= "2024-08-14T12:34:56Z"` - Sample observation civil time: - Pattern: `{sample_data_type}.sample_time.civil_time` - Supported comparison operators: `>=`, `<` - Date with optional time literal expected in ISO 8601 `YYYY-MM-DD[THH:mm:ss]` format - Supported logical operators: `AND` - Example: - `weight.sample_time.civil_time >= "2023-11-24" AND weight.sample_time.civil_time < "2023-11-25"` - `weight.sample_time.civil_time >= "2024-08-14T12:34:56"` - Daily summary date: - Pattern: `{daily_summary_data_type}.date` - Supported comparison operators: `>=`, `<` - Date literal expected in ISO 8601 `YYYY-MM-DD` format - Supported logical operators: `AND` - Example: - `daily_heart_rate_variability.date < "2024-08-15"` - Session civil start time (**Excluding Sleep and ECG**): - Pattern: `{session_data_type}.interval.civil_start_time` - Supported comparison operators: `>=`, `<` - Date with optional time literal expected in ISO 8601 `YYYY-MM-DD[THH:mm:ss]` format - Supported logical operators: `AND` - Example: - `exercise.interval.civil_start_time >= "2023-11-24" AND exercise.interval.civil_start_time < "2023-11-25"` - `exercise.interval.civil_start_time >= "2024-08-14T12:34:56"` - Session start time (**ECG specific**): - Pattern: `electrocardiogram.interval.start_time` - Supported comparison operators: `>=` - Timestamp literal expected in RFC-3339 format - Example: - `electrocardiogram.interval.start_time >= "2024-08-14T12:34:56Z"` - Note: Only filtering by start time is supported for ECG. Filtering by end time (e.g., `electrocardiogram.interval.end_time`) is not supported. - Session end time (**Sleep specific**): - Pattern: `sleep.interval.end_time` - Supported comparison operators: `>=`, `<` - Timestamp literal expected in RFC-3339 format - Supported logical operators: `AND`, `OR` - Example: - `sleep.interval.end_time >= "2023-11-24T00:00:00Z" AND sleep.interval.end_time < "2023-11-25T00:00:00Z"` - Session civil end time (**Sleep specific**): - Pattern: `sleep.interval.civil_end_time` - Supported comparison operators: `>=`, `<` - Date with optional time literal expected in ISO 8601 `YYYY-MM-DD[THH:mm:ss]` format - Supported logical operators: `AND`, `OR` - Example: - `sleep.interval.civil_end_time >= "2023-11-24" AND sleep.interval.civil_end_time < "2023-11-25"` Data points in the response will be ordered by the interval start time in descending order. pageSize: integer, Optional. The maximum number of data points to return. If unspecified, at most 1440 data points will be returned. The maximum page size is 10000; values above that will be truncated accordingly. For `exercise` and `sleep` the default page size is 25. The maximum page size for `exercise` and `sleep` is 25. pageToken: string, Optional. The `next_page_token` from a previous request, if any. x__xgafv: string, V1 error format. @@ -2355,6 +3103,41 @@

Method Details

{ # Response containing raw data points matching the query "dataPoints": [ # Data points matching the query { # A computed or recorded metric. + "activeEnergyBurned": { # Energy burned as part of an activity, excluding the basal energy burn. # Optional. Data for points in the `active-energy-burned` interval data type collection. + "interval": { # Represents a time interval of an observed data point. # Required. Observed interval + "civilEndTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. Observed interval end time in civil time in the timezone the subject is in at the end of the observed interval + "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date. + "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. + "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. + "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. + }, + "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted. + "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. + "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59. + "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999. + "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds. + }, + }, + "civilStartTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. Observed interval start time in civil time in the timezone the subject is in at the start of the observed interval + "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date. + "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. + "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. + "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. + }, + "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted. + "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. + "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59. + "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999. + "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds. + }, + }, + "endTime": "A String", # Required. Observed interval end time. + "endUtcOffset": "A String", # Required. The offset of the user's local time at the end of the observation relative to the Coordinated Universal Time (UTC). + "startTime": "A String", # Required. Observed interval start time. + "startUtcOffset": "A String", # Required. The offset of the user's local time at the start of the observation relative to the Coordinated Universal Time (UTC). + }, + "kcal": 3.14, # Required. Energy burned during an activity, measured in kilocalories. + }, "activeMinutes": { # Record of active minutes in a given time interval. # Optional. Data for points in the `active-minutes` interval data type collection. "activeMinutesByActivityLevel": [ # Required. Active minutes by activity level. At most one record per activity level is allowed. { # Active minutes at a given activity level. @@ -2536,6 +3319,31 @@

Method Details

}, "kcal": 3.14, # Required. Number of calories burned due to basal metabolic rate in kilocalories over the observed interval. }, + "bloodGlucose": { # Represents a blood glucose level measurement. LINT: LEGACY_NAMES # Optional. Data for points in the `blood-glucose` sample data type collection. + "bloodGlucoseMilligramsPerDeciliter": 3.14, # Required. Blood glucose level concentration in mg/dL. + "mealType": "A String", # Optional. Meal type of the measurement. + "measurementSource": "A String", # Optional. Source of the measurement. + "measurementTiming": "A String", # Optional. Timing of the measurement. + "notes": "A String", # Optional. Standard free-form notes captured at manual logging. + "sampleTime": { # Represents a sample time of an observed data point. # Required. The time at which blood glucose was measured. + "civilTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. The civil time in the timezone the subject is in at the time of the observation. + "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date. + "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. + "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. + "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. + }, + "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted. + "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. + "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59. + "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999. + "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds. + }, + }, + "physicalTime": "A String", # Required. The time of the observation. + "utcOffset": "A String", # Required. The offset of the user's local time during the observation relative to the Coordinated Universal Time (UTC). + }, + "specimen": "A String", # Optional. Type of body fluid used to measure the blood glucose. + }, "bodyFat": { # Body fat measurement. # Optional. Data for points in the `body-fat` sample data type collection. "percentage": 3.14, # Required. Body fat percentage, in range [0, 100]. "sampleTime": { # Represents a sample time of an observed data point. # Required. The time at which body fat was measured. @@ -2556,6 +3364,28 @@

Method Details

"utcOffset": "A String", # Required. The offset of the user's local time during the observation relative to the Coordinated Universal Time (UTC). }, }, + "coreBodyTemperature": { # Core body temperature measurement, distinct from peripheral body temperature, reflects the temperature of the body's internal organs. # Optional. Data for points in the `core-body-temperature` sample data type collection. + "id": "A String", # Optional. The unique identifier of the core body temperature measurement. + "measurementLocation": "A String", # Optional. The location of the core body temperature measurement. + "sampleTime": { # Represents a sample time of an observed data point. # Required. The time at which core body temperature was measured. + "civilTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. The civil time in the timezone the subject is in at the time of the observation. + "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date. + "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. + "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. + "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. + }, + "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted. + "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. + "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59. + "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999. + "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds. + }, + }, + "physicalTime": "A String", # Required. The time of the observation. + "utcOffset": "A String", # Required. The offset of the user's local time during the observation relative to the Coordinated Universal Time (UTC). + }, + "temperatureCelsius": 3.14, # Required. The core body temperature in Celsius. + }, "dailyHeartRateVariability": { # Represents the daily heart rate variability data type. At least one of the following fields must be set: - `average_heart_rate_variability_milliseconds` - `non_rem_heart_rate_beats_per_minute` - `entropy` - `deep_sleep_root_mean_square_of_successive_differences_milliseconds` # Optional. Data for points in the `daily-heart-rate-variability` daily data type collection. "averageHeartRateVariabilityMilliseconds": 3.14, # Optional. A user's average heart rate variability calculated using the root mean square of successive differences (RMSSD) in times between heartbeats. "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Date (in the user's timezone) of heart rate variability measurement. @@ -2681,6 +3511,55 @@

Method Details

}, "millimeters": "A String", # Required. Distance in millimeters over the observed interval. }, + "electrocardiogram": { # Represents an Electrocardiogram (ECG) measurement session. This data type is based on SaMD feature and any changes to it may require additional review. # Optional. Data for points in the `electrocardiogram` session data type collection. + "beatsPerMinuteAvg": "A String", # Optional. Average heart rate recorded during ECG reading in beats per minute. + "interval": { # Represents a time interval of session data point, which bundles multiple observed metrics together. # Required. Observed interval. NOTE: Historical ECG data lacks timezone offsets, so `start_utc_offset` and `end_utc_offset` will be missing or default to zero. As a result, the civil time fields within this interval will default to UTC. It is recommended to use physical time fields instead for accurate time referencing. NOTE: The `start_time` and `end_time` of the interval are equal, representing the reading time. + "civilEndTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. Session end time in civil time in the timezone the subject is in at the end of the session. + "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date. + "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. + "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. + "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. + }, + "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted. + "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. + "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59. + "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999. + "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds. + }, + }, + "civilStartTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. Session start time in civil time in the timezone the subject is in at the start of the session. + "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date. + "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. + "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. + "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. + }, + "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted. + "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. + "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59. + "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999. + "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds. + }, + }, + "endTime": "A String", # Required. The end time of the observed session. + "endUtcOffset": "A String", # Required. The offset of the user's local time at the end of the session relative to the Coordinated Universal Time (UTC). + "startTime": "A String", # Required. The start time of the observed session. + "startUtcOffset": "A String", # Required. The offset of the user's local time at the start of the session relative to the Coordinated Universal Time (UTC). + }, + "leadNumber": 42, # Optional. The number of leads used for ECG reading. + "medicalDeviceInfo": { # Software as Medical Device (SaMD) metadata. Used to construct the Unique Device Identifier (UDI). # Output only. The meta information for the compatible device used to conduct the measurement. ECG measurements typically populate `firmware_version`, `feature_version`, and `device_model`. + "algorithmVersion": "A String", # Output only. The algorithm version used by the feature. + "deviceModel": "A String", # Output only. The model name or device type of the compatible device used to collect the data. + "featureVersion": "A String", # Output only. The version of the feature/app running on the device. + "firmwareVersion": "A String", # Output only. The firmware version running on the compatible device used to collect the data. + "serviceVersion": "A String", # Output only. The service version used by the feature. + }, + "millivoltsScalingFactor": 42, # Optional. The factor by which to divide waveform samples to get voltage in millivolts: millivolts = waveform_sample / millivolts_scaling_factor. + "resultClassification": "A String", # Optional. The result classification of the ECG reading. + "samplingFrequencyHertz": 42, # Optional. The sampling frequency of waveform samples in hertz. + "waveformSamples": [ # Optional. An array of voltage values representing lead I ECG values. Each sample represents voltage difference in ECG graph. The first value in array corresponds to the start of the reading. + 42, + ], + }, "exercise": { # An exercise that stores information about a physical activity. # Optional. Data for points in the `exercise` session data type collection. "activeDuration": "A String", # Optional. Duration excluding pauses. "createTime": "A String", # Output only. Represents the timestamp of the creation of the exercise. @@ -2862,6 +3741,67 @@

Method Details

"startUtcOffset": "A String", # Required. The offset of the user's local time at the start of the observation relative to the Coordinated Universal Time (UTC). }, }, + "food": { # Represents a food item. # Optional. The food details. + "accessLevel": "A String", # Required. The access level of the food. + "brand": "A String", # Optional. The brand of the food. + "defaultServing": { # Represents different properties and information about the serving of a specific food. # Required. Value representing the default serving of the food. + "amount": 3.14, # Optional. Amount of food consumed, fractional values are supported. + "foodMeasurementUnit": "A String", # Required. Food measurement unit + "foodMeasurementUnitDisplayName": "A String", # Output only. Legacy measurement unit for serving size in singular form (e.g. "piece", "gram"). + "foodMeasurementUnitDisplayNamePlural": "A String", # Output only. Legacy measurement unit for serving size in plural form (e.g. "pieces", "grams"). + "multiplier": 3.14, # Optional. Value representing the multiplier used to compute the energy when using this serving instead of the default serving. + }, + "description": "A String", # Optional. The description of the food. + "displayName": "A String", # Required. The display name of the food. + "energyAvg": { # Represents the energy quantity. # Optional. Value representing the average energy of the food for the default serving. + "kcal": 3.14, # Required. Value representing the energy in kilocalories. + "userProvidedUnit": "A String", # Optional. Value representing the user provided unit. + }, + "energyFromFat": { # Represents the energy quantity. # Optional. Value representing the energy from fat of the food for the default serving. + "kcal": 3.14, # Required. Value representing the energy in kilocalories. + "userProvidedUnit": "A String", # Optional. Value representing the user provided unit. + }, + "energyMax": { # Represents the energy quantity. # Optional. Value representing the maximum energy of the food for the default serving. + "kcal": 3.14, # Required. Value representing the energy in kilocalories. + "userProvidedUnit": "A String", # Optional. Value representing the user provided unit. + }, + "energyMin": { # Represents the energy quantity. # Optional. Value representing the minimum energy of the food for the default serving. + "kcal": 3.14, # Required. Value representing the energy in kilocalories. + "userProvidedUnit": "A String", # Optional. Value representing the user provided unit. + }, + "languageCode": "A String", # Optional. The language code where the food is available in format xx-XX. Supported values are defined in Settings.food_language_code. + "mealType": "A String", # Optional. The meal type associated with this food. + "nutrients": [ # Optional. Value representing the nutrients of the food for the default serving. + { # Represents the quantity of a nutrient. + "nutrient": "A String", # Required. Value representing the nutrient. + "quantity": { # Represents the weight quantity. # Required. Value representing the quantity of the nutrient. + "grams": 3.14, # Required. Value representing the weight in grams. + "userProvidedUnit": "A String", # Optional. Value representing the user provided unit. + }, + }, + ], + "servings": [ # Optional. The serving of the food. + { # Represents different properties and information about the serving of a specific food. + "amount": 3.14, # Optional. Amount of food consumed, fractional values are supported. + "foodMeasurementUnit": "A String", # Required. Food measurement unit + "foodMeasurementUnitDisplayName": "A String", # Output only. Legacy measurement unit for serving size in singular form (e.g. "piece", "gram"). + "foodMeasurementUnitDisplayNamePlural": "A String", # Output only. Legacy measurement unit for serving size in plural form (e.g. "pieces", "grams"). + "multiplier": 3.14, # Optional. Value representing the multiplier used to compute the energy when using this serving instead of the default serving. + }, + ], + "totalCarbohydrate": { # Represents the weight quantity. # Optional. Value representing the total carbohydrate of the food for the default serving. + "grams": 3.14, # Required. Value representing the weight in grams. + "userProvidedUnit": "A String", # Optional. Value representing the user provided unit. + }, + "totalFat": { # Represents the weight quantity. # Optional. Value representing the total fat of the food for the default serving. + "grams": 3.14, # Required. Value representing the weight in grams. + "userProvidedUnit": "A String", # Optional. Value representing the user provided unit. + }, + }, + "foodMeasurementUnit": { # Represents a food measurement unit. # Optional. The food measurement unit details. + "displayName": "A String", # Required. The display name of the food measurement unit (e.g., "gram", "piece"). + "pluralDisplayName": "A String", # Optional. The plural display name of the food measurement unit (e.g., "grams", "pieces"). + }, "heartRate": { # A heart rate measurement. # Optional. Data for points in the `heart-rate` sample data type collection. "beatsPerMinute": "A String", # Required. The heart rate value in beats per minute. "metadata": { # Heart rate metadata. # Optional. Metadata about the heart rate sample. @@ -2965,7 +3905,170 @@

Method Details

"startUtcOffset": "A String", # Required. The offset of the user's local time at the start of the session relative to the Coordinated Universal Time (UTC). }, }, + "irregularRhythmNotification": { # Represents an Irregular Rhythm Notification alert, indicating a potential sign of atrial fibrillation (AFib). This data type is based on SaMD feature and any changes to it may require additional review. # Optional. Data for points in the `irregular-rhythm-notification` session data type collection. + "alertWindows": [ # Optional. The overlapping analysis windows that were used to evaluate rhythm for potential AFib, containing specific information about the user's heart rhythm. + { # An analysis window evaluated for AFib. Note: The current version of the algorithm will only produce alerts if all windows are positive. So anything returned from the API will always have the positive bit set to true. Internally, windows can be negative, however. We never save "inconclusive" windows (they aren't produced by the algorithm). + "civilEndTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. Observed interval end time in civil time in the timezone the subject is in at the end of the observed interval + "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date. + "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. + "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. + "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. + }, + "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted. + "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. + "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59. + "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999. + "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds. + }, + }, + "civilStartTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. Observed interval start time in civil time in the timezone the subject is in at the start of the observed interval + "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date. + "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. + "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. + "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. + }, + "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted. + "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. + "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59. + "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999. + "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds. + }, + }, + "endTime": "A String", # Required. The end time of the analysis window. + "endUtcOffset": "A String", # Required. The UTC offset of the user's timezone when the analysis window ended. + "heartBeats": [ # Optional. All heart beats in the interval contained in this analysis window. + { # A single heart beat measurement. + "beatsPerMinute": 42, # Required. The beats-per-minute value extrapolated from the time before the following heart beat. This is calculated as 60000 / rr, where rr is the gap between heart beats in milliseconds (IBI - Interbeat Interval). + "civilTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. The civil time in the timezone the subject is in at the time of the observation. + "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date. + "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. + "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. + "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. + }, + "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted. + "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. + "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59. + "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999. + "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds. + }, + }, + "physicalTime": "A String", # Required. The time of the heart beat measurement. + "utcOffset": "A String", # Required. The UTC offset of the user's timezone when the heart beat measurement occurred. + }, + ], + "positive": True or False, # Optional. Flag indicating whether the window was positive for AFib or not. A `true` value indicates that AFib was detected in this window. A `false` value means AFib was not detected, but does not guarantee the absence of AFib. + "startTime": "A String", # Required. Observed interval. The start time of the analysis window. + "startUtcOffset": "A String", # Required. The UTC offset of the user's timezone when the analysis window started. + }, + ], + "interval": { # Represents a time interval of session data point, which bundles multiple observed metrics together. # Required. Observed interval. + "civilEndTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. Session end time in civil time in the timezone the subject is in at the end of the session. + "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date. + "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. + "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. + "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. + }, + "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted. + "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. + "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59. + "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999. + "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds. + }, + }, + "civilStartTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. Session start time in civil time in the timezone the subject is in at the start of the session. + "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date. + "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. + "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. + "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. + }, + "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted. + "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. + "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59. + "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999. + "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds. + }, + }, + "endTime": "A String", # Required. The end time of the observed session. + "endUtcOffset": "A String", # Required. The offset of the user's local time at the end of the session relative to the Coordinated Universal Time (UTC). + "startTime": "A String", # Required. The start time of the observed session. + "startUtcOffset": "A String", # Required. The offset of the user's local time at the start of the session relative to the Coordinated Universal Time (UTC). + }, + "medicalDeviceInfo": { # Software as Medical Device (SaMD) metadata. Used to construct the Unique Device Identifier (UDI). # Output only. The meta information for the compatible device used to conduct the measurement. Irregular Rhythm Notification measurements typically populate `algorithm_version`, `service_version`, and `device_model`. + "algorithmVersion": "A String", # Output only. The algorithm version used by the feature. + "deviceModel": "A String", # Output only. The model name or device type of the compatible device used to collect the data. + "featureVersion": "A String", # Output only. The version of the feature/app running on the device. + "firmwareVersion": "A String", # Output only. The firmware version running on the compatible device used to collect the data. + "serviceVersion": "A String", # Output only. The service version used by the feature. + }, + }, "name": "A String", # Identifier. Data point name, only supported for the subset of identifiable data types. For the majority of the data types, individual data points do not need to be identified and this field would be empty. Format: `users/{user}/dataTypes/{data_type}/dataPoints/{data_point}` Example: `users/abcd1234/dataTypes/sleep/dataPoints/a1b2c3d4-e5f6-7890-1234-567890abcdef` The `{user}` ID is a system-generated identifier, as described in Identity.health_user_id. The `{data_type}` ID corresponds to the kebab-case version of the field names in the DataPoint data union field, e.g. `total-calories` for the `total_calories` field. The `{data_point}` ID can be client-provided or system-generated. If client-provided, it must be a string of 4-63 characters, containing only lowercase letters, numbers, and hyphens. + "nutritionLog": { # Holds information about a user logged food. There are two ways of creating a nutrition log based on the food type: 1. Identified food: Using the food field, which is a reference to a Food resource. In this case fields `nutrients`, `energy`, `energy_from_fat`, `total_carbohydrate`, `total_fat`, `food_display_name` will be populated based on the referenced food. 2. Anonymous food: Using the `food_display_name` field and setting the `nutrients`, `energy`, `energy_from_fat`, `total_carbohydrate`, `total_fat` fields manually. The identified food is preferred over the anonymous food. Nutrition logs created from anonymous food are not be editable. # Optional. Data for points in the `nutrition-log` session data type collection. + "energy": { # Represents the energy quantity. # Optional. Value representing the energy of the nutrition log. For nutrition logs created from an identified food, this field will be populated based on the referenced food. For anonymous food, this field will be populated manually. + "kcal": 3.14, # Required. Value representing the energy in kilocalories. + "userProvidedUnit": "A String", # Optional. Value representing the user provided unit. + }, + "energyFromFat": { # Represents the energy quantity. # Optional. Value representing the energy from fat of the nutrition log. For nutrition logs created from an identified food, this field will be populated based on the referenced food. For anonymous food, this field will be populated manually. + "kcal": 3.14, # Required. Value representing the energy in kilocalories. + "userProvidedUnit": "A String", # Optional. Value representing the user provided unit. + }, + "food": "A String", # Required. Represents the food ID. + "foodDisplayName": "A String", # Value representing the display name of the food. For nutrition logs created from an identified food, this field will be populated based on the referenced food. For anonymous food, this field will be populated manually. + "interval": { # Represents a time interval of session data point, which bundles multiple observed metrics together. # Required. Observed interval. + "civilEndTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. Session end time in civil time in the timezone the subject is in at the end of the session. + "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date. + "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. + "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. + "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. + }, + "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted. + "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. + "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59. + "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999. + "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds. + }, + }, + "civilStartTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. Session start time in civil time in the timezone the subject is in at the start of the session. + "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date. + "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. + "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. + "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. + }, + "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted. + "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. + "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59. + "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999. + "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds. + }, + }, + "endTime": "A String", # Required. The end time of the observed session. + "endUtcOffset": "A String", # Required. The offset of the user's local time at the end of the session relative to the Coordinated Universal Time (UTC). + "startTime": "A String", # Required. The start time of the observed session. + "startUtcOffset": "A String", # Required. The offset of the user's local time at the start of the session relative to the Coordinated Universal Time (UTC). + }, + "mealType": "A String", # Optional. Value representing the meal type of the nutrition log. + "nutrients": [ # Optional. Value representing the nutrients of the nutrition log. + { # Represents the quantity of a nutrient. + "nutrient": "A String", # Required. Value representing the nutrient. + "quantity": { # Represents the weight quantity. # Required. Value representing the quantity of the nutrient. + "grams": 3.14, # Required. Value representing the weight in grams. + "userProvidedUnit": "A String", # Optional. Value representing the user provided unit. + }, + }, + ], + "serving": { # Represents different properties and information about the serving of a specific food. # Optional. Value representing the nutrition log serving. + "amount": 3.14, # Optional. Amount of food consumed, fractional values are supported. + "foodMeasurementUnit": "A String", # Required. Food measurement unit + "foodMeasurementUnitDisplayName": "A String", # Output only. Legacy measurement unit for serving size in singular form (e.g. "piece", "gram"). + }, + "totalCarbohydrate": { # Represents the weight quantity. # Optional. Value representing the total carbohydrate of the nutrition log. For nutrition logs created from an identified food, this field will be populated based on the referenced food. For anonymous food, this field will be populated manually. + "grams": 3.14, # Required. Value representing the weight in grams. + "userProvidedUnit": "A String", # Optional. Value representing the user provided unit. + }, + "totalFat": { # Represents the weight quantity. # Optional. Value representing the total fat of the nutrition log. For nutrition logs created from an identified food, this field will be populated based on the referenced food. For anonymous food, this field will be populated manually. + "grams": 3.14, # Required. Value representing the weight in grams. + "userProvidedUnit": "A String", # Optional. Value representing the user provided unit. + }, + }, "oxygenSaturation": { # Captures the user's instantaneous oxygen saturation percentage (SpO2). # Optional. Data for points in the `oxygen-saturation` sample data type collection. "percentage": 3.14, # Required. The oxygen saturation percentage. Valid values are from 0 to 100. "sampleTime": { # Represents a sample time of an observed data point. # Required. The time at which oxygen saturation was measured. @@ -3334,6 +4437,41 @@

Method Details

The object takes the form of: { # A computed or recorded metric. + "activeEnergyBurned": { # Energy burned as part of an activity, excluding the basal energy burn. # Optional. Data for points in the `active-energy-burned` interval data type collection. + "interval": { # Represents a time interval of an observed data point. # Required. Observed interval + "civilEndTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. Observed interval end time in civil time in the timezone the subject is in at the end of the observed interval + "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date. + "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. + "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. + "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. + }, + "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted. + "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. + "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59. + "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999. + "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds. + }, + }, + "civilStartTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. Observed interval start time in civil time in the timezone the subject is in at the start of the observed interval + "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date. + "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. + "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. + "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. + }, + "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted. + "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. + "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59. + "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999. + "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds. + }, + }, + "endTime": "A String", # Required. Observed interval end time. + "endUtcOffset": "A String", # Required. The offset of the user's local time at the end of the observation relative to the Coordinated Universal Time (UTC). + "startTime": "A String", # Required. Observed interval start time. + "startUtcOffset": "A String", # Required. The offset of the user's local time at the start of the observation relative to the Coordinated Universal Time (UTC). + }, + "kcal": 3.14, # Required. Energy burned during an activity, measured in kilocalories. + }, "activeMinutes": { # Record of active minutes in a given time interval. # Optional. Data for points in the `active-minutes` interval data type collection. "activeMinutesByActivityLevel": [ # Required. Active minutes by activity level. At most one record per activity level is allowed. { # Active minutes at a given activity level. @@ -3515,6 +4653,31 @@

Method Details

}, "kcal": 3.14, # Required. Number of calories burned due to basal metabolic rate in kilocalories over the observed interval. }, + "bloodGlucose": { # Represents a blood glucose level measurement. LINT: LEGACY_NAMES # Optional. Data for points in the `blood-glucose` sample data type collection. + "bloodGlucoseMilligramsPerDeciliter": 3.14, # Required. Blood glucose level concentration in mg/dL. + "mealType": "A String", # Optional. Meal type of the measurement. + "measurementSource": "A String", # Optional. Source of the measurement. + "measurementTiming": "A String", # Optional. Timing of the measurement. + "notes": "A String", # Optional. Standard free-form notes captured at manual logging. + "sampleTime": { # Represents a sample time of an observed data point. # Required. The time at which blood glucose was measured. + "civilTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. The civil time in the timezone the subject is in at the time of the observation. + "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date. + "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. + "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. + "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. + }, + "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted. + "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. + "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59. + "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999. + "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds. + }, + }, + "physicalTime": "A String", # Required. The time of the observation. + "utcOffset": "A String", # Required. The offset of the user's local time during the observation relative to the Coordinated Universal Time (UTC). + }, + "specimen": "A String", # Optional. Type of body fluid used to measure the blood glucose. + }, "bodyFat": { # Body fat measurement. # Optional. Data for points in the `body-fat` sample data type collection. "percentage": 3.14, # Required. Body fat percentage, in range [0, 100]. "sampleTime": { # Represents a sample time of an observed data point. # Required. The time at which body fat was measured. @@ -3535,6 +4698,28 @@

Method Details

"utcOffset": "A String", # Required. The offset of the user's local time during the observation relative to the Coordinated Universal Time (UTC). }, }, + "coreBodyTemperature": { # Core body temperature measurement, distinct from peripheral body temperature, reflects the temperature of the body's internal organs. # Optional. Data for points in the `core-body-temperature` sample data type collection. + "id": "A String", # Optional. The unique identifier of the core body temperature measurement. + "measurementLocation": "A String", # Optional. The location of the core body temperature measurement. + "sampleTime": { # Represents a sample time of an observed data point. # Required. The time at which core body temperature was measured. + "civilTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. The civil time in the timezone the subject is in at the time of the observation. + "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date. + "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. + "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. + "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. + }, + "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted. + "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. + "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59. + "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999. + "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds. + }, + }, + "physicalTime": "A String", # Required. The time of the observation. + "utcOffset": "A String", # Required. The offset of the user's local time during the observation relative to the Coordinated Universal Time (UTC). + }, + "temperatureCelsius": 3.14, # Required. The core body temperature in Celsius. + }, "dailyHeartRateVariability": { # Represents the daily heart rate variability data type. At least one of the following fields must be set: - `average_heart_rate_variability_milliseconds` - `non_rem_heart_rate_beats_per_minute` - `entropy` - `deep_sleep_root_mean_square_of_successive_differences_milliseconds` # Optional. Data for points in the `daily-heart-rate-variability` daily data type collection. "averageHeartRateVariabilityMilliseconds": 3.14, # Optional. A user's average heart rate variability calculated using the root mean square of successive differences (RMSSD) in times between heartbeats. "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Date (in the user's timezone) of heart rate variability measurement. @@ -3660,6 +4845,55 @@

Method Details

}, "millimeters": "A String", # Required. Distance in millimeters over the observed interval. }, + "electrocardiogram": { # Represents an Electrocardiogram (ECG) measurement session. This data type is based on SaMD feature and any changes to it may require additional review. # Optional. Data for points in the `electrocardiogram` session data type collection. + "beatsPerMinuteAvg": "A String", # Optional. Average heart rate recorded during ECG reading in beats per minute. + "interval": { # Represents a time interval of session data point, which bundles multiple observed metrics together. # Required. Observed interval. NOTE: Historical ECG data lacks timezone offsets, so `start_utc_offset` and `end_utc_offset` will be missing or default to zero. As a result, the civil time fields within this interval will default to UTC. It is recommended to use physical time fields instead for accurate time referencing. NOTE: The `start_time` and `end_time` of the interval are equal, representing the reading time. + "civilEndTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. Session end time in civil time in the timezone the subject is in at the end of the session. + "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date. + "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. + "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. + "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. + }, + "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted. + "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. + "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59. + "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999. + "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds. + }, + }, + "civilStartTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. Session start time in civil time in the timezone the subject is in at the start of the session. + "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date. + "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. + "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. + "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. + }, + "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted. + "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. + "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59. + "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999. + "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds. + }, + }, + "endTime": "A String", # Required. The end time of the observed session. + "endUtcOffset": "A String", # Required. The offset of the user's local time at the end of the session relative to the Coordinated Universal Time (UTC). + "startTime": "A String", # Required. The start time of the observed session. + "startUtcOffset": "A String", # Required. The offset of the user's local time at the start of the session relative to the Coordinated Universal Time (UTC). + }, + "leadNumber": 42, # Optional. The number of leads used for ECG reading. + "medicalDeviceInfo": { # Software as Medical Device (SaMD) metadata. Used to construct the Unique Device Identifier (UDI). # Output only. The meta information for the compatible device used to conduct the measurement. ECG measurements typically populate `firmware_version`, `feature_version`, and `device_model`. + "algorithmVersion": "A String", # Output only. The algorithm version used by the feature. + "deviceModel": "A String", # Output only. The model name or device type of the compatible device used to collect the data. + "featureVersion": "A String", # Output only. The version of the feature/app running on the device. + "firmwareVersion": "A String", # Output only. The firmware version running on the compatible device used to collect the data. + "serviceVersion": "A String", # Output only. The service version used by the feature. + }, + "millivoltsScalingFactor": 42, # Optional. The factor by which to divide waveform samples to get voltage in millivolts: millivolts = waveform_sample / millivolts_scaling_factor. + "resultClassification": "A String", # Optional. The result classification of the ECG reading. + "samplingFrequencyHertz": 42, # Optional. The sampling frequency of waveform samples in hertz. + "waveformSamples": [ # Optional. An array of voltage values representing lead I ECG values. Each sample represents voltage difference in ECG graph. The first value in array corresponds to the start of the reading. + 42, + ], + }, "exercise": { # An exercise that stores information about a physical activity. # Optional. Data for points in the `exercise` session data type collection. "activeDuration": "A String", # Optional. Duration excluding pauses. "createTime": "A String", # Output only. Represents the timestamp of the creation of the exercise. @@ -3841,6 +5075,67 @@

Method Details

"startUtcOffset": "A String", # Required. The offset of the user's local time at the start of the observation relative to the Coordinated Universal Time (UTC). }, }, + "food": { # Represents a food item. # Optional. The food details. + "accessLevel": "A String", # Required. The access level of the food. + "brand": "A String", # Optional. The brand of the food. + "defaultServing": { # Represents different properties and information about the serving of a specific food. # Required. Value representing the default serving of the food. + "amount": 3.14, # Optional. Amount of food consumed, fractional values are supported. + "foodMeasurementUnit": "A String", # Required. Food measurement unit + "foodMeasurementUnitDisplayName": "A String", # Output only. Legacy measurement unit for serving size in singular form (e.g. "piece", "gram"). + "foodMeasurementUnitDisplayNamePlural": "A String", # Output only. Legacy measurement unit for serving size in plural form (e.g. "pieces", "grams"). + "multiplier": 3.14, # Optional. Value representing the multiplier used to compute the energy when using this serving instead of the default serving. + }, + "description": "A String", # Optional. The description of the food. + "displayName": "A String", # Required. The display name of the food. + "energyAvg": { # Represents the energy quantity. # Optional. Value representing the average energy of the food for the default serving. + "kcal": 3.14, # Required. Value representing the energy in kilocalories. + "userProvidedUnit": "A String", # Optional. Value representing the user provided unit. + }, + "energyFromFat": { # Represents the energy quantity. # Optional. Value representing the energy from fat of the food for the default serving. + "kcal": 3.14, # Required. Value representing the energy in kilocalories. + "userProvidedUnit": "A String", # Optional. Value representing the user provided unit. + }, + "energyMax": { # Represents the energy quantity. # Optional. Value representing the maximum energy of the food for the default serving. + "kcal": 3.14, # Required. Value representing the energy in kilocalories. + "userProvidedUnit": "A String", # Optional. Value representing the user provided unit. + }, + "energyMin": { # Represents the energy quantity. # Optional. Value representing the minimum energy of the food for the default serving. + "kcal": 3.14, # Required. Value representing the energy in kilocalories. + "userProvidedUnit": "A String", # Optional. Value representing the user provided unit. + }, + "languageCode": "A String", # Optional. The language code where the food is available in format xx-XX. Supported values are defined in Settings.food_language_code. + "mealType": "A String", # Optional. The meal type associated with this food. + "nutrients": [ # Optional. Value representing the nutrients of the food for the default serving. + { # Represents the quantity of a nutrient. + "nutrient": "A String", # Required. Value representing the nutrient. + "quantity": { # Represents the weight quantity. # Required. Value representing the quantity of the nutrient. + "grams": 3.14, # Required. Value representing the weight in grams. + "userProvidedUnit": "A String", # Optional. Value representing the user provided unit. + }, + }, + ], + "servings": [ # Optional. The serving of the food. + { # Represents different properties and information about the serving of a specific food. + "amount": 3.14, # Optional. Amount of food consumed, fractional values are supported. + "foodMeasurementUnit": "A String", # Required. Food measurement unit + "foodMeasurementUnitDisplayName": "A String", # Output only. Legacy measurement unit for serving size in singular form (e.g. "piece", "gram"). + "foodMeasurementUnitDisplayNamePlural": "A String", # Output only. Legacy measurement unit for serving size in plural form (e.g. "pieces", "grams"). + "multiplier": 3.14, # Optional. Value representing the multiplier used to compute the energy when using this serving instead of the default serving. + }, + ], + "totalCarbohydrate": { # Represents the weight quantity. # Optional. Value representing the total carbohydrate of the food for the default serving. + "grams": 3.14, # Required. Value representing the weight in grams. + "userProvidedUnit": "A String", # Optional. Value representing the user provided unit. + }, + "totalFat": { # Represents the weight quantity. # Optional. Value representing the total fat of the food for the default serving. + "grams": 3.14, # Required. Value representing the weight in grams. + "userProvidedUnit": "A String", # Optional. Value representing the user provided unit. + }, + }, + "foodMeasurementUnit": { # Represents a food measurement unit. # Optional. The food measurement unit details. + "displayName": "A String", # Required. The display name of the food measurement unit (e.g., "gram", "piece"). + "pluralDisplayName": "A String", # Optional. The plural display name of the food measurement unit (e.g., "grams", "pieces"). + }, "heartRate": { # A heart rate measurement. # Optional. Data for points in the `heart-rate` sample data type collection. "beatsPerMinute": "A String", # Required. The heart rate value in beats per minute. "metadata": { # Heart rate metadata. # Optional. Metadata about the heart rate sample. @@ -3944,7 +5239,170 @@

Method Details

"startUtcOffset": "A String", # Required. The offset of the user's local time at the start of the session relative to the Coordinated Universal Time (UTC). }, }, + "irregularRhythmNotification": { # Represents an Irregular Rhythm Notification alert, indicating a potential sign of atrial fibrillation (AFib). This data type is based on SaMD feature and any changes to it may require additional review. # Optional. Data for points in the `irregular-rhythm-notification` session data type collection. + "alertWindows": [ # Optional. The overlapping analysis windows that were used to evaluate rhythm for potential AFib, containing specific information about the user's heart rhythm. + { # An analysis window evaluated for AFib. Note: The current version of the algorithm will only produce alerts if all windows are positive. So anything returned from the API will always have the positive bit set to true. Internally, windows can be negative, however. We never save "inconclusive" windows (they aren't produced by the algorithm). + "civilEndTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. Observed interval end time in civil time in the timezone the subject is in at the end of the observed interval + "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date. + "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. + "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. + "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. + }, + "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted. + "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. + "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59. + "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999. + "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds. + }, + }, + "civilStartTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. Observed interval start time in civil time in the timezone the subject is in at the start of the observed interval + "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date. + "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. + "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. + "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. + }, + "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted. + "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. + "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59. + "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999. + "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds. + }, + }, + "endTime": "A String", # Required. The end time of the analysis window. + "endUtcOffset": "A String", # Required. The UTC offset of the user's timezone when the analysis window ended. + "heartBeats": [ # Optional. All heart beats in the interval contained in this analysis window. + { # A single heart beat measurement. + "beatsPerMinute": 42, # Required. The beats-per-minute value extrapolated from the time before the following heart beat. This is calculated as 60000 / rr, where rr is the gap between heart beats in milliseconds (IBI - Interbeat Interval). + "civilTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. The civil time in the timezone the subject is in at the time of the observation. + "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date. + "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. + "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. + "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. + }, + "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted. + "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. + "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59. + "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999. + "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds. + }, + }, + "physicalTime": "A String", # Required. The time of the heart beat measurement. + "utcOffset": "A String", # Required. The UTC offset of the user's timezone when the heart beat measurement occurred. + }, + ], + "positive": True or False, # Optional. Flag indicating whether the window was positive for AFib or not. A `true` value indicates that AFib was detected in this window. A `false` value means AFib was not detected, but does not guarantee the absence of AFib. + "startTime": "A String", # Required. Observed interval. The start time of the analysis window. + "startUtcOffset": "A String", # Required. The UTC offset of the user's timezone when the analysis window started. + }, + ], + "interval": { # Represents a time interval of session data point, which bundles multiple observed metrics together. # Required. Observed interval. + "civilEndTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. Session end time in civil time in the timezone the subject is in at the end of the session. + "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date. + "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. + "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. + "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. + }, + "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted. + "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. + "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59. + "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999. + "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds. + }, + }, + "civilStartTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. Session start time in civil time in the timezone the subject is in at the start of the session. + "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date. + "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. + "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. + "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. + }, + "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted. + "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. + "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59. + "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999. + "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds. + }, + }, + "endTime": "A String", # Required. The end time of the observed session. + "endUtcOffset": "A String", # Required. The offset of the user's local time at the end of the session relative to the Coordinated Universal Time (UTC). + "startTime": "A String", # Required. The start time of the observed session. + "startUtcOffset": "A String", # Required. The offset of the user's local time at the start of the session relative to the Coordinated Universal Time (UTC). + }, + "medicalDeviceInfo": { # Software as Medical Device (SaMD) metadata. Used to construct the Unique Device Identifier (UDI). # Output only. The meta information for the compatible device used to conduct the measurement. Irregular Rhythm Notification measurements typically populate `algorithm_version`, `service_version`, and `device_model`. + "algorithmVersion": "A String", # Output only. The algorithm version used by the feature. + "deviceModel": "A String", # Output only. The model name or device type of the compatible device used to collect the data. + "featureVersion": "A String", # Output only. The version of the feature/app running on the device. + "firmwareVersion": "A String", # Output only. The firmware version running on the compatible device used to collect the data. + "serviceVersion": "A String", # Output only. The service version used by the feature. + }, + }, "name": "A String", # Identifier. Data point name, only supported for the subset of identifiable data types. For the majority of the data types, individual data points do not need to be identified and this field would be empty. Format: `users/{user}/dataTypes/{data_type}/dataPoints/{data_point}` Example: `users/abcd1234/dataTypes/sleep/dataPoints/a1b2c3d4-e5f6-7890-1234-567890abcdef` The `{user}` ID is a system-generated identifier, as described in Identity.health_user_id. The `{data_type}` ID corresponds to the kebab-case version of the field names in the DataPoint data union field, e.g. `total-calories` for the `total_calories` field. The `{data_point}` ID can be client-provided or system-generated. If client-provided, it must be a string of 4-63 characters, containing only lowercase letters, numbers, and hyphens. + "nutritionLog": { # Holds information about a user logged food. There are two ways of creating a nutrition log based on the food type: 1. Identified food: Using the food field, which is a reference to a Food resource. In this case fields `nutrients`, `energy`, `energy_from_fat`, `total_carbohydrate`, `total_fat`, `food_display_name` will be populated based on the referenced food. 2. Anonymous food: Using the `food_display_name` field and setting the `nutrients`, `energy`, `energy_from_fat`, `total_carbohydrate`, `total_fat` fields manually. The identified food is preferred over the anonymous food. Nutrition logs created from anonymous food are not be editable. # Optional. Data for points in the `nutrition-log` session data type collection. + "energy": { # Represents the energy quantity. # Optional. Value representing the energy of the nutrition log. For nutrition logs created from an identified food, this field will be populated based on the referenced food. For anonymous food, this field will be populated manually. + "kcal": 3.14, # Required. Value representing the energy in kilocalories. + "userProvidedUnit": "A String", # Optional. Value representing the user provided unit. + }, + "energyFromFat": { # Represents the energy quantity. # Optional. Value representing the energy from fat of the nutrition log. For nutrition logs created from an identified food, this field will be populated based on the referenced food. For anonymous food, this field will be populated manually. + "kcal": 3.14, # Required. Value representing the energy in kilocalories. + "userProvidedUnit": "A String", # Optional. Value representing the user provided unit. + }, + "food": "A String", # Required. Represents the food ID. + "foodDisplayName": "A String", # Value representing the display name of the food. For nutrition logs created from an identified food, this field will be populated based on the referenced food. For anonymous food, this field will be populated manually. + "interval": { # Represents a time interval of session data point, which bundles multiple observed metrics together. # Required. Observed interval. + "civilEndTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. Session end time in civil time in the timezone the subject is in at the end of the session. + "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date. + "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. + "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. + "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. + }, + "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted. + "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. + "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59. + "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999. + "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds. + }, + }, + "civilStartTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. Session start time in civil time in the timezone the subject is in at the start of the session. + "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date. + "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. + "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. + "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. + }, + "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted. + "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. + "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59. + "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999. + "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds. + }, + }, + "endTime": "A String", # Required. The end time of the observed session. + "endUtcOffset": "A String", # Required. The offset of the user's local time at the end of the session relative to the Coordinated Universal Time (UTC). + "startTime": "A String", # Required. The start time of the observed session. + "startUtcOffset": "A String", # Required. The offset of the user's local time at the start of the session relative to the Coordinated Universal Time (UTC). + }, + "mealType": "A String", # Optional. Value representing the meal type of the nutrition log. + "nutrients": [ # Optional. Value representing the nutrients of the nutrition log. + { # Represents the quantity of a nutrient. + "nutrient": "A String", # Required. Value representing the nutrient. + "quantity": { # Represents the weight quantity. # Required. Value representing the quantity of the nutrient. + "grams": 3.14, # Required. Value representing the weight in grams. + "userProvidedUnit": "A String", # Optional. Value representing the user provided unit. + }, + }, + ], + "serving": { # Represents different properties and information about the serving of a specific food. # Optional. Value representing the nutrition log serving. + "amount": 3.14, # Optional. Amount of food consumed, fractional values are supported. + "foodMeasurementUnit": "A String", # Required. Food measurement unit + "foodMeasurementUnitDisplayName": "A String", # Output only. Legacy measurement unit for serving size in singular form (e.g. "piece", "gram"). + }, + "totalCarbohydrate": { # Represents the weight quantity. # Optional. Value representing the total carbohydrate of the nutrition log. For nutrition logs created from an identified food, this field will be populated based on the referenced food. For anonymous food, this field will be populated manually. + "grams": 3.14, # Required. Value representing the weight in grams. + "userProvidedUnit": "A String", # Optional. Value representing the user provided unit. + }, + "totalFat": { # Represents the weight quantity. # Optional. Value representing the total fat of the nutrition log. For nutrition logs created from an identified food, this field will be populated based on the referenced food. For anonymous food, this field will be populated manually. + "grams": 3.14, # Required. Value representing the weight in grams. + "userProvidedUnit": "A String", # Optional. Value representing the user provided unit. + }, + }, "oxygenSaturation": { # Captures the user's instantaneous oxygen saturation percentage (SpO2). # Optional. Data for points in the `oxygen-saturation` sample data type collection. "percentage": 3.14, # Required. The oxygen saturation percentage. Valid values are from 0 to 100. "sampleTime": { # Represents a sample time of an observed data point. # Required. The time at which oxygen saturation was measured. @@ -4335,6 +5793,41 @@

Method Details

{ # Response containing the list of reconciled DataPoints. "dataPoints": [ # Data points matching the query { # A reconciled computed or recorded metric. + "activeEnergyBurned": { # Energy burned as part of an activity, excluding the basal energy burn. # Data for points in the `active-energy-burned` interval data type collection. + "interval": { # Represents a time interval of an observed data point. # Required. Observed interval + "civilEndTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. Observed interval end time in civil time in the timezone the subject is in at the end of the observed interval + "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date. + "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. + "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. + "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. + }, + "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted. + "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. + "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59. + "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999. + "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds. + }, + }, + "civilStartTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. Observed interval start time in civil time in the timezone the subject is in at the start of the observed interval + "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date. + "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. + "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. + "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. + }, + "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted. + "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. + "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59. + "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999. + "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds. + }, + }, + "endTime": "A String", # Required. Observed interval end time. + "endUtcOffset": "A String", # Required. The offset of the user's local time at the end of the observation relative to the Coordinated Universal Time (UTC). + "startTime": "A String", # Required. Observed interval start time. + "startUtcOffset": "A String", # Required. The offset of the user's local time at the start of the observation relative to the Coordinated Universal Time (UTC). + }, + "kcal": 3.14, # Required. Energy burned during an activity, measured in kilocalories. + }, "activeMinutes": { # Record of active minutes in a given time interval. # Data for points in the `active-minutes` interval data type collection. "activeMinutesByActivityLevel": [ # Required. Active minutes by activity level. At most one record per activity level is allowed. { # Active minutes at a given activity level. @@ -4516,6 +6009,31 @@

Method Details

}, "kcal": 3.14, # Required. Number of calories burned due to basal metabolic rate in kilocalories over the observed interval. }, + "bloodGlucose": { # Represents a blood glucose level measurement. LINT: LEGACY_NAMES # Data for points in the `blood-glucose` sample data type collection. + "bloodGlucoseMilligramsPerDeciliter": 3.14, # Required. Blood glucose level concentration in mg/dL. + "mealType": "A String", # Optional. Meal type of the measurement. + "measurementSource": "A String", # Optional. Source of the measurement. + "measurementTiming": "A String", # Optional. Timing of the measurement. + "notes": "A String", # Optional. Standard free-form notes captured at manual logging. + "sampleTime": { # Represents a sample time of an observed data point. # Required. The time at which blood glucose was measured. + "civilTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. The civil time in the timezone the subject is in at the time of the observation. + "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date. + "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. + "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. + "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. + }, + "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted. + "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. + "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59. + "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999. + "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds. + }, + }, + "physicalTime": "A String", # Required. The time of the observation. + "utcOffset": "A String", # Required. The offset of the user's local time during the observation relative to the Coordinated Universal Time (UTC). + }, + "specimen": "A String", # Optional. Type of body fluid used to measure the blood glucose. + }, "bodyFat": { # Body fat measurement. # Data for points in the `body-fat` sample data type collection. "percentage": 3.14, # Required. Body fat percentage, in range [0, 100]. "sampleTime": { # Represents a sample time of an observed data point. # Required. The time at which body fat was measured. @@ -4536,6 +6054,28 @@

Method Details

"utcOffset": "A String", # Required. The offset of the user's local time during the observation relative to the Coordinated Universal Time (UTC). }, }, + "coreBodyTemperature": { # Core body temperature measurement, distinct from peripheral body temperature, reflects the temperature of the body's internal organs. # Data for points in the `core-body-temperature` sample data type collection. + "id": "A String", # Optional. The unique identifier of the core body temperature measurement. + "measurementLocation": "A String", # Optional. The location of the core body temperature measurement. + "sampleTime": { # Represents a sample time of an observed data point. # Required. The time at which core body temperature was measured. + "civilTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. The civil time in the timezone the subject is in at the time of the observation. + "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date. + "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. + "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. + "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. + }, + "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted. + "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. + "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59. + "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999. + "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds. + }, + }, + "physicalTime": "A String", # Required. The time of the observation. + "utcOffset": "A String", # Required. The offset of the user's local time during the observation relative to the Coordinated Universal Time (UTC). + }, + "temperatureCelsius": 3.14, # Required. The core body temperature in Celsius. + }, "dailyHeartRateVariability": { # Represents the daily heart rate variability data type. At least one of the following fields must be set: - `average_heart_rate_variability_milliseconds` - `non_rem_heart_rate_beats_per_minute` - `entropy` - `deep_sleep_root_mean_square_of_successive_differences_milliseconds` # Data for points in the `daily-heart-rate-variability` daily data type collection. "averageHeartRateVariabilityMilliseconds": 3.14, # Optional. A user's average heart rate variability calculated using the root mean square of successive differences (RMSSD) in times between heartbeats. "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Date (in the user's timezone) of heart rate variability measurement. @@ -4932,6 +6472,73 @@

Method Details

"startUtcOffset": "A String", # Required. The offset of the user's local time at the start of the session relative to the Coordinated Universal Time (UTC). }, }, + "nutritionLog": { # Holds information about a user logged food. There are two ways of creating a nutrition log based on the food type: 1. Identified food: Using the food field, which is a reference to a Food resource. In this case fields `nutrients`, `energy`, `energy_from_fat`, `total_carbohydrate`, `total_fat`, `food_display_name` will be populated based on the referenced food. 2. Anonymous food: Using the `food_display_name` field and setting the `nutrients`, `energy`, `energy_from_fat`, `total_carbohydrate`, `total_fat` fields manually. The identified food is preferred over the anonymous food. Nutrition logs created from anonymous food are not be editable. # Data for points in the `nutrition-log` session data type collection. + "energy": { # Represents the energy quantity. # Optional. Value representing the energy of the nutrition log. For nutrition logs created from an identified food, this field will be populated based on the referenced food. For anonymous food, this field will be populated manually. + "kcal": 3.14, # Required. Value representing the energy in kilocalories. + "userProvidedUnit": "A String", # Optional. Value representing the user provided unit. + }, + "energyFromFat": { # Represents the energy quantity. # Optional. Value representing the energy from fat of the nutrition log. For nutrition logs created from an identified food, this field will be populated based on the referenced food. For anonymous food, this field will be populated manually. + "kcal": 3.14, # Required. Value representing the energy in kilocalories. + "userProvidedUnit": "A String", # Optional. Value representing the user provided unit. + }, + "food": "A String", # Required. Represents the food ID. + "foodDisplayName": "A String", # Value representing the display name of the food. For nutrition logs created from an identified food, this field will be populated based on the referenced food. For anonymous food, this field will be populated manually. + "interval": { # Represents a time interval of session data point, which bundles multiple observed metrics together. # Required. Observed interval. + "civilEndTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. Session end time in civil time in the timezone the subject is in at the end of the session. + "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date. + "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. + "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. + "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. + }, + "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted. + "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. + "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59. + "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999. + "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds. + }, + }, + "civilStartTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. Session start time in civil time in the timezone the subject is in at the start of the session. + "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date. + "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. + "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. + "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. + }, + "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted. + "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. + "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59. + "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999. + "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds. + }, + }, + "endTime": "A String", # Required. The end time of the observed session. + "endUtcOffset": "A String", # Required. The offset of the user's local time at the end of the session relative to the Coordinated Universal Time (UTC). + "startTime": "A String", # Required. The start time of the observed session. + "startUtcOffset": "A String", # Required. The offset of the user's local time at the start of the session relative to the Coordinated Universal Time (UTC). + }, + "mealType": "A String", # Optional. Value representing the meal type of the nutrition log. + "nutrients": [ # Optional. Value representing the nutrients of the nutrition log. + { # Represents the quantity of a nutrient. + "nutrient": "A String", # Required. Value representing the nutrient. + "quantity": { # Represents the weight quantity. # Required. Value representing the quantity of the nutrient. + "grams": 3.14, # Required. Value representing the weight in grams. + "userProvidedUnit": "A String", # Optional. Value representing the user provided unit. + }, + }, + ], + "serving": { # Represents different properties and information about the serving of a specific food. # Optional. Value representing the nutrition log serving. + "amount": 3.14, # Optional. Amount of food consumed, fractional values are supported. + "foodMeasurementUnit": "A String", # Required. Food measurement unit + "foodMeasurementUnitDisplayName": "A String", # Output only. Legacy measurement unit for serving size in singular form (e.g. "piece", "gram"). + }, + "totalCarbohydrate": { # Represents the weight quantity. # Optional. Value representing the total carbohydrate of the nutrition log. For nutrition logs created from an identified food, this field will be populated based on the referenced food. For anonymous food, this field will be populated manually. + "grams": 3.14, # Required. Value representing the weight in grams. + "userProvidedUnit": "A String", # Optional. Value representing the user provided unit. + }, + "totalFat": { # Represents the weight quantity. # Optional. Value representing the total fat of the nutrition log. For nutrition logs created from an identified food, this field will be populated based on the referenced food. For anonymous food, this field will be populated manually. + "grams": 3.14, # Required. Value representing the weight in grams. + "userProvidedUnit": "A String", # Optional. Value representing the user provided unit. + }, + }, "oxygenSaturation": { # Captures the user's instantaneous oxygen saturation percentage (SpO2). # Data for points in the `oxygen-saturation` sample data type collection. "percentage": 3.14, # Required. The oxygen saturation percentage. Valid values are from 0 to 100. "sampleTime": { # Represents a sample time of an observed data point. # Required. The time at which oxygen saturation was measured. @@ -5322,6 +6929,9 @@

Method Details

"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. "rollupDataPoints": [ # Values for each aggregation time window. { # Value of a rollup for a single physical time interval (aggregation window) of reconciled data points from all data sources, excluding those data points that are identified as recorded by wearables in intervals when they were not actually worn. + "activeEnergyBurned": { # Represents the result of the rollup of active energy burned. # Returned by default when rolling up data points from the `active-energy-burned` data type. + "kcalSum": 3.14, # Output only. Sum of the active energy burned in kilocalories. + }, "activeMinutes": { # Represents the result of the rollup of the active minutes data type. # Returned by default when rolling up data points from the `active-minutes` data type, or when requested explicitly using the `active-minutes` rollup type identifier. "activeMinutesRollupByActivityLevel": [ # Active minutes by activity level. At most one record per activity level is allowed. { # Active minutes by activity level. @@ -5346,6 +6956,9 @@

Method Details

"altitude": { # Represents the result of the rollup of the user's altitude. # Returned by default when rolling up data points from the `altitude` data type, or when requested explicitly using the `altitude` rollup type identifier. "gainMillimetersSum": "A String", # Sum of the altitude gain in millimeters. }, + "bloodGlucose": { # Represents the result of the rollup of the blood glucose data type. LINT: LEGACY_NAMES # Returned by default when rolling up data points from the `blood-glucose` data type. + "bloodGlucoseMilligramsPerDeciliterAvg": 3.14, # Average blood glucose level in mg/dL. + }, "bodyFat": { # Represents the result of the rollup of the body fat data type. # Returned by default when rolling up data points from the `body-fat` data type, or when requested explicitly using the `body-fat` rollup type identifier. "bodyFatPercentageAvg": 3.14, # Average body fat percentage. }, @@ -5357,6 +6970,11 @@

Method Details

}, ], }, + "coreBodyTemperature": { # Represents the result of the rollup of the core body temperature data type. # Returned by default when rolling up data points from the `core-body-temperature` data type, or when requested explicitly using the `core-body-temperature` rollup type identifier. + "temperatureCelsiusAvg": 3.14, # Average core body temperature in Celsius. + "temperatureCelsiusMax": 3.14, # Maximum core body temperature in Celsius. + "temperatureCelsiusMin": 3.14, # Minimum core body temperature in Celsius. + }, "distance": { # Result of the rollup of the user's distance. # Returned by default when rolling up data points from the `distance` data type, or when requested explicitly using the `distance` rollup type identifier. "millimetersSum": "A String", # Sum of the distance in millimeters. }, @@ -5375,6 +6993,33 @@

Method Details

"userProvidedUnitLast": "A String", # Optional. The user provided unit on the last element. }, }, + "nutritionLog": { # Represents the result of the rollup of the nutrition log data type. # Returned by default when rolling up data points from the `nutrition-log` data type, or when requested explicitly using the `nutrition-log` rollup type identifier. + "energy": { # Rollup for the energy quantity. # Energy rollup. + "kcalSum": 3.14, # Required. The sum of the energy in kilocalories. + "userProvidedUnitLast": "A String", # Optional. The user provided unit on the last element. + }, + "energyFromFat": { # Rollup for the energy quantity. # Value Energy from fat rollup. + "kcalSum": 3.14, # Required. The sum of the energy in kilocalories. + "userProvidedUnitLast": "A String", # Optional. The user provided unit on the last element. + }, + "nutrients": [ # List of the nutrient roll-ups by the nutrient type. + { # Nutrient quantity rollup. + "nutrient": "A String", # Required. Aggregated nutrient. + "quantity": { # Rollup for the weight. # Required. Aggregated nutrient weight. + "gramsSum": 3.14, # Required. The sum of the weight in grams. + "userProvidedUnitLast": "A String", # Optional. The user provided unit on the last element. + }, + }, + ], + "totalCarbohydrate": { # Rollup for the weight. # Total carbohydrate rollup. + "gramsSum": 3.14, # Required. The sum of the weight in grams. + "userProvidedUnitLast": "A String", # Optional. The user provided unit on the last element. + }, + "totalFat": { # Rollup for the weight. # Total fat rollup. + "gramsSum": 3.14, # Required. The sum of the weight in grams. + "userProvidedUnitLast": "A String", # Optional. The user provided unit on the last element. + }, + }, "runVo2Max": { # Represents the result of the rollup of the user's daily heart rate variability personal range. # Returned by default when rolling up data points from the `run-vo2-max` data type, or when requested explicitly using the `run-vo2-max` rollup type identifier. "rateAvg": 3.14, # Average value of run VO2 max in the interval. "rateMax": 3.14, # Maximum value of run VO2 max in the interval. diff --git a/docs/dyn/health_v4.users.html b/docs/dyn/health_v4.users.html index 5274accf29..f527da29ed 100644 --- a/docs/dyn/health_v4.users.html +++ b/docs/dyn/health_v4.users.html @@ -79,12 +79,20 @@

Instance Methods

Returns the dataTypes Resource.

+

+ pairedDevices() +

+

Returns the pairedDevices Resource.

+

close()

Close httplib2 connections.

getIdentity(name, x__xgafv=None)

Gets the user's identity. It includes the legacy Fitbit user ID and the Google user ID and it can be used by migrating clients to map identifiers between the two systems.

+

+ getIrnProfile(name, x__xgafv=None)

+

Returns user's IRN Profile details.

getProfile(name, x__xgafv=None)

Returns user Profile details.

@@ -124,6 +132,28 @@

Method Details

}
+
+ getIrnProfile(name, x__xgafv=None) +
Returns user's IRN Profile details.
+
+Args:
+  name: string, Required. The resource name of the IRN Profile. Format: `users/{user}/irnProfile` Example: `users/1234567890/irnProfile` or `users/me/irnProfile` The {user} ID is a system-generated Google Health API user ID, a string of 1-63 characters consisting of lowercase and uppercase letters, numbers, and hyphens. The literal `me` can also be used to refer to the authenticated user. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Irregular Rhythm Notifications (IRN) Profile details. The Irregular Rhythm Notifications (IRN) feature checks for signs of atrial fibrillation (AFib). The IrnProfile details include information about the user's onboarding status, enrollment status, and the last update time of analyzable data for this feature.
+  "enrollmentStatus": True or False, # Required. Whether or not the user is currently enrolled in having their data processed for IRN alerts.
+  "name": "A String", # Identifier. The resource name of this IrnProfile resource. Format: `users/{user}/irnProfile` Example: `users/1234567890/irnProfile` or `users/me/irnProfile` The {user} ID is a system-generated Google Health API user ID, a string of 1-63 characters consisting of lowercase and uppercase letters, numbers, and hyphens. The literal `me` can also be used to refer to the authenticated user.
+  "onboardingStatus": True or False, # Required. Whether or not the user has onboarded onto the IRN feature.
+  "updateTime": "A String", # Output only. The timestamp of the last piece of analyzable data synced by the user.
+}
+
+
getProfile(name, x__xgafv=None)
Returns user Profile details.
@@ -170,6 +200,7 @@ 

Method Details

{ # Settings details. "autoStrideEnabled": True or False, # Optional. True if the user's stride length is determined automatically. Updates to this field are currently not supported. "distanceUnit": "A String", # Optional. The measurement unit defined in the user's account settings. Updates to this field are currently not supported. + "foodLanguageCode": "A String", # Output only. The food language code derived from the user's food database. Possible values: `'en-US'`, `'en-GB'`, `'de-DE'`, `'es-ES'`, `'fr-FR'`, `'zh-CN'`, `'zh-TW'`, `'ja-JP'`, `'en-AU'`, `'en-CA'`, `'it-IT'`, `'ko-KR'`, `'es-MX'`, `'en-IN'`, `'en-SG'`, `'en-PH'`, `'en-IE'`, `'fr-CA'`. Updates to this field are currently not supported. "glucoseUnit": "A String", # Optional. The measurement unit defined in the user's account settings. "heightUnit": "A String", # Optional. The measurement unit defined in the user's account settings. "languageLocale": "A String", # Optional. The locale defined in the user's account settings. Updates to this field are currently not supported. @@ -244,6 +275,7 @@

Method Details

{ # Settings details. "autoStrideEnabled": True or False, # Optional. True if the user's stride length is determined automatically. Updates to this field are currently not supported. "distanceUnit": "A String", # Optional. The measurement unit defined in the user's account settings. Updates to this field are currently not supported. + "foodLanguageCode": "A String", # Output only. The food language code derived from the user's food database. Possible values: `'en-US'`, `'en-GB'`, `'de-DE'`, `'es-ES'`, `'fr-FR'`, `'zh-CN'`, `'zh-TW'`, `'ja-JP'`, `'en-AU'`, `'en-CA'`, `'it-IT'`, `'ko-KR'`, `'es-MX'`, `'en-IN'`, `'en-SG'`, `'en-PH'`, `'en-IE'`, `'fr-CA'`. Updates to this field are currently not supported. "glucoseUnit": "A String", # Optional. The measurement unit defined in the user's account settings. "heightUnit": "A String", # Optional. The measurement unit defined in the user's account settings. "languageLocale": "A String", # Optional. The locale defined in the user's account settings. Updates to this field are currently not supported. @@ -270,6 +302,7 @@

Method Details

{ # Settings details. "autoStrideEnabled": True or False, # Optional. True if the user's stride length is determined automatically. Updates to this field are currently not supported. "distanceUnit": "A String", # Optional. The measurement unit defined in the user's account settings. Updates to this field are currently not supported. + "foodLanguageCode": "A String", # Output only. The food language code derived from the user's food database. Possible values: `'en-US'`, `'en-GB'`, `'de-DE'`, `'es-ES'`, `'fr-FR'`, `'zh-CN'`, `'zh-TW'`, `'ja-JP'`, `'en-AU'`, `'en-CA'`, `'it-IT'`, `'ko-KR'`, `'es-MX'`, `'en-IN'`, `'en-SG'`, `'en-PH'`, `'en-IE'`, `'fr-CA'`. Updates to this field are currently not supported. "glucoseUnit": "A String", # Optional. The measurement unit defined in the user's account settings. "heightUnit": "A String", # Optional. The measurement unit defined in the user's account settings. "languageLocale": "A String", # Optional. The locale defined in the user's account settings. Updates to this field are currently not supported. diff --git a/docs/dyn/health_v4.users.pairedDevices.html b/docs/dyn/health_v4.users.pairedDevices.html new file mode 100644 index 0000000000..edebdda7cd --- /dev/null +++ b/docs/dyn/health_v4.users.pairedDevices.html @@ -0,0 +1,172 @@ + + + +

Google Health API . users . pairedDevices

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ get(name, x__xgafv=None)

+

Returns user's Device.

+

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

+

Returns the user's list of paired 1P trackers and smartwatches.

+

+ list_next()

+

Retrieves the next page of results.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ get(name, x__xgafv=None) +
Returns user's Device.
+
+Args:
+  name: string, Required. The name of the device to retrieve. Format: users/{user}/devices/{device} (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # User's Paired 1P Device The PairedDevice details include information about the device type, battery status, battery level, last sync time, device version, mac address, and features.
+  "batteryLevel": 42, # Output only. The battery level of the device.
+  "batteryStatus": "A String", # Output only. The battery status of the device. Supported: High | Medium | Low | Empty
+  "deviceType": "A String", # Output only. The device type. Supported: TRACKER | SCALE
+  "deviceVersion": "A String", # Output only. The product name of the device
+  "features": [ # Output only. Lists of unique features supported by the device. Comprehensive list of supported features: **Fitness Tracking** - `ACTIVE_MINUTES`: Legacy active minutes. - `AUTOSTRIDE`: Automatic stride length calculation. - `BIKE_ONBOARDING`: Cycling UI support. - `CALORIES`: Daily burned calories. - `DISTANCE`: Daily distance tracking. - `ELEVATION`: Floors climbed. - `INACTIVITY_ALERTS`: Reminders to move. - `SEDENTARY_TIME`: Tracks inactive time. - `STEPS`: Daily steps. - `SWIM`: Swim tracking (laps/strokes). - `AUTORUN`: Automatic run detection. - `ACTIVE_ZONE_MINUTES`: Active Zone Minutes (AZM). **Heart Rate & Health** - `HEART_RATE`: Continuous heart rate (PPG). - `BAT_SIGNAL`: High/Low Heart Rate Alerts. **Advanced Sensors** - `SPO2`: Blood oxygen saturation. - `NIGHTTIME_OXYGEN_SATURATION`: Sleep SpO2. - `ESTIMATED_OXYGEN_VARIATION`: Estimated Oxygen Variation. - `EDA`: Electrodermal Activity (stress). - `SKIN_TEMPERATURE`: Skin temperature variation. - `INTERNAL_DEVICE_TEMPERATURE`: Internal device temperature. **Sleep & Wellness** - `SLEEP`: Basic sleep tracking. - `SMART_SLEEP`: Advanced sleep tracking (stages/score). - `BEDTIME_REMINDER`: Bedtime reminders. - `SOUNDSCAPE`: Snore and noise detection. **Advanced Workouts** - `WB`: Custom Workout Builder. - `AUTOCUES`: Auto Cues / Auto Lap. - `DWR_RUN`: Daily Run Recommendations. - `ADVANCED_RUNNING`: Advanced Running Dynamics (e.g., GCT, VO). **GPS & Location** - `GPS`: Built-in GPS. - `CONNECTED_GPS`: Connected GPS (uses phone). - `LOCATION_HINT`: Location helper. **Payments & NFC** - `PAYMENTS`: NFC payments (Fitbit Pay/Google Wallet). - `FELICA`: FeliCa support (Japan payments/transit). **Activity Detection** - `GROK`: SmartTrack automatic activity detection. - `RETRO_AR`: Retroactive Activity Recognition prompts. **Smart Features & UI** - `ALARMS`: Silent alarms. - `BLE_MUSIC_CONTROL`: BLE music control. - `MUSIC`: Direct music storage/control. - `YOUTUBE_MUSIC_SUPPORTED`: YouTube Music support. - `GALLERY`: App Gallery. - `TUTORIAL_SUPPORTED`: On-screen tutorials. - `SMILEY_EMOTE`: Legacy Zip face. - `MOBILE_TO_DEVICE_DEEPLINK`: Mobile to device settings deep link. - `HIDE_GALLERY`: Option to hide Gallery. - `HIDE_GOAL_SELECTION`: Option to hide goal selection. - `DIGITAL_WARRANTY_SUPPORTED`: Digital warranty display. - `DIRECT_DEVICE_SETTINGS_SUPPORTED`: Direct device settings management. **Gym HR Broadcasting** - `ASPEN_SUPPORTED`: Broadcast HR to gym equipment. - `ASPEN_REMOTE_UI_SUPPORTED`: Remote UI for HR sharing. **Privacy & Security** - `FINITE_IMPROBABILITY`: BLE Resolvable Private Address (RPA) privacy. - `DOMAIN_KEY_SYNC`: Domain key synchronization. **BLE Protocol** - `BONDING`: Secure BLE bonding. - `ADVERTISES_SERIAL`: Advertises serial number. - `STATUS_CHARACTERISTIC`: BLE Status Characteristic. - `TRACKER_CHANNEL_CHARACTERISTIC`: BLE Tracker Channel Characteristic. - `PING_CHARACTERISTIC`: BLE Ping Characteristic. **Cellular & Wi-Fi** - `MOBILE_DATA`: LTE cellular support. - `SINGLE_AP_WIFI`: Single AP Wi-Fi. - `MULTI_AP_WIFI`: Multi AP Wi-Fi. - `WIFI_FWUP`: Firmware updates over Wi-Fi. **Data Sync & Transfer** - `APP_SYNC`: Background app sync. - `LIVE_DATA`: Real-time data streaming. - `EVENT_BASED_SYNC_SUPPORTED`: Event-based sync. - `TIME_SERVICE`: Time synchronization service. - `REMOTE_FILE_PROVIDER`: Remote file transfer. - `DIRECT_COMMS_ALARMS`: Direct communication for alarms. - `DIRECT_COMMS_EXERCISE`: Direct communication for exercise. - `DIRECT_COMMS_BATTERY_ALERTS`: Direct communication for battery alerts. **Google Integrations** - `PARROT_TREE_SUPPORTED`: Find My Device support.
+    "A String",
+  ],
+  "lastSyncTime": "A String", # Output only. The time of last sync with the Fitbit mobile application.
+  "macAddress": "A String", # Output only. Mac ID number of the device.
+  "name": "A String", # Identifier. The resource name of this Device resource. Format: `users/{user}/pairedDevices/{paired_device}` Example: `users/1234567890/pairedDevices/123` or `users/me/pairedDevices/123`
+}
+
+ +
+ list(parent, pageSize=None, pageToken=None, x__xgafv=None) +
Returns the user's list of paired 1P trackers and smartwatches.
+
+Args:
+  parent: string, Required. The parent, which owns this collection of devices. Format: users/{user} (required)
+  pageSize: integer, Optional. The maximum number of devices to return. The service may return fewer than this value. If unspecified, at most 5 devices will be returned. The maximum value is 100. values above 100 will be coerced to 100.
+  pageToken: string, Optional. A page token, received from a previous `ListPairedDevices` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListPairedDevices` must match the call that provided the page token.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response message for ListPairedDevices.
+  "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.
+  "pairedDevices": [ # The paired devices of the user.
+    { # User's Paired 1P Device The PairedDevice details include information about the device type, battery status, battery level, last sync time, device version, mac address, and features.
+      "batteryLevel": 42, # Output only. The battery level of the device.
+      "batteryStatus": "A String", # Output only. The battery status of the device. Supported: High | Medium | Low | Empty
+      "deviceType": "A String", # Output only. The device type. Supported: TRACKER | SCALE
+      "deviceVersion": "A String", # Output only. The product name of the device
+      "features": [ # Output only. Lists of unique features supported by the device. Comprehensive list of supported features: **Fitness Tracking** - `ACTIVE_MINUTES`: Legacy active minutes. - `AUTOSTRIDE`: Automatic stride length calculation. - `BIKE_ONBOARDING`: Cycling UI support. - `CALORIES`: Daily burned calories. - `DISTANCE`: Daily distance tracking. - `ELEVATION`: Floors climbed. - `INACTIVITY_ALERTS`: Reminders to move. - `SEDENTARY_TIME`: Tracks inactive time. - `STEPS`: Daily steps. - `SWIM`: Swim tracking (laps/strokes). - `AUTORUN`: Automatic run detection. - `ACTIVE_ZONE_MINUTES`: Active Zone Minutes (AZM). **Heart Rate & Health** - `HEART_RATE`: Continuous heart rate (PPG). - `BAT_SIGNAL`: High/Low Heart Rate Alerts. **Advanced Sensors** - `SPO2`: Blood oxygen saturation. - `NIGHTTIME_OXYGEN_SATURATION`: Sleep SpO2. - `ESTIMATED_OXYGEN_VARIATION`: Estimated Oxygen Variation. - `EDA`: Electrodermal Activity (stress). - `SKIN_TEMPERATURE`: Skin temperature variation. - `INTERNAL_DEVICE_TEMPERATURE`: Internal device temperature. **Sleep & Wellness** - `SLEEP`: Basic sleep tracking. - `SMART_SLEEP`: Advanced sleep tracking (stages/score). - `BEDTIME_REMINDER`: Bedtime reminders. - `SOUNDSCAPE`: Snore and noise detection. **Advanced Workouts** - `WB`: Custom Workout Builder. - `AUTOCUES`: Auto Cues / Auto Lap. - `DWR_RUN`: Daily Run Recommendations. - `ADVANCED_RUNNING`: Advanced Running Dynamics (e.g., GCT, VO). **GPS & Location** - `GPS`: Built-in GPS. - `CONNECTED_GPS`: Connected GPS (uses phone). - `LOCATION_HINT`: Location helper. **Payments & NFC** - `PAYMENTS`: NFC payments (Fitbit Pay/Google Wallet). - `FELICA`: FeliCa support (Japan payments/transit). **Activity Detection** - `GROK`: SmartTrack automatic activity detection. - `RETRO_AR`: Retroactive Activity Recognition prompts. **Smart Features & UI** - `ALARMS`: Silent alarms. - `BLE_MUSIC_CONTROL`: BLE music control. - `MUSIC`: Direct music storage/control. - `YOUTUBE_MUSIC_SUPPORTED`: YouTube Music support. - `GALLERY`: App Gallery. - `TUTORIAL_SUPPORTED`: On-screen tutorials. - `SMILEY_EMOTE`: Legacy Zip face. - `MOBILE_TO_DEVICE_DEEPLINK`: Mobile to device settings deep link. - `HIDE_GALLERY`: Option to hide Gallery. - `HIDE_GOAL_SELECTION`: Option to hide goal selection. - `DIGITAL_WARRANTY_SUPPORTED`: Digital warranty display. - `DIRECT_DEVICE_SETTINGS_SUPPORTED`: Direct device settings management. **Gym HR Broadcasting** - `ASPEN_SUPPORTED`: Broadcast HR to gym equipment. - `ASPEN_REMOTE_UI_SUPPORTED`: Remote UI for HR sharing. **Privacy & Security** - `FINITE_IMPROBABILITY`: BLE Resolvable Private Address (RPA) privacy. - `DOMAIN_KEY_SYNC`: Domain key synchronization. **BLE Protocol** - `BONDING`: Secure BLE bonding. - `ADVERTISES_SERIAL`: Advertises serial number. - `STATUS_CHARACTERISTIC`: BLE Status Characteristic. - `TRACKER_CHANNEL_CHARACTERISTIC`: BLE Tracker Channel Characteristic. - `PING_CHARACTERISTIC`: BLE Ping Characteristic. **Cellular & Wi-Fi** - `MOBILE_DATA`: LTE cellular support. - `SINGLE_AP_WIFI`: Single AP Wi-Fi. - `MULTI_AP_WIFI`: Multi AP Wi-Fi. - `WIFI_FWUP`: Firmware updates over Wi-Fi. **Data Sync & Transfer** - `APP_SYNC`: Background app sync. - `LIVE_DATA`: Real-time data streaming. - `EVENT_BASED_SYNC_SUPPORTED`: Event-based sync. - `TIME_SERVICE`: Time synchronization service. - `REMOTE_FILE_PROVIDER`: Remote file transfer. - `DIRECT_COMMS_ALARMS`: Direct communication for alarms. - `DIRECT_COMMS_EXERCISE`: Direct communication for exercise. - `DIRECT_COMMS_BATTERY_ALERTS`: Direct communication for battery alerts. **Google Integrations** - `PARROT_TREE_SUPPORTED`: Find My Device support.
+        "A String",
+      ],
+      "lastSyncTime": "A String", # Output only. The time of last sync with the Fitbit mobile application.
+      "macAddress": "A String", # Output only. Mac ID number of the device.
+      "name": "A String", # Identifier. The resource name of this Device resource. Format: `users/{user}/pairedDevices/{paired_device}` Example: `users/1234567890/pairedDevices/123` or `users/me/pairedDevices/123`
+    },
+  ],
+}
+
+ +
+ 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/healthcare_v1beta1.projects.locations.datasets.dicomStores.html b/docs/dyn/healthcare_v1beta1.projects.locations.datasets.dicomStores.html index 38850112a9..035165033e 100644 --- a/docs/dyn/healthcare_v1beta1.projects.locations.datasets.dicomStores.html +++ b/docs/dyn/healthcare_v1beta1.projects.locations.datasets.dicomStores.html @@ -265,6 +265,14 @@

Method Details

"additionalInfoTypes": [ # Additional InfoTypes to redact in the images in addition to those used by `text_redaction_mode`. Can only be used when `text_redaction_mode` is set to `REDACT_SENSITIVE_TEXT`, `REDACT_SENSITIVE_TEXT_CLEAN_DESCRIPTORS` or `TEXT_REDACTION_MODE_UNSPECIFIED`. "A String", ], + "customRegexes": [ # Optional. Custom regex patterns to redact from the image. + { # Defines a custom regular expression pattern to detect and redact in the image. + "groupIndexes": [ # Optional. The capturing group indexes to redact. skip_request_analyics: true + 42, + ], + "pattern": "A String", # Optional. The regular expression pattern to match. + }, + ], "excludeInfoTypes": [ # InfoTypes to skip redacting, overriding those used by `text_redaction_mode`. Can only be used when `text_redaction_mode` is set to `REDACT_SENSITIVE_TEXT` or `REDACT_SENSITIVE_TEXT_CLEAN_DESCRIPTORS`. "A String", ], @@ -296,6 +304,14 @@

Method Details

"additionalInfoTypes": [ # Additional InfoTypes to redact in the images in addition to those used by `text_redaction_mode`. Can only be used when `text_redaction_mode` is set to `REDACT_SENSITIVE_TEXT`, `REDACT_SENSITIVE_TEXT_CLEAN_DESCRIPTORS` or `TEXT_REDACTION_MODE_UNSPECIFIED`. "A String", ], + "customRegexes": [ # Optional. Custom regex patterns to redact from the image. + { # Defines a custom regular expression pattern to detect and redact in the image. + "groupIndexes": [ # Optional. The capturing group indexes to redact. skip_request_analyics: true + 42, + ], + "pattern": "A String", # Optional. The regular expression pattern to match. + }, + ], "excludeInfoTypes": [ # InfoTypes to skip redacting, overriding those used by `text_redaction_mode`. Can only be used when `text_redaction_mode` is set to `REDACT_SENSITIVE_TEXT` or `REDACT_SENSITIVE_TEXT_CLEAN_DESCRIPTORS`. "A String", ], @@ -365,6 +381,14 @@

Method Details

"additionalInfoTypes": [ # Additional InfoTypes to redact in the images in addition to those used by `text_redaction_mode`. Can only be used when `text_redaction_mode` is set to `REDACT_SENSITIVE_TEXT`, `REDACT_SENSITIVE_TEXT_CLEAN_DESCRIPTORS` or `TEXT_REDACTION_MODE_UNSPECIFIED`. "A String", ], + "customRegexes": [ # Optional. Custom regex patterns to redact from the image. + { # Defines a custom regular expression pattern to detect and redact in the image. + "groupIndexes": [ # Optional. The capturing group indexes to redact. skip_request_analyics: true + 42, + ], + "pattern": "A String", # Optional. The regular expression pattern to match. + }, + ], "excludeInfoTypes": [ # InfoTypes to skip redacting, overriding those used by `text_redaction_mode`. Can only be used when `text_redaction_mode` is set to `REDACT_SENSITIVE_TEXT` or `REDACT_SENSITIVE_TEXT_CLEAN_DESCRIPTORS`. "A String", ], diff --git a/docs/dyn/healthcare_v1beta1.projects.locations.datasets.fhirStores.html b/docs/dyn/healthcare_v1beta1.projects.locations.datasets.fhirStores.html index c55bd59989..8b3bb39961 100644 --- a/docs/dyn/healthcare_v1beta1.projects.locations.datasets.fhirStores.html +++ b/docs/dyn/healthcare_v1beta1.projects.locations.datasets.fhirStores.html @@ -475,6 +475,14 @@

Method Details

"additionalInfoTypes": [ # Additional InfoTypes to redact in the images in addition to those used by `text_redaction_mode`. Can only be used when `text_redaction_mode` is set to `REDACT_SENSITIVE_TEXT`, `REDACT_SENSITIVE_TEXT_CLEAN_DESCRIPTORS` or `TEXT_REDACTION_MODE_UNSPECIFIED`. "A String", ], + "customRegexes": [ # Optional. Custom regex patterns to redact from the image. + { # Defines a custom regular expression pattern to detect and redact in the image. + "groupIndexes": [ # Optional. The capturing group indexes to redact. skip_request_analyics: true + 42, + ], + "pattern": "A String", # Optional. The regular expression pattern to match. + }, + ], "excludeInfoTypes": [ # InfoTypes to skip redacting, overriding those used by `text_redaction_mode`. Can only be used when `text_redaction_mode` is set to `REDACT_SENSITIVE_TEXT` or `REDACT_SENSITIVE_TEXT_CLEAN_DESCRIPTORS`. "A String", ], @@ -506,6 +514,14 @@

Method Details

"additionalInfoTypes": [ # Additional InfoTypes to redact in the images in addition to those used by `text_redaction_mode`. Can only be used when `text_redaction_mode` is set to `REDACT_SENSITIVE_TEXT`, `REDACT_SENSITIVE_TEXT_CLEAN_DESCRIPTORS` or `TEXT_REDACTION_MODE_UNSPECIFIED`. "A String", ], + "customRegexes": [ # Optional. Custom regex patterns to redact from the image. + { # Defines a custom regular expression pattern to detect and redact in the image. + "groupIndexes": [ # Optional. The capturing group indexes to redact. skip_request_analyics: true + 42, + ], + "pattern": "A String", # Optional. The regular expression pattern to match. + }, + ], "excludeInfoTypes": [ # InfoTypes to skip redacting, overriding those used by `text_redaction_mode`. Can only be used when `text_redaction_mode` is set to `REDACT_SENSITIVE_TEXT` or `REDACT_SENSITIVE_TEXT_CLEAN_DESCRIPTORS`. "A String", ], @@ -575,6 +591,14 @@

Method Details

"additionalInfoTypes": [ # Additional InfoTypes to redact in the images in addition to those used by `text_redaction_mode`. Can only be used when `text_redaction_mode` is set to `REDACT_SENSITIVE_TEXT`, `REDACT_SENSITIVE_TEXT_CLEAN_DESCRIPTORS` or `TEXT_REDACTION_MODE_UNSPECIFIED`. "A String", ], + "customRegexes": [ # Optional. Custom regex patterns to redact from the image. + { # Defines a custom regular expression pattern to detect and redact in the image. + "groupIndexes": [ # Optional. The capturing group indexes to redact. skip_request_analyics: true + 42, + ], + "pattern": "A String", # Optional. The regular expression pattern to match. + }, + ], "excludeInfoTypes": [ # InfoTypes to skip redacting, overriding those used by `text_redaction_mode`. Can only be used when `text_redaction_mode` is set to `REDACT_SENSITIVE_TEXT` or `REDACT_SENSITIVE_TEXT_CLEAN_DESCRIPTORS`. "A String", ], @@ -765,6 +789,14 @@

Method Details

"additionalInfoTypes": [ # Additional InfoTypes to redact in the images in addition to those used by `text_redaction_mode`. Can only be used when `text_redaction_mode` is set to `REDACT_SENSITIVE_TEXT`, `REDACT_SENSITIVE_TEXT_CLEAN_DESCRIPTORS` or `TEXT_REDACTION_MODE_UNSPECIFIED`. "A String", ], + "customRegexes": [ # Optional. Custom regex patterns to redact from the image. + { # Defines a custom regular expression pattern to detect and redact in the image. + "groupIndexes": [ # Optional. The capturing group indexes to redact. skip_request_analyics: true + 42, + ], + "pattern": "A String", # Optional. The regular expression pattern to match. + }, + ], "excludeInfoTypes": [ # InfoTypes to skip redacting, overriding those used by `text_redaction_mode`. Can only be used when `text_redaction_mode` is set to `REDACT_SENSITIVE_TEXT` or `REDACT_SENSITIVE_TEXT_CLEAN_DESCRIPTORS`. "A String", ], @@ -796,6 +828,14 @@

Method Details

"additionalInfoTypes": [ # Additional InfoTypes to redact in the images in addition to those used by `text_redaction_mode`. Can only be used when `text_redaction_mode` is set to `REDACT_SENSITIVE_TEXT`, `REDACT_SENSITIVE_TEXT_CLEAN_DESCRIPTORS` or `TEXT_REDACTION_MODE_UNSPECIFIED`. "A String", ], + "customRegexes": [ # Optional. Custom regex patterns to redact from the image. + { # Defines a custom regular expression pattern to detect and redact in the image. + "groupIndexes": [ # Optional. The capturing group indexes to redact. skip_request_analyics: true + 42, + ], + "pattern": "A String", # Optional. The regular expression pattern to match. + }, + ], "excludeInfoTypes": [ # InfoTypes to skip redacting, overriding those used by `text_redaction_mode`. Can only be used when `text_redaction_mode` is set to `REDACT_SENSITIVE_TEXT` or `REDACT_SENSITIVE_TEXT_CLEAN_DESCRIPTORS`. "A String", ], @@ -865,6 +905,14 @@

Method Details

"additionalInfoTypes": [ # Additional InfoTypes to redact in the images in addition to those used by `text_redaction_mode`. Can only be used when `text_redaction_mode` is set to `REDACT_SENSITIVE_TEXT`, `REDACT_SENSITIVE_TEXT_CLEAN_DESCRIPTORS` or `TEXT_REDACTION_MODE_UNSPECIFIED`. "A String", ], + "customRegexes": [ # Optional. Custom regex patterns to redact from the image. + { # Defines a custom regular expression pattern to detect and redact in the image. + "groupIndexes": [ # Optional. The capturing group indexes to redact. skip_request_analyics: true + 42, + ], + "pattern": "A String", # Optional. The regular expression pattern to match. + }, + ], "excludeInfoTypes": [ # InfoTypes to skip redacting, overriding those used by `text_redaction_mode`. Can only be used when `text_redaction_mode` is set to `REDACT_SENSITIVE_TEXT` or `REDACT_SENSITIVE_TEXT_CLEAN_DESCRIPTORS`. "A String", ], @@ -992,6 +1040,14 @@

Method Details

"additionalInfoTypes": [ # Additional InfoTypes to redact in the images in addition to those used by `text_redaction_mode`. Can only be used when `text_redaction_mode` is set to `REDACT_SENSITIVE_TEXT`, `REDACT_SENSITIVE_TEXT_CLEAN_DESCRIPTORS` or `TEXT_REDACTION_MODE_UNSPECIFIED`. "A String", ], + "customRegexes": [ # Optional. Custom regex patterns to redact from the image. + { # Defines a custom regular expression pattern to detect and redact in the image. + "groupIndexes": [ # Optional. The capturing group indexes to redact. skip_request_analyics: true + 42, + ], + "pattern": "A String", # Optional. The regular expression pattern to match. + }, + ], "excludeInfoTypes": [ # InfoTypes to skip redacting, overriding those used by `text_redaction_mode`. Can only be used when `text_redaction_mode` is set to `REDACT_SENSITIVE_TEXT` or `REDACT_SENSITIVE_TEXT_CLEAN_DESCRIPTORS`. "A String", ], @@ -1023,6 +1079,14 @@

Method Details

"additionalInfoTypes": [ # Additional InfoTypes to redact in the images in addition to those used by `text_redaction_mode`. Can only be used when `text_redaction_mode` is set to `REDACT_SENSITIVE_TEXT`, `REDACT_SENSITIVE_TEXT_CLEAN_DESCRIPTORS` or `TEXT_REDACTION_MODE_UNSPECIFIED`. "A String", ], + "customRegexes": [ # Optional. Custom regex patterns to redact from the image. + { # Defines a custom regular expression pattern to detect and redact in the image. + "groupIndexes": [ # Optional. The capturing group indexes to redact. skip_request_analyics: true + 42, + ], + "pattern": "A String", # Optional. The regular expression pattern to match. + }, + ], "excludeInfoTypes": [ # InfoTypes to skip redacting, overriding those used by `text_redaction_mode`. Can only be used when `text_redaction_mode` is set to `REDACT_SENSITIVE_TEXT` or `REDACT_SENSITIVE_TEXT_CLEAN_DESCRIPTORS`. "A String", ], @@ -1092,6 +1156,14 @@

Method Details

"additionalInfoTypes": [ # Additional InfoTypes to redact in the images in addition to those used by `text_redaction_mode`. Can only be used when `text_redaction_mode` is set to `REDACT_SENSITIVE_TEXT`, `REDACT_SENSITIVE_TEXT_CLEAN_DESCRIPTORS` or `TEXT_REDACTION_MODE_UNSPECIFIED`. "A String", ], + "customRegexes": [ # Optional. Custom regex patterns to redact from the image. + { # Defines a custom regular expression pattern to detect and redact in the image. + "groupIndexes": [ # Optional. The capturing group indexes to redact. skip_request_analyics: true + 42, + ], + "pattern": "A String", # Optional. The regular expression pattern to match. + }, + ], "excludeInfoTypes": [ # InfoTypes to skip redacting, overriding those used by `text_redaction_mode`. Can only be used when `text_redaction_mode` is set to `REDACT_SENSITIVE_TEXT` or `REDACT_SENSITIVE_TEXT_CLEAN_DESCRIPTORS`. "A String", ], @@ -1489,6 +1561,14 @@

Method Details

"additionalInfoTypes": [ # Additional InfoTypes to redact in the images in addition to those used by `text_redaction_mode`. Can only be used when `text_redaction_mode` is set to `REDACT_SENSITIVE_TEXT`, `REDACT_SENSITIVE_TEXT_CLEAN_DESCRIPTORS` or `TEXT_REDACTION_MODE_UNSPECIFIED`. "A String", ], + "customRegexes": [ # Optional. Custom regex patterns to redact from the image. + { # Defines a custom regular expression pattern to detect and redact in the image. + "groupIndexes": [ # Optional. The capturing group indexes to redact. skip_request_analyics: true + 42, + ], + "pattern": "A String", # Optional. The regular expression pattern to match. + }, + ], "excludeInfoTypes": [ # InfoTypes to skip redacting, overriding those used by `text_redaction_mode`. Can only be used when `text_redaction_mode` is set to `REDACT_SENSITIVE_TEXT` or `REDACT_SENSITIVE_TEXT_CLEAN_DESCRIPTORS`. "A String", ], @@ -1520,6 +1600,14 @@

Method Details

"additionalInfoTypes": [ # Additional InfoTypes to redact in the images in addition to those used by `text_redaction_mode`. Can only be used when `text_redaction_mode` is set to `REDACT_SENSITIVE_TEXT`, `REDACT_SENSITIVE_TEXT_CLEAN_DESCRIPTORS` or `TEXT_REDACTION_MODE_UNSPECIFIED`. "A String", ], + "customRegexes": [ # Optional. Custom regex patterns to redact from the image. + { # Defines a custom regular expression pattern to detect and redact in the image. + "groupIndexes": [ # Optional. The capturing group indexes to redact. skip_request_analyics: true + 42, + ], + "pattern": "A String", # Optional. The regular expression pattern to match. + }, + ], "excludeInfoTypes": [ # InfoTypes to skip redacting, overriding those used by `text_redaction_mode`. Can only be used when `text_redaction_mode` is set to `REDACT_SENSITIVE_TEXT` or `REDACT_SENSITIVE_TEXT_CLEAN_DESCRIPTORS`. "A String", ], @@ -1589,6 +1677,14 @@

Method Details

"additionalInfoTypes": [ # Additional InfoTypes to redact in the images in addition to those used by `text_redaction_mode`. Can only be used when `text_redaction_mode` is set to `REDACT_SENSITIVE_TEXT`, `REDACT_SENSITIVE_TEXT_CLEAN_DESCRIPTORS` or `TEXT_REDACTION_MODE_UNSPECIFIED`. "A String", ], + "customRegexes": [ # Optional. Custom regex patterns to redact from the image. + { # Defines a custom regular expression pattern to detect and redact in the image. + "groupIndexes": [ # Optional. The capturing group indexes to redact. skip_request_analyics: true + 42, + ], + "pattern": "A String", # Optional. The regular expression pattern to match. + }, + ], "excludeInfoTypes": [ # InfoTypes to skip redacting, overriding those used by `text_redaction_mode`. Can only be used when `text_redaction_mode` is set to `REDACT_SENSITIVE_TEXT` or `REDACT_SENSITIVE_TEXT_CLEAN_DESCRIPTORS`. "A String", ], @@ -1956,6 +2052,14 @@

Method Details

"additionalInfoTypes": [ # Additional InfoTypes to redact in the images in addition to those used by `text_redaction_mode`. Can only be used when `text_redaction_mode` is set to `REDACT_SENSITIVE_TEXT`, `REDACT_SENSITIVE_TEXT_CLEAN_DESCRIPTORS` or `TEXT_REDACTION_MODE_UNSPECIFIED`. "A String", ], + "customRegexes": [ # Optional. Custom regex patterns to redact from the image. + { # Defines a custom regular expression pattern to detect and redact in the image. + "groupIndexes": [ # Optional. The capturing group indexes to redact. skip_request_analyics: true + 42, + ], + "pattern": "A String", # Optional. The regular expression pattern to match. + }, + ], "excludeInfoTypes": [ # InfoTypes to skip redacting, overriding those used by `text_redaction_mode`. Can only be used when `text_redaction_mode` is set to `REDACT_SENSITIVE_TEXT` or `REDACT_SENSITIVE_TEXT_CLEAN_DESCRIPTORS`. "A String", ], @@ -1987,6 +2091,14 @@

Method Details

"additionalInfoTypes": [ # Additional InfoTypes to redact in the images in addition to those used by `text_redaction_mode`. Can only be used when `text_redaction_mode` is set to `REDACT_SENSITIVE_TEXT`, `REDACT_SENSITIVE_TEXT_CLEAN_DESCRIPTORS` or `TEXT_REDACTION_MODE_UNSPECIFIED`. "A String", ], + "customRegexes": [ # Optional. Custom regex patterns to redact from the image. + { # Defines a custom regular expression pattern to detect and redact in the image. + "groupIndexes": [ # Optional. The capturing group indexes to redact. skip_request_analyics: true + 42, + ], + "pattern": "A String", # Optional. The regular expression pattern to match. + }, + ], "excludeInfoTypes": [ # InfoTypes to skip redacting, overriding those used by `text_redaction_mode`. Can only be used when `text_redaction_mode` is set to `REDACT_SENSITIVE_TEXT` or `REDACT_SENSITIVE_TEXT_CLEAN_DESCRIPTORS`. "A String", ], @@ -2056,6 +2168,14 @@

Method Details

"additionalInfoTypes": [ # Additional InfoTypes to redact in the images in addition to those used by `text_redaction_mode`. Can only be used when `text_redaction_mode` is set to `REDACT_SENSITIVE_TEXT`, `REDACT_SENSITIVE_TEXT_CLEAN_DESCRIPTORS` or `TEXT_REDACTION_MODE_UNSPECIFIED`. "A String", ], + "customRegexes": [ # Optional. Custom regex patterns to redact from the image. + { # Defines a custom regular expression pattern to detect and redact in the image. + "groupIndexes": [ # Optional. The capturing group indexes to redact. skip_request_analyics: true + 42, + ], + "pattern": "A String", # Optional. The regular expression pattern to match. + }, + ], "excludeInfoTypes": [ # InfoTypes to skip redacting, overriding those used by `text_redaction_mode`. Can only be used when `text_redaction_mode` is set to `REDACT_SENSITIVE_TEXT` or `REDACT_SENSITIVE_TEXT_CLEAN_DESCRIPTORS`. "A String", ], @@ -2264,6 +2384,14 @@

Method Details

"additionalInfoTypes": [ # Additional InfoTypes to redact in the images in addition to those used by `text_redaction_mode`. Can only be used when `text_redaction_mode` is set to `REDACT_SENSITIVE_TEXT`, `REDACT_SENSITIVE_TEXT_CLEAN_DESCRIPTORS` or `TEXT_REDACTION_MODE_UNSPECIFIED`. "A String", ], + "customRegexes": [ # Optional. Custom regex patterns to redact from the image. + { # Defines a custom regular expression pattern to detect and redact in the image. + "groupIndexes": [ # Optional. The capturing group indexes to redact. skip_request_analyics: true + 42, + ], + "pattern": "A String", # Optional. The regular expression pattern to match. + }, + ], "excludeInfoTypes": [ # InfoTypes to skip redacting, overriding those used by `text_redaction_mode`. Can only be used when `text_redaction_mode` is set to `REDACT_SENSITIVE_TEXT` or `REDACT_SENSITIVE_TEXT_CLEAN_DESCRIPTORS`. "A String", ], @@ -2295,6 +2423,14 @@

Method Details

"additionalInfoTypes": [ # Additional InfoTypes to redact in the images in addition to those used by `text_redaction_mode`. Can only be used when `text_redaction_mode` is set to `REDACT_SENSITIVE_TEXT`, `REDACT_SENSITIVE_TEXT_CLEAN_DESCRIPTORS` or `TEXT_REDACTION_MODE_UNSPECIFIED`. "A String", ], + "customRegexes": [ # Optional. Custom regex patterns to redact from the image. + { # Defines a custom regular expression pattern to detect and redact in the image. + "groupIndexes": [ # Optional. The capturing group indexes to redact. skip_request_analyics: true + 42, + ], + "pattern": "A String", # Optional. The regular expression pattern to match. + }, + ], "excludeInfoTypes": [ # InfoTypes to skip redacting, overriding those used by `text_redaction_mode`. Can only be used when `text_redaction_mode` is set to `REDACT_SENSITIVE_TEXT` or `REDACT_SENSITIVE_TEXT_CLEAN_DESCRIPTORS`. "A String", ], @@ -2364,6 +2500,14 @@

Method Details

"additionalInfoTypes": [ # Additional InfoTypes to redact in the images in addition to those used by `text_redaction_mode`. Can only be used when `text_redaction_mode` is set to `REDACT_SENSITIVE_TEXT`, `REDACT_SENSITIVE_TEXT_CLEAN_DESCRIPTORS` or `TEXT_REDACTION_MODE_UNSPECIFIED`. "A String", ], + "customRegexes": [ # Optional. Custom regex patterns to redact from the image. + { # Defines a custom regular expression pattern to detect and redact in the image. + "groupIndexes": [ # Optional. The capturing group indexes to redact. skip_request_analyics: true + 42, + ], + "pattern": "A String", # Optional. The regular expression pattern to match. + }, + ], "excludeInfoTypes": [ # InfoTypes to skip redacting, overriding those used by `text_redaction_mode`. Can only be used when `text_redaction_mode` is set to `REDACT_SENSITIVE_TEXT` or `REDACT_SENSITIVE_TEXT_CLEAN_DESCRIPTORS`. "A String", ], @@ -2554,6 +2698,14 @@

Method Details

"additionalInfoTypes": [ # Additional InfoTypes to redact in the images in addition to those used by `text_redaction_mode`. Can only be used when `text_redaction_mode` is set to `REDACT_SENSITIVE_TEXT`, `REDACT_SENSITIVE_TEXT_CLEAN_DESCRIPTORS` or `TEXT_REDACTION_MODE_UNSPECIFIED`. "A String", ], + "customRegexes": [ # Optional. Custom regex patterns to redact from the image. + { # Defines a custom regular expression pattern to detect and redact in the image. + "groupIndexes": [ # Optional. The capturing group indexes to redact. skip_request_analyics: true + 42, + ], + "pattern": "A String", # Optional. The regular expression pattern to match. + }, + ], "excludeInfoTypes": [ # InfoTypes to skip redacting, overriding those used by `text_redaction_mode`. Can only be used when `text_redaction_mode` is set to `REDACT_SENSITIVE_TEXT` or `REDACT_SENSITIVE_TEXT_CLEAN_DESCRIPTORS`. "A String", ], @@ -2585,6 +2737,14 @@

Method Details

"additionalInfoTypes": [ # Additional InfoTypes to redact in the images in addition to those used by `text_redaction_mode`. Can only be used when `text_redaction_mode` is set to `REDACT_SENSITIVE_TEXT`, `REDACT_SENSITIVE_TEXT_CLEAN_DESCRIPTORS` or `TEXT_REDACTION_MODE_UNSPECIFIED`. "A String", ], + "customRegexes": [ # Optional. Custom regex patterns to redact from the image. + { # Defines a custom regular expression pattern to detect and redact in the image. + "groupIndexes": [ # Optional. The capturing group indexes to redact. skip_request_analyics: true + 42, + ], + "pattern": "A String", # Optional. The regular expression pattern to match. + }, + ], "excludeInfoTypes": [ # InfoTypes to skip redacting, overriding those used by `text_redaction_mode`. Can only be used when `text_redaction_mode` is set to `REDACT_SENSITIVE_TEXT` or `REDACT_SENSITIVE_TEXT_CLEAN_DESCRIPTORS`. "A String", ], @@ -2654,6 +2814,14 @@

Method Details

"additionalInfoTypes": [ # Additional InfoTypes to redact in the images in addition to those used by `text_redaction_mode`. Can only be used when `text_redaction_mode` is set to `REDACT_SENSITIVE_TEXT`, `REDACT_SENSITIVE_TEXT_CLEAN_DESCRIPTORS` or `TEXT_REDACTION_MODE_UNSPECIFIED`. "A String", ], + "customRegexes": [ # Optional. Custom regex patterns to redact from the image. + { # Defines a custom regular expression pattern to detect and redact in the image. + "groupIndexes": [ # Optional. The capturing group indexes to redact. skip_request_analyics: true + 42, + ], + "pattern": "A String", # Optional. The regular expression pattern to match. + }, + ], "excludeInfoTypes": [ # InfoTypes to skip redacting, overriding those used by `text_redaction_mode`. Can only be used when `text_redaction_mode` is set to `REDACT_SENSITIVE_TEXT` or `REDACT_SENSITIVE_TEXT_CLEAN_DESCRIPTORS`. "A String", ], diff --git a/docs/dyn/healthcare_v1beta1.projects.locations.datasets.html b/docs/dyn/healthcare_v1beta1.projects.locations.datasets.html index b5d1ef4589..b934752f20 100644 --- a/docs/dyn/healthcare_v1beta1.projects.locations.datasets.html +++ b/docs/dyn/healthcare_v1beta1.projects.locations.datasets.html @@ -224,6 +224,14 @@

Method Details

"additionalInfoTypes": [ # Additional InfoTypes to redact in the images in addition to those used by `text_redaction_mode`. Can only be used when `text_redaction_mode` is set to `REDACT_SENSITIVE_TEXT`, `REDACT_SENSITIVE_TEXT_CLEAN_DESCRIPTORS` or `TEXT_REDACTION_MODE_UNSPECIFIED`. "A String", ], + "customRegexes": [ # Optional. Custom regex patterns to redact from the image. + { # Defines a custom regular expression pattern to detect and redact in the image. + "groupIndexes": [ # Optional. The capturing group indexes to redact. skip_request_analyics: true + 42, + ], + "pattern": "A String", # Optional. The regular expression pattern to match. + }, + ], "excludeInfoTypes": [ # InfoTypes to skip redacting, overriding those used by `text_redaction_mode`. Can only be used when `text_redaction_mode` is set to `REDACT_SENSITIVE_TEXT` or `REDACT_SENSITIVE_TEXT_CLEAN_DESCRIPTORS`. "A String", ], @@ -255,6 +263,14 @@

Method Details

"additionalInfoTypes": [ # Additional InfoTypes to redact in the images in addition to those used by `text_redaction_mode`. Can only be used when `text_redaction_mode` is set to `REDACT_SENSITIVE_TEXT`, `REDACT_SENSITIVE_TEXT_CLEAN_DESCRIPTORS` or `TEXT_REDACTION_MODE_UNSPECIFIED`. "A String", ], + "customRegexes": [ # Optional. Custom regex patterns to redact from the image. + { # Defines a custom regular expression pattern to detect and redact in the image. + "groupIndexes": [ # Optional. The capturing group indexes to redact. skip_request_analyics: true + 42, + ], + "pattern": "A String", # Optional. The regular expression pattern to match. + }, + ], "excludeInfoTypes": [ # InfoTypes to skip redacting, overriding those used by `text_redaction_mode`. Can only be used when `text_redaction_mode` is set to `REDACT_SENSITIVE_TEXT` or `REDACT_SENSITIVE_TEXT_CLEAN_DESCRIPTORS`. "A String", ], @@ -324,6 +340,14 @@

Method Details

"additionalInfoTypes": [ # Additional InfoTypes to redact in the images in addition to those used by `text_redaction_mode`. Can only be used when `text_redaction_mode` is set to `REDACT_SENSITIVE_TEXT`, `REDACT_SENSITIVE_TEXT_CLEAN_DESCRIPTORS` or `TEXT_REDACTION_MODE_UNSPECIFIED`. "A String", ], + "customRegexes": [ # Optional. Custom regex patterns to redact from the image. + { # Defines a custom regular expression pattern to detect and redact in the image. + "groupIndexes": [ # Optional. The capturing group indexes to redact. skip_request_analyics: true + 42, + ], + "pattern": "A String", # Optional. The regular expression pattern to match. + }, + ], "excludeInfoTypes": [ # InfoTypes to skip redacting, overriding those used by `text_redaction_mode`. Can only be used when `text_redaction_mode` is set to `REDACT_SENSITIVE_TEXT` or `REDACT_SENSITIVE_TEXT_CLEAN_DESCRIPTORS`. "A String", ], diff --git a/docs/dyn/homegraph_v1.devices.html b/docs/dyn/homegraph_v1.devices.html index f2af8cf914..fb4b9e5cf9 100644 --- a/docs/dyn/homegraph_v1.devices.html +++ b/docs/dyn/homegraph_v1.devices.html @@ -187,7 +187,7 @@

Method Details

"componentId": "A String", # Required. ID of the component from the device provider. "traitData": [ # Required. The updated trait data for the component. { # Contains the trait payload for a single trait. - "trait": { # Optional. The Home API trait payload. + "trait": { # The Provider Home API trait payload. "a_key": "", # Properties of the object. Contains field @type with type URL. }, }, diff --git a/docs/dyn/index.md b/docs/dyn/index.md index 825c43c927..4780a11922 100644 --- a/docs/dyn/index.md +++ b/docs/dyn/index.md @@ -73,10 +73,6 @@ * [v1beta](http://googleapis.github.io/google-api-python-client/docs/dyn/alloydb_v1beta.html) -## analytics -* [v3](http://googleapis.github.io/google-api-python-client/docs/dyn/analytics_v3.html) - - ## analyticsadmin * [v1alpha](http://googleapis.github.io/google-api-python-client/docs/dyn/analyticsadmin_v1alpha.html) * [v1beta](http://googleapis.github.io/google-api-python-client/docs/dyn/analyticsadmin_v1beta.html) @@ -1381,6 +1377,10 @@ * [v1](http://googleapis.github.io/google-api-python-client/docs/dyn/walletobjects_v1.html) +## webcontentpublisher +* [v1](http://googleapis.github.io/google-api-python-client/docs/dyn/webcontentpublisher_v1.html) + + ## webfonts * [v1](http://googleapis.github.io/google-api-python-client/docs/dyn/webfonts_v1.html) diff --git a/docs/dyn/logging_v2.billingAccounts.locations.recentQueries.html b/docs/dyn/logging_v2.billingAccounts.locations.recentQueries.html index a9e0dfc0c4..a78d518a32 100644 --- a/docs/dyn/logging_v2.billingAccounts.locations.recentQueries.html +++ b/docs/dyn/logging_v2.billingAccounts.locations.recentQueries.html @@ -144,6 +144,12 @@

Method Details

"type": "A String", # Required. Specifies the aggregation function. Use one of the following string identifiers: "average": Computes the average (AVG). Applies only to numeric values. "count": Counts the number of values (COUNT). "count-distinct": Counts the number of distinct values (COUNT DISTINCT). "count-distinct-approx": Approximates the count of distinct values (APPROX_COUNT_DISTINCT). "max": Finds the maximum value (MAX). Applies only to numeric values. "min": Finds the minimum value (MIN). Applies only to numeric values. "sum": Computes the sum (SUM). Applies only to numeric values. }, "truncationGranularity": "A String", # The truncation granularity when grouping by a time/date field. This will be used to truncate the field to the granularity specified. This can be either a date or a time granularity found at https://cloud.google.com/bigquery/docs/reference/standard-sql/timestamp_functions#timestamp_trunc_granularity_date and https://cloud.google.com/bigquery/docs/reference/standard-sql/timestamp_functions#timestamp_trunc_granularity_time respectively. + "virtualField": { # A virtual field is a field that is not physically present in the underlying data schema, but is created through specific operations within the query builder model based on other fields in the schema. # Optional. A virtual field definition, used in place of field to define a field that is computed from other fields rather than being directly present in the data schema.For example, a virtual field can be defined using COALESCE to select the first non-null value from a list of fields.If virtual_field is set, field must not be set. + "underlyingFieldSources": [ # The field sources that will be used to create the virtual field, based on the semantics of the virtual field type.The field sources must follow these rules, based on the virtual field type: - For VIRTUAL_FIELD_TYPE_UNSPECIFIED, this field must be empty. - For COALESCE, this field must be non-empty and include a minimum of two field sources. The underlying field sources must be actual projected fields that represent actual schema fields and that must not be transformed and aggregated in any way, except for casting. The type of all the underlying field sources must be equivalent so that picking one of them would result in the same value type. + # Object with schema name: FieldSource + ], + "virtualFieldType": "A String", # Required. The type of the virtual field. + }, }, }, ], @@ -172,6 +178,12 @@

Method Details

"type": "A String", # Required. Specifies the aggregation function. Use one of the following string identifiers: "average": Computes the average (AVG). Applies only to numeric values. "count": Counts the number of values (COUNT). "count-distinct": Counts the number of distinct values (COUNT DISTINCT). "count-distinct-approx": Approximates the count of distinct values (APPROX_COUNT_DISTINCT). "max": Finds the maximum value (MAX). Applies only to numeric values. "min": Finds the minimum value (MIN). Applies only to numeric values. "sum": Computes the sum (SUM). Applies only to numeric values. }, "truncationGranularity": "A String", # The truncation granularity when grouping by a time/date field. This will be used to truncate the field to the granularity specified. This can be either a date or a time granularity found at https://cloud.google.com/bigquery/docs/reference/standard-sql/timestamp_functions#timestamp_trunc_granularity_date and https://cloud.google.com/bigquery/docs/reference/standard-sql/timestamp_functions#timestamp_trunc_granularity_time respectively. + "virtualField": { # A virtual field is a field that is not physically present in the underlying data schema, but is created through specific operations within the query builder model based on other fields in the schema. # Optional. A virtual field definition, used in place of field to define a field that is computed from other fields rather than being directly present in the data schema.For example, a virtual field can be defined using COALESCE to select the first non-null value from a list of fields.If virtual_field is set, field must not be set. + "underlyingFieldSources": [ # The field sources that will be used to create the virtual field, based on the semantics of the virtual field type.The field sources must follow these rules, based on the virtual field type: - For VIRTUAL_FIELD_TYPE_UNSPECIFIED, this field must be empty. - For COALESCE, this field must be non-empty and include a minimum of two field sources. The underlying field sources must be actual projected fields that represent actual schema fields and that must not be transformed and aggregated in any way, except for casting. The type of all the underlying field sources must be equivalent so that picking one of them would result in the same value type. + # Object with schema name: FieldSource + ], + "virtualFieldType": "A String", # Required. The type of the virtual field. + }, }, }, "fieldSourceValue": { # A source that can be used to represent a "field of data" within various parts of a structured query, such as in SELECT, WHERE, or ORDER BY clauses. The term "field of data" is used here because it is not limited to literal fields in the underlying data schema. # The field. This will be the field that is set as the Right Hand Side of the filter. @@ -193,6 +205,12 @@

Method Details

"type": "A String", # Required. Specifies the aggregation function. Use one of the following string identifiers: "average": Computes the average (AVG). Applies only to numeric values. "count": Counts the number of values (COUNT). "count-distinct": Counts the number of distinct values (COUNT DISTINCT). "count-distinct-approx": Approximates the count of distinct values (APPROX_COUNT_DISTINCT). "max": Finds the maximum value (MAX). Applies only to numeric values. "min": Finds the minimum value (MIN). Applies only to numeric values. "sum": Computes the sum (SUM). Applies only to numeric values. }, "truncationGranularity": "A String", # The truncation granularity when grouping by a time/date field. This will be used to truncate the field to the granularity specified. This can be either a date or a time granularity found at https://cloud.google.com/bigquery/docs/reference/standard-sql/timestamp_functions#timestamp_trunc_granularity_date and https://cloud.google.com/bigquery/docs/reference/standard-sql/timestamp_functions#timestamp_trunc_granularity_time respectively. + "virtualField": { # A virtual field is a field that is not physically present in the underlying data schema, but is created through specific operations within the query builder model based on other fields in the schema. # Optional. A virtual field definition, used in place of field to define a field that is computed from other fields rather than being directly present in the data schema.For example, a virtual field can be defined using COALESCE to select the first non-null value from a list of fields.If virtual_field is set, field must not be set. + "underlyingFieldSources": [ # The field sources that will be used to create the virtual field, based on the semantics of the virtual field type.The field sources must follow these rules, based on the virtual field type: - For VIRTUAL_FIELD_TYPE_UNSPECIFIED, this field must be empty. - For COALESCE, this field must be non-empty and include a minimum of two field sources. The underlying field sources must be actual projected fields that represent actual schema fields and that must not be transformed and aggregated in any way, except for casting. The type of all the underlying field sources must be equivalent so that picking one of them would result in the same value type. + # Object with schema name: FieldSource + ], + "virtualFieldType": "A String", # Required. The type of the virtual field. + }, }, }, "isNegation": True or False, # Determines if the NOT flag should be added to the comparator. @@ -222,6 +240,12 @@

Method Details

"type": "A String", # Required. Specifies the aggregation function. Use one of the following string identifiers: "average": Computes the average (AVG). Applies only to numeric values. "count": Counts the number of values (COUNT). "count-distinct": Counts the number of distinct values (COUNT DISTINCT). "count-distinct-approx": Approximates the count of distinct values (APPROX_COUNT_DISTINCT). "max": Finds the maximum value (MAX). Applies only to numeric values. "min": Finds the minimum value (MIN). Applies only to numeric values. "sum": Computes the sum (SUM). Applies only to numeric values. }, "truncationGranularity": "A String", # The truncation granularity when grouping by a time/date field. This will be used to truncate the field to the granularity specified. This can be either a date or a time granularity found at https://cloud.google.com/bigquery/docs/reference/standard-sql/timestamp_functions#timestamp_trunc_granularity_date and https://cloud.google.com/bigquery/docs/reference/standard-sql/timestamp_functions#timestamp_trunc_granularity_time respectively. + "virtualField": { # A virtual field is a field that is not physically present in the underlying data schema, but is created through specific operations within the query builder model based on other fields in the schema. # Optional. A virtual field definition, used in place of field to define a field that is computed from other fields rather than being directly present in the data schema.For example, a virtual field can be defined using COALESCE to select the first non-null value from a list of fields.If virtual_field is set, field must not be set. + "underlyingFieldSources": [ # The field sources that will be used to create the virtual field, based on the semantics of the virtual field type.The field sources must follow these rules, based on the virtual field type: - For VIRTUAL_FIELD_TYPE_UNSPECIFIED, this field must be empty. - For COALESCE, this field must be non-empty and include a minimum of two field sources. The underlying field sources must be actual projected fields that represent actual schema fields and that must not be transformed and aggregated in any way, except for casting. The type of all the underlying field sources must be equivalent so that picking one of them would result in the same value type. + # Object with schema name: FieldSource + ], + "virtualFieldType": "A String", # Required. The type of the virtual field. + }, }, }, "sortOrderDirection": "A String", # The sort order to use for the query. diff --git a/docs/dyn/logging_v2.billingAccounts.locations.savedQueries.html b/docs/dyn/logging_v2.billingAccounts.locations.savedQueries.html index 6dcb91fb85..c7038a5476 100644 --- a/docs/dyn/logging_v2.billingAccounts.locations.savedQueries.html +++ b/docs/dyn/logging_v2.billingAccounts.locations.savedQueries.html @@ -147,6 +147,12 @@

Method Details

"type": "A String", # Required. Specifies the aggregation function. Use one of the following string identifiers: "average": Computes the average (AVG). Applies only to numeric values. "count": Counts the number of values (COUNT). "count-distinct": Counts the number of distinct values (COUNT DISTINCT). "count-distinct-approx": Approximates the count of distinct values (APPROX_COUNT_DISTINCT). "max": Finds the maximum value (MAX). Applies only to numeric values. "min": Finds the minimum value (MIN). Applies only to numeric values. "sum": Computes the sum (SUM). Applies only to numeric values. }, "truncationGranularity": "A String", # The truncation granularity when grouping by a time/date field. This will be used to truncate the field to the granularity specified. This can be either a date or a time granularity found at https://cloud.google.com/bigquery/docs/reference/standard-sql/timestamp_functions#timestamp_trunc_granularity_date and https://cloud.google.com/bigquery/docs/reference/standard-sql/timestamp_functions#timestamp_trunc_granularity_time respectively. + "virtualField": { # A virtual field is a field that is not physically present in the underlying data schema, but is created through specific operations within the query builder model based on other fields in the schema. # Optional. A virtual field definition, used in place of field to define a field that is computed from other fields rather than being directly present in the data schema.For example, a virtual field can be defined using COALESCE to select the first non-null value from a list of fields.If virtual_field is set, field must not be set. + "underlyingFieldSources": [ # The field sources that will be used to create the virtual field, based on the semantics of the virtual field type.The field sources must follow these rules, based on the virtual field type: - For VIRTUAL_FIELD_TYPE_UNSPECIFIED, this field must be empty. - For COALESCE, this field must be non-empty and include a minimum of two field sources. The underlying field sources must be actual projected fields that represent actual schema fields and that must not be transformed and aggregated in any way, except for casting. The type of all the underlying field sources must be equivalent so that picking one of them would result in the same value type. + # Object with schema name: FieldSource + ], + "virtualFieldType": "A String", # Required. The type of the virtual field. + }, }, }, ], @@ -175,6 +181,12 @@

Method Details

"type": "A String", # Required. Specifies the aggregation function. Use one of the following string identifiers: "average": Computes the average (AVG). Applies only to numeric values. "count": Counts the number of values (COUNT). "count-distinct": Counts the number of distinct values (COUNT DISTINCT). "count-distinct-approx": Approximates the count of distinct values (APPROX_COUNT_DISTINCT). "max": Finds the maximum value (MAX). Applies only to numeric values. "min": Finds the minimum value (MIN). Applies only to numeric values. "sum": Computes the sum (SUM). Applies only to numeric values. }, "truncationGranularity": "A String", # The truncation granularity when grouping by a time/date field. This will be used to truncate the field to the granularity specified. This can be either a date or a time granularity found at https://cloud.google.com/bigquery/docs/reference/standard-sql/timestamp_functions#timestamp_trunc_granularity_date and https://cloud.google.com/bigquery/docs/reference/standard-sql/timestamp_functions#timestamp_trunc_granularity_time respectively. + "virtualField": { # A virtual field is a field that is not physically present in the underlying data schema, but is created through specific operations within the query builder model based on other fields in the schema. # Optional. A virtual field definition, used in place of field to define a field that is computed from other fields rather than being directly present in the data schema.For example, a virtual field can be defined using COALESCE to select the first non-null value from a list of fields.If virtual_field is set, field must not be set. + "underlyingFieldSources": [ # The field sources that will be used to create the virtual field, based on the semantics of the virtual field type.The field sources must follow these rules, based on the virtual field type: - For VIRTUAL_FIELD_TYPE_UNSPECIFIED, this field must be empty. - For COALESCE, this field must be non-empty and include a minimum of two field sources. The underlying field sources must be actual projected fields that represent actual schema fields and that must not be transformed and aggregated in any way, except for casting. The type of all the underlying field sources must be equivalent so that picking one of them would result in the same value type. + # Object with schema name: FieldSource + ], + "virtualFieldType": "A String", # Required. The type of the virtual field. + }, }, }, "fieldSourceValue": { # A source that can be used to represent a "field of data" within various parts of a structured query, such as in SELECT, WHERE, or ORDER BY clauses. The term "field of data" is used here because it is not limited to literal fields in the underlying data schema. # The field. This will be the field that is set as the Right Hand Side of the filter. @@ -196,6 +208,12 @@

Method Details

"type": "A String", # Required. Specifies the aggregation function. Use one of the following string identifiers: "average": Computes the average (AVG). Applies only to numeric values. "count": Counts the number of values (COUNT). "count-distinct": Counts the number of distinct values (COUNT DISTINCT). "count-distinct-approx": Approximates the count of distinct values (APPROX_COUNT_DISTINCT). "max": Finds the maximum value (MAX). Applies only to numeric values. "min": Finds the minimum value (MIN). Applies only to numeric values. "sum": Computes the sum (SUM). Applies only to numeric values. }, "truncationGranularity": "A String", # The truncation granularity when grouping by a time/date field. This will be used to truncate the field to the granularity specified. This can be either a date or a time granularity found at https://cloud.google.com/bigquery/docs/reference/standard-sql/timestamp_functions#timestamp_trunc_granularity_date and https://cloud.google.com/bigquery/docs/reference/standard-sql/timestamp_functions#timestamp_trunc_granularity_time respectively. + "virtualField": { # A virtual field is a field that is not physically present in the underlying data schema, but is created through specific operations within the query builder model based on other fields in the schema. # Optional. A virtual field definition, used in place of field to define a field that is computed from other fields rather than being directly present in the data schema.For example, a virtual field can be defined using COALESCE to select the first non-null value from a list of fields.If virtual_field is set, field must not be set. + "underlyingFieldSources": [ # The field sources that will be used to create the virtual field, based on the semantics of the virtual field type.The field sources must follow these rules, based on the virtual field type: - For VIRTUAL_FIELD_TYPE_UNSPECIFIED, this field must be empty. - For COALESCE, this field must be non-empty and include a minimum of two field sources. The underlying field sources must be actual projected fields that represent actual schema fields and that must not be transformed and aggregated in any way, except for casting. The type of all the underlying field sources must be equivalent so that picking one of them would result in the same value type. + # Object with schema name: FieldSource + ], + "virtualFieldType": "A String", # Required. The type of the virtual field. + }, }, }, "isNegation": True or False, # Determines if the NOT flag should be added to the comparator. @@ -225,6 +243,12 @@

Method Details

"type": "A String", # Required. Specifies the aggregation function. Use one of the following string identifiers: "average": Computes the average (AVG). Applies only to numeric values. "count": Counts the number of values (COUNT). "count-distinct": Counts the number of distinct values (COUNT DISTINCT). "count-distinct-approx": Approximates the count of distinct values (APPROX_COUNT_DISTINCT). "max": Finds the maximum value (MAX). Applies only to numeric values. "min": Finds the minimum value (MIN). Applies only to numeric values. "sum": Computes the sum (SUM). Applies only to numeric values. }, "truncationGranularity": "A String", # The truncation granularity when grouping by a time/date field. This will be used to truncate the field to the granularity specified. This can be either a date or a time granularity found at https://cloud.google.com/bigquery/docs/reference/standard-sql/timestamp_functions#timestamp_trunc_granularity_date and https://cloud.google.com/bigquery/docs/reference/standard-sql/timestamp_functions#timestamp_trunc_granularity_time respectively. + "virtualField": { # A virtual field is a field that is not physically present in the underlying data schema, but is created through specific operations within the query builder model based on other fields in the schema. # Optional. A virtual field definition, used in place of field to define a field that is computed from other fields rather than being directly present in the data schema.For example, a virtual field can be defined using COALESCE to select the first non-null value from a list of fields.If virtual_field is set, field must not be set. + "underlyingFieldSources": [ # The field sources that will be used to create the virtual field, based on the semantics of the virtual field type.The field sources must follow these rules, based on the virtual field type: - For VIRTUAL_FIELD_TYPE_UNSPECIFIED, this field must be empty. - For COALESCE, this field must be non-empty and include a minimum of two field sources. The underlying field sources must be actual projected fields that represent actual schema fields and that must not be transformed and aggregated in any way, except for casting. The type of all the underlying field sources must be equivalent so that picking one of them would result in the same value type. + # Object with schema name: FieldSource + ], + "virtualFieldType": "A String", # Required. The type of the virtual field. + }, }, }, "sortOrderDirection": "A String", # The sort order to use for the query. @@ -287,6 +311,12 @@

Method Details

"type": "A String", # Required. Specifies the aggregation function. Use one of the following string identifiers: "average": Computes the average (AVG). Applies only to numeric values. "count": Counts the number of values (COUNT). "count-distinct": Counts the number of distinct values (COUNT DISTINCT). "count-distinct-approx": Approximates the count of distinct values (APPROX_COUNT_DISTINCT). "max": Finds the maximum value (MAX). Applies only to numeric values. "min": Finds the minimum value (MIN). Applies only to numeric values. "sum": Computes the sum (SUM). Applies only to numeric values. }, "truncationGranularity": "A String", # The truncation granularity when grouping by a time/date field. This will be used to truncate the field to the granularity specified. This can be either a date or a time granularity found at https://cloud.google.com/bigquery/docs/reference/standard-sql/timestamp_functions#timestamp_trunc_granularity_date and https://cloud.google.com/bigquery/docs/reference/standard-sql/timestamp_functions#timestamp_trunc_granularity_time respectively. + "virtualField": { # A virtual field is a field that is not physically present in the underlying data schema, but is created through specific operations within the query builder model based on other fields in the schema. # Optional. A virtual field definition, used in place of field to define a field that is computed from other fields rather than being directly present in the data schema.For example, a virtual field can be defined using COALESCE to select the first non-null value from a list of fields.If virtual_field is set, field must not be set. + "underlyingFieldSources": [ # The field sources that will be used to create the virtual field, based on the semantics of the virtual field type.The field sources must follow these rules, based on the virtual field type: - For VIRTUAL_FIELD_TYPE_UNSPECIFIED, this field must be empty. - For COALESCE, this field must be non-empty and include a minimum of two field sources. The underlying field sources must be actual projected fields that represent actual schema fields and that must not be transformed and aggregated in any way, except for casting. The type of all the underlying field sources must be equivalent so that picking one of them would result in the same value type. + # Object with schema name: FieldSource + ], + "virtualFieldType": "A String", # Required. The type of the virtual field. + }, }, }, ], @@ -315,6 +345,12 @@

Method Details

"type": "A String", # Required. Specifies the aggregation function. Use one of the following string identifiers: "average": Computes the average (AVG). Applies only to numeric values. "count": Counts the number of values (COUNT). "count-distinct": Counts the number of distinct values (COUNT DISTINCT). "count-distinct-approx": Approximates the count of distinct values (APPROX_COUNT_DISTINCT). "max": Finds the maximum value (MAX). Applies only to numeric values. "min": Finds the minimum value (MIN). Applies only to numeric values. "sum": Computes the sum (SUM). Applies only to numeric values. }, "truncationGranularity": "A String", # The truncation granularity when grouping by a time/date field. This will be used to truncate the field to the granularity specified. This can be either a date or a time granularity found at https://cloud.google.com/bigquery/docs/reference/standard-sql/timestamp_functions#timestamp_trunc_granularity_date and https://cloud.google.com/bigquery/docs/reference/standard-sql/timestamp_functions#timestamp_trunc_granularity_time respectively. + "virtualField": { # A virtual field is a field that is not physically present in the underlying data schema, but is created through specific operations within the query builder model based on other fields in the schema. # Optional. A virtual field definition, used in place of field to define a field that is computed from other fields rather than being directly present in the data schema.For example, a virtual field can be defined using COALESCE to select the first non-null value from a list of fields.If virtual_field is set, field must not be set. + "underlyingFieldSources": [ # The field sources that will be used to create the virtual field, based on the semantics of the virtual field type.The field sources must follow these rules, based on the virtual field type: - For VIRTUAL_FIELD_TYPE_UNSPECIFIED, this field must be empty. - For COALESCE, this field must be non-empty and include a minimum of two field sources. The underlying field sources must be actual projected fields that represent actual schema fields and that must not be transformed and aggregated in any way, except for casting. The type of all the underlying field sources must be equivalent so that picking one of them would result in the same value type. + # Object with schema name: FieldSource + ], + "virtualFieldType": "A String", # Required. The type of the virtual field. + }, }, }, "fieldSourceValue": { # A source that can be used to represent a "field of data" within various parts of a structured query, such as in SELECT, WHERE, or ORDER BY clauses. The term "field of data" is used here because it is not limited to literal fields in the underlying data schema. # The field. This will be the field that is set as the Right Hand Side of the filter. @@ -336,6 +372,12 @@

Method Details

"type": "A String", # Required. Specifies the aggregation function. Use one of the following string identifiers: "average": Computes the average (AVG). Applies only to numeric values. "count": Counts the number of values (COUNT). "count-distinct": Counts the number of distinct values (COUNT DISTINCT). "count-distinct-approx": Approximates the count of distinct values (APPROX_COUNT_DISTINCT). "max": Finds the maximum value (MAX). Applies only to numeric values. "min": Finds the minimum value (MIN). Applies only to numeric values. "sum": Computes the sum (SUM). Applies only to numeric values. }, "truncationGranularity": "A String", # The truncation granularity when grouping by a time/date field. This will be used to truncate the field to the granularity specified. This can be either a date or a time granularity found at https://cloud.google.com/bigquery/docs/reference/standard-sql/timestamp_functions#timestamp_trunc_granularity_date and https://cloud.google.com/bigquery/docs/reference/standard-sql/timestamp_functions#timestamp_trunc_granularity_time respectively. + "virtualField": { # A virtual field is a field that is not physically present in the underlying data schema, but is created through specific operations within the query builder model based on other fields in the schema. # Optional. A virtual field definition, used in place of field to define a field that is computed from other fields rather than being directly present in the data schema.For example, a virtual field can be defined using COALESCE to select the first non-null value from a list of fields.If virtual_field is set, field must not be set. + "underlyingFieldSources": [ # The field sources that will be used to create the virtual field, based on the semantics of the virtual field type.The field sources must follow these rules, based on the virtual field type: - For VIRTUAL_FIELD_TYPE_UNSPECIFIED, this field must be empty. - For COALESCE, this field must be non-empty and include a minimum of two field sources. The underlying field sources must be actual projected fields that represent actual schema fields and that must not be transformed and aggregated in any way, except for casting. The type of all the underlying field sources must be equivalent so that picking one of them would result in the same value type. + # Object with schema name: FieldSource + ], + "virtualFieldType": "A String", # Required. The type of the virtual field. + }, }, }, "isNegation": True or False, # Determines if the NOT flag should be added to the comparator. @@ -365,6 +407,12 @@

Method Details

"type": "A String", # Required. Specifies the aggregation function. Use one of the following string identifiers: "average": Computes the average (AVG). Applies only to numeric values. "count": Counts the number of values (COUNT). "count-distinct": Counts the number of distinct values (COUNT DISTINCT). "count-distinct-approx": Approximates the count of distinct values (APPROX_COUNT_DISTINCT). "max": Finds the maximum value (MAX). Applies only to numeric values. "min": Finds the minimum value (MIN). Applies only to numeric values. "sum": Computes the sum (SUM). Applies only to numeric values. }, "truncationGranularity": "A String", # The truncation granularity when grouping by a time/date field. This will be used to truncate the field to the granularity specified. This can be either a date or a time granularity found at https://cloud.google.com/bigquery/docs/reference/standard-sql/timestamp_functions#timestamp_trunc_granularity_date and https://cloud.google.com/bigquery/docs/reference/standard-sql/timestamp_functions#timestamp_trunc_granularity_time respectively. + "virtualField": { # A virtual field is a field that is not physically present in the underlying data schema, but is created through specific operations within the query builder model based on other fields in the schema. # Optional. A virtual field definition, used in place of field to define a field that is computed from other fields rather than being directly present in the data schema.For example, a virtual field can be defined using COALESCE to select the first non-null value from a list of fields.If virtual_field is set, field must not be set. + "underlyingFieldSources": [ # The field sources that will be used to create the virtual field, based on the semantics of the virtual field type.The field sources must follow these rules, based on the virtual field type: - For VIRTUAL_FIELD_TYPE_UNSPECIFIED, this field must be empty. - For COALESCE, this field must be non-empty and include a minimum of two field sources. The underlying field sources must be actual projected fields that represent actual schema fields and that must not be transformed and aggregated in any way, except for casting. The type of all the underlying field sources must be equivalent so that picking one of them would result in the same value type. + # Object with schema name: FieldSource + ], + "virtualFieldType": "A String", # Required. The type of the virtual field. + }, }, }, "sortOrderDirection": "A String", # The sort order to use for the query. @@ -451,6 +499,12 @@

Method Details

"type": "A String", # Required. Specifies the aggregation function. Use one of the following string identifiers: "average": Computes the average (AVG). Applies only to numeric values. "count": Counts the number of values (COUNT). "count-distinct": Counts the number of distinct values (COUNT DISTINCT). "count-distinct-approx": Approximates the count of distinct values (APPROX_COUNT_DISTINCT). "max": Finds the maximum value (MAX). Applies only to numeric values. "min": Finds the minimum value (MIN). Applies only to numeric values. "sum": Computes the sum (SUM). Applies only to numeric values. }, "truncationGranularity": "A String", # The truncation granularity when grouping by a time/date field. This will be used to truncate the field to the granularity specified. This can be either a date or a time granularity found at https://cloud.google.com/bigquery/docs/reference/standard-sql/timestamp_functions#timestamp_trunc_granularity_date and https://cloud.google.com/bigquery/docs/reference/standard-sql/timestamp_functions#timestamp_trunc_granularity_time respectively. + "virtualField": { # A virtual field is a field that is not physically present in the underlying data schema, but is created through specific operations within the query builder model based on other fields in the schema. # Optional. A virtual field definition, used in place of field to define a field that is computed from other fields rather than being directly present in the data schema.For example, a virtual field can be defined using COALESCE to select the first non-null value from a list of fields.If virtual_field is set, field must not be set. + "underlyingFieldSources": [ # The field sources that will be used to create the virtual field, based on the semantics of the virtual field type.The field sources must follow these rules, based on the virtual field type: - For VIRTUAL_FIELD_TYPE_UNSPECIFIED, this field must be empty. - For COALESCE, this field must be non-empty and include a minimum of two field sources. The underlying field sources must be actual projected fields that represent actual schema fields and that must not be transformed and aggregated in any way, except for casting. The type of all the underlying field sources must be equivalent so that picking one of them would result in the same value type. + # Object with schema name: FieldSource + ], + "virtualFieldType": "A String", # Required. The type of the virtual field. + }, }, }, ], @@ -479,6 +533,12 @@

Method Details

"type": "A String", # Required. Specifies the aggregation function. Use one of the following string identifiers: "average": Computes the average (AVG). Applies only to numeric values. "count": Counts the number of values (COUNT). "count-distinct": Counts the number of distinct values (COUNT DISTINCT). "count-distinct-approx": Approximates the count of distinct values (APPROX_COUNT_DISTINCT). "max": Finds the maximum value (MAX). Applies only to numeric values. "min": Finds the minimum value (MIN). Applies only to numeric values. "sum": Computes the sum (SUM). Applies only to numeric values. }, "truncationGranularity": "A String", # The truncation granularity when grouping by a time/date field. This will be used to truncate the field to the granularity specified. This can be either a date or a time granularity found at https://cloud.google.com/bigquery/docs/reference/standard-sql/timestamp_functions#timestamp_trunc_granularity_date and https://cloud.google.com/bigquery/docs/reference/standard-sql/timestamp_functions#timestamp_trunc_granularity_time respectively. + "virtualField": { # A virtual field is a field that is not physically present in the underlying data schema, but is created through specific operations within the query builder model based on other fields in the schema. # Optional. A virtual field definition, used in place of field to define a field that is computed from other fields rather than being directly present in the data schema.For example, a virtual field can be defined using COALESCE to select the first non-null value from a list of fields.If virtual_field is set, field must not be set. + "underlyingFieldSources": [ # The field sources that will be used to create the virtual field, based on the semantics of the virtual field type.The field sources must follow these rules, based on the virtual field type: - For VIRTUAL_FIELD_TYPE_UNSPECIFIED, this field must be empty. - For COALESCE, this field must be non-empty and include a minimum of two field sources. The underlying field sources must be actual projected fields that represent actual schema fields and that must not be transformed and aggregated in any way, except for casting. The type of all the underlying field sources must be equivalent so that picking one of them would result in the same value type. + # Object with schema name: FieldSource + ], + "virtualFieldType": "A String", # Required. The type of the virtual field. + }, }, }, "fieldSourceValue": { # A source that can be used to represent a "field of data" within various parts of a structured query, such as in SELECT, WHERE, or ORDER BY clauses. The term "field of data" is used here because it is not limited to literal fields in the underlying data schema. # The field. This will be the field that is set as the Right Hand Side of the filter. @@ -500,6 +560,12 @@

Method Details

"type": "A String", # Required. Specifies the aggregation function. Use one of the following string identifiers: "average": Computes the average (AVG). Applies only to numeric values. "count": Counts the number of values (COUNT). "count-distinct": Counts the number of distinct values (COUNT DISTINCT). "count-distinct-approx": Approximates the count of distinct values (APPROX_COUNT_DISTINCT). "max": Finds the maximum value (MAX). Applies only to numeric values. "min": Finds the minimum value (MIN). Applies only to numeric values. "sum": Computes the sum (SUM). Applies only to numeric values. }, "truncationGranularity": "A String", # The truncation granularity when grouping by a time/date field. This will be used to truncate the field to the granularity specified. This can be either a date or a time granularity found at https://cloud.google.com/bigquery/docs/reference/standard-sql/timestamp_functions#timestamp_trunc_granularity_date and https://cloud.google.com/bigquery/docs/reference/standard-sql/timestamp_functions#timestamp_trunc_granularity_time respectively. + "virtualField": { # A virtual field is a field that is not physically present in the underlying data schema, but is created through specific operations within the query builder model based on other fields in the schema. # Optional. A virtual field definition, used in place of field to define a field that is computed from other fields rather than being directly present in the data schema.For example, a virtual field can be defined using COALESCE to select the first non-null value from a list of fields.If virtual_field is set, field must not be set. + "underlyingFieldSources": [ # The field sources that will be used to create the virtual field, based on the semantics of the virtual field type.The field sources must follow these rules, based on the virtual field type: - For VIRTUAL_FIELD_TYPE_UNSPECIFIED, this field must be empty. - For COALESCE, this field must be non-empty and include a minimum of two field sources. The underlying field sources must be actual projected fields that represent actual schema fields and that must not be transformed and aggregated in any way, except for casting. The type of all the underlying field sources must be equivalent so that picking one of them would result in the same value type. + # Object with schema name: FieldSource + ], + "virtualFieldType": "A String", # Required. The type of the virtual field. + }, }, }, "isNegation": True or False, # Determines if the NOT flag should be added to the comparator. @@ -529,6 +595,12 @@

Method Details

"type": "A String", # Required. Specifies the aggregation function. Use one of the following string identifiers: "average": Computes the average (AVG). Applies only to numeric values. "count": Counts the number of values (COUNT). "count-distinct": Counts the number of distinct values (COUNT DISTINCT). "count-distinct-approx": Approximates the count of distinct values (APPROX_COUNT_DISTINCT). "max": Finds the maximum value (MAX). Applies only to numeric values. "min": Finds the minimum value (MIN). Applies only to numeric values. "sum": Computes the sum (SUM). Applies only to numeric values. }, "truncationGranularity": "A String", # The truncation granularity when grouping by a time/date field. This will be used to truncate the field to the granularity specified. This can be either a date or a time granularity found at https://cloud.google.com/bigquery/docs/reference/standard-sql/timestamp_functions#timestamp_trunc_granularity_date and https://cloud.google.com/bigquery/docs/reference/standard-sql/timestamp_functions#timestamp_trunc_granularity_time respectively. + "virtualField": { # A virtual field is a field that is not physically present in the underlying data schema, but is created through specific operations within the query builder model based on other fields in the schema. # Optional. A virtual field definition, used in place of field to define a field that is computed from other fields rather than being directly present in the data schema.For example, a virtual field can be defined using COALESCE to select the first non-null value from a list of fields.If virtual_field is set, field must not be set. + "underlyingFieldSources": [ # The field sources that will be used to create the virtual field, based on the semantics of the virtual field type.The field sources must follow these rules, based on the virtual field type: - For VIRTUAL_FIELD_TYPE_UNSPECIFIED, this field must be empty. - For COALESCE, this field must be non-empty and include a minimum of two field sources. The underlying field sources must be actual projected fields that represent actual schema fields and that must not be transformed and aggregated in any way, except for casting. The type of all the underlying field sources must be equivalent so that picking one of them would result in the same value type. + # Object with schema name: FieldSource + ], + "virtualFieldType": "A String", # Required. The type of the virtual field. + }, }, }, "sortOrderDirection": "A String", # The sort order to use for the query. @@ -603,6 +675,12 @@

Method Details

"type": "A String", # Required. Specifies the aggregation function. Use one of the following string identifiers: "average": Computes the average (AVG). Applies only to numeric values. "count": Counts the number of values (COUNT). "count-distinct": Counts the number of distinct values (COUNT DISTINCT). "count-distinct-approx": Approximates the count of distinct values (APPROX_COUNT_DISTINCT). "max": Finds the maximum value (MAX). Applies only to numeric values. "min": Finds the minimum value (MIN). Applies only to numeric values. "sum": Computes the sum (SUM). Applies only to numeric values. }, "truncationGranularity": "A String", # The truncation granularity when grouping by a time/date field. This will be used to truncate the field to the granularity specified. This can be either a date or a time granularity found at https://cloud.google.com/bigquery/docs/reference/standard-sql/timestamp_functions#timestamp_trunc_granularity_date and https://cloud.google.com/bigquery/docs/reference/standard-sql/timestamp_functions#timestamp_trunc_granularity_time respectively. + "virtualField": { # A virtual field is a field that is not physically present in the underlying data schema, but is created through specific operations within the query builder model based on other fields in the schema. # Optional. A virtual field definition, used in place of field to define a field that is computed from other fields rather than being directly present in the data schema.For example, a virtual field can be defined using COALESCE to select the first non-null value from a list of fields.If virtual_field is set, field must not be set. + "underlyingFieldSources": [ # The field sources that will be used to create the virtual field, based on the semantics of the virtual field type.The field sources must follow these rules, based on the virtual field type: - For VIRTUAL_FIELD_TYPE_UNSPECIFIED, this field must be empty. - For COALESCE, this field must be non-empty and include a minimum of two field sources. The underlying field sources must be actual projected fields that represent actual schema fields and that must not be transformed and aggregated in any way, except for casting. The type of all the underlying field sources must be equivalent so that picking one of them would result in the same value type. + # Object with schema name: FieldSource + ], + "virtualFieldType": "A String", # Required. The type of the virtual field. + }, }, }, ], @@ -631,6 +709,12 @@

Method Details

"type": "A String", # Required. Specifies the aggregation function. Use one of the following string identifiers: "average": Computes the average (AVG). Applies only to numeric values. "count": Counts the number of values (COUNT). "count-distinct": Counts the number of distinct values (COUNT DISTINCT). "count-distinct-approx": Approximates the count of distinct values (APPROX_COUNT_DISTINCT). "max": Finds the maximum value (MAX). Applies only to numeric values. "min": Finds the minimum value (MIN). Applies only to numeric values. "sum": Computes the sum (SUM). Applies only to numeric values. }, "truncationGranularity": "A String", # The truncation granularity when grouping by a time/date field. This will be used to truncate the field to the granularity specified. This can be either a date or a time granularity found at https://cloud.google.com/bigquery/docs/reference/standard-sql/timestamp_functions#timestamp_trunc_granularity_date and https://cloud.google.com/bigquery/docs/reference/standard-sql/timestamp_functions#timestamp_trunc_granularity_time respectively. + "virtualField": { # A virtual field is a field that is not physically present in the underlying data schema, but is created through specific operations within the query builder model based on other fields in the schema. # Optional. A virtual field definition, used in place of field to define a field that is computed from other fields rather than being directly present in the data schema.For example, a virtual field can be defined using COALESCE to select the first non-null value from a list of fields.If virtual_field is set, field must not be set. + "underlyingFieldSources": [ # The field sources that will be used to create the virtual field, based on the semantics of the virtual field type.The field sources must follow these rules, based on the virtual field type: - For VIRTUAL_FIELD_TYPE_UNSPECIFIED, this field must be empty. - For COALESCE, this field must be non-empty and include a minimum of two field sources. The underlying field sources must be actual projected fields that represent actual schema fields and that must not be transformed and aggregated in any way, except for casting. The type of all the underlying field sources must be equivalent so that picking one of them would result in the same value type. + # Object with schema name: FieldSource + ], + "virtualFieldType": "A String", # Required. The type of the virtual field. + }, }, }, "fieldSourceValue": { # A source that can be used to represent a "field of data" within various parts of a structured query, such as in SELECT, WHERE, or ORDER BY clauses. The term "field of data" is used here because it is not limited to literal fields in the underlying data schema. # The field. This will be the field that is set as the Right Hand Side of the filter. @@ -652,6 +736,12 @@

Method Details

"type": "A String", # Required. Specifies the aggregation function. Use one of the following string identifiers: "average": Computes the average (AVG). Applies only to numeric values. "count": Counts the number of values (COUNT). "count-distinct": Counts the number of distinct values (COUNT DISTINCT). "count-distinct-approx": Approximates the count of distinct values (APPROX_COUNT_DISTINCT). "max": Finds the maximum value (MAX). Applies only to numeric values. "min": Finds the minimum value (MIN). Applies only to numeric values. "sum": Computes the sum (SUM). Applies only to numeric values. }, "truncationGranularity": "A String", # The truncation granularity when grouping by a time/date field. This will be used to truncate the field to the granularity specified. This can be either a date or a time granularity found at https://cloud.google.com/bigquery/docs/reference/standard-sql/timestamp_functions#timestamp_trunc_granularity_date and https://cloud.google.com/bigquery/docs/reference/standard-sql/timestamp_functions#timestamp_trunc_granularity_time respectively. + "virtualField": { # A virtual field is a field that is not physically present in the underlying data schema, but is created through specific operations within the query builder model based on other fields in the schema. # Optional. A virtual field definition, used in place of field to define a field that is computed from other fields rather than being directly present in the data schema.For example, a virtual field can be defined using COALESCE to select the first non-null value from a list of fields.If virtual_field is set, field must not be set. + "underlyingFieldSources": [ # The field sources that will be used to create the virtual field, based on the semantics of the virtual field type.The field sources must follow these rules, based on the virtual field type: - For VIRTUAL_FIELD_TYPE_UNSPECIFIED, this field must be empty. - For COALESCE, this field must be non-empty and include a minimum of two field sources. The underlying field sources must be actual projected fields that represent actual schema fields and that must not be transformed and aggregated in any way, except for casting. The type of all the underlying field sources must be equivalent so that picking one of them would result in the same value type. + # Object with schema name: FieldSource + ], + "virtualFieldType": "A String", # Required. The type of the virtual field. + }, }, }, "isNegation": True or False, # Determines if the NOT flag should be added to the comparator. @@ -681,6 +771,12 @@

Method Details

"type": "A String", # Required. Specifies the aggregation function. Use one of the following string identifiers: "average": Computes the average (AVG). Applies only to numeric values. "count": Counts the number of values (COUNT). "count-distinct": Counts the number of distinct values (COUNT DISTINCT). "count-distinct-approx": Approximates the count of distinct values (APPROX_COUNT_DISTINCT). "max": Finds the maximum value (MAX). Applies only to numeric values. "min": Finds the minimum value (MIN). Applies only to numeric values. "sum": Computes the sum (SUM). Applies only to numeric values. }, "truncationGranularity": "A String", # The truncation granularity when grouping by a time/date field. This will be used to truncate the field to the granularity specified. This can be either a date or a time granularity found at https://cloud.google.com/bigquery/docs/reference/standard-sql/timestamp_functions#timestamp_trunc_granularity_date and https://cloud.google.com/bigquery/docs/reference/standard-sql/timestamp_functions#timestamp_trunc_granularity_time respectively. + "virtualField": { # A virtual field is a field that is not physically present in the underlying data schema, but is created through specific operations within the query builder model based on other fields in the schema. # Optional. A virtual field definition, used in place of field to define a field that is computed from other fields rather than being directly present in the data schema.For example, a virtual field can be defined using COALESCE to select the first non-null value from a list of fields.If virtual_field is set, field must not be set. + "underlyingFieldSources": [ # The field sources that will be used to create the virtual field, based on the semantics of the virtual field type.The field sources must follow these rules, based on the virtual field type: - For VIRTUAL_FIELD_TYPE_UNSPECIFIED, this field must be empty. - For COALESCE, this field must be non-empty and include a minimum of two field sources. The underlying field sources must be actual projected fields that represent actual schema fields and that must not be transformed and aggregated in any way, except for casting. The type of all the underlying field sources must be equivalent so that picking one of them would result in the same value type. + # Object with schema name: FieldSource + ], + "virtualFieldType": "A String", # Required. The type of the virtual field. + }, }, }, "sortOrderDirection": "A String", # The sort order to use for the query. @@ -763,6 +859,12 @@

Method Details

"type": "A String", # Required. Specifies the aggregation function. Use one of the following string identifiers: "average": Computes the average (AVG). Applies only to numeric values. "count": Counts the number of values (COUNT). "count-distinct": Counts the number of distinct values (COUNT DISTINCT). "count-distinct-approx": Approximates the count of distinct values (APPROX_COUNT_DISTINCT). "max": Finds the maximum value (MAX). Applies only to numeric values. "min": Finds the minimum value (MIN). Applies only to numeric values. "sum": Computes the sum (SUM). Applies only to numeric values. }, "truncationGranularity": "A String", # The truncation granularity when grouping by a time/date field. This will be used to truncate the field to the granularity specified. This can be either a date or a time granularity found at https://cloud.google.com/bigquery/docs/reference/standard-sql/timestamp_functions#timestamp_trunc_granularity_date and https://cloud.google.com/bigquery/docs/reference/standard-sql/timestamp_functions#timestamp_trunc_granularity_time respectively. + "virtualField": { # A virtual field is a field that is not physically present in the underlying data schema, but is created through specific operations within the query builder model based on other fields in the schema. # Optional. A virtual field definition, used in place of field to define a field that is computed from other fields rather than being directly present in the data schema.For example, a virtual field can be defined using COALESCE to select the first non-null value from a list of fields.If virtual_field is set, field must not be set. + "underlyingFieldSources": [ # The field sources that will be used to create the virtual field, based on the semantics of the virtual field type.The field sources must follow these rules, based on the virtual field type: - For VIRTUAL_FIELD_TYPE_UNSPECIFIED, this field must be empty. - For COALESCE, this field must be non-empty and include a minimum of two field sources. The underlying field sources must be actual projected fields that represent actual schema fields and that must not be transformed and aggregated in any way, except for casting. The type of all the underlying field sources must be equivalent so that picking one of them would result in the same value type. + # Object with schema name: FieldSource + ], + "virtualFieldType": "A String", # Required. The type of the virtual field. + }, }, }, ], @@ -791,6 +893,12 @@

Method Details

"type": "A String", # Required. Specifies the aggregation function. Use one of the following string identifiers: "average": Computes the average (AVG). Applies only to numeric values. "count": Counts the number of values (COUNT). "count-distinct": Counts the number of distinct values (COUNT DISTINCT). "count-distinct-approx": Approximates the count of distinct values (APPROX_COUNT_DISTINCT). "max": Finds the maximum value (MAX). Applies only to numeric values. "min": Finds the minimum value (MIN). Applies only to numeric values. "sum": Computes the sum (SUM). Applies only to numeric values. }, "truncationGranularity": "A String", # The truncation granularity when grouping by a time/date field. This will be used to truncate the field to the granularity specified. This can be either a date or a time granularity found at https://cloud.google.com/bigquery/docs/reference/standard-sql/timestamp_functions#timestamp_trunc_granularity_date and https://cloud.google.com/bigquery/docs/reference/standard-sql/timestamp_functions#timestamp_trunc_granularity_time respectively. + "virtualField": { # A virtual field is a field that is not physically present in the underlying data schema, but is created through specific operations within the query builder model based on other fields in the schema. # Optional. A virtual field definition, used in place of field to define a field that is computed from other fields rather than being directly present in the data schema.For example, a virtual field can be defined using COALESCE to select the first non-null value from a list of fields.If virtual_field is set, field must not be set. + "underlyingFieldSources": [ # The field sources that will be used to create the virtual field, based on the semantics of the virtual field type.The field sources must follow these rules, based on the virtual field type: - For VIRTUAL_FIELD_TYPE_UNSPECIFIED, this field must be empty. - For COALESCE, this field must be non-empty and include a minimum of two field sources. The underlying field sources must be actual projected fields that represent actual schema fields and that must not be transformed and aggregated in any way, except for casting. The type of all the underlying field sources must be equivalent so that picking one of them would result in the same value type. + # Object with schema name: FieldSource + ], + "virtualFieldType": "A String", # Required. The type of the virtual field. + }, }, }, "fieldSourceValue": { # A source that can be used to represent a "field of data" within various parts of a structured query, such as in SELECT, WHERE, or ORDER BY clauses. The term "field of data" is used here because it is not limited to literal fields in the underlying data schema. # The field. This will be the field that is set as the Right Hand Side of the filter. @@ -812,6 +920,12 @@

Method Details

"type": "A String", # Required. Specifies the aggregation function. Use one of the following string identifiers: "average": Computes the average (AVG). Applies only to numeric values. "count": Counts the number of values (COUNT). "count-distinct": Counts the number of distinct values (COUNT DISTINCT). "count-distinct-approx": Approximates the count of distinct values (APPROX_COUNT_DISTINCT). "max": Finds the maximum value (MAX). Applies only to numeric values. "min": Finds the minimum value (MIN). Applies only to numeric values. "sum": Computes the sum (SUM). Applies only to numeric values. }, "truncationGranularity": "A String", # The truncation granularity when grouping by a time/date field. This will be used to truncate the field to the granularity specified. This can be either a date or a time granularity found at https://cloud.google.com/bigquery/docs/reference/standard-sql/timestamp_functions#timestamp_trunc_granularity_date and https://cloud.google.com/bigquery/docs/reference/standard-sql/timestamp_functions#timestamp_trunc_granularity_time respectively. + "virtualField": { # A virtual field is a field that is not physically present in the underlying data schema, but is created through specific operations within the query builder model based on other fields in the schema. # Optional. A virtual field definition, used in place of field to define a field that is computed from other fields rather than being directly present in the data schema.For example, a virtual field can be defined using COALESCE to select the first non-null value from a list of fields.If virtual_field is set, field must not be set. + "underlyingFieldSources": [ # The field sources that will be used to create the virtual field, based on the semantics of the virtual field type.The field sources must follow these rules, based on the virtual field type: - For VIRTUAL_FIELD_TYPE_UNSPECIFIED, this field must be empty. - For COALESCE, this field must be non-empty and include a minimum of two field sources. The underlying field sources must be actual projected fields that represent actual schema fields and that must not be transformed and aggregated in any way, except for casting. The type of all the underlying field sources must be equivalent so that picking one of them would result in the same value type. + # Object with schema name: FieldSource + ], + "virtualFieldType": "A String", # Required. The type of the virtual field. + }, }, }, "isNegation": True or False, # Determines if the NOT flag should be added to the comparator. @@ -841,6 +955,12 @@

Method Details

"type": "A String", # Required. Specifies the aggregation function. Use one of the following string identifiers: "average": Computes the average (AVG). Applies only to numeric values. "count": Counts the number of values (COUNT). "count-distinct": Counts the number of distinct values (COUNT DISTINCT). "count-distinct-approx": Approximates the count of distinct values (APPROX_COUNT_DISTINCT). "max": Finds the maximum value (MAX). Applies only to numeric values. "min": Finds the minimum value (MIN). Applies only to numeric values. "sum": Computes the sum (SUM). Applies only to numeric values. }, "truncationGranularity": "A String", # The truncation granularity when grouping by a time/date field. This will be used to truncate the field to the granularity specified. This can be either a date or a time granularity found at https://cloud.google.com/bigquery/docs/reference/standard-sql/timestamp_functions#timestamp_trunc_granularity_date and https://cloud.google.com/bigquery/docs/reference/standard-sql/timestamp_functions#timestamp_trunc_granularity_time respectively. + "virtualField": { # A virtual field is a field that is not physically present in the underlying data schema, but is created through specific operations within the query builder model based on other fields in the schema. # Optional. A virtual field definition, used in place of field to define a field that is computed from other fields rather than being directly present in the data schema.For example, a virtual field can be defined using COALESCE to select the first non-null value from a list of fields.If virtual_field is set, field must not be set. + "underlyingFieldSources": [ # The field sources that will be used to create the virtual field, based on the semantics of the virtual field type.The field sources must follow these rules, based on the virtual field type: - For VIRTUAL_FIELD_TYPE_UNSPECIFIED, this field must be empty. - For COALESCE, this field must be non-empty and include a minimum of two field sources. The underlying field sources must be actual projected fields that represent actual schema fields and that must not be transformed and aggregated in any way, except for casting. The type of all the underlying field sources must be equivalent so that picking one of them would result in the same value type. + # Object with schema name: FieldSource + ], + "virtualFieldType": "A String", # Required. The type of the virtual field. + }, }, }, "sortOrderDirection": "A String", # The sort order to use for the query. @@ -903,6 +1023,12 @@

Method Details

"type": "A String", # Required. Specifies the aggregation function. Use one of the following string identifiers: "average": Computes the average (AVG). Applies only to numeric values. "count": Counts the number of values (COUNT). "count-distinct": Counts the number of distinct values (COUNT DISTINCT). "count-distinct-approx": Approximates the count of distinct values (APPROX_COUNT_DISTINCT). "max": Finds the maximum value (MAX). Applies only to numeric values. "min": Finds the minimum value (MIN). Applies only to numeric values. "sum": Computes the sum (SUM). Applies only to numeric values. }, "truncationGranularity": "A String", # The truncation granularity when grouping by a time/date field. This will be used to truncate the field to the granularity specified. This can be either a date or a time granularity found at https://cloud.google.com/bigquery/docs/reference/standard-sql/timestamp_functions#timestamp_trunc_granularity_date and https://cloud.google.com/bigquery/docs/reference/standard-sql/timestamp_functions#timestamp_trunc_granularity_time respectively. + "virtualField": { # A virtual field is a field that is not physically present in the underlying data schema, but is created through specific operations within the query builder model based on other fields in the schema. # Optional. A virtual field definition, used in place of field to define a field that is computed from other fields rather than being directly present in the data schema.For example, a virtual field can be defined using COALESCE to select the first non-null value from a list of fields.If virtual_field is set, field must not be set. + "underlyingFieldSources": [ # The field sources that will be used to create the virtual field, based on the semantics of the virtual field type.The field sources must follow these rules, based on the virtual field type: - For VIRTUAL_FIELD_TYPE_UNSPECIFIED, this field must be empty. - For COALESCE, this field must be non-empty and include a minimum of two field sources. The underlying field sources must be actual projected fields that represent actual schema fields and that must not be transformed and aggregated in any way, except for casting. The type of all the underlying field sources must be equivalent so that picking one of them would result in the same value type. + # Object with schema name: FieldSource + ], + "virtualFieldType": "A String", # Required. The type of the virtual field. + }, }, }, ], @@ -931,6 +1057,12 @@

Method Details

"type": "A String", # Required. Specifies the aggregation function. Use one of the following string identifiers: "average": Computes the average (AVG). Applies only to numeric values. "count": Counts the number of values (COUNT). "count-distinct": Counts the number of distinct values (COUNT DISTINCT). "count-distinct-approx": Approximates the count of distinct values (APPROX_COUNT_DISTINCT). "max": Finds the maximum value (MAX). Applies only to numeric values. "min": Finds the minimum value (MIN). Applies only to numeric values. "sum": Computes the sum (SUM). Applies only to numeric values. }, "truncationGranularity": "A String", # The truncation granularity when grouping by a time/date field. This will be used to truncate the field to the granularity specified. This can be either a date or a time granularity found at https://cloud.google.com/bigquery/docs/reference/standard-sql/timestamp_functions#timestamp_trunc_granularity_date and https://cloud.google.com/bigquery/docs/reference/standard-sql/timestamp_functions#timestamp_trunc_granularity_time respectively. + "virtualField": { # A virtual field is a field that is not physically present in the underlying data schema, but is created through specific operations within the query builder model based on other fields in the schema. # Optional. A virtual field definition, used in place of field to define a field that is computed from other fields rather than being directly present in the data schema.For example, a virtual field can be defined using COALESCE to select the first non-null value from a list of fields.If virtual_field is set, field must not be set. + "underlyingFieldSources": [ # The field sources that will be used to create the virtual field, based on the semantics of the virtual field type.The field sources must follow these rules, based on the virtual field type: - For VIRTUAL_FIELD_TYPE_UNSPECIFIED, this field must be empty. - For COALESCE, this field must be non-empty and include a minimum of two field sources. The underlying field sources must be actual projected fields that represent actual schema fields and that must not be transformed and aggregated in any way, except for casting. The type of all the underlying field sources must be equivalent so that picking one of them would result in the same value type. + # Object with schema name: FieldSource + ], + "virtualFieldType": "A String", # Required. The type of the virtual field. + }, }, }, "fieldSourceValue": { # A source that can be used to represent a "field of data" within various parts of a structured query, such as in SELECT, WHERE, or ORDER BY clauses. The term "field of data" is used here because it is not limited to literal fields in the underlying data schema. # The field. This will be the field that is set as the Right Hand Side of the filter. @@ -952,6 +1084,12 @@

Method Details

"type": "A String", # Required. Specifies the aggregation function. Use one of the following string identifiers: "average": Computes the average (AVG). Applies only to numeric values. "count": Counts the number of values (COUNT). "count-distinct": Counts the number of distinct values (COUNT DISTINCT). "count-distinct-approx": Approximates the count of distinct values (APPROX_COUNT_DISTINCT). "max": Finds the maximum value (MAX). Applies only to numeric values. "min": Finds the minimum value (MIN). Applies only to numeric values. "sum": Computes the sum (SUM). Applies only to numeric values. }, "truncationGranularity": "A String", # The truncation granularity when grouping by a time/date field. This will be used to truncate the field to the granularity specified. This can be either a date or a time granularity found at https://cloud.google.com/bigquery/docs/reference/standard-sql/timestamp_functions#timestamp_trunc_granularity_date and https://cloud.google.com/bigquery/docs/reference/standard-sql/timestamp_functions#timestamp_trunc_granularity_time respectively. + "virtualField": { # A virtual field is a field that is not physically present in the underlying data schema, but is created through specific operations within the query builder model based on other fields in the schema. # Optional. A virtual field definition, used in place of field to define a field that is computed from other fields rather than being directly present in the data schema.For example, a virtual field can be defined using COALESCE to select the first non-null value from a list of fields.If virtual_field is set, field must not be set. + "underlyingFieldSources": [ # The field sources that will be used to create the virtual field, based on the semantics of the virtual field type.The field sources must follow these rules, based on the virtual field type: - For VIRTUAL_FIELD_TYPE_UNSPECIFIED, this field must be empty. - For COALESCE, this field must be non-empty and include a minimum of two field sources. The underlying field sources must be actual projected fields that represent actual schema fields and that must not be transformed and aggregated in any way, except for casting. The type of all the underlying field sources must be equivalent so that picking one of them would result in the same value type. + # Object with schema name: FieldSource + ], + "virtualFieldType": "A String", # Required. The type of the virtual field. + }, }, }, "isNegation": True or False, # Determines if the NOT flag should be added to the comparator. @@ -981,6 +1119,12 @@

Method Details

"type": "A String", # Required. Specifies the aggregation function. Use one of the following string identifiers: "average": Computes the average (AVG). Applies only to numeric values. "count": Counts the number of values (COUNT). "count-distinct": Counts the number of distinct values (COUNT DISTINCT). "count-distinct-approx": Approximates the count of distinct values (APPROX_COUNT_DISTINCT). "max": Finds the maximum value (MAX). Applies only to numeric values. "min": Finds the minimum value (MIN). Applies only to numeric values. "sum": Computes the sum (SUM). Applies only to numeric values. }, "truncationGranularity": "A String", # The truncation granularity when grouping by a time/date field. This will be used to truncate the field to the granularity specified. This can be either a date or a time granularity found at https://cloud.google.com/bigquery/docs/reference/standard-sql/timestamp_functions#timestamp_trunc_granularity_date and https://cloud.google.com/bigquery/docs/reference/standard-sql/timestamp_functions#timestamp_trunc_granularity_time respectively. + "virtualField": { # A virtual field is a field that is not physically present in the underlying data schema, but is created through specific operations within the query builder model based on other fields in the schema. # Optional. A virtual field definition, used in place of field to define a field that is computed from other fields rather than being directly present in the data schema.For example, a virtual field can be defined using COALESCE to select the first non-null value from a list of fields.If virtual_field is set, field must not be set. + "underlyingFieldSources": [ # The field sources that will be used to create the virtual field, based on the semantics of the virtual field type.The field sources must follow these rules, based on the virtual field type: - For VIRTUAL_FIELD_TYPE_UNSPECIFIED, this field must be empty. - For COALESCE, this field must be non-empty and include a minimum of two field sources. The underlying field sources must be actual projected fields that represent actual schema fields and that must not be transformed and aggregated in any way, except for casting. The type of all the underlying field sources must be equivalent so that picking one of them would result in the same value type. + # Object with schema name: FieldSource + ], + "virtualFieldType": "A String", # Required. The type of the virtual field. + }, }, }, "sortOrderDirection": "A String", # The sort order to use for the query. diff --git a/docs/dyn/logging_v2.folders.locations.recentQueries.html b/docs/dyn/logging_v2.folders.locations.recentQueries.html index df6caf2a9a..f08addeb6c 100644 --- a/docs/dyn/logging_v2.folders.locations.recentQueries.html +++ b/docs/dyn/logging_v2.folders.locations.recentQueries.html @@ -144,6 +144,12 @@

Method Details

"type": "A String", # Required. Specifies the aggregation function. Use one of the following string identifiers: "average": Computes the average (AVG). Applies only to numeric values. "count": Counts the number of values (COUNT). "count-distinct": Counts the number of distinct values (COUNT DISTINCT). "count-distinct-approx": Approximates the count of distinct values (APPROX_COUNT_DISTINCT). "max": Finds the maximum value (MAX). Applies only to numeric values. "min": Finds the minimum value (MIN). Applies only to numeric values. "sum": Computes the sum (SUM). Applies only to numeric values. }, "truncationGranularity": "A String", # The truncation granularity when grouping by a time/date field. This will be used to truncate the field to the granularity specified. This can be either a date or a time granularity found at https://cloud.google.com/bigquery/docs/reference/standard-sql/timestamp_functions#timestamp_trunc_granularity_date and https://cloud.google.com/bigquery/docs/reference/standard-sql/timestamp_functions#timestamp_trunc_granularity_time respectively. + "virtualField": { # A virtual field is a field that is not physically present in the underlying data schema, but is created through specific operations within the query builder model based on other fields in the schema. # Optional. A virtual field definition, used in place of field to define a field that is computed from other fields rather than being directly present in the data schema.For example, a virtual field can be defined using COALESCE to select the first non-null value from a list of fields.If virtual_field is set, field must not be set. + "underlyingFieldSources": [ # The field sources that will be used to create the virtual field, based on the semantics of the virtual field type.The field sources must follow these rules, based on the virtual field type: - For VIRTUAL_FIELD_TYPE_UNSPECIFIED, this field must be empty. - For COALESCE, this field must be non-empty and include a minimum of two field sources. The underlying field sources must be actual projected fields that represent actual schema fields and that must not be transformed and aggregated in any way, except for casting. The type of all the underlying field sources must be equivalent so that picking one of them would result in the same value type. + # Object with schema name: FieldSource + ], + "virtualFieldType": "A String", # Required. The type of the virtual field. + }, }, }, ], @@ -172,6 +178,12 @@

Method Details

"type": "A String", # Required. Specifies the aggregation function. Use one of the following string identifiers: "average": Computes the average (AVG). Applies only to numeric values. "count": Counts the number of values (COUNT). "count-distinct": Counts the number of distinct values (COUNT DISTINCT). "count-distinct-approx": Approximates the count of distinct values (APPROX_COUNT_DISTINCT). "max": Finds the maximum value (MAX). Applies only to numeric values. "min": Finds the minimum value (MIN). Applies only to numeric values. "sum": Computes the sum (SUM). Applies only to numeric values. }, "truncationGranularity": "A String", # The truncation granularity when grouping by a time/date field. This will be used to truncate the field to the granularity specified. This can be either a date or a time granularity found at https://cloud.google.com/bigquery/docs/reference/standard-sql/timestamp_functions#timestamp_trunc_granularity_date and https://cloud.google.com/bigquery/docs/reference/standard-sql/timestamp_functions#timestamp_trunc_granularity_time respectively. + "virtualField": { # A virtual field is a field that is not physically present in the underlying data schema, but is created through specific operations within the query builder model based on other fields in the schema. # Optional. A virtual field definition, used in place of field to define a field that is computed from other fields rather than being directly present in the data schema.For example, a virtual field can be defined using COALESCE to select the first non-null value from a list of fields.If virtual_field is set, field must not be set. + "underlyingFieldSources": [ # The field sources that will be used to create the virtual field, based on the semantics of the virtual field type.The field sources must follow these rules, based on the virtual field type: - For VIRTUAL_FIELD_TYPE_UNSPECIFIED, this field must be empty. - For COALESCE, this field must be non-empty and include a minimum of two field sources. The underlying field sources must be actual projected fields that represent actual schema fields and that must not be transformed and aggregated in any way, except for casting. The type of all the underlying field sources must be equivalent so that picking one of them would result in the same value type. + # Object with schema name: FieldSource + ], + "virtualFieldType": "A String", # Required. The type of the virtual field. + }, }, }, "fieldSourceValue": { # A source that can be used to represent a "field of data" within various parts of a structured query, such as in SELECT, WHERE, or ORDER BY clauses. The term "field of data" is used here because it is not limited to literal fields in the underlying data schema. # The field. This will be the field that is set as the Right Hand Side of the filter. @@ -193,6 +205,12 @@

Method Details

"type": "A String", # Required. Specifies the aggregation function. Use one of the following string identifiers: "average": Computes the average (AVG). Applies only to numeric values. "count": Counts the number of values (COUNT). "count-distinct": Counts the number of distinct values (COUNT DISTINCT). "count-distinct-approx": Approximates the count of distinct values (APPROX_COUNT_DISTINCT). "max": Finds the maximum value (MAX). Applies only to numeric values. "min": Finds the minimum value (MIN). Applies only to numeric values. "sum": Computes the sum (SUM). Applies only to numeric values. }, "truncationGranularity": "A String", # The truncation granularity when grouping by a time/date field. This will be used to truncate the field to the granularity specified. This can be either a date or a time granularity found at https://cloud.google.com/bigquery/docs/reference/standard-sql/timestamp_functions#timestamp_trunc_granularity_date and https://cloud.google.com/bigquery/docs/reference/standard-sql/timestamp_functions#timestamp_trunc_granularity_time respectively. + "virtualField": { # A virtual field is a field that is not physically present in the underlying data schema, but is created through specific operations within the query builder model based on other fields in the schema. # Optional. A virtual field definition, used in place of field to define a field that is computed from other fields rather than being directly present in the data schema.For example, a virtual field can be defined using COALESCE to select the first non-null value from a list of fields.If virtual_field is set, field must not be set. + "underlyingFieldSources": [ # The field sources that will be used to create the virtual field, based on the semantics of the virtual field type.The field sources must follow these rules, based on the virtual field type: - For VIRTUAL_FIELD_TYPE_UNSPECIFIED, this field must be empty. - For COALESCE, this field must be non-empty and include a minimum of two field sources. The underlying field sources must be actual projected fields that represent actual schema fields and that must not be transformed and aggregated in any way, except for casting. The type of all the underlying field sources must be equivalent so that picking one of them would result in the same value type. + # Object with schema name: FieldSource + ], + "virtualFieldType": "A String", # Required. The type of the virtual field. + }, }, }, "isNegation": True or False, # Determines if the NOT flag should be added to the comparator. @@ -222,6 +240,12 @@

Method Details

"type": "A String", # Required. Specifies the aggregation function. Use one of the following string identifiers: "average": Computes the average (AVG). Applies only to numeric values. "count": Counts the number of values (COUNT). "count-distinct": Counts the number of distinct values (COUNT DISTINCT). "count-distinct-approx": Approximates the count of distinct values (APPROX_COUNT_DISTINCT). "max": Finds the maximum value (MAX). Applies only to numeric values. "min": Finds the minimum value (MIN). Applies only to numeric values. "sum": Computes the sum (SUM). Applies only to numeric values. }, "truncationGranularity": "A String", # The truncation granularity when grouping by a time/date field. This will be used to truncate the field to the granularity specified. This can be either a date or a time granularity found at https://cloud.google.com/bigquery/docs/reference/standard-sql/timestamp_functions#timestamp_trunc_granularity_date and https://cloud.google.com/bigquery/docs/reference/standard-sql/timestamp_functions#timestamp_trunc_granularity_time respectively. + "virtualField": { # A virtual field is a field that is not physically present in the underlying data schema, but is created through specific operations within the query builder model based on other fields in the schema. # Optional. A virtual field definition, used in place of field to define a field that is computed from other fields rather than being directly present in the data schema.For example, a virtual field can be defined using COALESCE to select the first non-null value from a list of fields.If virtual_field is set, field must not be set. + "underlyingFieldSources": [ # The field sources that will be used to create the virtual field, based on the semantics of the virtual field type.The field sources must follow these rules, based on the virtual field type: - For VIRTUAL_FIELD_TYPE_UNSPECIFIED, this field must be empty. - For COALESCE, this field must be non-empty and include a minimum of two field sources. The underlying field sources must be actual projected fields that represent actual schema fields and that must not be transformed and aggregated in any way, except for casting. The type of all the underlying field sources must be equivalent so that picking one of them would result in the same value type. + # Object with schema name: FieldSource + ], + "virtualFieldType": "A String", # Required. The type of the virtual field. + }, }, }, "sortOrderDirection": "A String", # The sort order to use for the query. diff --git a/docs/dyn/logging_v2.folders.locations.savedQueries.html b/docs/dyn/logging_v2.folders.locations.savedQueries.html index e41d81ddb3..88b15cb44e 100644 --- a/docs/dyn/logging_v2.folders.locations.savedQueries.html +++ b/docs/dyn/logging_v2.folders.locations.savedQueries.html @@ -147,6 +147,12 @@

Method Details

"type": "A String", # Required. Specifies the aggregation function. Use one of the following string identifiers: "average": Computes the average (AVG). Applies only to numeric values. "count": Counts the number of values (COUNT). "count-distinct": Counts the number of distinct values (COUNT DISTINCT). "count-distinct-approx": Approximates the count of distinct values (APPROX_COUNT_DISTINCT). "max": Finds the maximum value (MAX). Applies only to numeric values. "min": Finds the minimum value (MIN). Applies only to numeric values. "sum": Computes the sum (SUM). Applies only to numeric values. }, "truncationGranularity": "A String", # The truncation granularity when grouping by a time/date field. This will be used to truncate the field to the granularity specified. This can be either a date or a time granularity found at https://cloud.google.com/bigquery/docs/reference/standard-sql/timestamp_functions#timestamp_trunc_granularity_date and https://cloud.google.com/bigquery/docs/reference/standard-sql/timestamp_functions#timestamp_trunc_granularity_time respectively. + "virtualField": { # A virtual field is a field that is not physically present in the underlying data schema, but is created through specific operations within the query builder model based on other fields in the schema. # Optional. A virtual field definition, used in place of field to define a field that is computed from other fields rather than being directly present in the data schema.For example, a virtual field can be defined using COALESCE to select the first non-null value from a list of fields.If virtual_field is set, field must not be set. + "underlyingFieldSources": [ # The field sources that will be used to create the virtual field, based on the semantics of the virtual field type.The field sources must follow these rules, based on the virtual field type: - For VIRTUAL_FIELD_TYPE_UNSPECIFIED, this field must be empty. - For COALESCE, this field must be non-empty and include a minimum of two field sources. The underlying field sources must be actual projected fields that represent actual schema fields and that must not be transformed and aggregated in any way, except for casting. The type of all the underlying field sources must be equivalent so that picking one of them would result in the same value type. + # Object with schema name: FieldSource + ], + "virtualFieldType": "A String", # Required. The type of the virtual field. + }, }, }, ], @@ -175,6 +181,12 @@

Method Details

"type": "A String", # Required. Specifies the aggregation function. Use one of the following string identifiers: "average": Computes the average (AVG). Applies only to numeric values. "count": Counts the number of values (COUNT). "count-distinct": Counts the number of distinct values (COUNT DISTINCT). "count-distinct-approx": Approximates the count of distinct values (APPROX_COUNT_DISTINCT). "max": Finds the maximum value (MAX). Applies only to numeric values. "min": Finds the minimum value (MIN). Applies only to numeric values. "sum": Computes the sum (SUM). Applies only to numeric values. }, "truncationGranularity": "A String", # The truncation granularity when grouping by a time/date field. This will be used to truncate the field to the granularity specified. This can be either a date or a time granularity found at https://cloud.google.com/bigquery/docs/reference/standard-sql/timestamp_functions#timestamp_trunc_granularity_date and https://cloud.google.com/bigquery/docs/reference/standard-sql/timestamp_functions#timestamp_trunc_granularity_time respectively. + "virtualField": { # A virtual field is a field that is not physically present in the underlying data schema, but is created through specific operations within the query builder model based on other fields in the schema. # Optional. A virtual field definition, used in place of field to define a field that is computed from other fields rather than being directly present in the data schema.For example, a virtual field can be defined using COALESCE to select the first non-null value from a list of fields.If virtual_field is set, field must not be set. + "underlyingFieldSources": [ # The field sources that will be used to create the virtual field, based on the semantics of the virtual field type.The field sources must follow these rules, based on the virtual field type: - For VIRTUAL_FIELD_TYPE_UNSPECIFIED, this field must be empty. - For COALESCE, this field must be non-empty and include a minimum of two field sources. The underlying field sources must be actual projected fields that represent actual schema fields and that must not be transformed and aggregated in any way, except for casting. The type of all the underlying field sources must be equivalent so that picking one of them would result in the same value type. + # Object with schema name: FieldSource + ], + "virtualFieldType": "A String", # Required. The type of the virtual field. + }, }, }, "fieldSourceValue": { # A source that can be used to represent a "field of data" within various parts of a structured query, such as in SELECT, WHERE, or ORDER BY clauses. The term "field of data" is used here because it is not limited to literal fields in the underlying data schema. # The field. This will be the field that is set as the Right Hand Side of the filter. @@ -196,6 +208,12 @@

Method Details

"type": "A String", # Required. Specifies the aggregation function. Use one of the following string identifiers: "average": Computes the average (AVG). Applies only to numeric values. "count": Counts the number of values (COUNT). "count-distinct": Counts the number of distinct values (COUNT DISTINCT). "count-distinct-approx": Approximates the count of distinct values (APPROX_COUNT_DISTINCT). "max": Finds the maximum value (MAX). Applies only to numeric values. "min": Finds the minimum value (MIN). Applies only to numeric values. "sum": Computes the sum (SUM). Applies only to numeric values. }, "truncationGranularity": "A String", # The truncation granularity when grouping by a time/date field. This will be used to truncate the field to the granularity specified. This can be either a date or a time granularity found at https://cloud.google.com/bigquery/docs/reference/standard-sql/timestamp_functions#timestamp_trunc_granularity_date and https://cloud.google.com/bigquery/docs/reference/standard-sql/timestamp_functions#timestamp_trunc_granularity_time respectively. + "virtualField": { # A virtual field is a field that is not physically present in the underlying data schema, but is created through specific operations within the query builder model based on other fields in the schema. # Optional. A virtual field definition, used in place of field to define a field that is computed from other fields rather than being directly present in the data schema.For example, a virtual field can be defined using COALESCE to select the first non-null value from a list of fields.If virtual_field is set, field must not be set. + "underlyingFieldSources": [ # The field sources that will be used to create the virtual field, based on the semantics of the virtual field type.The field sources must follow these rules, based on the virtual field type: - For VIRTUAL_FIELD_TYPE_UNSPECIFIED, this field must be empty. - For COALESCE, this field must be non-empty and include a minimum of two field sources. The underlying field sources must be actual projected fields that represent actual schema fields and that must not be transformed and aggregated in any way, except for casting. The type of all the underlying field sources must be equivalent so that picking one of them would result in the same value type. + # Object with schema name: FieldSource + ], + "virtualFieldType": "A String", # Required. The type of the virtual field. + }, }, }, "isNegation": True or False, # Determines if the NOT flag should be added to the comparator. @@ -225,6 +243,12 @@

Method Details

"type": "A String", # Required. Specifies the aggregation function. Use one of the following string identifiers: "average": Computes the average (AVG). Applies only to numeric values. "count": Counts the number of values (COUNT). "count-distinct": Counts the number of distinct values (COUNT DISTINCT). "count-distinct-approx": Approximates the count of distinct values (APPROX_COUNT_DISTINCT). "max": Finds the maximum value (MAX). Applies only to numeric values. "min": Finds the minimum value (MIN). Applies only to numeric values. "sum": Computes the sum (SUM). Applies only to numeric values. }, "truncationGranularity": "A String", # The truncation granularity when grouping by a time/date field. This will be used to truncate the field to the granularity specified. This can be either a date or a time granularity found at https://cloud.google.com/bigquery/docs/reference/standard-sql/timestamp_functions#timestamp_trunc_granularity_date and https://cloud.google.com/bigquery/docs/reference/standard-sql/timestamp_functions#timestamp_trunc_granularity_time respectively. + "virtualField": { # A virtual field is a field that is not physically present in the underlying data schema, but is created through specific operations within the query builder model based on other fields in the schema. # Optional. A virtual field definition, used in place of field to define a field that is computed from other fields rather than being directly present in the data schema.For example, a virtual field can be defined using COALESCE to select the first non-null value from a list of fields.If virtual_field is set, field must not be set. + "underlyingFieldSources": [ # The field sources that will be used to create the virtual field, based on the semantics of the virtual field type.The field sources must follow these rules, based on the virtual field type: - For VIRTUAL_FIELD_TYPE_UNSPECIFIED, this field must be empty. - For COALESCE, this field must be non-empty and include a minimum of two field sources. The underlying field sources must be actual projected fields that represent actual schema fields and that must not be transformed and aggregated in any way, except for casting. The type of all the underlying field sources must be equivalent so that picking one of them would result in the same value type. + # Object with schema name: FieldSource + ], + "virtualFieldType": "A String", # Required. The type of the virtual field. + }, }, }, "sortOrderDirection": "A String", # The sort order to use for the query. @@ -287,6 +311,12 @@

Method Details

"type": "A String", # Required. Specifies the aggregation function. Use one of the following string identifiers: "average": Computes the average (AVG). Applies only to numeric values. "count": Counts the number of values (COUNT). "count-distinct": Counts the number of distinct values (COUNT DISTINCT). "count-distinct-approx": Approximates the count of distinct values (APPROX_COUNT_DISTINCT). "max": Finds the maximum value (MAX). Applies only to numeric values. "min": Finds the minimum value (MIN). Applies only to numeric values. "sum": Computes the sum (SUM). Applies only to numeric values. }, "truncationGranularity": "A String", # The truncation granularity when grouping by a time/date field. This will be used to truncate the field to the granularity specified. This can be either a date or a time granularity found at https://cloud.google.com/bigquery/docs/reference/standard-sql/timestamp_functions#timestamp_trunc_granularity_date and https://cloud.google.com/bigquery/docs/reference/standard-sql/timestamp_functions#timestamp_trunc_granularity_time respectively. + "virtualField": { # A virtual field is a field that is not physically present in the underlying data schema, but is created through specific operations within the query builder model based on other fields in the schema. # Optional. A virtual field definition, used in place of field to define a field that is computed from other fields rather than being directly present in the data schema.For example, a virtual field can be defined using COALESCE to select the first non-null value from a list of fields.If virtual_field is set, field must not be set. + "underlyingFieldSources": [ # The field sources that will be used to create the virtual field, based on the semantics of the virtual field type.The field sources must follow these rules, based on the virtual field type: - For VIRTUAL_FIELD_TYPE_UNSPECIFIED, this field must be empty. - For COALESCE, this field must be non-empty and include a minimum of two field sources. The underlying field sources must be actual projected fields that represent actual schema fields and that must not be transformed and aggregated in any way, except for casting. The type of all the underlying field sources must be equivalent so that picking one of them would result in the same value type. + # Object with schema name: FieldSource + ], + "virtualFieldType": "A String", # Required. The type of the virtual field. + }, }, }, ], @@ -315,6 +345,12 @@

Method Details

"type": "A String", # Required. Specifies the aggregation function. Use one of the following string identifiers: "average": Computes the average (AVG). Applies only to numeric values. "count": Counts the number of values (COUNT). "count-distinct": Counts the number of distinct values (COUNT DISTINCT). "count-distinct-approx": Approximates the count of distinct values (APPROX_COUNT_DISTINCT). "max": Finds the maximum value (MAX). Applies only to numeric values. "min": Finds the minimum value (MIN). Applies only to numeric values. "sum": Computes the sum (SUM). Applies only to numeric values. }, "truncationGranularity": "A String", # The truncation granularity when grouping by a time/date field. This will be used to truncate the field to the granularity specified. This can be either a date or a time granularity found at https://cloud.google.com/bigquery/docs/reference/standard-sql/timestamp_functions#timestamp_trunc_granularity_date and https://cloud.google.com/bigquery/docs/reference/standard-sql/timestamp_functions#timestamp_trunc_granularity_time respectively. + "virtualField": { # A virtual field is a field that is not physically present in the underlying data schema, but is created through specific operations within the query builder model based on other fields in the schema. # Optional. A virtual field definition, used in place of field to define a field that is computed from other fields rather than being directly present in the data schema.For example, a virtual field can be defined using COALESCE to select the first non-null value from a list of fields.If virtual_field is set, field must not be set. + "underlyingFieldSources": [ # The field sources that will be used to create the virtual field, based on the semantics of the virtual field type.The field sources must follow these rules, based on the virtual field type: - For VIRTUAL_FIELD_TYPE_UNSPECIFIED, this field must be empty. - For COALESCE, this field must be non-empty and include a minimum of two field sources. The underlying field sources must be actual projected fields that represent actual schema fields and that must not be transformed and aggregated in any way, except for casting. The type of all the underlying field sources must be equivalent so that picking one of them would result in the same value type. + # Object with schema name: FieldSource + ], + "virtualFieldType": "A String", # Required. The type of the virtual field. + }, }, }, "fieldSourceValue": { # A source that can be used to represent a "field of data" within various parts of a structured query, such as in SELECT, WHERE, or ORDER BY clauses. The term "field of data" is used here because it is not limited to literal fields in the underlying data schema. # The field. This will be the field that is set as the Right Hand Side of the filter. @@ -336,6 +372,12 @@

Method Details

"type": "A String", # Required. Specifies the aggregation function. Use one of the following string identifiers: "average": Computes the average (AVG). Applies only to numeric values. "count": Counts the number of values (COUNT). "count-distinct": Counts the number of distinct values (COUNT DISTINCT). "count-distinct-approx": Approximates the count of distinct values (APPROX_COUNT_DISTINCT). "max": Finds the maximum value (MAX). Applies only to numeric values. "min": Finds the minimum value (MIN). Applies only to numeric values. "sum": Computes the sum (SUM). Applies only to numeric values. }, "truncationGranularity": "A String", # The truncation granularity when grouping by a time/date field. This will be used to truncate the field to the granularity specified. This can be either a date or a time granularity found at https://cloud.google.com/bigquery/docs/reference/standard-sql/timestamp_functions#timestamp_trunc_granularity_date and https://cloud.google.com/bigquery/docs/reference/standard-sql/timestamp_functions#timestamp_trunc_granularity_time respectively. + "virtualField": { # A virtual field is a field that is not physically present in the underlying data schema, but is created through specific operations within the query builder model based on other fields in the schema. # Optional. A virtual field definition, used in place of field to define a field that is computed from other fields rather than being directly present in the data schema.For example, a virtual field can be defined using COALESCE to select the first non-null value from a list of fields.If virtual_field is set, field must not be set. + "underlyingFieldSources": [ # The field sources that will be used to create the virtual field, based on the semantics of the virtual field type.The field sources must follow these rules, based on the virtual field type: - For VIRTUAL_FIELD_TYPE_UNSPECIFIED, this field must be empty. - For COALESCE, this field must be non-empty and include a minimum of two field sources. The underlying field sources must be actual projected fields that represent actual schema fields and that must not be transformed and aggregated in any way, except for casting. The type of all the underlying field sources must be equivalent so that picking one of them would result in the same value type. + # Object with schema name: FieldSource + ], + "virtualFieldType": "A String", # Required. The type of the virtual field. + }, }, }, "isNegation": True or False, # Determines if the NOT flag should be added to the comparator. @@ -365,6 +407,12 @@

Method Details

"type": "A String", # Required. Specifies the aggregation function. Use one of the following string identifiers: "average": Computes the average (AVG). Applies only to numeric values. "count": Counts the number of values (COUNT). "count-distinct": Counts the number of distinct values (COUNT DISTINCT). "count-distinct-approx": Approximates the count of distinct values (APPROX_COUNT_DISTINCT). "max": Finds the maximum value (MAX). Applies only to numeric values. "min": Finds the minimum value (MIN). Applies only to numeric values. "sum": Computes the sum (SUM). Applies only to numeric values. }, "truncationGranularity": "A String", # The truncation granularity when grouping by a time/date field. This will be used to truncate the field to the granularity specified. This can be either a date or a time granularity found at https://cloud.google.com/bigquery/docs/reference/standard-sql/timestamp_functions#timestamp_trunc_granularity_date and https://cloud.google.com/bigquery/docs/reference/standard-sql/timestamp_functions#timestamp_trunc_granularity_time respectively. + "virtualField": { # A virtual field is a field that is not physically present in the underlying data schema, but is created through specific operations within the query builder model based on other fields in the schema. # Optional. A virtual field definition, used in place of field to define a field that is computed from other fields rather than being directly present in the data schema.For example, a virtual field can be defined using COALESCE to select the first non-null value from a list of fields.If virtual_field is set, field must not be set. + "underlyingFieldSources": [ # The field sources that will be used to create the virtual field, based on the semantics of the virtual field type.The field sources must follow these rules, based on the virtual field type: - For VIRTUAL_FIELD_TYPE_UNSPECIFIED, this field must be empty. - For COALESCE, this field must be non-empty and include a minimum of two field sources. The underlying field sources must be actual projected fields that represent actual schema fields and that must not be transformed and aggregated in any way, except for casting. The type of all the underlying field sources must be equivalent so that picking one of them would result in the same value type. + # Object with schema name: FieldSource + ], + "virtualFieldType": "A String", # Required. The type of the virtual field. + }, }, }, "sortOrderDirection": "A String", # The sort order to use for the query. @@ -451,6 +499,12 @@

Method Details

"type": "A String", # Required. Specifies the aggregation function. Use one of the following string identifiers: "average": Computes the average (AVG). Applies only to numeric values. "count": Counts the number of values (COUNT). "count-distinct": Counts the number of distinct values (COUNT DISTINCT). "count-distinct-approx": Approximates the count of distinct values (APPROX_COUNT_DISTINCT). "max": Finds the maximum value (MAX). Applies only to numeric values. "min": Finds the minimum value (MIN). Applies only to numeric values. "sum": Computes the sum (SUM). Applies only to numeric values. }, "truncationGranularity": "A String", # The truncation granularity when grouping by a time/date field. This will be used to truncate the field to the granularity specified. This can be either a date or a time granularity found at https://cloud.google.com/bigquery/docs/reference/standard-sql/timestamp_functions#timestamp_trunc_granularity_date and https://cloud.google.com/bigquery/docs/reference/standard-sql/timestamp_functions#timestamp_trunc_granularity_time respectively. + "virtualField": { # A virtual field is a field that is not physically present in the underlying data schema, but is created through specific operations within the query builder model based on other fields in the schema. # Optional. A virtual field definition, used in place of field to define a field that is computed from other fields rather than being directly present in the data schema.For example, a virtual field can be defined using COALESCE to select the first non-null value from a list of fields.If virtual_field is set, field must not be set. + "underlyingFieldSources": [ # The field sources that will be used to create the virtual field, based on the semantics of the virtual field type.The field sources must follow these rules, based on the virtual field type: - For VIRTUAL_FIELD_TYPE_UNSPECIFIED, this field must be empty. - For COALESCE, this field must be non-empty and include a minimum of two field sources. The underlying field sources must be actual projected fields that represent actual schema fields and that must not be transformed and aggregated in any way, except for casting. The type of all the underlying field sources must be equivalent so that picking one of them would result in the same value type. + # Object with schema name: FieldSource + ], + "virtualFieldType": "A String", # Required. The type of the virtual field. + }, }, }, ], @@ -479,6 +533,12 @@

Method Details

"type": "A String", # Required. Specifies the aggregation function. Use one of the following string identifiers: "average": Computes the average (AVG). Applies only to numeric values. "count": Counts the number of values (COUNT). "count-distinct": Counts the number of distinct values (COUNT DISTINCT). "count-distinct-approx": Approximates the count of distinct values (APPROX_COUNT_DISTINCT). "max": Finds the maximum value (MAX). Applies only to numeric values. "min": Finds the minimum value (MIN). Applies only to numeric values. "sum": Computes the sum (SUM). Applies only to numeric values. }, "truncationGranularity": "A String", # The truncation granularity when grouping by a time/date field. This will be used to truncate the field to the granularity specified. This can be either a date or a time granularity found at https://cloud.google.com/bigquery/docs/reference/standard-sql/timestamp_functions#timestamp_trunc_granularity_date and https://cloud.google.com/bigquery/docs/reference/standard-sql/timestamp_functions#timestamp_trunc_granularity_time respectively. + "virtualField": { # A virtual field is a field that is not physically present in the underlying data schema, but is created through specific operations within the query builder model based on other fields in the schema. # Optional. A virtual field definition, used in place of field to define a field that is computed from other fields rather than being directly present in the data schema.For example, a virtual field can be defined using COALESCE to select the first non-null value from a list of fields.If virtual_field is set, field must not be set. + "underlyingFieldSources": [ # The field sources that will be used to create the virtual field, based on the semantics of the virtual field type.The field sources must follow these rules, based on the virtual field type: - For VIRTUAL_FIELD_TYPE_UNSPECIFIED, this field must be empty. - For COALESCE, this field must be non-empty and include a minimum of two field sources. The underlying field sources must be actual projected fields that represent actual schema fields and that must not be transformed and aggregated in any way, except for casting. The type of all the underlying field sources must be equivalent so that picking one of them would result in the same value type. + # Object with schema name: FieldSource + ], + "virtualFieldType": "A String", # Required. The type of the virtual field. + }, }, }, "fieldSourceValue": { # A source that can be used to represent a "field of data" within various parts of a structured query, such as in SELECT, WHERE, or ORDER BY clauses. The term "field of data" is used here because it is not limited to literal fields in the underlying data schema. # The field. This will be the field that is set as the Right Hand Side of the filter. @@ -500,6 +560,12 @@

Method Details

"type": "A String", # Required. Specifies the aggregation function. Use one of the following string identifiers: "average": Computes the average (AVG). Applies only to numeric values. "count": Counts the number of values (COUNT). "count-distinct": Counts the number of distinct values (COUNT DISTINCT). "count-distinct-approx": Approximates the count of distinct values (APPROX_COUNT_DISTINCT). "max": Finds the maximum value (MAX). Applies only to numeric values. "min": Finds the minimum value (MIN). Applies only to numeric values. "sum": Computes the sum (SUM). Applies only to numeric values. }, "truncationGranularity": "A String", # The truncation granularity when grouping by a time/date field. This will be used to truncate the field to the granularity specified. This can be either a date or a time granularity found at https://cloud.google.com/bigquery/docs/reference/standard-sql/timestamp_functions#timestamp_trunc_granularity_date and https://cloud.google.com/bigquery/docs/reference/standard-sql/timestamp_functions#timestamp_trunc_granularity_time respectively. + "virtualField": { # A virtual field is a field that is not physically present in the underlying data schema, but is created through specific operations within the query builder model based on other fields in the schema. # Optional. A virtual field definition, used in place of field to define a field that is computed from other fields rather than being directly present in the data schema.For example, a virtual field can be defined using COALESCE to select the first non-null value from a list of fields.If virtual_field is set, field must not be set. + "underlyingFieldSources": [ # The field sources that will be used to create the virtual field, based on the semantics of the virtual field type.The field sources must follow these rules, based on the virtual field type: - For VIRTUAL_FIELD_TYPE_UNSPECIFIED, this field must be empty. - For COALESCE, this field must be non-empty and include a minimum of two field sources. The underlying field sources must be actual projected fields that represent actual schema fields and that must not be transformed and aggregated in any way, except for casting. The type of all the underlying field sources must be equivalent so that picking one of them would result in the same value type. + # Object with schema name: FieldSource + ], + "virtualFieldType": "A String", # Required. The type of the virtual field. + }, }, }, "isNegation": True or False, # Determines if the NOT flag should be added to the comparator. @@ -529,6 +595,12 @@

Method Details

"type": "A String", # Required. Specifies the aggregation function. Use one of the following string identifiers: "average": Computes the average (AVG). Applies only to numeric values. "count": Counts the number of values (COUNT). "count-distinct": Counts the number of distinct values (COUNT DISTINCT). "count-distinct-approx": Approximates the count of distinct values (APPROX_COUNT_DISTINCT). "max": Finds the maximum value (MAX). Applies only to numeric values. "min": Finds the minimum value (MIN). Applies only to numeric values. "sum": Computes the sum (SUM). Applies only to numeric values. }, "truncationGranularity": "A String", # The truncation granularity when grouping by a time/date field. This will be used to truncate the field to the granularity specified. This can be either a date or a time granularity found at https://cloud.google.com/bigquery/docs/reference/standard-sql/timestamp_functions#timestamp_trunc_granularity_date and https://cloud.google.com/bigquery/docs/reference/standard-sql/timestamp_functions#timestamp_trunc_granularity_time respectively. + "virtualField": { # A virtual field is a field that is not physically present in the underlying data schema, but is created through specific operations within the query builder model based on other fields in the schema. # Optional. A virtual field definition, used in place of field to define a field that is computed from other fields rather than being directly present in the data schema.For example, a virtual field can be defined using COALESCE to select the first non-null value from a list of fields.If virtual_field is set, field must not be set. + "underlyingFieldSources": [ # The field sources that will be used to create the virtual field, based on the semantics of the virtual field type.The field sources must follow these rules, based on the virtual field type: - For VIRTUAL_FIELD_TYPE_UNSPECIFIED, this field must be empty. - For COALESCE, this field must be non-empty and include a minimum of two field sources. The underlying field sources must be actual projected fields that represent actual schema fields and that must not be transformed and aggregated in any way, except for casting. The type of all the underlying field sources must be equivalent so that picking one of them would result in the same value type. + # Object with schema name: FieldSource + ], + "virtualFieldType": "A String", # Required. The type of the virtual field. + }, }, }, "sortOrderDirection": "A String", # The sort order to use for the query. @@ -603,6 +675,12 @@

Method Details

"type": "A String", # Required. Specifies the aggregation function. Use one of the following string identifiers: "average": Computes the average (AVG). Applies only to numeric values. "count": Counts the number of values (COUNT). "count-distinct": Counts the number of distinct values (COUNT DISTINCT). "count-distinct-approx": Approximates the count of distinct values (APPROX_COUNT_DISTINCT). "max": Finds the maximum value (MAX). Applies only to numeric values. "min": Finds the minimum value (MIN). Applies only to numeric values. "sum": Computes the sum (SUM). Applies only to numeric values. }, "truncationGranularity": "A String", # The truncation granularity when grouping by a time/date field. This will be used to truncate the field to the granularity specified. This can be either a date or a time granularity found at https://cloud.google.com/bigquery/docs/reference/standard-sql/timestamp_functions#timestamp_trunc_granularity_date and https://cloud.google.com/bigquery/docs/reference/standard-sql/timestamp_functions#timestamp_trunc_granularity_time respectively. + "virtualField": { # A virtual field is a field that is not physically present in the underlying data schema, but is created through specific operations within the query builder model based on other fields in the schema. # Optional. A virtual field definition, used in place of field to define a field that is computed from other fields rather than being directly present in the data schema.For example, a virtual field can be defined using COALESCE to select the first non-null value from a list of fields.If virtual_field is set, field must not be set. + "underlyingFieldSources": [ # The field sources that will be used to create the virtual field, based on the semantics of the virtual field type.The field sources must follow these rules, based on the virtual field type: - For VIRTUAL_FIELD_TYPE_UNSPECIFIED, this field must be empty. - For COALESCE, this field must be non-empty and include a minimum of two field sources. The underlying field sources must be actual projected fields that represent actual schema fields and that must not be transformed and aggregated in any way, except for casting. The type of all the underlying field sources must be equivalent so that picking one of them would result in the same value type. + # Object with schema name: FieldSource + ], + "virtualFieldType": "A String", # Required. The type of the virtual field. + }, }, }, ], @@ -631,6 +709,12 @@

Method Details

"type": "A String", # Required. Specifies the aggregation function. Use one of the following string identifiers: "average": Computes the average (AVG). Applies only to numeric values. "count": Counts the number of values (COUNT). "count-distinct": Counts the number of distinct values (COUNT DISTINCT). "count-distinct-approx": Approximates the count of distinct values (APPROX_COUNT_DISTINCT). "max": Finds the maximum value (MAX). Applies only to numeric values. "min": Finds the minimum value (MIN). Applies only to numeric values. "sum": Computes the sum (SUM). Applies only to numeric values. }, "truncationGranularity": "A String", # The truncation granularity when grouping by a time/date field. This will be used to truncate the field to the granularity specified. This can be either a date or a time granularity found at https://cloud.google.com/bigquery/docs/reference/standard-sql/timestamp_functions#timestamp_trunc_granularity_date and https://cloud.google.com/bigquery/docs/reference/standard-sql/timestamp_functions#timestamp_trunc_granularity_time respectively. + "virtualField": { # A virtual field is a field that is not physically present in the underlying data schema, but is created through specific operations within the query builder model based on other fields in the schema. # Optional. A virtual field definition, used in place of field to define a field that is computed from other fields rather than being directly present in the data schema.For example, a virtual field can be defined using COALESCE to select the first non-null value from a list of fields.If virtual_field is set, field must not be set. + "underlyingFieldSources": [ # The field sources that will be used to create the virtual field, based on the semantics of the virtual field type.The field sources must follow these rules, based on the virtual field type: - For VIRTUAL_FIELD_TYPE_UNSPECIFIED, this field must be empty. - For COALESCE, this field must be non-empty and include a minimum of two field sources. The underlying field sources must be actual projected fields that represent actual schema fields and that must not be transformed and aggregated in any way, except for casting. The type of all the underlying field sources must be equivalent so that picking one of them would result in the same value type. + # Object with schema name: FieldSource + ], + "virtualFieldType": "A String", # Required. The type of the virtual field. + }, }, }, "fieldSourceValue": { # A source that can be used to represent a "field of data" within various parts of a structured query, such as in SELECT, WHERE, or ORDER BY clauses. The term "field of data" is used here because it is not limited to literal fields in the underlying data schema. # The field. This will be the field that is set as the Right Hand Side of the filter. @@ -652,6 +736,12 @@

Method Details

"type": "A String", # Required. Specifies the aggregation function. Use one of the following string identifiers: "average": Computes the average (AVG). Applies only to numeric values. "count": Counts the number of values (COUNT). "count-distinct": Counts the number of distinct values (COUNT DISTINCT). "count-distinct-approx": Approximates the count of distinct values (APPROX_COUNT_DISTINCT). "max": Finds the maximum value (MAX). Applies only to numeric values. "min": Finds the minimum value (MIN). Applies only to numeric values. "sum": Computes the sum (SUM). Applies only to numeric values. }, "truncationGranularity": "A String", # The truncation granularity when grouping by a time/date field. This will be used to truncate the field to the granularity specified. This can be either a date or a time granularity found at https://cloud.google.com/bigquery/docs/reference/standard-sql/timestamp_functions#timestamp_trunc_granularity_date and https://cloud.google.com/bigquery/docs/reference/standard-sql/timestamp_functions#timestamp_trunc_granularity_time respectively. + "virtualField": { # A virtual field is a field that is not physically present in the underlying data schema, but is created through specific operations within the query builder model based on other fields in the schema. # Optional. A virtual field definition, used in place of field to define a field that is computed from other fields rather than being directly present in the data schema.For example, a virtual field can be defined using COALESCE to select the first non-null value from a list of fields.If virtual_field is set, field must not be set. + "underlyingFieldSources": [ # The field sources that will be used to create the virtual field, based on the semantics of the virtual field type.The field sources must follow these rules, based on the virtual field type: - For VIRTUAL_FIELD_TYPE_UNSPECIFIED, this field must be empty. - For COALESCE, this field must be non-empty and include a minimum of two field sources. The underlying field sources must be actual projected fields that represent actual schema fields and that must not be transformed and aggregated in any way, except for casting. The type of all the underlying field sources must be equivalent so that picking one of them would result in the same value type. + # Object with schema name: FieldSource + ], + "virtualFieldType": "A String", # Required. The type of the virtual field. + }, }, }, "isNegation": True or False, # Determines if the NOT flag should be added to the comparator. @@ -681,6 +771,12 @@

Method Details

"type": "A String", # Required. Specifies the aggregation function. Use one of the following string identifiers: "average": Computes the average (AVG). Applies only to numeric values. "count": Counts the number of values (COUNT). "count-distinct": Counts the number of distinct values (COUNT DISTINCT). "count-distinct-approx": Approximates the count of distinct values (APPROX_COUNT_DISTINCT). "max": Finds the maximum value (MAX). Applies only to numeric values. "min": Finds the minimum value (MIN). Applies only to numeric values. "sum": Computes the sum (SUM). Applies only to numeric values. }, "truncationGranularity": "A String", # The truncation granularity when grouping by a time/date field. This will be used to truncate the field to the granularity specified. This can be either a date or a time granularity found at https://cloud.google.com/bigquery/docs/reference/standard-sql/timestamp_functions#timestamp_trunc_granularity_date and https://cloud.google.com/bigquery/docs/reference/standard-sql/timestamp_functions#timestamp_trunc_granularity_time respectively. + "virtualField": { # A virtual field is a field that is not physically present in the underlying data schema, but is created through specific operations within the query builder model based on other fields in the schema. # Optional. A virtual field definition, used in place of field to define a field that is computed from other fields rather than being directly present in the data schema.For example, a virtual field can be defined using COALESCE to select the first non-null value from a list of fields.If virtual_field is set, field must not be set. + "underlyingFieldSources": [ # The field sources that will be used to create the virtual field, based on the semantics of the virtual field type.The field sources must follow these rules, based on the virtual field type: - For VIRTUAL_FIELD_TYPE_UNSPECIFIED, this field must be empty. - For COALESCE, this field must be non-empty and include a minimum of two field sources. The underlying field sources must be actual projected fields that represent actual schema fields and that must not be transformed and aggregated in any way, except for casting. The type of all the underlying field sources must be equivalent so that picking one of them would result in the same value type. + # Object with schema name: FieldSource + ], + "virtualFieldType": "A String", # Required. The type of the virtual field. + }, }, }, "sortOrderDirection": "A String", # The sort order to use for the query. @@ -763,6 +859,12 @@

Method Details

"type": "A String", # Required. Specifies the aggregation function. Use one of the following string identifiers: "average": Computes the average (AVG). Applies only to numeric values. "count": Counts the number of values (COUNT). "count-distinct": Counts the number of distinct values (COUNT DISTINCT). "count-distinct-approx": Approximates the count of distinct values (APPROX_COUNT_DISTINCT). "max": Finds the maximum value (MAX). Applies only to numeric values. "min": Finds the minimum value (MIN). Applies only to numeric values. "sum": Computes the sum (SUM). Applies only to numeric values. }, "truncationGranularity": "A String", # The truncation granularity when grouping by a time/date field. This will be used to truncate the field to the granularity specified. This can be either a date or a time granularity found at https://cloud.google.com/bigquery/docs/reference/standard-sql/timestamp_functions#timestamp_trunc_granularity_date and https://cloud.google.com/bigquery/docs/reference/standard-sql/timestamp_functions#timestamp_trunc_granularity_time respectively. + "virtualField": { # A virtual field is a field that is not physically present in the underlying data schema, but is created through specific operations within the query builder model based on other fields in the schema. # Optional. A virtual field definition, used in place of field to define a field that is computed from other fields rather than being directly present in the data schema.For example, a virtual field can be defined using COALESCE to select the first non-null value from a list of fields.If virtual_field is set, field must not be set. + "underlyingFieldSources": [ # The field sources that will be used to create the virtual field, based on the semantics of the virtual field type.The field sources must follow these rules, based on the virtual field type: - For VIRTUAL_FIELD_TYPE_UNSPECIFIED, this field must be empty. - For COALESCE, this field must be non-empty and include a minimum of two field sources. The underlying field sources must be actual projected fields that represent actual schema fields and that must not be transformed and aggregated in any way, except for casting. The type of all the underlying field sources must be equivalent so that picking one of them would result in the same value type. + # Object with schema name: FieldSource + ], + "virtualFieldType": "A String", # Required. The type of the virtual field. + }, }, }, ], @@ -791,6 +893,12 @@

Method Details

"type": "A String", # Required. Specifies the aggregation function. Use one of the following string identifiers: "average": Computes the average (AVG). Applies only to numeric values. "count": Counts the number of values (COUNT). "count-distinct": Counts the number of distinct values (COUNT DISTINCT). "count-distinct-approx": Approximates the count of distinct values (APPROX_COUNT_DISTINCT). "max": Finds the maximum value (MAX). Applies only to numeric values. "min": Finds the minimum value (MIN). Applies only to numeric values. "sum": Computes the sum (SUM). Applies only to numeric values. }, "truncationGranularity": "A String", # The truncation granularity when grouping by a time/date field. This will be used to truncate the field to the granularity specified. This can be either a date or a time granularity found at https://cloud.google.com/bigquery/docs/reference/standard-sql/timestamp_functions#timestamp_trunc_granularity_date and https://cloud.google.com/bigquery/docs/reference/standard-sql/timestamp_functions#timestamp_trunc_granularity_time respectively. + "virtualField": { # A virtual field is a field that is not physically present in the underlying data schema, but is created through specific operations within the query builder model based on other fields in the schema. # Optional. A virtual field definition, used in place of field to define a field that is computed from other fields rather than being directly present in the data schema.For example, a virtual field can be defined using COALESCE to select the first non-null value from a list of fields.If virtual_field is set, field must not be set. + "underlyingFieldSources": [ # The field sources that will be used to create the virtual field, based on the semantics of the virtual field type.The field sources must follow these rules, based on the virtual field type: - For VIRTUAL_FIELD_TYPE_UNSPECIFIED, this field must be empty. - For COALESCE, this field must be non-empty and include a minimum of two field sources. The underlying field sources must be actual projected fields that represent actual schema fields and that must not be transformed and aggregated in any way, except for casting. The type of all the underlying field sources must be equivalent so that picking one of them would result in the same value type. + # Object with schema name: FieldSource + ], + "virtualFieldType": "A String", # Required. The type of the virtual field. + }, }, }, "fieldSourceValue": { # A source that can be used to represent a "field of data" within various parts of a structured query, such as in SELECT, WHERE, or ORDER BY clauses. The term "field of data" is used here because it is not limited to literal fields in the underlying data schema. # The field. This will be the field that is set as the Right Hand Side of the filter. @@ -812,6 +920,12 @@

Method Details

"type": "A String", # Required. Specifies the aggregation function. Use one of the following string identifiers: "average": Computes the average (AVG). Applies only to numeric values. "count": Counts the number of values (COUNT). "count-distinct": Counts the number of distinct values (COUNT DISTINCT). "count-distinct-approx": Approximates the count of distinct values (APPROX_COUNT_DISTINCT). "max": Finds the maximum value (MAX). Applies only to numeric values. "min": Finds the minimum value (MIN). Applies only to numeric values. "sum": Computes the sum (SUM). Applies only to numeric values. }, "truncationGranularity": "A String", # The truncation granularity when grouping by a time/date field. This will be used to truncate the field to the granularity specified. This can be either a date or a time granularity found at https://cloud.google.com/bigquery/docs/reference/standard-sql/timestamp_functions#timestamp_trunc_granularity_date and https://cloud.google.com/bigquery/docs/reference/standard-sql/timestamp_functions#timestamp_trunc_granularity_time respectively. + "virtualField": { # A virtual field is a field that is not physically present in the underlying data schema, but is created through specific operations within the query builder model based on other fields in the schema. # Optional. A virtual field definition, used in place of field to define a field that is computed from other fields rather than being directly present in the data schema.For example, a virtual field can be defined using COALESCE to select the first non-null value from a list of fields.If virtual_field is set, field must not be set. + "underlyingFieldSources": [ # The field sources that will be used to create the virtual field, based on the semantics of the virtual field type.The field sources must follow these rules, based on the virtual field type: - For VIRTUAL_FIELD_TYPE_UNSPECIFIED, this field must be empty. - For COALESCE, this field must be non-empty and include a minimum of two field sources. The underlying field sources must be actual projected fields that represent actual schema fields and that must not be transformed and aggregated in any way, except for casting. The type of all the underlying field sources must be equivalent so that picking one of them would result in the same value type. + # Object with schema name: FieldSource + ], + "virtualFieldType": "A String", # Required. The type of the virtual field. + }, }, }, "isNegation": True or False, # Determines if the NOT flag should be added to the comparator. @@ -841,6 +955,12 @@

Method Details

"type": "A String", # Required. Specifies the aggregation function. Use one of the following string identifiers: "average": Computes the average (AVG). Applies only to numeric values. "count": Counts the number of values (COUNT). "count-distinct": Counts the number of distinct values (COUNT DISTINCT). "count-distinct-approx": Approximates the count of distinct values (APPROX_COUNT_DISTINCT). "max": Finds the maximum value (MAX). Applies only to numeric values. "min": Finds the minimum value (MIN). Applies only to numeric values. "sum": Computes the sum (SUM). Applies only to numeric values. }, "truncationGranularity": "A String", # The truncation granularity when grouping by a time/date field. This will be used to truncate the field to the granularity specified. This can be either a date or a time granularity found at https://cloud.google.com/bigquery/docs/reference/standard-sql/timestamp_functions#timestamp_trunc_granularity_date and https://cloud.google.com/bigquery/docs/reference/standard-sql/timestamp_functions#timestamp_trunc_granularity_time respectively. + "virtualField": { # A virtual field is a field that is not physically present in the underlying data schema, but is created through specific operations within the query builder model based on other fields in the schema. # Optional. A virtual field definition, used in place of field to define a field that is computed from other fields rather than being directly present in the data schema.For example, a virtual field can be defined using COALESCE to select the first non-null value from a list of fields.If virtual_field is set, field must not be set. + "underlyingFieldSources": [ # The field sources that will be used to create the virtual field, based on the semantics of the virtual field type.The field sources must follow these rules, based on the virtual field type: - For VIRTUAL_FIELD_TYPE_UNSPECIFIED, this field must be empty. - For COALESCE, this field must be non-empty and include a minimum of two field sources. The underlying field sources must be actual projected fields that represent actual schema fields and that must not be transformed and aggregated in any way, except for casting. The type of all the underlying field sources must be equivalent so that picking one of them would result in the same value type. + # Object with schema name: FieldSource + ], + "virtualFieldType": "A String", # Required. The type of the virtual field. + }, }, }, "sortOrderDirection": "A String", # The sort order to use for the query. @@ -903,6 +1023,12 @@

Method Details

"type": "A String", # Required. Specifies the aggregation function. Use one of the following string identifiers: "average": Computes the average (AVG). Applies only to numeric values. "count": Counts the number of values (COUNT). "count-distinct": Counts the number of distinct values (COUNT DISTINCT). "count-distinct-approx": Approximates the count of distinct values (APPROX_COUNT_DISTINCT). "max": Finds the maximum value (MAX). Applies only to numeric values. "min": Finds the minimum value (MIN). Applies only to numeric values. "sum": Computes the sum (SUM). Applies only to numeric values. }, "truncationGranularity": "A String", # The truncation granularity when grouping by a time/date field. This will be used to truncate the field to the granularity specified. This can be either a date or a time granularity found at https://cloud.google.com/bigquery/docs/reference/standard-sql/timestamp_functions#timestamp_trunc_granularity_date and https://cloud.google.com/bigquery/docs/reference/standard-sql/timestamp_functions#timestamp_trunc_granularity_time respectively. + "virtualField": { # A virtual field is a field that is not physically present in the underlying data schema, but is created through specific operations within the query builder model based on other fields in the schema. # Optional. A virtual field definition, used in place of field to define a field that is computed from other fields rather than being directly present in the data schema.For example, a virtual field can be defined using COALESCE to select the first non-null value from a list of fields.If virtual_field is set, field must not be set. + "underlyingFieldSources": [ # The field sources that will be used to create the virtual field, based on the semantics of the virtual field type.The field sources must follow these rules, based on the virtual field type: - For VIRTUAL_FIELD_TYPE_UNSPECIFIED, this field must be empty. - For COALESCE, this field must be non-empty and include a minimum of two field sources. The underlying field sources must be actual projected fields that represent actual schema fields and that must not be transformed and aggregated in any way, except for casting. The type of all the underlying field sources must be equivalent so that picking one of them would result in the same value type. + # Object with schema name: FieldSource + ], + "virtualFieldType": "A String", # Required. The type of the virtual field. + }, }, }, ], @@ -931,6 +1057,12 @@

Method Details

"type": "A String", # Required. Specifies the aggregation function. Use one of the following string identifiers: "average": Computes the average (AVG). Applies only to numeric values. "count": Counts the number of values (COUNT). "count-distinct": Counts the number of distinct values (COUNT DISTINCT). "count-distinct-approx": Approximates the count of distinct values (APPROX_COUNT_DISTINCT). "max": Finds the maximum value (MAX). Applies only to numeric values. "min": Finds the minimum value (MIN). Applies only to numeric values. "sum": Computes the sum (SUM). Applies only to numeric values. }, "truncationGranularity": "A String", # The truncation granularity when grouping by a time/date field. This will be used to truncate the field to the granularity specified. This can be either a date or a time granularity found at https://cloud.google.com/bigquery/docs/reference/standard-sql/timestamp_functions#timestamp_trunc_granularity_date and https://cloud.google.com/bigquery/docs/reference/standard-sql/timestamp_functions#timestamp_trunc_granularity_time respectively. + "virtualField": { # A virtual field is a field that is not physically present in the underlying data schema, but is created through specific operations within the query builder model based on other fields in the schema. # Optional. A virtual field definition, used in place of field to define a field that is computed from other fields rather than being directly present in the data schema.For example, a virtual field can be defined using COALESCE to select the first non-null value from a list of fields.If virtual_field is set, field must not be set. + "underlyingFieldSources": [ # The field sources that will be used to create the virtual field, based on the semantics of the virtual field type.The field sources must follow these rules, based on the virtual field type: - For VIRTUAL_FIELD_TYPE_UNSPECIFIED, this field must be empty. - For COALESCE, this field must be non-empty and include a minimum of two field sources. The underlying field sources must be actual projected fields that represent actual schema fields and that must not be transformed and aggregated in any way, except for casting. The type of all the underlying field sources must be equivalent so that picking one of them would result in the same value type. + # Object with schema name: FieldSource + ], + "virtualFieldType": "A String", # Required. The type of the virtual field. + }, }, }, "fieldSourceValue": { # A source that can be used to represent a "field of data" within various parts of a structured query, such as in SELECT, WHERE, or ORDER BY clauses. The term "field of data" is used here because it is not limited to literal fields in the underlying data schema. # The field. This will be the field that is set as the Right Hand Side of the filter. @@ -952,6 +1084,12 @@

Method Details

"type": "A String", # Required. Specifies the aggregation function. Use one of the following string identifiers: "average": Computes the average (AVG). Applies only to numeric values. "count": Counts the number of values (COUNT). "count-distinct": Counts the number of distinct values (COUNT DISTINCT). "count-distinct-approx": Approximates the count of distinct values (APPROX_COUNT_DISTINCT). "max": Finds the maximum value (MAX). Applies only to numeric values. "min": Finds the minimum value (MIN). Applies only to numeric values. "sum": Computes the sum (SUM). Applies only to numeric values. }, "truncationGranularity": "A String", # The truncation granularity when grouping by a time/date field. This will be used to truncate the field to the granularity specified. This can be either a date or a time granularity found at https://cloud.google.com/bigquery/docs/reference/standard-sql/timestamp_functions#timestamp_trunc_granularity_date and https://cloud.google.com/bigquery/docs/reference/standard-sql/timestamp_functions#timestamp_trunc_granularity_time respectively. + "virtualField": { # A virtual field is a field that is not physically present in the underlying data schema, but is created through specific operations within the query builder model based on other fields in the schema. # Optional. A virtual field definition, used in place of field to define a field that is computed from other fields rather than being directly present in the data schema.For example, a virtual field can be defined using COALESCE to select the first non-null value from a list of fields.If virtual_field is set, field must not be set. + "underlyingFieldSources": [ # The field sources that will be used to create the virtual field, based on the semantics of the virtual field type.The field sources must follow these rules, based on the virtual field type: - For VIRTUAL_FIELD_TYPE_UNSPECIFIED, this field must be empty. - For COALESCE, this field must be non-empty and include a minimum of two field sources. The underlying field sources must be actual projected fields that represent actual schema fields and that must not be transformed and aggregated in any way, except for casting. The type of all the underlying field sources must be equivalent so that picking one of them would result in the same value type. + # Object with schema name: FieldSource + ], + "virtualFieldType": "A String", # Required. The type of the virtual field. + }, }, }, "isNegation": True or False, # Determines if the NOT flag should be added to the comparator. @@ -981,6 +1119,12 @@

Method Details

"type": "A String", # Required. Specifies the aggregation function. Use one of the following string identifiers: "average": Computes the average (AVG). Applies only to numeric values. "count": Counts the number of values (COUNT). "count-distinct": Counts the number of distinct values (COUNT DISTINCT). "count-distinct-approx": Approximates the count of distinct values (APPROX_COUNT_DISTINCT). "max": Finds the maximum value (MAX). Applies only to numeric values. "min": Finds the minimum value (MIN). Applies only to numeric values. "sum": Computes the sum (SUM). Applies only to numeric values. }, "truncationGranularity": "A String", # The truncation granularity when grouping by a time/date field. This will be used to truncate the field to the granularity specified. This can be either a date or a time granularity found at https://cloud.google.com/bigquery/docs/reference/standard-sql/timestamp_functions#timestamp_trunc_granularity_date and https://cloud.google.com/bigquery/docs/reference/standard-sql/timestamp_functions#timestamp_trunc_granularity_time respectively. + "virtualField": { # A virtual field is a field that is not physically present in the underlying data schema, but is created through specific operations within the query builder model based on other fields in the schema. # Optional. A virtual field definition, used in place of field to define a field that is computed from other fields rather than being directly present in the data schema.For example, a virtual field can be defined using COALESCE to select the first non-null value from a list of fields.If virtual_field is set, field must not be set. + "underlyingFieldSources": [ # The field sources that will be used to create the virtual field, based on the semantics of the virtual field type.The field sources must follow these rules, based on the virtual field type: - For VIRTUAL_FIELD_TYPE_UNSPECIFIED, this field must be empty. - For COALESCE, this field must be non-empty and include a minimum of two field sources. The underlying field sources must be actual projected fields that represent actual schema fields and that must not be transformed and aggregated in any way, except for casting. The type of all the underlying field sources must be equivalent so that picking one of them would result in the same value type. + # Object with schema name: FieldSource + ], + "virtualFieldType": "A String", # Required. The type of the virtual field. + }, }, }, "sortOrderDirection": "A String", # The sort order to use for the query. diff --git a/docs/dyn/logging_v2.organizations.locations.recentQueries.html b/docs/dyn/logging_v2.organizations.locations.recentQueries.html index e6fe4c202d..53d7475ca9 100644 --- a/docs/dyn/logging_v2.organizations.locations.recentQueries.html +++ b/docs/dyn/logging_v2.organizations.locations.recentQueries.html @@ -144,6 +144,12 @@

Method Details

"type": "A String", # Required. Specifies the aggregation function. Use one of the following string identifiers: "average": Computes the average (AVG). Applies only to numeric values. "count": Counts the number of values (COUNT). "count-distinct": Counts the number of distinct values (COUNT DISTINCT). "count-distinct-approx": Approximates the count of distinct values (APPROX_COUNT_DISTINCT). "max": Finds the maximum value (MAX). Applies only to numeric values. "min": Finds the minimum value (MIN). Applies only to numeric values. "sum": Computes the sum (SUM). Applies only to numeric values. }, "truncationGranularity": "A String", # The truncation granularity when grouping by a time/date field. This will be used to truncate the field to the granularity specified. This can be either a date or a time granularity found at https://cloud.google.com/bigquery/docs/reference/standard-sql/timestamp_functions#timestamp_trunc_granularity_date and https://cloud.google.com/bigquery/docs/reference/standard-sql/timestamp_functions#timestamp_trunc_granularity_time respectively. + "virtualField": { # A virtual field is a field that is not physically present in the underlying data schema, but is created through specific operations within the query builder model based on other fields in the schema. # Optional. A virtual field definition, used in place of field to define a field that is computed from other fields rather than being directly present in the data schema.For example, a virtual field can be defined using COALESCE to select the first non-null value from a list of fields.If virtual_field is set, field must not be set. + "underlyingFieldSources": [ # The field sources that will be used to create the virtual field, based on the semantics of the virtual field type.The field sources must follow these rules, based on the virtual field type: - For VIRTUAL_FIELD_TYPE_UNSPECIFIED, this field must be empty. - For COALESCE, this field must be non-empty and include a minimum of two field sources. The underlying field sources must be actual projected fields that represent actual schema fields and that must not be transformed and aggregated in any way, except for casting. The type of all the underlying field sources must be equivalent so that picking one of them would result in the same value type. + # Object with schema name: FieldSource + ], + "virtualFieldType": "A String", # Required. The type of the virtual field. + }, }, }, ], @@ -172,6 +178,12 @@

Method Details

"type": "A String", # Required. Specifies the aggregation function. Use one of the following string identifiers: "average": Computes the average (AVG). Applies only to numeric values. "count": Counts the number of values (COUNT). "count-distinct": Counts the number of distinct values (COUNT DISTINCT). "count-distinct-approx": Approximates the count of distinct values (APPROX_COUNT_DISTINCT). "max": Finds the maximum value (MAX). Applies only to numeric values. "min": Finds the minimum value (MIN). Applies only to numeric values. "sum": Computes the sum (SUM). Applies only to numeric values. }, "truncationGranularity": "A String", # The truncation granularity when grouping by a time/date field. This will be used to truncate the field to the granularity specified. This can be either a date or a time granularity found at https://cloud.google.com/bigquery/docs/reference/standard-sql/timestamp_functions#timestamp_trunc_granularity_date and https://cloud.google.com/bigquery/docs/reference/standard-sql/timestamp_functions#timestamp_trunc_granularity_time respectively. + "virtualField": { # A virtual field is a field that is not physically present in the underlying data schema, but is created through specific operations within the query builder model based on other fields in the schema. # Optional. A virtual field definition, used in place of field to define a field that is computed from other fields rather than being directly present in the data schema.For example, a virtual field can be defined using COALESCE to select the first non-null value from a list of fields.If virtual_field is set, field must not be set. + "underlyingFieldSources": [ # The field sources that will be used to create the virtual field, based on the semantics of the virtual field type.The field sources must follow these rules, based on the virtual field type: - For VIRTUAL_FIELD_TYPE_UNSPECIFIED, this field must be empty. - For COALESCE, this field must be non-empty and include a minimum of two field sources. The underlying field sources must be actual projected fields that represent actual schema fields and that must not be transformed and aggregated in any way, except for casting. The type of all the underlying field sources must be equivalent so that picking one of them would result in the same value type. + # Object with schema name: FieldSource + ], + "virtualFieldType": "A String", # Required. The type of the virtual field. + }, }, }, "fieldSourceValue": { # A source that can be used to represent a "field of data" within various parts of a structured query, such as in SELECT, WHERE, or ORDER BY clauses. The term "field of data" is used here because it is not limited to literal fields in the underlying data schema. # The field. This will be the field that is set as the Right Hand Side of the filter. @@ -193,6 +205,12 @@

Method Details

"type": "A String", # Required. Specifies the aggregation function. Use one of the following string identifiers: "average": Computes the average (AVG). Applies only to numeric values. "count": Counts the number of values (COUNT). "count-distinct": Counts the number of distinct values (COUNT DISTINCT). "count-distinct-approx": Approximates the count of distinct values (APPROX_COUNT_DISTINCT). "max": Finds the maximum value (MAX). Applies only to numeric values. "min": Finds the minimum value (MIN). Applies only to numeric values. "sum": Computes the sum (SUM). Applies only to numeric values. }, "truncationGranularity": "A String", # The truncation granularity when grouping by a time/date field. This will be used to truncate the field to the granularity specified. This can be either a date or a time granularity found at https://cloud.google.com/bigquery/docs/reference/standard-sql/timestamp_functions#timestamp_trunc_granularity_date and https://cloud.google.com/bigquery/docs/reference/standard-sql/timestamp_functions#timestamp_trunc_granularity_time respectively. + "virtualField": { # A virtual field is a field that is not physically present in the underlying data schema, but is created through specific operations within the query builder model based on other fields in the schema. # Optional. A virtual field definition, used in place of field to define a field that is computed from other fields rather than being directly present in the data schema.For example, a virtual field can be defined using COALESCE to select the first non-null value from a list of fields.If virtual_field is set, field must not be set. + "underlyingFieldSources": [ # The field sources that will be used to create the virtual field, based on the semantics of the virtual field type.The field sources must follow these rules, based on the virtual field type: - For VIRTUAL_FIELD_TYPE_UNSPECIFIED, this field must be empty. - For COALESCE, this field must be non-empty and include a minimum of two field sources. The underlying field sources must be actual projected fields that represent actual schema fields and that must not be transformed and aggregated in any way, except for casting. The type of all the underlying field sources must be equivalent so that picking one of them would result in the same value type. + # Object with schema name: FieldSource + ], + "virtualFieldType": "A String", # Required. The type of the virtual field. + }, }, }, "isNegation": True or False, # Determines if the NOT flag should be added to the comparator. @@ -222,6 +240,12 @@

Method Details

"type": "A String", # Required. Specifies the aggregation function. Use one of the following string identifiers: "average": Computes the average (AVG). Applies only to numeric values. "count": Counts the number of values (COUNT). "count-distinct": Counts the number of distinct values (COUNT DISTINCT). "count-distinct-approx": Approximates the count of distinct values (APPROX_COUNT_DISTINCT). "max": Finds the maximum value (MAX). Applies only to numeric values. "min": Finds the minimum value (MIN). Applies only to numeric values. "sum": Computes the sum (SUM). Applies only to numeric values. }, "truncationGranularity": "A String", # The truncation granularity when grouping by a time/date field. This will be used to truncate the field to the granularity specified. This can be either a date or a time granularity found at https://cloud.google.com/bigquery/docs/reference/standard-sql/timestamp_functions#timestamp_trunc_granularity_date and https://cloud.google.com/bigquery/docs/reference/standard-sql/timestamp_functions#timestamp_trunc_granularity_time respectively. + "virtualField": { # A virtual field is a field that is not physically present in the underlying data schema, but is created through specific operations within the query builder model based on other fields in the schema. # Optional. A virtual field definition, used in place of field to define a field that is computed from other fields rather than being directly present in the data schema.For example, a virtual field can be defined using COALESCE to select the first non-null value from a list of fields.If virtual_field is set, field must not be set. + "underlyingFieldSources": [ # The field sources that will be used to create the virtual field, based on the semantics of the virtual field type.The field sources must follow these rules, based on the virtual field type: - For VIRTUAL_FIELD_TYPE_UNSPECIFIED, this field must be empty. - For COALESCE, this field must be non-empty and include a minimum of two field sources. The underlying field sources must be actual projected fields that represent actual schema fields and that must not be transformed and aggregated in any way, except for casting. The type of all the underlying field sources must be equivalent so that picking one of them would result in the same value type. + # Object with schema name: FieldSource + ], + "virtualFieldType": "A String", # Required. The type of the virtual field. + }, }, }, "sortOrderDirection": "A String", # The sort order to use for the query. diff --git a/docs/dyn/logging_v2.organizations.locations.savedQueries.html b/docs/dyn/logging_v2.organizations.locations.savedQueries.html index e5f8cffa81..a584585bed 100644 --- a/docs/dyn/logging_v2.organizations.locations.savedQueries.html +++ b/docs/dyn/logging_v2.organizations.locations.savedQueries.html @@ -147,6 +147,12 @@

Method Details

"type": "A String", # Required. Specifies the aggregation function. Use one of the following string identifiers: "average": Computes the average (AVG). Applies only to numeric values. "count": Counts the number of values (COUNT). "count-distinct": Counts the number of distinct values (COUNT DISTINCT). "count-distinct-approx": Approximates the count of distinct values (APPROX_COUNT_DISTINCT). "max": Finds the maximum value (MAX). Applies only to numeric values. "min": Finds the minimum value (MIN). Applies only to numeric values. "sum": Computes the sum (SUM). Applies only to numeric values. }, "truncationGranularity": "A String", # The truncation granularity when grouping by a time/date field. This will be used to truncate the field to the granularity specified. This can be either a date or a time granularity found at https://cloud.google.com/bigquery/docs/reference/standard-sql/timestamp_functions#timestamp_trunc_granularity_date and https://cloud.google.com/bigquery/docs/reference/standard-sql/timestamp_functions#timestamp_trunc_granularity_time respectively. + "virtualField": { # A virtual field is a field that is not physically present in the underlying data schema, but is created through specific operations within the query builder model based on other fields in the schema. # Optional. A virtual field definition, used in place of field to define a field that is computed from other fields rather than being directly present in the data schema.For example, a virtual field can be defined using COALESCE to select the first non-null value from a list of fields.If virtual_field is set, field must not be set. + "underlyingFieldSources": [ # The field sources that will be used to create the virtual field, based on the semantics of the virtual field type.The field sources must follow these rules, based on the virtual field type: - For VIRTUAL_FIELD_TYPE_UNSPECIFIED, this field must be empty. - For COALESCE, this field must be non-empty and include a minimum of two field sources. The underlying field sources must be actual projected fields that represent actual schema fields and that must not be transformed and aggregated in any way, except for casting. The type of all the underlying field sources must be equivalent so that picking one of them would result in the same value type. + # Object with schema name: FieldSource + ], + "virtualFieldType": "A String", # Required. The type of the virtual field. + }, }, }, ], @@ -175,6 +181,12 @@

Method Details

"type": "A String", # Required. Specifies the aggregation function. Use one of the following string identifiers: "average": Computes the average (AVG). Applies only to numeric values. "count": Counts the number of values (COUNT). "count-distinct": Counts the number of distinct values (COUNT DISTINCT). "count-distinct-approx": Approximates the count of distinct values (APPROX_COUNT_DISTINCT). "max": Finds the maximum value (MAX). Applies only to numeric values. "min": Finds the minimum value (MIN). Applies only to numeric values. "sum": Computes the sum (SUM). Applies only to numeric values. }, "truncationGranularity": "A String", # The truncation granularity when grouping by a time/date field. This will be used to truncate the field to the granularity specified. This can be either a date or a time granularity found at https://cloud.google.com/bigquery/docs/reference/standard-sql/timestamp_functions#timestamp_trunc_granularity_date and https://cloud.google.com/bigquery/docs/reference/standard-sql/timestamp_functions#timestamp_trunc_granularity_time respectively. + "virtualField": { # A virtual field is a field that is not physically present in the underlying data schema, but is created through specific operations within the query builder model based on other fields in the schema. # Optional. A virtual field definition, used in place of field to define a field that is computed from other fields rather than being directly present in the data schema.For example, a virtual field can be defined using COALESCE to select the first non-null value from a list of fields.If virtual_field is set, field must not be set. + "underlyingFieldSources": [ # The field sources that will be used to create the virtual field, based on the semantics of the virtual field type.The field sources must follow these rules, based on the virtual field type: - For VIRTUAL_FIELD_TYPE_UNSPECIFIED, this field must be empty. - For COALESCE, this field must be non-empty and include a minimum of two field sources. The underlying field sources must be actual projected fields that represent actual schema fields and that must not be transformed and aggregated in any way, except for casting. The type of all the underlying field sources must be equivalent so that picking one of them would result in the same value type. + # Object with schema name: FieldSource + ], + "virtualFieldType": "A String", # Required. The type of the virtual field. + }, }, }, "fieldSourceValue": { # A source that can be used to represent a "field of data" within various parts of a structured query, such as in SELECT, WHERE, or ORDER BY clauses. The term "field of data" is used here because it is not limited to literal fields in the underlying data schema. # The field. This will be the field that is set as the Right Hand Side of the filter. @@ -196,6 +208,12 @@

Method Details

"type": "A String", # Required. Specifies the aggregation function. Use one of the following string identifiers: "average": Computes the average (AVG). Applies only to numeric values. "count": Counts the number of values (COUNT). "count-distinct": Counts the number of distinct values (COUNT DISTINCT). "count-distinct-approx": Approximates the count of distinct values (APPROX_COUNT_DISTINCT). "max": Finds the maximum value (MAX). Applies only to numeric values. "min": Finds the minimum value (MIN). Applies only to numeric values. "sum": Computes the sum (SUM). Applies only to numeric values. }, "truncationGranularity": "A String", # The truncation granularity when grouping by a time/date field. This will be used to truncate the field to the granularity specified. This can be either a date or a time granularity found at https://cloud.google.com/bigquery/docs/reference/standard-sql/timestamp_functions#timestamp_trunc_granularity_date and https://cloud.google.com/bigquery/docs/reference/standard-sql/timestamp_functions#timestamp_trunc_granularity_time respectively. + "virtualField": { # A virtual field is a field that is not physically present in the underlying data schema, but is created through specific operations within the query builder model based on other fields in the schema. # Optional. A virtual field definition, used in place of field to define a field that is computed from other fields rather than being directly present in the data schema.For example, a virtual field can be defined using COALESCE to select the first non-null value from a list of fields.If virtual_field is set, field must not be set. + "underlyingFieldSources": [ # The field sources that will be used to create the virtual field, based on the semantics of the virtual field type.The field sources must follow these rules, based on the virtual field type: - For VIRTUAL_FIELD_TYPE_UNSPECIFIED, this field must be empty. - For COALESCE, this field must be non-empty and include a minimum of two field sources. The underlying field sources must be actual projected fields that represent actual schema fields and that must not be transformed and aggregated in any way, except for casting. The type of all the underlying field sources must be equivalent so that picking one of them would result in the same value type. + # Object with schema name: FieldSource + ], + "virtualFieldType": "A String", # Required. The type of the virtual field. + }, }, }, "isNegation": True or False, # Determines if the NOT flag should be added to the comparator. @@ -225,6 +243,12 @@

Method Details

"type": "A String", # Required. Specifies the aggregation function. Use one of the following string identifiers: "average": Computes the average (AVG). Applies only to numeric values. "count": Counts the number of values (COUNT). "count-distinct": Counts the number of distinct values (COUNT DISTINCT). "count-distinct-approx": Approximates the count of distinct values (APPROX_COUNT_DISTINCT). "max": Finds the maximum value (MAX). Applies only to numeric values. "min": Finds the minimum value (MIN). Applies only to numeric values. "sum": Computes the sum (SUM). Applies only to numeric values. }, "truncationGranularity": "A String", # The truncation granularity when grouping by a time/date field. This will be used to truncate the field to the granularity specified. This can be either a date or a time granularity found at https://cloud.google.com/bigquery/docs/reference/standard-sql/timestamp_functions#timestamp_trunc_granularity_date and https://cloud.google.com/bigquery/docs/reference/standard-sql/timestamp_functions#timestamp_trunc_granularity_time respectively. + "virtualField": { # A virtual field is a field that is not physically present in the underlying data schema, but is created through specific operations within the query builder model based on other fields in the schema. # Optional. A virtual field definition, used in place of field to define a field that is computed from other fields rather than being directly present in the data schema.For example, a virtual field can be defined using COALESCE to select the first non-null value from a list of fields.If virtual_field is set, field must not be set. + "underlyingFieldSources": [ # The field sources that will be used to create the virtual field, based on the semantics of the virtual field type.The field sources must follow these rules, based on the virtual field type: - For VIRTUAL_FIELD_TYPE_UNSPECIFIED, this field must be empty. - For COALESCE, this field must be non-empty and include a minimum of two field sources. The underlying field sources must be actual projected fields that represent actual schema fields and that must not be transformed and aggregated in any way, except for casting. The type of all the underlying field sources must be equivalent so that picking one of them would result in the same value type. + # Object with schema name: FieldSource + ], + "virtualFieldType": "A String", # Required. The type of the virtual field. + }, }, }, "sortOrderDirection": "A String", # The sort order to use for the query. @@ -287,6 +311,12 @@

Method Details

"type": "A String", # Required. Specifies the aggregation function. Use one of the following string identifiers: "average": Computes the average (AVG). Applies only to numeric values. "count": Counts the number of values (COUNT). "count-distinct": Counts the number of distinct values (COUNT DISTINCT). "count-distinct-approx": Approximates the count of distinct values (APPROX_COUNT_DISTINCT). "max": Finds the maximum value (MAX). Applies only to numeric values. "min": Finds the minimum value (MIN). Applies only to numeric values. "sum": Computes the sum (SUM). Applies only to numeric values. }, "truncationGranularity": "A String", # The truncation granularity when grouping by a time/date field. This will be used to truncate the field to the granularity specified. This can be either a date or a time granularity found at https://cloud.google.com/bigquery/docs/reference/standard-sql/timestamp_functions#timestamp_trunc_granularity_date and https://cloud.google.com/bigquery/docs/reference/standard-sql/timestamp_functions#timestamp_trunc_granularity_time respectively. + "virtualField": { # A virtual field is a field that is not physically present in the underlying data schema, but is created through specific operations within the query builder model based on other fields in the schema. # Optional. A virtual field definition, used in place of field to define a field that is computed from other fields rather than being directly present in the data schema.For example, a virtual field can be defined using COALESCE to select the first non-null value from a list of fields.If virtual_field is set, field must not be set. + "underlyingFieldSources": [ # The field sources that will be used to create the virtual field, based on the semantics of the virtual field type.The field sources must follow these rules, based on the virtual field type: - For VIRTUAL_FIELD_TYPE_UNSPECIFIED, this field must be empty. - For COALESCE, this field must be non-empty and include a minimum of two field sources. The underlying field sources must be actual projected fields that represent actual schema fields and that must not be transformed and aggregated in any way, except for casting. The type of all the underlying field sources must be equivalent so that picking one of them would result in the same value type. + # Object with schema name: FieldSource + ], + "virtualFieldType": "A String", # Required. The type of the virtual field. + }, }, }, ], @@ -315,6 +345,12 @@

Method Details

"type": "A String", # Required. Specifies the aggregation function. Use one of the following string identifiers: "average": Computes the average (AVG). Applies only to numeric values. "count": Counts the number of values (COUNT). "count-distinct": Counts the number of distinct values (COUNT DISTINCT). "count-distinct-approx": Approximates the count of distinct values (APPROX_COUNT_DISTINCT). "max": Finds the maximum value (MAX). Applies only to numeric values. "min": Finds the minimum value (MIN). Applies only to numeric values. "sum": Computes the sum (SUM). Applies only to numeric values. }, "truncationGranularity": "A String", # The truncation granularity when grouping by a time/date field. This will be used to truncate the field to the granularity specified. This can be either a date or a time granularity found at https://cloud.google.com/bigquery/docs/reference/standard-sql/timestamp_functions#timestamp_trunc_granularity_date and https://cloud.google.com/bigquery/docs/reference/standard-sql/timestamp_functions#timestamp_trunc_granularity_time respectively. + "virtualField": { # A virtual field is a field that is not physically present in the underlying data schema, but is created through specific operations within the query builder model based on other fields in the schema. # Optional. A virtual field definition, used in place of field to define a field that is computed from other fields rather than being directly present in the data schema.For example, a virtual field can be defined using COALESCE to select the first non-null value from a list of fields.If virtual_field is set, field must not be set. + "underlyingFieldSources": [ # The field sources that will be used to create the virtual field, based on the semantics of the virtual field type.The field sources must follow these rules, based on the virtual field type: - For VIRTUAL_FIELD_TYPE_UNSPECIFIED, this field must be empty. - For COALESCE, this field must be non-empty and include a minimum of two field sources. The underlying field sources must be actual projected fields that represent actual schema fields and that must not be transformed and aggregated in any way, except for casting. The type of all the underlying field sources must be equivalent so that picking one of them would result in the same value type. + # Object with schema name: FieldSource + ], + "virtualFieldType": "A String", # Required. The type of the virtual field. + }, }, }, "fieldSourceValue": { # A source that can be used to represent a "field of data" within various parts of a structured query, such as in SELECT, WHERE, or ORDER BY clauses. The term "field of data" is used here because it is not limited to literal fields in the underlying data schema. # The field. This will be the field that is set as the Right Hand Side of the filter. @@ -336,6 +372,12 @@

Method Details

"type": "A String", # Required. Specifies the aggregation function. Use one of the following string identifiers: "average": Computes the average (AVG). Applies only to numeric values. "count": Counts the number of values (COUNT). "count-distinct": Counts the number of distinct values (COUNT DISTINCT). "count-distinct-approx": Approximates the count of distinct values (APPROX_COUNT_DISTINCT). "max": Finds the maximum value (MAX). Applies only to numeric values. "min": Finds the minimum value (MIN). Applies only to numeric values. "sum": Computes the sum (SUM). Applies only to numeric values. }, "truncationGranularity": "A String", # The truncation granularity when grouping by a time/date field. This will be used to truncate the field to the granularity specified. This can be either a date or a time granularity found at https://cloud.google.com/bigquery/docs/reference/standard-sql/timestamp_functions#timestamp_trunc_granularity_date and https://cloud.google.com/bigquery/docs/reference/standard-sql/timestamp_functions#timestamp_trunc_granularity_time respectively. + "virtualField": { # A virtual field is a field that is not physically present in the underlying data schema, but is created through specific operations within the query builder model based on other fields in the schema. # Optional. A virtual field definition, used in place of field to define a field that is computed from other fields rather than being directly present in the data schema.For example, a virtual field can be defined using COALESCE to select the first non-null value from a list of fields.If virtual_field is set, field must not be set. + "underlyingFieldSources": [ # The field sources that will be used to create the virtual field, based on the semantics of the virtual field type.The field sources must follow these rules, based on the virtual field type: - For VIRTUAL_FIELD_TYPE_UNSPECIFIED, this field must be empty. - For COALESCE, this field must be non-empty and include a minimum of two field sources. The underlying field sources must be actual projected fields that represent actual schema fields and that must not be transformed and aggregated in any way, except for casting. The type of all the underlying field sources must be equivalent so that picking one of them would result in the same value type. + # Object with schema name: FieldSource + ], + "virtualFieldType": "A String", # Required. The type of the virtual field. + }, }, }, "isNegation": True or False, # Determines if the NOT flag should be added to the comparator. @@ -365,6 +407,12 @@

Method Details

"type": "A String", # Required. Specifies the aggregation function. Use one of the following string identifiers: "average": Computes the average (AVG). Applies only to numeric values. "count": Counts the number of values (COUNT). "count-distinct": Counts the number of distinct values (COUNT DISTINCT). "count-distinct-approx": Approximates the count of distinct values (APPROX_COUNT_DISTINCT). "max": Finds the maximum value (MAX). Applies only to numeric values. "min": Finds the minimum value (MIN). Applies only to numeric values. "sum": Computes the sum (SUM). Applies only to numeric values. }, "truncationGranularity": "A String", # The truncation granularity when grouping by a time/date field. This will be used to truncate the field to the granularity specified. This can be either a date or a time granularity found at https://cloud.google.com/bigquery/docs/reference/standard-sql/timestamp_functions#timestamp_trunc_granularity_date and https://cloud.google.com/bigquery/docs/reference/standard-sql/timestamp_functions#timestamp_trunc_granularity_time respectively. + "virtualField": { # A virtual field is a field that is not physically present in the underlying data schema, but is created through specific operations within the query builder model based on other fields in the schema. # Optional. A virtual field definition, used in place of field to define a field that is computed from other fields rather than being directly present in the data schema.For example, a virtual field can be defined using COALESCE to select the first non-null value from a list of fields.If virtual_field is set, field must not be set. + "underlyingFieldSources": [ # The field sources that will be used to create the virtual field, based on the semantics of the virtual field type.The field sources must follow these rules, based on the virtual field type: - For VIRTUAL_FIELD_TYPE_UNSPECIFIED, this field must be empty. - For COALESCE, this field must be non-empty and include a minimum of two field sources. The underlying field sources must be actual projected fields that represent actual schema fields and that must not be transformed and aggregated in any way, except for casting. The type of all the underlying field sources must be equivalent so that picking one of them would result in the same value type. + # Object with schema name: FieldSource + ], + "virtualFieldType": "A String", # Required. The type of the virtual field. + }, }, }, "sortOrderDirection": "A String", # The sort order to use for the query. @@ -451,6 +499,12 @@

Method Details

"type": "A String", # Required. Specifies the aggregation function. Use one of the following string identifiers: "average": Computes the average (AVG). Applies only to numeric values. "count": Counts the number of values (COUNT). "count-distinct": Counts the number of distinct values (COUNT DISTINCT). "count-distinct-approx": Approximates the count of distinct values (APPROX_COUNT_DISTINCT). "max": Finds the maximum value (MAX). Applies only to numeric values. "min": Finds the minimum value (MIN). Applies only to numeric values. "sum": Computes the sum (SUM). Applies only to numeric values. }, "truncationGranularity": "A String", # The truncation granularity when grouping by a time/date field. This will be used to truncate the field to the granularity specified. This can be either a date or a time granularity found at https://cloud.google.com/bigquery/docs/reference/standard-sql/timestamp_functions#timestamp_trunc_granularity_date and https://cloud.google.com/bigquery/docs/reference/standard-sql/timestamp_functions#timestamp_trunc_granularity_time respectively. + "virtualField": { # A virtual field is a field that is not physically present in the underlying data schema, but is created through specific operations within the query builder model based on other fields in the schema. # Optional. A virtual field definition, used in place of field to define a field that is computed from other fields rather than being directly present in the data schema.For example, a virtual field can be defined using COALESCE to select the first non-null value from a list of fields.If virtual_field is set, field must not be set. + "underlyingFieldSources": [ # The field sources that will be used to create the virtual field, based on the semantics of the virtual field type.The field sources must follow these rules, based on the virtual field type: - For VIRTUAL_FIELD_TYPE_UNSPECIFIED, this field must be empty. - For COALESCE, this field must be non-empty and include a minimum of two field sources. The underlying field sources must be actual projected fields that represent actual schema fields and that must not be transformed and aggregated in any way, except for casting. The type of all the underlying field sources must be equivalent so that picking one of them would result in the same value type. + # Object with schema name: FieldSource + ], + "virtualFieldType": "A String", # Required. The type of the virtual field. + }, }, }, ], @@ -479,6 +533,12 @@

Method Details

"type": "A String", # Required. Specifies the aggregation function. Use one of the following string identifiers: "average": Computes the average (AVG). Applies only to numeric values. "count": Counts the number of values (COUNT). "count-distinct": Counts the number of distinct values (COUNT DISTINCT). "count-distinct-approx": Approximates the count of distinct values (APPROX_COUNT_DISTINCT). "max": Finds the maximum value (MAX). Applies only to numeric values. "min": Finds the minimum value (MIN). Applies only to numeric values. "sum": Computes the sum (SUM). Applies only to numeric values. }, "truncationGranularity": "A String", # The truncation granularity when grouping by a time/date field. This will be used to truncate the field to the granularity specified. This can be either a date or a time granularity found at https://cloud.google.com/bigquery/docs/reference/standard-sql/timestamp_functions#timestamp_trunc_granularity_date and https://cloud.google.com/bigquery/docs/reference/standard-sql/timestamp_functions#timestamp_trunc_granularity_time respectively. + "virtualField": { # A virtual field is a field that is not physically present in the underlying data schema, but is created through specific operations within the query builder model based on other fields in the schema. # Optional. A virtual field definition, used in place of field to define a field that is computed from other fields rather than being directly present in the data schema.For example, a virtual field can be defined using COALESCE to select the first non-null value from a list of fields.If virtual_field is set, field must not be set. + "underlyingFieldSources": [ # The field sources that will be used to create the virtual field, based on the semantics of the virtual field type.The field sources must follow these rules, based on the virtual field type: - For VIRTUAL_FIELD_TYPE_UNSPECIFIED, this field must be empty. - For COALESCE, this field must be non-empty and include a minimum of two field sources. The underlying field sources must be actual projected fields that represent actual schema fields and that must not be transformed and aggregated in any way, except for casting. The type of all the underlying field sources must be equivalent so that picking one of them would result in the same value type. + # Object with schema name: FieldSource + ], + "virtualFieldType": "A String", # Required. The type of the virtual field. + }, }, }, "fieldSourceValue": { # A source that can be used to represent a "field of data" within various parts of a structured query, such as in SELECT, WHERE, or ORDER BY clauses. The term "field of data" is used here because it is not limited to literal fields in the underlying data schema. # The field. This will be the field that is set as the Right Hand Side of the filter. @@ -500,6 +560,12 @@

Method Details

"type": "A String", # Required. Specifies the aggregation function. Use one of the following string identifiers: "average": Computes the average (AVG). Applies only to numeric values. "count": Counts the number of values (COUNT). "count-distinct": Counts the number of distinct values (COUNT DISTINCT). "count-distinct-approx": Approximates the count of distinct values (APPROX_COUNT_DISTINCT). "max": Finds the maximum value (MAX). Applies only to numeric values. "min": Finds the minimum value (MIN). Applies only to numeric values. "sum": Computes the sum (SUM). Applies only to numeric values. }, "truncationGranularity": "A String", # The truncation granularity when grouping by a time/date field. This will be used to truncate the field to the granularity specified. This can be either a date or a time granularity found at https://cloud.google.com/bigquery/docs/reference/standard-sql/timestamp_functions#timestamp_trunc_granularity_date and https://cloud.google.com/bigquery/docs/reference/standard-sql/timestamp_functions#timestamp_trunc_granularity_time respectively. + "virtualField": { # A virtual field is a field that is not physically present in the underlying data schema, but is created through specific operations within the query builder model based on other fields in the schema. # Optional. A virtual field definition, used in place of field to define a field that is computed from other fields rather than being directly present in the data schema.For example, a virtual field can be defined using COALESCE to select the first non-null value from a list of fields.If virtual_field is set, field must not be set. + "underlyingFieldSources": [ # The field sources that will be used to create the virtual field, based on the semantics of the virtual field type.The field sources must follow these rules, based on the virtual field type: - For VIRTUAL_FIELD_TYPE_UNSPECIFIED, this field must be empty. - For COALESCE, this field must be non-empty and include a minimum of two field sources. The underlying field sources must be actual projected fields that represent actual schema fields and that must not be transformed and aggregated in any way, except for casting. The type of all the underlying field sources must be equivalent so that picking one of them would result in the same value type. + # Object with schema name: FieldSource + ], + "virtualFieldType": "A String", # Required. The type of the virtual field. + }, }, }, "isNegation": True or False, # Determines if the NOT flag should be added to the comparator. @@ -529,6 +595,12 @@

Method Details

"type": "A String", # Required. Specifies the aggregation function. Use one of the following string identifiers: "average": Computes the average (AVG). Applies only to numeric values. "count": Counts the number of values (COUNT). "count-distinct": Counts the number of distinct values (COUNT DISTINCT). "count-distinct-approx": Approximates the count of distinct values (APPROX_COUNT_DISTINCT). "max": Finds the maximum value (MAX). Applies only to numeric values. "min": Finds the minimum value (MIN). Applies only to numeric values. "sum": Computes the sum (SUM). Applies only to numeric values. }, "truncationGranularity": "A String", # The truncation granularity when grouping by a time/date field. This will be used to truncate the field to the granularity specified. This can be either a date or a time granularity found at https://cloud.google.com/bigquery/docs/reference/standard-sql/timestamp_functions#timestamp_trunc_granularity_date and https://cloud.google.com/bigquery/docs/reference/standard-sql/timestamp_functions#timestamp_trunc_granularity_time respectively. + "virtualField": { # A virtual field is a field that is not physically present in the underlying data schema, but is created through specific operations within the query builder model based on other fields in the schema. # Optional. A virtual field definition, used in place of field to define a field that is computed from other fields rather than being directly present in the data schema.For example, a virtual field can be defined using COALESCE to select the first non-null value from a list of fields.If virtual_field is set, field must not be set. + "underlyingFieldSources": [ # The field sources that will be used to create the virtual field, based on the semantics of the virtual field type.The field sources must follow these rules, based on the virtual field type: - For VIRTUAL_FIELD_TYPE_UNSPECIFIED, this field must be empty. - For COALESCE, this field must be non-empty and include a minimum of two field sources. The underlying field sources must be actual projected fields that represent actual schema fields and that must not be transformed and aggregated in any way, except for casting. The type of all the underlying field sources must be equivalent so that picking one of them would result in the same value type. + # Object with schema name: FieldSource + ], + "virtualFieldType": "A String", # Required. The type of the virtual field. + }, }, }, "sortOrderDirection": "A String", # The sort order to use for the query. @@ -603,6 +675,12 @@

Method Details

"type": "A String", # Required. Specifies the aggregation function. Use one of the following string identifiers: "average": Computes the average (AVG). Applies only to numeric values. "count": Counts the number of values (COUNT). "count-distinct": Counts the number of distinct values (COUNT DISTINCT). "count-distinct-approx": Approximates the count of distinct values (APPROX_COUNT_DISTINCT). "max": Finds the maximum value (MAX). Applies only to numeric values. "min": Finds the minimum value (MIN). Applies only to numeric values. "sum": Computes the sum (SUM). Applies only to numeric values. }, "truncationGranularity": "A String", # The truncation granularity when grouping by a time/date field. This will be used to truncate the field to the granularity specified. This can be either a date or a time granularity found at https://cloud.google.com/bigquery/docs/reference/standard-sql/timestamp_functions#timestamp_trunc_granularity_date and https://cloud.google.com/bigquery/docs/reference/standard-sql/timestamp_functions#timestamp_trunc_granularity_time respectively. + "virtualField": { # A virtual field is a field that is not physically present in the underlying data schema, but is created through specific operations within the query builder model based on other fields in the schema. # Optional. A virtual field definition, used in place of field to define a field that is computed from other fields rather than being directly present in the data schema.For example, a virtual field can be defined using COALESCE to select the first non-null value from a list of fields.If virtual_field is set, field must not be set. + "underlyingFieldSources": [ # The field sources that will be used to create the virtual field, based on the semantics of the virtual field type.The field sources must follow these rules, based on the virtual field type: - For VIRTUAL_FIELD_TYPE_UNSPECIFIED, this field must be empty. - For COALESCE, this field must be non-empty and include a minimum of two field sources. The underlying field sources must be actual projected fields that represent actual schema fields and that must not be transformed and aggregated in any way, except for casting. The type of all the underlying field sources must be equivalent so that picking one of them would result in the same value type. + # Object with schema name: FieldSource + ], + "virtualFieldType": "A String", # Required. The type of the virtual field. + }, }, }, ], @@ -631,6 +709,12 @@

Method Details

"type": "A String", # Required. Specifies the aggregation function. Use one of the following string identifiers: "average": Computes the average (AVG). Applies only to numeric values. "count": Counts the number of values (COUNT). "count-distinct": Counts the number of distinct values (COUNT DISTINCT). "count-distinct-approx": Approximates the count of distinct values (APPROX_COUNT_DISTINCT). "max": Finds the maximum value (MAX). Applies only to numeric values. "min": Finds the minimum value (MIN). Applies only to numeric values. "sum": Computes the sum (SUM). Applies only to numeric values. }, "truncationGranularity": "A String", # The truncation granularity when grouping by a time/date field. This will be used to truncate the field to the granularity specified. This can be either a date or a time granularity found at https://cloud.google.com/bigquery/docs/reference/standard-sql/timestamp_functions#timestamp_trunc_granularity_date and https://cloud.google.com/bigquery/docs/reference/standard-sql/timestamp_functions#timestamp_trunc_granularity_time respectively. + "virtualField": { # A virtual field is a field that is not physically present in the underlying data schema, but is created through specific operations within the query builder model based on other fields in the schema. # Optional. A virtual field definition, used in place of field to define a field that is computed from other fields rather than being directly present in the data schema.For example, a virtual field can be defined using COALESCE to select the first non-null value from a list of fields.If virtual_field is set, field must not be set. + "underlyingFieldSources": [ # The field sources that will be used to create the virtual field, based on the semantics of the virtual field type.The field sources must follow these rules, based on the virtual field type: - For VIRTUAL_FIELD_TYPE_UNSPECIFIED, this field must be empty. - For COALESCE, this field must be non-empty and include a minimum of two field sources. The underlying field sources must be actual projected fields that represent actual schema fields and that must not be transformed and aggregated in any way, except for casting. The type of all the underlying field sources must be equivalent so that picking one of them would result in the same value type. + # Object with schema name: FieldSource + ], + "virtualFieldType": "A String", # Required. The type of the virtual field. + }, }, }, "fieldSourceValue": { # A source that can be used to represent a "field of data" within various parts of a structured query, such as in SELECT, WHERE, or ORDER BY clauses. The term "field of data" is used here because it is not limited to literal fields in the underlying data schema. # The field. This will be the field that is set as the Right Hand Side of the filter. @@ -652,6 +736,12 @@

Method Details

"type": "A String", # Required. Specifies the aggregation function. Use one of the following string identifiers: "average": Computes the average (AVG). Applies only to numeric values. "count": Counts the number of values (COUNT). "count-distinct": Counts the number of distinct values (COUNT DISTINCT). "count-distinct-approx": Approximates the count of distinct values (APPROX_COUNT_DISTINCT). "max": Finds the maximum value (MAX). Applies only to numeric values. "min": Finds the minimum value (MIN). Applies only to numeric values. "sum": Computes the sum (SUM). Applies only to numeric values. }, "truncationGranularity": "A String", # The truncation granularity when grouping by a time/date field. This will be used to truncate the field to the granularity specified. This can be either a date or a time granularity found at https://cloud.google.com/bigquery/docs/reference/standard-sql/timestamp_functions#timestamp_trunc_granularity_date and https://cloud.google.com/bigquery/docs/reference/standard-sql/timestamp_functions#timestamp_trunc_granularity_time respectively. + "virtualField": { # A virtual field is a field that is not physically present in the underlying data schema, but is created through specific operations within the query builder model based on other fields in the schema. # Optional. A virtual field definition, used in place of field to define a field that is computed from other fields rather than being directly present in the data schema.For example, a virtual field can be defined using COALESCE to select the first non-null value from a list of fields.If virtual_field is set, field must not be set. + "underlyingFieldSources": [ # The field sources that will be used to create the virtual field, based on the semantics of the virtual field type.The field sources must follow these rules, based on the virtual field type: - For VIRTUAL_FIELD_TYPE_UNSPECIFIED, this field must be empty. - For COALESCE, this field must be non-empty and include a minimum of two field sources. The underlying field sources must be actual projected fields that represent actual schema fields and that must not be transformed and aggregated in any way, except for casting. The type of all the underlying field sources must be equivalent so that picking one of them would result in the same value type. + # Object with schema name: FieldSource + ], + "virtualFieldType": "A String", # Required. The type of the virtual field. + }, }, }, "isNegation": True or False, # Determines if the NOT flag should be added to the comparator. @@ -681,6 +771,12 @@

Method Details

"type": "A String", # Required. Specifies the aggregation function. Use one of the following string identifiers: "average": Computes the average (AVG). Applies only to numeric values. "count": Counts the number of values (COUNT). "count-distinct": Counts the number of distinct values (COUNT DISTINCT). "count-distinct-approx": Approximates the count of distinct values (APPROX_COUNT_DISTINCT). "max": Finds the maximum value (MAX). Applies only to numeric values. "min": Finds the minimum value (MIN). Applies only to numeric values. "sum": Computes the sum (SUM). Applies only to numeric values. }, "truncationGranularity": "A String", # The truncation granularity when grouping by a time/date field. This will be used to truncate the field to the granularity specified. This can be either a date or a time granularity found at https://cloud.google.com/bigquery/docs/reference/standard-sql/timestamp_functions#timestamp_trunc_granularity_date and https://cloud.google.com/bigquery/docs/reference/standard-sql/timestamp_functions#timestamp_trunc_granularity_time respectively. + "virtualField": { # A virtual field is a field that is not physically present in the underlying data schema, but is created through specific operations within the query builder model based on other fields in the schema. # Optional. A virtual field definition, used in place of field to define a field that is computed from other fields rather than being directly present in the data schema.For example, a virtual field can be defined using COALESCE to select the first non-null value from a list of fields.If virtual_field is set, field must not be set. + "underlyingFieldSources": [ # The field sources that will be used to create the virtual field, based on the semantics of the virtual field type.The field sources must follow these rules, based on the virtual field type: - For VIRTUAL_FIELD_TYPE_UNSPECIFIED, this field must be empty. - For COALESCE, this field must be non-empty and include a minimum of two field sources. The underlying field sources must be actual projected fields that represent actual schema fields and that must not be transformed and aggregated in any way, except for casting. The type of all the underlying field sources must be equivalent so that picking one of them would result in the same value type. + # Object with schema name: FieldSource + ], + "virtualFieldType": "A String", # Required. The type of the virtual field. + }, }, }, "sortOrderDirection": "A String", # The sort order to use for the query. @@ -763,6 +859,12 @@

Method Details

"type": "A String", # Required. Specifies the aggregation function. Use one of the following string identifiers: "average": Computes the average (AVG). Applies only to numeric values. "count": Counts the number of values (COUNT). "count-distinct": Counts the number of distinct values (COUNT DISTINCT). "count-distinct-approx": Approximates the count of distinct values (APPROX_COUNT_DISTINCT). "max": Finds the maximum value (MAX). Applies only to numeric values. "min": Finds the minimum value (MIN). Applies only to numeric values. "sum": Computes the sum (SUM). Applies only to numeric values. }, "truncationGranularity": "A String", # The truncation granularity when grouping by a time/date field. This will be used to truncate the field to the granularity specified. This can be either a date or a time granularity found at https://cloud.google.com/bigquery/docs/reference/standard-sql/timestamp_functions#timestamp_trunc_granularity_date and https://cloud.google.com/bigquery/docs/reference/standard-sql/timestamp_functions#timestamp_trunc_granularity_time respectively. + "virtualField": { # A virtual field is a field that is not physically present in the underlying data schema, but is created through specific operations within the query builder model based on other fields in the schema. # Optional. A virtual field definition, used in place of field to define a field that is computed from other fields rather than being directly present in the data schema.For example, a virtual field can be defined using COALESCE to select the first non-null value from a list of fields.If virtual_field is set, field must not be set. + "underlyingFieldSources": [ # The field sources that will be used to create the virtual field, based on the semantics of the virtual field type.The field sources must follow these rules, based on the virtual field type: - For VIRTUAL_FIELD_TYPE_UNSPECIFIED, this field must be empty. - For COALESCE, this field must be non-empty and include a minimum of two field sources. The underlying field sources must be actual projected fields that represent actual schema fields and that must not be transformed and aggregated in any way, except for casting. The type of all the underlying field sources must be equivalent so that picking one of them would result in the same value type. + # Object with schema name: FieldSource + ], + "virtualFieldType": "A String", # Required. The type of the virtual field. + }, }, }, ], @@ -791,6 +893,12 @@

Method Details

"type": "A String", # Required. Specifies the aggregation function. Use one of the following string identifiers: "average": Computes the average (AVG). Applies only to numeric values. "count": Counts the number of values (COUNT). "count-distinct": Counts the number of distinct values (COUNT DISTINCT). "count-distinct-approx": Approximates the count of distinct values (APPROX_COUNT_DISTINCT). "max": Finds the maximum value (MAX). Applies only to numeric values. "min": Finds the minimum value (MIN). Applies only to numeric values. "sum": Computes the sum (SUM). Applies only to numeric values. }, "truncationGranularity": "A String", # The truncation granularity when grouping by a time/date field. This will be used to truncate the field to the granularity specified. This can be either a date or a time granularity found at https://cloud.google.com/bigquery/docs/reference/standard-sql/timestamp_functions#timestamp_trunc_granularity_date and https://cloud.google.com/bigquery/docs/reference/standard-sql/timestamp_functions#timestamp_trunc_granularity_time respectively. + "virtualField": { # A virtual field is a field that is not physically present in the underlying data schema, but is created through specific operations within the query builder model based on other fields in the schema. # Optional. A virtual field definition, used in place of field to define a field that is computed from other fields rather than being directly present in the data schema.For example, a virtual field can be defined using COALESCE to select the first non-null value from a list of fields.If virtual_field is set, field must not be set. + "underlyingFieldSources": [ # The field sources that will be used to create the virtual field, based on the semantics of the virtual field type.The field sources must follow these rules, based on the virtual field type: - For VIRTUAL_FIELD_TYPE_UNSPECIFIED, this field must be empty. - For COALESCE, this field must be non-empty and include a minimum of two field sources. The underlying field sources must be actual projected fields that represent actual schema fields and that must not be transformed and aggregated in any way, except for casting. The type of all the underlying field sources must be equivalent so that picking one of them would result in the same value type. + # Object with schema name: FieldSource + ], + "virtualFieldType": "A String", # Required. The type of the virtual field. + }, }, }, "fieldSourceValue": { # A source that can be used to represent a "field of data" within various parts of a structured query, such as in SELECT, WHERE, or ORDER BY clauses. The term "field of data" is used here because it is not limited to literal fields in the underlying data schema. # The field. This will be the field that is set as the Right Hand Side of the filter. @@ -812,6 +920,12 @@

Method Details

"type": "A String", # Required. Specifies the aggregation function. Use one of the following string identifiers: "average": Computes the average (AVG). Applies only to numeric values. "count": Counts the number of values (COUNT). "count-distinct": Counts the number of distinct values (COUNT DISTINCT). "count-distinct-approx": Approximates the count of distinct values (APPROX_COUNT_DISTINCT). "max": Finds the maximum value (MAX). Applies only to numeric values. "min": Finds the minimum value (MIN). Applies only to numeric values. "sum": Computes the sum (SUM). Applies only to numeric values. }, "truncationGranularity": "A String", # The truncation granularity when grouping by a time/date field. This will be used to truncate the field to the granularity specified. This can be either a date or a time granularity found at https://cloud.google.com/bigquery/docs/reference/standard-sql/timestamp_functions#timestamp_trunc_granularity_date and https://cloud.google.com/bigquery/docs/reference/standard-sql/timestamp_functions#timestamp_trunc_granularity_time respectively. + "virtualField": { # A virtual field is a field that is not physically present in the underlying data schema, but is created through specific operations within the query builder model based on other fields in the schema. # Optional. A virtual field definition, used in place of field to define a field that is computed from other fields rather than being directly present in the data schema.For example, a virtual field can be defined using COALESCE to select the first non-null value from a list of fields.If virtual_field is set, field must not be set. + "underlyingFieldSources": [ # The field sources that will be used to create the virtual field, based on the semantics of the virtual field type.The field sources must follow these rules, based on the virtual field type: - For VIRTUAL_FIELD_TYPE_UNSPECIFIED, this field must be empty. - For COALESCE, this field must be non-empty and include a minimum of two field sources. The underlying field sources must be actual projected fields that represent actual schema fields and that must not be transformed and aggregated in any way, except for casting. The type of all the underlying field sources must be equivalent so that picking one of them would result in the same value type. + # Object with schema name: FieldSource + ], + "virtualFieldType": "A String", # Required. The type of the virtual field. + }, }, }, "isNegation": True or False, # Determines if the NOT flag should be added to the comparator. @@ -841,6 +955,12 @@

Method Details

"type": "A String", # Required. Specifies the aggregation function. Use one of the following string identifiers: "average": Computes the average (AVG). Applies only to numeric values. "count": Counts the number of values (COUNT). "count-distinct": Counts the number of distinct values (COUNT DISTINCT). "count-distinct-approx": Approximates the count of distinct values (APPROX_COUNT_DISTINCT). "max": Finds the maximum value (MAX). Applies only to numeric values. "min": Finds the minimum value (MIN). Applies only to numeric values. "sum": Computes the sum (SUM). Applies only to numeric values. }, "truncationGranularity": "A String", # The truncation granularity when grouping by a time/date field. This will be used to truncate the field to the granularity specified. This can be either a date or a time granularity found at https://cloud.google.com/bigquery/docs/reference/standard-sql/timestamp_functions#timestamp_trunc_granularity_date and https://cloud.google.com/bigquery/docs/reference/standard-sql/timestamp_functions#timestamp_trunc_granularity_time respectively. + "virtualField": { # A virtual field is a field that is not physically present in the underlying data schema, but is created through specific operations within the query builder model based on other fields in the schema. # Optional. A virtual field definition, used in place of field to define a field that is computed from other fields rather than being directly present in the data schema.For example, a virtual field can be defined using COALESCE to select the first non-null value from a list of fields.If virtual_field is set, field must not be set. + "underlyingFieldSources": [ # The field sources that will be used to create the virtual field, based on the semantics of the virtual field type.The field sources must follow these rules, based on the virtual field type: - For VIRTUAL_FIELD_TYPE_UNSPECIFIED, this field must be empty. - For COALESCE, this field must be non-empty and include a minimum of two field sources. The underlying field sources must be actual projected fields that represent actual schema fields and that must not be transformed and aggregated in any way, except for casting. The type of all the underlying field sources must be equivalent so that picking one of them would result in the same value type. + # Object with schema name: FieldSource + ], + "virtualFieldType": "A String", # Required. The type of the virtual field. + }, }, }, "sortOrderDirection": "A String", # The sort order to use for the query. @@ -903,6 +1023,12 @@

Method Details

"type": "A String", # Required. Specifies the aggregation function. Use one of the following string identifiers: "average": Computes the average (AVG). Applies only to numeric values. "count": Counts the number of values (COUNT). "count-distinct": Counts the number of distinct values (COUNT DISTINCT). "count-distinct-approx": Approximates the count of distinct values (APPROX_COUNT_DISTINCT). "max": Finds the maximum value (MAX). Applies only to numeric values. "min": Finds the minimum value (MIN). Applies only to numeric values. "sum": Computes the sum (SUM). Applies only to numeric values. }, "truncationGranularity": "A String", # The truncation granularity when grouping by a time/date field. This will be used to truncate the field to the granularity specified. This can be either a date or a time granularity found at https://cloud.google.com/bigquery/docs/reference/standard-sql/timestamp_functions#timestamp_trunc_granularity_date and https://cloud.google.com/bigquery/docs/reference/standard-sql/timestamp_functions#timestamp_trunc_granularity_time respectively. + "virtualField": { # A virtual field is a field that is not physically present in the underlying data schema, but is created through specific operations within the query builder model based on other fields in the schema. # Optional. A virtual field definition, used in place of field to define a field that is computed from other fields rather than being directly present in the data schema.For example, a virtual field can be defined using COALESCE to select the first non-null value from a list of fields.If virtual_field is set, field must not be set. + "underlyingFieldSources": [ # The field sources that will be used to create the virtual field, based on the semantics of the virtual field type.The field sources must follow these rules, based on the virtual field type: - For VIRTUAL_FIELD_TYPE_UNSPECIFIED, this field must be empty. - For COALESCE, this field must be non-empty and include a minimum of two field sources. The underlying field sources must be actual projected fields that represent actual schema fields and that must not be transformed and aggregated in any way, except for casting. The type of all the underlying field sources must be equivalent so that picking one of them would result in the same value type. + # Object with schema name: FieldSource + ], + "virtualFieldType": "A String", # Required. The type of the virtual field. + }, }, }, ], @@ -931,6 +1057,12 @@

Method Details

"type": "A String", # Required. Specifies the aggregation function. Use one of the following string identifiers: "average": Computes the average (AVG). Applies only to numeric values. "count": Counts the number of values (COUNT). "count-distinct": Counts the number of distinct values (COUNT DISTINCT). "count-distinct-approx": Approximates the count of distinct values (APPROX_COUNT_DISTINCT). "max": Finds the maximum value (MAX). Applies only to numeric values. "min": Finds the minimum value (MIN). Applies only to numeric values. "sum": Computes the sum (SUM). Applies only to numeric values. }, "truncationGranularity": "A String", # The truncation granularity when grouping by a time/date field. This will be used to truncate the field to the granularity specified. This can be either a date or a time granularity found at https://cloud.google.com/bigquery/docs/reference/standard-sql/timestamp_functions#timestamp_trunc_granularity_date and https://cloud.google.com/bigquery/docs/reference/standard-sql/timestamp_functions#timestamp_trunc_granularity_time respectively. + "virtualField": { # A virtual field is a field that is not physically present in the underlying data schema, but is created through specific operations within the query builder model based on other fields in the schema. # Optional. A virtual field definition, used in place of field to define a field that is computed from other fields rather than being directly present in the data schema.For example, a virtual field can be defined using COALESCE to select the first non-null value from a list of fields.If virtual_field is set, field must not be set. + "underlyingFieldSources": [ # The field sources that will be used to create the virtual field, based on the semantics of the virtual field type.The field sources must follow these rules, based on the virtual field type: - For VIRTUAL_FIELD_TYPE_UNSPECIFIED, this field must be empty. - For COALESCE, this field must be non-empty and include a minimum of two field sources. The underlying field sources must be actual projected fields that represent actual schema fields and that must not be transformed and aggregated in any way, except for casting. The type of all the underlying field sources must be equivalent so that picking one of them would result in the same value type. + # Object with schema name: FieldSource + ], + "virtualFieldType": "A String", # Required. The type of the virtual field. + }, }, }, "fieldSourceValue": { # A source that can be used to represent a "field of data" within various parts of a structured query, such as in SELECT, WHERE, or ORDER BY clauses. The term "field of data" is used here because it is not limited to literal fields in the underlying data schema. # The field. This will be the field that is set as the Right Hand Side of the filter. @@ -952,6 +1084,12 @@

Method Details

"type": "A String", # Required. Specifies the aggregation function. Use one of the following string identifiers: "average": Computes the average (AVG). Applies only to numeric values. "count": Counts the number of values (COUNT). "count-distinct": Counts the number of distinct values (COUNT DISTINCT). "count-distinct-approx": Approximates the count of distinct values (APPROX_COUNT_DISTINCT). "max": Finds the maximum value (MAX). Applies only to numeric values. "min": Finds the minimum value (MIN). Applies only to numeric values. "sum": Computes the sum (SUM). Applies only to numeric values. }, "truncationGranularity": "A String", # The truncation granularity when grouping by a time/date field. This will be used to truncate the field to the granularity specified. This can be either a date or a time granularity found at https://cloud.google.com/bigquery/docs/reference/standard-sql/timestamp_functions#timestamp_trunc_granularity_date and https://cloud.google.com/bigquery/docs/reference/standard-sql/timestamp_functions#timestamp_trunc_granularity_time respectively. + "virtualField": { # A virtual field is a field that is not physically present in the underlying data schema, but is created through specific operations within the query builder model based on other fields in the schema. # Optional. A virtual field definition, used in place of field to define a field that is computed from other fields rather than being directly present in the data schema.For example, a virtual field can be defined using COALESCE to select the first non-null value from a list of fields.If virtual_field is set, field must not be set. + "underlyingFieldSources": [ # The field sources that will be used to create the virtual field, based on the semantics of the virtual field type.The field sources must follow these rules, based on the virtual field type: - For VIRTUAL_FIELD_TYPE_UNSPECIFIED, this field must be empty. - For COALESCE, this field must be non-empty and include a minimum of two field sources. The underlying field sources must be actual projected fields that represent actual schema fields and that must not be transformed and aggregated in any way, except for casting. The type of all the underlying field sources must be equivalent so that picking one of them would result in the same value type. + # Object with schema name: FieldSource + ], + "virtualFieldType": "A String", # Required. The type of the virtual field. + }, }, }, "isNegation": True or False, # Determines if the NOT flag should be added to the comparator. @@ -981,6 +1119,12 @@

Method Details

"type": "A String", # Required. Specifies the aggregation function. Use one of the following string identifiers: "average": Computes the average (AVG). Applies only to numeric values. "count": Counts the number of values (COUNT). "count-distinct": Counts the number of distinct values (COUNT DISTINCT). "count-distinct-approx": Approximates the count of distinct values (APPROX_COUNT_DISTINCT). "max": Finds the maximum value (MAX). Applies only to numeric values. "min": Finds the minimum value (MIN). Applies only to numeric values. "sum": Computes the sum (SUM). Applies only to numeric values. }, "truncationGranularity": "A String", # The truncation granularity when grouping by a time/date field. This will be used to truncate the field to the granularity specified. This can be either a date or a time granularity found at https://cloud.google.com/bigquery/docs/reference/standard-sql/timestamp_functions#timestamp_trunc_granularity_date and https://cloud.google.com/bigquery/docs/reference/standard-sql/timestamp_functions#timestamp_trunc_granularity_time respectively. + "virtualField": { # A virtual field is a field that is not physically present in the underlying data schema, but is created through specific operations within the query builder model based on other fields in the schema. # Optional. A virtual field definition, used in place of field to define a field that is computed from other fields rather than being directly present in the data schema.For example, a virtual field can be defined using COALESCE to select the first non-null value from a list of fields.If virtual_field is set, field must not be set. + "underlyingFieldSources": [ # The field sources that will be used to create the virtual field, based on the semantics of the virtual field type.The field sources must follow these rules, based on the virtual field type: - For VIRTUAL_FIELD_TYPE_UNSPECIFIED, this field must be empty. - For COALESCE, this field must be non-empty and include a minimum of two field sources. The underlying field sources must be actual projected fields that represent actual schema fields and that must not be transformed and aggregated in any way, except for casting. The type of all the underlying field sources must be equivalent so that picking one of them would result in the same value type. + # Object with schema name: FieldSource + ], + "virtualFieldType": "A String", # Required. The type of the virtual field. + }, }, }, "sortOrderDirection": "A String", # The sort order to use for the query. diff --git a/docs/dyn/logging_v2.projects.locations.recentQueries.html b/docs/dyn/logging_v2.projects.locations.recentQueries.html index e1ff2394f9..06116fa47c 100644 --- a/docs/dyn/logging_v2.projects.locations.recentQueries.html +++ b/docs/dyn/logging_v2.projects.locations.recentQueries.html @@ -144,6 +144,12 @@

Method Details

"type": "A String", # Required. Specifies the aggregation function. Use one of the following string identifiers: "average": Computes the average (AVG). Applies only to numeric values. "count": Counts the number of values (COUNT). "count-distinct": Counts the number of distinct values (COUNT DISTINCT). "count-distinct-approx": Approximates the count of distinct values (APPROX_COUNT_DISTINCT). "max": Finds the maximum value (MAX). Applies only to numeric values. "min": Finds the minimum value (MIN). Applies only to numeric values. "sum": Computes the sum (SUM). Applies only to numeric values. }, "truncationGranularity": "A String", # The truncation granularity when grouping by a time/date field. This will be used to truncate the field to the granularity specified. This can be either a date or a time granularity found at https://cloud.google.com/bigquery/docs/reference/standard-sql/timestamp_functions#timestamp_trunc_granularity_date and https://cloud.google.com/bigquery/docs/reference/standard-sql/timestamp_functions#timestamp_trunc_granularity_time respectively. + "virtualField": { # A virtual field is a field that is not physically present in the underlying data schema, but is created through specific operations within the query builder model based on other fields in the schema. # Optional. A virtual field definition, used in place of field to define a field that is computed from other fields rather than being directly present in the data schema.For example, a virtual field can be defined using COALESCE to select the first non-null value from a list of fields.If virtual_field is set, field must not be set. + "underlyingFieldSources": [ # The field sources that will be used to create the virtual field, based on the semantics of the virtual field type.The field sources must follow these rules, based on the virtual field type: - For VIRTUAL_FIELD_TYPE_UNSPECIFIED, this field must be empty. - For COALESCE, this field must be non-empty and include a minimum of two field sources. The underlying field sources must be actual projected fields that represent actual schema fields and that must not be transformed and aggregated in any way, except for casting. The type of all the underlying field sources must be equivalent so that picking one of them would result in the same value type. + # Object with schema name: FieldSource + ], + "virtualFieldType": "A String", # Required. The type of the virtual field. + }, }, }, ], @@ -172,6 +178,12 @@

Method Details

"type": "A String", # Required. Specifies the aggregation function. Use one of the following string identifiers: "average": Computes the average (AVG). Applies only to numeric values. "count": Counts the number of values (COUNT). "count-distinct": Counts the number of distinct values (COUNT DISTINCT). "count-distinct-approx": Approximates the count of distinct values (APPROX_COUNT_DISTINCT). "max": Finds the maximum value (MAX). Applies only to numeric values. "min": Finds the minimum value (MIN). Applies only to numeric values. "sum": Computes the sum (SUM). Applies only to numeric values. }, "truncationGranularity": "A String", # The truncation granularity when grouping by a time/date field. This will be used to truncate the field to the granularity specified. This can be either a date or a time granularity found at https://cloud.google.com/bigquery/docs/reference/standard-sql/timestamp_functions#timestamp_trunc_granularity_date and https://cloud.google.com/bigquery/docs/reference/standard-sql/timestamp_functions#timestamp_trunc_granularity_time respectively. + "virtualField": { # A virtual field is a field that is not physically present in the underlying data schema, but is created through specific operations within the query builder model based on other fields in the schema. # Optional. A virtual field definition, used in place of field to define a field that is computed from other fields rather than being directly present in the data schema.For example, a virtual field can be defined using COALESCE to select the first non-null value from a list of fields.If virtual_field is set, field must not be set. + "underlyingFieldSources": [ # The field sources that will be used to create the virtual field, based on the semantics of the virtual field type.The field sources must follow these rules, based on the virtual field type: - For VIRTUAL_FIELD_TYPE_UNSPECIFIED, this field must be empty. - For COALESCE, this field must be non-empty and include a minimum of two field sources. The underlying field sources must be actual projected fields that represent actual schema fields and that must not be transformed and aggregated in any way, except for casting. The type of all the underlying field sources must be equivalent so that picking one of them would result in the same value type. + # Object with schema name: FieldSource + ], + "virtualFieldType": "A String", # Required. The type of the virtual field. + }, }, }, "fieldSourceValue": { # A source that can be used to represent a "field of data" within various parts of a structured query, such as in SELECT, WHERE, or ORDER BY clauses. The term "field of data" is used here because it is not limited to literal fields in the underlying data schema. # The field. This will be the field that is set as the Right Hand Side of the filter. @@ -193,6 +205,12 @@

Method Details

"type": "A String", # Required. Specifies the aggregation function. Use one of the following string identifiers: "average": Computes the average (AVG). Applies only to numeric values. "count": Counts the number of values (COUNT). "count-distinct": Counts the number of distinct values (COUNT DISTINCT). "count-distinct-approx": Approximates the count of distinct values (APPROX_COUNT_DISTINCT). "max": Finds the maximum value (MAX). Applies only to numeric values. "min": Finds the minimum value (MIN). Applies only to numeric values. "sum": Computes the sum (SUM). Applies only to numeric values. }, "truncationGranularity": "A String", # The truncation granularity when grouping by a time/date field. This will be used to truncate the field to the granularity specified. This can be either a date or a time granularity found at https://cloud.google.com/bigquery/docs/reference/standard-sql/timestamp_functions#timestamp_trunc_granularity_date and https://cloud.google.com/bigquery/docs/reference/standard-sql/timestamp_functions#timestamp_trunc_granularity_time respectively. + "virtualField": { # A virtual field is a field that is not physically present in the underlying data schema, but is created through specific operations within the query builder model based on other fields in the schema. # Optional. A virtual field definition, used in place of field to define a field that is computed from other fields rather than being directly present in the data schema.For example, a virtual field can be defined using COALESCE to select the first non-null value from a list of fields.If virtual_field is set, field must not be set. + "underlyingFieldSources": [ # The field sources that will be used to create the virtual field, based on the semantics of the virtual field type.The field sources must follow these rules, based on the virtual field type: - For VIRTUAL_FIELD_TYPE_UNSPECIFIED, this field must be empty. - For COALESCE, this field must be non-empty and include a minimum of two field sources. The underlying field sources must be actual projected fields that represent actual schema fields and that must not be transformed and aggregated in any way, except for casting. The type of all the underlying field sources must be equivalent so that picking one of them would result in the same value type. + # Object with schema name: FieldSource + ], + "virtualFieldType": "A String", # Required. The type of the virtual field. + }, }, }, "isNegation": True or False, # Determines if the NOT flag should be added to the comparator. @@ -222,6 +240,12 @@

Method Details

"type": "A String", # Required. Specifies the aggregation function. Use one of the following string identifiers: "average": Computes the average (AVG). Applies only to numeric values. "count": Counts the number of values (COUNT). "count-distinct": Counts the number of distinct values (COUNT DISTINCT). "count-distinct-approx": Approximates the count of distinct values (APPROX_COUNT_DISTINCT). "max": Finds the maximum value (MAX). Applies only to numeric values. "min": Finds the minimum value (MIN). Applies only to numeric values. "sum": Computes the sum (SUM). Applies only to numeric values. }, "truncationGranularity": "A String", # The truncation granularity when grouping by a time/date field. This will be used to truncate the field to the granularity specified. This can be either a date or a time granularity found at https://cloud.google.com/bigquery/docs/reference/standard-sql/timestamp_functions#timestamp_trunc_granularity_date and https://cloud.google.com/bigquery/docs/reference/standard-sql/timestamp_functions#timestamp_trunc_granularity_time respectively. + "virtualField": { # A virtual field is a field that is not physically present in the underlying data schema, but is created through specific operations within the query builder model based on other fields in the schema. # Optional. A virtual field definition, used in place of field to define a field that is computed from other fields rather than being directly present in the data schema.For example, a virtual field can be defined using COALESCE to select the first non-null value from a list of fields.If virtual_field is set, field must not be set. + "underlyingFieldSources": [ # The field sources that will be used to create the virtual field, based on the semantics of the virtual field type.The field sources must follow these rules, based on the virtual field type: - For VIRTUAL_FIELD_TYPE_UNSPECIFIED, this field must be empty. - For COALESCE, this field must be non-empty and include a minimum of two field sources. The underlying field sources must be actual projected fields that represent actual schema fields and that must not be transformed and aggregated in any way, except for casting. The type of all the underlying field sources must be equivalent so that picking one of them would result in the same value type. + # Object with schema name: FieldSource + ], + "virtualFieldType": "A String", # Required. The type of the virtual field. + }, }, }, "sortOrderDirection": "A String", # The sort order to use for the query. diff --git a/docs/dyn/logging_v2.projects.locations.savedQueries.html b/docs/dyn/logging_v2.projects.locations.savedQueries.html index 55af6a88ab..3ee71b95c1 100644 --- a/docs/dyn/logging_v2.projects.locations.savedQueries.html +++ b/docs/dyn/logging_v2.projects.locations.savedQueries.html @@ -147,6 +147,12 @@

Method Details

"type": "A String", # Required. Specifies the aggregation function. Use one of the following string identifiers: "average": Computes the average (AVG). Applies only to numeric values. "count": Counts the number of values (COUNT). "count-distinct": Counts the number of distinct values (COUNT DISTINCT). "count-distinct-approx": Approximates the count of distinct values (APPROX_COUNT_DISTINCT). "max": Finds the maximum value (MAX). Applies only to numeric values. "min": Finds the minimum value (MIN). Applies only to numeric values. "sum": Computes the sum (SUM). Applies only to numeric values. }, "truncationGranularity": "A String", # The truncation granularity when grouping by a time/date field. This will be used to truncate the field to the granularity specified. This can be either a date or a time granularity found at https://cloud.google.com/bigquery/docs/reference/standard-sql/timestamp_functions#timestamp_trunc_granularity_date and https://cloud.google.com/bigquery/docs/reference/standard-sql/timestamp_functions#timestamp_trunc_granularity_time respectively. + "virtualField": { # A virtual field is a field that is not physically present in the underlying data schema, but is created through specific operations within the query builder model based on other fields in the schema. # Optional. A virtual field definition, used in place of field to define a field that is computed from other fields rather than being directly present in the data schema.For example, a virtual field can be defined using COALESCE to select the first non-null value from a list of fields.If virtual_field is set, field must not be set. + "underlyingFieldSources": [ # The field sources that will be used to create the virtual field, based on the semantics of the virtual field type.The field sources must follow these rules, based on the virtual field type: - For VIRTUAL_FIELD_TYPE_UNSPECIFIED, this field must be empty. - For COALESCE, this field must be non-empty and include a minimum of two field sources. The underlying field sources must be actual projected fields that represent actual schema fields and that must not be transformed and aggregated in any way, except for casting. The type of all the underlying field sources must be equivalent so that picking one of them would result in the same value type. + # Object with schema name: FieldSource + ], + "virtualFieldType": "A String", # Required. The type of the virtual field. + }, }, }, ], @@ -175,6 +181,12 @@

Method Details

"type": "A String", # Required. Specifies the aggregation function. Use one of the following string identifiers: "average": Computes the average (AVG). Applies only to numeric values. "count": Counts the number of values (COUNT). "count-distinct": Counts the number of distinct values (COUNT DISTINCT). "count-distinct-approx": Approximates the count of distinct values (APPROX_COUNT_DISTINCT). "max": Finds the maximum value (MAX). Applies only to numeric values. "min": Finds the minimum value (MIN). Applies only to numeric values. "sum": Computes the sum (SUM). Applies only to numeric values. }, "truncationGranularity": "A String", # The truncation granularity when grouping by a time/date field. This will be used to truncate the field to the granularity specified. This can be either a date or a time granularity found at https://cloud.google.com/bigquery/docs/reference/standard-sql/timestamp_functions#timestamp_trunc_granularity_date and https://cloud.google.com/bigquery/docs/reference/standard-sql/timestamp_functions#timestamp_trunc_granularity_time respectively. + "virtualField": { # A virtual field is a field that is not physically present in the underlying data schema, but is created through specific operations within the query builder model based on other fields in the schema. # Optional. A virtual field definition, used in place of field to define a field that is computed from other fields rather than being directly present in the data schema.For example, a virtual field can be defined using COALESCE to select the first non-null value from a list of fields.If virtual_field is set, field must not be set. + "underlyingFieldSources": [ # The field sources that will be used to create the virtual field, based on the semantics of the virtual field type.The field sources must follow these rules, based on the virtual field type: - For VIRTUAL_FIELD_TYPE_UNSPECIFIED, this field must be empty. - For COALESCE, this field must be non-empty and include a minimum of two field sources. The underlying field sources must be actual projected fields that represent actual schema fields and that must not be transformed and aggregated in any way, except for casting. The type of all the underlying field sources must be equivalent so that picking one of them would result in the same value type. + # Object with schema name: FieldSource + ], + "virtualFieldType": "A String", # Required. The type of the virtual field. + }, }, }, "fieldSourceValue": { # A source that can be used to represent a "field of data" within various parts of a structured query, such as in SELECT, WHERE, or ORDER BY clauses. The term "field of data" is used here because it is not limited to literal fields in the underlying data schema. # The field. This will be the field that is set as the Right Hand Side of the filter. @@ -196,6 +208,12 @@

Method Details

"type": "A String", # Required. Specifies the aggregation function. Use one of the following string identifiers: "average": Computes the average (AVG). Applies only to numeric values. "count": Counts the number of values (COUNT). "count-distinct": Counts the number of distinct values (COUNT DISTINCT). "count-distinct-approx": Approximates the count of distinct values (APPROX_COUNT_DISTINCT). "max": Finds the maximum value (MAX). Applies only to numeric values. "min": Finds the minimum value (MIN). Applies only to numeric values. "sum": Computes the sum (SUM). Applies only to numeric values. }, "truncationGranularity": "A String", # The truncation granularity when grouping by a time/date field. This will be used to truncate the field to the granularity specified. This can be either a date or a time granularity found at https://cloud.google.com/bigquery/docs/reference/standard-sql/timestamp_functions#timestamp_trunc_granularity_date and https://cloud.google.com/bigquery/docs/reference/standard-sql/timestamp_functions#timestamp_trunc_granularity_time respectively. + "virtualField": { # A virtual field is a field that is not physically present in the underlying data schema, but is created through specific operations within the query builder model based on other fields in the schema. # Optional. A virtual field definition, used in place of field to define a field that is computed from other fields rather than being directly present in the data schema.For example, a virtual field can be defined using COALESCE to select the first non-null value from a list of fields.If virtual_field is set, field must not be set. + "underlyingFieldSources": [ # The field sources that will be used to create the virtual field, based on the semantics of the virtual field type.The field sources must follow these rules, based on the virtual field type: - For VIRTUAL_FIELD_TYPE_UNSPECIFIED, this field must be empty. - For COALESCE, this field must be non-empty and include a minimum of two field sources. The underlying field sources must be actual projected fields that represent actual schema fields and that must not be transformed and aggregated in any way, except for casting. The type of all the underlying field sources must be equivalent so that picking one of them would result in the same value type. + # Object with schema name: FieldSource + ], + "virtualFieldType": "A String", # Required. The type of the virtual field. + }, }, }, "isNegation": True or False, # Determines if the NOT flag should be added to the comparator. @@ -225,6 +243,12 @@

Method Details

"type": "A String", # Required. Specifies the aggregation function. Use one of the following string identifiers: "average": Computes the average (AVG). Applies only to numeric values. "count": Counts the number of values (COUNT). "count-distinct": Counts the number of distinct values (COUNT DISTINCT). "count-distinct-approx": Approximates the count of distinct values (APPROX_COUNT_DISTINCT). "max": Finds the maximum value (MAX). Applies only to numeric values. "min": Finds the minimum value (MIN). Applies only to numeric values. "sum": Computes the sum (SUM). Applies only to numeric values. }, "truncationGranularity": "A String", # The truncation granularity when grouping by a time/date field. This will be used to truncate the field to the granularity specified. This can be either a date or a time granularity found at https://cloud.google.com/bigquery/docs/reference/standard-sql/timestamp_functions#timestamp_trunc_granularity_date and https://cloud.google.com/bigquery/docs/reference/standard-sql/timestamp_functions#timestamp_trunc_granularity_time respectively. + "virtualField": { # A virtual field is a field that is not physically present in the underlying data schema, but is created through specific operations within the query builder model based on other fields in the schema. # Optional. A virtual field definition, used in place of field to define a field that is computed from other fields rather than being directly present in the data schema.For example, a virtual field can be defined using COALESCE to select the first non-null value from a list of fields.If virtual_field is set, field must not be set. + "underlyingFieldSources": [ # The field sources that will be used to create the virtual field, based on the semantics of the virtual field type.The field sources must follow these rules, based on the virtual field type: - For VIRTUAL_FIELD_TYPE_UNSPECIFIED, this field must be empty. - For COALESCE, this field must be non-empty and include a minimum of two field sources. The underlying field sources must be actual projected fields that represent actual schema fields and that must not be transformed and aggregated in any way, except for casting. The type of all the underlying field sources must be equivalent so that picking one of them would result in the same value type. + # Object with schema name: FieldSource + ], + "virtualFieldType": "A String", # Required. The type of the virtual field. + }, }, }, "sortOrderDirection": "A String", # The sort order to use for the query. @@ -287,6 +311,12 @@

Method Details

"type": "A String", # Required. Specifies the aggregation function. Use one of the following string identifiers: "average": Computes the average (AVG). Applies only to numeric values. "count": Counts the number of values (COUNT). "count-distinct": Counts the number of distinct values (COUNT DISTINCT). "count-distinct-approx": Approximates the count of distinct values (APPROX_COUNT_DISTINCT). "max": Finds the maximum value (MAX). Applies only to numeric values. "min": Finds the minimum value (MIN). Applies only to numeric values. "sum": Computes the sum (SUM). Applies only to numeric values. }, "truncationGranularity": "A String", # The truncation granularity when grouping by a time/date field. This will be used to truncate the field to the granularity specified. This can be either a date or a time granularity found at https://cloud.google.com/bigquery/docs/reference/standard-sql/timestamp_functions#timestamp_trunc_granularity_date and https://cloud.google.com/bigquery/docs/reference/standard-sql/timestamp_functions#timestamp_trunc_granularity_time respectively. + "virtualField": { # A virtual field is a field that is not physically present in the underlying data schema, but is created through specific operations within the query builder model based on other fields in the schema. # Optional. A virtual field definition, used in place of field to define a field that is computed from other fields rather than being directly present in the data schema.For example, a virtual field can be defined using COALESCE to select the first non-null value from a list of fields.If virtual_field is set, field must not be set. + "underlyingFieldSources": [ # The field sources that will be used to create the virtual field, based on the semantics of the virtual field type.The field sources must follow these rules, based on the virtual field type: - For VIRTUAL_FIELD_TYPE_UNSPECIFIED, this field must be empty. - For COALESCE, this field must be non-empty and include a minimum of two field sources. The underlying field sources must be actual projected fields that represent actual schema fields and that must not be transformed and aggregated in any way, except for casting. The type of all the underlying field sources must be equivalent so that picking one of them would result in the same value type. + # Object with schema name: FieldSource + ], + "virtualFieldType": "A String", # Required. The type of the virtual field. + }, }, }, ], @@ -315,6 +345,12 @@

Method Details

"type": "A String", # Required. Specifies the aggregation function. Use one of the following string identifiers: "average": Computes the average (AVG). Applies only to numeric values. "count": Counts the number of values (COUNT). "count-distinct": Counts the number of distinct values (COUNT DISTINCT). "count-distinct-approx": Approximates the count of distinct values (APPROX_COUNT_DISTINCT). "max": Finds the maximum value (MAX). Applies only to numeric values. "min": Finds the minimum value (MIN). Applies only to numeric values. "sum": Computes the sum (SUM). Applies only to numeric values. }, "truncationGranularity": "A String", # The truncation granularity when grouping by a time/date field. This will be used to truncate the field to the granularity specified. This can be either a date or a time granularity found at https://cloud.google.com/bigquery/docs/reference/standard-sql/timestamp_functions#timestamp_trunc_granularity_date and https://cloud.google.com/bigquery/docs/reference/standard-sql/timestamp_functions#timestamp_trunc_granularity_time respectively. + "virtualField": { # A virtual field is a field that is not physically present in the underlying data schema, but is created through specific operations within the query builder model based on other fields in the schema. # Optional. A virtual field definition, used in place of field to define a field that is computed from other fields rather than being directly present in the data schema.For example, a virtual field can be defined using COALESCE to select the first non-null value from a list of fields.If virtual_field is set, field must not be set. + "underlyingFieldSources": [ # The field sources that will be used to create the virtual field, based on the semantics of the virtual field type.The field sources must follow these rules, based on the virtual field type: - For VIRTUAL_FIELD_TYPE_UNSPECIFIED, this field must be empty. - For COALESCE, this field must be non-empty and include a minimum of two field sources. The underlying field sources must be actual projected fields that represent actual schema fields and that must not be transformed and aggregated in any way, except for casting. The type of all the underlying field sources must be equivalent so that picking one of them would result in the same value type. + # Object with schema name: FieldSource + ], + "virtualFieldType": "A String", # Required. The type of the virtual field. + }, }, }, "fieldSourceValue": { # A source that can be used to represent a "field of data" within various parts of a structured query, such as in SELECT, WHERE, or ORDER BY clauses. The term "field of data" is used here because it is not limited to literal fields in the underlying data schema. # The field. This will be the field that is set as the Right Hand Side of the filter. @@ -336,6 +372,12 @@

Method Details

"type": "A String", # Required. Specifies the aggregation function. Use one of the following string identifiers: "average": Computes the average (AVG). Applies only to numeric values. "count": Counts the number of values (COUNT). "count-distinct": Counts the number of distinct values (COUNT DISTINCT). "count-distinct-approx": Approximates the count of distinct values (APPROX_COUNT_DISTINCT). "max": Finds the maximum value (MAX). Applies only to numeric values. "min": Finds the minimum value (MIN). Applies only to numeric values. "sum": Computes the sum (SUM). Applies only to numeric values. }, "truncationGranularity": "A String", # The truncation granularity when grouping by a time/date field. This will be used to truncate the field to the granularity specified. This can be either a date or a time granularity found at https://cloud.google.com/bigquery/docs/reference/standard-sql/timestamp_functions#timestamp_trunc_granularity_date and https://cloud.google.com/bigquery/docs/reference/standard-sql/timestamp_functions#timestamp_trunc_granularity_time respectively. + "virtualField": { # A virtual field is a field that is not physically present in the underlying data schema, but is created through specific operations within the query builder model based on other fields in the schema. # Optional. A virtual field definition, used in place of field to define a field that is computed from other fields rather than being directly present in the data schema.For example, a virtual field can be defined using COALESCE to select the first non-null value from a list of fields.If virtual_field is set, field must not be set. + "underlyingFieldSources": [ # The field sources that will be used to create the virtual field, based on the semantics of the virtual field type.The field sources must follow these rules, based on the virtual field type: - For VIRTUAL_FIELD_TYPE_UNSPECIFIED, this field must be empty. - For COALESCE, this field must be non-empty and include a minimum of two field sources. The underlying field sources must be actual projected fields that represent actual schema fields and that must not be transformed and aggregated in any way, except for casting. The type of all the underlying field sources must be equivalent so that picking one of them would result in the same value type. + # Object with schema name: FieldSource + ], + "virtualFieldType": "A String", # Required. The type of the virtual field. + }, }, }, "isNegation": True or False, # Determines if the NOT flag should be added to the comparator. @@ -365,6 +407,12 @@

Method Details

"type": "A String", # Required. Specifies the aggregation function. Use one of the following string identifiers: "average": Computes the average (AVG). Applies only to numeric values. "count": Counts the number of values (COUNT). "count-distinct": Counts the number of distinct values (COUNT DISTINCT). "count-distinct-approx": Approximates the count of distinct values (APPROX_COUNT_DISTINCT). "max": Finds the maximum value (MAX). Applies only to numeric values. "min": Finds the minimum value (MIN). Applies only to numeric values. "sum": Computes the sum (SUM). Applies only to numeric values. }, "truncationGranularity": "A String", # The truncation granularity when grouping by a time/date field. This will be used to truncate the field to the granularity specified. This can be either a date or a time granularity found at https://cloud.google.com/bigquery/docs/reference/standard-sql/timestamp_functions#timestamp_trunc_granularity_date and https://cloud.google.com/bigquery/docs/reference/standard-sql/timestamp_functions#timestamp_trunc_granularity_time respectively. + "virtualField": { # A virtual field is a field that is not physically present in the underlying data schema, but is created through specific operations within the query builder model based on other fields in the schema. # Optional. A virtual field definition, used in place of field to define a field that is computed from other fields rather than being directly present in the data schema.For example, a virtual field can be defined using COALESCE to select the first non-null value from a list of fields.If virtual_field is set, field must not be set. + "underlyingFieldSources": [ # The field sources that will be used to create the virtual field, based on the semantics of the virtual field type.The field sources must follow these rules, based on the virtual field type: - For VIRTUAL_FIELD_TYPE_UNSPECIFIED, this field must be empty. - For COALESCE, this field must be non-empty and include a minimum of two field sources. The underlying field sources must be actual projected fields that represent actual schema fields and that must not be transformed and aggregated in any way, except for casting. The type of all the underlying field sources must be equivalent so that picking one of them would result in the same value type. + # Object with schema name: FieldSource + ], + "virtualFieldType": "A String", # Required. The type of the virtual field. + }, }, }, "sortOrderDirection": "A String", # The sort order to use for the query. @@ -451,6 +499,12 @@

Method Details

"type": "A String", # Required. Specifies the aggregation function. Use one of the following string identifiers: "average": Computes the average (AVG). Applies only to numeric values. "count": Counts the number of values (COUNT). "count-distinct": Counts the number of distinct values (COUNT DISTINCT). "count-distinct-approx": Approximates the count of distinct values (APPROX_COUNT_DISTINCT). "max": Finds the maximum value (MAX). Applies only to numeric values. "min": Finds the minimum value (MIN). Applies only to numeric values. "sum": Computes the sum (SUM). Applies only to numeric values. }, "truncationGranularity": "A String", # The truncation granularity when grouping by a time/date field. This will be used to truncate the field to the granularity specified. This can be either a date or a time granularity found at https://cloud.google.com/bigquery/docs/reference/standard-sql/timestamp_functions#timestamp_trunc_granularity_date and https://cloud.google.com/bigquery/docs/reference/standard-sql/timestamp_functions#timestamp_trunc_granularity_time respectively. + "virtualField": { # A virtual field is a field that is not physically present in the underlying data schema, but is created through specific operations within the query builder model based on other fields in the schema. # Optional. A virtual field definition, used in place of field to define a field that is computed from other fields rather than being directly present in the data schema.For example, a virtual field can be defined using COALESCE to select the first non-null value from a list of fields.If virtual_field is set, field must not be set. + "underlyingFieldSources": [ # The field sources that will be used to create the virtual field, based on the semantics of the virtual field type.The field sources must follow these rules, based on the virtual field type: - For VIRTUAL_FIELD_TYPE_UNSPECIFIED, this field must be empty. - For COALESCE, this field must be non-empty and include a minimum of two field sources. The underlying field sources must be actual projected fields that represent actual schema fields and that must not be transformed and aggregated in any way, except for casting. The type of all the underlying field sources must be equivalent so that picking one of them would result in the same value type. + # Object with schema name: FieldSource + ], + "virtualFieldType": "A String", # Required. The type of the virtual field. + }, }, }, ], @@ -479,6 +533,12 @@

Method Details

"type": "A String", # Required. Specifies the aggregation function. Use one of the following string identifiers: "average": Computes the average (AVG). Applies only to numeric values. "count": Counts the number of values (COUNT). "count-distinct": Counts the number of distinct values (COUNT DISTINCT). "count-distinct-approx": Approximates the count of distinct values (APPROX_COUNT_DISTINCT). "max": Finds the maximum value (MAX). Applies only to numeric values. "min": Finds the minimum value (MIN). Applies only to numeric values. "sum": Computes the sum (SUM). Applies only to numeric values. }, "truncationGranularity": "A String", # The truncation granularity when grouping by a time/date field. This will be used to truncate the field to the granularity specified. This can be either a date or a time granularity found at https://cloud.google.com/bigquery/docs/reference/standard-sql/timestamp_functions#timestamp_trunc_granularity_date and https://cloud.google.com/bigquery/docs/reference/standard-sql/timestamp_functions#timestamp_trunc_granularity_time respectively. + "virtualField": { # A virtual field is a field that is not physically present in the underlying data schema, but is created through specific operations within the query builder model based on other fields in the schema. # Optional. A virtual field definition, used in place of field to define a field that is computed from other fields rather than being directly present in the data schema.For example, a virtual field can be defined using COALESCE to select the first non-null value from a list of fields.If virtual_field is set, field must not be set. + "underlyingFieldSources": [ # The field sources that will be used to create the virtual field, based on the semantics of the virtual field type.The field sources must follow these rules, based on the virtual field type: - For VIRTUAL_FIELD_TYPE_UNSPECIFIED, this field must be empty. - For COALESCE, this field must be non-empty and include a minimum of two field sources. The underlying field sources must be actual projected fields that represent actual schema fields and that must not be transformed and aggregated in any way, except for casting. The type of all the underlying field sources must be equivalent so that picking one of them would result in the same value type. + # Object with schema name: FieldSource + ], + "virtualFieldType": "A String", # Required. The type of the virtual field. + }, }, }, "fieldSourceValue": { # A source that can be used to represent a "field of data" within various parts of a structured query, such as in SELECT, WHERE, or ORDER BY clauses. The term "field of data" is used here because it is not limited to literal fields in the underlying data schema. # The field. This will be the field that is set as the Right Hand Side of the filter. @@ -500,6 +560,12 @@

Method Details

"type": "A String", # Required. Specifies the aggregation function. Use one of the following string identifiers: "average": Computes the average (AVG). Applies only to numeric values. "count": Counts the number of values (COUNT). "count-distinct": Counts the number of distinct values (COUNT DISTINCT). "count-distinct-approx": Approximates the count of distinct values (APPROX_COUNT_DISTINCT). "max": Finds the maximum value (MAX). Applies only to numeric values. "min": Finds the minimum value (MIN). Applies only to numeric values. "sum": Computes the sum (SUM). Applies only to numeric values. }, "truncationGranularity": "A String", # The truncation granularity when grouping by a time/date field. This will be used to truncate the field to the granularity specified. This can be either a date or a time granularity found at https://cloud.google.com/bigquery/docs/reference/standard-sql/timestamp_functions#timestamp_trunc_granularity_date and https://cloud.google.com/bigquery/docs/reference/standard-sql/timestamp_functions#timestamp_trunc_granularity_time respectively. + "virtualField": { # A virtual field is a field that is not physically present in the underlying data schema, but is created through specific operations within the query builder model based on other fields in the schema. # Optional. A virtual field definition, used in place of field to define a field that is computed from other fields rather than being directly present in the data schema.For example, a virtual field can be defined using COALESCE to select the first non-null value from a list of fields.If virtual_field is set, field must not be set. + "underlyingFieldSources": [ # The field sources that will be used to create the virtual field, based on the semantics of the virtual field type.The field sources must follow these rules, based on the virtual field type: - For VIRTUAL_FIELD_TYPE_UNSPECIFIED, this field must be empty. - For COALESCE, this field must be non-empty and include a minimum of two field sources. The underlying field sources must be actual projected fields that represent actual schema fields and that must not be transformed and aggregated in any way, except for casting. The type of all the underlying field sources must be equivalent so that picking one of them would result in the same value type. + # Object with schema name: FieldSource + ], + "virtualFieldType": "A String", # Required. The type of the virtual field. + }, }, }, "isNegation": True or False, # Determines if the NOT flag should be added to the comparator. @@ -529,6 +595,12 @@

Method Details

"type": "A String", # Required. Specifies the aggregation function. Use one of the following string identifiers: "average": Computes the average (AVG). Applies only to numeric values. "count": Counts the number of values (COUNT). "count-distinct": Counts the number of distinct values (COUNT DISTINCT). "count-distinct-approx": Approximates the count of distinct values (APPROX_COUNT_DISTINCT). "max": Finds the maximum value (MAX). Applies only to numeric values. "min": Finds the minimum value (MIN). Applies only to numeric values. "sum": Computes the sum (SUM). Applies only to numeric values. }, "truncationGranularity": "A String", # The truncation granularity when grouping by a time/date field. This will be used to truncate the field to the granularity specified. This can be either a date or a time granularity found at https://cloud.google.com/bigquery/docs/reference/standard-sql/timestamp_functions#timestamp_trunc_granularity_date and https://cloud.google.com/bigquery/docs/reference/standard-sql/timestamp_functions#timestamp_trunc_granularity_time respectively. + "virtualField": { # A virtual field is a field that is not physically present in the underlying data schema, but is created through specific operations within the query builder model based on other fields in the schema. # Optional. A virtual field definition, used in place of field to define a field that is computed from other fields rather than being directly present in the data schema.For example, a virtual field can be defined using COALESCE to select the first non-null value from a list of fields.If virtual_field is set, field must not be set. + "underlyingFieldSources": [ # The field sources that will be used to create the virtual field, based on the semantics of the virtual field type.The field sources must follow these rules, based on the virtual field type: - For VIRTUAL_FIELD_TYPE_UNSPECIFIED, this field must be empty. - For COALESCE, this field must be non-empty and include a minimum of two field sources. The underlying field sources must be actual projected fields that represent actual schema fields and that must not be transformed and aggregated in any way, except for casting. The type of all the underlying field sources must be equivalent so that picking one of them would result in the same value type. + # Object with schema name: FieldSource + ], + "virtualFieldType": "A String", # Required. The type of the virtual field. + }, }, }, "sortOrderDirection": "A String", # The sort order to use for the query. @@ -603,6 +675,12 @@

Method Details

"type": "A String", # Required. Specifies the aggregation function. Use one of the following string identifiers: "average": Computes the average (AVG). Applies only to numeric values. "count": Counts the number of values (COUNT). "count-distinct": Counts the number of distinct values (COUNT DISTINCT). "count-distinct-approx": Approximates the count of distinct values (APPROX_COUNT_DISTINCT). "max": Finds the maximum value (MAX). Applies only to numeric values. "min": Finds the minimum value (MIN). Applies only to numeric values. "sum": Computes the sum (SUM). Applies only to numeric values. }, "truncationGranularity": "A String", # The truncation granularity when grouping by a time/date field. This will be used to truncate the field to the granularity specified. This can be either a date or a time granularity found at https://cloud.google.com/bigquery/docs/reference/standard-sql/timestamp_functions#timestamp_trunc_granularity_date and https://cloud.google.com/bigquery/docs/reference/standard-sql/timestamp_functions#timestamp_trunc_granularity_time respectively. + "virtualField": { # A virtual field is a field that is not physically present in the underlying data schema, but is created through specific operations within the query builder model based on other fields in the schema. # Optional. A virtual field definition, used in place of field to define a field that is computed from other fields rather than being directly present in the data schema.For example, a virtual field can be defined using COALESCE to select the first non-null value from a list of fields.If virtual_field is set, field must not be set. + "underlyingFieldSources": [ # The field sources that will be used to create the virtual field, based on the semantics of the virtual field type.The field sources must follow these rules, based on the virtual field type: - For VIRTUAL_FIELD_TYPE_UNSPECIFIED, this field must be empty. - For COALESCE, this field must be non-empty and include a minimum of two field sources. The underlying field sources must be actual projected fields that represent actual schema fields and that must not be transformed and aggregated in any way, except for casting. The type of all the underlying field sources must be equivalent so that picking one of them would result in the same value type. + # Object with schema name: FieldSource + ], + "virtualFieldType": "A String", # Required. The type of the virtual field. + }, }, }, ], @@ -631,6 +709,12 @@

Method Details

"type": "A String", # Required. Specifies the aggregation function. Use one of the following string identifiers: "average": Computes the average (AVG). Applies only to numeric values. "count": Counts the number of values (COUNT). "count-distinct": Counts the number of distinct values (COUNT DISTINCT). "count-distinct-approx": Approximates the count of distinct values (APPROX_COUNT_DISTINCT). "max": Finds the maximum value (MAX). Applies only to numeric values. "min": Finds the minimum value (MIN). Applies only to numeric values. "sum": Computes the sum (SUM). Applies only to numeric values. }, "truncationGranularity": "A String", # The truncation granularity when grouping by a time/date field. This will be used to truncate the field to the granularity specified. This can be either a date or a time granularity found at https://cloud.google.com/bigquery/docs/reference/standard-sql/timestamp_functions#timestamp_trunc_granularity_date and https://cloud.google.com/bigquery/docs/reference/standard-sql/timestamp_functions#timestamp_trunc_granularity_time respectively. + "virtualField": { # A virtual field is a field that is not physically present in the underlying data schema, but is created through specific operations within the query builder model based on other fields in the schema. # Optional. A virtual field definition, used in place of field to define a field that is computed from other fields rather than being directly present in the data schema.For example, a virtual field can be defined using COALESCE to select the first non-null value from a list of fields.If virtual_field is set, field must not be set. + "underlyingFieldSources": [ # The field sources that will be used to create the virtual field, based on the semantics of the virtual field type.The field sources must follow these rules, based on the virtual field type: - For VIRTUAL_FIELD_TYPE_UNSPECIFIED, this field must be empty. - For COALESCE, this field must be non-empty and include a minimum of two field sources. The underlying field sources must be actual projected fields that represent actual schema fields and that must not be transformed and aggregated in any way, except for casting. The type of all the underlying field sources must be equivalent so that picking one of them would result in the same value type. + # Object with schema name: FieldSource + ], + "virtualFieldType": "A String", # Required. The type of the virtual field. + }, }, }, "fieldSourceValue": { # A source that can be used to represent a "field of data" within various parts of a structured query, such as in SELECT, WHERE, or ORDER BY clauses. The term "field of data" is used here because it is not limited to literal fields in the underlying data schema. # The field. This will be the field that is set as the Right Hand Side of the filter. @@ -652,6 +736,12 @@

Method Details

"type": "A String", # Required. Specifies the aggregation function. Use one of the following string identifiers: "average": Computes the average (AVG). Applies only to numeric values. "count": Counts the number of values (COUNT). "count-distinct": Counts the number of distinct values (COUNT DISTINCT). "count-distinct-approx": Approximates the count of distinct values (APPROX_COUNT_DISTINCT). "max": Finds the maximum value (MAX). Applies only to numeric values. "min": Finds the minimum value (MIN). Applies only to numeric values. "sum": Computes the sum (SUM). Applies only to numeric values. }, "truncationGranularity": "A String", # The truncation granularity when grouping by a time/date field. This will be used to truncate the field to the granularity specified. This can be either a date or a time granularity found at https://cloud.google.com/bigquery/docs/reference/standard-sql/timestamp_functions#timestamp_trunc_granularity_date and https://cloud.google.com/bigquery/docs/reference/standard-sql/timestamp_functions#timestamp_trunc_granularity_time respectively. + "virtualField": { # A virtual field is a field that is not physically present in the underlying data schema, but is created through specific operations within the query builder model based on other fields in the schema. # Optional. A virtual field definition, used in place of field to define a field that is computed from other fields rather than being directly present in the data schema.For example, a virtual field can be defined using COALESCE to select the first non-null value from a list of fields.If virtual_field is set, field must not be set. + "underlyingFieldSources": [ # The field sources that will be used to create the virtual field, based on the semantics of the virtual field type.The field sources must follow these rules, based on the virtual field type: - For VIRTUAL_FIELD_TYPE_UNSPECIFIED, this field must be empty. - For COALESCE, this field must be non-empty and include a minimum of two field sources. The underlying field sources must be actual projected fields that represent actual schema fields and that must not be transformed and aggregated in any way, except for casting. The type of all the underlying field sources must be equivalent so that picking one of them would result in the same value type. + # Object with schema name: FieldSource + ], + "virtualFieldType": "A String", # Required. The type of the virtual field. + }, }, }, "isNegation": True or False, # Determines if the NOT flag should be added to the comparator. @@ -681,6 +771,12 @@

Method Details

"type": "A String", # Required. Specifies the aggregation function. Use one of the following string identifiers: "average": Computes the average (AVG). Applies only to numeric values. "count": Counts the number of values (COUNT). "count-distinct": Counts the number of distinct values (COUNT DISTINCT). "count-distinct-approx": Approximates the count of distinct values (APPROX_COUNT_DISTINCT). "max": Finds the maximum value (MAX). Applies only to numeric values. "min": Finds the minimum value (MIN). Applies only to numeric values. "sum": Computes the sum (SUM). Applies only to numeric values. }, "truncationGranularity": "A String", # The truncation granularity when grouping by a time/date field. This will be used to truncate the field to the granularity specified. This can be either a date or a time granularity found at https://cloud.google.com/bigquery/docs/reference/standard-sql/timestamp_functions#timestamp_trunc_granularity_date and https://cloud.google.com/bigquery/docs/reference/standard-sql/timestamp_functions#timestamp_trunc_granularity_time respectively. + "virtualField": { # A virtual field is a field that is not physically present in the underlying data schema, but is created through specific operations within the query builder model based on other fields in the schema. # Optional. A virtual field definition, used in place of field to define a field that is computed from other fields rather than being directly present in the data schema.For example, a virtual field can be defined using COALESCE to select the first non-null value from a list of fields.If virtual_field is set, field must not be set. + "underlyingFieldSources": [ # The field sources that will be used to create the virtual field, based on the semantics of the virtual field type.The field sources must follow these rules, based on the virtual field type: - For VIRTUAL_FIELD_TYPE_UNSPECIFIED, this field must be empty. - For COALESCE, this field must be non-empty and include a minimum of two field sources. The underlying field sources must be actual projected fields that represent actual schema fields and that must not be transformed and aggregated in any way, except for casting. The type of all the underlying field sources must be equivalent so that picking one of them would result in the same value type. + # Object with schema name: FieldSource + ], + "virtualFieldType": "A String", # Required. The type of the virtual field. + }, }, }, "sortOrderDirection": "A String", # The sort order to use for the query. @@ -763,6 +859,12 @@

Method Details

"type": "A String", # Required. Specifies the aggregation function. Use one of the following string identifiers: "average": Computes the average (AVG). Applies only to numeric values. "count": Counts the number of values (COUNT). "count-distinct": Counts the number of distinct values (COUNT DISTINCT). "count-distinct-approx": Approximates the count of distinct values (APPROX_COUNT_DISTINCT). "max": Finds the maximum value (MAX). Applies only to numeric values. "min": Finds the minimum value (MIN). Applies only to numeric values. "sum": Computes the sum (SUM). Applies only to numeric values. }, "truncationGranularity": "A String", # The truncation granularity when grouping by a time/date field. This will be used to truncate the field to the granularity specified. This can be either a date or a time granularity found at https://cloud.google.com/bigquery/docs/reference/standard-sql/timestamp_functions#timestamp_trunc_granularity_date and https://cloud.google.com/bigquery/docs/reference/standard-sql/timestamp_functions#timestamp_trunc_granularity_time respectively. + "virtualField": { # A virtual field is a field that is not physically present in the underlying data schema, but is created through specific operations within the query builder model based on other fields in the schema. # Optional. A virtual field definition, used in place of field to define a field that is computed from other fields rather than being directly present in the data schema.For example, a virtual field can be defined using COALESCE to select the first non-null value from a list of fields.If virtual_field is set, field must not be set. + "underlyingFieldSources": [ # The field sources that will be used to create the virtual field, based on the semantics of the virtual field type.The field sources must follow these rules, based on the virtual field type: - For VIRTUAL_FIELD_TYPE_UNSPECIFIED, this field must be empty. - For COALESCE, this field must be non-empty and include a minimum of two field sources. The underlying field sources must be actual projected fields that represent actual schema fields and that must not be transformed and aggregated in any way, except for casting. The type of all the underlying field sources must be equivalent so that picking one of them would result in the same value type. + # Object with schema name: FieldSource + ], + "virtualFieldType": "A String", # Required. The type of the virtual field. + }, }, }, ], @@ -791,6 +893,12 @@

Method Details

"type": "A String", # Required. Specifies the aggregation function. Use one of the following string identifiers: "average": Computes the average (AVG). Applies only to numeric values. "count": Counts the number of values (COUNT). "count-distinct": Counts the number of distinct values (COUNT DISTINCT). "count-distinct-approx": Approximates the count of distinct values (APPROX_COUNT_DISTINCT). "max": Finds the maximum value (MAX). Applies only to numeric values. "min": Finds the minimum value (MIN). Applies only to numeric values. "sum": Computes the sum (SUM). Applies only to numeric values. }, "truncationGranularity": "A String", # The truncation granularity when grouping by a time/date field. This will be used to truncate the field to the granularity specified. This can be either a date or a time granularity found at https://cloud.google.com/bigquery/docs/reference/standard-sql/timestamp_functions#timestamp_trunc_granularity_date and https://cloud.google.com/bigquery/docs/reference/standard-sql/timestamp_functions#timestamp_trunc_granularity_time respectively. + "virtualField": { # A virtual field is a field that is not physically present in the underlying data schema, but is created through specific operations within the query builder model based on other fields in the schema. # Optional. A virtual field definition, used in place of field to define a field that is computed from other fields rather than being directly present in the data schema.For example, a virtual field can be defined using COALESCE to select the first non-null value from a list of fields.If virtual_field is set, field must not be set. + "underlyingFieldSources": [ # The field sources that will be used to create the virtual field, based on the semantics of the virtual field type.The field sources must follow these rules, based on the virtual field type: - For VIRTUAL_FIELD_TYPE_UNSPECIFIED, this field must be empty. - For COALESCE, this field must be non-empty and include a minimum of two field sources. The underlying field sources must be actual projected fields that represent actual schema fields and that must not be transformed and aggregated in any way, except for casting. The type of all the underlying field sources must be equivalent so that picking one of them would result in the same value type. + # Object with schema name: FieldSource + ], + "virtualFieldType": "A String", # Required. The type of the virtual field. + }, }, }, "fieldSourceValue": { # A source that can be used to represent a "field of data" within various parts of a structured query, such as in SELECT, WHERE, or ORDER BY clauses. The term "field of data" is used here because it is not limited to literal fields in the underlying data schema. # The field. This will be the field that is set as the Right Hand Side of the filter. @@ -812,6 +920,12 @@

Method Details

"type": "A String", # Required. Specifies the aggregation function. Use one of the following string identifiers: "average": Computes the average (AVG). Applies only to numeric values. "count": Counts the number of values (COUNT). "count-distinct": Counts the number of distinct values (COUNT DISTINCT). "count-distinct-approx": Approximates the count of distinct values (APPROX_COUNT_DISTINCT). "max": Finds the maximum value (MAX). Applies only to numeric values. "min": Finds the minimum value (MIN). Applies only to numeric values. "sum": Computes the sum (SUM). Applies only to numeric values. }, "truncationGranularity": "A String", # The truncation granularity when grouping by a time/date field. This will be used to truncate the field to the granularity specified. This can be either a date or a time granularity found at https://cloud.google.com/bigquery/docs/reference/standard-sql/timestamp_functions#timestamp_trunc_granularity_date and https://cloud.google.com/bigquery/docs/reference/standard-sql/timestamp_functions#timestamp_trunc_granularity_time respectively. + "virtualField": { # A virtual field is a field that is not physically present in the underlying data schema, but is created through specific operations within the query builder model based on other fields in the schema. # Optional. A virtual field definition, used in place of field to define a field that is computed from other fields rather than being directly present in the data schema.For example, a virtual field can be defined using COALESCE to select the first non-null value from a list of fields.If virtual_field is set, field must not be set. + "underlyingFieldSources": [ # The field sources that will be used to create the virtual field, based on the semantics of the virtual field type.The field sources must follow these rules, based on the virtual field type: - For VIRTUAL_FIELD_TYPE_UNSPECIFIED, this field must be empty. - For COALESCE, this field must be non-empty and include a minimum of two field sources. The underlying field sources must be actual projected fields that represent actual schema fields and that must not be transformed and aggregated in any way, except for casting. The type of all the underlying field sources must be equivalent so that picking one of them would result in the same value type. + # Object with schema name: FieldSource + ], + "virtualFieldType": "A String", # Required. The type of the virtual field. + }, }, }, "isNegation": True or False, # Determines if the NOT flag should be added to the comparator. @@ -841,6 +955,12 @@

Method Details

"type": "A String", # Required. Specifies the aggregation function. Use one of the following string identifiers: "average": Computes the average (AVG). Applies only to numeric values. "count": Counts the number of values (COUNT). "count-distinct": Counts the number of distinct values (COUNT DISTINCT). "count-distinct-approx": Approximates the count of distinct values (APPROX_COUNT_DISTINCT). "max": Finds the maximum value (MAX). Applies only to numeric values. "min": Finds the minimum value (MIN). Applies only to numeric values. "sum": Computes the sum (SUM). Applies only to numeric values. }, "truncationGranularity": "A String", # The truncation granularity when grouping by a time/date field. This will be used to truncate the field to the granularity specified. This can be either a date or a time granularity found at https://cloud.google.com/bigquery/docs/reference/standard-sql/timestamp_functions#timestamp_trunc_granularity_date and https://cloud.google.com/bigquery/docs/reference/standard-sql/timestamp_functions#timestamp_trunc_granularity_time respectively. + "virtualField": { # A virtual field is a field that is not physically present in the underlying data schema, but is created through specific operations within the query builder model based on other fields in the schema. # Optional. A virtual field definition, used in place of field to define a field that is computed from other fields rather than being directly present in the data schema.For example, a virtual field can be defined using COALESCE to select the first non-null value from a list of fields.If virtual_field is set, field must not be set. + "underlyingFieldSources": [ # The field sources that will be used to create the virtual field, based on the semantics of the virtual field type.The field sources must follow these rules, based on the virtual field type: - For VIRTUAL_FIELD_TYPE_UNSPECIFIED, this field must be empty. - For COALESCE, this field must be non-empty and include a minimum of two field sources. The underlying field sources must be actual projected fields that represent actual schema fields and that must not be transformed and aggregated in any way, except for casting. The type of all the underlying field sources must be equivalent so that picking one of them would result in the same value type. + # Object with schema name: FieldSource + ], + "virtualFieldType": "A String", # Required. The type of the virtual field. + }, }, }, "sortOrderDirection": "A String", # The sort order to use for the query. @@ -903,6 +1023,12 @@

Method Details

"type": "A String", # Required. Specifies the aggregation function. Use one of the following string identifiers: "average": Computes the average (AVG). Applies only to numeric values. "count": Counts the number of values (COUNT). "count-distinct": Counts the number of distinct values (COUNT DISTINCT). "count-distinct-approx": Approximates the count of distinct values (APPROX_COUNT_DISTINCT). "max": Finds the maximum value (MAX). Applies only to numeric values. "min": Finds the minimum value (MIN). Applies only to numeric values. "sum": Computes the sum (SUM). Applies only to numeric values. }, "truncationGranularity": "A String", # The truncation granularity when grouping by a time/date field. This will be used to truncate the field to the granularity specified. This can be either a date or a time granularity found at https://cloud.google.com/bigquery/docs/reference/standard-sql/timestamp_functions#timestamp_trunc_granularity_date and https://cloud.google.com/bigquery/docs/reference/standard-sql/timestamp_functions#timestamp_trunc_granularity_time respectively. + "virtualField": { # A virtual field is a field that is not physically present in the underlying data schema, but is created through specific operations within the query builder model based on other fields in the schema. # Optional. A virtual field definition, used in place of field to define a field that is computed from other fields rather than being directly present in the data schema.For example, a virtual field can be defined using COALESCE to select the first non-null value from a list of fields.If virtual_field is set, field must not be set. + "underlyingFieldSources": [ # The field sources that will be used to create the virtual field, based on the semantics of the virtual field type.The field sources must follow these rules, based on the virtual field type: - For VIRTUAL_FIELD_TYPE_UNSPECIFIED, this field must be empty. - For COALESCE, this field must be non-empty and include a minimum of two field sources. The underlying field sources must be actual projected fields that represent actual schema fields and that must not be transformed and aggregated in any way, except for casting. The type of all the underlying field sources must be equivalent so that picking one of them would result in the same value type. + # Object with schema name: FieldSource + ], + "virtualFieldType": "A String", # Required. The type of the virtual field. + }, }, }, ], @@ -931,6 +1057,12 @@

Method Details

"type": "A String", # Required. Specifies the aggregation function. Use one of the following string identifiers: "average": Computes the average (AVG). Applies only to numeric values. "count": Counts the number of values (COUNT). "count-distinct": Counts the number of distinct values (COUNT DISTINCT). "count-distinct-approx": Approximates the count of distinct values (APPROX_COUNT_DISTINCT). "max": Finds the maximum value (MAX). Applies only to numeric values. "min": Finds the minimum value (MIN). Applies only to numeric values. "sum": Computes the sum (SUM). Applies only to numeric values. }, "truncationGranularity": "A String", # The truncation granularity when grouping by a time/date field. This will be used to truncate the field to the granularity specified. This can be either a date or a time granularity found at https://cloud.google.com/bigquery/docs/reference/standard-sql/timestamp_functions#timestamp_trunc_granularity_date and https://cloud.google.com/bigquery/docs/reference/standard-sql/timestamp_functions#timestamp_trunc_granularity_time respectively. + "virtualField": { # A virtual field is a field that is not physically present in the underlying data schema, but is created through specific operations within the query builder model based on other fields in the schema. # Optional. A virtual field definition, used in place of field to define a field that is computed from other fields rather than being directly present in the data schema.For example, a virtual field can be defined using COALESCE to select the first non-null value from a list of fields.If virtual_field is set, field must not be set. + "underlyingFieldSources": [ # The field sources that will be used to create the virtual field, based on the semantics of the virtual field type.The field sources must follow these rules, based on the virtual field type: - For VIRTUAL_FIELD_TYPE_UNSPECIFIED, this field must be empty. - For COALESCE, this field must be non-empty and include a minimum of two field sources. The underlying field sources must be actual projected fields that represent actual schema fields and that must not be transformed and aggregated in any way, except for casting. The type of all the underlying field sources must be equivalent so that picking one of them would result in the same value type. + # Object with schema name: FieldSource + ], + "virtualFieldType": "A String", # Required. The type of the virtual field. + }, }, }, "fieldSourceValue": { # A source that can be used to represent a "field of data" within various parts of a structured query, such as in SELECT, WHERE, or ORDER BY clauses. The term "field of data" is used here because it is not limited to literal fields in the underlying data schema. # The field. This will be the field that is set as the Right Hand Side of the filter. @@ -952,6 +1084,12 @@

Method Details

"type": "A String", # Required. Specifies the aggregation function. Use one of the following string identifiers: "average": Computes the average (AVG). Applies only to numeric values. "count": Counts the number of values (COUNT). "count-distinct": Counts the number of distinct values (COUNT DISTINCT). "count-distinct-approx": Approximates the count of distinct values (APPROX_COUNT_DISTINCT). "max": Finds the maximum value (MAX). Applies only to numeric values. "min": Finds the minimum value (MIN). Applies only to numeric values. "sum": Computes the sum (SUM). Applies only to numeric values. }, "truncationGranularity": "A String", # The truncation granularity when grouping by a time/date field. This will be used to truncate the field to the granularity specified. This can be either a date or a time granularity found at https://cloud.google.com/bigquery/docs/reference/standard-sql/timestamp_functions#timestamp_trunc_granularity_date and https://cloud.google.com/bigquery/docs/reference/standard-sql/timestamp_functions#timestamp_trunc_granularity_time respectively. + "virtualField": { # A virtual field is a field that is not physically present in the underlying data schema, but is created through specific operations within the query builder model based on other fields in the schema. # Optional. A virtual field definition, used in place of field to define a field that is computed from other fields rather than being directly present in the data schema.For example, a virtual field can be defined using COALESCE to select the first non-null value from a list of fields.If virtual_field is set, field must not be set. + "underlyingFieldSources": [ # The field sources that will be used to create the virtual field, based on the semantics of the virtual field type.The field sources must follow these rules, based on the virtual field type: - For VIRTUAL_FIELD_TYPE_UNSPECIFIED, this field must be empty. - For COALESCE, this field must be non-empty and include a minimum of two field sources. The underlying field sources must be actual projected fields that represent actual schema fields and that must not be transformed and aggregated in any way, except for casting. The type of all the underlying field sources must be equivalent so that picking one of them would result in the same value type. + # Object with schema name: FieldSource + ], + "virtualFieldType": "A String", # Required. The type of the virtual field. + }, }, }, "isNegation": True or False, # Determines if the NOT flag should be added to the comparator. @@ -981,6 +1119,12 @@

Method Details

"type": "A String", # Required. Specifies the aggregation function. Use one of the following string identifiers: "average": Computes the average (AVG). Applies only to numeric values. "count": Counts the number of values (COUNT). "count-distinct": Counts the number of distinct values (COUNT DISTINCT). "count-distinct-approx": Approximates the count of distinct values (APPROX_COUNT_DISTINCT). "max": Finds the maximum value (MAX). Applies only to numeric values. "min": Finds the minimum value (MIN). Applies only to numeric values. "sum": Computes the sum (SUM). Applies only to numeric values. }, "truncationGranularity": "A String", # The truncation granularity when grouping by a time/date field. This will be used to truncate the field to the granularity specified. This can be either a date or a time granularity found at https://cloud.google.com/bigquery/docs/reference/standard-sql/timestamp_functions#timestamp_trunc_granularity_date and https://cloud.google.com/bigquery/docs/reference/standard-sql/timestamp_functions#timestamp_trunc_granularity_time respectively. + "virtualField": { # A virtual field is a field that is not physically present in the underlying data schema, but is created through specific operations within the query builder model based on other fields in the schema. # Optional. A virtual field definition, used in place of field to define a field that is computed from other fields rather than being directly present in the data schema.For example, a virtual field can be defined using COALESCE to select the first non-null value from a list of fields.If virtual_field is set, field must not be set. + "underlyingFieldSources": [ # The field sources that will be used to create the virtual field, based on the semantics of the virtual field type.The field sources must follow these rules, based on the virtual field type: - For VIRTUAL_FIELD_TYPE_UNSPECIFIED, this field must be empty. - For COALESCE, this field must be non-empty and include a minimum of two field sources. The underlying field sources must be actual projected fields that represent actual schema fields and that must not be transformed and aggregated in any way, except for casting. The type of all the underlying field sources must be equivalent so that picking one of them would result in the same value type. + # Object with schema name: FieldSource + ], + "virtualFieldType": "A String", # Required. The type of the virtual field. + }, }, }, "sortOrderDirection": "A String", # The sort order to use for the query. diff --git a/docs/dyn/memcache_v1.projects.locations.html b/docs/dyn/memcache_v1.projects.locations.html index bbd4ebd39b..680e6a02ea 100644 --- a/docs/dyn/memcache_v1.projects.locations.html +++ b/docs/dyn/memcache_v1.projects.locations.html @@ -92,7 +92,7 @@

Instance Methods

Gets information about a location.

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

-

Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project.

+

Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the ListLocationsRequest.name field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.

list_next()

Retrieves the next page of results.

@@ -131,11 +131,11 @@

Method Details

list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None) -
Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project.
+  
Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the ListLocationsRequest.name field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.
 
 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. Do not use this field 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/memcache_v1beta2.projects.locations.html b/docs/dyn/memcache_v1beta2.projects.locations.html
index f143be4f7d..f9a7233bc5 100644
--- a/docs/dyn/memcache_v1beta2.projects.locations.html
+++ b/docs/dyn/memcache_v1beta2.projects.locations.html
@@ -92,7 +92,7 @@ 

Instance Methods

Gets information about a location.

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

-

Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project.

+

Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the ListLocationsRequest.name field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.

list_next()

Retrieves the next page of results.

@@ -131,11 +131,11 @@

Method Details

list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None) -
Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project.
+  
Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the ListLocationsRequest.name field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.
 
 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. Do not use this field 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_products_v1.accounts.productInputs.html b/docs/dyn/merchantapi_products_v1.accounts.productInputs.html
index 0019b0e25d..5d0b66aa93 100644
--- a/docs/dyn/merchantapi_products_v1.accounts.productInputs.html
+++ b/docs/dyn/merchantapi_products_v1.accounts.productInputs.html
@@ -233,6 +233,9 @@ 

Method Details

], "displayAdsTitle": "A String", # Title of an item for dynamic remarketing campaigns. "displayAdsValue": 3.14, # Offer margin for dynamic remarketing campaigns. For more information, see [Display ads attribute](https://support.google.com/merchants/answer/6069387). + "documentLinks": [ # Optional. Contains a list of PDF [document URLs](https://support.google.com/merchants/answer/17084656) for the product. Examples are training manuals, user guides, assembly instructions, package inserts, etc. Must start with "http://" or "https://"), ASCII characters only, and RFC 3986 compliant. + "A String", + ], "electricRange": { # The mileage of the vehicle. # The [electric range](https://support.google.com/google-ads/answer/15162232) of the vehicle in miles/kms. "unit": "A String", # The unit of the mileage. "value": "A String", # The distance value. @@ -303,6 +306,7 @@

Method Details

}, "isBundle": True or False, # Whether the item is a business-defined sub-API. A [sub-API] (https://support.google.com/merchants/answer/6324449) is a custom grouping of different products sold by a business for a single price. "itemGroupId": "A String", # Shared identifier for all variants of the same product. + "itemGroupTitle": "A String", # Optional. Represents the [title of the product group](https://support.google.com/merchants/answer/17085146) to which this variant product belongs. This can be used along with the [item group id](https://support.google.com/merchants/answer/6324507) attribute. It lets you perform better grouping of variant products, and helps identifying common product characteristics more efficiently. "lifestyleImageLinks": [ # Additional URLs of lifestyle images of the item, used to explicitly identify images that showcase your item in a real-world context. See the [Help Center article](https://support.google.com/merchants/answer/9103186) for more information. "A String", ], @@ -376,6 +380,7 @@

Method Details

}, "pickupMethod": "A String", # The [pickup](https://support.google.com/merchants/answer/14634021) option for the item. "pickupSla": "A String", # Item store pickup timeline. For more information, see [Pickup SLA](https://support.google.com/merchants/answer/14635400). + "popularityRank": 3.14, # Optional. Indicates the [popularity](https://support.google.com/merchants/answer/17085297) of the product in a merchant's inventory. Using a scale of 0.0 (lowest) to 100.0 (highest). "price": { # The price represented as a number and currency. # Price of the item. "amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros). "currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217). @@ -412,6 +417,19 @@

Method Details

"promotionIds": [ # The unique ID of a promotion. "A String", ], + "questionsAndAnswers": [ # Optional. Contains user-, merchant-, and manufacturer-authored [questions and answers](https://support.google.com/merchants/answer/17085211) about the product. Max 30 question and answer pairs. Max 5000 characters total. Each question can have max 1000 characters. Each answer can have max 1000 characters. + { # The question and answer for the product. + "answer": "A String", # Required. The answer text. + "question": "A String", # Required. The question text. + }, + ], + "relatedProducts": [ # Optional. Specifies how other [products are related](https://support.google.com/merchants/answer/17085213) to this product. + { # Specifies how other products are related to this product. + "id": "A String", # Required. The identifier of the related product. + "idType": "A String", # Required. The type of the identifier of the related product. For example, [GTIN](https://support.google.com/merchants/answer/6219078) or [product ID](https://support.google.com/merchants/answer/6324405). + "relationshipType": "A String", # Required. The type of the relationship between this product and the related product. + }, + ], "returnPolicyLabel": "A String", # The return label of the product, used to group products in account-level return policies. Max. 100 characters. For more information, see [Return policy label](https://support.google.com/merchants/answer/9445425). "salePrice": { # The price represented as a number and currency. # Advertised sale price of the item. "amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros). @@ -518,6 +536,12 @@

Method Details

"unit": "A String", # The unit of the measure. "value": 3.14, # The measure of an item. }, + "variantOptions": [ # Optional. Contains the [list of all variant-identifying options](https://support.google.com/merchants/answer/17085214) of this product. + { # Additional product variants for the product. + "name": "A String", # Required. The name of the variant. For example, "Color", "Memory", "Size", "Length" + "value": "A String", # Required. The value of the variant. For example, "Red", "128GB", "XL", "100cm" + }, + ], "vehicleAllInPrice": { # The price represented as a number and currency. # The all-in advertised price for a vehicle, which includes costs for the following – any accessories attached to the vehicle, environmental levies, extra warranty, fuel, freight, pre-delivery inspection (PDI), dealer fees for handling licensing, provincial regulatory fees, miscellaneous dealer charges for security etching and nitrogen tire fill, and factory-to-customer or dealer-to-customer discounts or incentives. See the [Vehicle all-in price](https://support.google.com/google-ads/answer/14156981) for more information. "amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros). "currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217). @@ -671,6 +695,9 @@

Method Details

], "displayAdsTitle": "A String", # Title of an item for dynamic remarketing campaigns. "displayAdsValue": 3.14, # Offer margin for dynamic remarketing campaigns. For more information, see [Display ads attribute](https://support.google.com/merchants/answer/6069387). + "documentLinks": [ # Optional. Contains a list of PDF [document URLs](https://support.google.com/merchants/answer/17084656) for the product. Examples are training manuals, user guides, assembly instructions, package inserts, etc. Must start with "http://" or "https://"), ASCII characters only, and RFC 3986 compliant. + "A String", + ], "electricRange": { # The mileage of the vehicle. # The [electric range](https://support.google.com/google-ads/answer/15162232) of the vehicle in miles/kms. "unit": "A String", # The unit of the mileage. "value": "A String", # The distance value. @@ -741,6 +768,7 @@

Method Details

}, "isBundle": True or False, # Whether the item is a business-defined sub-API. A [sub-API] (https://support.google.com/merchants/answer/6324449) is a custom grouping of different products sold by a business for a single price. "itemGroupId": "A String", # Shared identifier for all variants of the same product. + "itemGroupTitle": "A String", # Optional. Represents the [title of the product group](https://support.google.com/merchants/answer/17085146) to which this variant product belongs. This can be used along with the [item group id](https://support.google.com/merchants/answer/6324507) attribute. It lets you perform better grouping of variant products, and helps identifying common product characteristics more efficiently. "lifestyleImageLinks": [ # Additional URLs of lifestyle images of the item, used to explicitly identify images that showcase your item in a real-world context. See the [Help Center article](https://support.google.com/merchants/answer/9103186) for more information. "A String", ], @@ -814,6 +842,7 @@

Method Details

}, "pickupMethod": "A String", # The [pickup](https://support.google.com/merchants/answer/14634021) option for the item. "pickupSla": "A String", # Item store pickup timeline. For more information, see [Pickup SLA](https://support.google.com/merchants/answer/14635400). + "popularityRank": 3.14, # Optional. Indicates the [popularity](https://support.google.com/merchants/answer/17085297) of the product in a merchant's inventory. Using a scale of 0.0 (lowest) to 100.0 (highest). "price": { # The price represented as a number and currency. # Price of the item. "amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros). "currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217). @@ -850,6 +879,19 @@

Method Details

"promotionIds": [ # The unique ID of a promotion. "A String", ], + "questionsAndAnswers": [ # Optional. Contains user-, merchant-, and manufacturer-authored [questions and answers](https://support.google.com/merchants/answer/17085211) about the product. Max 30 question and answer pairs. Max 5000 characters total. Each question can have max 1000 characters. Each answer can have max 1000 characters. + { # The question and answer for the product. + "answer": "A String", # Required. The answer text. + "question": "A String", # Required. The question text. + }, + ], + "relatedProducts": [ # Optional. Specifies how other [products are related](https://support.google.com/merchants/answer/17085213) to this product. + { # Specifies how other products are related to this product. + "id": "A String", # Required. The identifier of the related product. + "idType": "A String", # Required. The type of the identifier of the related product. For example, [GTIN](https://support.google.com/merchants/answer/6219078) or [product ID](https://support.google.com/merchants/answer/6324405). + "relationshipType": "A String", # Required. The type of the relationship between this product and the related product. + }, + ], "returnPolicyLabel": "A String", # The return label of the product, used to group products in account-level return policies. Max. 100 characters. For more information, see [Return policy label](https://support.google.com/merchants/answer/9445425). "salePrice": { # The price represented as a number and currency. # Advertised sale price of the item. "amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros). @@ -956,6 +998,12 @@

Method Details

"unit": "A String", # The unit of the measure. "value": 3.14, # The measure of an item. }, + "variantOptions": [ # Optional. Contains the [list of all variant-identifying options](https://support.google.com/merchants/answer/17085214) of this product. + { # Additional product variants for the product. + "name": "A String", # Required. The name of the variant. For example, "Color", "Memory", "Size", "Length" + "value": "A String", # Required. The value of the variant. For example, "Red", "128GB", "XL", "100cm" + }, + ], "vehicleAllInPrice": { # The price represented as a number and currency. # The all-in advertised price for a vehicle, which includes costs for the following – any accessories attached to the vehicle, environmental levies, extra warranty, fuel, freight, pre-delivery inspection (PDI), dealer fees for handling licensing, provincial regulatory fees, miscellaneous dealer charges for security etching and nitrogen tire fill, and factory-to-customer or dealer-to-customer discounts or incentives. See the [Vehicle all-in price](https://support.google.com/google-ads/answer/14156981) for more information. "amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros). "currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217). @@ -1110,6 +1158,9 @@

Method Details

], "displayAdsTitle": "A String", # Title of an item for dynamic remarketing campaigns. "displayAdsValue": 3.14, # Offer margin for dynamic remarketing campaigns. For more information, see [Display ads attribute](https://support.google.com/merchants/answer/6069387). + "documentLinks": [ # Optional. Contains a list of PDF [document URLs](https://support.google.com/merchants/answer/17084656) for the product. Examples are training manuals, user guides, assembly instructions, package inserts, etc. Must start with "http://" or "https://"), ASCII characters only, and RFC 3986 compliant. + "A String", + ], "electricRange": { # The mileage of the vehicle. # The [electric range](https://support.google.com/google-ads/answer/15162232) of the vehicle in miles/kms. "unit": "A String", # The unit of the mileage. "value": "A String", # The distance value. @@ -1180,6 +1231,7 @@

Method Details

}, "isBundle": True or False, # Whether the item is a business-defined sub-API. A [sub-API] (https://support.google.com/merchants/answer/6324449) is a custom grouping of different products sold by a business for a single price. "itemGroupId": "A String", # Shared identifier for all variants of the same product. + "itemGroupTitle": "A String", # Optional. Represents the [title of the product group](https://support.google.com/merchants/answer/17085146) to which this variant product belongs. This can be used along with the [item group id](https://support.google.com/merchants/answer/6324507) attribute. It lets you perform better grouping of variant products, and helps identifying common product characteristics more efficiently. "lifestyleImageLinks": [ # Additional URLs of lifestyle images of the item, used to explicitly identify images that showcase your item in a real-world context. See the [Help Center article](https://support.google.com/merchants/answer/9103186) for more information. "A String", ], @@ -1253,6 +1305,7 @@

Method Details

}, "pickupMethod": "A String", # The [pickup](https://support.google.com/merchants/answer/14634021) option for the item. "pickupSla": "A String", # Item store pickup timeline. For more information, see [Pickup SLA](https://support.google.com/merchants/answer/14635400). + "popularityRank": 3.14, # Optional. Indicates the [popularity](https://support.google.com/merchants/answer/17085297) of the product in a merchant's inventory. Using a scale of 0.0 (lowest) to 100.0 (highest). "price": { # The price represented as a number and currency. # Price of the item. "amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros). "currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217). @@ -1289,6 +1342,19 @@

Method Details

"promotionIds": [ # The unique ID of a promotion. "A String", ], + "questionsAndAnswers": [ # Optional. Contains user-, merchant-, and manufacturer-authored [questions and answers](https://support.google.com/merchants/answer/17085211) about the product. Max 30 question and answer pairs. Max 5000 characters total. Each question can have max 1000 characters. Each answer can have max 1000 characters. + { # The question and answer for the product. + "answer": "A String", # Required. The answer text. + "question": "A String", # Required. The question text. + }, + ], + "relatedProducts": [ # Optional. Specifies how other [products are related](https://support.google.com/merchants/answer/17085213) to this product. + { # Specifies how other products are related to this product. + "id": "A String", # Required. The identifier of the related product. + "idType": "A String", # Required. The type of the identifier of the related product. For example, [GTIN](https://support.google.com/merchants/answer/6219078) or [product ID](https://support.google.com/merchants/answer/6324405). + "relationshipType": "A String", # Required. The type of the relationship between this product and the related product. + }, + ], "returnPolicyLabel": "A String", # The return label of the product, used to group products in account-level return policies. Max. 100 characters. For more information, see [Return policy label](https://support.google.com/merchants/answer/9445425). "salePrice": { # The price represented as a number and currency. # Advertised sale price of the item. "amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros). @@ -1395,6 +1461,12 @@

Method Details

"unit": "A String", # The unit of the measure. "value": 3.14, # The measure of an item. }, + "variantOptions": [ # Optional. Contains the [list of all variant-identifying options](https://support.google.com/merchants/answer/17085214) of this product. + { # Additional product variants for the product. + "name": "A String", # Required. The name of the variant. For example, "Color", "Memory", "Size", "Length" + "value": "A String", # Required. The value of the variant. For example, "Red", "128GB", "XL", "100cm" + }, + ], "vehicleAllInPrice": { # The price represented as a number and currency. # The all-in advertised price for a vehicle, which includes costs for the following – any accessories attached to the vehicle, environmental levies, extra warranty, fuel, freight, pre-delivery inspection (PDI), dealer fees for handling licensing, provincial regulatory fees, miscellaneous dealer charges for security etching and nitrogen tire fill, and factory-to-customer or dealer-to-customer discounts or incentives. See the [Vehicle all-in price](https://support.google.com/google-ads/answer/14156981) for more information. "amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros). "currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217). @@ -1549,6 +1621,9 @@

Method Details

], "displayAdsTitle": "A String", # Title of an item for dynamic remarketing campaigns. "displayAdsValue": 3.14, # Offer margin for dynamic remarketing campaigns. For more information, see [Display ads attribute](https://support.google.com/merchants/answer/6069387). + "documentLinks": [ # Optional. Contains a list of PDF [document URLs](https://support.google.com/merchants/answer/17084656) for the product. Examples are training manuals, user guides, assembly instructions, package inserts, etc. Must start with "http://" or "https://"), ASCII characters only, and RFC 3986 compliant. + "A String", + ], "electricRange": { # The mileage of the vehicle. # The [electric range](https://support.google.com/google-ads/answer/15162232) of the vehicle in miles/kms. "unit": "A String", # The unit of the mileage. "value": "A String", # The distance value. @@ -1619,6 +1694,7 @@

Method Details

}, "isBundle": True or False, # Whether the item is a business-defined sub-API. A [sub-API] (https://support.google.com/merchants/answer/6324449) is a custom grouping of different products sold by a business for a single price. "itemGroupId": "A String", # Shared identifier for all variants of the same product. + "itemGroupTitle": "A String", # Optional. Represents the [title of the product group](https://support.google.com/merchants/answer/17085146) to which this variant product belongs. This can be used along with the [item group id](https://support.google.com/merchants/answer/6324507) attribute. It lets you perform better grouping of variant products, and helps identifying common product characteristics more efficiently. "lifestyleImageLinks": [ # Additional URLs of lifestyle images of the item, used to explicitly identify images that showcase your item in a real-world context. See the [Help Center article](https://support.google.com/merchants/answer/9103186) for more information. "A String", ], @@ -1692,6 +1768,7 @@

Method Details

}, "pickupMethod": "A String", # The [pickup](https://support.google.com/merchants/answer/14634021) option for the item. "pickupSla": "A String", # Item store pickup timeline. For more information, see [Pickup SLA](https://support.google.com/merchants/answer/14635400). + "popularityRank": 3.14, # Optional. Indicates the [popularity](https://support.google.com/merchants/answer/17085297) of the product in a merchant's inventory. Using a scale of 0.0 (lowest) to 100.0 (highest). "price": { # The price represented as a number and currency. # Price of the item. "amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros). "currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217). @@ -1728,6 +1805,19 @@

Method Details

"promotionIds": [ # The unique ID of a promotion. "A String", ], + "questionsAndAnswers": [ # Optional. Contains user-, merchant-, and manufacturer-authored [questions and answers](https://support.google.com/merchants/answer/17085211) about the product. Max 30 question and answer pairs. Max 5000 characters total. Each question can have max 1000 characters. Each answer can have max 1000 characters. + { # The question and answer for the product. + "answer": "A String", # Required. The answer text. + "question": "A String", # Required. The question text. + }, + ], + "relatedProducts": [ # Optional. Specifies how other [products are related](https://support.google.com/merchants/answer/17085213) to this product. + { # Specifies how other products are related to this product. + "id": "A String", # Required. The identifier of the related product. + "idType": "A String", # Required. The type of the identifier of the related product. For example, [GTIN](https://support.google.com/merchants/answer/6219078) or [product ID](https://support.google.com/merchants/answer/6324405). + "relationshipType": "A String", # Required. The type of the relationship between this product and the related product. + }, + ], "returnPolicyLabel": "A String", # The return label of the product, used to group products in account-level return policies. Max. 100 characters. For more information, see [Return policy label](https://support.google.com/merchants/answer/9445425). "salePrice": { # The price represented as a number and currency. # Advertised sale price of the item. "amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros). @@ -1834,6 +1924,12 @@

Method Details

"unit": "A String", # The unit of the measure. "value": 3.14, # The measure of an item. }, + "variantOptions": [ # Optional. Contains the [list of all variant-identifying options](https://support.google.com/merchants/answer/17085214) of this product. + { # Additional product variants for the product. + "name": "A String", # Required. The name of the variant. For example, "Color", "Memory", "Size", "Length" + "value": "A String", # Required. The value of the variant. For example, "Red", "128GB", "XL", "100cm" + }, + ], "vehicleAllInPrice": { # The price represented as a number and currency. # The all-in advertised price for a vehicle, which includes costs for the following – any accessories attached to the vehicle, environmental levies, extra warranty, fuel, freight, pre-delivery inspection (PDI), dealer fees for handling licensing, provincial regulatory fees, miscellaneous dealer charges for security etching and nitrogen tire fill, and factory-to-customer or dealer-to-customer discounts or incentives. See the [Vehicle all-in price](https://support.google.com/google-ads/answer/14156981) for more information. "amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros). "currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217). diff --git a/docs/dyn/merchantapi_products_v1.accounts.products.html b/docs/dyn/merchantapi_products_v1.accounts.products.html index 6104f57056..bc3e990ee2 100644 --- a/docs/dyn/merchantapi_products_v1.accounts.products.html +++ b/docs/dyn/merchantapi_products_v1.accounts.products.html @@ -233,6 +233,9 @@

Method Details

], "displayAdsTitle": "A String", # Title of an item for dynamic remarketing campaigns. "displayAdsValue": 3.14, # Offer margin for dynamic remarketing campaigns. For more information, see [Display ads attribute](https://support.google.com/merchants/answer/6069387). + "documentLinks": [ # Optional. Contains a list of PDF [document URLs](https://support.google.com/merchants/answer/17084656) for the product. Examples are training manuals, user guides, assembly instructions, package inserts, etc. Must start with "http://" or "https://"), ASCII characters only, and RFC 3986 compliant. + "A String", + ], "electricRange": { # The mileage of the vehicle. # The [electric range](https://support.google.com/google-ads/answer/15162232) of the vehicle in miles/kms. "unit": "A String", # The unit of the mileage. "value": "A String", # The distance value. @@ -303,6 +306,7 @@

Method Details

}, "isBundle": True or False, # Whether the item is a business-defined sub-API. A [sub-API] (https://support.google.com/merchants/answer/6324449) is a custom grouping of different products sold by a business for a single price. "itemGroupId": "A String", # Shared identifier for all variants of the same product. + "itemGroupTitle": "A String", # Optional. Represents the [title of the product group](https://support.google.com/merchants/answer/17085146) to which this variant product belongs. This can be used along with the [item group id](https://support.google.com/merchants/answer/6324507) attribute. It lets you perform better grouping of variant products, and helps identifying common product characteristics more efficiently. "lifestyleImageLinks": [ # Additional URLs of lifestyle images of the item, used to explicitly identify images that showcase your item in a real-world context. See the [Help Center article](https://support.google.com/merchants/answer/9103186) for more information. "A String", ], @@ -376,6 +380,7 @@

Method Details

}, "pickupMethod": "A String", # The [pickup](https://support.google.com/merchants/answer/14634021) option for the item. "pickupSla": "A String", # Item store pickup timeline. For more information, see [Pickup SLA](https://support.google.com/merchants/answer/14635400). + "popularityRank": 3.14, # Optional. Indicates the [popularity](https://support.google.com/merchants/answer/17085297) of the product in a merchant's inventory. Using a scale of 0.0 (lowest) to 100.0 (highest). "price": { # The price represented as a number and currency. # Price of the item. "amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros). "currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217). @@ -412,6 +417,19 @@

Method Details

"promotionIds": [ # The unique ID of a promotion. "A String", ], + "questionsAndAnswers": [ # Optional. Contains user-, merchant-, and manufacturer-authored [questions and answers](https://support.google.com/merchants/answer/17085211) about the product. Max 30 question and answer pairs. Max 5000 characters total. Each question can have max 1000 characters. Each answer can have max 1000 characters. + { # The question and answer for the product. + "answer": "A String", # Required. The answer text. + "question": "A String", # Required. The question text. + }, + ], + "relatedProducts": [ # Optional. Specifies how other [products are related](https://support.google.com/merchants/answer/17085213) to this product. + { # Specifies how other products are related to this product. + "id": "A String", # Required. The identifier of the related product. + "idType": "A String", # Required. The type of the identifier of the related product. For example, [GTIN](https://support.google.com/merchants/answer/6219078) or [product ID](https://support.google.com/merchants/answer/6324405). + "relationshipType": "A String", # Required. The type of the relationship between this product and the related product. + }, + ], "returnPolicyLabel": "A String", # The return label of the product, used to group products in account-level return policies. Max. 100 characters. For more information, see [Return policy label](https://support.google.com/merchants/answer/9445425). "salePrice": { # The price represented as a number and currency. # Advertised sale price of the item. "amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros). @@ -518,6 +536,12 @@

Method Details

"unit": "A String", # The unit of the measure. "value": 3.14, # The measure of an item. }, + "variantOptions": [ # Optional. Contains the [list of all variant-identifying options](https://support.google.com/merchants/answer/17085214) of this product. + { # Additional product variants for the product. + "name": "A String", # Required. The name of the variant. For example, "Color", "Memory", "Size", "Length" + "value": "A String", # Required. The value of the variant. For example, "Red", "128GB", "XL", "100cm" + }, + ], "vehicleAllInPrice": { # The price represented as a number and currency. # The all-in advertised price for a vehicle, which includes costs for the following – any accessories attached to the vehicle, environmental levies, extra warranty, fuel, freight, pre-delivery inspection (PDI), dealer fees for handling licensing, provincial regulatory fees, miscellaneous dealer charges for security etching and nitrogen tire fill, and factory-to-customer or dealer-to-customer discounts or incentives. See the [Vehicle all-in price](https://support.google.com/google-ads/answer/14156981) for more information. "amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros). "currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217). @@ -730,6 +754,9 @@

Method Details

], "displayAdsTitle": "A String", # Title of an item for dynamic remarketing campaigns. "displayAdsValue": 3.14, # Offer margin for dynamic remarketing campaigns. For more information, see [Display ads attribute](https://support.google.com/merchants/answer/6069387). + "documentLinks": [ # Optional. Contains a list of PDF [document URLs](https://support.google.com/merchants/answer/17084656) for the product. Examples are training manuals, user guides, assembly instructions, package inserts, etc. Must start with "http://" or "https://"), ASCII characters only, and RFC 3986 compliant. + "A String", + ], "electricRange": { # The mileage of the vehicle. # The [electric range](https://support.google.com/google-ads/answer/15162232) of the vehicle in miles/kms. "unit": "A String", # The unit of the mileage. "value": "A String", # The distance value. @@ -800,6 +827,7 @@

Method Details

}, "isBundle": True or False, # Whether the item is a business-defined sub-API. A [sub-API] (https://support.google.com/merchants/answer/6324449) is a custom grouping of different products sold by a business for a single price. "itemGroupId": "A String", # Shared identifier for all variants of the same product. + "itemGroupTitle": "A String", # Optional. Represents the [title of the product group](https://support.google.com/merchants/answer/17085146) to which this variant product belongs. This can be used along with the [item group id](https://support.google.com/merchants/answer/6324507) attribute. It lets you perform better grouping of variant products, and helps identifying common product characteristics more efficiently. "lifestyleImageLinks": [ # Additional URLs of lifestyle images of the item, used to explicitly identify images that showcase your item in a real-world context. See the [Help Center article](https://support.google.com/merchants/answer/9103186) for more information. "A String", ], @@ -873,6 +901,7 @@

Method Details

}, "pickupMethod": "A String", # The [pickup](https://support.google.com/merchants/answer/14634021) option for the item. "pickupSla": "A String", # Item store pickup timeline. For more information, see [Pickup SLA](https://support.google.com/merchants/answer/14635400). + "popularityRank": 3.14, # Optional. Indicates the [popularity](https://support.google.com/merchants/answer/17085297) of the product in a merchant's inventory. Using a scale of 0.0 (lowest) to 100.0 (highest). "price": { # The price represented as a number and currency. # Price of the item. "amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros). "currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217). @@ -909,6 +938,19 @@

Method Details

"promotionIds": [ # The unique ID of a promotion. "A String", ], + "questionsAndAnswers": [ # Optional. Contains user-, merchant-, and manufacturer-authored [questions and answers](https://support.google.com/merchants/answer/17085211) about the product. Max 30 question and answer pairs. Max 5000 characters total. Each question can have max 1000 characters. Each answer can have max 1000 characters. + { # The question and answer for the product. + "answer": "A String", # Required. The answer text. + "question": "A String", # Required. The question text. + }, + ], + "relatedProducts": [ # Optional. Specifies how other [products are related](https://support.google.com/merchants/answer/17085213) to this product. + { # Specifies how other products are related to this product. + "id": "A String", # Required. The identifier of the related product. + "idType": "A String", # Required. The type of the identifier of the related product. For example, [GTIN](https://support.google.com/merchants/answer/6219078) or [product ID](https://support.google.com/merchants/answer/6324405). + "relationshipType": "A String", # Required. The type of the relationship between this product and the related product. + }, + ], "returnPolicyLabel": "A String", # The return label of the product, used to group products in account-level return policies. Max. 100 characters. For more information, see [Return policy label](https://support.google.com/merchants/answer/9445425). "salePrice": { # The price represented as a number and currency. # Advertised sale price of the item. "amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros). @@ -1015,6 +1057,12 @@

Method Details

"unit": "A String", # The unit of the measure. "value": 3.14, # The measure of an item. }, + "variantOptions": [ # Optional. Contains the [list of all variant-identifying options](https://support.google.com/merchants/answer/17085214) of this product. + { # Additional product variants for the product. + "name": "A String", # Required. The name of the variant. For example, "Color", "Memory", "Size", "Length" + "value": "A String", # Required. The value of the variant. For example, "Red", "128GB", "XL", "100cm" + }, + ], "vehicleAllInPrice": { # The price represented as a number and currency. # The all-in advertised price for a vehicle, which includes costs for the following – any accessories attached to the vehicle, environmental levies, extra warranty, fuel, freight, pre-delivery inspection (PDI), dealer fees for handling licensing, provincial regulatory fees, miscellaneous dealer charges for security etching and nitrogen tire fill, and factory-to-customer or dealer-to-customer discounts or incentives. See the [Vehicle all-in price](https://support.google.com/google-ads/answer/14156981) for more information. "amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros). "currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217). diff --git a/docs/dyn/mybusinessverifications_v1.verificationTokens.html b/docs/dyn/mybusinessverifications_v1.verificationTokens.html index 243615dbf0..5968aca03a 100644 --- a/docs/dyn/mybusinessverifications_v1.verificationTokens.html +++ b/docs/dyn/mybusinessverifications_v1.verificationTokens.html @@ -95,26 +95,6 @@

Method Details

The object takes the form of: { # Request message for Verifications.GenerateInstantVerificationToken. - "locationData": { # The address and other details of the location to generate an instant verification token for. # Immutable. The address and other details of the location to generate an instant verification token for. - "address": { # Represents a postal address, such as for postal delivery or payments addresses. With a postal address, a postal service can deliver items to a premise, P.O. box, or similar. A postal address is not intended to model geographical locations like roads, towns, or mountains. In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # Immutable. A precise, accurate address to describe your business location. PO boxes or mailboxes located at remote locations are not acceptable. At this time, you can specify a maximum of five `address_lines` values in the address. - "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in `address_lines` do not have type information and may sometimes contain multiple values in a single field (for example, "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country or region of the address. In places where this can vary (for example, Japan), `address_language` is used to make it explicit (for example, "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). In this way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a `region_code` with all remaining information placed in the `address_lines`. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a `region_code` and `address_lines` and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas). - "A String", - ], - "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. For Spain, this is the province and not the autonomous community (for example, "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. For example, in Switzerland, this should be left unpopulated. - "languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if known). This is often the UI language of the input form or is expected to match one of the languages used in the address' country/region, or their transliterated equivalents. This can affect formatting in certain countries, but is not critical to the correctness of the data and will never affect any validation or other non-formatting related operations. If this value is not known, it should be omitted (rather than specifying a possibly incorrect default). Examples: "zh-Hant", "ja", "ja-Latn", "en". - "locality": "A String", # Optional. Generally refers to the city or town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave `locality` empty and use `address_lines`. - "organization": "A String", # Optional. The name of the organization at the address. - "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (for example, state or zip code validation in the United States). - "recipients": [ # Optional. The recipient at the address. This field may, under certain circumstances, contain multiline information. For example, it might contain "care of" information. - "A String", - ], - "regionCode": "A String", # Required. CLDR region code of the country/region of the address. This is never inferred and it is up to the user to ensure the value is correct. See https://cldr.unicode.org/ and https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: "CH" for Switzerland. - "revision": 42, # The schema revision of the `PostalAddress`. This must be set to 0, which is the latest revision. All new revisions **must** be backward compatible with old revisions. - "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (for example, "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (Côte d'Ivoire). - "sublocality": "A String", # Optional. Sublocality of the address. For example, this can be a neighborhood, borough, or district. - }, - "name": "A String", # Immutable. Name should reflect your business's real-world name, as used consistently on your storefront, website, and stationery, and as known to customers. Any additional information, when relevant, can be included in other fields of the resource (for example, `Address`, `Categories`). Don't add unnecessary information to your name (for example, prefer "Google" over "Google Inc. - Mountain View Corporate Headquarters"). Don't include marketing taglines, store codes, special characters, hours or closed/open status, phone numbers, website URLs, service/product information, location/address or directions, or containment information (for example, "Chase ATM in Duane Reade"). - }, "locationId": "A String", # The location identifier associated with an unverified listing. This is the location id generated at the time that the listing was originally created. It is the final portion of a location resource name as generated by the Google My Business API. Note: the caller must be an owner or manager of this listing in order to generate a verification token. See the [location resource](/my-business/reference/rest/v4/accounts.locations) documentation for more information. } diff --git a/docs/dyn/netapp_v1.projects.locations.backupVaults.backups.html b/docs/dyn/netapp_v1.projects.locations.backupVaults.backups.html index f30b014479..42105d155d 100644 --- a/docs/dyn/netapp_v1.projects.locations.backupVaults.backups.html +++ b/docs/dyn/netapp_v1.projects.locations.backupVaults.backups.html @@ -121,6 +121,11 @@

Method Details

"a_key": "A String", }, "name": "A String", # Identifier. The resource name of the backup. Format: `projects/{project_id}/locations/{location}/backupVaults/{backup_vault_id}/backups/{backup_id}`. + "ontapSource": { # Represents ONTAP source details. # Optional. Represents source details for ONTAP backups. Either source_volume or ontap_source should be provided. + "snapshotUuid": "A String", # Optional. The UUID of the ONTAP source snapshot. + "storagePool": "A String", # Required. Name of the storage pool. This must be specified for creating backups for ONTAP mode volumes. Format: `projects/{projects_id}/locations/{location}/storagePools/{storage_pool_id}` + "volumeUuid": "A String", # Required. The UUID of the ONTAP source volume. + }, "satisfiesPzi": True or False, # Output only. Reserved for future use "satisfiesPzs": True or False, # Output only. Reserved for future use "sourceSnapshot": "A String", # If specified, backup will be created from the given snapshot. If not specified, there will be a new snapshot taken to initiate the backup creation. Format: `projects/{project_id}/locations/{location}/volumes/{volume_id}/snapshots/{snapshot_id}` @@ -220,6 +225,11 @@

Method Details

"a_key": "A String", }, "name": "A String", # Identifier. The resource name of the backup. Format: `projects/{project_id}/locations/{location}/backupVaults/{backup_vault_id}/backups/{backup_id}`. + "ontapSource": { # Represents ONTAP source details. # Optional. Represents source details for ONTAP backups. Either source_volume or ontap_source should be provided. + "snapshotUuid": "A String", # Optional. The UUID of the ONTAP source snapshot. + "storagePool": "A String", # Required. Name of the storage pool. This must be specified for creating backups for ONTAP mode volumes. Format: `projects/{projects_id}/locations/{location}/storagePools/{storage_pool_id}` + "volumeUuid": "A String", # Required. The UUID of the ONTAP source volume. + }, "satisfiesPzi": True or False, # Output only. Reserved for future use "satisfiesPzs": True or False, # Output only. Reserved for future use "sourceSnapshot": "A String", # If specified, backup will be created from the given snapshot. If not specified, there will be a new snapshot taken to initiate the backup creation. Format: `projects/{project_id}/locations/{location}/volumes/{volume_id}/snapshots/{snapshot_id}` @@ -261,6 +271,11 @@

Method Details

"a_key": "A String", }, "name": "A String", # Identifier. The resource name of the backup. Format: `projects/{project_id}/locations/{location}/backupVaults/{backup_vault_id}/backups/{backup_id}`. + "ontapSource": { # Represents ONTAP source details. # Optional. Represents source details for ONTAP backups. Either source_volume or ontap_source should be provided. + "snapshotUuid": "A String", # Optional. The UUID of the ONTAP source snapshot. + "storagePool": "A String", # Required. Name of the storage pool. This must be specified for creating backups for ONTAP mode volumes. Format: `projects/{projects_id}/locations/{location}/storagePools/{storage_pool_id}` + "volumeUuid": "A String", # Required. The UUID of the ONTAP source volume. + }, "satisfiesPzi": True or False, # Output only. Reserved for future use "satisfiesPzs": True or False, # Output only. Reserved for future use "sourceSnapshot": "A String", # If specified, backup will be created from the given snapshot. If not specified, there will be a new snapshot taken to initiate the backup creation. Format: `projects/{project_id}/locations/{location}/volumes/{volume_id}/snapshots/{snapshot_id}` @@ -311,6 +326,11 @@

Method Details

"a_key": "A String", }, "name": "A String", # Identifier. The resource name of the backup. Format: `projects/{project_id}/locations/{location}/backupVaults/{backup_vault_id}/backups/{backup_id}`. + "ontapSource": { # Represents ONTAP source details. # Optional. Represents source details for ONTAP backups. Either source_volume or ontap_source should be provided. + "snapshotUuid": "A String", # Optional. The UUID of the ONTAP source snapshot. + "storagePool": "A String", # Required. Name of the storage pool. This must be specified for creating backups for ONTAP mode volumes. Format: `projects/{projects_id}/locations/{location}/storagePools/{storage_pool_id}` + "volumeUuid": "A String", # Required. The UUID of the ONTAP source volume. + }, "satisfiesPzi": True or False, # Output only. Reserved for future use "satisfiesPzs": True or False, # Output only. Reserved for future use "sourceSnapshot": "A String", # If specified, backup will be created from the given snapshot. If not specified, there will be a new snapshot taken to initiate the backup creation. Format: `projects/{project_id}/locations/{location}/volumes/{volume_id}/snapshots/{snapshot_id}` diff --git a/docs/dyn/netapp_v1.projects.locations.storagePools.backupConfigs.html b/docs/dyn/netapp_v1.projects.locations.storagePools.backupConfigs.html new file mode 100644 index 0000000000..0dd524d7c4 --- /dev/null +++ b/docs/dyn/netapp_v1.projects.locations.storagePools.backupConfigs.html @@ -0,0 +1,145 @@ + + + +

NetApp API . projects . locations . storagePools . backupConfigs

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

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

+

Lists backup configurations for all volumes in an ONTAP-mode Storage Pool.

+

+ list_next()

+

Retrieves the next page of results.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None) +
Lists backup configurations for all volumes in an ONTAP-mode Storage Pool.
+
+Args:
+  parent: string, Required. The ONTAP StoragePool for which to retrieve backup configuration information, in the format `projects/{project}/locations/{location}/storagePools/{storage_pool}`. (required)
+  filter: string, Optional. The standard list filter.
+  orderBy: string, Optional. Sort results. Supported values are "volume_id" or ""
+  pageSize: integer, Optional. The maximum number of items to return. The service may return fewer than this value. The maximum value is 1000; values above 1000 will be coerced to 1000. If unspecified or set to 0, a default of 50 will be used.
+  pageToken: string, Optional. The next_page_token value to use if there are additional results to retrieve for this list request.
+  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 BackupConfigs in an ONTAP StoragePool.
+  "nextPageToken": "A String", # The token you can use to retrieve the next page of results. Not returned if there are no more results in the list.
+  "unreachable": [ # Unordered list. Locations that could not be reached.
+    "A String",
+  ],
+  "volumeBackupConfigs": [ # A list of backup configurations for volumes in the pool.
+    { # Backup configuration for a volume in a pool.
+      "backupConfig": { # BackupConfig contains backup related config on a volume. # Backup configuration for the volume.
+        "backupChainBytes": "A String", # Output only. Total size of all backups in a chain in bytes = baseline backup size + sum(incremental backup size).
+        "backupPolicies": [ # Optional. When specified, schedule backups will be created based on the policy configuration.
+          "A String",
+        ],
+        "backupVault": "A String", # Optional. Name of backup vault. Format: projects/{project_id}/locations/{location}/backupVaults/{backup_vault_id}
+        "scheduledBackupEnabled": True or False, # Optional. When set to true, scheduled backup is enabled on the volume. This field should be nil when there's no backup policy attached.
+      },
+      "volumeUuid": "A String", # Provides the Ontap UUID of the volume within the pool.
+    },
+  ],
+}
+
+ +
+ 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/netapp_v1.projects.locations.storagePools.html b/docs/dyn/netapp_v1.projects.locations.storagePools.html index 5ebbee9605..ebfac2ff1f 100644 --- a/docs/dyn/netapp_v1.projects.locations.storagePools.html +++ b/docs/dyn/netapp_v1.projects.locations.storagePools.html @@ -74,6 +74,11 @@

NetApp API . projects . locations . storagePools

Instance Methods

+

+ backupConfigs() +

+

Returns the backupConfigs Resource.

+

ontap()

@@ -100,9 +105,15 @@

Instance Methods

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

Updates the storage pool properties with the full spec

+

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

+

Restores a backup to an ONTAP-mode volume.

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

This operation will switch the active/replica zone for a regional storagePool.

+

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

+

Updates the backup configuration for an ONTAP-mode volume.

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

ValidateDirectoryService does a connectivity check for a directory service policy attached to the storage pool.

@@ -437,6 +448,57 @@

Method Details

}
+
+ restoreVolume(name, body=None, x__xgafv=None) +
Restores a backup to an ONTAP-mode volume.
+
+Args:
+  name: string, Required. The resource name of the ONTAP mode storage pool, in the format of `projects/{project}/locations/{location}/storagePools/{storage_pool}` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for `RestoreVolume` API.
+  "backupSource": { # Represents the backup source of the restore operation. # The backup source of the restore operation.
+    "backup": "A String", # Required. The backup resource name.
+    "fileList": [ # Optional. List of files to be restored in the form of their absolute path as in source volume. If provided, only these files will be restored. If not provided, the entire backup will be restored (Full Backup Restore)
+      "A String",
+    ],
+  },
+  "ontapVolumeTarget": { # Represents the ONTAP volume target of the restore operation. # The ONTAP volume target of the restore operation.
+    "restoreDestinationPath": "A String", # Optional. Absolute directory path in the destination volume.
+    "volumeUuid": "A String", # Required. The UUID of the ONTAP volume to restore to.
+  },
+}
+
+  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.
+  },
+}
+
+
switch(name, body=None, x__xgafv=None)
This operation will switch the active/replica zone for a regional storagePool.
@@ -478,6 +540,57 @@ 

Method Details

}
+
+ updateBackupConfig(name, body=None, x__xgafv=None) +
Updates the backup configuration for an ONTAP-mode volume.
+
+Args:
+  name: string, Required. The resource name of the StoragePool, in the format: projects/{projectNumber}/locations/{locationId}/storagePools/{poolId} (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for UpdateBackupConfig
+  "backupConfig": { # BackupConfig contains backup related config on a volume. # Required. Backup configuration to apply.
+    "backupChainBytes": "A String", # Output only. Total size of all backups in a chain in bytes = baseline backup size + sum(incremental backup size).
+    "backupPolicies": [ # Optional. When specified, schedule backups will be created based on the policy configuration.
+      "A String",
+    ],
+    "backupVault": "A String", # Optional. Name of backup vault. Format: projects/{project_id}/locations/{location}/backupVaults/{backup_vault_id}
+    "scheduledBackupEnabled": True or False, # Optional. When set to true, scheduled backup is enabled on the volume. This field should be nil when there's no backup policy attached.
+  },
+  "updateMask": "A String", # Required. Field mask is used to specify the fields to be overwritten in the BackupConfig for the Volume. 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.
+  "volumeUuid": "A String", # Required. The UUID of the ONTAP-mode volume.
+}
+
+  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.
+  },
+}
+
+
validateDirectoryService(name, body=None, x__xgafv=None)
ValidateDirectoryService does a connectivity check for a directory service policy attached to the storage pool.
diff --git a/docs/dyn/networkmanagement_v1.projects.locations.global_.connectivityTests.html b/docs/dyn/networkmanagement_v1.projects.locations.global_.connectivityTests.html
index 4121bc36b5..cdccde5ea2 100644
--- a/docs/dyn/networkmanagement_v1.projects.locations.global_.connectivityTests.html
+++ b/docs/dyn/networkmanagement_v1.projects.locations.global_.connectivityTests.html
@@ -264,6 +264,11 @@ 

Method Details

"uri": "A String", # URI of a Cloud Function. "versionId": "A String", # Latest successfully deployed version id of the Cloud Function. }, + "cloudRunJob": { # For display only. Metadata associated with a Cloud Run job. # Display information of a Cloud Run job. + "displayName": "A String", # Name of a Cloud Run job. + "location": "A String", # Location in which this job is deployed. + "uri": "A String", # URI of a Cloud Run job. + }, "cloudRunRevision": { # For display only. Metadata associated with a Cloud Run revision. # Display information of a Cloud Run revision. "displayName": "A String", # Name of a Cloud Run revision. "location": "A String", # Location in which this revision is deployed. @@ -625,6 +630,11 @@

Method Details

"uri": "A String", # URI of a Cloud Function. "versionId": "A String", # Latest successfully deployed version id of the Cloud Function. }, + "cloudRunJob": { # For display only. Metadata associated with a Cloud Run job. # Display information of a Cloud Run job. + "displayName": "A String", # Name of a Cloud Run job. + "location": "A String", # Location in which this job is deployed. + "uri": "A String", # URI of a Cloud Run job. + }, "cloudRunRevision": { # For display only. Metadata associated with a Cloud Run revision. # Display information of a Cloud Run revision. "displayName": "A String", # Name of a Cloud Run revision. "location": "A String", # Location in which this revision is deployed. @@ -1189,6 +1199,11 @@

Method Details

"uri": "A String", # URI of a Cloud Function. "versionId": "A String", # Latest successfully deployed version id of the Cloud Function. }, + "cloudRunJob": { # For display only. Metadata associated with a Cloud Run job. # Display information of a Cloud Run job. + "displayName": "A String", # Name of a Cloud Run job. + "location": "A String", # Location in which this job is deployed. + "uri": "A String", # URI of a Cloud Run job. + }, "cloudRunRevision": { # For display only. Metadata associated with a Cloud Run revision. # Display information of a Cloud Run revision. "displayName": "A String", # Name of a Cloud Run revision. "location": "A String", # Location in which this revision is deployed. @@ -1550,6 +1565,11 @@

Method Details

"uri": "A String", # URI of a Cloud Function. "versionId": "A String", # Latest successfully deployed version id of the Cloud Function. }, + "cloudRunJob": { # For display only. Metadata associated with a Cloud Run job. # Display information of a Cloud Run job. + "displayName": "A String", # Name of a Cloud Run job. + "location": "A String", # Location in which this job is deployed. + "uri": "A String", # URI of a Cloud Run job. + }, "cloudRunRevision": { # For display only. Metadata associated with a Cloud Run revision. # Display information of a Cloud Run revision. "displayName": "A String", # Name of a Cloud Run revision. "location": "A String", # Location in which this revision is deployed. @@ -2105,6 +2125,11 @@

Method Details

"uri": "A String", # URI of a Cloud Function. "versionId": "A String", # Latest successfully deployed version id of the Cloud Function. }, + "cloudRunJob": { # For display only. Metadata associated with a Cloud Run job. # Display information of a Cloud Run job. + "displayName": "A String", # Name of a Cloud Run job. + "location": "A String", # Location in which this job is deployed. + "uri": "A String", # URI of a Cloud Run job. + }, "cloudRunRevision": { # For display only. Metadata associated with a Cloud Run revision. # Display information of a Cloud Run revision. "displayName": "A String", # Name of a Cloud Run revision. "location": "A String", # Location in which this revision is deployed. @@ -2466,6 +2491,11 @@

Method Details

"uri": "A String", # URI of a Cloud Function. "versionId": "A String", # Latest successfully deployed version id of the Cloud Function. }, + "cloudRunJob": { # For display only. Metadata associated with a Cloud Run job. # Display information of a Cloud Run job. + "displayName": "A String", # Name of a Cloud Run job. + "location": "A String", # Location in which this job is deployed. + "uri": "A String", # URI of a Cloud Run job. + }, "cloudRunRevision": { # For display only. Metadata associated with a Cloud Run revision. # Display information of a Cloud Run revision. "displayName": "A String", # Name of a Cloud Run revision. "location": "A String", # Location in which this revision is deployed. @@ -2980,6 +3010,11 @@

Method Details

"uri": "A String", # URI of a Cloud Function. "versionId": "A String", # Latest successfully deployed version id of the Cloud Function. }, + "cloudRunJob": { # For display only. Metadata associated with a Cloud Run job. # Display information of a Cloud Run job. + "displayName": "A String", # Name of a Cloud Run job. + "location": "A String", # Location in which this job is deployed. + "uri": "A String", # URI of a Cloud Run job. + }, "cloudRunRevision": { # For display only. Metadata associated with a Cloud Run revision. # Display information of a Cloud Run revision. "displayName": "A String", # Name of a Cloud Run revision. "location": "A String", # Location in which this revision is deployed. @@ -3341,6 +3376,11 @@

Method Details

"uri": "A String", # URI of a Cloud Function. "versionId": "A String", # Latest successfully deployed version id of the Cloud Function. }, + "cloudRunJob": { # For display only. Metadata associated with a Cloud Run job. # Display information of a Cloud Run job. + "displayName": "A String", # Name of a Cloud Run job. + "location": "A String", # Location in which this job is deployed. + "uri": "A String", # URI of a Cloud Run job. + }, "cloudRunRevision": { # For display only. Metadata associated with a Cloud Run revision. # Display information of a Cloud Run revision. "displayName": "A String", # Name of a Cloud Run revision. "location": "A String", # Location in which this revision is deployed. diff --git a/docs/dyn/networkmanagement_v1.projects.locations.html b/docs/dyn/networkmanagement_v1.projects.locations.html index 3a7f4cfad7..c3c8b0ca12 100644 --- a/docs/dyn/networkmanagement_v1.projects.locations.html +++ b/docs/dyn/networkmanagement_v1.projects.locations.html @@ -79,6 +79,11 @@

Instance Methods

Returns the global_ Resource.

+

+ networkMonitoringProviders() +

+

Returns the networkMonitoringProviders Resource.

+

vpcFlowLogsConfigs()

diff --git a/docs/dyn/networkmanagement_v1.projects.locations.networkMonitoringProviders.html b/docs/dyn/networkmanagement_v1.projects.locations.networkMonitoringProviders.html index 24508b7fbc..686a1aa1d6 100644 --- a/docs/dyn/networkmanagement_v1.projects.locations.networkMonitoringProviders.html +++ b/docs/dyn/networkmanagement_v1.projects.locations.networkMonitoringProviders.html @@ -96,8 +96,14 @@

Instance Methods

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

Creates a NetworkMonitoringProvider resource.

- delete(name, x__xgafv=None)

+ delete(name, force=None, x__xgafv=None)

Deletes a NetworkMonitoringProvider resource and all of its child resources.

+

+ generateMonitoringPointConfig(name, privateConnectivityEnabled=None, x__xgafv=None)

+

Generates Monitoring Point configuration of a NetworkMonitoringProvider resource.

+

+ generateProviderAccessToken(name, gcpAccessToken=None, x__xgafv=None)

+

Generates a provider access token for a given Google access token. Provider access token is a short-lived token that is used to access resources in the provider's platform.

get(name, x__xgafv=None)

Gets the NetworkMonitoringProvider resource.

@@ -165,11 +171,12 @@

Method Details

- delete(name, x__xgafv=None) + delete(name, force=None, x__xgafv=None)
Deletes a NetworkMonitoringProvider resource and all of its child resources.
 
 Args:
   name: string, Required. Name of the resource. Format: projects/{project}/locations/{location}/networkMonitoringProviders/{network_monitoring_provider} (required)
+  force: boolean, Optional. If set to true, any nested MonitoringPoints, NetworkPaths and WebPaths resources from this NetworkMonitoringProvider will also be deleted. Otherwise, the request will only work if there are no nested resources.
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -199,6 +206,48 @@ 

Method Details

}
+
+ generateMonitoringPointConfig(name, privateConnectivityEnabled=None, x__xgafv=None) +
Generates Monitoring Point configuration of a NetworkMonitoringProvider resource.
+
+Args:
+  name: string, Required. Name of the resource. Format: projects/{project}/locations/{location}/networkMonitoringProviders/{network_monitoring_provider} (required)
+  privateConnectivityEnabled: boolean, Optional. For Google Cloud MPs, this field indicates whether the Monitoring Point is deployed in a Private Service Connect deployment. Not used for non-Google Cloud MPs.
+  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 for getting Monitoring Point configuration of a NetworkMonitoringProvider resource.
+  "config": { # The Monitoring Point configuration of the provider in JSON format.
+    "a_key": "", # Properties of the object.
+  },
+}
+
+ +
+ generateProviderAccessToken(name, gcpAccessToken=None, x__xgafv=None) +
Generates a provider access token for a given Google access token. Provider access token is a short-lived token that is used to access resources in the provider's platform.
+
+Args:
+  name: string, Required. Name of the resource. Format: projects/{project}/locations/{location}/networkMonitoringProviders/{network_monitoring_provider} (required)
+  gcpAccessToken: string, Required. Google access 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 for generating an access token for a NetworkMonitoringProvider resource.
+  "providerAccessToken": "A String", # Provider access token for the NetworkMonitoringProvider resource.
+}
+
+
get(name, x__xgafv=None)
Gets the NetworkMonitoringProvider resource.
diff --git a/docs/dyn/networkmanagement_v1.projects.locations.networkMonitoringProviders.monitoringPoints.html b/docs/dyn/networkmanagement_v1.projects.locations.networkMonitoringProviders.monitoringPoints.html
index dde84031dc..92c220c9af 100644
--- a/docs/dyn/networkmanagement_v1.projects.locations.networkMonitoringProviders.monitoringPoints.html
+++ b/docs/dyn/networkmanagement_v1.projects.locations.networkMonitoringProviders.monitoringPoints.html
@@ -77,6 +77,15 @@ 

Instance Methods

close()

Close httplib2 connections.

+

+ downloadInstallScript(parent, hostname=None, monitoringPointType=None, ntpServerAddress=None, ntpServerSecondaryAddress=None, privateConnectivityEnabled=None, staticIpAddress_dnsServerAddress=None, staticIpAddress_dnsServerSecondaryAddress=None, staticIpAddress_domain=None, staticIpAddress_gatewayAddress=None, staticIpAddress_ipAddress=None, staticIpAddress_netmask=None, timeZone_id=None, timeZone_version=None, useDhcp=None, x__xgafv=None, x_password=None)

+

Downloads an install script for MonitoringPoints for a given network monitoring provider.

+

+ downloadRecreateInstallScript(name, hostname=None, x__xgafv=None)

+

Downloads an install script for a specific Container MonitoringPoint.

+

+ downloadServerConnectConfig(parent, x__xgafv=None)

+

Downloads the server connect configuration for a given network monitoring provider.

get(name, x__xgafv=None)

Gets the MonitoringPoint resource.

@@ -92,6 +101,105 @@

Method Details

Close httplib2 connections.
+
+ downloadInstallScript(parent, hostname=None, monitoringPointType=None, ntpServerAddress=None, ntpServerSecondaryAddress=None, privateConnectivityEnabled=None, staticIpAddress_dnsServerAddress=None, staticIpAddress_dnsServerSecondaryAddress=None, staticIpAddress_domain=None, staticIpAddress_gatewayAddress=None, staticIpAddress_ipAddress=None, staticIpAddress_netmask=None, timeZone_id=None, timeZone_version=None, useDhcp=None, x__xgafv=None, x_password=None) +
Downloads an install script for MonitoringPoints for a given network monitoring provider.
+
+Args:
+  parent: string, Required. Parent value for DownloadInstallScriptRequest. Format: projects/{project}/locations/{location}/networkMonitoringProviders/{network_monitoring_provider} (required)
+  hostname: string, Required. The hostname of the MonitoringPoint, e.g. "test-vm"
+  monitoringPointType: string, Required. The type of the monitoring point.
+    Allowed values
+      MONITORING_POINT_TYPE_UNSPECIFIED - This value should not be used.
+      CONTAINER - Monitoring Point that runs in a Docker container.
+      KVM - Monitoring Point that runs in a Kernel-based Virtual Machine (KVM) hypervisor.
+      VMWARE - Monitoring Point that runs in a VMware hypervisor.
+      HELM - Monitoring Point that runs on a K8S Helm.
+      GCE_VM - Monitoring Point that runs as a startup script in a Compute Engine VM.
+      AZURE_VM - Monitoring Point that runs as a startup script in an Azure VM.
+  ntpServerAddress: string, Optional. Network Time Protocol a user can configure. If the user omits the field, the default is either NTP servers provided in the DHCP lease or a set of well-known NTP servers pre-configured on the monitoring point. This field can be an IP address or FQDN.
+  ntpServerSecondaryAddress: string, Optional. Second NTP server.
+  privateConnectivityEnabled: boolean, Optional. For Google Cloud MPs, this field indicates whether the Monitoring Point is deployed in a Private Service Connect deployment. Not used for non-Google Cloud MPs.
+  staticIpAddress_dnsServerAddress: string, Required. DNS server.
+  staticIpAddress_dnsServerSecondaryAddress: string, Optional. Second DNS server.
+  staticIpAddress_domain: string, Optional. Domain name of the MonitoringPoint.
+  staticIpAddress_gatewayAddress: string, Required. Gateway IP address. Example: "100.80.40.1".
+  staticIpAddress_ipAddress: string, Required. IP address of the MonitoringPoint.
+  staticIpAddress_netmask: string, Optional. Networkmask and CIDR range. Example: "255.255.255.0/24"
+  timeZone_id: string, IANA Time Zone Database time zone. For example "America/New_York".
+  timeZone_version: string, Optional. IANA Time Zone Database version number. For example "2019a".
+  useDhcp: boolean, Optional. Dynamic Host Configuration Protocol, is a network management protocol that automatically assigns IP addresses and other network configuration parameters to devices connecting to a network.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+  x_password: string, Optional. Password for logging into the MonitoringPoint.
+
+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.
+    },
+  ],
+}
+
+ +
+ downloadRecreateInstallScript(name, hostname=None, x__xgafv=None) +
Downloads an install script for a specific Container MonitoringPoint.
+
+Args:
+  name: string, Required. Resource name of the MonitoringPoint. Format: projects/{project}/locations/{location}/networkMonitoringProviders/{network_monitoring_provider}/monitoringPoints/{monitoring_point} (required)
+  hostname: string, Optional. The hostname of the MonitoringPoint, e.g. "test-vm"
+  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.
+    },
+  ],
+}
+
+ +
+ downloadServerConnectConfig(parent, x__xgafv=None) +
Downloads the server connect configuration for a given network monitoring provider.
+
+Args:
+  parent: string, Required. Parent value for DownloadServerConnectConfigRequest. Format: projects/{project}/locations/{location}/networkMonitoringProviders/{network_monitoring_provider} (required)
+  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.
+    },
+  ],
+}
+
+
get(name, x__xgafv=None)
Gets the MonitoringPoint resource.
@@ -110,14 +218,16 @@ 

Method Details

"autoGeoLocationEnabled": True or False, # Output only. Indicates if automaitic geographic location is enabled for the MonitoringPoint. "connectionStatus": "A String", # Output only. Connection status of the MonitoringPoint. "createTime": "A String", # Output only. The time the MonitoringPoint was created. + "deploymentType": "A String", # Output only. The deployment type of the MonitoringPoint. "displayName": "A String", # Output only. Display name of the MonitoringPoint. "errors": [ # Output only. The codes of errors detected in the MonitoringPoint. "A String", ], - "geoLocation": { # The geographical location of the MonitoringPoint. # Output only. The geographical location of the MonitoringPoint. ; - "country": "A String", # Country. + "geoLocation": { # The geographical location of the MonitoringPoint. # Output only. The geographical location of the MonitoringPoint. "formattedAddress": "A String", # Formatted address. + "regionCode": "A String", # Unicode CLDR region code. }, + "guid": "A String", # Output only. The GUID of the MonitoringPoint. "host": { # Message describing information about the host. # Output only. The host information of the MonitoringPoint. "cloudInstanceId": "A String", # Output only. The cloud instance id of the host. "cloudProjectId": "A String", # Output only. The cloud project id of the host. @@ -126,7 +236,6 @@

Method Details

"cloudVirtualNetworkIds": [ # Output only. The ids of cloud virtual networks of the host. "A String", ], - "cloudVpcId": "A String", # Output only. The id of Virtual Private Cloud (VPC) of the host. "cloudZone": "A String", # Output only. The cloud zone of the host. "os": "A String", # Output only. The operating system of the host. }, @@ -181,14 +290,16 @@

Method Details

"autoGeoLocationEnabled": True or False, # Output only. Indicates if automaitic geographic location is enabled for the MonitoringPoint. "connectionStatus": "A String", # Output only. Connection status of the MonitoringPoint. "createTime": "A String", # Output only. The time the MonitoringPoint was created. + "deploymentType": "A String", # Output only. The deployment type of the MonitoringPoint. "displayName": "A String", # Output only. Display name of the MonitoringPoint. "errors": [ # Output only. The codes of errors detected in the MonitoringPoint. "A String", ], - "geoLocation": { # The geographical location of the MonitoringPoint. # Output only. The geographical location of the MonitoringPoint. ; - "country": "A String", # Country. + "geoLocation": { # The geographical location of the MonitoringPoint. # Output only. The geographical location of the MonitoringPoint. "formattedAddress": "A String", # Formatted address. + "regionCode": "A String", # Unicode CLDR region code. }, + "guid": "A String", # Output only. The GUID of the MonitoringPoint. "host": { # Message describing information about the host. # Output only. The host information of the MonitoringPoint. "cloudInstanceId": "A String", # Output only. The cloud instance id of the host. "cloudProjectId": "A String", # Output only. The cloud project id of the host. @@ -197,7 +308,6 @@

Method Details

"cloudVirtualNetworkIds": [ # Output only. The ids of cloud virtual networks of the host. "A String", ], - "cloudVpcId": "A String", # Output only. The id of Virtual Private Cloud (VPC) of the host. "cloudZone": "A String", # Output only. The cloud zone of the host. "os": "A String", # Output only. The operating system of the host. }, diff --git a/docs/dyn/networkmanagement_v1.projects.locations.networkMonitoringProviders.networkPaths.html b/docs/dyn/networkmanagement_v1.projects.locations.networkMonitoringProviders.networkPaths.html index 2739ae15e1..529862fe16 100644 --- a/docs/dyn/networkmanagement_v1.projects.locations.networkMonitoringProviders.networkPaths.html +++ b/docs/dyn/networkmanagement_v1.projects.locations.networkMonitoringProviders.networkPaths.html @@ -109,10 +109,11 @@

Method Details

{ # Message describing NetworkPath resource. "createTime": "A String", # Output only. The time the NetworkPath was created. "destination": "A String", # Output only. IP address or hostname of the network path destination. - "destinationGeoLocation": { # The geographical location of the MonitoringPoint. # Output only. Geographical location of the destination MonitoringPoint. ; - "country": "A String", # Country. + "destinationGeoLocation": { # The geographical location of the MonitoringPoint. # Output only. Geographical location of the destination MonitoringPoint. "formattedAddress": "A String", # Formatted address. + "regionCode": "A String", # Unicode CLDR region code. }, + "destinationMonitoringPointId": "A String", # Output only. Provider's UUID of the destination MonitoringPoint. This id may not point to a resource in the Google Cloud. "displayName": "A String", # Output only. The display name of the network path. "dualEnded": True or False, # Output only. Indicates if the network path is dual ended. When true, the network path is measured both: from both source to destination, and from destination to source. When false, the network path is measured from the source through the destination back to the source (round trip measurement). "monitoringEnabled": True or False, # Output only. Is monitoring enabled for the network path. @@ -129,7 +130,7 @@

Method Details

}, ], "providerUiUri": "A String", # Output only. Link to provider's UI; link shows the NetworkPath. - "sourceMonitoringPointId": "A String", # Output only. Provider's UUID of the source MonitoringPoint. This id may not point to a resource in the GCP. + "sourceMonitoringPointId": "A String", # Output only. Provider's UUID of the source MonitoringPoint. This id may not point to a resource in the Google Cloud. "updateTime": "A String", # Output only. The time the NetworkPath was updated. }
@@ -155,10 +156,11 @@

Method Details

{ # Message describing NetworkPath resource. "createTime": "A String", # Output only. The time the NetworkPath was created. "destination": "A String", # Output only. IP address or hostname of the network path destination. - "destinationGeoLocation": { # The geographical location of the MonitoringPoint. # Output only. Geographical location of the destination MonitoringPoint. ; - "country": "A String", # Country. + "destinationGeoLocation": { # The geographical location of the MonitoringPoint. # Output only. Geographical location of the destination MonitoringPoint. "formattedAddress": "A String", # Formatted address. + "regionCode": "A String", # Unicode CLDR region code. }, + "destinationMonitoringPointId": "A String", # Output only. Provider's UUID of the destination MonitoringPoint. This id may not point to a resource in the Google Cloud. "displayName": "A String", # Output only. The display name of the network path. "dualEnded": True or False, # Output only. Indicates if the network path is dual ended. When true, the network path is measured both: from both source to destination, and from destination to source. When false, the network path is measured from the source through the destination back to the source (round trip measurement). "monitoringEnabled": True or False, # Output only. Is monitoring enabled for the network path. @@ -175,7 +177,7 @@

Method Details

}, ], "providerUiUri": "A String", # Output only. Link to provider's UI; link shows the NetworkPath. - "sourceMonitoringPointId": "A String", # Output only. Provider's UUID of the source MonitoringPoint. This id may not point to a resource in the GCP. + "sourceMonitoringPointId": "A String", # Output only. Provider's UUID of the source MonitoringPoint. This id may not point to a resource in the Google Cloud. "updateTime": "A String", # Output only. The time the NetworkPath was updated. }, ], diff --git a/docs/dyn/networkmanagement_v1.projects.locations.networkMonitoringProviders.webPaths.html b/docs/dyn/networkmanagement_v1.projects.locations.networkMonitoringProviders.webPaths.html index 80cd387184..fd96cd1422 100644 --- a/docs/dyn/networkmanagement_v1.projects.locations.networkMonitoringProviders.webPaths.html +++ b/docs/dyn/networkmanagement_v1.projects.locations.networkMonitoringProviders.webPaths.html @@ -109,6 +109,10 @@

Method Details

{ # Message describing WebPath resource. "createTime": "A String", # Output only. The time the WebPath was created. "destination": "A String", # Output only. Web monitoring target. + "destinationGeoLocation": { # The geographical location of the MonitoringPoint. # Output only. Geographical location of the destination. + "formattedAddress": "A String", # Formatted address. + "regionCode": "A String", # Unicode CLDR region code. + }, "displayName": "A String", # Output only. Display name of the WebPath. "interval": "A String", # Output only. Monitoring interval. "monitoringEnabled": True or False, # Output only. Is monitoring enabled for the WebPath. @@ -153,6 +157,10 @@

Method Details

{ # Message describing WebPath resource. "createTime": "A String", # Output only. The time the WebPath was created. "destination": "A String", # Output only. Web monitoring target. + "destinationGeoLocation": { # The geographical location of the MonitoringPoint. # Output only. Geographical location of the destination. + "formattedAddress": "A String", # Formatted address. + "regionCode": "A String", # Unicode CLDR region code. + }, "displayName": "A String", # Output only. Display name of the WebPath. "interval": "A String", # Output only. Monitoring interval. "monitoringEnabled": True or False, # Output only. Is monitoring enabled for the WebPath. diff --git a/docs/dyn/networkmanagement_v1beta1.projects.locations.global_.connectivityTests.html b/docs/dyn/networkmanagement_v1beta1.projects.locations.global_.connectivityTests.html index 901ded0f1c..7818f06d57 100644 --- a/docs/dyn/networkmanagement_v1beta1.projects.locations.global_.connectivityTests.html +++ b/docs/dyn/networkmanagement_v1beta1.projects.locations.global_.connectivityTests.html @@ -267,6 +267,11 @@

Method Details

"uri": "A String", # URI of a Cloud Function. "versionId": "A String", # Latest successfully deployed version id of the Cloud Function. }, + "cloudRunJob": { # For display only. Metadata associated with a Cloud Run job. # Display information of a Cloud Run job. + "displayName": "A String", # Name of a Cloud Run job. + "location": "A String", # Location in which this job is deployed. + "uri": "A String", # URI of a Cloud Run job. + }, "cloudRunRevision": { # For display only. Metadata associated with a Cloud Run revision. # Display information of a Cloud Run revision. "displayName": "A String", # Name of a Cloud Run revision. "location": "A String", # Location in which this revision is deployed. @@ -628,6 +633,11 @@

Method Details

"uri": "A String", # URI of a Cloud Function. "versionId": "A String", # Latest successfully deployed version id of the Cloud Function. }, + "cloudRunJob": { # For display only. Metadata associated with a Cloud Run job. # Display information of a Cloud Run job. + "displayName": "A String", # Name of a Cloud Run job. + "location": "A String", # Location in which this job is deployed. + "uri": "A String", # URI of a Cloud Run job. + }, "cloudRunRevision": { # For display only. Metadata associated with a Cloud Run revision. # Display information of a Cloud Run revision. "displayName": "A String", # Name of a Cloud Run revision. "location": "A String", # Location in which this revision is deployed. @@ -1198,6 +1208,11 @@

Method Details

"uri": "A String", # URI of a Cloud Function. "versionId": "A String", # Latest successfully deployed version id of the Cloud Function. }, + "cloudRunJob": { # For display only. Metadata associated with a Cloud Run job. # Display information of a Cloud Run job. + "displayName": "A String", # Name of a Cloud Run job. + "location": "A String", # Location in which this job is deployed. + "uri": "A String", # URI of a Cloud Run job. + }, "cloudRunRevision": { # For display only. Metadata associated with a Cloud Run revision. # Display information of a Cloud Run revision. "displayName": "A String", # Name of a Cloud Run revision. "location": "A String", # Location in which this revision is deployed. @@ -1559,6 +1574,11 @@

Method Details

"uri": "A String", # URI of a Cloud Function. "versionId": "A String", # Latest successfully deployed version id of the Cloud Function. }, + "cloudRunJob": { # For display only. Metadata associated with a Cloud Run job. # Display information of a Cloud Run job. + "displayName": "A String", # Name of a Cloud Run job. + "location": "A String", # Location in which this job is deployed. + "uri": "A String", # URI of a Cloud Run job. + }, "cloudRunRevision": { # For display only. Metadata associated with a Cloud Run revision. # Display information of a Cloud Run revision. "displayName": "A String", # Name of a Cloud Run revision. "location": "A String", # Location in which this revision is deployed. @@ -2120,6 +2140,11 @@

Method Details

"uri": "A String", # URI of a Cloud Function. "versionId": "A String", # Latest successfully deployed version id of the Cloud Function. }, + "cloudRunJob": { # For display only. Metadata associated with a Cloud Run job. # Display information of a Cloud Run job. + "displayName": "A String", # Name of a Cloud Run job. + "location": "A String", # Location in which this job is deployed. + "uri": "A String", # URI of a Cloud Run job. + }, "cloudRunRevision": { # For display only. Metadata associated with a Cloud Run revision. # Display information of a Cloud Run revision. "displayName": "A String", # Name of a Cloud Run revision. "location": "A String", # Location in which this revision is deployed. @@ -2481,6 +2506,11 @@

Method Details

"uri": "A String", # URI of a Cloud Function. "versionId": "A String", # Latest successfully deployed version id of the Cloud Function. }, + "cloudRunJob": { # For display only. Metadata associated with a Cloud Run job. # Display information of a Cloud Run job. + "displayName": "A String", # Name of a Cloud Run job. + "location": "A String", # Location in which this job is deployed. + "uri": "A String", # URI of a Cloud Run job. + }, "cloudRunRevision": { # For display only. Metadata associated with a Cloud Run revision. # Display information of a Cloud Run revision. "displayName": "A String", # Name of a Cloud Run revision. "location": "A String", # Location in which this revision is deployed. @@ -3001,6 +3031,11 @@

Method Details

"uri": "A String", # URI of a Cloud Function. "versionId": "A String", # Latest successfully deployed version id of the Cloud Function. }, + "cloudRunJob": { # For display only. Metadata associated with a Cloud Run job. # Display information of a Cloud Run job. + "displayName": "A String", # Name of a Cloud Run job. + "location": "A String", # Location in which this job is deployed. + "uri": "A String", # URI of a Cloud Run job. + }, "cloudRunRevision": { # For display only. Metadata associated with a Cloud Run revision. # Display information of a Cloud Run revision. "displayName": "A String", # Name of a Cloud Run revision. "location": "A String", # Location in which this revision is deployed. @@ -3362,6 +3397,11 @@

Method Details

"uri": "A String", # URI of a Cloud Function. "versionId": "A String", # Latest successfully deployed version id of the Cloud Function. }, + "cloudRunJob": { # For display only. Metadata associated with a Cloud Run job. # Display information of a Cloud Run job. + "displayName": "A String", # Name of a Cloud Run job. + "location": "A String", # Location in which this job is deployed. + "uri": "A String", # URI of a Cloud Run job. + }, "cloudRunRevision": { # For display only. Metadata associated with a Cloud Run revision. # Display information of a Cloud Run revision. "displayName": "A String", # Name of a Cloud Run revision. "location": "A String", # Location in which this revision is deployed. diff --git a/docs/dyn/networksecurity_v1.organizations.locations.addressGroups.html b/docs/dyn/networksecurity_v1.organizations.locations.addressGroups.html index 6681614be1..6dd4b2e50d 100644 --- a/docs/dyn/networksecurity_v1.organizations.locations.addressGroups.html +++ b/docs/dyn/networksecurity_v1.organizations.locations.addressGroups.html @@ -110,6 +110,9 @@

Instance Methods

removeItems(addressGroup, body=None, x__xgafv=None)

Removes items from an address group.

+

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

+

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

Method Details

addItems(addressGroup, body=None, x__xgafv=None) @@ -538,4 +541,34 @@

Method Details

}
+
+ testIamPermissions(resource, body=None, x__xgafv=None) +
Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.
+
+Args:
+  resource: string, REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for `TestIamPermissions` method.
+  "permissions": [ # The set of permissions to check for the `resource`. Permissions with wildcards (such as `*` or `storage.*`) are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).
+    "A String",
+  ],
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response message for `TestIamPermissions` method.
+  "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
+    "A String",
+  ],
+}
+
+ \ No newline at end of file diff --git a/docs/dyn/networksecurity_v1.organizations.locations.firewallEndpoints.html b/docs/dyn/networksecurity_v1.organizations.locations.firewallEndpoints.html index 04dd716aac..070dc774df 100644 --- a/docs/dyn/networksecurity_v1.organizations.locations.firewallEndpoints.html +++ b/docs/dyn/networksecurity_v1.organizations.locations.firewallEndpoints.html @@ -111,7 +111,7 @@

Method Details

The object takes the form of: { # Message describing Endpoint object. - "associatedNetworks": [ # Output only. List of networks that are associated with this endpoint in the local zone. This is a projection of the FirewallEndpointAssociations pointing at this endpoint. A network will only appear in this list after traffic routing is fully configured. Format: projects/{project}/global/networks/{name}. + "associatedNetworks": [ # Output only. Deprecated: List of networks that are associated with this endpoint in the local zone. This is a projection of the FirewallEndpointAssociations pointing at this endpoint. A network will only appear in this list after traffic routing is fully configured. Format: projects/{project}/global/networks/{name}. "A String", ], "associations": [ # Output only. List of FirewallEndpointAssociations that are associated to this endpoint. An association will only appear in this list after traffic routing is fully configured. @@ -219,7 +219,7 @@

Method Details

An object of the form: { # Message describing Endpoint object. - "associatedNetworks": [ # Output only. List of networks that are associated with this endpoint in the local zone. This is a projection of the FirewallEndpointAssociations pointing at this endpoint. A network will only appear in this list after traffic routing is fully configured. Format: projects/{project}/global/networks/{name}. + "associatedNetworks": [ # Output only. Deprecated: List of networks that are associated with this endpoint in the local zone. This is a projection of the FirewallEndpointAssociations pointing at this endpoint. A network will only appear in this list after traffic routing is fully configured. Format: projects/{project}/global/networks/{name}. "A String", ], "associations": [ # Output only. List of FirewallEndpointAssociations that are associated to this endpoint. An association will only appear in this list after traffic routing is fully configured. @@ -267,7 +267,7 @@

Method Details

{ # Message for response to listing Endpoints "firewallEndpoints": [ # The list of Endpoint { # Message describing Endpoint object. - "associatedNetworks": [ # Output only. List of networks that are associated with this endpoint in the local zone. This is a projection of the FirewallEndpointAssociations pointing at this endpoint. A network will only appear in this list after traffic routing is fully configured. Format: projects/{project}/global/networks/{name}. + "associatedNetworks": [ # Output only. Deprecated: List of networks that are associated with this endpoint in the local zone. This is a projection of the FirewallEndpointAssociations pointing at this endpoint. A network will only appear in this list after traffic routing is fully configured. Format: projects/{project}/global/networks/{name}. "A String", ], "associations": [ # Output only. List of FirewallEndpointAssociations that are associated to this endpoint. An association will only appear in this list after traffic routing is fully configured. @@ -324,7 +324,7 @@

Method Details

The object takes the form of: { # Message describing Endpoint object. - "associatedNetworks": [ # Output only. List of networks that are associated with this endpoint in the local zone. This is a projection of the FirewallEndpointAssociations pointing at this endpoint. A network will only appear in this list after traffic routing is fully configured. Format: projects/{project}/global/networks/{name}. + "associatedNetworks": [ # Output only. Deprecated: List of networks that are associated with this endpoint in the local zone. This is a projection of the FirewallEndpointAssociations pointing at this endpoint. A network will only appear in this list after traffic routing is fully configured. Format: projects/{project}/global/networks/{name}. "A String", ], "associations": [ # Output only. List of FirewallEndpointAssociations that are associated to this endpoint. An association will only appear in this list after traffic routing is fully configured. diff --git a/docs/dyn/networksecurity_v1.organizations.locations.html b/docs/dyn/networksecurity_v1.organizations.locations.html index b6e90d83a7..c68d0d2954 100644 --- a/docs/dyn/networksecurity_v1.organizations.locations.html +++ b/docs/dyn/networksecurity_v1.organizations.locations.html @@ -102,10 +102,96 @@

Instance Methods

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. This method lists locations based on the resource scope provided in the ListLocationsRequest.name field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.

+

+ 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. This method lists locations based on the resource scope provided in the ListLocationsRequest.name field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.
+
+Args:
+  name: string, The resource that owns the locations collection, if applicable. (required)
+  extraLocationTypes: string, Optional. Do not use this field 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.
+  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/networksecurity_v1.projects.locations.authzPolicies.html b/docs/dyn/networksecurity_v1.projects.locations.authzPolicies.html index afac76c8c1..20b0f17671 100644 --- a/docs/dyn/networksecurity_v1.projects.locations.authzPolicies.html +++ b/docs/dyn/networksecurity_v1.projects.locations.authzPolicies.html @@ -267,6 +267,15 @@

Method Details

"suffix": "A String", # The input string must have the suffix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc`` }, ], + "snis": [ # Optional. A list of SNIs to match against. The match can be one of exact, prefix, suffix, or contains (substring match). If there is no SNI (i.e. plaintext HTTP traffic), the request will be denied. Matches are always case sensitive unless the ignoreCase is set. Limited to 10 SNIs per Authorization Policy. + { # Determines how a string value should be matched. + "contains": "A String", # The input string must have the substring specified here. Note: empty contains match is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc.def`` + "exact": "A String", # The input string must match exactly the string specified here. Examples: * ``abc`` only matches the value ``abc``. + "ignoreCase": True or False, # If true, indicates the exact/prefix/suffix/contains matching should be case insensitive. For example, the matcher ``data`` will match both input string ``Data`` and ``data`` if set to true. + "prefix": "A String", # The input string must have the prefix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``abc.xyz`` + "suffix": "A String", # The input string must have the suffix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc`` + }, + ], }, ], "operations": [ # Optional. Describes properties of one or more targets of a request. At least one of operations or notOperations must be specified. Limited to 1 operation. A match occurs when ANY operation (in operations or notOperations) matches. Within an operation, the match follows AND semantics across fields and OR semantics within a field, i.e. a match occurs when ANY path matches AND ANY header matches and ANY method matches. @@ -323,6 +332,15 @@

Method Details

"suffix": "A String", # The input string must have the suffix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc`` }, ], + "snis": [ # Optional. A list of SNIs to match against. The match can be one of exact, prefix, suffix, or contains (substring match). If there is no SNI (i.e. plaintext HTTP traffic), the request will be denied. Matches are always case sensitive unless the ignoreCase is set. Limited to 10 SNIs per Authorization Policy. + { # Determines how a string value should be matched. + "contains": "A String", # The input string must have the substring specified here. Note: empty contains match is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc.def`` + "exact": "A String", # The input string must match exactly the string specified here. Examples: * ``abc`` only matches the value ``abc``. + "ignoreCase": True or False, # If true, indicates the exact/prefix/suffix/contains matching should be case insensitive. For example, the matcher ``data`` will match both input string ``Data`` and ``data`` if set to true. + "prefix": "A String", # The input string must have the prefix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``abc.xyz`` + "suffix": "A String", # The input string must have the suffix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc`` + }, + ], }, ], }, @@ -333,6 +351,221 @@

Method Details

"a_key": "A String", }, "name": "A String", # Required. Identifier. Name of the `AuthzPolicy` resource in the following format: `projects/{project}/locations/{location}/authzPolicies/{authz_policy}`. + "networkRules": [ # Optional. A list of authorization network rules to match against the incoming request. A policy match occurs when at least one network rule matches the request. At least one network rule is required for Allow or Deny Action if no HTTP rules are provided. Network rules are mutually exclusive with HTTP rules. Limited to 5 rules. + { # Conditions to match against the incoming request. + "from": { # Describes properties of one or more sources of a request. # Optional. Describes properties of a source of a request. + "notSources": [ # Optional. Describes the negated properties of request sources. Matches requests from sources that do not match the criteria specified in this field. At least one of sources or notSources must be specified. + { # Describes the properties of a single source. + "ipBlocks": [ # Optional. A list of IP addresses or IP address ranges to match against the source IP address of the request. Limited to 10 ip_blocks per Authorization Policy + { # Represents a range of IP Addresses. + "length": 42, # Required. The length of the address range. + "prefix": "A String", # Required. The address prefix. + }, + ], + "principals": [ # Optional. A list of identities derived from the client's certificate. This field will not match on a request unless frontend mutual TLS is enabled for the forwarding rule or Gateway and the client certificate has been successfully validated by mTLS. Each identity is a string whose value is matched against a list of URI SANs, DNS Name SANs, or the common name in the client's certificate. A match happens when any principal matches with the rule. Limited to 50 principals per Authorization Policy for regional internal Application Load Balancers, regional external Application Load Balancers, cross-region internal Application Load Balancers, and Cloud Service Mesh. This field is not supported for global external Application Load Balancers. + { # Describes the properties of a principal to be matched against. + "principal": { # Determines how a string value should be matched. # Required. A non-empty string whose value is matched against the principal value based on the principal_selector. Only exact match can be applied for CLIENT_CERT_URI_SAN, CLIENT_CERT_DNS_NAME_SAN, CLIENT_CERT_COMMON_NAME selectors. + "contains": "A String", # The input string must have the substring specified here. Note: empty contains match is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc.def`` + "exact": "A String", # The input string must match exactly the string specified here. Examples: * ``abc`` only matches the value ``abc``. + "ignoreCase": True or False, # If true, indicates the exact/prefix/suffix/contains matching should be case insensitive. For example, the matcher ``data`` will match both input string ``Data`` and ``data`` if set to true. + "prefix": "A String", # The input string must have the prefix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``abc.xyz`` + "suffix": "A String", # The input string must have the suffix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc`` + }, + "principalSelector": "A String", # Optional. An enum to decide what principal value the principal rule will match against. If not specified, the PrincipalSelector is CLIENT_CERT_URI_SAN. + }, + ], + "resources": [ # Optional. A list of resources to match against the resource of the source VM of a request. Limited to 10 resources per Authorization Policy. + { # Describes the properties of a client VM resource accessing the internal application load balancers. + "iamServiceAccount": { # Determines how a string value should be matched. # Optional. An IAM service account to match against the source service account of the VM sending the request. + "contains": "A String", # The input string must have the substring specified here. Note: empty contains match is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc.def`` + "exact": "A String", # The input string must match exactly the string specified here. Examples: * ``abc`` only matches the value ``abc``. + "ignoreCase": True or False, # If true, indicates the exact/prefix/suffix/contains matching should be case insensitive. For example, the matcher ``data`` will match both input string ``Data`` and ``data`` if set to true. + "prefix": "A String", # The input string must have the prefix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``abc.xyz`` + "suffix": "A String", # The input string must have the suffix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc`` + }, + "tagValueIdSet": { # Describes a set of resource tag value permanent IDs to match against the resource manager tags value associated with the source VM of a request. # Optional. A list of resource tag value permanent IDs to match against the resource manager tags value associated with the source VM of a request. + "ids": [ # Required. A list of resource tag value permanent IDs to match against the resource manager tags value associated with the source VM of a request. The match follows AND semantics which means all the ids must match. Limited to 5 ids in the Tag value id set. + "A String", + ], + }, + }, + ], + }, + ], + "sources": [ # Optional. Describes the properties of a request's sources. At least one of sources or notSources must be specified. Limited to 1 source. A match occurs when ANY source (in sources or notSources) matches the request. Within a single source, the match follows AND semantics across fields and OR semantics within a single field, i.e. a match occurs when ANY principal matches AND ANY ipBlocks match. + { # Describes the properties of a single source. + "ipBlocks": [ # Optional. A list of IP addresses or IP address ranges to match against the source IP address of the request. Limited to 10 ip_blocks per Authorization Policy + { # Represents a range of IP Addresses. + "length": 42, # Required. The length of the address range. + "prefix": "A String", # Required. The address prefix. + }, + ], + "principals": [ # Optional. A list of identities derived from the client's certificate. This field will not match on a request unless frontend mutual TLS is enabled for the forwarding rule or Gateway and the client certificate has been successfully validated by mTLS. Each identity is a string whose value is matched against a list of URI SANs, DNS Name SANs, or the common name in the client's certificate. A match happens when any principal matches with the rule. Limited to 50 principals per Authorization Policy for regional internal Application Load Balancers, regional external Application Load Balancers, cross-region internal Application Load Balancers, and Cloud Service Mesh. This field is not supported for global external Application Load Balancers. + { # Describes the properties of a principal to be matched against. + "principal": { # Determines how a string value should be matched. # Required. A non-empty string whose value is matched against the principal value based on the principal_selector. Only exact match can be applied for CLIENT_CERT_URI_SAN, CLIENT_CERT_DNS_NAME_SAN, CLIENT_CERT_COMMON_NAME selectors. + "contains": "A String", # The input string must have the substring specified here. Note: empty contains match is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc.def`` + "exact": "A String", # The input string must match exactly the string specified here. Examples: * ``abc`` only matches the value ``abc``. + "ignoreCase": True or False, # If true, indicates the exact/prefix/suffix/contains matching should be case insensitive. For example, the matcher ``data`` will match both input string ``Data`` and ``data`` if set to true. + "prefix": "A String", # The input string must have the prefix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``abc.xyz`` + "suffix": "A String", # The input string must have the suffix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc`` + }, + "principalSelector": "A String", # Optional. An enum to decide what principal value the principal rule will match against. If not specified, the PrincipalSelector is CLIENT_CERT_URI_SAN. + }, + ], + "resources": [ # Optional. A list of resources to match against the resource of the source VM of a request. Limited to 10 resources per Authorization Policy. + { # Describes the properties of a client VM resource accessing the internal application load balancers. + "iamServiceAccount": { # Determines how a string value should be matched. # Optional. An IAM service account to match against the source service account of the VM sending the request. + "contains": "A String", # The input string must have the substring specified here. Note: empty contains match is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc.def`` + "exact": "A String", # The input string must match exactly the string specified here. Examples: * ``abc`` only matches the value ``abc``. + "ignoreCase": True or False, # If true, indicates the exact/prefix/suffix/contains matching should be case insensitive. For example, the matcher ``data`` will match both input string ``Data`` and ``data`` if set to true. + "prefix": "A String", # The input string must have the prefix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``abc.xyz`` + "suffix": "A String", # The input string must have the suffix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc`` + }, + "tagValueIdSet": { # Describes a set of resource tag value permanent IDs to match against the resource manager tags value associated with the source VM of a request. # Optional. A list of resource tag value permanent IDs to match against the resource manager tags value associated with the source VM of a request. + "ids": [ # Required. A list of resource tag value permanent IDs to match against the resource manager tags value associated with the source VM of a request. The match follows AND semantics which means all the ids must match. Limited to 5 ids in the Tag value id set. + "A String", + ], + }, + }, + ], + }, + ], + }, + "to": { # Describes properties of one or more targets of a request. # Optional. Describes properties of a target of a request. + "notOperations": [ # Optional. Describes the negated properties of the targets of a request. Matches requests for operations that do not match the criteria specified in this field. At least one of operations or notOperations must be specified. + { # Describes properties of one or more targets of a request. + "headerSet": { # Describes a set of HTTP headers to match against. # Optional. A list of headers to match against in http header. + "headers": [ # Required. A list of headers to match against in http header. The match can be one of exact, prefix, suffix, or contains (substring match). The match follows AND semantics which means all the headers must match. Matches are always case sensitive unless the ignoreCase is set. Limited to 10 headers per Authorization Policy. + { # Determines how a HTTP header should be matched. + "name": "A String", # Optional. Specifies the name of the header in the request. + "value": { # Determines how a string value should be matched. # Optional. Specifies how the header match will be performed. + "contains": "A String", # The input string must have the substring specified here. Note: empty contains match is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc.def`` + "exact": "A String", # The input string must match exactly the string specified here. Examples: * ``abc`` only matches the value ``abc``. + "ignoreCase": True or False, # If true, indicates the exact/prefix/suffix/contains matching should be case insensitive. For example, the matcher ``data`` will match both input string ``Data`` and ``data`` if set to true. + "prefix": "A String", # The input string must have the prefix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``abc.xyz`` + "suffix": "A String", # The input string must have the suffix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc`` + }, + }, + ], + }, + "hosts": [ # Optional. A list of HTTP Hosts to match against. The match can be one of exact, prefix, suffix, or contains (substring match). Matches are always case sensitive unless the ignoreCase is set. Limited to 10 hosts per Authorization Policy. + { # Determines how a string value should be matched. + "contains": "A String", # The input string must have the substring specified here. Note: empty contains match is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc.def`` + "exact": "A String", # The input string must match exactly the string specified here. Examples: * ``abc`` only matches the value ``abc``. + "ignoreCase": True or False, # If true, indicates the exact/prefix/suffix/contains matching should be case insensitive. For example, the matcher ``data`` will match both input string ``Data`` and ``data`` if set to true. + "prefix": "A String", # The input string must have the prefix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``abc.xyz`` + "suffix": "A String", # The input string must have the suffix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc`` + }, + ], + "mcp": { # Describes a set of MCP protocol attributes to match against for a given MCP request. # Optional. Defines the MCP protocol attributes to match on. If the MCP payload in the request body cannot be successfully parsed, the request will be denied. This field can be set only for AuthzPolicies targeting AgentGateway resources. + "baseProtocolMethodsOption": "A String", # Optional. If specified, matches on the MCP protocol’s non-access specific methods namely: * initialize * completion/ * logging/ * notifications/ * ping Defaults to SKIP_BASE_PROTOCOL_METHODS if not specified. + "methods": [ # Optional. A list of MCP methods and associated parameters to match on. It is recommended to use this field to match on tools, prompts and resource accesses while setting the baseProtocolMethodsOption to MATCH_BASE_PROTOCOL_METHODS to match on all the other MCP protocol methods. Limited to 10 MCP methods per Authorization Policy. + { # Describes a set of MCP methods to match against. + "name": "A String", # Required. The MCP method to match against. Allowed values are as follows: 1. `tools`, `prompts`, `resources` - these will match against all sub methods under the respective methods. 2. `prompts/list`, `tools/list`, `resources/list`, `resources/templates/list` 3. `prompts/get`, `tools/call`, `resources/subscribe`, `resources/unsubscribe`, `resources/read` Params cannot be specified for categories 1 and 2. + "params": [ # Optional. A list of MCP method parameters to match against. The match can be one of exact, prefix, suffix, or contains (substring match). Matches are always case sensitive unless the ignoreCase is set. Limited to 10 MCP method parameters per Authorization Policy. + { # Determines how a string value should be matched. + "contains": "A String", # The input string must have the substring specified here. Note: empty contains match is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc.def`` + "exact": "A String", # The input string must match exactly the string specified here. Examples: * ``abc`` only matches the value ``abc``. + "ignoreCase": True or False, # If true, indicates the exact/prefix/suffix/contains matching should be case insensitive. For example, the matcher ``data`` will match both input string ``Data`` and ``data`` if set to true. + "prefix": "A String", # The input string must have the prefix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``abc.xyz`` + "suffix": "A String", # The input string must have the suffix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc`` + }, + ], + }, + ], + }, + "methods": [ # Optional. A list of HTTP methods to match against. Each entry must be a valid HTTP method name (GET, PUT, POST, HEAD, PATCH, DELETE, OPTIONS). It only allows exact match and is always case sensitive. Limited to 10 methods per Authorization Policy. + "A String", + ], + "paths": [ # Optional. A list of paths to match against. The match can be one of exact, prefix, suffix, or contains (substring match). Matches are always case sensitive unless the ignoreCase is set. Limited to 10 paths per Authorization Policy. Note that this path match includes the query parameters. For gRPC services, this should be a fully-qualified name of the form /package.service/method. + { # Determines how a string value should be matched. + "contains": "A String", # The input string must have the substring specified here. Note: empty contains match is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc.def`` + "exact": "A String", # The input string must match exactly the string specified here. Examples: * ``abc`` only matches the value ``abc``. + "ignoreCase": True or False, # If true, indicates the exact/prefix/suffix/contains matching should be case insensitive. For example, the matcher ``data`` will match both input string ``Data`` and ``data`` if set to true. + "prefix": "A String", # The input string must have the prefix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``abc.xyz`` + "suffix": "A String", # The input string must have the suffix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc`` + }, + ], + "snis": [ # Optional. A list of SNIs to match against. The match can be one of exact, prefix, suffix, or contains (substring match). If there is no SNI (i.e. plaintext HTTP traffic), the request will be denied. Matches are always case sensitive unless the ignoreCase is set. Limited to 10 SNIs per Authorization Policy. + { # Determines how a string value should be matched. + "contains": "A String", # The input string must have the substring specified here. Note: empty contains match is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc.def`` + "exact": "A String", # The input string must match exactly the string specified here. Examples: * ``abc`` only matches the value ``abc``. + "ignoreCase": True or False, # If true, indicates the exact/prefix/suffix/contains matching should be case insensitive. For example, the matcher ``data`` will match both input string ``Data`` and ``data`` if set to true. + "prefix": "A String", # The input string must have the prefix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``abc.xyz`` + "suffix": "A String", # The input string must have the suffix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc`` + }, + ], + }, + ], + "operations": [ # Optional. Describes properties of one or more targets of a request. At least one of operations or notOperations must be specified. Limited to 1 operation. A match occurs when ANY operation (in operations or notOperations) matches. Within an operation, the match follows AND semantics across fields and OR semantics within a field, i.e. a match occurs when ANY path matches AND ANY header matches and ANY method matches. + { # Describes properties of one or more targets of a request. + "headerSet": { # Describes a set of HTTP headers to match against. # Optional. A list of headers to match against in http header. + "headers": [ # Required. A list of headers to match against in http header. The match can be one of exact, prefix, suffix, or contains (substring match). The match follows AND semantics which means all the headers must match. Matches are always case sensitive unless the ignoreCase is set. Limited to 10 headers per Authorization Policy. + { # Determines how a HTTP header should be matched. + "name": "A String", # Optional. Specifies the name of the header in the request. + "value": { # Determines how a string value should be matched. # Optional. Specifies how the header match will be performed. + "contains": "A String", # The input string must have the substring specified here. Note: empty contains match is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc.def`` + "exact": "A String", # The input string must match exactly the string specified here. Examples: * ``abc`` only matches the value ``abc``. + "ignoreCase": True or False, # If true, indicates the exact/prefix/suffix/contains matching should be case insensitive. For example, the matcher ``data`` will match both input string ``Data`` and ``data`` if set to true. + "prefix": "A String", # The input string must have the prefix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``abc.xyz`` + "suffix": "A String", # The input string must have the suffix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc`` + }, + }, + ], + }, + "hosts": [ # Optional. A list of HTTP Hosts to match against. The match can be one of exact, prefix, suffix, or contains (substring match). Matches are always case sensitive unless the ignoreCase is set. Limited to 10 hosts per Authorization Policy. + { # Determines how a string value should be matched. + "contains": "A String", # The input string must have the substring specified here. Note: empty contains match is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc.def`` + "exact": "A String", # The input string must match exactly the string specified here. Examples: * ``abc`` only matches the value ``abc``. + "ignoreCase": True or False, # If true, indicates the exact/prefix/suffix/contains matching should be case insensitive. For example, the matcher ``data`` will match both input string ``Data`` and ``data`` if set to true. + "prefix": "A String", # The input string must have the prefix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``abc.xyz`` + "suffix": "A String", # The input string must have the suffix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc`` + }, + ], + "mcp": { # Describes a set of MCP protocol attributes to match against for a given MCP request. # Optional. Defines the MCP protocol attributes to match on. If the MCP payload in the request body cannot be successfully parsed, the request will be denied. This field can be set only for AuthzPolicies targeting AgentGateway resources. + "baseProtocolMethodsOption": "A String", # Optional. If specified, matches on the MCP protocol’s non-access specific methods namely: * initialize * completion/ * logging/ * notifications/ * ping Defaults to SKIP_BASE_PROTOCOL_METHODS if not specified. + "methods": [ # Optional. A list of MCP methods and associated parameters to match on. It is recommended to use this field to match on tools, prompts and resource accesses while setting the baseProtocolMethodsOption to MATCH_BASE_PROTOCOL_METHODS to match on all the other MCP protocol methods. Limited to 10 MCP methods per Authorization Policy. + { # Describes a set of MCP methods to match against. + "name": "A String", # Required. The MCP method to match against. Allowed values are as follows: 1. `tools`, `prompts`, `resources` - these will match against all sub methods under the respective methods. 2. `prompts/list`, `tools/list`, `resources/list`, `resources/templates/list` 3. `prompts/get`, `tools/call`, `resources/subscribe`, `resources/unsubscribe`, `resources/read` Params cannot be specified for categories 1 and 2. + "params": [ # Optional. A list of MCP method parameters to match against. The match can be one of exact, prefix, suffix, or contains (substring match). Matches are always case sensitive unless the ignoreCase is set. Limited to 10 MCP method parameters per Authorization Policy. + { # Determines how a string value should be matched. + "contains": "A String", # The input string must have the substring specified here. Note: empty contains match is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc.def`` + "exact": "A String", # The input string must match exactly the string specified here. Examples: * ``abc`` only matches the value ``abc``. + "ignoreCase": True or False, # If true, indicates the exact/prefix/suffix/contains matching should be case insensitive. For example, the matcher ``data`` will match both input string ``Data`` and ``data`` if set to true. + "prefix": "A String", # The input string must have the prefix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``abc.xyz`` + "suffix": "A String", # The input string must have the suffix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc`` + }, + ], + }, + ], + }, + "methods": [ # Optional. A list of HTTP methods to match against. Each entry must be a valid HTTP method name (GET, PUT, POST, HEAD, PATCH, DELETE, OPTIONS). It only allows exact match and is always case sensitive. Limited to 10 methods per Authorization Policy. + "A String", + ], + "paths": [ # Optional. A list of paths to match against. The match can be one of exact, prefix, suffix, or contains (substring match). Matches are always case sensitive unless the ignoreCase is set. Limited to 10 paths per Authorization Policy. Note that this path match includes the query parameters. For gRPC services, this should be a fully-qualified name of the form /package.service/method. + { # Determines how a string value should be matched. + "contains": "A String", # The input string must have the substring specified here. Note: empty contains match is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc.def`` + "exact": "A String", # The input string must match exactly the string specified here. Examples: * ``abc`` only matches the value ``abc``. + "ignoreCase": True or False, # If true, indicates the exact/prefix/suffix/contains matching should be case insensitive. For example, the matcher ``data`` will match both input string ``Data`` and ``data`` if set to true. + "prefix": "A String", # The input string must have the prefix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``abc.xyz`` + "suffix": "A String", # The input string must have the suffix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc`` + }, + ], + "snis": [ # Optional. A list of SNIs to match against. The match can be one of exact, prefix, suffix, or contains (substring match). If there is no SNI (i.e. plaintext HTTP traffic), the request will be denied. Matches are always case sensitive unless the ignoreCase is set. Limited to 10 SNIs per Authorization Policy. + { # Determines how a string value should be matched. + "contains": "A String", # The input string must have the substring specified here. Note: empty contains match is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc.def`` + "exact": "A String", # The input string must match exactly the string specified here. Examples: * ``abc`` only matches the value ``abc``. + "ignoreCase": True or False, # If true, indicates the exact/prefix/suffix/contains matching should be case insensitive. For example, the matcher ``data`` will match both input string ``Data`` and ``data`` if set to true. + "prefix": "A String", # The input string must have the prefix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``abc.xyz`` + "suffix": "A String", # The input string must have the suffix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc`` + }, + ], + }, + ], + }, + "when": "A String", # Optional. CEL expression that describes the conditions to be satisfied for the action. The result of the CEL expression is ANDed with the from and to. Refer to the CEL language reference for a list of available attributes. + }, + ], "policyProfile": "A String", # Optional. Immutable. Defines the type of authorization being performed. If not specified, `REQUEST_AUTHZ` is applied. This field cannot be changed once AuthzPolicy is created. "target": { # Specifies the set of targets to which this policy should be applied to. # Required. Specifies the set of resources to which this policy should be applied to. "loadBalancingScheme": "A String", # Optional. All gateways and forwarding rules referenced by this policy and extensions must share the same load balancing scheme. Required only when targeting forwarding rules. If targeting Secure Web Proxy, this field must be `INTERNAL_MANAGED` or not specified. Must not be specified when targeting Agent Gateway. Supported values: `INTERNAL_MANAGED` and `EXTERNAL_MANAGED`. For more information, refer to [Backend services overview](https://cloud.google.com/load-balancing/docs/backend-service). @@ -572,6 +805,15 @@

Method Details

"suffix": "A String", # The input string must have the suffix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc`` }, ], + "snis": [ # Optional. A list of SNIs to match against. The match can be one of exact, prefix, suffix, or contains (substring match). If there is no SNI (i.e. plaintext HTTP traffic), the request will be denied. Matches are always case sensitive unless the ignoreCase is set. Limited to 10 SNIs per Authorization Policy. + { # Determines how a string value should be matched. + "contains": "A String", # The input string must have the substring specified here. Note: empty contains match is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc.def`` + "exact": "A String", # The input string must match exactly the string specified here. Examples: * ``abc`` only matches the value ``abc``. + "ignoreCase": True or False, # If true, indicates the exact/prefix/suffix/contains matching should be case insensitive. For example, the matcher ``data`` will match both input string ``Data`` and ``data`` if set to true. + "prefix": "A String", # The input string must have the prefix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``abc.xyz`` + "suffix": "A String", # The input string must have the suffix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc`` + }, + ], }, ], "operations": [ # Optional. Describes properties of one or more targets of a request. At least one of operations or notOperations must be specified. Limited to 1 operation. A match occurs when ANY operation (in operations or notOperations) matches. Within an operation, the match follows AND semantics across fields and OR semantics within a field, i.e. a match occurs when ANY path matches AND ANY header matches and ANY method matches. @@ -628,6 +870,15 @@

Method Details

"suffix": "A String", # The input string must have the suffix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc`` }, ], + "snis": [ # Optional. A list of SNIs to match against. The match can be one of exact, prefix, suffix, or contains (substring match). If there is no SNI (i.e. plaintext HTTP traffic), the request will be denied. Matches are always case sensitive unless the ignoreCase is set. Limited to 10 SNIs per Authorization Policy. + { # Determines how a string value should be matched. + "contains": "A String", # The input string must have the substring specified here. Note: empty contains match is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc.def`` + "exact": "A String", # The input string must match exactly the string specified here. Examples: * ``abc`` only matches the value ``abc``. + "ignoreCase": True or False, # If true, indicates the exact/prefix/suffix/contains matching should be case insensitive. For example, the matcher ``data`` will match both input string ``Data`` and ``data`` if set to true. + "prefix": "A String", # The input string must have the prefix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``abc.xyz`` + "suffix": "A String", # The input string must have the suffix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc`` + }, + ], }, ], }, @@ -638,18 +889,233 @@

Method Details

"a_key": "A String", }, "name": "A String", # Required. Identifier. Name of the `AuthzPolicy` resource in the following format: `projects/{project}/locations/{location}/authzPolicies/{authz_policy}`. - "policyProfile": "A String", # Optional. Immutable. Defines the type of authorization being performed. If not specified, `REQUEST_AUTHZ` is applied. This field cannot be changed once AuthzPolicy is created. - "target": { # Specifies the set of targets to which this policy should be applied to. # Required. Specifies the set of resources to which this policy should be applied to. - "loadBalancingScheme": "A String", # Optional. All gateways and forwarding rules referenced by this policy and extensions must share the same load balancing scheme. Required only when targeting forwarding rules. If targeting Secure Web Proxy, this field must be `INTERNAL_MANAGED` or not specified. Must not be specified when targeting Agent Gateway. Supported values: `INTERNAL_MANAGED` and `EXTERNAL_MANAGED`. For more information, refer to [Backend services overview](https://cloud.google.com/load-balancing/docs/backend-service). - "resources": [ # Required. A list of references to the Forwarding Rules, Secure Web Proxy Gateways, or Agent Gateways on which this policy will be applied. - "A String", - ], - }, - "updateTime": "A String", # Output only. The timestamp when the resource was updated. -}
-
- -
+ "networkRules": [ # Optional. A list of authorization network rules to match against the incoming request. A policy match occurs when at least one network rule matches the request. At least one network rule is required for Allow or Deny Action if no HTTP rules are provided. Network rules are mutually exclusive with HTTP rules. Limited to 5 rules. + { # Conditions to match against the incoming request. + "from": { # Describes properties of one or more sources of a request. # Optional. Describes properties of a source of a request. + "notSources": [ # Optional. Describes the negated properties of request sources. Matches requests from sources that do not match the criteria specified in this field. At least one of sources or notSources must be specified. + { # Describes the properties of a single source. + "ipBlocks": [ # Optional. A list of IP addresses or IP address ranges to match against the source IP address of the request. Limited to 10 ip_blocks per Authorization Policy + { # Represents a range of IP Addresses. + "length": 42, # Required. The length of the address range. + "prefix": "A String", # Required. The address prefix. + }, + ], + "principals": [ # Optional. A list of identities derived from the client's certificate. This field will not match on a request unless frontend mutual TLS is enabled for the forwarding rule or Gateway and the client certificate has been successfully validated by mTLS. Each identity is a string whose value is matched against a list of URI SANs, DNS Name SANs, or the common name in the client's certificate. A match happens when any principal matches with the rule. Limited to 50 principals per Authorization Policy for regional internal Application Load Balancers, regional external Application Load Balancers, cross-region internal Application Load Balancers, and Cloud Service Mesh. This field is not supported for global external Application Load Balancers. + { # Describes the properties of a principal to be matched against. + "principal": { # Determines how a string value should be matched. # Required. A non-empty string whose value is matched against the principal value based on the principal_selector. Only exact match can be applied for CLIENT_CERT_URI_SAN, CLIENT_CERT_DNS_NAME_SAN, CLIENT_CERT_COMMON_NAME selectors. + "contains": "A String", # The input string must have the substring specified here. Note: empty contains match is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc.def`` + "exact": "A String", # The input string must match exactly the string specified here. Examples: * ``abc`` only matches the value ``abc``. + "ignoreCase": True or False, # If true, indicates the exact/prefix/suffix/contains matching should be case insensitive. For example, the matcher ``data`` will match both input string ``Data`` and ``data`` if set to true. + "prefix": "A String", # The input string must have the prefix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``abc.xyz`` + "suffix": "A String", # The input string must have the suffix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc`` + }, + "principalSelector": "A String", # Optional. An enum to decide what principal value the principal rule will match against. If not specified, the PrincipalSelector is CLIENT_CERT_URI_SAN. + }, + ], + "resources": [ # Optional. A list of resources to match against the resource of the source VM of a request. Limited to 10 resources per Authorization Policy. + { # Describes the properties of a client VM resource accessing the internal application load balancers. + "iamServiceAccount": { # Determines how a string value should be matched. # Optional. An IAM service account to match against the source service account of the VM sending the request. + "contains": "A String", # The input string must have the substring specified here. Note: empty contains match is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc.def`` + "exact": "A String", # The input string must match exactly the string specified here. Examples: * ``abc`` only matches the value ``abc``. + "ignoreCase": True or False, # If true, indicates the exact/prefix/suffix/contains matching should be case insensitive. For example, the matcher ``data`` will match both input string ``Data`` and ``data`` if set to true. + "prefix": "A String", # The input string must have the prefix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``abc.xyz`` + "suffix": "A String", # The input string must have the suffix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc`` + }, + "tagValueIdSet": { # Describes a set of resource tag value permanent IDs to match against the resource manager tags value associated with the source VM of a request. # Optional. A list of resource tag value permanent IDs to match against the resource manager tags value associated with the source VM of a request. + "ids": [ # Required. A list of resource tag value permanent IDs to match against the resource manager tags value associated with the source VM of a request. The match follows AND semantics which means all the ids must match. Limited to 5 ids in the Tag value id set. + "A String", + ], + }, + }, + ], + }, + ], + "sources": [ # Optional. Describes the properties of a request's sources. At least one of sources or notSources must be specified. Limited to 1 source. A match occurs when ANY source (in sources or notSources) matches the request. Within a single source, the match follows AND semantics across fields and OR semantics within a single field, i.e. a match occurs when ANY principal matches AND ANY ipBlocks match. + { # Describes the properties of a single source. + "ipBlocks": [ # Optional. A list of IP addresses or IP address ranges to match against the source IP address of the request. Limited to 10 ip_blocks per Authorization Policy + { # Represents a range of IP Addresses. + "length": 42, # Required. The length of the address range. + "prefix": "A String", # Required. The address prefix. + }, + ], + "principals": [ # Optional. A list of identities derived from the client's certificate. This field will not match on a request unless frontend mutual TLS is enabled for the forwarding rule or Gateway and the client certificate has been successfully validated by mTLS. Each identity is a string whose value is matched against a list of URI SANs, DNS Name SANs, or the common name in the client's certificate. A match happens when any principal matches with the rule. Limited to 50 principals per Authorization Policy for regional internal Application Load Balancers, regional external Application Load Balancers, cross-region internal Application Load Balancers, and Cloud Service Mesh. This field is not supported for global external Application Load Balancers. + { # Describes the properties of a principal to be matched against. + "principal": { # Determines how a string value should be matched. # Required. A non-empty string whose value is matched against the principal value based on the principal_selector. Only exact match can be applied for CLIENT_CERT_URI_SAN, CLIENT_CERT_DNS_NAME_SAN, CLIENT_CERT_COMMON_NAME selectors. + "contains": "A String", # The input string must have the substring specified here. Note: empty contains match is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc.def`` + "exact": "A String", # The input string must match exactly the string specified here. Examples: * ``abc`` only matches the value ``abc``. + "ignoreCase": True or False, # If true, indicates the exact/prefix/suffix/contains matching should be case insensitive. For example, the matcher ``data`` will match both input string ``Data`` and ``data`` if set to true. + "prefix": "A String", # The input string must have the prefix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``abc.xyz`` + "suffix": "A String", # The input string must have the suffix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc`` + }, + "principalSelector": "A String", # Optional. An enum to decide what principal value the principal rule will match against. If not specified, the PrincipalSelector is CLIENT_CERT_URI_SAN. + }, + ], + "resources": [ # Optional. A list of resources to match against the resource of the source VM of a request. Limited to 10 resources per Authorization Policy. + { # Describes the properties of a client VM resource accessing the internal application load balancers. + "iamServiceAccount": { # Determines how a string value should be matched. # Optional. An IAM service account to match against the source service account of the VM sending the request. + "contains": "A String", # The input string must have the substring specified here. Note: empty contains match is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc.def`` + "exact": "A String", # The input string must match exactly the string specified here. Examples: * ``abc`` only matches the value ``abc``. + "ignoreCase": True or False, # If true, indicates the exact/prefix/suffix/contains matching should be case insensitive. For example, the matcher ``data`` will match both input string ``Data`` and ``data`` if set to true. + "prefix": "A String", # The input string must have the prefix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``abc.xyz`` + "suffix": "A String", # The input string must have the suffix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc`` + }, + "tagValueIdSet": { # Describes a set of resource tag value permanent IDs to match against the resource manager tags value associated with the source VM of a request. # Optional. A list of resource tag value permanent IDs to match against the resource manager tags value associated with the source VM of a request. + "ids": [ # Required. A list of resource tag value permanent IDs to match against the resource manager tags value associated with the source VM of a request. The match follows AND semantics which means all the ids must match. Limited to 5 ids in the Tag value id set. + "A String", + ], + }, + }, + ], + }, + ], + }, + "to": { # Describes properties of one or more targets of a request. # Optional. Describes properties of a target of a request. + "notOperations": [ # Optional. Describes the negated properties of the targets of a request. Matches requests for operations that do not match the criteria specified in this field. At least one of operations or notOperations must be specified. + { # Describes properties of one or more targets of a request. + "headerSet": { # Describes a set of HTTP headers to match against. # Optional. A list of headers to match against in http header. + "headers": [ # Required. A list of headers to match against in http header. The match can be one of exact, prefix, suffix, or contains (substring match). The match follows AND semantics which means all the headers must match. Matches are always case sensitive unless the ignoreCase is set. Limited to 10 headers per Authorization Policy. + { # Determines how a HTTP header should be matched. + "name": "A String", # Optional. Specifies the name of the header in the request. + "value": { # Determines how a string value should be matched. # Optional. Specifies how the header match will be performed. + "contains": "A String", # The input string must have the substring specified here. Note: empty contains match is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc.def`` + "exact": "A String", # The input string must match exactly the string specified here. Examples: * ``abc`` only matches the value ``abc``. + "ignoreCase": True or False, # If true, indicates the exact/prefix/suffix/contains matching should be case insensitive. For example, the matcher ``data`` will match both input string ``Data`` and ``data`` if set to true. + "prefix": "A String", # The input string must have the prefix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``abc.xyz`` + "suffix": "A String", # The input string must have the suffix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc`` + }, + }, + ], + }, + "hosts": [ # Optional. A list of HTTP Hosts to match against. The match can be one of exact, prefix, suffix, or contains (substring match). Matches are always case sensitive unless the ignoreCase is set. Limited to 10 hosts per Authorization Policy. + { # Determines how a string value should be matched. + "contains": "A String", # The input string must have the substring specified here. Note: empty contains match is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc.def`` + "exact": "A String", # The input string must match exactly the string specified here. Examples: * ``abc`` only matches the value ``abc``. + "ignoreCase": True or False, # If true, indicates the exact/prefix/suffix/contains matching should be case insensitive. For example, the matcher ``data`` will match both input string ``Data`` and ``data`` if set to true. + "prefix": "A String", # The input string must have the prefix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``abc.xyz`` + "suffix": "A String", # The input string must have the suffix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc`` + }, + ], + "mcp": { # Describes a set of MCP protocol attributes to match against for a given MCP request. # Optional. Defines the MCP protocol attributes to match on. If the MCP payload in the request body cannot be successfully parsed, the request will be denied. This field can be set only for AuthzPolicies targeting AgentGateway resources. + "baseProtocolMethodsOption": "A String", # Optional. If specified, matches on the MCP protocol’s non-access specific methods namely: * initialize * completion/ * logging/ * notifications/ * ping Defaults to SKIP_BASE_PROTOCOL_METHODS if not specified. + "methods": [ # Optional. A list of MCP methods and associated parameters to match on. It is recommended to use this field to match on tools, prompts and resource accesses while setting the baseProtocolMethodsOption to MATCH_BASE_PROTOCOL_METHODS to match on all the other MCP protocol methods. Limited to 10 MCP methods per Authorization Policy. + { # Describes a set of MCP methods to match against. + "name": "A String", # Required. The MCP method to match against. Allowed values are as follows: 1. `tools`, `prompts`, `resources` - these will match against all sub methods under the respective methods. 2. `prompts/list`, `tools/list`, `resources/list`, `resources/templates/list` 3. `prompts/get`, `tools/call`, `resources/subscribe`, `resources/unsubscribe`, `resources/read` Params cannot be specified for categories 1 and 2. + "params": [ # Optional. A list of MCP method parameters to match against. The match can be one of exact, prefix, suffix, or contains (substring match). Matches are always case sensitive unless the ignoreCase is set. Limited to 10 MCP method parameters per Authorization Policy. + { # Determines how a string value should be matched. + "contains": "A String", # The input string must have the substring specified here. Note: empty contains match is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc.def`` + "exact": "A String", # The input string must match exactly the string specified here. Examples: * ``abc`` only matches the value ``abc``. + "ignoreCase": True or False, # If true, indicates the exact/prefix/suffix/contains matching should be case insensitive. For example, the matcher ``data`` will match both input string ``Data`` and ``data`` if set to true. + "prefix": "A String", # The input string must have the prefix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``abc.xyz`` + "suffix": "A String", # The input string must have the suffix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc`` + }, + ], + }, + ], + }, + "methods": [ # Optional. A list of HTTP methods to match against. Each entry must be a valid HTTP method name (GET, PUT, POST, HEAD, PATCH, DELETE, OPTIONS). It only allows exact match and is always case sensitive. Limited to 10 methods per Authorization Policy. + "A String", + ], + "paths": [ # Optional. A list of paths to match against. The match can be one of exact, prefix, suffix, or contains (substring match). Matches are always case sensitive unless the ignoreCase is set. Limited to 10 paths per Authorization Policy. Note that this path match includes the query parameters. For gRPC services, this should be a fully-qualified name of the form /package.service/method. + { # Determines how a string value should be matched. + "contains": "A String", # The input string must have the substring specified here. Note: empty contains match is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc.def`` + "exact": "A String", # The input string must match exactly the string specified here. Examples: * ``abc`` only matches the value ``abc``. + "ignoreCase": True or False, # If true, indicates the exact/prefix/suffix/contains matching should be case insensitive. For example, the matcher ``data`` will match both input string ``Data`` and ``data`` if set to true. + "prefix": "A String", # The input string must have the prefix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``abc.xyz`` + "suffix": "A String", # The input string must have the suffix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc`` + }, + ], + "snis": [ # Optional. A list of SNIs to match against. The match can be one of exact, prefix, suffix, or contains (substring match). If there is no SNI (i.e. plaintext HTTP traffic), the request will be denied. Matches are always case sensitive unless the ignoreCase is set. Limited to 10 SNIs per Authorization Policy. + { # Determines how a string value should be matched. + "contains": "A String", # The input string must have the substring specified here. Note: empty contains match is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc.def`` + "exact": "A String", # The input string must match exactly the string specified here. Examples: * ``abc`` only matches the value ``abc``. + "ignoreCase": True or False, # If true, indicates the exact/prefix/suffix/contains matching should be case insensitive. For example, the matcher ``data`` will match both input string ``Data`` and ``data`` if set to true. + "prefix": "A String", # The input string must have the prefix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``abc.xyz`` + "suffix": "A String", # The input string must have the suffix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc`` + }, + ], + }, + ], + "operations": [ # Optional. Describes properties of one or more targets of a request. At least one of operations or notOperations must be specified. Limited to 1 operation. A match occurs when ANY operation (in operations or notOperations) matches. Within an operation, the match follows AND semantics across fields and OR semantics within a field, i.e. a match occurs when ANY path matches AND ANY header matches and ANY method matches. + { # Describes properties of one or more targets of a request. + "headerSet": { # Describes a set of HTTP headers to match against. # Optional. A list of headers to match against in http header. + "headers": [ # Required. A list of headers to match against in http header. The match can be one of exact, prefix, suffix, or contains (substring match). The match follows AND semantics which means all the headers must match. Matches are always case sensitive unless the ignoreCase is set. Limited to 10 headers per Authorization Policy. + { # Determines how a HTTP header should be matched. + "name": "A String", # Optional. Specifies the name of the header in the request. + "value": { # Determines how a string value should be matched. # Optional. Specifies how the header match will be performed. + "contains": "A String", # The input string must have the substring specified here. Note: empty contains match is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc.def`` + "exact": "A String", # The input string must match exactly the string specified here. Examples: * ``abc`` only matches the value ``abc``. + "ignoreCase": True or False, # If true, indicates the exact/prefix/suffix/contains matching should be case insensitive. For example, the matcher ``data`` will match both input string ``Data`` and ``data`` if set to true. + "prefix": "A String", # The input string must have the prefix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``abc.xyz`` + "suffix": "A String", # The input string must have the suffix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc`` + }, + }, + ], + }, + "hosts": [ # Optional. A list of HTTP Hosts to match against. The match can be one of exact, prefix, suffix, or contains (substring match). Matches are always case sensitive unless the ignoreCase is set. Limited to 10 hosts per Authorization Policy. + { # Determines how a string value should be matched. + "contains": "A String", # The input string must have the substring specified here. Note: empty contains match is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc.def`` + "exact": "A String", # The input string must match exactly the string specified here. Examples: * ``abc`` only matches the value ``abc``. + "ignoreCase": True or False, # If true, indicates the exact/prefix/suffix/contains matching should be case insensitive. For example, the matcher ``data`` will match both input string ``Data`` and ``data`` if set to true. + "prefix": "A String", # The input string must have the prefix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``abc.xyz`` + "suffix": "A String", # The input string must have the suffix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc`` + }, + ], + "mcp": { # Describes a set of MCP protocol attributes to match against for a given MCP request. # Optional. Defines the MCP protocol attributes to match on. If the MCP payload in the request body cannot be successfully parsed, the request will be denied. This field can be set only for AuthzPolicies targeting AgentGateway resources. + "baseProtocolMethodsOption": "A String", # Optional. If specified, matches on the MCP protocol’s non-access specific methods namely: * initialize * completion/ * logging/ * notifications/ * ping Defaults to SKIP_BASE_PROTOCOL_METHODS if not specified. + "methods": [ # Optional. A list of MCP methods and associated parameters to match on. It is recommended to use this field to match on tools, prompts and resource accesses while setting the baseProtocolMethodsOption to MATCH_BASE_PROTOCOL_METHODS to match on all the other MCP protocol methods. Limited to 10 MCP methods per Authorization Policy. + { # Describes a set of MCP methods to match against. + "name": "A String", # Required. The MCP method to match against. Allowed values are as follows: 1. `tools`, `prompts`, `resources` - these will match against all sub methods under the respective methods. 2. `prompts/list`, `tools/list`, `resources/list`, `resources/templates/list` 3. `prompts/get`, `tools/call`, `resources/subscribe`, `resources/unsubscribe`, `resources/read` Params cannot be specified for categories 1 and 2. + "params": [ # Optional. A list of MCP method parameters to match against. The match can be one of exact, prefix, suffix, or contains (substring match). Matches are always case sensitive unless the ignoreCase is set. Limited to 10 MCP method parameters per Authorization Policy. + { # Determines how a string value should be matched. + "contains": "A String", # The input string must have the substring specified here. Note: empty contains match is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc.def`` + "exact": "A String", # The input string must match exactly the string specified here. Examples: * ``abc`` only matches the value ``abc``. + "ignoreCase": True or False, # If true, indicates the exact/prefix/suffix/contains matching should be case insensitive. For example, the matcher ``data`` will match both input string ``Data`` and ``data`` if set to true. + "prefix": "A String", # The input string must have the prefix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``abc.xyz`` + "suffix": "A String", # The input string must have the suffix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc`` + }, + ], + }, + ], + }, + "methods": [ # Optional. A list of HTTP methods to match against. Each entry must be a valid HTTP method name (GET, PUT, POST, HEAD, PATCH, DELETE, OPTIONS). It only allows exact match and is always case sensitive. Limited to 10 methods per Authorization Policy. + "A String", + ], + "paths": [ # Optional. A list of paths to match against. The match can be one of exact, prefix, suffix, or contains (substring match). Matches are always case sensitive unless the ignoreCase is set. Limited to 10 paths per Authorization Policy. Note that this path match includes the query parameters. For gRPC services, this should be a fully-qualified name of the form /package.service/method. + { # Determines how a string value should be matched. + "contains": "A String", # The input string must have the substring specified here. Note: empty contains match is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc.def`` + "exact": "A String", # The input string must match exactly the string specified here. Examples: * ``abc`` only matches the value ``abc``. + "ignoreCase": True or False, # If true, indicates the exact/prefix/suffix/contains matching should be case insensitive. For example, the matcher ``data`` will match both input string ``Data`` and ``data`` if set to true. + "prefix": "A String", # The input string must have the prefix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``abc.xyz`` + "suffix": "A String", # The input string must have the suffix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc`` + }, + ], + "snis": [ # Optional. A list of SNIs to match against. The match can be one of exact, prefix, suffix, or contains (substring match). If there is no SNI (i.e. plaintext HTTP traffic), the request will be denied. Matches are always case sensitive unless the ignoreCase is set. Limited to 10 SNIs per Authorization Policy. + { # Determines how a string value should be matched. + "contains": "A String", # The input string must have the substring specified here. Note: empty contains match is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc.def`` + "exact": "A String", # The input string must match exactly the string specified here. Examples: * ``abc`` only matches the value ``abc``. + "ignoreCase": True or False, # If true, indicates the exact/prefix/suffix/contains matching should be case insensitive. For example, the matcher ``data`` will match both input string ``Data`` and ``data`` if set to true. + "prefix": "A String", # The input string must have the prefix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``abc.xyz`` + "suffix": "A String", # The input string must have the suffix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc`` + }, + ], + }, + ], + }, + "when": "A String", # Optional. CEL expression that describes the conditions to be satisfied for the action. The result of the CEL expression is ANDed with the from and to. Refer to the CEL language reference for a list of available attributes. + }, + ], + "policyProfile": "A String", # Optional. Immutable. Defines the type of authorization being performed. If not specified, `REQUEST_AUTHZ` is applied. This field cannot be changed once AuthzPolicy is created. + "target": { # Specifies the set of targets to which this policy should be applied to. # Required. Specifies the set of resources to which this policy should be applied to. + "loadBalancingScheme": "A String", # Optional. All gateways and forwarding rules referenced by this policy and extensions must share the same load balancing scheme. Required only when targeting forwarding rules. If targeting Secure Web Proxy, this field must be `INTERNAL_MANAGED` or not specified. Must not be specified when targeting Agent Gateway. Supported values: `INTERNAL_MANAGED` and `EXTERNAL_MANAGED`. For more information, refer to [Backend services overview](https://cloud.google.com/load-balancing/docs/backend-service). + "resources": [ # Required. A list of references to the Forwarding Rules, Secure Web Proxy Gateways, or Agent Gateways on which this policy will be applied. + "A String", + ], + }, + "updateTime": "A String", # Output only. The timestamp when the resource was updated. +}
+
+ +
getIamPolicy(resource, options_requestedPolicyVersion=None, x__xgafv=None)
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
 
@@ -729,8 +1195,227 @@ 

Method Details

"cloudIap": { # Optional. Delegates authorization decisions to Cloud IAP. Applicable only for managed load balancers. Enabling Cloud IAP at the AuthzPolicy level is not compatible with Cloud IAP settings in the BackendService. Enabling IAP in both places will result in request failure. Ensure that IAP is enabled in either the AuthzPolicy or the BackendService but not in both places. # Optional. Delegates authorization decisions to Cloud IAP. Applicable only for managed load balancers. Enabling Cloud IAP at the AuthzPolicy level is not compatible with Cloud IAP settings in the BackendService. Enabling IAP in both places will result in request failure. Ensure that IAP is enabled in either the AuthzPolicy or the BackendService but not in both places. }, }, - "description": "A String", # Optional. A human-readable description of the resource. - "httpRules": [ # Optional. A list of authorization HTTP rules to match against the incoming request. A policy match occurs when at least one HTTP rule matches the request or when no HTTP rules are specified in the policy. At least one HTTP Rule is required for Allow or Deny Action. Limited to 5 rules. + "description": "A String", # Optional. A human-readable description of the resource. + "httpRules": [ # Optional. A list of authorization HTTP rules to match against the incoming request. A policy match occurs when at least one HTTP rule matches the request or when no HTTP rules are specified in the policy. At least one HTTP Rule is required for Allow or Deny Action. Limited to 5 rules. + { # Conditions to match against the incoming request. + "from": { # Describes properties of one or more sources of a request. # Optional. Describes properties of a source of a request. + "notSources": [ # Optional. Describes the negated properties of request sources. Matches requests from sources that do not match the criteria specified in this field. At least one of sources or notSources must be specified. + { # Describes the properties of a single source. + "ipBlocks": [ # Optional. A list of IP addresses or IP address ranges to match against the source IP address of the request. Limited to 10 ip_blocks per Authorization Policy + { # Represents a range of IP Addresses. + "length": 42, # Required. The length of the address range. + "prefix": "A String", # Required. The address prefix. + }, + ], + "principals": [ # Optional. A list of identities derived from the client's certificate. This field will not match on a request unless frontend mutual TLS is enabled for the forwarding rule or Gateway and the client certificate has been successfully validated by mTLS. Each identity is a string whose value is matched against a list of URI SANs, DNS Name SANs, or the common name in the client's certificate. A match happens when any principal matches with the rule. Limited to 50 principals per Authorization Policy for regional internal Application Load Balancers, regional external Application Load Balancers, cross-region internal Application Load Balancers, and Cloud Service Mesh. This field is not supported for global external Application Load Balancers. + { # Describes the properties of a principal to be matched against. + "principal": { # Determines how a string value should be matched. # Required. A non-empty string whose value is matched against the principal value based on the principal_selector. Only exact match can be applied for CLIENT_CERT_URI_SAN, CLIENT_CERT_DNS_NAME_SAN, CLIENT_CERT_COMMON_NAME selectors. + "contains": "A String", # The input string must have the substring specified here. Note: empty contains match is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc.def`` + "exact": "A String", # The input string must match exactly the string specified here. Examples: * ``abc`` only matches the value ``abc``. + "ignoreCase": True or False, # If true, indicates the exact/prefix/suffix/contains matching should be case insensitive. For example, the matcher ``data`` will match both input string ``Data`` and ``data`` if set to true. + "prefix": "A String", # The input string must have the prefix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``abc.xyz`` + "suffix": "A String", # The input string must have the suffix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc`` + }, + "principalSelector": "A String", # Optional. An enum to decide what principal value the principal rule will match against. If not specified, the PrincipalSelector is CLIENT_CERT_URI_SAN. + }, + ], + "resources": [ # Optional. A list of resources to match against the resource of the source VM of a request. Limited to 10 resources per Authorization Policy. + { # Describes the properties of a client VM resource accessing the internal application load balancers. + "iamServiceAccount": { # Determines how a string value should be matched. # Optional. An IAM service account to match against the source service account of the VM sending the request. + "contains": "A String", # The input string must have the substring specified here. Note: empty contains match is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc.def`` + "exact": "A String", # The input string must match exactly the string specified here. Examples: * ``abc`` only matches the value ``abc``. + "ignoreCase": True or False, # If true, indicates the exact/prefix/suffix/contains matching should be case insensitive. For example, the matcher ``data`` will match both input string ``Data`` and ``data`` if set to true. + "prefix": "A String", # The input string must have the prefix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``abc.xyz`` + "suffix": "A String", # The input string must have the suffix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc`` + }, + "tagValueIdSet": { # Describes a set of resource tag value permanent IDs to match against the resource manager tags value associated with the source VM of a request. # Optional. A list of resource tag value permanent IDs to match against the resource manager tags value associated with the source VM of a request. + "ids": [ # Required. A list of resource tag value permanent IDs to match against the resource manager tags value associated with the source VM of a request. The match follows AND semantics which means all the ids must match. Limited to 5 ids in the Tag value id set. + "A String", + ], + }, + }, + ], + }, + ], + "sources": [ # Optional. Describes the properties of a request's sources. At least one of sources or notSources must be specified. Limited to 1 source. A match occurs when ANY source (in sources or notSources) matches the request. Within a single source, the match follows AND semantics across fields and OR semantics within a single field, i.e. a match occurs when ANY principal matches AND ANY ipBlocks match. + { # Describes the properties of a single source. + "ipBlocks": [ # Optional. A list of IP addresses or IP address ranges to match against the source IP address of the request. Limited to 10 ip_blocks per Authorization Policy + { # Represents a range of IP Addresses. + "length": 42, # Required. The length of the address range. + "prefix": "A String", # Required. The address prefix. + }, + ], + "principals": [ # Optional. A list of identities derived from the client's certificate. This field will not match on a request unless frontend mutual TLS is enabled for the forwarding rule or Gateway and the client certificate has been successfully validated by mTLS. Each identity is a string whose value is matched against a list of URI SANs, DNS Name SANs, or the common name in the client's certificate. A match happens when any principal matches with the rule. Limited to 50 principals per Authorization Policy for regional internal Application Load Balancers, regional external Application Load Balancers, cross-region internal Application Load Balancers, and Cloud Service Mesh. This field is not supported for global external Application Load Balancers. + { # Describes the properties of a principal to be matched against. + "principal": { # Determines how a string value should be matched. # Required. A non-empty string whose value is matched against the principal value based on the principal_selector. Only exact match can be applied for CLIENT_CERT_URI_SAN, CLIENT_CERT_DNS_NAME_SAN, CLIENT_CERT_COMMON_NAME selectors. + "contains": "A String", # The input string must have the substring specified here. Note: empty contains match is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc.def`` + "exact": "A String", # The input string must match exactly the string specified here. Examples: * ``abc`` only matches the value ``abc``. + "ignoreCase": True or False, # If true, indicates the exact/prefix/suffix/contains matching should be case insensitive. For example, the matcher ``data`` will match both input string ``Data`` and ``data`` if set to true. + "prefix": "A String", # The input string must have the prefix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``abc.xyz`` + "suffix": "A String", # The input string must have the suffix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc`` + }, + "principalSelector": "A String", # Optional. An enum to decide what principal value the principal rule will match against. If not specified, the PrincipalSelector is CLIENT_CERT_URI_SAN. + }, + ], + "resources": [ # Optional. A list of resources to match against the resource of the source VM of a request. Limited to 10 resources per Authorization Policy. + { # Describes the properties of a client VM resource accessing the internal application load balancers. + "iamServiceAccount": { # Determines how a string value should be matched. # Optional. An IAM service account to match against the source service account of the VM sending the request. + "contains": "A String", # The input string must have the substring specified here. Note: empty contains match is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc.def`` + "exact": "A String", # The input string must match exactly the string specified here. Examples: * ``abc`` only matches the value ``abc``. + "ignoreCase": True or False, # If true, indicates the exact/prefix/suffix/contains matching should be case insensitive. For example, the matcher ``data`` will match both input string ``Data`` and ``data`` if set to true. + "prefix": "A String", # The input string must have the prefix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``abc.xyz`` + "suffix": "A String", # The input string must have the suffix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc`` + }, + "tagValueIdSet": { # Describes a set of resource tag value permanent IDs to match against the resource manager tags value associated with the source VM of a request. # Optional. A list of resource tag value permanent IDs to match against the resource manager tags value associated with the source VM of a request. + "ids": [ # Required. A list of resource tag value permanent IDs to match against the resource manager tags value associated with the source VM of a request. The match follows AND semantics which means all the ids must match. Limited to 5 ids in the Tag value id set. + "A String", + ], + }, + }, + ], + }, + ], + }, + "to": { # Describes properties of one or more targets of a request. # Optional. Describes properties of a target of a request. + "notOperations": [ # Optional. Describes the negated properties of the targets of a request. Matches requests for operations that do not match the criteria specified in this field. At least one of operations or notOperations must be specified. + { # Describes properties of one or more targets of a request. + "headerSet": { # Describes a set of HTTP headers to match against. # Optional. A list of headers to match against in http header. + "headers": [ # Required. A list of headers to match against in http header. The match can be one of exact, prefix, suffix, or contains (substring match). The match follows AND semantics which means all the headers must match. Matches are always case sensitive unless the ignoreCase is set. Limited to 10 headers per Authorization Policy. + { # Determines how a HTTP header should be matched. + "name": "A String", # Optional. Specifies the name of the header in the request. + "value": { # Determines how a string value should be matched. # Optional. Specifies how the header match will be performed. + "contains": "A String", # The input string must have the substring specified here. Note: empty contains match is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc.def`` + "exact": "A String", # The input string must match exactly the string specified here. Examples: * ``abc`` only matches the value ``abc``. + "ignoreCase": True or False, # If true, indicates the exact/prefix/suffix/contains matching should be case insensitive. For example, the matcher ``data`` will match both input string ``Data`` and ``data`` if set to true. + "prefix": "A String", # The input string must have the prefix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``abc.xyz`` + "suffix": "A String", # The input string must have the suffix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc`` + }, + }, + ], + }, + "hosts": [ # Optional. A list of HTTP Hosts to match against. The match can be one of exact, prefix, suffix, or contains (substring match). Matches are always case sensitive unless the ignoreCase is set. Limited to 10 hosts per Authorization Policy. + { # Determines how a string value should be matched. + "contains": "A String", # The input string must have the substring specified here. Note: empty contains match is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc.def`` + "exact": "A String", # The input string must match exactly the string specified here. Examples: * ``abc`` only matches the value ``abc``. + "ignoreCase": True or False, # If true, indicates the exact/prefix/suffix/contains matching should be case insensitive. For example, the matcher ``data`` will match both input string ``Data`` and ``data`` if set to true. + "prefix": "A String", # The input string must have the prefix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``abc.xyz`` + "suffix": "A String", # The input string must have the suffix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc`` + }, + ], + "mcp": { # Describes a set of MCP protocol attributes to match against for a given MCP request. # Optional. Defines the MCP protocol attributes to match on. If the MCP payload in the request body cannot be successfully parsed, the request will be denied. This field can be set only for AuthzPolicies targeting AgentGateway resources. + "baseProtocolMethodsOption": "A String", # Optional. If specified, matches on the MCP protocol’s non-access specific methods namely: * initialize * completion/ * logging/ * notifications/ * ping Defaults to SKIP_BASE_PROTOCOL_METHODS if not specified. + "methods": [ # Optional. A list of MCP methods and associated parameters to match on. It is recommended to use this field to match on tools, prompts and resource accesses while setting the baseProtocolMethodsOption to MATCH_BASE_PROTOCOL_METHODS to match on all the other MCP protocol methods. Limited to 10 MCP methods per Authorization Policy. + { # Describes a set of MCP methods to match against. + "name": "A String", # Required. The MCP method to match against. Allowed values are as follows: 1. `tools`, `prompts`, `resources` - these will match against all sub methods under the respective methods. 2. `prompts/list`, `tools/list`, `resources/list`, `resources/templates/list` 3. `prompts/get`, `tools/call`, `resources/subscribe`, `resources/unsubscribe`, `resources/read` Params cannot be specified for categories 1 and 2. + "params": [ # Optional. A list of MCP method parameters to match against. The match can be one of exact, prefix, suffix, or contains (substring match). Matches are always case sensitive unless the ignoreCase is set. Limited to 10 MCP method parameters per Authorization Policy. + { # Determines how a string value should be matched. + "contains": "A String", # The input string must have the substring specified here. Note: empty contains match is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc.def`` + "exact": "A String", # The input string must match exactly the string specified here. Examples: * ``abc`` only matches the value ``abc``. + "ignoreCase": True or False, # If true, indicates the exact/prefix/suffix/contains matching should be case insensitive. For example, the matcher ``data`` will match both input string ``Data`` and ``data`` if set to true. + "prefix": "A String", # The input string must have the prefix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``abc.xyz`` + "suffix": "A String", # The input string must have the suffix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc`` + }, + ], + }, + ], + }, + "methods": [ # Optional. A list of HTTP methods to match against. Each entry must be a valid HTTP method name (GET, PUT, POST, HEAD, PATCH, DELETE, OPTIONS). It only allows exact match and is always case sensitive. Limited to 10 methods per Authorization Policy. + "A String", + ], + "paths": [ # Optional. A list of paths to match against. The match can be one of exact, prefix, suffix, or contains (substring match). Matches are always case sensitive unless the ignoreCase is set. Limited to 10 paths per Authorization Policy. Note that this path match includes the query parameters. For gRPC services, this should be a fully-qualified name of the form /package.service/method. + { # Determines how a string value should be matched. + "contains": "A String", # The input string must have the substring specified here. Note: empty contains match is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc.def`` + "exact": "A String", # The input string must match exactly the string specified here. Examples: * ``abc`` only matches the value ``abc``. + "ignoreCase": True or False, # If true, indicates the exact/prefix/suffix/contains matching should be case insensitive. For example, the matcher ``data`` will match both input string ``Data`` and ``data`` if set to true. + "prefix": "A String", # The input string must have the prefix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``abc.xyz`` + "suffix": "A String", # The input string must have the suffix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc`` + }, + ], + "snis": [ # Optional. A list of SNIs to match against. The match can be one of exact, prefix, suffix, or contains (substring match). If there is no SNI (i.e. plaintext HTTP traffic), the request will be denied. Matches are always case sensitive unless the ignoreCase is set. Limited to 10 SNIs per Authorization Policy. + { # Determines how a string value should be matched. + "contains": "A String", # The input string must have the substring specified here. Note: empty contains match is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc.def`` + "exact": "A String", # The input string must match exactly the string specified here. Examples: * ``abc`` only matches the value ``abc``. + "ignoreCase": True or False, # If true, indicates the exact/prefix/suffix/contains matching should be case insensitive. For example, the matcher ``data`` will match both input string ``Data`` and ``data`` if set to true. + "prefix": "A String", # The input string must have the prefix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``abc.xyz`` + "suffix": "A String", # The input string must have the suffix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc`` + }, + ], + }, + ], + "operations": [ # Optional. Describes properties of one or more targets of a request. At least one of operations or notOperations must be specified. Limited to 1 operation. A match occurs when ANY operation (in operations or notOperations) matches. Within an operation, the match follows AND semantics across fields and OR semantics within a field, i.e. a match occurs when ANY path matches AND ANY header matches and ANY method matches. + { # Describes properties of one or more targets of a request. + "headerSet": { # Describes a set of HTTP headers to match against. # Optional. A list of headers to match against in http header. + "headers": [ # Required. A list of headers to match against in http header. The match can be one of exact, prefix, suffix, or contains (substring match). The match follows AND semantics which means all the headers must match. Matches are always case sensitive unless the ignoreCase is set. Limited to 10 headers per Authorization Policy. + { # Determines how a HTTP header should be matched. + "name": "A String", # Optional. Specifies the name of the header in the request. + "value": { # Determines how a string value should be matched. # Optional. Specifies how the header match will be performed. + "contains": "A String", # The input string must have the substring specified here. Note: empty contains match is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc.def`` + "exact": "A String", # The input string must match exactly the string specified here. Examples: * ``abc`` only matches the value ``abc``. + "ignoreCase": True or False, # If true, indicates the exact/prefix/suffix/contains matching should be case insensitive. For example, the matcher ``data`` will match both input string ``Data`` and ``data`` if set to true. + "prefix": "A String", # The input string must have the prefix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``abc.xyz`` + "suffix": "A String", # The input string must have the suffix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc`` + }, + }, + ], + }, + "hosts": [ # Optional. A list of HTTP Hosts to match against. The match can be one of exact, prefix, suffix, or contains (substring match). Matches are always case sensitive unless the ignoreCase is set. Limited to 10 hosts per Authorization Policy. + { # Determines how a string value should be matched. + "contains": "A String", # The input string must have the substring specified here. Note: empty contains match is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc.def`` + "exact": "A String", # The input string must match exactly the string specified here. Examples: * ``abc`` only matches the value ``abc``. + "ignoreCase": True or False, # If true, indicates the exact/prefix/suffix/contains matching should be case insensitive. For example, the matcher ``data`` will match both input string ``Data`` and ``data`` if set to true. + "prefix": "A String", # The input string must have the prefix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``abc.xyz`` + "suffix": "A String", # The input string must have the suffix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc`` + }, + ], + "mcp": { # Describes a set of MCP protocol attributes to match against for a given MCP request. # Optional. Defines the MCP protocol attributes to match on. If the MCP payload in the request body cannot be successfully parsed, the request will be denied. This field can be set only for AuthzPolicies targeting AgentGateway resources. + "baseProtocolMethodsOption": "A String", # Optional. If specified, matches on the MCP protocol’s non-access specific methods namely: * initialize * completion/ * logging/ * notifications/ * ping Defaults to SKIP_BASE_PROTOCOL_METHODS if not specified. + "methods": [ # Optional. A list of MCP methods and associated parameters to match on. It is recommended to use this field to match on tools, prompts and resource accesses while setting the baseProtocolMethodsOption to MATCH_BASE_PROTOCOL_METHODS to match on all the other MCP protocol methods. Limited to 10 MCP methods per Authorization Policy. + { # Describes a set of MCP methods to match against. + "name": "A String", # Required. The MCP method to match against. Allowed values are as follows: 1. `tools`, `prompts`, `resources` - these will match against all sub methods under the respective methods. 2. `prompts/list`, `tools/list`, `resources/list`, `resources/templates/list` 3. `prompts/get`, `tools/call`, `resources/subscribe`, `resources/unsubscribe`, `resources/read` Params cannot be specified for categories 1 and 2. + "params": [ # Optional. A list of MCP method parameters to match against. The match can be one of exact, prefix, suffix, or contains (substring match). Matches are always case sensitive unless the ignoreCase is set. Limited to 10 MCP method parameters per Authorization Policy. + { # Determines how a string value should be matched. + "contains": "A String", # The input string must have the substring specified here. Note: empty contains match is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc.def`` + "exact": "A String", # The input string must match exactly the string specified here. Examples: * ``abc`` only matches the value ``abc``. + "ignoreCase": True or False, # If true, indicates the exact/prefix/suffix/contains matching should be case insensitive. For example, the matcher ``data`` will match both input string ``Data`` and ``data`` if set to true. + "prefix": "A String", # The input string must have the prefix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``abc.xyz`` + "suffix": "A String", # The input string must have the suffix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc`` + }, + ], + }, + ], + }, + "methods": [ # Optional. A list of HTTP methods to match against. Each entry must be a valid HTTP method name (GET, PUT, POST, HEAD, PATCH, DELETE, OPTIONS). It only allows exact match and is always case sensitive. Limited to 10 methods per Authorization Policy. + "A String", + ], + "paths": [ # Optional. A list of paths to match against. The match can be one of exact, prefix, suffix, or contains (substring match). Matches are always case sensitive unless the ignoreCase is set. Limited to 10 paths per Authorization Policy. Note that this path match includes the query parameters. For gRPC services, this should be a fully-qualified name of the form /package.service/method. + { # Determines how a string value should be matched. + "contains": "A String", # The input string must have the substring specified here. Note: empty contains match is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc.def`` + "exact": "A String", # The input string must match exactly the string specified here. Examples: * ``abc`` only matches the value ``abc``. + "ignoreCase": True or False, # If true, indicates the exact/prefix/suffix/contains matching should be case insensitive. For example, the matcher ``data`` will match both input string ``Data`` and ``data`` if set to true. + "prefix": "A String", # The input string must have the prefix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``abc.xyz`` + "suffix": "A String", # The input string must have the suffix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc`` + }, + ], + "snis": [ # Optional. A list of SNIs to match against. The match can be one of exact, prefix, suffix, or contains (substring match). If there is no SNI (i.e. plaintext HTTP traffic), the request will be denied. Matches are always case sensitive unless the ignoreCase is set. Limited to 10 SNIs per Authorization Policy. + { # Determines how a string value should be matched. + "contains": "A String", # The input string must have the substring specified here. Note: empty contains match is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc.def`` + "exact": "A String", # The input string must match exactly the string specified here. Examples: * ``abc`` only matches the value ``abc``. + "ignoreCase": True or False, # If true, indicates the exact/prefix/suffix/contains matching should be case insensitive. For example, the matcher ``data`` will match both input string ``Data`` and ``data`` if set to true. + "prefix": "A String", # The input string must have the prefix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``abc.xyz`` + "suffix": "A String", # The input string must have the suffix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc`` + }, + ], + }, + ], + }, + "when": "A String", # Optional. CEL expression that describes the conditions to be satisfied for the action. The result of the CEL expression is ANDed with the from and to. Refer to the CEL language reference for a list of available attributes. + }, + ], + "labels": { # Optional. Set of labels associated with the `AuthzPolicy` resource. The format must comply with [the following requirements](/compute/docs/labeling-resources#requirements). + "a_key": "A String", + }, + "name": "A String", # Required. Identifier. Name of the `AuthzPolicy` resource in the following format: `projects/{project}/locations/{location}/authzPolicies/{authz_policy}`. + "networkRules": [ # Optional. A list of authorization network rules to match against the incoming request. A policy match occurs when at least one network rule matches the request. At least one network rule is required for Allow or Deny Action if no HTTP rules are provided. Network rules are mutually exclusive with HTTP rules. Limited to 5 rules. { # Conditions to match against the incoming request. "from": { # Describes properties of one or more sources of a request. # Optional. Describes properties of a source of a request. "notSources": [ # Optional. Describes the negated properties of request sources. Matches requests from sources that do not match the criteria specified in this field. At least one of sources or notSources must be specified. @@ -865,6 +1550,15 @@

Method Details

"suffix": "A String", # The input string must have the suffix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc`` }, ], + "snis": [ # Optional. A list of SNIs to match against. The match can be one of exact, prefix, suffix, or contains (substring match). If there is no SNI (i.e. plaintext HTTP traffic), the request will be denied. Matches are always case sensitive unless the ignoreCase is set. Limited to 10 SNIs per Authorization Policy. + { # Determines how a string value should be matched. + "contains": "A String", # The input string must have the substring specified here. Note: empty contains match is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc.def`` + "exact": "A String", # The input string must match exactly the string specified here. Examples: * ``abc`` only matches the value ``abc``. + "ignoreCase": True or False, # If true, indicates the exact/prefix/suffix/contains matching should be case insensitive. For example, the matcher ``data`` will match both input string ``Data`` and ``data`` if set to true. + "prefix": "A String", # The input string must have the prefix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``abc.xyz`` + "suffix": "A String", # The input string must have the suffix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc`` + }, + ], }, ], "operations": [ # Optional. Describes properties of one or more targets of a request. At least one of operations or notOperations must be specified. Limited to 1 operation. A match occurs when ANY operation (in operations or notOperations) matches. Within an operation, the match follows AND semantics across fields and OR semantics within a field, i.e. a match occurs when ANY path matches AND ANY header matches and ANY method matches. @@ -921,16 +1615,21 @@

Method Details

"suffix": "A String", # The input string must have the suffix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc`` }, ], + "snis": [ # Optional. A list of SNIs to match against. The match can be one of exact, prefix, suffix, or contains (substring match). If there is no SNI (i.e. plaintext HTTP traffic), the request will be denied. Matches are always case sensitive unless the ignoreCase is set. Limited to 10 SNIs per Authorization Policy. + { # Determines how a string value should be matched. + "contains": "A String", # The input string must have the substring specified here. Note: empty contains match is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc.def`` + "exact": "A String", # The input string must match exactly the string specified here. Examples: * ``abc`` only matches the value ``abc``. + "ignoreCase": True or False, # If true, indicates the exact/prefix/suffix/contains matching should be case insensitive. For example, the matcher ``data`` will match both input string ``Data`` and ``data`` if set to true. + "prefix": "A String", # The input string must have the prefix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``abc.xyz`` + "suffix": "A String", # The input string must have the suffix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc`` + }, + ], }, ], }, "when": "A String", # Optional. CEL expression that describes the conditions to be satisfied for the action. The result of the CEL expression is ANDed with the from and to. Refer to the CEL language reference for a list of available attributes. }, ], - "labels": { # Optional. Set of labels associated with the `AuthzPolicy` resource. The format must comply with [the following requirements](/compute/docs/labeling-resources#requirements). - "a_key": "A String", - }, - "name": "A String", # Required. Identifier. Name of the `AuthzPolicy` resource in the following format: `projects/{project}/locations/{location}/authzPolicies/{authz_policy}`. "policyProfile": "A String", # Optional. Immutable. Defines the type of authorization being performed. If not specified, `REQUEST_AUTHZ` is applied. This field cannot be changed once AuthzPolicy is created. "target": { # Specifies the set of targets to which this policy should be applied to. # Required. Specifies the set of resources to which this policy should be applied to. "loadBalancingScheme": "A String", # Optional. All gateways and forwarding rules referenced by this policy and extensions must share the same load balancing scheme. Required only when targeting forwarding rules. If targeting Secure Web Proxy, this field must be `INTERNAL_MANAGED` or not specified. Must not be specified when targeting Agent Gateway. Supported values: `INTERNAL_MANAGED` and `EXTERNAL_MANAGED`. For more information, refer to [Backend services overview](https://cloud.google.com/load-balancing/docs/backend-service). @@ -1119,6 +1818,15 @@

Method Details

"suffix": "A String", # The input string must have the suffix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc`` }, ], + "snis": [ # Optional. A list of SNIs to match against. The match can be one of exact, prefix, suffix, or contains (substring match). If there is no SNI (i.e. plaintext HTTP traffic), the request will be denied. Matches are always case sensitive unless the ignoreCase is set. Limited to 10 SNIs per Authorization Policy. + { # Determines how a string value should be matched. + "contains": "A String", # The input string must have the substring specified here. Note: empty contains match is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc.def`` + "exact": "A String", # The input string must match exactly the string specified here. Examples: * ``abc`` only matches the value ``abc``. + "ignoreCase": True or False, # If true, indicates the exact/prefix/suffix/contains matching should be case insensitive. For example, the matcher ``data`` will match both input string ``Data`` and ``data`` if set to true. + "prefix": "A String", # The input string must have the prefix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``abc.xyz`` + "suffix": "A String", # The input string must have the suffix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc`` + }, + ], }, ], "operations": [ # Optional. Describes properties of one or more targets of a request. At least one of operations or notOperations must be specified. Limited to 1 operation. A match occurs when ANY operation (in operations or notOperations) matches. Within an operation, the match follows AND semantics across fields and OR semantics within a field, i.e. a match occurs when ANY path matches AND ANY header matches and ANY method matches. @@ -1175,6 +1883,15 @@

Method Details

"suffix": "A String", # The input string must have the suffix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc`` }, ], + "snis": [ # Optional. A list of SNIs to match against. The match can be one of exact, prefix, suffix, or contains (substring match). If there is no SNI (i.e. plaintext HTTP traffic), the request will be denied. Matches are always case sensitive unless the ignoreCase is set. Limited to 10 SNIs per Authorization Policy. + { # Determines how a string value should be matched. + "contains": "A String", # The input string must have the substring specified here. Note: empty contains match is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc.def`` + "exact": "A String", # The input string must match exactly the string specified here. Examples: * ``abc`` only matches the value ``abc``. + "ignoreCase": True or False, # If true, indicates the exact/prefix/suffix/contains matching should be case insensitive. For example, the matcher ``data`` will match both input string ``Data`` and ``data`` if set to true. + "prefix": "A String", # The input string must have the prefix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``abc.xyz`` + "suffix": "A String", # The input string must have the suffix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc`` + }, + ], }, ], }, @@ -1185,6 +1902,221 @@

Method Details

"a_key": "A String", }, "name": "A String", # Required. Identifier. Name of the `AuthzPolicy` resource in the following format: `projects/{project}/locations/{location}/authzPolicies/{authz_policy}`. + "networkRules": [ # Optional. A list of authorization network rules to match against the incoming request. A policy match occurs when at least one network rule matches the request. At least one network rule is required for Allow or Deny Action if no HTTP rules are provided. Network rules are mutually exclusive with HTTP rules. Limited to 5 rules. + { # Conditions to match against the incoming request. + "from": { # Describes properties of one or more sources of a request. # Optional. Describes properties of a source of a request. + "notSources": [ # Optional. Describes the negated properties of request sources. Matches requests from sources that do not match the criteria specified in this field. At least one of sources or notSources must be specified. + { # Describes the properties of a single source. + "ipBlocks": [ # Optional. A list of IP addresses or IP address ranges to match against the source IP address of the request. Limited to 10 ip_blocks per Authorization Policy + { # Represents a range of IP Addresses. + "length": 42, # Required. The length of the address range. + "prefix": "A String", # Required. The address prefix. + }, + ], + "principals": [ # Optional. A list of identities derived from the client's certificate. This field will not match on a request unless frontend mutual TLS is enabled for the forwarding rule or Gateway and the client certificate has been successfully validated by mTLS. Each identity is a string whose value is matched against a list of URI SANs, DNS Name SANs, or the common name in the client's certificate. A match happens when any principal matches with the rule. Limited to 50 principals per Authorization Policy for regional internal Application Load Balancers, regional external Application Load Balancers, cross-region internal Application Load Balancers, and Cloud Service Mesh. This field is not supported for global external Application Load Balancers. + { # Describes the properties of a principal to be matched against. + "principal": { # Determines how a string value should be matched. # Required. A non-empty string whose value is matched against the principal value based on the principal_selector. Only exact match can be applied for CLIENT_CERT_URI_SAN, CLIENT_CERT_DNS_NAME_SAN, CLIENT_CERT_COMMON_NAME selectors. + "contains": "A String", # The input string must have the substring specified here. Note: empty contains match is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc.def`` + "exact": "A String", # The input string must match exactly the string specified here. Examples: * ``abc`` only matches the value ``abc``. + "ignoreCase": True or False, # If true, indicates the exact/prefix/suffix/contains matching should be case insensitive. For example, the matcher ``data`` will match both input string ``Data`` and ``data`` if set to true. + "prefix": "A String", # The input string must have the prefix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``abc.xyz`` + "suffix": "A String", # The input string must have the suffix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc`` + }, + "principalSelector": "A String", # Optional. An enum to decide what principal value the principal rule will match against. If not specified, the PrincipalSelector is CLIENT_CERT_URI_SAN. + }, + ], + "resources": [ # Optional. A list of resources to match against the resource of the source VM of a request. Limited to 10 resources per Authorization Policy. + { # Describes the properties of a client VM resource accessing the internal application load balancers. + "iamServiceAccount": { # Determines how a string value should be matched. # Optional. An IAM service account to match against the source service account of the VM sending the request. + "contains": "A String", # The input string must have the substring specified here. Note: empty contains match is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc.def`` + "exact": "A String", # The input string must match exactly the string specified here. Examples: * ``abc`` only matches the value ``abc``. + "ignoreCase": True or False, # If true, indicates the exact/prefix/suffix/contains matching should be case insensitive. For example, the matcher ``data`` will match both input string ``Data`` and ``data`` if set to true. + "prefix": "A String", # The input string must have the prefix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``abc.xyz`` + "suffix": "A String", # The input string must have the suffix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc`` + }, + "tagValueIdSet": { # Describes a set of resource tag value permanent IDs to match against the resource manager tags value associated with the source VM of a request. # Optional. A list of resource tag value permanent IDs to match against the resource manager tags value associated with the source VM of a request. + "ids": [ # Required. A list of resource tag value permanent IDs to match against the resource manager tags value associated with the source VM of a request. The match follows AND semantics which means all the ids must match. Limited to 5 ids in the Tag value id set. + "A String", + ], + }, + }, + ], + }, + ], + "sources": [ # Optional. Describes the properties of a request's sources. At least one of sources or notSources must be specified. Limited to 1 source. A match occurs when ANY source (in sources or notSources) matches the request. Within a single source, the match follows AND semantics across fields and OR semantics within a single field, i.e. a match occurs when ANY principal matches AND ANY ipBlocks match. + { # Describes the properties of a single source. + "ipBlocks": [ # Optional. A list of IP addresses or IP address ranges to match against the source IP address of the request. Limited to 10 ip_blocks per Authorization Policy + { # Represents a range of IP Addresses. + "length": 42, # Required. The length of the address range. + "prefix": "A String", # Required. The address prefix. + }, + ], + "principals": [ # Optional. A list of identities derived from the client's certificate. This field will not match on a request unless frontend mutual TLS is enabled for the forwarding rule or Gateway and the client certificate has been successfully validated by mTLS. Each identity is a string whose value is matched against a list of URI SANs, DNS Name SANs, or the common name in the client's certificate. A match happens when any principal matches with the rule. Limited to 50 principals per Authorization Policy for regional internal Application Load Balancers, regional external Application Load Balancers, cross-region internal Application Load Balancers, and Cloud Service Mesh. This field is not supported for global external Application Load Balancers. + { # Describes the properties of a principal to be matched against. + "principal": { # Determines how a string value should be matched. # Required. A non-empty string whose value is matched against the principal value based on the principal_selector. Only exact match can be applied for CLIENT_CERT_URI_SAN, CLIENT_CERT_DNS_NAME_SAN, CLIENT_CERT_COMMON_NAME selectors. + "contains": "A String", # The input string must have the substring specified here. Note: empty contains match is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc.def`` + "exact": "A String", # The input string must match exactly the string specified here. Examples: * ``abc`` only matches the value ``abc``. + "ignoreCase": True or False, # If true, indicates the exact/prefix/suffix/contains matching should be case insensitive. For example, the matcher ``data`` will match both input string ``Data`` and ``data`` if set to true. + "prefix": "A String", # The input string must have the prefix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``abc.xyz`` + "suffix": "A String", # The input string must have the suffix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc`` + }, + "principalSelector": "A String", # Optional. An enum to decide what principal value the principal rule will match against. If not specified, the PrincipalSelector is CLIENT_CERT_URI_SAN. + }, + ], + "resources": [ # Optional. A list of resources to match against the resource of the source VM of a request. Limited to 10 resources per Authorization Policy. + { # Describes the properties of a client VM resource accessing the internal application load balancers. + "iamServiceAccount": { # Determines how a string value should be matched. # Optional. An IAM service account to match against the source service account of the VM sending the request. + "contains": "A String", # The input string must have the substring specified here. Note: empty contains match is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc.def`` + "exact": "A String", # The input string must match exactly the string specified here. Examples: * ``abc`` only matches the value ``abc``. + "ignoreCase": True or False, # If true, indicates the exact/prefix/suffix/contains matching should be case insensitive. For example, the matcher ``data`` will match both input string ``Data`` and ``data`` if set to true. + "prefix": "A String", # The input string must have the prefix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``abc.xyz`` + "suffix": "A String", # The input string must have the suffix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc`` + }, + "tagValueIdSet": { # Describes a set of resource tag value permanent IDs to match against the resource manager tags value associated with the source VM of a request. # Optional. A list of resource tag value permanent IDs to match against the resource manager tags value associated with the source VM of a request. + "ids": [ # Required. A list of resource tag value permanent IDs to match against the resource manager tags value associated with the source VM of a request. The match follows AND semantics which means all the ids must match. Limited to 5 ids in the Tag value id set. + "A String", + ], + }, + }, + ], + }, + ], + }, + "to": { # Describes properties of one or more targets of a request. # Optional. Describes properties of a target of a request. + "notOperations": [ # Optional. Describes the negated properties of the targets of a request. Matches requests for operations that do not match the criteria specified in this field. At least one of operations or notOperations must be specified. + { # Describes properties of one or more targets of a request. + "headerSet": { # Describes a set of HTTP headers to match against. # Optional. A list of headers to match against in http header. + "headers": [ # Required. A list of headers to match against in http header. The match can be one of exact, prefix, suffix, or contains (substring match). The match follows AND semantics which means all the headers must match. Matches are always case sensitive unless the ignoreCase is set. Limited to 10 headers per Authorization Policy. + { # Determines how a HTTP header should be matched. + "name": "A String", # Optional. Specifies the name of the header in the request. + "value": { # Determines how a string value should be matched. # Optional. Specifies how the header match will be performed. + "contains": "A String", # The input string must have the substring specified here. Note: empty contains match is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc.def`` + "exact": "A String", # The input string must match exactly the string specified here. Examples: * ``abc`` only matches the value ``abc``. + "ignoreCase": True or False, # If true, indicates the exact/prefix/suffix/contains matching should be case insensitive. For example, the matcher ``data`` will match both input string ``Data`` and ``data`` if set to true. + "prefix": "A String", # The input string must have the prefix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``abc.xyz`` + "suffix": "A String", # The input string must have the suffix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc`` + }, + }, + ], + }, + "hosts": [ # Optional. A list of HTTP Hosts to match against. The match can be one of exact, prefix, suffix, or contains (substring match). Matches are always case sensitive unless the ignoreCase is set. Limited to 10 hosts per Authorization Policy. + { # Determines how a string value should be matched. + "contains": "A String", # The input string must have the substring specified here. Note: empty contains match is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc.def`` + "exact": "A String", # The input string must match exactly the string specified here. Examples: * ``abc`` only matches the value ``abc``. + "ignoreCase": True or False, # If true, indicates the exact/prefix/suffix/contains matching should be case insensitive. For example, the matcher ``data`` will match both input string ``Data`` and ``data`` if set to true. + "prefix": "A String", # The input string must have the prefix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``abc.xyz`` + "suffix": "A String", # The input string must have the suffix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc`` + }, + ], + "mcp": { # Describes a set of MCP protocol attributes to match against for a given MCP request. # Optional. Defines the MCP protocol attributes to match on. If the MCP payload in the request body cannot be successfully parsed, the request will be denied. This field can be set only for AuthzPolicies targeting AgentGateway resources. + "baseProtocolMethodsOption": "A String", # Optional. If specified, matches on the MCP protocol’s non-access specific methods namely: * initialize * completion/ * logging/ * notifications/ * ping Defaults to SKIP_BASE_PROTOCOL_METHODS if not specified. + "methods": [ # Optional. A list of MCP methods and associated parameters to match on. It is recommended to use this field to match on tools, prompts and resource accesses while setting the baseProtocolMethodsOption to MATCH_BASE_PROTOCOL_METHODS to match on all the other MCP protocol methods. Limited to 10 MCP methods per Authorization Policy. + { # Describes a set of MCP methods to match against. + "name": "A String", # Required. The MCP method to match against. Allowed values are as follows: 1. `tools`, `prompts`, `resources` - these will match against all sub methods under the respective methods. 2. `prompts/list`, `tools/list`, `resources/list`, `resources/templates/list` 3. `prompts/get`, `tools/call`, `resources/subscribe`, `resources/unsubscribe`, `resources/read` Params cannot be specified for categories 1 and 2. + "params": [ # Optional. A list of MCP method parameters to match against. The match can be one of exact, prefix, suffix, or contains (substring match). Matches are always case sensitive unless the ignoreCase is set. Limited to 10 MCP method parameters per Authorization Policy. + { # Determines how a string value should be matched. + "contains": "A String", # The input string must have the substring specified here. Note: empty contains match is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc.def`` + "exact": "A String", # The input string must match exactly the string specified here. Examples: * ``abc`` only matches the value ``abc``. + "ignoreCase": True or False, # If true, indicates the exact/prefix/suffix/contains matching should be case insensitive. For example, the matcher ``data`` will match both input string ``Data`` and ``data`` if set to true. + "prefix": "A String", # The input string must have the prefix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``abc.xyz`` + "suffix": "A String", # The input string must have the suffix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc`` + }, + ], + }, + ], + }, + "methods": [ # Optional. A list of HTTP methods to match against. Each entry must be a valid HTTP method name (GET, PUT, POST, HEAD, PATCH, DELETE, OPTIONS). It only allows exact match and is always case sensitive. Limited to 10 methods per Authorization Policy. + "A String", + ], + "paths": [ # Optional. A list of paths to match against. The match can be one of exact, prefix, suffix, or contains (substring match). Matches are always case sensitive unless the ignoreCase is set. Limited to 10 paths per Authorization Policy. Note that this path match includes the query parameters. For gRPC services, this should be a fully-qualified name of the form /package.service/method. + { # Determines how a string value should be matched. + "contains": "A String", # The input string must have the substring specified here. Note: empty contains match is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc.def`` + "exact": "A String", # The input string must match exactly the string specified here. Examples: * ``abc`` only matches the value ``abc``. + "ignoreCase": True or False, # If true, indicates the exact/prefix/suffix/contains matching should be case insensitive. For example, the matcher ``data`` will match both input string ``Data`` and ``data`` if set to true. + "prefix": "A String", # The input string must have the prefix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``abc.xyz`` + "suffix": "A String", # The input string must have the suffix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc`` + }, + ], + "snis": [ # Optional. A list of SNIs to match against. The match can be one of exact, prefix, suffix, or contains (substring match). If there is no SNI (i.e. plaintext HTTP traffic), the request will be denied. Matches are always case sensitive unless the ignoreCase is set. Limited to 10 SNIs per Authorization Policy. + { # Determines how a string value should be matched. + "contains": "A String", # The input string must have the substring specified here. Note: empty contains match is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc.def`` + "exact": "A String", # The input string must match exactly the string specified here. Examples: * ``abc`` only matches the value ``abc``. + "ignoreCase": True or False, # If true, indicates the exact/prefix/suffix/contains matching should be case insensitive. For example, the matcher ``data`` will match both input string ``Data`` and ``data`` if set to true. + "prefix": "A String", # The input string must have the prefix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``abc.xyz`` + "suffix": "A String", # The input string must have the suffix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc`` + }, + ], + }, + ], + "operations": [ # Optional. Describes properties of one or more targets of a request. At least one of operations or notOperations must be specified. Limited to 1 operation. A match occurs when ANY operation (in operations or notOperations) matches. Within an operation, the match follows AND semantics across fields and OR semantics within a field, i.e. a match occurs when ANY path matches AND ANY header matches and ANY method matches. + { # Describes properties of one or more targets of a request. + "headerSet": { # Describes a set of HTTP headers to match against. # Optional. A list of headers to match against in http header. + "headers": [ # Required. A list of headers to match against in http header. The match can be one of exact, prefix, suffix, or contains (substring match). The match follows AND semantics which means all the headers must match. Matches are always case sensitive unless the ignoreCase is set. Limited to 10 headers per Authorization Policy. + { # Determines how a HTTP header should be matched. + "name": "A String", # Optional. Specifies the name of the header in the request. + "value": { # Determines how a string value should be matched. # Optional. Specifies how the header match will be performed. + "contains": "A String", # The input string must have the substring specified here. Note: empty contains match is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc.def`` + "exact": "A String", # The input string must match exactly the string specified here. Examples: * ``abc`` only matches the value ``abc``. + "ignoreCase": True or False, # If true, indicates the exact/prefix/suffix/contains matching should be case insensitive. For example, the matcher ``data`` will match both input string ``Data`` and ``data`` if set to true. + "prefix": "A String", # The input string must have the prefix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``abc.xyz`` + "suffix": "A String", # The input string must have the suffix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc`` + }, + }, + ], + }, + "hosts": [ # Optional. A list of HTTP Hosts to match against. The match can be one of exact, prefix, suffix, or contains (substring match). Matches are always case sensitive unless the ignoreCase is set. Limited to 10 hosts per Authorization Policy. + { # Determines how a string value should be matched. + "contains": "A String", # The input string must have the substring specified here. Note: empty contains match is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc.def`` + "exact": "A String", # The input string must match exactly the string specified here. Examples: * ``abc`` only matches the value ``abc``. + "ignoreCase": True or False, # If true, indicates the exact/prefix/suffix/contains matching should be case insensitive. For example, the matcher ``data`` will match both input string ``Data`` and ``data`` if set to true. + "prefix": "A String", # The input string must have the prefix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``abc.xyz`` + "suffix": "A String", # The input string must have the suffix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc`` + }, + ], + "mcp": { # Describes a set of MCP protocol attributes to match against for a given MCP request. # Optional. Defines the MCP protocol attributes to match on. If the MCP payload in the request body cannot be successfully parsed, the request will be denied. This field can be set only for AuthzPolicies targeting AgentGateway resources. + "baseProtocolMethodsOption": "A String", # Optional. If specified, matches on the MCP protocol’s non-access specific methods namely: * initialize * completion/ * logging/ * notifications/ * ping Defaults to SKIP_BASE_PROTOCOL_METHODS if not specified. + "methods": [ # Optional. A list of MCP methods and associated parameters to match on. It is recommended to use this field to match on tools, prompts and resource accesses while setting the baseProtocolMethodsOption to MATCH_BASE_PROTOCOL_METHODS to match on all the other MCP protocol methods. Limited to 10 MCP methods per Authorization Policy. + { # Describes a set of MCP methods to match against. + "name": "A String", # Required. The MCP method to match against. Allowed values are as follows: 1. `tools`, `prompts`, `resources` - these will match against all sub methods under the respective methods. 2. `prompts/list`, `tools/list`, `resources/list`, `resources/templates/list` 3. `prompts/get`, `tools/call`, `resources/subscribe`, `resources/unsubscribe`, `resources/read` Params cannot be specified for categories 1 and 2. + "params": [ # Optional. A list of MCP method parameters to match against. The match can be one of exact, prefix, suffix, or contains (substring match). Matches are always case sensitive unless the ignoreCase is set. Limited to 10 MCP method parameters per Authorization Policy. + { # Determines how a string value should be matched. + "contains": "A String", # The input string must have the substring specified here. Note: empty contains match is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc.def`` + "exact": "A String", # The input string must match exactly the string specified here. Examples: * ``abc`` only matches the value ``abc``. + "ignoreCase": True or False, # If true, indicates the exact/prefix/suffix/contains matching should be case insensitive. For example, the matcher ``data`` will match both input string ``Data`` and ``data`` if set to true. + "prefix": "A String", # The input string must have the prefix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``abc.xyz`` + "suffix": "A String", # The input string must have the suffix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc`` + }, + ], + }, + ], + }, + "methods": [ # Optional. A list of HTTP methods to match against. Each entry must be a valid HTTP method name (GET, PUT, POST, HEAD, PATCH, DELETE, OPTIONS). It only allows exact match and is always case sensitive. Limited to 10 methods per Authorization Policy. + "A String", + ], + "paths": [ # Optional. A list of paths to match against. The match can be one of exact, prefix, suffix, or contains (substring match). Matches are always case sensitive unless the ignoreCase is set. Limited to 10 paths per Authorization Policy. Note that this path match includes the query parameters. For gRPC services, this should be a fully-qualified name of the form /package.service/method. + { # Determines how a string value should be matched. + "contains": "A String", # The input string must have the substring specified here. Note: empty contains match is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc.def`` + "exact": "A String", # The input string must match exactly the string specified here. Examples: * ``abc`` only matches the value ``abc``. + "ignoreCase": True or False, # If true, indicates the exact/prefix/suffix/contains matching should be case insensitive. For example, the matcher ``data`` will match both input string ``Data`` and ``data`` if set to true. + "prefix": "A String", # The input string must have the prefix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``abc.xyz`` + "suffix": "A String", # The input string must have the suffix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc`` + }, + ], + "snis": [ # Optional. A list of SNIs to match against. The match can be one of exact, prefix, suffix, or contains (substring match). If there is no SNI (i.e. plaintext HTTP traffic), the request will be denied. Matches are always case sensitive unless the ignoreCase is set. Limited to 10 SNIs per Authorization Policy. + { # Determines how a string value should be matched. + "contains": "A String", # The input string must have the substring specified here. Note: empty contains match is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc.def`` + "exact": "A String", # The input string must match exactly the string specified here. Examples: * ``abc`` only matches the value ``abc``. + "ignoreCase": True or False, # If true, indicates the exact/prefix/suffix/contains matching should be case insensitive. For example, the matcher ``data`` will match both input string ``Data`` and ``data`` if set to true. + "prefix": "A String", # The input string must have the prefix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``abc.xyz`` + "suffix": "A String", # The input string must have the suffix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc`` + }, + ], + }, + ], + }, + "when": "A String", # Optional. CEL expression that describes the conditions to be satisfied for the action. The result of the CEL expression is ANDed with the from and to. Refer to the CEL language reference for a list of available attributes. + }, + ], "policyProfile": "A String", # Optional. Immutable. Defines the type of authorization being performed. If not specified, `REQUEST_AUTHZ` is applied. This field cannot be changed once AuthzPolicy is created. "target": { # Specifies the set of targets to which this policy should be applied to. # Required. Specifies the set of resources to which this policy should be applied to. "loadBalancingScheme": "A String", # Optional. All gateways and forwarding rules referenced by this policy and extensions must share the same load balancing scheme. Required only when targeting forwarding rules. If targeting Secure Web Proxy, this field must be `INTERNAL_MANAGED` or not specified. Must not be specified when targeting Agent Gateway. Supported values: `INTERNAL_MANAGED` and `EXTERNAL_MANAGED`. For more information, refer to [Backend services overview](https://cloud.google.com/load-balancing/docs/backend-service). diff --git a/docs/dyn/networksecurity_v1.projects.locations.firewallEndpoints.html b/docs/dyn/networksecurity_v1.projects.locations.firewallEndpoints.html index c1a109c9e2..6834fd97c7 100644 --- a/docs/dyn/networksecurity_v1.projects.locations.firewallEndpoints.html +++ b/docs/dyn/networksecurity_v1.projects.locations.firewallEndpoints.html @@ -111,7 +111,7 @@

Method Details

The object takes the form of: { # Message describing Endpoint object. - "associatedNetworks": [ # Output only. List of networks that are associated with this endpoint in the local zone. This is a projection of the FirewallEndpointAssociations pointing at this endpoint. A network will only appear in this list after traffic routing is fully configured. Format: projects/{project}/global/networks/{name}. + "associatedNetworks": [ # Output only. Deprecated: List of networks that are associated with this endpoint in the local zone. This is a projection of the FirewallEndpointAssociations pointing at this endpoint. A network will only appear in this list after traffic routing is fully configured. Format: projects/{project}/global/networks/{name}. "A String", ], "associations": [ # Output only. List of FirewallEndpointAssociations that are associated to this endpoint. An association will only appear in this list after traffic routing is fully configured. @@ -219,7 +219,7 @@

Method Details

An object of the form: { # Message describing Endpoint object. - "associatedNetworks": [ # Output only. List of networks that are associated with this endpoint in the local zone. This is a projection of the FirewallEndpointAssociations pointing at this endpoint. A network will only appear in this list after traffic routing is fully configured. Format: projects/{project}/global/networks/{name}. + "associatedNetworks": [ # Output only. Deprecated: List of networks that are associated with this endpoint in the local zone. This is a projection of the FirewallEndpointAssociations pointing at this endpoint. A network will only appear in this list after traffic routing is fully configured. Format: projects/{project}/global/networks/{name}. "A String", ], "associations": [ # Output only. List of FirewallEndpointAssociations that are associated to this endpoint. An association will only appear in this list after traffic routing is fully configured. @@ -267,7 +267,7 @@

Method Details

{ # Message for response to listing Endpoints "firewallEndpoints": [ # The list of Endpoint { # Message describing Endpoint object. - "associatedNetworks": [ # Output only. List of networks that are associated with this endpoint in the local zone. This is a projection of the FirewallEndpointAssociations pointing at this endpoint. A network will only appear in this list after traffic routing is fully configured. Format: projects/{project}/global/networks/{name}. + "associatedNetworks": [ # Output only. Deprecated: List of networks that are associated with this endpoint in the local zone. This is a projection of the FirewallEndpointAssociations pointing at this endpoint. A network will only appear in this list after traffic routing is fully configured. Format: projects/{project}/global/networks/{name}. "A String", ], "associations": [ # Output only. List of FirewallEndpointAssociations that are associated to this endpoint. An association will only appear in this list after traffic routing is fully configured. @@ -324,7 +324,7 @@

Method Details

The object takes the form of: { # Message describing Endpoint object. - "associatedNetworks": [ # Output only. List of networks that are associated with this endpoint in the local zone. This is a projection of the FirewallEndpointAssociations pointing at this endpoint. A network will only appear in this list after traffic routing is fully configured. Format: projects/{project}/global/networks/{name}. + "associatedNetworks": [ # Output only. Deprecated: List of networks that are associated with this endpoint in the local zone. This is a projection of the FirewallEndpointAssociations pointing at this endpoint. A network will only appear in this list after traffic routing is fully configured. Format: projects/{project}/global/networks/{name}. "A String", ], "associations": [ # Output only. List of FirewallEndpointAssociations that are associated to this endpoint. An association will only appear in this list after traffic routing is fully configured. diff --git a/docs/dyn/networksecurity_v1.projects.locations.html b/docs/dyn/networksecurity_v1.projects.locations.html index 51faaf84a7..ab03dfc70e 100644 --- a/docs/dyn/networksecurity_v1.projects.locations.html +++ b/docs/dyn/networksecurity_v1.projects.locations.html @@ -164,6 +164,16 @@

Instance Methods

Returns the operations Resource.

+

+ sacAttachments() +

+

Returns the sacAttachments Resource.

+ +

+ sacRealms() +

+

Returns the sacRealms Resource.

+

securityProfileGroups()

diff --git a/docs/dyn/networksecurity_v1.projects.locations.sacAttachments.html b/docs/dyn/networksecurity_v1.projects.locations.sacAttachments.html new file mode 100644 index 0000000000..8686e8c02a --- /dev/null +++ b/docs/dyn/networksecurity_v1.projects.locations.sacAttachments.html @@ -0,0 +1,269 @@ + + + +

Network Security API . projects . locations . sacAttachments

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

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

+

Creates a new SACAttachment in a given project and location.

+

+ delete(name, requestId=None, x__xgafv=None)

+

Deletes the specified attachment.

+

+ get(name, x__xgafv=None)

+

Returns the specified attachment.

+

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

+

Lists SACAttachments in a given project and location.

+

+ list_next()

+

Retrieves the next page of results.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ create(parent, body=None, requestId=None, sacAttachmentId=None, x__xgafv=None) +
Creates a new SACAttachment in a given project and location.
+
+Args:
+  parent: string, Required. The parent, in the form `projects/{project}/locations/{location}`. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Represents a Secure Access Connect (SAC) attachment resource. A Secure Access Connect attachment enables NCC Gateway to process traffic with an SSE product.
+  "createTime": "A String", # Output only. Timestamp when the attachment was created.
+  "labels": { # Optional. Optional list of labels applied to the resource.
+    "a_key": "A String",
+  },
+  "name": "A String", # Identifier. Resource name, in the form `projects/{project}/locations/{location}/sacAttachments/{sac_attachment}`.
+  "nccGateway": "A String", # Required. NCC Gateway associated with the attachment. This can be input as an ID or a full resource name. The output always has the form `projects/{project_number}/locations/{location}/spokes/{ncc_gateway}`.
+  "sacRealm": "A String", # Required. SAC Realm which owns the attachment. This can be input as an ID or a full resource name. The output always has the form `projects/{project_number}/locations/{location}/sacRealms/{sac_realm}`.
+  "state": "A String", # Output only. State of the attachment.
+  "updateTime": "A String", # Output only. Timestamp when the attachment was last updated.
+}
+
+  requestId: string, Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
+  sacAttachmentId: string, Required. ID of the created attachment. The ID must be 1-63 characters long, and comply with RFC1035. Specifically, it must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ delete(name, requestId=None, x__xgafv=None) +
Deletes the specified attachment.
+
+Args:
+  name: string, Required. Name of the resource, in the form `projects/{project}/locations/{location}/sacAttachments/{sac_attachment}`. (required)
+  requestId: string, Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
+  x__xgafv: string, V1 error format.
+    Allowed values
+      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) +
Returns the specified attachment.
+
+Args:
+  name: string, Required. Name of the resource, in the form `projects/{project}/locations/{location}/sacAttachments/{sac_attachment}`. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Represents a Secure Access Connect (SAC) attachment resource. A Secure Access Connect attachment enables NCC Gateway to process traffic with an SSE product.
+  "createTime": "A String", # Output only. Timestamp when the attachment was created.
+  "labels": { # Optional. Optional list of labels applied to the resource.
+    "a_key": "A String",
+  },
+  "name": "A String", # Identifier. Resource name, in the form `projects/{project}/locations/{location}/sacAttachments/{sac_attachment}`.
+  "nccGateway": "A String", # Required. NCC Gateway associated with the attachment. This can be input as an ID or a full resource name. The output always has the form `projects/{project_number}/locations/{location}/spokes/{ncc_gateway}`.
+  "sacRealm": "A String", # Required. SAC Realm which owns the attachment. This can be input as an ID or a full resource name. The output always has the form `projects/{project_number}/locations/{location}/sacRealms/{sac_realm}`.
+  "state": "A String", # Output only. State of the attachment.
+  "updateTime": "A String", # Output only. Timestamp when the attachment was last updated.
+}
+
+ +
+ list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None) +
Lists SACAttachments in a given project and location.
+
+Args:
+  parent: string, Required. The parent, in the form `projects/{project}/locations/{location}`. (required)
+  filter: string, Optional. An expression that filters the list of results.
+  orderBy: string, Optional. Sort the results by a certain order.
+  pageSize: integer, Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
+  pageToken: string, Optional. A token identifying a page of results the server should return.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response for `ListSACAttachments` method.
+  "nextPageToken": "A String", # A token identifying a page of results the server should return.
+  "sacAttachments": [ # The list of SACAttachments.
+    { # Represents a Secure Access Connect (SAC) attachment resource. A Secure Access Connect attachment enables NCC Gateway to process traffic with an SSE product.
+      "createTime": "A String", # Output only. Timestamp when the attachment was created.
+      "labels": { # Optional. Optional list of labels applied to the resource.
+        "a_key": "A String",
+      },
+      "name": "A String", # Identifier. Resource name, in the form `projects/{project}/locations/{location}/sacAttachments/{sac_attachment}`.
+      "nccGateway": "A String", # Required. NCC Gateway associated with the attachment. This can be input as an ID or a full resource name. The output always has the form `projects/{project_number}/locations/{location}/spokes/{ncc_gateway}`.
+      "sacRealm": "A String", # Required. SAC Realm which owns the attachment. This can be input as an ID or a full resource name. The output always has the form `projects/{project_number}/locations/{location}/sacRealms/{sac_realm}`.
+      "state": "A String", # Output only. State of the attachment.
+      "updateTime": "A String", # Output only. Timestamp when the attachment was last updated.
+    },
+  ],
+  "unreachable": [ # Locations that could not be reached.
+    "A String",
+  ],
+}
+
+ +
+ list_next() +
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+        
+
+ + \ No newline at end of file diff --git a/docs/dyn/networksecurity_v1.projects.locations.sacRealms.html b/docs/dyn/networksecurity_v1.projects.locations.sacRealms.html new file mode 100644 index 0000000000..02310a599b --- /dev/null +++ b/docs/dyn/networksecurity_v1.projects.locations.sacRealms.html @@ -0,0 +1,278 @@ + + + +

Network Security API . projects . locations . sacRealms

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

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

+

Creates a new SACRealm in a given project.

+

+ delete(name, requestId=None, x__xgafv=None)

+

Deletes the specified realm.

+

+ get(name, x__xgafv=None)

+

Returns the specified realm.

+

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

+

Lists SACRealms in a given project.

+

+ list_next()

+

Retrieves the next page of results.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ create(parent, body=None, requestId=None, sacRealmId=None, x__xgafv=None) +
Creates a new SACRealm in a given project.
+
+Args:
+  parent: string, Required. The parent, in the form `projects/{project}/locations/global`. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Represents a Secure Access Connect (SAC) realm resource. A Secure Access Connect realm establishes a connection between your Google Cloud project and an SSE service.
+  "createTime": "A String", # Output only. Timestamp when the realm was created.
+  "labels": { # Optional. Optional list of labels applied to the resource.
+    "a_key": "A String",
+  },
+  "name": "A String", # Identifier. Resource name, in the form `projects/{project}/locations/global/sacRealms/{sacRealm}`.
+  "pairingKey": { # Key to be shared with SSE service provider to establish global handshake. # Output only. Key to be shared with SSE service provider during pairing.
+    "expireTime": "A String", # Output only. Timestamp in UTC of when this resource is considered expired. It expires 7 days after creation.
+    "key": "A String", # Output only. Key value.
+  },
+  "securityService": "A String", # Immutable. SSE service provider associated with the realm.
+  "state": "A String", # Output only. State of the realm.
+  "updateTime": "A String", # Output only. Timestamp when the realm was last updated.
+}
+
+  requestId: string, Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
+  sacRealmId: string, Required. ID of the created realm. The ID must be 1-63 characters long, and comply with RFC1035. Specifically, it must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ delete(name, requestId=None, x__xgafv=None) +
Deletes the specified realm.
+
+Args:
+  name: string, Required. Name of the resource, in the form `projects/{project}/locations/global/sacRealms/{sacRealm}`. (required)
+  requestId: string, Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
+  x__xgafv: string, V1 error format.
+    Allowed values
+      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) +
Returns the specified realm.
+
+Args:
+  name: string, Required. Name of the resource, in the form `projects/{project}/locations/global/sacRealms/{sacRealm}`. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Represents a Secure Access Connect (SAC) realm resource. A Secure Access Connect realm establishes a connection between your Google Cloud project and an SSE service.
+  "createTime": "A String", # Output only. Timestamp when the realm was created.
+  "labels": { # Optional. Optional list of labels applied to the resource.
+    "a_key": "A String",
+  },
+  "name": "A String", # Identifier. Resource name, in the form `projects/{project}/locations/global/sacRealms/{sacRealm}`.
+  "pairingKey": { # Key to be shared with SSE service provider to establish global handshake. # Output only. Key to be shared with SSE service provider during pairing.
+    "expireTime": "A String", # Output only. Timestamp in UTC of when this resource is considered expired. It expires 7 days after creation.
+    "key": "A String", # Output only. Key value.
+  },
+  "securityService": "A String", # Immutable. SSE service provider associated with the realm.
+  "state": "A String", # Output only. State of the realm.
+  "updateTime": "A String", # Output only. Timestamp when the realm was last updated.
+}
+
+ +
+ list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None) +
Lists SACRealms in a given project.
+
+Args:
+  parent: string, Required. The parent, in the form `projects/{project}/locations/global`. (required)
+  filter: string, Optional. An expression that filters the list of results.
+  orderBy: string, Optional. Sort the results by a certain order.
+  pageSize: integer, Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
+  pageToken: string, Optional. A token identifying a page of results the server should return.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response for `ListSACRealms` method.
+  "nextPageToken": "A String", # A token identifying a page of results the server should return.
+  "sacRealms": [ # The list of SACRealms.
+    { # Represents a Secure Access Connect (SAC) realm resource. A Secure Access Connect realm establishes a connection between your Google Cloud project and an SSE service.
+      "createTime": "A String", # Output only. Timestamp when the realm was created.
+      "labels": { # Optional. Optional list of labels applied to the resource.
+        "a_key": "A String",
+      },
+      "name": "A String", # Identifier. Resource name, in the form `projects/{project}/locations/global/sacRealms/{sacRealm}`.
+      "pairingKey": { # Key to be shared with SSE service provider to establish global handshake. # Output only. Key to be shared with SSE service provider during pairing.
+        "expireTime": "A String", # Output only. Timestamp in UTC of when this resource is considered expired. It expires 7 days after creation.
+        "key": "A String", # Output only. Key value.
+      },
+      "securityService": "A String", # Immutable. SSE service provider associated with the realm.
+      "state": "A String", # Output only. State of the realm.
+      "updateTime": "A String", # Output only. Timestamp when the realm was last updated.
+    },
+  ],
+  "unreachable": [ # Locations that could not be reached.
+    "A String",
+  ],
+}
+
+ +
+ list_next() +
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+        
+
+ + \ No newline at end of file diff --git a/docs/dyn/networksecurity_v1beta1.organizations.locations.addressGroups.html b/docs/dyn/networksecurity_v1beta1.organizations.locations.addressGroups.html index ebe73c9c63..ebdf206653 100644 --- a/docs/dyn/networksecurity_v1beta1.organizations.locations.addressGroups.html +++ b/docs/dyn/networksecurity_v1beta1.organizations.locations.addressGroups.html @@ -110,6 +110,9 @@

Instance Methods

removeItems(addressGroup, body=None, x__xgafv=None)

Removes items from an address group.

+

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

+

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

Method Details

addItems(addressGroup, body=None, x__xgafv=None) @@ -538,4 +541,34 @@

Method Details

}
+
+ testIamPermissions(resource, body=None, x__xgafv=None) +
Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.
+
+Args:
+  resource: string, REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for `TestIamPermissions` method.
+  "permissions": [ # The set of permissions to check for the `resource`. Permissions with wildcards (such as `*` or `storage.*`) are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).
+    "A String",
+  ],
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response message for `TestIamPermissions` method.
+  "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
+    "A String",
+  ],
+}
+
+ \ No newline at end of file diff --git a/docs/dyn/networksecurity_v1beta1.organizations.locations.firewallEndpoints.html b/docs/dyn/networksecurity_v1beta1.organizations.locations.firewallEndpoints.html index 1bc040f830..e1d99c84a1 100644 --- a/docs/dyn/networksecurity_v1beta1.organizations.locations.firewallEndpoints.html +++ b/docs/dyn/networksecurity_v1beta1.organizations.locations.firewallEndpoints.html @@ -74,6 +74,11 @@

Network Security API . organizations . locations . firewallEndpoints

Instance Methods

+

+ wildfireVerdictChangeRequests() +

+

Returns the wildfireVerdictChangeRequests Resource.

+

close()

Close httplib2 connections.

@@ -111,7 +116,7 @@

Method Details

The object takes the form of: { # Message describing Endpoint object. - "associatedNetworks": [ # Output only. List of networks that are associated with this endpoint in the local zone. This is a projection of the FirewallEndpointAssociations pointing at this endpoint. A network will only appear in this list after traffic routing is fully configured. Format: projects/{project}/global/networks/{name}. + "associatedNetworks": [ # Output only. Deprecated: List of networks that are associated with this endpoint in the local zone. This is a projection of the FirewallEndpointAssociations pointing at this endpoint. A network will only appear in this list after traffic routing is fully configured. Format: projects/{project}/global/networks/{name}. "A String", ], "associations": [ # Output only. List of FirewallEndpointAssociations that are associated to this endpoint. An association will only appear in this list after traffic routing is fully configured. @@ -124,6 +129,8 @@

Method Details

"createTime": "A String", # Output only. Create time stamp. "description": "A String", # Optional. Description of the firewall endpoint. Max length 2048 characters. "endpointSettings": { # Settings for the endpoint. # Optional. Settings for the endpoint. + "contentCloudRegion": "A String", # Optional. The content cloud region of the endpoint. + "httpPartialResponseBlocked": True or False, # Optional. Whether to block HTTP partial responses for the endpoint. When this is true, resumption of blocked malicious HTTP file downloads will be blocked by the firewall. False provides maximum availability, true provides maximum security. "jumboFramesEnabled": True or False, # Optional. Immutable. Indicates whether Jumbo Frames are enabled. Default value is false. }, "labels": { # Optional. Labels as key value pairs @@ -135,6 +142,17 @@

Method Details

"satisfiesPzs": True or False, # Output only. [Output Only] Reserved for future use. "state": "A String", # Output only. Current state of the endpoint. "updateTime": "A String", # Output only. Update time stamp + "wildfireSettings": { # Settings for WildFire analysis. # Optional. Settings for WildFire analysis. + "enabled": True or False, # Optional. Indicates whether WildFire analysis is enabled. Default value is false. + "wildfireInlineCloudAnalysisSettings": { # Settings for WildFire inline cloud analysis. # Optional. Settings for WildFire inline cloud analysis. + "maxAnalysisDuration": "A String", # Optional. Timeout in milliseconds on a file being held while WildFire inline cloud analysis is performed. Value between 1 to 240000 is valid. Default value is 30000. + "submissionTimeoutLoggingDisabled": True or False, # Optional. Whether to disable WildFire submission log generation for files that timeout during WildFire inline cloud analysis. + "timeoutAction": "A String", # Optional. Action to take when WildFire inline cloud analysis times out. Default value is ALLOW. + }, + "wildfireRealtimeLookupDuration": "A String", # Optional. Duration in milliseconds on a file being held while the WildFire real time signature cloud performs a signature lookup. Value between 1 to 5000 is valid. Default value is 1000. + "wildfireRealtimeLookupTimeoutAction": "A String", # Optional. Action to take on WildFire real time signature lookup timeout. Default value is ALLOW. + "wildfireRegion": "A String", # Optional. The region where WildFire analysis will be performed. PAN supports regions: https://docs.paloaltonetworks.com/advanced-wildfire/administration/advanced-wildfire-overview/advanced-wildfire-deployments/advanced-wildfire-global-cloud + }, } firewallEndpointId: string, Required. Id of the requesting object. If auto-generating Id server-side, remove this field and firewall_endpoint_id from the method_signature of Create RPC. @@ -219,7 +237,7 @@

Method Details

An object of the form: { # Message describing Endpoint object. - "associatedNetworks": [ # Output only. List of networks that are associated with this endpoint in the local zone. This is a projection of the FirewallEndpointAssociations pointing at this endpoint. A network will only appear in this list after traffic routing is fully configured. Format: projects/{project}/global/networks/{name}. + "associatedNetworks": [ # Output only. Deprecated: List of networks that are associated with this endpoint in the local zone. This is a projection of the FirewallEndpointAssociations pointing at this endpoint. A network will only appear in this list after traffic routing is fully configured. Format: projects/{project}/global/networks/{name}. "A String", ], "associations": [ # Output only. List of FirewallEndpointAssociations that are associated to this endpoint. An association will only appear in this list after traffic routing is fully configured. @@ -232,6 +250,8 @@

Method Details

"createTime": "A String", # Output only. Create time stamp. "description": "A String", # Optional. Description of the firewall endpoint. Max length 2048 characters. "endpointSettings": { # Settings for the endpoint. # Optional. Settings for the endpoint. + "contentCloudRegion": "A String", # Optional. The content cloud region of the endpoint. + "httpPartialResponseBlocked": True or False, # Optional. Whether to block HTTP partial responses for the endpoint. When this is true, resumption of blocked malicious HTTP file downloads will be blocked by the firewall. False provides maximum availability, true provides maximum security. "jumboFramesEnabled": True or False, # Optional. Immutable. Indicates whether Jumbo Frames are enabled. Default value is false. }, "labels": { # Optional. Labels as key value pairs @@ -243,6 +263,17 @@

Method Details

"satisfiesPzs": True or False, # Output only. [Output Only] Reserved for future use. "state": "A String", # Output only. Current state of the endpoint. "updateTime": "A String", # Output only. Update time stamp + "wildfireSettings": { # Settings for WildFire analysis. # Optional. Settings for WildFire analysis. + "enabled": True or False, # Optional. Indicates whether WildFire analysis is enabled. Default value is false. + "wildfireInlineCloudAnalysisSettings": { # Settings for WildFire inline cloud analysis. # Optional. Settings for WildFire inline cloud analysis. + "maxAnalysisDuration": "A String", # Optional. Timeout in milliseconds on a file being held while WildFire inline cloud analysis is performed. Value between 1 to 240000 is valid. Default value is 30000. + "submissionTimeoutLoggingDisabled": True or False, # Optional. Whether to disable WildFire submission log generation for files that timeout during WildFire inline cloud analysis. + "timeoutAction": "A String", # Optional. Action to take when WildFire inline cloud analysis times out. Default value is ALLOW. + }, + "wildfireRealtimeLookupDuration": "A String", # Optional. Duration in milliseconds on a file being held while the WildFire real time signature cloud performs a signature lookup. Value between 1 to 5000 is valid. Default value is 1000. + "wildfireRealtimeLookupTimeoutAction": "A String", # Optional. Action to take on WildFire real time signature lookup timeout. Default value is ALLOW. + "wildfireRegion": "A String", # Optional. The region where WildFire analysis will be performed. PAN supports regions: https://docs.paloaltonetworks.com/advanced-wildfire/administration/advanced-wildfire-overview/advanced-wildfire-deployments/advanced-wildfire-global-cloud + }, }
@@ -267,7 +298,7 @@

Method Details

{ # Message for response to listing Endpoints "firewallEndpoints": [ # The list of Endpoint { # Message describing Endpoint object. - "associatedNetworks": [ # Output only. List of networks that are associated with this endpoint in the local zone. This is a projection of the FirewallEndpointAssociations pointing at this endpoint. A network will only appear in this list after traffic routing is fully configured. Format: projects/{project}/global/networks/{name}. + "associatedNetworks": [ # Output only. Deprecated: List of networks that are associated with this endpoint in the local zone. This is a projection of the FirewallEndpointAssociations pointing at this endpoint. A network will only appear in this list after traffic routing is fully configured. Format: projects/{project}/global/networks/{name}. "A String", ], "associations": [ # Output only. List of FirewallEndpointAssociations that are associated to this endpoint. An association will only appear in this list after traffic routing is fully configured. @@ -280,6 +311,8 @@

Method Details

"createTime": "A String", # Output only. Create time stamp. "description": "A String", # Optional. Description of the firewall endpoint. Max length 2048 characters. "endpointSettings": { # Settings for the endpoint. # Optional. Settings for the endpoint. + "contentCloudRegion": "A String", # Optional. The content cloud region of the endpoint. + "httpPartialResponseBlocked": True or False, # Optional. Whether to block HTTP partial responses for the endpoint. When this is true, resumption of blocked malicious HTTP file downloads will be blocked by the firewall. False provides maximum availability, true provides maximum security. "jumboFramesEnabled": True or False, # Optional. Immutable. Indicates whether Jumbo Frames are enabled. Default value is false. }, "labels": { # Optional. Labels as key value pairs @@ -291,6 +324,17 @@

Method Details

"satisfiesPzs": True or False, # Output only. [Output Only] Reserved for future use. "state": "A String", # Output only. Current state of the endpoint. "updateTime": "A String", # Output only. Update time stamp + "wildfireSettings": { # Settings for WildFire analysis. # Optional. Settings for WildFire analysis. + "enabled": True or False, # Optional. Indicates whether WildFire analysis is enabled. Default value is false. + "wildfireInlineCloudAnalysisSettings": { # Settings for WildFire inline cloud analysis. # Optional. Settings for WildFire inline cloud analysis. + "maxAnalysisDuration": "A String", # Optional. Timeout in milliseconds on a file being held while WildFire inline cloud analysis is performed. Value between 1 to 240000 is valid. Default value is 30000. + "submissionTimeoutLoggingDisabled": True or False, # Optional. Whether to disable WildFire submission log generation for files that timeout during WildFire inline cloud analysis. + "timeoutAction": "A String", # Optional. Action to take when WildFire inline cloud analysis times out. Default value is ALLOW. + }, + "wildfireRealtimeLookupDuration": "A String", # Optional. Duration in milliseconds on a file being held while the WildFire real time signature cloud performs a signature lookup. Value between 1 to 5000 is valid. Default value is 1000. + "wildfireRealtimeLookupTimeoutAction": "A String", # Optional. Action to take on WildFire real time signature lookup timeout. Default value is ALLOW. + "wildfireRegion": "A String", # Optional. The region where WildFire analysis will be performed. PAN supports regions: https://docs.paloaltonetworks.com/advanced-wildfire/administration/advanced-wildfire-overview/advanced-wildfire-deployments/advanced-wildfire-global-cloud + }, }, ], "nextPageToken": "A String", # A token identifying a page of results the server should return. @@ -324,7 +368,7 @@

Method Details

The object takes the form of: { # Message describing Endpoint object. - "associatedNetworks": [ # Output only. List of networks that are associated with this endpoint in the local zone. This is a projection of the FirewallEndpointAssociations pointing at this endpoint. A network will only appear in this list after traffic routing is fully configured. Format: projects/{project}/global/networks/{name}. + "associatedNetworks": [ # Output only. Deprecated: List of networks that are associated with this endpoint in the local zone. This is a projection of the FirewallEndpointAssociations pointing at this endpoint. A network will only appear in this list after traffic routing is fully configured. Format: projects/{project}/global/networks/{name}. "A String", ], "associations": [ # Output only. List of FirewallEndpointAssociations that are associated to this endpoint. An association will only appear in this list after traffic routing is fully configured. @@ -337,6 +381,8 @@

Method Details

"createTime": "A String", # Output only. Create time stamp. "description": "A String", # Optional. Description of the firewall endpoint. Max length 2048 characters. "endpointSettings": { # Settings for the endpoint. # Optional. Settings for the endpoint. + "contentCloudRegion": "A String", # Optional. The content cloud region of the endpoint. + "httpPartialResponseBlocked": True or False, # Optional. Whether to block HTTP partial responses for the endpoint. When this is true, resumption of blocked malicious HTTP file downloads will be blocked by the firewall. False provides maximum availability, true provides maximum security. "jumboFramesEnabled": True or False, # Optional. Immutable. Indicates whether Jumbo Frames are enabled. Default value is false. }, "labels": { # Optional. Labels as key value pairs @@ -348,6 +394,17 @@

Method Details

"satisfiesPzs": True or False, # Output only. [Output Only] Reserved for future use. "state": "A String", # Output only. Current state of the endpoint. "updateTime": "A String", # Output only. Update time stamp + "wildfireSettings": { # Settings for WildFire analysis. # Optional. Settings for WildFire analysis. + "enabled": True or False, # Optional. Indicates whether WildFire analysis is enabled. Default value is false. + "wildfireInlineCloudAnalysisSettings": { # Settings for WildFire inline cloud analysis. # Optional. Settings for WildFire inline cloud analysis. + "maxAnalysisDuration": "A String", # Optional. Timeout in milliseconds on a file being held while WildFire inline cloud analysis is performed. Value between 1 to 240000 is valid. Default value is 30000. + "submissionTimeoutLoggingDisabled": True or False, # Optional. Whether to disable WildFire submission log generation for files that timeout during WildFire inline cloud analysis. + "timeoutAction": "A String", # Optional. Action to take when WildFire inline cloud analysis times out. Default value is ALLOW. + }, + "wildfireRealtimeLookupDuration": "A String", # Optional. Duration in milliseconds on a file being held while the WildFire real time signature cloud performs a signature lookup. Value between 1 to 5000 is valid. Default value is 1000. + "wildfireRealtimeLookupTimeoutAction": "A String", # Optional. Action to take on WildFire real time signature lookup timeout. Default value is ALLOW. + "wildfireRegion": "A String", # Optional. The region where WildFire analysis will be performed. PAN supports regions: https://docs.paloaltonetworks.com/advanced-wildfire/administration/advanced-wildfire-overview/advanced-wildfire-deployments/advanced-wildfire-global-cloud + }, } requestId: string, Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). diff --git a/docs/dyn/networksecurity_v1beta1.organizations.locations.firewallEndpoints.wildfireVerdictChangeRequests.html b/docs/dyn/networksecurity_v1beta1.organizations.locations.firewallEndpoints.wildfireVerdictChangeRequests.html new file mode 100644 index 0000000000..dac95efe67 --- /dev/null +++ b/docs/dyn/networksecurity_v1beta1.organizations.locations.firewallEndpoints.wildfireVerdictChangeRequests.html @@ -0,0 +1,239 @@ + + + +

Network Security API . organizations . locations . firewallEndpoints . wildfireVerdictChangeRequests

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

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

+

Create WildfireVerdictChangeRequest in a given Firewall Endpoint in an organization and location.

+

+ get(name, x__xgafv=None)

+

Get WildfireVerdictChangeRequest in a given Firewall Endpoint in an organization and location.

+

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

+

Lists WildfireVerdictChangeRequests in a given Firewall Endpoint in an organization and location.

+

+ list_next()

+

Retrieves the next page of results.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ create(parent, body=None, x__xgafv=None) +
Create WildfireVerdictChangeRequest in a given Firewall Endpoint in an organization and location.
+
+Args:
+  parent: string, Required. Parent value for CreateWildfireVerdictChangeRequestRequest. The parent is a firewall endpoint resource. Format: organizations|projects/{project_or_organization}/locations/{location}/firewallEndpoints/{firewall_endpoint} (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Message for a WildfireVerdictChangeRequest.
+  "comment": "A String", # Required. The justification for the verdict change request. Max length 2048 characters.
+  "createTime": "A String", # Output only. The timestamp when the WildfireVerdictChangeRequest was created.
+  "fileName": "A String", # Output only. The file name of the Malware Sample.
+  "fileType": "A String", # Output only. The file type of the Malware Sample.
+  "finalVerdict": "A String", # Output only. The final verdict of the Malware Sample.
+  "name": "A String", # Output only. Identifier. The relative name of the WildfireVerdictChangeRequest. Output only. This is a unique identifier generated by the third party API. Format: organizations|projects/{project_or_organization}/locations/{location}/firewallEndpoints/{firewall_endpoint}/wildfireVerdictChangeRequests/{wildfire_verdict_change_request_id} Where {wildfire_verdict_change_request_id} is the ID in the format: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
+  "newVerdict": "A String", # Required. The suggested verdict to apply to the Malware Sample.
+  "oldVerdict": "A String", # Output only. The original verdict of the Malware Sample.
+  "resolutionTime": "A String", # Output only. The timestamp when the WildfireVerdictChangeRequest was resolved.
+  "sha256": "A String", # Required. The SHA256 hash of the Malware Sample to change the verdict of.
+  "sourceRegion": "A String", # Output only. The region of the file associated with the Malware Sample.
+  "state": "A String", # Output only. The review state of the WildfireVerdictChangeRequest.
+  "updateTime": "A String", # Output only. The timestamp when the WildfireVerdictChangeRequest was last updated.
+  "wildfireVerdictChangeRequestId": "A String", # Output only. The ID of the WildfireVerdictChangeRequest. This is a unique identifier generated by the third party API. Format: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Message for a WildfireVerdictChangeRequest.
+  "comment": "A String", # Required. The justification for the verdict change request. Max length 2048 characters.
+  "createTime": "A String", # Output only. The timestamp when the WildfireVerdictChangeRequest was created.
+  "fileName": "A String", # Output only. The file name of the Malware Sample.
+  "fileType": "A String", # Output only. The file type of the Malware Sample.
+  "finalVerdict": "A String", # Output only. The final verdict of the Malware Sample.
+  "name": "A String", # Output only. Identifier. The relative name of the WildfireVerdictChangeRequest. Output only. This is a unique identifier generated by the third party API. Format: organizations|projects/{project_or_organization}/locations/{location}/firewallEndpoints/{firewall_endpoint}/wildfireVerdictChangeRequests/{wildfire_verdict_change_request_id} Where {wildfire_verdict_change_request_id} is the ID in the format: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
+  "newVerdict": "A String", # Required. The suggested verdict to apply to the Malware Sample.
+  "oldVerdict": "A String", # Output only. The original verdict of the Malware Sample.
+  "resolutionTime": "A String", # Output only. The timestamp when the WildfireVerdictChangeRequest was resolved.
+  "sha256": "A String", # Required. The SHA256 hash of the Malware Sample to change the verdict of.
+  "sourceRegion": "A String", # Output only. The region of the file associated with the Malware Sample.
+  "state": "A String", # Output only. The review state of the WildfireVerdictChangeRequest.
+  "updateTime": "A String", # Output only. The timestamp when the WildfireVerdictChangeRequest was last updated.
+  "wildfireVerdictChangeRequestId": "A String", # Output only. The ID of the WildfireVerdictChangeRequest. This is a unique identifier generated by the third party API. Format: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
+}
+
+ +
+ get(name, x__xgafv=None) +
Get WildfireVerdictChangeRequest in a given Firewall Endpoint in an organization and location.
+
+Args:
+  name: string, Required. Name of the WildfireVerdictChangeRequest to retrieve. Format: organizations|projects/{project_or_organization}/locations/{location}/firewallEndpoints/{firewall_endpoint}/wildfireVerdictChangeRequests/{wildfire_verdict_change_request_id} Where {wildfire_verdict_change_request_id} is the ID in the format: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Message for a WildfireVerdictChangeRequest.
+  "comment": "A String", # Required. The justification for the verdict change request. Max length 2048 characters.
+  "createTime": "A String", # Output only. The timestamp when the WildfireVerdictChangeRequest was created.
+  "fileName": "A String", # Output only. The file name of the Malware Sample.
+  "fileType": "A String", # Output only. The file type of the Malware Sample.
+  "finalVerdict": "A String", # Output only. The final verdict of the Malware Sample.
+  "name": "A String", # Output only. Identifier. The relative name of the WildfireVerdictChangeRequest. Output only. This is a unique identifier generated by the third party API. Format: organizations|projects/{project_or_organization}/locations/{location}/firewallEndpoints/{firewall_endpoint}/wildfireVerdictChangeRequests/{wildfire_verdict_change_request_id} Where {wildfire_verdict_change_request_id} is the ID in the format: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
+  "newVerdict": "A String", # Required. The suggested verdict to apply to the Malware Sample.
+  "oldVerdict": "A String", # Output only. The original verdict of the Malware Sample.
+  "resolutionTime": "A String", # Output only. The timestamp when the WildfireVerdictChangeRequest was resolved.
+  "sha256": "A String", # Required. The SHA256 hash of the Malware Sample to change the verdict of.
+  "sourceRegion": "A String", # Output only. The region of the file associated with the Malware Sample.
+  "state": "A String", # Output only. The review state of the WildfireVerdictChangeRequest.
+  "updateTime": "A String", # Output only. The timestamp when the WildfireVerdictChangeRequest was last updated.
+  "wildfireVerdictChangeRequestId": "A String", # Output only. The ID of the WildfireVerdictChangeRequest. This is a unique identifier generated by the third party API. Format: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
+}
+
+ +
+ list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None) +
Lists WildfireVerdictChangeRequests in a given Firewall Endpoint in an organization and location.
+
+Args:
+  parent: string, Required. Parent value for ListWildfireVerdictChangeRequestsRequest. The parent is a firewall endpoint resource. Format: organizations|projects/{project_or_organization}/locations/{location}/firewallEndpoints/{firewall_endpoint} (required)
+  filter: string, Optional. Filter expression to filter the results. See AIP-160 for filtering syntax. Supported fields are: - `sha256` (string, equality only, e.g. `sha256 = "..."`) - `state` (enum, equality only, e.g. `state = "ACTIVE"`) - `create_time` (timestamp, comparisons, e.g. `create_time > "2026-01-01T00:00:00Z"`)
+  pageSize: integer, Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
+  pageToken: string, Optional. A token identifying a page of results the server should return.
+  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 WildfireVerdictChangeRequests.
+  "nextPageToken": "A String", # A token identifying a page of results the server should return.
+  "unreachable": [ # Unordered list. Locations that could not be reached.
+    "A String",
+  ],
+  "wildfireVerdictChangeRequests": [ # The list of WildfireVerdictChangeRequests
+    { # Message for a WildfireVerdictChangeRequest.
+      "comment": "A String", # Required. The justification for the verdict change request. Max length 2048 characters.
+      "createTime": "A String", # Output only. The timestamp when the WildfireVerdictChangeRequest was created.
+      "fileName": "A String", # Output only. The file name of the Malware Sample.
+      "fileType": "A String", # Output only. The file type of the Malware Sample.
+      "finalVerdict": "A String", # Output only. The final verdict of the Malware Sample.
+      "name": "A String", # Output only. Identifier. The relative name of the WildfireVerdictChangeRequest. Output only. This is a unique identifier generated by the third party API. Format: organizations|projects/{project_or_organization}/locations/{location}/firewallEndpoints/{firewall_endpoint}/wildfireVerdictChangeRequests/{wildfire_verdict_change_request_id} Where {wildfire_verdict_change_request_id} is the ID in the format: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
+      "newVerdict": "A String", # Required. The suggested verdict to apply to the Malware Sample.
+      "oldVerdict": "A String", # Output only. The original verdict of the Malware Sample.
+      "resolutionTime": "A String", # Output only. The timestamp when the WildfireVerdictChangeRequest was resolved.
+      "sha256": "A String", # Required. The SHA256 hash of the Malware Sample to change the verdict of.
+      "sourceRegion": "A String", # Output only. The region of the file associated with the Malware Sample.
+      "state": "A String", # Output only. The review state of the WildfireVerdictChangeRequest.
+      "updateTime": "A String", # Output only. The timestamp when the WildfireVerdictChangeRequest was last updated.
+      "wildfireVerdictChangeRequestId": "A String", # Output only. The ID of the WildfireVerdictChangeRequest. This is a unique identifier generated by the third party API. Format: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
+    },
+  ],
+}
+
+ +
+ 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/networksecurity_v1beta1.organizations.locations.html b/docs/dyn/networksecurity_v1beta1.organizations.locations.html index f9b8bbac27..82e8f843fb 100644 --- a/docs/dyn/networksecurity_v1beta1.organizations.locations.html +++ b/docs/dyn/networksecurity_v1beta1.organizations.locations.html @@ -102,10 +102,96 @@

Instance Methods

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. This method lists locations based on the resource scope provided in the ListLocationsRequest.name field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.

+

+ 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. This method lists locations based on the resource scope provided in the ListLocationsRequest.name field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.
+
+Args:
+  name: string, The resource that owns the locations collection, if applicable. (required)
+  extraLocationTypes: string, Optional. Do not use this field 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.
+  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/networksecurity_v1beta1.organizations.locations.securityProfileGroups.html b/docs/dyn/networksecurity_v1beta1.organizations.locations.securityProfileGroups.html index c99a1d1f67..2e411df97a 100644 --- a/docs/dyn/networksecurity_v1beta1.organizations.locations.securityProfileGroups.html +++ b/docs/dyn/networksecurity_v1beta1.organizations.locations.securityProfileGroups.html @@ -124,6 +124,7 @@

Method Details

"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. + "wildfireAnalysisProfile": "A String", # Optional. Reference to a SecurityProfile with the WildFire 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". @@ -220,6 +221,7 @@

Method Details

"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. + "wildfireAnalysisProfile": "A String", # Optional. Reference to a SecurityProfile with the WildFire configuration. }
@@ -256,6 +258,7 @@

Method Details

"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. + "wildfireAnalysisProfile": "A String", # Optional. Reference to a SecurityProfile with the WildFire configuration. }, ], }
@@ -298,6 +301,7 @@

Method Details

"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. + "wildfireAnalysisProfile": "A String", # Optional. Reference to a SecurityProfile with the WildFire 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 792c581cb1..a5336235a4 100644 --- a/docs/dyn/networksecurity_v1beta1.organizations.locations.securityProfiles.html +++ b/docs/dyn/networksecurity_v1beta1.organizations.locations.securityProfiles.html @@ -158,6 +158,80 @@

Method Details

}, ], }, + "wildfireAnalysisProfile": { # WildfireAnalysisProfile defines Palo Alto Networks WildFire behavior. # The WildFire Analysis configurations for SecurityProfile. + "wildfireInlineCloudAnalysisRules": [ # Optional. Configuration for WildFire inline cloud analysis. + { # The list of file type configurations to be scanned by WildFire Inline Cloud Analysis. + "action": "A String", # Required. Action to take when a threat is detected using WildFire Inline Cloud Analysis. The default Value is DENY. + "customFileTypes": { # The options to submit a custom list of file types for scan. # Submit a custom list of file types for WildFire analysis. + "fileTypes": [ # Required. File types to be submitted for WildFire inline cloud analysis. + "A String", + ], + }, + "direction": "A String", # Required. Direction for the file to be analyzed by WildFire Inline Cloud Analysis. + "fileSelectionMode": "A String", # Required. File selection mode for WildFire inline cloud analysis. + }, + ], + "wildfireInlineMlOverrides": [ # Optional. Configuration for overriding inline ML WildFire actions per protocol. + { # Defines what action to take for WildFire Inline ML threats per protocol. + "action": "A String", # Required. The action to take for WildFire Inline ML override. + "protocol": "A String", # Required. Protocol to match for WildFire Inline ML override. + }, + ], + "wildfireInlineMlSetting": { # Defines the settings for WildFire Inline ML analysis. # Optional. Settings for WildFire Inline ML analysis. + "fileExceptions": [ # Optional. List of files to exclude from WildFire Inline ML analysis. + { # Defines the file to exclude from WildFire Inline ML analysis. + "filename": "A String", # Optional. Name of the file to exclude from WildFire Inline ML analysis. + "partialHash": "A String", # Required. Machine learning partial hash of the file to exclude from WildFire Inline ML analysis. + }, + ], + "inlineMlConfigs": [ # Optional. List of Inline ML configs to enable in WildFire Inline ML analysis. + { # Configuration for WildFire Inline ML analysis per file type. + "action": "A String", # Required. Action to take when a threat is detected using Inline ML. + "fileType": "A String", # Required. File type to configure Inline ML for. + }, + ], + }, + "wildfireInlineMlSettings": [ # Optional. Settings for WildFire Inline ML analysis. + { # Defines the settings for WildFire Inline ML analysis. + "fileExceptions": [ # Optional. List of files to exclude from WildFire Inline ML analysis. + { # Defines the file to exclude from WildFire Inline ML analysis. + "filename": "A String", # Optional. Name of the file to exclude from WildFire Inline ML analysis. + "partialHash": "A String", # Required. Machine learning partial hash of the file to exclude from WildFire Inline ML analysis. + }, + ], + "inlineMlConfigs": [ # Optional. List of Inline ML configs to enable in WildFire Inline ML analysis. + { # Configuration for WildFire Inline ML analysis per file type. + "action": "A String", # Required. Action to take when a threat is detected using Inline ML. + "fileType": "A String", # Required. File type to configure Inline ML for. + }, + ], + }, + ], + "wildfireOverrides": [ # Optional. Configuration for overriding WildFire actions per protocol. + { # Defines what action to take for WildFire threats per protocol. + "action": "A String", # Required. Threat action override. For some threat types, only a subset of actions applies. + "protocol": "A String", # Required. Protocol to match. + }, + ], + "wildfireRealtimeLookup": True or False, # Optional. Whether to hold the transfer of a file while the WildFire real-time signature cloud performs a signature lookup. Default value is false. + "wildfireSubmissionRules": [ # Optional. Configurations for WildFire file submissions. + { # Defines the file types to be submitted for WildFire analysis and the direction of the traffic. + "customFileTypes": { # The options to submit a custom list of file types for scan. # Submit a custom list of file types for WildFire analysis. + "fileTypes": [ # Required. File types to be submitted for WildFire analysis. + "A String", + ], + }, + "direction": "A String", # Required. Direction for the files to be analyzed by WildFire. + "fileSelectionMode": "A String", # Required. File selection mode for WildFire analysis. + }, + ], + "wildfireThreatOverrides": [ # Optional. Configuration for overriding WildFire threats action by threat_id match. + { # Defines what action to take for a specific WildFire threat_id match. + "action": "A String", # Required. Threat action override. + "threatId": "A String", # Required. Threat ID to match. + }, + ], + }, } 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". @@ -288,6 +362,80 @@

Method Details

}, ], }, + "wildfireAnalysisProfile": { # WildfireAnalysisProfile defines Palo Alto Networks WildFire behavior. # The WildFire Analysis configurations for SecurityProfile. + "wildfireInlineCloudAnalysisRules": [ # Optional. Configuration for WildFire inline cloud analysis. + { # The list of file type configurations to be scanned by WildFire Inline Cloud Analysis. + "action": "A String", # Required. Action to take when a threat is detected using WildFire Inline Cloud Analysis. The default Value is DENY. + "customFileTypes": { # The options to submit a custom list of file types for scan. # Submit a custom list of file types for WildFire analysis. + "fileTypes": [ # Required. File types to be submitted for WildFire inline cloud analysis. + "A String", + ], + }, + "direction": "A String", # Required. Direction for the file to be analyzed by WildFire Inline Cloud Analysis. + "fileSelectionMode": "A String", # Required. File selection mode for WildFire inline cloud analysis. + }, + ], + "wildfireInlineMlOverrides": [ # Optional. Configuration for overriding inline ML WildFire actions per protocol. + { # Defines what action to take for WildFire Inline ML threats per protocol. + "action": "A String", # Required. The action to take for WildFire Inline ML override. + "protocol": "A String", # Required. Protocol to match for WildFire Inline ML override. + }, + ], + "wildfireInlineMlSetting": { # Defines the settings for WildFire Inline ML analysis. # Optional. Settings for WildFire Inline ML analysis. + "fileExceptions": [ # Optional. List of files to exclude from WildFire Inline ML analysis. + { # Defines the file to exclude from WildFire Inline ML analysis. + "filename": "A String", # Optional. Name of the file to exclude from WildFire Inline ML analysis. + "partialHash": "A String", # Required. Machine learning partial hash of the file to exclude from WildFire Inline ML analysis. + }, + ], + "inlineMlConfigs": [ # Optional. List of Inline ML configs to enable in WildFire Inline ML analysis. + { # Configuration for WildFire Inline ML analysis per file type. + "action": "A String", # Required. Action to take when a threat is detected using Inline ML. + "fileType": "A String", # Required. File type to configure Inline ML for. + }, + ], + }, + "wildfireInlineMlSettings": [ # Optional. Settings for WildFire Inline ML analysis. + { # Defines the settings for WildFire Inline ML analysis. + "fileExceptions": [ # Optional. List of files to exclude from WildFire Inline ML analysis. + { # Defines the file to exclude from WildFire Inline ML analysis. + "filename": "A String", # Optional. Name of the file to exclude from WildFire Inline ML analysis. + "partialHash": "A String", # Required. Machine learning partial hash of the file to exclude from WildFire Inline ML analysis. + }, + ], + "inlineMlConfigs": [ # Optional. List of Inline ML configs to enable in WildFire Inline ML analysis. + { # Configuration for WildFire Inline ML analysis per file type. + "action": "A String", # Required. Action to take when a threat is detected using Inline ML. + "fileType": "A String", # Required. File type to configure Inline ML for. + }, + ], + }, + ], + "wildfireOverrides": [ # Optional. Configuration for overriding WildFire actions per protocol. + { # Defines what action to take for WildFire threats per protocol. + "action": "A String", # Required. Threat action override. For some threat types, only a subset of actions applies. + "protocol": "A String", # Required. Protocol to match. + }, + ], + "wildfireRealtimeLookup": True or False, # Optional. Whether to hold the transfer of a file while the WildFire real-time signature cloud performs a signature lookup. Default value is false. + "wildfireSubmissionRules": [ # Optional. Configurations for WildFire file submissions. + { # Defines the file types to be submitted for WildFire analysis and the direction of the traffic. + "customFileTypes": { # The options to submit a custom list of file types for scan. # Submit a custom list of file types for WildFire analysis. + "fileTypes": [ # Required. File types to be submitted for WildFire analysis. + "A String", + ], + }, + "direction": "A String", # Required. Direction for the files to be analyzed by WildFire. + "fileSelectionMode": "A String", # Required. File selection mode for WildFire analysis. + }, + ], + "wildfireThreatOverrides": [ # Optional. Configuration for overriding WildFire threats action by threat_id match. + { # Defines what action to take for a specific WildFire threat_id match. + "action": "A String", # Required. Threat action override. + "threatId": "A String", # Required. Threat ID to match. + }, + ], + }, }
@@ -358,6 +506,80 @@

Method Details

}, ], }, + "wildfireAnalysisProfile": { # WildfireAnalysisProfile defines Palo Alto Networks WildFire behavior. # The WildFire Analysis configurations for SecurityProfile. + "wildfireInlineCloudAnalysisRules": [ # Optional. Configuration for WildFire inline cloud analysis. + { # The list of file type configurations to be scanned by WildFire Inline Cloud Analysis. + "action": "A String", # Required. Action to take when a threat is detected using WildFire Inline Cloud Analysis. The default Value is DENY. + "customFileTypes": { # The options to submit a custom list of file types for scan. # Submit a custom list of file types for WildFire analysis. + "fileTypes": [ # Required. File types to be submitted for WildFire inline cloud analysis. + "A String", + ], + }, + "direction": "A String", # Required. Direction for the file to be analyzed by WildFire Inline Cloud Analysis. + "fileSelectionMode": "A String", # Required. File selection mode for WildFire inline cloud analysis. + }, + ], + "wildfireInlineMlOverrides": [ # Optional. Configuration for overriding inline ML WildFire actions per protocol. + { # Defines what action to take for WildFire Inline ML threats per protocol. + "action": "A String", # Required. The action to take for WildFire Inline ML override. + "protocol": "A String", # Required. Protocol to match for WildFire Inline ML override. + }, + ], + "wildfireInlineMlSetting": { # Defines the settings for WildFire Inline ML analysis. # Optional. Settings for WildFire Inline ML analysis. + "fileExceptions": [ # Optional. List of files to exclude from WildFire Inline ML analysis. + { # Defines the file to exclude from WildFire Inline ML analysis. + "filename": "A String", # Optional. Name of the file to exclude from WildFire Inline ML analysis. + "partialHash": "A String", # Required. Machine learning partial hash of the file to exclude from WildFire Inline ML analysis. + }, + ], + "inlineMlConfigs": [ # Optional. List of Inline ML configs to enable in WildFire Inline ML analysis. + { # Configuration for WildFire Inline ML analysis per file type. + "action": "A String", # Required. Action to take when a threat is detected using Inline ML. + "fileType": "A String", # Required. File type to configure Inline ML for. + }, + ], + }, + "wildfireInlineMlSettings": [ # Optional. Settings for WildFire Inline ML analysis. + { # Defines the settings for WildFire Inline ML analysis. + "fileExceptions": [ # Optional. List of files to exclude from WildFire Inline ML analysis. + { # Defines the file to exclude from WildFire Inline ML analysis. + "filename": "A String", # Optional. Name of the file to exclude from WildFire Inline ML analysis. + "partialHash": "A String", # Required. Machine learning partial hash of the file to exclude from WildFire Inline ML analysis. + }, + ], + "inlineMlConfigs": [ # Optional. List of Inline ML configs to enable in WildFire Inline ML analysis. + { # Configuration for WildFire Inline ML analysis per file type. + "action": "A String", # Required. Action to take when a threat is detected using Inline ML. + "fileType": "A String", # Required. File type to configure Inline ML for. + }, + ], + }, + ], + "wildfireOverrides": [ # Optional. Configuration for overriding WildFire actions per protocol. + { # Defines what action to take for WildFire threats per protocol. + "action": "A String", # Required. Threat action override. For some threat types, only a subset of actions applies. + "protocol": "A String", # Required. Protocol to match. + }, + ], + "wildfireRealtimeLookup": True or False, # Optional. Whether to hold the transfer of a file while the WildFire real-time signature cloud performs a signature lookup. Default value is false. + "wildfireSubmissionRules": [ # Optional. Configurations for WildFire file submissions. + { # Defines the file types to be submitted for WildFire analysis and the direction of the traffic. + "customFileTypes": { # The options to submit a custom list of file types for scan. # Submit a custom list of file types for WildFire analysis. + "fileTypes": [ # Required. File types to be submitted for WildFire analysis. + "A String", + ], + }, + "direction": "A String", # Required. Direction for the files to be analyzed by WildFire. + "fileSelectionMode": "A String", # Required. File selection mode for WildFire analysis. + }, + ], + "wildfireThreatOverrides": [ # Optional. Configuration for overriding WildFire threats action by threat_id match. + { # Defines what action to take for a specific WildFire threat_id match. + "action": "A String", # Required. Threat action override. + "threatId": "A String", # Required. Threat ID to match. + }, + ], + }, }, ], }
@@ -434,6 +656,80 @@

Method Details

}, ], }, + "wildfireAnalysisProfile": { # WildfireAnalysisProfile defines Palo Alto Networks WildFire behavior. # The WildFire Analysis configurations for SecurityProfile. + "wildfireInlineCloudAnalysisRules": [ # Optional. Configuration for WildFire inline cloud analysis. + { # The list of file type configurations to be scanned by WildFire Inline Cloud Analysis. + "action": "A String", # Required. Action to take when a threat is detected using WildFire Inline Cloud Analysis. The default Value is DENY. + "customFileTypes": { # The options to submit a custom list of file types for scan. # Submit a custom list of file types for WildFire analysis. + "fileTypes": [ # Required. File types to be submitted for WildFire inline cloud analysis. + "A String", + ], + }, + "direction": "A String", # Required. Direction for the file to be analyzed by WildFire Inline Cloud Analysis. + "fileSelectionMode": "A String", # Required. File selection mode for WildFire inline cloud analysis. + }, + ], + "wildfireInlineMlOverrides": [ # Optional. Configuration for overriding inline ML WildFire actions per protocol. + { # Defines what action to take for WildFire Inline ML threats per protocol. + "action": "A String", # Required. The action to take for WildFire Inline ML override. + "protocol": "A String", # Required. Protocol to match for WildFire Inline ML override. + }, + ], + "wildfireInlineMlSetting": { # Defines the settings for WildFire Inline ML analysis. # Optional. Settings for WildFire Inline ML analysis. + "fileExceptions": [ # Optional. List of files to exclude from WildFire Inline ML analysis. + { # Defines the file to exclude from WildFire Inline ML analysis. + "filename": "A String", # Optional. Name of the file to exclude from WildFire Inline ML analysis. + "partialHash": "A String", # Required. Machine learning partial hash of the file to exclude from WildFire Inline ML analysis. + }, + ], + "inlineMlConfigs": [ # Optional. List of Inline ML configs to enable in WildFire Inline ML analysis. + { # Configuration for WildFire Inline ML analysis per file type. + "action": "A String", # Required. Action to take when a threat is detected using Inline ML. + "fileType": "A String", # Required. File type to configure Inline ML for. + }, + ], + }, + "wildfireInlineMlSettings": [ # Optional. Settings for WildFire Inline ML analysis. + { # Defines the settings for WildFire Inline ML analysis. + "fileExceptions": [ # Optional. List of files to exclude from WildFire Inline ML analysis. + { # Defines the file to exclude from WildFire Inline ML analysis. + "filename": "A String", # Optional. Name of the file to exclude from WildFire Inline ML analysis. + "partialHash": "A String", # Required. Machine learning partial hash of the file to exclude from WildFire Inline ML analysis. + }, + ], + "inlineMlConfigs": [ # Optional. List of Inline ML configs to enable in WildFire Inline ML analysis. + { # Configuration for WildFire Inline ML analysis per file type. + "action": "A String", # Required. Action to take when a threat is detected using Inline ML. + "fileType": "A String", # Required. File type to configure Inline ML for. + }, + ], + }, + ], + "wildfireOverrides": [ # Optional. Configuration for overriding WildFire actions per protocol. + { # Defines what action to take for WildFire threats per protocol. + "action": "A String", # Required. Threat action override. For some threat types, only a subset of actions applies. + "protocol": "A String", # Required. Protocol to match. + }, + ], + "wildfireRealtimeLookup": True or False, # Optional. Whether to hold the transfer of a file while the WildFire real-time signature cloud performs a signature lookup. Default value is false. + "wildfireSubmissionRules": [ # Optional. Configurations for WildFire file submissions. + { # Defines the file types to be submitted for WildFire analysis and the direction of the traffic. + "customFileTypes": { # The options to submit a custom list of file types for scan. # Submit a custom list of file types for WildFire analysis. + "fileTypes": [ # Required. File types to be submitted for WildFire analysis. + "A String", + ], + }, + "direction": "A String", # Required. Direction for the files to be analyzed by WildFire. + "fileSelectionMode": "A String", # Required. File selection mode for WildFire analysis. + }, + ], + "wildfireThreatOverrides": [ # Optional. Configuration for overriding WildFire threats action by threat_id match. + { # Defines what action to take for a specific WildFire threat_id match. + "action": "A String", # Required. Threat action override. + "threatId": "A String", # Required. Threat ID to match. + }, + ], + }, } 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/networksecurity_v1beta1.projects.locations.authzPolicies.html b/docs/dyn/networksecurity_v1beta1.projects.locations.authzPolicies.html index d2071184ae..605508ca71 100644 --- a/docs/dyn/networksecurity_v1beta1.projects.locations.authzPolicies.html +++ b/docs/dyn/networksecurity_v1beta1.projects.locations.authzPolicies.html @@ -267,6 +267,15 @@

Method Details

"suffix": "A String", # The input string must have the suffix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc`` }, ], + "snis": [ # Optional. A list of SNIs to match against. The match can be one of exact, prefix, suffix, or contains (substring match). If there is no SNI (i.e. plaintext HTTP traffic), the request will be denied. Matches are always case sensitive unless the ignoreCase is set. Limited to 10 SNIs per Authorization Policy. + { # Determines how a string value should be matched. + "contains": "A String", # The input string must have the substring specified here. Note: empty contains match is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc.def`` + "exact": "A String", # The input string must match exactly the string specified here. Examples: * ``abc`` only matches the value ``abc``. + "ignoreCase": True or False, # If true, indicates the exact/prefix/suffix/contains matching should be case insensitive. For example, the matcher ``data`` will match both input string ``Data`` and ``data`` if set to true. + "prefix": "A String", # The input string must have the prefix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``abc.xyz`` + "suffix": "A String", # The input string must have the suffix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc`` + }, + ], }, ], "operations": [ # Optional. Describes properties of one or more targets of a request. At least one of operations or notOperations must be specified. Limited to 1 operation. A match occurs when ANY operation (in operations or notOperations) matches. Within an operation, the match follows AND semantics across fields and OR semantics within a field, i.e. a match occurs when ANY path matches AND ANY header matches and ANY method matches. @@ -323,6 +332,15 @@

Method Details

"suffix": "A String", # The input string must have the suffix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc`` }, ], + "snis": [ # Optional. A list of SNIs to match against. The match can be one of exact, prefix, suffix, or contains (substring match). If there is no SNI (i.e. plaintext HTTP traffic), the request will be denied. Matches are always case sensitive unless the ignoreCase is set. Limited to 10 SNIs per Authorization Policy. + { # Determines how a string value should be matched. + "contains": "A String", # The input string must have the substring specified here. Note: empty contains match is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc.def`` + "exact": "A String", # The input string must match exactly the string specified here. Examples: * ``abc`` only matches the value ``abc``. + "ignoreCase": True or False, # If true, indicates the exact/prefix/suffix/contains matching should be case insensitive. For example, the matcher ``data`` will match both input string ``Data`` and ``data`` if set to true. + "prefix": "A String", # The input string must have the prefix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``abc.xyz`` + "suffix": "A String", # The input string must have the suffix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc`` + }, + ], }, ], }, @@ -333,6 +351,221 @@

Method Details

"a_key": "A String", }, "name": "A String", # Required. Identifier. Name of the `AuthzPolicy` resource in the following format: `projects/{project}/locations/{location}/authzPolicies/{authz_policy}`. + "networkRules": [ # Optional. A list of authorization network rules to match against the incoming request. A policy match occurs when at least one network rule matches the request. At least one network rule is required for Allow or Deny Action if no HTTP rules are provided. Network rules are mutually exclusive with HTTP rules. Limited to 5 rules. + { # Conditions to match against the incoming request. + "from": { # Describes properties of one or more sources of a request. # Optional. Describes properties of a source of a request. + "notSources": [ # Optional. Describes the negated properties of request sources. Matches requests from sources that do not match the criteria specified in this field. At least one of sources or notSources must be specified. + { # Describes the properties of a single source. + "ipBlocks": [ # Optional. A list of IP addresses or IP address ranges to match against the source IP address of the request. Limited to 10 ip_blocks per Authorization Policy + { # Represents a range of IP Addresses. + "length": 42, # Required. The length of the address range. + "prefix": "A String", # Required. The address prefix. + }, + ], + "principals": [ # Optional. A list of identities derived from the client's certificate. This field will not match on a request unless frontend mutual TLS is enabled for the forwarding rule or Gateway and the client certificate has been successfully validated by mTLS. Each identity is a string whose value is matched against a list of URI SANs, DNS Name SANs, or the common name in the client's certificate. A match happens when any principal matches with the rule. Limited to 50 principals per Authorization Policy for regional internal Application Load Balancers, regional external Application Load Balancers, cross-region internal Application Load Balancers, and Cloud Service Mesh. This field is not supported for global external Application Load Balancers. + { # Describes the properties of a principal to be matched against. + "principal": { # Determines how a string value should be matched. # Required. A non-empty string whose value is matched against the principal value based on the principal_selector. Only exact match can be applied for CLIENT_CERT_URI_SAN, CLIENT_CERT_DNS_NAME_SAN, CLIENT_CERT_COMMON_NAME selectors. + "contains": "A String", # The input string must have the substring specified here. Note: empty contains match is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc.def`` + "exact": "A String", # The input string must match exactly the string specified here. Examples: * ``abc`` only matches the value ``abc``. + "ignoreCase": True or False, # If true, indicates the exact/prefix/suffix/contains matching should be case insensitive. For example, the matcher ``data`` will match both input string ``Data`` and ``data`` if set to true. + "prefix": "A String", # The input string must have the prefix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``abc.xyz`` + "suffix": "A String", # The input string must have the suffix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc`` + }, + "principalSelector": "A String", # Optional. An enum to decide what principal value the principal rule will match against. If not specified, the PrincipalSelector is CLIENT_CERT_URI_SAN. + }, + ], + "resources": [ # Optional. A list of resources to match against the resource of the source VM of a request. Limited to 10 resources per Authorization Policy. + { # Describes the properties of a client VM resource accessing the internal application load balancers. + "iamServiceAccount": { # Determines how a string value should be matched. # Optional. An IAM service account to match against the source service account of the VM sending the request. + "contains": "A String", # The input string must have the substring specified here. Note: empty contains match is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc.def`` + "exact": "A String", # The input string must match exactly the string specified here. Examples: * ``abc`` only matches the value ``abc``. + "ignoreCase": True or False, # If true, indicates the exact/prefix/suffix/contains matching should be case insensitive. For example, the matcher ``data`` will match both input string ``Data`` and ``data`` if set to true. + "prefix": "A String", # The input string must have the prefix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``abc.xyz`` + "suffix": "A String", # The input string must have the suffix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc`` + }, + "tagValueIdSet": { # Describes a set of resource tag value permanent IDs to match against the resource manager tags value associated with the source VM of a request. # Optional. A list of resource tag value permanent IDs to match against the resource manager tags value associated with the source VM of a request. + "ids": [ # Required. A list of resource tag value permanent IDs to match against the resource manager tags value associated with the source VM of a request. The match follows AND semantics which means all the ids must match. Limited to 5 ids in the Tag value id set. + "A String", + ], + }, + }, + ], + }, + ], + "sources": [ # Optional. Describes the properties of a request's sources. At least one of sources or notSources must be specified. Limited to 1 source. A match occurs when ANY source (in sources or notSources) matches the request. Within a single source, the match follows AND semantics across fields and OR semantics within a single field, i.e. a match occurs when ANY principal matches AND ANY ipBlocks match. + { # Describes the properties of a single source. + "ipBlocks": [ # Optional. A list of IP addresses or IP address ranges to match against the source IP address of the request. Limited to 10 ip_blocks per Authorization Policy + { # Represents a range of IP Addresses. + "length": 42, # Required. The length of the address range. + "prefix": "A String", # Required. The address prefix. + }, + ], + "principals": [ # Optional. A list of identities derived from the client's certificate. This field will not match on a request unless frontend mutual TLS is enabled for the forwarding rule or Gateway and the client certificate has been successfully validated by mTLS. Each identity is a string whose value is matched against a list of URI SANs, DNS Name SANs, or the common name in the client's certificate. A match happens when any principal matches with the rule. Limited to 50 principals per Authorization Policy for regional internal Application Load Balancers, regional external Application Load Balancers, cross-region internal Application Load Balancers, and Cloud Service Mesh. This field is not supported for global external Application Load Balancers. + { # Describes the properties of a principal to be matched against. + "principal": { # Determines how a string value should be matched. # Required. A non-empty string whose value is matched against the principal value based on the principal_selector. Only exact match can be applied for CLIENT_CERT_URI_SAN, CLIENT_CERT_DNS_NAME_SAN, CLIENT_CERT_COMMON_NAME selectors. + "contains": "A String", # The input string must have the substring specified here. Note: empty contains match is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc.def`` + "exact": "A String", # The input string must match exactly the string specified here. Examples: * ``abc`` only matches the value ``abc``. + "ignoreCase": True or False, # If true, indicates the exact/prefix/suffix/contains matching should be case insensitive. For example, the matcher ``data`` will match both input string ``Data`` and ``data`` if set to true. + "prefix": "A String", # The input string must have the prefix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``abc.xyz`` + "suffix": "A String", # The input string must have the suffix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc`` + }, + "principalSelector": "A String", # Optional. An enum to decide what principal value the principal rule will match against. If not specified, the PrincipalSelector is CLIENT_CERT_URI_SAN. + }, + ], + "resources": [ # Optional. A list of resources to match against the resource of the source VM of a request. Limited to 10 resources per Authorization Policy. + { # Describes the properties of a client VM resource accessing the internal application load balancers. + "iamServiceAccount": { # Determines how a string value should be matched. # Optional. An IAM service account to match against the source service account of the VM sending the request. + "contains": "A String", # The input string must have the substring specified here. Note: empty contains match is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc.def`` + "exact": "A String", # The input string must match exactly the string specified here. Examples: * ``abc`` only matches the value ``abc``. + "ignoreCase": True or False, # If true, indicates the exact/prefix/suffix/contains matching should be case insensitive. For example, the matcher ``data`` will match both input string ``Data`` and ``data`` if set to true. + "prefix": "A String", # The input string must have the prefix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``abc.xyz`` + "suffix": "A String", # The input string must have the suffix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc`` + }, + "tagValueIdSet": { # Describes a set of resource tag value permanent IDs to match against the resource manager tags value associated with the source VM of a request. # Optional. A list of resource tag value permanent IDs to match against the resource manager tags value associated with the source VM of a request. + "ids": [ # Required. A list of resource tag value permanent IDs to match against the resource manager tags value associated with the source VM of a request. The match follows AND semantics which means all the ids must match. Limited to 5 ids in the Tag value id set. + "A String", + ], + }, + }, + ], + }, + ], + }, + "to": { # Describes properties of one or more targets of a request. # Optional. Describes properties of a target of a request. + "notOperations": [ # Optional. Describes the negated properties of the targets of a request. Matches requests for operations that do not match the criteria specified in this field. At least one of operations or notOperations must be specified. + { # Describes properties of one or more targets of a request. + "headerSet": { # Describes a set of HTTP headers to match against. # Optional. A list of headers to match against in http header. + "headers": [ # Required. A list of headers to match against in http header. The match can be one of exact, prefix, suffix, or contains (substring match). The match follows AND semantics which means all the headers must match. Matches are always case sensitive unless the ignoreCase is set. Limited to 10 headers per Authorization Policy. + { # Determines how a HTTP header should be matched. + "name": "A String", # Optional. Specifies the name of the header in the request. + "value": { # Determines how a string value should be matched. # Optional. Specifies how the header match will be performed. + "contains": "A String", # The input string must have the substring specified here. Note: empty contains match is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc.def`` + "exact": "A String", # The input string must match exactly the string specified here. Examples: * ``abc`` only matches the value ``abc``. + "ignoreCase": True or False, # If true, indicates the exact/prefix/suffix/contains matching should be case insensitive. For example, the matcher ``data`` will match both input string ``Data`` and ``data`` if set to true. + "prefix": "A String", # The input string must have the prefix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``abc.xyz`` + "suffix": "A String", # The input string must have the suffix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc`` + }, + }, + ], + }, + "hosts": [ # Optional. A list of HTTP Hosts to match against. The match can be one of exact, prefix, suffix, or contains (substring match). Matches are always case sensitive unless the ignoreCase is set. Limited to 10 hosts per Authorization Policy. + { # Determines how a string value should be matched. + "contains": "A String", # The input string must have the substring specified here. Note: empty contains match is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc.def`` + "exact": "A String", # The input string must match exactly the string specified here. Examples: * ``abc`` only matches the value ``abc``. + "ignoreCase": True or False, # If true, indicates the exact/prefix/suffix/contains matching should be case insensitive. For example, the matcher ``data`` will match both input string ``Data`` and ``data`` if set to true. + "prefix": "A String", # The input string must have the prefix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``abc.xyz`` + "suffix": "A String", # The input string must have the suffix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc`` + }, + ], + "mcp": { # Describes a set of MCP protocol attributes to match against for a given MCP request. # Optional. Defines the MCP protocol attributes to match on. If the MCP payload in the request body cannot be successfully parsed, the request will be denied. This field can be set only for AuthzPolicies targeting AgentGateway resources. + "baseProtocolMethodsOption": "A String", # Optional. If specified, matches on the MCP protocol’s non-access specific methods namely: * initialize * completion/ * logging/ * notifications/ * ping Defaults to SKIP_BASE_PROTOCOL_METHODS if not specified. + "methods": [ # Optional. A list of MCP methods and associated parameters to match on. It is recommended to use this field to match on tools, prompts and resource accesses while setting the baseProtocolMethodsOption to MATCH_BASE_PROTOCOL_METHODS to match on all the other MCP protocol methods. Limited to 10 MCP methods per Authorization Policy. + { # Describes a set of MCP methods to match against. + "name": "A String", # Required. The MCP method to match against. Allowed values are as follows: 1. `tools`, `prompts`, `resources` - these will match against all sub methods under the respective methods. 2. `prompts/list`, `tools/list`, `resources/list`, `resources/templates/list` 3. `prompts/get`, `tools/call`, `resources/subscribe`, `resources/unsubscribe`, `resources/read` Params cannot be specified for categories 1 and 2. + "params": [ # Optional. A list of MCP method parameters to match against. The match can be one of exact, prefix, suffix, or contains (substring match). Matches are always case sensitive unless the ignoreCase is set. Limited to 10 MCP method parameters per Authorization Policy. + { # Determines how a string value should be matched. + "contains": "A String", # The input string must have the substring specified here. Note: empty contains match is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc.def`` + "exact": "A String", # The input string must match exactly the string specified here. Examples: * ``abc`` only matches the value ``abc``. + "ignoreCase": True or False, # If true, indicates the exact/prefix/suffix/contains matching should be case insensitive. For example, the matcher ``data`` will match both input string ``Data`` and ``data`` if set to true. + "prefix": "A String", # The input string must have the prefix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``abc.xyz`` + "suffix": "A String", # The input string must have the suffix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc`` + }, + ], + }, + ], + }, + "methods": [ # Optional. A list of HTTP methods to match against. Each entry must be a valid HTTP method name (GET, PUT, POST, HEAD, PATCH, DELETE, OPTIONS). It only allows exact match and is always case sensitive. Limited to 10 methods per Authorization Policy. + "A String", + ], + "paths": [ # Optional. A list of paths to match against. The match can be one of exact, prefix, suffix, or contains (substring match). Matches are always case sensitive unless the ignoreCase is set. Limited to 10 paths per Authorization Policy. Note that this path match includes the query parameters. For gRPC services, this should be a fully-qualified name of the form /package.service/method. + { # Determines how a string value should be matched. + "contains": "A String", # The input string must have the substring specified here. Note: empty contains match is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc.def`` + "exact": "A String", # The input string must match exactly the string specified here. Examples: * ``abc`` only matches the value ``abc``. + "ignoreCase": True or False, # If true, indicates the exact/prefix/suffix/contains matching should be case insensitive. For example, the matcher ``data`` will match both input string ``Data`` and ``data`` if set to true. + "prefix": "A String", # The input string must have the prefix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``abc.xyz`` + "suffix": "A String", # The input string must have the suffix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc`` + }, + ], + "snis": [ # Optional. A list of SNIs to match against. The match can be one of exact, prefix, suffix, or contains (substring match). If there is no SNI (i.e. plaintext HTTP traffic), the request will be denied. Matches are always case sensitive unless the ignoreCase is set. Limited to 10 SNIs per Authorization Policy. + { # Determines how a string value should be matched. + "contains": "A String", # The input string must have the substring specified here. Note: empty contains match is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc.def`` + "exact": "A String", # The input string must match exactly the string specified here. Examples: * ``abc`` only matches the value ``abc``. + "ignoreCase": True or False, # If true, indicates the exact/prefix/suffix/contains matching should be case insensitive. For example, the matcher ``data`` will match both input string ``Data`` and ``data`` if set to true. + "prefix": "A String", # The input string must have the prefix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``abc.xyz`` + "suffix": "A String", # The input string must have the suffix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc`` + }, + ], + }, + ], + "operations": [ # Optional. Describes properties of one or more targets of a request. At least one of operations or notOperations must be specified. Limited to 1 operation. A match occurs when ANY operation (in operations or notOperations) matches. Within an operation, the match follows AND semantics across fields and OR semantics within a field, i.e. a match occurs when ANY path matches AND ANY header matches and ANY method matches. + { # Describes properties of one or more targets of a request. + "headerSet": { # Describes a set of HTTP headers to match against. # Optional. A list of headers to match against in http header. + "headers": [ # Required. A list of headers to match against in http header. The match can be one of exact, prefix, suffix, or contains (substring match). The match follows AND semantics which means all the headers must match. Matches are always case sensitive unless the ignoreCase is set. Limited to 10 headers per Authorization Policy. + { # Determines how a HTTP header should be matched. + "name": "A String", # Optional. Specifies the name of the header in the request. + "value": { # Determines how a string value should be matched. # Optional. Specifies how the header match will be performed. + "contains": "A String", # The input string must have the substring specified here. Note: empty contains match is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc.def`` + "exact": "A String", # The input string must match exactly the string specified here. Examples: * ``abc`` only matches the value ``abc``. + "ignoreCase": True or False, # If true, indicates the exact/prefix/suffix/contains matching should be case insensitive. For example, the matcher ``data`` will match both input string ``Data`` and ``data`` if set to true. + "prefix": "A String", # The input string must have the prefix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``abc.xyz`` + "suffix": "A String", # The input string must have the suffix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc`` + }, + }, + ], + }, + "hosts": [ # Optional. A list of HTTP Hosts to match against. The match can be one of exact, prefix, suffix, or contains (substring match). Matches are always case sensitive unless the ignoreCase is set. Limited to 10 hosts per Authorization Policy. + { # Determines how a string value should be matched. + "contains": "A String", # The input string must have the substring specified here. Note: empty contains match is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc.def`` + "exact": "A String", # The input string must match exactly the string specified here. Examples: * ``abc`` only matches the value ``abc``. + "ignoreCase": True or False, # If true, indicates the exact/prefix/suffix/contains matching should be case insensitive. For example, the matcher ``data`` will match both input string ``Data`` and ``data`` if set to true. + "prefix": "A String", # The input string must have the prefix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``abc.xyz`` + "suffix": "A String", # The input string must have the suffix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc`` + }, + ], + "mcp": { # Describes a set of MCP protocol attributes to match against for a given MCP request. # Optional. Defines the MCP protocol attributes to match on. If the MCP payload in the request body cannot be successfully parsed, the request will be denied. This field can be set only for AuthzPolicies targeting AgentGateway resources. + "baseProtocolMethodsOption": "A String", # Optional. If specified, matches on the MCP protocol’s non-access specific methods namely: * initialize * completion/ * logging/ * notifications/ * ping Defaults to SKIP_BASE_PROTOCOL_METHODS if not specified. + "methods": [ # Optional. A list of MCP methods and associated parameters to match on. It is recommended to use this field to match on tools, prompts and resource accesses while setting the baseProtocolMethodsOption to MATCH_BASE_PROTOCOL_METHODS to match on all the other MCP protocol methods. Limited to 10 MCP methods per Authorization Policy. + { # Describes a set of MCP methods to match against. + "name": "A String", # Required. The MCP method to match against. Allowed values are as follows: 1. `tools`, `prompts`, `resources` - these will match against all sub methods under the respective methods. 2. `prompts/list`, `tools/list`, `resources/list`, `resources/templates/list` 3. `prompts/get`, `tools/call`, `resources/subscribe`, `resources/unsubscribe`, `resources/read` Params cannot be specified for categories 1 and 2. + "params": [ # Optional. A list of MCP method parameters to match against. The match can be one of exact, prefix, suffix, or contains (substring match). Matches are always case sensitive unless the ignoreCase is set. Limited to 10 MCP method parameters per Authorization Policy. + { # Determines how a string value should be matched. + "contains": "A String", # The input string must have the substring specified here. Note: empty contains match is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc.def`` + "exact": "A String", # The input string must match exactly the string specified here. Examples: * ``abc`` only matches the value ``abc``. + "ignoreCase": True or False, # If true, indicates the exact/prefix/suffix/contains matching should be case insensitive. For example, the matcher ``data`` will match both input string ``Data`` and ``data`` if set to true. + "prefix": "A String", # The input string must have the prefix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``abc.xyz`` + "suffix": "A String", # The input string must have the suffix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc`` + }, + ], + }, + ], + }, + "methods": [ # Optional. A list of HTTP methods to match against. Each entry must be a valid HTTP method name (GET, PUT, POST, HEAD, PATCH, DELETE, OPTIONS). It only allows exact match and is always case sensitive. Limited to 10 methods per Authorization Policy. + "A String", + ], + "paths": [ # Optional. A list of paths to match against. The match can be one of exact, prefix, suffix, or contains (substring match). Matches are always case sensitive unless the ignoreCase is set. Limited to 10 paths per Authorization Policy. Note that this path match includes the query parameters. For gRPC services, this should be a fully-qualified name of the form /package.service/method. + { # Determines how a string value should be matched. + "contains": "A String", # The input string must have the substring specified here. Note: empty contains match is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc.def`` + "exact": "A String", # The input string must match exactly the string specified here. Examples: * ``abc`` only matches the value ``abc``. + "ignoreCase": True or False, # If true, indicates the exact/prefix/suffix/contains matching should be case insensitive. For example, the matcher ``data`` will match both input string ``Data`` and ``data`` if set to true. + "prefix": "A String", # The input string must have the prefix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``abc.xyz`` + "suffix": "A String", # The input string must have the suffix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc`` + }, + ], + "snis": [ # Optional. A list of SNIs to match against. The match can be one of exact, prefix, suffix, or contains (substring match). If there is no SNI (i.e. plaintext HTTP traffic), the request will be denied. Matches are always case sensitive unless the ignoreCase is set. Limited to 10 SNIs per Authorization Policy. + { # Determines how a string value should be matched. + "contains": "A String", # The input string must have the substring specified here. Note: empty contains match is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc.def`` + "exact": "A String", # The input string must match exactly the string specified here. Examples: * ``abc`` only matches the value ``abc``. + "ignoreCase": True or False, # If true, indicates the exact/prefix/suffix/contains matching should be case insensitive. For example, the matcher ``data`` will match both input string ``Data`` and ``data`` if set to true. + "prefix": "A String", # The input string must have the prefix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``abc.xyz`` + "suffix": "A String", # The input string must have the suffix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc`` + }, + ], + }, + ], + }, + "when": "A String", # Optional. CEL expression that describes the conditions to be satisfied for the action. The result of the CEL expression is ANDed with the from and to. Refer to the CEL language reference for a list of available attributes. + }, + ], "policyProfile": "A String", # Optional. Immutable. Defines the type of authorization being performed. If not specified, `REQUEST_AUTHZ` is applied. This field cannot be changed once AuthzPolicy is created. "target": { # Specifies the set of targets to which this policy should be applied to. # Required. Specifies the set of resources to which this policy should be applied to. "loadBalancingScheme": "A String", # Optional. All gateways and forwarding rules referenced by this policy and extensions must share the same load balancing scheme. Required only when targeting forwarding rules. If targeting Secure Web Proxy, this field must be `INTERNAL_MANAGED` or not specified. Must not be specified when targeting Agent Gateway. Supported values: `INTERNAL_MANAGED` and `EXTERNAL_MANAGED`. For more information, refer to [Backend services overview](https://cloud.google.com/load-balancing/docs/backend-service). @@ -572,6 +805,15 @@

Method Details

"suffix": "A String", # The input string must have the suffix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc`` }, ], + "snis": [ # Optional. A list of SNIs to match against. The match can be one of exact, prefix, suffix, or contains (substring match). If there is no SNI (i.e. plaintext HTTP traffic), the request will be denied. Matches are always case sensitive unless the ignoreCase is set. Limited to 10 SNIs per Authorization Policy. + { # Determines how a string value should be matched. + "contains": "A String", # The input string must have the substring specified here. Note: empty contains match is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc.def`` + "exact": "A String", # The input string must match exactly the string specified here. Examples: * ``abc`` only matches the value ``abc``. + "ignoreCase": True or False, # If true, indicates the exact/prefix/suffix/contains matching should be case insensitive. For example, the matcher ``data`` will match both input string ``Data`` and ``data`` if set to true. + "prefix": "A String", # The input string must have the prefix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``abc.xyz`` + "suffix": "A String", # The input string must have the suffix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc`` + }, + ], }, ], "operations": [ # Optional. Describes properties of one or more targets of a request. At least one of operations or notOperations must be specified. Limited to 1 operation. A match occurs when ANY operation (in operations or notOperations) matches. Within an operation, the match follows AND semantics across fields and OR semantics within a field, i.e. a match occurs when ANY path matches AND ANY header matches and ANY method matches. @@ -628,6 +870,15 @@

Method Details

"suffix": "A String", # The input string must have the suffix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc`` }, ], + "snis": [ # Optional. A list of SNIs to match against. The match can be one of exact, prefix, suffix, or contains (substring match). If there is no SNI (i.e. plaintext HTTP traffic), the request will be denied. Matches are always case sensitive unless the ignoreCase is set. Limited to 10 SNIs per Authorization Policy. + { # Determines how a string value should be matched. + "contains": "A String", # The input string must have the substring specified here. Note: empty contains match is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc.def`` + "exact": "A String", # The input string must match exactly the string specified here. Examples: * ``abc`` only matches the value ``abc``. + "ignoreCase": True or False, # If true, indicates the exact/prefix/suffix/contains matching should be case insensitive. For example, the matcher ``data`` will match both input string ``Data`` and ``data`` if set to true. + "prefix": "A String", # The input string must have the prefix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``abc.xyz`` + "suffix": "A String", # The input string must have the suffix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc`` + }, + ], }, ], }, @@ -638,18 +889,233 @@

Method Details

"a_key": "A String", }, "name": "A String", # Required. Identifier. Name of the `AuthzPolicy` resource in the following format: `projects/{project}/locations/{location}/authzPolicies/{authz_policy}`. - "policyProfile": "A String", # Optional. Immutable. Defines the type of authorization being performed. If not specified, `REQUEST_AUTHZ` is applied. This field cannot be changed once AuthzPolicy is created. - "target": { # Specifies the set of targets to which this policy should be applied to. # Required. Specifies the set of resources to which this policy should be applied to. - "loadBalancingScheme": "A String", # Optional. All gateways and forwarding rules referenced by this policy and extensions must share the same load balancing scheme. Required only when targeting forwarding rules. If targeting Secure Web Proxy, this field must be `INTERNAL_MANAGED` or not specified. Must not be specified when targeting Agent Gateway. Supported values: `INTERNAL_MANAGED` and `EXTERNAL_MANAGED`. For more information, refer to [Backend services overview](https://cloud.google.com/load-balancing/docs/backend-service). - "resources": [ # Required. A list of references to the Forwarding Rules, Secure Web Proxy Gateways, or Agent Gateways on which this policy will be applied. - "A String", - ], - }, - "updateTime": "A String", # Output only. The timestamp when the resource was updated. -}
-
- -
+ "networkRules": [ # Optional. A list of authorization network rules to match against the incoming request. A policy match occurs when at least one network rule matches the request. At least one network rule is required for Allow or Deny Action if no HTTP rules are provided. Network rules are mutually exclusive with HTTP rules. Limited to 5 rules. + { # Conditions to match against the incoming request. + "from": { # Describes properties of one or more sources of a request. # Optional. Describes properties of a source of a request. + "notSources": [ # Optional. Describes the negated properties of request sources. Matches requests from sources that do not match the criteria specified in this field. At least one of sources or notSources must be specified. + { # Describes the properties of a single source. + "ipBlocks": [ # Optional. A list of IP addresses or IP address ranges to match against the source IP address of the request. Limited to 10 ip_blocks per Authorization Policy + { # Represents a range of IP Addresses. + "length": 42, # Required. The length of the address range. + "prefix": "A String", # Required. The address prefix. + }, + ], + "principals": [ # Optional. A list of identities derived from the client's certificate. This field will not match on a request unless frontend mutual TLS is enabled for the forwarding rule or Gateway and the client certificate has been successfully validated by mTLS. Each identity is a string whose value is matched against a list of URI SANs, DNS Name SANs, or the common name in the client's certificate. A match happens when any principal matches with the rule. Limited to 50 principals per Authorization Policy for regional internal Application Load Balancers, regional external Application Load Balancers, cross-region internal Application Load Balancers, and Cloud Service Mesh. This field is not supported for global external Application Load Balancers. + { # Describes the properties of a principal to be matched against. + "principal": { # Determines how a string value should be matched. # Required. A non-empty string whose value is matched against the principal value based on the principal_selector. Only exact match can be applied for CLIENT_CERT_URI_SAN, CLIENT_CERT_DNS_NAME_SAN, CLIENT_CERT_COMMON_NAME selectors. + "contains": "A String", # The input string must have the substring specified here. Note: empty contains match is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc.def`` + "exact": "A String", # The input string must match exactly the string specified here. Examples: * ``abc`` only matches the value ``abc``. + "ignoreCase": True or False, # If true, indicates the exact/prefix/suffix/contains matching should be case insensitive. For example, the matcher ``data`` will match both input string ``Data`` and ``data`` if set to true. + "prefix": "A String", # The input string must have the prefix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``abc.xyz`` + "suffix": "A String", # The input string must have the suffix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc`` + }, + "principalSelector": "A String", # Optional. An enum to decide what principal value the principal rule will match against. If not specified, the PrincipalSelector is CLIENT_CERT_URI_SAN. + }, + ], + "resources": [ # Optional. A list of resources to match against the resource of the source VM of a request. Limited to 10 resources per Authorization Policy. + { # Describes the properties of a client VM resource accessing the internal application load balancers. + "iamServiceAccount": { # Determines how a string value should be matched. # Optional. An IAM service account to match against the source service account of the VM sending the request. + "contains": "A String", # The input string must have the substring specified here. Note: empty contains match is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc.def`` + "exact": "A String", # The input string must match exactly the string specified here. Examples: * ``abc`` only matches the value ``abc``. + "ignoreCase": True or False, # If true, indicates the exact/prefix/suffix/contains matching should be case insensitive. For example, the matcher ``data`` will match both input string ``Data`` and ``data`` if set to true. + "prefix": "A String", # The input string must have the prefix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``abc.xyz`` + "suffix": "A String", # The input string must have the suffix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc`` + }, + "tagValueIdSet": { # Describes a set of resource tag value permanent IDs to match against the resource manager tags value associated with the source VM of a request. # Optional. A list of resource tag value permanent IDs to match against the resource manager tags value associated with the source VM of a request. + "ids": [ # Required. A list of resource tag value permanent IDs to match against the resource manager tags value associated with the source VM of a request. The match follows AND semantics which means all the ids must match. Limited to 5 ids in the Tag value id set. + "A String", + ], + }, + }, + ], + }, + ], + "sources": [ # Optional. Describes the properties of a request's sources. At least one of sources or notSources must be specified. Limited to 1 source. A match occurs when ANY source (in sources or notSources) matches the request. Within a single source, the match follows AND semantics across fields and OR semantics within a single field, i.e. a match occurs when ANY principal matches AND ANY ipBlocks match. + { # Describes the properties of a single source. + "ipBlocks": [ # Optional. A list of IP addresses or IP address ranges to match against the source IP address of the request. Limited to 10 ip_blocks per Authorization Policy + { # Represents a range of IP Addresses. + "length": 42, # Required. The length of the address range. + "prefix": "A String", # Required. The address prefix. + }, + ], + "principals": [ # Optional. A list of identities derived from the client's certificate. This field will not match on a request unless frontend mutual TLS is enabled for the forwarding rule or Gateway and the client certificate has been successfully validated by mTLS. Each identity is a string whose value is matched against a list of URI SANs, DNS Name SANs, or the common name in the client's certificate. A match happens when any principal matches with the rule. Limited to 50 principals per Authorization Policy for regional internal Application Load Balancers, regional external Application Load Balancers, cross-region internal Application Load Balancers, and Cloud Service Mesh. This field is not supported for global external Application Load Balancers. + { # Describes the properties of a principal to be matched against. + "principal": { # Determines how a string value should be matched. # Required. A non-empty string whose value is matched against the principal value based on the principal_selector. Only exact match can be applied for CLIENT_CERT_URI_SAN, CLIENT_CERT_DNS_NAME_SAN, CLIENT_CERT_COMMON_NAME selectors. + "contains": "A String", # The input string must have the substring specified here. Note: empty contains match is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc.def`` + "exact": "A String", # The input string must match exactly the string specified here. Examples: * ``abc`` only matches the value ``abc``. + "ignoreCase": True or False, # If true, indicates the exact/prefix/suffix/contains matching should be case insensitive. For example, the matcher ``data`` will match both input string ``Data`` and ``data`` if set to true. + "prefix": "A String", # The input string must have the prefix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``abc.xyz`` + "suffix": "A String", # The input string must have the suffix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc`` + }, + "principalSelector": "A String", # Optional. An enum to decide what principal value the principal rule will match against. If not specified, the PrincipalSelector is CLIENT_CERT_URI_SAN. + }, + ], + "resources": [ # Optional. A list of resources to match against the resource of the source VM of a request. Limited to 10 resources per Authorization Policy. + { # Describes the properties of a client VM resource accessing the internal application load balancers. + "iamServiceAccount": { # Determines how a string value should be matched. # Optional. An IAM service account to match against the source service account of the VM sending the request. + "contains": "A String", # The input string must have the substring specified here. Note: empty contains match is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc.def`` + "exact": "A String", # The input string must match exactly the string specified here. Examples: * ``abc`` only matches the value ``abc``. + "ignoreCase": True or False, # If true, indicates the exact/prefix/suffix/contains matching should be case insensitive. For example, the matcher ``data`` will match both input string ``Data`` and ``data`` if set to true. + "prefix": "A String", # The input string must have the prefix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``abc.xyz`` + "suffix": "A String", # The input string must have the suffix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc`` + }, + "tagValueIdSet": { # Describes a set of resource tag value permanent IDs to match against the resource manager tags value associated with the source VM of a request. # Optional. A list of resource tag value permanent IDs to match against the resource manager tags value associated with the source VM of a request. + "ids": [ # Required. A list of resource tag value permanent IDs to match against the resource manager tags value associated with the source VM of a request. The match follows AND semantics which means all the ids must match. Limited to 5 ids in the Tag value id set. + "A String", + ], + }, + }, + ], + }, + ], + }, + "to": { # Describes properties of one or more targets of a request. # Optional. Describes properties of a target of a request. + "notOperations": [ # Optional. Describes the negated properties of the targets of a request. Matches requests for operations that do not match the criteria specified in this field. At least one of operations or notOperations must be specified. + { # Describes properties of one or more targets of a request. + "headerSet": { # Describes a set of HTTP headers to match against. # Optional. A list of headers to match against in http header. + "headers": [ # Required. A list of headers to match against in http header. The match can be one of exact, prefix, suffix, or contains (substring match). The match follows AND semantics which means all the headers must match. Matches are always case sensitive unless the ignoreCase is set. Limited to 10 headers per Authorization Policy. + { # Determines how a HTTP header should be matched. + "name": "A String", # Optional. Specifies the name of the header in the request. + "value": { # Determines how a string value should be matched. # Optional. Specifies how the header match will be performed. + "contains": "A String", # The input string must have the substring specified here. Note: empty contains match is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc.def`` + "exact": "A String", # The input string must match exactly the string specified here. Examples: * ``abc`` only matches the value ``abc``. + "ignoreCase": True or False, # If true, indicates the exact/prefix/suffix/contains matching should be case insensitive. For example, the matcher ``data`` will match both input string ``Data`` and ``data`` if set to true. + "prefix": "A String", # The input string must have the prefix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``abc.xyz`` + "suffix": "A String", # The input string must have the suffix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc`` + }, + }, + ], + }, + "hosts": [ # Optional. A list of HTTP Hosts to match against. The match can be one of exact, prefix, suffix, or contains (substring match). Matches are always case sensitive unless the ignoreCase is set. Limited to 10 hosts per Authorization Policy. + { # Determines how a string value should be matched. + "contains": "A String", # The input string must have the substring specified here. Note: empty contains match is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc.def`` + "exact": "A String", # The input string must match exactly the string specified here. Examples: * ``abc`` only matches the value ``abc``. + "ignoreCase": True or False, # If true, indicates the exact/prefix/suffix/contains matching should be case insensitive. For example, the matcher ``data`` will match both input string ``Data`` and ``data`` if set to true. + "prefix": "A String", # The input string must have the prefix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``abc.xyz`` + "suffix": "A String", # The input string must have the suffix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc`` + }, + ], + "mcp": { # Describes a set of MCP protocol attributes to match against for a given MCP request. # Optional. Defines the MCP protocol attributes to match on. If the MCP payload in the request body cannot be successfully parsed, the request will be denied. This field can be set only for AuthzPolicies targeting AgentGateway resources. + "baseProtocolMethodsOption": "A String", # Optional. If specified, matches on the MCP protocol’s non-access specific methods namely: * initialize * completion/ * logging/ * notifications/ * ping Defaults to SKIP_BASE_PROTOCOL_METHODS if not specified. + "methods": [ # Optional. A list of MCP methods and associated parameters to match on. It is recommended to use this field to match on tools, prompts and resource accesses while setting the baseProtocolMethodsOption to MATCH_BASE_PROTOCOL_METHODS to match on all the other MCP protocol methods. Limited to 10 MCP methods per Authorization Policy. + { # Describes a set of MCP methods to match against. + "name": "A String", # Required. The MCP method to match against. Allowed values are as follows: 1. `tools`, `prompts`, `resources` - these will match against all sub methods under the respective methods. 2. `prompts/list`, `tools/list`, `resources/list`, `resources/templates/list` 3. `prompts/get`, `tools/call`, `resources/subscribe`, `resources/unsubscribe`, `resources/read` Params cannot be specified for categories 1 and 2. + "params": [ # Optional. A list of MCP method parameters to match against. The match can be one of exact, prefix, suffix, or contains (substring match). Matches are always case sensitive unless the ignoreCase is set. Limited to 10 MCP method parameters per Authorization Policy. + { # Determines how a string value should be matched. + "contains": "A String", # The input string must have the substring specified here. Note: empty contains match is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc.def`` + "exact": "A String", # The input string must match exactly the string specified here. Examples: * ``abc`` only matches the value ``abc``. + "ignoreCase": True or False, # If true, indicates the exact/prefix/suffix/contains matching should be case insensitive. For example, the matcher ``data`` will match both input string ``Data`` and ``data`` if set to true. + "prefix": "A String", # The input string must have the prefix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``abc.xyz`` + "suffix": "A String", # The input string must have the suffix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc`` + }, + ], + }, + ], + }, + "methods": [ # Optional. A list of HTTP methods to match against. Each entry must be a valid HTTP method name (GET, PUT, POST, HEAD, PATCH, DELETE, OPTIONS). It only allows exact match and is always case sensitive. Limited to 10 methods per Authorization Policy. + "A String", + ], + "paths": [ # Optional. A list of paths to match against. The match can be one of exact, prefix, suffix, or contains (substring match). Matches are always case sensitive unless the ignoreCase is set. Limited to 10 paths per Authorization Policy. Note that this path match includes the query parameters. For gRPC services, this should be a fully-qualified name of the form /package.service/method. + { # Determines how a string value should be matched. + "contains": "A String", # The input string must have the substring specified here. Note: empty contains match is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc.def`` + "exact": "A String", # The input string must match exactly the string specified here. Examples: * ``abc`` only matches the value ``abc``. + "ignoreCase": True or False, # If true, indicates the exact/prefix/suffix/contains matching should be case insensitive. For example, the matcher ``data`` will match both input string ``Data`` and ``data`` if set to true. + "prefix": "A String", # The input string must have the prefix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``abc.xyz`` + "suffix": "A String", # The input string must have the suffix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc`` + }, + ], + "snis": [ # Optional. A list of SNIs to match against. The match can be one of exact, prefix, suffix, or contains (substring match). If there is no SNI (i.e. plaintext HTTP traffic), the request will be denied. Matches are always case sensitive unless the ignoreCase is set. Limited to 10 SNIs per Authorization Policy. + { # Determines how a string value should be matched. + "contains": "A String", # The input string must have the substring specified here. Note: empty contains match is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc.def`` + "exact": "A String", # The input string must match exactly the string specified here. Examples: * ``abc`` only matches the value ``abc``. + "ignoreCase": True or False, # If true, indicates the exact/prefix/suffix/contains matching should be case insensitive. For example, the matcher ``data`` will match both input string ``Data`` and ``data`` if set to true. + "prefix": "A String", # The input string must have the prefix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``abc.xyz`` + "suffix": "A String", # The input string must have the suffix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc`` + }, + ], + }, + ], + "operations": [ # Optional. Describes properties of one or more targets of a request. At least one of operations or notOperations must be specified. Limited to 1 operation. A match occurs when ANY operation (in operations or notOperations) matches. Within an operation, the match follows AND semantics across fields and OR semantics within a field, i.e. a match occurs when ANY path matches AND ANY header matches and ANY method matches. + { # Describes properties of one or more targets of a request. + "headerSet": { # Describes a set of HTTP headers to match against. # Optional. A list of headers to match against in http header. + "headers": [ # Required. A list of headers to match against in http header. The match can be one of exact, prefix, suffix, or contains (substring match). The match follows AND semantics which means all the headers must match. Matches are always case sensitive unless the ignoreCase is set. Limited to 10 headers per Authorization Policy. + { # Determines how a HTTP header should be matched. + "name": "A String", # Optional. Specifies the name of the header in the request. + "value": { # Determines how a string value should be matched. # Optional. Specifies how the header match will be performed. + "contains": "A String", # The input string must have the substring specified here. Note: empty contains match is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc.def`` + "exact": "A String", # The input string must match exactly the string specified here. Examples: * ``abc`` only matches the value ``abc``. + "ignoreCase": True or False, # If true, indicates the exact/prefix/suffix/contains matching should be case insensitive. For example, the matcher ``data`` will match both input string ``Data`` and ``data`` if set to true. + "prefix": "A String", # The input string must have the prefix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``abc.xyz`` + "suffix": "A String", # The input string must have the suffix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc`` + }, + }, + ], + }, + "hosts": [ # Optional. A list of HTTP Hosts to match against. The match can be one of exact, prefix, suffix, or contains (substring match). Matches are always case sensitive unless the ignoreCase is set. Limited to 10 hosts per Authorization Policy. + { # Determines how a string value should be matched. + "contains": "A String", # The input string must have the substring specified here. Note: empty contains match is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc.def`` + "exact": "A String", # The input string must match exactly the string specified here. Examples: * ``abc`` only matches the value ``abc``. + "ignoreCase": True or False, # If true, indicates the exact/prefix/suffix/contains matching should be case insensitive. For example, the matcher ``data`` will match both input string ``Data`` and ``data`` if set to true. + "prefix": "A String", # The input string must have the prefix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``abc.xyz`` + "suffix": "A String", # The input string must have the suffix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc`` + }, + ], + "mcp": { # Describes a set of MCP protocol attributes to match against for a given MCP request. # Optional. Defines the MCP protocol attributes to match on. If the MCP payload in the request body cannot be successfully parsed, the request will be denied. This field can be set only for AuthzPolicies targeting AgentGateway resources. + "baseProtocolMethodsOption": "A String", # Optional. If specified, matches on the MCP protocol’s non-access specific methods namely: * initialize * completion/ * logging/ * notifications/ * ping Defaults to SKIP_BASE_PROTOCOL_METHODS if not specified. + "methods": [ # Optional. A list of MCP methods and associated parameters to match on. It is recommended to use this field to match on tools, prompts and resource accesses while setting the baseProtocolMethodsOption to MATCH_BASE_PROTOCOL_METHODS to match on all the other MCP protocol methods. Limited to 10 MCP methods per Authorization Policy. + { # Describes a set of MCP methods to match against. + "name": "A String", # Required. The MCP method to match against. Allowed values are as follows: 1. `tools`, `prompts`, `resources` - these will match against all sub methods under the respective methods. 2. `prompts/list`, `tools/list`, `resources/list`, `resources/templates/list` 3. `prompts/get`, `tools/call`, `resources/subscribe`, `resources/unsubscribe`, `resources/read` Params cannot be specified for categories 1 and 2. + "params": [ # Optional. A list of MCP method parameters to match against. The match can be one of exact, prefix, suffix, or contains (substring match). Matches are always case sensitive unless the ignoreCase is set. Limited to 10 MCP method parameters per Authorization Policy. + { # Determines how a string value should be matched. + "contains": "A String", # The input string must have the substring specified here. Note: empty contains match is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc.def`` + "exact": "A String", # The input string must match exactly the string specified here. Examples: * ``abc`` only matches the value ``abc``. + "ignoreCase": True or False, # If true, indicates the exact/prefix/suffix/contains matching should be case insensitive. For example, the matcher ``data`` will match both input string ``Data`` and ``data`` if set to true. + "prefix": "A String", # The input string must have the prefix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``abc.xyz`` + "suffix": "A String", # The input string must have the suffix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc`` + }, + ], + }, + ], + }, + "methods": [ # Optional. A list of HTTP methods to match against. Each entry must be a valid HTTP method name (GET, PUT, POST, HEAD, PATCH, DELETE, OPTIONS). It only allows exact match and is always case sensitive. Limited to 10 methods per Authorization Policy. + "A String", + ], + "paths": [ # Optional. A list of paths to match against. The match can be one of exact, prefix, suffix, or contains (substring match). Matches are always case sensitive unless the ignoreCase is set. Limited to 10 paths per Authorization Policy. Note that this path match includes the query parameters. For gRPC services, this should be a fully-qualified name of the form /package.service/method. + { # Determines how a string value should be matched. + "contains": "A String", # The input string must have the substring specified here. Note: empty contains match is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc.def`` + "exact": "A String", # The input string must match exactly the string specified here. Examples: * ``abc`` only matches the value ``abc``. + "ignoreCase": True or False, # If true, indicates the exact/prefix/suffix/contains matching should be case insensitive. For example, the matcher ``data`` will match both input string ``Data`` and ``data`` if set to true. + "prefix": "A String", # The input string must have the prefix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``abc.xyz`` + "suffix": "A String", # The input string must have the suffix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc`` + }, + ], + "snis": [ # Optional. A list of SNIs to match against. The match can be one of exact, prefix, suffix, or contains (substring match). If there is no SNI (i.e. plaintext HTTP traffic), the request will be denied. Matches are always case sensitive unless the ignoreCase is set. Limited to 10 SNIs per Authorization Policy. + { # Determines how a string value should be matched. + "contains": "A String", # The input string must have the substring specified here. Note: empty contains match is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc.def`` + "exact": "A String", # The input string must match exactly the string specified here. Examples: * ``abc`` only matches the value ``abc``. + "ignoreCase": True or False, # If true, indicates the exact/prefix/suffix/contains matching should be case insensitive. For example, the matcher ``data`` will match both input string ``Data`` and ``data`` if set to true. + "prefix": "A String", # The input string must have the prefix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``abc.xyz`` + "suffix": "A String", # The input string must have the suffix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc`` + }, + ], + }, + ], + }, + "when": "A String", # Optional. CEL expression that describes the conditions to be satisfied for the action. The result of the CEL expression is ANDed with the from and to. Refer to the CEL language reference for a list of available attributes. + }, + ], + "policyProfile": "A String", # Optional. Immutable. Defines the type of authorization being performed. If not specified, `REQUEST_AUTHZ` is applied. This field cannot be changed once AuthzPolicy is created. + "target": { # Specifies the set of targets to which this policy should be applied to. # Required. Specifies the set of resources to which this policy should be applied to. + "loadBalancingScheme": "A String", # Optional. All gateways and forwarding rules referenced by this policy and extensions must share the same load balancing scheme. Required only when targeting forwarding rules. If targeting Secure Web Proxy, this field must be `INTERNAL_MANAGED` or not specified. Must not be specified when targeting Agent Gateway. Supported values: `INTERNAL_MANAGED` and `EXTERNAL_MANAGED`. For more information, refer to [Backend services overview](https://cloud.google.com/load-balancing/docs/backend-service). + "resources": [ # Required. A list of references to the Forwarding Rules, Secure Web Proxy Gateways, or Agent Gateways on which this policy will be applied. + "A String", + ], + }, + "updateTime": "A String", # Output only. The timestamp when the resource was updated. +}
+
+ +
getIamPolicy(resource, options_requestedPolicyVersion=None, x__xgafv=None)
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
 
@@ -729,8 +1195,227 @@ 

Method Details

"cloudIap": { # Optional. Delegates authorization decisions to Cloud IAP. Applicable only for managed load balancers. Enabling Cloud IAP at the AuthzPolicy level is not compatible with Cloud IAP settings in the BackendService. Enabling IAP in both places will result in request failure. Ensure that IAP is enabled in either the AuthzPolicy or the BackendService but not in both places. # Optional. Delegates authorization decisions to Cloud IAP. Applicable only for managed load balancers. Enabling Cloud IAP at the AuthzPolicy level is not compatible with Cloud IAP settings in the BackendService. Enabling IAP in both places will result in request failure. Ensure that IAP is enabled in either the AuthzPolicy or the BackendService but not in both places. }, }, - "description": "A String", # Optional. A human-readable description of the resource. - "httpRules": [ # Optional. A list of authorization HTTP rules to match against the incoming request. A policy match occurs when at least one HTTP rule matches the request or when no HTTP rules are specified in the policy. At least one HTTP Rule is required for Allow or Deny Action. Limited to 5 rules. + "description": "A String", # Optional. A human-readable description of the resource. + "httpRules": [ # Optional. A list of authorization HTTP rules to match against the incoming request. A policy match occurs when at least one HTTP rule matches the request or when no HTTP rules are specified in the policy. At least one HTTP Rule is required for Allow or Deny Action. Limited to 5 rules. + { # Conditions to match against the incoming request. + "from": { # Describes properties of one or more sources of a request. # Optional. Describes properties of a source of a request. + "notSources": [ # Optional. Describes the negated properties of request sources. Matches requests from sources that do not match the criteria specified in this field. At least one of sources or notSources must be specified. + { # Describes the properties of a single source. + "ipBlocks": [ # Optional. A list of IP addresses or IP address ranges to match against the source IP address of the request. Limited to 10 ip_blocks per Authorization Policy + { # Represents a range of IP Addresses. + "length": 42, # Required. The length of the address range. + "prefix": "A String", # Required. The address prefix. + }, + ], + "principals": [ # Optional. A list of identities derived from the client's certificate. This field will not match on a request unless frontend mutual TLS is enabled for the forwarding rule or Gateway and the client certificate has been successfully validated by mTLS. Each identity is a string whose value is matched against a list of URI SANs, DNS Name SANs, or the common name in the client's certificate. A match happens when any principal matches with the rule. Limited to 50 principals per Authorization Policy for regional internal Application Load Balancers, regional external Application Load Balancers, cross-region internal Application Load Balancers, and Cloud Service Mesh. This field is not supported for global external Application Load Balancers. + { # Describes the properties of a principal to be matched against. + "principal": { # Determines how a string value should be matched. # Required. A non-empty string whose value is matched against the principal value based on the principal_selector. Only exact match can be applied for CLIENT_CERT_URI_SAN, CLIENT_CERT_DNS_NAME_SAN, CLIENT_CERT_COMMON_NAME selectors. + "contains": "A String", # The input string must have the substring specified here. Note: empty contains match is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc.def`` + "exact": "A String", # The input string must match exactly the string specified here. Examples: * ``abc`` only matches the value ``abc``. + "ignoreCase": True or False, # If true, indicates the exact/prefix/suffix/contains matching should be case insensitive. For example, the matcher ``data`` will match both input string ``Data`` and ``data`` if set to true. + "prefix": "A String", # The input string must have the prefix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``abc.xyz`` + "suffix": "A String", # The input string must have the suffix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc`` + }, + "principalSelector": "A String", # Optional. An enum to decide what principal value the principal rule will match against. If not specified, the PrincipalSelector is CLIENT_CERT_URI_SAN. + }, + ], + "resources": [ # Optional. A list of resources to match against the resource of the source VM of a request. Limited to 10 resources per Authorization Policy. + { # Describes the properties of a client VM resource accessing the internal application load balancers. + "iamServiceAccount": { # Determines how a string value should be matched. # Optional. An IAM service account to match against the source service account of the VM sending the request. + "contains": "A String", # The input string must have the substring specified here. Note: empty contains match is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc.def`` + "exact": "A String", # The input string must match exactly the string specified here. Examples: * ``abc`` only matches the value ``abc``. + "ignoreCase": True or False, # If true, indicates the exact/prefix/suffix/contains matching should be case insensitive. For example, the matcher ``data`` will match both input string ``Data`` and ``data`` if set to true. + "prefix": "A String", # The input string must have the prefix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``abc.xyz`` + "suffix": "A String", # The input string must have the suffix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc`` + }, + "tagValueIdSet": { # Describes a set of resource tag value permanent IDs to match against the resource manager tags value associated with the source VM of a request. # Optional. A list of resource tag value permanent IDs to match against the resource manager tags value associated with the source VM of a request. + "ids": [ # Required. A list of resource tag value permanent IDs to match against the resource manager tags value associated with the source VM of a request. The match follows AND semantics which means all the ids must match. Limited to 5 ids in the Tag value id set. + "A String", + ], + }, + }, + ], + }, + ], + "sources": [ # Optional. Describes the properties of a request's sources. At least one of sources or notSources must be specified. Limited to 1 source. A match occurs when ANY source (in sources or notSources) matches the request. Within a single source, the match follows AND semantics across fields and OR semantics within a single field, i.e. a match occurs when ANY principal matches AND ANY ipBlocks match. + { # Describes the properties of a single source. + "ipBlocks": [ # Optional. A list of IP addresses or IP address ranges to match against the source IP address of the request. Limited to 10 ip_blocks per Authorization Policy + { # Represents a range of IP Addresses. + "length": 42, # Required. The length of the address range. + "prefix": "A String", # Required. The address prefix. + }, + ], + "principals": [ # Optional. A list of identities derived from the client's certificate. This field will not match on a request unless frontend mutual TLS is enabled for the forwarding rule or Gateway and the client certificate has been successfully validated by mTLS. Each identity is a string whose value is matched against a list of URI SANs, DNS Name SANs, or the common name in the client's certificate. A match happens when any principal matches with the rule. Limited to 50 principals per Authorization Policy for regional internal Application Load Balancers, regional external Application Load Balancers, cross-region internal Application Load Balancers, and Cloud Service Mesh. This field is not supported for global external Application Load Balancers. + { # Describes the properties of a principal to be matched against. + "principal": { # Determines how a string value should be matched. # Required. A non-empty string whose value is matched against the principal value based on the principal_selector. Only exact match can be applied for CLIENT_CERT_URI_SAN, CLIENT_CERT_DNS_NAME_SAN, CLIENT_CERT_COMMON_NAME selectors. + "contains": "A String", # The input string must have the substring specified here. Note: empty contains match is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc.def`` + "exact": "A String", # The input string must match exactly the string specified here. Examples: * ``abc`` only matches the value ``abc``. + "ignoreCase": True or False, # If true, indicates the exact/prefix/suffix/contains matching should be case insensitive. For example, the matcher ``data`` will match both input string ``Data`` and ``data`` if set to true. + "prefix": "A String", # The input string must have the prefix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``abc.xyz`` + "suffix": "A String", # The input string must have the suffix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc`` + }, + "principalSelector": "A String", # Optional. An enum to decide what principal value the principal rule will match against. If not specified, the PrincipalSelector is CLIENT_CERT_URI_SAN. + }, + ], + "resources": [ # Optional. A list of resources to match against the resource of the source VM of a request. Limited to 10 resources per Authorization Policy. + { # Describes the properties of a client VM resource accessing the internal application load balancers. + "iamServiceAccount": { # Determines how a string value should be matched. # Optional. An IAM service account to match against the source service account of the VM sending the request. + "contains": "A String", # The input string must have the substring specified here. Note: empty contains match is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc.def`` + "exact": "A String", # The input string must match exactly the string specified here. Examples: * ``abc`` only matches the value ``abc``. + "ignoreCase": True or False, # If true, indicates the exact/prefix/suffix/contains matching should be case insensitive. For example, the matcher ``data`` will match both input string ``Data`` and ``data`` if set to true. + "prefix": "A String", # The input string must have the prefix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``abc.xyz`` + "suffix": "A String", # The input string must have the suffix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc`` + }, + "tagValueIdSet": { # Describes a set of resource tag value permanent IDs to match against the resource manager tags value associated with the source VM of a request. # Optional. A list of resource tag value permanent IDs to match against the resource manager tags value associated with the source VM of a request. + "ids": [ # Required. A list of resource tag value permanent IDs to match against the resource manager tags value associated with the source VM of a request. The match follows AND semantics which means all the ids must match. Limited to 5 ids in the Tag value id set. + "A String", + ], + }, + }, + ], + }, + ], + }, + "to": { # Describes properties of one or more targets of a request. # Optional. Describes properties of a target of a request. + "notOperations": [ # Optional. Describes the negated properties of the targets of a request. Matches requests for operations that do not match the criteria specified in this field. At least one of operations or notOperations must be specified. + { # Describes properties of one or more targets of a request. + "headerSet": { # Describes a set of HTTP headers to match against. # Optional. A list of headers to match against in http header. + "headers": [ # Required. A list of headers to match against in http header. The match can be one of exact, prefix, suffix, or contains (substring match). The match follows AND semantics which means all the headers must match. Matches are always case sensitive unless the ignoreCase is set. Limited to 10 headers per Authorization Policy. + { # Determines how a HTTP header should be matched. + "name": "A String", # Optional. Specifies the name of the header in the request. + "value": { # Determines how a string value should be matched. # Optional. Specifies how the header match will be performed. + "contains": "A String", # The input string must have the substring specified here. Note: empty contains match is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc.def`` + "exact": "A String", # The input string must match exactly the string specified here. Examples: * ``abc`` only matches the value ``abc``. + "ignoreCase": True or False, # If true, indicates the exact/prefix/suffix/contains matching should be case insensitive. For example, the matcher ``data`` will match both input string ``Data`` and ``data`` if set to true. + "prefix": "A String", # The input string must have the prefix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``abc.xyz`` + "suffix": "A String", # The input string must have the suffix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc`` + }, + }, + ], + }, + "hosts": [ # Optional. A list of HTTP Hosts to match against. The match can be one of exact, prefix, suffix, or contains (substring match). Matches are always case sensitive unless the ignoreCase is set. Limited to 10 hosts per Authorization Policy. + { # Determines how a string value should be matched. + "contains": "A String", # The input string must have the substring specified here. Note: empty contains match is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc.def`` + "exact": "A String", # The input string must match exactly the string specified here. Examples: * ``abc`` only matches the value ``abc``. + "ignoreCase": True or False, # If true, indicates the exact/prefix/suffix/contains matching should be case insensitive. For example, the matcher ``data`` will match both input string ``Data`` and ``data`` if set to true. + "prefix": "A String", # The input string must have the prefix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``abc.xyz`` + "suffix": "A String", # The input string must have the suffix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc`` + }, + ], + "mcp": { # Describes a set of MCP protocol attributes to match against for a given MCP request. # Optional. Defines the MCP protocol attributes to match on. If the MCP payload in the request body cannot be successfully parsed, the request will be denied. This field can be set only for AuthzPolicies targeting AgentGateway resources. + "baseProtocolMethodsOption": "A String", # Optional. If specified, matches on the MCP protocol’s non-access specific methods namely: * initialize * completion/ * logging/ * notifications/ * ping Defaults to SKIP_BASE_PROTOCOL_METHODS if not specified. + "methods": [ # Optional. A list of MCP methods and associated parameters to match on. It is recommended to use this field to match on tools, prompts and resource accesses while setting the baseProtocolMethodsOption to MATCH_BASE_PROTOCOL_METHODS to match on all the other MCP protocol methods. Limited to 10 MCP methods per Authorization Policy. + { # Describes a set of MCP methods to match against. + "name": "A String", # Required. The MCP method to match against. Allowed values are as follows: 1. `tools`, `prompts`, `resources` - these will match against all sub methods under the respective methods. 2. `prompts/list`, `tools/list`, `resources/list`, `resources/templates/list` 3. `prompts/get`, `tools/call`, `resources/subscribe`, `resources/unsubscribe`, `resources/read` Params cannot be specified for categories 1 and 2. + "params": [ # Optional. A list of MCP method parameters to match against. The match can be one of exact, prefix, suffix, or contains (substring match). Matches are always case sensitive unless the ignoreCase is set. Limited to 10 MCP method parameters per Authorization Policy. + { # Determines how a string value should be matched. + "contains": "A String", # The input string must have the substring specified here. Note: empty contains match is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc.def`` + "exact": "A String", # The input string must match exactly the string specified here. Examples: * ``abc`` only matches the value ``abc``. + "ignoreCase": True or False, # If true, indicates the exact/prefix/suffix/contains matching should be case insensitive. For example, the matcher ``data`` will match both input string ``Data`` and ``data`` if set to true. + "prefix": "A String", # The input string must have the prefix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``abc.xyz`` + "suffix": "A String", # The input string must have the suffix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc`` + }, + ], + }, + ], + }, + "methods": [ # Optional. A list of HTTP methods to match against. Each entry must be a valid HTTP method name (GET, PUT, POST, HEAD, PATCH, DELETE, OPTIONS). It only allows exact match and is always case sensitive. Limited to 10 methods per Authorization Policy. + "A String", + ], + "paths": [ # Optional. A list of paths to match against. The match can be one of exact, prefix, suffix, or contains (substring match). Matches are always case sensitive unless the ignoreCase is set. Limited to 10 paths per Authorization Policy. Note that this path match includes the query parameters. For gRPC services, this should be a fully-qualified name of the form /package.service/method. + { # Determines how a string value should be matched. + "contains": "A String", # The input string must have the substring specified here. Note: empty contains match is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc.def`` + "exact": "A String", # The input string must match exactly the string specified here. Examples: * ``abc`` only matches the value ``abc``. + "ignoreCase": True or False, # If true, indicates the exact/prefix/suffix/contains matching should be case insensitive. For example, the matcher ``data`` will match both input string ``Data`` and ``data`` if set to true. + "prefix": "A String", # The input string must have the prefix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``abc.xyz`` + "suffix": "A String", # The input string must have the suffix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc`` + }, + ], + "snis": [ # Optional. A list of SNIs to match against. The match can be one of exact, prefix, suffix, or contains (substring match). If there is no SNI (i.e. plaintext HTTP traffic), the request will be denied. Matches are always case sensitive unless the ignoreCase is set. Limited to 10 SNIs per Authorization Policy. + { # Determines how a string value should be matched. + "contains": "A String", # The input string must have the substring specified here. Note: empty contains match is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc.def`` + "exact": "A String", # The input string must match exactly the string specified here. Examples: * ``abc`` only matches the value ``abc``. + "ignoreCase": True or False, # If true, indicates the exact/prefix/suffix/contains matching should be case insensitive. For example, the matcher ``data`` will match both input string ``Data`` and ``data`` if set to true. + "prefix": "A String", # The input string must have the prefix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``abc.xyz`` + "suffix": "A String", # The input string must have the suffix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc`` + }, + ], + }, + ], + "operations": [ # Optional. Describes properties of one or more targets of a request. At least one of operations or notOperations must be specified. Limited to 1 operation. A match occurs when ANY operation (in operations or notOperations) matches. Within an operation, the match follows AND semantics across fields and OR semantics within a field, i.e. a match occurs when ANY path matches AND ANY header matches and ANY method matches. + { # Describes properties of one or more targets of a request. + "headerSet": { # Describes a set of HTTP headers to match against. # Optional. A list of headers to match against in http header. + "headers": [ # Required. A list of headers to match against in http header. The match can be one of exact, prefix, suffix, or contains (substring match). The match follows AND semantics which means all the headers must match. Matches are always case sensitive unless the ignoreCase is set. Limited to 10 headers per Authorization Policy. + { # Determines how a HTTP header should be matched. + "name": "A String", # Optional. Specifies the name of the header in the request. + "value": { # Determines how a string value should be matched. # Optional. Specifies how the header match will be performed. + "contains": "A String", # The input string must have the substring specified here. Note: empty contains match is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc.def`` + "exact": "A String", # The input string must match exactly the string specified here. Examples: * ``abc`` only matches the value ``abc``. + "ignoreCase": True or False, # If true, indicates the exact/prefix/suffix/contains matching should be case insensitive. For example, the matcher ``data`` will match both input string ``Data`` and ``data`` if set to true. + "prefix": "A String", # The input string must have the prefix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``abc.xyz`` + "suffix": "A String", # The input string must have the suffix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc`` + }, + }, + ], + }, + "hosts": [ # Optional. A list of HTTP Hosts to match against. The match can be one of exact, prefix, suffix, or contains (substring match). Matches are always case sensitive unless the ignoreCase is set. Limited to 10 hosts per Authorization Policy. + { # Determines how a string value should be matched. + "contains": "A String", # The input string must have the substring specified here. Note: empty contains match is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc.def`` + "exact": "A String", # The input string must match exactly the string specified here. Examples: * ``abc`` only matches the value ``abc``. + "ignoreCase": True or False, # If true, indicates the exact/prefix/suffix/contains matching should be case insensitive. For example, the matcher ``data`` will match both input string ``Data`` and ``data`` if set to true. + "prefix": "A String", # The input string must have the prefix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``abc.xyz`` + "suffix": "A String", # The input string must have the suffix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc`` + }, + ], + "mcp": { # Describes a set of MCP protocol attributes to match against for a given MCP request. # Optional. Defines the MCP protocol attributes to match on. If the MCP payload in the request body cannot be successfully parsed, the request will be denied. This field can be set only for AuthzPolicies targeting AgentGateway resources. + "baseProtocolMethodsOption": "A String", # Optional. If specified, matches on the MCP protocol’s non-access specific methods namely: * initialize * completion/ * logging/ * notifications/ * ping Defaults to SKIP_BASE_PROTOCOL_METHODS if not specified. + "methods": [ # Optional. A list of MCP methods and associated parameters to match on. It is recommended to use this field to match on tools, prompts and resource accesses while setting the baseProtocolMethodsOption to MATCH_BASE_PROTOCOL_METHODS to match on all the other MCP protocol methods. Limited to 10 MCP methods per Authorization Policy. + { # Describes a set of MCP methods to match against. + "name": "A String", # Required. The MCP method to match against. Allowed values are as follows: 1. `tools`, `prompts`, `resources` - these will match against all sub methods under the respective methods. 2. `prompts/list`, `tools/list`, `resources/list`, `resources/templates/list` 3. `prompts/get`, `tools/call`, `resources/subscribe`, `resources/unsubscribe`, `resources/read` Params cannot be specified for categories 1 and 2. + "params": [ # Optional. A list of MCP method parameters to match against. The match can be one of exact, prefix, suffix, or contains (substring match). Matches are always case sensitive unless the ignoreCase is set. Limited to 10 MCP method parameters per Authorization Policy. + { # Determines how a string value should be matched. + "contains": "A String", # The input string must have the substring specified here. Note: empty contains match is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc.def`` + "exact": "A String", # The input string must match exactly the string specified here. Examples: * ``abc`` only matches the value ``abc``. + "ignoreCase": True or False, # If true, indicates the exact/prefix/suffix/contains matching should be case insensitive. For example, the matcher ``data`` will match both input string ``Data`` and ``data`` if set to true. + "prefix": "A String", # The input string must have the prefix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``abc.xyz`` + "suffix": "A String", # The input string must have the suffix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc`` + }, + ], + }, + ], + }, + "methods": [ # Optional. A list of HTTP methods to match against. Each entry must be a valid HTTP method name (GET, PUT, POST, HEAD, PATCH, DELETE, OPTIONS). It only allows exact match and is always case sensitive. Limited to 10 methods per Authorization Policy. + "A String", + ], + "paths": [ # Optional. A list of paths to match against. The match can be one of exact, prefix, suffix, or contains (substring match). Matches are always case sensitive unless the ignoreCase is set. Limited to 10 paths per Authorization Policy. Note that this path match includes the query parameters. For gRPC services, this should be a fully-qualified name of the form /package.service/method. + { # Determines how a string value should be matched. + "contains": "A String", # The input string must have the substring specified here. Note: empty contains match is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc.def`` + "exact": "A String", # The input string must match exactly the string specified here. Examples: * ``abc`` only matches the value ``abc``. + "ignoreCase": True or False, # If true, indicates the exact/prefix/suffix/contains matching should be case insensitive. For example, the matcher ``data`` will match both input string ``Data`` and ``data`` if set to true. + "prefix": "A String", # The input string must have the prefix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``abc.xyz`` + "suffix": "A String", # The input string must have the suffix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc`` + }, + ], + "snis": [ # Optional. A list of SNIs to match against. The match can be one of exact, prefix, suffix, or contains (substring match). If there is no SNI (i.e. plaintext HTTP traffic), the request will be denied. Matches are always case sensitive unless the ignoreCase is set. Limited to 10 SNIs per Authorization Policy. + { # Determines how a string value should be matched. + "contains": "A String", # The input string must have the substring specified here. Note: empty contains match is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc.def`` + "exact": "A String", # The input string must match exactly the string specified here. Examples: * ``abc`` only matches the value ``abc``. + "ignoreCase": True or False, # If true, indicates the exact/prefix/suffix/contains matching should be case insensitive. For example, the matcher ``data`` will match both input string ``Data`` and ``data`` if set to true. + "prefix": "A String", # The input string must have the prefix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``abc.xyz`` + "suffix": "A String", # The input string must have the suffix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc`` + }, + ], + }, + ], + }, + "when": "A String", # Optional. CEL expression that describes the conditions to be satisfied for the action. The result of the CEL expression is ANDed with the from and to. Refer to the CEL language reference for a list of available attributes. + }, + ], + "labels": { # Optional. Set of labels associated with the `AuthzPolicy` resource. The format must comply with [the following requirements](/compute/docs/labeling-resources#requirements). + "a_key": "A String", + }, + "name": "A String", # Required. Identifier. Name of the `AuthzPolicy` resource in the following format: `projects/{project}/locations/{location}/authzPolicies/{authz_policy}`. + "networkRules": [ # Optional. A list of authorization network rules to match against the incoming request. A policy match occurs when at least one network rule matches the request. At least one network rule is required for Allow or Deny Action if no HTTP rules are provided. Network rules are mutually exclusive with HTTP rules. Limited to 5 rules. { # Conditions to match against the incoming request. "from": { # Describes properties of one or more sources of a request. # Optional. Describes properties of a source of a request. "notSources": [ # Optional. Describes the negated properties of request sources. Matches requests from sources that do not match the criteria specified in this field. At least one of sources or notSources must be specified. @@ -865,6 +1550,15 @@

Method Details

"suffix": "A String", # The input string must have the suffix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc`` }, ], + "snis": [ # Optional. A list of SNIs to match against. The match can be one of exact, prefix, suffix, or contains (substring match). If there is no SNI (i.e. plaintext HTTP traffic), the request will be denied. Matches are always case sensitive unless the ignoreCase is set. Limited to 10 SNIs per Authorization Policy. + { # Determines how a string value should be matched. + "contains": "A String", # The input string must have the substring specified here. Note: empty contains match is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc.def`` + "exact": "A String", # The input string must match exactly the string specified here. Examples: * ``abc`` only matches the value ``abc``. + "ignoreCase": True or False, # If true, indicates the exact/prefix/suffix/contains matching should be case insensitive. For example, the matcher ``data`` will match both input string ``Data`` and ``data`` if set to true. + "prefix": "A String", # The input string must have the prefix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``abc.xyz`` + "suffix": "A String", # The input string must have the suffix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc`` + }, + ], }, ], "operations": [ # Optional. Describes properties of one or more targets of a request. At least one of operations or notOperations must be specified. Limited to 1 operation. A match occurs when ANY operation (in operations or notOperations) matches. Within an operation, the match follows AND semantics across fields and OR semantics within a field, i.e. a match occurs when ANY path matches AND ANY header matches and ANY method matches. @@ -921,16 +1615,21 @@

Method Details

"suffix": "A String", # The input string must have the suffix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc`` }, ], + "snis": [ # Optional. A list of SNIs to match against. The match can be one of exact, prefix, suffix, or contains (substring match). If there is no SNI (i.e. plaintext HTTP traffic), the request will be denied. Matches are always case sensitive unless the ignoreCase is set. Limited to 10 SNIs per Authorization Policy. + { # Determines how a string value should be matched. + "contains": "A String", # The input string must have the substring specified here. Note: empty contains match is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc.def`` + "exact": "A String", # The input string must match exactly the string specified here. Examples: * ``abc`` only matches the value ``abc``. + "ignoreCase": True or False, # If true, indicates the exact/prefix/suffix/contains matching should be case insensitive. For example, the matcher ``data`` will match both input string ``Data`` and ``data`` if set to true. + "prefix": "A String", # The input string must have the prefix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``abc.xyz`` + "suffix": "A String", # The input string must have the suffix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc`` + }, + ], }, ], }, "when": "A String", # Optional. CEL expression that describes the conditions to be satisfied for the action. The result of the CEL expression is ANDed with the from and to. Refer to the CEL language reference for a list of available attributes. }, ], - "labels": { # Optional. Set of labels associated with the `AuthzPolicy` resource. The format must comply with [the following requirements](/compute/docs/labeling-resources#requirements). - "a_key": "A String", - }, - "name": "A String", # Required. Identifier. Name of the `AuthzPolicy` resource in the following format: `projects/{project}/locations/{location}/authzPolicies/{authz_policy}`. "policyProfile": "A String", # Optional. Immutable. Defines the type of authorization being performed. If not specified, `REQUEST_AUTHZ` is applied. This field cannot be changed once AuthzPolicy is created. "target": { # Specifies the set of targets to which this policy should be applied to. # Required. Specifies the set of resources to which this policy should be applied to. "loadBalancingScheme": "A String", # Optional. All gateways and forwarding rules referenced by this policy and extensions must share the same load balancing scheme. Required only when targeting forwarding rules. If targeting Secure Web Proxy, this field must be `INTERNAL_MANAGED` or not specified. Must not be specified when targeting Agent Gateway. Supported values: `INTERNAL_MANAGED` and `EXTERNAL_MANAGED`. For more information, refer to [Backend services overview](https://cloud.google.com/load-balancing/docs/backend-service). @@ -1119,6 +1818,15 @@

Method Details

"suffix": "A String", # The input string must have the suffix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc`` }, ], + "snis": [ # Optional. A list of SNIs to match against. The match can be one of exact, prefix, suffix, or contains (substring match). If there is no SNI (i.e. plaintext HTTP traffic), the request will be denied. Matches are always case sensitive unless the ignoreCase is set. Limited to 10 SNIs per Authorization Policy. + { # Determines how a string value should be matched. + "contains": "A String", # The input string must have the substring specified here. Note: empty contains match is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc.def`` + "exact": "A String", # The input string must match exactly the string specified here. Examples: * ``abc`` only matches the value ``abc``. + "ignoreCase": True or False, # If true, indicates the exact/prefix/suffix/contains matching should be case insensitive. For example, the matcher ``data`` will match both input string ``Data`` and ``data`` if set to true. + "prefix": "A String", # The input string must have the prefix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``abc.xyz`` + "suffix": "A String", # The input string must have the suffix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc`` + }, + ], }, ], "operations": [ # Optional. Describes properties of one or more targets of a request. At least one of operations or notOperations must be specified. Limited to 1 operation. A match occurs when ANY operation (in operations or notOperations) matches. Within an operation, the match follows AND semantics across fields and OR semantics within a field, i.e. a match occurs when ANY path matches AND ANY header matches and ANY method matches. @@ -1175,6 +1883,15 @@

Method Details

"suffix": "A String", # The input string must have the suffix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc`` }, ], + "snis": [ # Optional. A list of SNIs to match against. The match can be one of exact, prefix, suffix, or contains (substring match). If there is no SNI (i.e. plaintext HTTP traffic), the request will be denied. Matches are always case sensitive unless the ignoreCase is set. Limited to 10 SNIs per Authorization Policy. + { # Determines how a string value should be matched. + "contains": "A String", # The input string must have the substring specified here. Note: empty contains match is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc.def`` + "exact": "A String", # The input string must match exactly the string specified here. Examples: * ``abc`` only matches the value ``abc``. + "ignoreCase": True or False, # If true, indicates the exact/prefix/suffix/contains matching should be case insensitive. For example, the matcher ``data`` will match both input string ``Data`` and ``data`` if set to true. + "prefix": "A String", # The input string must have the prefix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``abc.xyz`` + "suffix": "A String", # The input string must have the suffix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc`` + }, + ], }, ], }, @@ -1185,6 +1902,221 @@

Method Details

"a_key": "A String", }, "name": "A String", # Required. Identifier. Name of the `AuthzPolicy` resource in the following format: `projects/{project}/locations/{location}/authzPolicies/{authz_policy}`. + "networkRules": [ # Optional. A list of authorization network rules to match against the incoming request. A policy match occurs when at least one network rule matches the request. At least one network rule is required for Allow or Deny Action if no HTTP rules are provided. Network rules are mutually exclusive with HTTP rules. Limited to 5 rules. + { # Conditions to match against the incoming request. + "from": { # Describes properties of one or more sources of a request. # Optional. Describes properties of a source of a request. + "notSources": [ # Optional. Describes the negated properties of request sources. Matches requests from sources that do not match the criteria specified in this field. At least one of sources or notSources must be specified. + { # Describes the properties of a single source. + "ipBlocks": [ # Optional. A list of IP addresses or IP address ranges to match against the source IP address of the request. Limited to 10 ip_blocks per Authorization Policy + { # Represents a range of IP Addresses. + "length": 42, # Required. The length of the address range. + "prefix": "A String", # Required. The address prefix. + }, + ], + "principals": [ # Optional. A list of identities derived from the client's certificate. This field will not match on a request unless frontend mutual TLS is enabled for the forwarding rule or Gateway and the client certificate has been successfully validated by mTLS. Each identity is a string whose value is matched against a list of URI SANs, DNS Name SANs, or the common name in the client's certificate. A match happens when any principal matches with the rule. Limited to 50 principals per Authorization Policy for regional internal Application Load Balancers, regional external Application Load Balancers, cross-region internal Application Load Balancers, and Cloud Service Mesh. This field is not supported for global external Application Load Balancers. + { # Describes the properties of a principal to be matched against. + "principal": { # Determines how a string value should be matched. # Required. A non-empty string whose value is matched against the principal value based on the principal_selector. Only exact match can be applied for CLIENT_CERT_URI_SAN, CLIENT_CERT_DNS_NAME_SAN, CLIENT_CERT_COMMON_NAME selectors. + "contains": "A String", # The input string must have the substring specified here. Note: empty contains match is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc.def`` + "exact": "A String", # The input string must match exactly the string specified here. Examples: * ``abc`` only matches the value ``abc``. + "ignoreCase": True or False, # If true, indicates the exact/prefix/suffix/contains matching should be case insensitive. For example, the matcher ``data`` will match both input string ``Data`` and ``data`` if set to true. + "prefix": "A String", # The input string must have the prefix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``abc.xyz`` + "suffix": "A String", # The input string must have the suffix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc`` + }, + "principalSelector": "A String", # Optional. An enum to decide what principal value the principal rule will match against. If not specified, the PrincipalSelector is CLIENT_CERT_URI_SAN. + }, + ], + "resources": [ # Optional. A list of resources to match against the resource of the source VM of a request. Limited to 10 resources per Authorization Policy. + { # Describes the properties of a client VM resource accessing the internal application load balancers. + "iamServiceAccount": { # Determines how a string value should be matched. # Optional. An IAM service account to match against the source service account of the VM sending the request. + "contains": "A String", # The input string must have the substring specified here. Note: empty contains match is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc.def`` + "exact": "A String", # The input string must match exactly the string specified here. Examples: * ``abc`` only matches the value ``abc``. + "ignoreCase": True or False, # If true, indicates the exact/prefix/suffix/contains matching should be case insensitive. For example, the matcher ``data`` will match both input string ``Data`` and ``data`` if set to true. + "prefix": "A String", # The input string must have the prefix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``abc.xyz`` + "suffix": "A String", # The input string must have the suffix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc`` + }, + "tagValueIdSet": { # Describes a set of resource tag value permanent IDs to match against the resource manager tags value associated with the source VM of a request. # Optional. A list of resource tag value permanent IDs to match against the resource manager tags value associated with the source VM of a request. + "ids": [ # Required. A list of resource tag value permanent IDs to match against the resource manager tags value associated with the source VM of a request. The match follows AND semantics which means all the ids must match. Limited to 5 ids in the Tag value id set. + "A String", + ], + }, + }, + ], + }, + ], + "sources": [ # Optional. Describes the properties of a request's sources. At least one of sources or notSources must be specified. Limited to 1 source. A match occurs when ANY source (in sources or notSources) matches the request. Within a single source, the match follows AND semantics across fields and OR semantics within a single field, i.e. a match occurs when ANY principal matches AND ANY ipBlocks match. + { # Describes the properties of a single source. + "ipBlocks": [ # Optional. A list of IP addresses or IP address ranges to match against the source IP address of the request. Limited to 10 ip_blocks per Authorization Policy + { # Represents a range of IP Addresses. + "length": 42, # Required. The length of the address range. + "prefix": "A String", # Required. The address prefix. + }, + ], + "principals": [ # Optional. A list of identities derived from the client's certificate. This field will not match on a request unless frontend mutual TLS is enabled for the forwarding rule or Gateway and the client certificate has been successfully validated by mTLS. Each identity is a string whose value is matched against a list of URI SANs, DNS Name SANs, or the common name in the client's certificate. A match happens when any principal matches with the rule. Limited to 50 principals per Authorization Policy for regional internal Application Load Balancers, regional external Application Load Balancers, cross-region internal Application Load Balancers, and Cloud Service Mesh. This field is not supported for global external Application Load Balancers. + { # Describes the properties of a principal to be matched against. + "principal": { # Determines how a string value should be matched. # Required. A non-empty string whose value is matched against the principal value based on the principal_selector. Only exact match can be applied for CLIENT_CERT_URI_SAN, CLIENT_CERT_DNS_NAME_SAN, CLIENT_CERT_COMMON_NAME selectors. + "contains": "A String", # The input string must have the substring specified here. Note: empty contains match is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc.def`` + "exact": "A String", # The input string must match exactly the string specified here. Examples: * ``abc`` only matches the value ``abc``. + "ignoreCase": True or False, # If true, indicates the exact/prefix/suffix/contains matching should be case insensitive. For example, the matcher ``data`` will match both input string ``Data`` and ``data`` if set to true. + "prefix": "A String", # The input string must have the prefix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``abc.xyz`` + "suffix": "A String", # The input string must have the suffix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc`` + }, + "principalSelector": "A String", # Optional. An enum to decide what principal value the principal rule will match against. If not specified, the PrincipalSelector is CLIENT_CERT_URI_SAN. + }, + ], + "resources": [ # Optional. A list of resources to match against the resource of the source VM of a request. Limited to 10 resources per Authorization Policy. + { # Describes the properties of a client VM resource accessing the internal application load balancers. + "iamServiceAccount": { # Determines how a string value should be matched. # Optional. An IAM service account to match against the source service account of the VM sending the request. + "contains": "A String", # The input string must have the substring specified here. Note: empty contains match is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc.def`` + "exact": "A String", # The input string must match exactly the string specified here. Examples: * ``abc`` only matches the value ``abc``. + "ignoreCase": True or False, # If true, indicates the exact/prefix/suffix/contains matching should be case insensitive. For example, the matcher ``data`` will match both input string ``Data`` and ``data`` if set to true. + "prefix": "A String", # The input string must have the prefix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``abc.xyz`` + "suffix": "A String", # The input string must have the suffix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc`` + }, + "tagValueIdSet": { # Describes a set of resource tag value permanent IDs to match against the resource manager tags value associated with the source VM of a request. # Optional. A list of resource tag value permanent IDs to match against the resource manager tags value associated with the source VM of a request. + "ids": [ # Required. A list of resource tag value permanent IDs to match against the resource manager tags value associated with the source VM of a request. The match follows AND semantics which means all the ids must match. Limited to 5 ids in the Tag value id set. + "A String", + ], + }, + }, + ], + }, + ], + }, + "to": { # Describes properties of one or more targets of a request. # Optional. Describes properties of a target of a request. + "notOperations": [ # Optional. Describes the negated properties of the targets of a request. Matches requests for operations that do not match the criteria specified in this field. At least one of operations or notOperations must be specified. + { # Describes properties of one or more targets of a request. + "headerSet": { # Describes a set of HTTP headers to match against. # Optional. A list of headers to match against in http header. + "headers": [ # Required. A list of headers to match against in http header. The match can be one of exact, prefix, suffix, or contains (substring match). The match follows AND semantics which means all the headers must match. Matches are always case sensitive unless the ignoreCase is set. Limited to 10 headers per Authorization Policy. + { # Determines how a HTTP header should be matched. + "name": "A String", # Optional. Specifies the name of the header in the request. + "value": { # Determines how a string value should be matched. # Optional. Specifies how the header match will be performed. + "contains": "A String", # The input string must have the substring specified here. Note: empty contains match is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc.def`` + "exact": "A String", # The input string must match exactly the string specified here. Examples: * ``abc`` only matches the value ``abc``. + "ignoreCase": True or False, # If true, indicates the exact/prefix/suffix/contains matching should be case insensitive. For example, the matcher ``data`` will match both input string ``Data`` and ``data`` if set to true. + "prefix": "A String", # The input string must have the prefix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``abc.xyz`` + "suffix": "A String", # The input string must have the suffix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc`` + }, + }, + ], + }, + "hosts": [ # Optional. A list of HTTP Hosts to match against. The match can be one of exact, prefix, suffix, or contains (substring match). Matches are always case sensitive unless the ignoreCase is set. Limited to 10 hosts per Authorization Policy. + { # Determines how a string value should be matched. + "contains": "A String", # The input string must have the substring specified here. Note: empty contains match is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc.def`` + "exact": "A String", # The input string must match exactly the string specified here. Examples: * ``abc`` only matches the value ``abc``. + "ignoreCase": True or False, # If true, indicates the exact/prefix/suffix/contains matching should be case insensitive. For example, the matcher ``data`` will match both input string ``Data`` and ``data`` if set to true. + "prefix": "A String", # The input string must have the prefix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``abc.xyz`` + "suffix": "A String", # The input string must have the suffix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc`` + }, + ], + "mcp": { # Describes a set of MCP protocol attributes to match against for a given MCP request. # Optional. Defines the MCP protocol attributes to match on. If the MCP payload in the request body cannot be successfully parsed, the request will be denied. This field can be set only for AuthzPolicies targeting AgentGateway resources. + "baseProtocolMethodsOption": "A String", # Optional. If specified, matches on the MCP protocol’s non-access specific methods namely: * initialize * completion/ * logging/ * notifications/ * ping Defaults to SKIP_BASE_PROTOCOL_METHODS if not specified. + "methods": [ # Optional. A list of MCP methods and associated parameters to match on. It is recommended to use this field to match on tools, prompts and resource accesses while setting the baseProtocolMethodsOption to MATCH_BASE_PROTOCOL_METHODS to match on all the other MCP protocol methods. Limited to 10 MCP methods per Authorization Policy. + { # Describes a set of MCP methods to match against. + "name": "A String", # Required. The MCP method to match against. Allowed values are as follows: 1. `tools`, `prompts`, `resources` - these will match against all sub methods under the respective methods. 2. `prompts/list`, `tools/list`, `resources/list`, `resources/templates/list` 3. `prompts/get`, `tools/call`, `resources/subscribe`, `resources/unsubscribe`, `resources/read` Params cannot be specified for categories 1 and 2. + "params": [ # Optional. A list of MCP method parameters to match against. The match can be one of exact, prefix, suffix, or contains (substring match). Matches are always case sensitive unless the ignoreCase is set. Limited to 10 MCP method parameters per Authorization Policy. + { # Determines how a string value should be matched. + "contains": "A String", # The input string must have the substring specified here. Note: empty contains match is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc.def`` + "exact": "A String", # The input string must match exactly the string specified here. Examples: * ``abc`` only matches the value ``abc``. + "ignoreCase": True or False, # If true, indicates the exact/prefix/suffix/contains matching should be case insensitive. For example, the matcher ``data`` will match both input string ``Data`` and ``data`` if set to true. + "prefix": "A String", # The input string must have the prefix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``abc.xyz`` + "suffix": "A String", # The input string must have the suffix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc`` + }, + ], + }, + ], + }, + "methods": [ # Optional. A list of HTTP methods to match against. Each entry must be a valid HTTP method name (GET, PUT, POST, HEAD, PATCH, DELETE, OPTIONS). It only allows exact match and is always case sensitive. Limited to 10 methods per Authorization Policy. + "A String", + ], + "paths": [ # Optional. A list of paths to match against. The match can be one of exact, prefix, suffix, or contains (substring match). Matches are always case sensitive unless the ignoreCase is set. Limited to 10 paths per Authorization Policy. Note that this path match includes the query parameters. For gRPC services, this should be a fully-qualified name of the form /package.service/method. + { # Determines how a string value should be matched. + "contains": "A String", # The input string must have the substring specified here. Note: empty contains match is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc.def`` + "exact": "A String", # The input string must match exactly the string specified here. Examples: * ``abc`` only matches the value ``abc``. + "ignoreCase": True or False, # If true, indicates the exact/prefix/suffix/contains matching should be case insensitive. For example, the matcher ``data`` will match both input string ``Data`` and ``data`` if set to true. + "prefix": "A String", # The input string must have the prefix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``abc.xyz`` + "suffix": "A String", # The input string must have the suffix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc`` + }, + ], + "snis": [ # Optional. A list of SNIs to match against. The match can be one of exact, prefix, suffix, or contains (substring match). If there is no SNI (i.e. plaintext HTTP traffic), the request will be denied. Matches are always case sensitive unless the ignoreCase is set. Limited to 10 SNIs per Authorization Policy. + { # Determines how a string value should be matched. + "contains": "A String", # The input string must have the substring specified here. Note: empty contains match is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc.def`` + "exact": "A String", # The input string must match exactly the string specified here. Examples: * ``abc`` only matches the value ``abc``. + "ignoreCase": True or False, # If true, indicates the exact/prefix/suffix/contains matching should be case insensitive. For example, the matcher ``data`` will match both input string ``Data`` and ``data`` if set to true. + "prefix": "A String", # The input string must have the prefix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``abc.xyz`` + "suffix": "A String", # The input string must have the suffix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc`` + }, + ], + }, + ], + "operations": [ # Optional. Describes properties of one or more targets of a request. At least one of operations or notOperations must be specified. Limited to 1 operation. A match occurs when ANY operation (in operations or notOperations) matches. Within an operation, the match follows AND semantics across fields and OR semantics within a field, i.e. a match occurs when ANY path matches AND ANY header matches and ANY method matches. + { # Describes properties of one or more targets of a request. + "headerSet": { # Describes a set of HTTP headers to match against. # Optional. A list of headers to match against in http header. + "headers": [ # Required. A list of headers to match against in http header. The match can be one of exact, prefix, suffix, or contains (substring match). The match follows AND semantics which means all the headers must match. Matches are always case sensitive unless the ignoreCase is set. Limited to 10 headers per Authorization Policy. + { # Determines how a HTTP header should be matched. + "name": "A String", # Optional. Specifies the name of the header in the request. + "value": { # Determines how a string value should be matched. # Optional. Specifies how the header match will be performed. + "contains": "A String", # The input string must have the substring specified here. Note: empty contains match is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc.def`` + "exact": "A String", # The input string must match exactly the string specified here. Examples: * ``abc`` only matches the value ``abc``. + "ignoreCase": True or False, # If true, indicates the exact/prefix/suffix/contains matching should be case insensitive. For example, the matcher ``data`` will match both input string ``Data`` and ``data`` if set to true. + "prefix": "A String", # The input string must have the prefix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``abc.xyz`` + "suffix": "A String", # The input string must have the suffix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc`` + }, + }, + ], + }, + "hosts": [ # Optional. A list of HTTP Hosts to match against. The match can be one of exact, prefix, suffix, or contains (substring match). Matches are always case sensitive unless the ignoreCase is set. Limited to 10 hosts per Authorization Policy. + { # Determines how a string value should be matched. + "contains": "A String", # The input string must have the substring specified here. Note: empty contains match is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc.def`` + "exact": "A String", # The input string must match exactly the string specified here. Examples: * ``abc`` only matches the value ``abc``. + "ignoreCase": True or False, # If true, indicates the exact/prefix/suffix/contains matching should be case insensitive. For example, the matcher ``data`` will match both input string ``Data`` and ``data`` if set to true. + "prefix": "A String", # The input string must have the prefix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``abc.xyz`` + "suffix": "A String", # The input string must have the suffix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc`` + }, + ], + "mcp": { # Describes a set of MCP protocol attributes to match against for a given MCP request. # Optional. Defines the MCP protocol attributes to match on. If the MCP payload in the request body cannot be successfully parsed, the request will be denied. This field can be set only for AuthzPolicies targeting AgentGateway resources. + "baseProtocolMethodsOption": "A String", # Optional. If specified, matches on the MCP protocol’s non-access specific methods namely: * initialize * completion/ * logging/ * notifications/ * ping Defaults to SKIP_BASE_PROTOCOL_METHODS if not specified. + "methods": [ # Optional. A list of MCP methods and associated parameters to match on. It is recommended to use this field to match on tools, prompts and resource accesses while setting the baseProtocolMethodsOption to MATCH_BASE_PROTOCOL_METHODS to match on all the other MCP protocol methods. Limited to 10 MCP methods per Authorization Policy. + { # Describes a set of MCP methods to match against. + "name": "A String", # Required. The MCP method to match against. Allowed values are as follows: 1. `tools`, `prompts`, `resources` - these will match against all sub methods under the respective methods. 2. `prompts/list`, `tools/list`, `resources/list`, `resources/templates/list` 3. `prompts/get`, `tools/call`, `resources/subscribe`, `resources/unsubscribe`, `resources/read` Params cannot be specified for categories 1 and 2. + "params": [ # Optional. A list of MCP method parameters to match against. The match can be one of exact, prefix, suffix, or contains (substring match). Matches are always case sensitive unless the ignoreCase is set. Limited to 10 MCP method parameters per Authorization Policy. + { # Determines how a string value should be matched. + "contains": "A String", # The input string must have the substring specified here. Note: empty contains match is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc.def`` + "exact": "A String", # The input string must match exactly the string specified here. Examples: * ``abc`` only matches the value ``abc``. + "ignoreCase": True or False, # If true, indicates the exact/prefix/suffix/contains matching should be case insensitive. For example, the matcher ``data`` will match both input string ``Data`` and ``data`` if set to true. + "prefix": "A String", # The input string must have the prefix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``abc.xyz`` + "suffix": "A String", # The input string must have the suffix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc`` + }, + ], + }, + ], + }, + "methods": [ # Optional. A list of HTTP methods to match against. Each entry must be a valid HTTP method name (GET, PUT, POST, HEAD, PATCH, DELETE, OPTIONS). It only allows exact match and is always case sensitive. Limited to 10 methods per Authorization Policy. + "A String", + ], + "paths": [ # Optional. A list of paths to match against. The match can be one of exact, prefix, suffix, or contains (substring match). Matches are always case sensitive unless the ignoreCase is set. Limited to 10 paths per Authorization Policy. Note that this path match includes the query parameters. For gRPC services, this should be a fully-qualified name of the form /package.service/method. + { # Determines how a string value should be matched. + "contains": "A String", # The input string must have the substring specified here. Note: empty contains match is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc.def`` + "exact": "A String", # The input string must match exactly the string specified here. Examples: * ``abc`` only matches the value ``abc``. + "ignoreCase": True or False, # If true, indicates the exact/prefix/suffix/contains matching should be case insensitive. For example, the matcher ``data`` will match both input string ``Data`` and ``data`` if set to true. + "prefix": "A String", # The input string must have the prefix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``abc.xyz`` + "suffix": "A String", # The input string must have the suffix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc`` + }, + ], + "snis": [ # Optional. A list of SNIs to match against. The match can be one of exact, prefix, suffix, or contains (substring match). If there is no SNI (i.e. plaintext HTTP traffic), the request will be denied. Matches are always case sensitive unless the ignoreCase is set. Limited to 10 SNIs per Authorization Policy. + { # Determines how a string value should be matched. + "contains": "A String", # The input string must have the substring specified here. Note: empty contains match is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc.def`` + "exact": "A String", # The input string must match exactly the string specified here. Examples: * ``abc`` only matches the value ``abc``. + "ignoreCase": True or False, # If true, indicates the exact/prefix/suffix/contains matching should be case insensitive. For example, the matcher ``data`` will match both input string ``Data`` and ``data`` if set to true. + "prefix": "A String", # The input string must have the prefix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``abc.xyz`` + "suffix": "A String", # The input string must have the suffix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc`` + }, + ], + }, + ], + }, + "when": "A String", # Optional. CEL expression that describes the conditions to be satisfied for the action. The result of the CEL expression is ANDed with the from and to. Refer to the CEL language reference for a list of available attributes. + }, + ], "policyProfile": "A String", # Optional. Immutable. Defines the type of authorization being performed. If not specified, `REQUEST_AUTHZ` is applied. This field cannot be changed once AuthzPolicy is created. "target": { # Specifies the set of targets to which this policy should be applied to. # Required. Specifies the set of resources to which this policy should be applied to. "loadBalancingScheme": "A String", # Optional. All gateways and forwarding rules referenced by this policy and extensions must share the same load balancing scheme. Required only when targeting forwarding rules. If targeting Secure Web Proxy, this field must be `INTERNAL_MANAGED` or not specified. Must not be specified when targeting Agent Gateway. Supported values: `INTERNAL_MANAGED` and `EXTERNAL_MANAGED`. For more information, refer to [Backend services overview](https://cloud.google.com/load-balancing/docs/backend-service). diff --git a/docs/dyn/networksecurity_v1beta1.projects.locations.firewallEndpoints.html b/docs/dyn/networksecurity_v1beta1.projects.locations.firewallEndpoints.html index a248dfffc9..b6c866710f 100644 --- a/docs/dyn/networksecurity_v1beta1.projects.locations.firewallEndpoints.html +++ b/docs/dyn/networksecurity_v1beta1.projects.locations.firewallEndpoints.html @@ -74,6 +74,11 @@

Network Security API . projects . locations . firewallEndpoints

Instance Methods

+

+ wildfireVerdictChangeRequests() +

+

Returns the wildfireVerdictChangeRequests Resource.

+

close()

Close httplib2 connections.

@@ -111,7 +116,7 @@

Method Details

The object takes the form of: { # Message describing Endpoint object. - "associatedNetworks": [ # Output only. List of networks that are associated with this endpoint in the local zone. This is a projection of the FirewallEndpointAssociations pointing at this endpoint. A network will only appear in this list after traffic routing is fully configured. Format: projects/{project}/global/networks/{name}. + "associatedNetworks": [ # Output only. Deprecated: List of networks that are associated with this endpoint in the local zone. This is a projection of the FirewallEndpointAssociations pointing at this endpoint. A network will only appear in this list after traffic routing is fully configured. Format: projects/{project}/global/networks/{name}. "A String", ], "associations": [ # Output only. List of FirewallEndpointAssociations that are associated to this endpoint. An association will only appear in this list after traffic routing is fully configured. @@ -124,6 +129,8 @@

Method Details

"createTime": "A String", # Output only. Create time stamp. "description": "A String", # Optional. Description of the firewall endpoint. Max length 2048 characters. "endpointSettings": { # Settings for the endpoint. # Optional. Settings for the endpoint. + "contentCloudRegion": "A String", # Optional. The content cloud region of the endpoint. + "httpPartialResponseBlocked": True or False, # Optional. Whether to block HTTP partial responses for the endpoint. When this is true, resumption of blocked malicious HTTP file downloads will be blocked by the firewall. False provides maximum availability, true provides maximum security. "jumboFramesEnabled": True or False, # Optional. Immutable. Indicates whether Jumbo Frames are enabled. Default value is false. }, "labels": { # Optional. Labels as key value pairs @@ -135,6 +142,17 @@

Method Details

"satisfiesPzs": True or False, # Output only. [Output Only] Reserved for future use. "state": "A String", # Output only. Current state of the endpoint. "updateTime": "A String", # Output only. Update time stamp + "wildfireSettings": { # Settings for WildFire analysis. # Optional. Settings for WildFire analysis. + "enabled": True or False, # Optional. Indicates whether WildFire analysis is enabled. Default value is false. + "wildfireInlineCloudAnalysisSettings": { # Settings for WildFire inline cloud analysis. # Optional. Settings for WildFire inline cloud analysis. + "maxAnalysisDuration": "A String", # Optional. Timeout in milliseconds on a file being held while WildFire inline cloud analysis is performed. Value between 1 to 240000 is valid. Default value is 30000. + "submissionTimeoutLoggingDisabled": True or False, # Optional. Whether to disable WildFire submission log generation for files that timeout during WildFire inline cloud analysis. + "timeoutAction": "A String", # Optional. Action to take when WildFire inline cloud analysis times out. Default value is ALLOW. + }, + "wildfireRealtimeLookupDuration": "A String", # Optional. Duration in milliseconds on a file being held while the WildFire real time signature cloud performs a signature lookup. Value between 1 to 5000 is valid. Default value is 1000. + "wildfireRealtimeLookupTimeoutAction": "A String", # Optional. Action to take on WildFire real time signature lookup timeout. Default value is ALLOW. + "wildfireRegion": "A String", # Optional. The region where WildFire analysis will be performed. PAN supports regions: https://docs.paloaltonetworks.com/advanced-wildfire/administration/advanced-wildfire-overview/advanced-wildfire-deployments/advanced-wildfire-global-cloud + }, } firewallEndpointId: string, Required. Id of the requesting object. If auto-generating Id server-side, remove this field and firewall_endpoint_id from the method_signature of Create RPC. @@ -219,7 +237,7 @@

Method Details

An object of the form: { # Message describing Endpoint object. - "associatedNetworks": [ # Output only. List of networks that are associated with this endpoint in the local zone. This is a projection of the FirewallEndpointAssociations pointing at this endpoint. A network will only appear in this list after traffic routing is fully configured. Format: projects/{project}/global/networks/{name}. + "associatedNetworks": [ # Output only. Deprecated: List of networks that are associated with this endpoint in the local zone. This is a projection of the FirewallEndpointAssociations pointing at this endpoint. A network will only appear in this list after traffic routing is fully configured. Format: projects/{project}/global/networks/{name}. "A String", ], "associations": [ # Output only. List of FirewallEndpointAssociations that are associated to this endpoint. An association will only appear in this list after traffic routing is fully configured. @@ -232,6 +250,8 @@

Method Details

"createTime": "A String", # Output only. Create time stamp. "description": "A String", # Optional. Description of the firewall endpoint. Max length 2048 characters. "endpointSettings": { # Settings for the endpoint. # Optional. Settings for the endpoint. + "contentCloudRegion": "A String", # Optional. The content cloud region of the endpoint. + "httpPartialResponseBlocked": True or False, # Optional. Whether to block HTTP partial responses for the endpoint. When this is true, resumption of blocked malicious HTTP file downloads will be blocked by the firewall. False provides maximum availability, true provides maximum security. "jumboFramesEnabled": True or False, # Optional. Immutable. Indicates whether Jumbo Frames are enabled. Default value is false. }, "labels": { # Optional. Labels as key value pairs @@ -243,6 +263,17 @@

Method Details

"satisfiesPzs": True or False, # Output only. [Output Only] Reserved for future use. "state": "A String", # Output only. Current state of the endpoint. "updateTime": "A String", # Output only. Update time stamp + "wildfireSettings": { # Settings for WildFire analysis. # Optional. Settings for WildFire analysis. + "enabled": True or False, # Optional. Indicates whether WildFire analysis is enabled. Default value is false. + "wildfireInlineCloudAnalysisSettings": { # Settings for WildFire inline cloud analysis. # Optional. Settings for WildFire inline cloud analysis. + "maxAnalysisDuration": "A String", # Optional. Timeout in milliseconds on a file being held while WildFire inline cloud analysis is performed. Value between 1 to 240000 is valid. Default value is 30000. + "submissionTimeoutLoggingDisabled": True or False, # Optional. Whether to disable WildFire submission log generation for files that timeout during WildFire inline cloud analysis. + "timeoutAction": "A String", # Optional. Action to take when WildFire inline cloud analysis times out. Default value is ALLOW. + }, + "wildfireRealtimeLookupDuration": "A String", # Optional. Duration in milliseconds on a file being held while the WildFire real time signature cloud performs a signature lookup. Value between 1 to 5000 is valid. Default value is 1000. + "wildfireRealtimeLookupTimeoutAction": "A String", # Optional. Action to take on WildFire real time signature lookup timeout. Default value is ALLOW. + "wildfireRegion": "A String", # Optional. The region where WildFire analysis will be performed. PAN supports regions: https://docs.paloaltonetworks.com/advanced-wildfire/administration/advanced-wildfire-overview/advanced-wildfire-deployments/advanced-wildfire-global-cloud + }, }
@@ -267,7 +298,7 @@

Method Details

{ # Message for response to listing Endpoints "firewallEndpoints": [ # The list of Endpoint { # Message describing Endpoint object. - "associatedNetworks": [ # Output only. List of networks that are associated with this endpoint in the local zone. This is a projection of the FirewallEndpointAssociations pointing at this endpoint. A network will only appear in this list after traffic routing is fully configured. Format: projects/{project}/global/networks/{name}. + "associatedNetworks": [ # Output only. Deprecated: List of networks that are associated with this endpoint in the local zone. This is a projection of the FirewallEndpointAssociations pointing at this endpoint. A network will only appear in this list after traffic routing is fully configured. Format: projects/{project}/global/networks/{name}. "A String", ], "associations": [ # Output only. List of FirewallEndpointAssociations that are associated to this endpoint. An association will only appear in this list after traffic routing is fully configured. @@ -280,6 +311,8 @@

Method Details

"createTime": "A String", # Output only. Create time stamp. "description": "A String", # Optional. Description of the firewall endpoint. Max length 2048 characters. "endpointSettings": { # Settings for the endpoint. # Optional. Settings for the endpoint. + "contentCloudRegion": "A String", # Optional. The content cloud region of the endpoint. + "httpPartialResponseBlocked": True or False, # Optional. Whether to block HTTP partial responses for the endpoint. When this is true, resumption of blocked malicious HTTP file downloads will be blocked by the firewall. False provides maximum availability, true provides maximum security. "jumboFramesEnabled": True or False, # Optional. Immutable. Indicates whether Jumbo Frames are enabled. Default value is false. }, "labels": { # Optional. Labels as key value pairs @@ -291,6 +324,17 @@

Method Details

"satisfiesPzs": True or False, # Output only. [Output Only] Reserved for future use. "state": "A String", # Output only. Current state of the endpoint. "updateTime": "A String", # Output only. Update time stamp + "wildfireSettings": { # Settings for WildFire analysis. # Optional. Settings for WildFire analysis. + "enabled": True or False, # Optional. Indicates whether WildFire analysis is enabled. Default value is false. + "wildfireInlineCloudAnalysisSettings": { # Settings for WildFire inline cloud analysis. # Optional. Settings for WildFire inline cloud analysis. + "maxAnalysisDuration": "A String", # Optional. Timeout in milliseconds on a file being held while WildFire inline cloud analysis is performed. Value between 1 to 240000 is valid. Default value is 30000. + "submissionTimeoutLoggingDisabled": True or False, # Optional. Whether to disable WildFire submission log generation for files that timeout during WildFire inline cloud analysis. + "timeoutAction": "A String", # Optional. Action to take when WildFire inline cloud analysis times out. Default value is ALLOW. + }, + "wildfireRealtimeLookupDuration": "A String", # Optional. Duration in milliseconds on a file being held while the WildFire real time signature cloud performs a signature lookup. Value between 1 to 5000 is valid. Default value is 1000. + "wildfireRealtimeLookupTimeoutAction": "A String", # Optional. Action to take on WildFire real time signature lookup timeout. Default value is ALLOW. + "wildfireRegion": "A String", # Optional. The region where WildFire analysis will be performed. PAN supports regions: https://docs.paloaltonetworks.com/advanced-wildfire/administration/advanced-wildfire-overview/advanced-wildfire-deployments/advanced-wildfire-global-cloud + }, }, ], "nextPageToken": "A String", # A token identifying a page of results the server should return. @@ -324,7 +368,7 @@

Method Details

The object takes the form of: { # Message describing Endpoint object. - "associatedNetworks": [ # Output only. List of networks that are associated with this endpoint in the local zone. This is a projection of the FirewallEndpointAssociations pointing at this endpoint. A network will only appear in this list after traffic routing is fully configured. Format: projects/{project}/global/networks/{name}. + "associatedNetworks": [ # Output only. Deprecated: List of networks that are associated with this endpoint in the local zone. This is a projection of the FirewallEndpointAssociations pointing at this endpoint. A network will only appear in this list after traffic routing is fully configured. Format: projects/{project}/global/networks/{name}. "A String", ], "associations": [ # Output only. List of FirewallEndpointAssociations that are associated to this endpoint. An association will only appear in this list after traffic routing is fully configured. @@ -337,6 +381,8 @@

Method Details

"createTime": "A String", # Output only. Create time stamp. "description": "A String", # Optional. Description of the firewall endpoint. Max length 2048 characters. "endpointSettings": { # Settings for the endpoint. # Optional. Settings for the endpoint. + "contentCloudRegion": "A String", # Optional. The content cloud region of the endpoint. + "httpPartialResponseBlocked": True or False, # Optional. Whether to block HTTP partial responses for the endpoint. When this is true, resumption of blocked malicious HTTP file downloads will be blocked by the firewall. False provides maximum availability, true provides maximum security. "jumboFramesEnabled": True or False, # Optional. Immutable. Indicates whether Jumbo Frames are enabled. Default value is false. }, "labels": { # Optional. Labels as key value pairs @@ -348,6 +394,17 @@

Method Details

"satisfiesPzs": True or False, # Output only. [Output Only] Reserved for future use. "state": "A String", # Output only. Current state of the endpoint. "updateTime": "A String", # Output only. Update time stamp + "wildfireSettings": { # Settings for WildFire analysis. # Optional. Settings for WildFire analysis. + "enabled": True or False, # Optional. Indicates whether WildFire analysis is enabled. Default value is false. + "wildfireInlineCloudAnalysisSettings": { # Settings for WildFire inline cloud analysis. # Optional. Settings for WildFire inline cloud analysis. + "maxAnalysisDuration": "A String", # Optional. Timeout in milliseconds on a file being held while WildFire inline cloud analysis is performed. Value between 1 to 240000 is valid. Default value is 30000. + "submissionTimeoutLoggingDisabled": True or False, # Optional. Whether to disable WildFire submission log generation for files that timeout during WildFire inline cloud analysis. + "timeoutAction": "A String", # Optional. Action to take when WildFire inline cloud analysis times out. Default value is ALLOW. + }, + "wildfireRealtimeLookupDuration": "A String", # Optional. Duration in milliseconds on a file being held while the WildFire real time signature cloud performs a signature lookup. Value between 1 to 5000 is valid. Default value is 1000. + "wildfireRealtimeLookupTimeoutAction": "A String", # Optional. Action to take on WildFire real time signature lookup timeout. Default value is ALLOW. + "wildfireRegion": "A String", # Optional. The region where WildFire analysis will be performed. PAN supports regions: https://docs.paloaltonetworks.com/advanced-wildfire/administration/advanced-wildfire-overview/advanced-wildfire-deployments/advanced-wildfire-global-cloud + }, } requestId: string, Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). diff --git a/docs/dyn/networksecurity_v1beta1.projects.locations.firewallEndpoints.wildfireVerdictChangeRequests.html b/docs/dyn/networksecurity_v1beta1.projects.locations.firewallEndpoints.wildfireVerdictChangeRequests.html new file mode 100644 index 0000000000..c97fa27863 --- /dev/null +++ b/docs/dyn/networksecurity_v1beta1.projects.locations.firewallEndpoints.wildfireVerdictChangeRequests.html @@ -0,0 +1,239 @@ + + + +

Network Security API . projects . locations . firewallEndpoints . wildfireVerdictChangeRequests

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

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

+

Create WildfireVerdictChangeRequest in a given Firewall Endpoint in a project and location.

+

+ get(name, x__xgafv=None)

+

Get WildfireVerdictChangeRequest in a given Firewall Endpoint in a project and location.

+

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

+

Lists WildfireVerdictChangeRequests in a given Firewall Endpoint in a project and location.

+

+ list_next()

+

Retrieves the next page of results.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ create(parent, body=None, x__xgafv=None) +
Create WildfireVerdictChangeRequest in a given Firewall Endpoint in a project and location.
+
+Args:
+  parent: string, Required. Parent value for CreateWildfireVerdictChangeRequestRequest. The parent is a firewall endpoint resource. Format: organizations|projects/{project_or_organization}/locations/{location}/firewallEndpoints/{firewall_endpoint} (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Message for a WildfireVerdictChangeRequest.
+  "comment": "A String", # Required. The justification for the verdict change request. Max length 2048 characters.
+  "createTime": "A String", # Output only. The timestamp when the WildfireVerdictChangeRequest was created.
+  "fileName": "A String", # Output only. The file name of the Malware Sample.
+  "fileType": "A String", # Output only. The file type of the Malware Sample.
+  "finalVerdict": "A String", # Output only. The final verdict of the Malware Sample.
+  "name": "A String", # Output only. Identifier. The relative name of the WildfireVerdictChangeRequest. Output only. This is a unique identifier generated by the third party API. Format: organizations|projects/{project_or_organization}/locations/{location}/firewallEndpoints/{firewall_endpoint}/wildfireVerdictChangeRequests/{wildfire_verdict_change_request_id} Where {wildfire_verdict_change_request_id} is the ID in the format: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
+  "newVerdict": "A String", # Required. The suggested verdict to apply to the Malware Sample.
+  "oldVerdict": "A String", # Output only. The original verdict of the Malware Sample.
+  "resolutionTime": "A String", # Output only. The timestamp when the WildfireVerdictChangeRequest was resolved.
+  "sha256": "A String", # Required. The SHA256 hash of the Malware Sample to change the verdict of.
+  "sourceRegion": "A String", # Output only. The region of the file associated with the Malware Sample.
+  "state": "A String", # Output only. The review state of the WildfireVerdictChangeRequest.
+  "updateTime": "A String", # Output only. The timestamp when the WildfireVerdictChangeRequest was last updated.
+  "wildfireVerdictChangeRequestId": "A String", # Output only. The ID of the WildfireVerdictChangeRequest. This is a unique identifier generated by the third party API. Format: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Message for a WildfireVerdictChangeRequest.
+  "comment": "A String", # Required. The justification for the verdict change request. Max length 2048 characters.
+  "createTime": "A String", # Output only. The timestamp when the WildfireVerdictChangeRequest was created.
+  "fileName": "A String", # Output only. The file name of the Malware Sample.
+  "fileType": "A String", # Output only. The file type of the Malware Sample.
+  "finalVerdict": "A String", # Output only. The final verdict of the Malware Sample.
+  "name": "A String", # Output only. Identifier. The relative name of the WildfireVerdictChangeRequest. Output only. This is a unique identifier generated by the third party API. Format: organizations|projects/{project_or_organization}/locations/{location}/firewallEndpoints/{firewall_endpoint}/wildfireVerdictChangeRequests/{wildfire_verdict_change_request_id} Where {wildfire_verdict_change_request_id} is the ID in the format: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
+  "newVerdict": "A String", # Required. The suggested verdict to apply to the Malware Sample.
+  "oldVerdict": "A String", # Output only. The original verdict of the Malware Sample.
+  "resolutionTime": "A String", # Output only. The timestamp when the WildfireVerdictChangeRequest was resolved.
+  "sha256": "A String", # Required. The SHA256 hash of the Malware Sample to change the verdict of.
+  "sourceRegion": "A String", # Output only. The region of the file associated with the Malware Sample.
+  "state": "A String", # Output only. The review state of the WildfireVerdictChangeRequest.
+  "updateTime": "A String", # Output only. The timestamp when the WildfireVerdictChangeRequest was last updated.
+  "wildfireVerdictChangeRequestId": "A String", # Output only. The ID of the WildfireVerdictChangeRequest. This is a unique identifier generated by the third party API. Format: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
+}
+
+ +
+ get(name, x__xgafv=None) +
Get WildfireVerdictChangeRequest in a given Firewall Endpoint in a project and location.
+
+Args:
+  name: string, Required. Name of the WildfireVerdictChangeRequest to retrieve. Format: organizations|projects/{project_or_organization}/locations/{location}/firewallEndpoints/{firewall_endpoint}/wildfireVerdictChangeRequests/{wildfire_verdict_change_request_id} Where {wildfire_verdict_change_request_id} is the ID in the format: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Message for a WildfireVerdictChangeRequest.
+  "comment": "A String", # Required. The justification for the verdict change request. Max length 2048 characters.
+  "createTime": "A String", # Output only. The timestamp when the WildfireVerdictChangeRequest was created.
+  "fileName": "A String", # Output only. The file name of the Malware Sample.
+  "fileType": "A String", # Output only. The file type of the Malware Sample.
+  "finalVerdict": "A String", # Output only. The final verdict of the Malware Sample.
+  "name": "A String", # Output only. Identifier. The relative name of the WildfireVerdictChangeRequest. Output only. This is a unique identifier generated by the third party API. Format: organizations|projects/{project_or_organization}/locations/{location}/firewallEndpoints/{firewall_endpoint}/wildfireVerdictChangeRequests/{wildfire_verdict_change_request_id} Where {wildfire_verdict_change_request_id} is the ID in the format: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
+  "newVerdict": "A String", # Required. The suggested verdict to apply to the Malware Sample.
+  "oldVerdict": "A String", # Output only. The original verdict of the Malware Sample.
+  "resolutionTime": "A String", # Output only. The timestamp when the WildfireVerdictChangeRequest was resolved.
+  "sha256": "A String", # Required. The SHA256 hash of the Malware Sample to change the verdict of.
+  "sourceRegion": "A String", # Output only. The region of the file associated with the Malware Sample.
+  "state": "A String", # Output only. The review state of the WildfireVerdictChangeRequest.
+  "updateTime": "A String", # Output only. The timestamp when the WildfireVerdictChangeRequest was last updated.
+  "wildfireVerdictChangeRequestId": "A String", # Output only. The ID of the WildfireVerdictChangeRequest. This is a unique identifier generated by the third party API. Format: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
+}
+
+ +
+ list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None) +
Lists WildfireVerdictChangeRequests in a given Firewall Endpoint in a project and location.
+
+Args:
+  parent: string, Required. Parent value for ListWildfireVerdictChangeRequestsRequest. The parent is a firewall endpoint resource. Format: organizations|projects/{project_or_organization}/locations/{location}/firewallEndpoints/{firewall_endpoint} (required)
+  filter: string, Optional. Filter expression to filter the results. See AIP-160 for filtering syntax. Supported fields are: - `sha256` (string, equality only, e.g. `sha256 = "..."`) - `state` (enum, equality only, e.g. `state = "ACTIVE"`) - `create_time` (timestamp, comparisons, e.g. `create_time > "2026-01-01T00:00:00Z"`)
+  pageSize: integer, Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
+  pageToken: string, Optional. A token identifying a page of results the server should return.
+  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 WildfireVerdictChangeRequests.
+  "nextPageToken": "A String", # A token identifying a page of results the server should return.
+  "unreachable": [ # Unordered list. Locations that could not be reached.
+    "A String",
+  ],
+  "wildfireVerdictChangeRequests": [ # The list of WildfireVerdictChangeRequests
+    { # Message for a WildfireVerdictChangeRequest.
+      "comment": "A String", # Required. The justification for the verdict change request. Max length 2048 characters.
+      "createTime": "A String", # Output only. The timestamp when the WildfireVerdictChangeRequest was created.
+      "fileName": "A String", # Output only. The file name of the Malware Sample.
+      "fileType": "A String", # Output only. The file type of the Malware Sample.
+      "finalVerdict": "A String", # Output only. The final verdict of the Malware Sample.
+      "name": "A String", # Output only. Identifier. The relative name of the WildfireVerdictChangeRequest. Output only. This is a unique identifier generated by the third party API. Format: organizations|projects/{project_or_organization}/locations/{location}/firewallEndpoints/{firewall_endpoint}/wildfireVerdictChangeRequests/{wildfire_verdict_change_request_id} Where {wildfire_verdict_change_request_id} is the ID in the format: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
+      "newVerdict": "A String", # Required. The suggested verdict to apply to the Malware Sample.
+      "oldVerdict": "A String", # Output only. The original verdict of the Malware Sample.
+      "resolutionTime": "A String", # Output only. The timestamp when the WildfireVerdictChangeRequest was resolved.
+      "sha256": "A String", # Required. The SHA256 hash of the Malware Sample to change the verdict of.
+      "sourceRegion": "A String", # Output only. The region of the file associated with the Malware Sample.
+      "state": "A String", # Output only. The review state of the WildfireVerdictChangeRequest.
+      "updateTime": "A String", # Output only. The timestamp when the WildfireVerdictChangeRequest was last updated.
+      "wildfireVerdictChangeRequestId": "A String", # Output only. The ID of the WildfireVerdictChangeRequest. This is a unique identifier generated by the third party API. Format: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
+    },
+  ],
+}
+
+ +
+ 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/networksecurity_v1beta1.projects.locations.mirroringDeployments.html b/docs/dyn/networksecurity_v1beta1.projects.locations.mirroringDeployments.html index 523595defa..4c3bb3210a 100644 --- a/docs/dyn/networksecurity_v1beta1.projects.locations.mirroringDeployments.html +++ b/docs/dyn/networksecurity_v1beta1.projects.locations.mirroringDeployments.html @@ -255,7 +255,7 @@

Method Details

}, ], "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. See https://google.aip.dev/158 for more details. - "unreachable": [ # Locations that could not be reached. + "unreachable": [ # Unordered list. Locations that could not be reached. See https://google.aip.dev/217 for more details. "A String", ], }
diff --git a/docs/dyn/networksecurity_v1beta1.projects.locations.securityProfileGroups.html b/docs/dyn/networksecurity_v1beta1.projects.locations.securityProfileGroups.html index 7428c0cd9f..81bf637500 100644 --- a/docs/dyn/networksecurity_v1beta1.projects.locations.securityProfileGroups.html +++ b/docs/dyn/networksecurity_v1beta1.projects.locations.securityProfileGroups.html @@ -124,6 +124,7 @@

Method Details

"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. + "wildfireAnalysisProfile": "A String", # Optional. Reference to a SecurityProfile with the WildFire 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". @@ -220,6 +221,7 @@

Method Details

"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. + "wildfireAnalysisProfile": "A String", # Optional. Reference to a SecurityProfile with the WildFire configuration. }
@@ -256,6 +258,7 @@

Method Details

"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. + "wildfireAnalysisProfile": "A String", # Optional. Reference to a SecurityProfile with the WildFire configuration. }, ], }
@@ -298,6 +301,7 @@

Method Details

"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. + "wildfireAnalysisProfile": "A String", # Optional. Reference to a SecurityProfile with the WildFire 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.projects.locations.securityProfiles.html b/docs/dyn/networksecurity_v1beta1.projects.locations.securityProfiles.html index c8e27bbb7b..8e0a3d8818 100644 --- a/docs/dyn/networksecurity_v1beta1.projects.locations.securityProfiles.html +++ b/docs/dyn/networksecurity_v1beta1.projects.locations.securityProfiles.html @@ -158,6 +158,80 @@

Method Details

}, ], }, + "wildfireAnalysisProfile": { # WildfireAnalysisProfile defines Palo Alto Networks WildFire behavior. # The WildFire Analysis configurations for SecurityProfile. + "wildfireInlineCloudAnalysisRules": [ # Optional. Configuration for WildFire inline cloud analysis. + { # The list of file type configurations to be scanned by WildFire Inline Cloud Analysis. + "action": "A String", # Required. Action to take when a threat is detected using WildFire Inline Cloud Analysis. The default Value is DENY. + "customFileTypes": { # The options to submit a custom list of file types for scan. # Submit a custom list of file types for WildFire analysis. + "fileTypes": [ # Required. File types to be submitted for WildFire inline cloud analysis. + "A String", + ], + }, + "direction": "A String", # Required. Direction for the file to be analyzed by WildFire Inline Cloud Analysis. + "fileSelectionMode": "A String", # Required. File selection mode for WildFire inline cloud analysis. + }, + ], + "wildfireInlineMlOverrides": [ # Optional. Configuration for overriding inline ML WildFire actions per protocol. + { # Defines what action to take for WildFire Inline ML threats per protocol. + "action": "A String", # Required. The action to take for WildFire Inline ML override. + "protocol": "A String", # Required. Protocol to match for WildFire Inline ML override. + }, + ], + "wildfireInlineMlSetting": { # Defines the settings for WildFire Inline ML analysis. # Optional. Settings for WildFire Inline ML analysis. + "fileExceptions": [ # Optional. List of files to exclude from WildFire Inline ML analysis. + { # Defines the file to exclude from WildFire Inline ML analysis. + "filename": "A String", # Optional. Name of the file to exclude from WildFire Inline ML analysis. + "partialHash": "A String", # Required. Machine learning partial hash of the file to exclude from WildFire Inline ML analysis. + }, + ], + "inlineMlConfigs": [ # Optional. List of Inline ML configs to enable in WildFire Inline ML analysis. + { # Configuration for WildFire Inline ML analysis per file type. + "action": "A String", # Required. Action to take when a threat is detected using Inline ML. + "fileType": "A String", # Required. File type to configure Inline ML for. + }, + ], + }, + "wildfireInlineMlSettings": [ # Optional. Settings for WildFire Inline ML analysis. + { # Defines the settings for WildFire Inline ML analysis. + "fileExceptions": [ # Optional. List of files to exclude from WildFire Inline ML analysis. + { # Defines the file to exclude from WildFire Inline ML analysis. + "filename": "A String", # Optional. Name of the file to exclude from WildFire Inline ML analysis. + "partialHash": "A String", # Required. Machine learning partial hash of the file to exclude from WildFire Inline ML analysis. + }, + ], + "inlineMlConfigs": [ # Optional. List of Inline ML configs to enable in WildFire Inline ML analysis. + { # Configuration for WildFire Inline ML analysis per file type. + "action": "A String", # Required. Action to take when a threat is detected using Inline ML. + "fileType": "A String", # Required. File type to configure Inline ML for. + }, + ], + }, + ], + "wildfireOverrides": [ # Optional. Configuration for overriding WildFire actions per protocol. + { # Defines what action to take for WildFire threats per protocol. + "action": "A String", # Required. Threat action override. For some threat types, only a subset of actions applies. + "protocol": "A String", # Required. Protocol to match. + }, + ], + "wildfireRealtimeLookup": True or False, # Optional. Whether to hold the transfer of a file while the WildFire real-time signature cloud performs a signature lookup. Default value is false. + "wildfireSubmissionRules": [ # Optional. Configurations for WildFire file submissions. + { # Defines the file types to be submitted for WildFire analysis and the direction of the traffic. + "customFileTypes": { # The options to submit a custom list of file types for scan. # Submit a custom list of file types for WildFire analysis. + "fileTypes": [ # Required. File types to be submitted for WildFire analysis. + "A String", + ], + }, + "direction": "A String", # Required. Direction for the files to be analyzed by WildFire. + "fileSelectionMode": "A String", # Required. File selection mode for WildFire analysis. + }, + ], + "wildfireThreatOverrides": [ # Optional. Configuration for overriding WildFire threats action by threat_id match. + { # Defines what action to take for a specific WildFire threat_id match. + "action": "A String", # Required. Threat action override. + "threatId": "A String", # Required. Threat ID to match. + }, + ], + }, } 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". @@ -288,6 +362,80 @@

Method Details

}, ], }, + "wildfireAnalysisProfile": { # WildfireAnalysisProfile defines Palo Alto Networks WildFire behavior. # The WildFire Analysis configurations for SecurityProfile. + "wildfireInlineCloudAnalysisRules": [ # Optional. Configuration for WildFire inline cloud analysis. + { # The list of file type configurations to be scanned by WildFire Inline Cloud Analysis. + "action": "A String", # Required. Action to take when a threat is detected using WildFire Inline Cloud Analysis. The default Value is DENY. + "customFileTypes": { # The options to submit a custom list of file types for scan. # Submit a custom list of file types for WildFire analysis. + "fileTypes": [ # Required. File types to be submitted for WildFire inline cloud analysis. + "A String", + ], + }, + "direction": "A String", # Required. Direction for the file to be analyzed by WildFire Inline Cloud Analysis. + "fileSelectionMode": "A String", # Required. File selection mode for WildFire inline cloud analysis. + }, + ], + "wildfireInlineMlOverrides": [ # Optional. Configuration for overriding inline ML WildFire actions per protocol. + { # Defines what action to take for WildFire Inline ML threats per protocol. + "action": "A String", # Required. The action to take for WildFire Inline ML override. + "protocol": "A String", # Required. Protocol to match for WildFire Inline ML override. + }, + ], + "wildfireInlineMlSetting": { # Defines the settings for WildFire Inline ML analysis. # Optional. Settings for WildFire Inline ML analysis. + "fileExceptions": [ # Optional. List of files to exclude from WildFire Inline ML analysis. + { # Defines the file to exclude from WildFire Inline ML analysis. + "filename": "A String", # Optional. Name of the file to exclude from WildFire Inline ML analysis. + "partialHash": "A String", # Required. Machine learning partial hash of the file to exclude from WildFire Inline ML analysis. + }, + ], + "inlineMlConfigs": [ # Optional. List of Inline ML configs to enable in WildFire Inline ML analysis. + { # Configuration for WildFire Inline ML analysis per file type. + "action": "A String", # Required. Action to take when a threat is detected using Inline ML. + "fileType": "A String", # Required. File type to configure Inline ML for. + }, + ], + }, + "wildfireInlineMlSettings": [ # Optional. Settings for WildFire Inline ML analysis. + { # Defines the settings for WildFire Inline ML analysis. + "fileExceptions": [ # Optional. List of files to exclude from WildFire Inline ML analysis. + { # Defines the file to exclude from WildFire Inline ML analysis. + "filename": "A String", # Optional. Name of the file to exclude from WildFire Inline ML analysis. + "partialHash": "A String", # Required. Machine learning partial hash of the file to exclude from WildFire Inline ML analysis. + }, + ], + "inlineMlConfigs": [ # Optional. List of Inline ML configs to enable in WildFire Inline ML analysis. + { # Configuration for WildFire Inline ML analysis per file type. + "action": "A String", # Required. Action to take when a threat is detected using Inline ML. + "fileType": "A String", # Required. File type to configure Inline ML for. + }, + ], + }, + ], + "wildfireOverrides": [ # Optional. Configuration for overriding WildFire actions per protocol. + { # Defines what action to take for WildFire threats per protocol. + "action": "A String", # Required. Threat action override. For some threat types, only a subset of actions applies. + "protocol": "A String", # Required. Protocol to match. + }, + ], + "wildfireRealtimeLookup": True or False, # Optional. Whether to hold the transfer of a file while the WildFire real-time signature cloud performs a signature lookup. Default value is false. + "wildfireSubmissionRules": [ # Optional. Configurations for WildFire file submissions. + { # Defines the file types to be submitted for WildFire analysis and the direction of the traffic. + "customFileTypes": { # The options to submit a custom list of file types for scan. # Submit a custom list of file types for WildFire analysis. + "fileTypes": [ # Required. File types to be submitted for WildFire analysis. + "A String", + ], + }, + "direction": "A String", # Required. Direction for the files to be analyzed by WildFire. + "fileSelectionMode": "A String", # Required. File selection mode for WildFire analysis. + }, + ], + "wildfireThreatOverrides": [ # Optional. Configuration for overriding WildFire threats action by threat_id match. + { # Defines what action to take for a specific WildFire threat_id match. + "action": "A String", # Required. Threat action override. + "threatId": "A String", # Required. Threat ID to match. + }, + ], + }, }
@@ -358,6 +506,80 @@

Method Details

}, ], }, + "wildfireAnalysisProfile": { # WildfireAnalysisProfile defines Palo Alto Networks WildFire behavior. # The WildFire Analysis configurations for SecurityProfile. + "wildfireInlineCloudAnalysisRules": [ # Optional. Configuration for WildFire inline cloud analysis. + { # The list of file type configurations to be scanned by WildFire Inline Cloud Analysis. + "action": "A String", # Required. Action to take when a threat is detected using WildFire Inline Cloud Analysis. The default Value is DENY. + "customFileTypes": { # The options to submit a custom list of file types for scan. # Submit a custom list of file types for WildFire analysis. + "fileTypes": [ # Required. File types to be submitted for WildFire inline cloud analysis. + "A String", + ], + }, + "direction": "A String", # Required. Direction for the file to be analyzed by WildFire Inline Cloud Analysis. + "fileSelectionMode": "A String", # Required. File selection mode for WildFire inline cloud analysis. + }, + ], + "wildfireInlineMlOverrides": [ # Optional. Configuration for overriding inline ML WildFire actions per protocol. + { # Defines what action to take for WildFire Inline ML threats per protocol. + "action": "A String", # Required. The action to take for WildFire Inline ML override. + "protocol": "A String", # Required. Protocol to match for WildFire Inline ML override. + }, + ], + "wildfireInlineMlSetting": { # Defines the settings for WildFire Inline ML analysis. # Optional. Settings for WildFire Inline ML analysis. + "fileExceptions": [ # Optional. List of files to exclude from WildFire Inline ML analysis. + { # Defines the file to exclude from WildFire Inline ML analysis. + "filename": "A String", # Optional. Name of the file to exclude from WildFire Inline ML analysis. + "partialHash": "A String", # Required. Machine learning partial hash of the file to exclude from WildFire Inline ML analysis. + }, + ], + "inlineMlConfigs": [ # Optional. List of Inline ML configs to enable in WildFire Inline ML analysis. + { # Configuration for WildFire Inline ML analysis per file type. + "action": "A String", # Required. Action to take when a threat is detected using Inline ML. + "fileType": "A String", # Required. File type to configure Inline ML for. + }, + ], + }, + "wildfireInlineMlSettings": [ # Optional. Settings for WildFire Inline ML analysis. + { # Defines the settings for WildFire Inline ML analysis. + "fileExceptions": [ # Optional. List of files to exclude from WildFire Inline ML analysis. + { # Defines the file to exclude from WildFire Inline ML analysis. + "filename": "A String", # Optional. Name of the file to exclude from WildFire Inline ML analysis. + "partialHash": "A String", # Required. Machine learning partial hash of the file to exclude from WildFire Inline ML analysis. + }, + ], + "inlineMlConfigs": [ # Optional. List of Inline ML configs to enable in WildFire Inline ML analysis. + { # Configuration for WildFire Inline ML analysis per file type. + "action": "A String", # Required. Action to take when a threat is detected using Inline ML. + "fileType": "A String", # Required. File type to configure Inline ML for. + }, + ], + }, + ], + "wildfireOverrides": [ # Optional. Configuration for overriding WildFire actions per protocol. + { # Defines what action to take for WildFire threats per protocol. + "action": "A String", # Required. Threat action override. For some threat types, only a subset of actions applies. + "protocol": "A String", # Required. Protocol to match. + }, + ], + "wildfireRealtimeLookup": True or False, # Optional. Whether to hold the transfer of a file while the WildFire real-time signature cloud performs a signature lookup. Default value is false. + "wildfireSubmissionRules": [ # Optional. Configurations for WildFire file submissions. + { # Defines the file types to be submitted for WildFire analysis and the direction of the traffic. + "customFileTypes": { # The options to submit a custom list of file types for scan. # Submit a custom list of file types for WildFire analysis. + "fileTypes": [ # Required. File types to be submitted for WildFire analysis. + "A String", + ], + }, + "direction": "A String", # Required. Direction for the files to be analyzed by WildFire. + "fileSelectionMode": "A String", # Required. File selection mode for WildFire analysis. + }, + ], + "wildfireThreatOverrides": [ # Optional. Configuration for overriding WildFire threats action by threat_id match. + { # Defines what action to take for a specific WildFire threat_id match. + "action": "A String", # Required. Threat action override. + "threatId": "A String", # Required. Threat ID to match. + }, + ], + }, }, ], }
@@ -434,6 +656,80 @@

Method Details

}, ], }, + "wildfireAnalysisProfile": { # WildfireAnalysisProfile defines Palo Alto Networks WildFire behavior. # The WildFire Analysis configurations for SecurityProfile. + "wildfireInlineCloudAnalysisRules": [ # Optional. Configuration for WildFire inline cloud analysis. + { # The list of file type configurations to be scanned by WildFire Inline Cloud Analysis. + "action": "A String", # Required. Action to take when a threat is detected using WildFire Inline Cloud Analysis. The default Value is DENY. + "customFileTypes": { # The options to submit a custom list of file types for scan. # Submit a custom list of file types for WildFire analysis. + "fileTypes": [ # Required. File types to be submitted for WildFire inline cloud analysis. + "A String", + ], + }, + "direction": "A String", # Required. Direction for the file to be analyzed by WildFire Inline Cloud Analysis. + "fileSelectionMode": "A String", # Required. File selection mode for WildFire inline cloud analysis. + }, + ], + "wildfireInlineMlOverrides": [ # Optional. Configuration for overriding inline ML WildFire actions per protocol. + { # Defines what action to take for WildFire Inline ML threats per protocol. + "action": "A String", # Required. The action to take for WildFire Inline ML override. + "protocol": "A String", # Required. Protocol to match for WildFire Inline ML override. + }, + ], + "wildfireInlineMlSetting": { # Defines the settings for WildFire Inline ML analysis. # Optional. Settings for WildFire Inline ML analysis. + "fileExceptions": [ # Optional. List of files to exclude from WildFire Inline ML analysis. + { # Defines the file to exclude from WildFire Inline ML analysis. + "filename": "A String", # Optional. Name of the file to exclude from WildFire Inline ML analysis. + "partialHash": "A String", # Required. Machine learning partial hash of the file to exclude from WildFire Inline ML analysis. + }, + ], + "inlineMlConfigs": [ # Optional. List of Inline ML configs to enable in WildFire Inline ML analysis. + { # Configuration for WildFire Inline ML analysis per file type. + "action": "A String", # Required. Action to take when a threat is detected using Inline ML. + "fileType": "A String", # Required. File type to configure Inline ML for. + }, + ], + }, + "wildfireInlineMlSettings": [ # Optional. Settings for WildFire Inline ML analysis. + { # Defines the settings for WildFire Inline ML analysis. + "fileExceptions": [ # Optional. List of files to exclude from WildFire Inline ML analysis. + { # Defines the file to exclude from WildFire Inline ML analysis. + "filename": "A String", # Optional. Name of the file to exclude from WildFire Inline ML analysis. + "partialHash": "A String", # Required. Machine learning partial hash of the file to exclude from WildFire Inline ML analysis. + }, + ], + "inlineMlConfigs": [ # Optional. List of Inline ML configs to enable in WildFire Inline ML analysis. + { # Configuration for WildFire Inline ML analysis per file type. + "action": "A String", # Required. Action to take when a threat is detected using Inline ML. + "fileType": "A String", # Required. File type to configure Inline ML for. + }, + ], + }, + ], + "wildfireOverrides": [ # Optional. Configuration for overriding WildFire actions per protocol. + { # Defines what action to take for WildFire threats per protocol. + "action": "A String", # Required. Threat action override. For some threat types, only a subset of actions applies. + "protocol": "A String", # Required. Protocol to match. + }, + ], + "wildfireRealtimeLookup": True or False, # Optional. Whether to hold the transfer of a file while the WildFire real-time signature cloud performs a signature lookup. Default value is false. + "wildfireSubmissionRules": [ # Optional. Configurations for WildFire file submissions. + { # Defines the file types to be submitted for WildFire analysis and the direction of the traffic. + "customFileTypes": { # The options to submit a custom list of file types for scan. # Submit a custom list of file types for WildFire analysis. + "fileTypes": [ # Required. File types to be submitted for WildFire analysis. + "A String", + ], + }, + "direction": "A String", # Required. Direction for the files to be analyzed by WildFire. + "fileSelectionMode": "A String", # Required. File selection mode for WildFire analysis. + }, + ], + "wildfireThreatOverrides": [ # Optional. Configuration for overriding WildFire threats action by threat_id match. + { # Defines what action to take for a specific WildFire threat_id match. + "action": "A String", # Required. Threat action override. + "threatId": "A String", # Required. Threat ID to match. + }, + ], + }, } 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/notebooks_v1.projects.locations.html b/docs/dyn/notebooks_v1.projects.locations.html index 82a1c3a949..7489cd73d3 100644 --- a/docs/dyn/notebooks_v1.projects.locations.html +++ b/docs/dyn/notebooks_v1.projects.locations.html @@ -112,7 +112,7 @@

Instance Methods

Gets information about a location.

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

-

Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the [ListLocationsRequest.name] field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.

+

Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the ListLocationsRequest.name field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.

list_next()

Retrieves the next page of results.

@@ -151,11 +151,11 @@

Method Details

list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None) -
Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the [ListLocationsRequest.name] field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.
+  
Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the ListLocationsRequest.name field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.
 
 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. Do not use this field 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/notebooks_v2.projects.locations.html b/docs/dyn/notebooks_v2.projects.locations.html
index 6a66958a45..74f1296d7d 100644
--- a/docs/dyn/notebooks_v2.projects.locations.html
+++ b/docs/dyn/notebooks_v2.projects.locations.html
@@ -92,7 +92,7 @@ 

Instance Methods

Gets information about a location.

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

-

Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the [ListLocationsRequest.name] field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.

+

Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the ListLocationsRequest.name field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.

list_next()

Retrieves the next page of results.

@@ -131,11 +131,11 @@

Method Details

list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None) -
Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the [ListLocationsRequest.name] field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.
+  
Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the ListLocationsRequest.name field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.
 
 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. Do not use this field 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/notebooks_v2.projects.locations.instances.html b/docs/dyn/notebooks_v2.projects.locations.instances.html
index 6328e637ea..dc305834ba 100644
--- a/docs/dyn/notebooks_v2.projects.locations.instances.html
+++ b/docs/dyn/notebooks_v2.projects.locations.instances.html
@@ -1435,6 +1435,7 @@ 

Method Details

The object takes the form of: { # Request for upgrading a notebook instance + "imageFamily": "A String", # Optional. The Compute Engine image family resource name to upgrade to. Format: `projects/{project_id}/global/images/family/{image_family}` If specified, the instance will be upgraded to the latest image in the specified image family, allowing upgrades across image families. If not specified, the instance will be upgraded to the latest image in its current image family. } x__xgafv: string, V1 error format. diff --git a/docs/dyn/oracledatabase_v1.projects.locations.cloudVmClusters.html b/docs/dyn/oracledatabase_v1.projects.locations.cloudVmClusters.html index 354a4a8c61..e6cb994ed5 100644 --- a/docs/dyn/oracledatabase_v1.projects.locations.cloudVmClusters.html +++ b/docs/dyn/oracledatabase_v1.projects.locations.cloudVmClusters.html @@ -164,8 +164,8 @@

Method Details

"scanIpIds": [ # Output only. OCIDs of scan IPs. "A String", ], - "scanListenerPortTcp": 42, # Output only. SCAN listener port - TCP - "scanListenerPortTcpSsl": 42, # Output only. SCAN listener port - TLS + "scanListenerPortTcp": 42, # Optional. SCAN listener port - TCP + "scanListenerPortTcpSsl": 42, # Optional. SCAN listener port - TLS "shape": "A String", # Output only. Shape of VM Cluster. "sparseDiskgroupEnabled": True or False, # Optional. Use exadata sparse snapshots. "sshPublicKeys": [ # Optional. SSH public keys to be stored with cluster. @@ -315,8 +315,8 @@

Method Details

"scanIpIds": [ # Output only. OCIDs of scan IPs. "A String", ], - "scanListenerPortTcp": 42, # Output only. SCAN listener port - TCP - "scanListenerPortTcpSsl": 42, # Output only. SCAN listener port - TLS + "scanListenerPortTcp": 42, # Optional. SCAN listener port - TCP + "scanListenerPortTcpSsl": 42, # Optional. SCAN listener port - TLS "shape": "A String", # Output only. Shape of VM Cluster. "sparseDiskgroupEnabled": True or False, # Optional. Use exadata sparse snapshots. "sshPublicKeys": [ # Optional. SSH public keys to be stored with cluster. @@ -404,8 +404,8 @@

Method Details

"scanIpIds": [ # Output only. OCIDs of scan IPs. "A String", ], - "scanListenerPortTcp": 42, # Output only. SCAN listener port - TCP - "scanListenerPortTcpSsl": 42, # Output only. SCAN listener port - TLS + "scanListenerPortTcp": 42, # Optional. SCAN listener port - TCP + "scanListenerPortTcpSsl": 42, # Optional. SCAN listener port - TLS "shape": "A String", # Output only. Shape of VM Cluster. "sparseDiskgroupEnabled": True or False, # Optional. Use exadata sparse snapshots. "sshPublicKeys": [ # Optional. SSH public keys to be stored with cluster. diff --git a/docs/dyn/oracledatabase_v1.projects.locations.goldengateConnections.html b/docs/dyn/oracledatabase_v1.projects.locations.goldengateConnections.html index 4905497530..59849d7e1a 100644 --- a/docs/dyn/oracledatabase_v1.projects.locations.goldengateConnections.html +++ b/docs/dyn/oracledatabase_v1.projects.locations.goldengateConnections.html @@ -215,15 +215,15 @@

Method Details

"username": "A String", # Optional. The username credential. }, "googleBigQueryConnectionProperties": { # The properties of GoldengateGoogleBigQueryConnectionProperties. # Properties for a Google BigQuery Connection. - "serviceAccountKeyFile": "A String", # Optional. The service account key file Cloud Storage containing the credentials required to use Google BigQuery. + "serviceAccountKeyFile": "A String", # Optional. The base64 encoded content of the service account key file containing the credentials required to use Google BigQuery. "technologyType": "A String", # Optional. The technology type. }, "googleCloudStorageConnectionProperties": { # The properties of GoldengateGoogleCloudStorageConnectionProperties. # Properties for a Google Cloud Storage Connection. - "serviceAccountKeyFile": "A String", # Optional. The service account key Cloud Storage file containing the credentials required to use Google Cloud Storage. + "serviceAccountKeyFile": "A String", # Optional. The base64 encoded content of the service account key file containing the credentials required to use Google Cloud Storage. "technologyType": "A String", # Optional. The technology type. }, "googlePubsubConnectionProperties": { # The properties of GoldengateGooglePubsubConnection. # Properties for a Google Pub/Sub connection. - "serviceAccountKeyFile": "A String", # Optional. The content of the service account key file containing the credentials required to use Google Pub/Sub. + "serviceAccountKeyFile": "A String", # Optional. The base64 encoded content of the service account key file containing the credentials required to use Google Pub/Sub. "technologyType": "A String", # Optional. The technology type of GooglePubsubConnection. }, "hdfsConnectionProperties": { # The properties of GoldengateHdfsConnection. # Properties for an HDFS connection. @@ -248,7 +248,7 @@

Method Details

"uri": "A String", # Required. The Polaris uri. }, "restIcebergCatalog": { # The REST Iceberg catalog. # The REST Iceberg catalog. - "properties": "A String", # Optional. The content of the configuration file containing additional properties for the REST catalog. + "properties": "A String", # Optional. The base64 encoded content of the configuration file containing additional properties for the REST catalog. "uri": "A String", # Required. The REST uri. }, }, @@ -270,7 +270,7 @@

Method Details

"googleCloudStorageIcebergStorage": { # The Google Cloud Storage Iceberg storage. # The Google Cloud Storage Iceberg storage. "bucket": "A String", # Required. The bucket of Google Cloud Storage. "projectId": "A String", # Required. The project ID of Google Cloud Storage. - "serviceAccountKeyFile": "A String", # Optional. The service account key file of Google Cloud Storage. + "serviceAccountKeyFile": "A String", # Optional. The base64 encoded content of the service account key file of Google Cloud Storage. }, "storageType": "A String", # Required. The type of Iceberg storage. }, @@ -288,7 +288,7 @@

Method Details

"jndiProviderUrl": "A String", # Optional. The URL that Java Message Service will use to contact the JNDI provider. e.g.: 'tcp://myjms.host.domain:61616?jms.prefetchPolicy.all=1000' "jndiSecurityCredentialsSecret": "A String", # Optional. The password associated to the principal. "jndiSecurityPrincipal": "A String", # Optional. Specifies the identity of the principal (user) to be authenticated. - "keyStoreFile": "A String", # Optional. The content of the KeyStore file. + "keyStoreFile": "A String", # Optional. The base64 encoded content of the KeyStore file. "keyStorePassword": "A String", # Optional. Input only. The KeyStore password in plain text. "keyStorePasswordSecretVersion": "A String", # Optional. Input only. The resource name of a secret version in Secret Manager which contains the KeyStore password. Format: projects/{project}/secrets/{secret}/versions/{version}. "password": "A String", # Optional. Input only. The password Oracle Goldengate uses to connect the Java Message Service in plain text. @@ -297,7 +297,7 @@

Method Details

"sslKeyPassword": "A String", # Optional. Input only. The password for the cert inside of the KeyStore in plain text. "sslKeyPasswordSecretVersion": "A String", # Optional. Input only. The resource name of a secret version in Secret Manager which contains the password for the cert inside of the KeyStore. Format: projects/{project}/secrets/{secret}/versions/{version}. "technologyType": "A String", # Optional. The technology type of JavaMessageServiceConnection. - "trustStoreFile": "A String", # Optional. The content of the TrustStore file. + "trustStoreFile": "A String", # Optional. The base64 encoded content of the TrustStore file. "trustStorePassword": "A String", # Optional. Input only. The TrustStore password in plain text. "trustStorePasswordSecretVersion": "A String", # Optional. Input only. The resource name of a secret version in Secret Manager which contains the TrustStore password. Format: projects/{project}/secrets/{secret}/versions/{version}. "useJndi": True or False, # Optional. If set to true, Java Naming and Directory Interface (JNDI) properties should be provided. @@ -312,19 +312,19 @@

Method Details

}, ], "clusterId": "A String", # Optional. The OCID of the Kafka cluster being referenced from OCI Streaming with Apache Kafka. - "consumerPropertiesFile": "A String", # Optional. The content of the consumer.properties file. - "keyStoreFile": "A String", # Optional. The content of the KeyStore file. + "consumerPropertiesFile": "A String", # Optional. The base64 encoded content of the consumer.properties file. + "keyStoreFile": "A String", # Optional. The base64 encoded content of the KeyStore file. "keyStorePassword": "A String", # Optional. Input only. The KeyStore password in plain text. "keyStorePasswordSecretVersion": "A String", # Optional. Input only. The resource name of a secret version in Secret Manager which contains the KeyStore password. Format: projects/{project}/secrets/{secret}/versions/{version}. "password": "A String", # Optional. Input only. The password for Kafka basic/SASL auth in plain text. "passwordSecretVersion": "A String", # Optional. Input only. The resource name of a secret version in Secret Manager which contains the password for Kafka basic/SASL auth. Format: projects/{project}/secrets/{secret}/versions/{version}. - "producerPropertiesFile": "A String", # Optional. The content of the producer.properties file. + "producerPropertiesFile": "A String", # Optional. The base64 encoded content of the producer.properties file. "securityProtocol": "A String", # Optional. Security Type for Kafka. "sslKeyPassword": "A String", # Optional. Input only. The password for the cert inside of the KeyStore in plain text. "sslKeyPasswordSecretVersion": "A String", # Optional. Input only. The resource name of a secret version in Secret Manager which contains the password for the cert inside of the KeyStore. Format: projects/{project}/secrets/{secret}/versions/{version}. "streamPoolId": "A String", # Optional. The OCID of the stream pool being referenced. "technologyType": "A String", # Optional. The technology type of KafkaConnection. - "trustStoreFile": "A String", # Optional. The content of the TrustStore file. + "trustStoreFile": "A String", # Optional. The base64 encoded content of the TrustStore file. "trustStorePassword": "A String", # Optional. Input only. The TrustStore password in plain text. "trustStorePasswordSecretVersion": "A String", # Optional. Input only. The resource name of a secret version in Secret Manager which contains the TrustStore password. Format: projects/{project}/secrets/{secret}/versions/{version}. "useResourcePrincipal": True or False, # Optional. Specifies that the user intends to authenticate to the instance using a resource principal. Applicable only for OCI Streaming connections. @@ -332,7 +332,7 @@

Method Details

}, "kafkaSchemaRegistryConnectionProperties": { # The properties of GoldengateKafkaSchemaRegistryConnection. # Properties for a Kafka Schema Registry Connection. "authenticationType": "A String", # Optional. Used authentication mechanism to access Schema Registry. - "keyStoreFile": "A String", # Optional. The content of the KeyStore file. + "keyStoreFile": "A String", # Optional. The base64 encoded content of the KeyStore file. "keyStorePassword": "A String", # Optional. Input only. The KeyStore password in plain text. "keyStorePasswordSecretVersion": "A String", # Optional. Input only. The resource name of a secret version in Secret Manager which contains the KeyStore password. Format: projects/{project}/secrets/{secret}/versions/{version}. "password": "A String", # Optional. Input only. The password to access Schema Registry in plain text. @@ -340,7 +340,7 @@

Method Details

"sslKeyPassword": "A String", # Optional. Input only. The password for the cert inside the KeyStore in plain text. "sslKeyPasswordSecretVersion": "A String", # Optional. Input only. The resource name of a secret version in Secret Manager which contains the password for the cert inside the KeyStore. Format: projects/{project}/secrets/{secret}/versions/{version}. "technologyType": "A String", # Optional. The technology type of KafkaSchemaRegistryConnection. - "trustStoreFile": "A String", # Optional. The content of the TrustStore file. + "trustStoreFile": "A String", # Optional. The base64 encoded content of the TrustStore file. "trustStorePassword": "A String", # Optional. Input only. The TrustStore password in plain text. "trustStorePasswordSecretVersion": "A String", # Optional. Input only. The resource name of a secret version in Secret Manager which contains the TrustStore password. Format: projects/{project}/secrets/{secret}/versions/{version}. "url": "A String", # Optional. Kafka Schema Registry URL. e.g.: 'https://server1.us.oracle.com:8081' @@ -369,7 +369,7 @@

Method Details

"port": 42, # Optional. The port of an endpoint usually specified for a connection. "securityProtocol": "A String", # Optional. Security Type for Microsoft SQL Server. "serverCertificateValidationRequired": True or False, # Optional. If set to true, the driver validates the certificate that is sent by the database server. - "sslCaFile": "A String", # Optional. Database Certificate - The content of a .pem or .crt file containing the server public key (for 1-way SSL). + "sslCaFile": "A String", # Optional. Database Certificate - The base64 encoded content of a .pem or .crt file containing the server public key (for 1-way SSL). "technologyType": "A String", # Optional. The technology type of MicrosoftSqlserverConnection. "username": "A String", # Optional. The username Oracle Goldengate uses to connect to the Microsoft SQL Server. }, @@ -380,8 +380,8 @@

Method Details

"passwordSecretVersion": "A String", # Optional. Input only. The resource name of a secret version in Secret Manager which contains the password Oracle Goldengate uses to connect the Mongodb connection. Format: projects/{project}/secrets/{secret}/versions/{version}. "securityProtocol": "A String", # Optional. Security Type for MongoDB. "technologyType": "A String", # Optional. The technology type of MongodbConnection. - "tlsCaFile": "A String", # Optional. Database Certificate - The content of a .pem file, containing the server public key (for 1 and 2-way SSL). - "tlsCertificateKeyFile": "A String", # Optional. Client Certificate - The content of a .pem file, containing the client public key (for 2-way SSL). + "tlsCaFile": "A String", # Optional. Database Certificate - The base64 encoded content of a .pem file, containing the server public key (for 1 and 2-way SSL). + "tlsCertificateKeyFile": "A String", # Optional. Client Certificate - The base64 encoded content of a .pem file, containing the client public key (for 2-way SSL). "tlsCertificateKeyFilePassword": "A String", # Optional. Input only. The Client Certificate key file password in plain text. "tlsCertificateKeyFilePasswordSecretVersion": "A String", # Optional. Input only. The resource name of a secret version in Secret Manager which contains the Client Certificate key file password in Secret Manager. Format: projects/{project}/secrets/{secret}/versions/{version}. "username": "A String", # Optional. The username Oracle Goldengate uses to connect to the database. @@ -400,10 +400,10 @@

Method Details

"passwordSecretVersion": "A String", # Optional. Input only. The resource name of a secret version in Secret Manager which contains the password Oracle Goldengate uses to connect to MySQL. Format: projects/{project}/secrets/{secret}/versions/{version}. "port": 42, # Optional. The port of an endpoint usually specified for a connection. "securityProtocol": "A String", # Optional. Security Type for MySQL. - "sslCaFile": "A String", # Optional. Database Certificate - The content of a .pem or .crt file containing the server public key (for 1 and 2-way SSL). - "sslCertFile": "A String", # Optional. Client Certificate - The content of a .pem or .crt file containing the client public key (for 2-way SSL). - "sslCrlFile": "A String", # Optional. The list of certificates revoked by the trusted certificate authorities (Trusted CA). - "sslKeyFile": "A String", # Optional. Client Key - The content of a .pem or .crt file containing the client private key (for 2-way SSL). + "sslCaFile": "A String", # Optional. Database Certificate - The base64 encoded content of a .pem or .crt file containing the server public key (for 1 and 2-way SSL). + "sslCertFile": "A String", # Optional. Client Certificate - The base64 encoded content of a .pem or .crt file containing the client public key (for 2-way SSL). + "sslCrlFile": "A String", # Optional. The base64 encoded list of certificates revoked by the trusted certificate authorities (Trusted CA). + "sslKeyFile": "A String", # Optional. Client Key - The base64 encoded content of a .pem or .crt file containing the client private key (for 2-way SSL). "sslMode": "A String", # Optional. SSL modes for MySQL. "technologyType": "A String", # Optional. The technology type of MysqlConnection. "username": "A String", # Optional. The username Oracle Goldengate uses to connect the associated system of the given technology. @@ -439,7 +439,7 @@

Method Details

"sessionMode": "A String", # Optional. The mode of the database connection session to be established by the data client. "technologyType": "A String", # Optional. The technology type. "username": "A String", # Optional. The username Oracle Goldengate uses to connect. - "walletFile": "A String", # Optional. The wallet contents Oracle Goldengate uses to make connections to a database. + "walletFile": "A String", # Optional. The wallet contents Oracle Goldengate uses to make connections to a database. This attribute is expected to be base64 encoded. }, "oracleNosqlConnectionProperties": { # The properties of GoldengateOracleNosqlConnection. # Properties for an Oracle NoSQL connection. "privateKeyFile": "A String", # Optional. The content of the private key file (PEM file) corresponding to the API key of the fingerprint. @@ -465,17 +465,17 @@

Method Details

"passwordSecretVersion": "A String", # Optional. Input only. The resource name of a secret version in Secret Manager which contains the password Oracle Goldengate uses for PostgreSQL connection. Format: projects/{project}/secrets/{secret}/versions/{version}. "port": 42, # Optional. The port of an endpoint usually specified for a connection. "securityProtocol": "A String", # Optional. Security protocol for PostgreSQL. - "sslCaFile": "A String", # Optional. The certificate of the trusted certificate authorities (Trusted CA) for PostgreSQL. - "sslCertFile": "A String", # Optional. The certificate of the PostgreSQL server. - "sslCrlFile": "A String", # Optional. The list of certificates revoked by the trusted certificate authorities (Trusted CA). - "sslKeyFile": "A String", # Optional. The private key of the PostgreSQL server. + "sslCaFile": "A String", # Optional. The base64 encoded certificate of the trusted certificate authorities (Trusted CA) for PostgreSQL. + "sslCertFile": "A String", # Optional. The base64 encoded certificate of the PostgreSQL server. + "sslCrlFile": "A String", # Optional. The base64 encoded list of certificates revoked by the trusted certificate authorities (Trusted CA). + "sslKeyFile": "A String", # Optional. The base64 encoded private key of the PostgreSQL server. "sslMode": "A String", # Optional. SSL modes for PostgreSQL. "technologyType": "A String", # Optional. The technology type of PostgresqlConnection. "username": "A String", # Optional. The username Oracle Goldengate uses to connect the associated system of the given technology. }, "redisConnectionProperties": { # The properties of GoldengateRedisConnection. # Properties for a Redis connection. "authenticationType": "A String", # Optional. Authentication type for Redis. - "keyStoreFile": "A String", # Optional. The content of the KeyStore file. + "keyStoreFile": "A String", # Optional. The base64 encoded content of the KeyStore file. "keyStorePassword": "A String", # Optional. Input only. The KeyStore password in plain text. "keyStorePasswordSecretVersion": "A String", # Optional. Input only. The resource name of a secret version in Secret Manager which contains the KeyStore password. Format: projects/{project}/secrets/{secret}/versions/{version}. "password": "A String", # Optional. Input only. The password Oracle Goldengate uses for Redis connection in plain text. @@ -484,7 +484,7 @@

Method Details

"securityProtocol": "A String", # Optional. Security protocol for Redis. "servers": "A String", # Optional. Comma separated list of Redis server addresses, specified as host:port entries, where :port is optional. If port is not specified, it defaults to 6379. Example: "server1.example.com:6379,server2.example.com:6379" "technologyType": "A String", # Optional. The technology type of RedisConnection. - "trustStoreFile": "A String", # Optional. The content of the TrustStore file. + "trustStoreFile": "A String", # Optional. The base64 encoded content of the TrustStore file. "trustStorePassword": "A String", # Optional. Input only. The TrustStore password in plain text. "trustStorePasswordSecretVersion": "A String", # Optional. Input only. The resource name of a secret version in Secret Manager which contains the TrustStore password. Format: projects/{project}/secrets/{secret}/versions/{version}. "username": "A String", # Optional. The username Oracle Goldengate uses to connect the associated system of the given technology. @@ -693,15 +693,15 @@

Method Details

"username": "A String", # Optional. The username credential. }, "googleBigQueryConnectionProperties": { # The properties of GoldengateGoogleBigQueryConnectionProperties. # Properties for a Google BigQuery Connection. - "serviceAccountKeyFile": "A String", # Optional. The service account key file Cloud Storage containing the credentials required to use Google BigQuery. + "serviceAccountKeyFile": "A String", # Optional. The base64 encoded content of the service account key file containing the credentials required to use Google BigQuery. "technologyType": "A String", # Optional. The technology type. }, "googleCloudStorageConnectionProperties": { # The properties of GoldengateGoogleCloudStorageConnectionProperties. # Properties for a Google Cloud Storage Connection. - "serviceAccountKeyFile": "A String", # Optional. The service account key Cloud Storage file containing the credentials required to use Google Cloud Storage. + "serviceAccountKeyFile": "A String", # Optional. The base64 encoded content of the service account key file containing the credentials required to use Google Cloud Storage. "technologyType": "A String", # Optional. The technology type. }, "googlePubsubConnectionProperties": { # The properties of GoldengateGooglePubsubConnection. # Properties for a Google Pub/Sub connection. - "serviceAccountKeyFile": "A String", # Optional. The content of the service account key file containing the credentials required to use Google Pub/Sub. + "serviceAccountKeyFile": "A String", # Optional. The base64 encoded content of the service account key file containing the credentials required to use Google Pub/Sub. "technologyType": "A String", # Optional. The technology type of GooglePubsubConnection. }, "hdfsConnectionProperties": { # The properties of GoldengateHdfsConnection. # Properties for an HDFS connection. @@ -726,7 +726,7 @@

Method Details

"uri": "A String", # Required. The Polaris uri. }, "restIcebergCatalog": { # The REST Iceberg catalog. # The REST Iceberg catalog. - "properties": "A String", # Optional. The content of the configuration file containing additional properties for the REST catalog. + "properties": "A String", # Optional. The base64 encoded content of the configuration file containing additional properties for the REST catalog. "uri": "A String", # Required. The REST uri. }, }, @@ -748,7 +748,7 @@

Method Details

"googleCloudStorageIcebergStorage": { # The Google Cloud Storage Iceberg storage. # The Google Cloud Storage Iceberg storage. "bucket": "A String", # Required. The bucket of Google Cloud Storage. "projectId": "A String", # Required. The project ID of Google Cloud Storage. - "serviceAccountKeyFile": "A String", # Optional. The service account key file of Google Cloud Storage. + "serviceAccountKeyFile": "A String", # Optional. The base64 encoded content of the service account key file of Google Cloud Storage. }, "storageType": "A String", # Required. The type of Iceberg storage. }, @@ -766,7 +766,7 @@

Method Details

"jndiProviderUrl": "A String", # Optional. The URL that Java Message Service will use to contact the JNDI provider. e.g.: 'tcp://myjms.host.domain:61616?jms.prefetchPolicy.all=1000' "jndiSecurityCredentialsSecret": "A String", # Optional. The password associated to the principal. "jndiSecurityPrincipal": "A String", # Optional. Specifies the identity of the principal (user) to be authenticated. - "keyStoreFile": "A String", # Optional. The content of the KeyStore file. + "keyStoreFile": "A String", # Optional. The base64 encoded content of the KeyStore file. "keyStorePassword": "A String", # Optional. Input only. The KeyStore password in plain text. "keyStorePasswordSecretVersion": "A String", # Optional. Input only. The resource name of a secret version in Secret Manager which contains the KeyStore password. Format: projects/{project}/secrets/{secret}/versions/{version}. "password": "A String", # Optional. Input only. The password Oracle Goldengate uses to connect the Java Message Service in plain text. @@ -775,7 +775,7 @@

Method Details

"sslKeyPassword": "A String", # Optional. Input only. The password for the cert inside of the KeyStore in plain text. "sslKeyPasswordSecretVersion": "A String", # Optional. Input only. The resource name of a secret version in Secret Manager which contains the password for the cert inside of the KeyStore. Format: projects/{project}/secrets/{secret}/versions/{version}. "technologyType": "A String", # Optional. The technology type of JavaMessageServiceConnection. - "trustStoreFile": "A String", # Optional. The content of the TrustStore file. + "trustStoreFile": "A String", # Optional. The base64 encoded content of the TrustStore file. "trustStorePassword": "A String", # Optional. Input only. The TrustStore password in plain text. "trustStorePasswordSecretVersion": "A String", # Optional. Input only. The resource name of a secret version in Secret Manager which contains the TrustStore password. Format: projects/{project}/secrets/{secret}/versions/{version}. "useJndi": True or False, # Optional. If set to true, Java Naming and Directory Interface (JNDI) properties should be provided. @@ -790,19 +790,19 @@

Method Details

}, ], "clusterId": "A String", # Optional. The OCID of the Kafka cluster being referenced from OCI Streaming with Apache Kafka. - "consumerPropertiesFile": "A String", # Optional. The content of the consumer.properties file. - "keyStoreFile": "A String", # Optional. The content of the KeyStore file. + "consumerPropertiesFile": "A String", # Optional. The base64 encoded content of the consumer.properties file. + "keyStoreFile": "A String", # Optional. The base64 encoded content of the KeyStore file. "keyStorePassword": "A String", # Optional. Input only. The KeyStore password in plain text. "keyStorePasswordSecretVersion": "A String", # Optional. Input only. The resource name of a secret version in Secret Manager which contains the KeyStore password. Format: projects/{project}/secrets/{secret}/versions/{version}. "password": "A String", # Optional. Input only. The password for Kafka basic/SASL auth in plain text. "passwordSecretVersion": "A String", # Optional. Input only. The resource name of a secret version in Secret Manager which contains the password for Kafka basic/SASL auth. Format: projects/{project}/secrets/{secret}/versions/{version}. - "producerPropertiesFile": "A String", # Optional. The content of the producer.properties file. + "producerPropertiesFile": "A String", # Optional. The base64 encoded content of the producer.properties file. "securityProtocol": "A String", # Optional. Security Type for Kafka. "sslKeyPassword": "A String", # Optional. Input only. The password for the cert inside of the KeyStore in plain text. "sslKeyPasswordSecretVersion": "A String", # Optional. Input only. The resource name of a secret version in Secret Manager which contains the password for the cert inside of the KeyStore. Format: projects/{project}/secrets/{secret}/versions/{version}. "streamPoolId": "A String", # Optional. The OCID of the stream pool being referenced. "technologyType": "A String", # Optional. The technology type of KafkaConnection. - "trustStoreFile": "A String", # Optional. The content of the TrustStore file. + "trustStoreFile": "A String", # Optional. The base64 encoded content of the TrustStore file. "trustStorePassword": "A String", # Optional. Input only. The TrustStore password in plain text. "trustStorePasswordSecretVersion": "A String", # Optional. Input only. The resource name of a secret version in Secret Manager which contains the TrustStore password. Format: projects/{project}/secrets/{secret}/versions/{version}. "useResourcePrincipal": True or False, # Optional. Specifies that the user intends to authenticate to the instance using a resource principal. Applicable only for OCI Streaming connections. @@ -810,7 +810,7 @@

Method Details

}, "kafkaSchemaRegistryConnectionProperties": { # The properties of GoldengateKafkaSchemaRegistryConnection. # Properties for a Kafka Schema Registry Connection. "authenticationType": "A String", # Optional. Used authentication mechanism to access Schema Registry. - "keyStoreFile": "A String", # Optional. The content of the KeyStore file. + "keyStoreFile": "A String", # Optional. The base64 encoded content of the KeyStore file. "keyStorePassword": "A String", # Optional. Input only. The KeyStore password in plain text. "keyStorePasswordSecretVersion": "A String", # Optional. Input only. The resource name of a secret version in Secret Manager which contains the KeyStore password. Format: projects/{project}/secrets/{secret}/versions/{version}. "password": "A String", # Optional. Input only. The password to access Schema Registry in plain text. @@ -818,7 +818,7 @@

Method Details

"sslKeyPassword": "A String", # Optional. Input only. The password for the cert inside the KeyStore in plain text. "sslKeyPasswordSecretVersion": "A String", # Optional. Input only. The resource name of a secret version in Secret Manager which contains the password for the cert inside the KeyStore. Format: projects/{project}/secrets/{secret}/versions/{version}. "technologyType": "A String", # Optional. The technology type of KafkaSchemaRegistryConnection. - "trustStoreFile": "A String", # Optional. The content of the TrustStore file. + "trustStoreFile": "A String", # Optional. The base64 encoded content of the TrustStore file. "trustStorePassword": "A String", # Optional. Input only. The TrustStore password in plain text. "trustStorePasswordSecretVersion": "A String", # Optional. Input only. The resource name of a secret version in Secret Manager which contains the TrustStore password. Format: projects/{project}/secrets/{secret}/versions/{version}. "url": "A String", # Optional. Kafka Schema Registry URL. e.g.: 'https://server1.us.oracle.com:8081' @@ -847,7 +847,7 @@

Method Details

"port": 42, # Optional. The port of an endpoint usually specified for a connection. "securityProtocol": "A String", # Optional. Security Type for Microsoft SQL Server. "serverCertificateValidationRequired": True or False, # Optional. If set to true, the driver validates the certificate that is sent by the database server. - "sslCaFile": "A String", # Optional. Database Certificate - The content of a .pem or .crt file containing the server public key (for 1-way SSL). + "sslCaFile": "A String", # Optional. Database Certificate - The base64 encoded content of a .pem or .crt file containing the server public key (for 1-way SSL). "technologyType": "A String", # Optional. The technology type of MicrosoftSqlserverConnection. "username": "A String", # Optional. The username Oracle Goldengate uses to connect to the Microsoft SQL Server. }, @@ -858,8 +858,8 @@

Method Details

"passwordSecretVersion": "A String", # Optional. Input only. The resource name of a secret version in Secret Manager which contains the password Oracle Goldengate uses to connect the Mongodb connection. Format: projects/{project}/secrets/{secret}/versions/{version}. "securityProtocol": "A String", # Optional. Security Type for MongoDB. "technologyType": "A String", # Optional. The technology type of MongodbConnection. - "tlsCaFile": "A String", # Optional. Database Certificate - The content of a .pem file, containing the server public key (for 1 and 2-way SSL). - "tlsCertificateKeyFile": "A String", # Optional. Client Certificate - The content of a .pem file, containing the client public key (for 2-way SSL). + "tlsCaFile": "A String", # Optional. Database Certificate - The base64 encoded content of a .pem file, containing the server public key (for 1 and 2-way SSL). + "tlsCertificateKeyFile": "A String", # Optional. Client Certificate - The base64 encoded content of a .pem file, containing the client public key (for 2-way SSL). "tlsCertificateKeyFilePassword": "A String", # Optional. Input only. The Client Certificate key file password in plain text. "tlsCertificateKeyFilePasswordSecretVersion": "A String", # Optional. Input only. The resource name of a secret version in Secret Manager which contains the Client Certificate key file password in Secret Manager. Format: projects/{project}/secrets/{secret}/versions/{version}. "username": "A String", # Optional. The username Oracle Goldengate uses to connect to the database. @@ -878,10 +878,10 @@

Method Details

"passwordSecretVersion": "A String", # Optional. Input only. The resource name of a secret version in Secret Manager which contains the password Oracle Goldengate uses to connect to MySQL. Format: projects/{project}/secrets/{secret}/versions/{version}. "port": 42, # Optional. The port of an endpoint usually specified for a connection. "securityProtocol": "A String", # Optional. Security Type for MySQL. - "sslCaFile": "A String", # Optional. Database Certificate - The content of a .pem or .crt file containing the server public key (for 1 and 2-way SSL). - "sslCertFile": "A String", # Optional. Client Certificate - The content of a .pem or .crt file containing the client public key (for 2-way SSL). - "sslCrlFile": "A String", # Optional. The list of certificates revoked by the trusted certificate authorities (Trusted CA). - "sslKeyFile": "A String", # Optional. Client Key - The content of a .pem or .crt file containing the client private key (for 2-way SSL). + "sslCaFile": "A String", # Optional. Database Certificate - The base64 encoded content of a .pem or .crt file containing the server public key (for 1 and 2-way SSL). + "sslCertFile": "A String", # Optional. Client Certificate - The base64 encoded content of a .pem or .crt file containing the client public key (for 2-way SSL). + "sslCrlFile": "A String", # Optional. The base64 encoded list of certificates revoked by the trusted certificate authorities (Trusted CA). + "sslKeyFile": "A String", # Optional. Client Key - The base64 encoded content of a .pem or .crt file containing the client private key (for 2-way SSL). "sslMode": "A String", # Optional. SSL modes for MySQL. "technologyType": "A String", # Optional. The technology type of MysqlConnection. "username": "A String", # Optional. The username Oracle Goldengate uses to connect the associated system of the given technology. @@ -917,7 +917,7 @@

Method Details

"sessionMode": "A String", # Optional. The mode of the database connection session to be established by the data client. "technologyType": "A String", # Optional. The technology type. "username": "A String", # Optional. The username Oracle Goldengate uses to connect. - "walletFile": "A String", # Optional. The wallet contents Oracle Goldengate uses to make connections to a database. + "walletFile": "A String", # Optional. The wallet contents Oracle Goldengate uses to make connections to a database. This attribute is expected to be base64 encoded. }, "oracleNosqlConnectionProperties": { # The properties of GoldengateOracleNosqlConnection. # Properties for an Oracle NoSQL connection. "privateKeyFile": "A String", # Optional. The content of the private key file (PEM file) corresponding to the API key of the fingerprint. @@ -943,17 +943,17 @@

Method Details

"passwordSecretVersion": "A String", # Optional. Input only. The resource name of a secret version in Secret Manager which contains the password Oracle Goldengate uses for PostgreSQL connection. Format: projects/{project}/secrets/{secret}/versions/{version}. "port": 42, # Optional. The port of an endpoint usually specified for a connection. "securityProtocol": "A String", # Optional. Security protocol for PostgreSQL. - "sslCaFile": "A String", # Optional. The certificate of the trusted certificate authorities (Trusted CA) for PostgreSQL. - "sslCertFile": "A String", # Optional. The certificate of the PostgreSQL server. - "sslCrlFile": "A String", # Optional. The list of certificates revoked by the trusted certificate authorities (Trusted CA). - "sslKeyFile": "A String", # Optional. The private key of the PostgreSQL server. + "sslCaFile": "A String", # Optional. The base64 encoded certificate of the trusted certificate authorities (Trusted CA) for PostgreSQL. + "sslCertFile": "A String", # Optional. The base64 encoded certificate of the PostgreSQL server. + "sslCrlFile": "A String", # Optional. The base64 encoded list of certificates revoked by the trusted certificate authorities (Trusted CA). + "sslKeyFile": "A String", # Optional. The base64 encoded private key of the PostgreSQL server. "sslMode": "A String", # Optional. SSL modes for PostgreSQL. "technologyType": "A String", # Optional. The technology type of PostgresqlConnection. "username": "A String", # Optional. The username Oracle Goldengate uses to connect the associated system of the given technology. }, "redisConnectionProperties": { # The properties of GoldengateRedisConnection. # Properties for a Redis connection. "authenticationType": "A String", # Optional. Authentication type for Redis. - "keyStoreFile": "A String", # Optional. The content of the KeyStore file. + "keyStoreFile": "A String", # Optional. The base64 encoded content of the KeyStore file. "keyStorePassword": "A String", # Optional. Input only. The KeyStore password in plain text. "keyStorePasswordSecretVersion": "A String", # Optional. Input only. The resource name of a secret version in Secret Manager which contains the KeyStore password. Format: projects/{project}/secrets/{secret}/versions/{version}. "password": "A String", # Optional. Input only. The password Oracle Goldengate uses for Redis connection in plain text. @@ -962,7 +962,7 @@

Method Details

"securityProtocol": "A String", # Optional. Security protocol for Redis. "servers": "A String", # Optional. Comma separated list of Redis server addresses, specified as host:port entries, where :port is optional. If port is not specified, it defaults to 6379. Example: "server1.example.com:6379,server2.example.com:6379" "technologyType": "A String", # Optional. The technology type of RedisConnection. - "trustStoreFile": "A String", # Optional. The content of the TrustStore file. + "trustStoreFile": "A String", # Optional. The base64 encoded content of the TrustStore file. "trustStorePassword": "A String", # Optional. Input only. The TrustStore password in plain text. "trustStorePasswordSecretVersion": "A String", # Optional. Input only. The resource name of a secret version in Secret Manager which contains the TrustStore password. Format: projects/{project}/secrets/{secret}/versions/{version}. "username": "A String", # Optional. The username Oracle Goldengate uses to connect the associated system of the given technology. @@ -1111,15 +1111,15 @@

Method Details

"username": "A String", # Optional. The username credential. }, "googleBigQueryConnectionProperties": { # The properties of GoldengateGoogleBigQueryConnectionProperties. # Properties for a Google BigQuery Connection. - "serviceAccountKeyFile": "A String", # Optional. The service account key file Cloud Storage containing the credentials required to use Google BigQuery. + "serviceAccountKeyFile": "A String", # Optional. The base64 encoded content of the service account key file containing the credentials required to use Google BigQuery. "technologyType": "A String", # Optional. The technology type. }, "googleCloudStorageConnectionProperties": { # The properties of GoldengateGoogleCloudStorageConnectionProperties. # Properties for a Google Cloud Storage Connection. - "serviceAccountKeyFile": "A String", # Optional. The service account key Cloud Storage file containing the credentials required to use Google Cloud Storage. + "serviceAccountKeyFile": "A String", # Optional. The base64 encoded content of the service account key file containing the credentials required to use Google Cloud Storage. "technologyType": "A String", # Optional. The technology type. }, "googlePubsubConnectionProperties": { # The properties of GoldengateGooglePubsubConnection. # Properties for a Google Pub/Sub connection. - "serviceAccountKeyFile": "A String", # Optional. The content of the service account key file containing the credentials required to use Google Pub/Sub. + "serviceAccountKeyFile": "A String", # Optional. The base64 encoded content of the service account key file containing the credentials required to use Google Pub/Sub. "technologyType": "A String", # Optional. The technology type of GooglePubsubConnection. }, "hdfsConnectionProperties": { # The properties of GoldengateHdfsConnection. # Properties for an HDFS connection. @@ -1144,7 +1144,7 @@

Method Details

"uri": "A String", # Required. The Polaris uri. }, "restIcebergCatalog": { # The REST Iceberg catalog. # The REST Iceberg catalog. - "properties": "A String", # Optional. The content of the configuration file containing additional properties for the REST catalog. + "properties": "A String", # Optional. The base64 encoded content of the configuration file containing additional properties for the REST catalog. "uri": "A String", # Required. The REST uri. }, }, @@ -1166,7 +1166,7 @@

Method Details

"googleCloudStorageIcebergStorage": { # The Google Cloud Storage Iceberg storage. # The Google Cloud Storage Iceberg storage. "bucket": "A String", # Required. The bucket of Google Cloud Storage. "projectId": "A String", # Required. The project ID of Google Cloud Storage. - "serviceAccountKeyFile": "A String", # Optional. The service account key file of Google Cloud Storage. + "serviceAccountKeyFile": "A String", # Optional. The base64 encoded content of the service account key file of Google Cloud Storage. }, "storageType": "A String", # Required. The type of Iceberg storage. }, @@ -1184,7 +1184,7 @@

Method Details

"jndiProviderUrl": "A String", # Optional. The URL that Java Message Service will use to contact the JNDI provider. e.g.: 'tcp://myjms.host.domain:61616?jms.prefetchPolicy.all=1000' "jndiSecurityCredentialsSecret": "A String", # Optional. The password associated to the principal. "jndiSecurityPrincipal": "A String", # Optional. Specifies the identity of the principal (user) to be authenticated. - "keyStoreFile": "A String", # Optional. The content of the KeyStore file. + "keyStoreFile": "A String", # Optional. The base64 encoded content of the KeyStore file. "keyStorePassword": "A String", # Optional. Input only. The KeyStore password in plain text. "keyStorePasswordSecretVersion": "A String", # Optional. Input only. The resource name of a secret version in Secret Manager which contains the KeyStore password. Format: projects/{project}/secrets/{secret}/versions/{version}. "password": "A String", # Optional. Input only. The password Oracle Goldengate uses to connect the Java Message Service in plain text. @@ -1193,7 +1193,7 @@

Method Details

"sslKeyPassword": "A String", # Optional. Input only. The password for the cert inside of the KeyStore in plain text. "sslKeyPasswordSecretVersion": "A String", # Optional. Input only. The resource name of a secret version in Secret Manager which contains the password for the cert inside of the KeyStore. Format: projects/{project}/secrets/{secret}/versions/{version}. "technologyType": "A String", # Optional. The technology type of JavaMessageServiceConnection. - "trustStoreFile": "A String", # Optional. The content of the TrustStore file. + "trustStoreFile": "A String", # Optional. The base64 encoded content of the TrustStore file. "trustStorePassword": "A String", # Optional. Input only. The TrustStore password in plain text. "trustStorePasswordSecretVersion": "A String", # Optional. Input only. The resource name of a secret version in Secret Manager which contains the TrustStore password. Format: projects/{project}/secrets/{secret}/versions/{version}. "useJndi": True or False, # Optional. If set to true, Java Naming and Directory Interface (JNDI) properties should be provided. @@ -1208,19 +1208,19 @@

Method Details

}, ], "clusterId": "A String", # Optional. The OCID of the Kafka cluster being referenced from OCI Streaming with Apache Kafka. - "consumerPropertiesFile": "A String", # Optional. The content of the consumer.properties file. - "keyStoreFile": "A String", # Optional. The content of the KeyStore file. + "consumerPropertiesFile": "A String", # Optional. The base64 encoded content of the consumer.properties file. + "keyStoreFile": "A String", # Optional. The base64 encoded content of the KeyStore file. "keyStorePassword": "A String", # Optional. Input only. The KeyStore password in plain text. "keyStorePasswordSecretVersion": "A String", # Optional. Input only. The resource name of a secret version in Secret Manager which contains the KeyStore password. Format: projects/{project}/secrets/{secret}/versions/{version}. "password": "A String", # Optional. Input only. The password for Kafka basic/SASL auth in plain text. "passwordSecretVersion": "A String", # Optional. Input only. The resource name of a secret version in Secret Manager which contains the password for Kafka basic/SASL auth. Format: projects/{project}/secrets/{secret}/versions/{version}. - "producerPropertiesFile": "A String", # Optional. The content of the producer.properties file. + "producerPropertiesFile": "A String", # Optional. The base64 encoded content of the producer.properties file. "securityProtocol": "A String", # Optional. Security Type for Kafka. "sslKeyPassword": "A String", # Optional. Input only. The password for the cert inside of the KeyStore in plain text. "sslKeyPasswordSecretVersion": "A String", # Optional. Input only. The resource name of a secret version in Secret Manager which contains the password for the cert inside of the KeyStore. Format: projects/{project}/secrets/{secret}/versions/{version}. "streamPoolId": "A String", # Optional. The OCID of the stream pool being referenced. "technologyType": "A String", # Optional. The technology type of KafkaConnection. - "trustStoreFile": "A String", # Optional. The content of the TrustStore file. + "trustStoreFile": "A String", # Optional. The base64 encoded content of the TrustStore file. "trustStorePassword": "A String", # Optional. Input only. The TrustStore password in plain text. "trustStorePasswordSecretVersion": "A String", # Optional. Input only. The resource name of a secret version in Secret Manager which contains the TrustStore password. Format: projects/{project}/secrets/{secret}/versions/{version}. "useResourcePrincipal": True or False, # Optional. Specifies that the user intends to authenticate to the instance using a resource principal. Applicable only for OCI Streaming connections. @@ -1228,7 +1228,7 @@

Method Details

}, "kafkaSchemaRegistryConnectionProperties": { # The properties of GoldengateKafkaSchemaRegistryConnection. # Properties for a Kafka Schema Registry Connection. "authenticationType": "A String", # Optional. Used authentication mechanism to access Schema Registry. - "keyStoreFile": "A String", # Optional. The content of the KeyStore file. + "keyStoreFile": "A String", # Optional. The base64 encoded content of the KeyStore file. "keyStorePassword": "A String", # Optional. Input only. The KeyStore password in plain text. "keyStorePasswordSecretVersion": "A String", # Optional. Input only. The resource name of a secret version in Secret Manager which contains the KeyStore password. Format: projects/{project}/secrets/{secret}/versions/{version}. "password": "A String", # Optional. Input only. The password to access Schema Registry in plain text. @@ -1236,7 +1236,7 @@

Method Details

"sslKeyPassword": "A String", # Optional. Input only. The password for the cert inside the KeyStore in plain text. "sslKeyPasswordSecretVersion": "A String", # Optional. Input only. The resource name of a secret version in Secret Manager which contains the password for the cert inside the KeyStore. Format: projects/{project}/secrets/{secret}/versions/{version}. "technologyType": "A String", # Optional. The technology type of KafkaSchemaRegistryConnection. - "trustStoreFile": "A String", # Optional. The content of the TrustStore file. + "trustStoreFile": "A String", # Optional. The base64 encoded content of the TrustStore file. "trustStorePassword": "A String", # Optional. Input only. The TrustStore password in plain text. "trustStorePasswordSecretVersion": "A String", # Optional. Input only. The resource name of a secret version in Secret Manager which contains the TrustStore password. Format: projects/{project}/secrets/{secret}/versions/{version}. "url": "A String", # Optional. Kafka Schema Registry URL. e.g.: 'https://server1.us.oracle.com:8081' @@ -1265,7 +1265,7 @@

Method Details

"port": 42, # Optional. The port of an endpoint usually specified for a connection. "securityProtocol": "A String", # Optional. Security Type for Microsoft SQL Server. "serverCertificateValidationRequired": True or False, # Optional. If set to true, the driver validates the certificate that is sent by the database server. - "sslCaFile": "A String", # Optional. Database Certificate - The content of a .pem or .crt file containing the server public key (for 1-way SSL). + "sslCaFile": "A String", # Optional. Database Certificate - The base64 encoded content of a .pem or .crt file containing the server public key (for 1-way SSL). "technologyType": "A String", # Optional. The technology type of MicrosoftSqlserverConnection. "username": "A String", # Optional. The username Oracle Goldengate uses to connect to the Microsoft SQL Server. }, @@ -1276,8 +1276,8 @@

Method Details

"passwordSecretVersion": "A String", # Optional. Input only. The resource name of a secret version in Secret Manager which contains the password Oracle Goldengate uses to connect the Mongodb connection. Format: projects/{project}/secrets/{secret}/versions/{version}. "securityProtocol": "A String", # Optional. Security Type for MongoDB. "technologyType": "A String", # Optional. The technology type of MongodbConnection. - "tlsCaFile": "A String", # Optional. Database Certificate - The content of a .pem file, containing the server public key (for 1 and 2-way SSL). - "tlsCertificateKeyFile": "A String", # Optional. Client Certificate - The content of a .pem file, containing the client public key (for 2-way SSL). + "tlsCaFile": "A String", # Optional. Database Certificate - The base64 encoded content of a .pem file, containing the server public key (for 1 and 2-way SSL). + "tlsCertificateKeyFile": "A String", # Optional. Client Certificate - The base64 encoded content of a .pem file, containing the client public key (for 2-way SSL). "tlsCertificateKeyFilePassword": "A String", # Optional. Input only. The Client Certificate key file password in plain text. "tlsCertificateKeyFilePasswordSecretVersion": "A String", # Optional. Input only. The resource name of a secret version in Secret Manager which contains the Client Certificate key file password in Secret Manager. Format: projects/{project}/secrets/{secret}/versions/{version}. "username": "A String", # Optional. The username Oracle Goldengate uses to connect to the database. @@ -1296,10 +1296,10 @@

Method Details

"passwordSecretVersion": "A String", # Optional. Input only. The resource name of a secret version in Secret Manager which contains the password Oracle Goldengate uses to connect to MySQL. Format: projects/{project}/secrets/{secret}/versions/{version}. "port": 42, # Optional. The port of an endpoint usually specified for a connection. "securityProtocol": "A String", # Optional. Security Type for MySQL. - "sslCaFile": "A String", # Optional. Database Certificate - The content of a .pem or .crt file containing the server public key (for 1 and 2-way SSL). - "sslCertFile": "A String", # Optional. Client Certificate - The content of a .pem or .crt file containing the client public key (for 2-way SSL). - "sslCrlFile": "A String", # Optional. The list of certificates revoked by the trusted certificate authorities (Trusted CA). - "sslKeyFile": "A String", # Optional. Client Key - The content of a .pem or .crt file containing the client private key (for 2-way SSL). + "sslCaFile": "A String", # Optional. Database Certificate - The base64 encoded content of a .pem or .crt file containing the server public key (for 1 and 2-way SSL). + "sslCertFile": "A String", # Optional. Client Certificate - The base64 encoded content of a .pem or .crt file containing the client public key (for 2-way SSL). + "sslCrlFile": "A String", # Optional. The base64 encoded list of certificates revoked by the trusted certificate authorities (Trusted CA). + "sslKeyFile": "A String", # Optional. Client Key - The base64 encoded content of a .pem or .crt file containing the client private key (for 2-way SSL). "sslMode": "A String", # Optional. SSL modes for MySQL. "technologyType": "A String", # Optional. The technology type of MysqlConnection. "username": "A String", # Optional. The username Oracle Goldengate uses to connect the associated system of the given technology. @@ -1335,7 +1335,7 @@

Method Details

"sessionMode": "A String", # Optional. The mode of the database connection session to be established by the data client. "technologyType": "A String", # Optional. The technology type. "username": "A String", # Optional. The username Oracle Goldengate uses to connect. - "walletFile": "A String", # Optional. The wallet contents Oracle Goldengate uses to make connections to a database. + "walletFile": "A String", # Optional. The wallet contents Oracle Goldengate uses to make connections to a database. This attribute is expected to be base64 encoded. }, "oracleNosqlConnectionProperties": { # The properties of GoldengateOracleNosqlConnection. # Properties for an Oracle NoSQL connection. "privateKeyFile": "A String", # Optional. The content of the private key file (PEM file) corresponding to the API key of the fingerprint. @@ -1361,17 +1361,17 @@

Method Details

"passwordSecretVersion": "A String", # Optional. Input only. The resource name of a secret version in Secret Manager which contains the password Oracle Goldengate uses for PostgreSQL connection. Format: projects/{project}/secrets/{secret}/versions/{version}. "port": 42, # Optional. The port of an endpoint usually specified for a connection. "securityProtocol": "A String", # Optional. Security protocol for PostgreSQL. - "sslCaFile": "A String", # Optional. The certificate of the trusted certificate authorities (Trusted CA) for PostgreSQL. - "sslCertFile": "A String", # Optional. The certificate of the PostgreSQL server. - "sslCrlFile": "A String", # Optional. The list of certificates revoked by the trusted certificate authorities (Trusted CA). - "sslKeyFile": "A String", # Optional. The private key of the PostgreSQL server. + "sslCaFile": "A String", # Optional. The base64 encoded certificate of the trusted certificate authorities (Trusted CA) for PostgreSQL. + "sslCertFile": "A String", # Optional. The base64 encoded certificate of the PostgreSQL server. + "sslCrlFile": "A String", # Optional. The base64 encoded list of certificates revoked by the trusted certificate authorities (Trusted CA). + "sslKeyFile": "A String", # Optional. The base64 encoded private key of the PostgreSQL server. "sslMode": "A String", # Optional. SSL modes for PostgreSQL. "technologyType": "A String", # Optional. The technology type of PostgresqlConnection. "username": "A String", # Optional. The username Oracle Goldengate uses to connect the associated system of the given technology. }, "redisConnectionProperties": { # The properties of GoldengateRedisConnection. # Properties for a Redis connection. "authenticationType": "A String", # Optional. Authentication type for Redis. - "keyStoreFile": "A String", # Optional. The content of the KeyStore file. + "keyStoreFile": "A String", # Optional. The base64 encoded content of the KeyStore file. "keyStorePassword": "A String", # Optional. Input only. The KeyStore password in plain text. "keyStorePasswordSecretVersion": "A String", # Optional. Input only. The resource name of a secret version in Secret Manager which contains the KeyStore password. Format: projects/{project}/secrets/{secret}/versions/{version}. "password": "A String", # Optional. Input only. The password Oracle Goldengate uses for Redis connection in plain text. @@ -1380,7 +1380,7 @@

Method Details

"securityProtocol": "A String", # Optional. Security protocol for Redis. "servers": "A String", # Optional. Comma separated list of Redis server addresses, specified as host:port entries, where :port is optional. If port is not specified, it defaults to 6379. Example: "server1.example.com:6379,server2.example.com:6379" "technologyType": "A String", # Optional. The technology type of RedisConnection. - "trustStoreFile": "A String", # Optional. The content of the TrustStore file. + "trustStoreFile": "A String", # Optional. The base64 encoded content of the TrustStore file. "trustStorePassword": "A String", # Optional. Input only. The TrustStore password in plain text. "trustStorePasswordSecretVersion": "A String", # Optional. Input only. The resource name of a secret version in Secret Manager which contains the TrustStore password. Format: projects/{project}/secrets/{secret}/versions/{version}. "username": "A String", # Optional. The username Oracle Goldengate uses to connect the associated system of the given technology. diff --git a/docs/dyn/places_v1.places.html b/docs/dyn/places_v1.places.html index bb09a1c93c..710d59a21b 100644 --- a/docs/dyn/places_v1.places.html +++ b/docs/dyn/places_v1.places.html @@ -812,6 +812,77 @@

Method Details

"id": "A String", # IANA Time Zone Database time zone. For example "America/New_York". "version": "A String", # Optional. IANA Time Zone Database version number. For example "2019a". }, + "transitStation": { # Represents transit-specific information for a place. # The transit station information for the place. + "agencies": [ # The transit agencies that serve this station. + { # Represents a transit agency. + "displayName": { # Localized variant of a text in a particular language. # Agency name (e.g. "VTA") in the requested language. + "languageCode": "A String", # The text's BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. + "text": "A String", # Localized string in the language corresponding to language_code below. + }, + "fareUrl": "A String", # The URL of the agency's fare details page. + "icon": { # Icon for a transit line, vehicle, or agency. # Icon identifier for localized branded icon of a transit system (e.g. London Underground) which should be used instead of TransitLine.vehicle_icon in the UI. + "nameIncluded": True or False, # Whether the name is contained in the icon and there is no need to display it next to the icon. + "url": "A String", # The URL of the icon. + }, + "lines": [ # The transit lines that are served by this agency. + { # Represents a single transit line. + "backgroundColor": "A String", # The background color of the labels for this transit line in #RRGGBB hex format, e.g. #909CE1. This color can also be used for drawing shapes for this transit line. + "displayName": { # Localized variant of a text in a particular language. # The long name for this transit line (e.g. "Sunnydale local"). + "languageCode": "A String", # The text's BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. + "text": "A String", # Localized string in the language corresponding to language_code below. + }, + "icon": { # Icon for a transit line, vehicle, or agency. # Icon identifier for this particular line (e.g. subway lines in New York). + "nameIncluded": True or False, # Whether the name is contained in the icon and there is no need to display it next to the icon. + "url": "A String", # The URL of the icon. + }, + "id": "A String", # The id of the transit line that can be used to uniquely identify the line among other transit lines in the same transit station. This identifier is not guaranteed to be stable across different responses. + "shortDisplayName": { # Localized variant of a text in a particular language. # The short name for this transit line (e.g. "S2"). + "languageCode": "A String", # The text's BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. + "text": "A String", # Localized string in the language corresponding to language_code below. + }, + "textColor": "A String", # The text color of labels for this transit line in #RRGGBB hex format, e.g. #909CE1. + "url": "A String", # The URL of a webpage with details about this line. + "vehicleIcon": { # Icon for a transit line, vehicle, or agency. # Icon identifier for this particular vehicle type. + "nameIncluded": True or False, # Whether the name is contained in the icon and there is no need to display it next to the icon. + "url": "A String", # The URL of the icon. + }, + "vehicleType": "A String", # The type of vehicle using this line. + }, + ], + "url": "A String", # The URL of the agency's homepage. + }, + ], + "displayName": { # Localized variant of a text in a particular language. # The name of the station in the local language. + "languageCode": "A String", # The text's BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. + "text": "A String", # Localized string in the language corresponding to language_code below. + }, + "stops": [ # Transit stops at this station. + { # Represents a transit stop within a station. This is a specific location where passengers board and alight transit vehicles, such as a platform or bus bay. This is distinct from a `Departure`, which is an event of a vehicle leaving a stop at a specific time. + "displayName": { # Localized variant of a text in a particular language. # The name of the stop. + "languageCode": "A String", # The text's BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. + "text": "A String", # Localized string in the language corresponding to language_code below. + }, + "id": "A String", # The id of the transit stop that can be used to uniquely identify the stop among other transit stops in the same transit station. This identifier is not guaranteed to be stable across different responses. + "location": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # The stop's location. + "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. + "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. + }, + "platformCode": { # Localized variant of a text in a particular language. # The platform code represented by this stop. It can be formatted in any way. (eg: "2", "Platform 2", "2-4", or "1x"). + "languageCode": "A String", # The text's BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. + "text": "A String", # Localized string in the language corresponding to language_code below. + }, + "signageText": { # Localized variant of a text in a particular language. # The verbatim text written on the signboard for this platform, e.g. "Towards Central" or "East side & Brooklyn". When `platform_code` is absent, this field is potentially the only identifier for the platform; however, both `platform_code` and `signage_text` may be set simultaneously. + "languageCode": "A String", # The text's BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. + "text": "A String", # Localized string in the language corresponding to language_code below. + }, + "stopCode": { # Localized variant of a text in a particular language. # Human readable identifier of the stop, used by transit agencies to distinguish stops with the same name. + "languageCode": "A String", # The text's BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. + "text": "A String", # Localized string in the language corresponding to language_code below. + }, + "wheelchairAccessibleEntrance": True or False, # Wheelchair accessibility of this stop. This field indicates whether there is an accessible path from outside the station to the stop. It does not indicate whether it is possible to board a vehicle from the stop. + }, + ], + }, "types": [ # A set of type tags for this result. For example, "political" and "locality". For the complete list of possible values, see Table A and Table B at https://developers.google.com/maps/documentation/places/web-service/place-types "A String", ], @@ -1433,6 +1504,77 @@

Method Details

"id": "A String", # IANA Time Zone Database time zone. For example "America/New_York". "version": "A String", # Optional. IANA Time Zone Database version number. For example "2019a". }, + "transitStation": { # Represents transit-specific information for a place. # The transit station information for the place. + "agencies": [ # The transit agencies that serve this station. + { # Represents a transit agency. + "displayName": { # Localized variant of a text in a particular language. # Agency name (e.g. "VTA") in the requested language. + "languageCode": "A String", # The text's BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. + "text": "A String", # Localized string in the language corresponding to language_code below. + }, + "fareUrl": "A String", # The URL of the agency's fare details page. + "icon": { # Icon for a transit line, vehicle, or agency. # Icon identifier for localized branded icon of a transit system (e.g. London Underground) which should be used instead of TransitLine.vehicle_icon in the UI. + "nameIncluded": True or False, # Whether the name is contained in the icon and there is no need to display it next to the icon. + "url": "A String", # The URL of the icon. + }, + "lines": [ # The transit lines that are served by this agency. + { # Represents a single transit line. + "backgroundColor": "A String", # The background color of the labels for this transit line in #RRGGBB hex format, e.g. #909CE1. This color can also be used for drawing shapes for this transit line. + "displayName": { # Localized variant of a text in a particular language. # The long name for this transit line (e.g. "Sunnydale local"). + "languageCode": "A String", # The text's BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. + "text": "A String", # Localized string in the language corresponding to language_code below. + }, + "icon": { # Icon for a transit line, vehicle, or agency. # Icon identifier for this particular line (e.g. subway lines in New York). + "nameIncluded": True or False, # Whether the name is contained in the icon and there is no need to display it next to the icon. + "url": "A String", # The URL of the icon. + }, + "id": "A String", # The id of the transit line that can be used to uniquely identify the line among other transit lines in the same transit station. This identifier is not guaranteed to be stable across different responses. + "shortDisplayName": { # Localized variant of a text in a particular language. # The short name for this transit line (e.g. "S2"). + "languageCode": "A String", # The text's BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. + "text": "A String", # Localized string in the language corresponding to language_code below. + }, + "textColor": "A String", # The text color of labels for this transit line in #RRGGBB hex format, e.g. #909CE1. + "url": "A String", # The URL of a webpage with details about this line. + "vehicleIcon": { # Icon for a transit line, vehicle, or agency. # Icon identifier for this particular vehicle type. + "nameIncluded": True or False, # Whether the name is contained in the icon and there is no need to display it next to the icon. + "url": "A String", # The URL of the icon. + }, + "vehicleType": "A String", # The type of vehicle using this line. + }, + ], + "url": "A String", # The URL of the agency's homepage. + }, + ], + "displayName": { # Localized variant of a text in a particular language. # The name of the station in the local language. + "languageCode": "A String", # The text's BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. + "text": "A String", # Localized string in the language corresponding to language_code below. + }, + "stops": [ # Transit stops at this station. + { # Represents a transit stop within a station. This is a specific location where passengers board and alight transit vehicles, such as a platform or bus bay. This is distinct from a `Departure`, which is an event of a vehicle leaving a stop at a specific time. + "displayName": { # Localized variant of a text in a particular language. # The name of the stop. + "languageCode": "A String", # The text's BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. + "text": "A String", # Localized string in the language corresponding to language_code below. + }, + "id": "A String", # The id of the transit stop that can be used to uniquely identify the stop among other transit stops in the same transit station. This identifier is not guaranteed to be stable across different responses. + "location": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # The stop's location. + "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. + "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. + }, + "platformCode": { # Localized variant of a text in a particular language. # The platform code represented by this stop. It can be formatted in any way. (eg: "2", "Platform 2", "2-4", or "1x"). + "languageCode": "A String", # The text's BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. + "text": "A String", # Localized string in the language corresponding to language_code below. + }, + "signageText": { # Localized variant of a text in a particular language. # The verbatim text written on the signboard for this platform, e.g. "Towards Central" or "East side & Brooklyn". When `platform_code` is absent, this field is potentially the only identifier for the platform; however, both `platform_code` and `signage_text` may be set simultaneously. + "languageCode": "A String", # The text's BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. + "text": "A String", # Localized string in the language corresponding to language_code below. + }, + "stopCode": { # Localized variant of a text in a particular language. # Human readable identifier of the stop, used by transit agencies to distinguish stops with the same name. + "languageCode": "A String", # The text's BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. + "text": "A String", # Localized string in the language corresponding to language_code below. + }, + "wheelchairAccessibleEntrance": True or False, # Wheelchair accessibility of this stop. This field indicates whether there is an accessible path from outside the station to the stop. It does not indicate whether it is possible to board a vehicle from the stop. + }, + ], + }, "types": [ # A set of type tags for this result. For example, "political" and "locality". For the complete list of possible values, see Table A and Table B at https://developers.google.com/maps/documentation/places/web-service/place-types "A String", ], @@ -1558,15 +1700,15 @@

Method Details

{ # Response proto for SearchText. "contextualContents": [ # Experimental: See https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative for more details. A list of contextual contents where each entry associates to the corresponding place in the same index in the places field. The contents that are relevant to the `text_query` in the request are preferred. If the contextual content is not available for one of the places, it will return non-contextual content. It will be empty only when the content is unavailable for this place. This list will have as many entries as the list of places if requested. - { # Experimental: See https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative for more details. Content that is contextual to the place query. - "justifications": [ # Experimental: See https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative for more details. Justifications for the place. - { # Experimental: See https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative for more details. Justifications for the place. Justifications answers the question of why a place could interest an end user. - "businessAvailabilityAttributesJustification": { # Experimental: See https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative for more details. BusinessAvailabilityAttributes justifications. This shows some attributes a business has that could interest an end user. # Experimental: See https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative for more details. + { # Content that is contextual to the place query. + "justifications": [ # Justifications for the place. + { # Justifications for the place. Justifications answers the question of why a place could interest an end user. + "businessAvailabilityAttributesJustification": { # BusinessAvailabilityAttributes justifications. This shows some attributes a business has that could interest an end user. "delivery": True or False, # If a place provides delivery. "dineIn": True or False, # If a place provides dine-in. "takeout": True or False, # If a place provides takeout. }, - "reviewJustification": { # Experimental: See https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative for more details. User review justifications. This highlights a section of the user review that would interest an end user. For instance, if the search query is "firewood pizza", the review justification highlights the text relevant to the search query. # Experimental: See https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative for more details. + "reviewJustification": { # User review justifications. This highlights a section of the user review that would interest an end user. For instance, if the search query is "firewood pizza", the review justification highlights the text relevant to the search query. "highlightedText": { # The text highlighted by the justification. This is a subset of the review itself. The exact word to highlight is marked by the HighlightedTextRange. There could be several words in the text being highlighted. "highlightedTextRanges": [ # The list of the ranges of the highlighted text. { # The range of highlighted text. @@ -2194,6 +2336,77 @@

Method Details

"id": "A String", # IANA Time Zone Database time zone. For example "America/New_York". "version": "A String", # Optional. IANA Time Zone Database version number. For example "2019a". }, + "transitStation": { # Represents transit-specific information for a place. # The transit station information for the place. + "agencies": [ # The transit agencies that serve this station. + { # Represents a transit agency. + "displayName": { # Localized variant of a text in a particular language. # Agency name (e.g. "VTA") in the requested language. + "languageCode": "A String", # The text's BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. + "text": "A String", # Localized string in the language corresponding to language_code below. + }, + "fareUrl": "A String", # The URL of the agency's fare details page. + "icon": { # Icon for a transit line, vehicle, or agency. # Icon identifier for localized branded icon of a transit system (e.g. London Underground) which should be used instead of TransitLine.vehicle_icon in the UI. + "nameIncluded": True or False, # Whether the name is contained in the icon and there is no need to display it next to the icon. + "url": "A String", # The URL of the icon. + }, + "lines": [ # The transit lines that are served by this agency. + { # Represents a single transit line. + "backgroundColor": "A String", # The background color of the labels for this transit line in #RRGGBB hex format, e.g. #909CE1. This color can also be used for drawing shapes for this transit line. + "displayName": { # Localized variant of a text in a particular language. # The long name for this transit line (e.g. "Sunnydale local"). + "languageCode": "A String", # The text's BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. + "text": "A String", # Localized string in the language corresponding to language_code below. + }, + "icon": { # Icon for a transit line, vehicle, or agency. # Icon identifier for this particular line (e.g. subway lines in New York). + "nameIncluded": True or False, # Whether the name is contained in the icon and there is no need to display it next to the icon. + "url": "A String", # The URL of the icon. + }, + "id": "A String", # The id of the transit line that can be used to uniquely identify the line among other transit lines in the same transit station. This identifier is not guaranteed to be stable across different responses. + "shortDisplayName": { # Localized variant of a text in a particular language. # The short name for this transit line (e.g. "S2"). + "languageCode": "A String", # The text's BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. + "text": "A String", # Localized string in the language corresponding to language_code below. + }, + "textColor": "A String", # The text color of labels for this transit line in #RRGGBB hex format, e.g. #909CE1. + "url": "A String", # The URL of a webpage with details about this line. + "vehicleIcon": { # Icon for a transit line, vehicle, or agency. # Icon identifier for this particular vehicle type. + "nameIncluded": True or False, # Whether the name is contained in the icon and there is no need to display it next to the icon. + "url": "A String", # The URL of the icon. + }, + "vehicleType": "A String", # The type of vehicle using this line. + }, + ], + "url": "A String", # The URL of the agency's homepage. + }, + ], + "displayName": { # Localized variant of a text in a particular language. # The name of the station in the local language. + "languageCode": "A String", # The text's BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. + "text": "A String", # Localized string in the language corresponding to language_code below. + }, + "stops": [ # Transit stops at this station. + { # Represents a transit stop within a station. This is a specific location where passengers board and alight transit vehicles, such as a platform or bus bay. This is distinct from a `Departure`, which is an event of a vehicle leaving a stop at a specific time. + "displayName": { # Localized variant of a text in a particular language. # The name of the stop. + "languageCode": "A String", # The text's BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. + "text": "A String", # Localized string in the language corresponding to language_code below. + }, + "id": "A String", # The id of the transit stop that can be used to uniquely identify the stop among other transit stops in the same transit station. This identifier is not guaranteed to be stable across different responses. + "location": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # The stop's location. + "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. + "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. + }, + "platformCode": { # Localized variant of a text in a particular language. # The platform code represented by this stop. It can be formatted in any way. (eg: "2", "Platform 2", "2-4", or "1x"). + "languageCode": "A String", # The text's BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. + "text": "A String", # Localized string in the language corresponding to language_code below. + }, + "signageText": { # Localized variant of a text in a particular language. # The verbatim text written on the signboard for this platform, e.g. "Towards Central" or "East side & Brooklyn". When `platform_code` is absent, this field is potentially the only identifier for the platform; however, both `platform_code` and `signage_text` may be set simultaneously. + "languageCode": "A String", # The text's BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. + "text": "A String", # Localized string in the language corresponding to language_code below. + }, + "stopCode": { # Localized variant of a text in a particular language. # Human readable identifier of the stop, used by transit agencies to distinguish stops with the same name. + "languageCode": "A String", # The text's BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. + "text": "A String", # Localized string in the language corresponding to language_code below. + }, + "wheelchairAccessibleEntrance": True or False, # Wheelchair accessibility of this stop. This field indicates whether there is an accessible path from outside the station to the stop. It does not indicate whether it is possible to board a vehicle from the stop. + }, + ], + }, "types": [ # A set of type tags for this result. For example, "political" and "locality". For the complete list of possible values, see Table A and Table B at https://developers.google.com/maps/documentation/places/web-service/place-types "A String", ], diff --git a/docs/dyn/run_v1.namespaces.instances.html b/docs/dyn/run_v1.namespaces.instances.html index 89a328025c..dc88c4cad1 100644 --- a/docs/dyn/run_v1.namespaces.instances.html +++ b/docs/dyn/run_v1.namespaces.instances.html @@ -334,7 +334,6 @@

Method Details

"a_key": "A String", }, "serviceAccountName": "A String", # Optional. Email address of the IAM service account associated with the Instance. The service account represents the identity of the running container, and determines what permissions the Instance has. If not provided, the Instance will use the project's default service account. - "timeout": "A String", # Optional. Duration the instance may be active before the system will shut it down. "volumes": [ # Optional. List of volumes that can be mounted by containers belonging to the Instance. { # Volume represents a named volume in a container. "configMap": { # Not supported by Cloud Run. Adapts a ConfigMap into a volume. The contents of the target ConfigMap's Data field will be presented in a volume as files using the keys in the Data field as the file names, unless the items element is populated with specific mappings of keys to paths. # Not supported in Cloud Run. @@ -629,7 +628,6 @@

Method Details

"a_key": "A String", }, "serviceAccountName": "A String", # Optional. Email address of the IAM service account associated with the Instance. The service account represents the identity of the running container, and determines what permissions the Instance has. If not provided, the Instance will use the project's default service account. - "timeout": "A String", # Optional. Duration the instance may be active before the system will shut it down. "volumes": [ # Optional. List of volumes that can be mounted by containers belonging to the Instance. { # Volume represents a named volume in a container. "configMap": { # Not supported by Cloud Run. Adapts a ConfigMap into a volume. The contents of the target ConfigMap's Data field will be presented in a volume as files using the keys in the Data field as the file names, unless the items element is populated with specific mappings of keys to paths. # Not supported in Cloud Run. @@ -975,7 +973,6 @@

Method Details

"a_key": "A String", }, "serviceAccountName": "A String", # Optional. Email address of the IAM service account associated with the Instance. The service account represents the identity of the running container, and determines what permissions the Instance has. If not provided, the Instance will use the project's default service account. - "timeout": "A String", # Optional. Duration the instance may be active before the system will shut it down. "volumes": [ # Optional. List of volumes that can be mounted by containers belonging to the Instance. { # Volume represents a named volume in a container. "configMap": { # Not supported by Cloud Run. Adapts a ConfigMap into a volume. The contents of the target ConfigMap's Data field will be presented in a volume as files using the keys in the Data field as the file names, unless the items element is populated with specific mappings of keys to paths. # Not supported in Cloud Run. @@ -1287,7 +1284,6 @@

Method Details

"a_key": "A String", }, "serviceAccountName": "A String", # Optional. Email address of the IAM service account associated with the Instance. The service account represents the identity of the running container, and determines what permissions the Instance has. If not provided, the Instance will use the project's default service account. - "timeout": "A String", # Optional. Duration the instance may be active before the system will shut it down. "volumes": [ # Optional. List of volumes that can be mounted by containers belonging to the Instance. { # Volume represents a named volume in a container. "configMap": { # Not supported by Cloud Run. Adapts a ConfigMap into a volume. The contents of the target ConfigMap's Data field will be presented in a volume as files using the keys in the Data field as the file names, unless the items element is populated with specific mappings of keys to paths. # Not supported in Cloud Run. @@ -1595,7 +1591,6 @@

Method Details

"a_key": "A String", }, "serviceAccountName": "A String", # Optional. Email address of the IAM service account associated with the Instance. The service account represents the identity of the running container, and determines what permissions the Instance has. If not provided, the Instance will use the project's default service account. - "timeout": "A String", # Optional. Duration the instance may be active before the system will shut it down. "volumes": [ # Optional. List of volumes that can be mounted by containers belonging to the Instance. { # Volume represents a named volume in a container. "configMap": { # Not supported by Cloud Run. Adapts a ConfigMap into a volume. The contents of the target ConfigMap's Data field will be presented in a volume as files using the keys in the Data field as the file names, unless the items element is populated with specific mappings of keys to paths. # Not supported in Cloud Run. @@ -1890,7 +1885,6 @@

Method Details

"a_key": "A String", }, "serviceAccountName": "A String", # Optional. Email address of the IAM service account associated with the Instance. The service account represents the identity of the running container, and determines what permissions the Instance has. If not provided, the Instance will use the project's default service account. - "timeout": "A String", # Optional. Duration the instance may be active before the system will shut it down. "volumes": [ # Optional. List of volumes that can be mounted by containers belonging to the Instance. { # Volume represents a named volume in a container. "configMap": { # Not supported by Cloud Run. Adapts a ConfigMap into a volume. The contents of the target ConfigMap's Data field will be presented in a volume as files using the keys in the Data field as the file names, unless the items element is populated with specific mappings of keys to paths. # Not supported in Cloud Run. @@ -2198,7 +2192,6 @@

Method Details

"a_key": "A String", }, "serviceAccountName": "A String", # Optional. Email address of the IAM service account associated with the Instance. The service account represents the identity of the running container, and determines what permissions the Instance has. If not provided, the Instance will use the project's default service account. - "timeout": "A String", # Optional. Duration the instance may be active before the system will shut it down. "volumes": [ # Optional. List of volumes that can be mounted by containers belonging to the Instance. { # Volume represents a named volume in a container. "configMap": { # Not supported by Cloud Run. Adapts a ConfigMap into a volume. The contents of the target ConfigMap's Data field will be presented in a volume as files using the keys in the Data field as the file names, unless the items element is populated with specific mappings of keys to paths. # Not supported in Cloud Run. @@ -2506,7 +2499,6 @@

Method Details

"a_key": "A String", }, "serviceAccountName": "A String", # Optional. Email address of the IAM service account associated with the Instance. The service account represents the identity of the running container, and determines what permissions the Instance has. If not provided, the Instance will use the project's default service account. - "timeout": "A String", # Optional. Duration the instance may be active before the system will shut it down. "volumes": [ # Optional. List of volumes that can be mounted by containers belonging to the Instance. { # Volume represents a named volume in a container. "configMap": { # Not supported by Cloud Run. Adapts a ConfigMap into a volume. The contents of the target ConfigMap's Data field will be presented in a volume as files using the keys in the Data field as the file names, unless the items element is populated with specific mappings of keys to paths. # Not supported in Cloud Run. diff --git a/docs/dyn/run_v2.projects.locations.instances.html b/docs/dyn/run_v2.projects.locations.instances.html index 497ebf7d61..4aa6ae9384 100644 --- a/docs/dyn/run_v2.projects.locations.instances.html +++ b/docs/dyn/run_v2.projects.locations.instances.html @@ -330,7 +330,6 @@

Method Details

"state": "A String", # State of the condition. "type": "A String", # type is used to communicate the status of the reconciliation process. See also: https://github.com/knative/serving/blob/main/docs/spec/errors.md#error-conditions-and-reporting Types common to all resources include: * "Ready": True when the Resource is ready. }, - "timeout": "A String", # Optional. Duration the instance may be active before the system will shut it down. "uid": "A String", # Output only. Server assigned unique identifier for the trigger. The value is a UUID4 string and guaranteed to remain unchanged until the resource is deleted. "updateTime": "A String", # Output only. The last-modified time. "urls": [ # Output only. All URLs serving traffic for this Instance. @@ -675,7 +674,6 @@

Method Details

"state": "A String", # State of the condition. "type": "A String", # type is used to communicate the status of the reconciliation process. See also: https://github.com/knative/serving/blob/main/docs/spec/errors.md#error-conditions-and-reporting Types common to all resources include: * "Ready": True when the Resource is ready. }, - "timeout": "A String", # Optional. Duration the instance may be active before the system will shut it down. "uid": "A String", # Output only. Server assigned unique identifier for the trigger. The value is a UUID4 string and guaranteed to remain unchanged until the resource is deleted. "updateTime": "A String", # Output only. The last-modified time. "urls": [ # Output only. All URLs serving traffic for this Instance. @@ -1006,7 +1004,6 @@

Method Details

"state": "A String", # State of the condition. "type": "A String", # type is used to communicate the status of the reconciliation process. See also: https://github.com/knative/serving/blob/main/docs/spec/errors.md#error-conditions-and-reporting Types common to all resources include: * "Ready": True when the Resource is ready. }, - "timeout": "A String", # Optional. Duration the instance may be active before the system will shut it down. "uid": "A String", # Output only. Server assigned unique identifier for the trigger. The value is a UUID4 string and guaranteed to remain unchanged until the resource is deleted. "updateTime": "A String", # Output only. The last-modified time. "urls": [ # Output only. All URLs serving traffic for this Instance. @@ -1296,7 +1293,6 @@

Method Details

"state": "A String", # State of the condition. "type": "A String", # type is used to communicate the status of the reconciliation process. See also: https://github.com/knative/serving/blob/main/docs/spec/errors.md#error-conditions-and-reporting Types common to all resources include: * "Ready": True when the Resource is ready. }, - "timeout": "A String", # Optional. Duration the instance may be active before the system will shut it down. "uid": "A String", # Output only. Server assigned unique identifier for the trigger. The value is a UUID4 string and guaranteed to remain unchanged until the resource is deleted. "updateTime": "A String", # Output only. The last-modified time. "urls": [ # Output only. All URLs serving traffic for this Instance. diff --git a/docs/dyn/securitycenter_v1.folders.assets.html b/docs/dyn/securitycenter_v1.folders.assets.html index a95b48b68b..c11a41b533 100644 --- a/docs/dyn/securitycenter_v1.folders.assets.html +++ b/docs/dyn/securitycenter_v1.folders.assets.html @@ -79,19 +79,19 @@

Instance Methods

Close httplib2 connections.

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

-

Filters an organization's assets and groups them by their specified properties.

+

group_next()

Retrieves the next page of results.

list(parent, compareDuration=None, fieldMask=None, filter=None, orderBy=None, pageSize=None, pageToken=None, readTime=None, x__xgafv=None)

-

Lists an organization's assets.

+

list_next()

Retrieves the next page of results.

updateSecurityMarks(name, body=None, startTime=None, updateMask=None, x__xgafv=None)

-

Updates security marks.

+

Method Details

close() @@ -100,20 +100,20 @@

Method Details

group(parent, body=None, x__xgafv=None) -
Filters an organization's assets and groups them by their specified properties.
+  
 
 Args:
-  parent: string, Required. The name of the parent to group the assets by. Its format is `organizations/[organization_id]`, `folders/[folder_id]`, or `projects/[project_id]`. (required)
+  parent: string, A parameter (required)
   body: object, The request body.
     The object takes the form of:
 
-{ # Request message for grouping by assets.
-  "compareDuration": "A String", # When compare_duration is set, the GroupResult's "state_change" property is updated to indicate whether the asset was added, removed, or remained present during the compare_duration period of time that precedes the read_time. This is the time between (read_time - compare_duration) and read_time. The state change value is derived based on the presence of the asset at the two points in time. Intermediate state changes between the two times don't affect the result. For example, the results aren't affected if the asset is removed and re-created again. Possible "state_change" values when compare_duration is specified: * "ADDED": indicates that the asset was not present at the start of compare_duration, but present at reference_time. * "REMOVED": indicates that the asset was present at the start of compare_duration, but not present at reference_time. * "ACTIVE": indicates that the asset was present at both the start and the end of the time period defined by compare_duration and reference_time. If compare_duration is not specified, then the only possible state_change is "UNUSED", which will be the state_change set for all assets present at read_time. If this field is set then `state_change` must be a specified field in `group_by`.
-  "filter": "A String", # Expression that defines the filter to apply across assets. The expression is a list of zero or more restrictions combined via logical operators `AND` and `OR`. Parentheses are supported, and `OR` has higher precedence than `AND`. Restrictions have the form ` ` and may have a `-` character in front of them to indicate negation. The fields map to those defined in the Asset resource. Examples include: * name * security_center_properties.resource_name * resource_properties.a_property * security_marks.marks.marka The supported operators are: * `=` for all value types. * `>`, `<`, `>=`, `<=` for integer values. * `:`, meaning substring matching, for strings. The supported value types are: * string literals in quotes. * integer literals without quotes. * boolean literals `true` and `false` without quotes. The following field and operator combinations are supported: * name: `=` * update_time: `=`, `>`, `<`, `>=`, `<=` Usage: This should be milliseconds since epoch or an RFC3339 string. Examples: `update_time = "2019-06-10T16:07:18-07:00"` `update_time = 1560208038000` * create_time: `=`, `>`, `<`, `>=`, `<=` Usage: This should be milliseconds since epoch or an RFC3339 string. Examples: `create_time = "2019-06-10T16:07:18-07:00"` `create_time = 1560208038000` * iam_policy.policy_blob: `=`, `:` * resource_properties: `=`, `:`, `>`, `<`, `>=`, `<=` * security_marks.marks: `=`, `:` * security_center_properties.resource_name: `=`, `:` * security_center_properties.resource_display_name: `=`, `:` * security_center_properties.resource_type: `=`, `:` * security_center_properties.resource_parent: `=`, `:` * security_center_properties.resource_parent_display_name: `=`, `:` * security_center_properties.resource_project: `=`, `:` * security_center_properties.resource_project_display_name: `=`, `:` * security_center_properties.resource_owners: `=`, `:` For example, `resource_properties.size = 100` is a valid filter string. Use a partial match on the empty string to filter based on a property existing: `resource_properties.my_property : ""` Use a negated partial match on the empty string to filter based on a property not existing: `-resource_properties.my_property : ""`
-  "groupBy": "A String", # Required. Expression that defines what assets fields to use for grouping. The string value should follow SQL syntax: comma separated list of fields. For example: "security_center_properties.resource_project,security_center_properties.project". The following fields are supported when compare_duration is not set: * security_center_properties.resource_project * security_center_properties.resource_project_display_name * security_center_properties.resource_type * security_center_properties.resource_parent * security_center_properties.resource_parent_display_name The following fields are supported when compare_duration is set: * security_center_properties.resource_type * security_center_properties.resource_project_display_name * security_center_properties.resource_parent_display_name
-  "pageSize": 42, # The maximum number of results to return in a single response. Default is 10, minimum is 1, maximum is 1000.
-  "pageToken": "A String", # The value returned by the last `GroupAssetsResponse`; indicates that this is a continuation of a prior `GroupAssets` call, and that the system should return the next page of data.
-  "readTime": "A String", # Time used as a reference point when filtering assets. The filter is limited to assets existing at the supplied time and their values are those at that specific time. Absence of this field will default to the API's version of NOW.
+{
+  "compareDuration": "A String",
+  "filter": "A String",
+  "groupBy": "A String",
+  "pageSize": 42,
+  "pageToken": "A String",
+  "readTime": "A String",
 }
 
   x__xgafv: string, V1 error format.
@@ -124,18 +124,18 @@ 

Method Details

Returns: An object of the form: - { # Response message for grouping by assets. - "groupByResults": [ # Group results. There exists an element for each existing unique combination of property/values. The element contains a count for the number of times those specific property/values appear. - { # Result containing the properties and count of a groupBy request. - "count": "A String", # Total count of resources for the given properties. - "properties": { # Properties matching the groupBy fields in the request. + { + "groupByResults": [ + { + "count": "A String", + "properties": { "a_key": "", }, }, ], - "nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no more results. - "readTime": "A String", # Time used for executing the groupBy request. - "totalSize": 42, # The total number of results matching the query. + "nextPageToken": "A String", + "readTime": "A String", + "totalSize": 42, }
@@ -155,17 +155,17 @@

Method Details

list(parent, compareDuration=None, fieldMask=None, filter=None, orderBy=None, pageSize=None, pageToken=None, readTime=None, x__xgafv=None) -
Lists an organization's assets.
+  
 
 Args:
-  parent: string, Required. The name of the parent resource that contains the assets. The value that you can specify on parent depends on the method in which you specify parent. You can specify one of the following values: `organizations/[organization_id]`, `folders/[folder_id]`, or `projects/[project_id]`. (required)
-  compareDuration: string, When compare_duration is set, the ListAssetsResult's "state_change" attribute is updated to indicate whether the asset was added, removed, or remained present during the compare_duration period of time that precedes the read_time. This is the time between (read_time - compare_duration) and read_time. The state_change value is derived based on the presence of the asset at the two points in time. Intermediate state changes between the two times don't affect the result. For example, the results aren't affected if the asset is removed and re-created again. Possible "state_change" values when compare_duration is specified: * "ADDED": indicates that the asset was not present at the start of compare_duration, but present at read_time. * "REMOVED": indicates that the asset was present at the start of compare_duration, but not present at read_time. * "ACTIVE": indicates that the asset was present at both the start and the end of the time period defined by compare_duration and read_time. If compare_duration is not specified, then the only possible state_change is "UNUSED", which will be the state_change set for all assets present at read_time.
-  fieldMask: string, A field mask to specify the ListAssetsResult fields to be listed in the response. An empty field mask will list all fields.
-  filter: string, Expression that defines the filter to apply across assets. The expression is a list of zero or more restrictions combined via logical operators `AND` and `OR`. Parentheses are supported, and `OR` has higher precedence than `AND`. Restrictions have the form ` ` and may have a `-` character in front of them to indicate negation. The fields map to those defined in the Asset resource. Examples include: * name * security_center_properties.resource_name * resource_properties.a_property * security_marks.marks.marka The supported operators are: * `=` for all value types. * `>`, `<`, `>=`, `<=` for integer values. * `:`, meaning substring matching, for strings. The supported value types are: * string literals in quotes. * integer literals without quotes. * boolean literals `true` and `false` without quotes. The following are the allowed field and operator combinations: * name: `=` * update_time: `=`, `>`, `<`, `>=`, `<=` Usage: This should be milliseconds since epoch or an RFC3339 string. Examples: `update_time = "2019-06-10T16:07:18-07:00"` `update_time = 1560208038000` * create_time: `=`, `>`, `<`, `>=`, `<=` Usage: This should be milliseconds since epoch or an RFC3339 string. Examples: `create_time = "2019-06-10T16:07:18-07:00"` `create_time = 1560208038000` * iam_policy.policy_blob: `=`, `:` * resource_properties: `=`, `:`, `>`, `<`, `>=`, `<=` * security_marks.marks: `=`, `:` * security_center_properties.resource_name: `=`, `:` * security_center_properties.resource_display_name: `=`, `:` * security_center_properties.resource_type: `=`, `:` * security_center_properties.resource_parent: `=`, `:` * security_center_properties.resource_parent_display_name: `=`, `:` * security_center_properties.resource_project: `=`, `:` * security_center_properties.resource_project_display_name: `=`, `:` * security_center_properties.resource_owners: `=`, `:` For example, `resource_properties.size = 100` is a valid filter string. Use a partial match on the empty string to filter based on a property existing: `resource_properties.my_property : ""` Use a negated partial match on the empty string to filter based on a property not existing: `-resource_properties.my_property : ""`
-  orderBy: string, Expression that defines what fields and order to use for sorting. The string value should follow SQL syntax: comma separated list of fields. For example: "name,resource_properties.a_property". The default sorting order is ascending. To specify descending order for a field, a suffix " desc" should be appended to the field name. For example: "name desc,resource_properties.a_property". Redundant space characters in the syntax are insignificant. "name desc,resource_properties.a_property" and " name desc , resource_properties.a_property " are equivalent. The following fields are supported: name update_time resource_properties security_marks.marks security_center_properties.resource_name security_center_properties.resource_display_name security_center_properties.resource_parent security_center_properties.resource_parent_display_name security_center_properties.resource_project security_center_properties.resource_project_display_name security_center_properties.resource_type
-  pageSize: integer, The maximum number of results to return in a single response. Default is 10, minimum is 1, maximum is 1000.
-  pageToken: string, The value returned by the last `ListAssetsResponse`; indicates that this is a continuation of a prior `ListAssets` call, and that the system should return the next page of data.
-  readTime: string, Time used as a reference point when filtering assets. The filter is limited to assets existing at the supplied time and their values are those at that specific time. Absence of this field will default to the API's version of NOW.
+  parent: string, A parameter (required)
+  compareDuration: string, A parameter
+  fieldMask: string, A parameter
+  filter: string, A parameter
+  orderBy: string, A parameter
+  pageSize: integer, A parameter
+  pageToken: string, A parameter
+  readTime: string, A parameter
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -174,52 +174,52 @@ 

Method Details

Returns: An object of the form: - { # Response message for listing assets. - "listAssetsResults": [ # Assets matching the list request. - { # Result containing the Asset and its State. - "asset": { # Security Command Center representation of a Google Cloud resource. The Asset is a Security Command Center resource that captures information about a single Google Cloud resource. All modifications to an Asset are only within the context of Security Command Center and don't affect the referenced Google Cloud resource. # Asset matching the search request. - "canonicalName": "A String", # The canonical name of the resource. It's either "organizations/{organization_id}/assets/{asset_id}", "folders/{folder_id}/assets/{asset_id}" or "projects/{project_number}/assets/{asset_id}", depending on the closest CRM ancestor of the resource. - "createTime": "A String", # The time at which the asset was created in Security Command Center. - "iamPolicy": { # Cloud IAM Policy information associated with the Google Cloud resource described by the Security Command Center asset. This information is managed and defined by the Google Cloud resource and cannot be modified by the user. # Cloud IAM Policy information associated with the Google Cloud resource described by the Security Command Center asset. This information is managed and defined by the Google Cloud resource and cannot be modified by the user. - "policyBlob": "A String", # The JSON representation of the Policy associated with the asset. See https://cloud.google.com/iam/reference/rest/v1/Policy for format details. + { + "listAssetsResults": [ + { + "asset": { + "canonicalName": "A String", + "createTime": "A String", + "iamPolicy": { + "policyBlob": "A String", }, - "name": "A String", # The relative resource name of this asset. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Example: "organizations/{organization_id}/assets/{asset_id}". - "resourceProperties": { # Resource managed properties. These properties are managed and defined by the Google Cloud resource and cannot be modified by the user. + "name": "A String", + "resourceProperties": { "a_key": "", }, - "securityCenterProperties": { # Security Command Center managed properties. These properties are managed by Security Command Center and cannot be modified by the user. # Security Command Center managed properties. These properties are managed by Security Command Center and cannot be modified by the user. - "folders": [ # Contains a Folder message for each folder in the assets ancestry. The first folder is the deepest nested folder, and the last folder is the folder directly under the Organization. - { # Message that contains the resource name and display name of a folder resource. - "resourceFolder": "A String", # Full resource name of this folder. See: https://cloud.google.com/apis/design/resource_names#full_resource_name - "resourceFolderDisplayName": "A String", # The user defined display name for this folder. + "securityCenterProperties": { + "folders": [ + { + "resourceFolder": "A String", + "resourceFolderDisplayName": "A String", }, ], - "resourceDisplayName": "A String", # The user defined display name for this resource. - "resourceName": "A String", # The full resource name of the Google Cloud resource this asset represents. This field is immutable after create time. See: https://cloud.google.com/apis/design/resource_names#full_resource_name - "resourceOwners": [ # Owners of the Google Cloud resource. + "resourceDisplayName": "A String", + "resourceName": "A String", + "resourceOwners": [ "A String", ], - "resourceParent": "A String", # The full resource name of the immediate parent of the resource. See: https://cloud.google.com/apis/design/resource_names#full_resource_name - "resourceParentDisplayName": "A String", # The user defined display name for the parent of this resource. - "resourceProject": "A String", # The full resource name of the project the resource belongs to. See: https://cloud.google.com/apis/design/resource_names#full_resource_name - "resourceProjectDisplayName": "A String", # The user defined display name for the project of this resource. - "resourceType": "A String", # The type of the Google Cloud resource. Examples include: APPLICATION, PROJECT, and ORGANIZATION. This is a case insensitive field defined by Security Command Center and/or the producer of the resource and is immutable after create time. + "resourceParent": "A String", + "resourceParentDisplayName": "A String", + "resourceProject": "A String", + "resourceProjectDisplayName": "A String", + "resourceType": "A String", }, - "securityMarks": { # User specified security marks that are attached to the parent Security Command Center resource. Security marks are scoped within a Security Command Center organization -- they can be modified and viewed by all users who have proper permissions on the organization. # User specified security marks. These marks are entirely managed by the user and come from the SecurityMarks resource that belongs to the asset. - "canonicalName": "A String", # The canonical name of the marks. Examples: "organizations/{organization_id}/assets/{asset_id}/securityMarks" "folders/{folder_id}/assets/{asset_id}/securityMarks" "projects/{project_number}/assets/{asset_id}/securityMarks" "organizations/{organization_id}/sources/{source_id}/findings/{finding_id}/securityMarks" "folders/{folder_id}/sources/{source_id}/findings/{finding_id}/securityMarks" "projects/{project_number}/sources/{source_id}/findings/{finding_id}/securityMarks" - "marks": { # Mutable user specified security marks belonging to the parent resource. Constraints are as follows: * Keys and values are treated as case insensitive * Keys must be between 1 - 256 characters (inclusive) * Keys must be letters, numbers, underscores, or dashes * Values have leading and trailing whitespace trimmed, remaining characters must be between 1 - 4096 characters (inclusive) + "securityMarks": { + "canonicalName": "A String", + "marks": { "a_key": "A String", }, - "name": "A String", # The relative resource name of the SecurityMarks. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Examples: "organizations/{organization_id}/assets/{asset_id}/securityMarks" "organizations/{organization_id}/sources/{source_id}/findings/{finding_id}/securityMarks". + "name": "A String", }, - "updateTime": "A String", # The time at which the asset was last updated or added in Cloud SCC. + "updateTime": "A String", }, - "stateChange": "A String", # State change of the asset between the points in time. + "stateChange": "A String", }, ], - "nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no more results. - "readTime": "A String", # Time used for executing the list request. - "totalSize": 42, # The total number of assets matching the query. + "nextPageToken": "A String", + "readTime": "A String", + "totalSize": 42, }
@@ -239,23 +239,23 @@

Method Details

updateSecurityMarks(name, body=None, startTime=None, updateMask=None, x__xgafv=None) -
Updates security marks.
+  
 
 Args:
-  name: string, The relative resource name of the SecurityMarks. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Examples: "organizations/{organization_id}/assets/{asset_id}/securityMarks" "organizations/{organization_id}/sources/{source_id}/findings/{finding_id}/securityMarks". (required)
+  name: string, A parameter (required)
   body: object, The request body.
     The object takes the form of:
 
-{ # User specified security marks that are attached to the parent Security Command Center resource. Security marks are scoped within a Security Command Center organization -- they can be modified and viewed by all users who have proper permissions on the organization.
-  "canonicalName": "A String", # The canonical name of the marks. Examples: "organizations/{organization_id}/assets/{asset_id}/securityMarks" "folders/{folder_id}/assets/{asset_id}/securityMarks" "projects/{project_number}/assets/{asset_id}/securityMarks" "organizations/{organization_id}/sources/{source_id}/findings/{finding_id}/securityMarks" "folders/{folder_id}/sources/{source_id}/findings/{finding_id}/securityMarks" "projects/{project_number}/sources/{source_id}/findings/{finding_id}/securityMarks"
-  "marks": { # Mutable user specified security marks belonging to the parent resource. Constraints are as follows: * Keys and values are treated as case insensitive * Keys must be between 1 - 256 characters (inclusive) * Keys must be letters, numbers, underscores, or dashes * Values have leading and trailing whitespace trimmed, remaining characters must be between 1 - 4096 characters (inclusive)
+{
+  "canonicalName": "A String",
+  "marks": {
     "a_key": "A String",
   },
-  "name": "A String", # The relative resource name of the SecurityMarks. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Examples: "organizations/{organization_id}/assets/{asset_id}/securityMarks" "organizations/{organization_id}/sources/{source_id}/findings/{finding_id}/securityMarks".
+  "name": "A String",
 }
 
-  startTime: string, The time at which the updated SecurityMarks take effect. If not set uses current server time. Updates will be applied to the SecurityMarks that are active immediately preceding this time. Must be earlier or equal to the server time.
-  updateMask: string, The FieldMask to use when updating the security marks resource. The field mask must not contain duplicate fields. If empty or set to "marks", all marks will be replaced. Individual marks can be updated using "marks.".
+  startTime: string, A parameter
+  updateMask: string, A parameter
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -264,12 +264,12 @@ 

Method Details

Returns: An object of the form: - { # User specified security marks that are attached to the parent Security Command Center resource. Security marks are scoped within a Security Command Center organization -- they can be modified and viewed by all users who have proper permissions on the organization. - "canonicalName": "A String", # The canonical name of the marks. Examples: "organizations/{organization_id}/assets/{asset_id}/securityMarks" "folders/{folder_id}/assets/{asset_id}/securityMarks" "projects/{project_number}/assets/{asset_id}/securityMarks" "organizations/{organization_id}/sources/{source_id}/findings/{finding_id}/securityMarks" "folders/{folder_id}/sources/{source_id}/findings/{finding_id}/securityMarks" "projects/{project_number}/sources/{source_id}/findings/{finding_id}/securityMarks" - "marks": { # Mutable user specified security marks belonging to the parent resource. Constraints are as follows: * Keys and values are treated as case insensitive * Keys must be between 1 - 256 characters (inclusive) * Keys must be letters, numbers, underscores, or dashes * Values have leading and trailing whitespace trimmed, remaining characters must be between 1 - 4096 characters (inclusive) + { + "canonicalName": "A String", + "marks": { "a_key": "A String", }, - "name": "A String", # The relative resource name of the SecurityMarks. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Examples: "organizations/{organization_id}/assets/{asset_id}/securityMarks" "organizations/{organization_id}/sources/{source_id}/findings/{finding_id}/securityMarks". + "name": "A String", }
diff --git a/docs/dyn/securitycenter_v1.folders.bigQueryExports.html b/docs/dyn/securitycenter_v1.folders.bigQueryExports.html index 6ecb406aed..44bf4262a4 100644 --- a/docs/dyn/securitycenter_v1.folders.bigQueryExports.html +++ b/docs/dyn/securitycenter_v1.folders.bigQueryExports.html @@ -79,22 +79,22 @@

Instance Methods

Close httplib2 connections.

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

-

Creates a BigQuery export.

+

delete(name, x__xgafv=None)

-

Deletes an existing BigQuery export.

+

get(name, x__xgafv=None)

-

Gets a BigQuery export.

+

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

-

Lists BigQuery exports. Note that when requesting BigQuery exports at a given level all exports under that level are also returned e.g. if requesting BigQuery exports under a folder, then all BigQuery exports immediately under the folder plus the ones created under the projects within the folder are returned.

+

list_next()

Retrieves the next page of results.

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

-

Updates a BigQuery export.

+

Method Details

close() @@ -103,25 +103,25 @@

Method Details

create(parent, bigQueryExportId=None, body=None, x__xgafv=None) -
Creates a BigQuery export.
+  
 
 Args:
-  parent: string, Required. The name of the parent resource of the new BigQuery export. Its format is `organizations/[organization_id]`, `folders/[folder_id]`, or `projects/[project_id]`. (required)
+  parent: string, A parameter (required)
   body: object, The request body.
     The object takes the form of:
 
-{ # Configures how to deliver Findings to BigQuery Instance.
-  "createTime": "A String", # Output only. The time at which the BigQuery export was created. This field is set by the server and will be ignored if provided on export on creation.
-  "dataset": "A String", # The dataset to write findings' updates to. Its format is "projects/[project_id]/datasets/[bigquery_dataset_id]". BigQuery Dataset unique ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_).
-  "description": "A String", # The description of the export (max of 1024 characters).
-  "filter": "A String", # Expression that defines the filter to apply across create/update events of findings. The expression is a list of zero or more restrictions combined via logical operators `AND` and `OR`. Parentheses are supported, and `OR` has higher precedence than `AND`. Restrictions have the form ` ` and may have a `-` character in front of them to indicate negation. The fields map to those defined in the corresponding resource. The supported operators are: * `=` for all value types. * `>`, `<`, `>=`, `<=` for integer values. * `:`, meaning substring matching, for strings. The supported value types are: * string literals in quotes. * integer literals without quotes. * boolean literals `true` and `false` without quotes.
-  "mostRecentEditor": "A String", # Output only. Email address of the user who last edited the BigQuery export. This field is set by the server and will be ignored if provided on export creation or update.
-  "name": "A String", # The relative resource name of this export. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name. Example format: "organizations/{organization_id}/bigQueryExports/{export_id}" Example format: "folders/{folder_id}/bigQueryExports/{export_id}" Example format: "projects/{project_id}/bigQueryExports/{export_id}" This field is provided in responses, and is ignored when provided in create requests.
-  "principal": "A String", # Output only. The service account that needs permission to create table and upload data to the BigQuery dataset.
-  "updateTime": "A String", # Output only. The most recent time at which the BigQuery export was updated. This field is set by the server and will be ignored if provided on export creation or update.
+{
+  "createTime": "A String",
+  "dataset": "A String",
+  "description": "A String",
+  "filter": "A String",
+  "mostRecentEditor": "A String",
+  "name": "A String",
+  "principal": "A String",
+  "updateTime": "A String",
 }
 
-  bigQueryExportId: string, Required. Unique identifier provided by the client within the parent scope. It must consist of only lowercase letters, numbers, and hyphens, must start with a letter, must end with either a letter or a number, and must be 63 characters or less.
+  bigQueryExportId: string, A parameter
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -130,24 +130,24 @@ 

Method Details

Returns: An object of the form: - { # Configures how to deliver Findings to BigQuery Instance. - "createTime": "A String", # Output only. The time at which the BigQuery export was created. This field is set by the server and will be ignored if provided on export on creation. - "dataset": "A String", # The dataset to write findings' updates to. Its format is "projects/[project_id]/datasets/[bigquery_dataset_id]". BigQuery Dataset unique ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). - "description": "A String", # The description of the export (max of 1024 characters). - "filter": "A String", # Expression that defines the filter to apply across create/update events of findings. The expression is a list of zero or more restrictions combined via logical operators `AND` and `OR`. Parentheses are supported, and `OR` has higher precedence than `AND`. Restrictions have the form ` ` and may have a `-` character in front of them to indicate negation. The fields map to those defined in the corresponding resource. The supported operators are: * `=` for all value types. * `>`, `<`, `>=`, `<=` for integer values. * `:`, meaning substring matching, for strings. The supported value types are: * string literals in quotes. * integer literals without quotes. * boolean literals `true` and `false` without quotes. - "mostRecentEditor": "A String", # Output only. Email address of the user who last edited the BigQuery export. This field is set by the server and will be ignored if provided on export creation or update. - "name": "A String", # The relative resource name of this export. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name. Example format: "organizations/{organization_id}/bigQueryExports/{export_id}" Example format: "folders/{folder_id}/bigQueryExports/{export_id}" Example format: "projects/{project_id}/bigQueryExports/{export_id}" This field is provided in responses, and is ignored when provided in create requests. - "principal": "A String", # Output only. The service account that needs permission to create table and upload data to the BigQuery dataset. - "updateTime": "A String", # Output only. The most recent time at which the BigQuery export was updated. This field is set by the server and will be ignored if provided on export creation or update. + { + "createTime": "A String", + "dataset": "A String", + "description": "A String", + "filter": "A String", + "mostRecentEditor": "A String", + "name": "A String", + "principal": "A String", + "updateTime": "A String", }
delete(name, x__xgafv=None) -
Deletes an existing BigQuery export.
+  
 
 Args:
-  name: string, Required. The name of the BigQuery export to delete. Its format is `organizations/{organization}/bigQueryExports/{export_id}`, `folders/{folder}/bigQueryExports/{export_id}`, or `projects/{project}/bigQueryExports/{export_id}` (required)
+  name: string, A parameter (required)
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -156,16 +156,16 @@ 

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); } + { }
get(name, x__xgafv=None) -
Gets a BigQuery export.
+  
 
 Args:
-  name: string, Required. Name of the BigQuery export to retrieve. Its format is `organizations/{organization}/bigQueryExports/{export_id}`, `folders/{folder}/bigQueryExports/{export_id}`, or `projects/{project}/bigQueryExports/{export_id}` (required)
+  name: string, A parameter (required)
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -174,26 +174,26 @@ 

Method Details

Returns: An object of the form: - { # Configures how to deliver Findings to BigQuery Instance. - "createTime": "A String", # Output only. The time at which the BigQuery export was created. This field is set by the server and will be ignored if provided on export on creation. - "dataset": "A String", # The dataset to write findings' updates to. Its format is "projects/[project_id]/datasets/[bigquery_dataset_id]". BigQuery Dataset unique ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). - "description": "A String", # The description of the export (max of 1024 characters). - "filter": "A String", # Expression that defines the filter to apply across create/update events of findings. The expression is a list of zero or more restrictions combined via logical operators `AND` and `OR`. Parentheses are supported, and `OR` has higher precedence than `AND`. Restrictions have the form ` ` and may have a `-` character in front of them to indicate negation. The fields map to those defined in the corresponding resource. The supported operators are: * `=` for all value types. * `>`, `<`, `>=`, `<=` for integer values. * `:`, meaning substring matching, for strings. The supported value types are: * string literals in quotes. * integer literals without quotes. * boolean literals `true` and `false` without quotes. - "mostRecentEditor": "A String", # Output only. Email address of the user who last edited the BigQuery export. This field is set by the server and will be ignored if provided on export creation or update. - "name": "A String", # The relative resource name of this export. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name. Example format: "organizations/{organization_id}/bigQueryExports/{export_id}" Example format: "folders/{folder_id}/bigQueryExports/{export_id}" Example format: "projects/{project_id}/bigQueryExports/{export_id}" This field is provided in responses, and is ignored when provided in create requests. - "principal": "A String", # Output only. The service account that needs permission to create table and upload data to the BigQuery dataset. - "updateTime": "A String", # Output only. The most recent time at which the BigQuery export was updated. This field is set by the server and will be ignored if provided on export creation or update. + { + "createTime": "A String", + "dataset": "A String", + "description": "A String", + "filter": "A String", + "mostRecentEditor": "A String", + "name": "A String", + "principal": "A String", + "updateTime": "A String", }
list(parent, pageSize=None, pageToken=None, x__xgafv=None) -
Lists BigQuery exports. Note that when requesting BigQuery exports at a given level all exports under that level are also returned e.g. if requesting BigQuery exports under a folder, then all BigQuery exports immediately under the folder plus the ones created under the projects within the folder are returned.
+  
 
 Args:
-  parent: string, Required. The parent, which owns the collection of BigQuery exports. Its format is `organizations/[organization_id]`, `folders/[folder_id]`, `projects/[project_id]`. (required)
-  pageSize: integer, The maximum number of configs to return. The service may return fewer than this value. If unspecified, at most 10 configs will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
-  pageToken: string, A page token, received from a previous `ListBigQueryExports` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListBigQueryExports` must match the call that provided the page token.
+  parent: string, A parameter (required)
+  pageSize: integer, A parameter
+  pageToken: string, A parameter
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -202,20 +202,20 @@ 

Method Details

Returns: An object of the form: - { # Response message for listing BigQuery exports. - "bigQueryExports": [ # The BigQuery exports from the specified parent. - { # Configures how to deliver Findings to BigQuery Instance. - "createTime": "A String", # Output only. The time at which the BigQuery export was created. This field is set by the server and will be ignored if provided on export on creation. - "dataset": "A String", # The dataset to write findings' updates to. Its format is "projects/[project_id]/datasets/[bigquery_dataset_id]". BigQuery Dataset unique ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). - "description": "A String", # The description of the export (max of 1024 characters). - "filter": "A String", # Expression that defines the filter to apply across create/update events of findings. The expression is a list of zero or more restrictions combined via logical operators `AND` and `OR`. Parentheses are supported, and `OR` has higher precedence than `AND`. Restrictions have the form ` ` and may have a `-` character in front of them to indicate negation. The fields map to those defined in the corresponding resource. The supported operators are: * `=` for all value types. * `>`, `<`, `>=`, `<=` for integer values. * `:`, meaning substring matching, for strings. The supported value types are: * string literals in quotes. * integer literals without quotes. * boolean literals `true` and `false` without quotes. - "mostRecentEditor": "A String", # Output only. Email address of the user who last edited the BigQuery export. This field is set by the server and will be ignored if provided on export creation or update. - "name": "A String", # The relative resource name of this export. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name. Example format: "organizations/{organization_id}/bigQueryExports/{export_id}" Example format: "folders/{folder_id}/bigQueryExports/{export_id}" Example format: "projects/{project_id}/bigQueryExports/{export_id}" This field is provided in responses, and is ignored when provided in create requests. - "principal": "A String", # Output only. The service account that needs permission to create table and upload data to the BigQuery dataset. - "updateTime": "A String", # Output only. The most recent time at which the BigQuery export was updated. This field is set by the server and will be ignored if provided on export creation or update. + { + "bigQueryExports": [ + { + "createTime": "A String", + "dataset": "A String", + "description": "A String", + "filter": "A String", + "mostRecentEditor": "A String", + "name": "A String", + "principal": "A String", + "updateTime": "A String", }, ], - "nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. + "nextPageToken": "A String", }
@@ -235,25 +235,25 @@

Method Details

patch(name, body=None, updateMask=None, x__xgafv=None) -
Updates a BigQuery export.
+  
 
 Args:
-  name: string, The relative resource name of this export. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name. Example format: "organizations/{organization_id}/bigQueryExports/{export_id}" Example format: "folders/{folder_id}/bigQueryExports/{export_id}" Example format: "projects/{project_id}/bigQueryExports/{export_id}" This field is provided in responses, and is ignored when provided in create requests. (required)
+  name: string, A parameter (required)
   body: object, The request body.
     The object takes the form of:
 
-{ # Configures how to deliver Findings to BigQuery Instance.
-  "createTime": "A String", # Output only. The time at which the BigQuery export was created. This field is set by the server and will be ignored if provided on export on creation.
-  "dataset": "A String", # The dataset to write findings' updates to. Its format is "projects/[project_id]/datasets/[bigquery_dataset_id]". BigQuery Dataset unique ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_).
-  "description": "A String", # The description of the export (max of 1024 characters).
-  "filter": "A String", # Expression that defines the filter to apply across create/update events of findings. The expression is a list of zero or more restrictions combined via logical operators `AND` and `OR`. Parentheses are supported, and `OR` has higher precedence than `AND`. Restrictions have the form ` ` and may have a `-` character in front of them to indicate negation. The fields map to those defined in the corresponding resource. The supported operators are: * `=` for all value types. * `>`, `<`, `>=`, `<=` for integer values. * `:`, meaning substring matching, for strings. The supported value types are: * string literals in quotes. * integer literals without quotes. * boolean literals `true` and `false` without quotes.
-  "mostRecentEditor": "A String", # Output only. Email address of the user who last edited the BigQuery export. This field is set by the server and will be ignored if provided on export creation or update.
-  "name": "A String", # The relative resource name of this export. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name. Example format: "organizations/{organization_id}/bigQueryExports/{export_id}" Example format: "folders/{folder_id}/bigQueryExports/{export_id}" Example format: "projects/{project_id}/bigQueryExports/{export_id}" This field is provided in responses, and is ignored when provided in create requests.
-  "principal": "A String", # Output only. The service account that needs permission to create table and upload data to the BigQuery dataset.
-  "updateTime": "A String", # Output only. The most recent time at which the BigQuery export was updated. This field is set by the server and will be ignored if provided on export creation or update.
+{
+  "createTime": "A String",
+  "dataset": "A String",
+  "description": "A String",
+  "filter": "A String",
+  "mostRecentEditor": "A String",
+  "name": "A String",
+  "principal": "A String",
+  "updateTime": "A String",
 }
 
-  updateMask: string, The list of fields to be updated. If empty all mutable fields will be updated.
+  updateMask: string, A parameter
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -262,15 +262,15 @@ 

Method Details

Returns: An object of the form: - { # Configures how to deliver Findings to BigQuery Instance. - "createTime": "A String", # Output only. The time at which the BigQuery export was created. This field is set by the server and will be ignored if provided on export on creation. - "dataset": "A String", # The dataset to write findings' updates to. Its format is "projects/[project_id]/datasets/[bigquery_dataset_id]". BigQuery Dataset unique ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). - "description": "A String", # The description of the export (max of 1024 characters). - "filter": "A String", # Expression that defines the filter to apply across create/update events of findings. The expression is a list of zero or more restrictions combined via logical operators `AND` and `OR`. Parentheses are supported, and `OR` has higher precedence than `AND`. Restrictions have the form ` ` and may have a `-` character in front of them to indicate negation. The fields map to those defined in the corresponding resource. The supported operators are: * `=` for all value types. * `>`, `<`, `>=`, `<=` for integer values. * `:`, meaning substring matching, for strings. The supported value types are: * string literals in quotes. * integer literals without quotes. * boolean literals `true` and `false` without quotes. - "mostRecentEditor": "A String", # Output only. Email address of the user who last edited the BigQuery export. This field is set by the server and will be ignored if provided on export creation or update. - "name": "A String", # The relative resource name of this export. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name. Example format: "organizations/{organization_id}/bigQueryExports/{export_id}" Example format: "folders/{folder_id}/bigQueryExports/{export_id}" Example format: "projects/{project_id}/bigQueryExports/{export_id}" This field is provided in responses, and is ignored when provided in create requests. - "principal": "A String", # Output only. The service account that needs permission to create table and upload data to the BigQuery dataset. - "updateTime": "A String", # Output only. The most recent time at which the BigQuery export was updated. This field is set by the server and will be ignored if provided on export creation or update. + { + "createTime": "A String", + "dataset": "A String", + "description": "A String", + "filter": "A String", + "mostRecentEditor": "A String", + "name": "A String", + "principal": "A String", + "updateTime": "A String", }
diff --git a/docs/dyn/securitycenter_v1.folders.eventThreatDetectionSettings.customModules.html b/docs/dyn/securitycenter_v1.folders.eventThreatDetectionSettings.customModules.html index 5d2f600c34..89737e6c7a 100644 --- a/docs/dyn/securitycenter_v1.folders.eventThreatDetectionSettings.customModules.html +++ b/docs/dyn/securitycenter_v1.folders.eventThreatDetectionSettings.customModules.html @@ -79,19 +79,19 @@

Instance Methods

Close httplib2 connections.

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

-

Creates a resident Event Threat Detection custom module at the scope of the given Resource Manager parent, and also creates inherited custom modules for all descendants of the given parent. These modules are enabled by default.

+

delete(name, x__xgafv=None)

-

Deletes the specified Event Threat Detection custom module and all of its descendants in the Resource Manager hierarchy. This method is only supported for resident custom modules.

+

get(name, x__xgafv=None)

-

Gets an Event Threat Detection custom module.

+

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

-

Lists all Event Threat Detection custom modules for the given Resource Manager parent. This includes resident modules defined at the scope of the parent along with modules inherited from ancestors.

+

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

-

Lists all resident Event Threat Detection custom modules under the given Resource Manager parent and its descendants.

+

listDescendant_next()

Retrieves the next page of results.

@@ -100,7 +100,7 @@

Instance Methods

Retrieves the next page of results.

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

-

Updates the Event Threat Detection custom module with the given name based on the given update mask. Updating the enablement state is supported for both resident and inherited modules (though resident modules cannot have an enablement state of "inherited"). Updating the display name or configuration of a module is supported for resident modules only. The type of a module cannot be changed.

+

Method Details

close() @@ -109,26 +109,26 @@

Method Details

create(parent, body=None, x__xgafv=None) -
Creates a resident Event Threat Detection custom module at the scope of the given Resource Manager parent, and also creates inherited custom modules for all descendants of the given parent. These modules are enabled by default.
+  
 
 Args:
-  parent: string, Required. The new custom module's parent. Its format is: * `organizations/{organization}/eventThreatDetectionSettings`. * `folders/{folder}/eventThreatDetectionSettings`. * `projects/{project}/eventThreatDetectionSettings`. (required)
+  parent: string, A parameter (required)
   body: object, The request body.
     The object takes the form of:
 
-{ # Represents an instance of an Event Threat Detection custom module, including its full module name, display name, enablement state, and last updated time. You can create a custom module at the organization, folder, or project level. Custom modules that you create at the organization or folder level are inherited by child folders and projects.
-  "ancestorModule": "A String", # Output only. The closest ancestor module that this module inherits the enablement state from. The format is the same as the EventThreatDetectionCustomModule resource name.
-  "cloudProvider": "A String", # The cloud provider of the custom module.
-  "config": { # Config for the module. For the resident module, its config value is defined at this level. For the inherited module, its config value is inherited from the ancestor module.
+{
+  "ancestorModule": "A String",
+  "cloudProvider": "A String",
+  "config": {
     "a_key": "", # Properties of the object.
   },
-  "description": "A String", # The description for the module.
-  "displayName": "A String", # The human readable name to be displayed for the module.
-  "enablementState": "A String", # The state of enablement for the module at the given level of the hierarchy.
-  "lastEditor": "A String", # Output only. The editor the module was last updated by.
-  "name": "A String", # Immutable. The resource name of the Event Threat Detection custom module. Its format is: * `organizations/{organization}/eventThreatDetectionSettings/customModules/{module}`. * `folders/{folder}/eventThreatDetectionSettings/customModules/{module}`. * `projects/{project}/eventThreatDetectionSettings/customModules/{module}`.
-  "type": "A String", # Type for the module. e.g. CONFIGURABLE_BAD_IP.
-  "updateTime": "A String", # Output only. The time the module was last updated.
+  "description": "A String",
+  "displayName": "A String",
+  "enablementState": "A String",
+  "lastEditor": "A String",
+  "name": "A String",
+  "type": "A String",
+  "updateTime": "A String",
 }
 
   x__xgafv: string, V1 error format.
@@ -139,28 +139,28 @@ 

Method Details

Returns: An object of the form: - { # Represents an instance of an Event Threat Detection custom module, including its full module name, display name, enablement state, and last updated time. You can create a custom module at the organization, folder, or project level. Custom modules that you create at the organization or folder level are inherited by child folders and projects. - "ancestorModule": "A String", # Output only. The closest ancestor module that this module inherits the enablement state from. The format is the same as the EventThreatDetectionCustomModule resource name. - "cloudProvider": "A String", # The cloud provider of the custom module. - "config": { # Config for the module. For the resident module, its config value is defined at this level. For the inherited module, its config value is inherited from the ancestor module. + { + "ancestorModule": "A String", + "cloudProvider": "A String", + "config": { "a_key": "", # Properties of the object. }, - "description": "A String", # The description for the module. - "displayName": "A String", # The human readable name to be displayed for the module. - "enablementState": "A String", # The state of enablement for the module at the given level of the hierarchy. - "lastEditor": "A String", # Output only. The editor the module was last updated by. - "name": "A String", # Immutable. The resource name of the Event Threat Detection custom module. Its format is: * `organizations/{organization}/eventThreatDetectionSettings/customModules/{module}`. * `folders/{folder}/eventThreatDetectionSettings/customModules/{module}`. * `projects/{project}/eventThreatDetectionSettings/customModules/{module}`. - "type": "A String", # Type for the module. e.g. CONFIGURABLE_BAD_IP. - "updateTime": "A String", # Output only. The time the module was last updated. + "description": "A String", + "displayName": "A String", + "enablementState": "A String", + "lastEditor": "A String", + "name": "A String", + "type": "A String", + "updateTime": "A String", }
delete(name, x__xgafv=None) -
Deletes the specified Event Threat Detection custom module and all of its descendants in the Resource Manager hierarchy. This method is only supported for resident custom modules.
+  
 
 Args:
-  name: string, Required. Name of the custom module to delete. Its format is: * `organizations/{organization}/eventThreatDetectionSettings/customModules/{module}`. * `folders/{folder}/eventThreatDetectionSettings/customModules/{module}`. * `projects/{project}/eventThreatDetectionSettings/customModules/{module}`. (required)
+  name: string, A parameter (required)
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -169,16 +169,16 @@ 

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); } + { }
get(name, x__xgafv=None) -
Gets an Event Threat Detection custom module.
+  
 
 Args:
-  name: string, Required. Name of the custom module to get. Its format is: * `organizations/{organization}/eventThreatDetectionSettings/customModules/{module}`. * `folders/{folder}/eventThreatDetectionSettings/customModules/{module}`. * `projects/{project}/eventThreatDetectionSettings/customModules/{module}`. (required)
+  name: string, A parameter (required)
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -187,30 +187,30 @@ 

Method Details

Returns: An object of the form: - { # Represents an instance of an Event Threat Detection custom module, including its full module name, display name, enablement state, and last updated time. You can create a custom module at the organization, folder, or project level. Custom modules that you create at the organization or folder level are inherited by child folders and projects. - "ancestorModule": "A String", # Output only. The closest ancestor module that this module inherits the enablement state from. The format is the same as the EventThreatDetectionCustomModule resource name. - "cloudProvider": "A String", # The cloud provider of the custom module. - "config": { # Config for the module. For the resident module, its config value is defined at this level. For the inherited module, its config value is inherited from the ancestor module. + { + "ancestorModule": "A String", + "cloudProvider": "A String", + "config": { "a_key": "", # Properties of the object. }, - "description": "A String", # The description for the module. - "displayName": "A String", # The human readable name to be displayed for the module. - "enablementState": "A String", # The state of enablement for the module at the given level of the hierarchy. - "lastEditor": "A String", # Output only. The editor the module was last updated by. - "name": "A String", # Immutable. The resource name of the Event Threat Detection custom module. Its format is: * `organizations/{organization}/eventThreatDetectionSettings/customModules/{module}`. * `folders/{folder}/eventThreatDetectionSettings/customModules/{module}`. * `projects/{project}/eventThreatDetectionSettings/customModules/{module}`. - "type": "A String", # Type for the module. e.g. CONFIGURABLE_BAD_IP. - "updateTime": "A String", # Output only. The time the module was last updated. + "description": "A String", + "displayName": "A String", + "enablementState": "A String", + "lastEditor": "A String", + "name": "A String", + "type": "A String", + "updateTime": "A String", }
list(parent, pageSize=None, pageToken=None, x__xgafv=None) -
Lists all Event Threat Detection custom modules for the given Resource Manager parent. This includes resident modules defined at the scope of the parent along with modules inherited from ancestors.
+  
 
 Args:
-  parent: string, Required. Name of the parent to list custom modules under. Its format is: * `organizations/{organization}/eventThreatDetectionSettings`. * `folders/{folder}/eventThreatDetectionSettings`. * `projects/{project}/eventThreatDetectionSettings`. (required)
-  pageSize: integer, The maximum number of modules to return. The service may return fewer than this value. If unspecified, at most 10 configs will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
-  pageToken: string, A page token, received from a previous `ListEventThreatDetectionCustomModules` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListEventThreatDetectionCustomModules` must match the call that provided the page token.
+  parent: string, A parameter (required)
+  pageSize: integer, A parameter
+  pageToken: string, A parameter
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -219,35 +219,35 @@ 

Method Details

Returns: An object of the form: - { # Response for listing Event Threat Detection custom modules. - "eventThreatDetectionCustomModules": [ # Custom modules belonging to the requested parent. - { # Represents an instance of an Event Threat Detection custom module, including its full module name, display name, enablement state, and last updated time. You can create a custom module at the organization, folder, or project level. Custom modules that you create at the organization or folder level are inherited by child folders and projects. - "ancestorModule": "A String", # Output only. The closest ancestor module that this module inherits the enablement state from. The format is the same as the EventThreatDetectionCustomModule resource name. - "cloudProvider": "A String", # The cloud provider of the custom module. - "config": { # Config for the module. For the resident module, its config value is defined at this level. For the inherited module, its config value is inherited from the ancestor module. + { + "eventThreatDetectionCustomModules": [ + { + "ancestorModule": "A String", + "cloudProvider": "A String", + "config": { "a_key": "", # Properties of the object. }, - "description": "A String", # The description for the module. - "displayName": "A String", # The human readable name to be displayed for the module. - "enablementState": "A String", # The state of enablement for the module at the given level of the hierarchy. - "lastEditor": "A String", # Output only. The editor the module was last updated by. - "name": "A String", # Immutable. The resource name of the Event Threat Detection custom module. Its format is: * `organizations/{organization}/eventThreatDetectionSettings/customModules/{module}`. * `folders/{folder}/eventThreatDetectionSettings/customModules/{module}`. * `projects/{project}/eventThreatDetectionSettings/customModules/{module}`. - "type": "A String", # Type for the module. e.g. CONFIGURABLE_BAD_IP. - "updateTime": "A String", # Output only. The time the module was last updated. + "description": "A String", + "displayName": "A String", + "enablementState": "A String", + "lastEditor": "A String", + "name": "A String", + "type": "A String", + "updateTime": "A String", }, ], - "nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. + "nextPageToken": "A String", }
listDescendant(parent, pageSize=None, pageToken=None, x__xgafv=None) -
Lists all resident Event Threat Detection custom modules under the given Resource Manager parent and its descendants.
+  
 
 Args:
-  parent: string, Required. Name of the parent to list custom modules under. Its format is: * `organizations/{organization}/eventThreatDetectionSettings`. * `folders/{folder}/eventThreatDetectionSettings`. * `projects/{project}/eventThreatDetectionSettings`. (required)
-  pageSize: integer, The maximum number of modules to return. The service may return fewer than this value. If unspecified, at most 10 configs will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
-  pageToken: string, A page token, received from a previous `ListDescendantEventThreatDetectionCustomModules` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListDescendantEventThreatDetectionCustomModules` must match the call that provided the page token.
+  parent: string, A parameter (required)
+  pageSize: integer, A parameter
+  pageToken: string, A parameter
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -256,24 +256,24 @@ 

Method Details

Returns: An object of the form: - { # Response for listing current and descendant resident Event Threat Detection custom modules. - "eventThreatDetectionCustomModules": [ # Custom modules belonging to the requested parent. - { # Represents an instance of an Event Threat Detection custom module, including its full module name, display name, enablement state, and last updated time. You can create a custom module at the organization, folder, or project level. Custom modules that you create at the organization or folder level are inherited by child folders and projects. - "ancestorModule": "A String", # Output only. The closest ancestor module that this module inherits the enablement state from. The format is the same as the EventThreatDetectionCustomModule resource name. - "cloudProvider": "A String", # The cloud provider of the custom module. - "config": { # Config for the module. For the resident module, its config value is defined at this level. For the inherited module, its config value is inherited from the ancestor module. + { + "eventThreatDetectionCustomModules": [ + { + "ancestorModule": "A String", + "cloudProvider": "A String", + "config": { "a_key": "", # Properties of the object. }, - "description": "A String", # The description for the module. - "displayName": "A String", # The human readable name to be displayed for the module. - "enablementState": "A String", # The state of enablement for the module at the given level of the hierarchy. - "lastEditor": "A String", # Output only. The editor the module was last updated by. - "name": "A String", # Immutable. The resource name of the Event Threat Detection custom module. Its format is: * `organizations/{organization}/eventThreatDetectionSettings/customModules/{module}`. * `folders/{folder}/eventThreatDetectionSettings/customModules/{module}`. * `projects/{project}/eventThreatDetectionSettings/customModules/{module}`. - "type": "A String", # Type for the module. e.g. CONFIGURABLE_BAD_IP. - "updateTime": "A String", # Output only. The time the module was last updated. + "description": "A String", + "displayName": "A String", + "enablementState": "A String", + "lastEditor": "A String", + "name": "A String", + "type": "A String", + "updateTime": "A String", }, ], - "nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. + "nextPageToken": "A String", }
@@ -307,29 +307,29 @@

Method Details

patch(name, body=None, updateMask=None, x__xgafv=None) -
Updates the Event Threat Detection custom module with the given name based on the given update mask. Updating the enablement state is supported for both resident and inherited modules (though resident modules cannot have an enablement state of "inherited"). Updating the display name or configuration of a module is supported for resident modules only. The type of a module cannot be changed.
+  
 
 Args:
-  name: string, Immutable. The resource name of the Event Threat Detection custom module. Its format is: * `organizations/{organization}/eventThreatDetectionSettings/customModules/{module}`. * `folders/{folder}/eventThreatDetectionSettings/customModules/{module}`. * `projects/{project}/eventThreatDetectionSettings/customModules/{module}`. (required)
+  name: string, A parameter (required)
   body: object, The request body.
     The object takes the form of:
 
-{ # Represents an instance of an Event Threat Detection custom module, including its full module name, display name, enablement state, and last updated time. You can create a custom module at the organization, folder, or project level. Custom modules that you create at the organization or folder level are inherited by child folders and projects.
-  "ancestorModule": "A String", # Output only. The closest ancestor module that this module inherits the enablement state from. The format is the same as the EventThreatDetectionCustomModule resource name.
-  "cloudProvider": "A String", # The cloud provider of the custom module.
-  "config": { # Config for the module. For the resident module, its config value is defined at this level. For the inherited module, its config value is inherited from the ancestor module.
+{
+  "ancestorModule": "A String",
+  "cloudProvider": "A String",
+  "config": {
     "a_key": "", # Properties of the object.
   },
-  "description": "A String", # The description for the module.
-  "displayName": "A String", # The human readable name to be displayed for the module.
-  "enablementState": "A String", # The state of enablement for the module at the given level of the hierarchy.
-  "lastEditor": "A String", # Output only. The editor the module was last updated by.
-  "name": "A String", # Immutable. The resource name of the Event Threat Detection custom module. Its format is: * `organizations/{organization}/eventThreatDetectionSettings/customModules/{module}`. * `folders/{folder}/eventThreatDetectionSettings/customModules/{module}`. * `projects/{project}/eventThreatDetectionSettings/customModules/{module}`.
-  "type": "A String", # Type for the module. e.g. CONFIGURABLE_BAD_IP.
-  "updateTime": "A String", # Output only. The time the module was last updated.
+  "description": "A String",
+  "displayName": "A String",
+  "enablementState": "A String",
+  "lastEditor": "A String",
+  "name": "A String",
+  "type": "A String",
+  "updateTime": "A String",
 }
 
-  updateMask: string, The list of fields to be updated. If empty all mutable fields will be updated.
+  updateMask: string, A parameter
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -338,19 +338,19 @@ 

Method Details

Returns: An object of the form: - { # Represents an instance of an Event Threat Detection custom module, including its full module name, display name, enablement state, and last updated time. You can create a custom module at the organization, folder, or project level. Custom modules that you create at the organization or folder level are inherited by child folders and projects. - "ancestorModule": "A String", # Output only. The closest ancestor module that this module inherits the enablement state from. The format is the same as the EventThreatDetectionCustomModule resource name. - "cloudProvider": "A String", # The cloud provider of the custom module. - "config": { # Config for the module. For the resident module, its config value is defined at this level. For the inherited module, its config value is inherited from the ancestor module. + { + "ancestorModule": "A String", + "cloudProvider": "A String", + "config": { "a_key": "", # Properties of the object. }, - "description": "A String", # The description for the module. - "displayName": "A String", # The human readable name to be displayed for the module. - "enablementState": "A String", # The state of enablement for the module at the given level of the hierarchy. - "lastEditor": "A String", # Output only. The editor the module was last updated by. - "name": "A String", # Immutable. The resource name of the Event Threat Detection custom module. Its format is: * `organizations/{organization}/eventThreatDetectionSettings/customModules/{module}`. * `folders/{folder}/eventThreatDetectionSettings/customModules/{module}`. * `projects/{project}/eventThreatDetectionSettings/customModules/{module}`. - "type": "A String", # Type for the module. e.g. CONFIGURABLE_BAD_IP. - "updateTime": "A String", # Output only. The time the module was last updated. + "description": "A String", + "displayName": "A String", + "enablementState": "A String", + "lastEditor": "A String", + "name": "A String", + "type": "A String", + "updateTime": "A String", }
diff --git a/docs/dyn/securitycenter_v1.folders.eventThreatDetectionSettings.effectiveCustomModules.html b/docs/dyn/securitycenter_v1.folders.eventThreatDetectionSettings.effectiveCustomModules.html index b83c0f5359..7975dc9a5f 100644 --- a/docs/dyn/securitycenter_v1.folders.eventThreatDetectionSettings.effectiveCustomModules.html +++ b/docs/dyn/securitycenter_v1.folders.eventThreatDetectionSettings.effectiveCustomModules.html @@ -79,10 +79,10 @@

Instance Methods

Close httplib2 connections.

get(name, x__xgafv=None)

-

Gets an effective Event Threat Detection custom module at the given level.

+

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

-

Lists all effective Event Threat Detection custom modules for the given parent. This includes resident modules defined at the scope of the parent along with modules inherited from its ancestors.

+

list_next()

Retrieves the next page of results.

@@ -94,10 +94,10 @@

Method Details

get(name, x__xgafv=None) -
Gets an effective Event Threat Detection custom module at the given level.
+  
 
 Args:
-  name: string, Required. The resource name of the effective Event Threat Detection custom module. Its format is: * `organizations/{organization}/eventThreatDetectionSettings/effectiveCustomModules/{module}`. * `folders/{folder}/eventThreatDetectionSettings/effectiveCustomModules/{module}`. * `projects/{project}/eventThreatDetectionSettings/effectiveCustomModules/{module}`. (required)
+  name: string, A parameter (required)
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -106,27 +106,27 @@ 

Method Details

Returns: An object of the form: - { # An EffectiveEventThreatDetectionCustomModule is the representation of an Event Threat Detection custom module at a specified level of the resource hierarchy: organization, folder, or project. If a custom module is inherited from a parent organization or folder, the value of the `enablement_state` property in EffectiveEventThreatDetectionCustomModule is set to the value that is effective in the parent, instead of `INHERITED`. For example, if the module is enabled in a parent organization or folder, the effective `enablement_state` for the module in all child folders or projects is also `enabled`. EffectiveEventThreatDetectionCustomModule is read-only. - "cloudProvider": "A String", # The cloud provider of the custom module. - "config": { # Output only. Config for the effective module. + { + "cloudProvider": "A String", + "config": { "a_key": "", # Properties of the object. }, - "description": "A String", # Output only. The description for the module. - "displayName": "A String", # Output only. The human readable name to be displayed for the module. - "enablementState": "A String", # Output only. The effective state of enablement for the module at the given level of the hierarchy. - "name": "A String", # Output only. The resource name of the effective ETD custom module. Its format is: * `organizations/{organization}/eventThreatDetectionSettings/effectiveCustomModules/{module}`. * `folders/{folder}/eventThreatDetectionSettings/effectiveCustomModules/{module}`. * `projects/{project}/eventThreatDetectionSettings/effectiveCustomModules/{module}`. - "type": "A String", # Output only. Type for the module. e.g. CONFIGURABLE_BAD_IP. + "description": "A String", + "displayName": "A String", + "enablementState": "A String", + "name": "A String", + "type": "A String", }
list(parent, pageSize=None, pageToken=None, x__xgafv=None) -
Lists all effective Event Threat Detection custom modules for the given parent. This includes resident modules defined at the scope of the parent along with modules inherited from its ancestors.
+  
 
 Args:
-  parent: string, Required. Name of the parent to list custom modules for. Its format is: * `organizations/{organization}/eventThreatDetectionSettings`. * `folders/{folder}/eventThreatDetectionSettings`. * `projects/{project}/eventThreatDetectionSettings`. (required)
-  pageSize: integer, The maximum number of modules to return. The service may return fewer than this value. If unspecified, at most 10 configs will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
-  pageToken: string, A page token, received from a previous `ListEffectiveEventThreatDetectionCustomModules` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListEffectiveEventThreatDetectionCustomModules` must match the call that provided the page token.
+  parent: string, A parameter (required)
+  pageSize: integer, A parameter
+  pageToken: string, A parameter
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -135,21 +135,21 @@ 

Method Details

Returns: An object of the form: - { # Response for listing EffectiveEventThreatDetectionCustomModules. - "effectiveEventThreatDetectionCustomModules": [ # Effective custom modules belonging to the requested parent. - { # An EffectiveEventThreatDetectionCustomModule is the representation of an Event Threat Detection custom module at a specified level of the resource hierarchy: organization, folder, or project. If a custom module is inherited from a parent organization or folder, the value of the `enablement_state` property in EffectiveEventThreatDetectionCustomModule is set to the value that is effective in the parent, instead of `INHERITED`. For example, if the module is enabled in a parent organization or folder, the effective `enablement_state` for the module in all child folders or projects is also `enabled`. EffectiveEventThreatDetectionCustomModule is read-only. - "cloudProvider": "A String", # The cloud provider of the custom module. - "config": { # Output only. Config for the effective module. + { + "effectiveEventThreatDetectionCustomModules": [ + { + "cloudProvider": "A String", + "config": { "a_key": "", # Properties of the object. }, - "description": "A String", # Output only. The description for the module. - "displayName": "A String", # Output only. The human readable name to be displayed for the module. - "enablementState": "A String", # Output only. The effective state of enablement for the module at the given level of the hierarchy. - "name": "A String", # Output only. The resource name of the effective ETD custom module. Its format is: * `organizations/{organization}/eventThreatDetectionSettings/effectiveCustomModules/{module}`. * `folders/{folder}/eventThreatDetectionSettings/effectiveCustomModules/{module}`. * `projects/{project}/eventThreatDetectionSettings/effectiveCustomModules/{module}`. - "type": "A String", # Output only. Type for the module. e.g. CONFIGURABLE_BAD_IP. + "description": "A String", + "displayName": "A String", + "enablementState": "A String", + "name": "A String", + "type": "A String", }, ], - "nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. + "nextPageToken": "A String", }
diff --git a/docs/dyn/securitycenter_v1.folders.eventThreatDetectionSettings.html b/docs/dyn/securitycenter_v1.folders.eventThreatDetectionSettings.html index 230349bb3b..09edd4caa3 100644 --- a/docs/dyn/securitycenter_v1.folders.eventThreatDetectionSettings.html +++ b/docs/dyn/securitycenter_v1.folders.eventThreatDetectionSettings.html @@ -89,7 +89,7 @@

Instance Methods

Close httplib2 connections.

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

-

Validates the given Event Threat Detection custom module.

+

Method Details

close() @@ -98,16 +98,16 @@

Method Details

validateCustomModule(parent, body=None, x__xgafv=None) -
Validates the given Event Threat Detection custom module.
+  
 
 Args:
-  parent: string, Required. Resource name of the parent to validate the Custom Module under. Its format is: * `organizations/{organization}/eventThreatDetectionSettings`. * `folders/{folder}/eventThreatDetectionSettings`. * `projects/{project}/eventThreatDetectionSettings`. (required)
+  parent: string, A parameter (required)
   body: object, The request body.
     The object takes the form of:
 
-{ # Request to validate an Event Threat Detection custom module.
-  "rawText": "A String", # Required. The raw text of the module's contents. Used to generate error messages.
-  "type": "A String", # Required. The type of the module (e.g. CONFIGURABLE_BAD_IP).
+{
+  "rawText": "A String",
+  "type": "A String",
 }
 
   x__xgafv: string, V1 error format.
@@ -118,19 +118,19 @@ 

Method Details

Returns: An object of the form: - { # Response to validating an Event Threat Detection custom module. - "errors": { # A list of zero or more errors encountered while validating the uploaded configuration of an Event Threat Detection Custom Module. # A list of errors returned by the validator. If the list is empty, there were no errors. - "errors": [ # The list of errors. - { # An error encountered while validating the uploaded configuration of an Event Threat Detection Custom Module. - "description": "A String", # A description of the error, suitable for human consumption. Required. - "end": { # A position in the uploaded text version of a module. # The end position of the error in the uploaded text version of the module. This field may be omitted if no specific position applies, or if one could not be computed. - "columnNumber": 42, # The column number. - "lineNumber": 42, # The line number. + { + "errors": { + "errors": [ + { + "description": "A String", + "end": { + "columnNumber": 42, + "lineNumber": 42, }, - "fieldPath": "A String", # The path, in RFC 8901 JSON Pointer format, to the field that failed validation. This may be left empty if no specific field is affected. - "start": { # A position in the uploaded text version of a module. # The initial position of the error in the uploaded text version of the module. This field may be omitted if no specific position applies, or if one could not be computed. - "columnNumber": 42, # The column number. - "lineNumber": 42, # The line number. + "fieldPath": "A String", + "start": { + "columnNumber": 42, + "lineNumber": 42, }, }, ], diff --git a/docs/dyn/securitycenter_v1.folders.findings.html b/docs/dyn/securitycenter_v1.folders.findings.html index 623ba25cae..947e9053ae 100644 --- a/docs/dyn/securitycenter_v1.folders.findings.html +++ b/docs/dyn/securitycenter_v1.folders.findings.html @@ -76,24 +76,24 @@

Security Command Center API . bulkMute(parent, body=None, x__xgafv=None)

-

Kicks off an LRO to bulk mute findings for a parent based on a filter. The parent can be either an organization, folder or project. The findings matched by the filter will be muted after the LRO is done.

+

close()

Close httplib2 connections.

Method Details

bulkMute(parent, body=None, x__xgafv=None) -
Kicks off an LRO to bulk mute findings for a parent based on a filter. The parent can be either an organization, folder or project. The findings matched by the filter will be muted after the LRO is done.
+  
 
 Args:
-  parent: string, Required. The parent, at which bulk action needs to be applied. Its format is `organizations/[organization_id]`, `folders/[folder_id]`, `projects/[project_id]`. (required)
+  parent: string, A parameter (required)
   body: object, The request body.
     The object takes the form of:
 
-{ # Request message for bulk findings update. Note: 1. If multiple bulk update requests match the same resource, the order in which they get executed is not defined. 2. Once a bulk operation is started, there is no way to stop it.
-  "filter": "A String", # Expression that identifies findings that should be updated. The expression is a list of zero or more restrictions combined via logical operators `AND` and `OR`. Parentheses are supported, and `OR` has higher precedence than `AND`. Restrictions have the form ` ` and may have a `-` character in front of them to indicate negation. The fields map to those defined in the corresponding resource. The supported operators are: * `=` for all value types. * `>`, `<`, `>=`, `<=` for integer values. * `:`, meaning substring matching, for strings. The supported value types are: * string literals in quotes. * integer literals without quotes. * boolean literals `true` and `false` without quotes.
-  "muteAnnotation": "A String", # This can be a mute configuration name or any identifier for mute/unmute of findings based on the filter.
-  "muteState": "A String", # Optional. All findings matching the given filter will have their mute state set to this value. The default value is `MUTED`. Setting this to `UNDEFINED` will clear the mute state on all matching findings.
+{
+  "filter": "A String",
+  "muteAnnotation": "A String",
+  "muteState": "A String",
 }
 
   x__xgafv: string, V1 error format.
@@ -104,22 +104,22 @@ 

Method Details

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. + { + "done": True or False, + "error": { + "code": 42, + "details": [ { "a_key": "", # Properties of the object. Contains field @type with type URL. }, ], - "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. + "message": "A String", }, - "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. + "metadata": { "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`. + "name": "A String", + "response": { "a_key": "", # Properties of the object. Contains field @type with type URL. }, }
diff --git a/docs/dyn/securitycenter_v1.folders.locations.muteConfigs.html b/docs/dyn/securitycenter_v1.folders.locations.muteConfigs.html index e9f6014a47..c437fb642e 100644 --- a/docs/dyn/securitycenter_v1.folders.locations.muteConfigs.html +++ b/docs/dyn/securitycenter_v1.folders.locations.muteConfigs.html @@ -79,13 +79,13 @@

Instance Methods

Close httplib2 connections.

delete(name, x__xgafv=None)

-

Deletes an existing mute config.

+

get(name, x__xgafv=None)

-

Gets a mute config.

+

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

-

Updates a mute config.

+

Method Details

close() @@ -94,10 +94,10 @@

Method Details

delete(name, x__xgafv=None) -
Deletes an existing mute config.
+  
 
 Args:
-  name: string, Required. Name of the mute config to delete. Its format is `organizations/{organization}/muteConfigs/{config_id}`, `folders/{folder}/muteConfigs/{config_id}`, `projects/{project}/muteConfigs/{config_id}`, `organizations/{organization}/locations/global/muteConfigs/{config_id}`, `folders/{folder}/locations/global/muteConfigs/{config_id}`, or `projects/{project}/locations/global/muteConfigs/{config_id}`. (required)
+  name: string, A parameter (required)
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -106,16 +106,16 @@ 

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); } + { }
get(name, x__xgafv=None) -
Gets a mute config.
+  
 
 Args:
-  name: string, Required. Name of the mute config to retrieve. Its format is `organizations/{organization}/muteConfigs/{config_id}`, `folders/{folder}/muteConfigs/{config_id}`, `projects/{project}/muteConfigs/{config_id}`, `organizations/{organization}/locations/global/muteConfigs/{config_id}`, `folders/{folder}/locations/global/muteConfigs/{config_id}`, or `projects/{project}/locations/global/muteConfigs/{config_id}`. (required)
+  name: string, A parameter (required)
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -124,41 +124,41 @@ 

Method Details

Returns: An object of the form: - { # A mute config is a Cloud SCC resource that contains the configuration to mute create/update events of findings. - "createTime": "A String", # Output only. The time at which the mute config was created. This field is set by the server and will be ignored if provided on config creation. - "description": "A String", # A description of the mute config. - "displayName": "A String", # The human readable name to be displayed for the mute config. - "expiryTime": "A String", # Optional. The expiry of the mute config. Only applicable for dynamic configs. If the expiry is set, when the config expires, it is removed from all findings. - "filter": "A String", # Required. An expression that defines the filter to apply across create/update events of findings. While creating a filter string, be mindful of the scope in which the mute configuration is being created. E.g., If a filter contains project = X but is created under the project = Y scope, it might not match any findings. The following field and operator combinations are supported: * severity: `=`, `:` * category: `=`, `:` * resource.name: `=`, `:` * resource.project_name: `=`, `:` * resource.project_display_name: `=`, `:` * resource.folders.resource_folder: `=`, `:` * resource.parent_name: `=`, `:` * resource.parent_display_name: `=`, `:` * resource.type: `=`, `:` * finding_class: `=`, `:` * indicator.ip_addresses: `=`, `:` * indicator.domains: `=`, `:` - "mostRecentEditor": "A String", # Output only. Email address of the user who last edited the mute config. This field is set by the server and will be ignored if provided on config creation or update. - "name": "A String", # This field will be ignored if provided on config creation. Format `organizations/{organization}/muteConfigs/{mute_config}` `folders/{folder}/muteConfigs/{mute_config}` `projects/{project}/muteConfigs/{mute_config}` `organizations/{organization}/locations/global/muteConfigs/{mute_config}` `folders/{folder}/locations/global/muteConfigs/{mute_config}` `projects/{project}/locations/global/muteConfigs/{mute_config}` - "type": "A String", # Optional. The type of the mute config, which determines what type of mute state the config affects. The static mute state takes precedence over the dynamic mute state. Immutable after creation. STATIC by default if not set during creation. - "updateTime": "A String", # Output only. The most recent time at which the mute config was updated. This field is set by the server and will be ignored if provided on config creation or update. + { + "createTime": "A String", + "description": "A String", + "displayName": "A String", + "expiryTime": "A String", + "filter": "A String", + "mostRecentEditor": "A String", + "name": "A String", + "type": "A String", + "updateTime": "A String", }
patch(name, body=None, updateMask=None, x__xgafv=None) -
Updates a mute config.
+  
 
 Args:
-  name: string, This field will be ignored if provided on config creation. Format `organizations/{organization}/muteConfigs/{mute_config}` `folders/{folder}/muteConfigs/{mute_config}` `projects/{project}/muteConfigs/{mute_config}` `organizations/{organization}/locations/global/muteConfigs/{mute_config}` `folders/{folder}/locations/global/muteConfigs/{mute_config}` `projects/{project}/locations/global/muteConfigs/{mute_config}` (required)
+  name: string, A parameter (required)
   body: object, The request body.
     The object takes the form of:
 
-{ # A mute config is a Cloud SCC resource that contains the configuration to mute create/update events of findings.
-  "createTime": "A String", # Output only. The time at which the mute config was created. This field is set by the server and will be ignored if provided on config creation.
-  "description": "A String", # A description of the mute config.
-  "displayName": "A String", # The human readable name to be displayed for the mute config.
-  "expiryTime": "A String", # Optional. The expiry of the mute config. Only applicable for dynamic configs. If the expiry is set, when the config expires, it is removed from all findings.
-  "filter": "A String", # Required. An expression that defines the filter to apply across create/update events of findings. While creating a filter string, be mindful of the scope in which the mute configuration is being created. E.g., If a filter contains project = X but is created under the project = Y scope, it might not match any findings. The following field and operator combinations are supported: * severity: `=`, `:` * category: `=`, `:` * resource.name: `=`, `:` * resource.project_name: `=`, `:` * resource.project_display_name: `=`, `:` * resource.folders.resource_folder: `=`, `:` * resource.parent_name: `=`, `:` * resource.parent_display_name: `=`, `:` * resource.type: `=`, `:` * finding_class: `=`, `:` * indicator.ip_addresses: `=`, `:` * indicator.domains: `=`, `:`
-  "mostRecentEditor": "A String", # Output only. Email address of the user who last edited the mute config. This field is set by the server and will be ignored if provided on config creation or update.
-  "name": "A String", # This field will be ignored if provided on config creation. Format `organizations/{organization}/muteConfigs/{mute_config}` `folders/{folder}/muteConfigs/{mute_config}` `projects/{project}/muteConfigs/{mute_config}` `organizations/{organization}/locations/global/muteConfigs/{mute_config}` `folders/{folder}/locations/global/muteConfigs/{mute_config}` `projects/{project}/locations/global/muteConfigs/{mute_config}`
-  "type": "A String", # Optional. The type of the mute config, which determines what type of mute state the config affects. The static mute state takes precedence over the dynamic mute state. Immutable after creation. STATIC by default if not set during creation.
-  "updateTime": "A String", # Output only. The most recent time at which the mute config was updated. This field is set by the server and will be ignored if provided on config creation or update.
+{
+  "createTime": "A String",
+  "description": "A String",
+  "displayName": "A String",
+  "expiryTime": "A String",
+  "filter": "A String",
+  "mostRecentEditor": "A String",
+  "name": "A String",
+  "type": "A String",
+  "updateTime": "A String",
 }
 
-  updateMask: string, The list of fields to be updated. If empty all mutable fields will be updated.
+  updateMask: string, A parameter
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -167,16 +167,16 @@ 

Method Details

Returns: An object of the form: - { # A mute config is a Cloud SCC resource that contains the configuration to mute create/update events of findings. - "createTime": "A String", # Output only. The time at which the mute config was created. This field is set by the server and will be ignored if provided on config creation. - "description": "A String", # A description of the mute config. - "displayName": "A String", # The human readable name to be displayed for the mute config. - "expiryTime": "A String", # Optional. The expiry of the mute config. Only applicable for dynamic configs. If the expiry is set, when the config expires, it is removed from all findings. - "filter": "A String", # Required. An expression that defines the filter to apply across create/update events of findings. While creating a filter string, be mindful of the scope in which the mute configuration is being created. E.g., If a filter contains project = X but is created under the project = Y scope, it might not match any findings. The following field and operator combinations are supported: * severity: `=`, `:` * category: `=`, `:` * resource.name: `=`, `:` * resource.project_name: `=`, `:` * resource.project_display_name: `=`, `:` * resource.folders.resource_folder: `=`, `:` * resource.parent_name: `=`, `:` * resource.parent_display_name: `=`, `:` * resource.type: `=`, `:` * finding_class: `=`, `:` * indicator.ip_addresses: `=`, `:` * indicator.domains: `=`, `:` - "mostRecentEditor": "A String", # Output only. Email address of the user who last edited the mute config. This field is set by the server and will be ignored if provided on config creation or update. - "name": "A String", # This field will be ignored if provided on config creation. Format `organizations/{organization}/muteConfigs/{mute_config}` `folders/{folder}/muteConfigs/{mute_config}` `projects/{project}/muteConfigs/{mute_config}` `organizations/{organization}/locations/global/muteConfigs/{mute_config}` `folders/{folder}/locations/global/muteConfigs/{mute_config}` `projects/{project}/locations/global/muteConfigs/{mute_config}` - "type": "A String", # Optional. The type of the mute config, which determines what type of mute state the config affects. The static mute state takes precedence over the dynamic mute state. Immutable after creation. STATIC by default if not set during creation. - "updateTime": "A String", # Output only. The most recent time at which the mute config was updated. This field is set by the server and will be ignored if provided on config creation or update. + { + "createTime": "A String", + "description": "A String", + "displayName": "A String", + "expiryTime": "A String", + "filter": "A String", + "mostRecentEditor": "A String", + "name": "A String", + "type": "A String", + "updateTime": "A String", }
diff --git a/docs/dyn/securitycenter_v1.folders.muteConfigs.html b/docs/dyn/securitycenter_v1.folders.muteConfigs.html index 9124f16bb4..86a1fb6049 100644 --- a/docs/dyn/securitycenter_v1.folders.muteConfigs.html +++ b/docs/dyn/securitycenter_v1.folders.muteConfigs.html @@ -79,22 +79,22 @@

Instance Methods

Close httplib2 connections.

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

-

Creates a mute config.

+

delete(name, x__xgafv=None)

-

Deletes an existing mute config.

+

get(name, x__xgafv=None)

-

Gets a mute config.

+

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

-

Lists mute configs.

+

list_next()

Retrieves the next page of results.

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

-

Updates a mute config.

+

Method Details

close() @@ -103,26 +103,26 @@

Method Details

create(parent, body=None, muteConfigId=None, x__xgafv=None) -
Creates a mute config.
+  
 
 Args:
-  parent: string, Required. Resource name of the new mute configs's parent. Its format is `organizations/[organization_id]`, `folders/[folder_id]`, or `projects/[project_id]`. (required)
+  parent: string, A parameter (required)
   body: object, The request body.
     The object takes the form of:
 
-{ # A mute config is a Cloud SCC resource that contains the configuration to mute create/update events of findings.
-  "createTime": "A String", # Output only. The time at which the mute config was created. This field is set by the server and will be ignored if provided on config creation.
-  "description": "A String", # A description of the mute config.
-  "displayName": "A String", # The human readable name to be displayed for the mute config.
-  "expiryTime": "A String", # Optional. The expiry of the mute config. Only applicable for dynamic configs. If the expiry is set, when the config expires, it is removed from all findings.
-  "filter": "A String", # Required. An expression that defines the filter to apply across create/update events of findings. While creating a filter string, be mindful of the scope in which the mute configuration is being created. E.g., If a filter contains project = X but is created under the project = Y scope, it might not match any findings. The following field and operator combinations are supported: * severity: `=`, `:` * category: `=`, `:` * resource.name: `=`, `:` * resource.project_name: `=`, `:` * resource.project_display_name: `=`, `:` * resource.folders.resource_folder: `=`, `:` * resource.parent_name: `=`, `:` * resource.parent_display_name: `=`, `:` * resource.type: `=`, `:` * finding_class: `=`, `:` * indicator.ip_addresses: `=`, `:` * indicator.domains: `=`, `:`
-  "mostRecentEditor": "A String", # Output only. Email address of the user who last edited the mute config. This field is set by the server and will be ignored if provided on config creation or update.
-  "name": "A String", # This field will be ignored if provided on config creation. Format `organizations/{organization}/muteConfigs/{mute_config}` `folders/{folder}/muteConfigs/{mute_config}` `projects/{project}/muteConfigs/{mute_config}` `organizations/{organization}/locations/global/muteConfigs/{mute_config}` `folders/{folder}/locations/global/muteConfigs/{mute_config}` `projects/{project}/locations/global/muteConfigs/{mute_config}`
-  "type": "A String", # Optional. The type of the mute config, which determines what type of mute state the config affects. The static mute state takes precedence over the dynamic mute state. Immutable after creation. STATIC by default if not set during creation.
-  "updateTime": "A String", # Output only. The most recent time at which the mute config was updated. This field is set by the server and will be ignored if provided on config creation or update.
+{
+  "createTime": "A String",
+  "description": "A String",
+  "displayName": "A String",
+  "expiryTime": "A String",
+  "filter": "A String",
+  "mostRecentEditor": "A String",
+  "name": "A String",
+  "type": "A String",
+  "updateTime": "A String",
 }
 
-  muteConfigId: string, Required. Unique identifier provided by the client within the parent scope. It must consist of only lowercase letters, numbers, and hyphens, must start with a letter, must end with either a letter or a number, and must be 63 characters or less.
+  muteConfigId: string, A parameter
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -131,25 +131,25 @@ 

Method Details

Returns: An object of the form: - { # A mute config is a Cloud SCC resource that contains the configuration to mute create/update events of findings. - "createTime": "A String", # Output only. The time at which the mute config was created. This field is set by the server and will be ignored if provided on config creation. - "description": "A String", # A description of the mute config. - "displayName": "A String", # The human readable name to be displayed for the mute config. - "expiryTime": "A String", # Optional. The expiry of the mute config. Only applicable for dynamic configs. If the expiry is set, when the config expires, it is removed from all findings. - "filter": "A String", # Required. An expression that defines the filter to apply across create/update events of findings. While creating a filter string, be mindful of the scope in which the mute configuration is being created. E.g., If a filter contains project = X but is created under the project = Y scope, it might not match any findings. The following field and operator combinations are supported: * severity: `=`, `:` * category: `=`, `:` * resource.name: `=`, `:` * resource.project_name: `=`, `:` * resource.project_display_name: `=`, `:` * resource.folders.resource_folder: `=`, `:` * resource.parent_name: `=`, `:` * resource.parent_display_name: `=`, `:` * resource.type: `=`, `:` * finding_class: `=`, `:` * indicator.ip_addresses: `=`, `:` * indicator.domains: `=`, `:` - "mostRecentEditor": "A String", # Output only. Email address of the user who last edited the mute config. This field is set by the server and will be ignored if provided on config creation or update. - "name": "A String", # This field will be ignored if provided on config creation. Format `organizations/{organization}/muteConfigs/{mute_config}` `folders/{folder}/muteConfigs/{mute_config}` `projects/{project}/muteConfigs/{mute_config}` `organizations/{organization}/locations/global/muteConfigs/{mute_config}` `folders/{folder}/locations/global/muteConfigs/{mute_config}` `projects/{project}/locations/global/muteConfigs/{mute_config}` - "type": "A String", # Optional. The type of the mute config, which determines what type of mute state the config affects. The static mute state takes precedence over the dynamic mute state. Immutable after creation. STATIC by default if not set during creation. - "updateTime": "A String", # Output only. The most recent time at which the mute config was updated. This field is set by the server and will be ignored if provided on config creation or update. + { + "createTime": "A String", + "description": "A String", + "displayName": "A String", + "expiryTime": "A String", + "filter": "A String", + "mostRecentEditor": "A String", + "name": "A String", + "type": "A String", + "updateTime": "A String", }
delete(name, x__xgafv=None) -
Deletes an existing mute config.
+  
 
 Args:
-  name: string, Required. Name of the mute config to delete. Its format is `organizations/{organization}/muteConfigs/{config_id}`, `folders/{folder}/muteConfigs/{config_id}`, `projects/{project}/muteConfigs/{config_id}`, `organizations/{organization}/locations/global/muteConfigs/{config_id}`, `folders/{folder}/locations/global/muteConfigs/{config_id}`, or `projects/{project}/locations/global/muteConfigs/{config_id}`. (required)
+  name: string, A parameter (required)
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -158,16 +158,16 @@ 

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); } + { }
get(name, x__xgafv=None) -
Gets a mute config.
+  
 
 Args:
-  name: string, Required. Name of the mute config to retrieve. Its format is `organizations/{organization}/muteConfigs/{config_id}`, `folders/{folder}/muteConfigs/{config_id}`, `projects/{project}/muteConfigs/{config_id}`, `organizations/{organization}/locations/global/muteConfigs/{config_id}`, `folders/{folder}/locations/global/muteConfigs/{config_id}`, or `projects/{project}/locations/global/muteConfigs/{config_id}`. (required)
+  name: string, A parameter (required)
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -176,27 +176,27 @@ 

Method Details

Returns: An object of the form: - { # A mute config is a Cloud SCC resource that contains the configuration to mute create/update events of findings. - "createTime": "A String", # Output only. The time at which the mute config was created. This field is set by the server and will be ignored if provided on config creation. - "description": "A String", # A description of the mute config. - "displayName": "A String", # The human readable name to be displayed for the mute config. - "expiryTime": "A String", # Optional. The expiry of the mute config. Only applicable for dynamic configs. If the expiry is set, when the config expires, it is removed from all findings. - "filter": "A String", # Required. An expression that defines the filter to apply across create/update events of findings. While creating a filter string, be mindful of the scope in which the mute configuration is being created. E.g., If a filter contains project = X but is created under the project = Y scope, it might not match any findings. The following field and operator combinations are supported: * severity: `=`, `:` * category: `=`, `:` * resource.name: `=`, `:` * resource.project_name: `=`, `:` * resource.project_display_name: `=`, `:` * resource.folders.resource_folder: `=`, `:` * resource.parent_name: `=`, `:` * resource.parent_display_name: `=`, `:` * resource.type: `=`, `:` * finding_class: `=`, `:` * indicator.ip_addresses: `=`, `:` * indicator.domains: `=`, `:` - "mostRecentEditor": "A String", # Output only. Email address of the user who last edited the mute config. This field is set by the server and will be ignored if provided on config creation or update. - "name": "A String", # This field will be ignored if provided on config creation. Format `organizations/{organization}/muteConfigs/{mute_config}` `folders/{folder}/muteConfigs/{mute_config}` `projects/{project}/muteConfigs/{mute_config}` `organizations/{organization}/locations/global/muteConfigs/{mute_config}` `folders/{folder}/locations/global/muteConfigs/{mute_config}` `projects/{project}/locations/global/muteConfigs/{mute_config}` - "type": "A String", # Optional. The type of the mute config, which determines what type of mute state the config affects. The static mute state takes precedence over the dynamic mute state. Immutable after creation. STATIC by default if not set during creation. - "updateTime": "A String", # Output only. The most recent time at which the mute config was updated. This field is set by the server and will be ignored if provided on config creation or update. + { + "createTime": "A String", + "description": "A String", + "displayName": "A String", + "expiryTime": "A String", + "filter": "A String", + "mostRecentEditor": "A String", + "name": "A String", + "type": "A String", + "updateTime": "A String", }
list(parent, pageSize=None, pageToken=None, x__xgafv=None) -
Lists mute configs.
+  
 
 Args:
-  parent: string, Required. The parent, which owns the collection of mute configs. Its format is `organizations/[organization_id]`, `folders/[folder_id]`, `projects/[project_id]`. (required)
-  pageSize: integer, The maximum number of configs to return. The service may return fewer than this value. If unspecified, at most 10 configs will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
-  pageToken: string, A page token, received from a previous `ListMuteConfigs` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListMuteConfigs` must match the call that provided the page token.
+  parent: string, A parameter (required)
+  pageSize: integer, A parameter
+  pageToken: string, A parameter
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -205,21 +205,21 @@ 

Method Details

Returns: An object of the form: - { # Response message for listing mute configs. - "muteConfigs": [ # The mute configs from the specified parent. - { # A mute config is a Cloud SCC resource that contains the configuration to mute create/update events of findings. - "createTime": "A String", # Output only. The time at which the mute config was created. This field is set by the server and will be ignored if provided on config creation. - "description": "A String", # A description of the mute config. - "displayName": "A String", # The human readable name to be displayed for the mute config. - "expiryTime": "A String", # Optional. The expiry of the mute config. Only applicable for dynamic configs. If the expiry is set, when the config expires, it is removed from all findings. - "filter": "A String", # Required. An expression that defines the filter to apply across create/update events of findings. While creating a filter string, be mindful of the scope in which the mute configuration is being created. E.g., If a filter contains project = X but is created under the project = Y scope, it might not match any findings. The following field and operator combinations are supported: * severity: `=`, `:` * category: `=`, `:` * resource.name: `=`, `:` * resource.project_name: `=`, `:` * resource.project_display_name: `=`, `:` * resource.folders.resource_folder: `=`, `:` * resource.parent_name: `=`, `:` * resource.parent_display_name: `=`, `:` * resource.type: `=`, `:` * finding_class: `=`, `:` * indicator.ip_addresses: `=`, `:` * indicator.domains: `=`, `:` - "mostRecentEditor": "A String", # Output only. Email address of the user who last edited the mute config. This field is set by the server and will be ignored if provided on config creation or update. - "name": "A String", # This field will be ignored if provided on config creation. Format `organizations/{organization}/muteConfigs/{mute_config}` `folders/{folder}/muteConfigs/{mute_config}` `projects/{project}/muteConfigs/{mute_config}` `organizations/{organization}/locations/global/muteConfigs/{mute_config}` `folders/{folder}/locations/global/muteConfigs/{mute_config}` `projects/{project}/locations/global/muteConfigs/{mute_config}` - "type": "A String", # Optional. The type of the mute config, which determines what type of mute state the config affects. The static mute state takes precedence over the dynamic mute state. Immutable after creation. STATIC by default if not set during creation. - "updateTime": "A String", # Output only. The most recent time at which the mute config was updated. This field is set by the server and will be ignored if provided on config creation or update. + { + "muteConfigs": [ + { + "createTime": "A String", + "description": "A String", + "displayName": "A String", + "expiryTime": "A String", + "filter": "A String", + "mostRecentEditor": "A String", + "name": "A String", + "type": "A String", + "updateTime": "A String", }, ], - "nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. + "nextPageToken": "A String", }
@@ -239,26 +239,26 @@

Method Details

patch(name, body=None, updateMask=None, x__xgafv=None) -
Updates a mute config.
+  
 
 Args:
-  name: string, This field will be ignored if provided on config creation. Format `organizations/{organization}/muteConfigs/{mute_config}` `folders/{folder}/muteConfigs/{mute_config}` `projects/{project}/muteConfigs/{mute_config}` `organizations/{organization}/locations/global/muteConfigs/{mute_config}` `folders/{folder}/locations/global/muteConfigs/{mute_config}` `projects/{project}/locations/global/muteConfigs/{mute_config}` (required)
+  name: string, A parameter (required)
   body: object, The request body.
     The object takes the form of:
 
-{ # A mute config is a Cloud SCC resource that contains the configuration to mute create/update events of findings.
-  "createTime": "A String", # Output only. The time at which the mute config was created. This field is set by the server and will be ignored if provided on config creation.
-  "description": "A String", # A description of the mute config.
-  "displayName": "A String", # The human readable name to be displayed for the mute config.
-  "expiryTime": "A String", # Optional. The expiry of the mute config. Only applicable for dynamic configs. If the expiry is set, when the config expires, it is removed from all findings.
-  "filter": "A String", # Required. An expression that defines the filter to apply across create/update events of findings. While creating a filter string, be mindful of the scope in which the mute configuration is being created. E.g., If a filter contains project = X but is created under the project = Y scope, it might not match any findings. The following field and operator combinations are supported: * severity: `=`, `:` * category: `=`, `:` * resource.name: `=`, `:` * resource.project_name: `=`, `:` * resource.project_display_name: `=`, `:` * resource.folders.resource_folder: `=`, `:` * resource.parent_name: `=`, `:` * resource.parent_display_name: `=`, `:` * resource.type: `=`, `:` * finding_class: `=`, `:` * indicator.ip_addresses: `=`, `:` * indicator.domains: `=`, `:`
-  "mostRecentEditor": "A String", # Output only. Email address of the user who last edited the mute config. This field is set by the server and will be ignored if provided on config creation or update.
-  "name": "A String", # This field will be ignored if provided on config creation. Format `organizations/{organization}/muteConfigs/{mute_config}` `folders/{folder}/muteConfigs/{mute_config}` `projects/{project}/muteConfigs/{mute_config}` `organizations/{organization}/locations/global/muteConfigs/{mute_config}` `folders/{folder}/locations/global/muteConfigs/{mute_config}` `projects/{project}/locations/global/muteConfigs/{mute_config}`
-  "type": "A String", # Optional. The type of the mute config, which determines what type of mute state the config affects. The static mute state takes precedence over the dynamic mute state. Immutable after creation. STATIC by default if not set during creation.
-  "updateTime": "A String", # Output only. The most recent time at which the mute config was updated. This field is set by the server and will be ignored if provided on config creation or update.
+{
+  "createTime": "A String",
+  "description": "A String",
+  "displayName": "A String",
+  "expiryTime": "A String",
+  "filter": "A String",
+  "mostRecentEditor": "A String",
+  "name": "A String",
+  "type": "A String",
+  "updateTime": "A String",
 }
 
-  updateMask: string, The list of fields to be updated. If empty all mutable fields will be updated.
+  updateMask: string, A parameter
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -267,16 +267,16 @@ 

Method Details

Returns: An object of the form: - { # A mute config is a Cloud SCC resource that contains the configuration to mute create/update events of findings. - "createTime": "A String", # Output only. The time at which the mute config was created. This field is set by the server and will be ignored if provided on config creation. - "description": "A String", # A description of the mute config. - "displayName": "A String", # The human readable name to be displayed for the mute config. - "expiryTime": "A String", # Optional. The expiry of the mute config. Only applicable for dynamic configs. If the expiry is set, when the config expires, it is removed from all findings. - "filter": "A String", # Required. An expression that defines the filter to apply across create/update events of findings. While creating a filter string, be mindful of the scope in which the mute configuration is being created. E.g., If a filter contains project = X but is created under the project = Y scope, it might not match any findings. The following field and operator combinations are supported: * severity: `=`, `:` * category: `=`, `:` * resource.name: `=`, `:` * resource.project_name: `=`, `:` * resource.project_display_name: `=`, `:` * resource.folders.resource_folder: `=`, `:` * resource.parent_name: `=`, `:` * resource.parent_display_name: `=`, `:` * resource.type: `=`, `:` * finding_class: `=`, `:` * indicator.ip_addresses: `=`, `:` * indicator.domains: `=`, `:` - "mostRecentEditor": "A String", # Output only. Email address of the user who last edited the mute config. This field is set by the server and will be ignored if provided on config creation or update. - "name": "A String", # This field will be ignored if provided on config creation. Format `organizations/{organization}/muteConfigs/{mute_config}` `folders/{folder}/muteConfigs/{mute_config}` `projects/{project}/muteConfigs/{mute_config}` `organizations/{organization}/locations/global/muteConfigs/{mute_config}` `folders/{folder}/locations/global/muteConfigs/{mute_config}` `projects/{project}/locations/global/muteConfigs/{mute_config}` - "type": "A String", # Optional. The type of the mute config, which determines what type of mute state the config affects. The static mute state takes precedence over the dynamic mute state. Immutable after creation. STATIC by default if not set during creation. - "updateTime": "A String", # Output only. The most recent time at which the mute config was updated. This field is set by the server and will be ignored if provided on config creation or update. + { + "createTime": "A String", + "description": "A String", + "displayName": "A String", + "expiryTime": "A String", + "filter": "A String", + "mostRecentEditor": "A String", + "name": "A String", + "type": "A String", + "updateTime": "A String", }
diff --git a/docs/dyn/securitycenter_v1.folders.notificationConfigs.html b/docs/dyn/securitycenter_v1.folders.notificationConfigs.html index 2651c0e720..21fa7ba68a 100644 --- a/docs/dyn/securitycenter_v1.folders.notificationConfigs.html +++ b/docs/dyn/securitycenter_v1.folders.notificationConfigs.html @@ -79,22 +79,22 @@

Instance Methods

Close httplib2 connections.

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

-

Creates a notification config.

+

delete(name, x__xgafv=None)

-

Deletes a notification config.

+

get(name, x__xgafv=None)

-

Gets a notification config.

+

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

-

Lists notification configs.

+

list_next()

Retrieves the next page of results.

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

-

Updates a notification config. The following update fields are allowed: description, pubsub_topic, streaming_config.filter

+

Method Details

close() @@ -103,24 +103,24 @@

Method Details

create(parent, body=None, configId=None, x__xgafv=None) -
Creates a notification config.
+  
 
 Args:
-  parent: string, Required. Resource name of the new notification config's parent. Its format is `organizations/[organization_id]`, `folders/[folder_id]`, or `projects/[project_id]`. (required)
+  parent: string, A parameter (required)
   body: object, The request body.
     The object takes the form of:
 
-{ # Cloud Security Command Center (Cloud SCC) notification configs. A notification config is a Cloud SCC resource that contains the configuration to send notifications for create/update events of findings, assets and etc.
-  "description": "A String", # The description of the notification config (max of 1024 characters).
-  "name": "A String", # The relative resource name of this notification config. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Example: "organizations/{organization_id}/notificationConfigs/notify_public_bucket", "folders/{folder_id}/notificationConfigs/notify_public_bucket", or "projects/{project_id}/notificationConfigs/notify_public_bucket".
-  "pubsubTopic": "A String", # The Pub/Sub topic to send notifications to. Its format is "projects/[project_id]/topics/[topic]".
-  "serviceAccount": "A String", # Output only. The service account that needs "pubsub.topics.publish" permission to publish to the Pub/Sub topic.
-  "streamingConfig": { # The config for streaming-based notifications, which send each event as soon as it is detected. # The config for triggering streaming-based notifications.
-    "filter": "A String", # Expression that defines the filter to apply across create/update events of assets or findings as specified by the event type. The expression is a list of zero or more restrictions combined via logical operators `AND` and `OR`. Parentheses are supported, and `OR` has higher precedence than `AND`. Restrictions have the form ` ` and may have a `-` character in front of them to indicate negation. The fields map to those defined in the corresponding resource. The supported operators are: * `=` for all value types. * `>`, `<`, `>=`, `<=` for integer values. * `:`, meaning substring matching, for strings. The supported value types are: * string literals in quotes. * integer literals without quotes. * boolean literals `true` and `false` without quotes.
+{
+  "description": "A String",
+  "name": "A String",
+  "pubsubTopic": "A String",
+  "serviceAccount": "A String",
+  "streamingConfig": {
+    "filter": "A String",
   },
 }
 
-  configId: string, Required. Unique identifier provided by the client within the parent scope. It must be between 1 and 128 characters and contain alphanumeric characters, underscores, or hyphens only.
+  configId: string, A parameter
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -129,23 +129,23 @@ 

Method Details

Returns: An object of the form: - { # Cloud Security Command Center (Cloud SCC) notification configs. A notification config is a Cloud SCC resource that contains the configuration to send notifications for create/update events of findings, assets and etc. - "description": "A String", # The description of the notification config (max of 1024 characters). - "name": "A String", # The relative resource name of this notification config. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Example: "organizations/{organization_id}/notificationConfigs/notify_public_bucket", "folders/{folder_id}/notificationConfigs/notify_public_bucket", or "projects/{project_id}/notificationConfigs/notify_public_bucket". - "pubsubTopic": "A String", # The Pub/Sub topic to send notifications to. Its format is "projects/[project_id]/topics/[topic]". - "serviceAccount": "A String", # Output only. The service account that needs "pubsub.topics.publish" permission to publish to the Pub/Sub topic. - "streamingConfig": { # The config for streaming-based notifications, which send each event as soon as it is detected. # The config for triggering streaming-based notifications. - "filter": "A String", # Expression that defines the filter to apply across create/update events of assets or findings as specified by the event type. The expression is a list of zero or more restrictions combined via logical operators `AND` and `OR`. Parentheses are supported, and `OR` has higher precedence than `AND`. Restrictions have the form ` ` and may have a `-` character in front of them to indicate negation. The fields map to those defined in the corresponding resource. The supported operators are: * `=` for all value types. * `>`, `<`, `>=`, `<=` for integer values. * `:`, meaning substring matching, for strings. The supported value types are: * string literals in quotes. * integer literals without quotes. * boolean literals `true` and `false` without quotes. + { + "description": "A String", + "name": "A String", + "pubsubTopic": "A String", + "serviceAccount": "A String", + "streamingConfig": { + "filter": "A String", }, }
delete(name, x__xgafv=None) -
Deletes a notification config.
+  
 
 Args:
-  name: string, Required. Name of the notification config to delete. Its format is `organizations/[organization_id]/notificationConfigs/[config_id]`, `folders/[folder_id]/notificationConfigs/[config_id]`, or `projects/[project_id]/notificationConfigs/[config_id]`. (required)
+  name: string, A parameter (required)
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -154,16 +154,16 @@ 

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); } + { }
get(name, x__xgafv=None) -
Gets a notification config.
+  
 
 Args:
-  name: string, Required. Name of the notification config to get. Its format is `organizations/[organization_id]/notificationConfigs/[config_id]`, `folders/[folder_id]/notificationConfigs/[config_id]`, or `projects/[project_id]/notificationConfigs/[config_id]`. (required)
+  name: string, A parameter (required)
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -172,25 +172,25 @@ 

Method Details

Returns: An object of the form: - { # Cloud Security Command Center (Cloud SCC) notification configs. A notification config is a Cloud SCC resource that contains the configuration to send notifications for create/update events of findings, assets and etc. - "description": "A String", # The description of the notification config (max of 1024 characters). - "name": "A String", # The relative resource name of this notification config. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Example: "organizations/{organization_id}/notificationConfigs/notify_public_bucket", "folders/{folder_id}/notificationConfigs/notify_public_bucket", or "projects/{project_id}/notificationConfigs/notify_public_bucket". - "pubsubTopic": "A String", # The Pub/Sub topic to send notifications to. Its format is "projects/[project_id]/topics/[topic]". - "serviceAccount": "A String", # Output only. The service account that needs "pubsub.topics.publish" permission to publish to the Pub/Sub topic. - "streamingConfig": { # The config for streaming-based notifications, which send each event as soon as it is detected. # The config for triggering streaming-based notifications. - "filter": "A String", # Expression that defines the filter to apply across create/update events of assets or findings as specified by the event type. The expression is a list of zero or more restrictions combined via logical operators `AND` and `OR`. Parentheses are supported, and `OR` has higher precedence than `AND`. Restrictions have the form ` ` and may have a `-` character in front of them to indicate negation. The fields map to those defined in the corresponding resource. The supported operators are: * `=` for all value types. * `>`, `<`, `>=`, `<=` for integer values. * `:`, meaning substring matching, for strings. The supported value types are: * string literals in quotes. * integer literals without quotes. * boolean literals `true` and `false` without quotes. + { + "description": "A String", + "name": "A String", + "pubsubTopic": "A String", + "serviceAccount": "A String", + "streamingConfig": { + "filter": "A String", }, }
list(parent, pageSize=None, pageToken=None, x__xgafv=None) -
Lists notification configs.
+  
 
 Args:
-  parent: string, Required. The name of the parent in which to list the notification configurations. Its format is "organizations/[organization_id]", "folders/[folder_id]", or "projects/[project_id]". (required)
-  pageSize: integer, The maximum number of results to return in a single response. Default is 10, minimum is 1, maximum is 1000.
-  pageToken: string, The value returned by the last `ListNotificationConfigsResponse`; indicates that this is a continuation of a prior `ListNotificationConfigs` call, and that the system should return the next page of data.
+  parent: string, A parameter (required)
+  pageSize: integer, A parameter
+  pageToken: string, A parameter
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -199,16 +199,16 @@ 

Method Details

Returns: An object of the form: - { # Response message for listing notification configs. - "nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no more results. - "notificationConfigs": [ # Notification configs belonging to the requested parent. - { # Cloud Security Command Center (Cloud SCC) notification configs. A notification config is a Cloud SCC resource that contains the configuration to send notifications for create/update events of findings, assets and etc. - "description": "A String", # The description of the notification config (max of 1024 characters). - "name": "A String", # The relative resource name of this notification config. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Example: "organizations/{organization_id}/notificationConfigs/notify_public_bucket", "folders/{folder_id}/notificationConfigs/notify_public_bucket", or "projects/{project_id}/notificationConfigs/notify_public_bucket". - "pubsubTopic": "A String", # The Pub/Sub topic to send notifications to. Its format is "projects/[project_id]/topics/[topic]". - "serviceAccount": "A String", # Output only. The service account that needs "pubsub.topics.publish" permission to publish to the Pub/Sub topic. - "streamingConfig": { # The config for streaming-based notifications, which send each event as soon as it is detected. # The config for triggering streaming-based notifications. - "filter": "A String", # Expression that defines the filter to apply across create/update events of assets or findings as specified by the event type. The expression is a list of zero or more restrictions combined via logical operators `AND` and `OR`. Parentheses are supported, and `OR` has higher precedence than `AND`. Restrictions have the form ` ` and may have a `-` character in front of them to indicate negation. The fields map to those defined in the corresponding resource. The supported operators are: * `=` for all value types. * `>`, `<`, `>=`, `<=` for integer values. * `:`, meaning substring matching, for strings. The supported value types are: * string literals in quotes. * integer literals without quotes. * boolean literals `true` and `false` without quotes. + { + "nextPageToken": "A String", + "notificationConfigs": [ + { + "description": "A String", + "name": "A String", + "pubsubTopic": "A String", + "serviceAccount": "A String", + "streamingConfig": { + "filter": "A String", }, }, ], @@ -231,24 +231,24 @@

Method Details

patch(name, body=None, updateMask=None, x__xgafv=None) -
 Updates a notification config. The following update fields are allowed: description, pubsub_topic, streaming_config.filter
+  
 
 Args:
-  name: string, The relative resource name of this notification config. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Example: "organizations/{organization_id}/notificationConfigs/notify_public_bucket", "folders/{folder_id}/notificationConfigs/notify_public_bucket", or "projects/{project_id}/notificationConfigs/notify_public_bucket". (required)
+  name: string, A parameter (required)
   body: object, The request body.
     The object takes the form of:
 
-{ # Cloud Security Command Center (Cloud SCC) notification configs. A notification config is a Cloud SCC resource that contains the configuration to send notifications for create/update events of findings, assets and etc.
-  "description": "A String", # The description of the notification config (max of 1024 characters).
-  "name": "A String", # The relative resource name of this notification config. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Example: "organizations/{organization_id}/notificationConfigs/notify_public_bucket", "folders/{folder_id}/notificationConfigs/notify_public_bucket", or "projects/{project_id}/notificationConfigs/notify_public_bucket".
-  "pubsubTopic": "A String", # The Pub/Sub topic to send notifications to. Its format is "projects/[project_id]/topics/[topic]".
-  "serviceAccount": "A String", # Output only. The service account that needs "pubsub.topics.publish" permission to publish to the Pub/Sub topic.
-  "streamingConfig": { # The config for streaming-based notifications, which send each event as soon as it is detected. # The config for triggering streaming-based notifications.
-    "filter": "A String", # Expression that defines the filter to apply across create/update events of assets or findings as specified by the event type. The expression is a list of zero or more restrictions combined via logical operators `AND` and `OR`. Parentheses are supported, and `OR` has higher precedence than `AND`. Restrictions have the form ` ` and may have a `-` character in front of them to indicate negation. The fields map to those defined in the corresponding resource. The supported operators are: * `=` for all value types. * `>`, `<`, `>=`, `<=` for integer values. * `:`, meaning substring matching, for strings. The supported value types are: * string literals in quotes. * integer literals without quotes. * boolean literals `true` and `false` without quotes.
+{
+  "description": "A String",
+  "name": "A String",
+  "pubsubTopic": "A String",
+  "serviceAccount": "A String",
+  "streamingConfig": {
+    "filter": "A String",
   },
 }
 
-  updateMask: string, The FieldMask to use when updating the notification config. If empty all mutable fields will be updated.
+  updateMask: string, A parameter
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -257,13 +257,13 @@ 

Method Details

Returns: An object of the form: - { # Cloud Security Command Center (Cloud SCC) notification configs. A notification config is a Cloud SCC resource that contains the configuration to send notifications for create/update events of findings, assets and etc. - "description": "A String", # The description of the notification config (max of 1024 characters). - "name": "A String", # The relative resource name of this notification config. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Example: "organizations/{organization_id}/notificationConfigs/notify_public_bucket", "folders/{folder_id}/notificationConfigs/notify_public_bucket", or "projects/{project_id}/notificationConfigs/notify_public_bucket". - "pubsubTopic": "A String", # The Pub/Sub topic to send notifications to. Its format is "projects/[project_id]/topics/[topic]". - "serviceAccount": "A String", # Output only. The service account that needs "pubsub.topics.publish" permission to publish to the Pub/Sub topic. - "streamingConfig": { # The config for streaming-based notifications, which send each event as soon as it is detected. # The config for triggering streaming-based notifications. - "filter": "A String", # Expression that defines the filter to apply across create/update events of assets or findings as specified by the event type. The expression is a list of zero or more restrictions combined via logical operators `AND` and `OR`. Parentheses are supported, and `OR` has higher precedence than `AND`. Restrictions have the form ` ` and may have a `-` character in front of them to indicate negation. The fields map to those defined in the corresponding resource. The supported operators are: * `=` for all value types. * `>`, `<`, `>=`, `<=` for integer values. * `:`, meaning substring matching, for strings. The supported value types are: * string literals in quotes. * integer literals without quotes. * boolean literals `true` and `false` without quotes. + { + "description": "A String", + "name": "A String", + "pubsubTopic": "A String", + "serviceAccount": "A String", + "streamingConfig": { + "filter": "A String", }, }
diff --git a/docs/dyn/securitycenter_v1.folders.securityHealthAnalyticsSettings.customModules.html b/docs/dyn/securitycenter_v1.folders.securityHealthAnalyticsSettings.customModules.html index 7a3baffb0f..d605ec4f26 100644 --- a/docs/dyn/securitycenter_v1.folders.securityHealthAnalyticsSettings.customModules.html +++ b/docs/dyn/securitycenter_v1.folders.securityHealthAnalyticsSettings.customModules.html @@ -79,19 +79,19 @@

Instance Methods

Close httplib2 connections.

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

-

Creates a resident SecurityHealthAnalyticsCustomModule at the scope of the given CRM parent, and also creates inherited SecurityHealthAnalyticsCustomModules for all CRM descendants of the given parent. These modules are enabled by default.

+

delete(name, x__xgafv=None)

-

Deletes the specified SecurityHealthAnalyticsCustomModule and all of its descendants in the CRM hierarchy. This method is only supported for resident custom modules.

+

get(name, x__xgafv=None)

-

Retrieves a SecurityHealthAnalyticsCustomModule.

+

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

-

Returns a list of all SecurityHealthAnalyticsCustomModules for the given parent. This includes resident modules defined at the scope of the parent, and inherited modules, inherited from CRM ancestors.

+

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

-

Returns a list of all resident SecurityHealthAnalyticsCustomModules under the given CRM parent and all of the parent’s CRM descendants.

+

listDescendant_next()

Retrieves the next page of results.

@@ -100,10 +100,10 @@

Instance Methods

Retrieves the next page of results.

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

-

Updates the SecurityHealthAnalyticsCustomModule under the given name based on the given update mask. Updating the enablement state is supported on both resident and inherited modules (though resident modules cannot have an enablement state of "inherited"). Updating the display name and custom config of a module is supported on resident modules only.

+

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

-

Simulates a given SecurityHealthAnalyticsCustomModule and Resource.

+

Method Details

close() @@ -112,50 +112,50 @@

Method Details

create(parent, body=None, x__xgafv=None) -
Creates a resident SecurityHealthAnalyticsCustomModule at the scope of the given CRM parent, and also creates inherited SecurityHealthAnalyticsCustomModules for all CRM descendants of the given parent. These modules are enabled by default.
+  
 
 Args:
-  parent: string, Required. Resource name of the new custom module's parent. Its format is `organizations/{organization}/securityHealthAnalyticsSettings`, `folders/{folder}/securityHealthAnalyticsSettings`, or `projects/{project}/securityHealthAnalyticsSettings` (required)
+  parent: string, A parameter (required)
   body: object, The request body.
     The object takes the form of:
 
-{ # Represents an instance of a Security Health Analytics custom module, including its full module name, display name, enablement state, and last updated time. You can create a custom module at the organization, folder, or project level. Custom modules that you create at the organization or folder level are inherited by the child folders and projects.
-  "ancestorModule": "A String", # Output only. If empty, indicates that the custom module was created in the organization, folder, or project in which you are viewing the custom module. Otherwise, `ancestor_module` specifies the organization or folder from which the custom module is inherited.
-  "cloudProvider": "A String", # The cloud provider of the custom module.
-  "customConfig": { # Defines the properties in a custom module configuration for Security Health Analytics. Use the custom module configuration to create custom detectors that generate custom findings for resources that you specify. # The user specified custom configuration for the module.
-    "customOutput": { # A set of optional name-value pairs that define custom source properties to return with each finding that is generated by the custom module. The custom source properties that are defined here are included in the finding JSON under `sourceProperties`. # Custom output properties.
-      "properties": [ # A list of custom output properties to add to the finding.
-        { # An individual name-value pair that defines a custom source property.
-          "name": "A String", # Name of the property for the custom output.
-          "valueExpression": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The CEL expression for the custom output. A resource property can be specified to return the value of the property or a text string enclosed in quotation marks.
-            "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
-            "expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
-            "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
-            "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
+{
+  "ancestorModule": "A String",
+  "cloudProvider": "A String",
+  "customConfig": {
+    "customOutput": {
+      "properties": [
+        {
+          "name": "A String",
+          "valueExpression": {
+            "description": "A String",
+            "expression": "A String",
+            "location": "A String",
+            "title": "A String",
           },
         },
       ],
     },
-    "description": "A String", # Text that describes the vulnerability or misconfiguration that the custom module detects. This explanation is returned with each finding instance to help investigators understand the detected issue. The text must be enclosed in quotation marks.
-    "predicate": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The CEL expression to evaluate to produce findings. When the expression evaluates to true against a resource, a finding is generated.
-      "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
-      "expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
-      "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
-      "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
+    "description": "A String",
+    "predicate": {
+      "description": "A String",
+      "expression": "A String",
+      "location": "A String",
+      "title": "A String",
     },
-    "recommendation": "A String", # An explanation of the recommended steps that security teams can take to resolve the detected issue. This explanation is returned with each finding generated by this module in the `nextSteps` property of the finding JSON.
-    "resourceSelector": { # Resource for selecting resource type. # The resource types that the custom module operates on. Each custom module can specify up to 5 resource types.
-      "resourceTypes": [ # The resource types to run the detector on.
+    "recommendation": "A String",
+    "resourceSelector": {
+      "resourceTypes": [
         "A String",
       ],
     },
-    "severity": "A String", # The severity to assign to findings generated by the module.
+    "severity": "A String",
   },
-  "displayName": "A String", # The display name of the Security Health Analytics custom module. This display name becomes the finding category for all findings that are returned by this custom module. The display name must be between 1 and 128 characters, start with a lowercase letter, and contain alphanumeric characters or underscores only.
-  "enablementState": "A String", # The enablement state of the custom module.
-  "lastEditor": "A String", # Output only. The editor that last updated the custom module.
-  "name": "A String", # Immutable. The resource name of the custom module. Its format is "organizations/{organization}/securityHealthAnalyticsSettings/customModules/{customModule}", or "folders/{folder}/securityHealthAnalyticsSettings/customModules/{customModule}", or "projects/{project}/securityHealthAnalyticsSettings/customModules/{customModule}" The id {customModule} is server-generated and is not user settable. It will be a numeric id containing 1-20 digits.
-  "updateTime": "A String", # Output only. The time at which the custom module was last updated.
+  "displayName": "A String",
+  "enablementState": "A String",
+  "lastEditor": "A String",
+  "name": "A String",
+  "updateTime": "A String",
 }
 
   x__xgafv: string, V1 error format.
@@ -166,52 +166,52 @@ 

Method Details

Returns: An object of the form: - { # Represents an instance of a Security Health Analytics custom module, including its full module name, display name, enablement state, and last updated time. You can create a custom module at the organization, folder, or project level. Custom modules that you create at the organization or folder level are inherited by the child folders and projects. - "ancestorModule": "A String", # Output only. If empty, indicates that the custom module was created in the organization, folder, or project in which you are viewing the custom module. Otherwise, `ancestor_module` specifies the organization or folder from which the custom module is inherited. - "cloudProvider": "A String", # The cloud provider of the custom module. - "customConfig": { # Defines the properties in a custom module configuration for Security Health Analytics. Use the custom module configuration to create custom detectors that generate custom findings for resources that you specify. # The user specified custom configuration for the module. - "customOutput": { # A set of optional name-value pairs that define custom source properties to return with each finding that is generated by the custom module. The custom source properties that are defined here are included in the finding JSON under `sourceProperties`. # Custom output properties. - "properties": [ # A list of custom output properties to add to the finding. - { # An individual name-value pair that defines a custom source property. - "name": "A String", # Name of the property for the custom output. - "valueExpression": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The CEL expression for the custom output. A resource property can be specified to return the value of the property or a text string enclosed in quotation marks. - "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. - "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. - "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file. - "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. + { + "ancestorModule": "A String", + "cloudProvider": "A String", + "customConfig": { + "customOutput": { + "properties": [ + { + "name": "A String", + "valueExpression": { + "description": "A String", + "expression": "A String", + "location": "A String", + "title": "A String", }, }, ], }, - "description": "A String", # Text that describes the vulnerability or misconfiguration that the custom module detects. This explanation is returned with each finding instance to help investigators understand the detected issue. The text must be enclosed in quotation marks. - "predicate": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The CEL expression to evaluate to produce findings. When the expression evaluates to true against a resource, a finding is generated. - "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. - "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. - "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file. - "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. + "description": "A String", + "predicate": { + "description": "A String", + "expression": "A String", + "location": "A String", + "title": "A String", }, - "recommendation": "A String", # An explanation of the recommended steps that security teams can take to resolve the detected issue. This explanation is returned with each finding generated by this module in the `nextSteps` property of the finding JSON. - "resourceSelector": { # Resource for selecting resource type. # The resource types that the custom module operates on. Each custom module can specify up to 5 resource types. - "resourceTypes": [ # The resource types to run the detector on. + "recommendation": "A String", + "resourceSelector": { + "resourceTypes": [ "A String", ], }, - "severity": "A String", # The severity to assign to findings generated by the module. + "severity": "A String", }, - "displayName": "A String", # The display name of the Security Health Analytics custom module. This display name becomes the finding category for all findings that are returned by this custom module. The display name must be between 1 and 128 characters, start with a lowercase letter, and contain alphanumeric characters or underscores only. - "enablementState": "A String", # The enablement state of the custom module. - "lastEditor": "A String", # Output only. The editor that last updated the custom module. - "name": "A String", # Immutable. The resource name of the custom module. Its format is "organizations/{organization}/securityHealthAnalyticsSettings/customModules/{customModule}", or "folders/{folder}/securityHealthAnalyticsSettings/customModules/{customModule}", or "projects/{project}/securityHealthAnalyticsSettings/customModules/{customModule}" The id {customModule} is server-generated and is not user settable. It will be a numeric id containing 1-20 digits. - "updateTime": "A String", # Output only. The time at which the custom module was last updated. + "displayName": "A String", + "enablementState": "A String", + "lastEditor": "A String", + "name": "A String", + "updateTime": "A String", }
delete(name, x__xgafv=None) -
Deletes the specified SecurityHealthAnalyticsCustomModule and all of its descendants in the CRM hierarchy. This method is only supported for resident custom modules.
+  
 
 Args:
-  name: string, Required. Name of the custom module to delete. Its format is `organizations/{organization}/securityHealthAnalyticsSettings/customModules/{customModule}`, `folders/{folder}/securityHealthAnalyticsSettings/customModules/{customModule}`, or `projects/{project}/securityHealthAnalyticsSettings/customModules/{customModule}` (required)
+  name: string, A parameter (required)
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -220,16 +220,16 @@ 

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); } + { }
get(name, x__xgafv=None) -
Retrieves a SecurityHealthAnalyticsCustomModule.
+  
 
 Args:
-  name: string, Required. Name of the custom module to get. Its format is `organizations/{organization}/securityHealthAnalyticsSettings/customModules/{customModule}`, `folders/{folder}/securityHealthAnalyticsSettings/customModules/{customModule}`, or `projects/{project}/securityHealthAnalyticsSettings/customModules/{customModule}` (required)
+  name: string, A parameter (required)
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -238,54 +238,54 @@ 

Method Details

Returns: An object of the form: - { # Represents an instance of a Security Health Analytics custom module, including its full module name, display name, enablement state, and last updated time. You can create a custom module at the organization, folder, or project level. Custom modules that you create at the organization or folder level are inherited by the child folders and projects. - "ancestorModule": "A String", # Output only. If empty, indicates that the custom module was created in the organization, folder, or project in which you are viewing the custom module. Otherwise, `ancestor_module` specifies the organization or folder from which the custom module is inherited. - "cloudProvider": "A String", # The cloud provider of the custom module. - "customConfig": { # Defines the properties in a custom module configuration for Security Health Analytics. Use the custom module configuration to create custom detectors that generate custom findings for resources that you specify. # The user specified custom configuration for the module. - "customOutput": { # A set of optional name-value pairs that define custom source properties to return with each finding that is generated by the custom module. The custom source properties that are defined here are included in the finding JSON under `sourceProperties`. # Custom output properties. - "properties": [ # A list of custom output properties to add to the finding. - { # An individual name-value pair that defines a custom source property. - "name": "A String", # Name of the property for the custom output. - "valueExpression": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The CEL expression for the custom output. A resource property can be specified to return the value of the property or a text string enclosed in quotation marks. - "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. - "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. - "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file. - "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. + { + "ancestorModule": "A String", + "cloudProvider": "A String", + "customConfig": { + "customOutput": { + "properties": [ + { + "name": "A String", + "valueExpression": { + "description": "A String", + "expression": "A String", + "location": "A String", + "title": "A String", }, }, ], }, - "description": "A String", # Text that describes the vulnerability or misconfiguration that the custom module detects. This explanation is returned with each finding instance to help investigators understand the detected issue. The text must be enclosed in quotation marks. - "predicate": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The CEL expression to evaluate to produce findings. When the expression evaluates to true against a resource, a finding is generated. - "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. - "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. - "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file. - "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. + "description": "A String", + "predicate": { + "description": "A String", + "expression": "A String", + "location": "A String", + "title": "A String", }, - "recommendation": "A String", # An explanation of the recommended steps that security teams can take to resolve the detected issue. This explanation is returned with each finding generated by this module in the `nextSteps` property of the finding JSON. - "resourceSelector": { # Resource for selecting resource type. # The resource types that the custom module operates on. Each custom module can specify up to 5 resource types. - "resourceTypes": [ # The resource types to run the detector on. + "recommendation": "A String", + "resourceSelector": { + "resourceTypes": [ "A String", ], }, - "severity": "A String", # The severity to assign to findings generated by the module. + "severity": "A String", }, - "displayName": "A String", # The display name of the Security Health Analytics custom module. This display name becomes the finding category for all findings that are returned by this custom module. The display name must be between 1 and 128 characters, start with a lowercase letter, and contain alphanumeric characters or underscores only. - "enablementState": "A String", # The enablement state of the custom module. - "lastEditor": "A String", # Output only. The editor that last updated the custom module. - "name": "A String", # Immutable. The resource name of the custom module. Its format is "organizations/{organization}/securityHealthAnalyticsSettings/customModules/{customModule}", or "folders/{folder}/securityHealthAnalyticsSettings/customModules/{customModule}", or "projects/{project}/securityHealthAnalyticsSettings/customModules/{customModule}" The id {customModule} is server-generated and is not user settable. It will be a numeric id containing 1-20 digits. - "updateTime": "A String", # Output only. The time at which the custom module was last updated. + "displayName": "A String", + "enablementState": "A String", + "lastEditor": "A String", + "name": "A String", + "updateTime": "A String", }
list(parent, pageSize=None, pageToken=None, x__xgafv=None) -
Returns a list of all SecurityHealthAnalyticsCustomModules for the given parent. This includes resident modules defined at the scope of the parent, and inherited modules, inherited from CRM ancestors.
+  
 
 Args:
-  parent: string, Required. Name of parent to list custom modules. Its format is `organizations/{organization}/securityHealthAnalyticsSettings`, `folders/{folder}/securityHealthAnalyticsSettings`, or `projects/{project}/securityHealthAnalyticsSettings` (required)
-  pageSize: integer, The maximum number of results to return in a single response. Default is 10, minimum is 1, maximum is 1000.
-  pageToken: string, The value returned by the last call indicating a continuation
+  parent: string, A parameter (required)
+  pageSize: integer, A parameter
+  pageToken: string, A parameter
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -294,46 +294,46 @@ 

Method Details

Returns: An object of the form: - { # Response message for listing Security Health Analytics custom modules. - "nextPageToken": "A String", # If not empty, indicates that there may be more custom modules to be returned. - "securityHealthAnalyticsCustomModules": [ # Custom modules belonging to the requested parent. - { # Represents an instance of a Security Health Analytics custom module, including its full module name, display name, enablement state, and last updated time. You can create a custom module at the organization, folder, or project level. Custom modules that you create at the organization or folder level are inherited by the child folders and projects. - "ancestorModule": "A String", # Output only. If empty, indicates that the custom module was created in the organization, folder, or project in which you are viewing the custom module. Otherwise, `ancestor_module` specifies the organization or folder from which the custom module is inherited. - "cloudProvider": "A String", # The cloud provider of the custom module. - "customConfig": { # Defines the properties in a custom module configuration for Security Health Analytics. Use the custom module configuration to create custom detectors that generate custom findings for resources that you specify. # The user specified custom configuration for the module. - "customOutput": { # A set of optional name-value pairs that define custom source properties to return with each finding that is generated by the custom module. The custom source properties that are defined here are included in the finding JSON under `sourceProperties`. # Custom output properties. - "properties": [ # A list of custom output properties to add to the finding. - { # An individual name-value pair that defines a custom source property. - "name": "A String", # Name of the property for the custom output. - "valueExpression": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The CEL expression for the custom output. A resource property can be specified to return the value of the property or a text string enclosed in quotation marks. - "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. - "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. - "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file. - "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. + { + "nextPageToken": "A String", + "securityHealthAnalyticsCustomModules": [ + { + "ancestorModule": "A String", + "cloudProvider": "A String", + "customConfig": { + "customOutput": { + "properties": [ + { + "name": "A String", + "valueExpression": { + "description": "A String", + "expression": "A String", + "location": "A String", + "title": "A String", }, }, ], }, - "description": "A String", # Text that describes the vulnerability or misconfiguration that the custom module detects. This explanation is returned with each finding instance to help investigators understand the detected issue. The text must be enclosed in quotation marks. - "predicate": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The CEL expression to evaluate to produce findings. When the expression evaluates to true against a resource, a finding is generated. - "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. - "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. - "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file. - "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. + "description": "A String", + "predicate": { + "description": "A String", + "expression": "A String", + "location": "A String", + "title": "A String", }, - "recommendation": "A String", # An explanation of the recommended steps that security teams can take to resolve the detected issue. This explanation is returned with each finding generated by this module in the `nextSteps` property of the finding JSON. - "resourceSelector": { # Resource for selecting resource type. # The resource types that the custom module operates on. Each custom module can specify up to 5 resource types. - "resourceTypes": [ # The resource types to run the detector on. + "recommendation": "A String", + "resourceSelector": { + "resourceTypes": [ "A String", ], }, - "severity": "A String", # The severity to assign to findings generated by the module. + "severity": "A String", }, - "displayName": "A String", # The display name of the Security Health Analytics custom module. This display name becomes the finding category for all findings that are returned by this custom module. The display name must be between 1 and 128 characters, start with a lowercase letter, and contain alphanumeric characters or underscores only. - "enablementState": "A String", # The enablement state of the custom module. - "lastEditor": "A String", # Output only. The editor that last updated the custom module. - "name": "A String", # Immutable. The resource name of the custom module. Its format is "organizations/{organization}/securityHealthAnalyticsSettings/customModules/{customModule}", or "folders/{folder}/securityHealthAnalyticsSettings/customModules/{customModule}", or "projects/{project}/securityHealthAnalyticsSettings/customModules/{customModule}" The id {customModule} is server-generated and is not user settable. It will be a numeric id containing 1-20 digits. - "updateTime": "A String", # Output only. The time at which the custom module was last updated. + "displayName": "A String", + "enablementState": "A String", + "lastEditor": "A String", + "name": "A String", + "updateTime": "A String", }, ], }
@@ -341,12 +341,12 @@

Method Details

listDescendant(parent, pageSize=None, pageToken=None, x__xgafv=None) -
Returns a list of all resident SecurityHealthAnalyticsCustomModules under the given CRM parent and all of the parent’s CRM descendants.
+  
 
 Args:
-  parent: string, Required. Name of parent to list descendant custom modules. Its format is `organizations/{organization}/securityHealthAnalyticsSettings`, `folders/{folder}/securityHealthAnalyticsSettings`, or `projects/{project}/securityHealthAnalyticsSettings` (required)
-  pageSize: integer, The maximum number of results to return in a single response. Default is 10, minimum is 1, maximum is 1000.
-  pageToken: string, The value returned by the last call indicating a continuation
+  parent: string, A parameter (required)
+  pageSize: integer, A parameter
+  pageToken: string, A parameter
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -355,46 +355,46 @@ 

Method Details

Returns: An object of the form: - { # Response message for listing descendant Security Health Analytics custom modules. - "nextPageToken": "A String", # If not empty, indicates that there may be more custom modules to be returned. - "securityHealthAnalyticsCustomModules": [ # Custom modules belonging to the requested parent and its descendants. - { # Represents an instance of a Security Health Analytics custom module, including its full module name, display name, enablement state, and last updated time. You can create a custom module at the organization, folder, or project level. Custom modules that you create at the organization or folder level are inherited by the child folders and projects. - "ancestorModule": "A String", # Output only. If empty, indicates that the custom module was created in the organization, folder, or project in which you are viewing the custom module. Otherwise, `ancestor_module` specifies the organization or folder from which the custom module is inherited. - "cloudProvider": "A String", # The cloud provider of the custom module. - "customConfig": { # Defines the properties in a custom module configuration for Security Health Analytics. Use the custom module configuration to create custom detectors that generate custom findings for resources that you specify. # The user specified custom configuration for the module. - "customOutput": { # A set of optional name-value pairs that define custom source properties to return with each finding that is generated by the custom module. The custom source properties that are defined here are included in the finding JSON under `sourceProperties`. # Custom output properties. - "properties": [ # A list of custom output properties to add to the finding. - { # An individual name-value pair that defines a custom source property. - "name": "A String", # Name of the property for the custom output. - "valueExpression": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The CEL expression for the custom output. A resource property can be specified to return the value of the property or a text string enclosed in quotation marks. - "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. - "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. - "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file. - "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. + { + "nextPageToken": "A String", + "securityHealthAnalyticsCustomModules": [ + { + "ancestorModule": "A String", + "cloudProvider": "A String", + "customConfig": { + "customOutput": { + "properties": [ + { + "name": "A String", + "valueExpression": { + "description": "A String", + "expression": "A String", + "location": "A String", + "title": "A String", }, }, ], }, - "description": "A String", # Text that describes the vulnerability or misconfiguration that the custom module detects. This explanation is returned with each finding instance to help investigators understand the detected issue. The text must be enclosed in quotation marks. - "predicate": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The CEL expression to evaluate to produce findings. When the expression evaluates to true against a resource, a finding is generated. - "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. - "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. - "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file. - "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. + "description": "A String", + "predicate": { + "description": "A String", + "expression": "A String", + "location": "A String", + "title": "A String", }, - "recommendation": "A String", # An explanation of the recommended steps that security teams can take to resolve the detected issue. This explanation is returned with each finding generated by this module in the `nextSteps` property of the finding JSON. - "resourceSelector": { # Resource for selecting resource type. # The resource types that the custom module operates on. Each custom module can specify up to 5 resource types. - "resourceTypes": [ # The resource types to run the detector on. + "recommendation": "A String", + "resourceSelector": { + "resourceTypes": [ "A String", ], }, - "severity": "A String", # The severity to assign to findings generated by the module. + "severity": "A String", }, - "displayName": "A String", # The display name of the Security Health Analytics custom module. This display name becomes the finding category for all findings that are returned by this custom module. The display name must be between 1 and 128 characters, start with a lowercase letter, and contain alphanumeric characters or underscores only. - "enablementState": "A String", # The enablement state of the custom module. - "lastEditor": "A String", # Output only. The editor that last updated the custom module. - "name": "A String", # Immutable. The resource name of the custom module. Its format is "organizations/{organization}/securityHealthAnalyticsSettings/customModules/{customModule}", or "folders/{folder}/securityHealthAnalyticsSettings/customModules/{customModule}", or "projects/{project}/securityHealthAnalyticsSettings/customModules/{customModule}" The id {customModule} is server-generated and is not user settable. It will be a numeric id containing 1-20 digits. - "updateTime": "A String", # Output only. The time at which the custom module was last updated. + "displayName": "A String", + "enablementState": "A String", + "lastEditor": "A String", + "name": "A String", + "updateTime": "A String", }, ], }
@@ -430,53 +430,53 @@

Method Details

patch(name, body=None, updateMask=None, x__xgafv=None) -
Updates the SecurityHealthAnalyticsCustomModule under the given name based on the given update mask. Updating the enablement state is supported on both resident and inherited modules (though resident modules cannot have an enablement state of "inherited"). Updating the display name and custom config of a module is supported on resident modules only.
+  
 
 Args:
-  name: string, Immutable. The resource name of the custom module. Its format is "organizations/{organization}/securityHealthAnalyticsSettings/customModules/{customModule}", or "folders/{folder}/securityHealthAnalyticsSettings/customModules/{customModule}", or "projects/{project}/securityHealthAnalyticsSettings/customModules/{customModule}" The id {customModule} is server-generated and is not user settable. It will be a numeric id containing 1-20 digits. (required)
+  name: string, A parameter (required)
   body: object, The request body.
     The object takes the form of:
 
-{ # Represents an instance of a Security Health Analytics custom module, including its full module name, display name, enablement state, and last updated time. You can create a custom module at the organization, folder, or project level. Custom modules that you create at the organization or folder level are inherited by the child folders and projects.
-  "ancestorModule": "A String", # Output only. If empty, indicates that the custom module was created in the organization, folder, or project in which you are viewing the custom module. Otherwise, `ancestor_module` specifies the organization or folder from which the custom module is inherited.
-  "cloudProvider": "A String", # The cloud provider of the custom module.
-  "customConfig": { # Defines the properties in a custom module configuration for Security Health Analytics. Use the custom module configuration to create custom detectors that generate custom findings for resources that you specify. # The user specified custom configuration for the module.
-    "customOutput": { # A set of optional name-value pairs that define custom source properties to return with each finding that is generated by the custom module. The custom source properties that are defined here are included in the finding JSON under `sourceProperties`. # Custom output properties.
-      "properties": [ # A list of custom output properties to add to the finding.
-        { # An individual name-value pair that defines a custom source property.
-          "name": "A String", # Name of the property for the custom output.
-          "valueExpression": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The CEL expression for the custom output. A resource property can be specified to return the value of the property or a text string enclosed in quotation marks.
-            "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
-            "expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
-            "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
-            "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
+{
+  "ancestorModule": "A String",
+  "cloudProvider": "A String",
+  "customConfig": {
+    "customOutput": {
+      "properties": [
+        {
+          "name": "A String",
+          "valueExpression": {
+            "description": "A String",
+            "expression": "A String",
+            "location": "A String",
+            "title": "A String",
           },
         },
       ],
     },
-    "description": "A String", # Text that describes the vulnerability or misconfiguration that the custom module detects. This explanation is returned with each finding instance to help investigators understand the detected issue. The text must be enclosed in quotation marks.
-    "predicate": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The CEL expression to evaluate to produce findings. When the expression evaluates to true against a resource, a finding is generated.
-      "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
-      "expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
-      "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
-      "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
+    "description": "A String",
+    "predicate": {
+      "description": "A String",
+      "expression": "A String",
+      "location": "A String",
+      "title": "A String",
     },
-    "recommendation": "A String", # An explanation of the recommended steps that security teams can take to resolve the detected issue. This explanation is returned with each finding generated by this module in the `nextSteps` property of the finding JSON.
-    "resourceSelector": { # Resource for selecting resource type. # The resource types that the custom module operates on. Each custom module can specify up to 5 resource types.
-      "resourceTypes": [ # The resource types to run the detector on.
+    "recommendation": "A String",
+    "resourceSelector": {
+      "resourceTypes": [
         "A String",
       ],
     },
-    "severity": "A String", # The severity to assign to findings generated by the module.
+    "severity": "A String",
   },
-  "displayName": "A String", # The display name of the Security Health Analytics custom module. This display name becomes the finding category for all findings that are returned by this custom module. The display name must be between 1 and 128 characters, start with a lowercase letter, and contain alphanumeric characters or underscores only.
-  "enablementState": "A String", # The enablement state of the custom module.
-  "lastEditor": "A String", # Output only. The editor that last updated the custom module.
-  "name": "A String", # Immutable. The resource name of the custom module. Its format is "organizations/{organization}/securityHealthAnalyticsSettings/customModules/{customModule}", or "folders/{folder}/securityHealthAnalyticsSettings/customModules/{customModule}", or "projects/{project}/securityHealthAnalyticsSettings/customModules/{customModule}" The id {customModule} is server-generated and is not user settable. It will be a numeric id containing 1-20 digits.
-  "updateTime": "A String", # Output only. The time at which the custom module was last updated.
+  "displayName": "A String",
+  "enablementState": "A String",
+  "lastEditor": "A String",
+  "name": "A String",
+  "updateTime": "A String",
 }
 
-  updateMask: string, The list of fields to be updated. The only fields that can be updated are `enablement_state` and `custom_config`. If empty or set to the wildcard value `*`, both `enablement_state` and `custom_config` are updated.
+  updateMask: string, A parameter
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -485,121 +485,121 @@ 

Method Details

Returns: An object of the form: - { # Represents an instance of a Security Health Analytics custom module, including its full module name, display name, enablement state, and last updated time. You can create a custom module at the organization, folder, or project level. Custom modules that you create at the organization or folder level are inherited by the child folders and projects. - "ancestorModule": "A String", # Output only. If empty, indicates that the custom module was created in the organization, folder, or project in which you are viewing the custom module. Otherwise, `ancestor_module` specifies the organization or folder from which the custom module is inherited. - "cloudProvider": "A String", # The cloud provider of the custom module. - "customConfig": { # Defines the properties in a custom module configuration for Security Health Analytics. Use the custom module configuration to create custom detectors that generate custom findings for resources that you specify. # The user specified custom configuration for the module. - "customOutput": { # A set of optional name-value pairs that define custom source properties to return with each finding that is generated by the custom module. The custom source properties that are defined here are included in the finding JSON under `sourceProperties`. # Custom output properties. - "properties": [ # A list of custom output properties to add to the finding. - { # An individual name-value pair that defines a custom source property. - "name": "A String", # Name of the property for the custom output. - "valueExpression": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The CEL expression for the custom output. A resource property can be specified to return the value of the property or a text string enclosed in quotation marks. - "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. - "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. - "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file. - "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. + { + "ancestorModule": "A String", + "cloudProvider": "A String", + "customConfig": { + "customOutput": { + "properties": [ + { + "name": "A String", + "valueExpression": { + "description": "A String", + "expression": "A String", + "location": "A String", + "title": "A String", }, }, ], }, - "description": "A String", # Text that describes the vulnerability or misconfiguration that the custom module detects. This explanation is returned with each finding instance to help investigators understand the detected issue. The text must be enclosed in quotation marks. - "predicate": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The CEL expression to evaluate to produce findings. When the expression evaluates to true against a resource, a finding is generated. - "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. - "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. - "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file. - "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. + "description": "A String", + "predicate": { + "description": "A String", + "expression": "A String", + "location": "A String", + "title": "A String", }, - "recommendation": "A String", # An explanation of the recommended steps that security teams can take to resolve the detected issue. This explanation is returned with each finding generated by this module in the `nextSteps` property of the finding JSON. - "resourceSelector": { # Resource for selecting resource type. # The resource types that the custom module operates on. Each custom module can specify up to 5 resource types. - "resourceTypes": [ # The resource types to run the detector on. + "recommendation": "A String", + "resourceSelector": { + "resourceTypes": [ "A String", ], }, - "severity": "A String", # The severity to assign to findings generated by the module. + "severity": "A String", }, - "displayName": "A String", # The display name of the Security Health Analytics custom module. This display name becomes the finding category for all findings that are returned by this custom module. The display name must be between 1 and 128 characters, start with a lowercase letter, and contain alphanumeric characters or underscores only. - "enablementState": "A String", # The enablement state of the custom module. - "lastEditor": "A String", # Output only. The editor that last updated the custom module. - "name": "A String", # Immutable. The resource name of the custom module. Its format is "organizations/{organization}/securityHealthAnalyticsSettings/customModules/{customModule}", or "folders/{folder}/securityHealthAnalyticsSettings/customModules/{customModule}", or "projects/{project}/securityHealthAnalyticsSettings/customModules/{customModule}" The id {customModule} is server-generated and is not user settable. It will be a numeric id containing 1-20 digits. - "updateTime": "A String", # Output only. The time at which the custom module was last updated. + "displayName": "A String", + "enablementState": "A String", + "lastEditor": "A String", + "name": "A String", + "updateTime": "A String", }
simulate(parent, body=None, x__xgafv=None) -
Simulates a given SecurityHealthAnalyticsCustomModule and Resource.
+  
 
 Args:
-  parent: string, Required. The relative resource name of the organization, project, or folder. For more information about relative resource names, see [Relative Resource Name](https://cloud.google.com/apis/design/resource_names#relative_resource_name) Example: `organizations/{organization_id}` (required)
+  parent: string, A parameter (required)
   body: object, The request body.
     The object takes the form of:
 
-{ # Request message to simulate a CustomConfig against a given test resource. Maximum size of the request is 4 MB by default.
-  "customConfig": { # Defines the properties in a custom module configuration for Security Health Analytics. Use the custom module configuration to create custom detectors that generate custom findings for resources that you specify. # Required. The custom configuration that you need to test.
-    "customOutput": { # A set of optional name-value pairs that define custom source properties to return with each finding that is generated by the custom module. The custom source properties that are defined here are included in the finding JSON under `sourceProperties`. # Custom output properties.
-      "properties": [ # A list of custom output properties to add to the finding.
-        { # An individual name-value pair that defines a custom source property.
-          "name": "A String", # Name of the property for the custom output.
-          "valueExpression": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The CEL expression for the custom output. A resource property can be specified to return the value of the property or a text string enclosed in quotation marks.
-            "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
-            "expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
-            "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
-            "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
+{
+  "customConfig": {
+    "customOutput": {
+      "properties": [
+        {
+          "name": "A String",
+          "valueExpression": {
+            "description": "A String",
+            "expression": "A String",
+            "location": "A String",
+            "title": "A String",
           },
         },
       ],
     },
-    "description": "A String", # Text that describes the vulnerability or misconfiguration that the custom module detects. This explanation is returned with each finding instance to help investigators understand the detected issue. The text must be enclosed in quotation marks.
-    "predicate": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The CEL expression to evaluate to produce findings. When the expression evaluates to true against a resource, a finding is generated.
-      "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
-      "expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
-      "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
-      "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
+    "description": "A String",
+    "predicate": {
+      "description": "A String",
+      "expression": "A String",
+      "location": "A String",
+      "title": "A String",
     },
-    "recommendation": "A String", # An explanation of the recommended steps that security teams can take to resolve the detected issue. This explanation is returned with each finding generated by this module in the `nextSteps` property of the finding JSON.
-    "resourceSelector": { # Resource for selecting resource type. # The resource types that the custom module operates on. Each custom module can specify up to 5 resource types.
-      "resourceTypes": [ # The resource types to run the detector on.
+    "recommendation": "A String",
+    "resourceSelector": {
+      "resourceTypes": [
         "A String",
       ],
     },
-    "severity": "A String", # The severity to assign to findings generated by the module.
+    "severity": "A String",
   },
-  "resource": { # Manually constructed resource name. If the custom module evaluates against only the resource data, you can omit the `iam_policy_data` field. If it evaluates only the `iam_policy_data` field, you can omit the resource data. # Required. Resource data to simulate custom module against.
-    "iamPolicyData": { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). # Optional. A representation of the IAM policy.
-      "auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
-        { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging.
-          "auditLogConfigs": [ # The configuration for logging of each type of permission.
-            { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.
-              "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.
+  "resource": {
+    "iamPolicyData": {
+      "auditConfigs": [
+        {
+          "auditLogConfigs": [
+            {
+              "exemptedMembers": [
                 "A String",
               ],
-              "logType": "A String", # The log type that this config enables.
+              "logType": "A String",
             },
           ],
-          "service": "A String", # Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services.
+          "service": "A String",
         },
       ],
-      "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`.
-        { # Associates `members`, or principals, with a `role`.
-          "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
-            "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
-            "expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
-            "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
-            "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
+      "bindings": [
+        {
+          "condition": {
+            "description": "A String",
+            "expression": "A String",
+            "location": "A String",
+            "title": "A String",
           },
-          "members": [ # Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
+          "members": [
             "A String",
           ],
-          "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles).
+          "role": "A String",
         },
       ],
-      "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).
+      "etag": "A String",
+      "version": 42,
     },
-    "resourceData": { # Optional. A representation of the Google Cloud resource. Should match the Google Cloud resource JSON format.
+    "resourceData": {
       "a_key": "", # Properties of the object.
     },
-    "resourceType": "A String", # Required. The type of the resource, for example, `compute.googleapis.com/Disk`.
+    "resourceType": "A String",
   },
 }
 
@@ -611,826 +611,826 @@ 

Method Details

Returns: An object of the form: - { # Response message for simulating a `SecurityHealthAnalyticsCustomModule` against a given resource. - "result": { # Possible test result. # Result for test case in the corresponding request. - "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). # Error encountered during the test. - "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. + { + "result": { + "error": { + "code": 42, + "details": [ { "a_key": "", # Properties of the object. Contains field @type with type URL. }, ], - "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. + "message": "A String", }, - "finding": { # Security Command Center finding. A finding is a record of assessment data like security, risk, health, or privacy, that is ingested into Security Command Center for presentation, notification, analysis, policy testing, and enforcement. For example, a cross-site scripting (XSS) vulnerability in an App Engine application is a finding. # Finding that would be published for the test case, if a violation is detected. - "access": { # Represents an access event. # Access details associated with the finding, such as more information on the caller, which method was accessed, and from where. - "callerIp": "A String", # Caller's IP address, such as "1.1.1.1". - "callerIpGeo": { # Represents a geographical location for a given access. # The caller IP's geolocation, which identifies where the call came from. - "regionCode": "A String", # A CLDR. + "finding": { + "access": { + "callerIp": "A String", + "callerIpGeo": { + "regionCode": "A String", }, - "methodName": "A String", # The method that the service account called, e.g. "SetIamPolicy". - "principalEmail": "A String", # Associated email, such as "foo@google.com". The email address of the authenticated user or a service account acting on behalf of a 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). - "principalSubject": "A String", # A string that represents the principal_subject that is associated with the identity. Unlike `principal_email`, `principal_subject` supports principals that aren't associated with email addresses, such as third party principals. For most identities, the format is `principal://iam.googleapis.com/{identity pool name}/subject/{subject}`. Some GKE identities, such as GKE_WORKLOAD, FREEFORM, and GKE_HUB_WORKLOAD, still use the legacy format `serviceAccount:{identity pool name}[{subject}]`. - "serviceAccountDelegationInfo": [ # The identity delegation history of an authenticated service account that made the request. The `serviceAccountDelegationInfo[]` object contains information about the real authorities that try to access Google Cloud resources by delegating on a service account. When multiple authorities are present, they are guaranteed to be sorted based on the original ordering of the identity delegation events. - { # Identity delegation history of an authenticated service account. - "principalEmail": "A String", # The email address of a Google account. - "principalSubject": "A String", # A string representing the principal_subject associated with the identity. As compared to `principal_email`, supports principals that aren't associated with email addresses, such as third party principals. For most identities, the format will be `principal://iam.googleapis.com/{identity pool name}/subjects/{subject}` except for some GKE identities (GKE_WORKLOAD, FREEFORM, GKE_HUB_WORKLOAD) that are still in the legacy format `serviceAccount:{identity pool name}[{subject}]` + "methodName": "A String", + "principalEmail": "A String", + "principalSubject": "A String", + "serviceAccountDelegationInfo": [ + { + "principalEmail": "A String", + "principalSubject": "A String", }, ], - "serviceAccountKeyName": "A String", # The name of the service account key that was used to create or exchange credentials when authenticating the service account that made the request. This is a scheme-less URI full resource name. For example: "//iam.googleapis.com/projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}/keys/{key}". - "serviceName": "A String", # This is the API service that the service account made a call to, e.g. "iam.googleapis.com" - "userAgent": "A String", # The caller's user agent string associated with the finding. - "userAgentFamily": "A String", # Type of user agent associated with the finding. For example, an operating system shell or an embedded or standalone application. - "userName": "A String", # A string that represents a username. The username provided depends on the type of the finding and is likely not an IAM principal. For example, this can be a system username if the finding is related to a virtual machine, or it can be an application login username. + "serviceAccountKeyName": "A String", + "serviceName": "A String", + "userAgent": "A String", + "userAgentFamily": "A String", + "userName": "A String", }, - "affectedResources": { # Details about resources affected by this finding. # AffectedResources associated with the finding. - "count": "A String", # The count of resources affected by the finding. + "affectedResources": { + "count": "A String", }, - "agentDataAccessEvents": [ # Agent data access events associated with the finding. - { # Details about a data access attempt made by an agent principal not authorized under applicable data security policy. - "eventId": "A String", # Unique identifier for data access event. - "eventTime": "A String", # Timestamp of data access event. - "operation": "A String", # The operation performed by the principal to access the data. - "principalSubject": "A String", # The agent principal that accessed the data. + "agentDataAccessEvents": [ + { + "eventId": "A String", + "eventTime": "A String", + "operation": "A String", + "principalSubject": "A String", }, ], - "aiModel": { # Contains information about the AI model associated with the finding. # The AI model associated with the finding. - "deploymentPlatform": "A String", # The platform on which the model is deployed. - "displayName": "A String", # The user defined display name of model. Ex. baseline-classification-model - "domain": "A String", # The domain of the model, for example, “image-classification”. - "library": "A String", # The name of the model library, for example, “transformers”. - "location": "A String", # The region in which the model is used, for example, “us-central1”. - "name": "A String", # The name of the AI model, for example, "gemini:1.0.0". - "publisher": "A String", # The publisher of the model, for example, “google” or “nvidia”. - "usageCategory": "A String", # The purpose of the model, for example, "Inteference" or "Training". + "aiModel": { + "deploymentPlatform": "A String", + "displayName": "A String", + "domain": "A String", + "library": "A String", + "location": "A String", + "name": "A String", + "publisher": "A String", + "usageCategory": "A String", }, - "application": { # Represents an application associated with a finding. # Represents an application associated with the finding. - "baseUri": "A String", # The base URI that identifies the network location of the application in which the vulnerability was detected. For example, `http://example.com`. - "fullUri": "A String", # The full URI with payload that can be used to reproduce the vulnerability. For example, `http://example.com?p=aMmYgI6H`. + "application": { + "baseUri": "A String", + "fullUri": "A String", }, - "artifactGuardPolicies": { # Represents the result of evaluating artifact guard policies. # ArtifactGuardPolicies associated with the finding. - "failingPolicies": [ # A list of failing policies. - { # Represents an artifact guard policy. - "failureReason": "A String", # The reason for the policy failure, for example, "severity=HIGH AND max_vuln_count=2". - "policyId": "A String", # The ID of the failing policy, for example, "organizations/3392779/locations/global/policies/prod-policy". - "type": "A String", # The type of the policy evaluation. + "artifactGuardPolicies": { + "failingPolicies": [ + { + "failureReason": "A String", + "policyId": "A String", + "type": "A String", }, ], - "resourceId": "A String", # The ID of the resource that has policies configured for it. + "resourceId": "A String", }, - "attackExposure": { # An attack exposure contains the results of an attack path simulation run. # The results of an attack path simulation relevant to this finding. - "attackExposureResult": "A String", # The resource name of the attack path simulation result that contains the details regarding this attack exposure score. Example: `organizations/123/simulations/456/attackExposureResults/789` - "exposedHighValueResourcesCount": 42, # The number of high value resources that are exposed as a result of this finding. - "exposedLowValueResourcesCount": 42, # The number of high value resources that are exposed as a result of this finding. - "exposedMediumValueResourcesCount": 42, # The number of medium value resources that are exposed as a result of this finding. - "latestCalculationTime": "A String", # The most recent time the attack exposure was updated on this finding. - "score": 3.14, # A number between 0 (inclusive) and infinity that represents how important this finding is to remediate. The higher the score, the more important it is to remediate. - "state": "A String", # What state this AttackExposure is in. This captures whether or not an attack exposure has been calculated or not. + "attackExposure": { + "attackExposureResult": "A String", + "exposedHighValueResourcesCount": 42, + "exposedLowValueResourcesCount": 42, + "exposedMediumValueResourcesCount": 42, + "latestCalculationTime": "A String", + "score": 3.14, + "state": "A String", }, - "backupDisasterRecovery": { # Information related to Google Cloud Backup and DR Service findings. # Fields related to Backup and DR findings. - "appliance": "A String", # The name of the Backup and DR appliance that captures, moves, and manages the lifecycle of backup data. For example, `backup-server-57137`. - "applications": [ # The names of Backup and DR applications. An application is a VM, database, or file system on a managed host monitored by a backup and recovery appliance. For example, `centos7-01-vol00`, `centos7-01-vol01`, `centos7-01-vol02`. + "backupDisasterRecovery": { + "appliance": "A String", + "applications": [ "A String", ], - "backupCreateTime": "A String", # The timestamp at which the Backup and DR backup was created. - "backupTemplate": "A String", # The name of a Backup and DR template which comprises one or more backup policies. See the [Backup and DR documentation](https://cloud.google.com/backup-disaster-recovery/docs/concepts/backup-plan#temp) for more information. For example, `snap-ov`. - "backupType": "A String", # The backup type of the Backup and DR image. For example, `Snapshot`, `Remote Snapshot`, `OnVault`. - "host": "A String", # The name of a Backup and DR host, which is managed by the backup and recovery appliance and known to the management console. The host can be of type Generic (for example, Compute Engine, SQL Server, Oracle DB, SMB file system, etc.), vCenter, or an ESX server. See the [Backup and DR documentation on hosts](https://cloud.google.com/backup-disaster-recovery/docs/configuration/manage-hosts-and-their-applications) for more information. For example, `centos7-01`. - "policies": [ # The names of Backup and DR policies that are associated with a template and that define when to run a backup, how frequently to run a backup, and how long to retain the backup image. For example, `onvaults`. + "backupCreateTime": "A String", + "backupTemplate": "A String", + "backupType": "A String", + "host": "A String", + "policies": [ "A String", ], - "policyOptions": [ # The names of Backup and DR advanced policy options of a policy applying to an application. See the [Backup and DR documentation on policy options](https://cloud.google.com/backup-disaster-recovery/docs/create-plan/policy-settings). For example, `skipofflineappsincongrp, nounmap`. + "policyOptions": [ "A String", ], - "profile": "A String", # The name of the Backup and DR resource profile that specifies the storage media for backups of application and VM data. See the [Backup and DR documentation on profiles](https://cloud.google.com/backup-disaster-recovery/docs/concepts/backup-plan#profile). For example, `GCP`. - "storagePool": "A String", # The name of the Backup and DR storage pool that the backup and recovery appliance is storing data in. The storage pool could be of type Cloud, Primary, Snapshot, or OnVault. See the [Backup and DR documentation on storage pools](https://cloud.google.com/backup-disaster-recovery/docs/concepts/storage-pools). For example, `DiskPoolOne`. + "profile": "A String", + "storagePool": "A String", }, - "canonicalName": "A String", # The canonical name of the finding. It's either "organizations/{organization_id}/sources/{source_id}/findings/{finding_id}", "folders/{folder_id}/sources/{source_id}/findings/{finding_id}" or "projects/{project_number}/sources/{source_id}/findings/{finding_id}", depending on the closest CRM ancestor of the resource associated with the finding. - "category": "A String", # The additional taxonomy group within findings from a given source. This field is immutable after creation time. Example: "XSS_FLASH_INJECTION" - "chokepoint": { # Contains details about a chokepoint, which is a resource or resource group where high-risk attack paths converge, based on [attack path simulations] (https://cloud.google.com/security-command-center/docs/attack-exposure-learn#attack_path_simulations). # Contains details about a chokepoint, which is a resource or resource group where high-risk attack paths converge, based on [attack path simulations] (https://cloud.google.com/security-command-center/docs/attack-exposure-learn#attack_path_simulations). This field cannot be updated. Its value is ignored in all update requests. - "relatedFindings": [ # List of resource names of findings associated with this chokepoint. For example, organizations/123/sources/456/findings/789. This list will have at most 100 findings. + "canonicalName": "A String", + "category": "A String", + "chokepoint": { + "relatedFindings": [ "A String", ], }, - "cloudArmor": { # Fields related to Google Cloud Armor findings. # Fields related to Cloud Armor findings. - "adaptiveProtection": { # Information about [Google Cloud Armor Adaptive Protection](https://cloud.google.com/armor/docs/cloud-armor-overview#google-cloud-armor-adaptive-protection). # Information about potential Layer 7 DDoS attacks identified by [Google Cloud Armor Adaptive Protection](https://cloud.google.com/armor/docs/adaptive-protection-overview). - "confidence": 3.14, # A score of 0 means that there is low confidence that the detected event is an actual attack. A score of 1 means that there is high confidence that the detected event is an attack. See the [Adaptive Protection documentation](https://cloud.google.com/armor/docs/adaptive-protection-overview#configure-alert-tuning) for further explanation. + "cloudArmor": { + "adaptiveProtection": { + "confidence": 3.14, }, - "attack": { # Information about DDoS attack volume and classification. # Information about DDoS attack volume and classification. - "classification": "A String", # Type of attack, for example, 'SYN-flood', 'NTP-udp', or 'CHARGEN-udp'. - "volumeBps": 42, # Total BPS (bytes per second) volume of attack. Deprecated - refer to volume_bps_long instead. - "volumeBpsLong": "A String", # Total BPS (bytes per second) volume of attack. - "volumePps": 42, # Total PPS (packets per second) volume of attack. Deprecated - refer to volume_pps_long instead. - "volumePpsLong": "A String", # Total PPS (packets per second) volume of attack. + "attack": { + "classification": "A String", + "volumeBps": 42, + "volumeBpsLong": "A String", + "volumePps": 42, + "volumePpsLong": "A String", }, - "duration": "A String", # Duration of attack from the start until the current moment (updated every 5 minutes). - "requests": { # Information about the requests relevant to the finding. # Information about incoming requests evaluated by [Google Cloud Armor security policies](https://cloud.google.com/armor/docs/security-policy-overview). - "longTermAllowed": 42, # Allowed RPS (requests per second) over the long term. - "longTermDenied": 42, # Denied RPS (requests per second) over the long term. - "ratio": 3.14, # For 'Increasing deny ratio', the ratio is the denied traffic divided by the allowed traffic. For 'Allowed traffic spike', the ratio is the allowed traffic in the short term divided by allowed traffic in the long term. - "shortTermAllowed": 42, # Allowed RPS (requests per second) in the short term. + "duration": "A String", + "requests": { + "longTermAllowed": 42, + "longTermDenied": 42, + "ratio": 3.14, + "shortTermAllowed": 42, }, - "securityPolicy": { # Information about the [Google Cloud Armor security policy](https://cloud.google.com/armor/docs/security-policy-overview) relevant to the finding. # Information about the [Google Cloud Armor security policy](https://cloud.google.com/armor/docs/security-policy-overview) relevant to the finding. - "name": "A String", # The name of the Google Cloud Armor security policy, for example, "my-security-policy". - "preview": True or False, # Whether or not the associated rule or policy is in preview mode. - "type": "A String", # The type of Google Cloud Armor security policy for example, 'backend security policy', 'edge security policy', 'network edge security policy', or 'always-on DDoS protection'. + "securityPolicy": { + "name": "A String", + "preview": True or False, + "type": "A String", }, - "threatVector": "A String", # Distinguish between volumetric & protocol DDoS attack and application layer attacks. For example, "L3_4" for Layer 3 and Layer 4 DDoS attacks, or "L_7" for Layer 7 DDoS attacks. + "threatVector": "A String", }, - "cloudDlpDataProfile": { # The [data profile](https://cloud.google.com/dlp/docs/data-profiles) associated with the finding. # Cloud DLP data profile that is associated with the finding. - "dataProfile": "A String", # Name of the data profile, for example, `projects/123/locations/europe/tableProfiles/8383929`. - "infoTypes": [ # Type of information detected by SDP. Info type includes name, version and sensitivity of the detected information type. - { # Type of information detected by the API. - "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. - "sensitivityScore": { # Score is calculated from of all elements in the data profile. A higher level means the data is more sensitive. # Optional custom sensitivity for this InfoType. This only applies to data profiling. - "score": "A String", # The sensitivity score applied to the resource. + "cloudDlpDataProfile": { + "dataProfile": "A String", + "infoTypes": [ + { + "name": "A String", + "sensitivityScore": { + "score": "A String", }, - "version": "A String", # Optional version name for this InfoType. + "version": "A String", }, ], - "parentType": "A String", # The resource hierarchy level at which the data profile was generated. + "parentType": "A String", }, - "cloudDlpInspection": { # Details about the Cloud Data Loss Prevention (Cloud DLP) [inspection job](https://cloud.google.com/dlp/docs/concepts-job-triggers) that produced the finding. # Cloud Data Loss Prevention (Cloud DLP) inspection results that are associated with the finding. - "fullScan": True or False, # Whether Cloud DLP scanned the complete resource or a sampled subset. - "infoType": "A String", # The type of information (or *[infoType](https://cloud.google.com/dlp/docs/infotypes-reference)*) found, for example, `EMAIL_ADDRESS` or `STREET_ADDRESS`. - "infoTypeCount": "A String", # The number of times Cloud DLP found this infoType within this job and resource. - "inspectJob": "A String", # Name of the inspection job, for example, `projects/123/locations/europe/dlpJobs/i-8383929`. + "cloudDlpInspection": { + "fullScan": True or False, + "infoType": "A String", + "infoTypeCount": "A String", + "inspectJob": "A String", }, - "complianceDetails": { # Compliance Details associated with the finding. # Details about the compliance implications of the finding. - "cloudControl": { # CloudControl associated with the finding. # CloudControl associated with the finding - "cloudControlName": "A String", # Name of the CloudControl associated with the finding. - "policyType": "A String", # Policy type of the CloudControl - "type": "A String", # Type of cloud control. - "version": 42, # Version of the Cloud Control + "complianceDetails": { + "cloudControl": { + "cloudControlName": "A String", + "policyType": "A String", + "type": "A String", + "version": 42, }, - "cloudControlDeploymentNames": [ # Cloud Control Deployments associated with the finding. For example, organizations/123/locations/global/cloudControlDeployments/deploymentIdentifier + "cloudControlDeploymentNames": [ "A String", ], - "frameworks": [ # Details of Frameworks associated with the finding - { # Compliance framework associated with the finding. - "category": [ # Category of the framework associated with the finding. E.g. Security Benchmark, or Assured Workloads + "frameworks": [ + { + "category": [ "A String", ], - "controls": [ # The controls associated with the framework. - { # Compliance control associated with the finding. - "controlName": "A String", # Name of the Control - "displayName": "A String", # Display name of the control. For example, AU-02. + "controls": [ + { + "controlName": "A String", + "displayName": "A String", }, ], - "displayName": "A String", # Display name of the framework. For a standard framework, this will look like e.g. PCI DSS 3.2.1, whereas for a custom framework it can be a user defined string like MyFramework - "name": "A String", # Name of the framework associated with the finding - "type": "A String", # Type of the framework associated with the finding, to specify whether the framework is built-in (pre-defined and immutable) or a custom framework defined by the customer (equivalent to security posture) + "displayName": "A String", + "name": "A String", + "type": "A String", }, ], }, - "compliances": [ # Contains compliance information for security standards associated to the finding. - { # Contains compliance information about a security standard indicating unmet recommendations. - "ids": [ # Policies within the standard or benchmark, for example, A.12.4.1 + "compliances": [ + { + "ids": [ "A String", ], - "standard": "A String", # Industry-wide compliance standards or benchmarks, such as CIS, PCI, and OWASP. - "version": "A String", # Version of the standard or benchmark, for example, 1.1 + "standard": "A String", + "version": "A String", }, ], - "connections": [ # Contains information about the IP connection associated with the finding. - { # Contains information about the IP connection associated with the finding. - "destinationIp": "A String", # Destination IP address. Not present for sockets that are listening and not connected. - "destinationPort": 42, # Destination port. Not present for sockets that are listening and not connected. - "protocol": "A String", # IANA Internet Protocol Number such as TCP(6) and UDP(17). - "sourceIp": "A String", # Source IP address. - "sourcePort": 42, # Source port. + "connections": [ + { + "destinationIp": "A String", + "destinationPort": 42, + "protocol": "A String", + "sourceIp": "A String", + "sourcePort": 42, }, ], - "contacts": { # Output only. Map containing the points of contact for the given finding. The key represents the type of contact, while the value contains a list of all the contacts that pertain. Please refer to: https://cloud.google.com/resource-manager/docs/managing-notification-contacts#notification-categories { "security": { "contacts": [ { "email": "person1@company.com" }, { "email": "person2@company.com" } ] } } - "a_key": { # Details about specific contacts - "contacts": [ # A list of contacts - { # The email address of a contact. - "email": "A String", # An email address. For example, "`person123@company.com`". + "contacts": { + "a_key": { + "contacts": [ + { + "email": "A String", }, ], }, }, - "containers": [ # Containers associated with the finding. This field provides information for both Kubernetes and non-Kubernetes containers. - { # Container associated with the finding. - "createTime": "A String", # The time that the container was created. - "imageId": "A String", # Optional container image ID, if provided by the container runtime. Uniquely identifies the container image launched using a container image digest. - "labels": [ # Container labels, as provided by the container runtime. - { # Represents a generic name-value label. A label has separate name and value fields to support filtering with the `contains()` function. For more information, see [Filtering on array-type fields](https://cloud.google.com/security-command-center/docs/how-to-api-list-findings#array-contains-filtering). - "name": "A String", # Name of the label. - "value": "A String", # Value that corresponds to the label's name. + "containers": [ + { + "createTime": "A String", + "imageId": "A String", + "labels": [ + { + "name": "A String", + "value": "A String", }, ], - "name": "A String", # Name of the container. - "uri": "A String", # Container image URI provided when configuring a pod or container. This string can identify a container image version using mutable tags. + "name": "A String", + "uri": "A String", }, ], - "createTime": "A String", # The time at which the finding was created in Security Command Center. - "dataAccessEvents": [ # Data access events associated with the finding. - { # Details about a data access attempt made by a principal not authorized under applicable data security policy. - "eventId": "A String", # Unique identifier for data access event. - "eventTime": "A String", # Timestamp of data access event. - "operation": "A String", # The operation performed by the principal to access the data. - "principalEmail": "A String", # The email address of the principal that accessed the data. The principal could be a user account, service account, Google group, or other. + "createTime": "A String", + "dataAccessEvents": [ + { + "eventId": "A String", + "eventTime": "A String", + "operation": "A String", + "principalEmail": "A String", }, ], - "dataFlowEvents": [ # Data flow events associated with the finding. - { # Details about a data flow event, in which either the data is moved to or is accessed from a non-compliant geo-location, as defined in the applicable data security policy. - "eventId": "A String", # Unique identifier for data flow event. - "eventTime": "A String", # Timestamp of data flow event. - "operation": "A String", # The operation performed by the principal for the data flow event. - "principalEmail": "A String", # The email address of the principal that initiated the data flow event. The principal could be a user account, service account, Google group, or other. - "violatedLocation": "A String", # Non-compliant location of the principal or the data destination. + "dataFlowEvents": [ + { + "eventId": "A String", + "eventTime": "A String", + "operation": "A String", + "principalEmail": "A String", + "violatedLocation": "A String", }, ], - "dataRetentionDeletionEvents": [ # Data retention deletion events associated with the finding. - { # Details about data retention deletion violations, in which the data is non-compliant based on their retention or deletion time, as defined in the applicable data security policy. The Data Retention Deletion (DRD) control is a control of the DSPM (Data Security Posture Management) suite that enables organizations to manage data retention and deletion policies in compliance with regulations, such as GDPR and CRPA. DRD supports two primary policy types: maximum storage length (max TTL) and minimum storage length (min TTL). Both are aimed at helping organizations meet regulatory and data management commitments. - "dataObjectCount": "A String", # Number of objects that violated the policy for this resource. If the number is less than 1,000, then the value of this field is the exact number. If the number of objects that violated the policy is greater than or equal to 1,000, then the value of this field is 1000. - "eventDetectionTime": "A String", # Timestamp indicating when the event was detected. - "eventType": "A String", # Type of the DRD event. - "maxRetentionAllowed": "A String", # Maximum duration of retention allowed from the DRD control. This comes from the DRD control where users set a max TTL for their data. For example, suppose that a user sets the max TTL for a Cloud Storage bucket to 90 days. However, an object in that bucket is 100 days old. In this case, a DataRetentionDeletionEvent will be generated for that Cloud Storage bucket, and the max_retention_allowed is 90 days. - "minRetentionAllowed": "A String", # Min duration of retention allowed from the DSPM retention control. This field is only populated when event type is set to EVENT_TYPE_MIN_TTL_FROM_CREATION. + "dataRetentionDeletionEvents": [ + { + "dataObjectCount": "A String", + "eventDetectionTime": "A String", + "eventType": "A String", + "maxRetentionAllowed": "A String", + "minRetentionAllowed": "A String", }, ], - "database": { # Represents database access information, such as queries. A database may be a sub-resource of an instance (as in the case of Cloud SQL instances or Cloud Spanner instances), or the database instance itself. Some database resources might not have the [full resource name](https://google.aip.dev/122#full-resource-names) populated because these resource types, such as Cloud SQL databases, are not yet supported by Cloud Asset Inventory. In these cases only the display name is provided. # Database associated with the finding. - "displayName": "A String", # The human-readable name of the database that the user connected to. - "grantees": [ # The target usernames, roles, or groups of an SQL privilege grant, which is not an IAM policy change. + "database": { + "displayName": "A String", + "grantees": [ "A String", ], - "name": "A String", # Some database resources may not have the [full resource name](https://google.aip.dev/122#full-resource-names) populated because these resource types are not yet supported by Cloud Asset Inventory (e.g. Cloud SQL databases). In these cases only the display name will be provided. The [full resource name](https://google.aip.dev/122#full-resource-names) of the database that the user connected to, if it is supported by Cloud Asset Inventory. - "query": "A String", # The SQL statement that is associated with the database access. - "userName": "A String", # The username used to connect to the database. The username might not be an IAM principal and does not have a set format. - "version": "A String", # The version of the database, for example, POSTGRES_14. See [the complete list](https://cloud.google.com/sql/docs/mysql/admin-api/rest/v1/SqlDatabaseVersion). + "name": "A String", + "query": "A String", + "userName": "A String", + "version": "A String", }, - "description": "A String", # Contains more details about the finding. - "discoveredWorkload": { # Represents discovered, customer managed workload that is not registered with the respective GCP service. # DiscoveredWorkload associated with the finding. - "confidence": "A String", # The confidence in detection of this workload. - "detectedRelevantHardware": True or False, # A boolean flag set to true if associated hardware strongly predicts the workload type. - "detectedRelevantKeywords": True or False, # A boolean flag set to true if associated keywords strongly predict the workload type. - "detectedRelevantPackages": True or False, # A boolean flag set to true if installed packages strongly predict the workload type. - "workloadType": "A String", # The type of workload. + "description": "A String", + "discoveredWorkload": { + "confidence": "A String", + "detectedRelevantHardware": True or False, + "detectedRelevantKeywords": True or False, + "detectedRelevantPackages": True or False, + "workloadType": "A String", }, - "disk": { # Contains information about the disk associated with the finding. # Disk associated with the finding. - "name": "A String", # The name of the disk, for example, "https://www.googleapis.com/compute/v1/projects/{project-id}/zones/{zone-id}/disks/{disk-id}". + "disk": { + "name": "A String", }, - "eventTime": "A String", # The time the finding was first detected. If an existing finding is updated, then this is the time the update occurred. For example, if the finding represents an open firewall, this property captures the time the detector believes the firewall became open. The accuracy is determined by the detector. If the finding is later resolved, then this time reflects when the finding was resolved. This must not be set to a value greater than the current timestamp. - "exfiltration": { # Exfiltration represents a data exfiltration attempt from one or more sources to one or more targets. The `sources` attribute lists the sources of the exfiltrated data. The `targets` attribute lists the destinations the data was copied to. # Represents exfiltrations associated with the finding. - "sources": [ # If there are multiple sources, then the data is considered "joined" between them. For instance, BigQuery can join multiple tables, and each table would be considered a source. - { # Resource where data was exfiltrated from or exfiltrated to. - "components": [ # Subcomponents of the asset that was exfiltrated, like URIs used during exfiltration, table names, databases, and filenames. For example, multiple tables might have been exfiltrated from the same Cloud SQL instance, or multiple files might have been exfiltrated from the same Cloud Storage bucket. + "eventTime": "A String", + "exfiltration": { + "sources": [ + { + "components": [ "A String", ], - "name": "A String", # The resource's [full resource name](https://cloud.google.com/apis/design/resource_names#full_resource_name). + "name": "A String", }, ], - "targets": [ # If there are multiple targets, each target would get a complete copy of the "joined" source data. - { # Resource where data was exfiltrated from or exfiltrated to. - "components": [ # Subcomponents of the asset that was exfiltrated, like URIs used during exfiltration, table names, databases, and filenames. For example, multiple tables might have been exfiltrated from the same Cloud SQL instance, or multiple files might have been exfiltrated from the same Cloud Storage bucket. + "targets": [ + { + "components": [ "A String", ], - "name": "A String", # The resource's [full resource name](https://cloud.google.com/apis/design/resource_names#full_resource_name). + "name": "A String", }, ], - "totalExfiltratedBytes": "A String", # Total exfiltrated bytes processed for the entire job. + "totalExfiltratedBytes": "A String", }, - "externalExposure": { # Details about the externally exposed resource associated with the finding. # External exposure associated with the finding. - "backendBucket": "A String", # The full resource name of the load balancer backend bucket, for example, "//compute.googleapis.com/projects/{project-id}/global/backendBuckets/{name}" - "backendService": "A String", # The full resource name of load balancer backend service, for example, "//compute.googleapis.com/projects/{project-id}/global/backendServices/{name}". - "exposedApplication": "A String", # The name and version of the exposed web application, for example, "Jenkins 2.184". - "exposedEndpoint": "A String", # The resource which is running the exposed service, for example, "//compute.googleapis.com/projects/{project-id}/zones/{zone}/instances/{instance}.” - "exposedService": "A String", # The name and version of the service, for example, "Jupyter Notebook 6.14.0". - "forwardingRule": "A String", # The full resource name of the forwarding rule, for example, "//compute.googleapis.com/projects/{project-id}/global/forwardingRules/{forwarding-rule-name}". - "hostnameUri": "A String", # Hostname of the exposed application, for example, "https://test-app.a.run.app/" - "httpResponse": [ # The http response returned by the web application. - { # The http response returned by the web application. - "path": "A String", # The http path for which response code was returned by web application, for example, "https://test-app.a.run.app/test". - "statusCode": "A String", # The http response code returned by the web application, for example, 200. + "externalExposure": { + "backendBucket": "A String", + "backendService": "A String", + "exposedApplication": "A String", + "exposedEndpoint": "A String", + "exposedService": "A String", + "forwardingRule": "A String", + "hostnameUri": "A String", + "httpResponse": [ + { + "path": "A String", + "statusCode": "A String", }, ], - "instanceGroup": "A String", # The full resource name of the instance group, for example, "//compute.googleapis.com/projects/{project-id}/global/instanceGroups/{name}". - "internalBackendService": "A String", # The full resource name of load balancer backend service in the internal project having resource exposed via PSC, for example, "//compute.googleapis.com/projects/{project-id}/global/backendServices/{name}". - "loadBalancerFirewallPolicy": "A String", # The full resource name of the load balancer firewall policy, for example, "//compute.googleapis.com/projects/{project-id}/global/firewallPolicies/{policy-name}". - "networkEndpointGroup": "A String", # The full resource name of the network endpoint group, for example, "//compute.googleapis.com/projects/{project-id}/global/networkEndpointGroups/{name}". - "networkIngressFirewallPolicy": "A String", # The full resource name of the network ingress firewall policy, for example, "//compute.googleapis.com/projects/{project-id}/global/firewallPolicies/{name}". - "privateIpAddress": "A String", # Private IP address of the exposed endpoint. - "privatePort": "A String", # Port number associated with private IP address. - "pscNetworkAttachment": "A String", # The full resource name of the PSC (Private Service Connect) network attachment that network interface controller is attached to, for example, "//compute.googleapis.com/projects/{project-id}/regions/{region}/networkAttachments/{name}" - "pscServiceAttachment": "A String", # The full resource name of the PSC (Private Service Connect) service attachment that the load balancer network endpoint group targets, for example, "//compute.googleapis.com/projects/{project-id}/regions/{region}/serviceAttachments/{name}" - "publicIpAddress": "A String", # Public IP address of the exposed endpoint. - "publicPort": "A String", # Public port number of the exposed endpoint. - "serviceFirewallPolicy": "A String", # The full resource name of the firewall policy of the exposed service, for example, "//compute.googleapis.com/projects/{project-id}/global/firewallPolicies/{policy-name}". + "instanceGroup": "A String", + "internalBackendService": "A String", + "loadBalancerFirewallPolicy": "A String", + "networkEndpointGroup": "A String", + "networkIngressFirewallPolicy": "A String", + "privateIpAddress": "A String", + "privatePort": "A String", + "pscNetworkAttachment": "A String", + "pscServiceAttachment": "A String", + "publicIpAddress": "A String", + "publicPort": "A String", + "serviceFirewallPolicy": "A String", }, - "externalSystems": { # Output only. Third party SIEM/SOAR fields within SCC, contains external system information and external system finding fields. - "a_key": { # Representation of third party SIEM/SOAR fields within SCC. - "assignees": [ # References primary/secondary etc assignees in the external system. + "externalSystems": { + "a_key": { + "assignees": [ "A String", ], - "caseCloseTime": "A String", # The time when the case was closed, as reported by the external system. - "caseCreateTime": "A String", # The time when the case was created, as reported by the external system. - "casePriority": "A String", # The priority of the finding's corresponding case in the external system. - "caseSla": "A String", # The SLA of the finding's corresponding case in the external system. - "caseUri": "A String", # The link to the finding's corresponding case in the external system. - "externalSystemUpdateTime": "A String", # The time when the case was last updated, as reported by the external system. - "externalUid": "A String", # The identifier that's used to track the finding's corresponding case in the external system. - "name": "A String", # Full resource name of the external system, for example: "organizations/1234/sources/5678/findings/123456/externalSystems/jira", "folders/1234/sources/5678/findings/123456/externalSystems/jira", "projects/1234/sources/5678/findings/123456/externalSystems/jira" - "status": "A String", # The most recent status of the finding's corresponding case, as reported by the external system. - "ticketInfo": { # Information about the ticket, if any, that is being used to track the resolution of the issue that is identified by this finding. # Information about the ticket, if any, that is being used to track the resolution of the issue that is identified by this finding. - "assignee": "A String", # The assignee of the ticket in the ticket system. - "description": "A String", # The description of the ticket in the ticket system. - "id": "A String", # The identifier of the ticket in the ticket system. - "status": "A String", # The latest status of the ticket, as reported by the ticket system. - "updateTime": "A String", # The time when the ticket was last updated, as reported by the ticket system. - "uri": "A String", # The link to the ticket in the ticket system. + "caseCloseTime": "A String", + "caseCreateTime": "A String", + "casePriority": "A String", + "caseSla": "A String", + "caseUri": "A String", + "externalSystemUpdateTime": "A String", + "externalUid": "A String", + "name": "A String", + "status": "A String", + "ticketInfo": { + "assignee": "A String", + "description": "A String", + "id": "A String", + "status": "A String", + "updateTime": "A String", + "uri": "A String", }, }, }, - "externalUri": "A String", # The URI that, if available, points to a web page outside of Security Command Center where additional information about the finding can be found. This field is guaranteed to be either empty or a well formed URL. - "files": [ # File associated with the finding. - { # File information about the related binary/library used by an executable, or the script used by a script interpreter - "contents": "A String", # Prefix of the file contents as a JSON-encoded string. - "diskPath": { # Path of the file in terms of underlying disk/partition identifiers. # Path of the file in terms of underlying disk/partition identifiers. - "partitionUuid": "A String", # UUID of the partition (format https://wiki.archlinux.org/title/persistent_block_device_naming#by-uuid) - "relativePath": "A String", # Relative path of the file in the partition as a JSON encoded string. Example: /home/user1/executable_file.sh + "externalUri": "A String", + "files": [ + { + "contents": "A String", + "diskPath": { + "partitionUuid": "A String", + "relativePath": "A String", }, - "fileLoadState": "A String", # The load state of the file. - "hashedSize": "A String", # The length in bytes of the file prefix that was hashed. If hashed_size == size, any hashes reported represent the entire file. - "operations": [ # Operation(s) performed on a file. - { # Operation(s) performed on a file. - "type": "A String", # The type of the operation + "fileLoadState": "A String", + "hashedSize": "A String", + "operations": [ + { + "type": "A String", }, ], - "partiallyHashed": True or False, # True when the hash covers only a prefix of the file. - "path": "A String", # Absolute path of the file as a JSON encoded string. - "sha256": "A String", # SHA256 hash of the first hashed_size bytes of the file encoded as a hex string. If hashed_size == size, sha256 represents the SHA256 hash of the entire file. - "size": "A String", # Size of the file in bytes. + "partiallyHashed": True or False, + "path": "A String", + "sha256": "A String", + "size": "A String", }, ], - "findingClass": "A String", # The class of the finding. - "groupMemberships": [ # Contains details about groups of which this finding is a member. A group is a collection of findings that are related in some way. This field cannot be updated. Its value is ignored in all update requests. - { # Contains details about groups of which this finding is a member. A group is a collection of findings that are related in some way. - "groupId": "A String", # ID of the group. - "groupType": "A String", # Type of group. + "findingClass": "A String", + "groupMemberships": [ + { + "groupId": "A String", + "groupType": "A String", }, ], - "iamBindings": [ # Represents IAM bindings associated with the finding. - { # Represents a particular IAM binding, which captures a member's role addition, removal, or state. - "action": "A String", # The action that was performed on a Binding. - "member": "A String", # A single identity requesting access for a Cloud Platform resource, for example, "foo@google.com". - "role": "A String", # Role that is assigned to "members". For example, "roles/viewer", "roles/editor", or "roles/owner". + "iamBindings": [ + { + "action": "A String", + "member": "A String", + "role": "A String", }, ], - "indicator": { # Represents what's commonly known as an _indicator of compromise_ (IoC) in computer forensics. This is an artifact observed on a network or in an operating system that, with high confidence, indicates a computer intrusion. For more information, see [Indicator of compromise](https://en.wikipedia.org/wiki/Indicator_of_compromise). # Represents what's commonly known as an *indicator of compromise* (IoC) in computer forensics. This is an artifact observed on a network or in an operating system that, with high confidence, indicates a computer intrusion. For more information, see [Indicator of compromise](https://en.wikipedia.org/wiki/Indicator_of_compromise). - "domains": [ # List of domains associated to the Finding. + "indicator": { + "domains": [ "A String", ], - "ipAddresses": [ # The list of IP addresses that are associated with the finding. + "ipAddresses": [ "A String", ], - "signatures": [ # The list of matched signatures indicating that the given process is present in the environment. - { # Indicates what signature matched this process. - "memoryHashSignature": { # A signature corresponding to memory page hashes. # Signature indicating that a binary family was matched. - "binaryFamily": "A String", # The binary family. - "detections": [ # The list of memory hash detections contributing to the binary family match. - { # Memory hash detection contributing to the binary family match. - "binary": "A String", # The name of the binary associated with the memory hash signature detection. - "percentPagesMatched": 3.14, # The percentage of memory page hashes in the signature that were matched. + "signatures": [ + { + "memoryHashSignature": { + "binaryFamily": "A String", + "detections": [ + { + "binary": "A String", + "percentPagesMatched": 3.14, }, ], }, - "signatureType": "A String", # Describes the type of resource associated with the signature. - "yaraRuleSignature": { # A signature corresponding to a YARA rule. # Signature indicating that a YARA rule was matched. - "yaraRule": "A String", # The name of the YARA rule. + "signatureType": "A String", + "yaraRuleSignature": { + "yaraRule": "A String", }, }, ], - "uris": [ # The list of URIs associated to the Findings. + "uris": [ "A String", ], }, - "ipRules": { # IP rules associated with the finding. # IP rules associated with the finding. - "allowed": { # Allowed IP rule. # Tuple with allowed rules. - "ipRules": [ # Optional. Optional list of allowed IP rules. - { # IP rule information. - "portRanges": [ # Optional. An optional list of ports to which this rule applies. This field is only applicable for the UDP or (S)TCP protocols. Each entry must be either an integer or a range including a min and max port number. - { # A port range which is inclusive of the min and max values. Values are between 0 and 2^16-1. The max can be equal / must be not smaller than the min value. If min and max are equal this indicates that it is a single port. - "max": "A String", # Maximum port value. - "min": "A String", # Minimum port value. + "ipRules": { + "allowed": { + "ipRules": [ + { + "portRanges": [ + { + "max": "A String", + "min": "A String", }, ], - "protocol": "A String", # The IP protocol this rule applies to. This value can either be one of the following well known protocol strings (TCP, UDP, ICMP, ESP, AH, IPIP, SCTP) or a string representation of the integer value. + "protocol": "A String", }, ], }, - "denied": { # Denied IP rule. # Tuple with denied rules. - "ipRules": [ # Optional. Optional list of denied IP rules. - { # IP rule information. - "portRanges": [ # Optional. An optional list of ports to which this rule applies. This field is only applicable for the UDP or (S)TCP protocols. Each entry must be either an integer or a range including a min and max port number. - { # A port range which is inclusive of the min and max values. Values are between 0 and 2^16-1. The max can be equal / must be not smaller than the min value. If min and max are equal this indicates that it is a single port. - "max": "A String", # Maximum port value. - "min": "A String", # Minimum port value. + "denied": { + "ipRules": [ + { + "portRanges": [ + { + "max": "A String", + "min": "A String", }, ], - "protocol": "A String", # The IP protocol this rule applies to. This value can either be one of the following well known protocol strings (TCP, UDP, ICMP, ESP, AH, IPIP, SCTP) or a string representation of the integer value. + "protocol": "A String", }, ], }, - "destinationIpRanges": [ # If destination IP ranges are specified, the firewall rule applies only to traffic that has a destination IP address in these ranges. These ranges must be expressed in CIDR format. Only supports IPv4. + "destinationIpRanges": [ "A String", ], - "direction": "A String", # The direction that the rule is applicable to, one of ingress or egress. - "exposedServices": [ # Name of the network protocol service, such as FTP, that is exposed by the open port. Follows the naming convention available at: https://www.iana.org/assignments/service-names-port-numbers/service-names-port-numbers.xhtml. + "direction": "A String", + "exposedServices": [ "A String", ], - "sourceIpRanges": [ # If source IP ranges are specified, the firewall rule applies only to traffic that has a source IP address in these ranges. These ranges must be expressed in CIDR format. Only supports IPv4. + "sourceIpRanges": [ "A String", ], }, - "job": { # Describes a job # Job associated with the finding. - "errorCode": 42, # Optional. If the job did not complete successfully, this field describes why. - "location": "A String", # Optional. Gives the location where the job ran, such as `US` or `europe-west1` - "name": "A String", # The fully-qualified name for a job. e.g. `projects//jobs/` - "state": "A String", # Output only. State of the job, such as `RUNNING` or `PENDING`. + "job": { + "errorCode": 42, + "location": "A String", + "name": "A String", + "state": "A String", }, - "kernelRootkit": { # Kernel mode rootkit signatures. # Signature of the kernel rootkit. - "name": "A String", # Rootkit name, when available. - "unexpectedCodeModification": True or False, # True if unexpected modifications of kernel code memory are present. - "unexpectedFtraceHandler": True or False, # True if `ftrace` points are present with callbacks pointing to regions that are not in the expected kernel or module code range. - "unexpectedInterruptHandler": True or False, # True if interrupt handlers that are are not in the expected kernel or module code regions are present. - "unexpectedKernelCodePages": True or False, # True if kernel code pages that are not in the expected kernel or module code regions are present. - "unexpectedKprobeHandler": True or False, # True if `kprobe` points are present with callbacks pointing to regions that are not in the expected kernel or module code range. - "unexpectedProcessesInRunqueue": True or False, # True if unexpected processes in the scheduler run queue are present. Such processes are in the run queue, but not in the process task list. - "unexpectedReadOnlyDataModification": True or False, # True if unexpected modifications of kernel read-only data memory are present. - "unexpectedSystemCallHandler": True or False, # True if system call handlers that are are not in the expected kernel or module code regions are present. + "kernelRootkit": { + "name": "A String", + "unexpectedCodeModification": True or False, + "unexpectedFtraceHandler": True or False, + "unexpectedInterruptHandler": True or False, + "unexpectedKernelCodePages": True or False, + "unexpectedKprobeHandler": True or False, + "unexpectedProcessesInRunqueue": True or False, + "unexpectedReadOnlyDataModification": True or False, + "unexpectedSystemCallHandler": True or False, }, - "kubernetes": { # Kubernetes-related attributes. # Kubernetes resources associated with the finding. - "accessReviews": [ # Provides information on any Kubernetes access reviews (privilege checks) relevant to the finding. - { # Conveys information about a Kubernetes access review (such as one returned by a [`kubectl auth can-i`](https://kubernetes.io/docs/reference/access-authn-authz/authorization/#checking-api-access) command) that was involved in a finding. - "group": "A String", # The API group of the resource. "*" means all. - "name": "A String", # The name of the resource being requested. Empty means all. - "ns": "A String", # Namespace of the action being requested. Currently, there is no distinction between no namespace and all namespaces. Both are represented by "" (empty). - "resource": "A String", # The optional resource type requested. "*" means all. - "subresource": "A String", # The optional subresource type. - "verb": "A String", # A Kubernetes resource API verb, like get, list, watch, create, update, delete, proxy. "*" means all. - "version": "A String", # The API version of the resource. "*" means all. + "kubernetes": { + "accessReviews": [ + { + "group": "A String", + "name": "A String", + "ns": "A String", + "resource": "A String", + "subresource": "A String", + "verb": "A String", + "version": "A String", }, ], - "bindings": [ # Provides Kubernetes role binding information for findings that involve [RoleBindings or ClusterRoleBindings](https://cloud.google.com/kubernetes-engine/docs/how-to/role-based-access-control). - { # Represents a Kubernetes RoleBinding or ClusterRoleBinding. - "name": "A String", # Name for the binding. - "ns": "A String", # Namespace for the binding. - "role": { # Kubernetes Role or ClusterRole. # The Role or ClusterRole referenced by the binding. - "kind": "A String", # Role type. - "name": "A String", # Role name. - "ns": "A String", # Role namespace. + "bindings": [ + { + "name": "A String", + "ns": "A String", + "role": { + "kind": "A String", + "name": "A String", + "ns": "A String", }, - "subjects": [ # Represents one or more subjects that are bound to the role. Not always available for PATCH requests. - { # Represents a Kubernetes subject. - "kind": "A String", # Authentication type for the subject. - "name": "A String", # Name for the subject. - "ns": "A String", # Namespace for the subject. + "subjects": [ + { + "kind": "A String", + "name": "A String", + "ns": "A String", }, ], }, ], - "nodePools": [ # GKE [node pools](https://cloud.google.com/kubernetes-engine/docs/concepts/node-pools) associated with the finding. This field contains node pool information for each node, when it is available. - { # Provides GKE node pool information. - "name": "A String", # Kubernetes node pool name. - "nodes": [ # Nodes associated with the finding. - { # Kubernetes nodes associated with the finding. - "name": "A String", # [Full resource name](https://google.aip.dev/122#full-resource-names) of the Compute Engine VM running the cluster node. + "nodePools": [ + { + "name": "A String", + "nodes": [ + { + "name": "A String", }, ], }, ], - "nodes": [ # Provides Kubernetes [node](https://cloud.google.com/kubernetes-engine/docs/concepts/cluster-architecture#nodes) information. - { # Kubernetes nodes associated with the finding. - "name": "A String", # [Full resource name](https://google.aip.dev/122#full-resource-names) of the Compute Engine VM running the cluster node. + "nodes": [ + { + "name": "A String", }, ], - "objects": [ # Kubernetes objects related to the finding. - { # Kubernetes object related to the finding, uniquely identified by GKNN. Used if the object Kind is not one of Pod, Node, NodePool, Binding, or AccessReview. - "containers": [ # Pod containers associated with this finding, if any. - { # Container associated with the finding. - "createTime": "A String", # The time that the container was created. - "imageId": "A String", # Optional container image ID, if provided by the container runtime. Uniquely identifies the container image launched using a container image digest. - "labels": [ # Container labels, as provided by the container runtime. - { # Represents a generic name-value label. A label has separate name and value fields to support filtering with the `contains()` function. For more information, see [Filtering on array-type fields](https://cloud.google.com/security-command-center/docs/how-to-api-list-findings#array-contains-filtering). - "name": "A String", # Name of the label. - "value": "A String", # Value that corresponds to the label's name. + "objects": [ + { + "containers": [ + { + "createTime": "A String", + "imageId": "A String", + "labels": [ + { + "name": "A String", + "value": "A String", }, ], - "name": "A String", # Name of the container. - "uri": "A String", # Container image URI provided when configuring a pod or container. This string can identify a container image version using mutable tags. + "name": "A String", + "uri": "A String", }, ], - "group": "A String", # Kubernetes object group, such as "policy.k8s.io/v1". - "kind": "A String", # Kubernetes object kind, such as "Namespace". - "name": "A String", # Kubernetes object name. For details see https://kubernetes.io/docs/concepts/overview/working-with-objects/names/. - "ns": "A String", # Kubernetes object namespace. Must be a valid DNS label. Named "ns" to avoid collision with C++ namespace keyword. For details see https://kubernetes.io/docs/tasks/administer-cluster/namespaces/. + "group": "A String", + "kind": "A String", + "name": "A String", + "ns": "A String", }, ], - "pods": [ # Kubernetes [Pods](https://cloud.google.com/kubernetes-engine/docs/concepts/pod) associated with the finding. This field contains Pod records for each container that is owned by a Pod. - { # A Kubernetes Pod. - "containers": [ # Pod containers associated with this finding, if any. - { # Container associated with the finding. - "createTime": "A String", # The time that the container was created. - "imageId": "A String", # Optional container image ID, if provided by the container runtime. Uniquely identifies the container image launched using a container image digest. - "labels": [ # Container labels, as provided by the container runtime. - { # Represents a generic name-value label. A label has separate name and value fields to support filtering with the `contains()` function. For more information, see [Filtering on array-type fields](https://cloud.google.com/security-command-center/docs/how-to-api-list-findings#array-contains-filtering). - "name": "A String", # Name of the label. - "value": "A String", # Value that corresponds to the label's name. + "pods": [ + { + "containers": [ + { + "createTime": "A String", + "imageId": "A String", + "labels": [ + { + "name": "A String", + "value": "A String", }, ], - "name": "A String", # Name of the container. - "uri": "A String", # Container image URI provided when configuring a pod or container. This string can identify a container image version using mutable tags. + "name": "A String", + "uri": "A String", }, ], - "labels": [ # Pod labels. For Kubernetes containers, these are applied to the container. - { # Represents a generic name-value label. A label has separate name and value fields to support filtering with the `contains()` function. For more information, see [Filtering on array-type fields](https://cloud.google.com/security-command-center/docs/how-to-api-list-findings#array-contains-filtering). - "name": "A String", # Name of the label. - "value": "A String", # Value that corresponds to the label's name. + "labels": [ + { + "name": "A String", + "value": "A String", }, ], - "name": "A String", # Kubernetes Pod name. - "ns": "A String", # Kubernetes Pod namespace. + "name": "A String", + "ns": "A String", }, ], - "roles": [ # Provides Kubernetes role information for findings that involve [Roles or ClusterRoles](https://cloud.google.com/kubernetes-engine/docs/how-to/role-based-access-control). - { # Kubernetes Role or ClusterRole. - "kind": "A String", # Role type. - "name": "A String", # Role name. - "ns": "A String", # Role namespace. + "roles": [ + { + "kind": "A String", + "name": "A String", + "ns": "A String", }, ], }, - "loadBalancers": [ # The load balancers associated with the finding. - { # Contains information related to the load balancer associated with the finding. - "name": "A String", # The name of the load balancer associated with the finding. + "loadBalancers": [ + { + "name": "A String", }, ], - "logEntries": [ # Log entries that are relevant to the finding. - { # An individual entry in a log. - "cloudLoggingEntry": { # Metadata taken from a [Cloud Logging LogEntry](https://cloud.google.com/logging/docs/reference/v2/rest/v2/LogEntry) # An individual entry in a log stored in Cloud Logging. - "insertId": "A String", # A unique identifier for the log entry. - "logId": "A String", # The type of the log (part of `log_name`. `log_name` is the resource name of the log to which this log entry belongs). For example: `cloudresourcemanager.googleapis.com/activity`. Note that this field is not URL-encoded, unlike the `LOG_ID` field in `LogEntry`. - "resourceContainer": "A String", # The organization, folder, or project of the monitored resource that produced this log entry. - "timestamp": "A String", # The time the event described by the log entry occurred. + "logEntries": [ + { + "cloudLoggingEntry": { + "insertId": "A String", + "logId": "A String", + "resourceContainer": "A String", + "timestamp": "A String", }, }, ], - "mitreAttack": { # MITRE ATT&CK tactics and techniques related to this finding. See: https://attack.mitre.org # MITRE ATT&CK tactics and techniques related to this finding. See: https://attack.mitre.org - "additionalTactics": [ # Additional MITRE ATT&CK tactics related to this finding, if any. + "mitreAttack": { + "additionalTactics": [ "A String", ], - "additionalTechniques": [ # Additional MITRE ATT&CK techniques related to this finding, if any, along with any of their respective parent techniques. + "additionalTechniques": [ "A String", ], - "primaryTactic": "A String", # The MITRE ATT&CK tactic most closely represented by this finding, if any. - "primaryTechniques": [ # The MITRE ATT&CK technique most closely represented by this finding, if any. primary_techniques is a repeated field because there are multiple levels of MITRE ATT&CK techniques. If the technique most closely represented by this finding is a sub-technique (e.g. `SCANNING_IP_BLOCKS`), both the sub-technique and its parent technique(s) will be listed (e.g. `SCANNING_IP_BLOCKS`, `ACTIVE_SCANNING`). + "primaryTactic": "A String", + "primaryTechniques": [ "A String", ], - "version": "A String", # The MITRE ATT&CK version referenced by the above fields. E.g. "8". + "version": "A String", }, - "moduleName": "A String", # Unique identifier of the module which generated the finding. Example: folders/598186756061/securityHealthAnalyticsSettings/customModules/56799441161885 - "mute": "A String", # Indicates the mute state of a finding (either muted, unmuted or undefined). Unlike other attributes of a finding, a finding provider shouldn't set the value of mute. - "muteInfo": { # Mute information about the finding, including whether the finding has a static mute or any matching dynamic mute rules. # Output only. The mute information regarding this finding. - "dynamicMuteRecords": [ # The list of dynamic mute rules that currently match the finding. - { # The record of a dynamic mute rule that matches the finding. - "matchTime": "A String", # When the dynamic mute rule first matched the finding. - "muteConfig": "A String", # The relative resource name of the mute rule, represented by a mute config, that created this record, for example `organizations/123/muteConfigs/mymuteconfig` or `organizations/123/locations/global/muteConfigs/mymuteconfig`. + "moduleName": "A String", + "mute": "A String", + "muteInfo": { + "dynamicMuteRecords": [ + { + "matchTime": "A String", + "muteConfig": "A String", }, ], - "staticMute": { # Information about the static mute state. A static mute state overrides any dynamic mute rules that apply to this finding. The static mute state can be set by a static mute rule or by muting the finding directly. # If set, the static mute applied to this finding. Static mutes override dynamic mutes. If unset, there is no static mute. - "applyTime": "A String", # When the static mute was applied. - "state": "A String", # The static mute state. If the value is `MUTED` or `UNMUTED`, then the finding's overall mute state will have the same value. + "staticMute": { + "applyTime": "A String", + "state": "A String", }, }, - "muteInitiator": "A String", # Records additional information about the mute operation, for example, the [mute configuration](/security-command-center/docs/how-to-mute-findings) that muted the finding and the user who muted the finding. - "muteUpdateTime": "A String", # Output only. The most recent time this finding was muted or unmuted. - "name": "A String", # The [relative resource name](https://cloud.google.com/apis/design/resource_names#relative_resource_name) of the finding. Example: "organizations/{organization_id}/sources/{source_id}/findings/{finding_id}", "folders/{folder_id}/sources/{source_id}/findings/{finding_id}", "projects/{project_id}/sources/{source_id}/findings/{finding_id}". - "networks": [ # Represents the VPC networks that the resource is attached to. - { # Contains information about a VPC network associated with the finding. - "name": "A String", # The name of the VPC network resource, for example, `//compute.googleapis.com/projects/my-project/global/networks/my-network`. + "muteInitiator": "A String", + "muteUpdateTime": "A String", + "name": "A String", + "networks": [ + { + "name": "A String", }, ], - "nextSteps": "A String", # Steps to address the finding. - "notebook": { # Represents a Jupyter notebook IPYNB file, such as a [Colab Enterprise notebook](https://cloud.google.com/colab/docs/introduction) file, that is associated with a finding. # Notebook associated with the finding. - "lastAuthor": "A String", # The user ID of the latest author to modify the notebook. - "name": "A String", # The name of the notebook. - "notebookUpdateTime": "A String", # The most recent time the notebook was updated. - "service": "A String", # The source notebook service, for example, "Colab Enterprise". + "nextSteps": "A String", + "notebook": { + "lastAuthor": "A String", + "name": "A String", + "notebookUpdateTime": "A String", + "service": "A String", }, - "orgPolicies": [ # Contains information about the org policies associated with the finding. - { # Contains information about the org policies associated with the finding. - "name": "A String", # The resource name of the org policy. Example: "organizations/{organization_id}/policies/{constraint_name}" + "orgPolicies": [ + { + "name": "A String", }, ], - "parent": "A String", # The relative resource name of the source the finding belongs to. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name This field is immutable after creation time. For example: "organizations/{organization_id}/sources/{source_id}" - "parentDisplayName": "A String", # Output only. The human readable display name of the finding source such as "Event Threat Detection" or "Security Health Analytics". - "policyViolationSummary": { # Metadata summarizing policy violations of child resources of the affected resource. `finding_category` and `resource` determine the exact semantics of the counts. For example, when category=DATA_SECURITY_POSTURE_OBJECT_PUBLIC_ACCESS_VIOLATION and resource='storage.googleapis.com/buckets/my-bucket-name' then this counts the number of Cloud Storage objects in my-bucket-name which violate a Public Access control. # PolicyViolationSummary associated with the finding. - "conformantResourcesCount": "A String", # Total number of child resources that conform to the policy. - "evaluationErrorsCount": "A String", # Number of child resources for which errors during evaluation occurred. The evaluation result for these child resources is effectively "unknown". - "outOfScopeResourcesCount": "A String", # Total count of child resources which were not in scope for evaluation. - "policyViolationsCount": "A String", # Count of child resources in violation of the policy. + "parent": "A String", + "parentDisplayName": "A String", + "policyViolationSummary": { + "conformantResourcesCount": "A String", + "evaluationErrorsCount": "A String", + "outOfScopeResourcesCount": "A String", + "policyViolationsCount": "A String", }, - "processes": [ # Represents operating system processes associated with the Finding. - { # Represents an operating system process. - "args": [ # Process arguments as JSON encoded strings. + "processes": [ + { + "args": [ "A String", ], - "argumentsTruncated": True or False, # True if `args` is incomplete. - "binary": { # File information about the related binary/library used by an executable, or the script used by a script interpreter # File information for the process executable. - "contents": "A String", # Prefix of the file contents as a JSON-encoded string. - "diskPath": { # Path of the file in terms of underlying disk/partition identifiers. # Path of the file in terms of underlying disk/partition identifiers. - "partitionUuid": "A String", # UUID of the partition (format https://wiki.archlinux.org/title/persistent_block_device_naming#by-uuid) - "relativePath": "A String", # Relative path of the file in the partition as a JSON encoded string. Example: /home/user1/executable_file.sh + "argumentsTruncated": True or False, + "binary": { + "contents": "A String", + "diskPath": { + "partitionUuid": "A String", + "relativePath": "A String", }, - "fileLoadState": "A String", # The load state of the file. - "hashedSize": "A String", # The length in bytes of the file prefix that was hashed. If hashed_size == size, any hashes reported represent the entire file. - "operations": [ # Operation(s) performed on a file. - { # Operation(s) performed on a file. - "type": "A String", # The type of the operation + "fileLoadState": "A String", + "hashedSize": "A String", + "operations": [ + { + "type": "A String", }, ], - "partiallyHashed": True or False, # True when the hash covers only a prefix of the file. - "path": "A String", # Absolute path of the file as a JSON encoded string. - "sha256": "A String", # SHA256 hash of the first hashed_size bytes of the file encoded as a hex string. If hashed_size == size, sha256 represents the SHA256 hash of the entire file. - "size": "A String", # Size of the file in bytes. + "partiallyHashed": True or False, + "path": "A String", + "sha256": "A String", + "size": "A String", }, - "envVariables": [ # Process environment variables. - { # A name-value pair representing an environment variable used in an operating system process. - "name": "A String", # Environment variable name as a JSON encoded string. - "val": "A String", # Environment variable value as a JSON encoded string. + "envVariables": [ + { + "name": "A String", + "val": "A String", }, ], - "envVariablesTruncated": True or False, # True if `env_variables` is incomplete. - "libraries": [ # File information for libraries loaded by the process. - { # File information about the related binary/library used by an executable, or the script used by a script interpreter - "contents": "A String", # Prefix of the file contents as a JSON-encoded string. - "diskPath": { # Path of the file in terms of underlying disk/partition identifiers. # Path of the file in terms of underlying disk/partition identifiers. - "partitionUuid": "A String", # UUID of the partition (format https://wiki.archlinux.org/title/persistent_block_device_naming#by-uuid) - "relativePath": "A String", # Relative path of the file in the partition as a JSON encoded string. Example: /home/user1/executable_file.sh + "envVariablesTruncated": True or False, + "libraries": [ + { + "contents": "A String", + "diskPath": { + "partitionUuid": "A String", + "relativePath": "A String", }, - "fileLoadState": "A String", # The load state of the file. - "hashedSize": "A String", # The length in bytes of the file prefix that was hashed. If hashed_size == size, any hashes reported represent the entire file. - "operations": [ # Operation(s) performed on a file. - { # Operation(s) performed on a file. - "type": "A String", # The type of the operation + "fileLoadState": "A String", + "hashedSize": "A String", + "operations": [ + { + "type": "A String", }, ], - "partiallyHashed": True or False, # True when the hash covers only a prefix of the file. - "path": "A String", # Absolute path of the file as a JSON encoded string. - "sha256": "A String", # SHA256 hash of the first hashed_size bytes of the file encoded as a hex string. If hashed_size == size, sha256 represents the SHA256 hash of the entire file. - "size": "A String", # Size of the file in bytes. + "partiallyHashed": True or False, + "path": "A String", + "sha256": "A String", + "size": "A String", }, ], - "name": "A String", # The process name, as displayed in utilities like `top` and `ps`. This name can be accessed through `/proc/[pid]/comm` and changed with `prctl(PR_SET_NAME)`. - "parentPid": "A String", # The parent process ID. - "pid": "A String", # The process ID. - "script": { # File information about the related binary/library used by an executable, or the script used by a script interpreter # When the process represents the invocation of a script, `binary` provides information about the interpreter, while `script` provides information about the script file provided to the interpreter. - "contents": "A String", # Prefix of the file contents as a JSON-encoded string. - "diskPath": { # Path of the file in terms of underlying disk/partition identifiers. # Path of the file in terms of underlying disk/partition identifiers. - "partitionUuid": "A String", # UUID of the partition (format https://wiki.archlinux.org/title/persistent_block_device_naming#by-uuid) - "relativePath": "A String", # Relative path of the file in the partition as a JSON encoded string. Example: /home/user1/executable_file.sh + "name": "A String", + "parentPid": "A String", + "pid": "A String", + "script": { + "contents": "A String", + "diskPath": { + "partitionUuid": "A String", + "relativePath": "A String", }, - "fileLoadState": "A String", # The load state of the file. - "hashedSize": "A String", # The length in bytes of the file prefix that was hashed. If hashed_size == size, any hashes reported represent the entire file. - "operations": [ # Operation(s) performed on a file. - { # Operation(s) performed on a file. - "type": "A String", # The type of the operation + "fileLoadState": "A String", + "hashedSize": "A String", + "operations": [ + { + "type": "A String", }, ], - "partiallyHashed": True or False, # True when the hash covers only a prefix of the file. - "path": "A String", # Absolute path of the file as a JSON encoded string. - "sha256": "A String", # SHA256 hash of the first hashed_size bytes of the file encoded as a hex string. If hashed_size == size, sha256 represents the SHA256 hash of the entire file. - "size": "A String", # Size of the file in bytes. + "partiallyHashed": True or False, + "path": "A String", + "sha256": "A String", + "size": "A String", }, - "userId": "A String", # The ID of the user that executed the process. E.g. If this is the root user this will always be 0. + "userId": "A String", }, ], - "resourceName": "A String", # For findings on Google Cloud resources, the full resource name of the Google Cloud resource this finding is for. See: https://cloud.google.com/apis/design/resource_names#full_resource_name When the finding is for a non-Google Cloud resource, the resourceName can be a customer or partner defined string. This field is immutable after creation time. - "secret": { # Details about a secret or credential associated with the finding. # Secret associated with the finding. - "environmentVariable": { # Environment variable containing the secret. # The environment variable containing the secret. - "key": "A String", # Environment variable name as a JSON encoded string. Note that value is not included since the value contains the secret data, which is sensitive core content. + "resourceName": "A String", + "secret": { + "environmentVariable": { + "key": "A String", }, - "filePath": { # File path containing the secret. # The file containing the secret. - "path": "A String", # Path to the file. + "filePath": { + "path": "A String", }, - "status": { # The status of the secret. # The status of the secret. - "lastUpdatedTime": "A String", # Time that the secret was found. - "validity": "A String", # The validity of the secret. + "status": { + "lastUpdatedTime": "A String", + "validity": "A String", }, - "type": "A String", # The type of secret, for example, GCP_API_KEY. + "type": "A String", }, - "securityMarks": { # User specified security marks that are attached to the parent Security Command Center resource. Security marks are scoped within a Security Command Center organization -- they can be modified and viewed by all users who have proper permissions on the organization. # Output only. User specified security marks. These marks are entirely managed by the user and come from the SecurityMarks resource that belongs to the finding. - "canonicalName": "A String", # The canonical name of the marks. Examples: "organizations/{organization_id}/assets/{asset_id}/securityMarks" "folders/{folder_id}/assets/{asset_id}/securityMarks" "projects/{project_number}/assets/{asset_id}/securityMarks" "organizations/{organization_id}/sources/{source_id}/findings/{finding_id}/securityMarks" "folders/{folder_id}/sources/{source_id}/findings/{finding_id}/securityMarks" "projects/{project_number}/sources/{source_id}/findings/{finding_id}/securityMarks" - "marks": { # Mutable user specified security marks belonging to the parent resource. Constraints are as follows: * Keys and values are treated as case insensitive * Keys must be between 1 - 256 characters (inclusive) * Keys must be letters, numbers, underscores, or dashes * Values have leading and trailing whitespace trimmed, remaining characters must be between 1 - 4096 characters (inclusive) + "securityMarks": { + "canonicalName": "A String", + "marks": { "a_key": "A String", }, - "name": "A String", # The relative resource name of the SecurityMarks. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Examples: "organizations/{organization_id}/assets/{asset_id}/securityMarks" "organizations/{organization_id}/sources/{source_id}/findings/{finding_id}/securityMarks". + "name": "A String", }, - "securityPosture": { # Represents a posture that is deployed on Google Cloud by the Security Command Center Posture Management service. A posture contains one or more policy sets. A policy set is a group of policies that enforce a set of security rules on Google Cloud. # The security posture associated with the finding. - "changedPolicy": "A String", # The name of the updated policy, for example, `projects/{project_id}/policies/{constraint_name}`. - "name": "A String", # Name of the posture, for example, `CIS-Posture`. - "policy": "A String", # The ID of the updated policy, for example, `compute-policy-1`. - "policyDriftDetails": [ # The details about a change in an updated policy that violates the deployed posture. - { # The policy field that violates the deployed posture and its expected and detected values. - "detectedValue": "A String", # The detected value that violates the deployed posture, for example, `false` or `allowed_values={"projects/22831892"}`. - "expectedValue": "A String", # The value of this field that was configured in a posture, for example, `true` or `allowed_values={"projects/29831892"}`. - "field": "A String", # The name of the updated field, for example constraint.implementation.policy_rules[0].enforce + "securityPosture": { + "changedPolicy": "A String", + "name": "A String", + "policy": "A String", + "policyDriftDetails": [ + { + "detectedValue": "A String", + "expectedValue": "A String", + "field": "A String", }, ], - "policySet": "A String", # The name of the updated policyset, for example, `cis-policyset`. - "postureDeployment": "A String", # The name of the posture deployment, for example, `organizations/{org_id}/posturedeployments/{posture_deployment_id}`. - "postureDeploymentResource": "A String", # The project, folder, or organization on which the posture is deployed, for example, `projects/{project_number}`. - "revisionId": "A String", # The version of the posture, for example, `c7cfa2a8`. + "policySet": "A String", + "postureDeployment": "A String", + "postureDeploymentResource": "A String", + "revisionId": "A String", }, - "severity": "A String", # The severity of the finding. This field is managed by the source that writes the finding. - "sourceProperties": { # Source specific properties. These properties are managed by the source that writes the finding. The key names in the source_properties map must be between 1 and 255 characters, and must start with a letter and contain alphanumeric characters or underscores only. + "severity": "A String", + "sourceProperties": { "a_key": "", }, - "state": "A String", # The state of the finding. - "toxicCombination": { # Contains details about a group of security issues that, when the issues occur together, represent a greater risk than when the issues occur independently. A group of such issues is referred to as a toxic combination. # Contains details about a group of security issues that, when the issues occur together, represent a greater risk than when the issues occur independently. A group of such issues is referred to as a toxic combination. This field cannot be updated. Its value is ignored in all update requests. - "attackExposureScore": 3.14, # The [Attack exposure score](https://cloud.google.com/security-command-center/docs/attack-exposure-learn#attack_exposure_scores) of this toxic combination. The score is a measure of how much this toxic combination exposes one or more high-value resources to potential attack. - "relatedFindings": [ # List of resource names of findings associated with this toxic combination. For example, `organizations/123/sources/456/findings/789`. + "state": "A String", + "toxicCombination": { + "attackExposureScore": 3.14, + "relatedFindings": [ "A String", ], }, - "vertexAi": { # Vertex AI-related information associated with the finding. # VertexAi associated with the finding. - "datasets": [ # Datasets associated with the finding. - { # Vertex AI dataset associated with the finding. - "displayName": "A String", # The user defined display name of dataset, e.g. plants-dataset - "name": "A String", # Resource name of the dataset, e.g. projects/{project}/locations/{location}/datasets/2094040236064505856 - "source": "A String", # Data source, such as BigQuery source URI, e.g. bq://scc-nexus-test.AIPPtest.gsod + "vertexAi": { + "datasets": [ + { + "displayName": "A String", + "name": "A String", + "source": "A String", }, ], - "pipelines": [ # Pipelines associated with the finding. - { # Vertex AI training pipeline associated with the finding. - "displayName": "A String", # The user defined display name of pipeline, e.g. plants-classification - "name": "A String", # Resource name of the pipeline, e.g. projects/{project}/locations/{location}/trainingPipelines/5253428229225578496 + "pipelines": [ + { + "displayName": "A String", + "name": "A String", }, ], }, - "vulnerability": { # Refers to common vulnerability fields e.g. cve, cvss, cwe etc. # Represents vulnerability-specific fields like CVE and CVSS scores. CVE stands for Common Vulnerabilities and Exposures (https://cve.mitre.org/about/) - "cve": { # CVE stands for Common Vulnerabilities and Exposures. Information from the [CVE record](https://www.cve.org/ResourcesSupport/Glossary) that describes this vulnerability. # CVE stands for Common Vulnerabilities and Exposures (https://cve.mitre.org/about/) - "cvssv3": { # Common Vulnerability Scoring System version 3. # Describe Common Vulnerability Scoring System specified at https://www.first.org/cvss/v3.1/specification-document - "attackComplexity": "A String", # This metric describes the conditions beyond the attacker's control that must exist in order to exploit the vulnerability. - "attackVector": "A String", # Base Metrics Represents the intrinsic characteristics of a vulnerability that are constant over time and across user environments. This metric reflects the context by which vulnerability exploitation is possible. - "availabilityImpact": "A String", # This metric measures the impact to the availability of the impacted component resulting from a successfully exploited vulnerability. - "baseScore": 3.14, # The base score is a function of the base metric scores. - "confidentialityImpact": "A String", # This metric measures the impact to the confidentiality of the information resources managed by a software component due to a successfully exploited vulnerability. - "integrityImpact": "A String", # This metric measures the impact to integrity of a successfully exploited vulnerability. - "privilegesRequired": "A String", # This metric describes the level of privileges an attacker must possess before successfully exploiting the vulnerability. - "scope": "A String", # The Scope metric captures whether a vulnerability in one vulnerable component impacts resources in components beyond its security scope. - "userInteraction": "A String", # This metric captures the requirement for a human user, other than the attacker, to participate in the successful compromise of the vulnerable component. + "vulnerability": { + "cve": { + "cvssv3": { + "attackComplexity": "A String", + "attackVector": "A String", + "availabilityImpact": "A String", + "baseScore": 3.14, + "confidentialityImpact": "A String", + "integrityImpact": "A String", + "privilegesRequired": "A String", + "scope": "A String", + "userInteraction": "A String", }, - "exploitReleaseDate": "A String", # Date the first publicly available exploit or PoC was released. - "exploitationActivity": "A String", # The exploitation activity of the vulnerability in the wild. - "firstExploitationDate": "A String", # Date of the earliest known exploitation. - "id": "A String", # The unique identifier for the vulnerability. e.g. CVE-2021-34527 - "impact": "A String", # The potential impact of the vulnerability if it was to be exploited. - "observedInTheWild": True or False, # Whether or not the vulnerability has been observed in the wild. - "references": [ # Additional information about the CVE. e.g. https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2021-34527 - { # Additional Links - "source": "A String", # Source of the reference e.g. NVD - "uri": "A String", # Uri for the mentioned source e.g. https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2021-34527. + "exploitReleaseDate": "A String", + "exploitationActivity": "A String", + "firstExploitationDate": "A String", + "id": "A String", + "impact": "A String", + "observedInTheWild": True or False, + "references": [ + { + "source": "A String", + "uri": "A String", }, ], - "upstreamFixAvailable": True or False, # Whether upstream fix is available for the CVE. - "zeroDay": True or False, # Whether or not the vulnerability was zero day when the finding was published. + "upstreamFixAvailable": True or False, + "zeroDay": True or False, }, - "cwes": [ # Represents one or more Common Weakness Enumeration (CWE) information on this vulnerability. - { # CWE stands for Common Weakness Enumeration. Information about this weakness, as described by [CWE](https://cwe.mitre.org/). - "id": "A String", # The CWE identifier, e.g. CWE-94 - "references": [ # Any reference to the details on the CWE, for example, https://cwe.mitre.org/data/definitions/94.html - { # Additional Links - "source": "A String", # Source of the reference e.g. NVD - "uri": "A String", # Uri for the mentioned source e.g. https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2021-34527. + "cwes": [ + { + "id": "A String", + "references": [ + { + "source": "A String", + "uri": "A String", }, ], }, ], - "fixedPackage": { # Package is a generic definition of a package. # The fixed package is relevant to the finding. - "cpeUri": "A String", # The CPE URI where the vulnerability was detected. - "packageName": "A String", # The name of the package where the vulnerability was detected. - "packageType": "A String", # Type of package, for example, os, maven, or go. - "packageVersion": "A String", # The version of the package. + "fixedPackage": { + "cpeUri": "A String", + "packageName": "A String", + "packageType": "A String", + "packageVersion": "A String", }, - "offendingPackage": { # Package is a generic definition of a package. # The offending package is relevant to the finding. - "cpeUri": "A String", # The CPE URI where the vulnerability was detected. - "packageName": "A String", # The name of the package where the vulnerability was detected. - "packageType": "A String", # Type of package, for example, os, maven, or go. - "packageVersion": "A String", # The version of the package. + "offendingPackage": { + "cpeUri": "A String", + "packageName": "A String", + "packageType": "A String", + "packageVersion": "A String", }, - "providerRiskScore": "A String", # Provider provided risk_score based on multiple factors. The higher the risk score, the more risky the vulnerability is. - "reachable": True or False, # Represents whether the vulnerability is reachable (detected via static analysis) - "securityBulletin": { # SecurityBulletin are notifications of vulnerabilities of Google products. # The security bulletin is relevant to this finding. - "bulletinId": "A String", # ID of the bulletin corresponding to the vulnerability. - "submissionTime": "A String", # Submission time of this Security Bulletin. - "suggestedUpgradeVersion": "A String", # This represents a version that the cluster receiving this notification should be upgraded to, based on its current version. For example, 1.15.0 + "providerRiskScore": "A String", + "reachable": True or False, + "securityBulletin": { + "bulletinId": "A String", + "submissionTime": "A String", + "suggestedUpgradeVersion": "A String", }, }, }, - "noViolation": { # 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); } # Indicates that the test case does not trigger any violation. + "noViolation": { }, }, }
diff --git a/docs/dyn/securitycenter_v1.folders.securityHealthAnalyticsSettings.effectiveCustomModules.html b/docs/dyn/securitycenter_v1.folders.securityHealthAnalyticsSettings.effectiveCustomModules.html index e2e1bd1c3a..eb54e5d1a8 100644 --- a/docs/dyn/securitycenter_v1.folders.securityHealthAnalyticsSettings.effectiveCustomModules.html +++ b/docs/dyn/securitycenter_v1.folders.securityHealthAnalyticsSettings.effectiveCustomModules.html @@ -79,10 +79,10 @@

Instance Methods

Close httplib2 connections.

get(name, x__xgafv=None)

-

Retrieves an EffectiveSecurityHealthAnalyticsCustomModule.

+

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

-

Returns a list of all EffectiveSecurityHealthAnalyticsCustomModules for the given parent. This includes resident modules defined at the scope of the parent, and inherited modules, inherited from CRM ancestors.

+

list_next()

Retrieves the next page of results.

@@ -94,10 +94,10 @@

Method Details

get(name, x__xgafv=None) -
Retrieves an EffectiveSecurityHealthAnalyticsCustomModule.
+  
 
 Args:
-  name: string, Required. Name of the effective custom module to get. Its format is `organizations/{organization}/securityHealthAnalyticsSettings/effectiveCustomModules/{customModule}`, `folders/{folder}/securityHealthAnalyticsSettings/effectiveCustomModules/{customModule}`, or `projects/{project}/securityHealthAnalyticsSettings/effectiveCustomModules/{customModule}` (required)
+  name: string, A parameter (required)
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -106,51 +106,51 @@ 

Method Details

Returns: An object of the form: - { # An EffectiveSecurityHealthAnalyticsCustomModule is the representation of a Security Health Analytics custom module at a specified level of the resource hierarchy: organization, folder, or project. If a custom module is inherited from a parent organization or folder, the value of the `enablementState` property in EffectiveSecurityHealthAnalyticsCustomModule is set to the value that is effective in the parent, instead of `INHERITED`. For example, if the module is enabled in a parent organization or folder, the effective enablement_state for the module in all child folders or projects is also `enabled`. EffectiveSecurityHealthAnalyticsCustomModule is read-only. - "cloudProvider": "A String", # The cloud provider of the custom module. - "customConfig": { # Defines the properties in a custom module configuration for Security Health Analytics. Use the custom module configuration to create custom detectors that generate custom findings for resources that you specify. # Output only. The user-specified configuration for the module. - "customOutput": { # A set of optional name-value pairs that define custom source properties to return with each finding that is generated by the custom module. The custom source properties that are defined here are included in the finding JSON under `sourceProperties`. # Custom output properties. - "properties": [ # A list of custom output properties to add to the finding. - { # An individual name-value pair that defines a custom source property. - "name": "A String", # Name of the property for the custom output. - "valueExpression": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The CEL expression for the custom output. A resource property can be specified to return the value of the property or a text string enclosed in quotation marks. - "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. - "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. - "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file. - "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. + { + "cloudProvider": "A String", + "customConfig": { + "customOutput": { + "properties": [ + { + "name": "A String", + "valueExpression": { + "description": "A String", + "expression": "A String", + "location": "A String", + "title": "A String", }, }, ], }, - "description": "A String", # Text that describes the vulnerability or misconfiguration that the custom module detects. This explanation is returned with each finding instance to help investigators understand the detected issue. The text must be enclosed in quotation marks. - "predicate": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The CEL expression to evaluate to produce findings. When the expression evaluates to true against a resource, a finding is generated. - "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. - "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. - "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file. - "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. + "description": "A String", + "predicate": { + "description": "A String", + "expression": "A String", + "location": "A String", + "title": "A String", }, - "recommendation": "A String", # An explanation of the recommended steps that security teams can take to resolve the detected issue. This explanation is returned with each finding generated by this module in the `nextSteps` property of the finding JSON. - "resourceSelector": { # Resource for selecting resource type. # The resource types that the custom module operates on. Each custom module can specify up to 5 resource types. - "resourceTypes": [ # The resource types to run the detector on. + "recommendation": "A String", + "resourceSelector": { + "resourceTypes": [ "A String", ], }, - "severity": "A String", # The severity to assign to findings generated by the module. + "severity": "A String", }, - "displayName": "A String", # Output only. The display name for the custom module. The name must be between 1 and 128 characters, start with a lowercase letter, and contain alphanumeric characters or underscores only. - "enablementState": "A String", # Output only. The effective state of enablement for the module at the given level of the hierarchy. - "name": "A String", # Output only. The resource name of the custom module. Its format is "organizations/{organization}/securityHealthAnalyticsSettings/effectiveCustomModules/{customModule}", or "folders/{folder}/securityHealthAnalyticsSettings/effectiveCustomModules/{customModule}", or "projects/{project}/securityHealthAnalyticsSettings/effectiveCustomModules/{customModule}" + "displayName": "A String", + "enablementState": "A String", + "name": "A String", }
list(parent, pageSize=None, pageToken=None, x__xgafv=None) -
Returns a list of all EffectiveSecurityHealthAnalyticsCustomModules for the given parent. This includes resident modules defined at the scope of the parent, and inherited modules, inherited from CRM ancestors.
+  
 
 Args:
-  parent: string, Required. Name of parent to list effective custom modules. Its format is `organizations/{organization}/securityHealthAnalyticsSettings`, `folders/{folder}/securityHealthAnalyticsSettings`, or `projects/{project}/securityHealthAnalyticsSettings` (required)
-  pageSize: integer, The maximum number of results to return in a single response. Default is 10, minimum is 1, maximum is 1000.
-  pageToken: string, The value returned by the last call indicating a continuation
+  parent: string, A parameter (required)
+  pageSize: integer, A parameter
+  pageToken: string, A parameter
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -159,45 +159,45 @@ 

Method Details

Returns: An object of the form: - { # Response message for listing effective Security Health Analytics custom modules. - "effectiveSecurityHealthAnalyticsCustomModules": [ # Effective custom modules belonging to the requested parent. - { # An EffectiveSecurityHealthAnalyticsCustomModule is the representation of a Security Health Analytics custom module at a specified level of the resource hierarchy: organization, folder, or project. If a custom module is inherited from a parent organization or folder, the value of the `enablementState` property in EffectiveSecurityHealthAnalyticsCustomModule is set to the value that is effective in the parent, instead of `INHERITED`. For example, if the module is enabled in a parent organization or folder, the effective enablement_state for the module in all child folders or projects is also `enabled`. EffectiveSecurityHealthAnalyticsCustomModule is read-only. - "cloudProvider": "A String", # The cloud provider of the custom module. - "customConfig": { # Defines the properties in a custom module configuration for Security Health Analytics. Use the custom module configuration to create custom detectors that generate custom findings for resources that you specify. # Output only. The user-specified configuration for the module. - "customOutput": { # A set of optional name-value pairs that define custom source properties to return with each finding that is generated by the custom module. The custom source properties that are defined here are included in the finding JSON under `sourceProperties`. # Custom output properties. - "properties": [ # A list of custom output properties to add to the finding. - { # An individual name-value pair that defines a custom source property. - "name": "A String", # Name of the property for the custom output. - "valueExpression": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The CEL expression for the custom output. A resource property can be specified to return the value of the property or a text string enclosed in quotation marks. - "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. - "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. - "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file. - "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. + { + "effectiveSecurityHealthAnalyticsCustomModules": [ + { + "cloudProvider": "A String", + "customConfig": { + "customOutput": { + "properties": [ + { + "name": "A String", + "valueExpression": { + "description": "A String", + "expression": "A String", + "location": "A String", + "title": "A String", }, }, ], }, - "description": "A String", # Text that describes the vulnerability or misconfiguration that the custom module detects. This explanation is returned with each finding instance to help investigators understand the detected issue. The text must be enclosed in quotation marks. - "predicate": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The CEL expression to evaluate to produce findings. When the expression evaluates to true against a resource, a finding is generated. - "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. - "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. - "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file. - "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. + "description": "A String", + "predicate": { + "description": "A String", + "expression": "A String", + "location": "A String", + "title": "A String", }, - "recommendation": "A String", # An explanation of the recommended steps that security teams can take to resolve the detected issue. This explanation is returned with each finding generated by this module in the `nextSteps` property of the finding JSON. - "resourceSelector": { # Resource for selecting resource type. # The resource types that the custom module operates on. Each custom module can specify up to 5 resource types. - "resourceTypes": [ # The resource types to run the detector on. + "recommendation": "A String", + "resourceSelector": { + "resourceTypes": [ "A String", ], }, - "severity": "A String", # The severity to assign to findings generated by the module. + "severity": "A String", }, - "displayName": "A String", # Output only. The display name for the custom module. The name must be between 1 and 128 characters, start with a lowercase letter, and contain alphanumeric characters or underscores only. - "enablementState": "A String", # Output only. The effective state of enablement for the module at the given level of the hierarchy. - "name": "A String", # Output only. The resource name of the custom module. Its format is "organizations/{organization}/securityHealthAnalyticsSettings/effectiveCustomModules/{customModule}", or "folders/{folder}/securityHealthAnalyticsSettings/effectiveCustomModules/{customModule}", or "projects/{project}/securityHealthAnalyticsSettings/effectiveCustomModules/{customModule}" + "displayName": "A String", + "enablementState": "A String", + "name": "A String", }, ], - "nextPageToken": "A String", # If not empty, indicates that there may be more effective custom modules to be returned. + "nextPageToken": "A String", }
diff --git a/docs/dyn/securitycenter_v1.folders.sources.findings.externalSystems.html b/docs/dyn/securitycenter_v1.folders.sources.findings.externalSystems.html index 4a60c15add..4c0571cadc 100644 --- a/docs/dyn/securitycenter_v1.folders.sources.findings.externalSystems.html +++ b/docs/dyn/securitycenter_v1.folders.sources.findings.externalSystems.html @@ -79,7 +79,7 @@

Instance Methods

Close httplib2 connections.

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

-

Updates external system. This is for a given finding.

+

Method Details

close() @@ -88,37 +88,37 @@

Method Details

patch(name, body=None, updateMask=None, x__xgafv=None) -
Updates external system. This is for a given finding.
+  
 
 Args:
-  name: string, Full resource name of the external system, for example: "organizations/1234/sources/5678/findings/123456/externalSystems/jira", "folders/1234/sources/5678/findings/123456/externalSystems/jira", "projects/1234/sources/5678/findings/123456/externalSystems/jira" (required)
+  name: string, A parameter (required)
   body: object, The request body.
     The object takes the form of:
 
-{ # Representation of third party SIEM/SOAR fields within SCC.
-  "assignees": [ # References primary/secondary etc assignees in the external system.
+{
+  "assignees": [
     "A String",
   ],
-  "caseCloseTime": "A String", # The time when the case was closed, as reported by the external system.
-  "caseCreateTime": "A String", # The time when the case was created, as reported by the external system.
-  "casePriority": "A String", # The priority of the finding's corresponding case in the external system.
-  "caseSla": "A String", # The SLA of the finding's corresponding case in the external system.
-  "caseUri": "A String", # The link to the finding's corresponding case in the external system.
-  "externalSystemUpdateTime": "A String", # The time when the case was last updated, as reported by the external system.
-  "externalUid": "A String", # The identifier that's used to track the finding's corresponding case in the external system.
-  "name": "A String", # Full resource name of the external system, for example: "organizations/1234/sources/5678/findings/123456/externalSystems/jira", "folders/1234/sources/5678/findings/123456/externalSystems/jira", "projects/1234/sources/5678/findings/123456/externalSystems/jira"
-  "status": "A String", # The most recent status of the finding's corresponding case, as reported by the external system.
-  "ticketInfo": { # Information about the ticket, if any, that is being used to track the resolution of the issue that is identified by this finding. # Information about the ticket, if any, that is being used to track the resolution of the issue that is identified by this finding.
-    "assignee": "A String", # The assignee of the ticket in the ticket system.
-    "description": "A String", # The description of the ticket in the ticket system.
-    "id": "A String", # The identifier of the ticket in the ticket system.
-    "status": "A String", # The latest status of the ticket, as reported by the ticket system.
-    "updateTime": "A String", # The time when the ticket was last updated, as reported by the ticket system.
-    "uri": "A String", # The link to the ticket in the ticket system.
+  "caseCloseTime": "A String",
+  "caseCreateTime": "A String",
+  "casePriority": "A String",
+  "caseSla": "A String",
+  "caseUri": "A String",
+  "externalSystemUpdateTime": "A String",
+  "externalUid": "A String",
+  "name": "A String",
+  "status": "A String",
+  "ticketInfo": {
+    "assignee": "A String",
+    "description": "A String",
+    "id": "A String",
+    "status": "A String",
+    "updateTime": "A String",
+    "uri": "A String",
   },
 }
 
-  updateMask: string, The FieldMask to use when updating the external system resource. If empty all mutable fields will be updated.
+  updateMask: string, A parameter
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -127,26 +127,26 @@ 

Method Details

Returns: An object of the form: - { # Representation of third party SIEM/SOAR fields within SCC. - "assignees": [ # References primary/secondary etc assignees in the external system. + { + "assignees": [ "A String", ], - "caseCloseTime": "A String", # The time when the case was closed, as reported by the external system. - "caseCreateTime": "A String", # The time when the case was created, as reported by the external system. - "casePriority": "A String", # The priority of the finding's corresponding case in the external system. - "caseSla": "A String", # The SLA of the finding's corresponding case in the external system. - "caseUri": "A String", # The link to the finding's corresponding case in the external system. - "externalSystemUpdateTime": "A String", # The time when the case was last updated, as reported by the external system. - "externalUid": "A String", # The identifier that's used to track the finding's corresponding case in the external system. - "name": "A String", # Full resource name of the external system, for example: "organizations/1234/sources/5678/findings/123456/externalSystems/jira", "folders/1234/sources/5678/findings/123456/externalSystems/jira", "projects/1234/sources/5678/findings/123456/externalSystems/jira" - "status": "A String", # The most recent status of the finding's corresponding case, as reported by the external system. - "ticketInfo": { # Information about the ticket, if any, that is being used to track the resolution of the issue that is identified by this finding. # Information about the ticket, if any, that is being used to track the resolution of the issue that is identified by this finding. - "assignee": "A String", # The assignee of the ticket in the ticket system. - "description": "A String", # The description of the ticket in the ticket system. - "id": "A String", # The identifier of the ticket in the ticket system. - "status": "A String", # The latest status of the ticket, as reported by the ticket system. - "updateTime": "A String", # The time when the ticket was last updated, as reported by the ticket system. - "uri": "A String", # The link to the ticket in the ticket system. + "caseCloseTime": "A String", + "caseCreateTime": "A String", + "casePriority": "A String", + "caseSla": "A String", + "caseUri": "A String", + "externalSystemUpdateTime": "A String", + "externalUid": "A String", + "name": "A String", + "status": "A String", + "ticketInfo": { + "assignee": "A String", + "description": "A String", + "id": "A String", + "status": "A String", + "updateTime": "A String", + "uri": "A String", }, }
diff --git a/docs/dyn/securitycenter_v1.folders.sources.findings.html b/docs/dyn/securitycenter_v1.folders.sources.findings.html index 9abb5dcc95..cfb6f3bf6d 100644 --- a/docs/dyn/securitycenter_v1.folders.sources.findings.html +++ b/docs/dyn/securitycenter_v1.folders.sources.findings.html @@ -84,28 +84,28 @@

Instance Methods

Close httplib2 connections.

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

-

Filters an organization or source's findings and groups them by their specified properties. To group across all sources provide a `-` as the source id. Example: /v1/organizations/{organization_id}/sources/-/findings, /v1/folders/{folder_id}/sources/-/findings, /v1/projects/{project_id}/sources/-/findings

+

group_next()

Retrieves the next page of results.

list(parent, compareDuration=None, fieldMask=None, filter=None, orderBy=None, pageSize=None, pageToken=None, readTime=None, x__xgafv=None)

-

Lists an organization or source's findings. To list across all sources provide a `-` as the source id. Example: /v1/organizations/{organization_id}/sources/-/findings

+

list_next()

Retrieves the next page of results.

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

-

Creates or updates a finding. The corresponding source must exist for a finding creation to succeed.

+

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

-

Updates the mute state of a finding.

+

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

-

Updates the state of a finding.

+

updateSecurityMarks(name, body=None, startTime=None, updateMask=None, x__xgafv=None)

-

Updates security marks.

+

Method Details

close() @@ -114,20 +114,20 @@

Method Details

group(parent, body=None, x__xgafv=None) -
Filters an organization or source's findings and groups them by their specified properties. To group across all sources provide a `-` as the source id. Example: /v1/organizations/{organization_id}/sources/-/findings, /v1/folders/{folder_id}/sources/-/findings, /v1/projects/{project_id}/sources/-/findings
+  
 
 Args:
-  parent: string, Required. Name of the source to groupBy. Its format is `organizations/[organization_id]/sources/[source_id]`, `folders/[folder_id]/sources/[source_id]`, or `projects/[project_id]/sources/[source_id]`. To groupBy across all sources provide a source_id of `-`. For example: `organizations/{organization_id}/sources/-, folders/{folder_id}/sources/-`, or `projects/{project_id}/sources/-` (required)
+  parent: string, A parameter (required)
   body: object, The request body.
     The object takes the form of:
 
-{ # Request message for grouping by findings.
-  "compareDuration": "A String", # When compare_duration is set, the GroupResult's "state_change" attribute is updated to indicate whether the finding had its state changed, the finding's state remained unchanged, or if the finding was added during the compare_duration period of time that precedes the read_time. This is the time between (read_time - compare_duration) and read_time. The state_change value is derived based on the presence and state of the finding at the two points in time. Intermediate state changes between the two times don't affect the result. For example, the results aren't affected if the finding is made inactive and then active again. Possible "state_change" values when compare_duration is specified: * "CHANGED": indicates that the finding was present and matched the given filter at the start of compare_duration, but changed its state at read_time. * "UNCHANGED": indicates that the finding was present and matched the given filter at the start of compare_duration and did not change state at read_time. * "ADDED": indicates that the finding did not match the given filter or was not present at the start of compare_duration, but was present at read_time. * "REMOVED": indicates that the finding was present and matched the filter at the start of compare_duration, but did not match the filter at read_time. If compare_duration is not specified, then the only possible state_change is "UNUSED", which will be the state_change set for all findings present at read_time. If this field is set then `state_change` must be a specified field in `group_by`.
-  "filter": "A String", # Expression that defines the filter to apply across findings. The expression is a list of one or more restrictions combined via logical operators `AND` and `OR`. Parentheses are supported, and `OR` has higher precedence than `AND`. Restrictions have the form ` ` and may have a `-` character in front of them to indicate negation. Examples include: * name * source_properties.a_property * security_marks.marks.marka The supported operators are: * `=` for all value types. * `>`, `<`, `>=`, `<=` for integer values. * `:`, meaning substring matching, for strings. The supported value types are: * string literals in quotes. * integer literals without quotes. * boolean literals `true` and `false` without quotes. The following field and operator combinations are supported: * name: `=` * parent: `=`, `:` * resource_name: `=`, `:` * state: `=`, `:` * category: `=`, `:` * external_uri: `=`, `:` * event_time: `=`, `>`, `<`, `>=`, `<=` Usage: This should be milliseconds since epoch or an RFC3339 string. Examples: `event_time = "2019-06-10T16:07:18-07:00"` `event_time = 1560208038000` * severity: `=`, `:` * workflow_state: `=`, `:` * security_marks.marks: `=`, `:` * source_properties: `=`, `:`, `>`, `<`, `>=`, `<=` For example, `source_properties.size = 100` is a valid filter string. Use a partial match on the empty string to filter based on a property existing: `source_properties.my_property : ""` Use a negated partial match on the empty string to filter based on a property not existing: `-source_properties.my_property : ""` * resource: * resource.name: `=`, `:` * resource.parent_name: `=`, `:` * resource.parent_display_name: `=`, `:` * resource.project_name: `=`, `:` * resource.project_display_name: `=`, `:` * resource.type: `=`, `:`
-  "groupBy": "A String", # Required. Expression that defines what assets fields to use for grouping (including `state_change`). The string value should follow SQL syntax: comma separated list of fields. For example: "parent,resource_name". The following fields are supported when compare_duration is set: * state_change
-  "pageSize": 42, # The maximum number of results to return in a single response. Default is 10, minimum is 1, maximum is 1000.
-  "pageToken": "A String", # The value returned by the last `GroupFindingsResponse`; indicates that this is a continuation of a prior `GroupFindings` call, and that the system should return the next page of data.
-  "readTime": "A String", # Time used as a reference point when filtering findings. The filter is limited to findings existing at the supplied time and their values are those at that specific time. Absence of this field will default to the API's version of NOW.
+{
+  "compareDuration": "A String",
+  "filter": "A String",
+  "groupBy": "A String",
+  "pageSize": 42,
+  "pageToken": "A String",
+  "readTime": "A String",
 }
 
   x__xgafv: string, V1 error format.
@@ -138,18 +138,18 @@ 

Method Details

Returns: An object of the form: - { # Response message for group by findings. - "groupByResults": [ # Group results. There exists an element for each existing unique combination of property/values. The element contains a count for the number of times those specific property/values appear. - { # Result containing the properties and count of a groupBy request. - "count": "A String", # Total count of resources for the given properties. - "properties": { # Properties matching the groupBy fields in the request. + { + "groupByResults": [ + { + "count": "A String", + "properties": { "a_key": "", }, }, ], - "nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no more results. - "readTime": "A String", # Time used for executing the groupBy request. - "totalSize": 42, # The total number of results matching the query. + "nextPageToken": "A String", + "readTime": "A String", + "totalSize": 42, }
@@ -169,17 +169,17 @@

Method Details

list(parent, compareDuration=None, fieldMask=None, filter=None, orderBy=None, pageSize=None, pageToken=None, readTime=None, x__xgafv=None) -
Lists an organization or source's findings. To list across all sources provide a `-` as the source id. Example: /v1/organizations/{organization_id}/sources/-/findings
+  
 
 Args:
-  parent: string, Required. Name of the source the findings belong to. Its format is `organizations/[organization_id]/sources/[source_id]`, `folders/[folder_id]/sources/[source_id]`, or `projects/[project_id]/sources/[source_id]`. To list across all sources provide a source_id of `-`. For example: `organizations/{organization_id}/sources/-`, `folders/{folder_id}/sources/-` or `projects/{projects_id}/sources/-` (required)
-  compareDuration: string, When compare_duration is set, the ListFindingsResult's "state_change" attribute is updated to indicate whether the finding had its state changed, the finding's state remained unchanged, or if the finding was added in any state during the compare_duration period of time that precedes the read_time. This is the time between (read_time - compare_duration) and read_time. The state_change value is derived based on the presence and state of the finding at the two points in time. Intermediate state changes between the two times don't affect the result. For example, the results aren't affected if the finding is made inactive and then active again. Possible "state_change" values when compare_duration is specified: * "CHANGED": indicates that the finding was present and matched the given filter at the start of compare_duration, but changed its state at read_time. * "UNCHANGED": indicates that the finding was present and matched the given filter at the start of compare_duration and did not change state at read_time. * "ADDED": indicates that the finding did not match the given filter or was not present at the start of compare_duration, but was present at read_time. * "REMOVED": indicates that the finding was present and matched the filter at the start of compare_duration, but did not match the filter at read_time. If compare_duration is not specified, then the only possible state_change is "UNUSED", which will be the state_change set for all findings present at read_time.
-  fieldMask: string, A field mask to specify the Finding fields to be listed in the response. An empty field mask will list all fields.
-  filter: string, Expression that defines the filter to apply across findings. The expression is a list of one or more restrictions combined via logical operators `AND` and `OR`. Parentheses are supported, and `OR` has higher precedence than `AND`. Restrictions have the form ` ` and may have a `-` character in front of them to indicate negation. Examples include: * name * source_properties.a_property * security_marks.marks.marka The supported operators are: * `=` for all value types. * `>`, `<`, `>=`, `<=` for integer values. * `:`, meaning substring matching, for strings. The supported value types are: * string literals in quotes. * integer literals without quotes. * boolean literals `true` and `false` without quotes. The following field and operator combinations are supported: * name: `=` * parent: `=`, `:` * resource_name: `=`, `:` * state: `=`, `:` * category: `=`, `:` * external_uri: `=`, `:` * event_time: `=`, `>`, `<`, `>=`, `<=` Usage: This should be milliseconds since epoch or an RFC3339 string. Examples: `event_time = "2019-06-10T16:07:18-07:00"` `event_time = 1560208038000` * severity: `=`, `:` * workflow_state: `=`, `:` * security_marks.marks: `=`, `:` * source_properties: `=`, `:`, `>`, `<`, `>=`, `<=` For example, `source_properties.size = 100` is a valid filter string. Use a partial match on the empty string to filter based on a property existing: `source_properties.my_property : ""` Use a negated partial match on the empty string to filter based on a property not existing: `-source_properties.my_property : ""` * resource: * resource.name: `=`, `:` * resource.parent_name: `=`, `:` * resource.parent_display_name: `=`, `:` * resource.project_name: `=`, `:` * resource.project_display_name: `=`, `:` * resource.type: `=`, `:` * resource.folders.resource_folder: `=`, `:` * resource.display_name: `=`, `:`
-  orderBy: string, Expression that defines what fields and order to use for sorting. The string value should follow SQL syntax: comma separated list of fields. For example: "name,resource_properties.a_property". The default sorting order is ascending. To specify descending order for a field, a suffix " desc" should be appended to the field name. For example: "name desc,source_properties.a_property". Redundant space characters in the syntax are insignificant. "name desc,source_properties.a_property" and " name desc , source_properties.a_property " are equivalent. The following fields are supported: name parent state category resource_name event_time source_properties security_marks.marks
-  pageSize: integer, The maximum number of results to return in a single response. Default is 10, minimum is 1, maximum is 1000.
-  pageToken: string, The value returned by the last `ListFindingsResponse`; indicates that this is a continuation of a prior `ListFindings` call, and that the system should return the next page of data.
-  readTime: string, Time used as a reference point when filtering findings. The filter is limited to findings existing at the supplied time and their values are those at that specific time. Absence of this field will default to the API's version of NOW.
+  parent: string, A parameter (required)
+  compareDuration: string, A parameter
+  fieldMask: string, A parameter
+  filter: string, A parameter
+  orderBy: string, A parameter
+  pageSize: integer, A parameter
+  pageToken: string, A parameter
+  readTime: string, A parameter
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -188,945 +188,945 @@ 

Method Details

Returns: An object of the form: - { # Response message for listing findings. - "listFindingsResults": [ # Findings matching the list request. - { # Result containing the Finding and its StateChange. - "finding": { # Security Command Center finding. A finding is a record of assessment data like security, risk, health, or privacy, that is ingested into Security Command Center for presentation, notification, analysis, policy testing, and enforcement. For example, a cross-site scripting (XSS) vulnerability in an App Engine application is a finding. # Finding matching the search request. - "access": { # Represents an access event. # Access details associated with the finding, such as more information on the caller, which method was accessed, and from where. - "callerIp": "A String", # Caller's IP address, such as "1.1.1.1". - "callerIpGeo": { # Represents a geographical location for a given access. # The caller IP's geolocation, which identifies where the call came from. - "regionCode": "A String", # A CLDR. + { + "listFindingsResults": [ + { + "finding": { + "access": { + "callerIp": "A String", + "callerIpGeo": { + "regionCode": "A String", }, - "methodName": "A String", # The method that the service account called, e.g. "SetIamPolicy". - "principalEmail": "A String", # Associated email, such as "foo@google.com". The email address of the authenticated user or a service account acting on behalf of a 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). - "principalSubject": "A String", # A string that represents the principal_subject that is associated with the identity. Unlike `principal_email`, `principal_subject` supports principals that aren't associated with email addresses, such as third party principals. For most identities, the format is `principal://iam.googleapis.com/{identity pool name}/subject/{subject}`. Some GKE identities, such as GKE_WORKLOAD, FREEFORM, and GKE_HUB_WORKLOAD, still use the legacy format `serviceAccount:{identity pool name}[{subject}]`. - "serviceAccountDelegationInfo": [ # The identity delegation history of an authenticated service account that made the request. The `serviceAccountDelegationInfo[]` object contains information about the real authorities that try to access Google Cloud resources by delegating on a service account. When multiple authorities are present, they are guaranteed to be sorted based on the original ordering of the identity delegation events. - { # Identity delegation history of an authenticated service account. - "principalEmail": "A String", # The email address of a Google account. - "principalSubject": "A String", # A string representing the principal_subject associated with the identity. As compared to `principal_email`, supports principals that aren't associated with email addresses, such as third party principals. For most identities, the format will be `principal://iam.googleapis.com/{identity pool name}/subjects/{subject}` except for some GKE identities (GKE_WORKLOAD, FREEFORM, GKE_HUB_WORKLOAD) that are still in the legacy format `serviceAccount:{identity pool name}[{subject}]` + "methodName": "A String", + "principalEmail": "A String", + "principalSubject": "A String", + "serviceAccountDelegationInfo": [ + { + "principalEmail": "A String", + "principalSubject": "A String", }, ], - "serviceAccountKeyName": "A String", # The name of the service account key that was used to create or exchange credentials when authenticating the service account that made the request. This is a scheme-less URI full resource name. For example: "//iam.googleapis.com/projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}/keys/{key}". - "serviceName": "A String", # This is the API service that the service account made a call to, e.g. "iam.googleapis.com" - "userAgent": "A String", # The caller's user agent string associated with the finding. - "userAgentFamily": "A String", # Type of user agent associated with the finding. For example, an operating system shell or an embedded or standalone application. - "userName": "A String", # A string that represents a username. The username provided depends on the type of the finding and is likely not an IAM principal. For example, this can be a system username if the finding is related to a virtual machine, or it can be an application login username. + "serviceAccountKeyName": "A String", + "serviceName": "A String", + "userAgent": "A String", + "userAgentFamily": "A String", + "userName": "A String", }, - "affectedResources": { # Details about resources affected by this finding. # AffectedResources associated with the finding. - "count": "A String", # The count of resources affected by the finding. + "affectedResources": { + "count": "A String", }, - "agentDataAccessEvents": [ # Agent data access events associated with the finding. - { # Details about a data access attempt made by an agent principal not authorized under applicable data security policy. - "eventId": "A String", # Unique identifier for data access event. - "eventTime": "A String", # Timestamp of data access event. - "operation": "A String", # The operation performed by the principal to access the data. - "principalSubject": "A String", # The agent principal that accessed the data. + "agentDataAccessEvents": [ + { + "eventId": "A String", + "eventTime": "A String", + "operation": "A String", + "principalSubject": "A String", }, ], - "aiModel": { # Contains information about the AI model associated with the finding. # The AI model associated with the finding. - "deploymentPlatform": "A String", # The platform on which the model is deployed. - "displayName": "A String", # The user defined display name of model. Ex. baseline-classification-model - "domain": "A String", # The domain of the model, for example, “image-classification”. - "library": "A String", # The name of the model library, for example, “transformers”. - "location": "A String", # The region in which the model is used, for example, “us-central1”. - "name": "A String", # The name of the AI model, for example, "gemini:1.0.0". - "publisher": "A String", # The publisher of the model, for example, “google” or “nvidia”. - "usageCategory": "A String", # The purpose of the model, for example, "Inteference" or "Training". + "aiModel": { + "deploymentPlatform": "A String", + "displayName": "A String", + "domain": "A String", + "library": "A String", + "location": "A String", + "name": "A String", + "publisher": "A String", + "usageCategory": "A String", }, - "application": { # Represents an application associated with a finding. # Represents an application associated with the finding. - "baseUri": "A String", # The base URI that identifies the network location of the application in which the vulnerability was detected. For example, `http://example.com`. - "fullUri": "A String", # The full URI with payload that can be used to reproduce the vulnerability. For example, `http://example.com?p=aMmYgI6H`. + "application": { + "baseUri": "A String", + "fullUri": "A String", }, - "artifactGuardPolicies": { # Represents the result of evaluating artifact guard policies. # ArtifactGuardPolicies associated with the finding. - "failingPolicies": [ # A list of failing policies. - { # Represents an artifact guard policy. - "failureReason": "A String", # The reason for the policy failure, for example, "severity=HIGH AND max_vuln_count=2". - "policyId": "A String", # The ID of the failing policy, for example, "organizations/3392779/locations/global/policies/prod-policy". - "type": "A String", # The type of the policy evaluation. + "artifactGuardPolicies": { + "failingPolicies": [ + { + "failureReason": "A String", + "policyId": "A String", + "type": "A String", }, ], - "resourceId": "A String", # The ID of the resource that has policies configured for it. + "resourceId": "A String", }, - "attackExposure": { # An attack exposure contains the results of an attack path simulation run. # The results of an attack path simulation relevant to this finding. - "attackExposureResult": "A String", # The resource name of the attack path simulation result that contains the details regarding this attack exposure score. Example: `organizations/123/simulations/456/attackExposureResults/789` - "exposedHighValueResourcesCount": 42, # The number of high value resources that are exposed as a result of this finding. - "exposedLowValueResourcesCount": 42, # The number of high value resources that are exposed as a result of this finding. - "exposedMediumValueResourcesCount": 42, # The number of medium value resources that are exposed as a result of this finding. - "latestCalculationTime": "A String", # The most recent time the attack exposure was updated on this finding. - "score": 3.14, # A number between 0 (inclusive) and infinity that represents how important this finding is to remediate. The higher the score, the more important it is to remediate. - "state": "A String", # What state this AttackExposure is in. This captures whether or not an attack exposure has been calculated or not. + "attackExposure": { + "attackExposureResult": "A String", + "exposedHighValueResourcesCount": 42, + "exposedLowValueResourcesCount": 42, + "exposedMediumValueResourcesCount": 42, + "latestCalculationTime": "A String", + "score": 3.14, + "state": "A String", }, - "backupDisasterRecovery": { # Information related to Google Cloud Backup and DR Service findings. # Fields related to Backup and DR findings. - "appliance": "A String", # The name of the Backup and DR appliance that captures, moves, and manages the lifecycle of backup data. For example, `backup-server-57137`. - "applications": [ # The names of Backup and DR applications. An application is a VM, database, or file system on a managed host monitored by a backup and recovery appliance. For example, `centos7-01-vol00`, `centos7-01-vol01`, `centos7-01-vol02`. + "backupDisasterRecovery": { + "appliance": "A String", + "applications": [ "A String", ], - "backupCreateTime": "A String", # The timestamp at which the Backup and DR backup was created. - "backupTemplate": "A String", # The name of a Backup and DR template which comprises one or more backup policies. See the [Backup and DR documentation](https://cloud.google.com/backup-disaster-recovery/docs/concepts/backup-plan#temp) for more information. For example, `snap-ov`. - "backupType": "A String", # The backup type of the Backup and DR image. For example, `Snapshot`, `Remote Snapshot`, `OnVault`. - "host": "A String", # The name of a Backup and DR host, which is managed by the backup and recovery appliance and known to the management console. The host can be of type Generic (for example, Compute Engine, SQL Server, Oracle DB, SMB file system, etc.), vCenter, or an ESX server. See the [Backup and DR documentation on hosts](https://cloud.google.com/backup-disaster-recovery/docs/configuration/manage-hosts-and-their-applications) for more information. For example, `centos7-01`. - "policies": [ # The names of Backup and DR policies that are associated with a template and that define when to run a backup, how frequently to run a backup, and how long to retain the backup image. For example, `onvaults`. + "backupCreateTime": "A String", + "backupTemplate": "A String", + "backupType": "A String", + "host": "A String", + "policies": [ "A String", ], - "policyOptions": [ # The names of Backup and DR advanced policy options of a policy applying to an application. See the [Backup and DR documentation on policy options](https://cloud.google.com/backup-disaster-recovery/docs/create-plan/policy-settings). For example, `skipofflineappsincongrp, nounmap`. + "policyOptions": [ "A String", ], - "profile": "A String", # The name of the Backup and DR resource profile that specifies the storage media for backups of application and VM data. See the [Backup and DR documentation on profiles](https://cloud.google.com/backup-disaster-recovery/docs/concepts/backup-plan#profile). For example, `GCP`. - "storagePool": "A String", # The name of the Backup and DR storage pool that the backup and recovery appliance is storing data in. The storage pool could be of type Cloud, Primary, Snapshot, or OnVault. See the [Backup and DR documentation on storage pools](https://cloud.google.com/backup-disaster-recovery/docs/concepts/storage-pools). For example, `DiskPoolOne`. + "profile": "A String", + "storagePool": "A String", }, - "canonicalName": "A String", # The canonical name of the finding. It's either "organizations/{organization_id}/sources/{source_id}/findings/{finding_id}", "folders/{folder_id}/sources/{source_id}/findings/{finding_id}" or "projects/{project_number}/sources/{source_id}/findings/{finding_id}", depending on the closest CRM ancestor of the resource associated with the finding. - "category": "A String", # The additional taxonomy group within findings from a given source. This field is immutable after creation time. Example: "XSS_FLASH_INJECTION" - "chokepoint": { # Contains details about a chokepoint, which is a resource or resource group where high-risk attack paths converge, based on [attack path simulations] (https://cloud.google.com/security-command-center/docs/attack-exposure-learn#attack_path_simulations). # Contains details about a chokepoint, which is a resource or resource group where high-risk attack paths converge, based on [attack path simulations] (https://cloud.google.com/security-command-center/docs/attack-exposure-learn#attack_path_simulations). This field cannot be updated. Its value is ignored in all update requests. - "relatedFindings": [ # List of resource names of findings associated with this chokepoint. For example, organizations/123/sources/456/findings/789. This list will have at most 100 findings. + "canonicalName": "A String", + "category": "A String", + "chokepoint": { + "relatedFindings": [ "A String", ], }, - "cloudArmor": { # Fields related to Google Cloud Armor findings. # Fields related to Cloud Armor findings. - "adaptiveProtection": { # Information about [Google Cloud Armor Adaptive Protection](https://cloud.google.com/armor/docs/cloud-armor-overview#google-cloud-armor-adaptive-protection). # Information about potential Layer 7 DDoS attacks identified by [Google Cloud Armor Adaptive Protection](https://cloud.google.com/armor/docs/adaptive-protection-overview). - "confidence": 3.14, # A score of 0 means that there is low confidence that the detected event is an actual attack. A score of 1 means that there is high confidence that the detected event is an attack. See the [Adaptive Protection documentation](https://cloud.google.com/armor/docs/adaptive-protection-overview#configure-alert-tuning) for further explanation. + "cloudArmor": { + "adaptiveProtection": { + "confidence": 3.14, }, - "attack": { # Information about DDoS attack volume and classification. # Information about DDoS attack volume and classification. - "classification": "A String", # Type of attack, for example, 'SYN-flood', 'NTP-udp', or 'CHARGEN-udp'. - "volumeBps": 42, # Total BPS (bytes per second) volume of attack. Deprecated - refer to volume_bps_long instead. - "volumeBpsLong": "A String", # Total BPS (bytes per second) volume of attack. - "volumePps": 42, # Total PPS (packets per second) volume of attack. Deprecated - refer to volume_pps_long instead. - "volumePpsLong": "A String", # Total PPS (packets per second) volume of attack. + "attack": { + "classification": "A String", + "volumeBps": 42, + "volumeBpsLong": "A String", + "volumePps": 42, + "volumePpsLong": "A String", }, - "duration": "A String", # Duration of attack from the start until the current moment (updated every 5 minutes). - "requests": { # Information about the requests relevant to the finding. # Information about incoming requests evaluated by [Google Cloud Armor security policies](https://cloud.google.com/armor/docs/security-policy-overview). - "longTermAllowed": 42, # Allowed RPS (requests per second) over the long term. - "longTermDenied": 42, # Denied RPS (requests per second) over the long term. - "ratio": 3.14, # For 'Increasing deny ratio', the ratio is the denied traffic divided by the allowed traffic. For 'Allowed traffic spike', the ratio is the allowed traffic in the short term divided by allowed traffic in the long term. - "shortTermAllowed": 42, # Allowed RPS (requests per second) in the short term. + "duration": "A String", + "requests": { + "longTermAllowed": 42, + "longTermDenied": 42, + "ratio": 3.14, + "shortTermAllowed": 42, }, - "securityPolicy": { # Information about the [Google Cloud Armor security policy](https://cloud.google.com/armor/docs/security-policy-overview) relevant to the finding. # Information about the [Google Cloud Armor security policy](https://cloud.google.com/armor/docs/security-policy-overview) relevant to the finding. - "name": "A String", # The name of the Google Cloud Armor security policy, for example, "my-security-policy". - "preview": True or False, # Whether or not the associated rule or policy is in preview mode. - "type": "A String", # The type of Google Cloud Armor security policy for example, 'backend security policy', 'edge security policy', 'network edge security policy', or 'always-on DDoS protection'. + "securityPolicy": { + "name": "A String", + "preview": True or False, + "type": "A String", }, - "threatVector": "A String", # Distinguish between volumetric & protocol DDoS attack and application layer attacks. For example, "L3_4" for Layer 3 and Layer 4 DDoS attacks, or "L_7" for Layer 7 DDoS attacks. + "threatVector": "A String", }, - "cloudDlpDataProfile": { # The [data profile](https://cloud.google.com/dlp/docs/data-profiles) associated with the finding. # Cloud DLP data profile that is associated with the finding. - "dataProfile": "A String", # Name of the data profile, for example, `projects/123/locations/europe/tableProfiles/8383929`. - "infoTypes": [ # Type of information detected by SDP. Info type includes name, version and sensitivity of the detected information type. - { # Type of information detected by the API. - "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. - "sensitivityScore": { # Score is calculated from of all elements in the data profile. A higher level means the data is more sensitive. # Optional custom sensitivity for this InfoType. This only applies to data profiling. - "score": "A String", # The sensitivity score applied to the resource. + "cloudDlpDataProfile": { + "dataProfile": "A String", + "infoTypes": [ + { + "name": "A String", + "sensitivityScore": { + "score": "A String", }, - "version": "A String", # Optional version name for this InfoType. + "version": "A String", }, ], - "parentType": "A String", # The resource hierarchy level at which the data profile was generated. + "parentType": "A String", }, - "cloudDlpInspection": { # Details about the Cloud Data Loss Prevention (Cloud DLP) [inspection job](https://cloud.google.com/dlp/docs/concepts-job-triggers) that produced the finding. # Cloud Data Loss Prevention (Cloud DLP) inspection results that are associated with the finding. - "fullScan": True or False, # Whether Cloud DLP scanned the complete resource or a sampled subset. - "infoType": "A String", # The type of information (or *[infoType](https://cloud.google.com/dlp/docs/infotypes-reference)*) found, for example, `EMAIL_ADDRESS` or `STREET_ADDRESS`. - "infoTypeCount": "A String", # The number of times Cloud DLP found this infoType within this job and resource. - "inspectJob": "A String", # Name of the inspection job, for example, `projects/123/locations/europe/dlpJobs/i-8383929`. + "cloudDlpInspection": { + "fullScan": True or False, + "infoType": "A String", + "infoTypeCount": "A String", + "inspectJob": "A String", }, - "complianceDetails": { # Compliance Details associated with the finding. # Details about the compliance implications of the finding. - "cloudControl": { # CloudControl associated with the finding. # CloudControl associated with the finding - "cloudControlName": "A String", # Name of the CloudControl associated with the finding. - "policyType": "A String", # Policy type of the CloudControl - "type": "A String", # Type of cloud control. - "version": 42, # Version of the Cloud Control + "complianceDetails": { + "cloudControl": { + "cloudControlName": "A String", + "policyType": "A String", + "type": "A String", + "version": 42, }, - "cloudControlDeploymentNames": [ # Cloud Control Deployments associated with the finding. For example, organizations/123/locations/global/cloudControlDeployments/deploymentIdentifier + "cloudControlDeploymentNames": [ "A String", ], - "frameworks": [ # Details of Frameworks associated with the finding - { # Compliance framework associated with the finding. - "category": [ # Category of the framework associated with the finding. E.g. Security Benchmark, or Assured Workloads + "frameworks": [ + { + "category": [ "A String", ], - "controls": [ # The controls associated with the framework. - { # Compliance control associated with the finding. - "controlName": "A String", # Name of the Control - "displayName": "A String", # Display name of the control. For example, AU-02. + "controls": [ + { + "controlName": "A String", + "displayName": "A String", }, ], - "displayName": "A String", # Display name of the framework. For a standard framework, this will look like e.g. PCI DSS 3.2.1, whereas for a custom framework it can be a user defined string like MyFramework - "name": "A String", # Name of the framework associated with the finding - "type": "A String", # Type of the framework associated with the finding, to specify whether the framework is built-in (pre-defined and immutable) or a custom framework defined by the customer (equivalent to security posture) + "displayName": "A String", + "name": "A String", + "type": "A String", }, ], }, - "compliances": [ # Contains compliance information for security standards associated to the finding. - { # Contains compliance information about a security standard indicating unmet recommendations. - "ids": [ # Policies within the standard or benchmark, for example, A.12.4.1 + "compliances": [ + { + "ids": [ "A String", ], - "standard": "A String", # Industry-wide compliance standards or benchmarks, such as CIS, PCI, and OWASP. - "version": "A String", # Version of the standard or benchmark, for example, 1.1 + "standard": "A String", + "version": "A String", }, ], - "connections": [ # Contains information about the IP connection associated with the finding. - { # Contains information about the IP connection associated with the finding. - "destinationIp": "A String", # Destination IP address. Not present for sockets that are listening and not connected. - "destinationPort": 42, # Destination port. Not present for sockets that are listening and not connected. - "protocol": "A String", # IANA Internet Protocol Number such as TCP(6) and UDP(17). - "sourceIp": "A String", # Source IP address. - "sourcePort": 42, # Source port. + "connections": [ + { + "destinationIp": "A String", + "destinationPort": 42, + "protocol": "A String", + "sourceIp": "A String", + "sourcePort": 42, }, ], - "contacts": { # Output only. Map containing the points of contact for the given finding. The key represents the type of contact, while the value contains a list of all the contacts that pertain. Please refer to: https://cloud.google.com/resource-manager/docs/managing-notification-contacts#notification-categories { "security": { "contacts": [ { "email": "person1@company.com" }, { "email": "person2@company.com" } ] } } - "a_key": { # Details about specific contacts - "contacts": [ # A list of contacts - { # The email address of a contact. - "email": "A String", # An email address. For example, "`person123@company.com`". + "contacts": { + "a_key": { + "contacts": [ + { + "email": "A String", }, ], }, }, - "containers": [ # Containers associated with the finding. This field provides information for both Kubernetes and non-Kubernetes containers. - { # Container associated with the finding. - "createTime": "A String", # The time that the container was created. - "imageId": "A String", # Optional container image ID, if provided by the container runtime. Uniquely identifies the container image launched using a container image digest. - "labels": [ # Container labels, as provided by the container runtime. - { # Represents a generic name-value label. A label has separate name and value fields to support filtering with the `contains()` function. For more information, see [Filtering on array-type fields](https://cloud.google.com/security-command-center/docs/how-to-api-list-findings#array-contains-filtering). - "name": "A String", # Name of the label. - "value": "A String", # Value that corresponds to the label's name. + "containers": [ + { + "createTime": "A String", + "imageId": "A String", + "labels": [ + { + "name": "A String", + "value": "A String", }, ], - "name": "A String", # Name of the container. - "uri": "A String", # Container image URI provided when configuring a pod or container. This string can identify a container image version using mutable tags. + "name": "A String", + "uri": "A String", }, ], - "createTime": "A String", # The time at which the finding was created in Security Command Center. - "dataAccessEvents": [ # Data access events associated with the finding. - { # Details about a data access attempt made by a principal not authorized under applicable data security policy. - "eventId": "A String", # Unique identifier for data access event. - "eventTime": "A String", # Timestamp of data access event. - "operation": "A String", # The operation performed by the principal to access the data. - "principalEmail": "A String", # The email address of the principal that accessed the data. The principal could be a user account, service account, Google group, or other. + "createTime": "A String", + "dataAccessEvents": [ + { + "eventId": "A String", + "eventTime": "A String", + "operation": "A String", + "principalEmail": "A String", }, ], - "dataFlowEvents": [ # Data flow events associated with the finding. - { # Details about a data flow event, in which either the data is moved to or is accessed from a non-compliant geo-location, as defined in the applicable data security policy. - "eventId": "A String", # Unique identifier for data flow event. - "eventTime": "A String", # Timestamp of data flow event. - "operation": "A String", # The operation performed by the principal for the data flow event. - "principalEmail": "A String", # The email address of the principal that initiated the data flow event. The principal could be a user account, service account, Google group, or other. - "violatedLocation": "A String", # Non-compliant location of the principal or the data destination. + "dataFlowEvents": [ + { + "eventId": "A String", + "eventTime": "A String", + "operation": "A String", + "principalEmail": "A String", + "violatedLocation": "A String", }, ], - "dataRetentionDeletionEvents": [ # Data retention deletion events associated with the finding. - { # Details about data retention deletion violations, in which the data is non-compliant based on their retention or deletion time, as defined in the applicable data security policy. The Data Retention Deletion (DRD) control is a control of the DSPM (Data Security Posture Management) suite that enables organizations to manage data retention and deletion policies in compliance with regulations, such as GDPR and CRPA. DRD supports two primary policy types: maximum storage length (max TTL) and minimum storage length (min TTL). Both are aimed at helping organizations meet regulatory and data management commitments. - "dataObjectCount": "A String", # Number of objects that violated the policy for this resource. If the number is less than 1,000, then the value of this field is the exact number. If the number of objects that violated the policy is greater than or equal to 1,000, then the value of this field is 1000. - "eventDetectionTime": "A String", # Timestamp indicating when the event was detected. - "eventType": "A String", # Type of the DRD event. - "maxRetentionAllowed": "A String", # Maximum duration of retention allowed from the DRD control. This comes from the DRD control where users set a max TTL for their data. For example, suppose that a user sets the max TTL for a Cloud Storage bucket to 90 days. However, an object in that bucket is 100 days old. In this case, a DataRetentionDeletionEvent will be generated for that Cloud Storage bucket, and the max_retention_allowed is 90 days. - "minRetentionAllowed": "A String", # Min duration of retention allowed from the DSPM retention control. This field is only populated when event type is set to EVENT_TYPE_MIN_TTL_FROM_CREATION. + "dataRetentionDeletionEvents": [ + { + "dataObjectCount": "A String", + "eventDetectionTime": "A String", + "eventType": "A String", + "maxRetentionAllowed": "A String", + "minRetentionAllowed": "A String", }, ], - "database": { # Represents database access information, such as queries. A database may be a sub-resource of an instance (as in the case of Cloud SQL instances or Cloud Spanner instances), or the database instance itself. Some database resources might not have the [full resource name](https://google.aip.dev/122#full-resource-names) populated because these resource types, such as Cloud SQL databases, are not yet supported by Cloud Asset Inventory. In these cases only the display name is provided. # Database associated with the finding. - "displayName": "A String", # The human-readable name of the database that the user connected to. - "grantees": [ # The target usernames, roles, or groups of an SQL privilege grant, which is not an IAM policy change. + "database": { + "displayName": "A String", + "grantees": [ "A String", ], - "name": "A String", # Some database resources may not have the [full resource name](https://google.aip.dev/122#full-resource-names) populated because these resource types are not yet supported by Cloud Asset Inventory (e.g. Cloud SQL databases). In these cases only the display name will be provided. The [full resource name](https://google.aip.dev/122#full-resource-names) of the database that the user connected to, if it is supported by Cloud Asset Inventory. - "query": "A String", # The SQL statement that is associated with the database access. - "userName": "A String", # The username used to connect to the database. The username might not be an IAM principal and does not have a set format. - "version": "A String", # The version of the database, for example, POSTGRES_14. See [the complete list](https://cloud.google.com/sql/docs/mysql/admin-api/rest/v1/SqlDatabaseVersion). + "name": "A String", + "query": "A String", + "userName": "A String", + "version": "A String", }, - "description": "A String", # Contains more details about the finding. - "discoveredWorkload": { # Represents discovered, customer managed workload that is not registered with the respective GCP service. # DiscoveredWorkload associated with the finding. - "confidence": "A String", # The confidence in detection of this workload. - "detectedRelevantHardware": True or False, # A boolean flag set to true if associated hardware strongly predicts the workload type. - "detectedRelevantKeywords": True or False, # A boolean flag set to true if associated keywords strongly predict the workload type. - "detectedRelevantPackages": True or False, # A boolean flag set to true if installed packages strongly predict the workload type. - "workloadType": "A String", # The type of workload. + "description": "A String", + "discoveredWorkload": { + "confidence": "A String", + "detectedRelevantHardware": True or False, + "detectedRelevantKeywords": True or False, + "detectedRelevantPackages": True or False, + "workloadType": "A String", }, - "disk": { # Contains information about the disk associated with the finding. # Disk associated with the finding. - "name": "A String", # The name of the disk, for example, "https://www.googleapis.com/compute/v1/projects/{project-id}/zones/{zone-id}/disks/{disk-id}". + "disk": { + "name": "A String", }, - "eventTime": "A String", # The time the finding was first detected. If an existing finding is updated, then this is the time the update occurred. For example, if the finding represents an open firewall, this property captures the time the detector believes the firewall became open. The accuracy is determined by the detector. If the finding is later resolved, then this time reflects when the finding was resolved. This must not be set to a value greater than the current timestamp. - "exfiltration": { # Exfiltration represents a data exfiltration attempt from one or more sources to one or more targets. The `sources` attribute lists the sources of the exfiltrated data. The `targets` attribute lists the destinations the data was copied to. # Represents exfiltrations associated with the finding. - "sources": [ # If there are multiple sources, then the data is considered "joined" between them. For instance, BigQuery can join multiple tables, and each table would be considered a source. - { # Resource where data was exfiltrated from or exfiltrated to. - "components": [ # Subcomponents of the asset that was exfiltrated, like URIs used during exfiltration, table names, databases, and filenames. For example, multiple tables might have been exfiltrated from the same Cloud SQL instance, or multiple files might have been exfiltrated from the same Cloud Storage bucket. + "eventTime": "A String", + "exfiltration": { + "sources": [ + { + "components": [ "A String", ], - "name": "A String", # The resource's [full resource name](https://cloud.google.com/apis/design/resource_names#full_resource_name). + "name": "A String", }, ], - "targets": [ # If there are multiple targets, each target would get a complete copy of the "joined" source data. - { # Resource where data was exfiltrated from or exfiltrated to. - "components": [ # Subcomponents of the asset that was exfiltrated, like URIs used during exfiltration, table names, databases, and filenames. For example, multiple tables might have been exfiltrated from the same Cloud SQL instance, or multiple files might have been exfiltrated from the same Cloud Storage bucket. + "targets": [ + { + "components": [ "A String", ], - "name": "A String", # The resource's [full resource name](https://cloud.google.com/apis/design/resource_names#full_resource_name). + "name": "A String", }, ], - "totalExfiltratedBytes": "A String", # Total exfiltrated bytes processed for the entire job. + "totalExfiltratedBytes": "A String", }, - "externalExposure": { # Details about the externally exposed resource associated with the finding. # External exposure associated with the finding. - "backendBucket": "A String", # The full resource name of the load balancer backend bucket, for example, "//compute.googleapis.com/projects/{project-id}/global/backendBuckets/{name}" - "backendService": "A String", # The full resource name of load balancer backend service, for example, "//compute.googleapis.com/projects/{project-id}/global/backendServices/{name}". - "exposedApplication": "A String", # The name and version of the exposed web application, for example, "Jenkins 2.184". - "exposedEndpoint": "A String", # The resource which is running the exposed service, for example, "//compute.googleapis.com/projects/{project-id}/zones/{zone}/instances/{instance}.” - "exposedService": "A String", # The name and version of the service, for example, "Jupyter Notebook 6.14.0". - "forwardingRule": "A String", # The full resource name of the forwarding rule, for example, "//compute.googleapis.com/projects/{project-id}/global/forwardingRules/{forwarding-rule-name}". - "hostnameUri": "A String", # Hostname of the exposed application, for example, "https://test-app.a.run.app/" - "httpResponse": [ # The http response returned by the web application. - { # The http response returned by the web application. - "path": "A String", # The http path for which response code was returned by web application, for example, "https://test-app.a.run.app/test". - "statusCode": "A String", # The http response code returned by the web application, for example, 200. + "externalExposure": { + "backendBucket": "A String", + "backendService": "A String", + "exposedApplication": "A String", + "exposedEndpoint": "A String", + "exposedService": "A String", + "forwardingRule": "A String", + "hostnameUri": "A String", + "httpResponse": [ + { + "path": "A String", + "statusCode": "A String", }, ], - "instanceGroup": "A String", # The full resource name of the instance group, for example, "//compute.googleapis.com/projects/{project-id}/global/instanceGroups/{name}". - "internalBackendService": "A String", # The full resource name of load balancer backend service in the internal project having resource exposed via PSC, for example, "//compute.googleapis.com/projects/{project-id}/global/backendServices/{name}". - "loadBalancerFirewallPolicy": "A String", # The full resource name of the load balancer firewall policy, for example, "//compute.googleapis.com/projects/{project-id}/global/firewallPolicies/{policy-name}". - "networkEndpointGroup": "A String", # The full resource name of the network endpoint group, for example, "//compute.googleapis.com/projects/{project-id}/global/networkEndpointGroups/{name}". - "networkIngressFirewallPolicy": "A String", # The full resource name of the network ingress firewall policy, for example, "//compute.googleapis.com/projects/{project-id}/global/firewallPolicies/{name}". - "privateIpAddress": "A String", # Private IP address of the exposed endpoint. - "privatePort": "A String", # Port number associated with private IP address. - "pscNetworkAttachment": "A String", # The full resource name of the PSC (Private Service Connect) network attachment that network interface controller is attached to, for example, "//compute.googleapis.com/projects/{project-id}/regions/{region}/networkAttachments/{name}" - "pscServiceAttachment": "A String", # The full resource name of the PSC (Private Service Connect) service attachment that the load balancer network endpoint group targets, for example, "//compute.googleapis.com/projects/{project-id}/regions/{region}/serviceAttachments/{name}" - "publicIpAddress": "A String", # Public IP address of the exposed endpoint. - "publicPort": "A String", # Public port number of the exposed endpoint. - "serviceFirewallPolicy": "A String", # The full resource name of the firewall policy of the exposed service, for example, "//compute.googleapis.com/projects/{project-id}/global/firewallPolicies/{policy-name}". + "instanceGroup": "A String", + "internalBackendService": "A String", + "loadBalancerFirewallPolicy": "A String", + "networkEndpointGroup": "A String", + "networkIngressFirewallPolicy": "A String", + "privateIpAddress": "A String", + "privatePort": "A String", + "pscNetworkAttachment": "A String", + "pscServiceAttachment": "A String", + "publicIpAddress": "A String", + "publicPort": "A String", + "serviceFirewallPolicy": "A String", }, - "externalSystems": { # Output only. Third party SIEM/SOAR fields within SCC, contains external system information and external system finding fields. - "a_key": { # Representation of third party SIEM/SOAR fields within SCC. - "assignees": [ # References primary/secondary etc assignees in the external system. + "externalSystems": { + "a_key": { + "assignees": [ "A String", ], - "caseCloseTime": "A String", # The time when the case was closed, as reported by the external system. - "caseCreateTime": "A String", # The time when the case was created, as reported by the external system. - "casePriority": "A String", # The priority of the finding's corresponding case in the external system. - "caseSla": "A String", # The SLA of the finding's corresponding case in the external system. - "caseUri": "A String", # The link to the finding's corresponding case in the external system. - "externalSystemUpdateTime": "A String", # The time when the case was last updated, as reported by the external system. - "externalUid": "A String", # The identifier that's used to track the finding's corresponding case in the external system. - "name": "A String", # Full resource name of the external system, for example: "organizations/1234/sources/5678/findings/123456/externalSystems/jira", "folders/1234/sources/5678/findings/123456/externalSystems/jira", "projects/1234/sources/5678/findings/123456/externalSystems/jira" - "status": "A String", # The most recent status of the finding's corresponding case, as reported by the external system. - "ticketInfo": { # Information about the ticket, if any, that is being used to track the resolution of the issue that is identified by this finding. # Information about the ticket, if any, that is being used to track the resolution of the issue that is identified by this finding. - "assignee": "A String", # The assignee of the ticket in the ticket system. - "description": "A String", # The description of the ticket in the ticket system. - "id": "A String", # The identifier of the ticket in the ticket system. - "status": "A String", # The latest status of the ticket, as reported by the ticket system. - "updateTime": "A String", # The time when the ticket was last updated, as reported by the ticket system. - "uri": "A String", # The link to the ticket in the ticket system. + "caseCloseTime": "A String", + "caseCreateTime": "A String", + "casePriority": "A String", + "caseSla": "A String", + "caseUri": "A String", + "externalSystemUpdateTime": "A String", + "externalUid": "A String", + "name": "A String", + "status": "A String", + "ticketInfo": { + "assignee": "A String", + "description": "A String", + "id": "A String", + "status": "A String", + "updateTime": "A String", + "uri": "A String", }, }, }, - "externalUri": "A String", # The URI that, if available, points to a web page outside of Security Command Center where additional information about the finding can be found. This field is guaranteed to be either empty or a well formed URL. - "files": [ # File associated with the finding. - { # File information about the related binary/library used by an executable, or the script used by a script interpreter - "contents": "A String", # Prefix of the file contents as a JSON-encoded string. - "diskPath": { # Path of the file in terms of underlying disk/partition identifiers. # Path of the file in terms of underlying disk/partition identifiers. - "partitionUuid": "A String", # UUID of the partition (format https://wiki.archlinux.org/title/persistent_block_device_naming#by-uuid) - "relativePath": "A String", # Relative path of the file in the partition as a JSON encoded string. Example: /home/user1/executable_file.sh + "externalUri": "A String", + "files": [ + { + "contents": "A String", + "diskPath": { + "partitionUuid": "A String", + "relativePath": "A String", }, - "fileLoadState": "A String", # The load state of the file. - "hashedSize": "A String", # The length in bytes of the file prefix that was hashed. If hashed_size == size, any hashes reported represent the entire file. - "operations": [ # Operation(s) performed on a file. - { # Operation(s) performed on a file. - "type": "A String", # The type of the operation + "fileLoadState": "A String", + "hashedSize": "A String", + "operations": [ + { + "type": "A String", }, ], - "partiallyHashed": True or False, # True when the hash covers only a prefix of the file. - "path": "A String", # Absolute path of the file as a JSON encoded string. - "sha256": "A String", # SHA256 hash of the first hashed_size bytes of the file encoded as a hex string. If hashed_size == size, sha256 represents the SHA256 hash of the entire file. - "size": "A String", # Size of the file in bytes. + "partiallyHashed": True or False, + "path": "A String", + "sha256": "A String", + "size": "A String", }, ], - "findingClass": "A String", # The class of the finding. - "groupMemberships": [ # Contains details about groups of which this finding is a member. A group is a collection of findings that are related in some way. This field cannot be updated. Its value is ignored in all update requests. - { # Contains details about groups of which this finding is a member. A group is a collection of findings that are related in some way. - "groupId": "A String", # ID of the group. - "groupType": "A String", # Type of group. + "findingClass": "A String", + "groupMemberships": [ + { + "groupId": "A String", + "groupType": "A String", }, ], - "iamBindings": [ # Represents IAM bindings associated with the finding. - { # Represents a particular IAM binding, which captures a member's role addition, removal, or state. - "action": "A String", # The action that was performed on a Binding. - "member": "A String", # A single identity requesting access for a Cloud Platform resource, for example, "foo@google.com". - "role": "A String", # Role that is assigned to "members". For example, "roles/viewer", "roles/editor", or "roles/owner". + "iamBindings": [ + { + "action": "A String", + "member": "A String", + "role": "A String", }, ], - "indicator": { # Represents what's commonly known as an _indicator of compromise_ (IoC) in computer forensics. This is an artifact observed on a network or in an operating system that, with high confidence, indicates a computer intrusion. For more information, see [Indicator of compromise](https://en.wikipedia.org/wiki/Indicator_of_compromise). # Represents what's commonly known as an *indicator of compromise* (IoC) in computer forensics. This is an artifact observed on a network or in an operating system that, with high confidence, indicates a computer intrusion. For more information, see [Indicator of compromise](https://en.wikipedia.org/wiki/Indicator_of_compromise). - "domains": [ # List of domains associated to the Finding. + "indicator": { + "domains": [ "A String", ], - "ipAddresses": [ # The list of IP addresses that are associated with the finding. + "ipAddresses": [ "A String", ], - "signatures": [ # The list of matched signatures indicating that the given process is present in the environment. - { # Indicates what signature matched this process. - "memoryHashSignature": { # A signature corresponding to memory page hashes. # Signature indicating that a binary family was matched. - "binaryFamily": "A String", # The binary family. - "detections": [ # The list of memory hash detections contributing to the binary family match. - { # Memory hash detection contributing to the binary family match. - "binary": "A String", # The name of the binary associated with the memory hash signature detection. - "percentPagesMatched": 3.14, # The percentage of memory page hashes in the signature that were matched. + "signatures": [ + { + "memoryHashSignature": { + "binaryFamily": "A String", + "detections": [ + { + "binary": "A String", + "percentPagesMatched": 3.14, }, ], }, - "signatureType": "A String", # Describes the type of resource associated with the signature. - "yaraRuleSignature": { # A signature corresponding to a YARA rule. # Signature indicating that a YARA rule was matched. - "yaraRule": "A String", # The name of the YARA rule. + "signatureType": "A String", + "yaraRuleSignature": { + "yaraRule": "A String", }, }, ], - "uris": [ # The list of URIs associated to the Findings. + "uris": [ "A String", ], }, - "ipRules": { # IP rules associated with the finding. # IP rules associated with the finding. - "allowed": { # Allowed IP rule. # Tuple with allowed rules. - "ipRules": [ # Optional. Optional list of allowed IP rules. - { # IP rule information. - "portRanges": [ # Optional. An optional list of ports to which this rule applies. This field is only applicable for the UDP or (S)TCP protocols. Each entry must be either an integer or a range including a min and max port number. - { # A port range which is inclusive of the min and max values. Values are between 0 and 2^16-1. The max can be equal / must be not smaller than the min value. If min and max are equal this indicates that it is a single port. - "max": "A String", # Maximum port value. - "min": "A String", # Minimum port value. + "ipRules": { + "allowed": { + "ipRules": [ + { + "portRanges": [ + { + "max": "A String", + "min": "A String", }, ], - "protocol": "A String", # The IP protocol this rule applies to. This value can either be one of the following well known protocol strings (TCP, UDP, ICMP, ESP, AH, IPIP, SCTP) or a string representation of the integer value. + "protocol": "A String", }, ], }, - "denied": { # Denied IP rule. # Tuple with denied rules. - "ipRules": [ # Optional. Optional list of denied IP rules. - { # IP rule information. - "portRanges": [ # Optional. An optional list of ports to which this rule applies. This field is only applicable for the UDP or (S)TCP protocols. Each entry must be either an integer or a range including a min and max port number. - { # A port range which is inclusive of the min and max values. Values are between 0 and 2^16-1. The max can be equal / must be not smaller than the min value. If min and max are equal this indicates that it is a single port. - "max": "A String", # Maximum port value. - "min": "A String", # Minimum port value. + "denied": { + "ipRules": [ + { + "portRanges": [ + { + "max": "A String", + "min": "A String", }, ], - "protocol": "A String", # The IP protocol this rule applies to. This value can either be one of the following well known protocol strings (TCP, UDP, ICMP, ESP, AH, IPIP, SCTP) or a string representation of the integer value. + "protocol": "A String", }, ], }, - "destinationIpRanges": [ # If destination IP ranges are specified, the firewall rule applies only to traffic that has a destination IP address in these ranges. These ranges must be expressed in CIDR format. Only supports IPv4. + "destinationIpRanges": [ "A String", ], - "direction": "A String", # The direction that the rule is applicable to, one of ingress or egress. - "exposedServices": [ # Name of the network protocol service, such as FTP, that is exposed by the open port. Follows the naming convention available at: https://www.iana.org/assignments/service-names-port-numbers/service-names-port-numbers.xhtml. + "direction": "A String", + "exposedServices": [ "A String", ], - "sourceIpRanges": [ # If source IP ranges are specified, the firewall rule applies only to traffic that has a source IP address in these ranges. These ranges must be expressed in CIDR format. Only supports IPv4. + "sourceIpRanges": [ "A String", ], }, - "job": { # Describes a job # Job associated with the finding. - "errorCode": 42, # Optional. If the job did not complete successfully, this field describes why. - "location": "A String", # Optional. Gives the location where the job ran, such as `US` or `europe-west1` - "name": "A String", # The fully-qualified name for a job. e.g. `projects//jobs/` - "state": "A String", # Output only. State of the job, such as `RUNNING` or `PENDING`. + "job": { + "errorCode": 42, + "location": "A String", + "name": "A String", + "state": "A String", }, - "kernelRootkit": { # Kernel mode rootkit signatures. # Signature of the kernel rootkit. - "name": "A String", # Rootkit name, when available. - "unexpectedCodeModification": True or False, # True if unexpected modifications of kernel code memory are present. - "unexpectedFtraceHandler": True or False, # True if `ftrace` points are present with callbacks pointing to regions that are not in the expected kernel or module code range. - "unexpectedInterruptHandler": True or False, # True if interrupt handlers that are are not in the expected kernel or module code regions are present. - "unexpectedKernelCodePages": True or False, # True if kernel code pages that are not in the expected kernel or module code regions are present. - "unexpectedKprobeHandler": True or False, # True if `kprobe` points are present with callbacks pointing to regions that are not in the expected kernel or module code range. - "unexpectedProcessesInRunqueue": True or False, # True if unexpected processes in the scheduler run queue are present. Such processes are in the run queue, but not in the process task list. - "unexpectedReadOnlyDataModification": True or False, # True if unexpected modifications of kernel read-only data memory are present. - "unexpectedSystemCallHandler": True or False, # True if system call handlers that are are not in the expected kernel or module code regions are present. + "kernelRootkit": { + "name": "A String", + "unexpectedCodeModification": True or False, + "unexpectedFtraceHandler": True or False, + "unexpectedInterruptHandler": True or False, + "unexpectedKernelCodePages": True or False, + "unexpectedKprobeHandler": True or False, + "unexpectedProcessesInRunqueue": True or False, + "unexpectedReadOnlyDataModification": True or False, + "unexpectedSystemCallHandler": True or False, }, - "kubernetes": { # Kubernetes-related attributes. # Kubernetes resources associated with the finding. - "accessReviews": [ # Provides information on any Kubernetes access reviews (privilege checks) relevant to the finding. - { # Conveys information about a Kubernetes access review (such as one returned by a [`kubectl auth can-i`](https://kubernetes.io/docs/reference/access-authn-authz/authorization/#checking-api-access) command) that was involved in a finding. - "group": "A String", # The API group of the resource. "*" means all. - "name": "A String", # The name of the resource being requested. Empty means all. - "ns": "A String", # Namespace of the action being requested. Currently, there is no distinction between no namespace and all namespaces. Both are represented by "" (empty). - "resource": "A String", # The optional resource type requested. "*" means all. - "subresource": "A String", # The optional subresource type. - "verb": "A String", # A Kubernetes resource API verb, like get, list, watch, create, update, delete, proxy. "*" means all. - "version": "A String", # The API version of the resource. "*" means all. + "kubernetes": { + "accessReviews": [ + { + "group": "A String", + "name": "A String", + "ns": "A String", + "resource": "A String", + "subresource": "A String", + "verb": "A String", + "version": "A String", }, ], - "bindings": [ # Provides Kubernetes role binding information for findings that involve [RoleBindings or ClusterRoleBindings](https://cloud.google.com/kubernetes-engine/docs/how-to/role-based-access-control). - { # Represents a Kubernetes RoleBinding or ClusterRoleBinding. - "name": "A String", # Name for the binding. - "ns": "A String", # Namespace for the binding. - "role": { # Kubernetes Role or ClusterRole. # The Role or ClusterRole referenced by the binding. - "kind": "A String", # Role type. - "name": "A String", # Role name. - "ns": "A String", # Role namespace. + "bindings": [ + { + "name": "A String", + "ns": "A String", + "role": { + "kind": "A String", + "name": "A String", + "ns": "A String", }, - "subjects": [ # Represents one or more subjects that are bound to the role. Not always available for PATCH requests. - { # Represents a Kubernetes subject. - "kind": "A String", # Authentication type for the subject. - "name": "A String", # Name for the subject. - "ns": "A String", # Namespace for the subject. + "subjects": [ + { + "kind": "A String", + "name": "A String", + "ns": "A String", }, ], }, ], - "nodePools": [ # GKE [node pools](https://cloud.google.com/kubernetes-engine/docs/concepts/node-pools) associated with the finding. This field contains node pool information for each node, when it is available. - { # Provides GKE node pool information. - "name": "A String", # Kubernetes node pool name. - "nodes": [ # Nodes associated with the finding. - { # Kubernetes nodes associated with the finding. - "name": "A String", # [Full resource name](https://google.aip.dev/122#full-resource-names) of the Compute Engine VM running the cluster node. + "nodePools": [ + { + "name": "A String", + "nodes": [ + { + "name": "A String", }, ], }, ], - "nodes": [ # Provides Kubernetes [node](https://cloud.google.com/kubernetes-engine/docs/concepts/cluster-architecture#nodes) information. - { # Kubernetes nodes associated with the finding. - "name": "A String", # [Full resource name](https://google.aip.dev/122#full-resource-names) of the Compute Engine VM running the cluster node. + "nodes": [ + { + "name": "A String", }, ], - "objects": [ # Kubernetes objects related to the finding. - { # Kubernetes object related to the finding, uniquely identified by GKNN. Used if the object Kind is not one of Pod, Node, NodePool, Binding, or AccessReview. - "containers": [ # Pod containers associated with this finding, if any. - { # Container associated with the finding. - "createTime": "A String", # The time that the container was created. - "imageId": "A String", # Optional container image ID, if provided by the container runtime. Uniquely identifies the container image launched using a container image digest. - "labels": [ # Container labels, as provided by the container runtime. - { # Represents a generic name-value label. A label has separate name and value fields to support filtering with the `contains()` function. For more information, see [Filtering on array-type fields](https://cloud.google.com/security-command-center/docs/how-to-api-list-findings#array-contains-filtering). - "name": "A String", # Name of the label. - "value": "A String", # Value that corresponds to the label's name. + "objects": [ + { + "containers": [ + { + "createTime": "A String", + "imageId": "A String", + "labels": [ + { + "name": "A String", + "value": "A String", }, ], - "name": "A String", # Name of the container. - "uri": "A String", # Container image URI provided when configuring a pod or container. This string can identify a container image version using mutable tags. + "name": "A String", + "uri": "A String", }, ], - "group": "A String", # Kubernetes object group, such as "policy.k8s.io/v1". - "kind": "A String", # Kubernetes object kind, such as "Namespace". - "name": "A String", # Kubernetes object name. For details see https://kubernetes.io/docs/concepts/overview/working-with-objects/names/. - "ns": "A String", # Kubernetes object namespace. Must be a valid DNS label. Named "ns" to avoid collision with C++ namespace keyword. For details see https://kubernetes.io/docs/tasks/administer-cluster/namespaces/. + "group": "A String", + "kind": "A String", + "name": "A String", + "ns": "A String", }, ], - "pods": [ # Kubernetes [Pods](https://cloud.google.com/kubernetes-engine/docs/concepts/pod) associated with the finding. This field contains Pod records for each container that is owned by a Pod. - { # A Kubernetes Pod. - "containers": [ # Pod containers associated with this finding, if any. - { # Container associated with the finding. - "createTime": "A String", # The time that the container was created. - "imageId": "A String", # Optional container image ID, if provided by the container runtime. Uniquely identifies the container image launched using a container image digest. - "labels": [ # Container labels, as provided by the container runtime. - { # Represents a generic name-value label. A label has separate name and value fields to support filtering with the `contains()` function. For more information, see [Filtering on array-type fields](https://cloud.google.com/security-command-center/docs/how-to-api-list-findings#array-contains-filtering). - "name": "A String", # Name of the label. - "value": "A String", # Value that corresponds to the label's name. + "pods": [ + { + "containers": [ + { + "createTime": "A String", + "imageId": "A String", + "labels": [ + { + "name": "A String", + "value": "A String", }, ], - "name": "A String", # Name of the container. - "uri": "A String", # Container image URI provided when configuring a pod or container. This string can identify a container image version using mutable tags. + "name": "A String", + "uri": "A String", }, ], - "labels": [ # Pod labels. For Kubernetes containers, these are applied to the container. - { # Represents a generic name-value label. A label has separate name and value fields to support filtering with the `contains()` function. For more information, see [Filtering on array-type fields](https://cloud.google.com/security-command-center/docs/how-to-api-list-findings#array-contains-filtering). - "name": "A String", # Name of the label. - "value": "A String", # Value that corresponds to the label's name. + "labels": [ + { + "name": "A String", + "value": "A String", }, ], - "name": "A String", # Kubernetes Pod name. - "ns": "A String", # Kubernetes Pod namespace. + "name": "A String", + "ns": "A String", }, ], - "roles": [ # Provides Kubernetes role information for findings that involve [Roles or ClusterRoles](https://cloud.google.com/kubernetes-engine/docs/how-to/role-based-access-control). - { # Kubernetes Role or ClusterRole. - "kind": "A String", # Role type. - "name": "A String", # Role name. - "ns": "A String", # Role namespace. + "roles": [ + { + "kind": "A String", + "name": "A String", + "ns": "A String", }, ], }, - "loadBalancers": [ # The load balancers associated with the finding. - { # Contains information related to the load balancer associated with the finding. - "name": "A String", # The name of the load balancer associated with the finding. + "loadBalancers": [ + { + "name": "A String", }, ], - "logEntries": [ # Log entries that are relevant to the finding. - { # An individual entry in a log. - "cloudLoggingEntry": { # Metadata taken from a [Cloud Logging LogEntry](https://cloud.google.com/logging/docs/reference/v2/rest/v2/LogEntry) # An individual entry in a log stored in Cloud Logging. - "insertId": "A String", # A unique identifier for the log entry. - "logId": "A String", # The type of the log (part of `log_name`. `log_name` is the resource name of the log to which this log entry belongs). For example: `cloudresourcemanager.googleapis.com/activity`. Note that this field is not URL-encoded, unlike the `LOG_ID` field in `LogEntry`. - "resourceContainer": "A String", # The organization, folder, or project of the monitored resource that produced this log entry. - "timestamp": "A String", # The time the event described by the log entry occurred. + "logEntries": [ + { + "cloudLoggingEntry": { + "insertId": "A String", + "logId": "A String", + "resourceContainer": "A String", + "timestamp": "A String", }, }, ], - "mitreAttack": { # MITRE ATT&CK tactics and techniques related to this finding. See: https://attack.mitre.org # MITRE ATT&CK tactics and techniques related to this finding. See: https://attack.mitre.org - "additionalTactics": [ # Additional MITRE ATT&CK tactics related to this finding, if any. + "mitreAttack": { + "additionalTactics": [ "A String", ], - "additionalTechniques": [ # Additional MITRE ATT&CK techniques related to this finding, if any, along with any of their respective parent techniques. + "additionalTechniques": [ "A String", ], - "primaryTactic": "A String", # The MITRE ATT&CK tactic most closely represented by this finding, if any. - "primaryTechniques": [ # The MITRE ATT&CK technique most closely represented by this finding, if any. primary_techniques is a repeated field because there are multiple levels of MITRE ATT&CK techniques. If the technique most closely represented by this finding is a sub-technique (e.g. `SCANNING_IP_BLOCKS`), both the sub-technique and its parent technique(s) will be listed (e.g. `SCANNING_IP_BLOCKS`, `ACTIVE_SCANNING`). + "primaryTactic": "A String", + "primaryTechniques": [ "A String", ], - "version": "A String", # The MITRE ATT&CK version referenced by the above fields. E.g. "8". + "version": "A String", }, - "moduleName": "A String", # Unique identifier of the module which generated the finding. Example: folders/598186756061/securityHealthAnalyticsSettings/customModules/56799441161885 - "mute": "A String", # Indicates the mute state of a finding (either muted, unmuted or undefined). Unlike other attributes of a finding, a finding provider shouldn't set the value of mute. - "muteInfo": { # Mute information about the finding, including whether the finding has a static mute or any matching dynamic mute rules. # Output only. The mute information regarding this finding. - "dynamicMuteRecords": [ # The list of dynamic mute rules that currently match the finding. - { # The record of a dynamic mute rule that matches the finding. - "matchTime": "A String", # When the dynamic mute rule first matched the finding. - "muteConfig": "A String", # The relative resource name of the mute rule, represented by a mute config, that created this record, for example `organizations/123/muteConfigs/mymuteconfig` or `organizations/123/locations/global/muteConfigs/mymuteconfig`. + "moduleName": "A String", + "mute": "A String", + "muteInfo": { + "dynamicMuteRecords": [ + { + "matchTime": "A String", + "muteConfig": "A String", }, ], - "staticMute": { # Information about the static mute state. A static mute state overrides any dynamic mute rules that apply to this finding. The static mute state can be set by a static mute rule or by muting the finding directly. # If set, the static mute applied to this finding. Static mutes override dynamic mutes. If unset, there is no static mute. - "applyTime": "A String", # When the static mute was applied. - "state": "A String", # The static mute state. If the value is `MUTED` or `UNMUTED`, then the finding's overall mute state will have the same value. + "staticMute": { + "applyTime": "A String", + "state": "A String", }, }, - "muteInitiator": "A String", # Records additional information about the mute operation, for example, the [mute configuration](/security-command-center/docs/how-to-mute-findings) that muted the finding and the user who muted the finding. - "muteUpdateTime": "A String", # Output only. The most recent time this finding was muted or unmuted. - "name": "A String", # The [relative resource name](https://cloud.google.com/apis/design/resource_names#relative_resource_name) of the finding. Example: "organizations/{organization_id}/sources/{source_id}/findings/{finding_id}", "folders/{folder_id}/sources/{source_id}/findings/{finding_id}", "projects/{project_id}/sources/{source_id}/findings/{finding_id}". - "networks": [ # Represents the VPC networks that the resource is attached to. - { # Contains information about a VPC network associated with the finding. - "name": "A String", # The name of the VPC network resource, for example, `//compute.googleapis.com/projects/my-project/global/networks/my-network`. + "muteInitiator": "A String", + "muteUpdateTime": "A String", + "name": "A String", + "networks": [ + { + "name": "A String", }, ], - "nextSteps": "A String", # Steps to address the finding. - "notebook": { # Represents a Jupyter notebook IPYNB file, such as a [Colab Enterprise notebook](https://cloud.google.com/colab/docs/introduction) file, that is associated with a finding. # Notebook associated with the finding. - "lastAuthor": "A String", # The user ID of the latest author to modify the notebook. - "name": "A String", # The name of the notebook. - "notebookUpdateTime": "A String", # The most recent time the notebook was updated. - "service": "A String", # The source notebook service, for example, "Colab Enterprise". + "nextSteps": "A String", + "notebook": { + "lastAuthor": "A String", + "name": "A String", + "notebookUpdateTime": "A String", + "service": "A String", }, - "orgPolicies": [ # Contains information about the org policies associated with the finding. - { # Contains information about the org policies associated with the finding. - "name": "A String", # The resource name of the org policy. Example: "organizations/{organization_id}/policies/{constraint_name}" + "orgPolicies": [ + { + "name": "A String", }, ], - "parent": "A String", # The relative resource name of the source the finding belongs to. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name This field is immutable after creation time. For example: "organizations/{organization_id}/sources/{source_id}" - "parentDisplayName": "A String", # Output only. The human readable display name of the finding source such as "Event Threat Detection" or "Security Health Analytics". - "policyViolationSummary": { # Metadata summarizing policy violations of child resources of the affected resource. `finding_category` and `resource` determine the exact semantics of the counts. For example, when category=DATA_SECURITY_POSTURE_OBJECT_PUBLIC_ACCESS_VIOLATION and resource='storage.googleapis.com/buckets/my-bucket-name' then this counts the number of Cloud Storage objects in my-bucket-name which violate a Public Access control. # PolicyViolationSummary associated with the finding. - "conformantResourcesCount": "A String", # Total number of child resources that conform to the policy. - "evaluationErrorsCount": "A String", # Number of child resources for which errors during evaluation occurred. The evaluation result for these child resources is effectively "unknown". - "outOfScopeResourcesCount": "A String", # Total count of child resources which were not in scope for evaluation. - "policyViolationsCount": "A String", # Count of child resources in violation of the policy. + "parent": "A String", + "parentDisplayName": "A String", + "policyViolationSummary": { + "conformantResourcesCount": "A String", + "evaluationErrorsCount": "A String", + "outOfScopeResourcesCount": "A String", + "policyViolationsCount": "A String", }, - "processes": [ # Represents operating system processes associated with the Finding. - { # Represents an operating system process. - "args": [ # Process arguments as JSON encoded strings. + "processes": [ + { + "args": [ "A String", ], - "argumentsTruncated": True or False, # True if `args` is incomplete. - "binary": { # File information about the related binary/library used by an executable, or the script used by a script interpreter # File information for the process executable. - "contents": "A String", # Prefix of the file contents as a JSON-encoded string. - "diskPath": { # Path of the file in terms of underlying disk/partition identifiers. # Path of the file in terms of underlying disk/partition identifiers. - "partitionUuid": "A String", # UUID of the partition (format https://wiki.archlinux.org/title/persistent_block_device_naming#by-uuid) - "relativePath": "A String", # Relative path of the file in the partition as a JSON encoded string. Example: /home/user1/executable_file.sh + "argumentsTruncated": True or False, + "binary": { + "contents": "A String", + "diskPath": { + "partitionUuid": "A String", + "relativePath": "A String", }, - "fileLoadState": "A String", # The load state of the file. - "hashedSize": "A String", # The length in bytes of the file prefix that was hashed. If hashed_size == size, any hashes reported represent the entire file. - "operations": [ # Operation(s) performed on a file. - { # Operation(s) performed on a file. - "type": "A String", # The type of the operation + "fileLoadState": "A String", + "hashedSize": "A String", + "operations": [ + { + "type": "A String", }, ], - "partiallyHashed": True or False, # True when the hash covers only a prefix of the file. - "path": "A String", # Absolute path of the file as a JSON encoded string. - "sha256": "A String", # SHA256 hash of the first hashed_size bytes of the file encoded as a hex string. If hashed_size == size, sha256 represents the SHA256 hash of the entire file. - "size": "A String", # Size of the file in bytes. + "partiallyHashed": True or False, + "path": "A String", + "sha256": "A String", + "size": "A String", }, - "envVariables": [ # Process environment variables. - { # A name-value pair representing an environment variable used in an operating system process. - "name": "A String", # Environment variable name as a JSON encoded string. - "val": "A String", # Environment variable value as a JSON encoded string. + "envVariables": [ + { + "name": "A String", + "val": "A String", }, ], - "envVariablesTruncated": True or False, # True if `env_variables` is incomplete. - "libraries": [ # File information for libraries loaded by the process. - { # File information about the related binary/library used by an executable, or the script used by a script interpreter - "contents": "A String", # Prefix of the file contents as a JSON-encoded string. - "diskPath": { # Path of the file in terms of underlying disk/partition identifiers. # Path of the file in terms of underlying disk/partition identifiers. - "partitionUuid": "A String", # UUID of the partition (format https://wiki.archlinux.org/title/persistent_block_device_naming#by-uuid) - "relativePath": "A String", # Relative path of the file in the partition as a JSON encoded string. Example: /home/user1/executable_file.sh + "envVariablesTruncated": True or False, + "libraries": [ + { + "contents": "A String", + "diskPath": { + "partitionUuid": "A String", + "relativePath": "A String", }, - "fileLoadState": "A String", # The load state of the file. - "hashedSize": "A String", # The length in bytes of the file prefix that was hashed. If hashed_size == size, any hashes reported represent the entire file. - "operations": [ # Operation(s) performed on a file. - { # Operation(s) performed on a file. - "type": "A String", # The type of the operation + "fileLoadState": "A String", + "hashedSize": "A String", + "operations": [ + { + "type": "A String", }, ], - "partiallyHashed": True or False, # True when the hash covers only a prefix of the file. - "path": "A String", # Absolute path of the file as a JSON encoded string. - "sha256": "A String", # SHA256 hash of the first hashed_size bytes of the file encoded as a hex string. If hashed_size == size, sha256 represents the SHA256 hash of the entire file. - "size": "A String", # Size of the file in bytes. + "partiallyHashed": True or False, + "path": "A String", + "sha256": "A String", + "size": "A String", }, ], - "name": "A String", # The process name, as displayed in utilities like `top` and `ps`. This name can be accessed through `/proc/[pid]/comm` and changed with `prctl(PR_SET_NAME)`. - "parentPid": "A String", # The parent process ID. - "pid": "A String", # The process ID. - "script": { # File information about the related binary/library used by an executable, or the script used by a script interpreter # When the process represents the invocation of a script, `binary` provides information about the interpreter, while `script` provides information about the script file provided to the interpreter. - "contents": "A String", # Prefix of the file contents as a JSON-encoded string. - "diskPath": { # Path of the file in terms of underlying disk/partition identifiers. # Path of the file in terms of underlying disk/partition identifiers. - "partitionUuid": "A String", # UUID of the partition (format https://wiki.archlinux.org/title/persistent_block_device_naming#by-uuid) - "relativePath": "A String", # Relative path of the file in the partition as a JSON encoded string. Example: /home/user1/executable_file.sh + "name": "A String", + "parentPid": "A String", + "pid": "A String", + "script": { + "contents": "A String", + "diskPath": { + "partitionUuid": "A String", + "relativePath": "A String", }, - "fileLoadState": "A String", # The load state of the file. - "hashedSize": "A String", # The length in bytes of the file prefix that was hashed. If hashed_size == size, any hashes reported represent the entire file. - "operations": [ # Operation(s) performed on a file. - { # Operation(s) performed on a file. - "type": "A String", # The type of the operation + "fileLoadState": "A String", + "hashedSize": "A String", + "operations": [ + { + "type": "A String", }, ], - "partiallyHashed": True or False, # True when the hash covers only a prefix of the file. - "path": "A String", # Absolute path of the file as a JSON encoded string. - "sha256": "A String", # SHA256 hash of the first hashed_size bytes of the file encoded as a hex string. If hashed_size == size, sha256 represents the SHA256 hash of the entire file. - "size": "A String", # Size of the file in bytes. + "partiallyHashed": True or False, + "path": "A String", + "sha256": "A String", + "size": "A String", }, - "userId": "A String", # The ID of the user that executed the process. E.g. If this is the root user this will always be 0. + "userId": "A String", }, ], - "resourceName": "A String", # For findings on Google Cloud resources, the full resource name of the Google Cloud resource this finding is for. See: https://cloud.google.com/apis/design/resource_names#full_resource_name When the finding is for a non-Google Cloud resource, the resourceName can be a customer or partner defined string. This field is immutable after creation time. - "secret": { # Details about a secret or credential associated with the finding. # Secret associated with the finding. - "environmentVariable": { # Environment variable containing the secret. # The environment variable containing the secret. - "key": "A String", # Environment variable name as a JSON encoded string. Note that value is not included since the value contains the secret data, which is sensitive core content. + "resourceName": "A String", + "secret": { + "environmentVariable": { + "key": "A String", }, - "filePath": { # File path containing the secret. # The file containing the secret. - "path": "A String", # Path to the file. + "filePath": { + "path": "A String", }, - "status": { # The status of the secret. # The status of the secret. - "lastUpdatedTime": "A String", # Time that the secret was found. - "validity": "A String", # The validity of the secret. + "status": { + "lastUpdatedTime": "A String", + "validity": "A String", }, - "type": "A String", # The type of secret, for example, GCP_API_KEY. + "type": "A String", }, - "securityMarks": { # User specified security marks that are attached to the parent Security Command Center resource. Security marks are scoped within a Security Command Center organization -- they can be modified and viewed by all users who have proper permissions on the organization. # Output only. User specified security marks. These marks are entirely managed by the user and come from the SecurityMarks resource that belongs to the finding. - "canonicalName": "A String", # The canonical name of the marks. Examples: "organizations/{organization_id}/assets/{asset_id}/securityMarks" "folders/{folder_id}/assets/{asset_id}/securityMarks" "projects/{project_number}/assets/{asset_id}/securityMarks" "organizations/{organization_id}/sources/{source_id}/findings/{finding_id}/securityMarks" "folders/{folder_id}/sources/{source_id}/findings/{finding_id}/securityMarks" "projects/{project_number}/sources/{source_id}/findings/{finding_id}/securityMarks" - "marks": { # Mutable user specified security marks belonging to the parent resource. Constraints are as follows: * Keys and values are treated as case insensitive * Keys must be between 1 - 256 characters (inclusive) * Keys must be letters, numbers, underscores, or dashes * Values have leading and trailing whitespace trimmed, remaining characters must be between 1 - 4096 characters (inclusive) + "securityMarks": { + "canonicalName": "A String", + "marks": { "a_key": "A String", }, - "name": "A String", # The relative resource name of the SecurityMarks. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Examples: "organizations/{organization_id}/assets/{asset_id}/securityMarks" "organizations/{organization_id}/sources/{source_id}/findings/{finding_id}/securityMarks". + "name": "A String", }, - "securityPosture": { # Represents a posture that is deployed on Google Cloud by the Security Command Center Posture Management service. A posture contains one or more policy sets. A policy set is a group of policies that enforce a set of security rules on Google Cloud. # The security posture associated with the finding. - "changedPolicy": "A String", # The name of the updated policy, for example, `projects/{project_id}/policies/{constraint_name}`. - "name": "A String", # Name of the posture, for example, `CIS-Posture`. - "policy": "A String", # The ID of the updated policy, for example, `compute-policy-1`. - "policyDriftDetails": [ # The details about a change in an updated policy that violates the deployed posture. - { # The policy field that violates the deployed posture and its expected and detected values. - "detectedValue": "A String", # The detected value that violates the deployed posture, for example, `false` or `allowed_values={"projects/22831892"}`. - "expectedValue": "A String", # The value of this field that was configured in a posture, for example, `true` or `allowed_values={"projects/29831892"}`. - "field": "A String", # The name of the updated field, for example constraint.implementation.policy_rules[0].enforce + "securityPosture": { + "changedPolicy": "A String", + "name": "A String", + "policy": "A String", + "policyDriftDetails": [ + { + "detectedValue": "A String", + "expectedValue": "A String", + "field": "A String", }, ], - "policySet": "A String", # The name of the updated policyset, for example, `cis-policyset`. - "postureDeployment": "A String", # The name of the posture deployment, for example, `organizations/{org_id}/posturedeployments/{posture_deployment_id}`. - "postureDeploymentResource": "A String", # The project, folder, or organization on which the posture is deployed, for example, `projects/{project_number}`. - "revisionId": "A String", # The version of the posture, for example, `c7cfa2a8`. + "policySet": "A String", + "postureDeployment": "A String", + "postureDeploymentResource": "A String", + "revisionId": "A String", }, - "severity": "A String", # The severity of the finding. This field is managed by the source that writes the finding. - "sourceProperties": { # Source specific properties. These properties are managed by the source that writes the finding. The key names in the source_properties map must be between 1 and 255 characters, and must start with a letter and contain alphanumeric characters or underscores only. + "severity": "A String", + "sourceProperties": { "a_key": "", }, - "state": "A String", # The state of the finding. - "toxicCombination": { # Contains details about a group of security issues that, when the issues occur together, represent a greater risk than when the issues occur independently. A group of such issues is referred to as a toxic combination. # Contains details about a group of security issues that, when the issues occur together, represent a greater risk than when the issues occur independently. A group of such issues is referred to as a toxic combination. This field cannot be updated. Its value is ignored in all update requests. - "attackExposureScore": 3.14, # The [Attack exposure score](https://cloud.google.com/security-command-center/docs/attack-exposure-learn#attack_exposure_scores) of this toxic combination. The score is a measure of how much this toxic combination exposes one or more high-value resources to potential attack. - "relatedFindings": [ # List of resource names of findings associated with this toxic combination. For example, `organizations/123/sources/456/findings/789`. + "state": "A String", + "toxicCombination": { + "attackExposureScore": 3.14, + "relatedFindings": [ "A String", ], }, - "vertexAi": { # Vertex AI-related information associated with the finding. # VertexAi associated with the finding. - "datasets": [ # Datasets associated with the finding. - { # Vertex AI dataset associated with the finding. - "displayName": "A String", # The user defined display name of dataset, e.g. plants-dataset - "name": "A String", # Resource name of the dataset, e.g. projects/{project}/locations/{location}/datasets/2094040236064505856 - "source": "A String", # Data source, such as BigQuery source URI, e.g. bq://scc-nexus-test.AIPPtest.gsod + "vertexAi": { + "datasets": [ + { + "displayName": "A String", + "name": "A String", + "source": "A String", }, ], - "pipelines": [ # Pipelines associated with the finding. - { # Vertex AI training pipeline associated with the finding. - "displayName": "A String", # The user defined display name of pipeline, e.g. plants-classification - "name": "A String", # Resource name of the pipeline, e.g. projects/{project}/locations/{location}/trainingPipelines/5253428229225578496 + "pipelines": [ + { + "displayName": "A String", + "name": "A String", }, ], }, - "vulnerability": { # Refers to common vulnerability fields e.g. cve, cvss, cwe etc. # Represents vulnerability-specific fields like CVE and CVSS scores. CVE stands for Common Vulnerabilities and Exposures (https://cve.mitre.org/about/) - "cve": { # CVE stands for Common Vulnerabilities and Exposures. Information from the [CVE record](https://www.cve.org/ResourcesSupport/Glossary) that describes this vulnerability. # CVE stands for Common Vulnerabilities and Exposures (https://cve.mitre.org/about/) - "cvssv3": { # Common Vulnerability Scoring System version 3. # Describe Common Vulnerability Scoring System specified at https://www.first.org/cvss/v3.1/specification-document - "attackComplexity": "A String", # This metric describes the conditions beyond the attacker's control that must exist in order to exploit the vulnerability. - "attackVector": "A String", # Base Metrics Represents the intrinsic characteristics of a vulnerability that are constant over time and across user environments. This metric reflects the context by which vulnerability exploitation is possible. - "availabilityImpact": "A String", # This metric measures the impact to the availability of the impacted component resulting from a successfully exploited vulnerability. - "baseScore": 3.14, # The base score is a function of the base metric scores. - "confidentialityImpact": "A String", # This metric measures the impact to the confidentiality of the information resources managed by a software component due to a successfully exploited vulnerability. - "integrityImpact": "A String", # This metric measures the impact to integrity of a successfully exploited vulnerability. - "privilegesRequired": "A String", # This metric describes the level of privileges an attacker must possess before successfully exploiting the vulnerability. - "scope": "A String", # The Scope metric captures whether a vulnerability in one vulnerable component impacts resources in components beyond its security scope. - "userInteraction": "A String", # This metric captures the requirement for a human user, other than the attacker, to participate in the successful compromise of the vulnerable component. + "vulnerability": { + "cve": { + "cvssv3": { + "attackComplexity": "A String", + "attackVector": "A String", + "availabilityImpact": "A String", + "baseScore": 3.14, + "confidentialityImpact": "A String", + "integrityImpact": "A String", + "privilegesRequired": "A String", + "scope": "A String", + "userInteraction": "A String", }, - "exploitReleaseDate": "A String", # Date the first publicly available exploit or PoC was released. - "exploitationActivity": "A String", # The exploitation activity of the vulnerability in the wild. - "firstExploitationDate": "A String", # Date of the earliest known exploitation. - "id": "A String", # The unique identifier for the vulnerability. e.g. CVE-2021-34527 - "impact": "A String", # The potential impact of the vulnerability if it was to be exploited. - "observedInTheWild": True or False, # Whether or not the vulnerability has been observed in the wild. - "references": [ # Additional information about the CVE. e.g. https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2021-34527 - { # Additional Links - "source": "A String", # Source of the reference e.g. NVD - "uri": "A String", # Uri for the mentioned source e.g. https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2021-34527. + "exploitReleaseDate": "A String", + "exploitationActivity": "A String", + "firstExploitationDate": "A String", + "id": "A String", + "impact": "A String", + "observedInTheWild": True or False, + "references": [ + { + "source": "A String", + "uri": "A String", }, ], - "upstreamFixAvailable": True or False, # Whether upstream fix is available for the CVE. - "zeroDay": True or False, # Whether or not the vulnerability was zero day when the finding was published. + "upstreamFixAvailable": True or False, + "zeroDay": True or False, }, - "cwes": [ # Represents one or more Common Weakness Enumeration (CWE) information on this vulnerability. - { # CWE stands for Common Weakness Enumeration. Information about this weakness, as described by [CWE](https://cwe.mitre.org/). - "id": "A String", # The CWE identifier, e.g. CWE-94 - "references": [ # Any reference to the details on the CWE, for example, https://cwe.mitre.org/data/definitions/94.html - { # Additional Links - "source": "A String", # Source of the reference e.g. NVD - "uri": "A String", # Uri for the mentioned source e.g. https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2021-34527. + "cwes": [ + { + "id": "A String", + "references": [ + { + "source": "A String", + "uri": "A String", }, ], }, ], - "fixedPackage": { # Package is a generic definition of a package. # The fixed package is relevant to the finding. - "cpeUri": "A String", # The CPE URI where the vulnerability was detected. - "packageName": "A String", # The name of the package where the vulnerability was detected. - "packageType": "A String", # Type of package, for example, os, maven, or go. - "packageVersion": "A String", # The version of the package. + "fixedPackage": { + "cpeUri": "A String", + "packageName": "A String", + "packageType": "A String", + "packageVersion": "A String", }, - "offendingPackage": { # Package is a generic definition of a package. # The offending package is relevant to the finding. - "cpeUri": "A String", # The CPE URI where the vulnerability was detected. - "packageName": "A String", # The name of the package where the vulnerability was detected. - "packageType": "A String", # Type of package, for example, os, maven, or go. - "packageVersion": "A String", # The version of the package. + "offendingPackage": { + "cpeUri": "A String", + "packageName": "A String", + "packageType": "A String", + "packageVersion": "A String", }, - "providerRiskScore": "A String", # Provider provided risk_score based on multiple factors. The higher the risk score, the more risky the vulnerability is. - "reachable": True or False, # Represents whether the vulnerability is reachable (detected via static analysis) - "securityBulletin": { # SecurityBulletin are notifications of vulnerabilities of Google products. # The security bulletin is relevant to this finding. - "bulletinId": "A String", # ID of the bulletin corresponding to the vulnerability. - "submissionTime": "A String", # Submission time of this Security Bulletin. - "suggestedUpgradeVersion": "A String", # This represents a version that the cluster receiving this notification should be upgraded to, based on its current version. For example, 1.15.0 + "providerRiskScore": "A String", + "reachable": True or False, + "securityBulletin": { + "bulletinId": "A String", + "submissionTime": "A String", + "suggestedUpgradeVersion": "A String", }, }, }, - "resource": { # Information related to the Google Cloud resource that is associated with this finding. # Output only. Resource that is associated with this finding. - "adcApplication": { # Represents an ADC application associated with the finding. # The ADC application associated with the finding. - "attributes": { # Consumer provided attributes for the application # Consumer provided attributes for the AppHub application. - "businessOwners": [ # Business team that ensures user needs are met and value is delivered - { # Contact information of stakeholders. - "email": "A String", # Email address of the contacts. + "resource": { + "adcApplication": { + "attributes": { + "businessOwners": [ + { + "email": "A String", }, ], - "criticality": { # Criticality of the Application, Service, or Workload # User-defined criticality information. - "type": "A String", # Criticality Type. + "criticality": { + "type": "A String", }, - "developerOwners": [ # Developer team that owns development and coding. - { # Contact information of stakeholders. - "email": "A String", # Email address of the contacts. + "developerOwners": [ + { + "email": "A String", }, ], - "environment": { # Environment of the Application, Service, or Workload # User-defined environment information. - "type": "A String", # Environment Type. + "environment": { + "type": "A String", }, - "operatorOwners": [ # Operator team that ensures runtime and operations. - { # Contact information of stakeholders. - "email": "A String", # Email address of the contacts. + "operatorOwners": [ + { + "email": "A String", }, ], }, - "name": "A String", # The resource name of an ADC Application. Format: projects/{project}/locations/{location}/spaces/{space}/applications/{application} + "name": "A String", }, - "adcApplicationTemplate": { # Represents an ADC template associated with the finding. # The ADC template associated with the finding. - "name": "A String", # The resource name of an ADC Application Template Revision. Format: projects/{project}/locations/{location}/spaces/{space}/applicationTemplates/{application_template}/revisions/{revision} + "adcApplicationTemplate": { + "name": "A String", }, - "adcSharedTemplate": { # Represents an ADC shared template associated with the finding. # The ADC shared template associated with the finding. - "name": "A String", # The resource name of an ADC Shared Template Revision. Format: projects/{project}/locations/{location}/spaces/{space}/applicationTemplates/{application_template}/revisions/{revision} + "adcSharedTemplate": { + "name": "A String", }, - "application": { # The App Hub Application associated with the finding's resource. # The App Hub application this resource belongs to. - "attributes": { # Consumer provided attributes for the application # Consumer provided attributes for the application - "businessOwners": [ # Business team that ensures user needs are met and value is delivered - { # Contact information of stakeholders. - "email": "A String", # Email address of the contacts. + "application": { + "attributes": { + "businessOwners": [ + { + "email": "A String", }, ], - "criticality": { # Criticality of the Application, Service, or Workload # User-defined criticality information. - "type": "A String", # Criticality Type. + "criticality": { + "type": "A String", }, - "developerOwners": [ # Developer team that owns development and coding. - { # Contact information of stakeholders. - "email": "A String", # Email address of the contacts. + "developerOwners": [ + { + "email": "A String", }, ], - "environment": { # Environment of the Application, Service, or Workload # User-defined environment information. - "type": "A String", # Environment Type. + "environment": { + "type": "A String", }, - "operatorOwners": [ # Operator team that ensures runtime and operations. - { # Contact information of stakeholders. - "email": "A String", # Email address of the contacts. + "operatorOwners": [ + { + "email": "A String", }, ], }, - "name": "A String", # The resource name of an Application. Format: `projects/{host-project-id}/locations/{location}/applications/{application-id}` + "name": "A String", }, - "awsMetadata": { # AWS metadata associated with the resource, only applicable if the finding's cloud provider is Amazon Web Services. # The AWS metadata associated with the finding. - "account": { # An AWS account that is a member of an organization. # The AWS account associated with the resource. - "id": "A String", # The unique identifier (ID) of the account, containing exactly 12 digits. - "name": "A String", # The friendly name of this account. + "awsMetadata": { + "account": { + "id": "A String", + "name": "A String", }, - "organization": { # An organization is a collection of accounts that are centrally managed together using consolidated billing, organized hierarchically with organizational units (OUs), and controlled with policies. # The AWS organization associated with the resource. - "id": "A String", # The unique identifier (ID) for the organization. The regex pattern for an organization ID string requires "o-" followed by from 10 to 32 lowercase letters or digits. + "organization": { + "id": "A String", }, - "organizationalUnits": [ # A list of AWS organizational units associated with the resource, ordered from lowest level (closest to the account) to highest level. - { # An Organizational Unit (OU) is a container of AWS accounts within a root of an organization. Policies that are attached to an OU apply to all accounts contained in that OU and in any child OUs. - "id": "A String", # The unique identifier (ID) associated with this OU. The regex pattern for an organizational unit ID string requires "ou-" followed by from 4 to 32 lowercase letters or digits (the ID of the root that contains the OU). This string is followed by a second "-" dash and from 8 to 32 additional lowercase letters or digits. For example, "ou-ab12-cd34ef56". - "name": "A String", # The friendly name of the OU. + "organizationalUnits": [ + { + "id": "A String", + "name": "A String", }, ], }, - "azureMetadata": { # Azure metadata associated with the resource, only applicable if the finding's cloud provider is Microsoft Azure. # The Azure metadata associated with the finding. - "managementGroups": [ # A list of Azure management groups associated with the resource, ordered from lowest level (closest to the subscription) to highest level. - { # Represents an Azure management group. - "displayName": "A String", # The display name of the Azure management group. - "id": "A String", # The UUID of the Azure management group, for example, `20000000-0001-0000-0000-000000000000`. + "azureMetadata": { + "managementGroups": [ + { + "displayName": "A String", + "id": "A String", }, ], - "resourceGroup": { # Represents an Azure resource group. # The Azure resource group associated with the resource. - "id": "A String", # The ID of the Azure resource group. - "name": "A String", # The name of the Azure resource group. This is not a UUID. + "resourceGroup": { + "id": "A String", + "name": "A String", }, - "subscription": { # Represents an Azure subscription. # The Azure subscription associated with the resource. - "displayName": "A String", # The display name of the Azure subscription. - "id": "A String", # The UUID of the Azure subscription, for example, `291bba3f-e0a5-47bc-a099-3bdcb2a50a05`. + "subscription": { + "displayName": "A String", + "id": "A String", }, - "tenant": { # Represents a Microsoft Entra tenant. # The Azure Entra tenant associated with the resource. - "displayName": "A String", # The display name of the Azure tenant. - "id": "A String", # The ID of the Microsoft Entra tenant, for example, "a11aaa11-aa11-1aa1-11aa-1aaa11a". + "tenant": { + "displayName": "A String", + "id": "A String", }, }, - "cloudProvider": "A String", # Indicates which cloud provider the finding is from. - "displayName": "A String", # The human readable name of the resource. - "folders": [ # Contains a Folder message for each folder in the assets ancestry. The first folder is the deepest nested folder, and the last folder is the folder directly under the Organization. - { # Message that contains the resource name and display name of a folder resource. - "resourceFolder": "A String", # Full resource name of this folder. See: https://cloud.google.com/apis/design/resource_names#full_resource_name - "resourceFolderDisplayName": "A String", # The user defined display name for this folder. + "cloudProvider": "A String", + "displayName": "A String", + "folders": [ + { + "resourceFolder": "A String", + "resourceFolderDisplayName": "A String", }, ], - "location": "A String", # The region or location of the service (if applicable). - "name": "A String", # The full resource name of the resource. See: https://cloud.google.com/apis/design/resource_names#full_resource_name - "organization": "A String", # Indicates which organization / tenant the finding is for. - "parentDisplayName": "A String", # The human readable name of resource's parent. - "parentName": "A String", # The full resource name of resource's parent. - "projectDisplayName": "A String", # The project ID that the resource belongs to. - "projectName": "A String", # The full resource name of project that the resource belongs to. - "resourcePath": { # Represents the path of resources leading up to the resource this finding is about. # Provides the path to the resource within the resource hierarchy. - "nodes": [ # The list of nodes that make the up resource path, ordered from lowest level to highest level. - { # A node within the resource path. Each node represents a resource within the resource hierarchy. - "displayName": "A String", # The display name of the resource this node represents. - "id": "A String", # The ID of the resource this node represents. - "nodeType": "A String", # The type of resource this node represents. + "location": "A String", + "name": "A String", + "organization": "A String", + "parentDisplayName": "A String", + "parentName": "A String", + "projectDisplayName": "A String", + "projectName": "A String", + "resourcePath": { + "nodes": [ + { + "displayName": "A String", + "id": "A String", + "nodeType": "A String", }, ], }, - "resourcePathString": "A String", # A string representation of the resource path. For Google Cloud, it has the format of `org/{organization_id}/folder/{folder_id}/folder/{folder_id}/project/{project_id}` where there can be any number of folders. For AWS, it has the format of `org/{organization_id}/ou/{organizational_unit_id}/ou/{organizational_unit_id}/account/{account_id}` where there can be any number of organizational units. For Azure, it has the format of `mg/{management_group_id}/mg/{management_group_id}/subscription/{subscription_id}/rg/{resource_group_name}` where there can be any number of management groups. - "service": "A String", # The service or resource provider associated with the resource. - "type": "A String", # The full resource type of the resource. + "resourcePathString": "A String", + "service": "A String", + "type": "A String", }, - "stateChange": "A String", # State change of the finding between the points in time. + "stateChange": "A String", }, ], - "nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no more results. - "readTime": "A String", # Time used for executing the list request. - "totalSize": 42, # The total number of findings matching the query. + "nextPageToken": "A String", + "readTime": "A String", + "totalSize": 42, }
@@ -1146,823 +1146,823 @@

Method Details

patch(name, body=None, updateMask=None, x__xgafv=None) -
Creates or updates a finding. The corresponding source must exist for a finding creation to succeed.
+  
 
 Args:
-  name: string, The [relative resource name](https://cloud.google.com/apis/design/resource_names#relative_resource_name) of the finding. Example: "organizations/{organization_id}/sources/{source_id}/findings/{finding_id}", "folders/{folder_id}/sources/{source_id}/findings/{finding_id}", "projects/{project_id}/sources/{source_id}/findings/{finding_id}". (required)
+  name: string, A parameter (required)
   body: object, The request body.
     The object takes the form of:
 
-{ # Security Command Center finding. A finding is a record of assessment data like security, risk, health, or privacy, that is ingested into Security Command Center for presentation, notification, analysis, policy testing, and enforcement. For example, a cross-site scripting (XSS) vulnerability in an App Engine application is a finding.
-  "access": { # Represents an access event. # Access details associated with the finding, such as more information on the caller, which method was accessed, and from where.
-    "callerIp": "A String", # Caller's IP address, such as "1.1.1.1".
-    "callerIpGeo": { # Represents a geographical location for a given access. # The caller IP's geolocation, which identifies where the call came from.
-      "regionCode": "A String", # A CLDR.
-    },
-    "methodName": "A String", # The method that the service account called, e.g. "SetIamPolicy".
-    "principalEmail": "A String", # Associated email, such as "foo@google.com". The email address of the authenticated user or a service account acting on behalf of a 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).
-    "principalSubject": "A String", # A string that represents the principal_subject that is associated with the identity. Unlike `principal_email`, `principal_subject` supports principals that aren't associated with email addresses, such as third party principals. For most identities, the format is `principal://iam.googleapis.com/{identity pool name}/subject/{subject}`. Some GKE identities, such as GKE_WORKLOAD, FREEFORM, and GKE_HUB_WORKLOAD, still use the legacy format `serviceAccount:{identity pool name}[{subject}]`.
-    "serviceAccountDelegationInfo": [ # The identity delegation history of an authenticated service account that made the request. The `serviceAccountDelegationInfo[]` object contains information about the real authorities that try to access Google Cloud resources by delegating on a service account. When multiple authorities are present, they are guaranteed to be sorted based on the original ordering of the identity delegation events.
-      { # Identity delegation history of an authenticated service account.
-        "principalEmail": "A String", # The email address of a Google account.
-        "principalSubject": "A String", # A string representing the principal_subject associated with the identity. As compared to `principal_email`, supports principals that aren't associated with email addresses, such as third party principals. For most identities, the format will be `principal://iam.googleapis.com/{identity pool name}/subjects/{subject}` except for some GKE identities (GKE_WORKLOAD, FREEFORM, GKE_HUB_WORKLOAD) that are still in the legacy format `serviceAccount:{identity pool name}[{subject}]`
+{
+  "access": {
+    "callerIp": "A String",
+    "callerIpGeo": {
+      "regionCode": "A String",
+    },
+    "methodName": "A String",
+    "principalEmail": "A String",
+    "principalSubject": "A String",
+    "serviceAccountDelegationInfo": [
+      {
+        "principalEmail": "A String",
+        "principalSubject": "A String",
       },
     ],
-    "serviceAccountKeyName": "A String", # The name of the service account key that was used to create or exchange credentials when authenticating the service account that made the request. This is a scheme-less URI full resource name. For example: "//iam.googleapis.com/projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}/keys/{key}".
-    "serviceName": "A String", # This is the API service that the service account made a call to, e.g. "iam.googleapis.com"
-    "userAgent": "A String", # The caller's user agent string associated with the finding.
-    "userAgentFamily": "A String", # Type of user agent associated with the finding. For example, an operating system shell or an embedded or standalone application.
-    "userName": "A String", # A string that represents a username. The username provided depends on the type of the finding and is likely not an IAM principal. For example, this can be a system username if the finding is related to a virtual machine, or it can be an application login username.
+    "serviceAccountKeyName": "A String",
+    "serviceName": "A String",
+    "userAgent": "A String",
+    "userAgentFamily": "A String",
+    "userName": "A String",
   },
-  "affectedResources": { # Details about resources affected by this finding. # AffectedResources associated with the finding.
-    "count": "A String", # The count of resources affected by the finding.
+  "affectedResources": {
+    "count": "A String",
   },
-  "agentDataAccessEvents": [ # Agent data access events associated with the finding.
-    { # Details about a data access attempt made by an agent principal not authorized under applicable data security policy.
-      "eventId": "A String", # Unique identifier for data access event.
-      "eventTime": "A String", # Timestamp of data access event.
-      "operation": "A String", # The operation performed by the principal to access the data.
-      "principalSubject": "A String", # The agent principal that accessed the data.
+  "agentDataAccessEvents": [
+    {
+      "eventId": "A String",
+      "eventTime": "A String",
+      "operation": "A String",
+      "principalSubject": "A String",
     },
   ],
-  "aiModel": { # Contains information about the AI model associated with the finding. # The AI model associated with the finding.
-    "deploymentPlatform": "A String", # The platform on which the model is deployed.
-    "displayName": "A String", # The user defined display name of model. Ex. baseline-classification-model
-    "domain": "A String", # The domain of the model, for example, “image-classification”.
-    "library": "A String", # The name of the model library, for example, “transformers”.
-    "location": "A String", # The region in which the model is used, for example, “us-central1”.
-    "name": "A String", # The name of the AI model, for example, "gemini:1.0.0".
-    "publisher": "A String", # The publisher of the model, for example, “google” or “nvidia”.
-    "usageCategory": "A String", # The purpose of the model, for example, "Inteference" or "Training".
-  },
-  "application": { # Represents an application associated with a finding. # Represents an application associated with the finding.
-    "baseUri": "A String", # The base URI that identifies the network location of the application in which the vulnerability was detected. For example, `http://example.com`.
-    "fullUri": "A String", # The full URI with payload that can be used to reproduce the vulnerability. For example, `http://example.com?p=aMmYgI6H`.
-  },
-  "artifactGuardPolicies": { # Represents the result of evaluating artifact guard policies. # ArtifactGuardPolicies associated with the finding.
-    "failingPolicies": [ # A list of failing policies.
-      { # Represents an artifact guard policy.
-        "failureReason": "A String", # The reason for the policy failure, for example, "severity=HIGH AND max_vuln_count=2".
-        "policyId": "A String", # The ID of the failing policy, for example, "organizations/3392779/locations/global/policies/prod-policy".
-        "type": "A String", # The type of the policy evaluation.
+  "aiModel": {
+    "deploymentPlatform": "A String",
+    "displayName": "A String",
+    "domain": "A String",
+    "library": "A String",
+    "location": "A String",
+    "name": "A String",
+    "publisher": "A String",
+    "usageCategory": "A String",
+  },
+  "application": {
+    "baseUri": "A String",
+    "fullUri": "A String",
+  },
+  "artifactGuardPolicies": {
+    "failingPolicies": [
+      {
+        "failureReason": "A String",
+        "policyId": "A String",
+        "type": "A String",
       },
     ],
-    "resourceId": "A String", # The ID of the resource that has policies configured for it.
+    "resourceId": "A String",
   },
-  "attackExposure": { # An attack exposure contains the results of an attack path simulation run. # The results of an attack path simulation relevant to this finding.
-    "attackExposureResult": "A String", # The resource name of the attack path simulation result that contains the details regarding this attack exposure score. Example: `organizations/123/simulations/456/attackExposureResults/789`
-    "exposedHighValueResourcesCount": 42, # The number of high value resources that are exposed as a result of this finding.
-    "exposedLowValueResourcesCount": 42, # The number of high value resources that are exposed as a result of this finding.
-    "exposedMediumValueResourcesCount": 42, # The number of medium value resources that are exposed as a result of this finding.
-    "latestCalculationTime": "A String", # The most recent time the attack exposure was updated on this finding.
-    "score": 3.14, # A number between 0 (inclusive) and infinity that represents how important this finding is to remediate. The higher the score, the more important it is to remediate.
-    "state": "A String", # What state this AttackExposure is in. This captures whether or not an attack exposure has been calculated or not.
+  "attackExposure": {
+    "attackExposureResult": "A String",
+    "exposedHighValueResourcesCount": 42,
+    "exposedLowValueResourcesCount": 42,
+    "exposedMediumValueResourcesCount": 42,
+    "latestCalculationTime": "A String",
+    "score": 3.14,
+    "state": "A String",
   },
-  "backupDisasterRecovery": { # Information related to Google Cloud Backup and DR Service findings. # Fields related to Backup and DR findings.
-    "appliance": "A String", # The name of the Backup and DR appliance that captures, moves, and manages the lifecycle of backup data. For example, `backup-server-57137`.
-    "applications": [ # The names of Backup and DR applications. An application is a VM, database, or file system on a managed host monitored by a backup and recovery appliance. For example, `centos7-01-vol00`, `centos7-01-vol01`, `centos7-01-vol02`.
+  "backupDisasterRecovery": {
+    "appliance": "A String",
+    "applications": [
       "A String",
     ],
-    "backupCreateTime": "A String", # The timestamp at which the Backup and DR backup was created.
-    "backupTemplate": "A String", # The name of a Backup and DR template which comprises one or more backup policies. See the [Backup and DR documentation](https://cloud.google.com/backup-disaster-recovery/docs/concepts/backup-plan#temp) for more information. For example, `snap-ov`.
-    "backupType": "A String", # The backup type of the Backup and DR image. For example, `Snapshot`, `Remote Snapshot`, `OnVault`.
-    "host": "A String", # The name of a Backup and DR host, which is managed by the backup and recovery appliance and known to the management console. The host can be of type Generic (for example, Compute Engine, SQL Server, Oracle DB, SMB file system, etc.), vCenter, or an ESX server. See the [Backup and DR documentation on hosts](https://cloud.google.com/backup-disaster-recovery/docs/configuration/manage-hosts-and-their-applications) for more information. For example, `centos7-01`.
-    "policies": [ # The names of Backup and DR policies that are associated with a template and that define when to run a backup, how frequently to run a backup, and how long to retain the backup image. For example, `onvaults`.
+    "backupCreateTime": "A String",
+    "backupTemplate": "A String",
+    "backupType": "A String",
+    "host": "A String",
+    "policies": [
       "A String",
     ],
-    "policyOptions": [ # The names of Backup and DR advanced policy options of a policy applying to an application. See the [Backup and DR documentation on policy options](https://cloud.google.com/backup-disaster-recovery/docs/create-plan/policy-settings). For example, `skipofflineappsincongrp, nounmap`.
+    "policyOptions": [
       "A String",
     ],
-    "profile": "A String", # The name of the Backup and DR resource profile that specifies the storage media for backups of application and VM data. See the [Backup and DR documentation on profiles](https://cloud.google.com/backup-disaster-recovery/docs/concepts/backup-plan#profile). For example, `GCP`.
-    "storagePool": "A String", # The name of the Backup and DR storage pool that the backup and recovery appliance is storing data in. The storage pool could be of type Cloud, Primary, Snapshot, or OnVault. See the [Backup and DR documentation on storage pools](https://cloud.google.com/backup-disaster-recovery/docs/concepts/storage-pools). For example, `DiskPoolOne`.
+    "profile": "A String",
+    "storagePool": "A String",
   },
-  "canonicalName": "A String", # The canonical name of the finding. It's either "organizations/{organization_id}/sources/{source_id}/findings/{finding_id}", "folders/{folder_id}/sources/{source_id}/findings/{finding_id}" or "projects/{project_number}/sources/{source_id}/findings/{finding_id}", depending on the closest CRM ancestor of the resource associated with the finding.
-  "category": "A String", # The additional taxonomy group within findings from a given source. This field is immutable after creation time. Example: "XSS_FLASH_INJECTION"
-  "chokepoint": { # Contains details about a chokepoint, which is a resource or resource group where high-risk attack paths converge, based on [attack path simulations] (https://cloud.google.com/security-command-center/docs/attack-exposure-learn#attack_path_simulations). # Contains details about a chokepoint, which is a resource or resource group where high-risk attack paths converge, based on [attack path simulations] (https://cloud.google.com/security-command-center/docs/attack-exposure-learn#attack_path_simulations). This field cannot be updated. Its value is ignored in all update requests.
-    "relatedFindings": [ # List of resource names of findings associated with this chokepoint. For example, organizations/123/sources/456/findings/789. This list will have at most 100 findings.
+  "canonicalName": "A String",
+  "category": "A String",
+  "chokepoint": {
+    "relatedFindings": [
       "A String",
     ],
   },
-  "cloudArmor": { # Fields related to Google Cloud Armor findings. # Fields related to Cloud Armor findings.
-    "adaptiveProtection": { # Information about [Google Cloud Armor Adaptive Protection](https://cloud.google.com/armor/docs/cloud-armor-overview#google-cloud-armor-adaptive-protection). # Information about potential Layer 7 DDoS attacks identified by [Google Cloud Armor Adaptive Protection](https://cloud.google.com/armor/docs/adaptive-protection-overview).
-      "confidence": 3.14, # A score of 0 means that there is low confidence that the detected event is an actual attack. A score of 1 means that there is high confidence that the detected event is an attack. See the [Adaptive Protection documentation](https://cloud.google.com/armor/docs/adaptive-protection-overview#configure-alert-tuning) for further explanation.
-    },
-    "attack": { # Information about DDoS attack volume and classification. # Information about DDoS attack volume and classification.
-      "classification": "A String", # Type of attack, for example, 'SYN-flood', 'NTP-udp', or 'CHARGEN-udp'.
-      "volumeBps": 42, # Total BPS (bytes per second) volume of attack. Deprecated - refer to volume_bps_long instead.
-      "volumeBpsLong": "A String", # Total BPS (bytes per second) volume of attack.
-      "volumePps": 42, # Total PPS (packets per second) volume of attack. Deprecated - refer to volume_pps_long instead.
-      "volumePpsLong": "A String", # Total PPS (packets per second) volume of attack.
-    },
-    "duration": "A String", # Duration of attack from the start until the current moment (updated every 5 minutes).
-    "requests": { # Information about the requests relevant to the finding. # Information about incoming requests evaluated by [Google Cloud Armor security policies](https://cloud.google.com/armor/docs/security-policy-overview).
-      "longTermAllowed": 42, # Allowed RPS (requests per second) over the long term.
-      "longTermDenied": 42, # Denied RPS (requests per second) over the long term.
-      "ratio": 3.14, # For 'Increasing deny ratio', the ratio is the denied traffic divided by the allowed traffic. For 'Allowed traffic spike', the ratio is the allowed traffic in the short term divided by allowed traffic in the long term.
-      "shortTermAllowed": 42, # Allowed RPS (requests per second) in the short term.
-    },
-    "securityPolicy": { # Information about the [Google Cloud Armor security policy](https://cloud.google.com/armor/docs/security-policy-overview) relevant to the finding. # Information about the [Google Cloud Armor security policy](https://cloud.google.com/armor/docs/security-policy-overview) relevant to the finding.
-      "name": "A String", # The name of the Google Cloud Armor security policy, for example, "my-security-policy".
-      "preview": True or False, # Whether or not the associated rule or policy is in preview mode.
-      "type": "A String", # The type of Google Cloud Armor security policy for example, 'backend security policy', 'edge security policy', 'network edge security policy', or 'always-on DDoS protection'.
-    },
-    "threatVector": "A String", # Distinguish between volumetric & protocol DDoS attack and application layer attacks. For example, "L3_4" for Layer 3 and Layer 4 DDoS attacks, or "L_7" for Layer 7 DDoS attacks.
-  },
-  "cloudDlpDataProfile": { # The [data profile](https://cloud.google.com/dlp/docs/data-profiles) associated with the finding. # Cloud DLP data profile that is associated with the finding.
-    "dataProfile": "A String", # Name of the data profile, for example, `projects/123/locations/europe/tableProfiles/8383929`.
-    "infoTypes": [ # Type of information detected by SDP. Info type includes name, version and sensitivity of the detected information type.
-      { # Type of information detected by the API.
-        "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`.
-        "sensitivityScore": { # Score is calculated from of all elements in the data profile. A higher level means the data is more sensitive. # Optional custom sensitivity for this InfoType. This only applies to data profiling.
-          "score": "A String", # The sensitivity score applied to the resource.
+  "cloudArmor": {
+    "adaptiveProtection": {
+      "confidence": 3.14,
+    },
+    "attack": {
+      "classification": "A String",
+      "volumeBps": 42,
+      "volumeBpsLong": "A String",
+      "volumePps": 42,
+      "volumePpsLong": "A String",
+    },
+    "duration": "A String",
+    "requests": {
+      "longTermAllowed": 42,
+      "longTermDenied": 42,
+      "ratio": 3.14,
+      "shortTermAllowed": 42,
+    },
+    "securityPolicy": {
+      "name": "A String",
+      "preview": True or False,
+      "type": "A String",
+    },
+    "threatVector": "A String",
+  },
+  "cloudDlpDataProfile": {
+    "dataProfile": "A String",
+    "infoTypes": [
+      {
+        "name": "A String",
+        "sensitivityScore": {
+          "score": "A String",
         },
-        "version": "A String", # Optional version name for this InfoType.
+        "version": "A String",
       },
     ],
-    "parentType": "A String", # The resource hierarchy level at which the data profile was generated.
+    "parentType": "A String",
   },
-  "cloudDlpInspection": { # Details about the Cloud Data Loss Prevention (Cloud DLP) [inspection job](https://cloud.google.com/dlp/docs/concepts-job-triggers) that produced the finding. # Cloud Data Loss Prevention (Cloud DLP) inspection results that are associated with the finding.
-    "fullScan": True or False, # Whether Cloud DLP scanned the complete resource or a sampled subset.
-    "infoType": "A String", # The type of information (or *[infoType](https://cloud.google.com/dlp/docs/infotypes-reference)*) found, for example, `EMAIL_ADDRESS` or `STREET_ADDRESS`.
-    "infoTypeCount": "A String", # The number of times Cloud DLP found this infoType within this job and resource.
-    "inspectJob": "A String", # Name of the inspection job, for example, `projects/123/locations/europe/dlpJobs/i-8383929`.
+  "cloudDlpInspection": {
+    "fullScan": True or False,
+    "infoType": "A String",
+    "infoTypeCount": "A String",
+    "inspectJob": "A String",
   },
-  "complianceDetails": { # Compliance Details associated with the finding. # Details about the compliance implications of the finding.
-    "cloudControl": { # CloudControl associated with the finding. # CloudControl associated with the finding
-      "cloudControlName": "A String", # Name of the CloudControl associated with the finding.
-      "policyType": "A String", # Policy type of the CloudControl
-      "type": "A String", # Type of cloud control.
-      "version": 42, # Version of the Cloud Control
+  "complianceDetails": {
+    "cloudControl": {
+      "cloudControlName": "A String",
+      "policyType": "A String",
+      "type": "A String",
+      "version": 42,
     },
-    "cloudControlDeploymentNames": [ # Cloud Control Deployments associated with the finding. For example, organizations/123/locations/global/cloudControlDeployments/deploymentIdentifier
+    "cloudControlDeploymentNames": [
       "A String",
     ],
-    "frameworks": [ # Details of Frameworks associated with the finding
-      { # Compliance framework associated with the finding.
-        "category": [ # Category of the framework associated with the finding. E.g. Security Benchmark, or Assured Workloads
+    "frameworks": [
+      {
+        "category": [
           "A String",
         ],
-        "controls": [ # The controls associated with the framework.
-          { # Compliance control associated with the finding.
-            "controlName": "A String", # Name of the Control
-            "displayName": "A String", # Display name of the control. For example, AU-02.
+        "controls": [
+          {
+            "controlName": "A String",
+            "displayName": "A String",
           },
         ],
-        "displayName": "A String", # Display name of the framework. For a standard framework, this will look like e.g. PCI DSS 3.2.1, whereas for a custom framework it can be a user defined string like MyFramework
-        "name": "A String", # Name of the framework associated with the finding
-        "type": "A String", # Type of the framework associated with the finding, to specify whether the framework is built-in (pre-defined and immutable) or a custom framework defined by the customer (equivalent to security posture)
+        "displayName": "A String",
+        "name": "A String",
+        "type": "A String",
       },
     ],
   },
-  "compliances": [ # Contains compliance information for security standards associated to the finding.
-    { # Contains compliance information about a security standard indicating unmet recommendations.
-      "ids": [ # Policies within the standard or benchmark, for example, A.12.4.1
+  "compliances": [
+    {
+      "ids": [
         "A String",
       ],
-      "standard": "A String", # Industry-wide compliance standards or benchmarks, such as CIS, PCI, and OWASP.
-      "version": "A String", # Version of the standard or benchmark, for example, 1.1
+      "standard": "A String",
+      "version": "A String",
     },
   ],
-  "connections": [ # Contains information about the IP connection associated with the finding.
-    { # Contains information about the IP connection associated with the finding.
-      "destinationIp": "A String", # Destination IP address. Not present for sockets that are listening and not connected.
-      "destinationPort": 42, # Destination port. Not present for sockets that are listening and not connected.
-      "protocol": "A String", # IANA Internet Protocol Number such as TCP(6) and UDP(17).
-      "sourceIp": "A String", # Source IP address.
-      "sourcePort": 42, # Source port.
+  "connections": [
+    {
+      "destinationIp": "A String",
+      "destinationPort": 42,
+      "protocol": "A String",
+      "sourceIp": "A String",
+      "sourcePort": 42,
     },
   ],
-  "contacts": { # Output only. Map containing the points of contact for the given finding. The key represents the type of contact, while the value contains a list of all the contacts that pertain. Please refer to: https://cloud.google.com/resource-manager/docs/managing-notification-contacts#notification-categories { "security": { "contacts": [ { "email": "person1@company.com" }, { "email": "person2@company.com" } ] } }
-    "a_key": { # Details about specific contacts
-      "contacts": [ # A list of contacts
-        { # The email address of a contact.
-          "email": "A String", # An email address. For example, "`person123@company.com`".
+  "contacts": {
+    "a_key": {
+      "contacts": [
+        {
+          "email": "A String",
         },
       ],
     },
   },
-  "containers": [ # Containers associated with the finding. This field provides information for both Kubernetes and non-Kubernetes containers.
-    { # Container associated with the finding.
-      "createTime": "A String", # The time that the container was created.
-      "imageId": "A String", # Optional container image ID, if provided by the container runtime. Uniquely identifies the container image launched using a container image digest.
-      "labels": [ # Container labels, as provided by the container runtime.
-        { # Represents a generic name-value label. A label has separate name and value fields to support filtering with the `contains()` function. For more information, see [Filtering on array-type fields](https://cloud.google.com/security-command-center/docs/how-to-api-list-findings#array-contains-filtering).
-          "name": "A String", # Name of the label.
-          "value": "A String", # Value that corresponds to the label's name.
+  "containers": [
+    {
+      "createTime": "A String",
+      "imageId": "A String",
+      "labels": [
+        {
+          "name": "A String",
+          "value": "A String",
         },
       ],
-      "name": "A String", # Name of the container.
-      "uri": "A String", # Container image URI provided when configuring a pod or container. This string can identify a container image version using mutable tags.
+      "name": "A String",
+      "uri": "A String",
     },
   ],
-  "createTime": "A String", # The time at which the finding was created in Security Command Center.
-  "dataAccessEvents": [ # Data access events associated with the finding.
-    { # Details about a data access attempt made by a principal not authorized under applicable data security policy.
-      "eventId": "A String", # Unique identifier for data access event.
-      "eventTime": "A String", # Timestamp of data access event.
-      "operation": "A String", # The operation performed by the principal to access the data.
-      "principalEmail": "A String", # The email address of the principal that accessed the data. The principal could be a user account, service account, Google group, or other.
+  "createTime": "A String",
+  "dataAccessEvents": [
+    {
+      "eventId": "A String",
+      "eventTime": "A String",
+      "operation": "A String",
+      "principalEmail": "A String",
     },
   ],
-  "dataFlowEvents": [ # Data flow events associated with the finding.
-    { # Details about a data flow event, in which either the data is moved to or is accessed from a non-compliant geo-location, as defined in the applicable data security policy.
-      "eventId": "A String", # Unique identifier for data flow event.
-      "eventTime": "A String", # Timestamp of data flow event.
-      "operation": "A String", # The operation performed by the principal for the data flow event.
-      "principalEmail": "A String", # The email address of the principal that initiated the data flow event. The principal could be a user account, service account, Google group, or other.
-      "violatedLocation": "A String", # Non-compliant location of the principal or the data destination.
+  "dataFlowEvents": [
+    {
+      "eventId": "A String",
+      "eventTime": "A String",
+      "operation": "A String",
+      "principalEmail": "A String",
+      "violatedLocation": "A String",
     },
   ],
-  "dataRetentionDeletionEvents": [ # Data retention deletion events associated with the finding.
-    { # Details about data retention deletion violations, in which the data is non-compliant based on their retention or deletion time, as defined in the applicable data security policy. The Data Retention Deletion (DRD) control is a control of the DSPM (Data Security Posture Management) suite that enables organizations to manage data retention and deletion policies in compliance with regulations, such as GDPR and CRPA. DRD supports two primary policy types: maximum storage length (max TTL) and minimum storage length (min TTL). Both are aimed at helping organizations meet regulatory and data management commitments.
-      "dataObjectCount": "A String", # Number of objects that violated the policy for this resource. If the number is less than 1,000, then the value of this field is the exact number. If the number of objects that violated the policy is greater than or equal to 1,000, then the value of this field is 1000.
-      "eventDetectionTime": "A String", # Timestamp indicating when the event was detected.
-      "eventType": "A String", # Type of the DRD event.
-      "maxRetentionAllowed": "A String", # Maximum duration of retention allowed from the DRD control. This comes from the DRD control where users set a max TTL for their data. For example, suppose that a user sets the max TTL for a Cloud Storage bucket to 90 days. However, an object in that bucket is 100 days old. In this case, a DataRetentionDeletionEvent will be generated for that Cloud Storage bucket, and the max_retention_allowed is 90 days.
-      "minRetentionAllowed": "A String", # Min duration of retention allowed from the DSPM retention control. This field is only populated when event type is set to EVENT_TYPE_MIN_TTL_FROM_CREATION.
+  "dataRetentionDeletionEvents": [
+    {
+      "dataObjectCount": "A String",
+      "eventDetectionTime": "A String",
+      "eventType": "A String",
+      "maxRetentionAllowed": "A String",
+      "minRetentionAllowed": "A String",
     },
   ],
-  "database": { # Represents database access information, such as queries. A database may be a sub-resource of an instance (as in the case of Cloud SQL instances or Cloud Spanner instances), or the database instance itself. Some database resources might not have the [full resource name](https://google.aip.dev/122#full-resource-names) populated because these resource types, such as Cloud SQL databases, are not yet supported by Cloud Asset Inventory. In these cases only the display name is provided. # Database associated with the finding.
-    "displayName": "A String", # The human-readable name of the database that the user connected to.
-    "grantees": [ # The target usernames, roles, or groups of an SQL privilege grant, which is not an IAM policy change.
+  "database": {
+    "displayName": "A String",
+    "grantees": [
       "A String",
     ],
-    "name": "A String", # Some database resources may not have the [full resource name](https://google.aip.dev/122#full-resource-names) populated because these resource types are not yet supported by Cloud Asset Inventory (e.g. Cloud SQL databases). In these cases only the display name will be provided. The [full resource name](https://google.aip.dev/122#full-resource-names) of the database that the user connected to, if it is supported by Cloud Asset Inventory.
-    "query": "A String", # The SQL statement that is associated with the database access.
-    "userName": "A String", # The username used to connect to the database. The username might not be an IAM principal and does not have a set format.
-    "version": "A String", # The version of the database, for example, POSTGRES_14. See [the complete list](https://cloud.google.com/sql/docs/mysql/admin-api/rest/v1/SqlDatabaseVersion).
-  },
-  "description": "A String", # Contains more details about the finding.
-  "discoveredWorkload": { # Represents discovered, customer managed workload that is not registered with the respective GCP service. # DiscoveredWorkload associated with the finding.
-    "confidence": "A String", # The confidence in detection of this workload.
-    "detectedRelevantHardware": True or False, # A boolean flag set to true if associated hardware strongly predicts the workload type.
-    "detectedRelevantKeywords": True or False, # A boolean flag set to true if associated keywords strongly predict the workload type.
-    "detectedRelevantPackages": True or False, # A boolean flag set to true if installed packages strongly predict the workload type.
-    "workloadType": "A String", # The type of workload.
-  },
-  "disk": { # Contains information about the disk associated with the finding. # Disk associated with the finding.
-    "name": "A String", # The name of the disk, for example, "https://www.googleapis.com/compute/v1/projects/{project-id}/zones/{zone-id}/disks/{disk-id}".
-  },
-  "eventTime": "A String", # The time the finding was first detected. If an existing finding is updated, then this is the time the update occurred. For example, if the finding represents an open firewall, this property captures the time the detector believes the firewall became open. The accuracy is determined by the detector. If the finding is later resolved, then this time reflects when the finding was resolved. This must not be set to a value greater than the current timestamp.
-  "exfiltration": { # Exfiltration represents a data exfiltration attempt from one or more sources to one or more targets. The `sources` attribute lists the sources of the exfiltrated data. The `targets` attribute lists the destinations the data was copied to. # Represents exfiltrations associated with the finding.
-    "sources": [ # If there are multiple sources, then the data is considered "joined" between them. For instance, BigQuery can join multiple tables, and each table would be considered a source.
-      { # Resource where data was exfiltrated from or exfiltrated to.
-        "components": [ # Subcomponents of the asset that was exfiltrated, like URIs used during exfiltration, table names, databases, and filenames. For example, multiple tables might have been exfiltrated from the same Cloud SQL instance, or multiple files might have been exfiltrated from the same Cloud Storage bucket.
+    "name": "A String",
+    "query": "A String",
+    "userName": "A String",
+    "version": "A String",
+  },
+  "description": "A String",
+  "discoveredWorkload": {
+    "confidence": "A String",
+    "detectedRelevantHardware": True or False,
+    "detectedRelevantKeywords": True or False,
+    "detectedRelevantPackages": True or False,
+    "workloadType": "A String",
+  },
+  "disk": {
+    "name": "A String",
+  },
+  "eventTime": "A String",
+  "exfiltration": {
+    "sources": [
+      {
+        "components": [
           "A String",
         ],
-        "name": "A String", # The resource's [full resource name](https://cloud.google.com/apis/design/resource_names#full_resource_name).
+        "name": "A String",
       },
     ],
-    "targets": [ # If there are multiple targets, each target would get a complete copy of the "joined" source data.
-      { # Resource where data was exfiltrated from or exfiltrated to.
-        "components": [ # Subcomponents of the asset that was exfiltrated, like URIs used during exfiltration, table names, databases, and filenames. For example, multiple tables might have been exfiltrated from the same Cloud SQL instance, or multiple files might have been exfiltrated from the same Cloud Storage bucket.
+    "targets": [
+      {
+        "components": [
           "A String",
         ],
-        "name": "A String", # The resource's [full resource name](https://cloud.google.com/apis/design/resource_names#full_resource_name).
+        "name": "A String",
       },
     ],
-    "totalExfiltratedBytes": "A String", # Total exfiltrated bytes processed for the entire job.
-  },
-  "externalExposure": { # Details about the externally exposed resource associated with the finding. # External exposure associated with the finding.
-    "backendBucket": "A String", # The full resource name of the load balancer backend bucket, for example, "//compute.googleapis.com/projects/{project-id}/global/backendBuckets/{name}"
-    "backendService": "A String", # The full resource name of load balancer backend service, for example, "//compute.googleapis.com/projects/{project-id}/global/backendServices/{name}".
-    "exposedApplication": "A String", # The name and version of the exposed web application, for example, "Jenkins 2.184".
-    "exposedEndpoint": "A String", # The resource which is running the exposed service, for example, "//compute.googleapis.com/projects/{project-id}/zones/{zone}/instances/{instance}.”
-    "exposedService": "A String", # The name and version of the service, for example, "Jupyter Notebook 6.14.0".
-    "forwardingRule": "A String", # The full resource name of the forwarding rule, for example, "//compute.googleapis.com/projects/{project-id}/global/forwardingRules/{forwarding-rule-name}".
-    "hostnameUri": "A String", # Hostname of the exposed application, for example, "https://test-app.a.run.app/"
-    "httpResponse": [ # The http response returned by the web application.
-      { # The http response returned by the web application.
-        "path": "A String", # The http path for which response code was returned by web application, for example, "https://test-app.a.run.app/test".
-        "statusCode": "A String", # The http response code returned by the web application, for example, 200.
+    "totalExfiltratedBytes": "A String",
+  },
+  "externalExposure": {
+    "backendBucket": "A String",
+    "backendService": "A String",
+    "exposedApplication": "A String",
+    "exposedEndpoint": "A String",
+    "exposedService": "A String",
+    "forwardingRule": "A String",
+    "hostnameUri": "A String",
+    "httpResponse": [
+      {
+        "path": "A String",
+        "statusCode": "A String",
       },
     ],
-    "instanceGroup": "A String", # The full resource name of the instance group, for example, "//compute.googleapis.com/projects/{project-id}/global/instanceGroups/{name}".
-    "internalBackendService": "A String", # The full resource name of load balancer backend service in the internal project having resource exposed via PSC, for example, "//compute.googleapis.com/projects/{project-id}/global/backendServices/{name}".
-    "loadBalancerFirewallPolicy": "A String", # The full resource name of the load balancer firewall policy, for example, "//compute.googleapis.com/projects/{project-id}/global/firewallPolicies/{policy-name}".
-    "networkEndpointGroup": "A String", # The full resource name of the network endpoint group, for example, "//compute.googleapis.com/projects/{project-id}/global/networkEndpointGroups/{name}".
-    "networkIngressFirewallPolicy": "A String", # The full resource name of the network ingress firewall policy, for example, "//compute.googleapis.com/projects/{project-id}/global/firewallPolicies/{name}".
-    "privateIpAddress": "A String", # Private IP address of the exposed endpoint.
-    "privatePort": "A String", # Port number associated with private IP address.
-    "pscNetworkAttachment": "A String", # The full resource name of the PSC (Private Service Connect) network attachment that network interface controller is attached to, for example, "//compute.googleapis.com/projects/{project-id}/regions/{region}/networkAttachments/{name}"
-    "pscServiceAttachment": "A String", # The full resource name of the PSC (Private Service Connect) service attachment that the load balancer network endpoint group targets, for example, "//compute.googleapis.com/projects/{project-id}/regions/{region}/serviceAttachments/{name}"
-    "publicIpAddress": "A String", # Public IP address of the exposed endpoint.
-    "publicPort": "A String", # Public port number of the exposed endpoint.
-    "serviceFirewallPolicy": "A String", # The full resource name of the firewall policy of the exposed service, for example, "//compute.googleapis.com/projects/{project-id}/global/firewallPolicies/{policy-name}".
-  },
-  "externalSystems": { # Output only. Third party SIEM/SOAR fields within SCC, contains external system information and external system finding fields.
-    "a_key": { # Representation of third party SIEM/SOAR fields within SCC.
-      "assignees": [ # References primary/secondary etc assignees in the external system.
+    "instanceGroup": "A String",
+    "internalBackendService": "A String",
+    "loadBalancerFirewallPolicy": "A String",
+    "networkEndpointGroup": "A String",
+    "networkIngressFirewallPolicy": "A String",
+    "privateIpAddress": "A String",
+    "privatePort": "A String",
+    "pscNetworkAttachment": "A String",
+    "pscServiceAttachment": "A String",
+    "publicIpAddress": "A String",
+    "publicPort": "A String",
+    "serviceFirewallPolicy": "A String",
+  },
+  "externalSystems": {
+    "a_key": {
+      "assignees": [
         "A String",
       ],
-      "caseCloseTime": "A String", # The time when the case was closed, as reported by the external system.
-      "caseCreateTime": "A String", # The time when the case was created, as reported by the external system.
-      "casePriority": "A String", # The priority of the finding's corresponding case in the external system.
-      "caseSla": "A String", # The SLA of the finding's corresponding case in the external system.
-      "caseUri": "A String", # The link to the finding's corresponding case in the external system.
-      "externalSystemUpdateTime": "A String", # The time when the case was last updated, as reported by the external system.
-      "externalUid": "A String", # The identifier that's used to track the finding's corresponding case in the external system.
-      "name": "A String", # Full resource name of the external system, for example: "organizations/1234/sources/5678/findings/123456/externalSystems/jira", "folders/1234/sources/5678/findings/123456/externalSystems/jira", "projects/1234/sources/5678/findings/123456/externalSystems/jira"
-      "status": "A String", # The most recent status of the finding's corresponding case, as reported by the external system.
-      "ticketInfo": { # Information about the ticket, if any, that is being used to track the resolution of the issue that is identified by this finding. # Information about the ticket, if any, that is being used to track the resolution of the issue that is identified by this finding.
-        "assignee": "A String", # The assignee of the ticket in the ticket system.
-        "description": "A String", # The description of the ticket in the ticket system.
-        "id": "A String", # The identifier of the ticket in the ticket system.
-        "status": "A String", # The latest status of the ticket, as reported by the ticket system.
-        "updateTime": "A String", # The time when the ticket was last updated, as reported by the ticket system.
-        "uri": "A String", # The link to the ticket in the ticket system.
+      "caseCloseTime": "A String",
+      "caseCreateTime": "A String",
+      "casePriority": "A String",
+      "caseSla": "A String",
+      "caseUri": "A String",
+      "externalSystemUpdateTime": "A String",
+      "externalUid": "A String",
+      "name": "A String",
+      "status": "A String",
+      "ticketInfo": {
+        "assignee": "A String",
+        "description": "A String",
+        "id": "A String",
+        "status": "A String",
+        "updateTime": "A String",
+        "uri": "A String",
       },
     },
   },
-  "externalUri": "A String", # The URI that, if available, points to a web page outside of Security Command Center where additional information about the finding can be found. This field is guaranteed to be either empty or a well formed URL.
-  "files": [ # File associated with the finding.
-    { # File information about the related binary/library used by an executable, or the script used by a script interpreter
-      "contents": "A String", # Prefix of the file contents as a JSON-encoded string.
-      "diskPath": { # Path of the file in terms of underlying disk/partition identifiers. # Path of the file in terms of underlying disk/partition identifiers.
-        "partitionUuid": "A String", # UUID of the partition (format https://wiki.archlinux.org/title/persistent_block_device_naming#by-uuid)
-        "relativePath": "A String", # Relative path of the file in the partition as a JSON encoded string. Example: /home/user1/executable_file.sh
+  "externalUri": "A String",
+  "files": [
+    {
+      "contents": "A String",
+      "diskPath": {
+        "partitionUuid": "A String",
+        "relativePath": "A String",
       },
-      "fileLoadState": "A String", # The load state of the file.
-      "hashedSize": "A String", # The length in bytes of the file prefix that was hashed. If hashed_size == size, any hashes reported represent the entire file.
-      "operations": [ # Operation(s) performed on a file.
-        { # Operation(s) performed on a file.
-          "type": "A String", # The type of the operation
+      "fileLoadState": "A String",
+      "hashedSize": "A String",
+      "operations": [
+        {
+          "type": "A String",
         },
       ],
-      "partiallyHashed": True or False, # True when the hash covers only a prefix of the file.
-      "path": "A String", # Absolute path of the file as a JSON encoded string.
-      "sha256": "A String", # SHA256 hash of the first hashed_size bytes of the file encoded as a hex string. If hashed_size == size, sha256 represents the SHA256 hash of the entire file.
-      "size": "A String", # Size of the file in bytes.
+      "partiallyHashed": True or False,
+      "path": "A String",
+      "sha256": "A String",
+      "size": "A String",
     },
   ],
-  "findingClass": "A String", # The class of the finding.
-  "groupMemberships": [ # Contains details about groups of which this finding is a member. A group is a collection of findings that are related in some way. This field cannot be updated. Its value is ignored in all update requests.
-    { # Contains details about groups of which this finding is a member. A group is a collection of findings that are related in some way.
-      "groupId": "A String", # ID of the group.
-      "groupType": "A String", # Type of group.
+  "findingClass": "A String",
+  "groupMemberships": [
+    {
+      "groupId": "A String",
+      "groupType": "A String",
     },
   ],
-  "iamBindings": [ # Represents IAM bindings associated with the finding.
-    { # Represents a particular IAM binding, which captures a member's role addition, removal, or state.
-      "action": "A String", # The action that was performed on a Binding.
-      "member": "A String", # A single identity requesting access for a Cloud Platform resource, for example, "foo@google.com".
-      "role": "A String", # Role that is assigned to "members". For example, "roles/viewer", "roles/editor", or "roles/owner".
+  "iamBindings": [
+    {
+      "action": "A String",
+      "member": "A String",
+      "role": "A String",
     },
   ],
-  "indicator": { # Represents what's commonly known as an _indicator of compromise_ (IoC) in computer forensics. This is an artifact observed on a network or in an operating system that, with high confidence, indicates a computer intrusion. For more information, see [Indicator of compromise](https://en.wikipedia.org/wiki/Indicator_of_compromise). # Represents what's commonly known as an *indicator of compromise* (IoC) in computer forensics. This is an artifact observed on a network or in an operating system that, with high confidence, indicates a computer intrusion. For more information, see [Indicator of compromise](https://en.wikipedia.org/wiki/Indicator_of_compromise).
-    "domains": [ # List of domains associated to the Finding.
+  "indicator": {
+    "domains": [
       "A String",
     ],
-    "ipAddresses": [ # The list of IP addresses that are associated with the finding.
+    "ipAddresses": [
       "A String",
     ],
-    "signatures": [ # The list of matched signatures indicating that the given process is present in the environment.
-      { # Indicates what signature matched this process.
-        "memoryHashSignature": { # A signature corresponding to memory page hashes. # Signature indicating that a binary family was matched.
-          "binaryFamily": "A String", # The binary family.
-          "detections": [ # The list of memory hash detections contributing to the binary family match.
-            { # Memory hash detection contributing to the binary family match.
-              "binary": "A String", # The name of the binary associated with the memory hash signature detection.
-              "percentPagesMatched": 3.14, # The percentage of memory page hashes in the signature that were matched.
+    "signatures": [
+      {
+        "memoryHashSignature": {
+          "binaryFamily": "A String",
+          "detections": [
+            {
+              "binary": "A String",
+              "percentPagesMatched": 3.14,
             },
           ],
         },
-        "signatureType": "A String", # Describes the type of resource associated with the signature.
-        "yaraRuleSignature": { # A signature corresponding to a YARA rule. # Signature indicating that a YARA rule was matched.
-          "yaraRule": "A String", # The name of the YARA rule.
+        "signatureType": "A String",
+        "yaraRuleSignature": {
+          "yaraRule": "A String",
         },
       },
     ],
-    "uris": [ # The list of URIs associated to the Findings.
+    "uris": [
       "A String",
     ],
   },
-  "ipRules": { # IP rules associated with the finding. # IP rules associated with the finding.
-    "allowed": { # Allowed IP rule. # Tuple with allowed rules.
-      "ipRules": [ # Optional. Optional list of allowed IP rules.
-        { # IP rule information.
-          "portRanges": [ # Optional. An optional list of ports to which this rule applies. This field is only applicable for the UDP or (S)TCP protocols. Each entry must be either an integer or a range including a min and max port number.
-            { # A port range which is inclusive of the min and max values. Values are between 0 and 2^16-1. The max can be equal / must be not smaller than the min value. If min and max are equal this indicates that it is a single port.
-              "max": "A String", # Maximum port value.
-              "min": "A String", # Minimum port value.
+  "ipRules": {
+    "allowed": {
+      "ipRules": [
+        {
+          "portRanges": [
+            {
+              "max": "A String",
+              "min": "A String",
             },
           ],
-          "protocol": "A String", # The IP protocol this rule applies to. This value can either be one of the following well known protocol strings (TCP, UDP, ICMP, ESP, AH, IPIP, SCTP) or a string representation of the integer value.
+          "protocol": "A String",
         },
       ],
     },
-    "denied": { # Denied IP rule. # Tuple with denied rules.
-      "ipRules": [ # Optional. Optional list of denied IP rules.
-        { # IP rule information.
-          "portRanges": [ # Optional. An optional list of ports to which this rule applies. This field is only applicable for the UDP or (S)TCP protocols. Each entry must be either an integer or a range including a min and max port number.
-            { # A port range which is inclusive of the min and max values. Values are between 0 and 2^16-1. The max can be equal / must be not smaller than the min value. If min and max are equal this indicates that it is a single port.
-              "max": "A String", # Maximum port value.
-              "min": "A String", # Minimum port value.
+    "denied": {
+      "ipRules": [
+        {
+          "portRanges": [
+            {
+              "max": "A String",
+              "min": "A String",
             },
           ],
-          "protocol": "A String", # The IP protocol this rule applies to. This value can either be one of the following well known protocol strings (TCP, UDP, ICMP, ESP, AH, IPIP, SCTP) or a string representation of the integer value.
+          "protocol": "A String",
         },
       ],
     },
-    "destinationIpRanges": [ # If destination IP ranges are specified, the firewall rule applies only to traffic that has a destination IP address in these ranges. These ranges must be expressed in CIDR format. Only supports IPv4.
+    "destinationIpRanges": [
       "A String",
     ],
-    "direction": "A String", # The direction that the rule is applicable to, one of ingress or egress.
-    "exposedServices": [ # Name of the network protocol service, such as FTP, that is exposed by the open port. Follows the naming convention available at: https://www.iana.org/assignments/service-names-port-numbers/service-names-port-numbers.xhtml.
+    "direction": "A String",
+    "exposedServices": [
       "A String",
     ],
-    "sourceIpRanges": [ # If source IP ranges are specified, the firewall rule applies only to traffic that has a source IP address in these ranges. These ranges must be expressed in CIDR format. Only supports IPv4.
+    "sourceIpRanges": [
       "A String",
     ],
   },
-  "job": { # Describes a job # Job associated with the finding.
-    "errorCode": 42, # Optional. If the job did not complete successfully, this field describes why.
-    "location": "A String", # Optional. Gives the location where the job ran, such as `US` or `europe-west1`
-    "name": "A String", # The fully-qualified name for a job. e.g. `projects//jobs/`
-    "state": "A String", # Output only. State of the job, such as `RUNNING` or `PENDING`.
-  },
-  "kernelRootkit": { # Kernel mode rootkit signatures. # Signature of the kernel rootkit.
-    "name": "A String", # Rootkit name, when available.
-    "unexpectedCodeModification": True or False, # True if unexpected modifications of kernel code memory are present.
-    "unexpectedFtraceHandler": True or False, # True if `ftrace` points are present with callbacks pointing to regions that are not in the expected kernel or module code range.
-    "unexpectedInterruptHandler": True or False, # True if interrupt handlers that are are not in the expected kernel or module code regions are present.
-    "unexpectedKernelCodePages": True or False, # True if kernel code pages that are not in the expected kernel or module code regions are present.
-    "unexpectedKprobeHandler": True or False, # True if `kprobe` points are present with callbacks pointing to regions that are not in the expected kernel or module code range.
-    "unexpectedProcessesInRunqueue": True or False, # True if unexpected processes in the scheduler run queue are present. Such processes are in the run queue, but not in the process task list.
-    "unexpectedReadOnlyDataModification": True or False, # True if unexpected modifications of kernel read-only data memory are present.
-    "unexpectedSystemCallHandler": True or False, # True if system call handlers that are are not in the expected kernel or module code regions are present.
-  },
-  "kubernetes": { # Kubernetes-related attributes. # Kubernetes resources associated with the finding.
-    "accessReviews": [ # Provides information on any Kubernetes access reviews (privilege checks) relevant to the finding.
-      { # Conveys information about a Kubernetes access review (such as one returned by a [`kubectl auth can-i`](https://kubernetes.io/docs/reference/access-authn-authz/authorization/#checking-api-access) command) that was involved in a finding.
-        "group": "A String", # The API group of the resource. "*" means all.
-        "name": "A String", # The name of the resource being requested. Empty means all.
-        "ns": "A String", # Namespace of the action being requested. Currently, there is no distinction between no namespace and all namespaces. Both are represented by "" (empty).
-        "resource": "A String", # The optional resource type requested. "*" means all.
-        "subresource": "A String", # The optional subresource type.
-        "verb": "A String", # A Kubernetes resource API verb, like get, list, watch, create, update, delete, proxy. "*" means all.
-        "version": "A String", # The API version of the resource. "*" means all.
+  "job": {
+    "errorCode": 42,
+    "location": "A String",
+    "name": "A String",
+    "state": "A String",
+  },
+  "kernelRootkit": {
+    "name": "A String",
+    "unexpectedCodeModification": True or False,
+    "unexpectedFtraceHandler": True or False,
+    "unexpectedInterruptHandler": True or False,
+    "unexpectedKernelCodePages": True or False,
+    "unexpectedKprobeHandler": True or False,
+    "unexpectedProcessesInRunqueue": True or False,
+    "unexpectedReadOnlyDataModification": True or False,
+    "unexpectedSystemCallHandler": True or False,
+  },
+  "kubernetes": {
+    "accessReviews": [
+      {
+        "group": "A String",
+        "name": "A String",
+        "ns": "A String",
+        "resource": "A String",
+        "subresource": "A String",
+        "verb": "A String",
+        "version": "A String",
       },
     ],
-    "bindings": [ # Provides Kubernetes role binding information for findings that involve [RoleBindings or ClusterRoleBindings](https://cloud.google.com/kubernetes-engine/docs/how-to/role-based-access-control).
-      { # Represents a Kubernetes RoleBinding or ClusterRoleBinding.
-        "name": "A String", # Name for the binding.
-        "ns": "A String", # Namespace for the binding.
-        "role": { # Kubernetes Role or ClusterRole. # The Role or ClusterRole referenced by the binding.
-          "kind": "A String", # Role type.
-          "name": "A String", # Role name.
-          "ns": "A String", # Role namespace.
+    "bindings": [
+      {
+        "name": "A String",
+        "ns": "A String",
+        "role": {
+          "kind": "A String",
+          "name": "A String",
+          "ns": "A String",
         },
-        "subjects": [ # Represents one or more subjects that are bound to the role. Not always available for PATCH requests.
-          { # Represents a Kubernetes subject.
-            "kind": "A String", # Authentication type for the subject.
-            "name": "A String", # Name for the subject.
-            "ns": "A String", # Namespace for the subject.
+        "subjects": [
+          {
+            "kind": "A String",
+            "name": "A String",
+            "ns": "A String",
           },
         ],
       },
     ],
-    "nodePools": [ # GKE [node pools](https://cloud.google.com/kubernetes-engine/docs/concepts/node-pools) associated with the finding. This field contains node pool information for each node, when it is available.
-      { # Provides GKE node pool information.
-        "name": "A String", # Kubernetes node pool name.
-        "nodes": [ # Nodes associated with the finding.
-          { # Kubernetes nodes associated with the finding.
-            "name": "A String", # [Full resource name](https://google.aip.dev/122#full-resource-names) of the Compute Engine VM running the cluster node.
+    "nodePools": [
+      {
+        "name": "A String",
+        "nodes": [
+          {
+            "name": "A String",
           },
         ],
       },
     ],
-    "nodes": [ # Provides Kubernetes [node](https://cloud.google.com/kubernetes-engine/docs/concepts/cluster-architecture#nodes) information.
-      { # Kubernetes nodes associated with the finding.
-        "name": "A String", # [Full resource name](https://google.aip.dev/122#full-resource-names) of the Compute Engine VM running the cluster node.
+    "nodes": [
+      {
+        "name": "A String",
       },
     ],
-    "objects": [ # Kubernetes objects related to the finding.
-      { # Kubernetes object related to the finding, uniquely identified by GKNN. Used if the object Kind is not one of Pod, Node, NodePool, Binding, or AccessReview.
-        "containers": [ # Pod containers associated with this finding, if any.
-          { # Container associated with the finding.
-            "createTime": "A String", # The time that the container was created.
-            "imageId": "A String", # Optional container image ID, if provided by the container runtime. Uniquely identifies the container image launched using a container image digest.
-            "labels": [ # Container labels, as provided by the container runtime.
-              { # Represents a generic name-value label. A label has separate name and value fields to support filtering with the `contains()` function. For more information, see [Filtering on array-type fields](https://cloud.google.com/security-command-center/docs/how-to-api-list-findings#array-contains-filtering).
-                "name": "A String", # Name of the label.
-                "value": "A String", # Value that corresponds to the label's name.
+    "objects": [
+      {
+        "containers": [
+          {
+            "createTime": "A String",
+            "imageId": "A String",
+            "labels": [
+              {
+                "name": "A String",
+                "value": "A String",
               },
             ],
-            "name": "A String", # Name of the container.
-            "uri": "A String", # Container image URI provided when configuring a pod or container. This string can identify a container image version using mutable tags.
+            "name": "A String",
+            "uri": "A String",
           },
         ],
-        "group": "A String", # Kubernetes object group, such as "policy.k8s.io/v1".
-        "kind": "A String", # Kubernetes object kind, such as "Namespace".
-        "name": "A String", # Kubernetes object name. For details see https://kubernetes.io/docs/concepts/overview/working-with-objects/names/.
-        "ns": "A String", # Kubernetes object namespace. Must be a valid DNS label. Named "ns" to avoid collision with C++ namespace keyword. For details see https://kubernetes.io/docs/tasks/administer-cluster/namespaces/.
+        "group": "A String",
+        "kind": "A String",
+        "name": "A String",
+        "ns": "A String",
       },
     ],
-    "pods": [ # Kubernetes [Pods](https://cloud.google.com/kubernetes-engine/docs/concepts/pod) associated with the finding. This field contains Pod records for each container that is owned by a Pod.
-      { # A Kubernetes Pod.
-        "containers": [ # Pod containers associated with this finding, if any.
-          { # Container associated with the finding.
-            "createTime": "A String", # The time that the container was created.
-            "imageId": "A String", # Optional container image ID, if provided by the container runtime. Uniquely identifies the container image launched using a container image digest.
-            "labels": [ # Container labels, as provided by the container runtime.
-              { # Represents a generic name-value label. A label has separate name and value fields to support filtering with the `contains()` function. For more information, see [Filtering on array-type fields](https://cloud.google.com/security-command-center/docs/how-to-api-list-findings#array-contains-filtering).
-                "name": "A String", # Name of the label.
-                "value": "A String", # Value that corresponds to the label's name.
+    "pods": [
+      {
+        "containers": [
+          {
+            "createTime": "A String",
+            "imageId": "A String",
+            "labels": [
+              {
+                "name": "A String",
+                "value": "A String",
               },
             ],
-            "name": "A String", # Name of the container.
-            "uri": "A String", # Container image URI provided when configuring a pod or container. This string can identify a container image version using mutable tags.
+            "name": "A String",
+            "uri": "A String",
           },
         ],
-        "labels": [ # Pod labels. For Kubernetes containers, these are applied to the container.
-          { # Represents a generic name-value label. A label has separate name and value fields to support filtering with the `contains()` function. For more information, see [Filtering on array-type fields](https://cloud.google.com/security-command-center/docs/how-to-api-list-findings#array-contains-filtering).
-            "name": "A String", # Name of the label.
-            "value": "A String", # Value that corresponds to the label's name.
+        "labels": [
+          {
+            "name": "A String",
+            "value": "A String",
           },
         ],
-        "name": "A String", # Kubernetes Pod name.
-        "ns": "A String", # Kubernetes Pod namespace.
+        "name": "A String",
+        "ns": "A String",
       },
     ],
-    "roles": [ # Provides Kubernetes role information for findings that involve [Roles or ClusterRoles](https://cloud.google.com/kubernetes-engine/docs/how-to/role-based-access-control).
-      { # Kubernetes Role or ClusterRole.
-        "kind": "A String", # Role type.
-        "name": "A String", # Role name.
-        "ns": "A String", # Role namespace.
+    "roles": [
+      {
+        "kind": "A String",
+        "name": "A String",
+        "ns": "A String",
       },
     ],
   },
-  "loadBalancers": [ # The load balancers associated with the finding.
-    { # Contains information related to the load balancer associated with the finding.
-      "name": "A String", # The name of the load balancer associated with the finding.
+  "loadBalancers": [
+    {
+      "name": "A String",
     },
   ],
-  "logEntries": [ # Log entries that are relevant to the finding.
-    { # An individual entry in a log.
-      "cloudLoggingEntry": { # Metadata taken from a [Cloud Logging LogEntry](https://cloud.google.com/logging/docs/reference/v2/rest/v2/LogEntry) # An individual entry in a log stored in Cloud Logging.
-        "insertId": "A String", # A unique identifier for the log entry.
-        "logId": "A String", # The type of the log (part of `log_name`. `log_name` is the resource name of the log to which this log entry belongs). For example: `cloudresourcemanager.googleapis.com/activity`. Note that this field is not URL-encoded, unlike the `LOG_ID` field in `LogEntry`.
-        "resourceContainer": "A String", # The organization, folder, or project of the monitored resource that produced this log entry.
-        "timestamp": "A String", # The time the event described by the log entry occurred.
+  "logEntries": [
+    {
+      "cloudLoggingEntry": {
+        "insertId": "A String",
+        "logId": "A String",
+        "resourceContainer": "A String",
+        "timestamp": "A String",
       },
     },
   ],
-  "mitreAttack": { # MITRE ATT&CK tactics and techniques related to this finding. See: https://attack.mitre.org # MITRE ATT&CK tactics and techniques related to this finding. See: https://attack.mitre.org
-    "additionalTactics": [ # Additional MITRE ATT&CK tactics related to this finding, if any.
+  "mitreAttack": {
+    "additionalTactics": [
       "A String",
     ],
-    "additionalTechniques": [ # Additional MITRE ATT&CK techniques related to this finding, if any, along with any of their respective parent techniques.
+    "additionalTechniques": [
       "A String",
     ],
-    "primaryTactic": "A String", # The MITRE ATT&CK tactic most closely represented by this finding, if any.
-    "primaryTechniques": [ # The MITRE ATT&CK technique most closely represented by this finding, if any. primary_techniques is a repeated field because there are multiple levels of MITRE ATT&CK techniques. If the technique most closely represented by this finding is a sub-technique (e.g. `SCANNING_IP_BLOCKS`), both the sub-technique and its parent technique(s) will be listed (e.g. `SCANNING_IP_BLOCKS`, `ACTIVE_SCANNING`).
+    "primaryTactic": "A String",
+    "primaryTechniques": [
       "A String",
     ],
-    "version": "A String", # The MITRE ATT&CK version referenced by the above fields. E.g. "8".
+    "version": "A String",
   },
-  "moduleName": "A String", # Unique identifier of the module which generated the finding. Example: folders/598186756061/securityHealthAnalyticsSettings/customModules/56799441161885
-  "mute": "A String", # Indicates the mute state of a finding (either muted, unmuted or undefined). Unlike other attributes of a finding, a finding provider shouldn't set the value of mute.
-  "muteInfo": { # Mute information about the finding, including whether the finding has a static mute or any matching dynamic mute rules. # Output only. The mute information regarding this finding.
-    "dynamicMuteRecords": [ # The list of dynamic mute rules that currently match the finding.
-      { # The record of a dynamic mute rule that matches the finding.
-        "matchTime": "A String", # When the dynamic mute rule first matched the finding.
-        "muteConfig": "A String", # The relative resource name of the mute rule, represented by a mute config, that created this record, for example `organizations/123/muteConfigs/mymuteconfig` or `organizations/123/locations/global/muteConfigs/mymuteconfig`.
+  "moduleName": "A String",
+  "mute": "A String",
+  "muteInfo": {
+    "dynamicMuteRecords": [
+      {
+        "matchTime": "A String",
+        "muteConfig": "A String",
       },
     ],
-    "staticMute": { # Information about the static mute state. A static mute state overrides any dynamic mute rules that apply to this finding. The static mute state can be set by a static mute rule or by muting the finding directly. # If set, the static mute applied to this finding. Static mutes override dynamic mutes. If unset, there is no static mute.
-      "applyTime": "A String", # When the static mute was applied.
-      "state": "A String", # The static mute state. If the value is `MUTED` or `UNMUTED`, then the finding's overall mute state will have the same value.
+    "staticMute": {
+      "applyTime": "A String",
+      "state": "A String",
     },
   },
-  "muteInitiator": "A String", # Records additional information about the mute operation, for example, the [mute configuration](/security-command-center/docs/how-to-mute-findings) that muted the finding and the user who muted the finding.
-  "muteUpdateTime": "A String", # Output only. The most recent time this finding was muted or unmuted.
-  "name": "A String", # The [relative resource name](https://cloud.google.com/apis/design/resource_names#relative_resource_name) of the finding. Example: "organizations/{organization_id}/sources/{source_id}/findings/{finding_id}", "folders/{folder_id}/sources/{source_id}/findings/{finding_id}", "projects/{project_id}/sources/{source_id}/findings/{finding_id}".
-  "networks": [ # Represents the VPC networks that the resource is attached to.
-    { # Contains information about a VPC network associated with the finding.
-      "name": "A String", # The name of the VPC network resource, for example, `//compute.googleapis.com/projects/my-project/global/networks/my-network`.
+  "muteInitiator": "A String",
+  "muteUpdateTime": "A String",
+  "name": "A String",
+  "networks": [
+    {
+      "name": "A String",
     },
   ],
-  "nextSteps": "A String", # Steps to address the finding.
-  "notebook": { # Represents a Jupyter notebook IPYNB file, such as a [Colab Enterprise notebook](https://cloud.google.com/colab/docs/introduction) file, that is associated with a finding. # Notebook associated with the finding.
-    "lastAuthor": "A String", # The user ID of the latest author to modify the notebook.
-    "name": "A String", # The name of the notebook.
-    "notebookUpdateTime": "A String", # The most recent time the notebook was updated.
-    "service": "A String", # The source notebook service, for example, "Colab Enterprise".
+  "nextSteps": "A String",
+  "notebook": {
+    "lastAuthor": "A String",
+    "name": "A String",
+    "notebookUpdateTime": "A String",
+    "service": "A String",
   },
-  "orgPolicies": [ # Contains information about the org policies associated with the finding.
-    { # Contains information about the org policies associated with the finding.
-      "name": "A String", # The resource name of the org policy. Example: "organizations/{organization_id}/policies/{constraint_name}"
+  "orgPolicies": [
+    {
+      "name": "A String",
     },
   ],
-  "parent": "A String", # The relative resource name of the source the finding belongs to. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name This field is immutable after creation time. For example: "organizations/{organization_id}/sources/{source_id}"
-  "parentDisplayName": "A String", # Output only. The human readable display name of the finding source such as "Event Threat Detection" or "Security Health Analytics".
-  "policyViolationSummary": { # Metadata summarizing policy violations of child resources of the affected resource. `finding_category` and `resource` determine the exact semantics of the counts. For example, when category=DATA_SECURITY_POSTURE_OBJECT_PUBLIC_ACCESS_VIOLATION and resource='storage.googleapis.com/buckets/my-bucket-name' then this counts the number of Cloud Storage objects in my-bucket-name which violate a Public Access control. # PolicyViolationSummary associated with the finding.
-    "conformantResourcesCount": "A String", # Total number of child resources that conform to the policy.
-    "evaluationErrorsCount": "A String", # Number of child resources for which errors during evaluation occurred. The evaluation result for these child resources is effectively "unknown".
-    "outOfScopeResourcesCount": "A String", # Total count of child resources which were not in scope for evaluation.
-    "policyViolationsCount": "A String", # Count of child resources in violation of the policy.
-  },
-  "processes": [ # Represents operating system processes associated with the Finding.
-    { # Represents an operating system process.
-      "args": [ # Process arguments as JSON encoded strings.
+  "parent": "A String",
+  "parentDisplayName": "A String",
+  "policyViolationSummary": {
+    "conformantResourcesCount": "A String",
+    "evaluationErrorsCount": "A String",
+    "outOfScopeResourcesCount": "A String",
+    "policyViolationsCount": "A String",
+  },
+  "processes": [
+    {
+      "args": [
         "A String",
       ],
-      "argumentsTruncated": True or False, # True if `args` is incomplete.
-      "binary": { # File information about the related binary/library used by an executable, or the script used by a script interpreter # File information for the process executable.
-        "contents": "A String", # Prefix of the file contents as a JSON-encoded string.
-        "diskPath": { # Path of the file in terms of underlying disk/partition identifiers. # Path of the file in terms of underlying disk/partition identifiers.
-          "partitionUuid": "A String", # UUID of the partition (format https://wiki.archlinux.org/title/persistent_block_device_naming#by-uuid)
-          "relativePath": "A String", # Relative path of the file in the partition as a JSON encoded string. Example: /home/user1/executable_file.sh
+      "argumentsTruncated": True or False,
+      "binary": {
+        "contents": "A String",
+        "diskPath": {
+          "partitionUuid": "A String",
+          "relativePath": "A String",
         },
-        "fileLoadState": "A String", # The load state of the file.
-        "hashedSize": "A String", # The length in bytes of the file prefix that was hashed. If hashed_size == size, any hashes reported represent the entire file.
-        "operations": [ # Operation(s) performed on a file.
-          { # Operation(s) performed on a file.
-            "type": "A String", # The type of the operation
+        "fileLoadState": "A String",
+        "hashedSize": "A String",
+        "operations": [
+          {
+            "type": "A String",
           },
         ],
-        "partiallyHashed": True or False, # True when the hash covers only a prefix of the file.
-        "path": "A String", # Absolute path of the file as a JSON encoded string.
-        "sha256": "A String", # SHA256 hash of the first hashed_size bytes of the file encoded as a hex string. If hashed_size == size, sha256 represents the SHA256 hash of the entire file.
-        "size": "A String", # Size of the file in bytes.
+        "partiallyHashed": True or False,
+        "path": "A String",
+        "sha256": "A String",
+        "size": "A String",
       },
-      "envVariables": [ # Process environment variables.
-        { # A name-value pair representing an environment variable used in an operating system process.
-          "name": "A String", # Environment variable name as a JSON encoded string.
-          "val": "A String", # Environment variable value as a JSON encoded string.
+      "envVariables": [
+        {
+          "name": "A String",
+          "val": "A String",
         },
       ],
-      "envVariablesTruncated": True or False, # True if `env_variables` is incomplete.
-      "libraries": [ # File information for libraries loaded by the process.
-        { # File information about the related binary/library used by an executable, or the script used by a script interpreter
-          "contents": "A String", # Prefix of the file contents as a JSON-encoded string.
-          "diskPath": { # Path of the file in terms of underlying disk/partition identifiers. # Path of the file in terms of underlying disk/partition identifiers.
-            "partitionUuid": "A String", # UUID of the partition (format https://wiki.archlinux.org/title/persistent_block_device_naming#by-uuid)
-            "relativePath": "A String", # Relative path of the file in the partition as a JSON encoded string. Example: /home/user1/executable_file.sh
+      "envVariablesTruncated": True or False,
+      "libraries": [
+        {
+          "contents": "A String",
+          "diskPath": {
+            "partitionUuid": "A String",
+            "relativePath": "A String",
           },
-          "fileLoadState": "A String", # The load state of the file.
-          "hashedSize": "A String", # The length in bytes of the file prefix that was hashed. If hashed_size == size, any hashes reported represent the entire file.
-          "operations": [ # Operation(s) performed on a file.
-            { # Operation(s) performed on a file.
-              "type": "A String", # The type of the operation
+          "fileLoadState": "A String",
+          "hashedSize": "A String",
+          "operations": [
+            {
+              "type": "A String",
             },
           ],
-          "partiallyHashed": True or False, # True when the hash covers only a prefix of the file.
-          "path": "A String", # Absolute path of the file as a JSON encoded string.
-          "sha256": "A String", # SHA256 hash of the first hashed_size bytes of the file encoded as a hex string. If hashed_size == size, sha256 represents the SHA256 hash of the entire file.
-          "size": "A String", # Size of the file in bytes.
+          "partiallyHashed": True or False,
+          "path": "A String",
+          "sha256": "A String",
+          "size": "A String",
         },
       ],
-      "name": "A String", # The process name, as displayed in utilities like `top` and `ps`. This name can be accessed through `/proc/[pid]/comm` and changed with `prctl(PR_SET_NAME)`.
-      "parentPid": "A String", # The parent process ID.
-      "pid": "A String", # The process ID.
-      "script": { # File information about the related binary/library used by an executable, or the script used by a script interpreter # When the process represents the invocation of a script, `binary` provides information about the interpreter, while `script` provides information about the script file provided to the interpreter.
-        "contents": "A String", # Prefix of the file contents as a JSON-encoded string.
-        "diskPath": { # Path of the file in terms of underlying disk/partition identifiers. # Path of the file in terms of underlying disk/partition identifiers.
-          "partitionUuid": "A String", # UUID of the partition (format https://wiki.archlinux.org/title/persistent_block_device_naming#by-uuid)
-          "relativePath": "A String", # Relative path of the file in the partition as a JSON encoded string. Example: /home/user1/executable_file.sh
+      "name": "A String",
+      "parentPid": "A String",
+      "pid": "A String",
+      "script": {
+        "contents": "A String",
+        "diskPath": {
+          "partitionUuid": "A String",
+          "relativePath": "A String",
         },
-        "fileLoadState": "A String", # The load state of the file.
-        "hashedSize": "A String", # The length in bytes of the file prefix that was hashed. If hashed_size == size, any hashes reported represent the entire file.
-        "operations": [ # Operation(s) performed on a file.
-          { # Operation(s) performed on a file.
-            "type": "A String", # The type of the operation
+        "fileLoadState": "A String",
+        "hashedSize": "A String",
+        "operations": [
+          {
+            "type": "A String",
           },
         ],
-        "partiallyHashed": True or False, # True when the hash covers only a prefix of the file.
-        "path": "A String", # Absolute path of the file as a JSON encoded string.
-        "sha256": "A String", # SHA256 hash of the first hashed_size bytes of the file encoded as a hex string. If hashed_size == size, sha256 represents the SHA256 hash of the entire file.
-        "size": "A String", # Size of the file in bytes.
+        "partiallyHashed": True or False,
+        "path": "A String",
+        "sha256": "A String",
+        "size": "A String",
       },
-      "userId": "A String", # The ID of the user that executed the process. E.g. If this is the root user this will always be 0.
+      "userId": "A String",
     },
   ],
-  "resourceName": "A String", # For findings on Google Cloud resources, the full resource name of the Google Cloud resource this finding is for. See: https://cloud.google.com/apis/design/resource_names#full_resource_name When the finding is for a non-Google Cloud resource, the resourceName can be a customer or partner defined string. This field is immutable after creation time.
-  "secret": { # Details about a secret or credential associated with the finding. # Secret associated with the finding.
-    "environmentVariable": { # Environment variable containing the secret. # The environment variable containing the secret.
-      "key": "A String", # Environment variable name as a JSON encoded string. Note that value is not included since the value contains the secret data, which is sensitive core content.
+  "resourceName": "A String",
+  "secret": {
+    "environmentVariable": {
+      "key": "A String",
     },
-    "filePath": { # File path containing the secret. # The file containing the secret.
-      "path": "A String", # Path to the file.
+    "filePath": {
+      "path": "A String",
     },
-    "status": { # The status of the secret. # The status of the secret.
-      "lastUpdatedTime": "A String", # Time that the secret was found.
-      "validity": "A String", # The validity of the secret.
+    "status": {
+      "lastUpdatedTime": "A String",
+      "validity": "A String",
     },
-    "type": "A String", # The type of secret, for example, GCP_API_KEY.
+    "type": "A String",
   },
-  "securityMarks": { # User specified security marks that are attached to the parent Security Command Center resource. Security marks are scoped within a Security Command Center organization -- they can be modified and viewed by all users who have proper permissions on the organization. # Output only. User specified security marks. These marks are entirely managed by the user and come from the SecurityMarks resource that belongs to the finding.
-    "canonicalName": "A String", # The canonical name of the marks. Examples: "organizations/{organization_id}/assets/{asset_id}/securityMarks" "folders/{folder_id}/assets/{asset_id}/securityMarks" "projects/{project_number}/assets/{asset_id}/securityMarks" "organizations/{organization_id}/sources/{source_id}/findings/{finding_id}/securityMarks" "folders/{folder_id}/sources/{source_id}/findings/{finding_id}/securityMarks" "projects/{project_number}/sources/{source_id}/findings/{finding_id}/securityMarks"
-    "marks": { # Mutable user specified security marks belonging to the parent resource. Constraints are as follows: * Keys and values are treated as case insensitive * Keys must be between 1 - 256 characters (inclusive) * Keys must be letters, numbers, underscores, or dashes * Values have leading and trailing whitespace trimmed, remaining characters must be between 1 - 4096 characters (inclusive)
+  "securityMarks": {
+    "canonicalName": "A String",
+    "marks": {
       "a_key": "A String",
     },
-    "name": "A String", # The relative resource name of the SecurityMarks. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Examples: "organizations/{organization_id}/assets/{asset_id}/securityMarks" "organizations/{organization_id}/sources/{source_id}/findings/{finding_id}/securityMarks".
-  },
-  "securityPosture": { # Represents a posture that is deployed on Google Cloud by the Security Command Center Posture Management service. A posture contains one or more policy sets. A policy set is a group of policies that enforce a set of security rules on Google Cloud. # The security posture associated with the finding.
-    "changedPolicy": "A String", # The name of the updated policy, for example, `projects/{project_id}/policies/{constraint_name}`.
-    "name": "A String", # Name of the posture, for example, `CIS-Posture`.
-    "policy": "A String", # The ID of the updated policy, for example, `compute-policy-1`.
-    "policyDriftDetails": [ # The details about a change in an updated policy that violates the deployed posture.
-      { # The policy field that violates the deployed posture and its expected and detected values.
-        "detectedValue": "A String", # The detected value that violates the deployed posture, for example, `false` or `allowed_values={"projects/22831892"}`.
-        "expectedValue": "A String", # The value of this field that was configured in a posture, for example, `true` or `allowed_values={"projects/29831892"}`.
-        "field": "A String", # The name of the updated field, for example constraint.implementation.policy_rules[0].enforce
+    "name": "A String",
+  },
+  "securityPosture": {
+    "changedPolicy": "A String",
+    "name": "A String",
+    "policy": "A String",
+    "policyDriftDetails": [
+      {
+        "detectedValue": "A String",
+        "expectedValue": "A String",
+        "field": "A String",
       },
     ],
-    "policySet": "A String", # The name of the updated policyset, for example, `cis-policyset`.
-    "postureDeployment": "A String", # The name of the posture deployment, for example, `organizations/{org_id}/posturedeployments/{posture_deployment_id}`.
-    "postureDeploymentResource": "A String", # The project, folder, or organization on which the posture is deployed, for example, `projects/{project_number}`.
-    "revisionId": "A String", # The version of the posture, for example, `c7cfa2a8`.
+    "policySet": "A String",
+    "postureDeployment": "A String",
+    "postureDeploymentResource": "A String",
+    "revisionId": "A String",
   },
-  "severity": "A String", # The severity of the finding. This field is managed by the source that writes the finding.
-  "sourceProperties": { # Source specific properties. These properties are managed by the source that writes the finding. The key names in the source_properties map must be between 1 and 255 characters, and must start with a letter and contain alphanumeric characters or underscores only.
+  "severity": "A String",
+  "sourceProperties": {
     "a_key": "",
   },
-  "state": "A String", # The state of the finding.
-  "toxicCombination": { # Contains details about a group of security issues that, when the issues occur together, represent a greater risk than when the issues occur independently. A group of such issues is referred to as a toxic combination. # Contains details about a group of security issues that, when the issues occur together, represent a greater risk than when the issues occur independently. A group of such issues is referred to as a toxic combination. This field cannot be updated. Its value is ignored in all update requests.
-    "attackExposureScore": 3.14, # The [Attack exposure score](https://cloud.google.com/security-command-center/docs/attack-exposure-learn#attack_exposure_scores) of this toxic combination. The score is a measure of how much this toxic combination exposes one or more high-value resources to potential attack.
-    "relatedFindings": [ # List of resource names of findings associated with this toxic combination. For example, `organizations/123/sources/456/findings/789`.
+  "state": "A String",
+  "toxicCombination": {
+    "attackExposureScore": 3.14,
+    "relatedFindings": [
       "A String",
     ],
   },
-  "vertexAi": { # Vertex AI-related information associated with the finding. # VertexAi associated with the finding.
-    "datasets": [ # Datasets associated with the finding.
-      { # Vertex AI dataset associated with the finding.
-        "displayName": "A String", # The user defined display name of dataset, e.g. plants-dataset
-        "name": "A String", # Resource name of the dataset, e.g. projects/{project}/locations/{location}/datasets/2094040236064505856
-        "source": "A String", # Data source, such as BigQuery source URI, e.g. bq://scc-nexus-test.AIPPtest.gsod
+  "vertexAi": {
+    "datasets": [
+      {
+        "displayName": "A String",
+        "name": "A String",
+        "source": "A String",
       },
     ],
-    "pipelines": [ # Pipelines associated with the finding.
-      { # Vertex AI training pipeline associated with the finding.
-        "displayName": "A String", # The user defined display name of pipeline, e.g. plants-classification
-        "name": "A String", # Resource name of the pipeline, e.g. projects/{project}/locations/{location}/trainingPipelines/5253428229225578496
+    "pipelines": [
+      {
+        "displayName": "A String",
+        "name": "A String",
       },
     ],
   },
-  "vulnerability": { # Refers to common vulnerability fields e.g. cve, cvss, cwe etc. # Represents vulnerability-specific fields like CVE and CVSS scores. CVE stands for Common Vulnerabilities and Exposures (https://cve.mitre.org/about/)
-    "cve": { # CVE stands for Common Vulnerabilities and Exposures. Information from the [CVE record](https://www.cve.org/ResourcesSupport/Glossary) that describes this vulnerability. # CVE stands for Common Vulnerabilities and Exposures (https://cve.mitre.org/about/)
-      "cvssv3": { # Common Vulnerability Scoring System version 3. # Describe Common Vulnerability Scoring System specified at https://www.first.org/cvss/v3.1/specification-document
-        "attackComplexity": "A String", # This metric describes the conditions beyond the attacker's control that must exist in order to exploit the vulnerability.
-        "attackVector": "A String", # Base Metrics Represents the intrinsic characteristics of a vulnerability that are constant over time and across user environments. This metric reflects the context by which vulnerability exploitation is possible.
-        "availabilityImpact": "A String", # This metric measures the impact to the availability of the impacted component resulting from a successfully exploited vulnerability.
-        "baseScore": 3.14, # The base score is a function of the base metric scores.
-        "confidentialityImpact": "A String", # This metric measures the impact to the confidentiality of the information resources managed by a software component due to a successfully exploited vulnerability.
-        "integrityImpact": "A String", # This metric measures the impact to integrity of a successfully exploited vulnerability.
-        "privilegesRequired": "A String", # This metric describes the level of privileges an attacker must possess before successfully exploiting the vulnerability.
-        "scope": "A String", # The Scope metric captures whether a vulnerability in one vulnerable component impacts resources in components beyond its security scope.
-        "userInteraction": "A String", # This metric captures the requirement for a human user, other than the attacker, to participate in the successful compromise of the vulnerable component.
+  "vulnerability": {
+    "cve": {
+      "cvssv3": {
+        "attackComplexity": "A String",
+        "attackVector": "A String",
+        "availabilityImpact": "A String",
+        "baseScore": 3.14,
+        "confidentialityImpact": "A String",
+        "integrityImpact": "A String",
+        "privilegesRequired": "A String",
+        "scope": "A String",
+        "userInteraction": "A String",
       },
-      "exploitReleaseDate": "A String", # Date the first publicly available exploit or PoC was released.
-      "exploitationActivity": "A String", # The exploitation activity of the vulnerability in the wild.
-      "firstExploitationDate": "A String", # Date of the earliest known exploitation.
-      "id": "A String", # The unique identifier for the vulnerability. e.g. CVE-2021-34527
-      "impact": "A String", # The potential impact of the vulnerability if it was to be exploited.
-      "observedInTheWild": True or False, # Whether or not the vulnerability has been observed in the wild.
-      "references": [ # Additional information about the CVE. e.g. https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2021-34527
-        { # Additional Links
-          "source": "A String", # Source of the reference e.g. NVD
-          "uri": "A String", # Uri for the mentioned source e.g. https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2021-34527.
+      "exploitReleaseDate": "A String",
+      "exploitationActivity": "A String",
+      "firstExploitationDate": "A String",
+      "id": "A String",
+      "impact": "A String",
+      "observedInTheWild": True or False,
+      "references": [
+        {
+          "source": "A String",
+          "uri": "A String",
         },
       ],
-      "upstreamFixAvailable": True or False, # Whether upstream fix is available for the CVE.
-      "zeroDay": True or False, # Whether or not the vulnerability was zero day when the finding was published.
-    },
-    "cwes": [ # Represents one or more Common Weakness Enumeration (CWE) information on this vulnerability.
-      { # CWE stands for Common Weakness Enumeration. Information about this weakness, as described by [CWE](https://cwe.mitre.org/).
-        "id": "A String", # The CWE identifier, e.g. CWE-94
-        "references": [ # Any reference to the details on the CWE, for example, https://cwe.mitre.org/data/definitions/94.html
-          { # Additional Links
-            "source": "A String", # Source of the reference e.g. NVD
-            "uri": "A String", # Uri for the mentioned source e.g. https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2021-34527.
+      "upstreamFixAvailable": True or False,
+      "zeroDay": True or False,
+    },
+    "cwes": [
+      {
+        "id": "A String",
+        "references": [
+          {
+            "source": "A String",
+            "uri": "A String",
           },
         ],
       },
     ],
-    "fixedPackage": { # Package is a generic definition of a package. # The fixed package is relevant to the finding.
-      "cpeUri": "A String", # The CPE URI where the vulnerability was detected.
-      "packageName": "A String", # The name of the package where the vulnerability was detected.
-      "packageType": "A String", # Type of package, for example, os, maven, or go.
-      "packageVersion": "A String", # The version of the package.
+    "fixedPackage": {
+      "cpeUri": "A String",
+      "packageName": "A String",
+      "packageType": "A String",
+      "packageVersion": "A String",
     },
-    "offendingPackage": { # Package is a generic definition of a package. # The offending package is relevant to the finding.
-      "cpeUri": "A String", # The CPE URI where the vulnerability was detected.
-      "packageName": "A String", # The name of the package where the vulnerability was detected.
-      "packageType": "A String", # Type of package, for example, os, maven, or go.
-      "packageVersion": "A String", # The version of the package.
+    "offendingPackage": {
+      "cpeUri": "A String",
+      "packageName": "A String",
+      "packageType": "A String",
+      "packageVersion": "A String",
     },
-    "providerRiskScore": "A String", # Provider provided risk_score based on multiple factors. The higher the risk score, the more risky the vulnerability is.
-    "reachable": True or False, # Represents whether the vulnerability is reachable (detected via static analysis)
-    "securityBulletin": { # SecurityBulletin are notifications of vulnerabilities of Google products. # The security bulletin is relevant to this finding.
-      "bulletinId": "A String", # ID of the bulletin corresponding to the vulnerability.
-      "submissionTime": "A String", # Submission time of this Security Bulletin.
-      "suggestedUpgradeVersion": "A String", # This represents a version that the cluster receiving this notification should be upgraded to, based on its current version. For example, 1.15.0
+    "providerRiskScore": "A String",
+    "reachable": True or False,
+    "securityBulletin": {
+      "bulletinId": "A String",
+      "submissionTime": "A String",
+      "suggestedUpgradeVersion": "A String",
     },
   },
 }
 
-  updateMask: string, The FieldMask to use when updating the finding resource. This field should not be specified when creating a finding. When updating a finding, an empty mask is treated as updating all mutable fields and replacing source_properties. Individual source_properties can be added/updated by using "source_properties." in the field mask.
+  updateMask: string, A parameter
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -1971,811 +1971,811 @@ 

Method Details

Returns: An object of the form: - { # Security Command Center finding. A finding is a record of assessment data like security, risk, health, or privacy, that is ingested into Security Command Center for presentation, notification, analysis, policy testing, and enforcement. For example, a cross-site scripting (XSS) vulnerability in an App Engine application is a finding. - "access": { # Represents an access event. # Access details associated with the finding, such as more information on the caller, which method was accessed, and from where. - "callerIp": "A String", # Caller's IP address, such as "1.1.1.1". - "callerIpGeo": { # Represents a geographical location for a given access. # The caller IP's geolocation, which identifies where the call came from. - "regionCode": "A String", # A CLDR. - }, - "methodName": "A String", # The method that the service account called, e.g. "SetIamPolicy". - "principalEmail": "A String", # Associated email, such as "foo@google.com". The email address of the authenticated user or a service account acting on behalf of a 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). - "principalSubject": "A String", # A string that represents the principal_subject that is associated with the identity. Unlike `principal_email`, `principal_subject` supports principals that aren't associated with email addresses, such as third party principals. For most identities, the format is `principal://iam.googleapis.com/{identity pool name}/subject/{subject}`. Some GKE identities, such as GKE_WORKLOAD, FREEFORM, and GKE_HUB_WORKLOAD, still use the legacy format `serviceAccount:{identity pool name}[{subject}]`. - "serviceAccountDelegationInfo": [ # The identity delegation history of an authenticated service account that made the request. The `serviceAccountDelegationInfo[]` object contains information about the real authorities that try to access Google Cloud resources by delegating on a service account. When multiple authorities are present, they are guaranteed to be sorted based on the original ordering of the identity delegation events. - { # Identity delegation history of an authenticated service account. - "principalEmail": "A String", # The email address of a Google account. - "principalSubject": "A String", # A string representing the principal_subject associated with the identity. As compared to `principal_email`, supports principals that aren't associated with email addresses, such as third party principals. For most identities, the format will be `principal://iam.googleapis.com/{identity pool name}/subjects/{subject}` except for some GKE identities (GKE_WORKLOAD, FREEFORM, GKE_HUB_WORKLOAD) that are still in the legacy format `serviceAccount:{identity pool name}[{subject}]` + { + "access": { + "callerIp": "A String", + "callerIpGeo": { + "regionCode": "A String", + }, + "methodName": "A String", + "principalEmail": "A String", + "principalSubject": "A String", + "serviceAccountDelegationInfo": [ + { + "principalEmail": "A String", + "principalSubject": "A String", }, ], - "serviceAccountKeyName": "A String", # The name of the service account key that was used to create or exchange credentials when authenticating the service account that made the request. This is a scheme-less URI full resource name. For example: "//iam.googleapis.com/projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}/keys/{key}". - "serviceName": "A String", # This is the API service that the service account made a call to, e.g. "iam.googleapis.com" - "userAgent": "A String", # The caller's user agent string associated with the finding. - "userAgentFamily": "A String", # Type of user agent associated with the finding. For example, an operating system shell or an embedded or standalone application. - "userName": "A String", # A string that represents a username. The username provided depends on the type of the finding and is likely not an IAM principal. For example, this can be a system username if the finding is related to a virtual machine, or it can be an application login username. + "serviceAccountKeyName": "A String", + "serviceName": "A String", + "userAgent": "A String", + "userAgentFamily": "A String", + "userName": "A String", }, - "affectedResources": { # Details about resources affected by this finding. # AffectedResources associated with the finding. - "count": "A String", # The count of resources affected by the finding. + "affectedResources": { + "count": "A String", }, - "agentDataAccessEvents": [ # Agent data access events associated with the finding. - { # Details about a data access attempt made by an agent principal not authorized under applicable data security policy. - "eventId": "A String", # Unique identifier for data access event. - "eventTime": "A String", # Timestamp of data access event. - "operation": "A String", # The operation performed by the principal to access the data. - "principalSubject": "A String", # The agent principal that accessed the data. + "agentDataAccessEvents": [ + { + "eventId": "A String", + "eventTime": "A String", + "operation": "A String", + "principalSubject": "A String", }, ], - "aiModel": { # Contains information about the AI model associated with the finding. # The AI model associated with the finding. - "deploymentPlatform": "A String", # The platform on which the model is deployed. - "displayName": "A String", # The user defined display name of model. Ex. baseline-classification-model - "domain": "A String", # The domain of the model, for example, “image-classification”. - "library": "A String", # The name of the model library, for example, “transformers”. - "location": "A String", # The region in which the model is used, for example, “us-central1”. - "name": "A String", # The name of the AI model, for example, "gemini:1.0.0". - "publisher": "A String", # The publisher of the model, for example, “google” or “nvidia”. - "usageCategory": "A String", # The purpose of the model, for example, "Inteference" or "Training". - }, - "application": { # Represents an application associated with a finding. # Represents an application associated with the finding. - "baseUri": "A String", # The base URI that identifies the network location of the application in which the vulnerability was detected. For example, `http://example.com`. - "fullUri": "A String", # The full URI with payload that can be used to reproduce the vulnerability. For example, `http://example.com?p=aMmYgI6H`. - }, - "artifactGuardPolicies": { # Represents the result of evaluating artifact guard policies. # ArtifactGuardPolicies associated with the finding. - "failingPolicies": [ # A list of failing policies. - { # Represents an artifact guard policy. - "failureReason": "A String", # The reason for the policy failure, for example, "severity=HIGH AND max_vuln_count=2". - "policyId": "A String", # The ID of the failing policy, for example, "organizations/3392779/locations/global/policies/prod-policy". - "type": "A String", # The type of the policy evaluation. + "aiModel": { + "deploymentPlatform": "A String", + "displayName": "A String", + "domain": "A String", + "library": "A String", + "location": "A String", + "name": "A String", + "publisher": "A String", + "usageCategory": "A String", + }, + "application": { + "baseUri": "A String", + "fullUri": "A String", + }, + "artifactGuardPolicies": { + "failingPolicies": [ + { + "failureReason": "A String", + "policyId": "A String", + "type": "A String", }, ], - "resourceId": "A String", # The ID of the resource that has policies configured for it. + "resourceId": "A String", }, - "attackExposure": { # An attack exposure contains the results of an attack path simulation run. # The results of an attack path simulation relevant to this finding. - "attackExposureResult": "A String", # The resource name of the attack path simulation result that contains the details regarding this attack exposure score. Example: `organizations/123/simulations/456/attackExposureResults/789` - "exposedHighValueResourcesCount": 42, # The number of high value resources that are exposed as a result of this finding. - "exposedLowValueResourcesCount": 42, # The number of high value resources that are exposed as a result of this finding. - "exposedMediumValueResourcesCount": 42, # The number of medium value resources that are exposed as a result of this finding. - "latestCalculationTime": "A String", # The most recent time the attack exposure was updated on this finding. - "score": 3.14, # A number between 0 (inclusive) and infinity that represents how important this finding is to remediate. The higher the score, the more important it is to remediate. - "state": "A String", # What state this AttackExposure is in. This captures whether or not an attack exposure has been calculated or not. + "attackExposure": { + "attackExposureResult": "A String", + "exposedHighValueResourcesCount": 42, + "exposedLowValueResourcesCount": 42, + "exposedMediumValueResourcesCount": 42, + "latestCalculationTime": "A String", + "score": 3.14, + "state": "A String", }, - "backupDisasterRecovery": { # Information related to Google Cloud Backup and DR Service findings. # Fields related to Backup and DR findings. - "appliance": "A String", # The name of the Backup and DR appliance that captures, moves, and manages the lifecycle of backup data. For example, `backup-server-57137`. - "applications": [ # The names of Backup and DR applications. An application is a VM, database, or file system on a managed host monitored by a backup and recovery appliance. For example, `centos7-01-vol00`, `centos7-01-vol01`, `centos7-01-vol02`. + "backupDisasterRecovery": { + "appliance": "A String", + "applications": [ "A String", ], - "backupCreateTime": "A String", # The timestamp at which the Backup and DR backup was created. - "backupTemplate": "A String", # The name of a Backup and DR template which comprises one or more backup policies. See the [Backup and DR documentation](https://cloud.google.com/backup-disaster-recovery/docs/concepts/backup-plan#temp) for more information. For example, `snap-ov`. - "backupType": "A String", # The backup type of the Backup and DR image. For example, `Snapshot`, `Remote Snapshot`, `OnVault`. - "host": "A String", # The name of a Backup and DR host, which is managed by the backup and recovery appliance and known to the management console. The host can be of type Generic (for example, Compute Engine, SQL Server, Oracle DB, SMB file system, etc.), vCenter, or an ESX server. See the [Backup and DR documentation on hosts](https://cloud.google.com/backup-disaster-recovery/docs/configuration/manage-hosts-and-their-applications) for more information. For example, `centos7-01`. - "policies": [ # The names of Backup and DR policies that are associated with a template and that define when to run a backup, how frequently to run a backup, and how long to retain the backup image. For example, `onvaults`. + "backupCreateTime": "A String", + "backupTemplate": "A String", + "backupType": "A String", + "host": "A String", + "policies": [ "A String", ], - "policyOptions": [ # The names of Backup and DR advanced policy options of a policy applying to an application. See the [Backup and DR documentation on policy options](https://cloud.google.com/backup-disaster-recovery/docs/create-plan/policy-settings). For example, `skipofflineappsincongrp, nounmap`. + "policyOptions": [ "A String", ], - "profile": "A String", # The name of the Backup and DR resource profile that specifies the storage media for backups of application and VM data. See the [Backup and DR documentation on profiles](https://cloud.google.com/backup-disaster-recovery/docs/concepts/backup-plan#profile). For example, `GCP`. - "storagePool": "A String", # The name of the Backup and DR storage pool that the backup and recovery appliance is storing data in. The storage pool could be of type Cloud, Primary, Snapshot, or OnVault. See the [Backup and DR documentation on storage pools](https://cloud.google.com/backup-disaster-recovery/docs/concepts/storage-pools). For example, `DiskPoolOne`. + "profile": "A String", + "storagePool": "A String", }, - "canonicalName": "A String", # The canonical name of the finding. It's either "organizations/{organization_id}/sources/{source_id}/findings/{finding_id}", "folders/{folder_id}/sources/{source_id}/findings/{finding_id}" or "projects/{project_number}/sources/{source_id}/findings/{finding_id}", depending on the closest CRM ancestor of the resource associated with the finding. - "category": "A String", # The additional taxonomy group within findings from a given source. This field is immutable after creation time. Example: "XSS_FLASH_INJECTION" - "chokepoint": { # Contains details about a chokepoint, which is a resource or resource group where high-risk attack paths converge, based on [attack path simulations] (https://cloud.google.com/security-command-center/docs/attack-exposure-learn#attack_path_simulations). # Contains details about a chokepoint, which is a resource or resource group where high-risk attack paths converge, based on [attack path simulations] (https://cloud.google.com/security-command-center/docs/attack-exposure-learn#attack_path_simulations). This field cannot be updated. Its value is ignored in all update requests. - "relatedFindings": [ # List of resource names of findings associated with this chokepoint. For example, organizations/123/sources/456/findings/789. This list will have at most 100 findings. + "canonicalName": "A String", + "category": "A String", + "chokepoint": { + "relatedFindings": [ "A String", ], }, - "cloudArmor": { # Fields related to Google Cloud Armor findings. # Fields related to Cloud Armor findings. - "adaptiveProtection": { # Information about [Google Cloud Armor Adaptive Protection](https://cloud.google.com/armor/docs/cloud-armor-overview#google-cloud-armor-adaptive-protection). # Information about potential Layer 7 DDoS attacks identified by [Google Cloud Armor Adaptive Protection](https://cloud.google.com/armor/docs/adaptive-protection-overview). - "confidence": 3.14, # A score of 0 means that there is low confidence that the detected event is an actual attack. A score of 1 means that there is high confidence that the detected event is an attack. See the [Adaptive Protection documentation](https://cloud.google.com/armor/docs/adaptive-protection-overview#configure-alert-tuning) for further explanation. - }, - "attack": { # Information about DDoS attack volume and classification. # Information about DDoS attack volume and classification. - "classification": "A String", # Type of attack, for example, 'SYN-flood', 'NTP-udp', or 'CHARGEN-udp'. - "volumeBps": 42, # Total BPS (bytes per second) volume of attack. Deprecated - refer to volume_bps_long instead. - "volumeBpsLong": "A String", # Total BPS (bytes per second) volume of attack. - "volumePps": 42, # Total PPS (packets per second) volume of attack. Deprecated - refer to volume_pps_long instead. - "volumePpsLong": "A String", # Total PPS (packets per second) volume of attack. - }, - "duration": "A String", # Duration of attack from the start until the current moment (updated every 5 minutes). - "requests": { # Information about the requests relevant to the finding. # Information about incoming requests evaluated by [Google Cloud Armor security policies](https://cloud.google.com/armor/docs/security-policy-overview). - "longTermAllowed": 42, # Allowed RPS (requests per second) over the long term. - "longTermDenied": 42, # Denied RPS (requests per second) over the long term. - "ratio": 3.14, # For 'Increasing deny ratio', the ratio is the denied traffic divided by the allowed traffic. For 'Allowed traffic spike', the ratio is the allowed traffic in the short term divided by allowed traffic in the long term. - "shortTermAllowed": 42, # Allowed RPS (requests per second) in the short term. - }, - "securityPolicy": { # Information about the [Google Cloud Armor security policy](https://cloud.google.com/armor/docs/security-policy-overview) relevant to the finding. # Information about the [Google Cloud Armor security policy](https://cloud.google.com/armor/docs/security-policy-overview) relevant to the finding. - "name": "A String", # The name of the Google Cloud Armor security policy, for example, "my-security-policy". - "preview": True or False, # Whether or not the associated rule or policy is in preview mode. - "type": "A String", # The type of Google Cloud Armor security policy for example, 'backend security policy', 'edge security policy', 'network edge security policy', or 'always-on DDoS protection'. - }, - "threatVector": "A String", # Distinguish between volumetric & protocol DDoS attack and application layer attacks. For example, "L3_4" for Layer 3 and Layer 4 DDoS attacks, or "L_7" for Layer 7 DDoS attacks. - }, - "cloudDlpDataProfile": { # The [data profile](https://cloud.google.com/dlp/docs/data-profiles) associated with the finding. # Cloud DLP data profile that is associated with the finding. - "dataProfile": "A String", # Name of the data profile, for example, `projects/123/locations/europe/tableProfiles/8383929`. - "infoTypes": [ # Type of information detected by SDP. Info type includes name, version and sensitivity of the detected information type. - { # Type of information detected by the API. - "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. - "sensitivityScore": { # Score is calculated from of all elements in the data profile. A higher level means the data is more sensitive. # Optional custom sensitivity for this InfoType. This only applies to data profiling. - "score": "A String", # The sensitivity score applied to the resource. + "cloudArmor": { + "adaptiveProtection": { + "confidence": 3.14, + }, + "attack": { + "classification": "A String", + "volumeBps": 42, + "volumeBpsLong": "A String", + "volumePps": 42, + "volumePpsLong": "A String", + }, + "duration": "A String", + "requests": { + "longTermAllowed": 42, + "longTermDenied": 42, + "ratio": 3.14, + "shortTermAllowed": 42, + }, + "securityPolicy": { + "name": "A String", + "preview": True or False, + "type": "A String", + }, + "threatVector": "A String", + }, + "cloudDlpDataProfile": { + "dataProfile": "A String", + "infoTypes": [ + { + "name": "A String", + "sensitivityScore": { + "score": "A String", }, - "version": "A String", # Optional version name for this InfoType. + "version": "A String", }, ], - "parentType": "A String", # The resource hierarchy level at which the data profile was generated. + "parentType": "A String", }, - "cloudDlpInspection": { # Details about the Cloud Data Loss Prevention (Cloud DLP) [inspection job](https://cloud.google.com/dlp/docs/concepts-job-triggers) that produced the finding. # Cloud Data Loss Prevention (Cloud DLP) inspection results that are associated with the finding. - "fullScan": True or False, # Whether Cloud DLP scanned the complete resource or a sampled subset. - "infoType": "A String", # The type of information (or *[infoType](https://cloud.google.com/dlp/docs/infotypes-reference)*) found, for example, `EMAIL_ADDRESS` or `STREET_ADDRESS`. - "infoTypeCount": "A String", # The number of times Cloud DLP found this infoType within this job and resource. - "inspectJob": "A String", # Name of the inspection job, for example, `projects/123/locations/europe/dlpJobs/i-8383929`. + "cloudDlpInspection": { + "fullScan": True or False, + "infoType": "A String", + "infoTypeCount": "A String", + "inspectJob": "A String", }, - "complianceDetails": { # Compliance Details associated with the finding. # Details about the compliance implications of the finding. - "cloudControl": { # CloudControl associated with the finding. # CloudControl associated with the finding - "cloudControlName": "A String", # Name of the CloudControl associated with the finding. - "policyType": "A String", # Policy type of the CloudControl - "type": "A String", # Type of cloud control. - "version": 42, # Version of the Cloud Control + "complianceDetails": { + "cloudControl": { + "cloudControlName": "A String", + "policyType": "A String", + "type": "A String", + "version": 42, }, - "cloudControlDeploymentNames": [ # Cloud Control Deployments associated with the finding. For example, organizations/123/locations/global/cloudControlDeployments/deploymentIdentifier + "cloudControlDeploymentNames": [ "A String", ], - "frameworks": [ # Details of Frameworks associated with the finding - { # Compliance framework associated with the finding. - "category": [ # Category of the framework associated with the finding. E.g. Security Benchmark, or Assured Workloads + "frameworks": [ + { + "category": [ "A String", ], - "controls": [ # The controls associated with the framework. - { # Compliance control associated with the finding. - "controlName": "A String", # Name of the Control - "displayName": "A String", # Display name of the control. For example, AU-02. + "controls": [ + { + "controlName": "A String", + "displayName": "A String", }, ], - "displayName": "A String", # Display name of the framework. For a standard framework, this will look like e.g. PCI DSS 3.2.1, whereas for a custom framework it can be a user defined string like MyFramework - "name": "A String", # Name of the framework associated with the finding - "type": "A String", # Type of the framework associated with the finding, to specify whether the framework is built-in (pre-defined and immutable) or a custom framework defined by the customer (equivalent to security posture) + "displayName": "A String", + "name": "A String", + "type": "A String", }, ], }, - "compliances": [ # Contains compliance information for security standards associated to the finding. - { # Contains compliance information about a security standard indicating unmet recommendations. - "ids": [ # Policies within the standard or benchmark, for example, A.12.4.1 + "compliances": [ + { + "ids": [ "A String", ], - "standard": "A String", # Industry-wide compliance standards or benchmarks, such as CIS, PCI, and OWASP. - "version": "A String", # Version of the standard or benchmark, for example, 1.1 + "standard": "A String", + "version": "A String", }, ], - "connections": [ # Contains information about the IP connection associated with the finding. - { # Contains information about the IP connection associated with the finding. - "destinationIp": "A String", # Destination IP address. Not present for sockets that are listening and not connected. - "destinationPort": 42, # Destination port. Not present for sockets that are listening and not connected. - "protocol": "A String", # IANA Internet Protocol Number such as TCP(6) and UDP(17). - "sourceIp": "A String", # Source IP address. - "sourcePort": 42, # Source port. + "connections": [ + { + "destinationIp": "A String", + "destinationPort": 42, + "protocol": "A String", + "sourceIp": "A String", + "sourcePort": 42, }, ], - "contacts": { # Output only. Map containing the points of contact for the given finding. The key represents the type of contact, while the value contains a list of all the contacts that pertain. Please refer to: https://cloud.google.com/resource-manager/docs/managing-notification-contacts#notification-categories { "security": { "contacts": [ { "email": "person1@company.com" }, { "email": "person2@company.com" } ] } } - "a_key": { # Details about specific contacts - "contacts": [ # A list of contacts - { # The email address of a contact. - "email": "A String", # An email address. For example, "`person123@company.com`". + "contacts": { + "a_key": { + "contacts": [ + { + "email": "A String", }, ], }, }, - "containers": [ # Containers associated with the finding. This field provides information for both Kubernetes and non-Kubernetes containers. - { # Container associated with the finding. - "createTime": "A String", # The time that the container was created. - "imageId": "A String", # Optional container image ID, if provided by the container runtime. Uniquely identifies the container image launched using a container image digest. - "labels": [ # Container labels, as provided by the container runtime. - { # Represents a generic name-value label. A label has separate name and value fields to support filtering with the `contains()` function. For more information, see [Filtering on array-type fields](https://cloud.google.com/security-command-center/docs/how-to-api-list-findings#array-contains-filtering). - "name": "A String", # Name of the label. - "value": "A String", # Value that corresponds to the label's name. + "containers": [ + { + "createTime": "A String", + "imageId": "A String", + "labels": [ + { + "name": "A String", + "value": "A String", }, ], - "name": "A String", # Name of the container. - "uri": "A String", # Container image URI provided when configuring a pod or container. This string can identify a container image version using mutable tags. + "name": "A String", + "uri": "A String", }, ], - "createTime": "A String", # The time at which the finding was created in Security Command Center. - "dataAccessEvents": [ # Data access events associated with the finding. - { # Details about a data access attempt made by a principal not authorized under applicable data security policy. - "eventId": "A String", # Unique identifier for data access event. - "eventTime": "A String", # Timestamp of data access event. - "operation": "A String", # The operation performed by the principal to access the data. - "principalEmail": "A String", # The email address of the principal that accessed the data. The principal could be a user account, service account, Google group, or other. + "createTime": "A String", + "dataAccessEvents": [ + { + "eventId": "A String", + "eventTime": "A String", + "operation": "A String", + "principalEmail": "A String", }, ], - "dataFlowEvents": [ # Data flow events associated with the finding. - { # Details about a data flow event, in which either the data is moved to or is accessed from a non-compliant geo-location, as defined in the applicable data security policy. - "eventId": "A String", # Unique identifier for data flow event. - "eventTime": "A String", # Timestamp of data flow event. - "operation": "A String", # The operation performed by the principal for the data flow event. - "principalEmail": "A String", # The email address of the principal that initiated the data flow event. The principal could be a user account, service account, Google group, or other. - "violatedLocation": "A String", # Non-compliant location of the principal or the data destination. + "dataFlowEvents": [ + { + "eventId": "A String", + "eventTime": "A String", + "operation": "A String", + "principalEmail": "A String", + "violatedLocation": "A String", }, ], - "dataRetentionDeletionEvents": [ # Data retention deletion events associated with the finding. - { # Details about data retention deletion violations, in which the data is non-compliant based on their retention or deletion time, as defined in the applicable data security policy. The Data Retention Deletion (DRD) control is a control of the DSPM (Data Security Posture Management) suite that enables organizations to manage data retention and deletion policies in compliance with regulations, such as GDPR and CRPA. DRD supports two primary policy types: maximum storage length (max TTL) and minimum storage length (min TTL). Both are aimed at helping organizations meet regulatory and data management commitments. - "dataObjectCount": "A String", # Number of objects that violated the policy for this resource. If the number is less than 1,000, then the value of this field is the exact number. If the number of objects that violated the policy is greater than or equal to 1,000, then the value of this field is 1000. - "eventDetectionTime": "A String", # Timestamp indicating when the event was detected. - "eventType": "A String", # Type of the DRD event. - "maxRetentionAllowed": "A String", # Maximum duration of retention allowed from the DRD control. This comes from the DRD control where users set a max TTL for their data. For example, suppose that a user sets the max TTL for a Cloud Storage bucket to 90 days. However, an object in that bucket is 100 days old. In this case, a DataRetentionDeletionEvent will be generated for that Cloud Storage bucket, and the max_retention_allowed is 90 days. - "minRetentionAllowed": "A String", # Min duration of retention allowed from the DSPM retention control. This field is only populated when event type is set to EVENT_TYPE_MIN_TTL_FROM_CREATION. + "dataRetentionDeletionEvents": [ + { + "dataObjectCount": "A String", + "eventDetectionTime": "A String", + "eventType": "A String", + "maxRetentionAllowed": "A String", + "minRetentionAllowed": "A String", }, ], - "database": { # Represents database access information, such as queries. A database may be a sub-resource of an instance (as in the case of Cloud SQL instances or Cloud Spanner instances), or the database instance itself. Some database resources might not have the [full resource name](https://google.aip.dev/122#full-resource-names) populated because these resource types, such as Cloud SQL databases, are not yet supported by Cloud Asset Inventory. In these cases only the display name is provided. # Database associated with the finding. - "displayName": "A String", # The human-readable name of the database that the user connected to. - "grantees": [ # The target usernames, roles, or groups of an SQL privilege grant, which is not an IAM policy change. + "database": { + "displayName": "A String", + "grantees": [ "A String", ], - "name": "A String", # Some database resources may not have the [full resource name](https://google.aip.dev/122#full-resource-names) populated because these resource types are not yet supported by Cloud Asset Inventory (e.g. Cloud SQL databases). In these cases only the display name will be provided. The [full resource name](https://google.aip.dev/122#full-resource-names) of the database that the user connected to, if it is supported by Cloud Asset Inventory. - "query": "A String", # The SQL statement that is associated with the database access. - "userName": "A String", # The username used to connect to the database. The username might not be an IAM principal and does not have a set format. - "version": "A String", # The version of the database, for example, POSTGRES_14. See [the complete list](https://cloud.google.com/sql/docs/mysql/admin-api/rest/v1/SqlDatabaseVersion). - }, - "description": "A String", # Contains more details about the finding. - "discoveredWorkload": { # Represents discovered, customer managed workload that is not registered with the respective GCP service. # DiscoveredWorkload associated with the finding. - "confidence": "A String", # The confidence in detection of this workload. - "detectedRelevantHardware": True or False, # A boolean flag set to true if associated hardware strongly predicts the workload type. - "detectedRelevantKeywords": True or False, # A boolean flag set to true if associated keywords strongly predict the workload type. - "detectedRelevantPackages": True or False, # A boolean flag set to true if installed packages strongly predict the workload type. - "workloadType": "A String", # The type of workload. - }, - "disk": { # Contains information about the disk associated with the finding. # Disk associated with the finding. - "name": "A String", # The name of the disk, for example, "https://www.googleapis.com/compute/v1/projects/{project-id}/zones/{zone-id}/disks/{disk-id}". - }, - "eventTime": "A String", # The time the finding was first detected. If an existing finding is updated, then this is the time the update occurred. For example, if the finding represents an open firewall, this property captures the time the detector believes the firewall became open. The accuracy is determined by the detector. If the finding is later resolved, then this time reflects when the finding was resolved. This must not be set to a value greater than the current timestamp. - "exfiltration": { # Exfiltration represents a data exfiltration attempt from one or more sources to one or more targets. The `sources` attribute lists the sources of the exfiltrated data. The `targets` attribute lists the destinations the data was copied to. # Represents exfiltrations associated with the finding. - "sources": [ # If there are multiple sources, then the data is considered "joined" between them. For instance, BigQuery can join multiple tables, and each table would be considered a source. - { # Resource where data was exfiltrated from or exfiltrated to. - "components": [ # Subcomponents of the asset that was exfiltrated, like URIs used during exfiltration, table names, databases, and filenames. For example, multiple tables might have been exfiltrated from the same Cloud SQL instance, or multiple files might have been exfiltrated from the same Cloud Storage bucket. + "name": "A String", + "query": "A String", + "userName": "A String", + "version": "A String", + }, + "description": "A String", + "discoveredWorkload": { + "confidence": "A String", + "detectedRelevantHardware": True or False, + "detectedRelevantKeywords": True or False, + "detectedRelevantPackages": True or False, + "workloadType": "A String", + }, + "disk": { + "name": "A String", + }, + "eventTime": "A String", + "exfiltration": { + "sources": [ + { + "components": [ "A String", ], - "name": "A String", # The resource's [full resource name](https://cloud.google.com/apis/design/resource_names#full_resource_name). + "name": "A String", }, ], - "targets": [ # If there are multiple targets, each target would get a complete copy of the "joined" source data. - { # Resource where data was exfiltrated from or exfiltrated to. - "components": [ # Subcomponents of the asset that was exfiltrated, like URIs used during exfiltration, table names, databases, and filenames. For example, multiple tables might have been exfiltrated from the same Cloud SQL instance, or multiple files might have been exfiltrated from the same Cloud Storage bucket. + "targets": [ + { + "components": [ "A String", ], - "name": "A String", # The resource's [full resource name](https://cloud.google.com/apis/design/resource_names#full_resource_name). + "name": "A String", }, ], - "totalExfiltratedBytes": "A String", # Total exfiltrated bytes processed for the entire job. - }, - "externalExposure": { # Details about the externally exposed resource associated with the finding. # External exposure associated with the finding. - "backendBucket": "A String", # The full resource name of the load balancer backend bucket, for example, "//compute.googleapis.com/projects/{project-id}/global/backendBuckets/{name}" - "backendService": "A String", # The full resource name of load balancer backend service, for example, "//compute.googleapis.com/projects/{project-id}/global/backendServices/{name}". - "exposedApplication": "A String", # The name and version of the exposed web application, for example, "Jenkins 2.184". - "exposedEndpoint": "A String", # The resource which is running the exposed service, for example, "//compute.googleapis.com/projects/{project-id}/zones/{zone}/instances/{instance}.” - "exposedService": "A String", # The name and version of the service, for example, "Jupyter Notebook 6.14.0". - "forwardingRule": "A String", # The full resource name of the forwarding rule, for example, "//compute.googleapis.com/projects/{project-id}/global/forwardingRules/{forwarding-rule-name}". - "hostnameUri": "A String", # Hostname of the exposed application, for example, "https://test-app.a.run.app/" - "httpResponse": [ # The http response returned by the web application. - { # The http response returned by the web application. - "path": "A String", # The http path for which response code was returned by web application, for example, "https://test-app.a.run.app/test". - "statusCode": "A String", # The http response code returned by the web application, for example, 200. + "totalExfiltratedBytes": "A String", + }, + "externalExposure": { + "backendBucket": "A String", + "backendService": "A String", + "exposedApplication": "A String", + "exposedEndpoint": "A String", + "exposedService": "A String", + "forwardingRule": "A String", + "hostnameUri": "A String", + "httpResponse": [ + { + "path": "A String", + "statusCode": "A String", }, ], - "instanceGroup": "A String", # The full resource name of the instance group, for example, "//compute.googleapis.com/projects/{project-id}/global/instanceGroups/{name}". - "internalBackendService": "A String", # The full resource name of load balancer backend service in the internal project having resource exposed via PSC, for example, "//compute.googleapis.com/projects/{project-id}/global/backendServices/{name}". - "loadBalancerFirewallPolicy": "A String", # The full resource name of the load balancer firewall policy, for example, "//compute.googleapis.com/projects/{project-id}/global/firewallPolicies/{policy-name}". - "networkEndpointGroup": "A String", # The full resource name of the network endpoint group, for example, "//compute.googleapis.com/projects/{project-id}/global/networkEndpointGroups/{name}". - "networkIngressFirewallPolicy": "A String", # The full resource name of the network ingress firewall policy, for example, "//compute.googleapis.com/projects/{project-id}/global/firewallPolicies/{name}". - "privateIpAddress": "A String", # Private IP address of the exposed endpoint. - "privatePort": "A String", # Port number associated with private IP address. - "pscNetworkAttachment": "A String", # The full resource name of the PSC (Private Service Connect) network attachment that network interface controller is attached to, for example, "//compute.googleapis.com/projects/{project-id}/regions/{region}/networkAttachments/{name}" - "pscServiceAttachment": "A String", # The full resource name of the PSC (Private Service Connect) service attachment that the load balancer network endpoint group targets, for example, "//compute.googleapis.com/projects/{project-id}/regions/{region}/serviceAttachments/{name}" - "publicIpAddress": "A String", # Public IP address of the exposed endpoint. - "publicPort": "A String", # Public port number of the exposed endpoint. - "serviceFirewallPolicy": "A String", # The full resource name of the firewall policy of the exposed service, for example, "//compute.googleapis.com/projects/{project-id}/global/firewallPolicies/{policy-name}". - }, - "externalSystems": { # Output only. Third party SIEM/SOAR fields within SCC, contains external system information and external system finding fields. - "a_key": { # Representation of third party SIEM/SOAR fields within SCC. - "assignees": [ # References primary/secondary etc assignees in the external system. + "instanceGroup": "A String", + "internalBackendService": "A String", + "loadBalancerFirewallPolicy": "A String", + "networkEndpointGroup": "A String", + "networkIngressFirewallPolicy": "A String", + "privateIpAddress": "A String", + "privatePort": "A String", + "pscNetworkAttachment": "A String", + "pscServiceAttachment": "A String", + "publicIpAddress": "A String", + "publicPort": "A String", + "serviceFirewallPolicy": "A String", + }, + "externalSystems": { + "a_key": { + "assignees": [ "A String", ], - "caseCloseTime": "A String", # The time when the case was closed, as reported by the external system. - "caseCreateTime": "A String", # The time when the case was created, as reported by the external system. - "casePriority": "A String", # The priority of the finding's corresponding case in the external system. - "caseSla": "A String", # The SLA of the finding's corresponding case in the external system. - "caseUri": "A String", # The link to the finding's corresponding case in the external system. - "externalSystemUpdateTime": "A String", # The time when the case was last updated, as reported by the external system. - "externalUid": "A String", # The identifier that's used to track the finding's corresponding case in the external system. - "name": "A String", # Full resource name of the external system, for example: "organizations/1234/sources/5678/findings/123456/externalSystems/jira", "folders/1234/sources/5678/findings/123456/externalSystems/jira", "projects/1234/sources/5678/findings/123456/externalSystems/jira" - "status": "A String", # The most recent status of the finding's corresponding case, as reported by the external system. - "ticketInfo": { # Information about the ticket, if any, that is being used to track the resolution of the issue that is identified by this finding. # Information about the ticket, if any, that is being used to track the resolution of the issue that is identified by this finding. - "assignee": "A String", # The assignee of the ticket in the ticket system. - "description": "A String", # The description of the ticket in the ticket system. - "id": "A String", # The identifier of the ticket in the ticket system. - "status": "A String", # The latest status of the ticket, as reported by the ticket system. - "updateTime": "A String", # The time when the ticket was last updated, as reported by the ticket system. - "uri": "A String", # The link to the ticket in the ticket system. + "caseCloseTime": "A String", + "caseCreateTime": "A String", + "casePriority": "A String", + "caseSla": "A String", + "caseUri": "A String", + "externalSystemUpdateTime": "A String", + "externalUid": "A String", + "name": "A String", + "status": "A String", + "ticketInfo": { + "assignee": "A String", + "description": "A String", + "id": "A String", + "status": "A String", + "updateTime": "A String", + "uri": "A String", }, }, }, - "externalUri": "A String", # The URI that, if available, points to a web page outside of Security Command Center where additional information about the finding can be found. This field is guaranteed to be either empty or a well formed URL. - "files": [ # File associated with the finding. - { # File information about the related binary/library used by an executable, or the script used by a script interpreter - "contents": "A String", # Prefix of the file contents as a JSON-encoded string. - "diskPath": { # Path of the file in terms of underlying disk/partition identifiers. # Path of the file in terms of underlying disk/partition identifiers. - "partitionUuid": "A String", # UUID of the partition (format https://wiki.archlinux.org/title/persistent_block_device_naming#by-uuid) - "relativePath": "A String", # Relative path of the file in the partition as a JSON encoded string. Example: /home/user1/executable_file.sh + "externalUri": "A String", + "files": [ + { + "contents": "A String", + "diskPath": { + "partitionUuid": "A String", + "relativePath": "A String", }, - "fileLoadState": "A String", # The load state of the file. - "hashedSize": "A String", # The length in bytes of the file prefix that was hashed. If hashed_size == size, any hashes reported represent the entire file. - "operations": [ # Operation(s) performed on a file. - { # Operation(s) performed on a file. - "type": "A String", # The type of the operation + "fileLoadState": "A String", + "hashedSize": "A String", + "operations": [ + { + "type": "A String", }, ], - "partiallyHashed": True or False, # True when the hash covers only a prefix of the file. - "path": "A String", # Absolute path of the file as a JSON encoded string. - "sha256": "A String", # SHA256 hash of the first hashed_size bytes of the file encoded as a hex string. If hashed_size == size, sha256 represents the SHA256 hash of the entire file. - "size": "A String", # Size of the file in bytes. + "partiallyHashed": True or False, + "path": "A String", + "sha256": "A String", + "size": "A String", }, ], - "findingClass": "A String", # The class of the finding. - "groupMemberships": [ # Contains details about groups of which this finding is a member. A group is a collection of findings that are related in some way. This field cannot be updated. Its value is ignored in all update requests. - { # Contains details about groups of which this finding is a member. A group is a collection of findings that are related in some way. - "groupId": "A String", # ID of the group. - "groupType": "A String", # Type of group. + "findingClass": "A String", + "groupMemberships": [ + { + "groupId": "A String", + "groupType": "A String", }, ], - "iamBindings": [ # Represents IAM bindings associated with the finding. - { # Represents a particular IAM binding, which captures a member's role addition, removal, or state. - "action": "A String", # The action that was performed on a Binding. - "member": "A String", # A single identity requesting access for a Cloud Platform resource, for example, "foo@google.com". - "role": "A String", # Role that is assigned to "members". For example, "roles/viewer", "roles/editor", or "roles/owner". + "iamBindings": [ + { + "action": "A String", + "member": "A String", + "role": "A String", }, ], - "indicator": { # Represents what's commonly known as an _indicator of compromise_ (IoC) in computer forensics. This is an artifact observed on a network or in an operating system that, with high confidence, indicates a computer intrusion. For more information, see [Indicator of compromise](https://en.wikipedia.org/wiki/Indicator_of_compromise). # Represents what's commonly known as an *indicator of compromise* (IoC) in computer forensics. This is an artifact observed on a network or in an operating system that, with high confidence, indicates a computer intrusion. For more information, see [Indicator of compromise](https://en.wikipedia.org/wiki/Indicator_of_compromise). - "domains": [ # List of domains associated to the Finding. + "indicator": { + "domains": [ "A String", ], - "ipAddresses": [ # The list of IP addresses that are associated with the finding. + "ipAddresses": [ "A String", ], - "signatures": [ # The list of matched signatures indicating that the given process is present in the environment. - { # Indicates what signature matched this process. - "memoryHashSignature": { # A signature corresponding to memory page hashes. # Signature indicating that a binary family was matched. - "binaryFamily": "A String", # The binary family. - "detections": [ # The list of memory hash detections contributing to the binary family match. - { # Memory hash detection contributing to the binary family match. - "binary": "A String", # The name of the binary associated with the memory hash signature detection. - "percentPagesMatched": 3.14, # The percentage of memory page hashes in the signature that were matched. + "signatures": [ + { + "memoryHashSignature": { + "binaryFamily": "A String", + "detections": [ + { + "binary": "A String", + "percentPagesMatched": 3.14, }, ], }, - "signatureType": "A String", # Describes the type of resource associated with the signature. - "yaraRuleSignature": { # A signature corresponding to a YARA rule. # Signature indicating that a YARA rule was matched. - "yaraRule": "A String", # The name of the YARA rule. + "signatureType": "A String", + "yaraRuleSignature": { + "yaraRule": "A String", }, }, ], - "uris": [ # The list of URIs associated to the Findings. + "uris": [ "A String", ], }, - "ipRules": { # IP rules associated with the finding. # IP rules associated with the finding. - "allowed": { # Allowed IP rule. # Tuple with allowed rules. - "ipRules": [ # Optional. Optional list of allowed IP rules. - { # IP rule information. - "portRanges": [ # Optional. An optional list of ports to which this rule applies. This field is only applicable for the UDP or (S)TCP protocols. Each entry must be either an integer or a range including a min and max port number. - { # A port range which is inclusive of the min and max values. Values are between 0 and 2^16-1. The max can be equal / must be not smaller than the min value. If min and max are equal this indicates that it is a single port. - "max": "A String", # Maximum port value. - "min": "A String", # Minimum port value. + "ipRules": { + "allowed": { + "ipRules": [ + { + "portRanges": [ + { + "max": "A String", + "min": "A String", }, ], - "protocol": "A String", # The IP protocol this rule applies to. This value can either be one of the following well known protocol strings (TCP, UDP, ICMP, ESP, AH, IPIP, SCTP) or a string representation of the integer value. + "protocol": "A String", }, ], }, - "denied": { # Denied IP rule. # Tuple with denied rules. - "ipRules": [ # Optional. Optional list of denied IP rules. - { # IP rule information. - "portRanges": [ # Optional. An optional list of ports to which this rule applies. This field is only applicable for the UDP or (S)TCP protocols. Each entry must be either an integer or a range including a min and max port number. - { # A port range which is inclusive of the min and max values. Values are between 0 and 2^16-1. The max can be equal / must be not smaller than the min value. If min and max are equal this indicates that it is a single port. - "max": "A String", # Maximum port value. - "min": "A String", # Minimum port value. + "denied": { + "ipRules": [ + { + "portRanges": [ + { + "max": "A String", + "min": "A String", }, ], - "protocol": "A String", # The IP protocol this rule applies to. This value can either be one of the following well known protocol strings (TCP, UDP, ICMP, ESP, AH, IPIP, SCTP) or a string representation of the integer value. + "protocol": "A String", }, ], }, - "destinationIpRanges": [ # If destination IP ranges are specified, the firewall rule applies only to traffic that has a destination IP address in these ranges. These ranges must be expressed in CIDR format. Only supports IPv4. + "destinationIpRanges": [ "A String", ], - "direction": "A String", # The direction that the rule is applicable to, one of ingress or egress. - "exposedServices": [ # Name of the network protocol service, such as FTP, that is exposed by the open port. Follows the naming convention available at: https://www.iana.org/assignments/service-names-port-numbers/service-names-port-numbers.xhtml. + "direction": "A String", + "exposedServices": [ "A String", ], - "sourceIpRanges": [ # If source IP ranges are specified, the firewall rule applies only to traffic that has a source IP address in these ranges. These ranges must be expressed in CIDR format. Only supports IPv4. + "sourceIpRanges": [ "A String", ], }, - "job": { # Describes a job # Job associated with the finding. - "errorCode": 42, # Optional. If the job did not complete successfully, this field describes why. - "location": "A String", # Optional. Gives the location where the job ran, such as `US` or `europe-west1` - "name": "A String", # The fully-qualified name for a job. e.g. `projects//jobs/` - "state": "A String", # Output only. State of the job, such as `RUNNING` or `PENDING`. - }, - "kernelRootkit": { # Kernel mode rootkit signatures. # Signature of the kernel rootkit. - "name": "A String", # Rootkit name, when available. - "unexpectedCodeModification": True or False, # True if unexpected modifications of kernel code memory are present. - "unexpectedFtraceHandler": True or False, # True if `ftrace` points are present with callbacks pointing to regions that are not in the expected kernel or module code range. - "unexpectedInterruptHandler": True or False, # True if interrupt handlers that are are not in the expected kernel or module code regions are present. - "unexpectedKernelCodePages": True or False, # True if kernel code pages that are not in the expected kernel or module code regions are present. - "unexpectedKprobeHandler": True or False, # True if `kprobe` points are present with callbacks pointing to regions that are not in the expected kernel or module code range. - "unexpectedProcessesInRunqueue": True or False, # True if unexpected processes in the scheduler run queue are present. Such processes are in the run queue, but not in the process task list. - "unexpectedReadOnlyDataModification": True or False, # True if unexpected modifications of kernel read-only data memory are present. - "unexpectedSystemCallHandler": True or False, # True if system call handlers that are are not in the expected kernel or module code regions are present. - }, - "kubernetes": { # Kubernetes-related attributes. # Kubernetes resources associated with the finding. - "accessReviews": [ # Provides information on any Kubernetes access reviews (privilege checks) relevant to the finding. - { # Conveys information about a Kubernetes access review (such as one returned by a [`kubectl auth can-i`](https://kubernetes.io/docs/reference/access-authn-authz/authorization/#checking-api-access) command) that was involved in a finding. - "group": "A String", # The API group of the resource. "*" means all. - "name": "A String", # The name of the resource being requested. Empty means all. - "ns": "A String", # Namespace of the action being requested. Currently, there is no distinction between no namespace and all namespaces. Both are represented by "" (empty). - "resource": "A String", # The optional resource type requested. "*" means all. - "subresource": "A String", # The optional subresource type. - "verb": "A String", # A Kubernetes resource API verb, like get, list, watch, create, update, delete, proxy. "*" means all. - "version": "A String", # The API version of the resource. "*" means all. + "job": { + "errorCode": 42, + "location": "A String", + "name": "A String", + "state": "A String", + }, + "kernelRootkit": { + "name": "A String", + "unexpectedCodeModification": True or False, + "unexpectedFtraceHandler": True or False, + "unexpectedInterruptHandler": True or False, + "unexpectedKernelCodePages": True or False, + "unexpectedKprobeHandler": True or False, + "unexpectedProcessesInRunqueue": True or False, + "unexpectedReadOnlyDataModification": True or False, + "unexpectedSystemCallHandler": True or False, + }, + "kubernetes": { + "accessReviews": [ + { + "group": "A String", + "name": "A String", + "ns": "A String", + "resource": "A String", + "subresource": "A String", + "verb": "A String", + "version": "A String", }, ], - "bindings": [ # Provides Kubernetes role binding information for findings that involve [RoleBindings or ClusterRoleBindings](https://cloud.google.com/kubernetes-engine/docs/how-to/role-based-access-control). - { # Represents a Kubernetes RoleBinding or ClusterRoleBinding. - "name": "A String", # Name for the binding. - "ns": "A String", # Namespace for the binding. - "role": { # Kubernetes Role or ClusterRole. # The Role or ClusterRole referenced by the binding. - "kind": "A String", # Role type. - "name": "A String", # Role name. - "ns": "A String", # Role namespace. + "bindings": [ + { + "name": "A String", + "ns": "A String", + "role": { + "kind": "A String", + "name": "A String", + "ns": "A String", }, - "subjects": [ # Represents one or more subjects that are bound to the role. Not always available for PATCH requests. - { # Represents a Kubernetes subject. - "kind": "A String", # Authentication type for the subject. - "name": "A String", # Name for the subject. - "ns": "A String", # Namespace for the subject. + "subjects": [ + { + "kind": "A String", + "name": "A String", + "ns": "A String", }, ], }, ], - "nodePools": [ # GKE [node pools](https://cloud.google.com/kubernetes-engine/docs/concepts/node-pools) associated with the finding. This field contains node pool information for each node, when it is available. - { # Provides GKE node pool information. - "name": "A String", # Kubernetes node pool name. - "nodes": [ # Nodes associated with the finding. - { # Kubernetes nodes associated with the finding. - "name": "A String", # [Full resource name](https://google.aip.dev/122#full-resource-names) of the Compute Engine VM running the cluster node. + "nodePools": [ + { + "name": "A String", + "nodes": [ + { + "name": "A String", }, ], }, ], - "nodes": [ # Provides Kubernetes [node](https://cloud.google.com/kubernetes-engine/docs/concepts/cluster-architecture#nodes) information. - { # Kubernetes nodes associated with the finding. - "name": "A String", # [Full resource name](https://google.aip.dev/122#full-resource-names) of the Compute Engine VM running the cluster node. + "nodes": [ + { + "name": "A String", }, ], - "objects": [ # Kubernetes objects related to the finding. - { # Kubernetes object related to the finding, uniquely identified by GKNN. Used if the object Kind is not one of Pod, Node, NodePool, Binding, or AccessReview. - "containers": [ # Pod containers associated with this finding, if any. - { # Container associated with the finding. - "createTime": "A String", # The time that the container was created. - "imageId": "A String", # Optional container image ID, if provided by the container runtime. Uniquely identifies the container image launched using a container image digest. - "labels": [ # Container labels, as provided by the container runtime. - { # Represents a generic name-value label. A label has separate name and value fields to support filtering with the `contains()` function. For more information, see [Filtering on array-type fields](https://cloud.google.com/security-command-center/docs/how-to-api-list-findings#array-contains-filtering). - "name": "A String", # Name of the label. - "value": "A String", # Value that corresponds to the label's name. + "objects": [ + { + "containers": [ + { + "createTime": "A String", + "imageId": "A String", + "labels": [ + { + "name": "A String", + "value": "A String", }, ], - "name": "A String", # Name of the container. - "uri": "A String", # Container image URI provided when configuring a pod or container. This string can identify a container image version using mutable tags. + "name": "A String", + "uri": "A String", }, ], - "group": "A String", # Kubernetes object group, such as "policy.k8s.io/v1". - "kind": "A String", # Kubernetes object kind, such as "Namespace". - "name": "A String", # Kubernetes object name. For details see https://kubernetes.io/docs/concepts/overview/working-with-objects/names/. - "ns": "A String", # Kubernetes object namespace. Must be a valid DNS label. Named "ns" to avoid collision with C++ namespace keyword. For details see https://kubernetes.io/docs/tasks/administer-cluster/namespaces/. + "group": "A String", + "kind": "A String", + "name": "A String", + "ns": "A String", }, ], - "pods": [ # Kubernetes [Pods](https://cloud.google.com/kubernetes-engine/docs/concepts/pod) associated with the finding. This field contains Pod records for each container that is owned by a Pod. - { # A Kubernetes Pod. - "containers": [ # Pod containers associated with this finding, if any. - { # Container associated with the finding. - "createTime": "A String", # The time that the container was created. - "imageId": "A String", # Optional container image ID, if provided by the container runtime. Uniquely identifies the container image launched using a container image digest. - "labels": [ # Container labels, as provided by the container runtime. - { # Represents a generic name-value label. A label has separate name and value fields to support filtering with the `contains()` function. For more information, see [Filtering on array-type fields](https://cloud.google.com/security-command-center/docs/how-to-api-list-findings#array-contains-filtering). - "name": "A String", # Name of the label. - "value": "A String", # Value that corresponds to the label's name. + "pods": [ + { + "containers": [ + { + "createTime": "A String", + "imageId": "A String", + "labels": [ + { + "name": "A String", + "value": "A String", }, ], - "name": "A String", # Name of the container. - "uri": "A String", # Container image URI provided when configuring a pod or container. This string can identify a container image version using mutable tags. + "name": "A String", + "uri": "A String", }, ], - "labels": [ # Pod labels. For Kubernetes containers, these are applied to the container. - { # Represents a generic name-value label. A label has separate name and value fields to support filtering with the `contains()` function. For more information, see [Filtering on array-type fields](https://cloud.google.com/security-command-center/docs/how-to-api-list-findings#array-contains-filtering). - "name": "A String", # Name of the label. - "value": "A String", # Value that corresponds to the label's name. + "labels": [ + { + "name": "A String", + "value": "A String", }, ], - "name": "A String", # Kubernetes Pod name. - "ns": "A String", # Kubernetes Pod namespace. + "name": "A String", + "ns": "A String", }, ], - "roles": [ # Provides Kubernetes role information for findings that involve [Roles or ClusterRoles](https://cloud.google.com/kubernetes-engine/docs/how-to/role-based-access-control). - { # Kubernetes Role or ClusterRole. - "kind": "A String", # Role type. - "name": "A String", # Role name. - "ns": "A String", # Role namespace. + "roles": [ + { + "kind": "A String", + "name": "A String", + "ns": "A String", }, ], }, - "loadBalancers": [ # The load balancers associated with the finding. - { # Contains information related to the load balancer associated with the finding. - "name": "A String", # The name of the load balancer associated with the finding. + "loadBalancers": [ + { + "name": "A String", }, ], - "logEntries": [ # Log entries that are relevant to the finding. - { # An individual entry in a log. - "cloudLoggingEntry": { # Metadata taken from a [Cloud Logging LogEntry](https://cloud.google.com/logging/docs/reference/v2/rest/v2/LogEntry) # An individual entry in a log stored in Cloud Logging. - "insertId": "A String", # A unique identifier for the log entry. - "logId": "A String", # The type of the log (part of `log_name`. `log_name` is the resource name of the log to which this log entry belongs). For example: `cloudresourcemanager.googleapis.com/activity`. Note that this field is not URL-encoded, unlike the `LOG_ID` field in `LogEntry`. - "resourceContainer": "A String", # The organization, folder, or project of the monitored resource that produced this log entry. - "timestamp": "A String", # The time the event described by the log entry occurred. + "logEntries": [ + { + "cloudLoggingEntry": { + "insertId": "A String", + "logId": "A String", + "resourceContainer": "A String", + "timestamp": "A String", }, }, ], - "mitreAttack": { # MITRE ATT&CK tactics and techniques related to this finding. See: https://attack.mitre.org # MITRE ATT&CK tactics and techniques related to this finding. See: https://attack.mitre.org - "additionalTactics": [ # Additional MITRE ATT&CK tactics related to this finding, if any. + "mitreAttack": { + "additionalTactics": [ "A String", ], - "additionalTechniques": [ # Additional MITRE ATT&CK techniques related to this finding, if any, along with any of their respective parent techniques. + "additionalTechniques": [ "A String", ], - "primaryTactic": "A String", # The MITRE ATT&CK tactic most closely represented by this finding, if any. - "primaryTechniques": [ # The MITRE ATT&CK technique most closely represented by this finding, if any. primary_techniques is a repeated field because there are multiple levels of MITRE ATT&CK techniques. If the technique most closely represented by this finding is a sub-technique (e.g. `SCANNING_IP_BLOCKS`), both the sub-technique and its parent technique(s) will be listed (e.g. `SCANNING_IP_BLOCKS`, `ACTIVE_SCANNING`). + "primaryTactic": "A String", + "primaryTechniques": [ "A String", ], - "version": "A String", # The MITRE ATT&CK version referenced by the above fields. E.g. "8". + "version": "A String", }, - "moduleName": "A String", # Unique identifier of the module which generated the finding. Example: folders/598186756061/securityHealthAnalyticsSettings/customModules/56799441161885 - "mute": "A String", # Indicates the mute state of a finding (either muted, unmuted or undefined). Unlike other attributes of a finding, a finding provider shouldn't set the value of mute. - "muteInfo": { # Mute information about the finding, including whether the finding has a static mute or any matching dynamic mute rules. # Output only. The mute information regarding this finding. - "dynamicMuteRecords": [ # The list of dynamic mute rules that currently match the finding. - { # The record of a dynamic mute rule that matches the finding. - "matchTime": "A String", # When the dynamic mute rule first matched the finding. - "muteConfig": "A String", # The relative resource name of the mute rule, represented by a mute config, that created this record, for example `organizations/123/muteConfigs/mymuteconfig` or `organizations/123/locations/global/muteConfigs/mymuteconfig`. + "moduleName": "A String", + "mute": "A String", + "muteInfo": { + "dynamicMuteRecords": [ + { + "matchTime": "A String", + "muteConfig": "A String", }, ], - "staticMute": { # Information about the static mute state. A static mute state overrides any dynamic mute rules that apply to this finding. The static mute state can be set by a static mute rule or by muting the finding directly. # If set, the static mute applied to this finding. Static mutes override dynamic mutes. If unset, there is no static mute. - "applyTime": "A String", # When the static mute was applied. - "state": "A String", # The static mute state. If the value is `MUTED` or `UNMUTED`, then the finding's overall mute state will have the same value. + "staticMute": { + "applyTime": "A String", + "state": "A String", }, }, - "muteInitiator": "A String", # Records additional information about the mute operation, for example, the [mute configuration](/security-command-center/docs/how-to-mute-findings) that muted the finding and the user who muted the finding. - "muteUpdateTime": "A String", # Output only. The most recent time this finding was muted or unmuted. - "name": "A String", # The [relative resource name](https://cloud.google.com/apis/design/resource_names#relative_resource_name) of the finding. Example: "organizations/{organization_id}/sources/{source_id}/findings/{finding_id}", "folders/{folder_id}/sources/{source_id}/findings/{finding_id}", "projects/{project_id}/sources/{source_id}/findings/{finding_id}". - "networks": [ # Represents the VPC networks that the resource is attached to. - { # Contains information about a VPC network associated with the finding. - "name": "A String", # The name of the VPC network resource, for example, `//compute.googleapis.com/projects/my-project/global/networks/my-network`. + "muteInitiator": "A String", + "muteUpdateTime": "A String", + "name": "A String", + "networks": [ + { + "name": "A String", }, ], - "nextSteps": "A String", # Steps to address the finding. - "notebook": { # Represents a Jupyter notebook IPYNB file, such as a [Colab Enterprise notebook](https://cloud.google.com/colab/docs/introduction) file, that is associated with a finding. # Notebook associated with the finding. - "lastAuthor": "A String", # The user ID of the latest author to modify the notebook. - "name": "A String", # The name of the notebook. - "notebookUpdateTime": "A String", # The most recent time the notebook was updated. - "service": "A String", # The source notebook service, for example, "Colab Enterprise". + "nextSteps": "A String", + "notebook": { + "lastAuthor": "A String", + "name": "A String", + "notebookUpdateTime": "A String", + "service": "A String", }, - "orgPolicies": [ # Contains information about the org policies associated with the finding. - { # Contains information about the org policies associated with the finding. - "name": "A String", # The resource name of the org policy. Example: "organizations/{organization_id}/policies/{constraint_name}" + "orgPolicies": [ + { + "name": "A String", }, ], - "parent": "A String", # The relative resource name of the source the finding belongs to. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name This field is immutable after creation time. For example: "organizations/{organization_id}/sources/{source_id}" - "parentDisplayName": "A String", # Output only. The human readable display name of the finding source such as "Event Threat Detection" or "Security Health Analytics". - "policyViolationSummary": { # Metadata summarizing policy violations of child resources of the affected resource. `finding_category` and `resource` determine the exact semantics of the counts. For example, when category=DATA_SECURITY_POSTURE_OBJECT_PUBLIC_ACCESS_VIOLATION and resource='storage.googleapis.com/buckets/my-bucket-name' then this counts the number of Cloud Storage objects in my-bucket-name which violate a Public Access control. # PolicyViolationSummary associated with the finding. - "conformantResourcesCount": "A String", # Total number of child resources that conform to the policy. - "evaluationErrorsCount": "A String", # Number of child resources for which errors during evaluation occurred. The evaluation result for these child resources is effectively "unknown". - "outOfScopeResourcesCount": "A String", # Total count of child resources which were not in scope for evaluation. - "policyViolationsCount": "A String", # Count of child resources in violation of the policy. - }, - "processes": [ # Represents operating system processes associated with the Finding. - { # Represents an operating system process. - "args": [ # Process arguments as JSON encoded strings. + "parent": "A String", + "parentDisplayName": "A String", + "policyViolationSummary": { + "conformantResourcesCount": "A String", + "evaluationErrorsCount": "A String", + "outOfScopeResourcesCount": "A String", + "policyViolationsCount": "A String", + }, + "processes": [ + { + "args": [ "A String", ], - "argumentsTruncated": True or False, # True if `args` is incomplete. - "binary": { # File information about the related binary/library used by an executable, or the script used by a script interpreter # File information for the process executable. - "contents": "A String", # Prefix of the file contents as a JSON-encoded string. - "diskPath": { # Path of the file in terms of underlying disk/partition identifiers. # Path of the file in terms of underlying disk/partition identifiers. - "partitionUuid": "A String", # UUID of the partition (format https://wiki.archlinux.org/title/persistent_block_device_naming#by-uuid) - "relativePath": "A String", # Relative path of the file in the partition as a JSON encoded string. Example: /home/user1/executable_file.sh + "argumentsTruncated": True or False, + "binary": { + "contents": "A String", + "diskPath": { + "partitionUuid": "A String", + "relativePath": "A String", }, - "fileLoadState": "A String", # The load state of the file. - "hashedSize": "A String", # The length in bytes of the file prefix that was hashed. If hashed_size == size, any hashes reported represent the entire file. - "operations": [ # Operation(s) performed on a file. - { # Operation(s) performed on a file. - "type": "A String", # The type of the operation + "fileLoadState": "A String", + "hashedSize": "A String", + "operations": [ + { + "type": "A String", }, ], - "partiallyHashed": True or False, # True when the hash covers only a prefix of the file. - "path": "A String", # Absolute path of the file as a JSON encoded string. - "sha256": "A String", # SHA256 hash of the first hashed_size bytes of the file encoded as a hex string. If hashed_size == size, sha256 represents the SHA256 hash of the entire file. - "size": "A String", # Size of the file in bytes. + "partiallyHashed": True or False, + "path": "A String", + "sha256": "A String", + "size": "A String", }, - "envVariables": [ # Process environment variables. - { # A name-value pair representing an environment variable used in an operating system process. - "name": "A String", # Environment variable name as a JSON encoded string. - "val": "A String", # Environment variable value as a JSON encoded string. + "envVariables": [ + { + "name": "A String", + "val": "A String", }, ], - "envVariablesTruncated": True or False, # True if `env_variables` is incomplete. - "libraries": [ # File information for libraries loaded by the process. - { # File information about the related binary/library used by an executable, or the script used by a script interpreter - "contents": "A String", # Prefix of the file contents as a JSON-encoded string. - "diskPath": { # Path of the file in terms of underlying disk/partition identifiers. # Path of the file in terms of underlying disk/partition identifiers. - "partitionUuid": "A String", # UUID of the partition (format https://wiki.archlinux.org/title/persistent_block_device_naming#by-uuid) - "relativePath": "A String", # Relative path of the file in the partition as a JSON encoded string. Example: /home/user1/executable_file.sh + "envVariablesTruncated": True or False, + "libraries": [ + { + "contents": "A String", + "diskPath": { + "partitionUuid": "A String", + "relativePath": "A String", }, - "fileLoadState": "A String", # The load state of the file. - "hashedSize": "A String", # The length in bytes of the file prefix that was hashed. If hashed_size == size, any hashes reported represent the entire file. - "operations": [ # Operation(s) performed on a file. - { # Operation(s) performed on a file. - "type": "A String", # The type of the operation + "fileLoadState": "A String", + "hashedSize": "A String", + "operations": [ + { + "type": "A String", }, ], - "partiallyHashed": True or False, # True when the hash covers only a prefix of the file. - "path": "A String", # Absolute path of the file as a JSON encoded string. - "sha256": "A String", # SHA256 hash of the first hashed_size bytes of the file encoded as a hex string. If hashed_size == size, sha256 represents the SHA256 hash of the entire file. - "size": "A String", # Size of the file in bytes. + "partiallyHashed": True or False, + "path": "A String", + "sha256": "A String", + "size": "A String", }, ], - "name": "A String", # The process name, as displayed in utilities like `top` and `ps`. This name can be accessed through `/proc/[pid]/comm` and changed with `prctl(PR_SET_NAME)`. - "parentPid": "A String", # The parent process ID. - "pid": "A String", # The process ID. - "script": { # File information about the related binary/library used by an executable, or the script used by a script interpreter # When the process represents the invocation of a script, `binary` provides information about the interpreter, while `script` provides information about the script file provided to the interpreter. - "contents": "A String", # Prefix of the file contents as a JSON-encoded string. - "diskPath": { # Path of the file in terms of underlying disk/partition identifiers. # Path of the file in terms of underlying disk/partition identifiers. - "partitionUuid": "A String", # UUID of the partition (format https://wiki.archlinux.org/title/persistent_block_device_naming#by-uuid) - "relativePath": "A String", # Relative path of the file in the partition as a JSON encoded string. Example: /home/user1/executable_file.sh + "name": "A String", + "parentPid": "A String", + "pid": "A String", + "script": { + "contents": "A String", + "diskPath": { + "partitionUuid": "A String", + "relativePath": "A String", }, - "fileLoadState": "A String", # The load state of the file. - "hashedSize": "A String", # The length in bytes of the file prefix that was hashed. If hashed_size == size, any hashes reported represent the entire file. - "operations": [ # Operation(s) performed on a file. - { # Operation(s) performed on a file. - "type": "A String", # The type of the operation + "fileLoadState": "A String", + "hashedSize": "A String", + "operations": [ + { + "type": "A String", }, ], - "partiallyHashed": True or False, # True when the hash covers only a prefix of the file. - "path": "A String", # Absolute path of the file as a JSON encoded string. - "sha256": "A String", # SHA256 hash of the first hashed_size bytes of the file encoded as a hex string. If hashed_size == size, sha256 represents the SHA256 hash of the entire file. - "size": "A String", # Size of the file in bytes. + "partiallyHashed": True or False, + "path": "A String", + "sha256": "A String", + "size": "A String", }, - "userId": "A String", # The ID of the user that executed the process. E.g. If this is the root user this will always be 0. + "userId": "A String", }, ], - "resourceName": "A String", # For findings on Google Cloud resources, the full resource name of the Google Cloud resource this finding is for. See: https://cloud.google.com/apis/design/resource_names#full_resource_name When the finding is for a non-Google Cloud resource, the resourceName can be a customer or partner defined string. This field is immutable after creation time. - "secret": { # Details about a secret or credential associated with the finding. # Secret associated with the finding. - "environmentVariable": { # Environment variable containing the secret. # The environment variable containing the secret. - "key": "A String", # Environment variable name as a JSON encoded string. Note that value is not included since the value contains the secret data, which is sensitive core content. + "resourceName": "A String", + "secret": { + "environmentVariable": { + "key": "A String", }, - "filePath": { # File path containing the secret. # The file containing the secret. - "path": "A String", # Path to the file. + "filePath": { + "path": "A String", }, - "status": { # The status of the secret. # The status of the secret. - "lastUpdatedTime": "A String", # Time that the secret was found. - "validity": "A String", # The validity of the secret. + "status": { + "lastUpdatedTime": "A String", + "validity": "A String", }, - "type": "A String", # The type of secret, for example, GCP_API_KEY. + "type": "A String", }, - "securityMarks": { # User specified security marks that are attached to the parent Security Command Center resource. Security marks are scoped within a Security Command Center organization -- they can be modified and viewed by all users who have proper permissions on the organization. # Output only. User specified security marks. These marks are entirely managed by the user and come from the SecurityMarks resource that belongs to the finding. - "canonicalName": "A String", # The canonical name of the marks. Examples: "organizations/{organization_id}/assets/{asset_id}/securityMarks" "folders/{folder_id}/assets/{asset_id}/securityMarks" "projects/{project_number}/assets/{asset_id}/securityMarks" "organizations/{organization_id}/sources/{source_id}/findings/{finding_id}/securityMarks" "folders/{folder_id}/sources/{source_id}/findings/{finding_id}/securityMarks" "projects/{project_number}/sources/{source_id}/findings/{finding_id}/securityMarks" - "marks": { # Mutable user specified security marks belonging to the parent resource. Constraints are as follows: * Keys and values are treated as case insensitive * Keys must be between 1 - 256 characters (inclusive) * Keys must be letters, numbers, underscores, or dashes * Values have leading and trailing whitespace trimmed, remaining characters must be between 1 - 4096 characters (inclusive) + "securityMarks": { + "canonicalName": "A String", + "marks": { "a_key": "A String", }, - "name": "A String", # The relative resource name of the SecurityMarks. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Examples: "organizations/{organization_id}/assets/{asset_id}/securityMarks" "organizations/{organization_id}/sources/{source_id}/findings/{finding_id}/securityMarks". - }, - "securityPosture": { # Represents a posture that is deployed on Google Cloud by the Security Command Center Posture Management service. A posture contains one or more policy sets. A policy set is a group of policies that enforce a set of security rules on Google Cloud. # The security posture associated with the finding. - "changedPolicy": "A String", # The name of the updated policy, for example, `projects/{project_id}/policies/{constraint_name}`. - "name": "A String", # Name of the posture, for example, `CIS-Posture`. - "policy": "A String", # The ID of the updated policy, for example, `compute-policy-1`. - "policyDriftDetails": [ # The details about a change in an updated policy that violates the deployed posture. - { # The policy field that violates the deployed posture and its expected and detected values. - "detectedValue": "A String", # The detected value that violates the deployed posture, for example, `false` or `allowed_values={"projects/22831892"}`. - "expectedValue": "A String", # The value of this field that was configured in a posture, for example, `true` or `allowed_values={"projects/29831892"}`. - "field": "A String", # The name of the updated field, for example constraint.implementation.policy_rules[0].enforce + "name": "A String", + }, + "securityPosture": { + "changedPolicy": "A String", + "name": "A String", + "policy": "A String", + "policyDriftDetails": [ + { + "detectedValue": "A String", + "expectedValue": "A String", + "field": "A String", }, ], - "policySet": "A String", # The name of the updated policyset, for example, `cis-policyset`. - "postureDeployment": "A String", # The name of the posture deployment, for example, `organizations/{org_id}/posturedeployments/{posture_deployment_id}`. - "postureDeploymentResource": "A String", # The project, folder, or organization on which the posture is deployed, for example, `projects/{project_number}`. - "revisionId": "A String", # The version of the posture, for example, `c7cfa2a8`. + "policySet": "A String", + "postureDeployment": "A String", + "postureDeploymentResource": "A String", + "revisionId": "A String", }, - "severity": "A String", # The severity of the finding. This field is managed by the source that writes the finding. - "sourceProperties": { # Source specific properties. These properties are managed by the source that writes the finding. The key names in the source_properties map must be between 1 and 255 characters, and must start with a letter and contain alphanumeric characters or underscores only. + "severity": "A String", + "sourceProperties": { "a_key": "", }, - "state": "A String", # The state of the finding. - "toxicCombination": { # Contains details about a group of security issues that, when the issues occur together, represent a greater risk than when the issues occur independently. A group of such issues is referred to as a toxic combination. # Contains details about a group of security issues that, when the issues occur together, represent a greater risk than when the issues occur independently. A group of such issues is referred to as a toxic combination. This field cannot be updated. Its value is ignored in all update requests. - "attackExposureScore": 3.14, # The [Attack exposure score](https://cloud.google.com/security-command-center/docs/attack-exposure-learn#attack_exposure_scores) of this toxic combination. The score is a measure of how much this toxic combination exposes one or more high-value resources to potential attack. - "relatedFindings": [ # List of resource names of findings associated with this toxic combination. For example, `organizations/123/sources/456/findings/789`. + "state": "A String", + "toxicCombination": { + "attackExposureScore": 3.14, + "relatedFindings": [ "A String", ], }, - "vertexAi": { # Vertex AI-related information associated with the finding. # VertexAi associated with the finding. - "datasets": [ # Datasets associated with the finding. - { # Vertex AI dataset associated with the finding. - "displayName": "A String", # The user defined display name of dataset, e.g. plants-dataset - "name": "A String", # Resource name of the dataset, e.g. projects/{project}/locations/{location}/datasets/2094040236064505856 - "source": "A String", # Data source, such as BigQuery source URI, e.g. bq://scc-nexus-test.AIPPtest.gsod + "vertexAi": { + "datasets": [ + { + "displayName": "A String", + "name": "A String", + "source": "A String", }, ], - "pipelines": [ # Pipelines associated with the finding. - { # Vertex AI training pipeline associated with the finding. - "displayName": "A String", # The user defined display name of pipeline, e.g. plants-classification - "name": "A String", # Resource name of the pipeline, e.g. projects/{project}/locations/{location}/trainingPipelines/5253428229225578496 + "pipelines": [ + { + "displayName": "A String", + "name": "A String", }, ], }, - "vulnerability": { # Refers to common vulnerability fields e.g. cve, cvss, cwe etc. # Represents vulnerability-specific fields like CVE and CVSS scores. CVE stands for Common Vulnerabilities and Exposures (https://cve.mitre.org/about/) - "cve": { # CVE stands for Common Vulnerabilities and Exposures. Information from the [CVE record](https://www.cve.org/ResourcesSupport/Glossary) that describes this vulnerability. # CVE stands for Common Vulnerabilities and Exposures (https://cve.mitre.org/about/) - "cvssv3": { # Common Vulnerability Scoring System version 3. # Describe Common Vulnerability Scoring System specified at https://www.first.org/cvss/v3.1/specification-document - "attackComplexity": "A String", # This metric describes the conditions beyond the attacker's control that must exist in order to exploit the vulnerability. - "attackVector": "A String", # Base Metrics Represents the intrinsic characteristics of a vulnerability that are constant over time and across user environments. This metric reflects the context by which vulnerability exploitation is possible. - "availabilityImpact": "A String", # This metric measures the impact to the availability of the impacted component resulting from a successfully exploited vulnerability. - "baseScore": 3.14, # The base score is a function of the base metric scores. - "confidentialityImpact": "A String", # This metric measures the impact to the confidentiality of the information resources managed by a software component due to a successfully exploited vulnerability. - "integrityImpact": "A String", # This metric measures the impact to integrity of a successfully exploited vulnerability. - "privilegesRequired": "A String", # This metric describes the level of privileges an attacker must possess before successfully exploiting the vulnerability. - "scope": "A String", # The Scope metric captures whether a vulnerability in one vulnerable component impacts resources in components beyond its security scope. - "userInteraction": "A String", # This metric captures the requirement for a human user, other than the attacker, to participate in the successful compromise of the vulnerable component. + "vulnerability": { + "cve": { + "cvssv3": { + "attackComplexity": "A String", + "attackVector": "A String", + "availabilityImpact": "A String", + "baseScore": 3.14, + "confidentialityImpact": "A String", + "integrityImpact": "A String", + "privilegesRequired": "A String", + "scope": "A String", + "userInteraction": "A String", }, - "exploitReleaseDate": "A String", # Date the first publicly available exploit or PoC was released. - "exploitationActivity": "A String", # The exploitation activity of the vulnerability in the wild. - "firstExploitationDate": "A String", # Date of the earliest known exploitation. - "id": "A String", # The unique identifier for the vulnerability. e.g. CVE-2021-34527 - "impact": "A String", # The potential impact of the vulnerability if it was to be exploited. - "observedInTheWild": True or False, # Whether or not the vulnerability has been observed in the wild. - "references": [ # Additional information about the CVE. e.g. https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2021-34527 - { # Additional Links - "source": "A String", # Source of the reference e.g. NVD - "uri": "A String", # Uri for the mentioned source e.g. https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2021-34527. + "exploitReleaseDate": "A String", + "exploitationActivity": "A String", + "firstExploitationDate": "A String", + "id": "A String", + "impact": "A String", + "observedInTheWild": True or False, + "references": [ + { + "source": "A String", + "uri": "A String", }, ], - "upstreamFixAvailable": True or False, # Whether upstream fix is available for the CVE. - "zeroDay": True or False, # Whether or not the vulnerability was zero day when the finding was published. - }, - "cwes": [ # Represents one or more Common Weakness Enumeration (CWE) information on this vulnerability. - { # CWE stands for Common Weakness Enumeration. Information about this weakness, as described by [CWE](https://cwe.mitre.org/). - "id": "A String", # The CWE identifier, e.g. CWE-94 - "references": [ # Any reference to the details on the CWE, for example, https://cwe.mitre.org/data/definitions/94.html - { # Additional Links - "source": "A String", # Source of the reference e.g. NVD - "uri": "A String", # Uri for the mentioned source e.g. https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2021-34527. + "upstreamFixAvailable": True or False, + "zeroDay": True or False, + }, + "cwes": [ + { + "id": "A String", + "references": [ + { + "source": "A String", + "uri": "A String", }, ], }, ], - "fixedPackage": { # Package is a generic definition of a package. # The fixed package is relevant to the finding. - "cpeUri": "A String", # The CPE URI where the vulnerability was detected. - "packageName": "A String", # The name of the package where the vulnerability was detected. - "packageType": "A String", # Type of package, for example, os, maven, or go. - "packageVersion": "A String", # The version of the package. + "fixedPackage": { + "cpeUri": "A String", + "packageName": "A String", + "packageType": "A String", + "packageVersion": "A String", }, - "offendingPackage": { # Package is a generic definition of a package. # The offending package is relevant to the finding. - "cpeUri": "A String", # The CPE URI where the vulnerability was detected. - "packageName": "A String", # The name of the package where the vulnerability was detected. - "packageType": "A String", # Type of package, for example, os, maven, or go. - "packageVersion": "A String", # The version of the package. + "offendingPackage": { + "cpeUri": "A String", + "packageName": "A String", + "packageType": "A String", + "packageVersion": "A String", }, - "providerRiskScore": "A String", # Provider provided risk_score based on multiple factors. The higher the risk score, the more risky the vulnerability is. - "reachable": True or False, # Represents whether the vulnerability is reachable (detected via static analysis) - "securityBulletin": { # SecurityBulletin are notifications of vulnerabilities of Google products. # The security bulletin is relevant to this finding. - "bulletinId": "A String", # ID of the bulletin corresponding to the vulnerability. - "submissionTime": "A String", # Submission time of this Security Bulletin. - "suggestedUpgradeVersion": "A String", # This represents a version that the cluster receiving this notification should be upgraded to, based on its current version. For example, 1.15.0 + "providerRiskScore": "A String", + "reachable": True or False, + "securityBulletin": { + "bulletinId": "A String", + "submissionTime": "A String", + "suggestedUpgradeVersion": "A String", }, }, }
@@ -2783,15 +2783,15 @@

Method Details

setMute(name, body=None, x__xgafv=None) -
Updates the mute state of a finding.
+  
 
 Args:
-  name: string, Required. The [relative resource name](https://cloud.google.com/apis/design/resource_names#relative_resource_name) of the finding. Example: `organizations/{organization_id}/sources/{source_id}/findings/{finding_id}`, `folders/{folder_id}/sources/{source_id}/findings/{finding_id}`, `projects/{project_id}/sources/{source_id}/findings/{finding_id}`. (required)
+  name: string, A parameter (required)
   body: object, The request body.
     The object takes the form of:
 
-{ # Request message for updating a finding's mute status.
-  "mute": "A String", # Required. The desired state of the Mute.
+{
+  "mute": "A String",
 }
 
   x__xgafv: string, V1 error format.
@@ -2802,811 +2802,811 @@ 

Method Details

Returns: An object of the form: - { # Security Command Center finding. A finding is a record of assessment data like security, risk, health, or privacy, that is ingested into Security Command Center for presentation, notification, analysis, policy testing, and enforcement. For example, a cross-site scripting (XSS) vulnerability in an App Engine application is a finding. - "access": { # Represents an access event. # Access details associated with the finding, such as more information on the caller, which method was accessed, and from where. - "callerIp": "A String", # Caller's IP address, such as "1.1.1.1". - "callerIpGeo": { # Represents a geographical location for a given access. # The caller IP's geolocation, which identifies where the call came from. - "regionCode": "A String", # A CLDR. - }, - "methodName": "A String", # The method that the service account called, e.g. "SetIamPolicy". - "principalEmail": "A String", # Associated email, such as "foo@google.com". The email address of the authenticated user or a service account acting on behalf of a 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). - "principalSubject": "A String", # A string that represents the principal_subject that is associated with the identity. Unlike `principal_email`, `principal_subject` supports principals that aren't associated with email addresses, such as third party principals. For most identities, the format is `principal://iam.googleapis.com/{identity pool name}/subject/{subject}`. Some GKE identities, such as GKE_WORKLOAD, FREEFORM, and GKE_HUB_WORKLOAD, still use the legacy format `serviceAccount:{identity pool name}[{subject}]`. - "serviceAccountDelegationInfo": [ # The identity delegation history of an authenticated service account that made the request. The `serviceAccountDelegationInfo[]` object contains information about the real authorities that try to access Google Cloud resources by delegating on a service account. When multiple authorities are present, they are guaranteed to be sorted based on the original ordering of the identity delegation events. - { # Identity delegation history of an authenticated service account. - "principalEmail": "A String", # The email address of a Google account. - "principalSubject": "A String", # A string representing the principal_subject associated with the identity. As compared to `principal_email`, supports principals that aren't associated with email addresses, such as third party principals. For most identities, the format will be `principal://iam.googleapis.com/{identity pool name}/subjects/{subject}` except for some GKE identities (GKE_WORKLOAD, FREEFORM, GKE_HUB_WORKLOAD) that are still in the legacy format `serviceAccount:{identity pool name}[{subject}]` + { + "access": { + "callerIp": "A String", + "callerIpGeo": { + "regionCode": "A String", + }, + "methodName": "A String", + "principalEmail": "A String", + "principalSubject": "A String", + "serviceAccountDelegationInfo": [ + { + "principalEmail": "A String", + "principalSubject": "A String", }, ], - "serviceAccountKeyName": "A String", # The name of the service account key that was used to create or exchange credentials when authenticating the service account that made the request. This is a scheme-less URI full resource name. For example: "//iam.googleapis.com/projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}/keys/{key}". - "serviceName": "A String", # This is the API service that the service account made a call to, e.g. "iam.googleapis.com" - "userAgent": "A String", # The caller's user agent string associated with the finding. - "userAgentFamily": "A String", # Type of user agent associated with the finding. For example, an operating system shell or an embedded or standalone application. - "userName": "A String", # A string that represents a username. The username provided depends on the type of the finding and is likely not an IAM principal. For example, this can be a system username if the finding is related to a virtual machine, or it can be an application login username. + "serviceAccountKeyName": "A String", + "serviceName": "A String", + "userAgent": "A String", + "userAgentFamily": "A String", + "userName": "A String", }, - "affectedResources": { # Details about resources affected by this finding. # AffectedResources associated with the finding. - "count": "A String", # The count of resources affected by the finding. + "affectedResources": { + "count": "A String", }, - "agentDataAccessEvents": [ # Agent data access events associated with the finding. - { # Details about a data access attempt made by an agent principal not authorized under applicable data security policy. - "eventId": "A String", # Unique identifier for data access event. - "eventTime": "A String", # Timestamp of data access event. - "operation": "A String", # The operation performed by the principal to access the data. - "principalSubject": "A String", # The agent principal that accessed the data. + "agentDataAccessEvents": [ + { + "eventId": "A String", + "eventTime": "A String", + "operation": "A String", + "principalSubject": "A String", }, ], - "aiModel": { # Contains information about the AI model associated with the finding. # The AI model associated with the finding. - "deploymentPlatform": "A String", # The platform on which the model is deployed. - "displayName": "A String", # The user defined display name of model. Ex. baseline-classification-model - "domain": "A String", # The domain of the model, for example, “image-classification”. - "library": "A String", # The name of the model library, for example, “transformers”. - "location": "A String", # The region in which the model is used, for example, “us-central1”. - "name": "A String", # The name of the AI model, for example, "gemini:1.0.0". - "publisher": "A String", # The publisher of the model, for example, “google” or “nvidia”. - "usageCategory": "A String", # The purpose of the model, for example, "Inteference" or "Training". - }, - "application": { # Represents an application associated with a finding. # Represents an application associated with the finding. - "baseUri": "A String", # The base URI that identifies the network location of the application in which the vulnerability was detected. For example, `http://example.com`. - "fullUri": "A String", # The full URI with payload that can be used to reproduce the vulnerability. For example, `http://example.com?p=aMmYgI6H`. - }, - "artifactGuardPolicies": { # Represents the result of evaluating artifact guard policies. # ArtifactGuardPolicies associated with the finding. - "failingPolicies": [ # A list of failing policies. - { # Represents an artifact guard policy. - "failureReason": "A String", # The reason for the policy failure, for example, "severity=HIGH AND max_vuln_count=2". - "policyId": "A String", # The ID of the failing policy, for example, "organizations/3392779/locations/global/policies/prod-policy". - "type": "A String", # The type of the policy evaluation. + "aiModel": { + "deploymentPlatform": "A String", + "displayName": "A String", + "domain": "A String", + "library": "A String", + "location": "A String", + "name": "A String", + "publisher": "A String", + "usageCategory": "A String", + }, + "application": { + "baseUri": "A String", + "fullUri": "A String", + }, + "artifactGuardPolicies": { + "failingPolicies": [ + { + "failureReason": "A String", + "policyId": "A String", + "type": "A String", }, ], - "resourceId": "A String", # The ID of the resource that has policies configured for it. + "resourceId": "A String", }, - "attackExposure": { # An attack exposure contains the results of an attack path simulation run. # The results of an attack path simulation relevant to this finding. - "attackExposureResult": "A String", # The resource name of the attack path simulation result that contains the details regarding this attack exposure score. Example: `organizations/123/simulations/456/attackExposureResults/789` - "exposedHighValueResourcesCount": 42, # The number of high value resources that are exposed as a result of this finding. - "exposedLowValueResourcesCount": 42, # The number of high value resources that are exposed as a result of this finding. - "exposedMediumValueResourcesCount": 42, # The number of medium value resources that are exposed as a result of this finding. - "latestCalculationTime": "A String", # The most recent time the attack exposure was updated on this finding. - "score": 3.14, # A number between 0 (inclusive) and infinity that represents how important this finding is to remediate. The higher the score, the more important it is to remediate. - "state": "A String", # What state this AttackExposure is in. This captures whether or not an attack exposure has been calculated or not. + "attackExposure": { + "attackExposureResult": "A String", + "exposedHighValueResourcesCount": 42, + "exposedLowValueResourcesCount": 42, + "exposedMediumValueResourcesCount": 42, + "latestCalculationTime": "A String", + "score": 3.14, + "state": "A String", }, - "backupDisasterRecovery": { # Information related to Google Cloud Backup and DR Service findings. # Fields related to Backup and DR findings. - "appliance": "A String", # The name of the Backup and DR appliance that captures, moves, and manages the lifecycle of backup data. For example, `backup-server-57137`. - "applications": [ # The names of Backup and DR applications. An application is a VM, database, or file system on a managed host monitored by a backup and recovery appliance. For example, `centos7-01-vol00`, `centos7-01-vol01`, `centos7-01-vol02`. + "backupDisasterRecovery": { + "appliance": "A String", + "applications": [ "A String", ], - "backupCreateTime": "A String", # The timestamp at which the Backup and DR backup was created. - "backupTemplate": "A String", # The name of a Backup and DR template which comprises one or more backup policies. See the [Backup and DR documentation](https://cloud.google.com/backup-disaster-recovery/docs/concepts/backup-plan#temp) for more information. For example, `snap-ov`. - "backupType": "A String", # The backup type of the Backup and DR image. For example, `Snapshot`, `Remote Snapshot`, `OnVault`. - "host": "A String", # The name of a Backup and DR host, which is managed by the backup and recovery appliance and known to the management console. The host can be of type Generic (for example, Compute Engine, SQL Server, Oracle DB, SMB file system, etc.), vCenter, or an ESX server. See the [Backup and DR documentation on hosts](https://cloud.google.com/backup-disaster-recovery/docs/configuration/manage-hosts-and-their-applications) for more information. For example, `centos7-01`. - "policies": [ # The names of Backup and DR policies that are associated with a template and that define when to run a backup, how frequently to run a backup, and how long to retain the backup image. For example, `onvaults`. + "backupCreateTime": "A String", + "backupTemplate": "A String", + "backupType": "A String", + "host": "A String", + "policies": [ "A String", ], - "policyOptions": [ # The names of Backup and DR advanced policy options of a policy applying to an application. See the [Backup and DR documentation on policy options](https://cloud.google.com/backup-disaster-recovery/docs/create-plan/policy-settings). For example, `skipofflineappsincongrp, nounmap`. + "policyOptions": [ "A String", ], - "profile": "A String", # The name of the Backup and DR resource profile that specifies the storage media for backups of application and VM data. See the [Backup and DR documentation on profiles](https://cloud.google.com/backup-disaster-recovery/docs/concepts/backup-plan#profile). For example, `GCP`. - "storagePool": "A String", # The name of the Backup and DR storage pool that the backup and recovery appliance is storing data in. The storage pool could be of type Cloud, Primary, Snapshot, or OnVault. See the [Backup and DR documentation on storage pools](https://cloud.google.com/backup-disaster-recovery/docs/concepts/storage-pools). For example, `DiskPoolOne`. + "profile": "A String", + "storagePool": "A String", }, - "canonicalName": "A String", # The canonical name of the finding. It's either "organizations/{organization_id}/sources/{source_id}/findings/{finding_id}", "folders/{folder_id}/sources/{source_id}/findings/{finding_id}" or "projects/{project_number}/sources/{source_id}/findings/{finding_id}", depending on the closest CRM ancestor of the resource associated with the finding. - "category": "A String", # The additional taxonomy group within findings from a given source. This field is immutable after creation time. Example: "XSS_FLASH_INJECTION" - "chokepoint": { # Contains details about a chokepoint, which is a resource or resource group where high-risk attack paths converge, based on [attack path simulations] (https://cloud.google.com/security-command-center/docs/attack-exposure-learn#attack_path_simulations). # Contains details about a chokepoint, which is a resource or resource group where high-risk attack paths converge, based on [attack path simulations] (https://cloud.google.com/security-command-center/docs/attack-exposure-learn#attack_path_simulations). This field cannot be updated. Its value is ignored in all update requests. - "relatedFindings": [ # List of resource names of findings associated with this chokepoint. For example, organizations/123/sources/456/findings/789. This list will have at most 100 findings. + "canonicalName": "A String", + "category": "A String", + "chokepoint": { + "relatedFindings": [ "A String", ], }, - "cloudArmor": { # Fields related to Google Cloud Armor findings. # Fields related to Cloud Armor findings. - "adaptiveProtection": { # Information about [Google Cloud Armor Adaptive Protection](https://cloud.google.com/armor/docs/cloud-armor-overview#google-cloud-armor-adaptive-protection). # Information about potential Layer 7 DDoS attacks identified by [Google Cloud Armor Adaptive Protection](https://cloud.google.com/armor/docs/adaptive-protection-overview). - "confidence": 3.14, # A score of 0 means that there is low confidence that the detected event is an actual attack. A score of 1 means that there is high confidence that the detected event is an attack. See the [Adaptive Protection documentation](https://cloud.google.com/armor/docs/adaptive-protection-overview#configure-alert-tuning) for further explanation. - }, - "attack": { # Information about DDoS attack volume and classification. # Information about DDoS attack volume and classification. - "classification": "A String", # Type of attack, for example, 'SYN-flood', 'NTP-udp', or 'CHARGEN-udp'. - "volumeBps": 42, # Total BPS (bytes per second) volume of attack. Deprecated - refer to volume_bps_long instead. - "volumeBpsLong": "A String", # Total BPS (bytes per second) volume of attack. - "volumePps": 42, # Total PPS (packets per second) volume of attack. Deprecated - refer to volume_pps_long instead. - "volumePpsLong": "A String", # Total PPS (packets per second) volume of attack. - }, - "duration": "A String", # Duration of attack from the start until the current moment (updated every 5 minutes). - "requests": { # Information about the requests relevant to the finding. # Information about incoming requests evaluated by [Google Cloud Armor security policies](https://cloud.google.com/armor/docs/security-policy-overview). - "longTermAllowed": 42, # Allowed RPS (requests per second) over the long term. - "longTermDenied": 42, # Denied RPS (requests per second) over the long term. - "ratio": 3.14, # For 'Increasing deny ratio', the ratio is the denied traffic divided by the allowed traffic. For 'Allowed traffic spike', the ratio is the allowed traffic in the short term divided by allowed traffic in the long term. - "shortTermAllowed": 42, # Allowed RPS (requests per second) in the short term. - }, - "securityPolicy": { # Information about the [Google Cloud Armor security policy](https://cloud.google.com/armor/docs/security-policy-overview) relevant to the finding. # Information about the [Google Cloud Armor security policy](https://cloud.google.com/armor/docs/security-policy-overview) relevant to the finding. - "name": "A String", # The name of the Google Cloud Armor security policy, for example, "my-security-policy". - "preview": True or False, # Whether or not the associated rule or policy is in preview mode. - "type": "A String", # The type of Google Cloud Armor security policy for example, 'backend security policy', 'edge security policy', 'network edge security policy', or 'always-on DDoS protection'. - }, - "threatVector": "A String", # Distinguish between volumetric & protocol DDoS attack and application layer attacks. For example, "L3_4" for Layer 3 and Layer 4 DDoS attacks, or "L_7" for Layer 7 DDoS attacks. - }, - "cloudDlpDataProfile": { # The [data profile](https://cloud.google.com/dlp/docs/data-profiles) associated with the finding. # Cloud DLP data profile that is associated with the finding. - "dataProfile": "A String", # Name of the data profile, for example, `projects/123/locations/europe/tableProfiles/8383929`. - "infoTypes": [ # Type of information detected by SDP. Info type includes name, version and sensitivity of the detected information type. - { # Type of information detected by the API. - "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. - "sensitivityScore": { # Score is calculated from of all elements in the data profile. A higher level means the data is more sensitive. # Optional custom sensitivity for this InfoType. This only applies to data profiling. - "score": "A String", # The sensitivity score applied to the resource. + "cloudArmor": { + "adaptiveProtection": { + "confidence": 3.14, + }, + "attack": { + "classification": "A String", + "volumeBps": 42, + "volumeBpsLong": "A String", + "volumePps": 42, + "volumePpsLong": "A String", + }, + "duration": "A String", + "requests": { + "longTermAllowed": 42, + "longTermDenied": 42, + "ratio": 3.14, + "shortTermAllowed": 42, + }, + "securityPolicy": { + "name": "A String", + "preview": True or False, + "type": "A String", + }, + "threatVector": "A String", + }, + "cloudDlpDataProfile": { + "dataProfile": "A String", + "infoTypes": [ + { + "name": "A String", + "sensitivityScore": { + "score": "A String", }, - "version": "A String", # Optional version name for this InfoType. + "version": "A String", }, ], - "parentType": "A String", # The resource hierarchy level at which the data profile was generated. + "parentType": "A String", }, - "cloudDlpInspection": { # Details about the Cloud Data Loss Prevention (Cloud DLP) [inspection job](https://cloud.google.com/dlp/docs/concepts-job-triggers) that produced the finding. # Cloud Data Loss Prevention (Cloud DLP) inspection results that are associated with the finding. - "fullScan": True or False, # Whether Cloud DLP scanned the complete resource or a sampled subset. - "infoType": "A String", # The type of information (or *[infoType](https://cloud.google.com/dlp/docs/infotypes-reference)*) found, for example, `EMAIL_ADDRESS` or `STREET_ADDRESS`. - "infoTypeCount": "A String", # The number of times Cloud DLP found this infoType within this job and resource. - "inspectJob": "A String", # Name of the inspection job, for example, `projects/123/locations/europe/dlpJobs/i-8383929`. + "cloudDlpInspection": { + "fullScan": True or False, + "infoType": "A String", + "infoTypeCount": "A String", + "inspectJob": "A String", }, - "complianceDetails": { # Compliance Details associated with the finding. # Details about the compliance implications of the finding. - "cloudControl": { # CloudControl associated with the finding. # CloudControl associated with the finding - "cloudControlName": "A String", # Name of the CloudControl associated with the finding. - "policyType": "A String", # Policy type of the CloudControl - "type": "A String", # Type of cloud control. - "version": 42, # Version of the Cloud Control + "complianceDetails": { + "cloudControl": { + "cloudControlName": "A String", + "policyType": "A String", + "type": "A String", + "version": 42, }, - "cloudControlDeploymentNames": [ # Cloud Control Deployments associated with the finding. For example, organizations/123/locations/global/cloudControlDeployments/deploymentIdentifier + "cloudControlDeploymentNames": [ "A String", ], - "frameworks": [ # Details of Frameworks associated with the finding - { # Compliance framework associated with the finding. - "category": [ # Category of the framework associated with the finding. E.g. Security Benchmark, or Assured Workloads + "frameworks": [ + { + "category": [ "A String", ], - "controls": [ # The controls associated with the framework. - { # Compliance control associated with the finding. - "controlName": "A String", # Name of the Control - "displayName": "A String", # Display name of the control. For example, AU-02. + "controls": [ + { + "controlName": "A String", + "displayName": "A String", }, ], - "displayName": "A String", # Display name of the framework. For a standard framework, this will look like e.g. PCI DSS 3.2.1, whereas for a custom framework it can be a user defined string like MyFramework - "name": "A String", # Name of the framework associated with the finding - "type": "A String", # Type of the framework associated with the finding, to specify whether the framework is built-in (pre-defined and immutable) or a custom framework defined by the customer (equivalent to security posture) + "displayName": "A String", + "name": "A String", + "type": "A String", }, ], }, - "compliances": [ # Contains compliance information for security standards associated to the finding. - { # Contains compliance information about a security standard indicating unmet recommendations. - "ids": [ # Policies within the standard or benchmark, for example, A.12.4.1 + "compliances": [ + { + "ids": [ "A String", ], - "standard": "A String", # Industry-wide compliance standards or benchmarks, such as CIS, PCI, and OWASP. - "version": "A String", # Version of the standard or benchmark, for example, 1.1 + "standard": "A String", + "version": "A String", }, ], - "connections": [ # Contains information about the IP connection associated with the finding. - { # Contains information about the IP connection associated with the finding. - "destinationIp": "A String", # Destination IP address. Not present for sockets that are listening and not connected. - "destinationPort": 42, # Destination port. Not present for sockets that are listening and not connected. - "protocol": "A String", # IANA Internet Protocol Number such as TCP(6) and UDP(17). - "sourceIp": "A String", # Source IP address. - "sourcePort": 42, # Source port. + "connections": [ + { + "destinationIp": "A String", + "destinationPort": 42, + "protocol": "A String", + "sourceIp": "A String", + "sourcePort": 42, }, ], - "contacts": { # Output only. Map containing the points of contact for the given finding. The key represents the type of contact, while the value contains a list of all the contacts that pertain. Please refer to: https://cloud.google.com/resource-manager/docs/managing-notification-contacts#notification-categories { "security": { "contacts": [ { "email": "person1@company.com" }, { "email": "person2@company.com" } ] } } - "a_key": { # Details about specific contacts - "contacts": [ # A list of contacts - { # The email address of a contact. - "email": "A String", # An email address. For example, "`person123@company.com`". + "contacts": { + "a_key": { + "contacts": [ + { + "email": "A String", }, ], }, }, - "containers": [ # Containers associated with the finding. This field provides information for both Kubernetes and non-Kubernetes containers. - { # Container associated with the finding. - "createTime": "A String", # The time that the container was created. - "imageId": "A String", # Optional container image ID, if provided by the container runtime. Uniquely identifies the container image launched using a container image digest. - "labels": [ # Container labels, as provided by the container runtime. - { # Represents a generic name-value label. A label has separate name and value fields to support filtering with the `contains()` function. For more information, see [Filtering on array-type fields](https://cloud.google.com/security-command-center/docs/how-to-api-list-findings#array-contains-filtering). - "name": "A String", # Name of the label. - "value": "A String", # Value that corresponds to the label's name. + "containers": [ + { + "createTime": "A String", + "imageId": "A String", + "labels": [ + { + "name": "A String", + "value": "A String", }, ], - "name": "A String", # Name of the container. - "uri": "A String", # Container image URI provided when configuring a pod or container. This string can identify a container image version using mutable tags. + "name": "A String", + "uri": "A String", }, ], - "createTime": "A String", # The time at which the finding was created in Security Command Center. - "dataAccessEvents": [ # Data access events associated with the finding. - { # Details about a data access attempt made by a principal not authorized under applicable data security policy. - "eventId": "A String", # Unique identifier for data access event. - "eventTime": "A String", # Timestamp of data access event. - "operation": "A String", # The operation performed by the principal to access the data. - "principalEmail": "A String", # The email address of the principal that accessed the data. The principal could be a user account, service account, Google group, or other. + "createTime": "A String", + "dataAccessEvents": [ + { + "eventId": "A String", + "eventTime": "A String", + "operation": "A String", + "principalEmail": "A String", }, ], - "dataFlowEvents": [ # Data flow events associated with the finding. - { # Details about a data flow event, in which either the data is moved to or is accessed from a non-compliant geo-location, as defined in the applicable data security policy. - "eventId": "A String", # Unique identifier for data flow event. - "eventTime": "A String", # Timestamp of data flow event. - "operation": "A String", # The operation performed by the principal for the data flow event. - "principalEmail": "A String", # The email address of the principal that initiated the data flow event. The principal could be a user account, service account, Google group, or other. - "violatedLocation": "A String", # Non-compliant location of the principal or the data destination. + "dataFlowEvents": [ + { + "eventId": "A String", + "eventTime": "A String", + "operation": "A String", + "principalEmail": "A String", + "violatedLocation": "A String", }, ], - "dataRetentionDeletionEvents": [ # Data retention deletion events associated with the finding. - { # Details about data retention deletion violations, in which the data is non-compliant based on their retention or deletion time, as defined in the applicable data security policy. The Data Retention Deletion (DRD) control is a control of the DSPM (Data Security Posture Management) suite that enables organizations to manage data retention and deletion policies in compliance with regulations, such as GDPR and CRPA. DRD supports two primary policy types: maximum storage length (max TTL) and minimum storage length (min TTL). Both are aimed at helping organizations meet regulatory and data management commitments. - "dataObjectCount": "A String", # Number of objects that violated the policy for this resource. If the number is less than 1,000, then the value of this field is the exact number. If the number of objects that violated the policy is greater than or equal to 1,000, then the value of this field is 1000. - "eventDetectionTime": "A String", # Timestamp indicating when the event was detected. - "eventType": "A String", # Type of the DRD event. - "maxRetentionAllowed": "A String", # Maximum duration of retention allowed from the DRD control. This comes from the DRD control where users set a max TTL for their data. For example, suppose that a user sets the max TTL for a Cloud Storage bucket to 90 days. However, an object in that bucket is 100 days old. In this case, a DataRetentionDeletionEvent will be generated for that Cloud Storage bucket, and the max_retention_allowed is 90 days. - "minRetentionAllowed": "A String", # Min duration of retention allowed from the DSPM retention control. This field is only populated when event type is set to EVENT_TYPE_MIN_TTL_FROM_CREATION. + "dataRetentionDeletionEvents": [ + { + "dataObjectCount": "A String", + "eventDetectionTime": "A String", + "eventType": "A String", + "maxRetentionAllowed": "A String", + "minRetentionAllowed": "A String", }, ], - "database": { # Represents database access information, such as queries. A database may be a sub-resource of an instance (as in the case of Cloud SQL instances or Cloud Spanner instances), or the database instance itself. Some database resources might not have the [full resource name](https://google.aip.dev/122#full-resource-names) populated because these resource types, such as Cloud SQL databases, are not yet supported by Cloud Asset Inventory. In these cases only the display name is provided. # Database associated with the finding. - "displayName": "A String", # The human-readable name of the database that the user connected to. - "grantees": [ # The target usernames, roles, or groups of an SQL privilege grant, which is not an IAM policy change. + "database": { + "displayName": "A String", + "grantees": [ "A String", ], - "name": "A String", # Some database resources may not have the [full resource name](https://google.aip.dev/122#full-resource-names) populated because these resource types are not yet supported by Cloud Asset Inventory (e.g. Cloud SQL databases). In these cases only the display name will be provided. The [full resource name](https://google.aip.dev/122#full-resource-names) of the database that the user connected to, if it is supported by Cloud Asset Inventory. - "query": "A String", # The SQL statement that is associated with the database access. - "userName": "A String", # The username used to connect to the database. The username might not be an IAM principal and does not have a set format. - "version": "A String", # The version of the database, for example, POSTGRES_14. See [the complete list](https://cloud.google.com/sql/docs/mysql/admin-api/rest/v1/SqlDatabaseVersion). - }, - "description": "A String", # Contains more details about the finding. - "discoveredWorkload": { # Represents discovered, customer managed workload that is not registered with the respective GCP service. # DiscoveredWorkload associated with the finding. - "confidence": "A String", # The confidence in detection of this workload. - "detectedRelevantHardware": True or False, # A boolean flag set to true if associated hardware strongly predicts the workload type. - "detectedRelevantKeywords": True or False, # A boolean flag set to true if associated keywords strongly predict the workload type. - "detectedRelevantPackages": True or False, # A boolean flag set to true if installed packages strongly predict the workload type. - "workloadType": "A String", # The type of workload. - }, - "disk": { # Contains information about the disk associated with the finding. # Disk associated with the finding. - "name": "A String", # The name of the disk, for example, "https://www.googleapis.com/compute/v1/projects/{project-id}/zones/{zone-id}/disks/{disk-id}". - }, - "eventTime": "A String", # The time the finding was first detected. If an existing finding is updated, then this is the time the update occurred. For example, if the finding represents an open firewall, this property captures the time the detector believes the firewall became open. The accuracy is determined by the detector. If the finding is later resolved, then this time reflects when the finding was resolved. This must not be set to a value greater than the current timestamp. - "exfiltration": { # Exfiltration represents a data exfiltration attempt from one or more sources to one or more targets. The `sources` attribute lists the sources of the exfiltrated data. The `targets` attribute lists the destinations the data was copied to. # Represents exfiltrations associated with the finding. - "sources": [ # If there are multiple sources, then the data is considered "joined" between them. For instance, BigQuery can join multiple tables, and each table would be considered a source. - { # Resource where data was exfiltrated from or exfiltrated to. - "components": [ # Subcomponents of the asset that was exfiltrated, like URIs used during exfiltration, table names, databases, and filenames. For example, multiple tables might have been exfiltrated from the same Cloud SQL instance, or multiple files might have been exfiltrated from the same Cloud Storage bucket. + "name": "A String", + "query": "A String", + "userName": "A String", + "version": "A String", + }, + "description": "A String", + "discoveredWorkload": { + "confidence": "A String", + "detectedRelevantHardware": True or False, + "detectedRelevantKeywords": True or False, + "detectedRelevantPackages": True or False, + "workloadType": "A String", + }, + "disk": { + "name": "A String", + }, + "eventTime": "A String", + "exfiltration": { + "sources": [ + { + "components": [ "A String", ], - "name": "A String", # The resource's [full resource name](https://cloud.google.com/apis/design/resource_names#full_resource_name). + "name": "A String", }, ], - "targets": [ # If there are multiple targets, each target would get a complete copy of the "joined" source data. - { # Resource where data was exfiltrated from or exfiltrated to. - "components": [ # Subcomponents of the asset that was exfiltrated, like URIs used during exfiltration, table names, databases, and filenames. For example, multiple tables might have been exfiltrated from the same Cloud SQL instance, or multiple files might have been exfiltrated from the same Cloud Storage bucket. + "targets": [ + { + "components": [ "A String", ], - "name": "A String", # The resource's [full resource name](https://cloud.google.com/apis/design/resource_names#full_resource_name). + "name": "A String", }, ], - "totalExfiltratedBytes": "A String", # Total exfiltrated bytes processed for the entire job. - }, - "externalExposure": { # Details about the externally exposed resource associated with the finding. # External exposure associated with the finding. - "backendBucket": "A String", # The full resource name of the load balancer backend bucket, for example, "//compute.googleapis.com/projects/{project-id}/global/backendBuckets/{name}" - "backendService": "A String", # The full resource name of load balancer backend service, for example, "//compute.googleapis.com/projects/{project-id}/global/backendServices/{name}". - "exposedApplication": "A String", # The name and version of the exposed web application, for example, "Jenkins 2.184". - "exposedEndpoint": "A String", # The resource which is running the exposed service, for example, "//compute.googleapis.com/projects/{project-id}/zones/{zone}/instances/{instance}.” - "exposedService": "A String", # The name and version of the service, for example, "Jupyter Notebook 6.14.0". - "forwardingRule": "A String", # The full resource name of the forwarding rule, for example, "//compute.googleapis.com/projects/{project-id}/global/forwardingRules/{forwarding-rule-name}". - "hostnameUri": "A String", # Hostname of the exposed application, for example, "https://test-app.a.run.app/" - "httpResponse": [ # The http response returned by the web application. - { # The http response returned by the web application. - "path": "A String", # The http path for which response code was returned by web application, for example, "https://test-app.a.run.app/test". - "statusCode": "A String", # The http response code returned by the web application, for example, 200. + "totalExfiltratedBytes": "A String", + }, + "externalExposure": { + "backendBucket": "A String", + "backendService": "A String", + "exposedApplication": "A String", + "exposedEndpoint": "A String", + "exposedService": "A String", + "forwardingRule": "A String", + "hostnameUri": "A String", + "httpResponse": [ + { + "path": "A String", + "statusCode": "A String", }, ], - "instanceGroup": "A String", # The full resource name of the instance group, for example, "//compute.googleapis.com/projects/{project-id}/global/instanceGroups/{name}". - "internalBackendService": "A String", # The full resource name of load balancer backend service in the internal project having resource exposed via PSC, for example, "//compute.googleapis.com/projects/{project-id}/global/backendServices/{name}". - "loadBalancerFirewallPolicy": "A String", # The full resource name of the load balancer firewall policy, for example, "//compute.googleapis.com/projects/{project-id}/global/firewallPolicies/{policy-name}". - "networkEndpointGroup": "A String", # The full resource name of the network endpoint group, for example, "//compute.googleapis.com/projects/{project-id}/global/networkEndpointGroups/{name}". - "networkIngressFirewallPolicy": "A String", # The full resource name of the network ingress firewall policy, for example, "//compute.googleapis.com/projects/{project-id}/global/firewallPolicies/{name}". - "privateIpAddress": "A String", # Private IP address of the exposed endpoint. - "privatePort": "A String", # Port number associated with private IP address. - "pscNetworkAttachment": "A String", # The full resource name of the PSC (Private Service Connect) network attachment that network interface controller is attached to, for example, "//compute.googleapis.com/projects/{project-id}/regions/{region}/networkAttachments/{name}" - "pscServiceAttachment": "A String", # The full resource name of the PSC (Private Service Connect) service attachment that the load balancer network endpoint group targets, for example, "//compute.googleapis.com/projects/{project-id}/regions/{region}/serviceAttachments/{name}" - "publicIpAddress": "A String", # Public IP address of the exposed endpoint. - "publicPort": "A String", # Public port number of the exposed endpoint. - "serviceFirewallPolicy": "A String", # The full resource name of the firewall policy of the exposed service, for example, "//compute.googleapis.com/projects/{project-id}/global/firewallPolicies/{policy-name}". - }, - "externalSystems": { # Output only. Third party SIEM/SOAR fields within SCC, contains external system information and external system finding fields. - "a_key": { # Representation of third party SIEM/SOAR fields within SCC. - "assignees": [ # References primary/secondary etc assignees in the external system. + "instanceGroup": "A String", + "internalBackendService": "A String", + "loadBalancerFirewallPolicy": "A String", + "networkEndpointGroup": "A String", + "networkIngressFirewallPolicy": "A String", + "privateIpAddress": "A String", + "privatePort": "A String", + "pscNetworkAttachment": "A String", + "pscServiceAttachment": "A String", + "publicIpAddress": "A String", + "publicPort": "A String", + "serviceFirewallPolicy": "A String", + }, + "externalSystems": { + "a_key": { + "assignees": [ "A String", ], - "caseCloseTime": "A String", # The time when the case was closed, as reported by the external system. - "caseCreateTime": "A String", # The time when the case was created, as reported by the external system. - "casePriority": "A String", # The priority of the finding's corresponding case in the external system. - "caseSla": "A String", # The SLA of the finding's corresponding case in the external system. - "caseUri": "A String", # The link to the finding's corresponding case in the external system. - "externalSystemUpdateTime": "A String", # The time when the case was last updated, as reported by the external system. - "externalUid": "A String", # The identifier that's used to track the finding's corresponding case in the external system. - "name": "A String", # Full resource name of the external system, for example: "organizations/1234/sources/5678/findings/123456/externalSystems/jira", "folders/1234/sources/5678/findings/123456/externalSystems/jira", "projects/1234/sources/5678/findings/123456/externalSystems/jira" - "status": "A String", # The most recent status of the finding's corresponding case, as reported by the external system. - "ticketInfo": { # Information about the ticket, if any, that is being used to track the resolution of the issue that is identified by this finding. # Information about the ticket, if any, that is being used to track the resolution of the issue that is identified by this finding. - "assignee": "A String", # The assignee of the ticket in the ticket system. - "description": "A String", # The description of the ticket in the ticket system. - "id": "A String", # The identifier of the ticket in the ticket system. - "status": "A String", # The latest status of the ticket, as reported by the ticket system. - "updateTime": "A String", # The time when the ticket was last updated, as reported by the ticket system. - "uri": "A String", # The link to the ticket in the ticket system. + "caseCloseTime": "A String", + "caseCreateTime": "A String", + "casePriority": "A String", + "caseSla": "A String", + "caseUri": "A String", + "externalSystemUpdateTime": "A String", + "externalUid": "A String", + "name": "A String", + "status": "A String", + "ticketInfo": { + "assignee": "A String", + "description": "A String", + "id": "A String", + "status": "A String", + "updateTime": "A String", + "uri": "A String", }, }, }, - "externalUri": "A String", # The URI that, if available, points to a web page outside of Security Command Center where additional information about the finding can be found. This field is guaranteed to be either empty or a well formed URL. - "files": [ # File associated with the finding. - { # File information about the related binary/library used by an executable, or the script used by a script interpreter - "contents": "A String", # Prefix of the file contents as a JSON-encoded string. - "diskPath": { # Path of the file in terms of underlying disk/partition identifiers. # Path of the file in terms of underlying disk/partition identifiers. - "partitionUuid": "A String", # UUID of the partition (format https://wiki.archlinux.org/title/persistent_block_device_naming#by-uuid) - "relativePath": "A String", # Relative path of the file in the partition as a JSON encoded string. Example: /home/user1/executable_file.sh + "externalUri": "A String", + "files": [ + { + "contents": "A String", + "diskPath": { + "partitionUuid": "A String", + "relativePath": "A String", }, - "fileLoadState": "A String", # The load state of the file. - "hashedSize": "A String", # The length in bytes of the file prefix that was hashed. If hashed_size == size, any hashes reported represent the entire file. - "operations": [ # Operation(s) performed on a file. - { # Operation(s) performed on a file. - "type": "A String", # The type of the operation + "fileLoadState": "A String", + "hashedSize": "A String", + "operations": [ + { + "type": "A String", }, ], - "partiallyHashed": True or False, # True when the hash covers only a prefix of the file. - "path": "A String", # Absolute path of the file as a JSON encoded string. - "sha256": "A String", # SHA256 hash of the first hashed_size bytes of the file encoded as a hex string. If hashed_size == size, sha256 represents the SHA256 hash of the entire file. - "size": "A String", # Size of the file in bytes. + "partiallyHashed": True or False, + "path": "A String", + "sha256": "A String", + "size": "A String", }, ], - "findingClass": "A String", # The class of the finding. - "groupMemberships": [ # Contains details about groups of which this finding is a member. A group is a collection of findings that are related in some way. This field cannot be updated. Its value is ignored in all update requests. - { # Contains details about groups of which this finding is a member. A group is a collection of findings that are related in some way. - "groupId": "A String", # ID of the group. - "groupType": "A String", # Type of group. + "findingClass": "A String", + "groupMemberships": [ + { + "groupId": "A String", + "groupType": "A String", }, ], - "iamBindings": [ # Represents IAM bindings associated with the finding. - { # Represents a particular IAM binding, which captures a member's role addition, removal, or state. - "action": "A String", # The action that was performed on a Binding. - "member": "A String", # A single identity requesting access for a Cloud Platform resource, for example, "foo@google.com". - "role": "A String", # Role that is assigned to "members". For example, "roles/viewer", "roles/editor", or "roles/owner". + "iamBindings": [ + { + "action": "A String", + "member": "A String", + "role": "A String", }, ], - "indicator": { # Represents what's commonly known as an _indicator of compromise_ (IoC) in computer forensics. This is an artifact observed on a network or in an operating system that, with high confidence, indicates a computer intrusion. For more information, see [Indicator of compromise](https://en.wikipedia.org/wiki/Indicator_of_compromise). # Represents what's commonly known as an *indicator of compromise* (IoC) in computer forensics. This is an artifact observed on a network or in an operating system that, with high confidence, indicates a computer intrusion. For more information, see [Indicator of compromise](https://en.wikipedia.org/wiki/Indicator_of_compromise). - "domains": [ # List of domains associated to the Finding. + "indicator": { + "domains": [ "A String", ], - "ipAddresses": [ # The list of IP addresses that are associated with the finding. + "ipAddresses": [ "A String", ], - "signatures": [ # The list of matched signatures indicating that the given process is present in the environment. - { # Indicates what signature matched this process. - "memoryHashSignature": { # A signature corresponding to memory page hashes. # Signature indicating that a binary family was matched. - "binaryFamily": "A String", # The binary family. - "detections": [ # The list of memory hash detections contributing to the binary family match. - { # Memory hash detection contributing to the binary family match. - "binary": "A String", # The name of the binary associated with the memory hash signature detection. - "percentPagesMatched": 3.14, # The percentage of memory page hashes in the signature that were matched. + "signatures": [ + { + "memoryHashSignature": { + "binaryFamily": "A String", + "detections": [ + { + "binary": "A String", + "percentPagesMatched": 3.14, }, ], }, - "signatureType": "A String", # Describes the type of resource associated with the signature. - "yaraRuleSignature": { # A signature corresponding to a YARA rule. # Signature indicating that a YARA rule was matched. - "yaraRule": "A String", # The name of the YARA rule. + "signatureType": "A String", + "yaraRuleSignature": { + "yaraRule": "A String", }, }, ], - "uris": [ # The list of URIs associated to the Findings. + "uris": [ "A String", ], }, - "ipRules": { # IP rules associated with the finding. # IP rules associated with the finding. - "allowed": { # Allowed IP rule. # Tuple with allowed rules. - "ipRules": [ # Optional. Optional list of allowed IP rules. - { # IP rule information. - "portRanges": [ # Optional. An optional list of ports to which this rule applies. This field is only applicable for the UDP or (S)TCP protocols. Each entry must be either an integer or a range including a min and max port number. - { # A port range which is inclusive of the min and max values. Values are between 0 and 2^16-1. The max can be equal / must be not smaller than the min value. If min and max are equal this indicates that it is a single port. - "max": "A String", # Maximum port value. - "min": "A String", # Minimum port value. + "ipRules": { + "allowed": { + "ipRules": [ + { + "portRanges": [ + { + "max": "A String", + "min": "A String", }, ], - "protocol": "A String", # The IP protocol this rule applies to. This value can either be one of the following well known protocol strings (TCP, UDP, ICMP, ESP, AH, IPIP, SCTP) or a string representation of the integer value. + "protocol": "A String", }, ], }, - "denied": { # Denied IP rule. # Tuple with denied rules. - "ipRules": [ # Optional. Optional list of denied IP rules. - { # IP rule information. - "portRanges": [ # Optional. An optional list of ports to which this rule applies. This field is only applicable for the UDP or (S)TCP protocols. Each entry must be either an integer or a range including a min and max port number. - { # A port range which is inclusive of the min and max values. Values are between 0 and 2^16-1. The max can be equal / must be not smaller than the min value. If min and max are equal this indicates that it is a single port. - "max": "A String", # Maximum port value. - "min": "A String", # Minimum port value. + "denied": { + "ipRules": [ + { + "portRanges": [ + { + "max": "A String", + "min": "A String", }, ], - "protocol": "A String", # The IP protocol this rule applies to. This value can either be one of the following well known protocol strings (TCP, UDP, ICMP, ESP, AH, IPIP, SCTP) or a string representation of the integer value. + "protocol": "A String", }, ], }, - "destinationIpRanges": [ # If destination IP ranges are specified, the firewall rule applies only to traffic that has a destination IP address in these ranges. These ranges must be expressed in CIDR format. Only supports IPv4. + "destinationIpRanges": [ "A String", ], - "direction": "A String", # The direction that the rule is applicable to, one of ingress or egress. - "exposedServices": [ # Name of the network protocol service, such as FTP, that is exposed by the open port. Follows the naming convention available at: https://www.iana.org/assignments/service-names-port-numbers/service-names-port-numbers.xhtml. + "direction": "A String", + "exposedServices": [ "A String", ], - "sourceIpRanges": [ # If source IP ranges are specified, the firewall rule applies only to traffic that has a source IP address in these ranges. These ranges must be expressed in CIDR format. Only supports IPv4. + "sourceIpRanges": [ "A String", ], }, - "job": { # Describes a job # Job associated with the finding. - "errorCode": 42, # Optional. If the job did not complete successfully, this field describes why. - "location": "A String", # Optional. Gives the location where the job ran, such as `US` or `europe-west1` - "name": "A String", # The fully-qualified name for a job. e.g. `projects//jobs/` - "state": "A String", # Output only. State of the job, such as `RUNNING` or `PENDING`. - }, - "kernelRootkit": { # Kernel mode rootkit signatures. # Signature of the kernel rootkit. - "name": "A String", # Rootkit name, when available. - "unexpectedCodeModification": True or False, # True if unexpected modifications of kernel code memory are present. - "unexpectedFtraceHandler": True or False, # True if `ftrace` points are present with callbacks pointing to regions that are not in the expected kernel or module code range. - "unexpectedInterruptHandler": True or False, # True if interrupt handlers that are are not in the expected kernel or module code regions are present. - "unexpectedKernelCodePages": True or False, # True if kernel code pages that are not in the expected kernel or module code regions are present. - "unexpectedKprobeHandler": True or False, # True if `kprobe` points are present with callbacks pointing to regions that are not in the expected kernel or module code range. - "unexpectedProcessesInRunqueue": True or False, # True if unexpected processes in the scheduler run queue are present. Such processes are in the run queue, but not in the process task list. - "unexpectedReadOnlyDataModification": True or False, # True if unexpected modifications of kernel read-only data memory are present. - "unexpectedSystemCallHandler": True or False, # True if system call handlers that are are not in the expected kernel or module code regions are present. - }, - "kubernetes": { # Kubernetes-related attributes. # Kubernetes resources associated with the finding. - "accessReviews": [ # Provides information on any Kubernetes access reviews (privilege checks) relevant to the finding. - { # Conveys information about a Kubernetes access review (such as one returned by a [`kubectl auth can-i`](https://kubernetes.io/docs/reference/access-authn-authz/authorization/#checking-api-access) command) that was involved in a finding. - "group": "A String", # The API group of the resource. "*" means all. - "name": "A String", # The name of the resource being requested. Empty means all. - "ns": "A String", # Namespace of the action being requested. Currently, there is no distinction between no namespace and all namespaces. Both are represented by "" (empty). - "resource": "A String", # The optional resource type requested. "*" means all. - "subresource": "A String", # The optional subresource type. - "verb": "A String", # A Kubernetes resource API verb, like get, list, watch, create, update, delete, proxy. "*" means all. - "version": "A String", # The API version of the resource. "*" means all. + "job": { + "errorCode": 42, + "location": "A String", + "name": "A String", + "state": "A String", + }, + "kernelRootkit": { + "name": "A String", + "unexpectedCodeModification": True or False, + "unexpectedFtraceHandler": True or False, + "unexpectedInterruptHandler": True or False, + "unexpectedKernelCodePages": True or False, + "unexpectedKprobeHandler": True or False, + "unexpectedProcessesInRunqueue": True or False, + "unexpectedReadOnlyDataModification": True or False, + "unexpectedSystemCallHandler": True or False, + }, + "kubernetes": { + "accessReviews": [ + { + "group": "A String", + "name": "A String", + "ns": "A String", + "resource": "A String", + "subresource": "A String", + "verb": "A String", + "version": "A String", }, ], - "bindings": [ # Provides Kubernetes role binding information for findings that involve [RoleBindings or ClusterRoleBindings](https://cloud.google.com/kubernetes-engine/docs/how-to/role-based-access-control). - { # Represents a Kubernetes RoleBinding or ClusterRoleBinding. - "name": "A String", # Name for the binding. - "ns": "A String", # Namespace for the binding. - "role": { # Kubernetes Role or ClusterRole. # The Role or ClusterRole referenced by the binding. - "kind": "A String", # Role type. - "name": "A String", # Role name. - "ns": "A String", # Role namespace. + "bindings": [ + { + "name": "A String", + "ns": "A String", + "role": { + "kind": "A String", + "name": "A String", + "ns": "A String", }, - "subjects": [ # Represents one or more subjects that are bound to the role. Not always available for PATCH requests. - { # Represents a Kubernetes subject. - "kind": "A String", # Authentication type for the subject. - "name": "A String", # Name for the subject. - "ns": "A String", # Namespace for the subject. + "subjects": [ + { + "kind": "A String", + "name": "A String", + "ns": "A String", }, ], }, ], - "nodePools": [ # GKE [node pools](https://cloud.google.com/kubernetes-engine/docs/concepts/node-pools) associated with the finding. This field contains node pool information for each node, when it is available. - { # Provides GKE node pool information. - "name": "A String", # Kubernetes node pool name. - "nodes": [ # Nodes associated with the finding. - { # Kubernetes nodes associated with the finding. - "name": "A String", # [Full resource name](https://google.aip.dev/122#full-resource-names) of the Compute Engine VM running the cluster node. + "nodePools": [ + { + "name": "A String", + "nodes": [ + { + "name": "A String", }, ], }, ], - "nodes": [ # Provides Kubernetes [node](https://cloud.google.com/kubernetes-engine/docs/concepts/cluster-architecture#nodes) information. - { # Kubernetes nodes associated with the finding. - "name": "A String", # [Full resource name](https://google.aip.dev/122#full-resource-names) of the Compute Engine VM running the cluster node. + "nodes": [ + { + "name": "A String", }, ], - "objects": [ # Kubernetes objects related to the finding. - { # Kubernetes object related to the finding, uniquely identified by GKNN. Used if the object Kind is not one of Pod, Node, NodePool, Binding, or AccessReview. - "containers": [ # Pod containers associated with this finding, if any. - { # Container associated with the finding. - "createTime": "A String", # The time that the container was created. - "imageId": "A String", # Optional container image ID, if provided by the container runtime. Uniquely identifies the container image launched using a container image digest. - "labels": [ # Container labels, as provided by the container runtime. - { # Represents a generic name-value label. A label has separate name and value fields to support filtering with the `contains()` function. For more information, see [Filtering on array-type fields](https://cloud.google.com/security-command-center/docs/how-to-api-list-findings#array-contains-filtering). - "name": "A String", # Name of the label. - "value": "A String", # Value that corresponds to the label's name. + "objects": [ + { + "containers": [ + { + "createTime": "A String", + "imageId": "A String", + "labels": [ + { + "name": "A String", + "value": "A String", }, ], - "name": "A String", # Name of the container. - "uri": "A String", # Container image URI provided when configuring a pod or container. This string can identify a container image version using mutable tags. + "name": "A String", + "uri": "A String", }, ], - "group": "A String", # Kubernetes object group, such as "policy.k8s.io/v1". - "kind": "A String", # Kubernetes object kind, such as "Namespace". - "name": "A String", # Kubernetes object name. For details see https://kubernetes.io/docs/concepts/overview/working-with-objects/names/. - "ns": "A String", # Kubernetes object namespace. Must be a valid DNS label. Named "ns" to avoid collision with C++ namespace keyword. For details see https://kubernetes.io/docs/tasks/administer-cluster/namespaces/. + "group": "A String", + "kind": "A String", + "name": "A String", + "ns": "A String", }, ], - "pods": [ # Kubernetes [Pods](https://cloud.google.com/kubernetes-engine/docs/concepts/pod) associated with the finding. This field contains Pod records for each container that is owned by a Pod. - { # A Kubernetes Pod. - "containers": [ # Pod containers associated with this finding, if any. - { # Container associated with the finding. - "createTime": "A String", # The time that the container was created. - "imageId": "A String", # Optional container image ID, if provided by the container runtime. Uniquely identifies the container image launched using a container image digest. - "labels": [ # Container labels, as provided by the container runtime. - { # Represents a generic name-value label. A label has separate name and value fields to support filtering with the `contains()` function. For more information, see [Filtering on array-type fields](https://cloud.google.com/security-command-center/docs/how-to-api-list-findings#array-contains-filtering). - "name": "A String", # Name of the label. - "value": "A String", # Value that corresponds to the label's name. + "pods": [ + { + "containers": [ + { + "createTime": "A String", + "imageId": "A String", + "labels": [ + { + "name": "A String", + "value": "A String", }, ], - "name": "A String", # Name of the container. - "uri": "A String", # Container image URI provided when configuring a pod or container. This string can identify a container image version using mutable tags. + "name": "A String", + "uri": "A String", }, ], - "labels": [ # Pod labels. For Kubernetes containers, these are applied to the container. - { # Represents a generic name-value label. A label has separate name and value fields to support filtering with the `contains()` function. For more information, see [Filtering on array-type fields](https://cloud.google.com/security-command-center/docs/how-to-api-list-findings#array-contains-filtering). - "name": "A String", # Name of the label. - "value": "A String", # Value that corresponds to the label's name. + "labels": [ + { + "name": "A String", + "value": "A String", }, ], - "name": "A String", # Kubernetes Pod name. - "ns": "A String", # Kubernetes Pod namespace. + "name": "A String", + "ns": "A String", }, ], - "roles": [ # Provides Kubernetes role information for findings that involve [Roles or ClusterRoles](https://cloud.google.com/kubernetes-engine/docs/how-to/role-based-access-control). - { # Kubernetes Role or ClusterRole. - "kind": "A String", # Role type. - "name": "A String", # Role name. - "ns": "A String", # Role namespace. + "roles": [ + { + "kind": "A String", + "name": "A String", + "ns": "A String", }, ], }, - "loadBalancers": [ # The load balancers associated with the finding. - { # Contains information related to the load balancer associated with the finding. - "name": "A String", # The name of the load balancer associated with the finding. + "loadBalancers": [ + { + "name": "A String", }, ], - "logEntries": [ # Log entries that are relevant to the finding. - { # An individual entry in a log. - "cloudLoggingEntry": { # Metadata taken from a [Cloud Logging LogEntry](https://cloud.google.com/logging/docs/reference/v2/rest/v2/LogEntry) # An individual entry in a log stored in Cloud Logging. - "insertId": "A String", # A unique identifier for the log entry. - "logId": "A String", # The type of the log (part of `log_name`. `log_name` is the resource name of the log to which this log entry belongs). For example: `cloudresourcemanager.googleapis.com/activity`. Note that this field is not URL-encoded, unlike the `LOG_ID` field in `LogEntry`. - "resourceContainer": "A String", # The organization, folder, or project of the monitored resource that produced this log entry. - "timestamp": "A String", # The time the event described by the log entry occurred. + "logEntries": [ + { + "cloudLoggingEntry": { + "insertId": "A String", + "logId": "A String", + "resourceContainer": "A String", + "timestamp": "A String", }, }, ], - "mitreAttack": { # MITRE ATT&CK tactics and techniques related to this finding. See: https://attack.mitre.org # MITRE ATT&CK tactics and techniques related to this finding. See: https://attack.mitre.org - "additionalTactics": [ # Additional MITRE ATT&CK tactics related to this finding, if any. + "mitreAttack": { + "additionalTactics": [ "A String", ], - "additionalTechniques": [ # Additional MITRE ATT&CK techniques related to this finding, if any, along with any of their respective parent techniques. + "additionalTechniques": [ "A String", ], - "primaryTactic": "A String", # The MITRE ATT&CK tactic most closely represented by this finding, if any. - "primaryTechniques": [ # The MITRE ATT&CK technique most closely represented by this finding, if any. primary_techniques is a repeated field because there are multiple levels of MITRE ATT&CK techniques. If the technique most closely represented by this finding is a sub-technique (e.g. `SCANNING_IP_BLOCKS`), both the sub-technique and its parent technique(s) will be listed (e.g. `SCANNING_IP_BLOCKS`, `ACTIVE_SCANNING`). + "primaryTactic": "A String", + "primaryTechniques": [ "A String", ], - "version": "A String", # The MITRE ATT&CK version referenced by the above fields. E.g. "8". + "version": "A String", }, - "moduleName": "A String", # Unique identifier of the module which generated the finding. Example: folders/598186756061/securityHealthAnalyticsSettings/customModules/56799441161885 - "mute": "A String", # Indicates the mute state of a finding (either muted, unmuted or undefined). Unlike other attributes of a finding, a finding provider shouldn't set the value of mute. - "muteInfo": { # Mute information about the finding, including whether the finding has a static mute or any matching dynamic mute rules. # Output only. The mute information regarding this finding. - "dynamicMuteRecords": [ # The list of dynamic mute rules that currently match the finding. - { # The record of a dynamic mute rule that matches the finding. - "matchTime": "A String", # When the dynamic mute rule first matched the finding. - "muteConfig": "A String", # The relative resource name of the mute rule, represented by a mute config, that created this record, for example `organizations/123/muteConfigs/mymuteconfig` or `organizations/123/locations/global/muteConfigs/mymuteconfig`. + "moduleName": "A String", + "mute": "A String", + "muteInfo": { + "dynamicMuteRecords": [ + { + "matchTime": "A String", + "muteConfig": "A String", }, ], - "staticMute": { # Information about the static mute state. A static mute state overrides any dynamic mute rules that apply to this finding. The static mute state can be set by a static mute rule or by muting the finding directly. # If set, the static mute applied to this finding. Static mutes override dynamic mutes. If unset, there is no static mute. - "applyTime": "A String", # When the static mute was applied. - "state": "A String", # The static mute state. If the value is `MUTED` or `UNMUTED`, then the finding's overall mute state will have the same value. + "staticMute": { + "applyTime": "A String", + "state": "A String", }, }, - "muteInitiator": "A String", # Records additional information about the mute operation, for example, the [mute configuration](/security-command-center/docs/how-to-mute-findings) that muted the finding and the user who muted the finding. - "muteUpdateTime": "A String", # Output only. The most recent time this finding was muted or unmuted. - "name": "A String", # The [relative resource name](https://cloud.google.com/apis/design/resource_names#relative_resource_name) of the finding. Example: "organizations/{organization_id}/sources/{source_id}/findings/{finding_id}", "folders/{folder_id}/sources/{source_id}/findings/{finding_id}", "projects/{project_id}/sources/{source_id}/findings/{finding_id}". - "networks": [ # Represents the VPC networks that the resource is attached to. - { # Contains information about a VPC network associated with the finding. - "name": "A String", # The name of the VPC network resource, for example, `//compute.googleapis.com/projects/my-project/global/networks/my-network`. + "muteInitiator": "A String", + "muteUpdateTime": "A String", + "name": "A String", + "networks": [ + { + "name": "A String", }, ], - "nextSteps": "A String", # Steps to address the finding. - "notebook": { # Represents a Jupyter notebook IPYNB file, such as a [Colab Enterprise notebook](https://cloud.google.com/colab/docs/introduction) file, that is associated with a finding. # Notebook associated with the finding. - "lastAuthor": "A String", # The user ID of the latest author to modify the notebook. - "name": "A String", # The name of the notebook. - "notebookUpdateTime": "A String", # The most recent time the notebook was updated. - "service": "A String", # The source notebook service, for example, "Colab Enterprise". + "nextSteps": "A String", + "notebook": { + "lastAuthor": "A String", + "name": "A String", + "notebookUpdateTime": "A String", + "service": "A String", }, - "orgPolicies": [ # Contains information about the org policies associated with the finding. - { # Contains information about the org policies associated with the finding. - "name": "A String", # The resource name of the org policy. Example: "organizations/{organization_id}/policies/{constraint_name}" + "orgPolicies": [ + { + "name": "A String", }, ], - "parent": "A String", # The relative resource name of the source the finding belongs to. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name This field is immutable after creation time. For example: "organizations/{organization_id}/sources/{source_id}" - "parentDisplayName": "A String", # Output only. The human readable display name of the finding source such as "Event Threat Detection" or "Security Health Analytics". - "policyViolationSummary": { # Metadata summarizing policy violations of child resources of the affected resource. `finding_category` and `resource` determine the exact semantics of the counts. For example, when category=DATA_SECURITY_POSTURE_OBJECT_PUBLIC_ACCESS_VIOLATION and resource='storage.googleapis.com/buckets/my-bucket-name' then this counts the number of Cloud Storage objects in my-bucket-name which violate a Public Access control. # PolicyViolationSummary associated with the finding. - "conformantResourcesCount": "A String", # Total number of child resources that conform to the policy. - "evaluationErrorsCount": "A String", # Number of child resources for which errors during evaluation occurred. The evaluation result for these child resources is effectively "unknown". - "outOfScopeResourcesCount": "A String", # Total count of child resources which were not in scope for evaluation. - "policyViolationsCount": "A String", # Count of child resources in violation of the policy. - }, - "processes": [ # Represents operating system processes associated with the Finding. - { # Represents an operating system process. - "args": [ # Process arguments as JSON encoded strings. + "parent": "A String", + "parentDisplayName": "A String", + "policyViolationSummary": { + "conformantResourcesCount": "A String", + "evaluationErrorsCount": "A String", + "outOfScopeResourcesCount": "A String", + "policyViolationsCount": "A String", + }, + "processes": [ + { + "args": [ "A String", ], - "argumentsTruncated": True or False, # True if `args` is incomplete. - "binary": { # File information about the related binary/library used by an executable, or the script used by a script interpreter # File information for the process executable. - "contents": "A String", # Prefix of the file contents as a JSON-encoded string. - "diskPath": { # Path of the file in terms of underlying disk/partition identifiers. # Path of the file in terms of underlying disk/partition identifiers. - "partitionUuid": "A String", # UUID of the partition (format https://wiki.archlinux.org/title/persistent_block_device_naming#by-uuid) - "relativePath": "A String", # Relative path of the file in the partition as a JSON encoded string. Example: /home/user1/executable_file.sh + "argumentsTruncated": True or False, + "binary": { + "contents": "A String", + "diskPath": { + "partitionUuid": "A String", + "relativePath": "A String", }, - "fileLoadState": "A String", # The load state of the file. - "hashedSize": "A String", # The length in bytes of the file prefix that was hashed. If hashed_size == size, any hashes reported represent the entire file. - "operations": [ # Operation(s) performed on a file. - { # Operation(s) performed on a file. - "type": "A String", # The type of the operation + "fileLoadState": "A String", + "hashedSize": "A String", + "operations": [ + { + "type": "A String", }, ], - "partiallyHashed": True or False, # True when the hash covers only a prefix of the file. - "path": "A String", # Absolute path of the file as a JSON encoded string. - "sha256": "A String", # SHA256 hash of the first hashed_size bytes of the file encoded as a hex string. If hashed_size == size, sha256 represents the SHA256 hash of the entire file. - "size": "A String", # Size of the file in bytes. + "partiallyHashed": True or False, + "path": "A String", + "sha256": "A String", + "size": "A String", }, - "envVariables": [ # Process environment variables. - { # A name-value pair representing an environment variable used in an operating system process. - "name": "A String", # Environment variable name as a JSON encoded string. - "val": "A String", # Environment variable value as a JSON encoded string. + "envVariables": [ + { + "name": "A String", + "val": "A String", }, ], - "envVariablesTruncated": True or False, # True if `env_variables` is incomplete. - "libraries": [ # File information for libraries loaded by the process. - { # File information about the related binary/library used by an executable, or the script used by a script interpreter - "contents": "A String", # Prefix of the file contents as a JSON-encoded string. - "diskPath": { # Path of the file in terms of underlying disk/partition identifiers. # Path of the file in terms of underlying disk/partition identifiers. - "partitionUuid": "A String", # UUID of the partition (format https://wiki.archlinux.org/title/persistent_block_device_naming#by-uuid) - "relativePath": "A String", # Relative path of the file in the partition as a JSON encoded string. Example: /home/user1/executable_file.sh + "envVariablesTruncated": True or False, + "libraries": [ + { + "contents": "A String", + "diskPath": { + "partitionUuid": "A String", + "relativePath": "A String", }, - "fileLoadState": "A String", # The load state of the file. - "hashedSize": "A String", # The length in bytes of the file prefix that was hashed. If hashed_size == size, any hashes reported represent the entire file. - "operations": [ # Operation(s) performed on a file. - { # Operation(s) performed on a file. - "type": "A String", # The type of the operation + "fileLoadState": "A String", + "hashedSize": "A String", + "operations": [ + { + "type": "A String", }, ], - "partiallyHashed": True or False, # True when the hash covers only a prefix of the file. - "path": "A String", # Absolute path of the file as a JSON encoded string. - "sha256": "A String", # SHA256 hash of the first hashed_size bytes of the file encoded as a hex string. If hashed_size == size, sha256 represents the SHA256 hash of the entire file. - "size": "A String", # Size of the file in bytes. + "partiallyHashed": True or False, + "path": "A String", + "sha256": "A String", + "size": "A String", }, ], - "name": "A String", # The process name, as displayed in utilities like `top` and `ps`. This name can be accessed through `/proc/[pid]/comm` and changed with `prctl(PR_SET_NAME)`. - "parentPid": "A String", # The parent process ID. - "pid": "A String", # The process ID. - "script": { # File information about the related binary/library used by an executable, or the script used by a script interpreter # When the process represents the invocation of a script, `binary` provides information about the interpreter, while `script` provides information about the script file provided to the interpreter. - "contents": "A String", # Prefix of the file contents as a JSON-encoded string. - "diskPath": { # Path of the file in terms of underlying disk/partition identifiers. # Path of the file in terms of underlying disk/partition identifiers. - "partitionUuid": "A String", # UUID of the partition (format https://wiki.archlinux.org/title/persistent_block_device_naming#by-uuid) - "relativePath": "A String", # Relative path of the file in the partition as a JSON encoded string. Example: /home/user1/executable_file.sh + "name": "A String", + "parentPid": "A String", + "pid": "A String", + "script": { + "contents": "A String", + "diskPath": { + "partitionUuid": "A String", + "relativePath": "A String", }, - "fileLoadState": "A String", # The load state of the file. - "hashedSize": "A String", # The length in bytes of the file prefix that was hashed. If hashed_size == size, any hashes reported represent the entire file. - "operations": [ # Operation(s) performed on a file. - { # Operation(s) performed on a file. - "type": "A String", # The type of the operation + "fileLoadState": "A String", + "hashedSize": "A String", + "operations": [ + { + "type": "A String", }, ], - "partiallyHashed": True or False, # True when the hash covers only a prefix of the file. - "path": "A String", # Absolute path of the file as a JSON encoded string. - "sha256": "A String", # SHA256 hash of the first hashed_size bytes of the file encoded as a hex string. If hashed_size == size, sha256 represents the SHA256 hash of the entire file. - "size": "A String", # Size of the file in bytes. + "partiallyHashed": True or False, + "path": "A String", + "sha256": "A String", + "size": "A String", }, - "userId": "A String", # The ID of the user that executed the process. E.g. If this is the root user this will always be 0. + "userId": "A String", }, ], - "resourceName": "A String", # For findings on Google Cloud resources, the full resource name of the Google Cloud resource this finding is for. See: https://cloud.google.com/apis/design/resource_names#full_resource_name When the finding is for a non-Google Cloud resource, the resourceName can be a customer or partner defined string. This field is immutable after creation time. - "secret": { # Details about a secret or credential associated with the finding. # Secret associated with the finding. - "environmentVariable": { # Environment variable containing the secret. # The environment variable containing the secret. - "key": "A String", # Environment variable name as a JSON encoded string. Note that value is not included since the value contains the secret data, which is sensitive core content. + "resourceName": "A String", + "secret": { + "environmentVariable": { + "key": "A String", }, - "filePath": { # File path containing the secret. # The file containing the secret. - "path": "A String", # Path to the file. + "filePath": { + "path": "A String", }, - "status": { # The status of the secret. # The status of the secret. - "lastUpdatedTime": "A String", # Time that the secret was found. - "validity": "A String", # The validity of the secret. + "status": { + "lastUpdatedTime": "A String", + "validity": "A String", }, - "type": "A String", # The type of secret, for example, GCP_API_KEY. + "type": "A String", }, - "securityMarks": { # User specified security marks that are attached to the parent Security Command Center resource. Security marks are scoped within a Security Command Center organization -- they can be modified and viewed by all users who have proper permissions on the organization. # Output only. User specified security marks. These marks are entirely managed by the user and come from the SecurityMarks resource that belongs to the finding. - "canonicalName": "A String", # The canonical name of the marks. Examples: "organizations/{organization_id}/assets/{asset_id}/securityMarks" "folders/{folder_id}/assets/{asset_id}/securityMarks" "projects/{project_number}/assets/{asset_id}/securityMarks" "organizations/{organization_id}/sources/{source_id}/findings/{finding_id}/securityMarks" "folders/{folder_id}/sources/{source_id}/findings/{finding_id}/securityMarks" "projects/{project_number}/sources/{source_id}/findings/{finding_id}/securityMarks" - "marks": { # Mutable user specified security marks belonging to the parent resource. Constraints are as follows: * Keys and values are treated as case insensitive * Keys must be between 1 - 256 characters (inclusive) * Keys must be letters, numbers, underscores, or dashes * Values have leading and trailing whitespace trimmed, remaining characters must be between 1 - 4096 characters (inclusive) + "securityMarks": { + "canonicalName": "A String", + "marks": { "a_key": "A String", }, - "name": "A String", # The relative resource name of the SecurityMarks. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Examples: "organizations/{organization_id}/assets/{asset_id}/securityMarks" "organizations/{organization_id}/sources/{source_id}/findings/{finding_id}/securityMarks". - }, - "securityPosture": { # Represents a posture that is deployed on Google Cloud by the Security Command Center Posture Management service. A posture contains one or more policy sets. A policy set is a group of policies that enforce a set of security rules on Google Cloud. # The security posture associated with the finding. - "changedPolicy": "A String", # The name of the updated policy, for example, `projects/{project_id}/policies/{constraint_name}`. - "name": "A String", # Name of the posture, for example, `CIS-Posture`. - "policy": "A String", # The ID of the updated policy, for example, `compute-policy-1`. - "policyDriftDetails": [ # The details about a change in an updated policy that violates the deployed posture. - { # The policy field that violates the deployed posture and its expected and detected values. - "detectedValue": "A String", # The detected value that violates the deployed posture, for example, `false` or `allowed_values={"projects/22831892"}`. - "expectedValue": "A String", # The value of this field that was configured in a posture, for example, `true` or `allowed_values={"projects/29831892"}`. - "field": "A String", # The name of the updated field, for example constraint.implementation.policy_rules[0].enforce + "name": "A String", + }, + "securityPosture": { + "changedPolicy": "A String", + "name": "A String", + "policy": "A String", + "policyDriftDetails": [ + { + "detectedValue": "A String", + "expectedValue": "A String", + "field": "A String", }, ], - "policySet": "A String", # The name of the updated policyset, for example, `cis-policyset`. - "postureDeployment": "A String", # The name of the posture deployment, for example, `organizations/{org_id}/posturedeployments/{posture_deployment_id}`. - "postureDeploymentResource": "A String", # The project, folder, or organization on which the posture is deployed, for example, `projects/{project_number}`. - "revisionId": "A String", # The version of the posture, for example, `c7cfa2a8`. + "policySet": "A String", + "postureDeployment": "A String", + "postureDeploymentResource": "A String", + "revisionId": "A String", }, - "severity": "A String", # The severity of the finding. This field is managed by the source that writes the finding. - "sourceProperties": { # Source specific properties. These properties are managed by the source that writes the finding. The key names in the source_properties map must be between 1 and 255 characters, and must start with a letter and contain alphanumeric characters or underscores only. + "severity": "A String", + "sourceProperties": { "a_key": "", }, - "state": "A String", # The state of the finding. - "toxicCombination": { # Contains details about a group of security issues that, when the issues occur together, represent a greater risk than when the issues occur independently. A group of such issues is referred to as a toxic combination. # Contains details about a group of security issues that, when the issues occur together, represent a greater risk than when the issues occur independently. A group of such issues is referred to as a toxic combination. This field cannot be updated. Its value is ignored in all update requests. - "attackExposureScore": 3.14, # The [Attack exposure score](https://cloud.google.com/security-command-center/docs/attack-exposure-learn#attack_exposure_scores) of this toxic combination. The score is a measure of how much this toxic combination exposes one or more high-value resources to potential attack. - "relatedFindings": [ # List of resource names of findings associated with this toxic combination. For example, `organizations/123/sources/456/findings/789`. + "state": "A String", + "toxicCombination": { + "attackExposureScore": 3.14, + "relatedFindings": [ "A String", ], }, - "vertexAi": { # Vertex AI-related information associated with the finding. # VertexAi associated with the finding. - "datasets": [ # Datasets associated with the finding. - { # Vertex AI dataset associated with the finding. - "displayName": "A String", # The user defined display name of dataset, e.g. plants-dataset - "name": "A String", # Resource name of the dataset, e.g. projects/{project}/locations/{location}/datasets/2094040236064505856 - "source": "A String", # Data source, such as BigQuery source URI, e.g. bq://scc-nexus-test.AIPPtest.gsod + "vertexAi": { + "datasets": [ + { + "displayName": "A String", + "name": "A String", + "source": "A String", }, ], - "pipelines": [ # Pipelines associated with the finding. - { # Vertex AI training pipeline associated with the finding. - "displayName": "A String", # The user defined display name of pipeline, e.g. plants-classification - "name": "A String", # Resource name of the pipeline, e.g. projects/{project}/locations/{location}/trainingPipelines/5253428229225578496 + "pipelines": [ + { + "displayName": "A String", + "name": "A String", }, ], }, - "vulnerability": { # Refers to common vulnerability fields e.g. cve, cvss, cwe etc. # Represents vulnerability-specific fields like CVE and CVSS scores. CVE stands for Common Vulnerabilities and Exposures (https://cve.mitre.org/about/) - "cve": { # CVE stands for Common Vulnerabilities and Exposures. Information from the [CVE record](https://www.cve.org/ResourcesSupport/Glossary) that describes this vulnerability. # CVE stands for Common Vulnerabilities and Exposures (https://cve.mitre.org/about/) - "cvssv3": { # Common Vulnerability Scoring System version 3. # Describe Common Vulnerability Scoring System specified at https://www.first.org/cvss/v3.1/specification-document - "attackComplexity": "A String", # This metric describes the conditions beyond the attacker's control that must exist in order to exploit the vulnerability. - "attackVector": "A String", # Base Metrics Represents the intrinsic characteristics of a vulnerability that are constant over time and across user environments. This metric reflects the context by which vulnerability exploitation is possible. - "availabilityImpact": "A String", # This metric measures the impact to the availability of the impacted component resulting from a successfully exploited vulnerability. - "baseScore": 3.14, # The base score is a function of the base metric scores. - "confidentialityImpact": "A String", # This metric measures the impact to the confidentiality of the information resources managed by a software component due to a successfully exploited vulnerability. - "integrityImpact": "A String", # This metric measures the impact to integrity of a successfully exploited vulnerability. - "privilegesRequired": "A String", # This metric describes the level of privileges an attacker must possess before successfully exploiting the vulnerability. - "scope": "A String", # The Scope metric captures whether a vulnerability in one vulnerable component impacts resources in components beyond its security scope. - "userInteraction": "A String", # This metric captures the requirement for a human user, other than the attacker, to participate in the successful compromise of the vulnerable component. + "vulnerability": { + "cve": { + "cvssv3": { + "attackComplexity": "A String", + "attackVector": "A String", + "availabilityImpact": "A String", + "baseScore": 3.14, + "confidentialityImpact": "A String", + "integrityImpact": "A String", + "privilegesRequired": "A String", + "scope": "A String", + "userInteraction": "A String", }, - "exploitReleaseDate": "A String", # Date the first publicly available exploit or PoC was released. - "exploitationActivity": "A String", # The exploitation activity of the vulnerability in the wild. - "firstExploitationDate": "A String", # Date of the earliest known exploitation. - "id": "A String", # The unique identifier for the vulnerability. e.g. CVE-2021-34527 - "impact": "A String", # The potential impact of the vulnerability if it was to be exploited. - "observedInTheWild": True or False, # Whether or not the vulnerability has been observed in the wild. - "references": [ # Additional information about the CVE. e.g. https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2021-34527 - { # Additional Links - "source": "A String", # Source of the reference e.g. NVD - "uri": "A String", # Uri for the mentioned source e.g. https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2021-34527. + "exploitReleaseDate": "A String", + "exploitationActivity": "A String", + "firstExploitationDate": "A String", + "id": "A String", + "impact": "A String", + "observedInTheWild": True or False, + "references": [ + { + "source": "A String", + "uri": "A String", }, ], - "upstreamFixAvailable": True or False, # Whether upstream fix is available for the CVE. - "zeroDay": True or False, # Whether or not the vulnerability was zero day when the finding was published. - }, - "cwes": [ # Represents one or more Common Weakness Enumeration (CWE) information on this vulnerability. - { # CWE stands for Common Weakness Enumeration. Information about this weakness, as described by [CWE](https://cwe.mitre.org/). - "id": "A String", # The CWE identifier, e.g. CWE-94 - "references": [ # Any reference to the details on the CWE, for example, https://cwe.mitre.org/data/definitions/94.html - { # Additional Links - "source": "A String", # Source of the reference e.g. NVD - "uri": "A String", # Uri for the mentioned source e.g. https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2021-34527. + "upstreamFixAvailable": True or False, + "zeroDay": True or False, + }, + "cwes": [ + { + "id": "A String", + "references": [ + { + "source": "A String", + "uri": "A String", }, ], }, ], - "fixedPackage": { # Package is a generic definition of a package. # The fixed package is relevant to the finding. - "cpeUri": "A String", # The CPE URI where the vulnerability was detected. - "packageName": "A String", # The name of the package where the vulnerability was detected. - "packageType": "A String", # Type of package, for example, os, maven, or go. - "packageVersion": "A String", # The version of the package. + "fixedPackage": { + "cpeUri": "A String", + "packageName": "A String", + "packageType": "A String", + "packageVersion": "A String", }, - "offendingPackage": { # Package is a generic definition of a package. # The offending package is relevant to the finding. - "cpeUri": "A String", # The CPE URI where the vulnerability was detected. - "packageName": "A String", # The name of the package where the vulnerability was detected. - "packageType": "A String", # Type of package, for example, os, maven, or go. - "packageVersion": "A String", # The version of the package. + "offendingPackage": { + "cpeUri": "A String", + "packageName": "A String", + "packageType": "A String", + "packageVersion": "A String", }, - "providerRiskScore": "A String", # Provider provided risk_score based on multiple factors. The higher the risk score, the more risky the vulnerability is. - "reachable": True or False, # Represents whether the vulnerability is reachable (detected via static analysis) - "securityBulletin": { # SecurityBulletin are notifications of vulnerabilities of Google products. # The security bulletin is relevant to this finding. - "bulletinId": "A String", # ID of the bulletin corresponding to the vulnerability. - "submissionTime": "A String", # Submission time of this Security Bulletin. - "suggestedUpgradeVersion": "A String", # This represents a version that the cluster receiving this notification should be upgraded to, based on its current version. For example, 1.15.0 + "providerRiskScore": "A String", + "reachable": True or False, + "securityBulletin": { + "bulletinId": "A String", + "submissionTime": "A String", + "suggestedUpgradeVersion": "A String", }, }, }
@@ -3614,16 +3614,16 @@

Method Details

setState(name, body=None, x__xgafv=None) -
Updates the state of a finding.
+  
 
 Args:
-  name: string, Required. The [relative resource name](https://cloud.google.com/apis/design/resource_names#relative_resource_name) of the finding. Example: `organizations/{organization_id}/sources/{source_id}/findings/{finding_id}`, `folders/{folder_id}/sources/{source_id}/findings/{finding_id}`, `projects/{project_id}/sources/{source_id}/findings/{finding_id}`. (required)
+  name: string, A parameter (required)
   body: object, The request body.
     The object takes the form of:
 
-{ # Request message for updating a finding's state.
-  "startTime": "A String", # Optional. The time at which the updated state takes effect. If unset, defaults to the request time.
-  "state": "A String", # Required. The desired State of the finding.
+{
+  "startTime": "A String",
+  "state": "A String",
 }
 
   x__xgafv: string, V1 error format.
@@ -3634,811 +3634,811 @@ 

Method Details

Returns: An object of the form: - { # Security Command Center finding. A finding is a record of assessment data like security, risk, health, or privacy, that is ingested into Security Command Center for presentation, notification, analysis, policy testing, and enforcement. For example, a cross-site scripting (XSS) vulnerability in an App Engine application is a finding. - "access": { # Represents an access event. # Access details associated with the finding, such as more information on the caller, which method was accessed, and from where. - "callerIp": "A String", # Caller's IP address, such as "1.1.1.1". - "callerIpGeo": { # Represents a geographical location for a given access. # The caller IP's geolocation, which identifies where the call came from. - "regionCode": "A String", # A CLDR. - }, - "methodName": "A String", # The method that the service account called, e.g. "SetIamPolicy". - "principalEmail": "A String", # Associated email, such as "foo@google.com". The email address of the authenticated user or a service account acting on behalf of a 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). - "principalSubject": "A String", # A string that represents the principal_subject that is associated with the identity. Unlike `principal_email`, `principal_subject` supports principals that aren't associated with email addresses, such as third party principals. For most identities, the format is `principal://iam.googleapis.com/{identity pool name}/subject/{subject}`. Some GKE identities, such as GKE_WORKLOAD, FREEFORM, and GKE_HUB_WORKLOAD, still use the legacy format `serviceAccount:{identity pool name}[{subject}]`. - "serviceAccountDelegationInfo": [ # The identity delegation history of an authenticated service account that made the request. The `serviceAccountDelegationInfo[]` object contains information about the real authorities that try to access Google Cloud resources by delegating on a service account. When multiple authorities are present, they are guaranteed to be sorted based on the original ordering of the identity delegation events. - { # Identity delegation history of an authenticated service account. - "principalEmail": "A String", # The email address of a Google account. - "principalSubject": "A String", # A string representing the principal_subject associated with the identity. As compared to `principal_email`, supports principals that aren't associated with email addresses, such as third party principals. For most identities, the format will be `principal://iam.googleapis.com/{identity pool name}/subjects/{subject}` except for some GKE identities (GKE_WORKLOAD, FREEFORM, GKE_HUB_WORKLOAD) that are still in the legacy format `serviceAccount:{identity pool name}[{subject}]` + { + "access": { + "callerIp": "A String", + "callerIpGeo": { + "regionCode": "A String", + }, + "methodName": "A String", + "principalEmail": "A String", + "principalSubject": "A String", + "serviceAccountDelegationInfo": [ + { + "principalEmail": "A String", + "principalSubject": "A String", }, ], - "serviceAccountKeyName": "A String", # The name of the service account key that was used to create or exchange credentials when authenticating the service account that made the request. This is a scheme-less URI full resource name. For example: "//iam.googleapis.com/projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}/keys/{key}". - "serviceName": "A String", # This is the API service that the service account made a call to, e.g. "iam.googleapis.com" - "userAgent": "A String", # The caller's user agent string associated with the finding. - "userAgentFamily": "A String", # Type of user agent associated with the finding. For example, an operating system shell or an embedded or standalone application. - "userName": "A String", # A string that represents a username. The username provided depends on the type of the finding and is likely not an IAM principal. For example, this can be a system username if the finding is related to a virtual machine, or it can be an application login username. + "serviceAccountKeyName": "A String", + "serviceName": "A String", + "userAgent": "A String", + "userAgentFamily": "A String", + "userName": "A String", }, - "affectedResources": { # Details about resources affected by this finding. # AffectedResources associated with the finding. - "count": "A String", # The count of resources affected by the finding. + "affectedResources": { + "count": "A String", }, - "agentDataAccessEvents": [ # Agent data access events associated with the finding. - { # Details about a data access attempt made by an agent principal not authorized under applicable data security policy. - "eventId": "A String", # Unique identifier for data access event. - "eventTime": "A String", # Timestamp of data access event. - "operation": "A String", # The operation performed by the principal to access the data. - "principalSubject": "A String", # The agent principal that accessed the data. + "agentDataAccessEvents": [ + { + "eventId": "A String", + "eventTime": "A String", + "operation": "A String", + "principalSubject": "A String", }, ], - "aiModel": { # Contains information about the AI model associated with the finding. # The AI model associated with the finding. - "deploymentPlatform": "A String", # The platform on which the model is deployed. - "displayName": "A String", # The user defined display name of model. Ex. baseline-classification-model - "domain": "A String", # The domain of the model, for example, “image-classification”. - "library": "A String", # The name of the model library, for example, “transformers”. - "location": "A String", # The region in which the model is used, for example, “us-central1”. - "name": "A String", # The name of the AI model, for example, "gemini:1.0.0". - "publisher": "A String", # The publisher of the model, for example, “google” or “nvidia”. - "usageCategory": "A String", # The purpose of the model, for example, "Inteference" or "Training". - }, - "application": { # Represents an application associated with a finding. # Represents an application associated with the finding. - "baseUri": "A String", # The base URI that identifies the network location of the application in which the vulnerability was detected. For example, `http://example.com`. - "fullUri": "A String", # The full URI with payload that can be used to reproduce the vulnerability. For example, `http://example.com?p=aMmYgI6H`. - }, - "artifactGuardPolicies": { # Represents the result of evaluating artifact guard policies. # ArtifactGuardPolicies associated with the finding. - "failingPolicies": [ # A list of failing policies. - { # Represents an artifact guard policy. - "failureReason": "A String", # The reason for the policy failure, for example, "severity=HIGH AND max_vuln_count=2". - "policyId": "A String", # The ID of the failing policy, for example, "organizations/3392779/locations/global/policies/prod-policy". - "type": "A String", # The type of the policy evaluation. + "aiModel": { + "deploymentPlatform": "A String", + "displayName": "A String", + "domain": "A String", + "library": "A String", + "location": "A String", + "name": "A String", + "publisher": "A String", + "usageCategory": "A String", + }, + "application": { + "baseUri": "A String", + "fullUri": "A String", + }, + "artifactGuardPolicies": { + "failingPolicies": [ + { + "failureReason": "A String", + "policyId": "A String", + "type": "A String", }, ], - "resourceId": "A String", # The ID of the resource that has policies configured for it. + "resourceId": "A String", }, - "attackExposure": { # An attack exposure contains the results of an attack path simulation run. # The results of an attack path simulation relevant to this finding. - "attackExposureResult": "A String", # The resource name of the attack path simulation result that contains the details regarding this attack exposure score. Example: `organizations/123/simulations/456/attackExposureResults/789` - "exposedHighValueResourcesCount": 42, # The number of high value resources that are exposed as a result of this finding. - "exposedLowValueResourcesCount": 42, # The number of high value resources that are exposed as a result of this finding. - "exposedMediumValueResourcesCount": 42, # The number of medium value resources that are exposed as a result of this finding. - "latestCalculationTime": "A String", # The most recent time the attack exposure was updated on this finding. - "score": 3.14, # A number between 0 (inclusive) and infinity that represents how important this finding is to remediate. The higher the score, the more important it is to remediate. - "state": "A String", # What state this AttackExposure is in. This captures whether or not an attack exposure has been calculated or not. + "attackExposure": { + "attackExposureResult": "A String", + "exposedHighValueResourcesCount": 42, + "exposedLowValueResourcesCount": 42, + "exposedMediumValueResourcesCount": 42, + "latestCalculationTime": "A String", + "score": 3.14, + "state": "A String", }, - "backupDisasterRecovery": { # Information related to Google Cloud Backup and DR Service findings. # Fields related to Backup and DR findings. - "appliance": "A String", # The name of the Backup and DR appliance that captures, moves, and manages the lifecycle of backup data. For example, `backup-server-57137`. - "applications": [ # The names of Backup and DR applications. An application is a VM, database, or file system on a managed host monitored by a backup and recovery appliance. For example, `centos7-01-vol00`, `centos7-01-vol01`, `centos7-01-vol02`. + "backupDisasterRecovery": { + "appliance": "A String", + "applications": [ "A String", ], - "backupCreateTime": "A String", # The timestamp at which the Backup and DR backup was created. - "backupTemplate": "A String", # The name of a Backup and DR template which comprises one or more backup policies. See the [Backup and DR documentation](https://cloud.google.com/backup-disaster-recovery/docs/concepts/backup-plan#temp) for more information. For example, `snap-ov`. - "backupType": "A String", # The backup type of the Backup and DR image. For example, `Snapshot`, `Remote Snapshot`, `OnVault`. - "host": "A String", # The name of a Backup and DR host, which is managed by the backup and recovery appliance and known to the management console. The host can be of type Generic (for example, Compute Engine, SQL Server, Oracle DB, SMB file system, etc.), vCenter, or an ESX server. See the [Backup and DR documentation on hosts](https://cloud.google.com/backup-disaster-recovery/docs/configuration/manage-hosts-and-their-applications) for more information. For example, `centos7-01`. - "policies": [ # The names of Backup and DR policies that are associated with a template and that define when to run a backup, how frequently to run a backup, and how long to retain the backup image. For example, `onvaults`. + "backupCreateTime": "A String", + "backupTemplate": "A String", + "backupType": "A String", + "host": "A String", + "policies": [ "A String", ], - "policyOptions": [ # The names of Backup and DR advanced policy options of a policy applying to an application. See the [Backup and DR documentation on policy options](https://cloud.google.com/backup-disaster-recovery/docs/create-plan/policy-settings). For example, `skipofflineappsincongrp, nounmap`. + "policyOptions": [ "A String", ], - "profile": "A String", # The name of the Backup and DR resource profile that specifies the storage media for backups of application and VM data. See the [Backup and DR documentation on profiles](https://cloud.google.com/backup-disaster-recovery/docs/concepts/backup-plan#profile). For example, `GCP`. - "storagePool": "A String", # The name of the Backup and DR storage pool that the backup and recovery appliance is storing data in. The storage pool could be of type Cloud, Primary, Snapshot, or OnVault. See the [Backup and DR documentation on storage pools](https://cloud.google.com/backup-disaster-recovery/docs/concepts/storage-pools). For example, `DiskPoolOne`. + "profile": "A String", + "storagePool": "A String", }, - "canonicalName": "A String", # The canonical name of the finding. It's either "organizations/{organization_id}/sources/{source_id}/findings/{finding_id}", "folders/{folder_id}/sources/{source_id}/findings/{finding_id}" or "projects/{project_number}/sources/{source_id}/findings/{finding_id}", depending on the closest CRM ancestor of the resource associated with the finding. - "category": "A String", # The additional taxonomy group within findings from a given source. This field is immutable after creation time. Example: "XSS_FLASH_INJECTION" - "chokepoint": { # Contains details about a chokepoint, which is a resource or resource group where high-risk attack paths converge, based on [attack path simulations] (https://cloud.google.com/security-command-center/docs/attack-exposure-learn#attack_path_simulations). # Contains details about a chokepoint, which is a resource or resource group where high-risk attack paths converge, based on [attack path simulations] (https://cloud.google.com/security-command-center/docs/attack-exposure-learn#attack_path_simulations). This field cannot be updated. Its value is ignored in all update requests. - "relatedFindings": [ # List of resource names of findings associated with this chokepoint. For example, organizations/123/sources/456/findings/789. This list will have at most 100 findings. + "canonicalName": "A String", + "category": "A String", + "chokepoint": { + "relatedFindings": [ "A String", ], }, - "cloudArmor": { # Fields related to Google Cloud Armor findings. # Fields related to Cloud Armor findings. - "adaptiveProtection": { # Information about [Google Cloud Armor Adaptive Protection](https://cloud.google.com/armor/docs/cloud-armor-overview#google-cloud-armor-adaptive-protection). # Information about potential Layer 7 DDoS attacks identified by [Google Cloud Armor Adaptive Protection](https://cloud.google.com/armor/docs/adaptive-protection-overview). - "confidence": 3.14, # A score of 0 means that there is low confidence that the detected event is an actual attack. A score of 1 means that there is high confidence that the detected event is an attack. See the [Adaptive Protection documentation](https://cloud.google.com/armor/docs/adaptive-protection-overview#configure-alert-tuning) for further explanation. - }, - "attack": { # Information about DDoS attack volume and classification. # Information about DDoS attack volume and classification. - "classification": "A String", # Type of attack, for example, 'SYN-flood', 'NTP-udp', or 'CHARGEN-udp'. - "volumeBps": 42, # Total BPS (bytes per second) volume of attack. Deprecated - refer to volume_bps_long instead. - "volumeBpsLong": "A String", # Total BPS (bytes per second) volume of attack. - "volumePps": 42, # Total PPS (packets per second) volume of attack. Deprecated - refer to volume_pps_long instead. - "volumePpsLong": "A String", # Total PPS (packets per second) volume of attack. - }, - "duration": "A String", # Duration of attack from the start until the current moment (updated every 5 minutes). - "requests": { # Information about the requests relevant to the finding. # Information about incoming requests evaluated by [Google Cloud Armor security policies](https://cloud.google.com/armor/docs/security-policy-overview). - "longTermAllowed": 42, # Allowed RPS (requests per second) over the long term. - "longTermDenied": 42, # Denied RPS (requests per second) over the long term. - "ratio": 3.14, # For 'Increasing deny ratio', the ratio is the denied traffic divided by the allowed traffic. For 'Allowed traffic spike', the ratio is the allowed traffic in the short term divided by allowed traffic in the long term. - "shortTermAllowed": 42, # Allowed RPS (requests per second) in the short term. - }, - "securityPolicy": { # Information about the [Google Cloud Armor security policy](https://cloud.google.com/armor/docs/security-policy-overview) relevant to the finding. # Information about the [Google Cloud Armor security policy](https://cloud.google.com/armor/docs/security-policy-overview) relevant to the finding. - "name": "A String", # The name of the Google Cloud Armor security policy, for example, "my-security-policy". - "preview": True or False, # Whether or not the associated rule or policy is in preview mode. - "type": "A String", # The type of Google Cloud Armor security policy for example, 'backend security policy', 'edge security policy', 'network edge security policy', or 'always-on DDoS protection'. - }, - "threatVector": "A String", # Distinguish between volumetric & protocol DDoS attack and application layer attacks. For example, "L3_4" for Layer 3 and Layer 4 DDoS attacks, or "L_7" for Layer 7 DDoS attacks. - }, - "cloudDlpDataProfile": { # The [data profile](https://cloud.google.com/dlp/docs/data-profiles) associated with the finding. # Cloud DLP data profile that is associated with the finding. - "dataProfile": "A String", # Name of the data profile, for example, `projects/123/locations/europe/tableProfiles/8383929`. - "infoTypes": [ # Type of information detected by SDP. Info type includes name, version and sensitivity of the detected information type. - { # Type of information detected by the API. - "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. - "sensitivityScore": { # Score is calculated from of all elements in the data profile. A higher level means the data is more sensitive. # Optional custom sensitivity for this InfoType. This only applies to data profiling. - "score": "A String", # The sensitivity score applied to the resource. + "cloudArmor": { + "adaptiveProtection": { + "confidence": 3.14, + }, + "attack": { + "classification": "A String", + "volumeBps": 42, + "volumeBpsLong": "A String", + "volumePps": 42, + "volumePpsLong": "A String", + }, + "duration": "A String", + "requests": { + "longTermAllowed": 42, + "longTermDenied": 42, + "ratio": 3.14, + "shortTermAllowed": 42, + }, + "securityPolicy": { + "name": "A String", + "preview": True or False, + "type": "A String", + }, + "threatVector": "A String", + }, + "cloudDlpDataProfile": { + "dataProfile": "A String", + "infoTypes": [ + { + "name": "A String", + "sensitivityScore": { + "score": "A String", }, - "version": "A String", # Optional version name for this InfoType. + "version": "A String", }, ], - "parentType": "A String", # The resource hierarchy level at which the data profile was generated. + "parentType": "A String", }, - "cloudDlpInspection": { # Details about the Cloud Data Loss Prevention (Cloud DLP) [inspection job](https://cloud.google.com/dlp/docs/concepts-job-triggers) that produced the finding. # Cloud Data Loss Prevention (Cloud DLP) inspection results that are associated with the finding. - "fullScan": True or False, # Whether Cloud DLP scanned the complete resource or a sampled subset. - "infoType": "A String", # The type of information (or *[infoType](https://cloud.google.com/dlp/docs/infotypes-reference)*) found, for example, `EMAIL_ADDRESS` or `STREET_ADDRESS`. - "infoTypeCount": "A String", # The number of times Cloud DLP found this infoType within this job and resource. - "inspectJob": "A String", # Name of the inspection job, for example, `projects/123/locations/europe/dlpJobs/i-8383929`. + "cloudDlpInspection": { + "fullScan": True or False, + "infoType": "A String", + "infoTypeCount": "A String", + "inspectJob": "A String", }, - "complianceDetails": { # Compliance Details associated with the finding. # Details about the compliance implications of the finding. - "cloudControl": { # CloudControl associated with the finding. # CloudControl associated with the finding - "cloudControlName": "A String", # Name of the CloudControl associated with the finding. - "policyType": "A String", # Policy type of the CloudControl - "type": "A String", # Type of cloud control. - "version": 42, # Version of the Cloud Control + "complianceDetails": { + "cloudControl": { + "cloudControlName": "A String", + "policyType": "A String", + "type": "A String", + "version": 42, }, - "cloudControlDeploymentNames": [ # Cloud Control Deployments associated with the finding. For example, organizations/123/locations/global/cloudControlDeployments/deploymentIdentifier + "cloudControlDeploymentNames": [ "A String", ], - "frameworks": [ # Details of Frameworks associated with the finding - { # Compliance framework associated with the finding. - "category": [ # Category of the framework associated with the finding. E.g. Security Benchmark, or Assured Workloads + "frameworks": [ + { + "category": [ "A String", ], - "controls": [ # The controls associated with the framework. - { # Compliance control associated with the finding. - "controlName": "A String", # Name of the Control - "displayName": "A String", # Display name of the control. For example, AU-02. + "controls": [ + { + "controlName": "A String", + "displayName": "A String", }, ], - "displayName": "A String", # Display name of the framework. For a standard framework, this will look like e.g. PCI DSS 3.2.1, whereas for a custom framework it can be a user defined string like MyFramework - "name": "A String", # Name of the framework associated with the finding - "type": "A String", # Type of the framework associated with the finding, to specify whether the framework is built-in (pre-defined and immutable) or a custom framework defined by the customer (equivalent to security posture) + "displayName": "A String", + "name": "A String", + "type": "A String", }, ], }, - "compliances": [ # Contains compliance information for security standards associated to the finding. - { # Contains compliance information about a security standard indicating unmet recommendations. - "ids": [ # Policies within the standard or benchmark, for example, A.12.4.1 + "compliances": [ + { + "ids": [ "A String", ], - "standard": "A String", # Industry-wide compliance standards or benchmarks, such as CIS, PCI, and OWASP. - "version": "A String", # Version of the standard or benchmark, for example, 1.1 + "standard": "A String", + "version": "A String", }, ], - "connections": [ # Contains information about the IP connection associated with the finding. - { # Contains information about the IP connection associated with the finding. - "destinationIp": "A String", # Destination IP address. Not present for sockets that are listening and not connected. - "destinationPort": 42, # Destination port. Not present for sockets that are listening and not connected. - "protocol": "A String", # IANA Internet Protocol Number such as TCP(6) and UDP(17). - "sourceIp": "A String", # Source IP address. - "sourcePort": 42, # Source port. + "connections": [ + { + "destinationIp": "A String", + "destinationPort": 42, + "protocol": "A String", + "sourceIp": "A String", + "sourcePort": 42, }, ], - "contacts": { # Output only. Map containing the points of contact for the given finding. The key represents the type of contact, while the value contains a list of all the contacts that pertain. Please refer to: https://cloud.google.com/resource-manager/docs/managing-notification-contacts#notification-categories { "security": { "contacts": [ { "email": "person1@company.com" }, { "email": "person2@company.com" } ] } } - "a_key": { # Details about specific contacts - "contacts": [ # A list of contacts - { # The email address of a contact. - "email": "A String", # An email address. For example, "`person123@company.com`". + "contacts": { + "a_key": { + "contacts": [ + { + "email": "A String", }, ], }, }, - "containers": [ # Containers associated with the finding. This field provides information for both Kubernetes and non-Kubernetes containers. - { # Container associated with the finding. - "createTime": "A String", # The time that the container was created. - "imageId": "A String", # Optional container image ID, if provided by the container runtime. Uniquely identifies the container image launched using a container image digest. - "labels": [ # Container labels, as provided by the container runtime. - { # Represents a generic name-value label. A label has separate name and value fields to support filtering with the `contains()` function. For more information, see [Filtering on array-type fields](https://cloud.google.com/security-command-center/docs/how-to-api-list-findings#array-contains-filtering). - "name": "A String", # Name of the label. - "value": "A String", # Value that corresponds to the label's name. + "containers": [ + { + "createTime": "A String", + "imageId": "A String", + "labels": [ + { + "name": "A String", + "value": "A String", }, ], - "name": "A String", # Name of the container. - "uri": "A String", # Container image URI provided when configuring a pod or container. This string can identify a container image version using mutable tags. + "name": "A String", + "uri": "A String", }, ], - "createTime": "A String", # The time at which the finding was created in Security Command Center. - "dataAccessEvents": [ # Data access events associated with the finding. - { # Details about a data access attempt made by a principal not authorized under applicable data security policy. - "eventId": "A String", # Unique identifier for data access event. - "eventTime": "A String", # Timestamp of data access event. - "operation": "A String", # The operation performed by the principal to access the data. - "principalEmail": "A String", # The email address of the principal that accessed the data. The principal could be a user account, service account, Google group, or other. + "createTime": "A String", + "dataAccessEvents": [ + { + "eventId": "A String", + "eventTime": "A String", + "operation": "A String", + "principalEmail": "A String", }, ], - "dataFlowEvents": [ # Data flow events associated with the finding. - { # Details about a data flow event, in which either the data is moved to or is accessed from a non-compliant geo-location, as defined in the applicable data security policy. - "eventId": "A String", # Unique identifier for data flow event. - "eventTime": "A String", # Timestamp of data flow event. - "operation": "A String", # The operation performed by the principal for the data flow event. - "principalEmail": "A String", # The email address of the principal that initiated the data flow event. The principal could be a user account, service account, Google group, or other. - "violatedLocation": "A String", # Non-compliant location of the principal or the data destination. + "dataFlowEvents": [ + { + "eventId": "A String", + "eventTime": "A String", + "operation": "A String", + "principalEmail": "A String", + "violatedLocation": "A String", }, ], - "dataRetentionDeletionEvents": [ # Data retention deletion events associated with the finding. - { # Details about data retention deletion violations, in which the data is non-compliant based on their retention or deletion time, as defined in the applicable data security policy. The Data Retention Deletion (DRD) control is a control of the DSPM (Data Security Posture Management) suite that enables organizations to manage data retention and deletion policies in compliance with regulations, such as GDPR and CRPA. DRD supports two primary policy types: maximum storage length (max TTL) and minimum storage length (min TTL). Both are aimed at helping organizations meet regulatory and data management commitments. - "dataObjectCount": "A String", # Number of objects that violated the policy for this resource. If the number is less than 1,000, then the value of this field is the exact number. If the number of objects that violated the policy is greater than or equal to 1,000, then the value of this field is 1000. - "eventDetectionTime": "A String", # Timestamp indicating when the event was detected. - "eventType": "A String", # Type of the DRD event. - "maxRetentionAllowed": "A String", # Maximum duration of retention allowed from the DRD control. This comes from the DRD control where users set a max TTL for their data. For example, suppose that a user sets the max TTL for a Cloud Storage bucket to 90 days. However, an object in that bucket is 100 days old. In this case, a DataRetentionDeletionEvent will be generated for that Cloud Storage bucket, and the max_retention_allowed is 90 days. - "minRetentionAllowed": "A String", # Min duration of retention allowed from the DSPM retention control. This field is only populated when event type is set to EVENT_TYPE_MIN_TTL_FROM_CREATION. + "dataRetentionDeletionEvents": [ + { + "dataObjectCount": "A String", + "eventDetectionTime": "A String", + "eventType": "A String", + "maxRetentionAllowed": "A String", + "minRetentionAllowed": "A String", }, ], - "database": { # Represents database access information, such as queries. A database may be a sub-resource of an instance (as in the case of Cloud SQL instances or Cloud Spanner instances), or the database instance itself. Some database resources might not have the [full resource name](https://google.aip.dev/122#full-resource-names) populated because these resource types, such as Cloud SQL databases, are not yet supported by Cloud Asset Inventory. In these cases only the display name is provided. # Database associated with the finding. - "displayName": "A String", # The human-readable name of the database that the user connected to. - "grantees": [ # The target usernames, roles, or groups of an SQL privilege grant, which is not an IAM policy change. + "database": { + "displayName": "A String", + "grantees": [ "A String", ], - "name": "A String", # Some database resources may not have the [full resource name](https://google.aip.dev/122#full-resource-names) populated because these resource types are not yet supported by Cloud Asset Inventory (e.g. Cloud SQL databases). In these cases only the display name will be provided. The [full resource name](https://google.aip.dev/122#full-resource-names) of the database that the user connected to, if it is supported by Cloud Asset Inventory. - "query": "A String", # The SQL statement that is associated with the database access. - "userName": "A String", # The username used to connect to the database. The username might not be an IAM principal and does not have a set format. - "version": "A String", # The version of the database, for example, POSTGRES_14. See [the complete list](https://cloud.google.com/sql/docs/mysql/admin-api/rest/v1/SqlDatabaseVersion). - }, - "description": "A String", # Contains more details about the finding. - "discoveredWorkload": { # Represents discovered, customer managed workload that is not registered with the respective GCP service. # DiscoveredWorkload associated with the finding. - "confidence": "A String", # The confidence in detection of this workload. - "detectedRelevantHardware": True or False, # A boolean flag set to true if associated hardware strongly predicts the workload type. - "detectedRelevantKeywords": True or False, # A boolean flag set to true if associated keywords strongly predict the workload type. - "detectedRelevantPackages": True or False, # A boolean flag set to true if installed packages strongly predict the workload type. - "workloadType": "A String", # The type of workload. - }, - "disk": { # Contains information about the disk associated with the finding. # Disk associated with the finding. - "name": "A String", # The name of the disk, for example, "https://www.googleapis.com/compute/v1/projects/{project-id}/zones/{zone-id}/disks/{disk-id}". - }, - "eventTime": "A String", # The time the finding was first detected. If an existing finding is updated, then this is the time the update occurred. For example, if the finding represents an open firewall, this property captures the time the detector believes the firewall became open. The accuracy is determined by the detector. If the finding is later resolved, then this time reflects when the finding was resolved. This must not be set to a value greater than the current timestamp. - "exfiltration": { # Exfiltration represents a data exfiltration attempt from one or more sources to one or more targets. The `sources` attribute lists the sources of the exfiltrated data. The `targets` attribute lists the destinations the data was copied to. # Represents exfiltrations associated with the finding. - "sources": [ # If there are multiple sources, then the data is considered "joined" between them. For instance, BigQuery can join multiple tables, and each table would be considered a source. - { # Resource where data was exfiltrated from or exfiltrated to. - "components": [ # Subcomponents of the asset that was exfiltrated, like URIs used during exfiltration, table names, databases, and filenames. For example, multiple tables might have been exfiltrated from the same Cloud SQL instance, or multiple files might have been exfiltrated from the same Cloud Storage bucket. + "name": "A String", + "query": "A String", + "userName": "A String", + "version": "A String", + }, + "description": "A String", + "discoveredWorkload": { + "confidence": "A String", + "detectedRelevantHardware": True or False, + "detectedRelevantKeywords": True or False, + "detectedRelevantPackages": True or False, + "workloadType": "A String", + }, + "disk": { + "name": "A String", + }, + "eventTime": "A String", + "exfiltration": { + "sources": [ + { + "components": [ "A String", ], - "name": "A String", # The resource's [full resource name](https://cloud.google.com/apis/design/resource_names#full_resource_name). + "name": "A String", }, ], - "targets": [ # If there are multiple targets, each target would get a complete copy of the "joined" source data. - { # Resource where data was exfiltrated from or exfiltrated to. - "components": [ # Subcomponents of the asset that was exfiltrated, like URIs used during exfiltration, table names, databases, and filenames. For example, multiple tables might have been exfiltrated from the same Cloud SQL instance, or multiple files might have been exfiltrated from the same Cloud Storage bucket. + "targets": [ + { + "components": [ "A String", ], - "name": "A String", # The resource's [full resource name](https://cloud.google.com/apis/design/resource_names#full_resource_name). + "name": "A String", }, ], - "totalExfiltratedBytes": "A String", # Total exfiltrated bytes processed for the entire job. - }, - "externalExposure": { # Details about the externally exposed resource associated with the finding. # External exposure associated with the finding. - "backendBucket": "A String", # The full resource name of the load balancer backend bucket, for example, "//compute.googleapis.com/projects/{project-id}/global/backendBuckets/{name}" - "backendService": "A String", # The full resource name of load balancer backend service, for example, "//compute.googleapis.com/projects/{project-id}/global/backendServices/{name}". - "exposedApplication": "A String", # The name and version of the exposed web application, for example, "Jenkins 2.184". - "exposedEndpoint": "A String", # The resource which is running the exposed service, for example, "//compute.googleapis.com/projects/{project-id}/zones/{zone}/instances/{instance}.” - "exposedService": "A String", # The name and version of the service, for example, "Jupyter Notebook 6.14.0". - "forwardingRule": "A String", # The full resource name of the forwarding rule, for example, "//compute.googleapis.com/projects/{project-id}/global/forwardingRules/{forwarding-rule-name}". - "hostnameUri": "A String", # Hostname of the exposed application, for example, "https://test-app.a.run.app/" - "httpResponse": [ # The http response returned by the web application. - { # The http response returned by the web application. - "path": "A String", # The http path for which response code was returned by web application, for example, "https://test-app.a.run.app/test". - "statusCode": "A String", # The http response code returned by the web application, for example, 200. + "totalExfiltratedBytes": "A String", + }, + "externalExposure": { + "backendBucket": "A String", + "backendService": "A String", + "exposedApplication": "A String", + "exposedEndpoint": "A String", + "exposedService": "A String", + "forwardingRule": "A String", + "hostnameUri": "A String", + "httpResponse": [ + { + "path": "A String", + "statusCode": "A String", }, ], - "instanceGroup": "A String", # The full resource name of the instance group, for example, "//compute.googleapis.com/projects/{project-id}/global/instanceGroups/{name}". - "internalBackendService": "A String", # The full resource name of load balancer backend service in the internal project having resource exposed via PSC, for example, "//compute.googleapis.com/projects/{project-id}/global/backendServices/{name}". - "loadBalancerFirewallPolicy": "A String", # The full resource name of the load balancer firewall policy, for example, "//compute.googleapis.com/projects/{project-id}/global/firewallPolicies/{policy-name}". - "networkEndpointGroup": "A String", # The full resource name of the network endpoint group, for example, "//compute.googleapis.com/projects/{project-id}/global/networkEndpointGroups/{name}". - "networkIngressFirewallPolicy": "A String", # The full resource name of the network ingress firewall policy, for example, "//compute.googleapis.com/projects/{project-id}/global/firewallPolicies/{name}". - "privateIpAddress": "A String", # Private IP address of the exposed endpoint. - "privatePort": "A String", # Port number associated with private IP address. - "pscNetworkAttachment": "A String", # The full resource name of the PSC (Private Service Connect) network attachment that network interface controller is attached to, for example, "//compute.googleapis.com/projects/{project-id}/regions/{region}/networkAttachments/{name}" - "pscServiceAttachment": "A String", # The full resource name of the PSC (Private Service Connect) service attachment that the load balancer network endpoint group targets, for example, "//compute.googleapis.com/projects/{project-id}/regions/{region}/serviceAttachments/{name}" - "publicIpAddress": "A String", # Public IP address of the exposed endpoint. - "publicPort": "A String", # Public port number of the exposed endpoint. - "serviceFirewallPolicy": "A String", # The full resource name of the firewall policy of the exposed service, for example, "//compute.googleapis.com/projects/{project-id}/global/firewallPolicies/{policy-name}". - }, - "externalSystems": { # Output only. Third party SIEM/SOAR fields within SCC, contains external system information and external system finding fields. - "a_key": { # Representation of third party SIEM/SOAR fields within SCC. - "assignees": [ # References primary/secondary etc assignees in the external system. + "instanceGroup": "A String", + "internalBackendService": "A String", + "loadBalancerFirewallPolicy": "A String", + "networkEndpointGroup": "A String", + "networkIngressFirewallPolicy": "A String", + "privateIpAddress": "A String", + "privatePort": "A String", + "pscNetworkAttachment": "A String", + "pscServiceAttachment": "A String", + "publicIpAddress": "A String", + "publicPort": "A String", + "serviceFirewallPolicy": "A String", + }, + "externalSystems": { + "a_key": { + "assignees": [ "A String", ], - "caseCloseTime": "A String", # The time when the case was closed, as reported by the external system. - "caseCreateTime": "A String", # The time when the case was created, as reported by the external system. - "casePriority": "A String", # The priority of the finding's corresponding case in the external system. - "caseSla": "A String", # The SLA of the finding's corresponding case in the external system. - "caseUri": "A String", # The link to the finding's corresponding case in the external system. - "externalSystemUpdateTime": "A String", # The time when the case was last updated, as reported by the external system. - "externalUid": "A String", # The identifier that's used to track the finding's corresponding case in the external system. - "name": "A String", # Full resource name of the external system, for example: "organizations/1234/sources/5678/findings/123456/externalSystems/jira", "folders/1234/sources/5678/findings/123456/externalSystems/jira", "projects/1234/sources/5678/findings/123456/externalSystems/jira" - "status": "A String", # The most recent status of the finding's corresponding case, as reported by the external system. - "ticketInfo": { # Information about the ticket, if any, that is being used to track the resolution of the issue that is identified by this finding. # Information about the ticket, if any, that is being used to track the resolution of the issue that is identified by this finding. - "assignee": "A String", # The assignee of the ticket in the ticket system. - "description": "A String", # The description of the ticket in the ticket system. - "id": "A String", # The identifier of the ticket in the ticket system. - "status": "A String", # The latest status of the ticket, as reported by the ticket system. - "updateTime": "A String", # The time when the ticket was last updated, as reported by the ticket system. - "uri": "A String", # The link to the ticket in the ticket system. + "caseCloseTime": "A String", + "caseCreateTime": "A String", + "casePriority": "A String", + "caseSla": "A String", + "caseUri": "A String", + "externalSystemUpdateTime": "A String", + "externalUid": "A String", + "name": "A String", + "status": "A String", + "ticketInfo": { + "assignee": "A String", + "description": "A String", + "id": "A String", + "status": "A String", + "updateTime": "A String", + "uri": "A String", }, }, }, - "externalUri": "A String", # The URI that, if available, points to a web page outside of Security Command Center where additional information about the finding can be found. This field is guaranteed to be either empty or a well formed URL. - "files": [ # File associated with the finding. - { # File information about the related binary/library used by an executable, or the script used by a script interpreter - "contents": "A String", # Prefix of the file contents as a JSON-encoded string. - "diskPath": { # Path of the file in terms of underlying disk/partition identifiers. # Path of the file in terms of underlying disk/partition identifiers. - "partitionUuid": "A String", # UUID of the partition (format https://wiki.archlinux.org/title/persistent_block_device_naming#by-uuid) - "relativePath": "A String", # Relative path of the file in the partition as a JSON encoded string. Example: /home/user1/executable_file.sh + "externalUri": "A String", + "files": [ + { + "contents": "A String", + "diskPath": { + "partitionUuid": "A String", + "relativePath": "A String", }, - "fileLoadState": "A String", # The load state of the file. - "hashedSize": "A String", # The length in bytes of the file prefix that was hashed. If hashed_size == size, any hashes reported represent the entire file. - "operations": [ # Operation(s) performed on a file. - { # Operation(s) performed on a file. - "type": "A String", # The type of the operation + "fileLoadState": "A String", + "hashedSize": "A String", + "operations": [ + { + "type": "A String", }, ], - "partiallyHashed": True or False, # True when the hash covers only a prefix of the file. - "path": "A String", # Absolute path of the file as a JSON encoded string. - "sha256": "A String", # SHA256 hash of the first hashed_size bytes of the file encoded as a hex string. If hashed_size == size, sha256 represents the SHA256 hash of the entire file. - "size": "A String", # Size of the file in bytes. + "partiallyHashed": True or False, + "path": "A String", + "sha256": "A String", + "size": "A String", }, ], - "findingClass": "A String", # The class of the finding. - "groupMemberships": [ # Contains details about groups of which this finding is a member. A group is a collection of findings that are related in some way. This field cannot be updated. Its value is ignored in all update requests. - { # Contains details about groups of which this finding is a member. A group is a collection of findings that are related in some way. - "groupId": "A String", # ID of the group. - "groupType": "A String", # Type of group. + "findingClass": "A String", + "groupMemberships": [ + { + "groupId": "A String", + "groupType": "A String", }, ], - "iamBindings": [ # Represents IAM bindings associated with the finding. - { # Represents a particular IAM binding, which captures a member's role addition, removal, or state. - "action": "A String", # The action that was performed on a Binding. - "member": "A String", # A single identity requesting access for a Cloud Platform resource, for example, "foo@google.com". - "role": "A String", # Role that is assigned to "members". For example, "roles/viewer", "roles/editor", or "roles/owner". + "iamBindings": [ + { + "action": "A String", + "member": "A String", + "role": "A String", }, ], - "indicator": { # Represents what's commonly known as an _indicator of compromise_ (IoC) in computer forensics. This is an artifact observed on a network or in an operating system that, with high confidence, indicates a computer intrusion. For more information, see [Indicator of compromise](https://en.wikipedia.org/wiki/Indicator_of_compromise). # Represents what's commonly known as an *indicator of compromise* (IoC) in computer forensics. This is an artifact observed on a network or in an operating system that, with high confidence, indicates a computer intrusion. For more information, see [Indicator of compromise](https://en.wikipedia.org/wiki/Indicator_of_compromise). - "domains": [ # List of domains associated to the Finding. + "indicator": { + "domains": [ "A String", ], - "ipAddresses": [ # The list of IP addresses that are associated with the finding. + "ipAddresses": [ "A String", ], - "signatures": [ # The list of matched signatures indicating that the given process is present in the environment. - { # Indicates what signature matched this process. - "memoryHashSignature": { # A signature corresponding to memory page hashes. # Signature indicating that a binary family was matched. - "binaryFamily": "A String", # The binary family. - "detections": [ # The list of memory hash detections contributing to the binary family match. - { # Memory hash detection contributing to the binary family match. - "binary": "A String", # The name of the binary associated with the memory hash signature detection. - "percentPagesMatched": 3.14, # The percentage of memory page hashes in the signature that were matched. + "signatures": [ + { + "memoryHashSignature": { + "binaryFamily": "A String", + "detections": [ + { + "binary": "A String", + "percentPagesMatched": 3.14, }, ], }, - "signatureType": "A String", # Describes the type of resource associated with the signature. - "yaraRuleSignature": { # A signature corresponding to a YARA rule. # Signature indicating that a YARA rule was matched. - "yaraRule": "A String", # The name of the YARA rule. + "signatureType": "A String", + "yaraRuleSignature": { + "yaraRule": "A String", }, }, ], - "uris": [ # The list of URIs associated to the Findings. + "uris": [ "A String", ], }, - "ipRules": { # IP rules associated with the finding. # IP rules associated with the finding. - "allowed": { # Allowed IP rule. # Tuple with allowed rules. - "ipRules": [ # Optional. Optional list of allowed IP rules. - { # IP rule information. - "portRanges": [ # Optional. An optional list of ports to which this rule applies. This field is only applicable for the UDP or (S)TCP protocols. Each entry must be either an integer or a range including a min and max port number. - { # A port range which is inclusive of the min and max values. Values are between 0 and 2^16-1. The max can be equal / must be not smaller than the min value. If min and max are equal this indicates that it is a single port. - "max": "A String", # Maximum port value. - "min": "A String", # Minimum port value. + "ipRules": { + "allowed": { + "ipRules": [ + { + "portRanges": [ + { + "max": "A String", + "min": "A String", }, ], - "protocol": "A String", # The IP protocol this rule applies to. This value can either be one of the following well known protocol strings (TCP, UDP, ICMP, ESP, AH, IPIP, SCTP) or a string representation of the integer value. + "protocol": "A String", }, ], }, - "denied": { # Denied IP rule. # Tuple with denied rules. - "ipRules": [ # Optional. Optional list of denied IP rules. - { # IP rule information. - "portRanges": [ # Optional. An optional list of ports to which this rule applies. This field is only applicable for the UDP or (S)TCP protocols. Each entry must be either an integer or a range including a min and max port number. - { # A port range which is inclusive of the min and max values. Values are between 0 and 2^16-1. The max can be equal / must be not smaller than the min value. If min and max are equal this indicates that it is a single port. - "max": "A String", # Maximum port value. - "min": "A String", # Minimum port value. + "denied": { + "ipRules": [ + { + "portRanges": [ + { + "max": "A String", + "min": "A String", }, ], - "protocol": "A String", # The IP protocol this rule applies to. This value can either be one of the following well known protocol strings (TCP, UDP, ICMP, ESP, AH, IPIP, SCTP) or a string representation of the integer value. + "protocol": "A String", }, ], }, - "destinationIpRanges": [ # If destination IP ranges are specified, the firewall rule applies only to traffic that has a destination IP address in these ranges. These ranges must be expressed in CIDR format. Only supports IPv4. + "destinationIpRanges": [ "A String", ], - "direction": "A String", # The direction that the rule is applicable to, one of ingress or egress. - "exposedServices": [ # Name of the network protocol service, such as FTP, that is exposed by the open port. Follows the naming convention available at: https://www.iana.org/assignments/service-names-port-numbers/service-names-port-numbers.xhtml. + "direction": "A String", + "exposedServices": [ "A String", ], - "sourceIpRanges": [ # If source IP ranges are specified, the firewall rule applies only to traffic that has a source IP address in these ranges. These ranges must be expressed in CIDR format. Only supports IPv4. + "sourceIpRanges": [ "A String", ], }, - "job": { # Describes a job # Job associated with the finding. - "errorCode": 42, # Optional. If the job did not complete successfully, this field describes why. - "location": "A String", # Optional. Gives the location where the job ran, such as `US` or `europe-west1` - "name": "A String", # The fully-qualified name for a job. e.g. `projects//jobs/` - "state": "A String", # Output only. State of the job, such as `RUNNING` or `PENDING`. - }, - "kernelRootkit": { # Kernel mode rootkit signatures. # Signature of the kernel rootkit. - "name": "A String", # Rootkit name, when available. - "unexpectedCodeModification": True or False, # True if unexpected modifications of kernel code memory are present. - "unexpectedFtraceHandler": True or False, # True if `ftrace` points are present with callbacks pointing to regions that are not in the expected kernel or module code range. - "unexpectedInterruptHandler": True or False, # True if interrupt handlers that are are not in the expected kernel or module code regions are present. - "unexpectedKernelCodePages": True or False, # True if kernel code pages that are not in the expected kernel or module code regions are present. - "unexpectedKprobeHandler": True or False, # True if `kprobe` points are present with callbacks pointing to regions that are not in the expected kernel or module code range. - "unexpectedProcessesInRunqueue": True or False, # True if unexpected processes in the scheduler run queue are present. Such processes are in the run queue, but not in the process task list. - "unexpectedReadOnlyDataModification": True or False, # True if unexpected modifications of kernel read-only data memory are present. - "unexpectedSystemCallHandler": True or False, # True if system call handlers that are are not in the expected kernel or module code regions are present. - }, - "kubernetes": { # Kubernetes-related attributes. # Kubernetes resources associated with the finding. - "accessReviews": [ # Provides information on any Kubernetes access reviews (privilege checks) relevant to the finding. - { # Conveys information about a Kubernetes access review (such as one returned by a [`kubectl auth can-i`](https://kubernetes.io/docs/reference/access-authn-authz/authorization/#checking-api-access) command) that was involved in a finding. - "group": "A String", # The API group of the resource. "*" means all. - "name": "A String", # The name of the resource being requested. Empty means all. - "ns": "A String", # Namespace of the action being requested. Currently, there is no distinction between no namespace and all namespaces. Both are represented by "" (empty). - "resource": "A String", # The optional resource type requested. "*" means all. - "subresource": "A String", # The optional subresource type. - "verb": "A String", # A Kubernetes resource API verb, like get, list, watch, create, update, delete, proxy. "*" means all. - "version": "A String", # The API version of the resource. "*" means all. + "job": { + "errorCode": 42, + "location": "A String", + "name": "A String", + "state": "A String", + }, + "kernelRootkit": { + "name": "A String", + "unexpectedCodeModification": True or False, + "unexpectedFtraceHandler": True or False, + "unexpectedInterruptHandler": True or False, + "unexpectedKernelCodePages": True or False, + "unexpectedKprobeHandler": True or False, + "unexpectedProcessesInRunqueue": True or False, + "unexpectedReadOnlyDataModification": True or False, + "unexpectedSystemCallHandler": True or False, + }, + "kubernetes": { + "accessReviews": [ + { + "group": "A String", + "name": "A String", + "ns": "A String", + "resource": "A String", + "subresource": "A String", + "verb": "A String", + "version": "A String", }, ], - "bindings": [ # Provides Kubernetes role binding information for findings that involve [RoleBindings or ClusterRoleBindings](https://cloud.google.com/kubernetes-engine/docs/how-to/role-based-access-control). - { # Represents a Kubernetes RoleBinding or ClusterRoleBinding. - "name": "A String", # Name for the binding. - "ns": "A String", # Namespace for the binding. - "role": { # Kubernetes Role or ClusterRole. # The Role or ClusterRole referenced by the binding. - "kind": "A String", # Role type. - "name": "A String", # Role name. - "ns": "A String", # Role namespace. + "bindings": [ + { + "name": "A String", + "ns": "A String", + "role": { + "kind": "A String", + "name": "A String", + "ns": "A String", }, - "subjects": [ # Represents one or more subjects that are bound to the role. Not always available for PATCH requests. - { # Represents a Kubernetes subject. - "kind": "A String", # Authentication type for the subject. - "name": "A String", # Name for the subject. - "ns": "A String", # Namespace for the subject. + "subjects": [ + { + "kind": "A String", + "name": "A String", + "ns": "A String", }, ], }, ], - "nodePools": [ # GKE [node pools](https://cloud.google.com/kubernetes-engine/docs/concepts/node-pools) associated with the finding. This field contains node pool information for each node, when it is available. - { # Provides GKE node pool information. - "name": "A String", # Kubernetes node pool name. - "nodes": [ # Nodes associated with the finding. - { # Kubernetes nodes associated with the finding. - "name": "A String", # [Full resource name](https://google.aip.dev/122#full-resource-names) of the Compute Engine VM running the cluster node. + "nodePools": [ + { + "name": "A String", + "nodes": [ + { + "name": "A String", }, ], }, ], - "nodes": [ # Provides Kubernetes [node](https://cloud.google.com/kubernetes-engine/docs/concepts/cluster-architecture#nodes) information. - { # Kubernetes nodes associated with the finding. - "name": "A String", # [Full resource name](https://google.aip.dev/122#full-resource-names) of the Compute Engine VM running the cluster node. + "nodes": [ + { + "name": "A String", }, ], - "objects": [ # Kubernetes objects related to the finding. - { # Kubernetes object related to the finding, uniquely identified by GKNN. Used if the object Kind is not one of Pod, Node, NodePool, Binding, or AccessReview. - "containers": [ # Pod containers associated with this finding, if any. - { # Container associated with the finding. - "createTime": "A String", # The time that the container was created. - "imageId": "A String", # Optional container image ID, if provided by the container runtime. Uniquely identifies the container image launched using a container image digest. - "labels": [ # Container labels, as provided by the container runtime. - { # Represents a generic name-value label. A label has separate name and value fields to support filtering with the `contains()` function. For more information, see [Filtering on array-type fields](https://cloud.google.com/security-command-center/docs/how-to-api-list-findings#array-contains-filtering). - "name": "A String", # Name of the label. - "value": "A String", # Value that corresponds to the label's name. + "objects": [ + { + "containers": [ + { + "createTime": "A String", + "imageId": "A String", + "labels": [ + { + "name": "A String", + "value": "A String", }, ], - "name": "A String", # Name of the container. - "uri": "A String", # Container image URI provided when configuring a pod or container. This string can identify a container image version using mutable tags. + "name": "A String", + "uri": "A String", }, ], - "group": "A String", # Kubernetes object group, such as "policy.k8s.io/v1". - "kind": "A String", # Kubernetes object kind, such as "Namespace". - "name": "A String", # Kubernetes object name. For details see https://kubernetes.io/docs/concepts/overview/working-with-objects/names/. - "ns": "A String", # Kubernetes object namespace. Must be a valid DNS label. Named "ns" to avoid collision with C++ namespace keyword. For details see https://kubernetes.io/docs/tasks/administer-cluster/namespaces/. + "group": "A String", + "kind": "A String", + "name": "A String", + "ns": "A String", }, ], - "pods": [ # Kubernetes [Pods](https://cloud.google.com/kubernetes-engine/docs/concepts/pod) associated with the finding. This field contains Pod records for each container that is owned by a Pod. - { # A Kubernetes Pod. - "containers": [ # Pod containers associated with this finding, if any. - { # Container associated with the finding. - "createTime": "A String", # The time that the container was created. - "imageId": "A String", # Optional container image ID, if provided by the container runtime. Uniquely identifies the container image launched using a container image digest. - "labels": [ # Container labels, as provided by the container runtime. - { # Represents a generic name-value label. A label has separate name and value fields to support filtering with the `contains()` function. For more information, see [Filtering on array-type fields](https://cloud.google.com/security-command-center/docs/how-to-api-list-findings#array-contains-filtering). - "name": "A String", # Name of the label. - "value": "A String", # Value that corresponds to the label's name. + "pods": [ + { + "containers": [ + { + "createTime": "A String", + "imageId": "A String", + "labels": [ + { + "name": "A String", + "value": "A String", }, ], - "name": "A String", # Name of the container. - "uri": "A String", # Container image URI provided when configuring a pod or container. This string can identify a container image version using mutable tags. + "name": "A String", + "uri": "A String", }, ], - "labels": [ # Pod labels. For Kubernetes containers, these are applied to the container. - { # Represents a generic name-value label. A label has separate name and value fields to support filtering with the `contains()` function. For more information, see [Filtering on array-type fields](https://cloud.google.com/security-command-center/docs/how-to-api-list-findings#array-contains-filtering). - "name": "A String", # Name of the label. - "value": "A String", # Value that corresponds to the label's name. + "labels": [ + { + "name": "A String", + "value": "A String", }, ], - "name": "A String", # Kubernetes Pod name. - "ns": "A String", # Kubernetes Pod namespace. + "name": "A String", + "ns": "A String", }, ], - "roles": [ # Provides Kubernetes role information for findings that involve [Roles or ClusterRoles](https://cloud.google.com/kubernetes-engine/docs/how-to/role-based-access-control). - { # Kubernetes Role or ClusterRole. - "kind": "A String", # Role type. - "name": "A String", # Role name. - "ns": "A String", # Role namespace. + "roles": [ + { + "kind": "A String", + "name": "A String", + "ns": "A String", }, ], }, - "loadBalancers": [ # The load balancers associated with the finding. - { # Contains information related to the load balancer associated with the finding. - "name": "A String", # The name of the load balancer associated with the finding. + "loadBalancers": [ + { + "name": "A String", }, ], - "logEntries": [ # Log entries that are relevant to the finding. - { # An individual entry in a log. - "cloudLoggingEntry": { # Metadata taken from a [Cloud Logging LogEntry](https://cloud.google.com/logging/docs/reference/v2/rest/v2/LogEntry) # An individual entry in a log stored in Cloud Logging. - "insertId": "A String", # A unique identifier for the log entry. - "logId": "A String", # The type of the log (part of `log_name`. `log_name` is the resource name of the log to which this log entry belongs). For example: `cloudresourcemanager.googleapis.com/activity`. Note that this field is not URL-encoded, unlike the `LOG_ID` field in `LogEntry`. - "resourceContainer": "A String", # The organization, folder, or project of the monitored resource that produced this log entry. - "timestamp": "A String", # The time the event described by the log entry occurred. + "logEntries": [ + { + "cloudLoggingEntry": { + "insertId": "A String", + "logId": "A String", + "resourceContainer": "A String", + "timestamp": "A String", }, }, ], - "mitreAttack": { # MITRE ATT&CK tactics and techniques related to this finding. See: https://attack.mitre.org # MITRE ATT&CK tactics and techniques related to this finding. See: https://attack.mitre.org - "additionalTactics": [ # Additional MITRE ATT&CK tactics related to this finding, if any. + "mitreAttack": { + "additionalTactics": [ "A String", ], - "additionalTechniques": [ # Additional MITRE ATT&CK techniques related to this finding, if any, along with any of their respective parent techniques. + "additionalTechniques": [ "A String", ], - "primaryTactic": "A String", # The MITRE ATT&CK tactic most closely represented by this finding, if any. - "primaryTechniques": [ # The MITRE ATT&CK technique most closely represented by this finding, if any. primary_techniques is a repeated field because there are multiple levels of MITRE ATT&CK techniques. If the technique most closely represented by this finding is a sub-technique (e.g. `SCANNING_IP_BLOCKS`), both the sub-technique and its parent technique(s) will be listed (e.g. `SCANNING_IP_BLOCKS`, `ACTIVE_SCANNING`). + "primaryTactic": "A String", + "primaryTechniques": [ "A String", ], - "version": "A String", # The MITRE ATT&CK version referenced by the above fields. E.g. "8". + "version": "A String", }, - "moduleName": "A String", # Unique identifier of the module which generated the finding. Example: folders/598186756061/securityHealthAnalyticsSettings/customModules/56799441161885 - "mute": "A String", # Indicates the mute state of a finding (either muted, unmuted or undefined). Unlike other attributes of a finding, a finding provider shouldn't set the value of mute. - "muteInfo": { # Mute information about the finding, including whether the finding has a static mute or any matching dynamic mute rules. # Output only. The mute information regarding this finding. - "dynamicMuteRecords": [ # The list of dynamic mute rules that currently match the finding. - { # The record of a dynamic mute rule that matches the finding. - "matchTime": "A String", # When the dynamic mute rule first matched the finding. - "muteConfig": "A String", # The relative resource name of the mute rule, represented by a mute config, that created this record, for example `organizations/123/muteConfigs/mymuteconfig` or `organizations/123/locations/global/muteConfigs/mymuteconfig`. + "moduleName": "A String", + "mute": "A String", + "muteInfo": { + "dynamicMuteRecords": [ + { + "matchTime": "A String", + "muteConfig": "A String", }, ], - "staticMute": { # Information about the static mute state. A static mute state overrides any dynamic mute rules that apply to this finding. The static mute state can be set by a static mute rule or by muting the finding directly. # If set, the static mute applied to this finding. Static mutes override dynamic mutes. If unset, there is no static mute. - "applyTime": "A String", # When the static mute was applied. - "state": "A String", # The static mute state. If the value is `MUTED` or `UNMUTED`, then the finding's overall mute state will have the same value. + "staticMute": { + "applyTime": "A String", + "state": "A String", }, }, - "muteInitiator": "A String", # Records additional information about the mute operation, for example, the [mute configuration](/security-command-center/docs/how-to-mute-findings) that muted the finding and the user who muted the finding. - "muteUpdateTime": "A String", # Output only. The most recent time this finding was muted or unmuted. - "name": "A String", # The [relative resource name](https://cloud.google.com/apis/design/resource_names#relative_resource_name) of the finding. Example: "organizations/{organization_id}/sources/{source_id}/findings/{finding_id}", "folders/{folder_id}/sources/{source_id}/findings/{finding_id}", "projects/{project_id}/sources/{source_id}/findings/{finding_id}". - "networks": [ # Represents the VPC networks that the resource is attached to. - { # Contains information about a VPC network associated with the finding. - "name": "A String", # The name of the VPC network resource, for example, `//compute.googleapis.com/projects/my-project/global/networks/my-network`. + "muteInitiator": "A String", + "muteUpdateTime": "A String", + "name": "A String", + "networks": [ + { + "name": "A String", }, ], - "nextSteps": "A String", # Steps to address the finding. - "notebook": { # Represents a Jupyter notebook IPYNB file, such as a [Colab Enterprise notebook](https://cloud.google.com/colab/docs/introduction) file, that is associated with a finding. # Notebook associated with the finding. - "lastAuthor": "A String", # The user ID of the latest author to modify the notebook. - "name": "A String", # The name of the notebook. - "notebookUpdateTime": "A String", # The most recent time the notebook was updated. - "service": "A String", # The source notebook service, for example, "Colab Enterprise". + "nextSteps": "A String", + "notebook": { + "lastAuthor": "A String", + "name": "A String", + "notebookUpdateTime": "A String", + "service": "A String", }, - "orgPolicies": [ # Contains information about the org policies associated with the finding. - { # Contains information about the org policies associated with the finding. - "name": "A String", # The resource name of the org policy. Example: "organizations/{organization_id}/policies/{constraint_name}" + "orgPolicies": [ + { + "name": "A String", }, ], - "parent": "A String", # The relative resource name of the source the finding belongs to. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name This field is immutable after creation time. For example: "organizations/{organization_id}/sources/{source_id}" - "parentDisplayName": "A String", # Output only. The human readable display name of the finding source such as "Event Threat Detection" or "Security Health Analytics". - "policyViolationSummary": { # Metadata summarizing policy violations of child resources of the affected resource. `finding_category` and `resource` determine the exact semantics of the counts. For example, when category=DATA_SECURITY_POSTURE_OBJECT_PUBLIC_ACCESS_VIOLATION and resource='storage.googleapis.com/buckets/my-bucket-name' then this counts the number of Cloud Storage objects in my-bucket-name which violate a Public Access control. # PolicyViolationSummary associated with the finding. - "conformantResourcesCount": "A String", # Total number of child resources that conform to the policy. - "evaluationErrorsCount": "A String", # Number of child resources for which errors during evaluation occurred. The evaluation result for these child resources is effectively "unknown". - "outOfScopeResourcesCount": "A String", # Total count of child resources which were not in scope for evaluation. - "policyViolationsCount": "A String", # Count of child resources in violation of the policy. - }, - "processes": [ # Represents operating system processes associated with the Finding. - { # Represents an operating system process. - "args": [ # Process arguments as JSON encoded strings. + "parent": "A String", + "parentDisplayName": "A String", + "policyViolationSummary": { + "conformantResourcesCount": "A String", + "evaluationErrorsCount": "A String", + "outOfScopeResourcesCount": "A String", + "policyViolationsCount": "A String", + }, + "processes": [ + { + "args": [ "A String", ], - "argumentsTruncated": True or False, # True if `args` is incomplete. - "binary": { # File information about the related binary/library used by an executable, or the script used by a script interpreter # File information for the process executable. - "contents": "A String", # Prefix of the file contents as a JSON-encoded string. - "diskPath": { # Path of the file in terms of underlying disk/partition identifiers. # Path of the file in terms of underlying disk/partition identifiers. - "partitionUuid": "A String", # UUID of the partition (format https://wiki.archlinux.org/title/persistent_block_device_naming#by-uuid) - "relativePath": "A String", # Relative path of the file in the partition as a JSON encoded string. Example: /home/user1/executable_file.sh + "argumentsTruncated": True or False, + "binary": { + "contents": "A String", + "diskPath": { + "partitionUuid": "A String", + "relativePath": "A String", }, - "fileLoadState": "A String", # The load state of the file. - "hashedSize": "A String", # The length in bytes of the file prefix that was hashed. If hashed_size == size, any hashes reported represent the entire file. - "operations": [ # Operation(s) performed on a file. - { # Operation(s) performed on a file. - "type": "A String", # The type of the operation + "fileLoadState": "A String", + "hashedSize": "A String", + "operations": [ + { + "type": "A String", }, ], - "partiallyHashed": True or False, # True when the hash covers only a prefix of the file. - "path": "A String", # Absolute path of the file as a JSON encoded string. - "sha256": "A String", # SHA256 hash of the first hashed_size bytes of the file encoded as a hex string. If hashed_size == size, sha256 represents the SHA256 hash of the entire file. - "size": "A String", # Size of the file in bytes. + "partiallyHashed": True or False, + "path": "A String", + "sha256": "A String", + "size": "A String", }, - "envVariables": [ # Process environment variables. - { # A name-value pair representing an environment variable used in an operating system process. - "name": "A String", # Environment variable name as a JSON encoded string. - "val": "A String", # Environment variable value as a JSON encoded string. + "envVariables": [ + { + "name": "A String", + "val": "A String", }, ], - "envVariablesTruncated": True or False, # True if `env_variables` is incomplete. - "libraries": [ # File information for libraries loaded by the process. - { # File information about the related binary/library used by an executable, or the script used by a script interpreter - "contents": "A String", # Prefix of the file contents as a JSON-encoded string. - "diskPath": { # Path of the file in terms of underlying disk/partition identifiers. # Path of the file in terms of underlying disk/partition identifiers. - "partitionUuid": "A String", # UUID of the partition (format https://wiki.archlinux.org/title/persistent_block_device_naming#by-uuid) - "relativePath": "A String", # Relative path of the file in the partition as a JSON encoded string. Example: /home/user1/executable_file.sh + "envVariablesTruncated": True or False, + "libraries": [ + { + "contents": "A String", + "diskPath": { + "partitionUuid": "A String", + "relativePath": "A String", }, - "fileLoadState": "A String", # The load state of the file. - "hashedSize": "A String", # The length in bytes of the file prefix that was hashed. If hashed_size == size, any hashes reported represent the entire file. - "operations": [ # Operation(s) performed on a file. - { # Operation(s) performed on a file. - "type": "A String", # The type of the operation + "fileLoadState": "A String", + "hashedSize": "A String", + "operations": [ + { + "type": "A String", }, ], - "partiallyHashed": True or False, # True when the hash covers only a prefix of the file. - "path": "A String", # Absolute path of the file as a JSON encoded string. - "sha256": "A String", # SHA256 hash of the first hashed_size bytes of the file encoded as a hex string. If hashed_size == size, sha256 represents the SHA256 hash of the entire file. - "size": "A String", # Size of the file in bytes. + "partiallyHashed": True or False, + "path": "A String", + "sha256": "A String", + "size": "A String", }, ], - "name": "A String", # The process name, as displayed in utilities like `top` and `ps`. This name can be accessed through `/proc/[pid]/comm` and changed with `prctl(PR_SET_NAME)`. - "parentPid": "A String", # The parent process ID. - "pid": "A String", # The process ID. - "script": { # File information about the related binary/library used by an executable, or the script used by a script interpreter # When the process represents the invocation of a script, `binary` provides information about the interpreter, while `script` provides information about the script file provided to the interpreter. - "contents": "A String", # Prefix of the file contents as a JSON-encoded string. - "diskPath": { # Path of the file in terms of underlying disk/partition identifiers. # Path of the file in terms of underlying disk/partition identifiers. - "partitionUuid": "A String", # UUID of the partition (format https://wiki.archlinux.org/title/persistent_block_device_naming#by-uuid) - "relativePath": "A String", # Relative path of the file in the partition as a JSON encoded string. Example: /home/user1/executable_file.sh + "name": "A String", + "parentPid": "A String", + "pid": "A String", + "script": { + "contents": "A String", + "diskPath": { + "partitionUuid": "A String", + "relativePath": "A String", }, - "fileLoadState": "A String", # The load state of the file. - "hashedSize": "A String", # The length in bytes of the file prefix that was hashed. If hashed_size == size, any hashes reported represent the entire file. - "operations": [ # Operation(s) performed on a file. - { # Operation(s) performed on a file. - "type": "A String", # The type of the operation + "fileLoadState": "A String", + "hashedSize": "A String", + "operations": [ + { + "type": "A String", }, ], - "partiallyHashed": True or False, # True when the hash covers only a prefix of the file. - "path": "A String", # Absolute path of the file as a JSON encoded string. - "sha256": "A String", # SHA256 hash of the first hashed_size bytes of the file encoded as a hex string. If hashed_size == size, sha256 represents the SHA256 hash of the entire file. - "size": "A String", # Size of the file in bytes. + "partiallyHashed": True or False, + "path": "A String", + "sha256": "A String", + "size": "A String", }, - "userId": "A String", # The ID of the user that executed the process. E.g. If this is the root user this will always be 0. + "userId": "A String", }, ], - "resourceName": "A String", # For findings on Google Cloud resources, the full resource name of the Google Cloud resource this finding is for. See: https://cloud.google.com/apis/design/resource_names#full_resource_name When the finding is for a non-Google Cloud resource, the resourceName can be a customer or partner defined string. This field is immutable after creation time. - "secret": { # Details about a secret or credential associated with the finding. # Secret associated with the finding. - "environmentVariable": { # Environment variable containing the secret. # The environment variable containing the secret. - "key": "A String", # Environment variable name as a JSON encoded string. Note that value is not included since the value contains the secret data, which is sensitive core content. + "resourceName": "A String", + "secret": { + "environmentVariable": { + "key": "A String", }, - "filePath": { # File path containing the secret. # The file containing the secret. - "path": "A String", # Path to the file. + "filePath": { + "path": "A String", }, - "status": { # The status of the secret. # The status of the secret. - "lastUpdatedTime": "A String", # Time that the secret was found. - "validity": "A String", # The validity of the secret. + "status": { + "lastUpdatedTime": "A String", + "validity": "A String", }, - "type": "A String", # The type of secret, for example, GCP_API_KEY. + "type": "A String", }, - "securityMarks": { # User specified security marks that are attached to the parent Security Command Center resource. Security marks are scoped within a Security Command Center organization -- they can be modified and viewed by all users who have proper permissions on the organization. # Output only. User specified security marks. These marks are entirely managed by the user and come from the SecurityMarks resource that belongs to the finding. - "canonicalName": "A String", # The canonical name of the marks. Examples: "organizations/{organization_id}/assets/{asset_id}/securityMarks" "folders/{folder_id}/assets/{asset_id}/securityMarks" "projects/{project_number}/assets/{asset_id}/securityMarks" "organizations/{organization_id}/sources/{source_id}/findings/{finding_id}/securityMarks" "folders/{folder_id}/sources/{source_id}/findings/{finding_id}/securityMarks" "projects/{project_number}/sources/{source_id}/findings/{finding_id}/securityMarks" - "marks": { # Mutable user specified security marks belonging to the parent resource. Constraints are as follows: * Keys and values are treated as case insensitive * Keys must be between 1 - 256 characters (inclusive) * Keys must be letters, numbers, underscores, or dashes * Values have leading and trailing whitespace trimmed, remaining characters must be between 1 - 4096 characters (inclusive) + "securityMarks": { + "canonicalName": "A String", + "marks": { "a_key": "A String", }, - "name": "A String", # The relative resource name of the SecurityMarks. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Examples: "organizations/{organization_id}/assets/{asset_id}/securityMarks" "organizations/{organization_id}/sources/{source_id}/findings/{finding_id}/securityMarks". - }, - "securityPosture": { # Represents a posture that is deployed on Google Cloud by the Security Command Center Posture Management service. A posture contains one or more policy sets. A policy set is a group of policies that enforce a set of security rules on Google Cloud. # The security posture associated with the finding. - "changedPolicy": "A String", # The name of the updated policy, for example, `projects/{project_id}/policies/{constraint_name}`. - "name": "A String", # Name of the posture, for example, `CIS-Posture`. - "policy": "A String", # The ID of the updated policy, for example, `compute-policy-1`. - "policyDriftDetails": [ # The details about a change in an updated policy that violates the deployed posture. - { # The policy field that violates the deployed posture and its expected and detected values. - "detectedValue": "A String", # The detected value that violates the deployed posture, for example, `false` or `allowed_values={"projects/22831892"}`. - "expectedValue": "A String", # The value of this field that was configured in a posture, for example, `true` or `allowed_values={"projects/29831892"}`. - "field": "A String", # The name of the updated field, for example constraint.implementation.policy_rules[0].enforce + "name": "A String", + }, + "securityPosture": { + "changedPolicy": "A String", + "name": "A String", + "policy": "A String", + "policyDriftDetails": [ + { + "detectedValue": "A String", + "expectedValue": "A String", + "field": "A String", }, ], - "policySet": "A String", # The name of the updated policyset, for example, `cis-policyset`. - "postureDeployment": "A String", # The name of the posture deployment, for example, `organizations/{org_id}/posturedeployments/{posture_deployment_id}`. - "postureDeploymentResource": "A String", # The project, folder, or organization on which the posture is deployed, for example, `projects/{project_number}`. - "revisionId": "A String", # The version of the posture, for example, `c7cfa2a8`. + "policySet": "A String", + "postureDeployment": "A String", + "postureDeploymentResource": "A String", + "revisionId": "A String", }, - "severity": "A String", # The severity of the finding. This field is managed by the source that writes the finding. - "sourceProperties": { # Source specific properties. These properties are managed by the source that writes the finding. The key names in the source_properties map must be between 1 and 255 characters, and must start with a letter and contain alphanumeric characters or underscores only. + "severity": "A String", + "sourceProperties": { "a_key": "", }, - "state": "A String", # The state of the finding. - "toxicCombination": { # Contains details about a group of security issues that, when the issues occur together, represent a greater risk than when the issues occur independently. A group of such issues is referred to as a toxic combination. # Contains details about a group of security issues that, when the issues occur together, represent a greater risk than when the issues occur independently. A group of such issues is referred to as a toxic combination. This field cannot be updated. Its value is ignored in all update requests. - "attackExposureScore": 3.14, # The [Attack exposure score](https://cloud.google.com/security-command-center/docs/attack-exposure-learn#attack_exposure_scores) of this toxic combination. The score is a measure of how much this toxic combination exposes one or more high-value resources to potential attack. - "relatedFindings": [ # List of resource names of findings associated with this toxic combination. For example, `organizations/123/sources/456/findings/789`. + "state": "A String", + "toxicCombination": { + "attackExposureScore": 3.14, + "relatedFindings": [ "A String", ], }, - "vertexAi": { # Vertex AI-related information associated with the finding. # VertexAi associated with the finding. - "datasets": [ # Datasets associated with the finding. - { # Vertex AI dataset associated with the finding. - "displayName": "A String", # The user defined display name of dataset, e.g. plants-dataset - "name": "A String", # Resource name of the dataset, e.g. projects/{project}/locations/{location}/datasets/2094040236064505856 - "source": "A String", # Data source, such as BigQuery source URI, e.g. bq://scc-nexus-test.AIPPtest.gsod + "vertexAi": { + "datasets": [ + { + "displayName": "A String", + "name": "A String", + "source": "A String", }, ], - "pipelines": [ # Pipelines associated with the finding. - { # Vertex AI training pipeline associated with the finding. - "displayName": "A String", # The user defined display name of pipeline, e.g. plants-classification - "name": "A String", # Resource name of the pipeline, e.g. projects/{project}/locations/{location}/trainingPipelines/5253428229225578496 + "pipelines": [ + { + "displayName": "A String", + "name": "A String", }, ], }, - "vulnerability": { # Refers to common vulnerability fields e.g. cve, cvss, cwe etc. # Represents vulnerability-specific fields like CVE and CVSS scores. CVE stands for Common Vulnerabilities and Exposures (https://cve.mitre.org/about/) - "cve": { # CVE stands for Common Vulnerabilities and Exposures. Information from the [CVE record](https://www.cve.org/ResourcesSupport/Glossary) that describes this vulnerability. # CVE stands for Common Vulnerabilities and Exposures (https://cve.mitre.org/about/) - "cvssv3": { # Common Vulnerability Scoring System version 3. # Describe Common Vulnerability Scoring System specified at https://www.first.org/cvss/v3.1/specification-document - "attackComplexity": "A String", # This metric describes the conditions beyond the attacker's control that must exist in order to exploit the vulnerability. - "attackVector": "A String", # Base Metrics Represents the intrinsic characteristics of a vulnerability that are constant over time and across user environments. This metric reflects the context by which vulnerability exploitation is possible. - "availabilityImpact": "A String", # This metric measures the impact to the availability of the impacted component resulting from a successfully exploited vulnerability. - "baseScore": 3.14, # The base score is a function of the base metric scores. - "confidentialityImpact": "A String", # This metric measures the impact to the confidentiality of the information resources managed by a software component due to a successfully exploited vulnerability. - "integrityImpact": "A String", # This metric measures the impact to integrity of a successfully exploited vulnerability. - "privilegesRequired": "A String", # This metric describes the level of privileges an attacker must possess before successfully exploiting the vulnerability. - "scope": "A String", # The Scope metric captures whether a vulnerability in one vulnerable component impacts resources in components beyond its security scope. - "userInteraction": "A String", # This metric captures the requirement for a human user, other than the attacker, to participate in the successful compromise of the vulnerable component. + "vulnerability": { + "cve": { + "cvssv3": { + "attackComplexity": "A String", + "attackVector": "A String", + "availabilityImpact": "A String", + "baseScore": 3.14, + "confidentialityImpact": "A String", + "integrityImpact": "A String", + "privilegesRequired": "A String", + "scope": "A String", + "userInteraction": "A String", }, - "exploitReleaseDate": "A String", # Date the first publicly available exploit or PoC was released. - "exploitationActivity": "A String", # The exploitation activity of the vulnerability in the wild. - "firstExploitationDate": "A String", # Date of the earliest known exploitation. - "id": "A String", # The unique identifier for the vulnerability. e.g. CVE-2021-34527 - "impact": "A String", # The potential impact of the vulnerability if it was to be exploited. - "observedInTheWild": True or False, # Whether or not the vulnerability has been observed in the wild. - "references": [ # Additional information about the CVE. e.g. https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2021-34527 - { # Additional Links - "source": "A String", # Source of the reference e.g. NVD - "uri": "A String", # Uri for the mentioned source e.g. https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2021-34527. + "exploitReleaseDate": "A String", + "exploitationActivity": "A String", + "firstExploitationDate": "A String", + "id": "A String", + "impact": "A String", + "observedInTheWild": True or False, + "references": [ + { + "source": "A String", + "uri": "A String", }, ], - "upstreamFixAvailable": True or False, # Whether upstream fix is available for the CVE. - "zeroDay": True or False, # Whether or not the vulnerability was zero day when the finding was published. - }, - "cwes": [ # Represents one or more Common Weakness Enumeration (CWE) information on this vulnerability. - { # CWE stands for Common Weakness Enumeration. Information about this weakness, as described by [CWE](https://cwe.mitre.org/). - "id": "A String", # The CWE identifier, e.g. CWE-94 - "references": [ # Any reference to the details on the CWE, for example, https://cwe.mitre.org/data/definitions/94.html - { # Additional Links - "source": "A String", # Source of the reference e.g. NVD - "uri": "A String", # Uri for the mentioned source e.g. https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2021-34527. + "upstreamFixAvailable": True or False, + "zeroDay": True or False, + }, + "cwes": [ + { + "id": "A String", + "references": [ + { + "source": "A String", + "uri": "A String", }, ], }, ], - "fixedPackage": { # Package is a generic definition of a package. # The fixed package is relevant to the finding. - "cpeUri": "A String", # The CPE URI where the vulnerability was detected. - "packageName": "A String", # The name of the package where the vulnerability was detected. - "packageType": "A String", # Type of package, for example, os, maven, or go. - "packageVersion": "A String", # The version of the package. + "fixedPackage": { + "cpeUri": "A String", + "packageName": "A String", + "packageType": "A String", + "packageVersion": "A String", }, - "offendingPackage": { # Package is a generic definition of a package. # The offending package is relevant to the finding. - "cpeUri": "A String", # The CPE URI where the vulnerability was detected. - "packageName": "A String", # The name of the package where the vulnerability was detected. - "packageType": "A String", # Type of package, for example, os, maven, or go. - "packageVersion": "A String", # The version of the package. + "offendingPackage": { + "cpeUri": "A String", + "packageName": "A String", + "packageType": "A String", + "packageVersion": "A String", }, - "providerRiskScore": "A String", # Provider provided risk_score based on multiple factors. The higher the risk score, the more risky the vulnerability is. - "reachable": True or False, # Represents whether the vulnerability is reachable (detected via static analysis) - "securityBulletin": { # SecurityBulletin are notifications of vulnerabilities of Google products. # The security bulletin is relevant to this finding. - "bulletinId": "A String", # ID of the bulletin corresponding to the vulnerability. - "submissionTime": "A String", # Submission time of this Security Bulletin. - "suggestedUpgradeVersion": "A String", # This represents a version that the cluster receiving this notification should be upgraded to, based on its current version. For example, 1.15.0 + "providerRiskScore": "A String", + "reachable": True or False, + "securityBulletin": { + "bulletinId": "A String", + "submissionTime": "A String", + "suggestedUpgradeVersion": "A String", }, }, }
@@ -4446,23 +4446,23 @@

Method Details

updateSecurityMarks(name, body=None, startTime=None, updateMask=None, x__xgafv=None) -
Updates security marks.
+  
 
 Args:
-  name: string, The relative resource name of the SecurityMarks. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Examples: "organizations/{organization_id}/assets/{asset_id}/securityMarks" "organizations/{organization_id}/sources/{source_id}/findings/{finding_id}/securityMarks". (required)
+  name: string, A parameter (required)
   body: object, The request body.
     The object takes the form of:
 
-{ # User specified security marks that are attached to the parent Security Command Center resource. Security marks are scoped within a Security Command Center organization -- they can be modified and viewed by all users who have proper permissions on the organization.
-  "canonicalName": "A String", # The canonical name of the marks. Examples: "organizations/{organization_id}/assets/{asset_id}/securityMarks" "folders/{folder_id}/assets/{asset_id}/securityMarks" "projects/{project_number}/assets/{asset_id}/securityMarks" "organizations/{organization_id}/sources/{source_id}/findings/{finding_id}/securityMarks" "folders/{folder_id}/sources/{source_id}/findings/{finding_id}/securityMarks" "projects/{project_number}/sources/{source_id}/findings/{finding_id}/securityMarks"
-  "marks": { # Mutable user specified security marks belonging to the parent resource. Constraints are as follows: * Keys and values are treated as case insensitive * Keys must be between 1 - 256 characters (inclusive) * Keys must be letters, numbers, underscores, or dashes * Values have leading and trailing whitespace trimmed, remaining characters must be between 1 - 4096 characters (inclusive)
+{
+  "canonicalName": "A String",
+  "marks": {
     "a_key": "A String",
   },
-  "name": "A String", # The relative resource name of the SecurityMarks. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Examples: "organizations/{organization_id}/assets/{asset_id}/securityMarks" "organizations/{organization_id}/sources/{source_id}/findings/{finding_id}/securityMarks".
+  "name": "A String",
 }
 
-  startTime: string, The time at which the updated SecurityMarks take effect. If not set uses current server time. Updates will be applied to the SecurityMarks that are active immediately preceding this time. Must be earlier or equal to the server time.
-  updateMask: string, The FieldMask to use when updating the security marks resource. The field mask must not contain duplicate fields. If empty or set to "marks", all marks will be replaced. Individual marks can be updated using "marks.".
+  startTime: string, A parameter
+  updateMask: string, A parameter
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -4471,12 +4471,12 @@ 

Method Details

Returns: An object of the form: - { # User specified security marks that are attached to the parent Security Command Center resource. Security marks are scoped within a Security Command Center organization -- they can be modified and viewed by all users who have proper permissions on the organization. - "canonicalName": "A String", # The canonical name of the marks. Examples: "organizations/{organization_id}/assets/{asset_id}/securityMarks" "folders/{folder_id}/assets/{asset_id}/securityMarks" "projects/{project_number}/assets/{asset_id}/securityMarks" "organizations/{organization_id}/sources/{source_id}/findings/{finding_id}/securityMarks" "folders/{folder_id}/sources/{source_id}/findings/{finding_id}/securityMarks" "projects/{project_number}/sources/{source_id}/findings/{finding_id}/securityMarks" - "marks": { # Mutable user specified security marks belonging to the parent resource. Constraints are as follows: * Keys and values are treated as case insensitive * Keys must be between 1 - 256 characters (inclusive) * Keys must be letters, numbers, underscores, or dashes * Values have leading and trailing whitespace trimmed, remaining characters must be between 1 - 4096 characters (inclusive) + { + "canonicalName": "A String", + "marks": { "a_key": "A String", }, - "name": "A String", # The relative resource name of the SecurityMarks. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Examples: "organizations/{organization_id}/assets/{asset_id}/securityMarks" "organizations/{organization_id}/sources/{source_id}/findings/{finding_id}/securityMarks". + "name": "A String", }
diff --git a/docs/dyn/securitycenter_v1.folders.sources.html b/docs/dyn/securitycenter_v1.folders.sources.html index f25c7954d3..3120c37893 100644 --- a/docs/dyn/securitycenter_v1.folders.sources.html +++ b/docs/dyn/securitycenter_v1.folders.sources.html @@ -84,7 +84,7 @@

Instance Methods

Close httplib2 connections.

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

-

Lists all sources belonging to an organization.

+

list_next()

Retrieves the next page of results.

@@ -96,12 +96,12 @@

Method Details

list(parent, pageSize=None, pageToken=None, x__xgafv=None) -
Lists all sources belonging to an organization.
+  
 
 Args:
-  parent: string, Required. Resource name of the parent of sources to list. Its format should be `organizations/[organization_id]`, `folders/[folder_id]`, or `projects/[project_id]`. (required)
-  pageSize: integer, The maximum number of results to return in a single response. Default is 10, minimum is 1, maximum is 1000.
-  pageToken: string, The value returned by the last `ListSourcesResponse`; indicates that this is a continuation of a prior `ListSources` call, and that the system should return the next page of data.
+  parent: string, A parameter (required)
+  pageSize: integer, A parameter
+  pageToken: string, A parameter
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -110,14 +110,14 @@ 

Method Details

Returns: An object of the form: - { # Response message for listing sources. - "nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no more results. - "sources": [ # Sources belonging to the requested parent. - { # Security Command Center finding source. A finding source is an entity or a mechanism that can produce a finding. A source is like a container of findings that come from the same scanner, logger, monitor, and other tools. - "canonicalName": "A String", # The canonical name of the finding source. It's either "organizations/{organization_id}/sources/{source_id}", "folders/{folder_id}/sources/{source_id}", or "projects/{project_number}/sources/{source_id}", depending on the closest CRM ancestor of the resource associated with the finding. - "description": "A String", # The description of the source (max of 1024 characters). Example: "Web Security Scanner is a web security scanner for common vulnerabilities in App Engine applications. It can automatically scan and detect four common vulnerabilities, including cross-site-scripting (XSS), Flash injection, mixed content (HTTP in HTTPS), and outdated or insecure libraries." - "displayName": "A String", # The source's display name. A source's display name must be unique amongst its siblings, for example, two sources with the same parent can't share the same display name. The display name must have a length between 1 and 64 characters (inclusive). - "name": "A String", # The relative resource name of this source. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Example: "organizations/{organization_id}/sources/{source_id}" + { + "nextPageToken": "A String", + "sources": [ + { + "canonicalName": "A String", + "description": "A String", + "displayName": "A String", + "name": "A String", }, ], }
diff --git a/docs/dyn/securitycenter_v1.organizations.assets.html b/docs/dyn/securitycenter_v1.organizations.assets.html index ea859744a5..8fdfd60344 100644 --- a/docs/dyn/securitycenter_v1.organizations.assets.html +++ b/docs/dyn/securitycenter_v1.organizations.assets.html @@ -79,22 +79,22 @@

Instance Methods

Close httplib2 connections.

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

-

Filters an organization's assets and groups them by their specified properties.

+

group_next()

Retrieves the next page of results.

list(parent, compareDuration=None, fieldMask=None, filter=None, orderBy=None, pageSize=None, pageToken=None, readTime=None, x__xgafv=None)

-

Lists an organization's assets.

+

list_next()

Retrieves the next page of results.

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

-

Runs asset discovery. The discovery is tracked with a long-running operation. This API can only be called with limited frequency for an organization. If it is called too frequently the caller will receive a TOO_MANY_REQUESTS error.

+

updateSecurityMarks(name, body=None, startTime=None, updateMask=None, x__xgafv=None)

-

Updates security marks.

+

Method Details

close() @@ -103,20 +103,20 @@

Method Details

group(parent, body=None, x__xgafv=None) -
Filters an organization's assets and groups them by their specified properties.
+  
 
 Args:
-  parent: string, Required. The name of the parent to group the assets by. Its format is `organizations/[organization_id]`, `folders/[folder_id]`, or `projects/[project_id]`. (required)
+  parent: string, A parameter (required)
   body: object, The request body.
     The object takes the form of:
 
-{ # Request message for grouping by assets.
-  "compareDuration": "A String", # When compare_duration is set, the GroupResult's "state_change" property is updated to indicate whether the asset was added, removed, or remained present during the compare_duration period of time that precedes the read_time. This is the time between (read_time - compare_duration) and read_time. The state change value is derived based on the presence of the asset at the two points in time. Intermediate state changes between the two times don't affect the result. For example, the results aren't affected if the asset is removed and re-created again. Possible "state_change" values when compare_duration is specified: * "ADDED": indicates that the asset was not present at the start of compare_duration, but present at reference_time. * "REMOVED": indicates that the asset was present at the start of compare_duration, but not present at reference_time. * "ACTIVE": indicates that the asset was present at both the start and the end of the time period defined by compare_duration and reference_time. If compare_duration is not specified, then the only possible state_change is "UNUSED", which will be the state_change set for all assets present at read_time. If this field is set then `state_change` must be a specified field in `group_by`.
-  "filter": "A String", # Expression that defines the filter to apply across assets. The expression is a list of zero or more restrictions combined via logical operators `AND` and `OR`. Parentheses are supported, and `OR` has higher precedence than `AND`. Restrictions have the form ` ` and may have a `-` character in front of them to indicate negation. The fields map to those defined in the Asset resource. Examples include: * name * security_center_properties.resource_name * resource_properties.a_property * security_marks.marks.marka The supported operators are: * `=` for all value types. * `>`, `<`, `>=`, `<=` for integer values. * `:`, meaning substring matching, for strings. The supported value types are: * string literals in quotes. * integer literals without quotes. * boolean literals `true` and `false` without quotes. The following field and operator combinations are supported: * name: `=` * update_time: `=`, `>`, `<`, `>=`, `<=` Usage: This should be milliseconds since epoch or an RFC3339 string. Examples: `update_time = "2019-06-10T16:07:18-07:00"` `update_time = 1560208038000` * create_time: `=`, `>`, `<`, `>=`, `<=` Usage: This should be milliseconds since epoch or an RFC3339 string. Examples: `create_time = "2019-06-10T16:07:18-07:00"` `create_time = 1560208038000` * iam_policy.policy_blob: `=`, `:` * resource_properties: `=`, `:`, `>`, `<`, `>=`, `<=` * security_marks.marks: `=`, `:` * security_center_properties.resource_name: `=`, `:` * security_center_properties.resource_display_name: `=`, `:` * security_center_properties.resource_type: `=`, `:` * security_center_properties.resource_parent: `=`, `:` * security_center_properties.resource_parent_display_name: `=`, `:` * security_center_properties.resource_project: `=`, `:` * security_center_properties.resource_project_display_name: `=`, `:` * security_center_properties.resource_owners: `=`, `:` For example, `resource_properties.size = 100` is a valid filter string. Use a partial match on the empty string to filter based on a property existing: `resource_properties.my_property : ""` Use a negated partial match on the empty string to filter based on a property not existing: `-resource_properties.my_property : ""`
-  "groupBy": "A String", # Required. Expression that defines what assets fields to use for grouping. The string value should follow SQL syntax: comma separated list of fields. For example: "security_center_properties.resource_project,security_center_properties.project". The following fields are supported when compare_duration is not set: * security_center_properties.resource_project * security_center_properties.resource_project_display_name * security_center_properties.resource_type * security_center_properties.resource_parent * security_center_properties.resource_parent_display_name The following fields are supported when compare_duration is set: * security_center_properties.resource_type * security_center_properties.resource_project_display_name * security_center_properties.resource_parent_display_name
-  "pageSize": 42, # The maximum number of results to return in a single response. Default is 10, minimum is 1, maximum is 1000.
-  "pageToken": "A String", # The value returned by the last `GroupAssetsResponse`; indicates that this is a continuation of a prior `GroupAssets` call, and that the system should return the next page of data.
-  "readTime": "A String", # Time used as a reference point when filtering assets. The filter is limited to assets existing at the supplied time and their values are those at that specific time. Absence of this field will default to the API's version of NOW.
+{
+  "compareDuration": "A String",
+  "filter": "A String",
+  "groupBy": "A String",
+  "pageSize": 42,
+  "pageToken": "A String",
+  "readTime": "A String",
 }
 
   x__xgafv: string, V1 error format.
@@ -127,18 +127,18 @@ 

Method Details

Returns: An object of the form: - { # Response message for grouping by assets. - "groupByResults": [ # Group results. There exists an element for each existing unique combination of property/values. The element contains a count for the number of times those specific property/values appear. - { # Result containing the properties and count of a groupBy request. - "count": "A String", # Total count of resources for the given properties. - "properties": { # Properties matching the groupBy fields in the request. + { + "groupByResults": [ + { + "count": "A String", + "properties": { "a_key": "", }, }, ], - "nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no more results. - "readTime": "A String", # Time used for executing the groupBy request. - "totalSize": 42, # The total number of results matching the query. + "nextPageToken": "A String", + "readTime": "A String", + "totalSize": 42, }
@@ -158,17 +158,17 @@

Method Details

list(parent, compareDuration=None, fieldMask=None, filter=None, orderBy=None, pageSize=None, pageToken=None, readTime=None, x__xgafv=None) -
Lists an organization's assets.
+  
 
 Args:
-  parent: string, Required. The name of the parent resource that contains the assets. The value that you can specify on parent depends on the method in which you specify parent. You can specify one of the following values: `organizations/[organization_id]`, `folders/[folder_id]`, or `projects/[project_id]`. (required)
-  compareDuration: string, When compare_duration is set, the ListAssetsResult's "state_change" attribute is updated to indicate whether the asset was added, removed, or remained present during the compare_duration period of time that precedes the read_time. This is the time between (read_time - compare_duration) and read_time. The state_change value is derived based on the presence of the asset at the two points in time. Intermediate state changes between the two times don't affect the result. For example, the results aren't affected if the asset is removed and re-created again. Possible "state_change" values when compare_duration is specified: * "ADDED": indicates that the asset was not present at the start of compare_duration, but present at read_time. * "REMOVED": indicates that the asset was present at the start of compare_duration, but not present at read_time. * "ACTIVE": indicates that the asset was present at both the start and the end of the time period defined by compare_duration and read_time. If compare_duration is not specified, then the only possible state_change is "UNUSED", which will be the state_change set for all assets present at read_time.
-  fieldMask: string, A field mask to specify the ListAssetsResult fields to be listed in the response. An empty field mask will list all fields.
-  filter: string, Expression that defines the filter to apply across assets. The expression is a list of zero or more restrictions combined via logical operators `AND` and `OR`. Parentheses are supported, and `OR` has higher precedence than `AND`. Restrictions have the form ` ` and may have a `-` character in front of them to indicate negation. The fields map to those defined in the Asset resource. Examples include: * name * security_center_properties.resource_name * resource_properties.a_property * security_marks.marks.marka The supported operators are: * `=` for all value types. * `>`, `<`, `>=`, `<=` for integer values. * `:`, meaning substring matching, for strings. The supported value types are: * string literals in quotes. * integer literals without quotes. * boolean literals `true` and `false` without quotes. The following are the allowed field and operator combinations: * name: `=` * update_time: `=`, `>`, `<`, `>=`, `<=` Usage: This should be milliseconds since epoch or an RFC3339 string. Examples: `update_time = "2019-06-10T16:07:18-07:00"` `update_time = 1560208038000` * create_time: `=`, `>`, `<`, `>=`, `<=` Usage: This should be milliseconds since epoch or an RFC3339 string. Examples: `create_time = "2019-06-10T16:07:18-07:00"` `create_time = 1560208038000` * iam_policy.policy_blob: `=`, `:` * resource_properties: `=`, `:`, `>`, `<`, `>=`, `<=` * security_marks.marks: `=`, `:` * security_center_properties.resource_name: `=`, `:` * security_center_properties.resource_display_name: `=`, `:` * security_center_properties.resource_type: `=`, `:` * security_center_properties.resource_parent: `=`, `:` * security_center_properties.resource_parent_display_name: `=`, `:` * security_center_properties.resource_project: `=`, `:` * security_center_properties.resource_project_display_name: `=`, `:` * security_center_properties.resource_owners: `=`, `:` For example, `resource_properties.size = 100` is a valid filter string. Use a partial match on the empty string to filter based on a property existing: `resource_properties.my_property : ""` Use a negated partial match on the empty string to filter based on a property not existing: `-resource_properties.my_property : ""`
-  orderBy: string, Expression that defines what fields and order to use for sorting. The string value should follow SQL syntax: comma separated list of fields. For example: "name,resource_properties.a_property". The default sorting order is ascending. To specify descending order for a field, a suffix " desc" should be appended to the field name. For example: "name desc,resource_properties.a_property". Redundant space characters in the syntax are insignificant. "name desc,resource_properties.a_property" and " name desc , resource_properties.a_property " are equivalent. The following fields are supported: name update_time resource_properties security_marks.marks security_center_properties.resource_name security_center_properties.resource_display_name security_center_properties.resource_parent security_center_properties.resource_parent_display_name security_center_properties.resource_project security_center_properties.resource_project_display_name security_center_properties.resource_type
-  pageSize: integer, The maximum number of results to return in a single response. Default is 10, minimum is 1, maximum is 1000.
-  pageToken: string, The value returned by the last `ListAssetsResponse`; indicates that this is a continuation of a prior `ListAssets` call, and that the system should return the next page of data.
-  readTime: string, Time used as a reference point when filtering assets. The filter is limited to assets existing at the supplied time and their values are those at that specific time. Absence of this field will default to the API's version of NOW.
+  parent: string, A parameter (required)
+  compareDuration: string, A parameter
+  fieldMask: string, A parameter
+  filter: string, A parameter
+  orderBy: string, A parameter
+  pageSize: integer, A parameter
+  pageToken: string, A parameter
+  readTime: string, A parameter
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -177,52 +177,52 @@ 

Method Details

Returns: An object of the form: - { # Response message for listing assets. - "listAssetsResults": [ # Assets matching the list request. - { # Result containing the Asset and its State. - "asset": { # Security Command Center representation of a Google Cloud resource. The Asset is a Security Command Center resource that captures information about a single Google Cloud resource. All modifications to an Asset are only within the context of Security Command Center and don't affect the referenced Google Cloud resource. # Asset matching the search request. - "canonicalName": "A String", # The canonical name of the resource. It's either "organizations/{organization_id}/assets/{asset_id}", "folders/{folder_id}/assets/{asset_id}" or "projects/{project_number}/assets/{asset_id}", depending on the closest CRM ancestor of the resource. - "createTime": "A String", # The time at which the asset was created in Security Command Center. - "iamPolicy": { # Cloud IAM Policy information associated with the Google Cloud resource described by the Security Command Center asset. This information is managed and defined by the Google Cloud resource and cannot be modified by the user. # Cloud IAM Policy information associated with the Google Cloud resource described by the Security Command Center asset. This information is managed and defined by the Google Cloud resource and cannot be modified by the user. - "policyBlob": "A String", # The JSON representation of the Policy associated with the asset. See https://cloud.google.com/iam/reference/rest/v1/Policy for format details. + { + "listAssetsResults": [ + { + "asset": { + "canonicalName": "A String", + "createTime": "A String", + "iamPolicy": { + "policyBlob": "A String", }, - "name": "A String", # The relative resource name of this asset. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Example: "organizations/{organization_id}/assets/{asset_id}". - "resourceProperties": { # Resource managed properties. These properties are managed and defined by the Google Cloud resource and cannot be modified by the user. + "name": "A String", + "resourceProperties": { "a_key": "", }, - "securityCenterProperties": { # Security Command Center managed properties. These properties are managed by Security Command Center and cannot be modified by the user. # Security Command Center managed properties. These properties are managed by Security Command Center and cannot be modified by the user. - "folders": [ # Contains a Folder message for each folder in the assets ancestry. The first folder is the deepest nested folder, and the last folder is the folder directly under the Organization. - { # Message that contains the resource name and display name of a folder resource. - "resourceFolder": "A String", # Full resource name of this folder. See: https://cloud.google.com/apis/design/resource_names#full_resource_name - "resourceFolderDisplayName": "A String", # The user defined display name for this folder. + "securityCenterProperties": { + "folders": [ + { + "resourceFolder": "A String", + "resourceFolderDisplayName": "A String", }, ], - "resourceDisplayName": "A String", # The user defined display name for this resource. - "resourceName": "A String", # The full resource name of the Google Cloud resource this asset represents. This field is immutable after create time. See: https://cloud.google.com/apis/design/resource_names#full_resource_name - "resourceOwners": [ # Owners of the Google Cloud resource. + "resourceDisplayName": "A String", + "resourceName": "A String", + "resourceOwners": [ "A String", ], - "resourceParent": "A String", # The full resource name of the immediate parent of the resource. See: https://cloud.google.com/apis/design/resource_names#full_resource_name - "resourceParentDisplayName": "A String", # The user defined display name for the parent of this resource. - "resourceProject": "A String", # The full resource name of the project the resource belongs to. See: https://cloud.google.com/apis/design/resource_names#full_resource_name - "resourceProjectDisplayName": "A String", # The user defined display name for the project of this resource. - "resourceType": "A String", # The type of the Google Cloud resource. Examples include: APPLICATION, PROJECT, and ORGANIZATION. This is a case insensitive field defined by Security Command Center and/or the producer of the resource and is immutable after create time. + "resourceParent": "A String", + "resourceParentDisplayName": "A String", + "resourceProject": "A String", + "resourceProjectDisplayName": "A String", + "resourceType": "A String", }, - "securityMarks": { # User specified security marks that are attached to the parent Security Command Center resource. Security marks are scoped within a Security Command Center organization -- they can be modified and viewed by all users who have proper permissions on the organization. # User specified security marks. These marks are entirely managed by the user and come from the SecurityMarks resource that belongs to the asset. - "canonicalName": "A String", # The canonical name of the marks. Examples: "organizations/{organization_id}/assets/{asset_id}/securityMarks" "folders/{folder_id}/assets/{asset_id}/securityMarks" "projects/{project_number}/assets/{asset_id}/securityMarks" "organizations/{organization_id}/sources/{source_id}/findings/{finding_id}/securityMarks" "folders/{folder_id}/sources/{source_id}/findings/{finding_id}/securityMarks" "projects/{project_number}/sources/{source_id}/findings/{finding_id}/securityMarks" - "marks": { # Mutable user specified security marks belonging to the parent resource. Constraints are as follows: * Keys and values are treated as case insensitive * Keys must be between 1 - 256 characters (inclusive) * Keys must be letters, numbers, underscores, or dashes * Values have leading and trailing whitespace trimmed, remaining characters must be between 1 - 4096 characters (inclusive) + "securityMarks": { + "canonicalName": "A String", + "marks": { "a_key": "A String", }, - "name": "A String", # The relative resource name of the SecurityMarks. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Examples: "organizations/{organization_id}/assets/{asset_id}/securityMarks" "organizations/{organization_id}/sources/{source_id}/findings/{finding_id}/securityMarks". + "name": "A String", }, - "updateTime": "A String", # The time at which the asset was last updated or added in Cloud SCC. + "updateTime": "A String", }, - "stateChange": "A String", # State change of the asset between the points in time. + "stateChange": "A String", }, ], - "nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no more results. - "readTime": "A String", # Time used for executing the list request. - "totalSize": 42, # The total number of assets matching the query. + "nextPageToken": "A String", + "readTime": "A String", + "totalSize": 42, }
@@ -242,14 +242,14 @@

Method Details

runDiscovery(parent, body=None, x__xgafv=None) -
Runs asset discovery. The discovery is tracked with a long-running operation. This API can only be called with limited frequency for an organization. If it is called too frequently the caller will receive a TOO_MANY_REQUESTS error.
+  
 
 Args:
-  parent: string, Required. Name of the organization to run asset discovery for. Its format is `organizations/[organization_id]`. (required)
+  parent: string, A parameter (required)
   body: object, The request body.
     The object takes the form of:
 
-{ # Request message for running asset discovery for an organization.
+{
 }
 
   x__xgafv: string, V1 error format.
@@ -260,22 +260,22 @@ 

Method Details

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. + { + "done": True or False, + "error": { + "code": 42, + "details": [ { "a_key": "", # Properties of the object. Contains field @type with type URL. }, ], - "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. + "message": "A String", }, - "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. + "metadata": { "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`. + "name": "A String", + "response": { "a_key": "", # Properties of the object. Contains field @type with type URL. }, }
@@ -283,23 +283,23 @@

Method Details

updateSecurityMarks(name, body=None, startTime=None, updateMask=None, x__xgafv=None) -
Updates security marks.
+  
 
 Args:
-  name: string, The relative resource name of the SecurityMarks. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Examples: "organizations/{organization_id}/assets/{asset_id}/securityMarks" "organizations/{organization_id}/sources/{source_id}/findings/{finding_id}/securityMarks". (required)
+  name: string, A parameter (required)
   body: object, The request body.
     The object takes the form of:
 
-{ # User specified security marks that are attached to the parent Security Command Center resource. Security marks are scoped within a Security Command Center organization -- they can be modified and viewed by all users who have proper permissions on the organization.
-  "canonicalName": "A String", # The canonical name of the marks. Examples: "organizations/{organization_id}/assets/{asset_id}/securityMarks" "folders/{folder_id}/assets/{asset_id}/securityMarks" "projects/{project_number}/assets/{asset_id}/securityMarks" "organizations/{organization_id}/sources/{source_id}/findings/{finding_id}/securityMarks" "folders/{folder_id}/sources/{source_id}/findings/{finding_id}/securityMarks" "projects/{project_number}/sources/{source_id}/findings/{finding_id}/securityMarks"
-  "marks": { # Mutable user specified security marks belonging to the parent resource. Constraints are as follows: * Keys and values are treated as case insensitive * Keys must be between 1 - 256 characters (inclusive) * Keys must be letters, numbers, underscores, or dashes * Values have leading and trailing whitespace trimmed, remaining characters must be between 1 - 4096 characters (inclusive)
+{
+  "canonicalName": "A String",
+  "marks": {
     "a_key": "A String",
   },
-  "name": "A String", # The relative resource name of the SecurityMarks. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Examples: "organizations/{organization_id}/assets/{asset_id}/securityMarks" "organizations/{organization_id}/sources/{source_id}/findings/{finding_id}/securityMarks".
+  "name": "A String",
 }
 
-  startTime: string, The time at which the updated SecurityMarks take effect. If not set uses current server time. Updates will be applied to the SecurityMarks that are active immediately preceding this time. Must be earlier or equal to the server time.
-  updateMask: string, The FieldMask to use when updating the security marks resource. The field mask must not contain duplicate fields. If empty or set to "marks", all marks will be replaced. Individual marks can be updated using "marks.".
+  startTime: string, A parameter
+  updateMask: string, A parameter
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -308,12 +308,12 @@ 

Method Details

Returns: An object of the form: - { # User specified security marks that are attached to the parent Security Command Center resource. Security marks are scoped within a Security Command Center organization -- they can be modified and viewed by all users who have proper permissions on the organization. - "canonicalName": "A String", # The canonical name of the marks. Examples: "organizations/{organization_id}/assets/{asset_id}/securityMarks" "folders/{folder_id}/assets/{asset_id}/securityMarks" "projects/{project_number}/assets/{asset_id}/securityMarks" "organizations/{organization_id}/sources/{source_id}/findings/{finding_id}/securityMarks" "folders/{folder_id}/sources/{source_id}/findings/{finding_id}/securityMarks" "projects/{project_number}/sources/{source_id}/findings/{finding_id}/securityMarks" - "marks": { # Mutable user specified security marks belonging to the parent resource. Constraints are as follows: * Keys and values are treated as case insensitive * Keys must be between 1 - 256 characters (inclusive) * Keys must be letters, numbers, underscores, or dashes * Values have leading and trailing whitespace trimmed, remaining characters must be between 1 - 4096 characters (inclusive) + { + "canonicalName": "A String", + "marks": { "a_key": "A String", }, - "name": "A String", # The relative resource name of the SecurityMarks. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Examples: "organizations/{organization_id}/assets/{asset_id}/securityMarks" "organizations/{organization_id}/sources/{source_id}/findings/{finding_id}/securityMarks". + "name": "A String", }
diff --git a/docs/dyn/securitycenter_v1.organizations.attackPaths.html b/docs/dyn/securitycenter_v1.organizations.attackPaths.html index 75cdb2fd15..c5bb5c40ff 100644 --- a/docs/dyn/securitycenter_v1.organizations.attackPaths.html +++ b/docs/dyn/securitycenter_v1.organizations.attackPaths.html @@ -79,7 +79,7 @@

Instance Methods

Close httplib2 connections.

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

-

Lists the attack paths for a set of simulation results or valued resources and filter.

+

list_next()

Retrieves the next page of results.

@@ -91,13 +91,13 @@

Method Details

list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None) -
Lists the attack paths for a set of simulation results or valued resources and filter.
+  
 
 Args:
-  parent: string, Required. Name of parent to list attack paths. Valid formats: `organizations/{organization}`, `organizations/{organization}/simulations/{simulation}` `organizations/{organization}/simulations/{simulation}/attackExposureResults/{attack_exposure_result_v2}` `organizations/{organization}/simulations/{simulation}/valuedResources/{valued_resource}` (required)
-  filter: string, The filter expression that filters the attack path in the response. Supported fields: * `valued_resources` supports =
-  pageSize: integer, The maximum number of results to return in a single response. Default is 10, minimum is 1, maximum is 1000.
-  pageToken: string, The value returned by the last `ListAttackPathsResponse`; indicates that this is a continuation of a prior `ListAttackPaths` call, and that the system should return the next page of data.
+  parent: string, A parameter (required)
+  filter: string, A parameter
+  pageSize: integer, A parameter
+  pageToken: string, A parameter
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -106,45 +106,45 @@ 

Method Details

Returns: An object of the form: - { # Response message for listing the attack paths for a given simulation or valued resource. - "attackPaths": [ # The attack paths that the attack path simulation identified. - { # A path that an attacker could take to reach an exposed resource. - "edges": [ # A list of the edges between nodes in this attack path. - { # Represents a connection between a source node and a destination node in this attack path. - "destination": "A String", # The attack node uuid of the destination node. - "source": "A String", # The attack node uuid of the source node. + { + "attackPaths": [ + { + "edges": [ + { + "destination": "A String", + "source": "A String", }, ], - "name": "A String", # The attack path name, for example, `organizations/12/simulation/34/valuedResources/56/attackPaths/78` - "pathNodes": [ # A list of nodes that exist in this attack path. - { # Represents one point that an attacker passes through in this attack path. - "associatedFindings": [ # The findings associated with this node in the attack path. - { # A finding that is associated with this node in the attack path. - "canonicalFinding": "A String", # Canonical name of the associated findings. Example: `organizations/123/sources/456/findings/789` - "findingCategory": "A String", # The additional taxonomy group within findings from a given source. - "name": "A String", # Full resource name of the finding. + "name": "A String", + "pathNodes": [ + { + "associatedFindings": [ + { + "canonicalFinding": "A String", + "findingCategory": "A String", + "name": "A String", }, ], - "attackSteps": [ # A list of attack step nodes that exist in this attack path node. - { # Detailed steps the attack can take between path nodes. - "description": "A String", # Attack step description - "displayName": "A String", # User friendly name of the attack step - "labels": { # Attack step labels for metadata + "attackSteps": [ + { + "description": "A String", + "displayName": "A String", + "labels": { "a_key": "A String", }, - "type": "A String", # Attack step type. Can be either AND, OR or DEFENSE - "uuid": "A String", # Unique ID for one Node + "type": "A String", + "uuid": "A String", }, ], - "displayName": "A String", # Human-readable name of this resource. - "resource": "A String", # The name of the resource at this point in the attack path. The format of the name follows the Cloud Asset Inventory [resource name format](https://cloud.google.com/asset-inventory/docs/resource-name-format) - "resourceType": "A String", # The [supported resource type](https://cloud.google.com/asset-inventory/docs/supported-asset-types) - "uuid": "A String", # Unique id of the attack path node. + "displayName": "A String", + "resource": "A String", + "resourceType": "A String", + "uuid": "A String", }, ], }, ], - "nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no more results. + "nextPageToken": "A String", }
diff --git a/docs/dyn/securitycenter_v1.organizations.bigQueryExports.html b/docs/dyn/securitycenter_v1.organizations.bigQueryExports.html index 1e84b16722..094309b122 100644 --- a/docs/dyn/securitycenter_v1.organizations.bigQueryExports.html +++ b/docs/dyn/securitycenter_v1.organizations.bigQueryExports.html @@ -79,22 +79,22 @@

Instance Methods

Close httplib2 connections.

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

-

Creates a BigQuery export.

+

delete(name, x__xgafv=None)

-

Deletes an existing BigQuery export.

+

get(name, x__xgafv=None)

-

Gets a BigQuery export.

+

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

-

Lists BigQuery exports. Note that when requesting BigQuery exports at a given level all exports under that level are also returned e.g. if requesting BigQuery exports under a folder, then all BigQuery exports immediately under the folder plus the ones created under the projects within the folder are returned.

+

list_next()

Retrieves the next page of results.

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

-

Updates a BigQuery export.

+

Method Details

close() @@ -103,25 +103,25 @@

Method Details

create(parent, bigQueryExportId=None, body=None, x__xgafv=None) -
Creates a BigQuery export.
+  
 
 Args:
-  parent: string, Required. The name of the parent resource of the new BigQuery export. Its format is `organizations/[organization_id]`, `folders/[folder_id]`, or `projects/[project_id]`. (required)
+  parent: string, A parameter (required)
   body: object, The request body.
     The object takes the form of:
 
-{ # Configures how to deliver Findings to BigQuery Instance.
-  "createTime": "A String", # Output only. The time at which the BigQuery export was created. This field is set by the server and will be ignored if provided on export on creation.
-  "dataset": "A String", # The dataset to write findings' updates to. Its format is "projects/[project_id]/datasets/[bigquery_dataset_id]". BigQuery Dataset unique ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_).
-  "description": "A String", # The description of the export (max of 1024 characters).
-  "filter": "A String", # Expression that defines the filter to apply across create/update events of findings. The expression is a list of zero or more restrictions combined via logical operators `AND` and `OR`. Parentheses are supported, and `OR` has higher precedence than `AND`. Restrictions have the form ` ` and may have a `-` character in front of them to indicate negation. The fields map to those defined in the corresponding resource. The supported operators are: * `=` for all value types. * `>`, `<`, `>=`, `<=` for integer values. * `:`, meaning substring matching, for strings. The supported value types are: * string literals in quotes. * integer literals without quotes. * boolean literals `true` and `false` without quotes.
-  "mostRecentEditor": "A String", # Output only. Email address of the user who last edited the BigQuery export. This field is set by the server and will be ignored if provided on export creation or update.
-  "name": "A String", # The relative resource name of this export. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name. Example format: "organizations/{organization_id}/bigQueryExports/{export_id}" Example format: "folders/{folder_id}/bigQueryExports/{export_id}" Example format: "projects/{project_id}/bigQueryExports/{export_id}" This field is provided in responses, and is ignored when provided in create requests.
-  "principal": "A String", # Output only. The service account that needs permission to create table and upload data to the BigQuery dataset.
-  "updateTime": "A String", # Output only. The most recent time at which the BigQuery export was updated. This field is set by the server and will be ignored if provided on export creation or update.
+{
+  "createTime": "A String",
+  "dataset": "A String",
+  "description": "A String",
+  "filter": "A String",
+  "mostRecentEditor": "A String",
+  "name": "A String",
+  "principal": "A String",
+  "updateTime": "A String",
 }
 
-  bigQueryExportId: string, Required. Unique identifier provided by the client within the parent scope. It must consist of only lowercase letters, numbers, and hyphens, must start with a letter, must end with either a letter or a number, and must be 63 characters or less.
+  bigQueryExportId: string, A parameter
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -130,24 +130,24 @@ 

Method Details

Returns: An object of the form: - { # Configures how to deliver Findings to BigQuery Instance. - "createTime": "A String", # Output only. The time at which the BigQuery export was created. This field is set by the server and will be ignored if provided on export on creation. - "dataset": "A String", # The dataset to write findings' updates to. Its format is "projects/[project_id]/datasets/[bigquery_dataset_id]". BigQuery Dataset unique ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). - "description": "A String", # The description of the export (max of 1024 characters). - "filter": "A String", # Expression that defines the filter to apply across create/update events of findings. The expression is a list of zero or more restrictions combined via logical operators `AND` and `OR`. Parentheses are supported, and `OR` has higher precedence than `AND`. Restrictions have the form ` ` and may have a `-` character in front of them to indicate negation. The fields map to those defined in the corresponding resource. The supported operators are: * `=` for all value types. * `>`, `<`, `>=`, `<=` for integer values. * `:`, meaning substring matching, for strings. The supported value types are: * string literals in quotes. * integer literals without quotes. * boolean literals `true` and `false` without quotes. - "mostRecentEditor": "A String", # Output only. Email address of the user who last edited the BigQuery export. This field is set by the server and will be ignored if provided on export creation or update. - "name": "A String", # The relative resource name of this export. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name. Example format: "organizations/{organization_id}/bigQueryExports/{export_id}" Example format: "folders/{folder_id}/bigQueryExports/{export_id}" Example format: "projects/{project_id}/bigQueryExports/{export_id}" This field is provided in responses, and is ignored when provided in create requests. - "principal": "A String", # Output only. The service account that needs permission to create table and upload data to the BigQuery dataset. - "updateTime": "A String", # Output only. The most recent time at which the BigQuery export was updated. This field is set by the server and will be ignored if provided on export creation or update. + { + "createTime": "A String", + "dataset": "A String", + "description": "A String", + "filter": "A String", + "mostRecentEditor": "A String", + "name": "A String", + "principal": "A String", + "updateTime": "A String", }
delete(name, x__xgafv=None) -
Deletes an existing BigQuery export.
+  
 
 Args:
-  name: string, Required. The name of the BigQuery export to delete. Its format is `organizations/{organization}/bigQueryExports/{export_id}`, `folders/{folder}/bigQueryExports/{export_id}`, or `projects/{project}/bigQueryExports/{export_id}` (required)
+  name: string, A parameter (required)
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -156,16 +156,16 @@ 

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); } + { }
get(name, x__xgafv=None) -
Gets a BigQuery export.
+  
 
 Args:
-  name: string, Required. Name of the BigQuery export to retrieve. Its format is `organizations/{organization}/bigQueryExports/{export_id}`, `folders/{folder}/bigQueryExports/{export_id}`, or `projects/{project}/bigQueryExports/{export_id}` (required)
+  name: string, A parameter (required)
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -174,26 +174,26 @@ 

Method Details

Returns: An object of the form: - { # Configures how to deliver Findings to BigQuery Instance. - "createTime": "A String", # Output only. The time at which the BigQuery export was created. This field is set by the server and will be ignored if provided on export on creation. - "dataset": "A String", # The dataset to write findings' updates to. Its format is "projects/[project_id]/datasets/[bigquery_dataset_id]". BigQuery Dataset unique ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). - "description": "A String", # The description of the export (max of 1024 characters). - "filter": "A String", # Expression that defines the filter to apply across create/update events of findings. The expression is a list of zero or more restrictions combined via logical operators `AND` and `OR`. Parentheses are supported, and `OR` has higher precedence than `AND`. Restrictions have the form ` ` and may have a `-` character in front of them to indicate negation. The fields map to those defined in the corresponding resource. The supported operators are: * `=` for all value types. * `>`, `<`, `>=`, `<=` for integer values. * `:`, meaning substring matching, for strings. The supported value types are: * string literals in quotes. * integer literals without quotes. * boolean literals `true` and `false` without quotes. - "mostRecentEditor": "A String", # Output only. Email address of the user who last edited the BigQuery export. This field is set by the server and will be ignored if provided on export creation or update. - "name": "A String", # The relative resource name of this export. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name. Example format: "organizations/{organization_id}/bigQueryExports/{export_id}" Example format: "folders/{folder_id}/bigQueryExports/{export_id}" Example format: "projects/{project_id}/bigQueryExports/{export_id}" This field is provided in responses, and is ignored when provided in create requests. - "principal": "A String", # Output only. The service account that needs permission to create table and upload data to the BigQuery dataset. - "updateTime": "A String", # Output only. The most recent time at which the BigQuery export was updated. This field is set by the server and will be ignored if provided on export creation or update. + { + "createTime": "A String", + "dataset": "A String", + "description": "A String", + "filter": "A String", + "mostRecentEditor": "A String", + "name": "A String", + "principal": "A String", + "updateTime": "A String", }
list(parent, pageSize=None, pageToken=None, x__xgafv=None) -
Lists BigQuery exports. Note that when requesting BigQuery exports at a given level all exports under that level are also returned e.g. if requesting BigQuery exports under a folder, then all BigQuery exports immediately under the folder plus the ones created under the projects within the folder are returned.
+  
 
 Args:
-  parent: string, Required. The parent, which owns the collection of BigQuery exports. Its format is `organizations/[organization_id]`, `folders/[folder_id]`, `projects/[project_id]`. (required)
-  pageSize: integer, The maximum number of configs to return. The service may return fewer than this value. If unspecified, at most 10 configs will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
-  pageToken: string, A page token, received from a previous `ListBigQueryExports` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListBigQueryExports` must match the call that provided the page token.
+  parent: string, A parameter (required)
+  pageSize: integer, A parameter
+  pageToken: string, A parameter
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -202,20 +202,20 @@ 

Method Details

Returns: An object of the form: - { # Response message for listing BigQuery exports. - "bigQueryExports": [ # The BigQuery exports from the specified parent. - { # Configures how to deliver Findings to BigQuery Instance. - "createTime": "A String", # Output only. The time at which the BigQuery export was created. This field is set by the server and will be ignored if provided on export on creation. - "dataset": "A String", # The dataset to write findings' updates to. Its format is "projects/[project_id]/datasets/[bigquery_dataset_id]". BigQuery Dataset unique ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). - "description": "A String", # The description of the export (max of 1024 characters). - "filter": "A String", # Expression that defines the filter to apply across create/update events of findings. The expression is a list of zero or more restrictions combined via logical operators `AND` and `OR`. Parentheses are supported, and `OR` has higher precedence than `AND`. Restrictions have the form ` ` and may have a `-` character in front of them to indicate negation. The fields map to those defined in the corresponding resource. The supported operators are: * `=` for all value types. * `>`, `<`, `>=`, `<=` for integer values. * `:`, meaning substring matching, for strings. The supported value types are: * string literals in quotes. * integer literals without quotes. * boolean literals `true` and `false` without quotes. - "mostRecentEditor": "A String", # Output only. Email address of the user who last edited the BigQuery export. This field is set by the server and will be ignored if provided on export creation or update. - "name": "A String", # The relative resource name of this export. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name. Example format: "organizations/{organization_id}/bigQueryExports/{export_id}" Example format: "folders/{folder_id}/bigQueryExports/{export_id}" Example format: "projects/{project_id}/bigQueryExports/{export_id}" This field is provided in responses, and is ignored when provided in create requests. - "principal": "A String", # Output only. The service account that needs permission to create table and upload data to the BigQuery dataset. - "updateTime": "A String", # Output only. The most recent time at which the BigQuery export was updated. This field is set by the server and will be ignored if provided on export creation or update. + { + "bigQueryExports": [ + { + "createTime": "A String", + "dataset": "A String", + "description": "A String", + "filter": "A String", + "mostRecentEditor": "A String", + "name": "A String", + "principal": "A String", + "updateTime": "A String", }, ], - "nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. + "nextPageToken": "A String", }
@@ -235,25 +235,25 @@

Method Details

patch(name, body=None, updateMask=None, x__xgafv=None) -
Updates a BigQuery export.
+  
 
 Args:
-  name: string, The relative resource name of this export. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name. Example format: "organizations/{organization_id}/bigQueryExports/{export_id}" Example format: "folders/{folder_id}/bigQueryExports/{export_id}" Example format: "projects/{project_id}/bigQueryExports/{export_id}" This field is provided in responses, and is ignored when provided in create requests. (required)
+  name: string, A parameter (required)
   body: object, The request body.
     The object takes the form of:
 
-{ # Configures how to deliver Findings to BigQuery Instance.
-  "createTime": "A String", # Output only. The time at which the BigQuery export was created. This field is set by the server and will be ignored if provided on export on creation.
-  "dataset": "A String", # The dataset to write findings' updates to. Its format is "projects/[project_id]/datasets/[bigquery_dataset_id]". BigQuery Dataset unique ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_).
-  "description": "A String", # The description of the export (max of 1024 characters).
-  "filter": "A String", # Expression that defines the filter to apply across create/update events of findings. The expression is a list of zero or more restrictions combined via logical operators `AND` and `OR`. Parentheses are supported, and `OR` has higher precedence than `AND`. Restrictions have the form ` ` and may have a `-` character in front of them to indicate negation. The fields map to those defined in the corresponding resource. The supported operators are: * `=` for all value types. * `>`, `<`, `>=`, `<=` for integer values. * `:`, meaning substring matching, for strings. The supported value types are: * string literals in quotes. * integer literals without quotes. * boolean literals `true` and `false` without quotes.
-  "mostRecentEditor": "A String", # Output only. Email address of the user who last edited the BigQuery export. This field is set by the server and will be ignored if provided on export creation or update.
-  "name": "A String", # The relative resource name of this export. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name. Example format: "organizations/{organization_id}/bigQueryExports/{export_id}" Example format: "folders/{folder_id}/bigQueryExports/{export_id}" Example format: "projects/{project_id}/bigQueryExports/{export_id}" This field is provided in responses, and is ignored when provided in create requests.
-  "principal": "A String", # Output only. The service account that needs permission to create table and upload data to the BigQuery dataset.
-  "updateTime": "A String", # Output only. The most recent time at which the BigQuery export was updated. This field is set by the server and will be ignored if provided on export creation or update.
+{
+  "createTime": "A String",
+  "dataset": "A String",
+  "description": "A String",
+  "filter": "A String",
+  "mostRecentEditor": "A String",
+  "name": "A String",
+  "principal": "A String",
+  "updateTime": "A String",
 }
 
-  updateMask: string, The list of fields to be updated. If empty all mutable fields will be updated.
+  updateMask: string, A parameter
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -262,15 +262,15 @@ 

Method Details

Returns: An object of the form: - { # Configures how to deliver Findings to BigQuery Instance. - "createTime": "A String", # Output only. The time at which the BigQuery export was created. This field is set by the server and will be ignored if provided on export on creation. - "dataset": "A String", # The dataset to write findings' updates to. Its format is "projects/[project_id]/datasets/[bigquery_dataset_id]". BigQuery Dataset unique ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). - "description": "A String", # The description of the export (max of 1024 characters). - "filter": "A String", # Expression that defines the filter to apply across create/update events of findings. The expression is a list of zero or more restrictions combined via logical operators `AND` and `OR`. Parentheses are supported, and `OR` has higher precedence than `AND`. Restrictions have the form ` ` and may have a `-` character in front of them to indicate negation. The fields map to those defined in the corresponding resource. The supported operators are: * `=` for all value types. * `>`, `<`, `>=`, `<=` for integer values. * `:`, meaning substring matching, for strings. The supported value types are: * string literals in quotes. * integer literals without quotes. * boolean literals `true` and `false` without quotes. - "mostRecentEditor": "A String", # Output only. Email address of the user who last edited the BigQuery export. This field is set by the server and will be ignored if provided on export creation or update. - "name": "A String", # The relative resource name of this export. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name. Example format: "organizations/{organization_id}/bigQueryExports/{export_id}" Example format: "folders/{folder_id}/bigQueryExports/{export_id}" Example format: "projects/{project_id}/bigQueryExports/{export_id}" This field is provided in responses, and is ignored when provided in create requests. - "principal": "A String", # Output only. The service account that needs permission to create table and upload data to the BigQuery dataset. - "updateTime": "A String", # Output only. The most recent time at which the BigQuery export was updated. This field is set by the server and will be ignored if provided on export creation or update. + { + "createTime": "A String", + "dataset": "A String", + "description": "A String", + "filter": "A String", + "mostRecentEditor": "A String", + "name": "A String", + "principal": "A String", + "updateTime": "A String", }
diff --git a/docs/dyn/securitycenter_v1.organizations.eventThreatDetectionSettings.customModules.html b/docs/dyn/securitycenter_v1.organizations.eventThreatDetectionSettings.customModules.html index 9d0d7aab54..7cbf9363fe 100644 --- a/docs/dyn/securitycenter_v1.organizations.eventThreatDetectionSettings.customModules.html +++ b/docs/dyn/securitycenter_v1.organizations.eventThreatDetectionSettings.customModules.html @@ -79,19 +79,19 @@

Instance Methods

Close httplib2 connections.

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

-

Creates a resident Event Threat Detection custom module at the scope of the given Resource Manager parent, and also creates inherited custom modules for all descendants of the given parent. These modules are enabled by default.

+

delete(name, x__xgafv=None)

-

Deletes the specified Event Threat Detection custom module and all of its descendants in the Resource Manager hierarchy. This method is only supported for resident custom modules.

+

get(name, x__xgafv=None)

-

Gets an Event Threat Detection custom module.

+

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

-

Lists all Event Threat Detection custom modules for the given Resource Manager parent. This includes resident modules defined at the scope of the parent along with modules inherited from ancestors.

+

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

-

Lists all resident Event Threat Detection custom modules under the given Resource Manager parent and its descendants.

+

listDescendant_next()

Retrieves the next page of results.

@@ -100,7 +100,7 @@

Instance Methods

Retrieves the next page of results.

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

-

Updates the Event Threat Detection custom module with the given name based on the given update mask. Updating the enablement state is supported for both resident and inherited modules (though resident modules cannot have an enablement state of "inherited"). Updating the display name or configuration of a module is supported for resident modules only. The type of a module cannot be changed.

+

Method Details

close() @@ -109,26 +109,26 @@

Method Details

create(parent, body=None, x__xgafv=None) -
Creates a resident Event Threat Detection custom module at the scope of the given Resource Manager parent, and also creates inherited custom modules for all descendants of the given parent. These modules are enabled by default.
+  
 
 Args:
-  parent: string, Required. The new custom module's parent. Its format is: * `organizations/{organization}/eventThreatDetectionSettings`. * `folders/{folder}/eventThreatDetectionSettings`. * `projects/{project}/eventThreatDetectionSettings`. (required)
+  parent: string, A parameter (required)
   body: object, The request body.
     The object takes the form of:
 
-{ # Represents an instance of an Event Threat Detection custom module, including its full module name, display name, enablement state, and last updated time. You can create a custom module at the organization, folder, or project level. Custom modules that you create at the organization or folder level are inherited by child folders and projects.
-  "ancestorModule": "A String", # Output only. The closest ancestor module that this module inherits the enablement state from. The format is the same as the EventThreatDetectionCustomModule resource name.
-  "cloudProvider": "A String", # The cloud provider of the custom module.
-  "config": { # Config for the module. For the resident module, its config value is defined at this level. For the inherited module, its config value is inherited from the ancestor module.
+{
+  "ancestorModule": "A String",
+  "cloudProvider": "A String",
+  "config": {
     "a_key": "", # Properties of the object.
   },
-  "description": "A String", # The description for the module.
-  "displayName": "A String", # The human readable name to be displayed for the module.
-  "enablementState": "A String", # The state of enablement for the module at the given level of the hierarchy.
-  "lastEditor": "A String", # Output only. The editor the module was last updated by.
-  "name": "A String", # Immutable. The resource name of the Event Threat Detection custom module. Its format is: * `organizations/{organization}/eventThreatDetectionSettings/customModules/{module}`. * `folders/{folder}/eventThreatDetectionSettings/customModules/{module}`. * `projects/{project}/eventThreatDetectionSettings/customModules/{module}`.
-  "type": "A String", # Type for the module. e.g. CONFIGURABLE_BAD_IP.
-  "updateTime": "A String", # Output only. The time the module was last updated.
+  "description": "A String",
+  "displayName": "A String",
+  "enablementState": "A String",
+  "lastEditor": "A String",
+  "name": "A String",
+  "type": "A String",
+  "updateTime": "A String",
 }
 
   x__xgafv: string, V1 error format.
@@ -139,28 +139,28 @@ 

Method Details

Returns: An object of the form: - { # Represents an instance of an Event Threat Detection custom module, including its full module name, display name, enablement state, and last updated time. You can create a custom module at the organization, folder, or project level. Custom modules that you create at the organization or folder level are inherited by child folders and projects. - "ancestorModule": "A String", # Output only. The closest ancestor module that this module inherits the enablement state from. The format is the same as the EventThreatDetectionCustomModule resource name. - "cloudProvider": "A String", # The cloud provider of the custom module. - "config": { # Config for the module. For the resident module, its config value is defined at this level. For the inherited module, its config value is inherited from the ancestor module. + { + "ancestorModule": "A String", + "cloudProvider": "A String", + "config": { "a_key": "", # Properties of the object. }, - "description": "A String", # The description for the module. - "displayName": "A String", # The human readable name to be displayed for the module. - "enablementState": "A String", # The state of enablement for the module at the given level of the hierarchy. - "lastEditor": "A String", # Output only. The editor the module was last updated by. - "name": "A String", # Immutable. The resource name of the Event Threat Detection custom module. Its format is: * `organizations/{organization}/eventThreatDetectionSettings/customModules/{module}`. * `folders/{folder}/eventThreatDetectionSettings/customModules/{module}`. * `projects/{project}/eventThreatDetectionSettings/customModules/{module}`. - "type": "A String", # Type for the module. e.g. CONFIGURABLE_BAD_IP. - "updateTime": "A String", # Output only. The time the module was last updated. + "description": "A String", + "displayName": "A String", + "enablementState": "A String", + "lastEditor": "A String", + "name": "A String", + "type": "A String", + "updateTime": "A String", }
delete(name, x__xgafv=None) -
Deletes the specified Event Threat Detection custom module and all of its descendants in the Resource Manager hierarchy. This method is only supported for resident custom modules.
+  
 
 Args:
-  name: string, Required. Name of the custom module to delete. Its format is: * `organizations/{organization}/eventThreatDetectionSettings/customModules/{module}`. * `folders/{folder}/eventThreatDetectionSettings/customModules/{module}`. * `projects/{project}/eventThreatDetectionSettings/customModules/{module}`. (required)
+  name: string, A parameter (required)
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -169,16 +169,16 @@ 

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); } + { }
get(name, x__xgafv=None) -
Gets an Event Threat Detection custom module.
+  
 
 Args:
-  name: string, Required. Name of the custom module to get. Its format is: * `organizations/{organization}/eventThreatDetectionSettings/customModules/{module}`. * `folders/{folder}/eventThreatDetectionSettings/customModules/{module}`. * `projects/{project}/eventThreatDetectionSettings/customModules/{module}`. (required)
+  name: string, A parameter (required)
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -187,30 +187,30 @@ 

Method Details

Returns: An object of the form: - { # Represents an instance of an Event Threat Detection custom module, including its full module name, display name, enablement state, and last updated time. You can create a custom module at the organization, folder, or project level. Custom modules that you create at the organization or folder level are inherited by child folders and projects. - "ancestorModule": "A String", # Output only. The closest ancestor module that this module inherits the enablement state from. The format is the same as the EventThreatDetectionCustomModule resource name. - "cloudProvider": "A String", # The cloud provider of the custom module. - "config": { # Config for the module. For the resident module, its config value is defined at this level. For the inherited module, its config value is inherited from the ancestor module. + { + "ancestorModule": "A String", + "cloudProvider": "A String", + "config": { "a_key": "", # Properties of the object. }, - "description": "A String", # The description for the module. - "displayName": "A String", # The human readable name to be displayed for the module. - "enablementState": "A String", # The state of enablement for the module at the given level of the hierarchy. - "lastEditor": "A String", # Output only. The editor the module was last updated by. - "name": "A String", # Immutable. The resource name of the Event Threat Detection custom module. Its format is: * `organizations/{organization}/eventThreatDetectionSettings/customModules/{module}`. * `folders/{folder}/eventThreatDetectionSettings/customModules/{module}`. * `projects/{project}/eventThreatDetectionSettings/customModules/{module}`. - "type": "A String", # Type for the module. e.g. CONFIGURABLE_BAD_IP. - "updateTime": "A String", # Output only. The time the module was last updated. + "description": "A String", + "displayName": "A String", + "enablementState": "A String", + "lastEditor": "A String", + "name": "A String", + "type": "A String", + "updateTime": "A String", }
list(parent, pageSize=None, pageToken=None, x__xgafv=None) -
Lists all Event Threat Detection custom modules for the given Resource Manager parent. This includes resident modules defined at the scope of the parent along with modules inherited from ancestors.
+  
 
 Args:
-  parent: string, Required. Name of the parent to list custom modules under. Its format is: * `organizations/{organization}/eventThreatDetectionSettings`. * `folders/{folder}/eventThreatDetectionSettings`. * `projects/{project}/eventThreatDetectionSettings`. (required)
-  pageSize: integer, The maximum number of modules to return. The service may return fewer than this value. If unspecified, at most 10 configs will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
-  pageToken: string, A page token, received from a previous `ListEventThreatDetectionCustomModules` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListEventThreatDetectionCustomModules` must match the call that provided the page token.
+  parent: string, A parameter (required)
+  pageSize: integer, A parameter
+  pageToken: string, A parameter
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -219,35 +219,35 @@ 

Method Details

Returns: An object of the form: - { # Response for listing Event Threat Detection custom modules. - "eventThreatDetectionCustomModules": [ # Custom modules belonging to the requested parent. - { # Represents an instance of an Event Threat Detection custom module, including its full module name, display name, enablement state, and last updated time. You can create a custom module at the organization, folder, or project level. Custom modules that you create at the organization or folder level are inherited by child folders and projects. - "ancestorModule": "A String", # Output only. The closest ancestor module that this module inherits the enablement state from. The format is the same as the EventThreatDetectionCustomModule resource name. - "cloudProvider": "A String", # The cloud provider of the custom module. - "config": { # Config for the module. For the resident module, its config value is defined at this level. For the inherited module, its config value is inherited from the ancestor module. + { + "eventThreatDetectionCustomModules": [ + { + "ancestorModule": "A String", + "cloudProvider": "A String", + "config": { "a_key": "", # Properties of the object. }, - "description": "A String", # The description for the module. - "displayName": "A String", # The human readable name to be displayed for the module. - "enablementState": "A String", # The state of enablement for the module at the given level of the hierarchy. - "lastEditor": "A String", # Output only. The editor the module was last updated by. - "name": "A String", # Immutable. The resource name of the Event Threat Detection custom module. Its format is: * `organizations/{organization}/eventThreatDetectionSettings/customModules/{module}`. * `folders/{folder}/eventThreatDetectionSettings/customModules/{module}`. * `projects/{project}/eventThreatDetectionSettings/customModules/{module}`. - "type": "A String", # Type for the module. e.g. CONFIGURABLE_BAD_IP. - "updateTime": "A String", # Output only. The time the module was last updated. + "description": "A String", + "displayName": "A String", + "enablementState": "A String", + "lastEditor": "A String", + "name": "A String", + "type": "A String", + "updateTime": "A String", }, ], - "nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. + "nextPageToken": "A String", }
listDescendant(parent, pageSize=None, pageToken=None, x__xgafv=None) -
Lists all resident Event Threat Detection custom modules under the given Resource Manager parent and its descendants.
+  
 
 Args:
-  parent: string, Required. Name of the parent to list custom modules under. Its format is: * `organizations/{organization}/eventThreatDetectionSettings`. * `folders/{folder}/eventThreatDetectionSettings`. * `projects/{project}/eventThreatDetectionSettings`. (required)
-  pageSize: integer, The maximum number of modules to return. The service may return fewer than this value. If unspecified, at most 10 configs will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
-  pageToken: string, A page token, received from a previous `ListDescendantEventThreatDetectionCustomModules` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListDescendantEventThreatDetectionCustomModules` must match the call that provided the page token.
+  parent: string, A parameter (required)
+  pageSize: integer, A parameter
+  pageToken: string, A parameter
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -256,24 +256,24 @@ 

Method Details

Returns: An object of the form: - { # Response for listing current and descendant resident Event Threat Detection custom modules. - "eventThreatDetectionCustomModules": [ # Custom modules belonging to the requested parent. - { # Represents an instance of an Event Threat Detection custom module, including its full module name, display name, enablement state, and last updated time. You can create a custom module at the organization, folder, or project level. Custom modules that you create at the organization or folder level are inherited by child folders and projects. - "ancestorModule": "A String", # Output only. The closest ancestor module that this module inherits the enablement state from. The format is the same as the EventThreatDetectionCustomModule resource name. - "cloudProvider": "A String", # The cloud provider of the custom module. - "config": { # Config for the module. For the resident module, its config value is defined at this level. For the inherited module, its config value is inherited from the ancestor module. + { + "eventThreatDetectionCustomModules": [ + { + "ancestorModule": "A String", + "cloudProvider": "A String", + "config": { "a_key": "", # Properties of the object. }, - "description": "A String", # The description for the module. - "displayName": "A String", # The human readable name to be displayed for the module. - "enablementState": "A String", # The state of enablement for the module at the given level of the hierarchy. - "lastEditor": "A String", # Output only. The editor the module was last updated by. - "name": "A String", # Immutable. The resource name of the Event Threat Detection custom module. Its format is: * `organizations/{organization}/eventThreatDetectionSettings/customModules/{module}`. * `folders/{folder}/eventThreatDetectionSettings/customModules/{module}`. * `projects/{project}/eventThreatDetectionSettings/customModules/{module}`. - "type": "A String", # Type for the module. e.g. CONFIGURABLE_BAD_IP. - "updateTime": "A String", # Output only. The time the module was last updated. + "description": "A String", + "displayName": "A String", + "enablementState": "A String", + "lastEditor": "A String", + "name": "A String", + "type": "A String", + "updateTime": "A String", }, ], - "nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. + "nextPageToken": "A String", }
@@ -307,29 +307,29 @@

Method Details

patch(name, body=None, updateMask=None, x__xgafv=None) -
Updates the Event Threat Detection custom module with the given name based on the given update mask. Updating the enablement state is supported for both resident and inherited modules (though resident modules cannot have an enablement state of "inherited"). Updating the display name or configuration of a module is supported for resident modules only. The type of a module cannot be changed.
+  
 
 Args:
-  name: string, Immutable. The resource name of the Event Threat Detection custom module. Its format is: * `organizations/{organization}/eventThreatDetectionSettings/customModules/{module}`. * `folders/{folder}/eventThreatDetectionSettings/customModules/{module}`. * `projects/{project}/eventThreatDetectionSettings/customModules/{module}`. (required)
+  name: string, A parameter (required)
   body: object, The request body.
     The object takes the form of:
 
-{ # Represents an instance of an Event Threat Detection custom module, including its full module name, display name, enablement state, and last updated time. You can create a custom module at the organization, folder, or project level. Custom modules that you create at the organization or folder level are inherited by child folders and projects.
-  "ancestorModule": "A String", # Output only. The closest ancestor module that this module inherits the enablement state from. The format is the same as the EventThreatDetectionCustomModule resource name.
-  "cloudProvider": "A String", # The cloud provider of the custom module.
-  "config": { # Config for the module. For the resident module, its config value is defined at this level. For the inherited module, its config value is inherited from the ancestor module.
+{
+  "ancestorModule": "A String",
+  "cloudProvider": "A String",
+  "config": {
     "a_key": "", # Properties of the object.
   },
-  "description": "A String", # The description for the module.
-  "displayName": "A String", # The human readable name to be displayed for the module.
-  "enablementState": "A String", # The state of enablement for the module at the given level of the hierarchy.
-  "lastEditor": "A String", # Output only. The editor the module was last updated by.
-  "name": "A String", # Immutable. The resource name of the Event Threat Detection custom module. Its format is: * `organizations/{organization}/eventThreatDetectionSettings/customModules/{module}`. * `folders/{folder}/eventThreatDetectionSettings/customModules/{module}`. * `projects/{project}/eventThreatDetectionSettings/customModules/{module}`.
-  "type": "A String", # Type for the module. e.g. CONFIGURABLE_BAD_IP.
-  "updateTime": "A String", # Output only. The time the module was last updated.
+  "description": "A String",
+  "displayName": "A String",
+  "enablementState": "A String",
+  "lastEditor": "A String",
+  "name": "A String",
+  "type": "A String",
+  "updateTime": "A String",
 }
 
-  updateMask: string, The list of fields to be updated. If empty all mutable fields will be updated.
+  updateMask: string, A parameter
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -338,19 +338,19 @@ 

Method Details

Returns: An object of the form: - { # Represents an instance of an Event Threat Detection custom module, including its full module name, display name, enablement state, and last updated time. You can create a custom module at the organization, folder, or project level. Custom modules that you create at the organization or folder level are inherited by child folders and projects. - "ancestorModule": "A String", # Output only. The closest ancestor module that this module inherits the enablement state from. The format is the same as the EventThreatDetectionCustomModule resource name. - "cloudProvider": "A String", # The cloud provider of the custom module. - "config": { # Config for the module. For the resident module, its config value is defined at this level. For the inherited module, its config value is inherited from the ancestor module. + { + "ancestorModule": "A String", + "cloudProvider": "A String", + "config": { "a_key": "", # Properties of the object. }, - "description": "A String", # The description for the module. - "displayName": "A String", # The human readable name to be displayed for the module. - "enablementState": "A String", # The state of enablement for the module at the given level of the hierarchy. - "lastEditor": "A String", # Output only. The editor the module was last updated by. - "name": "A String", # Immutable. The resource name of the Event Threat Detection custom module. Its format is: * `organizations/{organization}/eventThreatDetectionSettings/customModules/{module}`. * `folders/{folder}/eventThreatDetectionSettings/customModules/{module}`. * `projects/{project}/eventThreatDetectionSettings/customModules/{module}`. - "type": "A String", # Type for the module. e.g. CONFIGURABLE_BAD_IP. - "updateTime": "A String", # Output only. The time the module was last updated. + "description": "A String", + "displayName": "A String", + "enablementState": "A String", + "lastEditor": "A String", + "name": "A String", + "type": "A String", + "updateTime": "A String", }
diff --git a/docs/dyn/securitycenter_v1.organizations.eventThreatDetectionSettings.effectiveCustomModules.html b/docs/dyn/securitycenter_v1.organizations.eventThreatDetectionSettings.effectiveCustomModules.html index 1cb28e3884..911cea0c59 100644 --- a/docs/dyn/securitycenter_v1.organizations.eventThreatDetectionSettings.effectiveCustomModules.html +++ b/docs/dyn/securitycenter_v1.organizations.eventThreatDetectionSettings.effectiveCustomModules.html @@ -79,10 +79,10 @@

Instance Methods

Close httplib2 connections.

get(name, x__xgafv=None)

-

Gets an effective Event Threat Detection custom module at the given level.

+

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

-

Lists all effective Event Threat Detection custom modules for the given parent. This includes resident modules defined at the scope of the parent along with modules inherited from its ancestors.

+

list_next()

Retrieves the next page of results.

@@ -94,10 +94,10 @@

Method Details

get(name, x__xgafv=None) -
Gets an effective Event Threat Detection custom module at the given level.
+  
 
 Args:
-  name: string, Required. The resource name of the effective Event Threat Detection custom module. Its format is: * `organizations/{organization}/eventThreatDetectionSettings/effectiveCustomModules/{module}`. * `folders/{folder}/eventThreatDetectionSettings/effectiveCustomModules/{module}`. * `projects/{project}/eventThreatDetectionSettings/effectiveCustomModules/{module}`. (required)
+  name: string, A parameter (required)
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -106,27 +106,27 @@ 

Method Details

Returns: An object of the form: - { # An EffectiveEventThreatDetectionCustomModule is the representation of an Event Threat Detection custom module at a specified level of the resource hierarchy: organization, folder, or project. If a custom module is inherited from a parent organization or folder, the value of the `enablement_state` property in EffectiveEventThreatDetectionCustomModule is set to the value that is effective in the parent, instead of `INHERITED`. For example, if the module is enabled in a parent organization or folder, the effective `enablement_state` for the module in all child folders or projects is also `enabled`. EffectiveEventThreatDetectionCustomModule is read-only. - "cloudProvider": "A String", # The cloud provider of the custom module. - "config": { # Output only. Config for the effective module. + { + "cloudProvider": "A String", + "config": { "a_key": "", # Properties of the object. }, - "description": "A String", # Output only. The description for the module. - "displayName": "A String", # Output only. The human readable name to be displayed for the module. - "enablementState": "A String", # Output only. The effective state of enablement for the module at the given level of the hierarchy. - "name": "A String", # Output only. The resource name of the effective ETD custom module. Its format is: * `organizations/{organization}/eventThreatDetectionSettings/effectiveCustomModules/{module}`. * `folders/{folder}/eventThreatDetectionSettings/effectiveCustomModules/{module}`. * `projects/{project}/eventThreatDetectionSettings/effectiveCustomModules/{module}`. - "type": "A String", # Output only. Type for the module. e.g. CONFIGURABLE_BAD_IP. + "description": "A String", + "displayName": "A String", + "enablementState": "A String", + "name": "A String", + "type": "A String", }
list(parent, pageSize=None, pageToken=None, x__xgafv=None) -
Lists all effective Event Threat Detection custom modules for the given parent. This includes resident modules defined at the scope of the parent along with modules inherited from its ancestors.
+  
 
 Args:
-  parent: string, Required. Name of the parent to list custom modules for. Its format is: * `organizations/{organization}/eventThreatDetectionSettings`. * `folders/{folder}/eventThreatDetectionSettings`. * `projects/{project}/eventThreatDetectionSettings`. (required)
-  pageSize: integer, The maximum number of modules to return. The service may return fewer than this value. If unspecified, at most 10 configs will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
-  pageToken: string, A page token, received from a previous `ListEffectiveEventThreatDetectionCustomModules` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListEffectiveEventThreatDetectionCustomModules` must match the call that provided the page token.
+  parent: string, A parameter (required)
+  pageSize: integer, A parameter
+  pageToken: string, A parameter
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -135,21 +135,21 @@ 

Method Details

Returns: An object of the form: - { # Response for listing EffectiveEventThreatDetectionCustomModules. - "effectiveEventThreatDetectionCustomModules": [ # Effective custom modules belonging to the requested parent. - { # An EffectiveEventThreatDetectionCustomModule is the representation of an Event Threat Detection custom module at a specified level of the resource hierarchy: organization, folder, or project. If a custom module is inherited from a parent organization or folder, the value of the `enablement_state` property in EffectiveEventThreatDetectionCustomModule is set to the value that is effective in the parent, instead of `INHERITED`. For example, if the module is enabled in a parent organization or folder, the effective `enablement_state` for the module in all child folders or projects is also `enabled`. EffectiveEventThreatDetectionCustomModule is read-only. - "cloudProvider": "A String", # The cloud provider of the custom module. - "config": { # Output only. Config for the effective module. + { + "effectiveEventThreatDetectionCustomModules": [ + { + "cloudProvider": "A String", + "config": { "a_key": "", # Properties of the object. }, - "description": "A String", # Output only. The description for the module. - "displayName": "A String", # Output only. The human readable name to be displayed for the module. - "enablementState": "A String", # Output only. The effective state of enablement for the module at the given level of the hierarchy. - "name": "A String", # Output only. The resource name of the effective ETD custom module. Its format is: * `organizations/{organization}/eventThreatDetectionSettings/effectiveCustomModules/{module}`. * `folders/{folder}/eventThreatDetectionSettings/effectiveCustomModules/{module}`. * `projects/{project}/eventThreatDetectionSettings/effectiveCustomModules/{module}`. - "type": "A String", # Output only. Type for the module. e.g. CONFIGURABLE_BAD_IP. + "description": "A String", + "displayName": "A String", + "enablementState": "A String", + "name": "A String", + "type": "A String", }, ], - "nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. + "nextPageToken": "A String", }
diff --git a/docs/dyn/securitycenter_v1.organizations.eventThreatDetectionSettings.html b/docs/dyn/securitycenter_v1.organizations.eventThreatDetectionSettings.html index 59aa5cada7..064ea60c4f 100644 --- a/docs/dyn/securitycenter_v1.organizations.eventThreatDetectionSettings.html +++ b/docs/dyn/securitycenter_v1.organizations.eventThreatDetectionSettings.html @@ -89,7 +89,7 @@

Instance Methods

Close httplib2 connections.

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

-

Validates the given Event Threat Detection custom module.

+

Method Details

close() @@ -98,16 +98,16 @@

Method Details

validateCustomModule(parent, body=None, x__xgafv=None) -
Validates the given Event Threat Detection custom module.
+  
 
 Args:
-  parent: string, Required. Resource name of the parent to validate the Custom Module under. Its format is: * `organizations/{organization}/eventThreatDetectionSettings`. * `folders/{folder}/eventThreatDetectionSettings`. * `projects/{project}/eventThreatDetectionSettings`. (required)
+  parent: string, A parameter (required)
   body: object, The request body.
     The object takes the form of:
 
-{ # Request to validate an Event Threat Detection custom module.
-  "rawText": "A String", # Required. The raw text of the module's contents. Used to generate error messages.
-  "type": "A String", # Required. The type of the module (e.g. CONFIGURABLE_BAD_IP).
+{
+  "rawText": "A String",
+  "type": "A String",
 }
 
   x__xgafv: string, V1 error format.
@@ -118,19 +118,19 @@ 

Method Details

Returns: An object of the form: - { # Response to validating an Event Threat Detection custom module. - "errors": { # A list of zero or more errors encountered while validating the uploaded configuration of an Event Threat Detection Custom Module. # A list of errors returned by the validator. If the list is empty, there were no errors. - "errors": [ # The list of errors. - { # An error encountered while validating the uploaded configuration of an Event Threat Detection Custom Module. - "description": "A String", # A description of the error, suitable for human consumption. Required. - "end": { # A position in the uploaded text version of a module. # The end position of the error in the uploaded text version of the module. This field may be omitted if no specific position applies, or if one could not be computed. - "columnNumber": 42, # The column number. - "lineNumber": 42, # The line number. + { + "errors": { + "errors": [ + { + "description": "A String", + "end": { + "columnNumber": 42, + "lineNumber": 42, }, - "fieldPath": "A String", # The path, in RFC 8901 JSON Pointer format, to the field that failed validation. This may be left empty if no specific field is affected. - "start": { # A position in the uploaded text version of a module. # The initial position of the error in the uploaded text version of the module. This field may be omitted if no specific position applies, or if one could not be computed. - "columnNumber": 42, # The column number. - "lineNumber": 42, # The line number. + "fieldPath": "A String", + "start": { + "columnNumber": 42, + "lineNumber": 42, }, }, ], diff --git a/docs/dyn/securitycenter_v1.organizations.findings.html b/docs/dyn/securitycenter_v1.organizations.findings.html index a52782f0fa..5eefc4ae01 100644 --- a/docs/dyn/securitycenter_v1.organizations.findings.html +++ b/docs/dyn/securitycenter_v1.organizations.findings.html @@ -76,24 +76,24 @@

Security Command Center API . bulkMute(parent, body=None, x__xgafv=None)

-

Kicks off an LRO to bulk mute findings for a parent based on a filter. The parent can be either an organization, folder or project. The findings matched by the filter will be muted after the LRO is done.

+

close()

Close httplib2 connections.

Method Details

bulkMute(parent, body=None, x__xgafv=None) -
Kicks off an LRO to bulk mute findings for a parent based on a filter. The parent can be either an organization, folder or project. The findings matched by the filter will be muted after the LRO is done.
+  
 
 Args:
-  parent: string, Required. The parent, at which bulk action needs to be applied. Its format is `organizations/[organization_id]`, `folders/[folder_id]`, `projects/[project_id]`. (required)
+  parent: string, A parameter (required)
   body: object, The request body.
     The object takes the form of:
 
-{ # Request message for bulk findings update. Note: 1. If multiple bulk update requests match the same resource, the order in which they get executed is not defined. 2. Once a bulk operation is started, there is no way to stop it.
-  "filter": "A String", # Expression that identifies findings that should be updated. The expression is a list of zero or more restrictions combined via logical operators `AND` and `OR`. Parentheses are supported, and `OR` has higher precedence than `AND`. Restrictions have the form ` ` and may have a `-` character in front of them to indicate negation. The fields map to those defined in the corresponding resource. The supported operators are: * `=` for all value types. * `>`, `<`, `>=`, `<=` for integer values. * `:`, meaning substring matching, for strings. The supported value types are: * string literals in quotes. * integer literals without quotes. * boolean literals `true` and `false` without quotes.
-  "muteAnnotation": "A String", # This can be a mute configuration name or any identifier for mute/unmute of findings based on the filter.
-  "muteState": "A String", # Optional. All findings matching the given filter will have their mute state set to this value. The default value is `MUTED`. Setting this to `UNDEFINED` will clear the mute state on all matching findings.
+{
+  "filter": "A String",
+  "muteAnnotation": "A String",
+  "muteState": "A String",
 }
 
   x__xgafv: string, V1 error format.
@@ -104,22 +104,22 @@ 

Method Details

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. + { + "done": True or False, + "error": { + "code": 42, + "details": [ { "a_key": "", # Properties of the object. Contains field @type with type URL. }, ], - "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. + "message": "A String", }, - "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. + "metadata": { "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`. + "name": "A String", + "response": { "a_key": "", # Properties of the object. Contains field @type with type URL. }, }
diff --git a/docs/dyn/securitycenter_v1.organizations.html b/docs/dyn/securitycenter_v1.organizations.html index 46bc1a276b..ef98e9b991 100644 --- a/docs/dyn/securitycenter_v1.organizations.html +++ b/docs/dyn/securitycenter_v1.organizations.html @@ -149,10 +149,10 @@

Instance Methods

Close httplib2 connections.

getOrganizationSettings(name, x__xgafv=None)

-

Gets the settings for an organization.

+

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

-

Updates an organization's settings.

+

Method Details

close() @@ -161,10 +161,10 @@

Method Details

getOrganizationSettings(name, x__xgafv=None) -
Gets the settings for an organization.
+  
 
 Args:
-  name: string, Required. Name of the organization to get organization settings for. Its format is `organizations/[organization_id]/organizationSettings`. (required)
+  name: string, A parameter (required)
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -173,45 +173,45 @@ 

Method Details

Returns: An object of the form: - { # User specified settings that are attached to the Security Command Center organization. - "assetDiscoveryConfig": { # The configuration used for Asset Discovery runs. # The configuration used for Asset Discovery runs. - "folderIds": [ # The folder ids to use for filtering asset discovery. It consists of only digits, e.g., 756619654966. + { + "assetDiscoveryConfig": { + "folderIds": [ "A String", ], - "inclusionMode": "A String", # The mode to use for filtering asset discovery. - "projectIds": [ # The project ids to use for filtering asset discovery. + "inclusionMode": "A String", + "projectIds": [ "A String", ], }, - "enableAssetDiscovery": True or False, # A flag that indicates if Asset Discovery should be enabled. If the flag is set to `true`, then discovery of assets will occur. If it is set to `false`, all historical assets will remain, but discovery of future assets will not occur. - "name": "A String", # The relative resource name of the settings. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Example: "organizations/{organization_id}/organizationSettings". + "enableAssetDiscovery": True or False, + "name": "A String", }
updateOrganizationSettings(name, body=None, updateMask=None, x__xgafv=None) -
Updates an organization's settings.
+  
 
 Args:
-  name: string, The relative resource name of the settings. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Example: "organizations/{organization_id}/organizationSettings". (required)
+  name: string, A parameter (required)
   body: object, The request body.
     The object takes the form of:
 
-{ # User specified settings that are attached to the Security Command Center organization.
-  "assetDiscoveryConfig": { # The configuration used for Asset Discovery runs. # The configuration used for Asset Discovery runs.
-    "folderIds": [ # The folder ids to use for filtering asset discovery. It consists of only digits, e.g., 756619654966.
+{
+  "assetDiscoveryConfig": {
+    "folderIds": [
       "A String",
     ],
-    "inclusionMode": "A String", # The mode to use for filtering asset discovery.
-    "projectIds": [ # The project ids to use for filtering asset discovery.
+    "inclusionMode": "A String",
+    "projectIds": [
       "A String",
     ],
   },
-  "enableAssetDiscovery": True or False, # A flag that indicates if Asset Discovery should be enabled. If the flag is set to `true`, then discovery of assets will occur. If it is set to `false`, all historical assets will remain, but discovery of future assets will not occur.
-  "name": "A String", # The relative resource name of the settings. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Example: "organizations/{organization_id}/organizationSettings".
+  "enableAssetDiscovery": True or False,
+  "name": "A String",
 }
 
-  updateMask: string, The FieldMask to use when updating the settings resource. If empty all mutable fields will be updated.
+  updateMask: string, A parameter
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -220,18 +220,18 @@ 

Method Details

Returns: An object of the form: - { # User specified settings that are attached to the Security Command Center organization. - "assetDiscoveryConfig": { # The configuration used for Asset Discovery runs. # The configuration used for Asset Discovery runs. - "folderIds": [ # The folder ids to use for filtering asset discovery. It consists of only digits, e.g., 756619654966. + { + "assetDiscoveryConfig": { + "folderIds": [ "A String", ], - "inclusionMode": "A String", # The mode to use for filtering asset discovery. - "projectIds": [ # The project ids to use for filtering asset discovery. + "inclusionMode": "A String", + "projectIds": [ "A String", ], }, - "enableAssetDiscovery": True or False, # A flag that indicates if Asset Discovery should be enabled. If the flag is set to `true`, then discovery of assets will occur. If it is set to `false`, all historical assets will remain, but discovery of future assets will not occur. - "name": "A String", # The relative resource name of the settings. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Example: "organizations/{organization_id}/organizationSettings". + "enableAssetDiscovery": True or False, + "name": "A String", }
diff --git a/docs/dyn/securitycenter_v1.organizations.locations.muteConfigs.html b/docs/dyn/securitycenter_v1.organizations.locations.muteConfigs.html index 0a43db42c3..37596d2e2e 100644 --- a/docs/dyn/securitycenter_v1.organizations.locations.muteConfigs.html +++ b/docs/dyn/securitycenter_v1.organizations.locations.muteConfigs.html @@ -79,13 +79,13 @@

Instance Methods

Close httplib2 connections.

delete(name, x__xgafv=None)

-

Deletes an existing mute config.

+

get(name, x__xgafv=None)

-

Gets a mute config.

+

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

-

Updates a mute config.

+

Method Details

close() @@ -94,10 +94,10 @@

Method Details

delete(name, x__xgafv=None) -
Deletes an existing mute config.
+  
 
 Args:
-  name: string, Required. Name of the mute config to delete. Its format is `organizations/{organization}/muteConfigs/{config_id}`, `folders/{folder}/muteConfigs/{config_id}`, `projects/{project}/muteConfigs/{config_id}`, `organizations/{organization}/locations/global/muteConfigs/{config_id}`, `folders/{folder}/locations/global/muteConfigs/{config_id}`, or `projects/{project}/locations/global/muteConfigs/{config_id}`. (required)
+  name: string, A parameter (required)
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -106,16 +106,16 @@ 

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); } + { }
get(name, x__xgafv=None) -
Gets a mute config.
+  
 
 Args:
-  name: string, Required. Name of the mute config to retrieve. Its format is `organizations/{organization}/muteConfigs/{config_id}`, `folders/{folder}/muteConfigs/{config_id}`, `projects/{project}/muteConfigs/{config_id}`, `organizations/{organization}/locations/global/muteConfigs/{config_id}`, `folders/{folder}/locations/global/muteConfigs/{config_id}`, or `projects/{project}/locations/global/muteConfigs/{config_id}`. (required)
+  name: string, A parameter (required)
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -124,41 +124,41 @@ 

Method Details

Returns: An object of the form: - { # A mute config is a Cloud SCC resource that contains the configuration to mute create/update events of findings. - "createTime": "A String", # Output only. The time at which the mute config was created. This field is set by the server and will be ignored if provided on config creation. - "description": "A String", # A description of the mute config. - "displayName": "A String", # The human readable name to be displayed for the mute config. - "expiryTime": "A String", # Optional. The expiry of the mute config. Only applicable for dynamic configs. If the expiry is set, when the config expires, it is removed from all findings. - "filter": "A String", # Required. An expression that defines the filter to apply across create/update events of findings. While creating a filter string, be mindful of the scope in which the mute configuration is being created. E.g., If a filter contains project = X but is created under the project = Y scope, it might not match any findings. The following field and operator combinations are supported: * severity: `=`, `:` * category: `=`, `:` * resource.name: `=`, `:` * resource.project_name: `=`, `:` * resource.project_display_name: `=`, `:` * resource.folders.resource_folder: `=`, `:` * resource.parent_name: `=`, `:` * resource.parent_display_name: `=`, `:` * resource.type: `=`, `:` * finding_class: `=`, `:` * indicator.ip_addresses: `=`, `:` * indicator.domains: `=`, `:` - "mostRecentEditor": "A String", # Output only. Email address of the user who last edited the mute config. This field is set by the server and will be ignored if provided on config creation or update. - "name": "A String", # This field will be ignored if provided on config creation. Format `organizations/{organization}/muteConfigs/{mute_config}` `folders/{folder}/muteConfigs/{mute_config}` `projects/{project}/muteConfigs/{mute_config}` `organizations/{organization}/locations/global/muteConfigs/{mute_config}` `folders/{folder}/locations/global/muteConfigs/{mute_config}` `projects/{project}/locations/global/muteConfigs/{mute_config}` - "type": "A String", # Optional. The type of the mute config, which determines what type of mute state the config affects. The static mute state takes precedence over the dynamic mute state. Immutable after creation. STATIC by default if not set during creation. - "updateTime": "A String", # Output only. The most recent time at which the mute config was updated. This field is set by the server and will be ignored if provided on config creation or update. + { + "createTime": "A String", + "description": "A String", + "displayName": "A String", + "expiryTime": "A String", + "filter": "A String", + "mostRecentEditor": "A String", + "name": "A String", + "type": "A String", + "updateTime": "A String", }
patch(name, body=None, updateMask=None, x__xgafv=None) -
Updates a mute config.
+  
 
 Args:
-  name: string, This field will be ignored if provided on config creation. Format `organizations/{organization}/muteConfigs/{mute_config}` `folders/{folder}/muteConfigs/{mute_config}` `projects/{project}/muteConfigs/{mute_config}` `organizations/{organization}/locations/global/muteConfigs/{mute_config}` `folders/{folder}/locations/global/muteConfigs/{mute_config}` `projects/{project}/locations/global/muteConfigs/{mute_config}` (required)
+  name: string, A parameter (required)
   body: object, The request body.
     The object takes the form of:
 
-{ # A mute config is a Cloud SCC resource that contains the configuration to mute create/update events of findings.
-  "createTime": "A String", # Output only. The time at which the mute config was created. This field is set by the server and will be ignored if provided on config creation.
-  "description": "A String", # A description of the mute config.
-  "displayName": "A String", # The human readable name to be displayed for the mute config.
-  "expiryTime": "A String", # Optional. The expiry of the mute config. Only applicable for dynamic configs. If the expiry is set, when the config expires, it is removed from all findings.
-  "filter": "A String", # Required. An expression that defines the filter to apply across create/update events of findings. While creating a filter string, be mindful of the scope in which the mute configuration is being created. E.g., If a filter contains project = X but is created under the project = Y scope, it might not match any findings. The following field and operator combinations are supported: * severity: `=`, `:` * category: `=`, `:` * resource.name: `=`, `:` * resource.project_name: `=`, `:` * resource.project_display_name: `=`, `:` * resource.folders.resource_folder: `=`, `:` * resource.parent_name: `=`, `:` * resource.parent_display_name: `=`, `:` * resource.type: `=`, `:` * finding_class: `=`, `:` * indicator.ip_addresses: `=`, `:` * indicator.domains: `=`, `:`
-  "mostRecentEditor": "A String", # Output only. Email address of the user who last edited the mute config. This field is set by the server and will be ignored if provided on config creation or update.
-  "name": "A String", # This field will be ignored if provided on config creation. Format `organizations/{organization}/muteConfigs/{mute_config}` `folders/{folder}/muteConfigs/{mute_config}` `projects/{project}/muteConfigs/{mute_config}` `organizations/{organization}/locations/global/muteConfigs/{mute_config}` `folders/{folder}/locations/global/muteConfigs/{mute_config}` `projects/{project}/locations/global/muteConfigs/{mute_config}`
-  "type": "A String", # Optional. The type of the mute config, which determines what type of mute state the config affects. The static mute state takes precedence over the dynamic mute state. Immutable after creation. STATIC by default if not set during creation.
-  "updateTime": "A String", # Output only. The most recent time at which the mute config was updated. This field is set by the server and will be ignored if provided on config creation or update.
+{
+  "createTime": "A String",
+  "description": "A String",
+  "displayName": "A String",
+  "expiryTime": "A String",
+  "filter": "A String",
+  "mostRecentEditor": "A String",
+  "name": "A String",
+  "type": "A String",
+  "updateTime": "A String",
 }
 
-  updateMask: string, The list of fields to be updated. If empty all mutable fields will be updated.
+  updateMask: string, A parameter
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -167,16 +167,16 @@ 

Method Details

Returns: An object of the form: - { # A mute config is a Cloud SCC resource that contains the configuration to mute create/update events of findings. - "createTime": "A String", # Output only. The time at which the mute config was created. This field is set by the server and will be ignored if provided on config creation. - "description": "A String", # A description of the mute config. - "displayName": "A String", # The human readable name to be displayed for the mute config. - "expiryTime": "A String", # Optional. The expiry of the mute config. Only applicable for dynamic configs. If the expiry is set, when the config expires, it is removed from all findings. - "filter": "A String", # Required. An expression that defines the filter to apply across create/update events of findings. While creating a filter string, be mindful of the scope in which the mute configuration is being created. E.g., If a filter contains project = X but is created under the project = Y scope, it might not match any findings. The following field and operator combinations are supported: * severity: `=`, `:` * category: `=`, `:` * resource.name: `=`, `:` * resource.project_name: `=`, `:` * resource.project_display_name: `=`, `:` * resource.folders.resource_folder: `=`, `:` * resource.parent_name: `=`, `:` * resource.parent_display_name: `=`, `:` * resource.type: `=`, `:` * finding_class: `=`, `:` * indicator.ip_addresses: `=`, `:` * indicator.domains: `=`, `:` - "mostRecentEditor": "A String", # Output only. Email address of the user who last edited the mute config. This field is set by the server and will be ignored if provided on config creation or update. - "name": "A String", # This field will be ignored if provided on config creation. Format `organizations/{organization}/muteConfigs/{mute_config}` `folders/{folder}/muteConfigs/{mute_config}` `projects/{project}/muteConfigs/{mute_config}` `organizations/{organization}/locations/global/muteConfigs/{mute_config}` `folders/{folder}/locations/global/muteConfigs/{mute_config}` `projects/{project}/locations/global/muteConfigs/{mute_config}` - "type": "A String", # Optional. The type of the mute config, which determines what type of mute state the config affects. The static mute state takes precedence over the dynamic mute state. Immutable after creation. STATIC by default if not set during creation. - "updateTime": "A String", # Output only. The most recent time at which the mute config was updated. This field is set by the server and will be ignored if provided on config creation or update. + { + "createTime": "A String", + "description": "A String", + "displayName": "A String", + "expiryTime": "A String", + "filter": "A String", + "mostRecentEditor": "A String", + "name": "A String", + "type": "A String", + "updateTime": "A String", }
diff --git a/docs/dyn/securitycenter_v1.organizations.muteConfigs.html b/docs/dyn/securitycenter_v1.organizations.muteConfigs.html index 786262353e..869eeac196 100644 --- a/docs/dyn/securitycenter_v1.organizations.muteConfigs.html +++ b/docs/dyn/securitycenter_v1.organizations.muteConfigs.html @@ -79,22 +79,22 @@

Instance Methods

Close httplib2 connections.

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

-

Creates a mute config.

+

delete(name, x__xgafv=None)

-

Deletes an existing mute config.

+

get(name, x__xgafv=None)

-

Gets a mute config.

+

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

-

Lists mute configs.

+

list_next()

Retrieves the next page of results.

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

-

Updates a mute config.

+

Method Details

close() @@ -103,26 +103,26 @@

Method Details

create(parent, body=None, muteConfigId=None, x__xgafv=None) -
Creates a mute config.
+  
 
 Args:
-  parent: string, Required. Resource name of the new mute configs's parent. Its format is `organizations/[organization_id]`, `folders/[folder_id]`, or `projects/[project_id]`. (required)
+  parent: string, A parameter (required)
   body: object, The request body.
     The object takes the form of:
 
-{ # A mute config is a Cloud SCC resource that contains the configuration to mute create/update events of findings.
-  "createTime": "A String", # Output only. The time at which the mute config was created. This field is set by the server and will be ignored if provided on config creation.
-  "description": "A String", # A description of the mute config.
-  "displayName": "A String", # The human readable name to be displayed for the mute config.
-  "expiryTime": "A String", # Optional. The expiry of the mute config. Only applicable for dynamic configs. If the expiry is set, when the config expires, it is removed from all findings.
-  "filter": "A String", # Required. An expression that defines the filter to apply across create/update events of findings. While creating a filter string, be mindful of the scope in which the mute configuration is being created. E.g., If a filter contains project = X but is created under the project = Y scope, it might not match any findings. The following field and operator combinations are supported: * severity: `=`, `:` * category: `=`, `:` * resource.name: `=`, `:` * resource.project_name: `=`, `:` * resource.project_display_name: `=`, `:` * resource.folders.resource_folder: `=`, `:` * resource.parent_name: `=`, `:` * resource.parent_display_name: `=`, `:` * resource.type: `=`, `:` * finding_class: `=`, `:` * indicator.ip_addresses: `=`, `:` * indicator.domains: `=`, `:`
-  "mostRecentEditor": "A String", # Output only. Email address of the user who last edited the mute config. This field is set by the server and will be ignored if provided on config creation or update.
-  "name": "A String", # This field will be ignored if provided on config creation. Format `organizations/{organization}/muteConfigs/{mute_config}` `folders/{folder}/muteConfigs/{mute_config}` `projects/{project}/muteConfigs/{mute_config}` `organizations/{organization}/locations/global/muteConfigs/{mute_config}` `folders/{folder}/locations/global/muteConfigs/{mute_config}` `projects/{project}/locations/global/muteConfigs/{mute_config}`
-  "type": "A String", # Optional. The type of the mute config, which determines what type of mute state the config affects. The static mute state takes precedence over the dynamic mute state. Immutable after creation. STATIC by default if not set during creation.
-  "updateTime": "A String", # Output only. The most recent time at which the mute config was updated. This field is set by the server and will be ignored if provided on config creation or update.
+{
+  "createTime": "A String",
+  "description": "A String",
+  "displayName": "A String",
+  "expiryTime": "A String",
+  "filter": "A String",
+  "mostRecentEditor": "A String",
+  "name": "A String",
+  "type": "A String",
+  "updateTime": "A String",
 }
 
-  muteConfigId: string, Required. Unique identifier provided by the client within the parent scope. It must consist of only lowercase letters, numbers, and hyphens, must start with a letter, must end with either a letter or a number, and must be 63 characters or less.
+  muteConfigId: string, A parameter
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -131,25 +131,25 @@ 

Method Details

Returns: An object of the form: - { # A mute config is a Cloud SCC resource that contains the configuration to mute create/update events of findings. - "createTime": "A String", # Output only. The time at which the mute config was created. This field is set by the server and will be ignored if provided on config creation. - "description": "A String", # A description of the mute config. - "displayName": "A String", # The human readable name to be displayed for the mute config. - "expiryTime": "A String", # Optional. The expiry of the mute config. Only applicable for dynamic configs. If the expiry is set, when the config expires, it is removed from all findings. - "filter": "A String", # Required. An expression that defines the filter to apply across create/update events of findings. While creating a filter string, be mindful of the scope in which the mute configuration is being created. E.g., If a filter contains project = X but is created under the project = Y scope, it might not match any findings. The following field and operator combinations are supported: * severity: `=`, `:` * category: `=`, `:` * resource.name: `=`, `:` * resource.project_name: `=`, `:` * resource.project_display_name: `=`, `:` * resource.folders.resource_folder: `=`, `:` * resource.parent_name: `=`, `:` * resource.parent_display_name: `=`, `:` * resource.type: `=`, `:` * finding_class: `=`, `:` * indicator.ip_addresses: `=`, `:` * indicator.domains: `=`, `:` - "mostRecentEditor": "A String", # Output only. Email address of the user who last edited the mute config. This field is set by the server and will be ignored if provided on config creation or update. - "name": "A String", # This field will be ignored if provided on config creation. Format `organizations/{organization}/muteConfigs/{mute_config}` `folders/{folder}/muteConfigs/{mute_config}` `projects/{project}/muteConfigs/{mute_config}` `organizations/{organization}/locations/global/muteConfigs/{mute_config}` `folders/{folder}/locations/global/muteConfigs/{mute_config}` `projects/{project}/locations/global/muteConfigs/{mute_config}` - "type": "A String", # Optional. The type of the mute config, which determines what type of mute state the config affects. The static mute state takes precedence over the dynamic mute state. Immutable after creation. STATIC by default if not set during creation. - "updateTime": "A String", # Output only. The most recent time at which the mute config was updated. This field is set by the server and will be ignored if provided on config creation or update. + { + "createTime": "A String", + "description": "A String", + "displayName": "A String", + "expiryTime": "A String", + "filter": "A String", + "mostRecentEditor": "A String", + "name": "A String", + "type": "A String", + "updateTime": "A String", }
delete(name, x__xgafv=None) -
Deletes an existing mute config.
+  
 
 Args:
-  name: string, Required. Name of the mute config to delete. Its format is `organizations/{organization}/muteConfigs/{config_id}`, `folders/{folder}/muteConfigs/{config_id}`, `projects/{project}/muteConfigs/{config_id}`, `organizations/{organization}/locations/global/muteConfigs/{config_id}`, `folders/{folder}/locations/global/muteConfigs/{config_id}`, or `projects/{project}/locations/global/muteConfigs/{config_id}`. (required)
+  name: string, A parameter (required)
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -158,16 +158,16 @@ 

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); } + { }
get(name, x__xgafv=None) -
Gets a mute config.
+  
 
 Args:
-  name: string, Required. Name of the mute config to retrieve. Its format is `organizations/{organization}/muteConfigs/{config_id}`, `folders/{folder}/muteConfigs/{config_id}`, `projects/{project}/muteConfigs/{config_id}`, `organizations/{organization}/locations/global/muteConfigs/{config_id}`, `folders/{folder}/locations/global/muteConfigs/{config_id}`, or `projects/{project}/locations/global/muteConfigs/{config_id}`. (required)
+  name: string, A parameter (required)
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -176,27 +176,27 @@ 

Method Details

Returns: An object of the form: - { # A mute config is a Cloud SCC resource that contains the configuration to mute create/update events of findings. - "createTime": "A String", # Output only. The time at which the mute config was created. This field is set by the server and will be ignored if provided on config creation. - "description": "A String", # A description of the mute config. - "displayName": "A String", # The human readable name to be displayed for the mute config. - "expiryTime": "A String", # Optional. The expiry of the mute config. Only applicable for dynamic configs. If the expiry is set, when the config expires, it is removed from all findings. - "filter": "A String", # Required. An expression that defines the filter to apply across create/update events of findings. While creating a filter string, be mindful of the scope in which the mute configuration is being created. E.g., If a filter contains project = X but is created under the project = Y scope, it might not match any findings. The following field and operator combinations are supported: * severity: `=`, `:` * category: `=`, `:` * resource.name: `=`, `:` * resource.project_name: `=`, `:` * resource.project_display_name: `=`, `:` * resource.folders.resource_folder: `=`, `:` * resource.parent_name: `=`, `:` * resource.parent_display_name: `=`, `:` * resource.type: `=`, `:` * finding_class: `=`, `:` * indicator.ip_addresses: `=`, `:` * indicator.domains: `=`, `:` - "mostRecentEditor": "A String", # Output only. Email address of the user who last edited the mute config. This field is set by the server and will be ignored if provided on config creation or update. - "name": "A String", # This field will be ignored if provided on config creation. Format `organizations/{organization}/muteConfigs/{mute_config}` `folders/{folder}/muteConfigs/{mute_config}` `projects/{project}/muteConfigs/{mute_config}` `organizations/{organization}/locations/global/muteConfigs/{mute_config}` `folders/{folder}/locations/global/muteConfigs/{mute_config}` `projects/{project}/locations/global/muteConfigs/{mute_config}` - "type": "A String", # Optional. The type of the mute config, which determines what type of mute state the config affects. The static mute state takes precedence over the dynamic mute state. Immutable after creation. STATIC by default if not set during creation. - "updateTime": "A String", # Output only. The most recent time at which the mute config was updated. This field is set by the server and will be ignored if provided on config creation or update. + { + "createTime": "A String", + "description": "A String", + "displayName": "A String", + "expiryTime": "A String", + "filter": "A String", + "mostRecentEditor": "A String", + "name": "A String", + "type": "A String", + "updateTime": "A String", }
list(parent, pageSize=None, pageToken=None, x__xgafv=None) -
Lists mute configs.
+  
 
 Args:
-  parent: string, Required. The parent, which owns the collection of mute configs. Its format is `organizations/[organization_id]`, `folders/[folder_id]`, `projects/[project_id]`. (required)
-  pageSize: integer, The maximum number of configs to return. The service may return fewer than this value. If unspecified, at most 10 configs will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
-  pageToken: string, A page token, received from a previous `ListMuteConfigs` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListMuteConfigs` must match the call that provided the page token.
+  parent: string, A parameter (required)
+  pageSize: integer, A parameter
+  pageToken: string, A parameter
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -205,21 +205,21 @@ 

Method Details

Returns: An object of the form: - { # Response message for listing mute configs. - "muteConfigs": [ # The mute configs from the specified parent. - { # A mute config is a Cloud SCC resource that contains the configuration to mute create/update events of findings. - "createTime": "A String", # Output only. The time at which the mute config was created. This field is set by the server and will be ignored if provided on config creation. - "description": "A String", # A description of the mute config. - "displayName": "A String", # The human readable name to be displayed for the mute config. - "expiryTime": "A String", # Optional. The expiry of the mute config. Only applicable for dynamic configs. If the expiry is set, when the config expires, it is removed from all findings. - "filter": "A String", # Required. An expression that defines the filter to apply across create/update events of findings. While creating a filter string, be mindful of the scope in which the mute configuration is being created. E.g., If a filter contains project = X but is created under the project = Y scope, it might not match any findings. The following field and operator combinations are supported: * severity: `=`, `:` * category: `=`, `:` * resource.name: `=`, `:` * resource.project_name: `=`, `:` * resource.project_display_name: `=`, `:` * resource.folders.resource_folder: `=`, `:` * resource.parent_name: `=`, `:` * resource.parent_display_name: `=`, `:` * resource.type: `=`, `:` * finding_class: `=`, `:` * indicator.ip_addresses: `=`, `:` * indicator.domains: `=`, `:` - "mostRecentEditor": "A String", # Output only. Email address of the user who last edited the mute config. This field is set by the server and will be ignored if provided on config creation or update. - "name": "A String", # This field will be ignored if provided on config creation. Format `organizations/{organization}/muteConfigs/{mute_config}` `folders/{folder}/muteConfigs/{mute_config}` `projects/{project}/muteConfigs/{mute_config}` `organizations/{organization}/locations/global/muteConfigs/{mute_config}` `folders/{folder}/locations/global/muteConfigs/{mute_config}` `projects/{project}/locations/global/muteConfigs/{mute_config}` - "type": "A String", # Optional. The type of the mute config, which determines what type of mute state the config affects. The static mute state takes precedence over the dynamic mute state. Immutable after creation. STATIC by default if not set during creation. - "updateTime": "A String", # Output only. The most recent time at which the mute config was updated. This field is set by the server and will be ignored if provided on config creation or update. + { + "muteConfigs": [ + { + "createTime": "A String", + "description": "A String", + "displayName": "A String", + "expiryTime": "A String", + "filter": "A String", + "mostRecentEditor": "A String", + "name": "A String", + "type": "A String", + "updateTime": "A String", }, ], - "nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. + "nextPageToken": "A String", }
@@ -239,26 +239,26 @@

Method Details

patch(name, body=None, updateMask=None, x__xgafv=None) -
Updates a mute config.
+  
 
 Args:
-  name: string, This field will be ignored if provided on config creation. Format `organizations/{organization}/muteConfigs/{mute_config}` `folders/{folder}/muteConfigs/{mute_config}` `projects/{project}/muteConfigs/{mute_config}` `organizations/{organization}/locations/global/muteConfigs/{mute_config}` `folders/{folder}/locations/global/muteConfigs/{mute_config}` `projects/{project}/locations/global/muteConfigs/{mute_config}` (required)
+  name: string, A parameter (required)
   body: object, The request body.
     The object takes the form of:
 
-{ # A mute config is a Cloud SCC resource that contains the configuration to mute create/update events of findings.
-  "createTime": "A String", # Output only. The time at which the mute config was created. This field is set by the server and will be ignored if provided on config creation.
-  "description": "A String", # A description of the mute config.
-  "displayName": "A String", # The human readable name to be displayed for the mute config.
-  "expiryTime": "A String", # Optional. The expiry of the mute config. Only applicable for dynamic configs. If the expiry is set, when the config expires, it is removed from all findings.
-  "filter": "A String", # Required. An expression that defines the filter to apply across create/update events of findings. While creating a filter string, be mindful of the scope in which the mute configuration is being created. E.g., If a filter contains project = X but is created under the project = Y scope, it might not match any findings. The following field and operator combinations are supported: * severity: `=`, `:` * category: `=`, `:` * resource.name: `=`, `:` * resource.project_name: `=`, `:` * resource.project_display_name: `=`, `:` * resource.folders.resource_folder: `=`, `:` * resource.parent_name: `=`, `:` * resource.parent_display_name: `=`, `:` * resource.type: `=`, `:` * finding_class: `=`, `:` * indicator.ip_addresses: `=`, `:` * indicator.domains: `=`, `:`
-  "mostRecentEditor": "A String", # Output only. Email address of the user who last edited the mute config. This field is set by the server and will be ignored if provided on config creation or update.
-  "name": "A String", # This field will be ignored if provided on config creation. Format `organizations/{organization}/muteConfigs/{mute_config}` `folders/{folder}/muteConfigs/{mute_config}` `projects/{project}/muteConfigs/{mute_config}` `organizations/{organization}/locations/global/muteConfigs/{mute_config}` `folders/{folder}/locations/global/muteConfigs/{mute_config}` `projects/{project}/locations/global/muteConfigs/{mute_config}`
-  "type": "A String", # Optional. The type of the mute config, which determines what type of mute state the config affects. The static mute state takes precedence over the dynamic mute state. Immutable after creation. STATIC by default if not set during creation.
-  "updateTime": "A String", # Output only. The most recent time at which the mute config was updated. This field is set by the server and will be ignored if provided on config creation or update.
+{
+  "createTime": "A String",
+  "description": "A String",
+  "displayName": "A String",
+  "expiryTime": "A String",
+  "filter": "A String",
+  "mostRecentEditor": "A String",
+  "name": "A String",
+  "type": "A String",
+  "updateTime": "A String",
 }
 
-  updateMask: string, The list of fields to be updated. If empty all mutable fields will be updated.
+  updateMask: string, A parameter
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -267,16 +267,16 @@ 

Method Details

Returns: An object of the form: - { # A mute config is a Cloud SCC resource that contains the configuration to mute create/update events of findings. - "createTime": "A String", # Output only. The time at which the mute config was created. This field is set by the server and will be ignored if provided on config creation. - "description": "A String", # A description of the mute config. - "displayName": "A String", # The human readable name to be displayed for the mute config. - "expiryTime": "A String", # Optional. The expiry of the mute config. Only applicable for dynamic configs. If the expiry is set, when the config expires, it is removed from all findings. - "filter": "A String", # Required. An expression that defines the filter to apply across create/update events of findings. While creating a filter string, be mindful of the scope in which the mute configuration is being created. E.g., If a filter contains project = X but is created under the project = Y scope, it might not match any findings. The following field and operator combinations are supported: * severity: `=`, `:` * category: `=`, `:` * resource.name: `=`, `:` * resource.project_name: `=`, `:` * resource.project_display_name: `=`, `:` * resource.folders.resource_folder: `=`, `:` * resource.parent_name: `=`, `:` * resource.parent_display_name: `=`, `:` * resource.type: `=`, `:` * finding_class: `=`, `:` * indicator.ip_addresses: `=`, `:` * indicator.domains: `=`, `:` - "mostRecentEditor": "A String", # Output only. Email address of the user who last edited the mute config. This field is set by the server and will be ignored if provided on config creation or update. - "name": "A String", # This field will be ignored if provided on config creation. Format `organizations/{organization}/muteConfigs/{mute_config}` `folders/{folder}/muteConfigs/{mute_config}` `projects/{project}/muteConfigs/{mute_config}` `organizations/{organization}/locations/global/muteConfigs/{mute_config}` `folders/{folder}/locations/global/muteConfigs/{mute_config}` `projects/{project}/locations/global/muteConfigs/{mute_config}` - "type": "A String", # Optional. The type of the mute config, which determines what type of mute state the config affects. The static mute state takes precedence over the dynamic mute state. Immutable after creation. STATIC by default if not set during creation. - "updateTime": "A String", # Output only. The most recent time at which the mute config was updated. This field is set by the server and will be ignored if provided on config creation or update. + { + "createTime": "A String", + "description": "A String", + "displayName": "A String", + "expiryTime": "A String", + "filter": "A String", + "mostRecentEditor": "A String", + "name": "A String", + "type": "A String", + "updateTime": "A String", }
diff --git a/docs/dyn/securitycenter_v1.organizations.notificationConfigs.html b/docs/dyn/securitycenter_v1.organizations.notificationConfigs.html index 637df17bd3..ab9b4d7839 100644 --- a/docs/dyn/securitycenter_v1.organizations.notificationConfigs.html +++ b/docs/dyn/securitycenter_v1.organizations.notificationConfigs.html @@ -79,22 +79,22 @@

Instance Methods

Close httplib2 connections.

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

-

Creates a notification config.

+

delete(name, x__xgafv=None)

-

Deletes a notification config.

+

get(name, x__xgafv=None)

-

Gets a notification config.

+

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

-

Lists notification configs.

+

list_next()

Retrieves the next page of results.

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

-

Updates a notification config. The following update fields are allowed: description, pubsub_topic, streaming_config.filter

+

Method Details

close() @@ -103,24 +103,24 @@

Method Details

create(parent, body=None, configId=None, x__xgafv=None) -
Creates a notification config.
+  
 
 Args:
-  parent: string, Required. Resource name of the new notification config's parent. Its format is `organizations/[organization_id]`, `folders/[folder_id]`, or `projects/[project_id]`. (required)
+  parent: string, A parameter (required)
   body: object, The request body.
     The object takes the form of:
 
-{ # Cloud Security Command Center (Cloud SCC) notification configs. A notification config is a Cloud SCC resource that contains the configuration to send notifications for create/update events of findings, assets and etc.
-  "description": "A String", # The description of the notification config (max of 1024 characters).
-  "name": "A String", # The relative resource name of this notification config. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Example: "organizations/{organization_id}/notificationConfigs/notify_public_bucket", "folders/{folder_id}/notificationConfigs/notify_public_bucket", or "projects/{project_id}/notificationConfigs/notify_public_bucket".
-  "pubsubTopic": "A String", # The Pub/Sub topic to send notifications to. Its format is "projects/[project_id]/topics/[topic]".
-  "serviceAccount": "A String", # Output only. The service account that needs "pubsub.topics.publish" permission to publish to the Pub/Sub topic.
-  "streamingConfig": { # The config for streaming-based notifications, which send each event as soon as it is detected. # The config for triggering streaming-based notifications.
-    "filter": "A String", # Expression that defines the filter to apply across create/update events of assets or findings as specified by the event type. The expression is a list of zero or more restrictions combined via logical operators `AND` and `OR`. Parentheses are supported, and `OR` has higher precedence than `AND`. Restrictions have the form ` ` and may have a `-` character in front of them to indicate negation. The fields map to those defined in the corresponding resource. The supported operators are: * `=` for all value types. * `>`, `<`, `>=`, `<=` for integer values. * `:`, meaning substring matching, for strings. The supported value types are: * string literals in quotes. * integer literals without quotes. * boolean literals `true` and `false` without quotes.
+{
+  "description": "A String",
+  "name": "A String",
+  "pubsubTopic": "A String",
+  "serviceAccount": "A String",
+  "streamingConfig": {
+    "filter": "A String",
   },
 }
 
-  configId: string, Required. Unique identifier provided by the client within the parent scope. It must be between 1 and 128 characters and contain alphanumeric characters, underscores, or hyphens only.
+  configId: string, A parameter
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -129,23 +129,23 @@ 

Method Details

Returns: An object of the form: - { # Cloud Security Command Center (Cloud SCC) notification configs. A notification config is a Cloud SCC resource that contains the configuration to send notifications for create/update events of findings, assets and etc. - "description": "A String", # The description of the notification config (max of 1024 characters). - "name": "A String", # The relative resource name of this notification config. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Example: "organizations/{organization_id}/notificationConfigs/notify_public_bucket", "folders/{folder_id}/notificationConfigs/notify_public_bucket", or "projects/{project_id}/notificationConfigs/notify_public_bucket". - "pubsubTopic": "A String", # The Pub/Sub topic to send notifications to. Its format is "projects/[project_id]/topics/[topic]". - "serviceAccount": "A String", # Output only. The service account that needs "pubsub.topics.publish" permission to publish to the Pub/Sub topic. - "streamingConfig": { # The config for streaming-based notifications, which send each event as soon as it is detected. # The config for triggering streaming-based notifications. - "filter": "A String", # Expression that defines the filter to apply across create/update events of assets or findings as specified by the event type. The expression is a list of zero or more restrictions combined via logical operators `AND` and `OR`. Parentheses are supported, and `OR` has higher precedence than `AND`. Restrictions have the form ` ` and may have a `-` character in front of them to indicate negation. The fields map to those defined in the corresponding resource. The supported operators are: * `=` for all value types. * `>`, `<`, `>=`, `<=` for integer values. * `:`, meaning substring matching, for strings. The supported value types are: * string literals in quotes. * integer literals without quotes. * boolean literals `true` and `false` without quotes. + { + "description": "A String", + "name": "A String", + "pubsubTopic": "A String", + "serviceAccount": "A String", + "streamingConfig": { + "filter": "A String", }, }
delete(name, x__xgafv=None) -
Deletes a notification config.
+  
 
 Args:
-  name: string, Required. Name of the notification config to delete. Its format is `organizations/[organization_id]/notificationConfigs/[config_id]`, `folders/[folder_id]/notificationConfigs/[config_id]`, or `projects/[project_id]/notificationConfigs/[config_id]`. (required)
+  name: string, A parameter (required)
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -154,16 +154,16 @@ 

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); } + { }
get(name, x__xgafv=None) -
Gets a notification config.
+  
 
 Args:
-  name: string, Required. Name of the notification config to get. Its format is `organizations/[organization_id]/notificationConfigs/[config_id]`, `folders/[folder_id]/notificationConfigs/[config_id]`, or `projects/[project_id]/notificationConfigs/[config_id]`. (required)
+  name: string, A parameter (required)
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -172,25 +172,25 @@ 

Method Details

Returns: An object of the form: - { # Cloud Security Command Center (Cloud SCC) notification configs. A notification config is a Cloud SCC resource that contains the configuration to send notifications for create/update events of findings, assets and etc. - "description": "A String", # The description of the notification config (max of 1024 characters). - "name": "A String", # The relative resource name of this notification config. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Example: "organizations/{organization_id}/notificationConfigs/notify_public_bucket", "folders/{folder_id}/notificationConfigs/notify_public_bucket", or "projects/{project_id}/notificationConfigs/notify_public_bucket". - "pubsubTopic": "A String", # The Pub/Sub topic to send notifications to. Its format is "projects/[project_id]/topics/[topic]". - "serviceAccount": "A String", # Output only. The service account that needs "pubsub.topics.publish" permission to publish to the Pub/Sub topic. - "streamingConfig": { # The config for streaming-based notifications, which send each event as soon as it is detected. # The config for triggering streaming-based notifications. - "filter": "A String", # Expression that defines the filter to apply across create/update events of assets or findings as specified by the event type. The expression is a list of zero or more restrictions combined via logical operators `AND` and `OR`. Parentheses are supported, and `OR` has higher precedence than `AND`. Restrictions have the form ` ` and may have a `-` character in front of them to indicate negation. The fields map to those defined in the corresponding resource. The supported operators are: * `=` for all value types. * `>`, `<`, `>=`, `<=` for integer values. * `:`, meaning substring matching, for strings. The supported value types are: * string literals in quotes. * integer literals without quotes. * boolean literals `true` and `false` without quotes. + { + "description": "A String", + "name": "A String", + "pubsubTopic": "A String", + "serviceAccount": "A String", + "streamingConfig": { + "filter": "A String", }, }
list(parent, pageSize=None, pageToken=None, x__xgafv=None) -
Lists notification configs.
+  
 
 Args:
-  parent: string, Required. The name of the parent in which to list the notification configurations. Its format is "organizations/[organization_id]", "folders/[folder_id]", or "projects/[project_id]". (required)
-  pageSize: integer, The maximum number of results to return in a single response. Default is 10, minimum is 1, maximum is 1000.
-  pageToken: string, The value returned by the last `ListNotificationConfigsResponse`; indicates that this is a continuation of a prior `ListNotificationConfigs` call, and that the system should return the next page of data.
+  parent: string, A parameter (required)
+  pageSize: integer, A parameter
+  pageToken: string, A parameter
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -199,16 +199,16 @@ 

Method Details

Returns: An object of the form: - { # Response message for listing notification configs. - "nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no more results. - "notificationConfigs": [ # Notification configs belonging to the requested parent. - { # Cloud Security Command Center (Cloud SCC) notification configs. A notification config is a Cloud SCC resource that contains the configuration to send notifications for create/update events of findings, assets and etc. - "description": "A String", # The description of the notification config (max of 1024 characters). - "name": "A String", # The relative resource name of this notification config. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Example: "organizations/{organization_id}/notificationConfigs/notify_public_bucket", "folders/{folder_id}/notificationConfigs/notify_public_bucket", or "projects/{project_id}/notificationConfigs/notify_public_bucket". - "pubsubTopic": "A String", # The Pub/Sub topic to send notifications to. Its format is "projects/[project_id]/topics/[topic]". - "serviceAccount": "A String", # Output only. The service account that needs "pubsub.topics.publish" permission to publish to the Pub/Sub topic. - "streamingConfig": { # The config for streaming-based notifications, which send each event as soon as it is detected. # The config for triggering streaming-based notifications. - "filter": "A String", # Expression that defines the filter to apply across create/update events of assets or findings as specified by the event type. The expression is a list of zero or more restrictions combined via logical operators `AND` and `OR`. Parentheses are supported, and `OR` has higher precedence than `AND`. Restrictions have the form ` ` and may have a `-` character in front of them to indicate negation. The fields map to those defined in the corresponding resource. The supported operators are: * `=` for all value types. * `>`, `<`, `>=`, `<=` for integer values. * `:`, meaning substring matching, for strings. The supported value types are: * string literals in quotes. * integer literals without quotes. * boolean literals `true` and `false` without quotes. + { + "nextPageToken": "A String", + "notificationConfigs": [ + { + "description": "A String", + "name": "A String", + "pubsubTopic": "A String", + "serviceAccount": "A String", + "streamingConfig": { + "filter": "A String", }, }, ], @@ -231,24 +231,24 @@

Method Details

patch(name, body=None, updateMask=None, x__xgafv=None) -
 Updates a notification config. The following update fields are allowed: description, pubsub_topic, streaming_config.filter
+  
 
 Args:
-  name: string, The relative resource name of this notification config. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Example: "organizations/{organization_id}/notificationConfigs/notify_public_bucket", "folders/{folder_id}/notificationConfigs/notify_public_bucket", or "projects/{project_id}/notificationConfigs/notify_public_bucket". (required)
+  name: string, A parameter (required)
   body: object, The request body.
     The object takes the form of:
 
-{ # Cloud Security Command Center (Cloud SCC) notification configs. A notification config is a Cloud SCC resource that contains the configuration to send notifications for create/update events of findings, assets and etc.
-  "description": "A String", # The description of the notification config (max of 1024 characters).
-  "name": "A String", # The relative resource name of this notification config. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Example: "organizations/{organization_id}/notificationConfigs/notify_public_bucket", "folders/{folder_id}/notificationConfigs/notify_public_bucket", or "projects/{project_id}/notificationConfigs/notify_public_bucket".
-  "pubsubTopic": "A String", # The Pub/Sub topic to send notifications to. Its format is "projects/[project_id]/topics/[topic]".
-  "serviceAccount": "A String", # Output only. The service account that needs "pubsub.topics.publish" permission to publish to the Pub/Sub topic.
-  "streamingConfig": { # The config for streaming-based notifications, which send each event as soon as it is detected. # The config for triggering streaming-based notifications.
-    "filter": "A String", # Expression that defines the filter to apply across create/update events of assets or findings as specified by the event type. The expression is a list of zero or more restrictions combined via logical operators `AND` and `OR`. Parentheses are supported, and `OR` has higher precedence than `AND`. Restrictions have the form ` ` and may have a `-` character in front of them to indicate negation. The fields map to those defined in the corresponding resource. The supported operators are: * `=` for all value types. * `>`, `<`, `>=`, `<=` for integer values. * `:`, meaning substring matching, for strings. The supported value types are: * string literals in quotes. * integer literals without quotes. * boolean literals `true` and `false` without quotes.
+{
+  "description": "A String",
+  "name": "A String",
+  "pubsubTopic": "A String",
+  "serviceAccount": "A String",
+  "streamingConfig": {
+    "filter": "A String",
   },
 }
 
-  updateMask: string, The FieldMask to use when updating the notification config. If empty all mutable fields will be updated.
+  updateMask: string, A parameter
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -257,13 +257,13 @@ 

Method Details

Returns: An object of the form: - { # Cloud Security Command Center (Cloud SCC) notification configs. A notification config is a Cloud SCC resource that contains the configuration to send notifications for create/update events of findings, assets and etc. - "description": "A String", # The description of the notification config (max of 1024 characters). - "name": "A String", # The relative resource name of this notification config. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Example: "organizations/{organization_id}/notificationConfigs/notify_public_bucket", "folders/{folder_id}/notificationConfigs/notify_public_bucket", or "projects/{project_id}/notificationConfigs/notify_public_bucket". - "pubsubTopic": "A String", # The Pub/Sub topic to send notifications to. Its format is "projects/[project_id]/topics/[topic]". - "serviceAccount": "A String", # Output only. The service account that needs "pubsub.topics.publish" permission to publish to the Pub/Sub topic. - "streamingConfig": { # The config for streaming-based notifications, which send each event as soon as it is detected. # The config for triggering streaming-based notifications. - "filter": "A String", # Expression that defines the filter to apply across create/update events of assets or findings as specified by the event type. The expression is a list of zero or more restrictions combined via logical operators `AND` and `OR`. Parentheses are supported, and `OR` has higher precedence than `AND`. Restrictions have the form ` ` and may have a `-` character in front of them to indicate negation. The fields map to those defined in the corresponding resource. The supported operators are: * `=` for all value types. * `>`, `<`, `>=`, `<=` for integer values. * `:`, meaning substring matching, for strings. The supported value types are: * string literals in quotes. * integer literals without quotes. * boolean literals `true` and `false` without quotes. + { + "description": "A String", + "name": "A String", + "pubsubTopic": "A String", + "serviceAccount": "A String", + "streamingConfig": { + "filter": "A String", }, }
diff --git a/docs/dyn/securitycenter_v1.organizations.operations.html b/docs/dyn/securitycenter_v1.organizations.operations.html index 201c136efd..c9d583207b 100644 --- a/docs/dyn/securitycenter_v1.organizations.operations.html +++ b/docs/dyn/securitycenter_v1.organizations.operations.html @@ -76,29 +76,29 @@

Security Command Center API . cancel(name, x__xgafv=None)

-

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

+

close()

Close httplib2 connections.

delete(name, x__xgafv=None)

-

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

+

get(name, x__xgafv=None)

-

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

+

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

-

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

+

list_next()

Retrieves the next page of results.

Method Details

cancel(name, x__xgafv=None) -
Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.
+  
 
 Args:
-  name: string, The name of the operation resource to be cancelled. (required)
+  name: string, A parameter (required)
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -107,7 +107,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); } + { }
@@ -118,10 +118,10 @@

Method Details

delete(name, x__xgafv=None) -
Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.
+  
 
 Args:
-  name: string, The name of the operation resource to be deleted. (required)
+  name: string, A parameter (required)
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -130,16 +130,16 @@ 

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); } + { }
get(name, x__xgafv=None) -
Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
+  
 
 Args:
-  name: string, The name of the operation resource. (required)
+  name: string, A parameter (required)
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -148,22 +148,22 @@ 

Method Details

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. + { + "done": True or False, + "error": { + "code": 42, + "details": [ { "a_key": "", # Properties of the object. Contains field @type with type URL. }, ], - "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. + "message": "A String", }, - "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. + "metadata": { "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`. + "name": "A String", + "response": { "a_key": "", # Properties of the object. Contains field @type with type URL. }, }
@@ -171,14 +171,14 @@

Method Details

list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None) -
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
+  
 
 Args:
-  name: string, The name of the operation's parent resource. (required)
-  filter: string, The standard list filter.
-  pageSize: integer, The standard list page size.
-  pageToken: string, The standard list page token.
-  returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
+  name: string, A parameter (required)
+  filter: string, A parameter
+  pageSize: integer, A parameter
+  pageToken: string, A parameter
+  returnPartialSuccess: boolean, A parameter
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -187,30 +187,30 @@ 

Method Details

Returns: An object of the form: - { # The response message for Operations.ListOperations. - "nextPageToken": "A String", # The standard List next-page token. - "operations": [ # A list of operations that matches the specified filter in the request. - { # This resource represents a long-running operation that is the result of a network API call. - "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. - "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation. - "code": 42, # The status code, which should be an enum value of google.rpc.Code. - "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. + { + "nextPageToken": "A String", + "operations": [ + { + "done": True or False, + "error": { + "code": 42, + "details": [ { "a_key": "", # Properties of the object. Contains field @type with type URL. }, ], - "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. + "message": "A String", }, - "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. + "metadata": { "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`. + "name": "A String", + "response": { "a_key": "", # Properties of the object. Contains field @type with type URL. }, }, ], - "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections. For example, when attempting to list all resources across all supported locations. + "unreachable": [ "A String", ], }
diff --git a/docs/dyn/securitycenter_v1.organizations.resourceValueConfigs.html b/docs/dyn/securitycenter_v1.organizations.resourceValueConfigs.html index 41d31a769d..18f0cd1ac2 100644 --- a/docs/dyn/securitycenter_v1.organizations.resourceValueConfigs.html +++ b/docs/dyn/securitycenter_v1.organizations.resourceValueConfigs.html @@ -76,58 +76,58 @@

Security Command Center API . batchCreate(parent, body=None, x__xgafv=None)

-

Creates a ResourceValueConfig for an organization. Maps user's tags to difference resource values for use by the attack path simulation.

+

close()

Close httplib2 connections.

delete(name, x__xgafv=None)

-

Deletes a ResourceValueConfig.

+

get(name, x__xgafv=None)

-

Gets a ResourceValueConfig.

+

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

-

Lists all ResourceValueConfigs.

+

list_next()

Retrieves the next page of results.

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

-

Updates an existing ResourceValueConfigs with new rules.

+

Method Details

batchCreate(parent, body=None, x__xgafv=None) -
Creates a ResourceValueConfig for an organization. Maps user's tags to difference resource values for use by the attack path simulation.
+  
 
 Args:
-  parent: string, Required. Resource name of the new ResourceValueConfig's parent. The parent field in the CreateResourceValueConfigRequest messages must either be empty or match this field. (required)
+  parent: string, A parameter (required)
   body: object, The request body.
     The object takes the form of:
 
-{ # Request message to create multiple resource value configs
-  "requests": [ # Required. The resource value configs to be created.
-    { # Request message to create single resource value config
-      "parent": "A String", # Required. Resource name of the new ResourceValueConfig's parent.
-      "resourceValueConfig": { # A resource value configuration (RVC) is a mapping configuration of user's resources to resource values. Used in Attack path simulations. # Required. The resource value config being created.
-        "cloudProvider": "A String", # Cloud provider this configuration applies to
-        "createTime": "A String", # Output only. Timestamp this resource value configuration was created.
-        "description": "A String", # Description of the resource value configuration.
-        "name": "A String", # Name for the resource value configuration
-        "resourceLabelsSelector": { # List of resource labels to search for, evaluated with `AND`. For example, `"resource_labels_selector": {"key": "value", "env": "prod"}` will match resources with labels "key": "value" `AND` "env": "prod" https://cloud.google.com/resource-manager/docs/creating-managing-labels
+{
+  "requests": [
+    {
+      "parent": "A String",
+      "resourceValueConfig": {
+        "cloudProvider": "A String",
+        "createTime": "A String",
+        "description": "A String",
+        "name": "A String",
+        "resourceLabelsSelector": {
           "a_key": "A String",
         },
-        "resourceType": "A String", # Apply resource_value only to resources that match resource_type. resource_type will be checked with `AND` of other resources. For example, "storage.googleapis.com/Bucket" with resource_value "HIGH" will apply "HIGH" value only to "storage.googleapis.com/Bucket" resources.
-        "resourceValue": "A String", # Required. Resource value level this expression represents
-        "scope": "A String", # Project or folder to scope this configuration to. For example, "project/456" would apply this configuration only to resources in "project/456" scope will be checked with `AND` of other resources.
-        "sensitiveDataProtectionMapping": { # Resource value mapping for Sensitive Data Protection findings. If any of these mappings have a resource value that is not unspecified, the resource_value field will be ignored when reading this configuration. # A mapping of the sensitivity on Sensitive Data Protection finding to resource values. This mapping can only be used in combination with a resource_type that is related to BigQuery, e.g. "bigquery.googleapis.com/Dataset".
-          "highSensitivityMapping": "A String", # Resource value mapping for high-sensitivity Sensitive Data Protection findings
-          "mediumSensitivityMapping": "A String", # Resource value mapping for medium-sensitivity Sensitive Data Protection findings
+        "resourceType": "A String",
+        "resourceValue": "A String",
+        "scope": "A String",
+        "sensitiveDataProtectionMapping": {
+          "highSensitivityMapping": "A String",
+          "mediumSensitivityMapping": "A String",
         },
-        "tagValues": [ # Required. Tag values combined with `AND` to check against. For Google Cloud resources, they are tag value IDs in the form of "tagValues/123". Example: `[ "tagValues/123", "tagValues/456", "tagValues/789" ]` https://cloud.google.com/resource-manager/docs/tags/tags-creating-and-managing
+        "tagValues": [
           "A String",
         ],
-        "updateTime": "A String", # Output only. Timestamp this resource value configuration was last updated.
+        "updateTime": "A String",
       },
     },
   ],
@@ -141,27 +141,27 @@ 

Method Details

Returns: An object of the form: - { # Response message for BatchCreateResourceValueConfigs - "resourceValueConfigs": [ # The resource value configs created - { # A resource value configuration (RVC) is a mapping configuration of user's resources to resource values. Used in Attack path simulations. - "cloudProvider": "A String", # Cloud provider this configuration applies to - "createTime": "A String", # Output only. Timestamp this resource value configuration was created. - "description": "A String", # Description of the resource value configuration. - "name": "A String", # Name for the resource value configuration - "resourceLabelsSelector": { # List of resource labels to search for, evaluated with `AND`. For example, `"resource_labels_selector": {"key": "value", "env": "prod"}` will match resources with labels "key": "value" `AND` "env": "prod" https://cloud.google.com/resource-manager/docs/creating-managing-labels + { + "resourceValueConfigs": [ + { + "cloudProvider": "A String", + "createTime": "A String", + "description": "A String", + "name": "A String", + "resourceLabelsSelector": { "a_key": "A String", }, - "resourceType": "A String", # Apply resource_value only to resources that match resource_type. resource_type will be checked with `AND` of other resources. For example, "storage.googleapis.com/Bucket" with resource_value "HIGH" will apply "HIGH" value only to "storage.googleapis.com/Bucket" resources. - "resourceValue": "A String", # Required. Resource value level this expression represents - "scope": "A String", # Project or folder to scope this configuration to. For example, "project/456" would apply this configuration only to resources in "project/456" scope will be checked with `AND` of other resources. - "sensitiveDataProtectionMapping": { # Resource value mapping for Sensitive Data Protection findings. If any of these mappings have a resource value that is not unspecified, the resource_value field will be ignored when reading this configuration. # A mapping of the sensitivity on Sensitive Data Protection finding to resource values. This mapping can only be used in combination with a resource_type that is related to BigQuery, e.g. "bigquery.googleapis.com/Dataset". - "highSensitivityMapping": "A String", # Resource value mapping for high-sensitivity Sensitive Data Protection findings - "mediumSensitivityMapping": "A String", # Resource value mapping for medium-sensitivity Sensitive Data Protection findings + "resourceType": "A String", + "resourceValue": "A String", + "scope": "A String", + "sensitiveDataProtectionMapping": { + "highSensitivityMapping": "A String", + "mediumSensitivityMapping": "A String", }, - "tagValues": [ # Required. Tag values combined with `AND` to check against. For Google Cloud resources, they are tag value IDs in the form of "tagValues/123". Example: `[ "tagValues/123", "tagValues/456", "tagValues/789" ]` https://cloud.google.com/resource-manager/docs/tags/tags-creating-and-managing + "tagValues": [ "A String", ], - "updateTime": "A String", # Output only. Timestamp this resource value configuration was last updated. + "updateTime": "A String", }, ], }
@@ -174,10 +174,10 @@

Method Details

delete(name, x__xgafv=None) -
Deletes a ResourceValueConfig.
+  
 
 Args:
-  name: string, Required. Name of the ResourceValueConfig to delete (required)
+  name: string, A parameter (required)
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -186,16 +186,16 @@ 

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); } + { }
get(name, x__xgafv=None) -
Gets a ResourceValueConfig.
+  
 
 Args:
-  name: string, Required. Name of the resource value config to retrieve. Its format is `organizations/{organization}/resourceValueConfigs/{config_id}`. (required)
+  name: string, A parameter (required)
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -204,36 +204,36 @@ 

Method Details

Returns: An object of the form: - { # A resource value configuration (RVC) is a mapping configuration of user's resources to resource values. Used in Attack path simulations. - "cloudProvider": "A String", # Cloud provider this configuration applies to - "createTime": "A String", # Output only. Timestamp this resource value configuration was created. - "description": "A String", # Description of the resource value configuration. - "name": "A String", # Name for the resource value configuration - "resourceLabelsSelector": { # List of resource labels to search for, evaluated with `AND`. For example, `"resource_labels_selector": {"key": "value", "env": "prod"}` will match resources with labels "key": "value" `AND` "env": "prod" https://cloud.google.com/resource-manager/docs/creating-managing-labels + { + "cloudProvider": "A String", + "createTime": "A String", + "description": "A String", + "name": "A String", + "resourceLabelsSelector": { "a_key": "A String", }, - "resourceType": "A String", # Apply resource_value only to resources that match resource_type. resource_type will be checked with `AND` of other resources. For example, "storage.googleapis.com/Bucket" with resource_value "HIGH" will apply "HIGH" value only to "storage.googleapis.com/Bucket" resources. - "resourceValue": "A String", # Required. Resource value level this expression represents - "scope": "A String", # Project or folder to scope this configuration to. For example, "project/456" would apply this configuration only to resources in "project/456" scope will be checked with `AND` of other resources. - "sensitiveDataProtectionMapping": { # Resource value mapping for Sensitive Data Protection findings. If any of these mappings have a resource value that is not unspecified, the resource_value field will be ignored when reading this configuration. # A mapping of the sensitivity on Sensitive Data Protection finding to resource values. This mapping can only be used in combination with a resource_type that is related to BigQuery, e.g. "bigquery.googleapis.com/Dataset". - "highSensitivityMapping": "A String", # Resource value mapping for high-sensitivity Sensitive Data Protection findings - "mediumSensitivityMapping": "A String", # Resource value mapping for medium-sensitivity Sensitive Data Protection findings + "resourceType": "A String", + "resourceValue": "A String", + "scope": "A String", + "sensitiveDataProtectionMapping": { + "highSensitivityMapping": "A String", + "mediumSensitivityMapping": "A String", }, - "tagValues": [ # Required. Tag values combined with `AND` to check against. For Google Cloud resources, they are tag value IDs in the form of "tagValues/123". Example: `[ "tagValues/123", "tagValues/456", "tagValues/789" ]` https://cloud.google.com/resource-manager/docs/tags/tags-creating-and-managing + "tagValues": [ "A String", ], - "updateTime": "A String", # Output only. Timestamp this resource value configuration was last updated. + "updateTime": "A String", }
list(parent, pageSize=None, pageToken=None, x__xgafv=None) -
Lists all ResourceValueConfigs.
+  
 
 Args:
-  parent: string, Required. The parent, which owns the collection of resource value configs. Its format is `organizations/[organization_id]` (required)
-  pageSize: integer, The number of results to return. The service may return fewer than this value. If unspecified, at most 10 configs will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
-  pageToken: string, A page token, received from a previous `ListResourceValueConfigs` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListResourceValueConfigs` must match the call that provided the page token. page_size can be specified, and the new page_size will be used.
+  parent: string, A parameter (required)
+  pageSize: integer, A parameter
+  pageToken: string, A parameter
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -242,28 +242,28 @@ 

Method Details

Returns: An object of the form: - { # Response message to list resource value configs - "nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is empty, there are no subsequent pages. - "resourceValueConfigs": [ # The resource value configs from the specified parent. - { # A resource value configuration (RVC) is a mapping configuration of user's resources to resource values. Used in Attack path simulations. - "cloudProvider": "A String", # Cloud provider this configuration applies to - "createTime": "A String", # Output only. Timestamp this resource value configuration was created. - "description": "A String", # Description of the resource value configuration. - "name": "A String", # Name for the resource value configuration - "resourceLabelsSelector": { # List of resource labels to search for, evaluated with `AND`. For example, `"resource_labels_selector": {"key": "value", "env": "prod"}` will match resources with labels "key": "value" `AND` "env": "prod" https://cloud.google.com/resource-manager/docs/creating-managing-labels + { + "nextPageToken": "A String", + "resourceValueConfigs": [ + { + "cloudProvider": "A String", + "createTime": "A String", + "description": "A String", + "name": "A String", + "resourceLabelsSelector": { "a_key": "A String", }, - "resourceType": "A String", # Apply resource_value only to resources that match resource_type. resource_type will be checked with `AND` of other resources. For example, "storage.googleapis.com/Bucket" with resource_value "HIGH" will apply "HIGH" value only to "storage.googleapis.com/Bucket" resources. - "resourceValue": "A String", # Required. Resource value level this expression represents - "scope": "A String", # Project or folder to scope this configuration to. For example, "project/456" would apply this configuration only to resources in "project/456" scope will be checked with `AND` of other resources. - "sensitiveDataProtectionMapping": { # Resource value mapping for Sensitive Data Protection findings. If any of these mappings have a resource value that is not unspecified, the resource_value field will be ignored when reading this configuration. # A mapping of the sensitivity on Sensitive Data Protection finding to resource values. This mapping can only be used in combination with a resource_type that is related to BigQuery, e.g. "bigquery.googleapis.com/Dataset". - "highSensitivityMapping": "A String", # Resource value mapping for high-sensitivity Sensitive Data Protection findings - "mediumSensitivityMapping": "A String", # Resource value mapping for medium-sensitivity Sensitive Data Protection findings + "resourceType": "A String", + "resourceValue": "A String", + "scope": "A String", + "sensitiveDataProtectionMapping": { + "highSensitivityMapping": "A String", + "mediumSensitivityMapping": "A String", }, - "tagValues": [ # Required. Tag values combined with `AND` to check against. For Google Cloud resources, they are tag value IDs in the form of "tagValues/123". Example: `[ "tagValues/123", "tagValues/456", "tagValues/789" ]` https://cloud.google.com/resource-manager/docs/tags/tags-creating-and-managing + "tagValues": [ "A String", ], - "updateTime": "A String", # Output only. Timestamp this resource value configuration was last updated. + "updateTime": "A String", }, ], }
@@ -285,35 +285,35 @@

Method Details

patch(name, body=None, updateMask=None, x__xgafv=None) -
Updates an existing ResourceValueConfigs with new rules.
+  
 
 Args:
-  name: string, Name for the resource value configuration (required)
+  name: string, A parameter (required)
   body: object, The request body.
     The object takes the form of:
 
-{ # A resource value configuration (RVC) is a mapping configuration of user's resources to resource values. Used in Attack path simulations.
-  "cloudProvider": "A String", # Cloud provider this configuration applies to
-  "createTime": "A String", # Output only. Timestamp this resource value configuration was created.
-  "description": "A String", # Description of the resource value configuration.
-  "name": "A String", # Name for the resource value configuration
-  "resourceLabelsSelector": { # List of resource labels to search for, evaluated with `AND`. For example, `"resource_labels_selector": {"key": "value", "env": "prod"}` will match resources with labels "key": "value" `AND` "env": "prod" https://cloud.google.com/resource-manager/docs/creating-managing-labels
+{
+  "cloudProvider": "A String",
+  "createTime": "A String",
+  "description": "A String",
+  "name": "A String",
+  "resourceLabelsSelector": {
     "a_key": "A String",
   },
-  "resourceType": "A String", # Apply resource_value only to resources that match resource_type. resource_type will be checked with `AND` of other resources. For example, "storage.googleapis.com/Bucket" with resource_value "HIGH" will apply "HIGH" value only to "storage.googleapis.com/Bucket" resources.
-  "resourceValue": "A String", # Required. Resource value level this expression represents
-  "scope": "A String", # Project or folder to scope this configuration to. For example, "project/456" would apply this configuration only to resources in "project/456" scope will be checked with `AND` of other resources.
-  "sensitiveDataProtectionMapping": { # Resource value mapping for Sensitive Data Protection findings. If any of these mappings have a resource value that is not unspecified, the resource_value field will be ignored when reading this configuration. # A mapping of the sensitivity on Sensitive Data Protection finding to resource values. This mapping can only be used in combination with a resource_type that is related to BigQuery, e.g. "bigquery.googleapis.com/Dataset".
-    "highSensitivityMapping": "A String", # Resource value mapping for high-sensitivity Sensitive Data Protection findings
-    "mediumSensitivityMapping": "A String", # Resource value mapping for medium-sensitivity Sensitive Data Protection findings
+  "resourceType": "A String",
+  "resourceValue": "A String",
+  "scope": "A String",
+  "sensitiveDataProtectionMapping": {
+    "highSensitivityMapping": "A String",
+    "mediumSensitivityMapping": "A String",
   },
-  "tagValues": [ # Required. Tag values combined with `AND` to check against. For Google Cloud resources, they are tag value IDs in the form of "tagValues/123". Example: `[ "tagValues/123", "tagValues/456", "tagValues/789" ]` https://cloud.google.com/resource-manager/docs/tags/tags-creating-and-managing
+  "tagValues": [
     "A String",
   ],
-  "updateTime": "A String", # Output only. Timestamp this resource value configuration was last updated.
+  "updateTime": "A String",
 }
 
-  updateMask: string, The list of fields to be updated. If empty all mutable fields will be updated.
+  updateMask: string, A parameter
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -322,25 +322,25 @@ 

Method Details

Returns: An object of the form: - { # A resource value configuration (RVC) is a mapping configuration of user's resources to resource values. Used in Attack path simulations. - "cloudProvider": "A String", # Cloud provider this configuration applies to - "createTime": "A String", # Output only. Timestamp this resource value configuration was created. - "description": "A String", # Description of the resource value configuration. - "name": "A String", # Name for the resource value configuration - "resourceLabelsSelector": { # List of resource labels to search for, evaluated with `AND`. For example, `"resource_labels_selector": {"key": "value", "env": "prod"}` will match resources with labels "key": "value" `AND` "env": "prod" https://cloud.google.com/resource-manager/docs/creating-managing-labels + { + "cloudProvider": "A String", + "createTime": "A String", + "description": "A String", + "name": "A String", + "resourceLabelsSelector": { "a_key": "A String", }, - "resourceType": "A String", # Apply resource_value only to resources that match resource_type. resource_type will be checked with `AND` of other resources. For example, "storage.googleapis.com/Bucket" with resource_value "HIGH" will apply "HIGH" value only to "storage.googleapis.com/Bucket" resources. - "resourceValue": "A String", # Required. Resource value level this expression represents - "scope": "A String", # Project or folder to scope this configuration to. For example, "project/456" would apply this configuration only to resources in "project/456" scope will be checked with `AND` of other resources. - "sensitiveDataProtectionMapping": { # Resource value mapping for Sensitive Data Protection findings. If any of these mappings have a resource value that is not unspecified, the resource_value field will be ignored when reading this configuration. # A mapping of the sensitivity on Sensitive Data Protection finding to resource values. This mapping can only be used in combination with a resource_type that is related to BigQuery, e.g. "bigquery.googleapis.com/Dataset". - "highSensitivityMapping": "A String", # Resource value mapping for high-sensitivity Sensitive Data Protection findings - "mediumSensitivityMapping": "A String", # Resource value mapping for medium-sensitivity Sensitive Data Protection findings + "resourceType": "A String", + "resourceValue": "A String", + "scope": "A String", + "sensitiveDataProtectionMapping": { + "highSensitivityMapping": "A String", + "mediumSensitivityMapping": "A String", }, - "tagValues": [ # Required. Tag values combined with `AND` to check against. For Google Cloud resources, they are tag value IDs in the form of "tagValues/123". Example: `[ "tagValues/123", "tagValues/456", "tagValues/789" ]` https://cloud.google.com/resource-manager/docs/tags/tags-creating-and-managing + "tagValues": [ "A String", ], - "updateTime": "A String", # Output only. Timestamp this resource value configuration was last updated. + "updateTime": "A String", }
diff --git a/docs/dyn/securitycenter_v1.organizations.securityHealthAnalyticsSettings.customModules.html b/docs/dyn/securitycenter_v1.organizations.securityHealthAnalyticsSettings.customModules.html index ce7c2551b4..96341b8f0b 100644 --- a/docs/dyn/securitycenter_v1.organizations.securityHealthAnalyticsSettings.customModules.html +++ b/docs/dyn/securitycenter_v1.organizations.securityHealthAnalyticsSettings.customModules.html @@ -79,19 +79,19 @@

Instance Methods

Close httplib2 connections.

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

-

Creates a resident SecurityHealthAnalyticsCustomModule at the scope of the given CRM parent, and also creates inherited SecurityHealthAnalyticsCustomModules for all CRM descendants of the given parent. These modules are enabled by default.

+

delete(name, x__xgafv=None)

-

Deletes the specified SecurityHealthAnalyticsCustomModule and all of its descendants in the CRM hierarchy. This method is only supported for resident custom modules.

+

get(name, x__xgafv=None)

-

Retrieves a SecurityHealthAnalyticsCustomModule.

+

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

-

Returns a list of all SecurityHealthAnalyticsCustomModules for the given parent. This includes resident modules defined at the scope of the parent, and inherited modules, inherited from CRM ancestors.

+

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

-

Returns a list of all resident SecurityHealthAnalyticsCustomModules under the given CRM parent and all of the parent’s CRM descendants.

+

listDescendant_next()

Retrieves the next page of results.

@@ -100,10 +100,10 @@

Instance Methods

Retrieves the next page of results.

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

-

Updates the SecurityHealthAnalyticsCustomModule under the given name based on the given update mask. Updating the enablement state is supported on both resident and inherited modules (though resident modules cannot have an enablement state of "inherited"). Updating the display name and custom config of a module is supported on resident modules only.

+

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

-

Simulates a given SecurityHealthAnalyticsCustomModule and Resource.

+

Method Details

close() @@ -112,50 +112,50 @@

Method Details

create(parent, body=None, x__xgafv=None) -
Creates a resident SecurityHealthAnalyticsCustomModule at the scope of the given CRM parent, and also creates inherited SecurityHealthAnalyticsCustomModules for all CRM descendants of the given parent. These modules are enabled by default.
+  
 
 Args:
-  parent: string, Required. Resource name of the new custom module's parent. Its format is `organizations/{organization}/securityHealthAnalyticsSettings`, `folders/{folder}/securityHealthAnalyticsSettings`, or `projects/{project}/securityHealthAnalyticsSettings` (required)
+  parent: string, A parameter (required)
   body: object, The request body.
     The object takes the form of:
 
-{ # Represents an instance of a Security Health Analytics custom module, including its full module name, display name, enablement state, and last updated time. You can create a custom module at the organization, folder, or project level. Custom modules that you create at the organization or folder level are inherited by the child folders and projects.
-  "ancestorModule": "A String", # Output only. If empty, indicates that the custom module was created in the organization, folder, or project in which you are viewing the custom module. Otherwise, `ancestor_module` specifies the organization or folder from which the custom module is inherited.
-  "cloudProvider": "A String", # The cloud provider of the custom module.
-  "customConfig": { # Defines the properties in a custom module configuration for Security Health Analytics. Use the custom module configuration to create custom detectors that generate custom findings for resources that you specify. # The user specified custom configuration for the module.
-    "customOutput": { # A set of optional name-value pairs that define custom source properties to return with each finding that is generated by the custom module. The custom source properties that are defined here are included in the finding JSON under `sourceProperties`. # Custom output properties.
-      "properties": [ # A list of custom output properties to add to the finding.
-        { # An individual name-value pair that defines a custom source property.
-          "name": "A String", # Name of the property for the custom output.
-          "valueExpression": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The CEL expression for the custom output. A resource property can be specified to return the value of the property or a text string enclosed in quotation marks.
-            "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
-            "expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
-            "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
-            "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
+{
+  "ancestorModule": "A String",
+  "cloudProvider": "A String",
+  "customConfig": {
+    "customOutput": {
+      "properties": [
+        {
+          "name": "A String",
+          "valueExpression": {
+            "description": "A String",
+            "expression": "A String",
+            "location": "A String",
+            "title": "A String",
           },
         },
       ],
     },
-    "description": "A String", # Text that describes the vulnerability or misconfiguration that the custom module detects. This explanation is returned with each finding instance to help investigators understand the detected issue. The text must be enclosed in quotation marks.
-    "predicate": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The CEL expression to evaluate to produce findings. When the expression evaluates to true against a resource, a finding is generated.
-      "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
-      "expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
-      "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
-      "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
+    "description": "A String",
+    "predicate": {
+      "description": "A String",
+      "expression": "A String",
+      "location": "A String",
+      "title": "A String",
     },
-    "recommendation": "A String", # An explanation of the recommended steps that security teams can take to resolve the detected issue. This explanation is returned with each finding generated by this module in the `nextSteps` property of the finding JSON.
-    "resourceSelector": { # Resource for selecting resource type. # The resource types that the custom module operates on. Each custom module can specify up to 5 resource types.
-      "resourceTypes": [ # The resource types to run the detector on.
+    "recommendation": "A String",
+    "resourceSelector": {
+      "resourceTypes": [
         "A String",
       ],
     },
-    "severity": "A String", # The severity to assign to findings generated by the module.
+    "severity": "A String",
   },
-  "displayName": "A String", # The display name of the Security Health Analytics custom module. This display name becomes the finding category for all findings that are returned by this custom module. The display name must be between 1 and 128 characters, start with a lowercase letter, and contain alphanumeric characters or underscores only.
-  "enablementState": "A String", # The enablement state of the custom module.
-  "lastEditor": "A String", # Output only. The editor that last updated the custom module.
-  "name": "A String", # Immutable. The resource name of the custom module. Its format is "organizations/{organization}/securityHealthAnalyticsSettings/customModules/{customModule}", or "folders/{folder}/securityHealthAnalyticsSettings/customModules/{customModule}", or "projects/{project}/securityHealthAnalyticsSettings/customModules/{customModule}" The id {customModule} is server-generated and is not user settable. It will be a numeric id containing 1-20 digits.
-  "updateTime": "A String", # Output only. The time at which the custom module was last updated.
+  "displayName": "A String",
+  "enablementState": "A String",
+  "lastEditor": "A String",
+  "name": "A String",
+  "updateTime": "A String",
 }
 
   x__xgafv: string, V1 error format.
@@ -166,52 +166,52 @@ 

Method Details

Returns: An object of the form: - { # Represents an instance of a Security Health Analytics custom module, including its full module name, display name, enablement state, and last updated time. You can create a custom module at the organization, folder, or project level. Custom modules that you create at the organization or folder level are inherited by the child folders and projects. - "ancestorModule": "A String", # Output only. If empty, indicates that the custom module was created in the organization, folder, or project in which you are viewing the custom module. Otherwise, `ancestor_module` specifies the organization or folder from which the custom module is inherited. - "cloudProvider": "A String", # The cloud provider of the custom module. - "customConfig": { # Defines the properties in a custom module configuration for Security Health Analytics. Use the custom module configuration to create custom detectors that generate custom findings for resources that you specify. # The user specified custom configuration for the module. - "customOutput": { # A set of optional name-value pairs that define custom source properties to return with each finding that is generated by the custom module. The custom source properties that are defined here are included in the finding JSON under `sourceProperties`. # Custom output properties. - "properties": [ # A list of custom output properties to add to the finding. - { # An individual name-value pair that defines a custom source property. - "name": "A String", # Name of the property for the custom output. - "valueExpression": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The CEL expression for the custom output. A resource property can be specified to return the value of the property or a text string enclosed in quotation marks. - "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. - "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. - "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file. - "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. + { + "ancestorModule": "A String", + "cloudProvider": "A String", + "customConfig": { + "customOutput": { + "properties": [ + { + "name": "A String", + "valueExpression": { + "description": "A String", + "expression": "A String", + "location": "A String", + "title": "A String", }, }, ], }, - "description": "A String", # Text that describes the vulnerability or misconfiguration that the custom module detects. This explanation is returned with each finding instance to help investigators understand the detected issue. The text must be enclosed in quotation marks. - "predicate": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The CEL expression to evaluate to produce findings. When the expression evaluates to true against a resource, a finding is generated. - "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. - "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. - "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file. - "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. + "description": "A String", + "predicate": { + "description": "A String", + "expression": "A String", + "location": "A String", + "title": "A String", }, - "recommendation": "A String", # An explanation of the recommended steps that security teams can take to resolve the detected issue. This explanation is returned with each finding generated by this module in the `nextSteps` property of the finding JSON. - "resourceSelector": { # Resource for selecting resource type. # The resource types that the custom module operates on. Each custom module can specify up to 5 resource types. - "resourceTypes": [ # The resource types to run the detector on. + "recommendation": "A String", + "resourceSelector": { + "resourceTypes": [ "A String", ], }, - "severity": "A String", # The severity to assign to findings generated by the module. + "severity": "A String", }, - "displayName": "A String", # The display name of the Security Health Analytics custom module. This display name becomes the finding category for all findings that are returned by this custom module. The display name must be between 1 and 128 characters, start with a lowercase letter, and contain alphanumeric characters or underscores only. - "enablementState": "A String", # The enablement state of the custom module. - "lastEditor": "A String", # Output only. The editor that last updated the custom module. - "name": "A String", # Immutable. The resource name of the custom module. Its format is "organizations/{organization}/securityHealthAnalyticsSettings/customModules/{customModule}", or "folders/{folder}/securityHealthAnalyticsSettings/customModules/{customModule}", or "projects/{project}/securityHealthAnalyticsSettings/customModules/{customModule}" The id {customModule} is server-generated and is not user settable. It will be a numeric id containing 1-20 digits. - "updateTime": "A String", # Output only. The time at which the custom module was last updated. + "displayName": "A String", + "enablementState": "A String", + "lastEditor": "A String", + "name": "A String", + "updateTime": "A String", }
delete(name, x__xgafv=None) -
Deletes the specified SecurityHealthAnalyticsCustomModule and all of its descendants in the CRM hierarchy. This method is only supported for resident custom modules.
+  
 
 Args:
-  name: string, Required. Name of the custom module to delete. Its format is `organizations/{organization}/securityHealthAnalyticsSettings/customModules/{customModule}`, `folders/{folder}/securityHealthAnalyticsSettings/customModules/{customModule}`, or `projects/{project}/securityHealthAnalyticsSettings/customModules/{customModule}` (required)
+  name: string, A parameter (required)
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -220,16 +220,16 @@ 

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); } + { }
get(name, x__xgafv=None) -
Retrieves a SecurityHealthAnalyticsCustomModule.
+  
 
 Args:
-  name: string, Required. Name of the custom module to get. Its format is `organizations/{organization}/securityHealthAnalyticsSettings/customModules/{customModule}`, `folders/{folder}/securityHealthAnalyticsSettings/customModules/{customModule}`, or `projects/{project}/securityHealthAnalyticsSettings/customModules/{customModule}` (required)
+  name: string, A parameter (required)
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -238,54 +238,54 @@ 

Method Details

Returns: An object of the form: - { # Represents an instance of a Security Health Analytics custom module, including its full module name, display name, enablement state, and last updated time. You can create a custom module at the organization, folder, or project level. Custom modules that you create at the organization or folder level are inherited by the child folders and projects. - "ancestorModule": "A String", # Output only. If empty, indicates that the custom module was created in the organization, folder, or project in which you are viewing the custom module. Otherwise, `ancestor_module` specifies the organization or folder from which the custom module is inherited. - "cloudProvider": "A String", # The cloud provider of the custom module. - "customConfig": { # Defines the properties in a custom module configuration for Security Health Analytics. Use the custom module configuration to create custom detectors that generate custom findings for resources that you specify. # The user specified custom configuration for the module. - "customOutput": { # A set of optional name-value pairs that define custom source properties to return with each finding that is generated by the custom module. The custom source properties that are defined here are included in the finding JSON under `sourceProperties`. # Custom output properties. - "properties": [ # A list of custom output properties to add to the finding. - { # An individual name-value pair that defines a custom source property. - "name": "A String", # Name of the property for the custom output. - "valueExpression": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The CEL expression for the custom output. A resource property can be specified to return the value of the property or a text string enclosed in quotation marks. - "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. - "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. - "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file. - "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. + { + "ancestorModule": "A String", + "cloudProvider": "A String", + "customConfig": { + "customOutput": { + "properties": [ + { + "name": "A String", + "valueExpression": { + "description": "A String", + "expression": "A String", + "location": "A String", + "title": "A String", }, }, ], }, - "description": "A String", # Text that describes the vulnerability or misconfiguration that the custom module detects. This explanation is returned with each finding instance to help investigators understand the detected issue. The text must be enclosed in quotation marks. - "predicate": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The CEL expression to evaluate to produce findings. When the expression evaluates to true against a resource, a finding is generated. - "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. - "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. - "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file. - "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. + "description": "A String", + "predicate": { + "description": "A String", + "expression": "A String", + "location": "A String", + "title": "A String", }, - "recommendation": "A String", # An explanation of the recommended steps that security teams can take to resolve the detected issue. This explanation is returned with each finding generated by this module in the `nextSteps` property of the finding JSON. - "resourceSelector": { # Resource for selecting resource type. # The resource types that the custom module operates on. Each custom module can specify up to 5 resource types. - "resourceTypes": [ # The resource types to run the detector on. + "recommendation": "A String", + "resourceSelector": { + "resourceTypes": [ "A String", ], }, - "severity": "A String", # The severity to assign to findings generated by the module. + "severity": "A String", }, - "displayName": "A String", # The display name of the Security Health Analytics custom module. This display name becomes the finding category for all findings that are returned by this custom module. The display name must be between 1 and 128 characters, start with a lowercase letter, and contain alphanumeric characters or underscores only. - "enablementState": "A String", # The enablement state of the custom module. - "lastEditor": "A String", # Output only. The editor that last updated the custom module. - "name": "A String", # Immutable. The resource name of the custom module. Its format is "organizations/{organization}/securityHealthAnalyticsSettings/customModules/{customModule}", or "folders/{folder}/securityHealthAnalyticsSettings/customModules/{customModule}", or "projects/{project}/securityHealthAnalyticsSettings/customModules/{customModule}" The id {customModule} is server-generated and is not user settable. It will be a numeric id containing 1-20 digits. - "updateTime": "A String", # Output only. The time at which the custom module was last updated. + "displayName": "A String", + "enablementState": "A String", + "lastEditor": "A String", + "name": "A String", + "updateTime": "A String", }
list(parent, pageSize=None, pageToken=None, x__xgafv=None) -
Returns a list of all SecurityHealthAnalyticsCustomModules for the given parent. This includes resident modules defined at the scope of the parent, and inherited modules, inherited from CRM ancestors.
+  
 
 Args:
-  parent: string, Required. Name of parent to list custom modules. Its format is `organizations/{organization}/securityHealthAnalyticsSettings`, `folders/{folder}/securityHealthAnalyticsSettings`, or `projects/{project}/securityHealthAnalyticsSettings` (required)
-  pageSize: integer, The maximum number of results to return in a single response. Default is 10, minimum is 1, maximum is 1000.
-  pageToken: string, The value returned by the last call indicating a continuation
+  parent: string, A parameter (required)
+  pageSize: integer, A parameter
+  pageToken: string, A parameter
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -294,46 +294,46 @@ 

Method Details

Returns: An object of the form: - { # Response message for listing Security Health Analytics custom modules. - "nextPageToken": "A String", # If not empty, indicates that there may be more custom modules to be returned. - "securityHealthAnalyticsCustomModules": [ # Custom modules belonging to the requested parent. - { # Represents an instance of a Security Health Analytics custom module, including its full module name, display name, enablement state, and last updated time. You can create a custom module at the organization, folder, or project level. Custom modules that you create at the organization or folder level are inherited by the child folders and projects. - "ancestorModule": "A String", # Output only. If empty, indicates that the custom module was created in the organization, folder, or project in which you are viewing the custom module. Otherwise, `ancestor_module` specifies the organization or folder from which the custom module is inherited. - "cloudProvider": "A String", # The cloud provider of the custom module. - "customConfig": { # Defines the properties in a custom module configuration for Security Health Analytics. Use the custom module configuration to create custom detectors that generate custom findings for resources that you specify. # The user specified custom configuration for the module. - "customOutput": { # A set of optional name-value pairs that define custom source properties to return with each finding that is generated by the custom module. The custom source properties that are defined here are included in the finding JSON under `sourceProperties`. # Custom output properties. - "properties": [ # A list of custom output properties to add to the finding. - { # An individual name-value pair that defines a custom source property. - "name": "A String", # Name of the property for the custom output. - "valueExpression": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The CEL expression for the custom output. A resource property can be specified to return the value of the property or a text string enclosed in quotation marks. - "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. - "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. - "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file. - "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. + { + "nextPageToken": "A String", + "securityHealthAnalyticsCustomModules": [ + { + "ancestorModule": "A String", + "cloudProvider": "A String", + "customConfig": { + "customOutput": { + "properties": [ + { + "name": "A String", + "valueExpression": { + "description": "A String", + "expression": "A String", + "location": "A String", + "title": "A String", }, }, ], }, - "description": "A String", # Text that describes the vulnerability or misconfiguration that the custom module detects. This explanation is returned with each finding instance to help investigators understand the detected issue. The text must be enclosed in quotation marks. - "predicate": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The CEL expression to evaluate to produce findings. When the expression evaluates to true against a resource, a finding is generated. - "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. - "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. - "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file. - "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. + "description": "A String", + "predicate": { + "description": "A String", + "expression": "A String", + "location": "A String", + "title": "A String", }, - "recommendation": "A String", # An explanation of the recommended steps that security teams can take to resolve the detected issue. This explanation is returned with each finding generated by this module in the `nextSteps` property of the finding JSON. - "resourceSelector": { # Resource for selecting resource type. # The resource types that the custom module operates on. Each custom module can specify up to 5 resource types. - "resourceTypes": [ # The resource types to run the detector on. + "recommendation": "A String", + "resourceSelector": { + "resourceTypes": [ "A String", ], }, - "severity": "A String", # The severity to assign to findings generated by the module. + "severity": "A String", }, - "displayName": "A String", # The display name of the Security Health Analytics custom module. This display name becomes the finding category for all findings that are returned by this custom module. The display name must be between 1 and 128 characters, start with a lowercase letter, and contain alphanumeric characters or underscores only. - "enablementState": "A String", # The enablement state of the custom module. - "lastEditor": "A String", # Output only. The editor that last updated the custom module. - "name": "A String", # Immutable. The resource name of the custom module. Its format is "organizations/{organization}/securityHealthAnalyticsSettings/customModules/{customModule}", or "folders/{folder}/securityHealthAnalyticsSettings/customModules/{customModule}", or "projects/{project}/securityHealthAnalyticsSettings/customModules/{customModule}" The id {customModule} is server-generated and is not user settable. It will be a numeric id containing 1-20 digits. - "updateTime": "A String", # Output only. The time at which the custom module was last updated. + "displayName": "A String", + "enablementState": "A String", + "lastEditor": "A String", + "name": "A String", + "updateTime": "A String", }, ], }
@@ -341,12 +341,12 @@

Method Details

listDescendant(parent, pageSize=None, pageToken=None, x__xgafv=None) -
Returns a list of all resident SecurityHealthAnalyticsCustomModules under the given CRM parent and all of the parent’s CRM descendants.
+  
 
 Args:
-  parent: string, Required. Name of parent to list descendant custom modules. Its format is `organizations/{organization}/securityHealthAnalyticsSettings`, `folders/{folder}/securityHealthAnalyticsSettings`, or `projects/{project}/securityHealthAnalyticsSettings` (required)
-  pageSize: integer, The maximum number of results to return in a single response. Default is 10, minimum is 1, maximum is 1000.
-  pageToken: string, The value returned by the last call indicating a continuation
+  parent: string, A parameter (required)
+  pageSize: integer, A parameter
+  pageToken: string, A parameter
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -355,46 +355,46 @@ 

Method Details

Returns: An object of the form: - { # Response message for listing descendant Security Health Analytics custom modules. - "nextPageToken": "A String", # If not empty, indicates that there may be more custom modules to be returned. - "securityHealthAnalyticsCustomModules": [ # Custom modules belonging to the requested parent and its descendants. - { # Represents an instance of a Security Health Analytics custom module, including its full module name, display name, enablement state, and last updated time. You can create a custom module at the organization, folder, or project level. Custom modules that you create at the organization or folder level are inherited by the child folders and projects. - "ancestorModule": "A String", # Output only. If empty, indicates that the custom module was created in the organization, folder, or project in which you are viewing the custom module. Otherwise, `ancestor_module` specifies the organization or folder from which the custom module is inherited. - "cloudProvider": "A String", # The cloud provider of the custom module. - "customConfig": { # Defines the properties in a custom module configuration for Security Health Analytics. Use the custom module configuration to create custom detectors that generate custom findings for resources that you specify. # The user specified custom configuration for the module. - "customOutput": { # A set of optional name-value pairs that define custom source properties to return with each finding that is generated by the custom module. The custom source properties that are defined here are included in the finding JSON under `sourceProperties`. # Custom output properties. - "properties": [ # A list of custom output properties to add to the finding. - { # An individual name-value pair that defines a custom source property. - "name": "A String", # Name of the property for the custom output. - "valueExpression": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The CEL expression for the custom output. A resource property can be specified to return the value of the property or a text string enclosed in quotation marks. - "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. - "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. - "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file. - "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. + { + "nextPageToken": "A String", + "securityHealthAnalyticsCustomModules": [ + { + "ancestorModule": "A String", + "cloudProvider": "A String", + "customConfig": { + "customOutput": { + "properties": [ + { + "name": "A String", + "valueExpression": { + "description": "A String", + "expression": "A String", + "location": "A String", + "title": "A String", }, }, ], }, - "description": "A String", # Text that describes the vulnerability or misconfiguration that the custom module detects. This explanation is returned with each finding instance to help investigators understand the detected issue. The text must be enclosed in quotation marks. - "predicate": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The CEL expression to evaluate to produce findings. When the expression evaluates to true against a resource, a finding is generated. - "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. - "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. - "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file. - "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. + "description": "A String", + "predicate": { + "description": "A String", + "expression": "A String", + "location": "A String", + "title": "A String", }, - "recommendation": "A String", # An explanation of the recommended steps that security teams can take to resolve the detected issue. This explanation is returned with each finding generated by this module in the `nextSteps` property of the finding JSON. - "resourceSelector": { # Resource for selecting resource type. # The resource types that the custom module operates on. Each custom module can specify up to 5 resource types. - "resourceTypes": [ # The resource types to run the detector on. + "recommendation": "A String", + "resourceSelector": { + "resourceTypes": [ "A String", ], }, - "severity": "A String", # The severity to assign to findings generated by the module. + "severity": "A String", }, - "displayName": "A String", # The display name of the Security Health Analytics custom module. This display name becomes the finding category for all findings that are returned by this custom module. The display name must be between 1 and 128 characters, start with a lowercase letter, and contain alphanumeric characters or underscores only. - "enablementState": "A String", # The enablement state of the custom module. - "lastEditor": "A String", # Output only. The editor that last updated the custom module. - "name": "A String", # Immutable. The resource name of the custom module. Its format is "organizations/{organization}/securityHealthAnalyticsSettings/customModules/{customModule}", or "folders/{folder}/securityHealthAnalyticsSettings/customModules/{customModule}", or "projects/{project}/securityHealthAnalyticsSettings/customModules/{customModule}" The id {customModule} is server-generated and is not user settable. It will be a numeric id containing 1-20 digits. - "updateTime": "A String", # Output only. The time at which the custom module was last updated. + "displayName": "A String", + "enablementState": "A String", + "lastEditor": "A String", + "name": "A String", + "updateTime": "A String", }, ], }
@@ -430,53 +430,53 @@

Method Details

patch(name, body=None, updateMask=None, x__xgafv=None) -
Updates the SecurityHealthAnalyticsCustomModule under the given name based on the given update mask. Updating the enablement state is supported on both resident and inherited modules (though resident modules cannot have an enablement state of "inherited"). Updating the display name and custom config of a module is supported on resident modules only.
+  
 
 Args:
-  name: string, Immutable. The resource name of the custom module. Its format is "organizations/{organization}/securityHealthAnalyticsSettings/customModules/{customModule}", or "folders/{folder}/securityHealthAnalyticsSettings/customModules/{customModule}", or "projects/{project}/securityHealthAnalyticsSettings/customModules/{customModule}" The id {customModule} is server-generated and is not user settable. It will be a numeric id containing 1-20 digits. (required)
+  name: string, A parameter (required)
   body: object, The request body.
     The object takes the form of:
 
-{ # Represents an instance of a Security Health Analytics custom module, including its full module name, display name, enablement state, and last updated time. You can create a custom module at the organization, folder, or project level. Custom modules that you create at the organization or folder level are inherited by the child folders and projects.
-  "ancestorModule": "A String", # Output only. If empty, indicates that the custom module was created in the organization, folder, or project in which you are viewing the custom module. Otherwise, `ancestor_module` specifies the organization or folder from which the custom module is inherited.
-  "cloudProvider": "A String", # The cloud provider of the custom module.
-  "customConfig": { # Defines the properties in a custom module configuration for Security Health Analytics. Use the custom module configuration to create custom detectors that generate custom findings for resources that you specify. # The user specified custom configuration for the module.
-    "customOutput": { # A set of optional name-value pairs that define custom source properties to return with each finding that is generated by the custom module. The custom source properties that are defined here are included in the finding JSON under `sourceProperties`. # Custom output properties.
-      "properties": [ # A list of custom output properties to add to the finding.
-        { # An individual name-value pair that defines a custom source property.
-          "name": "A String", # Name of the property for the custom output.
-          "valueExpression": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The CEL expression for the custom output. A resource property can be specified to return the value of the property or a text string enclosed in quotation marks.
-            "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
-            "expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
-            "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
-            "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
+{
+  "ancestorModule": "A String",
+  "cloudProvider": "A String",
+  "customConfig": {
+    "customOutput": {
+      "properties": [
+        {
+          "name": "A String",
+          "valueExpression": {
+            "description": "A String",
+            "expression": "A String",
+            "location": "A String",
+            "title": "A String",
           },
         },
       ],
     },
-    "description": "A String", # Text that describes the vulnerability or misconfiguration that the custom module detects. This explanation is returned with each finding instance to help investigators understand the detected issue. The text must be enclosed in quotation marks.
-    "predicate": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The CEL expression to evaluate to produce findings. When the expression evaluates to true against a resource, a finding is generated.
-      "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
-      "expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
-      "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
-      "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
+    "description": "A String",
+    "predicate": {
+      "description": "A String",
+      "expression": "A String",
+      "location": "A String",
+      "title": "A String",
     },
-    "recommendation": "A String", # An explanation of the recommended steps that security teams can take to resolve the detected issue. This explanation is returned with each finding generated by this module in the `nextSteps` property of the finding JSON.
-    "resourceSelector": { # Resource for selecting resource type. # The resource types that the custom module operates on. Each custom module can specify up to 5 resource types.
-      "resourceTypes": [ # The resource types to run the detector on.
+    "recommendation": "A String",
+    "resourceSelector": {
+      "resourceTypes": [
         "A String",
       ],
     },
-    "severity": "A String", # The severity to assign to findings generated by the module.
+    "severity": "A String",
   },
-  "displayName": "A String", # The display name of the Security Health Analytics custom module. This display name becomes the finding category for all findings that are returned by this custom module. The display name must be between 1 and 128 characters, start with a lowercase letter, and contain alphanumeric characters or underscores only.
-  "enablementState": "A String", # The enablement state of the custom module.
-  "lastEditor": "A String", # Output only. The editor that last updated the custom module.
-  "name": "A String", # Immutable. The resource name of the custom module. Its format is "organizations/{organization}/securityHealthAnalyticsSettings/customModules/{customModule}", or "folders/{folder}/securityHealthAnalyticsSettings/customModules/{customModule}", or "projects/{project}/securityHealthAnalyticsSettings/customModules/{customModule}" The id {customModule} is server-generated and is not user settable. It will be a numeric id containing 1-20 digits.
-  "updateTime": "A String", # Output only. The time at which the custom module was last updated.
+  "displayName": "A String",
+  "enablementState": "A String",
+  "lastEditor": "A String",
+  "name": "A String",
+  "updateTime": "A String",
 }
 
-  updateMask: string, The list of fields to be updated. The only fields that can be updated are `enablement_state` and `custom_config`. If empty or set to the wildcard value `*`, both `enablement_state` and `custom_config` are updated.
+  updateMask: string, A parameter
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -485,121 +485,121 @@ 

Method Details

Returns: An object of the form: - { # Represents an instance of a Security Health Analytics custom module, including its full module name, display name, enablement state, and last updated time. You can create a custom module at the organization, folder, or project level. Custom modules that you create at the organization or folder level are inherited by the child folders and projects. - "ancestorModule": "A String", # Output only. If empty, indicates that the custom module was created in the organization, folder, or project in which you are viewing the custom module. Otherwise, `ancestor_module` specifies the organization or folder from which the custom module is inherited. - "cloudProvider": "A String", # The cloud provider of the custom module. - "customConfig": { # Defines the properties in a custom module configuration for Security Health Analytics. Use the custom module configuration to create custom detectors that generate custom findings for resources that you specify. # The user specified custom configuration for the module. - "customOutput": { # A set of optional name-value pairs that define custom source properties to return with each finding that is generated by the custom module. The custom source properties that are defined here are included in the finding JSON under `sourceProperties`. # Custom output properties. - "properties": [ # A list of custom output properties to add to the finding. - { # An individual name-value pair that defines a custom source property. - "name": "A String", # Name of the property for the custom output. - "valueExpression": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The CEL expression for the custom output. A resource property can be specified to return the value of the property or a text string enclosed in quotation marks. - "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. - "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. - "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file. - "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. + { + "ancestorModule": "A String", + "cloudProvider": "A String", + "customConfig": { + "customOutput": { + "properties": [ + { + "name": "A String", + "valueExpression": { + "description": "A String", + "expression": "A String", + "location": "A String", + "title": "A String", }, }, ], }, - "description": "A String", # Text that describes the vulnerability or misconfiguration that the custom module detects. This explanation is returned with each finding instance to help investigators understand the detected issue. The text must be enclosed in quotation marks. - "predicate": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The CEL expression to evaluate to produce findings. When the expression evaluates to true against a resource, a finding is generated. - "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. - "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. - "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file. - "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. + "description": "A String", + "predicate": { + "description": "A String", + "expression": "A String", + "location": "A String", + "title": "A String", }, - "recommendation": "A String", # An explanation of the recommended steps that security teams can take to resolve the detected issue. This explanation is returned with each finding generated by this module in the `nextSteps` property of the finding JSON. - "resourceSelector": { # Resource for selecting resource type. # The resource types that the custom module operates on. Each custom module can specify up to 5 resource types. - "resourceTypes": [ # The resource types to run the detector on. + "recommendation": "A String", + "resourceSelector": { + "resourceTypes": [ "A String", ], }, - "severity": "A String", # The severity to assign to findings generated by the module. + "severity": "A String", }, - "displayName": "A String", # The display name of the Security Health Analytics custom module. This display name becomes the finding category for all findings that are returned by this custom module. The display name must be between 1 and 128 characters, start with a lowercase letter, and contain alphanumeric characters or underscores only. - "enablementState": "A String", # The enablement state of the custom module. - "lastEditor": "A String", # Output only. The editor that last updated the custom module. - "name": "A String", # Immutable. The resource name of the custom module. Its format is "organizations/{organization}/securityHealthAnalyticsSettings/customModules/{customModule}", or "folders/{folder}/securityHealthAnalyticsSettings/customModules/{customModule}", or "projects/{project}/securityHealthAnalyticsSettings/customModules/{customModule}" The id {customModule} is server-generated and is not user settable. It will be a numeric id containing 1-20 digits. - "updateTime": "A String", # Output only. The time at which the custom module was last updated. + "displayName": "A String", + "enablementState": "A String", + "lastEditor": "A String", + "name": "A String", + "updateTime": "A String", }
simulate(parent, body=None, x__xgafv=None) -
Simulates a given SecurityHealthAnalyticsCustomModule and Resource.
+  
 
 Args:
-  parent: string, Required. The relative resource name of the organization, project, or folder. For more information about relative resource names, see [Relative Resource Name](https://cloud.google.com/apis/design/resource_names#relative_resource_name) Example: `organizations/{organization_id}` (required)
+  parent: string, A parameter (required)
   body: object, The request body.
     The object takes the form of:
 
-{ # Request message to simulate a CustomConfig against a given test resource. Maximum size of the request is 4 MB by default.
-  "customConfig": { # Defines the properties in a custom module configuration for Security Health Analytics. Use the custom module configuration to create custom detectors that generate custom findings for resources that you specify. # Required. The custom configuration that you need to test.
-    "customOutput": { # A set of optional name-value pairs that define custom source properties to return with each finding that is generated by the custom module. The custom source properties that are defined here are included in the finding JSON under `sourceProperties`. # Custom output properties.
-      "properties": [ # A list of custom output properties to add to the finding.
-        { # An individual name-value pair that defines a custom source property.
-          "name": "A String", # Name of the property for the custom output.
-          "valueExpression": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The CEL expression for the custom output. A resource property can be specified to return the value of the property or a text string enclosed in quotation marks.
-            "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
-            "expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
-            "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
-            "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
+{
+  "customConfig": {
+    "customOutput": {
+      "properties": [
+        {
+          "name": "A String",
+          "valueExpression": {
+            "description": "A String",
+            "expression": "A String",
+            "location": "A String",
+            "title": "A String",
           },
         },
       ],
     },
-    "description": "A String", # Text that describes the vulnerability or misconfiguration that the custom module detects. This explanation is returned with each finding instance to help investigators understand the detected issue. The text must be enclosed in quotation marks.
-    "predicate": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The CEL expression to evaluate to produce findings. When the expression evaluates to true against a resource, a finding is generated.
-      "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
-      "expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
-      "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
-      "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
+    "description": "A String",
+    "predicate": {
+      "description": "A String",
+      "expression": "A String",
+      "location": "A String",
+      "title": "A String",
     },
-    "recommendation": "A String", # An explanation of the recommended steps that security teams can take to resolve the detected issue. This explanation is returned with each finding generated by this module in the `nextSteps` property of the finding JSON.
-    "resourceSelector": { # Resource for selecting resource type. # The resource types that the custom module operates on. Each custom module can specify up to 5 resource types.
-      "resourceTypes": [ # The resource types to run the detector on.
+    "recommendation": "A String",
+    "resourceSelector": {
+      "resourceTypes": [
         "A String",
       ],
     },
-    "severity": "A String", # The severity to assign to findings generated by the module.
+    "severity": "A String",
   },
-  "resource": { # Manually constructed resource name. If the custom module evaluates against only the resource data, you can omit the `iam_policy_data` field. If it evaluates only the `iam_policy_data` field, you can omit the resource data. # Required. Resource data to simulate custom module against.
-    "iamPolicyData": { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). # Optional. A representation of the IAM policy.
-      "auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
-        { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging.
-          "auditLogConfigs": [ # The configuration for logging of each type of permission.
-            { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.
-              "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.
+  "resource": {
+    "iamPolicyData": {
+      "auditConfigs": [
+        {
+          "auditLogConfigs": [
+            {
+              "exemptedMembers": [
                 "A String",
               ],
-              "logType": "A String", # The log type that this config enables.
+              "logType": "A String",
             },
           ],
-          "service": "A String", # Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services.
+          "service": "A String",
         },
       ],
-      "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`.
-        { # Associates `members`, or principals, with a `role`.
-          "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
-            "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
-            "expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
-            "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
-            "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
+      "bindings": [
+        {
+          "condition": {
+            "description": "A String",
+            "expression": "A String",
+            "location": "A String",
+            "title": "A String",
           },
-          "members": [ # Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
+          "members": [
             "A String",
           ],
-          "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles).
+          "role": "A String",
         },
       ],
-      "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).
+      "etag": "A String",
+      "version": 42,
     },
-    "resourceData": { # Optional. A representation of the Google Cloud resource. Should match the Google Cloud resource JSON format.
+    "resourceData": {
       "a_key": "", # Properties of the object.
     },
-    "resourceType": "A String", # Required. The type of the resource, for example, `compute.googleapis.com/Disk`.
+    "resourceType": "A String",
   },
 }
 
@@ -611,826 +611,826 @@ 

Method Details

Returns: An object of the form: - { # Response message for simulating a `SecurityHealthAnalyticsCustomModule` against a given resource. - "result": { # Possible test result. # Result for test case in the corresponding request. - "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). # Error encountered during the test. - "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. + { + "result": { + "error": { + "code": 42, + "details": [ { "a_key": "", # Properties of the object. Contains field @type with type URL. }, ], - "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. + "message": "A String", }, - "finding": { # Security Command Center finding. A finding is a record of assessment data like security, risk, health, or privacy, that is ingested into Security Command Center for presentation, notification, analysis, policy testing, and enforcement. For example, a cross-site scripting (XSS) vulnerability in an App Engine application is a finding. # Finding that would be published for the test case, if a violation is detected. - "access": { # Represents an access event. # Access details associated with the finding, such as more information on the caller, which method was accessed, and from where. - "callerIp": "A String", # Caller's IP address, such as "1.1.1.1". - "callerIpGeo": { # Represents a geographical location for a given access. # The caller IP's geolocation, which identifies where the call came from. - "regionCode": "A String", # A CLDR. + "finding": { + "access": { + "callerIp": "A String", + "callerIpGeo": { + "regionCode": "A String", }, - "methodName": "A String", # The method that the service account called, e.g. "SetIamPolicy". - "principalEmail": "A String", # Associated email, such as "foo@google.com". The email address of the authenticated user or a service account acting on behalf of a 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). - "principalSubject": "A String", # A string that represents the principal_subject that is associated with the identity. Unlike `principal_email`, `principal_subject` supports principals that aren't associated with email addresses, such as third party principals. For most identities, the format is `principal://iam.googleapis.com/{identity pool name}/subject/{subject}`. Some GKE identities, such as GKE_WORKLOAD, FREEFORM, and GKE_HUB_WORKLOAD, still use the legacy format `serviceAccount:{identity pool name}[{subject}]`. - "serviceAccountDelegationInfo": [ # The identity delegation history of an authenticated service account that made the request. The `serviceAccountDelegationInfo[]` object contains information about the real authorities that try to access Google Cloud resources by delegating on a service account. When multiple authorities are present, they are guaranteed to be sorted based on the original ordering of the identity delegation events. - { # Identity delegation history of an authenticated service account. - "principalEmail": "A String", # The email address of a Google account. - "principalSubject": "A String", # A string representing the principal_subject associated with the identity. As compared to `principal_email`, supports principals that aren't associated with email addresses, such as third party principals. For most identities, the format will be `principal://iam.googleapis.com/{identity pool name}/subjects/{subject}` except for some GKE identities (GKE_WORKLOAD, FREEFORM, GKE_HUB_WORKLOAD) that are still in the legacy format `serviceAccount:{identity pool name}[{subject}]` + "methodName": "A String", + "principalEmail": "A String", + "principalSubject": "A String", + "serviceAccountDelegationInfo": [ + { + "principalEmail": "A String", + "principalSubject": "A String", }, ], - "serviceAccountKeyName": "A String", # The name of the service account key that was used to create or exchange credentials when authenticating the service account that made the request. This is a scheme-less URI full resource name. For example: "//iam.googleapis.com/projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}/keys/{key}". - "serviceName": "A String", # This is the API service that the service account made a call to, e.g. "iam.googleapis.com" - "userAgent": "A String", # The caller's user agent string associated with the finding. - "userAgentFamily": "A String", # Type of user agent associated with the finding. For example, an operating system shell or an embedded or standalone application. - "userName": "A String", # A string that represents a username. The username provided depends on the type of the finding and is likely not an IAM principal. For example, this can be a system username if the finding is related to a virtual machine, or it can be an application login username. + "serviceAccountKeyName": "A String", + "serviceName": "A String", + "userAgent": "A String", + "userAgentFamily": "A String", + "userName": "A String", }, - "affectedResources": { # Details about resources affected by this finding. # AffectedResources associated with the finding. - "count": "A String", # The count of resources affected by the finding. + "affectedResources": { + "count": "A String", }, - "agentDataAccessEvents": [ # Agent data access events associated with the finding. - { # Details about a data access attempt made by an agent principal not authorized under applicable data security policy. - "eventId": "A String", # Unique identifier for data access event. - "eventTime": "A String", # Timestamp of data access event. - "operation": "A String", # The operation performed by the principal to access the data. - "principalSubject": "A String", # The agent principal that accessed the data. + "agentDataAccessEvents": [ + { + "eventId": "A String", + "eventTime": "A String", + "operation": "A String", + "principalSubject": "A String", }, ], - "aiModel": { # Contains information about the AI model associated with the finding. # The AI model associated with the finding. - "deploymentPlatform": "A String", # The platform on which the model is deployed. - "displayName": "A String", # The user defined display name of model. Ex. baseline-classification-model - "domain": "A String", # The domain of the model, for example, “image-classification”. - "library": "A String", # The name of the model library, for example, “transformers”. - "location": "A String", # The region in which the model is used, for example, “us-central1”. - "name": "A String", # The name of the AI model, for example, "gemini:1.0.0". - "publisher": "A String", # The publisher of the model, for example, “google” or “nvidia”. - "usageCategory": "A String", # The purpose of the model, for example, "Inteference" or "Training". + "aiModel": { + "deploymentPlatform": "A String", + "displayName": "A String", + "domain": "A String", + "library": "A String", + "location": "A String", + "name": "A String", + "publisher": "A String", + "usageCategory": "A String", }, - "application": { # Represents an application associated with a finding. # Represents an application associated with the finding. - "baseUri": "A String", # The base URI that identifies the network location of the application in which the vulnerability was detected. For example, `http://example.com`. - "fullUri": "A String", # The full URI with payload that can be used to reproduce the vulnerability. For example, `http://example.com?p=aMmYgI6H`. + "application": { + "baseUri": "A String", + "fullUri": "A String", }, - "artifactGuardPolicies": { # Represents the result of evaluating artifact guard policies. # ArtifactGuardPolicies associated with the finding. - "failingPolicies": [ # A list of failing policies. - { # Represents an artifact guard policy. - "failureReason": "A String", # The reason for the policy failure, for example, "severity=HIGH AND max_vuln_count=2". - "policyId": "A String", # The ID of the failing policy, for example, "organizations/3392779/locations/global/policies/prod-policy". - "type": "A String", # The type of the policy evaluation. + "artifactGuardPolicies": { + "failingPolicies": [ + { + "failureReason": "A String", + "policyId": "A String", + "type": "A String", }, ], - "resourceId": "A String", # The ID of the resource that has policies configured for it. + "resourceId": "A String", }, - "attackExposure": { # An attack exposure contains the results of an attack path simulation run. # The results of an attack path simulation relevant to this finding. - "attackExposureResult": "A String", # The resource name of the attack path simulation result that contains the details regarding this attack exposure score. Example: `organizations/123/simulations/456/attackExposureResults/789` - "exposedHighValueResourcesCount": 42, # The number of high value resources that are exposed as a result of this finding. - "exposedLowValueResourcesCount": 42, # The number of high value resources that are exposed as a result of this finding. - "exposedMediumValueResourcesCount": 42, # The number of medium value resources that are exposed as a result of this finding. - "latestCalculationTime": "A String", # The most recent time the attack exposure was updated on this finding. - "score": 3.14, # A number between 0 (inclusive) and infinity that represents how important this finding is to remediate. The higher the score, the more important it is to remediate. - "state": "A String", # What state this AttackExposure is in. This captures whether or not an attack exposure has been calculated or not. + "attackExposure": { + "attackExposureResult": "A String", + "exposedHighValueResourcesCount": 42, + "exposedLowValueResourcesCount": 42, + "exposedMediumValueResourcesCount": 42, + "latestCalculationTime": "A String", + "score": 3.14, + "state": "A String", }, - "backupDisasterRecovery": { # Information related to Google Cloud Backup and DR Service findings. # Fields related to Backup and DR findings. - "appliance": "A String", # The name of the Backup and DR appliance that captures, moves, and manages the lifecycle of backup data. For example, `backup-server-57137`. - "applications": [ # The names of Backup and DR applications. An application is a VM, database, or file system on a managed host monitored by a backup and recovery appliance. For example, `centos7-01-vol00`, `centos7-01-vol01`, `centos7-01-vol02`. + "backupDisasterRecovery": { + "appliance": "A String", + "applications": [ "A String", ], - "backupCreateTime": "A String", # The timestamp at which the Backup and DR backup was created. - "backupTemplate": "A String", # The name of a Backup and DR template which comprises one or more backup policies. See the [Backup and DR documentation](https://cloud.google.com/backup-disaster-recovery/docs/concepts/backup-plan#temp) for more information. For example, `snap-ov`. - "backupType": "A String", # The backup type of the Backup and DR image. For example, `Snapshot`, `Remote Snapshot`, `OnVault`. - "host": "A String", # The name of a Backup and DR host, which is managed by the backup and recovery appliance and known to the management console. The host can be of type Generic (for example, Compute Engine, SQL Server, Oracle DB, SMB file system, etc.), vCenter, or an ESX server. See the [Backup and DR documentation on hosts](https://cloud.google.com/backup-disaster-recovery/docs/configuration/manage-hosts-and-their-applications) for more information. For example, `centos7-01`. - "policies": [ # The names of Backup and DR policies that are associated with a template and that define when to run a backup, how frequently to run a backup, and how long to retain the backup image. For example, `onvaults`. + "backupCreateTime": "A String", + "backupTemplate": "A String", + "backupType": "A String", + "host": "A String", + "policies": [ "A String", ], - "policyOptions": [ # The names of Backup and DR advanced policy options of a policy applying to an application. See the [Backup and DR documentation on policy options](https://cloud.google.com/backup-disaster-recovery/docs/create-plan/policy-settings). For example, `skipofflineappsincongrp, nounmap`. + "policyOptions": [ "A String", ], - "profile": "A String", # The name of the Backup and DR resource profile that specifies the storage media for backups of application and VM data. See the [Backup and DR documentation on profiles](https://cloud.google.com/backup-disaster-recovery/docs/concepts/backup-plan#profile). For example, `GCP`. - "storagePool": "A String", # The name of the Backup and DR storage pool that the backup and recovery appliance is storing data in. The storage pool could be of type Cloud, Primary, Snapshot, or OnVault. See the [Backup and DR documentation on storage pools](https://cloud.google.com/backup-disaster-recovery/docs/concepts/storage-pools). For example, `DiskPoolOne`. + "profile": "A String", + "storagePool": "A String", }, - "canonicalName": "A String", # The canonical name of the finding. It's either "organizations/{organization_id}/sources/{source_id}/findings/{finding_id}", "folders/{folder_id}/sources/{source_id}/findings/{finding_id}" or "projects/{project_number}/sources/{source_id}/findings/{finding_id}", depending on the closest CRM ancestor of the resource associated with the finding. - "category": "A String", # The additional taxonomy group within findings from a given source. This field is immutable after creation time. Example: "XSS_FLASH_INJECTION" - "chokepoint": { # Contains details about a chokepoint, which is a resource or resource group where high-risk attack paths converge, based on [attack path simulations] (https://cloud.google.com/security-command-center/docs/attack-exposure-learn#attack_path_simulations). # Contains details about a chokepoint, which is a resource or resource group where high-risk attack paths converge, based on [attack path simulations] (https://cloud.google.com/security-command-center/docs/attack-exposure-learn#attack_path_simulations). This field cannot be updated. Its value is ignored in all update requests. - "relatedFindings": [ # List of resource names of findings associated with this chokepoint. For example, organizations/123/sources/456/findings/789. This list will have at most 100 findings. + "canonicalName": "A String", + "category": "A String", + "chokepoint": { + "relatedFindings": [ "A String", ], }, - "cloudArmor": { # Fields related to Google Cloud Armor findings. # Fields related to Cloud Armor findings. - "adaptiveProtection": { # Information about [Google Cloud Armor Adaptive Protection](https://cloud.google.com/armor/docs/cloud-armor-overview#google-cloud-armor-adaptive-protection). # Information about potential Layer 7 DDoS attacks identified by [Google Cloud Armor Adaptive Protection](https://cloud.google.com/armor/docs/adaptive-protection-overview). - "confidence": 3.14, # A score of 0 means that there is low confidence that the detected event is an actual attack. A score of 1 means that there is high confidence that the detected event is an attack. See the [Adaptive Protection documentation](https://cloud.google.com/armor/docs/adaptive-protection-overview#configure-alert-tuning) for further explanation. + "cloudArmor": { + "adaptiveProtection": { + "confidence": 3.14, }, - "attack": { # Information about DDoS attack volume and classification. # Information about DDoS attack volume and classification. - "classification": "A String", # Type of attack, for example, 'SYN-flood', 'NTP-udp', or 'CHARGEN-udp'. - "volumeBps": 42, # Total BPS (bytes per second) volume of attack. Deprecated - refer to volume_bps_long instead. - "volumeBpsLong": "A String", # Total BPS (bytes per second) volume of attack. - "volumePps": 42, # Total PPS (packets per second) volume of attack. Deprecated - refer to volume_pps_long instead. - "volumePpsLong": "A String", # Total PPS (packets per second) volume of attack. + "attack": { + "classification": "A String", + "volumeBps": 42, + "volumeBpsLong": "A String", + "volumePps": 42, + "volumePpsLong": "A String", }, - "duration": "A String", # Duration of attack from the start until the current moment (updated every 5 minutes). - "requests": { # Information about the requests relevant to the finding. # Information about incoming requests evaluated by [Google Cloud Armor security policies](https://cloud.google.com/armor/docs/security-policy-overview). - "longTermAllowed": 42, # Allowed RPS (requests per second) over the long term. - "longTermDenied": 42, # Denied RPS (requests per second) over the long term. - "ratio": 3.14, # For 'Increasing deny ratio', the ratio is the denied traffic divided by the allowed traffic. For 'Allowed traffic spike', the ratio is the allowed traffic in the short term divided by allowed traffic in the long term. - "shortTermAllowed": 42, # Allowed RPS (requests per second) in the short term. + "duration": "A String", + "requests": { + "longTermAllowed": 42, + "longTermDenied": 42, + "ratio": 3.14, + "shortTermAllowed": 42, }, - "securityPolicy": { # Information about the [Google Cloud Armor security policy](https://cloud.google.com/armor/docs/security-policy-overview) relevant to the finding. # Information about the [Google Cloud Armor security policy](https://cloud.google.com/armor/docs/security-policy-overview) relevant to the finding. - "name": "A String", # The name of the Google Cloud Armor security policy, for example, "my-security-policy". - "preview": True or False, # Whether or not the associated rule or policy is in preview mode. - "type": "A String", # The type of Google Cloud Armor security policy for example, 'backend security policy', 'edge security policy', 'network edge security policy', or 'always-on DDoS protection'. + "securityPolicy": { + "name": "A String", + "preview": True or False, + "type": "A String", }, - "threatVector": "A String", # Distinguish between volumetric & protocol DDoS attack and application layer attacks. For example, "L3_4" for Layer 3 and Layer 4 DDoS attacks, or "L_7" for Layer 7 DDoS attacks. + "threatVector": "A String", }, - "cloudDlpDataProfile": { # The [data profile](https://cloud.google.com/dlp/docs/data-profiles) associated with the finding. # Cloud DLP data profile that is associated with the finding. - "dataProfile": "A String", # Name of the data profile, for example, `projects/123/locations/europe/tableProfiles/8383929`. - "infoTypes": [ # Type of information detected by SDP. Info type includes name, version and sensitivity of the detected information type. - { # Type of information detected by the API. - "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. - "sensitivityScore": { # Score is calculated from of all elements in the data profile. A higher level means the data is more sensitive. # Optional custom sensitivity for this InfoType. This only applies to data profiling. - "score": "A String", # The sensitivity score applied to the resource. + "cloudDlpDataProfile": { + "dataProfile": "A String", + "infoTypes": [ + { + "name": "A String", + "sensitivityScore": { + "score": "A String", }, - "version": "A String", # Optional version name for this InfoType. + "version": "A String", }, ], - "parentType": "A String", # The resource hierarchy level at which the data profile was generated. + "parentType": "A String", }, - "cloudDlpInspection": { # Details about the Cloud Data Loss Prevention (Cloud DLP) [inspection job](https://cloud.google.com/dlp/docs/concepts-job-triggers) that produced the finding. # Cloud Data Loss Prevention (Cloud DLP) inspection results that are associated with the finding. - "fullScan": True or False, # Whether Cloud DLP scanned the complete resource or a sampled subset. - "infoType": "A String", # The type of information (or *[infoType](https://cloud.google.com/dlp/docs/infotypes-reference)*) found, for example, `EMAIL_ADDRESS` or `STREET_ADDRESS`. - "infoTypeCount": "A String", # The number of times Cloud DLP found this infoType within this job and resource. - "inspectJob": "A String", # Name of the inspection job, for example, `projects/123/locations/europe/dlpJobs/i-8383929`. + "cloudDlpInspection": { + "fullScan": True or False, + "infoType": "A String", + "infoTypeCount": "A String", + "inspectJob": "A String", }, - "complianceDetails": { # Compliance Details associated with the finding. # Details about the compliance implications of the finding. - "cloudControl": { # CloudControl associated with the finding. # CloudControl associated with the finding - "cloudControlName": "A String", # Name of the CloudControl associated with the finding. - "policyType": "A String", # Policy type of the CloudControl - "type": "A String", # Type of cloud control. - "version": 42, # Version of the Cloud Control + "complianceDetails": { + "cloudControl": { + "cloudControlName": "A String", + "policyType": "A String", + "type": "A String", + "version": 42, }, - "cloudControlDeploymentNames": [ # Cloud Control Deployments associated with the finding. For example, organizations/123/locations/global/cloudControlDeployments/deploymentIdentifier + "cloudControlDeploymentNames": [ "A String", ], - "frameworks": [ # Details of Frameworks associated with the finding - { # Compliance framework associated with the finding. - "category": [ # Category of the framework associated with the finding. E.g. Security Benchmark, or Assured Workloads + "frameworks": [ + { + "category": [ "A String", ], - "controls": [ # The controls associated with the framework. - { # Compliance control associated with the finding. - "controlName": "A String", # Name of the Control - "displayName": "A String", # Display name of the control. For example, AU-02. + "controls": [ + { + "controlName": "A String", + "displayName": "A String", }, ], - "displayName": "A String", # Display name of the framework. For a standard framework, this will look like e.g. PCI DSS 3.2.1, whereas for a custom framework it can be a user defined string like MyFramework - "name": "A String", # Name of the framework associated with the finding - "type": "A String", # Type of the framework associated with the finding, to specify whether the framework is built-in (pre-defined and immutable) or a custom framework defined by the customer (equivalent to security posture) + "displayName": "A String", + "name": "A String", + "type": "A String", }, ], }, - "compliances": [ # Contains compliance information for security standards associated to the finding. - { # Contains compliance information about a security standard indicating unmet recommendations. - "ids": [ # Policies within the standard or benchmark, for example, A.12.4.1 + "compliances": [ + { + "ids": [ "A String", ], - "standard": "A String", # Industry-wide compliance standards or benchmarks, such as CIS, PCI, and OWASP. - "version": "A String", # Version of the standard or benchmark, for example, 1.1 + "standard": "A String", + "version": "A String", }, ], - "connections": [ # Contains information about the IP connection associated with the finding. - { # Contains information about the IP connection associated with the finding. - "destinationIp": "A String", # Destination IP address. Not present for sockets that are listening and not connected. - "destinationPort": 42, # Destination port. Not present for sockets that are listening and not connected. - "protocol": "A String", # IANA Internet Protocol Number such as TCP(6) and UDP(17). - "sourceIp": "A String", # Source IP address. - "sourcePort": 42, # Source port. + "connections": [ + { + "destinationIp": "A String", + "destinationPort": 42, + "protocol": "A String", + "sourceIp": "A String", + "sourcePort": 42, }, ], - "contacts": { # Output only. Map containing the points of contact for the given finding. The key represents the type of contact, while the value contains a list of all the contacts that pertain. Please refer to: https://cloud.google.com/resource-manager/docs/managing-notification-contacts#notification-categories { "security": { "contacts": [ { "email": "person1@company.com" }, { "email": "person2@company.com" } ] } } - "a_key": { # Details about specific contacts - "contacts": [ # A list of contacts - { # The email address of a contact. - "email": "A String", # An email address. For example, "`person123@company.com`". + "contacts": { + "a_key": { + "contacts": [ + { + "email": "A String", }, ], }, }, - "containers": [ # Containers associated with the finding. This field provides information for both Kubernetes and non-Kubernetes containers. - { # Container associated with the finding. - "createTime": "A String", # The time that the container was created. - "imageId": "A String", # Optional container image ID, if provided by the container runtime. Uniquely identifies the container image launched using a container image digest. - "labels": [ # Container labels, as provided by the container runtime. - { # Represents a generic name-value label. A label has separate name and value fields to support filtering with the `contains()` function. For more information, see [Filtering on array-type fields](https://cloud.google.com/security-command-center/docs/how-to-api-list-findings#array-contains-filtering). - "name": "A String", # Name of the label. - "value": "A String", # Value that corresponds to the label's name. + "containers": [ + { + "createTime": "A String", + "imageId": "A String", + "labels": [ + { + "name": "A String", + "value": "A String", }, ], - "name": "A String", # Name of the container. - "uri": "A String", # Container image URI provided when configuring a pod or container. This string can identify a container image version using mutable tags. + "name": "A String", + "uri": "A String", }, ], - "createTime": "A String", # The time at which the finding was created in Security Command Center. - "dataAccessEvents": [ # Data access events associated with the finding. - { # Details about a data access attempt made by a principal not authorized under applicable data security policy. - "eventId": "A String", # Unique identifier for data access event. - "eventTime": "A String", # Timestamp of data access event. - "operation": "A String", # The operation performed by the principal to access the data. - "principalEmail": "A String", # The email address of the principal that accessed the data. The principal could be a user account, service account, Google group, or other. + "createTime": "A String", + "dataAccessEvents": [ + { + "eventId": "A String", + "eventTime": "A String", + "operation": "A String", + "principalEmail": "A String", }, ], - "dataFlowEvents": [ # Data flow events associated with the finding. - { # Details about a data flow event, in which either the data is moved to or is accessed from a non-compliant geo-location, as defined in the applicable data security policy. - "eventId": "A String", # Unique identifier for data flow event. - "eventTime": "A String", # Timestamp of data flow event. - "operation": "A String", # The operation performed by the principal for the data flow event. - "principalEmail": "A String", # The email address of the principal that initiated the data flow event. The principal could be a user account, service account, Google group, or other. - "violatedLocation": "A String", # Non-compliant location of the principal or the data destination. + "dataFlowEvents": [ + { + "eventId": "A String", + "eventTime": "A String", + "operation": "A String", + "principalEmail": "A String", + "violatedLocation": "A String", }, ], - "dataRetentionDeletionEvents": [ # Data retention deletion events associated with the finding. - { # Details about data retention deletion violations, in which the data is non-compliant based on their retention or deletion time, as defined in the applicable data security policy. The Data Retention Deletion (DRD) control is a control of the DSPM (Data Security Posture Management) suite that enables organizations to manage data retention and deletion policies in compliance with regulations, such as GDPR and CRPA. DRD supports two primary policy types: maximum storage length (max TTL) and minimum storage length (min TTL). Both are aimed at helping organizations meet regulatory and data management commitments. - "dataObjectCount": "A String", # Number of objects that violated the policy for this resource. If the number is less than 1,000, then the value of this field is the exact number. If the number of objects that violated the policy is greater than or equal to 1,000, then the value of this field is 1000. - "eventDetectionTime": "A String", # Timestamp indicating when the event was detected. - "eventType": "A String", # Type of the DRD event. - "maxRetentionAllowed": "A String", # Maximum duration of retention allowed from the DRD control. This comes from the DRD control where users set a max TTL for their data. For example, suppose that a user sets the max TTL for a Cloud Storage bucket to 90 days. However, an object in that bucket is 100 days old. In this case, a DataRetentionDeletionEvent will be generated for that Cloud Storage bucket, and the max_retention_allowed is 90 days. - "minRetentionAllowed": "A String", # Min duration of retention allowed from the DSPM retention control. This field is only populated when event type is set to EVENT_TYPE_MIN_TTL_FROM_CREATION. + "dataRetentionDeletionEvents": [ + { + "dataObjectCount": "A String", + "eventDetectionTime": "A String", + "eventType": "A String", + "maxRetentionAllowed": "A String", + "minRetentionAllowed": "A String", }, ], - "database": { # Represents database access information, such as queries. A database may be a sub-resource of an instance (as in the case of Cloud SQL instances or Cloud Spanner instances), or the database instance itself. Some database resources might not have the [full resource name](https://google.aip.dev/122#full-resource-names) populated because these resource types, such as Cloud SQL databases, are not yet supported by Cloud Asset Inventory. In these cases only the display name is provided. # Database associated with the finding. - "displayName": "A String", # The human-readable name of the database that the user connected to. - "grantees": [ # The target usernames, roles, or groups of an SQL privilege grant, which is not an IAM policy change. + "database": { + "displayName": "A String", + "grantees": [ "A String", ], - "name": "A String", # Some database resources may not have the [full resource name](https://google.aip.dev/122#full-resource-names) populated because these resource types are not yet supported by Cloud Asset Inventory (e.g. Cloud SQL databases). In these cases only the display name will be provided. The [full resource name](https://google.aip.dev/122#full-resource-names) of the database that the user connected to, if it is supported by Cloud Asset Inventory. - "query": "A String", # The SQL statement that is associated with the database access. - "userName": "A String", # The username used to connect to the database. The username might not be an IAM principal and does not have a set format. - "version": "A String", # The version of the database, for example, POSTGRES_14. See [the complete list](https://cloud.google.com/sql/docs/mysql/admin-api/rest/v1/SqlDatabaseVersion). + "name": "A String", + "query": "A String", + "userName": "A String", + "version": "A String", }, - "description": "A String", # Contains more details about the finding. - "discoveredWorkload": { # Represents discovered, customer managed workload that is not registered with the respective GCP service. # DiscoveredWorkload associated with the finding. - "confidence": "A String", # The confidence in detection of this workload. - "detectedRelevantHardware": True or False, # A boolean flag set to true if associated hardware strongly predicts the workload type. - "detectedRelevantKeywords": True or False, # A boolean flag set to true if associated keywords strongly predict the workload type. - "detectedRelevantPackages": True or False, # A boolean flag set to true if installed packages strongly predict the workload type. - "workloadType": "A String", # The type of workload. + "description": "A String", + "discoveredWorkload": { + "confidence": "A String", + "detectedRelevantHardware": True or False, + "detectedRelevantKeywords": True or False, + "detectedRelevantPackages": True or False, + "workloadType": "A String", }, - "disk": { # Contains information about the disk associated with the finding. # Disk associated with the finding. - "name": "A String", # The name of the disk, for example, "https://www.googleapis.com/compute/v1/projects/{project-id}/zones/{zone-id}/disks/{disk-id}". + "disk": { + "name": "A String", }, - "eventTime": "A String", # The time the finding was first detected. If an existing finding is updated, then this is the time the update occurred. For example, if the finding represents an open firewall, this property captures the time the detector believes the firewall became open. The accuracy is determined by the detector. If the finding is later resolved, then this time reflects when the finding was resolved. This must not be set to a value greater than the current timestamp. - "exfiltration": { # Exfiltration represents a data exfiltration attempt from one or more sources to one or more targets. The `sources` attribute lists the sources of the exfiltrated data. The `targets` attribute lists the destinations the data was copied to. # Represents exfiltrations associated with the finding. - "sources": [ # If there are multiple sources, then the data is considered "joined" between them. For instance, BigQuery can join multiple tables, and each table would be considered a source. - { # Resource where data was exfiltrated from or exfiltrated to. - "components": [ # Subcomponents of the asset that was exfiltrated, like URIs used during exfiltration, table names, databases, and filenames. For example, multiple tables might have been exfiltrated from the same Cloud SQL instance, or multiple files might have been exfiltrated from the same Cloud Storage bucket. + "eventTime": "A String", + "exfiltration": { + "sources": [ + { + "components": [ "A String", ], - "name": "A String", # The resource's [full resource name](https://cloud.google.com/apis/design/resource_names#full_resource_name). + "name": "A String", }, ], - "targets": [ # If there are multiple targets, each target would get a complete copy of the "joined" source data. - { # Resource where data was exfiltrated from or exfiltrated to. - "components": [ # Subcomponents of the asset that was exfiltrated, like URIs used during exfiltration, table names, databases, and filenames. For example, multiple tables might have been exfiltrated from the same Cloud SQL instance, or multiple files might have been exfiltrated from the same Cloud Storage bucket. + "targets": [ + { + "components": [ "A String", ], - "name": "A String", # The resource's [full resource name](https://cloud.google.com/apis/design/resource_names#full_resource_name). + "name": "A String", }, ], - "totalExfiltratedBytes": "A String", # Total exfiltrated bytes processed for the entire job. + "totalExfiltratedBytes": "A String", }, - "externalExposure": { # Details about the externally exposed resource associated with the finding. # External exposure associated with the finding. - "backendBucket": "A String", # The full resource name of the load balancer backend bucket, for example, "//compute.googleapis.com/projects/{project-id}/global/backendBuckets/{name}" - "backendService": "A String", # The full resource name of load balancer backend service, for example, "//compute.googleapis.com/projects/{project-id}/global/backendServices/{name}". - "exposedApplication": "A String", # The name and version of the exposed web application, for example, "Jenkins 2.184". - "exposedEndpoint": "A String", # The resource which is running the exposed service, for example, "//compute.googleapis.com/projects/{project-id}/zones/{zone}/instances/{instance}.” - "exposedService": "A String", # The name and version of the service, for example, "Jupyter Notebook 6.14.0". - "forwardingRule": "A String", # The full resource name of the forwarding rule, for example, "//compute.googleapis.com/projects/{project-id}/global/forwardingRules/{forwarding-rule-name}". - "hostnameUri": "A String", # Hostname of the exposed application, for example, "https://test-app.a.run.app/" - "httpResponse": [ # The http response returned by the web application. - { # The http response returned by the web application. - "path": "A String", # The http path for which response code was returned by web application, for example, "https://test-app.a.run.app/test". - "statusCode": "A String", # The http response code returned by the web application, for example, 200. + "externalExposure": { + "backendBucket": "A String", + "backendService": "A String", + "exposedApplication": "A String", + "exposedEndpoint": "A String", + "exposedService": "A String", + "forwardingRule": "A String", + "hostnameUri": "A String", + "httpResponse": [ + { + "path": "A String", + "statusCode": "A String", }, ], - "instanceGroup": "A String", # The full resource name of the instance group, for example, "//compute.googleapis.com/projects/{project-id}/global/instanceGroups/{name}". - "internalBackendService": "A String", # The full resource name of load balancer backend service in the internal project having resource exposed via PSC, for example, "//compute.googleapis.com/projects/{project-id}/global/backendServices/{name}". - "loadBalancerFirewallPolicy": "A String", # The full resource name of the load balancer firewall policy, for example, "//compute.googleapis.com/projects/{project-id}/global/firewallPolicies/{policy-name}". - "networkEndpointGroup": "A String", # The full resource name of the network endpoint group, for example, "//compute.googleapis.com/projects/{project-id}/global/networkEndpointGroups/{name}". - "networkIngressFirewallPolicy": "A String", # The full resource name of the network ingress firewall policy, for example, "//compute.googleapis.com/projects/{project-id}/global/firewallPolicies/{name}". - "privateIpAddress": "A String", # Private IP address of the exposed endpoint. - "privatePort": "A String", # Port number associated with private IP address. - "pscNetworkAttachment": "A String", # The full resource name of the PSC (Private Service Connect) network attachment that network interface controller is attached to, for example, "//compute.googleapis.com/projects/{project-id}/regions/{region}/networkAttachments/{name}" - "pscServiceAttachment": "A String", # The full resource name of the PSC (Private Service Connect) service attachment that the load balancer network endpoint group targets, for example, "//compute.googleapis.com/projects/{project-id}/regions/{region}/serviceAttachments/{name}" - "publicIpAddress": "A String", # Public IP address of the exposed endpoint. - "publicPort": "A String", # Public port number of the exposed endpoint. - "serviceFirewallPolicy": "A String", # The full resource name of the firewall policy of the exposed service, for example, "//compute.googleapis.com/projects/{project-id}/global/firewallPolicies/{policy-name}". + "instanceGroup": "A String", + "internalBackendService": "A String", + "loadBalancerFirewallPolicy": "A String", + "networkEndpointGroup": "A String", + "networkIngressFirewallPolicy": "A String", + "privateIpAddress": "A String", + "privatePort": "A String", + "pscNetworkAttachment": "A String", + "pscServiceAttachment": "A String", + "publicIpAddress": "A String", + "publicPort": "A String", + "serviceFirewallPolicy": "A String", }, - "externalSystems": { # Output only. Third party SIEM/SOAR fields within SCC, contains external system information and external system finding fields. - "a_key": { # Representation of third party SIEM/SOAR fields within SCC. - "assignees": [ # References primary/secondary etc assignees in the external system. + "externalSystems": { + "a_key": { + "assignees": [ "A String", ], - "caseCloseTime": "A String", # The time when the case was closed, as reported by the external system. - "caseCreateTime": "A String", # The time when the case was created, as reported by the external system. - "casePriority": "A String", # The priority of the finding's corresponding case in the external system. - "caseSla": "A String", # The SLA of the finding's corresponding case in the external system. - "caseUri": "A String", # The link to the finding's corresponding case in the external system. - "externalSystemUpdateTime": "A String", # The time when the case was last updated, as reported by the external system. - "externalUid": "A String", # The identifier that's used to track the finding's corresponding case in the external system. - "name": "A String", # Full resource name of the external system, for example: "organizations/1234/sources/5678/findings/123456/externalSystems/jira", "folders/1234/sources/5678/findings/123456/externalSystems/jira", "projects/1234/sources/5678/findings/123456/externalSystems/jira" - "status": "A String", # The most recent status of the finding's corresponding case, as reported by the external system. - "ticketInfo": { # Information about the ticket, if any, that is being used to track the resolution of the issue that is identified by this finding. # Information about the ticket, if any, that is being used to track the resolution of the issue that is identified by this finding. - "assignee": "A String", # The assignee of the ticket in the ticket system. - "description": "A String", # The description of the ticket in the ticket system. - "id": "A String", # The identifier of the ticket in the ticket system. - "status": "A String", # The latest status of the ticket, as reported by the ticket system. - "updateTime": "A String", # The time when the ticket was last updated, as reported by the ticket system. - "uri": "A String", # The link to the ticket in the ticket system. + "caseCloseTime": "A String", + "caseCreateTime": "A String", + "casePriority": "A String", + "caseSla": "A String", + "caseUri": "A String", + "externalSystemUpdateTime": "A String", + "externalUid": "A String", + "name": "A String", + "status": "A String", + "ticketInfo": { + "assignee": "A String", + "description": "A String", + "id": "A String", + "status": "A String", + "updateTime": "A String", + "uri": "A String", }, }, }, - "externalUri": "A String", # The URI that, if available, points to a web page outside of Security Command Center where additional information about the finding can be found. This field is guaranteed to be either empty or a well formed URL. - "files": [ # File associated with the finding. - { # File information about the related binary/library used by an executable, or the script used by a script interpreter - "contents": "A String", # Prefix of the file contents as a JSON-encoded string. - "diskPath": { # Path of the file in terms of underlying disk/partition identifiers. # Path of the file in terms of underlying disk/partition identifiers. - "partitionUuid": "A String", # UUID of the partition (format https://wiki.archlinux.org/title/persistent_block_device_naming#by-uuid) - "relativePath": "A String", # Relative path of the file in the partition as a JSON encoded string. Example: /home/user1/executable_file.sh + "externalUri": "A String", + "files": [ + { + "contents": "A String", + "diskPath": { + "partitionUuid": "A String", + "relativePath": "A String", }, - "fileLoadState": "A String", # The load state of the file. - "hashedSize": "A String", # The length in bytes of the file prefix that was hashed. If hashed_size == size, any hashes reported represent the entire file. - "operations": [ # Operation(s) performed on a file. - { # Operation(s) performed on a file. - "type": "A String", # The type of the operation + "fileLoadState": "A String", + "hashedSize": "A String", + "operations": [ + { + "type": "A String", }, ], - "partiallyHashed": True or False, # True when the hash covers only a prefix of the file. - "path": "A String", # Absolute path of the file as a JSON encoded string. - "sha256": "A String", # SHA256 hash of the first hashed_size bytes of the file encoded as a hex string. If hashed_size == size, sha256 represents the SHA256 hash of the entire file. - "size": "A String", # Size of the file in bytes. + "partiallyHashed": True or False, + "path": "A String", + "sha256": "A String", + "size": "A String", }, ], - "findingClass": "A String", # The class of the finding. - "groupMemberships": [ # Contains details about groups of which this finding is a member. A group is a collection of findings that are related in some way. This field cannot be updated. Its value is ignored in all update requests. - { # Contains details about groups of which this finding is a member. A group is a collection of findings that are related in some way. - "groupId": "A String", # ID of the group. - "groupType": "A String", # Type of group. + "findingClass": "A String", + "groupMemberships": [ + { + "groupId": "A String", + "groupType": "A String", }, ], - "iamBindings": [ # Represents IAM bindings associated with the finding. - { # Represents a particular IAM binding, which captures a member's role addition, removal, or state. - "action": "A String", # The action that was performed on a Binding. - "member": "A String", # A single identity requesting access for a Cloud Platform resource, for example, "foo@google.com". - "role": "A String", # Role that is assigned to "members". For example, "roles/viewer", "roles/editor", or "roles/owner". + "iamBindings": [ + { + "action": "A String", + "member": "A String", + "role": "A String", }, ], - "indicator": { # Represents what's commonly known as an _indicator of compromise_ (IoC) in computer forensics. This is an artifact observed on a network or in an operating system that, with high confidence, indicates a computer intrusion. For more information, see [Indicator of compromise](https://en.wikipedia.org/wiki/Indicator_of_compromise). # Represents what's commonly known as an *indicator of compromise* (IoC) in computer forensics. This is an artifact observed on a network or in an operating system that, with high confidence, indicates a computer intrusion. For more information, see [Indicator of compromise](https://en.wikipedia.org/wiki/Indicator_of_compromise). - "domains": [ # List of domains associated to the Finding. + "indicator": { + "domains": [ "A String", ], - "ipAddresses": [ # The list of IP addresses that are associated with the finding. + "ipAddresses": [ "A String", ], - "signatures": [ # The list of matched signatures indicating that the given process is present in the environment. - { # Indicates what signature matched this process. - "memoryHashSignature": { # A signature corresponding to memory page hashes. # Signature indicating that a binary family was matched. - "binaryFamily": "A String", # The binary family. - "detections": [ # The list of memory hash detections contributing to the binary family match. - { # Memory hash detection contributing to the binary family match. - "binary": "A String", # The name of the binary associated with the memory hash signature detection. - "percentPagesMatched": 3.14, # The percentage of memory page hashes in the signature that were matched. + "signatures": [ + { + "memoryHashSignature": { + "binaryFamily": "A String", + "detections": [ + { + "binary": "A String", + "percentPagesMatched": 3.14, }, ], }, - "signatureType": "A String", # Describes the type of resource associated with the signature. - "yaraRuleSignature": { # A signature corresponding to a YARA rule. # Signature indicating that a YARA rule was matched. - "yaraRule": "A String", # The name of the YARA rule. + "signatureType": "A String", + "yaraRuleSignature": { + "yaraRule": "A String", }, }, ], - "uris": [ # The list of URIs associated to the Findings. + "uris": [ "A String", ], }, - "ipRules": { # IP rules associated with the finding. # IP rules associated with the finding. - "allowed": { # Allowed IP rule. # Tuple with allowed rules. - "ipRules": [ # Optional. Optional list of allowed IP rules. - { # IP rule information. - "portRanges": [ # Optional. An optional list of ports to which this rule applies. This field is only applicable for the UDP or (S)TCP protocols. Each entry must be either an integer or a range including a min and max port number. - { # A port range which is inclusive of the min and max values. Values are between 0 and 2^16-1. The max can be equal / must be not smaller than the min value. If min and max are equal this indicates that it is a single port. - "max": "A String", # Maximum port value. - "min": "A String", # Minimum port value. + "ipRules": { + "allowed": { + "ipRules": [ + { + "portRanges": [ + { + "max": "A String", + "min": "A String", }, ], - "protocol": "A String", # The IP protocol this rule applies to. This value can either be one of the following well known protocol strings (TCP, UDP, ICMP, ESP, AH, IPIP, SCTP) or a string representation of the integer value. + "protocol": "A String", }, ], }, - "denied": { # Denied IP rule. # Tuple with denied rules. - "ipRules": [ # Optional. Optional list of denied IP rules. - { # IP rule information. - "portRanges": [ # Optional. An optional list of ports to which this rule applies. This field is only applicable for the UDP or (S)TCP protocols. Each entry must be either an integer or a range including a min and max port number. - { # A port range which is inclusive of the min and max values. Values are between 0 and 2^16-1. The max can be equal / must be not smaller than the min value. If min and max are equal this indicates that it is a single port. - "max": "A String", # Maximum port value. - "min": "A String", # Minimum port value. + "denied": { + "ipRules": [ + { + "portRanges": [ + { + "max": "A String", + "min": "A String", }, ], - "protocol": "A String", # The IP protocol this rule applies to. This value can either be one of the following well known protocol strings (TCP, UDP, ICMP, ESP, AH, IPIP, SCTP) or a string representation of the integer value. + "protocol": "A String", }, ], }, - "destinationIpRanges": [ # If destination IP ranges are specified, the firewall rule applies only to traffic that has a destination IP address in these ranges. These ranges must be expressed in CIDR format. Only supports IPv4. + "destinationIpRanges": [ "A String", ], - "direction": "A String", # The direction that the rule is applicable to, one of ingress or egress. - "exposedServices": [ # Name of the network protocol service, such as FTP, that is exposed by the open port. Follows the naming convention available at: https://www.iana.org/assignments/service-names-port-numbers/service-names-port-numbers.xhtml. + "direction": "A String", + "exposedServices": [ "A String", ], - "sourceIpRanges": [ # If source IP ranges are specified, the firewall rule applies only to traffic that has a source IP address in these ranges. These ranges must be expressed in CIDR format. Only supports IPv4. + "sourceIpRanges": [ "A String", ], }, - "job": { # Describes a job # Job associated with the finding. - "errorCode": 42, # Optional. If the job did not complete successfully, this field describes why. - "location": "A String", # Optional. Gives the location where the job ran, such as `US` or `europe-west1` - "name": "A String", # The fully-qualified name for a job. e.g. `projects//jobs/` - "state": "A String", # Output only. State of the job, such as `RUNNING` or `PENDING`. + "job": { + "errorCode": 42, + "location": "A String", + "name": "A String", + "state": "A String", }, - "kernelRootkit": { # Kernel mode rootkit signatures. # Signature of the kernel rootkit. - "name": "A String", # Rootkit name, when available. - "unexpectedCodeModification": True or False, # True if unexpected modifications of kernel code memory are present. - "unexpectedFtraceHandler": True or False, # True if `ftrace` points are present with callbacks pointing to regions that are not in the expected kernel or module code range. - "unexpectedInterruptHandler": True or False, # True if interrupt handlers that are are not in the expected kernel or module code regions are present. - "unexpectedKernelCodePages": True or False, # True if kernel code pages that are not in the expected kernel or module code regions are present. - "unexpectedKprobeHandler": True or False, # True if `kprobe` points are present with callbacks pointing to regions that are not in the expected kernel or module code range. - "unexpectedProcessesInRunqueue": True or False, # True if unexpected processes in the scheduler run queue are present. Such processes are in the run queue, but not in the process task list. - "unexpectedReadOnlyDataModification": True or False, # True if unexpected modifications of kernel read-only data memory are present. - "unexpectedSystemCallHandler": True or False, # True if system call handlers that are are not in the expected kernel or module code regions are present. + "kernelRootkit": { + "name": "A String", + "unexpectedCodeModification": True or False, + "unexpectedFtraceHandler": True or False, + "unexpectedInterruptHandler": True or False, + "unexpectedKernelCodePages": True or False, + "unexpectedKprobeHandler": True or False, + "unexpectedProcessesInRunqueue": True or False, + "unexpectedReadOnlyDataModification": True or False, + "unexpectedSystemCallHandler": True or False, }, - "kubernetes": { # Kubernetes-related attributes. # Kubernetes resources associated with the finding. - "accessReviews": [ # Provides information on any Kubernetes access reviews (privilege checks) relevant to the finding. - { # Conveys information about a Kubernetes access review (such as one returned by a [`kubectl auth can-i`](https://kubernetes.io/docs/reference/access-authn-authz/authorization/#checking-api-access) command) that was involved in a finding. - "group": "A String", # The API group of the resource. "*" means all. - "name": "A String", # The name of the resource being requested. Empty means all. - "ns": "A String", # Namespace of the action being requested. Currently, there is no distinction between no namespace and all namespaces. Both are represented by "" (empty). - "resource": "A String", # The optional resource type requested. "*" means all. - "subresource": "A String", # The optional subresource type. - "verb": "A String", # A Kubernetes resource API verb, like get, list, watch, create, update, delete, proxy. "*" means all. - "version": "A String", # The API version of the resource. "*" means all. + "kubernetes": { + "accessReviews": [ + { + "group": "A String", + "name": "A String", + "ns": "A String", + "resource": "A String", + "subresource": "A String", + "verb": "A String", + "version": "A String", }, ], - "bindings": [ # Provides Kubernetes role binding information for findings that involve [RoleBindings or ClusterRoleBindings](https://cloud.google.com/kubernetes-engine/docs/how-to/role-based-access-control). - { # Represents a Kubernetes RoleBinding or ClusterRoleBinding. - "name": "A String", # Name for the binding. - "ns": "A String", # Namespace for the binding. - "role": { # Kubernetes Role or ClusterRole. # The Role or ClusterRole referenced by the binding. - "kind": "A String", # Role type. - "name": "A String", # Role name. - "ns": "A String", # Role namespace. + "bindings": [ + { + "name": "A String", + "ns": "A String", + "role": { + "kind": "A String", + "name": "A String", + "ns": "A String", }, - "subjects": [ # Represents one or more subjects that are bound to the role. Not always available for PATCH requests. - { # Represents a Kubernetes subject. - "kind": "A String", # Authentication type for the subject. - "name": "A String", # Name for the subject. - "ns": "A String", # Namespace for the subject. + "subjects": [ + { + "kind": "A String", + "name": "A String", + "ns": "A String", }, ], }, ], - "nodePools": [ # GKE [node pools](https://cloud.google.com/kubernetes-engine/docs/concepts/node-pools) associated with the finding. This field contains node pool information for each node, when it is available. - { # Provides GKE node pool information. - "name": "A String", # Kubernetes node pool name. - "nodes": [ # Nodes associated with the finding. - { # Kubernetes nodes associated with the finding. - "name": "A String", # [Full resource name](https://google.aip.dev/122#full-resource-names) of the Compute Engine VM running the cluster node. + "nodePools": [ + { + "name": "A String", + "nodes": [ + { + "name": "A String", }, ], }, ], - "nodes": [ # Provides Kubernetes [node](https://cloud.google.com/kubernetes-engine/docs/concepts/cluster-architecture#nodes) information. - { # Kubernetes nodes associated with the finding. - "name": "A String", # [Full resource name](https://google.aip.dev/122#full-resource-names) of the Compute Engine VM running the cluster node. + "nodes": [ + { + "name": "A String", }, ], - "objects": [ # Kubernetes objects related to the finding. - { # Kubernetes object related to the finding, uniquely identified by GKNN. Used if the object Kind is not one of Pod, Node, NodePool, Binding, or AccessReview. - "containers": [ # Pod containers associated with this finding, if any. - { # Container associated with the finding. - "createTime": "A String", # The time that the container was created. - "imageId": "A String", # Optional container image ID, if provided by the container runtime. Uniquely identifies the container image launched using a container image digest. - "labels": [ # Container labels, as provided by the container runtime. - { # Represents a generic name-value label. A label has separate name and value fields to support filtering with the `contains()` function. For more information, see [Filtering on array-type fields](https://cloud.google.com/security-command-center/docs/how-to-api-list-findings#array-contains-filtering). - "name": "A String", # Name of the label. - "value": "A String", # Value that corresponds to the label's name. + "objects": [ + { + "containers": [ + { + "createTime": "A String", + "imageId": "A String", + "labels": [ + { + "name": "A String", + "value": "A String", }, ], - "name": "A String", # Name of the container. - "uri": "A String", # Container image URI provided when configuring a pod or container. This string can identify a container image version using mutable tags. + "name": "A String", + "uri": "A String", }, ], - "group": "A String", # Kubernetes object group, such as "policy.k8s.io/v1". - "kind": "A String", # Kubernetes object kind, such as "Namespace". - "name": "A String", # Kubernetes object name. For details see https://kubernetes.io/docs/concepts/overview/working-with-objects/names/. - "ns": "A String", # Kubernetes object namespace. Must be a valid DNS label. Named "ns" to avoid collision with C++ namespace keyword. For details see https://kubernetes.io/docs/tasks/administer-cluster/namespaces/. + "group": "A String", + "kind": "A String", + "name": "A String", + "ns": "A String", }, ], - "pods": [ # Kubernetes [Pods](https://cloud.google.com/kubernetes-engine/docs/concepts/pod) associated with the finding. This field contains Pod records for each container that is owned by a Pod. - { # A Kubernetes Pod. - "containers": [ # Pod containers associated with this finding, if any. - { # Container associated with the finding. - "createTime": "A String", # The time that the container was created. - "imageId": "A String", # Optional container image ID, if provided by the container runtime. Uniquely identifies the container image launched using a container image digest. - "labels": [ # Container labels, as provided by the container runtime. - { # Represents a generic name-value label. A label has separate name and value fields to support filtering with the `contains()` function. For more information, see [Filtering on array-type fields](https://cloud.google.com/security-command-center/docs/how-to-api-list-findings#array-contains-filtering). - "name": "A String", # Name of the label. - "value": "A String", # Value that corresponds to the label's name. + "pods": [ + { + "containers": [ + { + "createTime": "A String", + "imageId": "A String", + "labels": [ + { + "name": "A String", + "value": "A String", }, ], - "name": "A String", # Name of the container. - "uri": "A String", # Container image URI provided when configuring a pod or container. This string can identify a container image version using mutable tags. + "name": "A String", + "uri": "A String", }, ], - "labels": [ # Pod labels. For Kubernetes containers, these are applied to the container. - { # Represents a generic name-value label. A label has separate name and value fields to support filtering with the `contains()` function. For more information, see [Filtering on array-type fields](https://cloud.google.com/security-command-center/docs/how-to-api-list-findings#array-contains-filtering). - "name": "A String", # Name of the label. - "value": "A String", # Value that corresponds to the label's name. + "labels": [ + { + "name": "A String", + "value": "A String", }, ], - "name": "A String", # Kubernetes Pod name. - "ns": "A String", # Kubernetes Pod namespace. + "name": "A String", + "ns": "A String", }, ], - "roles": [ # Provides Kubernetes role information for findings that involve [Roles or ClusterRoles](https://cloud.google.com/kubernetes-engine/docs/how-to/role-based-access-control). - { # Kubernetes Role or ClusterRole. - "kind": "A String", # Role type. - "name": "A String", # Role name. - "ns": "A String", # Role namespace. + "roles": [ + { + "kind": "A String", + "name": "A String", + "ns": "A String", }, ], }, - "loadBalancers": [ # The load balancers associated with the finding. - { # Contains information related to the load balancer associated with the finding. - "name": "A String", # The name of the load balancer associated with the finding. + "loadBalancers": [ + { + "name": "A String", }, ], - "logEntries": [ # Log entries that are relevant to the finding. - { # An individual entry in a log. - "cloudLoggingEntry": { # Metadata taken from a [Cloud Logging LogEntry](https://cloud.google.com/logging/docs/reference/v2/rest/v2/LogEntry) # An individual entry in a log stored in Cloud Logging. - "insertId": "A String", # A unique identifier for the log entry. - "logId": "A String", # The type of the log (part of `log_name`. `log_name` is the resource name of the log to which this log entry belongs). For example: `cloudresourcemanager.googleapis.com/activity`. Note that this field is not URL-encoded, unlike the `LOG_ID` field in `LogEntry`. - "resourceContainer": "A String", # The organization, folder, or project of the monitored resource that produced this log entry. - "timestamp": "A String", # The time the event described by the log entry occurred. + "logEntries": [ + { + "cloudLoggingEntry": { + "insertId": "A String", + "logId": "A String", + "resourceContainer": "A String", + "timestamp": "A String", }, }, ], - "mitreAttack": { # MITRE ATT&CK tactics and techniques related to this finding. See: https://attack.mitre.org # MITRE ATT&CK tactics and techniques related to this finding. See: https://attack.mitre.org - "additionalTactics": [ # Additional MITRE ATT&CK tactics related to this finding, if any. + "mitreAttack": { + "additionalTactics": [ "A String", ], - "additionalTechniques": [ # Additional MITRE ATT&CK techniques related to this finding, if any, along with any of their respective parent techniques. + "additionalTechniques": [ "A String", ], - "primaryTactic": "A String", # The MITRE ATT&CK tactic most closely represented by this finding, if any. - "primaryTechniques": [ # The MITRE ATT&CK technique most closely represented by this finding, if any. primary_techniques is a repeated field because there are multiple levels of MITRE ATT&CK techniques. If the technique most closely represented by this finding is a sub-technique (e.g. `SCANNING_IP_BLOCKS`), both the sub-technique and its parent technique(s) will be listed (e.g. `SCANNING_IP_BLOCKS`, `ACTIVE_SCANNING`). + "primaryTactic": "A String", + "primaryTechniques": [ "A String", ], - "version": "A String", # The MITRE ATT&CK version referenced by the above fields. E.g. "8". + "version": "A String", }, - "moduleName": "A String", # Unique identifier of the module which generated the finding. Example: folders/598186756061/securityHealthAnalyticsSettings/customModules/56799441161885 - "mute": "A String", # Indicates the mute state of a finding (either muted, unmuted or undefined). Unlike other attributes of a finding, a finding provider shouldn't set the value of mute. - "muteInfo": { # Mute information about the finding, including whether the finding has a static mute or any matching dynamic mute rules. # Output only. The mute information regarding this finding. - "dynamicMuteRecords": [ # The list of dynamic mute rules that currently match the finding. - { # The record of a dynamic mute rule that matches the finding. - "matchTime": "A String", # When the dynamic mute rule first matched the finding. - "muteConfig": "A String", # The relative resource name of the mute rule, represented by a mute config, that created this record, for example `organizations/123/muteConfigs/mymuteconfig` or `organizations/123/locations/global/muteConfigs/mymuteconfig`. + "moduleName": "A String", + "mute": "A String", + "muteInfo": { + "dynamicMuteRecords": [ + { + "matchTime": "A String", + "muteConfig": "A String", }, ], - "staticMute": { # Information about the static mute state. A static mute state overrides any dynamic mute rules that apply to this finding. The static mute state can be set by a static mute rule or by muting the finding directly. # If set, the static mute applied to this finding. Static mutes override dynamic mutes. If unset, there is no static mute. - "applyTime": "A String", # When the static mute was applied. - "state": "A String", # The static mute state. If the value is `MUTED` or `UNMUTED`, then the finding's overall mute state will have the same value. + "staticMute": { + "applyTime": "A String", + "state": "A String", }, }, - "muteInitiator": "A String", # Records additional information about the mute operation, for example, the [mute configuration](/security-command-center/docs/how-to-mute-findings) that muted the finding and the user who muted the finding. - "muteUpdateTime": "A String", # Output only. The most recent time this finding was muted or unmuted. - "name": "A String", # The [relative resource name](https://cloud.google.com/apis/design/resource_names#relative_resource_name) of the finding. Example: "organizations/{organization_id}/sources/{source_id}/findings/{finding_id}", "folders/{folder_id}/sources/{source_id}/findings/{finding_id}", "projects/{project_id}/sources/{source_id}/findings/{finding_id}". - "networks": [ # Represents the VPC networks that the resource is attached to. - { # Contains information about a VPC network associated with the finding. - "name": "A String", # The name of the VPC network resource, for example, `//compute.googleapis.com/projects/my-project/global/networks/my-network`. + "muteInitiator": "A String", + "muteUpdateTime": "A String", + "name": "A String", + "networks": [ + { + "name": "A String", }, ], - "nextSteps": "A String", # Steps to address the finding. - "notebook": { # Represents a Jupyter notebook IPYNB file, such as a [Colab Enterprise notebook](https://cloud.google.com/colab/docs/introduction) file, that is associated with a finding. # Notebook associated with the finding. - "lastAuthor": "A String", # The user ID of the latest author to modify the notebook. - "name": "A String", # The name of the notebook. - "notebookUpdateTime": "A String", # The most recent time the notebook was updated. - "service": "A String", # The source notebook service, for example, "Colab Enterprise". + "nextSteps": "A String", + "notebook": { + "lastAuthor": "A String", + "name": "A String", + "notebookUpdateTime": "A String", + "service": "A String", }, - "orgPolicies": [ # Contains information about the org policies associated with the finding. - { # Contains information about the org policies associated with the finding. - "name": "A String", # The resource name of the org policy. Example: "organizations/{organization_id}/policies/{constraint_name}" + "orgPolicies": [ + { + "name": "A String", }, ], - "parent": "A String", # The relative resource name of the source the finding belongs to. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name This field is immutable after creation time. For example: "organizations/{organization_id}/sources/{source_id}" - "parentDisplayName": "A String", # Output only. The human readable display name of the finding source such as "Event Threat Detection" or "Security Health Analytics". - "policyViolationSummary": { # Metadata summarizing policy violations of child resources of the affected resource. `finding_category` and `resource` determine the exact semantics of the counts. For example, when category=DATA_SECURITY_POSTURE_OBJECT_PUBLIC_ACCESS_VIOLATION and resource='storage.googleapis.com/buckets/my-bucket-name' then this counts the number of Cloud Storage objects in my-bucket-name which violate a Public Access control. # PolicyViolationSummary associated with the finding. - "conformantResourcesCount": "A String", # Total number of child resources that conform to the policy. - "evaluationErrorsCount": "A String", # Number of child resources for which errors during evaluation occurred. The evaluation result for these child resources is effectively "unknown". - "outOfScopeResourcesCount": "A String", # Total count of child resources which were not in scope for evaluation. - "policyViolationsCount": "A String", # Count of child resources in violation of the policy. + "parent": "A String", + "parentDisplayName": "A String", + "policyViolationSummary": { + "conformantResourcesCount": "A String", + "evaluationErrorsCount": "A String", + "outOfScopeResourcesCount": "A String", + "policyViolationsCount": "A String", }, - "processes": [ # Represents operating system processes associated with the Finding. - { # Represents an operating system process. - "args": [ # Process arguments as JSON encoded strings. + "processes": [ + { + "args": [ "A String", ], - "argumentsTruncated": True or False, # True if `args` is incomplete. - "binary": { # File information about the related binary/library used by an executable, or the script used by a script interpreter # File information for the process executable. - "contents": "A String", # Prefix of the file contents as a JSON-encoded string. - "diskPath": { # Path of the file in terms of underlying disk/partition identifiers. # Path of the file in terms of underlying disk/partition identifiers. - "partitionUuid": "A String", # UUID of the partition (format https://wiki.archlinux.org/title/persistent_block_device_naming#by-uuid) - "relativePath": "A String", # Relative path of the file in the partition as a JSON encoded string. Example: /home/user1/executable_file.sh + "argumentsTruncated": True or False, + "binary": { + "contents": "A String", + "diskPath": { + "partitionUuid": "A String", + "relativePath": "A String", }, - "fileLoadState": "A String", # The load state of the file. - "hashedSize": "A String", # The length in bytes of the file prefix that was hashed. If hashed_size == size, any hashes reported represent the entire file. - "operations": [ # Operation(s) performed on a file. - { # Operation(s) performed on a file. - "type": "A String", # The type of the operation + "fileLoadState": "A String", + "hashedSize": "A String", + "operations": [ + { + "type": "A String", }, ], - "partiallyHashed": True or False, # True when the hash covers only a prefix of the file. - "path": "A String", # Absolute path of the file as a JSON encoded string. - "sha256": "A String", # SHA256 hash of the first hashed_size bytes of the file encoded as a hex string. If hashed_size == size, sha256 represents the SHA256 hash of the entire file. - "size": "A String", # Size of the file in bytes. + "partiallyHashed": True or False, + "path": "A String", + "sha256": "A String", + "size": "A String", }, - "envVariables": [ # Process environment variables. - { # A name-value pair representing an environment variable used in an operating system process. - "name": "A String", # Environment variable name as a JSON encoded string. - "val": "A String", # Environment variable value as a JSON encoded string. + "envVariables": [ + { + "name": "A String", + "val": "A String", }, ], - "envVariablesTruncated": True or False, # True if `env_variables` is incomplete. - "libraries": [ # File information for libraries loaded by the process. - { # File information about the related binary/library used by an executable, or the script used by a script interpreter - "contents": "A String", # Prefix of the file contents as a JSON-encoded string. - "diskPath": { # Path of the file in terms of underlying disk/partition identifiers. # Path of the file in terms of underlying disk/partition identifiers. - "partitionUuid": "A String", # UUID of the partition (format https://wiki.archlinux.org/title/persistent_block_device_naming#by-uuid) - "relativePath": "A String", # Relative path of the file in the partition as a JSON encoded string. Example: /home/user1/executable_file.sh + "envVariablesTruncated": True or False, + "libraries": [ + { + "contents": "A String", + "diskPath": { + "partitionUuid": "A String", + "relativePath": "A String", }, - "fileLoadState": "A String", # The load state of the file. - "hashedSize": "A String", # The length in bytes of the file prefix that was hashed. If hashed_size == size, any hashes reported represent the entire file. - "operations": [ # Operation(s) performed on a file. - { # Operation(s) performed on a file. - "type": "A String", # The type of the operation + "fileLoadState": "A String", + "hashedSize": "A String", + "operations": [ + { + "type": "A String", }, ], - "partiallyHashed": True or False, # True when the hash covers only a prefix of the file. - "path": "A String", # Absolute path of the file as a JSON encoded string. - "sha256": "A String", # SHA256 hash of the first hashed_size bytes of the file encoded as a hex string. If hashed_size == size, sha256 represents the SHA256 hash of the entire file. - "size": "A String", # Size of the file in bytes. + "partiallyHashed": True or False, + "path": "A String", + "sha256": "A String", + "size": "A String", }, ], - "name": "A String", # The process name, as displayed in utilities like `top` and `ps`. This name can be accessed through `/proc/[pid]/comm` and changed with `prctl(PR_SET_NAME)`. - "parentPid": "A String", # The parent process ID. - "pid": "A String", # The process ID. - "script": { # File information about the related binary/library used by an executable, or the script used by a script interpreter # When the process represents the invocation of a script, `binary` provides information about the interpreter, while `script` provides information about the script file provided to the interpreter. - "contents": "A String", # Prefix of the file contents as a JSON-encoded string. - "diskPath": { # Path of the file in terms of underlying disk/partition identifiers. # Path of the file in terms of underlying disk/partition identifiers. - "partitionUuid": "A String", # UUID of the partition (format https://wiki.archlinux.org/title/persistent_block_device_naming#by-uuid) - "relativePath": "A String", # Relative path of the file in the partition as a JSON encoded string. Example: /home/user1/executable_file.sh + "name": "A String", + "parentPid": "A String", + "pid": "A String", + "script": { + "contents": "A String", + "diskPath": { + "partitionUuid": "A String", + "relativePath": "A String", }, - "fileLoadState": "A String", # The load state of the file. - "hashedSize": "A String", # The length in bytes of the file prefix that was hashed. If hashed_size == size, any hashes reported represent the entire file. - "operations": [ # Operation(s) performed on a file. - { # Operation(s) performed on a file. - "type": "A String", # The type of the operation + "fileLoadState": "A String", + "hashedSize": "A String", + "operations": [ + { + "type": "A String", }, ], - "partiallyHashed": True or False, # True when the hash covers only a prefix of the file. - "path": "A String", # Absolute path of the file as a JSON encoded string. - "sha256": "A String", # SHA256 hash of the first hashed_size bytes of the file encoded as a hex string. If hashed_size == size, sha256 represents the SHA256 hash of the entire file. - "size": "A String", # Size of the file in bytes. + "partiallyHashed": True or False, + "path": "A String", + "sha256": "A String", + "size": "A String", }, - "userId": "A String", # The ID of the user that executed the process. E.g. If this is the root user this will always be 0. + "userId": "A String", }, ], - "resourceName": "A String", # For findings on Google Cloud resources, the full resource name of the Google Cloud resource this finding is for. See: https://cloud.google.com/apis/design/resource_names#full_resource_name When the finding is for a non-Google Cloud resource, the resourceName can be a customer or partner defined string. This field is immutable after creation time. - "secret": { # Details about a secret or credential associated with the finding. # Secret associated with the finding. - "environmentVariable": { # Environment variable containing the secret. # The environment variable containing the secret. - "key": "A String", # Environment variable name as a JSON encoded string. Note that value is not included since the value contains the secret data, which is sensitive core content. + "resourceName": "A String", + "secret": { + "environmentVariable": { + "key": "A String", }, - "filePath": { # File path containing the secret. # The file containing the secret. - "path": "A String", # Path to the file. + "filePath": { + "path": "A String", }, - "status": { # The status of the secret. # The status of the secret. - "lastUpdatedTime": "A String", # Time that the secret was found. - "validity": "A String", # The validity of the secret. + "status": { + "lastUpdatedTime": "A String", + "validity": "A String", }, - "type": "A String", # The type of secret, for example, GCP_API_KEY. + "type": "A String", }, - "securityMarks": { # User specified security marks that are attached to the parent Security Command Center resource. Security marks are scoped within a Security Command Center organization -- they can be modified and viewed by all users who have proper permissions on the organization. # Output only. User specified security marks. These marks are entirely managed by the user and come from the SecurityMarks resource that belongs to the finding. - "canonicalName": "A String", # The canonical name of the marks. Examples: "organizations/{organization_id}/assets/{asset_id}/securityMarks" "folders/{folder_id}/assets/{asset_id}/securityMarks" "projects/{project_number}/assets/{asset_id}/securityMarks" "organizations/{organization_id}/sources/{source_id}/findings/{finding_id}/securityMarks" "folders/{folder_id}/sources/{source_id}/findings/{finding_id}/securityMarks" "projects/{project_number}/sources/{source_id}/findings/{finding_id}/securityMarks" - "marks": { # Mutable user specified security marks belonging to the parent resource. Constraints are as follows: * Keys and values are treated as case insensitive * Keys must be between 1 - 256 characters (inclusive) * Keys must be letters, numbers, underscores, or dashes * Values have leading and trailing whitespace trimmed, remaining characters must be between 1 - 4096 characters (inclusive) + "securityMarks": { + "canonicalName": "A String", + "marks": { "a_key": "A String", }, - "name": "A String", # The relative resource name of the SecurityMarks. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Examples: "organizations/{organization_id}/assets/{asset_id}/securityMarks" "organizations/{organization_id}/sources/{source_id}/findings/{finding_id}/securityMarks". + "name": "A String", }, - "securityPosture": { # Represents a posture that is deployed on Google Cloud by the Security Command Center Posture Management service. A posture contains one or more policy sets. A policy set is a group of policies that enforce a set of security rules on Google Cloud. # The security posture associated with the finding. - "changedPolicy": "A String", # The name of the updated policy, for example, `projects/{project_id}/policies/{constraint_name}`. - "name": "A String", # Name of the posture, for example, `CIS-Posture`. - "policy": "A String", # The ID of the updated policy, for example, `compute-policy-1`. - "policyDriftDetails": [ # The details about a change in an updated policy that violates the deployed posture. - { # The policy field that violates the deployed posture and its expected and detected values. - "detectedValue": "A String", # The detected value that violates the deployed posture, for example, `false` or `allowed_values={"projects/22831892"}`. - "expectedValue": "A String", # The value of this field that was configured in a posture, for example, `true` or `allowed_values={"projects/29831892"}`. - "field": "A String", # The name of the updated field, for example constraint.implementation.policy_rules[0].enforce + "securityPosture": { + "changedPolicy": "A String", + "name": "A String", + "policy": "A String", + "policyDriftDetails": [ + { + "detectedValue": "A String", + "expectedValue": "A String", + "field": "A String", }, ], - "policySet": "A String", # The name of the updated policyset, for example, `cis-policyset`. - "postureDeployment": "A String", # The name of the posture deployment, for example, `organizations/{org_id}/posturedeployments/{posture_deployment_id}`. - "postureDeploymentResource": "A String", # The project, folder, or organization on which the posture is deployed, for example, `projects/{project_number}`. - "revisionId": "A String", # The version of the posture, for example, `c7cfa2a8`. + "policySet": "A String", + "postureDeployment": "A String", + "postureDeploymentResource": "A String", + "revisionId": "A String", }, - "severity": "A String", # The severity of the finding. This field is managed by the source that writes the finding. - "sourceProperties": { # Source specific properties. These properties are managed by the source that writes the finding. The key names in the source_properties map must be between 1 and 255 characters, and must start with a letter and contain alphanumeric characters or underscores only. + "severity": "A String", + "sourceProperties": { "a_key": "", }, - "state": "A String", # The state of the finding. - "toxicCombination": { # Contains details about a group of security issues that, when the issues occur together, represent a greater risk than when the issues occur independently. A group of such issues is referred to as a toxic combination. # Contains details about a group of security issues that, when the issues occur together, represent a greater risk than when the issues occur independently. A group of such issues is referred to as a toxic combination. This field cannot be updated. Its value is ignored in all update requests. - "attackExposureScore": 3.14, # The [Attack exposure score](https://cloud.google.com/security-command-center/docs/attack-exposure-learn#attack_exposure_scores) of this toxic combination. The score is a measure of how much this toxic combination exposes one or more high-value resources to potential attack. - "relatedFindings": [ # List of resource names of findings associated with this toxic combination. For example, `organizations/123/sources/456/findings/789`. + "state": "A String", + "toxicCombination": { + "attackExposureScore": 3.14, + "relatedFindings": [ "A String", ], }, - "vertexAi": { # Vertex AI-related information associated with the finding. # VertexAi associated with the finding. - "datasets": [ # Datasets associated with the finding. - { # Vertex AI dataset associated with the finding. - "displayName": "A String", # The user defined display name of dataset, e.g. plants-dataset - "name": "A String", # Resource name of the dataset, e.g. projects/{project}/locations/{location}/datasets/2094040236064505856 - "source": "A String", # Data source, such as BigQuery source URI, e.g. bq://scc-nexus-test.AIPPtest.gsod + "vertexAi": { + "datasets": [ + { + "displayName": "A String", + "name": "A String", + "source": "A String", }, ], - "pipelines": [ # Pipelines associated with the finding. - { # Vertex AI training pipeline associated with the finding. - "displayName": "A String", # The user defined display name of pipeline, e.g. plants-classification - "name": "A String", # Resource name of the pipeline, e.g. projects/{project}/locations/{location}/trainingPipelines/5253428229225578496 + "pipelines": [ + { + "displayName": "A String", + "name": "A String", }, ], }, - "vulnerability": { # Refers to common vulnerability fields e.g. cve, cvss, cwe etc. # Represents vulnerability-specific fields like CVE and CVSS scores. CVE stands for Common Vulnerabilities and Exposures (https://cve.mitre.org/about/) - "cve": { # CVE stands for Common Vulnerabilities and Exposures. Information from the [CVE record](https://www.cve.org/ResourcesSupport/Glossary) that describes this vulnerability. # CVE stands for Common Vulnerabilities and Exposures (https://cve.mitre.org/about/) - "cvssv3": { # Common Vulnerability Scoring System version 3. # Describe Common Vulnerability Scoring System specified at https://www.first.org/cvss/v3.1/specification-document - "attackComplexity": "A String", # This metric describes the conditions beyond the attacker's control that must exist in order to exploit the vulnerability. - "attackVector": "A String", # Base Metrics Represents the intrinsic characteristics of a vulnerability that are constant over time and across user environments. This metric reflects the context by which vulnerability exploitation is possible. - "availabilityImpact": "A String", # This metric measures the impact to the availability of the impacted component resulting from a successfully exploited vulnerability. - "baseScore": 3.14, # The base score is a function of the base metric scores. - "confidentialityImpact": "A String", # This metric measures the impact to the confidentiality of the information resources managed by a software component due to a successfully exploited vulnerability. - "integrityImpact": "A String", # This metric measures the impact to integrity of a successfully exploited vulnerability. - "privilegesRequired": "A String", # This metric describes the level of privileges an attacker must possess before successfully exploiting the vulnerability. - "scope": "A String", # The Scope metric captures whether a vulnerability in one vulnerable component impacts resources in components beyond its security scope. - "userInteraction": "A String", # This metric captures the requirement for a human user, other than the attacker, to participate in the successful compromise of the vulnerable component. + "vulnerability": { + "cve": { + "cvssv3": { + "attackComplexity": "A String", + "attackVector": "A String", + "availabilityImpact": "A String", + "baseScore": 3.14, + "confidentialityImpact": "A String", + "integrityImpact": "A String", + "privilegesRequired": "A String", + "scope": "A String", + "userInteraction": "A String", }, - "exploitReleaseDate": "A String", # Date the first publicly available exploit or PoC was released. - "exploitationActivity": "A String", # The exploitation activity of the vulnerability in the wild. - "firstExploitationDate": "A String", # Date of the earliest known exploitation. - "id": "A String", # The unique identifier for the vulnerability. e.g. CVE-2021-34527 - "impact": "A String", # The potential impact of the vulnerability if it was to be exploited. - "observedInTheWild": True or False, # Whether or not the vulnerability has been observed in the wild. - "references": [ # Additional information about the CVE. e.g. https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2021-34527 - { # Additional Links - "source": "A String", # Source of the reference e.g. NVD - "uri": "A String", # Uri for the mentioned source e.g. https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2021-34527. + "exploitReleaseDate": "A String", + "exploitationActivity": "A String", + "firstExploitationDate": "A String", + "id": "A String", + "impact": "A String", + "observedInTheWild": True or False, + "references": [ + { + "source": "A String", + "uri": "A String", }, ], - "upstreamFixAvailable": True or False, # Whether upstream fix is available for the CVE. - "zeroDay": True or False, # Whether or not the vulnerability was zero day when the finding was published. + "upstreamFixAvailable": True or False, + "zeroDay": True or False, }, - "cwes": [ # Represents one or more Common Weakness Enumeration (CWE) information on this vulnerability. - { # CWE stands for Common Weakness Enumeration. Information about this weakness, as described by [CWE](https://cwe.mitre.org/). - "id": "A String", # The CWE identifier, e.g. CWE-94 - "references": [ # Any reference to the details on the CWE, for example, https://cwe.mitre.org/data/definitions/94.html - { # Additional Links - "source": "A String", # Source of the reference e.g. NVD - "uri": "A String", # Uri for the mentioned source e.g. https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2021-34527. + "cwes": [ + { + "id": "A String", + "references": [ + { + "source": "A String", + "uri": "A String", }, ], }, ], - "fixedPackage": { # Package is a generic definition of a package. # The fixed package is relevant to the finding. - "cpeUri": "A String", # The CPE URI where the vulnerability was detected. - "packageName": "A String", # The name of the package where the vulnerability was detected. - "packageType": "A String", # Type of package, for example, os, maven, or go. - "packageVersion": "A String", # The version of the package. + "fixedPackage": { + "cpeUri": "A String", + "packageName": "A String", + "packageType": "A String", + "packageVersion": "A String", }, - "offendingPackage": { # Package is a generic definition of a package. # The offending package is relevant to the finding. - "cpeUri": "A String", # The CPE URI where the vulnerability was detected. - "packageName": "A String", # The name of the package where the vulnerability was detected. - "packageType": "A String", # Type of package, for example, os, maven, or go. - "packageVersion": "A String", # The version of the package. + "offendingPackage": { + "cpeUri": "A String", + "packageName": "A String", + "packageType": "A String", + "packageVersion": "A String", }, - "providerRiskScore": "A String", # Provider provided risk_score based on multiple factors. The higher the risk score, the more risky the vulnerability is. - "reachable": True or False, # Represents whether the vulnerability is reachable (detected via static analysis) - "securityBulletin": { # SecurityBulletin are notifications of vulnerabilities of Google products. # The security bulletin is relevant to this finding. - "bulletinId": "A String", # ID of the bulletin corresponding to the vulnerability. - "submissionTime": "A String", # Submission time of this Security Bulletin. - "suggestedUpgradeVersion": "A String", # This represents a version that the cluster receiving this notification should be upgraded to, based on its current version. For example, 1.15.0 + "providerRiskScore": "A String", + "reachable": True or False, + "securityBulletin": { + "bulletinId": "A String", + "submissionTime": "A String", + "suggestedUpgradeVersion": "A String", }, }, }, - "noViolation": { # 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); } # Indicates that the test case does not trigger any violation. + "noViolation": { }, }, }
diff --git a/docs/dyn/securitycenter_v1.organizations.securityHealthAnalyticsSettings.effectiveCustomModules.html b/docs/dyn/securitycenter_v1.organizations.securityHealthAnalyticsSettings.effectiveCustomModules.html index 50e9066a1a..7c0819530c 100644 --- a/docs/dyn/securitycenter_v1.organizations.securityHealthAnalyticsSettings.effectiveCustomModules.html +++ b/docs/dyn/securitycenter_v1.organizations.securityHealthAnalyticsSettings.effectiveCustomModules.html @@ -79,10 +79,10 @@

Instance Methods

Close httplib2 connections.

get(name, x__xgafv=None)

-

Retrieves an EffectiveSecurityHealthAnalyticsCustomModule.

+

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

-

Returns a list of all EffectiveSecurityHealthAnalyticsCustomModules for the given parent. This includes resident modules defined at the scope of the parent, and inherited modules, inherited from CRM ancestors.

+

list_next()

Retrieves the next page of results.

@@ -94,10 +94,10 @@

Method Details

get(name, x__xgafv=None) -
Retrieves an EffectiveSecurityHealthAnalyticsCustomModule.
+  
 
 Args:
-  name: string, Required. Name of the effective custom module to get. Its format is `organizations/{organization}/securityHealthAnalyticsSettings/effectiveCustomModules/{customModule}`, `folders/{folder}/securityHealthAnalyticsSettings/effectiveCustomModules/{customModule}`, or `projects/{project}/securityHealthAnalyticsSettings/effectiveCustomModules/{customModule}` (required)
+  name: string, A parameter (required)
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -106,51 +106,51 @@ 

Method Details

Returns: An object of the form: - { # An EffectiveSecurityHealthAnalyticsCustomModule is the representation of a Security Health Analytics custom module at a specified level of the resource hierarchy: organization, folder, or project. If a custom module is inherited from a parent organization or folder, the value of the `enablementState` property in EffectiveSecurityHealthAnalyticsCustomModule is set to the value that is effective in the parent, instead of `INHERITED`. For example, if the module is enabled in a parent organization or folder, the effective enablement_state for the module in all child folders or projects is also `enabled`. EffectiveSecurityHealthAnalyticsCustomModule is read-only. - "cloudProvider": "A String", # The cloud provider of the custom module. - "customConfig": { # Defines the properties in a custom module configuration for Security Health Analytics. Use the custom module configuration to create custom detectors that generate custom findings for resources that you specify. # Output only. The user-specified configuration for the module. - "customOutput": { # A set of optional name-value pairs that define custom source properties to return with each finding that is generated by the custom module. The custom source properties that are defined here are included in the finding JSON under `sourceProperties`. # Custom output properties. - "properties": [ # A list of custom output properties to add to the finding. - { # An individual name-value pair that defines a custom source property. - "name": "A String", # Name of the property for the custom output. - "valueExpression": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The CEL expression for the custom output. A resource property can be specified to return the value of the property or a text string enclosed in quotation marks. - "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. - "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. - "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file. - "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. + { + "cloudProvider": "A String", + "customConfig": { + "customOutput": { + "properties": [ + { + "name": "A String", + "valueExpression": { + "description": "A String", + "expression": "A String", + "location": "A String", + "title": "A String", }, }, ], }, - "description": "A String", # Text that describes the vulnerability or misconfiguration that the custom module detects. This explanation is returned with each finding instance to help investigators understand the detected issue. The text must be enclosed in quotation marks. - "predicate": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The CEL expression to evaluate to produce findings. When the expression evaluates to true against a resource, a finding is generated. - "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. - "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. - "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file. - "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. + "description": "A String", + "predicate": { + "description": "A String", + "expression": "A String", + "location": "A String", + "title": "A String", }, - "recommendation": "A String", # An explanation of the recommended steps that security teams can take to resolve the detected issue. This explanation is returned with each finding generated by this module in the `nextSteps` property of the finding JSON. - "resourceSelector": { # Resource for selecting resource type. # The resource types that the custom module operates on. Each custom module can specify up to 5 resource types. - "resourceTypes": [ # The resource types to run the detector on. + "recommendation": "A String", + "resourceSelector": { + "resourceTypes": [ "A String", ], }, - "severity": "A String", # The severity to assign to findings generated by the module. + "severity": "A String", }, - "displayName": "A String", # Output only. The display name for the custom module. The name must be between 1 and 128 characters, start with a lowercase letter, and contain alphanumeric characters or underscores only. - "enablementState": "A String", # Output only. The effective state of enablement for the module at the given level of the hierarchy. - "name": "A String", # Output only. The resource name of the custom module. Its format is "organizations/{organization}/securityHealthAnalyticsSettings/effectiveCustomModules/{customModule}", or "folders/{folder}/securityHealthAnalyticsSettings/effectiveCustomModules/{customModule}", or "projects/{project}/securityHealthAnalyticsSettings/effectiveCustomModules/{customModule}" + "displayName": "A String", + "enablementState": "A String", + "name": "A String", }
list(parent, pageSize=None, pageToken=None, x__xgafv=None) -
Returns a list of all EffectiveSecurityHealthAnalyticsCustomModules for the given parent. This includes resident modules defined at the scope of the parent, and inherited modules, inherited from CRM ancestors.
+  
 
 Args:
-  parent: string, Required. Name of parent to list effective custom modules. Its format is `organizations/{organization}/securityHealthAnalyticsSettings`, `folders/{folder}/securityHealthAnalyticsSettings`, or `projects/{project}/securityHealthAnalyticsSettings` (required)
-  pageSize: integer, The maximum number of results to return in a single response. Default is 10, minimum is 1, maximum is 1000.
-  pageToken: string, The value returned by the last call indicating a continuation
+  parent: string, A parameter (required)
+  pageSize: integer, A parameter
+  pageToken: string, A parameter
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -159,45 +159,45 @@ 

Method Details

Returns: An object of the form: - { # Response message for listing effective Security Health Analytics custom modules. - "effectiveSecurityHealthAnalyticsCustomModules": [ # Effective custom modules belonging to the requested parent. - { # An EffectiveSecurityHealthAnalyticsCustomModule is the representation of a Security Health Analytics custom module at a specified level of the resource hierarchy: organization, folder, or project. If a custom module is inherited from a parent organization or folder, the value of the `enablementState` property in EffectiveSecurityHealthAnalyticsCustomModule is set to the value that is effective in the parent, instead of `INHERITED`. For example, if the module is enabled in a parent organization or folder, the effective enablement_state for the module in all child folders or projects is also `enabled`. EffectiveSecurityHealthAnalyticsCustomModule is read-only. - "cloudProvider": "A String", # The cloud provider of the custom module. - "customConfig": { # Defines the properties in a custom module configuration for Security Health Analytics. Use the custom module configuration to create custom detectors that generate custom findings for resources that you specify. # Output only. The user-specified configuration for the module. - "customOutput": { # A set of optional name-value pairs that define custom source properties to return with each finding that is generated by the custom module. The custom source properties that are defined here are included in the finding JSON under `sourceProperties`. # Custom output properties. - "properties": [ # A list of custom output properties to add to the finding. - { # An individual name-value pair that defines a custom source property. - "name": "A String", # Name of the property for the custom output. - "valueExpression": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The CEL expression for the custom output. A resource property can be specified to return the value of the property or a text string enclosed in quotation marks. - "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. - "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. - "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file. - "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. + { + "effectiveSecurityHealthAnalyticsCustomModules": [ + { + "cloudProvider": "A String", + "customConfig": { + "customOutput": { + "properties": [ + { + "name": "A String", + "valueExpression": { + "description": "A String", + "expression": "A String", + "location": "A String", + "title": "A String", }, }, ], }, - "description": "A String", # Text that describes the vulnerability or misconfiguration that the custom module detects. This explanation is returned with each finding instance to help investigators understand the detected issue. The text must be enclosed in quotation marks. - "predicate": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The CEL expression to evaluate to produce findings. When the expression evaluates to true against a resource, a finding is generated. - "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. - "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. - "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file. - "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. + "description": "A String", + "predicate": { + "description": "A String", + "expression": "A String", + "location": "A String", + "title": "A String", }, - "recommendation": "A String", # An explanation of the recommended steps that security teams can take to resolve the detected issue. This explanation is returned with each finding generated by this module in the `nextSteps` property of the finding JSON. - "resourceSelector": { # Resource for selecting resource type. # The resource types that the custom module operates on. Each custom module can specify up to 5 resource types. - "resourceTypes": [ # The resource types to run the detector on. + "recommendation": "A String", + "resourceSelector": { + "resourceTypes": [ "A String", ], }, - "severity": "A String", # The severity to assign to findings generated by the module. + "severity": "A String", }, - "displayName": "A String", # Output only. The display name for the custom module. The name must be between 1 and 128 characters, start with a lowercase letter, and contain alphanumeric characters or underscores only. - "enablementState": "A String", # Output only. The effective state of enablement for the module at the given level of the hierarchy. - "name": "A String", # Output only. The resource name of the custom module. Its format is "organizations/{organization}/securityHealthAnalyticsSettings/effectiveCustomModules/{customModule}", or "folders/{folder}/securityHealthAnalyticsSettings/effectiveCustomModules/{customModule}", or "projects/{project}/securityHealthAnalyticsSettings/effectiveCustomModules/{customModule}" + "displayName": "A String", + "enablementState": "A String", + "name": "A String", }, ], - "nextPageToken": "A String", # If not empty, indicates that there may be more effective custom modules to be returned. + "nextPageToken": "A String", }
diff --git a/docs/dyn/securitycenter_v1.organizations.simulations.attackExposureResults.attackPaths.html b/docs/dyn/securitycenter_v1.organizations.simulations.attackExposureResults.attackPaths.html index e310178f4f..b1e795f073 100644 --- a/docs/dyn/securitycenter_v1.organizations.simulations.attackExposureResults.attackPaths.html +++ b/docs/dyn/securitycenter_v1.organizations.simulations.attackExposureResults.attackPaths.html @@ -79,7 +79,7 @@

Instance Methods

Close httplib2 connections.

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

-

Lists the attack paths for a set of simulation results or valued resources and filter.

+

list_next()

Retrieves the next page of results.

@@ -91,13 +91,13 @@

Method Details

list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None) -
Lists the attack paths for a set of simulation results or valued resources and filter.
+  
 
 Args:
-  parent: string, Required. Name of parent to list attack paths. Valid formats: `organizations/{organization}`, `organizations/{organization}/simulations/{simulation}` `organizations/{organization}/simulations/{simulation}/attackExposureResults/{attack_exposure_result_v2}` `organizations/{organization}/simulations/{simulation}/valuedResources/{valued_resource}` (required)
-  filter: string, The filter expression that filters the attack path in the response. Supported fields: * `valued_resources` supports =
-  pageSize: integer, The maximum number of results to return in a single response. Default is 10, minimum is 1, maximum is 1000.
-  pageToken: string, The value returned by the last `ListAttackPathsResponse`; indicates that this is a continuation of a prior `ListAttackPaths` call, and that the system should return the next page of data.
+  parent: string, A parameter (required)
+  filter: string, A parameter
+  pageSize: integer, A parameter
+  pageToken: string, A parameter
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -106,45 +106,45 @@ 

Method Details

Returns: An object of the form: - { # Response message for listing the attack paths for a given simulation or valued resource. - "attackPaths": [ # The attack paths that the attack path simulation identified. - { # A path that an attacker could take to reach an exposed resource. - "edges": [ # A list of the edges between nodes in this attack path. - { # Represents a connection between a source node and a destination node in this attack path. - "destination": "A String", # The attack node uuid of the destination node. - "source": "A String", # The attack node uuid of the source node. + { + "attackPaths": [ + { + "edges": [ + { + "destination": "A String", + "source": "A String", }, ], - "name": "A String", # The attack path name, for example, `organizations/12/simulation/34/valuedResources/56/attackPaths/78` - "pathNodes": [ # A list of nodes that exist in this attack path. - { # Represents one point that an attacker passes through in this attack path. - "associatedFindings": [ # The findings associated with this node in the attack path. - { # A finding that is associated with this node in the attack path. - "canonicalFinding": "A String", # Canonical name of the associated findings. Example: `organizations/123/sources/456/findings/789` - "findingCategory": "A String", # The additional taxonomy group within findings from a given source. - "name": "A String", # Full resource name of the finding. + "name": "A String", + "pathNodes": [ + { + "associatedFindings": [ + { + "canonicalFinding": "A String", + "findingCategory": "A String", + "name": "A String", }, ], - "attackSteps": [ # A list of attack step nodes that exist in this attack path node. - { # Detailed steps the attack can take between path nodes. - "description": "A String", # Attack step description - "displayName": "A String", # User friendly name of the attack step - "labels": { # Attack step labels for metadata + "attackSteps": [ + { + "description": "A String", + "displayName": "A String", + "labels": { "a_key": "A String", }, - "type": "A String", # Attack step type. Can be either AND, OR or DEFENSE - "uuid": "A String", # Unique ID for one Node + "type": "A String", + "uuid": "A String", }, ], - "displayName": "A String", # Human-readable name of this resource. - "resource": "A String", # The name of the resource at this point in the attack path. The format of the name follows the Cloud Asset Inventory [resource name format](https://cloud.google.com/asset-inventory/docs/resource-name-format) - "resourceType": "A String", # The [supported resource type](https://cloud.google.com/asset-inventory/docs/supported-asset-types) - "uuid": "A String", # Unique id of the attack path node. + "displayName": "A String", + "resource": "A String", + "resourceType": "A String", + "uuid": "A String", }, ], }, ], - "nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no more results. + "nextPageToken": "A String", }
diff --git a/docs/dyn/securitycenter_v1.organizations.simulations.attackExposureResults.valuedResources.html b/docs/dyn/securitycenter_v1.organizations.simulations.attackExposureResults.valuedResources.html index f9b2f9492c..0869d5a02b 100644 --- a/docs/dyn/securitycenter_v1.organizations.simulations.attackExposureResults.valuedResources.html +++ b/docs/dyn/securitycenter_v1.organizations.simulations.attackExposureResults.valuedResources.html @@ -79,7 +79,7 @@

Instance Methods

Close httplib2 connections.

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

-

Lists the valued resources for a set of simulation results and filter.

+

list_next()

Retrieves the next page of results.

@@ -91,14 +91,14 @@

Method Details

list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None) -
Lists the valued resources for a set of simulation results and filter.
+  
 
 Args:
-  parent: string, Required. Name of parent to list valued resources. Valid formats: `organizations/{organization}`, `organizations/{organization}/simulations/{simulation}` `organizations/{organization}/simulations/{simulation}/attackExposureResults/{attack_exposure_result_v2}` (required)
-  filter: string, The filter expression that filters the valued resources in the response. Supported fields: * `resource_value` supports = * `resource_type` supports =
-  orderBy: string, Optional. The fields by which to order the valued resources response. Supported fields: * `exposed_score` * `resource_value` * `resource_type` * `resource` * `display_name` Values should be a comma separated list of fields. For example: `exposed_score,resource_value`. The default sorting order is descending. To specify ascending or descending order for a field, append a ` ASC` or a ` DESC` suffix, respectively; for example: `exposed_score DESC`.
-  pageSize: integer, The maximum number of results to return in a single response. Default is 10, minimum is 1, maximum is 1000.
-  pageToken: string, The value returned by the last `ListValuedResourcesResponse`; indicates that this is a continuation of a prior `ListValuedResources` call, and that the system should return the next page of data.
+  parent: string, A parameter (required)
+  filter: string, A parameter
+  orderBy: string, A parameter
+  pageSize: integer, A parameter
+  pageToken: string, A parameter
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -107,20 +107,20 @@ 

Method Details

Returns: An object of the form: - { # Response message for listing the valued resources for a given simulation. - "nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no more results. - "totalSize": 42, # The estimated total number of results matching the query. - "valuedResources": [ # The valued resources that the attack path simulation identified. - { # A resource that is determined to have value to a user's system - "displayName": "A String", # Human-readable name of the valued resource. - "exposedScore": 3.14, # Exposed score for this valued resource. A value of 0 means no exposure was detected exposure. - "name": "A String", # Valued resource name, for example, e.g.: `organizations/123/simulations/456/valuedResources/789` - "resource": "A String", # The [full resource name](https://cloud.google.com/apis/design/resource_names#full_resource_name) of the valued resource. - "resourceType": "A String", # The [resource type](https://cloud.google.com/asset-inventory/docs/supported-asset-types) of the valued resource. - "resourceValue": "A String", # How valuable this resource is. - "resourceValueConfigsUsed": [ # List of resource value configurations' metadata used to determine the value of this resource. Maximum of 100. - { # Metadata about a ResourceValueConfig. For example, id and name. - "name": "A String", # Resource value config name + { + "nextPageToken": "A String", + "totalSize": 42, + "valuedResources": [ + { + "displayName": "A String", + "exposedScore": 3.14, + "name": "A String", + "resource": "A String", + "resourceType": "A String", + "resourceValue": "A String", + "resourceValueConfigsUsed": [ + { + "name": "A String", }, ], }, diff --git a/docs/dyn/securitycenter_v1.organizations.simulations.attackPaths.html b/docs/dyn/securitycenter_v1.organizations.simulations.attackPaths.html index dee2de1ce3..ba12d24cfd 100644 --- a/docs/dyn/securitycenter_v1.organizations.simulations.attackPaths.html +++ b/docs/dyn/securitycenter_v1.organizations.simulations.attackPaths.html @@ -79,7 +79,7 @@

Instance Methods

Close httplib2 connections.

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

-

Lists the attack paths for a set of simulation results or valued resources and filter.

+

list_next()

Retrieves the next page of results.

@@ -91,13 +91,13 @@

Method Details

list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None) -
Lists the attack paths for a set of simulation results or valued resources and filter.
+  
 
 Args:
-  parent: string, Required. Name of parent to list attack paths. Valid formats: `organizations/{organization}`, `organizations/{organization}/simulations/{simulation}` `organizations/{organization}/simulations/{simulation}/attackExposureResults/{attack_exposure_result_v2}` `organizations/{organization}/simulations/{simulation}/valuedResources/{valued_resource}` (required)
-  filter: string, The filter expression that filters the attack path in the response. Supported fields: * `valued_resources` supports =
-  pageSize: integer, The maximum number of results to return in a single response. Default is 10, minimum is 1, maximum is 1000.
-  pageToken: string, The value returned by the last `ListAttackPathsResponse`; indicates that this is a continuation of a prior `ListAttackPaths` call, and that the system should return the next page of data.
+  parent: string, A parameter (required)
+  filter: string, A parameter
+  pageSize: integer, A parameter
+  pageToken: string, A parameter
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -106,45 +106,45 @@ 

Method Details

Returns: An object of the form: - { # Response message for listing the attack paths for a given simulation or valued resource. - "attackPaths": [ # The attack paths that the attack path simulation identified. - { # A path that an attacker could take to reach an exposed resource. - "edges": [ # A list of the edges between nodes in this attack path. - { # Represents a connection between a source node and a destination node in this attack path. - "destination": "A String", # The attack node uuid of the destination node. - "source": "A String", # The attack node uuid of the source node. + { + "attackPaths": [ + { + "edges": [ + { + "destination": "A String", + "source": "A String", }, ], - "name": "A String", # The attack path name, for example, `organizations/12/simulation/34/valuedResources/56/attackPaths/78` - "pathNodes": [ # A list of nodes that exist in this attack path. - { # Represents one point that an attacker passes through in this attack path. - "associatedFindings": [ # The findings associated with this node in the attack path. - { # A finding that is associated with this node in the attack path. - "canonicalFinding": "A String", # Canonical name of the associated findings. Example: `organizations/123/sources/456/findings/789` - "findingCategory": "A String", # The additional taxonomy group within findings from a given source. - "name": "A String", # Full resource name of the finding. + "name": "A String", + "pathNodes": [ + { + "associatedFindings": [ + { + "canonicalFinding": "A String", + "findingCategory": "A String", + "name": "A String", }, ], - "attackSteps": [ # A list of attack step nodes that exist in this attack path node. - { # Detailed steps the attack can take between path nodes. - "description": "A String", # Attack step description - "displayName": "A String", # User friendly name of the attack step - "labels": { # Attack step labels for metadata + "attackSteps": [ + { + "description": "A String", + "displayName": "A String", + "labels": { "a_key": "A String", }, - "type": "A String", # Attack step type. Can be either AND, OR or DEFENSE - "uuid": "A String", # Unique ID for one Node + "type": "A String", + "uuid": "A String", }, ], - "displayName": "A String", # Human-readable name of this resource. - "resource": "A String", # The name of the resource at this point in the attack path. The format of the name follows the Cloud Asset Inventory [resource name format](https://cloud.google.com/asset-inventory/docs/resource-name-format) - "resourceType": "A String", # The [supported resource type](https://cloud.google.com/asset-inventory/docs/supported-asset-types) - "uuid": "A String", # Unique id of the attack path node. + "displayName": "A String", + "resource": "A String", + "resourceType": "A String", + "uuid": "A String", }, ], }, ], - "nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no more results. + "nextPageToken": "A String", }
diff --git a/docs/dyn/securitycenter_v1.organizations.simulations.html b/docs/dyn/securitycenter_v1.organizations.simulations.html index bc9074ec04..6d130327a9 100644 --- a/docs/dyn/securitycenter_v1.organizations.simulations.html +++ b/docs/dyn/securitycenter_v1.organizations.simulations.html @@ -94,7 +94,7 @@

Instance Methods

Close httplib2 connections.

get(name, x__xgafv=None)

-

Get the simulation by name or the latest simulation for the given organization.

+

Method Details

close() @@ -103,10 +103,10 @@

Method Details

get(name, x__xgafv=None) -
Get the simulation by name or the latest simulation for the given organization.
+  
 
 Args:
-  name: string, Required. The organization name or simulation name of this simulation Valid format: `organizations/{organization}/simulations/latest` `organizations/{organization}/simulations/{simulation}` (required)
+  name: string, A parameter (required)
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -115,13 +115,13 @@ 

Method Details

Returns: An object of the form: - { # Attack path simulation - "cloudProvider": "A String", # Indicates which cloud provider was used in this simulation. - "createTime": "A String", # Output only. Time simulation was created - "name": "A String", # Full resource name of the Simulation: `organizations/123/simulations/456` - "resourceValueConfigsMetadata": [ # Resource value configurations' metadata used in this simulation. Maximum of 100. - { # Metadata about a ResourceValueConfig. For example, id and name. - "name": "A String", # Resource value config name + { + "cloudProvider": "A String", + "createTime": "A String", + "name": "A String", + "resourceValueConfigsMetadata": [ + { + "name": "A String", }, ], }
diff --git a/docs/dyn/securitycenter_v1.organizations.simulations.valuedResources.attackPaths.html b/docs/dyn/securitycenter_v1.organizations.simulations.valuedResources.attackPaths.html index fd22287b97..c20d31c4b3 100644 --- a/docs/dyn/securitycenter_v1.organizations.simulations.valuedResources.attackPaths.html +++ b/docs/dyn/securitycenter_v1.organizations.simulations.valuedResources.attackPaths.html @@ -79,7 +79,7 @@

Instance Methods

Close httplib2 connections.

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

-

Lists the attack paths for a set of simulation results or valued resources and filter.

+

list_next()

Retrieves the next page of results.

@@ -91,13 +91,13 @@

Method Details

list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None) -
Lists the attack paths for a set of simulation results or valued resources and filter.
+  
 
 Args:
-  parent: string, Required. Name of parent to list attack paths. Valid formats: `organizations/{organization}`, `organizations/{organization}/simulations/{simulation}` `organizations/{organization}/simulations/{simulation}/attackExposureResults/{attack_exposure_result_v2}` `organizations/{organization}/simulations/{simulation}/valuedResources/{valued_resource}` (required)
-  filter: string, The filter expression that filters the attack path in the response. Supported fields: * `valued_resources` supports =
-  pageSize: integer, The maximum number of results to return in a single response. Default is 10, minimum is 1, maximum is 1000.
-  pageToken: string, The value returned by the last `ListAttackPathsResponse`; indicates that this is a continuation of a prior `ListAttackPaths` call, and that the system should return the next page of data.
+  parent: string, A parameter (required)
+  filter: string, A parameter
+  pageSize: integer, A parameter
+  pageToken: string, A parameter
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -106,45 +106,45 @@ 

Method Details

Returns: An object of the form: - { # Response message for listing the attack paths for a given simulation or valued resource. - "attackPaths": [ # The attack paths that the attack path simulation identified. - { # A path that an attacker could take to reach an exposed resource. - "edges": [ # A list of the edges between nodes in this attack path. - { # Represents a connection between a source node and a destination node in this attack path. - "destination": "A String", # The attack node uuid of the destination node. - "source": "A String", # The attack node uuid of the source node. + { + "attackPaths": [ + { + "edges": [ + { + "destination": "A String", + "source": "A String", }, ], - "name": "A String", # The attack path name, for example, `organizations/12/simulation/34/valuedResources/56/attackPaths/78` - "pathNodes": [ # A list of nodes that exist in this attack path. - { # Represents one point that an attacker passes through in this attack path. - "associatedFindings": [ # The findings associated with this node in the attack path. - { # A finding that is associated with this node in the attack path. - "canonicalFinding": "A String", # Canonical name of the associated findings. Example: `organizations/123/sources/456/findings/789` - "findingCategory": "A String", # The additional taxonomy group within findings from a given source. - "name": "A String", # Full resource name of the finding. + "name": "A String", + "pathNodes": [ + { + "associatedFindings": [ + { + "canonicalFinding": "A String", + "findingCategory": "A String", + "name": "A String", }, ], - "attackSteps": [ # A list of attack step nodes that exist in this attack path node. - { # Detailed steps the attack can take between path nodes. - "description": "A String", # Attack step description - "displayName": "A String", # User friendly name of the attack step - "labels": { # Attack step labels for metadata + "attackSteps": [ + { + "description": "A String", + "displayName": "A String", + "labels": { "a_key": "A String", }, - "type": "A String", # Attack step type. Can be either AND, OR or DEFENSE - "uuid": "A String", # Unique ID for one Node + "type": "A String", + "uuid": "A String", }, ], - "displayName": "A String", # Human-readable name of this resource. - "resource": "A String", # The name of the resource at this point in the attack path. The format of the name follows the Cloud Asset Inventory [resource name format](https://cloud.google.com/asset-inventory/docs/resource-name-format) - "resourceType": "A String", # The [supported resource type](https://cloud.google.com/asset-inventory/docs/supported-asset-types) - "uuid": "A String", # Unique id of the attack path node. + "displayName": "A String", + "resource": "A String", + "resourceType": "A String", + "uuid": "A String", }, ], }, ], - "nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no more results. + "nextPageToken": "A String", }
diff --git a/docs/dyn/securitycenter_v1.organizations.simulations.valuedResources.html b/docs/dyn/securitycenter_v1.organizations.simulations.valuedResources.html index b7ae94a1ef..18dea063af 100644 --- a/docs/dyn/securitycenter_v1.organizations.simulations.valuedResources.html +++ b/docs/dyn/securitycenter_v1.organizations.simulations.valuedResources.html @@ -84,10 +84,10 @@

Instance Methods

Close httplib2 connections.

get(name, x__xgafv=None)

-

Get the valued resource by name

+

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

-

Lists the valued resources for a set of simulation results and filter.

+

list_next()

Retrieves the next page of results.

@@ -99,10 +99,10 @@

Method Details

get(name, x__xgafv=None) -
Get the valued resource by name
+  
 
 Args:
-  name: string, Required. The name of this valued resource Valid format: `organizations/{organization}/simulations/{simulation}/valuedResources/{valued_resource}` (required)
+  name: string, A parameter (required)
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -111,16 +111,16 @@ 

Method Details

Returns: An object of the form: - { # A resource that is determined to have value to a user's system - "displayName": "A String", # Human-readable name of the valued resource. - "exposedScore": 3.14, # Exposed score for this valued resource. A value of 0 means no exposure was detected exposure. - "name": "A String", # Valued resource name, for example, e.g.: `organizations/123/simulations/456/valuedResources/789` - "resource": "A String", # The [full resource name](https://cloud.google.com/apis/design/resource_names#full_resource_name) of the valued resource. - "resourceType": "A String", # The [resource type](https://cloud.google.com/asset-inventory/docs/supported-asset-types) of the valued resource. - "resourceValue": "A String", # How valuable this resource is. - "resourceValueConfigsUsed": [ # List of resource value configurations' metadata used to determine the value of this resource. Maximum of 100. - { # Metadata about a ResourceValueConfig. For example, id and name. - "name": "A String", # Resource value config name + { + "displayName": "A String", + "exposedScore": 3.14, + "name": "A String", + "resource": "A String", + "resourceType": "A String", + "resourceValue": "A String", + "resourceValueConfigsUsed": [ + { + "name": "A String", }, ], }
@@ -128,14 +128,14 @@

Method Details

list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None) -
Lists the valued resources for a set of simulation results and filter.
+  
 
 Args:
-  parent: string, Required. Name of parent to list valued resources. Valid formats: `organizations/{organization}`, `organizations/{organization}/simulations/{simulation}` `organizations/{organization}/simulations/{simulation}/attackExposureResults/{attack_exposure_result_v2}` (required)
-  filter: string, The filter expression that filters the valued resources in the response. Supported fields: * `resource_value` supports = * `resource_type` supports =
-  orderBy: string, Optional. The fields by which to order the valued resources response. Supported fields: * `exposed_score` * `resource_value` * `resource_type` * `resource` * `display_name` Values should be a comma separated list of fields. For example: `exposed_score,resource_value`. The default sorting order is descending. To specify ascending or descending order for a field, append a ` ASC` or a ` DESC` suffix, respectively; for example: `exposed_score DESC`.
-  pageSize: integer, The maximum number of results to return in a single response. Default is 10, minimum is 1, maximum is 1000.
-  pageToken: string, The value returned by the last `ListValuedResourcesResponse`; indicates that this is a continuation of a prior `ListValuedResources` call, and that the system should return the next page of data.
+  parent: string, A parameter (required)
+  filter: string, A parameter
+  orderBy: string, A parameter
+  pageSize: integer, A parameter
+  pageToken: string, A parameter
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -144,20 +144,20 @@ 

Method Details

Returns: An object of the form: - { # Response message for listing the valued resources for a given simulation. - "nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no more results. - "totalSize": 42, # The estimated total number of results matching the query. - "valuedResources": [ # The valued resources that the attack path simulation identified. - { # A resource that is determined to have value to a user's system - "displayName": "A String", # Human-readable name of the valued resource. - "exposedScore": 3.14, # Exposed score for this valued resource. A value of 0 means no exposure was detected exposure. - "name": "A String", # Valued resource name, for example, e.g.: `organizations/123/simulations/456/valuedResources/789` - "resource": "A String", # The [full resource name](https://cloud.google.com/apis/design/resource_names#full_resource_name) of the valued resource. - "resourceType": "A String", # The [resource type](https://cloud.google.com/asset-inventory/docs/supported-asset-types) of the valued resource. - "resourceValue": "A String", # How valuable this resource is. - "resourceValueConfigsUsed": [ # List of resource value configurations' metadata used to determine the value of this resource. Maximum of 100. - { # Metadata about a ResourceValueConfig. For example, id and name. - "name": "A String", # Resource value config name + { + "nextPageToken": "A String", + "totalSize": 42, + "valuedResources": [ + { + "displayName": "A String", + "exposedScore": 3.14, + "name": "A String", + "resource": "A String", + "resourceType": "A String", + "resourceValue": "A String", + "resourceValueConfigsUsed": [ + { + "name": "A String", }, ], }, diff --git a/docs/dyn/securitycenter_v1.organizations.sources.findings.externalSystems.html b/docs/dyn/securitycenter_v1.organizations.sources.findings.externalSystems.html index af12dbbccf..95586a2841 100644 --- a/docs/dyn/securitycenter_v1.organizations.sources.findings.externalSystems.html +++ b/docs/dyn/securitycenter_v1.organizations.sources.findings.externalSystems.html @@ -79,7 +79,7 @@

Instance Methods

Close httplib2 connections.

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

-

Updates external system. This is for a given finding.

+

Method Details

close() @@ -88,37 +88,37 @@

Method Details

patch(name, body=None, updateMask=None, x__xgafv=None) -
Updates external system. This is for a given finding.
+  
 
 Args:
-  name: string, Full resource name of the external system, for example: "organizations/1234/sources/5678/findings/123456/externalSystems/jira", "folders/1234/sources/5678/findings/123456/externalSystems/jira", "projects/1234/sources/5678/findings/123456/externalSystems/jira" (required)
+  name: string, A parameter (required)
   body: object, The request body.
     The object takes the form of:
 
-{ # Representation of third party SIEM/SOAR fields within SCC.
-  "assignees": [ # References primary/secondary etc assignees in the external system.
+{
+  "assignees": [
     "A String",
   ],
-  "caseCloseTime": "A String", # The time when the case was closed, as reported by the external system.
-  "caseCreateTime": "A String", # The time when the case was created, as reported by the external system.
-  "casePriority": "A String", # The priority of the finding's corresponding case in the external system.
-  "caseSla": "A String", # The SLA of the finding's corresponding case in the external system.
-  "caseUri": "A String", # The link to the finding's corresponding case in the external system.
-  "externalSystemUpdateTime": "A String", # The time when the case was last updated, as reported by the external system.
-  "externalUid": "A String", # The identifier that's used to track the finding's corresponding case in the external system.
-  "name": "A String", # Full resource name of the external system, for example: "organizations/1234/sources/5678/findings/123456/externalSystems/jira", "folders/1234/sources/5678/findings/123456/externalSystems/jira", "projects/1234/sources/5678/findings/123456/externalSystems/jira"
-  "status": "A String", # The most recent status of the finding's corresponding case, as reported by the external system.
-  "ticketInfo": { # Information about the ticket, if any, that is being used to track the resolution of the issue that is identified by this finding. # Information about the ticket, if any, that is being used to track the resolution of the issue that is identified by this finding.
-    "assignee": "A String", # The assignee of the ticket in the ticket system.
-    "description": "A String", # The description of the ticket in the ticket system.
-    "id": "A String", # The identifier of the ticket in the ticket system.
-    "status": "A String", # The latest status of the ticket, as reported by the ticket system.
-    "updateTime": "A String", # The time when the ticket was last updated, as reported by the ticket system.
-    "uri": "A String", # The link to the ticket in the ticket system.
+  "caseCloseTime": "A String",
+  "caseCreateTime": "A String",
+  "casePriority": "A String",
+  "caseSla": "A String",
+  "caseUri": "A String",
+  "externalSystemUpdateTime": "A String",
+  "externalUid": "A String",
+  "name": "A String",
+  "status": "A String",
+  "ticketInfo": {
+    "assignee": "A String",
+    "description": "A String",
+    "id": "A String",
+    "status": "A String",
+    "updateTime": "A String",
+    "uri": "A String",
   },
 }
 
-  updateMask: string, The FieldMask to use when updating the external system resource. If empty all mutable fields will be updated.
+  updateMask: string, A parameter
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -127,26 +127,26 @@ 

Method Details

Returns: An object of the form: - { # Representation of third party SIEM/SOAR fields within SCC. - "assignees": [ # References primary/secondary etc assignees in the external system. + { + "assignees": [ "A String", ], - "caseCloseTime": "A String", # The time when the case was closed, as reported by the external system. - "caseCreateTime": "A String", # The time when the case was created, as reported by the external system. - "casePriority": "A String", # The priority of the finding's corresponding case in the external system. - "caseSla": "A String", # The SLA of the finding's corresponding case in the external system. - "caseUri": "A String", # The link to the finding's corresponding case in the external system. - "externalSystemUpdateTime": "A String", # The time when the case was last updated, as reported by the external system. - "externalUid": "A String", # The identifier that's used to track the finding's corresponding case in the external system. - "name": "A String", # Full resource name of the external system, for example: "organizations/1234/sources/5678/findings/123456/externalSystems/jira", "folders/1234/sources/5678/findings/123456/externalSystems/jira", "projects/1234/sources/5678/findings/123456/externalSystems/jira" - "status": "A String", # The most recent status of the finding's corresponding case, as reported by the external system. - "ticketInfo": { # Information about the ticket, if any, that is being used to track the resolution of the issue that is identified by this finding. # Information about the ticket, if any, that is being used to track the resolution of the issue that is identified by this finding. - "assignee": "A String", # The assignee of the ticket in the ticket system. - "description": "A String", # The description of the ticket in the ticket system. - "id": "A String", # The identifier of the ticket in the ticket system. - "status": "A String", # The latest status of the ticket, as reported by the ticket system. - "updateTime": "A String", # The time when the ticket was last updated, as reported by the ticket system. - "uri": "A String", # The link to the ticket in the ticket system. + "caseCloseTime": "A String", + "caseCreateTime": "A String", + "casePriority": "A String", + "caseSla": "A String", + "caseUri": "A String", + "externalSystemUpdateTime": "A String", + "externalUid": "A String", + "name": "A String", + "status": "A String", + "ticketInfo": { + "assignee": "A String", + "description": "A String", + "id": "A String", + "status": "A String", + "updateTime": "A String", + "uri": "A String", }, }
diff --git a/docs/dyn/securitycenter_v1.organizations.sources.findings.html b/docs/dyn/securitycenter_v1.organizations.sources.findings.html index 5aaa2697c0..84ed32e42a 100644 --- a/docs/dyn/securitycenter_v1.organizations.sources.findings.html +++ b/docs/dyn/securitycenter_v1.organizations.sources.findings.html @@ -84,31 +84,31 @@

Instance Methods

Close httplib2 connections.

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

-

Creates a finding. The corresponding source must exist for finding creation to succeed.

+

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

-

Filters an organization or source's findings and groups them by their specified properties. To group across all sources provide a `-` as the source id. Example: /v1/organizations/{organization_id}/sources/-/findings, /v1/folders/{folder_id}/sources/-/findings, /v1/projects/{project_id}/sources/-/findings

+

group_next()

Retrieves the next page of results.

list(parent, compareDuration=None, fieldMask=None, filter=None, orderBy=None, pageSize=None, pageToken=None, readTime=None, x__xgafv=None)

-

Lists an organization or source's findings. To list across all sources provide a `-` as the source id. Example: /v1/organizations/{organization_id}/sources/-/findings

+

list_next()

Retrieves the next page of results.

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

-

Creates or updates a finding. The corresponding source must exist for a finding creation to succeed.

+

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

-

Updates the mute state of a finding.

+

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

-

Updates the state of a finding.

+

updateSecurityMarks(name, body=None, startTime=None, updateMask=None, x__xgafv=None)

-

Updates security marks.

+

Method Details

close() @@ -117,823 +117,823 @@

Method Details

create(parent, body=None, findingId=None, x__xgafv=None) -
Creates a finding. The corresponding source must exist for finding creation to succeed.
+  
 
 Args:
-  parent: string, Required. Resource name of the new finding's parent. Its format should be `organizations/[organization_id]/sources/[source_id]`. (required)
+  parent: string, A parameter (required)
   body: object, The request body.
     The object takes the form of:
 
-{ # Security Command Center finding. A finding is a record of assessment data like security, risk, health, or privacy, that is ingested into Security Command Center for presentation, notification, analysis, policy testing, and enforcement. For example, a cross-site scripting (XSS) vulnerability in an App Engine application is a finding.
-  "access": { # Represents an access event. # Access details associated with the finding, such as more information on the caller, which method was accessed, and from where.
-    "callerIp": "A String", # Caller's IP address, such as "1.1.1.1".
-    "callerIpGeo": { # Represents a geographical location for a given access. # The caller IP's geolocation, which identifies where the call came from.
-      "regionCode": "A String", # A CLDR.
-    },
-    "methodName": "A String", # The method that the service account called, e.g. "SetIamPolicy".
-    "principalEmail": "A String", # Associated email, such as "foo@google.com". The email address of the authenticated user or a service account acting on behalf of a 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).
-    "principalSubject": "A String", # A string that represents the principal_subject that is associated with the identity. Unlike `principal_email`, `principal_subject` supports principals that aren't associated with email addresses, such as third party principals. For most identities, the format is `principal://iam.googleapis.com/{identity pool name}/subject/{subject}`. Some GKE identities, such as GKE_WORKLOAD, FREEFORM, and GKE_HUB_WORKLOAD, still use the legacy format `serviceAccount:{identity pool name}[{subject}]`.
-    "serviceAccountDelegationInfo": [ # The identity delegation history of an authenticated service account that made the request. The `serviceAccountDelegationInfo[]` object contains information about the real authorities that try to access Google Cloud resources by delegating on a service account. When multiple authorities are present, they are guaranteed to be sorted based on the original ordering of the identity delegation events.
-      { # Identity delegation history of an authenticated service account.
-        "principalEmail": "A String", # The email address of a Google account.
-        "principalSubject": "A String", # A string representing the principal_subject associated with the identity. As compared to `principal_email`, supports principals that aren't associated with email addresses, such as third party principals. For most identities, the format will be `principal://iam.googleapis.com/{identity pool name}/subjects/{subject}` except for some GKE identities (GKE_WORKLOAD, FREEFORM, GKE_HUB_WORKLOAD) that are still in the legacy format `serviceAccount:{identity pool name}[{subject}]`
-      },
-    ],
-    "serviceAccountKeyName": "A String", # The name of the service account key that was used to create or exchange credentials when authenticating the service account that made the request. This is a scheme-less URI full resource name. For example: "//iam.googleapis.com/projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}/keys/{key}".
-    "serviceName": "A String", # This is the API service that the service account made a call to, e.g. "iam.googleapis.com"
-    "userAgent": "A String", # The caller's user agent string associated with the finding.
-    "userAgentFamily": "A String", # Type of user agent associated with the finding. For example, an operating system shell or an embedded or standalone application.
-    "userName": "A String", # A string that represents a username. The username provided depends on the type of the finding and is likely not an IAM principal. For example, this can be a system username if the finding is related to a virtual machine, or it can be an application login username.
-  },
-  "affectedResources": { # Details about resources affected by this finding. # AffectedResources associated with the finding.
-    "count": "A String", # The count of resources affected by the finding.
-  },
-  "agentDataAccessEvents": [ # Agent data access events associated with the finding.
-    { # Details about a data access attempt made by an agent principal not authorized under applicable data security policy.
-      "eventId": "A String", # Unique identifier for data access event.
-      "eventTime": "A String", # Timestamp of data access event.
-      "operation": "A String", # The operation performed by the principal to access the data.
-      "principalSubject": "A String", # The agent principal that accessed the data.
+{
+  "access": {
+    "callerIp": "A String",
+    "callerIpGeo": {
+      "regionCode": "A String",
+    },
+    "methodName": "A String",
+    "principalEmail": "A String",
+    "principalSubject": "A String",
+    "serviceAccountDelegationInfo": [
+      {
+        "principalEmail": "A String",
+        "principalSubject": "A String",
+      },
+    ],
+    "serviceAccountKeyName": "A String",
+    "serviceName": "A String",
+    "userAgent": "A String",
+    "userAgentFamily": "A String",
+    "userName": "A String",
+  },
+  "affectedResources": {
+    "count": "A String",
+  },
+  "agentDataAccessEvents": [
+    {
+      "eventId": "A String",
+      "eventTime": "A String",
+      "operation": "A String",
+      "principalSubject": "A String",
     },
   ],
-  "aiModel": { # Contains information about the AI model associated with the finding. # The AI model associated with the finding.
-    "deploymentPlatform": "A String", # The platform on which the model is deployed.
-    "displayName": "A String", # The user defined display name of model. Ex. baseline-classification-model
-    "domain": "A String", # The domain of the model, for example, “image-classification”.
-    "library": "A String", # The name of the model library, for example, “transformers”.
-    "location": "A String", # The region in which the model is used, for example, “us-central1”.
-    "name": "A String", # The name of the AI model, for example, "gemini:1.0.0".
-    "publisher": "A String", # The publisher of the model, for example, “google” or “nvidia”.
-    "usageCategory": "A String", # The purpose of the model, for example, "Inteference" or "Training".
-  },
-  "application": { # Represents an application associated with a finding. # Represents an application associated with the finding.
-    "baseUri": "A String", # The base URI that identifies the network location of the application in which the vulnerability was detected. For example, `http://example.com`.
-    "fullUri": "A String", # The full URI with payload that can be used to reproduce the vulnerability. For example, `http://example.com?p=aMmYgI6H`.
-  },
-  "artifactGuardPolicies": { # Represents the result of evaluating artifact guard policies. # ArtifactGuardPolicies associated with the finding.
-    "failingPolicies": [ # A list of failing policies.
-      { # Represents an artifact guard policy.
-        "failureReason": "A String", # The reason for the policy failure, for example, "severity=HIGH AND max_vuln_count=2".
-        "policyId": "A String", # The ID of the failing policy, for example, "organizations/3392779/locations/global/policies/prod-policy".
-        "type": "A String", # The type of the policy evaluation.
-      },
-    ],
-    "resourceId": "A String", # The ID of the resource that has policies configured for it.
-  },
-  "attackExposure": { # An attack exposure contains the results of an attack path simulation run. # The results of an attack path simulation relevant to this finding.
-    "attackExposureResult": "A String", # The resource name of the attack path simulation result that contains the details regarding this attack exposure score. Example: `organizations/123/simulations/456/attackExposureResults/789`
-    "exposedHighValueResourcesCount": 42, # The number of high value resources that are exposed as a result of this finding.
-    "exposedLowValueResourcesCount": 42, # The number of high value resources that are exposed as a result of this finding.
-    "exposedMediumValueResourcesCount": 42, # The number of medium value resources that are exposed as a result of this finding.
-    "latestCalculationTime": "A String", # The most recent time the attack exposure was updated on this finding.
-    "score": 3.14, # A number between 0 (inclusive) and infinity that represents how important this finding is to remediate. The higher the score, the more important it is to remediate.
-    "state": "A String", # What state this AttackExposure is in. This captures whether or not an attack exposure has been calculated or not.
-  },
-  "backupDisasterRecovery": { # Information related to Google Cloud Backup and DR Service findings. # Fields related to Backup and DR findings.
-    "appliance": "A String", # The name of the Backup and DR appliance that captures, moves, and manages the lifecycle of backup data. For example, `backup-server-57137`.
-    "applications": [ # The names of Backup and DR applications. An application is a VM, database, or file system on a managed host monitored by a backup and recovery appliance. For example, `centos7-01-vol00`, `centos7-01-vol01`, `centos7-01-vol02`.
+  "aiModel": {
+    "deploymentPlatform": "A String",
+    "displayName": "A String",
+    "domain": "A String",
+    "library": "A String",
+    "location": "A String",
+    "name": "A String",
+    "publisher": "A String",
+    "usageCategory": "A String",
+  },
+  "application": {
+    "baseUri": "A String",
+    "fullUri": "A String",
+  },
+  "artifactGuardPolicies": {
+    "failingPolicies": [
+      {
+        "failureReason": "A String",
+        "policyId": "A String",
+        "type": "A String",
+      },
+    ],
+    "resourceId": "A String",
+  },
+  "attackExposure": {
+    "attackExposureResult": "A String",
+    "exposedHighValueResourcesCount": 42,
+    "exposedLowValueResourcesCount": 42,
+    "exposedMediumValueResourcesCount": 42,
+    "latestCalculationTime": "A String",
+    "score": 3.14,
+    "state": "A String",
+  },
+  "backupDisasterRecovery": {
+    "appliance": "A String",
+    "applications": [
       "A String",
     ],
-    "backupCreateTime": "A String", # The timestamp at which the Backup and DR backup was created.
-    "backupTemplate": "A String", # The name of a Backup and DR template which comprises one or more backup policies. See the [Backup and DR documentation](https://cloud.google.com/backup-disaster-recovery/docs/concepts/backup-plan#temp) for more information. For example, `snap-ov`.
-    "backupType": "A String", # The backup type of the Backup and DR image. For example, `Snapshot`, `Remote Snapshot`, `OnVault`.
-    "host": "A String", # The name of a Backup and DR host, which is managed by the backup and recovery appliance and known to the management console. The host can be of type Generic (for example, Compute Engine, SQL Server, Oracle DB, SMB file system, etc.), vCenter, or an ESX server. See the [Backup and DR documentation on hosts](https://cloud.google.com/backup-disaster-recovery/docs/configuration/manage-hosts-and-their-applications) for more information. For example, `centos7-01`.
-    "policies": [ # The names of Backup and DR policies that are associated with a template and that define when to run a backup, how frequently to run a backup, and how long to retain the backup image. For example, `onvaults`.
+    "backupCreateTime": "A String",
+    "backupTemplate": "A String",
+    "backupType": "A String",
+    "host": "A String",
+    "policies": [
       "A String",
     ],
-    "policyOptions": [ # The names of Backup and DR advanced policy options of a policy applying to an application. See the [Backup and DR documentation on policy options](https://cloud.google.com/backup-disaster-recovery/docs/create-plan/policy-settings). For example, `skipofflineappsincongrp, nounmap`.
+    "policyOptions": [
       "A String",
     ],
-    "profile": "A String", # The name of the Backup and DR resource profile that specifies the storage media for backups of application and VM data. See the [Backup and DR documentation on profiles](https://cloud.google.com/backup-disaster-recovery/docs/concepts/backup-plan#profile). For example, `GCP`.
-    "storagePool": "A String", # The name of the Backup and DR storage pool that the backup and recovery appliance is storing data in. The storage pool could be of type Cloud, Primary, Snapshot, or OnVault. See the [Backup and DR documentation on storage pools](https://cloud.google.com/backup-disaster-recovery/docs/concepts/storage-pools). For example, `DiskPoolOne`.
+    "profile": "A String",
+    "storagePool": "A String",
   },
-  "canonicalName": "A String", # The canonical name of the finding. It's either "organizations/{organization_id}/sources/{source_id}/findings/{finding_id}", "folders/{folder_id}/sources/{source_id}/findings/{finding_id}" or "projects/{project_number}/sources/{source_id}/findings/{finding_id}", depending on the closest CRM ancestor of the resource associated with the finding.
-  "category": "A String", # The additional taxonomy group within findings from a given source. This field is immutable after creation time. Example: "XSS_FLASH_INJECTION"
-  "chokepoint": { # Contains details about a chokepoint, which is a resource or resource group where high-risk attack paths converge, based on [attack path simulations] (https://cloud.google.com/security-command-center/docs/attack-exposure-learn#attack_path_simulations). # Contains details about a chokepoint, which is a resource or resource group where high-risk attack paths converge, based on [attack path simulations] (https://cloud.google.com/security-command-center/docs/attack-exposure-learn#attack_path_simulations). This field cannot be updated. Its value is ignored in all update requests.
-    "relatedFindings": [ # List of resource names of findings associated with this chokepoint. For example, organizations/123/sources/456/findings/789. This list will have at most 100 findings.
+  "canonicalName": "A String",
+  "category": "A String",
+  "chokepoint": {
+    "relatedFindings": [
       "A String",
     ],
   },
-  "cloudArmor": { # Fields related to Google Cloud Armor findings. # Fields related to Cloud Armor findings.
-    "adaptiveProtection": { # Information about [Google Cloud Armor Adaptive Protection](https://cloud.google.com/armor/docs/cloud-armor-overview#google-cloud-armor-adaptive-protection). # Information about potential Layer 7 DDoS attacks identified by [Google Cloud Armor Adaptive Protection](https://cloud.google.com/armor/docs/adaptive-protection-overview).
-      "confidence": 3.14, # A score of 0 means that there is low confidence that the detected event is an actual attack. A score of 1 means that there is high confidence that the detected event is an attack. See the [Adaptive Protection documentation](https://cloud.google.com/armor/docs/adaptive-protection-overview#configure-alert-tuning) for further explanation.
-    },
-    "attack": { # Information about DDoS attack volume and classification. # Information about DDoS attack volume and classification.
-      "classification": "A String", # Type of attack, for example, 'SYN-flood', 'NTP-udp', or 'CHARGEN-udp'.
-      "volumeBps": 42, # Total BPS (bytes per second) volume of attack. Deprecated - refer to volume_bps_long instead.
-      "volumeBpsLong": "A String", # Total BPS (bytes per second) volume of attack.
-      "volumePps": 42, # Total PPS (packets per second) volume of attack. Deprecated - refer to volume_pps_long instead.
-      "volumePpsLong": "A String", # Total PPS (packets per second) volume of attack.
-    },
-    "duration": "A String", # Duration of attack from the start until the current moment (updated every 5 minutes).
-    "requests": { # Information about the requests relevant to the finding. # Information about incoming requests evaluated by [Google Cloud Armor security policies](https://cloud.google.com/armor/docs/security-policy-overview).
-      "longTermAllowed": 42, # Allowed RPS (requests per second) over the long term.
-      "longTermDenied": 42, # Denied RPS (requests per second) over the long term.
-      "ratio": 3.14, # For 'Increasing deny ratio', the ratio is the denied traffic divided by the allowed traffic. For 'Allowed traffic spike', the ratio is the allowed traffic in the short term divided by allowed traffic in the long term.
-      "shortTermAllowed": 42, # Allowed RPS (requests per second) in the short term.
-    },
-    "securityPolicy": { # Information about the [Google Cloud Armor security policy](https://cloud.google.com/armor/docs/security-policy-overview) relevant to the finding. # Information about the [Google Cloud Armor security policy](https://cloud.google.com/armor/docs/security-policy-overview) relevant to the finding.
-      "name": "A String", # The name of the Google Cloud Armor security policy, for example, "my-security-policy".
-      "preview": True or False, # Whether or not the associated rule or policy is in preview mode.
-      "type": "A String", # The type of Google Cloud Armor security policy for example, 'backend security policy', 'edge security policy', 'network edge security policy', or 'always-on DDoS protection'.
-    },
-    "threatVector": "A String", # Distinguish between volumetric & protocol DDoS attack and application layer attacks. For example, "L3_4" for Layer 3 and Layer 4 DDoS attacks, or "L_7" for Layer 7 DDoS attacks.
-  },
-  "cloudDlpDataProfile": { # The [data profile](https://cloud.google.com/dlp/docs/data-profiles) associated with the finding. # Cloud DLP data profile that is associated with the finding.
-    "dataProfile": "A String", # Name of the data profile, for example, `projects/123/locations/europe/tableProfiles/8383929`.
-    "infoTypes": [ # Type of information detected by SDP. Info type includes name, version and sensitivity of the detected information type.
-      { # Type of information detected by the API.
-        "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`.
-        "sensitivityScore": { # Score is calculated from of all elements in the data profile. A higher level means the data is more sensitive. # Optional custom sensitivity for this InfoType. This only applies to data profiling.
-          "score": "A String", # The sensitivity score applied to the resource.
+  "cloudArmor": {
+    "adaptiveProtection": {
+      "confidence": 3.14,
+    },
+    "attack": {
+      "classification": "A String",
+      "volumeBps": 42,
+      "volumeBpsLong": "A String",
+      "volumePps": 42,
+      "volumePpsLong": "A String",
+    },
+    "duration": "A String",
+    "requests": {
+      "longTermAllowed": 42,
+      "longTermDenied": 42,
+      "ratio": 3.14,
+      "shortTermAllowed": 42,
+    },
+    "securityPolicy": {
+      "name": "A String",
+      "preview": True or False,
+      "type": "A String",
+    },
+    "threatVector": "A String",
+  },
+  "cloudDlpDataProfile": {
+    "dataProfile": "A String",
+    "infoTypes": [
+      {
+        "name": "A String",
+        "sensitivityScore": {
+          "score": "A String",
         },
-        "version": "A String", # Optional version name for this InfoType.
+        "version": "A String",
       },
     ],
-    "parentType": "A String", # The resource hierarchy level at which the data profile was generated.
+    "parentType": "A String",
   },
-  "cloudDlpInspection": { # Details about the Cloud Data Loss Prevention (Cloud DLP) [inspection job](https://cloud.google.com/dlp/docs/concepts-job-triggers) that produced the finding. # Cloud Data Loss Prevention (Cloud DLP) inspection results that are associated with the finding.
-    "fullScan": True or False, # Whether Cloud DLP scanned the complete resource or a sampled subset.
-    "infoType": "A String", # The type of information (or *[infoType](https://cloud.google.com/dlp/docs/infotypes-reference)*) found, for example, `EMAIL_ADDRESS` or `STREET_ADDRESS`.
-    "infoTypeCount": "A String", # The number of times Cloud DLP found this infoType within this job and resource.
-    "inspectJob": "A String", # Name of the inspection job, for example, `projects/123/locations/europe/dlpJobs/i-8383929`.
+  "cloudDlpInspection": {
+    "fullScan": True or False,
+    "infoType": "A String",
+    "infoTypeCount": "A String",
+    "inspectJob": "A String",
   },
-  "complianceDetails": { # Compliance Details associated with the finding. # Details about the compliance implications of the finding.
-    "cloudControl": { # CloudControl associated with the finding. # CloudControl associated with the finding
-      "cloudControlName": "A String", # Name of the CloudControl associated with the finding.
-      "policyType": "A String", # Policy type of the CloudControl
-      "type": "A String", # Type of cloud control.
-      "version": 42, # Version of the Cloud Control
+  "complianceDetails": {
+    "cloudControl": {
+      "cloudControlName": "A String",
+      "policyType": "A String",
+      "type": "A String",
+      "version": 42,
     },
-    "cloudControlDeploymentNames": [ # Cloud Control Deployments associated with the finding. For example, organizations/123/locations/global/cloudControlDeployments/deploymentIdentifier
+    "cloudControlDeploymentNames": [
       "A String",
     ],
-    "frameworks": [ # Details of Frameworks associated with the finding
-      { # Compliance framework associated with the finding.
-        "category": [ # Category of the framework associated with the finding. E.g. Security Benchmark, or Assured Workloads
+    "frameworks": [
+      {
+        "category": [
           "A String",
         ],
-        "controls": [ # The controls associated with the framework.
-          { # Compliance control associated with the finding.
-            "controlName": "A String", # Name of the Control
-            "displayName": "A String", # Display name of the control. For example, AU-02.
+        "controls": [
+          {
+            "controlName": "A String",
+            "displayName": "A String",
           },
         ],
-        "displayName": "A String", # Display name of the framework. For a standard framework, this will look like e.g. PCI DSS 3.2.1, whereas for a custom framework it can be a user defined string like MyFramework
-        "name": "A String", # Name of the framework associated with the finding
-        "type": "A String", # Type of the framework associated with the finding, to specify whether the framework is built-in (pre-defined and immutable) or a custom framework defined by the customer (equivalent to security posture)
+        "displayName": "A String",
+        "name": "A String",
+        "type": "A String",
       },
     ],
   },
-  "compliances": [ # Contains compliance information for security standards associated to the finding.
-    { # Contains compliance information about a security standard indicating unmet recommendations.
-      "ids": [ # Policies within the standard or benchmark, for example, A.12.4.1
+  "compliances": [
+    {
+      "ids": [
         "A String",
       ],
-      "standard": "A String", # Industry-wide compliance standards or benchmarks, such as CIS, PCI, and OWASP.
-      "version": "A String", # Version of the standard or benchmark, for example, 1.1
+      "standard": "A String",
+      "version": "A String",
     },
   ],
-  "connections": [ # Contains information about the IP connection associated with the finding.
-    { # Contains information about the IP connection associated with the finding.
-      "destinationIp": "A String", # Destination IP address. Not present for sockets that are listening and not connected.
-      "destinationPort": 42, # Destination port. Not present for sockets that are listening and not connected.
-      "protocol": "A String", # IANA Internet Protocol Number such as TCP(6) and UDP(17).
-      "sourceIp": "A String", # Source IP address.
-      "sourcePort": 42, # Source port.
+  "connections": [
+    {
+      "destinationIp": "A String",
+      "destinationPort": 42,
+      "protocol": "A String",
+      "sourceIp": "A String",
+      "sourcePort": 42,
     },
   ],
-  "contacts": { # Output only. Map containing the points of contact for the given finding. The key represents the type of contact, while the value contains a list of all the contacts that pertain. Please refer to: https://cloud.google.com/resource-manager/docs/managing-notification-contacts#notification-categories { "security": { "contacts": [ { "email": "person1@company.com" }, { "email": "person2@company.com" } ] } }
-    "a_key": { # Details about specific contacts
-      "contacts": [ # A list of contacts
-        { # The email address of a contact.
-          "email": "A String", # An email address. For example, "`person123@company.com`".
+  "contacts": {
+    "a_key": {
+      "contacts": [
+        {
+          "email": "A String",
         },
       ],
     },
   },
-  "containers": [ # Containers associated with the finding. This field provides information for both Kubernetes and non-Kubernetes containers.
-    { # Container associated with the finding.
-      "createTime": "A String", # The time that the container was created.
-      "imageId": "A String", # Optional container image ID, if provided by the container runtime. Uniquely identifies the container image launched using a container image digest.
-      "labels": [ # Container labels, as provided by the container runtime.
-        { # Represents a generic name-value label. A label has separate name and value fields to support filtering with the `contains()` function. For more information, see [Filtering on array-type fields](https://cloud.google.com/security-command-center/docs/how-to-api-list-findings#array-contains-filtering).
-          "name": "A String", # Name of the label.
-          "value": "A String", # Value that corresponds to the label's name.
+  "containers": [
+    {
+      "createTime": "A String",
+      "imageId": "A String",
+      "labels": [
+        {
+          "name": "A String",
+          "value": "A String",
         },
       ],
-      "name": "A String", # Name of the container.
-      "uri": "A String", # Container image URI provided when configuring a pod or container. This string can identify a container image version using mutable tags.
+      "name": "A String",
+      "uri": "A String",
     },
   ],
-  "createTime": "A String", # The time at which the finding was created in Security Command Center.
-  "dataAccessEvents": [ # Data access events associated with the finding.
-    { # Details about a data access attempt made by a principal not authorized under applicable data security policy.
-      "eventId": "A String", # Unique identifier for data access event.
-      "eventTime": "A String", # Timestamp of data access event.
-      "operation": "A String", # The operation performed by the principal to access the data.
-      "principalEmail": "A String", # The email address of the principal that accessed the data. The principal could be a user account, service account, Google group, or other.
+  "createTime": "A String",
+  "dataAccessEvents": [
+    {
+      "eventId": "A String",
+      "eventTime": "A String",
+      "operation": "A String",
+      "principalEmail": "A String",
     },
   ],
-  "dataFlowEvents": [ # Data flow events associated with the finding.
-    { # Details about a data flow event, in which either the data is moved to or is accessed from a non-compliant geo-location, as defined in the applicable data security policy.
-      "eventId": "A String", # Unique identifier for data flow event.
-      "eventTime": "A String", # Timestamp of data flow event.
-      "operation": "A String", # The operation performed by the principal for the data flow event.
-      "principalEmail": "A String", # The email address of the principal that initiated the data flow event. The principal could be a user account, service account, Google group, or other.
-      "violatedLocation": "A String", # Non-compliant location of the principal or the data destination.
+  "dataFlowEvents": [
+    {
+      "eventId": "A String",
+      "eventTime": "A String",
+      "operation": "A String",
+      "principalEmail": "A String",
+      "violatedLocation": "A String",
     },
   ],
-  "dataRetentionDeletionEvents": [ # Data retention deletion events associated with the finding.
-    { # Details about data retention deletion violations, in which the data is non-compliant based on their retention or deletion time, as defined in the applicable data security policy. The Data Retention Deletion (DRD) control is a control of the DSPM (Data Security Posture Management) suite that enables organizations to manage data retention and deletion policies in compliance with regulations, such as GDPR and CRPA. DRD supports two primary policy types: maximum storage length (max TTL) and minimum storage length (min TTL). Both are aimed at helping organizations meet regulatory and data management commitments.
-      "dataObjectCount": "A String", # Number of objects that violated the policy for this resource. If the number is less than 1,000, then the value of this field is the exact number. If the number of objects that violated the policy is greater than or equal to 1,000, then the value of this field is 1000.
-      "eventDetectionTime": "A String", # Timestamp indicating when the event was detected.
-      "eventType": "A String", # Type of the DRD event.
-      "maxRetentionAllowed": "A String", # Maximum duration of retention allowed from the DRD control. This comes from the DRD control where users set a max TTL for their data. For example, suppose that a user sets the max TTL for a Cloud Storage bucket to 90 days. However, an object in that bucket is 100 days old. In this case, a DataRetentionDeletionEvent will be generated for that Cloud Storage bucket, and the max_retention_allowed is 90 days.
-      "minRetentionAllowed": "A String", # Min duration of retention allowed from the DSPM retention control. This field is only populated when event type is set to EVENT_TYPE_MIN_TTL_FROM_CREATION.
+  "dataRetentionDeletionEvents": [
+    {
+      "dataObjectCount": "A String",
+      "eventDetectionTime": "A String",
+      "eventType": "A String",
+      "maxRetentionAllowed": "A String",
+      "minRetentionAllowed": "A String",
     },
   ],
-  "database": { # Represents database access information, such as queries. A database may be a sub-resource of an instance (as in the case of Cloud SQL instances or Cloud Spanner instances), or the database instance itself. Some database resources might not have the [full resource name](https://google.aip.dev/122#full-resource-names) populated because these resource types, such as Cloud SQL databases, are not yet supported by Cloud Asset Inventory. In these cases only the display name is provided. # Database associated with the finding.
-    "displayName": "A String", # The human-readable name of the database that the user connected to.
-    "grantees": [ # The target usernames, roles, or groups of an SQL privilege grant, which is not an IAM policy change.
+  "database": {
+    "displayName": "A String",
+    "grantees": [
       "A String",
     ],
-    "name": "A String", # Some database resources may not have the [full resource name](https://google.aip.dev/122#full-resource-names) populated because these resource types are not yet supported by Cloud Asset Inventory (e.g. Cloud SQL databases). In these cases only the display name will be provided. The [full resource name](https://google.aip.dev/122#full-resource-names) of the database that the user connected to, if it is supported by Cloud Asset Inventory.
-    "query": "A String", # The SQL statement that is associated with the database access.
-    "userName": "A String", # The username used to connect to the database. The username might not be an IAM principal and does not have a set format.
-    "version": "A String", # The version of the database, for example, POSTGRES_14. See [the complete list](https://cloud.google.com/sql/docs/mysql/admin-api/rest/v1/SqlDatabaseVersion).
-  },
-  "description": "A String", # Contains more details about the finding.
-  "discoveredWorkload": { # Represents discovered, customer managed workload that is not registered with the respective GCP service. # DiscoveredWorkload associated with the finding.
-    "confidence": "A String", # The confidence in detection of this workload.
-    "detectedRelevantHardware": True or False, # A boolean flag set to true if associated hardware strongly predicts the workload type.
-    "detectedRelevantKeywords": True or False, # A boolean flag set to true if associated keywords strongly predict the workload type.
-    "detectedRelevantPackages": True or False, # A boolean flag set to true if installed packages strongly predict the workload type.
-    "workloadType": "A String", # The type of workload.
-  },
-  "disk": { # Contains information about the disk associated with the finding. # Disk associated with the finding.
-    "name": "A String", # The name of the disk, for example, "https://www.googleapis.com/compute/v1/projects/{project-id}/zones/{zone-id}/disks/{disk-id}".
-  },
-  "eventTime": "A String", # The time the finding was first detected. If an existing finding is updated, then this is the time the update occurred. For example, if the finding represents an open firewall, this property captures the time the detector believes the firewall became open. The accuracy is determined by the detector. If the finding is later resolved, then this time reflects when the finding was resolved. This must not be set to a value greater than the current timestamp.
-  "exfiltration": { # Exfiltration represents a data exfiltration attempt from one or more sources to one or more targets. The `sources` attribute lists the sources of the exfiltrated data. The `targets` attribute lists the destinations the data was copied to. # Represents exfiltrations associated with the finding.
-    "sources": [ # If there are multiple sources, then the data is considered "joined" between them. For instance, BigQuery can join multiple tables, and each table would be considered a source.
-      { # Resource where data was exfiltrated from or exfiltrated to.
-        "components": [ # Subcomponents of the asset that was exfiltrated, like URIs used during exfiltration, table names, databases, and filenames. For example, multiple tables might have been exfiltrated from the same Cloud SQL instance, or multiple files might have been exfiltrated from the same Cloud Storage bucket.
+    "name": "A String",
+    "query": "A String",
+    "userName": "A String",
+    "version": "A String",
+  },
+  "description": "A String",
+  "discoveredWorkload": {
+    "confidence": "A String",
+    "detectedRelevantHardware": True or False,
+    "detectedRelevantKeywords": True or False,
+    "detectedRelevantPackages": True or False,
+    "workloadType": "A String",
+  },
+  "disk": {
+    "name": "A String",
+  },
+  "eventTime": "A String",
+  "exfiltration": {
+    "sources": [
+      {
+        "components": [
           "A String",
         ],
-        "name": "A String", # The resource's [full resource name](https://cloud.google.com/apis/design/resource_names#full_resource_name).
+        "name": "A String",
       },
     ],
-    "targets": [ # If there are multiple targets, each target would get a complete copy of the "joined" source data.
-      { # Resource where data was exfiltrated from or exfiltrated to.
-        "components": [ # Subcomponents of the asset that was exfiltrated, like URIs used during exfiltration, table names, databases, and filenames. For example, multiple tables might have been exfiltrated from the same Cloud SQL instance, or multiple files might have been exfiltrated from the same Cloud Storage bucket.
+    "targets": [
+      {
+        "components": [
           "A String",
         ],
-        "name": "A String", # The resource's [full resource name](https://cloud.google.com/apis/design/resource_names#full_resource_name).
-      },
-    ],
-    "totalExfiltratedBytes": "A String", # Total exfiltrated bytes processed for the entire job.
-  },
-  "externalExposure": { # Details about the externally exposed resource associated with the finding. # External exposure associated with the finding.
-    "backendBucket": "A String", # The full resource name of the load balancer backend bucket, for example, "//compute.googleapis.com/projects/{project-id}/global/backendBuckets/{name}"
-    "backendService": "A String", # The full resource name of load balancer backend service, for example, "//compute.googleapis.com/projects/{project-id}/global/backendServices/{name}".
-    "exposedApplication": "A String", # The name and version of the exposed web application, for example, "Jenkins 2.184".
-    "exposedEndpoint": "A String", # The resource which is running the exposed service, for example, "//compute.googleapis.com/projects/{project-id}/zones/{zone}/instances/{instance}.”
-    "exposedService": "A String", # The name and version of the service, for example, "Jupyter Notebook 6.14.0".
-    "forwardingRule": "A String", # The full resource name of the forwarding rule, for example, "//compute.googleapis.com/projects/{project-id}/global/forwardingRules/{forwarding-rule-name}".
-    "hostnameUri": "A String", # Hostname of the exposed application, for example, "https://test-app.a.run.app/"
-    "httpResponse": [ # The http response returned by the web application.
-      { # The http response returned by the web application.
-        "path": "A String", # The http path for which response code was returned by web application, for example, "https://test-app.a.run.app/test".
-        "statusCode": "A String", # The http response code returned by the web application, for example, 200.
-      },
-    ],
-    "instanceGroup": "A String", # The full resource name of the instance group, for example, "//compute.googleapis.com/projects/{project-id}/global/instanceGroups/{name}".
-    "internalBackendService": "A String", # The full resource name of load balancer backend service in the internal project having resource exposed via PSC, for example, "//compute.googleapis.com/projects/{project-id}/global/backendServices/{name}".
-    "loadBalancerFirewallPolicy": "A String", # The full resource name of the load balancer firewall policy, for example, "//compute.googleapis.com/projects/{project-id}/global/firewallPolicies/{policy-name}".
-    "networkEndpointGroup": "A String", # The full resource name of the network endpoint group, for example, "//compute.googleapis.com/projects/{project-id}/global/networkEndpointGroups/{name}".
-    "networkIngressFirewallPolicy": "A String", # The full resource name of the network ingress firewall policy, for example, "//compute.googleapis.com/projects/{project-id}/global/firewallPolicies/{name}".
-    "privateIpAddress": "A String", # Private IP address of the exposed endpoint.
-    "privatePort": "A String", # Port number associated with private IP address.
-    "pscNetworkAttachment": "A String", # The full resource name of the PSC (Private Service Connect) network attachment that network interface controller is attached to, for example, "//compute.googleapis.com/projects/{project-id}/regions/{region}/networkAttachments/{name}"
-    "pscServiceAttachment": "A String", # The full resource name of the PSC (Private Service Connect) service attachment that the load balancer network endpoint group targets, for example, "//compute.googleapis.com/projects/{project-id}/regions/{region}/serviceAttachments/{name}"
-    "publicIpAddress": "A String", # Public IP address of the exposed endpoint.
-    "publicPort": "A String", # Public port number of the exposed endpoint.
-    "serviceFirewallPolicy": "A String", # The full resource name of the firewall policy of the exposed service, for example, "//compute.googleapis.com/projects/{project-id}/global/firewallPolicies/{policy-name}".
-  },
-  "externalSystems": { # Output only. Third party SIEM/SOAR fields within SCC, contains external system information and external system finding fields.
-    "a_key": { # Representation of third party SIEM/SOAR fields within SCC.
-      "assignees": [ # References primary/secondary etc assignees in the external system.
+        "name": "A String",
+      },
+    ],
+    "totalExfiltratedBytes": "A String",
+  },
+  "externalExposure": {
+    "backendBucket": "A String",
+    "backendService": "A String",
+    "exposedApplication": "A String",
+    "exposedEndpoint": "A String",
+    "exposedService": "A String",
+    "forwardingRule": "A String",
+    "hostnameUri": "A String",
+    "httpResponse": [
+      {
+        "path": "A String",
+        "statusCode": "A String",
+      },
+    ],
+    "instanceGroup": "A String",
+    "internalBackendService": "A String",
+    "loadBalancerFirewallPolicy": "A String",
+    "networkEndpointGroup": "A String",
+    "networkIngressFirewallPolicy": "A String",
+    "privateIpAddress": "A String",
+    "privatePort": "A String",
+    "pscNetworkAttachment": "A String",
+    "pscServiceAttachment": "A String",
+    "publicIpAddress": "A String",
+    "publicPort": "A String",
+    "serviceFirewallPolicy": "A String",
+  },
+  "externalSystems": {
+    "a_key": {
+      "assignees": [
         "A String",
       ],
-      "caseCloseTime": "A String", # The time when the case was closed, as reported by the external system.
-      "caseCreateTime": "A String", # The time when the case was created, as reported by the external system.
-      "casePriority": "A String", # The priority of the finding's corresponding case in the external system.
-      "caseSla": "A String", # The SLA of the finding's corresponding case in the external system.
-      "caseUri": "A String", # The link to the finding's corresponding case in the external system.
-      "externalSystemUpdateTime": "A String", # The time when the case was last updated, as reported by the external system.
-      "externalUid": "A String", # The identifier that's used to track the finding's corresponding case in the external system.
-      "name": "A String", # Full resource name of the external system, for example: "organizations/1234/sources/5678/findings/123456/externalSystems/jira", "folders/1234/sources/5678/findings/123456/externalSystems/jira", "projects/1234/sources/5678/findings/123456/externalSystems/jira"
-      "status": "A String", # The most recent status of the finding's corresponding case, as reported by the external system.
-      "ticketInfo": { # Information about the ticket, if any, that is being used to track the resolution of the issue that is identified by this finding. # Information about the ticket, if any, that is being used to track the resolution of the issue that is identified by this finding.
-        "assignee": "A String", # The assignee of the ticket in the ticket system.
-        "description": "A String", # The description of the ticket in the ticket system.
-        "id": "A String", # The identifier of the ticket in the ticket system.
-        "status": "A String", # The latest status of the ticket, as reported by the ticket system.
-        "updateTime": "A String", # The time when the ticket was last updated, as reported by the ticket system.
-        "uri": "A String", # The link to the ticket in the ticket system.
-      },
-    },
-  },
-  "externalUri": "A String", # The URI that, if available, points to a web page outside of Security Command Center where additional information about the finding can be found. This field is guaranteed to be either empty or a well formed URL.
-  "files": [ # File associated with the finding.
-    { # File information about the related binary/library used by an executable, or the script used by a script interpreter
-      "contents": "A String", # Prefix of the file contents as a JSON-encoded string.
-      "diskPath": { # Path of the file in terms of underlying disk/partition identifiers. # Path of the file in terms of underlying disk/partition identifiers.
-        "partitionUuid": "A String", # UUID of the partition (format https://wiki.archlinux.org/title/persistent_block_device_naming#by-uuid)
-        "relativePath": "A String", # Relative path of the file in the partition as a JSON encoded string. Example: /home/user1/executable_file.sh
-      },
-      "fileLoadState": "A String", # The load state of the file.
-      "hashedSize": "A String", # The length in bytes of the file prefix that was hashed. If hashed_size == size, any hashes reported represent the entire file.
-      "operations": [ # Operation(s) performed on a file.
-        { # Operation(s) performed on a file.
-          "type": "A String", # The type of the operation
+      "caseCloseTime": "A String",
+      "caseCreateTime": "A String",
+      "casePriority": "A String",
+      "caseSla": "A String",
+      "caseUri": "A String",
+      "externalSystemUpdateTime": "A String",
+      "externalUid": "A String",
+      "name": "A String",
+      "status": "A String",
+      "ticketInfo": {
+        "assignee": "A String",
+        "description": "A String",
+        "id": "A String",
+        "status": "A String",
+        "updateTime": "A String",
+        "uri": "A String",
+      },
+    },
+  },
+  "externalUri": "A String",
+  "files": [
+    {
+      "contents": "A String",
+      "diskPath": {
+        "partitionUuid": "A String",
+        "relativePath": "A String",
+      },
+      "fileLoadState": "A String",
+      "hashedSize": "A String",
+      "operations": [
+        {
+          "type": "A String",
         },
       ],
-      "partiallyHashed": True or False, # True when the hash covers only a prefix of the file.
-      "path": "A String", # Absolute path of the file as a JSON encoded string.
-      "sha256": "A String", # SHA256 hash of the first hashed_size bytes of the file encoded as a hex string. If hashed_size == size, sha256 represents the SHA256 hash of the entire file.
-      "size": "A String", # Size of the file in bytes.
+      "partiallyHashed": True or False,
+      "path": "A String",
+      "sha256": "A String",
+      "size": "A String",
     },
   ],
-  "findingClass": "A String", # The class of the finding.
-  "groupMemberships": [ # Contains details about groups of which this finding is a member. A group is a collection of findings that are related in some way. This field cannot be updated. Its value is ignored in all update requests.
-    { # Contains details about groups of which this finding is a member. A group is a collection of findings that are related in some way.
-      "groupId": "A String", # ID of the group.
-      "groupType": "A String", # Type of group.
+  "findingClass": "A String",
+  "groupMemberships": [
+    {
+      "groupId": "A String",
+      "groupType": "A String",
     },
   ],
-  "iamBindings": [ # Represents IAM bindings associated with the finding.
-    { # Represents a particular IAM binding, which captures a member's role addition, removal, or state.
-      "action": "A String", # The action that was performed on a Binding.
-      "member": "A String", # A single identity requesting access for a Cloud Platform resource, for example, "foo@google.com".
-      "role": "A String", # Role that is assigned to "members". For example, "roles/viewer", "roles/editor", or "roles/owner".
+  "iamBindings": [
+    {
+      "action": "A String",
+      "member": "A String",
+      "role": "A String",
     },
   ],
-  "indicator": { # Represents what's commonly known as an _indicator of compromise_ (IoC) in computer forensics. This is an artifact observed on a network or in an operating system that, with high confidence, indicates a computer intrusion. For more information, see [Indicator of compromise](https://en.wikipedia.org/wiki/Indicator_of_compromise). # Represents what's commonly known as an *indicator of compromise* (IoC) in computer forensics. This is an artifact observed on a network or in an operating system that, with high confidence, indicates a computer intrusion. For more information, see [Indicator of compromise](https://en.wikipedia.org/wiki/Indicator_of_compromise).
-    "domains": [ # List of domains associated to the Finding.
+  "indicator": {
+    "domains": [
       "A String",
     ],
-    "ipAddresses": [ # The list of IP addresses that are associated with the finding.
+    "ipAddresses": [
       "A String",
     ],
-    "signatures": [ # The list of matched signatures indicating that the given process is present in the environment.
-      { # Indicates what signature matched this process.
-        "memoryHashSignature": { # A signature corresponding to memory page hashes. # Signature indicating that a binary family was matched.
-          "binaryFamily": "A String", # The binary family.
-          "detections": [ # The list of memory hash detections contributing to the binary family match.
-            { # Memory hash detection contributing to the binary family match.
-              "binary": "A String", # The name of the binary associated with the memory hash signature detection.
-              "percentPagesMatched": 3.14, # The percentage of memory page hashes in the signature that were matched.
+    "signatures": [
+      {
+        "memoryHashSignature": {
+          "binaryFamily": "A String",
+          "detections": [
+            {
+              "binary": "A String",
+              "percentPagesMatched": 3.14,
             },
           ],
         },
-        "signatureType": "A String", # Describes the type of resource associated with the signature.
-        "yaraRuleSignature": { # A signature corresponding to a YARA rule. # Signature indicating that a YARA rule was matched.
-          "yaraRule": "A String", # The name of the YARA rule.
+        "signatureType": "A String",
+        "yaraRuleSignature": {
+          "yaraRule": "A String",
         },
       },
     ],
-    "uris": [ # The list of URIs associated to the Findings.
+    "uris": [
       "A String",
     ],
   },
-  "ipRules": { # IP rules associated with the finding. # IP rules associated with the finding.
-    "allowed": { # Allowed IP rule. # Tuple with allowed rules.
-      "ipRules": [ # Optional. Optional list of allowed IP rules.
-        { # IP rule information.
-          "portRanges": [ # Optional. An optional list of ports to which this rule applies. This field is only applicable for the UDP or (S)TCP protocols. Each entry must be either an integer or a range including a min and max port number.
-            { # A port range which is inclusive of the min and max values. Values are between 0 and 2^16-1. The max can be equal / must be not smaller than the min value. If min and max are equal this indicates that it is a single port.
-              "max": "A String", # Maximum port value.
-              "min": "A String", # Minimum port value.
+  "ipRules": {
+    "allowed": {
+      "ipRules": [
+        {
+          "portRanges": [
+            {
+              "max": "A String",
+              "min": "A String",
             },
           ],
-          "protocol": "A String", # The IP protocol this rule applies to. This value can either be one of the following well known protocol strings (TCP, UDP, ICMP, ESP, AH, IPIP, SCTP) or a string representation of the integer value.
+          "protocol": "A String",
         },
       ],
     },
-    "denied": { # Denied IP rule. # Tuple with denied rules.
-      "ipRules": [ # Optional. Optional list of denied IP rules.
-        { # IP rule information.
-          "portRanges": [ # Optional. An optional list of ports to which this rule applies. This field is only applicable for the UDP or (S)TCP protocols. Each entry must be either an integer or a range including a min and max port number.
-            { # A port range which is inclusive of the min and max values. Values are between 0 and 2^16-1. The max can be equal / must be not smaller than the min value. If min and max are equal this indicates that it is a single port.
-              "max": "A String", # Maximum port value.
-              "min": "A String", # Minimum port value.
+    "denied": {
+      "ipRules": [
+        {
+          "portRanges": [
+            {
+              "max": "A String",
+              "min": "A String",
             },
           ],
-          "protocol": "A String", # The IP protocol this rule applies to. This value can either be one of the following well known protocol strings (TCP, UDP, ICMP, ESP, AH, IPIP, SCTP) or a string representation of the integer value.
+          "protocol": "A String",
         },
       ],
     },
-    "destinationIpRanges": [ # If destination IP ranges are specified, the firewall rule applies only to traffic that has a destination IP address in these ranges. These ranges must be expressed in CIDR format. Only supports IPv4.
+    "destinationIpRanges": [
       "A String",
     ],
-    "direction": "A String", # The direction that the rule is applicable to, one of ingress or egress.
-    "exposedServices": [ # Name of the network protocol service, such as FTP, that is exposed by the open port. Follows the naming convention available at: https://www.iana.org/assignments/service-names-port-numbers/service-names-port-numbers.xhtml.
+    "direction": "A String",
+    "exposedServices": [
       "A String",
     ],
-    "sourceIpRanges": [ # If source IP ranges are specified, the firewall rule applies only to traffic that has a source IP address in these ranges. These ranges must be expressed in CIDR format. Only supports IPv4.
+    "sourceIpRanges": [
       "A String",
     ],
   },
-  "job": { # Describes a job # Job associated with the finding.
-    "errorCode": 42, # Optional. If the job did not complete successfully, this field describes why.
-    "location": "A String", # Optional. Gives the location where the job ran, such as `US` or `europe-west1`
-    "name": "A String", # The fully-qualified name for a job. e.g. `projects//jobs/`
-    "state": "A String", # Output only. State of the job, such as `RUNNING` or `PENDING`.
-  },
-  "kernelRootkit": { # Kernel mode rootkit signatures. # Signature of the kernel rootkit.
-    "name": "A String", # Rootkit name, when available.
-    "unexpectedCodeModification": True or False, # True if unexpected modifications of kernel code memory are present.
-    "unexpectedFtraceHandler": True or False, # True if `ftrace` points are present with callbacks pointing to regions that are not in the expected kernel or module code range.
-    "unexpectedInterruptHandler": True or False, # True if interrupt handlers that are are not in the expected kernel or module code regions are present.
-    "unexpectedKernelCodePages": True or False, # True if kernel code pages that are not in the expected kernel or module code regions are present.
-    "unexpectedKprobeHandler": True or False, # True if `kprobe` points are present with callbacks pointing to regions that are not in the expected kernel or module code range.
-    "unexpectedProcessesInRunqueue": True or False, # True if unexpected processes in the scheduler run queue are present. Such processes are in the run queue, but not in the process task list.
-    "unexpectedReadOnlyDataModification": True or False, # True if unexpected modifications of kernel read-only data memory are present.
-    "unexpectedSystemCallHandler": True or False, # True if system call handlers that are are not in the expected kernel or module code regions are present.
-  },
-  "kubernetes": { # Kubernetes-related attributes. # Kubernetes resources associated with the finding.
-    "accessReviews": [ # Provides information on any Kubernetes access reviews (privilege checks) relevant to the finding.
-      { # Conveys information about a Kubernetes access review (such as one returned by a [`kubectl auth can-i`](https://kubernetes.io/docs/reference/access-authn-authz/authorization/#checking-api-access) command) that was involved in a finding.
-        "group": "A String", # The API group of the resource. "*" means all.
-        "name": "A String", # The name of the resource being requested. Empty means all.
-        "ns": "A String", # Namespace of the action being requested. Currently, there is no distinction between no namespace and all namespaces. Both are represented by "" (empty).
-        "resource": "A String", # The optional resource type requested. "*" means all.
-        "subresource": "A String", # The optional subresource type.
-        "verb": "A String", # A Kubernetes resource API verb, like get, list, watch, create, update, delete, proxy. "*" means all.
-        "version": "A String", # The API version of the resource. "*" means all.
-      },
-    ],
-    "bindings": [ # Provides Kubernetes role binding information for findings that involve [RoleBindings or ClusterRoleBindings](https://cloud.google.com/kubernetes-engine/docs/how-to/role-based-access-control).
-      { # Represents a Kubernetes RoleBinding or ClusterRoleBinding.
-        "name": "A String", # Name for the binding.
-        "ns": "A String", # Namespace for the binding.
-        "role": { # Kubernetes Role or ClusterRole. # The Role or ClusterRole referenced by the binding.
-          "kind": "A String", # Role type.
-          "name": "A String", # Role name.
-          "ns": "A String", # Role namespace.
+  "job": {
+    "errorCode": 42,
+    "location": "A String",
+    "name": "A String",
+    "state": "A String",
+  },
+  "kernelRootkit": {
+    "name": "A String",
+    "unexpectedCodeModification": True or False,
+    "unexpectedFtraceHandler": True or False,
+    "unexpectedInterruptHandler": True or False,
+    "unexpectedKernelCodePages": True or False,
+    "unexpectedKprobeHandler": True or False,
+    "unexpectedProcessesInRunqueue": True or False,
+    "unexpectedReadOnlyDataModification": True or False,
+    "unexpectedSystemCallHandler": True or False,
+  },
+  "kubernetes": {
+    "accessReviews": [
+      {
+        "group": "A String",
+        "name": "A String",
+        "ns": "A String",
+        "resource": "A String",
+        "subresource": "A String",
+        "verb": "A String",
+        "version": "A String",
+      },
+    ],
+    "bindings": [
+      {
+        "name": "A String",
+        "ns": "A String",
+        "role": {
+          "kind": "A String",
+          "name": "A String",
+          "ns": "A String",
         },
-        "subjects": [ # Represents one or more subjects that are bound to the role. Not always available for PATCH requests.
-          { # Represents a Kubernetes subject.
-            "kind": "A String", # Authentication type for the subject.
-            "name": "A String", # Name for the subject.
-            "ns": "A String", # Namespace for the subject.
+        "subjects": [
+          {
+            "kind": "A String",
+            "name": "A String",
+            "ns": "A String",
           },
         ],
       },
     ],
-    "nodePools": [ # GKE [node pools](https://cloud.google.com/kubernetes-engine/docs/concepts/node-pools) associated with the finding. This field contains node pool information for each node, when it is available.
-      { # Provides GKE node pool information.
-        "name": "A String", # Kubernetes node pool name.
-        "nodes": [ # Nodes associated with the finding.
-          { # Kubernetes nodes associated with the finding.
-            "name": "A String", # [Full resource name](https://google.aip.dev/122#full-resource-names) of the Compute Engine VM running the cluster node.
+    "nodePools": [
+      {
+        "name": "A String",
+        "nodes": [
+          {
+            "name": "A String",
           },
         ],
       },
     ],
-    "nodes": [ # Provides Kubernetes [node](https://cloud.google.com/kubernetes-engine/docs/concepts/cluster-architecture#nodes) information.
-      { # Kubernetes nodes associated with the finding.
-        "name": "A String", # [Full resource name](https://google.aip.dev/122#full-resource-names) of the Compute Engine VM running the cluster node.
+    "nodes": [
+      {
+        "name": "A String",
       },
     ],
-    "objects": [ # Kubernetes objects related to the finding.
-      { # Kubernetes object related to the finding, uniquely identified by GKNN. Used if the object Kind is not one of Pod, Node, NodePool, Binding, or AccessReview.
-        "containers": [ # Pod containers associated with this finding, if any.
-          { # Container associated with the finding.
-            "createTime": "A String", # The time that the container was created.
-            "imageId": "A String", # Optional container image ID, if provided by the container runtime. Uniquely identifies the container image launched using a container image digest.
-            "labels": [ # Container labels, as provided by the container runtime.
-              { # Represents a generic name-value label. A label has separate name and value fields to support filtering with the `contains()` function. For more information, see [Filtering on array-type fields](https://cloud.google.com/security-command-center/docs/how-to-api-list-findings#array-contains-filtering).
-                "name": "A String", # Name of the label.
-                "value": "A String", # Value that corresponds to the label's name.
+    "objects": [
+      {
+        "containers": [
+          {
+            "createTime": "A String",
+            "imageId": "A String",
+            "labels": [
+              {
+                "name": "A String",
+                "value": "A String",
               },
             ],
-            "name": "A String", # Name of the container.
-            "uri": "A String", # Container image URI provided when configuring a pod or container. This string can identify a container image version using mutable tags.
+            "name": "A String",
+            "uri": "A String",
           },
         ],
-        "group": "A String", # Kubernetes object group, such as "policy.k8s.io/v1".
-        "kind": "A String", # Kubernetes object kind, such as "Namespace".
-        "name": "A String", # Kubernetes object name. For details see https://kubernetes.io/docs/concepts/overview/working-with-objects/names/.
-        "ns": "A String", # Kubernetes object namespace. Must be a valid DNS label. Named "ns" to avoid collision with C++ namespace keyword. For details see https://kubernetes.io/docs/tasks/administer-cluster/namespaces/.
-      },
-    ],
-    "pods": [ # Kubernetes [Pods](https://cloud.google.com/kubernetes-engine/docs/concepts/pod) associated with the finding. This field contains Pod records for each container that is owned by a Pod.
-      { # A Kubernetes Pod.
-        "containers": [ # Pod containers associated with this finding, if any.
-          { # Container associated with the finding.
-            "createTime": "A String", # The time that the container was created.
-            "imageId": "A String", # Optional container image ID, if provided by the container runtime. Uniquely identifies the container image launched using a container image digest.
-            "labels": [ # Container labels, as provided by the container runtime.
-              { # Represents a generic name-value label. A label has separate name and value fields to support filtering with the `contains()` function. For more information, see [Filtering on array-type fields](https://cloud.google.com/security-command-center/docs/how-to-api-list-findings#array-contains-filtering).
-                "name": "A String", # Name of the label.
-                "value": "A String", # Value that corresponds to the label's name.
+        "group": "A String",
+        "kind": "A String",
+        "name": "A String",
+        "ns": "A String",
+      },
+    ],
+    "pods": [
+      {
+        "containers": [
+          {
+            "createTime": "A String",
+            "imageId": "A String",
+            "labels": [
+              {
+                "name": "A String",
+                "value": "A String",
               },
             ],
-            "name": "A String", # Name of the container.
-            "uri": "A String", # Container image URI provided when configuring a pod or container. This string can identify a container image version using mutable tags.
+            "name": "A String",
+            "uri": "A String",
           },
         ],
-        "labels": [ # Pod labels. For Kubernetes containers, these are applied to the container.
-          { # Represents a generic name-value label. A label has separate name and value fields to support filtering with the `contains()` function. For more information, see [Filtering on array-type fields](https://cloud.google.com/security-command-center/docs/how-to-api-list-findings#array-contains-filtering).
-            "name": "A String", # Name of the label.
-            "value": "A String", # Value that corresponds to the label's name.
+        "labels": [
+          {
+            "name": "A String",
+            "value": "A String",
           },
         ],
-        "name": "A String", # Kubernetes Pod name.
-        "ns": "A String", # Kubernetes Pod namespace.
+        "name": "A String",
+        "ns": "A String",
       },
     ],
-    "roles": [ # Provides Kubernetes role information for findings that involve [Roles or ClusterRoles](https://cloud.google.com/kubernetes-engine/docs/how-to/role-based-access-control).
-      { # Kubernetes Role or ClusterRole.
-        "kind": "A String", # Role type.
-        "name": "A String", # Role name.
-        "ns": "A String", # Role namespace.
+    "roles": [
+      {
+        "kind": "A String",
+        "name": "A String",
+        "ns": "A String",
       },
     ],
   },
-  "loadBalancers": [ # The load balancers associated with the finding.
-    { # Contains information related to the load balancer associated with the finding.
-      "name": "A String", # The name of the load balancer associated with the finding.
+  "loadBalancers": [
+    {
+      "name": "A String",
     },
   ],
-  "logEntries": [ # Log entries that are relevant to the finding.
-    { # An individual entry in a log.
-      "cloudLoggingEntry": { # Metadata taken from a [Cloud Logging LogEntry](https://cloud.google.com/logging/docs/reference/v2/rest/v2/LogEntry) # An individual entry in a log stored in Cloud Logging.
-        "insertId": "A String", # A unique identifier for the log entry.
-        "logId": "A String", # The type of the log (part of `log_name`. `log_name` is the resource name of the log to which this log entry belongs). For example: `cloudresourcemanager.googleapis.com/activity`. Note that this field is not URL-encoded, unlike the `LOG_ID` field in `LogEntry`.
-        "resourceContainer": "A String", # The organization, folder, or project of the monitored resource that produced this log entry.
-        "timestamp": "A String", # The time the event described by the log entry occurred.
+  "logEntries": [
+    {
+      "cloudLoggingEntry": {
+        "insertId": "A String",
+        "logId": "A String",
+        "resourceContainer": "A String",
+        "timestamp": "A String",
       },
     },
   ],
-  "mitreAttack": { # MITRE ATT&CK tactics and techniques related to this finding. See: https://attack.mitre.org # MITRE ATT&CK tactics and techniques related to this finding. See: https://attack.mitre.org
-    "additionalTactics": [ # Additional MITRE ATT&CK tactics related to this finding, if any.
+  "mitreAttack": {
+    "additionalTactics": [
       "A String",
     ],
-    "additionalTechniques": [ # Additional MITRE ATT&CK techniques related to this finding, if any, along with any of their respective parent techniques.
+    "additionalTechniques": [
       "A String",
     ],
-    "primaryTactic": "A String", # The MITRE ATT&CK tactic most closely represented by this finding, if any.
-    "primaryTechniques": [ # The MITRE ATT&CK technique most closely represented by this finding, if any. primary_techniques is a repeated field because there are multiple levels of MITRE ATT&CK techniques. If the technique most closely represented by this finding is a sub-technique (e.g. `SCANNING_IP_BLOCKS`), both the sub-technique and its parent technique(s) will be listed (e.g. `SCANNING_IP_BLOCKS`, `ACTIVE_SCANNING`).
+    "primaryTactic": "A String",
+    "primaryTechniques": [
       "A String",
     ],
-    "version": "A String", # The MITRE ATT&CK version referenced by the above fields. E.g. "8".
+    "version": "A String",
   },
-  "moduleName": "A String", # Unique identifier of the module which generated the finding. Example: folders/598186756061/securityHealthAnalyticsSettings/customModules/56799441161885
-  "mute": "A String", # Indicates the mute state of a finding (either muted, unmuted or undefined). Unlike other attributes of a finding, a finding provider shouldn't set the value of mute.
-  "muteInfo": { # Mute information about the finding, including whether the finding has a static mute or any matching dynamic mute rules. # Output only. The mute information regarding this finding.
-    "dynamicMuteRecords": [ # The list of dynamic mute rules that currently match the finding.
-      { # The record of a dynamic mute rule that matches the finding.
-        "matchTime": "A String", # When the dynamic mute rule first matched the finding.
-        "muteConfig": "A String", # The relative resource name of the mute rule, represented by a mute config, that created this record, for example `organizations/123/muteConfigs/mymuteconfig` or `organizations/123/locations/global/muteConfigs/mymuteconfig`.
+  "moduleName": "A String",
+  "mute": "A String",
+  "muteInfo": {
+    "dynamicMuteRecords": [
+      {
+        "matchTime": "A String",
+        "muteConfig": "A String",
       },
     ],
-    "staticMute": { # Information about the static mute state. A static mute state overrides any dynamic mute rules that apply to this finding. The static mute state can be set by a static mute rule or by muting the finding directly. # If set, the static mute applied to this finding. Static mutes override dynamic mutes. If unset, there is no static mute.
-      "applyTime": "A String", # When the static mute was applied.
-      "state": "A String", # The static mute state. If the value is `MUTED` or `UNMUTED`, then the finding's overall mute state will have the same value.
+    "staticMute": {
+      "applyTime": "A String",
+      "state": "A String",
     },
   },
-  "muteInitiator": "A String", # Records additional information about the mute operation, for example, the [mute configuration](/security-command-center/docs/how-to-mute-findings) that muted the finding and the user who muted the finding.
-  "muteUpdateTime": "A String", # Output only. The most recent time this finding was muted or unmuted.
-  "name": "A String", # The [relative resource name](https://cloud.google.com/apis/design/resource_names#relative_resource_name) of the finding. Example: "organizations/{organization_id}/sources/{source_id}/findings/{finding_id}", "folders/{folder_id}/sources/{source_id}/findings/{finding_id}", "projects/{project_id}/sources/{source_id}/findings/{finding_id}".
-  "networks": [ # Represents the VPC networks that the resource is attached to.
-    { # Contains information about a VPC network associated with the finding.
-      "name": "A String", # The name of the VPC network resource, for example, `//compute.googleapis.com/projects/my-project/global/networks/my-network`.
+  "muteInitiator": "A String",
+  "muteUpdateTime": "A String",
+  "name": "A String",
+  "networks": [
+    {
+      "name": "A String",
     },
   ],
-  "nextSteps": "A String", # Steps to address the finding.
-  "notebook": { # Represents a Jupyter notebook IPYNB file, such as a [Colab Enterprise notebook](https://cloud.google.com/colab/docs/introduction) file, that is associated with a finding. # Notebook associated with the finding.
-    "lastAuthor": "A String", # The user ID of the latest author to modify the notebook.
-    "name": "A String", # The name of the notebook.
-    "notebookUpdateTime": "A String", # The most recent time the notebook was updated.
-    "service": "A String", # The source notebook service, for example, "Colab Enterprise".
+  "nextSteps": "A String",
+  "notebook": {
+    "lastAuthor": "A String",
+    "name": "A String",
+    "notebookUpdateTime": "A String",
+    "service": "A String",
   },
-  "orgPolicies": [ # Contains information about the org policies associated with the finding.
-    { # Contains information about the org policies associated with the finding.
-      "name": "A String", # The resource name of the org policy. Example: "organizations/{organization_id}/policies/{constraint_name}"
+  "orgPolicies": [
+    {
+      "name": "A String",
     },
   ],
-  "parent": "A String", # The relative resource name of the source the finding belongs to. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name This field is immutable after creation time. For example: "organizations/{organization_id}/sources/{source_id}"
-  "parentDisplayName": "A String", # Output only. The human readable display name of the finding source such as "Event Threat Detection" or "Security Health Analytics".
-  "policyViolationSummary": { # Metadata summarizing policy violations of child resources of the affected resource. `finding_category` and `resource` determine the exact semantics of the counts. For example, when category=DATA_SECURITY_POSTURE_OBJECT_PUBLIC_ACCESS_VIOLATION and resource='storage.googleapis.com/buckets/my-bucket-name' then this counts the number of Cloud Storage objects in my-bucket-name which violate a Public Access control. # PolicyViolationSummary associated with the finding.
-    "conformantResourcesCount": "A String", # Total number of child resources that conform to the policy.
-    "evaluationErrorsCount": "A String", # Number of child resources for which errors during evaluation occurred. The evaluation result for these child resources is effectively "unknown".
-    "outOfScopeResourcesCount": "A String", # Total count of child resources which were not in scope for evaluation.
-    "policyViolationsCount": "A String", # Count of child resources in violation of the policy.
-  },
-  "processes": [ # Represents operating system processes associated with the Finding.
-    { # Represents an operating system process.
-      "args": [ # Process arguments as JSON encoded strings.
+  "parent": "A String",
+  "parentDisplayName": "A String",
+  "policyViolationSummary": {
+    "conformantResourcesCount": "A String",
+    "evaluationErrorsCount": "A String",
+    "outOfScopeResourcesCount": "A String",
+    "policyViolationsCount": "A String",
+  },
+  "processes": [
+    {
+      "args": [
         "A String",
       ],
-      "argumentsTruncated": True or False, # True if `args` is incomplete.
-      "binary": { # File information about the related binary/library used by an executable, or the script used by a script interpreter # File information for the process executable.
-        "contents": "A String", # Prefix of the file contents as a JSON-encoded string.
-        "diskPath": { # Path of the file in terms of underlying disk/partition identifiers. # Path of the file in terms of underlying disk/partition identifiers.
-          "partitionUuid": "A String", # UUID of the partition (format https://wiki.archlinux.org/title/persistent_block_device_naming#by-uuid)
-          "relativePath": "A String", # Relative path of the file in the partition as a JSON encoded string. Example: /home/user1/executable_file.sh
+      "argumentsTruncated": True or False,
+      "binary": {
+        "contents": "A String",
+        "diskPath": {
+          "partitionUuid": "A String",
+          "relativePath": "A String",
         },
-        "fileLoadState": "A String", # The load state of the file.
-        "hashedSize": "A String", # The length in bytes of the file prefix that was hashed. If hashed_size == size, any hashes reported represent the entire file.
-        "operations": [ # Operation(s) performed on a file.
-          { # Operation(s) performed on a file.
-            "type": "A String", # The type of the operation
+        "fileLoadState": "A String",
+        "hashedSize": "A String",
+        "operations": [
+          {
+            "type": "A String",
           },
         ],
-        "partiallyHashed": True or False, # True when the hash covers only a prefix of the file.
-        "path": "A String", # Absolute path of the file as a JSON encoded string.
-        "sha256": "A String", # SHA256 hash of the first hashed_size bytes of the file encoded as a hex string. If hashed_size == size, sha256 represents the SHA256 hash of the entire file.
-        "size": "A String", # Size of the file in bytes.
-      },
-      "envVariables": [ # Process environment variables.
-        { # A name-value pair representing an environment variable used in an operating system process.
-          "name": "A String", # Environment variable name as a JSON encoded string.
-          "val": "A String", # Environment variable value as a JSON encoded string.
+        "partiallyHashed": True or False,
+        "path": "A String",
+        "sha256": "A String",
+        "size": "A String",
+      },
+      "envVariables": [
+        {
+          "name": "A String",
+          "val": "A String",
         },
       ],
-      "envVariablesTruncated": True or False, # True if `env_variables` is incomplete.
-      "libraries": [ # File information for libraries loaded by the process.
-        { # File information about the related binary/library used by an executable, or the script used by a script interpreter
-          "contents": "A String", # Prefix of the file contents as a JSON-encoded string.
-          "diskPath": { # Path of the file in terms of underlying disk/partition identifiers. # Path of the file in terms of underlying disk/partition identifiers.
-            "partitionUuid": "A String", # UUID of the partition (format https://wiki.archlinux.org/title/persistent_block_device_naming#by-uuid)
-            "relativePath": "A String", # Relative path of the file in the partition as a JSON encoded string. Example: /home/user1/executable_file.sh
+      "envVariablesTruncated": True or False,
+      "libraries": [
+        {
+          "contents": "A String",
+          "diskPath": {
+            "partitionUuid": "A String",
+            "relativePath": "A String",
           },
-          "fileLoadState": "A String", # The load state of the file.
-          "hashedSize": "A String", # The length in bytes of the file prefix that was hashed. If hashed_size == size, any hashes reported represent the entire file.
-          "operations": [ # Operation(s) performed on a file.
-            { # Operation(s) performed on a file.
-              "type": "A String", # The type of the operation
+          "fileLoadState": "A String",
+          "hashedSize": "A String",
+          "operations": [
+            {
+              "type": "A String",
             },
           ],
-          "partiallyHashed": True or False, # True when the hash covers only a prefix of the file.
-          "path": "A String", # Absolute path of the file as a JSON encoded string.
-          "sha256": "A String", # SHA256 hash of the first hashed_size bytes of the file encoded as a hex string. If hashed_size == size, sha256 represents the SHA256 hash of the entire file.
-          "size": "A String", # Size of the file in bytes.
+          "partiallyHashed": True or False,
+          "path": "A String",
+          "sha256": "A String",
+          "size": "A String",
         },
       ],
-      "name": "A String", # The process name, as displayed in utilities like `top` and `ps`. This name can be accessed through `/proc/[pid]/comm` and changed with `prctl(PR_SET_NAME)`.
-      "parentPid": "A String", # The parent process ID.
-      "pid": "A String", # The process ID.
-      "script": { # File information about the related binary/library used by an executable, or the script used by a script interpreter # When the process represents the invocation of a script, `binary` provides information about the interpreter, while `script` provides information about the script file provided to the interpreter.
-        "contents": "A String", # Prefix of the file contents as a JSON-encoded string.
-        "diskPath": { # Path of the file in terms of underlying disk/partition identifiers. # Path of the file in terms of underlying disk/partition identifiers.
-          "partitionUuid": "A String", # UUID of the partition (format https://wiki.archlinux.org/title/persistent_block_device_naming#by-uuid)
-          "relativePath": "A String", # Relative path of the file in the partition as a JSON encoded string. Example: /home/user1/executable_file.sh
+      "name": "A String",
+      "parentPid": "A String",
+      "pid": "A String",
+      "script": {
+        "contents": "A String",
+        "diskPath": {
+          "partitionUuid": "A String",
+          "relativePath": "A String",
         },
-        "fileLoadState": "A String", # The load state of the file.
-        "hashedSize": "A String", # The length in bytes of the file prefix that was hashed. If hashed_size == size, any hashes reported represent the entire file.
-        "operations": [ # Operation(s) performed on a file.
-          { # Operation(s) performed on a file.
-            "type": "A String", # The type of the operation
+        "fileLoadState": "A String",
+        "hashedSize": "A String",
+        "operations": [
+          {
+            "type": "A String",
           },
         ],
-        "partiallyHashed": True or False, # True when the hash covers only a prefix of the file.
-        "path": "A String", # Absolute path of the file as a JSON encoded string.
-        "sha256": "A String", # SHA256 hash of the first hashed_size bytes of the file encoded as a hex string. If hashed_size == size, sha256 represents the SHA256 hash of the entire file.
-        "size": "A String", # Size of the file in bytes.
+        "partiallyHashed": True or False,
+        "path": "A String",
+        "sha256": "A String",
+        "size": "A String",
       },
-      "userId": "A String", # The ID of the user that executed the process. E.g. If this is the root user this will always be 0.
+      "userId": "A String",
     },
   ],
-  "resourceName": "A String", # For findings on Google Cloud resources, the full resource name of the Google Cloud resource this finding is for. See: https://cloud.google.com/apis/design/resource_names#full_resource_name When the finding is for a non-Google Cloud resource, the resourceName can be a customer or partner defined string. This field is immutable after creation time.
-  "secret": { # Details about a secret or credential associated with the finding. # Secret associated with the finding.
-    "environmentVariable": { # Environment variable containing the secret. # The environment variable containing the secret.
-      "key": "A String", # Environment variable name as a JSON encoded string. Note that value is not included since the value contains the secret data, which is sensitive core content.
+  "resourceName": "A String",
+  "secret": {
+    "environmentVariable": {
+      "key": "A String",
     },
-    "filePath": { # File path containing the secret. # The file containing the secret.
-      "path": "A String", # Path to the file.
+    "filePath": {
+      "path": "A String",
     },
-    "status": { # The status of the secret. # The status of the secret.
-      "lastUpdatedTime": "A String", # Time that the secret was found.
-      "validity": "A String", # The validity of the secret.
+    "status": {
+      "lastUpdatedTime": "A String",
+      "validity": "A String",
     },
-    "type": "A String", # The type of secret, for example, GCP_API_KEY.
+    "type": "A String",
   },
-  "securityMarks": { # User specified security marks that are attached to the parent Security Command Center resource. Security marks are scoped within a Security Command Center organization -- they can be modified and viewed by all users who have proper permissions on the organization. # Output only. User specified security marks. These marks are entirely managed by the user and come from the SecurityMarks resource that belongs to the finding.
-    "canonicalName": "A String", # The canonical name of the marks. Examples: "organizations/{organization_id}/assets/{asset_id}/securityMarks" "folders/{folder_id}/assets/{asset_id}/securityMarks" "projects/{project_number}/assets/{asset_id}/securityMarks" "organizations/{organization_id}/sources/{source_id}/findings/{finding_id}/securityMarks" "folders/{folder_id}/sources/{source_id}/findings/{finding_id}/securityMarks" "projects/{project_number}/sources/{source_id}/findings/{finding_id}/securityMarks"
-    "marks": { # Mutable user specified security marks belonging to the parent resource. Constraints are as follows: * Keys and values are treated as case insensitive * Keys must be between 1 - 256 characters (inclusive) * Keys must be letters, numbers, underscores, or dashes * Values have leading and trailing whitespace trimmed, remaining characters must be between 1 - 4096 characters (inclusive)
+  "securityMarks": {
+    "canonicalName": "A String",
+    "marks": {
       "a_key": "A String",
     },
-    "name": "A String", # The relative resource name of the SecurityMarks. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Examples: "organizations/{organization_id}/assets/{asset_id}/securityMarks" "organizations/{organization_id}/sources/{source_id}/findings/{finding_id}/securityMarks".
+    "name": "A String",
   },
-  "securityPosture": { # Represents a posture that is deployed on Google Cloud by the Security Command Center Posture Management service. A posture contains one or more policy sets. A policy set is a group of policies that enforce a set of security rules on Google Cloud. # The security posture associated with the finding.
-    "changedPolicy": "A String", # The name of the updated policy, for example, `projects/{project_id}/policies/{constraint_name}`.
-    "name": "A String", # Name of the posture, for example, `CIS-Posture`.
-    "policy": "A String", # The ID of the updated policy, for example, `compute-policy-1`.
-    "policyDriftDetails": [ # The details about a change in an updated policy that violates the deployed posture.
-      { # The policy field that violates the deployed posture and its expected and detected values.
-        "detectedValue": "A String", # The detected value that violates the deployed posture, for example, `false` or `allowed_values={"projects/22831892"}`.
-        "expectedValue": "A String", # The value of this field that was configured in a posture, for example, `true` or `allowed_values={"projects/29831892"}`.
-        "field": "A String", # The name of the updated field, for example constraint.implementation.policy_rules[0].enforce
+  "securityPosture": {
+    "changedPolicy": "A String",
+    "name": "A String",
+    "policy": "A String",
+    "policyDriftDetails": [
+      {
+        "detectedValue": "A String",
+        "expectedValue": "A String",
+        "field": "A String",
       },
     ],
-    "policySet": "A String", # The name of the updated policyset, for example, `cis-policyset`.
-    "postureDeployment": "A String", # The name of the posture deployment, for example, `organizations/{org_id}/posturedeployments/{posture_deployment_id}`.
-    "postureDeploymentResource": "A String", # The project, folder, or organization on which the posture is deployed, for example, `projects/{project_number}`.
-    "revisionId": "A String", # The version of the posture, for example, `c7cfa2a8`.
+    "policySet": "A String",
+    "postureDeployment": "A String",
+    "postureDeploymentResource": "A String",
+    "revisionId": "A String",
   },
-  "severity": "A String", # The severity of the finding. This field is managed by the source that writes the finding.
-  "sourceProperties": { # Source specific properties. These properties are managed by the source that writes the finding. The key names in the source_properties map must be between 1 and 255 characters, and must start with a letter and contain alphanumeric characters or underscores only.
+  "severity": "A String",
+  "sourceProperties": {
     "a_key": "",
   },
-  "state": "A String", # The state of the finding.
-  "toxicCombination": { # Contains details about a group of security issues that, when the issues occur together, represent a greater risk than when the issues occur independently. A group of such issues is referred to as a toxic combination. # Contains details about a group of security issues that, when the issues occur together, represent a greater risk than when the issues occur independently. A group of such issues is referred to as a toxic combination. This field cannot be updated. Its value is ignored in all update requests.
-    "attackExposureScore": 3.14, # The [Attack exposure score](https://cloud.google.com/security-command-center/docs/attack-exposure-learn#attack_exposure_scores) of this toxic combination. The score is a measure of how much this toxic combination exposes one or more high-value resources to potential attack.
-    "relatedFindings": [ # List of resource names of findings associated with this toxic combination. For example, `organizations/123/sources/456/findings/789`.
+  "state": "A String",
+  "toxicCombination": {
+    "attackExposureScore": 3.14,
+    "relatedFindings": [
       "A String",
     ],
   },
-  "vertexAi": { # Vertex AI-related information associated with the finding. # VertexAi associated with the finding.
-    "datasets": [ # Datasets associated with the finding.
-      { # Vertex AI dataset associated with the finding.
-        "displayName": "A String", # The user defined display name of dataset, e.g. plants-dataset
-        "name": "A String", # Resource name of the dataset, e.g. projects/{project}/locations/{location}/datasets/2094040236064505856
-        "source": "A String", # Data source, such as BigQuery source URI, e.g. bq://scc-nexus-test.AIPPtest.gsod
-      },
-    ],
-    "pipelines": [ # Pipelines associated with the finding.
-      { # Vertex AI training pipeline associated with the finding.
-        "displayName": "A String", # The user defined display name of pipeline, e.g. plants-classification
-        "name": "A String", # Resource name of the pipeline, e.g. projects/{project}/locations/{location}/trainingPipelines/5253428229225578496
-      },
-    ],
-  },
-  "vulnerability": { # Refers to common vulnerability fields e.g. cve, cvss, cwe etc. # Represents vulnerability-specific fields like CVE and CVSS scores. CVE stands for Common Vulnerabilities and Exposures (https://cve.mitre.org/about/)
-    "cve": { # CVE stands for Common Vulnerabilities and Exposures. Information from the [CVE record](https://www.cve.org/ResourcesSupport/Glossary) that describes this vulnerability. # CVE stands for Common Vulnerabilities and Exposures (https://cve.mitre.org/about/)
-      "cvssv3": { # Common Vulnerability Scoring System version 3. # Describe Common Vulnerability Scoring System specified at https://www.first.org/cvss/v3.1/specification-document
-        "attackComplexity": "A String", # This metric describes the conditions beyond the attacker's control that must exist in order to exploit the vulnerability.
-        "attackVector": "A String", # Base Metrics Represents the intrinsic characteristics of a vulnerability that are constant over time and across user environments. This metric reflects the context by which vulnerability exploitation is possible.
-        "availabilityImpact": "A String", # This metric measures the impact to the availability of the impacted component resulting from a successfully exploited vulnerability.
-        "baseScore": 3.14, # The base score is a function of the base metric scores.
-        "confidentialityImpact": "A String", # This metric measures the impact to the confidentiality of the information resources managed by a software component due to a successfully exploited vulnerability.
-        "integrityImpact": "A String", # This metric measures the impact to integrity of a successfully exploited vulnerability.
-        "privilegesRequired": "A String", # This metric describes the level of privileges an attacker must possess before successfully exploiting the vulnerability.
-        "scope": "A String", # The Scope metric captures whether a vulnerability in one vulnerable component impacts resources in components beyond its security scope.
-        "userInteraction": "A String", # This metric captures the requirement for a human user, other than the attacker, to participate in the successful compromise of the vulnerable component.
-      },
-      "exploitReleaseDate": "A String", # Date the first publicly available exploit or PoC was released.
-      "exploitationActivity": "A String", # The exploitation activity of the vulnerability in the wild.
-      "firstExploitationDate": "A String", # Date of the earliest known exploitation.
-      "id": "A String", # The unique identifier for the vulnerability. e.g. CVE-2021-34527
-      "impact": "A String", # The potential impact of the vulnerability if it was to be exploited.
-      "observedInTheWild": True or False, # Whether or not the vulnerability has been observed in the wild.
-      "references": [ # Additional information about the CVE. e.g. https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2021-34527
-        { # Additional Links
-          "source": "A String", # Source of the reference e.g. NVD
-          "uri": "A String", # Uri for the mentioned source e.g. https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2021-34527.
+  "vertexAi": {
+    "datasets": [
+      {
+        "displayName": "A String",
+        "name": "A String",
+        "source": "A String",
+      },
+    ],
+    "pipelines": [
+      {
+        "displayName": "A String",
+        "name": "A String",
+      },
+    ],
+  },
+  "vulnerability": {
+    "cve": {
+      "cvssv3": {
+        "attackComplexity": "A String",
+        "attackVector": "A String",
+        "availabilityImpact": "A String",
+        "baseScore": 3.14,
+        "confidentialityImpact": "A String",
+        "integrityImpact": "A String",
+        "privilegesRequired": "A String",
+        "scope": "A String",
+        "userInteraction": "A String",
+      },
+      "exploitReleaseDate": "A String",
+      "exploitationActivity": "A String",
+      "firstExploitationDate": "A String",
+      "id": "A String",
+      "impact": "A String",
+      "observedInTheWild": True or False,
+      "references": [
+        {
+          "source": "A String",
+          "uri": "A String",
         },
       ],
-      "upstreamFixAvailable": True or False, # Whether upstream fix is available for the CVE.
-      "zeroDay": True or False, # Whether or not the vulnerability was zero day when the finding was published.
-    },
-    "cwes": [ # Represents one or more Common Weakness Enumeration (CWE) information on this vulnerability.
-      { # CWE stands for Common Weakness Enumeration. Information about this weakness, as described by [CWE](https://cwe.mitre.org/).
-        "id": "A String", # The CWE identifier, e.g. CWE-94
-        "references": [ # Any reference to the details on the CWE, for example, https://cwe.mitre.org/data/definitions/94.html
-          { # Additional Links
-            "source": "A String", # Source of the reference e.g. NVD
-            "uri": "A String", # Uri for the mentioned source e.g. https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2021-34527.
+      "upstreamFixAvailable": True or False,
+      "zeroDay": True or False,
+    },
+    "cwes": [
+      {
+        "id": "A String",
+        "references": [
+          {
+            "source": "A String",
+            "uri": "A String",
           },
         ],
       },
     ],
-    "fixedPackage": { # Package is a generic definition of a package. # The fixed package is relevant to the finding.
-      "cpeUri": "A String", # The CPE URI where the vulnerability was detected.
-      "packageName": "A String", # The name of the package where the vulnerability was detected.
-      "packageType": "A String", # Type of package, for example, os, maven, or go.
-      "packageVersion": "A String", # The version of the package.
+    "fixedPackage": {
+      "cpeUri": "A String",
+      "packageName": "A String",
+      "packageType": "A String",
+      "packageVersion": "A String",
     },
-    "offendingPackage": { # Package is a generic definition of a package. # The offending package is relevant to the finding.
-      "cpeUri": "A String", # The CPE URI where the vulnerability was detected.
-      "packageName": "A String", # The name of the package where the vulnerability was detected.
-      "packageType": "A String", # Type of package, for example, os, maven, or go.
-      "packageVersion": "A String", # The version of the package.
+    "offendingPackage": {
+      "cpeUri": "A String",
+      "packageName": "A String",
+      "packageType": "A String",
+      "packageVersion": "A String",
     },
-    "providerRiskScore": "A String", # Provider provided risk_score based on multiple factors. The higher the risk score, the more risky the vulnerability is.
-    "reachable": True or False, # Represents whether the vulnerability is reachable (detected via static analysis)
-    "securityBulletin": { # SecurityBulletin are notifications of vulnerabilities of Google products. # The security bulletin is relevant to this finding.
-      "bulletinId": "A String", # ID of the bulletin corresponding to the vulnerability.
-      "submissionTime": "A String", # Submission time of this Security Bulletin.
-      "suggestedUpgradeVersion": "A String", # This represents a version that the cluster receiving this notification should be upgraded to, based on its current version. For example, 1.15.0
+    "providerRiskScore": "A String",
+    "reachable": True or False,
+    "securityBulletin": {
+      "bulletinId": "A String",
+      "submissionTime": "A String",
+      "suggestedUpgradeVersion": "A String",
     },
   },
 }
 
-  findingId: string, Required. Unique identifier provided by the client within the parent scope. It must be alphanumeric and less than or equal to 32 characters and greater than 0 characters in length.
+  findingId: string, A parameter
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -942,811 +942,811 @@ 

Method Details

Returns: An object of the form: - { # Security Command Center finding. A finding is a record of assessment data like security, risk, health, or privacy, that is ingested into Security Command Center for presentation, notification, analysis, policy testing, and enforcement. For example, a cross-site scripting (XSS) vulnerability in an App Engine application is a finding. - "access": { # Represents an access event. # Access details associated with the finding, such as more information on the caller, which method was accessed, and from where. - "callerIp": "A String", # Caller's IP address, such as "1.1.1.1". - "callerIpGeo": { # Represents a geographical location for a given access. # The caller IP's geolocation, which identifies where the call came from. - "regionCode": "A String", # A CLDR. - }, - "methodName": "A String", # The method that the service account called, e.g. "SetIamPolicy". - "principalEmail": "A String", # Associated email, such as "foo@google.com". The email address of the authenticated user or a service account acting on behalf of a 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). - "principalSubject": "A String", # A string that represents the principal_subject that is associated with the identity. Unlike `principal_email`, `principal_subject` supports principals that aren't associated with email addresses, such as third party principals. For most identities, the format is `principal://iam.googleapis.com/{identity pool name}/subject/{subject}`. Some GKE identities, such as GKE_WORKLOAD, FREEFORM, and GKE_HUB_WORKLOAD, still use the legacy format `serviceAccount:{identity pool name}[{subject}]`. - "serviceAccountDelegationInfo": [ # The identity delegation history of an authenticated service account that made the request. The `serviceAccountDelegationInfo[]` object contains information about the real authorities that try to access Google Cloud resources by delegating on a service account. When multiple authorities are present, they are guaranteed to be sorted based on the original ordering of the identity delegation events. - { # Identity delegation history of an authenticated service account. - "principalEmail": "A String", # The email address of a Google account. - "principalSubject": "A String", # A string representing the principal_subject associated with the identity. As compared to `principal_email`, supports principals that aren't associated with email addresses, such as third party principals. For most identities, the format will be `principal://iam.googleapis.com/{identity pool name}/subjects/{subject}` except for some GKE identities (GKE_WORKLOAD, FREEFORM, GKE_HUB_WORKLOAD) that are still in the legacy format `serviceAccount:{identity pool name}[{subject}]` - }, - ], - "serviceAccountKeyName": "A String", # The name of the service account key that was used to create or exchange credentials when authenticating the service account that made the request. This is a scheme-less URI full resource name. For example: "//iam.googleapis.com/projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}/keys/{key}". - "serviceName": "A String", # This is the API service that the service account made a call to, e.g. "iam.googleapis.com" - "userAgent": "A String", # The caller's user agent string associated with the finding. - "userAgentFamily": "A String", # Type of user agent associated with the finding. For example, an operating system shell or an embedded or standalone application. - "userName": "A String", # A string that represents a username. The username provided depends on the type of the finding and is likely not an IAM principal. For example, this can be a system username if the finding is related to a virtual machine, or it can be an application login username. - }, - "affectedResources": { # Details about resources affected by this finding. # AffectedResources associated with the finding. - "count": "A String", # The count of resources affected by the finding. - }, - "agentDataAccessEvents": [ # Agent data access events associated with the finding. - { # Details about a data access attempt made by an agent principal not authorized under applicable data security policy. - "eventId": "A String", # Unique identifier for data access event. - "eventTime": "A String", # Timestamp of data access event. - "operation": "A String", # The operation performed by the principal to access the data. - "principalSubject": "A String", # The agent principal that accessed the data. + { + "access": { + "callerIp": "A String", + "callerIpGeo": { + "regionCode": "A String", + }, + "methodName": "A String", + "principalEmail": "A String", + "principalSubject": "A String", + "serviceAccountDelegationInfo": [ + { + "principalEmail": "A String", + "principalSubject": "A String", + }, + ], + "serviceAccountKeyName": "A String", + "serviceName": "A String", + "userAgent": "A String", + "userAgentFamily": "A String", + "userName": "A String", + }, + "affectedResources": { + "count": "A String", + }, + "agentDataAccessEvents": [ + { + "eventId": "A String", + "eventTime": "A String", + "operation": "A String", + "principalSubject": "A String", }, ], - "aiModel": { # Contains information about the AI model associated with the finding. # The AI model associated with the finding. - "deploymentPlatform": "A String", # The platform on which the model is deployed. - "displayName": "A String", # The user defined display name of model. Ex. baseline-classification-model - "domain": "A String", # The domain of the model, for example, “image-classification”. - "library": "A String", # The name of the model library, for example, “transformers”. - "location": "A String", # The region in which the model is used, for example, “us-central1”. - "name": "A String", # The name of the AI model, for example, "gemini:1.0.0". - "publisher": "A String", # The publisher of the model, for example, “google” or “nvidia”. - "usageCategory": "A String", # The purpose of the model, for example, "Inteference" or "Training". - }, - "application": { # Represents an application associated with a finding. # Represents an application associated with the finding. - "baseUri": "A String", # The base URI that identifies the network location of the application in which the vulnerability was detected. For example, `http://example.com`. - "fullUri": "A String", # The full URI with payload that can be used to reproduce the vulnerability. For example, `http://example.com?p=aMmYgI6H`. - }, - "artifactGuardPolicies": { # Represents the result of evaluating artifact guard policies. # ArtifactGuardPolicies associated with the finding. - "failingPolicies": [ # A list of failing policies. - { # Represents an artifact guard policy. - "failureReason": "A String", # The reason for the policy failure, for example, "severity=HIGH AND max_vuln_count=2". - "policyId": "A String", # The ID of the failing policy, for example, "organizations/3392779/locations/global/policies/prod-policy". - "type": "A String", # The type of the policy evaluation. - }, - ], - "resourceId": "A String", # The ID of the resource that has policies configured for it. - }, - "attackExposure": { # An attack exposure contains the results of an attack path simulation run. # The results of an attack path simulation relevant to this finding. - "attackExposureResult": "A String", # The resource name of the attack path simulation result that contains the details regarding this attack exposure score. Example: `organizations/123/simulations/456/attackExposureResults/789` - "exposedHighValueResourcesCount": 42, # The number of high value resources that are exposed as a result of this finding. - "exposedLowValueResourcesCount": 42, # The number of high value resources that are exposed as a result of this finding. - "exposedMediumValueResourcesCount": 42, # The number of medium value resources that are exposed as a result of this finding. - "latestCalculationTime": "A String", # The most recent time the attack exposure was updated on this finding. - "score": 3.14, # A number between 0 (inclusive) and infinity that represents how important this finding is to remediate. The higher the score, the more important it is to remediate. - "state": "A String", # What state this AttackExposure is in. This captures whether or not an attack exposure has been calculated or not. - }, - "backupDisasterRecovery": { # Information related to Google Cloud Backup and DR Service findings. # Fields related to Backup and DR findings. - "appliance": "A String", # The name of the Backup and DR appliance that captures, moves, and manages the lifecycle of backup data. For example, `backup-server-57137`. - "applications": [ # The names of Backup and DR applications. An application is a VM, database, or file system on a managed host monitored by a backup and recovery appliance. For example, `centos7-01-vol00`, `centos7-01-vol01`, `centos7-01-vol02`. + "aiModel": { + "deploymentPlatform": "A String", + "displayName": "A String", + "domain": "A String", + "library": "A String", + "location": "A String", + "name": "A String", + "publisher": "A String", + "usageCategory": "A String", + }, + "application": { + "baseUri": "A String", + "fullUri": "A String", + }, + "artifactGuardPolicies": { + "failingPolicies": [ + { + "failureReason": "A String", + "policyId": "A String", + "type": "A String", + }, + ], + "resourceId": "A String", + }, + "attackExposure": { + "attackExposureResult": "A String", + "exposedHighValueResourcesCount": 42, + "exposedLowValueResourcesCount": 42, + "exposedMediumValueResourcesCount": 42, + "latestCalculationTime": "A String", + "score": 3.14, + "state": "A String", + }, + "backupDisasterRecovery": { + "appliance": "A String", + "applications": [ "A String", ], - "backupCreateTime": "A String", # The timestamp at which the Backup and DR backup was created. - "backupTemplate": "A String", # The name of a Backup and DR template which comprises one or more backup policies. See the [Backup and DR documentation](https://cloud.google.com/backup-disaster-recovery/docs/concepts/backup-plan#temp) for more information. For example, `snap-ov`. - "backupType": "A String", # The backup type of the Backup and DR image. For example, `Snapshot`, `Remote Snapshot`, `OnVault`. - "host": "A String", # The name of a Backup and DR host, which is managed by the backup and recovery appliance and known to the management console. The host can be of type Generic (for example, Compute Engine, SQL Server, Oracle DB, SMB file system, etc.), vCenter, or an ESX server. See the [Backup and DR documentation on hosts](https://cloud.google.com/backup-disaster-recovery/docs/configuration/manage-hosts-and-their-applications) for more information. For example, `centos7-01`. - "policies": [ # The names of Backup and DR policies that are associated with a template and that define when to run a backup, how frequently to run a backup, and how long to retain the backup image. For example, `onvaults`. + "backupCreateTime": "A String", + "backupTemplate": "A String", + "backupType": "A String", + "host": "A String", + "policies": [ "A String", ], - "policyOptions": [ # The names of Backup and DR advanced policy options of a policy applying to an application. See the [Backup and DR documentation on policy options](https://cloud.google.com/backup-disaster-recovery/docs/create-plan/policy-settings). For example, `skipofflineappsincongrp, nounmap`. + "policyOptions": [ "A String", ], - "profile": "A String", # The name of the Backup and DR resource profile that specifies the storage media for backups of application and VM data. See the [Backup and DR documentation on profiles](https://cloud.google.com/backup-disaster-recovery/docs/concepts/backup-plan#profile). For example, `GCP`. - "storagePool": "A String", # The name of the Backup and DR storage pool that the backup and recovery appliance is storing data in. The storage pool could be of type Cloud, Primary, Snapshot, or OnVault. See the [Backup and DR documentation on storage pools](https://cloud.google.com/backup-disaster-recovery/docs/concepts/storage-pools). For example, `DiskPoolOne`. + "profile": "A String", + "storagePool": "A String", }, - "canonicalName": "A String", # The canonical name of the finding. It's either "organizations/{organization_id}/sources/{source_id}/findings/{finding_id}", "folders/{folder_id}/sources/{source_id}/findings/{finding_id}" or "projects/{project_number}/sources/{source_id}/findings/{finding_id}", depending on the closest CRM ancestor of the resource associated with the finding. - "category": "A String", # The additional taxonomy group within findings from a given source. This field is immutable after creation time. Example: "XSS_FLASH_INJECTION" - "chokepoint": { # Contains details about a chokepoint, which is a resource or resource group where high-risk attack paths converge, based on [attack path simulations] (https://cloud.google.com/security-command-center/docs/attack-exposure-learn#attack_path_simulations). # Contains details about a chokepoint, which is a resource or resource group where high-risk attack paths converge, based on [attack path simulations] (https://cloud.google.com/security-command-center/docs/attack-exposure-learn#attack_path_simulations). This field cannot be updated. Its value is ignored in all update requests. - "relatedFindings": [ # List of resource names of findings associated with this chokepoint. For example, organizations/123/sources/456/findings/789. This list will have at most 100 findings. + "canonicalName": "A String", + "category": "A String", + "chokepoint": { + "relatedFindings": [ "A String", ], }, - "cloudArmor": { # Fields related to Google Cloud Armor findings. # Fields related to Cloud Armor findings. - "adaptiveProtection": { # Information about [Google Cloud Armor Adaptive Protection](https://cloud.google.com/armor/docs/cloud-armor-overview#google-cloud-armor-adaptive-protection). # Information about potential Layer 7 DDoS attacks identified by [Google Cloud Armor Adaptive Protection](https://cloud.google.com/armor/docs/adaptive-protection-overview). - "confidence": 3.14, # A score of 0 means that there is low confidence that the detected event is an actual attack. A score of 1 means that there is high confidence that the detected event is an attack. See the [Adaptive Protection documentation](https://cloud.google.com/armor/docs/adaptive-protection-overview#configure-alert-tuning) for further explanation. - }, - "attack": { # Information about DDoS attack volume and classification. # Information about DDoS attack volume and classification. - "classification": "A String", # Type of attack, for example, 'SYN-flood', 'NTP-udp', or 'CHARGEN-udp'. - "volumeBps": 42, # Total BPS (bytes per second) volume of attack. Deprecated - refer to volume_bps_long instead. - "volumeBpsLong": "A String", # Total BPS (bytes per second) volume of attack. - "volumePps": 42, # Total PPS (packets per second) volume of attack. Deprecated - refer to volume_pps_long instead. - "volumePpsLong": "A String", # Total PPS (packets per second) volume of attack. - }, - "duration": "A String", # Duration of attack from the start until the current moment (updated every 5 minutes). - "requests": { # Information about the requests relevant to the finding. # Information about incoming requests evaluated by [Google Cloud Armor security policies](https://cloud.google.com/armor/docs/security-policy-overview). - "longTermAllowed": 42, # Allowed RPS (requests per second) over the long term. - "longTermDenied": 42, # Denied RPS (requests per second) over the long term. - "ratio": 3.14, # For 'Increasing deny ratio', the ratio is the denied traffic divided by the allowed traffic. For 'Allowed traffic spike', the ratio is the allowed traffic in the short term divided by allowed traffic in the long term. - "shortTermAllowed": 42, # Allowed RPS (requests per second) in the short term. - }, - "securityPolicy": { # Information about the [Google Cloud Armor security policy](https://cloud.google.com/armor/docs/security-policy-overview) relevant to the finding. # Information about the [Google Cloud Armor security policy](https://cloud.google.com/armor/docs/security-policy-overview) relevant to the finding. - "name": "A String", # The name of the Google Cloud Armor security policy, for example, "my-security-policy". - "preview": True or False, # Whether or not the associated rule or policy is in preview mode. - "type": "A String", # The type of Google Cloud Armor security policy for example, 'backend security policy', 'edge security policy', 'network edge security policy', or 'always-on DDoS protection'. - }, - "threatVector": "A String", # Distinguish between volumetric & protocol DDoS attack and application layer attacks. For example, "L3_4" for Layer 3 and Layer 4 DDoS attacks, or "L_7" for Layer 7 DDoS attacks. - }, - "cloudDlpDataProfile": { # The [data profile](https://cloud.google.com/dlp/docs/data-profiles) associated with the finding. # Cloud DLP data profile that is associated with the finding. - "dataProfile": "A String", # Name of the data profile, for example, `projects/123/locations/europe/tableProfiles/8383929`. - "infoTypes": [ # Type of information detected by SDP. Info type includes name, version and sensitivity of the detected information type. - { # Type of information detected by the API. - "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. - "sensitivityScore": { # Score is calculated from of all elements in the data profile. A higher level means the data is more sensitive. # Optional custom sensitivity for this InfoType. This only applies to data profiling. - "score": "A String", # The sensitivity score applied to the resource. + "cloudArmor": { + "adaptiveProtection": { + "confidence": 3.14, + }, + "attack": { + "classification": "A String", + "volumeBps": 42, + "volumeBpsLong": "A String", + "volumePps": 42, + "volumePpsLong": "A String", + }, + "duration": "A String", + "requests": { + "longTermAllowed": 42, + "longTermDenied": 42, + "ratio": 3.14, + "shortTermAllowed": 42, + }, + "securityPolicy": { + "name": "A String", + "preview": True or False, + "type": "A String", + }, + "threatVector": "A String", + }, + "cloudDlpDataProfile": { + "dataProfile": "A String", + "infoTypes": [ + { + "name": "A String", + "sensitivityScore": { + "score": "A String", }, - "version": "A String", # Optional version name for this InfoType. + "version": "A String", }, ], - "parentType": "A String", # The resource hierarchy level at which the data profile was generated. + "parentType": "A String", }, - "cloudDlpInspection": { # Details about the Cloud Data Loss Prevention (Cloud DLP) [inspection job](https://cloud.google.com/dlp/docs/concepts-job-triggers) that produced the finding. # Cloud Data Loss Prevention (Cloud DLP) inspection results that are associated with the finding. - "fullScan": True or False, # Whether Cloud DLP scanned the complete resource or a sampled subset. - "infoType": "A String", # The type of information (or *[infoType](https://cloud.google.com/dlp/docs/infotypes-reference)*) found, for example, `EMAIL_ADDRESS` or `STREET_ADDRESS`. - "infoTypeCount": "A String", # The number of times Cloud DLP found this infoType within this job and resource. - "inspectJob": "A String", # Name of the inspection job, for example, `projects/123/locations/europe/dlpJobs/i-8383929`. + "cloudDlpInspection": { + "fullScan": True or False, + "infoType": "A String", + "infoTypeCount": "A String", + "inspectJob": "A String", }, - "complianceDetails": { # Compliance Details associated with the finding. # Details about the compliance implications of the finding. - "cloudControl": { # CloudControl associated with the finding. # CloudControl associated with the finding - "cloudControlName": "A String", # Name of the CloudControl associated with the finding. - "policyType": "A String", # Policy type of the CloudControl - "type": "A String", # Type of cloud control. - "version": 42, # Version of the Cloud Control + "complianceDetails": { + "cloudControl": { + "cloudControlName": "A String", + "policyType": "A String", + "type": "A String", + "version": 42, }, - "cloudControlDeploymentNames": [ # Cloud Control Deployments associated with the finding. For example, organizations/123/locations/global/cloudControlDeployments/deploymentIdentifier + "cloudControlDeploymentNames": [ "A String", ], - "frameworks": [ # Details of Frameworks associated with the finding - { # Compliance framework associated with the finding. - "category": [ # Category of the framework associated with the finding. E.g. Security Benchmark, or Assured Workloads + "frameworks": [ + { + "category": [ "A String", ], - "controls": [ # The controls associated with the framework. - { # Compliance control associated with the finding. - "controlName": "A String", # Name of the Control - "displayName": "A String", # Display name of the control. For example, AU-02. + "controls": [ + { + "controlName": "A String", + "displayName": "A String", }, ], - "displayName": "A String", # Display name of the framework. For a standard framework, this will look like e.g. PCI DSS 3.2.1, whereas for a custom framework it can be a user defined string like MyFramework - "name": "A String", # Name of the framework associated with the finding - "type": "A String", # Type of the framework associated with the finding, to specify whether the framework is built-in (pre-defined and immutable) or a custom framework defined by the customer (equivalent to security posture) + "displayName": "A String", + "name": "A String", + "type": "A String", }, ], }, - "compliances": [ # Contains compliance information for security standards associated to the finding. - { # Contains compliance information about a security standard indicating unmet recommendations. - "ids": [ # Policies within the standard or benchmark, for example, A.12.4.1 + "compliances": [ + { + "ids": [ "A String", ], - "standard": "A String", # Industry-wide compliance standards or benchmarks, such as CIS, PCI, and OWASP. - "version": "A String", # Version of the standard or benchmark, for example, 1.1 + "standard": "A String", + "version": "A String", }, ], - "connections": [ # Contains information about the IP connection associated with the finding. - { # Contains information about the IP connection associated with the finding. - "destinationIp": "A String", # Destination IP address. Not present for sockets that are listening and not connected. - "destinationPort": 42, # Destination port. Not present for sockets that are listening and not connected. - "protocol": "A String", # IANA Internet Protocol Number such as TCP(6) and UDP(17). - "sourceIp": "A String", # Source IP address. - "sourcePort": 42, # Source port. + "connections": [ + { + "destinationIp": "A String", + "destinationPort": 42, + "protocol": "A String", + "sourceIp": "A String", + "sourcePort": 42, }, ], - "contacts": { # Output only. Map containing the points of contact for the given finding. The key represents the type of contact, while the value contains a list of all the contacts that pertain. Please refer to: https://cloud.google.com/resource-manager/docs/managing-notification-contacts#notification-categories { "security": { "contacts": [ { "email": "person1@company.com" }, { "email": "person2@company.com" } ] } } - "a_key": { # Details about specific contacts - "contacts": [ # A list of contacts - { # The email address of a contact. - "email": "A String", # An email address. For example, "`person123@company.com`". + "contacts": { + "a_key": { + "contacts": [ + { + "email": "A String", }, ], }, }, - "containers": [ # Containers associated with the finding. This field provides information for both Kubernetes and non-Kubernetes containers. - { # Container associated with the finding. - "createTime": "A String", # The time that the container was created. - "imageId": "A String", # Optional container image ID, if provided by the container runtime. Uniquely identifies the container image launched using a container image digest. - "labels": [ # Container labels, as provided by the container runtime. - { # Represents a generic name-value label. A label has separate name and value fields to support filtering with the `contains()` function. For more information, see [Filtering on array-type fields](https://cloud.google.com/security-command-center/docs/how-to-api-list-findings#array-contains-filtering). - "name": "A String", # Name of the label. - "value": "A String", # Value that corresponds to the label's name. + "containers": [ + { + "createTime": "A String", + "imageId": "A String", + "labels": [ + { + "name": "A String", + "value": "A String", }, ], - "name": "A String", # Name of the container. - "uri": "A String", # Container image URI provided when configuring a pod or container. This string can identify a container image version using mutable tags. + "name": "A String", + "uri": "A String", }, ], - "createTime": "A String", # The time at which the finding was created in Security Command Center. - "dataAccessEvents": [ # Data access events associated with the finding. - { # Details about a data access attempt made by a principal not authorized under applicable data security policy. - "eventId": "A String", # Unique identifier for data access event. - "eventTime": "A String", # Timestamp of data access event. - "operation": "A String", # The operation performed by the principal to access the data. - "principalEmail": "A String", # The email address of the principal that accessed the data. The principal could be a user account, service account, Google group, or other. + "createTime": "A String", + "dataAccessEvents": [ + { + "eventId": "A String", + "eventTime": "A String", + "operation": "A String", + "principalEmail": "A String", }, ], - "dataFlowEvents": [ # Data flow events associated with the finding. - { # Details about a data flow event, in which either the data is moved to or is accessed from a non-compliant geo-location, as defined in the applicable data security policy. - "eventId": "A String", # Unique identifier for data flow event. - "eventTime": "A String", # Timestamp of data flow event. - "operation": "A String", # The operation performed by the principal for the data flow event. - "principalEmail": "A String", # The email address of the principal that initiated the data flow event. The principal could be a user account, service account, Google group, or other. - "violatedLocation": "A String", # Non-compliant location of the principal or the data destination. + "dataFlowEvents": [ + { + "eventId": "A String", + "eventTime": "A String", + "operation": "A String", + "principalEmail": "A String", + "violatedLocation": "A String", }, ], - "dataRetentionDeletionEvents": [ # Data retention deletion events associated with the finding. - { # Details about data retention deletion violations, in which the data is non-compliant based on their retention or deletion time, as defined in the applicable data security policy. The Data Retention Deletion (DRD) control is a control of the DSPM (Data Security Posture Management) suite that enables organizations to manage data retention and deletion policies in compliance with regulations, such as GDPR and CRPA. DRD supports two primary policy types: maximum storage length (max TTL) and minimum storage length (min TTL). Both are aimed at helping organizations meet regulatory and data management commitments. - "dataObjectCount": "A String", # Number of objects that violated the policy for this resource. If the number is less than 1,000, then the value of this field is the exact number. If the number of objects that violated the policy is greater than or equal to 1,000, then the value of this field is 1000. - "eventDetectionTime": "A String", # Timestamp indicating when the event was detected. - "eventType": "A String", # Type of the DRD event. - "maxRetentionAllowed": "A String", # Maximum duration of retention allowed from the DRD control. This comes from the DRD control where users set a max TTL for their data. For example, suppose that a user sets the max TTL for a Cloud Storage bucket to 90 days. However, an object in that bucket is 100 days old. In this case, a DataRetentionDeletionEvent will be generated for that Cloud Storage bucket, and the max_retention_allowed is 90 days. - "minRetentionAllowed": "A String", # Min duration of retention allowed from the DSPM retention control. This field is only populated when event type is set to EVENT_TYPE_MIN_TTL_FROM_CREATION. + "dataRetentionDeletionEvents": [ + { + "dataObjectCount": "A String", + "eventDetectionTime": "A String", + "eventType": "A String", + "maxRetentionAllowed": "A String", + "minRetentionAllowed": "A String", }, ], - "database": { # Represents database access information, such as queries. A database may be a sub-resource of an instance (as in the case of Cloud SQL instances or Cloud Spanner instances), or the database instance itself. Some database resources might not have the [full resource name](https://google.aip.dev/122#full-resource-names) populated because these resource types, such as Cloud SQL databases, are not yet supported by Cloud Asset Inventory. In these cases only the display name is provided. # Database associated with the finding. - "displayName": "A String", # The human-readable name of the database that the user connected to. - "grantees": [ # The target usernames, roles, or groups of an SQL privilege grant, which is not an IAM policy change. + "database": { + "displayName": "A String", + "grantees": [ "A String", ], - "name": "A String", # Some database resources may not have the [full resource name](https://google.aip.dev/122#full-resource-names) populated because these resource types are not yet supported by Cloud Asset Inventory (e.g. Cloud SQL databases). In these cases only the display name will be provided. The [full resource name](https://google.aip.dev/122#full-resource-names) of the database that the user connected to, if it is supported by Cloud Asset Inventory. - "query": "A String", # The SQL statement that is associated with the database access. - "userName": "A String", # The username used to connect to the database. The username might not be an IAM principal and does not have a set format. - "version": "A String", # The version of the database, for example, POSTGRES_14. See [the complete list](https://cloud.google.com/sql/docs/mysql/admin-api/rest/v1/SqlDatabaseVersion). - }, - "description": "A String", # Contains more details about the finding. - "discoveredWorkload": { # Represents discovered, customer managed workload that is not registered with the respective GCP service. # DiscoveredWorkload associated with the finding. - "confidence": "A String", # The confidence in detection of this workload. - "detectedRelevantHardware": True or False, # A boolean flag set to true if associated hardware strongly predicts the workload type. - "detectedRelevantKeywords": True or False, # A boolean flag set to true if associated keywords strongly predict the workload type. - "detectedRelevantPackages": True or False, # A boolean flag set to true if installed packages strongly predict the workload type. - "workloadType": "A String", # The type of workload. - }, - "disk": { # Contains information about the disk associated with the finding. # Disk associated with the finding. - "name": "A String", # The name of the disk, for example, "https://www.googleapis.com/compute/v1/projects/{project-id}/zones/{zone-id}/disks/{disk-id}". - }, - "eventTime": "A String", # The time the finding was first detected. If an existing finding is updated, then this is the time the update occurred. For example, if the finding represents an open firewall, this property captures the time the detector believes the firewall became open. The accuracy is determined by the detector. If the finding is later resolved, then this time reflects when the finding was resolved. This must not be set to a value greater than the current timestamp. - "exfiltration": { # Exfiltration represents a data exfiltration attempt from one or more sources to one or more targets. The `sources` attribute lists the sources of the exfiltrated data. The `targets` attribute lists the destinations the data was copied to. # Represents exfiltrations associated with the finding. - "sources": [ # If there are multiple sources, then the data is considered "joined" between them. For instance, BigQuery can join multiple tables, and each table would be considered a source. - { # Resource where data was exfiltrated from or exfiltrated to. - "components": [ # Subcomponents of the asset that was exfiltrated, like URIs used during exfiltration, table names, databases, and filenames. For example, multiple tables might have been exfiltrated from the same Cloud SQL instance, or multiple files might have been exfiltrated from the same Cloud Storage bucket. + "name": "A String", + "query": "A String", + "userName": "A String", + "version": "A String", + }, + "description": "A String", + "discoveredWorkload": { + "confidence": "A String", + "detectedRelevantHardware": True or False, + "detectedRelevantKeywords": True or False, + "detectedRelevantPackages": True or False, + "workloadType": "A String", + }, + "disk": { + "name": "A String", + }, + "eventTime": "A String", + "exfiltration": { + "sources": [ + { + "components": [ "A String", ], - "name": "A String", # The resource's [full resource name](https://cloud.google.com/apis/design/resource_names#full_resource_name). + "name": "A String", }, ], - "targets": [ # If there are multiple targets, each target would get a complete copy of the "joined" source data. - { # Resource where data was exfiltrated from or exfiltrated to. - "components": [ # Subcomponents of the asset that was exfiltrated, like URIs used during exfiltration, table names, databases, and filenames. For example, multiple tables might have been exfiltrated from the same Cloud SQL instance, or multiple files might have been exfiltrated from the same Cloud Storage bucket. + "targets": [ + { + "components": [ "A String", ], - "name": "A String", # The resource's [full resource name](https://cloud.google.com/apis/design/resource_names#full_resource_name). - }, - ], - "totalExfiltratedBytes": "A String", # Total exfiltrated bytes processed for the entire job. - }, - "externalExposure": { # Details about the externally exposed resource associated with the finding. # External exposure associated with the finding. - "backendBucket": "A String", # The full resource name of the load balancer backend bucket, for example, "//compute.googleapis.com/projects/{project-id}/global/backendBuckets/{name}" - "backendService": "A String", # The full resource name of load balancer backend service, for example, "//compute.googleapis.com/projects/{project-id}/global/backendServices/{name}". - "exposedApplication": "A String", # The name and version of the exposed web application, for example, "Jenkins 2.184". - "exposedEndpoint": "A String", # The resource which is running the exposed service, for example, "//compute.googleapis.com/projects/{project-id}/zones/{zone}/instances/{instance}.” - "exposedService": "A String", # The name and version of the service, for example, "Jupyter Notebook 6.14.0". - "forwardingRule": "A String", # The full resource name of the forwarding rule, for example, "//compute.googleapis.com/projects/{project-id}/global/forwardingRules/{forwarding-rule-name}". - "hostnameUri": "A String", # Hostname of the exposed application, for example, "https://test-app.a.run.app/" - "httpResponse": [ # The http response returned by the web application. - { # The http response returned by the web application. - "path": "A String", # The http path for which response code was returned by web application, for example, "https://test-app.a.run.app/test". - "statusCode": "A String", # The http response code returned by the web application, for example, 200. - }, - ], - "instanceGroup": "A String", # The full resource name of the instance group, for example, "//compute.googleapis.com/projects/{project-id}/global/instanceGroups/{name}". - "internalBackendService": "A String", # The full resource name of load balancer backend service in the internal project having resource exposed via PSC, for example, "//compute.googleapis.com/projects/{project-id}/global/backendServices/{name}". - "loadBalancerFirewallPolicy": "A String", # The full resource name of the load balancer firewall policy, for example, "//compute.googleapis.com/projects/{project-id}/global/firewallPolicies/{policy-name}". - "networkEndpointGroup": "A String", # The full resource name of the network endpoint group, for example, "//compute.googleapis.com/projects/{project-id}/global/networkEndpointGroups/{name}". - "networkIngressFirewallPolicy": "A String", # The full resource name of the network ingress firewall policy, for example, "//compute.googleapis.com/projects/{project-id}/global/firewallPolicies/{name}". - "privateIpAddress": "A String", # Private IP address of the exposed endpoint. - "privatePort": "A String", # Port number associated with private IP address. - "pscNetworkAttachment": "A String", # The full resource name of the PSC (Private Service Connect) network attachment that network interface controller is attached to, for example, "//compute.googleapis.com/projects/{project-id}/regions/{region}/networkAttachments/{name}" - "pscServiceAttachment": "A String", # The full resource name of the PSC (Private Service Connect) service attachment that the load balancer network endpoint group targets, for example, "//compute.googleapis.com/projects/{project-id}/regions/{region}/serviceAttachments/{name}" - "publicIpAddress": "A String", # Public IP address of the exposed endpoint. - "publicPort": "A String", # Public port number of the exposed endpoint. - "serviceFirewallPolicy": "A String", # The full resource name of the firewall policy of the exposed service, for example, "//compute.googleapis.com/projects/{project-id}/global/firewallPolicies/{policy-name}". - }, - "externalSystems": { # Output only. Third party SIEM/SOAR fields within SCC, contains external system information and external system finding fields. - "a_key": { # Representation of third party SIEM/SOAR fields within SCC. - "assignees": [ # References primary/secondary etc assignees in the external system. + "name": "A String", + }, + ], + "totalExfiltratedBytes": "A String", + }, + "externalExposure": { + "backendBucket": "A String", + "backendService": "A String", + "exposedApplication": "A String", + "exposedEndpoint": "A String", + "exposedService": "A String", + "forwardingRule": "A String", + "hostnameUri": "A String", + "httpResponse": [ + { + "path": "A String", + "statusCode": "A String", + }, + ], + "instanceGroup": "A String", + "internalBackendService": "A String", + "loadBalancerFirewallPolicy": "A String", + "networkEndpointGroup": "A String", + "networkIngressFirewallPolicy": "A String", + "privateIpAddress": "A String", + "privatePort": "A String", + "pscNetworkAttachment": "A String", + "pscServiceAttachment": "A String", + "publicIpAddress": "A String", + "publicPort": "A String", + "serviceFirewallPolicy": "A String", + }, + "externalSystems": { + "a_key": { + "assignees": [ "A String", ], - "caseCloseTime": "A String", # The time when the case was closed, as reported by the external system. - "caseCreateTime": "A String", # The time when the case was created, as reported by the external system. - "casePriority": "A String", # The priority of the finding's corresponding case in the external system. - "caseSla": "A String", # The SLA of the finding's corresponding case in the external system. - "caseUri": "A String", # The link to the finding's corresponding case in the external system. - "externalSystemUpdateTime": "A String", # The time when the case was last updated, as reported by the external system. - "externalUid": "A String", # The identifier that's used to track the finding's corresponding case in the external system. - "name": "A String", # Full resource name of the external system, for example: "organizations/1234/sources/5678/findings/123456/externalSystems/jira", "folders/1234/sources/5678/findings/123456/externalSystems/jira", "projects/1234/sources/5678/findings/123456/externalSystems/jira" - "status": "A String", # The most recent status of the finding's corresponding case, as reported by the external system. - "ticketInfo": { # Information about the ticket, if any, that is being used to track the resolution of the issue that is identified by this finding. # Information about the ticket, if any, that is being used to track the resolution of the issue that is identified by this finding. - "assignee": "A String", # The assignee of the ticket in the ticket system. - "description": "A String", # The description of the ticket in the ticket system. - "id": "A String", # The identifier of the ticket in the ticket system. - "status": "A String", # The latest status of the ticket, as reported by the ticket system. - "updateTime": "A String", # The time when the ticket was last updated, as reported by the ticket system. - "uri": "A String", # The link to the ticket in the ticket system. - }, - }, - }, - "externalUri": "A String", # The URI that, if available, points to a web page outside of Security Command Center where additional information about the finding can be found. This field is guaranteed to be either empty or a well formed URL. - "files": [ # File associated with the finding. - { # File information about the related binary/library used by an executable, or the script used by a script interpreter - "contents": "A String", # Prefix of the file contents as a JSON-encoded string. - "diskPath": { # Path of the file in terms of underlying disk/partition identifiers. # Path of the file in terms of underlying disk/partition identifiers. - "partitionUuid": "A String", # UUID of the partition (format https://wiki.archlinux.org/title/persistent_block_device_naming#by-uuid) - "relativePath": "A String", # Relative path of the file in the partition as a JSON encoded string. Example: /home/user1/executable_file.sh - }, - "fileLoadState": "A String", # The load state of the file. - "hashedSize": "A String", # The length in bytes of the file prefix that was hashed. If hashed_size == size, any hashes reported represent the entire file. - "operations": [ # Operation(s) performed on a file. - { # Operation(s) performed on a file. - "type": "A String", # The type of the operation + "caseCloseTime": "A String", + "caseCreateTime": "A String", + "casePriority": "A String", + "caseSla": "A String", + "caseUri": "A String", + "externalSystemUpdateTime": "A String", + "externalUid": "A String", + "name": "A String", + "status": "A String", + "ticketInfo": { + "assignee": "A String", + "description": "A String", + "id": "A String", + "status": "A String", + "updateTime": "A String", + "uri": "A String", + }, + }, + }, + "externalUri": "A String", + "files": [ + { + "contents": "A String", + "diskPath": { + "partitionUuid": "A String", + "relativePath": "A String", + }, + "fileLoadState": "A String", + "hashedSize": "A String", + "operations": [ + { + "type": "A String", }, ], - "partiallyHashed": True or False, # True when the hash covers only a prefix of the file. - "path": "A String", # Absolute path of the file as a JSON encoded string. - "sha256": "A String", # SHA256 hash of the first hashed_size bytes of the file encoded as a hex string. If hashed_size == size, sha256 represents the SHA256 hash of the entire file. - "size": "A String", # Size of the file in bytes. + "partiallyHashed": True or False, + "path": "A String", + "sha256": "A String", + "size": "A String", }, ], - "findingClass": "A String", # The class of the finding. - "groupMemberships": [ # Contains details about groups of which this finding is a member. A group is a collection of findings that are related in some way. This field cannot be updated. Its value is ignored in all update requests. - { # Contains details about groups of which this finding is a member. A group is a collection of findings that are related in some way. - "groupId": "A String", # ID of the group. - "groupType": "A String", # Type of group. + "findingClass": "A String", + "groupMemberships": [ + { + "groupId": "A String", + "groupType": "A String", }, ], - "iamBindings": [ # Represents IAM bindings associated with the finding. - { # Represents a particular IAM binding, which captures a member's role addition, removal, or state. - "action": "A String", # The action that was performed on a Binding. - "member": "A String", # A single identity requesting access for a Cloud Platform resource, for example, "foo@google.com". - "role": "A String", # Role that is assigned to "members". For example, "roles/viewer", "roles/editor", or "roles/owner". + "iamBindings": [ + { + "action": "A String", + "member": "A String", + "role": "A String", }, ], - "indicator": { # Represents what's commonly known as an _indicator of compromise_ (IoC) in computer forensics. This is an artifact observed on a network or in an operating system that, with high confidence, indicates a computer intrusion. For more information, see [Indicator of compromise](https://en.wikipedia.org/wiki/Indicator_of_compromise). # Represents what's commonly known as an *indicator of compromise* (IoC) in computer forensics. This is an artifact observed on a network or in an operating system that, with high confidence, indicates a computer intrusion. For more information, see [Indicator of compromise](https://en.wikipedia.org/wiki/Indicator_of_compromise). - "domains": [ # List of domains associated to the Finding. + "indicator": { + "domains": [ "A String", ], - "ipAddresses": [ # The list of IP addresses that are associated with the finding. + "ipAddresses": [ "A String", ], - "signatures": [ # The list of matched signatures indicating that the given process is present in the environment. - { # Indicates what signature matched this process. - "memoryHashSignature": { # A signature corresponding to memory page hashes. # Signature indicating that a binary family was matched. - "binaryFamily": "A String", # The binary family. - "detections": [ # The list of memory hash detections contributing to the binary family match. - { # Memory hash detection contributing to the binary family match. - "binary": "A String", # The name of the binary associated with the memory hash signature detection. - "percentPagesMatched": 3.14, # The percentage of memory page hashes in the signature that were matched. + "signatures": [ + { + "memoryHashSignature": { + "binaryFamily": "A String", + "detections": [ + { + "binary": "A String", + "percentPagesMatched": 3.14, }, ], }, - "signatureType": "A String", # Describes the type of resource associated with the signature. - "yaraRuleSignature": { # A signature corresponding to a YARA rule. # Signature indicating that a YARA rule was matched. - "yaraRule": "A String", # The name of the YARA rule. + "signatureType": "A String", + "yaraRuleSignature": { + "yaraRule": "A String", }, }, ], - "uris": [ # The list of URIs associated to the Findings. + "uris": [ "A String", ], }, - "ipRules": { # IP rules associated with the finding. # IP rules associated with the finding. - "allowed": { # Allowed IP rule. # Tuple with allowed rules. - "ipRules": [ # Optional. Optional list of allowed IP rules. - { # IP rule information. - "portRanges": [ # Optional. An optional list of ports to which this rule applies. This field is only applicable for the UDP or (S)TCP protocols. Each entry must be either an integer or a range including a min and max port number. - { # A port range which is inclusive of the min and max values. Values are between 0 and 2^16-1. The max can be equal / must be not smaller than the min value. If min and max are equal this indicates that it is a single port. - "max": "A String", # Maximum port value. - "min": "A String", # Minimum port value. + "ipRules": { + "allowed": { + "ipRules": [ + { + "portRanges": [ + { + "max": "A String", + "min": "A String", }, ], - "protocol": "A String", # The IP protocol this rule applies to. This value can either be one of the following well known protocol strings (TCP, UDP, ICMP, ESP, AH, IPIP, SCTP) or a string representation of the integer value. + "protocol": "A String", }, ], }, - "denied": { # Denied IP rule. # Tuple with denied rules. - "ipRules": [ # Optional. Optional list of denied IP rules. - { # IP rule information. - "portRanges": [ # Optional. An optional list of ports to which this rule applies. This field is only applicable for the UDP or (S)TCP protocols. Each entry must be either an integer or a range including a min and max port number. - { # A port range which is inclusive of the min and max values. Values are between 0 and 2^16-1. The max can be equal / must be not smaller than the min value. If min and max are equal this indicates that it is a single port. - "max": "A String", # Maximum port value. - "min": "A String", # Minimum port value. + "denied": { + "ipRules": [ + { + "portRanges": [ + { + "max": "A String", + "min": "A String", }, ], - "protocol": "A String", # The IP protocol this rule applies to. This value can either be one of the following well known protocol strings (TCP, UDP, ICMP, ESP, AH, IPIP, SCTP) or a string representation of the integer value. + "protocol": "A String", }, ], }, - "destinationIpRanges": [ # If destination IP ranges are specified, the firewall rule applies only to traffic that has a destination IP address in these ranges. These ranges must be expressed in CIDR format. Only supports IPv4. + "destinationIpRanges": [ "A String", ], - "direction": "A String", # The direction that the rule is applicable to, one of ingress or egress. - "exposedServices": [ # Name of the network protocol service, such as FTP, that is exposed by the open port. Follows the naming convention available at: https://www.iana.org/assignments/service-names-port-numbers/service-names-port-numbers.xhtml. + "direction": "A String", + "exposedServices": [ "A String", ], - "sourceIpRanges": [ # If source IP ranges are specified, the firewall rule applies only to traffic that has a source IP address in these ranges. These ranges must be expressed in CIDR format. Only supports IPv4. + "sourceIpRanges": [ "A String", ], }, - "job": { # Describes a job # Job associated with the finding. - "errorCode": 42, # Optional. If the job did not complete successfully, this field describes why. - "location": "A String", # Optional. Gives the location where the job ran, such as `US` or `europe-west1` - "name": "A String", # The fully-qualified name for a job. e.g. `projects//jobs/` - "state": "A String", # Output only. State of the job, such as `RUNNING` or `PENDING`. - }, - "kernelRootkit": { # Kernel mode rootkit signatures. # Signature of the kernel rootkit. - "name": "A String", # Rootkit name, when available. - "unexpectedCodeModification": True or False, # True if unexpected modifications of kernel code memory are present. - "unexpectedFtraceHandler": True or False, # True if `ftrace` points are present with callbacks pointing to regions that are not in the expected kernel or module code range. - "unexpectedInterruptHandler": True or False, # True if interrupt handlers that are are not in the expected kernel or module code regions are present. - "unexpectedKernelCodePages": True or False, # True if kernel code pages that are not in the expected kernel or module code regions are present. - "unexpectedKprobeHandler": True or False, # True if `kprobe` points are present with callbacks pointing to regions that are not in the expected kernel or module code range. - "unexpectedProcessesInRunqueue": True or False, # True if unexpected processes in the scheduler run queue are present. Such processes are in the run queue, but not in the process task list. - "unexpectedReadOnlyDataModification": True or False, # True if unexpected modifications of kernel read-only data memory are present. - "unexpectedSystemCallHandler": True or False, # True if system call handlers that are are not in the expected kernel or module code regions are present. - }, - "kubernetes": { # Kubernetes-related attributes. # Kubernetes resources associated with the finding. - "accessReviews": [ # Provides information on any Kubernetes access reviews (privilege checks) relevant to the finding. - { # Conveys information about a Kubernetes access review (such as one returned by a [`kubectl auth can-i`](https://kubernetes.io/docs/reference/access-authn-authz/authorization/#checking-api-access) command) that was involved in a finding. - "group": "A String", # The API group of the resource. "*" means all. - "name": "A String", # The name of the resource being requested. Empty means all. - "ns": "A String", # Namespace of the action being requested. Currently, there is no distinction between no namespace and all namespaces. Both are represented by "" (empty). - "resource": "A String", # The optional resource type requested. "*" means all. - "subresource": "A String", # The optional subresource type. - "verb": "A String", # A Kubernetes resource API verb, like get, list, watch, create, update, delete, proxy. "*" means all. - "version": "A String", # The API version of the resource. "*" means all. - }, - ], - "bindings": [ # Provides Kubernetes role binding information for findings that involve [RoleBindings or ClusterRoleBindings](https://cloud.google.com/kubernetes-engine/docs/how-to/role-based-access-control). - { # Represents a Kubernetes RoleBinding or ClusterRoleBinding. - "name": "A String", # Name for the binding. - "ns": "A String", # Namespace for the binding. - "role": { # Kubernetes Role or ClusterRole. # The Role or ClusterRole referenced by the binding. - "kind": "A String", # Role type. - "name": "A String", # Role name. - "ns": "A String", # Role namespace. + "job": { + "errorCode": 42, + "location": "A String", + "name": "A String", + "state": "A String", + }, + "kernelRootkit": { + "name": "A String", + "unexpectedCodeModification": True or False, + "unexpectedFtraceHandler": True or False, + "unexpectedInterruptHandler": True or False, + "unexpectedKernelCodePages": True or False, + "unexpectedKprobeHandler": True or False, + "unexpectedProcessesInRunqueue": True or False, + "unexpectedReadOnlyDataModification": True or False, + "unexpectedSystemCallHandler": True or False, + }, + "kubernetes": { + "accessReviews": [ + { + "group": "A String", + "name": "A String", + "ns": "A String", + "resource": "A String", + "subresource": "A String", + "verb": "A String", + "version": "A String", + }, + ], + "bindings": [ + { + "name": "A String", + "ns": "A String", + "role": { + "kind": "A String", + "name": "A String", + "ns": "A String", }, - "subjects": [ # Represents one or more subjects that are bound to the role. Not always available for PATCH requests. - { # Represents a Kubernetes subject. - "kind": "A String", # Authentication type for the subject. - "name": "A String", # Name for the subject. - "ns": "A String", # Namespace for the subject. + "subjects": [ + { + "kind": "A String", + "name": "A String", + "ns": "A String", }, ], }, ], - "nodePools": [ # GKE [node pools](https://cloud.google.com/kubernetes-engine/docs/concepts/node-pools) associated with the finding. This field contains node pool information for each node, when it is available. - { # Provides GKE node pool information. - "name": "A String", # Kubernetes node pool name. - "nodes": [ # Nodes associated with the finding. - { # Kubernetes nodes associated with the finding. - "name": "A String", # [Full resource name](https://google.aip.dev/122#full-resource-names) of the Compute Engine VM running the cluster node. + "nodePools": [ + { + "name": "A String", + "nodes": [ + { + "name": "A String", }, ], }, ], - "nodes": [ # Provides Kubernetes [node](https://cloud.google.com/kubernetes-engine/docs/concepts/cluster-architecture#nodes) information. - { # Kubernetes nodes associated with the finding. - "name": "A String", # [Full resource name](https://google.aip.dev/122#full-resource-names) of the Compute Engine VM running the cluster node. + "nodes": [ + { + "name": "A String", }, ], - "objects": [ # Kubernetes objects related to the finding. - { # Kubernetes object related to the finding, uniquely identified by GKNN. Used if the object Kind is not one of Pod, Node, NodePool, Binding, or AccessReview. - "containers": [ # Pod containers associated with this finding, if any. - { # Container associated with the finding. - "createTime": "A String", # The time that the container was created. - "imageId": "A String", # Optional container image ID, if provided by the container runtime. Uniquely identifies the container image launched using a container image digest. - "labels": [ # Container labels, as provided by the container runtime. - { # Represents a generic name-value label. A label has separate name and value fields to support filtering with the `contains()` function. For more information, see [Filtering on array-type fields](https://cloud.google.com/security-command-center/docs/how-to-api-list-findings#array-contains-filtering). - "name": "A String", # Name of the label. - "value": "A String", # Value that corresponds to the label's name. + "objects": [ + { + "containers": [ + { + "createTime": "A String", + "imageId": "A String", + "labels": [ + { + "name": "A String", + "value": "A String", }, ], - "name": "A String", # Name of the container. - "uri": "A String", # Container image URI provided when configuring a pod or container. This string can identify a container image version using mutable tags. + "name": "A String", + "uri": "A String", }, ], - "group": "A String", # Kubernetes object group, such as "policy.k8s.io/v1". - "kind": "A String", # Kubernetes object kind, such as "Namespace". - "name": "A String", # Kubernetes object name. For details see https://kubernetes.io/docs/concepts/overview/working-with-objects/names/. - "ns": "A String", # Kubernetes object namespace. Must be a valid DNS label. Named "ns" to avoid collision with C++ namespace keyword. For details see https://kubernetes.io/docs/tasks/administer-cluster/namespaces/. - }, - ], - "pods": [ # Kubernetes [Pods](https://cloud.google.com/kubernetes-engine/docs/concepts/pod) associated with the finding. This field contains Pod records for each container that is owned by a Pod. - { # A Kubernetes Pod. - "containers": [ # Pod containers associated with this finding, if any. - { # Container associated with the finding. - "createTime": "A String", # The time that the container was created. - "imageId": "A String", # Optional container image ID, if provided by the container runtime. Uniquely identifies the container image launched using a container image digest. - "labels": [ # Container labels, as provided by the container runtime. - { # Represents a generic name-value label. A label has separate name and value fields to support filtering with the `contains()` function. For more information, see [Filtering on array-type fields](https://cloud.google.com/security-command-center/docs/how-to-api-list-findings#array-contains-filtering). - "name": "A String", # Name of the label. - "value": "A String", # Value that corresponds to the label's name. + "group": "A String", + "kind": "A String", + "name": "A String", + "ns": "A String", + }, + ], + "pods": [ + { + "containers": [ + { + "createTime": "A String", + "imageId": "A String", + "labels": [ + { + "name": "A String", + "value": "A String", }, ], - "name": "A String", # Name of the container. - "uri": "A String", # Container image URI provided when configuring a pod or container. This string can identify a container image version using mutable tags. + "name": "A String", + "uri": "A String", }, ], - "labels": [ # Pod labels. For Kubernetes containers, these are applied to the container. - { # Represents a generic name-value label. A label has separate name and value fields to support filtering with the `contains()` function. For more information, see [Filtering on array-type fields](https://cloud.google.com/security-command-center/docs/how-to-api-list-findings#array-contains-filtering). - "name": "A String", # Name of the label. - "value": "A String", # Value that corresponds to the label's name. + "labels": [ + { + "name": "A String", + "value": "A String", }, ], - "name": "A String", # Kubernetes Pod name. - "ns": "A String", # Kubernetes Pod namespace. + "name": "A String", + "ns": "A String", }, ], - "roles": [ # Provides Kubernetes role information for findings that involve [Roles or ClusterRoles](https://cloud.google.com/kubernetes-engine/docs/how-to/role-based-access-control). - { # Kubernetes Role or ClusterRole. - "kind": "A String", # Role type. - "name": "A String", # Role name. - "ns": "A String", # Role namespace. + "roles": [ + { + "kind": "A String", + "name": "A String", + "ns": "A String", }, ], }, - "loadBalancers": [ # The load balancers associated with the finding. - { # Contains information related to the load balancer associated with the finding. - "name": "A String", # The name of the load balancer associated with the finding. + "loadBalancers": [ + { + "name": "A String", }, ], - "logEntries": [ # Log entries that are relevant to the finding. - { # An individual entry in a log. - "cloudLoggingEntry": { # Metadata taken from a [Cloud Logging LogEntry](https://cloud.google.com/logging/docs/reference/v2/rest/v2/LogEntry) # An individual entry in a log stored in Cloud Logging. - "insertId": "A String", # A unique identifier for the log entry. - "logId": "A String", # The type of the log (part of `log_name`. `log_name` is the resource name of the log to which this log entry belongs). For example: `cloudresourcemanager.googleapis.com/activity`. Note that this field is not URL-encoded, unlike the `LOG_ID` field in `LogEntry`. - "resourceContainer": "A String", # The organization, folder, or project of the monitored resource that produced this log entry. - "timestamp": "A String", # The time the event described by the log entry occurred. + "logEntries": [ + { + "cloudLoggingEntry": { + "insertId": "A String", + "logId": "A String", + "resourceContainer": "A String", + "timestamp": "A String", }, }, ], - "mitreAttack": { # MITRE ATT&CK tactics and techniques related to this finding. See: https://attack.mitre.org # MITRE ATT&CK tactics and techniques related to this finding. See: https://attack.mitre.org - "additionalTactics": [ # Additional MITRE ATT&CK tactics related to this finding, if any. + "mitreAttack": { + "additionalTactics": [ "A String", ], - "additionalTechniques": [ # Additional MITRE ATT&CK techniques related to this finding, if any, along with any of their respective parent techniques. + "additionalTechniques": [ "A String", ], - "primaryTactic": "A String", # The MITRE ATT&CK tactic most closely represented by this finding, if any. - "primaryTechniques": [ # The MITRE ATT&CK technique most closely represented by this finding, if any. primary_techniques is a repeated field because there are multiple levels of MITRE ATT&CK techniques. If the technique most closely represented by this finding is a sub-technique (e.g. `SCANNING_IP_BLOCKS`), both the sub-technique and its parent technique(s) will be listed (e.g. `SCANNING_IP_BLOCKS`, `ACTIVE_SCANNING`). + "primaryTactic": "A String", + "primaryTechniques": [ "A String", ], - "version": "A String", # The MITRE ATT&CK version referenced by the above fields. E.g. "8". + "version": "A String", }, - "moduleName": "A String", # Unique identifier of the module which generated the finding. Example: folders/598186756061/securityHealthAnalyticsSettings/customModules/56799441161885 - "mute": "A String", # Indicates the mute state of a finding (either muted, unmuted or undefined). Unlike other attributes of a finding, a finding provider shouldn't set the value of mute. - "muteInfo": { # Mute information about the finding, including whether the finding has a static mute or any matching dynamic mute rules. # Output only. The mute information regarding this finding. - "dynamicMuteRecords": [ # The list of dynamic mute rules that currently match the finding. - { # The record of a dynamic mute rule that matches the finding. - "matchTime": "A String", # When the dynamic mute rule first matched the finding. - "muteConfig": "A String", # The relative resource name of the mute rule, represented by a mute config, that created this record, for example `organizations/123/muteConfigs/mymuteconfig` or `organizations/123/locations/global/muteConfigs/mymuteconfig`. + "moduleName": "A String", + "mute": "A String", + "muteInfo": { + "dynamicMuteRecords": [ + { + "matchTime": "A String", + "muteConfig": "A String", }, ], - "staticMute": { # Information about the static mute state. A static mute state overrides any dynamic mute rules that apply to this finding. The static mute state can be set by a static mute rule or by muting the finding directly. # If set, the static mute applied to this finding. Static mutes override dynamic mutes. If unset, there is no static mute. - "applyTime": "A String", # When the static mute was applied. - "state": "A String", # The static mute state. If the value is `MUTED` or `UNMUTED`, then the finding's overall mute state will have the same value. + "staticMute": { + "applyTime": "A String", + "state": "A String", }, }, - "muteInitiator": "A String", # Records additional information about the mute operation, for example, the [mute configuration](/security-command-center/docs/how-to-mute-findings) that muted the finding and the user who muted the finding. - "muteUpdateTime": "A String", # Output only. The most recent time this finding was muted or unmuted. - "name": "A String", # The [relative resource name](https://cloud.google.com/apis/design/resource_names#relative_resource_name) of the finding. Example: "organizations/{organization_id}/sources/{source_id}/findings/{finding_id}", "folders/{folder_id}/sources/{source_id}/findings/{finding_id}", "projects/{project_id}/sources/{source_id}/findings/{finding_id}". - "networks": [ # Represents the VPC networks that the resource is attached to. - { # Contains information about a VPC network associated with the finding. - "name": "A String", # The name of the VPC network resource, for example, `//compute.googleapis.com/projects/my-project/global/networks/my-network`. + "muteInitiator": "A String", + "muteUpdateTime": "A String", + "name": "A String", + "networks": [ + { + "name": "A String", }, ], - "nextSteps": "A String", # Steps to address the finding. - "notebook": { # Represents a Jupyter notebook IPYNB file, such as a [Colab Enterprise notebook](https://cloud.google.com/colab/docs/introduction) file, that is associated with a finding. # Notebook associated with the finding. - "lastAuthor": "A String", # The user ID of the latest author to modify the notebook. - "name": "A String", # The name of the notebook. - "notebookUpdateTime": "A String", # The most recent time the notebook was updated. - "service": "A String", # The source notebook service, for example, "Colab Enterprise". + "nextSteps": "A String", + "notebook": { + "lastAuthor": "A String", + "name": "A String", + "notebookUpdateTime": "A String", + "service": "A String", }, - "orgPolicies": [ # Contains information about the org policies associated with the finding. - { # Contains information about the org policies associated with the finding. - "name": "A String", # The resource name of the org policy. Example: "organizations/{organization_id}/policies/{constraint_name}" + "orgPolicies": [ + { + "name": "A String", }, ], - "parent": "A String", # The relative resource name of the source the finding belongs to. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name This field is immutable after creation time. For example: "organizations/{organization_id}/sources/{source_id}" - "parentDisplayName": "A String", # Output only. The human readable display name of the finding source such as "Event Threat Detection" or "Security Health Analytics". - "policyViolationSummary": { # Metadata summarizing policy violations of child resources of the affected resource. `finding_category` and `resource` determine the exact semantics of the counts. For example, when category=DATA_SECURITY_POSTURE_OBJECT_PUBLIC_ACCESS_VIOLATION and resource='storage.googleapis.com/buckets/my-bucket-name' then this counts the number of Cloud Storage objects in my-bucket-name which violate a Public Access control. # PolicyViolationSummary associated with the finding. - "conformantResourcesCount": "A String", # Total number of child resources that conform to the policy. - "evaluationErrorsCount": "A String", # Number of child resources for which errors during evaluation occurred. The evaluation result for these child resources is effectively "unknown". - "outOfScopeResourcesCount": "A String", # Total count of child resources which were not in scope for evaluation. - "policyViolationsCount": "A String", # Count of child resources in violation of the policy. - }, - "processes": [ # Represents operating system processes associated with the Finding. - { # Represents an operating system process. - "args": [ # Process arguments as JSON encoded strings. + "parent": "A String", + "parentDisplayName": "A String", + "policyViolationSummary": { + "conformantResourcesCount": "A String", + "evaluationErrorsCount": "A String", + "outOfScopeResourcesCount": "A String", + "policyViolationsCount": "A String", + }, + "processes": [ + { + "args": [ "A String", ], - "argumentsTruncated": True or False, # True if `args` is incomplete. - "binary": { # File information about the related binary/library used by an executable, or the script used by a script interpreter # File information for the process executable. - "contents": "A String", # Prefix of the file contents as a JSON-encoded string. - "diskPath": { # Path of the file in terms of underlying disk/partition identifiers. # Path of the file in terms of underlying disk/partition identifiers. - "partitionUuid": "A String", # UUID of the partition (format https://wiki.archlinux.org/title/persistent_block_device_naming#by-uuid) - "relativePath": "A String", # Relative path of the file in the partition as a JSON encoded string. Example: /home/user1/executable_file.sh + "argumentsTruncated": True or False, + "binary": { + "contents": "A String", + "diskPath": { + "partitionUuid": "A String", + "relativePath": "A String", }, - "fileLoadState": "A String", # The load state of the file. - "hashedSize": "A String", # The length in bytes of the file prefix that was hashed. If hashed_size == size, any hashes reported represent the entire file. - "operations": [ # Operation(s) performed on a file. - { # Operation(s) performed on a file. - "type": "A String", # The type of the operation + "fileLoadState": "A String", + "hashedSize": "A String", + "operations": [ + { + "type": "A String", }, ], - "partiallyHashed": True or False, # True when the hash covers only a prefix of the file. - "path": "A String", # Absolute path of the file as a JSON encoded string. - "sha256": "A String", # SHA256 hash of the first hashed_size bytes of the file encoded as a hex string. If hashed_size == size, sha256 represents the SHA256 hash of the entire file. - "size": "A String", # Size of the file in bytes. - }, - "envVariables": [ # Process environment variables. - { # A name-value pair representing an environment variable used in an operating system process. - "name": "A String", # Environment variable name as a JSON encoded string. - "val": "A String", # Environment variable value as a JSON encoded string. + "partiallyHashed": True or False, + "path": "A String", + "sha256": "A String", + "size": "A String", + }, + "envVariables": [ + { + "name": "A String", + "val": "A String", }, ], - "envVariablesTruncated": True or False, # True if `env_variables` is incomplete. - "libraries": [ # File information for libraries loaded by the process. - { # File information about the related binary/library used by an executable, or the script used by a script interpreter - "contents": "A String", # Prefix of the file contents as a JSON-encoded string. - "diskPath": { # Path of the file in terms of underlying disk/partition identifiers. # Path of the file in terms of underlying disk/partition identifiers. - "partitionUuid": "A String", # UUID of the partition (format https://wiki.archlinux.org/title/persistent_block_device_naming#by-uuid) - "relativePath": "A String", # Relative path of the file in the partition as a JSON encoded string. Example: /home/user1/executable_file.sh + "envVariablesTruncated": True or False, + "libraries": [ + { + "contents": "A String", + "diskPath": { + "partitionUuid": "A String", + "relativePath": "A String", }, - "fileLoadState": "A String", # The load state of the file. - "hashedSize": "A String", # The length in bytes of the file prefix that was hashed. If hashed_size == size, any hashes reported represent the entire file. - "operations": [ # Operation(s) performed on a file. - { # Operation(s) performed on a file. - "type": "A String", # The type of the operation + "fileLoadState": "A String", + "hashedSize": "A String", + "operations": [ + { + "type": "A String", }, ], - "partiallyHashed": True or False, # True when the hash covers only a prefix of the file. - "path": "A String", # Absolute path of the file as a JSON encoded string. - "sha256": "A String", # SHA256 hash of the first hashed_size bytes of the file encoded as a hex string. If hashed_size == size, sha256 represents the SHA256 hash of the entire file. - "size": "A String", # Size of the file in bytes. + "partiallyHashed": True or False, + "path": "A String", + "sha256": "A String", + "size": "A String", }, ], - "name": "A String", # The process name, as displayed in utilities like `top` and `ps`. This name can be accessed through `/proc/[pid]/comm` and changed with `prctl(PR_SET_NAME)`. - "parentPid": "A String", # The parent process ID. - "pid": "A String", # The process ID. - "script": { # File information about the related binary/library used by an executable, or the script used by a script interpreter # When the process represents the invocation of a script, `binary` provides information about the interpreter, while `script` provides information about the script file provided to the interpreter. - "contents": "A String", # Prefix of the file contents as a JSON-encoded string. - "diskPath": { # Path of the file in terms of underlying disk/partition identifiers. # Path of the file in terms of underlying disk/partition identifiers. - "partitionUuid": "A String", # UUID of the partition (format https://wiki.archlinux.org/title/persistent_block_device_naming#by-uuid) - "relativePath": "A String", # Relative path of the file in the partition as a JSON encoded string. Example: /home/user1/executable_file.sh + "name": "A String", + "parentPid": "A String", + "pid": "A String", + "script": { + "contents": "A String", + "diskPath": { + "partitionUuid": "A String", + "relativePath": "A String", }, - "fileLoadState": "A String", # The load state of the file. - "hashedSize": "A String", # The length in bytes of the file prefix that was hashed. If hashed_size == size, any hashes reported represent the entire file. - "operations": [ # Operation(s) performed on a file. - { # Operation(s) performed on a file. - "type": "A String", # The type of the operation + "fileLoadState": "A String", + "hashedSize": "A String", + "operations": [ + { + "type": "A String", }, ], - "partiallyHashed": True or False, # True when the hash covers only a prefix of the file. - "path": "A String", # Absolute path of the file as a JSON encoded string. - "sha256": "A String", # SHA256 hash of the first hashed_size bytes of the file encoded as a hex string. If hashed_size == size, sha256 represents the SHA256 hash of the entire file. - "size": "A String", # Size of the file in bytes. + "partiallyHashed": True or False, + "path": "A String", + "sha256": "A String", + "size": "A String", }, - "userId": "A String", # The ID of the user that executed the process. E.g. If this is the root user this will always be 0. + "userId": "A String", }, ], - "resourceName": "A String", # For findings on Google Cloud resources, the full resource name of the Google Cloud resource this finding is for. See: https://cloud.google.com/apis/design/resource_names#full_resource_name When the finding is for a non-Google Cloud resource, the resourceName can be a customer or partner defined string. This field is immutable after creation time. - "secret": { # Details about a secret or credential associated with the finding. # Secret associated with the finding. - "environmentVariable": { # Environment variable containing the secret. # The environment variable containing the secret. - "key": "A String", # Environment variable name as a JSON encoded string. Note that value is not included since the value contains the secret data, which is sensitive core content. + "resourceName": "A String", + "secret": { + "environmentVariable": { + "key": "A String", }, - "filePath": { # File path containing the secret. # The file containing the secret. - "path": "A String", # Path to the file. + "filePath": { + "path": "A String", }, - "status": { # The status of the secret. # The status of the secret. - "lastUpdatedTime": "A String", # Time that the secret was found. - "validity": "A String", # The validity of the secret. + "status": { + "lastUpdatedTime": "A String", + "validity": "A String", }, - "type": "A String", # The type of secret, for example, GCP_API_KEY. + "type": "A String", }, - "securityMarks": { # User specified security marks that are attached to the parent Security Command Center resource. Security marks are scoped within a Security Command Center organization -- they can be modified and viewed by all users who have proper permissions on the organization. # Output only. User specified security marks. These marks are entirely managed by the user and come from the SecurityMarks resource that belongs to the finding. - "canonicalName": "A String", # The canonical name of the marks. Examples: "organizations/{organization_id}/assets/{asset_id}/securityMarks" "folders/{folder_id}/assets/{asset_id}/securityMarks" "projects/{project_number}/assets/{asset_id}/securityMarks" "organizations/{organization_id}/sources/{source_id}/findings/{finding_id}/securityMarks" "folders/{folder_id}/sources/{source_id}/findings/{finding_id}/securityMarks" "projects/{project_number}/sources/{source_id}/findings/{finding_id}/securityMarks" - "marks": { # Mutable user specified security marks belonging to the parent resource. Constraints are as follows: * Keys and values are treated as case insensitive * Keys must be between 1 - 256 characters (inclusive) * Keys must be letters, numbers, underscores, or dashes * Values have leading and trailing whitespace trimmed, remaining characters must be between 1 - 4096 characters (inclusive) + "securityMarks": { + "canonicalName": "A String", + "marks": { "a_key": "A String", }, - "name": "A String", # The relative resource name of the SecurityMarks. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Examples: "organizations/{organization_id}/assets/{asset_id}/securityMarks" "organizations/{organization_id}/sources/{source_id}/findings/{finding_id}/securityMarks". + "name": "A String", }, - "securityPosture": { # Represents a posture that is deployed on Google Cloud by the Security Command Center Posture Management service. A posture contains one or more policy sets. A policy set is a group of policies that enforce a set of security rules on Google Cloud. # The security posture associated with the finding. - "changedPolicy": "A String", # The name of the updated policy, for example, `projects/{project_id}/policies/{constraint_name}`. - "name": "A String", # Name of the posture, for example, `CIS-Posture`. - "policy": "A String", # The ID of the updated policy, for example, `compute-policy-1`. - "policyDriftDetails": [ # The details about a change in an updated policy that violates the deployed posture. - { # The policy field that violates the deployed posture and its expected and detected values. - "detectedValue": "A String", # The detected value that violates the deployed posture, for example, `false` or `allowed_values={"projects/22831892"}`. - "expectedValue": "A String", # The value of this field that was configured in a posture, for example, `true` or `allowed_values={"projects/29831892"}`. - "field": "A String", # The name of the updated field, for example constraint.implementation.policy_rules[0].enforce + "securityPosture": { + "changedPolicy": "A String", + "name": "A String", + "policy": "A String", + "policyDriftDetails": [ + { + "detectedValue": "A String", + "expectedValue": "A String", + "field": "A String", }, ], - "policySet": "A String", # The name of the updated policyset, for example, `cis-policyset`. - "postureDeployment": "A String", # The name of the posture deployment, for example, `organizations/{org_id}/posturedeployments/{posture_deployment_id}`. - "postureDeploymentResource": "A String", # The project, folder, or organization on which the posture is deployed, for example, `projects/{project_number}`. - "revisionId": "A String", # The version of the posture, for example, `c7cfa2a8`. + "policySet": "A String", + "postureDeployment": "A String", + "postureDeploymentResource": "A String", + "revisionId": "A String", }, - "severity": "A String", # The severity of the finding. This field is managed by the source that writes the finding. - "sourceProperties": { # Source specific properties. These properties are managed by the source that writes the finding. The key names in the source_properties map must be between 1 and 255 characters, and must start with a letter and contain alphanumeric characters or underscores only. + "severity": "A String", + "sourceProperties": { "a_key": "", }, - "state": "A String", # The state of the finding. - "toxicCombination": { # Contains details about a group of security issues that, when the issues occur together, represent a greater risk than when the issues occur independently. A group of such issues is referred to as a toxic combination. # Contains details about a group of security issues that, when the issues occur together, represent a greater risk than when the issues occur independently. A group of such issues is referred to as a toxic combination. This field cannot be updated. Its value is ignored in all update requests. - "attackExposureScore": 3.14, # The [Attack exposure score](https://cloud.google.com/security-command-center/docs/attack-exposure-learn#attack_exposure_scores) of this toxic combination. The score is a measure of how much this toxic combination exposes one or more high-value resources to potential attack. - "relatedFindings": [ # List of resource names of findings associated with this toxic combination. For example, `organizations/123/sources/456/findings/789`. + "state": "A String", + "toxicCombination": { + "attackExposureScore": 3.14, + "relatedFindings": [ "A String", ], }, - "vertexAi": { # Vertex AI-related information associated with the finding. # VertexAi associated with the finding. - "datasets": [ # Datasets associated with the finding. - { # Vertex AI dataset associated with the finding. - "displayName": "A String", # The user defined display name of dataset, e.g. plants-dataset - "name": "A String", # Resource name of the dataset, e.g. projects/{project}/locations/{location}/datasets/2094040236064505856 - "source": "A String", # Data source, such as BigQuery source URI, e.g. bq://scc-nexus-test.AIPPtest.gsod - }, - ], - "pipelines": [ # Pipelines associated with the finding. - { # Vertex AI training pipeline associated with the finding. - "displayName": "A String", # The user defined display name of pipeline, e.g. plants-classification - "name": "A String", # Resource name of the pipeline, e.g. projects/{project}/locations/{location}/trainingPipelines/5253428229225578496 - }, - ], - }, - "vulnerability": { # Refers to common vulnerability fields e.g. cve, cvss, cwe etc. # Represents vulnerability-specific fields like CVE and CVSS scores. CVE stands for Common Vulnerabilities and Exposures (https://cve.mitre.org/about/) - "cve": { # CVE stands for Common Vulnerabilities and Exposures. Information from the [CVE record](https://www.cve.org/ResourcesSupport/Glossary) that describes this vulnerability. # CVE stands for Common Vulnerabilities and Exposures (https://cve.mitre.org/about/) - "cvssv3": { # Common Vulnerability Scoring System version 3. # Describe Common Vulnerability Scoring System specified at https://www.first.org/cvss/v3.1/specification-document - "attackComplexity": "A String", # This metric describes the conditions beyond the attacker's control that must exist in order to exploit the vulnerability. - "attackVector": "A String", # Base Metrics Represents the intrinsic characteristics of a vulnerability that are constant over time and across user environments. This metric reflects the context by which vulnerability exploitation is possible. - "availabilityImpact": "A String", # This metric measures the impact to the availability of the impacted component resulting from a successfully exploited vulnerability. - "baseScore": 3.14, # The base score is a function of the base metric scores. - "confidentialityImpact": "A String", # This metric measures the impact to the confidentiality of the information resources managed by a software component due to a successfully exploited vulnerability. - "integrityImpact": "A String", # This metric measures the impact to integrity of a successfully exploited vulnerability. - "privilegesRequired": "A String", # This metric describes the level of privileges an attacker must possess before successfully exploiting the vulnerability. - "scope": "A String", # The Scope metric captures whether a vulnerability in one vulnerable component impacts resources in components beyond its security scope. - "userInteraction": "A String", # This metric captures the requirement for a human user, other than the attacker, to participate in the successful compromise of the vulnerable component. - }, - "exploitReleaseDate": "A String", # Date the first publicly available exploit or PoC was released. - "exploitationActivity": "A String", # The exploitation activity of the vulnerability in the wild. - "firstExploitationDate": "A String", # Date of the earliest known exploitation. - "id": "A String", # The unique identifier for the vulnerability. e.g. CVE-2021-34527 - "impact": "A String", # The potential impact of the vulnerability if it was to be exploited. - "observedInTheWild": True or False, # Whether or not the vulnerability has been observed in the wild. - "references": [ # Additional information about the CVE. e.g. https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2021-34527 - { # Additional Links - "source": "A String", # Source of the reference e.g. NVD - "uri": "A String", # Uri for the mentioned source e.g. https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2021-34527. + "vertexAi": { + "datasets": [ + { + "displayName": "A String", + "name": "A String", + "source": "A String", + }, + ], + "pipelines": [ + { + "displayName": "A String", + "name": "A String", + }, + ], + }, + "vulnerability": { + "cve": { + "cvssv3": { + "attackComplexity": "A String", + "attackVector": "A String", + "availabilityImpact": "A String", + "baseScore": 3.14, + "confidentialityImpact": "A String", + "integrityImpact": "A String", + "privilegesRequired": "A String", + "scope": "A String", + "userInteraction": "A String", + }, + "exploitReleaseDate": "A String", + "exploitationActivity": "A String", + "firstExploitationDate": "A String", + "id": "A String", + "impact": "A String", + "observedInTheWild": True or False, + "references": [ + { + "source": "A String", + "uri": "A String", }, ], - "upstreamFixAvailable": True or False, # Whether upstream fix is available for the CVE. - "zeroDay": True or False, # Whether or not the vulnerability was zero day when the finding was published. - }, - "cwes": [ # Represents one or more Common Weakness Enumeration (CWE) information on this vulnerability. - { # CWE stands for Common Weakness Enumeration. Information about this weakness, as described by [CWE](https://cwe.mitre.org/). - "id": "A String", # The CWE identifier, e.g. CWE-94 - "references": [ # Any reference to the details on the CWE, for example, https://cwe.mitre.org/data/definitions/94.html - { # Additional Links - "source": "A String", # Source of the reference e.g. NVD - "uri": "A String", # Uri for the mentioned source e.g. https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2021-34527. + "upstreamFixAvailable": True or False, + "zeroDay": True or False, + }, + "cwes": [ + { + "id": "A String", + "references": [ + { + "source": "A String", + "uri": "A String", }, ], }, ], - "fixedPackage": { # Package is a generic definition of a package. # The fixed package is relevant to the finding. - "cpeUri": "A String", # The CPE URI where the vulnerability was detected. - "packageName": "A String", # The name of the package where the vulnerability was detected. - "packageType": "A String", # Type of package, for example, os, maven, or go. - "packageVersion": "A String", # The version of the package. + "fixedPackage": { + "cpeUri": "A String", + "packageName": "A String", + "packageType": "A String", + "packageVersion": "A String", }, - "offendingPackage": { # Package is a generic definition of a package. # The offending package is relevant to the finding. - "cpeUri": "A String", # The CPE URI where the vulnerability was detected. - "packageName": "A String", # The name of the package where the vulnerability was detected. - "packageType": "A String", # Type of package, for example, os, maven, or go. - "packageVersion": "A String", # The version of the package. + "offendingPackage": { + "cpeUri": "A String", + "packageName": "A String", + "packageType": "A String", + "packageVersion": "A String", }, - "providerRiskScore": "A String", # Provider provided risk_score based on multiple factors. The higher the risk score, the more risky the vulnerability is. - "reachable": True or False, # Represents whether the vulnerability is reachable (detected via static analysis) - "securityBulletin": { # SecurityBulletin are notifications of vulnerabilities of Google products. # The security bulletin is relevant to this finding. - "bulletinId": "A String", # ID of the bulletin corresponding to the vulnerability. - "submissionTime": "A String", # Submission time of this Security Bulletin. - "suggestedUpgradeVersion": "A String", # This represents a version that the cluster receiving this notification should be upgraded to, based on its current version. For example, 1.15.0 + "providerRiskScore": "A String", + "reachable": True or False, + "securityBulletin": { + "bulletinId": "A String", + "submissionTime": "A String", + "suggestedUpgradeVersion": "A String", }, }, }
@@ -1754,20 +1754,20 @@

Method Details

group(parent, body=None, x__xgafv=None) -
Filters an organization or source's findings and groups them by their specified properties. To group across all sources provide a `-` as the source id. Example: /v1/organizations/{organization_id}/sources/-/findings, /v1/folders/{folder_id}/sources/-/findings, /v1/projects/{project_id}/sources/-/findings
+  
 
 Args:
-  parent: string, Required. Name of the source to groupBy. Its format is `organizations/[organization_id]/sources/[source_id]`, `folders/[folder_id]/sources/[source_id]`, or `projects/[project_id]/sources/[source_id]`. To groupBy across all sources provide a source_id of `-`. For example: `organizations/{organization_id}/sources/-, folders/{folder_id}/sources/-`, or `projects/{project_id}/sources/-` (required)
+  parent: string, A parameter (required)
   body: object, The request body.
     The object takes the form of:
 
-{ # Request message for grouping by findings.
-  "compareDuration": "A String", # When compare_duration is set, the GroupResult's "state_change" attribute is updated to indicate whether the finding had its state changed, the finding's state remained unchanged, or if the finding was added during the compare_duration period of time that precedes the read_time. This is the time between (read_time - compare_duration) and read_time. The state_change value is derived based on the presence and state of the finding at the two points in time. Intermediate state changes between the two times don't affect the result. For example, the results aren't affected if the finding is made inactive and then active again. Possible "state_change" values when compare_duration is specified: * "CHANGED": indicates that the finding was present and matched the given filter at the start of compare_duration, but changed its state at read_time. * "UNCHANGED": indicates that the finding was present and matched the given filter at the start of compare_duration and did not change state at read_time. * "ADDED": indicates that the finding did not match the given filter or was not present at the start of compare_duration, but was present at read_time. * "REMOVED": indicates that the finding was present and matched the filter at the start of compare_duration, but did not match the filter at read_time. If compare_duration is not specified, then the only possible state_change is "UNUSED", which will be the state_change set for all findings present at read_time. If this field is set then `state_change` must be a specified field in `group_by`.
-  "filter": "A String", # Expression that defines the filter to apply across findings. The expression is a list of one or more restrictions combined via logical operators `AND` and `OR`. Parentheses are supported, and `OR` has higher precedence than `AND`. Restrictions have the form ` ` and may have a `-` character in front of them to indicate negation. Examples include: * name * source_properties.a_property * security_marks.marks.marka The supported operators are: * `=` for all value types. * `>`, `<`, `>=`, `<=` for integer values. * `:`, meaning substring matching, for strings. The supported value types are: * string literals in quotes. * integer literals without quotes. * boolean literals `true` and `false` without quotes. The following field and operator combinations are supported: * name: `=` * parent: `=`, `:` * resource_name: `=`, `:` * state: `=`, `:` * category: `=`, `:` * external_uri: `=`, `:` * event_time: `=`, `>`, `<`, `>=`, `<=` Usage: This should be milliseconds since epoch or an RFC3339 string. Examples: `event_time = "2019-06-10T16:07:18-07:00"` `event_time = 1560208038000` * severity: `=`, `:` * workflow_state: `=`, `:` * security_marks.marks: `=`, `:` * source_properties: `=`, `:`, `>`, `<`, `>=`, `<=` For example, `source_properties.size = 100` is a valid filter string. Use a partial match on the empty string to filter based on a property existing: `source_properties.my_property : ""` Use a negated partial match on the empty string to filter based on a property not existing: `-source_properties.my_property : ""` * resource: * resource.name: `=`, `:` * resource.parent_name: `=`, `:` * resource.parent_display_name: `=`, `:` * resource.project_name: `=`, `:` * resource.project_display_name: `=`, `:` * resource.type: `=`, `:`
-  "groupBy": "A String", # Required. Expression that defines what assets fields to use for grouping (including `state_change`). The string value should follow SQL syntax: comma separated list of fields. For example: "parent,resource_name". The following fields are supported when compare_duration is set: * state_change
-  "pageSize": 42, # The maximum number of results to return in a single response. Default is 10, minimum is 1, maximum is 1000.
-  "pageToken": "A String", # The value returned by the last `GroupFindingsResponse`; indicates that this is a continuation of a prior `GroupFindings` call, and that the system should return the next page of data.
-  "readTime": "A String", # Time used as a reference point when filtering findings. The filter is limited to findings existing at the supplied time and their values are those at that specific time. Absence of this field will default to the API's version of NOW.
+{
+  "compareDuration": "A String",
+  "filter": "A String",
+  "groupBy": "A String",
+  "pageSize": 42,
+  "pageToken": "A String",
+  "readTime": "A String",
 }
 
   x__xgafv: string, V1 error format.
@@ -1778,18 +1778,18 @@ 

Method Details

Returns: An object of the form: - { # Response message for group by findings. - "groupByResults": [ # Group results. There exists an element for each existing unique combination of property/values. The element contains a count for the number of times those specific property/values appear. - { # Result containing the properties and count of a groupBy request. - "count": "A String", # Total count of resources for the given properties. - "properties": { # Properties matching the groupBy fields in the request. + { + "groupByResults": [ + { + "count": "A String", + "properties": { "a_key": "", }, }, ], - "nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no more results. - "readTime": "A String", # Time used for executing the groupBy request. - "totalSize": 42, # The total number of results matching the query. + "nextPageToken": "A String", + "readTime": "A String", + "totalSize": 42, }
@@ -1809,17 +1809,17 @@

Method Details

list(parent, compareDuration=None, fieldMask=None, filter=None, orderBy=None, pageSize=None, pageToken=None, readTime=None, x__xgafv=None) -
Lists an organization or source's findings. To list across all sources provide a `-` as the source id. Example: /v1/organizations/{organization_id}/sources/-/findings
+  
 
 Args:
-  parent: string, Required. Name of the source the findings belong to. Its format is `organizations/[organization_id]/sources/[source_id]`, `folders/[folder_id]/sources/[source_id]`, or `projects/[project_id]/sources/[source_id]`. To list across all sources provide a source_id of `-`. For example: `organizations/{organization_id}/sources/-`, `folders/{folder_id}/sources/-` or `projects/{projects_id}/sources/-` (required)
-  compareDuration: string, When compare_duration is set, the ListFindingsResult's "state_change" attribute is updated to indicate whether the finding had its state changed, the finding's state remained unchanged, or if the finding was added in any state during the compare_duration period of time that precedes the read_time. This is the time between (read_time - compare_duration) and read_time. The state_change value is derived based on the presence and state of the finding at the two points in time. Intermediate state changes between the two times don't affect the result. For example, the results aren't affected if the finding is made inactive and then active again. Possible "state_change" values when compare_duration is specified: * "CHANGED": indicates that the finding was present and matched the given filter at the start of compare_duration, but changed its state at read_time. * "UNCHANGED": indicates that the finding was present and matched the given filter at the start of compare_duration and did not change state at read_time. * "ADDED": indicates that the finding did not match the given filter or was not present at the start of compare_duration, but was present at read_time. * "REMOVED": indicates that the finding was present and matched the filter at the start of compare_duration, but did not match the filter at read_time. If compare_duration is not specified, then the only possible state_change is "UNUSED", which will be the state_change set for all findings present at read_time.
-  fieldMask: string, A field mask to specify the Finding fields to be listed in the response. An empty field mask will list all fields.
-  filter: string, Expression that defines the filter to apply across findings. The expression is a list of one or more restrictions combined via logical operators `AND` and `OR`. Parentheses are supported, and `OR` has higher precedence than `AND`. Restrictions have the form ` ` and may have a `-` character in front of them to indicate negation. Examples include: * name * source_properties.a_property * security_marks.marks.marka The supported operators are: * `=` for all value types. * `>`, `<`, `>=`, `<=` for integer values. * `:`, meaning substring matching, for strings. The supported value types are: * string literals in quotes. * integer literals without quotes. * boolean literals `true` and `false` without quotes. The following field and operator combinations are supported: * name: `=` * parent: `=`, `:` * resource_name: `=`, `:` * state: `=`, `:` * category: `=`, `:` * external_uri: `=`, `:` * event_time: `=`, `>`, `<`, `>=`, `<=` Usage: This should be milliseconds since epoch or an RFC3339 string. Examples: `event_time = "2019-06-10T16:07:18-07:00"` `event_time = 1560208038000` * severity: `=`, `:` * workflow_state: `=`, `:` * security_marks.marks: `=`, `:` * source_properties: `=`, `:`, `>`, `<`, `>=`, `<=` For example, `source_properties.size = 100` is a valid filter string. Use a partial match on the empty string to filter based on a property existing: `source_properties.my_property : ""` Use a negated partial match on the empty string to filter based on a property not existing: `-source_properties.my_property : ""` * resource: * resource.name: `=`, `:` * resource.parent_name: `=`, `:` * resource.parent_display_name: `=`, `:` * resource.project_name: `=`, `:` * resource.project_display_name: `=`, `:` * resource.type: `=`, `:` * resource.folders.resource_folder: `=`, `:` * resource.display_name: `=`, `:`
-  orderBy: string, Expression that defines what fields and order to use for sorting. The string value should follow SQL syntax: comma separated list of fields. For example: "name,resource_properties.a_property". The default sorting order is ascending. To specify descending order for a field, a suffix " desc" should be appended to the field name. For example: "name desc,source_properties.a_property". Redundant space characters in the syntax are insignificant. "name desc,source_properties.a_property" and " name desc , source_properties.a_property " are equivalent. The following fields are supported: name parent state category resource_name event_time source_properties security_marks.marks
-  pageSize: integer, The maximum number of results to return in a single response. Default is 10, minimum is 1, maximum is 1000.
-  pageToken: string, The value returned by the last `ListFindingsResponse`; indicates that this is a continuation of a prior `ListFindings` call, and that the system should return the next page of data.
-  readTime: string, Time used as a reference point when filtering findings. The filter is limited to findings existing at the supplied time and their values are those at that specific time. Absence of this field will default to the API's version of NOW.
+  parent: string, A parameter (required)
+  compareDuration: string, A parameter
+  fieldMask: string, A parameter
+  filter: string, A parameter
+  orderBy: string, A parameter
+  pageSize: integer, A parameter
+  pageToken: string, A parameter
+  readTime: string, A parameter
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -1828,945 +1828,945 @@ 

Method Details

Returns: An object of the form: - { # Response message for listing findings. - "listFindingsResults": [ # Findings matching the list request. - { # Result containing the Finding and its StateChange. - "finding": { # Security Command Center finding. A finding is a record of assessment data like security, risk, health, or privacy, that is ingested into Security Command Center for presentation, notification, analysis, policy testing, and enforcement. For example, a cross-site scripting (XSS) vulnerability in an App Engine application is a finding. # Finding matching the search request. - "access": { # Represents an access event. # Access details associated with the finding, such as more information on the caller, which method was accessed, and from where. - "callerIp": "A String", # Caller's IP address, such as "1.1.1.1". - "callerIpGeo": { # Represents a geographical location for a given access. # The caller IP's geolocation, which identifies where the call came from. - "regionCode": "A String", # A CLDR. + { + "listFindingsResults": [ + { + "finding": { + "access": { + "callerIp": "A String", + "callerIpGeo": { + "regionCode": "A String", }, - "methodName": "A String", # The method that the service account called, e.g. "SetIamPolicy". - "principalEmail": "A String", # Associated email, such as "foo@google.com". The email address of the authenticated user or a service account acting on behalf of a 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). - "principalSubject": "A String", # A string that represents the principal_subject that is associated with the identity. Unlike `principal_email`, `principal_subject` supports principals that aren't associated with email addresses, such as third party principals. For most identities, the format is `principal://iam.googleapis.com/{identity pool name}/subject/{subject}`. Some GKE identities, such as GKE_WORKLOAD, FREEFORM, and GKE_HUB_WORKLOAD, still use the legacy format `serviceAccount:{identity pool name}[{subject}]`. - "serviceAccountDelegationInfo": [ # The identity delegation history of an authenticated service account that made the request. The `serviceAccountDelegationInfo[]` object contains information about the real authorities that try to access Google Cloud resources by delegating on a service account. When multiple authorities are present, they are guaranteed to be sorted based on the original ordering of the identity delegation events. - { # Identity delegation history of an authenticated service account. - "principalEmail": "A String", # The email address of a Google account. - "principalSubject": "A String", # A string representing the principal_subject associated with the identity. As compared to `principal_email`, supports principals that aren't associated with email addresses, such as third party principals. For most identities, the format will be `principal://iam.googleapis.com/{identity pool name}/subjects/{subject}` except for some GKE identities (GKE_WORKLOAD, FREEFORM, GKE_HUB_WORKLOAD) that are still in the legacy format `serviceAccount:{identity pool name}[{subject}]` + "methodName": "A String", + "principalEmail": "A String", + "principalSubject": "A String", + "serviceAccountDelegationInfo": [ + { + "principalEmail": "A String", + "principalSubject": "A String", }, ], - "serviceAccountKeyName": "A String", # The name of the service account key that was used to create or exchange credentials when authenticating the service account that made the request. This is a scheme-less URI full resource name. For example: "//iam.googleapis.com/projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}/keys/{key}". - "serviceName": "A String", # This is the API service that the service account made a call to, e.g. "iam.googleapis.com" - "userAgent": "A String", # The caller's user agent string associated with the finding. - "userAgentFamily": "A String", # Type of user agent associated with the finding. For example, an operating system shell or an embedded or standalone application. - "userName": "A String", # A string that represents a username. The username provided depends on the type of the finding and is likely not an IAM principal. For example, this can be a system username if the finding is related to a virtual machine, or it can be an application login username. + "serviceAccountKeyName": "A String", + "serviceName": "A String", + "userAgent": "A String", + "userAgentFamily": "A String", + "userName": "A String", }, - "affectedResources": { # Details about resources affected by this finding. # AffectedResources associated with the finding. - "count": "A String", # The count of resources affected by the finding. + "affectedResources": { + "count": "A String", }, - "agentDataAccessEvents": [ # Agent data access events associated with the finding. - { # Details about a data access attempt made by an agent principal not authorized under applicable data security policy. - "eventId": "A String", # Unique identifier for data access event. - "eventTime": "A String", # Timestamp of data access event. - "operation": "A String", # The operation performed by the principal to access the data. - "principalSubject": "A String", # The agent principal that accessed the data. + "agentDataAccessEvents": [ + { + "eventId": "A String", + "eventTime": "A String", + "operation": "A String", + "principalSubject": "A String", }, ], - "aiModel": { # Contains information about the AI model associated with the finding. # The AI model associated with the finding. - "deploymentPlatform": "A String", # The platform on which the model is deployed. - "displayName": "A String", # The user defined display name of model. Ex. baseline-classification-model - "domain": "A String", # The domain of the model, for example, “image-classification”. - "library": "A String", # The name of the model library, for example, “transformers”. - "location": "A String", # The region in which the model is used, for example, “us-central1”. - "name": "A String", # The name of the AI model, for example, "gemini:1.0.0". - "publisher": "A String", # The publisher of the model, for example, “google” or “nvidia”. - "usageCategory": "A String", # The purpose of the model, for example, "Inteference" or "Training". + "aiModel": { + "deploymentPlatform": "A String", + "displayName": "A String", + "domain": "A String", + "library": "A String", + "location": "A String", + "name": "A String", + "publisher": "A String", + "usageCategory": "A String", }, - "application": { # Represents an application associated with a finding. # Represents an application associated with the finding. - "baseUri": "A String", # The base URI that identifies the network location of the application in which the vulnerability was detected. For example, `http://example.com`. - "fullUri": "A String", # The full URI with payload that can be used to reproduce the vulnerability. For example, `http://example.com?p=aMmYgI6H`. + "application": { + "baseUri": "A String", + "fullUri": "A String", }, - "artifactGuardPolicies": { # Represents the result of evaluating artifact guard policies. # ArtifactGuardPolicies associated with the finding. - "failingPolicies": [ # A list of failing policies. - { # Represents an artifact guard policy. - "failureReason": "A String", # The reason for the policy failure, for example, "severity=HIGH AND max_vuln_count=2". - "policyId": "A String", # The ID of the failing policy, for example, "organizations/3392779/locations/global/policies/prod-policy". - "type": "A String", # The type of the policy evaluation. + "artifactGuardPolicies": { + "failingPolicies": [ + { + "failureReason": "A String", + "policyId": "A String", + "type": "A String", }, ], - "resourceId": "A String", # The ID of the resource that has policies configured for it. + "resourceId": "A String", }, - "attackExposure": { # An attack exposure contains the results of an attack path simulation run. # The results of an attack path simulation relevant to this finding. - "attackExposureResult": "A String", # The resource name of the attack path simulation result that contains the details regarding this attack exposure score. Example: `organizations/123/simulations/456/attackExposureResults/789` - "exposedHighValueResourcesCount": 42, # The number of high value resources that are exposed as a result of this finding. - "exposedLowValueResourcesCount": 42, # The number of high value resources that are exposed as a result of this finding. - "exposedMediumValueResourcesCount": 42, # The number of medium value resources that are exposed as a result of this finding. - "latestCalculationTime": "A String", # The most recent time the attack exposure was updated on this finding. - "score": 3.14, # A number between 0 (inclusive) and infinity that represents how important this finding is to remediate. The higher the score, the more important it is to remediate. - "state": "A String", # What state this AttackExposure is in. This captures whether or not an attack exposure has been calculated or not. + "attackExposure": { + "attackExposureResult": "A String", + "exposedHighValueResourcesCount": 42, + "exposedLowValueResourcesCount": 42, + "exposedMediumValueResourcesCount": 42, + "latestCalculationTime": "A String", + "score": 3.14, + "state": "A String", }, - "backupDisasterRecovery": { # Information related to Google Cloud Backup and DR Service findings. # Fields related to Backup and DR findings. - "appliance": "A String", # The name of the Backup and DR appliance that captures, moves, and manages the lifecycle of backup data. For example, `backup-server-57137`. - "applications": [ # The names of Backup and DR applications. An application is a VM, database, or file system on a managed host monitored by a backup and recovery appliance. For example, `centos7-01-vol00`, `centos7-01-vol01`, `centos7-01-vol02`. + "backupDisasterRecovery": { + "appliance": "A String", + "applications": [ "A String", ], - "backupCreateTime": "A String", # The timestamp at which the Backup and DR backup was created. - "backupTemplate": "A String", # The name of a Backup and DR template which comprises one or more backup policies. See the [Backup and DR documentation](https://cloud.google.com/backup-disaster-recovery/docs/concepts/backup-plan#temp) for more information. For example, `snap-ov`. - "backupType": "A String", # The backup type of the Backup and DR image. For example, `Snapshot`, `Remote Snapshot`, `OnVault`. - "host": "A String", # The name of a Backup and DR host, which is managed by the backup and recovery appliance and known to the management console. The host can be of type Generic (for example, Compute Engine, SQL Server, Oracle DB, SMB file system, etc.), vCenter, or an ESX server. See the [Backup and DR documentation on hosts](https://cloud.google.com/backup-disaster-recovery/docs/configuration/manage-hosts-and-their-applications) for more information. For example, `centos7-01`. - "policies": [ # The names of Backup and DR policies that are associated with a template and that define when to run a backup, how frequently to run a backup, and how long to retain the backup image. For example, `onvaults`. + "backupCreateTime": "A String", + "backupTemplate": "A String", + "backupType": "A String", + "host": "A String", + "policies": [ "A String", ], - "policyOptions": [ # The names of Backup and DR advanced policy options of a policy applying to an application. See the [Backup and DR documentation on policy options](https://cloud.google.com/backup-disaster-recovery/docs/create-plan/policy-settings). For example, `skipofflineappsincongrp, nounmap`. + "policyOptions": [ "A String", ], - "profile": "A String", # The name of the Backup and DR resource profile that specifies the storage media for backups of application and VM data. See the [Backup and DR documentation on profiles](https://cloud.google.com/backup-disaster-recovery/docs/concepts/backup-plan#profile). For example, `GCP`. - "storagePool": "A String", # The name of the Backup and DR storage pool that the backup and recovery appliance is storing data in. The storage pool could be of type Cloud, Primary, Snapshot, or OnVault. See the [Backup and DR documentation on storage pools](https://cloud.google.com/backup-disaster-recovery/docs/concepts/storage-pools). For example, `DiskPoolOne`. + "profile": "A String", + "storagePool": "A String", }, - "canonicalName": "A String", # The canonical name of the finding. It's either "organizations/{organization_id}/sources/{source_id}/findings/{finding_id}", "folders/{folder_id}/sources/{source_id}/findings/{finding_id}" or "projects/{project_number}/sources/{source_id}/findings/{finding_id}", depending on the closest CRM ancestor of the resource associated with the finding. - "category": "A String", # The additional taxonomy group within findings from a given source. This field is immutable after creation time. Example: "XSS_FLASH_INJECTION" - "chokepoint": { # Contains details about a chokepoint, which is a resource or resource group where high-risk attack paths converge, based on [attack path simulations] (https://cloud.google.com/security-command-center/docs/attack-exposure-learn#attack_path_simulations). # Contains details about a chokepoint, which is a resource or resource group where high-risk attack paths converge, based on [attack path simulations] (https://cloud.google.com/security-command-center/docs/attack-exposure-learn#attack_path_simulations). This field cannot be updated. Its value is ignored in all update requests. - "relatedFindings": [ # List of resource names of findings associated with this chokepoint. For example, organizations/123/sources/456/findings/789. This list will have at most 100 findings. + "canonicalName": "A String", + "category": "A String", + "chokepoint": { + "relatedFindings": [ "A String", ], }, - "cloudArmor": { # Fields related to Google Cloud Armor findings. # Fields related to Cloud Armor findings. - "adaptiveProtection": { # Information about [Google Cloud Armor Adaptive Protection](https://cloud.google.com/armor/docs/cloud-armor-overview#google-cloud-armor-adaptive-protection). # Information about potential Layer 7 DDoS attacks identified by [Google Cloud Armor Adaptive Protection](https://cloud.google.com/armor/docs/adaptive-protection-overview). - "confidence": 3.14, # A score of 0 means that there is low confidence that the detected event is an actual attack. A score of 1 means that there is high confidence that the detected event is an attack. See the [Adaptive Protection documentation](https://cloud.google.com/armor/docs/adaptive-protection-overview#configure-alert-tuning) for further explanation. + "cloudArmor": { + "adaptiveProtection": { + "confidence": 3.14, }, - "attack": { # Information about DDoS attack volume and classification. # Information about DDoS attack volume and classification. - "classification": "A String", # Type of attack, for example, 'SYN-flood', 'NTP-udp', or 'CHARGEN-udp'. - "volumeBps": 42, # Total BPS (bytes per second) volume of attack. Deprecated - refer to volume_bps_long instead. - "volumeBpsLong": "A String", # Total BPS (bytes per second) volume of attack. - "volumePps": 42, # Total PPS (packets per second) volume of attack. Deprecated - refer to volume_pps_long instead. - "volumePpsLong": "A String", # Total PPS (packets per second) volume of attack. + "attack": { + "classification": "A String", + "volumeBps": 42, + "volumeBpsLong": "A String", + "volumePps": 42, + "volumePpsLong": "A String", }, - "duration": "A String", # Duration of attack from the start until the current moment (updated every 5 minutes). - "requests": { # Information about the requests relevant to the finding. # Information about incoming requests evaluated by [Google Cloud Armor security policies](https://cloud.google.com/armor/docs/security-policy-overview). - "longTermAllowed": 42, # Allowed RPS (requests per second) over the long term. - "longTermDenied": 42, # Denied RPS (requests per second) over the long term. - "ratio": 3.14, # For 'Increasing deny ratio', the ratio is the denied traffic divided by the allowed traffic. For 'Allowed traffic spike', the ratio is the allowed traffic in the short term divided by allowed traffic in the long term. - "shortTermAllowed": 42, # Allowed RPS (requests per second) in the short term. + "duration": "A String", + "requests": { + "longTermAllowed": 42, + "longTermDenied": 42, + "ratio": 3.14, + "shortTermAllowed": 42, }, - "securityPolicy": { # Information about the [Google Cloud Armor security policy](https://cloud.google.com/armor/docs/security-policy-overview) relevant to the finding. # Information about the [Google Cloud Armor security policy](https://cloud.google.com/armor/docs/security-policy-overview) relevant to the finding. - "name": "A String", # The name of the Google Cloud Armor security policy, for example, "my-security-policy". - "preview": True or False, # Whether or not the associated rule or policy is in preview mode. - "type": "A String", # The type of Google Cloud Armor security policy for example, 'backend security policy', 'edge security policy', 'network edge security policy', or 'always-on DDoS protection'. + "securityPolicy": { + "name": "A String", + "preview": True or False, + "type": "A String", }, - "threatVector": "A String", # Distinguish between volumetric & protocol DDoS attack and application layer attacks. For example, "L3_4" for Layer 3 and Layer 4 DDoS attacks, or "L_7" for Layer 7 DDoS attacks. + "threatVector": "A String", }, - "cloudDlpDataProfile": { # The [data profile](https://cloud.google.com/dlp/docs/data-profiles) associated with the finding. # Cloud DLP data profile that is associated with the finding. - "dataProfile": "A String", # Name of the data profile, for example, `projects/123/locations/europe/tableProfiles/8383929`. - "infoTypes": [ # Type of information detected by SDP. Info type includes name, version and sensitivity of the detected information type. - { # Type of information detected by the API. - "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. - "sensitivityScore": { # Score is calculated from of all elements in the data profile. A higher level means the data is more sensitive. # Optional custom sensitivity for this InfoType. This only applies to data profiling. - "score": "A String", # The sensitivity score applied to the resource. + "cloudDlpDataProfile": { + "dataProfile": "A String", + "infoTypes": [ + { + "name": "A String", + "sensitivityScore": { + "score": "A String", }, - "version": "A String", # Optional version name for this InfoType. + "version": "A String", }, ], - "parentType": "A String", # The resource hierarchy level at which the data profile was generated. + "parentType": "A String", }, - "cloudDlpInspection": { # Details about the Cloud Data Loss Prevention (Cloud DLP) [inspection job](https://cloud.google.com/dlp/docs/concepts-job-triggers) that produced the finding. # Cloud Data Loss Prevention (Cloud DLP) inspection results that are associated with the finding. - "fullScan": True or False, # Whether Cloud DLP scanned the complete resource or a sampled subset. - "infoType": "A String", # The type of information (or *[infoType](https://cloud.google.com/dlp/docs/infotypes-reference)*) found, for example, `EMAIL_ADDRESS` or `STREET_ADDRESS`. - "infoTypeCount": "A String", # The number of times Cloud DLP found this infoType within this job and resource. - "inspectJob": "A String", # Name of the inspection job, for example, `projects/123/locations/europe/dlpJobs/i-8383929`. + "cloudDlpInspection": { + "fullScan": True or False, + "infoType": "A String", + "infoTypeCount": "A String", + "inspectJob": "A String", }, - "complianceDetails": { # Compliance Details associated with the finding. # Details about the compliance implications of the finding. - "cloudControl": { # CloudControl associated with the finding. # CloudControl associated with the finding - "cloudControlName": "A String", # Name of the CloudControl associated with the finding. - "policyType": "A String", # Policy type of the CloudControl - "type": "A String", # Type of cloud control. - "version": 42, # Version of the Cloud Control + "complianceDetails": { + "cloudControl": { + "cloudControlName": "A String", + "policyType": "A String", + "type": "A String", + "version": 42, }, - "cloudControlDeploymentNames": [ # Cloud Control Deployments associated with the finding. For example, organizations/123/locations/global/cloudControlDeployments/deploymentIdentifier + "cloudControlDeploymentNames": [ "A String", ], - "frameworks": [ # Details of Frameworks associated with the finding - { # Compliance framework associated with the finding. - "category": [ # Category of the framework associated with the finding. E.g. Security Benchmark, or Assured Workloads + "frameworks": [ + { + "category": [ "A String", ], - "controls": [ # The controls associated with the framework. - { # Compliance control associated with the finding. - "controlName": "A String", # Name of the Control - "displayName": "A String", # Display name of the control. For example, AU-02. + "controls": [ + { + "controlName": "A String", + "displayName": "A String", }, ], - "displayName": "A String", # Display name of the framework. For a standard framework, this will look like e.g. PCI DSS 3.2.1, whereas for a custom framework it can be a user defined string like MyFramework - "name": "A String", # Name of the framework associated with the finding - "type": "A String", # Type of the framework associated with the finding, to specify whether the framework is built-in (pre-defined and immutable) or a custom framework defined by the customer (equivalent to security posture) + "displayName": "A String", + "name": "A String", + "type": "A String", }, ], }, - "compliances": [ # Contains compliance information for security standards associated to the finding. - { # Contains compliance information about a security standard indicating unmet recommendations. - "ids": [ # Policies within the standard or benchmark, for example, A.12.4.1 + "compliances": [ + { + "ids": [ "A String", ], - "standard": "A String", # Industry-wide compliance standards or benchmarks, such as CIS, PCI, and OWASP. - "version": "A String", # Version of the standard or benchmark, for example, 1.1 + "standard": "A String", + "version": "A String", }, ], - "connections": [ # Contains information about the IP connection associated with the finding. - { # Contains information about the IP connection associated with the finding. - "destinationIp": "A String", # Destination IP address. Not present for sockets that are listening and not connected. - "destinationPort": 42, # Destination port. Not present for sockets that are listening and not connected. - "protocol": "A String", # IANA Internet Protocol Number such as TCP(6) and UDP(17). - "sourceIp": "A String", # Source IP address. - "sourcePort": 42, # Source port. + "connections": [ + { + "destinationIp": "A String", + "destinationPort": 42, + "protocol": "A String", + "sourceIp": "A String", + "sourcePort": 42, }, ], - "contacts": { # Output only. Map containing the points of contact for the given finding. The key represents the type of contact, while the value contains a list of all the contacts that pertain. Please refer to: https://cloud.google.com/resource-manager/docs/managing-notification-contacts#notification-categories { "security": { "contacts": [ { "email": "person1@company.com" }, { "email": "person2@company.com" } ] } } - "a_key": { # Details about specific contacts - "contacts": [ # A list of contacts - { # The email address of a contact. - "email": "A String", # An email address. For example, "`person123@company.com`". + "contacts": { + "a_key": { + "contacts": [ + { + "email": "A String", }, ], }, }, - "containers": [ # Containers associated with the finding. This field provides information for both Kubernetes and non-Kubernetes containers. - { # Container associated with the finding. - "createTime": "A String", # The time that the container was created. - "imageId": "A String", # Optional container image ID, if provided by the container runtime. Uniquely identifies the container image launched using a container image digest. - "labels": [ # Container labels, as provided by the container runtime. - { # Represents a generic name-value label. A label has separate name and value fields to support filtering with the `contains()` function. For more information, see [Filtering on array-type fields](https://cloud.google.com/security-command-center/docs/how-to-api-list-findings#array-contains-filtering). - "name": "A String", # Name of the label. - "value": "A String", # Value that corresponds to the label's name. + "containers": [ + { + "createTime": "A String", + "imageId": "A String", + "labels": [ + { + "name": "A String", + "value": "A String", }, ], - "name": "A String", # Name of the container. - "uri": "A String", # Container image URI provided when configuring a pod or container. This string can identify a container image version using mutable tags. + "name": "A String", + "uri": "A String", }, ], - "createTime": "A String", # The time at which the finding was created in Security Command Center. - "dataAccessEvents": [ # Data access events associated with the finding. - { # Details about a data access attempt made by a principal not authorized under applicable data security policy. - "eventId": "A String", # Unique identifier for data access event. - "eventTime": "A String", # Timestamp of data access event. - "operation": "A String", # The operation performed by the principal to access the data. - "principalEmail": "A String", # The email address of the principal that accessed the data. The principal could be a user account, service account, Google group, or other. + "createTime": "A String", + "dataAccessEvents": [ + { + "eventId": "A String", + "eventTime": "A String", + "operation": "A String", + "principalEmail": "A String", }, ], - "dataFlowEvents": [ # Data flow events associated with the finding. - { # Details about a data flow event, in which either the data is moved to or is accessed from a non-compliant geo-location, as defined in the applicable data security policy. - "eventId": "A String", # Unique identifier for data flow event. - "eventTime": "A String", # Timestamp of data flow event. - "operation": "A String", # The operation performed by the principal for the data flow event. - "principalEmail": "A String", # The email address of the principal that initiated the data flow event. The principal could be a user account, service account, Google group, or other. - "violatedLocation": "A String", # Non-compliant location of the principal or the data destination. + "dataFlowEvents": [ + { + "eventId": "A String", + "eventTime": "A String", + "operation": "A String", + "principalEmail": "A String", + "violatedLocation": "A String", }, ], - "dataRetentionDeletionEvents": [ # Data retention deletion events associated with the finding. - { # Details about data retention deletion violations, in which the data is non-compliant based on their retention or deletion time, as defined in the applicable data security policy. The Data Retention Deletion (DRD) control is a control of the DSPM (Data Security Posture Management) suite that enables organizations to manage data retention and deletion policies in compliance with regulations, such as GDPR and CRPA. DRD supports two primary policy types: maximum storage length (max TTL) and minimum storage length (min TTL). Both are aimed at helping organizations meet regulatory and data management commitments. - "dataObjectCount": "A String", # Number of objects that violated the policy for this resource. If the number is less than 1,000, then the value of this field is the exact number. If the number of objects that violated the policy is greater than or equal to 1,000, then the value of this field is 1000. - "eventDetectionTime": "A String", # Timestamp indicating when the event was detected. - "eventType": "A String", # Type of the DRD event. - "maxRetentionAllowed": "A String", # Maximum duration of retention allowed from the DRD control. This comes from the DRD control where users set a max TTL for their data. For example, suppose that a user sets the max TTL for a Cloud Storage bucket to 90 days. However, an object in that bucket is 100 days old. In this case, a DataRetentionDeletionEvent will be generated for that Cloud Storage bucket, and the max_retention_allowed is 90 days. - "minRetentionAllowed": "A String", # Min duration of retention allowed from the DSPM retention control. This field is only populated when event type is set to EVENT_TYPE_MIN_TTL_FROM_CREATION. + "dataRetentionDeletionEvents": [ + { + "dataObjectCount": "A String", + "eventDetectionTime": "A String", + "eventType": "A String", + "maxRetentionAllowed": "A String", + "minRetentionAllowed": "A String", }, ], - "database": { # Represents database access information, such as queries. A database may be a sub-resource of an instance (as in the case of Cloud SQL instances or Cloud Spanner instances), or the database instance itself. Some database resources might not have the [full resource name](https://google.aip.dev/122#full-resource-names) populated because these resource types, such as Cloud SQL databases, are not yet supported by Cloud Asset Inventory. In these cases only the display name is provided. # Database associated with the finding. - "displayName": "A String", # The human-readable name of the database that the user connected to. - "grantees": [ # The target usernames, roles, or groups of an SQL privilege grant, which is not an IAM policy change. + "database": { + "displayName": "A String", + "grantees": [ "A String", ], - "name": "A String", # Some database resources may not have the [full resource name](https://google.aip.dev/122#full-resource-names) populated because these resource types are not yet supported by Cloud Asset Inventory (e.g. Cloud SQL databases). In these cases only the display name will be provided. The [full resource name](https://google.aip.dev/122#full-resource-names) of the database that the user connected to, if it is supported by Cloud Asset Inventory. - "query": "A String", # The SQL statement that is associated with the database access. - "userName": "A String", # The username used to connect to the database. The username might not be an IAM principal and does not have a set format. - "version": "A String", # The version of the database, for example, POSTGRES_14. See [the complete list](https://cloud.google.com/sql/docs/mysql/admin-api/rest/v1/SqlDatabaseVersion). + "name": "A String", + "query": "A String", + "userName": "A String", + "version": "A String", }, - "description": "A String", # Contains more details about the finding. - "discoveredWorkload": { # Represents discovered, customer managed workload that is not registered with the respective GCP service. # DiscoveredWorkload associated with the finding. - "confidence": "A String", # The confidence in detection of this workload. - "detectedRelevantHardware": True or False, # A boolean flag set to true if associated hardware strongly predicts the workload type. - "detectedRelevantKeywords": True or False, # A boolean flag set to true if associated keywords strongly predict the workload type. - "detectedRelevantPackages": True or False, # A boolean flag set to true if installed packages strongly predict the workload type. - "workloadType": "A String", # The type of workload. + "description": "A String", + "discoveredWorkload": { + "confidence": "A String", + "detectedRelevantHardware": True or False, + "detectedRelevantKeywords": True or False, + "detectedRelevantPackages": True or False, + "workloadType": "A String", }, - "disk": { # Contains information about the disk associated with the finding. # Disk associated with the finding. - "name": "A String", # The name of the disk, for example, "https://www.googleapis.com/compute/v1/projects/{project-id}/zones/{zone-id}/disks/{disk-id}". + "disk": { + "name": "A String", }, - "eventTime": "A String", # The time the finding was first detected. If an existing finding is updated, then this is the time the update occurred. For example, if the finding represents an open firewall, this property captures the time the detector believes the firewall became open. The accuracy is determined by the detector. If the finding is later resolved, then this time reflects when the finding was resolved. This must not be set to a value greater than the current timestamp. - "exfiltration": { # Exfiltration represents a data exfiltration attempt from one or more sources to one or more targets. The `sources` attribute lists the sources of the exfiltrated data. The `targets` attribute lists the destinations the data was copied to. # Represents exfiltrations associated with the finding. - "sources": [ # If there are multiple sources, then the data is considered "joined" between them. For instance, BigQuery can join multiple tables, and each table would be considered a source. - { # Resource where data was exfiltrated from or exfiltrated to. - "components": [ # Subcomponents of the asset that was exfiltrated, like URIs used during exfiltration, table names, databases, and filenames. For example, multiple tables might have been exfiltrated from the same Cloud SQL instance, or multiple files might have been exfiltrated from the same Cloud Storage bucket. + "eventTime": "A String", + "exfiltration": { + "sources": [ + { + "components": [ "A String", ], - "name": "A String", # The resource's [full resource name](https://cloud.google.com/apis/design/resource_names#full_resource_name). + "name": "A String", }, ], - "targets": [ # If there are multiple targets, each target would get a complete copy of the "joined" source data. - { # Resource where data was exfiltrated from or exfiltrated to. - "components": [ # Subcomponents of the asset that was exfiltrated, like URIs used during exfiltration, table names, databases, and filenames. For example, multiple tables might have been exfiltrated from the same Cloud SQL instance, or multiple files might have been exfiltrated from the same Cloud Storage bucket. + "targets": [ + { + "components": [ "A String", ], - "name": "A String", # The resource's [full resource name](https://cloud.google.com/apis/design/resource_names#full_resource_name). + "name": "A String", }, ], - "totalExfiltratedBytes": "A String", # Total exfiltrated bytes processed for the entire job. + "totalExfiltratedBytes": "A String", }, - "externalExposure": { # Details about the externally exposed resource associated with the finding. # External exposure associated with the finding. - "backendBucket": "A String", # The full resource name of the load balancer backend bucket, for example, "//compute.googleapis.com/projects/{project-id}/global/backendBuckets/{name}" - "backendService": "A String", # The full resource name of load balancer backend service, for example, "//compute.googleapis.com/projects/{project-id}/global/backendServices/{name}". - "exposedApplication": "A String", # The name and version of the exposed web application, for example, "Jenkins 2.184". - "exposedEndpoint": "A String", # The resource which is running the exposed service, for example, "//compute.googleapis.com/projects/{project-id}/zones/{zone}/instances/{instance}.” - "exposedService": "A String", # The name and version of the service, for example, "Jupyter Notebook 6.14.0". - "forwardingRule": "A String", # The full resource name of the forwarding rule, for example, "//compute.googleapis.com/projects/{project-id}/global/forwardingRules/{forwarding-rule-name}". - "hostnameUri": "A String", # Hostname of the exposed application, for example, "https://test-app.a.run.app/" - "httpResponse": [ # The http response returned by the web application. - { # The http response returned by the web application. - "path": "A String", # The http path for which response code was returned by web application, for example, "https://test-app.a.run.app/test". - "statusCode": "A String", # The http response code returned by the web application, for example, 200. + "externalExposure": { + "backendBucket": "A String", + "backendService": "A String", + "exposedApplication": "A String", + "exposedEndpoint": "A String", + "exposedService": "A String", + "forwardingRule": "A String", + "hostnameUri": "A String", + "httpResponse": [ + { + "path": "A String", + "statusCode": "A String", }, ], - "instanceGroup": "A String", # The full resource name of the instance group, for example, "//compute.googleapis.com/projects/{project-id}/global/instanceGroups/{name}". - "internalBackendService": "A String", # The full resource name of load balancer backend service in the internal project having resource exposed via PSC, for example, "//compute.googleapis.com/projects/{project-id}/global/backendServices/{name}". - "loadBalancerFirewallPolicy": "A String", # The full resource name of the load balancer firewall policy, for example, "//compute.googleapis.com/projects/{project-id}/global/firewallPolicies/{policy-name}". - "networkEndpointGroup": "A String", # The full resource name of the network endpoint group, for example, "//compute.googleapis.com/projects/{project-id}/global/networkEndpointGroups/{name}". - "networkIngressFirewallPolicy": "A String", # The full resource name of the network ingress firewall policy, for example, "//compute.googleapis.com/projects/{project-id}/global/firewallPolicies/{name}". - "privateIpAddress": "A String", # Private IP address of the exposed endpoint. - "privatePort": "A String", # Port number associated with private IP address. - "pscNetworkAttachment": "A String", # The full resource name of the PSC (Private Service Connect) network attachment that network interface controller is attached to, for example, "//compute.googleapis.com/projects/{project-id}/regions/{region}/networkAttachments/{name}" - "pscServiceAttachment": "A String", # The full resource name of the PSC (Private Service Connect) service attachment that the load balancer network endpoint group targets, for example, "//compute.googleapis.com/projects/{project-id}/regions/{region}/serviceAttachments/{name}" - "publicIpAddress": "A String", # Public IP address of the exposed endpoint. - "publicPort": "A String", # Public port number of the exposed endpoint. - "serviceFirewallPolicy": "A String", # The full resource name of the firewall policy of the exposed service, for example, "//compute.googleapis.com/projects/{project-id}/global/firewallPolicies/{policy-name}". + "instanceGroup": "A String", + "internalBackendService": "A String", + "loadBalancerFirewallPolicy": "A String", + "networkEndpointGroup": "A String", + "networkIngressFirewallPolicy": "A String", + "privateIpAddress": "A String", + "privatePort": "A String", + "pscNetworkAttachment": "A String", + "pscServiceAttachment": "A String", + "publicIpAddress": "A String", + "publicPort": "A String", + "serviceFirewallPolicy": "A String", }, - "externalSystems": { # Output only. Third party SIEM/SOAR fields within SCC, contains external system information and external system finding fields. - "a_key": { # Representation of third party SIEM/SOAR fields within SCC. - "assignees": [ # References primary/secondary etc assignees in the external system. + "externalSystems": { + "a_key": { + "assignees": [ "A String", ], - "caseCloseTime": "A String", # The time when the case was closed, as reported by the external system. - "caseCreateTime": "A String", # The time when the case was created, as reported by the external system. - "casePriority": "A String", # The priority of the finding's corresponding case in the external system. - "caseSla": "A String", # The SLA of the finding's corresponding case in the external system. - "caseUri": "A String", # The link to the finding's corresponding case in the external system. - "externalSystemUpdateTime": "A String", # The time when the case was last updated, as reported by the external system. - "externalUid": "A String", # The identifier that's used to track the finding's corresponding case in the external system. - "name": "A String", # Full resource name of the external system, for example: "organizations/1234/sources/5678/findings/123456/externalSystems/jira", "folders/1234/sources/5678/findings/123456/externalSystems/jira", "projects/1234/sources/5678/findings/123456/externalSystems/jira" - "status": "A String", # The most recent status of the finding's corresponding case, as reported by the external system. - "ticketInfo": { # Information about the ticket, if any, that is being used to track the resolution of the issue that is identified by this finding. # Information about the ticket, if any, that is being used to track the resolution of the issue that is identified by this finding. - "assignee": "A String", # The assignee of the ticket in the ticket system. - "description": "A String", # The description of the ticket in the ticket system. - "id": "A String", # The identifier of the ticket in the ticket system. - "status": "A String", # The latest status of the ticket, as reported by the ticket system. - "updateTime": "A String", # The time when the ticket was last updated, as reported by the ticket system. - "uri": "A String", # The link to the ticket in the ticket system. + "caseCloseTime": "A String", + "caseCreateTime": "A String", + "casePriority": "A String", + "caseSla": "A String", + "caseUri": "A String", + "externalSystemUpdateTime": "A String", + "externalUid": "A String", + "name": "A String", + "status": "A String", + "ticketInfo": { + "assignee": "A String", + "description": "A String", + "id": "A String", + "status": "A String", + "updateTime": "A String", + "uri": "A String", }, }, }, - "externalUri": "A String", # The URI that, if available, points to a web page outside of Security Command Center where additional information about the finding can be found. This field is guaranteed to be either empty or a well formed URL. - "files": [ # File associated with the finding. - { # File information about the related binary/library used by an executable, or the script used by a script interpreter - "contents": "A String", # Prefix of the file contents as a JSON-encoded string. - "diskPath": { # Path of the file in terms of underlying disk/partition identifiers. # Path of the file in terms of underlying disk/partition identifiers. - "partitionUuid": "A String", # UUID of the partition (format https://wiki.archlinux.org/title/persistent_block_device_naming#by-uuid) - "relativePath": "A String", # Relative path of the file in the partition as a JSON encoded string. Example: /home/user1/executable_file.sh + "externalUri": "A String", + "files": [ + { + "contents": "A String", + "diskPath": { + "partitionUuid": "A String", + "relativePath": "A String", }, - "fileLoadState": "A String", # The load state of the file. - "hashedSize": "A String", # The length in bytes of the file prefix that was hashed. If hashed_size == size, any hashes reported represent the entire file. - "operations": [ # Operation(s) performed on a file. - { # Operation(s) performed on a file. - "type": "A String", # The type of the operation + "fileLoadState": "A String", + "hashedSize": "A String", + "operations": [ + { + "type": "A String", }, ], - "partiallyHashed": True or False, # True when the hash covers only a prefix of the file. - "path": "A String", # Absolute path of the file as a JSON encoded string. - "sha256": "A String", # SHA256 hash of the first hashed_size bytes of the file encoded as a hex string. If hashed_size == size, sha256 represents the SHA256 hash of the entire file. - "size": "A String", # Size of the file in bytes. + "partiallyHashed": True or False, + "path": "A String", + "sha256": "A String", + "size": "A String", }, ], - "findingClass": "A String", # The class of the finding. - "groupMemberships": [ # Contains details about groups of which this finding is a member. A group is a collection of findings that are related in some way. This field cannot be updated. Its value is ignored in all update requests. - { # Contains details about groups of which this finding is a member. A group is a collection of findings that are related in some way. - "groupId": "A String", # ID of the group. - "groupType": "A String", # Type of group. + "findingClass": "A String", + "groupMemberships": [ + { + "groupId": "A String", + "groupType": "A String", }, ], - "iamBindings": [ # Represents IAM bindings associated with the finding. - { # Represents a particular IAM binding, which captures a member's role addition, removal, or state. - "action": "A String", # The action that was performed on a Binding. - "member": "A String", # A single identity requesting access for a Cloud Platform resource, for example, "foo@google.com". - "role": "A String", # Role that is assigned to "members". For example, "roles/viewer", "roles/editor", or "roles/owner". + "iamBindings": [ + { + "action": "A String", + "member": "A String", + "role": "A String", }, ], - "indicator": { # Represents what's commonly known as an _indicator of compromise_ (IoC) in computer forensics. This is an artifact observed on a network or in an operating system that, with high confidence, indicates a computer intrusion. For more information, see [Indicator of compromise](https://en.wikipedia.org/wiki/Indicator_of_compromise). # Represents what's commonly known as an *indicator of compromise* (IoC) in computer forensics. This is an artifact observed on a network or in an operating system that, with high confidence, indicates a computer intrusion. For more information, see [Indicator of compromise](https://en.wikipedia.org/wiki/Indicator_of_compromise). - "domains": [ # List of domains associated to the Finding. + "indicator": { + "domains": [ "A String", ], - "ipAddresses": [ # The list of IP addresses that are associated with the finding. + "ipAddresses": [ "A String", ], - "signatures": [ # The list of matched signatures indicating that the given process is present in the environment. - { # Indicates what signature matched this process. - "memoryHashSignature": { # A signature corresponding to memory page hashes. # Signature indicating that a binary family was matched. - "binaryFamily": "A String", # The binary family. - "detections": [ # The list of memory hash detections contributing to the binary family match. - { # Memory hash detection contributing to the binary family match. - "binary": "A String", # The name of the binary associated with the memory hash signature detection. - "percentPagesMatched": 3.14, # The percentage of memory page hashes in the signature that were matched. + "signatures": [ + { + "memoryHashSignature": { + "binaryFamily": "A String", + "detections": [ + { + "binary": "A String", + "percentPagesMatched": 3.14, }, ], }, - "signatureType": "A String", # Describes the type of resource associated with the signature. - "yaraRuleSignature": { # A signature corresponding to a YARA rule. # Signature indicating that a YARA rule was matched. - "yaraRule": "A String", # The name of the YARA rule. + "signatureType": "A String", + "yaraRuleSignature": { + "yaraRule": "A String", }, }, ], - "uris": [ # The list of URIs associated to the Findings. + "uris": [ "A String", ], }, - "ipRules": { # IP rules associated with the finding. # IP rules associated with the finding. - "allowed": { # Allowed IP rule. # Tuple with allowed rules. - "ipRules": [ # Optional. Optional list of allowed IP rules. - { # IP rule information. - "portRanges": [ # Optional. An optional list of ports to which this rule applies. This field is only applicable for the UDP or (S)TCP protocols. Each entry must be either an integer or a range including a min and max port number. - { # A port range which is inclusive of the min and max values. Values are between 0 and 2^16-1. The max can be equal / must be not smaller than the min value. If min and max are equal this indicates that it is a single port. - "max": "A String", # Maximum port value. - "min": "A String", # Minimum port value. + "ipRules": { + "allowed": { + "ipRules": [ + { + "portRanges": [ + { + "max": "A String", + "min": "A String", }, ], - "protocol": "A String", # The IP protocol this rule applies to. This value can either be one of the following well known protocol strings (TCP, UDP, ICMP, ESP, AH, IPIP, SCTP) or a string representation of the integer value. + "protocol": "A String", }, ], }, - "denied": { # Denied IP rule. # Tuple with denied rules. - "ipRules": [ # Optional. Optional list of denied IP rules. - { # IP rule information. - "portRanges": [ # Optional. An optional list of ports to which this rule applies. This field is only applicable for the UDP or (S)TCP protocols. Each entry must be either an integer or a range including a min and max port number. - { # A port range which is inclusive of the min and max values. Values are between 0 and 2^16-1. The max can be equal / must be not smaller than the min value. If min and max are equal this indicates that it is a single port. - "max": "A String", # Maximum port value. - "min": "A String", # Minimum port value. + "denied": { + "ipRules": [ + { + "portRanges": [ + { + "max": "A String", + "min": "A String", }, ], - "protocol": "A String", # The IP protocol this rule applies to. This value can either be one of the following well known protocol strings (TCP, UDP, ICMP, ESP, AH, IPIP, SCTP) or a string representation of the integer value. + "protocol": "A String", }, ], }, - "destinationIpRanges": [ # If destination IP ranges are specified, the firewall rule applies only to traffic that has a destination IP address in these ranges. These ranges must be expressed in CIDR format. Only supports IPv4. + "destinationIpRanges": [ "A String", ], - "direction": "A String", # The direction that the rule is applicable to, one of ingress or egress. - "exposedServices": [ # Name of the network protocol service, such as FTP, that is exposed by the open port. Follows the naming convention available at: https://www.iana.org/assignments/service-names-port-numbers/service-names-port-numbers.xhtml. + "direction": "A String", + "exposedServices": [ "A String", ], - "sourceIpRanges": [ # If source IP ranges are specified, the firewall rule applies only to traffic that has a source IP address in these ranges. These ranges must be expressed in CIDR format. Only supports IPv4. + "sourceIpRanges": [ "A String", ], }, - "job": { # Describes a job # Job associated with the finding. - "errorCode": 42, # Optional. If the job did not complete successfully, this field describes why. - "location": "A String", # Optional. Gives the location where the job ran, such as `US` or `europe-west1` - "name": "A String", # The fully-qualified name for a job. e.g. `projects//jobs/` - "state": "A String", # Output only. State of the job, such as `RUNNING` or `PENDING`. + "job": { + "errorCode": 42, + "location": "A String", + "name": "A String", + "state": "A String", }, - "kernelRootkit": { # Kernel mode rootkit signatures. # Signature of the kernel rootkit. - "name": "A String", # Rootkit name, when available. - "unexpectedCodeModification": True or False, # True if unexpected modifications of kernel code memory are present. - "unexpectedFtraceHandler": True or False, # True if `ftrace` points are present with callbacks pointing to regions that are not in the expected kernel or module code range. - "unexpectedInterruptHandler": True or False, # True if interrupt handlers that are are not in the expected kernel or module code regions are present. - "unexpectedKernelCodePages": True or False, # True if kernel code pages that are not in the expected kernel or module code regions are present. - "unexpectedKprobeHandler": True or False, # True if `kprobe` points are present with callbacks pointing to regions that are not in the expected kernel or module code range. - "unexpectedProcessesInRunqueue": True or False, # True if unexpected processes in the scheduler run queue are present. Such processes are in the run queue, but not in the process task list. - "unexpectedReadOnlyDataModification": True or False, # True if unexpected modifications of kernel read-only data memory are present. - "unexpectedSystemCallHandler": True or False, # True if system call handlers that are are not in the expected kernel or module code regions are present. + "kernelRootkit": { + "name": "A String", + "unexpectedCodeModification": True or False, + "unexpectedFtraceHandler": True or False, + "unexpectedInterruptHandler": True or False, + "unexpectedKernelCodePages": True or False, + "unexpectedKprobeHandler": True or False, + "unexpectedProcessesInRunqueue": True or False, + "unexpectedReadOnlyDataModification": True or False, + "unexpectedSystemCallHandler": True or False, }, - "kubernetes": { # Kubernetes-related attributes. # Kubernetes resources associated with the finding. - "accessReviews": [ # Provides information on any Kubernetes access reviews (privilege checks) relevant to the finding. - { # Conveys information about a Kubernetes access review (such as one returned by a [`kubectl auth can-i`](https://kubernetes.io/docs/reference/access-authn-authz/authorization/#checking-api-access) command) that was involved in a finding. - "group": "A String", # The API group of the resource. "*" means all. - "name": "A String", # The name of the resource being requested. Empty means all. - "ns": "A String", # Namespace of the action being requested. Currently, there is no distinction between no namespace and all namespaces. Both are represented by "" (empty). - "resource": "A String", # The optional resource type requested. "*" means all. - "subresource": "A String", # The optional subresource type. - "verb": "A String", # A Kubernetes resource API verb, like get, list, watch, create, update, delete, proxy. "*" means all. - "version": "A String", # The API version of the resource. "*" means all. + "kubernetes": { + "accessReviews": [ + { + "group": "A String", + "name": "A String", + "ns": "A String", + "resource": "A String", + "subresource": "A String", + "verb": "A String", + "version": "A String", }, ], - "bindings": [ # Provides Kubernetes role binding information for findings that involve [RoleBindings or ClusterRoleBindings](https://cloud.google.com/kubernetes-engine/docs/how-to/role-based-access-control). - { # Represents a Kubernetes RoleBinding or ClusterRoleBinding. - "name": "A String", # Name for the binding. - "ns": "A String", # Namespace for the binding. - "role": { # Kubernetes Role or ClusterRole. # The Role or ClusterRole referenced by the binding. - "kind": "A String", # Role type. - "name": "A String", # Role name. - "ns": "A String", # Role namespace. + "bindings": [ + { + "name": "A String", + "ns": "A String", + "role": { + "kind": "A String", + "name": "A String", + "ns": "A String", }, - "subjects": [ # Represents one or more subjects that are bound to the role. Not always available for PATCH requests. - { # Represents a Kubernetes subject. - "kind": "A String", # Authentication type for the subject. - "name": "A String", # Name for the subject. - "ns": "A String", # Namespace for the subject. + "subjects": [ + { + "kind": "A String", + "name": "A String", + "ns": "A String", }, ], }, ], - "nodePools": [ # GKE [node pools](https://cloud.google.com/kubernetes-engine/docs/concepts/node-pools) associated with the finding. This field contains node pool information for each node, when it is available. - { # Provides GKE node pool information. - "name": "A String", # Kubernetes node pool name. - "nodes": [ # Nodes associated with the finding. - { # Kubernetes nodes associated with the finding. - "name": "A String", # [Full resource name](https://google.aip.dev/122#full-resource-names) of the Compute Engine VM running the cluster node. + "nodePools": [ + { + "name": "A String", + "nodes": [ + { + "name": "A String", }, ], }, ], - "nodes": [ # Provides Kubernetes [node](https://cloud.google.com/kubernetes-engine/docs/concepts/cluster-architecture#nodes) information. - { # Kubernetes nodes associated with the finding. - "name": "A String", # [Full resource name](https://google.aip.dev/122#full-resource-names) of the Compute Engine VM running the cluster node. + "nodes": [ + { + "name": "A String", }, ], - "objects": [ # Kubernetes objects related to the finding. - { # Kubernetes object related to the finding, uniquely identified by GKNN. Used if the object Kind is not one of Pod, Node, NodePool, Binding, or AccessReview. - "containers": [ # Pod containers associated with this finding, if any. - { # Container associated with the finding. - "createTime": "A String", # The time that the container was created. - "imageId": "A String", # Optional container image ID, if provided by the container runtime. Uniquely identifies the container image launched using a container image digest. - "labels": [ # Container labels, as provided by the container runtime. - { # Represents a generic name-value label. A label has separate name and value fields to support filtering with the `contains()` function. For more information, see [Filtering on array-type fields](https://cloud.google.com/security-command-center/docs/how-to-api-list-findings#array-contains-filtering). - "name": "A String", # Name of the label. - "value": "A String", # Value that corresponds to the label's name. + "objects": [ + { + "containers": [ + { + "createTime": "A String", + "imageId": "A String", + "labels": [ + { + "name": "A String", + "value": "A String", }, ], - "name": "A String", # Name of the container. - "uri": "A String", # Container image URI provided when configuring a pod or container. This string can identify a container image version using mutable tags. + "name": "A String", + "uri": "A String", }, ], - "group": "A String", # Kubernetes object group, such as "policy.k8s.io/v1". - "kind": "A String", # Kubernetes object kind, such as "Namespace". - "name": "A String", # Kubernetes object name. For details see https://kubernetes.io/docs/concepts/overview/working-with-objects/names/. - "ns": "A String", # Kubernetes object namespace. Must be a valid DNS label. Named "ns" to avoid collision with C++ namespace keyword. For details see https://kubernetes.io/docs/tasks/administer-cluster/namespaces/. + "group": "A String", + "kind": "A String", + "name": "A String", + "ns": "A String", }, ], - "pods": [ # Kubernetes [Pods](https://cloud.google.com/kubernetes-engine/docs/concepts/pod) associated with the finding. This field contains Pod records for each container that is owned by a Pod. - { # A Kubernetes Pod. - "containers": [ # Pod containers associated with this finding, if any. - { # Container associated with the finding. - "createTime": "A String", # The time that the container was created. - "imageId": "A String", # Optional container image ID, if provided by the container runtime. Uniquely identifies the container image launched using a container image digest. - "labels": [ # Container labels, as provided by the container runtime. - { # Represents a generic name-value label. A label has separate name and value fields to support filtering with the `contains()` function. For more information, see [Filtering on array-type fields](https://cloud.google.com/security-command-center/docs/how-to-api-list-findings#array-contains-filtering). - "name": "A String", # Name of the label. - "value": "A String", # Value that corresponds to the label's name. + "pods": [ + { + "containers": [ + { + "createTime": "A String", + "imageId": "A String", + "labels": [ + { + "name": "A String", + "value": "A String", }, ], - "name": "A String", # Name of the container. - "uri": "A String", # Container image URI provided when configuring a pod or container. This string can identify a container image version using mutable tags. + "name": "A String", + "uri": "A String", }, ], - "labels": [ # Pod labels. For Kubernetes containers, these are applied to the container. - { # Represents a generic name-value label. A label has separate name and value fields to support filtering with the `contains()` function. For more information, see [Filtering on array-type fields](https://cloud.google.com/security-command-center/docs/how-to-api-list-findings#array-contains-filtering). - "name": "A String", # Name of the label. - "value": "A String", # Value that corresponds to the label's name. + "labels": [ + { + "name": "A String", + "value": "A String", }, ], - "name": "A String", # Kubernetes Pod name. - "ns": "A String", # Kubernetes Pod namespace. + "name": "A String", + "ns": "A String", }, ], - "roles": [ # Provides Kubernetes role information for findings that involve [Roles or ClusterRoles](https://cloud.google.com/kubernetes-engine/docs/how-to/role-based-access-control). - { # Kubernetes Role or ClusterRole. - "kind": "A String", # Role type. - "name": "A String", # Role name. - "ns": "A String", # Role namespace. + "roles": [ + { + "kind": "A String", + "name": "A String", + "ns": "A String", }, ], }, - "loadBalancers": [ # The load balancers associated with the finding. - { # Contains information related to the load balancer associated with the finding. - "name": "A String", # The name of the load balancer associated with the finding. + "loadBalancers": [ + { + "name": "A String", }, ], - "logEntries": [ # Log entries that are relevant to the finding. - { # An individual entry in a log. - "cloudLoggingEntry": { # Metadata taken from a [Cloud Logging LogEntry](https://cloud.google.com/logging/docs/reference/v2/rest/v2/LogEntry) # An individual entry in a log stored in Cloud Logging. - "insertId": "A String", # A unique identifier for the log entry. - "logId": "A String", # The type of the log (part of `log_name`. `log_name` is the resource name of the log to which this log entry belongs). For example: `cloudresourcemanager.googleapis.com/activity`. Note that this field is not URL-encoded, unlike the `LOG_ID` field in `LogEntry`. - "resourceContainer": "A String", # The organization, folder, or project of the monitored resource that produced this log entry. - "timestamp": "A String", # The time the event described by the log entry occurred. + "logEntries": [ + { + "cloudLoggingEntry": { + "insertId": "A String", + "logId": "A String", + "resourceContainer": "A String", + "timestamp": "A String", }, }, ], - "mitreAttack": { # MITRE ATT&CK tactics and techniques related to this finding. See: https://attack.mitre.org # MITRE ATT&CK tactics and techniques related to this finding. See: https://attack.mitre.org - "additionalTactics": [ # Additional MITRE ATT&CK tactics related to this finding, if any. + "mitreAttack": { + "additionalTactics": [ "A String", ], - "additionalTechniques": [ # Additional MITRE ATT&CK techniques related to this finding, if any, along with any of their respective parent techniques. + "additionalTechniques": [ "A String", ], - "primaryTactic": "A String", # The MITRE ATT&CK tactic most closely represented by this finding, if any. - "primaryTechniques": [ # The MITRE ATT&CK technique most closely represented by this finding, if any. primary_techniques is a repeated field because there are multiple levels of MITRE ATT&CK techniques. If the technique most closely represented by this finding is a sub-technique (e.g. `SCANNING_IP_BLOCKS`), both the sub-technique and its parent technique(s) will be listed (e.g. `SCANNING_IP_BLOCKS`, `ACTIVE_SCANNING`). + "primaryTactic": "A String", + "primaryTechniques": [ "A String", ], - "version": "A String", # The MITRE ATT&CK version referenced by the above fields. E.g. "8". + "version": "A String", }, - "moduleName": "A String", # Unique identifier of the module which generated the finding. Example: folders/598186756061/securityHealthAnalyticsSettings/customModules/56799441161885 - "mute": "A String", # Indicates the mute state of a finding (either muted, unmuted or undefined). Unlike other attributes of a finding, a finding provider shouldn't set the value of mute. - "muteInfo": { # Mute information about the finding, including whether the finding has a static mute or any matching dynamic mute rules. # Output only. The mute information regarding this finding. - "dynamicMuteRecords": [ # The list of dynamic mute rules that currently match the finding. - { # The record of a dynamic mute rule that matches the finding. - "matchTime": "A String", # When the dynamic mute rule first matched the finding. - "muteConfig": "A String", # The relative resource name of the mute rule, represented by a mute config, that created this record, for example `organizations/123/muteConfigs/mymuteconfig` or `organizations/123/locations/global/muteConfigs/mymuteconfig`. + "moduleName": "A String", + "mute": "A String", + "muteInfo": { + "dynamicMuteRecords": [ + { + "matchTime": "A String", + "muteConfig": "A String", }, ], - "staticMute": { # Information about the static mute state. A static mute state overrides any dynamic mute rules that apply to this finding. The static mute state can be set by a static mute rule or by muting the finding directly. # If set, the static mute applied to this finding. Static mutes override dynamic mutes. If unset, there is no static mute. - "applyTime": "A String", # When the static mute was applied. - "state": "A String", # The static mute state. If the value is `MUTED` or `UNMUTED`, then the finding's overall mute state will have the same value. + "staticMute": { + "applyTime": "A String", + "state": "A String", }, }, - "muteInitiator": "A String", # Records additional information about the mute operation, for example, the [mute configuration](/security-command-center/docs/how-to-mute-findings) that muted the finding and the user who muted the finding. - "muteUpdateTime": "A String", # Output only. The most recent time this finding was muted or unmuted. - "name": "A String", # The [relative resource name](https://cloud.google.com/apis/design/resource_names#relative_resource_name) of the finding. Example: "organizations/{organization_id}/sources/{source_id}/findings/{finding_id}", "folders/{folder_id}/sources/{source_id}/findings/{finding_id}", "projects/{project_id}/sources/{source_id}/findings/{finding_id}". - "networks": [ # Represents the VPC networks that the resource is attached to. - { # Contains information about a VPC network associated with the finding. - "name": "A String", # The name of the VPC network resource, for example, `//compute.googleapis.com/projects/my-project/global/networks/my-network`. + "muteInitiator": "A String", + "muteUpdateTime": "A String", + "name": "A String", + "networks": [ + { + "name": "A String", }, ], - "nextSteps": "A String", # Steps to address the finding. - "notebook": { # Represents a Jupyter notebook IPYNB file, such as a [Colab Enterprise notebook](https://cloud.google.com/colab/docs/introduction) file, that is associated with a finding. # Notebook associated with the finding. - "lastAuthor": "A String", # The user ID of the latest author to modify the notebook. - "name": "A String", # The name of the notebook. - "notebookUpdateTime": "A String", # The most recent time the notebook was updated. - "service": "A String", # The source notebook service, for example, "Colab Enterprise". + "nextSteps": "A String", + "notebook": { + "lastAuthor": "A String", + "name": "A String", + "notebookUpdateTime": "A String", + "service": "A String", }, - "orgPolicies": [ # Contains information about the org policies associated with the finding. - { # Contains information about the org policies associated with the finding. - "name": "A String", # The resource name of the org policy. Example: "organizations/{organization_id}/policies/{constraint_name}" + "orgPolicies": [ + { + "name": "A String", }, ], - "parent": "A String", # The relative resource name of the source the finding belongs to. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name This field is immutable after creation time. For example: "organizations/{organization_id}/sources/{source_id}" - "parentDisplayName": "A String", # Output only. The human readable display name of the finding source such as "Event Threat Detection" or "Security Health Analytics". - "policyViolationSummary": { # Metadata summarizing policy violations of child resources of the affected resource. `finding_category` and `resource` determine the exact semantics of the counts. For example, when category=DATA_SECURITY_POSTURE_OBJECT_PUBLIC_ACCESS_VIOLATION and resource='storage.googleapis.com/buckets/my-bucket-name' then this counts the number of Cloud Storage objects in my-bucket-name which violate a Public Access control. # PolicyViolationSummary associated with the finding. - "conformantResourcesCount": "A String", # Total number of child resources that conform to the policy. - "evaluationErrorsCount": "A String", # Number of child resources for which errors during evaluation occurred. The evaluation result for these child resources is effectively "unknown". - "outOfScopeResourcesCount": "A String", # Total count of child resources which were not in scope for evaluation. - "policyViolationsCount": "A String", # Count of child resources in violation of the policy. + "parent": "A String", + "parentDisplayName": "A String", + "policyViolationSummary": { + "conformantResourcesCount": "A String", + "evaluationErrorsCount": "A String", + "outOfScopeResourcesCount": "A String", + "policyViolationsCount": "A String", }, - "processes": [ # Represents operating system processes associated with the Finding. - { # Represents an operating system process. - "args": [ # Process arguments as JSON encoded strings. + "processes": [ + { + "args": [ "A String", ], - "argumentsTruncated": True or False, # True if `args` is incomplete. - "binary": { # File information about the related binary/library used by an executable, or the script used by a script interpreter # File information for the process executable. - "contents": "A String", # Prefix of the file contents as a JSON-encoded string. - "diskPath": { # Path of the file in terms of underlying disk/partition identifiers. # Path of the file in terms of underlying disk/partition identifiers. - "partitionUuid": "A String", # UUID of the partition (format https://wiki.archlinux.org/title/persistent_block_device_naming#by-uuid) - "relativePath": "A String", # Relative path of the file in the partition as a JSON encoded string. Example: /home/user1/executable_file.sh + "argumentsTruncated": True or False, + "binary": { + "contents": "A String", + "diskPath": { + "partitionUuid": "A String", + "relativePath": "A String", }, - "fileLoadState": "A String", # The load state of the file. - "hashedSize": "A String", # The length in bytes of the file prefix that was hashed. If hashed_size == size, any hashes reported represent the entire file. - "operations": [ # Operation(s) performed on a file. - { # Operation(s) performed on a file. - "type": "A String", # The type of the operation + "fileLoadState": "A String", + "hashedSize": "A String", + "operations": [ + { + "type": "A String", }, ], - "partiallyHashed": True or False, # True when the hash covers only a prefix of the file. - "path": "A String", # Absolute path of the file as a JSON encoded string. - "sha256": "A String", # SHA256 hash of the first hashed_size bytes of the file encoded as a hex string. If hashed_size == size, sha256 represents the SHA256 hash of the entire file. - "size": "A String", # Size of the file in bytes. + "partiallyHashed": True or False, + "path": "A String", + "sha256": "A String", + "size": "A String", }, - "envVariables": [ # Process environment variables. - { # A name-value pair representing an environment variable used in an operating system process. - "name": "A String", # Environment variable name as a JSON encoded string. - "val": "A String", # Environment variable value as a JSON encoded string. + "envVariables": [ + { + "name": "A String", + "val": "A String", }, ], - "envVariablesTruncated": True or False, # True if `env_variables` is incomplete. - "libraries": [ # File information for libraries loaded by the process. - { # File information about the related binary/library used by an executable, or the script used by a script interpreter - "contents": "A String", # Prefix of the file contents as a JSON-encoded string. - "diskPath": { # Path of the file in terms of underlying disk/partition identifiers. # Path of the file in terms of underlying disk/partition identifiers. - "partitionUuid": "A String", # UUID of the partition (format https://wiki.archlinux.org/title/persistent_block_device_naming#by-uuid) - "relativePath": "A String", # Relative path of the file in the partition as a JSON encoded string. Example: /home/user1/executable_file.sh + "envVariablesTruncated": True or False, + "libraries": [ + { + "contents": "A String", + "diskPath": { + "partitionUuid": "A String", + "relativePath": "A String", }, - "fileLoadState": "A String", # The load state of the file. - "hashedSize": "A String", # The length in bytes of the file prefix that was hashed. If hashed_size == size, any hashes reported represent the entire file. - "operations": [ # Operation(s) performed on a file. - { # Operation(s) performed on a file. - "type": "A String", # The type of the operation + "fileLoadState": "A String", + "hashedSize": "A String", + "operations": [ + { + "type": "A String", }, ], - "partiallyHashed": True or False, # True when the hash covers only a prefix of the file. - "path": "A String", # Absolute path of the file as a JSON encoded string. - "sha256": "A String", # SHA256 hash of the first hashed_size bytes of the file encoded as a hex string. If hashed_size == size, sha256 represents the SHA256 hash of the entire file. - "size": "A String", # Size of the file in bytes. + "partiallyHashed": True or False, + "path": "A String", + "sha256": "A String", + "size": "A String", }, ], - "name": "A String", # The process name, as displayed in utilities like `top` and `ps`. This name can be accessed through `/proc/[pid]/comm` and changed with `prctl(PR_SET_NAME)`. - "parentPid": "A String", # The parent process ID. - "pid": "A String", # The process ID. - "script": { # File information about the related binary/library used by an executable, or the script used by a script interpreter # When the process represents the invocation of a script, `binary` provides information about the interpreter, while `script` provides information about the script file provided to the interpreter. - "contents": "A String", # Prefix of the file contents as a JSON-encoded string. - "diskPath": { # Path of the file in terms of underlying disk/partition identifiers. # Path of the file in terms of underlying disk/partition identifiers. - "partitionUuid": "A String", # UUID of the partition (format https://wiki.archlinux.org/title/persistent_block_device_naming#by-uuid) - "relativePath": "A String", # Relative path of the file in the partition as a JSON encoded string. Example: /home/user1/executable_file.sh + "name": "A String", + "parentPid": "A String", + "pid": "A String", + "script": { + "contents": "A String", + "diskPath": { + "partitionUuid": "A String", + "relativePath": "A String", }, - "fileLoadState": "A String", # The load state of the file. - "hashedSize": "A String", # The length in bytes of the file prefix that was hashed. If hashed_size == size, any hashes reported represent the entire file. - "operations": [ # Operation(s) performed on a file. - { # Operation(s) performed on a file. - "type": "A String", # The type of the operation + "fileLoadState": "A String", + "hashedSize": "A String", + "operations": [ + { + "type": "A String", }, ], - "partiallyHashed": True or False, # True when the hash covers only a prefix of the file. - "path": "A String", # Absolute path of the file as a JSON encoded string. - "sha256": "A String", # SHA256 hash of the first hashed_size bytes of the file encoded as a hex string. If hashed_size == size, sha256 represents the SHA256 hash of the entire file. - "size": "A String", # Size of the file in bytes. + "partiallyHashed": True or False, + "path": "A String", + "sha256": "A String", + "size": "A String", }, - "userId": "A String", # The ID of the user that executed the process. E.g. If this is the root user this will always be 0. + "userId": "A String", }, ], - "resourceName": "A String", # For findings on Google Cloud resources, the full resource name of the Google Cloud resource this finding is for. See: https://cloud.google.com/apis/design/resource_names#full_resource_name When the finding is for a non-Google Cloud resource, the resourceName can be a customer or partner defined string. This field is immutable after creation time. - "secret": { # Details about a secret or credential associated with the finding. # Secret associated with the finding. - "environmentVariable": { # Environment variable containing the secret. # The environment variable containing the secret. - "key": "A String", # Environment variable name as a JSON encoded string. Note that value is not included since the value contains the secret data, which is sensitive core content. + "resourceName": "A String", + "secret": { + "environmentVariable": { + "key": "A String", }, - "filePath": { # File path containing the secret. # The file containing the secret. - "path": "A String", # Path to the file. + "filePath": { + "path": "A String", }, - "status": { # The status of the secret. # The status of the secret. - "lastUpdatedTime": "A String", # Time that the secret was found. - "validity": "A String", # The validity of the secret. + "status": { + "lastUpdatedTime": "A String", + "validity": "A String", }, - "type": "A String", # The type of secret, for example, GCP_API_KEY. + "type": "A String", }, - "securityMarks": { # User specified security marks that are attached to the parent Security Command Center resource. Security marks are scoped within a Security Command Center organization -- they can be modified and viewed by all users who have proper permissions on the organization. # Output only. User specified security marks. These marks are entirely managed by the user and come from the SecurityMarks resource that belongs to the finding. - "canonicalName": "A String", # The canonical name of the marks. Examples: "organizations/{organization_id}/assets/{asset_id}/securityMarks" "folders/{folder_id}/assets/{asset_id}/securityMarks" "projects/{project_number}/assets/{asset_id}/securityMarks" "organizations/{organization_id}/sources/{source_id}/findings/{finding_id}/securityMarks" "folders/{folder_id}/sources/{source_id}/findings/{finding_id}/securityMarks" "projects/{project_number}/sources/{source_id}/findings/{finding_id}/securityMarks" - "marks": { # Mutable user specified security marks belonging to the parent resource. Constraints are as follows: * Keys and values are treated as case insensitive * Keys must be between 1 - 256 characters (inclusive) * Keys must be letters, numbers, underscores, or dashes * Values have leading and trailing whitespace trimmed, remaining characters must be between 1 - 4096 characters (inclusive) + "securityMarks": { + "canonicalName": "A String", + "marks": { "a_key": "A String", }, - "name": "A String", # The relative resource name of the SecurityMarks. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Examples: "organizations/{organization_id}/assets/{asset_id}/securityMarks" "organizations/{organization_id}/sources/{source_id}/findings/{finding_id}/securityMarks". + "name": "A String", }, - "securityPosture": { # Represents a posture that is deployed on Google Cloud by the Security Command Center Posture Management service. A posture contains one or more policy sets. A policy set is a group of policies that enforce a set of security rules on Google Cloud. # The security posture associated with the finding. - "changedPolicy": "A String", # The name of the updated policy, for example, `projects/{project_id}/policies/{constraint_name}`. - "name": "A String", # Name of the posture, for example, `CIS-Posture`. - "policy": "A String", # The ID of the updated policy, for example, `compute-policy-1`. - "policyDriftDetails": [ # The details about a change in an updated policy that violates the deployed posture. - { # The policy field that violates the deployed posture and its expected and detected values. - "detectedValue": "A String", # The detected value that violates the deployed posture, for example, `false` or `allowed_values={"projects/22831892"}`. - "expectedValue": "A String", # The value of this field that was configured in a posture, for example, `true` or `allowed_values={"projects/29831892"}`. - "field": "A String", # The name of the updated field, for example constraint.implementation.policy_rules[0].enforce + "securityPosture": { + "changedPolicy": "A String", + "name": "A String", + "policy": "A String", + "policyDriftDetails": [ + { + "detectedValue": "A String", + "expectedValue": "A String", + "field": "A String", }, ], - "policySet": "A String", # The name of the updated policyset, for example, `cis-policyset`. - "postureDeployment": "A String", # The name of the posture deployment, for example, `organizations/{org_id}/posturedeployments/{posture_deployment_id}`. - "postureDeploymentResource": "A String", # The project, folder, or organization on which the posture is deployed, for example, `projects/{project_number}`. - "revisionId": "A String", # The version of the posture, for example, `c7cfa2a8`. + "policySet": "A String", + "postureDeployment": "A String", + "postureDeploymentResource": "A String", + "revisionId": "A String", }, - "severity": "A String", # The severity of the finding. This field is managed by the source that writes the finding. - "sourceProperties": { # Source specific properties. These properties are managed by the source that writes the finding. The key names in the source_properties map must be between 1 and 255 characters, and must start with a letter and contain alphanumeric characters or underscores only. + "severity": "A String", + "sourceProperties": { "a_key": "", }, - "state": "A String", # The state of the finding. - "toxicCombination": { # Contains details about a group of security issues that, when the issues occur together, represent a greater risk than when the issues occur independently. A group of such issues is referred to as a toxic combination. # Contains details about a group of security issues that, when the issues occur together, represent a greater risk than when the issues occur independently. A group of such issues is referred to as a toxic combination. This field cannot be updated. Its value is ignored in all update requests. - "attackExposureScore": 3.14, # The [Attack exposure score](https://cloud.google.com/security-command-center/docs/attack-exposure-learn#attack_exposure_scores) of this toxic combination. The score is a measure of how much this toxic combination exposes one or more high-value resources to potential attack. - "relatedFindings": [ # List of resource names of findings associated with this toxic combination. For example, `organizations/123/sources/456/findings/789`. + "state": "A String", + "toxicCombination": { + "attackExposureScore": 3.14, + "relatedFindings": [ "A String", ], }, - "vertexAi": { # Vertex AI-related information associated with the finding. # VertexAi associated with the finding. - "datasets": [ # Datasets associated with the finding. - { # Vertex AI dataset associated with the finding. - "displayName": "A String", # The user defined display name of dataset, e.g. plants-dataset - "name": "A String", # Resource name of the dataset, e.g. projects/{project}/locations/{location}/datasets/2094040236064505856 - "source": "A String", # Data source, such as BigQuery source URI, e.g. bq://scc-nexus-test.AIPPtest.gsod + "vertexAi": { + "datasets": [ + { + "displayName": "A String", + "name": "A String", + "source": "A String", }, ], - "pipelines": [ # Pipelines associated with the finding. - { # Vertex AI training pipeline associated with the finding. - "displayName": "A String", # The user defined display name of pipeline, e.g. plants-classification - "name": "A String", # Resource name of the pipeline, e.g. projects/{project}/locations/{location}/trainingPipelines/5253428229225578496 + "pipelines": [ + { + "displayName": "A String", + "name": "A String", }, ], }, - "vulnerability": { # Refers to common vulnerability fields e.g. cve, cvss, cwe etc. # Represents vulnerability-specific fields like CVE and CVSS scores. CVE stands for Common Vulnerabilities and Exposures (https://cve.mitre.org/about/) - "cve": { # CVE stands for Common Vulnerabilities and Exposures. Information from the [CVE record](https://www.cve.org/ResourcesSupport/Glossary) that describes this vulnerability. # CVE stands for Common Vulnerabilities and Exposures (https://cve.mitre.org/about/) - "cvssv3": { # Common Vulnerability Scoring System version 3. # Describe Common Vulnerability Scoring System specified at https://www.first.org/cvss/v3.1/specification-document - "attackComplexity": "A String", # This metric describes the conditions beyond the attacker's control that must exist in order to exploit the vulnerability. - "attackVector": "A String", # Base Metrics Represents the intrinsic characteristics of a vulnerability that are constant over time and across user environments. This metric reflects the context by which vulnerability exploitation is possible. - "availabilityImpact": "A String", # This metric measures the impact to the availability of the impacted component resulting from a successfully exploited vulnerability. - "baseScore": 3.14, # The base score is a function of the base metric scores. - "confidentialityImpact": "A String", # This metric measures the impact to the confidentiality of the information resources managed by a software component due to a successfully exploited vulnerability. - "integrityImpact": "A String", # This metric measures the impact to integrity of a successfully exploited vulnerability. - "privilegesRequired": "A String", # This metric describes the level of privileges an attacker must possess before successfully exploiting the vulnerability. - "scope": "A String", # The Scope metric captures whether a vulnerability in one vulnerable component impacts resources in components beyond its security scope. - "userInteraction": "A String", # This metric captures the requirement for a human user, other than the attacker, to participate in the successful compromise of the vulnerable component. + "vulnerability": { + "cve": { + "cvssv3": { + "attackComplexity": "A String", + "attackVector": "A String", + "availabilityImpact": "A String", + "baseScore": 3.14, + "confidentialityImpact": "A String", + "integrityImpact": "A String", + "privilegesRequired": "A String", + "scope": "A String", + "userInteraction": "A String", }, - "exploitReleaseDate": "A String", # Date the first publicly available exploit or PoC was released. - "exploitationActivity": "A String", # The exploitation activity of the vulnerability in the wild. - "firstExploitationDate": "A String", # Date of the earliest known exploitation. - "id": "A String", # The unique identifier for the vulnerability. e.g. CVE-2021-34527 - "impact": "A String", # The potential impact of the vulnerability if it was to be exploited. - "observedInTheWild": True or False, # Whether or not the vulnerability has been observed in the wild. - "references": [ # Additional information about the CVE. e.g. https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2021-34527 - { # Additional Links - "source": "A String", # Source of the reference e.g. NVD - "uri": "A String", # Uri for the mentioned source e.g. https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2021-34527. + "exploitReleaseDate": "A String", + "exploitationActivity": "A String", + "firstExploitationDate": "A String", + "id": "A String", + "impact": "A String", + "observedInTheWild": True or False, + "references": [ + { + "source": "A String", + "uri": "A String", }, ], - "upstreamFixAvailable": True or False, # Whether upstream fix is available for the CVE. - "zeroDay": True or False, # Whether or not the vulnerability was zero day when the finding was published. + "upstreamFixAvailable": True or False, + "zeroDay": True or False, }, - "cwes": [ # Represents one or more Common Weakness Enumeration (CWE) information on this vulnerability. - { # CWE stands for Common Weakness Enumeration. Information about this weakness, as described by [CWE](https://cwe.mitre.org/). - "id": "A String", # The CWE identifier, e.g. CWE-94 - "references": [ # Any reference to the details on the CWE, for example, https://cwe.mitre.org/data/definitions/94.html - { # Additional Links - "source": "A String", # Source of the reference e.g. NVD - "uri": "A String", # Uri for the mentioned source e.g. https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2021-34527. + "cwes": [ + { + "id": "A String", + "references": [ + { + "source": "A String", + "uri": "A String", }, ], }, ], - "fixedPackage": { # Package is a generic definition of a package. # The fixed package is relevant to the finding. - "cpeUri": "A String", # The CPE URI where the vulnerability was detected. - "packageName": "A String", # The name of the package where the vulnerability was detected. - "packageType": "A String", # Type of package, for example, os, maven, or go. - "packageVersion": "A String", # The version of the package. + "fixedPackage": { + "cpeUri": "A String", + "packageName": "A String", + "packageType": "A String", + "packageVersion": "A String", }, - "offendingPackage": { # Package is a generic definition of a package. # The offending package is relevant to the finding. - "cpeUri": "A String", # The CPE URI where the vulnerability was detected. - "packageName": "A String", # The name of the package where the vulnerability was detected. - "packageType": "A String", # Type of package, for example, os, maven, or go. - "packageVersion": "A String", # The version of the package. + "offendingPackage": { + "cpeUri": "A String", + "packageName": "A String", + "packageType": "A String", + "packageVersion": "A String", }, - "providerRiskScore": "A String", # Provider provided risk_score based on multiple factors. The higher the risk score, the more risky the vulnerability is. - "reachable": True or False, # Represents whether the vulnerability is reachable (detected via static analysis) - "securityBulletin": { # SecurityBulletin are notifications of vulnerabilities of Google products. # The security bulletin is relevant to this finding. - "bulletinId": "A String", # ID of the bulletin corresponding to the vulnerability. - "submissionTime": "A String", # Submission time of this Security Bulletin. - "suggestedUpgradeVersion": "A String", # This represents a version that the cluster receiving this notification should be upgraded to, based on its current version. For example, 1.15.0 + "providerRiskScore": "A String", + "reachable": True or False, + "securityBulletin": { + "bulletinId": "A String", + "submissionTime": "A String", + "suggestedUpgradeVersion": "A String", }, }, }, - "resource": { # Information related to the Google Cloud resource that is associated with this finding. # Output only. Resource that is associated with this finding. - "adcApplication": { # Represents an ADC application associated with the finding. # The ADC application associated with the finding. - "attributes": { # Consumer provided attributes for the application # Consumer provided attributes for the AppHub application. - "businessOwners": [ # Business team that ensures user needs are met and value is delivered - { # Contact information of stakeholders. - "email": "A String", # Email address of the contacts. + "resource": { + "adcApplication": { + "attributes": { + "businessOwners": [ + { + "email": "A String", }, ], - "criticality": { # Criticality of the Application, Service, or Workload # User-defined criticality information. - "type": "A String", # Criticality Type. + "criticality": { + "type": "A String", }, - "developerOwners": [ # Developer team that owns development and coding. - { # Contact information of stakeholders. - "email": "A String", # Email address of the contacts. + "developerOwners": [ + { + "email": "A String", }, ], - "environment": { # Environment of the Application, Service, or Workload # User-defined environment information. - "type": "A String", # Environment Type. + "environment": { + "type": "A String", }, - "operatorOwners": [ # Operator team that ensures runtime and operations. - { # Contact information of stakeholders. - "email": "A String", # Email address of the contacts. + "operatorOwners": [ + { + "email": "A String", }, ], }, - "name": "A String", # The resource name of an ADC Application. Format: projects/{project}/locations/{location}/spaces/{space}/applications/{application} + "name": "A String", }, - "adcApplicationTemplate": { # Represents an ADC template associated with the finding. # The ADC template associated with the finding. - "name": "A String", # The resource name of an ADC Application Template Revision. Format: projects/{project}/locations/{location}/spaces/{space}/applicationTemplates/{application_template}/revisions/{revision} + "adcApplicationTemplate": { + "name": "A String", }, - "adcSharedTemplate": { # Represents an ADC shared template associated with the finding. # The ADC shared template associated with the finding. - "name": "A String", # The resource name of an ADC Shared Template Revision. Format: projects/{project}/locations/{location}/spaces/{space}/applicationTemplates/{application_template}/revisions/{revision} + "adcSharedTemplate": { + "name": "A String", }, - "application": { # The App Hub Application associated with the finding's resource. # The App Hub application this resource belongs to. - "attributes": { # Consumer provided attributes for the application # Consumer provided attributes for the application - "businessOwners": [ # Business team that ensures user needs are met and value is delivered - { # Contact information of stakeholders. - "email": "A String", # Email address of the contacts. + "application": { + "attributes": { + "businessOwners": [ + { + "email": "A String", }, ], - "criticality": { # Criticality of the Application, Service, or Workload # User-defined criticality information. - "type": "A String", # Criticality Type. + "criticality": { + "type": "A String", }, - "developerOwners": [ # Developer team that owns development and coding. - { # Contact information of stakeholders. - "email": "A String", # Email address of the contacts. + "developerOwners": [ + { + "email": "A String", }, ], - "environment": { # Environment of the Application, Service, or Workload # User-defined environment information. - "type": "A String", # Environment Type. + "environment": { + "type": "A String", }, - "operatorOwners": [ # Operator team that ensures runtime and operations. - { # Contact information of stakeholders. - "email": "A String", # Email address of the contacts. + "operatorOwners": [ + { + "email": "A String", }, ], }, - "name": "A String", # The resource name of an Application. Format: `projects/{host-project-id}/locations/{location}/applications/{application-id}` + "name": "A String", }, - "awsMetadata": { # AWS metadata associated with the resource, only applicable if the finding's cloud provider is Amazon Web Services. # The AWS metadata associated with the finding. - "account": { # An AWS account that is a member of an organization. # The AWS account associated with the resource. - "id": "A String", # The unique identifier (ID) of the account, containing exactly 12 digits. - "name": "A String", # The friendly name of this account. + "awsMetadata": { + "account": { + "id": "A String", + "name": "A String", }, - "organization": { # An organization is a collection of accounts that are centrally managed together using consolidated billing, organized hierarchically with organizational units (OUs), and controlled with policies. # The AWS organization associated with the resource. - "id": "A String", # The unique identifier (ID) for the organization. The regex pattern for an organization ID string requires "o-" followed by from 10 to 32 lowercase letters or digits. + "organization": { + "id": "A String", }, - "organizationalUnits": [ # A list of AWS organizational units associated with the resource, ordered from lowest level (closest to the account) to highest level. - { # An Organizational Unit (OU) is a container of AWS accounts within a root of an organization. Policies that are attached to an OU apply to all accounts contained in that OU and in any child OUs. - "id": "A String", # The unique identifier (ID) associated with this OU. The regex pattern for an organizational unit ID string requires "ou-" followed by from 4 to 32 lowercase letters or digits (the ID of the root that contains the OU). This string is followed by a second "-" dash and from 8 to 32 additional lowercase letters or digits. For example, "ou-ab12-cd34ef56". - "name": "A String", # The friendly name of the OU. + "organizationalUnits": [ + { + "id": "A String", + "name": "A String", }, ], }, - "azureMetadata": { # Azure metadata associated with the resource, only applicable if the finding's cloud provider is Microsoft Azure. # The Azure metadata associated with the finding. - "managementGroups": [ # A list of Azure management groups associated with the resource, ordered from lowest level (closest to the subscription) to highest level. - { # Represents an Azure management group. - "displayName": "A String", # The display name of the Azure management group. - "id": "A String", # The UUID of the Azure management group, for example, `20000000-0001-0000-0000-000000000000`. + "azureMetadata": { + "managementGroups": [ + { + "displayName": "A String", + "id": "A String", }, ], - "resourceGroup": { # Represents an Azure resource group. # The Azure resource group associated with the resource. - "id": "A String", # The ID of the Azure resource group. - "name": "A String", # The name of the Azure resource group. This is not a UUID. + "resourceGroup": { + "id": "A String", + "name": "A String", }, - "subscription": { # Represents an Azure subscription. # The Azure subscription associated with the resource. - "displayName": "A String", # The display name of the Azure subscription. - "id": "A String", # The UUID of the Azure subscription, for example, `291bba3f-e0a5-47bc-a099-3bdcb2a50a05`. + "subscription": { + "displayName": "A String", + "id": "A String", }, - "tenant": { # Represents a Microsoft Entra tenant. # The Azure Entra tenant associated with the resource. - "displayName": "A String", # The display name of the Azure tenant. - "id": "A String", # The ID of the Microsoft Entra tenant, for example, "a11aaa11-aa11-1aa1-11aa-1aaa11a". + "tenant": { + "displayName": "A String", + "id": "A String", }, }, - "cloudProvider": "A String", # Indicates which cloud provider the finding is from. - "displayName": "A String", # The human readable name of the resource. - "folders": [ # Contains a Folder message for each folder in the assets ancestry. The first folder is the deepest nested folder, and the last folder is the folder directly under the Organization. - { # Message that contains the resource name and display name of a folder resource. - "resourceFolder": "A String", # Full resource name of this folder. See: https://cloud.google.com/apis/design/resource_names#full_resource_name - "resourceFolderDisplayName": "A String", # The user defined display name for this folder. + "cloudProvider": "A String", + "displayName": "A String", + "folders": [ + { + "resourceFolder": "A String", + "resourceFolderDisplayName": "A String", }, ], - "location": "A String", # The region or location of the service (if applicable). - "name": "A String", # The full resource name of the resource. See: https://cloud.google.com/apis/design/resource_names#full_resource_name - "organization": "A String", # Indicates which organization / tenant the finding is for. - "parentDisplayName": "A String", # The human readable name of resource's parent. - "parentName": "A String", # The full resource name of resource's parent. - "projectDisplayName": "A String", # The project ID that the resource belongs to. - "projectName": "A String", # The full resource name of project that the resource belongs to. - "resourcePath": { # Represents the path of resources leading up to the resource this finding is about. # Provides the path to the resource within the resource hierarchy. - "nodes": [ # The list of nodes that make the up resource path, ordered from lowest level to highest level. - { # A node within the resource path. Each node represents a resource within the resource hierarchy. - "displayName": "A String", # The display name of the resource this node represents. - "id": "A String", # The ID of the resource this node represents. - "nodeType": "A String", # The type of resource this node represents. + "location": "A String", + "name": "A String", + "organization": "A String", + "parentDisplayName": "A String", + "parentName": "A String", + "projectDisplayName": "A String", + "projectName": "A String", + "resourcePath": { + "nodes": [ + { + "displayName": "A String", + "id": "A String", + "nodeType": "A String", }, ], }, - "resourcePathString": "A String", # A string representation of the resource path. For Google Cloud, it has the format of `org/{organization_id}/folder/{folder_id}/folder/{folder_id}/project/{project_id}` where there can be any number of folders. For AWS, it has the format of `org/{organization_id}/ou/{organizational_unit_id}/ou/{organizational_unit_id}/account/{account_id}` where there can be any number of organizational units. For Azure, it has the format of `mg/{management_group_id}/mg/{management_group_id}/subscription/{subscription_id}/rg/{resource_group_name}` where there can be any number of management groups. - "service": "A String", # The service or resource provider associated with the resource. - "type": "A String", # The full resource type of the resource. + "resourcePathString": "A String", + "service": "A String", + "type": "A String", }, - "stateChange": "A String", # State change of the finding between the points in time. + "stateChange": "A String", }, ], - "nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no more results. - "readTime": "A String", # Time used for executing the list request. - "totalSize": 42, # The total number of findings matching the query. + "nextPageToken": "A String", + "readTime": "A String", + "totalSize": 42, }
@@ -2786,823 +2786,823 @@

Method Details

patch(name, body=None, updateMask=None, x__xgafv=None) -
Creates or updates a finding. The corresponding source must exist for a finding creation to succeed.
+  
 
 Args:
-  name: string, The [relative resource name](https://cloud.google.com/apis/design/resource_names#relative_resource_name) of the finding. Example: "organizations/{organization_id}/sources/{source_id}/findings/{finding_id}", "folders/{folder_id}/sources/{source_id}/findings/{finding_id}", "projects/{project_id}/sources/{source_id}/findings/{finding_id}". (required)
+  name: string, A parameter (required)
   body: object, The request body.
     The object takes the form of:
 
-{ # Security Command Center finding. A finding is a record of assessment data like security, risk, health, or privacy, that is ingested into Security Command Center for presentation, notification, analysis, policy testing, and enforcement. For example, a cross-site scripting (XSS) vulnerability in an App Engine application is a finding.
-  "access": { # Represents an access event. # Access details associated with the finding, such as more information on the caller, which method was accessed, and from where.
-    "callerIp": "A String", # Caller's IP address, such as "1.1.1.1".
-    "callerIpGeo": { # Represents a geographical location for a given access. # The caller IP's geolocation, which identifies where the call came from.
-      "regionCode": "A String", # A CLDR.
-    },
-    "methodName": "A String", # The method that the service account called, e.g. "SetIamPolicy".
-    "principalEmail": "A String", # Associated email, such as "foo@google.com". The email address of the authenticated user or a service account acting on behalf of a 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).
-    "principalSubject": "A String", # A string that represents the principal_subject that is associated with the identity. Unlike `principal_email`, `principal_subject` supports principals that aren't associated with email addresses, such as third party principals. For most identities, the format is `principal://iam.googleapis.com/{identity pool name}/subject/{subject}`. Some GKE identities, such as GKE_WORKLOAD, FREEFORM, and GKE_HUB_WORKLOAD, still use the legacy format `serviceAccount:{identity pool name}[{subject}]`.
-    "serviceAccountDelegationInfo": [ # The identity delegation history of an authenticated service account that made the request. The `serviceAccountDelegationInfo[]` object contains information about the real authorities that try to access Google Cloud resources by delegating on a service account. When multiple authorities are present, they are guaranteed to be sorted based on the original ordering of the identity delegation events.
-      { # Identity delegation history of an authenticated service account.
-        "principalEmail": "A String", # The email address of a Google account.
-        "principalSubject": "A String", # A string representing the principal_subject associated with the identity. As compared to `principal_email`, supports principals that aren't associated with email addresses, such as third party principals. For most identities, the format will be `principal://iam.googleapis.com/{identity pool name}/subjects/{subject}` except for some GKE identities (GKE_WORKLOAD, FREEFORM, GKE_HUB_WORKLOAD) that are still in the legacy format `serviceAccount:{identity pool name}[{subject}]`
-      },
-    ],
-    "serviceAccountKeyName": "A String", # The name of the service account key that was used to create or exchange credentials when authenticating the service account that made the request. This is a scheme-less URI full resource name. For example: "//iam.googleapis.com/projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}/keys/{key}".
-    "serviceName": "A String", # This is the API service that the service account made a call to, e.g. "iam.googleapis.com"
-    "userAgent": "A String", # The caller's user agent string associated with the finding.
-    "userAgentFamily": "A String", # Type of user agent associated with the finding. For example, an operating system shell or an embedded or standalone application.
-    "userName": "A String", # A string that represents a username. The username provided depends on the type of the finding and is likely not an IAM principal. For example, this can be a system username if the finding is related to a virtual machine, or it can be an application login username.
-  },
-  "affectedResources": { # Details about resources affected by this finding. # AffectedResources associated with the finding.
-    "count": "A String", # The count of resources affected by the finding.
-  },
-  "agentDataAccessEvents": [ # Agent data access events associated with the finding.
-    { # Details about a data access attempt made by an agent principal not authorized under applicable data security policy.
-      "eventId": "A String", # Unique identifier for data access event.
-      "eventTime": "A String", # Timestamp of data access event.
-      "operation": "A String", # The operation performed by the principal to access the data.
-      "principalSubject": "A String", # The agent principal that accessed the data.
+{
+  "access": {
+    "callerIp": "A String",
+    "callerIpGeo": {
+      "regionCode": "A String",
+    },
+    "methodName": "A String",
+    "principalEmail": "A String",
+    "principalSubject": "A String",
+    "serviceAccountDelegationInfo": [
+      {
+        "principalEmail": "A String",
+        "principalSubject": "A String",
+      },
+    ],
+    "serviceAccountKeyName": "A String",
+    "serviceName": "A String",
+    "userAgent": "A String",
+    "userAgentFamily": "A String",
+    "userName": "A String",
+  },
+  "affectedResources": {
+    "count": "A String",
+  },
+  "agentDataAccessEvents": [
+    {
+      "eventId": "A String",
+      "eventTime": "A String",
+      "operation": "A String",
+      "principalSubject": "A String",
     },
   ],
-  "aiModel": { # Contains information about the AI model associated with the finding. # The AI model associated with the finding.
-    "deploymentPlatform": "A String", # The platform on which the model is deployed.
-    "displayName": "A String", # The user defined display name of model. Ex. baseline-classification-model
-    "domain": "A String", # The domain of the model, for example, “image-classification”.
-    "library": "A String", # The name of the model library, for example, “transformers”.
-    "location": "A String", # The region in which the model is used, for example, “us-central1”.
-    "name": "A String", # The name of the AI model, for example, "gemini:1.0.0".
-    "publisher": "A String", # The publisher of the model, for example, “google” or “nvidia”.
-    "usageCategory": "A String", # The purpose of the model, for example, "Inteference" or "Training".
-  },
-  "application": { # Represents an application associated with a finding. # Represents an application associated with the finding.
-    "baseUri": "A String", # The base URI that identifies the network location of the application in which the vulnerability was detected. For example, `http://example.com`.
-    "fullUri": "A String", # The full URI with payload that can be used to reproduce the vulnerability. For example, `http://example.com?p=aMmYgI6H`.
-  },
-  "artifactGuardPolicies": { # Represents the result of evaluating artifact guard policies. # ArtifactGuardPolicies associated with the finding.
-    "failingPolicies": [ # A list of failing policies.
-      { # Represents an artifact guard policy.
-        "failureReason": "A String", # The reason for the policy failure, for example, "severity=HIGH AND max_vuln_count=2".
-        "policyId": "A String", # The ID of the failing policy, for example, "organizations/3392779/locations/global/policies/prod-policy".
-        "type": "A String", # The type of the policy evaluation.
-      },
-    ],
-    "resourceId": "A String", # The ID of the resource that has policies configured for it.
-  },
-  "attackExposure": { # An attack exposure contains the results of an attack path simulation run. # The results of an attack path simulation relevant to this finding.
-    "attackExposureResult": "A String", # The resource name of the attack path simulation result that contains the details regarding this attack exposure score. Example: `organizations/123/simulations/456/attackExposureResults/789`
-    "exposedHighValueResourcesCount": 42, # The number of high value resources that are exposed as a result of this finding.
-    "exposedLowValueResourcesCount": 42, # The number of high value resources that are exposed as a result of this finding.
-    "exposedMediumValueResourcesCount": 42, # The number of medium value resources that are exposed as a result of this finding.
-    "latestCalculationTime": "A String", # The most recent time the attack exposure was updated on this finding.
-    "score": 3.14, # A number between 0 (inclusive) and infinity that represents how important this finding is to remediate. The higher the score, the more important it is to remediate.
-    "state": "A String", # What state this AttackExposure is in. This captures whether or not an attack exposure has been calculated or not.
-  },
-  "backupDisasterRecovery": { # Information related to Google Cloud Backup and DR Service findings. # Fields related to Backup and DR findings.
-    "appliance": "A String", # The name of the Backup and DR appliance that captures, moves, and manages the lifecycle of backup data. For example, `backup-server-57137`.
-    "applications": [ # The names of Backup and DR applications. An application is a VM, database, or file system on a managed host monitored by a backup and recovery appliance. For example, `centos7-01-vol00`, `centos7-01-vol01`, `centos7-01-vol02`.
+  "aiModel": {
+    "deploymentPlatform": "A String",
+    "displayName": "A String",
+    "domain": "A String",
+    "library": "A String",
+    "location": "A String",
+    "name": "A String",
+    "publisher": "A String",
+    "usageCategory": "A String",
+  },
+  "application": {
+    "baseUri": "A String",
+    "fullUri": "A String",
+  },
+  "artifactGuardPolicies": {
+    "failingPolicies": [
+      {
+        "failureReason": "A String",
+        "policyId": "A String",
+        "type": "A String",
+      },
+    ],
+    "resourceId": "A String",
+  },
+  "attackExposure": {
+    "attackExposureResult": "A String",
+    "exposedHighValueResourcesCount": 42,
+    "exposedLowValueResourcesCount": 42,
+    "exposedMediumValueResourcesCount": 42,
+    "latestCalculationTime": "A String",
+    "score": 3.14,
+    "state": "A String",
+  },
+  "backupDisasterRecovery": {
+    "appliance": "A String",
+    "applications": [
       "A String",
     ],
-    "backupCreateTime": "A String", # The timestamp at which the Backup and DR backup was created.
-    "backupTemplate": "A String", # The name of a Backup and DR template which comprises one or more backup policies. See the [Backup and DR documentation](https://cloud.google.com/backup-disaster-recovery/docs/concepts/backup-plan#temp) for more information. For example, `snap-ov`.
-    "backupType": "A String", # The backup type of the Backup and DR image. For example, `Snapshot`, `Remote Snapshot`, `OnVault`.
-    "host": "A String", # The name of a Backup and DR host, which is managed by the backup and recovery appliance and known to the management console. The host can be of type Generic (for example, Compute Engine, SQL Server, Oracle DB, SMB file system, etc.), vCenter, or an ESX server. See the [Backup and DR documentation on hosts](https://cloud.google.com/backup-disaster-recovery/docs/configuration/manage-hosts-and-their-applications) for more information. For example, `centos7-01`.
-    "policies": [ # The names of Backup and DR policies that are associated with a template and that define when to run a backup, how frequently to run a backup, and how long to retain the backup image. For example, `onvaults`.
+    "backupCreateTime": "A String",
+    "backupTemplate": "A String",
+    "backupType": "A String",
+    "host": "A String",
+    "policies": [
       "A String",
     ],
-    "policyOptions": [ # The names of Backup and DR advanced policy options of a policy applying to an application. See the [Backup and DR documentation on policy options](https://cloud.google.com/backup-disaster-recovery/docs/create-plan/policy-settings). For example, `skipofflineappsincongrp, nounmap`.
+    "policyOptions": [
       "A String",
     ],
-    "profile": "A String", # The name of the Backup and DR resource profile that specifies the storage media for backups of application and VM data. See the [Backup and DR documentation on profiles](https://cloud.google.com/backup-disaster-recovery/docs/concepts/backup-plan#profile). For example, `GCP`.
-    "storagePool": "A String", # The name of the Backup and DR storage pool that the backup and recovery appliance is storing data in. The storage pool could be of type Cloud, Primary, Snapshot, or OnVault. See the [Backup and DR documentation on storage pools](https://cloud.google.com/backup-disaster-recovery/docs/concepts/storage-pools). For example, `DiskPoolOne`.
+    "profile": "A String",
+    "storagePool": "A String",
   },
-  "canonicalName": "A String", # The canonical name of the finding. It's either "organizations/{organization_id}/sources/{source_id}/findings/{finding_id}", "folders/{folder_id}/sources/{source_id}/findings/{finding_id}" or "projects/{project_number}/sources/{source_id}/findings/{finding_id}", depending on the closest CRM ancestor of the resource associated with the finding.
-  "category": "A String", # The additional taxonomy group within findings from a given source. This field is immutable after creation time. Example: "XSS_FLASH_INJECTION"
-  "chokepoint": { # Contains details about a chokepoint, which is a resource or resource group where high-risk attack paths converge, based on [attack path simulations] (https://cloud.google.com/security-command-center/docs/attack-exposure-learn#attack_path_simulations). # Contains details about a chokepoint, which is a resource or resource group where high-risk attack paths converge, based on [attack path simulations] (https://cloud.google.com/security-command-center/docs/attack-exposure-learn#attack_path_simulations). This field cannot be updated. Its value is ignored in all update requests.
-    "relatedFindings": [ # List of resource names of findings associated with this chokepoint. For example, organizations/123/sources/456/findings/789. This list will have at most 100 findings.
+  "canonicalName": "A String",
+  "category": "A String",
+  "chokepoint": {
+    "relatedFindings": [
       "A String",
     ],
   },
-  "cloudArmor": { # Fields related to Google Cloud Armor findings. # Fields related to Cloud Armor findings.
-    "adaptiveProtection": { # Information about [Google Cloud Armor Adaptive Protection](https://cloud.google.com/armor/docs/cloud-armor-overview#google-cloud-armor-adaptive-protection). # Information about potential Layer 7 DDoS attacks identified by [Google Cloud Armor Adaptive Protection](https://cloud.google.com/armor/docs/adaptive-protection-overview).
-      "confidence": 3.14, # A score of 0 means that there is low confidence that the detected event is an actual attack. A score of 1 means that there is high confidence that the detected event is an attack. See the [Adaptive Protection documentation](https://cloud.google.com/armor/docs/adaptive-protection-overview#configure-alert-tuning) for further explanation.
-    },
-    "attack": { # Information about DDoS attack volume and classification. # Information about DDoS attack volume and classification.
-      "classification": "A String", # Type of attack, for example, 'SYN-flood', 'NTP-udp', or 'CHARGEN-udp'.
-      "volumeBps": 42, # Total BPS (bytes per second) volume of attack. Deprecated - refer to volume_bps_long instead.
-      "volumeBpsLong": "A String", # Total BPS (bytes per second) volume of attack.
-      "volumePps": 42, # Total PPS (packets per second) volume of attack. Deprecated - refer to volume_pps_long instead.
-      "volumePpsLong": "A String", # Total PPS (packets per second) volume of attack.
-    },
-    "duration": "A String", # Duration of attack from the start until the current moment (updated every 5 minutes).
-    "requests": { # Information about the requests relevant to the finding. # Information about incoming requests evaluated by [Google Cloud Armor security policies](https://cloud.google.com/armor/docs/security-policy-overview).
-      "longTermAllowed": 42, # Allowed RPS (requests per second) over the long term.
-      "longTermDenied": 42, # Denied RPS (requests per second) over the long term.
-      "ratio": 3.14, # For 'Increasing deny ratio', the ratio is the denied traffic divided by the allowed traffic. For 'Allowed traffic spike', the ratio is the allowed traffic in the short term divided by allowed traffic in the long term.
-      "shortTermAllowed": 42, # Allowed RPS (requests per second) in the short term.
-    },
-    "securityPolicy": { # Information about the [Google Cloud Armor security policy](https://cloud.google.com/armor/docs/security-policy-overview) relevant to the finding. # Information about the [Google Cloud Armor security policy](https://cloud.google.com/armor/docs/security-policy-overview) relevant to the finding.
-      "name": "A String", # The name of the Google Cloud Armor security policy, for example, "my-security-policy".
-      "preview": True or False, # Whether or not the associated rule or policy is in preview mode.
-      "type": "A String", # The type of Google Cloud Armor security policy for example, 'backend security policy', 'edge security policy', 'network edge security policy', or 'always-on DDoS protection'.
-    },
-    "threatVector": "A String", # Distinguish between volumetric & protocol DDoS attack and application layer attacks. For example, "L3_4" for Layer 3 and Layer 4 DDoS attacks, or "L_7" for Layer 7 DDoS attacks.
-  },
-  "cloudDlpDataProfile": { # The [data profile](https://cloud.google.com/dlp/docs/data-profiles) associated with the finding. # Cloud DLP data profile that is associated with the finding.
-    "dataProfile": "A String", # Name of the data profile, for example, `projects/123/locations/europe/tableProfiles/8383929`.
-    "infoTypes": [ # Type of information detected by SDP. Info type includes name, version and sensitivity of the detected information type.
-      { # Type of information detected by the API.
-        "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`.
-        "sensitivityScore": { # Score is calculated from of all elements in the data profile. A higher level means the data is more sensitive. # Optional custom sensitivity for this InfoType. This only applies to data profiling.
-          "score": "A String", # The sensitivity score applied to the resource.
+  "cloudArmor": {
+    "adaptiveProtection": {
+      "confidence": 3.14,
+    },
+    "attack": {
+      "classification": "A String",
+      "volumeBps": 42,
+      "volumeBpsLong": "A String",
+      "volumePps": 42,
+      "volumePpsLong": "A String",
+    },
+    "duration": "A String",
+    "requests": {
+      "longTermAllowed": 42,
+      "longTermDenied": 42,
+      "ratio": 3.14,
+      "shortTermAllowed": 42,
+    },
+    "securityPolicy": {
+      "name": "A String",
+      "preview": True or False,
+      "type": "A String",
+    },
+    "threatVector": "A String",
+  },
+  "cloudDlpDataProfile": {
+    "dataProfile": "A String",
+    "infoTypes": [
+      {
+        "name": "A String",
+        "sensitivityScore": {
+          "score": "A String",
         },
-        "version": "A String", # Optional version name for this InfoType.
+        "version": "A String",
       },
     ],
-    "parentType": "A String", # The resource hierarchy level at which the data profile was generated.
+    "parentType": "A String",
   },
-  "cloudDlpInspection": { # Details about the Cloud Data Loss Prevention (Cloud DLP) [inspection job](https://cloud.google.com/dlp/docs/concepts-job-triggers) that produced the finding. # Cloud Data Loss Prevention (Cloud DLP) inspection results that are associated with the finding.
-    "fullScan": True or False, # Whether Cloud DLP scanned the complete resource or a sampled subset.
-    "infoType": "A String", # The type of information (or *[infoType](https://cloud.google.com/dlp/docs/infotypes-reference)*) found, for example, `EMAIL_ADDRESS` or `STREET_ADDRESS`.
-    "infoTypeCount": "A String", # The number of times Cloud DLP found this infoType within this job and resource.
-    "inspectJob": "A String", # Name of the inspection job, for example, `projects/123/locations/europe/dlpJobs/i-8383929`.
+  "cloudDlpInspection": {
+    "fullScan": True or False,
+    "infoType": "A String",
+    "infoTypeCount": "A String",
+    "inspectJob": "A String",
   },
-  "complianceDetails": { # Compliance Details associated with the finding. # Details about the compliance implications of the finding.
-    "cloudControl": { # CloudControl associated with the finding. # CloudControl associated with the finding
-      "cloudControlName": "A String", # Name of the CloudControl associated with the finding.
-      "policyType": "A String", # Policy type of the CloudControl
-      "type": "A String", # Type of cloud control.
-      "version": 42, # Version of the Cloud Control
+  "complianceDetails": {
+    "cloudControl": {
+      "cloudControlName": "A String",
+      "policyType": "A String",
+      "type": "A String",
+      "version": 42,
     },
-    "cloudControlDeploymentNames": [ # Cloud Control Deployments associated with the finding. For example, organizations/123/locations/global/cloudControlDeployments/deploymentIdentifier
+    "cloudControlDeploymentNames": [
       "A String",
     ],
-    "frameworks": [ # Details of Frameworks associated with the finding
-      { # Compliance framework associated with the finding.
-        "category": [ # Category of the framework associated with the finding. E.g. Security Benchmark, or Assured Workloads
+    "frameworks": [
+      {
+        "category": [
           "A String",
         ],
-        "controls": [ # The controls associated with the framework.
-          { # Compliance control associated with the finding.
-            "controlName": "A String", # Name of the Control
-            "displayName": "A String", # Display name of the control. For example, AU-02.
+        "controls": [
+          {
+            "controlName": "A String",
+            "displayName": "A String",
           },
         ],
-        "displayName": "A String", # Display name of the framework. For a standard framework, this will look like e.g. PCI DSS 3.2.1, whereas for a custom framework it can be a user defined string like MyFramework
-        "name": "A String", # Name of the framework associated with the finding
-        "type": "A String", # Type of the framework associated with the finding, to specify whether the framework is built-in (pre-defined and immutable) or a custom framework defined by the customer (equivalent to security posture)
+        "displayName": "A String",
+        "name": "A String",
+        "type": "A String",
       },
     ],
   },
-  "compliances": [ # Contains compliance information for security standards associated to the finding.
-    { # Contains compliance information about a security standard indicating unmet recommendations.
-      "ids": [ # Policies within the standard or benchmark, for example, A.12.4.1
+  "compliances": [
+    {
+      "ids": [
         "A String",
       ],
-      "standard": "A String", # Industry-wide compliance standards or benchmarks, such as CIS, PCI, and OWASP.
-      "version": "A String", # Version of the standard or benchmark, for example, 1.1
+      "standard": "A String",
+      "version": "A String",
     },
   ],
-  "connections": [ # Contains information about the IP connection associated with the finding.
-    { # Contains information about the IP connection associated with the finding.
-      "destinationIp": "A String", # Destination IP address. Not present for sockets that are listening and not connected.
-      "destinationPort": 42, # Destination port. Not present for sockets that are listening and not connected.
-      "protocol": "A String", # IANA Internet Protocol Number such as TCP(6) and UDP(17).
-      "sourceIp": "A String", # Source IP address.
-      "sourcePort": 42, # Source port.
+  "connections": [
+    {
+      "destinationIp": "A String",
+      "destinationPort": 42,
+      "protocol": "A String",
+      "sourceIp": "A String",
+      "sourcePort": 42,
     },
   ],
-  "contacts": { # Output only. Map containing the points of contact for the given finding. The key represents the type of contact, while the value contains a list of all the contacts that pertain. Please refer to: https://cloud.google.com/resource-manager/docs/managing-notification-contacts#notification-categories { "security": { "contacts": [ { "email": "person1@company.com" }, { "email": "person2@company.com" } ] } }
-    "a_key": { # Details about specific contacts
-      "contacts": [ # A list of contacts
-        { # The email address of a contact.
-          "email": "A String", # An email address. For example, "`person123@company.com`".
+  "contacts": {
+    "a_key": {
+      "contacts": [
+        {
+          "email": "A String",
         },
       ],
     },
   },
-  "containers": [ # Containers associated with the finding. This field provides information for both Kubernetes and non-Kubernetes containers.
-    { # Container associated with the finding.
-      "createTime": "A String", # The time that the container was created.
-      "imageId": "A String", # Optional container image ID, if provided by the container runtime. Uniquely identifies the container image launched using a container image digest.
-      "labels": [ # Container labels, as provided by the container runtime.
-        { # Represents a generic name-value label. A label has separate name and value fields to support filtering with the `contains()` function. For more information, see [Filtering on array-type fields](https://cloud.google.com/security-command-center/docs/how-to-api-list-findings#array-contains-filtering).
-          "name": "A String", # Name of the label.
-          "value": "A String", # Value that corresponds to the label's name.
+  "containers": [
+    {
+      "createTime": "A String",
+      "imageId": "A String",
+      "labels": [
+        {
+          "name": "A String",
+          "value": "A String",
         },
       ],
-      "name": "A String", # Name of the container.
-      "uri": "A String", # Container image URI provided when configuring a pod or container. This string can identify a container image version using mutable tags.
+      "name": "A String",
+      "uri": "A String",
     },
   ],
-  "createTime": "A String", # The time at which the finding was created in Security Command Center.
-  "dataAccessEvents": [ # Data access events associated with the finding.
-    { # Details about a data access attempt made by a principal not authorized under applicable data security policy.
-      "eventId": "A String", # Unique identifier for data access event.
-      "eventTime": "A String", # Timestamp of data access event.
-      "operation": "A String", # The operation performed by the principal to access the data.
-      "principalEmail": "A String", # The email address of the principal that accessed the data. The principal could be a user account, service account, Google group, or other.
+  "createTime": "A String",
+  "dataAccessEvents": [
+    {
+      "eventId": "A String",
+      "eventTime": "A String",
+      "operation": "A String",
+      "principalEmail": "A String",
     },
   ],
-  "dataFlowEvents": [ # Data flow events associated with the finding.
-    { # Details about a data flow event, in which either the data is moved to or is accessed from a non-compliant geo-location, as defined in the applicable data security policy.
-      "eventId": "A String", # Unique identifier for data flow event.
-      "eventTime": "A String", # Timestamp of data flow event.
-      "operation": "A String", # The operation performed by the principal for the data flow event.
-      "principalEmail": "A String", # The email address of the principal that initiated the data flow event. The principal could be a user account, service account, Google group, or other.
-      "violatedLocation": "A String", # Non-compliant location of the principal or the data destination.
+  "dataFlowEvents": [
+    {
+      "eventId": "A String",
+      "eventTime": "A String",
+      "operation": "A String",
+      "principalEmail": "A String",
+      "violatedLocation": "A String",
     },
   ],
-  "dataRetentionDeletionEvents": [ # Data retention deletion events associated with the finding.
-    { # Details about data retention deletion violations, in which the data is non-compliant based on their retention or deletion time, as defined in the applicable data security policy. The Data Retention Deletion (DRD) control is a control of the DSPM (Data Security Posture Management) suite that enables organizations to manage data retention and deletion policies in compliance with regulations, such as GDPR and CRPA. DRD supports two primary policy types: maximum storage length (max TTL) and minimum storage length (min TTL). Both are aimed at helping organizations meet regulatory and data management commitments.
-      "dataObjectCount": "A String", # Number of objects that violated the policy for this resource. If the number is less than 1,000, then the value of this field is the exact number. If the number of objects that violated the policy is greater than or equal to 1,000, then the value of this field is 1000.
-      "eventDetectionTime": "A String", # Timestamp indicating when the event was detected.
-      "eventType": "A String", # Type of the DRD event.
-      "maxRetentionAllowed": "A String", # Maximum duration of retention allowed from the DRD control. This comes from the DRD control where users set a max TTL for their data. For example, suppose that a user sets the max TTL for a Cloud Storage bucket to 90 days. However, an object in that bucket is 100 days old. In this case, a DataRetentionDeletionEvent will be generated for that Cloud Storage bucket, and the max_retention_allowed is 90 days.
-      "minRetentionAllowed": "A String", # Min duration of retention allowed from the DSPM retention control. This field is only populated when event type is set to EVENT_TYPE_MIN_TTL_FROM_CREATION.
+  "dataRetentionDeletionEvents": [
+    {
+      "dataObjectCount": "A String",
+      "eventDetectionTime": "A String",
+      "eventType": "A String",
+      "maxRetentionAllowed": "A String",
+      "minRetentionAllowed": "A String",
     },
   ],
-  "database": { # Represents database access information, such as queries. A database may be a sub-resource of an instance (as in the case of Cloud SQL instances or Cloud Spanner instances), or the database instance itself. Some database resources might not have the [full resource name](https://google.aip.dev/122#full-resource-names) populated because these resource types, such as Cloud SQL databases, are not yet supported by Cloud Asset Inventory. In these cases only the display name is provided. # Database associated with the finding.
-    "displayName": "A String", # The human-readable name of the database that the user connected to.
-    "grantees": [ # The target usernames, roles, or groups of an SQL privilege grant, which is not an IAM policy change.
+  "database": {
+    "displayName": "A String",
+    "grantees": [
       "A String",
     ],
-    "name": "A String", # Some database resources may not have the [full resource name](https://google.aip.dev/122#full-resource-names) populated because these resource types are not yet supported by Cloud Asset Inventory (e.g. Cloud SQL databases). In these cases only the display name will be provided. The [full resource name](https://google.aip.dev/122#full-resource-names) of the database that the user connected to, if it is supported by Cloud Asset Inventory.
-    "query": "A String", # The SQL statement that is associated with the database access.
-    "userName": "A String", # The username used to connect to the database. The username might not be an IAM principal and does not have a set format.
-    "version": "A String", # The version of the database, for example, POSTGRES_14. See [the complete list](https://cloud.google.com/sql/docs/mysql/admin-api/rest/v1/SqlDatabaseVersion).
-  },
-  "description": "A String", # Contains more details about the finding.
-  "discoveredWorkload": { # Represents discovered, customer managed workload that is not registered with the respective GCP service. # DiscoveredWorkload associated with the finding.
-    "confidence": "A String", # The confidence in detection of this workload.
-    "detectedRelevantHardware": True or False, # A boolean flag set to true if associated hardware strongly predicts the workload type.
-    "detectedRelevantKeywords": True or False, # A boolean flag set to true if associated keywords strongly predict the workload type.
-    "detectedRelevantPackages": True or False, # A boolean flag set to true if installed packages strongly predict the workload type.
-    "workloadType": "A String", # The type of workload.
-  },
-  "disk": { # Contains information about the disk associated with the finding. # Disk associated with the finding.
-    "name": "A String", # The name of the disk, for example, "https://www.googleapis.com/compute/v1/projects/{project-id}/zones/{zone-id}/disks/{disk-id}".
-  },
-  "eventTime": "A String", # The time the finding was first detected. If an existing finding is updated, then this is the time the update occurred. For example, if the finding represents an open firewall, this property captures the time the detector believes the firewall became open. The accuracy is determined by the detector. If the finding is later resolved, then this time reflects when the finding was resolved. This must not be set to a value greater than the current timestamp.
-  "exfiltration": { # Exfiltration represents a data exfiltration attempt from one or more sources to one or more targets. The `sources` attribute lists the sources of the exfiltrated data. The `targets` attribute lists the destinations the data was copied to. # Represents exfiltrations associated with the finding.
-    "sources": [ # If there are multiple sources, then the data is considered "joined" between them. For instance, BigQuery can join multiple tables, and each table would be considered a source.
-      { # Resource where data was exfiltrated from or exfiltrated to.
-        "components": [ # Subcomponents of the asset that was exfiltrated, like URIs used during exfiltration, table names, databases, and filenames. For example, multiple tables might have been exfiltrated from the same Cloud SQL instance, or multiple files might have been exfiltrated from the same Cloud Storage bucket.
+    "name": "A String",
+    "query": "A String",
+    "userName": "A String",
+    "version": "A String",
+  },
+  "description": "A String",
+  "discoveredWorkload": {
+    "confidence": "A String",
+    "detectedRelevantHardware": True or False,
+    "detectedRelevantKeywords": True or False,
+    "detectedRelevantPackages": True or False,
+    "workloadType": "A String",
+  },
+  "disk": {
+    "name": "A String",
+  },
+  "eventTime": "A String",
+  "exfiltration": {
+    "sources": [
+      {
+        "components": [
           "A String",
         ],
-        "name": "A String", # The resource's [full resource name](https://cloud.google.com/apis/design/resource_names#full_resource_name).
+        "name": "A String",
       },
     ],
-    "targets": [ # If there are multiple targets, each target would get a complete copy of the "joined" source data.
-      { # Resource where data was exfiltrated from or exfiltrated to.
-        "components": [ # Subcomponents of the asset that was exfiltrated, like URIs used during exfiltration, table names, databases, and filenames. For example, multiple tables might have been exfiltrated from the same Cloud SQL instance, or multiple files might have been exfiltrated from the same Cloud Storage bucket.
+    "targets": [
+      {
+        "components": [
           "A String",
         ],
-        "name": "A String", # The resource's [full resource name](https://cloud.google.com/apis/design/resource_names#full_resource_name).
-      },
-    ],
-    "totalExfiltratedBytes": "A String", # Total exfiltrated bytes processed for the entire job.
-  },
-  "externalExposure": { # Details about the externally exposed resource associated with the finding. # External exposure associated with the finding.
-    "backendBucket": "A String", # The full resource name of the load balancer backend bucket, for example, "//compute.googleapis.com/projects/{project-id}/global/backendBuckets/{name}"
-    "backendService": "A String", # The full resource name of load balancer backend service, for example, "//compute.googleapis.com/projects/{project-id}/global/backendServices/{name}".
-    "exposedApplication": "A String", # The name and version of the exposed web application, for example, "Jenkins 2.184".
-    "exposedEndpoint": "A String", # The resource which is running the exposed service, for example, "//compute.googleapis.com/projects/{project-id}/zones/{zone}/instances/{instance}.”
-    "exposedService": "A String", # The name and version of the service, for example, "Jupyter Notebook 6.14.0".
-    "forwardingRule": "A String", # The full resource name of the forwarding rule, for example, "//compute.googleapis.com/projects/{project-id}/global/forwardingRules/{forwarding-rule-name}".
-    "hostnameUri": "A String", # Hostname of the exposed application, for example, "https://test-app.a.run.app/"
-    "httpResponse": [ # The http response returned by the web application.
-      { # The http response returned by the web application.
-        "path": "A String", # The http path for which response code was returned by web application, for example, "https://test-app.a.run.app/test".
-        "statusCode": "A String", # The http response code returned by the web application, for example, 200.
-      },
-    ],
-    "instanceGroup": "A String", # The full resource name of the instance group, for example, "//compute.googleapis.com/projects/{project-id}/global/instanceGroups/{name}".
-    "internalBackendService": "A String", # The full resource name of load balancer backend service in the internal project having resource exposed via PSC, for example, "//compute.googleapis.com/projects/{project-id}/global/backendServices/{name}".
-    "loadBalancerFirewallPolicy": "A String", # The full resource name of the load balancer firewall policy, for example, "//compute.googleapis.com/projects/{project-id}/global/firewallPolicies/{policy-name}".
-    "networkEndpointGroup": "A String", # The full resource name of the network endpoint group, for example, "//compute.googleapis.com/projects/{project-id}/global/networkEndpointGroups/{name}".
-    "networkIngressFirewallPolicy": "A String", # The full resource name of the network ingress firewall policy, for example, "//compute.googleapis.com/projects/{project-id}/global/firewallPolicies/{name}".
-    "privateIpAddress": "A String", # Private IP address of the exposed endpoint.
-    "privatePort": "A String", # Port number associated with private IP address.
-    "pscNetworkAttachment": "A String", # The full resource name of the PSC (Private Service Connect) network attachment that network interface controller is attached to, for example, "//compute.googleapis.com/projects/{project-id}/regions/{region}/networkAttachments/{name}"
-    "pscServiceAttachment": "A String", # The full resource name of the PSC (Private Service Connect) service attachment that the load balancer network endpoint group targets, for example, "//compute.googleapis.com/projects/{project-id}/regions/{region}/serviceAttachments/{name}"
-    "publicIpAddress": "A String", # Public IP address of the exposed endpoint.
-    "publicPort": "A String", # Public port number of the exposed endpoint.
-    "serviceFirewallPolicy": "A String", # The full resource name of the firewall policy of the exposed service, for example, "//compute.googleapis.com/projects/{project-id}/global/firewallPolicies/{policy-name}".
-  },
-  "externalSystems": { # Output only. Third party SIEM/SOAR fields within SCC, contains external system information and external system finding fields.
-    "a_key": { # Representation of third party SIEM/SOAR fields within SCC.
-      "assignees": [ # References primary/secondary etc assignees in the external system.
+        "name": "A String",
+      },
+    ],
+    "totalExfiltratedBytes": "A String",
+  },
+  "externalExposure": {
+    "backendBucket": "A String",
+    "backendService": "A String",
+    "exposedApplication": "A String",
+    "exposedEndpoint": "A String",
+    "exposedService": "A String",
+    "forwardingRule": "A String",
+    "hostnameUri": "A String",
+    "httpResponse": [
+      {
+        "path": "A String",
+        "statusCode": "A String",
+      },
+    ],
+    "instanceGroup": "A String",
+    "internalBackendService": "A String",
+    "loadBalancerFirewallPolicy": "A String",
+    "networkEndpointGroup": "A String",
+    "networkIngressFirewallPolicy": "A String",
+    "privateIpAddress": "A String",
+    "privatePort": "A String",
+    "pscNetworkAttachment": "A String",
+    "pscServiceAttachment": "A String",
+    "publicIpAddress": "A String",
+    "publicPort": "A String",
+    "serviceFirewallPolicy": "A String",
+  },
+  "externalSystems": {
+    "a_key": {
+      "assignees": [
         "A String",
       ],
-      "caseCloseTime": "A String", # The time when the case was closed, as reported by the external system.
-      "caseCreateTime": "A String", # The time when the case was created, as reported by the external system.
-      "casePriority": "A String", # The priority of the finding's corresponding case in the external system.
-      "caseSla": "A String", # The SLA of the finding's corresponding case in the external system.
-      "caseUri": "A String", # The link to the finding's corresponding case in the external system.
-      "externalSystemUpdateTime": "A String", # The time when the case was last updated, as reported by the external system.
-      "externalUid": "A String", # The identifier that's used to track the finding's corresponding case in the external system.
-      "name": "A String", # Full resource name of the external system, for example: "organizations/1234/sources/5678/findings/123456/externalSystems/jira", "folders/1234/sources/5678/findings/123456/externalSystems/jira", "projects/1234/sources/5678/findings/123456/externalSystems/jira"
-      "status": "A String", # The most recent status of the finding's corresponding case, as reported by the external system.
-      "ticketInfo": { # Information about the ticket, if any, that is being used to track the resolution of the issue that is identified by this finding. # Information about the ticket, if any, that is being used to track the resolution of the issue that is identified by this finding.
-        "assignee": "A String", # The assignee of the ticket in the ticket system.
-        "description": "A String", # The description of the ticket in the ticket system.
-        "id": "A String", # The identifier of the ticket in the ticket system.
-        "status": "A String", # The latest status of the ticket, as reported by the ticket system.
-        "updateTime": "A String", # The time when the ticket was last updated, as reported by the ticket system.
-        "uri": "A String", # The link to the ticket in the ticket system.
-      },
-    },
-  },
-  "externalUri": "A String", # The URI that, if available, points to a web page outside of Security Command Center where additional information about the finding can be found. This field is guaranteed to be either empty or a well formed URL.
-  "files": [ # File associated with the finding.
-    { # File information about the related binary/library used by an executable, or the script used by a script interpreter
-      "contents": "A String", # Prefix of the file contents as a JSON-encoded string.
-      "diskPath": { # Path of the file in terms of underlying disk/partition identifiers. # Path of the file in terms of underlying disk/partition identifiers.
-        "partitionUuid": "A String", # UUID of the partition (format https://wiki.archlinux.org/title/persistent_block_device_naming#by-uuid)
-        "relativePath": "A String", # Relative path of the file in the partition as a JSON encoded string. Example: /home/user1/executable_file.sh
-      },
-      "fileLoadState": "A String", # The load state of the file.
-      "hashedSize": "A String", # The length in bytes of the file prefix that was hashed. If hashed_size == size, any hashes reported represent the entire file.
-      "operations": [ # Operation(s) performed on a file.
-        { # Operation(s) performed on a file.
-          "type": "A String", # The type of the operation
+      "caseCloseTime": "A String",
+      "caseCreateTime": "A String",
+      "casePriority": "A String",
+      "caseSla": "A String",
+      "caseUri": "A String",
+      "externalSystemUpdateTime": "A String",
+      "externalUid": "A String",
+      "name": "A String",
+      "status": "A String",
+      "ticketInfo": {
+        "assignee": "A String",
+        "description": "A String",
+        "id": "A String",
+        "status": "A String",
+        "updateTime": "A String",
+        "uri": "A String",
+      },
+    },
+  },
+  "externalUri": "A String",
+  "files": [
+    {
+      "contents": "A String",
+      "diskPath": {
+        "partitionUuid": "A String",
+        "relativePath": "A String",
+      },
+      "fileLoadState": "A String",
+      "hashedSize": "A String",
+      "operations": [
+        {
+          "type": "A String",
         },
       ],
-      "partiallyHashed": True or False, # True when the hash covers only a prefix of the file.
-      "path": "A String", # Absolute path of the file as a JSON encoded string.
-      "sha256": "A String", # SHA256 hash of the first hashed_size bytes of the file encoded as a hex string. If hashed_size == size, sha256 represents the SHA256 hash of the entire file.
-      "size": "A String", # Size of the file in bytes.
+      "partiallyHashed": True or False,
+      "path": "A String",
+      "sha256": "A String",
+      "size": "A String",
     },
   ],
-  "findingClass": "A String", # The class of the finding.
-  "groupMemberships": [ # Contains details about groups of which this finding is a member. A group is a collection of findings that are related in some way. This field cannot be updated. Its value is ignored in all update requests.
-    { # Contains details about groups of which this finding is a member. A group is a collection of findings that are related in some way.
-      "groupId": "A String", # ID of the group.
-      "groupType": "A String", # Type of group.
+  "findingClass": "A String",
+  "groupMemberships": [
+    {
+      "groupId": "A String",
+      "groupType": "A String",
     },
   ],
-  "iamBindings": [ # Represents IAM bindings associated with the finding.
-    { # Represents a particular IAM binding, which captures a member's role addition, removal, or state.
-      "action": "A String", # The action that was performed on a Binding.
-      "member": "A String", # A single identity requesting access for a Cloud Platform resource, for example, "foo@google.com".
-      "role": "A String", # Role that is assigned to "members". For example, "roles/viewer", "roles/editor", or "roles/owner".
+  "iamBindings": [
+    {
+      "action": "A String",
+      "member": "A String",
+      "role": "A String",
     },
   ],
-  "indicator": { # Represents what's commonly known as an _indicator of compromise_ (IoC) in computer forensics. This is an artifact observed on a network or in an operating system that, with high confidence, indicates a computer intrusion. For more information, see [Indicator of compromise](https://en.wikipedia.org/wiki/Indicator_of_compromise). # Represents what's commonly known as an *indicator of compromise* (IoC) in computer forensics. This is an artifact observed on a network or in an operating system that, with high confidence, indicates a computer intrusion. For more information, see [Indicator of compromise](https://en.wikipedia.org/wiki/Indicator_of_compromise).
-    "domains": [ # List of domains associated to the Finding.
+  "indicator": {
+    "domains": [
       "A String",
     ],
-    "ipAddresses": [ # The list of IP addresses that are associated with the finding.
+    "ipAddresses": [
       "A String",
     ],
-    "signatures": [ # The list of matched signatures indicating that the given process is present in the environment.
-      { # Indicates what signature matched this process.
-        "memoryHashSignature": { # A signature corresponding to memory page hashes. # Signature indicating that a binary family was matched.
-          "binaryFamily": "A String", # The binary family.
-          "detections": [ # The list of memory hash detections contributing to the binary family match.
-            { # Memory hash detection contributing to the binary family match.
-              "binary": "A String", # The name of the binary associated with the memory hash signature detection.
-              "percentPagesMatched": 3.14, # The percentage of memory page hashes in the signature that were matched.
+    "signatures": [
+      {
+        "memoryHashSignature": {
+          "binaryFamily": "A String",
+          "detections": [
+            {
+              "binary": "A String",
+              "percentPagesMatched": 3.14,
             },
           ],
         },
-        "signatureType": "A String", # Describes the type of resource associated with the signature.
-        "yaraRuleSignature": { # A signature corresponding to a YARA rule. # Signature indicating that a YARA rule was matched.
-          "yaraRule": "A String", # The name of the YARA rule.
+        "signatureType": "A String",
+        "yaraRuleSignature": {
+          "yaraRule": "A String",
         },
       },
     ],
-    "uris": [ # The list of URIs associated to the Findings.
+    "uris": [
       "A String",
     ],
   },
-  "ipRules": { # IP rules associated with the finding. # IP rules associated with the finding.
-    "allowed": { # Allowed IP rule. # Tuple with allowed rules.
-      "ipRules": [ # Optional. Optional list of allowed IP rules.
-        { # IP rule information.
-          "portRanges": [ # Optional. An optional list of ports to which this rule applies. This field is only applicable for the UDP or (S)TCP protocols. Each entry must be either an integer or a range including a min and max port number.
-            { # A port range which is inclusive of the min and max values. Values are between 0 and 2^16-1. The max can be equal / must be not smaller than the min value. If min and max are equal this indicates that it is a single port.
-              "max": "A String", # Maximum port value.
-              "min": "A String", # Minimum port value.
+  "ipRules": {
+    "allowed": {
+      "ipRules": [
+        {
+          "portRanges": [
+            {
+              "max": "A String",
+              "min": "A String",
             },
           ],
-          "protocol": "A String", # The IP protocol this rule applies to. This value can either be one of the following well known protocol strings (TCP, UDP, ICMP, ESP, AH, IPIP, SCTP) or a string representation of the integer value.
+          "protocol": "A String",
         },
       ],
     },
-    "denied": { # Denied IP rule. # Tuple with denied rules.
-      "ipRules": [ # Optional. Optional list of denied IP rules.
-        { # IP rule information.
-          "portRanges": [ # Optional. An optional list of ports to which this rule applies. This field is only applicable for the UDP or (S)TCP protocols. Each entry must be either an integer or a range including a min and max port number.
-            { # A port range which is inclusive of the min and max values. Values are between 0 and 2^16-1. The max can be equal / must be not smaller than the min value. If min and max are equal this indicates that it is a single port.
-              "max": "A String", # Maximum port value.
-              "min": "A String", # Minimum port value.
+    "denied": {
+      "ipRules": [
+        {
+          "portRanges": [
+            {
+              "max": "A String",
+              "min": "A String",
             },
           ],
-          "protocol": "A String", # The IP protocol this rule applies to. This value can either be one of the following well known protocol strings (TCP, UDP, ICMP, ESP, AH, IPIP, SCTP) or a string representation of the integer value.
+          "protocol": "A String",
         },
       ],
     },
-    "destinationIpRanges": [ # If destination IP ranges are specified, the firewall rule applies only to traffic that has a destination IP address in these ranges. These ranges must be expressed in CIDR format. Only supports IPv4.
+    "destinationIpRanges": [
       "A String",
     ],
-    "direction": "A String", # The direction that the rule is applicable to, one of ingress or egress.
-    "exposedServices": [ # Name of the network protocol service, such as FTP, that is exposed by the open port. Follows the naming convention available at: https://www.iana.org/assignments/service-names-port-numbers/service-names-port-numbers.xhtml.
+    "direction": "A String",
+    "exposedServices": [
       "A String",
     ],
-    "sourceIpRanges": [ # If source IP ranges are specified, the firewall rule applies only to traffic that has a source IP address in these ranges. These ranges must be expressed in CIDR format. Only supports IPv4.
+    "sourceIpRanges": [
       "A String",
     ],
   },
-  "job": { # Describes a job # Job associated with the finding.
-    "errorCode": 42, # Optional. If the job did not complete successfully, this field describes why.
-    "location": "A String", # Optional. Gives the location where the job ran, such as `US` or `europe-west1`
-    "name": "A String", # The fully-qualified name for a job. e.g. `projects//jobs/`
-    "state": "A String", # Output only. State of the job, such as `RUNNING` or `PENDING`.
-  },
-  "kernelRootkit": { # Kernel mode rootkit signatures. # Signature of the kernel rootkit.
-    "name": "A String", # Rootkit name, when available.
-    "unexpectedCodeModification": True or False, # True if unexpected modifications of kernel code memory are present.
-    "unexpectedFtraceHandler": True or False, # True if `ftrace` points are present with callbacks pointing to regions that are not in the expected kernel or module code range.
-    "unexpectedInterruptHandler": True or False, # True if interrupt handlers that are are not in the expected kernel or module code regions are present.
-    "unexpectedKernelCodePages": True or False, # True if kernel code pages that are not in the expected kernel or module code regions are present.
-    "unexpectedKprobeHandler": True or False, # True if `kprobe` points are present with callbacks pointing to regions that are not in the expected kernel or module code range.
-    "unexpectedProcessesInRunqueue": True or False, # True if unexpected processes in the scheduler run queue are present. Such processes are in the run queue, but not in the process task list.
-    "unexpectedReadOnlyDataModification": True or False, # True if unexpected modifications of kernel read-only data memory are present.
-    "unexpectedSystemCallHandler": True or False, # True if system call handlers that are are not in the expected kernel or module code regions are present.
-  },
-  "kubernetes": { # Kubernetes-related attributes. # Kubernetes resources associated with the finding.
-    "accessReviews": [ # Provides information on any Kubernetes access reviews (privilege checks) relevant to the finding.
-      { # Conveys information about a Kubernetes access review (such as one returned by a [`kubectl auth can-i`](https://kubernetes.io/docs/reference/access-authn-authz/authorization/#checking-api-access) command) that was involved in a finding.
-        "group": "A String", # The API group of the resource. "*" means all.
-        "name": "A String", # The name of the resource being requested. Empty means all.
-        "ns": "A String", # Namespace of the action being requested. Currently, there is no distinction between no namespace and all namespaces. Both are represented by "" (empty).
-        "resource": "A String", # The optional resource type requested. "*" means all.
-        "subresource": "A String", # The optional subresource type.
-        "verb": "A String", # A Kubernetes resource API verb, like get, list, watch, create, update, delete, proxy. "*" means all.
-        "version": "A String", # The API version of the resource. "*" means all.
-      },
-    ],
-    "bindings": [ # Provides Kubernetes role binding information for findings that involve [RoleBindings or ClusterRoleBindings](https://cloud.google.com/kubernetes-engine/docs/how-to/role-based-access-control).
-      { # Represents a Kubernetes RoleBinding or ClusterRoleBinding.
-        "name": "A String", # Name for the binding.
-        "ns": "A String", # Namespace for the binding.
-        "role": { # Kubernetes Role or ClusterRole. # The Role or ClusterRole referenced by the binding.
-          "kind": "A String", # Role type.
-          "name": "A String", # Role name.
-          "ns": "A String", # Role namespace.
+  "job": {
+    "errorCode": 42,
+    "location": "A String",
+    "name": "A String",
+    "state": "A String",
+  },
+  "kernelRootkit": {
+    "name": "A String",
+    "unexpectedCodeModification": True or False,
+    "unexpectedFtraceHandler": True or False,
+    "unexpectedInterruptHandler": True or False,
+    "unexpectedKernelCodePages": True or False,
+    "unexpectedKprobeHandler": True or False,
+    "unexpectedProcessesInRunqueue": True or False,
+    "unexpectedReadOnlyDataModification": True or False,
+    "unexpectedSystemCallHandler": True or False,
+  },
+  "kubernetes": {
+    "accessReviews": [
+      {
+        "group": "A String",
+        "name": "A String",
+        "ns": "A String",
+        "resource": "A String",
+        "subresource": "A String",
+        "verb": "A String",
+        "version": "A String",
+      },
+    ],
+    "bindings": [
+      {
+        "name": "A String",
+        "ns": "A String",
+        "role": {
+          "kind": "A String",
+          "name": "A String",
+          "ns": "A String",
         },
-        "subjects": [ # Represents one or more subjects that are bound to the role. Not always available for PATCH requests.
-          { # Represents a Kubernetes subject.
-            "kind": "A String", # Authentication type for the subject.
-            "name": "A String", # Name for the subject.
-            "ns": "A String", # Namespace for the subject.
+        "subjects": [
+          {
+            "kind": "A String",
+            "name": "A String",
+            "ns": "A String",
           },
         ],
       },
     ],
-    "nodePools": [ # GKE [node pools](https://cloud.google.com/kubernetes-engine/docs/concepts/node-pools) associated with the finding. This field contains node pool information for each node, when it is available.
-      { # Provides GKE node pool information.
-        "name": "A String", # Kubernetes node pool name.
-        "nodes": [ # Nodes associated with the finding.
-          { # Kubernetes nodes associated with the finding.
-            "name": "A String", # [Full resource name](https://google.aip.dev/122#full-resource-names) of the Compute Engine VM running the cluster node.
+    "nodePools": [
+      {
+        "name": "A String",
+        "nodes": [
+          {
+            "name": "A String",
           },
         ],
       },
     ],
-    "nodes": [ # Provides Kubernetes [node](https://cloud.google.com/kubernetes-engine/docs/concepts/cluster-architecture#nodes) information.
-      { # Kubernetes nodes associated with the finding.
-        "name": "A String", # [Full resource name](https://google.aip.dev/122#full-resource-names) of the Compute Engine VM running the cluster node.
+    "nodes": [
+      {
+        "name": "A String",
       },
     ],
-    "objects": [ # Kubernetes objects related to the finding.
-      { # Kubernetes object related to the finding, uniquely identified by GKNN. Used if the object Kind is not one of Pod, Node, NodePool, Binding, or AccessReview.
-        "containers": [ # Pod containers associated with this finding, if any.
-          { # Container associated with the finding.
-            "createTime": "A String", # The time that the container was created.
-            "imageId": "A String", # Optional container image ID, if provided by the container runtime. Uniquely identifies the container image launched using a container image digest.
-            "labels": [ # Container labels, as provided by the container runtime.
-              { # Represents a generic name-value label. A label has separate name and value fields to support filtering with the `contains()` function. For more information, see [Filtering on array-type fields](https://cloud.google.com/security-command-center/docs/how-to-api-list-findings#array-contains-filtering).
-                "name": "A String", # Name of the label.
-                "value": "A String", # Value that corresponds to the label's name.
+    "objects": [
+      {
+        "containers": [
+          {
+            "createTime": "A String",
+            "imageId": "A String",
+            "labels": [
+              {
+                "name": "A String",
+                "value": "A String",
               },
             ],
-            "name": "A String", # Name of the container.
-            "uri": "A String", # Container image URI provided when configuring a pod or container. This string can identify a container image version using mutable tags.
+            "name": "A String",
+            "uri": "A String",
           },
         ],
-        "group": "A String", # Kubernetes object group, such as "policy.k8s.io/v1".
-        "kind": "A String", # Kubernetes object kind, such as "Namespace".
-        "name": "A String", # Kubernetes object name. For details see https://kubernetes.io/docs/concepts/overview/working-with-objects/names/.
-        "ns": "A String", # Kubernetes object namespace. Must be a valid DNS label. Named "ns" to avoid collision with C++ namespace keyword. For details see https://kubernetes.io/docs/tasks/administer-cluster/namespaces/.
-      },
-    ],
-    "pods": [ # Kubernetes [Pods](https://cloud.google.com/kubernetes-engine/docs/concepts/pod) associated with the finding. This field contains Pod records for each container that is owned by a Pod.
-      { # A Kubernetes Pod.
-        "containers": [ # Pod containers associated with this finding, if any.
-          { # Container associated with the finding.
-            "createTime": "A String", # The time that the container was created.
-            "imageId": "A String", # Optional container image ID, if provided by the container runtime. Uniquely identifies the container image launched using a container image digest.
-            "labels": [ # Container labels, as provided by the container runtime.
-              { # Represents a generic name-value label. A label has separate name and value fields to support filtering with the `contains()` function. For more information, see [Filtering on array-type fields](https://cloud.google.com/security-command-center/docs/how-to-api-list-findings#array-contains-filtering).
-                "name": "A String", # Name of the label.
-                "value": "A String", # Value that corresponds to the label's name.
+        "group": "A String",
+        "kind": "A String",
+        "name": "A String",
+        "ns": "A String",
+      },
+    ],
+    "pods": [
+      {
+        "containers": [
+          {
+            "createTime": "A String",
+            "imageId": "A String",
+            "labels": [
+              {
+                "name": "A String",
+                "value": "A String",
               },
             ],
-            "name": "A String", # Name of the container.
-            "uri": "A String", # Container image URI provided when configuring a pod or container. This string can identify a container image version using mutable tags.
+            "name": "A String",
+            "uri": "A String",
           },
         ],
-        "labels": [ # Pod labels. For Kubernetes containers, these are applied to the container.
-          { # Represents a generic name-value label. A label has separate name and value fields to support filtering with the `contains()` function. For more information, see [Filtering on array-type fields](https://cloud.google.com/security-command-center/docs/how-to-api-list-findings#array-contains-filtering).
-            "name": "A String", # Name of the label.
-            "value": "A String", # Value that corresponds to the label's name.
+        "labels": [
+          {
+            "name": "A String",
+            "value": "A String",
           },
         ],
-        "name": "A String", # Kubernetes Pod name.
-        "ns": "A String", # Kubernetes Pod namespace.
+        "name": "A String",
+        "ns": "A String",
       },
     ],
-    "roles": [ # Provides Kubernetes role information for findings that involve [Roles or ClusterRoles](https://cloud.google.com/kubernetes-engine/docs/how-to/role-based-access-control).
-      { # Kubernetes Role or ClusterRole.
-        "kind": "A String", # Role type.
-        "name": "A String", # Role name.
-        "ns": "A String", # Role namespace.
+    "roles": [
+      {
+        "kind": "A String",
+        "name": "A String",
+        "ns": "A String",
       },
     ],
   },
-  "loadBalancers": [ # The load balancers associated with the finding.
-    { # Contains information related to the load balancer associated with the finding.
-      "name": "A String", # The name of the load balancer associated with the finding.
+  "loadBalancers": [
+    {
+      "name": "A String",
     },
   ],
-  "logEntries": [ # Log entries that are relevant to the finding.
-    { # An individual entry in a log.
-      "cloudLoggingEntry": { # Metadata taken from a [Cloud Logging LogEntry](https://cloud.google.com/logging/docs/reference/v2/rest/v2/LogEntry) # An individual entry in a log stored in Cloud Logging.
-        "insertId": "A String", # A unique identifier for the log entry.
-        "logId": "A String", # The type of the log (part of `log_name`. `log_name` is the resource name of the log to which this log entry belongs). For example: `cloudresourcemanager.googleapis.com/activity`. Note that this field is not URL-encoded, unlike the `LOG_ID` field in `LogEntry`.
-        "resourceContainer": "A String", # The organization, folder, or project of the monitored resource that produced this log entry.
-        "timestamp": "A String", # The time the event described by the log entry occurred.
+  "logEntries": [
+    {
+      "cloudLoggingEntry": {
+        "insertId": "A String",
+        "logId": "A String",
+        "resourceContainer": "A String",
+        "timestamp": "A String",
       },
     },
   ],
-  "mitreAttack": { # MITRE ATT&CK tactics and techniques related to this finding. See: https://attack.mitre.org # MITRE ATT&CK tactics and techniques related to this finding. See: https://attack.mitre.org
-    "additionalTactics": [ # Additional MITRE ATT&CK tactics related to this finding, if any.
+  "mitreAttack": {
+    "additionalTactics": [
       "A String",
     ],
-    "additionalTechniques": [ # Additional MITRE ATT&CK techniques related to this finding, if any, along with any of their respective parent techniques.
+    "additionalTechniques": [
       "A String",
     ],
-    "primaryTactic": "A String", # The MITRE ATT&CK tactic most closely represented by this finding, if any.
-    "primaryTechniques": [ # The MITRE ATT&CK technique most closely represented by this finding, if any. primary_techniques is a repeated field because there are multiple levels of MITRE ATT&CK techniques. If the technique most closely represented by this finding is a sub-technique (e.g. `SCANNING_IP_BLOCKS`), both the sub-technique and its parent technique(s) will be listed (e.g. `SCANNING_IP_BLOCKS`, `ACTIVE_SCANNING`).
+    "primaryTactic": "A String",
+    "primaryTechniques": [
       "A String",
     ],
-    "version": "A String", # The MITRE ATT&CK version referenced by the above fields. E.g. "8".
+    "version": "A String",
   },
-  "moduleName": "A String", # Unique identifier of the module which generated the finding. Example: folders/598186756061/securityHealthAnalyticsSettings/customModules/56799441161885
-  "mute": "A String", # Indicates the mute state of a finding (either muted, unmuted or undefined). Unlike other attributes of a finding, a finding provider shouldn't set the value of mute.
-  "muteInfo": { # Mute information about the finding, including whether the finding has a static mute or any matching dynamic mute rules. # Output only. The mute information regarding this finding.
-    "dynamicMuteRecords": [ # The list of dynamic mute rules that currently match the finding.
-      { # The record of a dynamic mute rule that matches the finding.
-        "matchTime": "A String", # When the dynamic mute rule first matched the finding.
-        "muteConfig": "A String", # The relative resource name of the mute rule, represented by a mute config, that created this record, for example `organizations/123/muteConfigs/mymuteconfig` or `organizations/123/locations/global/muteConfigs/mymuteconfig`.
+  "moduleName": "A String",
+  "mute": "A String",
+  "muteInfo": {
+    "dynamicMuteRecords": [
+      {
+        "matchTime": "A String",
+        "muteConfig": "A String",
       },
     ],
-    "staticMute": { # Information about the static mute state. A static mute state overrides any dynamic mute rules that apply to this finding. The static mute state can be set by a static mute rule or by muting the finding directly. # If set, the static mute applied to this finding. Static mutes override dynamic mutes. If unset, there is no static mute.
-      "applyTime": "A String", # When the static mute was applied.
-      "state": "A String", # The static mute state. If the value is `MUTED` or `UNMUTED`, then the finding's overall mute state will have the same value.
+    "staticMute": {
+      "applyTime": "A String",
+      "state": "A String",
     },
   },
-  "muteInitiator": "A String", # Records additional information about the mute operation, for example, the [mute configuration](/security-command-center/docs/how-to-mute-findings) that muted the finding and the user who muted the finding.
-  "muteUpdateTime": "A String", # Output only. The most recent time this finding was muted or unmuted.
-  "name": "A String", # The [relative resource name](https://cloud.google.com/apis/design/resource_names#relative_resource_name) of the finding. Example: "organizations/{organization_id}/sources/{source_id}/findings/{finding_id}", "folders/{folder_id}/sources/{source_id}/findings/{finding_id}", "projects/{project_id}/sources/{source_id}/findings/{finding_id}".
-  "networks": [ # Represents the VPC networks that the resource is attached to.
-    { # Contains information about a VPC network associated with the finding.
-      "name": "A String", # The name of the VPC network resource, for example, `//compute.googleapis.com/projects/my-project/global/networks/my-network`.
+  "muteInitiator": "A String",
+  "muteUpdateTime": "A String",
+  "name": "A String",
+  "networks": [
+    {
+      "name": "A String",
     },
   ],
-  "nextSteps": "A String", # Steps to address the finding.
-  "notebook": { # Represents a Jupyter notebook IPYNB file, such as a [Colab Enterprise notebook](https://cloud.google.com/colab/docs/introduction) file, that is associated with a finding. # Notebook associated with the finding.
-    "lastAuthor": "A String", # The user ID of the latest author to modify the notebook.
-    "name": "A String", # The name of the notebook.
-    "notebookUpdateTime": "A String", # The most recent time the notebook was updated.
-    "service": "A String", # The source notebook service, for example, "Colab Enterprise".
+  "nextSteps": "A String",
+  "notebook": {
+    "lastAuthor": "A String",
+    "name": "A String",
+    "notebookUpdateTime": "A String",
+    "service": "A String",
   },
-  "orgPolicies": [ # Contains information about the org policies associated with the finding.
-    { # Contains information about the org policies associated with the finding.
-      "name": "A String", # The resource name of the org policy. Example: "organizations/{organization_id}/policies/{constraint_name}"
+  "orgPolicies": [
+    {
+      "name": "A String",
     },
   ],
-  "parent": "A String", # The relative resource name of the source the finding belongs to. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name This field is immutable after creation time. For example: "organizations/{organization_id}/sources/{source_id}"
-  "parentDisplayName": "A String", # Output only. The human readable display name of the finding source such as "Event Threat Detection" or "Security Health Analytics".
-  "policyViolationSummary": { # Metadata summarizing policy violations of child resources of the affected resource. `finding_category` and `resource` determine the exact semantics of the counts. For example, when category=DATA_SECURITY_POSTURE_OBJECT_PUBLIC_ACCESS_VIOLATION and resource='storage.googleapis.com/buckets/my-bucket-name' then this counts the number of Cloud Storage objects in my-bucket-name which violate a Public Access control. # PolicyViolationSummary associated with the finding.
-    "conformantResourcesCount": "A String", # Total number of child resources that conform to the policy.
-    "evaluationErrorsCount": "A String", # Number of child resources for which errors during evaluation occurred. The evaluation result for these child resources is effectively "unknown".
-    "outOfScopeResourcesCount": "A String", # Total count of child resources which were not in scope for evaluation.
-    "policyViolationsCount": "A String", # Count of child resources in violation of the policy.
-  },
-  "processes": [ # Represents operating system processes associated with the Finding.
-    { # Represents an operating system process.
-      "args": [ # Process arguments as JSON encoded strings.
+  "parent": "A String",
+  "parentDisplayName": "A String",
+  "policyViolationSummary": {
+    "conformantResourcesCount": "A String",
+    "evaluationErrorsCount": "A String",
+    "outOfScopeResourcesCount": "A String",
+    "policyViolationsCount": "A String",
+  },
+  "processes": [
+    {
+      "args": [
         "A String",
       ],
-      "argumentsTruncated": True or False, # True if `args` is incomplete.
-      "binary": { # File information about the related binary/library used by an executable, or the script used by a script interpreter # File information for the process executable.
-        "contents": "A String", # Prefix of the file contents as a JSON-encoded string.
-        "diskPath": { # Path of the file in terms of underlying disk/partition identifiers. # Path of the file in terms of underlying disk/partition identifiers.
-          "partitionUuid": "A String", # UUID of the partition (format https://wiki.archlinux.org/title/persistent_block_device_naming#by-uuid)
-          "relativePath": "A String", # Relative path of the file in the partition as a JSON encoded string. Example: /home/user1/executable_file.sh
+      "argumentsTruncated": True or False,
+      "binary": {
+        "contents": "A String",
+        "diskPath": {
+          "partitionUuid": "A String",
+          "relativePath": "A String",
         },
-        "fileLoadState": "A String", # The load state of the file.
-        "hashedSize": "A String", # The length in bytes of the file prefix that was hashed. If hashed_size == size, any hashes reported represent the entire file.
-        "operations": [ # Operation(s) performed on a file.
-          { # Operation(s) performed on a file.
-            "type": "A String", # The type of the operation
+        "fileLoadState": "A String",
+        "hashedSize": "A String",
+        "operations": [
+          {
+            "type": "A String",
           },
         ],
-        "partiallyHashed": True or False, # True when the hash covers only a prefix of the file.
-        "path": "A String", # Absolute path of the file as a JSON encoded string.
-        "sha256": "A String", # SHA256 hash of the first hashed_size bytes of the file encoded as a hex string. If hashed_size == size, sha256 represents the SHA256 hash of the entire file.
-        "size": "A String", # Size of the file in bytes.
-      },
-      "envVariables": [ # Process environment variables.
-        { # A name-value pair representing an environment variable used in an operating system process.
-          "name": "A String", # Environment variable name as a JSON encoded string.
-          "val": "A String", # Environment variable value as a JSON encoded string.
+        "partiallyHashed": True or False,
+        "path": "A String",
+        "sha256": "A String",
+        "size": "A String",
+      },
+      "envVariables": [
+        {
+          "name": "A String",
+          "val": "A String",
         },
       ],
-      "envVariablesTruncated": True or False, # True if `env_variables` is incomplete.
-      "libraries": [ # File information for libraries loaded by the process.
-        { # File information about the related binary/library used by an executable, or the script used by a script interpreter
-          "contents": "A String", # Prefix of the file contents as a JSON-encoded string.
-          "diskPath": { # Path of the file in terms of underlying disk/partition identifiers. # Path of the file in terms of underlying disk/partition identifiers.
-            "partitionUuid": "A String", # UUID of the partition (format https://wiki.archlinux.org/title/persistent_block_device_naming#by-uuid)
-            "relativePath": "A String", # Relative path of the file in the partition as a JSON encoded string. Example: /home/user1/executable_file.sh
+      "envVariablesTruncated": True or False,
+      "libraries": [
+        {
+          "contents": "A String",
+          "diskPath": {
+            "partitionUuid": "A String",
+            "relativePath": "A String",
           },
-          "fileLoadState": "A String", # The load state of the file.
-          "hashedSize": "A String", # The length in bytes of the file prefix that was hashed. If hashed_size == size, any hashes reported represent the entire file.
-          "operations": [ # Operation(s) performed on a file.
-            { # Operation(s) performed on a file.
-              "type": "A String", # The type of the operation
+          "fileLoadState": "A String",
+          "hashedSize": "A String",
+          "operations": [
+            {
+              "type": "A String",
             },
           ],
-          "partiallyHashed": True or False, # True when the hash covers only a prefix of the file.
-          "path": "A String", # Absolute path of the file as a JSON encoded string.
-          "sha256": "A String", # SHA256 hash of the first hashed_size bytes of the file encoded as a hex string. If hashed_size == size, sha256 represents the SHA256 hash of the entire file.
-          "size": "A String", # Size of the file in bytes.
+          "partiallyHashed": True or False,
+          "path": "A String",
+          "sha256": "A String",
+          "size": "A String",
         },
       ],
-      "name": "A String", # The process name, as displayed in utilities like `top` and `ps`. This name can be accessed through `/proc/[pid]/comm` and changed with `prctl(PR_SET_NAME)`.
-      "parentPid": "A String", # The parent process ID.
-      "pid": "A String", # The process ID.
-      "script": { # File information about the related binary/library used by an executable, or the script used by a script interpreter # When the process represents the invocation of a script, `binary` provides information about the interpreter, while `script` provides information about the script file provided to the interpreter.
-        "contents": "A String", # Prefix of the file contents as a JSON-encoded string.
-        "diskPath": { # Path of the file in terms of underlying disk/partition identifiers. # Path of the file in terms of underlying disk/partition identifiers.
-          "partitionUuid": "A String", # UUID of the partition (format https://wiki.archlinux.org/title/persistent_block_device_naming#by-uuid)
-          "relativePath": "A String", # Relative path of the file in the partition as a JSON encoded string. Example: /home/user1/executable_file.sh
+      "name": "A String",
+      "parentPid": "A String",
+      "pid": "A String",
+      "script": {
+        "contents": "A String",
+        "diskPath": {
+          "partitionUuid": "A String",
+          "relativePath": "A String",
         },
-        "fileLoadState": "A String", # The load state of the file.
-        "hashedSize": "A String", # The length in bytes of the file prefix that was hashed. If hashed_size == size, any hashes reported represent the entire file.
-        "operations": [ # Operation(s) performed on a file.
-          { # Operation(s) performed on a file.
-            "type": "A String", # The type of the operation
+        "fileLoadState": "A String",
+        "hashedSize": "A String",
+        "operations": [
+          {
+            "type": "A String",
           },
         ],
-        "partiallyHashed": True or False, # True when the hash covers only a prefix of the file.
-        "path": "A String", # Absolute path of the file as a JSON encoded string.
-        "sha256": "A String", # SHA256 hash of the first hashed_size bytes of the file encoded as a hex string. If hashed_size == size, sha256 represents the SHA256 hash of the entire file.
-        "size": "A String", # Size of the file in bytes.
+        "partiallyHashed": True or False,
+        "path": "A String",
+        "sha256": "A String",
+        "size": "A String",
       },
-      "userId": "A String", # The ID of the user that executed the process. E.g. If this is the root user this will always be 0.
+      "userId": "A String",
     },
   ],
-  "resourceName": "A String", # For findings on Google Cloud resources, the full resource name of the Google Cloud resource this finding is for. See: https://cloud.google.com/apis/design/resource_names#full_resource_name When the finding is for a non-Google Cloud resource, the resourceName can be a customer or partner defined string. This field is immutable after creation time.
-  "secret": { # Details about a secret or credential associated with the finding. # Secret associated with the finding.
-    "environmentVariable": { # Environment variable containing the secret. # The environment variable containing the secret.
-      "key": "A String", # Environment variable name as a JSON encoded string. Note that value is not included since the value contains the secret data, which is sensitive core content.
+  "resourceName": "A String",
+  "secret": {
+    "environmentVariable": {
+      "key": "A String",
     },
-    "filePath": { # File path containing the secret. # The file containing the secret.
-      "path": "A String", # Path to the file.
+    "filePath": {
+      "path": "A String",
     },
-    "status": { # The status of the secret. # The status of the secret.
-      "lastUpdatedTime": "A String", # Time that the secret was found.
-      "validity": "A String", # The validity of the secret.
+    "status": {
+      "lastUpdatedTime": "A String",
+      "validity": "A String",
     },
-    "type": "A String", # The type of secret, for example, GCP_API_KEY.
+    "type": "A String",
   },
-  "securityMarks": { # User specified security marks that are attached to the parent Security Command Center resource. Security marks are scoped within a Security Command Center organization -- they can be modified and viewed by all users who have proper permissions on the organization. # Output only. User specified security marks. These marks are entirely managed by the user and come from the SecurityMarks resource that belongs to the finding.
-    "canonicalName": "A String", # The canonical name of the marks. Examples: "organizations/{organization_id}/assets/{asset_id}/securityMarks" "folders/{folder_id}/assets/{asset_id}/securityMarks" "projects/{project_number}/assets/{asset_id}/securityMarks" "organizations/{organization_id}/sources/{source_id}/findings/{finding_id}/securityMarks" "folders/{folder_id}/sources/{source_id}/findings/{finding_id}/securityMarks" "projects/{project_number}/sources/{source_id}/findings/{finding_id}/securityMarks"
-    "marks": { # Mutable user specified security marks belonging to the parent resource. Constraints are as follows: * Keys and values are treated as case insensitive * Keys must be between 1 - 256 characters (inclusive) * Keys must be letters, numbers, underscores, or dashes * Values have leading and trailing whitespace trimmed, remaining characters must be between 1 - 4096 characters (inclusive)
+  "securityMarks": {
+    "canonicalName": "A String",
+    "marks": {
       "a_key": "A String",
     },
-    "name": "A String", # The relative resource name of the SecurityMarks. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Examples: "organizations/{organization_id}/assets/{asset_id}/securityMarks" "organizations/{organization_id}/sources/{source_id}/findings/{finding_id}/securityMarks".
+    "name": "A String",
   },
-  "securityPosture": { # Represents a posture that is deployed on Google Cloud by the Security Command Center Posture Management service. A posture contains one or more policy sets. A policy set is a group of policies that enforce a set of security rules on Google Cloud. # The security posture associated with the finding.
-    "changedPolicy": "A String", # The name of the updated policy, for example, `projects/{project_id}/policies/{constraint_name}`.
-    "name": "A String", # Name of the posture, for example, `CIS-Posture`.
-    "policy": "A String", # The ID of the updated policy, for example, `compute-policy-1`.
-    "policyDriftDetails": [ # The details about a change in an updated policy that violates the deployed posture.
-      { # The policy field that violates the deployed posture and its expected and detected values.
-        "detectedValue": "A String", # The detected value that violates the deployed posture, for example, `false` or `allowed_values={"projects/22831892"}`.
-        "expectedValue": "A String", # The value of this field that was configured in a posture, for example, `true` or `allowed_values={"projects/29831892"}`.
-        "field": "A String", # The name of the updated field, for example constraint.implementation.policy_rules[0].enforce
+  "securityPosture": {
+    "changedPolicy": "A String",
+    "name": "A String",
+    "policy": "A String",
+    "policyDriftDetails": [
+      {
+        "detectedValue": "A String",
+        "expectedValue": "A String",
+        "field": "A String",
       },
     ],
-    "policySet": "A String", # The name of the updated policyset, for example, `cis-policyset`.
-    "postureDeployment": "A String", # The name of the posture deployment, for example, `organizations/{org_id}/posturedeployments/{posture_deployment_id}`.
-    "postureDeploymentResource": "A String", # The project, folder, or organization on which the posture is deployed, for example, `projects/{project_number}`.
-    "revisionId": "A String", # The version of the posture, for example, `c7cfa2a8`.
+    "policySet": "A String",
+    "postureDeployment": "A String",
+    "postureDeploymentResource": "A String",
+    "revisionId": "A String",
   },
-  "severity": "A String", # The severity of the finding. This field is managed by the source that writes the finding.
-  "sourceProperties": { # Source specific properties. These properties are managed by the source that writes the finding. The key names in the source_properties map must be between 1 and 255 characters, and must start with a letter and contain alphanumeric characters or underscores only.
+  "severity": "A String",
+  "sourceProperties": {
     "a_key": "",
   },
-  "state": "A String", # The state of the finding.
-  "toxicCombination": { # Contains details about a group of security issues that, when the issues occur together, represent a greater risk than when the issues occur independently. A group of such issues is referred to as a toxic combination. # Contains details about a group of security issues that, when the issues occur together, represent a greater risk than when the issues occur independently. A group of such issues is referred to as a toxic combination. This field cannot be updated. Its value is ignored in all update requests.
-    "attackExposureScore": 3.14, # The [Attack exposure score](https://cloud.google.com/security-command-center/docs/attack-exposure-learn#attack_exposure_scores) of this toxic combination. The score is a measure of how much this toxic combination exposes one or more high-value resources to potential attack.
-    "relatedFindings": [ # List of resource names of findings associated with this toxic combination. For example, `organizations/123/sources/456/findings/789`.
+  "state": "A String",
+  "toxicCombination": {
+    "attackExposureScore": 3.14,
+    "relatedFindings": [
       "A String",
     ],
   },
-  "vertexAi": { # Vertex AI-related information associated with the finding. # VertexAi associated with the finding.
-    "datasets": [ # Datasets associated with the finding.
-      { # Vertex AI dataset associated with the finding.
-        "displayName": "A String", # The user defined display name of dataset, e.g. plants-dataset
-        "name": "A String", # Resource name of the dataset, e.g. projects/{project}/locations/{location}/datasets/2094040236064505856
-        "source": "A String", # Data source, such as BigQuery source URI, e.g. bq://scc-nexus-test.AIPPtest.gsod
-      },
-    ],
-    "pipelines": [ # Pipelines associated with the finding.
-      { # Vertex AI training pipeline associated with the finding.
-        "displayName": "A String", # The user defined display name of pipeline, e.g. plants-classification
-        "name": "A String", # Resource name of the pipeline, e.g. projects/{project}/locations/{location}/trainingPipelines/5253428229225578496
-      },
-    ],
-  },
-  "vulnerability": { # Refers to common vulnerability fields e.g. cve, cvss, cwe etc. # Represents vulnerability-specific fields like CVE and CVSS scores. CVE stands for Common Vulnerabilities and Exposures (https://cve.mitre.org/about/)
-    "cve": { # CVE stands for Common Vulnerabilities and Exposures. Information from the [CVE record](https://www.cve.org/ResourcesSupport/Glossary) that describes this vulnerability. # CVE stands for Common Vulnerabilities and Exposures (https://cve.mitre.org/about/)
-      "cvssv3": { # Common Vulnerability Scoring System version 3. # Describe Common Vulnerability Scoring System specified at https://www.first.org/cvss/v3.1/specification-document
-        "attackComplexity": "A String", # This metric describes the conditions beyond the attacker's control that must exist in order to exploit the vulnerability.
-        "attackVector": "A String", # Base Metrics Represents the intrinsic characteristics of a vulnerability that are constant over time and across user environments. This metric reflects the context by which vulnerability exploitation is possible.
-        "availabilityImpact": "A String", # This metric measures the impact to the availability of the impacted component resulting from a successfully exploited vulnerability.
-        "baseScore": 3.14, # The base score is a function of the base metric scores.
-        "confidentialityImpact": "A String", # This metric measures the impact to the confidentiality of the information resources managed by a software component due to a successfully exploited vulnerability.
-        "integrityImpact": "A String", # This metric measures the impact to integrity of a successfully exploited vulnerability.
-        "privilegesRequired": "A String", # This metric describes the level of privileges an attacker must possess before successfully exploiting the vulnerability.
-        "scope": "A String", # The Scope metric captures whether a vulnerability in one vulnerable component impacts resources in components beyond its security scope.
-        "userInteraction": "A String", # This metric captures the requirement for a human user, other than the attacker, to participate in the successful compromise of the vulnerable component.
-      },
-      "exploitReleaseDate": "A String", # Date the first publicly available exploit or PoC was released.
-      "exploitationActivity": "A String", # The exploitation activity of the vulnerability in the wild.
-      "firstExploitationDate": "A String", # Date of the earliest known exploitation.
-      "id": "A String", # The unique identifier for the vulnerability. e.g. CVE-2021-34527
-      "impact": "A String", # The potential impact of the vulnerability if it was to be exploited.
-      "observedInTheWild": True or False, # Whether or not the vulnerability has been observed in the wild.
-      "references": [ # Additional information about the CVE. e.g. https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2021-34527
-        { # Additional Links
-          "source": "A String", # Source of the reference e.g. NVD
-          "uri": "A String", # Uri for the mentioned source e.g. https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2021-34527.
+  "vertexAi": {
+    "datasets": [
+      {
+        "displayName": "A String",
+        "name": "A String",
+        "source": "A String",
+      },
+    ],
+    "pipelines": [
+      {
+        "displayName": "A String",
+        "name": "A String",
+      },
+    ],
+  },
+  "vulnerability": {
+    "cve": {
+      "cvssv3": {
+        "attackComplexity": "A String",
+        "attackVector": "A String",
+        "availabilityImpact": "A String",
+        "baseScore": 3.14,
+        "confidentialityImpact": "A String",
+        "integrityImpact": "A String",
+        "privilegesRequired": "A String",
+        "scope": "A String",
+        "userInteraction": "A String",
+      },
+      "exploitReleaseDate": "A String",
+      "exploitationActivity": "A String",
+      "firstExploitationDate": "A String",
+      "id": "A String",
+      "impact": "A String",
+      "observedInTheWild": True or False,
+      "references": [
+        {
+          "source": "A String",
+          "uri": "A String",
         },
       ],
-      "upstreamFixAvailable": True or False, # Whether upstream fix is available for the CVE.
-      "zeroDay": True or False, # Whether or not the vulnerability was zero day when the finding was published.
-    },
-    "cwes": [ # Represents one or more Common Weakness Enumeration (CWE) information on this vulnerability.
-      { # CWE stands for Common Weakness Enumeration. Information about this weakness, as described by [CWE](https://cwe.mitre.org/).
-        "id": "A String", # The CWE identifier, e.g. CWE-94
-        "references": [ # Any reference to the details on the CWE, for example, https://cwe.mitre.org/data/definitions/94.html
-          { # Additional Links
-            "source": "A String", # Source of the reference e.g. NVD
-            "uri": "A String", # Uri for the mentioned source e.g. https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2021-34527.
+      "upstreamFixAvailable": True or False,
+      "zeroDay": True or False,
+    },
+    "cwes": [
+      {
+        "id": "A String",
+        "references": [
+          {
+            "source": "A String",
+            "uri": "A String",
           },
         ],
       },
     ],
-    "fixedPackage": { # Package is a generic definition of a package. # The fixed package is relevant to the finding.
-      "cpeUri": "A String", # The CPE URI where the vulnerability was detected.
-      "packageName": "A String", # The name of the package where the vulnerability was detected.
-      "packageType": "A String", # Type of package, for example, os, maven, or go.
-      "packageVersion": "A String", # The version of the package.
+    "fixedPackage": {
+      "cpeUri": "A String",
+      "packageName": "A String",
+      "packageType": "A String",
+      "packageVersion": "A String",
     },
-    "offendingPackage": { # Package is a generic definition of a package. # The offending package is relevant to the finding.
-      "cpeUri": "A String", # The CPE URI where the vulnerability was detected.
-      "packageName": "A String", # The name of the package where the vulnerability was detected.
-      "packageType": "A String", # Type of package, for example, os, maven, or go.
-      "packageVersion": "A String", # The version of the package.
+    "offendingPackage": {
+      "cpeUri": "A String",
+      "packageName": "A String",
+      "packageType": "A String",
+      "packageVersion": "A String",
     },
-    "providerRiskScore": "A String", # Provider provided risk_score based on multiple factors. The higher the risk score, the more risky the vulnerability is.
-    "reachable": True or False, # Represents whether the vulnerability is reachable (detected via static analysis)
-    "securityBulletin": { # SecurityBulletin are notifications of vulnerabilities of Google products. # The security bulletin is relevant to this finding.
-      "bulletinId": "A String", # ID of the bulletin corresponding to the vulnerability.
-      "submissionTime": "A String", # Submission time of this Security Bulletin.
-      "suggestedUpgradeVersion": "A String", # This represents a version that the cluster receiving this notification should be upgraded to, based on its current version. For example, 1.15.0
+    "providerRiskScore": "A String",
+    "reachable": True or False,
+    "securityBulletin": {
+      "bulletinId": "A String",
+      "submissionTime": "A String",
+      "suggestedUpgradeVersion": "A String",
     },
   },
 }
 
-  updateMask: string, The FieldMask to use when updating the finding resource. This field should not be specified when creating a finding. When updating a finding, an empty mask is treated as updating all mutable fields and replacing source_properties. Individual source_properties can be added/updated by using "source_properties." in the field mask.
+  updateMask: string, A parameter
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -3611,811 +3611,811 @@ 

Method Details

Returns: An object of the form: - { # Security Command Center finding. A finding is a record of assessment data like security, risk, health, or privacy, that is ingested into Security Command Center for presentation, notification, analysis, policy testing, and enforcement. For example, a cross-site scripting (XSS) vulnerability in an App Engine application is a finding. - "access": { # Represents an access event. # Access details associated with the finding, such as more information on the caller, which method was accessed, and from where. - "callerIp": "A String", # Caller's IP address, such as "1.1.1.1". - "callerIpGeo": { # Represents a geographical location for a given access. # The caller IP's geolocation, which identifies where the call came from. - "regionCode": "A String", # A CLDR. - }, - "methodName": "A String", # The method that the service account called, e.g. "SetIamPolicy". - "principalEmail": "A String", # Associated email, such as "foo@google.com". The email address of the authenticated user or a service account acting on behalf of a 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). - "principalSubject": "A String", # A string that represents the principal_subject that is associated with the identity. Unlike `principal_email`, `principal_subject` supports principals that aren't associated with email addresses, such as third party principals. For most identities, the format is `principal://iam.googleapis.com/{identity pool name}/subject/{subject}`. Some GKE identities, such as GKE_WORKLOAD, FREEFORM, and GKE_HUB_WORKLOAD, still use the legacy format `serviceAccount:{identity pool name}[{subject}]`. - "serviceAccountDelegationInfo": [ # The identity delegation history of an authenticated service account that made the request. The `serviceAccountDelegationInfo[]` object contains information about the real authorities that try to access Google Cloud resources by delegating on a service account. When multiple authorities are present, they are guaranteed to be sorted based on the original ordering of the identity delegation events. - { # Identity delegation history of an authenticated service account. - "principalEmail": "A String", # The email address of a Google account. - "principalSubject": "A String", # A string representing the principal_subject associated with the identity. As compared to `principal_email`, supports principals that aren't associated with email addresses, such as third party principals. For most identities, the format will be `principal://iam.googleapis.com/{identity pool name}/subjects/{subject}` except for some GKE identities (GKE_WORKLOAD, FREEFORM, GKE_HUB_WORKLOAD) that are still in the legacy format `serviceAccount:{identity pool name}[{subject}]` - }, - ], - "serviceAccountKeyName": "A String", # The name of the service account key that was used to create or exchange credentials when authenticating the service account that made the request. This is a scheme-less URI full resource name. For example: "//iam.googleapis.com/projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}/keys/{key}". - "serviceName": "A String", # This is the API service that the service account made a call to, e.g. "iam.googleapis.com" - "userAgent": "A String", # The caller's user agent string associated with the finding. - "userAgentFamily": "A String", # Type of user agent associated with the finding. For example, an operating system shell or an embedded or standalone application. - "userName": "A String", # A string that represents a username. The username provided depends on the type of the finding and is likely not an IAM principal. For example, this can be a system username if the finding is related to a virtual machine, or it can be an application login username. - }, - "affectedResources": { # Details about resources affected by this finding. # AffectedResources associated with the finding. - "count": "A String", # The count of resources affected by the finding. - }, - "agentDataAccessEvents": [ # Agent data access events associated with the finding. - { # Details about a data access attempt made by an agent principal not authorized under applicable data security policy. - "eventId": "A String", # Unique identifier for data access event. - "eventTime": "A String", # Timestamp of data access event. - "operation": "A String", # The operation performed by the principal to access the data. - "principalSubject": "A String", # The agent principal that accessed the data. + { + "access": { + "callerIp": "A String", + "callerIpGeo": { + "regionCode": "A String", + }, + "methodName": "A String", + "principalEmail": "A String", + "principalSubject": "A String", + "serviceAccountDelegationInfo": [ + { + "principalEmail": "A String", + "principalSubject": "A String", + }, + ], + "serviceAccountKeyName": "A String", + "serviceName": "A String", + "userAgent": "A String", + "userAgentFamily": "A String", + "userName": "A String", + }, + "affectedResources": { + "count": "A String", + }, + "agentDataAccessEvents": [ + { + "eventId": "A String", + "eventTime": "A String", + "operation": "A String", + "principalSubject": "A String", }, ], - "aiModel": { # Contains information about the AI model associated with the finding. # The AI model associated with the finding. - "deploymentPlatform": "A String", # The platform on which the model is deployed. - "displayName": "A String", # The user defined display name of model. Ex. baseline-classification-model - "domain": "A String", # The domain of the model, for example, “image-classification”. - "library": "A String", # The name of the model library, for example, “transformers”. - "location": "A String", # The region in which the model is used, for example, “us-central1”. - "name": "A String", # The name of the AI model, for example, "gemini:1.0.0". - "publisher": "A String", # The publisher of the model, for example, “google” or “nvidia”. - "usageCategory": "A String", # The purpose of the model, for example, "Inteference" or "Training". - }, - "application": { # Represents an application associated with a finding. # Represents an application associated with the finding. - "baseUri": "A String", # The base URI that identifies the network location of the application in which the vulnerability was detected. For example, `http://example.com`. - "fullUri": "A String", # The full URI with payload that can be used to reproduce the vulnerability. For example, `http://example.com?p=aMmYgI6H`. - }, - "artifactGuardPolicies": { # Represents the result of evaluating artifact guard policies. # ArtifactGuardPolicies associated with the finding. - "failingPolicies": [ # A list of failing policies. - { # Represents an artifact guard policy. - "failureReason": "A String", # The reason for the policy failure, for example, "severity=HIGH AND max_vuln_count=2". - "policyId": "A String", # The ID of the failing policy, for example, "organizations/3392779/locations/global/policies/prod-policy". - "type": "A String", # The type of the policy evaluation. - }, - ], - "resourceId": "A String", # The ID of the resource that has policies configured for it. - }, - "attackExposure": { # An attack exposure contains the results of an attack path simulation run. # The results of an attack path simulation relevant to this finding. - "attackExposureResult": "A String", # The resource name of the attack path simulation result that contains the details regarding this attack exposure score. Example: `organizations/123/simulations/456/attackExposureResults/789` - "exposedHighValueResourcesCount": 42, # The number of high value resources that are exposed as a result of this finding. - "exposedLowValueResourcesCount": 42, # The number of high value resources that are exposed as a result of this finding. - "exposedMediumValueResourcesCount": 42, # The number of medium value resources that are exposed as a result of this finding. - "latestCalculationTime": "A String", # The most recent time the attack exposure was updated on this finding. - "score": 3.14, # A number between 0 (inclusive) and infinity that represents how important this finding is to remediate. The higher the score, the more important it is to remediate. - "state": "A String", # What state this AttackExposure is in. This captures whether or not an attack exposure has been calculated or not. - }, - "backupDisasterRecovery": { # Information related to Google Cloud Backup and DR Service findings. # Fields related to Backup and DR findings. - "appliance": "A String", # The name of the Backup and DR appliance that captures, moves, and manages the lifecycle of backup data. For example, `backup-server-57137`. - "applications": [ # The names of Backup and DR applications. An application is a VM, database, or file system on a managed host monitored by a backup and recovery appliance. For example, `centos7-01-vol00`, `centos7-01-vol01`, `centos7-01-vol02`. + "aiModel": { + "deploymentPlatform": "A String", + "displayName": "A String", + "domain": "A String", + "library": "A String", + "location": "A String", + "name": "A String", + "publisher": "A String", + "usageCategory": "A String", + }, + "application": { + "baseUri": "A String", + "fullUri": "A String", + }, + "artifactGuardPolicies": { + "failingPolicies": [ + { + "failureReason": "A String", + "policyId": "A String", + "type": "A String", + }, + ], + "resourceId": "A String", + }, + "attackExposure": { + "attackExposureResult": "A String", + "exposedHighValueResourcesCount": 42, + "exposedLowValueResourcesCount": 42, + "exposedMediumValueResourcesCount": 42, + "latestCalculationTime": "A String", + "score": 3.14, + "state": "A String", + }, + "backupDisasterRecovery": { + "appliance": "A String", + "applications": [ "A String", ], - "backupCreateTime": "A String", # The timestamp at which the Backup and DR backup was created. - "backupTemplate": "A String", # The name of a Backup and DR template which comprises one or more backup policies. See the [Backup and DR documentation](https://cloud.google.com/backup-disaster-recovery/docs/concepts/backup-plan#temp) for more information. For example, `snap-ov`. - "backupType": "A String", # The backup type of the Backup and DR image. For example, `Snapshot`, `Remote Snapshot`, `OnVault`. - "host": "A String", # The name of a Backup and DR host, which is managed by the backup and recovery appliance and known to the management console. The host can be of type Generic (for example, Compute Engine, SQL Server, Oracle DB, SMB file system, etc.), vCenter, or an ESX server. See the [Backup and DR documentation on hosts](https://cloud.google.com/backup-disaster-recovery/docs/configuration/manage-hosts-and-their-applications) for more information. For example, `centos7-01`. - "policies": [ # The names of Backup and DR policies that are associated with a template and that define when to run a backup, how frequently to run a backup, and how long to retain the backup image. For example, `onvaults`. + "backupCreateTime": "A String", + "backupTemplate": "A String", + "backupType": "A String", + "host": "A String", + "policies": [ "A String", ], - "policyOptions": [ # The names of Backup and DR advanced policy options of a policy applying to an application. See the [Backup and DR documentation on policy options](https://cloud.google.com/backup-disaster-recovery/docs/create-plan/policy-settings). For example, `skipofflineappsincongrp, nounmap`. + "policyOptions": [ "A String", ], - "profile": "A String", # The name of the Backup and DR resource profile that specifies the storage media for backups of application and VM data. See the [Backup and DR documentation on profiles](https://cloud.google.com/backup-disaster-recovery/docs/concepts/backup-plan#profile). For example, `GCP`. - "storagePool": "A String", # The name of the Backup and DR storage pool that the backup and recovery appliance is storing data in. The storage pool could be of type Cloud, Primary, Snapshot, or OnVault. See the [Backup and DR documentation on storage pools](https://cloud.google.com/backup-disaster-recovery/docs/concepts/storage-pools). For example, `DiskPoolOne`. + "profile": "A String", + "storagePool": "A String", }, - "canonicalName": "A String", # The canonical name of the finding. It's either "organizations/{organization_id}/sources/{source_id}/findings/{finding_id}", "folders/{folder_id}/sources/{source_id}/findings/{finding_id}" or "projects/{project_number}/sources/{source_id}/findings/{finding_id}", depending on the closest CRM ancestor of the resource associated with the finding. - "category": "A String", # The additional taxonomy group within findings from a given source. This field is immutable after creation time. Example: "XSS_FLASH_INJECTION" - "chokepoint": { # Contains details about a chokepoint, which is a resource or resource group where high-risk attack paths converge, based on [attack path simulations] (https://cloud.google.com/security-command-center/docs/attack-exposure-learn#attack_path_simulations). # Contains details about a chokepoint, which is a resource or resource group where high-risk attack paths converge, based on [attack path simulations] (https://cloud.google.com/security-command-center/docs/attack-exposure-learn#attack_path_simulations). This field cannot be updated. Its value is ignored in all update requests. - "relatedFindings": [ # List of resource names of findings associated with this chokepoint. For example, organizations/123/sources/456/findings/789. This list will have at most 100 findings. + "canonicalName": "A String", + "category": "A String", + "chokepoint": { + "relatedFindings": [ "A String", ], }, - "cloudArmor": { # Fields related to Google Cloud Armor findings. # Fields related to Cloud Armor findings. - "adaptiveProtection": { # Information about [Google Cloud Armor Adaptive Protection](https://cloud.google.com/armor/docs/cloud-armor-overview#google-cloud-armor-adaptive-protection). # Information about potential Layer 7 DDoS attacks identified by [Google Cloud Armor Adaptive Protection](https://cloud.google.com/armor/docs/adaptive-protection-overview). - "confidence": 3.14, # A score of 0 means that there is low confidence that the detected event is an actual attack. A score of 1 means that there is high confidence that the detected event is an attack. See the [Adaptive Protection documentation](https://cloud.google.com/armor/docs/adaptive-protection-overview#configure-alert-tuning) for further explanation. - }, - "attack": { # Information about DDoS attack volume and classification. # Information about DDoS attack volume and classification. - "classification": "A String", # Type of attack, for example, 'SYN-flood', 'NTP-udp', or 'CHARGEN-udp'. - "volumeBps": 42, # Total BPS (bytes per second) volume of attack. Deprecated - refer to volume_bps_long instead. - "volumeBpsLong": "A String", # Total BPS (bytes per second) volume of attack. - "volumePps": 42, # Total PPS (packets per second) volume of attack. Deprecated - refer to volume_pps_long instead. - "volumePpsLong": "A String", # Total PPS (packets per second) volume of attack. - }, - "duration": "A String", # Duration of attack from the start until the current moment (updated every 5 minutes). - "requests": { # Information about the requests relevant to the finding. # Information about incoming requests evaluated by [Google Cloud Armor security policies](https://cloud.google.com/armor/docs/security-policy-overview). - "longTermAllowed": 42, # Allowed RPS (requests per second) over the long term. - "longTermDenied": 42, # Denied RPS (requests per second) over the long term. - "ratio": 3.14, # For 'Increasing deny ratio', the ratio is the denied traffic divided by the allowed traffic. For 'Allowed traffic spike', the ratio is the allowed traffic in the short term divided by allowed traffic in the long term. - "shortTermAllowed": 42, # Allowed RPS (requests per second) in the short term. - }, - "securityPolicy": { # Information about the [Google Cloud Armor security policy](https://cloud.google.com/armor/docs/security-policy-overview) relevant to the finding. # Information about the [Google Cloud Armor security policy](https://cloud.google.com/armor/docs/security-policy-overview) relevant to the finding. - "name": "A String", # The name of the Google Cloud Armor security policy, for example, "my-security-policy". - "preview": True or False, # Whether or not the associated rule or policy is in preview mode. - "type": "A String", # The type of Google Cloud Armor security policy for example, 'backend security policy', 'edge security policy', 'network edge security policy', or 'always-on DDoS protection'. - }, - "threatVector": "A String", # Distinguish between volumetric & protocol DDoS attack and application layer attacks. For example, "L3_4" for Layer 3 and Layer 4 DDoS attacks, or "L_7" for Layer 7 DDoS attacks. - }, - "cloudDlpDataProfile": { # The [data profile](https://cloud.google.com/dlp/docs/data-profiles) associated with the finding. # Cloud DLP data profile that is associated with the finding. - "dataProfile": "A String", # Name of the data profile, for example, `projects/123/locations/europe/tableProfiles/8383929`. - "infoTypes": [ # Type of information detected by SDP. Info type includes name, version and sensitivity of the detected information type. - { # Type of information detected by the API. - "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. - "sensitivityScore": { # Score is calculated from of all elements in the data profile. A higher level means the data is more sensitive. # Optional custom sensitivity for this InfoType. This only applies to data profiling. - "score": "A String", # The sensitivity score applied to the resource. + "cloudArmor": { + "adaptiveProtection": { + "confidence": 3.14, + }, + "attack": { + "classification": "A String", + "volumeBps": 42, + "volumeBpsLong": "A String", + "volumePps": 42, + "volumePpsLong": "A String", + }, + "duration": "A String", + "requests": { + "longTermAllowed": 42, + "longTermDenied": 42, + "ratio": 3.14, + "shortTermAllowed": 42, + }, + "securityPolicy": { + "name": "A String", + "preview": True or False, + "type": "A String", + }, + "threatVector": "A String", + }, + "cloudDlpDataProfile": { + "dataProfile": "A String", + "infoTypes": [ + { + "name": "A String", + "sensitivityScore": { + "score": "A String", }, - "version": "A String", # Optional version name for this InfoType. + "version": "A String", }, ], - "parentType": "A String", # The resource hierarchy level at which the data profile was generated. + "parentType": "A String", }, - "cloudDlpInspection": { # Details about the Cloud Data Loss Prevention (Cloud DLP) [inspection job](https://cloud.google.com/dlp/docs/concepts-job-triggers) that produced the finding. # Cloud Data Loss Prevention (Cloud DLP) inspection results that are associated with the finding. - "fullScan": True or False, # Whether Cloud DLP scanned the complete resource or a sampled subset. - "infoType": "A String", # The type of information (or *[infoType](https://cloud.google.com/dlp/docs/infotypes-reference)*) found, for example, `EMAIL_ADDRESS` or `STREET_ADDRESS`. - "infoTypeCount": "A String", # The number of times Cloud DLP found this infoType within this job and resource. - "inspectJob": "A String", # Name of the inspection job, for example, `projects/123/locations/europe/dlpJobs/i-8383929`. + "cloudDlpInspection": { + "fullScan": True or False, + "infoType": "A String", + "infoTypeCount": "A String", + "inspectJob": "A String", }, - "complianceDetails": { # Compliance Details associated with the finding. # Details about the compliance implications of the finding. - "cloudControl": { # CloudControl associated with the finding. # CloudControl associated with the finding - "cloudControlName": "A String", # Name of the CloudControl associated with the finding. - "policyType": "A String", # Policy type of the CloudControl - "type": "A String", # Type of cloud control. - "version": 42, # Version of the Cloud Control + "complianceDetails": { + "cloudControl": { + "cloudControlName": "A String", + "policyType": "A String", + "type": "A String", + "version": 42, }, - "cloudControlDeploymentNames": [ # Cloud Control Deployments associated with the finding. For example, organizations/123/locations/global/cloudControlDeployments/deploymentIdentifier + "cloudControlDeploymentNames": [ "A String", ], - "frameworks": [ # Details of Frameworks associated with the finding - { # Compliance framework associated with the finding. - "category": [ # Category of the framework associated with the finding. E.g. Security Benchmark, or Assured Workloads + "frameworks": [ + { + "category": [ "A String", ], - "controls": [ # The controls associated with the framework. - { # Compliance control associated with the finding. - "controlName": "A String", # Name of the Control - "displayName": "A String", # Display name of the control. For example, AU-02. + "controls": [ + { + "controlName": "A String", + "displayName": "A String", }, ], - "displayName": "A String", # Display name of the framework. For a standard framework, this will look like e.g. PCI DSS 3.2.1, whereas for a custom framework it can be a user defined string like MyFramework - "name": "A String", # Name of the framework associated with the finding - "type": "A String", # Type of the framework associated with the finding, to specify whether the framework is built-in (pre-defined and immutable) or a custom framework defined by the customer (equivalent to security posture) + "displayName": "A String", + "name": "A String", + "type": "A String", }, ], }, - "compliances": [ # Contains compliance information for security standards associated to the finding. - { # Contains compliance information about a security standard indicating unmet recommendations. - "ids": [ # Policies within the standard or benchmark, for example, A.12.4.1 + "compliances": [ + { + "ids": [ "A String", ], - "standard": "A String", # Industry-wide compliance standards or benchmarks, such as CIS, PCI, and OWASP. - "version": "A String", # Version of the standard or benchmark, for example, 1.1 + "standard": "A String", + "version": "A String", }, ], - "connections": [ # Contains information about the IP connection associated with the finding. - { # Contains information about the IP connection associated with the finding. - "destinationIp": "A String", # Destination IP address. Not present for sockets that are listening and not connected. - "destinationPort": 42, # Destination port. Not present for sockets that are listening and not connected. - "protocol": "A String", # IANA Internet Protocol Number such as TCP(6) and UDP(17). - "sourceIp": "A String", # Source IP address. - "sourcePort": 42, # Source port. + "connections": [ + { + "destinationIp": "A String", + "destinationPort": 42, + "protocol": "A String", + "sourceIp": "A String", + "sourcePort": 42, }, ], - "contacts": { # Output only. Map containing the points of contact for the given finding. The key represents the type of contact, while the value contains a list of all the contacts that pertain. Please refer to: https://cloud.google.com/resource-manager/docs/managing-notification-contacts#notification-categories { "security": { "contacts": [ { "email": "person1@company.com" }, { "email": "person2@company.com" } ] } } - "a_key": { # Details about specific contacts - "contacts": [ # A list of contacts - { # The email address of a contact. - "email": "A String", # An email address. For example, "`person123@company.com`". + "contacts": { + "a_key": { + "contacts": [ + { + "email": "A String", }, ], }, }, - "containers": [ # Containers associated with the finding. This field provides information for both Kubernetes and non-Kubernetes containers. - { # Container associated with the finding. - "createTime": "A String", # The time that the container was created. - "imageId": "A String", # Optional container image ID, if provided by the container runtime. Uniquely identifies the container image launched using a container image digest. - "labels": [ # Container labels, as provided by the container runtime. - { # Represents a generic name-value label. A label has separate name and value fields to support filtering with the `contains()` function. For more information, see [Filtering on array-type fields](https://cloud.google.com/security-command-center/docs/how-to-api-list-findings#array-contains-filtering). - "name": "A String", # Name of the label. - "value": "A String", # Value that corresponds to the label's name. + "containers": [ + { + "createTime": "A String", + "imageId": "A String", + "labels": [ + { + "name": "A String", + "value": "A String", }, ], - "name": "A String", # Name of the container. - "uri": "A String", # Container image URI provided when configuring a pod or container. This string can identify a container image version using mutable tags. + "name": "A String", + "uri": "A String", }, ], - "createTime": "A String", # The time at which the finding was created in Security Command Center. - "dataAccessEvents": [ # Data access events associated with the finding. - { # Details about a data access attempt made by a principal not authorized under applicable data security policy. - "eventId": "A String", # Unique identifier for data access event. - "eventTime": "A String", # Timestamp of data access event. - "operation": "A String", # The operation performed by the principal to access the data. - "principalEmail": "A String", # The email address of the principal that accessed the data. The principal could be a user account, service account, Google group, or other. + "createTime": "A String", + "dataAccessEvents": [ + { + "eventId": "A String", + "eventTime": "A String", + "operation": "A String", + "principalEmail": "A String", }, ], - "dataFlowEvents": [ # Data flow events associated with the finding. - { # Details about a data flow event, in which either the data is moved to or is accessed from a non-compliant geo-location, as defined in the applicable data security policy. - "eventId": "A String", # Unique identifier for data flow event. - "eventTime": "A String", # Timestamp of data flow event. - "operation": "A String", # The operation performed by the principal for the data flow event. - "principalEmail": "A String", # The email address of the principal that initiated the data flow event. The principal could be a user account, service account, Google group, or other. - "violatedLocation": "A String", # Non-compliant location of the principal or the data destination. + "dataFlowEvents": [ + { + "eventId": "A String", + "eventTime": "A String", + "operation": "A String", + "principalEmail": "A String", + "violatedLocation": "A String", }, ], - "dataRetentionDeletionEvents": [ # Data retention deletion events associated with the finding. - { # Details about data retention deletion violations, in which the data is non-compliant based on their retention or deletion time, as defined in the applicable data security policy. The Data Retention Deletion (DRD) control is a control of the DSPM (Data Security Posture Management) suite that enables organizations to manage data retention and deletion policies in compliance with regulations, such as GDPR and CRPA. DRD supports two primary policy types: maximum storage length (max TTL) and minimum storage length (min TTL). Both are aimed at helping organizations meet regulatory and data management commitments. - "dataObjectCount": "A String", # Number of objects that violated the policy for this resource. If the number is less than 1,000, then the value of this field is the exact number. If the number of objects that violated the policy is greater than or equal to 1,000, then the value of this field is 1000. - "eventDetectionTime": "A String", # Timestamp indicating when the event was detected. - "eventType": "A String", # Type of the DRD event. - "maxRetentionAllowed": "A String", # Maximum duration of retention allowed from the DRD control. This comes from the DRD control where users set a max TTL for their data. For example, suppose that a user sets the max TTL for a Cloud Storage bucket to 90 days. However, an object in that bucket is 100 days old. In this case, a DataRetentionDeletionEvent will be generated for that Cloud Storage bucket, and the max_retention_allowed is 90 days. - "minRetentionAllowed": "A String", # Min duration of retention allowed from the DSPM retention control. This field is only populated when event type is set to EVENT_TYPE_MIN_TTL_FROM_CREATION. + "dataRetentionDeletionEvents": [ + { + "dataObjectCount": "A String", + "eventDetectionTime": "A String", + "eventType": "A String", + "maxRetentionAllowed": "A String", + "minRetentionAllowed": "A String", }, ], - "database": { # Represents database access information, such as queries. A database may be a sub-resource of an instance (as in the case of Cloud SQL instances or Cloud Spanner instances), or the database instance itself. Some database resources might not have the [full resource name](https://google.aip.dev/122#full-resource-names) populated because these resource types, such as Cloud SQL databases, are not yet supported by Cloud Asset Inventory. In these cases only the display name is provided. # Database associated with the finding. - "displayName": "A String", # The human-readable name of the database that the user connected to. - "grantees": [ # The target usernames, roles, or groups of an SQL privilege grant, which is not an IAM policy change. + "database": { + "displayName": "A String", + "grantees": [ "A String", ], - "name": "A String", # Some database resources may not have the [full resource name](https://google.aip.dev/122#full-resource-names) populated because these resource types are not yet supported by Cloud Asset Inventory (e.g. Cloud SQL databases). In these cases only the display name will be provided. The [full resource name](https://google.aip.dev/122#full-resource-names) of the database that the user connected to, if it is supported by Cloud Asset Inventory. - "query": "A String", # The SQL statement that is associated with the database access. - "userName": "A String", # The username used to connect to the database. The username might not be an IAM principal and does not have a set format. - "version": "A String", # The version of the database, for example, POSTGRES_14. See [the complete list](https://cloud.google.com/sql/docs/mysql/admin-api/rest/v1/SqlDatabaseVersion). - }, - "description": "A String", # Contains more details about the finding. - "discoveredWorkload": { # Represents discovered, customer managed workload that is not registered with the respective GCP service. # DiscoveredWorkload associated with the finding. - "confidence": "A String", # The confidence in detection of this workload. - "detectedRelevantHardware": True or False, # A boolean flag set to true if associated hardware strongly predicts the workload type. - "detectedRelevantKeywords": True or False, # A boolean flag set to true if associated keywords strongly predict the workload type. - "detectedRelevantPackages": True or False, # A boolean flag set to true if installed packages strongly predict the workload type. - "workloadType": "A String", # The type of workload. - }, - "disk": { # Contains information about the disk associated with the finding. # Disk associated with the finding. - "name": "A String", # The name of the disk, for example, "https://www.googleapis.com/compute/v1/projects/{project-id}/zones/{zone-id}/disks/{disk-id}". - }, - "eventTime": "A String", # The time the finding was first detected. If an existing finding is updated, then this is the time the update occurred. For example, if the finding represents an open firewall, this property captures the time the detector believes the firewall became open. The accuracy is determined by the detector. If the finding is later resolved, then this time reflects when the finding was resolved. This must not be set to a value greater than the current timestamp. - "exfiltration": { # Exfiltration represents a data exfiltration attempt from one or more sources to one or more targets. The `sources` attribute lists the sources of the exfiltrated data. The `targets` attribute lists the destinations the data was copied to. # Represents exfiltrations associated with the finding. - "sources": [ # If there are multiple sources, then the data is considered "joined" between them. For instance, BigQuery can join multiple tables, and each table would be considered a source. - { # Resource where data was exfiltrated from or exfiltrated to. - "components": [ # Subcomponents of the asset that was exfiltrated, like URIs used during exfiltration, table names, databases, and filenames. For example, multiple tables might have been exfiltrated from the same Cloud SQL instance, or multiple files might have been exfiltrated from the same Cloud Storage bucket. + "name": "A String", + "query": "A String", + "userName": "A String", + "version": "A String", + }, + "description": "A String", + "discoveredWorkload": { + "confidence": "A String", + "detectedRelevantHardware": True or False, + "detectedRelevantKeywords": True or False, + "detectedRelevantPackages": True or False, + "workloadType": "A String", + }, + "disk": { + "name": "A String", + }, + "eventTime": "A String", + "exfiltration": { + "sources": [ + { + "components": [ "A String", ], - "name": "A String", # The resource's [full resource name](https://cloud.google.com/apis/design/resource_names#full_resource_name). + "name": "A String", }, ], - "targets": [ # If there are multiple targets, each target would get a complete copy of the "joined" source data. - { # Resource where data was exfiltrated from or exfiltrated to. - "components": [ # Subcomponents of the asset that was exfiltrated, like URIs used during exfiltration, table names, databases, and filenames. For example, multiple tables might have been exfiltrated from the same Cloud SQL instance, or multiple files might have been exfiltrated from the same Cloud Storage bucket. + "targets": [ + { + "components": [ "A String", ], - "name": "A String", # The resource's [full resource name](https://cloud.google.com/apis/design/resource_names#full_resource_name). - }, - ], - "totalExfiltratedBytes": "A String", # Total exfiltrated bytes processed for the entire job. - }, - "externalExposure": { # Details about the externally exposed resource associated with the finding. # External exposure associated with the finding. - "backendBucket": "A String", # The full resource name of the load balancer backend bucket, for example, "//compute.googleapis.com/projects/{project-id}/global/backendBuckets/{name}" - "backendService": "A String", # The full resource name of load balancer backend service, for example, "//compute.googleapis.com/projects/{project-id}/global/backendServices/{name}". - "exposedApplication": "A String", # The name and version of the exposed web application, for example, "Jenkins 2.184". - "exposedEndpoint": "A String", # The resource which is running the exposed service, for example, "//compute.googleapis.com/projects/{project-id}/zones/{zone}/instances/{instance}.” - "exposedService": "A String", # The name and version of the service, for example, "Jupyter Notebook 6.14.0". - "forwardingRule": "A String", # The full resource name of the forwarding rule, for example, "//compute.googleapis.com/projects/{project-id}/global/forwardingRules/{forwarding-rule-name}". - "hostnameUri": "A String", # Hostname of the exposed application, for example, "https://test-app.a.run.app/" - "httpResponse": [ # The http response returned by the web application. - { # The http response returned by the web application. - "path": "A String", # The http path for which response code was returned by web application, for example, "https://test-app.a.run.app/test". - "statusCode": "A String", # The http response code returned by the web application, for example, 200. - }, - ], - "instanceGroup": "A String", # The full resource name of the instance group, for example, "//compute.googleapis.com/projects/{project-id}/global/instanceGroups/{name}". - "internalBackendService": "A String", # The full resource name of load balancer backend service in the internal project having resource exposed via PSC, for example, "//compute.googleapis.com/projects/{project-id}/global/backendServices/{name}". - "loadBalancerFirewallPolicy": "A String", # The full resource name of the load balancer firewall policy, for example, "//compute.googleapis.com/projects/{project-id}/global/firewallPolicies/{policy-name}". - "networkEndpointGroup": "A String", # The full resource name of the network endpoint group, for example, "//compute.googleapis.com/projects/{project-id}/global/networkEndpointGroups/{name}". - "networkIngressFirewallPolicy": "A String", # The full resource name of the network ingress firewall policy, for example, "//compute.googleapis.com/projects/{project-id}/global/firewallPolicies/{name}". - "privateIpAddress": "A String", # Private IP address of the exposed endpoint. - "privatePort": "A String", # Port number associated with private IP address. - "pscNetworkAttachment": "A String", # The full resource name of the PSC (Private Service Connect) network attachment that network interface controller is attached to, for example, "//compute.googleapis.com/projects/{project-id}/regions/{region}/networkAttachments/{name}" - "pscServiceAttachment": "A String", # The full resource name of the PSC (Private Service Connect) service attachment that the load balancer network endpoint group targets, for example, "//compute.googleapis.com/projects/{project-id}/regions/{region}/serviceAttachments/{name}" - "publicIpAddress": "A String", # Public IP address of the exposed endpoint. - "publicPort": "A String", # Public port number of the exposed endpoint. - "serviceFirewallPolicy": "A String", # The full resource name of the firewall policy of the exposed service, for example, "//compute.googleapis.com/projects/{project-id}/global/firewallPolicies/{policy-name}". - }, - "externalSystems": { # Output only. Third party SIEM/SOAR fields within SCC, contains external system information and external system finding fields. - "a_key": { # Representation of third party SIEM/SOAR fields within SCC. - "assignees": [ # References primary/secondary etc assignees in the external system. + "name": "A String", + }, + ], + "totalExfiltratedBytes": "A String", + }, + "externalExposure": { + "backendBucket": "A String", + "backendService": "A String", + "exposedApplication": "A String", + "exposedEndpoint": "A String", + "exposedService": "A String", + "forwardingRule": "A String", + "hostnameUri": "A String", + "httpResponse": [ + { + "path": "A String", + "statusCode": "A String", + }, + ], + "instanceGroup": "A String", + "internalBackendService": "A String", + "loadBalancerFirewallPolicy": "A String", + "networkEndpointGroup": "A String", + "networkIngressFirewallPolicy": "A String", + "privateIpAddress": "A String", + "privatePort": "A String", + "pscNetworkAttachment": "A String", + "pscServiceAttachment": "A String", + "publicIpAddress": "A String", + "publicPort": "A String", + "serviceFirewallPolicy": "A String", + }, + "externalSystems": { + "a_key": { + "assignees": [ "A String", ], - "caseCloseTime": "A String", # The time when the case was closed, as reported by the external system. - "caseCreateTime": "A String", # The time when the case was created, as reported by the external system. - "casePriority": "A String", # The priority of the finding's corresponding case in the external system. - "caseSla": "A String", # The SLA of the finding's corresponding case in the external system. - "caseUri": "A String", # The link to the finding's corresponding case in the external system. - "externalSystemUpdateTime": "A String", # The time when the case was last updated, as reported by the external system. - "externalUid": "A String", # The identifier that's used to track the finding's corresponding case in the external system. - "name": "A String", # Full resource name of the external system, for example: "organizations/1234/sources/5678/findings/123456/externalSystems/jira", "folders/1234/sources/5678/findings/123456/externalSystems/jira", "projects/1234/sources/5678/findings/123456/externalSystems/jira" - "status": "A String", # The most recent status of the finding's corresponding case, as reported by the external system. - "ticketInfo": { # Information about the ticket, if any, that is being used to track the resolution of the issue that is identified by this finding. # Information about the ticket, if any, that is being used to track the resolution of the issue that is identified by this finding. - "assignee": "A String", # The assignee of the ticket in the ticket system. - "description": "A String", # The description of the ticket in the ticket system. - "id": "A String", # The identifier of the ticket in the ticket system. - "status": "A String", # The latest status of the ticket, as reported by the ticket system. - "updateTime": "A String", # The time when the ticket was last updated, as reported by the ticket system. - "uri": "A String", # The link to the ticket in the ticket system. - }, - }, - }, - "externalUri": "A String", # The URI that, if available, points to a web page outside of Security Command Center where additional information about the finding can be found. This field is guaranteed to be either empty or a well formed URL. - "files": [ # File associated with the finding. - { # File information about the related binary/library used by an executable, or the script used by a script interpreter - "contents": "A String", # Prefix of the file contents as a JSON-encoded string. - "diskPath": { # Path of the file in terms of underlying disk/partition identifiers. # Path of the file in terms of underlying disk/partition identifiers. - "partitionUuid": "A String", # UUID of the partition (format https://wiki.archlinux.org/title/persistent_block_device_naming#by-uuid) - "relativePath": "A String", # Relative path of the file in the partition as a JSON encoded string. Example: /home/user1/executable_file.sh - }, - "fileLoadState": "A String", # The load state of the file. - "hashedSize": "A String", # The length in bytes of the file prefix that was hashed. If hashed_size == size, any hashes reported represent the entire file. - "operations": [ # Operation(s) performed on a file. - { # Operation(s) performed on a file. - "type": "A String", # The type of the operation + "caseCloseTime": "A String", + "caseCreateTime": "A String", + "casePriority": "A String", + "caseSla": "A String", + "caseUri": "A String", + "externalSystemUpdateTime": "A String", + "externalUid": "A String", + "name": "A String", + "status": "A String", + "ticketInfo": { + "assignee": "A String", + "description": "A String", + "id": "A String", + "status": "A String", + "updateTime": "A String", + "uri": "A String", + }, + }, + }, + "externalUri": "A String", + "files": [ + { + "contents": "A String", + "diskPath": { + "partitionUuid": "A String", + "relativePath": "A String", + }, + "fileLoadState": "A String", + "hashedSize": "A String", + "operations": [ + { + "type": "A String", }, ], - "partiallyHashed": True or False, # True when the hash covers only a prefix of the file. - "path": "A String", # Absolute path of the file as a JSON encoded string. - "sha256": "A String", # SHA256 hash of the first hashed_size bytes of the file encoded as a hex string. If hashed_size == size, sha256 represents the SHA256 hash of the entire file. - "size": "A String", # Size of the file in bytes. + "partiallyHashed": True or False, + "path": "A String", + "sha256": "A String", + "size": "A String", }, ], - "findingClass": "A String", # The class of the finding. - "groupMemberships": [ # Contains details about groups of which this finding is a member. A group is a collection of findings that are related in some way. This field cannot be updated. Its value is ignored in all update requests. - { # Contains details about groups of which this finding is a member. A group is a collection of findings that are related in some way. - "groupId": "A String", # ID of the group. - "groupType": "A String", # Type of group. + "findingClass": "A String", + "groupMemberships": [ + { + "groupId": "A String", + "groupType": "A String", }, ], - "iamBindings": [ # Represents IAM bindings associated with the finding. - { # Represents a particular IAM binding, which captures a member's role addition, removal, or state. - "action": "A String", # The action that was performed on a Binding. - "member": "A String", # A single identity requesting access for a Cloud Platform resource, for example, "foo@google.com". - "role": "A String", # Role that is assigned to "members". For example, "roles/viewer", "roles/editor", or "roles/owner". + "iamBindings": [ + { + "action": "A String", + "member": "A String", + "role": "A String", }, ], - "indicator": { # Represents what's commonly known as an _indicator of compromise_ (IoC) in computer forensics. This is an artifact observed on a network or in an operating system that, with high confidence, indicates a computer intrusion. For more information, see [Indicator of compromise](https://en.wikipedia.org/wiki/Indicator_of_compromise). # Represents what's commonly known as an *indicator of compromise* (IoC) in computer forensics. This is an artifact observed on a network or in an operating system that, with high confidence, indicates a computer intrusion. For more information, see [Indicator of compromise](https://en.wikipedia.org/wiki/Indicator_of_compromise). - "domains": [ # List of domains associated to the Finding. + "indicator": { + "domains": [ "A String", ], - "ipAddresses": [ # The list of IP addresses that are associated with the finding. + "ipAddresses": [ "A String", ], - "signatures": [ # The list of matched signatures indicating that the given process is present in the environment. - { # Indicates what signature matched this process. - "memoryHashSignature": { # A signature corresponding to memory page hashes. # Signature indicating that a binary family was matched. - "binaryFamily": "A String", # The binary family. - "detections": [ # The list of memory hash detections contributing to the binary family match. - { # Memory hash detection contributing to the binary family match. - "binary": "A String", # The name of the binary associated with the memory hash signature detection. - "percentPagesMatched": 3.14, # The percentage of memory page hashes in the signature that were matched. + "signatures": [ + { + "memoryHashSignature": { + "binaryFamily": "A String", + "detections": [ + { + "binary": "A String", + "percentPagesMatched": 3.14, }, ], }, - "signatureType": "A String", # Describes the type of resource associated with the signature. - "yaraRuleSignature": { # A signature corresponding to a YARA rule. # Signature indicating that a YARA rule was matched. - "yaraRule": "A String", # The name of the YARA rule. + "signatureType": "A String", + "yaraRuleSignature": { + "yaraRule": "A String", }, }, ], - "uris": [ # The list of URIs associated to the Findings. + "uris": [ "A String", ], }, - "ipRules": { # IP rules associated with the finding. # IP rules associated with the finding. - "allowed": { # Allowed IP rule. # Tuple with allowed rules. - "ipRules": [ # Optional. Optional list of allowed IP rules. - { # IP rule information. - "portRanges": [ # Optional. An optional list of ports to which this rule applies. This field is only applicable for the UDP or (S)TCP protocols. Each entry must be either an integer or a range including a min and max port number. - { # A port range which is inclusive of the min and max values. Values are between 0 and 2^16-1. The max can be equal / must be not smaller than the min value. If min and max are equal this indicates that it is a single port. - "max": "A String", # Maximum port value. - "min": "A String", # Minimum port value. + "ipRules": { + "allowed": { + "ipRules": [ + { + "portRanges": [ + { + "max": "A String", + "min": "A String", }, ], - "protocol": "A String", # The IP protocol this rule applies to. This value can either be one of the following well known protocol strings (TCP, UDP, ICMP, ESP, AH, IPIP, SCTP) or a string representation of the integer value. + "protocol": "A String", }, ], }, - "denied": { # Denied IP rule. # Tuple with denied rules. - "ipRules": [ # Optional. Optional list of denied IP rules. - { # IP rule information. - "portRanges": [ # Optional. An optional list of ports to which this rule applies. This field is only applicable for the UDP or (S)TCP protocols. Each entry must be either an integer or a range including a min and max port number. - { # A port range which is inclusive of the min and max values. Values are between 0 and 2^16-1. The max can be equal / must be not smaller than the min value. If min and max are equal this indicates that it is a single port. - "max": "A String", # Maximum port value. - "min": "A String", # Minimum port value. + "denied": { + "ipRules": [ + { + "portRanges": [ + { + "max": "A String", + "min": "A String", }, ], - "protocol": "A String", # The IP protocol this rule applies to. This value can either be one of the following well known protocol strings (TCP, UDP, ICMP, ESP, AH, IPIP, SCTP) or a string representation of the integer value. + "protocol": "A String", }, ], }, - "destinationIpRanges": [ # If destination IP ranges are specified, the firewall rule applies only to traffic that has a destination IP address in these ranges. These ranges must be expressed in CIDR format. Only supports IPv4. + "destinationIpRanges": [ "A String", ], - "direction": "A String", # The direction that the rule is applicable to, one of ingress or egress. - "exposedServices": [ # Name of the network protocol service, such as FTP, that is exposed by the open port. Follows the naming convention available at: https://www.iana.org/assignments/service-names-port-numbers/service-names-port-numbers.xhtml. + "direction": "A String", + "exposedServices": [ "A String", ], - "sourceIpRanges": [ # If source IP ranges are specified, the firewall rule applies only to traffic that has a source IP address in these ranges. These ranges must be expressed in CIDR format. Only supports IPv4. + "sourceIpRanges": [ "A String", ], }, - "job": { # Describes a job # Job associated with the finding. - "errorCode": 42, # Optional. If the job did not complete successfully, this field describes why. - "location": "A String", # Optional. Gives the location where the job ran, such as `US` or `europe-west1` - "name": "A String", # The fully-qualified name for a job. e.g. `projects//jobs/` - "state": "A String", # Output only. State of the job, such as `RUNNING` or `PENDING`. - }, - "kernelRootkit": { # Kernel mode rootkit signatures. # Signature of the kernel rootkit. - "name": "A String", # Rootkit name, when available. - "unexpectedCodeModification": True or False, # True if unexpected modifications of kernel code memory are present. - "unexpectedFtraceHandler": True or False, # True if `ftrace` points are present with callbacks pointing to regions that are not in the expected kernel or module code range. - "unexpectedInterruptHandler": True or False, # True if interrupt handlers that are are not in the expected kernel or module code regions are present. - "unexpectedKernelCodePages": True or False, # True if kernel code pages that are not in the expected kernel or module code regions are present. - "unexpectedKprobeHandler": True or False, # True if `kprobe` points are present with callbacks pointing to regions that are not in the expected kernel or module code range. - "unexpectedProcessesInRunqueue": True or False, # True if unexpected processes in the scheduler run queue are present. Such processes are in the run queue, but not in the process task list. - "unexpectedReadOnlyDataModification": True or False, # True if unexpected modifications of kernel read-only data memory are present. - "unexpectedSystemCallHandler": True or False, # True if system call handlers that are are not in the expected kernel or module code regions are present. - }, - "kubernetes": { # Kubernetes-related attributes. # Kubernetes resources associated with the finding. - "accessReviews": [ # Provides information on any Kubernetes access reviews (privilege checks) relevant to the finding. - { # Conveys information about a Kubernetes access review (such as one returned by a [`kubectl auth can-i`](https://kubernetes.io/docs/reference/access-authn-authz/authorization/#checking-api-access) command) that was involved in a finding. - "group": "A String", # The API group of the resource. "*" means all. - "name": "A String", # The name of the resource being requested. Empty means all. - "ns": "A String", # Namespace of the action being requested. Currently, there is no distinction between no namespace and all namespaces. Both are represented by "" (empty). - "resource": "A String", # The optional resource type requested. "*" means all. - "subresource": "A String", # The optional subresource type. - "verb": "A String", # A Kubernetes resource API verb, like get, list, watch, create, update, delete, proxy. "*" means all. - "version": "A String", # The API version of the resource. "*" means all. - }, - ], - "bindings": [ # Provides Kubernetes role binding information for findings that involve [RoleBindings or ClusterRoleBindings](https://cloud.google.com/kubernetes-engine/docs/how-to/role-based-access-control). - { # Represents a Kubernetes RoleBinding or ClusterRoleBinding. - "name": "A String", # Name for the binding. - "ns": "A String", # Namespace for the binding. - "role": { # Kubernetes Role or ClusterRole. # The Role or ClusterRole referenced by the binding. - "kind": "A String", # Role type. - "name": "A String", # Role name. - "ns": "A String", # Role namespace. + "job": { + "errorCode": 42, + "location": "A String", + "name": "A String", + "state": "A String", + }, + "kernelRootkit": { + "name": "A String", + "unexpectedCodeModification": True or False, + "unexpectedFtraceHandler": True or False, + "unexpectedInterruptHandler": True or False, + "unexpectedKernelCodePages": True or False, + "unexpectedKprobeHandler": True or False, + "unexpectedProcessesInRunqueue": True or False, + "unexpectedReadOnlyDataModification": True or False, + "unexpectedSystemCallHandler": True or False, + }, + "kubernetes": { + "accessReviews": [ + { + "group": "A String", + "name": "A String", + "ns": "A String", + "resource": "A String", + "subresource": "A String", + "verb": "A String", + "version": "A String", + }, + ], + "bindings": [ + { + "name": "A String", + "ns": "A String", + "role": { + "kind": "A String", + "name": "A String", + "ns": "A String", }, - "subjects": [ # Represents one or more subjects that are bound to the role. Not always available for PATCH requests. - { # Represents a Kubernetes subject. - "kind": "A String", # Authentication type for the subject. - "name": "A String", # Name for the subject. - "ns": "A String", # Namespace for the subject. + "subjects": [ + { + "kind": "A String", + "name": "A String", + "ns": "A String", }, ], }, ], - "nodePools": [ # GKE [node pools](https://cloud.google.com/kubernetes-engine/docs/concepts/node-pools) associated with the finding. This field contains node pool information for each node, when it is available. - { # Provides GKE node pool information. - "name": "A String", # Kubernetes node pool name. - "nodes": [ # Nodes associated with the finding. - { # Kubernetes nodes associated with the finding. - "name": "A String", # [Full resource name](https://google.aip.dev/122#full-resource-names) of the Compute Engine VM running the cluster node. + "nodePools": [ + { + "name": "A String", + "nodes": [ + { + "name": "A String", }, ], }, ], - "nodes": [ # Provides Kubernetes [node](https://cloud.google.com/kubernetes-engine/docs/concepts/cluster-architecture#nodes) information. - { # Kubernetes nodes associated with the finding. - "name": "A String", # [Full resource name](https://google.aip.dev/122#full-resource-names) of the Compute Engine VM running the cluster node. + "nodes": [ + { + "name": "A String", }, ], - "objects": [ # Kubernetes objects related to the finding. - { # Kubernetes object related to the finding, uniquely identified by GKNN. Used if the object Kind is not one of Pod, Node, NodePool, Binding, or AccessReview. - "containers": [ # Pod containers associated with this finding, if any. - { # Container associated with the finding. - "createTime": "A String", # The time that the container was created. - "imageId": "A String", # Optional container image ID, if provided by the container runtime. Uniquely identifies the container image launched using a container image digest. - "labels": [ # Container labels, as provided by the container runtime. - { # Represents a generic name-value label. A label has separate name and value fields to support filtering with the `contains()` function. For more information, see [Filtering on array-type fields](https://cloud.google.com/security-command-center/docs/how-to-api-list-findings#array-contains-filtering). - "name": "A String", # Name of the label. - "value": "A String", # Value that corresponds to the label's name. + "objects": [ + { + "containers": [ + { + "createTime": "A String", + "imageId": "A String", + "labels": [ + { + "name": "A String", + "value": "A String", }, ], - "name": "A String", # Name of the container. - "uri": "A String", # Container image URI provided when configuring a pod or container. This string can identify a container image version using mutable tags. + "name": "A String", + "uri": "A String", }, ], - "group": "A String", # Kubernetes object group, such as "policy.k8s.io/v1". - "kind": "A String", # Kubernetes object kind, such as "Namespace". - "name": "A String", # Kubernetes object name. For details see https://kubernetes.io/docs/concepts/overview/working-with-objects/names/. - "ns": "A String", # Kubernetes object namespace. Must be a valid DNS label. Named "ns" to avoid collision with C++ namespace keyword. For details see https://kubernetes.io/docs/tasks/administer-cluster/namespaces/. - }, - ], - "pods": [ # Kubernetes [Pods](https://cloud.google.com/kubernetes-engine/docs/concepts/pod) associated with the finding. This field contains Pod records for each container that is owned by a Pod. - { # A Kubernetes Pod. - "containers": [ # Pod containers associated with this finding, if any. - { # Container associated with the finding. - "createTime": "A String", # The time that the container was created. - "imageId": "A String", # Optional container image ID, if provided by the container runtime. Uniquely identifies the container image launched using a container image digest. - "labels": [ # Container labels, as provided by the container runtime. - { # Represents a generic name-value label. A label has separate name and value fields to support filtering with the `contains()` function. For more information, see [Filtering on array-type fields](https://cloud.google.com/security-command-center/docs/how-to-api-list-findings#array-contains-filtering). - "name": "A String", # Name of the label. - "value": "A String", # Value that corresponds to the label's name. + "group": "A String", + "kind": "A String", + "name": "A String", + "ns": "A String", + }, + ], + "pods": [ + { + "containers": [ + { + "createTime": "A String", + "imageId": "A String", + "labels": [ + { + "name": "A String", + "value": "A String", }, ], - "name": "A String", # Name of the container. - "uri": "A String", # Container image URI provided when configuring a pod or container. This string can identify a container image version using mutable tags. + "name": "A String", + "uri": "A String", }, ], - "labels": [ # Pod labels. For Kubernetes containers, these are applied to the container. - { # Represents a generic name-value label. A label has separate name and value fields to support filtering with the `contains()` function. For more information, see [Filtering on array-type fields](https://cloud.google.com/security-command-center/docs/how-to-api-list-findings#array-contains-filtering). - "name": "A String", # Name of the label. - "value": "A String", # Value that corresponds to the label's name. + "labels": [ + { + "name": "A String", + "value": "A String", }, ], - "name": "A String", # Kubernetes Pod name. - "ns": "A String", # Kubernetes Pod namespace. + "name": "A String", + "ns": "A String", }, ], - "roles": [ # Provides Kubernetes role information for findings that involve [Roles or ClusterRoles](https://cloud.google.com/kubernetes-engine/docs/how-to/role-based-access-control). - { # Kubernetes Role or ClusterRole. - "kind": "A String", # Role type. - "name": "A String", # Role name. - "ns": "A String", # Role namespace. + "roles": [ + { + "kind": "A String", + "name": "A String", + "ns": "A String", }, ], }, - "loadBalancers": [ # The load balancers associated with the finding. - { # Contains information related to the load balancer associated with the finding. - "name": "A String", # The name of the load balancer associated with the finding. + "loadBalancers": [ + { + "name": "A String", }, ], - "logEntries": [ # Log entries that are relevant to the finding. - { # An individual entry in a log. - "cloudLoggingEntry": { # Metadata taken from a [Cloud Logging LogEntry](https://cloud.google.com/logging/docs/reference/v2/rest/v2/LogEntry) # An individual entry in a log stored in Cloud Logging. - "insertId": "A String", # A unique identifier for the log entry. - "logId": "A String", # The type of the log (part of `log_name`. `log_name` is the resource name of the log to which this log entry belongs). For example: `cloudresourcemanager.googleapis.com/activity`. Note that this field is not URL-encoded, unlike the `LOG_ID` field in `LogEntry`. - "resourceContainer": "A String", # The organization, folder, or project of the monitored resource that produced this log entry. - "timestamp": "A String", # The time the event described by the log entry occurred. + "logEntries": [ + { + "cloudLoggingEntry": { + "insertId": "A String", + "logId": "A String", + "resourceContainer": "A String", + "timestamp": "A String", }, }, ], - "mitreAttack": { # MITRE ATT&CK tactics and techniques related to this finding. See: https://attack.mitre.org # MITRE ATT&CK tactics and techniques related to this finding. See: https://attack.mitre.org - "additionalTactics": [ # Additional MITRE ATT&CK tactics related to this finding, if any. + "mitreAttack": { + "additionalTactics": [ "A String", ], - "additionalTechniques": [ # Additional MITRE ATT&CK techniques related to this finding, if any, along with any of their respective parent techniques. + "additionalTechniques": [ "A String", ], - "primaryTactic": "A String", # The MITRE ATT&CK tactic most closely represented by this finding, if any. - "primaryTechniques": [ # The MITRE ATT&CK technique most closely represented by this finding, if any. primary_techniques is a repeated field because there are multiple levels of MITRE ATT&CK techniques. If the technique most closely represented by this finding is a sub-technique (e.g. `SCANNING_IP_BLOCKS`), both the sub-technique and its parent technique(s) will be listed (e.g. `SCANNING_IP_BLOCKS`, `ACTIVE_SCANNING`). + "primaryTactic": "A String", + "primaryTechniques": [ "A String", ], - "version": "A String", # The MITRE ATT&CK version referenced by the above fields. E.g. "8". + "version": "A String", }, - "moduleName": "A String", # Unique identifier of the module which generated the finding. Example: folders/598186756061/securityHealthAnalyticsSettings/customModules/56799441161885 - "mute": "A String", # Indicates the mute state of a finding (either muted, unmuted or undefined). Unlike other attributes of a finding, a finding provider shouldn't set the value of mute. - "muteInfo": { # Mute information about the finding, including whether the finding has a static mute or any matching dynamic mute rules. # Output only. The mute information regarding this finding. - "dynamicMuteRecords": [ # The list of dynamic mute rules that currently match the finding. - { # The record of a dynamic mute rule that matches the finding. - "matchTime": "A String", # When the dynamic mute rule first matched the finding. - "muteConfig": "A String", # The relative resource name of the mute rule, represented by a mute config, that created this record, for example `organizations/123/muteConfigs/mymuteconfig` or `organizations/123/locations/global/muteConfigs/mymuteconfig`. + "moduleName": "A String", + "mute": "A String", + "muteInfo": { + "dynamicMuteRecords": [ + { + "matchTime": "A String", + "muteConfig": "A String", }, ], - "staticMute": { # Information about the static mute state. A static mute state overrides any dynamic mute rules that apply to this finding. The static mute state can be set by a static mute rule or by muting the finding directly. # If set, the static mute applied to this finding. Static mutes override dynamic mutes. If unset, there is no static mute. - "applyTime": "A String", # When the static mute was applied. - "state": "A String", # The static mute state. If the value is `MUTED` or `UNMUTED`, then the finding's overall mute state will have the same value. + "staticMute": { + "applyTime": "A String", + "state": "A String", }, }, - "muteInitiator": "A String", # Records additional information about the mute operation, for example, the [mute configuration](/security-command-center/docs/how-to-mute-findings) that muted the finding and the user who muted the finding. - "muteUpdateTime": "A String", # Output only. The most recent time this finding was muted or unmuted. - "name": "A String", # The [relative resource name](https://cloud.google.com/apis/design/resource_names#relative_resource_name) of the finding. Example: "organizations/{organization_id}/sources/{source_id}/findings/{finding_id}", "folders/{folder_id}/sources/{source_id}/findings/{finding_id}", "projects/{project_id}/sources/{source_id}/findings/{finding_id}". - "networks": [ # Represents the VPC networks that the resource is attached to. - { # Contains information about a VPC network associated with the finding. - "name": "A String", # The name of the VPC network resource, for example, `//compute.googleapis.com/projects/my-project/global/networks/my-network`. + "muteInitiator": "A String", + "muteUpdateTime": "A String", + "name": "A String", + "networks": [ + { + "name": "A String", }, ], - "nextSteps": "A String", # Steps to address the finding. - "notebook": { # Represents a Jupyter notebook IPYNB file, such as a [Colab Enterprise notebook](https://cloud.google.com/colab/docs/introduction) file, that is associated with a finding. # Notebook associated with the finding. - "lastAuthor": "A String", # The user ID of the latest author to modify the notebook. - "name": "A String", # The name of the notebook. - "notebookUpdateTime": "A String", # The most recent time the notebook was updated. - "service": "A String", # The source notebook service, for example, "Colab Enterprise". + "nextSteps": "A String", + "notebook": { + "lastAuthor": "A String", + "name": "A String", + "notebookUpdateTime": "A String", + "service": "A String", }, - "orgPolicies": [ # Contains information about the org policies associated with the finding. - { # Contains information about the org policies associated with the finding. - "name": "A String", # The resource name of the org policy. Example: "organizations/{organization_id}/policies/{constraint_name}" + "orgPolicies": [ + { + "name": "A String", }, ], - "parent": "A String", # The relative resource name of the source the finding belongs to. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name This field is immutable after creation time. For example: "organizations/{organization_id}/sources/{source_id}" - "parentDisplayName": "A String", # Output only. The human readable display name of the finding source such as "Event Threat Detection" or "Security Health Analytics". - "policyViolationSummary": { # Metadata summarizing policy violations of child resources of the affected resource. `finding_category` and `resource` determine the exact semantics of the counts. For example, when category=DATA_SECURITY_POSTURE_OBJECT_PUBLIC_ACCESS_VIOLATION and resource='storage.googleapis.com/buckets/my-bucket-name' then this counts the number of Cloud Storage objects in my-bucket-name which violate a Public Access control. # PolicyViolationSummary associated with the finding. - "conformantResourcesCount": "A String", # Total number of child resources that conform to the policy. - "evaluationErrorsCount": "A String", # Number of child resources for which errors during evaluation occurred. The evaluation result for these child resources is effectively "unknown". - "outOfScopeResourcesCount": "A String", # Total count of child resources which were not in scope for evaluation. - "policyViolationsCount": "A String", # Count of child resources in violation of the policy. - }, - "processes": [ # Represents operating system processes associated with the Finding. - { # Represents an operating system process. - "args": [ # Process arguments as JSON encoded strings. + "parent": "A String", + "parentDisplayName": "A String", + "policyViolationSummary": { + "conformantResourcesCount": "A String", + "evaluationErrorsCount": "A String", + "outOfScopeResourcesCount": "A String", + "policyViolationsCount": "A String", + }, + "processes": [ + { + "args": [ "A String", ], - "argumentsTruncated": True or False, # True if `args` is incomplete. - "binary": { # File information about the related binary/library used by an executable, or the script used by a script interpreter # File information for the process executable. - "contents": "A String", # Prefix of the file contents as a JSON-encoded string. - "diskPath": { # Path of the file in terms of underlying disk/partition identifiers. # Path of the file in terms of underlying disk/partition identifiers. - "partitionUuid": "A String", # UUID of the partition (format https://wiki.archlinux.org/title/persistent_block_device_naming#by-uuid) - "relativePath": "A String", # Relative path of the file in the partition as a JSON encoded string. Example: /home/user1/executable_file.sh + "argumentsTruncated": True or False, + "binary": { + "contents": "A String", + "diskPath": { + "partitionUuid": "A String", + "relativePath": "A String", }, - "fileLoadState": "A String", # The load state of the file. - "hashedSize": "A String", # The length in bytes of the file prefix that was hashed. If hashed_size == size, any hashes reported represent the entire file. - "operations": [ # Operation(s) performed on a file. - { # Operation(s) performed on a file. - "type": "A String", # The type of the operation + "fileLoadState": "A String", + "hashedSize": "A String", + "operations": [ + { + "type": "A String", }, ], - "partiallyHashed": True or False, # True when the hash covers only a prefix of the file. - "path": "A String", # Absolute path of the file as a JSON encoded string. - "sha256": "A String", # SHA256 hash of the first hashed_size bytes of the file encoded as a hex string. If hashed_size == size, sha256 represents the SHA256 hash of the entire file. - "size": "A String", # Size of the file in bytes. - }, - "envVariables": [ # Process environment variables. - { # A name-value pair representing an environment variable used in an operating system process. - "name": "A String", # Environment variable name as a JSON encoded string. - "val": "A String", # Environment variable value as a JSON encoded string. + "partiallyHashed": True or False, + "path": "A String", + "sha256": "A String", + "size": "A String", + }, + "envVariables": [ + { + "name": "A String", + "val": "A String", }, ], - "envVariablesTruncated": True or False, # True if `env_variables` is incomplete. - "libraries": [ # File information for libraries loaded by the process. - { # File information about the related binary/library used by an executable, or the script used by a script interpreter - "contents": "A String", # Prefix of the file contents as a JSON-encoded string. - "diskPath": { # Path of the file in terms of underlying disk/partition identifiers. # Path of the file in terms of underlying disk/partition identifiers. - "partitionUuid": "A String", # UUID of the partition (format https://wiki.archlinux.org/title/persistent_block_device_naming#by-uuid) - "relativePath": "A String", # Relative path of the file in the partition as a JSON encoded string. Example: /home/user1/executable_file.sh + "envVariablesTruncated": True or False, + "libraries": [ + { + "contents": "A String", + "diskPath": { + "partitionUuid": "A String", + "relativePath": "A String", }, - "fileLoadState": "A String", # The load state of the file. - "hashedSize": "A String", # The length in bytes of the file prefix that was hashed. If hashed_size == size, any hashes reported represent the entire file. - "operations": [ # Operation(s) performed on a file. - { # Operation(s) performed on a file. - "type": "A String", # The type of the operation + "fileLoadState": "A String", + "hashedSize": "A String", + "operations": [ + { + "type": "A String", }, ], - "partiallyHashed": True or False, # True when the hash covers only a prefix of the file. - "path": "A String", # Absolute path of the file as a JSON encoded string. - "sha256": "A String", # SHA256 hash of the first hashed_size bytes of the file encoded as a hex string. If hashed_size == size, sha256 represents the SHA256 hash of the entire file. - "size": "A String", # Size of the file in bytes. + "partiallyHashed": True or False, + "path": "A String", + "sha256": "A String", + "size": "A String", }, ], - "name": "A String", # The process name, as displayed in utilities like `top` and `ps`. This name can be accessed through `/proc/[pid]/comm` and changed with `prctl(PR_SET_NAME)`. - "parentPid": "A String", # The parent process ID. - "pid": "A String", # The process ID. - "script": { # File information about the related binary/library used by an executable, or the script used by a script interpreter # When the process represents the invocation of a script, `binary` provides information about the interpreter, while `script` provides information about the script file provided to the interpreter. - "contents": "A String", # Prefix of the file contents as a JSON-encoded string. - "diskPath": { # Path of the file in terms of underlying disk/partition identifiers. # Path of the file in terms of underlying disk/partition identifiers. - "partitionUuid": "A String", # UUID of the partition (format https://wiki.archlinux.org/title/persistent_block_device_naming#by-uuid) - "relativePath": "A String", # Relative path of the file in the partition as a JSON encoded string. Example: /home/user1/executable_file.sh + "name": "A String", + "parentPid": "A String", + "pid": "A String", + "script": { + "contents": "A String", + "diskPath": { + "partitionUuid": "A String", + "relativePath": "A String", }, - "fileLoadState": "A String", # The load state of the file. - "hashedSize": "A String", # The length in bytes of the file prefix that was hashed. If hashed_size == size, any hashes reported represent the entire file. - "operations": [ # Operation(s) performed on a file. - { # Operation(s) performed on a file. - "type": "A String", # The type of the operation + "fileLoadState": "A String", + "hashedSize": "A String", + "operations": [ + { + "type": "A String", }, ], - "partiallyHashed": True or False, # True when the hash covers only a prefix of the file. - "path": "A String", # Absolute path of the file as a JSON encoded string. - "sha256": "A String", # SHA256 hash of the first hashed_size bytes of the file encoded as a hex string. If hashed_size == size, sha256 represents the SHA256 hash of the entire file. - "size": "A String", # Size of the file in bytes. + "partiallyHashed": True or False, + "path": "A String", + "sha256": "A String", + "size": "A String", }, - "userId": "A String", # The ID of the user that executed the process. E.g. If this is the root user this will always be 0. + "userId": "A String", }, ], - "resourceName": "A String", # For findings on Google Cloud resources, the full resource name of the Google Cloud resource this finding is for. See: https://cloud.google.com/apis/design/resource_names#full_resource_name When the finding is for a non-Google Cloud resource, the resourceName can be a customer or partner defined string. This field is immutable after creation time. - "secret": { # Details about a secret or credential associated with the finding. # Secret associated with the finding. - "environmentVariable": { # Environment variable containing the secret. # The environment variable containing the secret. - "key": "A String", # Environment variable name as a JSON encoded string. Note that value is not included since the value contains the secret data, which is sensitive core content. + "resourceName": "A String", + "secret": { + "environmentVariable": { + "key": "A String", }, - "filePath": { # File path containing the secret. # The file containing the secret. - "path": "A String", # Path to the file. + "filePath": { + "path": "A String", }, - "status": { # The status of the secret. # The status of the secret. - "lastUpdatedTime": "A String", # Time that the secret was found. - "validity": "A String", # The validity of the secret. + "status": { + "lastUpdatedTime": "A String", + "validity": "A String", }, - "type": "A String", # The type of secret, for example, GCP_API_KEY. + "type": "A String", }, - "securityMarks": { # User specified security marks that are attached to the parent Security Command Center resource. Security marks are scoped within a Security Command Center organization -- they can be modified and viewed by all users who have proper permissions on the organization. # Output only. User specified security marks. These marks are entirely managed by the user and come from the SecurityMarks resource that belongs to the finding. - "canonicalName": "A String", # The canonical name of the marks. Examples: "organizations/{organization_id}/assets/{asset_id}/securityMarks" "folders/{folder_id}/assets/{asset_id}/securityMarks" "projects/{project_number}/assets/{asset_id}/securityMarks" "organizations/{organization_id}/sources/{source_id}/findings/{finding_id}/securityMarks" "folders/{folder_id}/sources/{source_id}/findings/{finding_id}/securityMarks" "projects/{project_number}/sources/{source_id}/findings/{finding_id}/securityMarks" - "marks": { # Mutable user specified security marks belonging to the parent resource. Constraints are as follows: * Keys and values are treated as case insensitive * Keys must be between 1 - 256 characters (inclusive) * Keys must be letters, numbers, underscores, or dashes * Values have leading and trailing whitespace trimmed, remaining characters must be between 1 - 4096 characters (inclusive) + "securityMarks": { + "canonicalName": "A String", + "marks": { "a_key": "A String", }, - "name": "A String", # The relative resource name of the SecurityMarks. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Examples: "organizations/{organization_id}/assets/{asset_id}/securityMarks" "organizations/{organization_id}/sources/{source_id}/findings/{finding_id}/securityMarks". + "name": "A String", }, - "securityPosture": { # Represents a posture that is deployed on Google Cloud by the Security Command Center Posture Management service. A posture contains one or more policy sets. A policy set is a group of policies that enforce a set of security rules on Google Cloud. # The security posture associated with the finding. - "changedPolicy": "A String", # The name of the updated policy, for example, `projects/{project_id}/policies/{constraint_name}`. - "name": "A String", # Name of the posture, for example, `CIS-Posture`. - "policy": "A String", # The ID of the updated policy, for example, `compute-policy-1`. - "policyDriftDetails": [ # The details about a change in an updated policy that violates the deployed posture. - { # The policy field that violates the deployed posture and its expected and detected values. - "detectedValue": "A String", # The detected value that violates the deployed posture, for example, `false` or `allowed_values={"projects/22831892"}`. - "expectedValue": "A String", # The value of this field that was configured in a posture, for example, `true` or `allowed_values={"projects/29831892"}`. - "field": "A String", # The name of the updated field, for example constraint.implementation.policy_rules[0].enforce + "securityPosture": { + "changedPolicy": "A String", + "name": "A String", + "policy": "A String", + "policyDriftDetails": [ + { + "detectedValue": "A String", + "expectedValue": "A String", + "field": "A String", }, ], - "policySet": "A String", # The name of the updated policyset, for example, `cis-policyset`. - "postureDeployment": "A String", # The name of the posture deployment, for example, `organizations/{org_id}/posturedeployments/{posture_deployment_id}`. - "postureDeploymentResource": "A String", # The project, folder, or organization on which the posture is deployed, for example, `projects/{project_number}`. - "revisionId": "A String", # The version of the posture, for example, `c7cfa2a8`. + "policySet": "A String", + "postureDeployment": "A String", + "postureDeploymentResource": "A String", + "revisionId": "A String", }, - "severity": "A String", # The severity of the finding. This field is managed by the source that writes the finding. - "sourceProperties": { # Source specific properties. These properties are managed by the source that writes the finding. The key names in the source_properties map must be between 1 and 255 characters, and must start with a letter and contain alphanumeric characters or underscores only. + "severity": "A String", + "sourceProperties": { "a_key": "", }, - "state": "A String", # The state of the finding. - "toxicCombination": { # Contains details about a group of security issues that, when the issues occur together, represent a greater risk than when the issues occur independently. A group of such issues is referred to as a toxic combination. # Contains details about a group of security issues that, when the issues occur together, represent a greater risk than when the issues occur independently. A group of such issues is referred to as a toxic combination. This field cannot be updated. Its value is ignored in all update requests. - "attackExposureScore": 3.14, # The [Attack exposure score](https://cloud.google.com/security-command-center/docs/attack-exposure-learn#attack_exposure_scores) of this toxic combination. The score is a measure of how much this toxic combination exposes one or more high-value resources to potential attack. - "relatedFindings": [ # List of resource names of findings associated with this toxic combination. For example, `organizations/123/sources/456/findings/789`. + "state": "A String", + "toxicCombination": { + "attackExposureScore": 3.14, + "relatedFindings": [ "A String", ], }, - "vertexAi": { # Vertex AI-related information associated with the finding. # VertexAi associated with the finding. - "datasets": [ # Datasets associated with the finding. - { # Vertex AI dataset associated with the finding. - "displayName": "A String", # The user defined display name of dataset, e.g. plants-dataset - "name": "A String", # Resource name of the dataset, e.g. projects/{project}/locations/{location}/datasets/2094040236064505856 - "source": "A String", # Data source, such as BigQuery source URI, e.g. bq://scc-nexus-test.AIPPtest.gsod - }, - ], - "pipelines": [ # Pipelines associated with the finding. - { # Vertex AI training pipeline associated with the finding. - "displayName": "A String", # The user defined display name of pipeline, e.g. plants-classification - "name": "A String", # Resource name of the pipeline, e.g. projects/{project}/locations/{location}/trainingPipelines/5253428229225578496 - }, - ], - }, - "vulnerability": { # Refers to common vulnerability fields e.g. cve, cvss, cwe etc. # Represents vulnerability-specific fields like CVE and CVSS scores. CVE stands for Common Vulnerabilities and Exposures (https://cve.mitre.org/about/) - "cve": { # CVE stands for Common Vulnerabilities and Exposures. Information from the [CVE record](https://www.cve.org/ResourcesSupport/Glossary) that describes this vulnerability. # CVE stands for Common Vulnerabilities and Exposures (https://cve.mitre.org/about/) - "cvssv3": { # Common Vulnerability Scoring System version 3. # Describe Common Vulnerability Scoring System specified at https://www.first.org/cvss/v3.1/specification-document - "attackComplexity": "A String", # This metric describes the conditions beyond the attacker's control that must exist in order to exploit the vulnerability. - "attackVector": "A String", # Base Metrics Represents the intrinsic characteristics of a vulnerability that are constant over time and across user environments. This metric reflects the context by which vulnerability exploitation is possible. - "availabilityImpact": "A String", # This metric measures the impact to the availability of the impacted component resulting from a successfully exploited vulnerability. - "baseScore": 3.14, # The base score is a function of the base metric scores. - "confidentialityImpact": "A String", # This metric measures the impact to the confidentiality of the information resources managed by a software component due to a successfully exploited vulnerability. - "integrityImpact": "A String", # This metric measures the impact to integrity of a successfully exploited vulnerability. - "privilegesRequired": "A String", # This metric describes the level of privileges an attacker must possess before successfully exploiting the vulnerability. - "scope": "A String", # The Scope metric captures whether a vulnerability in one vulnerable component impacts resources in components beyond its security scope. - "userInteraction": "A String", # This metric captures the requirement for a human user, other than the attacker, to participate in the successful compromise of the vulnerable component. - }, - "exploitReleaseDate": "A String", # Date the first publicly available exploit or PoC was released. - "exploitationActivity": "A String", # The exploitation activity of the vulnerability in the wild. - "firstExploitationDate": "A String", # Date of the earliest known exploitation. - "id": "A String", # The unique identifier for the vulnerability. e.g. CVE-2021-34527 - "impact": "A String", # The potential impact of the vulnerability if it was to be exploited. - "observedInTheWild": True or False, # Whether or not the vulnerability has been observed in the wild. - "references": [ # Additional information about the CVE. e.g. https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2021-34527 - { # Additional Links - "source": "A String", # Source of the reference e.g. NVD - "uri": "A String", # Uri for the mentioned source e.g. https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2021-34527. + "vertexAi": { + "datasets": [ + { + "displayName": "A String", + "name": "A String", + "source": "A String", + }, + ], + "pipelines": [ + { + "displayName": "A String", + "name": "A String", + }, + ], + }, + "vulnerability": { + "cve": { + "cvssv3": { + "attackComplexity": "A String", + "attackVector": "A String", + "availabilityImpact": "A String", + "baseScore": 3.14, + "confidentialityImpact": "A String", + "integrityImpact": "A String", + "privilegesRequired": "A String", + "scope": "A String", + "userInteraction": "A String", + }, + "exploitReleaseDate": "A String", + "exploitationActivity": "A String", + "firstExploitationDate": "A String", + "id": "A String", + "impact": "A String", + "observedInTheWild": True or False, + "references": [ + { + "source": "A String", + "uri": "A String", }, ], - "upstreamFixAvailable": True or False, # Whether upstream fix is available for the CVE. - "zeroDay": True or False, # Whether or not the vulnerability was zero day when the finding was published. - }, - "cwes": [ # Represents one or more Common Weakness Enumeration (CWE) information on this vulnerability. - { # CWE stands for Common Weakness Enumeration. Information about this weakness, as described by [CWE](https://cwe.mitre.org/). - "id": "A String", # The CWE identifier, e.g. CWE-94 - "references": [ # Any reference to the details on the CWE, for example, https://cwe.mitre.org/data/definitions/94.html - { # Additional Links - "source": "A String", # Source of the reference e.g. NVD - "uri": "A String", # Uri for the mentioned source e.g. https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2021-34527. + "upstreamFixAvailable": True or False, + "zeroDay": True or False, + }, + "cwes": [ + { + "id": "A String", + "references": [ + { + "source": "A String", + "uri": "A String", }, ], }, ], - "fixedPackage": { # Package is a generic definition of a package. # The fixed package is relevant to the finding. - "cpeUri": "A String", # The CPE URI where the vulnerability was detected. - "packageName": "A String", # The name of the package where the vulnerability was detected. - "packageType": "A String", # Type of package, for example, os, maven, or go. - "packageVersion": "A String", # The version of the package. + "fixedPackage": { + "cpeUri": "A String", + "packageName": "A String", + "packageType": "A String", + "packageVersion": "A String", }, - "offendingPackage": { # Package is a generic definition of a package. # The offending package is relevant to the finding. - "cpeUri": "A String", # The CPE URI where the vulnerability was detected. - "packageName": "A String", # The name of the package where the vulnerability was detected. - "packageType": "A String", # Type of package, for example, os, maven, or go. - "packageVersion": "A String", # The version of the package. + "offendingPackage": { + "cpeUri": "A String", + "packageName": "A String", + "packageType": "A String", + "packageVersion": "A String", }, - "providerRiskScore": "A String", # Provider provided risk_score based on multiple factors. The higher the risk score, the more risky the vulnerability is. - "reachable": True or False, # Represents whether the vulnerability is reachable (detected via static analysis) - "securityBulletin": { # SecurityBulletin are notifications of vulnerabilities of Google products. # The security bulletin is relevant to this finding. - "bulletinId": "A String", # ID of the bulletin corresponding to the vulnerability. - "submissionTime": "A String", # Submission time of this Security Bulletin. - "suggestedUpgradeVersion": "A String", # This represents a version that the cluster receiving this notification should be upgraded to, based on its current version. For example, 1.15.0 + "providerRiskScore": "A String", + "reachable": True or False, + "securityBulletin": { + "bulletinId": "A String", + "submissionTime": "A String", + "suggestedUpgradeVersion": "A String", }, }, }
@@ -4423,15 +4423,15 @@

Method Details

setMute(name, body=None, x__xgafv=None) -
Updates the mute state of a finding.
+  
 
 Args:
-  name: string, Required. The [relative resource name](https://cloud.google.com/apis/design/resource_names#relative_resource_name) of the finding. Example: `organizations/{organization_id}/sources/{source_id}/findings/{finding_id}`, `folders/{folder_id}/sources/{source_id}/findings/{finding_id}`, `projects/{project_id}/sources/{source_id}/findings/{finding_id}`. (required)
+  name: string, A parameter (required)
   body: object, The request body.
     The object takes the form of:
 
-{ # Request message for updating a finding's mute status.
-  "mute": "A String", # Required. The desired state of the Mute.
+{
+  "mute": "A String",
 }
 
   x__xgafv: string, V1 error format.
@@ -4442,811 +4442,811 @@ 

Method Details

Returns: An object of the form: - { # Security Command Center finding. A finding is a record of assessment data like security, risk, health, or privacy, that is ingested into Security Command Center for presentation, notification, analysis, policy testing, and enforcement. For example, a cross-site scripting (XSS) vulnerability in an App Engine application is a finding. - "access": { # Represents an access event. # Access details associated with the finding, such as more information on the caller, which method was accessed, and from where. - "callerIp": "A String", # Caller's IP address, such as "1.1.1.1". - "callerIpGeo": { # Represents a geographical location for a given access. # The caller IP's geolocation, which identifies where the call came from. - "regionCode": "A String", # A CLDR. - }, - "methodName": "A String", # The method that the service account called, e.g. "SetIamPolicy". - "principalEmail": "A String", # Associated email, such as "foo@google.com". The email address of the authenticated user or a service account acting on behalf of a 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). - "principalSubject": "A String", # A string that represents the principal_subject that is associated with the identity. Unlike `principal_email`, `principal_subject` supports principals that aren't associated with email addresses, such as third party principals. For most identities, the format is `principal://iam.googleapis.com/{identity pool name}/subject/{subject}`. Some GKE identities, such as GKE_WORKLOAD, FREEFORM, and GKE_HUB_WORKLOAD, still use the legacy format `serviceAccount:{identity pool name}[{subject}]`. - "serviceAccountDelegationInfo": [ # The identity delegation history of an authenticated service account that made the request. The `serviceAccountDelegationInfo[]` object contains information about the real authorities that try to access Google Cloud resources by delegating on a service account. When multiple authorities are present, they are guaranteed to be sorted based on the original ordering of the identity delegation events. - { # Identity delegation history of an authenticated service account. - "principalEmail": "A String", # The email address of a Google account. - "principalSubject": "A String", # A string representing the principal_subject associated with the identity. As compared to `principal_email`, supports principals that aren't associated with email addresses, such as third party principals. For most identities, the format will be `principal://iam.googleapis.com/{identity pool name}/subjects/{subject}` except for some GKE identities (GKE_WORKLOAD, FREEFORM, GKE_HUB_WORKLOAD) that are still in the legacy format `serviceAccount:{identity pool name}[{subject}]` - }, - ], - "serviceAccountKeyName": "A String", # The name of the service account key that was used to create or exchange credentials when authenticating the service account that made the request. This is a scheme-less URI full resource name. For example: "//iam.googleapis.com/projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}/keys/{key}". - "serviceName": "A String", # This is the API service that the service account made a call to, e.g. "iam.googleapis.com" - "userAgent": "A String", # The caller's user agent string associated with the finding. - "userAgentFamily": "A String", # Type of user agent associated with the finding. For example, an operating system shell or an embedded or standalone application. - "userName": "A String", # A string that represents a username. The username provided depends on the type of the finding and is likely not an IAM principal. For example, this can be a system username if the finding is related to a virtual machine, or it can be an application login username. - }, - "affectedResources": { # Details about resources affected by this finding. # AffectedResources associated with the finding. - "count": "A String", # The count of resources affected by the finding. - }, - "agentDataAccessEvents": [ # Agent data access events associated with the finding. - { # Details about a data access attempt made by an agent principal not authorized under applicable data security policy. - "eventId": "A String", # Unique identifier for data access event. - "eventTime": "A String", # Timestamp of data access event. - "operation": "A String", # The operation performed by the principal to access the data. - "principalSubject": "A String", # The agent principal that accessed the data. + { + "access": { + "callerIp": "A String", + "callerIpGeo": { + "regionCode": "A String", + }, + "methodName": "A String", + "principalEmail": "A String", + "principalSubject": "A String", + "serviceAccountDelegationInfo": [ + { + "principalEmail": "A String", + "principalSubject": "A String", + }, + ], + "serviceAccountKeyName": "A String", + "serviceName": "A String", + "userAgent": "A String", + "userAgentFamily": "A String", + "userName": "A String", + }, + "affectedResources": { + "count": "A String", + }, + "agentDataAccessEvents": [ + { + "eventId": "A String", + "eventTime": "A String", + "operation": "A String", + "principalSubject": "A String", }, ], - "aiModel": { # Contains information about the AI model associated with the finding. # The AI model associated with the finding. - "deploymentPlatform": "A String", # The platform on which the model is deployed. - "displayName": "A String", # The user defined display name of model. Ex. baseline-classification-model - "domain": "A String", # The domain of the model, for example, “image-classification”. - "library": "A String", # The name of the model library, for example, “transformers”. - "location": "A String", # The region in which the model is used, for example, “us-central1”. - "name": "A String", # The name of the AI model, for example, "gemini:1.0.0". - "publisher": "A String", # The publisher of the model, for example, “google” or “nvidia”. - "usageCategory": "A String", # The purpose of the model, for example, "Inteference" or "Training". - }, - "application": { # Represents an application associated with a finding. # Represents an application associated with the finding. - "baseUri": "A String", # The base URI that identifies the network location of the application in which the vulnerability was detected. For example, `http://example.com`. - "fullUri": "A String", # The full URI with payload that can be used to reproduce the vulnerability. For example, `http://example.com?p=aMmYgI6H`. - }, - "artifactGuardPolicies": { # Represents the result of evaluating artifact guard policies. # ArtifactGuardPolicies associated with the finding. - "failingPolicies": [ # A list of failing policies. - { # Represents an artifact guard policy. - "failureReason": "A String", # The reason for the policy failure, for example, "severity=HIGH AND max_vuln_count=2". - "policyId": "A String", # The ID of the failing policy, for example, "organizations/3392779/locations/global/policies/prod-policy". - "type": "A String", # The type of the policy evaluation. - }, - ], - "resourceId": "A String", # The ID of the resource that has policies configured for it. - }, - "attackExposure": { # An attack exposure contains the results of an attack path simulation run. # The results of an attack path simulation relevant to this finding. - "attackExposureResult": "A String", # The resource name of the attack path simulation result that contains the details regarding this attack exposure score. Example: `organizations/123/simulations/456/attackExposureResults/789` - "exposedHighValueResourcesCount": 42, # The number of high value resources that are exposed as a result of this finding. - "exposedLowValueResourcesCount": 42, # The number of high value resources that are exposed as a result of this finding. - "exposedMediumValueResourcesCount": 42, # The number of medium value resources that are exposed as a result of this finding. - "latestCalculationTime": "A String", # The most recent time the attack exposure was updated on this finding. - "score": 3.14, # A number between 0 (inclusive) and infinity that represents how important this finding is to remediate. The higher the score, the more important it is to remediate. - "state": "A String", # What state this AttackExposure is in. This captures whether or not an attack exposure has been calculated or not. - }, - "backupDisasterRecovery": { # Information related to Google Cloud Backup and DR Service findings. # Fields related to Backup and DR findings. - "appliance": "A String", # The name of the Backup and DR appliance that captures, moves, and manages the lifecycle of backup data. For example, `backup-server-57137`. - "applications": [ # The names of Backup and DR applications. An application is a VM, database, or file system on a managed host monitored by a backup and recovery appliance. For example, `centos7-01-vol00`, `centos7-01-vol01`, `centos7-01-vol02`. + "aiModel": { + "deploymentPlatform": "A String", + "displayName": "A String", + "domain": "A String", + "library": "A String", + "location": "A String", + "name": "A String", + "publisher": "A String", + "usageCategory": "A String", + }, + "application": { + "baseUri": "A String", + "fullUri": "A String", + }, + "artifactGuardPolicies": { + "failingPolicies": [ + { + "failureReason": "A String", + "policyId": "A String", + "type": "A String", + }, + ], + "resourceId": "A String", + }, + "attackExposure": { + "attackExposureResult": "A String", + "exposedHighValueResourcesCount": 42, + "exposedLowValueResourcesCount": 42, + "exposedMediumValueResourcesCount": 42, + "latestCalculationTime": "A String", + "score": 3.14, + "state": "A String", + }, + "backupDisasterRecovery": { + "appliance": "A String", + "applications": [ "A String", ], - "backupCreateTime": "A String", # The timestamp at which the Backup and DR backup was created. - "backupTemplate": "A String", # The name of a Backup and DR template which comprises one or more backup policies. See the [Backup and DR documentation](https://cloud.google.com/backup-disaster-recovery/docs/concepts/backup-plan#temp) for more information. For example, `snap-ov`. - "backupType": "A String", # The backup type of the Backup and DR image. For example, `Snapshot`, `Remote Snapshot`, `OnVault`. - "host": "A String", # The name of a Backup and DR host, which is managed by the backup and recovery appliance and known to the management console. The host can be of type Generic (for example, Compute Engine, SQL Server, Oracle DB, SMB file system, etc.), vCenter, or an ESX server. See the [Backup and DR documentation on hosts](https://cloud.google.com/backup-disaster-recovery/docs/configuration/manage-hosts-and-their-applications) for more information. For example, `centos7-01`. - "policies": [ # The names of Backup and DR policies that are associated with a template and that define when to run a backup, how frequently to run a backup, and how long to retain the backup image. For example, `onvaults`. + "backupCreateTime": "A String", + "backupTemplate": "A String", + "backupType": "A String", + "host": "A String", + "policies": [ "A String", ], - "policyOptions": [ # The names of Backup and DR advanced policy options of a policy applying to an application. See the [Backup and DR documentation on policy options](https://cloud.google.com/backup-disaster-recovery/docs/create-plan/policy-settings). For example, `skipofflineappsincongrp, nounmap`. + "policyOptions": [ "A String", ], - "profile": "A String", # The name of the Backup and DR resource profile that specifies the storage media for backups of application and VM data. See the [Backup and DR documentation on profiles](https://cloud.google.com/backup-disaster-recovery/docs/concepts/backup-plan#profile). For example, `GCP`. - "storagePool": "A String", # The name of the Backup and DR storage pool that the backup and recovery appliance is storing data in. The storage pool could be of type Cloud, Primary, Snapshot, or OnVault. See the [Backup and DR documentation on storage pools](https://cloud.google.com/backup-disaster-recovery/docs/concepts/storage-pools). For example, `DiskPoolOne`. + "profile": "A String", + "storagePool": "A String", }, - "canonicalName": "A String", # The canonical name of the finding. It's either "organizations/{organization_id}/sources/{source_id}/findings/{finding_id}", "folders/{folder_id}/sources/{source_id}/findings/{finding_id}" or "projects/{project_number}/sources/{source_id}/findings/{finding_id}", depending on the closest CRM ancestor of the resource associated with the finding. - "category": "A String", # The additional taxonomy group within findings from a given source. This field is immutable after creation time. Example: "XSS_FLASH_INJECTION" - "chokepoint": { # Contains details about a chokepoint, which is a resource or resource group where high-risk attack paths converge, based on [attack path simulations] (https://cloud.google.com/security-command-center/docs/attack-exposure-learn#attack_path_simulations). # Contains details about a chokepoint, which is a resource or resource group where high-risk attack paths converge, based on [attack path simulations] (https://cloud.google.com/security-command-center/docs/attack-exposure-learn#attack_path_simulations). This field cannot be updated. Its value is ignored in all update requests. - "relatedFindings": [ # List of resource names of findings associated with this chokepoint. For example, organizations/123/sources/456/findings/789. This list will have at most 100 findings. + "canonicalName": "A String", + "category": "A String", + "chokepoint": { + "relatedFindings": [ "A String", ], }, - "cloudArmor": { # Fields related to Google Cloud Armor findings. # Fields related to Cloud Armor findings. - "adaptiveProtection": { # Information about [Google Cloud Armor Adaptive Protection](https://cloud.google.com/armor/docs/cloud-armor-overview#google-cloud-armor-adaptive-protection). # Information about potential Layer 7 DDoS attacks identified by [Google Cloud Armor Adaptive Protection](https://cloud.google.com/armor/docs/adaptive-protection-overview). - "confidence": 3.14, # A score of 0 means that there is low confidence that the detected event is an actual attack. A score of 1 means that there is high confidence that the detected event is an attack. See the [Adaptive Protection documentation](https://cloud.google.com/armor/docs/adaptive-protection-overview#configure-alert-tuning) for further explanation. - }, - "attack": { # Information about DDoS attack volume and classification. # Information about DDoS attack volume and classification. - "classification": "A String", # Type of attack, for example, 'SYN-flood', 'NTP-udp', or 'CHARGEN-udp'. - "volumeBps": 42, # Total BPS (bytes per second) volume of attack. Deprecated - refer to volume_bps_long instead. - "volumeBpsLong": "A String", # Total BPS (bytes per second) volume of attack. - "volumePps": 42, # Total PPS (packets per second) volume of attack. Deprecated - refer to volume_pps_long instead. - "volumePpsLong": "A String", # Total PPS (packets per second) volume of attack. - }, - "duration": "A String", # Duration of attack from the start until the current moment (updated every 5 minutes). - "requests": { # Information about the requests relevant to the finding. # Information about incoming requests evaluated by [Google Cloud Armor security policies](https://cloud.google.com/armor/docs/security-policy-overview). - "longTermAllowed": 42, # Allowed RPS (requests per second) over the long term. - "longTermDenied": 42, # Denied RPS (requests per second) over the long term. - "ratio": 3.14, # For 'Increasing deny ratio', the ratio is the denied traffic divided by the allowed traffic. For 'Allowed traffic spike', the ratio is the allowed traffic in the short term divided by allowed traffic in the long term. - "shortTermAllowed": 42, # Allowed RPS (requests per second) in the short term. - }, - "securityPolicy": { # Information about the [Google Cloud Armor security policy](https://cloud.google.com/armor/docs/security-policy-overview) relevant to the finding. # Information about the [Google Cloud Armor security policy](https://cloud.google.com/armor/docs/security-policy-overview) relevant to the finding. - "name": "A String", # The name of the Google Cloud Armor security policy, for example, "my-security-policy". - "preview": True or False, # Whether or not the associated rule or policy is in preview mode. - "type": "A String", # The type of Google Cloud Armor security policy for example, 'backend security policy', 'edge security policy', 'network edge security policy', or 'always-on DDoS protection'. - }, - "threatVector": "A String", # Distinguish between volumetric & protocol DDoS attack and application layer attacks. For example, "L3_4" for Layer 3 and Layer 4 DDoS attacks, or "L_7" for Layer 7 DDoS attacks. - }, - "cloudDlpDataProfile": { # The [data profile](https://cloud.google.com/dlp/docs/data-profiles) associated with the finding. # Cloud DLP data profile that is associated with the finding. - "dataProfile": "A String", # Name of the data profile, for example, `projects/123/locations/europe/tableProfiles/8383929`. - "infoTypes": [ # Type of information detected by SDP. Info type includes name, version and sensitivity of the detected information type. - { # Type of information detected by the API. - "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. - "sensitivityScore": { # Score is calculated from of all elements in the data profile. A higher level means the data is more sensitive. # Optional custom sensitivity for this InfoType. This only applies to data profiling. - "score": "A String", # The sensitivity score applied to the resource. + "cloudArmor": { + "adaptiveProtection": { + "confidence": 3.14, + }, + "attack": { + "classification": "A String", + "volumeBps": 42, + "volumeBpsLong": "A String", + "volumePps": 42, + "volumePpsLong": "A String", + }, + "duration": "A String", + "requests": { + "longTermAllowed": 42, + "longTermDenied": 42, + "ratio": 3.14, + "shortTermAllowed": 42, + }, + "securityPolicy": { + "name": "A String", + "preview": True or False, + "type": "A String", + }, + "threatVector": "A String", + }, + "cloudDlpDataProfile": { + "dataProfile": "A String", + "infoTypes": [ + { + "name": "A String", + "sensitivityScore": { + "score": "A String", }, - "version": "A String", # Optional version name for this InfoType. + "version": "A String", }, ], - "parentType": "A String", # The resource hierarchy level at which the data profile was generated. + "parentType": "A String", }, - "cloudDlpInspection": { # Details about the Cloud Data Loss Prevention (Cloud DLP) [inspection job](https://cloud.google.com/dlp/docs/concepts-job-triggers) that produced the finding. # Cloud Data Loss Prevention (Cloud DLP) inspection results that are associated with the finding. - "fullScan": True or False, # Whether Cloud DLP scanned the complete resource or a sampled subset. - "infoType": "A String", # The type of information (or *[infoType](https://cloud.google.com/dlp/docs/infotypes-reference)*) found, for example, `EMAIL_ADDRESS` or `STREET_ADDRESS`. - "infoTypeCount": "A String", # The number of times Cloud DLP found this infoType within this job and resource. - "inspectJob": "A String", # Name of the inspection job, for example, `projects/123/locations/europe/dlpJobs/i-8383929`. + "cloudDlpInspection": { + "fullScan": True or False, + "infoType": "A String", + "infoTypeCount": "A String", + "inspectJob": "A String", }, - "complianceDetails": { # Compliance Details associated with the finding. # Details about the compliance implications of the finding. - "cloudControl": { # CloudControl associated with the finding. # CloudControl associated with the finding - "cloudControlName": "A String", # Name of the CloudControl associated with the finding. - "policyType": "A String", # Policy type of the CloudControl - "type": "A String", # Type of cloud control. - "version": 42, # Version of the Cloud Control + "complianceDetails": { + "cloudControl": { + "cloudControlName": "A String", + "policyType": "A String", + "type": "A String", + "version": 42, }, - "cloudControlDeploymentNames": [ # Cloud Control Deployments associated with the finding. For example, organizations/123/locations/global/cloudControlDeployments/deploymentIdentifier + "cloudControlDeploymentNames": [ "A String", ], - "frameworks": [ # Details of Frameworks associated with the finding - { # Compliance framework associated with the finding. - "category": [ # Category of the framework associated with the finding. E.g. Security Benchmark, or Assured Workloads + "frameworks": [ + { + "category": [ "A String", ], - "controls": [ # The controls associated with the framework. - { # Compliance control associated with the finding. - "controlName": "A String", # Name of the Control - "displayName": "A String", # Display name of the control. For example, AU-02. + "controls": [ + { + "controlName": "A String", + "displayName": "A String", }, ], - "displayName": "A String", # Display name of the framework. For a standard framework, this will look like e.g. PCI DSS 3.2.1, whereas for a custom framework it can be a user defined string like MyFramework - "name": "A String", # Name of the framework associated with the finding - "type": "A String", # Type of the framework associated with the finding, to specify whether the framework is built-in (pre-defined and immutable) or a custom framework defined by the customer (equivalent to security posture) + "displayName": "A String", + "name": "A String", + "type": "A String", }, ], }, - "compliances": [ # Contains compliance information for security standards associated to the finding. - { # Contains compliance information about a security standard indicating unmet recommendations. - "ids": [ # Policies within the standard or benchmark, for example, A.12.4.1 + "compliances": [ + { + "ids": [ "A String", ], - "standard": "A String", # Industry-wide compliance standards or benchmarks, such as CIS, PCI, and OWASP. - "version": "A String", # Version of the standard or benchmark, for example, 1.1 + "standard": "A String", + "version": "A String", }, ], - "connections": [ # Contains information about the IP connection associated with the finding. - { # Contains information about the IP connection associated with the finding. - "destinationIp": "A String", # Destination IP address. Not present for sockets that are listening and not connected. - "destinationPort": 42, # Destination port. Not present for sockets that are listening and not connected. - "protocol": "A String", # IANA Internet Protocol Number such as TCP(6) and UDP(17). - "sourceIp": "A String", # Source IP address. - "sourcePort": 42, # Source port. + "connections": [ + { + "destinationIp": "A String", + "destinationPort": 42, + "protocol": "A String", + "sourceIp": "A String", + "sourcePort": 42, }, ], - "contacts": { # Output only. Map containing the points of contact for the given finding. The key represents the type of contact, while the value contains a list of all the contacts that pertain. Please refer to: https://cloud.google.com/resource-manager/docs/managing-notification-contacts#notification-categories { "security": { "contacts": [ { "email": "person1@company.com" }, { "email": "person2@company.com" } ] } } - "a_key": { # Details about specific contacts - "contacts": [ # A list of contacts - { # The email address of a contact. - "email": "A String", # An email address. For example, "`person123@company.com`". + "contacts": { + "a_key": { + "contacts": [ + { + "email": "A String", }, ], }, }, - "containers": [ # Containers associated with the finding. This field provides information for both Kubernetes and non-Kubernetes containers. - { # Container associated with the finding. - "createTime": "A String", # The time that the container was created. - "imageId": "A String", # Optional container image ID, if provided by the container runtime. Uniquely identifies the container image launched using a container image digest. - "labels": [ # Container labels, as provided by the container runtime. - { # Represents a generic name-value label. A label has separate name and value fields to support filtering with the `contains()` function. For more information, see [Filtering on array-type fields](https://cloud.google.com/security-command-center/docs/how-to-api-list-findings#array-contains-filtering). - "name": "A String", # Name of the label. - "value": "A String", # Value that corresponds to the label's name. + "containers": [ + { + "createTime": "A String", + "imageId": "A String", + "labels": [ + { + "name": "A String", + "value": "A String", }, ], - "name": "A String", # Name of the container. - "uri": "A String", # Container image URI provided when configuring a pod or container. This string can identify a container image version using mutable tags. + "name": "A String", + "uri": "A String", }, ], - "createTime": "A String", # The time at which the finding was created in Security Command Center. - "dataAccessEvents": [ # Data access events associated with the finding. - { # Details about a data access attempt made by a principal not authorized under applicable data security policy. - "eventId": "A String", # Unique identifier for data access event. - "eventTime": "A String", # Timestamp of data access event. - "operation": "A String", # The operation performed by the principal to access the data. - "principalEmail": "A String", # The email address of the principal that accessed the data. The principal could be a user account, service account, Google group, or other. + "createTime": "A String", + "dataAccessEvents": [ + { + "eventId": "A String", + "eventTime": "A String", + "operation": "A String", + "principalEmail": "A String", }, ], - "dataFlowEvents": [ # Data flow events associated with the finding. - { # Details about a data flow event, in which either the data is moved to or is accessed from a non-compliant geo-location, as defined in the applicable data security policy. - "eventId": "A String", # Unique identifier for data flow event. - "eventTime": "A String", # Timestamp of data flow event. - "operation": "A String", # The operation performed by the principal for the data flow event. - "principalEmail": "A String", # The email address of the principal that initiated the data flow event. The principal could be a user account, service account, Google group, or other. - "violatedLocation": "A String", # Non-compliant location of the principal or the data destination. + "dataFlowEvents": [ + { + "eventId": "A String", + "eventTime": "A String", + "operation": "A String", + "principalEmail": "A String", + "violatedLocation": "A String", }, ], - "dataRetentionDeletionEvents": [ # Data retention deletion events associated with the finding. - { # Details about data retention deletion violations, in which the data is non-compliant based on their retention or deletion time, as defined in the applicable data security policy. The Data Retention Deletion (DRD) control is a control of the DSPM (Data Security Posture Management) suite that enables organizations to manage data retention and deletion policies in compliance with regulations, such as GDPR and CRPA. DRD supports two primary policy types: maximum storage length (max TTL) and minimum storage length (min TTL). Both are aimed at helping organizations meet regulatory and data management commitments. - "dataObjectCount": "A String", # Number of objects that violated the policy for this resource. If the number is less than 1,000, then the value of this field is the exact number. If the number of objects that violated the policy is greater than or equal to 1,000, then the value of this field is 1000. - "eventDetectionTime": "A String", # Timestamp indicating when the event was detected. - "eventType": "A String", # Type of the DRD event. - "maxRetentionAllowed": "A String", # Maximum duration of retention allowed from the DRD control. This comes from the DRD control where users set a max TTL for their data. For example, suppose that a user sets the max TTL for a Cloud Storage bucket to 90 days. However, an object in that bucket is 100 days old. In this case, a DataRetentionDeletionEvent will be generated for that Cloud Storage bucket, and the max_retention_allowed is 90 days. - "minRetentionAllowed": "A String", # Min duration of retention allowed from the DSPM retention control. This field is only populated when event type is set to EVENT_TYPE_MIN_TTL_FROM_CREATION. + "dataRetentionDeletionEvents": [ + { + "dataObjectCount": "A String", + "eventDetectionTime": "A String", + "eventType": "A String", + "maxRetentionAllowed": "A String", + "minRetentionAllowed": "A String", }, ], - "database": { # Represents database access information, such as queries. A database may be a sub-resource of an instance (as in the case of Cloud SQL instances or Cloud Spanner instances), or the database instance itself. Some database resources might not have the [full resource name](https://google.aip.dev/122#full-resource-names) populated because these resource types, such as Cloud SQL databases, are not yet supported by Cloud Asset Inventory. In these cases only the display name is provided. # Database associated with the finding. - "displayName": "A String", # The human-readable name of the database that the user connected to. - "grantees": [ # The target usernames, roles, or groups of an SQL privilege grant, which is not an IAM policy change. + "database": { + "displayName": "A String", + "grantees": [ "A String", ], - "name": "A String", # Some database resources may not have the [full resource name](https://google.aip.dev/122#full-resource-names) populated because these resource types are not yet supported by Cloud Asset Inventory (e.g. Cloud SQL databases). In these cases only the display name will be provided. The [full resource name](https://google.aip.dev/122#full-resource-names) of the database that the user connected to, if it is supported by Cloud Asset Inventory. - "query": "A String", # The SQL statement that is associated with the database access. - "userName": "A String", # The username used to connect to the database. The username might not be an IAM principal and does not have a set format. - "version": "A String", # The version of the database, for example, POSTGRES_14. See [the complete list](https://cloud.google.com/sql/docs/mysql/admin-api/rest/v1/SqlDatabaseVersion). - }, - "description": "A String", # Contains more details about the finding. - "discoveredWorkload": { # Represents discovered, customer managed workload that is not registered with the respective GCP service. # DiscoveredWorkload associated with the finding. - "confidence": "A String", # The confidence in detection of this workload. - "detectedRelevantHardware": True or False, # A boolean flag set to true if associated hardware strongly predicts the workload type. - "detectedRelevantKeywords": True or False, # A boolean flag set to true if associated keywords strongly predict the workload type. - "detectedRelevantPackages": True or False, # A boolean flag set to true if installed packages strongly predict the workload type. - "workloadType": "A String", # The type of workload. - }, - "disk": { # Contains information about the disk associated with the finding. # Disk associated with the finding. - "name": "A String", # The name of the disk, for example, "https://www.googleapis.com/compute/v1/projects/{project-id}/zones/{zone-id}/disks/{disk-id}". - }, - "eventTime": "A String", # The time the finding was first detected. If an existing finding is updated, then this is the time the update occurred. For example, if the finding represents an open firewall, this property captures the time the detector believes the firewall became open. The accuracy is determined by the detector. If the finding is later resolved, then this time reflects when the finding was resolved. This must not be set to a value greater than the current timestamp. - "exfiltration": { # Exfiltration represents a data exfiltration attempt from one or more sources to one or more targets. The `sources` attribute lists the sources of the exfiltrated data. The `targets` attribute lists the destinations the data was copied to. # Represents exfiltrations associated with the finding. - "sources": [ # If there are multiple sources, then the data is considered "joined" between them. For instance, BigQuery can join multiple tables, and each table would be considered a source. - { # Resource where data was exfiltrated from or exfiltrated to. - "components": [ # Subcomponents of the asset that was exfiltrated, like URIs used during exfiltration, table names, databases, and filenames. For example, multiple tables might have been exfiltrated from the same Cloud SQL instance, or multiple files might have been exfiltrated from the same Cloud Storage bucket. + "name": "A String", + "query": "A String", + "userName": "A String", + "version": "A String", + }, + "description": "A String", + "discoveredWorkload": { + "confidence": "A String", + "detectedRelevantHardware": True or False, + "detectedRelevantKeywords": True or False, + "detectedRelevantPackages": True or False, + "workloadType": "A String", + }, + "disk": { + "name": "A String", + }, + "eventTime": "A String", + "exfiltration": { + "sources": [ + { + "components": [ "A String", ], - "name": "A String", # The resource's [full resource name](https://cloud.google.com/apis/design/resource_names#full_resource_name). + "name": "A String", }, ], - "targets": [ # If there are multiple targets, each target would get a complete copy of the "joined" source data. - { # Resource where data was exfiltrated from or exfiltrated to. - "components": [ # Subcomponents of the asset that was exfiltrated, like URIs used during exfiltration, table names, databases, and filenames. For example, multiple tables might have been exfiltrated from the same Cloud SQL instance, or multiple files might have been exfiltrated from the same Cloud Storage bucket. + "targets": [ + { + "components": [ "A String", ], - "name": "A String", # The resource's [full resource name](https://cloud.google.com/apis/design/resource_names#full_resource_name). - }, - ], - "totalExfiltratedBytes": "A String", # Total exfiltrated bytes processed for the entire job. - }, - "externalExposure": { # Details about the externally exposed resource associated with the finding. # External exposure associated with the finding. - "backendBucket": "A String", # The full resource name of the load balancer backend bucket, for example, "//compute.googleapis.com/projects/{project-id}/global/backendBuckets/{name}" - "backendService": "A String", # The full resource name of load balancer backend service, for example, "//compute.googleapis.com/projects/{project-id}/global/backendServices/{name}". - "exposedApplication": "A String", # The name and version of the exposed web application, for example, "Jenkins 2.184". - "exposedEndpoint": "A String", # The resource which is running the exposed service, for example, "//compute.googleapis.com/projects/{project-id}/zones/{zone}/instances/{instance}.” - "exposedService": "A String", # The name and version of the service, for example, "Jupyter Notebook 6.14.0". - "forwardingRule": "A String", # The full resource name of the forwarding rule, for example, "//compute.googleapis.com/projects/{project-id}/global/forwardingRules/{forwarding-rule-name}". - "hostnameUri": "A String", # Hostname of the exposed application, for example, "https://test-app.a.run.app/" - "httpResponse": [ # The http response returned by the web application. - { # The http response returned by the web application. - "path": "A String", # The http path for which response code was returned by web application, for example, "https://test-app.a.run.app/test". - "statusCode": "A String", # The http response code returned by the web application, for example, 200. - }, - ], - "instanceGroup": "A String", # The full resource name of the instance group, for example, "//compute.googleapis.com/projects/{project-id}/global/instanceGroups/{name}". - "internalBackendService": "A String", # The full resource name of load balancer backend service in the internal project having resource exposed via PSC, for example, "//compute.googleapis.com/projects/{project-id}/global/backendServices/{name}". - "loadBalancerFirewallPolicy": "A String", # The full resource name of the load balancer firewall policy, for example, "//compute.googleapis.com/projects/{project-id}/global/firewallPolicies/{policy-name}". - "networkEndpointGroup": "A String", # The full resource name of the network endpoint group, for example, "//compute.googleapis.com/projects/{project-id}/global/networkEndpointGroups/{name}". - "networkIngressFirewallPolicy": "A String", # The full resource name of the network ingress firewall policy, for example, "//compute.googleapis.com/projects/{project-id}/global/firewallPolicies/{name}". - "privateIpAddress": "A String", # Private IP address of the exposed endpoint. - "privatePort": "A String", # Port number associated with private IP address. - "pscNetworkAttachment": "A String", # The full resource name of the PSC (Private Service Connect) network attachment that network interface controller is attached to, for example, "//compute.googleapis.com/projects/{project-id}/regions/{region}/networkAttachments/{name}" - "pscServiceAttachment": "A String", # The full resource name of the PSC (Private Service Connect) service attachment that the load balancer network endpoint group targets, for example, "//compute.googleapis.com/projects/{project-id}/regions/{region}/serviceAttachments/{name}" - "publicIpAddress": "A String", # Public IP address of the exposed endpoint. - "publicPort": "A String", # Public port number of the exposed endpoint. - "serviceFirewallPolicy": "A String", # The full resource name of the firewall policy of the exposed service, for example, "//compute.googleapis.com/projects/{project-id}/global/firewallPolicies/{policy-name}". - }, - "externalSystems": { # Output only. Third party SIEM/SOAR fields within SCC, contains external system information and external system finding fields. - "a_key": { # Representation of third party SIEM/SOAR fields within SCC. - "assignees": [ # References primary/secondary etc assignees in the external system. + "name": "A String", + }, + ], + "totalExfiltratedBytes": "A String", + }, + "externalExposure": { + "backendBucket": "A String", + "backendService": "A String", + "exposedApplication": "A String", + "exposedEndpoint": "A String", + "exposedService": "A String", + "forwardingRule": "A String", + "hostnameUri": "A String", + "httpResponse": [ + { + "path": "A String", + "statusCode": "A String", + }, + ], + "instanceGroup": "A String", + "internalBackendService": "A String", + "loadBalancerFirewallPolicy": "A String", + "networkEndpointGroup": "A String", + "networkIngressFirewallPolicy": "A String", + "privateIpAddress": "A String", + "privatePort": "A String", + "pscNetworkAttachment": "A String", + "pscServiceAttachment": "A String", + "publicIpAddress": "A String", + "publicPort": "A String", + "serviceFirewallPolicy": "A String", + }, + "externalSystems": { + "a_key": { + "assignees": [ "A String", ], - "caseCloseTime": "A String", # The time when the case was closed, as reported by the external system. - "caseCreateTime": "A String", # The time when the case was created, as reported by the external system. - "casePriority": "A String", # The priority of the finding's corresponding case in the external system. - "caseSla": "A String", # The SLA of the finding's corresponding case in the external system. - "caseUri": "A String", # The link to the finding's corresponding case in the external system. - "externalSystemUpdateTime": "A String", # The time when the case was last updated, as reported by the external system. - "externalUid": "A String", # The identifier that's used to track the finding's corresponding case in the external system. - "name": "A String", # Full resource name of the external system, for example: "organizations/1234/sources/5678/findings/123456/externalSystems/jira", "folders/1234/sources/5678/findings/123456/externalSystems/jira", "projects/1234/sources/5678/findings/123456/externalSystems/jira" - "status": "A String", # The most recent status of the finding's corresponding case, as reported by the external system. - "ticketInfo": { # Information about the ticket, if any, that is being used to track the resolution of the issue that is identified by this finding. # Information about the ticket, if any, that is being used to track the resolution of the issue that is identified by this finding. - "assignee": "A String", # The assignee of the ticket in the ticket system. - "description": "A String", # The description of the ticket in the ticket system. - "id": "A String", # The identifier of the ticket in the ticket system. - "status": "A String", # The latest status of the ticket, as reported by the ticket system. - "updateTime": "A String", # The time when the ticket was last updated, as reported by the ticket system. - "uri": "A String", # The link to the ticket in the ticket system. - }, - }, - }, - "externalUri": "A String", # The URI that, if available, points to a web page outside of Security Command Center where additional information about the finding can be found. This field is guaranteed to be either empty or a well formed URL. - "files": [ # File associated with the finding. - { # File information about the related binary/library used by an executable, or the script used by a script interpreter - "contents": "A String", # Prefix of the file contents as a JSON-encoded string. - "diskPath": { # Path of the file in terms of underlying disk/partition identifiers. # Path of the file in terms of underlying disk/partition identifiers. - "partitionUuid": "A String", # UUID of the partition (format https://wiki.archlinux.org/title/persistent_block_device_naming#by-uuid) - "relativePath": "A String", # Relative path of the file in the partition as a JSON encoded string. Example: /home/user1/executable_file.sh - }, - "fileLoadState": "A String", # The load state of the file. - "hashedSize": "A String", # The length in bytes of the file prefix that was hashed. If hashed_size == size, any hashes reported represent the entire file. - "operations": [ # Operation(s) performed on a file. - { # Operation(s) performed on a file. - "type": "A String", # The type of the operation + "caseCloseTime": "A String", + "caseCreateTime": "A String", + "casePriority": "A String", + "caseSla": "A String", + "caseUri": "A String", + "externalSystemUpdateTime": "A String", + "externalUid": "A String", + "name": "A String", + "status": "A String", + "ticketInfo": { + "assignee": "A String", + "description": "A String", + "id": "A String", + "status": "A String", + "updateTime": "A String", + "uri": "A String", + }, + }, + }, + "externalUri": "A String", + "files": [ + { + "contents": "A String", + "diskPath": { + "partitionUuid": "A String", + "relativePath": "A String", + }, + "fileLoadState": "A String", + "hashedSize": "A String", + "operations": [ + { + "type": "A String", }, ], - "partiallyHashed": True or False, # True when the hash covers only a prefix of the file. - "path": "A String", # Absolute path of the file as a JSON encoded string. - "sha256": "A String", # SHA256 hash of the first hashed_size bytes of the file encoded as a hex string. If hashed_size == size, sha256 represents the SHA256 hash of the entire file. - "size": "A String", # Size of the file in bytes. + "partiallyHashed": True or False, + "path": "A String", + "sha256": "A String", + "size": "A String", }, ], - "findingClass": "A String", # The class of the finding. - "groupMemberships": [ # Contains details about groups of which this finding is a member. A group is a collection of findings that are related in some way. This field cannot be updated. Its value is ignored in all update requests. - { # Contains details about groups of which this finding is a member. A group is a collection of findings that are related in some way. - "groupId": "A String", # ID of the group. - "groupType": "A String", # Type of group. + "findingClass": "A String", + "groupMemberships": [ + { + "groupId": "A String", + "groupType": "A String", }, ], - "iamBindings": [ # Represents IAM bindings associated with the finding. - { # Represents a particular IAM binding, which captures a member's role addition, removal, or state. - "action": "A String", # The action that was performed on a Binding. - "member": "A String", # A single identity requesting access for a Cloud Platform resource, for example, "foo@google.com". - "role": "A String", # Role that is assigned to "members". For example, "roles/viewer", "roles/editor", or "roles/owner". + "iamBindings": [ + { + "action": "A String", + "member": "A String", + "role": "A String", }, ], - "indicator": { # Represents what's commonly known as an _indicator of compromise_ (IoC) in computer forensics. This is an artifact observed on a network or in an operating system that, with high confidence, indicates a computer intrusion. For more information, see [Indicator of compromise](https://en.wikipedia.org/wiki/Indicator_of_compromise). # Represents what's commonly known as an *indicator of compromise* (IoC) in computer forensics. This is an artifact observed on a network or in an operating system that, with high confidence, indicates a computer intrusion. For more information, see [Indicator of compromise](https://en.wikipedia.org/wiki/Indicator_of_compromise). - "domains": [ # List of domains associated to the Finding. + "indicator": { + "domains": [ "A String", ], - "ipAddresses": [ # The list of IP addresses that are associated with the finding. + "ipAddresses": [ "A String", ], - "signatures": [ # The list of matched signatures indicating that the given process is present in the environment. - { # Indicates what signature matched this process. - "memoryHashSignature": { # A signature corresponding to memory page hashes. # Signature indicating that a binary family was matched. - "binaryFamily": "A String", # The binary family. - "detections": [ # The list of memory hash detections contributing to the binary family match. - { # Memory hash detection contributing to the binary family match. - "binary": "A String", # The name of the binary associated with the memory hash signature detection. - "percentPagesMatched": 3.14, # The percentage of memory page hashes in the signature that were matched. + "signatures": [ + { + "memoryHashSignature": { + "binaryFamily": "A String", + "detections": [ + { + "binary": "A String", + "percentPagesMatched": 3.14, }, ], }, - "signatureType": "A String", # Describes the type of resource associated with the signature. - "yaraRuleSignature": { # A signature corresponding to a YARA rule. # Signature indicating that a YARA rule was matched. - "yaraRule": "A String", # The name of the YARA rule. + "signatureType": "A String", + "yaraRuleSignature": { + "yaraRule": "A String", }, }, ], - "uris": [ # The list of URIs associated to the Findings. + "uris": [ "A String", ], }, - "ipRules": { # IP rules associated with the finding. # IP rules associated with the finding. - "allowed": { # Allowed IP rule. # Tuple with allowed rules. - "ipRules": [ # Optional. Optional list of allowed IP rules. - { # IP rule information. - "portRanges": [ # Optional. An optional list of ports to which this rule applies. This field is only applicable for the UDP or (S)TCP protocols. Each entry must be either an integer or a range including a min and max port number. - { # A port range which is inclusive of the min and max values. Values are between 0 and 2^16-1. The max can be equal / must be not smaller than the min value. If min and max are equal this indicates that it is a single port. - "max": "A String", # Maximum port value. - "min": "A String", # Minimum port value. + "ipRules": { + "allowed": { + "ipRules": [ + { + "portRanges": [ + { + "max": "A String", + "min": "A String", }, ], - "protocol": "A String", # The IP protocol this rule applies to. This value can either be one of the following well known protocol strings (TCP, UDP, ICMP, ESP, AH, IPIP, SCTP) or a string representation of the integer value. + "protocol": "A String", }, ], }, - "denied": { # Denied IP rule. # Tuple with denied rules. - "ipRules": [ # Optional. Optional list of denied IP rules. - { # IP rule information. - "portRanges": [ # Optional. An optional list of ports to which this rule applies. This field is only applicable for the UDP or (S)TCP protocols. Each entry must be either an integer or a range including a min and max port number. - { # A port range which is inclusive of the min and max values. Values are between 0 and 2^16-1. The max can be equal / must be not smaller than the min value. If min and max are equal this indicates that it is a single port. - "max": "A String", # Maximum port value. - "min": "A String", # Minimum port value. + "denied": { + "ipRules": [ + { + "portRanges": [ + { + "max": "A String", + "min": "A String", }, ], - "protocol": "A String", # The IP protocol this rule applies to. This value can either be one of the following well known protocol strings (TCP, UDP, ICMP, ESP, AH, IPIP, SCTP) or a string representation of the integer value. + "protocol": "A String", }, ], }, - "destinationIpRanges": [ # If destination IP ranges are specified, the firewall rule applies only to traffic that has a destination IP address in these ranges. These ranges must be expressed in CIDR format. Only supports IPv4. + "destinationIpRanges": [ "A String", ], - "direction": "A String", # The direction that the rule is applicable to, one of ingress or egress. - "exposedServices": [ # Name of the network protocol service, such as FTP, that is exposed by the open port. Follows the naming convention available at: https://www.iana.org/assignments/service-names-port-numbers/service-names-port-numbers.xhtml. + "direction": "A String", + "exposedServices": [ "A String", ], - "sourceIpRanges": [ # If source IP ranges are specified, the firewall rule applies only to traffic that has a source IP address in these ranges. These ranges must be expressed in CIDR format. Only supports IPv4. + "sourceIpRanges": [ "A String", ], }, - "job": { # Describes a job # Job associated with the finding. - "errorCode": 42, # Optional. If the job did not complete successfully, this field describes why. - "location": "A String", # Optional. Gives the location where the job ran, such as `US` or `europe-west1` - "name": "A String", # The fully-qualified name for a job. e.g. `projects//jobs/` - "state": "A String", # Output only. State of the job, such as `RUNNING` or `PENDING`. - }, - "kernelRootkit": { # Kernel mode rootkit signatures. # Signature of the kernel rootkit. - "name": "A String", # Rootkit name, when available. - "unexpectedCodeModification": True or False, # True if unexpected modifications of kernel code memory are present. - "unexpectedFtraceHandler": True or False, # True if `ftrace` points are present with callbacks pointing to regions that are not in the expected kernel or module code range. - "unexpectedInterruptHandler": True or False, # True if interrupt handlers that are are not in the expected kernel or module code regions are present. - "unexpectedKernelCodePages": True or False, # True if kernel code pages that are not in the expected kernel or module code regions are present. - "unexpectedKprobeHandler": True or False, # True if `kprobe` points are present with callbacks pointing to regions that are not in the expected kernel or module code range. - "unexpectedProcessesInRunqueue": True or False, # True if unexpected processes in the scheduler run queue are present. Such processes are in the run queue, but not in the process task list. - "unexpectedReadOnlyDataModification": True or False, # True if unexpected modifications of kernel read-only data memory are present. - "unexpectedSystemCallHandler": True or False, # True if system call handlers that are are not in the expected kernel or module code regions are present. - }, - "kubernetes": { # Kubernetes-related attributes. # Kubernetes resources associated with the finding. - "accessReviews": [ # Provides information on any Kubernetes access reviews (privilege checks) relevant to the finding. - { # Conveys information about a Kubernetes access review (such as one returned by a [`kubectl auth can-i`](https://kubernetes.io/docs/reference/access-authn-authz/authorization/#checking-api-access) command) that was involved in a finding. - "group": "A String", # The API group of the resource. "*" means all. - "name": "A String", # The name of the resource being requested. Empty means all. - "ns": "A String", # Namespace of the action being requested. Currently, there is no distinction between no namespace and all namespaces. Both are represented by "" (empty). - "resource": "A String", # The optional resource type requested. "*" means all. - "subresource": "A String", # The optional subresource type. - "verb": "A String", # A Kubernetes resource API verb, like get, list, watch, create, update, delete, proxy. "*" means all. - "version": "A String", # The API version of the resource. "*" means all. - }, - ], - "bindings": [ # Provides Kubernetes role binding information for findings that involve [RoleBindings or ClusterRoleBindings](https://cloud.google.com/kubernetes-engine/docs/how-to/role-based-access-control). - { # Represents a Kubernetes RoleBinding or ClusterRoleBinding. - "name": "A String", # Name for the binding. - "ns": "A String", # Namespace for the binding. - "role": { # Kubernetes Role or ClusterRole. # The Role or ClusterRole referenced by the binding. - "kind": "A String", # Role type. - "name": "A String", # Role name. - "ns": "A String", # Role namespace. + "job": { + "errorCode": 42, + "location": "A String", + "name": "A String", + "state": "A String", + }, + "kernelRootkit": { + "name": "A String", + "unexpectedCodeModification": True or False, + "unexpectedFtraceHandler": True or False, + "unexpectedInterruptHandler": True or False, + "unexpectedKernelCodePages": True or False, + "unexpectedKprobeHandler": True or False, + "unexpectedProcessesInRunqueue": True or False, + "unexpectedReadOnlyDataModification": True or False, + "unexpectedSystemCallHandler": True or False, + }, + "kubernetes": { + "accessReviews": [ + { + "group": "A String", + "name": "A String", + "ns": "A String", + "resource": "A String", + "subresource": "A String", + "verb": "A String", + "version": "A String", + }, + ], + "bindings": [ + { + "name": "A String", + "ns": "A String", + "role": { + "kind": "A String", + "name": "A String", + "ns": "A String", }, - "subjects": [ # Represents one or more subjects that are bound to the role. Not always available for PATCH requests. - { # Represents a Kubernetes subject. - "kind": "A String", # Authentication type for the subject. - "name": "A String", # Name for the subject. - "ns": "A String", # Namespace for the subject. + "subjects": [ + { + "kind": "A String", + "name": "A String", + "ns": "A String", }, ], }, ], - "nodePools": [ # GKE [node pools](https://cloud.google.com/kubernetes-engine/docs/concepts/node-pools) associated with the finding. This field contains node pool information for each node, when it is available. - { # Provides GKE node pool information. - "name": "A String", # Kubernetes node pool name. - "nodes": [ # Nodes associated with the finding. - { # Kubernetes nodes associated with the finding. - "name": "A String", # [Full resource name](https://google.aip.dev/122#full-resource-names) of the Compute Engine VM running the cluster node. + "nodePools": [ + { + "name": "A String", + "nodes": [ + { + "name": "A String", }, ], }, ], - "nodes": [ # Provides Kubernetes [node](https://cloud.google.com/kubernetes-engine/docs/concepts/cluster-architecture#nodes) information. - { # Kubernetes nodes associated with the finding. - "name": "A String", # [Full resource name](https://google.aip.dev/122#full-resource-names) of the Compute Engine VM running the cluster node. + "nodes": [ + { + "name": "A String", }, ], - "objects": [ # Kubernetes objects related to the finding. - { # Kubernetes object related to the finding, uniquely identified by GKNN. Used if the object Kind is not one of Pod, Node, NodePool, Binding, or AccessReview. - "containers": [ # Pod containers associated with this finding, if any. - { # Container associated with the finding. - "createTime": "A String", # The time that the container was created. - "imageId": "A String", # Optional container image ID, if provided by the container runtime. Uniquely identifies the container image launched using a container image digest. - "labels": [ # Container labels, as provided by the container runtime. - { # Represents a generic name-value label. A label has separate name and value fields to support filtering with the `contains()` function. For more information, see [Filtering on array-type fields](https://cloud.google.com/security-command-center/docs/how-to-api-list-findings#array-contains-filtering). - "name": "A String", # Name of the label. - "value": "A String", # Value that corresponds to the label's name. + "objects": [ + { + "containers": [ + { + "createTime": "A String", + "imageId": "A String", + "labels": [ + { + "name": "A String", + "value": "A String", }, ], - "name": "A String", # Name of the container. - "uri": "A String", # Container image URI provided when configuring a pod or container. This string can identify a container image version using mutable tags. + "name": "A String", + "uri": "A String", }, ], - "group": "A String", # Kubernetes object group, such as "policy.k8s.io/v1". - "kind": "A String", # Kubernetes object kind, such as "Namespace". - "name": "A String", # Kubernetes object name. For details see https://kubernetes.io/docs/concepts/overview/working-with-objects/names/. - "ns": "A String", # Kubernetes object namespace. Must be a valid DNS label. Named "ns" to avoid collision with C++ namespace keyword. For details see https://kubernetes.io/docs/tasks/administer-cluster/namespaces/. - }, - ], - "pods": [ # Kubernetes [Pods](https://cloud.google.com/kubernetes-engine/docs/concepts/pod) associated with the finding. This field contains Pod records for each container that is owned by a Pod. - { # A Kubernetes Pod. - "containers": [ # Pod containers associated with this finding, if any. - { # Container associated with the finding. - "createTime": "A String", # The time that the container was created. - "imageId": "A String", # Optional container image ID, if provided by the container runtime. Uniquely identifies the container image launched using a container image digest. - "labels": [ # Container labels, as provided by the container runtime. - { # Represents a generic name-value label. A label has separate name and value fields to support filtering with the `contains()` function. For more information, see [Filtering on array-type fields](https://cloud.google.com/security-command-center/docs/how-to-api-list-findings#array-contains-filtering). - "name": "A String", # Name of the label. - "value": "A String", # Value that corresponds to the label's name. + "group": "A String", + "kind": "A String", + "name": "A String", + "ns": "A String", + }, + ], + "pods": [ + { + "containers": [ + { + "createTime": "A String", + "imageId": "A String", + "labels": [ + { + "name": "A String", + "value": "A String", }, ], - "name": "A String", # Name of the container. - "uri": "A String", # Container image URI provided when configuring a pod or container. This string can identify a container image version using mutable tags. + "name": "A String", + "uri": "A String", }, ], - "labels": [ # Pod labels. For Kubernetes containers, these are applied to the container. - { # Represents a generic name-value label. A label has separate name and value fields to support filtering with the `contains()` function. For more information, see [Filtering on array-type fields](https://cloud.google.com/security-command-center/docs/how-to-api-list-findings#array-contains-filtering). - "name": "A String", # Name of the label. - "value": "A String", # Value that corresponds to the label's name. + "labels": [ + { + "name": "A String", + "value": "A String", }, ], - "name": "A String", # Kubernetes Pod name. - "ns": "A String", # Kubernetes Pod namespace. + "name": "A String", + "ns": "A String", }, ], - "roles": [ # Provides Kubernetes role information for findings that involve [Roles or ClusterRoles](https://cloud.google.com/kubernetes-engine/docs/how-to/role-based-access-control). - { # Kubernetes Role or ClusterRole. - "kind": "A String", # Role type. - "name": "A String", # Role name. - "ns": "A String", # Role namespace. + "roles": [ + { + "kind": "A String", + "name": "A String", + "ns": "A String", }, ], }, - "loadBalancers": [ # The load balancers associated with the finding. - { # Contains information related to the load balancer associated with the finding. - "name": "A String", # The name of the load balancer associated with the finding. + "loadBalancers": [ + { + "name": "A String", }, ], - "logEntries": [ # Log entries that are relevant to the finding. - { # An individual entry in a log. - "cloudLoggingEntry": { # Metadata taken from a [Cloud Logging LogEntry](https://cloud.google.com/logging/docs/reference/v2/rest/v2/LogEntry) # An individual entry in a log stored in Cloud Logging. - "insertId": "A String", # A unique identifier for the log entry. - "logId": "A String", # The type of the log (part of `log_name`. `log_name` is the resource name of the log to which this log entry belongs). For example: `cloudresourcemanager.googleapis.com/activity`. Note that this field is not URL-encoded, unlike the `LOG_ID` field in `LogEntry`. - "resourceContainer": "A String", # The organization, folder, or project of the monitored resource that produced this log entry. - "timestamp": "A String", # The time the event described by the log entry occurred. + "logEntries": [ + { + "cloudLoggingEntry": { + "insertId": "A String", + "logId": "A String", + "resourceContainer": "A String", + "timestamp": "A String", }, }, ], - "mitreAttack": { # MITRE ATT&CK tactics and techniques related to this finding. See: https://attack.mitre.org # MITRE ATT&CK tactics and techniques related to this finding. See: https://attack.mitre.org - "additionalTactics": [ # Additional MITRE ATT&CK tactics related to this finding, if any. + "mitreAttack": { + "additionalTactics": [ "A String", ], - "additionalTechniques": [ # Additional MITRE ATT&CK techniques related to this finding, if any, along with any of their respective parent techniques. + "additionalTechniques": [ "A String", ], - "primaryTactic": "A String", # The MITRE ATT&CK tactic most closely represented by this finding, if any. - "primaryTechniques": [ # The MITRE ATT&CK technique most closely represented by this finding, if any. primary_techniques is a repeated field because there are multiple levels of MITRE ATT&CK techniques. If the technique most closely represented by this finding is a sub-technique (e.g. `SCANNING_IP_BLOCKS`), both the sub-technique and its parent technique(s) will be listed (e.g. `SCANNING_IP_BLOCKS`, `ACTIVE_SCANNING`). + "primaryTactic": "A String", + "primaryTechniques": [ "A String", ], - "version": "A String", # The MITRE ATT&CK version referenced by the above fields. E.g. "8". + "version": "A String", }, - "moduleName": "A String", # Unique identifier of the module which generated the finding. Example: folders/598186756061/securityHealthAnalyticsSettings/customModules/56799441161885 - "mute": "A String", # Indicates the mute state of a finding (either muted, unmuted or undefined). Unlike other attributes of a finding, a finding provider shouldn't set the value of mute. - "muteInfo": { # Mute information about the finding, including whether the finding has a static mute or any matching dynamic mute rules. # Output only. The mute information regarding this finding. - "dynamicMuteRecords": [ # The list of dynamic mute rules that currently match the finding. - { # The record of a dynamic mute rule that matches the finding. - "matchTime": "A String", # When the dynamic mute rule first matched the finding. - "muteConfig": "A String", # The relative resource name of the mute rule, represented by a mute config, that created this record, for example `organizations/123/muteConfigs/mymuteconfig` or `organizations/123/locations/global/muteConfigs/mymuteconfig`. + "moduleName": "A String", + "mute": "A String", + "muteInfo": { + "dynamicMuteRecords": [ + { + "matchTime": "A String", + "muteConfig": "A String", }, ], - "staticMute": { # Information about the static mute state. A static mute state overrides any dynamic mute rules that apply to this finding. The static mute state can be set by a static mute rule or by muting the finding directly. # If set, the static mute applied to this finding. Static mutes override dynamic mutes. If unset, there is no static mute. - "applyTime": "A String", # When the static mute was applied. - "state": "A String", # The static mute state. If the value is `MUTED` or `UNMUTED`, then the finding's overall mute state will have the same value. + "staticMute": { + "applyTime": "A String", + "state": "A String", }, }, - "muteInitiator": "A String", # Records additional information about the mute operation, for example, the [mute configuration](/security-command-center/docs/how-to-mute-findings) that muted the finding and the user who muted the finding. - "muteUpdateTime": "A String", # Output only. The most recent time this finding was muted or unmuted. - "name": "A String", # The [relative resource name](https://cloud.google.com/apis/design/resource_names#relative_resource_name) of the finding. Example: "organizations/{organization_id}/sources/{source_id}/findings/{finding_id}", "folders/{folder_id}/sources/{source_id}/findings/{finding_id}", "projects/{project_id}/sources/{source_id}/findings/{finding_id}". - "networks": [ # Represents the VPC networks that the resource is attached to. - { # Contains information about a VPC network associated with the finding. - "name": "A String", # The name of the VPC network resource, for example, `//compute.googleapis.com/projects/my-project/global/networks/my-network`. + "muteInitiator": "A String", + "muteUpdateTime": "A String", + "name": "A String", + "networks": [ + { + "name": "A String", }, ], - "nextSteps": "A String", # Steps to address the finding. - "notebook": { # Represents a Jupyter notebook IPYNB file, such as a [Colab Enterprise notebook](https://cloud.google.com/colab/docs/introduction) file, that is associated with a finding. # Notebook associated with the finding. - "lastAuthor": "A String", # The user ID of the latest author to modify the notebook. - "name": "A String", # The name of the notebook. - "notebookUpdateTime": "A String", # The most recent time the notebook was updated. - "service": "A String", # The source notebook service, for example, "Colab Enterprise". + "nextSteps": "A String", + "notebook": { + "lastAuthor": "A String", + "name": "A String", + "notebookUpdateTime": "A String", + "service": "A String", }, - "orgPolicies": [ # Contains information about the org policies associated with the finding. - { # Contains information about the org policies associated with the finding. - "name": "A String", # The resource name of the org policy. Example: "organizations/{organization_id}/policies/{constraint_name}" + "orgPolicies": [ + { + "name": "A String", }, ], - "parent": "A String", # The relative resource name of the source the finding belongs to. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name This field is immutable after creation time. For example: "organizations/{organization_id}/sources/{source_id}" - "parentDisplayName": "A String", # Output only. The human readable display name of the finding source such as "Event Threat Detection" or "Security Health Analytics". - "policyViolationSummary": { # Metadata summarizing policy violations of child resources of the affected resource. `finding_category` and `resource` determine the exact semantics of the counts. For example, when category=DATA_SECURITY_POSTURE_OBJECT_PUBLIC_ACCESS_VIOLATION and resource='storage.googleapis.com/buckets/my-bucket-name' then this counts the number of Cloud Storage objects in my-bucket-name which violate a Public Access control. # PolicyViolationSummary associated with the finding. - "conformantResourcesCount": "A String", # Total number of child resources that conform to the policy. - "evaluationErrorsCount": "A String", # Number of child resources for which errors during evaluation occurred. The evaluation result for these child resources is effectively "unknown". - "outOfScopeResourcesCount": "A String", # Total count of child resources which were not in scope for evaluation. - "policyViolationsCount": "A String", # Count of child resources in violation of the policy. - }, - "processes": [ # Represents operating system processes associated with the Finding. - { # Represents an operating system process. - "args": [ # Process arguments as JSON encoded strings. + "parent": "A String", + "parentDisplayName": "A String", + "policyViolationSummary": { + "conformantResourcesCount": "A String", + "evaluationErrorsCount": "A String", + "outOfScopeResourcesCount": "A String", + "policyViolationsCount": "A String", + }, + "processes": [ + { + "args": [ "A String", ], - "argumentsTruncated": True or False, # True if `args` is incomplete. - "binary": { # File information about the related binary/library used by an executable, or the script used by a script interpreter # File information for the process executable. - "contents": "A String", # Prefix of the file contents as a JSON-encoded string. - "diskPath": { # Path of the file in terms of underlying disk/partition identifiers. # Path of the file in terms of underlying disk/partition identifiers. - "partitionUuid": "A String", # UUID of the partition (format https://wiki.archlinux.org/title/persistent_block_device_naming#by-uuid) - "relativePath": "A String", # Relative path of the file in the partition as a JSON encoded string. Example: /home/user1/executable_file.sh + "argumentsTruncated": True or False, + "binary": { + "contents": "A String", + "diskPath": { + "partitionUuid": "A String", + "relativePath": "A String", }, - "fileLoadState": "A String", # The load state of the file. - "hashedSize": "A String", # The length in bytes of the file prefix that was hashed. If hashed_size == size, any hashes reported represent the entire file. - "operations": [ # Operation(s) performed on a file. - { # Operation(s) performed on a file. - "type": "A String", # The type of the operation + "fileLoadState": "A String", + "hashedSize": "A String", + "operations": [ + { + "type": "A String", }, ], - "partiallyHashed": True or False, # True when the hash covers only a prefix of the file. - "path": "A String", # Absolute path of the file as a JSON encoded string. - "sha256": "A String", # SHA256 hash of the first hashed_size bytes of the file encoded as a hex string. If hashed_size == size, sha256 represents the SHA256 hash of the entire file. - "size": "A String", # Size of the file in bytes. - }, - "envVariables": [ # Process environment variables. - { # A name-value pair representing an environment variable used in an operating system process. - "name": "A String", # Environment variable name as a JSON encoded string. - "val": "A String", # Environment variable value as a JSON encoded string. + "partiallyHashed": True or False, + "path": "A String", + "sha256": "A String", + "size": "A String", + }, + "envVariables": [ + { + "name": "A String", + "val": "A String", }, ], - "envVariablesTruncated": True or False, # True if `env_variables` is incomplete. - "libraries": [ # File information for libraries loaded by the process. - { # File information about the related binary/library used by an executable, or the script used by a script interpreter - "contents": "A String", # Prefix of the file contents as a JSON-encoded string. - "diskPath": { # Path of the file in terms of underlying disk/partition identifiers. # Path of the file in terms of underlying disk/partition identifiers. - "partitionUuid": "A String", # UUID of the partition (format https://wiki.archlinux.org/title/persistent_block_device_naming#by-uuid) - "relativePath": "A String", # Relative path of the file in the partition as a JSON encoded string. Example: /home/user1/executable_file.sh + "envVariablesTruncated": True or False, + "libraries": [ + { + "contents": "A String", + "diskPath": { + "partitionUuid": "A String", + "relativePath": "A String", }, - "fileLoadState": "A String", # The load state of the file. - "hashedSize": "A String", # The length in bytes of the file prefix that was hashed. If hashed_size == size, any hashes reported represent the entire file. - "operations": [ # Operation(s) performed on a file. - { # Operation(s) performed on a file. - "type": "A String", # The type of the operation + "fileLoadState": "A String", + "hashedSize": "A String", + "operations": [ + { + "type": "A String", }, ], - "partiallyHashed": True or False, # True when the hash covers only a prefix of the file. - "path": "A String", # Absolute path of the file as a JSON encoded string. - "sha256": "A String", # SHA256 hash of the first hashed_size bytes of the file encoded as a hex string. If hashed_size == size, sha256 represents the SHA256 hash of the entire file. - "size": "A String", # Size of the file in bytes. + "partiallyHashed": True or False, + "path": "A String", + "sha256": "A String", + "size": "A String", }, ], - "name": "A String", # The process name, as displayed in utilities like `top` and `ps`. This name can be accessed through `/proc/[pid]/comm` and changed with `prctl(PR_SET_NAME)`. - "parentPid": "A String", # The parent process ID. - "pid": "A String", # The process ID. - "script": { # File information about the related binary/library used by an executable, or the script used by a script interpreter # When the process represents the invocation of a script, `binary` provides information about the interpreter, while `script` provides information about the script file provided to the interpreter. - "contents": "A String", # Prefix of the file contents as a JSON-encoded string. - "diskPath": { # Path of the file in terms of underlying disk/partition identifiers. # Path of the file in terms of underlying disk/partition identifiers. - "partitionUuid": "A String", # UUID of the partition (format https://wiki.archlinux.org/title/persistent_block_device_naming#by-uuid) - "relativePath": "A String", # Relative path of the file in the partition as a JSON encoded string. Example: /home/user1/executable_file.sh + "name": "A String", + "parentPid": "A String", + "pid": "A String", + "script": { + "contents": "A String", + "diskPath": { + "partitionUuid": "A String", + "relativePath": "A String", }, - "fileLoadState": "A String", # The load state of the file. - "hashedSize": "A String", # The length in bytes of the file prefix that was hashed. If hashed_size == size, any hashes reported represent the entire file. - "operations": [ # Operation(s) performed on a file. - { # Operation(s) performed on a file. - "type": "A String", # The type of the operation + "fileLoadState": "A String", + "hashedSize": "A String", + "operations": [ + { + "type": "A String", }, ], - "partiallyHashed": True or False, # True when the hash covers only a prefix of the file. - "path": "A String", # Absolute path of the file as a JSON encoded string. - "sha256": "A String", # SHA256 hash of the first hashed_size bytes of the file encoded as a hex string. If hashed_size == size, sha256 represents the SHA256 hash of the entire file. - "size": "A String", # Size of the file in bytes. + "partiallyHashed": True or False, + "path": "A String", + "sha256": "A String", + "size": "A String", }, - "userId": "A String", # The ID of the user that executed the process. E.g. If this is the root user this will always be 0. + "userId": "A String", }, ], - "resourceName": "A String", # For findings on Google Cloud resources, the full resource name of the Google Cloud resource this finding is for. See: https://cloud.google.com/apis/design/resource_names#full_resource_name When the finding is for a non-Google Cloud resource, the resourceName can be a customer or partner defined string. This field is immutable after creation time. - "secret": { # Details about a secret or credential associated with the finding. # Secret associated with the finding. - "environmentVariable": { # Environment variable containing the secret. # The environment variable containing the secret. - "key": "A String", # Environment variable name as a JSON encoded string. Note that value is not included since the value contains the secret data, which is sensitive core content. + "resourceName": "A String", + "secret": { + "environmentVariable": { + "key": "A String", }, - "filePath": { # File path containing the secret. # The file containing the secret. - "path": "A String", # Path to the file. + "filePath": { + "path": "A String", }, - "status": { # The status of the secret. # The status of the secret. - "lastUpdatedTime": "A String", # Time that the secret was found. - "validity": "A String", # The validity of the secret. + "status": { + "lastUpdatedTime": "A String", + "validity": "A String", }, - "type": "A String", # The type of secret, for example, GCP_API_KEY. + "type": "A String", }, - "securityMarks": { # User specified security marks that are attached to the parent Security Command Center resource. Security marks are scoped within a Security Command Center organization -- they can be modified and viewed by all users who have proper permissions on the organization. # Output only. User specified security marks. These marks are entirely managed by the user and come from the SecurityMarks resource that belongs to the finding. - "canonicalName": "A String", # The canonical name of the marks. Examples: "organizations/{organization_id}/assets/{asset_id}/securityMarks" "folders/{folder_id}/assets/{asset_id}/securityMarks" "projects/{project_number}/assets/{asset_id}/securityMarks" "organizations/{organization_id}/sources/{source_id}/findings/{finding_id}/securityMarks" "folders/{folder_id}/sources/{source_id}/findings/{finding_id}/securityMarks" "projects/{project_number}/sources/{source_id}/findings/{finding_id}/securityMarks" - "marks": { # Mutable user specified security marks belonging to the parent resource. Constraints are as follows: * Keys and values are treated as case insensitive * Keys must be between 1 - 256 characters (inclusive) * Keys must be letters, numbers, underscores, or dashes * Values have leading and trailing whitespace trimmed, remaining characters must be between 1 - 4096 characters (inclusive) + "securityMarks": { + "canonicalName": "A String", + "marks": { "a_key": "A String", }, - "name": "A String", # The relative resource name of the SecurityMarks. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Examples: "organizations/{organization_id}/assets/{asset_id}/securityMarks" "organizations/{organization_id}/sources/{source_id}/findings/{finding_id}/securityMarks". + "name": "A String", }, - "securityPosture": { # Represents a posture that is deployed on Google Cloud by the Security Command Center Posture Management service. A posture contains one or more policy sets. A policy set is a group of policies that enforce a set of security rules on Google Cloud. # The security posture associated with the finding. - "changedPolicy": "A String", # The name of the updated policy, for example, `projects/{project_id}/policies/{constraint_name}`. - "name": "A String", # Name of the posture, for example, `CIS-Posture`. - "policy": "A String", # The ID of the updated policy, for example, `compute-policy-1`. - "policyDriftDetails": [ # The details about a change in an updated policy that violates the deployed posture. - { # The policy field that violates the deployed posture and its expected and detected values. - "detectedValue": "A String", # The detected value that violates the deployed posture, for example, `false` or `allowed_values={"projects/22831892"}`. - "expectedValue": "A String", # The value of this field that was configured in a posture, for example, `true` or `allowed_values={"projects/29831892"}`. - "field": "A String", # The name of the updated field, for example constraint.implementation.policy_rules[0].enforce + "securityPosture": { + "changedPolicy": "A String", + "name": "A String", + "policy": "A String", + "policyDriftDetails": [ + { + "detectedValue": "A String", + "expectedValue": "A String", + "field": "A String", }, ], - "policySet": "A String", # The name of the updated policyset, for example, `cis-policyset`. - "postureDeployment": "A String", # The name of the posture deployment, for example, `organizations/{org_id}/posturedeployments/{posture_deployment_id}`. - "postureDeploymentResource": "A String", # The project, folder, or organization on which the posture is deployed, for example, `projects/{project_number}`. - "revisionId": "A String", # The version of the posture, for example, `c7cfa2a8`. + "policySet": "A String", + "postureDeployment": "A String", + "postureDeploymentResource": "A String", + "revisionId": "A String", }, - "severity": "A String", # The severity of the finding. This field is managed by the source that writes the finding. - "sourceProperties": { # Source specific properties. These properties are managed by the source that writes the finding. The key names in the source_properties map must be between 1 and 255 characters, and must start with a letter and contain alphanumeric characters or underscores only. + "severity": "A String", + "sourceProperties": { "a_key": "", }, - "state": "A String", # The state of the finding. - "toxicCombination": { # Contains details about a group of security issues that, when the issues occur together, represent a greater risk than when the issues occur independently. A group of such issues is referred to as a toxic combination. # Contains details about a group of security issues that, when the issues occur together, represent a greater risk than when the issues occur independently. A group of such issues is referred to as a toxic combination. This field cannot be updated. Its value is ignored in all update requests. - "attackExposureScore": 3.14, # The [Attack exposure score](https://cloud.google.com/security-command-center/docs/attack-exposure-learn#attack_exposure_scores) of this toxic combination. The score is a measure of how much this toxic combination exposes one or more high-value resources to potential attack. - "relatedFindings": [ # List of resource names of findings associated with this toxic combination. For example, `organizations/123/sources/456/findings/789`. + "state": "A String", + "toxicCombination": { + "attackExposureScore": 3.14, + "relatedFindings": [ "A String", ], }, - "vertexAi": { # Vertex AI-related information associated with the finding. # VertexAi associated with the finding. - "datasets": [ # Datasets associated with the finding. - { # Vertex AI dataset associated with the finding. - "displayName": "A String", # The user defined display name of dataset, e.g. plants-dataset - "name": "A String", # Resource name of the dataset, e.g. projects/{project}/locations/{location}/datasets/2094040236064505856 - "source": "A String", # Data source, such as BigQuery source URI, e.g. bq://scc-nexus-test.AIPPtest.gsod - }, - ], - "pipelines": [ # Pipelines associated with the finding. - { # Vertex AI training pipeline associated with the finding. - "displayName": "A String", # The user defined display name of pipeline, e.g. plants-classification - "name": "A String", # Resource name of the pipeline, e.g. projects/{project}/locations/{location}/trainingPipelines/5253428229225578496 - }, - ], - }, - "vulnerability": { # Refers to common vulnerability fields e.g. cve, cvss, cwe etc. # Represents vulnerability-specific fields like CVE and CVSS scores. CVE stands for Common Vulnerabilities and Exposures (https://cve.mitre.org/about/) - "cve": { # CVE stands for Common Vulnerabilities and Exposures. Information from the [CVE record](https://www.cve.org/ResourcesSupport/Glossary) that describes this vulnerability. # CVE stands for Common Vulnerabilities and Exposures (https://cve.mitre.org/about/) - "cvssv3": { # Common Vulnerability Scoring System version 3. # Describe Common Vulnerability Scoring System specified at https://www.first.org/cvss/v3.1/specification-document - "attackComplexity": "A String", # This metric describes the conditions beyond the attacker's control that must exist in order to exploit the vulnerability. - "attackVector": "A String", # Base Metrics Represents the intrinsic characteristics of a vulnerability that are constant over time and across user environments. This metric reflects the context by which vulnerability exploitation is possible. - "availabilityImpact": "A String", # This metric measures the impact to the availability of the impacted component resulting from a successfully exploited vulnerability. - "baseScore": 3.14, # The base score is a function of the base metric scores. - "confidentialityImpact": "A String", # This metric measures the impact to the confidentiality of the information resources managed by a software component due to a successfully exploited vulnerability. - "integrityImpact": "A String", # This metric measures the impact to integrity of a successfully exploited vulnerability. - "privilegesRequired": "A String", # This metric describes the level of privileges an attacker must possess before successfully exploiting the vulnerability. - "scope": "A String", # The Scope metric captures whether a vulnerability in one vulnerable component impacts resources in components beyond its security scope. - "userInteraction": "A String", # This metric captures the requirement for a human user, other than the attacker, to participate in the successful compromise of the vulnerable component. - }, - "exploitReleaseDate": "A String", # Date the first publicly available exploit or PoC was released. - "exploitationActivity": "A String", # The exploitation activity of the vulnerability in the wild. - "firstExploitationDate": "A String", # Date of the earliest known exploitation. - "id": "A String", # The unique identifier for the vulnerability. e.g. CVE-2021-34527 - "impact": "A String", # The potential impact of the vulnerability if it was to be exploited. - "observedInTheWild": True or False, # Whether or not the vulnerability has been observed in the wild. - "references": [ # Additional information about the CVE. e.g. https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2021-34527 - { # Additional Links - "source": "A String", # Source of the reference e.g. NVD - "uri": "A String", # Uri for the mentioned source e.g. https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2021-34527. + "vertexAi": { + "datasets": [ + { + "displayName": "A String", + "name": "A String", + "source": "A String", + }, + ], + "pipelines": [ + { + "displayName": "A String", + "name": "A String", + }, + ], + }, + "vulnerability": { + "cve": { + "cvssv3": { + "attackComplexity": "A String", + "attackVector": "A String", + "availabilityImpact": "A String", + "baseScore": 3.14, + "confidentialityImpact": "A String", + "integrityImpact": "A String", + "privilegesRequired": "A String", + "scope": "A String", + "userInteraction": "A String", + }, + "exploitReleaseDate": "A String", + "exploitationActivity": "A String", + "firstExploitationDate": "A String", + "id": "A String", + "impact": "A String", + "observedInTheWild": True or False, + "references": [ + { + "source": "A String", + "uri": "A String", }, ], - "upstreamFixAvailable": True or False, # Whether upstream fix is available for the CVE. - "zeroDay": True or False, # Whether or not the vulnerability was zero day when the finding was published. - }, - "cwes": [ # Represents one or more Common Weakness Enumeration (CWE) information on this vulnerability. - { # CWE stands for Common Weakness Enumeration. Information about this weakness, as described by [CWE](https://cwe.mitre.org/). - "id": "A String", # The CWE identifier, e.g. CWE-94 - "references": [ # Any reference to the details on the CWE, for example, https://cwe.mitre.org/data/definitions/94.html - { # Additional Links - "source": "A String", # Source of the reference e.g. NVD - "uri": "A String", # Uri for the mentioned source e.g. https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2021-34527. + "upstreamFixAvailable": True or False, + "zeroDay": True or False, + }, + "cwes": [ + { + "id": "A String", + "references": [ + { + "source": "A String", + "uri": "A String", }, ], }, ], - "fixedPackage": { # Package is a generic definition of a package. # The fixed package is relevant to the finding. - "cpeUri": "A String", # The CPE URI where the vulnerability was detected. - "packageName": "A String", # The name of the package where the vulnerability was detected. - "packageType": "A String", # Type of package, for example, os, maven, or go. - "packageVersion": "A String", # The version of the package. + "fixedPackage": { + "cpeUri": "A String", + "packageName": "A String", + "packageType": "A String", + "packageVersion": "A String", }, - "offendingPackage": { # Package is a generic definition of a package. # The offending package is relevant to the finding. - "cpeUri": "A String", # The CPE URI where the vulnerability was detected. - "packageName": "A String", # The name of the package where the vulnerability was detected. - "packageType": "A String", # Type of package, for example, os, maven, or go. - "packageVersion": "A String", # The version of the package. + "offendingPackage": { + "cpeUri": "A String", + "packageName": "A String", + "packageType": "A String", + "packageVersion": "A String", }, - "providerRiskScore": "A String", # Provider provided risk_score based on multiple factors. The higher the risk score, the more risky the vulnerability is. - "reachable": True or False, # Represents whether the vulnerability is reachable (detected via static analysis) - "securityBulletin": { # SecurityBulletin are notifications of vulnerabilities of Google products. # The security bulletin is relevant to this finding. - "bulletinId": "A String", # ID of the bulletin corresponding to the vulnerability. - "submissionTime": "A String", # Submission time of this Security Bulletin. - "suggestedUpgradeVersion": "A String", # This represents a version that the cluster receiving this notification should be upgraded to, based on its current version. For example, 1.15.0 + "providerRiskScore": "A String", + "reachable": True or False, + "securityBulletin": { + "bulletinId": "A String", + "submissionTime": "A String", + "suggestedUpgradeVersion": "A String", }, }, }
@@ -5254,16 +5254,16 @@

Method Details

setState(name, body=None, x__xgafv=None) -
Updates the state of a finding.
+  
 
 Args:
-  name: string, Required. The [relative resource name](https://cloud.google.com/apis/design/resource_names#relative_resource_name) of the finding. Example: `organizations/{organization_id}/sources/{source_id}/findings/{finding_id}`, `folders/{folder_id}/sources/{source_id}/findings/{finding_id}`, `projects/{project_id}/sources/{source_id}/findings/{finding_id}`. (required)
+  name: string, A parameter (required)
   body: object, The request body.
     The object takes the form of:
 
-{ # Request message for updating a finding's state.
-  "startTime": "A String", # Optional. The time at which the updated state takes effect. If unset, defaults to the request time.
-  "state": "A String", # Required. The desired State of the finding.
+{
+  "startTime": "A String",
+  "state": "A String",
 }
 
   x__xgafv: string, V1 error format.
@@ -5274,811 +5274,811 @@ 

Method Details

Returns: An object of the form: - { # Security Command Center finding. A finding is a record of assessment data like security, risk, health, or privacy, that is ingested into Security Command Center for presentation, notification, analysis, policy testing, and enforcement. For example, a cross-site scripting (XSS) vulnerability in an App Engine application is a finding. - "access": { # Represents an access event. # Access details associated with the finding, such as more information on the caller, which method was accessed, and from where. - "callerIp": "A String", # Caller's IP address, such as "1.1.1.1". - "callerIpGeo": { # Represents a geographical location for a given access. # The caller IP's geolocation, which identifies where the call came from. - "regionCode": "A String", # A CLDR. - }, - "methodName": "A String", # The method that the service account called, e.g. "SetIamPolicy". - "principalEmail": "A String", # Associated email, such as "foo@google.com". The email address of the authenticated user or a service account acting on behalf of a 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). - "principalSubject": "A String", # A string that represents the principal_subject that is associated with the identity. Unlike `principal_email`, `principal_subject` supports principals that aren't associated with email addresses, such as third party principals. For most identities, the format is `principal://iam.googleapis.com/{identity pool name}/subject/{subject}`. Some GKE identities, such as GKE_WORKLOAD, FREEFORM, and GKE_HUB_WORKLOAD, still use the legacy format `serviceAccount:{identity pool name}[{subject}]`. - "serviceAccountDelegationInfo": [ # The identity delegation history of an authenticated service account that made the request. The `serviceAccountDelegationInfo[]` object contains information about the real authorities that try to access Google Cloud resources by delegating on a service account. When multiple authorities are present, they are guaranteed to be sorted based on the original ordering of the identity delegation events. - { # Identity delegation history of an authenticated service account. - "principalEmail": "A String", # The email address of a Google account. - "principalSubject": "A String", # A string representing the principal_subject associated with the identity. As compared to `principal_email`, supports principals that aren't associated with email addresses, such as third party principals. For most identities, the format will be `principal://iam.googleapis.com/{identity pool name}/subjects/{subject}` except for some GKE identities (GKE_WORKLOAD, FREEFORM, GKE_HUB_WORKLOAD) that are still in the legacy format `serviceAccount:{identity pool name}[{subject}]` - }, - ], - "serviceAccountKeyName": "A String", # The name of the service account key that was used to create or exchange credentials when authenticating the service account that made the request. This is a scheme-less URI full resource name. For example: "//iam.googleapis.com/projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}/keys/{key}". - "serviceName": "A String", # This is the API service that the service account made a call to, e.g. "iam.googleapis.com" - "userAgent": "A String", # The caller's user agent string associated with the finding. - "userAgentFamily": "A String", # Type of user agent associated with the finding. For example, an operating system shell or an embedded or standalone application. - "userName": "A String", # A string that represents a username. The username provided depends on the type of the finding and is likely not an IAM principal. For example, this can be a system username if the finding is related to a virtual machine, or it can be an application login username. - }, - "affectedResources": { # Details about resources affected by this finding. # AffectedResources associated with the finding. - "count": "A String", # The count of resources affected by the finding. - }, - "agentDataAccessEvents": [ # Agent data access events associated with the finding. - { # Details about a data access attempt made by an agent principal not authorized under applicable data security policy. - "eventId": "A String", # Unique identifier for data access event. - "eventTime": "A String", # Timestamp of data access event. - "operation": "A String", # The operation performed by the principal to access the data. - "principalSubject": "A String", # The agent principal that accessed the data. + { + "access": { + "callerIp": "A String", + "callerIpGeo": { + "regionCode": "A String", + }, + "methodName": "A String", + "principalEmail": "A String", + "principalSubject": "A String", + "serviceAccountDelegationInfo": [ + { + "principalEmail": "A String", + "principalSubject": "A String", + }, + ], + "serviceAccountKeyName": "A String", + "serviceName": "A String", + "userAgent": "A String", + "userAgentFamily": "A String", + "userName": "A String", + }, + "affectedResources": { + "count": "A String", + }, + "agentDataAccessEvents": [ + { + "eventId": "A String", + "eventTime": "A String", + "operation": "A String", + "principalSubject": "A String", }, ], - "aiModel": { # Contains information about the AI model associated with the finding. # The AI model associated with the finding. - "deploymentPlatform": "A String", # The platform on which the model is deployed. - "displayName": "A String", # The user defined display name of model. Ex. baseline-classification-model - "domain": "A String", # The domain of the model, for example, “image-classification”. - "library": "A String", # The name of the model library, for example, “transformers”. - "location": "A String", # The region in which the model is used, for example, “us-central1”. - "name": "A String", # The name of the AI model, for example, "gemini:1.0.0". - "publisher": "A String", # The publisher of the model, for example, “google” or “nvidia”. - "usageCategory": "A String", # The purpose of the model, for example, "Inteference" or "Training". - }, - "application": { # Represents an application associated with a finding. # Represents an application associated with the finding. - "baseUri": "A String", # The base URI that identifies the network location of the application in which the vulnerability was detected. For example, `http://example.com`. - "fullUri": "A String", # The full URI with payload that can be used to reproduce the vulnerability. For example, `http://example.com?p=aMmYgI6H`. - }, - "artifactGuardPolicies": { # Represents the result of evaluating artifact guard policies. # ArtifactGuardPolicies associated with the finding. - "failingPolicies": [ # A list of failing policies. - { # Represents an artifact guard policy. - "failureReason": "A String", # The reason for the policy failure, for example, "severity=HIGH AND max_vuln_count=2". - "policyId": "A String", # The ID of the failing policy, for example, "organizations/3392779/locations/global/policies/prod-policy". - "type": "A String", # The type of the policy evaluation. - }, - ], - "resourceId": "A String", # The ID of the resource that has policies configured for it. - }, - "attackExposure": { # An attack exposure contains the results of an attack path simulation run. # The results of an attack path simulation relevant to this finding. - "attackExposureResult": "A String", # The resource name of the attack path simulation result that contains the details regarding this attack exposure score. Example: `organizations/123/simulations/456/attackExposureResults/789` - "exposedHighValueResourcesCount": 42, # The number of high value resources that are exposed as a result of this finding. - "exposedLowValueResourcesCount": 42, # The number of high value resources that are exposed as a result of this finding. - "exposedMediumValueResourcesCount": 42, # The number of medium value resources that are exposed as a result of this finding. - "latestCalculationTime": "A String", # The most recent time the attack exposure was updated on this finding. - "score": 3.14, # A number between 0 (inclusive) and infinity that represents how important this finding is to remediate. The higher the score, the more important it is to remediate. - "state": "A String", # What state this AttackExposure is in. This captures whether or not an attack exposure has been calculated or not. - }, - "backupDisasterRecovery": { # Information related to Google Cloud Backup and DR Service findings. # Fields related to Backup and DR findings. - "appliance": "A String", # The name of the Backup and DR appliance that captures, moves, and manages the lifecycle of backup data. For example, `backup-server-57137`. - "applications": [ # The names of Backup and DR applications. An application is a VM, database, or file system on a managed host monitored by a backup and recovery appliance. For example, `centos7-01-vol00`, `centos7-01-vol01`, `centos7-01-vol02`. + "aiModel": { + "deploymentPlatform": "A String", + "displayName": "A String", + "domain": "A String", + "library": "A String", + "location": "A String", + "name": "A String", + "publisher": "A String", + "usageCategory": "A String", + }, + "application": { + "baseUri": "A String", + "fullUri": "A String", + }, + "artifactGuardPolicies": { + "failingPolicies": [ + { + "failureReason": "A String", + "policyId": "A String", + "type": "A String", + }, + ], + "resourceId": "A String", + }, + "attackExposure": { + "attackExposureResult": "A String", + "exposedHighValueResourcesCount": 42, + "exposedLowValueResourcesCount": 42, + "exposedMediumValueResourcesCount": 42, + "latestCalculationTime": "A String", + "score": 3.14, + "state": "A String", + }, + "backupDisasterRecovery": { + "appliance": "A String", + "applications": [ "A String", ], - "backupCreateTime": "A String", # The timestamp at which the Backup and DR backup was created. - "backupTemplate": "A String", # The name of a Backup and DR template which comprises one or more backup policies. See the [Backup and DR documentation](https://cloud.google.com/backup-disaster-recovery/docs/concepts/backup-plan#temp) for more information. For example, `snap-ov`. - "backupType": "A String", # The backup type of the Backup and DR image. For example, `Snapshot`, `Remote Snapshot`, `OnVault`. - "host": "A String", # The name of a Backup and DR host, which is managed by the backup and recovery appliance and known to the management console. The host can be of type Generic (for example, Compute Engine, SQL Server, Oracle DB, SMB file system, etc.), vCenter, or an ESX server. See the [Backup and DR documentation on hosts](https://cloud.google.com/backup-disaster-recovery/docs/configuration/manage-hosts-and-their-applications) for more information. For example, `centos7-01`. - "policies": [ # The names of Backup and DR policies that are associated with a template and that define when to run a backup, how frequently to run a backup, and how long to retain the backup image. For example, `onvaults`. + "backupCreateTime": "A String", + "backupTemplate": "A String", + "backupType": "A String", + "host": "A String", + "policies": [ "A String", ], - "policyOptions": [ # The names of Backup and DR advanced policy options of a policy applying to an application. See the [Backup and DR documentation on policy options](https://cloud.google.com/backup-disaster-recovery/docs/create-plan/policy-settings). For example, `skipofflineappsincongrp, nounmap`. + "policyOptions": [ "A String", ], - "profile": "A String", # The name of the Backup and DR resource profile that specifies the storage media for backups of application and VM data. See the [Backup and DR documentation on profiles](https://cloud.google.com/backup-disaster-recovery/docs/concepts/backup-plan#profile). For example, `GCP`. - "storagePool": "A String", # The name of the Backup and DR storage pool that the backup and recovery appliance is storing data in. The storage pool could be of type Cloud, Primary, Snapshot, or OnVault. See the [Backup and DR documentation on storage pools](https://cloud.google.com/backup-disaster-recovery/docs/concepts/storage-pools). For example, `DiskPoolOne`. + "profile": "A String", + "storagePool": "A String", }, - "canonicalName": "A String", # The canonical name of the finding. It's either "organizations/{organization_id}/sources/{source_id}/findings/{finding_id}", "folders/{folder_id}/sources/{source_id}/findings/{finding_id}" or "projects/{project_number}/sources/{source_id}/findings/{finding_id}", depending on the closest CRM ancestor of the resource associated with the finding. - "category": "A String", # The additional taxonomy group within findings from a given source. This field is immutable after creation time. Example: "XSS_FLASH_INJECTION" - "chokepoint": { # Contains details about a chokepoint, which is a resource or resource group where high-risk attack paths converge, based on [attack path simulations] (https://cloud.google.com/security-command-center/docs/attack-exposure-learn#attack_path_simulations). # Contains details about a chokepoint, which is a resource or resource group where high-risk attack paths converge, based on [attack path simulations] (https://cloud.google.com/security-command-center/docs/attack-exposure-learn#attack_path_simulations). This field cannot be updated. Its value is ignored in all update requests. - "relatedFindings": [ # List of resource names of findings associated with this chokepoint. For example, organizations/123/sources/456/findings/789. This list will have at most 100 findings. + "canonicalName": "A String", + "category": "A String", + "chokepoint": { + "relatedFindings": [ "A String", ], }, - "cloudArmor": { # Fields related to Google Cloud Armor findings. # Fields related to Cloud Armor findings. - "adaptiveProtection": { # Information about [Google Cloud Armor Adaptive Protection](https://cloud.google.com/armor/docs/cloud-armor-overview#google-cloud-armor-adaptive-protection). # Information about potential Layer 7 DDoS attacks identified by [Google Cloud Armor Adaptive Protection](https://cloud.google.com/armor/docs/adaptive-protection-overview). - "confidence": 3.14, # A score of 0 means that there is low confidence that the detected event is an actual attack. A score of 1 means that there is high confidence that the detected event is an attack. See the [Adaptive Protection documentation](https://cloud.google.com/armor/docs/adaptive-protection-overview#configure-alert-tuning) for further explanation. - }, - "attack": { # Information about DDoS attack volume and classification. # Information about DDoS attack volume and classification. - "classification": "A String", # Type of attack, for example, 'SYN-flood', 'NTP-udp', or 'CHARGEN-udp'. - "volumeBps": 42, # Total BPS (bytes per second) volume of attack. Deprecated - refer to volume_bps_long instead. - "volumeBpsLong": "A String", # Total BPS (bytes per second) volume of attack. - "volumePps": 42, # Total PPS (packets per second) volume of attack. Deprecated - refer to volume_pps_long instead. - "volumePpsLong": "A String", # Total PPS (packets per second) volume of attack. - }, - "duration": "A String", # Duration of attack from the start until the current moment (updated every 5 minutes). - "requests": { # Information about the requests relevant to the finding. # Information about incoming requests evaluated by [Google Cloud Armor security policies](https://cloud.google.com/armor/docs/security-policy-overview). - "longTermAllowed": 42, # Allowed RPS (requests per second) over the long term. - "longTermDenied": 42, # Denied RPS (requests per second) over the long term. - "ratio": 3.14, # For 'Increasing deny ratio', the ratio is the denied traffic divided by the allowed traffic. For 'Allowed traffic spike', the ratio is the allowed traffic in the short term divided by allowed traffic in the long term. - "shortTermAllowed": 42, # Allowed RPS (requests per second) in the short term. - }, - "securityPolicy": { # Information about the [Google Cloud Armor security policy](https://cloud.google.com/armor/docs/security-policy-overview) relevant to the finding. # Information about the [Google Cloud Armor security policy](https://cloud.google.com/armor/docs/security-policy-overview) relevant to the finding. - "name": "A String", # The name of the Google Cloud Armor security policy, for example, "my-security-policy". - "preview": True or False, # Whether or not the associated rule or policy is in preview mode. - "type": "A String", # The type of Google Cloud Armor security policy for example, 'backend security policy', 'edge security policy', 'network edge security policy', or 'always-on DDoS protection'. - }, - "threatVector": "A String", # Distinguish between volumetric & protocol DDoS attack and application layer attacks. For example, "L3_4" for Layer 3 and Layer 4 DDoS attacks, or "L_7" for Layer 7 DDoS attacks. - }, - "cloudDlpDataProfile": { # The [data profile](https://cloud.google.com/dlp/docs/data-profiles) associated with the finding. # Cloud DLP data profile that is associated with the finding. - "dataProfile": "A String", # Name of the data profile, for example, `projects/123/locations/europe/tableProfiles/8383929`. - "infoTypes": [ # Type of information detected by SDP. Info type includes name, version and sensitivity of the detected information type. - { # Type of information detected by the API. - "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. - "sensitivityScore": { # Score is calculated from of all elements in the data profile. A higher level means the data is more sensitive. # Optional custom sensitivity for this InfoType. This only applies to data profiling. - "score": "A String", # The sensitivity score applied to the resource. + "cloudArmor": { + "adaptiveProtection": { + "confidence": 3.14, + }, + "attack": { + "classification": "A String", + "volumeBps": 42, + "volumeBpsLong": "A String", + "volumePps": 42, + "volumePpsLong": "A String", + }, + "duration": "A String", + "requests": { + "longTermAllowed": 42, + "longTermDenied": 42, + "ratio": 3.14, + "shortTermAllowed": 42, + }, + "securityPolicy": { + "name": "A String", + "preview": True or False, + "type": "A String", + }, + "threatVector": "A String", + }, + "cloudDlpDataProfile": { + "dataProfile": "A String", + "infoTypes": [ + { + "name": "A String", + "sensitivityScore": { + "score": "A String", }, - "version": "A String", # Optional version name for this InfoType. + "version": "A String", }, ], - "parentType": "A String", # The resource hierarchy level at which the data profile was generated. + "parentType": "A String", }, - "cloudDlpInspection": { # Details about the Cloud Data Loss Prevention (Cloud DLP) [inspection job](https://cloud.google.com/dlp/docs/concepts-job-triggers) that produced the finding. # Cloud Data Loss Prevention (Cloud DLP) inspection results that are associated with the finding. - "fullScan": True or False, # Whether Cloud DLP scanned the complete resource or a sampled subset. - "infoType": "A String", # The type of information (or *[infoType](https://cloud.google.com/dlp/docs/infotypes-reference)*) found, for example, `EMAIL_ADDRESS` or `STREET_ADDRESS`. - "infoTypeCount": "A String", # The number of times Cloud DLP found this infoType within this job and resource. - "inspectJob": "A String", # Name of the inspection job, for example, `projects/123/locations/europe/dlpJobs/i-8383929`. + "cloudDlpInspection": { + "fullScan": True or False, + "infoType": "A String", + "infoTypeCount": "A String", + "inspectJob": "A String", }, - "complianceDetails": { # Compliance Details associated with the finding. # Details about the compliance implications of the finding. - "cloudControl": { # CloudControl associated with the finding. # CloudControl associated with the finding - "cloudControlName": "A String", # Name of the CloudControl associated with the finding. - "policyType": "A String", # Policy type of the CloudControl - "type": "A String", # Type of cloud control. - "version": 42, # Version of the Cloud Control + "complianceDetails": { + "cloudControl": { + "cloudControlName": "A String", + "policyType": "A String", + "type": "A String", + "version": 42, }, - "cloudControlDeploymentNames": [ # Cloud Control Deployments associated with the finding. For example, organizations/123/locations/global/cloudControlDeployments/deploymentIdentifier + "cloudControlDeploymentNames": [ "A String", ], - "frameworks": [ # Details of Frameworks associated with the finding - { # Compliance framework associated with the finding. - "category": [ # Category of the framework associated with the finding. E.g. Security Benchmark, or Assured Workloads + "frameworks": [ + { + "category": [ "A String", ], - "controls": [ # The controls associated with the framework. - { # Compliance control associated with the finding. - "controlName": "A String", # Name of the Control - "displayName": "A String", # Display name of the control. For example, AU-02. + "controls": [ + { + "controlName": "A String", + "displayName": "A String", }, ], - "displayName": "A String", # Display name of the framework. For a standard framework, this will look like e.g. PCI DSS 3.2.1, whereas for a custom framework it can be a user defined string like MyFramework - "name": "A String", # Name of the framework associated with the finding - "type": "A String", # Type of the framework associated with the finding, to specify whether the framework is built-in (pre-defined and immutable) or a custom framework defined by the customer (equivalent to security posture) + "displayName": "A String", + "name": "A String", + "type": "A String", }, ], }, - "compliances": [ # Contains compliance information for security standards associated to the finding. - { # Contains compliance information about a security standard indicating unmet recommendations. - "ids": [ # Policies within the standard or benchmark, for example, A.12.4.1 + "compliances": [ + { + "ids": [ "A String", ], - "standard": "A String", # Industry-wide compliance standards or benchmarks, such as CIS, PCI, and OWASP. - "version": "A String", # Version of the standard or benchmark, for example, 1.1 + "standard": "A String", + "version": "A String", }, ], - "connections": [ # Contains information about the IP connection associated with the finding. - { # Contains information about the IP connection associated with the finding. - "destinationIp": "A String", # Destination IP address. Not present for sockets that are listening and not connected. - "destinationPort": 42, # Destination port. Not present for sockets that are listening and not connected. - "protocol": "A String", # IANA Internet Protocol Number such as TCP(6) and UDP(17). - "sourceIp": "A String", # Source IP address. - "sourcePort": 42, # Source port. + "connections": [ + { + "destinationIp": "A String", + "destinationPort": 42, + "protocol": "A String", + "sourceIp": "A String", + "sourcePort": 42, }, ], - "contacts": { # Output only. Map containing the points of contact for the given finding. The key represents the type of contact, while the value contains a list of all the contacts that pertain. Please refer to: https://cloud.google.com/resource-manager/docs/managing-notification-contacts#notification-categories { "security": { "contacts": [ { "email": "person1@company.com" }, { "email": "person2@company.com" } ] } } - "a_key": { # Details about specific contacts - "contacts": [ # A list of contacts - { # The email address of a contact. - "email": "A String", # An email address. For example, "`person123@company.com`". + "contacts": { + "a_key": { + "contacts": [ + { + "email": "A String", }, ], }, }, - "containers": [ # Containers associated with the finding. This field provides information for both Kubernetes and non-Kubernetes containers. - { # Container associated with the finding. - "createTime": "A String", # The time that the container was created. - "imageId": "A String", # Optional container image ID, if provided by the container runtime. Uniquely identifies the container image launched using a container image digest. - "labels": [ # Container labels, as provided by the container runtime. - { # Represents a generic name-value label. A label has separate name and value fields to support filtering with the `contains()` function. For more information, see [Filtering on array-type fields](https://cloud.google.com/security-command-center/docs/how-to-api-list-findings#array-contains-filtering). - "name": "A String", # Name of the label. - "value": "A String", # Value that corresponds to the label's name. + "containers": [ + { + "createTime": "A String", + "imageId": "A String", + "labels": [ + { + "name": "A String", + "value": "A String", }, ], - "name": "A String", # Name of the container. - "uri": "A String", # Container image URI provided when configuring a pod or container. This string can identify a container image version using mutable tags. + "name": "A String", + "uri": "A String", }, ], - "createTime": "A String", # The time at which the finding was created in Security Command Center. - "dataAccessEvents": [ # Data access events associated with the finding. - { # Details about a data access attempt made by a principal not authorized under applicable data security policy. - "eventId": "A String", # Unique identifier for data access event. - "eventTime": "A String", # Timestamp of data access event. - "operation": "A String", # The operation performed by the principal to access the data. - "principalEmail": "A String", # The email address of the principal that accessed the data. The principal could be a user account, service account, Google group, or other. + "createTime": "A String", + "dataAccessEvents": [ + { + "eventId": "A String", + "eventTime": "A String", + "operation": "A String", + "principalEmail": "A String", }, ], - "dataFlowEvents": [ # Data flow events associated with the finding. - { # Details about a data flow event, in which either the data is moved to or is accessed from a non-compliant geo-location, as defined in the applicable data security policy. - "eventId": "A String", # Unique identifier for data flow event. - "eventTime": "A String", # Timestamp of data flow event. - "operation": "A String", # The operation performed by the principal for the data flow event. - "principalEmail": "A String", # The email address of the principal that initiated the data flow event. The principal could be a user account, service account, Google group, or other. - "violatedLocation": "A String", # Non-compliant location of the principal or the data destination. + "dataFlowEvents": [ + { + "eventId": "A String", + "eventTime": "A String", + "operation": "A String", + "principalEmail": "A String", + "violatedLocation": "A String", }, ], - "dataRetentionDeletionEvents": [ # Data retention deletion events associated with the finding. - { # Details about data retention deletion violations, in which the data is non-compliant based on their retention or deletion time, as defined in the applicable data security policy. The Data Retention Deletion (DRD) control is a control of the DSPM (Data Security Posture Management) suite that enables organizations to manage data retention and deletion policies in compliance with regulations, such as GDPR and CRPA. DRD supports two primary policy types: maximum storage length (max TTL) and minimum storage length (min TTL). Both are aimed at helping organizations meet regulatory and data management commitments. - "dataObjectCount": "A String", # Number of objects that violated the policy for this resource. If the number is less than 1,000, then the value of this field is the exact number. If the number of objects that violated the policy is greater than or equal to 1,000, then the value of this field is 1000. - "eventDetectionTime": "A String", # Timestamp indicating when the event was detected. - "eventType": "A String", # Type of the DRD event. - "maxRetentionAllowed": "A String", # Maximum duration of retention allowed from the DRD control. This comes from the DRD control where users set a max TTL for their data. For example, suppose that a user sets the max TTL for a Cloud Storage bucket to 90 days. However, an object in that bucket is 100 days old. In this case, a DataRetentionDeletionEvent will be generated for that Cloud Storage bucket, and the max_retention_allowed is 90 days. - "minRetentionAllowed": "A String", # Min duration of retention allowed from the DSPM retention control. This field is only populated when event type is set to EVENT_TYPE_MIN_TTL_FROM_CREATION. + "dataRetentionDeletionEvents": [ + { + "dataObjectCount": "A String", + "eventDetectionTime": "A String", + "eventType": "A String", + "maxRetentionAllowed": "A String", + "minRetentionAllowed": "A String", }, ], - "database": { # Represents database access information, such as queries. A database may be a sub-resource of an instance (as in the case of Cloud SQL instances or Cloud Spanner instances), or the database instance itself. Some database resources might not have the [full resource name](https://google.aip.dev/122#full-resource-names) populated because these resource types, such as Cloud SQL databases, are not yet supported by Cloud Asset Inventory. In these cases only the display name is provided. # Database associated with the finding. - "displayName": "A String", # The human-readable name of the database that the user connected to. - "grantees": [ # The target usernames, roles, or groups of an SQL privilege grant, which is not an IAM policy change. + "database": { + "displayName": "A String", + "grantees": [ "A String", ], - "name": "A String", # Some database resources may not have the [full resource name](https://google.aip.dev/122#full-resource-names) populated because these resource types are not yet supported by Cloud Asset Inventory (e.g. Cloud SQL databases). In these cases only the display name will be provided. The [full resource name](https://google.aip.dev/122#full-resource-names) of the database that the user connected to, if it is supported by Cloud Asset Inventory. - "query": "A String", # The SQL statement that is associated with the database access. - "userName": "A String", # The username used to connect to the database. The username might not be an IAM principal and does not have a set format. - "version": "A String", # The version of the database, for example, POSTGRES_14. See [the complete list](https://cloud.google.com/sql/docs/mysql/admin-api/rest/v1/SqlDatabaseVersion). - }, - "description": "A String", # Contains more details about the finding. - "discoveredWorkload": { # Represents discovered, customer managed workload that is not registered with the respective GCP service. # DiscoveredWorkload associated with the finding. - "confidence": "A String", # The confidence in detection of this workload. - "detectedRelevantHardware": True or False, # A boolean flag set to true if associated hardware strongly predicts the workload type. - "detectedRelevantKeywords": True or False, # A boolean flag set to true if associated keywords strongly predict the workload type. - "detectedRelevantPackages": True or False, # A boolean flag set to true if installed packages strongly predict the workload type. - "workloadType": "A String", # The type of workload. - }, - "disk": { # Contains information about the disk associated with the finding. # Disk associated with the finding. - "name": "A String", # The name of the disk, for example, "https://www.googleapis.com/compute/v1/projects/{project-id}/zones/{zone-id}/disks/{disk-id}". - }, - "eventTime": "A String", # The time the finding was first detected. If an existing finding is updated, then this is the time the update occurred. For example, if the finding represents an open firewall, this property captures the time the detector believes the firewall became open. The accuracy is determined by the detector. If the finding is later resolved, then this time reflects when the finding was resolved. This must not be set to a value greater than the current timestamp. - "exfiltration": { # Exfiltration represents a data exfiltration attempt from one or more sources to one or more targets. The `sources` attribute lists the sources of the exfiltrated data. The `targets` attribute lists the destinations the data was copied to. # Represents exfiltrations associated with the finding. - "sources": [ # If there are multiple sources, then the data is considered "joined" between them. For instance, BigQuery can join multiple tables, and each table would be considered a source. - { # Resource where data was exfiltrated from or exfiltrated to. - "components": [ # Subcomponents of the asset that was exfiltrated, like URIs used during exfiltration, table names, databases, and filenames. For example, multiple tables might have been exfiltrated from the same Cloud SQL instance, or multiple files might have been exfiltrated from the same Cloud Storage bucket. + "name": "A String", + "query": "A String", + "userName": "A String", + "version": "A String", + }, + "description": "A String", + "discoveredWorkload": { + "confidence": "A String", + "detectedRelevantHardware": True or False, + "detectedRelevantKeywords": True or False, + "detectedRelevantPackages": True or False, + "workloadType": "A String", + }, + "disk": { + "name": "A String", + }, + "eventTime": "A String", + "exfiltration": { + "sources": [ + { + "components": [ "A String", ], - "name": "A String", # The resource's [full resource name](https://cloud.google.com/apis/design/resource_names#full_resource_name). + "name": "A String", }, ], - "targets": [ # If there are multiple targets, each target would get a complete copy of the "joined" source data. - { # Resource where data was exfiltrated from or exfiltrated to. - "components": [ # Subcomponents of the asset that was exfiltrated, like URIs used during exfiltration, table names, databases, and filenames. For example, multiple tables might have been exfiltrated from the same Cloud SQL instance, or multiple files might have been exfiltrated from the same Cloud Storage bucket. + "targets": [ + { + "components": [ "A String", ], - "name": "A String", # The resource's [full resource name](https://cloud.google.com/apis/design/resource_names#full_resource_name). - }, - ], - "totalExfiltratedBytes": "A String", # Total exfiltrated bytes processed for the entire job. - }, - "externalExposure": { # Details about the externally exposed resource associated with the finding. # External exposure associated with the finding. - "backendBucket": "A String", # The full resource name of the load balancer backend bucket, for example, "//compute.googleapis.com/projects/{project-id}/global/backendBuckets/{name}" - "backendService": "A String", # The full resource name of load balancer backend service, for example, "//compute.googleapis.com/projects/{project-id}/global/backendServices/{name}". - "exposedApplication": "A String", # The name and version of the exposed web application, for example, "Jenkins 2.184". - "exposedEndpoint": "A String", # The resource which is running the exposed service, for example, "//compute.googleapis.com/projects/{project-id}/zones/{zone}/instances/{instance}.” - "exposedService": "A String", # The name and version of the service, for example, "Jupyter Notebook 6.14.0". - "forwardingRule": "A String", # The full resource name of the forwarding rule, for example, "//compute.googleapis.com/projects/{project-id}/global/forwardingRules/{forwarding-rule-name}". - "hostnameUri": "A String", # Hostname of the exposed application, for example, "https://test-app.a.run.app/" - "httpResponse": [ # The http response returned by the web application. - { # The http response returned by the web application. - "path": "A String", # The http path for which response code was returned by web application, for example, "https://test-app.a.run.app/test". - "statusCode": "A String", # The http response code returned by the web application, for example, 200. - }, - ], - "instanceGroup": "A String", # The full resource name of the instance group, for example, "//compute.googleapis.com/projects/{project-id}/global/instanceGroups/{name}". - "internalBackendService": "A String", # The full resource name of load balancer backend service in the internal project having resource exposed via PSC, for example, "//compute.googleapis.com/projects/{project-id}/global/backendServices/{name}". - "loadBalancerFirewallPolicy": "A String", # The full resource name of the load balancer firewall policy, for example, "//compute.googleapis.com/projects/{project-id}/global/firewallPolicies/{policy-name}". - "networkEndpointGroup": "A String", # The full resource name of the network endpoint group, for example, "//compute.googleapis.com/projects/{project-id}/global/networkEndpointGroups/{name}". - "networkIngressFirewallPolicy": "A String", # The full resource name of the network ingress firewall policy, for example, "//compute.googleapis.com/projects/{project-id}/global/firewallPolicies/{name}". - "privateIpAddress": "A String", # Private IP address of the exposed endpoint. - "privatePort": "A String", # Port number associated with private IP address. - "pscNetworkAttachment": "A String", # The full resource name of the PSC (Private Service Connect) network attachment that network interface controller is attached to, for example, "//compute.googleapis.com/projects/{project-id}/regions/{region}/networkAttachments/{name}" - "pscServiceAttachment": "A String", # The full resource name of the PSC (Private Service Connect) service attachment that the load balancer network endpoint group targets, for example, "//compute.googleapis.com/projects/{project-id}/regions/{region}/serviceAttachments/{name}" - "publicIpAddress": "A String", # Public IP address of the exposed endpoint. - "publicPort": "A String", # Public port number of the exposed endpoint. - "serviceFirewallPolicy": "A String", # The full resource name of the firewall policy of the exposed service, for example, "//compute.googleapis.com/projects/{project-id}/global/firewallPolicies/{policy-name}". - }, - "externalSystems": { # Output only. Third party SIEM/SOAR fields within SCC, contains external system information and external system finding fields. - "a_key": { # Representation of third party SIEM/SOAR fields within SCC. - "assignees": [ # References primary/secondary etc assignees in the external system. + "name": "A String", + }, + ], + "totalExfiltratedBytes": "A String", + }, + "externalExposure": { + "backendBucket": "A String", + "backendService": "A String", + "exposedApplication": "A String", + "exposedEndpoint": "A String", + "exposedService": "A String", + "forwardingRule": "A String", + "hostnameUri": "A String", + "httpResponse": [ + { + "path": "A String", + "statusCode": "A String", + }, + ], + "instanceGroup": "A String", + "internalBackendService": "A String", + "loadBalancerFirewallPolicy": "A String", + "networkEndpointGroup": "A String", + "networkIngressFirewallPolicy": "A String", + "privateIpAddress": "A String", + "privatePort": "A String", + "pscNetworkAttachment": "A String", + "pscServiceAttachment": "A String", + "publicIpAddress": "A String", + "publicPort": "A String", + "serviceFirewallPolicy": "A String", + }, + "externalSystems": { + "a_key": { + "assignees": [ "A String", ], - "caseCloseTime": "A String", # The time when the case was closed, as reported by the external system. - "caseCreateTime": "A String", # The time when the case was created, as reported by the external system. - "casePriority": "A String", # The priority of the finding's corresponding case in the external system. - "caseSla": "A String", # The SLA of the finding's corresponding case in the external system. - "caseUri": "A String", # The link to the finding's corresponding case in the external system. - "externalSystemUpdateTime": "A String", # The time when the case was last updated, as reported by the external system. - "externalUid": "A String", # The identifier that's used to track the finding's corresponding case in the external system. - "name": "A String", # Full resource name of the external system, for example: "organizations/1234/sources/5678/findings/123456/externalSystems/jira", "folders/1234/sources/5678/findings/123456/externalSystems/jira", "projects/1234/sources/5678/findings/123456/externalSystems/jira" - "status": "A String", # The most recent status of the finding's corresponding case, as reported by the external system. - "ticketInfo": { # Information about the ticket, if any, that is being used to track the resolution of the issue that is identified by this finding. # Information about the ticket, if any, that is being used to track the resolution of the issue that is identified by this finding. - "assignee": "A String", # The assignee of the ticket in the ticket system. - "description": "A String", # The description of the ticket in the ticket system. - "id": "A String", # The identifier of the ticket in the ticket system. - "status": "A String", # The latest status of the ticket, as reported by the ticket system. - "updateTime": "A String", # The time when the ticket was last updated, as reported by the ticket system. - "uri": "A String", # The link to the ticket in the ticket system. - }, - }, - }, - "externalUri": "A String", # The URI that, if available, points to a web page outside of Security Command Center where additional information about the finding can be found. This field is guaranteed to be either empty or a well formed URL. - "files": [ # File associated with the finding. - { # File information about the related binary/library used by an executable, or the script used by a script interpreter - "contents": "A String", # Prefix of the file contents as a JSON-encoded string. - "diskPath": { # Path of the file in terms of underlying disk/partition identifiers. # Path of the file in terms of underlying disk/partition identifiers. - "partitionUuid": "A String", # UUID of the partition (format https://wiki.archlinux.org/title/persistent_block_device_naming#by-uuid) - "relativePath": "A String", # Relative path of the file in the partition as a JSON encoded string. Example: /home/user1/executable_file.sh - }, - "fileLoadState": "A String", # The load state of the file. - "hashedSize": "A String", # The length in bytes of the file prefix that was hashed. If hashed_size == size, any hashes reported represent the entire file. - "operations": [ # Operation(s) performed on a file. - { # Operation(s) performed on a file. - "type": "A String", # The type of the operation + "caseCloseTime": "A String", + "caseCreateTime": "A String", + "casePriority": "A String", + "caseSla": "A String", + "caseUri": "A String", + "externalSystemUpdateTime": "A String", + "externalUid": "A String", + "name": "A String", + "status": "A String", + "ticketInfo": { + "assignee": "A String", + "description": "A String", + "id": "A String", + "status": "A String", + "updateTime": "A String", + "uri": "A String", + }, + }, + }, + "externalUri": "A String", + "files": [ + { + "contents": "A String", + "diskPath": { + "partitionUuid": "A String", + "relativePath": "A String", + }, + "fileLoadState": "A String", + "hashedSize": "A String", + "operations": [ + { + "type": "A String", }, ], - "partiallyHashed": True or False, # True when the hash covers only a prefix of the file. - "path": "A String", # Absolute path of the file as a JSON encoded string. - "sha256": "A String", # SHA256 hash of the first hashed_size bytes of the file encoded as a hex string. If hashed_size == size, sha256 represents the SHA256 hash of the entire file. - "size": "A String", # Size of the file in bytes. + "partiallyHashed": True or False, + "path": "A String", + "sha256": "A String", + "size": "A String", }, ], - "findingClass": "A String", # The class of the finding. - "groupMemberships": [ # Contains details about groups of which this finding is a member. A group is a collection of findings that are related in some way. This field cannot be updated. Its value is ignored in all update requests. - { # Contains details about groups of which this finding is a member. A group is a collection of findings that are related in some way. - "groupId": "A String", # ID of the group. - "groupType": "A String", # Type of group. + "findingClass": "A String", + "groupMemberships": [ + { + "groupId": "A String", + "groupType": "A String", }, ], - "iamBindings": [ # Represents IAM bindings associated with the finding. - { # Represents a particular IAM binding, which captures a member's role addition, removal, or state. - "action": "A String", # The action that was performed on a Binding. - "member": "A String", # A single identity requesting access for a Cloud Platform resource, for example, "foo@google.com". - "role": "A String", # Role that is assigned to "members". For example, "roles/viewer", "roles/editor", or "roles/owner". + "iamBindings": [ + { + "action": "A String", + "member": "A String", + "role": "A String", }, ], - "indicator": { # Represents what's commonly known as an _indicator of compromise_ (IoC) in computer forensics. This is an artifact observed on a network or in an operating system that, with high confidence, indicates a computer intrusion. For more information, see [Indicator of compromise](https://en.wikipedia.org/wiki/Indicator_of_compromise). # Represents what's commonly known as an *indicator of compromise* (IoC) in computer forensics. This is an artifact observed on a network or in an operating system that, with high confidence, indicates a computer intrusion. For more information, see [Indicator of compromise](https://en.wikipedia.org/wiki/Indicator_of_compromise). - "domains": [ # List of domains associated to the Finding. + "indicator": { + "domains": [ "A String", ], - "ipAddresses": [ # The list of IP addresses that are associated with the finding. + "ipAddresses": [ "A String", ], - "signatures": [ # The list of matched signatures indicating that the given process is present in the environment. - { # Indicates what signature matched this process. - "memoryHashSignature": { # A signature corresponding to memory page hashes. # Signature indicating that a binary family was matched. - "binaryFamily": "A String", # The binary family. - "detections": [ # The list of memory hash detections contributing to the binary family match. - { # Memory hash detection contributing to the binary family match. - "binary": "A String", # The name of the binary associated with the memory hash signature detection. - "percentPagesMatched": 3.14, # The percentage of memory page hashes in the signature that were matched. + "signatures": [ + { + "memoryHashSignature": { + "binaryFamily": "A String", + "detections": [ + { + "binary": "A String", + "percentPagesMatched": 3.14, }, ], }, - "signatureType": "A String", # Describes the type of resource associated with the signature. - "yaraRuleSignature": { # A signature corresponding to a YARA rule. # Signature indicating that a YARA rule was matched. - "yaraRule": "A String", # The name of the YARA rule. + "signatureType": "A String", + "yaraRuleSignature": { + "yaraRule": "A String", }, }, ], - "uris": [ # The list of URIs associated to the Findings. + "uris": [ "A String", ], }, - "ipRules": { # IP rules associated with the finding. # IP rules associated with the finding. - "allowed": { # Allowed IP rule. # Tuple with allowed rules. - "ipRules": [ # Optional. Optional list of allowed IP rules. - { # IP rule information. - "portRanges": [ # Optional. An optional list of ports to which this rule applies. This field is only applicable for the UDP or (S)TCP protocols. Each entry must be either an integer or a range including a min and max port number. - { # A port range which is inclusive of the min and max values. Values are between 0 and 2^16-1. The max can be equal / must be not smaller than the min value. If min and max are equal this indicates that it is a single port. - "max": "A String", # Maximum port value. - "min": "A String", # Minimum port value. + "ipRules": { + "allowed": { + "ipRules": [ + { + "portRanges": [ + { + "max": "A String", + "min": "A String", }, ], - "protocol": "A String", # The IP protocol this rule applies to. This value can either be one of the following well known protocol strings (TCP, UDP, ICMP, ESP, AH, IPIP, SCTP) or a string representation of the integer value. + "protocol": "A String", }, ], }, - "denied": { # Denied IP rule. # Tuple with denied rules. - "ipRules": [ # Optional. Optional list of denied IP rules. - { # IP rule information. - "portRanges": [ # Optional. An optional list of ports to which this rule applies. This field is only applicable for the UDP or (S)TCP protocols. Each entry must be either an integer or a range including a min and max port number. - { # A port range which is inclusive of the min and max values. Values are between 0 and 2^16-1. The max can be equal / must be not smaller than the min value. If min and max are equal this indicates that it is a single port. - "max": "A String", # Maximum port value. - "min": "A String", # Minimum port value. + "denied": { + "ipRules": [ + { + "portRanges": [ + { + "max": "A String", + "min": "A String", }, ], - "protocol": "A String", # The IP protocol this rule applies to. This value can either be one of the following well known protocol strings (TCP, UDP, ICMP, ESP, AH, IPIP, SCTP) or a string representation of the integer value. + "protocol": "A String", }, ], }, - "destinationIpRanges": [ # If destination IP ranges are specified, the firewall rule applies only to traffic that has a destination IP address in these ranges. These ranges must be expressed in CIDR format. Only supports IPv4. + "destinationIpRanges": [ "A String", ], - "direction": "A String", # The direction that the rule is applicable to, one of ingress or egress. - "exposedServices": [ # Name of the network protocol service, such as FTP, that is exposed by the open port. Follows the naming convention available at: https://www.iana.org/assignments/service-names-port-numbers/service-names-port-numbers.xhtml. + "direction": "A String", + "exposedServices": [ "A String", ], - "sourceIpRanges": [ # If source IP ranges are specified, the firewall rule applies only to traffic that has a source IP address in these ranges. These ranges must be expressed in CIDR format. Only supports IPv4. + "sourceIpRanges": [ "A String", ], }, - "job": { # Describes a job # Job associated with the finding. - "errorCode": 42, # Optional. If the job did not complete successfully, this field describes why. - "location": "A String", # Optional. Gives the location where the job ran, such as `US` or `europe-west1` - "name": "A String", # The fully-qualified name for a job. e.g. `projects//jobs/` - "state": "A String", # Output only. State of the job, such as `RUNNING` or `PENDING`. - }, - "kernelRootkit": { # Kernel mode rootkit signatures. # Signature of the kernel rootkit. - "name": "A String", # Rootkit name, when available. - "unexpectedCodeModification": True or False, # True if unexpected modifications of kernel code memory are present. - "unexpectedFtraceHandler": True or False, # True if `ftrace` points are present with callbacks pointing to regions that are not in the expected kernel or module code range. - "unexpectedInterruptHandler": True or False, # True if interrupt handlers that are are not in the expected kernel or module code regions are present. - "unexpectedKernelCodePages": True or False, # True if kernel code pages that are not in the expected kernel or module code regions are present. - "unexpectedKprobeHandler": True or False, # True if `kprobe` points are present with callbacks pointing to regions that are not in the expected kernel or module code range. - "unexpectedProcessesInRunqueue": True or False, # True if unexpected processes in the scheduler run queue are present. Such processes are in the run queue, but not in the process task list. - "unexpectedReadOnlyDataModification": True or False, # True if unexpected modifications of kernel read-only data memory are present. - "unexpectedSystemCallHandler": True or False, # True if system call handlers that are are not in the expected kernel or module code regions are present. - }, - "kubernetes": { # Kubernetes-related attributes. # Kubernetes resources associated with the finding. - "accessReviews": [ # Provides information on any Kubernetes access reviews (privilege checks) relevant to the finding. - { # Conveys information about a Kubernetes access review (such as one returned by a [`kubectl auth can-i`](https://kubernetes.io/docs/reference/access-authn-authz/authorization/#checking-api-access) command) that was involved in a finding. - "group": "A String", # The API group of the resource. "*" means all. - "name": "A String", # The name of the resource being requested. Empty means all. - "ns": "A String", # Namespace of the action being requested. Currently, there is no distinction between no namespace and all namespaces. Both are represented by "" (empty). - "resource": "A String", # The optional resource type requested. "*" means all. - "subresource": "A String", # The optional subresource type. - "verb": "A String", # A Kubernetes resource API verb, like get, list, watch, create, update, delete, proxy. "*" means all. - "version": "A String", # The API version of the resource. "*" means all. - }, - ], - "bindings": [ # Provides Kubernetes role binding information for findings that involve [RoleBindings or ClusterRoleBindings](https://cloud.google.com/kubernetes-engine/docs/how-to/role-based-access-control). - { # Represents a Kubernetes RoleBinding or ClusterRoleBinding. - "name": "A String", # Name for the binding. - "ns": "A String", # Namespace for the binding. - "role": { # Kubernetes Role or ClusterRole. # The Role or ClusterRole referenced by the binding. - "kind": "A String", # Role type. - "name": "A String", # Role name. - "ns": "A String", # Role namespace. + "job": { + "errorCode": 42, + "location": "A String", + "name": "A String", + "state": "A String", + }, + "kernelRootkit": { + "name": "A String", + "unexpectedCodeModification": True or False, + "unexpectedFtraceHandler": True or False, + "unexpectedInterruptHandler": True or False, + "unexpectedKernelCodePages": True or False, + "unexpectedKprobeHandler": True or False, + "unexpectedProcessesInRunqueue": True or False, + "unexpectedReadOnlyDataModification": True or False, + "unexpectedSystemCallHandler": True or False, + }, + "kubernetes": { + "accessReviews": [ + { + "group": "A String", + "name": "A String", + "ns": "A String", + "resource": "A String", + "subresource": "A String", + "verb": "A String", + "version": "A String", + }, + ], + "bindings": [ + { + "name": "A String", + "ns": "A String", + "role": { + "kind": "A String", + "name": "A String", + "ns": "A String", }, - "subjects": [ # Represents one or more subjects that are bound to the role. Not always available for PATCH requests. - { # Represents a Kubernetes subject. - "kind": "A String", # Authentication type for the subject. - "name": "A String", # Name for the subject. - "ns": "A String", # Namespace for the subject. + "subjects": [ + { + "kind": "A String", + "name": "A String", + "ns": "A String", }, ], }, ], - "nodePools": [ # GKE [node pools](https://cloud.google.com/kubernetes-engine/docs/concepts/node-pools) associated with the finding. This field contains node pool information for each node, when it is available. - { # Provides GKE node pool information. - "name": "A String", # Kubernetes node pool name. - "nodes": [ # Nodes associated with the finding. - { # Kubernetes nodes associated with the finding. - "name": "A String", # [Full resource name](https://google.aip.dev/122#full-resource-names) of the Compute Engine VM running the cluster node. + "nodePools": [ + { + "name": "A String", + "nodes": [ + { + "name": "A String", }, ], }, ], - "nodes": [ # Provides Kubernetes [node](https://cloud.google.com/kubernetes-engine/docs/concepts/cluster-architecture#nodes) information. - { # Kubernetes nodes associated with the finding. - "name": "A String", # [Full resource name](https://google.aip.dev/122#full-resource-names) of the Compute Engine VM running the cluster node. + "nodes": [ + { + "name": "A String", }, ], - "objects": [ # Kubernetes objects related to the finding. - { # Kubernetes object related to the finding, uniquely identified by GKNN. Used if the object Kind is not one of Pod, Node, NodePool, Binding, or AccessReview. - "containers": [ # Pod containers associated with this finding, if any. - { # Container associated with the finding. - "createTime": "A String", # The time that the container was created. - "imageId": "A String", # Optional container image ID, if provided by the container runtime. Uniquely identifies the container image launched using a container image digest. - "labels": [ # Container labels, as provided by the container runtime. - { # Represents a generic name-value label. A label has separate name and value fields to support filtering with the `contains()` function. For more information, see [Filtering on array-type fields](https://cloud.google.com/security-command-center/docs/how-to-api-list-findings#array-contains-filtering). - "name": "A String", # Name of the label. - "value": "A String", # Value that corresponds to the label's name. + "objects": [ + { + "containers": [ + { + "createTime": "A String", + "imageId": "A String", + "labels": [ + { + "name": "A String", + "value": "A String", }, ], - "name": "A String", # Name of the container. - "uri": "A String", # Container image URI provided when configuring a pod or container. This string can identify a container image version using mutable tags. + "name": "A String", + "uri": "A String", }, ], - "group": "A String", # Kubernetes object group, such as "policy.k8s.io/v1". - "kind": "A String", # Kubernetes object kind, such as "Namespace". - "name": "A String", # Kubernetes object name. For details see https://kubernetes.io/docs/concepts/overview/working-with-objects/names/. - "ns": "A String", # Kubernetes object namespace. Must be a valid DNS label. Named "ns" to avoid collision with C++ namespace keyword. For details see https://kubernetes.io/docs/tasks/administer-cluster/namespaces/. - }, - ], - "pods": [ # Kubernetes [Pods](https://cloud.google.com/kubernetes-engine/docs/concepts/pod) associated with the finding. This field contains Pod records for each container that is owned by a Pod. - { # A Kubernetes Pod. - "containers": [ # Pod containers associated with this finding, if any. - { # Container associated with the finding. - "createTime": "A String", # The time that the container was created. - "imageId": "A String", # Optional container image ID, if provided by the container runtime. Uniquely identifies the container image launched using a container image digest. - "labels": [ # Container labels, as provided by the container runtime. - { # Represents a generic name-value label. A label has separate name and value fields to support filtering with the `contains()` function. For more information, see [Filtering on array-type fields](https://cloud.google.com/security-command-center/docs/how-to-api-list-findings#array-contains-filtering). - "name": "A String", # Name of the label. - "value": "A String", # Value that corresponds to the label's name. + "group": "A String", + "kind": "A String", + "name": "A String", + "ns": "A String", + }, + ], + "pods": [ + { + "containers": [ + { + "createTime": "A String", + "imageId": "A String", + "labels": [ + { + "name": "A String", + "value": "A String", }, ], - "name": "A String", # Name of the container. - "uri": "A String", # Container image URI provided when configuring a pod or container. This string can identify a container image version using mutable tags. + "name": "A String", + "uri": "A String", }, ], - "labels": [ # Pod labels. For Kubernetes containers, these are applied to the container. - { # Represents a generic name-value label. A label has separate name and value fields to support filtering with the `contains()` function. For more information, see [Filtering on array-type fields](https://cloud.google.com/security-command-center/docs/how-to-api-list-findings#array-contains-filtering). - "name": "A String", # Name of the label. - "value": "A String", # Value that corresponds to the label's name. + "labels": [ + { + "name": "A String", + "value": "A String", }, ], - "name": "A String", # Kubernetes Pod name. - "ns": "A String", # Kubernetes Pod namespace. + "name": "A String", + "ns": "A String", }, ], - "roles": [ # Provides Kubernetes role information for findings that involve [Roles or ClusterRoles](https://cloud.google.com/kubernetes-engine/docs/how-to/role-based-access-control). - { # Kubernetes Role or ClusterRole. - "kind": "A String", # Role type. - "name": "A String", # Role name. - "ns": "A String", # Role namespace. + "roles": [ + { + "kind": "A String", + "name": "A String", + "ns": "A String", }, ], }, - "loadBalancers": [ # The load balancers associated with the finding. - { # Contains information related to the load balancer associated with the finding. - "name": "A String", # The name of the load balancer associated with the finding. + "loadBalancers": [ + { + "name": "A String", }, ], - "logEntries": [ # Log entries that are relevant to the finding. - { # An individual entry in a log. - "cloudLoggingEntry": { # Metadata taken from a [Cloud Logging LogEntry](https://cloud.google.com/logging/docs/reference/v2/rest/v2/LogEntry) # An individual entry in a log stored in Cloud Logging. - "insertId": "A String", # A unique identifier for the log entry. - "logId": "A String", # The type of the log (part of `log_name`. `log_name` is the resource name of the log to which this log entry belongs). For example: `cloudresourcemanager.googleapis.com/activity`. Note that this field is not URL-encoded, unlike the `LOG_ID` field in `LogEntry`. - "resourceContainer": "A String", # The organization, folder, or project of the monitored resource that produced this log entry. - "timestamp": "A String", # The time the event described by the log entry occurred. + "logEntries": [ + { + "cloudLoggingEntry": { + "insertId": "A String", + "logId": "A String", + "resourceContainer": "A String", + "timestamp": "A String", }, }, ], - "mitreAttack": { # MITRE ATT&CK tactics and techniques related to this finding. See: https://attack.mitre.org # MITRE ATT&CK tactics and techniques related to this finding. See: https://attack.mitre.org - "additionalTactics": [ # Additional MITRE ATT&CK tactics related to this finding, if any. + "mitreAttack": { + "additionalTactics": [ "A String", ], - "additionalTechniques": [ # Additional MITRE ATT&CK techniques related to this finding, if any, along with any of their respective parent techniques. + "additionalTechniques": [ "A String", ], - "primaryTactic": "A String", # The MITRE ATT&CK tactic most closely represented by this finding, if any. - "primaryTechniques": [ # The MITRE ATT&CK technique most closely represented by this finding, if any. primary_techniques is a repeated field because there are multiple levels of MITRE ATT&CK techniques. If the technique most closely represented by this finding is a sub-technique (e.g. `SCANNING_IP_BLOCKS`), both the sub-technique and its parent technique(s) will be listed (e.g. `SCANNING_IP_BLOCKS`, `ACTIVE_SCANNING`). + "primaryTactic": "A String", + "primaryTechniques": [ "A String", ], - "version": "A String", # The MITRE ATT&CK version referenced by the above fields. E.g. "8". + "version": "A String", }, - "moduleName": "A String", # Unique identifier of the module which generated the finding. Example: folders/598186756061/securityHealthAnalyticsSettings/customModules/56799441161885 - "mute": "A String", # Indicates the mute state of a finding (either muted, unmuted or undefined). Unlike other attributes of a finding, a finding provider shouldn't set the value of mute. - "muteInfo": { # Mute information about the finding, including whether the finding has a static mute or any matching dynamic mute rules. # Output only. The mute information regarding this finding. - "dynamicMuteRecords": [ # The list of dynamic mute rules that currently match the finding. - { # The record of a dynamic mute rule that matches the finding. - "matchTime": "A String", # When the dynamic mute rule first matched the finding. - "muteConfig": "A String", # The relative resource name of the mute rule, represented by a mute config, that created this record, for example `organizations/123/muteConfigs/mymuteconfig` or `organizations/123/locations/global/muteConfigs/mymuteconfig`. + "moduleName": "A String", + "mute": "A String", + "muteInfo": { + "dynamicMuteRecords": [ + { + "matchTime": "A String", + "muteConfig": "A String", }, ], - "staticMute": { # Information about the static mute state. A static mute state overrides any dynamic mute rules that apply to this finding. The static mute state can be set by a static mute rule or by muting the finding directly. # If set, the static mute applied to this finding. Static mutes override dynamic mutes. If unset, there is no static mute. - "applyTime": "A String", # When the static mute was applied. - "state": "A String", # The static mute state. If the value is `MUTED` or `UNMUTED`, then the finding's overall mute state will have the same value. + "staticMute": { + "applyTime": "A String", + "state": "A String", }, }, - "muteInitiator": "A String", # Records additional information about the mute operation, for example, the [mute configuration](/security-command-center/docs/how-to-mute-findings) that muted the finding and the user who muted the finding. - "muteUpdateTime": "A String", # Output only. The most recent time this finding was muted or unmuted. - "name": "A String", # The [relative resource name](https://cloud.google.com/apis/design/resource_names#relative_resource_name) of the finding. Example: "organizations/{organization_id}/sources/{source_id}/findings/{finding_id}", "folders/{folder_id}/sources/{source_id}/findings/{finding_id}", "projects/{project_id}/sources/{source_id}/findings/{finding_id}". - "networks": [ # Represents the VPC networks that the resource is attached to. - { # Contains information about a VPC network associated with the finding. - "name": "A String", # The name of the VPC network resource, for example, `//compute.googleapis.com/projects/my-project/global/networks/my-network`. + "muteInitiator": "A String", + "muteUpdateTime": "A String", + "name": "A String", + "networks": [ + { + "name": "A String", }, ], - "nextSteps": "A String", # Steps to address the finding. - "notebook": { # Represents a Jupyter notebook IPYNB file, such as a [Colab Enterprise notebook](https://cloud.google.com/colab/docs/introduction) file, that is associated with a finding. # Notebook associated with the finding. - "lastAuthor": "A String", # The user ID of the latest author to modify the notebook. - "name": "A String", # The name of the notebook. - "notebookUpdateTime": "A String", # The most recent time the notebook was updated. - "service": "A String", # The source notebook service, for example, "Colab Enterprise". + "nextSteps": "A String", + "notebook": { + "lastAuthor": "A String", + "name": "A String", + "notebookUpdateTime": "A String", + "service": "A String", }, - "orgPolicies": [ # Contains information about the org policies associated with the finding. - { # Contains information about the org policies associated with the finding. - "name": "A String", # The resource name of the org policy. Example: "organizations/{organization_id}/policies/{constraint_name}" + "orgPolicies": [ + { + "name": "A String", }, ], - "parent": "A String", # The relative resource name of the source the finding belongs to. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name This field is immutable after creation time. For example: "organizations/{organization_id}/sources/{source_id}" - "parentDisplayName": "A String", # Output only. The human readable display name of the finding source such as "Event Threat Detection" or "Security Health Analytics". - "policyViolationSummary": { # Metadata summarizing policy violations of child resources of the affected resource. `finding_category` and `resource` determine the exact semantics of the counts. For example, when category=DATA_SECURITY_POSTURE_OBJECT_PUBLIC_ACCESS_VIOLATION and resource='storage.googleapis.com/buckets/my-bucket-name' then this counts the number of Cloud Storage objects in my-bucket-name which violate a Public Access control. # PolicyViolationSummary associated with the finding. - "conformantResourcesCount": "A String", # Total number of child resources that conform to the policy. - "evaluationErrorsCount": "A String", # Number of child resources for which errors during evaluation occurred. The evaluation result for these child resources is effectively "unknown". - "outOfScopeResourcesCount": "A String", # Total count of child resources which were not in scope for evaluation. - "policyViolationsCount": "A String", # Count of child resources in violation of the policy. - }, - "processes": [ # Represents operating system processes associated with the Finding. - { # Represents an operating system process. - "args": [ # Process arguments as JSON encoded strings. + "parent": "A String", + "parentDisplayName": "A String", + "policyViolationSummary": { + "conformantResourcesCount": "A String", + "evaluationErrorsCount": "A String", + "outOfScopeResourcesCount": "A String", + "policyViolationsCount": "A String", + }, + "processes": [ + { + "args": [ "A String", ], - "argumentsTruncated": True or False, # True if `args` is incomplete. - "binary": { # File information about the related binary/library used by an executable, or the script used by a script interpreter # File information for the process executable. - "contents": "A String", # Prefix of the file contents as a JSON-encoded string. - "diskPath": { # Path of the file in terms of underlying disk/partition identifiers. # Path of the file in terms of underlying disk/partition identifiers. - "partitionUuid": "A String", # UUID of the partition (format https://wiki.archlinux.org/title/persistent_block_device_naming#by-uuid) - "relativePath": "A String", # Relative path of the file in the partition as a JSON encoded string. Example: /home/user1/executable_file.sh + "argumentsTruncated": True or False, + "binary": { + "contents": "A String", + "diskPath": { + "partitionUuid": "A String", + "relativePath": "A String", }, - "fileLoadState": "A String", # The load state of the file. - "hashedSize": "A String", # The length in bytes of the file prefix that was hashed. If hashed_size == size, any hashes reported represent the entire file. - "operations": [ # Operation(s) performed on a file. - { # Operation(s) performed on a file. - "type": "A String", # The type of the operation + "fileLoadState": "A String", + "hashedSize": "A String", + "operations": [ + { + "type": "A String", }, ], - "partiallyHashed": True or False, # True when the hash covers only a prefix of the file. - "path": "A String", # Absolute path of the file as a JSON encoded string. - "sha256": "A String", # SHA256 hash of the first hashed_size bytes of the file encoded as a hex string. If hashed_size == size, sha256 represents the SHA256 hash of the entire file. - "size": "A String", # Size of the file in bytes. - }, - "envVariables": [ # Process environment variables. - { # A name-value pair representing an environment variable used in an operating system process. - "name": "A String", # Environment variable name as a JSON encoded string. - "val": "A String", # Environment variable value as a JSON encoded string. + "partiallyHashed": True or False, + "path": "A String", + "sha256": "A String", + "size": "A String", + }, + "envVariables": [ + { + "name": "A String", + "val": "A String", }, ], - "envVariablesTruncated": True or False, # True if `env_variables` is incomplete. - "libraries": [ # File information for libraries loaded by the process. - { # File information about the related binary/library used by an executable, or the script used by a script interpreter - "contents": "A String", # Prefix of the file contents as a JSON-encoded string. - "diskPath": { # Path of the file in terms of underlying disk/partition identifiers. # Path of the file in terms of underlying disk/partition identifiers. - "partitionUuid": "A String", # UUID of the partition (format https://wiki.archlinux.org/title/persistent_block_device_naming#by-uuid) - "relativePath": "A String", # Relative path of the file in the partition as a JSON encoded string. Example: /home/user1/executable_file.sh + "envVariablesTruncated": True or False, + "libraries": [ + { + "contents": "A String", + "diskPath": { + "partitionUuid": "A String", + "relativePath": "A String", }, - "fileLoadState": "A String", # The load state of the file. - "hashedSize": "A String", # The length in bytes of the file prefix that was hashed. If hashed_size == size, any hashes reported represent the entire file. - "operations": [ # Operation(s) performed on a file. - { # Operation(s) performed on a file. - "type": "A String", # The type of the operation + "fileLoadState": "A String", + "hashedSize": "A String", + "operations": [ + { + "type": "A String", }, ], - "partiallyHashed": True or False, # True when the hash covers only a prefix of the file. - "path": "A String", # Absolute path of the file as a JSON encoded string. - "sha256": "A String", # SHA256 hash of the first hashed_size bytes of the file encoded as a hex string. If hashed_size == size, sha256 represents the SHA256 hash of the entire file. - "size": "A String", # Size of the file in bytes. + "partiallyHashed": True or False, + "path": "A String", + "sha256": "A String", + "size": "A String", }, ], - "name": "A String", # The process name, as displayed in utilities like `top` and `ps`. This name can be accessed through `/proc/[pid]/comm` and changed with `prctl(PR_SET_NAME)`. - "parentPid": "A String", # The parent process ID. - "pid": "A String", # The process ID. - "script": { # File information about the related binary/library used by an executable, or the script used by a script interpreter # When the process represents the invocation of a script, `binary` provides information about the interpreter, while `script` provides information about the script file provided to the interpreter. - "contents": "A String", # Prefix of the file contents as a JSON-encoded string. - "diskPath": { # Path of the file in terms of underlying disk/partition identifiers. # Path of the file in terms of underlying disk/partition identifiers. - "partitionUuid": "A String", # UUID of the partition (format https://wiki.archlinux.org/title/persistent_block_device_naming#by-uuid) - "relativePath": "A String", # Relative path of the file in the partition as a JSON encoded string. Example: /home/user1/executable_file.sh + "name": "A String", + "parentPid": "A String", + "pid": "A String", + "script": { + "contents": "A String", + "diskPath": { + "partitionUuid": "A String", + "relativePath": "A String", }, - "fileLoadState": "A String", # The load state of the file. - "hashedSize": "A String", # The length in bytes of the file prefix that was hashed. If hashed_size == size, any hashes reported represent the entire file. - "operations": [ # Operation(s) performed on a file. - { # Operation(s) performed on a file. - "type": "A String", # The type of the operation + "fileLoadState": "A String", + "hashedSize": "A String", + "operations": [ + { + "type": "A String", }, ], - "partiallyHashed": True or False, # True when the hash covers only a prefix of the file. - "path": "A String", # Absolute path of the file as a JSON encoded string. - "sha256": "A String", # SHA256 hash of the first hashed_size bytes of the file encoded as a hex string. If hashed_size == size, sha256 represents the SHA256 hash of the entire file. - "size": "A String", # Size of the file in bytes. + "partiallyHashed": True or False, + "path": "A String", + "sha256": "A String", + "size": "A String", }, - "userId": "A String", # The ID of the user that executed the process. E.g. If this is the root user this will always be 0. + "userId": "A String", }, ], - "resourceName": "A String", # For findings on Google Cloud resources, the full resource name of the Google Cloud resource this finding is for. See: https://cloud.google.com/apis/design/resource_names#full_resource_name When the finding is for a non-Google Cloud resource, the resourceName can be a customer or partner defined string. This field is immutable after creation time. - "secret": { # Details about a secret or credential associated with the finding. # Secret associated with the finding. - "environmentVariable": { # Environment variable containing the secret. # The environment variable containing the secret. - "key": "A String", # Environment variable name as a JSON encoded string. Note that value is not included since the value contains the secret data, which is sensitive core content. + "resourceName": "A String", + "secret": { + "environmentVariable": { + "key": "A String", }, - "filePath": { # File path containing the secret. # The file containing the secret. - "path": "A String", # Path to the file. + "filePath": { + "path": "A String", }, - "status": { # The status of the secret. # The status of the secret. - "lastUpdatedTime": "A String", # Time that the secret was found. - "validity": "A String", # The validity of the secret. + "status": { + "lastUpdatedTime": "A String", + "validity": "A String", }, - "type": "A String", # The type of secret, for example, GCP_API_KEY. + "type": "A String", }, - "securityMarks": { # User specified security marks that are attached to the parent Security Command Center resource. Security marks are scoped within a Security Command Center organization -- they can be modified and viewed by all users who have proper permissions on the organization. # Output only. User specified security marks. These marks are entirely managed by the user and come from the SecurityMarks resource that belongs to the finding. - "canonicalName": "A String", # The canonical name of the marks. Examples: "organizations/{organization_id}/assets/{asset_id}/securityMarks" "folders/{folder_id}/assets/{asset_id}/securityMarks" "projects/{project_number}/assets/{asset_id}/securityMarks" "organizations/{organization_id}/sources/{source_id}/findings/{finding_id}/securityMarks" "folders/{folder_id}/sources/{source_id}/findings/{finding_id}/securityMarks" "projects/{project_number}/sources/{source_id}/findings/{finding_id}/securityMarks" - "marks": { # Mutable user specified security marks belonging to the parent resource. Constraints are as follows: * Keys and values are treated as case insensitive * Keys must be between 1 - 256 characters (inclusive) * Keys must be letters, numbers, underscores, or dashes * Values have leading and trailing whitespace trimmed, remaining characters must be between 1 - 4096 characters (inclusive) + "securityMarks": { + "canonicalName": "A String", + "marks": { "a_key": "A String", }, - "name": "A String", # The relative resource name of the SecurityMarks. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Examples: "organizations/{organization_id}/assets/{asset_id}/securityMarks" "organizations/{organization_id}/sources/{source_id}/findings/{finding_id}/securityMarks". + "name": "A String", }, - "securityPosture": { # Represents a posture that is deployed on Google Cloud by the Security Command Center Posture Management service. A posture contains one or more policy sets. A policy set is a group of policies that enforce a set of security rules on Google Cloud. # The security posture associated with the finding. - "changedPolicy": "A String", # The name of the updated policy, for example, `projects/{project_id}/policies/{constraint_name}`. - "name": "A String", # Name of the posture, for example, `CIS-Posture`. - "policy": "A String", # The ID of the updated policy, for example, `compute-policy-1`. - "policyDriftDetails": [ # The details about a change in an updated policy that violates the deployed posture. - { # The policy field that violates the deployed posture and its expected and detected values. - "detectedValue": "A String", # The detected value that violates the deployed posture, for example, `false` or `allowed_values={"projects/22831892"}`. - "expectedValue": "A String", # The value of this field that was configured in a posture, for example, `true` or `allowed_values={"projects/29831892"}`. - "field": "A String", # The name of the updated field, for example constraint.implementation.policy_rules[0].enforce + "securityPosture": { + "changedPolicy": "A String", + "name": "A String", + "policy": "A String", + "policyDriftDetails": [ + { + "detectedValue": "A String", + "expectedValue": "A String", + "field": "A String", }, ], - "policySet": "A String", # The name of the updated policyset, for example, `cis-policyset`. - "postureDeployment": "A String", # The name of the posture deployment, for example, `organizations/{org_id}/posturedeployments/{posture_deployment_id}`. - "postureDeploymentResource": "A String", # The project, folder, or organization on which the posture is deployed, for example, `projects/{project_number}`. - "revisionId": "A String", # The version of the posture, for example, `c7cfa2a8`. + "policySet": "A String", + "postureDeployment": "A String", + "postureDeploymentResource": "A String", + "revisionId": "A String", }, - "severity": "A String", # The severity of the finding. This field is managed by the source that writes the finding. - "sourceProperties": { # Source specific properties. These properties are managed by the source that writes the finding. The key names in the source_properties map must be between 1 and 255 characters, and must start with a letter and contain alphanumeric characters or underscores only. + "severity": "A String", + "sourceProperties": { "a_key": "", }, - "state": "A String", # The state of the finding. - "toxicCombination": { # Contains details about a group of security issues that, when the issues occur together, represent a greater risk than when the issues occur independently. A group of such issues is referred to as a toxic combination. # Contains details about a group of security issues that, when the issues occur together, represent a greater risk than when the issues occur independently. A group of such issues is referred to as a toxic combination. This field cannot be updated. Its value is ignored in all update requests. - "attackExposureScore": 3.14, # The [Attack exposure score](https://cloud.google.com/security-command-center/docs/attack-exposure-learn#attack_exposure_scores) of this toxic combination. The score is a measure of how much this toxic combination exposes one or more high-value resources to potential attack. - "relatedFindings": [ # List of resource names of findings associated with this toxic combination. For example, `organizations/123/sources/456/findings/789`. + "state": "A String", + "toxicCombination": { + "attackExposureScore": 3.14, + "relatedFindings": [ "A String", ], }, - "vertexAi": { # Vertex AI-related information associated with the finding. # VertexAi associated with the finding. - "datasets": [ # Datasets associated with the finding. - { # Vertex AI dataset associated with the finding. - "displayName": "A String", # The user defined display name of dataset, e.g. plants-dataset - "name": "A String", # Resource name of the dataset, e.g. projects/{project}/locations/{location}/datasets/2094040236064505856 - "source": "A String", # Data source, such as BigQuery source URI, e.g. bq://scc-nexus-test.AIPPtest.gsod - }, - ], - "pipelines": [ # Pipelines associated with the finding. - { # Vertex AI training pipeline associated with the finding. - "displayName": "A String", # The user defined display name of pipeline, e.g. plants-classification - "name": "A String", # Resource name of the pipeline, e.g. projects/{project}/locations/{location}/trainingPipelines/5253428229225578496 - }, - ], - }, - "vulnerability": { # Refers to common vulnerability fields e.g. cve, cvss, cwe etc. # Represents vulnerability-specific fields like CVE and CVSS scores. CVE stands for Common Vulnerabilities and Exposures (https://cve.mitre.org/about/) - "cve": { # CVE stands for Common Vulnerabilities and Exposures. Information from the [CVE record](https://www.cve.org/ResourcesSupport/Glossary) that describes this vulnerability. # CVE stands for Common Vulnerabilities and Exposures (https://cve.mitre.org/about/) - "cvssv3": { # Common Vulnerability Scoring System version 3. # Describe Common Vulnerability Scoring System specified at https://www.first.org/cvss/v3.1/specification-document - "attackComplexity": "A String", # This metric describes the conditions beyond the attacker's control that must exist in order to exploit the vulnerability. - "attackVector": "A String", # Base Metrics Represents the intrinsic characteristics of a vulnerability that are constant over time and across user environments. This metric reflects the context by which vulnerability exploitation is possible. - "availabilityImpact": "A String", # This metric measures the impact to the availability of the impacted component resulting from a successfully exploited vulnerability. - "baseScore": 3.14, # The base score is a function of the base metric scores. - "confidentialityImpact": "A String", # This metric measures the impact to the confidentiality of the information resources managed by a software component due to a successfully exploited vulnerability. - "integrityImpact": "A String", # This metric measures the impact to integrity of a successfully exploited vulnerability. - "privilegesRequired": "A String", # This metric describes the level of privileges an attacker must possess before successfully exploiting the vulnerability. - "scope": "A String", # The Scope metric captures whether a vulnerability in one vulnerable component impacts resources in components beyond its security scope. - "userInteraction": "A String", # This metric captures the requirement for a human user, other than the attacker, to participate in the successful compromise of the vulnerable component. - }, - "exploitReleaseDate": "A String", # Date the first publicly available exploit or PoC was released. - "exploitationActivity": "A String", # The exploitation activity of the vulnerability in the wild. - "firstExploitationDate": "A String", # Date of the earliest known exploitation. - "id": "A String", # The unique identifier for the vulnerability. e.g. CVE-2021-34527 - "impact": "A String", # The potential impact of the vulnerability if it was to be exploited. - "observedInTheWild": True or False, # Whether or not the vulnerability has been observed in the wild. - "references": [ # Additional information about the CVE. e.g. https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2021-34527 - { # Additional Links - "source": "A String", # Source of the reference e.g. NVD - "uri": "A String", # Uri for the mentioned source e.g. https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2021-34527. + "vertexAi": { + "datasets": [ + { + "displayName": "A String", + "name": "A String", + "source": "A String", + }, + ], + "pipelines": [ + { + "displayName": "A String", + "name": "A String", + }, + ], + }, + "vulnerability": { + "cve": { + "cvssv3": { + "attackComplexity": "A String", + "attackVector": "A String", + "availabilityImpact": "A String", + "baseScore": 3.14, + "confidentialityImpact": "A String", + "integrityImpact": "A String", + "privilegesRequired": "A String", + "scope": "A String", + "userInteraction": "A String", + }, + "exploitReleaseDate": "A String", + "exploitationActivity": "A String", + "firstExploitationDate": "A String", + "id": "A String", + "impact": "A String", + "observedInTheWild": True or False, + "references": [ + { + "source": "A String", + "uri": "A String", }, ], - "upstreamFixAvailable": True or False, # Whether upstream fix is available for the CVE. - "zeroDay": True or False, # Whether or not the vulnerability was zero day when the finding was published. - }, - "cwes": [ # Represents one or more Common Weakness Enumeration (CWE) information on this vulnerability. - { # CWE stands for Common Weakness Enumeration. Information about this weakness, as described by [CWE](https://cwe.mitre.org/). - "id": "A String", # The CWE identifier, e.g. CWE-94 - "references": [ # Any reference to the details on the CWE, for example, https://cwe.mitre.org/data/definitions/94.html - { # Additional Links - "source": "A String", # Source of the reference e.g. NVD - "uri": "A String", # Uri for the mentioned source e.g. https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2021-34527. + "upstreamFixAvailable": True or False, + "zeroDay": True or False, + }, + "cwes": [ + { + "id": "A String", + "references": [ + { + "source": "A String", + "uri": "A String", }, ], }, ], - "fixedPackage": { # Package is a generic definition of a package. # The fixed package is relevant to the finding. - "cpeUri": "A String", # The CPE URI where the vulnerability was detected. - "packageName": "A String", # The name of the package where the vulnerability was detected. - "packageType": "A String", # Type of package, for example, os, maven, or go. - "packageVersion": "A String", # The version of the package. + "fixedPackage": { + "cpeUri": "A String", + "packageName": "A String", + "packageType": "A String", + "packageVersion": "A String", }, - "offendingPackage": { # Package is a generic definition of a package. # The offending package is relevant to the finding. - "cpeUri": "A String", # The CPE URI where the vulnerability was detected. - "packageName": "A String", # The name of the package where the vulnerability was detected. - "packageType": "A String", # Type of package, for example, os, maven, or go. - "packageVersion": "A String", # The version of the package. + "offendingPackage": { + "cpeUri": "A String", + "packageName": "A String", + "packageType": "A String", + "packageVersion": "A String", }, - "providerRiskScore": "A String", # Provider provided risk_score based on multiple factors. The higher the risk score, the more risky the vulnerability is. - "reachable": True or False, # Represents whether the vulnerability is reachable (detected via static analysis) - "securityBulletin": { # SecurityBulletin are notifications of vulnerabilities of Google products. # The security bulletin is relevant to this finding. - "bulletinId": "A String", # ID of the bulletin corresponding to the vulnerability. - "submissionTime": "A String", # Submission time of this Security Bulletin. - "suggestedUpgradeVersion": "A String", # This represents a version that the cluster receiving this notification should be upgraded to, based on its current version. For example, 1.15.0 + "providerRiskScore": "A String", + "reachable": True or False, + "securityBulletin": { + "bulletinId": "A String", + "submissionTime": "A String", + "suggestedUpgradeVersion": "A String", }, }, }
@@ -6086,23 +6086,23 @@

Method Details

updateSecurityMarks(name, body=None, startTime=None, updateMask=None, x__xgafv=None) -
Updates security marks.
+  
 
 Args:
-  name: string, The relative resource name of the SecurityMarks. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Examples: "organizations/{organization_id}/assets/{asset_id}/securityMarks" "organizations/{organization_id}/sources/{source_id}/findings/{finding_id}/securityMarks". (required)
+  name: string, A parameter (required)
   body: object, The request body.
     The object takes the form of:
 
-{ # User specified security marks that are attached to the parent Security Command Center resource. Security marks are scoped within a Security Command Center organization -- they can be modified and viewed by all users who have proper permissions on the organization.
-  "canonicalName": "A String", # The canonical name of the marks. Examples: "organizations/{organization_id}/assets/{asset_id}/securityMarks" "folders/{folder_id}/assets/{asset_id}/securityMarks" "projects/{project_number}/assets/{asset_id}/securityMarks" "organizations/{organization_id}/sources/{source_id}/findings/{finding_id}/securityMarks" "folders/{folder_id}/sources/{source_id}/findings/{finding_id}/securityMarks" "projects/{project_number}/sources/{source_id}/findings/{finding_id}/securityMarks"
-  "marks": { # Mutable user specified security marks belonging to the parent resource. Constraints are as follows: * Keys and values are treated as case insensitive * Keys must be between 1 - 256 characters (inclusive) * Keys must be letters, numbers, underscores, or dashes * Values have leading and trailing whitespace trimmed, remaining characters must be between 1 - 4096 characters (inclusive)
+{
+  "canonicalName": "A String",
+  "marks": {
     "a_key": "A String",
   },
-  "name": "A String", # The relative resource name of the SecurityMarks. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Examples: "organizations/{organization_id}/assets/{asset_id}/securityMarks" "organizations/{organization_id}/sources/{source_id}/findings/{finding_id}/securityMarks".
+  "name": "A String",
 }
 
-  startTime: string, The time at which the updated SecurityMarks take effect. If not set uses current server time. Updates will be applied to the SecurityMarks that are active immediately preceding this time. Must be earlier or equal to the server time.
-  updateMask: string, The FieldMask to use when updating the security marks resource. The field mask must not contain duplicate fields. If empty or set to "marks", all marks will be replaced. Individual marks can be updated using "marks.".
+  startTime: string, A parameter
+  updateMask: string, A parameter
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -6111,12 +6111,12 @@ 

Method Details

Returns: An object of the form: - { # User specified security marks that are attached to the parent Security Command Center resource. Security marks are scoped within a Security Command Center organization -- they can be modified and viewed by all users who have proper permissions on the organization. - "canonicalName": "A String", # The canonical name of the marks. Examples: "organizations/{organization_id}/assets/{asset_id}/securityMarks" "folders/{folder_id}/assets/{asset_id}/securityMarks" "projects/{project_number}/assets/{asset_id}/securityMarks" "organizations/{organization_id}/sources/{source_id}/findings/{finding_id}/securityMarks" "folders/{folder_id}/sources/{source_id}/findings/{finding_id}/securityMarks" "projects/{project_number}/sources/{source_id}/findings/{finding_id}/securityMarks" - "marks": { # Mutable user specified security marks belonging to the parent resource. Constraints are as follows: * Keys and values are treated as case insensitive * Keys must be between 1 - 256 characters (inclusive) * Keys must be letters, numbers, underscores, or dashes * Values have leading and trailing whitespace trimmed, remaining characters must be between 1 - 4096 characters (inclusive) + { + "canonicalName": "A String", + "marks": { "a_key": "A String", }, - "name": "A String", # The relative resource name of the SecurityMarks. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Examples: "organizations/{organization_id}/assets/{asset_id}/securityMarks" "organizations/{organization_id}/sources/{source_id}/findings/{finding_id}/securityMarks". + "name": "A String", }
diff --git a/docs/dyn/securitycenter_v1.organizations.sources.html b/docs/dyn/securitycenter_v1.organizations.sources.html index 2039e67113..822878fc09 100644 --- a/docs/dyn/securitycenter_v1.organizations.sources.html +++ b/docs/dyn/securitycenter_v1.organizations.sources.html @@ -84,28 +84,28 @@

Instance Methods

Close httplib2 connections.

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

-

Creates a source.

+

get(name, x__xgafv=None)

-

Gets a source.

+

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

-

Gets the access control policy on the specified Source.

+

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

-

Lists all sources belonging to an organization.

+

list_next()

Retrieves the next page of results.

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

-

Updates a source.

+

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

-

Sets the access control policy on the specified Source.

+

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

-

Returns the permissions that a caller has on the specified source.

+

Method Details

close() @@ -114,18 +114,18 @@

Method Details

create(parent, body=None, x__xgafv=None) -
Creates a source.
+  
 
 Args:
-  parent: string, Required. Resource name of the new source's parent. Its format should be `organizations/[organization_id]`. (required)
+  parent: string, A parameter (required)
   body: object, The request body.
     The object takes the form of:
 
-{ # Security Command Center finding source. A finding source is an entity or a mechanism that can produce a finding. A source is like a container of findings that come from the same scanner, logger, monitor, and other tools.
-  "canonicalName": "A String", # The canonical name of the finding source. It's either "organizations/{organization_id}/sources/{source_id}", "folders/{folder_id}/sources/{source_id}", or "projects/{project_number}/sources/{source_id}", depending on the closest CRM ancestor of the resource associated with the finding.
-  "description": "A String", # The description of the source (max of 1024 characters). Example: "Web Security Scanner is a web security scanner for common vulnerabilities in App Engine applications. It can automatically scan and detect four common vulnerabilities, including cross-site-scripting (XSS), Flash injection, mixed content (HTTP in HTTPS), and outdated or insecure libraries."
-  "displayName": "A String", # The source's display name. A source's display name must be unique amongst its siblings, for example, two sources with the same parent can't share the same display name. The display name must have a length between 1 and 64 characters (inclusive).
-  "name": "A String", # The relative resource name of this source. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Example: "organizations/{organization_id}/sources/{source_id}"
+{
+  "canonicalName": "A String",
+  "description": "A String",
+  "displayName": "A String",
+  "name": "A String",
 }
 
   x__xgafv: string, V1 error format.
@@ -136,20 +136,20 @@ 

Method Details

Returns: An object of the form: - { # Security Command Center finding source. A finding source is an entity or a mechanism that can produce a finding. A source is like a container of findings that come from the same scanner, logger, monitor, and other tools. - "canonicalName": "A String", # The canonical name of the finding source. It's either "organizations/{organization_id}/sources/{source_id}", "folders/{folder_id}/sources/{source_id}", or "projects/{project_number}/sources/{source_id}", depending on the closest CRM ancestor of the resource associated with the finding. - "description": "A String", # The description of the source (max of 1024 characters). Example: "Web Security Scanner is a web security scanner for common vulnerabilities in App Engine applications. It can automatically scan and detect four common vulnerabilities, including cross-site-scripting (XSS), Flash injection, mixed content (HTTP in HTTPS), and outdated or insecure libraries." - "displayName": "A String", # The source's display name. A source's display name must be unique amongst its siblings, for example, two sources with the same parent can't share the same display name. The display name must have a length between 1 and 64 characters (inclusive). - "name": "A String", # The relative resource name of this source. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Example: "organizations/{organization_id}/sources/{source_id}" + { + "canonicalName": "A String", + "description": "A String", + "displayName": "A String", + "name": "A String", }
get(name, x__xgafv=None) -
Gets a source.
+  
 
 Args:
-  name: string, Required. Relative resource name of the source. Its format is `organizations/[organization_id]/source/[source_id]`. (required)
+  name: string, A parameter (required)
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -158,26 +158,26 @@ 

Method Details

Returns: An object of the form: - { # Security Command Center finding source. A finding source is an entity or a mechanism that can produce a finding. A source is like a container of findings that come from the same scanner, logger, monitor, and other tools. - "canonicalName": "A String", # The canonical name of the finding source. It's either "organizations/{organization_id}/sources/{source_id}", "folders/{folder_id}/sources/{source_id}", or "projects/{project_number}/sources/{source_id}", depending on the closest CRM ancestor of the resource associated with the finding. - "description": "A String", # The description of the source (max of 1024 characters). Example: "Web Security Scanner is a web security scanner for common vulnerabilities in App Engine applications. It can automatically scan and detect four common vulnerabilities, including cross-site-scripting (XSS), Flash injection, mixed content (HTTP in HTTPS), and outdated or insecure libraries." - "displayName": "A String", # The source's display name. A source's display name must be unique amongst its siblings, for example, two sources with the same parent can't share the same display name. The display name must have a length between 1 and 64 characters (inclusive). - "name": "A String", # The relative resource name of this source. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Example: "organizations/{organization_id}/sources/{source_id}" + { + "canonicalName": "A String", + "description": "A String", + "displayName": "A String", + "name": "A String", }
getIamPolicy(resource, body=None, x__xgafv=None) -
Gets the access control policy on the specified Source.
+  
 
 Args:
-  resource: string, REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. (required)
+  resource: string, A parameter (required)
   body: object, The request body.
     The object takes the form of:
 
-{ # Request message for `GetIamPolicy` method.
-  "options": { # Encapsulates settings provided to GetIamPolicy. # OPTIONAL: A `GetPolicyOptions` object for specifying options to `GetIamPolicy`.
-    "requestedPolicyVersion": 42, # Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+{
+  "options": {
+    "requestedPolicyVersion": 42,
   },
 }
 
@@ -189,47 +189,47 @@ 

Method Details

Returns: An object of the form: - { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). - "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. - { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. - "auditLogConfigs": [ # The configuration for logging of each type of permission. - { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. - "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. + { + "auditConfigs": [ + { + "auditLogConfigs": [ + { + "exemptedMembers": [ "A String", ], - "logType": "A String", # The log type that this config enables. + "logType": "A String", }, ], - "service": "A String", # Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services. + "service": "A String", }, ], - "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. - { # Associates `members`, or principals, with a `role`. - "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). - "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. - "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. - "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file. - "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. + "bindings": [ + { + "condition": { + "description": "A String", + "expression": "A String", + "location": "A String", + "title": "A String", }, - "members": [ # Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`. + "members": [ "A String", ], - "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles). + "role": "A String", }, ], - "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). + "etag": "A String", + "version": 42, }
list(parent, pageSize=None, pageToken=None, x__xgafv=None) -
Lists all sources belonging to an organization.
+  
 
 Args:
-  parent: string, Required. Resource name of the parent of sources to list. Its format should be `organizations/[organization_id]`, `folders/[folder_id]`, or `projects/[project_id]`. (required)
-  pageSize: integer, The maximum number of results to return in a single response. Default is 10, minimum is 1, maximum is 1000.
-  pageToken: string, The value returned by the last `ListSourcesResponse`; indicates that this is a continuation of a prior `ListSources` call, and that the system should return the next page of data.
+  parent: string, A parameter (required)
+  pageSize: integer, A parameter
+  pageToken: string, A parameter
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -238,14 +238,14 @@ 

Method Details

Returns: An object of the form: - { # Response message for listing sources. - "nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no more results. - "sources": [ # Sources belonging to the requested parent. - { # Security Command Center finding source. A finding source is an entity or a mechanism that can produce a finding. A source is like a container of findings that come from the same scanner, logger, monitor, and other tools. - "canonicalName": "A String", # The canonical name of the finding source. It's either "organizations/{organization_id}/sources/{source_id}", "folders/{folder_id}/sources/{source_id}", or "projects/{project_number}/sources/{source_id}", depending on the closest CRM ancestor of the resource associated with the finding. - "description": "A String", # The description of the source (max of 1024 characters). Example: "Web Security Scanner is a web security scanner for common vulnerabilities in App Engine applications. It can automatically scan and detect four common vulnerabilities, including cross-site-scripting (XSS), Flash injection, mixed content (HTTP in HTTPS), and outdated or insecure libraries." - "displayName": "A String", # The source's display name. A source's display name must be unique amongst its siblings, for example, two sources with the same parent can't share the same display name. The display name must have a length between 1 and 64 characters (inclusive). - "name": "A String", # The relative resource name of this source. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Example: "organizations/{organization_id}/sources/{source_id}" + { + "nextPageToken": "A String", + "sources": [ + { + "canonicalName": "A String", + "description": "A String", + "displayName": "A String", + "name": "A String", }, ], }
@@ -267,21 +267,21 @@

Method Details

patch(name, body=None, updateMask=None, x__xgafv=None) -
Updates a source.
+  
 
 Args:
-  name: string, The relative resource name of this source. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Example: "organizations/{organization_id}/sources/{source_id}" (required)
+  name: string, A parameter (required)
   body: object, The request body.
     The object takes the form of:
 
-{ # Security Command Center finding source. A finding source is an entity or a mechanism that can produce a finding. A source is like a container of findings that come from the same scanner, logger, monitor, and other tools.
-  "canonicalName": "A String", # The canonical name of the finding source. It's either "organizations/{organization_id}/sources/{source_id}", "folders/{folder_id}/sources/{source_id}", or "projects/{project_number}/sources/{source_id}", depending on the closest CRM ancestor of the resource associated with the finding.
-  "description": "A String", # The description of the source (max of 1024 characters). Example: "Web Security Scanner is a web security scanner for common vulnerabilities in App Engine applications. It can automatically scan and detect four common vulnerabilities, including cross-site-scripting (XSS), Flash injection, mixed content (HTTP in HTTPS), and outdated or insecure libraries."
-  "displayName": "A String", # The source's display name. A source's display name must be unique amongst its siblings, for example, two sources with the same parent can't share the same display name. The display name must have a length between 1 and 64 characters (inclusive).
-  "name": "A String", # The relative resource name of this source. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Example: "organizations/{organization_id}/sources/{source_id}"
+{
+  "canonicalName": "A String",
+  "description": "A String",
+  "displayName": "A String",
+  "name": "A String",
 }
 
-  updateMask: string, The FieldMask to use when updating the source resource. If empty all mutable fields will be updated.
+  updateMask: string, A parameter
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -290,56 +290,56 @@ 

Method Details

Returns: An object of the form: - { # Security Command Center finding source. A finding source is an entity or a mechanism that can produce a finding. A source is like a container of findings that come from the same scanner, logger, monitor, and other tools. - "canonicalName": "A String", # The canonical name of the finding source. It's either "organizations/{organization_id}/sources/{source_id}", "folders/{folder_id}/sources/{source_id}", or "projects/{project_number}/sources/{source_id}", depending on the closest CRM ancestor of the resource associated with the finding. - "description": "A String", # The description of the source (max of 1024 characters). Example: "Web Security Scanner is a web security scanner for common vulnerabilities in App Engine applications. It can automatically scan and detect four common vulnerabilities, including cross-site-scripting (XSS), Flash injection, mixed content (HTTP in HTTPS), and outdated or insecure libraries." - "displayName": "A String", # The source's display name. A source's display name must be unique amongst its siblings, for example, two sources with the same parent can't share the same display name. The display name must have a length between 1 and 64 characters (inclusive). - "name": "A String", # The relative resource name of this source. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Example: "organizations/{organization_id}/sources/{source_id}" + { + "canonicalName": "A String", + "description": "A String", + "displayName": "A String", + "name": "A String", }
setIamPolicy(resource, body=None, x__xgafv=None) -
Sets the access control policy on the specified Source.
+  
 
 Args:
-  resource: string, REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. (required)
+  resource: string, A parameter (required)
   body: object, The request body.
     The object takes the form of:
 
-{ # Request message for `SetIamPolicy` method.
-  "policy": { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). # REQUIRED: The complete policy to be applied to the `resource`. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Google Cloud services (such as Projects) might reject them.
-    "auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
-      { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging.
-        "auditLogConfigs": [ # The configuration for logging of each type of permission.
-          { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.
-            "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.
+{
+  "policy": {
+    "auditConfigs": [
+      {
+        "auditLogConfigs": [
+          {
+            "exemptedMembers": [
               "A String",
             ],
-            "logType": "A String", # The log type that this config enables.
+            "logType": "A String",
           },
         ],
-        "service": "A String", # Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services.
+        "service": "A String",
       },
     ],
-    "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`.
-      { # Associates `members`, or principals, with a `role`.
-        "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
-          "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
-          "expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
-          "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
-          "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
+    "bindings": [
+      {
+        "condition": {
+          "description": "A String",
+          "expression": "A String",
+          "location": "A String",
+          "title": "A String",
         },
-        "members": [ # Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
+        "members": [
           "A String",
         ],
-        "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles).
+        "role": "A String",
       },
     ],
-    "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).
+    "etag": "A String",
+    "version": 42,
   },
-  "updateMask": "A String", # OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only the fields in the mask will be modified. If no mask is provided, the following default mask is used: `paths: "bindings, etag"`
+  "updateMask": "A String",
 }
 
   x__xgafv: string, V1 error format.
@@ -350,50 +350,50 @@ 

Method Details

Returns: An object of the form: - { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). - "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. - { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. - "auditLogConfigs": [ # The configuration for logging of each type of permission. - { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. - "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. + { + "auditConfigs": [ + { + "auditLogConfigs": [ + { + "exemptedMembers": [ "A String", ], - "logType": "A String", # The log type that this config enables. + "logType": "A String", }, ], - "service": "A String", # Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services. + "service": "A String", }, ], - "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. - { # Associates `members`, or principals, with a `role`. - "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). - "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. - "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. - "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file. - "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. + "bindings": [ + { + "condition": { + "description": "A String", + "expression": "A String", + "location": "A String", + "title": "A String", }, - "members": [ # Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`. + "members": [ "A String", ], - "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles). + "role": "A String", }, ], - "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). + "etag": "A String", + "version": 42, }
testIamPermissions(resource, body=None, x__xgafv=None) -
Returns the permissions that a caller has on the specified source.
+  
 
 Args:
-  resource: string, REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. (required)
+  resource: string, A parameter (required)
   body: object, The request body.
     The object takes the form of:
 
-{ # Request message for `TestIamPermissions` method.
-  "permissions": [ # The set of permissions to check for the `resource`. Permissions with wildcards (such as `*` or `storage.*`) are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).
+{
+  "permissions": [
     "A String",
   ],
 }
@@ -406,8 +406,8 @@ 

Method Details

Returns: An object of the form: - { # Response message for `TestIamPermissions` method. - "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed. + { + "permissions": [ "A String", ], }
diff --git a/docs/dyn/securitycenter_v1.organizations.valuedResources.html b/docs/dyn/securitycenter_v1.organizations.valuedResources.html index d8d8a10334..e935447da9 100644 --- a/docs/dyn/securitycenter_v1.organizations.valuedResources.html +++ b/docs/dyn/securitycenter_v1.organizations.valuedResources.html @@ -79,7 +79,7 @@

Instance Methods

Close httplib2 connections.

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

-

Lists the valued resources for a set of simulation results and filter.

+

list_next()

Retrieves the next page of results.

@@ -91,14 +91,14 @@

Method Details

list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None) -
Lists the valued resources for a set of simulation results and filter.
+  
 
 Args:
-  parent: string, Required. Name of parent to list valued resources. Valid formats: `organizations/{organization}`, `organizations/{organization}/simulations/{simulation}` `organizations/{organization}/simulations/{simulation}/attackExposureResults/{attack_exposure_result_v2}` (required)
-  filter: string, The filter expression that filters the valued resources in the response. Supported fields: * `resource_value` supports = * `resource_type` supports =
-  orderBy: string, Optional. The fields by which to order the valued resources response. Supported fields: * `exposed_score` * `resource_value` * `resource_type` * `resource` * `display_name` Values should be a comma separated list of fields. For example: `exposed_score,resource_value`. The default sorting order is descending. To specify ascending or descending order for a field, append a ` ASC` or a ` DESC` suffix, respectively; for example: `exposed_score DESC`.
-  pageSize: integer, The maximum number of results to return in a single response. Default is 10, minimum is 1, maximum is 1000.
-  pageToken: string, The value returned by the last `ListValuedResourcesResponse`; indicates that this is a continuation of a prior `ListValuedResources` call, and that the system should return the next page of data.
+  parent: string, A parameter (required)
+  filter: string, A parameter
+  orderBy: string, A parameter
+  pageSize: integer, A parameter
+  pageToken: string, A parameter
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -107,20 +107,20 @@ 

Method Details

Returns: An object of the form: - { # Response message for listing the valued resources for a given simulation. - "nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no more results. - "totalSize": 42, # The estimated total number of results matching the query. - "valuedResources": [ # The valued resources that the attack path simulation identified. - { # A resource that is determined to have value to a user's system - "displayName": "A String", # Human-readable name of the valued resource. - "exposedScore": 3.14, # Exposed score for this valued resource. A value of 0 means no exposure was detected exposure. - "name": "A String", # Valued resource name, for example, e.g.: `organizations/123/simulations/456/valuedResources/789` - "resource": "A String", # The [full resource name](https://cloud.google.com/apis/design/resource_names#full_resource_name) of the valued resource. - "resourceType": "A String", # The [resource type](https://cloud.google.com/asset-inventory/docs/supported-asset-types) of the valued resource. - "resourceValue": "A String", # How valuable this resource is. - "resourceValueConfigsUsed": [ # List of resource value configurations' metadata used to determine the value of this resource. Maximum of 100. - { # Metadata about a ResourceValueConfig. For example, id and name. - "name": "A String", # Resource value config name + { + "nextPageToken": "A String", + "totalSize": 42, + "valuedResources": [ + { + "displayName": "A String", + "exposedScore": 3.14, + "name": "A String", + "resource": "A String", + "resourceType": "A String", + "resourceValue": "A String", + "resourceValueConfigsUsed": [ + { + "name": "A String", }, ], }, diff --git a/docs/dyn/securitycenter_v1.projects.assets.html b/docs/dyn/securitycenter_v1.projects.assets.html index 1c16a78119..78d589dc66 100644 --- a/docs/dyn/securitycenter_v1.projects.assets.html +++ b/docs/dyn/securitycenter_v1.projects.assets.html @@ -79,19 +79,19 @@

Instance Methods

Close httplib2 connections.

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

-

Filters an organization's assets and groups them by their specified properties.

+

group_next()

Retrieves the next page of results.

list(parent, compareDuration=None, fieldMask=None, filter=None, orderBy=None, pageSize=None, pageToken=None, readTime=None, x__xgafv=None)

-

Lists an organization's assets.

+

list_next()

Retrieves the next page of results.

updateSecurityMarks(name, body=None, startTime=None, updateMask=None, x__xgafv=None)

-

Updates security marks.

+

Method Details

close() @@ -100,20 +100,20 @@

Method Details

group(parent, body=None, x__xgafv=None) -
Filters an organization's assets and groups them by their specified properties.
+  
 
 Args:
-  parent: string, Required. The name of the parent to group the assets by. Its format is `organizations/[organization_id]`, `folders/[folder_id]`, or `projects/[project_id]`. (required)
+  parent: string, A parameter (required)
   body: object, The request body.
     The object takes the form of:
 
-{ # Request message for grouping by assets.
-  "compareDuration": "A String", # When compare_duration is set, the GroupResult's "state_change" property is updated to indicate whether the asset was added, removed, or remained present during the compare_duration period of time that precedes the read_time. This is the time between (read_time - compare_duration) and read_time. The state change value is derived based on the presence of the asset at the two points in time. Intermediate state changes between the two times don't affect the result. For example, the results aren't affected if the asset is removed and re-created again. Possible "state_change" values when compare_duration is specified: * "ADDED": indicates that the asset was not present at the start of compare_duration, but present at reference_time. * "REMOVED": indicates that the asset was present at the start of compare_duration, but not present at reference_time. * "ACTIVE": indicates that the asset was present at both the start and the end of the time period defined by compare_duration and reference_time. If compare_duration is not specified, then the only possible state_change is "UNUSED", which will be the state_change set for all assets present at read_time. If this field is set then `state_change` must be a specified field in `group_by`.
-  "filter": "A String", # Expression that defines the filter to apply across assets. The expression is a list of zero or more restrictions combined via logical operators `AND` and `OR`. Parentheses are supported, and `OR` has higher precedence than `AND`. Restrictions have the form ` ` and may have a `-` character in front of them to indicate negation. The fields map to those defined in the Asset resource. Examples include: * name * security_center_properties.resource_name * resource_properties.a_property * security_marks.marks.marka The supported operators are: * `=` for all value types. * `>`, `<`, `>=`, `<=` for integer values. * `:`, meaning substring matching, for strings. The supported value types are: * string literals in quotes. * integer literals without quotes. * boolean literals `true` and `false` without quotes. The following field and operator combinations are supported: * name: `=` * update_time: `=`, `>`, `<`, `>=`, `<=` Usage: This should be milliseconds since epoch or an RFC3339 string. Examples: `update_time = "2019-06-10T16:07:18-07:00"` `update_time = 1560208038000` * create_time: `=`, `>`, `<`, `>=`, `<=` Usage: This should be milliseconds since epoch or an RFC3339 string. Examples: `create_time = "2019-06-10T16:07:18-07:00"` `create_time = 1560208038000` * iam_policy.policy_blob: `=`, `:` * resource_properties: `=`, `:`, `>`, `<`, `>=`, `<=` * security_marks.marks: `=`, `:` * security_center_properties.resource_name: `=`, `:` * security_center_properties.resource_display_name: `=`, `:` * security_center_properties.resource_type: `=`, `:` * security_center_properties.resource_parent: `=`, `:` * security_center_properties.resource_parent_display_name: `=`, `:` * security_center_properties.resource_project: `=`, `:` * security_center_properties.resource_project_display_name: `=`, `:` * security_center_properties.resource_owners: `=`, `:` For example, `resource_properties.size = 100` is a valid filter string. Use a partial match on the empty string to filter based on a property existing: `resource_properties.my_property : ""` Use a negated partial match on the empty string to filter based on a property not existing: `-resource_properties.my_property : ""`
-  "groupBy": "A String", # Required. Expression that defines what assets fields to use for grouping. The string value should follow SQL syntax: comma separated list of fields. For example: "security_center_properties.resource_project,security_center_properties.project". The following fields are supported when compare_duration is not set: * security_center_properties.resource_project * security_center_properties.resource_project_display_name * security_center_properties.resource_type * security_center_properties.resource_parent * security_center_properties.resource_parent_display_name The following fields are supported when compare_duration is set: * security_center_properties.resource_type * security_center_properties.resource_project_display_name * security_center_properties.resource_parent_display_name
-  "pageSize": 42, # The maximum number of results to return in a single response. Default is 10, minimum is 1, maximum is 1000.
-  "pageToken": "A String", # The value returned by the last `GroupAssetsResponse`; indicates that this is a continuation of a prior `GroupAssets` call, and that the system should return the next page of data.
-  "readTime": "A String", # Time used as a reference point when filtering assets. The filter is limited to assets existing at the supplied time and their values are those at that specific time. Absence of this field will default to the API's version of NOW.
+{
+  "compareDuration": "A String",
+  "filter": "A String",
+  "groupBy": "A String",
+  "pageSize": 42,
+  "pageToken": "A String",
+  "readTime": "A String",
 }
 
   x__xgafv: string, V1 error format.
@@ -124,18 +124,18 @@ 

Method Details

Returns: An object of the form: - { # Response message for grouping by assets. - "groupByResults": [ # Group results. There exists an element for each existing unique combination of property/values. The element contains a count for the number of times those specific property/values appear. - { # Result containing the properties and count of a groupBy request. - "count": "A String", # Total count of resources for the given properties. - "properties": { # Properties matching the groupBy fields in the request. + { + "groupByResults": [ + { + "count": "A String", + "properties": { "a_key": "", }, }, ], - "nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no more results. - "readTime": "A String", # Time used for executing the groupBy request. - "totalSize": 42, # The total number of results matching the query. + "nextPageToken": "A String", + "readTime": "A String", + "totalSize": 42, }
@@ -155,17 +155,17 @@

Method Details

list(parent, compareDuration=None, fieldMask=None, filter=None, orderBy=None, pageSize=None, pageToken=None, readTime=None, x__xgafv=None) -
Lists an organization's assets.
+  
 
 Args:
-  parent: string, Required. The name of the parent resource that contains the assets. The value that you can specify on parent depends on the method in which you specify parent. You can specify one of the following values: `organizations/[organization_id]`, `folders/[folder_id]`, or `projects/[project_id]`. (required)
-  compareDuration: string, When compare_duration is set, the ListAssetsResult's "state_change" attribute is updated to indicate whether the asset was added, removed, or remained present during the compare_duration period of time that precedes the read_time. This is the time between (read_time - compare_duration) and read_time. The state_change value is derived based on the presence of the asset at the two points in time. Intermediate state changes between the two times don't affect the result. For example, the results aren't affected if the asset is removed and re-created again. Possible "state_change" values when compare_duration is specified: * "ADDED": indicates that the asset was not present at the start of compare_duration, but present at read_time. * "REMOVED": indicates that the asset was present at the start of compare_duration, but not present at read_time. * "ACTIVE": indicates that the asset was present at both the start and the end of the time period defined by compare_duration and read_time. If compare_duration is not specified, then the only possible state_change is "UNUSED", which will be the state_change set for all assets present at read_time.
-  fieldMask: string, A field mask to specify the ListAssetsResult fields to be listed in the response. An empty field mask will list all fields.
-  filter: string, Expression that defines the filter to apply across assets. The expression is a list of zero or more restrictions combined via logical operators `AND` and `OR`. Parentheses are supported, and `OR` has higher precedence than `AND`. Restrictions have the form ` ` and may have a `-` character in front of them to indicate negation. The fields map to those defined in the Asset resource. Examples include: * name * security_center_properties.resource_name * resource_properties.a_property * security_marks.marks.marka The supported operators are: * `=` for all value types. * `>`, `<`, `>=`, `<=` for integer values. * `:`, meaning substring matching, for strings. The supported value types are: * string literals in quotes. * integer literals without quotes. * boolean literals `true` and `false` without quotes. The following are the allowed field and operator combinations: * name: `=` * update_time: `=`, `>`, `<`, `>=`, `<=` Usage: This should be milliseconds since epoch or an RFC3339 string. Examples: `update_time = "2019-06-10T16:07:18-07:00"` `update_time = 1560208038000` * create_time: `=`, `>`, `<`, `>=`, `<=` Usage: This should be milliseconds since epoch or an RFC3339 string. Examples: `create_time = "2019-06-10T16:07:18-07:00"` `create_time = 1560208038000` * iam_policy.policy_blob: `=`, `:` * resource_properties: `=`, `:`, `>`, `<`, `>=`, `<=` * security_marks.marks: `=`, `:` * security_center_properties.resource_name: `=`, `:` * security_center_properties.resource_display_name: `=`, `:` * security_center_properties.resource_type: `=`, `:` * security_center_properties.resource_parent: `=`, `:` * security_center_properties.resource_parent_display_name: `=`, `:` * security_center_properties.resource_project: `=`, `:` * security_center_properties.resource_project_display_name: `=`, `:` * security_center_properties.resource_owners: `=`, `:` For example, `resource_properties.size = 100` is a valid filter string. Use a partial match on the empty string to filter based on a property existing: `resource_properties.my_property : ""` Use a negated partial match on the empty string to filter based on a property not existing: `-resource_properties.my_property : ""`
-  orderBy: string, Expression that defines what fields and order to use for sorting. The string value should follow SQL syntax: comma separated list of fields. For example: "name,resource_properties.a_property". The default sorting order is ascending. To specify descending order for a field, a suffix " desc" should be appended to the field name. For example: "name desc,resource_properties.a_property". Redundant space characters in the syntax are insignificant. "name desc,resource_properties.a_property" and " name desc , resource_properties.a_property " are equivalent. The following fields are supported: name update_time resource_properties security_marks.marks security_center_properties.resource_name security_center_properties.resource_display_name security_center_properties.resource_parent security_center_properties.resource_parent_display_name security_center_properties.resource_project security_center_properties.resource_project_display_name security_center_properties.resource_type
-  pageSize: integer, The maximum number of results to return in a single response. Default is 10, minimum is 1, maximum is 1000.
-  pageToken: string, The value returned by the last `ListAssetsResponse`; indicates that this is a continuation of a prior `ListAssets` call, and that the system should return the next page of data.
-  readTime: string, Time used as a reference point when filtering assets. The filter is limited to assets existing at the supplied time and their values are those at that specific time. Absence of this field will default to the API's version of NOW.
+  parent: string, A parameter (required)
+  compareDuration: string, A parameter
+  fieldMask: string, A parameter
+  filter: string, A parameter
+  orderBy: string, A parameter
+  pageSize: integer, A parameter
+  pageToken: string, A parameter
+  readTime: string, A parameter
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -174,52 +174,52 @@ 

Method Details

Returns: An object of the form: - { # Response message for listing assets. - "listAssetsResults": [ # Assets matching the list request. - { # Result containing the Asset and its State. - "asset": { # Security Command Center representation of a Google Cloud resource. The Asset is a Security Command Center resource that captures information about a single Google Cloud resource. All modifications to an Asset are only within the context of Security Command Center and don't affect the referenced Google Cloud resource. # Asset matching the search request. - "canonicalName": "A String", # The canonical name of the resource. It's either "organizations/{organization_id}/assets/{asset_id}", "folders/{folder_id}/assets/{asset_id}" or "projects/{project_number}/assets/{asset_id}", depending on the closest CRM ancestor of the resource. - "createTime": "A String", # The time at which the asset was created in Security Command Center. - "iamPolicy": { # Cloud IAM Policy information associated with the Google Cloud resource described by the Security Command Center asset. This information is managed and defined by the Google Cloud resource and cannot be modified by the user. # Cloud IAM Policy information associated with the Google Cloud resource described by the Security Command Center asset. This information is managed and defined by the Google Cloud resource and cannot be modified by the user. - "policyBlob": "A String", # The JSON representation of the Policy associated with the asset. See https://cloud.google.com/iam/reference/rest/v1/Policy for format details. + { + "listAssetsResults": [ + { + "asset": { + "canonicalName": "A String", + "createTime": "A String", + "iamPolicy": { + "policyBlob": "A String", }, - "name": "A String", # The relative resource name of this asset. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Example: "organizations/{organization_id}/assets/{asset_id}". - "resourceProperties": { # Resource managed properties. These properties are managed and defined by the Google Cloud resource and cannot be modified by the user. + "name": "A String", + "resourceProperties": { "a_key": "", }, - "securityCenterProperties": { # Security Command Center managed properties. These properties are managed by Security Command Center and cannot be modified by the user. # Security Command Center managed properties. These properties are managed by Security Command Center and cannot be modified by the user. - "folders": [ # Contains a Folder message for each folder in the assets ancestry. The first folder is the deepest nested folder, and the last folder is the folder directly under the Organization. - { # Message that contains the resource name and display name of a folder resource. - "resourceFolder": "A String", # Full resource name of this folder. See: https://cloud.google.com/apis/design/resource_names#full_resource_name - "resourceFolderDisplayName": "A String", # The user defined display name for this folder. + "securityCenterProperties": { + "folders": [ + { + "resourceFolder": "A String", + "resourceFolderDisplayName": "A String", }, ], - "resourceDisplayName": "A String", # The user defined display name for this resource. - "resourceName": "A String", # The full resource name of the Google Cloud resource this asset represents. This field is immutable after create time. See: https://cloud.google.com/apis/design/resource_names#full_resource_name - "resourceOwners": [ # Owners of the Google Cloud resource. + "resourceDisplayName": "A String", + "resourceName": "A String", + "resourceOwners": [ "A String", ], - "resourceParent": "A String", # The full resource name of the immediate parent of the resource. See: https://cloud.google.com/apis/design/resource_names#full_resource_name - "resourceParentDisplayName": "A String", # The user defined display name for the parent of this resource. - "resourceProject": "A String", # The full resource name of the project the resource belongs to. See: https://cloud.google.com/apis/design/resource_names#full_resource_name - "resourceProjectDisplayName": "A String", # The user defined display name for the project of this resource. - "resourceType": "A String", # The type of the Google Cloud resource. Examples include: APPLICATION, PROJECT, and ORGANIZATION. This is a case insensitive field defined by Security Command Center and/or the producer of the resource and is immutable after create time. + "resourceParent": "A String", + "resourceParentDisplayName": "A String", + "resourceProject": "A String", + "resourceProjectDisplayName": "A String", + "resourceType": "A String", }, - "securityMarks": { # User specified security marks that are attached to the parent Security Command Center resource. Security marks are scoped within a Security Command Center organization -- they can be modified and viewed by all users who have proper permissions on the organization. # User specified security marks. These marks are entirely managed by the user and come from the SecurityMarks resource that belongs to the asset. - "canonicalName": "A String", # The canonical name of the marks. Examples: "organizations/{organization_id}/assets/{asset_id}/securityMarks" "folders/{folder_id}/assets/{asset_id}/securityMarks" "projects/{project_number}/assets/{asset_id}/securityMarks" "organizations/{organization_id}/sources/{source_id}/findings/{finding_id}/securityMarks" "folders/{folder_id}/sources/{source_id}/findings/{finding_id}/securityMarks" "projects/{project_number}/sources/{source_id}/findings/{finding_id}/securityMarks" - "marks": { # Mutable user specified security marks belonging to the parent resource. Constraints are as follows: * Keys and values are treated as case insensitive * Keys must be between 1 - 256 characters (inclusive) * Keys must be letters, numbers, underscores, or dashes * Values have leading and trailing whitespace trimmed, remaining characters must be between 1 - 4096 characters (inclusive) + "securityMarks": { + "canonicalName": "A String", + "marks": { "a_key": "A String", }, - "name": "A String", # The relative resource name of the SecurityMarks. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Examples: "organizations/{organization_id}/assets/{asset_id}/securityMarks" "organizations/{organization_id}/sources/{source_id}/findings/{finding_id}/securityMarks". + "name": "A String", }, - "updateTime": "A String", # The time at which the asset was last updated or added in Cloud SCC. + "updateTime": "A String", }, - "stateChange": "A String", # State change of the asset between the points in time. + "stateChange": "A String", }, ], - "nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no more results. - "readTime": "A String", # Time used for executing the list request. - "totalSize": 42, # The total number of assets matching the query. + "nextPageToken": "A String", + "readTime": "A String", + "totalSize": 42, }
@@ -239,23 +239,23 @@

Method Details

updateSecurityMarks(name, body=None, startTime=None, updateMask=None, x__xgafv=None) -
Updates security marks.
+  
 
 Args:
-  name: string, The relative resource name of the SecurityMarks. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Examples: "organizations/{organization_id}/assets/{asset_id}/securityMarks" "organizations/{organization_id}/sources/{source_id}/findings/{finding_id}/securityMarks". (required)
+  name: string, A parameter (required)
   body: object, The request body.
     The object takes the form of:
 
-{ # User specified security marks that are attached to the parent Security Command Center resource. Security marks are scoped within a Security Command Center organization -- they can be modified and viewed by all users who have proper permissions on the organization.
-  "canonicalName": "A String", # The canonical name of the marks. Examples: "organizations/{organization_id}/assets/{asset_id}/securityMarks" "folders/{folder_id}/assets/{asset_id}/securityMarks" "projects/{project_number}/assets/{asset_id}/securityMarks" "organizations/{organization_id}/sources/{source_id}/findings/{finding_id}/securityMarks" "folders/{folder_id}/sources/{source_id}/findings/{finding_id}/securityMarks" "projects/{project_number}/sources/{source_id}/findings/{finding_id}/securityMarks"
-  "marks": { # Mutable user specified security marks belonging to the parent resource. Constraints are as follows: * Keys and values are treated as case insensitive * Keys must be between 1 - 256 characters (inclusive) * Keys must be letters, numbers, underscores, or dashes * Values have leading and trailing whitespace trimmed, remaining characters must be between 1 - 4096 characters (inclusive)
+{
+  "canonicalName": "A String",
+  "marks": {
     "a_key": "A String",
   },
-  "name": "A String", # The relative resource name of the SecurityMarks. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Examples: "organizations/{organization_id}/assets/{asset_id}/securityMarks" "organizations/{organization_id}/sources/{source_id}/findings/{finding_id}/securityMarks".
+  "name": "A String",
 }
 
-  startTime: string, The time at which the updated SecurityMarks take effect. If not set uses current server time. Updates will be applied to the SecurityMarks that are active immediately preceding this time. Must be earlier or equal to the server time.
-  updateMask: string, The FieldMask to use when updating the security marks resource. The field mask must not contain duplicate fields. If empty or set to "marks", all marks will be replaced. Individual marks can be updated using "marks.".
+  startTime: string, A parameter
+  updateMask: string, A parameter
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -264,12 +264,12 @@ 

Method Details

Returns: An object of the form: - { # User specified security marks that are attached to the parent Security Command Center resource. Security marks are scoped within a Security Command Center organization -- they can be modified and viewed by all users who have proper permissions on the organization. - "canonicalName": "A String", # The canonical name of the marks. Examples: "organizations/{organization_id}/assets/{asset_id}/securityMarks" "folders/{folder_id}/assets/{asset_id}/securityMarks" "projects/{project_number}/assets/{asset_id}/securityMarks" "organizations/{organization_id}/sources/{source_id}/findings/{finding_id}/securityMarks" "folders/{folder_id}/sources/{source_id}/findings/{finding_id}/securityMarks" "projects/{project_number}/sources/{source_id}/findings/{finding_id}/securityMarks" - "marks": { # Mutable user specified security marks belonging to the parent resource. Constraints are as follows: * Keys and values are treated as case insensitive * Keys must be between 1 - 256 characters (inclusive) * Keys must be letters, numbers, underscores, or dashes * Values have leading and trailing whitespace trimmed, remaining characters must be between 1 - 4096 characters (inclusive) + { + "canonicalName": "A String", + "marks": { "a_key": "A String", }, - "name": "A String", # The relative resource name of the SecurityMarks. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Examples: "organizations/{organization_id}/assets/{asset_id}/securityMarks" "organizations/{organization_id}/sources/{source_id}/findings/{finding_id}/securityMarks". + "name": "A String", }
diff --git a/docs/dyn/securitycenter_v1.projects.bigQueryExports.html b/docs/dyn/securitycenter_v1.projects.bigQueryExports.html index 9205f9fb20..50f24448a0 100644 --- a/docs/dyn/securitycenter_v1.projects.bigQueryExports.html +++ b/docs/dyn/securitycenter_v1.projects.bigQueryExports.html @@ -79,22 +79,22 @@

Instance Methods

Close httplib2 connections.

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

-

Creates a BigQuery export.

+

delete(name, x__xgafv=None)

-

Deletes an existing BigQuery export.

+

get(name, x__xgafv=None)

-

Gets a BigQuery export.

+

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

-

Lists BigQuery exports. Note that when requesting BigQuery exports at a given level all exports under that level are also returned e.g. if requesting BigQuery exports under a folder, then all BigQuery exports immediately under the folder plus the ones created under the projects within the folder are returned.

+

list_next()

Retrieves the next page of results.

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

-

Updates a BigQuery export.

+

Method Details

close() @@ -103,25 +103,25 @@

Method Details

create(parent, bigQueryExportId=None, body=None, x__xgafv=None) -
Creates a BigQuery export.
+  
 
 Args:
-  parent: string, Required. The name of the parent resource of the new BigQuery export. Its format is `organizations/[organization_id]`, `folders/[folder_id]`, or `projects/[project_id]`. (required)
+  parent: string, A parameter (required)
   body: object, The request body.
     The object takes the form of:
 
-{ # Configures how to deliver Findings to BigQuery Instance.
-  "createTime": "A String", # Output only. The time at which the BigQuery export was created. This field is set by the server and will be ignored if provided on export on creation.
-  "dataset": "A String", # The dataset to write findings' updates to. Its format is "projects/[project_id]/datasets/[bigquery_dataset_id]". BigQuery Dataset unique ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_).
-  "description": "A String", # The description of the export (max of 1024 characters).
-  "filter": "A String", # Expression that defines the filter to apply across create/update events of findings. The expression is a list of zero or more restrictions combined via logical operators `AND` and `OR`. Parentheses are supported, and `OR` has higher precedence than `AND`. Restrictions have the form ` ` and may have a `-` character in front of them to indicate negation. The fields map to those defined in the corresponding resource. The supported operators are: * `=` for all value types. * `>`, `<`, `>=`, `<=` for integer values. * `:`, meaning substring matching, for strings. The supported value types are: * string literals in quotes. * integer literals without quotes. * boolean literals `true` and `false` without quotes.
-  "mostRecentEditor": "A String", # Output only. Email address of the user who last edited the BigQuery export. This field is set by the server and will be ignored if provided on export creation or update.
-  "name": "A String", # The relative resource name of this export. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name. Example format: "organizations/{organization_id}/bigQueryExports/{export_id}" Example format: "folders/{folder_id}/bigQueryExports/{export_id}" Example format: "projects/{project_id}/bigQueryExports/{export_id}" This field is provided in responses, and is ignored when provided in create requests.
-  "principal": "A String", # Output only. The service account that needs permission to create table and upload data to the BigQuery dataset.
-  "updateTime": "A String", # Output only. The most recent time at which the BigQuery export was updated. This field is set by the server and will be ignored if provided on export creation or update.
+{
+  "createTime": "A String",
+  "dataset": "A String",
+  "description": "A String",
+  "filter": "A String",
+  "mostRecentEditor": "A String",
+  "name": "A String",
+  "principal": "A String",
+  "updateTime": "A String",
 }
 
-  bigQueryExportId: string, Required. Unique identifier provided by the client within the parent scope. It must consist of only lowercase letters, numbers, and hyphens, must start with a letter, must end with either a letter or a number, and must be 63 characters or less.
+  bigQueryExportId: string, A parameter
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -130,24 +130,24 @@ 

Method Details

Returns: An object of the form: - { # Configures how to deliver Findings to BigQuery Instance. - "createTime": "A String", # Output only. The time at which the BigQuery export was created. This field is set by the server and will be ignored if provided on export on creation. - "dataset": "A String", # The dataset to write findings' updates to. Its format is "projects/[project_id]/datasets/[bigquery_dataset_id]". BigQuery Dataset unique ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). - "description": "A String", # The description of the export (max of 1024 characters). - "filter": "A String", # Expression that defines the filter to apply across create/update events of findings. The expression is a list of zero or more restrictions combined via logical operators `AND` and `OR`. Parentheses are supported, and `OR` has higher precedence than `AND`. Restrictions have the form ` ` and may have a `-` character in front of them to indicate negation. The fields map to those defined in the corresponding resource. The supported operators are: * `=` for all value types. * `>`, `<`, `>=`, `<=` for integer values. * `:`, meaning substring matching, for strings. The supported value types are: * string literals in quotes. * integer literals without quotes. * boolean literals `true` and `false` without quotes. - "mostRecentEditor": "A String", # Output only. Email address of the user who last edited the BigQuery export. This field is set by the server and will be ignored if provided on export creation or update. - "name": "A String", # The relative resource name of this export. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name. Example format: "organizations/{organization_id}/bigQueryExports/{export_id}" Example format: "folders/{folder_id}/bigQueryExports/{export_id}" Example format: "projects/{project_id}/bigQueryExports/{export_id}" This field is provided in responses, and is ignored when provided in create requests. - "principal": "A String", # Output only. The service account that needs permission to create table and upload data to the BigQuery dataset. - "updateTime": "A String", # Output only. The most recent time at which the BigQuery export was updated. This field is set by the server and will be ignored if provided on export creation or update. + { + "createTime": "A String", + "dataset": "A String", + "description": "A String", + "filter": "A String", + "mostRecentEditor": "A String", + "name": "A String", + "principal": "A String", + "updateTime": "A String", }
delete(name, x__xgafv=None) -
Deletes an existing BigQuery export.
+  
 
 Args:
-  name: string, Required. The name of the BigQuery export to delete. Its format is `organizations/{organization}/bigQueryExports/{export_id}`, `folders/{folder}/bigQueryExports/{export_id}`, or `projects/{project}/bigQueryExports/{export_id}` (required)
+  name: string, A parameter (required)
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -156,16 +156,16 @@ 

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); } + { }
get(name, x__xgafv=None) -
Gets a BigQuery export.
+  
 
 Args:
-  name: string, Required. Name of the BigQuery export to retrieve. Its format is `organizations/{organization}/bigQueryExports/{export_id}`, `folders/{folder}/bigQueryExports/{export_id}`, or `projects/{project}/bigQueryExports/{export_id}` (required)
+  name: string, A parameter (required)
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -174,26 +174,26 @@ 

Method Details

Returns: An object of the form: - { # Configures how to deliver Findings to BigQuery Instance. - "createTime": "A String", # Output only. The time at which the BigQuery export was created. This field is set by the server and will be ignored if provided on export on creation. - "dataset": "A String", # The dataset to write findings' updates to. Its format is "projects/[project_id]/datasets/[bigquery_dataset_id]". BigQuery Dataset unique ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). - "description": "A String", # The description of the export (max of 1024 characters). - "filter": "A String", # Expression that defines the filter to apply across create/update events of findings. The expression is a list of zero or more restrictions combined via logical operators `AND` and `OR`. Parentheses are supported, and `OR` has higher precedence than `AND`. Restrictions have the form ` ` and may have a `-` character in front of them to indicate negation. The fields map to those defined in the corresponding resource. The supported operators are: * `=` for all value types. * `>`, `<`, `>=`, `<=` for integer values. * `:`, meaning substring matching, for strings. The supported value types are: * string literals in quotes. * integer literals without quotes. * boolean literals `true` and `false` without quotes. - "mostRecentEditor": "A String", # Output only. Email address of the user who last edited the BigQuery export. This field is set by the server and will be ignored if provided on export creation or update. - "name": "A String", # The relative resource name of this export. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name. Example format: "organizations/{organization_id}/bigQueryExports/{export_id}" Example format: "folders/{folder_id}/bigQueryExports/{export_id}" Example format: "projects/{project_id}/bigQueryExports/{export_id}" This field is provided in responses, and is ignored when provided in create requests. - "principal": "A String", # Output only. The service account that needs permission to create table and upload data to the BigQuery dataset. - "updateTime": "A String", # Output only. The most recent time at which the BigQuery export was updated. This field is set by the server and will be ignored if provided on export creation or update. + { + "createTime": "A String", + "dataset": "A String", + "description": "A String", + "filter": "A String", + "mostRecentEditor": "A String", + "name": "A String", + "principal": "A String", + "updateTime": "A String", }
list(parent, pageSize=None, pageToken=None, x__xgafv=None) -
Lists BigQuery exports. Note that when requesting BigQuery exports at a given level all exports under that level are also returned e.g. if requesting BigQuery exports under a folder, then all BigQuery exports immediately under the folder plus the ones created under the projects within the folder are returned.
+  
 
 Args:
-  parent: string, Required. The parent, which owns the collection of BigQuery exports. Its format is `organizations/[organization_id]`, `folders/[folder_id]`, `projects/[project_id]`. (required)
-  pageSize: integer, The maximum number of configs to return. The service may return fewer than this value. If unspecified, at most 10 configs will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
-  pageToken: string, A page token, received from a previous `ListBigQueryExports` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListBigQueryExports` must match the call that provided the page token.
+  parent: string, A parameter (required)
+  pageSize: integer, A parameter
+  pageToken: string, A parameter
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -202,20 +202,20 @@ 

Method Details

Returns: An object of the form: - { # Response message for listing BigQuery exports. - "bigQueryExports": [ # The BigQuery exports from the specified parent. - { # Configures how to deliver Findings to BigQuery Instance. - "createTime": "A String", # Output only. The time at which the BigQuery export was created. This field is set by the server and will be ignored if provided on export on creation. - "dataset": "A String", # The dataset to write findings' updates to. Its format is "projects/[project_id]/datasets/[bigquery_dataset_id]". BigQuery Dataset unique ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). - "description": "A String", # The description of the export (max of 1024 characters). - "filter": "A String", # Expression that defines the filter to apply across create/update events of findings. The expression is a list of zero or more restrictions combined via logical operators `AND` and `OR`. Parentheses are supported, and `OR` has higher precedence than `AND`. Restrictions have the form ` ` and may have a `-` character in front of them to indicate negation. The fields map to those defined in the corresponding resource. The supported operators are: * `=` for all value types. * `>`, `<`, `>=`, `<=` for integer values. * `:`, meaning substring matching, for strings. The supported value types are: * string literals in quotes. * integer literals without quotes. * boolean literals `true` and `false` without quotes. - "mostRecentEditor": "A String", # Output only. Email address of the user who last edited the BigQuery export. This field is set by the server and will be ignored if provided on export creation or update. - "name": "A String", # The relative resource name of this export. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name. Example format: "organizations/{organization_id}/bigQueryExports/{export_id}" Example format: "folders/{folder_id}/bigQueryExports/{export_id}" Example format: "projects/{project_id}/bigQueryExports/{export_id}" This field is provided in responses, and is ignored when provided in create requests. - "principal": "A String", # Output only. The service account that needs permission to create table and upload data to the BigQuery dataset. - "updateTime": "A String", # Output only. The most recent time at which the BigQuery export was updated. This field is set by the server and will be ignored if provided on export creation or update. + { + "bigQueryExports": [ + { + "createTime": "A String", + "dataset": "A String", + "description": "A String", + "filter": "A String", + "mostRecentEditor": "A String", + "name": "A String", + "principal": "A String", + "updateTime": "A String", }, ], - "nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. + "nextPageToken": "A String", }
@@ -235,25 +235,25 @@

Method Details

patch(name, body=None, updateMask=None, x__xgafv=None) -
Updates a BigQuery export.
+  
 
 Args:
-  name: string, The relative resource name of this export. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name. Example format: "organizations/{organization_id}/bigQueryExports/{export_id}" Example format: "folders/{folder_id}/bigQueryExports/{export_id}" Example format: "projects/{project_id}/bigQueryExports/{export_id}" This field is provided in responses, and is ignored when provided in create requests. (required)
+  name: string, A parameter (required)
   body: object, The request body.
     The object takes the form of:
 
-{ # Configures how to deliver Findings to BigQuery Instance.
-  "createTime": "A String", # Output only. The time at which the BigQuery export was created. This field is set by the server and will be ignored if provided on export on creation.
-  "dataset": "A String", # The dataset to write findings' updates to. Its format is "projects/[project_id]/datasets/[bigquery_dataset_id]". BigQuery Dataset unique ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_).
-  "description": "A String", # The description of the export (max of 1024 characters).
-  "filter": "A String", # Expression that defines the filter to apply across create/update events of findings. The expression is a list of zero or more restrictions combined via logical operators `AND` and `OR`. Parentheses are supported, and `OR` has higher precedence than `AND`. Restrictions have the form ` ` and may have a `-` character in front of them to indicate negation. The fields map to those defined in the corresponding resource. The supported operators are: * `=` for all value types. * `>`, `<`, `>=`, `<=` for integer values. * `:`, meaning substring matching, for strings. The supported value types are: * string literals in quotes. * integer literals without quotes. * boolean literals `true` and `false` without quotes.
-  "mostRecentEditor": "A String", # Output only. Email address of the user who last edited the BigQuery export. This field is set by the server and will be ignored if provided on export creation or update.
-  "name": "A String", # The relative resource name of this export. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name. Example format: "organizations/{organization_id}/bigQueryExports/{export_id}" Example format: "folders/{folder_id}/bigQueryExports/{export_id}" Example format: "projects/{project_id}/bigQueryExports/{export_id}" This field is provided in responses, and is ignored when provided in create requests.
-  "principal": "A String", # Output only. The service account that needs permission to create table and upload data to the BigQuery dataset.
-  "updateTime": "A String", # Output only. The most recent time at which the BigQuery export was updated. This field is set by the server and will be ignored if provided on export creation or update.
+{
+  "createTime": "A String",
+  "dataset": "A String",
+  "description": "A String",
+  "filter": "A String",
+  "mostRecentEditor": "A String",
+  "name": "A String",
+  "principal": "A String",
+  "updateTime": "A String",
 }
 
-  updateMask: string, The list of fields to be updated. If empty all mutable fields will be updated.
+  updateMask: string, A parameter
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -262,15 +262,15 @@ 

Method Details

Returns: An object of the form: - { # Configures how to deliver Findings to BigQuery Instance. - "createTime": "A String", # Output only. The time at which the BigQuery export was created. This field is set by the server and will be ignored if provided on export on creation. - "dataset": "A String", # The dataset to write findings' updates to. Its format is "projects/[project_id]/datasets/[bigquery_dataset_id]". BigQuery Dataset unique ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). - "description": "A String", # The description of the export (max of 1024 characters). - "filter": "A String", # Expression that defines the filter to apply across create/update events of findings. The expression is a list of zero or more restrictions combined via logical operators `AND` and `OR`. Parentheses are supported, and `OR` has higher precedence than `AND`. Restrictions have the form ` ` and may have a `-` character in front of them to indicate negation. The fields map to those defined in the corresponding resource. The supported operators are: * `=` for all value types. * `>`, `<`, `>=`, `<=` for integer values. * `:`, meaning substring matching, for strings. The supported value types are: * string literals in quotes. * integer literals without quotes. * boolean literals `true` and `false` without quotes. - "mostRecentEditor": "A String", # Output only. Email address of the user who last edited the BigQuery export. This field is set by the server and will be ignored if provided on export creation or update. - "name": "A String", # The relative resource name of this export. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name. Example format: "organizations/{organization_id}/bigQueryExports/{export_id}" Example format: "folders/{folder_id}/bigQueryExports/{export_id}" Example format: "projects/{project_id}/bigQueryExports/{export_id}" This field is provided in responses, and is ignored when provided in create requests. - "principal": "A String", # Output only. The service account that needs permission to create table and upload data to the BigQuery dataset. - "updateTime": "A String", # Output only. The most recent time at which the BigQuery export was updated. This field is set by the server and will be ignored if provided on export creation or update. + { + "createTime": "A String", + "dataset": "A String", + "description": "A String", + "filter": "A String", + "mostRecentEditor": "A String", + "name": "A String", + "principal": "A String", + "updateTime": "A String", }
diff --git a/docs/dyn/securitycenter_v1.projects.eventThreatDetectionSettings.customModules.html b/docs/dyn/securitycenter_v1.projects.eventThreatDetectionSettings.customModules.html index 46e8301801..d87ee602f4 100644 --- a/docs/dyn/securitycenter_v1.projects.eventThreatDetectionSettings.customModules.html +++ b/docs/dyn/securitycenter_v1.projects.eventThreatDetectionSettings.customModules.html @@ -79,19 +79,19 @@

Instance Methods

Close httplib2 connections.

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

-

Creates a resident Event Threat Detection custom module at the scope of the given Resource Manager parent, and also creates inherited custom modules for all descendants of the given parent. These modules are enabled by default.

+

delete(name, x__xgafv=None)

-

Deletes the specified Event Threat Detection custom module and all of its descendants in the Resource Manager hierarchy. This method is only supported for resident custom modules.

+

get(name, x__xgafv=None)

-

Gets an Event Threat Detection custom module.

+

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

-

Lists all Event Threat Detection custom modules for the given Resource Manager parent. This includes resident modules defined at the scope of the parent along with modules inherited from ancestors.

+

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

-

Lists all resident Event Threat Detection custom modules under the given Resource Manager parent and its descendants.

+

listDescendant_next()

Retrieves the next page of results.

@@ -100,7 +100,7 @@

Instance Methods

Retrieves the next page of results.

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

-

Updates the Event Threat Detection custom module with the given name based on the given update mask. Updating the enablement state is supported for both resident and inherited modules (though resident modules cannot have an enablement state of "inherited"). Updating the display name or configuration of a module is supported for resident modules only. The type of a module cannot be changed.

+

Method Details

close() @@ -109,26 +109,26 @@

Method Details

create(parent, body=None, x__xgafv=None) -
Creates a resident Event Threat Detection custom module at the scope of the given Resource Manager parent, and also creates inherited custom modules for all descendants of the given parent. These modules are enabled by default.
+  
 
 Args:
-  parent: string, Required. The new custom module's parent. Its format is: * `organizations/{organization}/eventThreatDetectionSettings`. * `folders/{folder}/eventThreatDetectionSettings`. * `projects/{project}/eventThreatDetectionSettings`. (required)
+  parent: string, A parameter (required)
   body: object, The request body.
     The object takes the form of:
 
-{ # Represents an instance of an Event Threat Detection custom module, including its full module name, display name, enablement state, and last updated time. You can create a custom module at the organization, folder, or project level. Custom modules that you create at the organization or folder level are inherited by child folders and projects.
-  "ancestorModule": "A String", # Output only. The closest ancestor module that this module inherits the enablement state from. The format is the same as the EventThreatDetectionCustomModule resource name.
-  "cloudProvider": "A String", # The cloud provider of the custom module.
-  "config": { # Config for the module. For the resident module, its config value is defined at this level. For the inherited module, its config value is inherited from the ancestor module.
+{
+  "ancestorModule": "A String",
+  "cloudProvider": "A String",
+  "config": {
     "a_key": "", # Properties of the object.
   },
-  "description": "A String", # The description for the module.
-  "displayName": "A String", # The human readable name to be displayed for the module.
-  "enablementState": "A String", # The state of enablement for the module at the given level of the hierarchy.
-  "lastEditor": "A String", # Output only. The editor the module was last updated by.
-  "name": "A String", # Immutable. The resource name of the Event Threat Detection custom module. Its format is: * `organizations/{organization}/eventThreatDetectionSettings/customModules/{module}`. * `folders/{folder}/eventThreatDetectionSettings/customModules/{module}`. * `projects/{project}/eventThreatDetectionSettings/customModules/{module}`.
-  "type": "A String", # Type for the module. e.g. CONFIGURABLE_BAD_IP.
-  "updateTime": "A String", # Output only. The time the module was last updated.
+  "description": "A String",
+  "displayName": "A String",
+  "enablementState": "A String",
+  "lastEditor": "A String",
+  "name": "A String",
+  "type": "A String",
+  "updateTime": "A String",
 }
 
   x__xgafv: string, V1 error format.
@@ -139,28 +139,28 @@ 

Method Details

Returns: An object of the form: - { # Represents an instance of an Event Threat Detection custom module, including its full module name, display name, enablement state, and last updated time. You can create a custom module at the organization, folder, or project level. Custom modules that you create at the organization or folder level are inherited by child folders and projects. - "ancestorModule": "A String", # Output only. The closest ancestor module that this module inherits the enablement state from. The format is the same as the EventThreatDetectionCustomModule resource name. - "cloudProvider": "A String", # The cloud provider of the custom module. - "config": { # Config for the module. For the resident module, its config value is defined at this level. For the inherited module, its config value is inherited from the ancestor module. + { + "ancestorModule": "A String", + "cloudProvider": "A String", + "config": { "a_key": "", # Properties of the object. }, - "description": "A String", # The description for the module. - "displayName": "A String", # The human readable name to be displayed for the module. - "enablementState": "A String", # The state of enablement for the module at the given level of the hierarchy. - "lastEditor": "A String", # Output only. The editor the module was last updated by. - "name": "A String", # Immutable. The resource name of the Event Threat Detection custom module. Its format is: * `organizations/{organization}/eventThreatDetectionSettings/customModules/{module}`. * `folders/{folder}/eventThreatDetectionSettings/customModules/{module}`. * `projects/{project}/eventThreatDetectionSettings/customModules/{module}`. - "type": "A String", # Type for the module. e.g. CONFIGURABLE_BAD_IP. - "updateTime": "A String", # Output only. The time the module was last updated. + "description": "A String", + "displayName": "A String", + "enablementState": "A String", + "lastEditor": "A String", + "name": "A String", + "type": "A String", + "updateTime": "A String", }
delete(name, x__xgafv=None) -
Deletes the specified Event Threat Detection custom module and all of its descendants in the Resource Manager hierarchy. This method is only supported for resident custom modules.
+  
 
 Args:
-  name: string, Required. Name of the custom module to delete. Its format is: * `organizations/{organization}/eventThreatDetectionSettings/customModules/{module}`. * `folders/{folder}/eventThreatDetectionSettings/customModules/{module}`. * `projects/{project}/eventThreatDetectionSettings/customModules/{module}`. (required)
+  name: string, A parameter (required)
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -169,16 +169,16 @@ 

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); } + { }
get(name, x__xgafv=None) -
Gets an Event Threat Detection custom module.
+  
 
 Args:
-  name: string, Required. Name of the custom module to get. Its format is: * `organizations/{organization}/eventThreatDetectionSettings/customModules/{module}`. * `folders/{folder}/eventThreatDetectionSettings/customModules/{module}`. * `projects/{project}/eventThreatDetectionSettings/customModules/{module}`. (required)
+  name: string, A parameter (required)
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -187,30 +187,30 @@ 

Method Details

Returns: An object of the form: - { # Represents an instance of an Event Threat Detection custom module, including its full module name, display name, enablement state, and last updated time. You can create a custom module at the organization, folder, or project level. Custom modules that you create at the organization or folder level are inherited by child folders and projects. - "ancestorModule": "A String", # Output only. The closest ancestor module that this module inherits the enablement state from. The format is the same as the EventThreatDetectionCustomModule resource name. - "cloudProvider": "A String", # The cloud provider of the custom module. - "config": { # Config for the module. For the resident module, its config value is defined at this level. For the inherited module, its config value is inherited from the ancestor module. + { + "ancestorModule": "A String", + "cloudProvider": "A String", + "config": { "a_key": "", # Properties of the object. }, - "description": "A String", # The description for the module. - "displayName": "A String", # The human readable name to be displayed for the module. - "enablementState": "A String", # The state of enablement for the module at the given level of the hierarchy. - "lastEditor": "A String", # Output only. The editor the module was last updated by. - "name": "A String", # Immutable. The resource name of the Event Threat Detection custom module. Its format is: * `organizations/{organization}/eventThreatDetectionSettings/customModules/{module}`. * `folders/{folder}/eventThreatDetectionSettings/customModules/{module}`. * `projects/{project}/eventThreatDetectionSettings/customModules/{module}`. - "type": "A String", # Type for the module. e.g. CONFIGURABLE_BAD_IP. - "updateTime": "A String", # Output only. The time the module was last updated. + "description": "A String", + "displayName": "A String", + "enablementState": "A String", + "lastEditor": "A String", + "name": "A String", + "type": "A String", + "updateTime": "A String", }
list(parent, pageSize=None, pageToken=None, x__xgafv=None) -
Lists all Event Threat Detection custom modules for the given Resource Manager parent. This includes resident modules defined at the scope of the parent along with modules inherited from ancestors.
+  
 
 Args:
-  parent: string, Required. Name of the parent to list custom modules under. Its format is: * `organizations/{organization}/eventThreatDetectionSettings`. * `folders/{folder}/eventThreatDetectionSettings`. * `projects/{project}/eventThreatDetectionSettings`. (required)
-  pageSize: integer, The maximum number of modules to return. The service may return fewer than this value. If unspecified, at most 10 configs will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
-  pageToken: string, A page token, received from a previous `ListEventThreatDetectionCustomModules` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListEventThreatDetectionCustomModules` must match the call that provided the page token.
+  parent: string, A parameter (required)
+  pageSize: integer, A parameter
+  pageToken: string, A parameter
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -219,35 +219,35 @@ 

Method Details

Returns: An object of the form: - { # Response for listing Event Threat Detection custom modules. - "eventThreatDetectionCustomModules": [ # Custom modules belonging to the requested parent. - { # Represents an instance of an Event Threat Detection custom module, including its full module name, display name, enablement state, and last updated time. You can create a custom module at the organization, folder, or project level. Custom modules that you create at the organization or folder level are inherited by child folders and projects. - "ancestorModule": "A String", # Output only. The closest ancestor module that this module inherits the enablement state from. The format is the same as the EventThreatDetectionCustomModule resource name. - "cloudProvider": "A String", # The cloud provider of the custom module. - "config": { # Config for the module. For the resident module, its config value is defined at this level. For the inherited module, its config value is inherited from the ancestor module. + { + "eventThreatDetectionCustomModules": [ + { + "ancestorModule": "A String", + "cloudProvider": "A String", + "config": { "a_key": "", # Properties of the object. }, - "description": "A String", # The description for the module. - "displayName": "A String", # The human readable name to be displayed for the module. - "enablementState": "A String", # The state of enablement for the module at the given level of the hierarchy. - "lastEditor": "A String", # Output only. The editor the module was last updated by. - "name": "A String", # Immutable. The resource name of the Event Threat Detection custom module. Its format is: * `organizations/{organization}/eventThreatDetectionSettings/customModules/{module}`. * `folders/{folder}/eventThreatDetectionSettings/customModules/{module}`. * `projects/{project}/eventThreatDetectionSettings/customModules/{module}`. - "type": "A String", # Type for the module. e.g. CONFIGURABLE_BAD_IP. - "updateTime": "A String", # Output only. The time the module was last updated. + "description": "A String", + "displayName": "A String", + "enablementState": "A String", + "lastEditor": "A String", + "name": "A String", + "type": "A String", + "updateTime": "A String", }, ], - "nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. + "nextPageToken": "A String", }
listDescendant(parent, pageSize=None, pageToken=None, x__xgafv=None) -
Lists all resident Event Threat Detection custom modules under the given Resource Manager parent and its descendants.
+  
 
 Args:
-  parent: string, Required. Name of the parent to list custom modules under. Its format is: * `organizations/{organization}/eventThreatDetectionSettings`. * `folders/{folder}/eventThreatDetectionSettings`. * `projects/{project}/eventThreatDetectionSettings`. (required)
-  pageSize: integer, The maximum number of modules to return. The service may return fewer than this value. If unspecified, at most 10 configs will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
-  pageToken: string, A page token, received from a previous `ListDescendantEventThreatDetectionCustomModules` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListDescendantEventThreatDetectionCustomModules` must match the call that provided the page token.
+  parent: string, A parameter (required)
+  pageSize: integer, A parameter
+  pageToken: string, A parameter
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -256,24 +256,24 @@ 

Method Details

Returns: An object of the form: - { # Response for listing current and descendant resident Event Threat Detection custom modules. - "eventThreatDetectionCustomModules": [ # Custom modules belonging to the requested parent. - { # Represents an instance of an Event Threat Detection custom module, including its full module name, display name, enablement state, and last updated time. You can create a custom module at the organization, folder, or project level. Custom modules that you create at the organization or folder level are inherited by child folders and projects. - "ancestorModule": "A String", # Output only. The closest ancestor module that this module inherits the enablement state from. The format is the same as the EventThreatDetectionCustomModule resource name. - "cloudProvider": "A String", # The cloud provider of the custom module. - "config": { # Config for the module. For the resident module, its config value is defined at this level. For the inherited module, its config value is inherited from the ancestor module. + { + "eventThreatDetectionCustomModules": [ + { + "ancestorModule": "A String", + "cloudProvider": "A String", + "config": { "a_key": "", # Properties of the object. }, - "description": "A String", # The description for the module. - "displayName": "A String", # The human readable name to be displayed for the module. - "enablementState": "A String", # The state of enablement for the module at the given level of the hierarchy. - "lastEditor": "A String", # Output only. The editor the module was last updated by. - "name": "A String", # Immutable. The resource name of the Event Threat Detection custom module. Its format is: * `organizations/{organization}/eventThreatDetectionSettings/customModules/{module}`. * `folders/{folder}/eventThreatDetectionSettings/customModules/{module}`. * `projects/{project}/eventThreatDetectionSettings/customModules/{module}`. - "type": "A String", # Type for the module. e.g. CONFIGURABLE_BAD_IP. - "updateTime": "A String", # Output only. The time the module was last updated. + "description": "A String", + "displayName": "A String", + "enablementState": "A String", + "lastEditor": "A String", + "name": "A String", + "type": "A String", + "updateTime": "A String", }, ], - "nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. + "nextPageToken": "A String", }
@@ -307,29 +307,29 @@

Method Details

patch(name, body=None, updateMask=None, x__xgafv=None) -
Updates the Event Threat Detection custom module with the given name based on the given update mask. Updating the enablement state is supported for both resident and inherited modules (though resident modules cannot have an enablement state of "inherited"). Updating the display name or configuration of a module is supported for resident modules only. The type of a module cannot be changed.
+  
 
 Args:
-  name: string, Immutable. The resource name of the Event Threat Detection custom module. Its format is: * `organizations/{organization}/eventThreatDetectionSettings/customModules/{module}`. * `folders/{folder}/eventThreatDetectionSettings/customModules/{module}`. * `projects/{project}/eventThreatDetectionSettings/customModules/{module}`. (required)
+  name: string, A parameter (required)
   body: object, The request body.
     The object takes the form of:
 
-{ # Represents an instance of an Event Threat Detection custom module, including its full module name, display name, enablement state, and last updated time. You can create a custom module at the organization, folder, or project level. Custom modules that you create at the organization or folder level are inherited by child folders and projects.
-  "ancestorModule": "A String", # Output only. The closest ancestor module that this module inherits the enablement state from. The format is the same as the EventThreatDetectionCustomModule resource name.
-  "cloudProvider": "A String", # The cloud provider of the custom module.
-  "config": { # Config for the module. For the resident module, its config value is defined at this level. For the inherited module, its config value is inherited from the ancestor module.
+{
+  "ancestorModule": "A String",
+  "cloudProvider": "A String",
+  "config": {
     "a_key": "", # Properties of the object.
   },
-  "description": "A String", # The description for the module.
-  "displayName": "A String", # The human readable name to be displayed for the module.
-  "enablementState": "A String", # The state of enablement for the module at the given level of the hierarchy.
-  "lastEditor": "A String", # Output only. The editor the module was last updated by.
-  "name": "A String", # Immutable. The resource name of the Event Threat Detection custom module. Its format is: * `organizations/{organization}/eventThreatDetectionSettings/customModules/{module}`. * `folders/{folder}/eventThreatDetectionSettings/customModules/{module}`. * `projects/{project}/eventThreatDetectionSettings/customModules/{module}`.
-  "type": "A String", # Type for the module. e.g. CONFIGURABLE_BAD_IP.
-  "updateTime": "A String", # Output only. The time the module was last updated.
+  "description": "A String",
+  "displayName": "A String",
+  "enablementState": "A String",
+  "lastEditor": "A String",
+  "name": "A String",
+  "type": "A String",
+  "updateTime": "A String",
 }
 
-  updateMask: string, The list of fields to be updated. If empty all mutable fields will be updated.
+  updateMask: string, A parameter
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -338,19 +338,19 @@ 

Method Details

Returns: An object of the form: - { # Represents an instance of an Event Threat Detection custom module, including its full module name, display name, enablement state, and last updated time. You can create a custom module at the organization, folder, or project level. Custom modules that you create at the organization or folder level are inherited by child folders and projects. - "ancestorModule": "A String", # Output only. The closest ancestor module that this module inherits the enablement state from. The format is the same as the EventThreatDetectionCustomModule resource name. - "cloudProvider": "A String", # The cloud provider of the custom module. - "config": { # Config for the module. For the resident module, its config value is defined at this level. For the inherited module, its config value is inherited from the ancestor module. + { + "ancestorModule": "A String", + "cloudProvider": "A String", + "config": { "a_key": "", # Properties of the object. }, - "description": "A String", # The description for the module. - "displayName": "A String", # The human readable name to be displayed for the module. - "enablementState": "A String", # The state of enablement for the module at the given level of the hierarchy. - "lastEditor": "A String", # Output only. The editor the module was last updated by. - "name": "A String", # Immutable. The resource name of the Event Threat Detection custom module. Its format is: * `organizations/{organization}/eventThreatDetectionSettings/customModules/{module}`. * `folders/{folder}/eventThreatDetectionSettings/customModules/{module}`. * `projects/{project}/eventThreatDetectionSettings/customModules/{module}`. - "type": "A String", # Type for the module. e.g. CONFIGURABLE_BAD_IP. - "updateTime": "A String", # Output only. The time the module was last updated. + "description": "A String", + "displayName": "A String", + "enablementState": "A String", + "lastEditor": "A String", + "name": "A String", + "type": "A String", + "updateTime": "A String", }
diff --git a/docs/dyn/securitycenter_v1.projects.eventThreatDetectionSettings.effectiveCustomModules.html b/docs/dyn/securitycenter_v1.projects.eventThreatDetectionSettings.effectiveCustomModules.html index e9c41329cb..914c434eb7 100644 --- a/docs/dyn/securitycenter_v1.projects.eventThreatDetectionSettings.effectiveCustomModules.html +++ b/docs/dyn/securitycenter_v1.projects.eventThreatDetectionSettings.effectiveCustomModules.html @@ -79,10 +79,10 @@

Instance Methods

Close httplib2 connections.

get(name, x__xgafv=None)

-

Gets an effective Event Threat Detection custom module at the given level.

+

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

-

Lists all effective Event Threat Detection custom modules for the given parent. This includes resident modules defined at the scope of the parent along with modules inherited from its ancestors.

+

list_next()

Retrieves the next page of results.

@@ -94,10 +94,10 @@

Method Details

get(name, x__xgafv=None) -
Gets an effective Event Threat Detection custom module at the given level.
+  
 
 Args:
-  name: string, Required. The resource name of the effective Event Threat Detection custom module. Its format is: * `organizations/{organization}/eventThreatDetectionSettings/effectiveCustomModules/{module}`. * `folders/{folder}/eventThreatDetectionSettings/effectiveCustomModules/{module}`. * `projects/{project}/eventThreatDetectionSettings/effectiveCustomModules/{module}`. (required)
+  name: string, A parameter (required)
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -106,27 +106,27 @@ 

Method Details

Returns: An object of the form: - { # An EffectiveEventThreatDetectionCustomModule is the representation of an Event Threat Detection custom module at a specified level of the resource hierarchy: organization, folder, or project. If a custom module is inherited from a parent organization or folder, the value of the `enablement_state` property in EffectiveEventThreatDetectionCustomModule is set to the value that is effective in the parent, instead of `INHERITED`. For example, if the module is enabled in a parent organization or folder, the effective `enablement_state` for the module in all child folders or projects is also `enabled`. EffectiveEventThreatDetectionCustomModule is read-only. - "cloudProvider": "A String", # The cloud provider of the custom module. - "config": { # Output only. Config for the effective module. + { + "cloudProvider": "A String", + "config": { "a_key": "", # Properties of the object. }, - "description": "A String", # Output only. The description for the module. - "displayName": "A String", # Output only. The human readable name to be displayed for the module. - "enablementState": "A String", # Output only. The effective state of enablement for the module at the given level of the hierarchy. - "name": "A String", # Output only. The resource name of the effective ETD custom module. Its format is: * `organizations/{organization}/eventThreatDetectionSettings/effectiveCustomModules/{module}`. * `folders/{folder}/eventThreatDetectionSettings/effectiveCustomModules/{module}`. * `projects/{project}/eventThreatDetectionSettings/effectiveCustomModules/{module}`. - "type": "A String", # Output only. Type for the module. e.g. CONFIGURABLE_BAD_IP. + "description": "A String", + "displayName": "A String", + "enablementState": "A String", + "name": "A String", + "type": "A String", }
list(parent, pageSize=None, pageToken=None, x__xgafv=None) -
Lists all effective Event Threat Detection custom modules for the given parent. This includes resident modules defined at the scope of the parent along with modules inherited from its ancestors.
+  
 
 Args:
-  parent: string, Required. Name of the parent to list custom modules for. Its format is: * `organizations/{organization}/eventThreatDetectionSettings`. * `folders/{folder}/eventThreatDetectionSettings`. * `projects/{project}/eventThreatDetectionSettings`. (required)
-  pageSize: integer, The maximum number of modules to return. The service may return fewer than this value. If unspecified, at most 10 configs will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
-  pageToken: string, A page token, received from a previous `ListEffectiveEventThreatDetectionCustomModules` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListEffectiveEventThreatDetectionCustomModules` must match the call that provided the page token.
+  parent: string, A parameter (required)
+  pageSize: integer, A parameter
+  pageToken: string, A parameter
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -135,21 +135,21 @@ 

Method Details

Returns: An object of the form: - { # Response for listing EffectiveEventThreatDetectionCustomModules. - "effectiveEventThreatDetectionCustomModules": [ # Effective custom modules belonging to the requested parent. - { # An EffectiveEventThreatDetectionCustomModule is the representation of an Event Threat Detection custom module at a specified level of the resource hierarchy: organization, folder, or project. If a custom module is inherited from a parent organization or folder, the value of the `enablement_state` property in EffectiveEventThreatDetectionCustomModule is set to the value that is effective in the parent, instead of `INHERITED`. For example, if the module is enabled in a parent organization or folder, the effective `enablement_state` for the module in all child folders or projects is also `enabled`. EffectiveEventThreatDetectionCustomModule is read-only. - "cloudProvider": "A String", # The cloud provider of the custom module. - "config": { # Output only. Config for the effective module. + { + "effectiveEventThreatDetectionCustomModules": [ + { + "cloudProvider": "A String", + "config": { "a_key": "", # Properties of the object. }, - "description": "A String", # Output only. The description for the module. - "displayName": "A String", # Output only. The human readable name to be displayed for the module. - "enablementState": "A String", # Output only. The effective state of enablement for the module at the given level of the hierarchy. - "name": "A String", # Output only. The resource name of the effective ETD custom module. Its format is: * `organizations/{organization}/eventThreatDetectionSettings/effectiveCustomModules/{module}`. * `folders/{folder}/eventThreatDetectionSettings/effectiveCustomModules/{module}`. * `projects/{project}/eventThreatDetectionSettings/effectiveCustomModules/{module}`. - "type": "A String", # Output only. Type for the module. e.g. CONFIGURABLE_BAD_IP. + "description": "A String", + "displayName": "A String", + "enablementState": "A String", + "name": "A String", + "type": "A String", }, ], - "nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. + "nextPageToken": "A String", }
diff --git a/docs/dyn/securitycenter_v1.projects.eventThreatDetectionSettings.html b/docs/dyn/securitycenter_v1.projects.eventThreatDetectionSettings.html index 4e98a53963..d153a5d42f 100644 --- a/docs/dyn/securitycenter_v1.projects.eventThreatDetectionSettings.html +++ b/docs/dyn/securitycenter_v1.projects.eventThreatDetectionSettings.html @@ -89,7 +89,7 @@

Instance Methods

Close httplib2 connections.

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

-

Validates the given Event Threat Detection custom module.

+

Method Details

close() @@ -98,16 +98,16 @@

Method Details

validateCustomModule(parent, body=None, x__xgafv=None) -
Validates the given Event Threat Detection custom module.
+  
 
 Args:
-  parent: string, Required. Resource name of the parent to validate the Custom Module under. Its format is: * `organizations/{organization}/eventThreatDetectionSettings`. * `folders/{folder}/eventThreatDetectionSettings`. * `projects/{project}/eventThreatDetectionSettings`. (required)
+  parent: string, A parameter (required)
   body: object, The request body.
     The object takes the form of:
 
-{ # Request to validate an Event Threat Detection custom module.
-  "rawText": "A String", # Required. The raw text of the module's contents. Used to generate error messages.
-  "type": "A String", # Required. The type of the module (e.g. CONFIGURABLE_BAD_IP).
+{
+  "rawText": "A String",
+  "type": "A String",
 }
 
   x__xgafv: string, V1 error format.
@@ -118,19 +118,19 @@ 

Method Details

Returns: An object of the form: - { # Response to validating an Event Threat Detection custom module. - "errors": { # A list of zero or more errors encountered while validating the uploaded configuration of an Event Threat Detection Custom Module. # A list of errors returned by the validator. If the list is empty, there were no errors. - "errors": [ # The list of errors. - { # An error encountered while validating the uploaded configuration of an Event Threat Detection Custom Module. - "description": "A String", # A description of the error, suitable for human consumption. Required. - "end": { # A position in the uploaded text version of a module. # The end position of the error in the uploaded text version of the module. This field may be omitted if no specific position applies, or if one could not be computed. - "columnNumber": 42, # The column number. - "lineNumber": 42, # The line number. + { + "errors": { + "errors": [ + { + "description": "A String", + "end": { + "columnNumber": 42, + "lineNumber": 42, }, - "fieldPath": "A String", # The path, in RFC 8901 JSON Pointer format, to the field that failed validation. This may be left empty if no specific field is affected. - "start": { # A position in the uploaded text version of a module. # The initial position of the error in the uploaded text version of the module. This field may be omitted if no specific position applies, or if one could not be computed. - "columnNumber": 42, # The column number. - "lineNumber": 42, # The line number. + "fieldPath": "A String", + "start": { + "columnNumber": 42, + "lineNumber": 42, }, }, ], diff --git a/docs/dyn/securitycenter_v1.projects.findings.html b/docs/dyn/securitycenter_v1.projects.findings.html index 678ab1c4e3..9f67442c0d 100644 --- a/docs/dyn/securitycenter_v1.projects.findings.html +++ b/docs/dyn/securitycenter_v1.projects.findings.html @@ -76,24 +76,24 @@

Security Command Center API . bulkMute(parent, body=None, x__xgafv=None)

-

Kicks off an LRO to bulk mute findings for a parent based on a filter. The parent can be either an organization, folder or project. The findings matched by the filter will be muted after the LRO is done.

+

close()

Close httplib2 connections.

Method Details

bulkMute(parent, body=None, x__xgafv=None) -
Kicks off an LRO to bulk mute findings for a parent based on a filter. The parent can be either an organization, folder or project. The findings matched by the filter will be muted after the LRO is done.
+  
 
 Args:
-  parent: string, Required. The parent, at which bulk action needs to be applied. Its format is `organizations/[organization_id]`, `folders/[folder_id]`, `projects/[project_id]`. (required)
+  parent: string, A parameter (required)
   body: object, The request body.
     The object takes the form of:
 
-{ # Request message for bulk findings update. Note: 1. If multiple bulk update requests match the same resource, the order in which they get executed is not defined. 2. Once a bulk operation is started, there is no way to stop it.
-  "filter": "A String", # Expression that identifies findings that should be updated. The expression is a list of zero or more restrictions combined via logical operators `AND` and `OR`. Parentheses are supported, and `OR` has higher precedence than `AND`. Restrictions have the form ` ` and may have a `-` character in front of them to indicate negation. The fields map to those defined in the corresponding resource. The supported operators are: * `=` for all value types. * `>`, `<`, `>=`, `<=` for integer values. * `:`, meaning substring matching, for strings. The supported value types are: * string literals in quotes. * integer literals without quotes. * boolean literals `true` and `false` without quotes.
-  "muteAnnotation": "A String", # This can be a mute configuration name or any identifier for mute/unmute of findings based on the filter.
-  "muteState": "A String", # Optional. All findings matching the given filter will have their mute state set to this value. The default value is `MUTED`. Setting this to `UNDEFINED` will clear the mute state on all matching findings.
+{
+  "filter": "A String",
+  "muteAnnotation": "A String",
+  "muteState": "A String",
 }
 
   x__xgafv: string, V1 error format.
@@ -104,22 +104,22 @@ 

Method Details

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. + { + "done": True or False, + "error": { + "code": 42, + "details": [ { "a_key": "", # Properties of the object. Contains field @type with type URL. }, ], - "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. + "message": "A String", }, - "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. + "metadata": { "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`. + "name": "A String", + "response": { "a_key": "", # Properties of the object. Contains field @type with type URL. }, }
diff --git a/docs/dyn/securitycenter_v1.projects.locations.muteConfigs.html b/docs/dyn/securitycenter_v1.projects.locations.muteConfigs.html index c8f2f30294..eb78b997cd 100644 --- a/docs/dyn/securitycenter_v1.projects.locations.muteConfigs.html +++ b/docs/dyn/securitycenter_v1.projects.locations.muteConfigs.html @@ -79,13 +79,13 @@

Instance Methods

Close httplib2 connections.

delete(name, x__xgafv=None)

-

Deletes an existing mute config.

+

get(name, x__xgafv=None)

-

Gets a mute config.

+

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

-

Updates a mute config.

+

Method Details

close() @@ -94,10 +94,10 @@

Method Details

delete(name, x__xgafv=None) -
Deletes an existing mute config.
+  
 
 Args:
-  name: string, Required. Name of the mute config to delete. Its format is `organizations/{organization}/muteConfigs/{config_id}`, `folders/{folder}/muteConfigs/{config_id}`, `projects/{project}/muteConfigs/{config_id}`, `organizations/{organization}/locations/global/muteConfigs/{config_id}`, `folders/{folder}/locations/global/muteConfigs/{config_id}`, or `projects/{project}/locations/global/muteConfigs/{config_id}`. (required)
+  name: string, A parameter (required)
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -106,16 +106,16 @@ 

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); } + { }
get(name, x__xgafv=None) -
Gets a mute config.
+  
 
 Args:
-  name: string, Required. Name of the mute config to retrieve. Its format is `organizations/{organization}/muteConfigs/{config_id}`, `folders/{folder}/muteConfigs/{config_id}`, `projects/{project}/muteConfigs/{config_id}`, `organizations/{organization}/locations/global/muteConfigs/{config_id}`, `folders/{folder}/locations/global/muteConfigs/{config_id}`, or `projects/{project}/locations/global/muteConfigs/{config_id}`. (required)
+  name: string, A parameter (required)
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -124,41 +124,41 @@ 

Method Details

Returns: An object of the form: - { # A mute config is a Cloud SCC resource that contains the configuration to mute create/update events of findings. - "createTime": "A String", # Output only. The time at which the mute config was created. This field is set by the server and will be ignored if provided on config creation. - "description": "A String", # A description of the mute config. - "displayName": "A String", # The human readable name to be displayed for the mute config. - "expiryTime": "A String", # Optional. The expiry of the mute config. Only applicable for dynamic configs. If the expiry is set, when the config expires, it is removed from all findings. - "filter": "A String", # Required. An expression that defines the filter to apply across create/update events of findings. While creating a filter string, be mindful of the scope in which the mute configuration is being created. E.g., If a filter contains project = X but is created under the project = Y scope, it might not match any findings. The following field and operator combinations are supported: * severity: `=`, `:` * category: `=`, `:` * resource.name: `=`, `:` * resource.project_name: `=`, `:` * resource.project_display_name: `=`, `:` * resource.folders.resource_folder: `=`, `:` * resource.parent_name: `=`, `:` * resource.parent_display_name: `=`, `:` * resource.type: `=`, `:` * finding_class: `=`, `:` * indicator.ip_addresses: `=`, `:` * indicator.domains: `=`, `:` - "mostRecentEditor": "A String", # Output only. Email address of the user who last edited the mute config. This field is set by the server and will be ignored if provided on config creation or update. - "name": "A String", # This field will be ignored if provided on config creation. Format `organizations/{organization}/muteConfigs/{mute_config}` `folders/{folder}/muteConfigs/{mute_config}` `projects/{project}/muteConfigs/{mute_config}` `organizations/{organization}/locations/global/muteConfigs/{mute_config}` `folders/{folder}/locations/global/muteConfigs/{mute_config}` `projects/{project}/locations/global/muteConfigs/{mute_config}` - "type": "A String", # Optional. The type of the mute config, which determines what type of mute state the config affects. The static mute state takes precedence over the dynamic mute state. Immutable after creation. STATIC by default if not set during creation. - "updateTime": "A String", # Output only. The most recent time at which the mute config was updated. This field is set by the server and will be ignored if provided on config creation or update. + { + "createTime": "A String", + "description": "A String", + "displayName": "A String", + "expiryTime": "A String", + "filter": "A String", + "mostRecentEditor": "A String", + "name": "A String", + "type": "A String", + "updateTime": "A String", }
patch(name, body=None, updateMask=None, x__xgafv=None) -
Updates a mute config.
+  
 
 Args:
-  name: string, This field will be ignored if provided on config creation. Format `organizations/{organization}/muteConfigs/{mute_config}` `folders/{folder}/muteConfigs/{mute_config}` `projects/{project}/muteConfigs/{mute_config}` `organizations/{organization}/locations/global/muteConfigs/{mute_config}` `folders/{folder}/locations/global/muteConfigs/{mute_config}` `projects/{project}/locations/global/muteConfigs/{mute_config}` (required)
+  name: string, A parameter (required)
   body: object, The request body.
     The object takes the form of:
 
-{ # A mute config is a Cloud SCC resource that contains the configuration to mute create/update events of findings.
-  "createTime": "A String", # Output only. The time at which the mute config was created. This field is set by the server and will be ignored if provided on config creation.
-  "description": "A String", # A description of the mute config.
-  "displayName": "A String", # The human readable name to be displayed for the mute config.
-  "expiryTime": "A String", # Optional. The expiry of the mute config. Only applicable for dynamic configs. If the expiry is set, when the config expires, it is removed from all findings.
-  "filter": "A String", # Required. An expression that defines the filter to apply across create/update events of findings. While creating a filter string, be mindful of the scope in which the mute configuration is being created. E.g., If a filter contains project = X but is created under the project = Y scope, it might not match any findings. The following field and operator combinations are supported: * severity: `=`, `:` * category: `=`, `:` * resource.name: `=`, `:` * resource.project_name: `=`, `:` * resource.project_display_name: `=`, `:` * resource.folders.resource_folder: `=`, `:` * resource.parent_name: `=`, `:` * resource.parent_display_name: `=`, `:` * resource.type: `=`, `:` * finding_class: `=`, `:` * indicator.ip_addresses: `=`, `:` * indicator.domains: `=`, `:`
-  "mostRecentEditor": "A String", # Output only. Email address of the user who last edited the mute config. This field is set by the server and will be ignored if provided on config creation or update.
-  "name": "A String", # This field will be ignored if provided on config creation. Format `organizations/{organization}/muteConfigs/{mute_config}` `folders/{folder}/muteConfigs/{mute_config}` `projects/{project}/muteConfigs/{mute_config}` `organizations/{organization}/locations/global/muteConfigs/{mute_config}` `folders/{folder}/locations/global/muteConfigs/{mute_config}` `projects/{project}/locations/global/muteConfigs/{mute_config}`
-  "type": "A String", # Optional. The type of the mute config, which determines what type of mute state the config affects. The static mute state takes precedence over the dynamic mute state. Immutable after creation. STATIC by default if not set during creation.
-  "updateTime": "A String", # Output only. The most recent time at which the mute config was updated. This field is set by the server and will be ignored if provided on config creation or update.
+{
+  "createTime": "A String",
+  "description": "A String",
+  "displayName": "A String",
+  "expiryTime": "A String",
+  "filter": "A String",
+  "mostRecentEditor": "A String",
+  "name": "A String",
+  "type": "A String",
+  "updateTime": "A String",
 }
 
-  updateMask: string, The list of fields to be updated. If empty all mutable fields will be updated.
+  updateMask: string, A parameter
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -167,16 +167,16 @@ 

Method Details

Returns: An object of the form: - { # A mute config is a Cloud SCC resource that contains the configuration to mute create/update events of findings. - "createTime": "A String", # Output only. The time at which the mute config was created. This field is set by the server and will be ignored if provided on config creation. - "description": "A String", # A description of the mute config. - "displayName": "A String", # The human readable name to be displayed for the mute config. - "expiryTime": "A String", # Optional. The expiry of the mute config. Only applicable for dynamic configs. If the expiry is set, when the config expires, it is removed from all findings. - "filter": "A String", # Required. An expression that defines the filter to apply across create/update events of findings. While creating a filter string, be mindful of the scope in which the mute configuration is being created. E.g., If a filter contains project = X but is created under the project = Y scope, it might not match any findings. The following field and operator combinations are supported: * severity: `=`, `:` * category: `=`, `:` * resource.name: `=`, `:` * resource.project_name: `=`, `:` * resource.project_display_name: `=`, `:` * resource.folders.resource_folder: `=`, `:` * resource.parent_name: `=`, `:` * resource.parent_display_name: `=`, `:` * resource.type: `=`, `:` * finding_class: `=`, `:` * indicator.ip_addresses: `=`, `:` * indicator.domains: `=`, `:` - "mostRecentEditor": "A String", # Output only. Email address of the user who last edited the mute config. This field is set by the server and will be ignored if provided on config creation or update. - "name": "A String", # This field will be ignored if provided on config creation. Format `organizations/{organization}/muteConfigs/{mute_config}` `folders/{folder}/muteConfigs/{mute_config}` `projects/{project}/muteConfigs/{mute_config}` `organizations/{organization}/locations/global/muteConfigs/{mute_config}` `folders/{folder}/locations/global/muteConfigs/{mute_config}` `projects/{project}/locations/global/muteConfigs/{mute_config}` - "type": "A String", # Optional. The type of the mute config, which determines what type of mute state the config affects. The static mute state takes precedence over the dynamic mute state. Immutable after creation. STATIC by default if not set during creation. - "updateTime": "A String", # Output only. The most recent time at which the mute config was updated. This field is set by the server and will be ignored if provided on config creation or update. + { + "createTime": "A String", + "description": "A String", + "displayName": "A String", + "expiryTime": "A String", + "filter": "A String", + "mostRecentEditor": "A String", + "name": "A String", + "type": "A String", + "updateTime": "A String", }
diff --git a/docs/dyn/securitycenter_v1.projects.muteConfigs.html b/docs/dyn/securitycenter_v1.projects.muteConfigs.html index 1436c2cf32..9e49a9a66c 100644 --- a/docs/dyn/securitycenter_v1.projects.muteConfigs.html +++ b/docs/dyn/securitycenter_v1.projects.muteConfigs.html @@ -79,22 +79,22 @@

Instance Methods

Close httplib2 connections.

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

-

Creates a mute config.

+

delete(name, x__xgafv=None)

-

Deletes an existing mute config.

+

get(name, x__xgafv=None)

-

Gets a mute config.

+

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

-

Lists mute configs.

+

list_next()

Retrieves the next page of results.

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

-

Updates a mute config.

+

Method Details

close() @@ -103,26 +103,26 @@

Method Details

create(parent, body=None, muteConfigId=None, x__xgafv=None) -
Creates a mute config.
+  
 
 Args:
-  parent: string, Required. Resource name of the new mute configs's parent. Its format is `organizations/[organization_id]`, `folders/[folder_id]`, or `projects/[project_id]`. (required)
+  parent: string, A parameter (required)
   body: object, The request body.
     The object takes the form of:
 
-{ # A mute config is a Cloud SCC resource that contains the configuration to mute create/update events of findings.
-  "createTime": "A String", # Output only. The time at which the mute config was created. This field is set by the server and will be ignored if provided on config creation.
-  "description": "A String", # A description of the mute config.
-  "displayName": "A String", # The human readable name to be displayed for the mute config.
-  "expiryTime": "A String", # Optional. The expiry of the mute config. Only applicable for dynamic configs. If the expiry is set, when the config expires, it is removed from all findings.
-  "filter": "A String", # Required. An expression that defines the filter to apply across create/update events of findings. While creating a filter string, be mindful of the scope in which the mute configuration is being created. E.g., If a filter contains project = X but is created under the project = Y scope, it might not match any findings. The following field and operator combinations are supported: * severity: `=`, `:` * category: `=`, `:` * resource.name: `=`, `:` * resource.project_name: `=`, `:` * resource.project_display_name: `=`, `:` * resource.folders.resource_folder: `=`, `:` * resource.parent_name: `=`, `:` * resource.parent_display_name: `=`, `:` * resource.type: `=`, `:` * finding_class: `=`, `:` * indicator.ip_addresses: `=`, `:` * indicator.domains: `=`, `:`
-  "mostRecentEditor": "A String", # Output only. Email address of the user who last edited the mute config. This field is set by the server and will be ignored if provided on config creation or update.
-  "name": "A String", # This field will be ignored if provided on config creation. Format `organizations/{organization}/muteConfigs/{mute_config}` `folders/{folder}/muteConfigs/{mute_config}` `projects/{project}/muteConfigs/{mute_config}` `organizations/{organization}/locations/global/muteConfigs/{mute_config}` `folders/{folder}/locations/global/muteConfigs/{mute_config}` `projects/{project}/locations/global/muteConfigs/{mute_config}`
-  "type": "A String", # Optional. The type of the mute config, which determines what type of mute state the config affects. The static mute state takes precedence over the dynamic mute state. Immutable after creation. STATIC by default if not set during creation.
-  "updateTime": "A String", # Output only. The most recent time at which the mute config was updated. This field is set by the server and will be ignored if provided on config creation or update.
+{
+  "createTime": "A String",
+  "description": "A String",
+  "displayName": "A String",
+  "expiryTime": "A String",
+  "filter": "A String",
+  "mostRecentEditor": "A String",
+  "name": "A String",
+  "type": "A String",
+  "updateTime": "A String",
 }
 
-  muteConfigId: string, Required. Unique identifier provided by the client within the parent scope. It must consist of only lowercase letters, numbers, and hyphens, must start with a letter, must end with either a letter or a number, and must be 63 characters or less.
+  muteConfigId: string, A parameter
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -131,25 +131,25 @@ 

Method Details

Returns: An object of the form: - { # A mute config is a Cloud SCC resource that contains the configuration to mute create/update events of findings. - "createTime": "A String", # Output only. The time at which the mute config was created. This field is set by the server and will be ignored if provided on config creation. - "description": "A String", # A description of the mute config. - "displayName": "A String", # The human readable name to be displayed for the mute config. - "expiryTime": "A String", # Optional. The expiry of the mute config. Only applicable for dynamic configs. If the expiry is set, when the config expires, it is removed from all findings. - "filter": "A String", # Required. An expression that defines the filter to apply across create/update events of findings. While creating a filter string, be mindful of the scope in which the mute configuration is being created. E.g., If a filter contains project = X but is created under the project = Y scope, it might not match any findings. The following field and operator combinations are supported: * severity: `=`, `:` * category: `=`, `:` * resource.name: `=`, `:` * resource.project_name: `=`, `:` * resource.project_display_name: `=`, `:` * resource.folders.resource_folder: `=`, `:` * resource.parent_name: `=`, `:` * resource.parent_display_name: `=`, `:` * resource.type: `=`, `:` * finding_class: `=`, `:` * indicator.ip_addresses: `=`, `:` * indicator.domains: `=`, `:` - "mostRecentEditor": "A String", # Output only. Email address of the user who last edited the mute config. This field is set by the server and will be ignored if provided on config creation or update. - "name": "A String", # This field will be ignored if provided on config creation. Format `organizations/{organization}/muteConfigs/{mute_config}` `folders/{folder}/muteConfigs/{mute_config}` `projects/{project}/muteConfigs/{mute_config}` `organizations/{organization}/locations/global/muteConfigs/{mute_config}` `folders/{folder}/locations/global/muteConfigs/{mute_config}` `projects/{project}/locations/global/muteConfigs/{mute_config}` - "type": "A String", # Optional. The type of the mute config, which determines what type of mute state the config affects. The static mute state takes precedence over the dynamic mute state. Immutable after creation. STATIC by default if not set during creation. - "updateTime": "A String", # Output only. The most recent time at which the mute config was updated. This field is set by the server and will be ignored if provided on config creation or update. + { + "createTime": "A String", + "description": "A String", + "displayName": "A String", + "expiryTime": "A String", + "filter": "A String", + "mostRecentEditor": "A String", + "name": "A String", + "type": "A String", + "updateTime": "A String", }
delete(name, x__xgafv=None) -
Deletes an existing mute config.
+  
 
 Args:
-  name: string, Required. Name of the mute config to delete. Its format is `organizations/{organization}/muteConfigs/{config_id}`, `folders/{folder}/muteConfigs/{config_id}`, `projects/{project}/muteConfigs/{config_id}`, `organizations/{organization}/locations/global/muteConfigs/{config_id}`, `folders/{folder}/locations/global/muteConfigs/{config_id}`, or `projects/{project}/locations/global/muteConfigs/{config_id}`. (required)
+  name: string, A parameter (required)
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -158,16 +158,16 @@ 

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); } + { }
get(name, x__xgafv=None) -
Gets a mute config.
+  
 
 Args:
-  name: string, Required. Name of the mute config to retrieve. Its format is `organizations/{organization}/muteConfigs/{config_id}`, `folders/{folder}/muteConfigs/{config_id}`, `projects/{project}/muteConfigs/{config_id}`, `organizations/{organization}/locations/global/muteConfigs/{config_id}`, `folders/{folder}/locations/global/muteConfigs/{config_id}`, or `projects/{project}/locations/global/muteConfigs/{config_id}`. (required)
+  name: string, A parameter (required)
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -176,27 +176,27 @@ 

Method Details

Returns: An object of the form: - { # A mute config is a Cloud SCC resource that contains the configuration to mute create/update events of findings. - "createTime": "A String", # Output only. The time at which the mute config was created. This field is set by the server and will be ignored if provided on config creation. - "description": "A String", # A description of the mute config. - "displayName": "A String", # The human readable name to be displayed for the mute config. - "expiryTime": "A String", # Optional. The expiry of the mute config. Only applicable for dynamic configs. If the expiry is set, when the config expires, it is removed from all findings. - "filter": "A String", # Required. An expression that defines the filter to apply across create/update events of findings. While creating a filter string, be mindful of the scope in which the mute configuration is being created. E.g., If a filter contains project = X but is created under the project = Y scope, it might not match any findings. The following field and operator combinations are supported: * severity: `=`, `:` * category: `=`, `:` * resource.name: `=`, `:` * resource.project_name: `=`, `:` * resource.project_display_name: `=`, `:` * resource.folders.resource_folder: `=`, `:` * resource.parent_name: `=`, `:` * resource.parent_display_name: `=`, `:` * resource.type: `=`, `:` * finding_class: `=`, `:` * indicator.ip_addresses: `=`, `:` * indicator.domains: `=`, `:` - "mostRecentEditor": "A String", # Output only. Email address of the user who last edited the mute config. This field is set by the server and will be ignored if provided on config creation or update. - "name": "A String", # This field will be ignored if provided on config creation. Format `organizations/{organization}/muteConfigs/{mute_config}` `folders/{folder}/muteConfigs/{mute_config}` `projects/{project}/muteConfigs/{mute_config}` `organizations/{organization}/locations/global/muteConfigs/{mute_config}` `folders/{folder}/locations/global/muteConfigs/{mute_config}` `projects/{project}/locations/global/muteConfigs/{mute_config}` - "type": "A String", # Optional. The type of the mute config, which determines what type of mute state the config affects. The static mute state takes precedence over the dynamic mute state. Immutable after creation. STATIC by default if not set during creation. - "updateTime": "A String", # Output only. The most recent time at which the mute config was updated. This field is set by the server and will be ignored if provided on config creation or update. + { + "createTime": "A String", + "description": "A String", + "displayName": "A String", + "expiryTime": "A String", + "filter": "A String", + "mostRecentEditor": "A String", + "name": "A String", + "type": "A String", + "updateTime": "A String", }
list(parent, pageSize=None, pageToken=None, x__xgafv=None) -
Lists mute configs.
+  
 
 Args:
-  parent: string, Required. The parent, which owns the collection of mute configs. Its format is `organizations/[organization_id]`, `folders/[folder_id]`, `projects/[project_id]`. (required)
-  pageSize: integer, The maximum number of configs to return. The service may return fewer than this value. If unspecified, at most 10 configs will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
-  pageToken: string, A page token, received from a previous `ListMuteConfigs` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListMuteConfigs` must match the call that provided the page token.
+  parent: string, A parameter (required)
+  pageSize: integer, A parameter
+  pageToken: string, A parameter
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -205,21 +205,21 @@ 

Method Details

Returns: An object of the form: - { # Response message for listing mute configs. - "muteConfigs": [ # The mute configs from the specified parent. - { # A mute config is a Cloud SCC resource that contains the configuration to mute create/update events of findings. - "createTime": "A String", # Output only. The time at which the mute config was created. This field is set by the server and will be ignored if provided on config creation. - "description": "A String", # A description of the mute config. - "displayName": "A String", # The human readable name to be displayed for the mute config. - "expiryTime": "A String", # Optional. The expiry of the mute config. Only applicable for dynamic configs. If the expiry is set, when the config expires, it is removed from all findings. - "filter": "A String", # Required. An expression that defines the filter to apply across create/update events of findings. While creating a filter string, be mindful of the scope in which the mute configuration is being created. E.g., If a filter contains project = X but is created under the project = Y scope, it might not match any findings. The following field and operator combinations are supported: * severity: `=`, `:` * category: `=`, `:` * resource.name: `=`, `:` * resource.project_name: `=`, `:` * resource.project_display_name: `=`, `:` * resource.folders.resource_folder: `=`, `:` * resource.parent_name: `=`, `:` * resource.parent_display_name: `=`, `:` * resource.type: `=`, `:` * finding_class: `=`, `:` * indicator.ip_addresses: `=`, `:` * indicator.domains: `=`, `:` - "mostRecentEditor": "A String", # Output only. Email address of the user who last edited the mute config. This field is set by the server and will be ignored if provided on config creation or update. - "name": "A String", # This field will be ignored if provided on config creation. Format `organizations/{organization}/muteConfigs/{mute_config}` `folders/{folder}/muteConfigs/{mute_config}` `projects/{project}/muteConfigs/{mute_config}` `organizations/{organization}/locations/global/muteConfigs/{mute_config}` `folders/{folder}/locations/global/muteConfigs/{mute_config}` `projects/{project}/locations/global/muteConfigs/{mute_config}` - "type": "A String", # Optional. The type of the mute config, which determines what type of mute state the config affects. The static mute state takes precedence over the dynamic mute state. Immutable after creation. STATIC by default if not set during creation. - "updateTime": "A String", # Output only. The most recent time at which the mute config was updated. This field is set by the server and will be ignored if provided on config creation or update. + { + "muteConfigs": [ + { + "createTime": "A String", + "description": "A String", + "displayName": "A String", + "expiryTime": "A String", + "filter": "A String", + "mostRecentEditor": "A String", + "name": "A String", + "type": "A String", + "updateTime": "A String", }, ], - "nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. + "nextPageToken": "A String", }
@@ -239,26 +239,26 @@

Method Details

patch(name, body=None, updateMask=None, x__xgafv=None) -
Updates a mute config.
+  
 
 Args:
-  name: string, This field will be ignored if provided on config creation. Format `organizations/{organization}/muteConfigs/{mute_config}` `folders/{folder}/muteConfigs/{mute_config}` `projects/{project}/muteConfigs/{mute_config}` `organizations/{organization}/locations/global/muteConfigs/{mute_config}` `folders/{folder}/locations/global/muteConfigs/{mute_config}` `projects/{project}/locations/global/muteConfigs/{mute_config}` (required)
+  name: string, A parameter (required)
   body: object, The request body.
     The object takes the form of:
 
-{ # A mute config is a Cloud SCC resource that contains the configuration to mute create/update events of findings.
-  "createTime": "A String", # Output only. The time at which the mute config was created. This field is set by the server and will be ignored if provided on config creation.
-  "description": "A String", # A description of the mute config.
-  "displayName": "A String", # The human readable name to be displayed for the mute config.
-  "expiryTime": "A String", # Optional. The expiry of the mute config. Only applicable for dynamic configs. If the expiry is set, when the config expires, it is removed from all findings.
-  "filter": "A String", # Required. An expression that defines the filter to apply across create/update events of findings. While creating a filter string, be mindful of the scope in which the mute configuration is being created. E.g., If a filter contains project = X but is created under the project = Y scope, it might not match any findings. The following field and operator combinations are supported: * severity: `=`, `:` * category: `=`, `:` * resource.name: `=`, `:` * resource.project_name: `=`, `:` * resource.project_display_name: `=`, `:` * resource.folders.resource_folder: `=`, `:` * resource.parent_name: `=`, `:` * resource.parent_display_name: `=`, `:` * resource.type: `=`, `:` * finding_class: `=`, `:` * indicator.ip_addresses: `=`, `:` * indicator.domains: `=`, `:`
-  "mostRecentEditor": "A String", # Output only. Email address of the user who last edited the mute config. This field is set by the server and will be ignored if provided on config creation or update.
-  "name": "A String", # This field will be ignored if provided on config creation. Format `organizations/{organization}/muteConfigs/{mute_config}` `folders/{folder}/muteConfigs/{mute_config}` `projects/{project}/muteConfigs/{mute_config}` `organizations/{organization}/locations/global/muteConfigs/{mute_config}` `folders/{folder}/locations/global/muteConfigs/{mute_config}` `projects/{project}/locations/global/muteConfigs/{mute_config}`
-  "type": "A String", # Optional. The type of the mute config, which determines what type of mute state the config affects. The static mute state takes precedence over the dynamic mute state. Immutable after creation. STATIC by default if not set during creation.
-  "updateTime": "A String", # Output only. The most recent time at which the mute config was updated. This field is set by the server and will be ignored if provided on config creation or update.
+{
+  "createTime": "A String",
+  "description": "A String",
+  "displayName": "A String",
+  "expiryTime": "A String",
+  "filter": "A String",
+  "mostRecentEditor": "A String",
+  "name": "A String",
+  "type": "A String",
+  "updateTime": "A String",
 }
 
-  updateMask: string, The list of fields to be updated. If empty all mutable fields will be updated.
+  updateMask: string, A parameter
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -267,16 +267,16 @@ 

Method Details

Returns: An object of the form: - { # A mute config is a Cloud SCC resource that contains the configuration to mute create/update events of findings. - "createTime": "A String", # Output only. The time at which the mute config was created. This field is set by the server and will be ignored if provided on config creation. - "description": "A String", # A description of the mute config. - "displayName": "A String", # The human readable name to be displayed for the mute config. - "expiryTime": "A String", # Optional. The expiry of the mute config. Only applicable for dynamic configs. If the expiry is set, when the config expires, it is removed from all findings. - "filter": "A String", # Required. An expression that defines the filter to apply across create/update events of findings. While creating a filter string, be mindful of the scope in which the mute configuration is being created. E.g., If a filter contains project = X but is created under the project = Y scope, it might not match any findings. The following field and operator combinations are supported: * severity: `=`, `:` * category: `=`, `:` * resource.name: `=`, `:` * resource.project_name: `=`, `:` * resource.project_display_name: `=`, `:` * resource.folders.resource_folder: `=`, `:` * resource.parent_name: `=`, `:` * resource.parent_display_name: `=`, `:` * resource.type: `=`, `:` * finding_class: `=`, `:` * indicator.ip_addresses: `=`, `:` * indicator.domains: `=`, `:` - "mostRecentEditor": "A String", # Output only. Email address of the user who last edited the mute config. This field is set by the server and will be ignored if provided on config creation or update. - "name": "A String", # This field will be ignored if provided on config creation. Format `organizations/{organization}/muteConfigs/{mute_config}` `folders/{folder}/muteConfigs/{mute_config}` `projects/{project}/muteConfigs/{mute_config}` `organizations/{organization}/locations/global/muteConfigs/{mute_config}` `folders/{folder}/locations/global/muteConfigs/{mute_config}` `projects/{project}/locations/global/muteConfigs/{mute_config}` - "type": "A String", # Optional. The type of the mute config, which determines what type of mute state the config affects. The static mute state takes precedence over the dynamic mute state. Immutable after creation. STATIC by default if not set during creation. - "updateTime": "A String", # Output only. The most recent time at which the mute config was updated. This field is set by the server and will be ignored if provided on config creation or update. + { + "createTime": "A String", + "description": "A String", + "displayName": "A String", + "expiryTime": "A String", + "filter": "A String", + "mostRecentEditor": "A String", + "name": "A String", + "type": "A String", + "updateTime": "A String", }
diff --git a/docs/dyn/securitycenter_v1.projects.notificationConfigs.html b/docs/dyn/securitycenter_v1.projects.notificationConfigs.html index 8688947aa5..95843828cd 100644 --- a/docs/dyn/securitycenter_v1.projects.notificationConfigs.html +++ b/docs/dyn/securitycenter_v1.projects.notificationConfigs.html @@ -79,22 +79,22 @@

Instance Methods

Close httplib2 connections.

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

-

Creates a notification config.

+

delete(name, x__xgafv=None)

-

Deletes a notification config.

+

get(name, x__xgafv=None)

-

Gets a notification config.

+

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

-

Lists notification configs.

+

list_next()

Retrieves the next page of results.

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

-

Updates a notification config. The following update fields are allowed: description, pubsub_topic, streaming_config.filter

+

Method Details

close() @@ -103,24 +103,24 @@

Method Details

create(parent, body=None, configId=None, x__xgafv=None) -
Creates a notification config.
+  
 
 Args:
-  parent: string, Required. Resource name of the new notification config's parent. Its format is `organizations/[organization_id]`, `folders/[folder_id]`, or `projects/[project_id]`. (required)
+  parent: string, A parameter (required)
   body: object, The request body.
     The object takes the form of:
 
-{ # Cloud Security Command Center (Cloud SCC) notification configs. A notification config is a Cloud SCC resource that contains the configuration to send notifications for create/update events of findings, assets and etc.
-  "description": "A String", # The description of the notification config (max of 1024 characters).
-  "name": "A String", # The relative resource name of this notification config. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Example: "organizations/{organization_id}/notificationConfigs/notify_public_bucket", "folders/{folder_id}/notificationConfigs/notify_public_bucket", or "projects/{project_id}/notificationConfigs/notify_public_bucket".
-  "pubsubTopic": "A String", # The Pub/Sub topic to send notifications to. Its format is "projects/[project_id]/topics/[topic]".
-  "serviceAccount": "A String", # Output only. The service account that needs "pubsub.topics.publish" permission to publish to the Pub/Sub topic.
-  "streamingConfig": { # The config for streaming-based notifications, which send each event as soon as it is detected. # The config for triggering streaming-based notifications.
-    "filter": "A String", # Expression that defines the filter to apply across create/update events of assets or findings as specified by the event type. The expression is a list of zero or more restrictions combined via logical operators `AND` and `OR`. Parentheses are supported, and `OR` has higher precedence than `AND`. Restrictions have the form ` ` and may have a `-` character in front of them to indicate negation. The fields map to those defined in the corresponding resource. The supported operators are: * `=` for all value types. * `>`, `<`, `>=`, `<=` for integer values. * `:`, meaning substring matching, for strings. The supported value types are: * string literals in quotes. * integer literals without quotes. * boolean literals `true` and `false` without quotes.
+{
+  "description": "A String",
+  "name": "A String",
+  "pubsubTopic": "A String",
+  "serviceAccount": "A String",
+  "streamingConfig": {
+    "filter": "A String",
   },
 }
 
-  configId: string, Required. Unique identifier provided by the client within the parent scope. It must be between 1 and 128 characters and contain alphanumeric characters, underscores, or hyphens only.
+  configId: string, A parameter
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -129,23 +129,23 @@ 

Method Details

Returns: An object of the form: - { # Cloud Security Command Center (Cloud SCC) notification configs. A notification config is a Cloud SCC resource that contains the configuration to send notifications for create/update events of findings, assets and etc. - "description": "A String", # The description of the notification config (max of 1024 characters). - "name": "A String", # The relative resource name of this notification config. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Example: "organizations/{organization_id}/notificationConfigs/notify_public_bucket", "folders/{folder_id}/notificationConfigs/notify_public_bucket", or "projects/{project_id}/notificationConfigs/notify_public_bucket". - "pubsubTopic": "A String", # The Pub/Sub topic to send notifications to. Its format is "projects/[project_id]/topics/[topic]". - "serviceAccount": "A String", # Output only. The service account that needs "pubsub.topics.publish" permission to publish to the Pub/Sub topic. - "streamingConfig": { # The config for streaming-based notifications, which send each event as soon as it is detected. # The config for triggering streaming-based notifications. - "filter": "A String", # Expression that defines the filter to apply across create/update events of assets or findings as specified by the event type. The expression is a list of zero or more restrictions combined via logical operators `AND` and `OR`. Parentheses are supported, and `OR` has higher precedence than `AND`. Restrictions have the form ` ` and may have a `-` character in front of them to indicate negation. The fields map to those defined in the corresponding resource. The supported operators are: * `=` for all value types. * `>`, `<`, `>=`, `<=` for integer values. * `:`, meaning substring matching, for strings. The supported value types are: * string literals in quotes. * integer literals without quotes. * boolean literals `true` and `false` without quotes. + { + "description": "A String", + "name": "A String", + "pubsubTopic": "A String", + "serviceAccount": "A String", + "streamingConfig": { + "filter": "A String", }, }
delete(name, x__xgafv=None) -
Deletes a notification config.
+  
 
 Args:
-  name: string, Required. Name of the notification config to delete. Its format is `organizations/[organization_id]/notificationConfigs/[config_id]`, `folders/[folder_id]/notificationConfigs/[config_id]`, or `projects/[project_id]/notificationConfigs/[config_id]`. (required)
+  name: string, A parameter (required)
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -154,16 +154,16 @@ 

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); } + { }
get(name, x__xgafv=None) -
Gets a notification config.
+  
 
 Args:
-  name: string, Required. Name of the notification config to get. Its format is `organizations/[organization_id]/notificationConfigs/[config_id]`, `folders/[folder_id]/notificationConfigs/[config_id]`, or `projects/[project_id]/notificationConfigs/[config_id]`. (required)
+  name: string, A parameter (required)
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -172,25 +172,25 @@ 

Method Details

Returns: An object of the form: - { # Cloud Security Command Center (Cloud SCC) notification configs. A notification config is a Cloud SCC resource that contains the configuration to send notifications for create/update events of findings, assets and etc. - "description": "A String", # The description of the notification config (max of 1024 characters). - "name": "A String", # The relative resource name of this notification config. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Example: "organizations/{organization_id}/notificationConfigs/notify_public_bucket", "folders/{folder_id}/notificationConfigs/notify_public_bucket", or "projects/{project_id}/notificationConfigs/notify_public_bucket". - "pubsubTopic": "A String", # The Pub/Sub topic to send notifications to. Its format is "projects/[project_id]/topics/[topic]". - "serviceAccount": "A String", # Output only. The service account that needs "pubsub.topics.publish" permission to publish to the Pub/Sub topic. - "streamingConfig": { # The config for streaming-based notifications, which send each event as soon as it is detected. # The config for triggering streaming-based notifications. - "filter": "A String", # Expression that defines the filter to apply across create/update events of assets or findings as specified by the event type. The expression is a list of zero or more restrictions combined via logical operators `AND` and `OR`. Parentheses are supported, and `OR` has higher precedence than `AND`. Restrictions have the form ` ` and may have a `-` character in front of them to indicate negation. The fields map to those defined in the corresponding resource. The supported operators are: * `=` for all value types. * `>`, `<`, `>=`, `<=` for integer values. * `:`, meaning substring matching, for strings. The supported value types are: * string literals in quotes. * integer literals without quotes. * boolean literals `true` and `false` without quotes. + { + "description": "A String", + "name": "A String", + "pubsubTopic": "A String", + "serviceAccount": "A String", + "streamingConfig": { + "filter": "A String", }, }
list(parent, pageSize=None, pageToken=None, x__xgafv=None) -
Lists notification configs.
+  
 
 Args:
-  parent: string, Required. The name of the parent in which to list the notification configurations. Its format is "organizations/[organization_id]", "folders/[folder_id]", or "projects/[project_id]". (required)
-  pageSize: integer, The maximum number of results to return in a single response. Default is 10, minimum is 1, maximum is 1000.
-  pageToken: string, The value returned by the last `ListNotificationConfigsResponse`; indicates that this is a continuation of a prior `ListNotificationConfigs` call, and that the system should return the next page of data.
+  parent: string, A parameter (required)
+  pageSize: integer, A parameter
+  pageToken: string, A parameter
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -199,16 +199,16 @@ 

Method Details

Returns: An object of the form: - { # Response message for listing notification configs. - "nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no more results. - "notificationConfigs": [ # Notification configs belonging to the requested parent. - { # Cloud Security Command Center (Cloud SCC) notification configs. A notification config is a Cloud SCC resource that contains the configuration to send notifications for create/update events of findings, assets and etc. - "description": "A String", # The description of the notification config (max of 1024 characters). - "name": "A String", # The relative resource name of this notification config. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Example: "organizations/{organization_id}/notificationConfigs/notify_public_bucket", "folders/{folder_id}/notificationConfigs/notify_public_bucket", or "projects/{project_id}/notificationConfigs/notify_public_bucket". - "pubsubTopic": "A String", # The Pub/Sub topic to send notifications to. Its format is "projects/[project_id]/topics/[topic]". - "serviceAccount": "A String", # Output only. The service account that needs "pubsub.topics.publish" permission to publish to the Pub/Sub topic. - "streamingConfig": { # The config for streaming-based notifications, which send each event as soon as it is detected. # The config for triggering streaming-based notifications. - "filter": "A String", # Expression that defines the filter to apply across create/update events of assets or findings as specified by the event type. The expression is a list of zero or more restrictions combined via logical operators `AND` and `OR`. Parentheses are supported, and `OR` has higher precedence than `AND`. Restrictions have the form ` ` and may have a `-` character in front of them to indicate negation. The fields map to those defined in the corresponding resource. The supported operators are: * `=` for all value types. * `>`, `<`, `>=`, `<=` for integer values. * `:`, meaning substring matching, for strings. The supported value types are: * string literals in quotes. * integer literals without quotes. * boolean literals `true` and `false` without quotes. + { + "nextPageToken": "A String", + "notificationConfigs": [ + { + "description": "A String", + "name": "A String", + "pubsubTopic": "A String", + "serviceAccount": "A String", + "streamingConfig": { + "filter": "A String", }, }, ], @@ -231,24 +231,24 @@

Method Details

patch(name, body=None, updateMask=None, x__xgafv=None) -
 Updates a notification config. The following update fields are allowed: description, pubsub_topic, streaming_config.filter
+  
 
 Args:
-  name: string, The relative resource name of this notification config. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Example: "organizations/{organization_id}/notificationConfigs/notify_public_bucket", "folders/{folder_id}/notificationConfigs/notify_public_bucket", or "projects/{project_id}/notificationConfigs/notify_public_bucket". (required)
+  name: string, A parameter (required)
   body: object, The request body.
     The object takes the form of:
 
-{ # Cloud Security Command Center (Cloud SCC) notification configs. A notification config is a Cloud SCC resource that contains the configuration to send notifications for create/update events of findings, assets and etc.
-  "description": "A String", # The description of the notification config (max of 1024 characters).
-  "name": "A String", # The relative resource name of this notification config. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Example: "organizations/{organization_id}/notificationConfigs/notify_public_bucket", "folders/{folder_id}/notificationConfigs/notify_public_bucket", or "projects/{project_id}/notificationConfigs/notify_public_bucket".
-  "pubsubTopic": "A String", # The Pub/Sub topic to send notifications to. Its format is "projects/[project_id]/topics/[topic]".
-  "serviceAccount": "A String", # Output only. The service account that needs "pubsub.topics.publish" permission to publish to the Pub/Sub topic.
-  "streamingConfig": { # The config for streaming-based notifications, which send each event as soon as it is detected. # The config for triggering streaming-based notifications.
-    "filter": "A String", # Expression that defines the filter to apply across create/update events of assets or findings as specified by the event type. The expression is a list of zero or more restrictions combined via logical operators `AND` and `OR`. Parentheses are supported, and `OR` has higher precedence than `AND`. Restrictions have the form ` ` and may have a `-` character in front of them to indicate negation. The fields map to those defined in the corresponding resource. The supported operators are: * `=` for all value types. * `>`, `<`, `>=`, `<=` for integer values. * `:`, meaning substring matching, for strings. The supported value types are: * string literals in quotes. * integer literals without quotes. * boolean literals `true` and `false` without quotes.
+{
+  "description": "A String",
+  "name": "A String",
+  "pubsubTopic": "A String",
+  "serviceAccount": "A String",
+  "streamingConfig": {
+    "filter": "A String",
   },
 }
 
-  updateMask: string, The FieldMask to use when updating the notification config. If empty all mutable fields will be updated.
+  updateMask: string, A parameter
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -257,13 +257,13 @@ 

Method Details

Returns: An object of the form: - { # Cloud Security Command Center (Cloud SCC) notification configs. A notification config is a Cloud SCC resource that contains the configuration to send notifications for create/update events of findings, assets and etc. - "description": "A String", # The description of the notification config (max of 1024 characters). - "name": "A String", # The relative resource name of this notification config. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Example: "organizations/{organization_id}/notificationConfigs/notify_public_bucket", "folders/{folder_id}/notificationConfigs/notify_public_bucket", or "projects/{project_id}/notificationConfigs/notify_public_bucket". - "pubsubTopic": "A String", # The Pub/Sub topic to send notifications to. Its format is "projects/[project_id]/topics/[topic]". - "serviceAccount": "A String", # Output only. The service account that needs "pubsub.topics.publish" permission to publish to the Pub/Sub topic. - "streamingConfig": { # The config for streaming-based notifications, which send each event as soon as it is detected. # The config for triggering streaming-based notifications. - "filter": "A String", # Expression that defines the filter to apply across create/update events of assets or findings as specified by the event type. The expression is a list of zero or more restrictions combined via logical operators `AND` and `OR`. Parentheses are supported, and `OR` has higher precedence than `AND`. Restrictions have the form ` ` and may have a `-` character in front of them to indicate negation. The fields map to those defined in the corresponding resource. The supported operators are: * `=` for all value types. * `>`, `<`, `>=`, `<=` for integer values. * `:`, meaning substring matching, for strings. The supported value types are: * string literals in quotes. * integer literals without quotes. * boolean literals `true` and `false` without quotes. + { + "description": "A String", + "name": "A String", + "pubsubTopic": "A String", + "serviceAccount": "A String", + "streamingConfig": { + "filter": "A String", }, }
diff --git a/docs/dyn/securitycenter_v1.projects.securityHealthAnalyticsSettings.customModules.html b/docs/dyn/securitycenter_v1.projects.securityHealthAnalyticsSettings.customModules.html index 0046b0404c..92d8c3eb1b 100644 --- a/docs/dyn/securitycenter_v1.projects.securityHealthAnalyticsSettings.customModules.html +++ b/docs/dyn/securitycenter_v1.projects.securityHealthAnalyticsSettings.customModules.html @@ -79,19 +79,19 @@

Instance Methods

Close httplib2 connections.

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

-

Creates a resident SecurityHealthAnalyticsCustomModule at the scope of the given CRM parent, and also creates inherited SecurityHealthAnalyticsCustomModules for all CRM descendants of the given parent. These modules are enabled by default.

+

delete(name, x__xgafv=None)

-

Deletes the specified SecurityHealthAnalyticsCustomModule and all of its descendants in the CRM hierarchy. This method is only supported for resident custom modules.

+

get(name, x__xgafv=None)

-

Retrieves a SecurityHealthAnalyticsCustomModule.

+

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

-

Returns a list of all SecurityHealthAnalyticsCustomModules for the given parent. This includes resident modules defined at the scope of the parent, and inherited modules, inherited from CRM ancestors.

+

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

-

Returns a list of all resident SecurityHealthAnalyticsCustomModules under the given CRM parent and all of the parent’s CRM descendants.

+

listDescendant_next()

Retrieves the next page of results.

@@ -100,10 +100,10 @@

Instance Methods

Retrieves the next page of results.

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

-

Updates the SecurityHealthAnalyticsCustomModule under the given name based on the given update mask. Updating the enablement state is supported on both resident and inherited modules (though resident modules cannot have an enablement state of "inherited"). Updating the display name and custom config of a module is supported on resident modules only.

+

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

-

Simulates a given SecurityHealthAnalyticsCustomModule and Resource.

+

Method Details

close() @@ -112,50 +112,50 @@

Method Details

create(parent, body=None, x__xgafv=None) -
Creates a resident SecurityHealthAnalyticsCustomModule at the scope of the given CRM parent, and also creates inherited SecurityHealthAnalyticsCustomModules for all CRM descendants of the given parent. These modules are enabled by default.
+  
 
 Args:
-  parent: string, Required. Resource name of the new custom module's parent. Its format is `organizations/{organization}/securityHealthAnalyticsSettings`, `folders/{folder}/securityHealthAnalyticsSettings`, or `projects/{project}/securityHealthAnalyticsSettings` (required)
+  parent: string, A parameter (required)
   body: object, The request body.
     The object takes the form of:
 
-{ # Represents an instance of a Security Health Analytics custom module, including its full module name, display name, enablement state, and last updated time. You can create a custom module at the organization, folder, or project level. Custom modules that you create at the organization or folder level are inherited by the child folders and projects.
-  "ancestorModule": "A String", # Output only. If empty, indicates that the custom module was created in the organization, folder, or project in which you are viewing the custom module. Otherwise, `ancestor_module` specifies the organization or folder from which the custom module is inherited.
-  "cloudProvider": "A String", # The cloud provider of the custom module.
-  "customConfig": { # Defines the properties in a custom module configuration for Security Health Analytics. Use the custom module configuration to create custom detectors that generate custom findings for resources that you specify. # The user specified custom configuration for the module.
-    "customOutput": { # A set of optional name-value pairs that define custom source properties to return with each finding that is generated by the custom module. The custom source properties that are defined here are included in the finding JSON under `sourceProperties`. # Custom output properties.
-      "properties": [ # A list of custom output properties to add to the finding.
-        { # An individual name-value pair that defines a custom source property.
-          "name": "A String", # Name of the property for the custom output.
-          "valueExpression": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The CEL expression for the custom output. A resource property can be specified to return the value of the property or a text string enclosed in quotation marks.
-            "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
-            "expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
-            "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
-            "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
+{
+  "ancestorModule": "A String",
+  "cloudProvider": "A String",
+  "customConfig": {
+    "customOutput": {
+      "properties": [
+        {
+          "name": "A String",
+          "valueExpression": {
+            "description": "A String",
+            "expression": "A String",
+            "location": "A String",
+            "title": "A String",
           },
         },
       ],
     },
-    "description": "A String", # Text that describes the vulnerability or misconfiguration that the custom module detects. This explanation is returned with each finding instance to help investigators understand the detected issue. The text must be enclosed in quotation marks.
-    "predicate": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The CEL expression to evaluate to produce findings. When the expression evaluates to true against a resource, a finding is generated.
-      "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
-      "expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
-      "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
-      "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
+    "description": "A String",
+    "predicate": {
+      "description": "A String",
+      "expression": "A String",
+      "location": "A String",
+      "title": "A String",
     },
-    "recommendation": "A String", # An explanation of the recommended steps that security teams can take to resolve the detected issue. This explanation is returned with each finding generated by this module in the `nextSteps` property of the finding JSON.
-    "resourceSelector": { # Resource for selecting resource type. # The resource types that the custom module operates on. Each custom module can specify up to 5 resource types.
-      "resourceTypes": [ # The resource types to run the detector on.
+    "recommendation": "A String",
+    "resourceSelector": {
+      "resourceTypes": [
         "A String",
       ],
     },
-    "severity": "A String", # The severity to assign to findings generated by the module.
+    "severity": "A String",
   },
-  "displayName": "A String", # The display name of the Security Health Analytics custom module. This display name becomes the finding category for all findings that are returned by this custom module. The display name must be between 1 and 128 characters, start with a lowercase letter, and contain alphanumeric characters or underscores only.
-  "enablementState": "A String", # The enablement state of the custom module.
-  "lastEditor": "A String", # Output only. The editor that last updated the custom module.
-  "name": "A String", # Immutable. The resource name of the custom module. Its format is "organizations/{organization}/securityHealthAnalyticsSettings/customModules/{customModule}", or "folders/{folder}/securityHealthAnalyticsSettings/customModules/{customModule}", or "projects/{project}/securityHealthAnalyticsSettings/customModules/{customModule}" The id {customModule} is server-generated and is not user settable. It will be a numeric id containing 1-20 digits.
-  "updateTime": "A String", # Output only. The time at which the custom module was last updated.
+  "displayName": "A String",
+  "enablementState": "A String",
+  "lastEditor": "A String",
+  "name": "A String",
+  "updateTime": "A String",
 }
 
   x__xgafv: string, V1 error format.
@@ -166,52 +166,52 @@ 

Method Details

Returns: An object of the form: - { # Represents an instance of a Security Health Analytics custom module, including its full module name, display name, enablement state, and last updated time. You can create a custom module at the organization, folder, or project level. Custom modules that you create at the organization or folder level are inherited by the child folders and projects. - "ancestorModule": "A String", # Output only. If empty, indicates that the custom module was created in the organization, folder, or project in which you are viewing the custom module. Otherwise, `ancestor_module` specifies the organization or folder from which the custom module is inherited. - "cloudProvider": "A String", # The cloud provider of the custom module. - "customConfig": { # Defines the properties in a custom module configuration for Security Health Analytics. Use the custom module configuration to create custom detectors that generate custom findings for resources that you specify. # The user specified custom configuration for the module. - "customOutput": { # A set of optional name-value pairs that define custom source properties to return with each finding that is generated by the custom module. The custom source properties that are defined here are included in the finding JSON under `sourceProperties`. # Custom output properties. - "properties": [ # A list of custom output properties to add to the finding. - { # An individual name-value pair that defines a custom source property. - "name": "A String", # Name of the property for the custom output. - "valueExpression": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The CEL expression for the custom output. A resource property can be specified to return the value of the property or a text string enclosed in quotation marks. - "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. - "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. - "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file. - "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. + { + "ancestorModule": "A String", + "cloudProvider": "A String", + "customConfig": { + "customOutput": { + "properties": [ + { + "name": "A String", + "valueExpression": { + "description": "A String", + "expression": "A String", + "location": "A String", + "title": "A String", }, }, ], }, - "description": "A String", # Text that describes the vulnerability or misconfiguration that the custom module detects. This explanation is returned with each finding instance to help investigators understand the detected issue. The text must be enclosed in quotation marks. - "predicate": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The CEL expression to evaluate to produce findings. When the expression evaluates to true against a resource, a finding is generated. - "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. - "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. - "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file. - "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. + "description": "A String", + "predicate": { + "description": "A String", + "expression": "A String", + "location": "A String", + "title": "A String", }, - "recommendation": "A String", # An explanation of the recommended steps that security teams can take to resolve the detected issue. This explanation is returned with each finding generated by this module in the `nextSteps` property of the finding JSON. - "resourceSelector": { # Resource for selecting resource type. # The resource types that the custom module operates on. Each custom module can specify up to 5 resource types. - "resourceTypes": [ # The resource types to run the detector on. + "recommendation": "A String", + "resourceSelector": { + "resourceTypes": [ "A String", ], }, - "severity": "A String", # The severity to assign to findings generated by the module. + "severity": "A String", }, - "displayName": "A String", # The display name of the Security Health Analytics custom module. This display name becomes the finding category for all findings that are returned by this custom module. The display name must be between 1 and 128 characters, start with a lowercase letter, and contain alphanumeric characters or underscores only. - "enablementState": "A String", # The enablement state of the custom module. - "lastEditor": "A String", # Output only. The editor that last updated the custom module. - "name": "A String", # Immutable. The resource name of the custom module. Its format is "organizations/{organization}/securityHealthAnalyticsSettings/customModules/{customModule}", or "folders/{folder}/securityHealthAnalyticsSettings/customModules/{customModule}", or "projects/{project}/securityHealthAnalyticsSettings/customModules/{customModule}" The id {customModule} is server-generated and is not user settable. It will be a numeric id containing 1-20 digits. - "updateTime": "A String", # Output only. The time at which the custom module was last updated. + "displayName": "A String", + "enablementState": "A String", + "lastEditor": "A String", + "name": "A String", + "updateTime": "A String", }
delete(name, x__xgafv=None) -
Deletes the specified SecurityHealthAnalyticsCustomModule and all of its descendants in the CRM hierarchy. This method is only supported for resident custom modules.
+  
 
 Args:
-  name: string, Required. Name of the custom module to delete. Its format is `organizations/{organization}/securityHealthAnalyticsSettings/customModules/{customModule}`, `folders/{folder}/securityHealthAnalyticsSettings/customModules/{customModule}`, or `projects/{project}/securityHealthAnalyticsSettings/customModules/{customModule}` (required)
+  name: string, A parameter (required)
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -220,16 +220,16 @@ 

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); } + { }
get(name, x__xgafv=None) -
Retrieves a SecurityHealthAnalyticsCustomModule.
+  
 
 Args:
-  name: string, Required. Name of the custom module to get. Its format is `organizations/{organization}/securityHealthAnalyticsSettings/customModules/{customModule}`, `folders/{folder}/securityHealthAnalyticsSettings/customModules/{customModule}`, or `projects/{project}/securityHealthAnalyticsSettings/customModules/{customModule}` (required)
+  name: string, A parameter (required)
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -238,54 +238,54 @@ 

Method Details

Returns: An object of the form: - { # Represents an instance of a Security Health Analytics custom module, including its full module name, display name, enablement state, and last updated time. You can create a custom module at the organization, folder, or project level. Custom modules that you create at the organization or folder level are inherited by the child folders and projects. - "ancestorModule": "A String", # Output only. If empty, indicates that the custom module was created in the organization, folder, or project in which you are viewing the custom module. Otherwise, `ancestor_module` specifies the organization or folder from which the custom module is inherited. - "cloudProvider": "A String", # The cloud provider of the custom module. - "customConfig": { # Defines the properties in a custom module configuration for Security Health Analytics. Use the custom module configuration to create custom detectors that generate custom findings for resources that you specify. # The user specified custom configuration for the module. - "customOutput": { # A set of optional name-value pairs that define custom source properties to return with each finding that is generated by the custom module. The custom source properties that are defined here are included in the finding JSON under `sourceProperties`. # Custom output properties. - "properties": [ # A list of custom output properties to add to the finding. - { # An individual name-value pair that defines a custom source property. - "name": "A String", # Name of the property for the custom output. - "valueExpression": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The CEL expression for the custom output. A resource property can be specified to return the value of the property or a text string enclosed in quotation marks. - "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. - "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. - "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file. - "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. + { + "ancestorModule": "A String", + "cloudProvider": "A String", + "customConfig": { + "customOutput": { + "properties": [ + { + "name": "A String", + "valueExpression": { + "description": "A String", + "expression": "A String", + "location": "A String", + "title": "A String", }, }, ], }, - "description": "A String", # Text that describes the vulnerability or misconfiguration that the custom module detects. This explanation is returned with each finding instance to help investigators understand the detected issue. The text must be enclosed in quotation marks. - "predicate": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The CEL expression to evaluate to produce findings. When the expression evaluates to true against a resource, a finding is generated. - "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. - "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. - "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file. - "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. + "description": "A String", + "predicate": { + "description": "A String", + "expression": "A String", + "location": "A String", + "title": "A String", }, - "recommendation": "A String", # An explanation of the recommended steps that security teams can take to resolve the detected issue. This explanation is returned with each finding generated by this module in the `nextSteps` property of the finding JSON. - "resourceSelector": { # Resource for selecting resource type. # The resource types that the custom module operates on. Each custom module can specify up to 5 resource types. - "resourceTypes": [ # The resource types to run the detector on. + "recommendation": "A String", + "resourceSelector": { + "resourceTypes": [ "A String", ], }, - "severity": "A String", # The severity to assign to findings generated by the module. + "severity": "A String", }, - "displayName": "A String", # The display name of the Security Health Analytics custom module. This display name becomes the finding category for all findings that are returned by this custom module. The display name must be between 1 and 128 characters, start with a lowercase letter, and contain alphanumeric characters or underscores only. - "enablementState": "A String", # The enablement state of the custom module. - "lastEditor": "A String", # Output only. The editor that last updated the custom module. - "name": "A String", # Immutable. The resource name of the custom module. Its format is "organizations/{organization}/securityHealthAnalyticsSettings/customModules/{customModule}", or "folders/{folder}/securityHealthAnalyticsSettings/customModules/{customModule}", or "projects/{project}/securityHealthAnalyticsSettings/customModules/{customModule}" The id {customModule} is server-generated and is not user settable. It will be a numeric id containing 1-20 digits. - "updateTime": "A String", # Output only. The time at which the custom module was last updated. + "displayName": "A String", + "enablementState": "A String", + "lastEditor": "A String", + "name": "A String", + "updateTime": "A String", }
list(parent, pageSize=None, pageToken=None, x__xgafv=None) -
Returns a list of all SecurityHealthAnalyticsCustomModules for the given parent. This includes resident modules defined at the scope of the parent, and inherited modules, inherited from CRM ancestors.
+  
 
 Args:
-  parent: string, Required. Name of parent to list custom modules. Its format is `organizations/{organization}/securityHealthAnalyticsSettings`, `folders/{folder}/securityHealthAnalyticsSettings`, or `projects/{project}/securityHealthAnalyticsSettings` (required)
-  pageSize: integer, The maximum number of results to return in a single response. Default is 10, minimum is 1, maximum is 1000.
-  pageToken: string, The value returned by the last call indicating a continuation
+  parent: string, A parameter (required)
+  pageSize: integer, A parameter
+  pageToken: string, A parameter
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -294,46 +294,46 @@ 

Method Details

Returns: An object of the form: - { # Response message for listing Security Health Analytics custom modules. - "nextPageToken": "A String", # If not empty, indicates that there may be more custom modules to be returned. - "securityHealthAnalyticsCustomModules": [ # Custom modules belonging to the requested parent. - { # Represents an instance of a Security Health Analytics custom module, including its full module name, display name, enablement state, and last updated time. You can create a custom module at the organization, folder, or project level. Custom modules that you create at the organization or folder level are inherited by the child folders and projects. - "ancestorModule": "A String", # Output only. If empty, indicates that the custom module was created in the organization, folder, or project in which you are viewing the custom module. Otherwise, `ancestor_module` specifies the organization or folder from which the custom module is inherited. - "cloudProvider": "A String", # The cloud provider of the custom module. - "customConfig": { # Defines the properties in a custom module configuration for Security Health Analytics. Use the custom module configuration to create custom detectors that generate custom findings for resources that you specify. # The user specified custom configuration for the module. - "customOutput": { # A set of optional name-value pairs that define custom source properties to return with each finding that is generated by the custom module. The custom source properties that are defined here are included in the finding JSON under `sourceProperties`. # Custom output properties. - "properties": [ # A list of custom output properties to add to the finding. - { # An individual name-value pair that defines a custom source property. - "name": "A String", # Name of the property for the custom output. - "valueExpression": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The CEL expression for the custom output. A resource property can be specified to return the value of the property or a text string enclosed in quotation marks. - "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. - "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. - "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file. - "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. + { + "nextPageToken": "A String", + "securityHealthAnalyticsCustomModules": [ + { + "ancestorModule": "A String", + "cloudProvider": "A String", + "customConfig": { + "customOutput": { + "properties": [ + { + "name": "A String", + "valueExpression": { + "description": "A String", + "expression": "A String", + "location": "A String", + "title": "A String", }, }, ], }, - "description": "A String", # Text that describes the vulnerability or misconfiguration that the custom module detects. This explanation is returned with each finding instance to help investigators understand the detected issue. The text must be enclosed in quotation marks. - "predicate": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The CEL expression to evaluate to produce findings. When the expression evaluates to true against a resource, a finding is generated. - "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. - "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. - "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file. - "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. + "description": "A String", + "predicate": { + "description": "A String", + "expression": "A String", + "location": "A String", + "title": "A String", }, - "recommendation": "A String", # An explanation of the recommended steps that security teams can take to resolve the detected issue. This explanation is returned with each finding generated by this module in the `nextSteps` property of the finding JSON. - "resourceSelector": { # Resource for selecting resource type. # The resource types that the custom module operates on. Each custom module can specify up to 5 resource types. - "resourceTypes": [ # The resource types to run the detector on. + "recommendation": "A String", + "resourceSelector": { + "resourceTypes": [ "A String", ], }, - "severity": "A String", # The severity to assign to findings generated by the module. + "severity": "A String", }, - "displayName": "A String", # The display name of the Security Health Analytics custom module. This display name becomes the finding category for all findings that are returned by this custom module. The display name must be between 1 and 128 characters, start with a lowercase letter, and contain alphanumeric characters or underscores only. - "enablementState": "A String", # The enablement state of the custom module. - "lastEditor": "A String", # Output only. The editor that last updated the custom module. - "name": "A String", # Immutable. The resource name of the custom module. Its format is "organizations/{organization}/securityHealthAnalyticsSettings/customModules/{customModule}", or "folders/{folder}/securityHealthAnalyticsSettings/customModules/{customModule}", or "projects/{project}/securityHealthAnalyticsSettings/customModules/{customModule}" The id {customModule} is server-generated and is not user settable. It will be a numeric id containing 1-20 digits. - "updateTime": "A String", # Output only. The time at which the custom module was last updated. + "displayName": "A String", + "enablementState": "A String", + "lastEditor": "A String", + "name": "A String", + "updateTime": "A String", }, ], }
@@ -341,12 +341,12 @@

Method Details

listDescendant(parent, pageSize=None, pageToken=None, x__xgafv=None) -
Returns a list of all resident SecurityHealthAnalyticsCustomModules under the given CRM parent and all of the parent’s CRM descendants.
+  
 
 Args:
-  parent: string, Required. Name of parent to list descendant custom modules. Its format is `organizations/{organization}/securityHealthAnalyticsSettings`, `folders/{folder}/securityHealthAnalyticsSettings`, or `projects/{project}/securityHealthAnalyticsSettings` (required)
-  pageSize: integer, The maximum number of results to return in a single response. Default is 10, minimum is 1, maximum is 1000.
-  pageToken: string, The value returned by the last call indicating a continuation
+  parent: string, A parameter (required)
+  pageSize: integer, A parameter
+  pageToken: string, A parameter
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -355,46 +355,46 @@ 

Method Details

Returns: An object of the form: - { # Response message for listing descendant Security Health Analytics custom modules. - "nextPageToken": "A String", # If not empty, indicates that there may be more custom modules to be returned. - "securityHealthAnalyticsCustomModules": [ # Custom modules belonging to the requested parent and its descendants. - { # Represents an instance of a Security Health Analytics custom module, including its full module name, display name, enablement state, and last updated time. You can create a custom module at the organization, folder, or project level. Custom modules that you create at the organization or folder level are inherited by the child folders and projects. - "ancestorModule": "A String", # Output only. If empty, indicates that the custom module was created in the organization, folder, or project in which you are viewing the custom module. Otherwise, `ancestor_module` specifies the organization or folder from which the custom module is inherited. - "cloudProvider": "A String", # The cloud provider of the custom module. - "customConfig": { # Defines the properties in a custom module configuration for Security Health Analytics. Use the custom module configuration to create custom detectors that generate custom findings for resources that you specify. # The user specified custom configuration for the module. - "customOutput": { # A set of optional name-value pairs that define custom source properties to return with each finding that is generated by the custom module. The custom source properties that are defined here are included in the finding JSON under `sourceProperties`. # Custom output properties. - "properties": [ # A list of custom output properties to add to the finding. - { # An individual name-value pair that defines a custom source property. - "name": "A String", # Name of the property for the custom output. - "valueExpression": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The CEL expression for the custom output. A resource property can be specified to return the value of the property or a text string enclosed in quotation marks. - "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. - "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. - "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file. - "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. + { + "nextPageToken": "A String", + "securityHealthAnalyticsCustomModules": [ + { + "ancestorModule": "A String", + "cloudProvider": "A String", + "customConfig": { + "customOutput": { + "properties": [ + { + "name": "A String", + "valueExpression": { + "description": "A String", + "expression": "A String", + "location": "A String", + "title": "A String", }, }, ], }, - "description": "A String", # Text that describes the vulnerability or misconfiguration that the custom module detects. This explanation is returned with each finding instance to help investigators understand the detected issue. The text must be enclosed in quotation marks. - "predicate": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The CEL expression to evaluate to produce findings. When the expression evaluates to true against a resource, a finding is generated. - "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. - "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. - "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file. - "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. + "description": "A String", + "predicate": { + "description": "A String", + "expression": "A String", + "location": "A String", + "title": "A String", }, - "recommendation": "A String", # An explanation of the recommended steps that security teams can take to resolve the detected issue. This explanation is returned with each finding generated by this module in the `nextSteps` property of the finding JSON. - "resourceSelector": { # Resource for selecting resource type. # The resource types that the custom module operates on. Each custom module can specify up to 5 resource types. - "resourceTypes": [ # The resource types to run the detector on. + "recommendation": "A String", + "resourceSelector": { + "resourceTypes": [ "A String", ], }, - "severity": "A String", # The severity to assign to findings generated by the module. + "severity": "A String", }, - "displayName": "A String", # The display name of the Security Health Analytics custom module. This display name becomes the finding category for all findings that are returned by this custom module. The display name must be between 1 and 128 characters, start with a lowercase letter, and contain alphanumeric characters or underscores only. - "enablementState": "A String", # The enablement state of the custom module. - "lastEditor": "A String", # Output only. The editor that last updated the custom module. - "name": "A String", # Immutable. The resource name of the custom module. Its format is "organizations/{organization}/securityHealthAnalyticsSettings/customModules/{customModule}", or "folders/{folder}/securityHealthAnalyticsSettings/customModules/{customModule}", or "projects/{project}/securityHealthAnalyticsSettings/customModules/{customModule}" The id {customModule} is server-generated and is not user settable. It will be a numeric id containing 1-20 digits. - "updateTime": "A String", # Output only. The time at which the custom module was last updated. + "displayName": "A String", + "enablementState": "A String", + "lastEditor": "A String", + "name": "A String", + "updateTime": "A String", }, ], }
@@ -430,53 +430,53 @@

Method Details

patch(name, body=None, updateMask=None, x__xgafv=None) -
Updates the SecurityHealthAnalyticsCustomModule under the given name based on the given update mask. Updating the enablement state is supported on both resident and inherited modules (though resident modules cannot have an enablement state of "inherited"). Updating the display name and custom config of a module is supported on resident modules only.
+  
 
 Args:
-  name: string, Immutable. The resource name of the custom module. Its format is "organizations/{organization}/securityHealthAnalyticsSettings/customModules/{customModule}", or "folders/{folder}/securityHealthAnalyticsSettings/customModules/{customModule}", or "projects/{project}/securityHealthAnalyticsSettings/customModules/{customModule}" The id {customModule} is server-generated and is not user settable. It will be a numeric id containing 1-20 digits. (required)
+  name: string, A parameter (required)
   body: object, The request body.
     The object takes the form of:
 
-{ # Represents an instance of a Security Health Analytics custom module, including its full module name, display name, enablement state, and last updated time. You can create a custom module at the organization, folder, or project level. Custom modules that you create at the organization or folder level are inherited by the child folders and projects.
-  "ancestorModule": "A String", # Output only. If empty, indicates that the custom module was created in the organization, folder, or project in which you are viewing the custom module. Otherwise, `ancestor_module` specifies the organization or folder from which the custom module is inherited.
-  "cloudProvider": "A String", # The cloud provider of the custom module.
-  "customConfig": { # Defines the properties in a custom module configuration for Security Health Analytics. Use the custom module configuration to create custom detectors that generate custom findings for resources that you specify. # The user specified custom configuration for the module.
-    "customOutput": { # A set of optional name-value pairs that define custom source properties to return with each finding that is generated by the custom module. The custom source properties that are defined here are included in the finding JSON under `sourceProperties`. # Custom output properties.
-      "properties": [ # A list of custom output properties to add to the finding.
-        { # An individual name-value pair that defines a custom source property.
-          "name": "A String", # Name of the property for the custom output.
-          "valueExpression": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The CEL expression for the custom output. A resource property can be specified to return the value of the property or a text string enclosed in quotation marks.
-            "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
-            "expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
-            "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
-            "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
+{
+  "ancestorModule": "A String",
+  "cloudProvider": "A String",
+  "customConfig": {
+    "customOutput": {
+      "properties": [
+        {
+          "name": "A String",
+          "valueExpression": {
+            "description": "A String",
+            "expression": "A String",
+            "location": "A String",
+            "title": "A String",
           },
         },
       ],
     },
-    "description": "A String", # Text that describes the vulnerability or misconfiguration that the custom module detects. This explanation is returned with each finding instance to help investigators understand the detected issue. The text must be enclosed in quotation marks.
-    "predicate": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The CEL expression to evaluate to produce findings. When the expression evaluates to true against a resource, a finding is generated.
-      "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
-      "expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
-      "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
-      "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
+    "description": "A String",
+    "predicate": {
+      "description": "A String",
+      "expression": "A String",
+      "location": "A String",
+      "title": "A String",
     },
-    "recommendation": "A String", # An explanation of the recommended steps that security teams can take to resolve the detected issue. This explanation is returned with each finding generated by this module in the `nextSteps` property of the finding JSON.
-    "resourceSelector": { # Resource for selecting resource type. # The resource types that the custom module operates on. Each custom module can specify up to 5 resource types.
-      "resourceTypes": [ # The resource types to run the detector on.
+    "recommendation": "A String",
+    "resourceSelector": {
+      "resourceTypes": [
         "A String",
       ],
     },
-    "severity": "A String", # The severity to assign to findings generated by the module.
+    "severity": "A String",
   },
-  "displayName": "A String", # The display name of the Security Health Analytics custom module. This display name becomes the finding category for all findings that are returned by this custom module. The display name must be between 1 and 128 characters, start with a lowercase letter, and contain alphanumeric characters or underscores only.
-  "enablementState": "A String", # The enablement state of the custom module.
-  "lastEditor": "A String", # Output only. The editor that last updated the custom module.
-  "name": "A String", # Immutable. The resource name of the custom module. Its format is "organizations/{organization}/securityHealthAnalyticsSettings/customModules/{customModule}", or "folders/{folder}/securityHealthAnalyticsSettings/customModules/{customModule}", or "projects/{project}/securityHealthAnalyticsSettings/customModules/{customModule}" The id {customModule} is server-generated and is not user settable. It will be a numeric id containing 1-20 digits.
-  "updateTime": "A String", # Output only. The time at which the custom module was last updated.
+  "displayName": "A String",
+  "enablementState": "A String",
+  "lastEditor": "A String",
+  "name": "A String",
+  "updateTime": "A String",
 }
 
-  updateMask: string, The list of fields to be updated. The only fields that can be updated are `enablement_state` and `custom_config`. If empty or set to the wildcard value `*`, both `enablement_state` and `custom_config` are updated.
+  updateMask: string, A parameter
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -485,121 +485,121 @@ 

Method Details

Returns: An object of the form: - { # Represents an instance of a Security Health Analytics custom module, including its full module name, display name, enablement state, and last updated time. You can create a custom module at the organization, folder, or project level. Custom modules that you create at the organization or folder level are inherited by the child folders and projects. - "ancestorModule": "A String", # Output only. If empty, indicates that the custom module was created in the organization, folder, or project in which you are viewing the custom module. Otherwise, `ancestor_module` specifies the organization or folder from which the custom module is inherited. - "cloudProvider": "A String", # The cloud provider of the custom module. - "customConfig": { # Defines the properties in a custom module configuration for Security Health Analytics. Use the custom module configuration to create custom detectors that generate custom findings for resources that you specify. # The user specified custom configuration for the module. - "customOutput": { # A set of optional name-value pairs that define custom source properties to return with each finding that is generated by the custom module. The custom source properties that are defined here are included in the finding JSON under `sourceProperties`. # Custom output properties. - "properties": [ # A list of custom output properties to add to the finding. - { # An individual name-value pair that defines a custom source property. - "name": "A String", # Name of the property for the custom output. - "valueExpression": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The CEL expression for the custom output. A resource property can be specified to return the value of the property or a text string enclosed in quotation marks. - "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. - "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. - "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file. - "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. + { + "ancestorModule": "A String", + "cloudProvider": "A String", + "customConfig": { + "customOutput": { + "properties": [ + { + "name": "A String", + "valueExpression": { + "description": "A String", + "expression": "A String", + "location": "A String", + "title": "A String", }, }, ], }, - "description": "A String", # Text that describes the vulnerability or misconfiguration that the custom module detects. This explanation is returned with each finding instance to help investigators understand the detected issue. The text must be enclosed in quotation marks. - "predicate": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The CEL expression to evaluate to produce findings. When the expression evaluates to true against a resource, a finding is generated. - "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. - "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. - "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file. - "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. + "description": "A String", + "predicate": { + "description": "A String", + "expression": "A String", + "location": "A String", + "title": "A String", }, - "recommendation": "A String", # An explanation of the recommended steps that security teams can take to resolve the detected issue. This explanation is returned with each finding generated by this module in the `nextSteps` property of the finding JSON. - "resourceSelector": { # Resource for selecting resource type. # The resource types that the custom module operates on. Each custom module can specify up to 5 resource types. - "resourceTypes": [ # The resource types to run the detector on. + "recommendation": "A String", + "resourceSelector": { + "resourceTypes": [ "A String", ], }, - "severity": "A String", # The severity to assign to findings generated by the module. + "severity": "A String", }, - "displayName": "A String", # The display name of the Security Health Analytics custom module. This display name becomes the finding category for all findings that are returned by this custom module. The display name must be between 1 and 128 characters, start with a lowercase letter, and contain alphanumeric characters or underscores only. - "enablementState": "A String", # The enablement state of the custom module. - "lastEditor": "A String", # Output only. The editor that last updated the custom module. - "name": "A String", # Immutable. The resource name of the custom module. Its format is "organizations/{organization}/securityHealthAnalyticsSettings/customModules/{customModule}", or "folders/{folder}/securityHealthAnalyticsSettings/customModules/{customModule}", or "projects/{project}/securityHealthAnalyticsSettings/customModules/{customModule}" The id {customModule} is server-generated and is not user settable. It will be a numeric id containing 1-20 digits. - "updateTime": "A String", # Output only. The time at which the custom module was last updated. + "displayName": "A String", + "enablementState": "A String", + "lastEditor": "A String", + "name": "A String", + "updateTime": "A String", }
simulate(parent, body=None, x__xgafv=None) -
Simulates a given SecurityHealthAnalyticsCustomModule and Resource.
+  
 
 Args:
-  parent: string, Required. The relative resource name of the organization, project, or folder. For more information about relative resource names, see [Relative Resource Name](https://cloud.google.com/apis/design/resource_names#relative_resource_name) Example: `organizations/{organization_id}` (required)
+  parent: string, A parameter (required)
   body: object, The request body.
     The object takes the form of:
 
-{ # Request message to simulate a CustomConfig against a given test resource. Maximum size of the request is 4 MB by default.
-  "customConfig": { # Defines the properties in a custom module configuration for Security Health Analytics. Use the custom module configuration to create custom detectors that generate custom findings for resources that you specify. # Required. The custom configuration that you need to test.
-    "customOutput": { # A set of optional name-value pairs that define custom source properties to return with each finding that is generated by the custom module. The custom source properties that are defined here are included in the finding JSON under `sourceProperties`. # Custom output properties.
-      "properties": [ # A list of custom output properties to add to the finding.
-        { # An individual name-value pair that defines a custom source property.
-          "name": "A String", # Name of the property for the custom output.
-          "valueExpression": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The CEL expression for the custom output. A resource property can be specified to return the value of the property or a text string enclosed in quotation marks.
-            "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
-            "expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
-            "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
-            "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
+{
+  "customConfig": {
+    "customOutput": {
+      "properties": [
+        {
+          "name": "A String",
+          "valueExpression": {
+            "description": "A String",
+            "expression": "A String",
+            "location": "A String",
+            "title": "A String",
           },
         },
       ],
     },
-    "description": "A String", # Text that describes the vulnerability or misconfiguration that the custom module detects. This explanation is returned with each finding instance to help investigators understand the detected issue. The text must be enclosed in quotation marks.
-    "predicate": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The CEL expression to evaluate to produce findings. When the expression evaluates to true against a resource, a finding is generated.
-      "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
-      "expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
-      "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
-      "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
+    "description": "A String",
+    "predicate": {
+      "description": "A String",
+      "expression": "A String",
+      "location": "A String",
+      "title": "A String",
     },
-    "recommendation": "A String", # An explanation of the recommended steps that security teams can take to resolve the detected issue. This explanation is returned with each finding generated by this module in the `nextSteps` property of the finding JSON.
-    "resourceSelector": { # Resource for selecting resource type. # The resource types that the custom module operates on. Each custom module can specify up to 5 resource types.
-      "resourceTypes": [ # The resource types to run the detector on.
+    "recommendation": "A String",
+    "resourceSelector": {
+      "resourceTypes": [
         "A String",
       ],
     },
-    "severity": "A String", # The severity to assign to findings generated by the module.
+    "severity": "A String",
   },
-  "resource": { # Manually constructed resource name. If the custom module evaluates against only the resource data, you can omit the `iam_policy_data` field. If it evaluates only the `iam_policy_data` field, you can omit the resource data. # Required. Resource data to simulate custom module against.
-    "iamPolicyData": { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). # Optional. A representation of the IAM policy.
-      "auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
-        { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging.
-          "auditLogConfigs": [ # The configuration for logging of each type of permission.
-            { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.
-              "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.
+  "resource": {
+    "iamPolicyData": {
+      "auditConfigs": [
+        {
+          "auditLogConfigs": [
+            {
+              "exemptedMembers": [
                 "A String",
               ],
-              "logType": "A String", # The log type that this config enables.
+              "logType": "A String",
             },
           ],
-          "service": "A String", # Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services.
+          "service": "A String",
         },
       ],
-      "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`.
-        { # Associates `members`, or principals, with a `role`.
-          "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
-            "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
-            "expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
-            "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
-            "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
+      "bindings": [
+        {
+          "condition": {
+            "description": "A String",
+            "expression": "A String",
+            "location": "A String",
+            "title": "A String",
           },
-          "members": [ # Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
+          "members": [
             "A String",
           ],
-          "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles).
+          "role": "A String",
         },
       ],
-      "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).
+      "etag": "A String",
+      "version": 42,
     },
-    "resourceData": { # Optional. A representation of the Google Cloud resource. Should match the Google Cloud resource JSON format.
+    "resourceData": {
       "a_key": "", # Properties of the object.
     },
-    "resourceType": "A String", # Required. The type of the resource, for example, `compute.googleapis.com/Disk`.
+    "resourceType": "A String",
   },
 }
 
@@ -611,826 +611,826 @@ 

Method Details

Returns: An object of the form: - { # Response message for simulating a `SecurityHealthAnalyticsCustomModule` against a given resource. - "result": { # Possible test result. # Result for test case in the corresponding request. - "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). # Error encountered during the test. - "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. + { + "result": { + "error": { + "code": 42, + "details": [ { "a_key": "", # Properties of the object. Contains field @type with type URL. }, ], - "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. + "message": "A String", }, - "finding": { # Security Command Center finding. A finding is a record of assessment data like security, risk, health, or privacy, that is ingested into Security Command Center for presentation, notification, analysis, policy testing, and enforcement. For example, a cross-site scripting (XSS) vulnerability in an App Engine application is a finding. # Finding that would be published for the test case, if a violation is detected. - "access": { # Represents an access event. # Access details associated with the finding, such as more information on the caller, which method was accessed, and from where. - "callerIp": "A String", # Caller's IP address, such as "1.1.1.1". - "callerIpGeo": { # Represents a geographical location for a given access. # The caller IP's geolocation, which identifies where the call came from. - "regionCode": "A String", # A CLDR. + "finding": { + "access": { + "callerIp": "A String", + "callerIpGeo": { + "regionCode": "A String", }, - "methodName": "A String", # The method that the service account called, e.g. "SetIamPolicy". - "principalEmail": "A String", # Associated email, such as "foo@google.com". The email address of the authenticated user or a service account acting on behalf of a 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). - "principalSubject": "A String", # A string that represents the principal_subject that is associated with the identity. Unlike `principal_email`, `principal_subject` supports principals that aren't associated with email addresses, such as third party principals. For most identities, the format is `principal://iam.googleapis.com/{identity pool name}/subject/{subject}`. Some GKE identities, such as GKE_WORKLOAD, FREEFORM, and GKE_HUB_WORKLOAD, still use the legacy format `serviceAccount:{identity pool name}[{subject}]`. - "serviceAccountDelegationInfo": [ # The identity delegation history of an authenticated service account that made the request. The `serviceAccountDelegationInfo[]` object contains information about the real authorities that try to access Google Cloud resources by delegating on a service account. When multiple authorities are present, they are guaranteed to be sorted based on the original ordering of the identity delegation events. - { # Identity delegation history of an authenticated service account. - "principalEmail": "A String", # The email address of a Google account. - "principalSubject": "A String", # A string representing the principal_subject associated with the identity. As compared to `principal_email`, supports principals that aren't associated with email addresses, such as third party principals. For most identities, the format will be `principal://iam.googleapis.com/{identity pool name}/subjects/{subject}` except for some GKE identities (GKE_WORKLOAD, FREEFORM, GKE_HUB_WORKLOAD) that are still in the legacy format `serviceAccount:{identity pool name}[{subject}]` + "methodName": "A String", + "principalEmail": "A String", + "principalSubject": "A String", + "serviceAccountDelegationInfo": [ + { + "principalEmail": "A String", + "principalSubject": "A String", }, ], - "serviceAccountKeyName": "A String", # The name of the service account key that was used to create or exchange credentials when authenticating the service account that made the request. This is a scheme-less URI full resource name. For example: "//iam.googleapis.com/projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}/keys/{key}". - "serviceName": "A String", # This is the API service that the service account made a call to, e.g. "iam.googleapis.com" - "userAgent": "A String", # The caller's user agent string associated with the finding. - "userAgentFamily": "A String", # Type of user agent associated with the finding. For example, an operating system shell or an embedded or standalone application. - "userName": "A String", # A string that represents a username. The username provided depends on the type of the finding and is likely not an IAM principal. For example, this can be a system username if the finding is related to a virtual machine, or it can be an application login username. + "serviceAccountKeyName": "A String", + "serviceName": "A String", + "userAgent": "A String", + "userAgentFamily": "A String", + "userName": "A String", }, - "affectedResources": { # Details about resources affected by this finding. # AffectedResources associated with the finding. - "count": "A String", # The count of resources affected by the finding. + "affectedResources": { + "count": "A String", }, - "agentDataAccessEvents": [ # Agent data access events associated with the finding. - { # Details about a data access attempt made by an agent principal not authorized under applicable data security policy. - "eventId": "A String", # Unique identifier for data access event. - "eventTime": "A String", # Timestamp of data access event. - "operation": "A String", # The operation performed by the principal to access the data. - "principalSubject": "A String", # The agent principal that accessed the data. + "agentDataAccessEvents": [ + { + "eventId": "A String", + "eventTime": "A String", + "operation": "A String", + "principalSubject": "A String", }, ], - "aiModel": { # Contains information about the AI model associated with the finding. # The AI model associated with the finding. - "deploymentPlatform": "A String", # The platform on which the model is deployed. - "displayName": "A String", # The user defined display name of model. Ex. baseline-classification-model - "domain": "A String", # The domain of the model, for example, “image-classification”. - "library": "A String", # The name of the model library, for example, “transformers”. - "location": "A String", # The region in which the model is used, for example, “us-central1”. - "name": "A String", # The name of the AI model, for example, "gemini:1.0.0". - "publisher": "A String", # The publisher of the model, for example, “google” or “nvidia”. - "usageCategory": "A String", # The purpose of the model, for example, "Inteference" or "Training". + "aiModel": { + "deploymentPlatform": "A String", + "displayName": "A String", + "domain": "A String", + "library": "A String", + "location": "A String", + "name": "A String", + "publisher": "A String", + "usageCategory": "A String", }, - "application": { # Represents an application associated with a finding. # Represents an application associated with the finding. - "baseUri": "A String", # The base URI that identifies the network location of the application in which the vulnerability was detected. For example, `http://example.com`. - "fullUri": "A String", # The full URI with payload that can be used to reproduce the vulnerability. For example, `http://example.com?p=aMmYgI6H`. + "application": { + "baseUri": "A String", + "fullUri": "A String", }, - "artifactGuardPolicies": { # Represents the result of evaluating artifact guard policies. # ArtifactGuardPolicies associated with the finding. - "failingPolicies": [ # A list of failing policies. - { # Represents an artifact guard policy. - "failureReason": "A String", # The reason for the policy failure, for example, "severity=HIGH AND max_vuln_count=2". - "policyId": "A String", # The ID of the failing policy, for example, "organizations/3392779/locations/global/policies/prod-policy". - "type": "A String", # The type of the policy evaluation. + "artifactGuardPolicies": { + "failingPolicies": [ + { + "failureReason": "A String", + "policyId": "A String", + "type": "A String", }, ], - "resourceId": "A String", # The ID of the resource that has policies configured for it. + "resourceId": "A String", }, - "attackExposure": { # An attack exposure contains the results of an attack path simulation run. # The results of an attack path simulation relevant to this finding. - "attackExposureResult": "A String", # The resource name of the attack path simulation result that contains the details regarding this attack exposure score. Example: `organizations/123/simulations/456/attackExposureResults/789` - "exposedHighValueResourcesCount": 42, # The number of high value resources that are exposed as a result of this finding. - "exposedLowValueResourcesCount": 42, # The number of high value resources that are exposed as a result of this finding. - "exposedMediumValueResourcesCount": 42, # The number of medium value resources that are exposed as a result of this finding. - "latestCalculationTime": "A String", # The most recent time the attack exposure was updated on this finding. - "score": 3.14, # A number between 0 (inclusive) and infinity that represents how important this finding is to remediate. The higher the score, the more important it is to remediate. - "state": "A String", # What state this AttackExposure is in. This captures whether or not an attack exposure has been calculated or not. + "attackExposure": { + "attackExposureResult": "A String", + "exposedHighValueResourcesCount": 42, + "exposedLowValueResourcesCount": 42, + "exposedMediumValueResourcesCount": 42, + "latestCalculationTime": "A String", + "score": 3.14, + "state": "A String", }, - "backupDisasterRecovery": { # Information related to Google Cloud Backup and DR Service findings. # Fields related to Backup and DR findings. - "appliance": "A String", # The name of the Backup and DR appliance that captures, moves, and manages the lifecycle of backup data. For example, `backup-server-57137`. - "applications": [ # The names of Backup and DR applications. An application is a VM, database, or file system on a managed host monitored by a backup and recovery appliance. For example, `centos7-01-vol00`, `centos7-01-vol01`, `centos7-01-vol02`. + "backupDisasterRecovery": { + "appliance": "A String", + "applications": [ "A String", ], - "backupCreateTime": "A String", # The timestamp at which the Backup and DR backup was created. - "backupTemplate": "A String", # The name of a Backup and DR template which comprises one or more backup policies. See the [Backup and DR documentation](https://cloud.google.com/backup-disaster-recovery/docs/concepts/backup-plan#temp) for more information. For example, `snap-ov`. - "backupType": "A String", # The backup type of the Backup and DR image. For example, `Snapshot`, `Remote Snapshot`, `OnVault`. - "host": "A String", # The name of a Backup and DR host, which is managed by the backup and recovery appliance and known to the management console. The host can be of type Generic (for example, Compute Engine, SQL Server, Oracle DB, SMB file system, etc.), vCenter, or an ESX server. See the [Backup and DR documentation on hosts](https://cloud.google.com/backup-disaster-recovery/docs/configuration/manage-hosts-and-their-applications) for more information. For example, `centos7-01`. - "policies": [ # The names of Backup and DR policies that are associated with a template and that define when to run a backup, how frequently to run a backup, and how long to retain the backup image. For example, `onvaults`. + "backupCreateTime": "A String", + "backupTemplate": "A String", + "backupType": "A String", + "host": "A String", + "policies": [ "A String", ], - "policyOptions": [ # The names of Backup and DR advanced policy options of a policy applying to an application. See the [Backup and DR documentation on policy options](https://cloud.google.com/backup-disaster-recovery/docs/create-plan/policy-settings). For example, `skipofflineappsincongrp, nounmap`. + "policyOptions": [ "A String", ], - "profile": "A String", # The name of the Backup and DR resource profile that specifies the storage media for backups of application and VM data. See the [Backup and DR documentation on profiles](https://cloud.google.com/backup-disaster-recovery/docs/concepts/backup-plan#profile). For example, `GCP`. - "storagePool": "A String", # The name of the Backup and DR storage pool that the backup and recovery appliance is storing data in. The storage pool could be of type Cloud, Primary, Snapshot, or OnVault. See the [Backup and DR documentation on storage pools](https://cloud.google.com/backup-disaster-recovery/docs/concepts/storage-pools). For example, `DiskPoolOne`. + "profile": "A String", + "storagePool": "A String", }, - "canonicalName": "A String", # The canonical name of the finding. It's either "organizations/{organization_id}/sources/{source_id}/findings/{finding_id}", "folders/{folder_id}/sources/{source_id}/findings/{finding_id}" or "projects/{project_number}/sources/{source_id}/findings/{finding_id}", depending on the closest CRM ancestor of the resource associated with the finding. - "category": "A String", # The additional taxonomy group within findings from a given source. This field is immutable after creation time. Example: "XSS_FLASH_INJECTION" - "chokepoint": { # Contains details about a chokepoint, which is a resource or resource group where high-risk attack paths converge, based on [attack path simulations] (https://cloud.google.com/security-command-center/docs/attack-exposure-learn#attack_path_simulations). # Contains details about a chokepoint, which is a resource or resource group where high-risk attack paths converge, based on [attack path simulations] (https://cloud.google.com/security-command-center/docs/attack-exposure-learn#attack_path_simulations). This field cannot be updated. Its value is ignored in all update requests. - "relatedFindings": [ # List of resource names of findings associated with this chokepoint. For example, organizations/123/sources/456/findings/789. This list will have at most 100 findings. + "canonicalName": "A String", + "category": "A String", + "chokepoint": { + "relatedFindings": [ "A String", ], }, - "cloudArmor": { # Fields related to Google Cloud Armor findings. # Fields related to Cloud Armor findings. - "adaptiveProtection": { # Information about [Google Cloud Armor Adaptive Protection](https://cloud.google.com/armor/docs/cloud-armor-overview#google-cloud-armor-adaptive-protection). # Information about potential Layer 7 DDoS attacks identified by [Google Cloud Armor Adaptive Protection](https://cloud.google.com/armor/docs/adaptive-protection-overview). - "confidence": 3.14, # A score of 0 means that there is low confidence that the detected event is an actual attack. A score of 1 means that there is high confidence that the detected event is an attack. See the [Adaptive Protection documentation](https://cloud.google.com/armor/docs/adaptive-protection-overview#configure-alert-tuning) for further explanation. + "cloudArmor": { + "adaptiveProtection": { + "confidence": 3.14, }, - "attack": { # Information about DDoS attack volume and classification. # Information about DDoS attack volume and classification. - "classification": "A String", # Type of attack, for example, 'SYN-flood', 'NTP-udp', or 'CHARGEN-udp'. - "volumeBps": 42, # Total BPS (bytes per second) volume of attack. Deprecated - refer to volume_bps_long instead. - "volumeBpsLong": "A String", # Total BPS (bytes per second) volume of attack. - "volumePps": 42, # Total PPS (packets per second) volume of attack. Deprecated - refer to volume_pps_long instead. - "volumePpsLong": "A String", # Total PPS (packets per second) volume of attack. + "attack": { + "classification": "A String", + "volumeBps": 42, + "volumeBpsLong": "A String", + "volumePps": 42, + "volumePpsLong": "A String", }, - "duration": "A String", # Duration of attack from the start until the current moment (updated every 5 minutes). - "requests": { # Information about the requests relevant to the finding. # Information about incoming requests evaluated by [Google Cloud Armor security policies](https://cloud.google.com/armor/docs/security-policy-overview). - "longTermAllowed": 42, # Allowed RPS (requests per second) over the long term. - "longTermDenied": 42, # Denied RPS (requests per second) over the long term. - "ratio": 3.14, # For 'Increasing deny ratio', the ratio is the denied traffic divided by the allowed traffic. For 'Allowed traffic spike', the ratio is the allowed traffic in the short term divided by allowed traffic in the long term. - "shortTermAllowed": 42, # Allowed RPS (requests per second) in the short term. + "duration": "A String", + "requests": { + "longTermAllowed": 42, + "longTermDenied": 42, + "ratio": 3.14, + "shortTermAllowed": 42, }, - "securityPolicy": { # Information about the [Google Cloud Armor security policy](https://cloud.google.com/armor/docs/security-policy-overview) relevant to the finding. # Information about the [Google Cloud Armor security policy](https://cloud.google.com/armor/docs/security-policy-overview) relevant to the finding. - "name": "A String", # The name of the Google Cloud Armor security policy, for example, "my-security-policy". - "preview": True or False, # Whether or not the associated rule or policy is in preview mode. - "type": "A String", # The type of Google Cloud Armor security policy for example, 'backend security policy', 'edge security policy', 'network edge security policy', or 'always-on DDoS protection'. + "securityPolicy": { + "name": "A String", + "preview": True or False, + "type": "A String", }, - "threatVector": "A String", # Distinguish between volumetric & protocol DDoS attack and application layer attacks. For example, "L3_4" for Layer 3 and Layer 4 DDoS attacks, or "L_7" for Layer 7 DDoS attacks. + "threatVector": "A String", }, - "cloudDlpDataProfile": { # The [data profile](https://cloud.google.com/dlp/docs/data-profiles) associated with the finding. # Cloud DLP data profile that is associated with the finding. - "dataProfile": "A String", # Name of the data profile, for example, `projects/123/locations/europe/tableProfiles/8383929`. - "infoTypes": [ # Type of information detected by SDP. Info type includes name, version and sensitivity of the detected information type. - { # Type of information detected by the API. - "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. - "sensitivityScore": { # Score is calculated from of all elements in the data profile. A higher level means the data is more sensitive. # Optional custom sensitivity for this InfoType. This only applies to data profiling. - "score": "A String", # The sensitivity score applied to the resource. + "cloudDlpDataProfile": { + "dataProfile": "A String", + "infoTypes": [ + { + "name": "A String", + "sensitivityScore": { + "score": "A String", }, - "version": "A String", # Optional version name for this InfoType. + "version": "A String", }, ], - "parentType": "A String", # The resource hierarchy level at which the data profile was generated. + "parentType": "A String", }, - "cloudDlpInspection": { # Details about the Cloud Data Loss Prevention (Cloud DLP) [inspection job](https://cloud.google.com/dlp/docs/concepts-job-triggers) that produced the finding. # Cloud Data Loss Prevention (Cloud DLP) inspection results that are associated with the finding. - "fullScan": True or False, # Whether Cloud DLP scanned the complete resource or a sampled subset. - "infoType": "A String", # The type of information (or *[infoType](https://cloud.google.com/dlp/docs/infotypes-reference)*) found, for example, `EMAIL_ADDRESS` or `STREET_ADDRESS`. - "infoTypeCount": "A String", # The number of times Cloud DLP found this infoType within this job and resource. - "inspectJob": "A String", # Name of the inspection job, for example, `projects/123/locations/europe/dlpJobs/i-8383929`. + "cloudDlpInspection": { + "fullScan": True or False, + "infoType": "A String", + "infoTypeCount": "A String", + "inspectJob": "A String", }, - "complianceDetails": { # Compliance Details associated with the finding. # Details about the compliance implications of the finding. - "cloudControl": { # CloudControl associated with the finding. # CloudControl associated with the finding - "cloudControlName": "A String", # Name of the CloudControl associated with the finding. - "policyType": "A String", # Policy type of the CloudControl - "type": "A String", # Type of cloud control. - "version": 42, # Version of the Cloud Control + "complianceDetails": { + "cloudControl": { + "cloudControlName": "A String", + "policyType": "A String", + "type": "A String", + "version": 42, }, - "cloudControlDeploymentNames": [ # Cloud Control Deployments associated with the finding. For example, organizations/123/locations/global/cloudControlDeployments/deploymentIdentifier + "cloudControlDeploymentNames": [ "A String", ], - "frameworks": [ # Details of Frameworks associated with the finding - { # Compliance framework associated with the finding. - "category": [ # Category of the framework associated with the finding. E.g. Security Benchmark, or Assured Workloads + "frameworks": [ + { + "category": [ "A String", ], - "controls": [ # The controls associated with the framework. - { # Compliance control associated with the finding. - "controlName": "A String", # Name of the Control - "displayName": "A String", # Display name of the control. For example, AU-02. + "controls": [ + { + "controlName": "A String", + "displayName": "A String", }, ], - "displayName": "A String", # Display name of the framework. For a standard framework, this will look like e.g. PCI DSS 3.2.1, whereas for a custom framework it can be a user defined string like MyFramework - "name": "A String", # Name of the framework associated with the finding - "type": "A String", # Type of the framework associated with the finding, to specify whether the framework is built-in (pre-defined and immutable) or a custom framework defined by the customer (equivalent to security posture) + "displayName": "A String", + "name": "A String", + "type": "A String", }, ], }, - "compliances": [ # Contains compliance information for security standards associated to the finding. - { # Contains compliance information about a security standard indicating unmet recommendations. - "ids": [ # Policies within the standard or benchmark, for example, A.12.4.1 + "compliances": [ + { + "ids": [ "A String", ], - "standard": "A String", # Industry-wide compliance standards or benchmarks, such as CIS, PCI, and OWASP. - "version": "A String", # Version of the standard or benchmark, for example, 1.1 + "standard": "A String", + "version": "A String", }, ], - "connections": [ # Contains information about the IP connection associated with the finding. - { # Contains information about the IP connection associated with the finding. - "destinationIp": "A String", # Destination IP address. Not present for sockets that are listening and not connected. - "destinationPort": 42, # Destination port. Not present for sockets that are listening and not connected. - "protocol": "A String", # IANA Internet Protocol Number such as TCP(6) and UDP(17). - "sourceIp": "A String", # Source IP address. - "sourcePort": 42, # Source port. + "connections": [ + { + "destinationIp": "A String", + "destinationPort": 42, + "protocol": "A String", + "sourceIp": "A String", + "sourcePort": 42, }, ], - "contacts": { # Output only. Map containing the points of contact for the given finding. The key represents the type of contact, while the value contains a list of all the contacts that pertain. Please refer to: https://cloud.google.com/resource-manager/docs/managing-notification-contacts#notification-categories { "security": { "contacts": [ { "email": "person1@company.com" }, { "email": "person2@company.com" } ] } } - "a_key": { # Details about specific contacts - "contacts": [ # A list of contacts - { # The email address of a contact. - "email": "A String", # An email address. For example, "`person123@company.com`". + "contacts": { + "a_key": { + "contacts": [ + { + "email": "A String", }, ], }, }, - "containers": [ # Containers associated with the finding. This field provides information for both Kubernetes and non-Kubernetes containers. - { # Container associated with the finding. - "createTime": "A String", # The time that the container was created. - "imageId": "A String", # Optional container image ID, if provided by the container runtime. Uniquely identifies the container image launched using a container image digest. - "labels": [ # Container labels, as provided by the container runtime. - { # Represents a generic name-value label. A label has separate name and value fields to support filtering with the `contains()` function. For more information, see [Filtering on array-type fields](https://cloud.google.com/security-command-center/docs/how-to-api-list-findings#array-contains-filtering). - "name": "A String", # Name of the label. - "value": "A String", # Value that corresponds to the label's name. + "containers": [ + { + "createTime": "A String", + "imageId": "A String", + "labels": [ + { + "name": "A String", + "value": "A String", }, ], - "name": "A String", # Name of the container. - "uri": "A String", # Container image URI provided when configuring a pod or container. This string can identify a container image version using mutable tags. + "name": "A String", + "uri": "A String", }, ], - "createTime": "A String", # The time at which the finding was created in Security Command Center. - "dataAccessEvents": [ # Data access events associated with the finding. - { # Details about a data access attempt made by a principal not authorized under applicable data security policy. - "eventId": "A String", # Unique identifier for data access event. - "eventTime": "A String", # Timestamp of data access event. - "operation": "A String", # The operation performed by the principal to access the data. - "principalEmail": "A String", # The email address of the principal that accessed the data. The principal could be a user account, service account, Google group, or other. + "createTime": "A String", + "dataAccessEvents": [ + { + "eventId": "A String", + "eventTime": "A String", + "operation": "A String", + "principalEmail": "A String", }, ], - "dataFlowEvents": [ # Data flow events associated with the finding. - { # Details about a data flow event, in which either the data is moved to or is accessed from a non-compliant geo-location, as defined in the applicable data security policy. - "eventId": "A String", # Unique identifier for data flow event. - "eventTime": "A String", # Timestamp of data flow event. - "operation": "A String", # The operation performed by the principal for the data flow event. - "principalEmail": "A String", # The email address of the principal that initiated the data flow event. The principal could be a user account, service account, Google group, or other. - "violatedLocation": "A String", # Non-compliant location of the principal or the data destination. + "dataFlowEvents": [ + { + "eventId": "A String", + "eventTime": "A String", + "operation": "A String", + "principalEmail": "A String", + "violatedLocation": "A String", }, ], - "dataRetentionDeletionEvents": [ # Data retention deletion events associated with the finding. - { # Details about data retention deletion violations, in which the data is non-compliant based on their retention or deletion time, as defined in the applicable data security policy. The Data Retention Deletion (DRD) control is a control of the DSPM (Data Security Posture Management) suite that enables organizations to manage data retention and deletion policies in compliance with regulations, such as GDPR and CRPA. DRD supports two primary policy types: maximum storage length (max TTL) and minimum storage length (min TTL). Both are aimed at helping organizations meet regulatory and data management commitments. - "dataObjectCount": "A String", # Number of objects that violated the policy for this resource. If the number is less than 1,000, then the value of this field is the exact number. If the number of objects that violated the policy is greater than or equal to 1,000, then the value of this field is 1000. - "eventDetectionTime": "A String", # Timestamp indicating when the event was detected. - "eventType": "A String", # Type of the DRD event. - "maxRetentionAllowed": "A String", # Maximum duration of retention allowed from the DRD control. This comes from the DRD control where users set a max TTL for their data. For example, suppose that a user sets the max TTL for a Cloud Storage bucket to 90 days. However, an object in that bucket is 100 days old. In this case, a DataRetentionDeletionEvent will be generated for that Cloud Storage bucket, and the max_retention_allowed is 90 days. - "minRetentionAllowed": "A String", # Min duration of retention allowed from the DSPM retention control. This field is only populated when event type is set to EVENT_TYPE_MIN_TTL_FROM_CREATION. + "dataRetentionDeletionEvents": [ + { + "dataObjectCount": "A String", + "eventDetectionTime": "A String", + "eventType": "A String", + "maxRetentionAllowed": "A String", + "minRetentionAllowed": "A String", }, ], - "database": { # Represents database access information, such as queries. A database may be a sub-resource of an instance (as in the case of Cloud SQL instances or Cloud Spanner instances), or the database instance itself. Some database resources might not have the [full resource name](https://google.aip.dev/122#full-resource-names) populated because these resource types, such as Cloud SQL databases, are not yet supported by Cloud Asset Inventory. In these cases only the display name is provided. # Database associated with the finding. - "displayName": "A String", # The human-readable name of the database that the user connected to. - "grantees": [ # The target usernames, roles, or groups of an SQL privilege grant, which is not an IAM policy change. + "database": { + "displayName": "A String", + "grantees": [ "A String", ], - "name": "A String", # Some database resources may not have the [full resource name](https://google.aip.dev/122#full-resource-names) populated because these resource types are not yet supported by Cloud Asset Inventory (e.g. Cloud SQL databases). In these cases only the display name will be provided. The [full resource name](https://google.aip.dev/122#full-resource-names) of the database that the user connected to, if it is supported by Cloud Asset Inventory. - "query": "A String", # The SQL statement that is associated with the database access. - "userName": "A String", # The username used to connect to the database. The username might not be an IAM principal and does not have a set format. - "version": "A String", # The version of the database, for example, POSTGRES_14. See [the complete list](https://cloud.google.com/sql/docs/mysql/admin-api/rest/v1/SqlDatabaseVersion). + "name": "A String", + "query": "A String", + "userName": "A String", + "version": "A String", }, - "description": "A String", # Contains more details about the finding. - "discoveredWorkload": { # Represents discovered, customer managed workload that is not registered with the respective GCP service. # DiscoveredWorkload associated with the finding. - "confidence": "A String", # The confidence in detection of this workload. - "detectedRelevantHardware": True or False, # A boolean flag set to true if associated hardware strongly predicts the workload type. - "detectedRelevantKeywords": True or False, # A boolean flag set to true if associated keywords strongly predict the workload type. - "detectedRelevantPackages": True or False, # A boolean flag set to true if installed packages strongly predict the workload type. - "workloadType": "A String", # The type of workload. + "description": "A String", + "discoveredWorkload": { + "confidence": "A String", + "detectedRelevantHardware": True or False, + "detectedRelevantKeywords": True or False, + "detectedRelevantPackages": True or False, + "workloadType": "A String", }, - "disk": { # Contains information about the disk associated with the finding. # Disk associated with the finding. - "name": "A String", # The name of the disk, for example, "https://www.googleapis.com/compute/v1/projects/{project-id}/zones/{zone-id}/disks/{disk-id}". + "disk": { + "name": "A String", }, - "eventTime": "A String", # The time the finding was first detected. If an existing finding is updated, then this is the time the update occurred. For example, if the finding represents an open firewall, this property captures the time the detector believes the firewall became open. The accuracy is determined by the detector. If the finding is later resolved, then this time reflects when the finding was resolved. This must not be set to a value greater than the current timestamp. - "exfiltration": { # Exfiltration represents a data exfiltration attempt from one or more sources to one or more targets. The `sources` attribute lists the sources of the exfiltrated data. The `targets` attribute lists the destinations the data was copied to. # Represents exfiltrations associated with the finding. - "sources": [ # If there are multiple sources, then the data is considered "joined" between them. For instance, BigQuery can join multiple tables, and each table would be considered a source. - { # Resource where data was exfiltrated from or exfiltrated to. - "components": [ # Subcomponents of the asset that was exfiltrated, like URIs used during exfiltration, table names, databases, and filenames. For example, multiple tables might have been exfiltrated from the same Cloud SQL instance, or multiple files might have been exfiltrated from the same Cloud Storage bucket. + "eventTime": "A String", + "exfiltration": { + "sources": [ + { + "components": [ "A String", ], - "name": "A String", # The resource's [full resource name](https://cloud.google.com/apis/design/resource_names#full_resource_name). + "name": "A String", }, ], - "targets": [ # If there are multiple targets, each target would get a complete copy of the "joined" source data. - { # Resource where data was exfiltrated from or exfiltrated to. - "components": [ # Subcomponents of the asset that was exfiltrated, like URIs used during exfiltration, table names, databases, and filenames. For example, multiple tables might have been exfiltrated from the same Cloud SQL instance, or multiple files might have been exfiltrated from the same Cloud Storage bucket. + "targets": [ + { + "components": [ "A String", ], - "name": "A String", # The resource's [full resource name](https://cloud.google.com/apis/design/resource_names#full_resource_name). + "name": "A String", }, ], - "totalExfiltratedBytes": "A String", # Total exfiltrated bytes processed for the entire job. + "totalExfiltratedBytes": "A String", }, - "externalExposure": { # Details about the externally exposed resource associated with the finding. # External exposure associated with the finding. - "backendBucket": "A String", # The full resource name of the load balancer backend bucket, for example, "//compute.googleapis.com/projects/{project-id}/global/backendBuckets/{name}" - "backendService": "A String", # The full resource name of load balancer backend service, for example, "//compute.googleapis.com/projects/{project-id}/global/backendServices/{name}". - "exposedApplication": "A String", # The name and version of the exposed web application, for example, "Jenkins 2.184". - "exposedEndpoint": "A String", # The resource which is running the exposed service, for example, "//compute.googleapis.com/projects/{project-id}/zones/{zone}/instances/{instance}.” - "exposedService": "A String", # The name and version of the service, for example, "Jupyter Notebook 6.14.0". - "forwardingRule": "A String", # The full resource name of the forwarding rule, for example, "//compute.googleapis.com/projects/{project-id}/global/forwardingRules/{forwarding-rule-name}". - "hostnameUri": "A String", # Hostname of the exposed application, for example, "https://test-app.a.run.app/" - "httpResponse": [ # The http response returned by the web application. - { # The http response returned by the web application. - "path": "A String", # The http path for which response code was returned by web application, for example, "https://test-app.a.run.app/test". - "statusCode": "A String", # The http response code returned by the web application, for example, 200. + "externalExposure": { + "backendBucket": "A String", + "backendService": "A String", + "exposedApplication": "A String", + "exposedEndpoint": "A String", + "exposedService": "A String", + "forwardingRule": "A String", + "hostnameUri": "A String", + "httpResponse": [ + { + "path": "A String", + "statusCode": "A String", }, ], - "instanceGroup": "A String", # The full resource name of the instance group, for example, "//compute.googleapis.com/projects/{project-id}/global/instanceGroups/{name}". - "internalBackendService": "A String", # The full resource name of load balancer backend service in the internal project having resource exposed via PSC, for example, "//compute.googleapis.com/projects/{project-id}/global/backendServices/{name}". - "loadBalancerFirewallPolicy": "A String", # The full resource name of the load balancer firewall policy, for example, "//compute.googleapis.com/projects/{project-id}/global/firewallPolicies/{policy-name}". - "networkEndpointGroup": "A String", # The full resource name of the network endpoint group, for example, "//compute.googleapis.com/projects/{project-id}/global/networkEndpointGroups/{name}". - "networkIngressFirewallPolicy": "A String", # The full resource name of the network ingress firewall policy, for example, "//compute.googleapis.com/projects/{project-id}/global/firewallPolicies/{name}". - "privateIpAddress": "A String", # Private IP address of the exposed endpoint. - "privatePort": "A String", # Port number associated with private IP address. - "pscNetworkAttachment": "A String", # The full resource name of the PSC (Private Service Connect) network attachment that network interface controller is attached to, for example, "//compute.googleapis.com/projects/{project-id}/regions/{region}/networkAttachments/{name}" - "pscServiceAttachment": "A String", # The full resource name of the PSC (Private Service Connect) service attachment that the load balancer network endpoint group targets, for example, "//compute.googleapis.com/projects/{project-id}/regions/{region}/serviceAttachments/{name}" - "publicIpAddress": "A String", # Public IP address of the exposed endpoint. - "publicPort": "A String", # Public port number of the exposed endpoint. - "serviceFirewallPolicy": "A String", # The full resource name of the firewall policy of the exposed service, for example, "//compute.googleapis.com/projects/{project-id}/global/firewallPolicies/{policy-name}". + "instanceGroup": "A String", + "internalBackendService": "A String", + "loadBalancerFirewallPolicy": "A String", + "networkEndpointGroup": "A String", + "networkIngressFirewallPolicy": "A String", + "privateIpAddress": "A String", + "privatePort": "A String", + "pscNetworkAttachment": "A String", + "pscServiceAttachment": "A String", + "publicIpAddress": "A String", + "publicPort": "A String", + "serviceFirewallPolicy": "A String", }, - "externalSystems": { # Output only. Third party SIEM/SOAR fields within SCC, contains external system information and external system finding fields. - "a_key": { # Representation of third party SIEM/SOAR fields within SCC. - "assignees": [ # References primary/secondary etc assignees in the external system. + "externalSystems": { + "a_key": { + "assignees": [ "A String", ], - "caseCloseTime": "A String", # The time when the case was closed, as reported by the external system. - "caseCreateTime": "A String", # The time when the case was created, as reported by the external system. - "casePriority": "A String", # The priority of the finding's corresponding case in the external system. - "caseSla": "A String", # The SLA of the finding's corresponding case in the external system. - "caseUri": "A String", # The link to the finding's corresponding case in the external system. - "externalSystemUpdateTime": "A String", # The time when the case was last updated, as reported by the external system. - "externalUid": "A String", # The identifier that's used to track the finding's corresponding case in the external system. - "name": "A String", # Full resource name of the external system, for example: "organizations/1234/sources/5678/findings/123456/externalSystems/jira", "folders/1234/sources/5678/findings/123456/externalSystems/jira", "projects/1234/sources/5678/findings/123456/externalSystems/jira" - "status": "A String", # The most recent status of the finding's corresponding case, as reported by the external system. - "ticketInfo": { # Information about the ticket, if any, that is being used to track the resolution of the issue that is identified by this finding. # Information about the ticket, if any, that is being used to track the resolution of the issue that is identified by this finding. - "assignee": "A String", # The assignee of the ticket in the ticket system. - "description": "A String", # The description of the ticket in the ticket system. - "id": "A String", # The identifier of the ticket in the ticket system. - "status": "A String", # The latest status of the ticket, as reported by the ticket system. - "updateTime": "A String", # The time when the ticket was last updated, as reported by the ticket system. - "uri": "A String", # The link to the ticket in the ticket system. + "caseCloseTime": "A String", + "caseCreateTime": "A String", + "casePriority": "A String", + "caseSla": "A String", + "caseUri": "A String", + "externalSystemUpdateTime": "A String", + "externalUid": "A String", + "name": "A String", + "status": "A String", + "ticketInfo": { + "assignee": "A String", + "description": "A String", + "id": "A String", + "status": "A String", + "updateTime": "A String", + "uri": "A String", }, }, }, - "externalUri": "A String", # The URI that, if available, points to a web page outside of Security Command Center where additional information about the finding can be found. This field is guaranteed to be either empty or a well formed URL. - "files": [ # File associated with the finding. - { # File information about the related binary/library used by an executable, or the script used by a script interpreter - "contents": "A String", # Prefix of the file contents as a JSON-encoded string. - "diskPath": { # Path of the file in terms of underlying disk/partition identifiers. # Path of the file in terms of underlying disk/partition identifiers. - "partitionUuid": "A String", # UUID of the partition (format https://wiki.archlinux.org/title/persistent_block_device_naming#by-uuid) - "relativePath": "A String", # Relative path of the file in the partition as a JSON encoded string. Example: /home/user1/executable_file.sh + "externalUri": "A String", + "files": [ + { + "contents": "A String", + "diskPath": { + "partitionUuid": "A String", + "relativePath": "A String", }, - "fileLoadState": "A String", # The load state of the file. - "hashedSize": "A String", # The length in bytes of the file prefix that was hashed. If hashed_size == size, any hashes reported represent the entire file. - "operations": [ # Operation(s) performed on a file. - { # Operation(s) performed on a file. - "type": "A String", # The type of the operation + "fileLoadState": "A String", + "hashedSize": "A String", + "operations": [ + { + "type": "A String", }, ], - "partiallyHashed": True or False, # True when the hash covers only a prefix of the file. - "path": "A String", # Absolute path of the file as a JSON encoded string. - "sha256": "A String", # SHA256 hash of the first hashed_size bytes of the file encoded as a hex string. If hashed_size == size, sha256 represents the SHA256 hash of the entire file. - "size": "A String", # Size of the file in bytes. + "partiallyHashed": True or False, + "path": "A String", + "sha256": "A String", + "size": "A String", }, ], - "findingClass": "A String", # The class of the finding. - "groupMemberships": [ # Contains details about groups of which this finding is a member. A group is a collection of findings that are related in some way. This field cannot be updated. Its value is ignored in all update requests. - { # Contains details about groups of which this finding is a member. A group is a collection of findings that are related in some way. - "groupId": "A String", # ID of the group. - "groupType": "A String", # Type of group. + "findingClass": "A String", + "groupMemberships": [ + { + "groupId": "A String", + "groupType": "A String", }, ], - "iamBindings": [ # Represents IAM bindings associated with the finding. - { # Represents a particular IAM binding, which captures a member's role addition, removal, or state. - "action": "A String", # The action that was performed on a Binding. - "member": "A String", # A single identity requesting access for a Cloud Platform resource, for example, "foo@google.com". - "role": "A String", # Role that is assigned to "members". For example, "roles/viewer", "roles/editor", or "roles/owner". + "iamBindings": [ + { + "action": "A String", + "member": "A String", + "role": "A String", }, ], - "indicator": { # Represents what's commonly known as an _indicator of compromise_ (IoC) in computer forensics. This is an artifact observed on a network or in an operating system that, with high confidence, indicates a computer intrusion. For more information, see [Indicator of compromise](https://en.wikipedia.org/wiki/Indicator_of_compromise). # Represents what's commonly known as an *indicator of compromise* (IoC) in computer forensics. This is an artifact observed on a network or in an operating system that, with high confidence, indicates a computer intrusion. For more information, see [Indicator of compromise](https://en.wikipedia.org/wiki/Indicator_of_compromise). - "domains": [ # List of domains associated to the Finding. + "indicator": { + "domains": [ "A String", ], - "ipAddresses": [ # The list of IP addresses that are associated with the finding. + "ipAddresses": [ "A String", ], - "signatures": [ # The list of matched signatures indicating that the given process is present in the environment. - { # Indicates what signature matched this process. - "memoryHashSignature": { # A signature corresponding to memory page hashes. # Signature indicating that a binary family was matched. - "binaryFamily": "A String", # The binary family. - "detections": [ # The list of memory hash detections contributing to the binary family match. - { # Memory hash detection contributing to the binary family match. - "binary": "A String", # The name of the binary associated with the memory hash signature detection. - "percentPagesMatched": 3.14, # The percentage of memory page hashes in the signature that were matched. + "signatures": [ + { + "memoryHashSignature": { + "binaryFamily": "A String", + "detections": [ + { + "binary": "A String", + "percentPagesMatched": 3.14, }, ], }, - "signatureType": "A String", # Describes the type of resource associated with the signature. - "yaraRuleSignature": { # A signature corresponding to a YARA rule. # Signature indicating that a YARA rule was matched. - "yaraRule": "A String", # The name of the YARA rule. + "signatureType": "A String", + "yaraRuleSignature": { + "yaraRule": "A String", }, }, ], - "uris": [ # The list of URIs associated to the Findings. + "uris": [ "A String", ], }, - "ipRules": { # IP rules associated with the finding. # IP rules associated with the finding. - "allowed": { # Allowed IP rule. # Tuple with allowed rules. - "ipRules": [ # Optional. Optional list of allowed IP rules. - { # IP rule information. - "portRanges": [ # Optional. An optional list of ports to which this rule applies. This field is only applicable for the UDP or (S)TCP protocols. Each entry must be either an integer or a range including a min and max port number. - { # A port range which is inclusive of the min and max values. Values are between 0 and 2^16-1. The max can be equal / must be not smaller than the min value. If min and max are equal this indicates that it is a single port. - "max": "A String", # Maximum port value. - "min": "A String", # Minimum port value. + "ipRules": { + "allowed": { + "ipRules": [ + { + "portRanges": [ + { + "max": "A String", + "min": "A String", }, ], - "protocol": "A String", # The IP protocol this rule applies to. This value can either be one of the following well known protocol strings (TCP, UDP, ICMP, ESP, AH, IPIP, SCTP) or a string representation of the integer value. + "protocol": "A String", }, ], }, - "denied": { # Denied IP rule. # Tuple with denied rules. - "ipRules": [ # Optional. Optional list of denied IP rules. - { # IP rule information. - "portRanges": [ # Optional. An optional list of ports to which this rule applies. This field is only applicable for the UDP or (S)TCP protocols. Each entry must be either an integer or a range including a min and max port number. - { # A port range which is inclusive of the min and max values. Values are between 0 and 2^16-1. The max can be equal / must be not smaller than the min value. If min and max are equal this indicates that it is a single port. - "max": "A String", # Maximum port value. - "min": "A String", # Minimum port value. + "denied": { + "ipRules": [ + { + "portRanges": [ + { + "max": "A String", + "min": "A String", }, ], - "protocol": "A String", # The IP protocol this rule applies to. This value can either be one of the following well known protocol strings (TCP, UDP, ICMP, ESP, AH, IPIP, SCTP) or a string representation of the integer value. + "protocol": "A String", }, ], }, - "destinationIpRanges": [ # If destination IP ranges are specified, the firewall rule applies only to traffic that has a destination IP address in these ranges. These ranges must be expressed in CIDR format. Only supports IPv4. + "destinationIpRanges": [ "A String", ], - "direction": "A String", # The direction that the rule is applicable to, one of ingress or egress. - "exposedServices": [ # Name of the network protocol service, such as FTP, that is exposed by the open port. Follows the naming convention available at: https://www.iana.org/assignments/service-names-port-numbers/service-names-port-numbers.xhtml. + "direction": "A String", + "exposedServices": [ "A String", ], - "sourceIpRanges": [ # If source IP ranges are specified, the firewall rule applies only to traffic that has a source IP address in these ranges. These ranges must be expressed in CIDR format. Only supports IPv4. + "sourceIpRanges": [ "A String", ], }, - "job": { # Describes a job # Job associated with the finding. - "errorCode": 42, # Optional. If the job did not complete successfully, this field describes why. - "location": "A String", # Optional. Gives the location where the job ran, such as `US` or `europe-west1` - "name": "A String", # The fully-qualified name for a job. e.g. `projects//jobs/` - "state": "A String", # Output only. State of the job, such as `RUNNING` or `PENDING`. + "job": { + "errorCode": 42, + "location": "A String", + "name": "A String", + "state": "A String", }, - "kernelRootkit": { # Kernel mode rootkit signatures. # Signature of the kernel rootkit. - "name": "A String", # Rootkit name, when available. - "unexpectedCodeModification": True or False, # True if unexpected modifications of kernel code memory are present. - "unexpectedFtraceHandler": True or False, # True if `ftrace` points are present with callbacks pointing to regions that are not in the expected kernel or module code range. - "unexpectedInterruptHandler": True or False, # True if interrupt handlers that are are not in the expected kernel or module code regions are present. - "unexpectedKernelCodePages": True or False, # True if kernel code pages that are not in the expected kernel or module code regions are present. - "unexpectedKprobeHandler": True or False, # True if `kprobe` points are present with callbacks pointing to regions that are not in the expected kernel or module code range. - "unexpectedProcessesInRunqueue": True or False, # True if unexpected processes in the scheduler run queue are present. Such processes are in the run queue, but not in the process task list. - "unexpectedReadOnlyDataModification": True or False, # True if unexpected modifications of kernel read-only data memory are present. - "unexpectedSystemCallHandler": True or False, # True if system call handlers that are are not in the expected kernel or module code regions are present. + "kernelRootkit": { + "name": "A String", + "unexpectedCodeModification": True or False, + "unexpectedFtraceHandler": True or False, + "unexpectedInterruptHandler": True or False, + "unexpectedKernelCodePages": True or False, + "unexpectedKprobeHandler": True or False, + "unexpectedProcessesInRunqueue": True or False, + "unexpectedReadOnlyDataModification": True or False, + "unexpectedSystemCallHandler": True or False, }, - "kubernetes": { # Kubernetes-related attributes. # Kubernetes resources associated with the finding. - "accessReviews": [ # Provides information on any Kubernetes access reviews (privilege checks) relevant to the finding. - { # Conveys information about a Kubernetes access review (such as one returned by a [`kubectl auth can-i`](https://kubernetes.io/docs/reference/access-authn-authz/authorization/#checking-api-access) command) that was involved in a finding. - "group": "A String", # The API group of the resource. "*" means all. - "name": "A String", # The name of the resource being requested. Empty means all. - "ns": "A String", # Namespace of the action being requested. Currently, there is no distinction between no namespace and all namespaces. Both are represented by "" (empty). - "resource": "A String", # The optional resource type requested. "*" means all. - "subresource": "A String", # The optional subresource type. - "verb": "A String", # A Kubernetes resource API verb, like get, list, watch, create, update, delete, proxy. "*" means all. - "version": "A String", # The API version of the resource. "*" means all. + "kubernetes": { + "accessReviews": [ + { + "group": "A String", + "name": "A String", + "ns": "A String", + "resource": "A String", + "subresource": "A String", + "verb": "A String", + "version": "A String", }, ], - "bindings": [ # Provides Kubernetes role binding information for findings that involve [RoleBindings or ClusterRoleBindings](https://cloud.google.com/kubernetes-engine/docs/how-to/role-based-access-control). - { # Represents a Kubernetes RoleBinding or ClusterRoleBinding. - "name": "A String", # Name for the binding. - "ns": "A String", # Namespace for the binding. - "role": { # Kubernetes Role or ClusterRole. # The Role or ClusterRole referenced by the binding. - "kind": "A String", # Role type. - "name": "A String", # Role name. - "ns": "A String", # Role namespace. + "bindings": [ + { + "name": "A String", + "ns": "A String", + "role": { + "kind": "A String", + "name": "A String", + "ns": "A String", }, - "subjects": [ # Represents one or more subjects that are bound to the role. Not always available for PATCH requests. - { # Represents a Kubernetes subject. - "kind": "A String", # Authentication type for the subject. - "name": "A String", # Name for the subject. - "ns": "A String", # Namespace for the subject. + "subjects": [ + { + "kind": "A String", + "name": "A String", + "ns": "A String", }, ], }, ], - "nodePools": [ # GKE [node pools](https://cloud.google.com/kubernetes-engine/docs/concepts/node-pools) associated with the finding. This field contains node pool information for each node, when it is available. - { # Provides GKE node pool information. - "name": "A String", # Kubernetes node pool name. - "nodes": [ # Nodes associated with the finding. - { # Kubernetes nodes associated with the finding. - "name": "A String", # [Full resource name](https://google.aip.dev/122#full-resource-names) of the Compute Engine VM running the cluster node. + "nodePools": [ + { + "name": "A String", + "nodes": [ + { + "name": "A String", }, ], }, ], - "nodes": [ # Provides Kubernetes [node](https://cloud.google.com/kubernetes-engine/docs/concepts/cluster-architecture#nodes) information. - { # Kubernetes nodes associated with the finding. - "name": "A String", # [Full resource name](https://google.aip.dev/122#full-resource-names) of the Compute Engine VM running the cluster node. + "nodes": [ + { + "name": "A String", }, ], - "objects": [ # Kubernetes objects related to the finding. - { # Kubernetes object related to the finding, uniquely identified by GKNN. Used if the object Kind is not one of Pod, Node, NodePool, Binding, or AccessReview. - "containers": [ # Pod containers associated with this finding, if any. - { # Container associated with the finding. - "createTime": "A String", # The time that the container was created. - "imageId": "A String", # Optional container image ID, if provided by the container runtime. Uniquely identifies the container image launched using a container image digest. - "labels": [ # Container labels, as provided by the container runtime. - { # Represents a generic name-value label. A label has separate name and value fields to support filtering with the `contains()` function. For more information, see [Filtering on array-type fields](https://cloud.google.com/security-command-center/docs/how-to-api-list-findings#array-contains-filtering). - "name": "A String", # Name of the label. - "value": "A String", # Value that corresponds to the label's name. + "objects": [ + { + "containers": [ + { + "createTime": "A String", + "imageId": "A String", + "labels": [ + { + "name": "A String", + "value": "A String", }, ], - "name": "A String", # Name of the container. - "uri": "A String", # Container image URI provided when configuring a pod or container. This string can identify a container image version using mutable tags. + "name": "A String", + "uri": "A String", }, ], - "group": "A String", # Kubernetes object group, such as "policy.k8s.io/v1". - "kind": "A String", # Kubernetes object kind, such as "Namespace". - "name": "A String", # Kubernetes object name. For details see https://kubernetes.io/docs/concepts/overview/working-with-objects/names/. - "ns": "A String", # Kubernetes object namespace. Must be a valid DNS label. Named "ns" to avoid collision with C++ namespace keyword. For details see https://kubernetes.io/docs/tasks/administer-cluster/namespaces/. + "group": "A String", + "kind": "A String", + "name": "A String", + "ns": "A String", }, ], - "pods": [ # Kubernetes [Pods](https://cloud.google.com/kubernetes-engine/docs/concepts/pod) associated with the finding. This field contains Pod records for each container that is owned by a Pod. - { # A Kubernetes Pod. - "containers": [ # Pod containers associated with this finding, if any. - { # Container associated with the finding. - "createTime": "A String", # The time that the container was created. - "imageId": "A String", # Optional container image ID, if provided by the container runtime. Uniquely identifies the container image launched using a container image digest. - "labels": [ # Container labels, as provided by the container runtime. - { # Represents a generic name-value label. A label has separate name and value fields to support filtering with the `contains()` function. For more information, see [Filtering on array-type fields](https://cloud.google.com/security-command-center/docs/how-to-api-list-findings#array-contains-filtering). - "name": "A String", # Name of the label. - "value": "A String", # Value that corresponds to the label's name. + "pods": [ + { + "containers": [ + { + "createTime": "A String", + "imageId": "A String", + "labels": [ + { + "name": "A String", + "value": "A String", }, ], - "name": "A String", # Name of the container. - "uri": "A String", # Container image URI provided when configuring a pod or container. This string can identify a container image version using mutable tags. + "name": "A String", + "uri": "A String", }, ], - "labels": [ # Pod labels. For Kubernetes containers, these are applied to the container. - { # Represents a generic name-value label. A label has separate name and value fields to support filtering with the `contains()` function. For more information, see [Filtering on array-type fields](https://cloud.google.com/security-command-center/docs/how-to-api-list-findings#array-contains-filtering). - "name": "A String", # Name of the label. - "value": "A String", # Value that corresponds to the label's name. + "labels": [ + { + "name": "A String", + "value": "A String", }, ], - "name": "A String", # Kubernetes Pod name. - "ns": "A String", # Kubernetes Pod namespace. + "name": "A String", + "ns": "A String", }, ], - "roles": [ # Provides Kubernetes role information for findings that involve [Roles or ClusterRoles](https://cloud.google.com/kubernetes-engine/docs/how-to/role-based-access-control). - { # Kubernetes Role or ClusterRole. - "kind": "A String", # Role type. - "name": "A String", # Role name. - "ns": "A String", # Role namespace. + "roles": [ + { + "kind": "A String", + "name": "A String", + "ns": "A String", }, ], }, - "loadBalancers": [ # The load balancers associated with the finding. - { # Contains information related to the load balancer associated with the finding. - "name": "A String", # The name of the load balancer associated with the finding. + "loadBalancers": [ + { + "name": "A String", }, ], - "logEntries": [ # Log entries that are relevant to the finding. - { # An individual entry in a log. - "cloudLoggingEntry": { # Metadata taken from a [Cloud Logging LogEntry](https://cloud.google.com/logging/docs/reference/v2/rest/v2/LogEntry) # An individual entry in a log stored in Cloud Logging. - "insertId": "A String", # A unique identifier for the log entry. - "logId": "A String", # The type of the log (part of `log_name`. `log_name` is the resource name of the log to which this log entry belongs). For example: `cloudresourcemanager.googleapis.com/activity`. Note that this field is not URL-encoded, unlike the `LOG_ID` field in `LogEntry`. - "resourceContainer": "A String", # The organization, folder, or project of the monitored resource that produced this log entry. - "timestamp": "A String", # The time the event described by the log entry occurred. + "logEntries": [ + { + "cloudLoggingEntry": { + "insertId": "A String", + "logId": "A String", + "resourceContainer": "A String", + "timestamp": "A String", }, }, ], - "mitreAttack": { # MITRE ATT&CK tactics and techniques related to this finding. See: https://attack.mitre.org # MITRE ATT&CK tactics and techniques related to this finding. See: https://attack.mitre.org - "additionalTactics": [ # Additional MITRE ATT&CK tactics related to this finding, if any. + "mitreAttack": { + "additionalTactics": [ "A String", ], - "additionalTechniques": [ # Additional MITRE ATT&CK techniques related to this finding, if any, along with any of their respective parent techniques. + "additionalTechniques": [ "A String", ], - "primaryTactic": "A String", # The MITRE ATT&CK tactic most closely represented by this finding, if any. - "primaryTechniques": [ # The MITRE ATT&CK technique most closely represented by this finding, if any. primary_techniques is a repeated field because there are multiple levels of MITRE ATT&CK techniques. If the technique most closely represented by this finding is a sub-technique (e.g. `SCANNING_IP_BLOCKS`), both the sub-technique and its parent technique(s) will be listed (e.g. `SCANNING_IP_BLOCKS`, `ACTIVE_SCANNING`). + "primaryTactic": "A String", + "primaryTechniques": [ "A String", ], - "version": "A String", # The MITRE ATT&CK version referenced by the above fields. E.g. "8". + "version": "A String", }, - "moduleName": "A String", # Unique identifier of the module which generated the finding. Example: folders/598186756061/securityHealthAnalyticsSettings/customModules/56799441161885 - "mute": "A String", # Indicates the mute state of a finding (either muted, unmuted or undefined). Unlike other attributes of a finding, a finding provider shouldn't set the value of mute. - "muteInfo": { # Mute information about the finding, including whether the finding has a static mute or any matching dynamic mute rules. # Output only. The mute information regarding this finding. - "dynamicMuteRecords": [ # The list of dynamic mute rules that currently match the finding. - { # The record of a dynamic mute rule that matches the finding. - "matchTime": "A String", # When the dynamic mute rule first matched the finding. - "muteConfig": "A String", # The relative resource name of the mute rule, represented by a mute config, that created this record, for example `organizations/123/muteConfigs/mymuteconfig` or `organizations/123/locations/global/muteConfigs/mymuteconfig`. + "moduleName": "A String", + "mute": "A String", + "muteInfo": { + "dynamicMuteRecords": [ + { + "matchTime": "A String", + "muteConfig": "A String", }, ], - "staticMute": { # Information about the static mute state. A static mute state overrides any dynamic mute rules that apply to this finding. The static mute state can be set by a static mute rule or by muting the finding directly. # If set, the static mute applied to this finding. Static mutes override dynamic mutes. If unset, there is no static mute. - "applyTime": "A String", # When the static mute was applied. - "state": "A String", # The static mute state. If the value is `MUTED` or `UNMUTED`, then the finding's overall mute state will have the same value. + "staticMute": { + "applyTime": "A String", + "state": "A String", }, }, - "muteInitiator": "A String", # Records additional information about the mute operation, for example, the [mute configuration](/security-command-center/docs/how-to-mute-findings) that muted the finding and the user who muted the finding. - "muteUpdateTime": "A String", # Output only. The most recent time this finding was muted or unmuted. - "name": "A String", # The [relative resource name](https://cloud.google.com/apis/design/resource_names#relative_resource_name) of the finding. Example: "organizations/{organization_id}/sources/{source_id}/findings/{finding_id}", "folders/{folder_id}/sources/{source_id}/findings/{finding_id}", "projects/{project_id}/sources/{source_id}/findings/{finding_id}". - "networks": [ # Represents the VPC networks that the resource is attached to. - { # Contains information about a VPC network associated with the finding. - "name": "A String", # The name of the VPC network resource, for example, `//compute.googleapis.com/projects/my-project/global/networks/my-network`. + "muteInitiator": "A String", + "muteUpdateTime": "A String", + "name": "A String", + "networks": [ + { + "name": "A String", }, ], - "nextSteps": "A String", # Steps to address the finding. - "notebook": { # Represents a Jupyter notebook IPYNB file, such as a [Colab Enterprise notebook](https://cloud.google.com/colab/docs/introduction) file, that is associated with a finding. # Notebook associated with the finding. - "lastAuthor": "A String", # The user ID of the latest author to modify the notebook. - "name": "A String", # The name of the notebook. - "notebookUpdateTime": "A String", # The most recent time the notebook was updated. - "service": "A String", # The source notebook service, for example, "Colab Enterprise". + "nextSteps": "A String", + "notebook": { + "lastAuthor": "A String", + "name": "A String", + "notebookUpdateTime": "A String", + "service": "A String", }, - "orgPolicies": [ # Contains information about the org policies associated with the finding. - { # Contains information about the org policies associated with the finding. - "name": "A String", # The resource name of the org policy. Example: "organizations/{organization_id}/policies/{constraint_name}" + "orgPolicies": [ + { + "name": "A String", }, ], - "parent": "A String", # The relative resource name of the source the finding belongs to. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name This field is immutable after creation time. For example: "organizations/{organization_id}/sources/{source_id}" - "parentDisplayName": "A String", # Output only. The human readable display name of the finding source such as "Event Threat Detection" or "Security Health Analytics". - "policyViolationSummary": { # Metadata summarizing policy violations of child resources of the affected resource. `finding_category` and `resource` determine the exact semantics of the counts. For example, when category=DATA_SECURITY_POSTURE_OBJECT_PUBLIC_ACCESS_VIOLATION and resource='storage.googleapis.com/buckets/my-bucket-name' then this counts the number of Cloud Storage objects in my-bucket-name which violate a Public Access control. # PolicyViolationSummary associated with the finding. - "conformantResourcesCount": "A String", # Total number of child resources that conform to the policy. - "evaluationErrorsCount": "A String", # Number of child resources for which errors during evaluation occurred. The evaluation result for these child resources is effectively "unknown". - "outOfScopeResourcesCount": "A String", # Total count of child resources which were not in scope for evaluation. - "policyViolationsCount": "A String", # Count of child resources in violation of the policy. + "parent": "A String", + "parentDisplayName": "A String", + "policyViolationSummary": { + "conformantResourcesCount": "A String", + "evaluationErrorsCount": "A String", + "outOfScopeResourcesCount": "A String", + "policyViolationsCount": "A String", }, - "processes": [ # Represents operating system processes associated with the Finding. - { # Represents an operating system process. - "args": [ # Process arguments as JSON encoded strings. + "processes": [ + { + "args": [ "A String", ], - "argumentsTruncated": True or False, # True if `args` is incomplete. - "binary": { # File information about the related binary/library used by an executable, or the script used by a script interpreter # File information for the process executable. - "contents": "A String", # Prefix of the file contents as a JSON-encoded string. - "diskPath": { # Path of the file in terms of underlying disk/partition identifiers. # Path of the file in terms of underlying disk/partition identifiers. - "partitionUuid": "A String", # UUID of the partition (format https://wiki.archlinux.org/title/persistent_block_device_naming#by-uuid) - "relativePath": "A String", # Relative path of the file in the partition as a JSON encoded string. Example: /home/user1/executable_file.sh + "argumentsTruncated": True or False, + "binary": { + "contents": "A String", + "diskPath": { + "partitionUuid": "A String", + "relativePath": "A String", }, - "fileLoadState": "A String", # The load state of the file. - "hashedSize": "A String", # The length in bytes of the file prefix that was hashed. If hashed_size == size, any hashes reported represent the entire file. - "operations": [ # Operation(s) performed on a file. - { # Operation(s) performed on a file. - "type": "A String", # The type of the operation + "fileLoadState": "A String", + "hashedSize": "A String", + "operations": [ + { + "type": "A String", }, ], - "partiallyHashed": True or False, # True when the hash covers only a prefix of the file. - "path": "A String", # Absolute path of the file as a JSON encoded string. - "sha256": "A String", # SHA256 hash of the first hashed_size bytes of the file encoded as a hex string. If hashed_size == size, sha256 represents the SHA256 hash of the entire file. - "size": "A String", # Size of the file in bytes. + "partiallyHashed": True or False, + "path": "A String", + "sha256": "A String", + "size": "A String", }, - "envVariables": [ # Process environment variables. - { # A name-value pair representing an environment variable used in an operating system process. - "name": "A String", # Environment variable name as a JSON encoded string. - "val": "A String", # Environment variable value as a JSON encoded string. + "envVariables": [ + { + "name": "A String", + "val": "A String", }, ], - "envVariablesTruncated": True or False, # True if `env_variables` is incomplete. - "libraries": [ # File information for libraries loaded by the process. - { # File information about the related binary/library used by an executable, or the script used by a script interpreter - "contents": "A String", # Prefix of the file contents as a JSON-encoded string. - "diskPath": { # Path of the file in terms of underlying disk/partition identifiers. # Path of the file in terms of underlying disk/partition identifiers. - "partitionUuid": "A String", # UUID of the partition (format https://wiki.archlinux.org/title/persistent_block_device_naming#by-uuid) - "relativePath": "A String", # Relative path of the file in the partition as a JSON encoded string. Example: /home/user1/executable_file.sh + "envVariablesTruncated": True or False, + "libraries": [ + { + "contents": "A String", + "diskPath": { + "partitionUuid": "A String", + "relativePath": "A String", }, - "fileLoadState": "A String", # The load state of the file. - "hashedSize": "A String", # The length in bytes of the file prefix that was hashed. If hashed_size == size, any hashes reported represent the entire file. - "operations": [ # Operation(s) performed on a file. - { # Operation(s) performed on a file. - "type": "A String", # The type of the operation + "fileLoadState": "A String", + "hashedSize": "A String", + "operations": [ + { + "type": "A String", }, ], - "partiallyHashed": True or False, # True when the hash covers only a prefix of the file. - "path": "A String", # Absolute path of the file as a JSON encoded string. - "sha256": "A String", # SHA256 hash of the first hashed_size bytes of the file encoded as a hex string. If hashed_size == size, sha256 represents the SHA256 hash of the entire file. - "size": "A String", # Size of the file in bytes. + "partiallyHashed": True or False, + "path": "A String", + "sha256": "A String", + "size": "A String", }, ], - "name": "A String", # The process name, as displayed in utilities like `top` and `ps`. This name can be accessed through `/proc/[pid]/comm` and changed with `prctl(PR_SET_NAME)`. - "parentPid": "A String", # The parent process ID. - "pid": "A String", # The process ID. - "script": { # File information about the related binary/library used by an executable, or the script used by a script interpreter # When the process represents the invocation of a script, `binary` provides information about the interpreter, while `script` provides information about the script file provided to the interpreter. - "contents": "A String", # Prefix of the file contents as a JSON-encoded string. - "diskPath": { # Path of the file in terms of underlying disk/partition identifiers. # Path of the file in terms of underlying disk/partition identifiers. - "partitionUuid": "A String", # UUID of the partition (format https://wiki.archlinux.org/title/persistent_block_device_naming#by-uuid) - "relativePath": "A String", # Relative path of the file in the partition as a JSON encoded string. Example: /home/user1/executable_file.sh + "name": "A String", + "parentPid": "A String", + "pid": "A String", + "script": { + "contents": "A String", + "diskPath": { + "partitionUuid": "A String", + "relativePath": "A String", }, - "fileLoadState": "A String", # The load state of the file. - "hashedSize": "A String", # The length in bytes of the file prefix that was hashed. If hashed_size == size, any hashes reported represent the entire file. - "operations": [ # Operation(s) performed on a file. - { # Operation(s) performed on a file. - "type": "A String", # The type of the operation + "fileLoadState": "A String", + "hashedSize": "A String", + "operations": [ + { + "type": "A String", }, ], - "partiallyHashed": True or False, # True when the hash covers only a prefix of the file. - "path": "A String", # Absolute path of the file as a JSON encoded string. - "sha256": "A String", # SHA256 hash of the first hashed_size bytes of the file encoded as a hex string. If hashed_size == size, sha256 represents the SHA256 hash of the entire file. - "size": "A String", # Size of the file in bytes. + "partiallyHashed": True or False, + "path": "A String", + "sha256": "A String", + "size": "A String", }, - "userId": "A String", # The ID of the user that executed the process. E.g. If this is the root user this will always be 0. + "userId": "A String", }, ], - "resourceName": "A String", # For findings on Google Cloud resources, the full resource name of the Google Cloud resource this finding is for. See: https://cloud.google.com/apis/design/resource_names#full_resource_name When the finding is for a non-Google Cloud resource, the resourceName can be a customer or partner defined string. This field is immutable after creation time. - "secret": { # Details about a secret or credential associated with the finding. # Secret associated with the finding. - "environmentVariable": { # Environment variable containing the secret. # The environment variable containing the secret. - "key": "A String", # Environment variable name as a JSON encoded string. Note that value is not included since the value contains the secret data, which is sensitive core content. + "resourceName": "A String", + "secret": { + "environmentVariable": { + "key": "A String", }, - "filePath": { # File path containing the secret. # The file containing the secret. - "path": "A String", # Path to the file. + "filePath": { + "path": "A String", }, - "status": { # The status of the secret. # The status of the secret. - "lastUpdatedTime": "A String", # Time that the secret was found. - "validity": "A String", # The validity of the secret. + "status": { + "lastUpdatedTime": "A String", + "validity": "A String", }, - "type": "A String", # The type of secret, for example, GCP_API_KEY. + "type": "A String", }, - "securityMarks": { # User specified security marks that are attached to the parent Security Command Center resource. Security marks are scoped within a Security Command Center organization -- they can be modified and viewed by all users who have proper permissions on the organization. # Output only. User specified security marks. These marks are entirely managed by the user and come from the SecurityMarks resource that belongs to the finding. - "canonicalName": "A String", # The canonical name of the marks. Examples: "organizations/{organization_id}/assets/{asset_id}/securityMarks" "folders/{folder_id}/assets/{asset_id}/securityMarks" "projects/{project_number}/assets/{asset_id}/securityMarks" "organizations/{organization_id}/sources/{source_id}/findings/{finding_id}/securityMarks" "folders/{folder_id}/sources/{source_id}/findings/{finding_id}/securityMarks" "projects/{project_number}/sources/{source_id}/findings/{finding_id}/securityMarks" - "marks": { # Mutable user specified security marks belonging to the parent resource. Constraints are as follows: * Keys and values are treated as case insensitive * Keys must be between 1 - 256 characters (inclusive) * Keys must be letters, numbers, underscores, or dashes * Values have leading and trailing whitespace trimmed, remaining characters must be between 1 - 4096 characters (inclusive) + "securityMarks": { + "canonicalName": "A String", + "marks": { "a_key": "A String", }, - "name": "A String", # The relative resource name of the SecurityMarks. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Examples: "organizations/{organization_id}/assets/{asset_id}/securityMarks" "organizations/{organization_id}/sources/{source_id}/findings/{finding_id}/securityMarks". + "name": "A String", }, - "securityPosture": { # Represents a posture that is deployed on Google Cloud by the Security Command Center Posture Management service. A posture contains one or more policy sets. A policy set is a group of policies that enforce a set of security rules on Google Cloud. # The security posture associated with the finding. - "changedPolicy": "A String", # The name of the updated policy, for example, `projects/{project_id}/policies/{constraint_name}`. - "name": "A String", # Name of the posture, for example, `CIS-Posture`. - "policy": "A String", # The ID of the updated policy, for example, `compute-policy-1`. - "policyDriftDetails": [ # The details about a change in an updated policy that violates the deployed posture. - { # The policy field that violates the deployed posture and its expected and detected values. - "detectedValue": "A String", # The detected value that violates the deployed posture, for example, `false` or `allowed_values={"projects/22831892"}`. - "expectedValue": "A String", # The value of this field that was configured in a posture, for example, `true` or `allowed_values={"projects/29831892"}`. - "field": "A String", # The name of the updated field, for example constraint.implementation.policy_rules[0].enforce + "securityPosture": { + "changedPolicy": "A String", + "name": "A String", + "policy": "A String", + "policyDriftDetails": [ + { + "detectedValue": "A String", + "expectedValue": "A String", + "field": "A String", }, ], - "policySet": "A String", # The name of the updated policyset, for example, `cis-policyset`. - "postureDeployment": "A String", # The name of the posture deployment, for example, `organizations/{org_id}/posturedeployments/{posture_deployment_id}`. - "postureDeploymentResource": "A String", # The project, folder, or organization on which the posture is deployed, for example, `projects/{project_number}`. - "revisionId": "A String", # The version of the posture, for example, `c7cfa2a8`. + "policySet": "A String", + "postureDeployment": "A String", + "postureDeploymentResource": "A String", + "revisionId": "A String", }, - "severity": "A String", # The severity of the finding. This field is managed by the source that writes the finding. - "sourceProperties": { # Source specific properties. These properties are managed by the source that writes the finding. The key names in the source_properties map must be between 1 and 255 characters, and must start with a letter and contain alphanumeric characters or underscores only. + "severity": "A String", + "sourceProperties": { "a_key": "", }, - "state": "A String", # The state of the finding. - "toxicCombination": { # Contains details about a group of security issues that, when the issues occur together, represent a greater risk than when the issues occur independently. A group of such issues is referred to as a toxic combination. # Contains details about a group of security issues that, when the issues occur together, represent a greater risk than when the issues occur independently. A group of such issues is referred to as a toxic combination. This field cannot be updated. Its value is ignored in all update requests. - "attackExposureScore": 3.14, # The [Attack exposure score](https://cloud.google.com/security-command-center/docs/attack-exposure-learn#attack_exposure_scores) of this toxic combination. The score is a measure of how much this toxic combination exposes one or more high-value resources to potential attack. - "relatedFindings": [ # List of resource names of findings associated with this toxic combination. For example, `organizations/123/sources/456/findings/789`. + "state": "A String", + "toxicCombination": { + "attackExposureScore": 3.14, + "relatedFindings": [ "A String", ], }, - "vertexAi": { # Vertex AI-related information associated with the finding. # VertexAi associated with the finding. - "datasets": [ # Datasets associated with the finding. - { # Vertex AI dataset associated with the finding. - "displayName": "A String", # The user defined display name of dataset, e.g. plants-dataset - "name": "A String", # Resource name of the dataset, e.g. projects/{project}/locations/{location}/datasets/2094040236064505856 - "source": "A String", # Data source, such as BigQuery source URI, e.g. bq://scc-nexus-test.AIPPtest.gsod + "vertexAi": { + "datasets": [ + { + "displayName": "A String", + "name": "A String", + "source": "A String", }, ], - "pipelines": [ # Pipelines associated with the finding. - { # Vertex AI training pipeline associated with the finding. - "displayName": "A String", # The user defined display name of pipeline, e.g. plants-classification - "name": "A String", # Resource name of the pipeline, e.g. projects/{project}/locations/{location}/trainingPipelines/5253428229225578496 + "pipelines": [ + { + "displayName": "A String", + "name": "A String", }, ], }, - "vulnerability": { # Refers to common vulnerability fields e.g. cve, cvss, cwe etc. # Represents vulnerability-specific fields like CVE and CVSS scores. CVE stands for Common Vulnerabilities and Exposures (https://cve.mitre.org/about/) - "cve": { # CVE stands for Common Vulnerabilities and Exposures. Information from the [CVE record](https://www.cve.org/ResourcesSupport/Glossary) that describes this vulnerability. # CVE stands for Common Vulnerabilities and Exposures (https://cve.mitre.org/about/) - "cvssv3": { # Common Vulnerability Scoring System version 3. # Describe Common Vulnerability Scoring System specified at https://www.first.org/cvss/v3.1/specification-document - "attackComplexity": "A String", # This metric describes the conditions beyond the attacker's control that must exist in order to exploit the vulnerability. - "attackVector": "A String", # Base Metrics Represents the intrinsic characteristics of a vulnerability that are constant over time and across user environments. This metric reflects the context by which vulnerability exploitation is possible. - "availabilityImpact": "A String", # This metric measures the impact to the availability of the impacted component resulting from a successfully exploited vulnerability. - "baseScore": 3.14, # The base score is a function of the base metric scores. - "confidentialityImpact": "A String", # This metric measures the impact to the confidentiality of the information resources managed by a software component due to a successfully exploited vulnerability. - "integrityImpact": "A String", # This metric measures the impact to integrity of a successfully exploited vulnerability. - "privilegesRequired": "A String", # This metric describes the level of privileges an attacker must possess before successfully exploiting the vulnerability. - "scope": "A String", # The Scope metric captures whether a vulnerability in one vulnerable component impacts resources in components beyond its security scope. - "userInteraction": "A String", # This metric captures the requirement for a human user, other than the attacker, to participate in the successful compromise of the vulnerable component. + "vulnerability": { + "cve": { + "cvssv3": { + "attackComplexity": "A String", + "attackVector": "A String", + "availabilityImpact": "A String", + "baseScore": 3.14, + "confidentialityImpact": "A String", + "integrityImpact": "A String", + "privilegesRequired": "A String", + "scope": "A String", + "userInteraction": "A String", }, - "exploitReleaseDate": "A String", # Date the first publicly available exploit or PoC was released. - "exploitationActivity": "A String", # The exploitation activity of the vulnerability in the wild. - "firstExploitationDate": "A String", # Date of the earliest known exploitation. - "id": "A String", # The unique identifier for the vulnerability. e.g. CVE-2021-34527 - "impact": "A String", # The potential impact of the vulnerability if it was to be exploited. - "observedInTheWild": True or False, # Whether or not the vulnerability has been observed in the wild. - "references": [ # Additional information about the CVE. e.g. https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2021-34527 - { # Additional Links - "source": "A String", # Source of the reference e.g. NVD - "uri": "A String", # Uri for the mentioned source e.g. https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2021-34527. + "exploitReleaseDate": "A String", + "exploitationActivity": "A String", + "firstExploitationDate": "A String", + "id": "A String", + "impact": "A String", + "observedInTheWild": True or False, + "references": [ + { + "source": "A String", + "uri": "A String", }, ], - "upstreamFixAvailable": True or False, # Whether upstream fix is available for the CVE. - "zeroDay": True or False, # Whether or not the vulnerability was zero day when the finding was published. + "upstreamFixAvailable": True or False, + "zeroDay": True or False, }, - "cwes": [ # Represents one or more Common Weakness Enumeration (CWE) information on this vulnerability. - { # CWE stands for Common Weakness Enumeration. Information about this weakness, as described by [CWE](https://cwe.mitre.org/). - "id": "A String", # The CWE identifier, e.g. CWE-94 - "references": [ # Any reference to the details on the CWE, for example, https://cwe.mitre.org/data/definitions/94.html - { # Additional Links - "source": "A String", # Source of the reference e.g. NVD - "uri": "A String", # Uri for the mentioned source e.g. https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2021-34527. + "cwes": [ + { + "id": "A String", + "references": [ + { + "source": "A String", + "uri": "A String", }, ], }, ], - "fixedPackage": { # Package is a generic definition of a package. # The fixed package is relevant to the finding. - "cpeUri": "A String", # The CPE URI where the vulnerability was detected. - "packageName": "A String", # The name of the package where the vulnerability was detected. - "packageType": "A String", # Type of package, for example, os, maven, or go. - "packageVersion": "A String", # The version of the package. + "fixedPackage": { + "cpeUri": "A String", + "packageName": "A String", + "packageType": "A String", + "packageVersion": "A String", }, - "offendingPackage": { # Package is a generic definition of a package. # The offending package is relevant to the finding. - "cpeUri": "A String", # The CPE URI where the vulnerability was detected. - "packageName": "A String", # The name of the package where the vulnerability was detected. - "packageType": "A String", # Type of package, for example, os, maven, or go. - "packageVersion": "A String", # The version of the package. + "offendingPackage": { + "cpeUri": "A String", + "packageName": "A String", + "packageType": "A String", + "packageVersion": "A String", }, - "providerRiskScore": "A String", # Provider provided risk_score based on multiple factors. The higher the risk score, the more risky the vulnerability is. - "reachable": True or False, # Represents whether the vulnerability is reachable (detected via static analysis) - "securityBulletin": { # SecurityBulletin are notifications of vulnerabilities of Google products. # The security bulletin is relevant to this finding. - "bulletinId": "A String", # ID of the bulletin corresponding to the vulnerability. - "submissionTime": "A String", # Submission time of this Security Bulletin. - "suggestedUpgradeVersion": "A String", # This represents a version that the cluster receiving this notification should be upgraded to, based on its current version. For example, 1.15.0 + "providerRiskScore": "A String", + "reachable": True or False, + "securityBulletin": { + "bulletinId": "A String", + "submissionTime": "A String", + "suggestedUpgradeVersion": "A String", }, }, }, - "noViolation": { # 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); } # Indicates that the test case does not trigger any violation. + "noViolation": { }, }, }
diff --git a/docs/dyn/securitycenter_v1.projects.securityHealthAnalyticsSettings.effectiveCustomModules.html b/docs/dyn/securitycenter_v1.projects.securityHealthAnalyticsSettings.effectiveCustomModules.html index aaf2056402..ffe572b621 100644 --- a/docs/dyn/securitycenter_v1.projects.securityHealthAnalyticsSettings.effectiveCustomModules.html +++ b/docs/dyn/securitycenter_v1.projects.securityHealthAnalyticsSettings.effectiveCustomModules.html @@ -79,10 +79,10 @@

Instance Methods

Close httplib2 connections.

get(name, x__xgafv=None)

-

Retrieves an EffectiveSecurityHealthAnalyticsCustomModule.

+

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

-

Returns a list of all EffectiveSecurityHealthAnalyticsCustomModules for the given parent. This includes resident modules defined at the scope of the parent, and inherited modules, inherited from CRM ancestors.

+

list_next()

Retrieves the next page of results.

@@ -94,10 +94,10 @@

Method Details

get(name, x__xgafv=None) -
Retrieves an EffectiveSecurityHealthAnalyticsCustomModule.
+  
 
 Args:
-  name: string, Required. Name of the effective custom module to get. Its format is `organizations/{organization}/securityHealthAnalyticsSettings/effectiveCustomModules/{customModule}`, `folders/{folder}/securityHealthAnalyticsSettings/effectiveCustomModules/{customModule}`, or `projects/{project}/securityHealthAnalyticsSettings/effectiveCustomModules/{customModule}` (required)
+  name: string, A parameter (required)
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -106,51 +106,51 @@ 

Method Details

Returns: An object of the form: - { # An EffectiveSecurityHealthAnalyticsCustomModule is the representation of a Security Health Analytics custom module at a specified level of the resource hierarchy: organization, folder, or project. If a custom module is inherited from a parent organization or folder, the value of the `enablementState` property in EffectiveSecurityHealthAnalyticsCustomModule is set to the value that is effective in the parent, instead of `INHERITED`. For example, if the module is enabled in a parent organization or folder, the effective enablement_state for the module in all child folders or projects is also `enabled`. EffectiveSecurityHealthAnalyticsCustomModule is read-only. - "cloudProvider": "A String", # The cloud provider of the custom module. - "customConfig": { # Defines the properties in a custom module configuration for Security Health Analytics. Use the custom module configuration to create custom detectors that generate custom findings for resources that you specify. # Output only. The user-specified configuration for the module. - "customOutput": { # A set of optional name-value pairs that define custom source properties to return with each finding that is generated by the custom module. The custom source properties that are defined here are included in the finding JSON under `sourceProperties`. # Custom output properties. - "properties": [ # A list of custom output properties to add to the finding. - { # An individual name-value pair that defines a custom source property. - "name": "A String", # Name of the property for the custom output. - "valueExpression": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The CEL expression for the custom output. A resource property can be specified to return the value of the property or a text string enclosed in quotation marks. - "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. - "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. - "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file. - "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. + { + "cloudProvider": "A String", + "customConfig": { + "customOutput": { + "properties": [ + { + "name": "A String", + "valueExpression": { + "description": "A String", + "expression": "A String", + "location": "A String", + "title": "A String", }, }, ], }, - "description": "A String", # Text that describes the vulnerability or misconfiguration that the custom module detects. This explanation is returned with each finding instance to help investigators understand the detected issue. The text must be enclosed in quotation marks. - "predicate": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The CEL expression to evaluate to produce findings. When the expression evaluates to true against a resource, a finding is generated. - "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. - "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. - "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file. - "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. + "description": "A String", + "predicate": { + "description": "A String", + "expression": "A String", + "location": "A String", + "title": "A String", }, - "recommendation": "A String", # An explanation of the recommended steps that security teams can take to resolve the detected issue. This explanation is returned with each finding generated by this module in the `nextSteps` property of the finding JSON. - "resourceSelector": { # Resource for selecting resource type. # The resource types that the custom module operates on. Each custom module can specify up to 5 resource types. - "resourceTypes": [ # The resource types to run the detector on. + "recommendation": "A String", + "resourceSelector": { + "resourceTypes": [ "A String", ], }, - "severity": "A String", # The severity to assign to findings generated by the module. + "severity": "A String", }, - "displayName": "A String", # Output only. The display name for the custom module. The name must be between 1 and 128 characters, start with a lowercase letter, and contain alphanumeric characters or underscores only. - "enablementState": "A String", # Output only. The effective state of enablement for the module at the given level of the hierarchy. - "name": "A String", # Output only. The resource name of the custom module. Its format is "organizations/{organization}/securityHealthAnalyticsSettings/effectiveCustomModules/{customModule}", or "folders/{folder}/securityHealthAnalyticsSettings/effectiveCustomModules/{customModule}", or "projects/{project}/securityHealthAnalyticsSettings/effectiveCustomModules/{customModule}" + "displayName": "A String", + "enablementState": "A String", + "name": "A String", }
list(parent, pageSize=None, pageToken=None, x__xgafv=None) -
Returns a list of all EffectiveSecurityHealthAnalyticsCustomModules for the given parent. This includes resident modules defined at the scope of the parent, and inherited modules, inherited from CRM ancestors.
+  
 
 Args:
-  parent: string, Required. Name of parent to list effective custom modules. Its format is `organizations/{organization}/securityHealthAnalyticsSettings`, `folders/{folder}/securityHealthAnalyticsSettings`, or `projects/{project}/securityHealthAnalyticsSettings` (required)
-  pageSize: integer, The maximum number of results to return in a single response. Default is 10, minimum is 1, maximum is 1000.
-  pageToken: string, The value returned by the last call indicating a continuation
+  parent: string, A parameter (required)
+  pageSize: integer, A parameter
+  pageToken: string, A parameter
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -159,45 +159,45 @@ 

Method Details

Returns: An object of the form: - { # Response message for listing effective Security Health Analytics custom modules. - "effectiveSecurityHealthAnalyticsCustomModules": [ # Effective custom modules belonging to the requested parent. - { # An EffectiveSecurityHealthAnalyticsCustomModule is the representation of a Security Health Analytics custom module at a specified level of the resource hierarchy: organization, folder, or project. If a custom module is inherited from a parent organization or folder, the value of the `enablementState` property in EffectiveSecurityHealthAnalyticsCustomModule is set to the value that is effective in the parent, instead of `INHERITED`. For example, if the module is enabled in a parent organization or folder, the effective enablement_state for the module in all child folders or projects is also `enabled`. EffectiveSecurityHealthAnalyticsCustomModule is read-only. - "cloudProvider": "A String", # The cloud provider of the custom module. - "customConfig": { # Defines the properties in a custom module configuration for Security Health Analytics. Use the custom module configuration to create custom detectors that generate custom findings for resources that you specify. # Output only. The user-specified configuration for the module. - "customOutput": { # A set of optional name-value pairs that define custom source properties to return with each finding that is generated by the custom module. The custom source properties that are defined here are included in the finding JSON under `sourceProperties`. # Custom output properties. - "properties": [ # A list of custom output properties to add to the finding. - { # An individual name-value pair that defines a custom source property. - "name": "A String", # Name of the property for the custom output. - "valueExpression": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The CEL expression for the custom output. A resource property can be specified to return the value of the property or a text string enclosed in quotation marks. - "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. - "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. - "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file. - "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. + { + "effectiveSecurityHealthAnalyticsCustomModules": [ + { + "cloudProvider": "A String", + "customConfig": { + "customOutput": { + "properties": [ + { + "name": "A String", + "valueExpression": { + "description": "A String", + "expression": "A String", + "location": "A String", + "title": "A String", }, }, ], }, - "description": "A String", # Text that describes the vulnerability or misconfiguration that the custom module detects. This explanation is returned with each finding instance to help investigators understand the detected issue. The text must be enclosed in quotation marks. - "predicate": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The CEL expression to evaluate to produce findings. When the expression evaluates to true against a resource, a finding is generated. - "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. - "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. - "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file. - "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. + "description": "A String", + "predicate": { + "description": "A String", + "expression": "A String", + "location": "A String", + "title": "A String", }, - "recommendation": "A String", # An explanation of the recommended steps that security teams can take to resolve the detected issue. This explanation is returned with each finding generated by this module in the `nextSteps` property of the finding JSON. - "resourceSelector": { # Resource for selecting resource type. # The resource types that the custom module operates on. Each custom module can specify up to 5 resource types. - "resourceTypes": [ # The resource types to run the detector on. + "recommendation": "A String", + "resourceSelector": { + "resourceTypes": [ "A String", ], }, - "severity": "A String", # The severity to assign to findings generated by the module. + "severity": "A String", }, - "displayName": "A String", # Output only. The display name for the custom module. The name must be between 1 and 128 characters, start with a lowercase letter, and contain alphanumeric characters or underscores only. - "enablementState": "A String", # Output only. The effective state of enablement for the module at the given level of the hierarchy. - "name": "A String", # Output only. The resource name of the custom module. Its format is "organizations/{organization}/securityHealthAnalyticsSettings/effectiveCustomModules/{customModule}", or "folders/{folder}/securityHealthAnalyticsSettings/effectiveCustomModules/{customModule}", or "projects/{project}/securityHealthAnalyticsSettings/effectiveCustomModules/{customModule}" + "displayName": "A String", + "enablementState": "A String", + "name": "A String", }, ], - "nextPageToken": "A String", # If not empty, indicates that there may be more effective custom modules to be returned. + "nextPageToken": "A String", }
diff --git a/docs/dyn/securitycenter_v1.projects.sources.findings.externalSystems.html b/docs/dyn/securitycenter_v1.projects.sources.findings.externalSystems.html index a6c94b819e..288014ef83 100644 --- a/docs/dyn/securitycenter_v1.projects.sources.findings.externalSystems.html +++ b/docs/dyn/securitycenter_v1.projects.sources.findings.externalSystems.html @@ -79,7 +79,7 @@

Instance Methods

Close httplib2 connections.

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

-

Updates external system. This is for a given finding.

+

Method Details

close() @@ -88,37 +88,37 @@

Method Details

patch(name, body=None, updateMask=None, x__xgafv=None) -
Updates external system. This is for a given finding.
+  
 
 Args:
-  name: string, Full resource name of the external system, for example: "organizations/1234/sources/5678/findings/123456/externalSystems/jira", "folders/1234/sources/5678/findings/123456/externalSystems/jira", "projects/1234/sources/5678/findings/123456/externalSystems/jira" (required)
+  name: string, A parameter (required)
   body: object, The request body.
     The object takes the form of:
 
-{ # Representation of third party SIEM/SOAR fields within SCC.
-  "assignees": [ # References primary/secondary etc assignees in the external system.
+{
+  "assignees": [
     "A String",
   ],
-  "caseCloseTime": "A String", # The time when the case was closed, as reported by the external system.
-  "caseCreateTime": "A String", # The time when the case was created, as reported by the external system.
-  "casePriority": "A String", # The priority of the finding's corresponding case in the external system.
-  "caseSla": "A String", # The SLA of the finding's corresponding case in the external system.
-  "caseUri": "A String", # The link to the finding's corresponding case in the external system.
-  "externalSystemUpdateTime": "A String", # The time when the case was last updated, as reported by the external system.
-  "externalUid": "A String", # The identifier that's used to track the finding's corresponding case in the external system.
-  "name": "A String", # Full resource name of the external system, for example: "organizations/1234/sources/5678/findings/123456/externalSystems/jira", "folders/1234/sources/5678/findings/123456/externalSystems/jira", "projects/1234/sources/5678/findings/123456/externalSystems/jira"
-  "status": "A String", # The most recent status of the finding's corresponding case, as reported by the external system.
-  "ticketInfo": { # Information about the ticket, if any, that is being used to track the resolution of the issue that is identified by this finding. # Information about the ticket, if any, that is being used to track the resolution of the issue that is identified by this finding.
-    "assignee": "A String", # The assignee of the ticket in the ticket system.
-    "description": "A String", # The description of the ticket in the ticket system.
-    "id": "A String", # The identifier of the ticket in the ticket system.
-    "status": "A String", # The latest status of the ticket, as reported by the ticket system.
-    "updateTime": "A String", # The time when the ticket was last updated, as reported by the ticket system.
-    "uri": "A String", # The link to the ticket in the ticket system.
+  "caseCloseTime": "A String",
+  "caseCreateTime": "A String",
+  "casePriority": "A String",
+  "caseSla": "A String",
+  "caseUri": "A String",
+  "externalSystemUpdateTime": "A String",
+  "externalUid": "A String",
+  "name": "A String",
+  "status": "A String",
+  "ticketInfo": {
+    "assignee": "A String",
+    "description": "A String",
+    "id": "A String",
+    "status": "A String",
+    "updateTime": "A String",
+    "uri": "A String",
   },
 }
 
-  updateMask: string, The FieldMask to use when updating the external system resource. If empty all mutable fields will be updated.
+  updateMask: string, A parameter
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -127,26 +127,26 @@ 

Method Details

Returns: An object of the form: - { # Representation of third party SIEM/SOAR fields within SCC. - "assignees": [ # References primary/secondary etc assignees in the external system. + { + "assignees": [ "A String", ], - "caseCloseTime": "A String", # The time when the case was closed, as reported by the external system. - "caseCreateTime": "A String", # The time when the case was created, as reported by the external system. - "casePriority": "A String", # The priority of the finding's corresponding case in the external system. - "caseSla": "A String", # The SLA of the finding's corresponding case in the external system. - "caseUri": "A String", # The link to the finding's corresponding case in the external system. - "externalSystemUpdateTime": "A String", # The time when the case was last updated, as reported by the external system. - "externalUid": "A String", # The identifier that's used to track the finding's corresponding case in the external system. - "name": "A String", # Full resource name of the external system, for example: "organizations/1234/sources/5678/findings/123456/externalSystems/jira", "folders/1234/sources/5678/findings/123456/externalSystems/jira", "projects/1234/sources/5678/findings/123456/externalSystems/jira" - "status": "A String", # The most recent status of the finding's corresponding case, as reported by the external system. - "ticketInfo": { # Information about the ticket, if any, that is being used to track the resolution of the issue that is identified by this finding. # Information about the ticket, if any, that is being used to track the resolution of the issue that is identified by this finding. - "assignee": "A String", # The assignee of the ticket in the ticket system. - "description": "A String", # The description of the ticket in the ticket system. - "id": "A String", # The identifier of the ticket in the ticket system. - "status": "A String", # The latest status of the ticket, as reported by the ticket system. - "updateTime": "A String", # The time when the ticket was last updated, as reported by the ticket system. - "uri": "A String", # The link to the ticket in the ticket system. + "caseCloseTime": "A String", + "caseCreateTime": "A String", + "casePriority": "A String", + "caseSla": "A String", + "caseUri": "A String", + "externalSystemUpdateTime": "A String", + "externalUid": "A String", + "name": "A String", + "status": "A String", + "ticketInfo": { + "assignee": "A String", + "description": "A String", + "id": "A String", + "status": "A String", + "updateTime": "A String", + "uri": "A String", }, }
diff --git a/docs/dyn/securitycenter_v1.projects.sources.findings.html b/docs/dyn/securitycenter_v1.projects.sources.findings.html index dcc6584e17..1f225663c7 100644 --- a/docs/dyn/securitycenter_v1.projects.sources.findings.html +++ b/docs/dyn/securitycenter_v1.projects.sources.findings.html @@ -84,28 +84,28 @@

Instance Methods

Close httplib2 connections.

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

-

Filters an organization or source's findings and groups them by their specified properties. To group across all sources provide a `-` as the source id. Example: /v1/organizations/{organization_id}/sources/-/findings, /v1/folders/{folder_id}/sources/-/findings, /v1/projects/{project_id}/sources/-/findings

+

group_next()

Retrieves the next page of results.

list(parent, compareDuration=None, fieldMask=None, filter=None, orderBy=None, pageSize=None, pageToken=None, readTime=None, x__xgafv=None)

-

Lists an organization or source's findings. To list across all sources provide a `-` as the source id. Example: /v1/organizations/{organization_id}/sources/-/findings

+

list_next()

Retrieves the next page of results.

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

-

Creates or updates a finding. The corresponding source must exist for a finding creation to succeed.

+

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

-

Updates the mute state of a finding.

+

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

-

Updates the state of a finding.

+

updateSecurityMarks(name, body=None, startTime=None, updateMask=None, x__xgafv=None)

-

Updates security marks.

+

Method Details

close() @@ -114,20 +114,20 @@

Method Details

group(parent, body=None, x__xgafv=None) -
Filters an organization or source's findings and groups them by their specified properties. To group across all sources provide a `-` as the source id. Example: /v1/organizations/{organization_id}/sources/-/findings, /v1/folders/{folder_id}/sources/-/findings, /v1/projects/{project_id}/sources/-/findings
+  
 
 Args:
-  parent: string, Required. Name of the source to groupBy. Its format is `organizations/[organization_id]/sources/[source_id]`, `folders/[folder_id]/sources/[source_id]`, or `projects/[project_id]/sources/[source_id]`. To groupBy across all sources provide a source_id of `-`. For example: `organizations/{organization_id}/sources/-, folders/{folder_id}/sources/-`, or `projects/{project_id}/sources/-` (required)
+  parent: string, A parameter (required)
   body: object, The request body.
     The object takes the form of:
 
-{ # Request message for grouping by findings.
-  "compareDuration": "A String", # When compare_duration is set, the GroupResult's "state_change" attribute is updated to indicate whether the finding had its state changed, the finding's state remained unchanged, or if the finding was added during the compare_duration period of time that precedes the read_time. This is the time between (read_time - compare_duration) and read_time. The state_change value is derived based on the presence and state of the finding at the two points in time. Intermediate state changes between the two times don't affect the result. For example, the results aren't affected if the finding is made inactive and then active again. Possible "state_change" values when compare_duration is specified: * "CHANGED": indicates that the finding was present and matched the given filter at the start of compare_duration, but changed its state at read_time. * "UNCHANGED": indicates that the finding was present and matched the given filter at the start of compare_duration and did not change state at read_time. * "ADDED": indicates that the finding did not match the given filter or was not present at the start of compare_duration, but was present at read_time. * "REMOVED": indicates that the finding was present and matched the filter at the start of compare_duration, but did not match the filter at read_time. If compare_duration is not specified, then the only possible state_change is "UNUSED", which will be the state_change set for all findings present at read_time. If this field is set then `state_change` must be a specified field in `group_by`.
-  "filter": "A String", # Expression that defines the filter to apply across findings. The expression is a list of one or more restrictions combined via logical operators `AND` and `OR`. Parentheses are supported, and `OR` has higher precedence than `AND`. Restrictions have the form ` ` and may have a `-` character in front of them to indicate negation. Examples include: * name * source_properties.a_property * security_marks.marks.marka The supported operators are: * `=` for all value types. * `>`, `<`, `>=`, `<=` for integer values. * `:`, meaning substring matching, for strings. The supported value types are: * string literals in quotes. * integer literals without quotes. * boolean literals `true` and `false` without quotes. The following field and operator combinations are supported: * name: `=` * parent: `=`, `:` * resource_name: `=`, `:` * state: `=`, `:` * category: `=`, `:` * external_uri: `=`, `:` * event_time: `=`, `>`, `<`, `>=`, `<=` Usage: This should be milliseconds since epoch or an RFC3339 string. Examples: `event_time = "2019-06-10T16:07:18-07:00"` `event_time = 1560208038000` * severity: `=`, `:` * workflow_state: `=`, `:` * security_marks.marks: `=`, `:` * source_properties: `=`, `:`, `>`, `<`, `>=`, `<=` For example, `source_properties.size = 100` is a valid filter string. Use a partial match on the empty string to filter based on a property existing: `source_properties.my_property : ""` Use a negated partial match on the empty string to filter based on a property not existing: `-source_properties.my_property : ""` * resource: * resource.name: `=`, `:` * resource.parent_name: `=`, `:` * resource.parent_display_name: `=`, `:` * resource.project_name: `=`, `:` * resource.project_display_name: `=`, `:` * resource.type: `=`, `:`
-  "groupBy": "A String", # Required. Expression that defines what assets fields to use for grouping (including `state_change`). The string value should follow SQL syntax: comma separated list of fields. For example: "parent,resource_name". The following fields are supported when compare_duration is set: * state_change
-  "pageSize": 42, # The maximum number of results to return in a single response. Default is 10, minimum is 1, maximum is 1000.
-  "pageToken": "A String", # The value returned by the last `GroupFindingsResponse`; indicates that this is a continuation of a prior `GroupFindings` call, and that the system should return the next page of data.
-  "readTime": "A String", # Time used as a reference point when filtering findings. The filter is limited to findings existing at the supplied time and their values are those at that specific time. Absence of this field will default to the API's version of NOW.
+{
+  "compareDuration": "A String",
+  "filter": "A String",
+  "groupBy": "A String",
+  "pageSize": 42,
+  "pageToken": "A String",
+  "readTime": "A String",
 }
 
   x__xgafv: string, V1 error format.
@@ -138,18 +138,18 @@ 

Method Details

Returns: An object of the form: - { # Response message for group by findings. - "groupByResults": [ # Group results. There exists an element for each existing unique combination of property/values. The element contains a count for the number of times those specific property/values appear. - { # Result containing the properties and count of a groupBy request. - "count": "A String", # Total count of resources for the given properties. - "properties": { # Properties matching the groupBy fields in the request. + { + "groupByResults": [ + { + "count": "A String", + "properties": { "a_key": "", }, }, ], - "nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no more results. - "readTime": "A String", # Time used for executing the groupBy request. - "totalSize": 42, # The total number of results matching the query. + "nextPageToken": "A String", + "readTime": "A String", + "totalSize": 42, }
@@ -169,17 +169,17 @@

Method Details

list(parent, compareDuration=None, fieldMask=None, filter=None, orderBy=None, pageSize=None, pageToken=None, readTime=None, x__xgafv=None) -
Lists an organization or source's findings. To list across all sources provide a `-` as the source id. Example: /v1/organizations/{organization_id}/sources/-/findings
+  
 
 Args:
-  parent: string, Required. Name of the source the findings belong to. Its format is `organizations/[organization_id]/sources/[source_id]`, `folders/[folder_id]/sources/[source_id]`, or `projects/[project_id]/sources/[source_id]`. To list across all sources provide a source_id of `-`. For example: `organizations/{organization_id}/sources/-`, `folders/{folder_id}/sources/-` or `projects/{projects_id}/sources/-` (required)
-  compareDuration: string, When compare_duration is set, the ListFindingsResult's "state_change" attribute is updated to indicate whether the finding had its state changed, the finding's state remained unchanged, or if the finding was added in any state during the compare_duration period of time that precedes the read_time. This is the time between (read_time - compare_duration) and read_time. The state_change value is derived based on the presence and state of the finding at the two points in time. Intermediate state changes between the two times don't affect the result. For example, the results aren't affected if the finding is made inactive and then active again. Possible "state_change" values when compare_duration is specified: * "CHANGED": indicates that the finding was present and matched the given filter at the start of compare_duration, but changed its state at read_time. * "UNCHANGED": indicates that the finding was present and matched the given filter at the start of compare_duration and did not change state at read_time. * "ADDED": indicates that the finding did not match the given filter or was not present at the start of compare_duration, but was present at read_time. * "REMOVED": indicates that the finding was present and matched the filter at the start of compare_duration, but did not match the filter at read_time. If compare_duration is not specified, then the only possible state_change is "UNUSED", which will be the state_change set for all findings present at read_time.
-  fieldMask: string, A field mask to specify the Finding fields to be listed in the response. An empty field mask will list all fields.
-  filter: string, Expression that defines the filter to apply across findings. The expression is a list of one or more restrictions combined via logical operators `AND` and `OR`. Parentheses are supported, and `OR` has higher precedence than `AND`. Restrictions have the form ` ` and may have a `-` character in front of them to indicate negation. Examples include: * name * source_properties.a_property * security_marks.marks.marka The supported operators are: * `=` for all value types. * `>`, `<`, `>=`, `<=` for integer values. * `:`, meaning substring matching, for strings. The supported value types are: * string literals in quotes. * integer literals without quotes. * boolean literals `true` and `false` without quotes. The following field and operator combinations are supported: * name: `=` * parent: `=`, `:` * resource_name: `=`, `:` * state: `=`, `:` * category: `=`, `:` * external_uri: `=`, `:` * event_time: `=`, `>`, `<`, `>=`, `<=` Usage: This should be milliseconds since epoch or an RFC3339 string. Examples: `event_time = "2019-06-10T16:07:18-07:00"` `event_time = 1560208038000` * severity: `=`, `:` * workflow_state: `=`, `:` * security_marks.marks: `=`, `:` * source_properties: `=`, `:`, `>`, `<`, `>=`, `<=` For example, `source_properties.size = 100` is a valid filter string. Use a partial match on the empty string to filter based on a property existing: `source_properties.my_property : ""` Use a negated partial match on the empty string to filter based on a property not existing: `-source_properties.my_property : ""` * resource: * resource.name: `=`, `:` * resource.parent_name: `=`, `:` * resource.parent_display_name: `=`, `:` * resource.project_name: `=`, `:` * resource.project_display_name: `=`, `:` * resource.type: `=`, `:` * resource.folders.resource_folder: `=`, `:` * resource.display_name: `=`, `:`
-  orderBy: string, Expression that defines what fields and order to use for sorting. The string value should follow SQL syntax: comma separated list of fields. For example: "name,resource_properties.a_property". The default sorting order is ascending. To specify descending order for a field, a suffix " desc" should be appended to the field name. For example: "name desc,source_properties.a_property". Redundant space characters in the syntax are insignificant. "name desc,source_properties.a_property" and " name desc , source_properties.a_property " are equivalent. The following fields are supported: name parent state category resource_name event_time source_properties security_marks.marks
-  pageSize: integer, The maximum number of results to return in a single response. Default is 10, minimum is 1, maximum is 1000.
-  pageToken: string, The value returned by the last `ListFindingsResponse`; indicates that this is a continuation of a prior `ListFindings` call, and that the system should return the next page of data.
-  readTime: string, Time used as a reference point when filtering findings. The filter is limited to findings existing at the supplied time and their values are those at that specific time. Absence of this field will default to the API's version of NOW.
+  parent: string, A parameter (required)
+  compareDuration: string, A parameter
+  fieldMask: string, A parameter
+  filter: string, A parameter
+  orderBy: string, A parameter
+  pageSize: integer, A parameter
+  pageToken: string, A parameter
+  readTime: string, A parameter
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -188,945 +188,945 @@ 

Method Details

Returns: An object of the form: - { # Response message for listing findings. - "listFindingsResults": [ # Findings matching the list request. - { # Result containing the Finding and its StateChange. - "finding": { # Security Command Center finding. A finding is a record of assessment data like security, risk, health, or privacy, that is ingested into Security Command Center for presentation, notification, analysis, policy testing, and enforcement. For example, a cross-site scripting (XSS) vulnerability in an App Engine application is a finding. # Finding matching the search request. - "access": { # Represents an access event. # Access details associated with the finding, such as more information on the caller, which method was accessed, and from where. - "callerIp": "A String", # Caller's IP address, such as "1.1.1.1". - "callerIpGeo": { # Represents a geographical location for a given access. # The caller IP's geolocation, which identifies where the call came from. - "regionCode": "A String", # A CLDR. + { + "listFindingsResults": [ + { + "finding": { + "access": { + "callerIp": "A String", + "callerIpGeo": { + "regionCode": "A String", }, - "methodName": "A String", # The method that the service account called, e.g. "SetIamPolicy". - "principalEmail": "A String", # Associated email, such as "foo@google.com". The email address of the authenticated user or a service account acting on behalf of a 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). - "principalSubject": "A String", # A string that represents the principal_subject that is associated with the identity. Unlike `principal_email`, `principal_subject` supports principals that aren't associated with email addresses, such as third party principals. For most identities, the format is `principal://iam.googleapis.com/{identity pool name}/subject/{subject}`. Some GKE identities, such as GKE_WORKLOAD, FREEFORM, and GKE_HUB_WORKLOAD, still use the legacy format `serviceAccount:{identity pool name}[{subject}]`. - "serviceAccountDelegationInfo": [ # The identity delegation history of an authenticated service account that made the request. The `serviceAccountDelegationInfo[]` object contains information about the real authorities that try to access Google Cloud resources by delegating on a service account. When multiple authorities are present, they are guaranteed to be sorted based on the original ordering of the identity delegation events. - { # Identity delegation history of an authenticated service account. - "principalEmail": "A String", # The email address of a Google account. - "principalSubject": "A String", # A string representing the principal_subject associated with the identity. As compared to `principal_email`, supports principals that aren't associated with email addresses, such as third party principals. For most identities, the format will be `principal://iam.googleapis.com/{identity pool name}/subjects/{subject}` except for some GKE identities (GKE_WORKLOAD, FREEFORM, GKE_HUB_WORKLOAD) that are still in the legacy format `serviceAccount:{identity pool name}[{subject}]` + "methodName": "A String", + "principalEmail": "A String", + "principalSubject": "A String", + "serviceAccountDelegationInfo": [ + { + "principalEmail": "A String", + "principalSubject": "A String", }, ], - "serviceAccountKeyName": "A String", # The name of the service account key that was used to create or exchange credentials when authenticating the service account that made the request. This is a scheme-less URI full resource name. For example: "//iam.googleapis.com/projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}/keys/{key}". - "serviceName": "A String", # This is the API service that the service account made a call to, e.g. "iam.googleapis.com" - "userAgent": "A String", # The caller's user agent string associated with the finding. - "userAgentFamily": "A String", # Type of user agent associated with the finding. For example, an operating system shell or an embedded or standalone application. - "userName": "A String", # A string that represents a username. The username provided depends on the type of the finding and is likely not an IAM principal. For example, this can be a system username if the finding is related to a virtual machine, or it can be an application login username. + "serviceAccountKeyName": "A String", + "serviceName": "A String", + "userAgent": "A String", + "userAgentFamily": "A String", + "userName": "A String", }, - "affectedResources": { # Details about resources affected by this finding. # AffectedResources associated with the finding. - "count": "A String", # The count of resources affected by the finding. + "affectedResources": { + "count": "A String", }, - "agentDataAccessEvents": [ # Agent data access events associated with the finding. - { # Details about a data access attempt made by an agent principal not authorized under applicable data security policy. - "eventId": "A String", # Unique identifier for data access event. - "eventTime": "A String", # Timestamp of data access event. - "operation": "A String", # The operation performed by the principal to access the data. - "principalSubject": "A String", # The agent principal that accessed the data. + "agentDataAccessEvents": [ + { + "eventId": "A String", + "eventTime": "A String", + "operation": "A String", + "principalSubject": "A String", }, ], - "aiModel": { # Contains information about the AI model associated with the finding. # The AI model associated with the finding. - "deploymentPlatform": "A String", # The platform on which the model is deployed. - "displayName": "A String", # The user defined display name of model. Ex. baseline-classification-model - "domain": "A String", # The domain of the model, for example, “image-classification”. - "library": "A String", # The name of the model library, for example, “transformers”. - "location": "A String", # The region in which the model is used, for example, “us-central1”. - "name": "A String", # The name of the AI model, for example, "gemini:1.0.0". - "publisher": "A String", # The publisher of the model, for example, “google” or “nvidia”. - "usageCategory": "A String", # The purpose of the model, for example, "Inteference" or "Training". + "aiModel": { + "deploymentPlatform": "A String", + "displayName": "A String", + "domain": "A String", + "library": "A String", + "location": "A String", + "name": "A String", + "publisher": "A String", + "usageCategory": "A String", }, - "application": { # Represents an application associated with a finding. # Represents an application associated with the finding. - "baseUri": "A String", # The base URI that identifies the network location of the application in which the vulnerability was detected. For example, `http://example.com`. - "fullUri": "A String", # The full URI with payload that can be used to reproduce the vulnerability. For example, `http://example.com?p=aMmYgI6H`. + "application": { + "baseUri": "A String", + "fullUri": "A String", }, - "artifactGuardPolicies": { # Represents the result of evaluating artifact guard policies. # ArtifactGuardPolicies associated with the finding. - "failingPolicies": [ # A list of failing policies. - { # Represents an artifact guard policy. - "failureReason": "A String", # The reason for the policy failure, for example, "severity=HIGH AND max_vuln_count=2". - "policyId": "A String", # The ID of the failing policy, for example, "organizations/3392779/locations/global/policies/prod-policy". - "type": "A String", # The type of the policy evaluation. + "artifactGuardPolicies": { + "failingPolicies": [ + { + "failureReason": "A String", + "policyId": "A String", + "type": "A String", }, ], - "resourceId": "A String", # The ID of the resource that has policies configured for it. + "resourceId": "A String", }, - "attackExposure": { # An attack exposure contains the results of an attack path simulation run. # The results of an attack path simulation relevant to this finding. - "attackExposureResult": "A String", # The resource name of the attack path simulation result that contains the details regarding this attack exposure score. Example: `organizations/123/simulations/456/attackExposureResults/789` - "exposedHighValueResourcesCount": 42, # The number of high value resources that are exposed as a result of this finding. - "exposedLowValueResourcesCount": 42, # The number of high value resources that are exposed as a result of this finding. - "exposedMediumValueResourcesCount": 42, # The number of medium value resources that are exposed as a result of this finding. - "latestCalculationTime": "A String", # The most recent time the attack exposure was updated on this finding. - "score": 3.14, # A number between 0 (inclusive) and infinity that represents how important this finding is to remediate. The higher the score, the more important it is to remediate. - "state": "A String", # What state this AttackExposure is in. This captures whether or not an attack exposure has been calculated or not. + "attackExposure": { + "attackExposureResult": "A String", + "exposedHighValueResourcesCount": 42, + "exposedLowValueResourcesCount": 42, + "exposedMediumValueResourcesCount": 42, + "latestCalculationTime": "A String", + "score": 3.14, + "state": "A String", }, - "backupDisasterRecovery": { # Information related to Google Cloud Backup and DR Service findings. # Fields related to Backup and DR findings. - "appliance": "A String", # The name of the Backup and DR appliance that captures, moves, and manages the lifecycle of backup data. For example, `backup-server-57137`. - "applications": [ # The names of Backup and DR applications. An application is a VM, database, or file system on a managed host monitored by a backup and recovery appliance. For example, `centos7-01-vol00`, `centos7-01-vol01`, `centos7-01-vol02`. + "backupDisasterRecovery": { + "appliance": "A String", + "applications": [ "A String", ], - "backupCreateTime": "A String", # The timestamp at which the Backup and DR backup was created. - "backupTemplate": "A String", # The name of a Backup and DR template which comprises one or more backup policies. See the [Backup and DR documentation](https://cloud.google.com/backup-disaster-recovery/docs/concepts/backup-plan#temp) for more information. For example, `snap-ov`. - "backupType": "A String", # The backup type of the Backup and DR image. For example, `Snapshot`, `Remote Snapshot`, `OnVault`. - "host": "A String", # The name of a Backup and DR host, which is managed by the backup and recovery appliance and known to the management console. The host can be of type Generic (for example, Compute Engine, SQL Server, Oracle DB, SMB file system, etc.), vCenter, or an ESX server. See the [Backup and DR documentation on hosts](https://cloud.google.com/backup-disaster-recovery/docs/configuration/manage-hosts-and-their-applications) for more information. For example, `centos7-01`. - "policies": [ # The names of Backup and DR policies that are associated with a template and that define when to run a backup, how frequently to run a backup, and how long to retain the backup image. For example, `onvaults`. + "backupCreateTime": "A String", + "backupTemplate": "A String", + "backupType": "A String", + "host": "A String", + "policies": [ "A String", ], - "policyOptions": [ # The names of Backup and DR advanced policy options of a policy applying to an application. See the [Backup and DR documentation on policy options](https://cloud.google.com/backup-disaster-recovery/docs/create-plan/policy-settings). For example, `skipofflineappsincongrp, nounmap`. + "policyOptions": [ "A String", ], - "profile": "A String", # The name of the Backup and DR resource profile that specifies the storage media for backups of application and VM data. See the [Backup and DR documentation on profiles](https://cloud.google.com/backup-disaster-recovery/docs/concepts/backup-plan#profile). For example, `GCP`. - "storagePool": "A String", # The name of the Backup and DR storage pool that the backup and recovery appliance is storing data in. The storage pool could be of type Cloud, Primary, Snapshot, or OnVault. See the [Backup and DR documentation on storage pools](https://cloud.google.com/backup-disaster-recovery/docs/concepts/storage-pools). For example, `DiskPoolOne`. + "profile": "A String", + "storagePool": "A String", }, - "canonicalName": "A String", # The canonical name of the finding. It's either "organizations/{organization_id}/sources/{source_id}/findings/{finding_id}", "folders/{folder_id}/sources/{source_id}/findings/{finding_id}" or "projects/{project_number}/sources/{source_id}/findings/{finding_id}", depending on the closest CRM ancestor of the resource associated with the finding. - "category": "A String", # The additional taxonomy group within findings from a given source. This field is immutable after creation time. Example: "XSS_FLASH_INJECTION" - "chokepoint": { # Contains details about a chokepoint, which is a resource or resource group where high-risk attack paths converge, based on [attack path simulations] (https://cloud.google.com/security-command-center/docs/attack-exposure-learn#attack_path_simulations). # Contains details about a chokepoint, which is a resource or resource group where high-risk attack paths converge, based on [attack path simulations] (https://cloud.google.com/security-command-center/docs/attack-exposure-learn#attack_path_simulations). This field cannot be updated. Its value is ignored in all update requests. - "relatedFindings": [ # List of resource names of findings associated with this chokepoint. For example, organizations/123/sources/456/findings/789. This list will have at most 100 findings. + "canonicalName": "A String", + "category": "A String", + "chokepoint": { + "relatedFindings": [ "A String", ], }, - "cloudArmor": { # Fields related to Google Cloud Armor findings. # Fields related to Cloud Armor findings. - "adaptiveProtection": { # Information about [Google Cloud Armor Adaptive Protection](https://cloud.google.com/armor/docs/cloud-armor-overview#google-cloud-armor-adaptive-protection). # Information about potential Layer 7 DDoS attacks identified by [Google Cloud Armor Adaptive Protection](https://cloud.google.com/armor/docs/adaptive-protection-overview). - "confidence": 3.14, # A score of 0 means that there is low confidence that the detected event is an actual attack. A score of 1 means that there is high confidence that the detected event is an attack. See the [Adaptive Protection documentation](https://cloud.google.com/armor/docs/adaptive-protection-overview#configure-alert-tuning) for further explanation. + "cloudArmor": { + "adaptiveProtection": { + "confidence": 3.14, }, - "attack": { # Information about DDoS attack volume and classification. # Information about DDoS attack volume and classification. - "classification": "A String", # Type of attack, for example, 'SYN-flood', 'NTP-udp', or 'CHARGEN-udp'. - "volumeBps": 42, # Total BPS (bytes per second) volume of attack. Deprecated - refer to volume_bps_long instead. - "volumeBpsLong": "A String", # Total BPS (bytes per second) volume of attack. - "volumePps": 42, # Total PPS (packets per second) volume of attack. Deprecated - refer to volume_pps_long instead. - "volumePpsLong": "A String", # Total PPS (packets per second) volume of attack. + "attack": { + "classification": "A String", + "volumeBps": 42, + "volumeBpsLong": "A String", + "volumePps": 42, + "volumePpsLong": "A String", }, - "duration": "A String", # Duration of attack from the start until the current moment (updated every 5 minutes). - "requests": { # Information about the requests relevant to the finding. # Information about incoming requests evaluated by [Google Cloud Armor security policies](https://cloud.google.com/armor/docs/security-policy-overview). - "longTermAllowed": 42, # Allowed RPS (requests per second) over the long term. - "longTermDenied": 42, # Denied RPS (requests per second) over the long term. - "ratio": 3.14, # For 'Increasing deny ratio', the ratio is the denied traffic divided by the allowed traffic. For 'Allowed traffic spike', the ratio is the allowed traffic in the short term divided by allowed traffic in the long term. - "shortTermAllowed": 42, # Allowed RPS (requests per second) in the short term. + "duration": "A String", + "requests": { + "longTermAllowed": 42, + "longTermDenied": 42, + "ratio": 3.14, + "shortTermAllowed": 42, }, - "securityPolicy": { # Information about the [Google Cloud Armor security policy](https://cloud.google.com/armor/docs/security-policy-overview) relevant to the finding. # Information about the [Google Cloud Armor security policy](https://cloud.google.com/armor/docs/security-policy-overview) relevant to the finding. - "name": "A String", # The name of the Google Cloud Armor security policy, for example, "my-security-policy". - "preview": True or False, # Whether or not the associated rule or policy is in preview mode. - "type": "A String", # The type of Google Cloud Armor security policy for example, 'backend security policy', 'edge security policy', 'network edge security policy', or 'always-on DDoS protection'. + "securityPolicy": { + "name": "A String", + "preview": True or False, + "type": "A String", }, - "threatVector": "A String", # Distinguish between volumetric & protocol DDoS attack and application layer attacks. For example, "L3_4" for Layer 3 and Layer 4 DDoS attacks, or "L_7" for Layer 7 DDoS attacks. + "threatVector": "A String", }, - "cloudDlpDataProfile": { # The [data profile](https://cloud.google.com/dlp/docs/data-profiles) associated with the finding. # Cloud DLP data profile that is associated with the finding. - "dataProfile": "A String", # Name of the data profile, for example, `projects/123/locations/europe/tableProfiles/8383929`. - "infoTypes": [ # Type of information detected by SDP. Info type includes name, version and sensitivity of the detected information type. - { # Type of information detected by the API. - "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. - "sensitivityScore": { # Score is calculated from of all elements in the data profile. A higher level means the data is more sensitive. # Optional custom sensitivity for this InfoType. This only applies to data profiling. - "score": "A String", # The sensitivity score applied to the resource. + "cloudDlpDataProfile": { + "dataProfile": "A String", + "infoTypes": [ + { + "name": "A String", + "sensitivityScore": { + "score": "A String", }, - "version": "A String", # Optional version name for this InfoType. + "version": "A String", }, ], - "parentType": "A String", # The resource hierarchy level at which the data profile was generated. + "parentType": "A String", }, - "cloudDlpInspection": { # Details about the Cloud Data Loss Prevention (Cloud DLP) [inspection job](https://cloud.google.com/dlp/docs/concepts-job-triggers) that produced the finding. # Cloud Data Loss Prevention (Cloud DLP) inspection results that are associated with the finding. - "fullScan": True or False, # Whether Cloud DLP scanned the complete resource or a sampled subset. - "infoType": "A String", # The type of information (or *[infoType](https://cloud.google.com/dlp/docs/infotypes-reference)*) found, for example, `EMAIL_ADDRESS` or `STREET_ADDRESS`. - "infoTypeCount": "A String", # The number of times Cloud DLP found this infoType within this job and resource. - "inspectJob": "A String", # Name of the inspection job, for example, `projects/123/locations/europe/dlpJobs/i-8383929`. + "cloudDlpInspection": { + "fullScan": True or False, + "infoType": "A String", + "infoTypeCount": "A String", + "inspectJob": "A String", }, - "complianceDetails": { # Compliance Details associated with the finding. # Details about the compliance implications of the finding. - "cloudControl": { # CloudControl associated with the finding. # CloudControl associated with the finding - "cloudControlName": "A String", # Name of the CloudControl associated with the finding. - "policyType": "A String", # Policy type of the CloudControl - "type": "A String", # Type of cloud control. - "version": 42, # Version of the Cloud Control + "complianceDetails": { + "cloudControl": { + "cloudControlName": "A String", + "policyType": "A String", + "type": "A String", + "version": 42, }, - "cloudControlDeploymentNames": [ # Cloud Control Deployments associated with the finding. For example, organizations/123/locations/global/cloudControlDeployments/deploymentIdentifier + "cloudControlDeploymentNames": [ "A String", ], - "frameworks": [ # Details of Frameworks associated with the finding - { # Compliance framework associated with the finding. - "category": [ # Category of the framework associated with the finding. E.g. Security Benchmark, or Assured Workloads + "frameworks": [ + { + "category": [ "A String", ], - "controls": [ # The controls associated with the framework. - { # Compliance control associated with the finding. - "controlName": "A String", # Name of the Control - "displayName": "A String", # Display name of the control. For example, AU-02. + "controls": [ + { + "controlName": "A String", + "displayName": "A String", }, ], - "displayName": "A String", # Display name of the framework. For a standard framework, this will look like e.g. PCI DSS 3.2.1, whereas for a custom framework it can be a user defined string like MyFramework - "name": "A String", # Name of the framework associated with the finding - "type": "A String", # Type of the framework associated with the finding, to specify whether the framework is built-in (pre-defined and immutable) or a custom framework defined by the customer (equivalent to security posture) + "displayName": "A String", + "name": "A String", + "type": "A String", }, ], }, - "compliances": [ # Contains compliance information for security standards associated to the finding. - { # Contains compliance information about a security standard indicating unmet recommendations. - "ids": [ # Policies within the standard or benchmark, for example, A.12.4.1 + "compliances": [ + { + "ids": [ "A String", ], - "standard": "A String", # Industry-wide compliance standards or benchmarks, such as CIS, PCI, and OWASP. - "version": "A String", # Version of the standard or benchmark, for example, 1.1 + "standard": "A String", + "version": "A String", }, ], - "connections": [ # Contains information about the IP connection associated with the finding. - { # Contains information about the IP connection associated with the finding. - "destinationIp": "A String", # Destination IP address. Not present for sockets that are listening and not connected. - "destinationPort": 42, # Destination port. Not present for sockets that are listening and not connected. - "protocol": "A String", # IANA Internet Protocol Number such as TCP(6) and UDP(17). - "sourceIp": "A String", # Source IP address. - "sourcePort": 42, # Source port. + "connections": [ + { + "destinationIp": "A String", + "destinationPort": 42, + "protocol": "A String", + "sourceIp": "A String", + "sourcePort": 42, }, ], - "contacts": { # Output only. Map containing the points of contact for the given finding. The key represents the type of contact, while the value contains a list of all the contacts that pertain. Please refer to: https://cloud.google.com/resource-manager/docs/managing-notification-contacts#notification-categories { "security": { "contacts": [ { "email": "person1@company.com" }, { "email": "person2@company.com" } ] } } - "a_key": { # Details about specific contacts - "contacts": [ # A list of contacts - { # The email address of a contact. - "email": "A String", # An email address. For example, "`person123@company.com`". + "contacts": { + "a_key": { + "contacts": [ + { + "email": "A String", }, ], }, }, - "containers": [ # Containers associated with the finding. This field provides information for both Kubernetes and non-Kubernetes containers. - { # Container associated with the finding. - "createTime": "A String", # The time that the container was created. - "imageId": "A String", # Optional container image ID, if provided by the container runtime. Uniquely identifies the container image launched using a container image digest. - "labels": [ # Container labels, as provided by the container runtime. - { # Represents a generic name-value label. A label has separate name and value fields to support filtering with the `contains()` function. For more information, see [Filtering on array-type fields](https://cloud.google.com/security-command-center/docs/how-to-api-list-findings#array-contains-filtering). - "name": "A String", # Name of the label. - "value": "A String", # Value that corresponds to the label's name. + "containers": [ + { + "createTime": "A String", + "imageId": "A String", + "labels": [ + { + "name": "A String", + "value": "A String", }, ], - "name": "A String", # Name of the container. - "uri": "A String", # Container image URI provided when configuring a pod or container. This string can identify a container image version using mutable tags. + "name": "A String", + "uri": "A String", }, ], - "createTime": "A String", # The time at which the finding was created in Security Command Center. - "dataAccessEvents": [ # Data access events associated with the finding. - { # Details about a data access attempt made by a principal not authorized under applicable data security policy. - "eventId": "A String", # Unique identifier for data access event. - "eventTime": "A String", # Timestamp of data access event. - "operation": "A String", # The operation performed by the principal to access the data. - "principalEmail": "A String", # The email address of the principal that accessed the data. The principal could be a user account, service account, Google group, or other. + "createTime": "A String", + "dataAccessEvents": [ + { + "eventId": "A String", + "eventTime": "A String", + "operation": "A String", + "principalEmail": "A String", }, ], - "dataFlowEvents": [ # Data flow events associated with the finding. - { # Details about a data flow event, in which either the data is moved to or is accessed from a non-compliant geo-location, as defined in the applicable data security policy. - "eventId": "A String", # Unique identifier for data flow event. - "eventTime": "A String", # Timestamp of data flow event. - "operation": "A String", # The operation performed by the principal for the data flow event. - "principalEmail": "A String", # The email address of the principal that initiated the data flow event. The principal could be a user account, service account, Google group, or other. - "violatedLocation": "A String", # Non-compliant location of the principal or the data destination. + "dataFlowEvents": [ + { + "eventId": "A String", + "eventTime": "A String", + "operation": "A String", + "principalEmail": "A String", + "violatedLocation": "A String", }, ], - "dataRetentionDeletionEvents": [ # Data retention deletion events associated with the finding. - { # Details about data retention deletion violations, in which the data is non-compliant based on their retention or deletion time, as defined in the applicable data security policy. The Data Retention Deletion (DRD) control is a control of the DSPM (Data Security Posture Management) suite that enables organizations to manage data retention and deletion policies in compliance with regulations, such as GDPR and CRPA. DRD supports two primary policy types: maximum storage length (max TTL) and minimum storage length (min TTL). Both are aimed at helping organizations meet regulatory and data management commitments. - "dataObjectCount": "A String", # Number of objects that violated the policy for this resource. If the number is less than 1,000, then the value of this field is the exact number. If the number of objects that violated the policy is greater than or equal to 1,000, then the value of this field is 1000. - "eventDetectionTime": "A String", # Timestamp indicating when the event was detected. - "eventType": "A String", # Type of the DRD event. - "maxRetentionAllowed": "A String", # Maximum duration of retention allowed from the DRD control. This comes from the DRD control where users set a max TTL for their data. For example, suppose that a user sets the max TTL for a Cloud Storage bucket to 90 days. However, an object in that bucket is 100 days old. In this case, a DataRetentionDeletionEvent will be generated for that Cloud Storage bucket, and the max_retention_allowed is 90 days. - "minRetentionAllowed": "A String", # Min duration of retention allowed from the DSPM retention control. This field is only populated when event type is set to EVENT_TYPE_MIN_TTL_FROM_CREATION. + "dataRetentionDeletionEvents": [ + { + "dataObjectCount": "A String", + "eventDetectionTime": "A String", + "eventType": "A String", + "maxRetentionAllowed": "A String", + "minRetentionAllowed": "A String", }, ], - "database": { # Represents database access information, such as queries. A database may be a sub-resource of an instance (as in the case of Cloud SQL instances or Cloud Spanner instances), or the database instance itself. Some database resources might not have the [full resource name](https://google.aip.dev/122#full-resource-names) populated because these resource types, such as Cloud SQL databases, are not yet supported by Cloud Asset Inventory. In these cases only the display name is provided. # Database associated with the finding. - "displayName": "A String", # The human-readable name of the database that the user connected to. - "grantees": [ # The target usernames, roles, or groups of an SQL privilege grant, which is not an IAM policy change. + "database": { + "displayName": "A String", + "grantees": [ "A String", ], - "name": "A String", # Some database resources may not have the [full resource name](https://google.aip.dev/122#full-resource-names) populated because these resource types are not yet supported by Cloud Asset Inventory (e.g. Cloud SQL databases). In these cases only the display name will be provided. The [full resource name](https://google.aip.dev/122#full-resource-names) of the database that the user connected to, if it is supported by Cloud Asset Inventory. - "query": "A String", # The SQL statement that is associated with the database access. - "userName": "A String", # The username used to connect to the database. The username might not be an IAM principal and does not have a set format. - "version": "A String", # The version of the database, for example, POSTGRES_14. See [the complete list](https://cloud.google.com/sql/docs/mysql/admin-api/rest/v1/SqlDatabaseVersion). + "name": "A String", + "query": "A String", + "userName": "A String", + "version": "A String", }, - "description": "A String", # Contains more details about the finding. - "discoveredWorkload": { # Represents discovered, customer managed workload that is not registered with the respective GCP service. # DiscoveredWorkload associated with the finding. - "confidence": "A String", # The confidence in detection of this workload. - "detectedRelevantHardware": True or False, # A boolean flag set to true if associated hardware strongly predicts the workload type. - "detectedRelevantKeywords": True or False, # A boolean flag set to true if associated keywords strongly predict the workload type. - "detectedRelevantPackages": True or False, # A boolean flag set to true if installed packages strongly predict the workload type. - "workloadType": "A String", # The type of workload. + "description": "A String", + "discoveredWorkload": { + "confidence": "A String", + "detectedRelevantHardware": True or False, + "detectedRelevantKeywords": True or False, + "detectedRelevantPackages": True or False, + "workloadType": "A String", }, - "disk": { # Contains information about the disk associated with the finding. # Disk associated with the finding. - "name": "A String", # The name of the disk, for example, "https://www.googleapis.com/compute/v1/projects/{project-id}/zones/{zone-id}/disks/{disk-id}". + "disk": { + "name": "A String", }, - "eventTime": "A String", # The time the finding was first detected. If an existing finding is updated, then this is the time the update occurred. For example, if the finding represents an open firewall, this property captures the time the detector believes the firewall became open. The accuracy is determined by the detector. If the finding is later resolved, then this time reflects when the finding was resolved. This must not be set to a value greater than the current timestamp. - "exfiltration": { # Exfiltration represents a data exfiltration attempt from one or more sources to one or more targets. The `sources` attribute lists the sources of the exfiltrated data. The `targets` attribute lists the destinations the data was copied to. # Represents exfiltrations associated with the finding. - "sources": [ # If there are multiple sources, then the data is considered "joined" between them. For instance, BigQuery can join multiple tables, and each table would be considered a source. - { # Resource where data was exfiltrated from or exfiltrated to. - "components": [ # Subcomponents of the asset that was exfiltrated, like URIs used during exfiltration, table names, databases, and filenames. For example, multiple tables might have been exfiltrated from the same Cloud SQL instance, or multiple files might have been exfiltrated from the same Cloud Storage bucket. + "eventTime": "A String", + "exfiltration": { + "sources": [ + { + "components": [ "A String", ], - "name": "A String", # The resource's [full resource name](https://cloud.google.com/apis/design/resource_names#full_resource_name). + "name": "A String", }, ], - "targets": [ # If there are multiple targets, each target would get a complete copy of the "joined" source data. - { # Resource where data was exfiltrated from or exfiltrated to. - "components": [ # Subcomponents of the asset that was exfiltrated, like URIs used during exfiltration, table names, databases, and filenames. For example, multiple tables might have been exfiltrated from the same Cloud SQL instance, or multiple files might have been exfiltrated from the same Cloud Storage bucket. + "targets": [ + { + "components": [ "A String", ], - "name": "A String", # The resource's [full resource name](https://cloud.google.com/apis/design/resource_names#full_resource_name). + "name": "A String", }, ], - "totalExfiltratedBytes": "A String", # Total exfiltrated bytes processed for the entire job. + "totalExfiltratedBytes": "A String", }, - "externalExposure": { # Details about the externally exposed resource associated with the finding. # External exposure associated with the finding. - "backendBucket": "A String", # The full resource name of the load balancer backend bucket, for example, "//compute.googleapis.com/projects/{project-id}/global/backendBuckets/{name}" - "backendService": "A String", # The full resource name of load balancer backend service, for example, "//compute.googleapis.com/projects/{project-id}/global/backendServices/{name}". - "exposedApplication": "A String", # The name and version of the exposed web application, for example, "Jenkins 2.184". - "exposedEndpoint": "A String", # The resource which is running the exposed service, for example, "//compute.googleapis.com/projects/{project-id}/zones/{zone}/instances/{instance}.” - "exposedService": "A String", # The name and version of the service, for example, "Jupyter Notebook 6.14.0". - "forwardingRule": "A String", # The full resource name of the forwarding rule, for example, "//compute.googleapis.com/projects/{project-id}/global/forwardingRules/{forwarding-rule-name}". - "hostnameUri": "A String", # Hostname of the exposed application, for example, "https://test-app.a.run.app/" - "httpResponse": [ # The http response returned by the web application. - { # The http response returned by the web application. - "path": "A String", # The http path for which response code was returned by web application, for example, "https://test-app.a.run.app/test". - "statusCode": "A String", # The http response code returned by the web application, for example, 200. + "externalExposure": { + "backendBucket": "A String", + "backendService": "A String", + "exposedApplication": "A String", + "exposedEndpoint": "A String", + "exposedService": "A String", + "forwardingRule": "A String", + "hostnameUri": "A String", + "httpResponse": [ + { + "path": "A String", + "statusCode": "A String", }, ], - "instanceGroup": "A String", # The full resource name of the instance group, for example, "//compute.googleapis.com/projects/{project-id}/global/instanceGroups/{name}". - "internalBackendService": "A String", # The full resource name of load balancer backend service in the internal project having resource exposed via PSC, for example, "//compute.googleapis.com/projects/{project-id}/global/backendServices/{name}". - "loadBalancerFirewallPolicy": "A String", # The full resource name of the load balancer firewall policy, for example, "//compute.googleapis.com/projects/{project-id}/global/firewallPolicies/{policy-name}". - "networkEndpointGroup": "A String", # The full resource name of the network endpoint group, for example, "//compute.googleapis.com/projects/{project-id}/global/networkEndpointGroups/{name}". - "networkIngressFirewallPolicy": "A String", # The full resource name of the network ingress firewall policy, for example, "//compute.googleapis.com/projects/{project-id}/global/firewallPolicies/{name}". - "privateIpAddress": "A String", # Private IP address of the exposed endpoint. - "privatePort": "A String", # Port number associated with private IP address. - "pscNetworkAttachment": "A String", # The full resource name of the PSC (Private Service Connect) network attachment that network interface controller is attached to, for example, "//compute.googleapis.com/projects/{project-id}/regions/{region}/networkAttachments/{name}" - "pscServiceAttachment": "A String", # The full resource name of the PSC (Private Service Connect) service attachment that the load balancer network endpoint group targets, for example, "//compute.googleapis.com/projects/{project-id}/regions/{region}/serviceAttachments/{name}" - "publicIpAddress": "A String", # Public IP address of the exposed endpoint. - "publicPort": "A String", # Public port number of the exposed endpoint. - "serviceFirewallPolicy": "A String", # The full resource name of the firewall policy of the exposed service, for example, "//compute.googleapis.com/projects/{project-id}/global/firewallPolicies/{policy-name}". + "instanceGroup": "A String", + "internalBackendService": "A String", + "loadBalancerFirewallPolicy": "A String", + "networkEndpointGroup": "A String", + "networkIngressFirewallPolicy": "A String", + "privateIpAddress": "A String", + "privatePort": "A String", + "pscNetworkAttachment": "A String", + "pscServiceAttachment": "A String", + "publicIpAddress": "A String", + "publicPort": "A String", + "serviceFirewallPolicy": "A String", }, - "externalSystems": { # Output only. Third party SIEM/SOAR fields within SCC, contains external system information and external system finding fields. - "a_key": { # Representation of third party SIEM/SOAR fields within SCC. - "assignees": [ # References primary/secondary etc assignees in the external system. + "externalSystems": { + "a_key": { + "assignees": [ "A String", ], - "caseCloseTime": "A String", # The time when the case was closed, as reported by the external system. - "caseCreateTime": "A String", # The time when the case was created, as reported by the external system. - "casePriority": "A String", # The priority of the finding's corresponding case in the external system. - "caseSla": "A String", # The SLA of the finding's corresponding case in the external system. - "caseUri": "A String", # The link to the finding's corresponding case in the external system. - "externalSystemUpdateTime": "A String", # The time when the case was last updated, as reported by the external system. - "externalUid": "A String", # The identifier that's used to track the finding's corresponding case in the external system. - "name": "A String", # Full resource name of the external system, for example: "organizations/1234/sources/5678/findings/123456/externalSystems/jira", "folders/1234/sources/5678/findings/123456/externalSystems/jira", "projects/1234/sources/5678/findings/123456/externalSystems/jira" - "status": "A String", # The most recent status of the finding's corresponding case, as reported by the external system. - "ticketInfo": { # Information about the ticket, if any, that is being used to track the resolution of the issue that is identified by this finding. # Information about the ticket, if any, that is being used to track the resolution of the issue that is identified by this finding. - "assignee": "A String", # The assignee of the ticket in the ticket system. - "description": "A String", # The description of the ticket in the ticket system. - "id": "A String", # The identifier of the ticket in the ticket system. - "status": "A String", # The latest status of the ticket, as reported by the ticket system. - "updateTime": "A String", # The time when the ticket was last updated, as reported by the ticket system. - "uri": "A String", # The link to the ticket in the ticket system. + "caseCloseTime": "A String", + "caseCreateTime": "A String", + "casePriority": "A String", + "caseSla": "A String", + "caseUri": "A String", + "externalSystemUpdateTime": "A String", + "externalUid": "A String", + "name": "A String", + "status": "A String", + "ticketInfo": { + "assignee": "A String", + "description": "A String", + "id": "A String", + "status": "A String", + "updateTime": "A String", + "uri": "A String", }, }, }, - "externalUri": "A String", # The URI that, if available, points to a web page outside of Security Command Center where additional information about the finding can be found. This field is guaranteed to be either empty or a well formed URL. - "files": [ # File associated with the finding. - { # File information about the related binary/library used by an executable, or the script used by a script interpreter - "contents": "A String", # Prefix of the file contents as a JSON-encoded string. - "diskPath": { # Path of the file in terms of underlying disk/partition identifiers. # Path of the file in terms of underlying disk/partition identifiers. - "partitionUuid": "A String", # UUID of the partition (format https://wiki.archlinux.org/title/persistent_block_device_naming#by-uuid) - "relativePath": "A String", # Relative path of the file in the partition as a JSON encoded string. Example: /home/user1/executable_file.sh + "externalUri": "A String", + "files": [ + { + "contents": "A String", + "diskPath": { + "partitionUuid": "A String", + "relativePath": "A String", }, - "fileLoadState": "A String", # The load state of the file. - "hashedSize": "A String", # The length in bytes of the file prefix that was hashed. If hashed_size == size, any hashes reported represent the entire file. - "operations": [ # Operation(s) performed on a file. - { # Operation(s) performed on a file. - "type": "A String", # The type of the operation + "fileLoadState": "A String", + "hashedSize": "A String", + "operations": [ + { + "type": "A String", }, ], - "partiallyHashed": True or False, # True when the hash covers only a prefix of the file. - "path": "A String", # Absolute path of the file as a JSON encoded string. - "sha256": "A String", # SHA256 hash of the first hashed_size bytes of the file encoded as a hex string. If hashed_size == size, sha256 represents the SHA256 hash of the entire file. - "size": "A String", # Size of the file in bytes. + "partiallyHashed": True or False, + "path": "A String", + "sha256": "A String", + "size": "A String", }, ], - "findingClass": "A String", # The class of the finding. - "groupMemberships": [ # Contains details about groups of which this finding is a member. A group is a collection of findings that are related in some way. This field cannot be updated. Its value is ignored in all update requests. - { # Contains details about groups of which this finding is a member. A group is a collection of findings that are related in some way. - "groupId": "A String", # ID of the group. - "groupType": "A String", # Type of group. + "findingClass": "A String", + "groupMemberships": [ + { + "groupId": "A String", + "groupType": "A String", }, ], - "iamBindings": [ # Represents IAM bindings associated with the finding. - { # Represents a particular IAM binding, which captures a member's role addition, removal, or state. - "action": "A String", # The action that was performed on a Binding. - "member": "A String", # A single identity requesting access for a Cloud Platform resource, for example, "foo@google.com". - "role": "A String", # Role that is assigned to "members". For example, "roles/viewer", "roles/editor", or "roles/owner". + "iamBindings": [ + { + "action": "A String", + "member": "A String", + "role": "A String", }, ], - "indicator": { # Represents what's commonly known as an _indicator of compromise_ (IoC) in computer forensics. This is an artifact observed on a network or in an operating system that, with high confidence, indicates a computer intrusion. For more information, see [Indicator of compromise](https://en.wikipedia.org/wiki/Indicator_of_compromise). # Represents what's commonly known as an *indicator of compromise* (IoC) in computer forensics. This is an artifact observed on a network or in an operating system that, with high confidence, indicates a computer intrusion. For more information, see [Indicator of compromise](https://en.wikipedia.org/wiki/Indicator_of_compromise). - "domains": [ # List of domains associated to the Finding. + "indicator": { + "domains": [ "A String", ], - "ipAddresses": [ # The list of IP addresses that are associated with the finding. + "ipAddresses": [ "A String", ], - "signatures": [ # The list of matched signatures indicating that the given process is present in the environment. - { # Indicates what signature matched this process. - "memoryHashSignature": { # A signature corresponding to memory page hashes. # Signature indicating that a binary family was matched. - "binaryFamily": "A String", # The binary family. - "detections": [ # The list of memory hash detections contributing to the binary family match. - { # Memory hash detection contributing to the binary family match. - "binary": "A String", # The name of the binary associated with the memory hash signature detection. - "percentPagesMatched": 3.14, # The percentage of memory page hashes in the signature that were matched. + "signatures": [ + { + "memoryHashSignature": { + "binaryFamily": "A String", + "detections": [ + { + "binary": "A String", + "percentPagesMatched": 3.14, }, ], }, - "signatureType": "A String", # Describes the type of resource associated with the signature. - "yaraRuleSignature": { # A signature corresponding to a YARA rule. # Signature indicating that a YARA rule was matched. - "yaraRule": "A String", # The name of the YARA rule. + "signatureType": "A String", + "yaraRuleSignature": { + "yaraRule": "A String", }, }, ], - "uris": [ # The list of URIs associated to the Findings. + "uris": [ "A String", ], }, - "ipRules": { # IP rules associated with the finding. # IP rules associated with the finding. - "allowed": { # Allowed IP rule. # Tuple with allowed rules. - "ipRules": [ # Optional. Optional list of allowed IP rules. - { # IP rule information. - "portRanges": [ # Optional. An optional list of ports to which this rule applies. This field is only applicable for the UDP or (S)TCP protocols. Each entry must be either an integer or a range including a min and max port number. - { # A port range which is inclusive of the min and max values. Values are between 0 and 2^16-1. The max can be equal / must be not smaller than the min value. If min and max are equal this indicates that it is a single port. - "max": "A String", # Maximum port value. - "min": "A String", # Minimum port value. + "ipRules": { + "allowed": { + "ipRules": [ + { + "portRanges": [ + { + "max": "A String", + "min": "A String", }, ], - "protocol": "A String", # The IP protocol this rule applies to. This value can either be one of the following well known protocol strings (TCP, UDP, ICMP, ESP, AH, IPIP, SCTP) or a string representation of the integer value. + "protocol": "A String", }, ], }, - "denied": { # Denied IP rule. # Tuple with denied rules. - "ipRules": [ # Optional. Optional list of denied IP rules. - { # IP rule information. - "portRanges": [ # Optional. An optional list of ports to which this rule applies. This field is only applicable for the UDP or (S)TCP protocols. Each entry must be either an integer or a range including a min and max port number. - { # A port range which is inclusive of the min and max values. Values are between 0 and 2^16-1. The max can be equal / must be not smaller than the min value. If min and max are equal this indicates that it is a single port. - "max": "A String", # Maximum port value. - "min": "A String", # Minimum port value. + "denied": { + "ipRules": [ + { + "portRanges": [ + { + "max": "A String", + "min": "A String", }, ], - "protocol": "A String", # The IP protocol this rule applies to. This value can either be one of the following well known protocol strings (TCP, UDP, ICMP, ESP, AH, IPIP, SCTP) or a string representation of the integer value. + "protocol": "A String", }, ], }, - "destinationIpRanges": [ # If destination IP ranges are specified, the firewall rule applies only to traffic that has a destination IP address in these ranges. These ranges must be expressed in CIDR format. Only supports IPv4. + "destinationIpRanges": [ "A String", ], - "direction": "A String", # The direction that the rule is applicable to, one of ingress or egress. - "exposedServices": [ # Name of the network protocol service, such as FTP, that is exposed by the open port. Follows the naming convention available at: https://www.iana.org/assignments/service-names-port-numbers/service-names-port-numbers.xhtml. + "direction": "A String", + "exposedServices": [ "A String", ], - "sourceIpRanges": [ # If source IP ranges are specified, the firewall rule applies only to traffic that has a source IP address in these ranges. These ranges must be expressed in CIDR format. Only supports IPv4. + "sourceIpRanges": [ "A String", ], }, - "job": { # Describes a job # Job associated with the finding. - "errorCode": 42, # Optional. If the job did not complete successfully, this field describes why. - "location": "A String", # Optional. Gives the location where the job ran, such as `US` or `europe-west1` - "name": "A String", # The fully-qualified name for a job. e.g. `projects//jobs/` - "state": "A String", # Output only. State of the job, such as `RUNNING` or `PENDING`. + "job": { + "errorCode": 42, + "location": "A String", + "name": "A String", + "state": "A String", }, - "kernelRootkit": { # Kernel mode rootkit signatures. # Signature of the kernel rootkit. - "name": "A String", # Rootkit name, when available. - "unexpectedCodeModification": True or False, # True if unexpected modifications of kernel code memory are present. - "unexpectedFtraceHandler": True or False, # True if `ftrace` points are present with callbacks pointing to regions that are not in the expected kernel or module code range. - "unexpectedInterruptHandler": True or False, # True if interrupt handlers that are are not in the expected kernel or module code regions are present. - "unexpectedKernelCodePages": True or False, # True if kernel code pages that are not in the expected kernel or module code regions are present. - "unexpectedKprobeHandler": True or False, # True if `kprobe` points are present with callbacks pointing to regions that are not in the expected kernel or module code range. - "unexpectedProcessesInRunqueue": True or False, # True if unexpected processes in the scheduler run queue are present. Such processes are in the run queue, but not in the process task list. - "unexpectedReadOnlyDataModification": True or False, # True if unexpected modifications of kernel read-only data memory are present. - "unexpectedSystemCallHandler": True or False, # True if system call handlers that are are not in the expected kernel or module code regions are present. + "kernelRootkit": { + "name": "A String", + "unexpectedCodeModification": True or False, + "unexpectedFtraceHandler": True or False, + "unexpectedInterruptHandler": True or False, + "unexpectedKernelCodePages": True or False, + "unexpectedKprobeHandler": True or False, + "unexpectedProcessesInRunqueue": True or False, + "unexpectedReadOnlyDataModification": True or False, + "unexpectedSystemCallHandler": True or False, }, - "kubernetes": { # Kubernetes-related attributes. # Kubernetes resources associated with the finding. - "accessReviews": [ # Provides information on any Kubernetes access reviews (privilege checks) relevant to the finding. - { # Conveys information about a Kubernetes access review (such as one returned by a [`kubectl auth can-i`](https://kubernetes.io/docs/reference/access-authn-authz/authorization/#checking-api-access) command) that was involved in a finding. - "group": "A String", # The API group of the resource. "*" means all. - "name": "A String", # The name of the resource being requested. Empty means all. - "ns": "A String", # Namespace of the action being requested. Currently, there is no distinction between no namespace and all namespaces. Both are represented by "" (empty). - "resource": "A String", # The optional resource type requested. "*" means all. - "subresource": "A String", # The optional subresource type. - "verb": "A String", # A Kubernetes resource API verb, like get, list, watch, create, update, delete, proxy. "*" means all. - "version": "A String", # The API version of the resource. "*" means all. + "kubernetes": { + "accessReviews": [ + { + "group": "A String", + "name": "A String", + "ns": "A String", + "resource": "A String", + "subresource": "A String", + "verb": "A String", + "version": "A String", }, ], - "bindings": [ # Provides Kubernetes role binding information for findings that involve [RoleBindings or ClusterRoleBindings](https://cloud.google.com/kubernetes-engine/docs/how-to/role-based-access-control). - { # Represents a Kubernetes RoleBinding or ClusterRoleBinding. - "name": "A String", # Name for the binding. - "ns": "A String", # Namespace for the binding. - "role": { # Kubernetes Role or ClusterRole. # The Role or ClusterRole referenced by the binding. - "kind": "A String", # Role type. - "name": "A String", # Role name. - "ns": "A String", # Role namespace. + "bindings": [ + { + "name": "A String", + "ns": "A String", + "role": { + "kind": "A String", + "name": "A String", + "ns": "A String", }, - "subjects": [ # Represents one or more subjects that are bound to the role. Not always available for PATCH requests. - { # Represents a Kubernetes subject. - "kind": "A String", # Authentication type for the subject. - "name": "A String", # Name for the subject. - "ns": "A String", # Namespace for the subject. + "subjects": [ + { + "kind": "A String", + "name": "A String", + "ns": "A String", }, ], }, ], - "nodePools": [ # GKE [node pools](https://cloud.google.com/kubernetes-engine/docs/concepts/node-pools) associated with the finding. This field contains node pool information for each node, when it is available. - { # Provides GKE node pool information. - "name": "A String", # Kubernetes node pool name. - "nodes": [ # Nodes associated with the finding. - { # Kubernetes nodes associated with the finding. - "name": "A String", # [Full resource name](https://google.aip.dev/122#full-resource-names) of the Compute Engine VM running the cluster node. + "nodePools": [ + { + "name": "A String", + "nodes": [ + { + "name": "A String", }, ], }, ], - "nodes": [ # Provides Kubernetes [node](https://cloud.google.com/kubernetes-engine/docs/concepts/cluster-architecture#nodes) information. - { # Kubernetes nodes associated with the finding. - "name": "A String", # [Full resource name](https://google.aip.dev/122#full-resource-names) of the Compute Engine VM running the cluster node. + "nodes": [ + { + "name": "A String", }, ], - "objects": [ # Kubernetes objects related to the finding. - { # Kubernetes object related to the finding, uniquely identified by GKNN. Used if the object Kind is not one of Pod, Node, NodePool, Binding, or AccessReview. - "containers": [ # Pod containers associated with this finding, if any. - { # Container associated with the finding. - "createTime": "A String", # The time that the container was created. - "imageId": "A String", # Optional container image ID, if provided by the container runtime. Uniquely identifies the container image launched using a container image digest. - "labels": [ # Container labels, as provided by the container runtime. - { # Represents a generic name-value label. A label has separate name and value fields to support filtering with the `contains()` function. For more information, see [Filtering on array-type fields](https://cloud.google.com/security-command-center/docs/how-to-api-list-findings#array-contains-filtering). - "name": "A String", # Name of the label. - "value": "A String", # Value that corresponds to the label's name. + "objects": [ + { + "containers": [ + { + "createTime": "A String", + "imageId": "A String", + "labels": [ + { + "name": "A String", + "value": "A String", }, ], - "name": "A String", # Name of the container. - "uri": "A String", # Container image URI provided when configuring a pod or container. This string can identify a container image version using mutable tags. + "name": "A String", + "uri": "A String", }, ], - "group": "A String", # Kubernetes object group, such as "policy.k8s.io/v1". - "kind": "A String", # Kubernetes object kind, such as "Namespace". - "name": "A String", # Kubernetes object name. For details see https://kubernetes.io/docs/concepts/overview/working-with-objects/names/. - "ns": "A String", # Kubernetes object namespace. Must be a valid DNS label. Named "ns" to avoid collision with C++ namespace keyword. For details see https://kubernetes.io/docs/tasks/administer-cluster/namespaces/. + "group": "A String", + "kind": "A String", + "name": "A String", + "ns": "A String", }, ], - "pods": [ # Kubernetes [Pods](https://cloud.google.com/kubernetes-engine/docs/concepts/pod) associated with the finding. This field contains Pod records for each container that is owned by a Pod. - { # A Kubernetes Pod. - "containers": [ # Pod containers associated with this finding, if any. - { # Container associated with the finding. - "createTime": "A String", # The time that the container was created. - "imageId": "A String", # Optional container image ID, if provided by the container runtime. Uniquely identifies the container image launched using a container image digest. - "labels": [ # Container labels, as provided by the container runtime. - { # Represents a generic name-value label. A label has separate name and value fields to support filtering with the `contains()` function. For more information, see [Filtering on array-type fields](https://cloud.google.com/security-command-center/docs/how-to-api-list-findings#array-contains-filtering). - "name": "A String", # Name of the label. - "value": "A String", # Value that corresponds to the label's name. + "pods": [ + { + "containers": [ + { + "createTime": "A String", + "imageId": "A String", + "labels": [ + { + "name": "A String", + "value": "A String", }, ], - "name": "A String", # Name of the container. - "uri": "A String", # Container image URI provided when configuring a pod or container. This string can identify a container image version using mutable tags. + "name": "A String", + "uri": "A String", }, ], - "labels": [ # Pod labels. For Kubernetes containers, these are applied to the container. - { # Represents a generic name-value label. A label has separate name and value fields to support filtering with the `contains()` function. For more information, see [Filtering on array-type fields](https://cloud.google.com/security-command-center/docs/how-to-api-list-findings#array-contains-filtering). - "name": "A String", # Name of the label. - "value": "A String", # Value that corresponds to the label's name. + "labels": [ + { + "name": "A String", + "value": "A String", }, ], - "name": "A String", # Kubernetes Pod name. - "ns": "A String", # Kubernetes Pod namespace. + "name": "A String", + "ns": "A String", }, ], - "roles": [ # Provides Kubernetes role information for findings that involve [Roles or ClusterRoles](https://cloud.google.com/kubernetes-engine/docs/how-to/role-based-access-control). - { # Kubernetes Role or ClusterRole. - "kind": "A String", # Role type. - "name": "A String", # Role name. - "ns": "A String", # Role namespace. + "roles": [ + { + "kind": "A String", + "name": "A String", + "ns": "A String", }, ], }, - "loadBalancers": [ # The load balancers associated with the finding. - { # Contains information related to the load balancer associated with the finding. - "name": "A String", # The name of the load balancer associated with the finding. + "loadBalancers": [ + { + "name": "A String", }, ], - "logEntries": [ # Log entries that are relevant to the finding. - { # An individual entry in a log. - "cloudLoggingEntry": { # Metadata taken from a [Cloud Logging LogEntry](https://cloud.google.com/logging/docs/reference/v2/rest/v2/LogEntry) # An individual entry in a log stored in Cloud Logging. - "insertId": "A String", # A unique identifier for the log entry. - "logId": "A String", # The type of the log (part of `log_name`. `log_name` is the resource name of the log to which this log entry belongs). For example: `cloudresourcemanager.googleapis.com/activity`. Note that this field is not URL-encoded, unlike the `LOG_ID` field in `LogEntry`. - "resourceContainer": "A String", # The organization, folder, or project of the monitored resource that produced this log entry. - "timestamp": "A String", # The time the event described by the log entry occurred. + "logEntries": [ + { + "cloudLoggingEntry": { + "insertId": "A String", + "logId": "A String", + "resourceContainer": "A String", + "timestamp": "A String", }, }, ], - "mitreAttack": { # MITRE ATT&CK tactics and techniques related to this finding. See: https://attack.mitre.org # MITRE ATT&CK tactics and techniques related to this finding. See: https://attack.mitre.org - "additionalTactics": [ # Additional MITRE ATT&CK tactics related to this finding, if any. + "mitreAttack": { + "additionalTactics": [ "A String", ], - "additionalTechniques": [ # Additional MITRE ATT&CK techniques related to this finding, if any, along with any of their respective parent techniques. + "additionalTechniques": [ "A String", ], - "primaryTactic": "A String", # The MITRE ATT&CK tactic most closely represented by this finding, if any. - "primaryTechniques": [ # The MITRE ATT&CK technique most closely represented by this finding, if any. primary_techniques is a repeated field because there are multiple levels of MITRE ATT&CK techniques. If the technique most closely represented by this finding is a sub-technique (e.g. `SCANNING_IP_BLOCKS`), both the sub-technique and its parent technique(s) will be listed (e.g. `SCANNING_IP_BLOCKS`, `ACTIVE_SCANNING`). + "primaryTactic": "A String", + "primaryTechniques": [ "A String", ], - "version": "A String", # The MITRE ATT&CK version referenced by the above fields. E.g. "8". + "version": "A String", }, - "moduleName": "A String", # Unique identifier of the module which generated the finding. Example: folders/598186756061/securityHealthAnalyticsSettings/customModules/56799441161885 - "mute": "A String", # Indicates the mute state of a finding (either muted, unmuted or undefined). Unlike other attributes of a finding, a finding provider shouldn't set the value of mute. - "muteInfo": { # Mute information about the finding, including whether the finding has a static mute or any matching dynamic mute rules. # Output only. The mute information regarding this finding. - "dynamicMuteRecords": [ # The list of dynamic mute rules that currently match the finding. - { # The record of a dynamic mute rule that matches the finding. - "matchTime": "A String", # When the dynamic mute rule first matched the finding. - "muteConfig": "A String", # The relative resource name of the mute rule, represented by a mute config, that created this record, for example `organizations/123/muteConfigs/mymuteconfig` or `organizations/123/locations/global/muteConfigs/mymuteconfig`. + "moduleName": "A String", + "mute": "A String", + "muteInfo": { + "dynamicMuteRecords": [ + { + "matchTime": "A String", + "muteConfig": "A String", }, ], - "staticMute": { # Information about the static mute state. A static mute state overrides any dynamic mute rules that apply to this finding. The static mute state can be set by a static mute rule or by muting the finding directly. # If set, the static mute applied to this finding. Static mutes override dynamic mutes. If unset, there is no static mute. - "applyTime": "A String", # When the static mute was applied. - "state": "A String", # The static mute state. If the value is `MUTED` or `UNMUTED`, then the finding's overall mute state will have the same value. + "staticMute": { + "applyTime": "A String", + "state": "A String", }, }, - "muteInitiator": "A String", # Records additional information about the mute operation, for example, the [mute configuration](/security-command-center/docs/how-to-mute-findings) that muted the finding and the user who muted the finding. - "muteUpdateTime": "A String", # Output only. The most recent time this finding was muted or unmuted. - "name": "A String", # The [relative resource name](https://cloud.google.com/apis/design/resource_names#relative_resource_name) of the finding. Example: "organizations/{organization_id}/sources/{source_id}/findings/{finding_id}", "folders/{folder_id}/sources/{source_id}/findings/{finding_id}", "projects/{project_id}/sources/{source_id}/findings/{finding_id}". - "networks": [ # Represents the VPC networks that the resource is attached to. - { # Contains information about a VPC network associated with the finding. - "name": "A String", # The name of the VPC network resource, for example, `//compute.googleapis.com/projects/my-project/global/networks/my-network`. + "muteInitiator": "A String", + "muteUpdateTime": "A String", + "name": "A String", + "networks": [ + { + "name": "A String", }, ], - "nextSteps": "A String", # Steps to address the finding. - "notebook": { # Represents a Jupyter notebook IPYNB file, such as a [Colab Enterprise notebook](https://cloud.google.com/colab/docs/introduction) file, that is associated with a finding. # Notebook associated with the finding. - "lastAuthor": "A String", # The user ID of the latest author to modify the notebook. - "name": "A String", # The name of the notebook. - "notebookUpdateTime": "A String", # The most recent time the notebook was updated. - "service": "A String", # The source notebook service, for example, "Colab Enterprise". + "nextSteps": "A String", + "notebook": { + "lastAuthor": "A String", + "name": "A String", + "notebookUpdateTime": "A String", + "service": "A String", }, - "orgPolicies": [ # Contains information about the org policies associated with the finding. - { # Contains information about the org policies associated with the finding. - "name": "A String", # The resource name of the org policy. Example: "organizations/{organization_id}/policies/{constraint_name}" + "orgPolicies": [ + { + "name": "A String", }, ], - "parent": "A String", # The relative resource name of the source the finding belongs to. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name This field is immutable after creation time. For example: "organizations/{organization_id}/sources/{source_id}" - "parentDisplayName": "A String", # Output only. The human readable display name of the finding source such as "Event Threat Detection" or "Security Health Analytics". - "policyViolationSummary": { # Metadata summarizing policy violations of child resources of the affected resource. `finding_category` and `resource` determine the exact semantics of the counts. For example, when category=DATA_SECURITY_POSTURE_OBJECT_PUBLIC_ACCESS_VIOLATION and resource='storage.googleapis.com/buckets/my-bucket-name' then this counts the number of Cloud Storage objects in my-bucket-name which violate a Public Access control. # PolicyViolationSummary associated with the finding. - "conformantResourcesCount": "A String", # Total number of child resources that conform to the policy. - "evaluationErrorsCount": "A String", # Number of child resources for which errors during evaluation occurred. The evaluation result for these child resources is effectively "unknown". - "outOfScopeResourcesCount": "A String", # Total count of child resources which were not in scope for evaluation. - "policyViolationsCount": "A String", # Count of child resources in violation of the policy. + "parent": "A String", + "parentDisplayName": "A String", + "policyViolationSummary": { + "conformantResourcesCount": "A String", + "evaluationErrorsCount": "A String", + "outOfScopeResourcesCount": "A String", + "policyViolationsCount": "A String", }, - "processes": [ # Represents operating system processes associated with the Finding. - { # Represents an operating system process. - "args": [ # Process arguments as JSON encoded strings. + "processes": [ + { + "args": [ "A String", ], - "argumentsTruncated": True or False, # True if `args` is incomplete. - "binary": { # File information about the related binary/library used by an executable, or the script used by a script interpreter # File information for the process executable. - "contents": "A String", # Prefix of the file contents as a JSON-encoded string. - "diskPath": { # Path of the file in terms of underlying disk/partition identifiers. # Path of the file in terms of underlying disk/partition identifiers. - "partitionUuid": "A String", # UUID of the partition (format https://wiki.archlinux.org/title/persistent_block_device_naming#by-uuid) - "relativePath": "A String", # Relative path of the file in the partition as a JSON encoded string. Example: /home/user1/executable_file.sh + "argumentsTruncated": True or False, + "binary": { + "contents": "A String", + "diskPath": { + "partitionUuid": "A String", + "relativePath": "A String", }, - "fileLoadState": "A String", # The load state of the file. - "hashedSize": "A String", # The length in bytes of the file prefix that was hashed. If hashed_size == size, any hashes reported represent the entire file. - "operations": [ # Operation(s) performed on a file. - { # Operation(s) performed on a file. - "type": "A String", # The type of the operation + "fileLoadState": "A String", + "hashedSize": "A String", + "operations": [ + { + "type": "A String", }, ], - "partiallyHashed": True or False, # True when the hash covers only a prefix of the file. - "path": "A String", # Absolute path of the file as a JSON encoded string. - "sha256": "A String", # SHA256 hash of the first hashed_size bytes of the file encoded as a hex string. If hashed_size == size, sha256 represents the SHA256 hash of the entire file. - "size": "A String", # Size of the file in bytes. + "partiallyHashed": True or False, + "path": "A String", + "sha256": "A String", + "size": "A String", }, - "envVariables": [ # Process environment variables. - { # A name-value pair representing an environment variable used in an operating system process. - "name": "A String", # Environment variable name as a JSON encoded string. - "val": "A String", # Environment variable value as a JSON encoded string. + "envVariables": [ + { + "name": "A String", + "val": "A String", }, ], - "envVariablesTruncated": True or False, # True if `env_variables` is incomplete. - "libraries": [ # File information for libraries loaded by the process. - { # File information about the related binary/library used by an executable, or the script used by a script interpreter - "contents": "A String", # Prefix of the file contents as a JSON-encoded string. - "diskPath": { # Path of the file in terms of underlying disk/partition identifiers. # Path of the file in terms of underlying disk/partition identifiers. - "partitionUuid": "A String", # UUID of the partition (format https://wiki.archlinux.org/title/persistent_block_device_naming#by-uuid) - "relativePath": "A String", # Relative path of the file in the partition as a JSON encoded string. Example: /home/user1/executable_file.sh + "envVariablesTruncated": True or False, + "libraries": [ + { + "contents": "A String", + "diskPath": { + "partitionUuid": "A String", + "relativePath": "A String", }, - "fileLoadState": "A String", # The load state of the file. - "hashedSize": "A String", # The length in bytes of the file prefix that was hashed. If hashed_size == size, any hashes reported represent the entire file. - "operations": [ # Operation(s) performed on a file. - { # Operation(s) performed on a file. - "type": "A String", # The type of the operation + "fileLoadState": "A String", + "hashedSize": "A String", + "operations": [ + { + "type": "A String", }, ], - "partiallyHashed": True or False, # True when the hash covers only a prefix of the file. - "path": "A String", # Absolute path of the file as a JSON encoded string. - "sha256": "A String", # SHA256 hash of the first hashed_size bytes of the file encoded as a hex string. If hashed_size == size, sha256 represents the SHA256 hash of the entire file. - "size": "A String", # Size of the file in bytes. + "partiallyHashed": True or False, + "path": "A String", + "sha256": "A String", + "size": "A String", }, ], - "name": "A String", # The process name, as displayed in utilities like `top` and `ps`. This name can be accessed through `/proc/[pid]/comm` and changed with `prctl(PR_SET_NAME)`. - "parentPid": "A String", # The parent process ID. - "pid": "A String", # The process ID. - "script": { # File information about the related binary/library used by an executable, or the script used by a script interpreter # When the process represents the invocation of a script, `binary` provides information about the interpreter, while `script` provides information about the script file provided to the interpreter. - "contents": "A String", # Prefix of the file contents as a JSON-encoded string. - "diskPath": { # Path of the file in terms of underlying disk/partition identifiers. # Path of the file in terms of underlying disk/partition identifiers. - "partitionUuid": "A String", # UUID of the partition (format https://wiki.archlinux.org/title/persistent_block_device_naming#by-uuid) - "relativePath": "A String", # Relative path of the file in the partition as a JSON encoded string. Example: /home/user1/executable_file.sh + "name": "A String", + "parentPid": "A String", + "pid": "A String", + "script": { + "contents": "A String", + "diskPath": { + "partitionUuid": "A String", + "relativePath": "A String", }, - "fileLoadState": "A String", # The load state of the file. - "hashedSize": "A String", # The length in bytes of the file prefix that was hashed. If hashed_size == size, any hashes reported represent the entire file. - "operations": [ # Operation(s) performed on a file. - { # Operation(s) performed on a file. - "type": "A String", # The type of the operation + "fileLoadState": "A String", + "hashedSize": "A String", + "operations": [ + { + "type": "A String", }, ], - "partiallyHashed": True or False, # True when the hash covers only a prefix of the file. - "path": "A String", # Absolute path of the file as a JSON encoded string. - "sha256": "A String", # SHA256 hash of the first hashed_size bytes of the file encoded as a hex string. If hashed_size == size, sha256 represents the SHA256 hash of the entire file. - "size": "A String", # Size of the file in bytes. + "partiallyHashed": True or False, + "path": "A String", + "sha256": "A String", + "size": "A String", }, - "userId": "A String", # The ID of the user that executed the process. E.g. If this is the root user this will always be 0. + "userId": "A String", }, ], - "resourceName": "A String", # For findings on Google Cloud resources, the full resource name of the Google Cloud resource this finding is for. See: https://cloud.google.com/apis/design/resource_names#full_resource_name When the finding is for a non-Google Cloud resource, the resourceName can be a customer or partner defined string. This field is immutable after creation time. - "secret": { # Details about a secret or credential associated with the finding. # Secret associated with the finding. - "environmentVariable": { # Environment variable containing the secret. # The environment variable containing the secret. - "key": "A String", # Environment variable name as a JSON encoded string. Note that value is not included since the value contains the secret data, which is sensitive core content. + "resourceName": "A String", + "secret": { + "environmentVariable": { + "key": "A String", }, - "filePath": { # File path containing the secret. # The file containing the secret. - "path": "A String", # Path to the file. + "filePath": { + "path": "A String", }, - "status": { # The status of the secret. # The status of the secret. - "lastUpdatedTime": "A String", # Time that the secret was found. - "validity": "A String", # The validity of the secret. + "status": { + "lastUpdatedTime": "A String", + "validity": "A String", }, - "type": "A String", # The type of secret, for example, GCP_API_KEY. + "type": "A String", }, - "securityMarks": { # User specified security marks that are attached to the parent Security Command Center resource. Security marks are scoped within a Security Command Center organization -- they can be modified and viewed by all users who have proper permissions on the organization. # Output only. User specified security marks. These marks are entirely managed by the user and come from the SecurityMarks resource that belongs to the finding. - "canonicalName": "A String", # The canonical name of the marks. Examples: "organizations/{organization_id}/assets/{asset_id}/securityMarks" "folders/{folder_id}/assets/{asset_id}/securityMarks" "projects/{project_number}/assets/{asset_id}/securityMarks" "organizations/{organization_id}/sources/{source_id}/findings/{finding_id}/securityMarks" "folders/{folder_id}/sources/{source_id}/findings/{finding_id}/securityMarks" "projects/{project_number}/sources/{source_id}/findings/{finding_id}/securityMarks" - "marks": { # Mutable user specified security marks belonging to the parent resource. Constraints are as follows: * Keys and values are treated as case insensitive * Keys must be between 1 - 256 characters (inclusive) * Keys must be letters, numbers, underscores, or dashes * Values have leading and trailing whitespace trimmed, remaining characters must be between 1 - 4096 characters (inclusive) + "securityMarks": { + "canonicalName": "A String", + "marks": { "a_key": "A String", }, - "name": "A String", # The relative resource name of the SecurityMarks. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Examples: "organizations/{organization_id}/assets/{asset_id}/securityMarks" "organizations/{organization_id}/sources/{source_id}/findings/{finding_id}/securityMarks". + "name": "A String", }, - "securityPosture": { # Represents a posture that is deployed on Google Cloud by the Security Command Center Posture Management service. A posture contains one or more policy sets. A policy set is a group of policies that enforce a set of security rules on Google Cloud. # The security posture associated with the finding. - "changedPolicy": "A String", # The name of the updated policy, for example, `projects/{project_id}/policies/{constraint_name}`. - "name": "A String", # Name of the posture, for example, `CIS-Posture`. - "policy": "A String", # The ID of the updated policy, for example, `compute-policy-1`. - "policyDriftDetails": [ # The details about a change in an updated policy that violates the deployed posture. - { # The policy field that violates the deployed posture and its expected and detected values. - "detectedValue": "A String", # The detected value that violates the deployed posture, for example, `false` or `allowed_values={"projects/22831892"}`. - "expectedValue": "A String", # The value of this field that was configured in a posture, for example, `true` or `allowed_values={"projects/29831892"}`. - "field": "A String", # The name of the updated field, for example constraint.implementation.policy_rules[0].enforce + "securityPosture": { + "changedPolicy": "A String", + "name": "A String", + "policy": "A String", + "policyDriftDetails": [ + { + "detectedValue": "A String", + "expectedValue": "A String", + "field": "A String", }, ], - "policySet": "A String", # The name of the updated policyset, for example, `cis-policyset`. - "postureDeployment": "A String", # The name of the posture deployment, for example, `organizations/{org_id}/posturedeployments/{posture_deployment_id}`. - "postureDeploymentResource": "A String", # The project, folder, or organization on which the posture is deployed, for example, `projects/{project_number}`. - "revisionId": "A String", # The version of the posture, for example, `c7cfa2a8`. + "policySet": "A String", + "postureDeployment": "A String", + "postureDeploymentResource": "A String", + "revisionId": "A String", }, - "severity": "A String", # The severity of the finding. This field is managed by the source that writes the finding. - "sourceProperties": { # Source specific properties. These properties are managed by the source that writes the finding. The key names in the source_properties map must be between 1 and 255 characters, and must start with a letter and contain alphanumeric characters or underscores only. + "severity": "A String", + "sourceProperties": { "a_key": "", }, - "state": "A String", # The state of the finding. - "toxicCombination": { # Contains details about a group of security issues that, when the issues occur together, represent a greater risk than when the issues occur independently. A group of such issues is referred to as a toxic combination. # Contains details about a group of security issues that, when the issues occur together, represent a greater risk than when the issues occur independently. A group of such issues is referred to as a toxic combination. This field cannot be updated. Its value is ignored in all update requests. - "attackExposureScore": 3.14, # The [Attack exposure score](https://cloud.google.com/security-command-center/docs/attack-exposure-learn#attack_exposure_scores) of this toxic combination. The score is a measure of how much this toxic combination exposes one or more high-value resources to potential attack. - "relatedFindings": [ # List of resource names of findings associated with this toxic combination. For example, `organizations/123/sources/456/findings/789`. + "state": "A String", + "toxicCombination": { + "attackExposureScore": 3.14, + "relatedFindings": [ "A String", ], }, - "vertexAi": { # Vertex AI-related information associated with the finding. # VertexAi associated with the finding. - "datasets": [ # Datasets associated with the finding. - { # Vertex AI dataset associated with the finding. - "displayName": "A String", # The user defined display name of dataset, e.g. plants-dataset - "name": "A String", # Resource name of the dataset, e.g. projects/{project}/locations/{location}/datasets/2094040236064505856 - "source": "A String", # Data source, such as BigQuery source URI, e.g. bq://scc-nexus-test.AIPPtest.gsod + "vertexAi": { + "datasets": [ + { + "displayName": "A String", + "name": "A String", + "source": "A String", }, ], - "pipelines": [ # Pipelines associated with the finding. - { # Vertex AI training pipeline associated with the finding. - "displayName": "A String", # The user defined display name of pipeline, e.g. plants-classification - "name": "A String", # Resource name of the pipeline, e.g. projects/{project}/locations/{location}/trainingPipelines/5253428229225578496 + "pipelines": [ + { + "displayName": "A String", + "name": "A String", }, ], }, - "vulnerability": { # Refers to common vulnerability fields e.g. cve, cvss, cwe etc. # Represents vulnerability-specific fields like CVE and CVSS scores. CVE stands for Common Vulnerabilities and Exposures (https://cve.mitre.org/about/) - "cve": { # CVE stands for Common Vulnerabilities and Exposures. Information from the [CVE record](https://www.cve.org/ResourcesSupport/Glossary) that describes this vulnerability. # CVE stands for Common Vulnerabilities and Exposures (https://cve.mitre.org/about/) - "cvssv3": { # Common Vulnerability Scoring System version 3. # Describe Common Vulnerability Scoring System specified at https://www.first.org/cvss/v3.1/specification-document - "attackComplexity": "A String", # This metric describes the conditions beyond the attacker's control that must exist in order to exploit the vulnerability. - "attackVector": "A String", # Base Metrics Represents the intrinsic characteristics of a vulnerability that are constant over time and across user environments. This metric reflects the context by which vulnerability exploitation is possible. - "availabilityImpact": "A String", # This metric measures the impact to the availability of the impacted component resulting from a successfully exploited vulnerability. - "baseScore": 3.14, # The base score is a function of the base metric scores. - "confidentialityImpact": "A String", # This metric measures the impact to the confidentiality of the information resources managed by a software component due to a successfully exploited vulnerability. - "integrityImpact": "A String", # This metric measures the impact to integrity of a successfully exploited vulnerability. - "privilegesRequired": "A String", # This metric describes the level of privileges an attacker must possess before successfully exploiting the vulnerability. - "scope": "A String", # The Scope metric captures whether a vulnerability in one vulnerable component impacts resources in components beyond its security scope. - "userInteraction": "A String", # This metric captures the requirement for a human user, other than the attacker, to participate in the successful compromise of the vulnerable component. + "vulnerability": { + "cve": { + "cvssv3": { + "attackComplexity": "A String", + "attackVector": "A String", + "availabilityImpact": "A String", + "baseScore": 3.14, + "confidentialityImpact": "A String", + "integrityImpact": "A String", + "privilegesRequired": "A String", + "scope": "A String", + "userInteraction": "A String", }, - "exploitReleaseDate": "A String", # Date the first publicly available exploit or PoC was released. - "exploitationActivity": "A String", # The exploitation activity of the vulnerability in the wild. - "firstExploitationDate": "A String", # Date of the earliest known exploitation. - "id": "A String", # The unique identifier for the vulnerability. e.g. CVE-2021-34527 - "impact": "A String", # The potential impact of the vulnerability if it was to be exploited. - "observedInTheWild": True or False, # Whether or not the vulnerability has been observed in the wild. - "references": [ # Additional information about the CVE. e.g. https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2021-34527 - { # Additional Links - "source": "A String", # Source of the reference e.g. NVD - "uri": "A String", # Uri for the mentioned source e.g. https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2021-34527. + "exploitReleaseDate": "A String", + "exploitationActivity": "A String", + "firstExploitationDate": "A String", + "id": "A String", + "impact": "A String", + "observedInTheWild": True or False, + "references": [ + { + "source": "A String", + "uri": "A String", }, ], - "upstreamFixAvailable": True or False, # Whether upstream fix is available for the CVE. - "zeroDay": True or False, # Whether or not the vulnerability was zero day when the finding was published. + "upstreamFixAvailable": True or False, + "zeroDay": True or False, }, - "cwes": [ # Represents one or more Common Weakness Enumeration (CWE) information on this vulnerability. - { # CWE stands for Common Weakness Enumeration. Information about this weakness, as described by [CWE](https://cwe.mitre.org/). - "id": "A String", # The CWE identifier, e.g. CWE-94 - "references": [ # Any reference to the details on the CWE, for example, https://cwe.mitre.org/data/definitions/94.html - { # Additional Links - "source": "A String", # Source of the reference e.g. NVD - "uri": "A String", # Uri for the mentioned source e.g. https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2021-34527. + "cwes": [ + { + "id": "A String", + "references": [ + { + "source": "A String", + "uri": "A String", }, ], }, ], - "fixedPackage": { # Package is a generic definition of a package. # The fixed package is relevant to the finding. - "cpeUri": "A String", # The CPE URI where the vulnerability was detected. - "packageName": "A String", # The name of the package where the vulnerability was detected. - "packageType": "A String", # Type of package, for example, os, maven, or go. - "packageVersion": "A String", # The version of the package. + "fixedPackage": { + "cpeUri": "A String", + "packageName": "A String", + "packageType": "A String", + "packageVersion": "A String", }, - "offendingPackage": { # Package is a generic definition of a package. # The offending package is relevant to the finding. - "cpeUri": "A String", # The CPE URI where the vulnerability was detected. - "packageName": "A String", # The name of the package where the vulnerability was detected. - "packageType": "A String", # Type of package, for example, os, maven, or go. - "packageVersion": "A String", # The version of the package. + "offendingPackage": { + "cpeUri": "A String", + "packageName": "A String", + "packageType": "A String", + "packageVersion": "A String", }, - "providerRiskScore": "A String", # Provider provided risk_score based on multiple factors. The higher the risk score, the more risky the vulnerability is. - "reachable": True or False, # Represents whether the vulnerability is reachable (detected via static analysis) - "securityBulletin": { # SecurityBulletin are notifications of vulnerabilities of Google products. # The security bulletin is relevant to this finding. - "bulletinId": "A String", # ID of the bulletin corresponding to the vulnerability. - "submissionTime": "A String", # Submission time of this Security Bulletin. - "suggestedUpgradeVersion": "A String", # This represents a version that the cluster receiving this notification should be upgraded to, based on its current version. For example, 1.15.0 + "providerRiskScore": "A String", + "reachable": True or False, + "securityBulletin": { + "bulletinId": "A String", + "submissionTime": "A String", + "suggestedUpgradeVersion": "A String", }, }, }, - "resource": { # Information related to the Google Cloud resource that is associated with this finding. # Output only. Resource that is associated with this finding. - "adcApplication": { # Represents an ADC application associated with the finding. # The ADC application associated with the finding. - "attributes": { # Consumer provided attributes for the application # Consumer provided attributes for the AppHub application. - "businessOwners": [ # Business team that ensures user needs are met and value is delivered - { # Contact information of stakeholders. - "email": "A String", # Email address of the contacts. + "resource": { + "adcApplication": { + "attributes": { + "businessOwners": [ + { + "email": "A String", }, ], - "criticality": { # Criticality of the Application, Service, or Workload # User-defined criticality information. - "type": "A String", # Criticality Type. + "criticality": { + "type": "A String", }, - "developerOwners": [ # Developer team that owns development and coding. - { # Contact information of stakeholders. - "email": "A String", # Email address of the contacts. + "developerOwners": [ + { + "email": "A String", }, ], - "environment": { # Environment of the Application, Service, or Workload # User-defined environment information. - "type": "A String", # Environment Type. + "environment": { + "type": "A String", }, - "operatorOwners": [ # Operator team that ensures runtime and operations. - { # Contact information of stakeholders. - "email": "A String", # Email address of the contacts. + "operatorOwners": [ + { + "email": "A String", }, ], }, - "name": "A String", # The resource name of an ADC Application. Format: projects/{project}/locations/{location}/spaces/{space}/applications/{application} + "name": "A String", }, - "adcApplicationTemplate": { # Represents an ADC template associated with the finding. # The ADC template associated with the finding. - "name": "A String", # The resource name of an ADC Application Template Revision. Format: projects/{project}/locations/{location}/spaces/{space}/applicationTemplates/{application_template}/revisions/{revision} + "adcApplicationTemplate": { + "name": "A String", }, - "adcSharedTemplate": { # Represents an ADC shared template associated with the finding. # The ADC shared template associated with the finding. - "name": "A String", # The resource name of an ADC Shared Template Revision. Format: projects/{project}/locations/{location}/spaces/{space}/applicationTemplates/{application_template}/revisions/{revision} + "adcSharedTemplate": { + "name": "A String", }, - "application": { # The App Hub Application associated with the finding's resource. # The App Hub application this resource belongs to. - "attributes": { # Consumer provided attributes for the application # Consumer provided attributes for the application - "businessOwners": [ # Business team that ensures user needs are met and value is delivered - { # Contact information of stakeholders. - "email": "A String", # Email address of the contacts. + "application": { + "attributes": { + "businessOwners": [ + { + "email": "A String", }, ], - "criticality": { # Criticality of the Application, Service, or Workload # User-defined criticality information. - "type": "A String", # Criticality Type. + "criticality": { + "type": "A String", }, - "developerOwners": [ # Developer team that owns development and coding. - { # Contact information of stakeholders. - "email": "A String", # Email address of the contacts. + "developerOwners": [ + { + "email": "A String", }, ], - "environment": { # Environment of the Application, Service, or Workload # User-defined environment information. - "type": "A String", # Environment Type. + "environment": { + "type": "A String", }, - "operatorOwners": [ # Operator team that ensures runtime and operations. - { # Contact information of stakeholders. - "email": "A String", # Email address of the contacts. + "operatorOwners": [ + { + "email": "A String", }, ], }, - "name": "A String", # The resource name of an Application. Format: `projects/{host-project-id}/locations/{location}/applications/{application-id}` + "name": "A String", }, - "awsMetadata": { # AWS metadata associated with the resource, only applicable if the finding's cloud provider is Amazon Web Services. # The AWS metadata associated with the finding. - "account": { # An AWS account that is a member of an organization. # The AWS account associated with the resource. - "id": "A String", # The unique identifier (ID) of the account, containing exactly 12 digits. - "name": "A String", # The friendly name of this account. + "awsMetadata": { + "account": { + "id": "A String", + "name": "A String", }, - "organization": { # An organization is a collection of accounts that are centrally managed together using consolidated billing, organized hierarchically with organizational units (OUs), and controlled with policies. # The AWS organization associated with the resource. - "id": "A String", # The unique identifier (ID) for the organization. The regex pattern for an organization ID string requires "o-" followed by from 10 to 32 lowercase letters or digits. + "organization": { + "id": "A String", }, - "organizationalUnits": [ # A list of AWS organizational units associated with the resource, ordered from lowest level (closest to the account) to highest level. - { # An Organizational Unit (OU) is a container of AWS accounts within a root of an organization. Policies that are attached to an OU apply to all accounts contained in that OU and in any child OUs. - "id": "A String", # The unique identifier (ID) associated with this OU. The regex pattern for an organizational unit ID string requires "ou-" followed by from 4 to 32 lowercase letters or digits (the ID of the root that contains the OU). This string is followed by a second "-" dash and from 8 to 32 additional lowercase letters or digits. For example, "ou-ab12-cd34ef56". - "name": "A String", # The friendly name of the OU. + "organizationalUnits": [ + { + "id": "A String", + "name": "A String", }, ], }, - "azureMetadata": { # Azure metadata associated with the resource, only applicable if the finding's cloud provider is Microsoft Azure. # The Azure metadata associated with the finding. - "managementGroups": [ # A list of Azure management groups associated with the resource, ordered from lowest level (closest to the subscription) to highest level. - { # Represents an Azure management group. - "displayName": "A String", # The display name of the Azure management group. - "id": "A String", # The UUID of the Azure management group, for example, `20000000-0001-0000-0000-000000000000`. + "azureMetadata": { + "managementGroups": [ + { + "displayName": "A String", + "id": "A String", }, ], - "resourceGroup": { # Represents an Azure resource group. # The Azure resource group associated with the resource. - "id": "A String", # The ID of the Azure resource group. - "name": "A String", # The name of the Azure resource group. This is not a UUID. + "resourceGroup": { + "id": "A String", + "name": "A String", }, - "subscription": { # Represents an Azure subscription. # The Azure subscription associated with the resource. - "displayName": "A String", # The display name of the Azure subscription. - "id": "A String", # The UUID of the Azure subscription, for example, `291bba3f-e0a5-47bc-a099-3bdcb2a50a05`. + "subscription": { + "displayName": "A String", + "id": "A String", }, - "tenant": { # Represents a Microsoft Entra tenant. # The Azure Entra tenant associated with the resource. - "displayName": "A String", # The display name of the Azure tenant. - "id": "A String", # The ID of the Microsoft Entra tenant, for example, "a11aaa11-aa11-1aa1-11aa-1aaa11a". + "tenant": { + "displayName": "A String", + "id": "A String", }, }, - "cloudProvider": "A String", # Indicates which cloud provider the finding is from. - "displayName": "A String", # The human readable name of the resource. - "folders": [ # Contains a Folder message for each folder in the assets ancestry. The first folder is the deepest nested folder, and the last folder is the folder directly under the Organization. - { # Message that contains the resource name and display name of a folder resource. - "resourceFolder": "A String", # Full resource name of this folder. See: https://cloud.google.com/apis/design/resource_names#full_resource_name - "resourceFolderDisplayName": "A String", # The user defined display name for this folder. + "cloudProvider": "A String", + "displayName": "A String", + "folders": [ + { + "resourceFolder": "A String", + "resourceFolderDisplayName": "A String", }, ], - "location": "A String", # The region or location of the service (if applicable). - "name": "A String", # The full resource name of the resource. See: https://cloud.google.com/apis/design/resource_names#full_resource_name - "organization": "A String", # Indicates which organization / tenant the finding is for. - "parentDisplayName": "A String", # The human readable name of resource's parent. - "parentName": "A String", # The full resource name of resource's parent. - "projectDisplayName": "A String", # The project ID that the resource belongs to. - "projectName": "A String", # The full resource name of project that the resource belongs to. - "resourcePath": { # Represents the path of resources leading up to the resource this finding is about. # Provides the path to the resource within the resource hierarchy. - "nodes": [ # The list of nodes that make the up resource path, ordered from lowest level to highest level. - { # A node within the resource path. Each node represents a resource within the resource hierarchy. - "displayName": "A String", # The display name of the resource this node represents. - "id": "A String", # The ID of the resource this node represents. - "nodeType": "A String", # The type of resource this node represents. + "location": "A String", + "name": "A String", + "organization": "A String", + "parentDisplayName": "A String", + "parentName": "A String", + "projectDisplayName": "A String", + "projectName": "A String", + "resourcePath": { + "nodes": [ + { + "displayName": "A String", + "id": "A String", + "nodeType": "A String", }, ], }, - "resourcePathString": "A String", # A string representation of the resource path. For Google Cloud, it has the format of `org/{organization_id}/folder/{folder_id}/folder/{folder_id}/project/{project_id}` where there can be any number of folders. For AWS, it has the format of `org/{organization_id}/ou/{organizational_unit_id}/ou/{organizational_unit_id}/account/{account_id}` where there can be any number of organizational units. For Azure, it has the format of `mg/{management_group_id}/mg/{management_group_id}/subscription/{subscription_id}/rg/{resource_group_name}` where there can be any number of management groups. - "service": "A String", # The service or resource provider associated with the resource. - "type": "A String", # The full resource type of the resource. + "resourcePathString": "A String", + "service": "A String", + "type": "A String", }, - "stateChange": "A String", # State change of the finding between the points in time. + "stateChange": "A String", }, ], - "nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no more results. - "readTime": "A String", # Time used for executing the list request. - "totalSize": 42, # The total number of findings matching the query. + "nextPageToken": "A String", + "readTime": "A String", + "totalSize": 42, }
@@ -1146,823 +1146,823 @@

Method Details

patch(name, body=None, updateMask=None, x__xgafv=None) -
Creates or updates a finding. The corresponding source must exist for a finding creation to succeed.
+  
 
 Args:
-  name: string, The [relative resource name](https://cloud.google.com/apis/design/resource_names#relative_resource_name) of the finding. Example: "organizations/{organization_id}/sources/{source_id}/findings/{finding_id}", "folders/{folder_id}/sources/{source_id}/findings/{finding_id}", "projects/{project_id}/sources/{source_id}/findings/{finding_id}". (required)
+  name: string, A parameter (required)
   body: object, The request body.
     The object takes the form of:
 
-{ # Security Command Center finding. A finding is a record of assessment data like security, risk, health, or privacy, that is ingested into Security Command Center for presentation, notification, analysis, policy testing, and enforcement. For example, a cross-site scripting (XSS) vulnerability in an App Engine application is a finding.
-  "access": { # Represents an access event. # Access details associated with the finding, such as more information on the caller, which method was accessed, and from where.
-    "callerIp": "A String", # Caller's IP address, such as "1.1.1.1".
-    "callerIpGeo": { # Represents a geographical location for a given access. # The caller IP's geolocation, which identifies where the call came from.
-      "regionCode": "A String", # A CLDR.
-    },
-    "methodName": "A String", # The method that the service account called, e.g. "SetIamPolicy".
-    "principalEmail": "A String", # Associated email, such as "foo@google.com". The email address of the authenticated user or a service account acting on behalf of a 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).
-    "principalSubject": "A String", # A string that represents the principal_subject that is associated with the identity. Unlike `principal_email`, `principal_subject` supports principals that aren't associated with email addresses, such as third party principals. For most identities, the format is `principal://iam.googleapis.com/{identity pool name}/subject/{subject}`. Some GKE identities, such as GKE_WORKLOAD, FREEFORM, and GKE_HUB_WORKLOAD, still use the legacy format `serviceAccount:{identity pool name}[{subject}]`.
-    "serviceAccountDelegationInfo": [ # The identity delegation history of an authenticated service account that made the request. The `serviceAccountDelegationInfo[]` object contains information about the real authorities that try to access Google Cloud resources by delegating on a service account. When multiple authorities are present, they are guaranteed to be sorted based on the original ordering of the identity delegation events.
-      { # Identity delegation history of an authenticated service account.
-        "principalEmail": "A String", # The email address of a Google account.
-        "principalSubject": "A String", # A string representing the principal_subject associated with the identity. As compared to `principal_email`, supports principals that aren't associated with email addresses, such as third party principals. For most identities, the format will be `principal://iam.googleapis.com/{identity pool name}/subjects/{subject}` except for some GKE identities (GKE_WORKLOAD, FREEFORM, GKE_HUB_WORKLOAD) that are still in the legacy format `serviceAccount:{identity pool name}[{subject}]`
+{
+  "access": {
+    "callerIp": "A String",
+    "callerIpGeo": {
+      "regionCode": "A String",
+    },
+    "methodName": "A String",
+    "principalEmail": "A String",
+    "principalSubject": "A String",
+    "serviceAccountDelegationInfo": [
+      {
+        "principalEmail": "A String",
+        "principalSubject": "A String",
       },
     ],
-    "serviceAccountKeyName": "A String", # The name of the service account key that was used to create or exchange credentials when authenticating the service account that made the request. This is a scheme-less URI full resource name. For example: "//iam.googleapis.com/projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}/keys/{key}".
-    "serviceName": "A String", # This is the API service that the service account made a call to, e.g. "iam.googleapis.com"
-    "userAgent": "A String", # The caller's user agent string associated with the finding.
-    "userAgentFamily": "A String", # Type of user agent associated with the finding. For example, an operating system shell or an embedded or standalone application.
-    "userName": "A String", # A string that represents a username. The username provided depends on the type of the finding and is likely not an IAM principal. For example, this can be a system username if the finding is related to a virtual machine, or it can be an application login username.
+    "serviceAccountKeyName": "A String",
+    "serviceName": "A String",
+    "userAgent": "A String",
+    "userAgentFamily": "A String",
+    "userName": "A String",
   },
-  "affectedResources": { # Details about resources affected by this finding. # AffectedResources associated with the finding.
-    "count": "A String", # The count of resources affected by the finding.
+  "affectedResources": {
+    "count": "A String",
   },
-  "agentDataAccessEvents": [ # Agent data access events associated with the finding.
-    { # Details about a data access attempt made by an agent principal not authorized under applicable data security policy.
-      "eventId": "A String", # Unique identifier for data access event.
-      "eventTime": "A String", # Timestamp of data access event.
-      "operation": "A String", # The operation performed by the principal to access the data.
-      "principalSubject": "A String", # The agent principal that accessed the data.
+  "agentDataAccessEvents": [
+    {
+      "eventId": "A String",
+      "eventTime": "A String",
+      "operation": "A String",
+      "principalSubject": "A String",
     },
   ],
-  "aiModel": { # Contains information about the AI model associated with the finding. # The AI model associated with the finding.
-    "deploymentPlatform": "A String", # The platform on which the model is deployed.
-    "displayName": "A String", # The user defined display name of model. Ex. baseline-classification-model
-    "domain": "A String", # The domain of the model, for example, “image-classification”.
-    "library": "A String", # The name of the model library, for example, “transformers”.
-    "location": "A String", # The region in which the model is used, for example, “us-central1”.
-    "name": "A String", # The name of the AI model, for example, "gemini:1.0.0".
-    "publisher": "A String", # The publisher of the model, for example, “google” or “nvidia”.
-    "usageCategory": "A String", # The purpose of the model, for example, "Inteference" or "Training".
-  },
-  "application": { # Represents an application associated with a finding. # Represents an application associated with the finding.
-    "baseUri": "A String", # The base URI that identifies the network location of the application in which the vulnerability was detected. For example, `http://example.com`.
-    "fullUri": "A String", # The full URI with payload that can be used to reproduce the vulnerability. For example, `http://example.com?p=aMmYgI6H`.
-  },
-  "artifactGuardPolicies": { # Represents the result of evaluating artifact guard policies. # ArtifactGuardPolicies associated with the finding.
-    "failingPolicies": [ # A list of failing policies.
-      { # Represents an artifact guard policy.
-        "failureReason": "A String", # The reason for the policy failure, for example, "severity=HIGH AND max_vuln_count=2".
-        "policyId": "A String", # The ID of the failing policy, for example, "organizations/3392779/locations/global/policies/prod-policy".
-        "type": "A String", # The type of the policy evaluation.
+  "aiModel": {
+    "deploymentPlatform": "A String",
+    "displayName": "A String",
+    "domain": "A String",
+    "library": "A String",
+    "location": "A String",
+    "name": "A String",
+    "publisher": "A String",
+    "usageCategory": "A String",
+  },
+  "application": {
+    "baseUri": "A String",
+    "fullUri": "A String",
+  },
+  "artifactGuardPolicies": {
+    "failingPolicies": [
+      {
+        "failureReason": "A String",
+        "policyId": "A String",
+        "type": "A String",
       },
     ],
-    "resourceId": "A String", # The ID of the resource that has policies configured for it.
+    "resourceId": "A String",
   },
-  "attackExposure": { # An attack exposure contains the results of an attack path simulation run. # The results of an attack path simulation relevant to this finding.
-    "attackExposureResult": "A String", # The resource name of the attack path simulation result that contains the details regarding this attack exposure score. Example: `organizations/123/simulations/456/attackExposureResults/789`
-    "exposedHighValueResourcesCount": 42, # The number of high value resources that are exposed as a result of this finding.
-    "exposedLowValueResourcesCount": 42, # The number of high value resources that are exposed as a result of this finding.
-    "exposedMediumValueResourcesCount": 42, # The number of medium value resources that are exposed as a result of this finding.
-    "latestCalculationTime": "A String", # The most recent time the attack exposure was updated on this finding.
-    "score": 3.14, # A number between 0 (inclusive) and infinity that represents how important this finding is to remediate. The higher the score, the more important it is to remediate.
-    "state": "A String", # What state this AttackExposure is in. This captures whether or not an attack exposure has been calculated or not.
+  "attackExposure": {
+    "attackExposureResult": "A String",
+    "exposedHighValueResourcesCount": 42,
+    "exposedLowValueResourcesCount": 42,
+    "exposedMediumValueResourcesCount": 42,
+    "latestCalculationTime": "A String",
+    "score": 3.14,
+    "state": "A String",
   },
-  "backupDisasterRecovery": { # Information related to Google Cloud Backup and DR Service findings. # Fields related to Backup and DR findings.
-    "appliance": "A String", # The name of the Backup and DR appliance that captures, moves, and manages the lifecycle of backup data. For example, `backup-server-57137`.
-    "applications": [ # The names of Backup and DR applications. An application is a VM, database, or file system on a managed host monitored by a backup and recovery appliance. For example, `centos7-01-vol00`, `centos7-01-vol01`, `centos7-01-vol02`.
+  "backupDisasterRecovery": {
+    "appliance": "A String",
+    "applications": [
       "A String",
     ],
-    "backupCreateTime": "A String", # The timestamp at which the Backup and DR backup was created.
-    "backupTemplate": "A String", # The name of a Backup and DR template which comprises one or more backup policies. See the [Backup and DR documentation](https://cloud.google.com/backup-disaster-recovery/docs/concepts/backup-plan#temp) for more information. For example, `snap-ov`.
-    "backupType": "A String", # The backup type of the Backup and DR image. For example, `Snapshot`, `Remote Snapshot`, `OnVault`.
-    "host": "A String", # The name of a Backup and DR host, which is managed by the backup and recovery appliance and known to the management console. The host can be of type Generic (for example, Compute Engine, SQL Server, Oracle DB, SMB file system, etc.), vCenter, or an ESX server. See the [Backup and DR documentation on hosts](https://cloud.google.com/backup-disaster-recovery/docs/configuration/manage-hosts-and-their-applications) for more information. For example, `centos7-01`.
-    "policies": [ # The names of Backup and DR policies that are associated with a template and that define when to run a backup, how frequently to run a backup, and how long to retain the backup image. For example, `onvaults`.
+    "backupCreateTime": "A String",
+    "backupTemplate": "A String",
+    "backupType": "A String",
+    "host": "A String",
+    "policies": [
       "A String",
     ],
-    "policyOptions": [ # The names of Backup and DR advanced policy options of a policy applying to an application. See the [Backup and DR documentation on policy options](https://cloud.google.com/backup-disaster-recovery/docs/create-plan/policy-settings). For example, `skipofflineappsincongrp, nounmap`.
+    "policyOptions": [
       "A String",
     ],
-    "profile": "A String", # The name of the Backup and DR resource profile that specifies the storage media for backups of application and VM data. See the [Backup and DR documentation on profiles](https://cloud.google.com/backup-disaster-recovery/docs/concepts/backup-plan#profile). For example, `GCP`.
-    "storagePool": "A String", # The name of the Backup and DR storage pool that the backup and recovery appliance is storing data in. The storage pool could be of type Cloud, Primary, Snapshot, or OnVault. See the [Backup and DR documentation on storage pools](https://cloud.google.com/backup-disaster-recovery/docs/concepts/storage-pools). For example, `DiskPoolOne`.
+    "profile": "A String",
+    "storagePool": "A String",
   },
-  "canonicalName": "A String", # The canonical name of the finding. It's either "organizations/{organization_id}/sources/{source_id}/findings/{finding_id}", "folders/{folder_id}/sources/{source_id}/findings/{finding_id}" or "projects/{project_number}/sources/{source_id}/findings/{finding_id}", depending on the closest CRM ancestor of the resource associated with the finding.
-  "category": "A String", # The additional taxonomy group within findings from a given source. This field is immutable after creation time. Example: "XSS_FLASH_INJECTION"
-  "chokepoint": { # Contains details about a chokepoint, which is a resource or resource group where high-risk attack paths converge, based on [attack path simulations] (https://cloud.google.com/security-command-center/docs/attack-exposure-learn#attack_path_simulations). # Contains details about a chokepoint, which is a resource or resource group where high-risk attack paths converge, based on [attack path simulations] (https://cloud.google.com/security-command-center/docs/attack-exposure-learn#attack_path_simulations). This field cannot be updated. Its value is ignored in all update requests.
-    "relatedFindings": [ # List of resource names of findings associated with this chokepoint. For example, organizations/123/sources/456/findings/789. This list will have at most 100 findings.
+  "canonicalName": "A String",
+  "category": "A String",
+  "chokepoint": {
+    "relatedFindings": [
       "A String",
     ],
   },
-  "cloudArmor": { # Fields related to Google Cloud Armor findings. # Fields related to Cloud Armor findings.
-    "adaptiveProtection": { # Information about [Google Cloud Armor Adaptive Protection](https://cloud.google.com/armor/docs/cloud-armor-overview#google-cloud-armor-adaptive-protection). # Information about potential Layer 7 DDoS attacks identified by [Google Cloud Armor Adaptive Protection](https://cloud.google.com/armor/docs/adaptive-protection-overview).
-      "confidence": 3.14, # A score of 0 means that there is low confidence that the detected event is an actual attack. A score of 1 means that there is high confidence that the detected event is an attack. See the [Adaptive Protection documentation](https://cloud.google.com/armor/docs/adaptive-protection-overview#configure-alert-tuning) for further explanation.
-    },
-    "attack": { # Information about DDoS attack volume and classification. # Information about DDoS attack volume and classification.
-      "classification": "A String", # Type of attack, for example, 'SYN-flood', 'NTP-udp', or 'CHARGEN-udp'.
-      "volumeBps": 42, # Total BPS (bytes per second) volume of attack. Deprecated - refer to volume_bps_long instead.
-      "volumeBpsLong": "A String", # Total BPS (bytes per second) volume of attack.
-      "volumePps": 42, # Total PPS (packets per second) volume of attack. Deprecated - refer to volume_pps_long instead.
-      "volumePpsLong": "A String", # Total PPS (packets per second) volume of attack.
-    },
-    "duration": "A String", # Duration of attack from the start until the current moment (updated every 5 minutes).
-    "requests": { # Information about the requests relevant to the finding. # Information about incoming requests evaluated by [Google Cloud Armor security policies](https://cloud.google.com/armor/docs/security-policy-overview).
-      "longTermAllowed": 42, # Allowed RPS (requests per second) over the long term.
-      "longTermDenied": 42, # Denied RPS (requests per second) over the long term.
-      "ratio": 3.14, # For 'Increasing deny ratio', the ratio is the denied traffic divided by the allowed traffic. For 'Allowed traffic spike', the ratio is the allowed traffic in the short term divided by allowed traffic in the long term.
-      "shortTermAllowed": 42, # Allowed RPS (requests per second) in the short term.
-    },
-    "securityPolicy": { # Information about the [Google Cloud Armor security policy](https://cloud.google.com/armor/docs/security-policy-overview) relevant to the finding. # Information about the [Google Cloud Armor security policy](https://cloud.google.com/armor/docs/security-policy-overview) relevant to the finding.
-      "name": "A String", # The name of the Google Cloud Armor security policy, for example, "my-security-policy".
-      "preview": True or False, # Whether or not the associated rule or policy is in preview mode.
-      "type": "A String", # The type of Google Cloud Armor security policy for example, 'backend security policy', 'edge security policy', 'network edge security policy', or 'always-on DDoS protection'.
-    },
-    "threatVector": "A String", # Distinguish between volumetric & protocol DDoS attack and application layer attacks. For example, "L3_4" for Layer 3 and Layer 4 DDoS attacks, or "L_7" for Layer 7 DDoS attacks.
-  },
-  "cloudDlpDataProfile": { # The [data profile](https://cloud.google.com/dlp/docs/data-profiles) associated with the finding. # Cloud DLP data profile that is associated with the finding.
-    "dataProfile": "A String", # Name of the data profile, for example, `projects/123/locations/europe/tableProfiles/8383929`.
-    "infoTypes": [ # Type of information detected by SDP. Info type includes name, version and sensitivity of the detected information type.
-      { # Type of information detected by the API.
-        "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`.
-        "sensitivityScore": { # Score is calculated from of all elements in the data profile. A higher level means the data is more sensitive. # Optional custom sensitivity for this InfoType. This only applies to data profiling.
-          "score": "A String", # The sensitivity score applied to the resource.
+  "cloudArmor": {
+    "adaptiveProtection": {
+      "confidence": 3.14,
+    },
+    "attack": {
+      "classification": "A String",
+      "volumeBps": 42,
+      "volumeBpsLong": "A String",
+      "volumePps": 42,
+      "volumePpsLong": "A String",
+    },
+    "duration": "A String",
+    "requests": {
+      "longTermAllowed": 42,
+      "longTermDenied": 42,
+      "ratio": 3.14,
+      "shortTermAllowed": 42,
+    },
+    "securityPolicy": {
+      "name": "A String",
+      "preview": True or False,
+      "type": "A String",
+    },
+    "threatVector": "A String",
+  },
+  "cloudDlpDataProfile": {
+    "dataProfile": "A String",
+    "infoTypes": [
+      {
+        "name": "A String",
+        "sensitivityScore": {
+          "score": "A String",
         },
-        "version": "A String", # Optional version name for this InfoType.
+        "version": "A String",
       },
     ],
-    "parentType": "A String", # The resource hierarchy level at which the data profile was generated.
+    "parentType": "A String",
   },
-  "cloudDlpInspection": { # Details about the Cloud Data Loss Prevention (Cloud DLP) [inspection job](https://cloud.google.com/dlp/docs/concepts-job-triggers) that produced the finding. # Cloud Data Loss Prevention (Cloud DLP) inspection results that are associated with the finding.
-    "fullScan": True or False, # Whether Cloud DLP scanned the complete resource or a sampled subset.
-    "infoType": "A String", # The type of information (or *[infoType](https://cloud.google.com/dlp/docs/infotypes-reference)*) found, for example, `EMAIL_ADDRESS` or `STREET_ADDRESS`.
-    "infoTypeCount": "A String", # The number of times Cloud DLP found this infoType within this job and resource.
-    "inspectJob": "A String", # Name of the inspection job, for example, `projects/123/locations/europe/dlpJobs/i-8383929`.
+  "cloudDlpInspection": {
+    "fullScan": True or False,
+    "infoType": "A String",
+    "infoTypeCount": "A String",
+    "inspectJob": "A String",
   },
-  "complianceDetails": { # Compliance Details associated with the finding. # Details about the compliance implications of the finding.
-    "cloudControl": { # CloudControl associated with the finding. # CloudControl associated with the finding
-      "cloudControlName": "A String", # Name of the CloudControl associated with the finding.
-      "policyType": "A String", # Policy type of the CloudControl
-      "type": "A String", # Type of cloud control.
-      "version": 42, # Version of the Cloud Control
+  "complianceDetails": {
+    "cloudControl": {
+      "cloudControlName": "A String",
+      "policyType": "A String",
+      "type": "A String",
+      "version": 42,
     },
-    "cloudControlDeploymentNames": [ # Cloud Control Deployments associated with the finding. For example, organizations/123/locations/global/cloudControlDeployments/deploymentIdentifier
+    "cloudControlDeploymentNames": [
       "A String",
     ],
-    "frameworks": [ # Details of Frameworks associated with the finding
-      { # Compliance framework associated with the finding.
-        "category": [ # Category of the framework associated with the finding. E.g. Security Benchmark, or Assured Workloads
+    "frameworks": [
+      {
+        "category": [
           "A String",
         ],
-        "controls": [ # The controls associated with the framework.
-          { # Compliance control associated with the finding.
-            "controlName": "A String", # Name of the Control
-            "displayName": "A String", # Display name of the control. For example, AU-02.
+        "controls": [
+          {
+            "controlName": "A String",
+            "displayName": "A String",
           },
         ],
-        "displayName": "A String", # Display name of the framework. For a standard framework, this will look like e.g. PCI DSS 3.2.1, whereas for a custom framework it can be a user defined string like MyFramework
-        "name": "A String", # Name of the framework associated with the finding
-        "type": "A String", # Type of the framework associated with the finding, to specify whether the framework is built-in (pre-defined and immutable) or a custom framework defined by the customer (equivalent to security posture)
+        "displayName": "A String",
+        "name": "A String",
+        "type": "A String",
       },
     ],
   },
-  "compliances": [ # Contains compliance information for security standards associated to the finding.
-    { # Contains compliance information about a security standard indicating unmet recommendations.
-      "ids": [ # Policies within the standard or benchmark, for example, A.12.4.1
+  "compliances": [
+    {
+      "ids": [
         "A String",
       ],
-      "standard": "A String", # Industry-wide compliance standards or benchmarks, such as CIS, PCI, and OWASP.
-      "version": "A String", # Version of the standard or benchmark, for example, 1.1
+      "standard": "A String",
+      "version": "A String",
     },
   ],
-  "connections": [ # Contains information about the IP connection associated with the finding.
-    { # Contains information about the IP connection associated with the finding.
-      "destinationIp": "A String", # Destination IP address. Not present for sockets that are listening and not connected.
-      "destinationPort": 42, # Destination port. Not present for sockets that are listening and not connected.
-      "protocol": "A String", # IANA Internet Protocol Number such as TCP(6) and UDP(17).
-      "sourceIp": "A String", # Source IP address.
-      "sourcePort": 42, # Source port.
+  "connections": [
+    {
+      "destinationIp": "A String",
+      "destinationPort": 42,
+      "protocol": "A String",
+      "sourceIp": "A String",
+      "sourcePort": 42,
     },
   ],
-  "contacts": { # Output only. Map containing the points of contact for the given finding. The key represents the type of contact, while the value contains a list of all the contacts that pertain. Please refer to: https://cloud.google.com/resource-manager/docs/managing-notification-contacts#notification-categories { "security": { "contacts": [ { "email": "person1@company.com" }, { "email": "person2@company.com" } ] } }
-    "a_key": { # Details about specific contacts
-      "contacts": [ # A list of contacts
-        { # The email address of a contact.
-          "email": "A String", # An email address. For example, "`person123@company.com`".
+  "contacts": {
+    "a_key": {
+      "contacts": [
+        {
+          "email": "A String",
         },
       ],
     },
   },
-  "containers": [ # Containers associated with the finding. This field provides information for both Kubernetes and non-Kubernetes containers.
-    { # Container associated with the finding.
-      "createTime": "A String", # The time that the container was created.
-      "imageId": "A String", # Optional container image ID, if provided by the container runtime. Uniquely identifies the container image launched using a container image digest.
-      "labels": [ # Container labels, as provided by the container runtime.
-        { # Represents a generic name-value label. A label has separate name and value fields to support filtering with the `contains()` function. For more information, see [Filtering on array-type fields](https://cloud.google.com/security-command-center/docs/how-to-api-list-findings#array-contains-filtering).
-          "name": "A String", # Name of the label.
-          "value": "A String", # Value that corresponds to the label's name.
+  "containers": [
+    {
+      "createTime": "A String",
+      "imageId": "A String",
+      "labels": [
+        {
+          "name": "A String",
+          "value": "A String",
         },
       ],
-      "name": "A String", # Name of the container.
-      "uri": "A String", # Container image URI provided when configuring a pod or container. This string can identify a container image version using mutable tags.
+      "name": "A String",
+      "uri": "A String",
     },
   ],
-  "createTime": "A String", # The time at which the finding was created in Security Command Center.
-  "dataAccessEvents": [ # Data access events associated with the finding.
-    { # Details about a data access attempt made by a principal not authorized under applicable data security policy.
-      "eventId": "A String", # Unique identifier for data access event.
-      "eventTime": "A String", # Timestamp of data access event.
-      "operation": "A String", # The operation performed by the principal to access the data.
-      "principalEmail": "A String", # The email address of the principal that accessed the data. The principal could be a user account, service account, Google group, or other.
+  "createTime": "A String",
+  "dataAccessEvents": [
+    {
+      "eventId": "A String",
+      "eventTime": "A String",
+      "operation": "A String",
+      "principalEmail": "A String",
     },
   ],
-  "dataFlowEvents": [ # Data flow events associated with the finding.
-    { # Details about a data flow event, in which either the data is moved to or is accessed from a non-compliant geo-location, as defined in the applicable data security policy.
-      "eventId": "A String", # Unique identifier for data flow event.
-      "eventTime": "A String", # Timestamp of data flow event.
-      "operation": "A String", # The operation performed by the principal for the data flow event.
-      "principalEmail": "A String", # The email address of the principal that initiated the data flow event. The principal could be a user account, service account, Google group, or other.
-      "violatedLocation": "A String", # Non-compliant location of the principal or the data destination.
+  "dataFlowEvents": [
+    {
+      "eventId": "A String",
+      "eventTime": "A String",
+      "operation": "A String",
+      "principalEmail": "A String",
+      "violatedLocation": "A String",
     },
   ],
-  "dataRetentionDeletionEvents": [ # Data retention deletion events associated with the finding.
-    { # Details about data retention deletion violations, in which the data is non-compliant based on their retention or deletion time, as defined in the applicable data security policy. The Data Retention Deletion (DRD) control is a control of the DSPM (Data Security Posture Management) suite that enables organizations to manage data retention and deletion policies in compliance with regulations, such as GDPR and CRPA. DRD supports two primary policy types: maximum storage length (max TTL) and minimum storage length (min TTL). Both are aimed at helping organizations meet regulatory and data management commitments.
-      "dataObjectCount": "A String", # Number of objects that violated the policy for this resource. If the number is less than 1,000, then the value of this field is the exact number. If the number of objects that violated the policy is greater than or equal to 1,000, then the value of this field is 1000.
-      "eventDetectionTime": "A String", # Timestamp indicating when the event was detected.
-      "eventType": "A String", # Type of the DRD event.
-      "maxRetentionAllowed": "A String", # Maximum duration of retention allowed from the DRD control. This comes from the DRD control where users set a max TTL for their data. For example, suppose that a user sets the max TTL for a Cloud Storage bucket to 90 days. However, an object in that bucket is 100 days old. In this case, a DataRetentionDeletionEvent will be generated for that Cloud Storage bucket, and the max_retention_allowed is 90 days.
-      "minRetentionAllowed": "A String", # Min duration of retention allowed from the DSPM retention control. This field is only populated when event type is set to EVENT_TYPE_MIN_TTL_FROM_CREATION.
+  "dataRetentionDeletionEvents": [
+    {
+      "dataObjectCount": "A String",
+      "eventDetectionTime": "A String",
+      "eventType": "A String",
+      "maxRetentionAllowed": "A String",
+      "minRetentionAllowed": "A String",
     },
   ],
-  "database": { # Represents database access information, such as queries. A database may be a sub-resource of an instance (as in the case of Cloud SQL instances or Cloud Spanner instances), or the database instance itself. Some database resources might not have the [full resource name](https://google.aip.dev/122#full-resource-names) populated because these resource types, such as Cloud SQL databases, are not yet supported by Cloud Asset Inventory. In these cases only the display name is provided. # Database associated with the finding.
-    "displayName": "A String", # The human-readable name of the database that the user connected to.
-    "grantees": [ # The target usernames, roles, or groups of an SQL privilege grant, which is not an IAM policy change.
+  "database": {
+    "displayName": "A String",
+    "grantees": [
       "A String",
     ],
-    "name": "A String", # Some database resources may not have the [full resource name](https://google.aip.dev/122#full-resource-names) populated because these resource types are not yet supported by Cloud Asset Inventory (e.g. Cloud SQL databases). In these cases only the display name will be provided. The [full resource name](https://google.aip.dev/122#full-resource-names) of the database that the user connected to, if it is supported by Cloud Asset Inventory.
-    "query": "A String", # The SQL statement that is associated with the database access.
-    "userName": "A String", # The username used to connect to the database. The username might not be an IAM principal and does not have a set format.
-    "version": "A String", # The version of the database, for example, POSTGRES_14. See [the complete list](https://cloud.google.com/sql/docs/mysql/admin-api/rest/v1/SqlDatabaseVersion).
-  },
-  "description": "A String", # Contains more details about the finding.
-  "discoveredWorkload": { # Represents discovered, customer managed workload that is not registered with the respective GCP service. # DiscoveredWorkload associated with the finding.
-    "confidence": "A String", # The confidence in detection of this workload.
-    "detectedRelevantHardware": True or False, # A boolean flag set to true if associated hardware strongly predicts the workload type.
-    "detectedRelevantKeywords": True or False, # A boolean flag set to true if associated keywords strongly predict the workload type.
-    "detectedRelevantPackages": True or False, # A boolean flag set to true if installed packages strongly predict the workload type.
-    "workloadType": "A String", # The type of workload.
-  },
-  "disk": { # Contains information about the disk associated with the finding. # Disk associated with the finding.
-    "name": "A String", # The name of the disk, for example, "https://www.googleapis.com/compute/v1/projects/{project-id}/zones/{zone-id}/disks/{disk-id}".
-  },
-  "eventTime": "A String", # The time the finding was first detected. If an existing finding is updated, then this is the time the update occurred. For example, if the finding represents an open firewall, this property captures the time the detector believes the firewall became open. The accuracy is determined by the detector. If the finding is later resolved, then this time reflects when the finding was resolved. This must not be set to a value greater than the current timestamp.
-  "exfiltration": { # Exfiltration represents a data exfiltration attempt from one or more sources to one or more targets. The `sources` attribute lists the sources of the exfiltrated data. The `targets` attribute lists the destinations the data was copied to. # Represents exfiltrations associated with the finding.
-    "sources": [ # If there are multiple sources, then the data is considered "joined" between them. For instance, BigQuery can join multiple tables, and each table would be considered a source.
-      { # Resource where data was exfiltrated from or exfiltrated to.
-        "components": [ # Subcomponents of the asset that was exfiltrated, like URIs used during exfiltration, table names, databases, and filenames. For example, multiple tables might have been exfiltrated from the same Cloud SQL instance, or multiple files might have been exfiltrated from the same Cloud Storage bucket.
+    "name": "A String",
+    "query": "A String",
+    "userName": "A String",
+    "version": "A String",
+  },
+  "description": "A String",
+  "discoveredWorkload": {
+    "confidence": "A String",
+    "detectedRelevantHardware": True or False,
+    "detectedRelevantKeywords": True or False,
+    "detectedRelevantPackages": True or False,
+    "workloadType": "A String",
+  },
+  "disk": {
+    "name": "A String",
+  },
+  "eventTime": "A String",
+  "exfiltration": {
+    "sources": [
+      {
+        "components": [
           "A String",
         ],
-        "name": "A String", # The resource's [full resource name](https://cloud.google.com/apis/design/resource_names#full_resource_name).
+        "name": "A String",
       },
     ],
-    "targets": [ # If there are multiple targets, each target would get a complete copy of the "joined" source data.
-      { # Resource where data was exfiltrated from or exfiltrated to.
-        "components": [ # Subcomponents of the asset that was exfiltrated, like URIs used during exfiltration, table names, databases, and filenames. For example, multiple tables might have been exfiltrated from the same Cloud SQL instance, or multiple files might have been exfiltrated from the same Cloud Storage bucket.
+    "targets": [
+      {
+        "components": [
           "A String",
         ],
-        "name": "A String", # The resource's [full resource name](https://cloud.google.com/apis/design/resource_names#full_resource_name).
+        "name": "A String",
       },
     ],
-    "totalExfiltratedBytes": "A String", # Total exfiltrated bytes processed for the entire job.
-  },
-  "externalExposure": { # Details about the externally exposed resource associated with the finding. # External exposure associated with the finding.
-    "backendBucket": "A String", # The full resource name of the load balancer backend bucket, for example, "//compute.googleapis.com/projects/{project-id}/global/backendBuckets/{name}"
-    "backendService": "A String", # The full resource name of load balancer backend service, for example, "//compute.googleapis.com/projects/{project-id}/global/backendServices/{name}".
-    "exposedApplication": "A String", # The name and version of the exposed web application, for example, "Jenkins 2.184".
-    "exposedEndpoint": "A String", # The resource which is running the exposed service, for example, "//compute.googleapis.com/projects/{project-id}/zones/{zone}/instances/{instance}.”
-    "exposedService": "A String", # The name and version of the service, for example, "Jupyter Notebook 6.14.0".
-    "forwardingRule": "A String", # The full resource name of the forwarding rule, for example, "//compute.googleapis.com/projects/{project-id}/global/forwardingRules/{forwarding-rule-name}".
-    "hostnameUri": "A String", # Hostname of the exposed application, for example, "https://test-app.a.run.app/"
-    "httpResponse": [ # The http response returned by the web application.
-      { # The http response returned by the web application.
-        "path": "A String", # The http path for which response code was returned by web application, for example, "https://test-app.a.run.app/test".
-        "statusCode": "A String", # The http response code returned by the web application, for example, 200.
+    "totalExfiltratedBytes": "A String",
+  },
+  "externalExposure": {
+    "backendBucket": "A String",
+    "backendService": "A String",
+    "exposedApplication": "A String",
+    "exposedEndpoint": "A String",
+    "exposedService": "A String",
+    "forwardingRule": "A String",
+    "hostnameUri": "A String",
+    "httpResponse": [
+      {
+        "path": "A String",
+        "statusCode": "A String",
       },
     ],
-    "instanceGroup": "A String", # The full resource name of the instance group, for example, "//compute.googleapis.com/projects/{project-id}/global/instanceGroups/{name}".
-    "internalBackendService": "A String", # The full resource name of load balancer backend service in the internal project having resource exposed via PSC, for example, "//compute.googleapis.com/projects/{project-id}/global/backendServices/{name}".
-    "loadBalancerFirewallPolicy": "A String", # The full resource name of the load balancer firewall policy, for example, "//compute.googleapis.com/projects/{project-id}/global/firewallPolicies/{policy-name}".
-    "networkEndpointGroup": "A String", # The full resource name of the network endpoint group, for example, "//compute.googleapis.com/projects/{project-id}/global/networkEndpointGroups/{name}".
-    "networkIngressFirewallPolicy": "A String", # The full resource name of the network ingress firewall policy, for example, "//compute.googleapis.com/projects/{project-id}/global/firewallPolicies/{name}".
-    "privateIpAddress": "A String", # Private IP address of the exposed endpoint.
-    "privatePort": "A String", # Port number associated with private IP address.
-    "pscNetworkAttachment": "A String", # The full resource name of the PSC (Private Service Connect) network attachment that network interface controller is attached to, for example, "//compute.googleapis.com/projects/{project-id}/regions/{region}/networkAttachments/{name}"
-    "pscServiceAttachment": "A String", # The full resource name of the PSC (Private Service Connect) service attachment that the load balancer network endpoint group targets, for example, "//compute.googleapis.com/projects/{project-id}/regions/{region}/serviceAttachments/{name}"
-    "publicIpAddress": "A String", # Public IP address of the exposed endpoint.
-    "publicPort": "A String", # Public port number of the exposed endpoint.
-    "serviceFirewallPolicy": "A String", # The full resource name of the firewall policy of the exposed service, for example, "//compute.googleapis.com/projects/{project-id}/global/firewallPolicies/{policy-name}".
-  },
-  "externalSystems": { # Output only. Third party SIEM/SOAR fields within SCC, contains external system information and external system finding fields.
-    "a_key": { # Representation of third party SIEM/SOAR fields within SCC.
-      "assignees": [ # References primary/secondary etc assignees in the external system.
+    "instanceGroup": "A String",
+    "internalBackendService": "A String",
+    "loadBalancerFirewallPolicy": "A String",
+    "networkEndpointGroup": "A String",
+    "networkIngressFirewallPolicy": "A String",
+    "privateIpAddress": "A String",
+    "privatePort": "A String",
+    "pscNetworkAttachment": "A String",
+    "pscServiceAttachment": "A String",
+    "publicIpAddress": "A String",
+    "publicPort": "A String",
+    "serviceFirewallPolicy": "A String",
+  },
+  "externalSystems": {
+    "a_key": {
+      "assignees": [
         "A String",
       ],
-      "caseCloseTime": "A String", # The time when the case was closed, as reported by the external system.
-      "caseCreateTime": "A String", # The time when the case was created, as reported by the external system.
-      "casePriority": "A String", # The priority of the finding's corresponding case in the external system.
-      "caseSla": "A String", # The SLA of the finding's corresponding case in the external system.
-      "caseUri": "A String", # The link to the finding's corresponding case in the external system.
-      "externalSystemUpdateTime": "A String", # The time when the case was last updated, as reported by the external system.
-      "externalUid": "A String", # The identifier that's used to track the finding's corresponding case in the external system.
-      "name": "A String", # Full resource name of the external system, for example: "organizations/1234/sources/5678/findings/123456/externalSystems/jira", "folders/1234/sources/5678/findings/123456/externalSystems/jira", "projects/1234/sources/5678/findings/123456/externalSystems/jira"
-      "status": "A String", # The most recent status of the finding's corresponding case, as reported by the external system.
-      "ticketInfo": { # Information about the ticket, if any, that is being used to track the resolution of the issue that is identified by this finding. # Information about the ticket, if any, that is being used to track the resolution of the issue that is identified by this finding.
-        "assignee": "A String", # The assignee of the ticket in the ticket system.
-        "description": "A String", # The description of the ticket in the ticket system.
-        "id": "A String", # The identifier of the ticket in the ticket system.
-        "status": "A String", # The latest status of the ticket, as reported by the ticket system.
-        "updateTime": "A String", # The time when the ticket was last updated, as reported by the ticket system.
-        "uri": "A String", # The link to the ticket in the ticket system.
+      "caseCloseTime": "A String",
+      "caseCreateTime": "A String",
+      "casePriority": "A String",
+      "caseSla": "A String",
+      "caseUri": "A String",
+      "externalSystemUpdateTime": "A String",
+      "externalUid": "A String",
+      "name": "A String",
+      "status": "A String",
+      "ticketInfo": {
+        "assignee": "A String",
+        "description": "A String",
+        "id": "A String",
+        "status": "A String",
+        "updateTime": "A String",
+        "uri": "A String",
       },
     },
   },
-  "externalUri": "A String", # The URI that, if available, points to a web page outside of Security Command Center where additional information about the finding can be found. This field is guaranteed to be either empty or a well formed URL.
-  "files": [ # File associated with the finding.
-    { # File information about the related binary/library used by an executable, or the script used by a script interpreter
-      "contents": "A String", # Prefix of the file contents as a JSON-encoded string.
-      "diskPath": { # Path of the file in terms of underlying disk/partition identifiers. # Path of the file in terms of underlying disk/partition identifiers.
-        "partitionUuid": "A String", # UUID of the partition (format https://wiki.archlinux.org/title/persistent_block_device_naming#by-uuid)
-        "relativePath": "A String", # Relative path of the file in the partition as a JSON encoded string. Example: /home/user1/executable_file.sh
+  "externalUri": "A String",
+  "files": [
+    {
+      "contents": "A String",
+      "diskPath": {
+        "partitionUuid": "A String",
+        "relativePath": "A String",
       },
-      "fileLoadState": "A String", # The load state of the file.
-      "hashedSize": "A String", # The length in bytes of the file prefix that was hashed. If hashed_size == size, any hashes reported represent the entire file.
-      "operations": [ # Operation(s) performed on a file.
-        { # Operation(s) performed on a file.
-          "type": "A String", # The type of the operation
+      "fileLoadState": "A String",
+      "hashedSize": "A String",
+      "operations": [
+        {
+          "type": "A String",
         },
       ],
-      "partiallyHashed": True or False, # True when the hash covers only a prefix of the file.
-      "path": "A String", # Absolute path of the file as a JSON encoded string.
-      "sha256": "A String", # SHA256 hash of the first hashed_size bytes of the file encoded as a hex string. If hashed_size == size, sha256 represents the SHA256 hash of the entire file.
-      "size": "A String", # Size of the file in bytes.
+      "partiallyHashed": True or False,
+      "path": "A String",
+      "sha256": "A String",
+      "size": "A String",
     },
   ],
-  "findingClass": "A String", # The class of the finding.
-  "groupMemberships": [ # Contains details about groups of which this finding is a member. A group is a collection of findings that are related in some way. This field cannot be updated. Its value is ignored in all update requests.
-    { # Contains details about groups of which this finding is a member. A group is a collection of findings that are related in some way.
-      "groupId": "A String", # ID of the group.
-      "groupType": "A String", # Type of group.
+  "findingClass": "A String",
+  "groupMemberships": [
+    {
+      "groupId": "A String",
+      "groupType": "A String",
     },
   ],
-  "iamBindings": [ # Represents IAM bindings associated with the finding.
-    { # Represents a particular IAM binding, which captures a member's role addition, removal, or state.
-      "action": "A String", # The action that was performed on a Binding.
-      "member": "A String", # A single identity requesting access for a Cloud Platform resource, for example, "foo@google.com".
-      "role": "A String", # Role that is assigned to "members". For example, "roles/viewer", "roles/editor", or "roles/owner".
+  "iamBindings": [
+    {
+      "action": "A String",
+      "member": "A String",
+      "role": "A String",
     },
   ],
-  "indicator": { # Represents what's commonly known as an _indicator of compromise_ (IoC) in computer forensics. This is an artifact observed on a network or in an operating system that, with high confidence, indicates a computer intrusion. For more information, see [Indicator of compromise](https://en.wikipedia.org/wiki/Indicator_of_compromise). # Represents what's commonly known as an *indicator of compromise* (IoC) in computer forensics. This is an artifact observed on a network or in an operating system that, with high confidence, indicates a computer intrusion. For more information, see [Indicator of compromise](https://en.wikipedia.org/wiki/Indicator_of_compromise).
-    "domains": [ # List of domains associated to the Finding.
+  "indicator": {
+    "domains": [
       "A String",
     ],
-    "ipAddresses": [ # The list of IP addresses that are associated with the finding.
+    "ipAddresses": [
       "A String",
     ],
-    "signatures": [ # The list of matched signatures indicating that the given process is present in the environment.
-      { # Indicates what signature matched this process.
-        "memoryHashSignature": { # A signature corresponding to memory page hashes. # Signature indicating that a binary family was matched.
-          "binaryFamily": "A String", # The binary family.
-          "detections": [ # The list of memory hash detections contributing to the binary family match.
-            { # Memory hash detection contributing to the binary family match.
-              "binary": "A String", # The name of the binary associated with the memory hash signature detection.
-              "percentPagesMatched": 3.14, # The percentage of memory page hashes in the signature that were matched.
+    "signatures": [
+      {
+        "memoryHashSignature": {
+          "binaryFamily": "A String",
+          "detections": [
+            {
+              "binary": "A String",
+              "percentPagesMatched": 3.14,
             },
           ],
         },
-        "signatureType": "A String", # Describes the type of resource associated with the signature.
-        "yaraRuleSignature": { # A signature corresponding to a YARA rule. # Signature indicating that a YARA rule was matched.
-          "yaraRule": "A String", # The name of the YARA rule.
+        "signatureType": "A String",
+        "yaraRuleSignature": {
+          "yaraRule": "A String",
         },
       },
     ],
-    "uris": [ # The list of URIs associated to the Findings.
+    "uris": [
       "A String",
     ],
   },
-  "ipRules": { # IP rules associated with the finding. # IP rules associated with the finding.
-    "allowed": { # Allowed IP rule. # Tuple with allowed rules.
-      "ipRules": [ # Optional. Optional list of allowed IP rules.
-        { # IP rule information.
-          "portRanges": [ # Optional. An optional list of ports to which this rule applies. This field is only applicable for the UDP or (S)TCP protocols. Each entry must be either an integer or a range including a min and max port number.
-            { # A port range which is inclusive of the min and max values. Values are between 0 and 2^16-1. The max can be equal / must be not smaller than the min value. If min and max are equal this indicates that it is a single port.
-              "max": "A String", # Maximum port value.
-              "min": "A String", # Minimum port value.
+  "ipRules": {
+    "allowed": {
+      "ipRules": [
+        {
+          "portRanges": [
+            {
+              "max": "A String",
+              "min": "A String",
             },
           ],
-          "protocol": "A String", # The IP protocol this rule applies to. This value can either be one of the following well known protocol strings (TCP, UDP, ICMP, ESP, AH, IPIP, SCTP) or a string representation of the integer value.
+          "protocol": "A String",
         },
       ],
     },
-    "denied": { # Denied IP rule. # Tuple with denied rules.
-      "ipRules": [ # Optional. Optional list of denied IP rules.
-        { # IP rule information.
-          "portRanges": [ # Optional. An optional list of ports to which this rule applies. This field is only applicable for the UDP or (S)TCP protocols. Each entry must be either an integer or a range including a min and max port number.
-            { # A port range which is inclusive of the min and max values. Values are between 0 and 2^16-1. The max can be equal / must be not smaller than the min value. If min and max are equal this indicates that it is a single port.
-              "max": "A String", # Maximum port value.
-              "min": "A String", # Minimum port value.
+    "denied": {
+      "ipRules": [
+        {
+          "portRanges": [
+            {
+              "max": "A String",
+              "min": "A String",
             },
           ],
-          "protocol": "A String", # The IP protocol this rule applies to. This value can either be one of the following well known protocol strings (TCP, UDP, ICMP, ESP, AH, IPIP, SCTP) or a string representation of the integer value.
+          "protocol": "A String",
         },
       ],
     },
-    "destinationIpRanges": [ # If destination IP ranges are specified, the firewall rule applies only to traffic that has a destination IP address in these ranges. These ranges must be expressed in CIDR format. Only supports IPv4.
+    "destinationIpRanges": [
       "A String",
     ],
-    "direction": "A String", # The direction that the rule is applicable to, one of ingress or egress.
-    "exposedServices": [ # Name of the network protocol service, such as FTP, that is exposed by the open port. Follows the naming convention available at: https://www.iana.org/assignments/service-names-port-numbers/service-names-port-numbers.xhtml.
+    "direction": "A String",
+    "exposedServices": [
       "A String",
     ],
-    "sourceIpRanges": [ # If source IP ranges are specified, the firewall rule applies only to traffic that has a source IP address in these ranges. These ranges must be expressed in CIDR format. Only supports IPv4.
+    "sourceIpRanges": [
       "A String",
     ],
   },
-  "job": { # Describes a job # Job associated with the finding.
-    "errorCode": 42, # Optional. If the job did not complete successfully, this field describes why.
-    "location": "A String", # Optional. Gives the location where the job ran, such as `US` or `europe-west1`
-    "name": "A String", # The fully-qualified name for a job. e.g. `projects//jobs/`
-    "state": "A String", # Output only. State of the job, such as `RUNNING` or `PENDING`.
-  },
-  "kernelRootkit": { # Kernel mode rootkit signatures. # Signature of the kernel rootkit.
-    "name": "A String", # Rootkit name, when available.
-    "unexpectedCodeModification": True or False, # True if unexpected modifications of kernel code memory are present.
-    "unexpectedFtraceHandler": True or False, # True if `ftrace` points are present with callbacks pointing to regions that are not in the expected kernel or module code range.
-    "unexpectedInterruptHandler": True or False, # True if interrupt handlers that are are not in the expected kernel or module code regions are present.
-    "unexpectedKernelCodePages": True or False, # True if kernel code pages that are not in the expected kernel or module code regions are present.
-    "unexpectedKprobeHandler": True or False, # True if `kprobe` points are present with callbacks pointing to regions that are not in the expected kernel or module code range.
-    "unexpectedProcessesInRunqueue": True or False, # True if unexpected processes in the scheduler run queue are present. Such processes are in the run queue, but not in the process task list.
-    "unexpectedReadOnlyDataModification": True or False, # True if unexpected modifications of kernel read-only data memory are present.
-    "unexpectedSystemCallHandler": True or False, # True if system call handlers that are are not in the expected kernel or module code regions are present.
-  },
-  "kubernetes": { # Kubernetes-related attributes. # Kubernetes resources associated with the finding.
-    "accessReviews": [ # Provides information on any Kubernetes access reviews (privilege checks) relevant to the finding.
-      { # Conveys information about a Kubernetes access review (such as one returned by a [`kubectl auth can-i`](https://kubernetes.io/docs/reference/access-authn-authz/authorization/#checking-api-access) command) that was involved in a finding.
-        "group": "A String", # The API group of the resource. "*" means all.
-        "name": "A String", # The name of the resource being requested. Empty means all.
-        "ns": "A String", # Namespace of the action being requested. Currently, there is no distinction between no namespace and all namespaces. Both are represented by "" (empty).
-        "resource": "A String", # The optional resource type requested. "*" means all.
-        "subresource": "A String", # The optional subresource type.
-        "verb": "A String", # A Kubernetes resource API verb, like get, list, watch, create, update, delete, proxy. "*" means all.
-        "version": "A String", # The API version of the resource. "*" means all.
+  "job": {
+    "errorCode": 42,
+    "location": "A String",
+    "name": "A String",
+    "state": "A String",
+  },
+  "kernelRootkit": {
+    "name": "A String",
+    "unexpectedCodeModification": True or False,
+    "unexpectedFtraceHandler": True or False,
+    "unexpectedInterruptHandler": True or False,
+    "unexpectedKernelCodePages": True or False,
+    "unexpectedKprobeHandler": True or False,
+    "unexpectedProcessesInRunqueue": True or False,
+    "unexpectedReadOnlyDataModification": True or False,
+    "unexpectedSystemCallHandler": True or False,
+  },
+  "kubernetes": {
+    "accessReviews": [
+      {
+        "group": "A String",
+        "name": "A String",
+        "ns": "A String",
+        "resource": "A String",
+        "subresource": "A String",
+        "verb": "A String",
+        "version": "A String",
       },
     ],
-    "bindings": [ # Provides Kubernetes role binding information for findings that involve [RoleBindings or ClusterRoleBindings](https://cloud.google.com/kubernetes-engine/docs/how-to/role-based-access-control).
-      { # Represents a Kubernetes RoleBinding or ClusterRoleBinding.
-        "name": "A String", # Name for the binding.
-        "ns": "A String", # Namespace for the binding.
-        "role": { # Kubernetes Role or ClusterRole. # The Role or ClusterRole referenced by the binding.
-          "kind": "A String", # Role type.
-          "name": "A String", # Role name.
-          "ns": "A String", # Role namespace.
+    "bindings": [
+      {
+        "name": "A String",
+        "ns": "A String",
+        "role": {
+          "kind": "A String",
+          "name": "A String",
+          "ns": "A String",
         },
-        "subjects": [ # Represents one or more subjects that are bound to the role. Not always available for PATCH requests.
-          { # Represents a Kubernetes subject.
-            "kind": "A String", # Authentication type for the subject.
-            "name": "A String", # Name for the subject.
-            "ns": "A String", # Namespace for the subject.
+        "subjects": [
+          {
+            "kind": "A String",
+            "name": "A String",
+            "ns": "A String",
           },
         ],
       },
     ],
-    "nodePools": [ # GKE [node pools](https://cloud.google.com/kubernetes-engine/docs/concepts/node-pools) associated with the finding. This field contains node pool information for each node, when it is available.
-      { # Provides GKE node pool information.
-        "name": "A String", # Kubernetes node pool name.
-        "nodes": [ # Nodes associated with the finding.
-          { # Kubernetes nodes associated with the finding.
-            "name": "A String", # [Full resource name](https://google.aip.dev/122#full-resource-names) of the Compute Engine VM running the cluster node.
+    "nodePools": [
+      {
+        "name": "A String",
+        "nodes": [
+          {
+            "name": "A String",
           },
         ],
       },
     ],
-    "nodes": [ # Provides Kubernetes [node](https://cloud.google.com/kubernetes-engine/docs/concepts/cluster-architecture#nodes) information.
-      { # Kubernetes nodes associated with the finding.
-        "name": "A String", # [Full resource name](https://google.aip.dev/122#full-resource-names) of the Compute Engine VM running the cluster node.
+    "nodes": [
+      {
+        "name": "A String",
       },
     ],
-    "objects": [ # Kubernetes objects related to the finding.
-      { # Kubernetes object related to the finding, uniquely identified by GKNN. Used if the object Kind is not one of Pod, Node, NodePool, Binding, or AccessReview.
-        "containers": [ # Pod containers associated with this finding, if any.
-          { # Container associated with the finding.
-            "createTime": "A String", # The time that the container was created.
-            "imageId": "A String", # Optional container image ID, if provided by the container runtime. Uniquely identifies the container image launched using a container image digest.
-            "labels": [ # Container labels, as provided by the container runtime.
-              { # Represents a generic name-value label. A label has separate name and value fields to support filtering with the `contains()` function. For more information, see [Filtering on array-type fields](https://cloud.google.com/security-command-center/docs/how-to-api-list-findings#array-contains-filtering).
-                "name": "A String", # Name of the label.
-                "value": "A String", # Value that corresponds to the label's name.
+    "objects": [
+      {
+        "containers": [
+          {
+            "createTime": "A String",
+            "imageId": "A String",
+            "labels": [
+              {
+                "name": "A String",
+                "value": "A String",
               },
             ],
-            "name": "A String", # Name of the container.
-            "uri": "A String", # Container image URI provided when configuring a pod or container. This string can identify a container image version using mutable tags.
+            "name": "A String",
+            "uri": "A String",
           },
         ],
-        "group": "A String", # Kubernetes object group, such as "policy.k8s.io/v1".
-        "kind": "A String", # Kubernetes object kind, such as "Namespace".
-        "name": "A String", # Kubernetes object name. For details see https://kubernetes.io/docs/concepts/overview/working-with-objects/names/.
-        "ns": "A String", # Kubernetes object namespace. Must be a valid DNS label. Named "ns" to avoid collision with C++ namespace keyword. For details see https://kubernetes.io/docs/tasks/administer-cluster/namespaces/.
+        "group": "A String",
+        "kind": "A String",
+        "name": "A String",
+        "ns": "A String",
       },
     ],
-    "pods": [ # Kubernetes [Pods](https://cloud.google.com/kubernetes-engine/docs/concepts/pod) associated with the finding. This field contains Pod records for each container that is owned by a Pod.
-      { # A Kubernetes Pod.
-        "containers": [ # Pod containers associated with this finding, if any.
-          { # Container associated with the finding.
-            "createTime": "A String", # The time that the container was created.
-            "imageId": "A String", # Optional container image ID, if provided by the container runtime. Uniquely identifies the container image launched using a container image digest.
-            "labels": [ # Container labels, as provided by the container runtime.
-              { # Represents a generic name-value label. A label has separate name and value fields to support filtering with the `contains()` function. For more information, see [Filtering on array-type fields](https://cloud.google.com/security-command-center/docs/how-to-api-list-findings#array-contains-filtering).
-                "name": "A String", # Name of the label.
-                "value": "A String", # Value that corresponds to the label's name.
+    "pods": [
+      {
+        "containers": [
+          {
+            "createTime": "A String",
+            "imageId": "A String",
+            "labels": [
+              {
+                "name": "A String",
+                "value": "A String",
               },
             ],
-            "name": "A String", # Name of the container.
-            "uri": "A String", # Container image URI provided when configuring a pod or container. This string can identify a container image version using mutable tags.
+            "name": "A String",
+            "uri": "A String",
           },
         ],
-        "labels": [ # Pod labels. For Kubernetes containers, these are applied to the container.
-          { # Represents a generic name-value label. A label has separate name and value fields to support filtering with the `contains()` function. For more information, see [Filtering on array-type fields](https://cloud.google.com/security-command-center/docs/how-to-api-list-findings#array-contains-filtering).
-            "name": "A String", # Name of the label.
-            "value": "A String", # Value that corresponds to the label's name.
+        "labels": [
+          {
+            "name": "A String",
+            "value": "A String",
           },
         ],
-        "name": "A String", # Kubernetes Pod name.
-        "ns": "A String", # Kubernetes Pod namespace.
+        "name": "A String",
+        "ns": "A String",
       },
     ],
-    "roles": [ # Provides Kubernetes role information for findings that involve [Roles or ClusterRoles](https://cloud.google.com/kubernetes-engine/docs/how-to/role-based-access-control).
-      { # Kubernetes Role or ClusterRole.
-        "kind": "A String", # Role type.
-        "name": "A String", # Role name.
-        "ns": "A String", # Role namespace.
+    "roles": [
+      {
+        "kind": "A String",
+        "name": "A String",
+        "ns": "A String",
       },
     ],
   },
-  "loadBalancers": [ # The load balancers associated with the finding.
-    { # Contains information related to the load balancer associated with the finding.
-      "name": "A String", # The name of the load balancer associated with the finding.
+  "loadBalancers": [
+    {
+      "name": "A String",
     },
   ],
-  "logEntries": [ # Log entries that are relevant to the finding.
-    { # An individual entry in a log.
-      "cloudLoggingEntry": { # Metadata taken from a [Cloud Logging LogEntry](https://cloud.google.com/logging/docs/reference/v2/rest/v2/LogEntry) # An individual entry in a log stored in Cloud Logging.
-        "insertId": "A String", # A unique identifier for the log entry.
-        "logId": "A String", # The type of the log (part of `log_name`. `log_name` is the resource name of the log to which this log entry belongs). For example: `cloudresourcemanager.googleapis.com/activity`. Note that this field is not URL-encoded, unlike the `LOG_ID` field in `LogEntry`.
-        "resourceContainer": "A String", # The organization, folder, or project of the monitored resource that produced this log entry.
-        "timestamp": "A String", # The time the event described by the log entry occurred.
+  "logEntries": [
+    {
+      "cloudLoggingEntry": {
+        "insertId": "A String",
+        "logId": "A String",
+        "resourceContainer": "A String",
+        "timestamp": "A String",
       },
     },
   ],
-  "mitreAttack": { # MITRE ATT&CK tactics and techniques related to this finding. See: https://attack.mitre.org # MITRE ATT&CK tactics and techniques related to this finding. See: https://attack.mitre.org
-    "additionalTactics": [ # Additional MITRE ATT&CK tactics related to this finding, if any.
+  "mitreAttack": {
+    "additionalTactics": [
       "A String",
     ],
-    "additionalTechniques": [ # Additional MITRE ATT&CK techniques related to this finding, if any, along with any of their respective parent techniques.
+    "additionalTechniques": [
       "A String",
     ],
-    "primaryTactic": "A String", # The MITRE ATT&CK tactic most closely represented by this finding, if any.
-    "primaryTechniques": [ # The MITRE ATT&CK technique most closely represented by this finding, if any. primary_techniques is a repeated field because there are multiple levels of MITRE ATT&CK techniques. If the technique most closely represented by this finding is a sub-technique (e.g. `SCANNING_IP_BLOCKS`), both the sub-technique and its parent technique(s) will be listed (e.g. `SCANNING_IP_BLOCKS`, `ACTIVE_SCANNING`).
+    "primaryTactic": "A String",
+    "primaryTechniques": [
       "A String",
     ],
-    "version": "A String", # The MITRE ATT&CK version referenced by the above fields. E.g. "8".
+    "version": "A String",
   },
-  "moduleName": "A String", # Unique identifier of the module which generated the finding. Example: folders/598186756061/securityHealthAnalyticsSettings/customModules/56799441161885
-  "mute": "A String", # Indicates the mute state of a finding (either muted, unmuted or undefined). Unlike other attributes of a finding, a finding provider shouldn't set the value of mute.
-  "muteInfo": { # Mute information about the finding, including whether the finding has a static mute or any matching dynamic mute rules. # Output only. The mute information regarding this finding.
-    "dynamicMuteRecords": [ # The list of dynamic mute rules that currently match the finding.
-      { # The record of a dynamic mute rule that matches the finding.
-        "matchTime": "A String", # When the dynamic mute rule first matched the finding.
-        "muteConfig": "A String", # The relative resource name of the mute rule, represented by a mute config, that created this record, for example `organizations/123/muteConfigs/mymuteconfig` or `organizations/123/locations/global/muteConfigs/mymuteconfig`.
+  "moduleName": "A String",
+  "mute": "A String",
+  "muteInfo": {
+    "dynamicMuteRecords": [
+      {
+        "matchTime": "A String",
+        "muteConfig": "A String",
       },
     ],
-    "staticMute": { # Information about the static mute state. A static mute state overrides any dynamic mute rules that apply to this finding. The static mute state can be set by a static mute rule or by muting the finding directly. # If set, the static mute applied to this finding. Static mutes override dynamic mutes. If unset, there is no static mute.
-      "applyTime": "A String", # When the static mute was applied.
-      "state": "A String", # The static mute state. If the value is `MUTED` or `UNMUTED`, then the finding's overall mute state will have the same value.
+    "staticMute": {
+      "applyTime": "A String",
+      "state": "A String",
     },
   },
-  "muteInitiator": "A String", # Records additional information about the mute operation, for example, the [mute configuration](/security-command-center/docs/how-to-mute-findings) that muted the finding and the user who muted the finding.
-  "muteUpdateTime": "A String", # Output only. The most recent time this finding was muted or unmuted.
-  "name": "A String", # The [relative resource name](https://cloud.google.com/apis/design/resource_names#relative_resource_name) of the finding. Example: "organizations/{organization_id}/sources/{source_id}/findings/{finding_id}", "folders/{folder_id}/sources/{source_id}/findings/{finding_id}", "projects/{project_id}/sources/{source_id}/findings/{finding_id}".
-  "networks": [ # Represents the VPC networks that the resource is attached to.
-    { # Contains information about a VPC network associated with the finding.
-      "name": "A String", # The name of the VPC network resource, for example, `//compute.googleapis.com/projects/my-project/global/networks/my-network`.
+  "muteInitiator": "A String",
+  "muteUpdateTime": "A String",
+  "name": "A String",
+  "networks": [
+    {
+      "name": "A String",
     },
   ],
-  "nextSteps": "A String", # Steps to address the finding.
-  "notebook": { # Represents a Jupyter notebook IPYNB file, such as a [Colab Enterprise notebook](https://cloud.google.com/colab/docs/introduction) file, that is associated with a finding. # Notebook associated with the finding.
-    "lastAuthor": "A String", # The user ID of the latest author to modify the notebook.
-    "name": "A String", # The name of the notebook.
-    "notebookUpdateTime": "A String", # The most recent time the notebook was updated.
-    "service": "A String", # The source notebook service, for example, "Colab Enterprise".
+  "nextSteps": "A String",
+  "notebook": {
+    "lastAuthor": "A String",
+    "name": "A String",
+    "notebookUpdateTime": "A String",
+    "service": "A String",
   },
-  "orgPolicies": [ # Contains information about the org policies associated with the finding.
-    { # Contains information about the org policies associated with the finding.
-      "name": "A String", # The resource name of the org policy. Example: "organizations/{organization_id}/policies/{constraint_name}"
+  "orgPolicies": [
+    {
+      "name": "A String",
     },
   ],
-  "parent": "A String", # The relative resource name of the source the finding belongs to. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name This field is immutable after creation time. For example: "organizations/{organization_id}/sources/{source_id}"
-  "parentDisplayName": "A String", # Output only. The human readable display name of the finding source such as "Event Threat Detection" or "Security Health Analytics".
-  "policyViolationSummary": { # Metadata summarizing policy violations of child resources of the affected resource. `finding_category` and `resource` determine the exact semantics of the counts. For example, when category=DATA_SECURITY_POSTURE_OBJECT_PUBLIC_ACCESS_VIOLATION and resource='storage.googleapis.com/buckets/my-bucket-name' then this counts the number of Cloud Storage objects in my-bucket-name which violate a Public Access control. # PolicyViolationSummary associated with the finding.
-    "conformantResourcesCount": "A String", # Total number of child resources that conform to the policy.
-    "evaluationErrorsCount": "A String", # Number of child resources for which errors during evaluation occurred. The evaluation result for these child resources is effectively "unknown".
-    "outOfScopeResourcesCount": "A String", # Total count of child resources which were not in scope for evaluation.
-    "policyViolationsCount": "A String", # Count of child resources in violation of the policy.
-  },
-  "processes": [ # Represents operating system processes associated with the Finding.
-    { # Represents an operating system process.
-      "args": [ # Process arguments as JSON encoded strings.
+  "parent": "A String",
+  "parentDisplayName": "A String",
+  "policyViolationSummary": {
+    "conformantResourcesCount": "A String",
+    "evaluationErrorsCount": "A String",
+    "outOfScopeResourcesCount": "A String",
+    "policyViolationsCount": "A String",
+  },
+  "processes": [
+    {
+      "args": [
         "A String",
       ],
-      "argumentsTruncated": True or False, # True if `args` is incomplete.
-      "binary": { # File information about the related binary/library used by an executable, or the script used by a script interpreter # File information for the process executable.
-        "contents": "A String", # Prefix of the file contents as a JSON-encoded string.
-        "diskPath": { # Path of the file in terms of underlying disk/partition identifiers. # Path of the file in terms of underlying disk/partition identifiers.
-          "partitionUuid": "A String", # UUID of the partition (format https://wiki.archlinux.org/title/persistent_block_device_naming#by-uuid)
-          "relativePath": "A String", # Relative path of the file in the partition as a JSON encoded string. Example: /home/user1/executable_file.sh
+      "argumentsTruncated": True or False,
+      "binary": {
+        "contents": "A String",
+        "diskPath": {
+          "partitionUuid": "A String",
+          "relativePath": "A String",
         },
-        "fileLoadState": "A String", # The load state of the file.
-        "hashedSize": "A String", # The length in bytes of the file prefix that was hashed. If hashed_size == size, any hashes reported represent the entire file.
-        "operations": [ # Operation(s) performed on a file.
-          { # Operation(s) performed on a file.
-            "type": "A String", # The type of the operation
+        "fileLoadState": "A String",
+        "hashedSize": "A String",
+        "operations": [
+          {
+            "type": "A String",
           },
         ],
-        "partiallyHashed": True or False, # True when the hash covers only a prefix of the file.
-        "path": "A String", # Absolute path of the file as a JSON encoded string.
-        "sha256": "A String", # SHA256 hash of the first hashed_size bytes of the file encoded as a hex string. If hashed_size == size, sha256 represents the SHA256 hash of the entire file.
-        "size": "A String", # Size of the file in bytes.
+        "partiallyHashed": True or False,
+        "path": "A String",
+        "sha256": "A String",
+        "size": "A String",
       },
-      "envVariables": [ # Process environment variables.
-        { # A name-value pair representing an environment variable used in an operating system process.
-          "name": "A String", # Environment variable name as a JSON encoded string.
-          "val": "A String", # Environment variable value as a JSON encoded string.
+      "envVariables": [
+        {
+          "name": "A String",
+          "val": "A String",
         },
       ],
-      "envVariablesTruncated": True or False, # True if `env_variables` is incomplete.
-      "libraries": [ # File information for libraries loaded by the process.
-        { # File information about the related binary/library used by an executable, or the script used by a script interpreter
-          "contents": "A String", # Prefix of the file contents as a JSON-encoded string.
-          "diskPath": { # Path of the file in terms of underlying disk/partition identifiers. # Path of the file in terms of underlying disk/partition identifiers.
-            "partitionUuid": "A String", # UUID of the partition (format https://wiki.archlinux.org/title/persistent_block_device_naming#by-uuid)
-            "relativePath": "A String", # Relative path of the file in the partition as a JSON encoded string. Example: /home/user1/executable_file.sh
+      "envVariablesTruncated": True or False,
+      "libraries": [
+        {
+          "contents": "A String",
+          "diskPath": {
+            "partitionUuid": "A String",
+            "relativePath": "A String",
           },
-          "fileLoadState": "A String", # The load state of the file.
-          "hashedSize": "A String", # The length in bytes of the file prefix that was hashed. If hashed_size == size, any hashes reported represent the entire file.
-          "operations": [ # Operation(s) performed on a file.
-            { # Operation(s) performed on a file.
-              "type": "A String", # The type of the operation
+          "fileLoadState": "A String",
+          "hashedSize": "A String",
+          "operations": [
+            {
+              "type": "A String",
             },
           ],
-          "partiallyHashed": True or False, # True when the hash covers only a prefix of the file.
-          "path": "A String", # Absolute path of the file as a JSON encoded string.
-          "sha256": "A String", # SHA256 hash of the first hashed_size bytes of the file encoded as a hex string. If hashed_size == size, sha256 represents the SHA256 hash of the entire file.
-          "size": "A String", # Size of the file in bytes.
+          "partiallyHashed": True or False,
+          "path": "A String",
+          "sha256": "A String",
+          "size": "A String",
         },
       ],
-      "name": "A String", # The process name, as displayed in utilities like `top` and `ps`. This name can be accessed through `/proc/[pid]/comm` and changed with `prctl(PR_SET_NAME)`.
-      "parentPid": "A String", # The parent process ID.
-      "pid": "A String", # The process ID.
-      "script": { # File information about the related binary/library used by an executable, or the script used by a script interpreter # When the process represents the invocation of a script, `binary` provides information about the interpreter, while `script` provides information about the script file provided to the interpreter.
-        "contents": "A String", # Prefix of the file contents as a JSON-encoded string.
-        "diskPath": { # Path of the file in terms of underlying disk/partition identifiers. # Path of the file in terms of underlying disk/partition identifiers.
-          "partitionUuid": "A String", # UUID of the partition (format https://wiki.archlinux.org/title/persistent_block_device_naming#by-uuid)
-          "relativePath": "A String", # Relative path of the file in the partition as a JSON encoded string. Example: /home/user1/executable_file.sh
+      "name": "A String",
+      "parentPid": "A String",
+      "pid": "A String",
+      "script": {
+        "contents": "A String",
+        "diskPath": {
+          "partitionUuid": "A String",
+          "relativePath": "A String",
         },
-        "fileLoadState": "A String", # The load state of the file.
-        "hashedSize": "A String", # The length in bytes of the file prefix that was hashed. If hashed_size == size, any hashes reported represent the entire file.
-        "operations": [ # Operation(s) performed on a file.
-          { # Operation(s) performed on a file.
-            "type": "A String", # The type of the operation
+        "fileLoadState": "A String",
+        "hashedSize": "A String",
+        "operations": [
+          {
+            "type": "A String",
           },
         ],
-        "partiallyHashed": True or False, # True when the hash covers only a prefix of the file.
-        "path": "A String", # Absolute path of the file as a JSON encoded string.
-        "sha256": "A String", # SHA256 hash of the first hashed_size bytes of the file encoded as a hex string. If hashed_size == size, sha256 represents the SHA256 hash of the entire file.
-        "size": "A String", # Size of the file in bytes.
+        "partiallyHashed": True or False,
+        "path": "A String",
+        "sha256": "A String",
+        "size": "A String",
       },
-      "userId": "A String", # The ID of the user that executed the process. E.g. If this is the root user this will always be 0.
+      "userId": "A String",
     },
   ],
-  "resourceName": "A String", # For findings on Google Cloud resources, the full resource name of the Google Cloud resource this finding is for. See: https://cloud.google.com/apis/design/resource_names#full_resource_name When the finding is for a non-Google Cloud resource, the resourceName can be a customer or partner defined string. This field is immutable after creation time.
-  "secret": { # Details about a secret or credential associated with the finding. # Secret associated with the finding.
-    "environmentVariable": { # Environment variable containing the secret. # The environment variable containing the secret.
-      "key": "A String", # Environment variable name as a JSON encoded string. Note that value is not included since the value contains the secret data, which is sensitive core content.
+  "resourceName": "A String",
+  "secret": {
+    "environmentVariable": {
+      "key": "A String",
     },
-    "filePath": { # File path containing the secret. # The file containing the secret.
-      "path": "A String", # Path to the file.
+    "filePath": {
+      "path": "A String",
     },
-    "status": { # The status of the secret. # The status of the secret.
-      "lastUpdatedTime": "A String", # Time that the secret was found.
-      "validity": "A String", # The validity of the secret.
+    "status": {
+      "lastUpdatedTime": "A String",
+      "validity": "A String",
     },
-    "type": "A String", # The type of secret, for example, GCP_API_KEY.
+    "type": "A String",
   },
-  "securityMarks": { # User specified security marks that are attached to the parent Security Command Center resource. Security marks are scoped within a Security Command Center organization -- they can be modified and viewed by all users who have proper permissions on the organization. # Output only. User specified security marks. These marks are entirely managed by the user and come from the SecurityMarks resource that belongs to the finding.
-    "canonicalName": "A String", # The canonical name of the marks. Examples: "organizations/{organization_id}/assets/{asset_id}/securityMarks" "folders/{folder_id}/assets/{asset_id}/securityMarks" "projects/{project_number}/assets/{asset_id}/securityMarks" "organizations/{organization_id}/sources/{source_id}/findings/{finding_id}/securityMarks" "folders/{folder_id}/sources/{source_id}/findings/{finding_id}/securityMarks" "projects/{project_number}/sources/{source_id}/findings/{finding_id}/securityMarks"
-    "marks": { # Mutable user specified security marks belonging to the parent resource. Constraints are as follows: * Keys and values are treated as case insensitive * Keys must be between 1 - 256 characters (inclusive) * Keys must be letters, numbers, underscores, or dashes * Values have leading and trailing whitespace trimmed, remaining characters must be between 1 - 4096 characters (inclusive)
+  "securityMarks": {
+    "canonicalName": "A String",
+    "marks": {
       "a_key": "A String",
     },
-    "name": "A String", # The relative resource name of the SecurityMarks. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Examples: "organizations/{organization_id}/assets/{asset_id}/securityMarks" "organizations/{organization_id}/sources/{source_id}/findings/{finding_id}/securityMarks".
-  },
-  "securityPosture": { # Represents a posture that is deployed on Google Cloud by the Security Command Center Posture Management service. A posture contains one or more policy sets. A policy set is a group of policies that enforce a set of security rules on Google Cloud. # The security posture associated with the finding.
-    "changedPolicy": "A String", # The name of the updated policy, for example, `projects/{project_id}/policies/{constraint_name}`.
-    "name": "A String", # Name of the posture, for example, `CIS-Posture`.
-    "policy": "A String", # The ID of the updated policy, for example, `compute-policy-1`.
-    "policyDriftDetails": [ # The details about a change in an updated policy that violates the deployed posture.
-      { # The policy field that violates the deployed posture and its expected and detected values.
-        "detectedValue": "A String", # The detected value that violates the deployed posture, for example, `false` or `allowed_values={"projects/22831892"}`.
-        "expectedValue": "A String", # The value of this field that was configured in a posture, for example, `true` or `allowed_values={"projects/29831892"}`.
-        "field": "A String", # The name of the updated field, for example constraint.implementation.policy_rules[0].enforce
+    "name": "A String",
+  },
+  "securityPosture": {
+    "changedPolicy": "A String",
+    "name": "A String",
+    "policy": "A String",
+    "policyDriftDetails": [
+      {
+        "detectedValue": "A String",
+        "expectedValue": "A String",
+        "field": "A String",
       },
     ],
-    "policySet": "A String", # The name of the updated policyset, for example, `cis-policyset`.
-    "postureDeployment": "A String", # The name of the posture deployment, for example, `organizations/{org_id}/posturedeployments/{posture_deployment_id}`.
-    "postureDeploymentResource": "A String", # The project, folder, or organization on which the posture is deployed, for example, `projects/{project_number}`.
-    "revisionId": "A String", # The version of the posture, for example, `c7cfa2a8`.
+    "policySet": "A String",
+    "postureDeployment": "A String",
+    "postureDeploymentResource": "A String",
+    "revisionId": "A String",
   },
-  "severity": "A String", # The severity of the finding. This field is managed by the source that writes the finding.
-  "sourceProperties": { # Source specific properties. These properties are managed by the source that writes the finding. The key names in the source_properties map must be between 1 and 255 characters, and must start with a letter and contain alphanumeric characters or underscores only.
+  "severity": "A String",
+  "sourceProperties": {
     "a_key": "",
   },
-  "state": "A String", # The state of the finding.
-  "toxicCombination": { # Contains details about a group of security issues that, when the issues occur together, represent a greater risk than when the issues occur independently. A group of such issues is referred to as a toxic combination. # Contains details about a group of security issues that, when the issues occur together, represent a greater risk than when the issues occur independently. A group of such issues is referred to as a toxic combination. This field cannot be updated. Its value is ignored in all update requests.
-    "attackExposureScore": 3.14, # The [Attack exposure score](https://cloud.google.com/security-command-center/docs/attack-exposure-learn#attack_exposure_scores) of this toxic combination. The score is a measure of how much this toxic combination exposes one or more high-value resources to potential attack.
-    "relatedFindings": [ # List of resource names of findings associated with this toxic combination. For example, `organizations/123/sources/456/findings/789`.
+  "state": "A String",
+  "toxicCombination": {
+    "attackExposureScore": 3.14,
+    "relatedFindings": [
       "A String",
     ],
   },
-  "vertexAi": { # Vertex AI-related information associated with the finding. # VertexAi associated with the finding.
-    "datasets": [ # Datasets associated with the finding.
-      { # Vertex AI dataset associated with the finding.
-        "displayName": "A String", # The user defined display name of dataset, e.g. plants-dataset
-        "name": "A String", # Resource name of the dataset, e.g. projects/{project}/locations/{location}/datasets/2094040236064505856
-        "source": "A String", # Data source, such as BigQuery source URI, e.g. bq://scc-nexus-test.AIPPtest.gsod
+  "vertexAi": {
+    "datasets": [
+      {
+        "displayName": "A String",
+        "name": "A String",
+        "source": "A String",
       },
     ],
-    "pipelines": [ # Pipelines associated with the finding.
-      { # Vertex AI training pipeline associated with the finding.
-        "displayName": "A String", # The user defined display name of pipeline, e.g. plants-classification
-        "name": "A String", # Resource name of the pipeline, e.g. projects/{project}/locations/{location}/trainingPipelines/5253428229225578496
+    "pipelines": [
+      {
+        "displayName": "A String",
+        "name": "A String",
       },
     ],
   },
-  "vulnerability": { # Refers to common vulnerability fields e.g. cve, cvss, cwe etc. # Represents vulnerability-specific fields like CVE and CVSS scores. CVE stands for Common Vulnerabilities and Exposures (https://cve.mitre.org/about/)
-    "cve": { # CVE stands for Common Vulnerabilities and Exposures. Information from the [CVE record](https://www.cve.org/ResourcesSupport/Glossary) that describes this vulnerability. # CVE stands for Common Vulnerabilities and Exposures (https://cve.mitre.org/about/)
-      "cvssv3": { # Common Vulnerability Scoring System version 3. # Describe Common Vulnerability Scoring System specified at https://www.first.org/cvss/v3.1/specification-document
-        "attackComplexity": "A String", # This metric describes the conditions beyond the attacker's control that must exist in order to exploit the vulnerability.
-        "attackVector": "A String", # Base Metrics Represents the intrinsic characteristics of a vulnerability that are constant over time and across user environments. This metric reflects the context by which vulnerability exploitation is possible.
-        "availabilityImpact": "A String", # This metric measures the impact to the availability of the impacted component resulting from a successfully exploited vulnerability.
-        "baseScore": 3.14, # The base score is a function of the base metric scores.
-        "confidentialityImpact": "A String", # This metric measures the impact to the confidentiality of the information resources managed by a software component due to a successfully exploited vulnerability.
-        "integrityImpact": "A String", # This metric measures the impact to integrity of a successfully exploited vulnerability.
-        "privilegesRequired": "A String", # This metric describes the level of privileges an attacker must possess before successfully exploiting the vulnerability.
-        "scope": "A String", # The Scope metric captures whether a vulnerability in one vulnerable component impacts resources in components beyond its security scope.
-        "userInteraction": "A String", # This metric captures the requirement for a human user, other than the attacker, to participate in the successful compromise of the vulnerable component.
+  "vulnerability": {
+    "cve": {
+      "cvssv3": {
+        "attackComplexity": "A String",
+        "attackVector": "A String",
+        "availabilityImpact": "A String",
+        "baseScore": 3.14,
+        "confidentialityImpact": "A String",
+        "integrityImpact": "A String",
+        "privilegesRequired": "A String",
+        "scope": "A String",
+        "userInteraction": "A String",
       },
-      "exploitReleaseDate": "A String", # Date the first publicly available exploit or PoC was released.
-      "exploitationActivity": "A String", # The exploitation activity of the vulnerability in the wild.
-      "firstExploitationDate": "A String", # Date of the earliest known exploitation.
-      "id": "A String", # The unique identifier for the vulnerability. e.g. CVE-2021-34527
-      "impact": "A String", # The potential impact of the vulnerability if it was to be exploited.
-      "observedInTheWild": True or False, # Whether or not the vulnerability has been observed in the wild.
-      "references": [ # Additional information about the CVE. e.g. https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2021-34527
-        { # Additional Links
-          "source": "A String", # Source of the reference e.g. NVD
-          "uri": "A String", # Uri for the mentioned source e.g. https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2021-34527.
+      "exploitReleaseDate": "A String",
+      "exploitationActivity": "A String",
+      "firstExploitationDate": "A String",
+      "id": "A String",
+      "impact": "A String",
+      "observedInTheWild": True or False,
+      "references": [
+        {
+          "source": "A String",
+          "uri": "A String",
         },
       ],
-      "upstreamFixAvailable": True or False, # Whether upstream fix is available for the CVE.
-      "zeroDay": True or False, # Whether or not the vulnerability was zero day when the finding was published.
-    },
-    "cwes": [ # Represents one or more Common Weakness Enumeration (CWE) information on this vulnerability.
-      { # CWE stands for Common Weakness Enumeration. Information about this weakness, as described by [CWE](https://cwe.mitre.org/).
-        "id": "A String", # The CWE identifier, e.g. CWE-94
-        "references": [ # Any reference to the details on the CWE, for example, https://cwe.mitre.org/data/definitions/94.html
-          { # Additional Links
-            "source": "A String", # Source of the reference e.g. NVD
-            "uri": "A String", # Uri for the mentioned source e.g. https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2021-34527.
+      "upstreamFixAvailable": True or False,
+      "zeroDay": True or False,
+    },
+    "cwes": [
+      {
+        "id": "A String",
+        "references": [
+          {
+            "source": "A String",
+            "uri": "A String",
           },
         ],
       },
     ],
-    "fixedPackage": { # Package is a generic definition of a package. # The fixed package is relevant to the finding.
-      "cpeUri": "A String", # The CPE URI where the vulnerability was detected.
-      "packageName": "A String", # The name of the package where the vulnerability was detected.
-      "packageType": "A String", # Type of package, for example, os, maven, or go.
-      "packageVersion": "A String", # The version of the package.
+    "fixedPackage": {
+      "cpeUri": "A String",
+      "packageName": "A String",
+      "packageType": "A String",
+      "packageVersion": "A String",
     },
-    "offendingPackage": { # Package is a generic definition of a package. # The offending package is relevant to the finding.
-      "cpeUri": "A String", # The CPE URI where the vulnerability was detected.
-      "packageName": "A String", # The name of the package where the vulnerability was detected.
-      "packageType": "A String", # Type of package, for example, os, maven, or go.
-      "packageVersion": "A String", # The version of the package.
+    "offendingPackage": {
+      "cpeUri": "A String",
+      "packageName": "A String",
+      "packageType": "A String",
+      "packageVersion": "A String",
     },
-    "providerRiskScore": "A String", # Provider provided risk_score based on multiple factors. The higher the risk score, the more risky the vulnerability is.
-    "reachable": True or False, # Represents whether the vulnerability is reachable (detected via static analysis)
-    "securityBulletin": { # SecurityBulletin are notifications of vulnerabilities of Google products. # The security bulletin is relevant to this finding.
-      "bulletinId": "A String", # ID of the bulletin corresponding to the vulnerability.
-      "submissionTime": "A String", # Submission time of this Security Bulletin.
-      "suggestedUpgradeVersion": "A String", # This represents a version that the cluster receiving this notification should be upgraded to, based on its current version. For example, 1.15.0
+    "providerRiskScore": "A String",
+    "reachable": True or False,
+    "securityBulletin": {
+      "bulletinId": "A String",
+      "submissionTime": "A String",
+      "suggestedUpgradeVersion": "A String",
     },
   },
 }
 
-  updateMask: string, The FieldMask to use when updating the finding resource. This field should not be specified when creating a finding. When updating a finding, an empty mask is treated as updating all mutable fields and replacing source_properties. Individual source_properties can be added/updated by using "source_properties." in the field mask.
+  updateMask: string, A parameter
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -1971,811 +1971,811 @@ 

Method Details

Returns: An object of the form: - { # Security Command Center finding. A finding is a record of assessment data like security, risk, health, or privacy, that is ingested into Security Command Center for presentation, notification, analysis, policy testing, and enforcement. For example, a cross-site scripting (XSS) vulnerability in an App Engine application is a finding. - "access": { # Represents an access event. # Access details associated with the finding, such as more information on the caller, which method was accessed, and from where. - "callerIp": "A String", # Caller's IP address, such as "1.1.1.1". - "callerIpGeo": { # Represents a geographical location for a given access. # The caller IP's geolocation, which identifies where the call came from. - "regionCode": "A String", # A CLDR. - }, - "methodName": "A String", # The method that the service account called, e.g. "SetIamPolicy". - "principalEmail": "A String", # Associated email, such as "foo@google.com". The email address of the authenticated user or a service account acting on behalf of a 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). - "principalSubject": "A String", # A string that represents the principal_subject that is associated with the identity. Unlike `principal_email`, `principal_subject` supports principals that aren't associated with email addresses, such as third party principals. For most identities, the format is `principal://iam.googleapis.com/{identity pool name}/subject/{subject}`. Some GKE identities, such as GKE_WORKLOAD, FREEFORM, and GKE_HUB_WORKLOAD, still use the legacy format `serviceAccount:{identity pool name}[{subject}]`. - "serviceAccountDelegationInfo": [ # The identity delegation history of an authenticated service account that made the request. The `serviceAccountDelegationInfo[]` object contains information about the real authorities that try to access Google Cloud resources by delegating on a service account. When multiple authorities are present, they are guaranteed to be sorted based on the original ordering of the identity delegation events. - { # Identity delegation history of an authenticated service account. - "principalEmail": "A String", # The email address of a Google account. - "principalSubject": "A String", # A string representing the principal_subject associated with the identity. As compared to `principal_email`, supports principals that aren't associated with email addresses, such as third party principals. For most identities, the format will be `principal://iam.googleapis.com/{identity pool name}/subjects/{subject}` except for some GKE identities (GKE_WORKLOAD, FREEFORM, GKE_HUB_WORKLOAD) that are still in the legacy format `serviceAccount:{identity pool name}[{subject}]` + { + "access": { + "callerIp": "A String", + "callerIpGeo": { + "regionCode": "A String", + }, + "methodName": "A String", + "principalEmail": "A String", + "principalSubject": "A String", + "serviceAccountDelegationInfo": [ + { + "principalEmail": "A String", + "principalSubject": "A String", }, ], - "serviceAccountKeyName": "A String", # The name of the service account key that was used to create or exchange credentials when authenticating the service account that made the request. This is a scheme-less URI full resource name. For example: "//iam.googleapis.com/projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}/keys/{key}". - "serviceName": "A String", # This is the API service that the service account made a call to, e.g. "iam.googleapis.com" - "userAgent": "A String", # The caller's user agent string associated with the finding. - "userAgentFamily": "A String", # Type of user agent associated with the finding. For example, an operating system shell or an embedded or standalone application. - "userName": "A String", # A string that represents a username. The username provided depends on the type of the finding and is likely not an IAM principal. For example, this can be a system username if the finding is related to a virtual machine, or it can be an application login username. + "serviceAccountKeyName": "A String", + "serviceName": "A String", + "userAgent": "A String", + "userAgentFamily": "A String", + "userName": "A String", }, - "affectedResources": { # Details about resources affected by this finding. # AffectedResources associated with the finding. - "count": "A String", # The count of resources affected by the finding. + "affectedResources": { + "count": "A String", }, - "agentDataAccessEvents": [ # Agent data access events associated with the finding. - { # Details about a data access attempt made by an agent principal not authorized under applicable data security policy. - "eventId": "A String", # Unique identifier for data access event. - "eventTime": "A String", # Timestamp of data access event. - "operation": "A String", # The operation performed by the principal to access the data. - "principalSubject": "A String", # The agent principal that accessed the data. + "agentDataAccessEvents": [ + { + "eventId": "A String", + "eventTime": "A String", + "operation": "A String", + "principalSubject": "A String", }, ], - "aiModel": { # Contains information about the AI model associated with the finding. # The AI model associated with the finding. - "deploymentPlatform": "A String", # The platform on which the model is deployed. - "displayName": "A String", # The user defined display name of model. Ex. baseline-classification-model - "domain": "A String", # The domain of the model, for example, “image-classification”. - "library": "A String", # The name of the model library, for example, “transformers”. - "location": "A String", # The region in which the model is used, for example, “us-central1”. - "name": "A String", # The name of the AI model, for example, "gemini:1.0.0". - "publisher": "A String", # The publisher of the model, for example, “google” or “nvidia”. - "usageCategory": "A String", # The purpose of the model, for example, "Inteference" or "Training". - }, - "application": { # Represents an application associated with a finding. # Represents an application associated with the finding. - "baseUri": "A String", # The base URI that identifies the network location of the application in which the vulnerability was detected. For example, `http://example.com`. - "fullUri": "A String", # The full URI with payload that can be used to reproduce the vulnerability. For example, `http://example.com?p=aMmYgI6H`. - }, - "artifactGuardPolicies": { # Represents the result of evaluating artifact guard policies. # ArtifactGuardPolicies associated with the finding. - "failingPolicies": [ # A list of failing policies. - { # Represents an artifact guard policy. - "failureReason": "A String", # The reason for the policy failure, for example, "severity=HIGH AND max_vuln_count=2". - "policyId": "A String", # The ID of the failing policy, for example, "organizations/3392779/locations/global/policies/prod-policy". - "type": "A String", # The type of the policy evaluation. + "aiModel": { + "deploymentPlatform": "A String", + "displayName": "A String", + "domain": "A String", + "library": "A String", + "location": "A String", + "name": "A String", + "publisher": "A String", + "usageCategory": "A String", + }, + "application": { + "baseUri": "A String", + "fullUri": "A String", + }, + "artifactGuardPolicies": { + "failingPolicies": [ + { + "failureReason": "A String", + "policyId": "A String", + "type": "A String", }, ], - "resourceId": "A String", # The ID of the resource that has policies configured for it. + "resourceId": "A String", }, - "attackExposure": { # An attack exposure contains the results of an attack path simulation run. # The results of an attack path simulation relevant to this finding. - "attackExposureResult": "A String", # The resource name of the attack path simulation result that contains the details regarding this attack exposure score. Example: `organizations/123/simulations/456/attackExposureResults/789` - "exposedHighValueResourcesCount": 42, # The number of high value resources that are exposed as a result of this finding. - "exposedLowValueResourcesCount": 42, # The number of high value resources that are exposed as a result of this finding. - "exposedMediumValueResourcesCount": 42, # The number of medium value resources that are exposed as a result of this finding. - "latestCalculationTime": "A String", # The most recent time the attack exposure was updated on this finding. - "score": 3.14, # A number between 0 (inclusive) and infinity that represents how important this finding is to remediate. The higher the score, the more important it is to remediate. - "state": "A String", # What state this AttackExposure is in. This captures whether or not an attack exposure has been calculated or not. + "attackExposure": { + "attackExposureResult": "A String", + "exposedHighValueResourcesCount": 42, + "exposedLowValueResourcesCount": 42, + "exposedMediumValueResourcesCount": 42, + "latestCalculationTime": "A String", + "score": 3.14, + "state": "A String", }, - "backupDisasterRecovery": { # Information related to Google Cloud Backup and DR Service findings. # Fields related to Backup and DR findings. - "appliance": "A String", # The name of the Backup and DR appliance that captures, moves, and manages the lifecycle of backup data. For example, `backup-server-57137`. - "applications": [ # The names of Backup and DR applications. An application is a VM, database, or file system on a managed host monitored by a backup and recovery appliance. For example, `centos7-01-vol00`, `centos7-01-vol01`, `centos7-01-vol02`. + "backupDisasterRecovery": { + "appliance": "A String", + "applications": [ "A String", ], - "backupCreateTime": "A String", # The timestamp at which the Backup and DR backup was created. - "backupTemplate": "A String", # The name of a Backup and DR template which comprises one or more backup policies. See the [Backup and DR documentation](https://cloud.google.com/backup-disaster-recovery/docs/concepts/backup-plan#temp) for more information. For example, `snap-ov`. - "backupType": "A String", # The backup type of the Backup and DR image. For example, `Snapshot`, `Remote Snapshot`, `OnVault`. - "host": "A String", # The name of a Backup and DR host, which is managed by the backup and recovery appliance and known to the management console. The host can be of type Generic (for example, Compute Engine, SQL Server, Oracle DB, SMB file system, etc.), vCenter, or an ESX server. See the [Backup and DR documentation on hosts](https://cloud.google.com/backup-disaster-recovery/docs/configuration/manage-hosts-and-their-applications) for more information. For example, `centos7-01`. - "policies": [ # The names of Backup and DR policies that are associated with a template and that define when to run a backup, how frequently to run a backup, and how long to retain the backup image. For example, `onvaults`. + "backupCreateTime": "A String", + "backupTemplate": "A String", + "backupType": "A String", + "host": "A String", + "policies": [ "A String", ], - "policyOptions": [ # The names of Backup and DR advanced policy options of a policy applying to an application. See the [Backup and DR documentation on policy options](https://cloud.google.com/backup-disaster-recovery/docs/create-plan/policy-settings). For example, `skipofflineappsincongrp, nounmap`. + "policyOptions": [ "A String", ], - "profile": "A String", # The name of the Backup and DR resource profile that specifies the storage media for backups of application and VM data. See the [Backup and DR documentation on profiles](https://cloud.google.com/backup-disaster-recovery/docs/concepts/backup-plan#profile). For example, `GCP`. - "storagePool": "A String", # The name of the Backup and DR storage pool that the backup and recovery appliance is storing data in. The storage pool could be of type Cloud, Primary, Snapshot, or OnVault. See the [Backup and DR documentation on storage pools](https://cloud.google.com/backup-disaster-recovery/docs/concepts/storage-pools). For example, `DiskPoolOne`. + "profile": "A String", + "storagePool": "A String", }, - "canonicalName": "A String", # The canonical name of the finding. It's either "organizations/{organization_id}/sources/{source_id}/findings/{finding_id}", "folders/{folder_id}/sources/{source_id}/findings/{finding_id}" or "projects/{project_number}/sources/{source_id}/findings/{finding_id}", depending on the closest CRM ancestor of the resource associated with the finding. - "category": "A String", # The additional taxonomy group within findings from a given source. This field is immutable after creation time. Example: "XSS_FLASH_INJECTION" - "chokepoint": { # Contains details about a chokepoint, which is a resource or resource group where high-risk attack paths converge, based on [attack path simulations] (https://cloud.google.com/security-command-center/docs/attack-exposure-learn#attack_path_simulations). # Contains details about a chokepoint, which is a resource or resource group where high-risk attack paths converge, based on [attack path simulations] (https://cloud.google.com/security-command-center/docs/attack-exposure-learn#attack_path_simulations). This field cannot be updated. Its value is ignored in all update requests. - "relatedFindings": [ # List of resource names of findings associated with this chokepoint. For example, organizations/123/sources/456/findings/789. This list will have at most 100 findings. + "canonicalName": "A String", + "category": "A String", + "chokepoint": { + "relatedFindings": [ "A String", ], }, - "cloudArmor": { # Fields related to Google Cloud Armor findings. # Fields related to Cloud Armor findings. - "adaptiveProtection": { # Information about [Google Cloud Armor Adaptive Protection](https://cloud.google.com/armor/docs/cloud-armor-overview#google-cloud-armor-adaptive-protection). # Information about potential Layer 7 DDoS attacks identified by [Google Cloud Armor Adaptive Protection](https://cloud.google.com/armor/docs/adaptive-protection-overview). - "confidence": 3.14, # A score of 0 means that there is low confidence that the detected event is an actual attack. A score of 1 means that there is high confidence that the detected event is an attack. See the [Adaptive Protection documentation](https://cloud.google.com/armor/docs/adaptive-protection-overview#configure-alert-tuning) for further explanation. - }, - "attack": { # Information about DDoS attack volume and classification. # Information about DDoS attack volume and classification. - "classification": "A String", # Type of attack, for example, 'SYN-flood', 'NTP-udp', or 'CHARGEN-udp'. - "volumeBps": 42, # Total BPS (bytes per second) volume of attack. Deprecated - refer to volume_bps_long instead. - "volumeBpsLong": "A String", # Total BPS (bytes per second) volume of attack. - "volumePps": 42, # Total PPS (packets per second) volume of attack. Deprecated - refer to volume_pps_long instead. - "volumePpsLong": "A String", # Total PPS (packets per second) volume of attack. - }, - "duration": "A String", # Duration of attack from the start until the current moment (updated every 5 minutes). - "requests": { # Information about the requests relevant to the finding. # Information about incoming requests evaluated by [Google Cloud Armor security policies](https://cloud.google.com/armor/docs/security-policy-overview). - "longTermAllowed": 42, # Allowed RPS (requests per second) over the long term. - "longTermDenied": 42, # Denied RPS (requests per second) over the long term. - "ratio": 3.14, # For 'Increasing deny ratio', the ratio is the denied traffic divided by the allowed traffic. For 'Allowed traffic spike', the ratio is the allowed traffic in the short term divided by allowed traffic in the long term. - "shortTermAllowed": 42, # Allowed RPS (requests per second) in the short term. - }, - "securityPolicy": { # Information about the [Google Cloud Armor security policy](https://cloud.google.com/armor/docs/security-policy-overview) relevant to the finding. # Information about the [Google Cloud Armor security policy](https://cloud.google.com/armor/docs/security-policy-overview) relevant to the finding. - "name": "A String", # The name of the Google Cloud Armor security policy, for example, "my-security-policy". - "preview": True or False, # Whether or not the associated rule or policy is in preview mode. - "type": "A String", # The type of Google Cloud Armor security policy for example, 'backend security policy', 'edge security policy', 'network edge security policy', or 'always-on DDoS protection'. - }, - "threatVector": "A String", # Distinguish between volumetric & protocol DDoS attack and application layer attacks. For example, "L3_4" for Layer 3 and Layer 4 DDoS attacks, or "L_7" for Layer 7 DDoS attacks. - }, - "cloudDlpDataProfile": { # The [data profile](https://cloud.google.com/dlp/docs/data-profiles) associated with the finding. # Cloud DLP data profile that is associated with the finding. - "dataProfile": "A String", # Name of the data profile, for example, `projects/123/locations/europe/tableProfiles/8383929`. - "infoTypes": [ # Type of information detected by SDP. Info type includes name, version and sensitivity of the detected information type. - { # Type of information detected by the API. - "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. - "sensitivityScore": { # Score is calculated from of all elements in the data profile. A higher level means the data is more sensitive. # Optional custom sensitivity for this InfoType. This only applies to data profiling. - "score": "A String", # The sensitivity score applied to the resource. + "cloudArmor": { + "adaptiveProtection": { + "confidence": 3.14, + }, + "attack": { + "classification": "A String", + "volumeBps": 42, + "volumeBpsLong": "A String", + "volumePps": 42, + "volumePpsLong": "A String", + }, + "duration": "A String", + "requests": { + "longTermAllowed": 42, + "longTermDenied": 42, + "ratio": 3.14, + "shortTermAllowed": 42, + }, + "securityPolicy": { + "name": "A String", + "preview": True or False, + "type": "A String", + }, + "threatVector": "A String", + }, + "cloudDlpDataProfile": { + "dataProfile": "A String", + "infoTypes": [ + { + "name": "A String", + "sensitivityScore": { + "score": "A String", }, - "version": "A String", # Optional version name for this InfoType. + "version": "A String", }, ], - "parentType": "A String", # The resource hierarchy level at which the data profile was generated. + "parentType": "A String", }, - "cloudDlpInspection": { # Details about the Cloud Data Loss Prevention (Cloud DLP) [inspection job](https://cloud.google.com/dlp/docs/concepts-job-triggers) that produced the finding. # Cloud Data Loss Prevention (Cloud DLP) inspection results that are associated with the finding. - "fullScan": True or False, # Whether Cloud DLP scanned the complete resource or a sampled subset. - "infoType": "A String", # The type of information (or *[infoType](https://cloud.google.com/dlp/docs/infotypes-reference)*) found, for example, `EMAIL_ADDRESS` or `STREET_ADDRESS`. - "infoTypeCount": "A String", # The number of times Cloud DLP found this infoType within this job and resource. - "inspectJob": "A String", # Name of the inspection job, for example, `projects/123/locations/europe/dlpJobs/i-8383929`. + "cloudDlpInspection": { + "fullScan": True or False, + "infoType": "A String", + "infoTypeCount": "A String", + "inspectJob": "A String", }, - "complianceDetails": { # Compliance Details associated with the finding. # Details about the compliance implications of the finding. - "cloudControl": { # CloudControl associated with the finding. # CloudControl associated with the finding - "cloudControlName": "A String", # Name of the CloudControl associated with the finding. - "policyType": "A String", # Policy type of the CloudControl - "type": "A String", # Type of cloud control. - "version": 42, # Version of the Cloud Control + "complianceDetails": { + "cloudControl": { + "cloudControlName": "A String", + "policyType": "A String", + "type": "A String", + "version": 42, }, - "cloudControlDeploymentNames": [ # Cloud Control Deployments associated with the finding. For example, organizations/123/locations/global/cloudControlDeployments/deploymentIdentifier + "cloudControlDeploymentNames": [ "A String", ], - "frameworks": [ # Details of Frameworks associated with the finding - { # Compliance framework associated with the finding. - "category": [ # Category of the framework associated with the finding. E.g. Security Benchmark, or Assured Workloads + "frameworks": [ + { + "category": [ "A String", ], - "controls": [ # The controls associated with the framework. - { # Compliance control associated with the finding. - "controlName": "A String", # Name of the Control - "displayName": "A String", # Display name of the control. For example, AU-02. + "controls": [ + { + "controlName": "A String", + "displayName": "A String", }, ], - "displayName": "A String", # Display name of the framework. For a standard framework, this will look like e.g. PCI DSS 3.2.1, whereas for a custom framework it can be a user defined string like MyFramework - "name": "A String", # Name of the framework associated with the finding - "type": "A String", # Type of the framework associated with the finding, to specify whether the framework is built-in (pre-defined and immutable) or a custom framework defined by the customer (equivalent to security posture) + "displayName": "A String", + "name": "A String", + "type": "A String", }, ], }, - "compliances": [ # Contains compliance information for security standards associated to the finding. - { # Contains compliance information about a security standard indicating unmet recommendations. - "ids": [ # Policies within the standard or benchmark, for example, A.12.4.1 + "compliances": [ + { + "ids": [ "A String", ], - "standard": "A String", # Industry-wide compliance standards or benchmarks, such as CIS, PCI, and OWASP. - "version": "A String", # Version of the standard or benchmark, for example, 1.1 + "standard": "A String", + "version": "A String", }, ], - "connections": [ # Contains information about the IP connection associated with the finding. - { # Contains information about the IP connection associated with the finding. - "destinationIp": "A String", # Destination IP address. Not present for sockets that are listening and not connected. - "destinationPort": 42, # Destination port. Not present for sockets that are listening and not connected. - "protocol": "A String", # IANA Internet Protocol Number such as TCP(6) and UDP(17). - "sourceIp": "A String", # Source IP address. - "sourcePort": 42, # Source port. + "connections": [ + { + "destinationIp": "A String", + "destinationPort": 42, + "protocol": "A String", + "sourceIp": "A String", + "sourcePort": 42, }, ], - "contacts": { # Output only. Map containing the points of contact for the given finding. The key represents the type of contact, while the value contains a list of all the contacts that pertain. Please refer to: https://cloud.google.com/resource-manager/docs/managing-notification-contacts#notification-categories { "security": { "contacts": [ { "email": "person1@company.com" }, { "email": "person2@company.com" } ] } } - "a_key": { # Details about specific contacts - "contacts": [ # A list of contacts - { # The email address of a contact. - "email": "A String", # An email address. For example, "`person123@company.com`". + "contacts": { + "a_key": { + "contacts": [ + { + "email": "A String", }, ], }, }, - "containers": [ # Containers associated with the finding. This field provides information for both Kubernetes and non-Kubernetes containers. - { # Container associated with the finding. - "createTime": "A String", # The time that the container was created. - "imageId": "A String", # Optional container image ID, if provided by the container runtime. Uniquely identifies the container image launched using a container image digest. - "labels": [ # Container labels, as provided by the container runtime. - { # Represents a generic name-value label. A label has separate name and value fields to support filtering with the `contains()` function. For more information, see [Filtering on array-type fields](https://cloud.google.com/security-command-center/docs/how-to-api-list-findings#array-contains-filtering). - "name": "A String", # Name of the label. - "value": "A String", # Value that corresponds to the label's name. + "containers": [ + { + "createTime": "A String", + "imageId": "A String", + "labels": [ + { + "name": "A String", + "value": "A String", }, ], - "name": "A String", # Name of the container. - "uri": "A String", # Container image URI provided when configuring a pod or container. This string can identify a container image version using mutable tags. + "name": "A String", + "uri": "A String", }, ], - "createTime": "A String", # The time at which the finding was created in Security Command Center. - "dataAccessEvents": [ # Data access events associated with the finding. - { # Details about a data access attempt made by a principal not authorized under applicable data security policy. - "eventId": "A String", # Unique identifier for data access event. - "eventTime": "A String", # Timestamp of data access event. - "operation": "A String", # The operation performed by the principal to access the data. - "principalEmail": "A String", # The email address of the principal that accessed the data. The principal could be a user account, service account, Google group, or other. + "createTime": "A String", + "dataAccessEvents": [ + { + "eventId": "A String", + "eventTime": "A String", + "operation": "A String", + "principalEmail": "A String", }, ], - "dataFlowEvents": [ # Data flow events associated with the finding. - { # Details about a data flow event, in which either the data is moved to or is accessed from a non-compliant geo-location, as defined in the applicable data security policy. - "eventId": "A String", # Unique identifier for data flow event. - "eventTime": "A String", # Timestamp of data flow event. - "operation": "A String", # The operation performed by the principal for the data flow event. - "principalEmail": "A String", # The email address of the principal that initiated the data flow event. The principal could be a user account, service account, Google group, or other. - "violatedLocation": "A String", # Non-compliant location of the principal or the data destination. + "dataFlowEvents": [ + { + "eventId": "A String", + "eventTime": "A String", + "operation": "A String", + "principalEmail": "A String", + "violatedLocation": "A String", }, ], - "dataRetentionDeletionEvents": [ # Data retention deletion events associated with the finding. - { # Details about data retention deletion violations, in which the data is non-compliant based on their retention or deletion time, as defined in the applicable data security policy. The Data Retention Deletion (DRD) control is a control of the DSPM (Data Security Posture Management) suite that enables organizations to manage data retention and deletion policies in compliance with regulations, such as GDPR and CRPA. DRD supports two primary policy types: maximum storage length (max TTL) and minimum storage length (min TTL). Both are aimed at helping organizations meet regulatory and data management commitments. - "dataObjectCount": "A String", # Number of objects that violated the policy for this resource. If the number is less than 1,000, then the value of this field is the exact number. If the number of objects that violated the policy is greater than or equal to 1,000, then the value of this field is 1000. - "eventDetectionTime": "A String", # Timestamp indicating when the event was detected. - "eventType": "A String", # Type of the DRD event. - "maxRetentionAllowed": "A String", # Maximum duration of retention allowed from the DRD control. This comes from the DRD control where users set a max TTL for their data. For example, suppose that a user sets the max TTL for a Cloud Storage bucket to 90 days. However, an object in that bucket is 100 days old. In this case, a DataRetentionDeletionEvent will be generated for that Cloud Storage bucket, and the max_retention_allowed is 90 days. - "minRetentionAllowed": "A String", # Min duration of retention allowed from the DSPM retention control. This field is only populated when event type is set to EVENT_TYPE_MIN_TTL_FROM_CREATION. + "dataRetentionDeletionEvents": [ + { + "dataObjectCount": "A String", + "eventDetectionTime": "A String", + "eventType": "A String", + "maxRetentionAllowed": "A String", + "minRetentionAllowed": "A String", }, ], - "database": { # Represents database access information, such as queries. A database may be a sub-resource of an instance (as in the case of Cloud SQL instances or Cloud Spanner instances), or the database instance itself. Some database resources might not have the [full resource name](https://google.aip.dev/122#full-resource-names) populated because these resource types, such as Cloud SQL databases, are not yet supported by Cloud Asset Inventory. In these cases only the display name is provided. # Database associated with the finding. - "displayName": "A String", # The human-readable name of the database that the user connected to. - "grantees": [ # The target usernames, roles, or groups of an SQL privilege grant, which is not an IAM policy change. + "database": { + "displayName": "A String", + "grantees": [ "A String", ], - "name": "A String", # Some database resources may not have the [full resource name](https://google.aip.dev/122#full-resource-names) populated because these resource types are not yet supported by Cloud Asset Inventory (e.g. Cloud SQL databases). In these cases only the display name will be provided. The [full resource name](https://google.aip.dev/122#full-resource-names) of the database that the user connected to, if it is supported by Cloud Asset Inventory. - "query": "A String", # The SQL statement that is associated with the database access. - "userName": "A String", # The username used to connect to the database. The username might not be an IAM principal and does not have a set format. - "version": "A String", # The version of the database, for example, POSTGRES_14. See [the complete list](https://cloud.google.com/sql/docs/mysql/admin-api/rest/v1/SqlDatabaseVersion). - }, - "description": "A String", # Contains more details about the finding. - "discoveredWorkload": { # Represents discovered, customer managed workload that is not registered with the respective GCP service. # DiscoveredWorkload associated with the finding. - "confidence": "A String", # The confidence in detection of this workload. - "detectedRelevantHardware": True or False, # A boolean flag set to true if associated hardware strongly predicts the workload type. - "detectedRelevantKeywords": True or False, # A boolean flag set to true if associated keywords strongly predict the workload type. - "detectedRelevantPackages": True or False, # A boolean flag set to true if installed packages strongly predict the workload type. - "workloadType": "A String", # The type of workload. - }, - "disk": { # Contains information about the disk associated with the finding. # Disk associated with the finding. - "name": "A String", # The name of the disk, for example, "https://www.googleapis.com/compute/v1/projects/{project-id}/zones/{zone-id}/disks/{disk-id}". - }, - "eventTime": "A String", # The time the finding was first detected. If an existing finding is updated, then this is the time the update occurred. For example, if the finding represents an open firewall, this property captures the time the detector believes the firewall became open. The accuracy is determined by the detector. If the finding is later resolved, then this time reflects when the finding was resolved. This must not be set to a value greater than the current timestamp. - "exfiltration": { # Exfiltration represents a data exfiltration attempt from one or more sources to one or more targets. The `sources` attribute lists the sources of the exfiltrated data. The `targets` attribute lists the destinations the data was copied to. # Represents exfiltrations associated with the finding. - "sources": [ # If there are multiple sources, then the data is considered "joined" between them. For instance, BigQuery can join multiple tables, and each table would be considered a source. - { # Resource where data was exfiltrated from or exfiltrated to. - "components": [ # Subcomponents of the asset that was exfiltrated, like URIs used during exfiltration, table names, databases, and filenames. For example, multiple tables might have been exfiltrated from the same Cloud SQL instance, or multiple files might have been exfiltrated from the same Cloud Storage bucket. + "name": "A String", + "query": "A String", + "userName": "A String", + "version": "A String", + }, + "description": "A String", + "discoveredWorkload": { + "confidence": "A String", + "detectedRelevantHardware": True or False, + "detectedRelevantKeywords": True or False, + "detectedRelevantPackages": True or False, + "workloadType": "A String", + }, + "disk": { + "name": "A String", + }, + "eventTime": "A String", + "exfiltration": { + "sources": [ + { + "components": [ "A String", ], - "name": "A String", # The resource's [full resource name](https://cloud.google.com/apis/design/resource_names#full_resource_name). + "name": "A String", }, ], - "targets": [ # If there are multiple targets, each target would get a complete copy of the "joined" source data. - { # Resource where data was exfiltrated from or exfiltrated to. - "components": [ # Subcomponents of the asset that was exfiltrated, like URIs used during exfiltration, table names, databases, and filenames. For example, multiple tables might have been exfiltrated from the same Cloud SQL instance, or multiple files might have been exfiltrated from the same Cloud Storage bucket. + "targets": [ + { + "components": [ "A String", ], - "name": "A String", # The resource's [full resource name](https://cloud.google.com/apis/design/resource_names#full_resource_name). + "name": "A String", }, ], - "totalExfiltratedBytes": "A String", # Total exfiltrated bytes processed for the entire job. - }, - "externalExposure": { # Details about the externally exposed resource associated with the finding. # External exposure associated with the finding. - "backendBucket": "A String", # The full resource name of the load balancer backend bucket, for example, "//compute.googleapis.com/projects/{project-id}/global/backendBuckets/{name}" - "backendService": "A String", # The full resource name of load balancer backend service, for example, "//compute.googleapis.com/projects/{project-id}/global/backendServices/{name}". - "exposedApplication": "A String", # The name and version of the exposed web application, for example, "Jenkins 2.184". - "exposedEndpoint": "A String", # The resource which is running the exposed service, for example, "//compute.googleapis.com/projects/{project-id}/zones/{zone}/instances/{instance}.” - "exposedService": "A String", # The name and version of the service, for example, "Jupyter Notebook 6.14.0". - "forwardingRule": "A String", # The full resource name of the forwarding rule, for example, "//compute.googleapis.com/projects/{project-id}/global/forwardingRules/{forwarding-rule-name}". - "hostnameUri": "A String", # Hostname of the exposed application, for example, "https://test-app.a.run.app/" - "httpResponse": [ # The http response returned by the web application. - { # The http response returned by the web application. - "path": "A String", # The http path for which response code was returned by web application, for example, "https://test-app.a.run.app/test". - "statusCode": "A String", # The http response code returned by the web application, for example, 200. + "totalExfiltratedBytes": "A String", + }, + "externalExposure": { + "backendBucket": "A String", + "backendService": "A String", + "exposedApplication": "A String", + "exposedEndpoint": "A String", + "exposedService": "A String", + "forwardingRule": "A String", + "hostnameUri": "A String", + "httpResponse": [ + { + "path": "A String", + "statusCode": "A String", }, ], - "instanceGroup": "A String", # The full resource name of the instance group, for example, "//compute.googleapis.com/projects/{project-id}/global/instanceGroups/{name}". - "internalBackendService": "A String", # The full resource name of load balancer backend service in the internal project having resource exposed via PSC, for example, "//compute.googleapis.com/projects/{project-id}/global/backendServices/{name}". - "loadBalancerFirewallPolicy": "A String", # The full resource name of the load balancer firewall policy, for example, "//compute.googleapis.com/projects/{project-id}/global/firewallPolicies/{policy-name}". - "networkEndpointGroup": "A String", # The full resource name of the network endpoint group, for example, "//compute.googleapis.com/projects/{project-id}/global/networkEndpointGroups/{name}". - "networkIngressFirewallPolicy": "A String", # The full resource name of the network ingress firewall policy, for example, "//compute.googleapis.com/projects/{project-id}/global/firewallPolicies/{name}". - "privateIpAddress": "A String", # Private IP address of the exposed endpoint. - "privatePort": "A String", # Port number associated with private IP address. - "pscNetworkAttachment": "A String", # The full resource name of the PSC (Private Service Connect) network attachment that network interface controller is attached to, for example, "//compute.googleapis.com/projects/{project-id}/regions/{region}/networkAttachments/{name}" - "pscServiceAttachment": "A String", # The full resource name of the PSC (Private Service Connect) service attachment that the load balancer network endpoint group targets, for example, "//compute.googleapis.com/projects/{project-id}/regions/{region}/serviceAttachments/{name}" - "publicIpAddress": "A String", # Public IP address of the exposed endpoint. - "publicPort": "A String", # Public port number of the exposed endpoint. - "serviceFirewallPolicy": "A String", # The full resource name of the firewall policy of the exposed service, for example, "//compute.googleapis.com/projects/{project-id}/global/firewallPolicies/{policy-name}". - }, - "externalSystems": { # Output only. Third party SIEM/SOAR fields within SCC, contains external system information and external system finding fields. - "a_key": { # Representation of third party SIEM/SOAR fields within SCC. - "assignees": [ # References primary/secondary etc assignees in the external system. + "instanceGroup": "A String", + "internalBackendService": "A String", + "loadBalancerFirewallPolicy": "A String", + "networkEndpointGroup": "A String", + "networkIngressFirewallPolicy": "A String", + "privateIpAddress": "A String", + "privatePort": "A String", + "pscNetworkAttachment": "A String", + "pscServiceAttachment": "A String", + "publicIpAddress": "A String", + "publicPort": "A String", + "serviceFirewallPolicy": "A String", + }, + "externalSystems": { + "a_key": { + "assignees": [ "A String", ], - "caseCloseTime": "A String", # The time when the case was closed, as reported by the external system. - "caseCreateTime": "A String", # The time when the case was created, as reported by the external system. - "casePriority": "A String", # The priority of the finding's corresponding case in the external system. - "caseSla": "A String", # The SLA of the finding's corresponding case in the external system. - "caseUri": "A String", # The link to the finding's corresponding case in the external system. - "externalSystemUpdateTime": "A String", # The time when the case was last updated, as reported by the external system. - "externalUid": "A String", # The identifier that's used to track the finding's corresponding case in the external system. - "name": "A String", # Full resource name of the external system, for example: "organizations/1234/sources/5678/findings/123456/externalSystems/jira", "folders/1234/sources/5678/findings/123456/externalSystems/jira", "projects/1234/sources/5678/findings/123456/externalSystems/jira" - "status": "A String", # The most recent status of the finding's corresponding case, as reported by the external system. - "ticketInfo": { # Information about the ticket, if any, that is being used to track the resolution of the issue that is identified by this finding. # Information about the ticket, if any, that is being used to track the resolution of the issue that is identified by this finding. - "assignee": "A String", # The assignee of the ticket in the ticket system. - "description": "A String", # The description of the ticket in the ticket system. - "id": "A String", # The identifier of the ticket in the ticket system. - "status": "A String", # The latest status of the ticket, as reported by the ticket system. - "updateTime": "A String", # The time when the ticket was last updated, as reported by the ticket system. - "uri": "A String", # The link to the ticket in the ticket system. + "caseCloseTime": "A String", + "caseCreateTime": "A String", + "casePriority": "A String", + "caseSla": "A String", + "caseUri": "A String", + "externalSystemUpdateTime": "A String", + "externalUid": "A String", + "name": "A String", + "status": "A String", + "ticketInfo": { + "assignee": "A String", + "description": "A String", + "id": "A String", + "status": "A String", + "updateTime": "A String", + "uri": "A String", }, }, }, - "externalUri": "A String", # The URI that, if available, points to a web page outside of Security Command Center where additional information about the finding can be found. This field is guaranteed to be either empty or a well formed URL. - "files": [ # File associated with the finding. - { # File information about the related binary/library used by an executable, or the script used by a script interpreter - "contents": "A String", # Prefix of the file contents as a JSON-encoded string. - "diskPath": { # Path of the file in terms of underlying disk/partition identifiers. # Path of the file in terms of underlying disk/partition identifiers. - "partitionUuid": "A String", # UUID of the partition (format https://wiki.archlinux.org/title/persistent_block_device_naming#by-uuid) - "relativePath": "A String", # Relative path of the file in the partition as a JSON encoded string. Example: /home/user1/executable_file.sh + "externalUri": "A String", + "files": [ + { + "contents": "A String", + "diskPath": { + "partitionUuid": "A String", + "relativePath": "A String", }, - "fileLoadState": "A String", # The load state of the file. - "hashedSize": "A String", # The length in bytes of the file prefix that was hashed. If hashed_size == size, any hashes reported represent the entire file. - "operations": [ # Operation(s) performed on a file. - { # Operation(s) performed on a file. - "type": "A String", # The type of the operation + "fileLoadState": "A String", + "hashedSize": "A String", + "operations": [ + { + "type": "A String", }, ], - "partiallyHashed": True or False, # True when the hash covers only a prefix of the file. - "path": "A String", # Absolute path of the file as a JSON encoded string. - "sha256": "A String", # SHA256 hash of the first hashed_size bytes of the file encoded as a hex string. If hashed_size == size, sha256 represents the SHA256 hash of the entire file. - "size": "A String", # Size of the file in bytes. + "partiallyHashed": True or False, + "path": "A String", + "sha256": "A String", + "size": "A String", }, ], - "findingClass": "A String", # The class of the finding. - "groupMemberships": [ # Contains details about groups of which this finding is a member. A group is a collection of findings that are related in some way. This field cannot be updated. Its value is ignored in all update requests. - { # Contains details about groups of which this finding is a member. A group is a collection of findings that are related in some way. - "groupId": "A String", # ID of the group. - "groupType": "A String", # Type of group. + "findingClass": "A String", + "groupMemberships": [ + { + "groupId": "A String", + "groupType": "A String", }, ], - "iamBindings": [ # Represents IAM bindings associated with the finding. - { # Represents a particular IAM binding, which captures a member's role addition, removal, or state. - "action": "A String", # The action that was performed on a Binding. - "member": "A String", # A single identity requesting access for a Cloud Platform resource, for example, "foo@google.com". - "role": "A String", # Role that is assigned to "members". For example, "roles/viewer", "roles/editor", or "roles/owner". + "iamBindings": [ + { + "action": "A String", + "member": "A String", + "role": "A String", }, ], - "indicator": { # Represents what's commonly known as an _indicator of compromise_ (IoC) in computer forensics. This is an artifact observed on a network or in an operating system that, with high confidence, indicates a computer intrusion. For more information, see [Indicator of compromise](https://en.wikipedia.org/wiki/Indicator_of_compromise). # Represents what's commonly known as an *indicator of compromise* (IoC) in computer forensics. This is an artifact observed on a network or in an operating system that, with high confidence, indicates a computer intrusion. For more information, see [Indicator of compromise](https://en.wikipedia.org/wiki/Indicator_of_compromise). - "domains": [ # List of domains associated to the Finding. + "indicator": { + "domains": [ "A String", ], - "ipAddresses": [ # The list of IP addresses that are associated with the finding. + "ipAddresses": [ "A String", ], - "signatures": [ # The list of matched signatures indicating that the given process is present in the environment. - { # Indicates what signature matched this process. - "memoryHashSignature": { # A signature corresponding to memory page hashes. # Signature indicating that a binary family was matched. - "binaryFamily": "A String", # The binary family. - "detections": [ # The list of memory hash detections contributing to the binary family match. - { # Memory hash detection contributing to the binary family match. - "binary": "A String", # The name of the binary associated with the memory hash signature detection. - "percentPagesMatched": 3.14, # The percentage of memory page hashes in the signature that were matched. + "signatures": [ + { + "memoryHashSignature": { + "binaryFamily": "A String", + "detections": [ + { + "binary": "A String", + "percentPagesMatched": 3.14, }, ], }, - "signatureType": "A String", # Describes the type of resource associated with the signature. - "yaraRuleSignature": { # A signature corresponding to a YARA rule. # Signature indicating that a YARA rule was matched. - "yaraRule": "A String", # The name of the YARA rule. + "signatureType": "A String", + "yaraRuleSignature": { + "yaraRule": "A String", }, }, ], - "uris": [ # The list of URIs associated to the Findings. + "uris": [ "A String", ], }, - "ipRules": { # IP rules associated with the finding. # IP rules associated with the finding. - "allowed": { # Allowed IP rule. # Tuple with allowed rules. - "ipRules": [ # Optional. Optional list of allowed IP rules. - { # IP rule information. - "portRanges": [ # Optional. An optional list of ports to which this rule applies. This field is only applicable for the UDP or (S)TCP protocols. Each entry must be either an integer or a range including a min and max port number. - { # A port range which is inclusive of the min and max values. Values are between 0 and 2^16-1. The max can be equal / must be not smaller than the min value. If min and max are equal this indicates that it is a single port. - "max": "A String", # Maximum port value. - "min": "A String", # Minimum port value. + "ipRules": { + "allowed": { + "ipRules": [ + { + "portRanges": [ + { + "max": "A String", + "min": "A String", }, ], - "protocol": "A String", # The IP protocol this rule applies to. This value can either be one of the following well known protocol strings (TCP, UDP, ICMP, ESP, AH, IPIP, SCTP) or a string representation of the integer value. + "protocol": "A String", }, ], }, - "denied": { # Denied IP rule. # Tuple with denied rules. - "ipRules": [ # Optional. Optional list of denied IP rules. - { # IP rule information. - "portRanges": [ # Optional. An optional list of ports to which this rule applies. This field is only applicable for the UDP or (S)TCP protocols. Each entry must be either an integer or a range including a min and max port number. - { # A port range which is inclusive of the min and max values. Values are between 0 and 2^16-1. The max can be equal / must be not smaller than the min value. If min and max are equal this indicates that it is a single port. - "max": "A String", # Maximum port value. - "min": "A String", # Minimum port value. + "denied": { + "ipRules": [ + { + "portRanges": [ + { + "max": "A String", + "min": "A String", }, ], - "protocol": "A String", # The IP protocol this rule applies to. This value can either be one of the following well known protocol strings (TCP, UDP, ICMP, ESP, AH, IPIP, SCTP) or a string representation of the integer value. + "protocol": "A String", }, ], }, - "destinationIpRanges": [ # If destination IP ranges are specified, the firewall rule applies only to traffic that has a destination IP address in these ranges. These ranges must be expressed in CIDR format. Only supports IPv4. + "destinationIpRanges": [ "A String", ], - "direction": "A String", # The direction that the rule is applicable to, one of ingress or egress. - "exposedServices": [ # Name of the network protocol service, such as FTP, that is exposed by the open port. Follows the naming convention available at: https://www.iana.org/assignments/service-names-port-numbers/service-names-port-numbers.xhtml. + "direction": "A String", + "exposedServices": [ "A String", ], - "sourceIpRanges": [ # If source IP ranges are specified, the firewall rule applies only to traffic that has a source IP address in these ranges. These ranges must be expressed in CIDR format. Only supports IPv4. + "sourceIpRanges": [ "A String", ], }, - "job": { # Describes a job # Job associated with the finding. - "errorCode": 42, # Optional. If the job did not complete successfully, this field describes why. - "location": "A String", # Optional. Gives the location where the job ran, such as `US` or `europe-west1` - "name": "A String", # The fully-qualified name for a job. e.g. `projects//jobs/` - "state": "A String", # Output only. State of the job, such as `RUNNING` or `PENDING`. - }, - "kernelRootkit": { # Kernel mode rootkit signatures. # Signature of the kernel rootkit. - "name": "A String", # Rootkit name, when available. - "unexpectedCodeModification": True or False, # True if unexpected modifications of kernel code memory are present. - "unexpectedFtraceHandler": True or False, # True if `ftrace` points are present with callbacks pointing to regions that are not in the expected kernel or module code range. - "unexpectedInterruptHandler": True or False, # True if interrupt handlers that are are not in the expected kernel or module code regions are present. - "unexpectedKernelCodePages": True or False, # True if kernel code pages that are not in the expected kernel or module code regions are present. - "unexpectedKprobeHandler": True or False, # True if `kprobe` points are present with callbacks pointing to regions that are not in the expected kernel or module code range. - "unexpectedProcessesInRunqueue": True or False, # True if unexpected processes in the scheduler run queue are present. Such processes are in the run queue, but not in the process task list. - "unexpectedReadOnlyDataModification": True or False, # True if unexpected modifications of kernel read-only data memory are present. - "unexpectedSystemCallHandler": True or False, # True if system call handlers that are are not in the expected kernel or module code regions are present. - }, - "kubernetes": { # Kubernetes-related attributes. # Kubernetes resources associated with the finding. - "accessReviews": [ # Provides information on any Kubernetes access reviews (privilege checks) relevant to the finding. - { # Conveys information about a Kubernetes access review (such as one returned by a [`kubectl auth can-i`](https://kubernetes.io/docs/reference/access-authn-authz/authorization/#checking-api-access) command) that was involved in a finding. - "group": "A String", # The API group of the resource. "*" means all. - "name": "A String", # The name of the resource being requested. Empty means all. - "ns": "A String", # Namespace of the action being requested. Currently, there is no distinction between no namespace and all namespaces. Both are represented by "" (empty). - "resource": "A String", # The optional resource type requested. "*" means all. - "subresource": "A String", # The optional subresource type. - "verb": "A String", # A Kubernetes resource API verb, like get, list, watch, create, update, delete, proxy. "*" means all. - "version": "A String", # The API version of the resource. "*" means all. + "job": { + "errorCode": 42, + "location": "A String", + "name": "A String", + "state": "A String", + }, + "kernelRootkit": { + "name": "A String", + "unexpectedCodeModification": True or False, + "unexpectedFtraceHandler": True or False, + "unexpectedInterruptHandler": True or False, + "unexpectedKernelCodePages": True or False, + "unexpectedKprobeHandler": True or False, + "unexpectedProcessesInRunqueue": True or False, + "unexpectedReadOnlyDataModification": True or False, + "unexpectedSystemCallHandler": True or False, + }, + "kubernetes": { + "accessReviews": [ + { + "group": "A String", + "name": "A String", + "ns": "A String", + "resource": "A String", + "subresource": "A String", + "verb": "A String", + "version": "A String", }, ], - "bindings": [ # Provides Kubernetes role binding information for findings that involve [RoleBindings or ClusterRoleBindings](https://cloud.google.com/kubernetes-engine/docs/how-to/role-based-access-control). - { # Represents a Kubernetes RoleBinding or ClusterRoleBinding. - "name": "A String", # Name for the binding. - "ns": "A String", # Namespace for the binding. - "role": { # Kubernetes Role or ClusterRole. # The Role or ClusterRole referenced by the binding. - "kind": "A String", # Role type. - "name": "A String", # Role name. - "ns": "A String", # Role namespace. + "bindings": [ + { + "name": "A String", + "ns": "A String", + "role": { + "kind": "A String", + "name": "A String", + "ns": "A String", }, - "subjects": [ # Represents one or more subjects that are bound to the role. Not always available for PATCH requests. - { # Represents a Kubernetes subject. - "kind": "A String", # Authentication type for the subject. - "name": "A String", # Name for the subject. - "ns": "A String", # Namespace for the subject. + "subjects": [ + { + "kind": "A String", + "name": "A String", + "ns": "A String", }, ], }, ], - "nodePools": [ # GKE [node pools](https://cloud.google.com/kubernetes-engine/docs/concepts/node-pools) associated with the finding. This field contains node pool information for each node, when it is available. - { # Provides GKE node pool information. - "name": "A String", # Kubernetes node pool name. - "nodes": [ # Nodes associated with the finding. - { # Kubernetes nodes associated with the finding. - "name": "A String", # [Full resource name](https://google.aip.dev/122#full-resource-names) of the Compute Engine VM running the cluster node. + "nodePools": [ + { + "name": "A String", + "nodes": [ + { + "name": "A String", }, ], }, ], - "nodes": [ # Provides Kubernetes [node](https://cloud.google.com/kubernetes-engine/docs/concepts/cluster-architecture#nodes) information. - { # Kubernetes nodes associated with the finding. - "name": "A String", # [Full resource name](https://google.aip.dev/122#full-resource-names) of the Compute Engine VM running the cluster node. + "nodes": [ + { + "name": "A String", }, ], - "objects": [ # Kubernetes objects related to the finding. - { # Kubernetes object related to the finding, uniquely identified by GKNN. Used if the object Kind is not one of Pod, Node, NodePool, Binding, or AccessReview. - "containers": [ # Pod containers associated with this finding, if any. - { # Container associated with the finding. - "createTime": "A String", # The time that the container was created. - "imageId": "A String", # Optional container image ID, if provided by the container runtime. Uniquely identifies the container image launched using a container image digest. - "labels": [ # Container labels, as provided by the container runtime. - { # Represents a generic name-value label. A label has separate name and value fields to support filtering with the `contains()` function. For more information, see [Filtering on array-type fields](https://cloud.google.com/security-command-center/docs/how-to-api-list-findings#array-contains-filtering). - "name": "A String", # Name of the label. - "value": "A String", # Value that corresponds to the label's name. + "objects": [ + { + "containers": [ + { + "createTime": "A String", + "imageId": "A String", + "labels": [ + { + "name": "A String", + "value": "A String", }, ], - "name": "A String", # Name of the container. - "uri": "A String", # Container image URI provided when configuring a pod or container. This string can identify a container image version using mutable tags. + "name": "A String", + "uri": "A String", }, ], - "group": "A String", # Kubernetes object group, such as "policy.k8s.io/v1". - "kind": "A String", # Kubernetes object kind, such as "Namespace". - "name": "A String", # Kubernetes object name. For details see https://kubernetes.io/docs/concepts/overview/working-with-objects/names/. - "ns": "A String", # Kubernetes object namespace. Must be a valid DNS label. Named "ns" to avoid collision with C++ namespace keyword. For details see https://kubernetes.io/docs/tasks/administer-cluster/namespaces/. + "group": "A String", + "kind": "A String", + "name": "A String", + "ns": "A String", }, ], - "pods": [ # Kubernetes [Pods](https://cloud.google.com/kubernetes-engine/docs/concepts/pod) associated with the finding. This field contains Pod records for each container that is owned by a Pod. - { # A Kubernetes Pod. - "containers": [ # Pod containers associated with this finding, if any. - { # Container associated with the finding. - "createTime": "A String", # The time that the container was created. - "imageId": "A String", # Optional container image ID, if provided by the container runtime. Uniquely identifies the container image launched using a container image digest. - "labels": [ # Container labels, as provided by the container runtime. - { # Represents a generic name-value label. A label has separate name and value fields to support filtering with the `contains()` function. For more information, see [Filtering on array-type fields](https://cloud.google.com/security-command-center/docs/how-to-api-list-findings#array-contains-filtering). - "name": "A String", # Name of the label. - "value": "A String", # Value that corresponds to the label's name. + "pods": [ + { + "containers": [ + { + "createTime": "A String", + "imageId": "A String", + "labels": [ + { + "name": "A String", + "value": "A String", }, ], - "name": "A String", # Name of the container. - "uri": "A String", # Container image URI provided when configuring a pod or container. This string can identify a container image version using mutable tags. + "name": "A String", + "uri": "A String", }, ], - "labels": [ # Pod labels. For Kubernetes containers, these are applied to the container. - { # Represents a generic name-value label. A label has separate name and value fields to support filtering with the `contains()` function. For more information, see [Filtering on array-type fields](https://cloud.google.com/security-command-center/docs/how-to-api-list-findings#array-contains-filtering). - "name": "A String", # Name of the label. - "value": "A String", # Value that corresponds to the label's name. + "labels": [ + { + "name": "A String", + "value": "A String", }, ], - "name": "A String", # Kubernetes Pod name. - "ns": "A String", # Kubernetes Pod namespace. + "name": "A String", + "ns": "A String", }, ], - "roles": [ # Provides Kubernetes role information for findings that involve [Roles or ClusterRoles](https://cloud.google.com/kubernetes-engine/docs/how-to/role-based-access-control). - { # Kubernetes Role or ClusterRole. - "kind": "A String", # Role type. - "name": "A String", # Role name. - "ns": "A String", # Role namespace. + "roles": [ + { + "kind": "A String", + "name": "A String", + "ns": "A String", }, ], }, - "loadBalancers": [ # The load balancers associated with the finding. - { # Contains information related to the load balancer associated with the finding. - "name": "A String", # The name of the load balancer associated with the finding. + "loadBalancers": [ + { + "name": "A String", }, ], - "logEntries": [ # Log entries that are relevant to the finding. - { # An individual entry in a log. - "cloudLoggingEntry": { # Metadata taken from a [Cloud Logging LogEntry](https://cloud.google.com/logging/docs/reference/v2/rest/v2/LogEntry) # An individual entry in a log stored in Cloud Logging. - "insertId": "A String", # A unique identifier for the log entry. - "logId": "A String", # The type of the log (part of `log_name`. `log_name` is the resource name of the log to which this log entry belongs). For example: `cloudresourcemanager.googleapis.com/activity`. Note that this field is not URL-encoded, unlike the `LOG_ID` field in `LogEntry`. - "resourceContainer": "A String", # The organization, folder, or project of the monitored resource that produced this log entry. - "timestamp": "A String", # The time the event described by the log entry occurred. + "logEntries": [ + { + "cloudLoggingEntry": { + "insertId": "A String", + "logId": "A String", + "resourceContainer": "A String", + "timestamp": "A String", }, }, ], - "mitreAttack": { # MITRE ATT&CK tactics and techniques related to this finding. See: https://attack.mitre.org # MITRE ATT&CK tactics and techniques related to this finding. See: https://attack.mitre.org - "additionalTactics": [ # Additional MITRE ATT&CK tactics related to this finding, if any. + "mitreAttack": { + "additionalTactics": [ "A String", ], - "additionalTechniques": [ # Additional MITRE ATT&CK techniques related to this finding, if any, along with any of their respective parent techniques. + "additionalTechniques": [ "A String", ], - "primaryTactic": "A String", # The MITRE ATT&CK tactic most closely represented by this finding, if any. - "primaryTechniques": [ # The MITRE ATT&CK technique most closely represented by this finding, if any. primary_techniques is a repeated field because there are multiple levels of MITRE ATT&CK techniques. If the technique most closely represented by this finding is a sub-technique (e.g. `SCANNING_IP_BLOCKS`), both the sub-technique and its parent technique(s) will be listed (e.g. `SCANNING_IP_BLOCKS`, `ACTIVE_SCANNING`). + "primaryTactic": "A String", + "primaryTechniques": [ "A String", ], - "version": "A String", # The MITRE ATT&CK version referenced by the above fields. E.g. "8". + "version": "A String", }, - "moduleName": "A String", # Unique identifier of the module which generated the finding. Example: folders/598186756061/securityHealthAnalyticsSettings/customModules/56799441161885 - "mute": "A String", # Indicates the mute state of a finding (either muted, unmuted or undefined). Unlike other attributes of a finding, a finding provider shouldn't set the value of mute. - "muteInfo": { # Mute information about the finding, including whether the finding has a static mute or any matching dynamic mute rules. # Output only. The mute information regarding this finding. - "dynamicMuteRecords": [ # The list of dynamic mute rules that currently match the finding. - { # The record of a dynamic mute rule that matches the finding. - "matchTime": "A String", # When the dynamic mute rule first matched the finding. - "muteConfig": "A String", # The relative resource name of the mute rule, represented by a mute config, that created this record, for example `organizations/123/muteConfigs/mymuteconfig` or `organizations/123/locations/global/muteConfigs/mymuteconfig`. + "moduleName": "A String", + "mute": "A String", + "muteInfo": { + "dynamicMuteRecords": [ + { + "matchTime": "A String", + "muteConfig": "A String", }, ], - "staticMute": { # Information about the static mute state. A static mute state overrides any dynamic mute rules that apply to this finding. The static mute state can be set by a static mute rule or by muting the finding directly. # If set, the static mute applied to this finding. Static mutes override dynamic mutes. If unset, there is no static mute. - "applyTime": "A String", # When the static mute was applied. - "state": "A String", # The static mute state. If the value is `MUTED` or `UNMUTED`, then the finding's overall mute state will have the same value. + "staticMute": { + "applyTime": "A String", + "state": "A String", }, }, - "muteInitiator": "A String", # Records additional information about the mute operation, for example, the [mute configuration](/security-command-center/docs/how-to-mute-findings) that muted the finding and the user who muted the finding. - "muteUpdateTime": "A String", # Output only. The most recent time this finding was muted or unmuted. - "name": "A String", # The [relative resource name](https://cloud.google.com/apis/design/resource_names#relative_resource_name) of the finding. Example: "organizations/{organization_id}/sources/{source_id}/findings/{finding_id}", "folders/{folder_id}/sources/{source_id}/findings/{finding_id}", "projects/{project_id}/sources/{source_id}/findings/{finding_id}". - "networks": [ # Represents the VPC networks that the resource is attached to. - { # Contains information about a VPC network associated with the finding. - "name": "A String", # The name of the VPC network resource, for example, `//compute.googleapis.com/projects/my-project/global/networks/my-network`. + "muteInitiator": "A String", + "muteUpdateTime": "A String", + "name": "A String", + "networks": [ + { + "name": "A String", }, ], - "nextSteps": "A String", # Steps to address the finding. - "notebook": { # Represents a Jupyter notebook IPYNB file, such as a [Colab Enterprise notebook](https://cloud.google.com/colab/docs/introduction) file, that is associated with a finding. # Notebook associated with the finding. - "lastAuthor": "A String", # The user ID of the latest author to modify the notebook. - "name": "A String", # The name of the notebook. - "notebookUpdateTime": "A String", # The most recent time the notebook was updated. - "service": "A String", # The source notebook service, for example, "Colab Enterprise". + "nextSteps": "A String", + "notebook": { + "lastAuthor": "A String", + "name": "A String", + "notebookUpdateTime": "A String", + "service": "A String", }, - "orgPolicies": [ # Contains information about the org policies associated with the finding. - { # Contains information about the org policies associated with the finding. - "name": "A String", # The resource name of the org policy. Example: "organizations/{organization_id}/policies/{constraint_name}" + "orgPolicies": [ + { + "name": "A String", }, ], - "parent": "A String", # The relative resource name of the source the finding belongs to. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name This field is immutable after creation time. For example: "organizations/{organization_id}/sources/{source_id}" - "parentDisplayName": "A String", # Output only. The human readable display name of the finding source such as "Event Threat Detection" or "Security Health Analytics". - "policyViolationSummary": { # Metadata summarizing policy violations of child resources of the affected resource. `finding_category` and `resource` determine the exact semantics of the counts. For example, when category=DATA_SECURITY_POSTURE_OBJECT_PUBLIC_ACCESS_VIOLATION and resource='storage.googleapis.com/buckets/my-bucket-name' then this counts the number of Cloud Storage objects in my-bucket-name which violate a Public Access control. # PolicyViolationSummary associated with the finding. - "conformantResourcesCount": "A String", # Total number of child resources that conform to the policy. - "evaluationErrorsCount": "A String", # Number of child resources for which errors during evaluation occurred. The evaluation result for these child resources is effectively "unknown". - "outOfScopeResourcesCount": "A String", # Total count of child resources which were not in scope for evaluation. - "policyViolationsCount": "A String", # Count of child resources in violation of the policy. - }, - "processes": [ # Represents operating system processes associated with the Finding. - { # Represents an operating system process. - "args": [ # Process arguments as JSON encoded strings. + "parent": "A String", + "parentDisplayName": "A String", + "policyViolationSummary": { + "conformantResourcesCount": "A String", + "evaluationErrorsCount": "A String", + "outOfScopeResourcesCount": "A String", + "policyViolationsCount": "A String", + }, + "processes": [ + { + "args": [ "A String", ], - "argumentsTruncated": True or False, # True if `args` is incomplete. - "binary": { # File information about the related binary/library used by an executable, or the script used by a script interpreter # File information for the process executable. - "contents": "A String", # Prefix of the file contents as a JSON-encoded string. - "diskPath": { # Path of the file in terms of underlying disk/partition identifiers. # Path of the file in terms of underlying disk/partition identifiers. - "partitionUuid": "A String", # UUID of the partition (format https://wiki.archlinux.org/title/persistent_block_device_naming#by-uuid) - "relativePath": "A String", # Relative path of the file in the partition as a JSON encoded string. Example: /home/user1/executable_file.sh + "argumentsTruncated": True or False, + "binary": { + "contents": "A String", + "diskPath": { + "partitionUuid": "A String", + "relativePath": "A String", }, - "fileLoadState": "A String", # The load state of the file. - "hashedSize": "A String", # The length in bytes of the file prefix that was hashed. If hashed_size == size, any hashes reported represent the entire file. - "operations": [ # Operation(s) performed on a file. - { # Operation(s) performed on a file. - "type": "A String", # The type of the operation + "fileLoadState": "A String", + "hashedSize": "A String", + "operations": [ + { + "type": "A String", }, ], - "partiallyHashed": True or False, # True when the hash covers only a prefix of the file. - "path": "A String", # Absolute path of the file as a JSON encoded string. - "sha256": "A String", # SHA256 hash of the first hashed_size bytes of the file encoded as a hex string. If hashed_size == size, sha256 represents the SHA256 hash of the entire file. - "size": "A String", # Size of the file in bytes. + "partiallyHashed": True or False, + "path": "A String", + "sha256": "A String", + "size": "A String", }, - "envVariables": [ # Process environment variables. - { # A name-value pair representing an environment variable used in an operating system process. - "name": "A String", # Environment variable name as a JSON encoded string. - "val": "A String", # Environment variable value as a JSON encoded string. + "envVariables": [ + { + "name": "A String", + "val": "A String", }, ], - "envVariablesTruncated": True or False, # True if `env_variables` is incomplete. - "libraries": [ # File information for libraries loaded by the process. - { # File information about the related binary/library used by an executable, or the script used by a script interpreter - "contents": "A String", # Prefix of the file contents as a JSON-encoded string. - "diskPath": { # Path of the file in terms of underlying disk/partition identifiers. # Path of the file in terms of underlying disk/partition identifiers. - "partitionUuid": "A String", # UUID of the partition (format https://wiki.archlinux.org/title/persistent_block_device_naming#by-uuid) - "relativePath": "A String", # Relative path of the file in the partition as a JSON encoded string. Example: /home/user1/executable_file.sh + "envVariablesTruncated": True or False, + "libraries": [ + { + "contents": "A String", + "diskPath": { + "partitionUuid": "A String", + "relativePath": "A String", }, - "fileLoadState": "A String", # The load state of the file. - "hashedSize": "A String", # The length in bytes of the file prefix that was hashed. If hashed_size == size, any hashes reported represent the entire file. - "operations": [ # Operation(s) performed on a file. - { # Operation(s) performed on a file. - "type": "A String", # The type of the operation + "fileLoadState": "A String", + "hashedSize": "A String", + "operations": [ + { + "type": "A String", }, ], - "partiallyHashed": True or False, # True when the hash covers only a prefix of the file. - "path": "A String", # Absolute path of the file as a JSON encoded string. - "sha256": "A String", # SHA256 hash of the first hashed_size bytes of the file encoded as a hex string. If hashed_size == size, sha256 represents the SHA256 hash of the entire file. - "size": "A String", # Size of the file in bytes. + "partiallyHashed": True or False, + "path": "A String", + "sha256": "A String", + "size": "A String", }, ], - "name": "A String", # The process name, as displayed in utilities like `top` and `ps`. This name can be accessed through `/proc/[pid]/comm` and changed with `prctl(PR_SET_NAME)`. - "parentPid": "A String", # The parent process ID. - "pid": "A String", # The process ID. - "script": { # File information about the related binary/library used by an executable, or the script used by a script interpreter # When the process represents the invocation of a script, `binary` provides information about the interpreter, while `script` provides information about the script file provided to the interpreter. - "contents": "A String", # Prefix of the file contents as a JSON-encoded string. - "diskPath": { # Path of the file in terms of underlying disk/partition identifiers. # Path of the file in terms of underlying disk/partition identifiers. - "partitionUuid": "A String", # UUID of the partition (format https://wiki.archlinux.org/title/persistent_block_device_naming#by-uuid) - "relativePath": "A String", # Relative path of the file in the partition as a JSON encoded string. Example: /home/user1/executable_file.sh + "name": "A String", + "parentPid": "A String", + "pid": "A String", + "script": { + "contents": "A String", + "diskPath": { + "partitionUuid": "A String", + "relativePath": "A String", }, - "fileLoadState": "A String", # The load state of the file. - "hashedSize": "A String", # The length in bytes of the file prefix that was hashed. If hashed_size == size, any hashes reported represent the entire file. - "operations": [ # Operation(s) performed on a file. - { # Operation(s) performed on a file. - "type": "A String", # The type of the operation + "fileLoadState": "A String", + "hashedSize": "A String", + "operations": [ + { + "type": "A String", }, ], - "partiallyHashed": True or False, # True when the hash covers only a prefix of the file. - "path": "A String", # Absolute path of the file as a JSON encoded string. - "sha256": "A String", # SHA256 hash of the first hashed_size bytes of the file encoded as a hex string. If hashed_size == size, sha256 represents the SHA256 hash of the entire file. - "size": "A String", # Size of the file in bytes. + "partiallyHashed": True or False, + "path": "A String", + "sha256": "A String", + "size": "A String", }, - "userId": "A String", # The ID of the user that executed the process. E.g. If this is the root user this will always be 0. + "userId": "A String", }, ], - "resourceName": "A String", # For findings on Google Cloud resources, the full resource name of the Google Cloud resource this finding is for. See: https://cloud.google.com/apis/design/resource_names#full_resource_name When the finding is for a non-Google Cloud resource, the resourceName can be a customer or partner defined string. This field is immutable after creation time. - "secret": { # Details about a secret or credential associated with the finding. # Secret associated with the finding. - "environmentVariable": { # Environment variable containing the secret. # The environment variable containing the secret. - "key": "A String", # Environment variable name as a JSON encoded string. Note that value is not included since the value contains the secret data, which is sensitive core content. + "resourceName": "A String", + "secret": { + "environmentVariable": { + "key": "A String", }, - "filePath": { # File path containing the secret. # The file containing the secret. - "path": "A String", # Path to the file. + "filePath": { + "path": "A String", }, - "status": { # The status of the secret. # The status of the secret. - "lastUpdatedTime": "A String", # Time that the secret was found. - "validity": "A String", # The validity of the secret. + "status": { + "lastUpdatedTime": "A String", + "validity": "A String", }, - "type": "A String", # The type of secret, for example, GCP_API_KEY. + "type": "A String", }, - "securityMarks": { # User specified security marks that are attached to the parent Security Command Center resource. Security marks are scoped within a Security Command Center organization -- they can be modified and viewed by all users who have proper permissions on the organization. # Output only. User specified security marks. These marks are entirely managed by the user and come from the SecurityMarks resource that belongs to the finding. - "canonicalName": "A String", # The canonical name of the marks. Examples: "organizations/{organization_id}/assets/{asset_id}/securityMarks" "folders/{folder_id}/assets/{asset_id}/securityMarks" "projects/{project_number}/assets/{asset_id}/securityMarks" "organizations/{organization_id}/sources/{source_id}/findings/{finding_id}/securityMarks" "folders/{folder_id}/sources/{source_id}/findings/{finding_id}/securityMarks" "projects/{project_number}/sources/{source_id}/findings/{finding_id}/securityMarks" - "marks": { # Mutable user specified security marks belonging to the parent resource. Constraints are as follows: * Keys and values are treated as case insensitive * Keys must be between 1 - 256 characters (inclusive) * Keys must be letters, numbers, underscores, or dashes * Values have leading and trailing whitespace trimmed, remaining characters must be between 1 - 4096 characters (inclusive) + "securityMarks": { + "canonicalName": "A String", + "marks": { "a_key": "A String", }, - "name": "A String", # The relative resource name of the SecurityMarks. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Examples: "organizations/{organization_id}/assets/{asset_id}/securityMarks" "organizations/{organization_id}/sources/{source_id}/findings/{finding_id}/securityMarks". - }, - "securityPosture": { # Represents a posture that is deployed on Google Cloud by the Security Command Center Posture Management service. A posture contains one or more policy sets. A policy set is a group of policies that enforce a set of security rules on Google Cloud. # The security posture associated with the finding. - "changedPolicy": "A String", # The name of the updated policy, for example, `projects/{project_id}/policies/{constraint_name}`. - "name": "A String", # Name of the posture, for example, `CIS-Posture`. - "policy": "A String", # The ID of the updated policy, for example, `compute-policy-1`. - "policyDriftDetails": [ # The details about a change in an updated policy that violates the deployed posture. - { # The policy field that violates the deployed posture and its expected and detected values. - "detectedValue": "A String", # The detected value that violates the deployed posture, for example, `false` or `allowed_values={"projects/22831892"}`. - "expectedValue": "A String", # The value of this field that was configured in a posture, for example, `true` or `allowed_values={"projects/29831892"}`. - "field": "A String", # The name of the updated field, for example constraint.implementation.policy_rules[0].enforce + "name": "A String", + }, + "securityPosture": { + "changedPolicy": "A String", + "name": "A String", + "policy": "A String", + "policyDriftDetails": [ + { + "detectedValue": "A String", + "expectedValue": "A String", + "field": "A String", }, ], - "policySet": "A String", # The name of the updated policyset, for example, `cis-policyset`. - "postureDeployment": "A String", # The name of the posture deployment, for example, `organizations/{org_id}/posturedeployments/{posture_deployment_id}`. - "postureDeploymentResource": "A String", # The project, folder, or organization on which the posture is deployed, for example, `projects/{project_number}`. - "revisionId": "A String", # The version of the posture, for example, `c7cfa2a8`. + "policySet": "A String", + "postureDeployment": "A String", + "postureDeploymentResource": "A String", + "revisionId": "A String", }, - "severity": "A String", # The severity of the finding. This field is managed by the source that writes the finding. - "sourceProperties": { # Source specific properties. These properties are managed by the source that writes the finding. The key names in the source_properties map must be between 1 and 255 characters, and must start with a letter and contain alphanumeric characters or underscores only. + "severity": "A String", + "sourceProperties": { "a_key": "", }, - "state": "A String", # The state of the finding. - "toxicCombination": { # Contains details about a group of security issues that, when the issues occur together, represent a greater risk than when the issues occur independently. A group of such issues is referred to as a toxic combination. # Contains details about a group of security issues that, when the issues occur together, represent a greater risk than when the issues occur independently. A group of such issues is referred to as a toxic combination. This field cannot be updated. Its value is ignored in all update requests. - "attackExposureScore": 3.14, # The [Attack exposure score](https://cloud.google.com/security-command-center/docs/attack-exposure-learn#attack_exposure_scores) of this toxic combination. The score is a measure of how much this toxic combination exposes one or more high-value resources to potential attack. - "relatedFindings": [ # List of resource names of findings associated with this toxic combination. For example, `organizations/123/sources/456/findings/789`. + "state": "A String", + "toxicCombination": { + "attackExposureScore": 3.14, + "relatedFindings": [ "A String", ], }, - "vertexAi": { # Vertex AI-related information associated with the finding. # VertexAi associated with the finding. - "datasets": [ # Datasets associated with the finding. - { # Vertex AI dataset associated with the finding. - "displayName": "A String", # The user defined display name of dataset, e.g. plants-dataset - "name": "A String", # Resource name of the dataset, e.g. projects/{project}/locations/{location}/datasets/2094040236064505856 - "source": "A String", # Data source, such as BigQuery source URI, e.g. bq://scc-nexus-test.AIPPtest.gsod + "vertexAi": { + "datasets": [ + { + "displayName": "A String", + "name": "A String", + "source": "A String", }, ], - "pipelines": [ # Pipelines associated with the finding. - { # Vertex AI training pipeline associated with the finding. - "displayName": "A String", # The user defined display name of pipeline, e.g. plants-classification - "name": "A String", # Resource name of the pipeline, e.g. projects/{project}/locations/{location}/trainingPipelines/5253428229225578496 + "pipelines": [ + { + "displayName": "A String", + "name": "A String", }, ], }, - "vulnerability": { # Refers to common vulnerability fields e.g. cve, cvss, cwe etc. # Represents vulnerability-specific fields like CVE and CVSS scores. CVE stands for Common Vulnerabilities and Exposures (https://cve.mitre.org/about/) - "cve": { # CVE stands for Common Vulnerabilities and Exposures. Information from the [CVE record](https://www.cve.org/ResourcesSupport/Glossary) that describes this vulnerability. # CVE stands for Common Vulnerabilities and Exposures (https://cve.mitre.org/about/) - "cvssv3": { # Common Vulnerability Scoring System version 3. # Describe Common Vulnerability Scoring System specified at https://www.first.org/cvss/v3.1/specification-document - "attackComplexity": "A String", # This metric describes the conditions beyond the attacker's control that must exist in order to exploit the vulnerability. - "attackVector": "A String", # Base Metrics Represents the intrinsic characteristics of a vulnerability that are constant over time and across user environments. This metric reflects the context by which vulnerability exploitation is possible. - "availabilityImpact": "A String", # This metric measures the impact to the availability of the impacted component resulting from a successfully exploited vulnerability. - "baseScore": 3.14, # The base score is a function of the base metric scores. - "confidentialityImpact": "A String", # This metric measures the impact to the confidentiality of the information resources managed by a software component due to a successfully exploited vulnerability. - "integrityImpact": "A String", # This metric measures the impact to integrity of a successfully exploited vulnerability. - "privilegesRequired": "A String", # This metric describes the level of privileges an attacker must possess before successfully exploiting the vulnerability. - "scope": "A String", # The Scope metric captures whether a vulnerability in one vulnerable component impacts resources in components beyond its security scope. - "userInteraction": "A String", # This metric captures the requirement for a human user, other than the attacker, to participate in the successful compromise of the vulnerable component. + "vulnerability": { + "cve": { + "cvssv3": { + "attackComplexity": "A String", + "attackVector": "A String", + "availabilityImpact": "A String", + "baseScore": 3.14, + "confidentialityImpact": "A String", + "integrityImpact": "A String", + "privilegesRequired": "A String", + "scope": "A String", + "userInteraction": "A String", }, - "exploitReleaseDate": "A String", # Date the first publicly available exploit or PoC was released. - "exploitationActivity": "A String", # The exploitation activity of the vulnerability in the wild. - "firstExploitationDate": "A String", # Date of the earliest known exploitation. - "id": "A String", # The unique identifier for the vulnerability. e.g. CVE-2021-34527 - "impact": "A String", # The potential impact of the vulnerability if it was to be exploited. - "observedInTheWild": True or False, # Whether or not the vulnerability has been observed in the wild. - "references": [ # Additional information about the CVE. e.g. https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2021-34527 - { # Additional Links - "source": "A String", # Source of the reference e.g. NVD - "uri": "A String", # Uri for the mentioned source e.g. https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2021-34527. + "exploitReleaseDate": "A String", + "exploitationActivity": "A String", + "firstExploitationDate": "A String", + "id": "A String", + "impact": "A String", + "observedInTheWild": True or False, + "references": [ + { + "source": "A String", + "uri": "A String", }, ], - "upstreamFixAvailable": True or False, # Whether upstream fix is available for the CVE. - "zeroDay": True or False, # Whether or not the vulnerability was zero day when the finding was published. - }, - "cwes": [ # Represents one or more Common Weakness Enumeration (CWE) information on this vulnerability. - { # CWE stands for Common Weakness Enumeration. Information about this weakness, as described by [CWE](https://cwe.mitre.org/). - "id": "A String", # The CWE identifier, e.g. CWE-94 - "references": [ # Any reference to the details on the CWE, for example, https://cwe.mitre.org/data/definitions/94.html - { # Additional Links - "source": "A String", # Source of the reference e.g. NVD - "uri": "A String", # Uri for the mentioned source e.g. https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2021-34527. + "upstreamFixAvailable": True or False, + "zeroDay": True or False, + }, + "cwes": [ + { + "id": "A String", + "references": [ + { + "source": "A String", + "uri": "A String", }, ], }, ], - "fixedPackage": { # Package is a generic definition of a package. # The fixed package is relevant to the finding. - "cpeUri": "A String", # The CPE URI where the vulnerability was detected. - "packageName": "A String", # The name of the package where the vulnerability was detected. - "packageType": "A String", # Type of package, for example, os, maven, or go. - "packageVersion": "A String", # The version of the package. + "fixedPackage": { + "cpeUri": "A String", + "packageName": "A String", + "packageType": "A String", + "packageVersion": "A String", }, - "offendingPackage": { # Package is a generic definition of a package. # The offending package is relevant to the finding. - "cpeUri": "A String", # The CPE URI where the vulnerability was detected. - "packageName": "A String", # The name of the package where the vulnerability was detected. - "packageType": "A String", # Type of package, for example, os, maven, or go. - "packageVersion": "A String", # The version of the package. + "offendingPackage": { + "cpeUri": "A String", + "packageName": "A String", + "packageType": "A String", + "packageVersion": "A String", }, - "providerRiskScore": "A String", # Provider provided risk_score based on multiple factors. The higher the risk score, the more risky the vulnerability is. - "reachable": True or False, # Represents whether the vulnerability is reachable (detected via static analysis) - "securityBulletin": { # SecurityBulletin are notifications of vulnerabilities of Google products. # The security bulletin is relevant to this finding. - "bulletinId": "A String", # ID of the bulletin corresponding to the vulnerability. - "submissionTime": "A String", # Submission time of this Security Bulletin. - "suggestedUpgradeVersion": "A String", # This represents a version that the cluster receiving this notification should be upgraded to, based on its current version. For example, 1.15.0 + "providerRiskScore": "A String", + "reachable": True or False, + "securityBulletin": { + "bulletinId": "A String", + "submissionTime": "A String", + "suggestedUpgradeVersion": "A String", }, }, }
@@ -2783,15 +2783,15 @@

Method Details

setMute(name, body=None, x__xgafv=None) -
Updates the mute state of a finding.
+  
 
 Args:
-  name: string, Required. The [relative resource name](https://cloud.google.com/apis/design/resource_names#relative_resource_name) of the finding. Example: `organizations/{organization_id}/sources/{source_id}/findings/{finding_id}`, `folders/{folder_id}/sources/{source_id}/findings/{finding_id}`, `projects/{project_id}/sources/{source_id}/findings/{finding_id}`. (required)
+  name: string, A parameter (required)
   body: object, The request body.
     The object takes the form of:
 
-{ # Request message for updating a finding's mute status.
-  "mute": "A String", # Required. The desired state of the Mute.
+{
+  "mute": "A String",
 }
 
   x__xgafv: string, V1 error format.
@@ -2802,811 +2802,811 @@ 

Method Details

Returns: An object of the form: - { # Security Command Center finding. A finding is a record of assessment data like security, risk, health, or privacy, that is ingested into Security Command Center for presentation, notification, analysis, policy testing, and enforcement. For example, a cross-site scripting (XSS) vulnerability in an App Engine application is a finding. - "access": { # Represents an access event. # Access details associated with the finding, such as more information on the caller, which method was accessed, and from where. - "callerIp": "A String", # Caller's IP address, such as "1.1.1.1". - "callerIpGeo": { # Represents a geographical location for a given access. # The caller IP's geolocation, which identifies where the call came from. - "regionCode": "A String", # A CLDR. - }, - "methodName": "A String", # The method that the service account called, e.g. "SetIamPolicy". - "principalEmail": "A String", # Associated email, such as "foo@google.com". The email address of the authenticated user or a service account acting on behalf of a 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). - "principalSubject": "A String", # A string that represents the principal_subject that is associated with the identity. Unlike `principal_email`, `principal_subject` supports principals that aren't associated with email addresses, such as third party principals. For most identities, the format is `principal://iam.googleapis.com/{identity pool name}/subject/{subject}`. Some GKE identities, such as GKE_WORKLOAD, FREEFORM, and GKE_HUB_WORKLOAD, still use the legacy format `serviceAccount:{identity pool name}[{subject}]`. - "serviceAccountDelegationInfo": [ # The identity delegation history of an authenticated service account that made the request. The `serviceAccountDelegationInfo[]` object contains information about the real authorities that try to access Google Cloud resources by delegating on a service account. When multiple authorities are present, they are guaranteed to be sorted based on the original ordering of the identity delegation events. - { # Identity delegation history of an authenticated service account. - "principalEmail": "A String", # The email address of a Google account. - "principalSubject": "A String", # A string representing the principal_subject associated with the identity. As compared to `principal_email`, supports principals that aren't associated with email addresses, such as third party principals. For most identities, the format will be `principal://iam.googleapis.com/{identity pool name}/subjects/{subject}` except for some GKE identities (GKE_WORKLOAD, FREEFORM, GKE_HUB_WORKLOAD) that are still in the legacy format `serviceAccount:{identity pool name}[{subject}]` + { + "access": { + "callerIp": "A String", + "callerIpGeo": { + "regionCode": "A String", + }, + "methodName": "A String", + "principalEmail": "A String", + "principalSubject": "A String", + "serviceAccountDelegationInfo": [ + { + "principalEmail": "A String", + "principalSubject": "A String", }, ], - "serviceAccountKeyName": "A String", # The name of the service account key that was used to create or exchange credentials when authenticating the service account that made the request. This is a scheme-less URI full resource name. For example: "//iam.googleapis.com/projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}/keys/{key}". - "serviceName": "A String", # This is the API service that the service account made a call to, e.g. "iam.googleapis.com" - "userAgent": "A String", # The caller's user agent string associated with the finding. - "userAgentFamily": "A String", # Type of user agent associated with the finding. For example, an operating system shell or an embedded or standalone application. - "userName": "A String", # A string that represents a username. The username provided depends on the type of the finding and is likely not an IAM principal. For example, this can be a system username if the finding is related to a virtual machine, or it can be an application login username. + "serviceAccountKeyName": "A String", + "serviceName": "A String", + "userAgent": "A String", + "userAgentFamily": "A String", + "userName": "A String", }, - "affectedResources": { # Details about resources affected by this finding. # AffectedResources associated with the finding. - "count": "A String", # The count of resources affected by the finding. + "affectedResources": { + "count": "A String", }, - "agentDataAccessEvents": [ # Agent data access events associated with the finding. - { # Details about a data access attempt made by an agent principal not authorized under applicable data security policy. - "eventId": "A String", # Unique identifier for data access event. - "eventTime": "A String", # Timestamp of data access event. - "operation": "A String", # The operation performed by the principal to access the data. - "principalSubject": "A String", # The agent principal that accessed the data. + "agentDataAccessEvents": [ + { + "eventId": "A String", + "eventTime": "A String", + "operation": "A String", + "principalSubject": "A String", }, ], - "aiModel": { # Contains information about the AI model associated with the finding. # The AI model associated with the finding. - "deploymentPlatform": "A String", # The platform on which the model is deployed. - "displayName": "A String", # The user defined display name of model. Ex. baseline-classification-model - "domain": "A String", # The domain of the model, for example, “image-classification”. - "library": "A String", # The name of the model library, for example, “transformers”. - "location": "A String", # The region in which the model is used, for example, “us-central1”. - "name": "A String", # The name of the AI model, for example, "gemini:1.0.0". - "publisher": "A String", # The publisher of the model, for example, “google” or “nvidia”. - "usageCategory": "A String", # The purpose of the model, for example, "Inteference" or "Training". - }, - "application": { # Represents an application associated with a finding. # Represents an application associated with the finding. - "baseUri": "A String", # The base URI that identifies the network location of the application in which the vulnerability was detected. For example, `http://example.com`. - "fullUri": "A String", # The full URI with payload that can be used to reproduce the vulnerability. For example, `http://example.com?p=aMmYgI6H`. - }, - "artifactGuardPolicies": { # Represents the result of evaluating artifact guard policies. # ArtifactGuardPolicies associated with the finding. - "failingPolicies": [ # A list of failing policies. - { # Represents an artifact guard policy. - "failureReason": "A String", # The reason for the policy failure, for example, "severity=HIGH AND max_vuln_count=2". - "policyId": "A String", # The ID of the failing policy, for example, "organizations/3392779/locations/global/policies/prod-policy". - "type": "A String", # The type of the policy evaluation. + "aiModel": { + "deploymentPlatform": "A String", + "displayName": "A String", + "domain": "A String", + "library": "A String", + "location": "A String", + "name": "A String", + "publisher": "A String", + "usageCategory": "A String", + }, + "application": { + "baseUri": "A String", + "fullUri": "A String", + }, + "artifactGuardPolicies": { + "failingPolicies": [ + { + "failureReason": "A String", + "policyId": "A String", + "type": "A String", }, ], - "resourceId": "A String", # The ID of the resource that has policies configured for it. + "resourceId": "A String", }, - "attackExposure": { # An attack exposure contains the results of an attack path simulation run. # The results of an attack path simulation relevant to this finding. - "attackExposureResult": "A String", # The resource name of the attack path simulation result that contains the details regarding this attack exposure score. Example: `organizations/123/simulations/456/attackExposureResults/789` - "exposedHighValueResourcesCount": 42, # The number of high value resources that are exposed as a result of this finding. - "exposedLowValueResourcesCount": 42, # The number of high value resources that are exposed as a result of this finding. - "exposedMediumValueResourcesCount": 42, # The number of medium value resources that are exposed as a result of this finding. - "latestCalculationTime": "A String", # The most recent time the attack exposure was updated on this finding. - "score": 3.14, # A number between 0 (inclusive) and infinity that represents how important this finding is to remediate. The higher the score, the more important it is to remediate. - "state": "A String", # What state this AttackExposure is in. This captures whether or not an attack exposure has been calculated or not. + "attackExposure": { + "attackExposureResult": "A String", + "exposedHighValueResourcesCount": 42, + "exposedLowValueResourcesCount": 42, + "exposedMediumValueResourcesCount": 42, + "latestCalculationTime": "A String", + "score": 3.14, + "state": "A String", }, - "backupDisasterRecovery": { # Information related to Google Cloud Backup and DR Service findings. # Fields related to Backup and DR findings. - "appliance": "A String", # The name of the Backup and DR appliance that captures, moves, and manages the lifecycle of backup data. For example, `backup-server-57137`. - "applications": [ # The names of Backup and DR applications. An application is a VM, database, or file system on a managed host monitored by a backup and recovery appliance. For example, `centos7-01-vol00`, `centos7-01-vol01`, `centos7-01-vol02`. + "backupDisasterRecovery": { + "appliance": "A String", + "applications": [ "A String", ], - "backupCreateTime": "A String", # The timestamp at which the Backup and DR backup was created. - "backupTemplate": "A String", # The name of a Backup and DR template which comprises one or more backup policies. See the [Backup and DR documentation](https://cloud.google.com/backup-disaster-recovery/docs/concepts/backup-plan#temp) for more information. For example, `snap-ov`. - "backupType": "A String", # The backup type of the Backup and DR image. For example, `Snapshot`, `Remote Snapshot`, `OnVault`. - "host": "A String", # The name of a Backup and DR host, which is managed by the backup and recovery appliance and known to the management console. The host can be of type Generic (for example, Compute Engine, SQL Server, Oracle DB, SMB file system, etc.), vCenter, or an ESX server. See the [Backup and DR documentation on hosts](https://cloud.google.com/backup-disaster-recovery/docs/configuration/manage-hosts-and-their-applications) for more information. For example, `centos7-01`. - "policies": [ # The names of Backup and DR policies that are associated with a template and that define when to run a backup, how frequently to run a backup, and how long to retain the backup image. For example, `onvaults`. + "backupCreateTime": "A String", + "backupTemplate": "A String", + "backupType": "A String", + "host": "A String", + "policies": [ "A String", ], - "policyOptions": [ # The names of Backup and DR advanced policy options of a policy applying to an application. See the [Backup and DR documentation on policy options](https://cloud.google.com/backup-disaster-recovery/docs/create-plan/policy-settings). For example, `skipofflineappsincongrp, nounmap`. + "policyOptions": [ "A String", ], - "profile": "A String", # The name of the Backup and DR resource profile that specifies the storage media for backups of application and VM data. See the [Backup and DR documentation on profiles](https://cloud.google.com/backup-disaster-recovery/docs/concepts/backup-plan#profile). For example, `GCP`. - "storagePool": "A String", # The name of the Backup and DR storage pool that the backup and recovery appliance is storing data in. The storage pool could be of type Cloud, Primary, Snapshot, or OnVault. See the [Backup and DR documentation on storage pools](https://cloud.google.com/backup-disaster-recovery/docs/concepts/storage-pools). For example, `DiskPoolOne`. + "profile": "A String", + "storagePool": "A String", }, - "canonicalName": "A String", # The canonical name of the finding. It's either "organizations/{organization_id}/sources/{source_id}/findings/{finding_id}", "folders/{folder_id}/sources/{source_id}/findings/{finding_id}" or "projects/{project_number}/sources/{source_id}/findings/{finding_id}", depending on the closest CRM ancestor of the resource associated with the finding. - "category": "A String", # The additional taxonomy group within findings from a given source. This field is immutable after creation time. Example: "XSS_FLASH_INJECTION" - "chokepoint": { # Contains details about a chokepoint, which is a resource or resource group where high-risk attack paths converge, based on [attack path simulations] (https://cloud.google.com/security-command-center/docs/attack-exposure-learn#attack_path_simulations). # Contains details about a chokepoint, which is a resource or resource group where high-risk attack paths converge, based on [attack path simulations] (https://cloud.google.com/security-command-center/docs/attack-exposure-learn#attack_path_simulations). This field cannot be updated. Its value is ignored in all update requests. - "relatedFindings": [ # List of resource names of findings associated with this chokepoint. For example, organizations/123/sources/456/findings/789. This list will have at most 100 findings. + "canonicalName": "A String", + "category": "A String", + "chokepoint": { + "relatedFindings": [ "A String", ], }, - "cloudArmor": { # Fields related to Google Cloud Armor findings. # Fields related to Cloud Armor findings. - "adaptiveProtection": { # Information about [Google Cloud Armor Adaptive Protection](https://cloud.google.com/armor/docs/cloud-armor-overview#google-cloud-armor-adaptive-protection). # Information about potential Layer 7 DDoS attacks identified by [Google Cloud Armor Adaptive Protection](https://cloud.google.com/armor/docs/adaptive-protection-overview). - "confidence": 3.14, # A score of 0 means that there is low confidence that the detected event is an actual attack. A score of 1 means that there is high confidence that the detected event is an attack. See the [Adaptive Protection documentation](https://cloud.google.com/armor/docs/adaptive-protection-overview#configure-alert-tuning) for further explanation. - }, - "attack": { # Information about DDoS attack volume and classification. # Information about DDoS attack volume and classification. - "classification": "A String", # Type of attack, for example, 'SYN-flood', 'NTP-udp', or 'CHARGEN-udp'. - "volumeBps": 42, # Total BPS (bytes per second) volume of attack. Deprecated - refer to volume_bps_long instead. - "volumeBpsLong": "A String", # Total BPS (bytes per second) volume of attack. - "volumePps": 42, # Total PPS (packets per second) volume of attack. Deprecated - refer to volume_pps_long instead. - "volumePpsLong": "A String", # Total PPS (packets per second) volume of attack. - }, - "duration": "A String", # Duration of attack from the start until the current moment (updated every 5 minutes). - "requests": { # Information about the requests relevant to the finding. # Information about incoming requests evaluated by [Google Cloud Armor security policies](https://cloud.google.com/armor/docs/security-policy-overview). - "longTermAllowed": 42, # Allowed RPS (requests per second) over the long term. - "longTermDenied": 42, # Denied RPS (requests per second) over the long term. - "ratio": 3.14, # For 'Increasing deny ratio', the ratio is the denied traffic divided by the allowed traffic. For 'Allowed traffic spike', the ratio is the allowed traffic in the short term divided by allowed traffic in the long term. - "shortTermAllowed": 42, # Allowed RPS (requests per second) in the short term. - }, - "securityPolicy": { # Information about the [Google Cloud Armor security policy](https://cloud.google.com/armor/docs/security-policy-overview) relevant to the finding. # Information about the [Google Cloud Armor security policy](https://cloud.google.com/armor/docs/security-policy-overview) relevant to the finding. - "name": "A String", # The name of the Google Cloud Armor security policy, for example, "my-security-policy". - "preview": True or False, # Whether or not the associated rule or policy is in preview mode. - "type": "A String", # The type of Google Cloud Armor security policy for example, 'backend security policy', 'edge security policy', 'network edge security policy', or 'always-on DDoS protection'. - }, - "threatVector": "A String", # Distinguish between volumetric & protocol DDoS attack and application layer attacks. For example, "L3_4" for Layer 3 and Layer 4 DDoS attacks, or "L_7" for Layer 7 DDoS attacks. - }, - "cloudDlpDataProfile": { # The [data profile](https://cloud.google.com/dlp/docs/data-profiles) associated with the finding. # Cloud DLP data profile that is associated with the finding. - "dataProfile": "A String", # Name of the data profile, for example, `projects/123/locations/europe/tableProfiles/8383929`. - "infoTypes": [ # Type of information detected by SDP. Info type includes name, version and sensitivity of the detected information type. - { # Type of information detected by the API. - "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. - "sensitivityScore": { # Score is calculated from of all elements in the data profile. A higher level means the data is more sensitive. # Optional custom sensitivity for this InfoType. This only applies to data profiling. - "score": "A String", # The sensitivity score applied to the resource. + "cloudArmor": { + "adaptiveProtection": { + "confidence": 3.14, + }, + "attack": { + "classification": "A String", + "volumeBps": 42, + "volumeBpsLong": "A String", + "volumePps": 42, + "volumePpsLong": "A String", + }, + "duration": "A String", + "requests": { + "longTermAllowed": 42, + "longTermDenied": 42, + "ratio": 3.14, + "shortTermAllowed": 42, + }, + "securityPolicy": { + "name": "A String", + "preview": True or False, + "type": "A String", + }, + "threatVector": "A String", + }, + "cloudDlpDataProfile": { + "dataProfile": "A String", + "infoTypes": [ + { + "name": "A String", + "sensitivityScore": { + "score": "A String", }, - "version": "A String", # Optional version name for this InfoType. + "version": "A String", }, ], - "parentType": "A String", # The resource hierarchy level at which the data profile was generated. + "parentType": "A String", }, - "cloudDlpInspection": { # Details about the Cloud Data Loss Prevention (Cloud DLP) [inspection job](https://cloud.google.com/dlp/docs/concepts-job-triggers) that produced the finding. # Cloud Data Loss Prevention (Cloud DLP) inspection results that are associated with the finding. - "fullScan": True or False, # Whether Cloud DLP scanned the complete resource or a sampled subset. - "infoType": "A String", # The type of information (or *[infoType](https://cloud.google.com/dlp/docs/infotypes-reference)*) found, for example, `EMAIL_ADDRESS` or `STREET_ADDRESS`. - "infoTypeCount": "A String", # The number of times Cloud DLP found this infoType within this job and resource. - "inspectJob": "A String", # Name of the inspection job, for example, `projects/123/locations/europe/dlpJobs/i-8383929`. + "cloudDlpInspection": { + "fullScan": True or False, + "infoType": "A String", + "infoTypeCount": "A String", + "inspectJob": "A String", }, - "complianceDetails": { # Compliance Details associated with the finding. # Details about the compliance implications of the finding. - "cloudControl": { # CloudControl associated with the finding. # CloudControl associated with the finding - "cloudControlName": "A String", # Name of the CloudControl associated with the finding. - "policyType": "A String", # Policy type of the CloudControl - "type": "A String", # Type of cloud control. - "version": 42, # Version of the Cloud Control + "complianceDetails": { + "cloudControl": { + "cloudControlName": "A String", + "policyType": "A String", + "type": "A String", + "version": 42, }, - "cloudControlDeploymentNames": [ # Cloud Control Deployments associated with the finding. For example, organizations/123/locations/global/cloudControlDeployments/deploymentIdentifier + "cloudControlDeploymentNames": [ "A String", ], - "frameworks": [ # Details of Frameworks associated with the finding - { # Compliance framework associated with the finding. - "category": [ # Category of the framework associated with the finding. E.g. Security Benchmark, or Assured Workloads + "frameworks": [ + { + "category": [ "A String", ], - "controls": [ # The controls associated with the framework. - { # Compliance control associated with the finding. - "controlName": "A String", # Name of the Control - "displayName": "A String", # Display name of the control. For example, AU-02. + "controls": [ + { + "controlName": "A String", + "displayName": "A String", }, ], - "displayName": "A String", # Display name of the framework. For a standard framework, this will look like e.g. PCI DSS 3.2.1, whereas for a custom framework it can be a user defined string like MyFramework - "name": "A String", # Name of the framework associated with the finding - "type": "A String", # Type of the framework associated with the finding, to specify whether the framework is built-in (pre-defined and immutable) or a custom framework defined by the customer (equivalent to security posture) + "displayName": "A String", + "name": "A String", + "type": "A String", }, ], }, - "compliances": [ # Contains compliance information for security standards associated to the finding. - { # Contains compliance information about a security standard indicating unmet recommendations. - "ids": [ # Policies within the standard or benchmark, for example, A.12.4.1 + "compliances": [ + { + "ids": [ "A String", ], - "standard": "A String", # Industry-wide compliance standards or benchmarks, such as CIS, PCI, and OWASP. - "version": "A String", # Version of the standard or benchmark, for example, 1.1 + "standard": "A String", + "version": "A String", }, ], - "connections": [ # Contains information about the IP connection associated with the finding. - { # Contains information about the IP connection associated with the finding. - "destinationIp": "A String", # Destination IP address. Not present for sockets that are listening and not connected. - "destinationPort": 42, # Destination port. Not present for sockets that are listening and not connected. - "protocol": "A String", # IANA Internet Protocol Number such as TCP(6) and UDP(17). - "sourceIp": "A String", # Source IP address. - "sourcePort": 42, # Source port. + "connections": [ + { + "destinationIp": "A String", + "destinationPort": 42, + "protocol": "A String", + "sourceIp": "A String", + "sourcePort": 42, }, ], - "contacts": { # Output only. Map containing the points of contact for the given finding. The key represents the type of contact, while the value contains a list of all the contacts that pertain. Please refer to: https://cloud.google.com/resource-manager/docs/managing-notification-contacts#notification-categories { "security": { "contacts": [ { "email": "person1@company.com" }, { "email": "person2@company.com" } ] } } - "a_key": { # Details about specific contacts - "contacts": [ # A list of contacts - { # The email address of a contact. - "email": "A String", # An email address. For example, "`person123@company.com`". + "contacts": { + "a_key": { + "contacts": [ + { + "email": "A String", }, ], }, }, - "containers": [ # Containers associated with the finding. This field provides information for both Kubernetes and non-Kubernetes containers. - { # Container associated with the finding. - "createTime": "A String", # The time that the container was created. - "imageId": "A String", # Optional container image ID, if provided by the container runtime. Uniquely identifies the container image launched using a container image digest. - "labels": [ # Container labels, as provided by the container runtime. - { # Represents a generic name-value label. A label has separate name and value fields to support filtering with the `contains()` function. For more information, see [Filtering on array-type fields](https://cloud.google.com/security-command-center/docs/how-to-api-list-findings#array-contains-filtering). - "name": "A String", # Name of the label. - "value": "A String", # Value that corresponds to the label's name. + "containers": [ + { + "createTime": "A String", + "imageId": "A String", + "labels": [ + { + "name": "A String", + "value": "A String", }, ], - "name": "A String", # Name of the container. - "uri": "A String", # Container image URI provided when configuring a pod or container. This string can identify a container image version using mutable tags. + "name": "A String", + "uri": "A String", }, ], - "createTime": "A String", # The time at which the finding was created in Security Command Center. - "dataAccessEvents": [ # Data access events associated with the finding. - { # Details about a data access attempt made by a principal not authorized under applicable data security policy. - "eventId": "A String", # Unique identifier for data access event. - "eventTime": "A String", # Timestamp of data access event. - "operation": "A String", # The operation performed by the principal to access the data. - "principalEmail": "A String", # The email address of the principal that accessed the data. The principal could be a user account, service account, Google group, or other. + "createTime": "A String", + "dataAccessEvents": [ + { + "eventId": "A String", + "eventTime": "A String", + "operation": "A String", + "principalEmail": "A String", }, ], - "dataFlowEvents": [ # Data flow events associated with the finding. - { # Details about a data flow event, in which either the data is moved to or is accessed from a non-compliant geo-location, as defined in the applicable data security policy. - "eventId": "A String", # Unique identifier for data flow event. - "eventTime": "A String", # Timestamp of data flow event. - "operation": "A String", # The operation performed by the principal for the data flow event. - "principalEmail": "A String", # The email address of the principal that initiated the data flow event. The principal could be a user account, service account, Google group, or other. - "violatedLocation": "A String", # Non-compliant location of the principal or the data destination. + "dataFlowEvents": [ + { + "eventId": "A String", + "eventTime": "A String", + "operation": "A String", + "principalEmail": "A String", + "violatedLocation": "A String", }, ], - "dataRetentionDeletionEvents": [ # Data retention deletion events associated with the finding. - { # Details about data retention deletion violations, in which the data is non-compliant based on their retention or deletion time, as defined in the applicable data security policy. The Data Retention Deletion (DRD) control is a control of the DSPM (Data Security Posture Management) suite that enables organizations to manage data retention and deletion policies in compliance with regulations, such as GDPR and CRPA. DRD supports two primary policy types: maximum storage length (max TTL) and minimum storage length (min TTL). Both are aimed at helping organizations meet regulatory and data management commitments. - "dataObjectCount": "A String", # Number of objects that violated the policy for this resource. If the number is less than 1,000, then the value of this field is the exact number. If the number of objects that violated the policy is greater than or equal to 1,000, then the value of this field is 1000. - "eventDetectionTime": "A String", # Timestamp indicating when the event was detected. - "eventType": "A String", # Type of the DRD event. - "maxRetentionAllowed": "A String", # Maximum duration of retention allowed from the DRD control. This comes from the DRD control where users set a max TTL for their data. For example, suppose that a user sets the max TTL for a Cloud Storage bucket to 90 days. However, an object in that bucket is 100 days old. In this case, a DataRetentionDeletionEvent will be generated for that Cloud Storage bucket, and the max_retention_allowed is 90 days. - "minRetentionAllowed": "A String", # Min duration of retention allowed from the DSPM retention control. This field is only populated when event type is set to EVENT_TYPE_MIN_TTL_FROM_CREATION. + "dataRetentionDeletionEvents": [ + { + "dataObjectCount": "A String", + "eventDetectionTime": "A String", + "eventType": "A String", + "maxRetentionAllowed": "A String", + "minRetentionAllowed": "A String", }, ], - "database": { # Represents database access information, such as queries. A database may be a sub-resource of an instance (as in the case of Cloud SQL instances or Cloud Spanner instances), or the database instance itself. Some database resources might not have the [full resource name](https://google.aip.dev/122#full-resource-names) populated because these resource types, such as Cloud SQL databases, are not yet supported by Cloud Asset Inventory. In these cases only the display name is provided. # Database associated with the finding. - "displayName": "A String", # The human-readable name of the database that the user connected to. - "grantees": [ # The target usernames, roles, or groups of an SQL privilege grant, which is not an IAM policy change. + "database": { + "displayName": "A String", + "grantees": [ "A String", ], - "name": "A String", # Some database resources may not have the [full resource name](https://google.aip.dev/122#full-resource-names) populated because these resource types are not yet supported by Cloud Asset Inventory (e.g. Cloud SQL databases). In these cases only the display name will be provided. The [full resource name](https://google.aip.dev/122#full-resource-names) of the database that the user connected to, if it is supported by Cloud Asset Inventory. - "query": "A String", # The SQL statement that is associated with the database access. - "userName": "A String", # The username used to connect to the database. The username might not be an IAM principal and does not have a set format. - "version": "A String", # The version of the database, for example, POSTGRES_14. See [the complete list](https://cloud.google.com/sql/docs/mysql/admin-api/rest/v1/SqlDatabaseVersion). - }, - "description": "A String", # Contains more details about the finding. - "discoveredWorkload": { # Represents discovered, customer managed workload that is not registered with the respective GCP service. # DiscoveredWorkload associated with the finding. - "confidence": "A String", # The confidence in detection of this workload. - "detectedRelevantHardware": True or False, # A boolean flag set to true if associated hardware strongly predicts the workload type. - "detectedRelevantKeywords": True or False, # A boolean flag set to true if associated keywords strongly predict the workload type. - "detectedRelevantPackages": True or False, # A boolean flag set to true if installed packages strongly predict the workload type. - "workloadType": "A String", # The type of workload. - }, - "disk": { # Contains information about the disk associated with the finding. # Disk associated with the finding. - "name": "A String", # The name of the disk, for example, "https://www.googleapis.com/compute/v1/projects/{project-id}/zones/{zone-id}/disks/{disk-id}". - }, - "eventTime": "A String", # The time the finding was first detected. If an existing finding is updated, then this is the time the update occurred. For example, if the finding represents an open firewall, this property captures the time the detector believes the firewall became open. The accuracy is determined by the detector. If the finding is later resolved, then this time reflects when the finding was resolved. This must not be set to a value greater than the current timestamp. - "exfiltration": { # Exfiltration represents a data exfiltration attempt from one or more sources to one or more targets. The `sources` attribute lists the sources of the exfiltrated data. The `targets` attribute lists the destinations the data was copied to. # Represents exfiltrations associated with the finding. - "sources": [ # If there are multiple sources, then the data is considered "joined" between them. For instance, BigQuery can join multiple tables, and each table would be considered a source. - { # Resource where data was exfiltrated from or exfiltrated to. - "components": [ # Subcomponents of the asset that was exfiltrated, like URIs used during exfiltration, table names, databases, and filenames. For example, multiple tables might have been exfiltrated from the same Cloud SQL instance, or multiple files might have been exfiltrated from the same Cloud Storage bucket. + "name": "A String", + "query": "A String", + "userName": "A String", + "version": "A String", + }, + "description": "A String", + "discoveredWorkload": { + "confidence": "A String", + "detectedRelevantHardware": True or False, + "detectedRelevantKeywords": True or False, + "detectedRelevantPackages": True or False, + "workloadType": "A String", + }, + "disk": { + "name": "A String", + }, + "eventTime": "A String", + "exfiltration": { + "sources": [ + { + "components": [ "A String", ], - "name": "A String", # The resource's [full resource name](https://cloud.google.com/apis/design/resource_names#full_resource_name). + "name": "A String", }, ], - "targets": [ # If there are multiple targets, each target would get a complete copy of the "joined" source data. - { # Resource where data was exfiltrated from or exfiltrated to. - "components": [ # Subcomponents of the asset that was exfiltrated, like URIs used during exfiltration, table names, databases, and filenames. For example, multiple tables might have been exfiltrated from the same Cloud SQL instance, or multiple files might have been exfiltrated from the same Cloud Storage bucket. + "targets": [ + { + "components": [ "A String", ], - "name": "A String", # The resource's [full resource name](https://cloud.google.com/apis/design/resource_names#full_resource_name). + "name": "A String", }, ], - "totalExfiltratedBytes": "A String", # Total exfiltrated bytes processed for the entire job. - }, - "externalExposure": { # Details about the externally exposed resource associated with the finding. # External exposure associated with the finding. - "backendBucket": "A String", # The full resource name of the load balancer backend bucket, for example, "//compute.googleapis.com/projects/{project-id}/global/backendBuckets/{name}" - "backendService": "A String", # The full resource name of load balancer backend service, for example, "//compute.googleapis.com/projects/{project-id}/global/backendServices/{name}". - "exposedApplication": "A String", # The name and version of the exposed web application, for example, "Jenkins 2.184". - "exposedEndpoint": "A String", # The resource which is running the exposed service, for example, "//compute.googleapis.com/projects/{project-id}/zones/{zone}/instances/{instance}.” - "exposedService": "A String", # The name and version of the service, for example, "Jupyter Notebook 6.14.0". - "forwardingRule": "A String", # The full resource name of the forwarding rule, for example, "//compute.googleapis.com/projects/{project-id}/global/forwardingRules/{forwarding-rule-name}". - "hostnameUri": "A String", # Hostname of the exposed application, for example, "https://test-app.a.run.app/" - "httpResponse": [ # The http response returned by the web application. - { # The http response returned by the web application. - "path": "A String", # The http path for which response code was returned by web application, for example, "https://test-app.a.run.app/test". - "statusCode": "A String", # The http response code returned by the web application, for example, 200. + "totalExfiltratedBytes": "A String", + }, + "externalExposure": { + "backendBucket": "A String", + "backendService": "A String", + "exposedApplication": "A String", + "exposedEndpoint": "A String", + "exposedService": "A String", + "forwardingRule": "A String", + "hostnameUri": "A String", + "httpResponse": [ + { + "path": "A String", + "statusCode": "A String", }, ], - "instanceGroup": "A String", # The full resource name of the instance group, for example, "//compute.googleapis.com/projects/{project-id}/global/instanceGroups/{name}". - "internalBackendService": "A String", # The full resource name of load balancer backend service in the internal project having resource exposed via PSC, for example, "//compute.googleapis.com/projects/{project-id}/global/backendServices/{name}". - "loadBalancerFirewallPolicy": "A String", # The full resource name of the load balancer firewall policy, for example, "//compute.googleapis.com/projects/{project-id}/global/firewallPolicies/{policy-name}". - "networkEndpointGroup": "A String", # The full resource name of the network endpoint group, for example, "//compute.googleapis.com/projects/{project-id}/global/networkEndpointGroups/{name}". - "networkIngressFirewallPolicy": "A String", # The full resource name of the network ingress firewall policy, for example, "//compute.googleapis.com/projects/{project-id}/global/firewallPolicies/{name}". - "privateIpAddress": "A String", # Private IP address of the exposed endpoint. - "privatePort": "A String", # Port number associated with private IP address. - "pscNetworkAttachment": "A String", # The full resource name of the PSC (Private Service Connect) network attachment that network interface controller is attached to, for example, "//compute.googleapis.com/projects/{project-id}/regions/{region}/networkAttachments/{name}" - "pscServiceAttachment": "A String", # The full resource name of the PSC (Private Service Connect) service attachment that the load balancer network endpoint group targets, for example, "//compute.googleapis.com/projects/{project-id}/regions/{region}/serviceAttachments/{name}" - "publicIpAddress": "A String", # Public IP address of the exposed endpoint. - "publicPort": "A String", # Public port number of the exposed endpoint. - "serviceFirewallPolicy": "A String", # The full resource name of the firewall policy of the exposed service, for example, "//compute.googleapis.com/projects/{project-id}/global/firewallPolicies/{policy-name}". - }, - "externalSystems": { # Output only. Third party SIEM/SOAR fields within SCC, contains external system information and external system finding fields. - "a_key": { # Representation of third party SIEM/SOAR fields within SCC. - "assignees": [ # References primary/secondary etc assignees in the external system. + "instanceGroup": "A String", + "internalBackendService": "A String", + "loadBalancerFirewallPolicy": "A String", + "networkEndpointGroup": "A String", + "networkIngressFirewallPolicy": "A String", + "privateIpAddress": "A String", + "privatePort": "A String", + "pscNetworkAttachment": "A String", + "pscServiceAttachment": "A String", + "publicIpAddress": "A String", + "publicPort": "A String", + "serviceFirewallPolicy": "A String", + }, + "externalSystems": { + "a_key": { + "assignees": [ "A String", ], - "caseCloseTime": "A String", # The time when the case was closed, as reported by the external system. - "caseCreateTime": "A String", # The time when the case was created, as reported by the external system. - "casePriority": "A String", # The priority of the finding's corresponding case in the external system. - "caseSla": "A String", # The SLA of the finding's corresponding case in the external system. - "caseUri": "A String", # The link to the finding's corresponding case in the external system. - "externalSystemUpdateTime": "A String", # The time when the case was last updated, as reported by the external system. - "externalUid": "A String", # The identifier that's used to track the finding's corresponding case in the external system. - "name": "A String", # Full resource name of the external system, for example: "organizations/1234/sources/5678/findings/123456/externalSystems/jira", "folders/1234/sources/5678/findings/123456/externalSystems/jira", "projects/1234/sources/5678/findings/123456/externalSystems/jira" - "status": "A String", # The most recent status of the finding's corresponding case, as reported by the external system. - "ticketInfo": { # Information about the ticket, if any, that is being used to track the resolution of the issue that is identified by this finding. # Information about the ticket, if any, that is being used to track the resolution of the issue that is identified by this finding. - "assignee": "A String", # The assignee of the ticket in the ticket system. - "description": "A String", # The description of the ticket in the ticket system. - "id": "A String", # The identifier of the ticket in the ticket system. - "status": "A String", # The latest status of the ticket, as reported by the ticket system. - "updateTime": "A String", # The time when the ticket was last updated, as reported by the ticket system. - "uri": "A String", # The link to the ticket in the ticket system. + "caseCloseTime": "A String", + "caseCreateTime": "A String", + "casePriority": "A String", + "caseSla": "A String", + "caseUri": "A String", + "externalSystemUpdateTime": "A String", + "externalUid": "A String", + "name": "A String", + "status": "A String", + "ticketInfo": { + "assignee": "A String", + "description": "A String", + "id": "A String", + "status": "A String", + "updateTime": "A String", + "uri": "A String", }, }, }, - "externalUri": "A String", # The URI that, if available, points to a web page outside of Security Command Center where additional information about the finding can be found. This field is guaranteed to be either empty or a well formed URL. - "files": [ # File associated with the finding. - { # File information about the related binary/library used by an executable, or the script used by a script interpreter - "contents": "A String", # Prefix of the file contents as a JSON-encoded string. - "diskPath": { # Path of the file in terms of underlying disk/partition identifiers. # Path of the file in terms of underlying disk/partition identifiers. - "partitionUuid": "A String", # UUID of the partition (format https://wiki.archlinux.org/title/persistent_block_device_naming#by-uuid) - "relativePath": "A String", # Relative path of the file in the partition as a JSON encoded string. Example: /home/user1/executable_file.sh + "externalUri": "A String", + "files": [ + { + "contents": "A String", + "diskPath": { + "partitionUuid": "A String", + "relativePath": "A String", }, - "fileLoadState": "A String", # The load state of the file. - "hashedSize": "A String", # The length in bytes of the file prefix that was hashed. If hashed_size == size, any hashes reported represent the entire file. - "operations": [ # Operation(s) performed on a file. - { # Operation(s) performed on a file. - "type": "A String", # The type of the operation + "fileLoadState": "A String", + "hashedSize": "A String", + "operations": [ + { + "type": "A String", }, ], - "partiallyHashed": True or False, # True when the hash covers only a prefix of the file. - "path": "A String", # Absolute path of the file as a JSON encoded string. - "sha256": "A String", # SHA256 hash of the first hashed_size bytes of the file encoded as a hex string. If hashed_size == size, sha256 represents the SHA256 hash of the entire file. - "size": "A String", # Size of the file in bytes. + "partiallyHashed": True or False, + "path": "A String", + "sha256": "A String", + "size": "A String", }, ], - "findingClass": "A String", # The class of the finding. - "groupMemberships": [ # Contains details about groups of which this finding is a member. A group is a collection of findings that are related in some way. This field cannot be updated. Its value is ignored in all update requests. - { # Contains details about groups of which this finding is a member. A group is a collection of findings that are related in some way. - "groupId": "A String", # ID of the group. - "groupType": "A String", # Type of group. + "findingClass": "A String", + "groupMemberships": [ + { + "groupId": "A String", + "groupType": "A String", }, ], - "iamBindings": [ # Represents IAM bindings associated with the finding. - { # Represents a particular IAM binding, which captures a member's role addition, removal, or state. - "action": "A String", # The action that was performed on a Binding. - "member": "A String", # A single identity requesting access for a Cloud Platform resource, for example, "foo@google.com". - "role": "A String", # Role that is assigned to "members". For example, "roles/viewer", "roles/editor", or "roles/owner". + "iamBindings": [ + { + "action": "A String", + "member": "A String", + "role": "A String", }, ], - "indicator": { # Represents what's commonly known as an _indicator of compromise_ (IoC) in computer forensics. This is an artifact observed on a network or in an operating system that, with high confidence, indicates a computer intrusion. For more information, see [Indicator of compromise](https://en.wikipedia.org/wiki/Indicator_of_compromise). # Represents what's commonly known as an *indicator of compromise* (IoC) in computer forensics. This is an artifact observed on a network or in an operating system that, with high confidence, indicates a computer intrusion. For more information, see [Indicator of compromise](https://en.wikipedia.org/wiki/Indicator_of_compromise). - "domains": [ # List of domains associated to the Finding. + "indicator": { + "domains": [ "A String", ], - "ipAddresses": [ # The list of IP addresses that are associated with the finding. + "ipAddresses": [ "A String", ], - "signatures": [ # The list of matched signatures indicating that the given process is present in the environment. - { # Indicates what signature matched this process. - "memoryHashSignature": { # A signature corresponding to memory page hashes. # Signature indicating that a binary family was matched. - "binaryFamily": "A String", # The binary family. - "detections": [ # The list of memory hash detections contributing to the binary family match. - { # Memory hash detection contributing to the binary family match. - "binary": "A String", # The name of the binary associated with the memory hash signature detection. - "percentPagesMatched": 3.14, # The percentage of memory page hashes in the signature that were matched. + "signatures": [ + { + "memoryHashSignature": { + "binaryFamily": "A String", + "detections": [ + { + "binary": "A String", + "percentPagesMatched": 3.14, }, ], }, - "signatureType": "A String", # Describes the type of resource associated with the signature. - "yaraRuleSignature": { # A signature corresponding to a YARA rule. # Signature indicating that a YARA rule was matched. - "yaraRule": "A String", # The name of the YARA rule. + "signatureType": "A String", + "yaraRuleSignature": { + "yaraRule": "A String", }, }, ], - "uris": [ # The list of URIs associated to the Findings. + "uris": [ "A String", ], }, - "ipRules": { # IP rules associated with the finding. # IP rules associated with the finding. - "allowed": { # Allowed IP rule. # Tuple with allowed rules. - "ipRules": [ # Optional. Optional list of allowed IP rules. - { # IP rule information. - "portRanges": [ # Optional. An optional list of ports to which this rule applies. This field is only applicable for the UDP or (S)TCP protocols. Each entry must be either an integer or a range including a min and max port number. - { # A port range which is inclusive of the min and max values. Values are between 0 and 2^16-1. The max can be equal / must be not smaller than the min value. If min and max are equal this indicates that it is a single port. - "max": "A String", # Maximum port value. - "min": "A String", # Minimum port value. + "ipRules": { + "allowed": { + "ipRules": [ + { + "portRanges": [ + { + "max": "A String", + "min": "A String", }, ], - "protocol": "A String", # The IP protocol this rule applies to. This value can either be one of the following well known protocol strings (TCP, UDP, ICMP, ESP, AH, IPIP, SCTP) or a string representation of the integer value. + "protocol": "A String", }, ], }, - "denied": { # Denied IP rule. # Tuple with denied rules. - "ipRules": [ # Optional. Optional list of denied IP rules. - { # IP rule information. - "portRanges": [ # Optional. An optional list of ports to which this rule applies. This field is only applicable for the UDP or (S)TCP protocols. Each entry must be either an integer or a range including a min and max port number. - { # A port range which is inclusive of the min and max values. Values are between 0 and 2^16-1. The max can be equal / must be not smaller than the min value. If min and max are equal this indicates that it is a single port. - "max": "A String", # Maximum port value. - "min": "A String", # Minimum port value. + "denied": { + "ipRules": [ + { + "portRanges": [ + { + "max": "A String", + "min": "A String", }, ], - "protocol": "A String", # The IP protocol this rule applies to. This value can either be one of the following well known protocol strings (TCP, UDP, ICMP, ESP, AH, IPIP, SCTP) or a string representation of the integer value. + "protocol": "A String", }, ], }, - "destinationIpRanges": [ # If destination IP ranges are specified, the firewall rule applies only to traffic that has a destination IP address in these ranges. These ranges must be expressed in CIDR format. Only supports IPv4. + "destinationIpRanges": [ "A String", ], - "direction": "A String", # The direction that the rule is applicable to, one of ingress or egress. - "exposedServices": [ # Name of the network protocol service, such as FTP, that is exposed by the open port. Follows the naming convention available at: https://www.iana.org/assignments/service-names-port-numbers/service-names-port-numbers.xhtml. + "direction": "A String", + "exposedServices": [ "A String", ], - "sourceIpRanges": [ # If source IP ranges are specified, the firewall rule applies only to traffic that has a source IP address in these ranges. These ranges must be expressed in CIDR format. Only supports IPv4. + "sourceIpRanges": [ "A String", ], }, - "job": { # Describes a job # Job associated with the finding. - "errorCode": 42, # Optional. If the job did not complete successfully, this field describes why. - "location": "A String", # Optional. Gives the location where the job ran, such as `US` or `europe-west1` - "name": "A String", # The fully-qualified name for a job. e.g. `projects//jobs/` - "state": "A String", # Output only. State of the job, such as `RUNNING` or `PENDING`. - }, - "kernelRootkit": { # Kernel mode rootkit signatures. # Signature of the kernel rootkit. - "name": "A String", # Rootkit name, when available. - "unexpectedCodeModification": True or False, # True if unexpected modifications of kernel code memory are present. - "unexpectedFtraceHandler": True or False, # True if `ftrace` points are present with callbacks pointing to regions that are not in the expected kernel or module code range. - "unexpectedInterruptHandler": True or False, # True if interrupt handlers that are are not in the expected kernel or module code regions are present. - "unexpectedKernelCodePages": True or False, # True if kernel code pages that are not in the expected kernel or module code regions are present. - "unexpectedKprobeHandler": True or False, # True if `kprobe` points are present with callbacks pointing to regions that are not in the expected kernel or module code range. - "unexpectedProcessesInRunqueue": True or False, # True if unexpected processes in the scheduler run queue are present. Such processes are in the run queue, but not in the process task list. - "unexpectedReadOnlyDataModification": True or False, # True if unexpected modifications of kernel read-only data memory are present. - "unexpectedSystemCallHandler": True or False, # True if system call handlers that are are not in the expected kernel or module code regions are present. - }, - "kubernetes": { # Kubernetes-related attributes. # Kubernetes resources associated with the finding. - "accessReviews": [ # Provides information on any Kubernetes access reviews (privilege checks) relevant to the finding. - { # Conveys information about a Kubernetes access review (such as one returned by a [`kubectl auth can-i`](https://kubernetes.io/docs/reference/access-authn-authz/authorization/#checking-api-access) command) that was involved in a finding. - "group": "A String", # The API group of the resource. "*" means all. - "name": "A String", # The name of the resource being requested. Empty means all. - "ns": "A String", # Namespace of the action being requested. Currently, there is no distinction between no namespace and all namespaces. Both are represented by "" (empty). - "resource": "A String", # The optional resource type requested. "*" means all. - "subresource": "A String", # The optional subresource type. - "verb": "A String", # A Kubernetes resource API verb, like get, list, watch, create, update, delete, proxy. "*" means all. - "version": "A String", # The API version of the resource. "*" means all. + "job": { + "errorCode": 42, + "location": "A String", + "name": "A String", + "state": "A String", + }, + "kernelRootkit": { + "name": "A String", + "unexpectedCodeModification": True or False, + "unexpectedFtraceHandler": True or False, + "unexpectedInterruptHandler": True or False, + "unexpectedKernelCodePages": True or False, + "unexpectedKprobeHandler": True or False, + "unexpectedProcessesInRunqueue": True or False, + "unexpectedReadOnlyDataModification": True or False, + "unexpectedSystemCallHandler": True or False, + }, + "kubernetes": { + "accessReviews": [ + { + "group": "A String", + "name": "A String", + "ns": "A String", + "resource": "A String", + "subresource": "A String", + "verb": "A String", + "version": "A String", }, ], - "bindings": [ # Provides Kubernetes role binding information for findings that involve [RoleBindings or ClusterRoleBindings](https://cloud.google.com/kubernetes-engine/docs/how-to/role-based-access-control). - { # Represents a Kubernetes RoleBinding or ClusterRoleBinding. - "name": "A String", # Name for the binding. - "ns": "A String", # Namespace for the binding. - "role": { # Kubernetes Role or ClusterRole. # The Role or ClusterRole referenced by the binding. - "kind": "A String", # Role type. - "name": "A String", # Role name. - "ns": "A String", # Role namespace. + "bindings": [ + { + "name": "A String", + "ns": "A String", + "role": { + "kind": "A String", + "name": "A String", + "ns": "A String", }, - "subjects": [ # Represents one or more subjects that are bound to the role. Not always available for PATCH requests. - { # Represents a Kubernetes subject. - "kind": "A String", # Authentication type for the subject. - "name": "A String", # Name for the subject. - "ns": "A String", # Namespace for the subject. + "subjects": [ + { + "kind": "A String", + "name": "A String", + "ns": "A String", }, ], }, ], - "nodePools": [ # GKE [node pools](https://cloud.google.com/kubernetes-engine/docs/concepts/node-pools) associated with the finding. This field contains node pool information for each node, when it is available. - { # Provides GKE node pool information. - "name": "A String", # Kubernetes node pool name. - "nodes": [ # Nodes associated with the finding. - { # Kubernetes nodes associated with the finding. - "name": "A String", # [Full resource name](https://google.aip.dev/122#full-resource-names) of the Compute Engine VM running the cluster node. + "nodePools": [ + { + "name": "A String", + "nodes": [ + { + "name": "A String", }, ], }, ], - "nodes": [ # Provides Kubernetes [node](https://cloud.google.com/kubernetes-engine/docs/concepts/cluster-architecture#nodes) information. - { # Kubernetes nodes associated with the finding. - "name": "A String", # [Full resource name](https://google.aip.dev/122#full-resource-names) of the Compute Engine VM running the cluster node. + "nodes": [ + { + "name": "A String", }, ], - "objects": [ # Kubernetes objects related to the finding. - { # Kubernetes object related to the finding, uniquely identified by GKNN. Used if the object Kind is not one of Pod, Node, NodePool, Binding, or AccessReview. - "containers": [ # Pod containers associated with this finding, if any. - { # Container associated with the finding. - "createTime": "A String", # The time that the container was created. - "imageId": "A String", # Optional container image ID, if provided by the container runtime. Uniquely identifies the container image launched using a container image digest. - "labels": [ # Container labels, as provided by the container runtime. - { # Represents a generic name-value label. A label has separate name and value fields to support filtering with the `contains()` function. For more information, see [Filtering on array-type fields](https://cloud.google.com/security-command-center/docs/how-to-api-list-findings#array-contains-filtering). - "name": "A String", # Name of the label. - "value": "A String", # Value that corresponds to the label's name. + "objects": [ + { + "containers": [ + { + "createTime": "A String", + "imageId": "A String", + "labels": [ + { + "name": "A String", + "value": "A String", }, ], - "name": "A String", # Name of the container. - "uri": "A String", # Container image URI provided when configuring a pod or container. This string can identify a container image version using mutable tags. + "name": "A String", + "uri": "A String", }, ], - "group": "A String", # Kubernetes object group, such as "policy.k8s.io/v1". - "kind": "A String", # Kubernetes object kind, such as "Namespace". - "name": "A String", # Kubernetes object name. For details see https://kubernetes.io/docs/concepts/overview/working-with-objects/names/. - "ns": "A String", # Kubernetes object namespace. Must be a valid DNS label. Named "ns" to avoid collision with C++ namespace keyword. For details see https://kubernetes.io/docs/tasks/administer-cluster/namespaces/. + "group": "A String", + "kind": "A String", + "name": "A String", + "ns": "A String", }, ], - "pods": [ # Kubernetes [Pods](https://cloud.google.com/kubernetes-engine/docs/concepts/pod) associated with the finding. This field contains Pod records for each container that is owned by a Pod. - { # A Kubernetes Pod. - "containers": [ # Pod containers associated with this finding, if any. - { # Container associated with the finding. - "createTime": "A String", # The time that the container was created. - "imageId": "A String", # Optional container image ID, if provided by the container runtime. Uniquely identifies the container image launched using a container image digest. - "labels": [ # Container labels, as provided by the container runtime. - { # Represents a generic name-value label. A label has separate name and value fields to support filtering with the `contains()` function. For more information, see [Filtering on array-type fields](https://cloud.google.com/security-command-center/docs/how-to-api-list-findings#array-contains-filtering). - "name": "A String", # Name of the label. - "value": "A String", # Value that corresponds to the label's name. + "pods": [ + { + "containers": [ + { + "createTime": "A String", + "imageId": "A String", + "labels": [ + { + "name": "A String", + "value": "A String", }, ], - "name": "A String", # Name of the container. - "uri": "A String", # Container image URI provided when configuring a pod or container. This string can identify a container image version using mutable tags. + "name": "A String", + "uri": "A String", }, ], - "labels": [ # Pod labels. For Kubernetes containers, these are applied to the container. - { # Represents a generic name-value label. A label has separate name and value fields to support filtering with the `contains()` function. For more information, see [Filtering on array-type fields](https://cloud.google.com/security-command-center/docs/how-to-api-list-findings#array-contains-filtering). - "name": "A String", # Name of the label. - "value": "A String", # Value that corresponds to the label's name. + "labels": [ + { + "name": "A String", + "value": "A String", }, ], - "name": "A String", # Kubernetes Pod name. - "ns": "A String", # Kubernetes Pod namespace. + "name": "A String", + "ns": "A String", }, ], - "roles": [ # Provides Kubernetes role information for findings that involve [Roles or ClusterRoles](https://cloud.google.com/kubernetes-engine/docs/how-to/role-based-access-control). - { # Kubernetes Role or ClusterRole. - "kind": "A String", # Role type. - "name": "A String", # Role name. - "ns": "A String", # Role namespace. + "roles": [ + { + "kind": "A String", + "name": "A String", + "ns": "A String", }, ], }, - "loadBalancers": [ # The load balancers associated with the finding. - { # Contains information related to the load balancer associated with the finding. - "name": "A String", # The name of the load balancer associated with the finding. + "loadBalancers": [ + { + "name": "A String", }, ], - "logEntries": [ # Log entries that are relevant to the finding. - { # An individual entry in a log. - "cloudLoggingEntry": { # Metadata taken from a [Cloud Logging LogEntry](https://cloud.google.com/logging/docs/reference/v2/rest/v2/LogEntry) # An individual entry in a log stored in Cloud Logging. - "insertId": "A String", # A unique identifier for the log entry. - "logId": "A String", # The type of the log (part of `log_name`. `log_name` is the resource name of the log to which this log entry belongs). For example: `cloudresourcemanager.googleapis.com/activity`. Note that this field is not URL-encoded, unlike the `LOG_ID` field in `LogEntry`. - "resourceContainer": "A String", # The organization, folder, or project of the monitored resource that produced this log entry. - "timestamp": "A String", # The time the event described by the log entry occurred. + "logEntries": [ + { + "cloudLoggingEntry": { + "insertId": "A String", + "logId": "A String", + "resourceContainer": "A String", + "timestamp": "A String", }, }, ], - "mitreAttack": { # MITRE ATT&CK tactics and techniques related to this finding. See: https://attack.mitre.org # MITRE ATT&CK tactics and techniques related to this finding. See: https://attack.mitre.org - "additionalTactics": [ # Additional MITRE ATT&CK tactics related to this finding, if any. + "mitreAttack": { + "additionalTactics": [ "A String", ], - "additionalTechniques": [ # Additional MITRE ATT&CK techniques related to this finding, if any, along with any of their respective parent techniques. + "additionalTechniques": [ "A String", ], - "primaryTactic": "A String", # The MITRE ATT&CK tactic most closely represented by this finding, if any. - "primaryTechniques": [ # The MITRE ATT&CK technique most closely represented by this finding, if any. primary_techniques is a repeated field because there are multiple levels of MITRE ATT&CK techniques. If the technique most closely represented by this finding is a sub-technique (e.g. `SCANNING_IP_BLOCKS`), both the sub-technique and its parent technique(s) will be listed (e.g. `SCANNING_IP_BLOCKS`, `ACTIVE_SCANNING`). + "primaryTactic": "A String", + "primaryTechniques": [ "A String", ], - "version": "A String", # The MITRE ATT&CK version referenced by the above fields. E.g. "8". + "version": "A String", }, - "moduleName": "A String", # Unique identifier of the module which generated the finding. Example: folders/598186756061/securityHealthAnalyticsSettings/customModules/56799441161885 - "mute": "A String", # Indicates the mute state of a finding (either muted, unmuted or undefined). Unlike other attributes of a finding, a finding provider shouldn't set the value of mute. - "muteInfo": { # Mute information about the finding, including whether the finding has a static mute or any matching dynamic mute rules. # Output only. The mute information regarding this finding. - "dynamicMuteRecords": [ # The list of dynamic mute rules that currently match the finding. - { # The record of a dynamic mute rule that matches the finding. - "matchTime": "A String", # When the dynamic mute rule first matched the finding. - "muteConfig": "A String", # The relative resource name of the mute rule, represented by a mute config, that created this record, for example `organizations/123/muteConfigs/mymuteconfig` or `organizations/123/locations/global/muteConfigs/mymuteconfig`. + "moduleName": "A String", + "mute": "A String", + "muteInfo": { + "dynamicMuteRecords": [ + { + "matchTime": "A String", + "muteConfig": "A String", }, ], - "staticMute": { # Information about the static mute state. A static mute state overrides any dynamic mute rules that apply to this finding. The static mute state can be set by a static mute rule or by muting the finding directly. # If set, the static mute applied to this finding. Static mutes override dynamic mutes. If unset, there is no static mute. - "applyTime": "A String", # When the static mute was applied. - "state": "A String", # The static mute state. If the value is `MUTED` or `UNMUTED`, then the finding's overall mute state will have the same value. + "staticMute": { + "applyTime": "A String", + "state": "A String", }, }, - "muteInitiator": "A String", # Records additional information about the mute operation, for example, the [mute configuration](/security-command-center/docs/how-to-mute-findings) that muted the finding and the user who muted the finding. - "muteUpdateTime": "A String", # Output only. The most recent time this finding was muted or unmuted. - "name": "A String", # The [relative resource name](https://cloud.google.com/apis/design/resource_names#relative_resource_name) of the finding. Example: "organizations/{organization_id}/sources/{source_id}/findings/{finding_id}", "folders/{folder_id}/sources/{source_id}/findings/{finding_id}", "projects/{project_id}/sources/{source_id}/findings/{finding_id}". - "networks": [ # Represents the VPC networks that the resource is attached to. - { # Contains information about a VPC network associated with the finding. - "name": "A String", # The name of the VPC network resource, for example, `//compute.googleapis.com/projects/my-project/global/networks/my-network`. + "muteInitiator": "A String", + "muteUpdateTime": "A String", + "name": "A String", + "networks": [ + { + "name": "A String", }, ], - "nextSteps": "A String", # Steps to address the finding. - "notebook": { # Represents a Jupyter notebook IPYNB file, such as a [Colab Enterprise notebook](https://cloud.google.com/colab/docs/introduction) file, that is associated with a finding. # Notebook associated with the finding. - "lastAuthor": "A String", # The user ID of the latest author to modify the notebook. - "name": "A String", # The name of the notebook. - "notebookUpdateTime": "A String", # The most recent time the notebook was updated. - "service": "A String", # The source notebook service, for example, "Colab Enterprise". + "nextSteps": "A String", + "notebook": { + "lastAuthor": "A String", + "name": "A String", + "notebookUpdateTime": "A String", + "service": "A String", }, - "orgPolicies": [ # Contains information about the org policies associated with the finding. - { # Contains information about the org policies associated with the finding. - "name": "A String", # The resource name of the org policy. Example: "organizations/{organization_id}/policies/{constraint_name}" + "orgPolicies": [ + { + "name": "A String", }, ], - "parent": "A String", # The relative resource name of the source the finding belongs to. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name This field is immutable after creation time. For example: "organizations/{organization_id}/sources/{source_id}" - "parentDisplayName": "A String", # Output only. The human readable display name of the finding source such as "Event Threat Detection" or "Security Health Analytics". - "policyViolationSummary": { # Metadata summarizing policy violations of child resources of the affected resource. `finding_category` and `resource` determine the exact semantics of the counts. For example, when category=DATA_SECURITY_POSTURE_OBJECT_PUBLIC_ACCESS_VIOLATION and resource='storage.googleapis.com/buckets/my-bucket-name' then this counts the number of Cloud Storage objects in my-bucket-name which violate a Public Access control. # PolicyViolationSummary associated with the finding. - "conformantResourcesCount": "A String", # Total number of child resources that conform to the policy. - "evaluationErrorsCount": "A String", # Number of child resources for which errors during evaluation occurred. The evaluation result for these child resources is effectively "unknown". - "outOfScopeResourcesCount": "A String", # Total count of child resources which were not in scope for evaluation. - "policyViolationsCount": "A String", # Count of child resources in violation of the policy. - }, - "processes": [ # Represents operating system processes associated with the Finding. - { # Represents an operating system process. - "args": [ # Process arguments as JSON encoded strings. + "parent": "A String", + "parentDisplayName": "A String", + "policyViolationSummary": { + "conformantResourcesCount": "A String", + "evaluationErrorsCount": "A String", + "outOfScopeResourcesCount": "A String", + "policyViolationsCount": "A String", + }, + "processes": [ + { + "args": [ "A String", ], - "argumentsTruncated": True or False, # True if `args` is incomplete. - "binary": { # File information about the related binary/library used by an executable, or the script used by a script interpreter # File information for the process executable. - "contents": "A String", # Prefix of the file contents as a JSON-encoded string. - "diskPath": { # Path of the file in terms of underlying disk/partition identifiers. # Path of the file in terms of underlying disk/partition identifiers. - "partitionUuid": "A String", # UUID of the partition (format https://wiki.archlinux.org/title/persistent_block_device_naming#by-uuid) - "relativePath": "A String", # Relative path of the file in the partition as a JSON encoded string. Example: /home/user1/executable_file.sh + "argumentsTruncated": True or False, + "binary": { + "contents": "A String", + "diskPath": { + "partitionUuid": "A String", + "relativePath": "A String", }, - "fileLoadState": "A String", # The load state of the file. - "hashedSize": "A String", # The length in bytes of the file prefix that was hashed. If hashed_size == size, any hashes reported represent the entire file. - "operations": [ # Operation(s) performed on a file. - { # Operation(s) performed on a file. - "type": "A String", # The type of the operation + "fileLoadState": "A String", + "hashedSize": "A String", + "operations": [ + { + "type": "A String", }, ], - "partiallyHashed": True or False, # True when the hash covers only a prefix of the file. - "path": "A String", # Absolute path of the file as a JSON encoded string. - "sha256": "A String", # SHA256 hash of the first hashed_size bytes of the file encoded as a hex string. If hashed_size == size, sha256 represents the SHA256 hash of the entire file. - "size": "A String", # Size of the file in bytes. + "partiallyHashed": True or False, + "path": "A String", + "sha256": "A String", + "size": "A String", }, - "envVariables": [ # Process environment variables. - { # A name-value pair representing an environment variable used in an operating system process. - "name": "A String", # Environment variable name as a JSON encoded string. - "val": "A String", # Environment variable value as a JSON encoded string. + "envVariables": [ + { + "name": "A String", + "val": "A String", }, ], - "envVariablesTruncated": True or False, # True if `env_variables` is incomplete. - "libraries": [ # File information for libraries loaded by the process. - { # File information about the related binary/library used by an executable, or the script used by a script interpreter - "contents": "A String", # Prefix of the file contents as a JSON-encoded string. - "diskPath": { # Path of the file in terms of underlying disk/partition identifiers. # Path of the file in terms of underlying disk/partition identifiers. - "partitionUuid": "A String", # UUID of the partition (format https://wiki.archlinux.org/title/persistent_block_device_naming#by-uuid) - "relativePath": "A String", # Relative path of the file in the partition as a JSON encoded string. Example: /home/user1/executable_file.sh + "envVariablesTruncated": True or False, + "libraries": [ + { + "contents": "A String", + "diskPath": { + "partitionUuid": "A String", + "relativePath": "A String", }, - "fileLoadState": "A String", # The load state of the file. - "hashedSize": "A String", # The length in bytes of the file prefix that was hashed. If hashed_size == size, any hashes reported represent the entire file. - "operations": [ # Operation(s) performed on a file. - { # Operation(s) performed on a file. - "type": "A String", # The type of the operation + "fileLoadState": "A String", + "hashedSize": "A String", + "operations": [ + { + "type": "A String", }, ], - "partiallyHashed": True or False, # True when the hash covers only a prefix of the file. - "path": "A String", # Absolute path of the file as a JSON encoded string. - "sha256": "A String", # SHA256 hash of the first hashed_size bytes of the file encoded as a hex string. If hashed_size == size, sha256 represents the SHA256 hash of the entire file. - "size": "A String", # Size of the file in bytes. + "partiallyHashed": True or False, + "path": "A String", + "sha256": "A String", + "size": "A String", }, ], - "name": "A String", # The process name, as displayed in utilities like `top` and `ps`. This name can be accessed through `/proc/[pid]/comm` and changed with `prctl(PR_SET_NAME)`. - "parentPid": "A String", # The parent process ID. - "pid": "A String", # The process ID. - "script": { # File information about the related binary/library used by an executable, or the script used by a script interpreter # When the process represents the invocation of a script, `binary` provides information about the interpreter, while `script` provides information about the script file provided to the interpreter. - "contents": "A String", # Prefix of the file contents as a JSON-encoded string. - "diskPath": { # Path of the file in terms of underlying disk/partition identifiers. # Path of the file in terms of underlying disk/partition identifiers. - "partitionUuid": "A String", # UUID of the partition (format https://wiki.archlinux.org/title/persistent_block_device_naming#by-uuid) - "relativePath": "A String", # Relative path of the file in the partition as a JSON encoded string. Example: /home/user1/executable_file.sh + "name": "A String", + "parentPid": "A String", + "pid": "A String", + "script": { + "contents": "A String", + "diskPath": { + "partitionUuid": "A String", + "relativePath": "A String", }, - "fileLoadState": "A String", # The load state of the file. - "hashedSize": "A String", # The length in bytes of the file prefix that was hashed. If hashed_size == size, any hashes reported represent the entire file. - "operations": [ # Operation(s) performed on a file. - { # Operation(s) performed on a file. - "type": "A String", # The type of the operation + "fileLoadState": "A String", + "hashedSize": "A String", + "operations": [ + { + "type": "A String", }, ], - "partiallyHashed": True or False, # True when the hash covers only a prefix of the file. - "path": "A String", # Absolute path of the file as a JSON encoded string. - "sha256": "A String", # SHA256 hash of the first hashed_size bytes of the file encoded as a hex string. If hashed_size == size, sha256 represents the SHA256 hash of the entire file. - "size": "A String", # Size of the file in bytes. + "partiallyHashed": True or False, + "path": "A String", + "sha256": "A String", + "size": "A String", }, - "userId": "A String", # The ID of the user that executed the process. E.g. If this is the root user this will always be 0. + "userId": "A String", }, ], - "resourceName": "A String", # For findings on Google Cloud resources, the full resource name of the Google Cloud resource this finding is for. See: https://cloud.google.com/apis/design/resource_names#full_resource_name When the finding is for a non-Google Cloud resource, the resourceName can be a customer or partner defined string. This field is immutable after creation time. - "secret": { # Details about a secret or credential associated with the finding. # Secret associated with the finding. - "environmentVariable": { # Environment variable containing the secret. # The environment variable containing the secret. - "key": "A String", # Environment variable name as a JSON encoded string. Note that value is not included since the value contains the secret data, which is sensitive core content. + "resourceName": "A String", + "secret": { + "environmentVariable": { + "key": "A String", }, - "filePath": { # File path containing the secret. # The file containing the secret. - "path": "A String", # Path to the file. + "filePath": { + "path": "A String", }, - "status": { # The status of the secret. # The status of the secret. - "lastUpdatedTime": "A String", # Time that the secret was found. - "validity": "A String", # The validity of the secret. + "status": { + "lastUpdatedTime": "A String", + "validity": "A String", }, - "type": "A String", # The type of secret, for example, GCP_API_KEY. + "type": "A String", }, - "securityMarks": { # User specified security marks that are attached to the parent Security Command Center resource. Security marks are scoped within a Security Command Center organization -- they can be modified and viewed by all users who have proper permissions on the organization. # Output only. User specified security marks. These marks are entirely managed by the user and come from the SecurityMarks resource that belongs to the finding. - "canonicalName": "A String", # The canonical name of the marks. Examples: "organizations/{organization_id}/assets/{asset_id}/securityMarks" "folders/{folder_id}/assets/{asset_id}/securityMarks" "projects/{project_number}/assets/{asset_id}/securityMarks" "organizations/{organization_id}/sources/{source_id}/findings/{finding_id}/securityMarks" "folders/{folder_id}/sources/{source_id}/findings/{finding_id}/securityMarks" "projects/{project_number}/sources/{source_id}/findings/{finding_id}/securityMarks" - "marks": { # Mutable user specified security marks belonging to the parent resource. Constraints are as follows: * Keys and values are treated as case insensitive * Keys must be between 1 - 256 characters (inclusive) * Keys must be letters, numbers, underscores, or dashes * Values have leading and trailing whitespace trimmed, remaining characters must be between 1 - 4096 characters (inclusive) + "securityMarks": { + "canonicalName": "A String", + "marks": { "a_key": "A String", }, - "name": "A String", # The relative resource name of the SecurityMarks. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Examples: "organizations/{organization_id}/assets/{asset_id}/securityMarks" "organizations/{organization_id}/sources/{source_id}/findings/{finding_id}/securityMarks". - }, - "securityPosture": { # Represents a posture that is deployed on Google Cloud by the Security Command Center Posture Management service. A posture contains one or more policy sets. A policy set is a group of policies that enforce a set of security rules on Google Cloud. # The security posture associated with the finding. - "changedPolicy": "A String", # The name of the updated policy, for example, `projects/{project_id}/policies/{constraint_name}`. - "name": "A String", # Name of the posture, for example, `CIS-Posture`. - "policy": "A String", # The ID of the updated policy, for example, `compute-policy-1`. - "policyDriftDetails": [ # The details about a change in an updated policy that violates the deployed posture. - { # The policy field that violates the deployed posture and its expected and detected values. - "detectedValue": "A String", # The detected value that violates the deployed posture, for example, `false` or `allowed_values={"projects/22831892"}`. - "expectedValue": "A String", # The value of this field that was configured in a posture, for example, `true` or `allowed_values={"projects/29831892"}`. - "field": "A String", # The name of the updated field, for example constraint.implementation.policy_rules[0].enforce + "name": "A String", + }, + "securityPosture": { + "changedPolicy": "A String", + "name": "A String", + "policy": "A String", + "policyDriftDetails": [ + { + "detectedValue": "A String", + "expectedValue": "A String", + "field": "A String", }, ], - "policySet": "A String", # The name of the updated policyset, for example, `cis-policyset`. - "postureDeployment": "A String", # The name of the posture deployment, for example, `organizations/{org_id}/posturedeployments/{posture_deployment_id}`. - "postureDeploymentResource": "A String", # The project, folder, or organization on which the posture is deployed, for example, `projects/{project_number}`. - "revisionId": "A String", # The version of the posture, for example, `c7cfa2a8`. + "policySet": "A String", + "postureDeployment": "A String", + "postureDeploymentResource": "A String", + "revisionId": "A String", }, - "severity": "A String", # The severity of the finding. This field is managed by the source that writes the finding. - "sourceProperties": { # Source specific properties. These properties are managed by the source that writes the finding. The key names in the source_properties map must be between 1 and 255 characters, and must start with a letter and contain alphanumeric characters or underscores only. + "severity": "A String", + "sourceProperties": { "a_key": "", }, - "state": "A String", # The state of the finding. - "toxicCombination": { # Contains details about a group of security issues that, when the issues occur together, represent a greater risk than when the issues occur independently. A group of such issues is referred to as a toxic combination. # Contains details about a group of security issues that, when the issues occur together, represent a greater risk than when the issues occur independently. A group of such issues is referred to as a toxic combination. This field cannot be updated. Its value is ignored in all update requests. - "attackExposureScore": 3.14, # The [Attack exposure score](https://cloud.google.com/security-command-center/docs/attack-exposure-learn#attack_exposure_scores) of this toxic combination. The score is a measure of how much this toxic combination exposes one or more high-value resources to potential attack. - "relatedFindings": [ # List of resource names of findings associated with this toxic combination. For example, `organizations/123/sources/456/findings/789`. + "state": "A String", + "toxicCombination": { + "attackExposureScore": 3.14, + "relatedFindings": [ "A String", ], }, - "vertexAi": { # Vertex AI-related information associated with the finding. # VertexAi associated with the finding. - "datasets": [ # Datasets associated with the finding. - { # Vertex AI dataset associated with the finding. - "displayName": "A String", # The user defined display name of dataset, e.g. plants-dataset - "name": "A String", # Resource name of the dataset, e.g. projects/{project}/locations/{location}/datasets/2094040236064505856 - "source": "A String", # Data source, such as BigQuery source URI, e.g. bq://scc-nexus-test.AIPPtest.gsod + "vertexAi": { + "datasets": [ + { + "displayName": "A String", + "name": "A String", + "source": "A String", }, ], - "pipelines": [ # Pipelines associated with the finding. - { # Vertex AI training pipeline associated with the finding. - "displayName": "A String", # The user defined display name of pipeline, e.g. plants-classification - "name": "A String", # Resource name of the pipeline, e.g. projects/{project}/locations/{location}/trainingPipelines/5253428229225578496 + "pipelines": [ + { + "displayName": "A String", + "name": "A String", }, ], }, - "vulnerability": { # Refers to common vulnerability fields e.g. cve, cvss, cwe etc. # Represents vulnerability-specific fields like CVE and CVSS scores. CVE stands for Common Vulnerabilities and Exposures (https://cve.mitre.org/about/) - "cve": { # CVE stands for Common Vulnerabilities and Exposures. Information from the [CVE record](https://www.cve.org/ResourcesSupport/Glossary) that describes this vulnerability. # CVE stands for Common Vulnerabilities and Exposures (https://cve.mitre.org/about/) - "cvssv3": { # Common Vulnerability Scoring System version 3. # Describe Common Vulnerability Scoring System specified at https://www.first.org/cvss/v3.1/specification-document - "attackComplexity": "A String", # This metric describes the conditions beyond the attacker's control that must exist in order to exploit the vulnerability. - "attackVector": "A String", # Base Metrics Represents the intrinsic characteristics of a vulnerability that are constant over time and across user environments. This metric reflects the context by which vulnerability exploitation is possible. - "availabilityImpact": "A String", # This metric measures the impact to the availability of the impacted component resulting from a successfully exploited vulnerability. - "baseScore": 3.14, # The base score is a function of the base metric scores. - "confidentialityImpact": "A String", # This metric measures the impact to the confidentiality of the information resources managed by a software component due to a successfully exploited vulnerability. - "integrityImpact": "A String", # This metric measures the impact to integrity of a successfully exploited vulnerability. - "privilegesRequired": "A String", # This metric describes the level of privileges an attacker must possess before successfully exploiting the vulnerability. - "scope": "A String", # The Scope metric captures whether a vulnerability in one vulnerable component impacts resources in components beyond its security scope. - "userInteraction": "A String", # This metric captures the requirement for a human user, other than the attacker, to participate in the successful compromise of the vulnerable component. + "vulnerability": { + "cve": { + "cvssv3": { + "attackComplexity": "A String", + "attackVector": "A String", + "availabilityImpact": "A String", + "baseScore": 3.14, + "confidentialityImpact": "A String", + "integrityImpact": "A String", + "privilegesRequired": "A String", + "scope": "A String", + "userInteraction": "A String", }, - "exploitReleaseDate": "A String", # Date the first publicly available exploit or PoC was released. - "exploitationActivity": "A String", # The exploitation activity of the vulnerability in the wild. - "firstExploitationDate": "A String", # Date of the earliest known exploitation. - "id": "A String", # The unique identifier for the vulnerability. e.g. CVE-2021-34527 - "impact": "A String", # The potential impact of the vulnerability if it was to be exploited. - "observedInTheWild": True or False, # Whether or not the vulnerability has been observed in the wild. - "references": [ # Additional information about the CVE. e.g. https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2021-34527 - { # Additional Links - "source": "A String", # Source of the reference e.g. NVD - "uri": "A String", # Uri for the mentioned source e.g. https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2021-34527. + "exploitReleaseDate": "A String", + "exploitationActivity": "A String", + "firstExploitationDate": "A String", + "id": "A String", + "impact": "A String", + "observedInTheWild": True or False, + "references": [ + { + "source": "A String", + "uri": "A String", }, ], - "upstreamFixAvailable": True or False, # Whether upstream fix is available for the CVE. - "zeroDay": True or False, # Whether or not the vulnerability was zero day when the finding was published. - }, - "cwes": [ # Represents one or more Common Weakness Enumeration (CWE) information on this vulnerability. - { # CWE stands for Common Weakness Enumeration. Information about this weakness, as described by [CWE](https://cwe.mitre.org/). - "id": "A String", # The CWE identifier, e.g. CWE-94 - "references": [ # Any reference to the details on the CWE, for example, https://cwe.mitre.org/data/definitions/94.html - { # Additional Links - "source": "A String", # Source of the reference e.g. NVD - "uri": "A String", # Uri for the mentioned source e.g. https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2021-34527. + "upstreamFixAvailable": True or False, + "zeroDay": True or False, + }, + "cwes": [ + { + "id": "A String", + "references": [ + { + "source": "A String", + "uri": "A String", }, ], }, ], - "fixedPackage": { # Package is a generic definition of a package. # The fixed package is relevant to the finding. - "cpeUri": "A String", # The CPE URI where the vulnerability was detected. - "packageName": "A String", # The name of the package where the vulnerability was detected. - "packageType": "A String", # Type of package, for example, os, maven, or go. - "packageVersion": "A String", # The version of the package. + "fixedPackage": { + "cpeUri": "A String", + "packageName": "A String", + "packageType": "A String", + "packageVersion": "A String", }, - "offendingPackage": { # Package is a generic definition of a package. # The offending package is relevant to the finding. - "cpeUri": "A String", # The CPE URI where the vulnerability was detected. - "packageName": "A String", # The name of the package where the vulnerability was detected. - "packageType": "A String", # Type of package, for example, os, maven, or go. - "packageVersion": "A String", # The version of the package. + "offendingPackage": { + "cpeUri": "A String", + "packageName": "A String", + "packageType": "A String", + "packageVersion": "A String", }, - "providerRiskScore": "A String", # Provider provided risk_score based on multiple factors. The higher the risk score, the more risky the vulnerability is. - "reachable": True or False, # Represents whether the vulnerability is reachable (detected via static analysis) - "securityBulletin": { # SecurityBulletin are notifications of vulnerabilities of Google products. # The security bulletin is relevant to this finding. - "bulletinId": "A String", # ID of the bulletin corresponding to the vulnerability. - "submissionTime": "A String", # Submission time of this Security Bulletin. - "suggestedUpgradeVersion": "A String", # This represents a version that the cluster receiving this notification should be upgraded to, based on its current version. For example, 1.15.0 + "providerRiskScore": "A String", + "reachable": True or False, + "securityBulletin": { + "bulletinId": "A String", + "submissionTime": "A String", + "suggestedUpgradeVersion": "A String", }, }, }
@@ -3614,16 +3614,16 @@

Method Details

setState(name, body=None, x__xgafv=None) -
Updates the state of a finding.
+  
 
 Args:
-  name: string, Required. The [relative resource name](https://cloud.google.com/apis/design/resource_names#relative_resource_name) of the finding. Example: `organizations/{organization_id}/sources/{source_id}/findings/{finding_id}`, `folders/{folder_id}/sources/{source_id}/findings/{finding_id}`, `projects/{project_id}/sources/{source_id}/findings/{finding_id}`. (required)
+  name: string, A parameter (required)
   body: object, The request body.
     The object takes the form of:
 
-{ # Request message for updating a finding's state.
-  "startTime": "A String", # Optional. The time at which the updated state takes effect. If unset, defaults to the request time.
-  "state": "A String", # Required. The desired State of the finding.
+{
+  "startTime": "A String",
+  "state": "A String",
 }
 
   x__xgafv: string, V1 error format.
@@ -3634,811 +3634,811 @@ 

Method Details

Returns: An object of the form: - { # Security Command Center finding. A finding is a record of assessment data like security, risk, health, or privacy, that is ingested into Security Command Center for presentation, notification, analysis, policy testing, and enforcement. For example, a cross-site scripting (XSS) vulnerability in an App Engine application is a finding. - "access": { # Represents an access event. # Access details associated with the finding, such as more information on the caller, which method was accessed, and from where. - "callerIp": "A String", # Caller's IP address, such as "1.1.1.1". - "callerIpGeo": { # Represents a geographical location for a given access. # The caller IP's geolocation, which identifies where the call came from. - "regionCode": "A String", # A CLDR. - }, - "methodName": "A String", # The method that the service account called, e.g. "SetIamPolicy". - "principalEmail": "A String", # Associated email, such as "foo@google.com". The email address of the authenticated user or a service account acting on behalf of a 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). - "principalSubject": "A String", # A string that represents the principal_subject that is associated with the identity. Unlike `principal_email`, `principal_subject` supports principals that aren't associated with email addresses, such as third party principals. For most identities, the format is `principal://iam.googleapis.com/{identity pool name}/subject/{subject}`. Some GKE identities, such as GKE_WORKLOAD, FREEFORM, and GKE_HUB_WORKLOAD, still use the legacy format `serviceAccount:{identity pool name}[{subject}]`. - "serviceAccountDelegationInfo": [ # The identity delegation history of an authenticated service account that made the request. The `serviceAccountDelegationInfo[]` object contains information about the real authorities that try to access Google Cloud resources by delegating on a service account. When multiple authorities are present, they are guaranteed to be sorted based on the original ordering of the identity delegation events. - { # Identity delegation history of an authenticated service account. - "principalEmail": "A String", # The email address of a Google account. - "principalSubject": "A String", # A string representing the principal_subject associated with the identity. As compared to `principal_email`, supports principals that aren't associated with email addresses, such as third party principals. For most identities, the format will be `principal://iam.googleapis.com/{identity pool name}/subjects/{subject}` except for some GKE identities (GKE_WORKLOAD, FREEFORM, GKE_HUB_WORKLOAD) that are still in the legacy format `serviceAccount:{identity pool name}[{subject}]` + { + "access": { + "callerIp": "A String", + "callerIpGeo": { + "regionCode": "A String", + }, + "methodName": "A String", + "principalEmail": "A String", + "principalSubject": "A String", + "serviceAccountDelegationInfo": [ + { + "principalEmail": "A String", + "principalSubject": "A String", }, ], - "serviceAccountKeyName": "A String", # The name of the service account key that was used to create or exchange credentials when authenticating the service account that made the request. This is a scheme-less URI full resource name. For example: "//iam.googleapis.com/projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}/keys/{key}". - "serviceName": "A String", # This is the API service that the service account made a call to, e.g. "iam.googleapis.com" - "userAgent": "A String", # The caller's user agent string associated with the finding. - "userAgentFamily": "A String", # Type of user agent associated with the finding. For example, an operating system shell or an embedded or standalone application. - "userName": "A String", # A string that represents a username. The username provided depends on the type of the finding and is likely not an IAM principal. For example, this can be a system username if the finding is related to a virtual machine, or it can be an application login username. + "serviceAccountKeyName": "A String", + "serviceName": "A String", + "userAgent": "A String", + "userAgentFamily": "A String", + "userName": "A String", }, - "affectedResources": { # Details about resources affected by this finding. # AffectedResources associated with the finding. - "count": "A String", # The count of resources affected by the finding. + "affectedResources": { + "count": "A String", }, - "agentDataAccessEvents": [ # Agent data access events associated with the finding. - { # Details about a data access attempt made by an agent principal not authorized under applicable data security policy. - "eventId": "A String", # Unique identifier for data access event. - "eventTime": "A String", # Timestamp of data access event. - "operation": "A String", # The operation performed by the principal to access the data. - "principalSubject": "A String", # The agent principal that accessed the data. + "agentDataAccessEvents": [ + { + "eventId": "A String", + "eventTime": "A String", + "operation": "A String", + "principalSubject": "A String", }, ], - "aiModel": { # Contains information about the AI model associated with the finding. # The AI model associated with the finding. - "deploymentPlatform": "A String", # The platform on which the model is deployed. - "displayName": "A String", # The user defined display name of model. Ex. baseline-classification-model - "domain": "A String", # The domain of the model, for example, “image-classification”. - "library": "A String", # The name of the model library, for example, “transformers”. - "location": "A String", # The region in which the model is used, for example, “us-central1”. - "name": "A String", # The name of the AI model, for example, "gemini:1.0.0". - "publisher": "A String", # The publisher of the model, for example, “google” or “nvidia”. - "usageCategory": "A String", # The purpose of the model, for example, "Inteference" or "Training". - }, - "application": { # Represents an application associated with a finding. # Represents an application associated with the finding. - "baseUri": "A String", # The base URI that identifies the network location of the application in which the vulnerability was detected. For example, `http://example.com`. - "fullUri": "A String", # The full URI with payload that can be used to reproduce the vulnerability. For example, `http://example.com?p=aMmYgI6H`. - }, - "artifactGuardPolicies": { # Represents the result of evaluating artifact guard policies. # ArtifactGuardPolicies associated with the finding. - "failingPolicies": [ # A list of failing policies. - { # Represents an artifact guard policy. - "failureReason": "A String", # The reason for the policy failure, for example, "severity=HIGH AND max_vuln_count=2". - "policyId": "A String", # The ID of the failing policy, for example, "organizations/3392779/locations/global/policies/prod-policy". - "type": "A String", # The type of the policy evaluation. + "aiModel": { + "deploymentPlatform": "A String", + "displayName": "A String", + "domain": "A String", + "library": "A String", + "location": "A String", + "name": "A String", + "publisher": "A String", + "usageCategory": "A String", + }, + "application": { + "baseUri": "A String", + "fullUri": "A String", + }, + "artifactGuardPolicies": { + "failingPolicies": [ + { + "failureReason": "A String", + "policyId": "A String", + "type": "A String", }, ], - "resourceId": "A String", # The ID of the resource that has policies configured for it. + "resourceId": "A String", }, - "attackExposure": { # An attack exposure contains the results of an attack path simulation run. # The results of an attack path simulation relevant to this finding. - "attackExposureResult": "A String", # The resource name of the attack path simulation result that contains the details regarding this attack exposure score. Example: `organizations/123/simulations/456/attackExposureResults/789` - "exposedHighValueResourcesCount": 42, # The number of high value resources that are exposed as a result of this finding. - "exposedLowValueResourcesCount": 42, # The number of high value resources that are exposed as a result of this finding. - "exposedMediumValueResourcesCount": 42, # The number of medium value resources that are exposed as a result of this finding. - "latestCalculationTime": "A String", # The most recent time the attack exposure was updated on this finding. - "score": 3.14, # A number between 0 (inclusive) and infinity that represents how important this finding is to remediate. The higher the score, the more important it is to remediate. - "state": "A String", # What state this AttackExposure is in. This captures whether or not an attack exposure has been calculated or not. + "attackExposure": { + "attackExposureResult": "A String", + "exposedHighValueResourcesCount": 42, + "exposedLowValueResourcesCount": 42, + "exposedMediumValueResourcesCount": 42, + "latestCalculationTime": "A String", + "score": 3.14, + "state": "A String", }, - "backupDisasterRecovery": { # Information related to Google Cloud Backup and DR Service findings. # Fields related to Backup and DR findings. - "appliance": "A String", # The name of the Backup and DR appliance that captures, moves, and manages the lifecycle of backup data. For example, `backup-server-57137`. - "applications": [ # The names of Backup and DR applications. An application is a VM, database, or file system on a managed host monitored by a backup and recovery appliance. For example, `centos7-01-vol00`, `centos7-01-vol01`, `centos7-01-vol02`. + "backupDisasterRecovery": { + "appliance": "A String", + "applications": [ "A String", ], - "backupCreateTime": "A String", # The timestamp at which the Backup and DR backup was created. - "backupTemplate": "A String", # The name of a Backup and DR template which comprises one or more backup policies. See the [Backup and DR documentation](https://cloud.google.com/backup-disaster-recovery/docs/concepts/backup-plan#temp) for more information. For example, `snap-ov`. - "backupType": "A String", # The backup type of the Backup and DR image. For example, `Snapshot`, `Remote Snapshot`, `OnVault`. - "host": "A String", # The name of a Backup and DR host, which is managed by the backup and recovery appliance and known to the management console. The host can be of type Generic (for example, Compute Engine, SQL Server, Oracle DB, SMB file system, etc.), vCenter, or an ESX server. See the [Backup and DR documentation on hosts](https://cloud.google.com/backup-disaster-recovery/docs/configuration/manage-hosts-and-their-applications) for more information. For example, `centos7-01`. - "policies": [ # The names of Backup and DR policies that are associated with a template and that define when to run a backup, how frequently to run a backup, and how long to retain the backup image. For example, `onvaults`. + "backupCreateTime": "A String", + "backupTemplate": "A String", + "backupType": "A String", + "host": "A String", + "policies": [ "A String", ], - "policyOptions": [ # The names of Backup and DR advanced policy options of a policy applying to an application. See the [Backup and DR documentation on policy options](https://cloud.google.com/backup-disaster-recovery/docs/create-plan/policy-settings). For example, `skipofflineappsincongrp, nounmap`. + "policyOptions": [ "A String", ], - "profile": "A String", # The name of the Backup and DR resource profile that specifies the storage media for backups of application and VM data. See the [Backup and DR documentation on profiles](https://cloud.google.com/backup-disaster-recovery/docs/concepts/backup-plan#profile). For example, `GCP`. - "storagePool": "A String", # The name of the Backup and DR storage pool that the backup and recovery appliance is storing data in. The storage pool could be of type Cloud, Primary, Snapshot, or OnVault. See the [Backup and DR documentation on storage pools](https://cloud.google.com/backup-disaster-recovery/docs/concepts/storage-pools). For example, `DiskPoolOne`. + "profile": "A String", + "storagePool": "A String", }, - "canonicalName": "A String", # The canonical name of the finding. It's either "organizations/{organization_id}/sources/{source_id}/findings/{finding_id}", "folders/{folder_id}/sources/{source_id}/findings/{finding_id}" or "projects/{project_number}/sources/{source_id}/findings/{finding_id}", depending on the closest CRM ancestor of the resource associated with the finding. - "category": "A String", # The additional taxonomy group within findings from a given source. This field is immutable after creation time. Example: "XSS_FLASH_INJECTION" - "chokepoint": { # Contains details about a chokepoint, which is a resource or resource group where high-risk attack paths converge, based on [attack path simulations] (https://cloud.google.com/security-command-center/docs/attack-exposure-learn#attack_path_simulations). # Contains details about a chokepoint, which is a resource or resource group where high-risk attack paths converge, based on [attack path simulations] (https://cloud.google.com/security-command-center/docs/attack-exposure-learn#attack_path_simulations). This field cannot be updated. Its value is ignored in all update requests. - "relatedFindings": [ # List of resource names of findings associated with this chokepoint. For example, organizations/123/sources/456/findings/789. This list will have at most 100 findings. + "canonicalName": "A String", + "category": "A String", + "chokepoint": { + "relatedFindings": [ "A String", ], }, - "cloudArmor": { # Fields related to Google Cloud Armor findings. # Fields related to Cloud Armor findings. - "adaptiveProtection": { # Information about [Google Cloud Armor Adaptive Protection](https://cloud.google.com/armor/docs/cloud-armor-overview#google-cloud-armor-adaptive-protection). # Information about potential Layer 7 DDoS attacks identified by [Google Cloud Armor Adaptive Protection](https://cloud.google.com/armor/docs/adaptive-protection-overview). - "confidence": 3.14, # A score of 0 means that there is low confidence that the detected event is an actual attack. A score of 1 means that there is high confidence that the detected event is an attack. See the [Adaptive Protection documentation](https://cloud.google.com/armor/docs/adaptive-protection-overview#configure-alert-tuning) for further explanation. - }, - "attack": { # Information about DDoS attack volume and classification. # Information about DDoS attack volume and classification. - "classification": "A String", # Type of attack, for example, 'SYN-flood', 'NTP-udp', or 'CHARGEN-udp'. - "volumeBps": 42, # Total BPS (bytes per second) volume of attack. Deprecated - refer to volume_bps_long instead. - "volumeBpsLong": "A String", # Total BPS (bytes per second) volume of attack. - "volumePps": 42, # Total PPS (packets per second) volume of attack. Deprecated - refer to volume_pps_long instead. - "volumePpsLong": "A String", # Total PPS (packets per second) volume of attack. - }, - "duration": "A String", # Duration of attack from the start until the current moment (updated every 5 minutes). - "requests": { # Information about the requests relevant to the finding. # Information about incoming requests evaluated by [Google Cloud Armor security policies](https://cloud.google.com/armor/docs/security-policy-overview). - "longTermAllowed": 42, # Allowed RPS (requests per second) over the long term. - "longTermDenied": 42, # Denied RPS (requests per second) over the long term. - "ratio": 3.14, # For 'Increasing deny ratio', the ratio is the denied traffic divided by the allowed traffic. For 'Allowed traffic spike', the ratio is the allowed traffic in the short term divided by allowed traffic in the long term. - "shortTermAllowed": 42, # Allowed RPS (requests per second) in the short term. - }, - "securityPolicy": { # Information about the [Google Cloud Armor security policy](https://cloud.google.com/armor/docs/security-policy-overview) relevant to the finding. # Information about the [Google Cloud Armor security policy](https://cloud.google.com/armor/docs/security-policy-overview) relevant to the finding. - "name": "A String", # The name of the Google Cloud Armor security policy, for example, "my-security-policy". - "preview": True or False, # Whether or not the associated rule or policy is in preview mode. - "type": "A String", # The type of Google Cloud Armor security policy for example, 'backend security policy', 'edge security policy', 'network edge security policy', or 'always-on DDoS protection'. - }, - "threatVector": "A String", # Distinguish between volumetric & protocol DDoS attack and application layer attacks. For example, "L3_4" for Layer 3 and Layer 4 DDoS attacks, or "L_7" for Layer 7 DDoS attacks. - }, - "cloudDlpDataProfile": { # The [data profile](https://cloud.google.com/dlp/docs/data-profiles) associated with the finding. # Cloud DLP data profile that is associated with the finding. - "dataProfile": "A String", # Name of the data profile, for example, `projects/123/locations/europe/tableProfiles/8383929`. - "infoTypes": [ # Type of information detected by SDP. Info type includes name, version and sensitivity of the detected information type. - { # Type of information detected by the API. - "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. - "sensitivityScore": { # Score is calculated from of all elements in the data profile. A higher level means the data is more sensitive. # Optional custom sensitivity for this InfoType. This only applies to data profiling. - "score": "A String", # The sensitivity score applied to the resource. + "cloudArmor": { + "adaptiveProtection": { + "confidence": 3.14, + }, + "attack": { + "classification": "A String", + "volumeBps": 42, + "volumeBpsLong": "A String", + "volumePps": 42, + "volumePpsLong": "A String", + }, + "duration": "A String", + "requests": { + "longTermAllowed": 42, + "longTermDenied": 42, + "ratio": 3.14, + "shortTermAllowed": 42, + }, + "securityPolicy": { + "name": "A String", + "preview": True or False, + "type": "A String", + }, + "threatVector": "A String", + }, + "cloudDlpDataProfile": { + "dataProfile": "A String", + "infoTypes": [ + { + "name": "A String", + "sensitivityScore": { + "score": "A String", }, - "version": "A String", # Optional version name for this InfoType. + "version": "A String", }, ], - "parentType": "A String", # The resource hierarchy level at which the data profile was generated. + "parentType": "A String", }, - "cloudDlpInspection": { # Details about the Cloud Data Loss Prevention (Cloud DLP) [inspection job](https://cloud.google.com/dlp/docs/concepts-job-triggers) that produced the finding. # Cloud Data Loss Prevention (Cloud DLP) inspection results that are associated with the finding. - "fullScan": True or False, # Whether Cloud DLP scanned the complete resource or a sampled subset. - "infoType": "A String", # The type of information (or *[infoType](https://cloud.google.com/dlp/docs/infotypes-reference)*) found, for example, `EMAIL_ADDRESS` or `STREET_ADDRESS`. - "infoTypeCount": "A String", # The number of times Cloud DLP found this infoType within this job and resource. - "inspectJob": "A String", # Name of the inspection job, for example, `projects/123/locations/europe/dlpJobs/i-8383929`. + "cloudDlpInspection": { + "fullScan": True or False, + "infoType": "A String", + "infoTypeCount": "A String", + "inspectJob": "A String", }, - "complianceDetails": { # Compliance Details associated with the finding. # Details about the compliance implications of the finding. - "cloudControl": { # CloudControl associated with the finding. # CloudControl associated with the finding - "cloudControlName": "A String", # Name of the CloudControl associated with the finding. - "policyType": "A String", # Policy type of the CloudControl - "type": "A String", # Type of cloud control. - "version": 42, # Version of the Cloud Control + "complianceDetails": { + "cloudControl": { + "cloudControlName": "A String", + "policyType": "A String", + "type": "A String", + "version": 42, }, - "cloudControlDeploymentNames": [ # Cloud Control Deployments associated with the finding. For example, organizations/123/locations/global/cloudControlDeployments/deploymentIdentifier + "cloudControlDeploymentNames": [ "A String", ], - "frameworks": [ # Details of Frameworks associated with the finding - { # Compliance framework associated with the finding. - "category": [ # Category of the framework associated with the finding. E.g. Security Benchmark, or Assured Workloads + "frameworks": [ + { + "category": [ "A String", ], - "controls": [ # The controls associated with the framework. - { # Compliance control associated with the finding. - "controlName": "A String", # Name of the Control - "displayName": "A String", # Display name of the control. For example, AU-02. + "controls": [ + { + "controlName": "A String", + "displayName": "A String", }, ], - "displayName": "A String", # Display name of the framework. For a standard framework, this will look like e.g. PCI DSS 3.2.1, whereas for a custom framework it can be a user defined string like MyFramework - "name": "A String", # Name of the framework associated with the finding - "type": "A String", # Type of the framework associated with the finding, to specify whether the framework is built-in (pre-defined and immutable) or a custom framework defined by the customer (equivalent to security posture) + "displayName": "A String", + "name": "A String", + "type": "A String", }, ], }, - "compliances": [ # Contains compliance information for security standards associated to the finding. - { # Contains compliance information about a security standard indicating unmet recommendations. - "ids": [ # Policies within the standard or benchmark, for example, A.12.4.1 + "compliances": [ + { + "ids": [ "A String", ], - "standard": "A String", # Industry-wide compliance standards or benchmarks, such as CIS, PCI, and OWASP. - "version": "A String", # Version of the standard or benchmark, for example, 1.1 + "standard": "A String", + "version": "A String", }, ], - "connections": [ # Contains information about the IP connection associated with the finding. - { # Contains information about the IP connection associated with the finding. - "destinationIp": "A String", # Destination IP address. Not present for sockets that are listening and not connected. - "destinationPort": 42, # Destination port. Not present for sockets that are listening and not connected. - "protocol": "A String", # IANA Internet Protocol Number such as TCP(6) and UDP(17). - "sourceIp": "A String", # Source IP address. - "sourcePort": 42, # Source port. + "connections": [ + { + "destinationIp": "A String", + "destinationPort": 42, + "protocol": "A String", + "sourceIp": "A String", + "sourcePort": 42, }, ], - "contacts": { # Output only. Map containing the points of contact for the given finding. The key represents the type of contact, while the value contains a list of all the contacts that pertain. Please refer to: https://cloud.google.com/resource-manager/docs/managing-notification-contacts#notification-categories { "security": { "contacts": [ { "email": "person1@company.com" }, { "email": "person2@company.com" } ] } } - "a_key": { # Details about specific contacts - "contacts": [ # A list of contacts - { # The email address of a contact. - "email": "A String", # An email address. For example, "`person123@company.com`". + "contacts": { + "a_key": { + "contacts": [ + { + "email": "A String", }, ], }, }, - "containers": [ # Containers associated with the finding. This field provides information for both Kubernetes and non-Kubernetes containers. - { # Container associated with the finding. - "createTime": "A String", # The time that the container was created. - "imageId": "A String", # Optional container image ID, if provided by the container runtime. Uniquely identifies the container image launched using a container image digest. - "labels": [ # Container labels, as provided by the container runtime. - { # Represents a generic name-value label. A label has separate name and value fields to support filtering with the `contains()` function. For more information, see [Filtering on array-type fields](https://cloud.google.com/security-command-center/docs/how-to-api-list-findings#array-contains-filtering). - "name": "A String", # Name of the label. - "value": "A String", # Value that corresponds to the label's name. + "containers": [ + { + "createTime": "A String", + "imageId": "A String", + "labels": [ + { + "name": "A String", + "value": "A String", }, ], - "name": "A String", # Name of the container. - "uri": "A String", # Container image URI provided when configuring a pod or container. This string can identify a container image version using mutable tags. + "name": "A String", + "uri": "A String", }, ], - "createTime": "A String", # The time at which the finding was created in Security Command Center. - "dataAccessEvents": [ # Data access events associated with the finding. - { # Details about a data access attempt made by a principal not authorized under applicable data security policy. - "eventId": "A String", # Unique identifier for data access event. - "eventTime": "A String", # Timestamp of data access event. - "operation": "A String", # The operation performed by the principal to access the data. - "principalEmail": "A String", # The email address of the principal that accessed the data. The principal could be a user account, service account, Google group, or other. + "createTime": "A String", + "dataAccessEvents": [ + { + "eventId": "A String", + "eventTime": "A String", + "operation": "A String", + "principalEmail": "A String", }, ], - "dataFlowEvents": [ # Data flow events associated with the finding. - { # Details about a data flow event, in which either the data is moved to or is accessed from a non-compliant geo-location, as defined in the applicable data security policy. - "eventId": "A String", # Unique identifier for data flow event. - "eventTime": "A String", # Timestamp of data flow event. - "operation": "A String", # The operation performed by the principal for the data flow event. - "principalEmail": "A String", # The email address of the principal that initiated the data flow event. The principal could be a user account, service account, Google group, or other. - "violatedLocation": "A String", # Non-compliant location of the principal or the data destination. + "dataFlowEvents": [ + { + "eventId": "A String", + "eventTime": "A String", + "operation": "A String", + "principalEmail": "A String", + "violatedLocation": "A String", }, ], - "dataRetentionDeletionEvents": [ # Data retention deletion events associated with the finding. - { # Details about data retention deletion violations, in which the data is non-compliant based on their retention or deletion time, as defined in the applicable data security policy. The Data Retention Deletion (DRD) control is a control of the DSPM (Data Security Posture Management) suite that enables organizations to manage data retention and deletion policies in compliance with regulations, such as GDPR and CRPA. DRD supports two primary policy types: maximum storage length (max TTL) and minimum storage length (min TTL). Both are aimed at helping organizations meet regulatory and data management commitments. - "dataObjectCount": "A String", # Number of objects that violated the policy for this resource. If the number is less than 1,000, then the value of this field is the exact number. If the number of objects that violated the policy is greater than or equal to 1,000, then the value of this field is 1000. - "eventDetectionTime": "A String", # Timestamp indicating when the event was detected. - "eventType": "A String", # Type of the DRD event. - "maxRetentionAllowed": "A String", # Maximum duration of retention allowed from the DRD control. This comes from the DRD control where users set a max TTL for their data. For example, suppose that a user sets the max TTL for a Cloud Storage bucket to 90 days. However, an object in that bucket is 100 days old. In this case, a DataRetentionDeletionEvent will be generated for that Cloud Storage bucket, and the max_retention_allowed is 90 days. - "minRetentionAllowed": "A String", # Min duration of retention allowed from the DSPM retention control. This field is only populated when event type is set to EVENT_TYPE_MIN_TTL_FROM_CREATION. + "dataRetentionDeletionEvents": [ + { + "dataObjectCount": "A String", + "eventDetectionTime": "A String", + "eventType": "A String", + "maxRetentionAllowed": "A String", + "minRetentionAllowed": "A String", }, ], - "database": { # Represents database access information, such as queries. A database may be a sub-resource of an instance (as in the case of Cloud SQL instances or Cloud Spanner instances), or the database instance itself. Some database resources might not have the [full resource name](https://google.aip.dev/122#full-resource-names) populated because these resource types, such as Cloud SQL databases, are not yet supported by Cloud Asset Inventory. In these cases only the display name is provided. # Database associated with the finding. - "displayName": "A String", # The human-readable name of the database that the user connected to. - "grantees": [ # The target usernames, roles, or groups of an SQL privilege grant, which is not an IAM policy change. + "database": { + "displayName": "A String", + "grantees": [ "A String", ], - "name": "A String", # Some database resources may not have the [full resource name](https://google.aip.dev/122#full-resource-names) populated because these resource types are not yet supported by Cloud Asset Inventory (e.g. Cloud SQL databases). In these cases only the display name will be provided. The [full resource name](https://google.aip.dev/122#full-resource-names) of the database that the user connected to, if it is supported by Cloud Asset Inventory. - "query": "A String", # The SQL statement that is associated with the database access. - "userName": "A String", # The username used to connect to the database. The username might not be an IAM principal and does not have a set format. - "version": "A String", # The version of the database, for example, POSTGRES_14. See [the complete list](https://cloud.google.com/sql/docs/mysql/admin-api/rest/v1/SqlDatabaseVersion). - }, - "description": "A String", # Contains more details about the finding. - "discoveredWorkload": { # Represents discovered, customer managed workload that is not registered with the respective GCP service. # DiscoveredWorkload associated with the finding. - "confidence": "A String", # The confidence in detection of this workload. - "detectedRelevantHardware": True or False, # A boolean flag set to true if associated hardware strongly predicts the workload type. - "detectedRelevantKeywords": True or False, # A boolean flag set to true if associated keywords strongly predict the workload type. - "detectedRelevantPackages": True or False, # A boolean flag set to true if installed packages strongly predict the workload type. - "workloadType": "A String", # The type of workload. - }, - "disk": { # Contains information about the disk associated with the finding. # Disk associated with the finding. - "name": "A String", # The name of the disk, for example, "https://www.googleapis.com/compute/v1/projects/{project-id}/zones/{zone-id}/disks/{disk-id}". - }, - "eventTime": "A String", # The time the finding was first detected. If an existing finding is updated, then this is the time the update occurred. For example, if the finding represents an open firewall, this property captures the time the detector believes the firewall became open. The accuracy is determined by the detector. If the finding is later resolved, then this time reflects when the finding was resolved. This must not be set to a value greater than the current timestamp. - "exfiltration": { # Exfiltration represents a data exfiltration attempt from one or more sources to one or more targets. The `sources` attribute lists the sources of the exfiltrated data. The `targets` attribute lists the destinations the data was copied to. # Represents exfiltrations associated with the finding. - "sources": [ # If there are multiple sources, then the data is considered "joined" between them. For instance, BigQuery can join multiple tables, and each table would be considered a source. - { # Resource where data was exfiltrated from or exfiltrated to. - "components": [ # Subcomponents of the asset that was exfiltrated, like URIs used during exfiltration, table names, databases, and filenames. For example, multiple tables might have been exfiltrated from the same Cloud SQL instance, or multiple files might have been exfiltrated from the same Cloud Storage bucket. + "name": "A String", + "query": "A String", + "userName": "A String", + "version": "A String", + }, + "description": "A String", + "discoveredWorkload": { + "confidence": "A String", + "detectedRelevantHardware": True or False, + "detectedRelevantKeywords": True or False, + "detectedRelevantPackages": True or False, + "workloadType": "A String", + }, + "disk": { + "name": "A String", + }, + "eventTime": "A String", + "exfiltration": { + "sources": [ + { + "components": [ "A String", ], - "name": "A String", # The resource's [full resource name](https://cloud.google.com/apis/design/resource_names#full_resource_name). + "name": "A String", }, ], - "targets": [ # If there are multiple targets, each target would get a complete copy of the "joined" source data. - { # Resource where data was exfiltrated from or exfiltrated to. - "components": [ # Subcomponents of the asset that was exfiltrated, like URIs used during exfiltration, table names, databases, and filenames. For example, multiple tables might have been exfiltrated from the same Cloud SQL instance, or multiple files might have been exfiltrated from the same Cloud Storage bucket. + "targets": [ + { + "components": [ "A String", ], - "name": "A String", # The resource's [full resource name](https://cloud.google.com/apis/design/resource_names#full_resource_name). + "name": "A String", }, ], - "totalExfiltratedBytes": "A String", # Total exfiltrated bytes processed for the entire job. - }, - "externalExposure": { # Details about the externally exposed resource associated with the finding. # External exposure associated with the finding. - "backendBucket": "A String", # The full resource name of the load balancer backend bucket, for example, "//compute.googleapis.com/projects/{project-id}/global/backendBuckets/{name}" - "backendService": "A String", # The full resource name of load balancer backend service, for example, "//compute.googleapis.com/projects/{project-id}/global/backendServices/{name}". - "exposedApplication": "A String", # The name and version of the exposed web application, for example, "Jenkins 2.184". - "exposedEndpoint": "A String", # The resource which is running the exposed service, for example, "//compute.googleapis.com/projects/{project-id}/zones/{zone}/instances/{instance}.” - "exposedService": "A String", # The name and version of the service, for example, "Jupyter Notebook 6.14.0". - "forwardingRule": "A String", # The full resource name of the forwarding rule, for example, "//compute.googleapis.com/projects/{project-id}/global/forwardingRules/{forwarding-rule-name}". - "hostnameUri": "A String", # Hostname of the exposed application, for example, "https://test-app.a.run.app/" - "httpResponse": [ # The http response returned by the web application. - { # The http response returned by the web application. - "path": "A String", # The http path for which response code was returned by web application, for example, "https://test-app.a.run.app/test". - "statusCode": "A String", # The http response code returned by the web application, for example, 200. + "totalExfiltratedBytes": "A String", + }, + "externalExposure": { + "backendBucket": "A String", + "backendService": "A String", + "exposedApplication": "A String", + "exposedEndpoint": "A String", + "exposedService": "A String", + "forwardingRule": "A String", + "hostnameUri": "A String", + "httpResponse": [ + { + "path": "A String", + "statusCode": "A String", }, ], - "instanceGroup": "A String", # The full resource name of the instance group, for example, "//compute.googleapis.com/projects/{project-id}/global/instanceGroups/{name}". - "internalBackendService": "A String", # The full resource name of load balancer backend service in the internal project having resource exposed via PSC, for example, "//compute.googleapis.com/projects/{project-id}/global/backendServices/{name}". - "loadBalancerFirewallPolicy": "A String", # The full resource name of the load balancer firewall policy, for example, "//compute.googleapis.com/projects/{project-id}/global/firewallPolicies/{policy-name}". - "networkEndpointGroup": "A String", # The full resource name of the network endpoint group, for example, "//compute.googleapis.com/projects/{project-id}/global/networkEndpointGroups/{name}". - "networkIngressFirewallPolicy": "A String", # The full resource name of the network ingress firewall policy, for example, "//compute.googleapis.com/projects/{project-id}/global/firewallPolicies/{name}". - "privateIpAddress": "A String", # Private IP address of the exposed endpoint. - "privatePort": "A String", # Port number associated with private IP address. - "pscNetworkAttachment": "A String", # The full resource name of the PSC (Private Service Connect) network attachment that network interface controller is attached to, for example, "//compute.googleapis.com/projects/{project-id}/regions/{region}/networkAttachments/{name}" - "pscServiceAttachment": "A String", # The full resource name of the PSC (Private Service Connect) service attachment that the load balancer network endpoint group targets, for example, "//compute.googleapis.com/projects/{project-id}/regions/{region}/serviceAttachments/{name}" - "publicIpAddress": "A String", # Public IP address of the exposed endpoint. - "publicPort": "A String", # Public port number of the exposed endpoint. - "serviceFirewallPolicy": "A String", # The full resource name of the firewall policy of the exposed service, for example, "//compute.googleapis.com/projects/{project-id}/global/firewallPolicies/{policy-name}". - }, - "externalSystems": { # Output only. Third party SIEM/SOAR fields within SCC, contains external system information and external system finding fields. - "a_key": { # Representation of third party SIEM/SOAR fields within SCC. - "assignees": [ # References primary/secondary etc assignees in the external system. + "instanceGroup": "A String", + "internalBackendService": "A String", + "loadBalancerFirewallPolicy": "A String", + "networkEndpointGroup": "A String", + "networkIngressFirewallPolicy": "A String", + "privateIpAddress": "A String", + "privatePort": "A String", + "pscNetworkAttachment": "A String", + "pscServiceAttachment": "A String", + "publicIpAddress": "A String", + "publicPort": "A String", + "serviceFirewallPolicy": "A String", + }, + "externalSystems": { + "a_key": { + "assignees": [ "A String", ], - "caseCloseTime": "A String", # The time when the case was closed, as reported by the external system. - "caseCreateTime": "A String", # The time when the case was created, as reported by the external system. - "casePriority": "A String", # The priority of the finding's corresponding case in the external system. - "caseSla": "A String", # The SLA of the finding's corresponding case in the external system. - "caseUri": "A String", # The link to the finding's corresponding case in the external system. - "externalSystemUpdateTime": "A String", # The time when the case was last updated, as reported by the external system. - "externalUid": "A String", # The identifier that's used to track the finding's corresponding case in the external system. - "name": "A String", # Full resource name of the external system, for example: "organizations/1234/sources/5678/findings/123456/externalSystems/jira", "folders/1234/sources/5678/findings/123456/externalSystems/jira", "projects/1234/sources/5678/findings/123456/externalSystems/jira" - "status": "A String", # The most recent status of the finding's corresponding case, as reported by the external system. - "ticketInfo": { # Information about the ticket, if any, that is being used to track the resolution of the issue that is identified by this finding. # Information about the ticket, if any, that is being used to track the resolution of the issue that is identified by this finding. - "assignee": "A String", # The assignee of the ticket in the ticket system. - "description": "A String", # The description of the ticket in the ticket system. - "id": "A String", # The identifier of the ticket in the ticket system. - "status": "A String", # The latest status of the ticket, as reported by the ticket system. - "updateTime": "A String", # The time when the ticket was last updated, as reported by the ticket system. - "uri": "A String", # The link to the ticket in the ticket system. + "caseCloseTime": "A String", + "caseCreateTime": "A String", + "casePriority": "A String", + "caseSla": "A String", + "caseUri": "A String", + "externalSystemUpdateTime": "A String", + "externalUid": "A String", + "name": "A String", + "status": "A String", + "ticketInfo": { + "assignee": "A String", + "description": "A String", + "id": "A String", + "status": "A String", + "updateTime": "A String", + "uri": "A String", }, }, }, - "externalUri": "A String", # The URI that, if available, points to a web page outside of Security Command Center where additional information about the finding can be found. This field is guaranteed to be either empty or a well formed URL. - "files": [ # File associated with the finding. - { # File information about the related binary/library used by an executable, or the script used by a script interpreter - "contents": "A String", # Prefix of the file contents as a JSON-encoded string. - "diskPath": { # Path of the file in terms of underlying disk/partition identifiers. # Path of the file in terms of underlying disk/partition identifiers. - "partitionUuid": "A String", # UUID of the partition (format https://wiki.archlinux.org/title/persistent_block_device_naming#by-uuid) - "relativePath": "A String", # Relative path of the file in the partition as a JSON encoded string. Example: /home/user1/executable_file.sh + "externalUri": "A String", + "files": [ + { + "contents": "A String", + "diskPath": { + "partitionUuid": "A String", + "relativePath": "A String", }, - "fileLoadState": "A String", # The load state of the file. - "hashedSize": "A String", # The length in bytes of the file prefix that was hashed. If hashed_size == size, any hashes reported represent the entire file. - "operations": [ # Operation(s) performed on a file. - { # Operation(s) performed on a file. - "type": "A String", # The type of the operation + "fileLoadState": "A String", + "hashedSize": "A String", + "operations": [ + { + "type": "A String", }, ], - "partiallyHashed": True or False, # True when the hash covers only a prefix of the file. - "path": "A String", # Absolute path of the file as a JSON encoded string. - "sha256": "A String", # SHA256 hash of the first hashed_size bytes of the file encoded as a hex string. If hashed_size == size, sha256 represents the SHA256 hash of the entire file. - "size": "A String", # Size of the file in bytes. + "partiallyHashed": True or False, + "path": "A String", + "sha256": "A String", + "size": "A String", }, ], - "findingClass": "A String", # The class of the finding. - "groupMemberships": [ # Contains details about groups of which this finding is a member. A group is a collection of findings that are related in some way. This field cannot be updated. Its value is ignored in all update requests. - { # Contains details about groups of which this finding is a member. A group is a collection of findings that are related in some way. - "groupId": "A String", # ID of the group. - "groupType": "A String", # Type of group. + "findingClass": "A String", + "groupMemberships": [ + { + "groupId": "A String", + "groupType": "A String", }, ], - "iamBindings": [ # Represents IAM bindings associated with the finding. - { # Represents a particular IAM binding, which captures a member's role addition, removal, or state. - "action": "A String", # The action that was performed on a Binding. - "member": "A String", # A single identity requesting access for a Cloud Platform resource, for example, "foo@google.com". - "role": "A String", # Role that is assigned to "members". For example, "roles/viewer", "roles/editor", or "roles/owner". + "iamBindings": [ + { + "action": "A String", + "member": "A String", + "role": "A String", }, ], - "indicator": { # Represents what's commonly known as an _indicator of compromise_ (IoC) in computer forensics. This is an artifact observed on a network or in an operating system that, with high confidence, indicates a computer intrusion. For more information, see [Indicator of compromise](https://en.wikipedia.org/wiki/Indicator_of_compromise). # Represents what's commonly known as an *indicator of compromise* (IoC) in computer forensics. This is an artifact observed on a network or in an operating system that, with high confidence, indicates a computer intrusion. For more information, see [Indicator of compromise](https://en.wikipedia.org/wiki/Indicator_of_compromise). - "domains": [ # List of domains associated to the Finding. + "indicator": { + "domains": [ "A String", ], - "ipAddresses": [ # The list of IP addresses that are associated with the finding. + "ipAddresses": [ "A String", ], - "signatures": [ # The list of matched signatures indicating that the given process is present in the environment. - { # Indicates what signature matched this process. - "memoryHashSignature": { # A signature corresponding to memory page hashes. # Signature indicating that a binary family was matched. - "binaryFamily": "A String", # The binary family. - "detections": [ # The list of memory hash detections contributing to the binary family match. - { # Memory hash detection contributing to the binary family match. - "binary": "A String", # The name of the binary associated with the memory hash signature detection. - "percentPagesMatched": 3.14, # The percentage of memory page hashes in the signature that were matched. + "signatures": [ + { + "memoryHashSignature": { + "binaryFamily": "A String", + "detections": [ + { + "binary": "A String", + "percentPagesMatched": 3.14, }, ], }, - "signatureType": "A String", # Describes the type of resource associated with the signature. - "yaraRuleSignature": { # A signature corresponding to a YARA rule. # Signature indicating that a YARA rule was matched. - "yaraRule": "A String", # The name of the YARA rule. + "signatureType": "A String", + "yaraRuleSignature": { + "yaraRule": "A String", }, }, ], - "uris": [ # The list of URIs associated to the Findings. + "uris": [ "A String", ], }, - "ipRules": { # IP rules associated with the finding. # IP rules associated with the finding. - "allowed": { # Allowed IP rule. # Tuple with allowed rules. - "ipRules": [ # Optional. Optional list of allowed IP rules. - { # IP rule information. - "portRanges": [ # Optional. An optional list of ports to which this rule applies. This field is only applicable for the UDP or (S)TCP protocols. Each entry must be either an integer or a range including a min and max port number. - { # A port range which is inclusive of the min and max values. Values are between 0 and 2^16-1. The max can be equal / must be not smaller than the min value. If min and max are equal this indicates that it is a single port. - "max": "A String", # Maximum port value. - "min": "A String", # Minimum port value. + "ipRules": { + "allowed": { + "ipRules": [ + { + "portRanges": [ + { + "max": "A String", + "min": "A String", }, ], - "protocol": "A String", # The IP protocol this rule applies to. This value can either be one of the following well known protocol strings (TCP, UDP, ICMP, ESP, AH, IPIP, SCTP) or a string representation of the integer value. + "protocol": "A String", }, ], }, - "denied": { # Denied IP rule. # Tuple with denied rules. - "ipRules": [ # Optional. Optional list of denied IP rules. - { # IP rule information. - "portRanges": [ # Optional. An optional list of ports to which this rule applies. This field is only applicable for the UDP or (S)TCP protocols. Each entry must be either an integer or a range including a min and max port number. - { # A port range which is inclusive of the min and max values. Values are between 0 and 2^16-1. The max can be equal / must be not smaller than the min value. If min and max are equal this indicates that it is a single port. - "max": "A String", # Maximum port value. - "min": "A String", # Minimum port value. + "denied": { + "ipRules": [ + { + "portRanges": [ + { + "max": "A String", + "min": "A String", }, ], - "protocol": "A String", # The IP protocol this rule applies to. This value can either be one of the following well known protocol strings (TCP, UDP, ICMP, ESP, AH, IPIP, SCTP) or a string representation of the integer value. + "protocol": "A String", }, ], }, - "destinationIpRanges": [ # If destination IP ranges are specified, the firewall rule applies only to traffic that has a destination IP address in these ranges. These ranges must be expressed in CIDR format. Only supports IPv4. + "destinationIpRanges": [ "A String", ], - "direction": "A String", # The direction that the rule is applicable to, one of ingress or egress. - "exposedServices": [ # Name of the network protocol service, such as FTP, that is exposed by the open port. Follows the naming convention available at: https://www.iana.org/assignments/service-names-port-numbers/service-names-port-numbers.xhtml. + "direction": "A String", + "exposedServices": [ "A String", ], - "sourceIpRanges": [ # If source IP ranges are specified, the firewall rule applies only to traffic that has a source IP address in these ranges. These ranges must be expressed in CIDR format. Only supports IPv4. + "sourceIpRanges": [ "A String", ], }, - "job": { # Describes a job # Job associated with the finding. - "errorCode": 42, # Optional. If the job did not complete successfully, this field describes why. - "location": "A String", # Optional. Gives the location where the job ran, such as `US` or `europe-west1` - "name": "A String", # The fully-qualified name for a job. e.g. `projects//jobs/` - "state": "A String", # Output only. State of the job, such as `RUNNING` or `PENDING`. - }, - "kernelRootkit": { # Kernel mode rootkit signatures. # Signature of the kernel rootkit. - "name": "A String", # Rootkit name, when available. - "unexpectedCodeModification": True or False, # True if unexpected modifications of kernel code memory are present. - "unexpectedFtraceHandler": True or False, # True if `ftrace` points are present with callbacks pointing to regions that are not in the expected kernel or module code range. - "unexpectedInterruptHandler": True or False, # True if interrupt handlers that are are not in the expected kernel or module code regions are present. - "unexpectedKernelCodePages": True or False, # True if kernel code pages that are not in the expected kernel or module code regions are present. - "unexpectedKprobeHandler": True or False, # True if `kprobe` points are present with callbacks pointing to regions that are not in the expected kernel or module code range. - "unexpectedProcessesInRunqueue": True or False, # True if unexpected processes in the scheduler run queue are present. Such processes are in the run queue, but not in the process task list. - "unexpectedReadOnlyDataModification": True or False, # True if unexpected modifications of kernel read-only data memory are present. - "unexpectedSystemCallHandler": True or False, # True if system call handlers that are are not in the expected kernel or module code regions are present. - }, - "kubernetes": { # Kubernetes-related attributes. # Kubernetes resources associated with the finding. - "accessReviews": [ # Provides information on any Kubernetes access reviews (privilege checks) relevant to the finding. - { # Conveys information about a Kubernetes access review (such as one returned by a [`kubectl auth can-i`](https://kubernetes.io/docs/reference/access-authn-authz/authorization/#checking-api-access) command) that was involved in a finding. - "group": "A String", # The API group of the resource. "*" means all. - "name": "A String", # The name of the resource being requested. Empty means all. - "ns": "A String", # Namespace of the action being requested. Currently, there is no distinction between no namespace and all namespaces. Both are represented by "" (empty). - "resource": "A String", # The optional resource type requested. "*" means all. - "subresource": "A String", # The optional subresource type. - "verb": "A String", # A Kubernetes resource API verb, like get, list, watch, create, update, delete, proxy. "*" means all. - "version": "A String", # The API version of the resource. "*" means all. + "job": { + "errorCode": 42, + "location": "A String", + "name": "A String", + "state": "A String", + }, + "kernelRootkit": { + "name": "A String", + "unexpectedCodeModification": True or False, + "unexpectedFtraceHandler": True or False, + "unexpectedInterruptHandler": True or False, + "unexpectedKernelCodePages": True or False, + "unexpectedKprobeHandler": True or False, + "unexpectedProcessesInRunqueue": True or False, + "unexpectedReadOnlyDataModification": True or False, + "unexpectedSystemCallHandler": True or False, + }, + "kubernetes": { + "accessReviews": [ + { + "group": "A String", + "name": "A String", + "ns": "A String", + "resource": "A String", + "subresource": "A String", + "verb": "A String", + "version": "A String", }, ], - "bindings": [ # Provides Kubernetes role binding information for findings that involve [RoleBindings or ClusterRoleBindings](https://cloud.google.com/kubernetes-engine/docs/how-to/role-based-access-control). - { # Represents a Kubernetes RoleBinding or ClusterRoleBinding. - "name": "A String", # Name for the binding. - "ns": "A String", # Namespace for the binding. - "role": { # Kubernetes Role or ClusterRole. # The Role or ClusterRole referenced by the binding. - "kind": "A String", # Role type. - "name": "A String", # Role name. - "ns": "A String", # Role namespace. + "bindings": [ + { + "name": "A String", + "ns": "A String", + "role": { + "kind": "A String", + "name": "A String", + "ns": "A String", }, - "subjects": [ # Represents one or more subjects that are bound to the role. Not always available for PATCH requests. - { # Represents a Kubernetes subject. - "kind": "A String", # Authentication type for the subject. - "name": "A String", # Name for the subject. - "ns": "A String", # Namespace for the subject. + "subjects": [ + { + "kind": "A String", + "name": "A String", + "ns": "A String", }, ], }, ], - "nodePools": [ # GKE [node pools](https://cloud.google.com/kubernetes-engine/docs/concepts/node-pools) associated with the finding. This field contains node pool information for each node, when it is available. - { # Provides GKE node pool information. - "name": "A String", # Kubernetes node pool name. - "nodes": [ # Nodes associated with the finding. - { # Kubernetes nodes associated with the finding. - "name": "A String", # [Full resource name](https://google.aip.dev/122#full-resource-names) of the Compute Engine VM running the cluster node. + "nodePools": [ + { + "name": "A String", + "nodes": [ + { + "name": "A String", }, ], }, ], - "nodes": [ # Provides Kubernetes [node](https://cloud.google.com/kubernetes-engine/docs/concepts/cluster-architecture#nodes) information. - { # Kubernetes nodes associated with the finding. - "name": "A String", # [Full resource name](https://google.aip.dev/122#full-resource-names) of the Compute Engine VM running the cluster node. + "nodes": [ + { + "name": "A String", }, ], - "objects": [ # Kubernetes objects related to the finding. - { # Kubernetes object related to the finding, uniquely identified by GKNN. Used if the object Kind is not one of Pod, Node, NodePool, Binding, or AccessReview. - "containers": [ # Pod containers associated with this finding, if any. - { # Container associated with the finding. - "createTime": "A String", # The time that the container was created. - "imageId": "A String", # Optional container image ID, if provided by the container runtime. Uniquely identifies the container image launched using a container image digest. - "labels": [ # Container labels, as provided by the container runtime. - { # Represents a generic name-value label. A label has separate name and value fields to support filtering with the `contains()` function. For more information, see [Filtering on array-type fields](https://cloud.google.com/security-command-center/docs/how-to-api-list-findings#array-contains-filtering). - "name": "A String", # Name of the label. - "value": "A String", # Value that corresponds to the label's name. + "objects": [ + { + "containers": [ + { + "createTime": "A String", + "imageId": "A String", + "labels": [ + { + "name": "A String", + "value": "A String", }, ], - "name": "A String", # Name of the container. - "uri": "A String", # Container image URI provided when configuring a pod or container. This string can identify a container image version using mutable tags. + "name": "A String", + "uri": "A String", }, ], - "group": "A String", # Kubernetes object group, such as "policy.k8s.io/v1". - "kind": "A String", # Kubernetes object kind, such as "Namespace". - "name": "A String", # Kubernetes object name. For details see https://kubernetes.io/docs/concepts/overview/working-with-objects/names/. - "ns": "A String", # Kubernetes object namespace. Must be a valid DNS label. Named "ns" to avoid collision with C++ namespace keyword. For details see https://kubernetes.io/docs/tasks/administer-cluster/namespaces/. + "group": "A String", + "kind": "A String", + "name": "A String", + "ns": "A String", }, ], - "pods": [ # Kubernetes [Pods](https://cloud.google.com/kubernetes-engine/docs/concepts/pod) associated with the finding. This field contains Pod records for each container that is owned by a Pod. - { # A Kubernetes Pod. - "containers": [ # Pod containers associated with this finding, if any. - { # Container associated with the finding. - "createTime": "A String", # The time that the container was created. - "imageId": "A String", # Optional container image ID, if provided by the container runtime. Uniquely identifies the container image launched using a container image digest. - "labels": [ # Container labels, as provided by the container runtime. - { # Represents a generic name-value label. A label has separate name and value fields to support filtering with the `contains()` function. For more information, see [Filtering on array-type fields](https://cloud.google.com/security-command-center/docs/how-to-api-list-findings#array-contains-filtering). - "name": "A String", # Name of the label. - "value": "A String", # Value that corresponds to the label's name. + "pods": [ + { + "containers": [ + { + "createTime": "A String", + "imageId": "A String", + "labels": [ + { + "name": "A String", + "value": "A String", }, ], - "name": "A String", # Name of the container. - "uri": "A String", # Container image URI provided when configuring a pod or container. This string can identify a container image version using mutable tags. + "name": "A String", + "uri": "A String", }, ], - "labels": [ # Pod labels. For Kubernetes containers, these are applied to the container. - { # Represents a generic name-value label. A label has separate name and value fields to support filtering with the `contains()` function. For more information, see [Filtering on array-type fields](https://cloud.google.com/security-command-center/docs/how-to-api-list-findings#array-contains-filtering). - "name": "A String", # Name of the label. - "value": "A String", # Value that corresponds to the label's name. + "labels": [ + { + "name": "A String", + "value": "A String", }, ], - "name": "A String", # Kubernetes Pod name. - "ns": "A String", # Kubernetes Pod namespace. + "name": "A String", + "ns": "A String", }, ], - "roles": [ # Provides Kubernetes role information for findings that involve [Roles or ClusterRoles](https://cloud.google.com/kubernetes-engine/docs/how-to/role-based-access-control). - { # Kubernetes Role or ClusterRole. - "kind": "A String", # Role type. - "name": "A String", # Role name. - "ns": "A String", # Role namespace. + "roles": [ + { + "kind": "A String", + "name": "A String", + "ns": "A String", }, ], }, - "loadBalancers": [ # The load balancers associated with the finding. - { # Contains information related to the load balancer associated with the finding. - "name": "A String", # The name of the load balancer associated with the finding. + "loadBalancers": [ + { + "name": "A String", }, ], - "logEntries": [ # Log entries that are relevant to the finding. - { # An individual entry in a log. - "cloudLoggingEntry": { # Metadata taken from a [Cloud Logging LogEntry](https://cloud.google.com/logging/docs/reference/v2/rest/v2/LogEntry) # An individual entry in a log stored in Cloud Logging. - "insertId": "A String", # A unique identifier for the log entry. - "logId": "A String", # The type of the log (part of `log_name`. `log_name` is the resource name of the log to which this log entry belongs). For example: `cloudresourcemanager.googleapis.com/activity`. Note that this field is not URL-encoded, unlike the `LOG_ID` field in `LogEntry`. - "resourceContainer": "A String", # The organization, folder, or project of the monitored resource that produced this log entry. - "timestamp": "A String", # The time the event described by the log entry occurred. + "logEntries": [ + { + "cloudLoggingEntry": { + "insertId": "A String", + "logId": "A String", + "resourceContainer": "A String", + "timestamp": "A String", }, }, ], - "mitreAttack": { # MITRE ATT&CK tactics and techniques related to this finding. See: https://attack.mitre.org # MITRE ATT&CK tactics and techniques related to this finding. See: https://attack.mitre.org - "additionalTactics": [ # Additional MITRE ATT&CK tactics related to this finding, if any. + "mitreAttack": { + "additionalTactics": [ "A String", ], - "additionalTechniques": [ # Additional MITRE ATT&CK techniques related to this finding, if any, along with any of their respective parent techniques. + "additionalTechniques": [ "A String", ], - "primaryTactic": "A String", # The MITRE ATT&CK tactic most closely represented by this finding, if any. - "primaryTechniques": [ # The MITRE ATT&CK technique most closely represented by this finding, if any. primary_techniques is a repeated field because there are multiple levels of MITRE ATT&CK techniques. If the technique most closely represented by this finding is a sub-technique (e.g. `SCANNING_IP_BLOCKS`), both the sub-technique and its parent technique(s) will be listed (e.g. `SCANNING_IP_BLOCKS`, `ACTIVE_SCANNING`). + "primaryTactic": "A String", + "primaryTechniques": [ "A String", ], - "version": "A String", # The MITRE ATT&CK version referenced by the above fields. E.g. "8". + "version": "A String", }, - "moduleName": "A String", # Unique identifier of the module which generated the finding. Example: folders/598186756061/securityHealthAnalyticsSettings/customModules/56799441161885 - "mute": "A String", # Indicates the mute state of a finding (either muted, unmuted or undefined). Unlike other attributes of a finding, a finding provider shouldn't set the value of mute. - "muteInfo": { # Mute information about the finding, including whether the finding has a static mute or any matching dynamic mute rules. # Output only. The mute information regarding this finding. - "dynamicMuteRecords": [ # The list of dynamic mute rules that currently match the finding. - { # The record of a dynamic mute rule that matches the finding. - "matchTime": "A String", # When the dynamic mute rule first matched the finding. - "muteConfig": "A String", # The relative resource name of the mute rule, represented by a mute config, that created this record, for example `organizations/123/muteConfigs/mymuteconfig` or `organizations/123/locations/global/muteConfigs/mymuteconfig`. + "moduleName": "A String", + "mute": "A String", + "muteInfo": { + "dynamicMuteRecords": [ + { + "matchTime": "A String", + "muteConfig": "A String", }, ], - "staticMute": { # Information about the static mute state. A static mute state overrides any dynamic mute rules that apply to this finding. The static mute state can be set by a static mute rule or by muting the finding directly. # If set, the static mute applied to this finding. Static mutes override dynamic mutes. If unset, there is no static mute. - "applyTime": "A String", # When the static mute was applied. - "state": "A String", # The static mute state. If the value is `MUTED` or `UNMUTED`, then the finding's overall mute state will have the same value. + "staticMute": { + "applyTime": "A String", + "state": "A String", }, }, - "muteInitiator": "A String", # Records additional information about the mute operation, for example, the [mute configuration](/security-command-center/docs/how-to-mute-findings) that muted the finding and the user who muted the finding. - "muteUpdateTime": "A String", # Output only. The most recent time this finding was muted or unmuted. - "name": "A String", # The [relative resource name](https://cloud.google.com/apis/design/resource_names#relative_resource_name) of the finding. Example: "organizations/{organization_id}/sources/{source_id}/findings/{finding_id}", "folders/{folder_id}/sources/{source_id}/findings/{finding_id}", "projects/{project_id}/sources/{source_id}/findings/{finding_id}". - "networks": [ # Represents the VPC networks that the resource is attached to. - { # Contains information about a VPC network associated with the finding. - "name": "A String", # The name of the VPC network resource, for example, `//compute.googleapis.com/projects/my-project/global/networks/my-network`. + "muteInitiator": "A String", + "muteUpdateTime": "A String", + "name": "A String", + "networks": [ + { + "name": "A String", }, ], - "nextSteps": "A String", # Steps to address the finding. - "notebook": { # Represents a Jupyter notebook IPYNB file, such as a [Colab Enterprise notebook](https://cloud.google.com/colab/docs/introduction) file, that is associated with a finding. # Notebook associated with the finding. - "lastAuthor": "A String", # The user ID of the latest author to modify the notebook. - "name": "A String", # The name of the notebook. - "notebookUpdateTime": "A String", # The most recent time the notebook was updated. - "service": "A String", # The source notebook service, for example, "Colab Enterprise". + "nextSteps": "A String", + "notebook": { + "lastAuthor": "A String", + "name": "A String", + "notebookUpdateTime": "A String", + "service": "A String", }, - "orgPolicies": [ # Contains information about the org policies associated with the finding. - { # Contains information about the org policies associated with the finding. - "name": "A String", # The resource name of the org policy. Example: "organizations/{organization_id}/policies/{constraint_name}" + "orgPolicies": [ + { + "name": "A String", }, ], - "parent": "A String", # The relative resource name of the source the finding belongs to. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name This field is immutable after creation time. For example: "organizations/{organization_id}/sources/{source_id}" - "parentDisplayName": "A String", # Output only. The human readable display name of the finding source such as "Event Threat Detection" or "Security Health Analytics". - "policyViolationSummary": { # Metadata summarizing policy violations of child resources of the affected resource. `finding_category` and `resource` determine the exact semantics of the counts. For example, when category=DATA_SECURITY_POSTURE_OBJECT_PUBLIC_ACCESS_VIOLATION and resource='storage.googleapis.com/buckets/my-bucket-name' then this counts the number of Cloud Storage objects in my-bucket-name which violate a Public Access control. # PolicyViolationSummary associated with the finding. - "conformantResourcesCount": "A String", # Total number of child resources that conform to the policy. - "evaluationErrorsCount": "A String", # Number of child resources for which errors during evaluation occurred. The evaluation result for these child resources is effectively "unknown". - "outOfScopeResourcesCount": "A String", # Total count of child resources which were not in scope for evaluation. - "policyViolationsCount": "A String", # Count of child resources in violation of the policy. - }, - "processes": [ # Represents operating system processes associated with the Finding. - { # Represents an operating system process. - "args": [ # Process arguments as JSON encoded strings. + "parent": "A String", + "parentDisplayName": "A String", + "policyViolationSummary": { + "conformantResourcesCount": "A String", + "evaluationErrorsCount": "A String", + "outOfScopeResourcesCount": "A String", + "policyViolationsCount": "A String", + }, + "processes": [ + { + "args": [ "A String", ], - "argumentsTruncated": True or False, # True if `args` is incomplete. - "binary": { # File information about the related binary/library used by an executable, or the script used by a script interpreter # File information for the process executable. - "contents": "A String", # Prefix of the file contents as a JSON-encoded string. - "diskPath": { # Path of the file in terms of underlying disk/partition identifiers. # Path of the file in terms of underlying disk/partition identifiers. - "partitionUuid": "A String", # UUID of the partition (format https://wiki.archlinux.org/title/persistent_block_device_naming#by-uuid) - "relativePath": "A String", # Relative path of the file in the partition as a JSON encoded string. Example: /home/user1/executable_file.sh + "argumentsTruncated": True or False, + "binary": { + "contents": "A String", + "diskPath": { + "partitionUuid": "A String", + "relativePath": "A String", }, - "fileLoadState": "A String", # The load state of the file. - "hashedSize": "A String", # The length in bytes of the file prefix that was hashed. If hashed_size == size, any hashes reported represent the entire file. - "operations": [ # Operation(s) performed on a file. - { # Operation(s) performed on a file. - "type": "A String", # The type of the operation + "fileLoadState": "A String", + "hashedSize": "A String", + "operations": [ + { + "type": "A String", }, ], - "partiallyHashed": True or False, # True when the hash covers only a prefix of the file. - "path": "A String", # Absolute path of the file as a JSON encoded string. - "sha256": "A String", # SHA256 hash of the first hashed_size bytes of the file encoded as a hex string. If hashed_size == size, sha256 represents the SHA256 hash of the entire file. - "size": "A String", # Size of the file in bytes. + "partiallyHashed": True or False, + "path": "A String", + "sha256": "A String", + "size": "A String", }, - "envVariables": [ # Process environment variables. - { # A name-value pair representing an environment variable used in an operating system process. - "name": "A String", # Environment variable name as a JSON encoded string. - "val": "A String", # Environment variable value as a JSON encoded string. + "envVariables": [ + { + "name": "A String", + "val": "A String", }, ], - "envVariablesTruncated": True or False, # True if `env_variables` is incomplete. - "libraries": [ # File information for libraries loaded by the process. - { # File information about the related binary/library used by an executable, or the script used by a script interpreter - "contents": "A String", # Prefix of the file contents as a JSON-encoded string. - "diskPath": { # Path of the file in terms of underlying disk/partition identifiers. # Path of the file in terms of underlying disk/partition identifiers. - "partitionUuid": "A String", # UUID of the partition (format https://wiki.archlinux.org/title/persistent_block_device_naming#by-uuid) - "relativePath": "A String", # Relative path of the file in the partition as a JSON encoded string. Example: /home/user1/executable_file.sh + "envVariablesTruncated": True or False, + "libraries": [ + { + "contents": "A String", + "diskPath": { + "partitionUuid": "A String", + "relativePath": "A String", }, - "fileLoadState": "A String", # The load state of the file. - "hashedSize": "A String", # The length in bytes of the file prefix that was hashed. If hashed_size == size, any hashes reported represent the entire file. - "operations": [ # Operation(s) performed on a file. - { # Operation(s) performed on a file. - "type": "A String", # The type of the operation + "fileLoadState": "A String", + "hashedSize": "A String", + "operations": [ + { + "type": "A String", }, ], - "partiallyHashed": True or False, # True when the hash covers only a prefix of the file. - "path": "A String", # Absolute path of the file as a JSON encoded string. - "sha256": "A String", # SHA256 hash of the first hashed_size bytes of the file encoded as a hex string. If hashed_size == size, sha256 represents the SHA256 hash of the entire file. - "size": "A String", # Size of the file in bytes. + "partiallyHashed": True or False, + "path": "A String", + "sha256": "A String", + "size": "A String", }, ], - "name": "A String", # The process name, as displayed in utilities like `top` and `ps`. This name can be accessed through `/proc/[pid]/comm` and changed with `prctl(PR_SET_NAME)`. - "parentPid": "A String", # The parent process ID. - "pid": "A String", # The process ID. - "script": { # File information about the related binary/library used by an executable, or the script used by a script interpreter # When the process represents the invocation of a script, `binary` provides information about the interpreter, while `script` provides information about the script file provided to the interpreter. - "contents": "A String", # Prefix of the file contents as a JSON-encoded string. - "diskPath": { # Path of the file in terms of underlying disk/partition identifiers. # Path of the file in terms of underlying disk/partition identifiers. - "partitionUuid": "A String", # UUID of the partition (format https://wiki.archlinux.org/title/persistent_block_device_naming#by-uuid) - "relativePath": "A String", # Relative path of the file in the partition as a JSON encoded string. Example: /home/user1/executable_file.sh + "name": "A String", + "parentPid": "A String", + "pid": "A String", + "script": { + "contents": "A String", + "diskPath": { + "partitionUuid": "A String", + "relativePath": "A String", }, - "fileLoadState": "A String", # The load state of the file. - "hashedSize": "A String", # The length in bytes of the file prefix that was hashed. If hashed_size == size, any hashes reported represent the entire file. - "operations": [ # Operation(s) performed on a file. - { # Operation(s) performed on a file. - "type": "A String", # The type of the operation + "fileLoadState": "A String", + "hashedSize": "A String", + "operations": [ + { + "type": "A String", }, ], - "partiallyHashed": True or False, # True when the hash covers only a prefix of the file. - "path": "A String", # Absolute path of the file as a JSON encoded string. - "sha256": "A String", # SHA256 hash of the first hashed_size bytes of the file encoded as a hex string. If hashed_size == size, sha256 represents the SHA256 hash of the entire file. - "size": "A String", # Size of the file in bytes. + "partiallyHashed": True or False, + "path": "A String", + "sha256": "A String", + "size": "A String", }, - "userId": "A String", # The ID of the user that executed the process. E.g. If this is the root user this will always be 0. + "userId": "A String", }, ], - "resourceName": "A String", # For findings on Google Cloud resources, the full resource name of the Google Cloud resource this finding is for. See: https://cloud.google.com/apis/design/resource_names#full_resource_name When the finding is for a non-Google Cloud resource, the resourceName can be a customer or partner defined string. This field is immutable after creation time. - "secret": { # Details about a secret or credential associated with the finding. # Secret associated with the finding. - "environmentVariable": { # Environment variable containing the secret. # The environment variable containing the secret. - "key": "A String", # Environment variable name as a JSON encoded string. Note that value is not included since the value contains the secret data, which is sensitive core content. + "resourceName": "A String", + "secret": { + "environmentVariable": { + "key": "A String", }, - "filePath": { # File path containing the secret. # The file containing the secret. - "path": "A String", # Path to the file. + "filePath": { + "path": "A String", }, - "status": { # The status of the secret. # The status of the secret. - "lastUpdatedTime": "A String", # Time that the secret was found. - "validity": "A String", # The validity of the secret. + "status": { + "lastUpdatedTime": "A String", + "validity": "A String", }, - "type": "A String", # The type of secret, for example, GCP_API_KEY. + "type": "A String", }, - "securityMarks": { # User specified security marks that are attached to the parent Security Command Center resource. Security marks are scoped within a Security Command Center organization -- they can be modified and viewed by all users who have proper permissions on the organization. # Output only. User specified security marks. These marks are entirely managed by the user and come from the SecurityMarks resource that belongs to the finding. - "canonicalName": "A String", # The canonical name of the marks. Examples: "organizations/{organization_id}/assets/{asset_id}/securityMarks" "folders/{folder_id}/assets/{asset_id}/securityMarks" "projects/{project_number}/assets/{asset_id}/securityMarks" "organizations/{organization_id}/sources/{source_id}/findings/{finding_id}/securityMarks" "folders/{folder_id}/sources/{source_id}/findings/{finding_id}/securityMarks" "projects/{project_number}/sources/{source_id}/findings/{finding_id}/securityMarks" - "marks": { # Mutable user specified security marks belonging to the parent resource. Constraints are as follows: * Keys and values are treated as case insensitive * Keys must be between 1 - 256 characters (inclusive) * Keys must be letters, numbers, underscores, or dashes * Values have leading and trailing whitespace trimmed, remaining characters must be between 1 - 4096 characters (inclusive) + "securityMarks": { + "canonicalName": "A String", + "marks": { "a_key": "A String", }, - "name": "A String", # The relative resource name of the SecurityMarks. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Examples: "organizations/{organization_id}/assets/{asset_id}/securityMarks" "organizations/{organization_id}/sources/{source_id}/findings/{finding_id}/securityMarks". - }, - "securityPosture": { # Represents a posture that is deployed on Google Cloud by the Security Command Center Posture Management service. A posture contains one or more policy sets. A policy set is a group of policies that enforce a set of security rules on Google Cloud. # The security posture associated with the finding. - "changedPolicy": "A String", # The name of the updated policy, for example, `projects/{project_id}/policies/{constraint_name}`. - "name": "A String", # Name of the posture, for example, `CIS-Posture`. - "policy": "A String", # The ID of the updated policy, for example, `compute-policy-1`. - "policyDriftDetails": [ # The details about a change in an updated policy that violates the deployed posture. - { # The policy field that violates the deployed posture and its expected and detected values. - "detectedValue": "A String", # The detected value that violates the deployed posture, for example, `false` or `allowed_values={"projects/22831892"}`. - "expectedValue": "A String", # The value of this field that was configured in a posture, for example, `true` or `allowed_values={"projects/29831892"}`. - "field": "A String", # The name of the updated field, for example constraint.implementation.policy_rules[0].enforce + "name": "A String", + }, + "securityPosture": { + "changedPolicy": "A String", + "name": "A String", + "policy": "A String", + "policyDriftDetails": [ + { + "detectedValue": "A String", + "expectedValue": "A String", + "field": "A String", }, ], - "policySet": "A String", # The name of the updated policyset, for example, `cis-policyset`. - "postureDeployment": "A String", # The name of the posture deployment, for example, `organizations/{org_id}/posturedeployments/{posture_deployment_id}`. - "postureDeploymentResource": "A String", # The project, folder, or organization on which the posture is deployed, for example, `projects/{project_number}`. - "revisionId": "A String", # The version of the posture, for example, `c7cfa2a8`. + "policySet": "A String", + "postureDeployment": "A String", + "postureDeploymentResource": "A String", + "revisionId": "A String", }, - "severity": "A String", # The severity of the finding. This field is managed by the source that writes the finding. - "sourceProperties": { # Source specific properties. These properties are managed by the source that writes the finding. The key names in the source_properties map must be between 1 and 255 characters, and must start with a letter and contain alphanumeric characters or underscores only. + "severity": "A String", + "sourceProperties": { "a_key": "", }, - "state": "A String", # The state of the finding. - "toxicCombination": { # Contains details about a group of security issues that, when the issues occur together, represent a greater risk than when the issues occur independently. A group of such issues is referred to as a toxic combination. # Contains details about a group of security issues that, when the issues occur together, represent a greater risk than when the issues occur independently. A group of such issues is referred to as a toxic combination. This field cannot be updated. Its value is ignored in all update requests. - "attackExposureScore": 3.14, # The [Attack exposure score](https://cloud.google.com/security-command-center/docs/attack-exposure-learn#attack_exposure_scores) of this toxic combination. The score is a measure of how much this toxic combination exposes one or more high-value resources to potential attack. - "relatedFindings": [ # List of resource names of findings associated with this toxic combination. For example, `organizations/123/sources/456/findings/789`. + "state": "A String", + "toxicCombination": { + "attackExposureScore": 3.14, + "relatedFindings": [ "A String", ], }, - "vertexAi": { # Vertex AI-related information associated with the finding. # VertexAi associated with the finding. - "datasets": [ # Datasets associated with the finding. - { # Vertex AI dataset associated with the finding. - "displayName": "A String", # The user defined display name of dataset, e.g. plants-dataset - "name": "A String", # Resource name of the dataset, e.g. projects/{project}/locations/{location}/datasets/2094040236064505856 - "source": "A String", # Data source, such as BigQuery source URI, e.g. bq://scc-nexus-test.AIPPtest.gsod + "vertexAi": { + "datasets": [ + { + "displayName": "A String", + "name": "A String", + "source": "A String", }, ], - "pipelines": [ # Pipelines associated with the finding. - { # Vertex AI training pipeline associated with the finding. - "displayName": "A String", # The user defined display name of pipeline, e.g. plants-classification - "name": "A String", # Resource name of the pipeline, e.g. projects/{project}/locations/{location}/trainingPipelines/5253428229225578496 + "pipelines": [ + { + "displayName": "A String", + "name": "A String", }, ], }, - "vulnerability": { # Refers to common vulnerability fields e.g. cve, cvss, cwe etc. # Represents vulnerability-specific fields like CVE and CVSS scores. CVE stands for Common Vulnerabilities and Exposures (https://cve.mitre.org/about/) - "cve": { # CVE stands for Common Vulnerabilities and Exposures. Information from the [CVE record](https://www.cve.org/ResourcesSupport/Glossary) that describes this vulnerability. # CVE stands for Common Vulnerabilities and Exposures (https://cve.mitre.org/about/) - "cvssv3": { # Common Vulnerability Scoring System version 3. # Describe Common Vulnerability Scoring System specified at https://www.first.org/cvss/v3.1/specification-document - "attackComplexity": "A String", # This metric describes the conditions beyond the attacker's control that must exist in order to exploit the vulnerability. - "attackVector": "A String", # Base Metrics Represents the intrinsic characteristics of a vulnerability that are constant over time and across user environments. This metric reflects the context by which vulnerability exploitation is possible. - "availabilityImpact": "A String", # This metric measures the impact to the availability of the impacted component resulting from a successfully exploited vulnerability. - "baseScore": 3.14, # The base score is a function of the base metric scores. - "confidentialityImpact": "A String", # This metric measures the impact to the confidentiality of the information resources managed by a software component due to a successfully exploited vulnerability. - "integrityImpact": "A String", # This metric measures the impact to integrity of a successfully exploited vulnerability. - "privilegesRequired": "A String", # This metric describes the level of privileges an attacker must possess before successfully exploiting the vulnerability. - "scope": "A String", # The Scope metric captures whether a vulnerability in one vulnerable component impacts resources in components beyond its security scope. - "userInteraction": "A String", # This metric captures the requirement for a human user, other than the attacker, to participate in the successful compromise of the vulnerable component. + "vulnerability": { + "cve": { + "cvssv3": { + "attackComplexity": "A String", + "attackVector": "A String", + "availabilityImpact": "A String", + "baseScore": 3.14, + "confidentialityImpact": "A String", + "integrityImpact": "A String", + "privilegesRequired": "A String", + "scope": "A String", + "userInteraction": "A String", }, - "exploitReleaseDate": "A String", # Date the first publicly available exploit or PoC was released. - "exploitationActivity": "A String", # The exploitation activity of the vulnerability in the wild. - "firstExploitationDate": "A String", # Date of the earliest known exploitation. - "id": "A String", # The unique identifier for the vulnerability. e.g. CVE-2021-34527 - "impact": "A String", # The potential impact of the vulnerability if it was to be exploited. - "observedInTheWild": True or False, # Whether or not the vulnerability has been observed in the wild. - "references": [ # Additional information about the CVE. e.g. https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2021-34527 - { # Additional Links - "source": "A String", # Source of the reference e.g. NVD - "uri": "A String", # Uri for the mentioned source e.g. https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2021-34527. + "exploitReleaseDate": "A String", + "exploitationActivity": "A String", + "firstExploitationDate": "A String", + "id": "A String", + "impact": "A String", + "observedInTheWild": True or False, + "references": [ + { + "source": "A String", + "uri": "A String", }, ], - "upstreamFixAvailable": True or False, # Whether upstream fix is available for the CVE. - "zeroDay": True or False, # Whether or not the vulnerability was zero day when the finding was published. - }, - "cwes": [ # Represents one or more Common Weakness Enumeration (CWE) information on this vulnerability. - { # CWE stands for Common Weakness Enumeration. Information about this weakness, as described by [CWE](https://cwe.mitre.org/). - "id": "A String", # The CWE identifier, e.g. CWE-94 - "references": [ # Any reference to the details on the CWE, for example, https://cwe.mitre.org/data/definitions/94.html - { # Additional Links - "source": "A String", # Source of the reference e.g. NVD - "uri": "A String", # Uri for the mentioned source e.g. https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2021-34527. + "upstreamFixAvailable": True or False, + "zeroDay": True or False, + }, + "cwes": [ + { + "id": "A String", + "references": [ + { + "source": "A String", + "uri": "A String", }, ], }, ], - "fixedPackage": { # Package is a generic definition of a package. # The fixed package is relevant to the finding. - "cpeUri": "A String", # The CPE URI where the vulnerability was detected. - "packageName": "A String", # The name of the package where the vulnerability was detected. - "packageType": "A String", # Type of package, for example, os, maven, or go. - "packageVersion": "A String", # The version of the package. + "fixedPackage": { + "cpeUri": "A String", + "packageName": "A String", + "packageType": "A String", + "packageVersion": "A String", }, - "offendingPackage": { # Package is a generic definition of a package. # The offending package is relevant to the finding. - "cpeUri": "A String", # The CPE URI where the vulnerability was detected. - "packageName": "A String", # The name of the package where the vulnerability was detected. - "packageType": "A String", # Type of package, for example, os, maven, or go. - "packageVersion": "A String", # The version of the package. + "offendingPackage": { + "cpeUri": "A String", + "packageName": "A String", + "packageType": "A String", + "packageVersion": "A String", }, - "providerRiskScore": "A String", # Provider provided risk_score based on multiple factors. The higher the risk score, the more risky the vulnerability is. - "reachable": True or False, # Represents whether the vulnerability is reachable (detected via static analysis) - "securityBulletin": { # SecurityBulletin are notifications of vulnerabilities of Google products. # The security bulletin is relevant to this finding. - "bulletinId": "A String", # ID of the bulletin corresponding to the vulnerability. - "submissionTime": "A String", # Submission time of this Security Bulletin. - "suggestedUpgradeVersion": "A String", # This represents a version that the cluster receiving this notification should be upgraded to, based on its current version. For example, 1.15.0 + "providerRiskScore": "A String", + "reachable": True or False, + "securityBulletin": { + "bulletinId": "A String", + "submissionTime": "A String", + "suggestedUpgradeVersion": "A String", }, }, }
@@ -4446,23 +4446,23 @@

Method Details

updateSecurityMarks(name, body=None, startTime=None, updateMask=None, x__xgafv=None) -
Updates security marks.
+  
 
 Args:
-  name: string, The relative resource name of the SecurityMarks. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Examples: "organizations/{organization_id}/assets/{asset_id}/securityMarks" "organizations/{organization_id}/sources/{source_id}/findings/{finding_id}/securityMarks". (required)
+  name: string, A parameter (required)
   body: object, The request body.
     The object takes the form of:
 
-{ # User specified security marks that are attached to the parent Security Command Center resource. Security marks are scoped within a Security Command Center organization -- they can be modified and viewed by all users who have proper permissions on the organization.
-  "canonicalName": "A String", # The canonical name of the marks. Examples: "organizations/{organization_id}/assets/{asset_id}/securityMarks" "folders/{folder_id}/assets/{asset_id}/securityMarks" "projects/{project_number}/assets/{asset_id}/securityMarks" "organizations/{organization_id}/sources/{source_id}/findings/{finding_id}/securityMarks" "folders/{folder_id}/sources/{source_id}/findings/{finding_id}/securityMarks" "projects/{project_number}/sources/{source_id}/findings/{finding_id}/securityMarks"
-  "marks": { # Mutable user specified security marks belonging to the parent resource. Constraints are as follows: * Keys and values are treated as case insensitive * Keys must be between 1 - 256 characters (inclusive) * Keys must be letters, numbers, underscores, or dashes * Values have leading and trailing whitespace trimmed, remaining characters must be between 1 - 4096 characters (inclusive)
+{
+  "canonicalName": "A String",
+  "marks": {
     "a_key": "A String",
   },
-  "name": "A String", # The relative resource name of the SecurityMarks. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Examples: "organizations/{organization_id}/assets/{asset_id}/securityMarks" "organizations/{organization_id}/sources/{source_id}/findings/{finding_id}/securityMarks".
+  "name": "A String",
 }
 
-  startTime: string, The time at which the updated SecurityMarks take effect. If not set uses current server time. Updates will be applied to the SecurityMarks that are active immediately preceding this time. Must be earlier or equal to the server time.
-  updateMask: string, The FieldMask to use when updating the security marks resource. The field mask must not contain duplicate fields. If empty or set to "marks", all marks will be replaced. Individual marks can be updated using "marks.".
+  startTime: string, A parameter
+  updateMask: string, A parameter
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -4471,12 +4471,12 @@ 

Method Details

Returns: An object of the form: - { # User specified security marks that are attached to the parent Security Command Center resource. Security marks are scoped within a Security Command Center organization -- they can be modified and viewed by all users who have proper permissions on the organization. - "canonicalName": "A String", # The canonical name of the marks. Examples: "organizations/{organization_id}/assets/{asset_id}/securityMarks" "folders/{folder_id}/assets/{asset_id}/securityMarks" "projects/{project_number}/assets/{asset_id}/securityMarks" "organizations/{organization_id}/sources/{source_id}/findings/{finding_id}/securityMarks" "folders/{folder_id}/sources/{source_id}/findings/{finding_id}/securityMarks" "projects/{project_number}/sources/{source_id}/findings/{finding_id}/securityMarks" - "marks": { # Mutable user specified security marks belonging to the parent resource. Constraints are as follows: * Keys and values are treated as case insensitive * Keys must be between 1 - 256 characters (inclusive) * Keys must be letters, numbers, underscores, or dashes * Values have leading and trailing whitespace trimmed, remaining characters must be between 1 - 4096 characters (inclusive) + { + "canonicalName": "A String", + "marks": { "a_key": "A String", }, - "name": "A String", # The relative resource name of the SecurityMarks. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Examples: "organizations/{organization_id}/assets/{asset_id}/securityMarks" "organizations/{organization_id}/sources/{source_id}/findings/{finding_id}/securityMarks". + "name": "A String", }
diff --git a/docs/dyn/securitycenter_v1.projects.sources.html b/docs/dyn/securitycenter_v1.projects.sources.html index 400bcb92d3..3c8c3935ee 100644 --- a/docs/dyn/securitycenter_v1.projects.sources.html +++ b/docs/dyn/securitycenter_v1.projects.sources.html @@ -84,7 +84,7 @@

Instance Methods

Close httplib2 connections.

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

-

Lists all sources belonging to an organization.

+

list_next()

Retrieves the next page of results.

@@ -96,12 +96,12 @@

Method Details

list(parent, pageSize=None, pageToken=None, x__xgafv=None) -
Lists all sources belonging to an organization.
+  
 
 Args:
-  parent: string, Required. Resource name of the parent of sources to list. Its format should be `organizations/[organization_id]`, `folders/[folder_id]`, or `projects/[project_id]`. (required)
-  pageSize: integer, The maximum number of results to return in a single response. Default is 10, minimum is 1, maximum is 1000.
-  pageToken: string, The value returned by the last `ListSourcesResponse`; indicates that this is a continuation of a prior `ListSources` call, and that the system should return the next page of data.
+  parent: string, A parameter (required)
+  pageSize: integer, A parameter
+  pageToken: string, A parameter
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -110,14 +110,14 @@ 

Method Details

Returns: An object of the form: - { # Response message for listing sources. - "nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no more results. - "sources": [ # Sources belonging to the requested parent. - { # Security Command Center finding source. A finding source is an entity or a mechanism that can produce a finding. A source is like a container of findings that come from the same scanner, logger, monitor, and other tools. - "canonicalName": "A String", # The canonical name of the finding source. It's either "organizations/{organization_id}/sources/{source_id}", "folders/{folder_id}/sources/{source_id}", or "projects/{project_number}/sources/{source_id}", depending on the closest CRM ancestor of the resource associated with the finding. - "description": "A String", # The description of the source (max of 1024 characters). Example: "Web Security Scanner is a web security scanner for common vulnerabilities in App Engine applications. It can automatically scan and detect four common vulnerabilities, including cross-site-scripting (XSS), Flash injection, mixed content (HTTP in HTTPS), and outdated or insecure libraries." - "displayName": "A String", # The source's display name. A source's display name must be unique amongst its siblings, for example, two sources with the same parent can't share the same display name. The display name must have a length between 1 and 64 characters (inclusive). - "name": "A String", # The relative resource name of this source. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Example: "organizations/{organization_id}/sources/{source_id}" + { + "nextPageToken": "A String", + "sources": [ + { + "canonicalName": "A String", + "description": "A String", + "displayName": "A String", + "name": "A String", }, ], }
diff --git a/docs/dyn/securitycenter_v1beta1.organizations.assets.html b/docs/dyn/securitycenter_v1beta1.organizations.assets.html index c810c4ad5b..de52a51662 100644 --- a/docs/dyn/securitycenter_v1beta1.organizations.assets.html +++ b/docs/dyn/securitycenter_v1beta1.organizations.assets.html @@ -79,22 +79,22 @@

Instance Methods

Close httplib2 connections.

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

-

Filters an organization's assets and groups them by their specified properties.

+

group_next()

Retrieves the next page of results.

list(parent, compareDuration=None, fieldMask=None, filter=None, orderBy=None, pageSize=None, pageToken=None, readTime=None, x__xgafv=None)

-

Lists an organization's assets.

+

list_next()

Retrieves the next page of results.

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

-

Runs asset discovery. The discovery is tracked with a long-running operation. This API can only be called with limited frequency for an organization. If it is called too frequently the caller will receive a TOO_MANY_REQUESTS error.

+

updateSecurityMarks(name, body=None, startTime=None, updateMask=None, x__xgafv=None)

-

Updates security marks.

+

Method Details

close() @@ -103,20 +103,20 @@

Method Details

group(parent, body=None, x__xgafv=None) -
Filters an organization's assets and groups them by their specified properties.
+  
 
 Args:
-  parent: string, Required. Name of the organization to groupBy. Its format is "organizations/[organization_id]". (required)
+  parent: string, A parameter (required)
   body: object, The request body.
     The object takes the form of:
 
-{ # Request message for grouping by assets.
-  "compareDuration": "A String", # When compare_duration is set, the Asset's "state" property is updated to indicate whether the asset was added, removed, or remained present during the compare_duration period of time that precedes the read_time. This is the time between (read_time - compare_duration) and read_time. The state value is derived based on the presence of the asset at the two points in time. Intermediate state changes between the two times don't affect the result. For example, the results aren't affected if the asset is removed and re-created again. Possible "state" values when compare_duration is specified: * "ADDED": indicates that the asset was not present before compare_duration, but present at reference_time. * "REMOVED": indicates that the asset was present at the start of compare_duration, but not present at reference_time. * "ACTIVE": indicates that the asset was present at both the start and the end of the time period defined by compare_duration and reference_time. This field is ignored if `state` is not a field in `group_by`.
-  "filter": "A String", # Expression that defines the filter to apply across assets. The expression is a list of zero or more restrictions combined via logical operators `AND` and `OR`. Parentheses are not supported, and `OR` has higher precedence than `AND`. Restrictions have the form ` ` and may have a `-` character in front of them to indicate negation. The fields map to those defined in the Asset resource. Examples include: * name * security_center_properties.resource_name * resource_properties.a_property * security_marks.marks.marka The supported operators are: * `=` for all value types. * `>`, `<`, `>=`, `<=` for integer values. * `:`, meaning substring matching, for strings. The supported value types are: * string literals in quotes. * integer literals without quotes. * boolean literals `true` and `false` without quotes. For example, `resource_properties.size = 100` is a valid filter string.
-  "groupBy": "A String", # Required. Expression that defines what assets fields to use for grouping. The string value should follow SQL syntax: comma separated list of fields. For example: "security_center_properties.resource_project,security_center_properties.project". The following fields are supported when compare_duration is not set: * security_center_properties.resource_project * security_center_properties.resource_type * security_center_properties.resource_parent The following fields are supported when compare_duration is set: * security_center_properties.resource_type
-  "pageSize": 42, # The maximum number of results to return in a single response. Default is 10, minimum is 1, maximum is 1000.
-  "pageToken": "A String", # The value returned by the last `GroupAssetsResponse`; indicates that this is a continuation of a prior `GroupAssets` call, and that the system should return the next page of data.
-  "readTime": "A String", # Time used as a reference point when filtering assets. The filter is limited to assets existing at the supplied time and their values are those at that specific time. Absence of this field will default to the API's version of NOW.
+{
+  "compareDuration": "A String",
+  "filter": "A String",
+  "groupBy": "A String",
+  "pageSize": 42,
+  "pageToken": "A String",
+  "readTime": "A String",
 }
 
   x__xgafv: string, V1 error format.
@@ -127,17 +127,17 @@ 

Method Details

Returns: An object of the form: - { # Response message for grouping by assets. - "groupByResults": [ # Group results. There exists an element for each existing unique combination of property/values. The element contains a count for the number of times those specific property/values appear. - { # Result containing the properties and count of a groupBy request. - "count": "A String", # Total count of resources for the given properties. - "properties": { # Properties matching the groupBy fields in the request. + { + "groupByResults": [ + { + "count": "A String", + "properties": { "a_key": "", }, }, ], - "nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no more results. - "readTime": "A String", # Time used for executing the groupBy request. + "nextPageToken": "A String", + "readTime": "A String", }
@@ -157,17 +157,17 @@

Method Details

list(parent, compareDuration=None, fieldMask=None, filter=None, orderBy=None, pageSize=None, pageToken=None, readTime=None, x__xgafv=None) -
Lists an organization's assets.
+  
 
 Args:
-  parent: string, Required. Name of the organization assets should belong to. Its format is "organizations/[organization_id]". (required)
-  compareDuration: string, When compare_duration is set, the ListAssetResult's "state" attribute is updated to indicate whether the asset was added, removed, or remained present during the compare_duration period of time that precedes the read_time. This is the time between (read_time - compare_duration) and read_time. The state value is derived based on the presence of the asset at the two points in time. Intermediate state changes between the two times don't affect the result. For example, the results aren't affected if the asset is removed and re-created again. Possible "state" values when compare_duration is specified: * "ADDED": indicates that the asset was not present before compare_duration, but present at read_time. * "REMOVED": indicates that the asset was present at the start of compare_duration, but not present at read_time. * "ACTIVE": indicates that the asset was present at both the start and the end of the time period defined by compare_duration and read_time. If compare_duration is not specified, then the only possible state is "UNUSED", which indicates that the asset is present at read_time.
-  fieldMask: string, Optional. A field mask to specify the ListAssetsResult fields to be listed in the response. An empty field mask will list all fields.
-  filter: string, Expression that defines the filter to apply across assets. The expression is a list of zero or more restrictions combined via logical operators `AND` and `OR`. Parentheses are not supported, and `OR` has higher precedence than `AND`. Restrictions have the form ` ` and may have a `-` character in front of them to indicate negation. The fields map to those defined in the Asset resource. Examples include: * name * security_center_properties.resource_name * resource_properties.a_property * security_marks.marks.marka The supported operators are: * `=` for all value types. * `>`, `<`, `>=`, `<=` for integer values. * `:`, meaning substring matching, for strings. The supported value types are: * string literals in quotes. * integer literals without quotes. * boolean literals `true` and `false` without quotes. For example, `resource_properties.size = 100` is a valid filter string.
-  orderBy: string, Expression that defines what fields and order to use for sorting. The string value should follow SQL syntax: comma separated list of fields. For example: "name,resource_properties.a_property". The default sorting order is ascending. To specify descending order for a field, a suffix " desc" should be appended to the field name. For example: "name desc,resource_properties.a_property". Redundant space characters in the syntax are insignificant. "name desc,resource_properties.a_property" and " name desc , resource_properties.a_property " are equivalent.
-  pageSize: integer, The maximum number of results to return in a single response. Default is 10, minimum is 1, maximum is 1000.
-  pageToken: string, The value returned by the last `ListAssetsResponse`; indicates that this is a continuation of a prior `ListAssets` call, and that the system should return the next page of data.
-  readTime: string, Time used as a reference point when filtering assets. The filter is limited to assets existing at the supplied time and their values are those at that specific time. Absence of this field will default to the API's version of NOW.
+  parent: string, A parameter (required)
+  compareDuration: string, A parameter
+  fieldMask: string, A parameter
+  filter: string, A parameter
+  orderBy: string, A parameter
+  pageSize: integer, A parameter
+  pageToken: string, A parameter
+  readTime: string, A parameter
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -176,38 +176,38 @@ 

Method Details

Returns: An object of the form: - { # Response message for listing assets. - "listAssetsResults": [ # Assets matching the list request. - { # Result containing the Asset and its State. - "asset": { # Security Command Center representation of a Google Cloud resource. The Asset is a Security Command Center resource that captures information about a single Google Cloud resource. All modifications to an Asset are only within the context of Security Command Center and don't affect the referenced Google Cloud resource. # Asset matching the search request. - "createTime": "A String", # The time at which the asset was created in Security Command Center. - "name": "A String", # The relative resource name of this asset. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Example: "organizations/{organization_id}/assets/{asset_id}". - "resourceProperties": { # Resource managed properties. These properties are managed and defined by the Google Cloud resource and cannot be modified by the user. + { + "listAssetsResults": [ + { + "asset": { + "createTime": "A String", + "name": "A String", + "resourceProperties": { "a_key": "", }, - "securityCenterProperties": { # Security Command Center managed properties. These properties are managed by Security Command Center and cannot be modified by the user. # Security Command Center managed properties. These properties are managed by Security Command Center and cannot be modified by the user. - "resourceName": "A String", # Immutable. The full resource name of the Google Cloud resource this asset represents. This field is immutable after create time. See: https://cloud.google.com/apis/design/resource_names#full_resource_name - "resourceOwners": [ # Owners of the Google Cloud resource. + "securityCenterProperties": { + "resourceName": "A String", + "resourceOwners": [ "A String", ], - "resourceParent": "A String", # The full resource name of the immediate parent of the resource. See: https://cloud.google.com/apis/design/resource_names#full_resource_name - "resourceProject": "A String", # The full resource name of the project the resource belongs to. See: https://cloud.google.com/apis/design/resource_names#full_resource_name - "resourceType": "A String", # The type of the Google Cloud resource. Examples include: APPLICATION, PROJECT, and ORGANIZATION. This is a case insensitive field defined by Security Command Center and/or the producer of the resource and is immutable after create time. + "resourceParent": "A String", + "resourceProject": "A String", + "resourceType": "A String", }, - "securityMarks": { # User specified security marks that are attached to the parent Security Command Center resource. Security marks are scoped within a Security Command Center organization -- they can be modified and viewed by all users who have proper permissions on the organization. # User specified security marks. These marks are entirely managed by the user and come from the SecurityMarks resource that belongs to the asset. - "marks": { # Mutable user specified security marks belonging to the parent resource. Constraints are as follows: * Keys and values are treated as case insensitive * Keys must be between 1 - 256 characters (inclusive) * Keys must be letters, numbers, underscores, or dashes * Values have leading and trailing whitespace trimmed, remaining characters must be between 1 - 4096 characters (inclusive) + "securityMarks": { + "marks": { "a_key": "A String", }, - "name": "A String", # The relative resource name of the SecurityMarks. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Examples: "organizations/{organization_id}/assets/{asset_id}/securityMarks" "organizations/{organization_id}/sources/{source_id}/findings/{finding_id}/securityMarks". + "name": "A String", }, - "updateTime": "A String", # The time at which the asset was last updated, added, or deleted in Security Command Center. + "updateTime": "A String", }, - "state": "A String", # State of the asset. + "state": "A String", }, ], - "nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no more results. - "readTime": "A String", # Time used for executing the list request. - "totalSize": 42, # The total number of assets matching the query. + "nextPageToken": "A String", + "readTime": "A String", + "totalSize": 42, }
@@ -227,14 +227,14 @@

Method Details

runDiscovery(parent, body=None, x__xgafv=None) -
Runs asset discovery. The discovery is tracked with a long-running operation. This API can only be called with limited frequency for an organization. If it is called too frequently the caller will receive a TOO_MANY_REQUESTS error.
+  
 
 Args:
-  parent: string, Required. Name of the organization to run asset discovery for. Its format is "organizations/[organization_id]". (required)
+  parent: string, A parameter (required)
   body: object, The request body.
     The object takes the form of:
 
-{ # Request message for running asset discovery for an organization.
+{
 }
 
   x__xgafv: string, V1 error format.
@@ -245,22 +245,22 @@ 

Method Details

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. + { + "done": True or False, + "error": { + "code": 42, + "details": [ { "a_key": "", # Properties of the object. Contains field @type with type URL. }, ], - "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. + "message": "A String", }, - "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. + "metadata": { "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`. + "name": "A String", + "response": { "a_key": "", # Properties of the object. Contains field @type with type URL. }, }
@@ -268,22 +268,22 @@

Method Details

updateSecurityMarks(name, body=None, startTime=None, updateMask=None, x__xgafv=None) -
Updates security marks.
+  
 
 Args:
-  name: string, The relative resource name of the SecurityMarks. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Examples: "organizations/{organization_id}/assets/{asset_id}/securityMarks" "organizations/{organization_id}/sources/{source_id}/findings/{finding_id}/securityMarks". (required)
+  name: string, A parameter (required)
   body: object, The request body.
     The object takes the form of:
 
-{ # User specified security marks that are attached to the parent Security Command Center resource. Security marks are scoped within a Security Command Center organization -- they can be modified and viewed by all users who have proper permissions on the organization.
-  "marks": { # Mutable user specified security marks belonging to the parent resource. Constraints are as follows: * Keys and values are treated as case insensitive * Keys must be between 1 - 256 characters (inclusive) * Keys must be letters, numbers, underscores, or dashes * Values have leading and trailing whitespace trimmed, remaining characters must be between 1 - 4096 characters (inclusive)
+{
+  "marks": {
     "a_key": "A String",
   },
-  "name": "A String", # The relative resource name of the SecurityMarks. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Examples: "organizations/{organization_id}/assets/{asset_id}/securityMarks" "organizations/{organization_id}/sources/{source_id}/findings/{finding_id}/securityMarks".
+  "name": "A String",
 }
 
-  startTime: string, The time at which the updated SecurityMarks take effect.
-  updateMask: string, The FieldMask to use when updating the security marks resource.
+  startTime: string, A parameter
+  updateMask: string, A parameter
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -292,11 +292,11 @@ 

Method Details

Returns: An object of the form: - { # User specified security marks that are attached to the parent Security Command Center resource. Security marks are scoped within a Security Command Center organization -- they can be modified and viewed by all users who have proper permissions on the organization. - "marks": { # Mutable user specified security marks belonging to the parent resource. Constraints are as follows: * Keys and values are treated as case insensitive * Keys must be between 1 - 256 characters (inclusive) * Keys must be letters, numbers, underscores, or dashes * Values have leading and trailing whitespace trimmed, remaining characters must be between 1 - 4096 characters (inclusive) + { + "marks": { "a_key": "A String", }, - "name": "A String", # The relative resource name of the SecurityMarks. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Examples: "organizations/{organization_id}/assets/{asset_id}/securityMarks" "organizations/{organization_id}/sources/{source_id}/findings/{finding_id}/securityMarks". + "name": "A String", }
diff --git a/docs/dyn/securitycenter_v1beta1.organizations.html b/docs/dyn/securitycenter_v1beta1.organizations.html index 7eaa56c8c7..261e365f3a 100644 --- a/docs/dyn/securitycenter_v1beta1.organizations.html +++ b/docs/dyn/securitycenter_v1beta1.organizations.html @@ -94,10 +94,10 @@

Instance Methods

Close httplib2 connections.

getOrganizationSettings(name, x__xgafv=None)

-

Gets the settings for an organization.

+

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

-

Updates an organization's settings.

+

Method Details

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

Method Details

getOrganizationSettings(name, x__xgafv=None) -
Gets the settings for an organization.
+  
 
 Args:
-  name: string, Required. Name of the organization to get organization settings for. Its format is "organizations/[organization_id]/organizationSettings". (required)
+  name: string, A parameter (required)
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -118,39 +118,39 @@ 

Method Details

Returns: An object of the form: - { # User specified settings that are attached to the Security Command Center organization. - "assetDiscoveryConfig": { # The configuration used for Asset Discovery runs. # The configuration used for Asset Discovery runs. - "inclusionMode": "A String", # The mode to use for filtering asset discovery. - "projectIds": [ # The project ids to use for filtering asset discovery. + { + "assetDiscoveryConfig": { + "inclusionMode": "A String", + "projectIds": [ "A String", ], }, - "enableAssetDiscovery": True or False, # A flag that indicates if Asset Discovery should be enabled. If the flag is set to `true`, then discovery of assets will occur. If it is set to `false`, all historical assets will remain, but discovery of future assets will not occur. - "name": "A String", # The relative resource name of the settings. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Example: "organizations/{organization_id}/organizationSettings". + "enableAssetDiscovery": True or False, + "name": "A String", }
updateOrganizationSettings(name, body=None, updateMask=None, x__xgafv=None) -
Updates an organization's settings.
+  
 
 Args:
-  name: string, The relative resource name of the settings. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Example: "organizations/{organization_id}/organizationSettings". (required)
+  name: string, A parameter (required)
   body: object, The request body.
     The object takes the form of:
 
-{ # User specified settings that are attached to the Security Command Center organization.
-  "assetDiscoveryConfig": { # The configuration used for Asset Discovery runs. # The configuration used for Asset Discovery runs.
-    "inclusionMode": "A String", # The mode to use for filtering asset discovery.
-    "projectIds": [ # The project ids to use for filtering asset discovery.
+{
+  "assetDiscoveryConfig": {
+    "inclusionMode": "A String",
+    "projectIds": [
       "A String",
     ],
   },
-  "enableAssetDiscovery": True or False, # A flag that indicates if Asset Discovery should be enabled. If the flag is set to `true`, then discovery of assets will occur. If it is set to `false`, all historical assets will remain, but discovery of future assets will not occur.
-  "name": "A String", # The relative resource name of the settings. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Example: "organizations/{organization_id}/organizationSettings".
+  "enableAssetDiscovery": True or False,
+  "name": "A String",
 }
 
-  updateMask: string, The FieldMask to use when updating the settings resource.
+  updateMask: string, A parameter
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -159,15 +159,15 @@ 

Method Details

Returns: An object of the form: - { # User specified settings that are attached to the Security Command Center organization. - "assetDiscoveryConfig": { # The configuration used for Asset Discovery runs. # The configuration used for Asset Discovery runs. - "inclusionMode": "A String", # The mode to use for filtering asset discovery. - "projectIds": [ # The project ids to use for filtering asset discovery. + { + "assetDiscoveryConfig": { + "inclusionMode": "A String", + "projectIds": [ "A String", ], }, - "enableAssetDiscovery": True or False, # A flag that indicates if Asset Discovery should be enabled. If the flag is set to `true`, then discovery of assets will occur. If it is set to `false`, all historical assets will remain, but discovery of future assets will not occur. - "name": "A String", # The relative resource name of the settings. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Example: "organizations/{organization_id}/organizationSettings". + "enableAssetDiscovery": True or False, + "name": "A String", }
diff --git a/docs/dyn/securitycenter_v1beta1.organizations.operations.html b/docs/dyn/securitycenter_v1beta1.organizations.operations.html index b561fc01da..a42e5addb5 100644 --- a/docs/dyn/securitycenter_v1beta1.organizations.operations.html +++ b/docs/dyn/securitycenter_v1beta1.organizations.operations.html @@ -76,33 +76,33 @@

Security Command Center API . Instance Methods

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

-

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

+

close()

Close httplib2 connections.

delete(name, x__xgafv=None)

-

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

+

get(name, x__xgafv=None)

-

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

+

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

-

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

+

list_next()

Retrieves the next page of results.

Method Details

cancel(name, body=None, x__xgafv=None) -
Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.
+  
 
 Args:
-  name: string, The name of the operation resource to be cancelled. (required)
+  name: string, A parameter (required)
   body: object, The request body.
     The object takes the form of:
 
-{ # The request message for Operations.CancelOperation.
+{
 }
 
   x__xgafv: string, V1 error format.
@@ -113,7 +113,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); } + { }
@@ -124,10 +124,10 @@

Method Details

delete(name, x__xgafv=None) -
Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.
+  
 
 Args:
-  name: string, The name of the operation resource to be deleted. (required)
+  name: string, A parameter (required)
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -136,16 +136,16 @@ 

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); } + { }
get(name, x__xgafv=None) -
Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
+  
 
 Args:
-  name: string, The name of the operation resource. (required)
+  name: string, A parameter (required)
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -154,22 +154,22 @@ 

Method Details

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. + { + "done": True or False, + "error": { + "code": 42, + "details": [ { "a_key": "", # Properties of the object. Contains field @type with type URL. }, ], - "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. + "message": "A String", }, - "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. + "metadata": { "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`. + "name": "A String", + "response": { "a_key": "", # Properties of the object. Contains field @type with type URL. }, }
@@ -177,14 +177,14 @@

Method Details

list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None) -
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
+  
 
 Args:
-  name: string, The name of the operation's parent resource. (required)
-  filter: string, The standard list filter.
-  pageSize: integer, The standard list page size.
-  pageToken: string, The standard list page token.
-  returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
+  name: string, A parameter (required)
+  filter: string, A parameter
+  pageSize: integer, A parameter
+  pageToken: string, A parameter
+  returnPartialSuccess: boolean, A parameter
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -193,30 +193,30 @@ 

Method Details

Returns: An object of the form: - { # The response message for Operations.ListOperations. - "nextPageToken": "A String", # The standard List next-page token. - "operations": [ # A list of operations that matches the specified filter in the request. - { # This resource represents a long-running operation that is the result of a network API call. - "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. - "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation. - "code": 42, # The status code, which should be an enum value of google.rpc.Code. - "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. + { + "nextPageToken": "A String", + "operations": [ + { + "done": True or False, + "error": { + "code": 42, + "details": [ { "a_key": "", # Properties of the object. Contains field @type with type URL. }, ], - "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. + "message": "A String", }, - "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. + "metadata": { "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`. + "name": "A String", + "response": { "a_key": "", # Properties of the object. Contains field @type with type URL. }, }, ], - "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections. For example, when attempting to list all resources across all supported locations. + "unreachable": [ "A String", ], }
diff --git a/docs/dyn/securitycenter_v1beta1.organizations.sources.findings.html b/docs/dyn/securitycenter_v1beta1.organizations.sources.findings.html index 84cdda0c15..40a80d9ca3 100644 --- a/docs/dyn/securitycenter_v1beta1.organizations.sources.findings.html +++ b/docs/dyn/securitycenter_v1beta1.organizations.sources.findings.html @@ -79,28 +79,28 @@

Instance Methods

Close httplib2 connections.

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

-

Creates a finding. The corresponding source must exist for finding creation to succeed.

+

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

-

Filters an organization or source's findings and groups them by their specified properties. To group across all sources provide a `-` as the source id. Example: /v1beta1/organizations/{organization_id}/sources/-/findings

+

group_next()

Retrieves the next page of results.

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

-

Lists an organization or source's findings. To list across all sources provide a `-` as the source id. Example: /v1beta1/organizations/{organization_id}/sources/-/findings

+

list_next()

Retrieves the next page of results.

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

-

Creates or updates a finding. The corresponding source must exist for a finding creation to succeed.

+

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

-

Updates the state of a finding.

+

updateSecurityMarks(name, body=None, startTime=None, updateMask=None, x__xgafv=None)

-

Updates security marks.

+

Method Details

close() @@ -109,34 +109,34 @@

Method Details

create(parent, body=None, findingId=None, x__xgafv=None) -
Creates a finding. The corresponding source must exist for finding creation to succeed.
+  
 
 Args:
-  parent: string, Required. Resource name of the new finding's parent. Its format should be "organizations/[organization_id]/sources/[source_id]". (required)
+  parent: string, A parameter (required)
   body: object, The request body.
     The object takes the form of:
 
-{ # Security Command Center finding. A finding is a record of assessment data (security, risk, health or privacy) ingested into Security Command Center for presentation, notification, analysis, policy testing, and enforcement. For example, an XSS vulnerability in an App Engine application is a finding.
-  "category": "A String", # The additional taxonomy group within findings from a given source. This field is immutable after creation time. Example: "XSS_FLASH_INJECTION"
-  "createTime": "A String", # The time at which the finding was created in Security Command Center.
-  "eventTime": "A String", # The time at which the event took place, or when an update to the finding occurred. For example, if the finding represents an open firewall it would capture the time the detector believes the firewall became open. The accuracy is determined by the detector. If the finding were to be resolved afterward, this time would reflect when the finding was resolved.
-  "externalUri": "A String", # The URI that, if available, points to a web page outside of Security Command Center where additional information about the finding can be found. This field is guaranteed to be either empty or a well formed URL.
-  "name": "A String", # The relative resource name of this finding. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Example: "organizations/{organization_id}/sources/{source_id}/findings/{finding_id}"
-  "parent": "A String", # Immutable. The relative resource name of the source the finding belongs to. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name This field is immutable after creation time. For example: "organizations/{organization_id}/sources/{source_id}"
-  "resourceName": "A String", # For findings on Google Cloud resources, the full resource name of the Google Cloud resource this finding is for. See: https://cloud.google.com/apis/design/resource_names#full_resource_name When the finding is for a non-Google Cloud resource, the resourceName can be a customer or partner defined string. This field is immutable after creation time.
-  "securityMarks": { # User specified security marks that are attached to the parent Security Command Center resource. Security marks are scoped within a Security Command Center organization -- they can be modified and viewed by all users who have proper permissions on the organization. # Output only. User specified security marks. These marks are entirely managed by the user and come from the SecurityMarks resource that belongs to the finding.
-    "marks": { # Mutable user specified security marks belonging to the parent resource. Constraints are as follows: * Keys and values are treated as case insensitive * Keys must be between 1 - 256 characters (inclusive) * Keys must be letters, numbers, underscores, or dashes * Values have leading and trailing whitespace trimmed, remaining characters must be between 1 - 4096 characters (inclusive)
+{
+  "category": "A String",
+  "createTime": "A String",
+  "eventTime": "A String",
+  "externalUri": "A String",
+  "name": "A String",
+  "parent": "A String",
+  "resourceName": "A String",
+  "securityMarks": {
+    "marks": {
       "a_key": "A String",
     },
-    "name": "A String", # The relative resource name of the SecurityMarks. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Examples: "organizations/{organization_id}/assets/{asset_id}/securityMarks" "organizations/{organization_id}/sources/{source_id}/findings/{finding_id}/securityMarks".
+    "name": "A String",
   },
-  "sourceProperties": { # Source specific properties. These properties are managed by the source that writes the finding. The key names in the source_properties map must be between 1 and 255 characters, and must start with a letter and contain alphanumeric characters or underscores only.
+  "sourceProperties": {
     "a_key": "",
   },
-  "state": "A String", # The state of the finding.
+  "state": "A String",
 }
 
-  findingId: string, Required. Unique identifier provided by the client within the parent scope. It must be alphanumeric and less than or equal to 32 characters and greater than 0 characters in length.
+  findingId: string, A parameter
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -145,42 +145,42 @@ 

Method Details

Returns: An object of the form: - { # Security Command Center finding. A finding is a record of assessment data (security, risk, health or privacy) ingested into Security Command Center for presentation, notification, analysis, policy testing, and enforcement. For example, an XSS vulnerability in an App Engine application is a finding. - "category": "A String", # The additional taxonomy group within findings from a given source. This field is immutable after creation time. Example: "XSS_FLASH_INJECTION" - "createTime": "A String", # The time at which the finding was created in Security Command Center. - "eventTime": "A String", # The time at which the event took place, or when an update to the finding occurred. For example, if the finding represents an open firewall it would capture the time the detector believes the firewall became open. The accuracy is determined by the detector. If the finding were to be resolved afterward, this time would reflect when the finding was resolved. - "externalUri": "A String", # The URI that, if available, points to a web page outside of Security Command Center where additional information about the finding can be found. This field is guaranteed to be either empty or a well formed URL. - "name": "A String", # The relative resource name of this finding. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Example: "organizations/{organization_id}/sources/{source_id}/findings/{finding_id}" - "parent": "A String", # Immutable. The relative resource name of the source the finding belongs to. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name This field is immutable after creation time. For example: "organizations/{organization_id}/sources/{source_id}" - "resourceName": "A String", # For findings on Google Cloud resources, the full resource name of the Google Cloud resource this finding is for. See: https://cloud.google.com/apis/design/resource_names#full_resource_name When the finding is for a non-Google Cloud resource, the resourceName can be a customer or partner defined string. This field is immutable after creation time. - "securityMarks": { # User specified security marks that are attached to the parent Security Command Center resource. Security marks are scoped within a Security Command Center organization -- they can be modified and viewed by all users who have proper permissions on the organization. # Output only. User specified security marks. These marks are entirely managed by the user and come from the SecurityMarks resource that belongs to the finding. - "marks": { # Mutable user specified security marks belonging to the parent resource. Constraints are as follows: * Keys and values are treated as case insensitive * Keys must be between 1 - 256 characters (inclusive) * Keys must be letters, numbers, underscores, or dashes * Values have leading and trailing whitespace trimmed, remaining characters must be between 1 - 4096 characters (inclusive) + { + "category": "A String", + "createTime": "A String", + "eventTime": "A String", + "externalUri": "A String", + "name": "A String", + "parent": "A String", + "resourceName": "A String", + "securityMarks": { + "marks": { "a_key": "A String", }, - "name": "A String", # The relative resource name of the SecurityMarks. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Examples: "organizations/{organization_id}/assets/{asset_id}/securityMarks" "organizations/{organization_id}/sources/{source_id}/findings/{finding_id}/securityMarks". + "name": "A String", }, - "sourceProperties": { # Source specific properties. These properties are managed by the source that writes the finding. The key names in the source_properties map must be between 1 and 255 characters, and must start with a letter and contain alphanumeric characters or underscores only. + "sourceProperties": { "a_key": "", }, - "state": "A String", # The state of the finding. + "state": "A String", }
group(parent, body=None, x__xgafv=None) -
Filters an organization or source's findings and groups them by their specified properties. To group across all sources provide a `-` as the source id. Example: /v1beta1/organizations/{organization_id}/sources/-/findings
+  
 
 Args:
-  parent: string, Required. Name of the source to groupBy. Its format is "organizations/[organization_id]/sources/[source_id]". To groupBy across all sources provide a source_id of `-`. For example: organizations/{organization_id}/sources/- (required)
+  parent: string, A parameter (required)
   body: object, The request body.
     The object takes the form of:
 
-{ # Request message for grouping by findings.
-  "filter": "A String", # Expression that defines the filter to apply across findings. The expression is a list of one or more restrictions combined via logical operators `AND` and `OR`. Parentheses are not supported, and `OR` has higher precedence than `AND`. Restrictions have the form ` ` and may have a `-` character in front of them to indicate negation. Examples include: * name * source_properties.a_property * security_marks.marks.marka The supported operators are: * `=` for all value types. * `>`, `<`, `>=`, `<=` for integer values. * `:`, meaning substring matching, for strings. The supported value types are: * string literals in quotes. * integer literals without quotes. * boolean literals `true` and `false` without quotes. For example, `source_properties.size = 100` is a valid filter string.
-  "groupBy": "A String", # Required. Expression that defines what assets fields to use for grouping (including `state`). The string value should follow SQL syntax: comma separated list of fields. For example: "parent,resource_name". The following fields are supported: * resource_name * category * state * parent
-  "pageSize": 42, # The maximum number of results to return in a single response. Default is 10, minimum is 1, maximum is 1000.
-  "pageToken": "A String", # The value returned by the last `GroupFindingsResponse`; indicates that this is a continuation of a prior `GroupFindings` call, and that the system should return the next page of data.
-  "readTime": "A String", # Time used as a reference point when filtering findings. The filter is limited to findings existing at the supplied time and their values are those at that specific time. Absence of this field will default to the API's version of NOW.
+{
+  "filter": "A String",
+  "groupBy": "A String",
+  "pageSize": 42,
+  "pageToken": "A String",
+  "readTime": "A String",
 }
 
   x__xgafv: string, V1 error format.
@@ -191,17 +191,17 @@ 

Method Details

Returns: An object of the form: - { # Response message for group by findings. - "groupByResults": [ # Group results. There exists an element for each existing unique combination of property/values. The element contains a count for the number of times those specific property/values appear. - { # Result containing the properties and count of a groupBy request. - "count": "A String", # Total count of resources for the given properties. - "properties": { # Properties matching the groupBy fields in the request. + { + "groupByResults": [ + { + "count": "A String", + "properties": { "a_key": "", }, }, ], - "nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no more results. - "readTime": "A String", # Time used for executing the groupBy request. + "nextPageToken": "A String", + "readTime": "A String", }
@@ -221,16 +221,16 @@

Method Details

list(parent, fieldMask=None, filter=None, orderBy=None, pageSize=None, pageToken=None, readTime=None, x__xgafv=None) -
Lists an organization or source's findings. To list across all sources provide a `-` as the source id. Example: /v1beta1/organizations/{organization_id}/sources/-/findings
+  
 
 Args:
-  parent: string, Required. Name of the source the findings belong to. Its format is "organizations/[organization_id]/sources/[source_id]". To list across all sources provide a source_id of `-`. For example: organizations/{organization_id}/sources/- (required)
-  fieldMask: string, Optional. A field mask to specify the Finding fields to be listed in the response. An empty field mask will list all fields.
-  filter: string, Expression that defines the filter to apply across findings. The expression is a list of one or more restrictions combined via logical operators `AND` and `OR`. Parentheses are not supported, and `OR` has higher precedence than `AND`. Restrictions have the form ` ` and may have a `-` character in front of them to indicate negation. Examples include: * name * source_properties.a_property * security_marks.marks.marka The supported operators are: * `=` for all value types. * `>`, `<`, `>=`, `<=` for integer values. * `:`, meaning substring matching, for strings. The supported value types are: * string literals in quotes. * integer literals without quotes. * boolean literals `true` and `false` without quotes. For example, `source_properties.size = 100` is a valid filter string.
-  orderBy: string, Expression that defines what fields and order to use for sorting. The string value should follow SQL syntax: comma separated list of fields. For example: "name,resource_properties.a_property". The default sorting order is ascending. To specify descending order for a field, a suffix " desc" should be appended to the field name. For example: "name desc,source_properties.a_property". Redundant space characters in the syntax are insignificant. "name desc,source_properties.a_property" and " name desc , source_properties.a_property " are equivalent.
-  pageSize: integer, The maximum number of results to return in a single response. Default is 10, minimum is 1, maximum is 1000.
-  pageToken: string, The value returned by the last `ListFindingsResponse`; indicates that this is a continuation of a prior `ListFindings` call, and that the system should return the next page of data.
-  readTime: string, Time used as a reference point when filtering findings. The filter is limited to findings existing at the supplied time and their values are those at that specific time. Absence of this field will default to the API's version of NOW.
+  parent: string, A parameter (required)
+  fieldMask: string, A parameter
+  filter: string, A parameter
+  orderBy: string, A parameter
+  pageSize: integer, A parameter
+  pageToken: string, A parameter
+  readTime: string, A parameter
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -239,31 +239,31 @@ 

Method Details

Returns: An object of the form: - { # Response message for listing findings. - "findings": [ # Findings matching the list request. - { # Security Command Center finding. A finding is a record of assessment data (security, risk, health or privacy) ingested into Security Command Center for presentation, notification, analysis, policy testing, and enforcement. For example, an XSS vulnerability in an App Engine application is a finding. - "category": "A String", # The additional taxonomy group within findings from a given source. This field is immutable after creation time. Example: "XSS_FLASH_INJECTION" - "createTime": "A String", # The time at which the finding was created in Security Command Center. - "eventTime": "A String", # The time at which the event took place, or when an update to the finding occurred. For example, if the finding represents an open firewall it would capture the time the detector believes the firewall became open. The accuracy is determined by the detector. If the finding were to be resolved afterward, this time would reflect when the finding was resolved. - "externalUri": "A String", # The URI that, if available, points to a web page outside of Security Command Center where additional information about the finding can be found. This field is guaranteed to be either empty or a well formed URL. - "name": "A String", # The relative resource name of this finding. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Example: "organizations/{organization_id}/sources/{source_id}/findings/{finding_id}" - "parent": "A String", # Immutable. The relative resource name of the source the finding belongs to. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name This field is immutable after creation time. For example: "organizations/{organization_id}/sources/{source_id}" - "resourceName": "A String", # For findings on Google Cloud resources, the full resource name of the Google Cloud resource this finding is for. See: https://cloud.google.com/apis/design/resource_names#full_resource_name When the finding is for a non-Google Cloud resource, the resourceName can be a customer or partner defined string. This field is immutable after creation time. - "securityMarks": { # User specified security marks that are attached to the parent Security Command Center resource. Security marks are scoped within a Security Command Center organization -- they can be modified and viewed by all users who have proper permissions on the organization. # Output only. User specified security marks. These marks are entirely managed by the user and come from the SecurityMarks resource that belongs to the finding. - "marks": { # Mutable user specified security marks belonging to the parent resource. Constraints are as follows: * Keys and values are treated as case insensitive * Keys must be between 1 - 256 characters (inclusive) * Keys must be letters, numbers, underscores, or dashes * Values have leading and trailing whitespace trimmed, remaining characters must be between 1 - 4096 characters (inclusive) + { + "findings": [ + { + "category": "A String", + "createTime": "A String", + "eventTime": "A String", + "externalUri": "A String", + "name": "A String", + "parent": "A String", + "resourceName": "A String", + "securityMarks": { + "marks": { "a_key": "A String", }, - "name": "A String", # The relative resource name of the SecurityMarks. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Examples: "organizations/{organization_id}/assets/{asset_id}/securityMarks" "organizations/{organization_id}/sources/{source_id}/findings/{finding_id}/securityMarks". + "name": "A String", }, - "sourceProperties": { # Source specific properties. These properties are managed by the source that writes the finding. The key names in the source_properties map must be between 1 and 255 characters, and must start with a letter and contain alphanumeric characters or underscores only. + "sourceProperties": { "a_key": "", }, - "state": "A String", # The state of the finding. + "state": "A String", }, ], - "nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no more results. - "readTime": "A String", # Time used for executing the list request. - "totalSize": 42, # The total number of findings matching the query. + "nextPageToken": "A String", + "readTime": "A String", + "totalSize": 42, }
@@ -283,34 +283,34 @@

Method Details

patch(name, body=None, updateMask=None, x__xgafv=None) -
Creates or updates a finding. The corresponding source must exist for a finding creation to succeed.
+  
 
 Args:
-  name: string, The relative resource name of this finding. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Example: "organizations/{organization_id}/sources/{source_id}/findings/{finding_id}" (required)
+  name: string, A parameter (required)
   body: object, The request body.
     The object takes the form of:
 
-{ # Security Command Center finding. A finding is a record of assessment data (security, risk, health or privacy) ingested into Security Command Center for presentation, notification, analysis, policy testing, and enforcement. For example, an XSS vulnerability in an App Engine application is a finding.
-  "category": "A String", # The additional taxonomy group within findings from a given source. This field is immutable after creation time. Example: "XSS_FLASH_INJECTION"
-  "createTime": "A String", # The time at which the finding was created in Security Command Center.
-  "eventTime": "A String", # The time at which the event took place, or when an update to the finding occurred. For example, if the finding represents an open firewall it would capture the time the detector believes the firewall became open. The accuracy is determined by the detector. If the finding were to be resolved afterward, this time would reflect when the finding was resolved.
-  "externalUri": "A String", # The URI that, if available, points to a web page outside of Security Command Center where additional information about the finding can be found. This field is guaranteed to be either empty or a well formed URL.
-  "name": "A String", # The relative resource name of this finding. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Example: "organizations/{organization_id}/sources/{source_id}/findings/{finding_id}"
-  "parent": "A String", # Immutable. The relative resource name of the source the finding belongs to. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name This field is immutable after creation time. For example: "organizations/{organization_id}/sources/{source_id}"
-  "resourceName": "A String", # For findings on Google Cloud resources, the full resource name of the Google Cloud resource this finding is for. See: https://cloud.google.com/apis/design/resource_names#full_resource_name When the finding is for a non-Google Cloud resource, the resourceName can be a customer or partner defined string. This field is immutable after creation time.
-  "securityMarks": { # User specified security marks that are attached to the parent Security Command Center resource. Security marks are scoped within a Security Command Center organization -- they can be modified and viewed by all users who have proper permissions on the organization. # Output only. User specified security marks. These marks are entirely managed by the user and come from the SecurityMarks resource that belongs to the finding.
-    "marks": { # Mutable user specified security marks belonging to the parent resource. Constraints are as follows: * Keys and values are treated as case insensitive * Keys must be between 1 - 256 characters (inclusive) * Keys must be letters, numbers, underscores, or dashes * Values have leading and trailing whitespace trimmed, remaining characters must be between 1 - 4096 characters (inclusive)
+{
+  "category": "A String",
+  "createTime": "A String",
+  "eventTime": "A String",
+  "externalUri": "A String",
+  "name": "A String",
+  "parent": "A String",
+  "resourceName": "A String",
+  "securityMarks": {
+    "marks": {
       "a_key": "A String",
     },
-    "name": "A String", # The relative resource name of the SecurityMarks. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Examples: "organizations/{organization_id}/assets/{asset_id}/securityMarks" "organizations/{organization_id}/sources/{source_id}/findings/{finding_id}/securityMarks".
+    "name": "A String",
   },
-  "sourceProperties": { # Source specific properties. These properties are managed by the source that writes the finding. The key names in the source_properties map must be between 1 and 255 characters, and must start with a letter and contain alphanumeric characters or underscores only.
+  "sourceProperties": {
     "a_key": "",
   },
-  "state": "A String", # The state of the finding.
+  "state": "A String",
 }
 
-  updateMask: string, The FieldMask to use when updating the finding resource. This field should not be specified when creating a finding.
+  updateMask: string, A parameter
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -319,39 +319,39 @@ 

Method Details

Returns: An object of the form: - { # Security Command Center finding. A finding is a record of assessment data (security, risk, health or privacy) ingested into Security Command Center for presentation, notification, analysis, policy testing, and enforcement. For example, an XSS vulnerability in an App Engine application is a finding. - "category": "A String", # The additional taxonomy group within findings from a given source. This field is immutable after creation time. Example: "XSS_FLASH_INJECTION" - "createTime": "A String", # The time at which the finding was created in Security Command Center. - "eventTime": "A String", # The time at which the event took place, or when an update to the finding occurred. For example, if the finding represents an open firewall it would capture the time the detector believes the firewall became open. The accuracy is determined by the detector. If the finding were to be resolved afterward, this time would reflect when the finding was resolved. - "externalUri": "A String", # The URI that, if available, points to a web page outside of Security Command Center where additional information about the finding can be found. This field is guaranteed to be either empty or a well formed URL. - "name": "A String", # The relative resource name of this finding. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Example: "organizations/{organization_id}/sources/{source_id}/findings/{finding_id}" - "parent": "A String", # Immutable. The relative resource name of the source the finding belongs to. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name This field is immutable after creation time. For example: "organizations/{organization_id}/sources/{source_id}" - "resourceName": "A String", # For findings on Google Cloud resources, the full resource name of the Google Cloud resource this finding is for. See: https://cloud.google.com/apis/design/resource_names#full_resource_name When the finding is for a non-Google Cloud resource, the resourceName can be a customer or partner defined string. This field is immutable after creation time. - "securityMarks": { # User specified security marks that are attached to the parent Security Command Center resource. Security marks are scoped within a Security Command Center organization -- they can be modified and viewed by all users who have proper permissions on the organization. # Output only. User specified security marks. These marks are entirely managed by the user and come from the SecurityMarks resource that belongs to the finding. - "marks": { # Mutable user specified security marks belonging to the parent resource. Constraints are as follows: * Keys and values are treated as case insensitive * Keys must be between 1 - 256 characters (inclusive) * Keys must be letters, numbers, underscores, or dashes * Values have leading and trailing whitespace trimmed, remaining characters must be between 1 - 4096 characters (inclusive) + { + "category": "A String", + "createTime": "A String", + "eventTime": "A String", + "externalUri": "A String", + "name": "A String", + "parent": "A String", + "resourceName": "A String", + "securityMarks": { + "marks": { "a_key": "A String", }, - "name": "A String", # The relative resource name of the SecurityMarks. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Examples: "organizations/{organization_id}/assets/{asset_id}/securityMarks" "organizations/{organization_id}/sources/{source_id}/findings/{finding_id}/securityMarks". + "name": "A String", }, - "sourceProperties": { # Source specific properties. These properties are managed by the source that writes the finding. The key names in the source_properties map must be between 1 and 255 characters, and must start with a letter and contain alphanumeric characters or underscores only. + "sourceProperties": { "a_key": "", }, - "state": "A String", # The state of the finding. + "state": "A String", }
setState(name, body=None, x__xgafv=None) -
Updates the state of a finding.
+  
 
 Args:
-  name: string, Required. The relative resource name of the finding. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Example: "organizations/{organization_id}/sources/{source_id}/finding/{finding_id}". (required)
+  name: string, A parameter (required)
   body: object, The request body.
     The object takes the form of:
 
-{ # Request message for updating a finding's state.
-  "startTime": "A String", # Optional. The time at which the updated state takes effect. If not set uses the current time.
-  "state": "A String", # Required. The desired State of the finding.
+{
+  "startTime": "A String",
+  "state": "A String",
 }
 
   x__xgafv: string, V1 error format.
@@ -362,45 +362,45 @@ 

Method Details

Returns: An object of the form: - { # Security Command Center finding. A finding is a record of assessment data (security, risk, health or privacy) ingested into Security Command Center for presentation, notification, analysis, policy testing, and enforcement. For example, an XSS vulnerability in an App Engine application is a finding. - "category": "A String", # The additional taxonomy group within findings from a given source. This field is immutable after creation time. Example: "XSS_FLASH_INJECTION" - "createTime": "A String", # The time at which the finding was created in Security Command Center. - "eventTime": "A String", # The time at which the event took place, or when an update to the finding occurred. For example, if the finding represents an open firewall it would capture the time the detector believes the firewall became open. The accuracy is determined by the detector. If the finding were to be resolved afterward, this time would reflect when the finding was resolved. - "externalUri": "A String", # The URI that, if available, points to a web page outside of Security Command Center where additional information about the finding can be found. This field is guaranteed to be either empty or a well formed URL. - "name": "A String", # The relative resource name of this finding. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Example: "organizations/{organization_id}/sources/{source_id}/findings/{finding_id}" - "parent": "A String", # Immutable. The relative resource name of the source the finding belongs to. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name This field is immutable after creation time. For example: "organizations/{organization_id}/sources/{source_id}" - "resourceName": "A String", # For findings on Google Cloud resources, the full resource name of the Google Cloud resource this finding is for. See: https://cloud.google.com/apis/design/resource_names#full_resource_name When the finding is for a non-Google Cloud resource, the resourceName can be a customer or partner defined string. This field is immutable after creation time. - "securityMarks": { # User specified security marks that are attached to the parent Security Command Center resource. Security marks are scoped within a Security Command Center organization -- they can be modified and viewed by all users who have proper permissions on the organization. # Output only. User specified security marks. These marks are entirely managed by the user and come from the SecurityMarks resource that belongs to the finding. - "marks": { # Mutable user specified security marks belonging to the parent resource. Constraints are as follows: * Keys and values are treated as case insensitive * Keys must be between 1 - 256 characters (inclusive) * Keys must be letters, numbers, underscores, or dashes * Values have leading and trailing whitespace trimmed, remaining characters must be between 1 - 4096 characters (inclusive) + { + "category": "A String", + "createTime": "A String", + "eventTime": "A String", + "externalUri": "A String", + "name": "A String", + "parent": "A String", + "resourceName": "A String", + "securityMarks": { + "marks": { "a_key": "A String", }, - "name": "A String", # The relative resource name of the SecurityMarks. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Examples: "organizations/{organization_id}/assets/{asset_id}/securityMarks" "organizations/{organization_id}/sources/{source_id}/findings/{finding_id}/securityMarks". + "name": "A String", }, - "sourceProperties": { # Source specific properties. These properties are managed by the source that writes the finding. The key names in the source_properties map must be between 1 and 255 characters, and must start with a letter and contain alphanumeric characters or underscores only. + "sourceProperties": { "a_key": "", }, - "state": "A String", # The state of the finding. + "state": "A String", }
updateSecurityMarks(name, body=None, startTime=None, updateMask=None, x__xgafv=None) -
Updates security marks.
+  
 
 Args:
-  name: string, The relative resource name of the SecurityMarks. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Examples: "organizations/{organization_id}/assets/{asset_id}/securityMarks" "organizations/{organization_id}/sources/{source_id}/findings/{finding_id}/securityMarks". (required)
+  name: string, A parameter (required)
   body: object, The request body.
     The object takes the form of:
 
-{ # User specified security marks that are attached to the parent Security Command Center resource. Security marks are scoped within a Security Command Center organization -- they can be modified and viewed by all users who have proper permissions on the organization.
-  "marks": { # Mutable user specified security marks belonging to the parent resource. Constraints are as follows: * Keys and values are treated as case insensitive * Keys must be between 1 - 256 characters (inclusive) * Keys must be letters, numbers, underscores, or dashes * Values have leading and trailing whitespace trimmed, remaining characters must be between 1 - 4096 characters (inclusive)
+{
+  "marks": {
     "a_key": "A String",
   },
-  "name": "A String", # The relative resource name of the SecurityMarks. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Examples: "organizations/{organization_id}/assets/{asset_id}/securityMarks" "organizations/{organization_id}/sources/{source_id}/findings/{finding_id}/securityMarks".
+  "name": "A String",
 }
 
-  startTime: string, The time at which the updated SecurityMarks take effect.
-  updateMask: string, The FieldMask to use when updating the security marks resource.
+  startTime: string, A parameter
+  updateMask: string, A parameter
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -409,11 +409,11 @@ 

Method Details

Returns: An object of the form: - { # User specified security marks that are attached to the parent Security Command Center resource. Security marks are scoped within a Security Command Center organization -- they can be modified and viewed by all users who have proper permissions on the organization. - "marks": { # Mutable user specified security marks belonging to the parent resource. Constraints are as follows: * Keys and values are treated as case insensitive * Keys must be between 1 - 256 characters (inclusive) * Keys must be letters, numbers, underscores, or dashes * Values have leading and trailing whitespace trimmed, remaining characters must be between 1 - 4096 characters (inclusive) + { + "marks": { "a_key": "A String", }, - "name": "A String", # The relative resource name of the SecurityMarks. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Examples: "organizations/{organization_id}/assets/{asset_id}/securityMarks" "organizations/{organization_id}/sources/{source_id}/findings/{finding_id}/securityMarks". + "name": "A String", }
diff --git a/docs/dyn/securitycenter_v1beta1.organizations.sources.html b/docs/dyn/securitycenter_v1beta1.organizations.sources.html index b350274c15..488e1f0a1f 100644 --- a/docs/dyn/securitycenter_v1beta1.organizations.sources.html +++ b/docs/dyn/securitycenter_v1beta1.organizations.sources.html @@ -84,28 +84,28 @@

Instance Methods

Close httplib2 connections.

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

-

Creates a source.

+

get(name, x__xgafv=None)

-

Gets a source.

+

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

-

Gets the access control policy on the specified Source.

+

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

-

Lists all sources belonging to an organization.

+

list_next()

Retrieves the next page of results.

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

-

Updates a source.

+

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

-

Sets the access control policy on the specified Source.

+

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

-

Returns the permissions that a caller has on the specified source.

+

Method Details

close() @@ -114,17 +114,17 @@

Method Details

create(parent, body=None, x__xgafv=None) -
Creates a source.
+  
 
 Args:
-  parent: string, Required. Resource name of the new source's parent. Its format should be "organizations/[organization_id]". (required)
+  parent: string, A parameter (required)
   body: object, The request body.
     The object takes the form of:
 
-{ # Security Command Center finding source. A finding source is an entity or a mechanism that can produce a finding. A source is like a container of findings that come from the same scanner, logger, monitor, etc.
-  "description": "A String", # The description of the source (max of 1024 characters). Example: "Web Security Scanner is a web security scanner for common vulnerabilities in App Engine applications. It can automatically scan and detect four common vulnerabilities, including cross-site-scripting (XSS), Flash injection, mixed content (HTTP in HTTPS), and outdated/insecure libraries."
-  "displayName": "A String", # The source's display name. A source's display name must be unique amongst its siblings, for example, two sources with the same parent can't share the same display name. The display name must have a length between 1 and 64 characters (inclusive).
-  "name": "A String", # The relative resource name of this source. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Example: "organizations/{organization_id}/sources/{source_id}"
+{
+  "description": "A String",
+  "displayName": "A String",
+  "name": "A String",
 }
 
   x__xgafv: string, V1 error format.
@@ -135,19 +135,19 @@ 

Method Details

Returns: An object of the form: - { # Security Command Center finding source. A finding source is an entity or a mechanism that can produce a finding. A source is like a container of findings that come from the same scanner, logger, monitor, etc. - "description": "A String", # The description of the source (max of 1024 characters). Example: "Web Security Scanner is a web security scanner for common vulnerabilities in App Engine applications. It can automatically scan and detect four common vulnerabilities, including cross-site-scripting (XSS), Flash injection, mixed content (HTTP in HTTPS), and outdated/insecure libraries." - "displayName": "A String", # The source's display name. A source's display name must be unique amongst its siblings, for example, two sources with the same parent can't share the same display name. The display name must have a length between 1 and 64 characters (inclusive). - "name": "A String", # The relative resource name of this source. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Example: "organizations/{organization_id}/sources/{source_id}" + { + "description": "A String", + "displayName": "A String", + "name": "A String", }
get(name, x__xgafv=None) -
Gets a source.
+  
 
 Args:
-  name: string, Required. Relative resource name of the source. Its format is "organizations/[organization_id]/source/[source_id]". (required)
+  name: string, A parameter (required)
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -156,25 +156,25 @@ 

Method Details

Returns: An object of the form: - { # Security Command Center finding source. A finding source is an entity or a mechanism that can produce a finding. A source is like a container of findings that come from the same scanner, logger, monitor, etc. - "description": "A String", # The description of the source (max of 1024 characters). Example: "Web Security Scanner is a web security scanner for common vulnerabilities in App Engine applications. It can automatically scan and detect four common vulnerabilities, including cross-site-scripting (XSS), Flash injection, mixed content (HTTP in HTTPS), and outdated/insecure libraries." - "displayName": "A String", # The source's display name. A source's display name must be unique amongst its siblings, for example, two sources with the same parent can't share the same display name. The display name must have a length between 1 and 64 characters (inclusive). - "name": "A String", # The relative resource name of this source. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Example: "organizations/{organization_id}/sources/{source_id}" + { + "description": "A String", + "displayName": "A String", + "name": "A String", }
getIamPolicy(resource, body=None, x__xgafv=None) -
Gets the access control policy on the specified Source.
+  
 
 Args:
-  resource: string, REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. (required)
+  resource: string, A parameter (required)
   body: object, The request body.
     The object takes the form of:
 
-{ # Request message for `GetIamPolicy` method.
-  "options": { # Encapsulates settings provided to GetIamPolicy. # OPTIONAL: A `GetPolicyOptions` object for specifying options to `GetIamPolicy`.
-    "requestedPolicyVersion": 42, # Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+{
+  "options": {
+    "requestedPolicyVersion": 42,
   },
 }
 
@@ -186,47 +186,47 @@ 

Method Details

Returns: An object of the form: - { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). - "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. - { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. - "auditLogConfigs": [ # The configuration for logging of each type of permission. - { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. - "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. + { + "auditConfigs": [ + { + "auditLogConfigs": [ + { + "exemptedMembers": [ "A String", ], - "logType": "A String", # The log type that this config enables. + "logType": "A String", }, ], - "service": "A String", # Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services. + "service": "A String", }, ], - "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. - { # Associates `members`, or principals, with a `role`. - "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). - "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. - "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. - "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file. - "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. + "bindings": [ + { + "condition": { + "description": "A String", + "expression": "A String", + "location": "A String", + "title": "A String", }, - "members": [ # Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`. + "members": [ "A String", ], - "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles). + "role": "A String", }, ], - "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). + "etag": "A String", + "version": 42, }
list(parent, pageSize=None, pageToken=None, x__xgafv=None) -
Lists all sources belonging to an organization.
+  
 
 Args:
-  parent: string, Required. Resource name of the parent of sources to list. Its format should be "organizations/[organization_id]". (required)
-  pageSize: integer, The maximum number of results to return in a single response. Default is 10, minimum is 1, maximum is 1000.
-  pageToken: string, The value returned by the last `ListSourcesResponse`; indicates that this is a continuation of a prior `ListSources` call, and that the system should return the next page of data.
+  parent: string, A parameter (required)
+  pageSize: integer, A parameter
+  pageToken: string, A parameter
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -235,13 +235,13 @@ 

Method Details

Returns: An object of the form: - { # Response message for listing sources. - "nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no more results. - "sources": [ # Sources belonging to the requested parent. - { # Security Command Center finding source. A finding source is an entity or a mechanism that can produce a finding. A source is like a container of findings that come from the same scanner, logger, monitor, etc. - "description": "A String", # The description of the source (max of 1024 characters). Example: "Web Security Scanner is a web security scanner for common vulnerabilities in App Engine applications. It can automatically scan and detect four common vulnerabilities, including cross-site-scripting (XSS), Flash injection, mixed content (HTTP in HTTPS), and outdated/insecure libraries." - "displayName": "A String", # The source's display name. A source's display name must be unique amongst its siblings, for example, two sources with the same parent can't share the same display name. The display name must have a length between 1 and 64 characters (inclusive). - "name": "A String", # The relative resource name of this source. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Example: "organizations/{organization_id}/sources/{source_id}" + { + "nextPageToken": "A String", + "sources": [ + { + "description": "A String", + "displayName": "A String", + "name": "A String", }, ], }
@@ -263,20 +263,20 @@

Method Details

patch(name, body=None, updateMask=None, x__xgafv=None) -
Updates a source.
+  
 
 Args:
-  name: string, The relative resource name of this source. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Example: "organizations/{organization_id}/sources/{source_id}" (required)
+  name: string, A parameter (required)
   body: object, The request body.
     The object takes the form of:
 
-{ # Security Command Center finding source. A finding source is an entity or a mechanism that can produce a finding. A source is like a container of findings that come from the same scanner, logger, monitor, etc.
-  "description": "A String", # The description of the source (max of 1024 characters). Example: "Web Security Scanner is a web security scanner for common vulnerabilities in App Engine applications. It can automatically scan and detect four common vulnerabilities, including cross-site-scripting (XSS), Flash injection, mixed content (HTTP in HTTPS), and outdated/insecure libraries."
-  "displayName": "A String", # The source's display name. A source's display name must be unique amongst its siblings, for example, two sources with the same parent can't share the same display name. The display name must have a length between 1 and 64 characters (inclusive).
-  "name": "A String", # The relative resource name of this source. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Example: "organizations/{organization_id}/sources/{source_id}"
+{
+  "description": "A String",
+  "displayName": "A String",
+  "name": "A String",
 }
 
-  updateMask: string, The FieldMask to use when updating the source resource.
+  updateMask: string, A parameter
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -285,55 +285,55 @@ 

Method Details

Returns: An object of the form: - { # Security Command Center finding source. A finding source is an entity or a mechanism that can produce a finding. A source is like a container of findings that come from the same scanner, logger, monitor, etc. - "description": "A String", # The description of the source (max of 1024 characters). Example: "Web Security Scanner is a web security scanner for common vulnerabilities in App Engine applications. It can automatically scan and detect four common vulnerabilities, including cross-site-scripting (XSS), Flash injection, mixed content (HTTP in HTTPS), and outdated/insecure libraries." - "displayName": "A String", # The source's display name. A source's display name must be unique amongst its siblings, for example, two sources with the same parent can't share the same display name. The display name must have a length between 1 and 64 characters (inclusive). - "name": "A String", # The relative resource name of this source. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Example: "organizations/{organization_id}/sources/{source_id}" + { + "description": "A String", + "displayName": "A String", + "name": "A String", }
setIamPolicy(resource, body=None, x__xgafv=None) -
Sets the access control policy on the specified Source.
+  
 
 Args:
-  resource: string, REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. (required)
+  resource: string, A parameter (required)
   body: object, The request body.
     The object takes the form of:
 
-{ # Request message for `SetIamPolicy` method.
-  "policy": { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). # REQUIRED: The complete policy to be applied to the `resource`. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Google Cloud services (such as Projects) might reject them.
-    "auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
-      { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging.
-        "auditLogConfigs": [ # The configuration for logging of each type of permission.
-          { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.
-            "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.
+{
+  "policy": {
+    "auditConfigs": [
+      {
+        "auditLogConfigs": [
+          {
+            "exemptedMembers": [
               "A String",
             ],
-            "logType": "A String", # The log type that this config enables.
+            "logType": "A String",
           },
         ],
-        "service": "A String", # Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services.
+        "service": "A String",
       },
     ],
-    "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`.
-      { # Associates `members`, or principals, with a `role`.
-        "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
-          "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
-          "expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
-          "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
-          "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
+    "bindings": [
+      {
+        "condition": {
+          "description": "A String",
+          "expression": "A String",
+          "location": "A String",
+          "title": "A String",
         },
-        "members": [ # Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
+        "members": [
           "A String",
         ],
-        "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles).
+        "role": "A String",
       },
     ],
-    "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).
+    "etag": "A String",
+    "version": 42,
   },
-  "updateMask": "A String", # OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only the fields in the mask will be modified. If no mask is provided, the following default mask is used: `paths: "bindings, etag"`
+  "updateMask": "A String",
 }
 
   x__xgafv: string, V1 error format.
@@ -344,50 +344,50 @@ 

Method Details

Returns: An object of the form: - { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). - "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. - { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. - "auditLogConfigs": [ # The configuration for logging of each type of permission. - { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. - "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. + { + "auditConfigs": [ + { + "auditLogConfigs": [ + { + "exemptedMembers": [ "A String", ], - "logType": "A String", # The log type that this config enables. + "logType": "A String", }, ], - "service": "A String", # Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services. + "service": "A String", }, ], - "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. - { # Associates `members`, or principals, with a `role`. - "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). - "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. - "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. - "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file. - "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. + "bindings": [ + { + "condition": { + "description": "A String", + "expression": "A String", + "location": "A String", + "title": "A String", }, - "members": [ # Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`. + "members": [ "A String", ], - "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles). + "role": "A String", }, ], - "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). + "etag": "A String", + "version": 42, }
testIamPermissions(resource, body=None, x__xgafv=None) -
 Returns the permissions that a caller has on the specified source.
+  
 
 Args:
-  resource: string, REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. (required)
+  resource: string, A parameter (required)
   body: object, The request body.
     The object takes the form of:
 
-{ # Request message for `TestIamPermissions` method.
-  "permissions": [ # The set of permissions to check for the `resource`. Permissions with wildcards (such as `*` or `storage.*`) are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).
+{
+  "permissions": [
     "A String",
   ],
 }
@@ -400,8 +400,8 @@ 

Method Details

Returns: An object of the form: - { # Response message for `TestIamPermissions` method. - "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed. + { + "permissions": [ "A String", ], }
diff --git a/docs/dyn/securitycenter_v1beta2.folders.containerThreatDetectionSettings.html b/docs/dyn/securitycenter_v1beta2.folders.containerThreatDetectionSettings.html index d33386e02d..576cea4ef9 100644 --- a/docs/dyn/securitycenter_v1beta2.folders.containerThreatDetectionSettings.html +++ b/docs/dyn/securitycenter_v1beta2.folders.containerThreatDetectionSettings.html @@ -76,18 +76,18 @@

Security Command Center API . Instance Methods

calculate(name, showEligibleModulesOnly=None, x__xgafv=None)

-

Calculates the effective ContainerThreatDetectionSettings based on its level in the resource hierarchy and its settings. Settings provided closer to the target resource take precedence over those further away (e.g. folder will override organization level settings). The default SCC setting for the detector service defaults can be overridden at organization, folder and project levels. No assumptions should be made about the SCC defaults as it is considered an internal implementation detail.

+

close()

Close httplib2 connections.

Method Details

calculate(name, showEligibleModulesOnly=None, x__xgafv=None) -
Calculates the effective ContainerThreatDetectionSettings based on its level in the resource hierarchy and its settings. Settings provided closer to the target resource take precedence over those further away (e.g. folder will override organization level settings). The default SCC setting for the detector service defaults can be overridden at organization, folder and project levels. No assumptions should be made about the SCC defaults as it is considered an internal implementation detail.
+  
 
 Args:
-  name: string, Required. The name of the ContainerThreatDetectionSettings to calculate. Formats: * organizations/{organization}/containerThreatDetectionSettings * folders/{folder}/containerThreatDetectionSettings * projects/{project}/containerThreatDetectionSettings * projects/{project}/locations/{location}/clusters/{cluster}/containerThreatDetectionSettings (required)
-  showEligibleModulesOnly: boolean, Optional. When set, will only retrieve the modules that are in scope. By default, all modules will be shown.
+  name: string, A parameter (required)
+  showEligibleModulesOnly: boolean, A parameter
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -96,19 +96,19 @@ 

Method Details

Returns: An object of the form: - { # Resource capturing the settings for the Container Threat Detection service. - "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's configuration. - "a_key": { # Configuration of a module. - "moduleEnablementState": "A String", # The state of enablement for the module at its level of the resource hierarchy. - "value": { # The configuration value for the module. The absence of this field implies its inheritance from the parent. + { + "modules": { + "a_key": { + "moduleEnablementState": "A String", + "value": { "a_key": "", # Properties of the object. }, }, }, - "name": "A String", # Identifier. The resource name of the ContainerThreatDetectionSettings. Formats: * organizations/{organization}/containerThreatDetectionSettings * folders/{folder}/containerThreatDetectionSettings * projects/{project}/containerThreatDetectionSettings * projects/{project}/locations/{location}/clusters/{cluster}/containerThreatDetectionSettings - "serviceAccount": "A String", # Output only. The service account used by Container Threat Detection for scanning. Service accounts are scoped at the project level meaning this field will be empty at any level above a project. - "serviceEnablementState": "A String", # The state of enablement for the service at its level of the resource hierarchy. A DISABLED state will override all module enablement_states to DISABLED. - "updateTime": "A String", # Output only. The time the settings were last updated. + "name": "A String", + "serviceAccount": "A String", + "serviceEnablementState": "A String", + "updateTime": "A String", }
diff --git a/docs/dyn/securitycenter_v1beta2.folders.eventThreatDetectionSettings.html b/docs/dyn/securitycenter_v1beta2.folders.eventThreatDetectionSettings.html index ff96693fe7..b3eefd7f8a 100644 --- a/docs/dyn/securitycenter_v1beta2.folders.eventThreatDetectionSettings.html +++ b/docs/dyn/securitycenter_v1beta2.folders.eventThreatDetectionSettings.html @@ -76,18 +76,18 @@

Security Command Center API . Instance Methods

calculate(name, showEligibleModulesOnly=None, x__xgafv=None)

-

Calculates the effective EventThreatDetectionSettings based on its level in the resource hierarchy and its settings. Settings provided closer to the target resource take precedence over those further away (e.g. folder will override organization level settings). The default SCC setting for the detector service defaults can be overridden at organization, folder and project levels. No assumptions should be made about the SCC defaults as it is considered an internal implementation detail.

+

close()

Close httplib2 connections.

Method Details

calculate(name, showEligibleModulesOnly=None, x__xgafv=None) -
Calculates the effective EventThreatDetectionSettings based on its level in the resource hierarchy and its settings. Settings provided closer to the target resource take precedence over those further away (e.g. folder will override organization level settings). The default SCC setting for the detector service defaults can be overridden at organization, folder and project levels. No assumptions should be made about the SCC defaults as it is considered an internal implementation detail.
+  
 
 Args:
-  name: string, Required. The name of the EventThreatDetectionSettings to calculate. Formats: * organizations/{organization}/eventThreatDetectionSettings * folders/{folder}/eventThreatDetectionSettings * projects/{project}/eventThreatDetectionSettings (required)
-  showEligibleModulesOnly: boolean, Optional. When set, will only retrieve the modules that are in scope. By default, all modules will be shown.
+  name: string, A parameter (required)
+  showEligibleModulesOnly: boolean, A parameter
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -96,18 +96,18 @@ 

Method Details

Returns: An object of the form: - { # Resource capturing the settings for the Event Threat Detection service. - "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's configuration. - "a_key": { # Configuration of a module. - "moduleEnablementState": "A String", # The state of enablement for the module at its level of the resource hierarchy. - "value": { # The configuration value for the module. The absence of this field implies its inheritance from the parent. + { + "modules": { + "a_key": { + "moduleEnablementState": "A String", + "value": { "a_key": "", # Properties of the object. }, }, }, - "name": "A String", # Identifier. The resource name of the EventThreatDetectionSettings. Formats: * organizations/{organization}/eventThreatDetectionSettings * folders/{folder}/eventThreatDetectionSettings * projects/{project}/eventThreatDetectionSettings - "serviceEnablementState": "A String", # The state of enablement for the service at its level of the resource hierarchy. A DISABLED state will override all module enablement_states to DISABLED. - "updateTime": "A String", # Output only. The time the settings were last updated. + "name": "A String", + "serviceEnablementState": "A String", + "updateTime": "A String", }
diff --git a/docs/dyn/securitycenter_v1beta2.folders.html b/docs/dyn/securitycenter_v1beta2.folders.html index 4fb1b55c6e..07eab8d45c 100644 --- a/docs/dyn/securitycenter_v1beta2.folders.html +++ b/docs/dyn/securitycenter_v1beta2.folders.html @@ -109,43 +109,43 @@

Instance Methods

Close httplib2 connections.

getContainerThreatDetectionSettings(name, x__xgafv=None)

-

Get the ContainerThreatDetectionSettings resource. In the returned settings response, a missing field only indicates that it was not explicitly set, so no assumption should be made about these fields. In other words, GetContainerThreatDetectionSettings does not calculate the effective service settings for the resource, which accounts for inherited settings and defaults. Instead, use CalculateContainerThreatDetectionSettings for this purpose.

+

getEventThreatDetectionSettings(name, x__xgafv=None)

-

Get the EventThreatDetectionSettings resource. In the returned settings response, a missing field only indicates that it was not explicitly set, so no assumption should be made about these fields. In other words, GetEventThreatDetectionSettings does not calculate the effective service settings for the resource, which accounts for inherited settings and defaults. Instead, use CalculateEventThreatDetectionSettings for this purpose.

+

getRapidVulnerabilityDetectionSettings(name, x__xgafv=None)

-

Get the RapidVulnerabilityDetectionSettings resource. In the returned settings response, a missing field only indicates that it was not explicitly set, so no assumption should be made about these fields. In other words, GetRapidVulnerabilityDetectionSettings does not calculate the effective service settings for the resource, which accounts for inherited settings and defaults. Instead, use CalculateRapidVulnerabilityDetectionSettings for this purpose.

+

getSecurityCenterSettings(name, x__xgafv=None)

-

Get the SecurityCenterSettings resource.

+

getSecurityHealthAnalyticsSettings(name, x__xgafv=None)

-

Get the SecurityHealthAnalyticsSettings resource. In the returned settings response, a missing field only indicates that it was not explicitly set, so no assumption should be made about these fields. In other words, GetSecurityHealthAnalyticsSettings does not calculate the effective service settings for the resource, which accounts for inherited settings and defaults. Instead, use CalculateSecurityHealthAnalyticsSettings for this purpose.

+

getVirtualMachineThreatDetectionSettings(name, x__xgafv=None)

-

Get the VirtualMachineThreatDetectionSettings resource. In the returned settings response, a missing field only indicates that it was not explicitly set, so no assumption should be made about these fields. In other words, GetVirtualMachineThreatDetectionSettings does not calculate the effective service settings for the resource, which accounts for inherited settings and defaults. Instead, use CalculateVirtualMachineThreatDetectionSettings for this purpose.

+

getWebSecurityScannerSettings(name, x__xgafv=None)

-

Get the WebSecurityScannerSettings resource. In the returned settings response, a missing field only indicates that it was not explicitly set, so no assumption should be made about these fields. In other words, GetWebSecurityScannerSettings does not calculate the effective service settings for the resource, which accounts for inherited settings and defaults. Instead, use CalculateWebSecurityScannerSettings for this purpose.

+

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

-

Update the ContainerThreatDetectionSettings resource.

+

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

-

Update the EventThreatDetectionSettings resource.

+

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

-

Update the RapidVulnerabilityDetectionSettings resource.

+

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

-

Update the SecurityHealthAnalyticsSettings resource.

+

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

-

Update the VirtualMachineThreatDetectionSettings resource.

+

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

-

Update the WebSecurityScannerSettings resource.

+

Method Details

close() @@ -154,10 +154,10 @@

Method Details

getContainerThreatDetectionSettings(name, x__xgafv=None) -
Get the ContainerThreatDetectionSettings resource. In the returned settings response, a missing field only indicates that it was not explicitly set, so no assumption should be made about these fields. In other words, GetContainerThreatDetectionSettings does not calculate the effective service settings for the resource, which accounts for inherited settings and defaults. Instead, use CalculateContainerThreatDetectionSettings for this purpose.
+  
 
 Args:
-  name: string, Required. The name of the ContainerThreatDetectionSettings to retrieve. Formats: * organizations/{organization}/containerThreatDetectionSettings * folders/{folder}/containerThreatDetectionSettings * projects/{project}/containerThreatDetectionSettings * projects/{project}/locations/{location}/clusters/{cluster}/containerThreatDetectionSettings (required)
+  name: string, A parameter (required)
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -166,28 +166,28 @@ 

Method Details

Returns: An object of the form: - { # Resource capturing the settings for the Container Threat Detection service. - "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's configuration. - "a_key": { # Configuration of a module. - "moduleEnablementState": "A String", # The state of enablement for the module at its level of the resource hierarchy. - "value": { # The configuration value for the module. The absence of this field implies its inheritance from the parent. + { + "modules": { + "a_key": { + "moduleEnablementState": "A String", + "value": { "a_key": "", # Properties of the object. }, }, }, - "name": "A String", # Identifier. The resource name of the ContainerThreatDetectionSettings. Formats: * organizations/{organization}/containerThreatDetectionSettings * folders/{folder}/containerThreatDetectionSettings * projects/{project}/containerThreatDetectionSettings * projects/{project}/locations/{location}/clusters/{cluster}/containerThreatDetectionSettings - "serviceAccount": "A String", # Output only. The service account used by Container Threat Detection for scanning. Service accounts are scoped at the project level meaning this field will be empty at any level above a project. - "serviceEnablementState": "A String", # The state of enablement for the service at its level of the resource hierarchy. A DISABLED state will override all module enablement_states to DISABLED. - "updateTime": "A String", # Output only. The time the settings were last updated. + "name": "A String", + "serviceAccount": "A String", + "serviceEnablementState": "A String", + "updateTime": "A String", }
getEventThreatDetectionSettings(name, x__xgafv=None) -
Get the EventThreatDetectionSettings resource. In the returned settings response, a missing field only indicates that it was not explicitly set, so no assumption should be made about these fields. In other words, GetEventThreatDetectionSettings does not calculate the effective service settings for the resource, which accounts for inherited settings and defaults. Instead, use CalculateEventThreatDetectionSettings for this purpose.
+  
 
 Args:
-  name: string, Required. The name of the EventThreatDetectionSettings to retrieve. Formats: * organizations/{organization}/eventThreatDetectionSettings * folders/{folder}/eventThreatDetectionSettings * projects/{project}/eventThreatDetectionSettings (required)
+  name: string, A parameter (required)
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -196,27 +196,27 @@ 

Method Details

Returns: An object of the form: - { # Resource capturing the settings for the Event Threat Detection service. - "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's configuration. - "a_key": { # Configuration of a module. - "moduleEnablementState": "A String", # The state of enablement for the module at its level of the resource hierarchy. - "value": { # The configuration value for the module. The absence of this field implies its inheritance from the parent. + { + "modules": { + "a_key": { + "moduleEnablementState": "A String", + "value": { "a_key": "", # Properties of the object. }, }, }, - "name": "A String", # Identifier. The resource name of the EventThreatDetectionSettings. Formats: * organizations/{organization}/eventThreatDetectionSettings * folders/{folder}/eventThreatDetectionSettings * projects/{project}/eventThreatDetectionSettings - "serviceEnablementState": "A String", # The state of enablement for the service at its level of the resource hierarchy. A DISABLED state will override all module enablement_states to DISABLED. - "updateTime": "A String", # Output only. The time the settings were last updated. + "name": "A String", + "serviceEnablementState": "A String", + "updateTime": "A String", }
getRapidVulnerabilityDetectionSettings(name, x__xgafv=None) -
Get the RapidVulnerabilityDetectionSettings resource. In the returned settings response, a missing field only indicates that it was not explicitly set, so no assumption should be made about these fields. In other words, GetRapidVulnerabilityDetectionSettings does not calculate the effective service settings for the resource, which accounts for inherited settings and defaults. Instead, use CalculateRapidVulnerabilityDetectionSettings for this purpose.
+  
 
 Args:
-  name: string, Required. The name of the RapidVulnerabilityDetectionSettings to retrieve. Formats: * organizations/{organization}/rapidVulnerabilityDetectionSettings * folders/{folder}/rapidVulnerabilityDetectionSettings * projects/{project}/rapidVulnerabilityDetectionSettings (required)
+  name: string, A parameter (required)
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -225,27 +225,27 @@ 

Method Details

Returns: An object of the form: - { # Resource capturing the settings for the Rapid Vulnerability Detection service. - "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's. - "a_key": { # Configuration of a module. - "moduleEnablementState": "A String", # The state of enablement for the module at its level of the resource hierarchy. - "value": { # The configuration value for the module. The absence of this field implies its inheritance from the parent. + { + "modules": { + "a_key": { + "moduleEnablementState": "A String", + "value": { "a_key": "", # Properties of the object. }, }, }, - "name": "A String", # The resource name of the RapidVulnerabilityDetectionSettings. Formats: * organizations/{organization}/rapidVulnerabilityDetectionSettings * folders/{folder}/rapidVulnerabilityDetectionSettings * projects/{project}/rapidVulnerabilityDetectionSettings - "serviceEnablementState": "A String", # The state of enablement for the service at its level of the resource hierarchy. A DISABLED state will override all module enablement_states to DISABLED. - "updateTime": "A String", # Output only. The time the settings were last updated. + "name": "A String", + "serviceEnablementState": "A String", + "updateTime": "A String", }
getSecurityCenterSettings(name, x__xgafv=None) -
Get the SecurityCenterSettings resource.
+  
 
 Args:
-  name: string, Required. The name of the SecurityCenterSettings to retrieve. Format: organizations/{organization}/securityCenterSettings Format: folders/{folder}/securityCenterSettings Format: projects/{project}/securityCenterSettings (required)
+  name: string, A parameter (required)
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -254,21 +254,21 @@ 

Method Details

Returns: An object of the form: - { # Resource capturing the settings for Security Center. - "cryptoKeyName": "A String", # The KMS key name used for CMEK encryption. Format: projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{key_name} - "logSinkProject": "A String", # The resource name of the project to send logs to. This project must be part of the organization this resource resides in. The format is `projects/{project_id}`. An empty value disables logging. This value is only referenced by services that support log sink. Please refer to the documentation for an updated list of compatible services. This may only be specified for organization level onboarding. - "name": "A String", # The resource name of the SecurityCenterSettings. Format: organizations/{organization}/securityCenterSettings Format: folders/{folder}/securityCenterSettings Format: projects/{project}/securityCenterSettings - "onboardingTime": "A String", # Output only. Timestamp of when the customer organization was onboarded to SCC. - "orgServiceAccount": "A String", # Output only. The organization level service account to be used for security center components. + { + "cryptoKeyName": "A String", + "logSinkProject": "A String", + "name": "A String", + "onboardingTime": "A String", + "orgServiceAccount": "A String", }
getSecurityHealthAnalyticsSettings(name, x__xgafv=None) -
Get the SecurityHealthAnalyticsSettings resource. In the returned settings response, a missing field only indicates that it was not explicitly set, so no assumption should be made about these fields. In other words, GetSecurityHealthAnalyticsSettings does not calculate the effective service settings for the resource, which accounts for inherited settings and defaults. Instead, use CalculateSecurityHealthAnalyticsSettings for this purpose.
+  
 
 Args:
-  name: string, Required. The name of the SecurityHealthAnalyticsSettings to retrieve. Formats: * organizations/{organization}/securityHealthAnalyticsSettings * folders/{folder}/securityHealthAnalyticsSettings * projects/{project}/securityHealthAnalyticsSettings (required)
+  name: string, A parameter (required)
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -277,28 +277,28 @@ 

Method Details

Returns: An object of the form: - { # Resource capturing the settings for the Security Health Analytics service. - "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's configuration. - "a_key": { # Configuration of a module. - "moduleEnablementState": "A String", # The state of enablement for the module at its level of the resource hierarchy. - "value": { # The configuration value for the module. The absence of this field implies its inheritance from the parent. + { + "modules": { + "a_key": { + "moduleEnablementState": "A String", + "value": { "a_key": "", # Properties of the object. }, }, }, - "name": "A String", # Identifier. The resource name of the SecurityHealthAnalyticsSettings. Formats: * organizations/{organization}/securityHealthAnalyticsSettings * folders/{folder}/securityHealthAnalyticsSettings * projects/{project}/securityHealthAnalyticsSettings - "serviceAccount": "A String", # Output only. The service account used by Security Health Analytics detectors. - "serviceEnablementState": "A String", # The state of enablement for the service at its level of the resource hierarchy. A DISABLED state will override all module enablement_states to DISABLED. - "updateTime": "A String", # Output only. The time the settings were last updated. + "name": "A String", + "serviceAccount": "A String", + "serviceEnablementState": "A String", + "updateTime": "A String", }
getVirtualMachineThreatDetectionSettings(name, x__xgafv=None) -
Get the VirtualMachineThreatDetectionSettings resource. In the returned settings response, a missing field only indicates that it was not explicitly set, so no assumption should be made about these fields. In other words, GetVirtualMachineThreatDetectionSettings does not calculate the effective service settings for the resource, which accounts for inherited settings and defaults. Instead, use CalculateVirtualMachineThreatDetectionSettings for this purpose.
+  
 
 Args:
-  name: string, Required. The name of the VirtualMachineThreatDetectionSettings to retrieve. Formats: * organizations/{organization}/virtualMachineThreatDetectionSettings * folders/{folder}/virtualMachineThreatDetectionSettings * projects/{project}/virtualMachineThreatDetectionSettings (required)
+  name: string, A parameter (required)
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -307,28 +307,28 @@ 

Method Details

Returns: An object of the form: - { # Resource capturing the settings for the Virtual Machine Threat Detection service. - "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's configuration. - "a_key": { # Configuration of a module. - "moduleEnablementState": "A String", # The state of enablement for the module at its level of the resource hierarchy. - "value": { # The configuration value for the module. The absence of this field implies its inheritance from the parent. + { + "modules": { + "a_key": { + "moduleEnablementState": "A String", + "value": { "a_key": "", # Properties of the object. }, }, }, - "name": "A String", # Identifier. The resource name of the VirtualMachineThreatDetectionSettings. Formats: * organizations/{organization}/virtualMachineThreatDetectionSettings * folders/{folder}/virtualMachineThreatDetectionSettings * projects/{project}/virtualMachineThreatDetectionSettings - "serviceAccount": "A String", # Output only. The service account used by Virtual Machine Threat Detection detectors. - "serviceEnablementState": "A String", # The state of enablement for the service at its level of the resource hierarchy. A DISABLED state will override all module enablement_states to DISABLED. - "updateTime": "A String", # Output only. The time the settings were last updated. + "name": "A String", + "serviceAccount": "A String", + "serviceEnablementState": "A String", + "updateTime": "A String", }
getWebSecurityScannerSettings(name, x__xgafv=None) -
Get the WebSecurityScannerSettings resource. In the returned settings response, a missing field only indicates that it was not explicitly set, so no assumption should be made about these fields. In other words, GetWebSecurityScannerSettings does not calculate the effective service settings for the resource, which accounts for inherited settings and defaults. Instead, use CalculateWebSecurityScannerSettings for this purpose.
+  
 
 Args:
-  name: string, Required. The name of the WebSecurityScannerSettings to retrieve. Formats: * organizations/{organization}/webSecurityScannerSettings * folders/{folder}/webSecurityScannerSettings * projects/{project}/webSecurityScannerSettings (required)
+  name: string, A parameter (required)
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -337,46 +337,46 @@ 

Method Details

Returns: An object of the form: - { # Resource capturing the settings for the Web Security Scanner service. - "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's configuration. - "a_key": { # Configuration of a module. - "moduleEnablementState": "A String", # The state of enablement for the module at its level of the resource hierarchy. - "value": { # The configuration value for the module. The absence of this field implies its inheritance from the parent. + { + "modules": { + "a_key": { + "moduleEnablementState": "A String", + "value": { "a_key": "", # Properties of the object. }, }, }, - "name": "A String", # Identifier. The resource name of the WebSecurityScannerSettings. Formats: * organizations/{organization}/webSecurityScannerSettings * folders/{folder}/webSecurityScannerSettings * projects/{project}/webSecurityScannerSettings - "serviceEnablementState": "A String", # The state of enablement for the service at its level of the resource hierarchy. A DISABLED state will override all module enablement_states to DISABLED. - "updateTime": "A String", # Output only. The time the settings were last updated. + "name": "A String", + "serviceEnablementState": "A String", + "updateTime": "A String", }
updateContainerThreatDetectionSettings(name, body=None, updateMask=None, x__xgafv=None) -
Update the ContainerThreatDetectionSettings resource.
+  
 
 Args:
-  name: string, Identifier. The resource name of the ContainerThreatDetectionSettings. Formats: * organizations/{organization}/containerThreatDetectionSettings * folders/{folder}/containerThreatDetectionSettings * projects/{project}/containerThreatDetectionSettings * projects/{project}/locations/{location}/clusters/{cluster}/containerThreatDetectionSettings (required)
+  name: string, A parameter (required)
   body: object, The request body.
     The object takes the form of:
 
-{ # Resource capturing the settings for the Container Threat Detection service.
-  "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's configuration.
-    "a_key": { # Configuration of a module.
-      "moduleEnablementState": "A String", # The state of enablement for the module at its level of the resource hierarchy.
-      "value": { # The configuration value for the module. The absence of this field implies its inheritance from the parent.
+{
+  "modules": {
+    "a_key": {
+      "moduleEnablementState": "A String",
+      "value": {
         "a_key": "", # Properties of the object.
       },
     },
   },
-  "name": "A String", # Identifier. The resource name of the ContainerThreatDetectionSettings. Formats: * organizations/{organization}/containerThreatDetectionSettings * folders/{folder}/containerThreatDetectionSettings * projects/{project}/containerThreatDetectionSettings * projects/{project}/locations/{location}/clusters/{cluster}/containerThreatDetectionSettings
-  "serviceAccount": "A String", # Output only. The service account used by Container Threat Detection for scanning. Service accounts are scoped at the project level meaning this field will be empty at any level above a project.
-  "serviceEnablementState": "A String", # The state of enablement for the service at its level of the resource hierarchy. A DISABLED state will override all module enablement_states to DISABLED.
-  "updateTime": "A String", # Output only. The time the settings were last updated.
+  "name": "A String",
+  "serviceAccount": "A String",
+  "serviceEnablementState": "A String",
+  "updateTime": "A String",
 }
 
-  updateMask: string, The list of fields to be updated.
+  updateMask: string, A parameter
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -385,46 +385,46 @@ 

Method Details

Returns: An object of the form: - { # Resource capturing the settings for the Container Threat Detection service. - "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's configuration. - "a_key": { # Configuration of a module. - "moduleEnablementState": "A String", # The state of enablement for the module at its level of the resource hierarchy. - "value": { # The configuration value for the module. The absence of this field implies its inheritance from the parent. + { + "modules": { + "a_key": { + "moduleEnablementState": "A String", + "value": { "a_key": "", # Properties of the object. }, }, }, - "name": "A String", # Identifier. The resource name of the ContainerThreatDetectionSettings. Formats: * organizations/{organization}/containerThreatDetectionSettings * folders/{folder}/containerThreatDetectionSettings * projects/{project}/containerThreatDetectionSettings * projects/{project}/locations/{location}/clusters/{cluster}/containerThreatDetectionSettings - "serviceAccount": "A String", # Output only. The service account used by Container Threat Detection for scanning. Service accounts are scoped at the project level meaning this field will be empty at any level above a project. - "serviceEnablementState": "A String", # The state of enablement for the service at its level of the resource hierarchy. A DISABLED state will override all module enablement_states to DISABLED. - "updateTime": "A String", # Output only. The time the settings were last updated. + "name": "A String", + "serviceAccount": "A String", + "serviceEnablementState": "A String", + "updateTime": "A String", }
updateEventThreatDetectionSettings(name, body=None, updateMask=None, x__xgafv=None) -
Update the EventThreatDetectionSettings resource.
+  
 
 Args:
-  name: string, Identifier. The resource name of the EventThreatDetectionSettings. Formats: * organizations/{organization}/eventThreatDetectionSettings * folders/{folder}/eventThreatDetectionSettings * projects/{project}/eventThreatDetectionSettings (required)
+  name: string, A parameter (required)
   body: object, The request body.
     The object takes the form of:
 
-{ # Resource capturing the settings for the Event Threat Detection service.
-  "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's configuration.
-    "a_key": { # Configuration of a module.
-      "moduleEnablementState": "A String", # The state of enablement for the module at its level of the resource hierarchy.
-      "value": { # The configuration value for the module. The absence of this field implies its inheritance from the parent.
+{
+  "modules": {
+    "a_key": {
+      "moduleEnablementState": "A String",
+      "value": {
         "a_key": "", # Properties of the object.
       },
     },
   },
-  "name": "A String", # Identifier. The resource name of the EventThreatDetectionSettings. Formats: * organizations/{organization}/eventThreatDetectionSettings * folders/{folder}/eventThreatDetectionSettings * projects/{project}/eventThreatDetectionSettings
-  "serviceEnablementState": "A String", # The state of enablement for the service at its level of the resource hierarchy. A DISABLED state will override all module enablement_states to DISABLED.
-  "updateTime": "A String", # Output only. The time the settings were last updated.
+  "name": "A String",
+  "serviceEnablementState": "A String",
+  "updateTime": "A String",
 }
 
-  updateMask: string, The list of fields to be updated.
+  updateMask: string, A parameter
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -433,45 +433,45 @@ 

Method Details

Returns: An object of the form: - { # Resource capturing the settings for the Event Threat Detection service. - "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's configuration. - "a_key": { # Configuration of a module. - "moduleEnablementState": "A String", # The state of enablement for the module at its level of the resource hierarchy. - "value": { # The configuration value for the module. The absence of this field implies its inheritance from the parent. + { + "modules": { + "a_key": { + "moduleEnablementState": "A String", + "value": { "a_key": "", # Properties of the object. }, }, }, - "name": "A String", # Identifier. The resource name of the EventThreatDetectionSettings. Formats: * organizations/{organization}/eventThreatDetectionSettings * folders/{folder}/eventThreatDetectionSettings * projects/{project}/eventThreatDetectionSettings - "serviceEnablementState": "A String", # The state of enablement for the service at its level of the resource hierarchy. A DISABLED state will override all module enablement_states to DISABLED. - "updateTime": "A String", # Output only. The time the settings were last updated. + "name": "A String", + "serviceEnablementState": "A String", + "updateTime": "A String", }
updateRapidVulnerabilityDetectionSettings(name, body=None, updateMask=None, x__xgafv=None) -
Update the RapidVulnerabilityDetectionSettings resource.
+  
 
 Args:
-  name: string, The resource name of the RapidVulnerabilityDetectionSettings. Formats: * organizations/{organization}/rapidVulnerabilityDetectionSettings * folders/{folder}/rapidVulnerabilityDetectionSettings * projects/{project}/rapidVulnerabilityDetectionSettings (required)
+  name: string, A parameter (required)
   body: object, The request body.
     The object takes the form of:
 
-{ # Resource capturing the settings for the Rapid Vulnerability Detection service.
-  "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's.
-    "a_key": { # Configuration of a module.
-      "moduleEnablementState": "A String", # The state of enablement for the module at its level of the resource hierarchy.
-      "value": { # The configuration value for the module. The absence of this field implies its inheritance from the parent.
+{
+  "modules": {
+    "a_key": {
+      "moduleEnablementState": "A String",
+      "value": {
         "a_key": "", # Properties of the object.
       },
     },
   },
-  "name": "A String", # The resource name of the RapidVulnerabilityDetectionSettings. Formats: * organizations/{organization}/rapidVulnerabilityDetectionSettings * folders/{folder}/rapidVulnerabilityDetectionSettings * projects/{project}/rapidVulnerabilityDetectionSettings
-  "serviceEnablementState": "A String", # The state of enablement for the service at its level of the resource hierarchy. A DISABLED state will override all module enablement_states to DISABLED.
-  "updateTime": "A String", # Output only. The time the settings were last updated.
+  "name": "A String",
+  "serviceEnablementState": "A String",
+  "updateTime": "A String",
 }
 
-  updateMask: string, The list of fields to be updated.
+  updateMask: string, A parameter
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -480,46 +480,46 @@ 

Method Details

Returns: An object of the form: - { # Resource capturing the settings for the Rapid Vulnerability Detection service. - "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's. - "a_key": { # Configuration of a module. - "moduleEnablementState": "A String", # The state of enablement for the module at its level of the resource hierarchy. - "value": { # The configuration value for the module. The absence of this field implies its inheritance from the parent. + { + "modules": { + "a_key": { + "moduleEnablementState": "A String", + "value": { "a_key": "", # Properties of the object. }, }, }, - "name": "A String", # The resource name of the RapidVulnerabilityDetectionSettings. Formats: * organizations/{organization}/rapidVulnerabilityDetectionSettings * folders/{folder}/rapidVulnerabilityDetectionSettings * projects/{project}/rapidVulnerabilityDetectionSettings - "serviceEnablementState": "A String", # The state of enablement for the service at its level of the resource hierarchy. A DISABLED state will override all module enablement_states to DISABLED. - "updateTime": "A String", # Output only. The time the settings were last updated. + "name": "A String", + "serviceEnablementState": "A String", + "updateTime": "A String", }
updateSecurityHealthAnalyticsSettings(name, body=None, updateMask=None, x__xgafv=None) -
Update the SecurityHealthAnalyticsSettings resource.
+  
 
 Args:
-  name: string, Identifier. The resource name of the SecurityHealthAnalyticsSettings. Formats: * organizations/{organization}/securityHealthAnalyticsSettings * folders/{folder}/securityHealthAnalyticsSettings * projects/{project}/securityHealthAnalyticsSettings (required)
+  name: string, A parameter (required)
   body: object, The request body.
     The object takes the form of:
 
-{ # Resource capturing the settings for the Security Health Analytics service.
-  "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's configuration.
-    "a_key": { # Configuration of a module.
-      "moduleEnablementState": "A String", # The state of enablement for the module at its level of the resource hierarchy.
-      "value": { # The configuration value for the module. The absence of this field implies its inheritance from the parent.
+{
+  "modules": {
+    "a_key": {
+      "moduleEnablementState": "A String",
+      "value": {
         "a_key": "", # Properties of the object.
       },
     },
   },
-  "name": "A String", # Identifier. The resource name of the SecurityHealthAnalyticsSettings. Formats: * organizations/{organization}/securityHealthAnalyticsSettings * folders/{folder}/securityHealthAnalyticsSettings * projects/{project}/securityHealthAnalyticsSettings
-  "serviceAccount": "A String", # Output only. The service account used by Security Health Analytics detectors.
-  "serviceEnablementState": "A String", # The state of enablement for the service at its level of the resource hierarchy. A DISABLED state will override all module enablement_states to DISABLED.
-  "updateTime": "A String", # Output only. The time the settings were last updated.
+  "name": "A String",
+  "serviceAccount": "A String",
+  "serviceEnablementState": "A String",
+  "updateTime": "A String",
 }
 
-  updateMask: string, The list of fields to be updated.
+  updateMask: string, A parameter
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -528,47 +528,47 @@ 

Method Details

Returns: An object of the form: - { # Resource capturing the settings for the Security Health Analytics service. - "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's configuration. - "a_key": { # Configuration of a module. - "moduleEnablementState": "A String", # The state of enablement for the module at its level of the resource hierarchy. - "value": { # The configuration value for the module. The absence of this field implies its inheritance from the parent. + { + "modules": { + "a_key": { + "moduleEnablementState": "A String", + "value": { "a_key": "", # Properties of the object. }, }, }, - "name": "A String", # Identifier. The resource name of the SecurityHealthAnalyticsSettings. Formats: * organizations/{organization}/securityHealthAnalyticsSettings * folders/{folder}/securityHealthAnalyticsSettings * projects/{project}/securityHealthAnalyticsSettings - "serviceAccount": "A String", # Output only. The service account used by Security Health Analytics detectors. - "serviceEnablementState": "A String", # The state of enablement for the service at its level of the resource hierarchy. A DISABLED state will override all module enablement_states to DISABLED. - "updateTime": "A String", # Output only. The time the settings were last updated. + "name": "A String", + "serviceAccount": "A String", + "serviceEnablementState": "A String", + "updateTime": "A String", }
updateVirtualMachineThreatDetectionSettings(name, body=None, updateMask=None, x__xgafv=None) -
Update the VirtualMachineThreatDetectionSettings resource.
+  
 
 Args:
-  name: string, Identifier. The resource name of the VirtualMachineThreatDetectionSettings. Formats: * organizations/{organization}/virtualMachineThreatDetectionSettings * folders/{folder}/virtualMachineThreatDetectionSettings * projects/{project}/virtualMachineThreatDetectionSettings (required)
+  name: string, A parameter (required)
   body: object, The request body.
     The object takes the form of:
 
-{ # Resource capturing the settings for the Virtual Machine Threat Detection service.
-  "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's configuration.
-    "a_key": { # Configuration of a module.
-      "moduleEnablementState": "A String", # The state of enablement for the module at its level of the resource hierarchy.
-      "value": { # The configuration value for the module. The absence of this field implies its inheritance from the parent.
+{
+  "modules": {
+    "a_key": {
+      "moduleEnablementState": "A String",
+      "value": {
         "a_key": "", # Properties of the object.
       },
     },
   },
-  "name": "A String", # Identifier. The resource name of the VirtualMachineThreatDetectionSettings. Formats: * organizations/{organization}/virtualMachineThreatDetectionSettings * folders/{folder}/virtualMachineThreatDetectionSettings * projects/{project}/virtualMachineThreatDetectionSettings
-  "serviceAccount": "A String", # Output only. The service account used by Virtual Machine Threat Detection detectors.
-  "serviceEnablementState": "A String", # The state of enablement for the service at its level of the resource hierarchy. A DISABLED state will override all module enablement_states to DISABLED.
-  "updateTime": "A String", # Output only. The time the settings were last updated.
+  "name": "A String",
+  "serviceAccount": "A String",
+  "serviceEnablementState": "A String",
+  "updateTime": "A String",
 }
 
-  updateMask: string, The list of fields to be updated.
+  updateMask: string, A parameter
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -577,46 +577,46 @@ 

Method Details

Returns: An object of the form: - { # Resource capturing the settings for the Virtual Machine Threat Detection service. - "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's configuration. - "a_key": { # Configuration of a module. - "moduleEnablementState": "A String", # The state of enablement for the module at its level of the resource hierarchy. - "value": { # The configuration value for the module. The absence of this field implies its inheritance from the parent. + { + "modules": { + "a_key": { + "moduleEnablementState": "A String", + "value": { "a_key": "", # Properties of the object. }, }, }, - "name": "A String", # Identifier. The resource name of the VirtualMachineThreatDetectionSettings. Formats: * organizations/{organization}/virtualMachineThreatDetectionSettings * folders/{folder}/virtualMachineThreatDetectionSettings * projects/{project}/virtualMachineThreatDetectionSettings - "serviceAccount": "A String", # Output only. The service account used by Virtual Machine Threat Detection detectors. - "serviceEnablementState": "A String", # The state of enablement for the service at its level of the resource hierarchy. A DISABLED state will override all module enablement_states to DISABLED. - "updateTime": "A String", # Output only. The time the settings were last updated. + "name": "A String", + "serviceAccount": "A String", + "serviceEnablementState": "A String", + "updateTime": "A String", }
updateWebSecurityScannerSettings(name, body=None, updateMask=None, x__xgafv=None) -
Update the WebSecurityScannerSettings resource.
+  
 
 Args:
-  name: string, Identifier. The resource name of the WebSecurityScannerSettings. Formats: * organizations/{organization}/webSecurityScannerSettings * folders/{folder}/webSecurityScannerSettings * projects/{project}/webSecurityScannerSettings (required)
+  name: string, A parameter (required)
   body: object, The request body.
     The object takes the form of:
 
-{ # Resource capturing the settings for the Web Security Scanner service.
-  "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's configuration.
-    "a_key": { # Configuration of a module.
-      "moduleEnablementState": "A String", # The state of enablement for the module at its level of the resource hierarchy.
-      "value": { # The configuration value for the module. The absence of this field implies its inheritance from the parent.
+{
+  "modules": {
+    "a_key": {
+      "moduleEnablementState": "A String",
+      "value": {
         "a_key": "", # Properties of the object.
       },
     },
   },
-  "name": "A String", # Identifier. The resource name of the WebSecurityScannerSettings. Formats: * organizations/{organization}/webSecurityScannerSettings * folders/{folder}/webSecurityScannerSettings * projects/{project}/webSecurityScannerSettings
-  "serviceEnablementState": "A String", # The state of enablement for the service at its level of the resource hierarchy. A DISABLED state will override all module enablement_states to DISABLED.
-  "updateTime": "A String", # Output only. The time the settings were last updated.
+  "name": "A String",
+  "serviceEnablementState": "A String",
+  "updateTime": "A String",
 }
 
-  updateMask: string, The list of fields to be updated.
+  updateMask: string, A parameter
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -625,18 +625,18 @@ 

Method Details

Returns: An object of the form: - { # Resource capturing the settings for the Web Security Scanner service. - "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's configuration. - "a_key": { # Configuration of a module. - "moduleEnablementState": "A String", # The state of enablement for the module at its level of the resource hierarchy. - "value": { # The configuration value for the module. The absence of this field implies its inheritance from the parent. + { + "modules": { + "a_key": { + "moduleEnablementState": "A String", + "value": { "a_key": "", # Properties of the object. }, }, }, - "name": "A String", # Identifier. The resource name of the WebSecurityScannerSettings. Formats: * organizations/{organization}/webSecurityScannerSettings * folders/{folder}/webSecurityScannerSettings * projects/{project}/webSecurityScannerSettings - "serviceEnablementState": "A String", # The state of enablement for the service at its level of the resource hierarchy. A DISABLED state will override all module enablement_states to DISABLED. - "updateTime": "A String", # Output only. The time the settings were last updated. + "name": "A String", + "serviceEnablementState": "A String", + "updateTime": "A String", }
diff --git a/docs/dyn/securitycenter_v1beta2.folders.rapidVulnerabilityDetectionSettings.html b/docs/dyn/securitycenter_v1beta2.folders.rapidVulnerabilityDetectionSettings.html index 88c2af5016..5171d4db4b 100644 --- a/docs/dyn/securitycenter_v1beta2.folders.rapidVulnerabilityDetectionSettings.html +++ b/docs/dyn/securitycenter_v1beta2.folders.rapidVulnerabilityDetectionSettings.html @@ -76,17 +76,17 @@

Security Command Center API . Instance Methods

calculate(name, x__xgafv=None)

-

Calculates the effective RapidVulnerabilityDetectionSettings based on its level in the resource hierarchy and its settings. Settings provided closer to the target resource take precedence over those further away (e.g. folder will override organization level settings). The default SCC setting for the detector service defaults can be overridden at organization, folder and project levels. No assumptions should be made about the SCC defaults as it is considered an internal implementation detail.

+

close()

Close httplib2 connections.

Method Details

calculate(name, x__xgafv=None) -
Calculates the effective RapidVulnerabilityDetectionSettings based on its level in the resource hierarchy and its settings. Settings provided closer to the target resource take precedence over those further away (e.g. folder will override organization level settings). The default SCC setting for the detector service defaults can be overridden at organization, folder and project levels. No assumptions should be made about the SCC defaults as it is considered an internal implementation detail.
+  
 
 Args:
-  name: string, Required. The name of the RapidVulnerabilityDetectionSettings to calculate. Formats: * organizations/{organization}/rapidVulnerabilityDetectionSettings * folders/{folder}/rapidVulnerabilityDetectionSettings * projects/{project}/rapidVulnerabilityDetectionSettings (required)
+  name: string, A parameter (required)
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -95,18 +95,18 @@ 

Method Details

Returns: An object of the form: - { # Resource capturing the settings for the Rapid Vulnerability Detection service. - "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's. - "a_key": { # Configuration of a module. - "moduleEnablementState": "A String", # The state of enablement for the module at its level of the resource hierarchy. - "value": { # The configuration value for the module. The absence of this field implies its inheritance from the parent. + { + "modules": { + "a_key": { + "moduleEnablementState": "A String", + "value": { "a_key": "", # Properties of the object. }, }, }, - "name": "A String", # The resource name of the RapidVulnerabilityDetectionSettings. Formats: * organizations/{organization}/rapidVulnerabilityDetectionSettings * folders/{folder}/rapidVulnerabilityDetectionSettings * projects/{project}/rapidVulnerabilityDetectionSettings - "serviceEnablementState": "A String", # The state of enablement for the service at its level of the resource hierarchy. A DISABLED state will override all module enablement_states to DISABLED. - "updateTime": "A String", # Output only. The time the settings were last updated. + "name": "A String", + "serviceEnablementState": "A String", + "updateTime": "A String", }
diff --git a/docs/dyn/securitycenter_v1beta2.folders.securityHealthAnalyticsSettings.html b/docs/dyn/securitycenter_v1beta2.folders.securityHealthAnalyticsSettings.html index a82dba8229..f8373adbba 100644 --- a/docs/dyn/securitycenter_v1beta2.folders.securityHealthAnalyticsSettings.html +++ b/docs/dyn/securitycenter_v1beta2.folders.securityHealthAnalyticsSettings.html @@ -76,18 +76,18 @@

Security Command Center API . Instance Methods

calculate(name, showEligibleModulesOnly=None, x__xgafv=None)

-

Calculates the effective SecurityHealthAnalyticsSettings based on its level in the resource hierarchy and its settings. Settings provided closer to the target resource take precedence over those further away (e.g. folder will override organization level settings). The default SCC setting for the detector service defaults can be overridden at organization, folder and project levels. No assumptions should be made about the SCC defaults as it is considered an internal implementation detail.

+

close()

Close httplib2 connections.

Method Details

calculate(name, showEligibleModulesOnly=None, x__xgafv=None) -
Calculates the effective SecurityHealthAnalyticsSettings based on its level in the resource hierarchy and its settings. Settings provided closer to the target resource take precedence over those further away (e.g. folder will override organization level settings). The default SCC setting for the detector service defaults can be overridden at organization, folder and project levels. No assumptions should be made about the SCC defaults as it is considered an internal implementation detail.
+  
 
 Args:
-  name: string, Required. The name of the SecurityHealthAnalyticsSettings to calculate. Formats: * organizations/{organization}/securityHealthAnalyticsSettings * folders/{folder}/securityHealthAnalyticsSettings * projects/{project}/securityHealthAnalyticsSettings (required)
-  showEligibleModulesOnly: boolean, Optional. When set, will only retrieve the modules that are in scope. By default, all modules will be shown.
+  name: string, A parameter (required)
+  showEligibleModulesOnly: boolean, A parameter
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -96,19 +96,19 @@ 

Method Details

Returns: An object of the form: - { # Resource capturing the settings for the Security Health Analytics service. - "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's configuration. - "a_key": { # Configuration of a module. - "moduleEnablementState": "A String", # The state of enablement for the module at its level of the resource hierarchy. - "value": { # The configuration value for the module. The absence of this field implies its inheritance from the parent. + { + "modules": { + "a_key": { + "moduleEnablementState": "A String", + "value": { "a_key": "", # Properties of the object. }, }, }, - "name": "A String", # Identifier. The resource name of the SecurityHealthAnalyticsSettings. Formats: * organizations/{organization}/securityHealthAnalyticsSettings * folders/{folder}/securityHealthAnalyticsSettings * projects/{project}/securityHealthAnalyticsSettings - "serviceAccount": "A String", # Output only. The service account used by Security Health Analytics detectors. - "serviceEnablementState": "A String", # The state of enablement for the service at its level of the resource hierarchy. A DISABLED state will override all module enablement_states to DISABLED. - "updateTime": "A String", # Output only. The time the settings were last updated. + "name": "A String", + "serviceAccount": "A String", + "serviceEnablementState": "A String", + "updateTime": "A String", }
diff --git a/docs/dyn/securitycenter_v1beta2.folders.virtualMachineThreatDetectionSettings.html b/docs/dyn/securitycenter_v1beta2.folders.virtualMachineThreatDetectionSettings.html index 0b0f3004f4..23f9f75f45 100644 --- a/docs/dyn/securitycenter_v1beta2.folders.virtualMachineThreatDetectionSettings.html +++ b/docs/dyn/securitycenter_v1beta2.folders.virtualMachineThreatDetectionSettings.html @@ -76,18 +76,18 @@

Security Command Center API . Instance Methods

calculate(name, showEligibleModulesOnly=None, x__xgafv=None)

-

Calculates the effective VirtualMachineThreatDetectionSettings based on its level in the resource hierarchy and its settings. Settings provided closer to the target resource take precedence over those further away (e.g. folder will override organization level settings). The default SCC setting for the detector service defaults can be overridden at organization, folder and project levels. No assumptions should be made about the SCC defaults as it is considered an internal implementation detail.

+

close()

Close httplib2 connections.

Method Details

calculate(name, showEligibleModulesOnly=None, x__xgafv=None) -
Calculates the effective VirtualMachineThreatDetectionSettings based on its level in the resource hierarchy and its settings. Settings provided closer to the target resource take precedence over those further away (e.g. folder will override organization level settings). The default SCC setting for the detector service defaults can be overridden at organization, folder and project levels. No assumptions should be made about the SCC defaults as it is considered an internal implementation detail.
+  
 
 Args:
-  name: string, Required. The name of the VirtualMachineThreatDetectionSettings to calculate. Formats: * organizations/{organization}/virtualMachineThreatDetectionSettings * folders/{folder}/virtualMachineThreatDetectionSettings * projects/{project}/virtualMachineThreatDetectionSettings (required)
-  showEligibleModulesOnly: boolean, Optional. When set, will only retrieve the modules that are in scope. By default, all modules will be shown.
+  name: string, A parameter (required)
+  showEligibleModulesOnly: boolean, A parameter
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -96,19 +96,19 @@ 

Method Details

Returns: An object of the form: - { # Resource capturing the settings for the Virtual Machine Threat Detection service. - "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's configuration. - "a_key": { # Configuration of a module. - "moduleEnablementState": "A String", # The state of enablement for the module at its level of the resource hierarchy. - "value": { # The configuration value for the module. The absence of this field implies its inheritance from the parent. + { + "modules": { + "a_key": { + "moduleEnablementState": "A String", + "value": { "a_key": "", # Properties of the object. }, }, }, - "name": "A String", # Identifier. The resource name of the VirtualMachineThreatDetectionSettings. Formats: * organizations/{organization}/virtualMachineThreatDetectionSettings * folders/{folder}/virtualMachineThreatDetectionSettings * projects/{project}/virtualMachineThreatDetectionSettings - "serviceAccount": "A String", # Output only. The service account used by Virtual Machine Threat Detection detectors. - "serviceEnablementState": "A String", # The state of enablement for the service at its level of the resource hierarchy. A DISABLED state will override all module enablement_states to DISABLED. - "updateTime": "A String", # Output only. The time the settings were last updated. + "name": "A String", + "serviceAccount": "A String", + "serviceEnablementState": "A String", + "updateTime": "A String", }
diff --git a/docs/dyn/securitycenter_v1beta2.folders.webSecurityScannerSettings.html b/docs/dyn/securitycenter_v1beta2.folders.webSecurityScannerSettings.html index 3a17b4e815..8b8bab5c61 100644 --- a/docs/dyn/securitycenter_v1beta2.folders.webSecurityScannerSettings.html +++ b/docs/dyn/securitycenter_v1beta2.folders.webSecurityScannerSettings.html @@ -76,18 +76,18 @@

Security Command Center API . Instance Methods

calculate(name, showEligibleModulesOnly=None, x__xgafv=None)

-

Calculates the effective WebSecurityScannerSettings based on its level in the resource hierarchy and its settings. Settings provided closer to the target resource take precedence over those further away (e.g. folder will override organization level settings). The default SCC setting for the detector service defaults can be overridden at organization, folder and project levels. No assumptions should be made about the SCC defaults as it is considered an internal implementation detail.

+

close()

Close httplib2 connections.

Method Details

calculate(name, showEligibleModulesOnly=None, x__xgafv=None) -
Calculates the effective WebSecurityScannerSettings based on its level in the resource hierarchy and its settings. Settings provided closer to the target resource take precedence over those further away (e.g. folder will override organization level settings). The default SCC setting for the detector service defaults can be overridden at organization, folder and project levels. No assumptions should be made about the SCC defaults as it is considered an internal implementation detail.
+  
 
 Args:
-  name: string, Required. The name of the WebSecurityScannerSettings to calculate. Formats: * organizations/{organization}/webSecurityScannerSettings * folders/{folder}/webSecurityScannerSettings * projects/{project}/webSecurityScannerSettings (required)
-  showEligibleModulesOnly: boolean, Optional. When set, will only retrieve the modules that are in scope. By default, all modules will be shown.
+  name: string, A parameter (required)
+  showEligibleModulesOnly: boolean, A parameter
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -96,18 +96,18 @@ 

Method Details

Returns: An object of the form: - { # Resource capturing the settings for the Web Security Scanner service. - "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's configuration. - "a_key": { # Configuration of a module. - "moduleEnablementState": "A String", # The state of enablement for the module at its level of the resource hierarchy. - "value": { # The configuration value for the module. The absence of this field implies its inheritance from the parent. + { + "modules": { + "a_key": { + "moduleEnablementState": "A String", + "value": { "a_key": "", # Properties of the object. }, }, }, - "name": "A String", # Identifier. The resource name of the WebSecurityScannerSettings. Formats: * organizations/{organization}/webSecurityScannerSettings * folders/{folder}/webSecurityScannerSettings * projects/{project}/webSecurityScannerSettings - "serviceEnablementState": "A String", # The state of enablement for the service at its level of the resource hierarchy. A DISABLED state will override all module enablement_states to DISABLED. - "updateTime": "A String", # Output only. The time the settings were last updated. + "name": "A String", + "serviceEnablementState": "A String", + "updateTime": "A String", }
diff --git a/docs/dyn/securitycenter_v1beta2.organizations.containerThreatDetectionSettings.html b/docs/dyn/securitycenter_v1beta2.organizations.containerThreatDetectionSettings.html index 962b331dfc..c1c1c0a388 100644 --- a/docs/dyn/securitycenter_v1beta2.organizations.containerThreatDetectionSettings.html +++ b/docs/dyn/securitycenter_v1beta2.organizations.containerThreatDetectionSettings.html @@ -76,18 +76,18 @@

Security Command Center API . Instance Methods

calculate(name, showEligibleModulesOnly=None, x__xgafv=None)

-

Calculates the effective ContainerThreatDetectionSettings based on its level in the resource hierarchy and its settings. Settings provided closer to the target resource take precedence over those further away (e.g. folder will override organization level settings). The default SCC setting for the detector service defaults can be overridden at organization, folder and project levels. No assumptions should be made about the SCC defaults as it is considered an internal implementation detail.

+

close()

Close httplib2 connections.

Method Details

calculate(name, showEligibleModulesOnly=None, x__xgafv=None) -
Calculates the effective ContainerThreatDetectionSettings based on its level in the resource hierarchy and its settings. Settings provided closer to the target resource take precedence over those further away (e.g. folder will override organization level settings). The default SCC setting for the detector service defaults can be overridden at organization, folder and project levels. No assumptions should be made about the SCC defaults as it is considered an internal implementation detail.
+  
 
 Args:
-  name: string, Required. The name of the ContainerThreatDetectionSettings to calculate. Formats: * organizations/{organization}/containerThreatDetectionSettings * folders/{folder}/containerThreatDetectionSettings * projects/{project}/containerThreatDetectionSettings * projects/{project}/locations/{location}/clusters/{cluster}/containerThreatDetectionSettings (required)
-  showEligibleModulesOnly: boolean, Optional. When set, will only retrieve the modules that are in scope. By default, all modules will be shown.
+  name: string, A parameter (required)
+  showEligibleModulesOnly: boolean, A parameter
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -96,19 +96,19 @@ 

Method Details

Returns: An object of the form: - { # Resource capturing the settings for the Container Threat Detection service. - "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's configuration. - "a_key": { # Configuration of a module. - "moduleEnablementState": "A String", # The state of enablement for the module at its level of the resource hierarchy. - "value": { # The configuration value for the module. The absence of this field implies its inheritance from the parent. + { + "modules": { + "a_key": { + "moduleEnablementState": "A String", + "value": { "a_key": "", # Properties of the object. }, }, }, - "name": "A String", # Identifier. The resource name of the ContainerThreatDetectionSettings. Formats: * organizations/{organization}/containerThreatDetectionSettings * folders/{folder}/containerThreatDetectionSettings * projects/{project}/containerThreatDetectionSettings * projects/{project}/locations/{location}/clusters/{cluster}/containerThreatDetectionSettings - "serviceAccount": "A String", # Output only. The service account used by Container Threat Detection for scanning. Service accounts are scoped at the project level meaning this field will be empty at any level above a project. - "serviceEnablementState": "A String", # The state of enablement for the service at its level of the resource hierarchy. A DISABLED state will override all module enablement_states to DISABLED. - "updateTime": "A String", # Output only. The time the settings were last updated. + "name": "A String", + "serviceAccount": "A String", + "serviceEnablementState": "A String", + "updateTime": "A String", }
diff --git a/docs/dyn/securitycenter_v1beta2.organizations.eventThreatDetectionSettings.html b/docs/dyn/securitycenter_v1beta2.organizations.eventThreatDetectionSettings.html index 384a46bd98..86f88e5029 100644 --- a/docs/dyn/securitycenter_v1beta2.organizations.eventThreatDetectionSettings.html +++ b/docs/dyn/securitycenter_v1beta2.organizations.eventThreatDetectionSettings.html @@ -76,18 +76,18 @@

Security Command Center API . Instance Methods

calculate(name, showEligibleModulesOnly=None, x__xgafv=None)

-

Calculates the effective EventThreatDetectionSettings based on its level in the resource hierarchy and its settings. Settings provided closer to the target resource take precedence over those further away (e.g. folder will override organization level settings). The default SCC setting for the detector service defaults can be overridden at organization, folder and project levels. No assumptions should be made about the SCC defaults as it is considered an internal implementation detail.

+

close()

Close httplib2 connections.

Method Details

calculate(name, showEligibleModulesOnly=None, x__xgafv=None) -
Calculates the effective EventThreatDetectionSettings based on its level in the resource hierarchy and its settings. Settings provided closer to the target resource take precedence over those further away (e.g. folder will override organization level settings). The default SCC setting for the detector service defaults can be overridden at organization, folder and project levels. No assumptions should be made about the SCC defaults as it is considered an internal implementation detail.
+  
 
 Args:
-  name: string, Required. The name of the EventThreatDetectionSettings to calculate. Formats: * organizations/{organization}/eventThreatDetectionSettings * folders/{folder}/eventThreatDetectionSettings * projects/{project}/eventThreatDetectionSettings (required)
-  showEligibleModulesOnly: boolean, Optional. When set, will only retrieve the modules that are in scope. By default, all modules will be shown.
+  name: string, A parameter (required)
+  showEligibleModulesOnly: boolean, A parameter
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -96,18 +96,18 @@ 

Method Details

Returns: An object of the form: - { # Resource capturing the settings for the Event Threat Detection service. - "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's configuration. - "a_key": { # Configuration of a module. - "moduleEnablementState": "A String", # The state of enablement for the module at its level of the resource hierarchy. - "value": { # The configuration value for the module. The absence of this field implies its inheritance from the parent. + { + "modules": { + "a_key": { + "moduleEnablementState": "A String", + "value": { "a_key": "", # Properties of the object. }, }, }, - "name": "A String", # Identifier. The resource name of the EventThreatDetectionSettings. Formats: * organizations/{organization}/eventThreatDetectionSettings * folders/{folder}/eventThreatDetectionSettings * projects/{project}/eventThreatDetectionSettings - "serviceEnablementState": "A String", # The state of enablement for the service at its level of the resource hierarchy. A DISABLED state will override all module enablement_states to DISABLED. - "updateTime": "A String", # Output only. The time the settings were last updated. + "name": "A String", + "serviceEnablementState": "A String", + "updateTime": "A String", }
diff --git a/docs/dyn/securitycenter_v1beta2.organizations.html b/docs/dyn/securitycenter_v1beta2.organizations.html index 3574baa911..2872385f43 100644 --- a/docs/dyn/securitycenter_v1beta2.organizations.html +++ b/docs/dyn/securitycenter_v1beta2.organizations.html @@ -109,46 +109,46 @@

Instance Methods

Close httplib2 connections.

getContainerThreatDetectionSettings(name, x__xgafv=None)

-

Get the ContainerThreatDetectionSettings resource. In the returned settings response, a missing field only indicates that it was not explicitly set, so no assumption should be made about these fields. In other words, GetContainerThreatDetectionSettings does not calculate the effective service settings for the resource, which accounts for inherited settings and defaults. Instead, use CalculateContainerThreatDetectionSettings for this purpose.

+

getEventThreatDetectionSettings(name, x__xgafv=None)

-

Get the EventThreatDetectionSettings resource. In the returned settings response, a missing field only indicates that it was not explicitly set, so no assumption should be made about these fields. In other words, GetEventThreatDetectionSettings does not calculate the effective service settings for the resource, which accounts for inherited settings and defaults. Instead, use CalculateEventThreatDetectionSettings for this purpose.

+

getRapidVulnerabilityDetectionSettings(name, x__xgafv=None)

-

Get the RapidVulnerabilityDetectionSettings resource. In the returned settings response, a missing field only indicates that it was not explicitly set, so no assumption should be made about these fields. In other words, GetRapidVulnerabilityDetectionSettings does not calculate the effective service settings for the resource, which accounts for inherited settings and defaults. Instead, use CalculateRapidVulnerabilityDetectionSettings for this purpose.

+

getSecurityCenterSettings(name, x__xgafv=None)

-

Get the SecurityCenterSettings resource.

+

getSecurityHealthAnalyticsSettings(name, x__xgafv=None)

-

Get the SecurityHealthAnalyticsSettings resource. In the returned settings response, a missing field only indicates that it was not explicitly set, so no assumption should be made about these fields. In other words, GetSecurityHealthAnalyticsSettings does not calculate the effective service settings for the resource, which accounts for inherited settings and defaults. Instead, use CalculateSecurityHealthAnalyticsSettings for this purpose.

+

getSubscription(name, x__xgafv=None)

-

Get the Subscription resource.

+

getVirtualMachineThreatDetectionSettings(name, x__xgafv=None)

-

Get the VirtualMachineThreatDetectionSettings resource. In the returned settings response, a missing field only indicates that it was not explicitly set, so no assumption should be made about these fields. In other words, GetVirtualMachineThreatDetectionSettings does not calculate the effective service settings for the resource, which accounts for inherited settings and defaults. Instead, use CalculateVirtualMachineThreatDetectionSettings for this purpose.

+

getWebSecurityScannerSettings(name, x__xgafv=None)

-

Get the WebSecurityScannerSettings resource. In the returned settings response, a missing field only indicates that it was not explicitly set, so no assumption should be made about these fields. In other words, GetWebSecurityScannerSettings does not calculate the effective service settings for the resource, which accounts for inherited settings and defaults. Instead, use CalculateWebSecurityScannerSettings for this purpose.

+

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

-

Update the ContainerThreatDetectionSettings resource.

+

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

-

Update the EventThreatDetectionSettings resource.

+

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

-

Update the RapidVulnerabilityDetectionSettings resource.

+

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

-

Update the SecurityHealthAnalyticsSettings resource.

+

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

-

Update the VirtualMachineThreatDetectionSettings resource.

+

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

-

Update the WebSecurityScannerSettings resource.

+

Method Details

close() @@ -157,10 +157,10 @@

Method Details

getContainerThreatDetectionSettings(name, x__xgafv=None) -
Get the ContainerThreatDetectionSettings resource. In the returned settings response, a missing field only indicates that it was not explicitly set, so no assumption should be made about these fields. In other words, GetContainerThreatDetectionSettings does not calculate the effective service settings for the resource, which accounts for inherited settings and defaults. Instead, use CalculateContainerThreatDetectionSettings for this purpose.
+  
 
 Args:
-  name: string, Required. The name of the ContainerThreatDetectionSettings to retrieve. Formats: * organizations/{organization}/containerThreatDetectionSettings * folders/{folder}/containerThreatDetectionSettings * projects/{project}/containerThreatDetectionSettings * projects/{project}/locations/{location}/clusters/{cluster}/containerThreatDetectionSettings (required)
+  name: string, A parameter (required)
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -169,28 +169,28 @@ 

Method Details

Returns: An object of the form: - { # Resource capturing the settings for the Container Threat Detection service. - "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's configuration. - "a_key": { # Configuration of a module. - "moduleEnablementState": "A String", # The state of enablement for the module at its level of the resource hierarchy. - "value": { # The configuration value for the module. The absence of this field implies its inheritance from the parent. + { + "modules": { + "a_key": { + "moduleEnablementState": "A String", + "value": { "a_key": "", # Properties of the object. }, }, }, - "name": "A String", # Identifier. The resource name of the ContainerThreatDetectionSettings. Formats: * organizations/{organization}/containerThreatDetectionSettings * folders/{folder}/containerThreatDetectionSettings * projects/{project}/containerThreatDetectionSettings * projects/{project}/locations/{location}/clusters/{cluster}/containerThreatDetectionSettings - "serviceAccount": "A String", # Output only. The service account used by Container Threat Detection for scanning. Service accounts are scoped at the project level meaning this field will be empty at any level above a project. - "serviceEnablementState": "A String", # The state of enablement for the service at its level of the resource hierarchy. A DISABLED state will override all module enablement_states to DISABLED. - "updateTime": "A String", # Output only. The time the settings were last updated. + "name": "A String", + "serviceAccount": "A String", + "serviceEnablementState": "A String", + "updateTime": "A String", }
getEventThreatDetectionSettings(name, x__xgafv=None) -
Get the EventThreatDetectionSettings resource. In the returned settings response, a missing field only indicates that it was not explicitly set, so no assumption should be made about these fields. In other words, GetEventThreatDetectionSettings does not calculate the effective service settings for the resource, which accounts for inherited settings and defaults. Instead, use CalculateEventThreatDetectionSettings for this purpose.
+  
 
 Args:
-  name: string, Required. The name of the EventThreatDetectionSettings to retrieve. Formats: * organizations/{organization}/eventThreatDetectionSettings * folders/{folder}/eventThreatDetectionSettings * projects/{project}/eventThreatDetectionSettings (required)
+  name: string, A parameter (required)
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -199,27 +199,27 @@ 

Method Details

Returns: An object of the form: - { # Resource capturing the settings for the Event Threat Detection service. - "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's configuration. - "a_key": { # Configuration of a module. - "moduleEnablementState": "A String", # The state of enablement for the module at its level of the resource hierarchy. - "value": { # The configuration value for the module. The absence of this field implies its inheritance from the parent. + { + "modules": { + "a_key": { + "moduleEnablementState": "A String", + "value": { "a_key": "", # Properties of the object. }, }, }, - "name": "A String", # Identifier. The resource name of the EventThreatDetectionSettings. Formats: * organizations/{organization}/eventThreatDetectionSettings * folders/{folder}/eventThreatDetectionSettings * projects/{project}/eventThreatDetectionSettings - "serviceEnablementState": "A String", # The state of enablement for the service at its level of the resource hierarchy. A DISABLED state will override all module enablement_states to DISABLED. - "updateTime": "A String", # Output only. The time the settings were last updated. + "name": "A String", + "serviceEnablementState": "A String", + "updateTime": "A String", }
getRapidVulnerabilityDetectionSettings(name, x__xgafv=None) -
Get the RapidVulnerabilityDetectionSettings resource. In the returned settings response, a missing field only indicates that it was not explicitly set, so no assumption should be made about these fields. In other words, GetRapidVulnerabilityDetectionSettings does not calculate the effective service settings for the resource, which accounts for inherited settings and defaults. Instead, use CalculateRapidVulnerabilityDetectionSettings for this purpose.
+  
 
 Args:
-  name: string, Required. The name of the RapidVulnerabilityDetectionSettings to retrieve. Formats: * organizations/{organization}/rapidVulnerabilityDetectionSettings * folders/{folder}/rapidVulnerabilityDetectionSettings * projects/{project}/rapidVulnerabilityDetectionSettings (required)
+  name: string, A parameter (required)
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -228,27 +228,27 @@ 

Method Details

Returns: An object of the form: - { # Resource capturing the settings for the Rapid Vulnerability Detection service. - "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's. - "a_key": { # Configuration of a module. - "moduleEnablementState": "A String", # The state of enablement for the module at its level of the resource hierarchy. - "value": { # The configuration value for the module. The absence of this field implies its inheritance from the parent. + { + "modules": { + "a_key": { + "moduleEnablementState": "A String", + "value": { "a_key": "", # Properties of the object. }, }, }, - "name": "A String", # The resource name of the RapidVulnerabilityDetectionSettings. Formats: * organizations/{organization}/rapidVulnerabilityDetectionSettings * folders/{folder}/rapidVulnerabilityDetectionSettings * projects/{project}/rapidVulnerabilityDetectionSettings - "serviceEnablementState": "A String", # The state of enablement for the service at its level of the resource hierarchy. A DISABLED state will override all module enablement_states to DISABLED. - "updateTime": "A String", # Output only. The time the settings were last updated. + "name": "A String", + "serviceEnablementState": "A String", + "updateTime": "A String", }
getSecurityCenterSettings(name, x__xgafv=None) -
Get the SecurityCenterSettings resource.
+  
 
 Args:
-  name: string, Required. The name of the SecurityCenterSettings to retrieve. Format: organizations/{organization}/securityCenterSettings Format: folders/{folder}/securityCenterSettings Format: projects/{project}/securityCenterSettings (required)
+  name: string, A parameter (required)
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -257,21 +257,21 @@ 

Method Details

Returns: An object of the form: - { # Resource capturing the settings for Security Center. - "cryptoKeyName": "A String", # The KMS key name used for CMEK encryption. Format: projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{key_name} - "logSinkProject": "A String", # The resource name of the project to send logs to. This project must be part of the organization this resource resides in. The format is `projects/{project_id}`. An empty value disables logging. This value is only referenced by services that support log sink. Please refer to the documentation for an updated list of compatible services. This may only be specified for organization level onboarding. - "name": "A String", # The resource name of the SecurityCenterSettings. Format: organizations/{organization}/securityCenterSettings Format: folders/{folder}/securityCenterSettings Format: projects/{project}/securityCenterSettings - "onboardingTime": "A String", # Output only. Timestamp of when the customer organization was onboarded to SCC. - "orgServiceAccount": "A String", # Output only. The organization level service account to be used for security center components. + { + "cryptoKeyName": "A String", + "logSinkProject": "A String", + "name": "A String", + "onboardingTime": "A String", + "orgServiceAccount": "A String", }
getSecurityHealthAnalyticsSettings(name, x__xgafv=None) -
Get the SecurityHealthAnalyticsSettings resource. In the returned settings response, a missing field only indicates that it was not explicitly set, so no assumption should be made about these fields. In other words, GetSecurityHealthAnalyticsSettings does not calculate the effective service settings for the resource, which accounts for inherited settings and defaults. Instead, use CalculateSecurityHealthAnalyticsSettings for this purpose.
+  
 
 Args:
-  name: string, Required. The name of the SecurityHealthAnalyticsSettings to retrieve. Formats: * organizations/{organization}/securityHealthAnalyticsSettings * folders/{folder}/securityHealthAnalyticsSettings * projects/{project}/securityHealthAnalyticsSettings (required)
+  name: string, A parameter (required)
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -280,28 +280,28 @@ 

Method Details

Returns: An object of the form: - { # Resource capturing the settings for the Security Health Analytics service. - "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's configuration. - "a_key": { # Configuration of a module. - "moduleEnablementState": "A String", # The state of enablement for the module at its level of the resource hierarchy. - "value": { # The configuration value for the module. The absence of this field implies its inheritance from the parent. + { + "modules": { + "a_key": { + "moduleEnablementState": "A String", + "value": { "a_key": "", # Properties of the object. }, }, }, - "name": "A String", # Identifier. The resource name of the SecurityHealthAnalyticsSettings. Formats: * organizations/{organization}/securityHealthAnalyticsSettings * folders/{folder}/securityHealthAnalyticsSettings * projects/{project}/securityHealthAnalyticsSettings - "serviceAccount": "A String", # Output only. The service account used by Security Health Analytics detectors. - "serviceEnablementState": "A String", # The state of enablement for the service at its level of the resource hierarchy. A DISABLED state will override all module enablement_states to DISABLED. - "updateTime": "A String", # Output only. The time the settings were last updated. + "name": "A String", + "serviceAccount": "A String", + "serviceEnablementState": "A String", + "updateTime": "A String", }
getSubscription(name, x__xgafv=None) -
Get the Subscription resource.
+  
 
 Args:
-  name: string, Required. The name of the subscription to retrieve. Format: organizations/{organization}/subscription (required)
+  name: string, A parameter (required)
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -310,23 +310,23 @@ 

Method Details

Returns: An object of the form: - { # Resource capturing the state of an organization's subscription. - "details": { # Details of a subscription. # The details of the most recent active subscription. If there has never been a subscription this will be empty. - "endTime": "A String", # The time the subscription has or will end. - "startTime": "A String", # The time the subscription has or will start. - "type": "A String", # The type of subscription + { + "details": { + "endTime": "A String", + "startTime": "A String", + "type": "A String", }, - "name": "A String", # The resource name of the subscription. Format: organizations/{organization}/subscription - "tier": "A String", # The tier of SCC features this organization currently has access to. + "name": "A String", + "tier": "A String", }
getVirtualMachineThreatDetectionSettings(name, x__xgafv=None) -
Get the VirtualMachineThreatDetectionSettings resource. In the returned settings response, a missing field only indicates that it was not explicitly set, so no assumption should be made about these fields. In other words, GetVirtualMachineThreatDetectionSettings does not calculate the effective service settings for the resource, which accounts for inherited settings and defaults. Instead, use CalculateVirtualMachineThreatDetectionSettings for this purpose.
+  
 
 Args:
-  name: string, Required. The name of the VirtualMachineThreatDetectionSettings to retrieve. Formats: * organizations/{organization}/virtualMachineThreatDetectionSettings * folders/{folder}/virtualMachineThreatDetectionSettings * projects/{project}/virtualMachineThreatDetectionSettings (required)
+  name: string, A parameter (required)
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -335,28 +335,28 @@ 

Method Details

Returns: An object of the form: - { # Resource capturing the settings for the Virtual Machine Threat Detection service. - "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's configuration. - "a_key": { # Configuration of a module. - "moduleEnablementState": "A String", # The state of enablement for the module at its level of the resource hierarchy. - "value": { # The configuration value for the module. The absence of this field implies its inheritance from the parent. + { + "modules": { + "a_key": { + "moduleEnablementState": "A String", + "value": { "a_key": "", # Properties of the object. }, }, }, - "name": "A String", # Identifier. The resource name of the VirtualMachineThreatDetectionSettings. Formats: * organizations/{organization}/virtualMachineThreatDetectionSettings * folders/{folder}/virtualMachineThreatDetectionSettings * projects/{project}/virtualMachineThreatDetectionSettings - "serviceAccount": "A String", # Output only. The service account used by Virtual Machine Threat Detection detectors. - "serviceEnablementState": "A String", # The state of enablement for the service at its level of the resource hierarchy. A DISABLED state will override all module enablement_states to DISABLED. - "updateTime": "A String", # Output only. The time the settings were last updated. + "name": "A String", + "serviceAccount": "A String", + "serviceEnablementState": "A String", + "updateTime": "A String", }
getWebSecurityScannerSettings(name, x__xgafv=None) -
Get the WebSecurityScannerSettings resource. In the returned settings response, a missing field only indicates that it was not explicitly set, so no assumption should be made about these fields. In other words, GetWebSecurityScannerSettings does not calculate the effective service settings for the resource, which accounts for inherited settings and defaults. Instead, use CalculateWebSecurityScannerSettings for this purpose.
+  
 
 Args:
-  name: string, Required. The name of the WebSecurityScannerSettings to retrieve. Formats: * organizations/{organization}/webSecurityScannerSettings * folders/{folder}/webSecurityScannerSettings * projects/{project}/webSecurityScannerSettings (required)
+  name: string, A parameter (required)
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -365,46 +365,46 @@ 

Method Details

Returns: An object of the form: - { # Resource capturing the settings for the Web Security Scanner service. - "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's configuration. - "a_key": { # Configuration of a module. - "moduleEnablementState": "A String", # The state of enablement for the module at its level of the resource hierarchy. - "value": { # The configuration value for the module. The absence of this field implies its inheritance from the parent. + { + "modules": { + "a_key": { + "moduleEnablementState": "A String", + "value": { "a_key": "", # Properties of the object. }, }, }, - "name": "A String", # Identifier. The resource name of the WebSecurityScannerSettings. Formats: * organizations/{organization}/webSecurityScannerSettings * folders/{folder}/webSecurityScannerSettings * projects/{project}/webSecurityScannerSettings - "serviceEnablementState": "A String", # The state of enablement for the service at its level of the resource hierarchy. A DISABLED state will override all module enablement_states to DISABLED. - "updateTime": "A String", # Output only. The time the settings were last updated. + "name": "A String", + "serviceEnablementState": "A String", + "updateTime": "A String", }
updateContainerThreatDetectionSettings(name, body=None, updateMask=None, x__xgafv=None) -
Update the ContainerThreatDetectionSettings resource.
+  
 
 Args:
-  name: string, Identifier. The resource name of the ContainerThreatDetectionSettings. Formats: * organizations/{organization}/containerThreatDetectionSettings * folders/{folder}/containerThreatDetectionSettings * projects/{project}/containerThreatDetectionSettings * projects/{project}/locations/{location}/clusters/{cluster}/containerThreatDetectionSettings (required)
+  name: string, A parameter (required)
   body: object, The request body.
     The object takes the form of:
 
-{ # Resource capturing the settings for the Container Threat Detection service.
-  "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's configuration.
-    "a_key": { # Configuration of a module.
-      "moduleEnablementState": "A String", # The state of enablement for the module at its level of the resource hierarchy.
-      "value": { # The configuration value for the module. The absence of this field implies its inheritance from the parent.
+{
+  "modules": {
+    "a_key": {
+      "moduleEnablementState": "A String",
+      "value": {
         "a_key": "", # Properties of the object.
       },
     },
   },
-  "name": "A String", # Identifier. The resource name of the ContainerThreatDetectionSettings. Formats: * organizations/{organization}/containerThreatDetectionSettings * folders/{folder}/containerThreatDetectionSettings * projects/{project}/containerThreatDetectionSettings * projects/{project}/locations/{location}/clusters/{cluster}/containerThreatDetectionSettings
-  "serviceAccount": "A String", # Output only. The service account used by Container Threat Detection for scanning. Service accounts are scoped at the project level meaning this field will be empty at any level above a project.
-  "serviceEnablementState": "A String", # The state of enablement for the service at its level of the resource hierarchy. A DISABLED state will override all module enablement_states to DISABLED.
-  "updateTime": "A String", # Output only. The time the settings were last updated.
+  "name": "A String",
+  "serviceAccount": "A String",
+  "serviceEnablementState": "A String",
+  "updateTime": "A String",
 }
 
-  updateMask: string, The list of fields to be updated.
+  updateMask: string, A parameter
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -413,46 +413,46 @@ 

Method Details

Returns: An object of the form: - { # Resource capturing the settings for the Container Threat Detection service. - "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's configuration. - "a_key": { # Configuration of a module. - "moduleEnablementState": "A String", # The state of enablement for the module at its level of the resource hierarchy. - "value": { # The configuration value for the module. The absence of this field implies its inheritance from the parent. + { + "modules": { + "a_key": { + "moduleEnablementState": "A String", + "value": { "a_key": "", # Properties of the object. }, }, }, - "name": "A String", # Identifier. The resource name of the ContainerThreatDetectionSettings. Formats: * organizations/{organization}/containerThreatDetectionSettings * folders/{folder}/containerThreatDetectionSettings * projects/{project}/containerThreatDetectionSettings * projects/{project}/locations/{location}/clusters/{cluster}/containerThreatDetectionSettings - "serviceAccount": "A String", # Output only. The service account used by Container Threat Detection for scanning. Service accounts are scoped at the project level meaning this field will be empty at any level above a project. - "serviceEnablementState": "A String", # The state of enablement for the service at its level of the resource hierarchy. A DISABLED state will override all module enablement_states to DISABLED. - "updateTime": "A String", # Output only. The time the settings were last updated. + "name": "A String", + "serviceAccount": "A String", + "serviceEnablementState": "A String", + "updateTime": "A String", }
updateEventThreatDetectionSettings(name, body=None, updateMask=None, x__xgafv=None) -
Update the EventThreatDetectionSettings resource.
+  
 
 Args:
-  name: string, Identifier. The resource name of the EventThreatDetectionSettings. Formats: * organizations/{organization}/eventThreatDetectionSettings * folders/{folder}/eventThreatDetectionSettings * projects/{project}/eventThreatDetectionSettings (required)
+  name: string, A parameter (required)
   body: object, The request body.
     The object takes the form of:
 
-{ # Resource capturing the settings for the Event Threat Detection service.
-  "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's configuration.
-    "a_key": { # Configuration of a module.
-      "moduleEnablementState": "A String", # The state of enablement for the module at its level of the resource hierarchy.
-      "value": { # The configuration value for the module. The absence of this field implies its inheritance from the parent.
+{
+  "modules": {
+    "a_key": {
+      "moduleEnablementState": "A String",
+      "value": {
         "a_key": "", # Properties of the object.
       },
     },
   },
-  "name": "A String", # Identifier. The resource name of the EventThreatDetectionSettings. Formats: * organizations/{organization}/eventThreatDetectionSettings * folders/{folder}/eventThreatDetectionSettings * projects/{project}/eventThreatDetectionSettings
-  "serviceEnablementState": "A String", # The state of enablement for the service at its level of the resource hierarchy. A DISABLED state will override all module enablement_states to DISABLED.
-  "updateTime": "A String", # Output only. The time the settings were last updated.
+  "name": "A String",
+  "serviceEnablementState": "A String",
+  "updateTime": "A String",
 }
 
-  updateMask: string, The list of fields to be updated.
+  updateMask: string, A parameter
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -461,45 +461,45 @@ 

Method Details

Returns: An object of the form: - { # Resource capturing the settings for the Event Threat Detection service. - "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's configuration. - "a_key": { # Configuration of a module. - "moduleEnablementState": "A String", # The state of enablement for the module at its level of the resource hierarchy. - "value": { # The configuration value for the module. The absence of this field implies its inheritance from the parent. + { + "modules": { + "a_key": { + "moduleEnablementState": "A String", + "value": { "a_key": "", # Properties of the object. }, }, }, - "name": "A String", # Identifier. The resource name of the EventThreatDetectionSettings. Formats: * organizations/{organization}/eventThreatDetectionSettings * folders/{folder}/eventThreatDetectionSettings * projects/{project}/eventThreatDetectionSettings - "serviceEnablementState": "A String", # The state of enablement for the service at its level of the resource hierarchy. A DISABLED state will override all module enablement_states to DISABLED. - "updateTime": "A String", # Output only. The time the settings were last updated. + "name": "A String", + "serviceEnablementState": "A String", + "updateTime": "A String", }
updateRapidVulnerabilityDetectionSettings(name, body=None, updateMask=None, x__xgafv=None) -
Update the RapidVulnerabilityDetectionSettings resource.
+  
 
 Args:
-  name: string, The resource name of the RapidVulnerabilityDetectionSettings. Formats: * organizations/{organization}/rapidVulnerabilityDetectionSettings * folders/{folder}/rapidVulnerabilityDetectionSettings * projects/{project}/rapidVulnerabilityDetectionSettings (required)
+  name: string, A parameter (required)
   body: object, The request body.
     The object takes the form of:
 
-{ # Resource capturing the settings for the Rapid Vulnerability Detection service.
-  "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's.
-    "a_key": { # Configuration of a module.
-      "moduleEnablementState": "A String", # The state of enablement for the module at its level of the resource hierarchy.
-      "value": { # The configuration value for the module. The absence of this field implies its inheritance from the parent.
+{
+  "modules": {
+    "a_key": {
+      "moduleEnablementState": "A String",
+      "value": {
         "a_key": "", # Properties of the object.
       },
     },
   },
-  "name": "A String", # The resource name of the RapidVulnerabilityDetectionSettings. Formats: * organizations/{organization}/rapidVulnerabilityDetectionSettings * folders/{folder}/rapidVulnerabilityDetectionSettings * projects/{project}/rapidVulnerabilityDetectionSettings
-  "serviceEnablementState": "A String", # The state of enablement for the service at its level of the resource hierarchy. A DISABLED state will override all module enablement_states to DISABLED.
-  "updateTime": "A String", # Output only. The time the settings were last updated.
+  "name": "A String",
+  "serviceEnablementState": "A String",
+  "updateTime": "A String",
 }
 
-  updateMask: string, The list of fields to be updated.
+  updateMask: string, A parameter
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -508,46 +508,46 @@ 

Method Details

Returns: An object of the form: - { # Resource capturing the settings for the Rapid Vulnerability Detection service. - "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's. - "a_key": { # Configuration of a module. - "moduleEnablementState": "A String", # The state of enablement for the module at its level of the resource hierarchy. - "value": { # The configuration value for the module. The absence of this field implies its inheritance from the parent. + { + "modules": { + "a_key": { + "moduleEnablementState": "A String", + "value": { "a_key": "", # Properties of the object. }, }, }, - "name": "A String", # The resource name of the RapidVulnerabilityDetectionSettings. Formats: * organizations/{organization}/rapidVulnerabilityDetectionSettings * folders/{folder}/rapidVulnerabilityDetectionSettings * projects/{project}/rapidVulnerabilityDetectionSettings - "serviceEnablementState": "A String", # The state of enablement for the service at its level of the resource hierarchy. A DISABLED state will override all module enablement_states to DISABLED. - "updateTime": "A String", # Output only. The time the settings were last updated. + "name": "A String", + "serviceEnablementState": "A String", + "updateTime": "A String", }
updateSecurityHealthAnalyticsSettings(name, body=None, updateMask=None, x__xgafv=None) -
Update the SecurityHealthAnalyticsSettings resource.
+  
 
 Args:
-  name: string, Identifier. The resource name of the SecurityHealthAnalyticsSettings. Formats: * organizations/{organization}/securityHealthAnalyticsSettings * folders/{folder}/securityHealthAnalyticsSettings * projects/{project}/securityHealthAnalyticsSettings (required)
+  name: string, A parameter (required)
   body: object, The request body.
     The object takes the form of:
 
-{ # Resource capturing the settings for the Security Health Analytics service.
-  "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's configuration.
-    "a_key": { # Configuration of a module.
-      "moduleEnablementState": "A String", # The state of enablement for the module at its level of the resource hierarchy.
-      "value": { # The configuration value for the module. The absence of this field implies its inheritance from the parent.
+{
+  "modules": {
+    "a_key": {
+      "moduleEnablementState": "A String",
+      "value": {
         "a_key": "", # Properties of the object.
       },
     },
   },
-  "name": "A String", # Identifier. The resource name of the SecurityHealthAnalyticsSettings. Formats: * organizations/{organization}/securityHealthAnalyticsSettings * folders/{folder}/securityHealthAnalyticsSettings * projects/{project}/securityHealthAnalyticsSettings
-  "serviceAccount": "A String", # Output only. The service account used by Security Health Analytics detectors.
-  "serviceEnablementState": "A String", # The state of enablement for the service at its level of the resource hierarchy. A DISABLED state will override all module enablement_states to DISABLED.
-  "updateTime": "A String", # Output only. The time the settings were last updated.
+  "name": "A String",
+  "serviceAccount": "A String",
+  "serviceEnablementState": "A String",
+  "updateTime": "A String",
 }
 
-  updateMask: string, The list of fields to be updated.
+  updateMask: string, A parameter
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -556,47 +556,47 @@ 

Method Details

Returns: An object of the form: - { # Resource capturing the settings for the Security Health Analytics service. - "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's configuration. - "a_key": { # Configuration of a module. - "moduleEnablementState": "A String", # The state of enablement for the module at its level of the resource hierarchy. - "value": { # The configuration value for the module. The absence of this field implies its inheritance from the parent. + { + "modules": { + "a_key": { + "moduleEnablementState": "A String", + "value": { "a_key": "", # Properties of the object. }, }, }, - "name": "A String", # Identifier. The resource name of the SecurityHealthAnalyticsSettings. Formats: * organizations/{organization}/securityHealthAnalyticsSettings * folders/{folder}/securityHealthAnalyticsSettings * projects/{project}/securityHealthAnalyticsSettings - "serviceAccount": "A String", # Output only. The service account used by Security Health Analytics detectors. - "serviceEnablementState": "A String", # The state of enablement for the service at its level of the resource hierarchy. A DISABLED state will override all module enablement_states to DISABLED. - "updateTime": "A String", # Output only. The time the settings were last updated. + "name": "A String", + "serviceAccount": "A String", + "serviceEnablementState": "A String", + "updateTime": "A String", }
updateVirtualMachineThreatDetectionSettings(name, body=None, updateMask=None, x__xgafv=None) -
Update the VirtualMachineThreatDetectionSettings resource.
+  
 
 Args:
-  name: string, Identifier. The resource name of the VirtualMachineThreatDetectionSettings. Formats: * organizations/{organization}/virtualMachineThreatDetectionSettings * folders/{folder}/virtualMachineThreatDetectionSettings * projects/{project}/virtualMachineThreatDetectionSettings (required)
+  name: string, A parameter (required)
   body: object, The request body.
     The object takes the form of:
 
-{ # Resource capturing the settings for the Virtual Machine Threat Detection service.
-  "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's configuration.
-    "a_key": { # Configuration of a module.
-      "moduleEnablementState": "A String", # The state of enablement for the module at its level of the resource hierarchy.
-      "value": { # The configuration value for the module. The absence of this field implies its inheritance from the parent.
+{
+  "modules": {
+    "a_key": {
+      "moduleEnablementState": "A String",
+      "value": {
         "a_key": "", # Properties of the object.
       },
     },
   },
-  "name": "A String", # Identifier. The resource name of the VirtualMachineThreatDetectionSettings. Formats: * organizations/{organization}/virtualMachineThreatDetectionSettings * folders/{folder}/virtualMachineThreatDetectionSettings * projects/{project}/virtualMachineThreatDetectionSettings
-  "serviceAccount": "A String", # Output only. The service account used by Virtual Machine Threat Detection detectors.
-  "serviceEnablementState": "A String", # The state of enablement for the service at its level of the resource hierarchy. A DISABLED state will override all module enablement_states to DISABLED.
-  "updateTime": "A String", # Output only. The time the settings were last updated.
+  "name": "A String",
+  "serviceAccount": "A String",
+  "serviceEnablementState": "A String",
+  "updateTime": "A String",
 }
 
-  updateMask: string, The list of fields to be updated.
+  updateMask: string, A parameter
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -605,46 +605,46 @@ 

Method Details

Returns: An object of the form: - { # Resource capturing the settings for the Virtual Machine Threat Detection service. - "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's configuration. - "a_key": { # Configuration of a module. - "moduleEnablementState": "A String", # The state of enablement for the module at its level of the resource hierarchy. - "value": { # The configuration value for the module. The absence of this field implies its inheritance from the parent. + { + "modules": { + "a_key": { + "moduleEnablementState": "A String", + "value": { "a_key": "", # Properties of the object. }, }, }, - "name": "A String", # Identifier. The resource name of the VirtualMachineThreatDetectionSettings. Formats: * organizations/{organization}/virtualMachineThreatDetectionSettings * folders/{folder}/virtualMachineThreatDetectionSettings * projects/{project}/virtualMachineThreatDetectionSettings - "serviceAccount": "A String", # Output only. The service account used by Virtual Machine Threat Detection detectors. - "serviceEnablementState": "A String", # The state of enablement for the service at its level of the resource hierarchy. A DISABLED state will override all module enablement_states to DISABLED. - "updateTime": "A String", # Output only. The time the settings were last updated. + "name": "A String", + "serviceAccount": "A String", + "serviceEnablementState": "A String", + "updateTime": "A String", }
updateWebSecurityScannerSettings(name, body=None, updateMask=None, x__xgafv=None) -
Update the WebSecurityScannerSettings resource.
+  
 
 Args:
-  name: string, Identifier. The resource name of the WebSecurityScannerSettings. Formats: * organizations/{organization}/webSecurityScannerSettings * folders/{folder}/webSecurityScannerSettings * projects/{project}/webSecurityScannerSettings (required)
+  name: string, A parameter (required)
   body: object, The request body.
     The object takes the form of:
 
-{ # Resource capturing the settings for the Web Security Scanner service.
-  "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's configuration.
-    "a_key": { # Configuration of a module.
-      "moduleEnablementState": "A String", # The state of enablement for the module at its level of the resource hierarchy.
-      "value": { # The configuration value for the module. The absence of this field implies its inheritance from the parent.
+{
+  "modules": {
+    "a_key": {
+      "moduleEnablementState": "A String",
+      "value": {
         "a_key": "", # Properties of the object.
       },
     },
   },
-  "name": "A String", # Identifier. The resource name of the WebSecurityScannerSettings. Formats: * organizations/{organization}/webSecurityScannerSettings * folders/{folder}/webSecurityScannerSettings * projects/{project}/webSecurityScannerSettings
-  "serviceEnablementState": "A String", # The state of enablement for the service at its level of the resource hierarchy. A DISABLED state will override all module enablement_states to DISABLED.
-  "updateTime": "A String", # Output only. The time the settings were last updated.
+  "name": "A String",
+  "serviceEnablementState": "A String",
+  "updateTime": "A String",
 }
 
-  updateMask: string, The list of fields to be updated.
+  updateMask: string, A parameter
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -653,18 +653,18 @@ 

Method Details

Returns: An object of the form: - { # Resource capturing the settings for the Web Security Scanner service. - "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's configuration. - "a_key": { # Configuration of a module. - "moduleEnablementState": "A String", # The state of enablement for the module at its level of the resource hierarchy. - "value": { # The configuration value for the module. The absence of this field implies its inheritance from the parent. + { + "modules": { + "a_key": { + "moduleEnablementState": "A String", + "value": { "a_key": "", # Properties of the object. }, }, }, - "name": "A String", # Identifier. The resource name of the WebSecurityScannerSettings. Formats: * organizations/{organization}/webSecurityScannerSettings * folders/{folder}/webSecurityScannerSettings * projects/{project}/webSecurityScannerSettings - "serviceEnablementState": "A String", # The state of enablement for the service at its level of the resource hierarchy. A DISABLED state will override all module enablement_states to DISABLED. - "updateTime": "A String", # Output only. The time the settings were last updated. + "name": "A String", + "serviceEnablementState": "A String", + "updateTime": "A String", }
diff --git a/docs/dyn/securitycenter_v1beta2.organizations.rapidVulnerabilityDetectionSettings.html b/docs/dyn/securitycenter_v1beta2.organizations.rapidVulnerabilityDetectionSettings.html index 24c07ef161..554c7f4bbc 100644 --- a/docs/dyn/securitycenter_v1beta2.organizations.rapidVulnerabilityDetectionSettings.html +++ b/docs/dyn/securitycenter_v1beta2.organizations.rapidVulnerabilityDetectionSettings.html @@ -76,17 +76,17 @@

Security Command Center API . Instance Methods

calculate(name, x__xgafv=None)

-

Calculates the effective RapidVulnerabilityDetectionSettings based on its level in the resource hierarchy and its settings. Settings provided closer to the target resource take precedence over those further away (e.g. folder will override organization level settings). The default SCC setting for the detector service defaults can be overridden at organization, folder and project levels. No assumptions should be made about the SCC defaults as it is considered an internal implementation detail.

+

close()

Close httplib2 connections.

Method Details

calculate(name, x__xgafv=None) -
Calculates the effective RapidVulnerabilityDetectionSettings based on its level in the resource hierarchy and its settings. Settings provided closer to the target resource take precedence over those further away (e.g. folder will override organization level settings). The default SCC setting for the detector service defaults can be overridden at organization, folder and project levels. No assumptions should be made about the SCC defaults as it is considered an internal implementation detail.
+  
 
 Args:
-  name: string, Required. The name of the RapidVulnerabilityDetectionSettings to calculate. Formats: * organizations/{organization}/rapidVulnerabilityDetectionSettings * folders/{folder}/rapidVulnerabilityDetectionSettings * projects/{project}/rapidVulnerabilityDetectionSettings (required)
+  name: string, A parameter (required)
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -95,18 +95,18 @@ 

Method Details

Returns: An object of the form: - { # Resource capturing the settings for the Rapid Vulnerability Detection service. - "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's. - "a_key": { # Configuration of a module. - "moduleEnablementState": "A String", # The state of enablement for the module at its level of the resource hierarchy. - "value": { # The configuration value for the module. The absence of this field implies its inheritance from the parent. + { + "modules": { + "a_key": { + "moduleEnablementState": "A String", + "value": { "a_key": "", # Properties of the object. }, }, }, - "name": "A String", # The resource name of the RapidVulnerabilityDetectionSettings. Formats: * organizations/{organization}/rapidVulnerabilityDetectionSettings * folders/{folder}/rapidVulnerabilityDetectionSettings * projects/{project}/rapidVulnerabilityDetectionSettings - "serviceEnablementState": "A String", # The state of enablement for the service at its level of the resource hierarchy. A DISABLED state will override all module enablement_states to DISABLED. - "updateTime": "A String", # Output only. The time the settings were last updated. + "name": "A String", + "serviceEnablementState": "A String", + "updateTime": "A String", }
diff --git a/docs/dyn/securitycenter_v1beta2.organizations.securityHealthAnalyticsSettings.html b/docs/dyn/securitycenter_v1beta2.organizations.securityHealthAnalyticsSettings.html index 021372012f..2273f15d4c 100644 --- a/docs/dyn/securitycenter_v1beta2.organizations.securityHealthAnalyticsSettings.html +++ b/docs/dyn/securitycenter_v1beta2.organizations.securityHealthAnalyticsSettings.html @@ -76,18 +76,18 @@

Security Command Center API . Instance Methods

calculate(name, showEligibleModulesOnly=None, x__xgafv=None)

-

Calculates the effective SecurityHealthAnalyticsSettings based on its level in the resource hierarchy and its settings. Settings provided closer to the target resource take precedence over those further away (e.g. folder will override organization level settings). The default SCC setting for the detector service defaults can be overridden at organization, folder and project levels. No assumptions should be made about the SCC defaults as it is considered an internal implementation detail.

+

close()

Close httplib2 connections.

Method Details

calculate(name, showEligibleModulesOnly=None, x__xgafv=None) -
Calculates the effective SecurityHealthAnalyticsSettings based on its level in the resource hierarchy and its settings. Settings provided closer to the target resource take precedence over those further away (e.g. folder will override organization level settings). The default SCC setting for the detector service defaults can be overridden at organization, folder and project levels. No assumptions should be made about the SCC defaults as it is considered an internal implementation detail.
+  
 
 Args:
-  name: string, Required. The name of the SecurityHealthAnalyticsSettings to calculate. Formats: * organizations/{organization}/securityHealthAnalyticsSettings * folders/{folder}/securityHealthAnalyticsSettings * projects/{project}/securityHealthAnalyticsSettings (required)
-  showEligibleModulesOnly: boolean, Optional. When set, will only retrieve the modules that are in scope. By default, all modules will be shown.
+  name: string, A parameter (required)
+  showEligibleModulesOnly: boolean, A parameter
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -96,19 +96,19 @@ 

Method Details

Returns: An object of the form: - { # Resource capturing the settings for the Security Health Analytics service. - "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's configuration. - "a_key": { # Configuration of a module. - "moduleEnablementState": "A String", # The state of enablement for the module at its level of the resource hierarchy. - "value": { # The configuration value for the module. The absence of this field implies its inheritance from the parent. + { + "modules": { + "a_key": { + "moduleEnablementState": "A String", + "value": { "a_key": "", # Properties of the object. }, }, }, - "name": "A String", # Identifier. The resource name of the SecurityHealthAnalyticsSettings. Formats: * organizations/{organization}/securityHealthAnalyticsSettings * folders/{folder}/securityHealthAnalyticsSettings * projects/{project}/securityHealthAnalyticsSettings - "serviceAccount": "A String", # Output only. The service account used by Security Health Analytics detectors. - "serviceEnablementState": "A String", # The state of enablement for the service at its level of the resource hierarchy. A DISABLED state will override all module enablement_states to DISABLED. - "updateTime": "A String", # Output only. The time the settings were last updated. + "name": "A String", + "serviceAccount": "A String", + "serviceEnablementState": "A String", + "updateTime": "A String", }
diff --git a/docs/dyn/securitycenter_v1beta2.organizations.virtualMachineThreatDetectionSettings.html b/docs/dyn/securitycenter_v1beta2.organizations.virtualMachineThreatDetectionSettings.html index e10787d65f..6fc9a831f7 100644 --- a/docs/dyn/securitycenter_v1beta2.organizations.virtualMachineThreatDetectionSettings.html +++ b/docs/dyn/securitycenter_v1beta2.organizations.virtualMachineThreatDetectionSettings.html @@ -76,18 +76,18 @@

Security Command Center API . Instance Methods

calculate(name, showEligibleModulesOnly=None, x__xgafv=None)

-

Calculates the effective VirtualMachineThreatDetectionSettings based on its level in the resource hierarchy and its settings. Settings provided closer to the target resource take precedence over those further away (e.g. folder will override organization level settings). The default SCC setting for the detector service defaults can be overridden at organization, folder and project levels. No assumptions should be made about the SCC defaults as it is considered an internal implementation detail.

+

close()

Close httplib2 connections.

Method Details

calculate(name, showEligibleModulesOnly=None, x__xgafv=None) -
Calculates the effective VirtualMachineThreatDetectionSettings based on its level in the resource hierarchy and its settings. Settings provided closer to the target resource take precedence over those further away (e.g. folder will override organization level settings). The default SCC setting for the detector service defaults can be overridden at organization, folder and project levels. No assumptions should be made about the SCC defaults as it is considered an internal implementation detail.
+  
 
 Args:
-  name: string, Required. The name of the VirtualMachineThreatDetectionSettings to calculate. Formats: * organizations/{organization}/virtualMachineThreatDetectionSettings * folders/{folder}/virtualMachineThreatDetectionSettings * projects/{project}/virtualMachineThreatDetectionSettings (required)
-  showEligibleModulesOnly: boolean, Optional. When set, will only retrieve the modules that are in scope. By default, all modules will be shown.
+  name: string, A parameter (required)
+  showEligibleModulesOnly: boolean, A parameter
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -96,19 +96,19 @@ 

Method Details

Returns: An object of the form: - { # Resource capturing the settings for the Virtual Machine Threat Detection service. - "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's configuration. - "a_key": { # Configuration of a module. - "moduleEnablementState": "A String", # The state of enablement for the module at its level of the resource hierarchy. - "value": { # The configuration value for the module. The absence of this field implies its inheritance from the parent. + { + "modules": { + "a_key": { + "moduleEnablementState": "A String", + "value": { "a_key": "", # Properties of the object. }, }, }, - "name": "A String", # Identifier. The resource name of the VirtualMachineThreatDetectionSettings. Formats: * organizations/{organization}/virtualMachineThreatDetectionSettings * folders/{folder}/virtualMachineThreatDetectionSettings * projects/{project}/virtualMachineThreatDetectionSettings - "serviceAccount": "A String", # Output only. The service account used by Virtual Machine Threat Detection detectors. - "serviceEnablementState": "A String", # The state of enablement for the service at its level of the resource hierarchy. A DISABLED state will override all module enablement_states to DISABLED. - "updateTime": "A String", # Output only. The time the settings were last updated. + "name": "A String", + "serviceAccount": "A String", + "serviceEnablementState": "A String", + "updateTime": "A String", }
diff --git a/docs/dyn/securitycenter_v1beta2.organizations.webSecurityScannerSettings.html b/docs/dyn/securitycenter_v1beta2.organizations.webSecurityScannerSettings.html index 05b49d5ec3..1c43919559 100644 --- a/docs/dyn/securitycenter_v1beta2.organizations.webSecurityScannerSettings.html +++ b/docs/dyn/securitycenter_v1beta2.organizations.webSecurityScannerSettings.html @@ -76,18 +76,18 @@

Security Command Center API . Instance Methods

calculate(name, showEligibleModulesOnly=None, x__xgafv=None)

-

Calculates the effective WebSecurityScannerSettings based on its level in the resource hierarchy and its settings. Settings provided closer to the target resource take precedence over those further away (e.g. folder will override organization level settings). The default SCC setting for the detector service defaults can be overridden at organization, folder and project levels. No assumptions should be made about the SCC defaults as it is considered an internal implementation detail.

+

close()

Close httplib2 connections.

Method Details

calculate(name, showEligibleModulesOnly=None, x__xgafv=None) -
Calculates the effective WebSecurityScannerSettings based on its level in the resource hierarchy and its settings. Settings provided closer to the target resource take precedence over those further away (e.g. folder will override organization level settings). The default SCC setting for the detector service defaults can be overridden at organization, folder and project levels. No assumptions should be made about the SCC defaults as it is considered an internal implementation detail.
+  
 
 Args:
-  name: string, Required. The name of the WebSecurityScannerSettings to calculate. Formats: * organizations/{organization}/webSecurityScannerSettings * folders/{folder}/webSecurityScannerSettings * projects/{project}/webSecurityScannerSettings (required)
-  showEligibleModulesOnly: boolean, Optional. When set, will only retrieve the modules that are in scope. By default, all modules will be shown.
+  name: string, A parameter (required)
+  showEligibleModulesOnly: boolean, A parameter
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -96,18 +96,18 @@ 

Method Details

Returns: An object of the form: - { # Resource capturing the settings for the Web Security Scanner service. - "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's configuration. - "a_key": { # Configuration of a module. - "moduleEnablementState": "A String", # The state of enablement for the module at its level of the resource hierarchy. - "value": { # The configuration value for the module. The absence of this field implies its inheritance from the parent. + { + "modules": { + "a_key": { + "moduleEnablementState": "A String", + "value": { "a_key": "", # Properties of the object. }, }, }, - "name": "A String", # Identifier. The resource name of the WebSecurityScannerSettings. Formats: * organizations/{organization}/webSecurityScannerSettings * folders/{folder}/webSecurityScannerSettings * projects/{project}/webSecurityScannerSettings - "serviceEnablementState": "A String", # The state of enablement for the service at its level of the resource hierarchy. A DISABLED state will override all module enablement_states to DISABLED. - "updateTime": "A String", # Output only. The time the settings were last updated. + "name": "A String", + "serviceEnablementState": "A String", + "updateTime": "A String", }
diff --git a/docs/dyn/securitycenter_v1beta2.projects.containerThreatDetectionSettings.html b/docs/dyn/securitycenter_v1beta2.projects.containerThreatDetectionSettings.html index f0ba0ab315..fa0df28130 100644 --- a/docs/dyn/securitycenter_v1beta2.projects.containerThreatDetectionSettings.html +++ b/docs/dyn/securitycenter_v1beta2.projects.containerThreatDetectionSettings.html @@ -76,18 +76,18 @@

Security Command Center API . Instance Methods

calculate(name, showEligibleModulesOnly=None, x__xgafv=None)

-

Calculates the effective ContainerThreatDetectionSettings based on its level in the resource hierarchy and its settings. Settings provided closer to the target resource take precedence over those further away (e.g. folder will override organization level settings). The default SCC setting for the detector service defaults can be overridden at organization, folder and project levels. No assumptions should be made about the SCC defaults as it is considered an internal implementation detail.

+

close()

Close httplib2 connections.

Method Details

calculate(name, showEligibleModulesOnly=None, x__xgafv=None) -
Calculates the effective ContainerThreatDetectionSettings based on its level in the resource hierarchy and its settings. Settings provided closer to the target resource take precedence over those further away (e.g. folder will override organization level settings). The default SCC setting for the detector service defaults can be overridden at organization, folder and project levels. No assumptions should be made about the SCC defaults as it is considered an internal implementation detail.
+  
 
 Args:
-  name: string, Required. The name of the ContainerThreatDetectionSettings to calculate. Formats: * organizations/{organization}/containerThreatDetectionSettings * folders/{folder}/containerThreatDetectionSettings * projects/{project}/containerThreatDetectionSettings * projects/{project}/locations/{location}/clusters/{cluster}/containerThreatDetectionSettings (required)
-  showEligibleModulesOnly: boolean, Optional. When set, will only retrieve the modules that are in scope. By default, all modules will be shown.
+  name: string, A parameter (required)
+  showEligibleModulesOnly: boolean, A parameter
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -96,19 +96,19 @@ 

Method Details

Returns: An object of the form: - { # Resource capturing the settings for the Container Threat Detection service. - "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's configuration. - "a_key": { # Configuration of a module. - "moduleEnablementState": "A String", # The state of enablement for the module at its level of the resource hierarchy. - "value": { # The configuration value for the module. The absence of this field implies its inheritance from the parent. + { + "modules": { + "a_key": { + "moduleEnablementState": "A String", + "value": { "a_key": "", # Properties of the object. }, }, }, - "name": "A String", # Identifier. The resource name of the ContainerThreatDetectionSettings. Formats: * organizations/{organization}/containerThreatDetectionSettings * folders/{folder}/containerThreatDetectionSettings * projects/{project}/containerThreatDetectionSettings * projects/{project}/locations/{location}/clusters/{cluster}/containerThreatDetectionSettings - "serviceAccount": "A String", # Output only. The service account used by Container Threat Detection for scanning. Service accounts are scoped at the project level meaning this field will be empty at any level above a project. - "serviceEnablementState": "A String", # The state of enablement for the service at its level of the resource hierarchy. A DISABLED state will override all module enablement_states to DISABLED. - "updateTime": "A String", # Output only. The time the settings were last updated. + "name": "A String", + "serviceAccount": "A String", + "serviceEnablementState": "A String", + "updateTime": "A String", }
diff --git a/docs/dyn/securitycenter_v1beta2.projects.eventThreatDetectionSettings.html b/docs/dyn/securitycenter_v1beta2.projects.eventThreatDetectionSettings.html index 397a13ac2d..d4c1b0c80d 100644 --- a/docs/dyn/securitycenter_v1beta2.projects.eventThreatDetectionSettings.html +++ b/docs/dyn/securitycenter_v1beta2.projects.eventThreatDetectionSettings.html @@ -76,18 +76,18 @@

Security Command Center API . Instance Methods

calculate(name, showEligibleModulesOnly=None, x__xgafv=None)

-

Calculates the effective EventThreatDetectionSettings based on its level in the resource hierarchy and its settings. Settings provided closer to the target resource take precedence over those further away (e.g. folder will override organization level settings). The default SCC setting for the detector service defaults can be overridden at organization, folder and project levels. No assumptions should be made about the SCC defaults as it is considered an internal implementation detail.

+

close()

Close httplib2 connections.

Method Details

calculate(name, showEligibleModulesOnly=None, x__xgafv=None) -
Calculates the effective EventThreatDetectionSettings based on its level in the resource hierarchy and its settings. Settings provided closer to the target resource take precedence over those further away (e.g. folder will override organization level settings). The default SCC setting for the detector service defaults can be overridden at organization, folder and project levels. No assumptions should be made about the SCC defaults as it is considered an internal implementation detail.
+  
 
 Args:
-  name: string, Required. The name of the EventThreatDetectionSettings to calculate. Formats: * organizations/{organization}/eventThreatDetectionSettings * folders/{folder}/eventThreatDetectionSettings * projects/{project}/eventThreatDetectionSettings (required)
-  showEligibleModulesOnly: boolean, Optional. When set, will only retrieve the modules that are in scope. By default, all modules will be shown.
+  name: string, A parameter (required)
+  showEligibleModulesOnly: boolean, A parameter
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -96,18 +96,18 @@ 

Method Details

Returns: An object of the form: - { # Resource capturing the settings for the Event Threat Detection service. - "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's configuration. - "a_key": { # Configuration of a module. - "moduleEnablementState": "A String", # The state of enablement for the module at its level of the resource hierarchy. - "value": { # The configuration value for the module. The absence of this field implies its inheritance from the parent. + { + "modules": { + "a_key": { + "moduleEnablementState": "A String", + "value": { "a_key": "", # Properties of the object. }, }, }, - "name": "A String", # Identifier. The resource name of the EventThreatDetectionSettings. Formats: * organizations/{organization}/eventThreatDetectionSettings * folders/{folder}/eventThreatDetectionSettings * projects/{project}/eventThreatDetectionSettings - "serviceEnablementState": "A String", # The state of enablement for the service at its level of the resource hierarchy. A DISABLED state will override all module enablement_states to DISABLED. - "updateTime": "A String", # Output only. The time the settings were last updated. + "name": "A String", + "serviceEnablementState": "A String", + "updateTime": "A String", }
diff --git a/docs/dyn/securitycenter_v1beta2.projects.html b/docs/dyn/securitycenter_v1beta2.projects.html index e43655beab..13ea48dc75 100644 --- a/docs/dyn/securitycenter_v1beta2.projects.html +++ b/docs/dyn/securitycenter_v1beta2.projects.html @@ -114,43 +114,43 @@

Instance Methods

Close httplib2 connections.

getContainerThreatDetectionSettings(name, x__xgafv=None)

-

Get the ContainerThreatDetectionSettings resource. In the returned settings response, a missing field only indicates that it was not explicitly set, so no assumption should be made about these fields. In other words, GetContainerThreatDetectionSettings does not calculate the effective service settings for the resource, which accounts for inherited settings and defaults. Instead, use CalculateContainerThreatDetectionSettings for this purpose.

+

getEventThreatDetectionSettings(name, x__xgafv=None)

-

Get the EventThreatDetectionSettings resource. In the returned settings response, a missing field only indicates that it was not explicitly set, so no assumption should be made about these fields. In other words, GetEventThreatDetectionSettings does not calculate the effective service settings for the resource, which accounts for inherited settings and defaults. Instead, use CalculateEventThreatDetectionSettings for this purpose.

+

getRapidVulnerabilityDetectionSettings(name, x__xgafv=None)

-

Get the RapidVulnerabilityDetectionSettings resource. In the returned settings response, a missing field only indicates that it was not explicitly set, so no assumption should be made about these fields. In other words, GetRapidVulnerabilityDetectionSettings does not calculate the effective service settings for the resource, which accounts for inherited settings and defaults. Instead, use CalculateRapidVulnerabilityDetectionSettings for this purpose.

+

getSecurityCenterSettings(name, x__xgafv=None)

-

Get the SecurityCenterSettings resource.

+

getSecurityHealthAnalyticsSettings(name, x__xgafv=None)

-

Get the SecurityHealthAnalyticsSettings resource. In the returned settings response, a missing field only indicates that it was not explicitly set, so no assumption should be made about these fields. In other words, GetSecurityHealthAnalyticsSettings does not calculate the effective service settings for the resource, which accounts for inherited settings and defaults. Instead, use CalculateSecurityHealthAnalyticsSettings for this purpose.

+

getVirtualMachineThreatDetectionSettings(name, x__xgafv=None)

-

Get the VirtualMachineThreatDetectionSettings resource. In the returned settings response, a missing field only indicates that it was not explicitly set, so no assumption should be made about these fields. In other words, GetVirtualMachineThreatDetectionSettings does not calculate the effective service settings for the resource, which accounts for inherited settings and defaults. Instead, use CalculateVirtualMachineThreatDetectionSettings for this purpose.

+

getWebSecurityScannerSettings(name, x__xgafv=None)

-

Get the WebSecurityScannerSettings resource. In the returned settings response, a missing field only indicates that it was not explicitly set, so no assumption should be made about these fields. In other words, GetWebSecurityScannerSettings does not calculate the effective service settings for the resource, which accounts for inherited settings and defaults. Instead, use CalculateWebSecurityScannerSettings for this purpose.

+

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

-

Update the ContainerThreatDetectionSettings resource.

+

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

-

Update the EventThreatDetectionSettings resource.

+

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

-

Update the RapidVulnerabilityDetectionSettings resource.

+

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

-

Update the SecurityHealthAnalyticsSettings resource.

+

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

-

Update the VirtualMachineThreatDetectionSettings resource.

+

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

-

Update the WebSecurityScannerSettings resource.

+

Method Details

close() @@ -159,10 +159,10 @@

Method Details

getContainerThreatDetectionSettings(name, x__xgafv=None) -
Get the ContainerThreatDetectionSettings resource. In the returned settings response, a missing field only indicates that it was not explicitly set, so no assumption should be made about these fields. In other words, GetContainerThreatDetectionSettings does not calculate the effective service settings for the resource, which accounts for inherited settings and defaults. Instead, use CalculateContainerThreatDetectionSettings for this purpose.
+  
 
 Args:
-  name: string, Required. The name of the ContainerThreatDetectionSettings to retrieve. Formats: * organizations/{organization}/containerThreatDetectionSettings * folders/{folder}/containerThreatDetectionSettings * projects/{project}/containerThreatDetectionSettings * projects/{project}/locations/{location}/clusters/{cluster}/containerThreatDetectionSettings (required)
+  name: string, A parameter (required)
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -171,28 +171,28 @@ 

Method Details

Returns: An object of the form: - { # Resource capturing the settings for the Container Threat Detection service. - "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's configuration. - "a_key": { # Configuration of a module. - "moduleEnablementState": "A String", # The state of enablement for the module at its level of the resource hierarchy. - "value": { # The configuration value for the module. The absence of this field implies its inheritance from the parent. + { + "modules": { + "a_key": { + "moduleEnablementState": "A String", + "value": { "a_key": "", # Properties of the object. }, }, }, - "name": "A String", # Identifier. The resource name of the ContainerThreatDetectionSettings. Formats: * organizations/{organization}/containerThreatDetectionSettings * folders/{folder}/containerThreatDetectionSettings * projects/{project}/containerThreatDetectionSettings * projects/{project}/locations/{location}/clusters/{cluster}/containerThreatDetectionSettings - "serviceAccount": "A String", # Output only. The service account used by Container Threat Detection for scanning. Service accounts are scoped at the project level meaning this field will be empty at any level above a project. - "serviceEnablementState": "A String", # The state of enablement for the service at its level of the resource hierarchy. A DISABLED state will override all module enablement_states to DISABLED. - "updateTime": "A String", # Output only. The time the settings were last updated. + "name": "A String", + "serviceAccount": "A String", + "serviceEnablementState": "A String", + "updateTime": "A String", }
getEventThreatDetectionSettings(name, x__xgafv=None) -
Get the EventThreatDetectionSettings resource. In the returned settings response, a missing field only indicates that it was not explicitly set, so no assumption should be made about these fields. In other words, GetEventThreatDetectionSettings does not calculate the effective service settings for the resource, which accounts for inherited settings and defaults. Instead, use CalculateEventThreatDetectionSettings for this purpose.
+  
 
 Args:
-  name: string, Required. The name of the EventThreatDetectionSettings to retrieve. Formats: * organizations/{organization}/eventThreatDetectionSettings * folders/{folder}/eventThreatDetectionSettings * projects/{project}/eventThreatDetectionSettings (required)
+  name: string, A parameter (required)
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -201,27 +201,27 @@ 

Method Details

Returns: An object of the form: - { # Resource capturing the settings for the Event Threat Detection service. - "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's configuration. - "a_key": { # Configuration of a module. - "moduleEnablementState": "A String", # The state of enablement for the module at its level of the resource hierarchy. - "value": { # The configuration value for the module. The absence of this field implies its inheritance from the parent. + { + "modules": { + "a_key": { + "moduleEnablementState": "A String", + "value": { "a_key": "", # Properties of the object. }, }, }, - "name": "A String", # Identifier. The resource name of the EventThreatDetectionSettings. Formats: * organizations/{organization}/eventThreatDetectionSettings * folders/{folder}/eventThreatDetectionSettings * projects/{project}/eventThreatDetectionSettings - "serviceEnablementState": "A String", # The state of enablement for the service at its level of the resource hierarchy. A DISABLED state will override all module enablement_states to DISABLED. - "updateTime": "A String", # Output only. The time the settings were last updated. + "name": "A String", + "serviceEnablementState": "A String", + "updateTime": "A String", }
getRapidVulnerabilityDetectionSettings(name, x__xgafv=None) -
Get the RapidVulnerabilityDetectionSettings resource. In the returned settings response, a missing field only indicates that it was not explicitly set, so no assumption should be made about these fields. In other words, GetRapidVulnerabilityDetectionSettings does not calculate the effective service settings for the resource, which accounts for inherited settings and defaults. Instead, use CalculateRapidVulnerabilityDetectionSettings for this purpose.
+  
 
 Args:
-  name: string, Required. The name of the RapidVulnerabilityDetectionSettings to retrieve. Formats: * organizations/{organization}/rapidVulnerabilityDetectionSettings * folders/{folder}/rapidVulnerabilityDetectionSettings * projects/{project}/rapidVulnerabilityDetectionSettings (required)
+  name: string, A parameter (required)
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -230,27 +230,27 @@ 

Method Details

Returns: An object of the form: - { # Resource capturing the settings for the Rapid Vulnerability Detection service. - "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's. - "a_key": { # Configuration of a module. - "moduleEnablementState": "A String", # The state of enablement for the module at its level of the resource hierarchy. - "value": { # The configuration value for the module. The absence of this field implies its inheritance from the parent. + { + "modules": { + "a_key": { + "moduleEnablementState": "A String", + "value": { "a_key": "", # Properties of the object. }, }, }, - "name": "A String", # The resource name of the RapidVulnerabilityDetectionSettings. Formats: * organizations/{organization}/rapidVulnerabilityDetectionSettings * folders/{folder}/rapidVulnerabilityDetectionSettings * projects/{project}/rapidVulnerabilityDetectionSettings - "serviceEnablementState": "A String", # The state of enablement for the service at its level of the resource hierarchy. A DISABLED state will override all module enablement_states to DISABLED. - "updateTime": "A String", # Output only. The time the settings were last updated. + "name": "A String", + "serviceEnablementState": "A String", + "updateTime": "A String", }
getSecurityCenterSettings(name, x__xgafv=None) -
Get the SecurityCenterSettings resource.
+  
 
 Args:
-  name: string, Required. The name of the SecurityCenterSettings to retrieve. Format: organizations/{organization}/securityCenterSettings Format: folders/{folder}/securityCenterSettings Format: projects/{project}/securityCenterSettings (required)
+  name: string, A parameter (required)
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -259,21 +259,21 @@ 

Method Details

Returns: An object of the form: - { # Resource capturing the settings for Security Center. - "cryptoKeyName": "A String", # The KMS key name used for CMEK encryption. Format: projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{key_name} - "logSinkProject": "A String", # The resource name of the project to send logs to. This project must be part of the organization this resource resides in. The format is `projects/{project_id}`. An empty value disables logging. This value is only referenced by services that support log sink. Please refer to the documentation for an updated list of compatible services. This may only be specified for organization level onboarding. - "name": "A String", # The resource name of the SecurityCenterSettings. Format: organizations/{organization}/securityCenterSettings Format: folders/{folder}/securityCenterSettings Format: projects/{project}/securityCenterSettings - "onboardingTime": "A String", # Output only. Timestamp of when the customer organization was onboarded to SCC. - "orgServiceAccount": "A String", # Output only. The organization level service account to be used for security center components. + { + "cryptoKeyName": "A String", + "logSinkProject": "A String", + "name": "A String", + "onboardingTime": "A String", + "orgServiceAccount": "A String", }
getSecurityHealthAnalyticsSettings(name, x__xgafv=None) -
Get the SecurityHealthAnalyticsSettings resource. In the returned settings response, a missing field only indicates that it was not explicitly set, so no assumption should be made about these fields. In other words, GetSecurityHealthAnalyticsSettings does not calculate the effective service settings for the resource, which accounts for inherited settings and defaults. Instead, use CalculateSecurityHealthAnalyticsSettings for this purpose.
+  
 
 Args:
-  name: string, Required. The name of the SecurityHealthAnalyticsSettings to retrieve. Formats: * organizations/{organization}/securityHealthAnalyticsSettings * folders/{folder}/securityHealthAnalyticsSettings * projects/{project}/securityHealthAnalyticsSettings (required)
+  name: string, A parameter (required)
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -282,28 +282,28 @@ 

Method Details

Returns: An object of the form: - { # Resource capturing the settings for the Security Health Analytics service. - "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's configuration. - "a_key": { # Configuration of a module. - "moduleEnablementState": "A String", # The state of enablement for the module at its level of the resource hierarchy. - "value": { # The configuration value for the module. The absence of this field implies its inheritance from the parent. + { + "modules": { + "a_key": { + "moduleEnablementState": "A String", + "value": { "a_key": "", # Properties of the object. }, }, }, - "name": "A String", # Identifier. The resource name of the SecurityHealthAnalyticsSettings. Formats: * organizations/{organization}/securityHealthAnalyticsSettings * folders/{folder}/securityHealthAnalyticsSettings * projects/{project}/securityHealthAnalyticsSettings - "serviceAccount": "A String", # Output only. The service account used by Security Health Analytics detectors. - "serviceEnablementState": "A String", # The state of enablement for the service at its level of the resource hierarchy. A DISABLED state will override all module enablement_states to DISABLED. - "updateTime": "A String", # Output only. The time the settings were last updated. + "name": "A String", + "serviceAccount": "A String", + "serviceEnablementState": "A String", + "updateTime": "A String", }
getVirtualMachineThreatDetectionSettings(name, x__xgafv=None) -
Get the VirtualMachineThreatDetectionSettings resource. In the returned settings response, a missing field only indicates that it was not explicitly set, so no assumption should be made about these fields. In other words, GetVirtualMachineThreatDetectionSettings does not calculate the effective service settings for the resource, which accounts for inherited settings and defaults. Instead, use CalculateVirtualMachineThreatDetectionSettings for this purpose.
+  
 
 Args:
-  name: string, Required. The name of the VirtualMachineThreatDetectionSettings to retrieve. Formats: * organizations/{organization}/virtualMachineThreatDetectionSettings * folders/{folder}/virtualMachineThreatDetectionSettings * projects/{project}/virtualMachineThreatDetectionSettings (required)
+  name: string, A parameter (required)
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -312,28 +312,28 @@ 

Method Details

Returns: An object of the form: - { # Resource capturing the settings for the Virtual Machine Threat Detection service. - "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's configuration. - "a_key": { # Configuration of a module. - "moduleEnablementState": "A String", # The state of enablement for the module at its level of the resource hierarchy. - "value": { # The configuration value for the module. The absence of this field implies its inheritance from the parent. + { + "modules": { + "a_key": { + "moduleEnablementState": "A String", + "value": { "a_key": "", # Properties of the object. }, }, }, - "name": "A String", # Identifier. The resource name of the VirtualMachineThreatDetectionSettings. Formats: * organizations/{organization}/virtualMachineThreatDetectionSettings * folders/{folder}/virtualMachineThreatDetectionSettings * projects/{project}/virtualMachineThreatDetectionSettings - "serviceAccount": "A String", # Output only. The service account used by Virtual Machine Threat Detection detectors. - "serviceEnablementState": "A String", # The state of enablement for the service at its level of the resource hierarchy. A DISABLED state will override all module enablement_states to DISABLED. - "updateTime": "A String", # Output only. The time the settings were last updated. + "name": "A String", + "serviceAccount": "A String", + "serviceEnablementState": "A String", + "updateTime": "A String", }
getWebSecurityScannerSettings(name, x__xgafv=None) -
Get the WebSecurityScannerSettings resource. In the returned settings response, a missing field only indicates that it was not explicitly set, so no assumption should be made about these fields. In other words, GetWebSecurityScannerSettings does not calculate the effective service settings for the resource, which accounts for inherited settings and defaults. Instead, use CalculateWebSecurityScannerSettings for this purpose.
+  
 
 Args:
-  name: string, Required. The name of the WebSecurityScannerSettings to retrieve. Formats: * organizations/{organization}/webSecurityScannerSettings * folders/{folder}/webSecurityScannerSettings * projects/{project}/webSecurityScannerSettings (required)
+  name: string, A parameter (required)
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -342,46 +342,46 @@ 

Method Details

Returns: An object of the form: - { # Resource capturing the settings for the Web Security Scanner service. - "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's configuration. - "a_key": { # Configuration of a module. - "moduleEnablementState": "A String", # The state of enablement for the module at its level of the resource hierarchy. - "value": { # The configuration value for the module. The absence of this field implies its inheritance from the parent. + { + "modules": { + "a_key": { + "moduleEnablementState": "A String", + "value": { "a_key": "", # Properties of the object. }, }, }, - "name": "A String", # Identifier. The resource name of the WebSecurityScannerSettings. Formats: * organizations/{organization}/webSecurityScannerSettings * folders/{folder}/webSecurityScannerSettings * projects/{project}/webSecurityScannerSettings - "serviceEnablementState": "A String", # The state of enablement for the service at its level of the resource hierarchy. A DISABLED state will override all module enablement_states to DISABLED. - "updateTime": "A String", # Output only. The time the settings were last updated. + "name": "A String", + "serviceEnablementState": "A String", + "updateTime": "A String", }
updateContainerThreatDetectionSettings(name, body=None, updateMask=None, x__xgafv=None) -
Update the ContainerThreatDetectionSettings resource.
+  
 
 Args:
-  name: string, Identifier. The resource name of the ContainerThreatDetectionSettings. Formats: * organizations/{organization}/containerThreatDetectionSettings * folders/{folder}/containerThreatDetectionSettings * projects/{project}/containerThreatDetectionSettings * projects/{project}/locations/{location}/clusters/{cluster}/containerThreatDetectionSettings (required)
+  name: string, A parameter (required)
   body: object, The request body.
     The object takes the form of:
 
-{ # Resource capturing the settings for the Container Threat Detection service.
-  "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's configuration.
-    "a_key": { # Configuration of a module.
-      "moduleEnablementState": "A String", # The state of enablement for the module at its level of the resource hierarchy.
-      "value": { # The configuration value for the module. The absence of this field implies its inheritance from the parent.
+{
+  "modules": {
+    "a_key": {
+      "moduleEnablementState": "A String",
+      "value": {
         "a_key": "", # Properties of the object.
       },
     },
   },
-  "name": "A String", # Identifier. The resource name of the ContainerThreatDetectionSettings. Formats: * organizations/{organization}/containerThreatDetectionSettings * folders/{folder}/containerThreatDetectionSettings * projects/{project}/containerThreatDetectionSettings * projects/{project}/locations/{location}/clusters/{cluster}/containerThreatDetectionSettings
-  "serviceAccount": "A String", # Output only. The service account used by Container Threat Detection for scanning. Service accounts are scoped at the project level meaning this field will be empty at any level above a project.
-  "serviceEnablementState": "A String", # The state of enablement for the service at its level of the resource hierarchy. A DISABLED state will override all module enablement_states to DISABLED.
-  "updateTime": "A String", # Output only. The time the settings were last updated.
+  "name": "A String",
+  "serviceAccount": "A String",
+  "serviceEnablementState": "A String",
+  "updateTime": "A String",
 }
 
-  updateMask: string, The list of fields to be updated.
+  updateMask: string, A parameter
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -390,46 +390,46 @@ 

Method Details

Returns: An object of the form: - { # Resource capturing the settings for the Container Threat Detection service. - "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's configuration. - "a_key": { # Configuration of a module. - "moduleEnablementState": "A String", # The state of enablement for the module at its level of the resource hierarchy. - "value": { # The configuration value for the module. The absence of this field implies its inheritance from the parent. + { + "modules": { + "a_key": { + "moduleEnablementState": "A String", + "value": { "a_key": "", # Properties of the object. }, }, }, - "name": "A String", # Identifier. The resource name of the ContainerThreatDetectionSettings. Formats: * organizations/{organization}/containerThreatDetectionSettings * folders/{folder}/containerThreatDetectionSettings * projects/{project}/containerThreatDetectionSettings * projects/{project}/locations/{location}/clusters/{cluster}/containerThreatDetectionSettings - "serviceAccount": "A String", # Output only. The service account used by Container Threat Detection for scanning. Service accounts are scoped at the project level meaning this field will be empty at any level above a project. - "serviceEnablementState": "A String", # The state of enablement for the service at its level of the resource hierarchy. A DISABLED state will override all module enablement_states to DISABLED. - "updateTime": "A String", # Output only. The time the settings were last updated. + "name": "A String", + "serviceAccount": "A String", + "serviceEnablementState": "A String", + "updateTime": "A String", }
updateEventThreatDetectionSettings(name, body=None, updateMask=None, x__xgafv=None) -
Update the EventThreatDetectionSettings resource.
+  
 
 Args:
-  name: string, Identifier. The resource name of the EventThreatDetectionSettings. Formats: * organizations/{organization}/eventThreatDetectionSettings * folders/{folder}/eventThreatDetectionSettings * projects/{project}/eventThreatDetectionSettings (required)
+  name: string, A parameter (required)
   body: object, The request body.
     The object takes the form of:
 
-{ # Resource capturing the settings for the Event Threat Detection service.
-  "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's configuration.
-    "a_key": { # Configuration of a module.
-      "moduleEnablementState": "A String", # The state of enablement for the module at its level of the resource hierarchy.
-      "value": { # The configuration value for the module. The absence of this field implies its inheritance from the parent.
+{
+  "modules": {
+    "a_key": {
+      "moduleEnablementState": "A String",
+      "value": {
         "a_key": "", # Properties of the object.
       },
     },
   },
-  "name": "A String", # Identifier. The resource name of the EventThreatDetectionSettings. Formats: * organizations/{organization}/eventThreatDetectionSettings * folders/{folder}/eventThreatDetectionSettings * projects/{project}/eventThreatDetectionSettings
-  "serviceEnablementState": "A String", # The state of enablement for the service at its level of the resource hierarchy. A DISABLED state will override all module enablement_states to DISABLED.
-  "updateTime": "A String", # Output only. The time the settings were last updated.
+  "name": "A String",
+  "serviceEnablementState": "A String",
+  "updateTime": "A String",
 }
 
-  updateMask: string, The list of fields to be updated.
+  updateMask: string, A parameter
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -438,45 +438,45 @@ 

Method Details

Returns: An object of the form: - { # Resource capturing the settings for the Event Threat Detection service. - "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's configuration. - "a_key": { # Configuration of a module. - "moduleEnablementState": "A String", # The state of enablement for the module at its level of the resource hierarchy. - "value": { # The configuration value for the module. The absence of this field implies its inheritance from the parent. + { + "modules": { + "a_key": { + "moduleEnablementState": "A String", + "value": { "a_key": "", # Properties of the object. }, }, }, - "name": "A String", # Identifier. The resource name of the EventThreatDetectionSettings. Formats: * organizations/{organization}/eventThreatDetectionSettings * folders/{folder}/eventThreatDetectionSettings * projects/{project}/eventThreatDetectionSettings - "serviceEnablementState": "A String", # The state of enablement for the service at its level of the resource hierarchy. A DISABLED state will override all module enablement_states to DISABLED. - "updateTime": "A String", # Output only. The time the settings were last updated. + "name": "A String", + "serviceEnablementState": "A String", + "updateTime": "A String", }
updateRapidVulnerabilityDetectionSettings(name, body=None, updateMask=None, x__xgafv=None) -
Update the RapidVulnerabilityDetectionSettings resource.
+  
 
 Args:
-  name: string, The resource name of the RapidVulnerabilityDetectionSettings. Formats: * organizations/{organization}/rapidVulnerabilityDetectionSettings * folders/{folder}/rapidVulnerabilityDetectionSettings * projects/{project}/rapidVulnerabilityDetectionSettings (required)
+  name: string, A parameter (required)
   body: object, The request body.
     The object takes the form of:
 
-{ # Resource capturing the settings for the Rapid Vulnerability Detection service.
-  "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's.
-    "a_key": { # Configuration of a module.
-      "moduleEnablementState": "A String", # The state of enablement for the module at its level of the resource hierarchy.
-      "value": { # The configuration value for the module. The absence of this field implies its inheritance from the parent.
+{
+  "modules": {
+    "a_key": {
+      "moduleEnablementState": "A String",
+      "value": {
         "a_key": "", # Properties of the object.
       },
     },
   },
-  "name": "A String", # The resource name of the RapidVulnerabilityDetectionSettings. Formats: * organizations/{organization}/rapidVulnerabilityDetectionSettings * folders/{folder}/rapidVulnerabilityDetectionSettings * projects/{project}/rapidVulnerabilityDetectionSettings
-  "serviceEnablementState": "A String", # The state of enablement for the service at its level of the resource hierarchy. A DISABLED state will override all module enablement_states to DISABLED.
-  "updateTime": "A String", # Output only. The time the settings were last updated.
+  "name": "A String",
+  "serviceEnablementState": "A String",
+  "updateTime": "A String",
 }
 
-  updateMask: string, The list of fields to be updated.
+  updateMask: string, A parameter
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -485,46 +485,46 @@ 

Method Details

Returns: An object of the form: - { # Resource capturing the settings for the Rapid Vulnerability Detection service. - "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's. - "a_key": { # Configuration of a module. - "moduleEnablementState": "A String", # The state of enablement for the module at its level of the resource hierarchy. - "value": { # The configuration value for the module. The absence of this field implies its inheritance from the parent. + { + "modules": { + "a_key": { + "moduleEnablementState": "A String", + "value": { "a_key": "", # Properties of the object. }, }, }, - "name": "A String", # The resource name of the RapidVulnerabilityDetectionSettings. Formats: * organizations/{organization}/rapidVulnerabilityDetectionSettings * folders/{folder}/rapidVulnerabilityDetectionSettings * projects/{project}/rapidVulnerabilityDetectionSettings - "serviceEnablementState": "A String", # The state of enablement for the service at its level of the resource hierarchy. A DISABLED state will override all module enablement_states to DISABLED. - "updateTime": "A String", # Output only. The time the settings were last updated. + "name": "A String", + "serviceEnablementState": "A String", + "updateTime": "A String", }
updateSecurityHealthAnalyticsSettings(name, body=None, updateMask=None, x__xgafv=None) -
Update the SecurityHealthAnalyticsSettings resource.
+  
 
 Args:
-  name: string, Identifier. The resource name of the SecurityHealthAnalyticsSettings. Formats: * organizations/{organization}/securityHealthAnalyticsSettings * folders/{folder}/securityHealthAnalyticsSettings * projects/{project}/securityHealthAnalyticsSettings (required)
+  name: string, A parameter (required)
   body: object, The request body.
     The object takes the form of:
 
-{ # Resource capturing the settings for the Security Health Analytics service.
-  "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's configuration.
-    "a_key": { # Configuration of a module.
-      "moduleEnablementState": "A String", # The state of enablement for the module at its level of the resource hierarchy.
-      "value": { # The configuration value for the module. The absence of this field implies its inheritance from the parent.
+{
+  "modules": {
+    "a_key": {
+      "moduleEnablementState": "A String",
+      "value": {
         "a_key": "", # Properties of the object.
       },
     },
   },
-  "name": "A String", # Identifier. The resource name of the SecurityHealthAnalyticsSettings. Formats: * organizations/{organization}/securityHealthAnalyticsSettings * folders/{folder}/securityHealthAnalyticsSettings * projects/{project}/securityHealthAnalyticsSettings
-  "serviceAccount": "A String", # Output only. The service account used by Security Health Analytics detectors.
-  "serviceEnablementState": "A String", # The state of enablement for the service at its level of the resource hierarchy. A DISABLED state will override all module enablement_states to DISABLED.
-  "updateTime": "A String", # Output only. The time the settings were last updated.
+  "name": "A String",
+  "serviceAccount": "A String",
+  "serviceEnablementState": "A String",
+  "updateTime": "A String",
 }
 
-  updateMask: string, The list of fields to be updated.
+  updateMask: string, A parameter
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -533,47 +533,47 @@ 

Method Details

Returns: An object of the form: - { # Resource capturing the settings for the Security Health Analytics service. - "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's configuration. - "a_key": { # Configuration of a module. - "moduleEnablementState": "A String", # The state of enablement for the module at its level of the resource hierarchy. - "value": { # The configuration value for the module. The absence of this field implies its inheritance from the parent. + { + "modules": { + "a_key": { + "moduleEnablementState": "A String", + "value": { "a_key": "", # Properties of the object. }, }, }, - "name": "A String", # Identifier. The resource name of the SecurityHealthAnalyticsSettings. Formats: * organizations/{organization}/securityHealthAnalyticsSettings * folders/{folder}/securityHealthAnalyticsSettings * projects/{project}/securityHealthAnalyticsSettings - "serviceAccount": "A String", # Output only. The service account used by Security Health Analytics detectors. - "serviceEnablementState": "A String", # The state of enablement for the service at its level of the resource hierarchy. A DISABLED state will override all module enablement_states to DISABLED. - "updateTime": "A String", # Output only. The time the settings were last updated. + "name": "A String", + "serviceAccount": "A String", + "serviceEnablementState": "A String", + "updateTime": "A String", }
updateVirtualMachineThreatDetectionSettings(name, body=None, updateMask=None, x__xgafv=None) -
Update the VirtualMachineThreatDetectionSettings resource.
+  
 
 Args:
-  name: string, Identifier. The resource name of the VirtualMachineThreatDetectionSettings. Formats: * organizations/{organization}/virtualMachineThreatDetectionSettings * folders/{folder}/virtualMachineThreatDetectionSettings * projects/{project}/virtualMachineThreatDetectionSettings (required)
+  name: string, A parameter (required)
   body: object, The request body.
     The object takes the form of:
 
-{ # Resource capturing the settings for the Virtual Machine Threat Detection service.
-  "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's configuration.
-    "a_key": { # Configuration of a module.
-      "moduleEnablementState": "A String", # The state of enablement for the module at its level of the resource hierarchy.
-      "value": { # The configuration value for the module. The absence of this field implies its inheritance from the parent.
+{
+  "modules": {
+    "a_key": {
+      "moduleEnablementState": "A String",
+      "value": {
         "a_key": "", # Properties of the object.
       },
     },
   },
-  "name": "A String", # Identifier. The resource name of the VirtualMachineThreatDetectionSettings. Formats: * organizations/{organization}/virtualMachineThreatDetectionSettings * folders/{folder}/virtualMachineThreatDetectionSettings * projects/{project}/virtualMachineThreatDetectionSettings
-  "serviceAccount": "A String", # Output only. The service account used by Virtual Machine Threat Detection detectors.
-  "serviceEnablementState": "A String", # The state of enablement for the service at its level of the resource hierarchy. A DISABLED state will override all module enablement_states to DISABLED.
-  "updateTime": "A String", # Output only. The time the settings were last updated.
+  "name": "A String",
+  "serviceAccount": "A String",
+  "serviceEnablementState": "A String",
+  "updateTime": "A String",
 }
 
-  updateMask: string, The list of fields to be updated.
+  updateMask: string, A parameter
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -582,46 +582,46 @@ 

Method Details

Returns: An object of the form: - { # Resource capturing the settings for the Virtual Machine Threat Detection service. - "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's configuration. - "a_key": { # Configuration of a module. - "moduleEnablementState": "A String", # The state of enablement for the module at its level of the resource hierarchy. - "value": { # The configuration value for the module. The absence of this field implies its inheritance from the parent. + { + "modules": { + "a_key": { + "moduleEnablementState": "A String", + "value": { "a_key": "", # Properties of the object. }, }, }, - "name": "A String", # Identifier. The resource name of the VirtualMachineThreatDetectionSettings. Formats: * organizations/{organization}/virtualMachineThreatDetectionSettings * folders/{folder}/virtualMachineThreatDetectionSettings * projects/{project}/virtualMachineThreatDetectionSettings - "serviceAccount": "A String", # Output only. The service account used by Virtual Machine Threat Detection detectors. - "serviceEnablementState": "A String", # The state of enablement for the service at its level of the resource hierarchy. A DISABLED state will override all module enablement_states to DISABLED. - "updateTime": "A String", # Output only. The time the settings were last updated. + "name": "A String", + "serviceAccount": "A String", + "serviceEnablementState": "A String", + "updateTime": "A String", }
updateWebSecurityScannerSettings(name, body=None, updateMask=None, x__xgafv=None) -
Update the WebSecurityScannerSettings resource.
+  
 
 Args:
-  name: string, Identifier. The resource name of the WebSecurityScannerSettings. Formats: * organizations/{organization}/webSecurityScannerSettings * folders/{folder}/webSecurityScannerSettings * projects/{project}/webSecurityScannerSettings (required)
+  name: string, A parameter (required)
   body: object, The request body.
     The object takes the form of:
 
-{ # Resource capturing the settings for the Web Security Scanner service.
-  "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's configuration.
-    "a_key": { # Configuration of a module.
-      "moduleEnablementState": "A String", # The state of enablement for the module at its level of the resource hierarchy.
-      "value": { # The configuration value for the module. The absence of this field implies its inheritance from the parent.
+{
+  "modules": {
+    "a_key": {
+      "moduleEnablementState": "A String",
+      "value": {
         "a_key": "", # Properties of the object.
       },
     },
   },
-  "name": "A String", # Identifier. The resource name of the WebSecurityScannerSettings. Formats: * organizations/{organization}/webSecurityScannerSettings * folders/{folder}/webSecurityScannerSettings * projects/{project}/webSecurityScannerSettings
-  "serviceEnablementState": "A String", # The state of enablement for the service at its level of the resource hierarchy. A DISABLED state will override all module enablement_states to DISABLED.
-  "updateTime": "A String", # Output only. The time the settings were last updated.
+  "name": "A String",
+  "serviceEnablementState": "A String",
+  "updateTime": "A String",
 }
 
-  updateMask: string, The list of fields to be updated.
+  updateMask: string, A parameter
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -630,18 +630,18 @@ 

Method Details

Returns: An object of the form: - { # Resource capturing the settings for the Web Security Scanner service. - "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's configuration. - "a_key": { # Configuration of a module. - "moduleEnablementState": "A String", # The state of enablement for the module at its level of the resource hierarchy. - "value": { # The configuration value for the module. The absence of this field implies its inheritance from the parent. + { + "modules": { + "a_key": { + "moduleEnablementState": "A String", + "value": { "a_key": "", # Properties of the object. }, }, }, - "name": "A String", # Identifier. The resource name of the WebSecurityScannerSettings. Formats: * organizations/{organization}/webSecurityScannerSettings * folders/{folder}/webSecurityScannerSettings * projects/{project}/webSecurityScannerSettings - "serviceEnablementState": "A String", # The state of enablement for the service at its level of the resource hierarchy. A DISABLED state will override all module enablement_states to DISABLED. - "updateTime": "A String", # Output only. The time the settings were last updated. + "name": "A String", + "serviceEnablementState": "A String", + "updateTime": "A String", }
diff --git a/docs/dyn/securitycenter_v1beta2.projects.locations.clusters.containerThreatDetectionSettings.html b/docs/dyn/securitycenter_v1beta2.projects.locations.clusters.containerThreatDetectionSettings.html index 8d8534db90..ea432340f5 100644 --- a/docs/dyn/securitycenter_v1beta2.projects.locations.clusters.containerThreatDetectionSettings.html +++ b/docs/dyn/securitycenter_v1beta2.projects.locations.clusters.containerThreatDetectionSettings.html @@ -76,18 +76,18 @@

Security Command Center API . Instance Methods

calculate(name, showEligibleModulesOnly=None, x__xgafv=None)

-

Calculates the effective ContainerThreatDetectionSettings based on its level in the resource hierarchy and its settings. Settings provided closer to the target resource take precedence over those further away (e.g. folder will override organization level settings). The default SCC setting for the detector service defaults can be overridden at organization, folder and project levels. No assumptions should be made about the SCC defaults as it is considered an internal implementation detail.

+

close()

Close httplib2 connections.

Method Details

calculate(name, showEligibleModulesOnly=None, x__xgafv=None) -
Calculates the effective ContainerThreatDetectionSettings based on its level in the resource hierarchy and its settings. Settings provided closer to the target resource take precedence over those further away (e.g. folder will override organization level settings). The default SCC setting for the detector service defaults can be overridden at organization, folder and project levels. No assumptions should be made about the SCC defaults as it is considered an internal implementation detail.
+  
 
 Args:
-  name: string, Required. The name of the ContainerThreatDetectionSettings to calculate. Formats: * organizations/{organization}/containerThreatDetectionSettings * folders/{folder}/containerThreatDetectionSettings * projects/{project}/containerThreatDetectionSettings * projects/{project}/locations/{location}/clusters/{cluster}/containerThreatDetectionSettings (required)
-  showEligibleModulesOnly: boolean, Optional. When set, will only retrieve the modules that are in scope. By default, all modules will be shown.
+  name: string, A parameter (required)
+  showEligibleModulesOnly: boolean, A parameter
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -96,19 +96,19 @@ 

Method Details

Returns: An object of the form: - { # Resource capturing the settings for the Container Threat Detection service. - "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's configuration. - "a_key": { # Configuration of a module. - "moduleEnablementState": "A String", # The state of enablement for the module at its level of the resource hierarchy. - "value": { # The configuration value for the module. The absence of this field implies its inheritance from the parent. + { + "modules": { + "a_key": { + "moduleEnablementState": "A String", + "value": { "a_key": "", # Properties of the object. }, }, }, - "name": "A String", # Identifier. The resource name of the ContainerThreatDetectionSettings. Formats: * organizations/{organization}/containerThreatDetectionSettings * folders/{folder}/containerThreatDetectionSettings * projects/{project}/containerThreatDetectionSettings * projects/{project}/locations/{location}/clusters/{cluster}/containerThreatDetectionSettings - "serviceAccount": "A String", # Output only. The service account used by Container Threat Detection for scanning. Service accounts are scoped at the project level meaning this field will be empty at any level above a project. - "serviceEnablementState": "A String", # The state of enablement for the service at its level of the resource hierarchy. A DISABLED state will override all module enablement_states to DISABLED. - "updateTime": "A String", # Output only. The time the settings were last updated. + "name": "A String", + "serviceAccount": "A String", + "serviceEnablementState": "A String", + "updateTime": "A String", }
diff --git a/docs/dyn/securitycenter_v1beta2.projects.locations.clusters.html b/docs/dyn/securitycenter_v1beta2.projects.locations.clusters.html index e0d0fe7011..b7181abcb8 100644 --- a/docs/dyn/securitycenter_v1beta2.projects.locations.clusters.html +++ b/docs/dyn/securitycenter_v1beta2.projects.locations.clusters.html @@ -84,10 +84,10 @@

Instance Methods

Close httplib2 connections.

getContainerThreatDetectionSettings(name, x__xgafv=None)

-

Get the ContainerThreatDetectionSettings resource. In the returned settings response, a missing field only indicates that it was not explicitly set, so no assumption should be made about these fields. In other words, GetContainerThreatDetectionSettings does not calculate the effective service settings for the resource, which accounts for inherited settings and defaults. Instead, use CalculateContainerThreatDetectionSettings for this purpose.

+

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

-

Update the ContainerThreatDetectionSettings resource.

+

Method Details

close() @@ -96,10 +96,10 @@

Method Details

getContainerThreatDetectionSettings(name, x__xgafv=None) -
Get the ContainerThreatDetectionSettings resource. In the returned settings response, a missing field only indicates that it was not explicitly set, so no assumption should be made about these fields. In other words, GetContainerThreatDetectionSettings does not calculate the effective service settings for the resource, which accounts for inherited settings and defaults. Instead, use CalculateContainerThreatDetectionSettings for this purpose.
+  
 
 Args:
-  name: string, Required. The name of the ContainerThreatDetectionSettings to retrieve. Formats: * organizations/{organization}/containerThreatDetectionSettings * folders/{folder}/containerThreatDetectionSettings * projects/{project}/containerThreatDetectionSettings * projects/{project}/locations/{location}/clusters/{cluster}/containerThreatDetectionSettings (required)
+  name: string, A parameter (required)
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -108,47 +108,47 @@ 

Method Details

Returns: An object of the form: - { # Resource capturing the settings for the Container Threat Detection service. - "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's configuration. - "a_key": { # Configuration of a module. - "moduleEnablementState": "A String", # The state of enablement for the module at its level of the resource hierarchy. - "value": { # The configuration value for the module. The absence of this field implies its inheritance from the parent. + { + "modules": { + "a_key": { + "moduleEnablementState": "A String", + "value": { "a_key": "", # Properties of the object. }, }, }, - "name": "A String", # Identifier. The resource name of the ContainerThreatDetectionSettings. Formats: * organizations/{organization}/containerThreatDetectionSettings * folders/{folder}/containerThreatDetectionSettings * projects/{project}/containerThreatDetectionSettings * projects/{project}/locations/{location}/clusters/{cluster}/containerThreatDetectionSettings - "serviceAccount": "A String", # Output only. The service account used by Container Threat Detection for scanning. Service accounts are scoped at the project level meaning this field will be empty at any level above a project. - "serviceEnablementState": "A String", # The state of enablement for the service at its level of the resource hierarchy. A DISABLED state will override all module enablement_states to DISABLED. - "updateTime": "A String", # Output only. The time the settings were last updated. + "name": "A String", + "serviceAccount": "A String", + "serviceEnablementState": "A String", + "updateTime": "A String", }
updateContainerThreatDetectionSettings(name, body=None, updateMask=None, x__xgafv=None) -
Update the ContainerThreatDetectionSettings resource.
+  
 
 Args:
-  name: string, Identifier. The resource name of the ContainerThreatDetectionSettings. Formats: * organizations/{organization}/containerThreatDetectionSettings * folders/{folder}/containerThreatDetectionSettings * projects/{project}/containerThreatDetectionSettings * projects/{project}/locations/{location}/clusters/{cluster}/containerThreatDetectionSettings (required)
+  name: string, A parameter (required)
   body: object, The request body.
     The object takes the form of:
 
-{ # Resource capturing the settings for the Container Threat Detection service.
-  "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's configuration.
-    "a_key": { # Configuration of a module.
-      "moduleEnablementState": "A String", # The state of enablement for the module at its level of the resource hierarchy.
-      "value": { # The configuration value for the module. The absence of this field implies its inheritance from the parent.
+{
+  "modules": {
+    "a_key": {
+      "moduleEnablementState": "A String",
+      "value": {
         "a_key": "", # Properties of the object.
       },
     },
   },
-  "name": "A String", # Identifier. The resource name of the ContainerThreatDetectionSettings. Formats: * organizations/{organization}/containerThreatDetectionSettings * folders/{folder}/containerThreatDetectionSettings * projects/{project}/containerThreatDetectionSettings * projects/{project}/locations/{location}/clusters/{cluster}/containerThreatDetectionSettings
-  "serviceAccount": "A String", # Output only. The service account used by Container Threat Detection for scanning. Service accounts are scoped at the project level meaning this field will be empty at any level above a project.
-  "serviceEnablementState": "A String", # The state of enablement for the service at its level of the resource hierarchy. A DISABLED state will override all module enablement_states to DISABLED.
-  "updateTime": "A String", # Output only. The time the settings were last updated.
+  "name": "A String",
+  "serviceAccount": "A String",
+  "serviceEnablementState": "A String",
+  "updateTime": "A String",
 }
 
-  updateMask: string, The list of fields to be updated.
+  updateMask: string, A parameter
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -157,19 +157,19 @@ 

Method Details

Returns: An object of the form: - { # Resource capturing the settings for the Container Threat Detection service. - "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's configuration. - "a_key": { # Configuration of a module. - "moduleEnablementState": "A String", # The state of enablement for the module at its level of the resource hierarchy. - "value": { # The configuration value for the module. The absence of this field implies its inheritance from the parent. + { + "modules": { + "a_key": { + "moduleEnablementState": "A String", + "value": { "a_key": "", # Properties of the object. }, }, }, - "name": "A String", # Identifier. The resource name of the ContainerThreatDetectionSettings. Formats: * organizations/{organization}/containerThreatDetectionSettings * folders/{folder}/containerThreatDetectionSettings * projects/{project}/containerThreatDetectionSettings * projects/{project}/locations/{location}/clusters/{cluster}/containerThreatDetectionSettings - "serviceAccount": "A String", # Output only. The service account used by Container Threat Detection for scanning. Service accounts are scoped at the project level meaning this field will be empty at any level above a project. - "serviceEnablementState": "A String", # The state of enablement for the service at its level of the resource hierarchy. A DISABLED state will override all module enablement_states to DISABLED. - "updateTime": "A String", # Output only. The time the settings were last updated. + "name": "A String", + "serviceAccount": "A String", + "serviceEnablementState": "A String", + "updateTime": "A String", }
diff --git a/docs/dyn/securitycenter_v1beta2.projects.rapidVulnerabilityDetectionSettings.html b/docs/dyn/securitycenter_v1beta2.projects.rapidVulnerabilityDetectionSettings.html index 205692bf0a..411faef04d 100644 --- a/docs/dyn/securitycenter_v1beta2.projects.rapidVulnerabilityDetectionSettings.html +++ b/docs/dyn/securitycenter_v1beta2.projects.rapidVulnerabilityDetectionSettings.html @@ -76,17 +76,17 @@

Security Command Center API . Instance Methods

calculate(name, x__xgafv=None)

-

Calculates the effective RapidVulnerabilityDetectionSettings based on its level in the resource hierarchy and its settings. Settings provided closer to the target resource take precedence over those further away (e.g. folder will override organization level settings). The default SCC setting for the detector service defaults can be overridden at organization, folder and project levels. No assumptions should be made about the SCC defaults as it is considered an internal implementation detail.

+

close()

Close httplib2 connections.

Method Details

calculate(name, x__xgafv=None) -
Calculates the effective RapidVulnerabilityDetectionSettings based on its level in the resource hierarchy and its settings. Settings provided closer to the target resource take precedence over those further away (e.g. folder will override organization level settings). The default SCC setting for the detector service defaults can be overridden at organization, folder and project levels. No assumptions should be made about the SCC defaults as it is considered an internal implementation detail.
+  
 
 Args:
-  name: string, Required. The name of the RapidVulnerabilityDetectionSettings to calculate. Formats: * organizations/{organization}/rapidVulnerabilityDetectionSettings * folders/{folder}/rapidVulnerabilityDetectionSettings * projects/{project}/rapidVulnerabilityDetectionSettings (required)
+  name: string, A parameter (required)
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -95,18 +95,18 @@ 

Method Details

Returns: An object of the form: - { # Resource capturing the settings for the Rapid Vulnerability Detection service. - "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's. - "a_key": { # Configuration of a module. - "moduleEnablementState": "A String", # The state of enablement for the module at its level of the resource hierarchy. - "value": { # The configuration value for the module. The absence of this field implies its inheritance from the parent. + { + "modules": { + "a_key": { + "moduleEnablementState": "A String", + "value": { "a_key": "", # Properties of the object. }, }, }, - "name": "A String", # The resource name of the RapidVulnerabilityDetectionSettings. Formats: * organizations/{organization}/rapidVulnerabilityDetectionSettings * folders/{folder}/rapidVulnerabilityDetectionSettings * projects/{project}/rapidVulnerabilityDetectionSettings - "serviceEnablementState": "A String", # The state of enablement for the service at its level of the resource hierarchy. A DISABLED state will override all module enablement_states to DISABLED. - "updateTime": "A String", # Output only. The time the settings were last updated. + "name": "A String", + "serviceEnablementState": "A String", + "updateTime": "A String", }
diff --git a/docs/dyn/securitycenter_v1beta2.projects.securityHealthAnalyticsSettings.html b/docs/dyn/securitycenter_v1beta2.projects.securityHealthAnalyticsSettings.html index 327581f2f1..6c0e32d019 100644 --- a/docs/dyn/securitycenter_v1beta2.projects.securityHealthAnalyticsSettings.html +++ b/docs/dyn/securitycenter_v1beta2.projects.securityHealthAnalyticsSettings.html @@ -76,18 +76,18 @@

Security Command Center API . Instance Methods

calculate(name, showEligibleModulesOnly=None, x__xgafv=None)

-

Calculates the effective SecurityHealthAnalyticsSettings based on its level in the resource hierarchy and its settings. Settings provided closer to the target resource take precedence over those further away (e.g. folder will override organization level settings). The default SCC setting for the detector service defaults can be overridden at organization, folder and project levels. No assumptions should be made about the SCC defaults as it is considered an internal implementation detail.

+

close()

Close httplib2 connections.

Method Details

calculate(name, showEligibleModulesOnly=None, x__xgafv=None) -
Calculates the effective SecurityHealthAnalyticsSettings based on its level in the resource hierarchy and its settings. Settings provided closer to the target resource take precedence over those further away (e.g. folder will override organization level settings). The default SCC setting for the detector service defaults can be overridden at organization, folder and project levels. No assumptions should be made about the SCC defaults as it is considered an internal implementation detail.
+  
 
 Args:
-  name: string, Required. The name of the SecurityHealthAnalyticsSettings to calculate. Formats: * organizations/{organization}/securityHealthAnalyticsSettings * folders/{folder}/securityHealthAnalyticsSettings * projects/{project}/securityHealthAnalyticsSettings (required)
-  showEligibleModulesOnly: boolean, Optional. When set, will only retrieve the modules that are in scope. By default, all modules will be shown.
+  name: string, A parameter (required)
+  showEligibleModulesOnly: boolean, A parameter
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -96,19 +96,19 @@ 

Method Details

Returns: An object of the form: - { # Resource capturing the settings for the Security Health Analytics service. - "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's configuration. - "a_key": { # Configuration of a module. - "moduleEnablementState": "A String", # The state of enablement for the module at its level of the resource hierarchy. - "value": { # The configuration value for the module. The absence of this field implies its inheritance from the parent. + { + "modules": { + "a_key": { + "moduleEnablementState": "A String", + "value": { "a_key": "", # Properties of the object. }, }, }, - "name": "A String", # Identifier. The resource name of the SecurityHealthAnalyticsSettings. Formats: * organizations/{organization}/securityHealthAnalyticsSettings * folders/{folder}/securityHealthAnalyticsSettings * projects/{project}/securityHealthAnalyticsSettings - "serviceAccount": "A String", # Output only. The service account used by Security Health Analytics detectors. - "serviceEnablementState": "A String", # The state of enablement for the service at its level of the resource hierarchy. A DISABLED state will override all module enablement_states to DISABLED. - "updateTime": "A String", # Output only. The time the settings were last updated. + "name": "A String", + "serviceAccount": "A String", + "serviceEnablementState": "A String", + "updateTime": "A String", }
diff --git a/docs/dyn/securitycenter_v1beta2.projects.virtualMachineThreatDetectionSettings.html b/docs/dyn/securitycenter_v1beta2.projects.virtualMachineThreatDetectionSettings.html index 7adb72ab2b..df1f4357a9 100644 --- a/docs/dyn/securitycenter_v1beta2.projects.virtualMachineThreatDetectionSettings.html +++ b/docs/dyn/securitycenter_v1beta2.projects.virtualMachineThreatDetectionSettings.html @@ -76,18 +76,18 @@

Security Command Center API . Instance Methods

calculate(name, showEligibleModulesOnly=None, x__xgafv=None)

-

Calculates the effective VirtualMachineThreatDetectionSettings based on its level in the resource hierarchy and its settings. Settings provided closer to the target resource take precedence over those further away (e.g. folder will override organization level settings). The default SCC setting for the detector service defaults can be overridden at organization, folder and project levels. No assumptions should be made about the SCC defaults as it is considered an internal implementation detail.

+

close()

Close httplib2 connections.

Method Details

calculate(name, showEligibleModulesOnly=None, x__xgafv=None) -
Calculates the effective VirtualMachineThreatDetectionSettings based on its level in the resource hierarchy and its settings. Settings provided closer to the target resource take precedence over those further away (e.g. folder will override organization level settings). The default SCC setting for the detector service defaults can be overridden at organization, folder and project levels. No assumptions should be made about the SCC defaults as it is considered an internal implementation detail.
+  
 
 Args:
-  name: string, Required. The name of the VirtualMachineThreatDetectionSettings to calculate. Formats: * organizations/{organization}/virtualMachineThreatDetectionSettings * folders/{folder}/virtualMachineThreatDetectionSettings * projects/{project}/virtualMachineThreatDetectionSettings (required)
-  showEligibleModulesOnly: boolean, Optional. When set, will only retrieve the modules that are in scope. By default, all modules will be shown.
+  name: string, A parameter (required)
+  showEligibleModulesOnly: boolean, A parameter
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -96,19 +96,19 @@ 

Method Details

Returns: An object of the form: - { # Resource capturing the settings for the Virtual Machine Threat Detection service. - "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's configuration. - "a_key": { # Configuration of a module. - "moduleEnablementState": "A String", # The state of enablement for the module at its level of the resource hierarchy. - "value": { # The configuration value for the module. The absence of this field implies its inheritance from the parent. + { + "modules": { + "a_key": { + "moduleEnablementState": "A String", + "value": { "a_key": "", # Properties of the object. }, }, }, - "name": "A String", # Identifier. The resource name of the VirtualMachineThreatDetectionSettings. Formats: * organizations/{organization}/virtualMachineThreatDetectionSettings * folders/{folder}/virtualMachineThreatDetectionSettings * projects/{project}/virtualMachineThreatDetectionSettings - "serviceAccount": "A String", # Output only. The service account used by Virtual Machine Threat Detection detectors. - "serviceEnablementState": "A String", # The state of enablement for the service at its level of the resource hierarchy. A DISABLED state will override all module enablement_states to DISABLED. - "updateTime": "A String", # Output only. The time the settings were last updated. + "name": "A String", + "serviceAccount": "A String", + "serviceEnablementState": "A String", + "updateTime": "A String", }
diff --git a/docs/dyn/securitycenter_v1beta2.projects.webSecurityScannerSettings.html b/docs/dyn/securitycenter_v1beta2.projects.webSecurityScannerSettings.html index e6a066b458..5e4444ade9 100644 --- a/docs/dyn/securitycenter_v1beta2.projects.webSecurityScannerSettings.html +++ b/docs/dyn/securitycenter_v1beta2.projects.webSecurityScannerSettings.html @@ -76,18 +76,18 @@

Security Command Center API . Instance Methods

calculate(name, showEligibleModulesOnly=None, x__xgafv=None)

-

Calculates the effective WebSecurityScannerSettings based on its level in the resource hierarchy and its settings. Settings provided closer to the target resource take precedence over those further away (e.g. folder will override organization level settings). The default SCC setting for the detector service defaults can be overridden at organization, folder and project levels. No assumptions should be made about the SCC defaults as it is considered an internal implementation detail.

+

close()

Close httplib2 connections.

Method Details

calculate(name, showEligibleModulesOnly=None, x__xgafv=None) -
Calculates the effective WebSecurityScannerSettings based on its level in the resource hierarchy and its settings. Settings provided closer to the target resource take precedence over those further away (e.g. folder will override organization level settings). The default SCC setting for the detector service defaults can be overridden at organization, folder and project levels. No assumptions should be made about the SCC defaults as it is considered an internal implementation detail.
+  
 
 Args:
-  name: string, Required. The name of the WebSecurityScannerSettings to calculate. Formats: * organizations/{organization}/webSecurityScannerSettings * folders/{folder}/webSecurityScannerSettings * projects/{project}/webSecurityScannerSettings (required)
-  showEligibleModulesOnly: boolean, Optional. When set, will only retrieve the modules that are in scope. By default, all modules will be shown.
+  name: string, A parameter (required)
+  showEligibleModulesOnly: boolean, A parameter
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -96,18 +96,18 @@ 

Method Details

Returns: An object of the form: - { # Resource capturing the settings for the Web Security Scanner service. - "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's configuration. - "a_key": { # Configuration of a module. - "moduleEnablementState": "A String", # The state of enablement for the module at its level of the resource hierarchy. - "value": { # The configuration value for the module. The absence of this field implies its inheritance from the parent. + { + "modules": { + "a_key": { + "moduleEnablementState": "A String", + "value": { "a_key": "", # Properties of the object. }, }, }, - "name": "A String", # Identifier. The resource name of the WebSecurityScannerSettings. Formats: * organizations/{organization}/webSecurityScannerSettings * folders/{folder}/webSecurityScannerSettings * projects/{project}/webSecurityScannerSettings - "serviceEnablementState": "A String", # The state of enablement for the service at its level of the resource hierarchy. A DISABLED state will override all module enablement_states to DISABLED. - "updateTime": "A String", # Output only. The time the settings were last updated. + "name": "A String", + "serviceEnablementState": "A String", + "updateTime": "A String", }
diff --git a/docs/dyn/servicecontrol_v2.services.html b/docs/dyn/servicecontrol_v2.services.html index d1f29db4a4..c3d131c9c1 100644 --- a/docs/dyn/servicecontrol_v2.services.html +++ b/docs/dyn/servicecontrol_v2.services.html @@ -135,6 +135,7 @@

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. }, + "credentialId": "A String", # Identifies the client credential id used for authentication. credential_id is in the format of AUTH_METHOD:IDENTIFIER, e.g. "serviceaccount:XXXXX, apikey:XXXXX" where the format of the IDENTIFIER can vary for different AUTH_METHODs. "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. }, @@ -290,6 +291,7 @@

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. }, + "credentialId": "A String", # Identifies the client credential id used for authentication. credential_id is in the format of AUTH_METHOD:IDENTIFIER, e.g. "serviceaccount:XXXXX, apikey:XXXXX" where the format of the IDENTIFIER can vary for different AUTH_METHODs. "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. }, diff --git a/docs/dyn/storage_v1.buckets.html b/docs/dyn/storage_v1.buckets.html index 2305822e6f..cfaa2ea5b2 100644 --- a/docs/dyn/storage_v1.buckets.html +++ b/docs/dyn/storage_v1.buckets.html @@ -327,6 +327,8 @@

Method Details

], "noncurrentTimeBefore": "A String", # A date in RFC 3339 format with only the date part (for instance, "2013-01-15"). This condition is satisfied when the noncurrent time on an object is before this date in UTC. This condition is relevant only for versioned objects. "numNewerVersions": 42, # Relevant only for versioned objects. If the value is N, this condition is satisfied when there are at least N versions (including the live version) newer than this version of the object. + "sizeAboveBytes": "A String", # Objects having a size greater than this value in bytes will be matched. + "sizeBelowBytes": "A String", # Objects having a size less than this value in bytes will be matched. }, }, ], @@ -634,6 +636,8 @@

Method Details

], "noncurrentTimeBefore": "A String", # A date in RFC 3339 format with only the date part (for instance, "2013-01-15"). This condition is satisfied when the noncurrent time on an object is before this date in UTC. This condition is relevant only for versioned objects. "numNewerVersions": 42, # Relevant only for versioned objects. If the value is N, this condition is satisfied when there are at least N versions (including the live version) newer than this version of the object. + "sizeAboveBytes": "A String", # Objects having a size greater than this value in bytes will be matched. + "sizeBelowBytes": "A String", # Objects having a size less than this value in bytes will be matched. }, }, ], @@ -876,6 +880,8 @@

Method Details

], "noncurrentTimeBefore": "A String", # A date in RFC 3339 format with only the date part (for instance, "2013-01-15"). This condition is satisfied when the noncurrent time on an object is before this date in UTC. This condition is relevant only for versioned objects. "numNewerVersions": 42, # Relevant only for versioned objects. If the value is N, this condition is satisfied when there are at least N versions (including the live version) newer than this version of the object. + "sizeAboveBytes": "A String", # Objects having a size greater than this value in bytes will be matched. + "sizeBelowBytes": "A String", # Objects having a size less than this value in bytes will be matched. }, }, ], @@ -1116,6 +1122,8 @@

Method Details

], "noncurrentTimeBefore": "A String", # A date in RFC 3339 format with only the date part (for instance, "2013-01-15"). This condition is satisfied when the noncurrent time on an object is before this date in UTC. This condition is relevant only for versioned objects. "numNewerVersions": 42, # Relevant only for versioned objects. If the value is N, this condition is satisfied when there are at least N versions (including the live version) newer than this version of the object. + "sizeAboveBytes": "A String", # Objects having a size greater than this value in bytes will be matched. + "sizeBelowBytes": "A String", # Objects having a size less than this value in bytes will be matched. }, }, ], @@ -1367,6 +1375,8 @@

Method Details

], "noncurrentTimeBefore": "A String", # A date in RFC 3339 format with only the date part (for instance, "2013-01-15"). This condition is satisfied when the noncurrent time on an object is before this date in UTC. This condition is relevant only for versioned objects. "numNewerVersions": 42, # Relevant only for versioned objects. If the value is N, this condition is satisfied when there are at least N versions (including the live version) newer than this version of the object. + "sizeAboveBytes": "A String", # Objects having a size greater than this value in bytes will be matched. + "sizeBelowBytes": "A String", # Objects having a size less than this value in bytes will be matched. }, }, ], @@ -1594,6 +1604,8 @@

Method Details

], "noncurrentTimeBefore": "A String", # A date in RFC 3339 format with only the date part (for instance, "2013-01-15"). This condition is satisfied when the noncurrent time on an object is before this date in UTC. This condition is relevant only for versioned objects. "numNewerVersions": 42, # Relevant only for versioned objects. If the value is N, this condition is satisfied when there are at least N versions (including the live version) newer than this version of the object. + "sizeAboveBytes": "A String", # Objects having a size greater than this value in bytes will be matched. + "sizeBelowBytes": "A String", # Objects having a size less than this value in bytes will be matched. }, }, ], @@ -1837,6 +1849,8 @@

Method Details

], "noncurrentTimeBefore": "A String", # A date in RFC 3339 format with only the date part (for instance, "2013-01-15"). This condition is satisfied when the noncurrent time on an object is before this date in UTC. This condition is relevant only for versioned objects. "numNewerVersions": 42, # Relevant only for versioned objects. If the value is N, this condition is satisfied when there are at least N versions (including the live version) newer than this version of the object. + "sizeAboveBytes": "A String", # Objects having a size greater than this value in bytes will be matched. + "sizeBelowBytes": "A String", # Objects having a size less than this value in bytes will be matched. }, }, ], @@ -2118,6 +2132,8 @@

Method Details

], "noncurrentTimeBefore": "A String", # A date in RFC 3339 format with only the date part (for instance, "2013-01-15"). This condition is satisfied when the noncurrent time on an object is before this date in UTC. This condition is relevant only for versioned objects. "numNewerVersions": 42, # Relevant only for versioned objects. If the value is N, this condition is satisfied when there are at least N versions (including the live version) newer than this version of the object. + "sizeAboveBytes": "A String", # Objects having a size greater than this value in bytes will be matched. + "sizeBelowBytes": "A String", # Objects having a size less than this value in bytes will be matched. }, }, ], @@ -2480,6 +2496,8 @@

Method Details

], "noncurrentTimeBefore": "A String", # A date in RFC 3339 format with only the date part (for instance, "2013-01-15"). This condition is satisfied when the noncurrent time on an object is before this date in UTC. This condition is relevant only for versioned objects. "numNewerVersions": 42, # Relevant only for versioned objects. If the value is N, this condition is satisfied when there are at least N versions (including the live version) newer than this version of the object. + "sizeAboveBytes": "A String", # Objects having a size greater than this value in bytes will be matched. + "sizeBelowBytes": "A String", # Objects having a size less than this value in bytes will be matched. }, }, ], @@ -2723,6 +2741,8 @@

Method Details

], "noncurrentTimeBefore": "A String", # A date in RFC 3339 format with only the date part (for instance, "2013-01-15"). This condition is satisfied when the noncurrent time on an object is before this date in UTC. This condition is relevant only for versioned objects. "numNewerVersions": 42, # Relevant only for versioned objects. If the value is N, this condition is satisfied when there are at least N versions (including the live version) newer than this version of the object. + "sizeAboveBytes": "A String", # Objects having a size greater than this value in bytes will be matched. + "sizeBelowBytes": "A String", # Objects having a size less than this value in bytes will be matched. }, }, ], diff --git a/docs/dyn/threatintelligence_v1beta.projects.configurations.html b/docs/dyn/threatintelligence_v1beta.projects.configurations.html index ddbf66d83e..faf5e59d74 100644 --- a/docs/dyn/threatintelligence_v1beta.projects.configurations.html +++ b/docs/dyn/threatintelligence_v1beta.projects.configurations.html @@ -284,6 +284,7 @@

Method Details

"detailType": "A String", # Output only. Name of the detail type. Will be set by the server during creation to the name of the field that is set in the detail union. }, "displayName": "A String", # Output only. Human readable name for the configuration. + "etag": "A String", # If included when updating a configuration, this should be set to the current etag of the configuration. If the etags do not match, the update will be rejected and an ABORTED error will be returned. "name": "A String", # Identifier. Server generated name for the configuration. format is projects/{project}/configurations/{configuration} "provider": "A String", # Required. Name of the service that provides the configuration. "state": "A String", # Optional. State of the configuration. @@ -481,6 +482,7 @@

Method Details

"detailType": "A String", # Output only. Name of the detail type. Will be set by the server during creation to the name of the field that is set in the detail union. }, "displayName": "A String", # Output only. Human readable name for the configuration. + "etag": "A String", # If included when updating a configuration, this should be set to the current etag of the configuration. If the etags do not match, the update will be rejected and an ABORTED error will be returned. "name": "A String", # Identifier. Server generated name for the configuration. format is projects/{project}/configurations/{configuration} "provider": "A String", # Required. Name of the service that provides the configuration. "state": "A String", # Optional. State of the configuration. @@ -684,6 +686,7 @@

Method Details

"detailType": "A String", # Output only. Name of the detail type. Will be set by the server during creation to the name of the field that is set in the detail union. }, "displayName": "A String", # Output only. Human readable name for the configuration. + "etag": "A String", # If included when updating a configuration, this should be set to the current etag of the configuration. If the etags do not match, the update will be rejected and an ABORTED error will be returned. "name": "A String", # Identifier. Server generated name for the configuration. format is projects/{project}/configurations/{configuration} "provider": "A String", # Required. Name of the service that provides the configuration. "state": "A String", # Optional. State of the configuration. diff --git a/docs/dyn/threatintelligence_v1beta.projects.configurations.revisions.html b/docs/dyn/threatintelligence_v1beta.projects.configurations.revisions.html index c90a6fe47e..a914248406 100644 --- a/docs/dyn/threatintelligence_v1beta.projects.configurations.revisions.html +++ b/docs/dyn/threatintelligence_v1beta.projects.configurations.revisions.html @@ -283,6 +283,7 @@

Method Details

"detailType": "A String", # Output only. Name of the detail type. Will be set by the server during creation to the name of the field that is set in the detail union. }, "displayName": "A String", # Output only. Human readable name for the configuration. + "etag": "A String", # If included when updating a configuration, this should be set to the current etag of the configuration. If the etags do not match, the update will be rejected and an ABORTED error will be returned. "name": "A String", # Identifier. Server generated name for the configuration. format is projects/{project}/configurations/{configuration} "provider": "A String", # Required. Name of the service that provides the configuration. "state": "A String", # Optional. State of the configuration. diff --git a/docs/dyn/travelimpactmodel_v1.flights.html b/docs/dyn/travelimpactmodel_v1.flights.html index 76e6b786a2..982ecbfb5f 100644 --- a/docs/dyn/travelimpactmodel_v1.flights.html +++ b/docs/dyn/travelimpactmodel_v1.flights.html @@ -79,7 +79,7 @@

Instance Methods

Close httplib2 connections.

computeFlightEmissions(body=None, x__xgafv=None)

-

Stateless method to retrieve emission estimates. Details on how emission estimates are computed are in [GitHub](https://github.com/google/travel-impact-model) The response will contain all entries that match the input flight legs, in the same order. If there are no estimates available for a certain flight leg, the response will return the flight leg object with empty emission fields. The request will still be considered successful. Reasons for missing emission estimates include: * The flight is unknown to the server. * The input flight leg is missing one or more identifiers. * The flight date is in the past. * The aircraft type is not supported by the model. * Missing seat configuration. The request can contain up to 1000 flight legs. If the request has more than 1000 direct flights, if will fail with an INVALID_ARGUMENT error.

+

Stateless method to retrieve emission estimates. Details on how emission estimates are computed are in [GitHub](https://github.com/google/travel-impact-model). The response will contain all entries that match the input flight legs, in the same order. If there are no estimates available for a certain flight leg, the response will return the flight leg object with empty emission fields. The request will still be considered successful. Reasons for missing emission estimates include: * The flight is unknown to the server. * The input flight leg is missing one or more identifiers. * The flight date is in the past. * The aircraft type is not supported by the model. * Missing seat configuration. The request can contain up to 1000 flight legs. If the request has more than 1000 direct flights, if will fail with an INVALID_ARGUMENT error.

computeScope3FlightEmissions(body=None, x__xgafv=None)

Stateless method to retrieve GHG emissions estimates for a set of flight segments for Scope 3 reporting. The response will contain all entries that match the input Scope3FlightSegment flight segments, in the same order provided. The estimates will be computed using the following cascading logic (using the first one that is available): 1. TIM-based emissions given origin, destination, carrier, flightNumber, departureDate, and cabinClass. 2. Typical flight emissions given origin, destination, year in departureDate, and cabinClass. 3. Distance-based emissions calculated using distanceKm, year in departureDate, and cabinClass. If there is a future flight requested in this calendar year, we do not support Tier 1 emissions and will fallback to Tier 2 or 3 emissions. If the requested future flight is in not in this calendar year, we will return an empty response. We recommend that for future flights, computeFlightEmissions API is used instead. If there are no estimates available for a certain flight with any of the three methods, the response will return a Scope3FlightEmissions object with empty emission fields. The request will still be considered successful. Generally, missing emissions estimates occur when the flight is unknown to the server (e.g. no specific flight exists, or typical flight emissions are not available for the requested pair). The request will fail with an `INVALID_ARGUMENT` error if: * The request contains more than 1,000 flight legs. * The input flight leg is missing one or more identifiers. For example, missing origin/destination without a valid distance for TIM_EMISSIONS or TYPICAL_FLIGHT_EMISSIONS type matching, or missing distance for a DISTANCE_BASED_EMISSIONS type matching (if you want to fallback to distance-based emissions or want a distance-based emissions estimate, you need to specify a distance). * The flight date is before 2019 (Scope 3 data is only available for 2019 and after). * The flight distance is 0 or lower. * Missing cabin class. Because the request is processed with fallback logic, it is possible that misconfigured requests return valid emissions estimates using fallback methods. For example, if a request has the wrong flight number but specifies the origin and destination, the request will still succeed, but the returned emissions will be based solely on the typical flight emissions. Similarly, if a request is missing the origin for a typical flight emissions request, but specifies a valid distance, the request could succeed based solely on the distance-based emissions. Consequently, one should check the source of the returned emissions (source) to confirm the results are as expected.

@@ -94,7 +94,7 @@

Method Details

computeFlightEmissions(body=None, x__xgafv=None) -
Stateless method to retrieve emission estimates. Details on how emission estimates are computed are in [GitHub](https://github.com/google/travel-impact-model) The response will contain all entries that match the input flight legs, in the same order. If there are no estimates available for a certain flight leg, the response will return the flight leg object with empty emission fields. The request will still be considered successful. Reasons for missing emission estimates include: * The flight is unknown to the server. * The input flight leg is missing one or more identifiers. * The flight date is in the past. * The aircraft type is not supported by the model. * Missing seat configuration. The request can contain up to 1000 flight legs. If the request has more than 1000 direct flights, if will fail with an INVALID_ARGUMENT error.
+  
Stateless method to retrieve emission estimates. Details on how emission estimates are computed are in [GitHub](https://github.com/google/travel-impact-model). The response will contain all entries that match the input flight legs, in the same order. If there are no estimates available for a certain flight leg, the response will return the flight leg object with empty emission fields. The request will still be considered successful. Reasons for missing emission estimates include: * The flight is unknown to the server. * The input flight leg is missing one or more identifiers. * The flight date is in the past. * The aircraft type is not supported by the model. * Missing seat configuration. The request can contain up to 1000 flight legs. If the request has more than 1000 direct flights, if will fail with an INVALID_ARGUMENT error.
 
 Args:
   body: object, The request body.
diff --git a/docs/dyn/vmmigration_v1.projects.locations.sources.migratingVms.cloneJobs.html b/docs/dyn/vmmigration_v1.projects.locations.sources.migratingVms.cloneJobs.html
index 2ad9e0b6ba..1dbb1fc471 100644
--- a/docs/dyn/vmmigration_v1.projects.locations.sources.migratingVms.cloneJobs.html
+++ b/docs/dyn/vmmigration_v1.projects.locations.sources.migratingVms.cloneJobs.html
@@ -152,8 +152,8 @@ 

Method Details

"computeEngineDisksTargetDetails": { # ComputeEngineDisksTargetDetails is a collection of created Persistent Disks details. # Output only. Details of the target Persistent Disks in Compute Engine. "disks": [ # The details of each created Persistent Disk. { # Details of a created Persistent Disk. - "diskUri": "A String", # The URI of the Persistent Disk. - "sourceDiskNumber": 42, # The ordinal number of the source VM disk. + "diskUri": "A String", # Output only. The URI of the Persistent Disk. + "sourceDiskNumber": 42, # Output only. The ordinal number of the source VM disk. }, ], "disksTargetDetails": { # Details for a disks-only migration. # Details of the disks-only migration target. @@ -307,8 +307,8 @@

Method Details

"computeEngineDisksTargetDetails": { # ComputeEngineDisksTargetDetails is a collection of created Persistent Disks details. # Output only. Details of the target Persistent Disks in Compute Engine. "disks": [ # The details of each created Persistent Disk. { # Details of a created Persistent Disk. - "diskUri": "A String", # The URI of the Persistent Disk. - "sourceDiskNumber": 42, # The ordinal number of the source VM disk. + "diskUri": "A String", # Output only. The URI of the Persistent Disk. + "sourceDiskNumber": 42, # Output only. The ordinal number of the source VM disk. }, ], "disksTargetDetails": { # Details for a disks-only migration. # Details of the disks-only migration target. @@ -438,8 +438,8 @@

Method Details

"computeEngineDisksTargetDetails": { # ComputeEngineDisksTargetDetails is a collection of created Persistent Disks details. # Output only. Details of the target Persistent Disks in Compute Engine. "disks": [ # The details of each created Persistent Disk. { # Details of a created Persistent Disk. - "diskUri": "A String", # The URI of the Persistent Disk. - "sourceDiskNumber": 42, # The ordinal number of the source VM disk. + "diskUri": "A String", # Output only. The URI of the Persistent Disk. + "sourceDiskNumber": 42, # Output only. The ordinal number of the source VM disk. }, ], "disksTargetDetails": { # Details for a disks-only migration. # Details of the disks-only migration target. diff --git a/docs/dyn/vmmigration_v1.projects.locations.sources.migratingVms.cutoverJobs.html b/docs/dyn/vmmigration_v1.projects.locations.sources.migratingVms.cutoverJobs.html index ba1db178b6..c882b547ca 100644 --- a/docs/dyn/vmmigration_v1.projects.locations.sources.migratingVms.cutoverJobs.html +++ b/docs/dyn/vmmigration_v1.projects.locations.sources.migratingVms.cutoverJobs.html @@ -152,8 +152,8 @@

Method Details

"computeEngineDisksTargetDetails": { # ComputeEngineDisksTargetDetails is a collection of created Persistent Disks details. # Output only. Details of the target Persistent Disks in Compute Engine. "disks": [ # The details of each created Persistent Disk. { # Details of a created Persistent Disk. - "diskUri": "A String", # The URI of the Persistent Disk. - "sourceDiskNumber": 42, # The ordinal number of the source VM disk. + "diskUri": "A String", # Output only. The URI of the Persistent Disk. + "sourceDiskNumber": 42, # Output only. The ordinal number of the source VM disk. }, ], "disksTargetDetails": { # Details for a disks-only migration. # Details of the disks-only migration target. @@ -417,8 +417,8 @@

Method Details

"computeEngineDisksTargetDetails": { # ComputeEngineDisksTargetDetails is a collection of created Persistent Disks details. # Output only. Details of the target Persistent Disks in Compute Engine. "disks": [ # The details of each created Persistent Disk. { # Details of a created Persistent Disk. - "diskUri": "A String", # The URI of the Persistent Disk. - "sourceDiskNumber": 42, # The ordinal number of the source VM disk. + "diskUri": "A String", # Output only. The URI of the Persistent Disk. + "sourceDiskNumber": 42, # Output only. The ordinal number of the source VM disk. }, ], "disksTargetDetails": { # Details for a disks-only migration. # Details of the disks-only migration target. @@ -658,8 +658,8 @@

Method Details

"computeEngineDisksTargetDetails": { # ComputeEngineDisksTargetDetails is a collection of created Persistent Disks details. # Output only. Details of the target Persistent Disks in Compute Engine. "disks": [ # The details of each created Persistent Disk. { # Details of a created Persistent Disk. - "diskUri": "A String", # The URI of the Persistent Disk. - "sourceDiskNumber": 42, # The ordinal number of the source VM disk. + "diskUri": "A String", # Output only. The URI of the Persistent Disk. + "sourceDiskNumber": 42, # Output only. The ordinal number of the source VM disk. }, ], "disksTargetDetails": { # Details for a disks-only migration. # Details of the disks-only migration target. diff --git a/docs/dyn/vmmigration_v1.projects.locations.sources.migratingVms.html b/docs/dyn/vmmigration_v1.projects.locations.sources.migratingVms.html index cc621189b4..472b1f86e7 100644 --- a/docs/dyn/vmmigration_v1.projects.locations.sources.migratingVms.html +++ b/docs/dyn/vmmigration_v1.projects.locations.sources.migratingVms.html @@ -292,6 +292,22 @@

Method Details

"A String", ], "diskType": "A String", # The disk type to use in the VM. + "disks": [ # Optional. The details of each disk to create. + { # Details for creation of a Persistent Disk. + "additionalLabels": { # A map of labels to associate with the Persistent Disk. + "a_key": "A String", + }, + "diskName": "A String", # Optional. The name of the Persistent Disk to create. + "diskType": "A String", # The disk type to use. + "encryption": { # Encryption message describes the details of the applied encryption. # Optional. The encryption to apply to the disk. + "kmsKey": "A String", # Required. The name of the encryption key that is stored in Google Cloud KMS. + }, + "sourceDiskNumber": 42, # Required. The ordinal number of the source VM disk. + "vmAttachmentDetails": { # Details for attachment of the disk to a VM. # Optional. Details for attachment of the disk to a VM. Used when the disk is set to be attached to a target VM. + "deviceName": "A String", # Optional. Specifies a unique device name of your choice that is reflected into the /dev/disk/by-id/google-* tree of a Linux operating system running within the instance. If not specified, the server chooses a default device name to apply to this disk, in the form persistent-disk-x, where x is a number assigned by Google Compute Engine. This field is only applicable for persistent disks. + }, + }, + ], "enableIntegrityMonitoring": True or False, # Optional. Defines whether the instance has integrity monitoring enabled. This can be set to true only if the VM boot option is EFI, and vTPM is enabled. "enableVtpm": True or False, # Optional. Defines whether the instance has vTPM enabled. This can be set to true only if the VM boot option is EFI. "encryption": { # Encryption message describes the details of the applied encryption. # Optional. Immutable. The encryption to apply to the VM disks. @@ -471,8 +487,8 @@

Method Details

"computeEngineDisksTargetDetails": { # ComputeEngineDisksTargetDetails is a collection of created Persistent Disks details. # Output only. Details of the target Persistent Disks in Compute Engine. "disks": [ # The details of each created Persistent Disk. { # Details of a created Persistent Disk. - "diskUri": "A String", # The URI of the Persistent Disk. - "sourceDiskNumber": 42, # The ordinal number of the source VM disk. + "diskUri": "A String", # Output only. The URI of the Persistent Disk. + "sourceDiskNumber": 42, # Output only. The ordinal number of the source VM disk. }, ], "disksTargetDetails": { # Details for a disks-only migration. # Details of the disks-only migration target. @@ -582,8 +598,8 @@

Method Details

"computeEngineDisksTargetDetails": { # ComputeEngineDisksTargetDetails is a collection of created Persistent Disks details. # Output only. Details of the target Persistent Disks in Compute Engine. "disks": [ # The details of each created Persistent Disk. { # Details of a created Persistent Disk. - "diskUri": "A String", # The URI of the Persistent Disk. - "sourceDiskNumber": 42, # The ordinal number of the source VM disk. + "diskUri": "A String", # Output only. The URI of the Persistent Disk. + "sourceDiskNumber": 42, # Output only. The ordinal number of the source VM disk. }, ], "disksTargetDetails": { # Details for a disks-only migration. # Details of the disks-only migration target. @@ -1141,6 +1157,22 @@

Method Details

"A String", ], "diskType": "A String", # The disk type to use in the VM. + "disks": [ # Optional. The details of each disk to create. + { # Details for creation of a Persistent Disk. + "additionalLabels": { # A map of labels to associate with the Persistent Disk. + "a_key": "A String", + }, + "diskName": "A String", # Optional. The name of the Persistent Disk to create. + "diskType": "A String", # The disk type to use. + "encryption": { # Encryption message describes the details of the applied encryption. # Optional. The encryption to apply to the disk. + "kmsKey": "A String", # Required. The name of the encryption key that is stored in Google Cloud KMS. + }, + "sourceDiskNumber": 42, # Required. The ordinal number of the source VM disk. + "vmAttachmentDetails": { # Details for attachment of the disk to a VM. # Optional. Details for attachment of the disk to a VM. Used when the disk is set to be attached to a target VM. + "deviceName": "A String", # Optional. Specifies a unique device name of your choice that is reflected into the /dev/disk/by-id/google-* tree of a Linux operating system running within the instance. If not specified, the server chooses a default device name to apply to this disk, in the form persistent-disk-x, where x is a number assigned by Google Compute Engine. This field is only applicable for persistent disks. + }, + }, + ], "enableIntegrityMonitoring": True or False, # Optional. Defines whether the instance has integrity monitoring enabled. This can be set to true only if the VM boot option is EFI, and vTPM is enabled. "enableVtpm": True or False, # Optional. Defines whether the instance has vTPM enabled. This can be set to true only if the VM boot option is EFI. "encryption": { # Encryption message describes the details of the applied encryption. # Optional. Immutable. The encryption to apply to the VM disks. @@ -1320,8 +1352,8 @@

Method Details

"computeEngineDisksTargetDetails": { # ComputeEngineDisksTargetDetails is a collection of created Persistent Disks details. # Output only. Details of the target Persistent Disks in Compute Engine. "disks": [ # The details of each created Persistent Disk. { # Details of a created Persistent Disk. - "diskUri": "A String", # The URI of the Persistent Disk. - "sourceDiskNumber": 42, # The ordinal number of the source VM disk. + "diskUri": "A String", # Output only. The URI of the Persistent Disk. + "sourceDiskNumber": 42, # Output only. The ordinal number of the source VM disk. }, ], "disksTargetDetails": { # Details for a disks-only migration. # Details of the disks-only migration target. @@ -1431,8 +1463,8 @@

Method Details

"computeEngineDisksTargetDetails": { # ComputeEngineDisksTargetDetails is a collection of created Persistent Disks details. # Output only. Details of the target Persistent Disks in Compute Engine. "disks": [ # The details of each created Persistent Disk. { # Details of a created Persistent Disk. - "diskUri": "A String", # The URI of the Persistent Disk. - "sourceDiskNumber": 42, # The ordinal number of the source VM disk. + "diskUri": "A String", # Output only. The URI of the Persistent Disk. + "sourceDiskNumber": 42, # Output only. The ordinal number of the source VM disk. }, ], "disksTargetDetails": { # Details for a disks-only migration. # Details of the disks-only migration target. @@ -1849,6 +1881,22 @@

Method Details

"A String", ], "diskType": "A String", # The disk type to use in the VM. + "disks": [ # Optional. The details of each disk to create. + { # Details for creation of a Persistent Disk. + "additionalLabels": { # A map of labels to associate with the Persistent Disk. + "a_key": "A String", + }, + "diskName": "A String", # Optional. The name of the Persistent Disk to create. + "diskType": "A String", # The disk type to use. + "encryption": { # Encryption message describes the details of the applied encryption. # Optional. The encryption to apply to the disk. + "kmsKey": "A String", # Required. The name of the encryption key that is stored in Google Cloud KMS. + }, + "sourceDiskNumber": 42, # Required. The ordinal number of the source VM disk. + "vmAttachmentDetails": { # Details for attachment of the disk to a VM. # Optional. Details for attachment of the disk to a VM. Used when the disk is set to be attached to a target VM. + "deviceName": "A String", # Optional. Specifies a unique device name of your choice that is reflected into the /dev/disk/by-id/google-* tree of a Linux operating system running within the instance. If not specified, the server chooses a default device name to apply to this disk, in the form persistent-disk-x, where x is a number assigned by Google Compute Engine. This field is only applicable for persistent disks. + }, + }, + ], "enableIntegrityMonitoring": True or False, # Optional. Defines whether the instance has integrity monitoring enabled. This can be set to true only if the VM boot option is EFI, and vTPM is enabled. "enableVtpm": True or False, # Optional. Defines whether the instance has vTPM enabled. This can be set to true only if the VM boot option is EFI. "encryption": { # Encryption message describes the details of the applied encryption. # Optional. Immutable. The encryption to apply to the VM disks. @@ -2028,8 +2076,8 @@

Method Details

"computeEngineDisksTargetDetails": { # ComputeEngineDisksTargetDetails is a collection of created Persistent Disks details. # Output only. Details of the target Persistent Disks in Compute Engine. "disks": [ # The details of each created Persistent Disk. { # Details of a created Persistent Disk. - "diskUri": "A String", # The URI of the Persistent Disk. - "sourceDiskNumber": 42, # The ordinal number of the source VM disk. + "diskUri": "A String", # Output only. The URI of the Persistent Disk. + "sourceDiskNumber": 42, # Output only. The ordinal number of the source VM disk. }, ], "disksTargetDetails": { # Details for a disks-only migration. # Details of the disks-only migration target. @@ -2139,8 +2187,8 @@

Method Details

"computeEngineDisksTargetDetails": { # ComputeEngineDisksTargetDetails is a collection of created Persistent Disks details. # Output only. Details of the target Persistent Disks in Compute Engine. "disks": [ # The details of each created Persistent Disk. { # Details of a created Persistent Disk. - "diskUri": "A String", # The URI of the Persistent Disk. - "sourceDiskNumber": 42, # The ordinal number of the source VM disk. + "diskUri": "A String", # Output only. The URI of the Persistent Disk. + "sourceDiskNumber": 42, # Output only. The ordinal number of the source VM disk. }, ], "disksTargetDetails": { # Details for a disks-only migration. # Details of the disks-only migration target. @@ -2561,6 +2609,22 @@

Method Details

"A String", ], "diskType": "A String", # The disk type to use in the VM. + "disks": [ # Optional. The details of each disk to create. + { # Details for creation of a Persistent Disk. + "additionalLabels": { # A map of labels to associate with the Persistent Disk. + "a_key": "A String", + }, + "diskName": "A String", # Optional. The name of the Persistent Disk to create. + "diskType": "A String", # The disk type to use. + "encryption": { # Encryption message describes the details of the applied encryption. # Optional. The encryption to apply to the disk. + "kmsKey": "A String", # Required. The name of the encryption key that is stored in Google Cloud KMS. + }, + "sourceDiskNumber": 42, # Required. The ordinal number of the source VM disk. + "vmAttachmentDetails": { # Details for attachment of the disk to a VM. # Optional. Details for attachment of the disk to a VM. Used when the disk is set to be attached to a target VM. + "deviceName": "A String", # Optional. Specifies a unique device name of your choice that is reflected into the /dev/disk/by-id/google-* tree of a Linux operating system running within the instance. If not specified, the server chooses a default device name to apply to this disk, in the form persistent-disk-x, where x is a number assigned by Google Compute Engine. This field is only applicable for persistent disks. + }, + }, + ], "enableIntegrityMonitoring": True or False, # Optional. Defines whether the instance has integrity monitoring enabled. This can be set to true only if the VM boot option is EFI, and vTPM is enabled. "enableVtpm": True or False, # Optional. Defines whether the instance has vTPM enabled. This can be set to true only if the VM boot option is EFI. "encryption": { # Encryption message describes the details of the applied encryption. # Optional. Immutable. The encryption to apply to the VM disks. @@ -2740,8 +2804,8 @@

Method Details

"computeEngineDisksTargetDetails": { # ComputeEngineDisksTargetDetails is a collection of created Persistent Disks details. # Output only. Details of the target Persistent Disks in Compute Engine. "disks": [ # The details of each created Persistent Disk. { # Details of a created Persistent Disk. - "diskUri": "A String", # The URI of the Persistent Disk. - "sourceDiskNumber": 42, # The ordinal number of the source VM disk. + "diskUri": "A String", # Output only. The URI of the Persistent Disk. + "sourceDiskNumber": 42, # Output only. The ordinal number of the source VM disk. }, ], "disksTargetDetails": { # Details for a disks-only migration. # Details of the disks-only migration target. @@ -2851,8 +2915,8 @@

Method Details

"computeEngineDisksTargetDetails": { # ComputeEngineDisksTargetDetails is a collection of created Persistent Disks details. # Output only. Details of the target Persistent Disks in Compute Engine. "disks": [ # The details of each created Persistent Disk. { # Details of a created Persistent Disk. - "diskUri": "A String", # The URI of the Persistent Disk. - "sourceDiskNumber": 42, # The ordinal number of the source VM disk. + "diskUri": "A String", # Output only. The URI of the Persistent Disk. + "sourceDiskNumber": 42, # Output only. The ordinal number of the source VM disk. }, ], "disksTargetDetails": { # Details for a disks-only migration. # Details of the disks-only migration target. diff --git a/docs/dyn/vmmigration_v1alpha1.projects.locations.sources.migratingVms.cloneJobs.html b/docs/dyn/vmmigration_v1alpha1.projects.locations.sources.migratingVms.cloneJobs.html index d4ffdc5224..86b170e68c 100644 --- a/docs/dyn/vmmigration_v1alpha1.projects.locations.sources.migratingVms.cloneJobs.html +++ b/docs/dyn/vmmigration_v1alpha1.projects.locations.sources.migratingVms.cloneJobs.html @@ -152,8 +152,8 @@

Method Details

"computeEngineDisksTargetDetails": { # ComputeEngineDisksTargetDetails is a collection of created Persistent Disks details. # Output only. Details of the target Persistent Disks in Compute Engine. "disks": [ # The details of each created Persistent Disk. { # Details of a created Persistent Disk. - "diskUri": "A String", # The URI of the Persistent Disk. - "sourceDiskNumber": 42, # The ordinal number of the source VM disk. + "diskUri": "A String", # Output only. The URI of the Persistent Disk. + "sourceDiskNumber": 42, # Output only. The ordinal number of the source VM disk. }, ], "disksTargetDetails": { # Details for a disks-only migration. # Details of the disks-only migration target. @@ -416,8 +416,8 @@

Method Details

"computeEngineDisksTargetDetails": { # ComputeEngineDisksTargetDetails is a collection of created Persistent Disks details. # Output only. Details of the target Persistent Disks in Compute Engine. "disks": [ # The details of each created Persistent Disk. { # Details of a created Persistent Disk. - "diskUri": "A String", # The URI of the Persistent Disk. - "sourceDiskNumber": 42, # The ordinal number of the source VM disk. + "diskUri": "A String", # Output only. The URI of the Persistent Disk. + "sourceDiskNumber": 42, # Output only. The ordinal number of the source VM disk. }, ], "disksTargetDetails": { # Details for a disks-only migration. # Details of the disks-only migration target. @@ -656,8 +656,8 @@

Method Details

"computeEngineDisksTargetDetails": { # ComputeEngineDisksTargetDetails is a collection of created Persistent Disks details. # Output only. Details of the target Persistent Disks in Compute Engine. "disks": [ # The details of each created Persistent Disk. { # Details of a created Persistent Disk. - "diskUri": "A String", # The URI of the Persistent Disk. - "sourceDiskNumber": 42, # The ordinal number of the source VM disk. + "diskUri": "A String", # Output only. The URI of the Persistent Disk. + "sourceDiskNumber": 42, # Output only. The ordinal number of the source VM disk. }, ], "disksTargetDetails": { # Details for a disks-only migration. # Details of the disks-only migration target. diff --git a/docs/dyn/vmmigration_v1alpha1.projects.locations.sources.migratingVms.cutoverJobs.html b/docs/dyn/vmmigration_v1alpha1.projects.locations.sources.migratingVms.cutoverJobs.html index c66e0f3fa5..b66b8b6c92 100644 --- a/docs/dyn/vmmigration_v1alpha1.projects.locations.sources.migratingVms.cutoverJobs.html +++ b/docs/dyn/vmmigration_v1alpha1.projects.locations.sources.migratingVms.cutoverJobs.html @@ -152,8 +152,8 @@

Method Details

"computeEngineDisksTargetDetails": { # ComputeEngineDisksTargetDetails is a collection of created Persistent Disks details. # Output only. Details of the target Persistent Disks in Compute Engine. "disks": [ # The details of each created Persistent Disk. { # Details of a created Persistent Disk. - "diskUri": "A String", # The URI of the Persistent Disk. - "sourceDiskNumber": 42, # The ordinal number of the source VM disk. + "diskUri": "A String", # Output only. The URI of the Persistent Disk. + "sourceDiskNumber": 42, # Output only. The ordinal number of the source VM disk. }, ], "disksTargetDetails": { # Details for a disks-only migration. # Details of the disks-only migration target. @@ -529,8 +529,8 @@

Method Details

"computeEngineDisksTargetDetails": { # ComputeEngineDisksTargetDetails is a collection of created Persistent Disks details. # Output only. Details of the target Persistent Disks in Compute Engine. "disks": [ # The details of each created Persistent Disk. { # Details of a created Persistent Disk. - "diskUri": "A String", # The URI of the Persistent Disk. - "sourceDiskNumber": 42, # The ordinal number of the source VM disk. + "diskUri": "A String", # Output only. The URI of the Persistent Disk. + "sourceDiskNumber": 42, # Output only. The ordinal number of the source VM disk. }, ], "disksTargetDetails": { # Details for a disks-only migration. # Details of the disks-only migration target. @@ -882,8 +882,8 @@

Method Details

"computeEngineDisksTargetDetails": { # ComputeEngineDisksTargetDetails is a collection of created Persistent Disks details. # Output only. Details of the target Persistent Disks in Compute Engine. "disks": [ # The details of each created Persistent Disk. { # Details of a created Persistent Disk. - "diskUri": "A String", # The URI of the Persistent Disk. - "sourceDiskNumber": 42, # The ordinal number of the source VM disk. + "diskUri": "A String", # Output only. The URI of the Persistent Disk. + "sourceDiskNumber": 42, # Output only. The ordinal number of the source VM disk. }, ], "disksTargetDetails": { # Details for a disks-only migration. # Details of the disks-only migration target. diff --git a/docs/dyn/vmmigration_v1alpha1.projects.locations.sources.migratingVms.html b/docs/dyn/vmmigration_v1alpha1.projects.locations.sources.migratingVms.html index 7785144e85..0fbe9f8f5b 100644 --- a/docs/dyn/vmmigration_v1alpha1.projects.locations.sources.migratingVms.html +++ b/docs/dyn/vmmigration_v1alpha1.projects.locations.sources.migratingVms.html @@ -294,6 +294,22 @@

Method Details

"A String", ], "diskType": "A String", # The disk type to use in the VM. + "disks": [ # Optional. The details of each disk to create. + { # Details for creation of a Persistent Disk. + "additionalLabels": { # A map of labels to associate with the Persistent Disk. + "a_key": "A String", + }, + "diskName": "A String", # Optional. The name of the Persistent Disk to create. + "diskType": "A String", # The disk type to use. + "encryption": { # Encryption message describes the details of the applied encryption. # Optional. The encryption to apply to the disk. + "kmsKey": "A String", # Required. The name of the encryption key that is stored in Google Cloud KMS. + }, + "sourceDiskNumber": 42, # Required. The ordinal number of the source VM disk. + "vmAttachmentDetails": { # Details for attachment of the disk to a VM. # Optional. Details for attachment of the disk to a VM. Used when the disk is set to be attached to a target VM. + "deviceName": "A String", # Optional. Specifies a unique device name of your choice that is reflected into the /dev/disk/by-id/google-* tree of a Linux operating system running within the instance. If not specified, the server chooses a default device name to apply to this disk, in the form persistent-disk-x, where x is a number assigned by Google Compute Engine. This field is only applicable for persistent disks. + }, + }, + ], "enableIntegrityMonitoring": True or False, # Optional. Defines whether the instance has integrity monitoring enabled. This can be set to true only if the VM boot option is EFI, and vTPM is enabled. "enableVtpm": True or False, # Optional. Defines whether the instance has vTPM enabled. This can be set to true only if the VM boot option is EFI. "encryption": { # Encryption message describes the details of the applied encryption. # Optional. Immutable. The encryption to apply to the VM disks. @@ -529,8 +545,8 @@

Method Details

"computeEngineDisksTargetDetails": { # ComputeEngineDisksTargetDetails is a collection of created Persistent Disks details. # Output only. Details of the target Persistent Disks in Compute Engine. "disks": [ # The details of each created Persistent Disk. { # Details of a created Persistent Disk. - "diskUri": "A String", # The URI of the Persistent Disk. - "sourceDiskNumber": 42, # The ordinal number of the source VM disk. + "diskUri": "A String", # Output only. The URI of the Persistent Disk. + "sourceDiskNumber": 42, # Output only. The ordinal number of the source VM disk. }, ], "disksTargetDetails": { # Details for a disks-only migration. # Details of the disks-only migration target. @@ -749,8 +765,8 @@

Method Details

"computeEngineDisksTargetDetails": { # ComputeEngineDisksTargetDetails is a collection of created Persistent Disks details. # Output only. Details of the target Persistent Disks in Compute Engine. "disks": [ # The details of each created Persistent Disk. { # Details of a created Persistent Disk. - "diskUri": "A String", # The URI of the Persistent Disk. - "sourceDiskNumber": 42, # The ordinal number of the source VM disk. + "diskUri": "A String", # Output only. The URI of the Persistent Disk. + "sourceDiskNumber": 42, # Output only. The ordinal number of the source VM disk. }, ], "disksTargetDetails": { # Details for a disks-only migration. # Details of the disks-only migration target. @@ -1476,6 +1492,22 @@

Method Details

"A String", ], "diskType": "A String", # The disk type to use in the VM. + "disks": [ # Optional. The details of each disk to create. + { # Details for creation of a Persistent Disk. + "additionalLabels": { # A map of labels to associate with the Persistent Disk. + "a_key": "A String", + }, + "diskName": "A String", # Optional. The name of the Persistent Disk to create. + "diskType": "A String", # The disk type to use. + "encryption": { # Encryption message describes the details of the applied encryption. # Optional. The encryption to apply to the disk. + "kmsKey": "A String", # Required. The name of the encryption key that is stored in Google Cloud KMS. + }, + "sourceDiskNumber": 42, # Required. The ordinal number of the source VM disk. + "vmAttachmentDetails": { # Details for attachment of the disk to a VM. # Optional. Details for attachment of the disk to a VM. Used when the disk is set to be attached to a target VM. + "deviceName": "A String", # Optional. Specifies a unique device name of your choice that is reflected into the /dev/disk/by-id/google-* tree of a Linux operating system running within the instance. If not specified, the server chooses a default device name to apply to this disk, in the form persistent-disk-x, where x is a number assigned by Google Compute Engine. This field is only applicable for persistent disks. + }, + }, + ], "enableIntegrityMonitoring": True or False, # Optional. Defines whether the instance has integrity monitoring enabled. This can be set to true only if the VM boot option is EFI, and vTPM is enabled. "enableVtpm": True or False, # Optional. Defines whether the instance has vTPM enabled. This can be set to true only if the VM boot option is EFI. "encryption": { # Encryption message describes the details of the applied encryption. # Optional. Immutable. The encryption to apply to the VM disks. @@ -1711,8 +1743,8 @@

Method Details

"computeEngineDisksTargetDetails": { # ComputeEngineDisksTargetDetails is a collection of created Persistent Disks details. # Output only. Details of the target Persistent Disks in Compute Engine. "disks": [ # The details of each created Persistent Disk. { # Details of a created Persistent Disk. - "diskUri": "A String", # The URI of the Persistent Disk. - "sourceDiskNumber": 42, # The ordinal number of the source VM disk. + "diskUri": "A String", # Output only. The URI of the Persistent Disk. + "sourceDiskNumber": 42, # Output only. The ordinal number of the source VM disk. }, ], "disksTargetDetails": { # Details for a disks-only migration. # Details of the disks-only migration target. @@ -1931,8 +1963,8 @@

Method Details

"computeEngineDisksTargetDetails": { # ComputeEngineDisksTargetDetails is a collection of created Persistent Disks details. # Output only. Details of the target Persistent Disks in Compute Engine. "disks": [ # The details of each created Persistent Disk. { # Details of a created Persistent Disk. - "diskUri": "A String", # The URI of the Persistent Disk. - "sourceDiskNumber": 42, # The ordinal number of the source VM disk. + "diskUri": "A String", # Output only. The URI of the Persistent Disk. + "sourceDiskNumber": 42, # Output only. The ordinal number of the source VM disk. }, ], "disksTargetDetails": { # Details for a disks-only migration. # Details of the disks-only migration target. @@ -2517,6 +2549,22 @@

Method Details

"A String", ], "diskType": "A String", # The disk type to use in the VM. + "disks": [ # Optional. The details of each disk to create. + { # Details for creation of a Persistent Disk. + "additionalLabels": { # A map of labels to associate with the Persistent Disk. + "a_key": "A String", + }, + "diskName": "A String", # Optional. The name of the Persistent Disk to create. + "diskType": "A String", # The disk type to use. + "encryption": { # Encryption message describes the details of the applied encryption. # Optional. The encryption to apply to the disk. + "kmsKey": "A String", # Required. The name of the encryption key that is stored in Google Cloud KMS. + }, + "sourceDiskNumber": 42, # Required. The ordinal number of the source VM disk. + "vmAttachmentDetails": { # Details for attachment of the disk to a VM. # Optional. Details for attachment of the disk to a VM. Used when the disk is set to be attached to a target VM. + "deviceName": "A String", # Optional. Specifies a unique device name of your choice that is reflected into the /dev/disk/by-id/google-* tree of a Linux operating system running within the instance. If not specified, the server chooses a default device name to apply to this disk, in the form persistent-disk-x, where x is a number assigned by Google Compute Engine. This field is only applicable for persistent disks. + }, + }, + ], "enableIntegrityMonitoring": True or False, # Optional. Defines whether the instance has integrity monitoring enabled. This can be set to true only if the VM boot option is EFI, and vTPM is enabled. "enableVtpm": True or False, # Optional. Defines whether the instance has vTPM enabled. This can be set to true only if the VM boot option is EFI. "encryption": { # Encryption message describes the details of the applied encryption. # Optional. Immutable. The encryption to apply to the VM disks. @@ -2752,8 +2800,8 @@

Method Details

"computeEngineDisksTargetDetails": { # ComputeEngineDisksTargetDetails is a collection of created Persistent Disks details. # Output only. Details of the target Persistent Disks in Compute Engine. "disks": [ # The details of each created Persistent Disk. { # Details of a created Persistent Disk. - "diskUri": "A String", # The URI of the Persistent Disk. - "sourceDiskNumber": 42, # The ordinal number of the source VM disk. + "diskUri": "A String", # Output only. The URI of the Persistent Disk. + "sourceDiskNumber": 42, # Output only. The ordinal number of the source VM disk. }, ], "disksTargetDetails": { # Details for a disks-only migration. # Details of the disks-only migration target. @@ -2972,8 +3020,8 @@

Method Details

"computeEngineDisksTargetDetails": { # ComputeEngineDisksTargetDetails is a collection of created Persistent Disks details. # Output only. Details of the target Persistent Disks in Compute Engine. "disks": [ # The details of each created Persistent Disk. { # Details of a created Persistent Disk. - "diskUri": "A String", # The URI of the Persistent Disk. - "sourceDiskNumber": 42, # The ordinal number of the source VM disk. + "diskUri": "A String", # Output only. The URI of the Persistent Disk. + "sourceDiskNumber": 42, # Output only. The ordinal number of the source VM disk. }, ], "disksTargetDetails": { # Details for a disks-only migration. # Details of the disks-only migration target. @@ -3562,6 +3610,22 @@

Method Details

"A String", ], "diskType": "A String", # The disk type to use in the VM. + "disks": [ # Optional. The details of each disk to create. + { # Details for creation of a Persistent Disk. + "additionalLabels": { # A map of labels to associate with the Persistent Disk. + "a_key": "A String", + }, + "diskName": "A String", # Optional. The name of the Persistent Disk to create. + "diskType": "A String", # The disk type to use. + "encryption": { # Encryption message describes the details of the applied encryption. # Optional. The encryption to apply to the disk. + "kmsKey": "A String", # Required. The name of the encryption key that is stored in Google Cloud KMS. + }, + "sourceDiskNumber": 42, # Required. The ordinal number of the source VM disk. + "vmAttachmentDetails": { # Details for attachment of the disk to a VM. # Optional. Details for attachment of the disk to a VM. Used when the disk is set to be attached to a target VM. + "deviceName": "A String", # Optional. Specifies a unique device name of your choice that is reflected into the /dev/disk/by-id/google-* tree of a Linux operating system running within the instance. If not specified, the server chooses a default device name to apply to this disk, in the form persistent-disk-x, where x is a number assigned by Google Compute Engine. This field is only applicable for persistent disks. + }, + }, + ], "enableIntegrityMonitoring": True or False, # Optional. Defines whether the instance has integrity monitoring enabled. This can be set to true only if the VM boot option is EFI, and vTPM is enabled. "enableVtpm": True or False, # Optional. Defines whether the instance has vTPM enabled. This can be set to true only if the VM boot option is EFI. "encryption": { # Encryption message describes the details of the applied encryption. # Optional. Immutable. The encryption to apply to the VM disks. @@ -3797,8 +3861,8 @@

Method Details

"computeEngineDisksTargetDetails": { # ComputeEngineDisksTargetDetails is a collection of created Persistent Disks details. # Output only. Details of the target Persistent Disks in Compute Engine. "disks": [ # The details of each created Persistent Disk. { # Details of a created Persistent Disk. - "diskUri": "A String", # The URI of the Persistent Disk. - "sourceDiskNumber": 42, # The ordinal number of the source VM disk. + "diskUri": "A String", # Output only. The URI of the Persistent Disk. + "sourceDiskNumber": 42, # Output only. The ordinal number of the source VM disk. }, ], "disksTargetDetails": { # Details for a disks-only migration. # Details of the disks-only migration target. @@ -4017,8 +4081,8 @@

Method Details

"computeEngineDisksTargetDetails": { # ComputeEngineDisksTargetDetails is a collection of created Persistent Disks details. # Output only. Details of the target Persistent Disks in Compute Engine. "disks": [ # The details of each created Persistent Disk. { # Details of a created Persistent Disk. - "diskUri": "A String", # The URI of the Persistent Disk. - "sourceDiskNumber": 42, # The ordinal number of the source VM disk. + "diskUri": "A String", # Output only. The URI of the Persistent Disk. + "sourceDiskNumber": 42, # Output only. The ordinal number of the source VM disk. }, ], "disksTargetDetails": { # Details for a disks-only migration. # Details of the disks-only migration target. diff --git a/docs/dyn/vmwareengine_v1.projects.locations.html b/docs/dyn/vmwareengine_v1.projects.locations.html index 70d4b6bfff..3670367113 100644 --- a/docs/dyn/vmwareengine_v1.projects.locations.html +++ b/docs/dyn/vmwareengine_v1.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. Do not use this field 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/vmwareengine_v1.projects.locations.privateClouds.html b/docs/dyn/vmwareengine_v1.projects.locations.privateClouds.html index 340abe0da1..75d9b04c7b 100644 --- a/docs/dyn/vmwareengine_v1.projects.locations.privateClouds.html +++ b/docs/dyn/vmwareengine_v1.projects.locations.privateClouds.html @@ -133,6 +133,9 @@

Instance Methods

list_next()

Retrieves the next page of results.

+

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

+

Migrates the management VMs of the PC from the current management cluster to a workload cluster. Post this migration, the provided workload cluster becomes the management cluster

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

Modifies a `PrivateCloud` resource. Only the following fields can be updated: `description`. Only fields specified in `updateMask` are applied. During operation processing, the resource is temporarily in the `ACTIVE` state before the operation fully completes. For that period of time, you can't update the resource. Use the operation status to determine when the processing fully completes.

@@ -531,6 +534,50 @@

Method Details

+
+ migrateManagementVms(name, body=None, x__xgafv=None) +
Migrates the management VMs of the PC from the current management cluster to a workload cluster. Post this migration, the provided workload cluster becomes the management cluster
+
+Args:
+  name: string, Required. The resource name of the private cloud whose management vms are getting migrated. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-project/locations/us-central1-a/privateClouds/my-cloud` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for VmwareEngine.MigrateManagementVms
+  "clusterId": "A String", # Required. The user-provided identifier of the workload cluster to which the management VMs are to be migrated. The cluster must be in the same private cloud as the one specified in `name`, and must be a workload cluster. The eventual cluster name will be constructed from the private cloud name and this cluster ID.
+  "etag": "A String", # Optional. Checksum used to ensure that the user-provided value is up to date before the server processes the request. The server compares provided checksum with the current checksum of the resource. If the user-provided value is out of date, this request returns an `ABORTED` error.
+  "requestId": "A String", # Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server guarantees that a request doesn't result in creation of duplicate commitments for at least 60 minutes. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if the original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # 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.
+  },
+}
+
+
patch(name, body=None, requestId=None, updateMask=None, validateOnly=None, x__xgafv=None)
Modifies a `PrivateCloud` resource. Only the following fields can be updated: `description`. Only fields specified in `updateMask` are applied. During operation processing, the resource is temporarily in the `ACTIVE` state before the operation fully completes. For that period of time, you can't update the resource. Use the operation status to determine when the processing fully completes.
diff --git a/docs/dyn/webcontentpublisher_v1.html b/docs/dyn/webcontentpublisher_v1.html
new file mode 100644
index 0000000000..3b79666444
--- /dev/null
+++ b/docs/dyn/webcontentpublisher_v1.html
@@ -0,0 +1,111 @@
+
+
+
+

Web Content Publisher API

+

Instance Methods

+

+ publications() +

+

Returns the publications 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/webcontentpublisher_v1.publications.html b/docs/dyn/webcontentpublisher_v1.publications.html new file mode 100644 index 0000000000..0502e52b06 --- /dev/null +++ b/docs/dyn/webcontentpublisher_v1.publications.html @@ -0,0 +1,110 @@ + + + +

Web Content Publisher API . publications

+

Instance Methods

+

+ checkFreeAccess(name, httpReferrer=None, uri=None, x__xgafv=None)

+

Checks if a user is eligible for free article access.

+

+ close()

+

Close httplib2 connections.

+

Method Details

+
+ checkFreeAccess(name, httpReferrer=None, uri=None, x__xgafv=None) +
Checks if a user is eligible for free article access.
+
+Args:
+  name: string, Required. The resource name of the publication. Format: publications/{publication_id} (required)
+  httpReferrer: string, Required. The HTTP referrer.
+  uri: string, Required. The URI of the content.
+  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 CheckFreeAccess
+  "isAllowed": True or False, # True if free access should be allowed, false otherwise.
+}
+
+ +
+ close() +
Close httplib2 connections.
+
+ + \ No newline at end of file diff --git a/docs/dyn/webrisk_v1.projects.submissions.html b/docs/dyn/webrisk_v1.projects.submissions.html index c769da68e7..406ad498c4 100644 --- a/docs/dyn/webrisk_v1.projects.submissions.html +++ b/docs/dyn/webrisk_v1.projects.submissions.html @@ -79,7 +79,7 @@

Instance Methods

Close httplib2 connections.

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

-

Creates a Submission of a URI suspected of containing phishing content to be reviewed. If the result verifies the existence of malicious phishing content, the site will be added to the [Google's Social Engineering lists](https://support.google.com/webmasters/answer/6350487/) in order to protect users that could get exposed to this threat in the future. Only allowlisted projects can use this method during Early Access. Please reach out to Sales or your customer engineer to obtain access.

+

Creates a Submission of a URI suspected of containing phishing content for review. If the review confirms malicious phishing content, Google adds the site to [Google's Social Engineering lists](https://support.google.com/webmasters/answer/6350487/) to help protect users. Only allowlisted projects can use this method during Early Access. To obtain access, contact Sales or your customer engineer.

Method Details

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

Method Details

create(parent, body=None, x__xgafv=None) -
Creates a Submission of a URI suspected of containing phishing content to be reviewed. If the result verifies the existence of malicious phishing content, the site will be added to the [Google's Social Engineering lists](https://support.google.com/webmasters/answer/6350487/) in order to protect users that could get exposed to this threat in the future. Only allowlisted projects can use this method during Early Access. Please reach out to Sales or your customer engineer to obtain access.
+  
Creates a Submission of a URI suspected of containing phishing content for review. If the review confirms malicious phishing content, Google adds the site to [Google's Social Engineering lists](https://support.google.com/webmasters/answer/6350487/) to help protect users. Only allowlisted projects can use this method during Early Access. To obtain access, contact Sales or your customer engineer.
 
 Args:
   parent: string, Required. The name of the project that is making the submission. This string is in the format "projects/{project_number}". (required)
diff --git a/docs/dyn/youtube_v3.search.html b/docs/dyn/youtube_v3.search.html
index f573269e61..2ffa0995d3 100644
--- a/docs/dyn/youtube_v3.search.html
+++ b/docs/dyn/youtube_v3.search.html
@@ -95,7 +95,7 @@ 

Method Details

Args: part: string, The *part* parameter specifies a comma-separated list of one or more search resource properties that the API response will include. Set the parameter value to snippet. (required) (repeated) - channelId: string, Filter on resources belonging to this channelId. + channelId: string, Filter on resources belonging to this channelId. (Force TAP rebuild) channelType: string, Add a filter on the channel search. Allowed values channelTypeUnspecified - @@ -255,7 +255,7 @@

Method Details

"regionCode": "A String", "tokenPagination": { # Stub token pagination template to suppress results. }, - "visitorId": "A String", # The visitorId identifies the visitor. + "visitorId": "A String", # The visitor ID identifies the visitor. }
diff --git a/googleapiclient/discovery_cache/documents/admin.directory_v1.json b/googleapiclient/discovery_cache/documents/admin.directory_v1.json index e539d8db66..edae7b2a64 100644 --- a/googleapiclient/discovery_cache/documents/admin.directory_v1.json +++ b/googleapiclient/discovery_cache/documents/admin.directory_v1.json @@ -3890,7 +3890,7 @@ "users": { "methods": { "createGuest": { -"description": "Create a guest user with access to a [subset of Workspace capabilities](https://support.google.com/a/answer/16558545). This feature is currently in Alpha. Please reach out to support if you are interested in trying this feature.", +"description": "Create a guest user with access to a [subset of Workspace capabilities](https://support.google.com/a/answer/16558545). This feature is currently in Open Beta.", "flatPath": "admin/directory/v1/users:createGuest", "httpMethod": "POST", "id": "directory.users.createGuest", @@ -4729,7 +4729,7 @@ } } }, -"revision": "20260421", +"revision": "20260522", "rootUrl": "https://admin.googleapis.com/", "schemas": { "Alias": { @@ -6429,11 +6429,11 @@ false "id": "DirectoryUsersCreateGuestRequest", "properties": { "customer": { -"description": "Optional. Immutable ID of the Google Workspace account.", +"description": "Optional. Immutable ID of the Google Workspace account. Only required when request is created by a service account. Defaults to the authenticated user's customer ID otherwise.", "type": "string" }, "primaryGuestEmail": { -"description": "Immutable. External email of the guest user being created.", +"description": "Required. External email of the guest user being created.", "type": "string" } }, diff --git a/googleapiclient/discovery_cache/documents/aiplatform.v1.json b/googleapiclient/discovery_cache/documents/aiplatform.v1.json index c40590a8b8..dd55d14c77 100644 --- a/googleapiclient/discovery_cache/documents/aiplatform.v1.json +++ b/googleapiclient/discovery_cache/documents/aiplatform.v1.json @@ -22751,7 +22751,7 @@ "type": "string" }, "updateMask": { -"description": "Optional. Mask specifying which fields to update. Supported fields: * `display_name` * `description` * `fact`", +"description": "Optional. Mask specifying which fields to update. The following fields are immutable: * `scope` * `memory_type`", "format": "google-fieldmask", "location": "query", "type": "string" @@ -32357,7 +32357,7 @@ } } }, -"revision": "20260509", +"revision": "20260523", "rootUrl": "https://aiplatform.googleapis.com/", "schemas": { "CloudAiLargeModelsVisionGenerateVideoExperiments": { @@ -32398,6 +32398,10 @@ "format": "int32", "type": "integer" }, +"originalRequestJson": { +"description": "The original REST API request JSON sent by the user, in the instances/parameters format. Preserved for saving alongside output artifacts so users can reproduce their requests. This field is populated by the API handler and is not user-settable.", +"type": "string" +}, "promptInputs": { "$ref": "CloudAiLargeModelsVisionPromptInputs", "description": "Prompt chunks for \"ProModel\" prompting. If set, the prompt will not be rewritten, and top-level prompt ignored." @@ -36063,6 +36067,18 @@ }, "type": "object" }, +"GoogleCloudAiplatformV1CreateServingProfileOperationMetadata": { +"description": "Runtime operation metadata for ServingProfileService.CreateServingProfile.", +"id": "GoogleCloudAiplatformV1CreateServingProfileOperationMetadata", +"properties": { +"genericMetadata": { +"$ref": "GoogleCloudAiplatformV1GenericOperationMetadata", +"description": "Output only. The standard operation metadata for Vertex AI.", +"readOnly": true +} +}, +"type": "object" +}, "GoogleCloudAiplatformV1CreateSpecialistPoolOperationMetadata": { "description": "Runtime operation information for SpecialistPoolService.CreateSpecialistPool.", "id": "GoogleCloudAiplatformV1CreateSpecialistPoolOperationMetadata", @@ -50959,7 +50975,7 @@ false "type": "object" }, "GoogleCloudAiplatformV1PersistentDiskSpec": { -"description": "Represents the spec of persistent disk options.", +"description": "Represents the spec of persistent disk and hyperdisk options.", "id": "GoogleCloudAiplatformV1PersistentDiskSpec", "properties": { "diskSizeGb": { @@ -50968,7 +50984,7 @@ false "type": "string" }, "diskType": { -"description": "Type of the disk (default is \"pd-standard\"). Valid values: \"pd-ssd\" (Persistent Disk Solid State Drive) \"pd-standard\" (Persistent Disk Hard Disk Drive) \"pd-balanced\" (Balanced Persistent Disk) \"pd-extreme\" (Extreme Persistent Disk)", +"description": "Type of the disk (default is \"pd-standard\"). Valid values: \"pd-ssd\" (Persistent Disk Solid State Drive) \"pd-standard\" (Persistent Disk Hard Disk Drive) \"pd-balanced\" (Balanced Persistent Disk) \"pd-extreme\" (Extreme Persistent Disk) \"hyperdisk-balanced\" (Hyperdisk Balanced) \"hyperdisk-extreme\" (Hyperdisk Extreme) \"hyperdisk-balanced-high-availability\" (Hyperdisk Balanced High Availability) \"hyperdisk-ml\" (Hyperdisk ML) \"hyperdisk-throughput\" (Hyperdisk Throughput)", "type": "string" } }, @@ -55998,6 +56014,10 @@ false "The default container image for Computer Use." ], "type": "string" +}, +"resources": { +"$ref": "GoogleCloudAiplatformV1SandboxEnvironmentTemplateResourceRequirements", +"description": "Optional. Resource requests and limits for the default container." } }, "type": "object" @@ -63186,6 +63206,10 @@ false "$ref": "GoogleCloudAiplatformV1EnterpriseWebSearch", "description": "Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance." }, +"exaAiSearch": { +"$ref": "GoogleCloudAiplatformV1ToolExaAiSearch", +"description": "Optional. Uses Exa.ai to search for information to answer user queries. The search results will be grounded on Exa.ai and presented to the model for response generation" +}, "functionDeclarations": { "description": "Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided.", "items": { @@ -63350,6 +63374,25 @@ false }, "type": "object" }, +"GoogleCloudAiplatformV1ToolExaAiSearch": { +"description": "ExaAiSearch tool type. A tool that uses the Exa.ai search engine for grounding.", +"id": "GoogleCloudAiplatformV1ToolExaAiSearch", +"properties": { +"apiKey": { +"description": "Required. The API key for ExaAiSearch.", +"type": "string" +}, +"customConfigs": { +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" +}, +"description": "Optional. This field can be used to pass any parameter from the Exa.ai Search API.", +"type": "object" +} +}, +"type": "object" +}, "GoogleCloudAiplatformV1ToolGoogleSearch": { "description": "GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google.", "id": "GoogleCloudAiplatformV1ToolGoogleSearch", diff --git a/googleapiclient/discovery_cache/documents/aiplatform.v1beta1.json b/googleapiclient/discovery_cache/documents/aiplatform.v1beta1.json index 25c7cbd2d2..c9d88dff56 100644 --- a/googleapiclient/discovery_cache/documents/aiplatform.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/aiplatform.v1beta1.json @@ -8951,6 +8951,31 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, +"getSemanticGovernancePolicyEngine": { +"description": "Gets a SemanticGovernancePolicyEngine. A SemanticGovernancePolicyEngine is a singleton resource that is created when its parent is created, and deleted when its parent is deleted. This method retrieves the current state of the Semantic Governance Policy Engine.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/semanticGovernancePolicyEngine", +"httpMethod": "GET", +"id": "aiplatform.projects.locations.getSemanticGovernancePolicyEngine", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The resource name of the SemanticGovernancePolicyEngine to retrieve. Format: projects/{project}/locations/{location}/semanticGovernancePolicyEngine", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/semanticGovernancePolicyEngine$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+name}", +"response": { +"$ref": "GoogleCloudAiplatformV1beta1SemanticGovernancePolicyEngine" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, "list": { "description": "Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the ListLocationsRequest.name field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.", "flatPath": "v1beta1/projects/{projectsId}/locations", @@ -9081,13 +9106,47 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] +}, +"updateSemanticGovernancePolicyEngine": { +"description": "Updates a SemanticGovernancePolicyEngine. This method performs an upsert operation. If the SemanticGovernancePolicyEngine resource does not exist, it will be created. Otherwise, it will be updated.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/semanticGovernancePolicyEngine", +"httpMethod": "PATCH", +"id": "aiplatform.projects.locations.updateSemanticGovernancePolicyEngine", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Identifier. The resource name of the SemanticGovernancePolicyEngine. Format: projects/{project}/locations/{location}/semanticGovernancePolicyEngine", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/semanticGovernancePolicyEngine$", +"required": true, +"type": "string" +}, +"updateMask": { +"description": "Optional. Specifies the fields to be overwritten in the SemanticGovernancePolicyEngine resource by the update. The fields specified in the update_mask are relative to the resource itself. If no update_mask is provided, all fields are overwritten.", +"format": "google-fieldmask", +"location": "query", +"type": "string" +} +}, +"path": "v1beta1/{+name}", +"request": { +"$ref": "GoogleCloudAiplatformV1beta1SemanticGovernancePolicyEngine" +}, +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] } }, "resources": { "agents": { "methods": { "create": { -"description": "Creates a new Agent in a given location.", +"description": "Creates an agent.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/agents", "httpMethod": "POST", "id": "aiplatform.projects.locations.agents.create", @@ -9115,7 +9174,7 @@ ] }, "delete": { -"description": "Deletes the specific Agent.", +"description": "Deletes an agent.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}", "httpMethod": "DELETE", "id": "aiplatform.projects.locations.agents.delete", @@ -9124,7 +9183,7 @@ ], "parameters": { "name": { -"description": "Required. The resource name of the agent. Format: `projects/{project}/locations/{location}/agents/{agent}`", +"description": "Required. The resource name of the agent to delete. Format: `projects/{project}/locations/{location}/agents/{agent}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+$", "required": true, @@ -9140,7 +9199,7 @@ ] }, "get": { -"description": "Gets details of the specific Agent.", +"description": "Retrieves an agent.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}", "httpMethod": "GET", "id": "aiplatform.projects.locations.agents.get", @@ -9149,7 +9208,7 @@ ], "parameters": { "name": { -"description": "Required. The resource name of the agent. Format: `projects/{project}/locations/{location}/agents/{agent}`.", +"description": "Required. The resource name of the agent to retrieve. Format: `projects/{project}/locations/{location}/agents/{agent}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+$", "required": true, @@ -9165,7 +9224,7 @@ ] }, "list": { -"description": "Lists Agents in a given location.", +"description": "Lists agents in a location.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/agents", "httpMethod": "GET", "id": "aiplatform.projects.locations.agents.list", @@ -9174,23 +9233,23 @@ ], "parameters": { "orderBy": { -"description": "Optional. A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Supported fields: * `create_time` * `update_time` Example: `create_time desc`.", +"description": "Optional. A comma-separated list of fields to order by. Supported fields: * `create_time` * `update_time` Use `desc` after a field name for descending order. Example: `create_time desc`.", "location": "query", "type": "string" }, "pageSize": { -"description": "Optional. The maximum number of agents to return. The service may return fewer than this value. If unspecified, at most 100 agents will be returned.", +"description": "Optional. The maximum number of agents to return. The service may return fewer than this value. The maximum page size is 100; values above 100 will be coerced to 100. If unspecified, the default page size is 10.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { -"description": "Optional. The next_page_token value returned from a previous list AgentService.ListAgents call.", +"description": "Optional. A page token, received from a previous AgentService.ListAgents call. Provide this to retrieve the subsequent page.", "location": "query", "type": "string" }, "parent": { -"description": "Required. The resource name of the location to list agents from. Format: `projects/{project}/locations/{location}", +"description": "Required. The resource name of the location to list agents from. Format: `projects/{project}/locations/{location}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, @@ -9206,7 +9265,7 @@ ] }, "patch": { -"description": "Updates the specific Agent.", +"description": "Updates an agent.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}", "httpMethod": "PATCH", "id": "aiplatform.projects.locations.agents.patch", @@ -9215,14 +9274,14 @@ ], "parameters": { "name": { -"description": "Identifier. The resource name of the Agent. Format: `projects/{project}/locations/{location}/agents/{agent}`.", +"description": "Identifier. The resource name of the agent. Format: `projects/{project}/locations/{location}/agents/{agent}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+$", "required": true, "type": "string" }, "updateMask": { -"description": "Optional. Field mask is used to control which fields get updated. If the mask is not present, all fields will be updated.", +"description": "Optional. The list of fields to update. If not present, all fields are updated.", "format": "google-fieldmask", "location": "query", "type": "string" @@ -31168,7 +31227,7 @@ "type": "string" }, "updateMask": { -"description": "Optional. Mask specifying which fields to update. Supported fields: * `display_name` * `description` * `fact`", +"description": "Optional. Mask specifying which fields to update. The following fields are immutable: * `scope` * `memory_type`", "format": "google-fieldmask", "location": "query", "type": "string" @@ -34511,154 +34570,158 @@ } }, "semanticGovernancePolicies": { -"resources": { -"operations": { "methods": { -"cancel": { -"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/semanticGovernancePolicies/{semanticGovernancePoliciesId}/operations/{operationsId}:cancel", +"create": { +"description": "Creates a SemanticGovernancePolicy.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/semanticGovernancePolicies", "httpMethod": "POST", -"id": "aiplatform.projects.locations.semanticGovernancePolicies.operations.cancel", +"id": "aiplatform.projects.locations.semanticGovernancePolicies.create", "parameterOrder": [ -"name" +"parent" ], "parameters": { -"name": { -"description": "The name of the operation resource to be cancelled.", +"parent": { +"description": "Required. The resource name of the Location into which to create the SemanticGovernancePolicy. Format: `projects/{project}/locations/{location}`", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/semanticGovernancePolicies/[^/]+/operations/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string" +}, +"semanticGovernancePolicyId": { +"description": "Required. The ID to use for the SemanticGovernancePolicy, which will become the final component of the SemanticGovernancePolicy's resource name. This value may be up to 63 characters, and valid characters are `[a-z0-9-]`. The first character cannot be a number or hyphen. The last character must be a letter or a number.", +"location": "query", +"type": "string" } }, -"path": "v1beta1/{+name}:cancel", +"path": "v1beta1/{+parent}/semanticGovernancePolicies", +"request": { +"$ref": "GoogleCloudAiplatformV1beta1SemanticGovernancePolicy" +}, "response": { -"$ref": "GoogleProtobufEmpty" +"$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "delete": { -"description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/semanticGovernancePolicies/{semanticGovernancePoliciesId}/operations/{operationsId}", +"description": "Deletes a SemanticGovernancePolicy.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/semanticGovernancePolicies/{semanticGovernancePoliciesId}", "httpMethod": "DELETE", -"id": "aiplatform.projects.locations.semanticGovernancePolicies.operations.delete", +"id": "aiplatform.projects.locations.semanticGovernancePolicies.delete", "parameterOrder": [ "name" ], "parameters": { +"etag": { +"description": "Optional. The etag of the SemanticGovernancePolicy. If an etag is provided and does not match the current etag of the SemanticGovernancePolicy, deletion will be blocked and an ABORTED error will be returned.", +"location": "query", +"type": "string" +}, "name": { -"description": "The name of the operation resource to be deleted.", +"description": "Required. The name of the SemanticGovernancePolicy resource to be deleted. Format: `projects/{project}/locations/{location}/semanticGovernancePolicies/{semantic_governance_policy}`", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/semanticGovernancePolicies/[^/]+/operations/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/semanticGovernancePolicies/[^/]+$", "required": true, "type": "string" } }, "path": "v1beta1/{+name}", "response": { -"$ref": "GoogleProtobufEmpty" +"$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "get": { -"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/semanticGovernancePolicies/{semanticGovernancePoliciesId}/operations/{operationsId}", +"description": "Gets a SemanticGovernancePolicy.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/semanticGovernancePolicies/{semanticGovernancePoliciesId}", "httpMethod": "GET", -"id": "aiplatform.projects.locations.semanticGovernancePolicies.operations.get", +"id": "aiplatform.projects.locations.semanticGovernancePolicies.get", "parameterOrder": [ "name" ], "parameters": { "name": { -"description": "The name of the operation resource.", +"description": "Required. The name of the SemanticGovernancePolicy resource. Format: `projects/{project}/locations/{location}/semanticGovernancePolicies/{semantic_governance_policy}`", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/semanticGovernancePolicies/[^/]+/operations/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/semanticGovernancePolicies/[^/]+$", "required": true, "type": "string" } }, "path": "v1beta1/{+name}", "response": { -"$ref": "GoogleLongrunningOperation" +"$ref": "GoogleCloudAiplatformV1beta1SemanticGovernancePolicy" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "list": { -"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/semanticGovernancePolicies/{semanticGovernancePoliciesId}/operations", +"description": "Lists SemanticGovernancePolicies in a given location.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/semanticGovernancePolicies", "httpMethod": "GET", -"id": "aiplatform.projects.locations.semanticGovernancePolicies.operations.list", +"id": "aiplatform.projects.locations.semanticGovernancePolicies.list", "parameterOrder": [ -"name" +"parent" ], "parameters": { -"filter": { -"description": "The standard list filter.", -"location": "query", -"type": "string" -}, -"name": { -"description": "The name of the operation's parent resource.", -"location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/semanticGovernancePolicies/[^/]+$", -"required": true, -"type": "string" -}, "pageSize": { -"description": "The standard list page size.", +"description": "Optional. The list page size. If zero, a default page size of 10 is used.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { -"description": "The standard list page token.", +"description": "Optional. The standard list page token.", "location": "query", "type": "string" }, -"returnPartialSuccess": { -"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", -"location": "query", -"type": "boolean" +"parent": { +"description": "Required. The resource name of the Location from which to list the SemanticGovernancePolicies. Format: `projects/{project}/locations/{location}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" } }, -"path": "v1beta1/{+name}/operations", +"path": "v1beta1/{+parent}/semanticGovernancePolicies", "response": { -"$ref": "GoogleLongrunningListOperationsResponse" +"$ref": "GoogleCloudAiplatformV1beta1ListSemanticGovernancePoliciesResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, -"wait": { -"description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/semanticGovernancePolicies/{semanticGovernancePoliciesId}/operations/{operationsId}:wait", -"httpMethod": "POST", -"id": "aiplatform.projects.locations.semanticGovernancePolicies.operations.wait", +"patch": { +"description": "Updates a SemanticGovernancePolicy.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/semanticGovernancePolicies/{semanticGovernancePoliciesId}", +"httpMethod": "PATCH", +"id": "aiplatform.projects.locations.semanticGovernancePolicies.patch", "parameterOrder": [ "name" ], "parameters": { "name": { -"description": "The name of the operation resource to wait on.", +"description": "Identifier. Resource name of the SemanticGovernancePolicy.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/semanticGovernancePolicies/[^/]+/operations/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/semanticGovernancePolicies/[^/]+$", "required": true, "type": "string" }, -"timeout": { -"description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", -"format": "google-duration", +"updateMask": { +"description": "Optional. `update_mask` is used to specify the fields to be overwritten in the SemanticGovernancePolicy resource by the update. The fields specified in the `update_mask` are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the mask is not present, then all fields that are populated in the request message will be overwritten. Set the `update_mask` to `*` to override all fields.", +"format": "google-fieldmask", "location": "query", "type": "string" } }, -"path": "v1beta1/{+name}:wait", +"path": "v1beta1/{+name}", +"request": { +"$ref": "GoogleCloudAiplatformV1beta1SemanticGovernancePolicy" +}, "response": { "$ref": "GoogleLongrunningOperation" }, @@ -34666,19 +34729,15 @@ "https://www.googleapis.com/auth/cloud-platform" ] } -} -} -} }, -"semanticGovernancePolicyEngine": { "resources": { "operations": { "methods": { "cancel": { "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/semanticGovernancePolicyEngine/operations/{operationsId}:cancel", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/semanticGovernancePolicies/{semanticGovernancePoliciesId}/operations/{operationsId}:cancel", "httpMethod": "POST", -"id": "aiplatform.projects.locations.semanticGovernancePolicyEngine.operations.cancel", +"id": "aiplatform.projects.locations.semanticGovernancePolicies.operations.cancel", "parameterOrder": [ "name" ], @@ -34686,7 +34745,7 @@ "name": { "description": "The name of the operation resource to be cancelled.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/semanticGovernancePolicyEngine/operations/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/semanticGovernancePolicies/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -34701,9 +34760,9 @@ }, "delete": { "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/semanticGovernancePolicyEngine/operations/{operationsId}", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/semanticGovernancePolicies/{semanticGovernancePoliciesId}/operations/{operationsId}", "httpMethod": "DELETE", -"id": "aiplatform.projects.locations.semanticGovernancePolicyEngine.operations.delete", +"id": "aiplatform.projects.locations.semanticGovernancePolicies.operations.delete", "parameterOrder": [ "name" ], @@ -34711,7 +34770,7 @@ "name": { "description": "The name of the operation resource to be deleted.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/semanticGovernancePolicyEngine/operations/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/semanticGovernancePolicies/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -34726,9 +34785,9 @@ }, "get": { "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/semanticGovernancePolicyEngine/operations/{operationsId}", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/semanticGovernancePolicies/{semanticGovernancePoliciesId}/operations/{operationsId}", "httpMethod": "GET", -"id": "aiplatform.projects.locations.semanticGovernancePolicyEngine.operations.get", +"id": "aiplatform.projects.locations.semanticGovernancePolicies.operations.get", "parameterOrder": [ "name" ], @@ -34736,7 +34795,7 @@ "name": { "description": "The name of the operation resource.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/semanticGovernancePolicyEngine/operations/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/semanticGovernancePolicies/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -34751,9 +34810,9 @@ }, "list": { "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/semanticGovernancePolicyEngine/operations", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/semanticGovernancePolicies/{semanticGovernancePoliciesId}/operations", "httpMethod": "GET", -"id": "aiplatform.projects.locations.semanticGovernancePolicyEngine.operations.list", +"id": "aiplatform.projects.locations.semanticGovernancePolicies.operations.list", "parameterOrder": [ "name" ], @@ -34766,7 +34825,7 @@ "name": { "description": "The name of the operation's parent resource.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/semanticGovernancePolicyEngine$", +"pattern": "^projects/[^/]+/locations/[^/]+/semanticGovernancePolicies/[^/]+$", "required": true, "type": "string" }, @@ -34797,9 +34856,9 @@ }, "wait": { "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/semanticGovernancePolicyEngine/operations/{operationsId}:wait", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/semanticGovernancePolicies/{semanticGovernancePoliciesId}/operations/{operationsId}:wait", "httpMethod": "POST", -"id": "aiplatform.projects.locations.semanticGovernancePolicyEngine.operations.wait", +"id": "aiplatform.projects.locations.semanticGovernancePolicies.operations.wait", "parameterOrder": [ "name" ], @@ -34807,7 +34866,7 @@ "name": { "description": "The name of the operation resource to wait on.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/semanticGovernancePolicyEngine/operations/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/semanticGovernancePolicies/[^/]+/operations/[^/]+$", "required": true, "type": "string" }, @@ -34830,6 +34889,38 @@ } } }, +"semanticGovernancePolicyEngine": { +"methods": { +"deprovision": { +"description": "Deprovisions the SemanticGovernancePolicyEngine, tearing down the associated tenant project, GKE cluster, and PSC service attachments. This operation is irreversible. Returns a long-running operation; poll for completion. The response contains the SemanticGovernancePolicyEngine in DEPROVISIONING state.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/semanticGovernancePolicyEngine:deprovision", +"httpMethod": "POST", +"id": "aiplatform.projects.locations.semanticGovernancePolicyEngine.deprovision", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The resource name of the SemanticGovernancePolicyEngine to deprovision. Format: projects/{project}/locations/{location}/semanticGovernancePolicyEngine", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/semanticGovernancePolicyEngine$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+name}:deprovision", +"request": { +"$ref": "GoogleCloudAiplatformV1beta1DeprovisionSemanticGovernancePolicyEngineRequest" +}, +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +}, "servingProfiles": { "resources": { "operations": { @@ -35009,7 +35100,7 @@ "type": "string" }, "skillId": { -"description": "Optional. The ID to use for the Skill, which will become the final component of the Skill's resource name. If not provided, a system-generated ID will be used. This value must be 1-63 characters. Valid characters are lowercase letters, numbers, and hyphens. The first character must be a lowercase letter, and the last character must be a lowercase letter or a number. Specifically, the ID must match the regular expression: `^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$` See [AIP-122](https://aip.dev/122#resource-id-segments) for more details.", +"description": "Required. The ID to use for the Skill, which will become the final component of the Skill's resource name. If not provided, a system-generated ID will be used. This value must be 1-63 characters. Valid characters are lowercase letters, numbers, and hyphens. The first character must be a lowercase letter, and the last character must be a lowercase letter or a number. Specifically, the ID must match the regular expression: `^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$` See [AIP-122](https://aip.dev/122#resource-id-segments) for more details.", "location": "query", "type": "string" } @@ -38668,6 +38759,34 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, +"processData": { +"description": "Processes data from a user's Cloud Storage bucket and saves the result to a destination Cloud Storage bucket. This method returns a long-running operation, and the `ProcessDataResponse` will be returned upon completion.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tuningJobs:processData", +"httpMethod": "POST", +"id": "aiplatform.projects.locations.tuningJobs.processData", +"parameterOrder": [ +"parent" +], +"parameters": { +"parent": { +"description": "Required. The resource name of the Location to process the data in. Format: `projects/{project}/locations/{location}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+parent}/tuningJobs:processData", +"request": { +"$ref": "GoogleCloudAiplatformV1beta1ProcessDataRequest" +}, +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, "rebaseTunedModel": { "description": "Rebase a tuned model. A rebase operation takes a model that was previously tuned on a base model version, and retunes it on a new base model version. The rebase operation creates a new tuning job and a new tuned model.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tuningJobs:rebaseTunedModel", @@ -41300,7 +41419,7 @@ "type": "string" }, "updateMask": { -"description": "Optional. Mask specifying which fields to update. Supported fields: * `display_name` * `description` * `fact`", +"description": "Optional. Mask specifying which fields to update. The following fields are immutable: * `scope` * `memory_type`", "format": "google-fieldmask", "location": "query", "type": "string" @@ -44495,166 +44614,6 @@ } } }, -"semanticGovernancePolicyEngine": { -"resources": { -"operations": { -"methods": { -"cancel": { -"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", -"flatPath": "v1beta1/semanticGovernancePolicyEngine/operations/{operationsId}:cancel", -"httpMethod": "POST", -"id": "aiplatform.semanticGovernancePolicyEngine.operations.cancel", -"parameterOrder": [ -"name" -], -"parameters": { -"name": { -"description": "The name of the operation resource to be cancelled.", -"location": "path", -"pattern": "^semanticGovernancePolicyEngine/operations/[^/]+$", -"required": true, -"type": "string" -} -}, -"path": "v1beta1/{+name}:cancel", -"response": { -"$ref": "GoogleProtobufEmpty" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform" -] -}, -"delete": { -"description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", -"flatPath": "v1beta1/semanticGovernancePolicyEngine/operations/{operationsId}", -"httpMethod": "DELETE", -"id": "aiplatform.semanticGovernancePolicyEngine.operations.delete", -"parameterOrder": [ -"name" -], -"parameters": { -"name": { -"description": "The name of the operation resource to be deleted.", -"location": "path", -"pattern": "^semanticGovernancePolicyEngine/operations/[^/]+$", -"required": true, -"type": "string" -} -}, -"path": "v1beta1/{+name}", -"response": { -"$ref": "GoogleProtobufEmpty" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform" -] -}, -"get": { -"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", -"flatPath": "v1beta1/semanticGovernancePolicyEngine/operations/{operationsId}", -"httpMethod": "GET", -"id": "aiplatform.semanticGovernancePolicyEngine.operations.get", -"parameterOrder": [ -"name" -], -"parameters": { -"name": { -"description": "The name of the operation resource.", -"location": "path", -"pattern": "^semanticGovernancePolicyEngine/operations/[^/]+$", -"required": true, -"type": "string" -} -}, -"path": "v1beta1/{+name}", -"response": { -"$ref": "GoogleLongrunningOperation" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform" -] -}, -"list": { -"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", -"flatPath": "v1beta1/semanticGovernancePolicyEngine/operations", -"httpMethod": "GET", -"id": "aiplatform.semanticGovernancePolicyEngine.operations.list", -"parameterOrder": [ -"name" -], -"parameters": { -"filter": { -"description": "The standard list filter.", -"location": "query", -"type": "string" -}, -"name": { -"description": "The name of the operation's parent resource.", -"location": "path", -"pattern": "^semanticGovernancePolicyEngine$", -"required": true, -"type": "string" -}, -"pageSize": { -"description": "The standard list page size.", -"format": "int32", -"location": "query", -"type": "integer" -}, -"pageToken": { -"description": "The standard list page token.", -"location": "query", -"type": "string" -}, -"returnPartialSuccess": { -"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", -"location": "query", -"type": "boolean" -} -}, -"path": "v1beta1/{+name}/operations", -"response": { -"$ref": "GoogleLongrunningListOperationsResponse" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform" -] -}, -"wait": { -"description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", -"flatPath": "v1beta1/semanticGovernancePolicyEngine/operations/{operationsId}:wait", -"httpMethod": "POST", -"id": "aiplatform.semanticGovernancePolicyEngine.operations.wait", -"parameterOrder": [ -"name" -], -"parameters": { -"name": { -"description": "The name of the operation resource to wait on.", -"location": "path", -"pattern": "^semanticGovernancePolicyEngine/operations/[^/]+$", -"required": true, -"type": "string" -}, -"timeout": { -"description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", -"format": "google-duration", -"location": "query", -"type": "string" -} -}, -"path": "v1beta1/{+name}:wait", -"response": { -"$ref": "GoogleLongrunningOperation" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform" -] -} -} -} -} -}, "servingProfiles": { "resources": { "operations": { @@ -46515,7 +46474,7 @@ } } }, -"revision": "20260515", +"revision": "20260523", "rootUrl": "https://aiplatform.googleapis.com/", "schemas": { "CloudAiLargeModelsVisionGenerateVideoExperiments": { @@ -46556,6 +46515,10 @@ "format": "int32", "type": "integer" }, +"originalRequestJson": { +"description": "The original REST API request JSON sent by the user, in the instances/parameters format. Preserved for saving alongside output artifacts so users can reproduce their requests. This field is populated by the API handler and is not user-settable.", +"type": "string" +}, "promptInputs": { "$ref": "CloudAiLargeModelsVisionPromptInputs", "description": "Prompt chunks for \"ProModel\" prompting. If set, the prompt will not be rewritten, and top-level prompt ignored." @@ -47213,7 +47176,7 @@ "GenaiVertexV1beta1ArgumentsDelta": { "id": "GenaiVertexV1beta1ArgumentsDelta", "properties": { -"partial_arguments": { +"arguments": { "type": "string" } }, @@ -47355,12 +47318,12 @@ "enum": [ "DELIVERY_UNSPECIFIED", "INLINE", -"URL" +"URI" ], "enumDescriptions": [ "Default value. This value is unused.", "Audio data is returned inline in the response.", -"Audio data is returned as a URL." +"Audio data is returned as a URI." ], "type": "string" }, @@ -47791,6 +47754,107 @@ }, "type": "object" }, +"GenaiVertexV1beta1EnvironmentConfig": { +"description": "Configuration for a custom environment.", +"id": "GenaiVertexV1beta1EnvironmentConfig", +"properties": { +"networkAllowlist": { +"$ref": "GenaiVertexV1beta1EnvironmentConfigEnvironmentNetworkEgressAllowlist", +"description": "Allow only specific domains." +}, +"networkMode": { +"description": "Network egress mode.", +"enum": [ +"NETWORK_MODE_UNSPECIFIED", +"DISABLED" +], +"enumDescriptions": [ +"Default value. Unused.", +"All network egress is blocked." +], +"type": "string" +}, +"sources": { +"items": { +"$ref": "GenaiVertexV1beta1EnvironmentConfigSource" +}, +"type": "array" +} +}, +"type": "object" +}, +"GenaiVertexV1beta1EnvironmentConfigEgressRule": { +"description": "A network egress rule that controls which external domains the environment is allowed to reach. Each rule identifies a target domain and, optionally, a set of HTTP headers to inject into every matching outbound request.", +"id": "GenaiVertexV1beta1EnvironmentConfigEgressRule", +"properties": { +"domain": { +"description": "The domain pattern to match for this rule. Use an exact hostname (e.g., `github.com`), a wildcard prefix (e.g., `*.googleapis.com`), or `*` to match all domains.", +"type": "string" +}, +"transform": { +"additionalProperties": { +"type": "string" +}, +"description": "Headers to inject into requests matching this rule. Key: header name (e.g., \"Authorization\"). Value: header value (e.g., \"Bearer your-token\").", +"type": "object" +} +}, +"type": "object" +}, +"GenaiVertexV1beta1EnvironmentConfigEnvironmentNetworkEgressAllowlist": { +"description": "Network egress configuration for the environment.", +"id": "GenaiVertexV1beta1EnvironmentConfigEnvironmentNetworkEgressAllowlist", +"properties": { +"allowlist": { +"description": "List of allowed domains and their configurations.", +"items": { +"$ref": "GenaiVertexV1beta1EnvironmentConfigEgressRule" +}, +"type": "array" +} +}, +"type": "object" +}, +"GenaiVertexV1beta1EnvironmentConfigSource": { +"description": "A source to be mounted into the environment.", +"id": "GenaiVertexV1beta1EnvironmentConfigSource", +"properties": { +"content": { +"description": "The inline content if `type` is `INLINE`.", +"type": "string" +}, +"encoding": { +"description": "Optional encoding for inline content (e.g. `base64`).", +"type": "string" +}, +"source": { +"description": "The source of the environment. For GCS, this is the GCS path. For GitHub, this is the GitHub path.", +"type": "string" +}, +"target": { +"description": "Where the source should appear in the environment.", +"type": "string" +}, +"type": { +"enum": [ +"TYPE_UNSPECIFIED", +"GCS", +"INLINE", +"REPOSITORY", +"SKILL_REGISTRY" +], +"enumDescriptions": [ +"", +"A GCS bucket.", +"Inline content.", +"A generic repository. The protocol prefix in the source URL identifies the provider (e.g., github://, gcs://).", +"A skill resource from the Skill Registry Service. Skill: projects/{project}/locations/{location}/skills/{skill} SkillRevision: projects/{project}/locations/{location}/skills/{skill}/revisions/{revision} Support mounting all skills under a project: projects/{project}/locations/{location}/skills." +], +"type": "string" +} +}, +"type": "object" +}, "GenaiVertexV1beta1Error": { "description": "Error message from an interaction.", "id": "GenaiVertexV1beta1Error", @@ -48085,6 +48149,7 @@ "properties": { "image_config": { "$ref": "GenaiVertexV1beta1ImageConfig", +"deprecated": true, "description": "Configuration for image interaction." }, "max_output_tokens": { @@ -48747,12 +48812,12 @@ "enum": [ "DELIVERY_UNSPECIFIED", "INLINE", -"URL" +"URI" ], "enumDescriptions": [ "Default value. This value is unused.", "Image data is returned inline in the response.", -"Image data is returned as a URL." +"Image data is returned as a URI." ], "type": "string" }, @@ -48811,6 +48876,15 @@ "readOnly": true, "type": "string" }, +"env_id": { +"description": "The environment ID for the interaction. Can be 'remote' for default environment.", +"type": "string" +}, +"environment_id": { +"description": "Output only. The environment ID for the interaction. Only populated if environment config is set in the request.", +"readOnly": true, +"type": "string" +}, "id": { "description": "Required. Output only. A unique identifier for the interaction completion.", "readOnly": true, @@ -48833,6 +48907,9 @@ "description": "The ID of the previous interaction, if any.", "type": "string" }, +"remoteEnvironment": { +"$ref": "GenaiVertexV1beta1EnvironmentConfig" +}, "responseFormatList": { "$ref": "GenaiVertexV1beta1ResponseFormatList" }, @@ -48845,6 +48922,7 @@ "description": "Enforces that the generated response is a JSON object that complies with the JSON schema specified in this field." }, "response_mime_type": { +"deprecated": true, "description": "The mime type of the response. This is required if response_format is set.", "type": "string" }, @@ -48886,7 +48964,8 @@ "COMPLETED", "FAILED", "CANCELLED", -"INCOMPLETE" +"INCOMPLETE", +"BUDGET_EXCEEDED" ], "enumDescriptions": [ "Default value. This value is unused.", @@ -48895,7 +48974,8 @@ "The interaction is completed.", "The interaction failed.", "The interaction was cancelled.", -"The interaction is completed, but contains incomplete results (e.g. hitting max_tokens)." +"The interaction is completed, but contains incomplete results (e.g. hitting max_tokens).", +"The interaction was halted because the token budget was exceeded." ], "readOnly": true, "type": "string" @@ -48905,7 +48985,7 @@ "description": "Input only. The steps for the interaction." }, "steps": { -"description": "Output only. The steps that make up the interaction.", +"description": "Required. Output only. The steps that make up the interaction.", "items": { "$ref": "GenaiVertexV1beta1Step" }, @@ -48999,7 +49079,8 @@ "COMPLETED", "FAILED", "CANCELLED", -"INCOMPLETE" +"INCOMPLETE", +"BUDGET_EXCEEDED" ], "enumDescriptions": [ "Default value. This value is unused.", @@ -49008,7 +49089,8 @@ "The interaction is completed.", "The interaction failed.", "The interaction was cancelled.", -"The interaction is completed, but contains incomplete results (e.g. hitting max_tokens)." +"The interaction is completed, but contains incomplete results (e.g. hitting max_tokens).", +"The interaction was halted because the token budget was exceeded." ], "type": "string" } @@ -49060,6 +49142,10 @@ "$ref": "GenaiVertexV1beta1InteractionStatusUpdate", "description": "The interaction status data, used for interaction.status_update events." }, +"metadata": { +"$ref": "GenaiVertexV1beta1StreamMetadata", +"description": "Optional metadata accompanying ANY streamed event." +}, "stepDelta": { "$ref": "GenaiVertexV1beta1StepDelta", "description": "The step delta data, used for step.delta events." @@ -49427,9 +49513,6 @@ }, "text": { "$ref": "GenaiVertexV1beta1TextResponseFormat" -}, -"video": { -"$ref": "GenaiVertexV1beta1VideoResponseFormat" } }, "type": "object" @@ -49491,6 +49574,64 @@ }, "type": "object" }, +"GenaiVertexV1beta1ServerToolCallDelta": { +"id": "GenaiVertexV1beta1ServerToolCallDelta", +"properties": { +"codeExecutionCall": { +"$ref": "GenaiVertexV1beta1CodeExecutionCallDelta" +}, +"fileSearchCall": { +"$ref": "GenaiVertexV1beta1FileSearchCallDelta" +}, +"googleMapsCall": { +"$ref": "GenaiVertexV1beta1GoogleMapsCallDelta" +}, +"googleSearchCall": { +"$ref": "GenaiVertexV1beta1GoogleSearchCallDelta" +}, +"mcpServerToolCall": { +"$ref": "GenaiVertexV1beta1McpServerToolCallDelta" +}, +"signature": { +"description": "A signature hash for backend validation.", +"format": "byte", +"type": "string" +}, +"urlContextCall": { +"$ref": "GenaiVertexV1beta1UrlContextCallDelta" +} +}, +"type": "object" +}, +"GenaiVertexV1beta1ServerToolResultDelta": { +"id": "GenaiVertexV1beta1ServerToolResultDelta", +"properties": { +"codeExecutionResult": { +"$ref": "GenaiVertexV1beta1CodeExecutionResultDelta" +}, +"fileSearchResult": { +"$ref": "GenaiVertexV1beta1FileSearchResultDelta" +}, +"googleMapsResult": { +"$ref": "GenaiVertexV1beta1GoogleMapsResultDelta" +}, +"googleSearchResult": { +"$ref": "GenaiVertexV1beta1GoogleSearchResultDelta" +}, +"mcpServerToolResult": { +"$ref": "GenaiVertexV1beta1McpServerToolResultDelta" +}, +"signature": { +"description": "A signature hash for backend validation.", +"format": "byte", +"type": "string" +}, +"urlContextResult": { +"$ref": "GenaiVertexV1beta1UrlContextResultDelta" +} +}, +"type": "object" +}, "GenaiVertexV1beta1SpeechConfig": { "description": "The configuration for speech interaction.", "id": "GenaiVertexV1beta1SpeechConfig", @@ -49557,9 +49698,18 @@ "document": { "$ref": "GenaiVertexV1beta1DocumentDelta" }, +"functionResult": { +"$ref": "GenaiVertexV1beta1FunctionResultDelta" +}, "image": { "$ref": "GenaiVertexV1beta1ImageDelta" }, +"serverToolCall": { +"$ref": "GenaiVertexV1beta1ServerToolCallDelta" +}, +"serverToolResult": { +"$ref": "GenaiVertexV1beta1ServerToolResultDelta" +}, "text": { "$ref": "GenaiVertexV1beta1TextDelta" }, @@ -49615,6 +49765,15 @@ }, "type": "object" }, +"GenaiVertexV1beta1StreamMetadata": { +"id": "GenaiVertexV1beta1StreamMetadata", +"properties": { +"usage": { +"$ref": "GenaiVertexV1beta1InteractionUsage" +} +}, +"type": "object" +}, "GenaiVertexV1beta1TextAnnotationDelta": { "id": "GenaiVertexV1beta1TextAnnotationDelta", "properties": { @@ -50280,11 +50439,13 @@ "description": "Input provided by the user.", "id": "GenaiVertexV1beta1UserInputStep", "properties": { -"content": { -"items": { -"$ref": "GenaiVertexV1beta1Content" +"contentList": { +"$ref": "GenaiVertexV1beta1ContentList", +"description": "The content of the step. An array of Content objects." }, -"type": "array" +"contentString": { +"description": "The content of the step. A single string.", +"type": "string" } }, "type": "object" @@ -50427,12 +50588,6 @@ }, "type": "object" }, -"GenaiVertexV1beta1VideoResponseFormat": { -"description": "Configuration for video output format.", -"id": "GenaiVertexV1beta1VideoResponseFormat", -"properties": {}, -"type": "object" -}, "GoogleApiHttpBody": { "description": "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.", "id": "GoogleApiHttpBody", @@ -50684,15 +50839,15 @@ "id": "GoogleCloudAiplatformV1beta1Agent", "properties": { "base_agent": { -"description": "Required. The base agent of the agent. Supported values: - \"antigravity-preview-05-2026\"", +"description": "Required. The base agent for the agent. Supported values: * `antigravity-preview-05-2026`", "type": "string" }, "base_environment": { -"description": "Optional. The environment config of the agent. Valid types are: - string value for environment_id, or 'remote' for default - struct value for EnvironmentConfig.", +"description": "Optional. The base environment configuration for the agent. Valid types: * A string value for the environment ID, or `remote` for the default. * A struct value for the `environment_config`.", "type": "any" }, "created": { -"description": "Output only. Timestamp when the agent was created.", +"description": "Output only. The time the agent was created.", "format": "google-datetime", "readOnly": true, "type": "string" @@ -50702,38 +50857,38 @@ "type": "string" }, "id": { -"description": "Immutable. The ID to use for agent, which will become the final component of the agent resource name. If not provided, Vertex AI will generate a value for this ID. This value may be up to 63 characters, and valid characters are `[a-z0-9-]`. The first character must be a letter, the last character must be a letter or number.", +"description": "Immutable. The user-specified ID for the agent. This ID becomes the final component of the agent resource name. If not provided, Vertex AI will generate a value for this ID. The ID can be up to 63 characters and must match the regular expression `[a-z]([a-z0-9-]{0,61}[a-z0-9])?`.", "type": "string" }, "metadata": { "additionalProperties": { "type": "string" }, -"description": "Optional. The metadata of the agent.", +"description": "Optional. The metadata for the agent.", "type": "object" }, "name": { -"description": "Identifier. The resource name of the Agent. Format: `projects/{project}/locations/{location}/agents/{agent}`.", +"description": "Identifier. The resource name of the agent. Format: `projects/{project}/locations/{location}/agents/{agent}`.", "type": "string" }, "object": { -"description": "Output only. The object type of this resource. Always set to \"agent\" in this case.", +"description": "Output only. The object type of the resource. For agents, the value is `agent`.", "readOnly": true, "type": "string" }, "system_instruction": { -"description": "Optional. The detailed struction that the agent should follow. The instruction is passed to LLM as system instruction.", +"description": "Optional. The instructions for the agent to follow. These instructions are passed to the LLM as a system instruction.", "type": "string" }, "tools": { -"description": "Optional. A list of tools that are available for the agent during the process of execucting the task.", +"description": "Optional. The tools available to the agent.", "items": { "$ref": "GoogleCloudAiplatformV1beta1AgentTool" }, "type": "array" }, "updated": { -"description": "Output only. Timestamp when the agent was last updated.", +"description": "Output only. The time the agent was last updated.", "format": "google-datetime", "readOnly": true, "type": "string" @@ -50835,26 +50990,26 @@ "type": "object" }, "GoogleCloudAiplatformV1beta1AgentTool": { -"description": "A tool provides a list of actions that are available for the Agent during the process of executing the task.", +"description": "A tool provides a list of actions available to the Agent during the process of executing a task.", "id": "GoogleCloudAiplatformV1beta1AgentTool", "properties": { "headers": { "additionalProperties": { "type": "string" }, -"description": "Optional. Headers for the MCP server (e.g., authentication). Only applicable when `type` is \"mcp\".", +"description": "Optional. The headers for the MCP server, such as for authentication. Only applicable when `type` is `mcp_server`.", "type": "object" }, "name": { -"description": "Optional. The name of the MCP server. Only applicable when `type` is \"mcp\".", +"description": "Optional. The name of the MCP server. Only applicable when `type` is `mcp_server`.", "type": "string" }, "type": { -"description": "Required. Type of the tool. Supported types: - \"code_execution\" - \"filesystem\" - \"google_search\" - \"mcp\" - \"url_context\"", +"description": "Required. The type of the tool. Supported types: * `code_execution` * `filesystem` * `google_search` * `mcp_server` * `url_context`", "type": "string" }, "url": { -"description": "Optional. The full URL for the MCP server endpoint. Only applicable when `type` is \"mcp\".", +"description": "Optional. The URL for the MCP server endpoint. Only applicable when `type` is `mcp_server`.", "type": "string" } }, @@ -56005,6 +56160,12 @@ }, "type": "object" }, +"GoogleCloudAiplatformV1beta1DeprovisionSemanticGovernancePolicyEngineRequest": { +"description": "Request message for SemanticGovernancePolicyEngineService.DeprovisionSemanticGovernancePolicyEngine.", +"id": "GoogleCloudAiplatformV1beta1DeprovisionSemanticGovernancePolicyEngineRequest", +"properties": {}, +"type": "object" +}, "GoogleCloudAiplatformV1beta1DestinationFeatureSetting": { "id": "GoogleCloudAiplatformV1beta1DestinationFeatureSetting", "properties": { @@ -62408,6 +62569,61 @@ }, "type": "object" }, +"GoogleCloudAiplatformV1beta1GatewayConfig": { +"description": "Configuration for a single gateway.", +"id": "GoogleCloudAiplatformV1beta1GatewayConfig", +"properties": { +"dnsRecord": { +"description": "Output only. The fully qualified record name of the created A-record in Cloud DNS.", +"readOnly": true, +"type": "string" +}, +"dnsZoneName": { +"description": "Optional. FQDN of the private DNS zone to create DNS record set for PSC endpoint.", +"type": "string" +}, +"ipAddress": { +"description": "Output only. The private IP address of the PSC endpoint.", +"readOnly": true, +"type": "string" +}, +"network": { +"description": "Optional. The URI of the network resource where PSC-E will be provisioned. if not provided `default` network will be used. Format: projects/{project}/global/networks/{network}", +"type": "string" +}, +"pscEndpoint": { +"description": "Output only. The self-link or name of the Private Service Connect endpoint forwarding rule.", +"readOnly": true, +"type": "string" +}, +"state": { +"description": "Output only. The state of the Gateway configuration.", +"enum": [ +"STATE_UNSPECIFIED", +"PROVISIONING", +"ACTIVE", +"DEPROVISIONING", +"INACTIVE", +"FAILED" +], +"enumDescriptions": [ +"The default value. This value is used if the state is omitted.", +"The Gateway is being provisioned.", +"The Gateway is active and ready to use.", +"The Gateway is being de-provisioned.", +"The Gateway is inactive.", +"The Gateway failed to be provisioned." +], +"readOnly": true, +"type": "string" +}, +"subnetwork": { +"description": "Optional. The URI of the subnetwork resource where PSC-E will be provisioned. if not provided `default` subnet will be used from the same {location} Format: projects/{project}/regions/{region}/subnetworks/{subnetwork}", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudAiplatformV1beta1GcsDestination": { "description": "The Google Cloud Storage location where the output is to be written to.", "id": "GoogleCloudAiplatformV1beta1GcsDestination", @@ -65483,14 +65699,14 @@ "id": "GoogleCloudAiplatformV1beta1ListAgentsResponse", "properties": { "agents": { -"description": "A list of agents matching the request.", +"description": "The agents matching the request.", "items": { "$ref": "GoogleCloudAiplatformV1beta1Agent" }, "type": "array" }, "nextPageToken": { -"description": "A token, which can be sent as ListAgentsRequest.page_token to retrieve the next page. Absence of this field indicates there are no subsequent pages.", +"description": "A token to retrieve the next page of results. Pass this value as ListAgentsRequest.page_token in a subsequent call.", "type": "string" } }, @@ -66667,6 +66883,24 @@ }, "type": "object" }, +"GoogleCloudAiplatformV1beta1ListSemanticGovernancePoliciesResponse": { +"description": "Response message for SemanticGovernancePolicyService.ListSemanticGovernancePolicies.", +"id": "GoogleCloudAiplatformV1beta1ListSemanticGovernancePoliciesResponse", +"properties": { +"nextPageToken": { +"description": "A token to retrieve the next page of results. Pass to ListSemanticGovernancePoliciesRequest.page_token to obtain that page.", +"type": "string" +}, +"semanticGovernancePolicies": { +"description": "The list of SemanticGovernancePolicies.", +"items": { +"$ref": "GoogleCloudAiplatformV1beta1SemanticGovernancePolicy" +}, +"type": "array" +} +}, +"type": "object" +}, "GoogleCloudAiplatformV1beta1ListSessionsResponse": { "description": "Response message for SessionService.ListSessions.", "id": "GoogleCloudAiplatformV1beta1ListSessionsResponse", @@ -72587,7 +72821,7 @@ false "type": "object" }, "GoogleCloudAiplatformV1beta1PersistentDiskSpec": { -"description": "Represents the spec of persistent disk options.", +"description": "Represents the spec of persistent disk and hyperdisk options.", "id": "GoogleCloudAiplatformV1beta1PersistentDiskSpec", "properties": { "diskSizeGb": { @@ -72596,7 +72830,7 @@ false "type": "string" }, "diskType": { -"description": "Type of the disk (default is \"pd-standard\"). Valid values: \"pd-ssd\" (Persistent Disk Solid State Drive) \"pd-standard\" (Persistent Disk Hard Disk Drive) \"pd-balanced\" (Balanced Persistent Disk) \"pd-extreme\" (Extreme Persistent Disk)", +"description": "Type of the disk (default is \"pd-standard\"). Valid values: \"pd-ssd\" (Persistent Disk Solid State Drive) \"pd-standard\" (Persistent Disk Hard Disk Drive) \"pd-balanced\" (Balanced Persistent Disk) \"pd-extreme\" (Extreme Persistent Disk) \"hyperdisk-balanced\" (Hyperdisk Balanced) \"hyperdisk-extreme\" (Hyperdisk Extreme) \"hyperdisk-balanced-high-availability\" (Hyperdisk Balanced High Availability) \"hyperdisk-ml\" (Hyperdisk ML) \"hyperdisk-throughput\" (Hyperdisk Throughput)", "type": "string" } }, @@ -74030,6 +74264,44 @@ false }, "type": "object" }, +"GoogleCloudAiplatformV1beta1ProcessDataRequest": { +"description": "Request message for GenAiTuningService.ProcessData.", +"id": "GoogleCloudAiplatformV1beta1ProcessDataRequest", +"properties": { +"gcsDestination": { +"$ref": "GoogleCloudAiplatformV1beta1GcsDestination", +"description": "Optional. The GCS bucket to store the processed videos and captions data." +}, +"gcsSource": { +"$ref": "GoogleCloudAiplatformV1beta1GcsSource", +"description": "Optional. A JSONL file containing a list of files to process stored in the user's GCS bucket." +}, +"veoSpec": { +"$ref": "GoogleCloudAiplatformV1beta1ProcessDataRequestVeoSpec", +"description": "Optional. Spec for Veo data processing." +} +}, +"type": "object" +}, +"GoogleCloudAiplatformV1beta1ProcessDataRequestVeoSpec": { +"description": "Spec for Veo data processing.", +"id": "GoogleCloudAiplatformV1beta1ProcessDataRequestVeoSpec", +"properties": { +"processType": { +"description": "Optional. The type of data processing to perform.", +"enum": [ +"VEO_V1_AND_V2_DEFAULT", +"VEO_V3" +], +"enumDescriptions": [ +"Process type for Veo 1 and 2.", +"Process type for Veo 3." +], +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudAiplatformV1beta1PscAutomatedEndpoints": { "description": "PscAutomatedEndpoints defines the output of the forwarding rule automatically created by each PscAutomationConfig.", "id": "GoogleCloudAiplatformV1beta1PscAutomatedEndpoints", @@ -78919,6 +79191,10 @@ false "The default container image for Computer Use." ], "type": "string" +}, +"resources": { +"$ref": "GoogleCloudAiplatformV1beta1SandboxEnvironmentTemplateResourceRequirements", +"description": "Optional. Resource requests and limits for the default container." } }, "type": "object" @@ -84063,6 +84339,149 @@ false }, "type": "object" }, +"GoogleCloudAiplatformV1beta1SemanticGovernancePolicy": { +"description": "Represents a governance policy applied to a specific Agent and optionally a specific Tool within that Agent.", +"id": "GoogleCloudAiplatformV1beta1SemanticGovernancePolicy", +"properties": { +"agent": { +"description": "Required. The name of the agent in Agent Registry that is affected by this policy.", +"type": "string" +}, +"agentIdentity": { +"description": "Output only. Represents the principal of the agent, used by the Policy Decision Point (PDP) for governance checks. For more information, see https://docs.cloud.google.com/agent-builder/agent-engine/agent-identity Format: `principal://TRUST_DOMAIN/NAMESPACE/AGENT_NAME` Example: `principal://agents.global.org-ORGANIZATION_ID.system.id.goog/resources/aiplatform/projects/PROJECT_NUMBER/locations/LOCATION/reasoningEngines/AGENT_ENGINE_ID`", +"readOnly": true, +"type": "string" +}, +"createTime": { +"description": "Output only. Timestamp when this SemanticGovernancePolicy was created.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"description": { +"description": "Optional. The description of the SemanticGovernancePolicy.", +"type": "string" +}, +"displayName": { +"description": "Optional. The user-defined name of the SemanticGovernancePolicy.", +"type": "string" +}, +"etag": { +"description": "Optional. Used to perform consistent read-modify-write transactions. If provided, the request will only succeed if the etag matches the current value. Otherwise, an ABORTED error will be returned.", +"type": "string" +}, +"mcpTools": { +"description": "Optional. The McpTools that are affected by this policy.", +"items": { +"$ref": "GoogleCloudAiplatformV1beta1SemanticGovernancePolicyMcpTool" +}, +"type": "array" +}, +"name": { +"description": "Identifier. Resource name of the SemanticGovernancePolicy.", +"type": "string" +}, +"naturalLanguageConstraint": { +"description": "Required. The natural language constraint of the SemanticGovernancePolicy.", +"type": "string" +}, +"updateTime": { +"description": "Output only. Timestamp when this SemanticGovernancePolicy was last updated.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudAiplatformV1beta1SemanticGovernancePolicyEngine": { +"description": "Define a singleton SemanticGovernancePolicyEngine resource under a project and location.", +"id": "GoogleCloudAiplatformV1beta1SemanticGovernancePolicyEngine", +"properties": { +"createTime": { +"description": "Output only. Timestamp when this SemanticGovernancePolicyEngine was created.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"gatewayConfigs": { +"additionalProperties": { +"$ref": "GoogleCloudAiplatformV1beta1GatewayConfig" +}, +"description": "Optional. Configurations for gateways. The keys are user-defined names for each gateway.", +"type": "object" +}, +"ipAddress": { +"description": "Output only. The private IPv4 address of the PSC endpoint.", +"readOnly": true, +"type": "string" +}, +"name": { +"description": "Identifier. The resource name of the SemanticGovernancePolicyEngine. Format: projects/{project}/locations/{location}/semanticGovernancePolicyEngine", +"type": "string" +}, +"pscForwardingRule": { +"description": "Output only. The URI of the PSC endpoint resource created in customer project. Format: projects/{project}/regions/{region}/forwardingRules/{forwarding_rule}", +"readOnly": true, +"type": "string" +}, +"pscServiceAttachment": { +"description": "Output only. URI of the PSC attachment resource provided by SGP. Format: projects/{project}/regions/{region}/serviceAttachments/{service_attachment}", +"readOnly": true, +"type": "string" +}, +"state": { +"description": "Output only. The state of the SemanticGovernancePolicyEngine.", +"enum": [ +"STATE_UNSPECIFIED", +"PROVISIONING", +"ACTIVE", +"DEPROVISIONING", +"INACTIVE", +"FAILED" +], +"enumDescriptions": [ +"Default value. This value is unused.", +"A provisioning operation is in progress. The engine will transition to ACTIVE on success or FAILED on failure.", +"The engine and all of its gateway configurations are provisioned and ready to serve traffic.", +"A deprovisioning operation is in progress. The engine will transition to INACTIVE on success or FAILED on failure.", +"The engine has no provisioned infrastructure: either never provisioned, or successfully deprovisioned.", +"The most recent provisioning or deprovisioning operation failed. The engine may have partial infrastructure that needs explicit deprovision; the engine may be either re-provisioned or deprovisioned to recover." +], +"readOnly": true, +"type": "string" +}, +"targetProject": { +"description": "Optional. The project where network, subnetwork and dns resources are located. If not provided, it is assumed to be the same project of SemanticGovernancePolicyEngine. This field is for Shared VPC scenarios, where network resources may be in a target project and SGP engine in a service project.", +"type": "string" +}, +"updateTime": { +"description": "Output only. Timestamp when this SemanticGovernancePolicyEngine was last updated.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudAiplatformV1beta1SemanticGovernancePolicyMcpTool": { +"description": "Represents a governance policy applied to MCP tools used by an Agent.", +"id": "GoogleCloudAiplatformV1beta1SemanticGovernancePolicyMcpTool", +"properties": { +"mcpServer": { +"description": "Required. The resource name of the McpServer in Agent Registry that is affected by this policy. Format: `projects/{project}/locations/{location}/mcpServers/{mcp_server}`", +"type": "string" +}, +"tools": { +"description": "Optional. The resource names of the McpTools used by the Agent that is affected by this policy. If not specified, the policy applies to all McpTools in the McpServer.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, "GoogleCloudAiplatformV1beta1ServiceAccountSpec": { "description": "Configuration for the use of custom service account to run the workloads.", "id": "GoogleCloudAiplatformV1beta1ServiceAccountSpec", @@ -84391,7 +84810,7 @@ false }, "skill": { "$ref": "GoogleCloudAiplatformV1beta1Skill", -"description": "Output only. The state of the Skill at this revision. TODO(b/503772996) Use a different proto for skill data included in skill revision", +"description": "Output only. The state of the Skill at this revision.", "readOnly": true }, "state": { @@ -87035,6 +87454,10 @@ false "$ref": "GoogleCloudAiplatformV1beta1EnterpriseWebSearch", "description": "Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance." }, +"exaAiSearch": { +"$ref": "GoogleCloudAiplatformV1beta1ToolExaAiSearch", +"description": "Optional. Uses Exa.ai to search for information to answer user queries. The search results will be grounded on Exa.ai and presented to the model for response generation" +}, "functionDeclarations": { "description": "Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided.", "items": { @@ -87199,6 +87622,25 @@ false }, "type": "object" }, +"GoogleCloudAiplatformV1beta1ToolExaAiSearch": { +"description": "ExaAiSearch tool type. A tool that uses the Exa.ai search engine for grounding.", +"id": "GoogleCloudAiplatformV1beta1ToolExaAiSearch", +"properties": { +"apiKey": { +"description": "Required. The API key for ExaAiSearch.", +"type": "string" +}, +"customConfigs": { +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" +}, +"description": "Optional. This field can be used to pass any parameter from the Exa.ai Search API.", +"type": "object" +} +}, +"type": "object" +}, "GoogleCloudAiplatformV1beta1ToolGoogleSearch": { "description": "GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google.", "id": "GoogleCloudAiplatformV1beta1ToolGoogleSearch", diff --git a/googleapiclient/discovery_cache/documents/alertcenter.v1beta1.json b/googleapiclient/discovery_cache/documents/alertcenter.v1beta1.json index 72b5098011..d40aa42445 100644 --- a/googleapiclient/discovery_cache/documents/alertcenter.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/alertcenter.v1beta1.json @@ -423,7 +423,7 @@ } } }, -"revision": "20260427", +"revision": "20260525", "rootUrl": "https://alertcenter.googleapis.com/", "schemas": { "AbuseDetected": { @@ -1852,6 +1852,18 @@ "description": "Common alert information about violated rules that are configured by Google Workspace administrators.", "id": "RuleViolationInfo", "properties": { +"agentType": { +"description": "Optional. Agent type that triggered the rule.", +"enum": [ +"AGENT_TYPE_UNSPECIFIED", +"STUDIO" +], +"enumDescriptions": [ +"Unspecified agent type.", +"Studio agent type." +], +"type": "string" +}, "dataSource": { "description": "Source of the data.", "enum": [ @@ -1995,7 +2007,8 @@ "CHROME_PAGE_PRINT", "CHROME_URL_VISITED", "CHROMEOS_FILE_TRANSFER", -"GEMINI_ACCESS" +"GEMINI_ACCESS", +"AGENT_EXECUTION" ], "enumDescriptions": [ "Trigger is unspecified.", @@ -2009,7 +2022,8 @@ "A page is being printed by Chrome.", "A URL is visited within Chrome.", "A file being transferred (copy or moved) between different file systems on ChromeOS.", -"Gemini access." +"Gemini access.", +"Agent execution." ], "type": "string" }, diff --git a/googleapiclient/discovery_cache/documents/alloydb.v1.json b/googleapiclient/discovery_cache/documents/alloydb.v1.json index 792b87c303..7b1fd7dc33 100644 --- a/googleapiclient/discovery_cache/documents/alloydb.v1.json +++ b/googleapiclient/discovery_cache/documents/alloydb.v1.json @@ -1879,7 +1879,7 @@ } } }, -"revision": "20260507", +"revision": "20260520", "rootUrl": "https://alloydb.googleapis.com/", "schemas": { "AuthorizedNetwork": { @@ -5280,9 +5280,17 @@ false "type": "object" }, "StorageDatabasecenterPartnerapiV1mainDatabaseResourceMetadata": { -"description": "Common model for database resource instance metadata. Next ID: 32", +"description": "Common model for database resource instance metadata. Next ID: 35", "id": "StorageDatabasecenterPartnerapiV1mainDatabaseResourceMetadata", "properties": { +"additionalMetadata": { +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" +}, +"description": "Field to ingest additional metadata whichd does not support proto format.", +"type": "object" +}, "availabilityConfiguration": { "$ref": "StorageDatabasecenterPartnerapiV1mainAvailabilityConfiguration", "description": "Availability configuration for this instance" @@ -5436,6 +5444,18 @@ false ], "type": "string" }, +"internalAdditionalMetadata": { +"additionalProperties": { +"description": "Properties of the object. Contains field @type with type URL.", +"type": "any" +}, +"description": "Field to ingest additional metadata which support proto format.", +"type": "object" +}, +"ipAddress": { +"$ref": "StorageDatabasecenterPartnerapiV1mainIpAddress", +"description": "Optional. Private and public IP address of the resource." +}, "isDeletionProtectionEnabled": { "description": "Optional. Whether deletion protection is enabled for this resource.", "type": "boolean" @@ -6098,6 +6118,21 @@ false }, "type": "object" }, +"StorageDatabasecenterPartnerapiV1mainIpAddress": { +"description": "Used to send IP address information for a database resource.", +"id": "StorageDatabasecenterPartnerapiV1mainIpAddress", +"properties": { +"privateIp": { +"description": "The private IP address assigned to the resource within a Virtual Private Cloud (VPC). This IP is only reachable from within the same VPC network. Stored in standard string format (e.g., \"10.0.0.2\").", +"type": "string" +}, +"publicIp": { +"description": "The public IP address assigned to the resource. This IP is reachable from the internet. Stored in standard string format (e.g., \"34.72.1.1\").", +"type": "string" +} +}, +"type": "object" +}, "StorageDatabasecenterPartnerapiV1mainMachineConfiguration": { "description": "MachineConfiguration describes the configuration of a machine specific to Database Resource.", "id": "StorageDatabasecenterPartnerapiV1mainMachineConfiguration", @@ -6502,6 +6537,7 @@ false "ENGINE_CLOUD_SPANNER_WITH_GOOGLESQL_DIALECT", "ENGINE_MEMORYSTORE_FOR_REDIS", "ENGINE_MEMORYSTORE_FOR_REDIS_CLUSTER", +"ENGINE_MEMORSTORE_FOR_VALKEY", "ENGINE_OTHER", "ENGINE_FIRESTORE_WITH_NATIVE_MODE", "ENGINE_FIRESTORE_WITH_DATASTORE_MODE", @@ -6528,6 +6564,7 @@ false, false, false, false, +false, false ], "enumDescriptions": [ @@ -6544,6 +6581,7 @@ false "Cloud Spanner with Google SQL dialect.", "Memorystore with Redis dialect.", "Memorystore with Redis cluster dialect.", +"Memorystore with Valkey dialect.", "Other refers to rest of other database engine. This is to be when engine is known, but it is not present in this enum.", "Firestore with native mode.", "Firestore with datastore mode.", diff --git a/googleapiclient/discovery_cache/documents/alloydb.v1alpha.json b/googleapiclient/discovery_cache/documents/alloydb.v1alpha.json index ef83fd2871..7c6072f3d9 100644 --- a/googleapiclient/discovery_cache/documents/alloydb.v1alpha.json +++ b/googleapiclient/discovery_cache/documents/alloydb.v1alpha.json @@ -2086,7 +2086,7 @@ } } }, -"revision": "20260507", +"revision": "20260520", "rootUrl": "https://alloydb.googleapis.com/", "schemas": { "AuthorizedNetwork": { @@ -5830,9 +5830,17 @@ false "type": "object" }, "StorageDatabasecenterPartnerapiV1mainDatabaseResourceMetadata": { -"description": "Common model for database resource instance metadata. Next ID: 32", +"description": "Common model for database resource instance metadata. Next ID: 35", "id": "StorageDatabasecenterPartnerapiV1mainDatabaseResourceMetadata", "properties": { +"additionalMetadata": { +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" +}, +"description": "Field to ingest additional metadata whichd does not support proto format.", +"type": "object" +}, "availabilityConfiguration": { "$ref": "StorageDatabasecenterPartnerapiV1mainAvailabilityConfiguration", "description": "Availability configuration for this instance" @@ -5986,6 +5994,18 @@ false ], "type": "string" }, +"internalAdditionalMetadata": { +"additionalProperties": { +"description": "Properties of the object. Contains field @type with type URL.", +"type": "any" +}, +"description": "Field to ingest additional metadata which support proto format.", +"type": "object" +}, +"ipAddress": { +"$ref": "StorageDatabasecenterPartnerapiV1mainIpAddress", +"description": "Optional. Private and public IP address of the resource." +}, "isDeletionProtectionEnabled": { "description": "Optional. Whether deletion protection is enabled for this resource.", "type": "boolean" @@ -6648,6 +6668,21 @@ false }, "type": "object" }, +"StorageDatabasecenterPartnerapiV1mainIpAddress": { +"description": "Used to send IP address information for a database resource.", +"id": "StorageDatabasecenterPartnerapiV1mainIpAddress", +"properties": { +"privateIp": { +"description": "The private IP address assigned to the resource within a Virtual Private Cloud (VPC). This IP is only reachable from within the same VPC network. Stored in standard string format (e.g., \"10.0.0.2\").", +"type": "string" +}, +"publicIp": { +"description": "The public IP address assigned to the resource. This IP is reachable from the internet. Stored in standard string format (e.g., \"34.72.1.1\").", +"type": "string" +} +}, +"type": "object" +}, "StorageDatabasecenterPartnerapiV1mainMachineConfiguration": { "description": "MachineConfiguration describes the configuration of a machine specific to Database Resource.", "id": "StorageDatabasecenterPartnerapiV1mainMachineConfiguration", @@ -7052,6 +7087,7 @@ false "ENGINE_CLOUD_SPANNER_WITH_GOOGLESQL_DIALECT", "ENGINE_MEMORYSTORE_FOR_REDIS", "ENGINE_MEMORYSTORE_FOR_REDIS_CLUSTER", +"ENGINE_MEMORSTORE_FOR_VALKEY", "ENGINE_OTHER", "ENGINE_FIRESTORE_WITH_NATIVE_MODE", "ENGINE_FIRESTORE_WITH_DATASTORE_MODE", @@ -7078,6 +7114,7 @@ false, false, false, false, +false, false ], "enumDescriptions": [ @@ -7094,6 +7131,7 @@ false "Cloud Spanner with Google SQL dialect.", "Memorystore with Redis dialect.", "Memorystore with Redis cluster dialect.", +"Memorystore with Valkey dialect.", "Other refers to rest of other database engine. This is to be when engine is known, but it is not present in this enum.", "Firestore with native mode.", "Firestore with datastore mode.", diff --git a/googleapiclient/discovery_cache/documents/alloydb.v1beta.json b/googleapiclient/discovery_cache/documents/alloydb.v1beta.json index ce62bb747c..c742683bc2 100644 --- a/googleapiclient/discovery_cache/documents/alloydb.v1beta.json +++ b/googleapiclient/discovery_cache/documents/alloydb.v1beta.json @@ -2083,7 +2083,7 @@ } } }, -"revision": "20260507", +"revision": "20260520", "rootUrl": "https://alloydb.googleapis.com/", "schemas": { "AuthorizedNetwork": { @@ -5806,9 +5806,17 @@ false "type": "object" }, "StorageDatabasecenterPartnerapiV1mainDatabaseResourceMetadata": { -"description": "Common model for database resource instance metadata. Next ID: 32", +"description": "Common model for database resource instance metadata. Next ID: 35", "id": "StorageDatabasecenterPartnerapiV1mainDatabaseResourceMetadata", "properties": { +"additionalMetadata": { +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" +}, +"description": "Field to ingest additional metadata whichd does not support proto format.", +"type": "object" +}, "availabilityConfiguration": { "$ref": "StorageDatabasecenterPartnerapiV1mainAvailabilityConfiguration", "description": "Availability configuration for this instance" @@ -5962,6 +5970,18 @@ false ], "type": "string" }, +"internalAdditionalMetadata": { +"additionalProperties": { +"description": "Properties of the object. Contains field @type with type URL.", +"type": "any" +}, +"description": "Field to ingest additional metadata which support proto format.", +"type": "object" +}, +"ipAddress": { +"$ref": "StorageDatabasecenterPartnerapiV1mainIpAddress", +"description": "Optional. Private and public IP address of the resource." +}, "isDeletionProtectionEnabled": { "description": "Optional. Whether deletion protection is enabled for this resource.", "type": "boolean" @@ -6624,6 +6644,21 @@ false }, "type": "object" }, +"StorageDatabasecenterPartnerapiV1mainIpAddress": { +"description": "Used to send IP address information for a database resource.", +"id": "StorageDatabasecenterPartnerapiV1mainIpAddress", +"properties": { +"privateIp": { +"description": "The private IP address assigned to the resource within a Virtual Private Cloud (VPC). This IP is only reachable from within the same VPC network. Stored in standard string format (e.g., \"10.0.0.2\").", +"type": "string" +}, +"publicIp": { +"description": "The public IP address assigned to the resource. This IP is reachable from the internet. Stored in standard string format (e.g., \"34.72.1.1\").", +"type": "string" +} +}, +"type": "object" +}, "StorageDatabasecenterPartnerapiV1mainMachineConfiguration": { "description": "MachineConfiguration describes the configuration of a machine specific to Database Resource.", "id": "StorageDatabasecenterPartnerapiV1mainMachineConfiguration", @@ -7028,6 +7063,7 @@ false "ENGINE_CLOUD_SPANNER_WITH_GOOGLESQL_DIALECT", "ENGINE_MEMORYSTORE_FOR_REDIS", "ENGINE_MEMORYSTORE_FOR_REDIS_CLUSTER", +"ENGINE_MEMORSTORE_FOR_VALKEY", "ENGINE_OTHER", "ENGINE_FIRESTORE_WITH_NATIVE_MODE", "ENGINE_FIRESTORE_WITH_DATASTORE_MODE", @@ -7054,6 +7090,7 @@ false, false, false, false, +false, false ], "enumDescriptions": [ @@ -7070,6 +7107,7 @@ false "Cloud Spanner with Google SQL dialect.", "Memorystore with Redis dialect.", "Memorystore with Redis cluster dialect.", +"Memorystore with Valkey dialect.", "Other refers to rest of other database engine. This is to be when engine is known, but it is not present in this enum.", "Firestore with native mode.", "Firestore with datastore mode.", diff --git a/googleapiclient/discovery_cache/documents/androidmanagement.v1.json b/googleapiclient/discovery_cache/documents/androidmanagement.v1.json index 74e0f8a416..9e202a75fa 100644 --- a/googleapiclient/discovery_cache/documents/androidmanagement.v1.json +++ b/googleapiclient/discovery_cache/documents/androidmanagement.v1.json @@ -1265,7 +1265,7 @@ } } }, -"revision": "20260507", +"revision": "20260521", "rootUrl": "https://androidmanagement.googleapis.com/", "schemas": { "AdbShellCommandEvent": { @@ -2370,12 +2370,21 @@ false "type": "string" }, "signingKeyCertFingerprints": { -"description": "The SHA-1 hash of each android.content.pm.Signature (https://developer.android.com/reference/android/content/pm/Signature.html) associated with the app package. Each byte of each hash value is represented as a two-digit hexadecimal number.", +"deprecated": true, +"description": "Deprecated. Use signingKeyCerts instead. The SHA-1 hash of each android.content.pm.Signature (https://developer.android.com/reference/android/content/pm/Signature.html) associated with the app package. Each byte of each hash value is represented as a two-digit hexadecimal number.", "items": { "type": "string" }, "type": "array" }, +"signingKeyCerts": { +"description": "Output only. Signing key certificates of the app.", +"items": { +"$ref": "ApplicationSigningKeyCert" +}, +"readOnly": true, +"type": "array" +}, "state": { "description": "Application state.", "enum": [ diff --git a/googleapiclient/discovery_cache/documents/androidpublisher.v3.json b/googleapiclient/discovery_cache/documents/androidpublisher.v3.json index 5f91b8be2e..4a68b21e94 100644 --- a/googleapiclient/discovery_cache/documents/androidpublisher.v3.json +++ b/googleapiclient/discovery_cache/documents/androidpublisher.v3.json @@ -4843,7 +4843,8 @@ ] }, "cancel": { -"description": "Cancels a user's subscription purchase. The subscription remains valid until its expiration time. Newer version is available at purchases.subscriptionsv2.cancel for better client library support.", +"deprecated": true, +"description": "Deprecated: Use purchases.subscriptionsv2.cancel instead. Cancels a user's subscription purchase. The subscription remains valid until its expiration time. Newer version is available at purchases.subscriptionsv2.cancel for better client library support.", "flatPath": "androidpublisher/v3/applications/{packageName}/purchases/subscriptions/{subscriptionId}/tokens/{token}:cancel", "httpMethod": "POST", "id": "androidpublisher.purchases.subscriptions.cancel", @@ -4878,7 +4879,8 @@ ] }, "defer": { -"description": "Defers a user's subscription purchase until a specified future expiration time.", +"deprecated": true, +"description": "Deprecated: Use purchases.subscriptionsv2.defer instead. Defers a user's subscription purchase until a specified future expiration time.", "flatPath": "androidpublisher/v3/applications/{packageName}/purchases/subscriptions/{subscriptionId}/tokens/{token}:defer", "httpMethod": "POST", "id": "androidpublisher.purchases.subscriptions.defer", @@ -5637,7 +5639,7 @@ } } }, -"revision": "20260511", +"revision": "20260528", "rootUrl": "https://androidpublisher.googleapis.com/", "schemas": { "Abi": { @@ -8092,7 +8094,7 @@ "type": "object" }, "GeneratedApksPerSigningKey": { -"description": "Download metadata for split, standalone and universal APKs, as well as asset pack slices, signed with a given key. Next ID: 10", +"description": "Download metadata for split, standalone and universal APKs, as well as asset pack slices, signed with a given key.", "id": "GeneratedApksPerSigningKey", "properties": { "certificateSha256Hash": { @@ -8555,6 +8557,17 @@ false }, "type": "object" }, +"InGracePeriodStateContext": { +"description": "Additional context around subscriptions in IN_GRACE_PERIOD state.", +"id": "InGracePeriodStateContext", +"properties": { +"renewalDeclined": { +"$ref": "RenewalDeclinedContext", +"description": "Optional. The payment for the renewal was declined." +} +}, +"type": "object" +}, "InappproductsBatchDeleteRequest": { "description": "Request to delete multiple in-app products.", "id": "InappproductsBatchDeleteRequest", @@ -9469,6 +9482,17 @@ false }, "type": "object" }, +"OnHoldStateContext": { +"description": "Additional context around subscriptions in ON_HOLD state.", +"id": "OnHoldStateContext", +"properties": { +"renewalDeclined": { +"$ref": "RenewalDeclinedContext", +"description": "Optional. The payment for the renewal was declined." +} +}, +"type": "object" +}, "OneTimeCode": { "description": "A single use promotion code.", "id": "OneTimeCode", @@ -11172,6 +11196,17 @@ false }, "type": "object" }, +"RenewalDeclinedContext": { +"description": "Context related to renewal declined scenario.", +"id": "RenewalDeclinedContext", +"properties": { +"pendingOrderId": { +"description": "Required. The ID of the pending or failed order causing the state.", +"type": "string" +} +}, +"type": "object" +}, "RentOfferDetails": { "description": "Offer details information related to a rental line item.", "id": "RentOfferDetails", @@ -11636,7 +11671,8 @@ false "type": "string" }, "offerPhase": { -"description": "The pricing phase for the billing period funded by this order. Deprecated. Use offer_phase_details instead.", +"deprecated": true, +"description": "Deprecated: Use offer_phase_details instead. The pricing phase for the billing period funded by this order.", "enum": [ "OFFER_PHASE_UNSPECIFIED", "BASE", @@ -11872,7 +11908,8 @@ false "type": "object" }, "SubscriptionPurchase": { -"description": "A SubscriptionPurchase resource indicates the status of a user's subscription purchase.", +"deprecated": true, +"description": "Deprecated: Use SubscriptionPurchaseV2 instead. A SubscriptionPurchase resource indicates the status of a user's subscription purchase.", "id": "SubscriptionPurchase", "properties": { "acknowledgementState": { @@ -12086,6 +12123,10 @@ false "$ref": "ExternalAccountIdentifiers", "description": "User account identifier in the third-party service." }, +"inGracePeriodStateContext": { +"$ref": "InGracePeriodStateContext", +"description": "Optional. Additional context around subscriptions in IN_GRACE_PERIOD state. Only present if the subscription currently has subscription_state SUBSCRIPTION_STATE_IN_GRACE_PERIOD." +}, "kind": { "description": "This kind represents a SubscriptionPurchaseV2 object in the androidpublisher service.", "type": "string" @@ -12106,6 +12147,10 @@ false "description": "The purchase token of the old subscription if this subscription is one of the following: * Re-signup of a canceled but non-lapsed subscription * Upgrade/downgrade from a previous subscription. * Convert from prepaid to auto renewing subscription. * Convert from an auto renewing subscription to prepaid. * Topup a prepaid subscription.", "type": "string" }, +"onHoldStateContext": { +"$ref": "OnHoldStateContext", +"description": "Optional. Additional context around subscriptions in ON_HOLD state. Only present if the subscription currently has subscription_state SUBSCRIPTION_STATE_ON_HOLD." +}, "outOfAppPurchaseContext": { "$ref": "OutOfAppPurchaseContext", "description": "Additional context for out of app purchases. This information is only present for re-subscription purchases (subscription purchases made after the previous subscription of the same product has expired) made through the Google Play subscriptions center. This field will be removed after you acknowledge the subscription." @@ -12982,7 +13027,9 @@ false "CAN_MANAGE_APP_CONTENT_GLOBAL", "CAN_VIEW_NON_FINANCIAL_DATA_GLOBAL", "CAN_VIEW_APP_QUALITY_GLOBAL", -"CAN_MANAGE_DEEPLINKS_GLOBAL" +"CAN_MANAGE_DEEPLINKS_GLOBAL", +"CAN_VIEW_CONNECTED_APPS_GLOBAL", +"CAN_EDIT_CONNECTED_APPS_GLOBAL" ], "enumDeprecated": [ false, @@ -13003,6 +13050,8 @@ false, false, false, false, +false, +false, false ], "enumDescriptions": [ @@ -13024,7 +13073,9 @@ false "Manage policy related pages on all apps for the developer.", "View app information and download bulk reports (read-only).", "View app quality information for all apps for the developer.", -"Manage the deep links setup for all apps for the developer." +"Manage the deep links setup for all apps for the developer.", +"Allows viewing connected apps in the Google Play Console.", +"Allows editing connected apps in the Google Play Console." ], "type": "string" }, diff --git a/googleapiclient/discovery_cache/documents/apphub.v1.json b/googleapiclient/discovery_cache/documents/apphub.v1.json index 1965123058..a1fe1af1e1 100644 --- a/googleapiclient/discovery_cache/documents/apphub.v1.json +++ b/googleapiclient/discovery_cache/documents/apphub.v1.json @@ -281,7 +281,7 @@ "type": "string" }, "updateMask": { -"description": "Required. Field mask is used to specify the fields to be overwritten in the Boundary resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.", +"description": "Optional. Field mask is used to specify the fields to be overwritten in the Boundary resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.", "format": "google-fieldmask", "location": "query", "type": "string" @@ -494,7 +494,7 @@ "type": "string" }, "updateMask": { -"description": "Required. Field mask is used to specify the fields to be overwritten in the Application resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. The API changes the values of the fields as specified in the update_mask. The API ignores the values of all fields not covered by the update_mask. You can also unset a field by not specifying it in the updated message, but adding the field to the mask. This clears whatever value the field previously had.", +"description": "Optional. Field mask is used to specify the fields to be overwritten in the Application resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. The API changes the values of the fields as specified in the update_mask. The API ignores the values of all fields not covered by the update_mask. You can also unset a field by not specifying it in the updated message, but adding the field to the mask. This clears whatever value the field previously had.", "format": "google-fieldmask", "location": "query", "type": "string" @@ -732,7 +732,7 @@ "type": "string" }, "updateMask": { -"description": "Required. Field mask is used to specify the fields to be overwritten in the Service resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. The API changes the values of the fields as specified in the update_mask. The API ignores the values of all fields not covered by the update_mask. You can also unset a field by not specifying it in the updated message, but adding the field to the mask. This clears whatever value the field previously had.", +"description": "Optional. Field mask is used to specify the fields to be overwritten in the Service resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. The API changes the values of the fields as specified in the update_mask. The API ignores the values of all fields not covered by the update_mask. You can also unset a field by not specifying it in the updated message, but adding the field to the mask. This clears whatever value the field previously had.", "format": "google-fieldmask", "location": "query", "type": "string" @@ -914,7 +914,7 @@ "type": "string" }, "updateMask": { -"description": "Required. Field mask is used to specify the fields to be overwritten in the Workload resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. The API changes the values of the fields as specified in the update_mask. The API ignores the values of all fields not covered by the update_mask. You can also unset a field by not specifying it in the updated message, but adding the field to the mask. This clears whatever value the field previously had.", +"description": "Optional. Field mask is used to specify the fields to be overwritten in the Workload resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. The API changes the values of the fields as specified in the update_mask. The API ignores the values of all fields not covered by the update_mask. You can also unset a field by not specifying it in the updated message, but adding the field to the mask. This clears whatever value the field previously had.", "format": "google-fieldmask", "location": "query", "type": "string" @@ -1486,7 +1486,7 @@ } } }, -"revision": "20260422", +"revision": "20260520", "rootUrl": "https://apphub.googleapis.com/", "schemas": { "Application": { diff --git a/googleapiclient/discovery_cache/documents/apphub.v1alpha.json b/googleapiclient/discovery_cache/documents/apphub.v1alpha.json index f0654ab569..ea64837b72 100644 --- a/googleapiclient/discovery_cache/documents/apphub.v1alpha.json +++ b/googleapiclient/discovery_cache/documents/apphub.v1alpha.json @@ -281,7 +281,7 @@ "type": "string" }, "updateMask": { -"description": "Required. Field mask is used to specify the fields to be overwritten in the Boundary resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.", +"description": "Optional. Field mask is used to specify the fields to be overwritten in the Boundary resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.", "format": "google-fieldmask", "location": "query", "type": "string" @@ -494,7 +494,7 @@ "type": "string" }, "updateMask": { -"description": "Required. Field mask is used to specify the fields to be overwritten in the Application resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. The API changes the values of the fields as specified in the update_mask. The API ignores the values of all fields not covered by the update_mask. You can also unset a field by not specifying it in the updated message, but adding the field to the mask. This clears whatever value the field previously had.", +"description": "Optional. Field mask is used to specify the fields to be overwritten in the Application resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. The API changes the values of the fields as specified in the update_mask. The API ignores the values of all fields not covered by the update_mask. You can also unset a field by not specifying it in the updated message, but adding the field to the mask. This clears whatever value the field previously had.", "format": "google-fieldmask", "location": "query", "type": "string" @@ -732,7 +732,7 @@ "type": "string" }, "updateMask": { -"description": "Required. Field mask is used to specify the fields to be overwritten in the Service resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. The API changes the values of the fields as specified in the update_mask. The API ignores the values of all fields not covered by the update_mask. You can also unset a field by not specifying it in the updated message, but adding the field to the mask. This clears whatever value the field previously had.", +"description": "Optional. Field mask is used to specify the fields to be overwritten in the Service resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. The API changes the values of the fields as specified in the update_mask. The API ignores the values of all fields not covered by the update_mask. You can also unset a field by not specifying it in the updated message, but adding the field to the mask. This clears whatever value the field previously had.", "format": "google-fieldmask", "location": "query", "type": "string" @@ -914,7 +914,7 @@ "type": "string" }, "updateMask": { -"description": "Required. Field mask is used to specify the fields to be overwritten in the Workload resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. The API changes the values of the fields as specified in the update_mask. The API ignores the values of all fields not covered by the update_mask. You can also unset a field by not specifying it in the updated message, but adding the field to the mask. This clears whatever value the field previously had.", +"description": "Optional. Field mask is used to specify the fields to be overwritten in the Workload resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. The API changes the values of the fields as specified in the update_mask. The API ignores the values of all fields not covered by the update_mask. You can also unset a field by not specifying it in the updated message, but adding the field to the mask. This clears whatever value the field previously had.", "format": "google-fieldmask", "location": "query", "type": "string" @@ -1578,7 +1578,7 @@ } } }, -"revision": "20260422", +"revision": "20260520", "rootUrl": "https://apphub.googleapis.com/", "schemas": { "Application": { diff --git a/googleapiclient/discovery_cache/documents/artifactregistry.v1.json b/googleapiclient/discovery_cache/documents/artifactregistry.v1.json index 844fb40e7b..61c28e8775 100644 --- a/googleapiclient/discovery_cache/documents/artifactregistry.v1.json +++ b/googleapiclient/discovery_cache/documents/artifactregistry.v1.json @@ -490,7 +490,7 @@ ] }, "list": { -"description": "Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the [ListLocationsRequest.name] field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.", +"description": "Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the ListLocationsRequest.name field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.", "flatPath": "v1/projects/{projectsId}/locations", "httpMethod": "GET", "id": "artifactregistry.projects.locations.list", @@ -499,7 +499,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. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -667,6 +667,35 @@ }, "repositories": { "methods": { +"checkPrewarmedArtifact": { +"description": "Checks an artifact streaming.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}:checkPrewarmedArtifact", +"httpMethod": "POST", +"id": "artifactregistry.projects.locations.repositories.checkPrewarmedArtifact", +"parameterOrder": [ +"repository" +], +"parameters": { +"repository": { +"description": "Required. The name of the repository, for example: `projects/p1/locations/us-central1/repositories/repo1`. If the package or version ID parts contain slashes, the slashes are escaped.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/repositories/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+repository}:checkPrewarmedArtifact", +"request": { +"$ref": "CheckPrewarmedArtifactRequest" +}, +"response": { +"$ref": "CheckPrewarmedArtifactResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/cloud-platform.read-only" +] +}, "create": { "description": "Creates a repository. The returned Operation will finish once the repository has been created. Its response will be the created Repository.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/repositories", @@ -892,6 +921,64 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, +"prewarmArtifact": { +"description": "Prewarms an artifact for streaming.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}:prewarmArtifact", +"httpMethod": "POST", +"id": "artifactregistry.projects.locations.repositories.prewarmArtifact", +"parameterOrder": [ +"repository" +], +"parameters": { +"repository": { +"description": "Required. The repository name, for example: `projects/p1/locations/us-central1/repositories/repo1`. If the package or version ID parts contain slashes, the slashes are escaped.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/repositories/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+repository}:prewarmArtifact", +"request": { +"$ref": "PrewarmArtifactRequest" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/cloud-platform.read-only" +] +}, +"removePrewarmedArtifact": { +"description": "Removes an artifact from streaming.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}:removePrewarmedArtifact", +"httpMethod": "POST", +"id": "artifactregistry.projects.locations.repositories.removePrewarmedArtifact", +"parameterOrder": [ +"repository" +], +"parameters": { +"repository": { +"description": "Required. The repository name, for example: `projects/p1/locations/us-central1/repositories/repo1`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/repositories/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+repository}:removePrewarmedArtifact", +"request": { +"$ref": "RemovePrewarmedArtifactRequest" +}, +"response": { +"$ref": "RemovePrewarmedArtifactResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/cloud-platform.read-only" +] +}, "setIamPolicy": { "description": "Updates the IAM policy for a given resource.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}:setIamPolicy", @@ -2276,6 +2363,52 @@ } } }, +"prewarmedArtifacts": { +"methods": { +"list": { +"description": "Lists all streamed artifacts in a repository.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/prewarmedArtifacts", +"httpMethod": "GET", +"id": "artifactregistry.projects.locations.repositories.prewarmedArtifacts.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"filter": { +"description": "Optional. Filter should only support The location of the prewarmed artifacts. multi-region is not supported for this field.", +"location": "query", +"type": "string" +}, +"pageSize": { +"description": "Optional. The maximum number of prewarmed artifacts to return. Maximum page size is 1,000. Default page size is 100.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "Optional. The next_page_token value returned from a previous list request, if any.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The repository of the artifact to list. Format: projects/{project}/locations/{location}/repositories/{repository}", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/repositories/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+parent}/prewarmedArtifacts", +"response": { +"$ref": "ListPrewarmedArtifactsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/cloud-platform.read-only" +] +} +} +}, "pythonPackages": { "methods": { "get": { @@ -2581,7 +2714,7 @@ } } }, -"revision": "20260320", +"revision": "20260522", "rootUrl": "https://artifactregistry.googleapis.com/", "schemas": { "AptArtifact": { @@ -2761,6 +2894,36 @@ "properties": {}, "type": "object" }, +"CheckPrewarmedArtifactRequest": { +"description": "The request for checking an artifact for streaming.", +"id": "CheckPrewarmedArtifactRequest", +"properties": { +"streamLocation": { +"description": "Optional. The location of the prewarmed artifact. multi-region is not supported for this field.", +"type": "string" +}, +"tag": { +"description": "Optional. The artifact tag Format:projects/{project}/locations/{location}/repositories/{repository}/packages/{package}/tags/{tag}", +"type": "string" +}, +"version": { +"description": "Optional. The artifact version Format: projects/{project}/locations/{location}/repositories/{repository}/packages/{package}/versions/{version}", +"type": "string" +} +}, +"type": "object" +}, +"CheckPrewarmedArtifactResponse": { +"description": "The response for checking an artifact for streaming.", +"id": "CheckPrewarmedArtifactResponse", +"properties": { +"prewarmedArtifact": { +"$ref": "PrewarmedArtifact", +"description": "The prewarmed artifact that was checked." +} +}, +"type": "object" +}, "CleanupPolicy": { "description": "Artifact policy configuration for repository cleanup policies.", "id": "CleanupPolicy", @@ -3790,6 +3953,24 @@ }, "type": "object" }, +"ListPrewarmedArtifactsResponse": { +"description": "The response for listing artifacts for streaming.", +"id": "ListPrewarmedArtifactsResponse", +"properties": { +"nextPageToken": { +"description": "The token to retrieve the next page of prewarmed artifacts, or empty if there are no more streamings to return.", +"type": "string" +}, +"prewarmedArtifacts": { +"description": "The prewarmed artifacts.", +"items": { +"$ref": "PrewarmedArtifact" +}, +"type": "array" +} +}, +"type": "object" +}, "ListPythonPackagesResponse": { "description": "The response from listing python packages.", "id": "ListPythonPackagesResponse", @@ -4206,6 +4387,65 @@ }, "type": "object" }, +"PrewarmArtifactRequest": { +"description": "The request for prewarming an artifact for streaming.", +"id": "PrewarmArtifactRequest", +"properties": { +"force": { +"description": "Optional. If true, old artifact will be evicted to make room for the new artifact.", +"type": "boolean" +}, +"retentionDays": { +"description": "Optional. The retention days of the prewarmed artifact. If not specified, the artifact will be cached for 3 days.", +"format": "int64", +"type": "string" +}, +"streamLocation": { +"description": "Optional. The location to cache the artifact in. If not specified, the artifact will be cached in the same location as the artifact. multi-region is not supported for this field.", +"type": "string" +}, +"tag": { +"description": "Optional. The artifact tag Format:projects/{project}/locations/{location}/repositories/{repository}/packages/{package}/tags/{tag}", +"type": "string" +}, +"version": { +"description": "Optional. The artifact version Format: projects/{project}/locations/{location}/repositories/{repository}/packages/{package}/versions/{version}", +"type": "string" +} +}, +"type": "object" +}, +"PrewarmArtifactResponse": { +"description": "The response for prewarming an artifact for streaming.", +"id": "PrewarmArtifactResponse", +"properties": { +"prewarmedArtifact": { +"$ref": "PrewarmedArtifact", +"description": "The prewarmed artifact that was prewarmed." +} +}, +"type": "object" +}, +"PrewarmedArtifact": { +"description": "PrewarmedArtifact represents a streamed artifact.", +"id": "PrewarmedArtifact", +"properties": { +"expirationTime": { +"description": "The expiration time of the prewarmed artifact.", +"format": "google-datetime", +"type": "string" +}, +"location": { +"description": "The location of the prewarmed artifact.", +"type": "string" +}, +"uri": { +"description": "URL to access the image. Example: us-west4-docker.pkg.dev/test-project/test-repo/nginx@sha256:e9954c1fc875017be1c3e36eca16be2d9e9bccc4bf072163515467d6a823c7cf", +"type": "string" +} +}, +"type": "object" +}, "ProjectConfig": { "description": "The Artifact Registry logging configurations that apply to a Project.", "id": "ProjectConfig", @@ -4370,6 +4610,36 @@ false }, "type": "object" }, +"RemovePrewarmedArtifactRequest": { +"description": "The request for removing an artifact from streaming.", +"id": "RemovePrewarmedArtifactRequest", +"properties": { +"streamLocation": { +"description": "Optional. The location of the prewarmed artifact. multi-region is not supported for this field.", +"type": "string" +}, +"tag": { +"description": "Optional. The artifact tag Format:projects/{project}/locations/{location}/repositories/{repository}/packages/{package}/tags/{tag}", +"type": "string" +}, +"version": { +"description": "Optional. The artifact version Format: projects/{project}/locations/{location}/repositories/{repository}/packages/{package}/versions/{version}", +"type": "string" +} +}, +"type": "object" +}, +"RemovePrewarmedArtifactResponse": { +"description": "The response for removing an artifact from streaming.", +"id": "RemovePrewarmedArtifactResponse", +"properties": { +"prewarmedArtifact": { +"$ref": "PrewarmedArtifact", +"description": "The prewarmed artifact that was removed." +} +}, +"type": "object" +}, "Repository": { "description": "A Repository for storing artifacts with a specific format.", "id": "Repository", diff --git a/googleapiclient/discovery_cache/documents/artifactregistry.v1beta1.json b/googleapiclient/discovery_cache/documents/artifactregistry.v1beta1.json index a662bde1fa..5fe12ec1a8 100644 --- a/googleapiclient/discovery_cache/documents/artifactregistry.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/artifactregistry.v1beta1.json @@ -376,7 +376,7 @@ ] }, "list": { -"description": "Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the [ListLocationsRequest.name] field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.", +"description": "Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the ListLocationsRequest.name field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.", "flatPath": "v1beta1/projects/{projectsId}/locations", "httpMethod": "GET", "id": "artifactregistry.projects.locations.list", @@ -385,7 +385,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. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -1182,7 +1182,7 @@ } } }, -"revision": "20260320", +"revision": "20260522", "rootUrl": "https://artifactregistry.googleapis.com/", "schemas": { "Binding": { diff --git a/googleapiclient/discovery_cache/documents/backupdr.v1.json b/googleapiclient/discovery_cache/documents/backupdr.v1.json index ced07f7499..c6be526999 100644 --- a/googleapiclient/discovery_cache/documents/backupdr.v1.json +++ b/googleapiclient/discovery_cache/documents/backupdr.v1.json @@ -2661,7 +2661,7 @@ } } }, -"revision": "20260510", +"revision": "20260517", "rootUrl": "https://backupdr.googleapis.com/", "schemas": { "AbandonBackupRequest": { @@ -4531,6 +4531,10 @@ "description": "Required. Target project for the Compute Engine instance.", "type": "string" }, +"useProjectServiceAccount": { +"description": "Optional. Whether to use the project service account for the Compute Engine instance.", +"type": "boolean" +}, "zone": { "description": "Required. The zone of the Compute Engine instance.", "type": "string" @@ -5140,6 +5144,10 @@ "description": "Required. Target project for the disk.", "type": "string" }, +"useProjectServiceAccount": { +"description": "Optional. Whether to use the project service account for the disk.", +"type": "boolean" +}, "zone": { "description": "Required. Target zone for the disk.", "type": "string" @@ -6579,6 +6587,10 @@ "type": "string" }, "type": "array" +}, +"useProjectServiceAccount": { +"description": "Optional. Whether to use the project service account for the disk.", +"type": "boolean" } }, "type": "object" diff --git a/googleapiclient/discovery_cache/documents/bigquery.v2.json b/googleapiclient/discovery_cache/documents/bigquery.v2.json index 55be493b5e..1c6c5a87dd 100644 --- a/googleapiclient/discovery_cache/documents/bigquery.v2.json +++ b/googleapiclient/discovery_cache/documents/bigquery.v2.json @@ -2390,7 +2390,7 @@ } } }, -"revision": "20260314", +"revision": "20260429", "rootUrl": "https://bigquery.googleapis.com/", "schemas": { "AggregateClassificationMetrics": { @@ -3607,6 +3607,20 @@ }, "type": "object" }, +"DataPolicyList": { +"description": "A list of data policy options. For more information, see [Mask data by applying data policies to a column](https://docs.cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column).", +"id": "DataPolicyList", +"properties": { +"dataPolicies": { +"description": "Contains a list of data policy options. At most 9 data policies are allowed per field.", +"items": { +"$ref": "DataPolicyOption" +}, +"type": "array" +} +}, +"type": "object" +}, "DataPolicyOption": { "description": "Data policy option. For more information, see [Mask data by applying data policies to a column](https://docs.cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column).", "id": "DataPolicyOption", @@ -4764,6 +4778,11 @@ "description": "Optional. Amount of memory provisioned for a Python UDF container instance. Format: {number}{unit} where unit is one of \"M\", \"G\", \"Mi\" and \"Gi\" (e.g. 1G, 512Mi). If not specified, the default value is 512Mi. For more information, see [Configure container limits for Python UDFs](https://cloud.google.com/bigquery/docs/user-defined-functions-python#configure-container-limits)", "type": "string" }, +"containerRequestConcurrency": { +"description": "Optional. Maximum number of requests that a Cloud Run instance can handle concurrently. If absent or if `0`, a default concurrency is used.", +"format": "int64", +"type": "string" +}, "maxBatchingRows": { "description": "Optional. Maximum number of rows in each batch sent to the external runtime. If absent or if 0, BigQuery dynamically decides the number of rows in a batch.", "format": "int64", @@ -4883,6 +4902,18 @@ }, "type": "object" }, +"GenAiFunctionCacheStats": { +"description": "Provides cache statistics for a GenAi function call.", +"id": "GenAiFunctionCacheStats", +"properties": { +"numCacheHitRows": { +"description": "Number of rows served from cache.", +"format": "int64", +"type": "string" +} +}, +"type": "object" +}, "GenAiFunctionCostOptimizationStats": { "description": "Provides cost optimization statistics for a GenAi function call.", "id": "GenAiFunctionCostOptimizationStats", @@ -4922,6 +4953,10 @@ "description": "Provides statistics for each Ai function call within a query.", "id": "GenAiFunctionStats", "properties": { +"cacheStats": { +"$ref": "GenAiFunctionCacheStats", +"description": "Cache stats for the function." +}, "costOptimizationStats": { "$ref": "GenAiFunctionCostOptimizationStats", "description": "Cost optimization stats if applied on the rows processed by the function." @@ -7318,6 +7353,25 @@ }, "type": "object" }, +"MetadataCacheStalenessInsight": { +"description": "Column Metadata Index staleness detailed infnormation.", +"id": "MetadataCacheStalenessInsight", +"properties": { +"avgPreviousStalenessMs": { +"description": "Output only. Average column metadata index staleness of previous runs with the same query hash.", +"format": "google-duration", +"readOnly": true, +"type": "string" +}, +"stalenessPercentageIncrease": { +"description": "Output only. The percent increase in staleness between the current job and the average staleness of previous jobs with the same query hash.", +"format": "double", +"readOnly": true, +"type": "number" +} +}, +"type": "object" +}, "MetadataCacheStatistics": { "description": "Statistics for metadata caching in queried tables.", "id": "MetadataCacheStatistics", @@ -7795,6 +7849,14 @@ }, "readOnly": true, "type": "array" +}, +"tableChangeInsights": { +"description": "Output only. Performance insights for table-level attributes that changed compared to previous runs.", +"items": { +"$ref": "TableChangeInsight" +}, +"readOnly": true, +"type": "array" } }, "type": "object" @@ -9872,6 +9934,28 @@ }, "type": "object" }, +"TableChangeInsight": { +"description": "Table-level performance insights compared to previous runs. These insights don't apply to specific query stages, rather they apply to the whole table.", +"id": "TableChangeInsight", +"properties": { +"metadataCacheNotUsedButUsedPreviously": { +"description": "Output only. True if the table's column metadata index was not used in the current job, but was used in a previous job with the same query hash.", +"readOnly": true, +"type": "boolean" +}, +"metadataCacheStalenessInsight": { +"$ref": "MetadataCacheStalenessInsight", +"description": "Output only. If present, indicates that the table's metadata column index staleness has increased significantly compared to previous jobs with the same query hash.", +"readOnly": true +}, +"tableReference": { +"$ref": "TableReference", +"description": "Output only. The table that was queried.", +"readOnly": true +} +}, +"type": "object" +}, "TableConstraints": { "description": "The TableConstraints defines the primary key and foreign key.", "id": "TableConstraints", @@ -10069,6 +10153,19 @@ "description": "Optional. Field collation can be set only when the type of field is STRING. The following values are supported: * 'und:ci': undetermined locale, case insensitive. * '': empty string. Default to case-sensitive behavior.", "type": "string" }, +"dataGovernanceTagsInfo": { +"description": "Optional. Specifies the data governance tags on this field. This field works with other column-level security fields as follows: - Precedence: If a data governance tag is attached to a column, it takes precedence over the policy tag attached to the column. However, if a data policy is attached to a column, it takes precedence over the data governance tag. - Patching behavior (how this field behaves during a `Table.patch` schema update): - Unset: If the `data_governance_tags_info` field is omitted from the update request, the existing tags on the column are preserved. - Empty Field: To clear data governance tags from a column, send the `data_governance_tags_info` field as an empty object. This will remove all tags from the column. - Updating tags: To replace existing tag, send the field with the new tag.", +"properties": { +"dataGovernanceTags": { +"additionalProperties": { +"type": "string" +}, +"description": "Optional. The data governance tags added to this field are used for field-level access control. Only one data governance tag is currently supported on a field. Tag keys are globally unique. Tag key is expected to be in the namespaced format, for example \"123456789012/pii\" where 123456789012 is the ID of the parent organization or project resource for this tag key. Tag value is expected to be the short name, for example \"sensitive\". See [Tag definitions](https://cloud.google.com/iam/docs/tags-access-control#definitions) for more details. For example: \"123456789012/pii\": \"sensitive\", \"myProject/cost_center\": \"sales\"", +"type": "object" +} +}, +"type": "object" +}, "dataPolicies": { "description": "Optional. Data policies attached to this field, used for field-level access control.", "items": { @@ -10076,6 +10173,10 @@ }, "type": "array" }, +"dataPolicyList": { +"$ref": "DataPolicyList", +"description": "Optional. Specifies data policies attached to this field, used for field-level access control. When set, this will be the source of truth for data policy information." +}, "defaultValueExpression": { "description": "Optional. A SQL expression to specify the [default value] (https://cloud.google.com/bigquery/docs/default-values) for this field.", "type": "string" diff --git a/googleapiclient/discovery_cache/documents/bigtableadmin.v2.json b/googleapiclient/discovery_cache/documents/bigtableadmin.v2.json index 5b6fd2cc98..525011c24c 100644 --- a/googleapiclient/discovery_cache/documents/bigtableadmin.v2.json +++ b/googleapiclient/discovery_cache/documents/bigtableadmin.v2.json @@ -3194,7 +3194,7 @@ } } }, -"revision": "20260425", +"revision": "20260514", "rootUrl": "https://bigtableadmin.googleapis.com/", "schemas": { "AppProfile": { @@ -3330,7 +3330,7 @@ "type": "string" }, "locations": { -"description": "Optional. A list of Cloud Bigtable zones where automated backups are allowed to be created. If empty, automated backups will be created in all zones of the instance. Locations are in the format `projects/{project}/locations/{zone}`. This field can only set for tables in Enterprise Plus instances.", +"description": "Optional. A list of Cloud Bigtable zones where automated backups are allowed to be created. If empty, automated backups will be created in all zones of the instance. Locations are in the format `projects/{project}/locations/{zone}`. You can set this field only for tables in Enterprise Plus instances.", "items": { "type": "string" }, @@ -5530,7 +5530,7 @@ "type": "object" }, "ProtoSchema": { -"description": "Represents a protobuf schema.", +"description": "Represents a collection of protobuf schemas.", "id": "ProtoSchema", "properties": { "protoDescriptors": { diff --git a/googleapiclient/discovery_cache/documents/blogger.v3.json b/googleapiclient/discovery_cache/documents/blogger.v3.json index 4f444b01ed..e9a7283016 100644 --- a/googleapiclient/discovery_cache/documents/blogger.v3.json +++ b/googleapiclient/discovery_cache/documents/blogger.v3.json @@ -1713,7 +1713,7 @@ } } }, -"revision": "20260309", +"revision": "20260521", "rootUrl": "https://blogger.googleapis.com/", "schemas": { "Blog": { @@ -2554,6 +2554,6 @@ } }, "servicePath": "", -"title": "Blogger API", +"title": "blogger API", "version": "v3" } \ No newline at end of file diff --git a/googleapiclient/discovery_cache/documents/calendar.v3.json b/googleapiclient/discovery_cache/documents/calendar.v3.json index 38ce5d4475..15f4838157 100644 --- a/googleapiclient/discovery_cache/documents/calendar.v3.json +++ b/googleapiclient/discovery_cache/documents/calendar.v3.json @@ -1890,7 +1890,7 @@ } } }, -"revision": "20260225", +"revision": "20260517", "rootUrl": "https://www.googleapis.com/", "schemas": { "Acl": { @@ -2849,6 +2849,11 @@ "format": "int32", "type": "integer" }, +"asyncOperation": { +"default": "", +"description": "If present, indicates the status of an asynchronous operation ongoing for this attendee (e.g. listing of members of large attendee groups). Read-only. The default is to not be present.\nPossible values are: \n- \"inProgress\" - The asynchronous operation is in progress. \n- (not present) - Otherwise.", +"type": "string" +}, "comment": { "description": "The attendee's response comment. Optional.", "type": "string" diff --git a/googleapiclient/discovery_cache/documents/ces.v1.json b/googleapiclient/discovery_cache/documents/ces.v1.json index 745dcf4498..9fe777e139 100644 --- a/googleapiclient/discovery_cache/documents/ces.v1.json +++ b/googleapiclient/discovery_cache/documents/ces.v1.json @@ -1489,6 +1489,39 @@ } } }, +"message": { +"methods": { +"send": { +"description": "Sends a message to an agent.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/message:send", +"httpMethod": "POST", +"id": "ces.projects.locations.apps.message.send", +"parameterOrder": [ +"tenant" +], +"parameters": { +"tenant": { +"description": "Optional. Tenant ID, provided as a path parameter.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+tenant}/message:send", +"request": { +"$ref": "LfA2aV1SendMessageRequest" +}, +"response": { +"$ref": "LfA2aV1SendMessageResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/ces", +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +}, "sessions": { "methods": { "generateChatToken": { @@ -2283,7 +2316,7 @@ } } }, -"revision": "20260506", +"revision": "20260513", "rootUrl": "https://ces.googleapis.com/", "schemas": { "Action": { @@ -2590,6 +2623,10 @@ "description": "Optional. The mapping of the app variables names to the Dialogflow session parameters names to be sent to the Dialogflow agent as input.", "type": "object" }, +"languageCodeVariable": { +"description": "Optional. The name of the variable that contains the language code to be used for the Dialogflow session. If unspecified, the default language code of the Dialogflow agent will be used.", +"type": "string" +}, "outputVariableMapping": { "additionalProperties": { "type": "string" @@ -5349,6 +5386,343 @@ }, "type": "object" }, +"LfA2aV1Artifact": { +"description": "Artifacts represent task outputs.", +"id": "LfA2aV1Artifact", +"properties": { +"artifactId": { +"description": "Required. Unique identifier (e.g. UUID) for the artifact. It must be unique within a task.", +"type": "string" +}, +"description": { +"description": "Optional. A human readable description of the artifact.", +"type": "string" +}, +"extensions": { +"description": "The URIs of extensions that are present or contributed to this Artifact.", +"items": { +"type": "string" +}, +"type": "array" +}, +"metadata": { +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" +}, +"description": "Optional. Metadata included with the artifact.", +"type": "object" +}, +"name": { +"description": "A human readable name for the artifact.", +"type": "string" +}, +"parts": { +"description": "Required. The content of the artifact. Must contain at least one part.", +"items": { +"$ref": "LfA2aV1Part" +}, +"type": "array" +} +}, +"type": "object" +}, +"LfA2aV1AuthenticationInfo": { +"description": "Defines authentication details, used for push notifications.", +"id": "LfA2aV1AuthenticationInfo", +"properties": { +"credentials": { +"description": "Push Notification credentials. Format depends on the scheme (e.g., token for Bearer).", +"type": "string" +}, +"scheme": { +"description": "Required. HTTP Authentication Scheme from the [IANA registry](https://www.iana.org/assignments/http-authschemes/). Examples: `Bearer`, `Basic`, `Digest`. Scheme names are case-insensitive per [RFC 9110 Section 11.1](https://www.rfc-editor.org/rfc/rfc9110#section-11.1).", +"type": "string" +} +}, +"type": "object" +}, +"LfA2aV1Message": { +"description": "`Message` is one unit of communication between client and server. It can be associated with a context and/or a task. For server messages, `context_id` must be provided, and `task_id` only if a task was created. For client messages, both fields are optional, with the caveat that if both are provided, they have to match (the `context_id` has to be the one that is set on the task). If only `task_id` is provided, the server will infer `context_id` from it.", +"id": "LfA2aV1Message", +"properties": { +"contextId": { +"description": "Optional. The context id of the message. If set, the message will be associated with the given context.", +"type": "string" +}, +"extensions": { +"description": "The URIs of extensions that are present or contributed to this Message.", +"items": { +"type": "string" +}, +"type": "array" +}, +"messageId": { +"description": "Required. The unique identifier (e.g. UUID) of the message. This is created by the message creator.", +"type": "string" +}, +"metadata": { +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" +}, +"description": "Optional. Any metadata to provide along with the message.", +"type": "object" +}, +"parts": { +"description": "Required. Parts is the container of the message content.", +"items": { +"$ref": "LfA2aV1Part" +}, +"type": "array" +}, +"referenceTaskIds": { +"description": "A list of task IDs that this message references for additional context.", +"items": { +"type": "string" +}, +"type": "array" +}, +"role": { +"description": "Required. Identifies the sender of the message.", +"enum": [ +"ROLE_UNSPECIFIED", +"ROLE_USER", +"ROLE_AGENT" +], +"enumDescriptions": [ +"The role is unspecified.", +"The message is from the client to the server.", +"The message is from the server to the client." +], +"type": "string" +}, +"taskId": { +"description": "Optional. The task id of the message. If set, the message will be associated with the given task.", +"type": "string" +} +}, +"type": "object" +}, +"LfA2aV1Part": { +"description": "`Part` represents a container for a section of communication content. Parts can be purely textual, some sort of file (image, video, etc) or a structured data blob (i.e. JSON).", +"id": "LfA2aV1Part", +"properties": { +"data": { +"description": "Arbitrary structured `data` as a JSON value (object, array, string, number, boolean, or null).", +"type": "any" +}, +"filename": { +"description": "An optional `filename` for the file (e.g., \"document.pdf\").", +"type": "string" +}, +"mediaType": { +"description": "The `media_type` (MIME type) of the part content (e.g., \"text/plain\", \"application/json\", \"image/png\"). This field is available for all part types.", +"type": "string" +}, +"metadata": { +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" +}, +"description": "Optional. metadata associated with this part.", +"type": "object" +}, +"raw": { +"description": "The `raw` byte content of a file. In JSON serialization, this is encoded as a base64 string.", +"format": "byte", +"type": "string" +}, +"text": { +"description": "The string content of the `text` part.", +"type": "string" +}, +"url": { +"description": "A `url` pointing to the file's content.", +"type": "string" +} +}, +"type": "object" +}, +"LfA2aV1SendMessageConfiguration": { +"description": "Configuration of a send message request.", +"id": "LfA2aV1SendMessageConfiguration", +"properties": { +"acceptedOutputModes": { +"description": "A list of media types the client is prepared to accept for response parts. Agents SHOULD use this to tailor their output.", +"items": { +"type": "string" +}, +"type": "array" +}, +"historyLength": { +"description": "The maximum number of most recent messages from the task's history to retrieve in the response. An unset value means the client does not impose any limit. A value of zero is a request to not include any messages. The server MUST NOT return more messages than the provided value, but MAY apply a lower limit.", +"format": "int32", +"type": "integer" +}, +"returnImmediately": { +"description": "If `true`, the operation returns immediately after creating the task, even if processing is still in progress. If `false` (default), the operation MUST wait until the task reaches a terminal (`COMPLETED`, `FAILED`, `CANCELED`, `REJECTED`) or interrupted (`INPUT_REQUIRED`, `AUTH_REQUIRED`) state before returning.", +"type": "boolean" +}, +"taskPushNotificationConfig": { +"$ref": "LfA2aV1TaskPushNotificationConfig", +"description": "Configuration for the agent to send push notifications for task updates. Task id should be empty when sending this configuration in a `SendMessage` request." +} +}, +"type": "object" +}, +"LfA2aV1SendMessageRequest": { +"description": "Represents a request for the `SendMessage` method.", +"id": "LfA2aV1SendMessageRequest", +"properties": { +"configuration": { +"$ref": "LfA2aV1SendMessageConfiguration", +"description": "Configuration for the send request." +}, +"message": { +"$ref": "LfA2aV1Message", +"description": "Required. The message to send to the agent." +}, +"metadata": { +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" +}, +"description": "A flexible key-value map for passing additional context or parameters.", +"type": "object" +} +}, +"type": "object" +}, +"LfA2aV1SendMessageResponse": { +"description": "Represents the response for the `SendMessage` method.", +"id": "LfA2aV1SendMessageResponse", +"properties": { +"message": { +"$ref": "LfA2aV1Message", +"description": "A message from the agent." +}, +"task": { +"$ref": "LfA2aV1Task", +"description": "The task created or updated by the message." +} +}, +"type": "object" +}, +"LfA2aV1Task": { +"description": "`Task` is the core unit of action for A2A. It has a current status and when results are created for the task they are stored in the artifact. If there are multiple turns for a task, these are stored in history.", +"id": "LfA2aV1Task", +"properties": { +"artifacts": { +"description": "A set of output artifacts for a `Task`.", +"items": { +"$ref": "LfA2aV1Artifact" +}, +"type": "array" +}, +"contextId": { +"description": "Unique identifier (e.g. UUID) for the contextual collection of interactions (tasks and messages).", +"type": "string" +}, +"history": { +"description": "protolint:disable REPEATED_FIELD_NAMES_PLURALIZED The history of interactions from a `Task`.", +"items": { +"$ref": "LfA2aV1Message" +}, +"type": "array" +}, +"id": { +"description": "Required. Unique identifier (e.g. UUID) for the task, generated by the server for a new task.", +"type": "string" +}, +"metadata": { +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" +}, +"description": "protolint:enable REPEATED_FIELD_NAMES_PLURALIZED A key/value object to store custom metadata about a task.", +"type": "object" +}, +"status": { +"$ref": "LfA2aV1TaskStatus", +"description": "Required. The current status of a `Task`, including `state` and a `message`." +} +}, +"type": "object" +}, +"LfA2aV1TaskPushNotificationConfig": { +"description": "A container associating a push notification configuration with a specific task.", +"id": "LfA2aV1TaskPushNotificationConfig", +"properties": { +"authentication": { +"$ref": "LfA2aV1AuthenticationInfo", +"description": "Authentication information required to send the notification." +}, +"id": { +"description": "The push notification configuration details. A unique identifier (e.g. UUID) for this push notification configuration.", +"type": "string" +}, +"taskId": { +"description": "The ID of the task this configuration is associated with.", +"type": "string" +}, +"tenant": { +"description": "Optional. Tenant ID.", +"type": "string" +}, +"token": { +"description": "A token unique for this task or session.", +"type": "string" +}, +"url": { +"description": "Required. The URL where the notification should be sent.", +"type": "string" +} +}, +"type": "object" +}, +"LfA2aV1TaskStatus": { +"description": "A container for the status of a task", +"id": "LfA2aV1TaskStatus", +"properties": { +"message": { +"$ref": "LfA2aV1Message", +"description": "A message associated with the status." +}, +"state": { +"description": "Required. The current state of this task.", +"enum": [ +"TASK_STATE_UNSPECIFIED", +"TASK_STATE_SUBMITTED", +"TASK_STATE_WORKING", +"TASK_STATE_COMPLETED", +"TASK_STATE_FAILED", +"TASK_STATE_CANCELED", +"TASK_STATE_INPUT_REQUIRED", +"TASK_STATE_REJECTED", +"TASK_STATE_AUTH_REQUIRED" +], +"enumDescriptions": [ +"The task is in an unknown or indeterminate state.", +"Indicates that a task has been successfully submitted and acknowledged.", +"Indicates that a task is actively being processed by the agent.", +"Indicates that a task has finished successfully. This is a terminal state.", +"Indicates that a task has finished with an error. This is a terminal state.", +"Indicates that a task was canceled before completion. This is a terminal state.", +"Indicates that the agent requires additional user input to proceed. This is an interrupted state.", +"Indicates that the agent has decided to not perform the task. This may be done during initial task creation or later once an agent has determined it can't or won't proceed. This is a terminal state.", +"Indicates that authentication is required to proceed. This is an interrupted state." +], +"type": "string" +}, +"timestamp": { +"description": "ISO 8601 Timestamp when the status was recorded. Example: \"2023-10-27T10:00:00Z\"", +"format": "google-datetime", +"type": "string" +} +}, +"type": "object" +}, "ListAgentsResponse": { "description": "Response message for AgentService.ListAgents.", "id": "ListAgentsResponse", @@ -5619,11 +5993,11 @@ "properties": { "audioRecordingConfig": { "$ref": "AudioRecordingConfig", -"description": "Optional. Configuration for how audio interactions should be recorded." +"description": "Optional. Configuration for how audio interactions should be recorded. The audio is subject to redaction as configured in RedactionConfig." }, "bigqueryExportSettings": { "$ref": "BigQueryExportSettings", -"description": "Optional. Settings to describe the BigQuery export behaviors for the app. The conversation data will be exported to BigQuery tables if it is enabled." +"description": "Optional. Configures the BigQuery export behaviors for the app. The conversation data is subject to redaction as configured in RedactionConfig." }, "cloudLoggingSettings": { "$ref": "CloudLoggingSettings", @@ -5647,7 +6021,7 @@ }, "unredactedAudioRecordingConfig": { "$ref": "AudioRecordingConfig", -"description": "Optional. Configures recording of unredacted audio. Use this to maintain a raw backup with restricted access when audio redaction is enabled, typically for auditing or monitoring purposes." +"description": "Optional. Configures an additional recording of unredacted audio. This can be used to maintain a raw audio copy when audio redaction is enabled, typically for auditing or monitoring purposes." } }, "type": "object" @@ -5679,6 +6053,10 @@ "description": "Required. The name of the MCP tool.", "type": "string" }, +"nameOverride": { +"description": "Optional. The name override of the MCP tool. This is populated if the name was overridden by a Toolset override.", +"type": "string" +}, "outputSchema": { "$ref": "Schema", "description": "Optional. The schema of the output arguments of the MCP tool." @@ -5691,6 +6069,23 @@ "$ref": "ServiceDirectoryConfig", "description": "Optional. Service Directory configuration for VPC-SC, used to resolve service names within a perimeter." }, +"state": { +"description": "Output only. The dynamic availability state of the tool on the external server.", +"enum": [ +"STATE_UNSPECIFIED", +"ACTIVE", +"INACTIVE", +"STALE" +], +"enumDescriptions": [ +"Default state.", +"The tool is available and actively offered by the server.", +"The tool is configured or pinned, but currently not offered by the server.", +"The tool exists on the server, but does not match the version on the server." +], +"readOnly": true, +"type": "string" +}, "tlsConfig": { "$ref": "TlsConfig", "description": "Optional. The TLS configuration. Includes the custom server certificates that the client should trust." @@ -5698,6 +6093,52 @@ }, "type": "object" }, +"McpToolDefinition": { +"description": "Container for a tool's core definition elements that are snapshot. Schemas in the snapshot are used as-is and cannot be overridden.", +"id": "McpToolDefinition", +"properties": { +"description": { +"description": "Output only. The description of the MCP tool. This can be overridden by `description_override` in `McpToolOverride`.", +"readOnly": true, +"type": "string" +}, +"inputSchema": { +"$ref": "Schema", +"description": "Output only. The schema of the input arguments of the MCP tool.", +"readOnly": true +}, +"outputSchema": { +"$ref": "Schema", +"description": "Output only. The schema of the output arguments of the MCP tool.", +"readOnly": true +} +}, +"type": "object" +}, +"McpToolOverride": { +"description": "Overrides associated with a given tool in a Toolset. This enables \"pinning\" or \"overriding\" of tool definitions from the external dynamic server.", +"id": "McpToolOverride", +"properties": { +"descriptionOverride": { +"description": "Optional. If present, this tool uses this description instead of the original description from the server.", +"type": "string" +}, +"nameOverride": { +"description": "Optional. If present, this tool uses this name in the Agent instead of the original name. This is primarily used as an alias if the MCP server offers poorly named tools.", +"type": "string" +}, +"snapshot": { +"$ref": "McpToolDefinition", +"description": "Output only. If present, this tool is \"Pinned\" and uses the snapshot values as fallbacks if the server becomes temporarily unavailable or if no Override is present.", +"readOnly": true +}, +"tool": { +"description": "Required. The original name of the tool as it is emitted by the MCP server.", +"type": "string" +} +}, +"type": "object" +}, "McpToolset": { "description": "A toolset that contains a list of tools that are offered by the MCP server.", "id": "McpToolset", @@ -5724,6 +6165,13 @@ "tlsConfig": { "$ref": "TlsConfig", "description": "Optional. The TLS configuration. Includes the custom server certificates that the client should trust." +}, +"toolOverrides": { +"description": "Optional. Overrides for individual tools within this toolset. This allows overriding specific details like descriptions, names, or pinning the tools' states so they aren't fully dynamic.", +"items": { +"$ref": "McpToolOverride" +}, +"type": "array" } }, "type": "object" @@ -6069,6 +6517,10 @@ "pythonCode": { "description": "Optional. The Python code to execute for the tool.", "type": "string" +}, +"serviceDirectoryConfig": { +"$ref": "ServiceDirectoryConfig", +"description": "Optional. Service Directory configuration for the tool." } }, "type": "object" @@ -6159,6 +6611,10 @@ "description": "Request message for ToolService.RetrieveTools.", "id": "RetrieveToolsRequest", "properties": { +"bypassPersistenceConfig": { +"description": "Optional. If true, the returned tools will contain raw descriptions and schemas directly from the server, bypassing any stored persistence configurations (overrides/snapshots).", +"type": "boolean" +}, "toolIds": { "description": "Optional. The identifiers of the tools to retrieve from the toolset. If empty, all tools in the toolset will be returned.", "items": { diff --git a/googleapiclient/discovery_cache/documents/ces.v1beta.json b/googleapiclient/discovery_cache/documents/ces.v1beta.json index f53dcb45e4..a736e1ebb3 100644 --- a/googleapiclient/discovery_cache/documents/ces.v1beta.json +++ b/googleapiclient/discovery_cache/documents/ces.v1beta.json @@ -2571,6 +2571,39 @@ } } }, +"message": { +"methods": { +"send": { +"description": "Sends a message to an agent.", +"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/message:send", +"httpMethod": "POST", +"id": "ces.projects.locations.apps.message.send", +"parameterOrder": [ +"tenant" +], +"parameters": { +"tenant": { +"description": "Optional. Tenant ID, provided as a path parameter.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta/{+tenant}/message:send", +"request": { +"$ref": "LfA2aV1SendMessageRequest" +}, +"response": { +"$ref": "LfA2aV1SendMessageResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/ces", +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +}, "scheduledEvaluationRuns": { "methods": { "create": { @@ -3542,7 +3575,7 @@ } } }, -"revision": "20260506", +"revision": "20260513", "rootUrl": "https://ces.googleapis.com/", "schemas": { "Action": { @@ -3849,6 +3882,10 @@ "description": "Optional. The mapping of the app variables names to the Dialogflow session parameters names to be sent to the Dialogflow agent as input.", "type": "object" }, +"languageCodeVariable": { +"description": "Optional. The name of the variable that contains the language code to be used for the Dialogflow session. If unspecified, the default language code of the Dialogflow agent will be used.", +"type": "string" +}, "outputVariableMapping": { "additionalProperties": { "type": "string" @@ -6167,6 +6204,11 @@ "description": "Output only. The session ID for the conversation that caused the error.", "readOnly": true, "type": "string" +}, +"userFacingErrorMessage": { +"description": "Output only. The user facing error message.", +"readOnly": true, +"type": "string" } }, "type": "object" @@ -7558,6 +7600,11 @@ "description": "Identifier. The unique identifier of the evaluation run. Format: `projects/{project}/locations/{location}/apps/{app}/evaluationRuns/{evaluationRun}`", "type": "string" }, +"operation": { +"description": "Output only. The operation that created this evaluation run. Format: `projects/{project}/locations/{location}/operations/{operation}`", +"readOnly": true, +"type": "string" +}, "optimizationConfig": { "$ref": "OptimizationConfig", "description": "Optional. Configuration for running the optimization step after the evaluation run. If not set, the optimization step will not be run." @@ -9499,6 +9546,343 @@ }, "type": "object" }, +"LfA2aV1Artifact": { +"description": "Artifacts represent task outputs.", +"id": "LfA2aV1Artifact", +"properties": { +"artifactId": { +"description": "Required. Unique identifier (e.g. UUID) for the artifact. It must be unique within a task.", +"type": "string" +}, +"description": { +"description": "Optional. A human readable description of the artifact.", +"type": "string" +}, +"extensions": { +"description": "The URIs of extensions that are present or contributed to this Artifact.", +"items": { +"type": "string" +}, +"type": "array" +}, +"metadata": { +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" +}, +"description": "Optional. Metadata included with the artifact.", +"type": "object" +}, +"name": { +"description": "A human readable name for the artifact.", +"type": "string" +}, +"parts": { +"description": "Required. The content of the artifact. Must contain at least one part.", +"items": { +"$ref": "LfA2aV1Part" +}, +"type": "array" +} +}, +"type": "object" +}, +"LfA2aV1AuthenticationInfo": { +"description": "Defines authentication details, used for push notifications.", +"id": "LfA2aV1AuthenticationInfo", +"properties": { +"credentials": { +"description": "Push Notification credentials. Format depends on the scheme (e.g., token for Bearer).", +"type": "string" +}, +"scheme": { +"description": "Required. HTTP Authentication Scheme from the [IANA registry](https://www.iana.org/assignments/http-authschemes/). Examples: `Bearer`, `Basic`, `Digest`. Scheme names are case-insensitive per [RFC 9110 Section 11.1](https://www.rfc-editor.org/rfc/rfc9110#section-11.1).", +"type": "string" +} +}, +"type": "object" +}, +"LfA2aV1Message": { +"description": "`Message` is one unit of communication between client and server. It can be associated with a context and/or a task. For server messages, `context_id` must be provided, and `task_id` only if a task was created. For client messages, both fields are optional, with the caveat that if both are provided, they have to match (the `context_id` has to be the one that is set on the task). If only `task_id` is provided, the server will infer `context_id` from it.", +"id": "LfA2aV1Message", +"properties": { +"contextId": { +"description": "Optional. The context id of the message. If set, the message will be associated with the given context.", +"type": "string" +}, +"extensions": { +"description": "The URIs of extensions that are present or contributed to this Message.", +"items": { +"type": "string" +}, +"type": "array" +}, +"messageId": { +"description": "Required. The unique identifier (e.g. UUID) of the message. This is created by the message creator.", +"type": "string" +}, +"metadata": { +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" +}, +"description": "Optional. Any metadata to provide along with the message.", +"type": "object" +}, +"parts": { +"description": "Required. Parts is the container of the message content.", +"items": { +"$ref": "LfA2aV1Part" +}, +"type": "array" +}, +"referenceTaskIds": { +"description": "A list of task IDs that this message references for additional context.", +"items": { +"type": "string" +}, +"type": "array" +}, +"role": { +"description": "Required. Identifies the sender of the message.", +"enum": [ +"ROLE_UNSPECIFIED", +"ROLE_USER", +"ROLE_AGENT" +], +"enumDescriptions": [ +"The role is unspecified.", +"The message is from the client to the server.", +"The message is from the server to the client." +], +"type": "string" +}, +"taskId": { +"description": "Optional. The task id of the message. If set, the message will be associated with the given task.", +"type": "string" +} +}, +"type": "object" +}, +"LfA2aV1Part": { +"description": "`Part` represents a container for a section of communication content. Parts can be purely textual, some sort of file (image, video, etc) or a structured data blob (i.e. JSON).", +"id": "LfA2aV1Part", +"properties": { +"data": { +"description": "Arbitrary structured `data` as a JSON value (object, array, string, number, boolean, or null).", +"type": "any" +}, +"filename": { +"description": "An optional `filename` for the file (e.g., \"document.pdf\").", +"type": "string" +}, +"mediaType": { +"description": "The `media_type` (MIME type) of the part content (e.g., \"text/plain\", \"application/json\", \"image/png\"). This field is available for all part types.", +"type": "string" +}, +"metadata": { +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" +}, +"description": "Optional. metadata associated with this part.", +"type": "object" +}, +"raw": { +"description": "The `raw` byte content of a file. In JSON serialization, this is encoded as a base64 string.", +"format": "byte", +"type": "string" +}, +"text": { +"description": "The string content of the `text` part.", +"type": "string" +}, +"url": { +"description": "A `url` pointing to the file's content.", +"type": "string" +} +}, +"type": "object" +}, +"LfA2aV1SendMessageConfiguration": { +"description": "Configuration of a send message request.", +"id": "LfA2aV1SendMessageConfiguration", +"properties": { +"acceptedOutputModes": { +"description": "A list of media types the client is prepared to accept for response parts. Agents SHOULD use this to tailor their output.", +"items": { +"type": "string" +}, +"type": "array" +}, +"historyLength": { +"description": "The maximum number of most recent messages from the task's history to retrieve in the response. An unset value means the client does not impose any limit. A value of zero is a request to not include any messages. The server MUST NOT return more messages than the provided value, but MAY apply a lower limit.", +"format": "int32", +"type": "integer" +}, +"returnImmediately": { +"description": "If `true`, the operation returns immediately after creating the task, even if processing is still in progress. If `false` (default), the operation MUST wait until the task reaches a terminal (`COMPLETED`, `FAILED`, `CANCELED`, `REJECTED`) or interrupted (`INPUT_REQUIRED`, `AUTH_REQUIRED`) state before returning.", +"type": "boolean" +}, +"taskPushNotificationConfig": { +"$ref": "LfA2aV1TaskPushNotificationConfig", +"description": "Configuration for the agent to send push notifications for task updates. Task id should be empty when sending this configuration in a `SendMessage` request." +} +}, +"type": "object" +}, +"LfA2aV1SendMessageRequest": { +"description": "Represents a request for the `SendMessage` method.", +"id": "LfA2aV1SendMessageRequest", +"properties": { +"configuration": { +"$ref": "LfA2aV1SendMessageConfiguration", +"description": "Configuration for the send request." +}, +"message": { +"$ref": "LfA2aV1Message", +"description": "Required. The message to send to the agent." +}, +"metadata": { +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" +}, +"description": "A flexible key-value map for passing additional context or parameters.", +"type": "object" +} +}, +"type": "object" +}, +"LfA2aV1SendMessageResponse": { +"description": "Represents the response for the `SendMessage` method.", +"id": "LfA2aV1SendMessageResponse", +"properties": { +"message": { +"$ref": "LfA2aV1Message", +"description": "A message from the agent." +}, +"task": { +"$ref": "LfA2aV1Task", +"description": "The task created or updated by the message." +} +}, +"type": "object" +}, +"LfA2aV1Task": { +"description": "`Task` is the core unit of action for A2A. It has a current status and when results are created for the task they are stored in the artifact. If there are multiple turns for a task, these are stored in history.", +"id": "LfA2aV1Task", +"properties": { +"artifacts": { +"description": "A set of output artifacts for a `Task`.", +"items": { +"$ref": "LfA2aV1Artifact" +}, +"type": "array" +}, +"contextId": { +"description": "Unique identifier (e.g. UUID) for the contextual collection of interactions (tasks and messages).", +"type": "string" +}, +"history": { +"description": "protolint:disable REPEATED_FIELD_NAMES_PLURALIZED The history of interactions from a `Task`.", +"items": { +"$ref": "LfA2aV1Message" +}, +"type": "array" +}, +"id": { +"description": "Required. Unique identifier (e.g. UUID) for the task, generated by the server for a new task.", +"type": "string" +}, +"metadata": { +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" +}, +"description": "protolint:enable REPEATED_FIELD_NAMES_PLURALIZED A key/value object to store custom metadata about a task.", +"type": "object" +}, +"status": { +"$ref": "LfA2aV1TaskStatus", +"description": "Required. The current status of a `Task`, including `state` and a `message`." +} +}, +"type": "object" +}, +"LfA2aV1TaskPushNotificationConfig": { +"description": "A container associating a push notification configuration with a specific task.", +"id": "LfA2aV1TaskPushNotificationConfig", +"properties": { +"authentication": { +"$ref": "LfA2aV1AuthenticationInfo", +"description": "Authentication information required to send the notification." +}, +"id": { +"description": "The push notification configuration details. A unique identifier (e.g. UUID) for this push notification configuration.", +"type": "string" +}, +"taskId": { +"description": "The ID of the task this configuration is associated with.", +"type": "string" +}, +"tenant": { +"description": "Optional. Tenant ID.", +"type": "string" +}, +"token": { +"description": "A token unique for this task or session.", +"type": "string" +}, +"url": { +"description": "Required. The URL where the notification should be sent.", +"type": "string" +} +}, +"type": "object" +}, +"LfA2aV1TaskStatus": { +"description": "A container for the status of a task", +"id": "LfA2aV1TaskStatus", +"properties": { +"message": { +"$ref": "LfA2aV1Message", +"description": "A message associated with the status." +}, +"state": { +"description": "Required. The current state of this task.", +"enum": [ +"TASK_STATE_UNSPECIFIED", +"TASK_STATE_SUBMITTED", +"TASK_STATE_WORKING", +"TASK_STATE_COMPLETED", +"TASK_STATE_FAILED", +"TASK_STATE_CANCELED", +"TASK_STATE_INPUT_REQUIRED", +"TASK_STATE_REJECTED", +"TASK_STATE_AUTH_REQUIRED" +], +"enumDescriptions": [ +"The task is in an unknown or indeterminate state.", +"Indicates that a task has been successfully submitted and acknowledged.", +"Indicates that a task is actively being processed by the agent.", +"Indicates that a task has finished successfully. This is a terminal state.", +"Indicates that a task has finished with an error. This is a terminal state.", +"Indicates that a task was canceled before completion. This is a terminal state.", +"Indicates that the agent requires additional user input to proceed. This is an interrupted state.", +"Indicates that the agent has decided to not perform the task. This may be done during initial task creation or later once an agent has determined it can't or won't proceed. This is a terminal state.", +"Indicates that authentication is required to proceed. This is an interrupted state." +], +"type": "string" +}, +"timestamp": { +"description": "ISO 8601 Timestamp when the status was recorded. Example: \"2023-10-27T10:00:00Z\"", +"format": "google-datetime", +"type": "string" +} +}, +"type": "object" +}, "ListAgentsResponse": { "description": "Response message for AgentService.ListAgents.", "id": "ListAgentsResponse", @@ -9877,11 +10261,11 @@ "properties": { "audioRecordingConfig": { "$ref": "AudioRecordingConfig", -"description": "Optional. Configuration for how audio interactions should be recorded." +"description": "Optional. Configuration for how audio interactions should be recorded. The audio is subject to redaction as configured in RedactionConfig." }, "bigqueryExportSettings": { "$ref": "BigQueryExportSettings", -"description": "Optional. Settings to describe the BigQuery export behaviors for the app. The conversation data will be exported to BigQuery tables if it is enabled." +"description": "Optional. Configures the BigQuery export behaviors for the app. The conversation data is subject to redaction as configured in RedactionConfig." }, "cloudLoggingSettings": { "$ref": "CloudLoggingSettings", @@ -9905,7 +10289,7 @@ }, "unredactedAudioRecordingConfig": { "$ref": "AudioRecordingConfig", -"description": "Optional. Configures recording of unredacted audio. Use this to maintain a raw backup with restricted access when audio redaction is enabled, typically for auditing or monitoring purposes." +"description": "Optional. Configures an additional recording of unredacted audio. This can be used to maintain a raw audio copy when audio redaction is enabled, typically for auditing or monitoring purposes." } }, "type": "object" @@ -9937,6 +10321,10 @@ "description": "Required. The name of the MCP tool.", "type": "string" }, +"nameOverride": { +"description": "Optional. The name override of the MCP tool. This is populated if the name was overridden by a Toolset override.", +"type": "string" +}, "outputSchema": { "$ref": "Schema", "description": "Optional. The schema of the output arguments of the MCP tool." @@ -9949,6 +10337,23 @@ "$ref": "ServiceDirectoryConfig", "description": "Optional. Service Directory configuration for VPC-SC, used to resolve service names within a perimeter." }, +"state": { +"description": "Output only. The dynamic availability state of the tool on the external server.", +"enum": [ +"STATE_UNSPECIFIED", +"ACTIVE", +"INACTIVE", +"STALE" +], +"enumDescriptions": [ +"Default state.", +"The tool is available and actively offered by the server.", +"The tool is configured or pinned, but currently not offered by the server.", +"The tool exists on the server, but does not match the version on the server." +], +"readOnly": true, +"type": "string" +}, "tlsConfig": { "$ref": "TlsConfig", "description": "Optional. The TLS configuration. Includes the custom server certificates that the client should trust." @@ -9956,6 +10361,52 @@ }, "type": "object" }, +"McpToolDefinition": { +"description": "Container for a tool's core definition elements that are snapshot. Schemas in the snapshot are used as-is and cannot be overridden.", +"id": "McpToolDefinition", +"properties": { +"description": { +"description": "Output only. The description of the MCP tool. This can be overridden by `description_override` in `McpToolOverride`.", +"readOnly": true, +"type": "string" +}, +"inputSchema": { +"$ref": "Schema", +"description": "Output only. The schema of the input arguments of the MCP tool.", +"readOnly": true +}, +"outputSchema": { +"$ref": "Schema", +"description": "Output only. The schema of the output arguments of the MCP tool.", +"readOnly": true +} +}, +"type": "object" +}, +"McpToolOverride": { +"description": "Overrides associated with a given tool in a Toolset. This enables \"pinning\" or \"overriding\" of tool definitions from the external dynamic server.", +"id": "McpToolOverride", +"properties": { +"descriptionOverride": { +"description": "Optional. If present, this tool uses this description instead of the original description from the server.", +"type": "string" +}, +"nameOverride": { +"description": "Optional. If present, this tool uses this name in the Agent instead of the original name. This is primarily used as an alias if the MCP server offers poorly named tools.", +"type": "string" +}, +"snapshot": { +"$ref": "McpToolDefinition", +"description": "Output only. If present, this tool is \"Pinned\" and uses the snapshot values as fallbacks if the server becomes temporarily unavailable or if no Override is present.", +"readOnly": true +}, +"tool": { +"description": "Required. The original name of the tool as it is emitted by the MCP server.", +"type": "string" +} +}, +"type": "object" +}, "McpToolset": { "description": "A toolset that contains a list of tools that are offered by the MCP server.", "id": "McpToolset", @@ -9982,6 +10433,13 @@ "tlsConfig": { "$ref": "TlsConfig", "description": "Optional. The TLS configuration. Includes the custom server certificates that the client should trust." +}, +"toolOverrides": { +"description": "Optional. Overrides for individual tools within this toolset. This allows overriding specific details like descriptions, names, or pinning the tools' states so they aren't fully dynamic.", +"items": { +"$ref": "McpToolOverride" +}, +"type": "array" } }, "type": "object" @@ -10400,6 +10858,10 @@ "pythonCode": { "description": "Optional. The Python code to execute for the tool.", "type": "string" +}, +"serviceDirectoryConfig": { +"$ref": "ServiceDirectoryConfig", +"description": "Optional. Service Directory configuration for the tool." } }, "type": "object" @@ -10556,6 +11018,10 @@ "description": "Request message for ToolService.RetrieveTools.", "id": "RetrieveToolsRequest", "properties": { +"bypassPersistenceConfig": { +"description": "Optional. If true, the returned tools will contain raw descriptions and schemas directly from the server, bypassing any stored persistence configurations (overrides/snapshots).", +"type": "boolean" +}, "toolIds": { "description": "Optional. The identifiers of the tools to retrieve from the toolset. If empty, all tools in the toolset will be returned.", "items": { diff --git a/googleapiclient/discovery_cache/documents/chromemanagement.v1.json b/googleapiclient/discovery_cache/documents/chromemanagement.v1.json index f749886b89..5bdb8226bc 100644 --- a/googleapiclient/discovery_cache/documents/chromemanagement.v1.json +++ b/googleapiclient/discovery_cache/documents/chromemanagement.v1.json @@ -646,6 +646,86 @@ } } }, +"enterprise": { +"resources": { +"securityInsights": { +"methods": { +"checkEnablementStatus": { +"description": "Gets the setting state of the insights feature for the customer.", +"flatPath": "v1/customers/{customersId}/enterprise/securityInsights:checkEnablementStatus", +"httpMethod": "GET", +"id": "chromemanagement.customers.enterprise.securityInsights.checkEnablementStatus", +"parameterOrder": [ +"customer" +], +"parameters": { +"customer": { +"description": "Required. The customer to check the enablement status for. Format: customers/{customer_id}", +"location": "path", +"pattern": "^customers/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+customer}/enterprise/securityInsights:checkEnablementStatus", +"response": { +"$ref": "GoogleChromeManagementVersionsV1CheckEnablementStatusResponse" +} +}, +"disable": { +"description": "Disables insights for the customer.", +"flatPath": "v1/customers/{customersId}/enterprise/securityInsights:disable", +"httpMethod": "POST", +"id": "chromemanagement.customers.enterprise.securityInsights.disable", +"parameterOrder": [ +"customer" +], +"parameters": { +"customer": { +"description": "Required. The customer to disable insights for. Format: customers/{customer}", +"location": "path", +"pattern": "^customers/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+customer}/enterprise/securityInsights:disable", +"request": { +"$ref": "GoogleChromeManagementVersionsV1DisableInsightsRequest" +}, +"response": { +"$ref": "GoogleChromeManagementVersionsV1DisableInsightsResponse" +} +}, +"enable": { +"description": "Enables insights for the customer and sets up required chrome connectors.", +"flatPath": "v1/customers/{customersId}/enterprise/securityInsights:enable", +"httpMethod": "POST", +"id": "chromemanagement.customers.enterprise.securityInsights.enable", +"parameterOrder": [ +"customer" +], +"parameters": { +"customer": { +"description": "Required. The customer to enable insights for. Format: customers/{customer}", +"location": "path", +"pattern": "^customers/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+customer}/enterprise/securityInsights:enable", +"request": { +"$ref": "GoogleChromeManagementVersionsV1EnableInsightsRequest" +}, +"response": { +"$ref": "GoogleChromeManagementVersionsV1EnableInsightsResponse" +} +} +} +} +} +}, "profiles": { "methods": { "delete": { @@ -1072,6 +1152,52 @@ "https://www.googleapis.com/auth/chrome.management.reports.readonly" ] }, +"countChromeProfileVersions": { +"description": "Generate report of installed Chrome versions on managed profiles.", +"flatPath": "v1/customers/{customersId}/reports:countChromeProfileVersions", +"httpMethod": "GET", +"id": "chromemanagement.customers.reports.countChromeProfileVersions", +"parameterOrder": [ +"customer" +], +"parameters": { +"customer": { +"description": "Required. Customer id or \"my_customer\" to use the customer associated to the account making the request.", +"location": "path", +"pattern": "^customers/[^/]+$", +"required": true, +"type": "string" +}, +"filter": { +"description": "Optional. Query string to filter results, AND-separated fields in EBNF syntax. Note: OR operations are not supported in this filter. Supported filter fields: * last_active_date", +"location": "query", +"type": "string" +}, +"orgUnitId": { +"description": "The ID of the organizational unit. If omitted, all data will be returned.", +"location": "query", +"type": "string" +}, +"pageSize": { +"description": "Optional. Maximum number of results to return. Maximum and default are 100.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "Optional. Token to specify the page of the request to be returned.", +"location": "query", +"type": "string" +} +}, +"path": "v1/{+customer}/reports:countChromeProfileVersions", +"response": { +"$ref": "GoogleChromeManagementV1CountChromeProfileVersionsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/chrome.management.reports.readonly" +] +}, "countChromeVersions": { "description": "Generate report of installed Chrome versions.", "flatPath": "v1/customers/{customersId}/reports:countChromeVersions", @@ -2005,7 +2131,7 @@ } } }, -"revision": "20260505", +"revision": "20260528", "rootUrl": "https://chromemanagement.googleapis.com/", "schemas": { "GoogleChromeManagementV1AndroidAppInfo": { @@ -2908,6 +3034,29 @@ false }, "type": "object" }, +"GoogleChromeManagementV1CountChromeProfileVersionsResponse": { +"description": "Response containing requested managed profile versions details and counts.", +"id": "GoogleChromeManagementV1CountChromeProfileVersionsResponse", +"properties": { +"nextPageToken": { +"description": "Token to specify the next page of the request.", +"type": "string" +}, +"profileBrowserVersions": { +"description": "List of all browser versions reported for profiles and their install counts.", +"items": { +"$ref": "GoogleChromeManagementV1BrowserVersion" +}, +"type": "array" +}, +"totalSize": { +"description": "Total number browser versions matching request.", +"format": "int32", +"type": "integer" +} +}, +"type": "object" +}, "GoogleChromeManagementV1CountChromeVersionsResponse": { "description": "Response containing requested browser versions details and counts.", "id": "GoogleChromeManagementV1CountChromeVersionsResponse", @@ -6144,6 +6293,27 @@ false }, "type": "object" }, +"GoogleChromeManagementVersionsV1CheckEnablementStatusResponse": { +"description": "Response from checking the enablement status of insights for the customer.", +"id": "GoogleChromeManagementVersionsV1CheckEnablementStatusResponse", +"properties": { +"insightsState": { +"description": "The state of the insights feature.", +"enum": [ +"INSIGHTS_ENABLEMENT_STATE_UNSPECIFIED", +"INSIGHTS_ENABLED", +"INSIGHTS_DISABLED" +], +"enumDescriptions": [ +"Default value. Should not be used.", +"The insights feature is enabled for the customer.", +"The insights feature is disabled for the customer." +], +"type": "string" +} +}, +"type": "object" +}, "GoogleChromeManagementVersionsV1ChromeBrowserProfile": { "description": "A representation of a Chrome browser profile.", "id": "GoogleChromeManagementVersionsV1ChromeBrowserProfile", @@ -6748,6 +6918,68 @@ false }, "type": "object" }, +"GoogleChromeManagementVersionsV1DisableInsightsRequest": { +"description": "Request to disable insights for the customer.", +"id": "GoogleChromeManagementVersionsV1DisableInsightsRequest", +"properties": {}, +"type": "object" +}, +"GoogleChromeManagementVersionsV1DisableInsightsResponse": { +"description": "Response from disabling insights for the customer.", +"id": "GoogleChromeManagementVersionsV1DisableInsightsResponse", +"properties": { +"insightsState": { +"description": "The state of the insights feature.", +"enum": [ +"INSIGHTS_ENABLEMENT_STATE_UNSPECIFIED", +"INSIGHTS_ENABLED", +"INSIGHTS_DISABLED" +], +"enumDescriptions": [ +"Default value. Should not be used.", +"The insights feature is enabled for the customer.", +"The insights feature is disabled for the customer." +], +"type": "string" +} +}, +"type": "object" +}, +"GoogleChromeManagementVersionsV1EnableInsightsRequest": { +"description": "Request to enable insights for the customer.", +"id": "GoogleChromeManagementVersionsV1EnableInsightsRequest", +"properties": { +"targetOus": { +"description": "Optional. The Organizational Units to set up required connectors for. Organizational Units are provided as paths relative to root. If this field is not set, connectors will be set up at root OU (as if it were set to [\"/\"]). Example: [\"/corp/sales\", \"/eng\"]", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleChromeManagementVersionsV1EnableInsightsResponse": { +"description": "Response from enabling insights for the customer.", +"id": "GoogleChromeManagementVersionsV1EnableInsightsResponse", +"properties": { +"insightsState": { +"description": "The state of the insights feature.", +"enum": [ +"INSIGHTS_ENABLEMENT_STATE_UNSPECIFIED", +"INSIGHTS_ENABLED", +"INSIGHTS_DISABLED" +], +"enumDescriptions": [ +"Default value. Should not be used.", +"The insights feature is enabled for the customer.", +"The insights feature is disabled for the customer." +], +"type": "string" +} +}, +"type": "object" +}, "GoogleChromeManagementVersionsV1GenericCaConnection": { "description": "Describes a generic Certificate Authority Connection.", "id": "GoogleChromeManagementVersionsV1GenericCaConnection", diff --git a/googleapiclient/discovery_cache/documents/chromewebstore.v2.json b/googleapiclient/discovery_cache/documents/chromewebstore.v2.json index 4f6a04793c..cce971fbe6 100644 --- a/googleapiclient/discovery_cache/documents/chromewebstore.v2.json +++ b/googleapiclient/discovery_cache/documents/chromewebstore.v2.json @@ -272,7 +272,7 @@ } } }, -"revision": "20251026", +"revision": "20260517", "rootUrl": "https://chromewebstore.googleapis.com/", "schemas": { "CancelSubmissionRequest": { @@ -412,6 +412,10 @@ "description": "Request message for PublishItem.", "id": "PublishItemRequest", "properties": { +"blockOnWarnings": { +"description": "Optional. When set to true the request will fail if there are any warnings during validation and the details will be included in the error_details. Otherwise warnings are treated as non-blocking and will be ignored for validation but will be included in the response for inspection. Defaults to `false` if unset.", +"type": "boolean" +}, "deployInfos": { "description": "Optional. Additional deploy information including the desired initial percentage rollout. Defaults to the current value saved in the developer dashboard if unset.", "items": { @@ -475,6 +479,11 @@ ], "readOnly": true, "type": "string" +}, +"warningInfo": { +"$ref": "WarningsInfo", +"description": "Output only. Non-blocking warnings encountered during the request.", +"readOnly": true } }, "type": "object" @@ -541,6 +550,35 @@ } }, "type": "object" +}, +"Warning": { +"description": "Represents a single warning encountered during the request.", +"id": "Warning", +"properties": { +"description": { +"description": "A description of the warning. Developers should use this message to understand the warning and take appropriate action to resolve the issue.", +"type": "string" +}, +"reason": { +"description": "The reason for the warning. This is a constant value that identifies the proximate cause of the warning. This should be at most 63 characters and match a regular expression of `A-Z+[A-Z0-9]`, which represents UPPER_SNAKE_CASE.", +"type": "string" +} +}, +"type": "object" +}, +"WarningsInfo": { +"description": "Message containing details on warnings encountered during PublishItem.", +"id": "WarningsInfo", +"properties": { +"warnings": { +"description": "All warnings encountered during the request.", +"items": { +"$ref": "Warning" +}, +"type": "array" +} +}, +"type": "object" } }, "servicePath": "", diff --git a/googleapiclient/discovery_cache/documents/cloudbuild.v1.json b/googleapiclient/discovery_cache/documents/cloudbuild.v1.json index 1489026590..92251aede7 100644 --- a/googleapiclient/discovery_cache/documents/cloudbuild.v1.json +++ b/googleapiclient/discovery_cache/documents/cloudbuild.v1.json @@ -2583,7 +2583,7 @@ } } }, -"revision": "20260323", +"revision": "20260511", "rootUrl": "https://cloudbuild.googleapis.com/", "schemas": { "ApprovalConfig": { @@ -3520,6 +3520,13 @@ false "description": "Output only. Stores timing information for pulling this build step's builder image only.", "readOnly": true }, +"results": { +"description": "Declaration of results for this build step.", +"items": { +"$ref": "StepResult" +}, +"type": "array" +}, "script": { "description": "A shell script to be executed in the step. When script is provided, the user cannot specify the entrypoint or args.", "type": "string" @@ -3587,6 +3594,20 @@ false }, "type": "object" }, +"BuildStepResults": { +"description": "Results for a build step.", +"id": "BuildStepResults", +"properties": { +"results": { +"additionalProperties": { +"type": "string" +}, +"description": "Results for a build step.", +"type": "object" +} +}, +"type": "object" +}, "BuildTrigger": { "description": "Configuration for an automated build in response to source repository changes.", "id": "BuildTrigger", @@ -5419,6 +5440,13 @@ false }, "type": "array" }, +"buildStepResults": { +"additionalProperties": { +"$ref": "BuildStepResults" +}, +"description": "Results for build steps. step_id -> ", +"type": "object" +}, "genericArtifacts": { "description": "Output only. Generic artifacts uploaded to Artifact Registry at the end of the build.", "items": { @@ -5669,6 +5697,25 @@ false }, "type": "object" }, +"StepResult": { +"description": "StepResult is the declaration of a result for a build step.", +"id": "StepResult", +"properties": { +"attestationContent": { +"description": "Optional. The content of the attestation to be generated.", +"type": "string" +}, +"attestationType": { +"description": "Optional. The type of attestation to be generated.", +"type": "string" +}, +"name": { +"description": "Required. The name of the result.", +"type": "string" +} +}, +"type": "object" +}, "StorageSource": { "description": "Location of the source in an archive file in Cloud Storage.", "id": "StorageSource", diff --git a/googleapiclient/discovery_cache/documents/cloudbuild.v2.json b/googleapiclient/discovery_cache/documents/cloudbuild.v2.json index 5006c366be..a7661eb776 100644 --- a/googleapiclient/discovery_cache/documents/cloudbuild.v2.json +++ b/googleapiclient/discovery_cache/documents/cloudbuild.v2.json @@ -372,7 +372,7 @@ ] }, "list": { -"description": "Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the [ListLocationsRequest.name] field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.", +"description": "Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the ListLocationsRequest.name field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.", "flatPath": "v2/projects/{projectsId}/locations", "httpMethod": "GET", "id": "cloudbuild.projects.locations.list", @@ -381,7 +381,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. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -1097,7 +1097,7 @@ } } }, -"revision": "20260323", +"revision": "20260511", "rootUrl": "https://cloudbuild.googleapis.com/", "schemas": { "AuditConfig": { diff --git a/googleapiclient/discovery_cache/documents/clouddeploy.v1.json b/googleapiclient/discovery_cache/documents/clouddeploy.v1.json index 5c711aa7d9..f61bff4fd2 100644 --- a/googleapiclient/discovery_cache/documents/clouddeploy.v1.json +++ b/googleapiclient/discovery_cache/documents/clouddeploy.v1.json @@ -15,6 +15,73 @@ "description": "", "discoveryVersion": "v1", "documentationLink": "https://cloud.google.com/deploy/", +"endpoints": [ +{ +"description": "Regional Endpoint", +"endpointUrl": "https://clouddeploy.asia-south1.rep.googleapis.com/", +"location": "asia-south1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://clouddeploy.asia-south2.rep.googleapis.com/", +"location": "asia-south2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://clouddeploy.us-central1.rep.googleapis.com/", +"location": "us-central1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://clouddeploy.us-central2.rep.googleapis.com/", +"location": "us-central2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://clouddeploy.us-east1.rep.googleapis.com/", +"location": "us-east1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://clouddeploy.us-east4.rep.googleapis.com/", +"location": "us-east4" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://clouddeploy.us-east5.rep.googleapis.com/", +"location": "us-east5" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://clouddeploy.us-east7.rep.googleapis.com/", +"location": "us-east7" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://clouddeploy.us-south1.rep.googleapis.com/", +"location": "us-south1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://clouddeploy.us-west1.rep.googleapis.com/", +"location": "us-west1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://clouddeploy.us-west2.rep.googleapis.com/", +"location": "us-west2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://clouddeploy.us-west3.rep.googleapis.com/", +"location": "us-west3" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://clouddeploy.us-west4.rep.googleapis.com/", +"location": "us-west4" +} +], "fullyEncodeReservedExpansion": true, "icons": { "x16": "http://www.google.com/images/icons/product/search-16.gif", @@ -2359,7 +2426,7 @@ } } }, -"revision": "20260427", +"revision": "20260525", "rootUrl": "https://clouddeploy.googleapis.com/", "schemas": { "AbandonReleaseRequest": { @@ -3439,10 +3506,6 @@ true "image": { "description": "Required. Image is the container image to use.", "type": "string" -}, -"script": { -"description": "Optional. Shell script to execute. If provided then command and args cannot be specified.", -"type": "string" } }, "type": "object" @@ -3826,7 +3889,7 @@ true "additionalProperties": { "type": "string" }, -"description": "Labels are attributes that can be set and used by both the user and by Cloud Deploy. Labels must meet the following constraints: * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. * All characters must use UTF-8 encoding, and international characters are allowed. * Keys must start with a lowercase letter or international character. * Each resource is limited to a maximum of 64 labels. Both keys and values are additionally constrained to be <= 128 bytes.", +"description": "Optional. Labels are attributes that can be set and used by both the user and by Cloud Deploy. Labels must meet the following constraints: * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. * All characters must use UTF-8 encoding, and international characters are allowed. * Keys must start with a lowercase letter or international character. * Each resource is limited to a maximum of 64 labels. Both keys and values are additionally constrained to be <= 128 bytes.", "type": "object" }, "name": { @@ -5828,7 +5891,7 @@ true "additionalProperties": { "type": "string" }, -"description": "Labels are attributes that can be set and used by both the user and by Cloud Deploy. Labels must meet the following constraints: * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. * All characters must use UTF-8 encoding, and international characters are allowed. * Keys must start with a lowercase letter or international character. * Each resource is limited to a maximum of 64 labels. Both keys and values are additionally constrained to be <= 128 bytes.", +"description": "Optional. Labels are attributes that can be set and used by both the user and by Cloud Deploy. Labels must meet the following constraints: * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. * All characters must use UTF-8 encoding, and international characters are allowed. * Keys must start with a lowercase letter or international character. * Each resource is limited to a maximum of 64 labels. Both keys and values are additionally constrained to be <= 128 bytes.", "type": "object" }, "name": { diff --git a/googleapiclient/discovery_cache/documents/cloudidentity.v1.json b/googleapiclient/discovery_cache/documents/cloudidentity.v1.json index 26fcedc5dc..7e267d4f5d 100644 --- a/googleapiclient/discovery_cache/documents/cloudidentity.v1.json +++ b/googleapiclient/discovery_cache/documents/cloudidentity.v1.json @@ -2255,7 +2255,7 @@ "parameterOrder": [], "parameters": { "filter": { -"description": "Optional. A CEL expression for filtering the results. Policies can be filtered by application with this expression: setting.type.matches('^settings/gmail\\\\..*$') Policies can be filtered by setting type with this expression: setting.type.matches('^.*\\\\.service_status$') A maximum of one of the above setting.type clauses can be used. Policies can be filtered by customer with this expression: customer == \"customers/{customer}\" Where `customer` is the `id` from the [Admin SDK `Customer` resource](https://developers.google.com/admin-sdk/directory/reference/rest/v1/customers). You may use `customers/my_customer` to specify your own organization. When no customer is mentioned it will be default to customers/my_customer. A maximum of one customer clause can be used. The above clauses can only be combined together in a single filter expression with the `&&` operator.", +"description": "Optional. A CEL expression for filtering the results. Policies can be filtered by application with this expression: setting.type.matches('^settings/gmail\\\\..*$') Policies can be filtered by setting type with this expression: setting.type.matches('^.*\\\\.service_status$') Policies can be filtered by customer with this expression: customer == \"customers/{customer}\" Where `customer` is the `id` from the [Admin SDK `Customer` resource](https://developers.google.com/admin-sdk/directory/reference/rest/v1/customers). You may use `customers/my_customer` to specify your own organization. When no customer is mentioned it will be default to customers/my_customer. You may only filter on policies for a single customer at a time. The above clauses can be combined together in a single filter expression with the `&&` and `||` operators, like in the following example: customer == \"customers/my_customer\" && ( setting.type.matches('^settings/gmail\\\\..*$') || setting.type.matches('^.*\\\\.service_status$') )", "location": "query", "type": "string" }, @@ -2311,7 +2311,7 @@ } } }, -"revision": "20260513", +"revision": "20260524", "rootUrl": "https://cloudidentity.googleapis.com/", "schemas": { "AddIdpCredentialOperationMetadata": { @@ -4444,7 +4444,7 @@ "type": "string" }, "query": { -"description": "Immutable. The CEL query that defines which entities the Policy applies to (ex. a User entity). For details about CEL see https://opensource.google.com/projects/cel. The OrgUnits the Policy applies to are represented by a clause like so: entity.org_units.exists(org_unit, org_unit.org_unit_id == orgUnitId('{orgUnitId}')) The Group the Policy applies to are represented by a clause like so: entity.groups.exists(group, group.group_id == groupId('{groupId}')) The Licenses the Policy applies to are represented by a clause like so: entity.licenses.exists(license, license in ['/product/{productId}/sku/{skuId}']) The above clauses can be present in any combination, and used in conjunction with the &&, || and ! operators. The org_unit and group fields below are helper fields that contain the corresponding value(s) as the query to make the query easier to use.", +"description": "Immutable. The CEL query that defines which entities the Policy applies to (ex. a User entity). For details about CEL see https://opensource.google.com/projects/cel. The OrgUnits the Policy applies to are represented by a clause like so: entity.org_units.exists(org_unit, org_unit.org_unit_id == orgUnitId('{orgUnitId}')) The Group the Policy applies to are represented by a clause like so: entity.groups.exists(group, group.group_id == groupId('{groupId}')) The Licenses the Policy applies to are represented by a clause like so: entity.licenses.exists(license, license in ['/product/{productId}/sku/{skuId}']) **Note:** The licenses clause is not supported in mutate endpoints. The above clauses can be present in any combination, and used in conjunction with the &&, || and ! operators. The org_unit and group fields below are helper fields that contain the corresponding value(s) as the query to make the query easier to use.", "type": "string" }, "sortOrder": { diff --git a/googleapiclient/discovery_cache/documents/cloudidentity.v1beta1.json b/googleapiclient/discovery_cache/documents/cloudidentity.v1beta1.json index e55489cdb3..d0cd20a030 100644 --- a/googleapiclient/discovery_cache/documents/cloudidentity.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/cloudidentity.v1beta1.json @@ -2293,7 +2293,7 @@ "parameterOrder": [], "parameters": { "filter": { -"description": "Optional. A CEL expression for filtering the results. Policies can be filtered by application with this expression: setting.type.matches('^settings/gmail\\\\..*$') Policies can be filtered by setting type with this expression: setting.type.matches('^.*\\\\.service_status$') A maximum of one of the above setting.type clauses can be used. Policies can be filtered by customer with this expression: customer == \"customers/{customer}\" Where `customer` is the `id` from the [Admin SDK `Customer` resource](https://developers.google.com/admin-sdk/directory/reference/rest/v1/customers). You may use `customers/my_customer` to specify your own organization. When no customer is mentioned it will be default to customers/my_customer. A maximum of one customer clause can be used. The above clauses can only be combined together in a single filter expression with the `&&` operator.", +"description": "Optional. A CEL expression for filtering the results. Policies can be filtered by application with this expression: setting.type.matches('^settings/gmail\\\\..*$') Policies can be filtered by setting type with this expression: setting.type.matches('^.*\\\\.service_status$') Policies can be filtered by customer with this expression: customer == \"customers/{customer}\" Where `customer` is the `id` from the [Admin SDK `Customer` resource](https://developers.google.com/admin-sdk/directory/reference/rest/v1/customers). You may use `customers/my_customer` to specify your own organization. When no customer is mentioned it will be default to customers/my_customer. You may only filter on policies for a single customer at a time. The above clauses can be combined together in a single filter expression with the `&&` and `||` operators, like in the following example: customer == \"customers/my_customer\" && ( setting.type.matches('^settings/gmail\\\\..*$') || setting.type.matches('^.*\\\\.service_status$') )", "location": "query", "type": "string" }, @@ -2349,7 +2349,7 @@ } } }, -"revision": "20260506", +"revision": "20260524", "rootUrl": "https://cloudidentity.googleapis.com/", "schemas": { "AddIdpCredentialOperationMetadata": { @@ -5539,7 +5539,7 @@ "type": "string" }, "query": { -"description": "Immutable. The CEL query that defines which entities the Policy applies to (ex. a User entity). For details about CEL see https://opensource.google.com/projects/cel. The OrgUnits the Policy applies to are represented by a clause like so: entity.org_units.exists(org_unit, org_unit.org_unit_id == orgUnitId('{orgUnitId}')) The Group the Policy applies to are represented by a clause like so: entity.groups.exists(group, group.group_id == groupId('{groupId}')) The Licenses the Policy applies to are represented by a clause like so: entity.licenses.exists(license, license in ['/product/{productId}/sku/{skuId}']) The above clauses can be present in any combination, and used in conjunction with the &&, || and ! operators. The org_unit and group fields below are helper fields that contain the corresponding value(s) as the query to make the query easier to use.", +"description": "Immutable. The CEL query that defines which entities the Policy applies to (ex. a User entity). For details about CEL see https://opensource.google.com/projects/cel. The OrgUnits the Policy applies to are represented by a clause like so: entity.org_units.exists(org_unit, org_unit.org_unit_id == orgUnitId('{orgUnitId}')) The Group the Policy applies to are represented by a clause like so: entity.groups.exists(group, group.group_id == groupId('{groupId}')) The Licenses the Policy applies to are represented by a clause like so: entity.licenses.exists(license, license in ['/product/{productId}/sku/{skuId}']) **Note:** The licenses clause is not supported in mutate endpoints. The above clauses can be present in any combination, and used in conjunction with the &&, || and ! operators. The org_unit and group fields below are helper fields that contain the corresponding value(s) as the query to make the query easier to use.", "type": "string" }, "sortOrder": { diff --git a/googleapiclient/discovery_cache/documents/cloudkms.v1.json b/googleapiclient/discovery_cache/documents/cloudkms.v1.json index 2023312c62..ad8b47fef7 100644 --- a/googleapiclient/discovery_cache/documents/cloudkms.v1.json +++ b/googleapiclient/discovery_cache/documents/cloudkms.v1.json @@ -26,36 +26,6 @@ }, { "description": "Regional Endpoint", -"endpointUrl": "https://cloudkms.europe-west9.rep.googleapis.com/", -"location": "europe-west9" -}, -{ -"description": "Regional Endpoint", -"endpointUrl": "https://cloudkms.me-central2.rep.googleapis.com/", -"location": "me-central2" -}, -{ -"description": "Regional Endpoint", -"endpointUrl": "https://cloudkms.us-east1.rep.googleapis.com/", -"location": "us-east1" -}, -{ -"description": "Regional Endpoint", -"endpointUrl": "https://cloudkms.us-east4.rep.googleapis.com/", -"location": "us-east4" -}, -{ -"description": "Regional Endpoint", -"endpointUrl": "https://cloudkms.us-west2.rep.googleapis.com/", -"location": "us-west2" -}, -{ -"description": "Regional Endpoint", -"endpointUrl": "https://cloudkms.us-west1.rep.googleapis.com/", -"location": "us-west1" -}, -{ -"description": "Regional Endpoint", "endpointUrl": "https://cloudkms.us-central1.rep.googleapis.com/", "location": "us-central1" }, @@ -86,6 +56,16 @@ }, { "description": "Regional Endpoint", +"endpointUrl": "https://cloudkms.us-east4.rep.googleapis.com/", +"location": "us-east4" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://cloudkms.us-west2.rep.googleapis.com/", +"location": "us-west2" +}, +{ +"description": "Regional Endpoint", "endpointUrl": "https://cloudkms.us-east7.rep.googleapis.com/", "location": "us-east7" }, @@ -101,6 +81,26 @@ }, { "description": "Regional Endpoint", +"endpointUrl": "https://cloudkms.europe-west9.rep.googleapis.com/", +"location": "europe-west9" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://cloudkms.me-central2.rep.googleapis.com/", +"location": "me-central2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://cloudkms.us-east1.rep.googleapis.com/", +"location": "us-east1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://cloudkms.us-west1.rep.googleapis.com/", +"location": "us-west1" +}, +{ +"description": "Regional Endpoint", "endpointUrl": "https://cloudkms.northamerica-northeast1.rep.googleapis.com/", "location": "northamerica-northeast1" }, @@ -227,7 +227,7 @@ ], "parameters": { "name": { -"description": "Required. Name of the AutokeyConfig resource, e.g. `folders/{FOLDER_NUMBER}/autokeyConfig` or `projects/{PROJECT_NUMBER}/autokeyConfig`.", +"description": "Required. Name of the AutokeyConfig resource, e.g. `folders/{FOLDER_NUMBER}/autokeyConfig`, `projects/{PROJECT_NUMBER}/autokeyConfig`, or `projects/{PROJECT_ID}/autokeyConfig`.", "location": "path", "pattern": "^folders/[^/]+/autokeyConfig$", "required": true, @@ -279,7 +279,7 @@ ], "parameters": { "name": { -"description": "Identifier. Name of the AutokeyConfig resource, e.g. `folders/{FOLDER_NUMBER}/autokeyConfig` or `projects/{PROJECT_NUMBER}/autokeyConfig`.", +"description": "Identifier. Name of the AutokeyConfig resource, e.g. `folders/{FOLDER_NUMBER}/autokeyConfig`, `projects/{PROJECT_NUMBER}/autokeyConfig`, or `projects/{PROJECT_ID}/autokeyConfig`.", "location": "path", "pattern": "^folders/[^/]+/autokeyConfig$", "required": true, @@ -418,7 +418,7 @@ ], "parameters": { "name": { -"description": "Required. Name of the AutokeyConfig resource, e.g. `folders/{FOLDER_NUMBER}/autokeyConfig` or `projects/{PROJECT_NUMBER}/autokeyConfig`.", +"description": "Required. Name of the AutokeyConfig resource, e.g. `folders/{FOLDER_NUMBER}/autokeyConfig`, `projects/{PROJECT_NUMBER}/autokeyConfig`, or `projects/{PROJECT_ID}/autokeyConfig`.", "location": "path", "pattern": "^projects/[^/]+/autokeyConfig$", "required": true, @@ -548,7 +548,7 @@ ], "parameters": { "name": { -"description": "Identifier. Name of the AutokeyConfig resource, e.g. `folders/{FOLDER_NUMBER}/autokeyConfig` or `projects/{PROJECT_NUMBER}/autokeyConfig`.", +"description": "Identifier. Name of the AutokeyConfig resource, e.g. `folders/{FOLDER_NUMBER}/autokeyConfig`, `projects/{PROJECT_NUMBER}/autokeyConfig`, or `projects/{PROJECT_ID}/autokeyConfig`.", "location": "path", "pattern": "^projects/[^/]+/autokeyConfig$", "required": true, @@ -2376,6 +2376,25 @@ "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/importJobs/[^/]+$", "required": true, "type": "string" +}, +"publicKeyFormat": { +"description": "Optional. Specifies the WrappingPublicKey format. If not specified: * For RSA-based import methods, the wrapping key will be returned in PEM format * For pure ML-KEM-based import methods, the wrapping key will be returned in the raw bytes format specified in FIPS-203 * For X-Wing-based import methods, the wrapping key will be returned in the raw bytes format specified in https://datatracker.ietf.org/doc/draft-connolly-cfrg-xwing-kem.", +"enum": [ +"PUBLIC_KEY_FORMAT_UNSPECIFIED", +"PEM", +"DER", +"NIST_PQC", +"XWING_RAW_BYTES" +], +"enumDescriptions": [ +"If the public_key_format field is not specified: - For PQC algorithms, an error will be returned. - For non-PQC algorithms, the default format is PEM, and the field pem will be populated. Otherwise, the public key will be exported through the public_key field in the requested format.", +"The returned public key will be encoded in PEM format. See the [RFC7468](https://tools.ietf.org/html/rfc7468) sections for [General Considerations](https://tools.ietf.org/html/rfc7468#section-2) and [Textual Encoding of Subject Public Key Info] (https://tools.ietf.org/html/rfc7468#section-13) for more information.", +"The returned public key will be encoded in DER format (the PrivateKeyInfo structure from RFC 5208).", +"This is supported only for PQC algorithms. The key material is returned in the format defined by NIST PQC standards (FIPS 203, FIPS 204, and FIPS 205).", +"The returned public key is in raw bytes format defined in its standard https://datatracker.ietf.org/doc/draft-connolly-cfrg-xwing-kem." +], +"location": "query", +"type": "string" } }, "path": "v1/{+name}", @@ -2948,7 +2967,7 @@ } } }, -"revision": "20260506", +"revision": "20260522", "rootUrl": "https://cloudkms.googleapis.com/", "schemas": { "AddQuorumMember": { @@ -3193,7 +3212,7 @@ "type": "string" }, "name": { -"description": "Identifier. Name of the AutokeyConfig resource, e.g. `folders/{FOLDER_NUMBER}/autokeyConfig` or `projects/{PROJECT_NUMBER}/autokeyConfig`.", +"description": "Identifier. Name of the AutokeyConfig resource, e.g. `folders/{FOLDER_NUMBER}/autokeyConfig`, `projects/{PROJECT_NUMBER}/autokeyConfig`, or `projects/{PROJECT_ID}/autokeyConfig`.", "type": "string" }, "state": { @@ -3202,13 +3221,22 @@ "STATE_UNSPECIFIED", "ACTIVE", "KEY_PROJECT_DELETED", -"UNINITIALIZED" +"UNINITIALIZED", +"KEY_PROJECT_PERMISSION_DENIED" +], +"enumDeprecated": [ +false, +false, +false, +false, +true ], "enumDescriptions": [ "The state of the AutokeyConfig is unspecified.", "The AutokeyConfig is currently active.", "A previously configured key project has been deleted and the current AutokeyConfig is unusable.", -"The AutokeyConfig is not yet initialized or has been reset to its default uninitialized state." +"The AutokeyConfig is not yet initialized or has been reset to its default uninitialized state.", +"Deprecated: This state is not returned by the backend." ], "readOnly": true, "type": "string" @@ -4408,7 +4436,10 @@ "RSA_OAEP_3072_SHA256_AES_256", "RSA_OAEP_4096_SHA256_AES_256", "RSA_OAEP_3072_SHA256", -"RSA_OAEP_4096_SHA256" +"RSA_OAEP_4096_SHA256", +"HPKE_KEM_ML_KEM_768_HKDF_SHA256_AES_256_GCM", +"HPKE_KEM_ML_KEM_1024_HKDF_SHA256_AES_256_GCM", +"HPKE_KEM_XWING_HKDF_SHA256_AES_256_GCM" ], "enumDescriptions": [ "Not specified.", @@ -4417,7 +4448,10 @@ "This ImportMethod represents the CKM_RSA_AES_KEY_WRAP key wrapping scheme defined in the PKCS #11 standard. In summary, this involves wrapping the raw key with an ephemeral AES key, and wrapping the ephemeral AES key with a 3072 bit RSA key. For more details, see [RSA AES key wrap mechanism](http://docs.oasis-open.org/pkcs11/pkcs11-curr/v2.40/cos01/pkcs11-curr-v2.40-cos01.html#_Toc408226908).", "This ImportMethod represents the CKM_RSA_AES_KEY_WRAP key wrapping scheme defined in the PKCS #11 standard. In summary, this involves wrapping the raw key with an ephemeral AES key, and wrapping the ephemeral AES key with a 4096 bit RSA key. For more details, see [RSA AES key wrap mechanism](http://docs.oasis-open.org/pkcs11/pkcs11-curr/v2.40/cos01/pkcs11-curr-v2.40-cos01.html#_Toc408226908).", "This ImportMethod represents RSAES-OAEP with a 3072 bit RSA key. The key material to be imported is wrapped directly with the RSA key. Due to technical limitations of RSA wrapping, this method cannot be used to wrap RSA keys for import.", -"This ImportMethod represents RSAES-OAEP with a 4096 bit RSA key. The key material to be imported is wrapped directly with the RSA key. Due to technical limitations of RSA wrapping, this method cannot be used to wrap RSA keys for import." +"This ImportMethod represents RSAES-OAEP with a 4096 bit RSA key. The key material to be imported is wrapped directly with the RSA key. Due to technical limitations of RSA wrapping, this method cannot be used to wrap RSA keys for import.", +"Represents the Hybrid Public Key Encryption (HPKE) Scheme originally defined in [RFC 9180](https://www.rfc-editor.org/rfc/rfc9180). It involves wrapping the raw key with an ephemeral AES key, derived with HKDF-SHA256 from an encryption context, that is, in turn obtained from the receiver\u2019s public key with the help of the ML-KEM-768 KEM. For more details, see the [ML-KEM HPKE standard](http://datatracker.ietf.org/doc/draft-ietf-hpke-pq/01/).", +"Represents the Hybrid Public Key Encryption (HPKE) Scheme originally defined in [RFC 9180](https://www.rfc-editor.org/rfc/rfc9180). It involves wrapping the raw key with an ephemeral AES key, derived with HKDF-SHA256 from an encryption context, that is, in turn obtained from the receiver\u2019s public key with the help of the ML-KEM-1024 KEM. For more details, see the [ML-KEM HPKE standard](http://datatracker.ietf.org/doc/draft-ietf-hpke-pq/01/).", +"Represents the Hybrid Public Key Encryption (HPKE) Scheme originally defined in [RFC 9180](https://www.rfc-editor.org/rfc/rfc9180). It involves wrapping the raw key with an ephemeral AES key, derived with HKDF-SHA256 from an encryption context, that is, in turn obtained from the receiver\u2019s public key with the help of the X-Wing hybrid KEM. For more details, see the [X-Wing standard](http://datatracker.ietf.org/doc/draft-connolly-cfrg-xwing-kem/09/)." ], "type": "string" }, @@ -4451,6 +4485,25 @@ "description": "Output only. The public key with which to wrap key material prior to import. Only returned if state is ACTIVE.", "readOnly": true }, +"publicKeyFormat": { +"description": "Output only. Specifies the WrappingPublicKey format provided by the customer in the KeyManagementService.GetImportJob request.", +"enum": [ +"PUBLIC_KEY_FORMAT_UNSPECIFIED", +"PEM", +"DER", +"NIST_PQC", +"XWING_RAW_BYTES" +], +"enumDescriptions": [ +"If the public_key_format field is not specified: - For PQC algorithms, an error will be returned. - For non-PQC algorithms, the default format is PEM, and the field pem will be populated. Otherwise, the public key will be exported through the public_key field in the requested format.", +"The returned public key will be encoded in PEM format. See the [RFC7468](https://tools.ietf.org/html/rfc7468) sections for [General Considerations](https://tools.ietf.org/html/rfc7468#section-2) and [Textual Encoding of Subject Public Key Info] (https://tools.ietf.org/html/rfc7468#section-13) for more information.", +"The returned public key will be encoded in DER format (the PrivateKeyInfo structure from RFC 5208).", +"This is supported only for PQC algorithms. The key material is returned in the format defined by NIST PQC standards (FIPS 203, FIPS 204, and FIPS 205).", +"The returned public key is in raw bytes format defined in its standard https://datatracker.ietf.org/doc/draft-connolly-cfrg-xwing-kem." +], +"readOnly": true, +"type": "string" +}, "state": { "description": "Output only. The current state of the ImportJob, indicating if it can be used.", "enum": [ @@ -6001,8 +6054,14 @@ false "description": "The public key component of the wrapping key. For details of the type of key this public key corresponds to, see the ImportMethod.", "id": "WrappingPublicKey", "properties": { +"data": { +"description": "Output only. Contains the public key, formatted according to the PublicKey.PublicKeyFormat specified in the KeyManagementService.GetImportJob request.", +"format": "byte", +"readOnly": true, +"type": "string" +}, "pem": { -"description": "The public key, encoded in PEM format. For more information, see the [RFC 7468](https://tools.ietf.org/html/rfc7468) sections for [General Considerations](https://tools.ietf.org/html/rfc7468#section-2) and [Textual Encoding of Subject Public Key Info] (https://tools.ietf.org/html/rfc7468#section-13).", +"description": "The public key, encoded in PEM format. For more information, see the [RFC 7468](https://tools.ietf.org/html/rfc7468) sections for [General Considerations](https://tools.ietf.org/html/rfc7468#section-2) and [Textual Encoding of Subject Public Key Info] (https://tools.ietf.org/html/rfc7468#section-13). This field gets populated by default for RSA-based import methods, if no public_key_format is specified in the request. If you want to retrieve the wrapping key of an ImportJob in some other format, use KeyManagementService.GetImportJob and set the public_key_format to the desired public key format.", "type": "string" } }, diff --git a/googleapiclient/discovery_cache/documents/cloudsupport.v2.json b/googleapiclient/discovery_cache/documents/cloudsupport.v2.json index db0e3f4852..5c1879b376 100644 --- a/googleapiclient/discovery_cache/documents/cloudsupport.v2.json +++ b/googleapiclient/discovery_cache/documents/cloudsupport.v2.json @@ -372,6 +372,31 @@ "resources": { "attachments": { "methods": { +"get": { +"description": "Retrieve an attachment associated with a support case. EXAMPLES: cURL: ```shell attachment=\"projects/some-project/cases/23598314/attachments/0684M00000P3h1fQAB\" curl \\ --header \"Authorization: Bearer $(gcloud auth print-access-token)\" \\ \"https://cloudsupport.googleapis.com/v2/$attachment\" ``` Python: ```python import googleapiclient.discovery api_version = \"v2\" supportApiService = googleapiclient.discovery.build( serviceName=\"cloudsupport\", version=api_version, discoveryServiceUrl=f\"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}\", ) request = ( supportApiService.cases() .attachments() .get(name=\"projects/some-project/cases/43595344/attachments/0684M00000P3h1fQAB\") ) print(request.execute()) ```", +"flatPath": "v2/{v2Id}/{v2Id1}/cases/{casesId}/attachments/{attachmentsId}", +"httpMethod": "GET", +"id": "cloudsupport.cases.attachments.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The name of the attachment to get.", +"location": "path", +"pattern": "^[^/]+/[^/]+/cases/[^/]+/attachments/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v2/{+name}", +"response": { +"$ref": "Attachment" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, "list": { "description": "List all the attachments associated with a support case. EXAMPLES: cURL: ```shell case=\"projects/some-project/cases/23598314\" curl \\ --header \"Authorization: Bearer $(gcloud auth print-access-token)\" \\ \"https://cloudsupport.googleapis.com/v2/$case/attachments\" ``` Python: ```python import googleapiclient.discovery api_version = \"v2\" supportApiService = googleapiclient.discovery.build( serviceName=\"cloudsupport\", version=api_version, discoveryServiceUrl=f\"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}\", ) request = ( supportApiService.cases() .attachments() .list(parent=\"projects/some-project/cases/43595344\") ) print(request.execute()) ```", "flatPath": "v2/{v2Id}/{v2Id1}/cases/{casesId}/attachments", @@ -440,6 +465,31 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, +"get": { +"description": "Retrieve a comment. EXAMPLES: cURL: ```shell comment=\"projects/some-project/cases/43595344/comments/234567890\" curl \\ --header \"Authorization: Bearer $(gcloud auth print-access-token)\" \\ \"https://cloudsupport.googleapis.com/v2/$comment\" ``` Python: ```python import googleapiclient.discovery api_version = \"v2\" supportApiService = googleapiclient.discovery.build( serviceName=\"cloudsupport\", version=api_version, discoveryServiceUrl=f\"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}\", ) request = supportApiService.cases().comments().get( name=\"projects/some-project/cases/43595344/comments/234567890\", ) print(request.execute()) ```", +"flatPath": "v2/{v2Id}/{v2Id1}/cases/{casesId}/comments/{commentsId}", +"httpMethod": "GET", +"id": "cloudsupport.cases.comments.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The name of the comment to retrieve.", +"location": "path", +"pattern": "^[^/]+/[^/]+/cases/[^/]+/comments/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v2/{+name}", +"response": { +"$ref": "Comment" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, "list": { "description": "List all the comments associated with a case. EXAMPLES: cURL: ```shell case=\"projects/some-project/cases/43595344\" curl \\ --header \"Authorization: Bearer $(gcloud auth print-access-token)\" \\ \"https://cloudsupport.googleapis.com/v2/$case/comments\" ``` Python: ```python import googleapiclient.discovery api_version = \"v2\" supportApiService = googleapiclient.discovery.build( serviceName=\"cloudsupport\", version=api_version, discoveryServiceUrl=f\"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}\", ) request = ( supportApiService.cases() .comments() .list(parent=\"projects/some-project/cases/43595344\") ) print(request.execute()) ```", "flatPath": "v2/{v2Id}/{v2Id1}/cases/{casesId}/comments", @@ -510,7 +560,7 @@ "useMediaDownloadService": true }, "upload": { -"description": "Create a file attachment on a case or Cloud resource. The attachment must have the following fields set: `filename`. EXAMPLES: cURL: ```shell echo \"This text is in a file I'm uploading using CSAPI.\" \\ > \"./example_file.txt\" case=\"projects/some-project/cases/43594844\" curl \\ --header \"Authorization: Bearer $(gcloud auth print-access-token)\" \\ --data-binary @\"./example_file.txt\" \\ \"https://cloudsupport.googleapis.com/upload/v2beta/$case/attachments?attachment.filename=uploaded_via_curl.txt\" ``` Python: ```python import googleapiclient.discovery api_version = \"v2\" supportApiService = googleapiclient.discovery.build( serviceName=\"cloudsupport\", version=api_version, discoveryServiceUrl=f\"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}\", ) file_path = \"./example_file.txt\" with open(file_path, \"w\") as file: file.write( \"This text is inside a file I'm going to upload using the Cloud Support API.\", ) request = supportApiService.media().upload( parent=\"projects/some-project/cases/43595344\", media_body=file_path ) request.uri = request.uri.split(\"?\")[0] + \"?attachment.filename=uploaded_via_python.txt\" print(request.execute()) ```", +"description": "Create a file attachment on a case or Cloud resource. The attachment must have the following fields set: `filename`. EXAMPLES: cURL: ```shell echo \"This text is in a file I'm uploading using CSAPI.\" \\ > \"./example_file.txt\" case=\"projects/some-project/cases/43594844\" curl \\ --header \"Authorization: Bearer $(gcloud auth print-access-token)\" \\ --data-binary @\"./example_file.txt\" \\ \"https://cloudsupport.googleapis.com/upload/v2/$case/attachments?attachment.filename=uploaded_via_curl.txt\" ``` Python: ```python import googleapiclient.discovery api_version = \"v2\" supportApiService = googleapiclient.discovery.build( serviceName=\"cloudsupport\", version=api_version, discoveryServiceUrl=f\"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}\", ) file_path = \"./example_file.txt\" with open(file_path, \"w\") as file: file.write( \"This text is inside a file I'm going to upload using the Cloud Support API.\", ) request = supportApiService.media().upload( parent=\"projects/some-project/cases/43595344\", media_body=file_path ) request.uri = request.uri.split(\"?\")[0] + \"?attachment.filename=uploaded_via_python.txt\" print(request.execute()) ```", "flatPath": "v2/{v2Id}/{v2Id1}/cases/{casesId}/attachments", "httpMethod": "POST", "id": "cloudsupport.media.upload", @@ -552,7 +602,7 @@ } } }, -"revision": "20260409", +"revision": "20260519", "rootUrl": "https://cloudsupport.googleapis.com/", "schemas": { "Actor": { @@ -1300,6 +1350,11 @@ "format": "byte", "type": "string" }, +"sha512Hash": { +"description": "# gdata.* are outside protos with mising documentation", +"format": "byte", +"type": "string" +}, "timestamp": { "description": "# gdata.* are outside protos with mising documentation", "format": "uint64", diff --git a/googleapiclient/discovery_cache/documents/cloudsupport.v2beta.json b/googleapiclient/discovery_cache/documents/cloudsupport.v2beta.json index fb24e966e6..c4881b6f29 100644 --- a/googleapiclient/discovery_cache/documents/cloudsupport.v2beta.json +++ b/googleapiclient/discovery_cache/documents/cloudsupport.v2beta.json @@ -108,7 +108,7 @@ "caseClassifications": { "methods": { "search": { -"description": "Retrieve valid classifications to use when creating a support case. Classifications are hierarchical. Each classification is a string containing all levels of the hierarchy separated by `\" > \"`. For example, `\"Technical Issue > Compute > Compute Engine\"`. Classification IDs returned by this endpoint are valid for at least six months. When a classification is deactivated, this endpoint immediately stops returning it. After six months, `case.create` requests using the classification will fail. EXAMPLES: cURL: ```shell curl \\ --header \"Authorization: Bearer $(gcloud auth print-access-token)\" \\ 'https://cloudsupport.googleapis.com/v2/caseClassifications:search?query=display_name:\"*Compute%20Engine*\"' ``` Python: ```python import googleapiclient.discovery supportApiService = googleapiclient.discovery.build( serviceName=\"cloudsupport\", version=\"v2\", discoveryServiceUrl=f\"https://cloudsupport.googleapis.com/$discovery/rest?version=v2\", ) request = supportApiService.caseClassifications().search( query='display_name:\"*Compute Engine*\"' ) print(request.execute()) ```", +"description": "Retrieve valid classifications to use when creating a support case. Classifications are hierarchical. Each classification is a string containing all levels of the hierarchy separated by `\" > \"`. For example, `\"Technical Issue > Compute > Compute Engine\"`. Classification IDs returned by this endpoint are valid for at least six months. When a classification is deactivated, this endpoint immediately stops returning it. After six months, `case.create` requests using the classification will fail. EXAMPLES: cURL: ```shell curl \\ --header \"Authorization: Bearer $(gcloud auth print-access-token)\" \\ 'https://cloudsupport.googleapis.com/v2beta/caseClassifications:search?query=display_name:\"*Compute%20Engine*\"' ``` Python: ```python import googleapiclient.discovery supportApiService = googleapiclient.discovery.build( serviceName=\"cloudsupport\", version=\"v2beta\", discoveryServiceUrl=f\"https://cloudsupport.googleapis.com/$discovery/rest?version=v2\", ) request = supportApiService.caseClassifications().search( query='display_name:\"*Compute Engine*\"' ) print(request.execute()) ```", "flatPath": "v2beta/caseClassifications:search", "httpMethod": "GET", "id": "cloudsupport.caseClassifications.search", @@ -159,7 +159,7 @@ "cases": { "methods": { "close": { -"description": "Close a case. EXAMPLES: cURL: ```shell case=\"projects/some-project/cases/43595344\" curl \\ --request POST \\ --header \"Authorization: Bearer $(gcloud auth print-access-token)\" \\ \"https://cloudsupport.googleapis.com/v2/$case:close\" ``` Python: ```python import googleapiclient.discovery api_version = \"v2\" supportApiService = googleapiclient.discovery.build( serviceName=\"cloudsupport\", version=api_version, discoveryServiceUrl=f\"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}\", ) request = supportApiService.cases().close( name=\"projects/some-project/cases/43595344\" ) print(request.execute()) ```", +"description": "Close a case. EXAMPLES: cURL: ```shell case=\"projects/some-project/cases/43595344\" curl \\ --request POST \\ --header \"Authorization: Bearer $(gcloud auth print-access-token)\" \\ \"https://cloudsupport.googleapis.com/v2beta/$case:close\" ``` Python: ```python import googleapiclient.discovery api_version = \"v2beta\" supportApiService = googleapiclient.discovery.build( serviceName=\"cloudsupport\", version=api_version, discoveryServiceUrl=f\"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}\", ) request = supportApiService.cases().close( name=\"projects/some-project/cases/43595344\" ) print(request.execute()) ```", "flatPath": "v2beta/{v2betaId}/{v2betaId1}/cases/{casesId}:close", "httpMethod": "POST", "id": "cloudsupport.cases.close", @@ -187,7 +187,7 @@ ] }, "create": { -"description": "Create a new case and associate it with a parent. It must have the following fields set: `display_name`, `description`, `classification`, and `priority`. If you're just testing the API and don't want to route your case to an agent, set `testCase=true`. EXAMPLES: cURL: ```shell parent=\"projects/some-project\" curl \\ --request POST \\ --header \"Authorization: Bearer $(gcloud auth print-access-token)\" \\ --header 'Content-Type: application/json' \\ --data '{ \"display_name\": \"Test case created by me.\", \"description\": \"a random test case, feel free to close\", \"classification\": { \"id\": \"100IK2AKCLHMGRJ9CDGMOCGP8DM6UTB4BT262T31BT1M2T31DHNMENPO6KS36CPJ786L2TBFEHGN6NPI64R3CDHN8880G08I1H3MURR7DHII0GRCDTQM8\" }, \"time_zone\": \"-07:00\", \"subscriber_email_addresses\": [ \"foo@domain.com\", \"bar@domain.com\" ], \"testCase\": true, \"priority\": \"P3\" }' \\ \"https://cloudsupport.googleapis.com/v2/$parent/cases\" ``` Python: ```python import googleapiclient.discovery api_version = \"v2\" supportApiService = googleapiclient.discovery.build( serviceName=\"cloudsupport\", version=api_version, discoveryServiceUrl=f\"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}\", ) request = supportApiService.cases().create( parent=\"projects/some-project\", body={ \"displayName\": \"A Test Case\", \"description\": \"This is a test case.\", \"testCase\": True, \"priority\": \"P2\", \"classification\": { \"id\": \"100IK2AKCLHMGRJ9CDGMOCGP8DM6UTB4BT262T31BT1M2T31DHNMENPO6KS36CPJ786L2TBFEHGN6NPI64R3CDHN8880G08I1H3MURR7DHII0GRCDTQM8\" }, }, ) print(request.execute()) ```", +"description": "Create a new case and associate it with a parent. It must have the following fields set: `display_name`, `description`, `classification`, and `priority`. If you're just testing the API and don't want to route your case to an agent, set `testCase=true`. EXAMPLES: cURL: ```shell parent=\"projects/some-project\" curl \\ --request POST \\ --header \"Authorization: Bearer $(gcloud auth print-access-token)\" \\ --header 'Content-Type: application/json' \\ --data '{ \"display_name\": \"Test case created by me.\", \"description\": \"a random test case, feel free to close\", \"classification\": { \"id\": \"100IK2AKCLHMGRJ9CDGMOCGP8DM6UTB4BT262T31BT1M2T31DHNMENPO6KS36CPJ786L2TBFEHGN6NPI64R3CDHN8880G08I1H3MURR7DHII0GRCDTQM8\" }, \"time_zone\": \"-07:00\", \"subscriber_email_addresses\": [ \"foo@domain.com\", \"bar@domain.com\" ], \"testCase\": true, \"priority\": \"P3\" }' \\ \"https://cloudsupport.googleapis.com/v2beta/$parent/cases\" ``` Python: ```python import googleapiclient.discovery api_version = \"v2beta\" supportApiService = googleapiclient.discovery.build( serviceName=\"cloudsupport\", version=api_version, discoveryServiceUrl=f\"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}\", ) request = supportApiService.cases().create( parent=\"projects/some-project\", body={ \"displayName\": \"A Test Case\", \"description\": \"This is a test case.\", \"testCase\": True, \"priority\": \"P2\", \"classification\": { \"id\": \"100IK2AKCLHMGRJ9CDGMOCGP8DM6UTB4BT262T31BT1M2T31DHNMENPO6KS36CPJ786L2TBFEHGN6NPI64R3CDHN8880G08I1H3MURR7DHII0GRCDTQM8\" }, }, ) print(request.execute()) ```", "flatPath": "v2beta/{v2betaId}/{v2betaId1}/cases", "httpMethod": "POST", "id": "cloudsupport.cases.create", @@ -215,7 +215,7 @@ ] }, "escalate": { -"description": "Escalate a case, starting the Google Cloud Support escalation management process. This operation is only available for some support services. Go to https://cloud.google.com/support and look for 'Technical support escalations' in the feature list to find out which ones let you do that. EXAMPLES: cURL: ```shell case=\"projects/some-project/cases/43595344\" curl \\ --request POST \\ --header \"Authorization: Bearer $(gcloud auth print-access-token)\" \\ --header \"Content-Type: application/json\" \\ --data '{ \"escalation\": { \"reason\": \"BUSINESS_IMPACT\", \"justification\": \"This is a test escalation.\" } }' \\ \"https://cloudsupport.googleapis.com/v2/$case:escalate\" ``` Python: ```python import googleapiclient.discovery api_version = \"v2\" supportApiService = googleapiclient.discovery.build( serviceName=\"cloudsupport\", version=api_version, discoveryServiceUrl=f\"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}\", ) request = supportApiService.cases().escalate( name=\"projects/some-project/cases/43595344\", body={ \"escalation\": { \"reason\": \"BUSINESS_IMPACT\", \"justification\": \"This is a test escalation.\", }, }, ) print(request.execute()) ```", +"description": "Escalate a case, starting the Google Cloud Support escalation management process. This operation is only available for some support services. Go to https://cloud.google.com/support and look for 'Technical support escalations' in the feature list to find out which ones let you do that. EXAMPLES: cURL: ```shell case=\"projects/some-project/cases/43595344\" curl \\ --request POST \\ --header \"Authorization: Bearer $(gcloud auth print-access-token)\" \\ --header \"Content-Type: application/json\" \\ --data '{ \"escalation\": { \"reason\": \"BUSINESS_IMPACT\", \"justification\": \"This is a test escalation.\" } }' \\ \"https://cloudsupport.googleapis.com/v2beta/$case:escalate\" ``` Python: ```python import googleapiclient.discovery api_version = \"v2beta\" supportApiService = googleapiclient.discovery.build( serviceName=\"cloudsupport\", version=api_version, discoveryServiceUrl=f\"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}\", ) request = supportApiService.cases().escalate( name=\"projects/some-project/cases/43595344\", body={ \"escalation\": { \"reason\": \"BUSINESS_IMPACT\", \"justification\": \"This is a test escalation.\", }, }, ) print(request.execute()) ```", "flatPath": "v2beta/{v2betaId}/{v2betaId1}/cases/{casesId}:escalate", "httpMethod": "POST", "id": "cloudsupport.cases.escalate", @@ -243,7 +243,7 @@ ] }, "get": { -"description": "Retrieve a case. EXAMPLES: cURL: ```shell case=\"projects/some-project/cases/16033687\" curl \\ --header \"Authorization: Bearer $(gcloud auth print-access-token)\" \\ \"https://cloudsupport.googleapis.com/v2/$case\" ``` Python: ```python import googleapiclient.discovery api_version = \"v2\" supportApiService = googleapiclient.discovery.build( serviceName=\"cloudsupport\", version=api_version, discoveryServiceUrl=f\"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}\", ) request = supportApiService.cases().get( name=\"projects/some-project/cases/43595344\", ) print(request.execute()) ```", +"description": "Retrieve a case. EXAMPLES: cURL: ```shell case=\"projects/some-project/cases/16033687\" curl \\ --header \"Authorization: Bearer $(gcloud auth print-access-token)\" \\ \"https://cloudsupport.googleapis.com/v2beta/$case\" ``` Python: ```python import googleapiclient.discovery api_version = \"v2beta\" supportApiService = googleapiclient.discovery.build( serviceName=\"cloudsupport\", version=api_version, discoveryServiceUrl=f\"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}\", ) request = supportApiService.cases().get( name=\"projects/some-project/cases/43595344\", ) print(request.execute()) ```", "flatPath": "v2beta/{v2betaId}/{v2betaId1}/cases/{casesId}", "httpMethod": "GET", "id": "cloudsupport.cases.get", @@ -268,7 +268,7 @@ ] }, "list": { -"description": "Retrieve all cases under a parent, but not its children. For example, listing cases under an organization only returns the cases that are directly parented by that organization. To retrieve cases under an organization and its projects, use `cases.search`. EXAMPLES: cURL: ```shell parent=\"projects/some-project\" curl \\ --header \"Authorization: Bearer $(gcloud auth print-access-token)\" \\ \"https://cloudsupport.googleapis.com/v2/$parent/cases\" ``` Python: ```python import googleapiclient.discovery api_version = \"v2\" supportApiService = googleapiclient.discovery.build( serviceName=\"cloudsupport\", version=api_version, discoveryServiceUrl=f\"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}\", ) request = supportApiService.cases().list(parent=\"projects/some-project\") print(request.execute()) ```", +"description": "Retrieve all cases under a parent, but not its children. For example, listing cases under an organization only returns the cases that are directly parented by that organization. To retrieve cases under an organization and its projects, use `cases.search`. EXAMPLES: cURL: ```shell parent=\"projects/some-project\" curl \\ --header \"Authorization: Bearer $(gcloud auth print-access-token)\" \\ \"https://cloudsupport.googleapis.com/v2beta/$parent/cases\" ``` Python: ```python import googleapiclient.discovery api_version = \"v2beta\" supportApiService = googleapiclient.discovery.build( serviceName=\"cloudsupport\", version=api_version, discoveryServiceUrl=f\"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}\", ) request = supportApiService.cases().list(parent=\"projects/some-project\") print(request.execute()) ```", "flatPath": "v2beta/{v2betaId}/{v2betaId1}/cases", "httpMethod": "GET", "id": "cloudsupport.cases.list", @@ -324,7 +324,7 @@ ] }, "patch": { -"description": "Update a case. Only some fields can be updated. EXAMPLES: cURL: ```shell case=\"projects/some-project/cases/43595344\" curl \\ --request PATCH \\ --header \"Authorization: Bearer $(gcloud auth print-access-token)\" \\ --header \"Content-Type: application/json\" \\ --data '{ \"priority\": \"P1\" }' \\ \"https://cloudsupport.googleapis.com/v2/$case?updateMask=priority\" ``` Python: ```python import googleapiclient.discovery api_version = \"v2\" supportApiService = googleapiclient.discovery.build( serviceName=\"cloudsupport\", version=api_version, discoveryServiceUrl=f\"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}\", ) request = supportApiService.cases().patch( name=\"projects/some-project/cases/43112854\", body={ \"displayName\": \"This is Now a New Title\", \"priority\": \"P2\", }, ) print(request.execute()) ```", +"description": "Update a case. Only some fields can be updated. EXAMPLES: cURL: ```shell case=\"projects/some-project/cases/43595344\" curl \\ --request PATCH \\ --header \"Authorization: Bearer $(gcloud auth print-access-token)\" \\ --header \"Content-Type: application/json\" \\ --data '{ \"priority\": \"P1\" }' \\ \"https://cloudsupport.googleapis.com/v2beta/$case?updateMask=priority\" ``` Python: ```python import googleapiclient.discovery api_version = \"v2beta\" supportApiService = googleapiclient.discovery.build( serviceName=\"cloudsupport\", version=api_version, discoveryServiceUrl=f\"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}\", ) request = supportApiService.cases().patch( name=\"projects/some-project/cases/43112854\", body={ \"displayName\": \"This is Now a New Title\", \"priority\": \"P2\", }, ) print(request.execute()) ```", "flatPath": "v2beta/{v2betaId}/{v2betaId1}/cases/{casesId}", "httpMethod": "PATCH", "id": "cloudsupport.cases.patch", @@ -358,7 +358,7 @@ ] }, "search": { -"description": "Search for cases using a query. EXAMPLES: cURL: ```shell parent=\"projects/some-project\" curl \\ --header \"Authorization: Bearer $(gcloud auth print-access-token)\" \\ \"https://cloudsupport.googleapis.com/v2/$parent/cases:search\" ``` Python: ```python import googleapiclient.discovery api_version = \"v2\" supportApiService = googleapiclient.discovery.build( serviceName=\"cloudsupport\", version=api_version, discoveryServiceUrl=f\"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}\", ) request = supportApiService.cases().search( parent=\"projects/some-project\", query=\"state=OPEN\" ) print(request.execute()) ```", +"description": "Search for cases using a query. EXAMPLES: cURL: ```shell parent=\"projects/some-project\" curl \\ --header \"Authorization: Bearer $(gcloud auth print-access-token)\" \\ \"https://cloudsupport.googleapis.com/v2beta/$parent/cases:search\" ``` Python: ```python import googleapiclient.discovery api_version = \"v2beta\" supportApiService = googleapiclient.discovery.build( serviceName=\"cloudsupport\", version=api_version, discoveryServiceUrl=f\"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}\", ) request = supportApiService.cases().search( parent=\"projects/some-project\", query=\"state=OPEN\" ) print(request.execute()) ```", "flatPath": "v2beta/cases:search", "httpMethod": "GET", "id": "cloudsupport.cases.search", @@ -440,7 +440,7 @@ "attachments": { "methods": { "get": { -"description": "Retrieve an attachment associated with a support case. EXAMPLES: cURL: ```shell attachment=\"projects/some-project/cases/23598314/attachments/0684M00000P3h1fQAB\" curl \\ --header \"Authorization: Bearer $(gcloud auth print-access-token)\" \\ \"https://cloudsupport.googleapis.com/v2/$attachment\" ``` Python: ```python import googleapiclient.discovery api_version = \"v2beta\" supportApiService = googleapiclient.discovery.build( serviceName=\"cloudsupport\", version=api_version, discoveryServiceUrl=f\"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}\", ) request = ( supportApiService.cases() .attachments() .get(name=\"projects/some-project/cases/43595344/attachments/0684M00000P3h1fQAB\") ) print(request.execute()) ```", +"description": "Retrieve an attachment associated with a support case. EXAMPLES: cURL: ```shell attachment=\"projects/some-project/cases/23598314/attachments/0684M00000P3h1fQAB\" curl \\ --header \"Authorization: Bearer $(gcloud auth print-access-token)\" \\ \"https://cloudsupport.googleapis.com/v2beta/$attachment\" ``` Python: ```python import googleapiclient.discovery api_version = \"v2beta\" supportApiService = googleapiclient.discovery.build( serviceName=\"cloudsupport\", version=api_version, discoveryServiceUrl=f\"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}\", ) request = ( supportApiService.cases() .attachments() .get(name=\"projects/some-project/cases/43595344/attachments/0684M00000P3h1fQAB\") ) print(request.execute()) ```", "flatPath": "v2beta/{v2betaId}/{v2betaId1}/cases/{casesId}/attachments/{attachmentsId}", "httpMethod": "GET", "id": "cloudsupport.cases.attachments.get", @@ -465,7 +465,7 @@ ] }, "list": { -"description": "List all the attachments associated with a support case. EXAMPLES: cURL: ```shell case=\"projects/some-project/cases/23598314\" curl \\ --header \"Authorization: Bearer $(gcloud auth print-access-token)\" \\ \"https://cloudsupport.googleapis.com/v2/$case/attachments\" ``` Python: ```python import googleapiclient.discovery api_version = \"v2\" supportApiService = googleapiclient.discovery.build( serviceName=\"cloudsupport\", version=api_version, discoveryServiceUrl=f\"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}\", ) request = ( supportApiService.cases() .attachments() .list(parent=\"projects/some-project/cases/43595344\") ) print(request.execute()) ```", +"description": "List all the attachments associated with a support case. EXAMPLES: cURL: ```shell case=\"projects/some-project/cases/23598314\" curl \\ --header \"Authorization: Bearer $(gcloud auth print-access-token)\" \\ \"https://cloudsupport.googleapis.com/v2beta/$case/attachments\" ``` Python: ```python import googleapiclient.discovery api_version = \"v2beta\" supportApiService = googleapiclient.discovery.build( serviceName=\"cloudsupport\", version=api_version, discoveryServiceUrl=f\"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}\", ) request = ( supportApiService.cases() .attachments() .list(parent=\"projects/some-project/cases/43595344\") ) print(request.execute()) ```", "flatPath": "v2beta/{v2betaId}/{v2betaId1}/cases/{casesId}/attachments", "httpMethod": "GET", "id": "cloudsupport.cases.attachments.list", @@ -505,7 +505,7 @@ "comments": { "methods": { "create": { -"description": "Add a new comment to a case. The comment must have the following fields set: `body`. EXAMPLES: cURL: ```shell case=\"projects/some-project/cases/43591344\" curl \\ --request POST \\ --header \"Authorization: Bearer $(gcloud auth print-access-token)\" \\ --header 'Content-Type: application/json' \\ --data '{ \"body\": \"This is a test comment.\" }' \\ \"https://cloudsupport.googleapis.com/v2/$case/comments\" ``` Python: ```python import googleapiclient.discovery api_version = \"v2\" supportApiService = googleapiclient.discovery.build( serviceName=\"cloudsupport\", version=api_version, discoveryServiceUrl=f\"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}\", ) request = ( supportApiService.cases() .comments() .create( parent=\"projects/some-project/cases/43595344\", body={\"body\": \"This is a test comment.\"}, ) ) print(request.execute()) ```", +"description": "Add a new comment to a case. The comment must have the following fields set: `body`. EXAMPLES: cURL: ```shell case=\"projects/some-project/cases/43591344\" curl \\ --request POST \\ --header \"Authorization: Bearer $(gcloud auth print-access-token)\" \\ --header 'Content-Type: application/json' \\ --data '{ \"body\": \"This is a test comment.\" }' \\ \"https://cloudsupport.googleapis.com/v2beta/$case/comments\" ``` Python: ```python import googleapiclient.discovery api_version = \"v2beta\" supportApiService = googleapiclient.discovery.build( serviceName=\"cloudsupport\", version=api_version, discoveryServiceUrl=f\"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}\", ) request = ( supportApiService.cases() .comments() .create( parent=\"projects/some-project/cases/43595344\", body={\"body\": \"This is a test comment.\"}, ) ) print(request.execute()) ```", "flatPath": "v2beta/{v2betaId}/{v2betaId1}/cases/{casesId}/comments", "httpMethod": "POST", "id": "cloudsupport.cases.comments.create", @@ -533,7 +533,7 @@ ] }, "get": { -"description": "Retrieve a comment. EXAMPLES: cURL: ```shell comment=\"projects/some-project/cases/43595344/comments/234567890\" curl \\ --header \"Authorization: Bearer $(gcloud auth print-access-token)\" \\ \"https://cloudsupport.googleapis.com/v2/$comment\" ``` Python: ```python import googleapiclient.discovery api_version = \"v2beta\" supportApiService = googleapiclient.discovery.build( serviceName=\"cloudsupport\", version=api_version, discoveryServiceUrl=f\"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}\", ) request = supportApiService.cases().comments().get( name=\"projects/some-project/cases/43595344/comments/234567890\", ) print(request.execute()) ```", +"description": "Retrieve a comment. EXAMPLES: cURL: ```shell comment=\"projects/some-project/cases/43595344/comments/234567890\" curl \\ --header \"Authorization: Bearer $(gcloud auth print-access-token)\" \\ \"https://cloudsupport.googleapis.com/v2beta/$comment\" ``` Python: ```python import googleapiclient.discovery api_version = \"v2beta\" supportApiService = googleapiclient.discovery.build( serviceName=\"cloudsupport\", version=api_version, discoveryServiceUrl=f\"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}\", ) request = supportApiService.cases().comments().get( name=\"projects/some-project/cases/43595344/comments/234567890\", ) print(request.execute()) ```", "flatPath": "v2beta/{v2betaId}/{v2betaId1}/cases/{casesId}/comments/{commentsId}", "httpMethod": "GET", "id": "cloudsupport.cases.comments.get", @@ -558,7 +558,7 @@ ] }, "list": { -"description": "List all the comments associated with a case. EXAMPLES: cURL: ```shell case=\"projects/some-project/cases/43595344\" curl \\ --header \"Authorization: Bearer $(gcloud auth print-access-token)\" \\ \"https://cloudsupport.googleapis.com/v2/$case/comments\" ``` Python: ```python import googleapiclient.discovery api_version = \"v2\" supportApiService = googleapiclient.discovery.build( serviceName=\"cloudsupport\", version=api_version, discoveryServiceUrl=f\"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}\", ) request = ( supportApiService.cases() .comments() .list(parent=\"projects/some-project/cases/43595344\") ) print(request.execute()) ```", +"description": "List all the comments associated with a case. EXAMPLES: cURL: ```shell case=\"projects/some-project/cases/43595344\" curl \\ --header \"Authorization: Bearer $(gcloud auth print-access-token)\" \\ \"https://cloudsupport.googleapis.com/v2beta/$case/comments\" ``` Python: ```python import googleapiclient.discovery api_version = \"v2beta\" supportApiService = googleapiclient.discovery.build( serviceName=\"cloudsupport\", version=api_version, discoveryServiceUrl=f\"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}\", ) request = ( supportApiService.cases() .comments() .list(parent=\"projects/some-project/cases/43595344\") ) print(request.execute()) ```", "flatPath": "v2beta/{v2betaId}/{v2betaId1}/cases/{casesId}/comments", "httpMethod": "GET", "id": "cloudsupport.cases.comments.list", @@ -600,7 +600,7 @@ "media": { "methods": { "download": { -"description": "Download a file attached to a case. When this endpoint is called, no \"response body\" will be returned. Instead, the attachment's blob will be returned. Note: HTTP requests must append \"?alt=media\" to the URL. EXAMPLES: cURL: ```shell name=\"projects/some-project/cases/43594844/attachments/0674M00000WijAnZAJ\" curl \\ --header \"Authorization: Bearer $(gcloud auth print-access-token)\" \\ \"https://cloudsupport.googleapis.com/v2/$name:download?alt=media\" ``` Python: ```python import googleapiclient.discovery api_version = \"v2\" supportApiService = googleapiclient.discovery.build( serviceName=\"cloudsupport\", version=api_version, discoveryServiceUrl=f\"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}\", ) request = supportApiService.media().download( name=\"projects/some-project/cases/43595344/attachments/0684M00000Pw6pHQAR\" ) request.uri = request.uri.split(\"?\")[0] + \"?alt=media\" print(request.execute()) ```", +"description": "Download a file attached to a case. When this endpoint is called, no \"response body\" will be returned. Instead, the attachment's blob will be returned. Note: HTTP requests must append \"?alt=media\" to the URL. EXAMPLES: cURL: ```shell name=\"projects/some-project/cases/43594844/attachments/0674M00000WijAnZAJ\" curl \\ --header \"Authorization: Bearer $(gcloud auth print-access-token)\" \\ \"https://cloudsupport.googleapis.com/v2beta/$name:download?alt=media\" ``` Python: ```python import googleapiclient.discovery api_version = \"v2beta\" supportApiService = googleapiclient.discovery.build( serviceName=\"cloudsupport\", version=api_version, discoveryServiceUrl=f\"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}\", ) request = supportApiService.media().download( name=\"projects/some-project/cases/43595344/attachments/0684M00000Pw6pHQAR\" ) request.uri = request.uri.split(\"?\")[0] + \"?alt=media\" print(request.execute()) ```", "flatPath": "v2beta/{v2betaId}/{v2betaId1}/cases/{casesId}/attachments/{attachmentsId}:download", "httpMethod": "GET", "id": "cloudsupport.media.download", @@ -627,7 +627,7 @@ "useMediaDownloadService": true }, "upload": { -"description": "Create a file attachment on a case or Cloud resource. The attachment must have the following fields set: `filename`. EXAMPLES: cURL: ```shell echo \"This text is in a file I'm uploading using CSAPI.\" \\ > \"./example_file.txt\" case=\"projects/some-project/cases/43594844\" curl \\ --header \"Authorization: Bearer $(gcloud auth print-access-token)\" \\ --data-binary @\"./example_file.txt\" \\ \"https://cloudsupport.googleapis.com/upload/v2beta/$case/attachments?attachment.filename=uploaded_via_curl.txt\" ``` Python: ```python import googleapiclient.discovery api_version = \"v2\" supportApiService = googleapiclient.discovery.build( serviceName=\"cloudsupport\", version=api_version, discoveryServiceUrl=f\"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}\", ) file_path = \"./example_file.txt\" with open(file_path, \"w\") as file: file.write( \"This text is inside a file I'm going to upload using the Cloud Support API.\", ) request = supportApiService.media().upload( parent=\"projects/some-project/cases/43595344\", media_body=file_path ) request.uri = request.uri.split(\"?\")[0] + \"?attachment.filename=uploaded_via_python.txt\" print(request.execute()) ```", +"description": "Create a file attachment on a case or Cloud resource. The attachment must have the following fields set: `filename`. EXAMPLES: cURL: ```shell echo \"This text is in a file I'm uploading using CSAPI.\" \\ > \"./example_file.txt\" case=\"projects/some-project/cases/43594844\" curl \\ --header \"Authorization: Bearer $(gcloud auth print-access-token)\" \\ --data-binary @\"./example_file.txt\" \\ \"https://cloudsupport.googleapis.com/upload/v2beta/$case/attachments?attachment.filename=uploaded_via_curl.txt\" ``` Python: ```python import googleapiclient.discovery api_version = \"v2beta\" supportApiService = googleapiclient.discovery.build( serviceName=\"cloudsupport\", version=api_version, discoveryServiceUrl=f\"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}\", ) file_path = \"./example_file.txt\" with open(file_path, \"w\") as file: file.write( \"This text is inside a file I'm going to upload using the Cloud Support API.\", ) request = supportApiService.media().upload( parent=\"projects/some-project/cases/43595344\", media_body=file_path ) request.uri = request.uri.split(\"?\")[0] + \"?attachment.filename=uploaded_via_python.txt\" print(request.execute()) ```", "flatPath": "v2beta/{v2betaId}/{v2betaId1}/cases/{casesId}/attachments", "httpMethod": "POST", "id": "cloudsupport.media.upload", @@ -669,7 +669,7 @@ } } }, -"revision": "20260409", +"revision": "20260519", "rootUrl": "https://cloudsupport.googleapis.com/", "schemas": { "Actor": { @@ -1522,6 +1522,11 @@ "format": "byte", "type": "string" }, +"sha512Hash": { +"description": "# gdata.* are outside protos with mising documentation", +"format": "byte", +"type": "string" +}, "timestamp": { "description": "# gdata.* are outside protos with mising documentation", "format": "uint64", diff --git a/googleapiclient/discovery_cache/documents/cloudtasks.v2.json b/googleapiclient/discovery_cache/documents/cloudtasks.v2.json index 1794a97d12..29350ad3bc 100644 --- a/googleapiclient/discovery_cache/documents/cloudtasks.v2.json +++ b/googleapiclient/discovery_cache/documents/cloudtasks.v2.json @@ -785,7 +785,7 @@ } } }, -"revision": "20260423", +"revision": "20260512", "rootUrl": "https://cloudtasks.googleapis.com/", "schemas": { "AppEngineHttpRequest": { @@ -1426,7 +1426,7 @@ "type": "integer" }, "maxDispatchesPerSecond": { -"description": "The maximum rate at which tasks are dispatched from this queue. If unspecified when the queue is created, Cloud Tasks will pick the default. * The maximum allowed value is 500. This field has the same meaning as [rate in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#rate).", +"description": "The maximum rate at which tasks are dispatched from this queue. If unspecified when the queue is created, Cloud Tasks will pick the default. The maximum allowed value is 500. This field has the same meaning as [rate in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#rate).", "format": "double", "type": "number" } @@ -1444,12 +1444,12 @@ "id": "RetryConfig", "properties": { "maxAttempts": { -"description": "Number of attempts per task. Cloud Tasks will attempt the task `max_attempts` times (that is, if the first attempt fails, then there will be `max_attempts - 1` retries). Must be >= -1. If unspecified when the queue is created, Cloud Tasks will pick the default. -1 indicates unlimited attempts. This field has the same meaning as [task_retry_limit in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). Note: Cloud Tasks stops retrying only when `max_attempts` and `max_retry_duration` are both satisfied. When the task has been attempted `max_attempts` times and when the `max_retry_duration` time has passed, no further attempts are made, and the task is deleted. If you want your task to retry infinitely, you must set `max_attempts` to -1 and `max_retry_duration` to 0.", +"description": "Number of attempts per task, including the first attempt. (If the first attempt fails, there will be `max_attempts - 1` retries.) Must be greater than or equal to -1, which indicates unlimited attempts. Cloud Tasks stops retrying only when `max_attempts` and `max_retry_duration` are both satisfied, or when the task is successfully executed. When the task has been attempted `max_attempts` times and when the `max_retry_duration` time has passed, no further attempts are made, and the task is deleted. If `max_attempts` is set to -1 and `max_retry_duration` is set to 0, the task is retried until the [maximum task retention](https://docs.cloud.google.com/tasks/docs/quotas#limits) limit is reached. If unspecified when the queue is created, Cloud Tasks will pick the default. This field has the same meaning as [task_retry_limit in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).", "format": "int32", "type": "integer" }, "maxBackoff": { -"description": "A task will be scheduled for retry between min_backoff and max_backoff duration after it fails, if the queue's RetryConfig specifies that the task should be retried. If unspecified when the queue is created, Cloud Tasks will pick the default. The value must be given as a string that indicates the length of time (in seconds) followed by `s` (for \"seconds\"). For more information on the format, see the documentation for [Duration](https://protobuf.dev/reference/protobuf/google.protobuf/#duration). `max_backoff` will be truncated to the nearest second. This field has the same meaning as [max_backoff_seconds in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).", +"description": "A task will be scheduled for retry between min_backoff and max_backoff duration after it fails, if the queue's RetryConfig specifies that the task should be retried. The value must be given as a string that indicates the length of time (in seconds) followed by `s` (for \"seconds\"). For more information on the format, see the documentation for [Duration](https://protobuf.dev/reference/protobuf/google.protobuf/#duration). `max_backoff` will be truncated to the nearest second. If unspecified when the queue is created, Cloud Tasks will pick the default. This field has the same meaning as [max_backoff_seconds in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).", "format": "google-duration", "type": "string" }, @@ -1459,12 +1459,12 @@ "type": "integer" }, "maxRetryDuration": { -"description": "If positive, `max_retry_duration` specifies the time limit for retrying a failed task, measured from when the task was first attempted. Once `max_retry_duration` time has passed *and* the task has been attempted max_attempts times, no further attempts will be made and the task will be deleted. If zero, then the task age is unlimited. If unspecified when the queue is created, Cloud Tasks will pick the default. The value must be given as a string that indicates the length of time (in seconds) followed by `s` (for \"seconds\"). For the maximum possible value or the format, see the documentation for [Duration](https://protobuf.dev/reference/protobuf/google.protobuf/#duration). `max_retry_duration` will be truncated to the nearest second. This field has the same meaning as [task_age_limit in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).", +"description": "If positive, `max_retry_duration` specifies the time limit for retrying a failed task, measured from when the task was first attempted. Once `max_retry_duration` time has passed *and* the task has been attempted max_attempts times, no further attempts are made and the task is deleted. A zero (0) indicates an unlimited duration, up to the [maximum task retention](https://docs.cloud.google.com/tasks/docs/quotas#limits) limit. The value must be given as a string that indicates the length of time (in seconds) followed by `s` (for \"seconds\"). For the maximum possible value or the format, see the documentation for [Duration](https://protobuf.dev/reference/protobuf/google.protobuf/#duration). `max_retry_duration` will be truncated to the nearest second. If unspecified when the queue is created, Cloud Tasks will pick the default. This field has the same meaning as [task_age_limit in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).", "format": "google-duration", "type": "string" }, "minBackoff": { -"description": "A task will be scheduled for retry between min_backoff and max_backoff duration after it fails, if the queue's RetryConfig specifies that the task should be retried. If unspecified when the queue is created, Cloud Tasks will pick the default. The value must be given as a string that indicates the length of time (in seconds) followed by `s` (for \"seconds\"). For more information on the format, see the documentation for [Duration](https://protobuf.dev/reference/protobuf/google.protobuf/#duration). `min_backoff` will be truncated to the nearest second. This field has the same meaning as [min_backoff_seconds in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).", +"description": "A task will be scheduled for retry between min_backoff and max_backoff duration after it fails, if the queue's RetryConfig specifies that the task should be retried. The value must be given as a string that indicates the length of time (in seconds) followed by `s` (for \"seconds\"). For more information on the format, see the documentation for [Duration](https://protobuf.dev/reference/protobuf/google.protobuf/#duration). `min_backoff` will be truncated to the nearest second. If unspecified when the queue is created, Cloud Tasks will pick the default. This field has the same meaning as [min_backoff_seconds in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).", "format": "google-duration", "type": "string" } diff --git a/googleapiclient/discovery_cache/documents/cloudtasks.v2beta3.json b/googleapiclient/discovery_cache/documents/cloudtasks.v2beta3.json index 67318abd06..60d1ee4e54 100644 --- a/googleapiclient/discovery_cache/documents/cloudtasks.v2beta3.json +++ b/googleapiclient/discovery_cache/documents/cloudtasks.v2beta3.json @@ -797,7 +797,7 @@ } } }, -"revision": "20260423", +"revision": "20260512", "rootUrl": "https://cloudtasks.googleapis.com/", "schemas": { "AppEngineHttpQueue": { @@ -1531,7 +1531,7 @@ "type": "integer" }, "maxDispatchesPerSecond": { -"description": "The maximum rate at which tasks are dispatched from this queue. If unspecified when the queue is created, Cloud Tasks will pick the default. * For App Engine queues, the maximum allowed value is 500. This field has the same meaning as [rate in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#rate).", +"description": "The maximum rate at which tasks are dispatched from this queue. If unspecified when the queue is created, Cloud Tasks will pick the default. For App Engine queues, the maximum allowed value is 500. This field has the same meaning as [rate in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#rate).", "format": "double", "type": "number" } @@ -1549,12 +1549,12 @@ "id": "RetryConfig", "properties": { "maxAttempts": { -"description": "Number of attempts per task. Cloud Tasks will attempt the task `max_attempts` times (that is, if the first attempt fails, then there will be `max_attempts - 1` retries). Must be >= -1. If unspecified when the queue is created, Cloud Tasks will pick the default. -1 indicates unlimited attempts. This field has the same meaning as [task_retry_limit in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). Note: Cloud Tasks stops retrying only when `max_attempts` and `max_retry_duration` are both satisfied. When the task has been attempted `max_attempts` times and when the `max_retry_duration` time has passed, no further attempts are made, and the task is deleted. If you want your task to retry infinitely, you must set `max_attempts` to -1 and `max_retry_duration` to 0.", +"description": "Number of attempts per task, including the first attempt. (If the first attempt fails, there will be `max_attempts - 1` retries.) Must be greater than or equal to -1, which indicates unlimited attempts. Cloud Tasks stops retrying only when `max_attempts` and `max_retry_duration` are both satisfied, or when the task is successfully executed. When the task has been attempted `max_attempts` times and when the `max_retry_duration` time has passed, no further attempts are made, and the task is deleted. If `max_attempts` is set to -1 and `max_retry_duration` is set to 0, the task is retried until the [maximum task retention](https://docs.cloud.google.com/tasks/docs/quotas#limits) limit is reached. If unspecified when the queue is created, Cloud Tasks will pick the default. This field has the same meaning as [task_retry_limit in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).", "format": "int32", "type": "integer" }, "maxBackoff": { -"description": "A task will be scheduled for retry between min_backoff and max_backoff duration after it fails, if the queue's RetryConfig specifies that the task should be retried. If unspecified when the queue is created, Cloud Tasks will pick the default. The value must be given as a string that indicates the length of time (in seconds) followed by `s` (for \"seconds\"). For more information on the format, see the documentation for [Duration](https://protobuf.dev/reference/protobuf/google.protobuf/#duration). `max_backoff` will be truncated to the nearest second. This field has the same meaning as [max_backoff_seconds in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).", +"description": "A task will be scheduled for retry between min_backoff and max_backoff duration after it fails, if the queue's RetryConfig specifies that the task should be retried. The value must be given as a string that indicates the length of time (in seconds) followed by `s` (for \"seconds\"). For more information on the format, see the documentation for [Duration](https://protobuf.dev/reference/protobuf/google.protobuf/#duration). `max_backoff` will be truncated to the nearest second. If unspecified when the queue is created, Cloud Tasks will pick the default. This field has the same meaning as [max_backoff_seconds in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).", "format": "google-duration", "type": "string" }, @@ -1564,12 +1564,12 @@ "type": "integer" }, "maxRetryDuration": { -"description": "If positive, `max_retry_duration` specifies the time limit for retrying a failed task, measured from when the task was first attempted. Once `max_retry_duration` time has passed *and* the task has been attempted max_attempts times, no further attempts will be made and the task will be deleted. If zero, then the task age is unlimited. If unspecified when the queue is created, Cloud Tasks will pick the default. The value must be given as a string that indicates the length of time (in seconds) followed by `s` (for \"seconds\"). For the maximum possible value or the format, see the documentation for [Duration](https://protobuf.dev/reference/protobuf/google.protobuf/#duration). `max_retry_duration` will be truncated to the nearest second. This field has the same meaning as [task_age_limit in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).", +"description": "If positive, `max_retry_duration` specifies the time limit for retrying a failed task, measured from when the task was first attempted. Once `max_retry_duration` time has passed *and* the task has been attempted max_attempts times, no further attempts are made and the task is deleted. A zero (0) indicates an unlimited duration, up to the [maximum task retention](https://docs.cloud.google.com/tasks/docs/quotas#limits) limit. The value must be given as a string that indicates the length of time (in seconds) followed by `s` (for \"seconds\"). For the maximum possible value or the format, see the documentation for [Duration](https://protobuf.dev/reference/protobuf/google.protobuf/#duration). `max_retry_duration` will be truncated to the nearest second. If unspecified when the queue is created, Cloud Tasks will pick the default. This field has the same meaning as [task_age_limit in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).", "format": "google-duration", "type": "string" }, "minBackoff": { -"description": "A task will be scheduled for retry between min_backoff and max_backoff duration after it fails, if the queue's RetryConfig specifies that the task should be retried. If unspecified when the queue is created, Cloud Tasks will pick the default. The value must be given as a string that indicates the length of time (in seconds) followed by `s` (for \"seconds\"). For more information on the format, see the documentation for [Duration](https://protobuf.dev/reference/protobuf/google.protobuf/#duration). `min_backoff` will be truncated to the nearest second. This field has the same meaning as [min_backoff_seconds in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).", +"description": "A task will be scheduled for retry between min_backoff and max_backoff duration after it fails, if the queue's RetryConfig specifies that the task should be retried. The value must be given as a string that indicates the length of time (in seconds) followed by `s` (for \"seconds\"). For more information on the format, see the documentation for [Duration](https://protobuf.dev/reference/protobuf/google.protobuf/#duration). `min_backoff` will be truncated to the nearest second. If unspecified when the queue is created, Cloud Tasks will pick the default. This field has the same meaning as [min_backoff_seconds in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).", "format": "google-duration", "type": "string" } diff --git a/googleapiclient/discovery_cache/documents/cloudtrace.v2.json b/googleapiclient/discovery_cache/documents/cloudtrace.v2.json index 6000bf164a..a27b4efb2e 100644 --- a/googleapiclient/discovery_cache/documents/cloudtrace.v2.json +++ b/googleapiclient/discovery_cache/documents/cloudtrace.v2.json @@ -191,11 +191,6 @@ }, { "description": "Regional Endpoint", -"endpointUrl": "https://cloudtrace.us-central2.rep.googleapis.com/", -"location": "us-central2" -}, -{ -"description": "Regional Endpoint", "endpointUrl": "https://cloudtrace.us-east1.rep.googleapis.com/", "location": "us-east1" }, @@ -418,7 +413,7 @@ } } }, -"revision": "20260508", +"revision": "20260520", "rootUrl": "https://cloudtrace.googleapis.com/", "schemas": { "Annotation": { diff --git a/googleapiclient/discovery_cache/documents/composer.v1beta1.json b/googleapiclient/discovery_cache/documents/composer.v1beta1.json index 8aecd4a219..624f64f245 100644 --- a/googleapiclient/discovery_cache/documents/composer.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/composer.v1beta1.json @@ -1278,7 +1278,7 @@ } } }, -"revision": "20260423", +"revision": "20260525", "rootUrl": "https://composer.googleapis.com/", "schemas": { "AirflowMetadataRetentionPolicyConfig": { @@ -2810,6 +2810,10 @@ "name": { "description": "Identifier. The resource name of the Secret, in the form: \"projects/{projectId}/locations/{locationId}/environments/{environmentId}/userWorkloadsSecrets/{userWorkloadsSecretId}\"", "type": "string" +}, +"type": { +"description": "Optional. The \"type\" field of Kubernetes Secret. For details see: https://kubernetes.io/docs/concepts/configuration/secret/#secret-types", +"type": "string" } }, "type": "object" diff --git a/googleapiclient/discovery_cache/documents/compute.alpha.json b/googleapiclient/discovery_cache/documents/compute.alpha.json index d664a5b278..240b8e8014 100644 --- a/googleapiclient/discovery_cache/documents/compute.alpha.json +++ b/googleapiclient/discovery_cache/documents/compute.alpha.json @@ -5525,6 +5525,358 @@ } } }, +"folderZoneVmExtensionPolicies": { +"methods": { +"delete": { +"description": "Deletes a specified zone VM extension policy within a folder.", +"flatPath": "folders/{foldersId}/zones/{zone}/vmExtensionPolicies/{vmExtensionPolicy}", +"httpMethod": "DELETE", +"id": "compute.folderZoneVmExtensionPolicies.delete", +"parameterOrder": [ +"folder", +"zone", +"vmExtensionPolicy" +], +"parameters": { +"folder": { +"description": "Folder ID for this request.", +"location": "path", +"pattern": "folders/[0-9]{0,20}", +"required": true, +"type": "string" +}, +"requestId": { +"description": "An optional request ID to identify requests. Specify a unique request ID so\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).", +"location": "query", +"type": "string" +}, +"vmExtensionPolicy": { +"description": "Name of the zone VM extension policy to delete.", +"location": "path", +"required": true, +"type": "string" +}, +"zone": { +"description": "Name of the zone for this request.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", +"required": true, +"type": "string" +} +}, +"path": "{+folder}/zones/{zone}/vmExtensionPolicies/{vmExtensionPolicy}", +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute" +] +}, +"get": { +"description": "Retrieves details of a specific zone VM extension policy within a folder.", +"flatPath": "folders/{foldersId}/zones/{zone}/vmExtensionPolicies/{vmExtensionPolicy}", +"httpMethod": "GET", +"id": "compute.folderZoneVmExtensionPolicies.get", +"parameterOrder": [ +"folder", +"zone", +"vmExtensionPolicy" +], +"parameters": { +"folder": { +"description": "Folder ID for this request.", +"location": "path", +"pattern": "folders/[0-9]{0,20}", +"required": true, +"type": "string" +}, +"vmExtensionPolicy": { +"description": "Name of the VM extension policy resource to return.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", +"required": true, +"type": "string" +}, +"zone": { +"description": "Name of the zone for this request.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", +"required": true, +"type": "string" +} +}, +"path": "{+folder}/zones/{zone}/vmExtensionPolicies/{vmExtensionPolicy}", +"response": { +"$ref": "VmExtensionPolicy" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute", +"https://www.googleapis.com/auth/compute.readonly" +] +}, +"getVmExtension": { +"description": "Retrieves details of a specific VM extension within a folder.", +"flatPath": "folders/{foldersId}/zones/{zone}/vmExtensions/{extensionName}", +"httpMethod": "GET", +"id": "compute.folderZoneVmExtensionPolicies.getVmExtension", +"parameterOrder": [ +"folder", +"zone", +"extensionName" +], +"parameters": { +"extensionName": { +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", +"required": true, +"type": "string" +}, +"folder": { +"description": "Folder ID for this request.", +"location": "path", +"pattern": "folders/[0-9]{0,20}", +"required": true, +"type": "string" +}, +"zone": { +"description": "Name of the zone for this request.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", +"required": true, +"type": "string" +} +}, +"path": "{+folder}/zones/{zone}/vmExtensions/{extensionName}", +"response": { +"$ref": "VmExtension" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute", +"https://www.googleapis.com/auth/compute.readonly" +] +}, +"insert": { +"description": "Creates a new zone-level VM extension policy within a folder.", +"flatPath": "folders/{foldersId}/zones/{zone}/vmExtensionPolicies", +"httpMethod": "POST", +"id": "compute.folderZoneVmExtensionPolicies.insert", +"parameterOrder": [ +"folder", +"zone" +], +"parameters": { +"folder": { +"description": "Folder ID for this request.", +"location": "path", +"pattern": "folders/[0-9]{0,20}", +"required": true, +"type": "string" +}, +"requestId": { +"description": "An optional request ID to identify requests. Specify a unique request ID so\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).", +"location": "query", +"type": "string" +}, +"zone": { +"description": "Name of the zone for this request.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", +"required": true, +"type": "string" +} +}, +"path": "{+folder}/zones/{zone}/vmExtensionPolicies", +"request": { +"$ref": "VmExtensionPolicy" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute" +] +}, +"list": { +"description": "Lists all VM extension policies within a specific zone for a folder.", +"flatPath": "folders/{foldersId}/zones/{zone}/vmExtensionPolicies", +"httpMethod": "GET", +"id": "compute.folderZoneVmExtensionPolicies.list", +"parameterOrder": [ +"folder", +"zone" +], +"parameters": { +"filter": { +"description": "A filter expression that filters resources listed in the response. Most\nCompute resources support two types of filter expressions:\nexpressions that support regular expressions and expressions that follow\nAPI improvement proposal AIP-160.\nThese two types of filter expressions cannot be mixed in one request.\n\nIf you want to use AIP-160, your expression must specify the field name, an\noperator, and the value that you want to use for filtering. The value\nmust be a string, a number, or a boolean. The operator\nmust be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.\n\nFor example, if you are filtering Compute Engine instances, you can\nexclude instances named `example-instance` by specifying\n`name != example-instance`.\n\nThe `:*` comparison can be used to test whether a key has been defined.\nFor example, to find all objects with `owner` label use:\n```\nlabels.owner:*\n```\n\nYou can also filter nested fields. For example, you could specify\n`scheduling.automaticRestart = false` to include instances only\nif they are not scheduled for automatic restarts. You can use filtering\non nested fields to filter based onresource labels.\n\nTo filter on multiple expressions, provide each separate expression within\nparentheses. For example:\n```\n(scheduling.automaticRestart = true)\n(cpuPlatform = \"Intel Skylake\")\n```\nBy default, each expression is an `AND` expression. However, you\ncan include `AND` and `OR` expressions explicitly.\nFor example:\n```\n(cpuPlatform = \"Intel Skylake\") OR\n(cpuPlatform = \"Intel Broadwell\") AND\n(scheduling.automaticRestart = true)\n```\n\nIf you want to use a regular expression, use the `eq` (equal) or `ne`\n(not equal) operator against a single un-parenthesized expression with or\nwithout quotes or against multiple parenthesized expressions. Examples:\n\n`fieldname eq unquoted literal`\n`fieldname eq 'single quoted literal'`\n`fieldname eq \"double quoted literal\"`\n`(fieldname1 eq literal) (fieldname2 ne \"literal\")`\n\nThe literal value is interpreted as a regular expression using GoogleRE2 library syntax.\nThe literal value must match the entire field.\n\nFor example, to filter for instances that do not end with name \"instance\",\nyou would use `name ne .*instance`.\n\nYou cannot combine constraints on multiple fields using regular\nexpressions.", +"location": "query", +"type": "string" +}, +"folder": { +"description": "Folder ID for this request.", +"location": "path", +"pattern": "folders/[0-9]{0,20}", +"required": true, +"type": "string" +}, +"maxResults": { +"default": "500", +"description": "The maximum number of results per page that should be returned.\nIf the number of available results is larger than `maxResults`,\nCompute Engine returns a `nextPageToken` that can be used to get\nthe next page of results in subsequent list requests. Acceptable values are\n`0` to `500`, inclusive. (Default: `500`)", +"format": "uint32", +"location": "query", +"minimum": "0", +"type": "integer" +}, +"orderBy": { +"description": "Sorts list results by a certain order. By default, results\nare returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation\ntimestamp using `orderBy=\"creationTimestamp desc\"`. This sorts\nresults based on the `creationTimestamp` field in\nreverse chronological order (newest result first). Use this to sort\nresources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or\n`creationTimestamp desc` is supported.", +"location": "query", +"type": "string" +}, +"pageToken": { +"description": "Specifies a page token to use. Set `pageToken` to the\n`nextPageToken` returned by a previous list request to get\nthe next page of results.", +"location": "query", +"type": "string" +}, +"returnPartialSuccess": { +"description": "Opt-in for partial success behavior which provides partial results in case\nof failure. The default value is false.\n\nFor example, when partial success behavior is enabled, aggregatedList for a\nsingle zone scope either returns all resources in the zone or no resources,\nwith an error code.", +"location": "query", +"type": "boolean" +}, +"zone": { +"description": "Name of the zone for this request.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", +"required": true, +"type": "string" +} +}, +"path": "{+folder}/zones/{zone}/vmExtensionPolicies", +"response": { +"$ref": "VmExtensionPolicyList" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute", +"https://www.googleapis.com/auth/compute.readonly" +] +}, +"listVmExtensions": { +"description": "Lists all VM extensions within a specific zone for a folder.\nThis is a read-only API.", +"flatPath": "folders/{foldersId}/zones/{zone}/vmExtensions", +"httpMethod": "GET", +"id": "compute.folderZoneVmExtensionPolicies.listVmExtensions", +"parameterOrder": [ +"folder", +"zone" +], +"parameters": { +"filter": { +"description": "A filter expression that filters resources listed in the response. Most\nCompute resources support two types of filter expressions:\nexpressions that support regular expressions and expressions that follow\nAPI improvement proposal AIP-160.\nThese two types of filter expressions cannot be mixed in one request.\n\nIf you want to use AIP-160, your expression must specify the field name, an\noperator, and the value that you want to use for filtering. The value\nmust be a string, a number, or a boolean. The operator\nmust be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.\n\nFor example, if you are filtering Compute Engine instances, you can\nexclude instances named `example-instance` by specifying\n`name != example-instance`.\n\nThe `:*` comparison can be used to test whether a key has been defined.\nFor example, to find all objects with `owner` label use:\n```\nlabels.owner:*\n```\n\nYou can also filter nested fields. For example, you could specify\n`scheduling.automaticRestart = false` to include instances only\nif they are not scheduled for automatic restarts. You can use filtering\non nested fields to filter based onresource labels.\n\nTo filter on multiple expressions, provide each separate expression within\nparentheses. For example:\n```\n(scheduling.automaticRestart = true)\n(cpuPlatform = \"Intel Skylake\")\n```\nBy default, each expression is an `AND` expression. However, you\ncan include `AND` and `OR` expressions explicitly.\nFor example:\n```\n(cpuPlatform = \"Intel Skylake\") OR\n(cpuPlatform = \"Intel Broadwell\") AND\n(scheduling.automaticRestart = true)\n```\n\nIf you want to use a regular expression, use the `eq` (equal) or `ne`\n(not equal) operator against a single un-parenthesized expression with or\nwithout quotes or against multiple parenthesized expressions. Examples:\n\n`fieldname eq unquoted literal`\n`fieldname eq 'single quoted literal'`\n`fieldname eq \"double quoted literal\"`\n`(fieldname1 eq literal) (fieldname2 ne \"literal\")`\n\nThe literal value is interpreted as a regular expression using GoogleRE2 library syntax.\nThe literal value must match the entire field.\n\nFor example, to filter for instances that do not end with name \"instance\",\nyou would use `name ne .*instance`.\n\nYou cannot combine constraints on multiple fields using regular\nexpressions.", +"location": "query", +"type": "string" +}, +"folder": { +"description": "Folder ID for this request.", +"location": "path", +"pattern": "folders/[0-9]{0,20}", +"required": true, +"type": "string" +}, +"maxResults": { +"default": "500", +"description": "The maximum number of results per page that should be returned.\nIf the number of available results is larger than `maxResults`,\nCompute Engine returns a `nextPageToken` that can be used to get\nthe next page of results in subsequent list requests. Acceptable values are\n`0` to `500`, inclusive. (Default: `500`)", +"format": "uint32", +"location": "query", +"minimum": "0", +"type": "integer" +}, +"orderBy": { +"description": "Sorts list results by a certain order. By default, results\nare returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation\ntimestamp using `orderBy=\"creationTimestamp desc\"`. This sorts\nresults based on the `creationTimestamp` field in\nreverse chronological order (newest result first). Use this to sort\nresources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or\n`creationTimestamp desc` is supported.", +"location": "query", +"type": "string" +}, +"pageToken": { +"description": "Specifies a page token to use. Set `pageToken` to the\n`nextPageToken` returned by a previous list request to get\nthe next page of results.", +"location": "query", +"type": "string" +}, +"returnPartialSuccess": { +"description": "Opt-in for partial success behavior which provides partial results in case\nof failure. The default value is false.\n\nFor example, when partial success behavior is enabled, aggregatedList for a\nsingle zone scope either returns all resources in the zone or no resources,\nwith an error code.", +"location": "query", +"type": "boolean" +}, +"zone": { +"description": "Name of the zone for this request.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", +"required": true, +"type": "string" +} +}, +"path": "{+folder}/zones/{zone}/vmExtensions", +"response": { +"$ref": "ListVmExtensionsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute", +"https://www.googleapis.com/auth/compute.readonly" +] +}, +"update": { +"description": "Modifies an existing zone VM extension policy within a folder.", +"flatPath": "folders/{foldersId}/zones/{zone}/vmExtensionPolicies/{vmExtensionPolicy}", +"httpMethod": "PATCH", +"id": "compute.folderZoneVmExtensionPolicies.update", +"parameterOrder": [ +"folder", +"zone", +"vmExtensionPolicy" +], +"parameters": { +"folder": { +"description": "Folder ID for this request.", +"location": "path", +"pattern": "folders/[0-9]{0,20}", +"required": true, +"type": "string" +}, +"requestId": { +"description": "An optional request ID to identify requests. Specify a unique request ID so\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).", +"location": "query", +"type": "string" +}, +"vmExtensionPolicy": { +"description": "Name of the zone VM extension policy to update.", +"location": "path", +"required": true, +"type": "string" +}, +"zone": { +"description": "Name of the zone for this request.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", +"required": true, +"type": "string" +} +}, +"path": "{+folder}/zones/{zone}/vmExtensionPolicies/{vmExtensionPolicy}", +"request": { +"$ref": "VmExtensionPolicy" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute" +] +} +} +}, "forwardingRules": { "methods": { "aggregatedList": { @@ -9866,7 +10218,7 @@ "imageViews": { "methods": { "get": { -"description": "Returns the specified global Image resource by providing a regional\ncontext to read the metadata from the Global Clone in the region.", +"description": "Returns the specified global ImageView resource, with a regional\ncontext.", "flatPath": "projects/{project}/regions/{region}/imageViews/{resourceId}", "httpMethod": "GET", "id": "compute.imageViews.get", @@ -9909,7 +10261,7 @@ ] }, "list": { -"description": "Retrieves the list of global Image resources available to the project by\nproviding a regional context to read the metadata from the Global Clone in\nthe region.", +"description": "Returns a list of global ImageView resources, with a regional\ncontext.", "flatPath": "projects/{project}/regions/{region}/imageViews", "httpMethod": "GET", "id": "compute.imageViews.list", @@ -24425,6 +24777,533 @@ } } }, +"orgVmExtensionPolicies": { +"methods": { +"delete": { +"description": "Deletes a specified zone VM extension policy within an organization.", +"flatPath": "organizations/{organizationsId}/zones/{zone}/vmExtensionPolicies/{vmExtensionPolicy}", +"httpMethod": "DELETE", +"id": "compute.orgVmExtensionPolicies.delete", +"parameterOrder": [ +"organization", +"zone", +"vmExtensionPolicy" +], +"parameters": { +"organization": { +"description": "Organization ID for this request.", +"location": "path", +"pattern": "organizations/[0-9]{0,20}", +"required": true, +"type": "string" +}, +"requestId": { +"description": "An optional request ID to identify requests. Specify a unique request ID so\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).", +"location": "query", +"type": "string" +}, +"vmExtensionPolicy": { +"description": "Name of the zone VM extension policy to delete.", +"location": "path", +"required": true, +"type": "string" +}, +"zone": { +"description": "Name of the zone for this request.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", +"required": true, +"type": "string" +} +}, +"path": "{+organization}/zones/{zone}/vmExtensionPolicies/{vmExtensionPolicy}", +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute" +] +} +} +}, +"organizationRolloutPlans": { +"methods": { +"delete": { +"description": "Deletes an OrganizationRolloutPlan.", +"flatPath": "organizations/{organizationsId}/global/rolloutPlans/{rolloutPlan}", +"httpMethod": "DELETE", +"id": "compute.organizationRolloutPlans.delete", +"parameterOrder": [ +"organization", +"rolloutPlan" +], +"parameters": { +"organization": { +"description": "Organization ID for this request.", +"location": "path", +"pattern": "organizations/[0-9]{0,20}", +"required": true, +"type": "string" +}, +"requestId": { +"description": "An optional request ID to identify requests. Specify a unique request ID so\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).", +"location": "query", +"type": "string" +}, +"rolloutPlan": { +"description": "Name of the OrganizationRolloutPlan resource to delete.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", +"required": true, +"type": "string" +} +}, +"path": "{+organization}/global/rolloutPlans/{rolloutPlan}", +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute" +] +}, +"get": { +"description": "Gets details of a single organization-scoped RolloutPlan.", +"flatPath": "organizations/{organizationsId}/global/rolloutPlans/{rolloutPlan}", +"httpMethod": "GET", +"id": "compute.organizationRolloutPlans.get", +"parameterOrder": [ +"organization", +"rolloutPlan" +], +"parameters": { +"organization": { +"description": "Organization ID for this request.", +"location": "path", +"pattern": "organizations/[0-9]{0,20}", +"required": true, +"type": "string" +}, +"rolloutPlan": { +"description": "Name of the persistent rollout plan to return.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", +"required": true, +"type": "string" +} +}, +"path": "{+organization}/global/rolloutPlans/{rolloutPlan}", +"response": { +"$ref": "RolloutPlan" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute", +"https://www.googleapis.com/auth/compute.readonly" +] +}, +"insert": { +"description": "Creates a new RolloutPlan in a given organization and location.", +"flatPath": "organizations/{organizationsId}/global/rolloutPlans", +"httpMethod": "POST", +"id": "compute.organizationRolloutPlans.insert", +"parameterOrder": [ +"organization" +], +"parameters": { +"organization": { +"description": "Organization ID for this request.", +"location": "path", +"pattern": "organizations/[0-9]{0,20}", +"required": true, +"type": "string" +}, +"requestId": { +"description": "An optional request ID to identify requests. Specify a unique request ID so\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).", +"location": "query", +"type": "string" +} +}, +"path": "{+organization}/global/rolloutPlans", +"request": { +"$ref": "RolloutPlan" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute" +] +}, +"list": { +"description": "Lists OrganizationRolloutPlans in a given organization and location.", +"flatPath": "organizations/{organizationsId}/global/rolloutPlans", +"httpMethod": "GET", +"id": "compute.organizationRolloutPlans.list", +"parameterOrder": [ +"organization" +], +"parameters": { +"filter": { +"description": "A filter expression that filters resources listed in the response. Most\nCompute resources support two types of filter expressions:\nexpressions that support regular expressions and expressions that follow\nAPI improvement proposal AIP-160.\nThese two types of filter expressions cannot be mixed in one request.\n\nIf you want to use AIP-160, your expression must specify the field name, an\noperator, and the value that you want to use for filtering. The value\nmust be a string, a number, or a boolean. The operator\nmust be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.\n\nFor example, if you are filtering Compute Engine instances, you can\nexclude instances named `example-instance` by specifying\n`name != example-instance`.\n\nThe `:*` comparison can be used to test whether a key has been defined.\nFor example, to find all objects with `owner` label use:\n```\nlabels.owner:*\n```\n\nYou can also filter nested fields. For example, you could specify\n`scheduling.automaticRestart = false` to include instances only\nif they are not scheduled for automatic restarts. You can use filtering\non nested fields to filter based onresource labels.\n\nTo filter on multiple expressions, provide each separate expression within\nparentheses. For example:\n```\n(scheduling.automaticRestart = true)\n(cpuPlatform = \"Intel Skylake\")\n```\nBy default, each expression is an `AND` expression. However, you\ncan include `AND` and `OR` expressions explicitly.\nFor example:\n```\n(cpuPlatform = \"Intel Skylake\") OR\n(cpuPlatform = \"Intel Broadwell\") AND\n(scheduling.automaticRestart = true)\n```\n\nIf you want to use a regular expression, use the `eq` (equal) or `ne`\n(not equal) operator against a single un-parenthesized expression with or\nwithout quotes or against multiple parenthesized expressions. Examples:\n\n`fieldname eq unquoted literal`\n`fieldname eq 'single quoted literal'`\n`fieldname eq \"double quoted literal\"`\n`(fieldname1 eq literal) (fieldname2 ne \"literal\")`\n\nThe literal value is interpreted as a regular expression using GoogleRE2 library syntax.\nThe literal value must match the entire field.\n\nFor example, to filter for instances that do not end with name \"instance\",\nyou would use `name ne .*instance`.\n\nYou cannot combine constraints on multiple fields using regular\nexpressions.", +"location": "query", +"type": "string" +}, +"maxResults": { +"default": "500", +"description": "The maximum number of results per page that should be returned.\nIf the number of available results is larger than `maxResults`,\nCompute Engine returns a `nextPageToken` that can be used to get\nthe next page of results in subsequent list requests. Acceptable values are\n`0` to `500`, inclusive. (Default: `500`)", +"format": "uint32", +"location": "query", +"minimum": "0", +"type": "integer" +}, +"orderBy": { +"description": "Sorts list results by a certain order. By default, results\nare returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation\ntimestamp using `orderBy=\"creationTimestamp desc\"`. This sorts\nresults based on the `creationTimestamp` field in\nreverse chronological order (newest result first). Use this to sort\nresources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or\n`creationTimestamp desc` is supported.", +"location": "query", +"type": "string" +}, +"organization": { +"description": "Organization ID for this request.", +"location": "path", +"pattern": "organizations/[0-9]{0,20}", +"required": true, +"type": "string" +}, +"pageToken": { +"description": "Specifies a page token to use. Set `pageToken` to the\n`nextPageToken` returned by a previous list request to get\nthe next page of results.", +"location": "query", +"type": "string" +}, +"returnPartialSuccess": { +"description": "Opt-in for partial success behavior which provides partial results in case\nof failure. The default value is false.\n\nFor example, when partial success behavior is enabled, aggregatedList for a\nsingle zone scope either returns all resources in the zone or no resources,\nwith an error code.", +"location": "query", +"type": "boolean" +} +}, +"path": "{+organization}/global/rolloutPlans", +"response": { +"$ref": "RolloutPlansListResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute", +"https://www.googleapis.com/auth/compute.readonly" +] +} +} +}, +"organizationRollouts": { +"methods": { +"advance": { +"description": "Advances a Rollout to the next wave, or completes it if no waves remain.", +"flatPath": "organizations/{organizationsId}/global/rollouts/{rollout}/advance", +"httpMethod": "POST", +"id": "compute.organizationRollouts.advance", +"parameterOrder": [ +"organization", +"rollout" +], +"parameters": { +"currentWaveNumber": { +"description": "Required. Wave number of the current wave.", +"format": "int64", +"location": "query", +"type": "string" +}, +"organization": { +"description": "Required. Organization ID for this request.", +"location": "path", +"pattern": "organizations/[0-9]{1,19}", +"required": true, +"type": "string" +}, +"requestId": { +"description": "An optional request ID to identify requests. Specify a unique request ID so\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).", +"location": "query", +"type": "string" +}, +"rollout": { +"description": "Required. Name of the Rollout resource to advance.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", +"required": true, +"type": "string" +} +}, +"path": "{+organization}/global/rollouts/{rollout}/advance", +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute" +] +}, +"cancel": { +"description": "Cancels a Rollout.", +"flatPath": "organizations/{organizationsId}/global/rollouts/{rollout}", +"httpMethod": "PATCH", +"id": "compute.organizationRollouts.cancel", +"parameterOrder": [ +"organization", +"rollout" +], +"parameters": { +"organization": { +"description": "Required. Organization ID for this request.", +"location": "path", +"pattern": "organizations/[0-9]{1,19}", +"required": true, +"type": "string" +}, +"requestId": { +"description": "An optional request ID to identify requests. Specify a unique request ID so\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).", +"location": "query", +"type": "string" +}, +"rollback": { +"description": "Optional. If true, then the ongoing rollout must be rolled back. Else, just cancel\nthe rollout without taking any further actions. Note that products must\nsupport at least one of these options, however, it does not need to support\nboth.", +"location": "query", +"type": "boolean" +}, +"rollout": { +"description": "Name of the Rollout resource to cancel.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", +"required": true, +"type": "string" +} +}, +"path": "{+organization}/global/rollouts/{rollout}", +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute" +] +}, +"delete": { +"description": "Deletes a Rollout.", +"flatPath": "organizations/{organizationsId}/global/rollouts/{rollout}", +"httpMethod": "DELETE", +"id": "compute.organizationRollouts.delete", +"parameterOrder": [ +"organization", +"rollout" +], +"parameters": { +"organization": { +"description": "Required. Organization ID for this request.", +"location": "path", +"pattern": "organizations/[0-9]{1,19}", +"required": true, +"type": "string" +}, +"requestId": { +"description": "An optional request ID to identify requests. Specify a unique request ID so\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).", +"location": "query", +"type": "string" +}, +"rollout": { +"description": "Name of the Rollout resource to delete.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", +"required": true, +"type": "string" +} +}, +"path": "{+organization}/global/rollouts/{rollout}", +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute" +] +}, +"get": { +"description": "Gets details of a single organization-scoped Rollout.", +"flatPath": "organizations/{organizationsId}/global/rollouts/{rollout}", +"httpMethod": "GET", +"id": "compute.organizationRollouts.get", +"parameterOrder": [ +"organization", +"rollout" +], +"parameters": { +"organization": { +"description": "Organization ID for this request.", +"location": "path", +"pattern": "organizations/[0-9]{0,20}", +"required": true, +"type": "string" +}, +"rollout": { +"description": "Name of the persistent rollout to return.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", +"required": true, +"type": "string" +} +}, +"path": "{+organization}/global/rollouts/{rollout}", +"response": { +"$ref": "Rollout" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute", +"https://www.googleapis.com/auth/compute.readonly" +] +}, +"list": { +"description": "Lists Rollouts in a given organization and location.", +"flatPath": "organizations/{organizationsId}/global/rollouts", +"httpMethod": "GET", +"id": "compute.organizationRollouts.list", +"parameterOrder": [ +"organization" +], +"parameters": { +"filter": { +"description": "A filter expression that filters resources listed in the response. Most\nCompute resources support two types of filter expressions:\nexpressions that support regular expressions and expressions that follow\nAPI improvement proposal AIP-160.\nThese two types of filter expressions cannot be mixed in one request.\n\nIf you want to use AIP-160, your expression must specify the field name, an\noperator, and the value that you want to use for filtering. The value\nmust be a string, a number, or a boolean. The operator\nmust be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.\n\nFor example, if you are filtering Compute Engine instances, you can\nexclude instances named `example-instance` by specifying\n`name != example-instance`.\n\nThe `:*` comparison can be used to test whether a key has been defined.\nFor example, to find all objects with `owner` label use:\n```\nlabels.owner:*\n```\n\nYou can also filter nested fields. For example, you could specify\n`scheduling.automaticRestart = false` to include instances only\nif they are not scheduled for automatic restarts. You can use filtering\non nested fields to filter based onresource labels.\n\nTo filter on multiple expressions, provide each separate expression within\nparentheses. For example:\n```\n(scheduling.automaticRestart = true)\n(cpuPlatform = \"Intel Skylake\")\n```\nBy default, each expression is an `AND` expression. However, you\ncan include `AND` and `OR` expressions explicitly.\nFor example:\n```\n(cpuPlatform = \"Intel Skylake\") OR\n(cpuPlatform = \"Intel Broadwell\") AND\n(scheduling.automaticRestart = true)\n```\n\nIf you want to use a regular expression, use the `eq` (equal) or `ne`\n(not equal) operator against a single un-parenthesized expression with or\nwithout quotes or against multiple parenthesized expressions. Examples:\n\n`fieldname eq unquoted literal`\n`fieldname eq 'single quoted literal'`\n`fieldname eq \"double quoted literal\"`\n`(fieldname1 eq literal) (fieldname2 ne \"literal\")`\n\nThe literal value is interpreted as a regular expression using GoogleRE2 library syntax.\nThe literal value must match the entire field.\n\nFor example, to filter for instances that do not end with name \"instance\",\nyou would use `name ne .*instance`.\n\nYou cannot combine constraints on multiple fields using regular\nexpressions.", +"location": "query", +"type": "string" +}, +"maxResults": { +"default": "500", +"description": "The maximum number of results per page that should be returned.\nIf the number of available results is larger than `maxResults`,\nCompute Engine returns a `nextPageToken` that can be used to get\nthe next page of results in subsequent list requests. Acceptable values are\n`0` to `500`, inclusive. (Default: `500`)", +"format": "uint32", +"location": "query", +"minimum": "0", +"type": "integer" +}, +"orderBy": { +"description": "Sorts list results by a certain order. By default, results\nare returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation\ntimestamp using `orderBy=\"creationTimestamp desc\"`. This sorts\nresults based on the `creationTimestamp` field in\nreverse chronological order (newest result first). Use this to sort\nresources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or\n`creationTimestamp desc` is supported.", +"location": "query", +"type": "string" +}, +"organization": { +"description": "Required. Organization ID for this request.", +"location": "path", +"pattern": "organizations/[0-9]{1,19}", +"required": true, +"type": "string" +}, +"pageToken": { +"description": "Specifies a page token to use. Set `pageToken` to the\n`nextPageToken` returned by a previous list request to get\nthe next page of results.", +"location": "query", +"type": "string" +}, +"returnPartialSuccess": { +"description": "Opt-in for partial success behavior which provides partial results in case\nof failure. The default value is false.\n\nFor example, when partial success behavior is enabled, aggregatedList for a\nsingle zone scope either returns all resources in the zone or no resources,\nwith an error code.", +"location": "query", +"type": "boolean" +} +}, +"path": "{+organization}/global/rollouts", +"response": { +"$ref": "OrganizationRolloutsListResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute", +"https://www.googleapis.com/auth/compute.readonly" +] +}, +"pause": { +"description": "Pauses a Rollout.", +"flatPath": "organizations/{organizationsId}/global/rollouts/{rollout}/pause", +"httpMethod": "POST", +"id": "compute.organizationRollouts.pause", +"parameterOrder": [ +"organization", +"rollout" +], +"parameters": { +"etag": { +"description": "The etag of the Rollout.\nIf this is provided, the request will only succeed if the etag matches\nthe current etag of the Rollout.", +"location": "query", +"type": "string" +}, +"organization": { +"description": "Required. Organization ID for this request.", +"location": "path", +"pattern": "organizations/[0-9]{1,19}", +"required": true, +"type": "string" +}, +"requestId": { +"description": "An optional request ID to identify requests. Specify a unique request ID so\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).", +"location": "query", +"type": "string" +}, +"rollout": { +"description": "Required. Name of the Rollout resource to pause.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", +"required": true, +"type": "string" +} +}, +"path": "{+organization}/global/rollouts/{rollout}/pause", +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute" +] +}, +"resume": { +"description": "Resumes a Rollout.", +"flatPath": "organizations/{organizationsId}/global/rollouts/{rollout}/resume", +"httpMethod": "POST", +"id": "compute.organizationRollouts.resume", +"parameterOrder": [ +"organization", +"rollout" +], +"parameters": { +"etag": { +"description": "The etag of the Rollout.\nIf this is provided, the request will only succeed if the etag matches\nthe current etag of the Rollout.", +"location": "query", +"type": "string" +}, +"organization": { +"description": "Required. Organization ID for this request.", +"location": "path", +"pattern": "organizations/[0-9]{1,19}", +"required": true, +"type": "string" +}, +"requestId": { +"description": "An optional request ID to identify requests. Specify a unique request ID so\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).", +"location": "query", +"type": "string" +}, +"rollout": { +"description": "Required. Name of the Rollout resource to resume.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", +"required": true, +"type": "string" +} +}, +"path": "{+organization}/global/rollouts/{rollout}/resume", +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute" +] +} +} +}, "organizationSecurityPolicies": { "methods": { "addAssociation": { @@ -25072,6 +25951,312 @@ } } }, +"organizationZoneVmExtensionPolicies": { +"methods": { +"get": { +"description": "Retrieves details of a specific zone VM extension policy within an\norganization.", +"flatPath": "organizations/{organizationsId}/zones/{zone}/vmExtensionPolicies/{vmExtensionPolicy}", +"httpMethod": "GET", +"id": "compute.organizationZoneVmExtensionPolicies.get", +"parameterOrder": [ +"organization", +"zone", +"vmExtensionPolicy" +], +"parameters": { +"organization": { +"description": "Organization ID for this request.", +"location": "path", +"pattern": "organizations/[0-9]{0,20}", +"required": true, +"type": "string" +}, +"vmExtensionPolicy": { +"description": "Name of the VM extension policy resource to return.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", +"required": true, +"type": "string" +}, +"zone": { +"description": "Name of the zone for this request.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", +"required": true, +"type": "string" +} +}, +"path": "{+organization}/zones/{zone}/vmExtensionPolicies/{vmExtensionPolicy}", +"response": { +"$ref": "VmExtensionPolicy" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute", +"https://www.googleapis.com/auth/compute.readonly" +] +}, +"getVmExtension": { +"description": "Retrieves details of a specific VM extension within an organization.", +"flatPath": "organizations/{organizationsId}/zones/{zone}/vmExtensions/{extensionName}", +"httpMethod": "GET", +"id": "compute.organizationZoneVmExtensionPolicies.getVmExtension", +"parameterOrder": [ +"organization", +"zone", +"extensionName" +], +"parameters": { +"extensionName": { +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", +"required": true, +"type": "string" +}, +"organization": { +"description": "Organization ID for this request.", +"location": "path", +"pattern": "organizations/[0-9]{0,20}", +"required": true, +"type": "string" +}, +"zone": { +"description": "Name of the zone for this request.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", +"required": true, +"type": "string" +} +}, +"path": "{+organization}/zones/{zone}/vmExtensions/{extensionName}", +"response": { +"$ref": "VmExtension" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute", +"https://www.googleapis.com/auth/compute.readonly" +] +}, +"insert": { +"description": "Creates a new zone-level VM extension policy within an organization.", +"flatPath": "organizations/{organizationsId}/zones/{zone}/vmExtensionPolicies", +"httpMethod": "POST", +"id": "compute.organizationZoneVmExtensionPolicies.insert", +"parameterOrder": [ +"organization", +"zone" +], +"parameters": { +"organization": { +"description": "Organization ID for this request.", +"location": "path", +"pattern": "organizations/[0-9]{0,20}", +"required": true, +"type": "string" +}, +"requestId": { +"description": "An optional request ID to identify requests. Specify a unique request ID so\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).", +"location": "query", +"type": "string" +}, +"zone": { +"description": "Name of the zone for this request.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", +"required": true, +"type": "string" +} +}, +"path": "{+organization}/zones/{zone}/vmExtensionPolicies", +"request": { +"$ref": "VmExtensionPolicy" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute" +] +}, +"list": { +"description": "Lists all VM extension policies within a specific zone for an organization.", +"flatPath": "organizations/{organizationsId}/zones/{zone}/vmExtensionPolicies", +"httpMethod": "GET", +"id": "compute.organizationZoneVmExtensionPolicies.list", +"parameterOrder": [ +"organization", +"zone" +], +"parameters": { +"filter": { +"description": "A filter expression that filters resources listed in the response. Most\nCompute resources support two types of filter expressions:\nexpressions that support regular expressions and expressions that follow\nAPI improvement proposal AIP-160.\nThese two types of filter expressions cannot be mixed in one request.\n\nIf you want to use AIP-160, your expression must specify the field name, an\noperator, and the value that you want to use for filtering. The value\nmust be a string, a number, or a boolean. The operator\nmust be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.\n\nFor example, if you are filtering Compute Engine instances, you can\nexclude instances named `example-instance` by specifying\n`name != example-instance`.\n\nThe `:*` comparison can be used to test whether a key has been defined.\nFor example, to find all objects with `owner` label use:\n```\nlabels.owner:*\n```\n\nYou can also filter nested fields. For example, you could specify\n`scheduling.automaticRestart = false` to include instances only\nif they are not scheduled for automatic restarts. You can use filtering\non nested fields to filter based onresource labels.\n\nTo filter on multiple expressions, provide each separate expression within\nparentheses. For example:\n```\n(scheduling.automaticRestart = true)\n(cpuPlatform = \"Intel Skylake\")\n```\nBy default, each expression is an `AND` expression. However, you\ncan include `AND` and `OR` expressions explicitly.\nFor example:\n```\n(cpuPlatform = \"Intel Skylake\") OR\n(cpuPlatform = \"Intel Broadwell\") AND\n(scheduling.automaticRestart = true)\n```\n\nIf you want to use a regular expression, use the `eq` (equal) or `ne`\n(not equal) operator against a single un-parenthesized expression with or\nwithout quotes or against multiple parenthesized expressions. Examples:\n\n`fieldname eq unquoted literal`\n`fieldname eq 'single quoted literal'`\n`fieldname eq \"double quoted literal\"`\n`(fieldname1 eq literal) (fieldname2 ne \"literal\")`\n\nThe literal value is interpreted as a regular expression using GoogleRE2 library syntax.\nThe literal value must match the entire field.\n\nFor example, to filter for instances that do not end with name \"instance\",\nyou would use `name ne .*instance`.\n\nYou cannot combine constraints on multiple fields using regular\nexpressions.", +"location": "query", +"type": "string" +}, +"maxResults": { +"default": "500", +"description": "The maximum number of results per page that should be returned.\nIf the number of available results is larger than `maxResults`,\nCompute Engine returns a `nextPageToken` that can be used to get\nthe next page of results in subsequent list requests. Acceptable values are\n`0` to `500`, inclusive. (Default: `500`)", +"format": "uint32", +"location": "query", +"minimum": "0", +"type": "integer" +}, +"orderBy": { +"description": "Sorts list results by a certain order. By default, results\nare returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation\ntimestamp using `orderBy=\"creationTimestamp desc\"`. This sorts\nresults based on the `creationTimestamp` field in\nreverse chronological order (newest result first). Use this to sort\nresources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or\n`creationTimestamp desc` is supported.", +"location": "query", +"type": "string" +}, +"organization": { +"description": "Organization ID for this request.", +"location": "path", +"pattern": "organizations/[0-9]{0,20}", +"required": true, +"type": "string" +}, +"pageToken": { +"description": "Specifies a page token to use. Set `pageToken` to the\n`nextPageToken` returned by a previous list request to get\nthe next page of results.", +"location": "query", +"type": "string" +}, +"returnPartialSuccess": { +"description": "Opt-in for partial success behavior which provides partial results in case\nof failure. The default value is false.\n\nFor example, when partial success behavior is enabled, aggregatedList for a\nsingle zone scope either returns all resources in the zone or no resources,\nwith an error code.", +"location": "query", +"type": "boolean" +}, +"zone": { +"description": "Name of the zone for this request.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", +"required": true, +"type": "string" +} +}, +"path": "{+organization}/zones/{zone}/vmExtensionPolicies", +"response": { +"$ref": "VmExtensionPolicyList" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute", +"https://www.googleapis.com/auth/compute.readonly" +] +}, +"listVmExtensions": { +"description": "Lists all VM extensions within a specific zone for an organization.\nThis is a read-only API.", +"flatPath": "organizations/{organizationsId}/zones/{zone}/vmExtensions", +"httpMethod": "GET", +"id": "compute.organizationZoneVmExtensionPolicies.listVmExtensions", +"parameterOrder": [ +"organization", +"zone" +], +"parameters": { +"filter": { +"description": "A filter expression that filters resources listed in the response. Most\nCompute resources support two types of filter expressions:\nexpressions that support regular expressions and expressions that follow\nAPI improvement proposal AIP-160.\nThese two types of filter expressions cannot be mixed in one request.\n\nIf you want to use AIP-160, your expression must specify the field name, an\noperator, and the value that you want to use for filtering. The value\nmust be a string, a number, or a boolean. The operator\nmust be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.\n\nFor example, if you are filtering Compute Engine instances, you can\nexclude instances named `example-instance` by specifying\n`name != example-instance`.\n\nThe `:*` comparison can be used to test whether a key has been defined.\nFor example, to find all objects with `owner` label use:\n```\nlabels.owner:*\n```\n\nYou can also filter nested fields. For example, you could specify\n`scheduling.automaticRestart = false` to include instances only\nif they are not scheduled for automatic restarts. You can use filtering\non nested fields to filter based onresource labels.\n\nTo filter on multiple expressions, provide each separate expression within\nparentheses. For example:\n```\n(scheduling.automaticRestart = true)\n(cpuPlatform = \"Intel Skylake\")\n```\nBy default, each expression is an `AND` expression. However, you\ncan include `AND` and `OR` expressions explicitly.\nFor example:\n```\n(cpuPlatform = \"Intel Skylake\") OR\n(cpuPlatform = \"Intel Broadwell\") AND\n(scheduling.automaticRestart = true)\n```\n\nIf you want to use a regular expression, use the `eq` (equal) or `ne`\n(not equal) operator against a single un-parenthesized expression with or\nwithout quotes or against multiple parenthesized expressions. Examples:\n\n`fieldname eq unquoted literal`\n`fieldname eq 'single quoted literal'`\n`fieldname eq \"double quoted literal\"`\n`(fieldname1 eq literal) (fieldname2 ne \"literal\")`\n\nThe literal value is interpreted as a regular expression using GoogleRE2 library syntax.\nThe literal value must match the entire field.\n\nFor example, to filter for instances that do not end with name \"instance\",\nyou would use `name ne .*instance`.\n\nYou cannot combine constraints on multiple fields using regular\nexpressions.", +"location": "query", +"type": "string" +}, +"maxResults": { +"default": "500", +"description": "The maximum number of results per page that should be returned.\nIf the number of available results is larger than `maxResults`,\nCompute Engine returns a `nextPageToken` that can be used to get\nthe next page of results in subsequent list requests. Acceptable values are\n`0` to `500`, inclusive. (Default: `500`)", +"format": "uint32", +"location": "query", +"minimum": "0", +"type": "integer" +}, +"orderBy": { +"description": "Sorts list results by a certain order. By default, results\nare returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation\ntimestamp using `orderBy=\"creationTimestamp desc\"`. This sorts\nresults based on the `creationTimestamp` field in\nreverse chronological order (newest result first). Use this to sort\nresources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or\n`creationTimestamp desc` is supported.", +"location": "query", +"type": "string" +}, +"organization": { +"description": "Organization ID for this request.", +"location": "path", +"pattern": "organizations/[0-9]{0,20}", +"required": true, +"type": "string" +}, +"pageToken": { +"description": "Specifies a page token to use. Set `pageToken` to the\n`nextPageToken` returned by a previous list request to get\nthe next page of results.", +"location": "query", +"type": "string" +}, +"returnPartialSuccess": { +"description": "Opt-in for partial success behavior which provides partial results in case\nof failure. The default value is false.\n\nFor example, when partial success behavior is enabled, aggregatedList for a\nsingle zone scope either returns all resources in the zone or no resources,\nwith an error code.", +"location": "query", +"type": "boolean" +}, +"zone": { +"description": "Name of the zone for this request.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", +"required": true, +"type": "string" +} +}, +"path": "{+organization}/zones/{zone}/vmExtensions", +"response": { +"$ref": "ListVmExtensionsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute", +"https://www.googleapis.com/auth/compute.readonly" +] +}, +"update": { +"description": "Modifies an existing zone VM extension policy within an organization.", +"flatPath": "organizations/{organizationsId}/zones/{zone}/vmExtensionPolicies/{vmExtensionPolicy}", +"httpMethod": "PATCH", +"id": "compute.organizationZoneVmExtensionPolicies.update", +"parameterOrder": [ +"organization", +"zone", +"vmExtensionPolicy" +], +"parameters": { +"organization": { +"description": "Organization ID for this request.", +"location": "path", +"pattern": "organizations/[0-9]{0,20}", +"required": true, +"type": "string" +}, +"requestId": { +"description": "An optional request ID to identify requests. Specify a unique request ID so\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).", +"location": "query", +"type": "string" +}, +"vmExtensionPolicy": { +"description": "Name of the zone VM extension policy to update.", +"location": "path", +"required": true, +"type": "string" +}, +"zone": { +"description": "Name of the zone for this request.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", +"required": true, +"type": "string" +} +}, +"path": "{+organization}/zones/{zone}/vmExtensionPolicies/{vmExtensionPolicy}", +"request": { +"$ref": "VmExtensionPolicy" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute" +] +} +} +}, "packetMirrorings": { "methods": { "aggregatedList": { @@ -55121,7 +56306,7 @@ } } }, -"revision": "20260501", +"revision": "20260520", "rootUrl": "https://compute.googleapis.com/", "schemas": { "AWSV4Signature": { @@ -56600,7 +57785,8 @@ false "VM_FAMILY_CLOUD_TPU_POD_SLICE_CT4P", "VM_FAMILY_CLOUD_TPU_POD_SLICE_CT5P", "VM_FAMILY_CLOUD_TPU_POD_SLICE_TPU7", -"VM_FAMILY_CLOUD_TPU_POD_SLICE_TPU7X" +"VM_FAMILY_CLOUD_TPU_POD_SLICE_TPU7X", +"VM_FAMILY_CLOUD_TPU_POD_SLICE_TPU8I_METAL" ], "enumDescriptions": [ "", @@ -56611,6 +57797,7 @@ false "", "", "", +"", "" ], "type": "string" @@ -57960,7 +59147,7 @@ false "Do not automatically scale the MIG in or out.\nThe recommended_size field contains the size of MIG that would be set if\nthe actuation mode was enabled.", "Automatically scale the MIG in and out according to the policy.", "Automatically create VMs according to the policy, but do not scale\nthe MIG in.", -"Automatically create VMs according to the policy, but do not scale\nthe MIG in." +"Automatically create VMs according to the policy, but do not scale\nthe MIG in.\nIt's recommended to use ONLY_SCALE_OUT instead of ONLY_UP." ], "type": "string" }, @@ -60470,6 +61657,20 @@ false "description": "Denotes whether to enable logging for the load balancer\ntraffic served by this backend service. The default value is false.", "type": "boolean" }, +"loggingHttpRequestHeaders": { +"description": "The list of request headers that will be logged to Stackdriver.", +"items": { +"$ref": "BackendServiceLogConfigLoggingHttpHeader" +}, +"type": "array" +}, +"loggingHttpResponseHeaders": { +"description": "The list of response headers that will be logged to Stackdriver.", +"items": { +"$ref": "BackendServiceLogConfigLoggingHttpHeader" +}, +"type": "array" +}, "optional": { "deprecated": true, "description": "Deprecated in favor of optionalMode.\nThis field can only be specified if logging is enabled for this backend\nservice. Configures whether all, none or a subset of optional fields\nshould be added to the reported logs. One of [INCLUDE_ALL_OPTIONAL,\nEXCLUDE_ALL_OPTIONAL, CUSTOM]. Default is EXCLUDE_ALL_OPTIONAL.", @@ -60518,6 +61719,17 @@ false }, "type": "object" }, +"BackendServiceLogConfigLoggingHttpHeader": { +"description": "Determines which HTTP headers will be logged to Stackdriver.", +"id": "BackendServiceLogConfigLoggingHttpHeader", +"properties": { +"headerName": { +"description": "The name of the header to be logged.", +"type": "string" +} +}, +"type": "object" +}, "BackendServiceNetworkPassThroughLbTrafficPolicy": { "id": "BackendServiceNetworkPassThroughLbTrafficPolicy", "properties": { @@ -62287,6 +63499,7 @@ false "ACCELERATOR_OPTIMIZED_A4", "ACCELERATOR_OPTIMIZED_A4X", "ACCELERATOR_OPTIMIZED_A4X_MAX", +"ACCELERATOR_OPTIMIZED_A5X", "COMPUTE_OPTIMIZED", "COMPUTE_OPTIMIZED_C2D", "COMPUTE_OPTIMIZED_C3", @@ -62322,6 +63535,7 @@ false "MEMORY_OPTIMIZED_X4_960_12T", "MEMORY_OPTIMIZED_X4_960_16T", "STORAGE_OPTIMIZED_Z3", +"STORAGE_OPTIMIZED_Z4D", "TYPE_UNSPECIFIED" ], "enumDescriptions": [ @@ -62357,6 +63571,7 @@ false "", "", "", +"", "CUD bucket for X4 machine with 1440 vCPUs and 24TB of memory.", "", "CUD bucket for X4 machine with 1920 vCPUs and 32TB of memory.", @@ -62367,6 +63582,7 @@ false "CUD bucket for X4 machine with 960 vCPUs and 12TB of memory.", "CUD bucket for X4 machine with 960 vCPUs and 16TB of memory.", "", +"CUD bucket for Z4D machines.", "Note for internal users: When adding a new enum Type for v1, make sure\nto also add it in the comment for the `optional Type type` definition.\nThis ensures that the public documentation displays the new enum Type." ], "type": "string" @@ -69637,7 +70853,8 @@ false "VM_FAMILY_CLOUD_TPU_POD_SLICE_CT4P", "VM_FAMILY_CLOUD_TPU_POD_SLICE_CT5P", "VM_FAMILY_CLOUD_TPU_POD_SLICE_TPU7", -"VM_FAMILY_CLOUD_TPU_POD_SLICE_TPU7X" +"VM_FAMILY_CLOUD_TPU_POD_SLICE_TPU7X", +"VM_FAMILY_CLOUD_TPU_POD_SLICE_TPU8I_METAL" ], "enumDescriptions": [ "", @@ -69648,6 +70865,7 @@ false "", "", "", +"", "" ], "type": "string" @@ -71635,12 +72853,6 @@ false "description": "Name of the destination zone for the failover.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "type": "string" -}, -"primaryZone": { -"deprecated": true, -"description": "Name of the destination zone for the failover.\nDeprecated: use failover_to_zone instead.", -"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", -"type": "string" } }, "type": "object" @@ -79021,6 +80233,27 @@ false "InstanceGroupManagerUpdatePolicy": { "id": "InstanceGroupManagerUpdatePolicy", "properties": { +"allowedActions": { +"description": "Actions that are allowed to update instances within MIG.", +"items": { +"enum": [ +"NONE", +"REFRESH", +"REPLACE", +"RESTART", +"RESTART_IN_PLACE" +], +"enumDescriptions": [ +"Do not perform any action.", +"Do not stop the instance.", +"(Default.) Replace the instance according to the replacement method\noption.", +"Stop the instance and start it again.", +"Restart the instance using the same capacity and preserving local SSDs." +], +"type": "string" +}, +"type": "array" +}, "disruptionMode": { "description": "Whether the boot disk is allowed to be updated with restart.", "enum": [ @@ -79164,6 +80397,27 @@ false "description": "Flag to update all instances instead of specified list of \u201cinstances\u201d.\nIf the flag is set to true then the instances may not be specified\nin the request.", "type": "boolean" }, +"allowedActions": { +"description": "Actions that are allowed to update instances within MIG.", +"items": { +"enum": [ +"NONE", +"REFRESH", +"REPLACE", +"RESTART", +"RESTART_IN_PLACE" +], +"enumDescriptions": [ +"Do not perform any action.", +"Do not stop the instance.", +"(Default.) Replace the instance according to the replacement method\noption.", +"Stop the instance and start it again.", +"Restart the instance using the same capacity and preserving local SSDs." +], +"type": "string" +}, +"type": "array" +}, "disruptionMode": { "description": "Whether the boot disk is allowed to be updated with restart.", "enum": [ @@ -80650,16 +81904,16 @@ false "properties": { "error": { "$ref": "InstanceManagedByIgmErrorManagedInstanceError", -"description": "Output only. [Output Only] Contents of the error.", +"description": "Output only. Contents of the error.", "readOnly": true }, "instanceActionDetails": { "$ref": "InstanceManagedByIgmErrorInstanceActionDetails", -"description": "Output only. [Output Only] Details of the instance action that triggered this error.\nMay be null, if the error was not caused by an action on an instance.\nThis field is optional.", +"description": "Output only. Details of the instance action that triggered this error.\nMay be null, if the error was not caused by an action on an instance.\nThis field is optional.", "readOnly": true }, "timestamp": { -"description": "Output only. [Output Only] The time that this error occurred.\nThis value is in RFC3339 text format.", +"description": "Output only. The time that this error occurred. This value is in RFC3339 text format.", "readOnly": true, "type": "string" } @@ -80670,7 +81924,7 @@ false "id": "InstanceManagedByIgmErrorInstanceActionDetails", "properties": { "action": { -"description": "Output only. [Output Only] Action that managed instance group was executing on\nthe instance when the error occurred. Possible values:", +"description": "Output only. Action that managed instance group was executing on the instance when the\nerror occurred. Possible values:", "enum": [ "ABANDONING", "ADOPTING", @@ -80713,13 +81967,13 @@ false "type": "string" }, "instance": { -"description": "Output only. [Output Only] The URL of the instance.\nThe URL can be set even if the instance has not yet been created.", +"description": "Output only. The URL of the instance. The URL can be set even if the instance has not\nyet been created.", "readOnly": true, "type": "string" }, "version": { "$ref": "ManagedInstanceVersion", -"description": "Output only. [Output Only] Version this instance was created from, or was being\ncreated from, but the creation failed. Corresponds to one of the versions\nthat were set on the Instance Group Manager resource at the time this\ninstance was being created.", +"description": "Output only. Version this instance was created from, or was being\ncreated from, but the creation failed. Corresponds to one of the versions\nthat were set on the Instance Group Manager resource at the time this\ninstance was being created.", "readOnly": true } }, @@ -80729,12 +81983,12 @@ false "id": "InstanceManagedByIgmErrorManagedInstanceError", "properties": { "code": { -"description": "Output only. [Output Only] Error code.", +"description": "Output only. Error code.", "readOnly": true, "type": "string" }, "message": { -"description": "Output only. [Output Only] Error message.", +"description": "Output only. Error message.", "readOnly": true, "type": "string" } @@ -98975,6 +100229,167 @@ false }, "type": "object" }, +"OrganizationRolloutsListResponse": { +"id": "OrganizationRolloutsListResponse", +"properties": { +"etag": { +"type": "string" +}, +"id": { +"description": "[Output Only] Unique identifier for the resource; defined by the server.", +"type": "string" +}, +"items": { +"description": "A list of Rollout resources.", +"items": { +"$ref": "Rollout" +}, +"type": "array" +}, +"nextPageToken": { +"description": "[Output Only] This token allows you to get the next page of results for\nlist requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for\nthe query parameter pageToken in the next list request.\nSubsequent list requests will have their own nextPageToken to\ncontinue paging through the results.", +"type": "string" +}, +"selfLink": { +"description": "Output only. [Output Only] Server-defined URL for this resource.", +"readOnly": true, +"type": "string" +}, +"unreachables": { +"description": "Output only. [Output Only] Unreachable resources.\nend_interface: MixerListResponseWithEtagBuilder", +"items": { +"type": "string" +}, +"readOnly": true, +"type": "array" +}, +"warning": { +"description": "[Output Only] Informational warning message.", +"properties": { +"code": { +"description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare no results in the response.", +"enum": [ +"CLEANUP_FAILED", +"DEPRECATED_RESOURCE_USED", +"DEPRECATED_TYPE_USED", +"DISK_SIZE_LARGER_THAN_IMAGE_SIZE", +"EXPERIMENTAL_TYPE_USED", +"EXTERNAL_API_WARNING", +"FIELD_VALUE_OVERRIDEN", +"INJECTED_KERNELS_DEPRECATED", +"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB", +"LARGE_DEPLOYMENT_WARNING", +"LIST_OVERHEAD_QUOTA_EXCEED", +"MISSING_TYPE_DEPENDENCY", +"NEXT_HOP_ADDRESS_NOT_ASSIGNED", +"NEXT_HOP_CANNOT_IP_FORWARD", +"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE", +"NEXT_HOP_INSTANCE_NOT_FOUND", +"NEXT_HOP_INSTANCE_NOT_ON_NETWORK", +"NEXT_HOP_NOT_RUNNING", +"NOT_CRITICAL_ERROR", +"NO_RESULTS_ON_PAGE", +"PARTIAL_SUCCESS", +"QUOTA_INFO_UNAVAILABLE", +"REQUIRED_TOS_AGREEMENT", +"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING", +"RESOURCE_NOT_DELETED", +"SCHEMA_VALIDATION_IGNORED", +"SINGLE_INSTANCE_PROPERTY_TEMPLATE", +"UNDECLARED_PROPERTIES", +"UNREACHABLE" +], +"enumDeprecated": [ +false, +false, +false, +false, +false, +false, +true, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false +], +"enumDescriptions": [ +"Warning about failed cleanup of transient changes made by a failed\noperation.", +"A link to a deprecated resource was created.", +"When deploying and at least one of the resources has a type marked as\ndeprecated", +"The user created a boot disk that is larger than image size.", +"When deploying and at least one of the resources has a type marked as\nexperimental", +"Warning that is present in an external api call", +"Warning that value of a field has been overridden.\nDeprecated unused field.", +"The operation involved use of an injected kernel, which is deprecated.", +"A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.", +"When deploying a deployment with a exceedingly large number of resources", +"Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.", +"A resource depends on a missing type", +"The route's nextHopIp address is not assigned to an instance on the\nnetwork.", +"The route's next hop instance cannot ip forward.", +"The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.", +"The route's nextHopInstance URL refers to an instance that does not exist.", +"The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.", +"The route's next hop instance does not have a status of RUNNING.", +"Error which is not critical. We decided to continue the process despite\nthe mentioned error.", +"No results are present on a particular list page.", +"Success is reported, but some results may be missing due to errors", +"Quota information is not available to client requests (e.g:\nregions.list).", +"The user attempted to use a resource that requires a TOS they have not\naccepted.", +"Warning that a resource is in use.", +"One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.", +"When a resource schema validation is ignored.", +"Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.", +"When undeclared properties in the schema are present", +"A given scope cannot be reached." +], +"type": "string" +}, +"data": { +"description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n {\n \"key\": \"scope\",\n \"value\": \"zones/us-east1-d\"\n }", +"items": { +"properties": { +"key": { +"description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts to perform IP forwarding but is not enabled for IP forwarding).", +"type": "string" +}, +"value": { +"description": "[Output Only] A warning data value corresponding to the key.", +"type": "string" +} +}, +"type": "object" +}, +"type": "array" +}, +"message": { +"description": "[Output Only] A human-readable description of the warning code.", +"type": "string" +} +}, +"type": "object" +} +}, +"type": "object" +}, "OrganizationSecurityPoliciesListAssociationsResponse": { "id": "OrganizationSecurityPoliciesListAssociationsResponse", "properties": { @@ -99957,10 +101372,10 @@ false ], "enumDescriptions": [ "Default value.", -"A dedicated window for customers to perform their own maintenance. This\noften runs concurrently with a DISRUPTIVE_UPGRADE. This corresponds to\nthe Customer Maintenance Window for CME.", -"For disruptive updates, including host machine kernel or firmware\nupgrades. This corresponds to the Critical Services Maintenance Window\nfor CME.", -"A post-maintenance window for customers to conduct final testing and\nperformance validation before resuming full business operations. This\ncorresponds to Performance Stress Testing for CME.", -"For preliminary, non-disruptive tasks such as key rotations. This\ncorresponds to the Zone Swap Window for CME." +"A dedicated window for customers to perform their own maintenance. This\noften runs concurrently with a DISRUPTIVE_UPGRADE.", +"For disruptive updates, including host machine kernel or firmware\nupgrades.", +"A post-maintenance window for customers to conduct final testing and\nperformance validation before resuming full business operations.", +"For preliminary, non-disruptive tasks such as key rotations." ], "type": "string" }, @@ -105041,6 +106456,27 @@ false "description": "Flag to update all instances instead of specified list of \u201cinstances\u201d.\nIf the flag is set to true then the instances may not be specified\nin the request.", "type": "boolean" }, +"allowedActions": { +"description": "Actions that are allowed to update instances within MIG.", +"items": { +"enum": [ +"NONE", +"REFRESH", +"REPLACE", +"RESTART", +"RESTART_IN_PLACE" +], +"enumDescriptions": [ +"Do not perform any action.", +"Do not stop the instance.", +"(Default.) Replace the instance according to the replacement method\noption.", +"Stop the instance and start it again.", +"Restart the instance using the same capacity and preserving local SSDs." +], +"type": "string" +}, +"type": "array" +}, "disruptionMode": { "description": "Whether the boot disk is allowed to be updated with restart.", "enum": [ @@ -109439,6 +110875,11 @@ false "description": "Represents the physical host topology of the host on which the VM is\nrunning.", "id": "ResourceStatusPhysicalHostTopology", "properties": { +"additionalAttributes": { +"$ref": "ResourceStatusPhysicalHostTopologyAdditionalAttributes", +"description": "Output only. [Output Only] Additional location information of the running instance.", +"readOnly": true +}, "block": { "description": "[Output Only] The ID of the block in which the running instance is\nlocated. Instances within the same block experience low network latency.", "type": "string" @@ -109458,6 +110899,21 @@ false }, "type": "object" }, +"ResourceStatusPhysicalHostTopologyAdditionalAttributes": { +"description": "Additional location information of the running instance.", +"id": "ResourceStatusPhysicalHostTopologyAdditionalAttributes", +"properties": { +"acceleratorTopologyIds": { +"additionalProperties": { +"type": "string" +}, +"description": "Output only. The IDs of the accelerator topologies the instance belongs to. For\nexample\nThe key will be topologies like \"4x4\", \"2x2x2\" and the value will be\nthe location ID of the topologies.", +"readOnly": true, +"type": "object" +} +}, +"type": "object" +}, "ResourceStatusReservationConsumptionInfo": { "description": "Reservation consumption information that the instance is consuming from.", "id": "ResourceStatusReservationConsumptionInfo", @@ -111980,6 +113436,12 @@ false }, "type": "array" }, +"effectiveTcpTimeWaitTimeoutSec": { +"description": "Output only. Effective timeout (in seconds) for TCP connections that are in TIME_WAIT\nstate. This value is equal to tcp_time_wait_timeout_sec if it is set,\notherwise it is equal to 120s. The field is output only.", +"format": "int32", +"readOnly": true, +"type": "integer" +}, "enableDynamicPortAllocation": { "description": "Enable Dynamic Port Allocation.\n\n\nIf not specified, it is disabled by default.\n\n\nIf set to true,\n \n - Dynamic Port Allocation will be enabled on this NAT\n config.\n - enableEndpointIndependentMapping cannot be set to true.\n - If minPorts is set, minPortsPerVm must be set to a\n power of two greater than or equal to 32. If minPortsPerVm is not set, a\n minimum of 32 ports will be allocated to a VM from this NAT\n config.", "type": "boolean" @@ -117299,6 +118761,14 @@ false }, "description": "The rules for the snapshot recycle bin policy. The key is either 'default'\nor namespacedName of the TagValue which can be in the format:\n`{organization_id}/{tag_key_short_name}/{tag_value_short_name}` or\n`{project_id}/{tag_key_short_name}/{tag_value_short_name}` or\n`{project_number}/{tag_key_short_name}/{tag_value_short_name}`. The default\nrule is applied if snapshots do not have any of these tags.\n The value is the rule for the key.", "type": "object" +}, +"systemRules": { +"additionalProperties": { +"$ref": "SnapshotRecycleBinPolicyRule" +}, +"description": "Output only. The system rules for snapshot recycle bin policy.\nDefines the default rule that applies if no customer-defined rule matches.", +"readOnly": true, +"type": "object" } }, "type": "object" diff --git a/googleapiclient/discovery_cache/documents/compute.beta.json b/googleapiclient/discovery_cache/documents/compute.beta.json index 6909d22b85..3dac086dec 100644 --- a/googleapiclient/discovery_cache/documents/compute.beta.json +++ b/googleapiclient/discovery_cache/documents/compute.beta.json @@ -22836,6 +22836,483 @@ } } }, +"organizationRolloutPlans": { +"methods": { +"delete": { +"description": "Deletes an OrganizationRolloutPlan.", +"flatPath": "organizations/{organizationsId}/global/rolloutPlans/{rolloutPlan}", +"httpMethod": "DELETE", +"id": "compute.organizationRolloutPlans.delete", +"parameterOrder": [ +"organization", +"rolloutPlan" +], +"parameters": { +"organization": { +"description": "Organization ID for this request.", +"location": "path", +"pattern": "organizations/[0-9]{0,20}", +"required": true, +"type": "string" +}, +"requestId": { +"description": "An optional request ID to identify requests. Specify a unique request ID so\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).", +"location": "query", +"type": "string" +}, +"rolloutPlan": { +"description": "Name of the OrganizationRolloutPlan resource to delete.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", +"required": true, +"type": "string" +} +}, +"path": "{+organization}/global/rolloutPlans/{rolloutPlan}", +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute" +] +}, +"get": { +"description": "Gets details of a single organization-scoped RolloutPlan.", +"flatPath": "organizations/{organizationsId}/global/rolloutPlans/{rolloutPlan}", +"httpMethod": "GET", +"id": "compute.organizationRolloutPlans.get", +"parameterOrder": [ +"organization", +"rolloutPlan" +], +"parameters": { +"organization": { +"description": "Organization ID for this request.", +"location": "path", +"pattern": "organizations/[0-9]{0,20}", +"required": true, +"type": "string" +}, +"rolloutPlan": { +"description": "Name of the persistent rollout plan to return.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", +"required": true, +"type": "string" +} +}, +"path": "{+organization}/global/rolloutPlans/{rolloutPlan}", +"response": { +"$ref": "RolloutPlan" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute", +"https://www.googleapis.com/auth/compute.readonly" +] +}, +"insert": { +"description": "Creates a new RolloutPlan in a given organization and location.", +"flatPath": "organizations/{organizationsId}/global/rolloutPlans", +"httpMethod": "POST", +"id": "compute.organizationRolloutPlans.insert", +"parameterOrder": [ +"organization" +], +"parameters": { +"organization": { +"description": "Organization ID for this request.", +"location": "path", +"pattern": "organizations/[0-9]{0,20}", +"required": true, +"type": "string" +}, +"requestId": { +"description": "An optional request ID to identify requests. Specify a unique request ID so\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).", +"location": "query", +"type": "string" +} +}, +"path": "{+organization}/global/rolloutPlans", +"request": { +"$ref": "RolloutPlan" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute" +] +}, +"list": { +"description": "Lists OrganizationRolloutPlans in a given organization and location.", +"flatPath": "organizations/{organizationsId}/global/rolloutPlans", +"httpMethod": "GET", +"id": "compute.organizationRolloutPlans.list", +"parameterOrder": [ +"organization" +], +"parameters": { +"filter": { +"description": "A filter expression that filters resources listed in the response. Most\nCompute resources support two types of filter expressions:\nexpressions that support regular expressions and expressions that follow\nAPI improvement proposal AIP-160.\nThese two types of filter expressions cannot be mixed in one request.\n\nIf you want to use AIP-160, your expression must specify the field name, an\noperator, and the value that you want to use for filtering. The value\nmust be a string, a number, or a boolean. The operator\nmust be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.\n\nFor example, if you are filtering Compute Engine instances, you can\nexclude instances named `example-instance` by specifying\n`name != example-instance`.\n\nThe `:*` comparison can be used to test whether a key has been defined.\nFor example, to find all objects with `owner` label use:\n```\nlabels.owner:*\n```\n\nYou can also filter nested fields. For example, you could specify\n`scheduling.automaticRestart = false` to include instances only\nif they are not scheduled for automatic restarts. You can use filtering\non nested fields to filter based onresource labels.\n\nTo filter on multiple expressions, provide each separate expression within\nparentheses. For example:\n```\n(scheduling.automaticRestart = true)\n(cpuPlatform = \"Intel Skylake\")\n```\nBy default, each expression is an `AND` expression. However, you\ncan include `AND` and `OR` expressions explicitly.\nFor example:\n```\n(cpuPlatform = \"Intel Skylake\") OR\n(cpuPlatform = \"Intel Broadwell\") AND\n(scheduling.automaticRestart = true)\n```\n\nIf you want to use a regular expression, use the `eq` (equal) or `ne`\n(not equal) operator against a single un-parenthesized expression with or\nwithout quotes or against multiple parenthesized expressions. Examples:\n\n`fieldname eq unquoted literal`\n`fieldname eq 'single quoted literal'`\n`fieldname eq \"double quoted literal\"`\n`(fieldname1 eq literal) (fieldname2 ne \"literal\")`\n\nThe literal value is interpreted as a regular expression using GoogleRE2 library syntax.\nThe literal value must match the entire field.\n\nFor example, to filter for instances that do not end with name \"instance\",\nyou would use `name ne .*instance`.\n\nYou cannot combine constraints on multiple fields using regular\nexpressions.", +"location": "query", +"type": "string" +}, +"maxResults": { +"default": "500", +"description": "The maximum number of results per page that should be returned.\nIf the number of available results is larger than `maxResults`,\nCompute Engine returns a `nextPageToken` that can be used to get\nthe next page of results in subsequent list requests. Acceptable values are\n`0` to `500`, inclusive. (Default: `500`)", +"format": "uint32", +"location": "query", +"minimum": "0", +"type": "integer" +}, +"orderBy": { +"description": "Sorts list results by a certain order. By default, results\nare returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation\ntimestamp using `orderBy=\"creationTimestamp desc\"`. This sorts\nresults based on the `creationTimestamp` field in\nreverse chronological order (newest result first). Use this to sort\nresources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or\n`creationTimestamp desc` is supported.", +"location": "query", +"type": "string" +}, +"organization": { +"description": "Organization ID for this request.", +"location": "path", +"pattern": "organizations/[0-9]{0,20}", +"required": true, +"type": "string" +}, +"pageToken": { +"description": "Specifies a page token to use. Set `pageToken` to the\n`nextPageToken` returned by a previous list request to get\nthe next page of results.", +"location": "query", +"type": "string" +}, +"returnPartialSuccess": { +"description": "Opt-in for partial success behavior which provides partial results in case\nof failure. The default value is false.\n\nFor example, when partial success behavior is enabled, aggregatedList for a\nsingle zone scope either returns all resources in the zone or no resources,\nwith an error code.", +"location": "query", +"type": "boolean" +} +}, +"path": "{+organization}/global/rolloutPlans", +"response": { +"$ref": "RolloutPlansListResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute", +"https://www.googleapis.com/auth/compute.readonly" +] +} +} +}, +"organizationRollouts": { +"methods": { +"advance": { +"description": "Advances a Rollout to the next wave, or completes it if no waves remain.", +"flatPath": "organizations/{organizationsId}/global/rollouts/{rollout}/advance", +"httpMethod": "POST", +"id": "compute.organizationRollouts.advance", +"parameterOrder": [ +"organization", +"rollout" +], +"parameters": { +"currentWaveNumber": { +"description": "Required. Wave number of the current wave.", +"format": "int64", +"location": "query", +"type": "string" +}, +"organization": { +"description": "Required. Organization ID for this request.", +"location": "path", +"pattern": "organizations/[0-9]{1,19}", +"required": true, +"type": "string" +}, +"requestId": { +"description": "An optional request ID to identify requests. Specify a unique request ID so\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).", +"location": "query", +"type": "string" +}, +"rollout": { +"description": "Required. Name of the Rollout resource to advance.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", +"required": true, +"type": "string" +} +}, +"path": "{+organization}/global/rollouts/{rollout}/advance", +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute" +] +}, +"cancel": { +"description": "Cancels a Rollout.", +"flatPath": "organizations/{organizationsId}/global/rollouts/{rollout}", +"httpMethod": "PATCH", +"id": "compute.organizationRollouts.cancel", +"parameterOrder": [ +"organization", +"rollout" +], +"parameters": { +"organization": { +"description": "Required. Organization ID for this request.", +"location": "path", +"pattern": "organizations/[0-9]{1,19}", +"required": true, +"type": "string" +}, +"requestId": { +"description": "An optional request ID to identify requests. Specify a unique request ID so\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).", +"location": "query", +"type": "string" +}, +"rollback": { +"description": "Optional. If true, then the ongoing rollout must be rolled back. Else, just cancel\nthe rollout without taking any further actions. Note that products must\nsupport at least one of these options, however, it does not need to support\nboth.", +"location": "query", +"type": "boolean" +}, +"rollout": { +"description": "Name of the Rollout resource to cancel.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", +"required": true, +"type": "string" +} +}, +"path": "{+organization}/global/rollouts/{rollout}", +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute" +] +}, +"delete": { +"description": "Deletes a Rollout.", +"flatPath": "organizations/{organizationsId}/global/rollouts/{rollout}", +"httpMethod": "DELETE", +"id": "compute.organizationRollouts.delete", +"parameterOrder": [ +"organization", +"rollout" +], +"parameters": { +"organization": { +"description": "Required. Organization ID for this request.", +"location": "path", +"pattern": "organizations/[0-9]{1,19}", +"required": true, +"type": "string" +}, +"requestId": { +"description": "An optional request ID to identify requests. Specify a unique request ID so\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).", +"location": "query", +"type": "string" +}, +"rollout": { +"description": "Name of the Rollout resource to delete.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", +"required": true, +"type": "string" +} +}, +"path": "{+organization}/global/rollouts/{rollout}", +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute" +] +}, +"get": { +"description": "Gets details of a single organization-scoped Rollout.", +"flatPath": "organizations/{organizationsId}/global/rollouts/{rollout}", +"httpMethod": "GET", +"id": "compute.organizationRollouts.get", +"parameterOrder": [ +"organization", +"rollout" +], +"parameters": { +"organization": { +"description": "Organization ID for this request.", +"location": "path", +"pattern": "organizations/[0-9]{0,20}", +"required": true, +"type": "string" +}, +"rollout": { +"description": "Name of the persistent rollout to return.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", +"required": true, +"type": "string" +} +}, +"path": "{+organization}/global/rollouts/{rollout}", +"response": { +"$ref": "Rollout" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute", +"https://www.googleapis.com/auth/compute.readonly" +] +}, +"list": { +"description": "Lists Rollouts in a given organization and location.", +"flatPath": "organizations/{organizationsId}/global/rollouts", +"httpMethod": "GET", +"id": "compute.organizationRollouts.list", +"parameterOrder": [ +"organization" +], +"parameters": { +"filter": { +"description": "A filter expression that filters resources listed in the response. Most\nCompute resources support two types of filter expressions:\nexpressions that support regular expressions and expressions that follow\nAPI improvement proposal AIP-160.\nThese two types of filter expressions cannot be mixed in one request.\n\nIf you want to use AIP-160, your expression must specify the field name, an\noperator, and the value that you want to use for filtering. The value\nmust be a string, a number, or a boolean. The operator\nmust be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.\n\nFor example, if you are filtering Compute Engine instances, you can\nexclude instances named `example-instance` by specifying\n`name != example-instance`.\n\nThe `:*` comparison can be used to test whether a key has been defined.\nFor example, to find all objects with `owner` label use:\n```\nlabels.owner:*\n```\n\nYou can also filter nested fields. For example, you could specify\n`scheduling.automaticRestart = false` to include instances only\nif they are not scheduled for automatic restarts. You can use filtering\non nested fields to filter based onresource labels.\n\nTo filter on multiple expressions, provide each separate expression within\nparentheses. For example:\n```\n(scheduling.automaticRestart = true)\n(cpuPlatform = \"Intel Skylake\")\n```\nBy default, each expression is an `AND` expression. However, you\ncan include `AND` and `OR` expressions explicitly.\nFor example:\n```\n(cpuPlatform = \"Intel Skylake\") OR\n(cpuPlatform = \"Intel Broadwell\") AND\n(scheduling.automaticRestart = true)\n```\n\nIf you want to use a regular expression, use the `eq` (equal) or `ne`\n(not equal) operator against a single un-parenthesized expression with or\nwithout quotes or against multiple parenthesized expressions. Examples:\n\n`fieldname eq unquoted literal`\n`fieldname eq 'single quoted literal'`\n`fieldname eq \"double quoted literal\"`\n`(fieldname1 eq literal) (fieldname2 ne \"literal\")`\n\nThe literal value is interpreted as a regular expression using GoogleRE2 library syntax.\nThe literal value must match the entire field.\n\nFor example, to filter for instances that do not end with name \"instance\",\nyou would use `name ne .*instance`.\n\nYou cannot combine constraints on multiple fields using regular\nexpressions.", +"location": "query", +"type": "string" +}, +"maxResults": { +"default": "500", +"description": "The maximum number of results per page that should be returned.\nIf the number of available results is larger than `maxResults`,\nCompute Engine returns a `nextPageToken` that can be used to get\nthe next page of results in subsequent list requests. Acceptable values are\n`0` to `500`, inclusive. (Default: `500`)", +"format": "uint32", +"location": "query", +"minimum": "0", +"type": "integer" +}, +"orderBy": { +"description": "Sorts list results by a certain order. By default, results\nare returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation\ntimestamp using `orderBy=\"creationTimestamp desc\"`. This sorts\nresults based on the `creationTimestamp` field in\nreverse chronological order (newest result first). Use this to sort\nresources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or\n`creationTimestamp desc` is supported.", +"location": "query", +"type": "string" +}, +"organization": { +"description": "Required. Organization ID for this request.", +"location": "path", +"pattern": "organizations/[0-9]{1,19}", +"required": true, +"type": "string" +}, +"pageToken": { +"description": "Specifies a page token to use. Set `pageToken` to the\n`nextPageToken` returned by a previous list request to get\nthe next page of results.", +"location": "query", +"type": "string" +}, +"returnPartialSuccess": { +"description": "Opt-in for partial success behavior which provides partial results in case\nof failure. The default value is false.\n\nFor example, when partial success behavior is enabled, aggregatedList for a\nsingle zone scope either returns all resources in the zone or no resources,\nwith an error code.", +"location": "query", +"type": "boolean" +} +}, +"path": "{+organization}/global/rollouts", +"response": { +"$ref": "OrganizationRolloutsListResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute", +"https://www.googleapis.com/auth/compute.readonly" +] +}, +"pause": { +"description": "Pauses a Rollout.", +"flatPath": "organizations/{organizationsId}/global/rollouts/{rollout}/pause", +"httpMethod": "POST", +"id": "compute.organizationRollouts.pause", +"parameterOrder": [ +"organization", +"rollout" +], +"parameters": { +"etag": { +"description": "The etag of the Rollout.\nIf this is provided, the request will only succeed if the etag matches\nthe current etag of the Rollout.", +"location": "query", +"type": "string" +}, +"organization": { +"description": "Required. Organization ID for this request.", +"location": "path", +"pattern": "organizations/[0-9]{1,19}", +"required": true, +"type": "string" +}, +"requestId": { +"description": "An optional request ID to identify requests. Specify a unique request ID so\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).", +"location": "query", +"type": "string" +}, +"rollout": { +"description": "Required. Name of the Rollout resource to pause.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", +"required": true, +"type": "string" +} +}, +"path": "{+organization}/global/rollouts/{rollout}/pause", +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute" +] +}, +"resume": { +"description": "Resumes a Rollout.", +"flatPath": "organizations/{organizationsId}/global/rollouts/{rollout}/resume", +"httpMethod": "POST", +"id": "compute.organizationRollouts.resume", +"parameterOrder": [ +"organization", +"rollout" +], +"parameters": { +"etag": { +"description": "The etag of the Rollout.\nIf this is provided, the request will only succeed if the etag matches\nthe current etag of the Rollout.", +"location": "query", +"type": "string" +}, +"organization": { +"description": "Required. Organization ID for this request.", +"location": "path", +"pattern": "organizations/[0-9]{1,19}", +"required": true, +"type": "string" +}, +"requestId": { +"description": "An optional request ID to identify requests. Specify a unique request ID so\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).", +"location": "query", +"type": "string" +}, +"rollout": { +"description": "Required. Name of the Rollout resource to resume.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", +"required": true, +"type": "string" +} +}, +"path": "{+organization}/global/rollouts/{rollout}/resume", +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute" +] +} +} +}, "organizationSecurityPolicies": { "methods": { "addAssociation": { @@ -51930,7 +52407,7 @@ } } }, -"revision": "20260501", +"revision": "20260520", "rootUrl": "https://compute.googleapis.com/", "schemas": { "AWSV4Signature": { @@ -54613,7 +55090,7 @@ false "Do not automatically scale the MIG in or out.\nThe recommended_size field contains the size of MIG that would be set if\nthe actuation mode was enabled.", "Automatically scale the MIG in and out according to the policy.", "Automatically create VMs according to the policy, but do not scale\nthe MIG in.", -"Automatically create VMs according to the policy, but do not scale\nthe MIG in." +"Automatically create VMs according to the policy, but do not scale\nthe MIG in.\nIt's recommended to use ONLY_SCALE_OUT instead of ONLY_UP." ], "type": "string" }, @@ -57083,6 +57560,20 @@ false "description": "Denotes whether to enable logging for the load balancer\ntraffic served by this backend service. The default value is false.", "type": "boolean" }, +"loggingHttpRequestHeaders": { +"description": "The list of request headers that will be logged to Stackdriver.", +"items": { +"$ref": "BackendServiceLogConfigLoggingHttpHeader" +}, +"type": "array" +}, +"loggingHttpResponseHeaders": { +"description": "The list of response headers that will be logged to Stackdriver.", +"items": { +"$ref": "BackendServiceLogConfigLoggingHttpHeader" +}, +"type": "array" +}, "optionalFields": { "description": "This field can only be specified if logging is enabled for this backend\nservice and \"logConfig.optionalMode\" was set to CUSTOM. Contains a list\nof optional fields you want to include in the logs. For example:\nserverInstance, serverGkeDetails.cluster,\nserverGkeDetails.pod.podNamespace", "items": { @@ -57112,6 +57603,17 @@ false }, "type": "object" }, +"BackendServiceLogConfigLoggingHttpHeader": { +"description": "Determines which HTTP headers will be logged to Stackdriver.", +"id": "BackendServiceLogConfigLoggingHttpHeader", +"properties": { +"headerName": { +"description": "The name of the header to be logged.", +"type": "string" +} +}, +"type": "object" +}, "BackendServiceNetworkPassThroughLbTrafficPolicy": { "id": "BackendServiceNetworkPassThroughLbTrafficPolicy", "properties": { @@ -60316,6 +60818,57 @@ false }, "type": "object" }, +"DateTime": { +"description": "Represents civil time (or occasionally physical time).\n\nThis type can represent a civil time in one of a few possible ways:\n\n * When utc_offset is set and time_zone is unset: a civil time on a calendar\n day with a particular offset from UTC.\n * When time_zone is set and utc_offset is unset: a civil time on a calendar\n day in a particular time zone.\n * When neither time_zone nor utc_offset is set: a civil time on a calendar\n day in local time.\n\nThe date is relative to the Proleptic Gregorian Calendar.\n\nIf year, month, or day are 0, the DateTime is considered not to have a\nspecific year, month, or day respectively.\n\nThis type may also be used to represent a physical time if all the date and\ntime fields are set and either case of the `time_offset` oneof is set.\nConsider using `Timestamp` message for physical time instead. If your use\ncase also would like to store the user's timezone, that can be done in\nanother field.\n\nThis type is more flexible than some applications may want. Make sure to\ndocument and validate your application's limitations.", +"id": "DateTime", +"properties": { +"day": { +"description": "Optional. Day of month. Must be from 1 to 31 and valid for the year and\nmonth, or 0 if specifying a datetime without a day.", +"format": "int32", +"type": "integer" +}, +"hours": { +"description": "Optional. Hours of day in 24 hour format. Should be from 0 to 23, defaults\nto 0 (midnight). An API may choose to allow the value \"24:00:00\" for\nscenarios like business closing time.", +"format": "int32", +"type": "integer" +}, +"minutes": { +"description": "Optional. Minutes of hour of day. Must be from 0 to 59, defaults to 0.", +"format": "int32", +"type": "integer" +}, +"month": { +"description": "Optional. Month of year. Must be from 1 to 12, or 0 if specifying a\ndatetime without a month.", +"format": "int32", +"type": "integer" +}, +"nanos": { +"description": "Optional. Fractions of seconds in nanoseconds. Must be from 0 to\n999,999,999, defaults to 0.", +"format": "int32", +"type": "integer" +}, +"seconds": { +"description": "Optional. Seconds of minutes of the time. Must normally be from 0 to 59,\ndefaults to 0. An API may allow the value 60 if it allows leap-seconds.", +"format": "int32", +"type": "integer" +}, +"timeZone": { +"$ref": "TimeZone", +"description": "Time zone." +}, +"utcOffset": { +"description": "UTC offset. Must be whole seconds, between -18 hours and +18 hours.\nFor example, a UTC offset of -4:00 would be represented as\n{ seconds: -14400 }.", +"format": "google-duration", +"type": "string" +}, +"year": { +"description": "Optional. Year of date. Must be from 1 to 9999, or 0 if specifying a\ndatetime without a year.", +"format": "int32", +"type": "integer" +} +}, +"type": "object" +}, "DeprecationStatus": { "description": "Deprecation status for a public resource.", "id": "DeprecationStatus", @@ -69737,6 +70290,10 @@ false "$ref": "HttpFaultInjection", "description": "The specification for fault injection introduced into traffic to test\nthe resiliency of clients to backend service failure. As part of fault\ninjection, when clients send requests to a backend service, delays can be\nintroduced by a load balancer on a percentage of requests before sending\nthose requests to the backend service. Similarly requests from clients can\nbe aborted by the load balancer for a percentage of requests.timeout and retry_policy is ignored by clients\nthat are configured with a fault_injection_policy if:\n1. The traffic is generated by fault injection AND\n2. The fault injection is not a delay fault injection.\nFault injection is not supported with the classic Application Load Balancer\n. To see which load balancers support fault injection,\nsee Load\nbalancing: Routing and traffic management features." }, +"imageOptimizationPolicy": { +"$ref": "ImageOptimizationPolicy", +"description": "Image optimization policy for this URL Map's route. Available only for\nGlobal EXTERNAL_MANAGED load balancer schemes.\nEither Cloud CDN must be enabled on the backend service or backend bucket\nserving the route, or cache policy must be configured on the same route" +}, "maxStreamDuration": { "$ref": "Duration", "description": "Specifies the maximum duration (timeout) for streams on the selected route.\nUnlike the timeout field where the timeout duration starts\nfrom the time the request has been fully processed (known as*end-of-stream*),\nthe duration in this field is computed from the beginning of the stream\nuntil the response has been processed, including all retries. A\nstream that does not complete in this duration is closed.\n\nIf not specified, this field uses the maximummaxStreamDuration value among all backend services associated\nwith the route.\n\nThis field is only allowed if the Url map is used with backend services\nwith loadBalancingScheme set toINTERNAL_SELF_MANAGED." @@ -70509,6 +71066,27 @@ false }, "type": "object" }, +"ImageOptimizationPolicy": { +"description": "The configuration for Cloud CDN's image optimization feature. This feature\ndynamically processes and delivers images from the network edge.\nImage Optimization is only available for Global External Application Load\nBalancers.\nEither Cloud CDN must be enabled on the backend service or backend bucket\nserving the route, or cache policy must be configured on the same route.", +"id": "ImageOptimizationPolicy", +"properties": { +"queryParameterInterpretation": { +"description": "Specifies whether to interpret query parameters for image optimization.", +"enum": [ +"DISABLED", +"ENABLED", +"QUERY_PARAMETER_INTERPRETATION_UNSPECIFIED" +], +"enumDescriptions": [ +"Query parameters for image optimization are ignored.", +"Query parameters for image optimization are interpreted.", +"Default value. This field value translates to the\ndefault behavior, which is to ignore query parameters for image\noptimization." +], +"type": "string" +} +}, +"type": "object" +}, "ImageParams": { "description": "Additional image params.", "id": "ImageParams", @@ -71801,6 +72379,12 @@ false "readOnly": true, "type": "integer" }, +"restartingInPlace": { +"description": "Output only. The number of instances in the managed instance group that\nare scheduled to be restarted or are currently being restarted.", +"format": "int32", +"readOnly": true, +"type": "integer" +}, "resuming": { "description": "Output only. The number of instances in the managed instance group that\nare scheduled to be resumed or are currently being resumed.", "format": "int32", @@ -73150,6 +73734,27 @@ false "InstanceGroupManagerUpdatePolicy": { "id": "InstanceGroupManagerUpdatePolicy", "properties": { +"allowedActions": { +"description": "Actions that are allowed to update instances within MIG.", +"items": { +"enum": [ +"NONE", +"REFRESH", +"REPLACE", +"RESTART", +"RESTART_IN_PLACE" +], +"enumDescriptions": [ +"Do not perform any action.", +"Do not stop the instance.", +"(Default.) Replace the instance according to the replacement method\noption.", +"Stop the instance and start it again.", +"Restart the instance using the same capacity and preserving local SSDs." +], +"type": "string" +}, +"type": "array" +}, "instanceRedistributionType": { "description": "The \ninstance redistribution policy for regional managed instance groups.\nValid values are: \n \n - PROACTIVE (default): The group attempts to maintain an\n even distribution of VM instances across zones in the region.\n - NONE: For non-autoscaled groups, proactive\n redistribution is disabled.", "enum": [ @@ -73181,13 +73786,15 @@ false "NONE", "REFRESH", "REPLACE", -"RESTART" +"RESTART", +"RESTART_IN_PLACE" ], "enumDescriptions": [ "Do not perform any action.", "Do not stop the instance.", "(Default.) Replace the instance according to the replacement method\noption.", -"Stop the instance and start it again." +"Stop the instance and start it again.", +"Restart the instance using the same capacity and preserving local SSDs." ], "type": "string" }, @@ -73197,13 +73804,15 @@ false "NONE", "REFRESH", "REPLACE", -"RESTART" +"RESTART", +"RESTART_IN_PLACE" ], "enumDescriptions": [ "Do not perform any action.", "Do not stop the instance.", "(Default.) Replace the instance according to the replacement method\noption.", -"Stop the instance and start it again." +"Stop the instance and start it again.", +"Restart the instance using the same capacity and preserving local SSDs." ], "type": "string" }, @@ -73273,6 +73882,27 @@ false "description": "Flag to update all instances instead of specified list of \u201cinstances\u201d.\nIf the flag is set to true then the instances may not be specified\nin the request.", "type": "boolean" }, +"allowedActions": { +"description": "Actions that are allowed to update instances within MIG.", +"items": { +"enum": [ +"NONE", +"REFRESH", +"REPLACE", +"RESTART", +"RESTART_IN_PLACE" +], +"enumDescriptions": [ +"Do not perform any action.", +"Do not stop the instance.", +"(Default.) Replace the instance according to the replacement method\noption.", +"Stop the instance and start it again.", +"Restart the instance using the same capacity and preserving local SSDs." +], +"type": "string" +}, +"type": "array" +}, "instances": { "description": "The list of URLs of one or more instances for which you want to apply\nupdates. Each URL can be a full URL or a partial URL, such aszones/[ZONE]/instances/[INSTANCE_NAME].", "items": { @@ -73286,13 +73916,15 @@ false "NONE", "REFRESH", "REPLACE", -"RESTART" +"RESTART", +"RESTART_IN_PLACE" ], "enumDescriptions": [ "Do not perform any action.", "Do not stop the instance.", "(Default.) Replace the instance according to the replacement method\noption.", -"Stop the instance and start it again." +"Stop the instance and start it again.", +"Restart the instance using the same capacity and preserving local SSDs." ], "type": "string" }, @@ -73302,13 +73934,15 @@ false "NONE", "REFRESH", "REPLACE", -"RESTART" +"RESTART", +"RESTART_IN_PLACE" ], "enumDescriptions": [ "Do not perform any action.", "Do not stop the instance.", "(Default.) Replace the instance according to the replacement method\noption.", -"Stop the instance and start it again." +"Stop the instance and start it again.", +"Restart the instance using the same capacity and preserving local SSDs." ], "type": "string" } @@ -74714,16 +75348,16 @@ false "properties": { "error": { "$ref": "InstanceManagedByIgmErrorManagedInstanceError", -"description": "Output only. [Output Only] Contents of the error.", +"description": "Output only. Contents of the error.", "readOnly": true }, "instanceActionDetails": { "$ref": "InstanceManagedByIgmErrorInstanceActionDetails", -"description": "Output only. [Output Only] Details of the instance action that triggered this error.\nMay be null, if the error was not caused by an action on an instance.\nThis field is optional.", +"description": "Output only. Details of the instance action that triggered this error.\nMay be null, if the error was not caused by an action on an instance.\nThis field is optional.", "readOnly": true }, "timestamp": { -"description": "Output only. [Output Only] The time that this error occurred.\nThis value is in RFC3339 text format.", +"description": "Output only. The time that this error occurred. This value is in RFC3339 text format.", "readOnly": true, "type": "string" } @@ -74734,7 +75368,7 @@ false "id": "InstanceManagedByIgmErrorInstanceActionDetails", "properties": { "action": { -"description": "Output only. [Output Only] Action that managed instance group was executing on\nthe instance when the error occurred. Possible values:", +"description": "Output only. Action that managed instance group was executing on the instance when the\nerror occurred. Possible values:", "enum": [ "ABANDONING", "ADOPTING", @@ -74745,6 +75379,7 @@ false "RECREATING", "REFRESHING", "RESTARTING", +"RESTARTING_IN_PLACE", "RESUMING", "STARTING", "STOPPING", @@ -74761,6 +75396,7 @@ false "The managed instance group is recreating this instance.", "The managed instance group is applying configuration changes to the\ninstance without stopping it. For example, the group can update the\ntarget pool list for an instance without stopping that instance.", "The managed instance group is restarting this instance.", +"The managed instance group is restarting this instance while preserving\nits capacity and local SSDs.", "The managed instance group is resuming this instance.", "The managed instance group is starting this instance.", "The managed instance group is stopping this instance.", @@ -74771,13 +75407,13 @@ false "type": "string" }, "instance": { -"description": "Output only. [Output Only] The URL of the instance.\nThe URL can be set even if the instance has not yet been created.", +"description": "Output only. The URL of the instance. The URL can be set even if the instance has not\nyet been created.", "readOnly": true, "type": "string" }, "version": { "$ref": "ManagedInstanceVersion", -"description": "Output only. [Output Only] Version this instance was created from, or was being\ncreated from, but the creation failed. Corresponds to one of the versions\nthat were set on the Instance Group Manager resource at the time this\ninstance was being created.", +"description": "Output only. Version this instance was created from, or was being\ncreated from, but the creation failed. Corresponds to one of the versions\nthat were set on the Instance Group Manager resource at the time this\ninstance was being created.", "readOnly": true } }, @@ -74787,12 +75423,12 @@ false "id": "InstanceManagedByIgmErrorManagedInstanceError", "properties": { "code": { -"description": "Output only. [Output Only] Error code.", +"description": "Output only. Error code.", "readOnly": true, "type": "string" }, "message": { -"description": "Output only. [Output Only] Error message.", +"description": "Output only. Error message.", "readOnly": true, "type": "string" } @@ -82559,6 +83195,7 @@ false "RECREATING", "REFRESHING", "RESTARTING", +"RESTARTING_IN_PLACE", "RESUMING", "STARTING", "STOPPING", @@ -82575,6 +83212,7 @@ false "The managed instance group is recreating this instance.", "The managed instance group is applying configuration changes to the\ninstance without stopping it. For example, the group can update the\ntarget pool list for an instance without stopping that instance.", "The managed instance group is restarting this instance.", +"The managed instance group is restarting this instance while preserving\nits capacity and local SSDs.", "The managed instance group is resuming this instance.", "The managed instance group is starting this instance.", "The managed instance group is stopping this instance.", @@ -91610,6 +92248,167 @@ false }, "type": "object" }, +"OrganizationRolloutsListResponse": { +"id": "OrganizationRolloutsListResponse", +"properties": { +"etag": { +"type": "string" +}, +"id": { +"description": "[Output Only] Unique identifier for the resource; defined by the server.", +"type": "string" +}, +"items": { +"description": "A list of Rollout resources.", +"items": { +"$ref": "Rollout" +}, +"type": "array" +}, +"nextPageToken": { +"description": "[Output Only] This token allows you to get the next page of results for\nlist requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for\nthe query parameter pageToken in the next list request.\nSubsequent list requests will have their own nextPageToken to\ncontinue paging through the results.", +"type": "string" +}, +"selfLink": { +"description": "Output only. [Output Only] Server-defined URL for this resource.", +"readOnly": true, +"type": "string" +}, +"unreachables": { +"description": "Output only. [Output Only] Unreachable resources.\nend_interface: MixerListResponseWithEtagBuilder", +"items": { +"type": "string" +}, +"readOnly": true, +"type": "array" +}, +"warning": { +"description": "[Output Only] Informational warning message.", +"properties": { +"code": { +"description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare no results in the response.", +"enum": [ +"CLEANUP_FAILED", +"DEPRECATED_RESOURCE_USED", +"DEPRECATED_TYPE_USED", +"DISK_SIZE_LARGER_THAN_IMAGE_SIZE", +"EXPERIMENTAL_TYPE_USED", +"EXTERNAL_API_WARNING", +"FIELD_VALUE_OVERRIDEN", +"INJECTED_KERNELS_DEPRECATED", +"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB", +"LARGE_DEPLOYMENT_WARNING", +"LIST_OVERHEAD_QUOTA_EXCEED", +"MISSING_TYPE_DEPENDENCY", +"NEXT_HOP_ADDRESS_NOT_ASSIGNED", +"NEXT_HOP_CANNOT_IP_FORWARD", +"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE", +"NEXT_HOP_INSTANCE_NOT_FOUND", +"NEXT_HOP_INSTANCE_NOT_ON_NETWORK", +"NEXT_HOP_NOT_RUNNING", +"NOT_CRITICAL_ERROR", +"NO_RESULTS_ON_PAGE", +"PARTIAL_SUCCESS", +"QUOTA_INFO_UNAVAILABLE", +"REQUIRED_TOS_AGREEMENT", +"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING", +"RESOURCE_NOT_DELETED", +"SCHEMA_VALIDATION_IGNORED", +"SINGLE_INSTANCE_PROPERTY_TEMPLATE", +"UNDECLARED_PROPERTIES", +"UNREACHABLE" +], +"enumDeprecated": [ +false, +false, +false, +false, +false, +false, +true, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false +], +"enumDescriptions": [ +"Warning about failed cleanup of transient changes made by a failed\noperation.", +"A link to a deprecated resource was created.", +"When deploying and at least one of the resources has a type marked as\ndeprecated", +"The user created a boot disk that is larger than image size.", +"When deploying and at least one of the resources has a type marked as\nexperimental", +"Warning that is present in an external api call", +"Warning that value of a field has been overridden.\nDeprecated unused field.", +"The operation involved use of an injected kernel, which is deprecated.", +"A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.", +"When deploying a deployment with a exceedingly large number of resources", +"Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.", +"A resource depends on a missing type", +"The route's nextHopIp address is not assigned to an instance on the\nnetwork.", +"The route's next hop instance cannot ip forward.", +"The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.", +"The route's nextHopInstance URL refers to an instance that does not exist.", +"The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.", +"The route's next hop instance does not have a status of RUNNING.", +"Error which is not critical. We decided to continue the process despite\nthe mentioned error.", +"No results are present on a particular list page.", +"Success is reported, but some results may be missing due to errors", +"Quota information is not available to client requests (e.g:\nregions.list).", +"The user attempted to use a resource that requires a TOS they have not\naccepted.", +"Warning that a resource is in use.", +"One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.", +"When a resource schema validation is ignored.", +"Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.", +"When undeclared properties in the schema are present", +"A given scope cannot be reached." +], +"type": "string" +}, +"data": { +"description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n {\n \"key\": \"scope\",\n \"value\": \"zones/us-east1-d\"\n }", +"items": { +"properties": { +"key": { +"description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts to perform IP forwarding but is not enabled for IP forwarding).", +"type": "string" +}, +"value": { +"description": "[Output Only] A warning data value corresponding to the key.", +"type": "string" +} +}, +"type": "object" +}, +"type": "array" +}, +"message": { +"description": "[Output Only] A human-readable description of the warning code.", +"type": "string" +} +}, +"type": "object" +} +}, +"type": "object" +}, "OrganizationSecurityPoliciesListAssociationsResponse": { "id": "OrganizationSecurityPoliciesListAssociationsResponse", "properties": { @@ -92551,6 +93350,54 @@ false }, "type": "object" }, +"PeriodicPartialMaintenanceSchedule": { +"description": "The periodic partial maintenance schedule includes 52 weeks worth of\nmaintenance windows.\nLINT.IfChange(PeriodicPartialMaintenanceSchedule)", +"id": "PeriodicPartialMaintenanceSchedule", +"properties": { +"subType": { +"description": "The maintenance type in which the zone is during the given window.", +"enum": [ +"MAINTENANCE_SUBTYPE_UNSPECIFIED", +"MAINTENANCE_TYPE_CUSTOMER_MAINTENANCE", +"MAINTENANCE_TYPE_DISRUPTIVE_UPGRADE", +"MAINTENANCE_TYPE_STABLE", +"MAINTENANCE_TYPE_TRANSITION" +], +"enumDescriptions": [ +"Default value.", +"A dedicated window for customers to perform their own maintenance. This\noften runs concurrently with a DISRUPTIVE_UPGRADE.", +"For disruptive updates, including host machine kernel or firmware\nupgrades.", +"A post-maintenance window for customers to conduct final testing and\nperformance validation before resuming full business operations.", +"For preliminary, non-disruptive tasks such as key rotations." +], +"type": "string" +}, +"targetResource": { +"description": "The target resource that the maintenance window is for.\nFor example, \"projects/my-project/zones/us-central1-a\".", +"type": "string" +}, +"type": { +"enum": [ +"MAINTENANCE_TYPE_UNSPECIFIED", +"PRIVATE_ZONE_MAINTENANCE" +], +"enumDescriptions": [ +"Default value.", +"The zone is in a private maintenance window." +], +"type": "string" +}, +"windowEndTime": { +"$ref": "DateTime", +"description": "The end civil timestamp of the window (not inclusive).\nThis contains a time zone." +}, +"windowStartTime": { +"$ref": "DateTime", +"description": "The start civil timestamp of the window.\nThis contains a time zone." +} +}, +"type": "object" +}, "Policy": { "description": "An Identity and Access Management (IAM) policy, which specifies access\ncontrols for Google Cloud resources.\n\n\nA `Policy` is a collection of `bindings`. A `binding` binds one or more\n`members`, or principals, to a single `role`. Principals can be user\naccounts, service accounts, Google groups, and domains (such as G Suite). A\n`role` is a named list of permissions; each `role` can be an IAM predefined\nrole or a user-created custom role.\n\nFor some types of Google Cloud resources, a `binding` can also specify a\n`condition`, which is a logical expression that allows access to a resource\nonly if the expression evaluates to `true`. A condition can add constraints\nbased on attributes of the request, the resource, or both. To learn which\nresources support conditions in their IAM policies, see the\n[IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).\n\n**JSON example:**\n\n```\n {\n \"bindings\": [\n {\n \"role\": \"roles/resourcemanager.organizationAdmin\",\n \"members\": [\n \"user:mike@example.com\",\n \"group:admins@example.com\",\n \"domain:google.com\",\n \"serviceAccount:my-project-id@appspot.gserviceaccount.com\"\n ]\n },\n {\n \"role\": \"roles/resourcemanager.organizationViewer\",\n \"members\": [\n \"user:eve@example.com\"\n ],\n \"condition\": {\n \"title\": \"expirable access\",\n \"description\": \"Does not grant access after Sep 2020\",\n \"expression\": \"request.time < timestamp('2020-10-01T00:00:00.000Z')\",\n }\n }\n ],\n \"etag\": \"BwWWja0YfJA=\",\n \"version\": 3\n }\n```\n\n**YAML example:**\n\n```\n bindings:\n - members:\n - user:mike@example.com\n - group:admins@example.com\n - domain:google.com\n - serviceAccount:my-project-id@appspot.gserviceaccount.com\n role: roles/resourcemanager.organizationAdmin\n - members:\n - user:eve@example.com\n role: roles/resourcemanager.organizationViewer\n condition:\n title: expirable access\n description: Does not grant access after Sep 2020\n expression: request.time < timestamp('2020-10-01T00:00:00.000Z')\n etag: BwWWja0YfJA=\n version: 3\n```\n\nFor a description of IAM and its features, see the\n[IAM documentation](https://cloud.google.com/iam/docs/).", "id": "Policy", @@ -95873,6 +96720,27 @@ false "description": "Flag to update all instances instead of specified list of \u201cinstances\u201d.\nIf the flag is set to true then the instances may not be specified\nin the request.", "type": "boolean" }, +"allowedActions": { +"description": "Actions that are allowed to update instances within MIG.", +"items": { +"enum": [ +"NONE", +"REFRESH", +"REPLACE", +"RESTART", +"RESTART_IN_PLACE" +], +"enumDescriptions": [ +"Do not perform any action.", +"Do not stop the instance.", +"(Default.) Replace the instance according to the replacement method\noption.", +"Stop the instance and start it again.", +"Restart the instance using the same capacity and preserving local SSDs." +], +"type": "string" +}, +"type": "array" +}, "instances": { "description": "The list of URLs of one or more instances for which you want to apply\nupdates. Each URL can be a full URL or a partial URL, such aszones/[ZONE]/instances/[INSTANCE_NAME].", "items": { @@ -95886,13 +96754,15 @@ false "NONE", "REFRESH", "REPLACE", -"RESTART" +"RESTART", +"RESTART_IN_PLACE" ], "enumDescriptions": [ "Do not perform any action.", "Do not stop the instance.", "(Default.) Replace the instance according to the replacement method\noption.", -"Stop the instance and start it again." +"Stop the instance and start it again.", +"Restart the instance using the same capacity and preserving local SSDs." ], "type": "string" }, @@ -95902,13 +96772,15 @@ false "NONE", "REFRESH", "REPLACE", -"RESTART" +"RESTART", +"RESTART_IN_PLACE" ], "enumDescriptions": [ "Do not perform any action.", "Do not stop the instance.", "(Default.) Replace the instance according to the replacement method\noption.", -"Stop the instance and start it again." +"Stop the instance and start it again.", +"Restart the instance using the same capacity and preserving local SSDs." ], "type": "string" } @@ -99754,6 +100626,11 @@ false "description": "Represents the physical host topology of the host on which the VM is\nrunning.", "id": "ResourceStatusPhysicalHostTopology", "properties": { +"additionalAttributes": { +"$ref": "ResourceStatusPhysicalHostTopologyAdditionalAttributes", +"description": "Output only. [Output Only] Additional location information of the running instance.", +"readOnly": true +}, "block": { "description": "[Output Only] The ID of the block in which the running instance is\nlocated. Instances within the same block experience low network latency.", "type": "string" @@ -99773,6 +100650,21 @@ false }, "type": "object" }, +"ResourceStatusPhysicalHostTopologyAdditionalAttributes": { +"description": "Additional location information of the running instance.", +"id": "ResourceStatusPhysicalHostTopologyAdditionalAttributes", +"properties": { +"acceleratorTopologyIds": { +"additionalProperties": { +"type": "string" +}, +"description": "Output only. The IDs of the accelerator topologies the instance belongs to. For\nexample\nThe key will be topologies like \"4x4\", \"2x2x2\" and the value will be\nthe location ID of the topologies.", +"readOnly": true, +"type": "object" +} +}, +"type": "object" +}, "ResourceStatusReservationConsumptionInfo": { "description": "Reservation consumption information that the instance is consuming from.", "id": "ResourceStatusReservationConsumptionInfo", @@ -99781,6 +100673,16 @@ false "description": "Output only. [Output Only] The full resource name of the reservation that this\ninstance is consuming from.", "readOnly": true, "type": "string" +}, +"consumedReservationBlock": { +"description": "Output only. [Output Only] The full resource name of the reservation block that this\ninstance is consuming from.", +"readOnly": true, +"type": "string" +}, +"consumedReservationSubBlock": { +"description": "Output only. [Output Only] The full resource name of the reservation sub-block that\nthis instance is consuming from.", +"readOnly": true, +"type": "string" } }, "type": "object" @@ -99890,6 +100792,16 @@ false "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "type": "string" }, +"pauseTime": { +"description": "Output only. The timestamp at which the Rollout was paused.", +"readOnly": true, +"type": "string" +}, +"resumeTime": { +"description": "Output only. The timestamp at which the Rollout was resumed.", +"readOnly": true, +"type": "string" +}, "rolloutEntity": { "$ref": "RolloutRolloutEntity", "description": "Required. The resource being rolled out." @@ -102071,6 +102983,12 @@ false }, "type": "array" }, +"effectiveTcpTimeWaitTimeoutSec": { +"description": "Output only. Effective timeout (in seconds) for TCP connections that are in TIME_WAIT\nstate. This value is equal to tcp_time_wait_timeout_sec if it is set,\notherwise it is equal to 120s. The field is output only.", +"format": "int32", +"readOnly": true, +"type": "integer" +}, "enableDynamicPortAllocation": { "description": "Enable Dynamic Port Allocation.\n\n\nIf not specified, it is disabled by default.\n\n\nIf set to true,\n \n - Dynamic Port Allocation will be enabled on this NAT\n config.\n - enableEndpointIndependentMapping cannot be set to true.\n - If minPorts is set, minPortsPerVm must be set to a\n power of two greater than or equal to 32. If minPortsPerVm is not set, a\n minimum of 32 ports will be allocated to a VM from this NAT\n config.", "type": "boolean" @@ -115607,6 +116525,21 @@ false }, "type": "object" }, +"TimeZone": { +"description": "Represents a time zone from the\n[IANA Time Zone Database](https://www.iana.org/time-zones).", +"id": "TimeZone", +"properties": { +"id": { +"description": "IANA Time Zone Database time zone. For example \"America/New_York\".", +"type": "string" +}, +"version": { +"description": "Optional. IANA Time Zone Database version number. For example \"2019a\".", +"type": "string" +} +}, +"type": "object" +}, "Uint128": { "id": "Uint128", "properties": { @@ -119766,6 +120699,10 @@ false "description": "[Output Only] Full URL reference to the region which hosts the zone.", "type": "string" }, +"resourceStatus": { +"$ref": "ZoneResourceStatus", +"readOnly": true +}, "selfLink": { "description": "[Output Only] Server-defined URL for the resource.", "type": "string" @@ -119947,6 +120884,20 @@ false }, "type": "object" }, +"ZoneResourceStatus": { +"id": "ZoneResourceStatus", +"properties": { +"upcomingMaintenances": { +"description": "Output only. [Output Only] The upcoming maintenance schedule.", +"items": { +"$ref": "PeriodicPartialMaintenanceSchedule" +}, +"readOnly": true, +"type": "array" +} +}, +"type": "object" +}, "ZoneSetLabelsRequest": { "id": "ZoneSetLabelsRequest", "properties": { diff --git a/googleapiclient/discovery_cache/documents/config.v1.json b/googleapiclient/discovery_cache/documents/config.v1.json index 0a8f287a1b..6edb01f38e 100644 --- a/googleapiclient/discovery_cache/documents/config.v1.json +++ b/googleapiclient/discovery_cache/documents/config.v1.json @@ -15,6 +15,38 @@ "description": "Creates and manages Google Cloud Platform resources and infrastructure.", "discoveryVersion": "v1", "documentationLink": "https://cloud.google.com/infrastructure-manager/docs", +"endpoints": [ +{ +"description": "Regional Endpoint", +"endpointUrl": "https://config.us-south1.rep.googleapis.com/", +"location": "us-south1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://config.us-west3.rep.googleapis.com/", +"location": "us-west3" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://config.us-east4.rep.googleapis.com/", +"location": "us-east4" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://config.us-west4.rep.googleapis.com/", +"location": "us-west4" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://config.us-east5.rep.googleapis.com/", +"location": "us-east5" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://config.us-east7.rep.googleapis.com/", +"location": "us-east7" +} +], "fullyEncodeReservedExpansion": true, "icons": { "x16": "http://www.google.com/images/icons/product/search-16.gif", @@ -1736,7 +1768,7 @@ } } }, -"revision": "20260422", +"revision": "20260513", "rootUrl": "https://config.googleapis.com/", "schemas": { "ApplyResults": { diff --git a/googleapiclient/discovery_cache/documents/connectors.v2.json b/googleapiclient/discovery_cache/documents/connectors.v2.json index b67e1a8c07..35e9a9be16 100644 --- a/googleapiclient/discovery_cache/documents/connectors.v2.json +++ b/googleapiclient/discovery_cache/documents/connectors.v2.json @@ -999,6 +999,12 @@ "pattern": "^projects/[^/]+/locations/[^/]+/connections/[^/]+$", "required": true, "type": "string" +}, +"toolNames": { +"description": "List of tool names for selective tool fetching.", +"location": "query", +"repeated": true, +"type": "string" } }, "path": "v2/{+parent}/tools", @@ -1018,7 +1024,7 @@ } } }, -"revision": "20260427", +"revision": "20260527", "rootUrl": "https://connectors.googleapis.com/", "schemas": { "AccessCredentials": { diff --git a/googleapiclient/discovery_cache/documents/contactcenterinsights.v1.json b/googleapiclient/discovery_cache/documents/contactcenterinsights.v1.json index e3f35588c9..0e59ef400f 100644 --- a/googleapiclient/discovery_cache/documents/contactcenterinsights.v1.json +++ b/googleapiclient/discovery_cache/documents/contactcenterinsights.v1.json @@ -4568,6 +4568,16 @@ "parent" ], "parameters": { +"appId": { +"description": "Optional. The CES App ID to filter diagnostics by.", +"location": "query", +"type": "string" +}, +"appVersion": { +"description": "Optional. The CES App version to filter diagnostics by. Setting to \"-\" filters to diagnostics created using \"-\" (the latest draft version). Note that reports created at different times may correspond to different draft instructions. Setting to \"\" (empty) retrieves all diagnostics for the app_id regardless of version.", +"location": "query", +"type": "string" +}, "filter": { "description": "Optional. A filter to apply to the list (e.g. `create_time > \"2023-01-01T00:00:00Z\"`).", "location": "query", @@ -6224,7 +6234,7 @@ } } }, -"revision": "20260510", +"revision": "20260527", "rootUrl": "https://contactcenterinsights.googleapis.com/", "schemas": { "GoogleCloudAiplatformV1Blob": { @@ -8724,6 +8734,10 @@ true "description": "The entry subagent's display name.", "type": "string" }, +"entrySubagentId": { +"description": "The entry subagent's ID.", +"type": "string" +}, "location": { "description": "The agent's location.", "type": "string" @@ -9330,6 +9344,14 @@ true "description": "Metadata for a DiagnoseConversations operation.", "id": "GoogleCloudContactcenterinsightsV1DiagnoseConversationsMetadata", "properties": { +"conversationIds": { +"description": "Output only. The list of conversation IDs that were selected for this diagnosis.", +"items": { +"type": "string" +}, +"readOnly": true, +"type": "array" +}, "createTime": { "description": "Output only. The time the operation was created.", "format": "google-datetime", @@ -9401,6 +9423,22 @@ true "description": "The request to analyze conversation data using agentic workflows. This RPC triggers a complex analysis process that may involve several steps of reasoning and tool execution.", "id": "GoogleCloudContactcenterinsightsV1DiagnoseConversationsRequest", "properties": { +"agentDisplayName": { +"description": "ces agent display name (e.g., \"Steering\", \"Billing\").", +"type": "string" +}, +"agentId": { +"description": "ces agent id to diagnose.", +"type": "string" +}, +"appId": { +"description": "Required. The CES App ID.", +"type": "string" +}, +"appVersion": { +"description": "Required. The CES App version of the agent. Setting to \"-\" uses the latest draft version. Note that the agent active during the conversation history may have different instructions or tool definitions compared with the latest draft version.", +"type": "string" +}, "dryRun": { "deprecated": true, "description": "Optional. Deprecated: If true, the request will be validated and a simulation of the analysis will be performed without actually executing the task. This field is unused. Use validate_only instead.", @@ -9415,8 +9453,13 @@ true "description": "Optional. Deprecated: If true, the agent will generate a full diagnostic report for all sub-agents. Subagent reporting configuration is unused. The final diagnostic details are already persisted inside the Diagnostic resource instead.", "type": "boolean" }, +"groupId": { +"description": "Optional. A unique identifier used to group multiple diagnostic requests triggered under the same run batch or cron job.", +"type": "string" +}, "instructions": { -"description": "Optional. Specific instructions for the agent.", +"deprecated": true, +"description": "Optional. Deprecated: Specific instructions for the agent. Use app_id and subagent fields instead.", "type": "string" }, "maxSteps": { @@ -9503,11 +9546,31 @@ true "description": "The diagnostic resource.", "id": "GoogleCloudContactcenterinsightsV1Diagnostic", "properties": { +"agentDisplayName": { +"description": "Output only. The display name of the agent associated with the diagnostic.", +"readOnly": true, +"type": "string" +}, +"agentId": { +"description": "Output only. The ID of the agent associated with the diagnostic.", +"readOnly": true, +"type": "string" +}, "analysisSummary": { "description": "Output only. The complete sequence of thoughts and actions taken by the agent.", "readOnly": true, "type": "string" }, +"appId": { +"description": "Output only. The application ID associated with the diagnostic.", +"readOnly": true, +"type": "string" +}, +"appVersion": { +"description": "Output only. The application version associated with the diagnostic.", +"readOnly": true, +"type": "string" +}, "conversationFilter": { "description": "Output only. The filter used to select the conversations that were included in the diagnostic.", "readOnly": true, @@ -9519,6 +9582,12 @@ true "readOnly": true, "type": "string" }, +"groupCreateTime": { +"description": "Output only. The timestamp when the group was created.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, "name": { "description": "Immutable. Identifier. The resource name of the diagnostic.", "type": "string" @@ -9532,7 +9601,7 @@ true "type": "object" }, "GoogleCloudContactcenterinsightsV1DiagnosticReport": { -"description": "A diagnostic report containing aggregate metrics and intent breakdowns.", +"description": "A diagnostic report containing loss patterns and problematic slice stats.", "id": "GoogleCloudContactcenterinsightsV1DiagnosticReport", "properties": { "conversationSlices": { @@ -15554,6 +15623,10 @@ true "description": "The entry subagent's display name.", "type": "string" }, +"entrySubagentId": { +"description": "The entry subagent's ID.", +"type": "string" +}, "location": { "description": "The agent's location.", "type": "string" @@ -15995,6 +16068,14 @@ true "description": "Metadata for a DiagnoseConversations operation.", "id": "GoogleCloudContactcenterinsightsV1alpha1DiagnoseConversationsMetadata", "properties": { +"conversationIds": { +"description": "Output only. The list of conversation IDs that were selected for this diagnosis.", +"items": { +"type": "string" +}, +"readOnly": true, +"type": "array" +}, "createTime": { "description": "Output only. The time the operation was created.", "format": "google-datetime", @@ -16066,6 +16147,22 @@ true "description": "The request to analyze conversation data using agentic workflows. This RPC triggers a complex analysis process that may involve several steps of reasoning and tool execution.", "id": "GoogleCloudContactcenterinsightsV1alpha1DiagnoseConversationsRequest", "properties": { +"agentDisplayName": { +"description": "ces agent display name (e.g., \"Steering\", \"Billing\").", +"type": "string" +}, +"agentId": { +"description": "ces agent id to diagnose.", +"type": "string" +}, +"appId": { +"description": "Required. The CES App ID.", +"type": "string" +}, +"appVersion": { +"description": "Required. The CES App version of the agent. Setting to \"-\" uses the latest draft version. Note that the agent active during the conversation history may have different instructions or tool definitions compared with the latest draft version.", +"type": "string" +}, "dryRun": { "deprecated": true, "description": "Optional. Deprecated: If true, the request will be validated and a simulation of the analysis will be performed without actually executing the task. This field is unused. Use validate_only instead.", @@ -16080,8 +16177,13 @@ true "description": "Optional. Deprecated: If true, the agent will generate a full diagnostic report for all sub-agents. Subagent reporting configuration is unused. The final diagnostic details are already persisted inside the Diagnostic resource instead.", "type": "boolean" }, +"groupId": { +"description": "Optional. A unique identifier used to group multiple diagnostic requests triggered under the same run batch or cron job.", +"type": "string" +}, "instructions": { -"description": "Optional. Specific instructions for the agent.", +"deprecated": true, +"description": "Optional. Deprecated: Specific instructions for the agent. Use app_id and subagent fields instead.", "type": "string" }, "maxSteps": { @@ -16165,7 +16267,7 @@ true "type": "object" }, "GoogleCloudContactcenterinsightsV1alpha1DiagnosticReport": { -"description": "A diagnostic report containing aggregate metrics and intent breakdowns.", +"description": "A diagnostic report containing loss patterns and problematic slice stats.", "id": "GoogleCloudContactcenterinsightsV1alpha1DiagnosticReport", "properties": { "conversationSlices": { @@ -20757,6 +20859,10 @@ true "description": "The entry subagent's display name.", "type": "string" }, +"entrySubagentId": { +"description": "The entry subagent's ID.", +"type": "string" +}, "location": { "description": "The agent's location.", "type": "string" @@ -21198,6 +21304,14 @@ true "description": "Metadata for a DiagnoseConversations operation.", "id": "GoogleCloudContactcenterinsightsV1mainDiagnoseConversationsMetadata", "properties": { +"conversationIds": { +"description": "Output only. The list of conversation IDs that were selected for this diagnosis.", +"items": { +"type": "string" +}, +"readOnly": true, +"type": "array" +}, "createTime": { "description": "Output only. The time the operation was created.", "format": "google-datetime", @@ -21269,6 +21383,22 @@ true "description": "The request to analyze conversation data using agentic workflows. This RPC triggers a complex analysis process that may involve several steps of reasoning and tool execution.", "id": "GoogleCloudContactcenterinsightsV1mainDiagnoseConversationsRequest", "properties": { +"agentDisplayName": { +"description": "ces agent display name (e.g., \"Steering\", \"Billing\").", +"type": "string" +}, +"agentId": { +"description": "ces agent id to diagnose.", +"type": "string" +}, +"appId": { +"description": "Required. The CES App ID.", +"type": "string" +}, +"appVersion": { +"description": "Required. The CES App version of the agent. Setting to \"-\" uses the latest draft version. Note that the agent active during the conversation history may have different instructions or tool definitions compared with the latest draft version.", +"type": "string" +}, "dryRun": { "deprecated": true, "description": "Optional. Deprecated: If true, the request will be validated and a simulation of the analysis will be performed without actually executing the task. This field is unused. Use validate_only instead.", @@ -21283,8 +21413,13 @@ true "description": "Optional. Deprecated: If true, the agent will generate a full diagnostic report for all sub-agents. Subagent reporting configuration is unused. The final diagnostic details are already persisted inside the Diagnostic resource instead.", "type": "boolean" }, +"groupId": { +"description": "Optional. A unique identifier used to group multiple diagnostic requests triggered under the same run batch or cron job.", +"type": "string" +}, "instructions": { -"description": "Optional. Specific instructions for the agent.", +"deprecated": true, +"description": "Optional. Deprecated: Specific instructions for the agent. Use app_id and subagent fields instead.", "type": "string" }, "maxSteps": { @@ -21368,7 +21503,7 @@ true "type": "object" }, "GoogleCloudContactcenterinsightsV1mainDiagnosticReport": { -"description": "A diagnostic report containing aggregate metrics and intent breakdowns.", +"description": "A diagnostic report containing loss patterns and problematic slice stats.", "id": "GoogleCloudContactcenterinsightsV1mainDiagnosticReport", "properties": { "conversationSlices": { diff --git a/googleapiclient/discovery_cache/documents/container.v1.json b/googleapiclient/discovery_cache/documents/container.v1.json index 72734dc28d..119d14b1bf 100644 --- a/googleapiclient/discovery_cache/documents/container.v1.json +++ b/googleapiclient/discovery_cache/documents/container.v1.json @@ -4,6 +4,12 @@ "scopes": { "https://www.googleapis.com/auth/cloud-platform": { "description": "See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account." +}, +"https://www.googleapis.com/auth/container": { +"description": "See, edit, configure, and delete your Google Kubernetes Engine data and see the email address for your Google Account" +}, +"https://www.googleapis.com/auth/container.read-only": { +"description": "See your Google Kubernetes Engine data and the email address of your Google Account" } } } @@ -149,7 +155,9 @@ "$ref": "ListUsableSubnetworksResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/container", +"https://www.googleapis.com/auth/container.read-only" ] } } @@ -192,7 +200,9 @@ "$ref": "ServerConfig" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/container", +"https://www.googleapis.com/auth/container.read-only" ] } }, @@ -221,7 +231,9 @@ "$ref": "CheckAutopilotCompatibilityResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/container", +"https://www.googleapis.com/auth/container.read-only" ] }, "completeIpRotation": { @@ -249,7 +261,8 @@ "$ref": "Operation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/container" ] }, "create": { @@ -277,7 +290,8 @@ "$ref": "Operation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/container" ] }, "delete": { @@ -320,7 +334,8 @@ "$ref": "Operation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/container" ] }, "fetchClusterUpgradeInfo": { @@ -350,7 +365,9 @@ "$ref": "ClusterUpgradeInfo" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/container", +"https://www.googleapis.com/auth/container.read-only" ] }, "get": { @@ -393,7 +410,9 @@ "$ref": "Cluster" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/container", +"https://www.googleapis.com/auth/container.read-only" ] }, "getJwks": { @@ -452,7 +471,9 @@ "$ref": "ListClustersResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/container", +"https://www.googleapis.com/auth/container.read-only" ] }, "setAddons": { @@ -480,7 +501,8 @@ "$ref": "Operation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/container" ] }, "setLegacyAbac": { @@ -508,7 +530,8 @@ "$ref": "Operation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/container" ] }, "setLocations": { @@ -537,7 +560,8 @@ "$ref": "Operation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/container" ] }, "setLogging": { @@ -565,7 +589,8 @@ "$ref": "Operation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/container" ] }, "setMaintenancePolicy": { @@ -593,7 +618,8 @@ "$ref": "Operation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/container" ] }, "setMasterAuth": { @@ -621,7 +647,8 @@ "$ref": "Operation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/container" ] }, "setMonitoring": { @@ -649,7 +676,8 @@ "$ref": "Operation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/container" ] }, "setNetworkPolicy": { @@ -677,7 +705,8 @@ "$ref": "Operation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/container" ] }, "setResourceLabels": { @@ -705,7 +734,8 @@ "$ref": "Operation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/container" ] }, "startIpRotation": { @@ -733,7 +763,8 @@ "$ref": "Operation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/container" ] }, "update": { @@ -761,7 +792,8 @@ "$ref": "Operation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/container" ] }, "updateMaster": { @@ -789,7 +821,8 @@ "$ref": "Operation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/container" ] } }, @@ -821,7 +854,8 @@ "$ref": "Empty" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/container" ] }, "create": { @@ -849,7 +883,8 @@ "$ref": "Operation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/container" ] }, "delete": { @@ -898,7 +933,8 @@ "$ref": "Operation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/container" ] }, "fetchNodePoolUpgradeInfo": { @@ -928,7 +964,9 @@ "$ref": "NodePoolUpgradeInfo" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/container", +"https://www.googleapis.com/auth/container.read-only" ] }, "get": { @@ -977,7 +1015,9 @@ "$ref": "NodePool" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/container", +"https://www.googleapis.com/auth/container.read-only" ] }, "list": { @@ -1020,7 +1060,9 @@ "$ref": "ListNodePoolsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/container", +"https://www.googleapis.com/auth/container.read-only" ] }, "rollback": { @@ -1048,7 +1090,8 @@ "$ref": "Operation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/container" ] }, "setAutoscaling": { @@ -1076,7 +1119,8 @@ "$ref": "Operation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/container" ] }, "setManagement": { @@ -1104,7 +1148,8 @@ "$ref": "Operation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/container" ] }, "setSize": { @@ -1132,7 +1177,8 @@ "$ref": "Operation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/container" ] }, "update": { @@ -1160,7 +1206,8 @@ "$ref": "Operation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/container" ] } } @@ -1220,7 +1267,8 @@ "$ref": "Empty" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/container" ] }, "get": { @@ -1263,7 +1311,9 @@ "$ref": "Operation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/container", +"https://www.googleapis.com/auth/container.read-only" ] }, "list": { @@ -1300,7 +1350,9 @@ "$ref": "ListOperationsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/container", +"https://www.googleapis.com/auth/container.read-only" ] } } @@ -1342,7 +1394,9 @@ "$ref": "ServerConfig" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/container", +"https://www.googleapis.com/auth/container.read-only" ] } }, @@ -1387,7 +1441,8 @@ "$ref": "Operation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/container" ] }, "completeIpRotation": { @@ -1428,7 +1483,8 @@ "$ref": "Operation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/container" ] }, "create": { @@ -1462,7 +1518,8 @@ "$ref": "Operation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/container" ] }, "delete": { @@ -1505,7 +1562,8 @@ "$ref": "Operation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/container" ] }, "fetchClusterUpgradeInfo": { @@ -1535,7 +1593,9 @@ "$ref": "ClusterUpgradeInfo" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/container", +"https://www.googleapis.com/auth/container.read-only" ] }, "get": { @@ -1578,7 +1638,9 @@ "$ref": "Cluster" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/container", +"https://www.googleapis.com/auth/container.read-only" ] }, "legacyAbac": { @@ -1619,7 +1681,8 @@ "$ref": "Operation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/container" ] }, "list": { @@ -1655,7 +1718,9 @@ "$ref": "ListClustersResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/container", +"https://www.googleapis.com/auth/container.read-only" ] }, "locations": { @@ -1697,7 +1762,8 @@ "$ref": "Operation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/container" ] }, "logging": { @@ -1738,7 +1804,8 @@ "$ref": "Operation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/container" ] }, "master": { @@ -1779,7 +1846,8 @@ "$ref": "Operation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/container" ] }, "monitoring": { @@ -1820,7 +1888,8 @@ "$ref": "Operation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/container" ] }, "resourceLabels": { @@ -1861,7 +1930,8 @@ "$ref": "Operation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/container" ] }, "setMaintenancePolicy": { @@ -1902,7 +1972,8 @@ "$ref": "Operation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/container" ] }, "setMasterAuth": { @@ -1943,7 +2014,8 @@ "$ref": "Operation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/container" ] }, "setNetworkPolicy": { @@ -1984,7 +2056,8 @@ "$ref": "Operation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/container" ] }, "startIpRotation": { @@ -2025,7 +2098,8 @@ "$ref": "Operation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/container" ] }, "update": { @@ -2066,7 +2140,8 @@ "$ref": "Operation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/container" ] } }, @@ -2118,7 +2193,8 @@ "$ref": "Operation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/container" ] }, "create": { @@ -2159,7 +2235,8 @@ "$ref": "Operation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/container" ] }, "delete": { @@ -2209,7 +2286,8 @@ "$ref": "Operation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/container" ] }, "fetchNodePoolUpgradeInfo": { @@ -2239,7 +2317,9 @@ "$ref": "NodePoolUpgradeInfo" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/container", +"https://www.googleapis.com/auth/container.read-only" ] }, "get": { @@ -2289,7 +2369,9 @@ "$ref": "NodePool" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/container", +"https://www.googleapis.com/auth/container.read-only" ] }, "list": { @@ -2332,7 +2414,9 @@ "$ref": "ListNodePoolsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/container", +"https://www.googleapis.com/auth/container.read-only" ] }, "rollback": { @@ -2380,7 +2464,8 @@ "$ref": "Operation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/container" ] }, "setManagement": { @@ -2428,7 +2513,8 @@ "$ref": "Operation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/container" ] }, "setSize": { @@ -2476,7 +2562,8 @@ "$ref": "Operation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/container" ] }, "update": { @@ -2524,7 +2611,8 @@ "$ref": "Operation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/container" ] } } @@ -2571,7 +2659,8 @@ "$ref": "Empty" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/container" ] }, "get": { @@ -2614,7 +2703,9 @@ "$ref": "Operation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/container", +"https://www.googleapis.com/auth/container.read-only" ] }, "list": { @@ -2650,7 +2741,9 @@ "$ref": "ListOperationsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/container", +"https://www.googleapis.com/auth/container.read-only" ] } } @@ -2660,7 +2753,7 @@ } } }, -"revision": "20260421", +"revision": "20260519", "rootUrl": "https://container.googleapis.com/", "schemas": { "AcceleratorConfig": { @@ -2798,6 +2891,10 @@ "description": "Configuration for the addons that can be automatically spun up in the cluster, enabling additional functionality.", "id": "AddonsConfig", "properties": { +"agentSandboxConfig": { +"$ref": "AgentSandboxConfig", +"description": "Optional. Configuration for the AgentSandbox addon." +}, "cloudRunConfig": { "$ref": "CloudRunConfig", "description": "Configuration for the Cloud Run addon, which allows the user to use a managed Knative service." @@ -2945,6 +3042,17 @@ }, "type": "object" }, +"AgentSandboxConfig": { +"description": "Configuration for the AgentSandbox addon.", +"id": "AgentSandboxConfig", +"properties": { +"enabled": { +"description": "Optional. Whether AgentSandbox is enabled for this cluster.", +"type": "boolean" +} +}, +"type": "object" +}, "AnonymousAuthenticationConfig": { "description": "AnonymousAuthenticationConfig defines the settings needed to limit endpoints that allow anonymous authentication.", "id": "AnonymousAuthenticationConfig", @@ -3743,6 +3851,10 @@ "deprecated": true, "description": "Parameters used in creating the cluster's nodes. For requests, this field should only be used in lieu of a \"node_pool\" object, since this configuration (along with the \"initial_node_count\") will be used to create a \"NodePool\" object with an auto-generated name. Do not use this and a node_pool at the same time. For responses, this field will be populated with the node configuration of the first node pool. (For configuration of each node pool, see `node_pool.config`) If unspecified, the defaults are used. This field is deprecated, use node_pool.config instead." }, +"nodeCreationConfig": { +"$ref": "NodeCreationConfig", +"description": "Optional. Configuration for Node Creation Mode." +}, "nodeIpv4CidrSize": { "description": "Output only. The size of the address space on each node for hosting containers. This is provisioned from within the `container_ipv4_cidr` range. This field will only be set when cluster is in route-based network mode.", "format": "int32", @@ -4139,6 +4251,14 @@ "$ref": "IdentityServiceConfig", "description": "The desired Identity Service component configuration." }, +"desiredImage": { +"description": "The desired name of the image to use for this node. This is used to create clusters using a custom image. NOTE: Set the \"desired_node_pool\" field as well.", +"type": "string" +}, +"desiredImageProject": { +"description": "The project containing the desired image to use for this node. This is used to create clusters using a custom image. NOTE: Set the \"desired_node_pool\" field as well.", +"type": "string" +}, "desiredImageType": { "description": "The desired image type for the node pool. NOTE: Set the \"desired_node_pool\" field as well.", "type": "string" @@ -4221,6 +4341,10 @@ "$ref": "NetworkTierConfig", "description": "The desired network tier configuration for the cluster." }, +"desiredNodeCreationConfig": { +"$ref": "NodeCreationConfig", +"description": "Optional. The desired NodeCreationConfig for the cluster." +}, "desiredNodeKubeletConfig": { "$ref": "NodeKubeletConfig", "description": "The desired node kubelet config for the cluster." @@ -4706,6 +4830,25 @@ }, "type": "object" }, +"CustomImageConfig": { +"description": "CustomImageConfig contains the information r", +"id": "CustomImageConfig", +"properties": { +"image": { +"description": "The name of the image to use for this node.", +"type": "string" +}, +"imageFamily": { +"description": "The name of the image family to use for this node.", +"type": "string" +}, +"imageProject": { +"description": "The project containing the image to use for this node.", +"type": "string" +} +}, +"type": "object" +}, "CustomNodeInit": { "description": "Support for running custom init code while bootstrapping nodes.", "id": "CustomNodeInit", @@ -4874,6 +5017,27 @@ }, "type": "object" }, +"DataplaneV2Config": { +"description": "DataplaneV2Config is the configuration for DPv2.", +"id": "DataplaneV2Config", +"properties": { +"scalabilityMode": { +"description": "Optional. Scalability mode for the cluster.", +"enum": [ +"SCALABILITY_MODE_UNSPECIFIED", +"DISABLED", +"SCALE_OPTIMIZED" +], +"enumDescriptions": [ +"Default value.", +"Disables the scale optimized mode for DPv2.", +"Enables the scale optimized mode for DPv2." +], +"type": "string" +} +}, +"type": "object" +}, "Date": { "description": "Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp", "id": "Date", @@ -5224,6 +5388,29 @@ }, "type": "object" }, +"ExclusionUntilEndOfSupport": { +"description": "Defines the maintenance exclusion for the node pool.", +"id": "ExclusionUntilEndOfSupport", +"properties": { +"enabled": { +"description": "Optional. Indicates whether the exclusion is enabled.", +"type": "boolean" +}, +"endTime": { +"description": "Output only. The end time of the maintenance exclusion. It is output only. It is the cluster control plane version's end of support time, or end of extended support time when the cluster is on extended support channel.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"startTime": { +"description": "Output only. The start time of the maintenance exclusion. It is output only. It is the exclusion creation time.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, "FastSocket": { "description": "Configuration of Fast Socket feature.", "id": "FastSocket", @@ -6030,7 +6217,7 @@ false "additionalProperties": { "type": "string" }, -"description": "The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_mtu_probing net.ipv4.tcp_max_orphans net.ipv4.tcp_max_tw_buckets net.ipv4.tcp_syn_retries net.ipv4.tcp_ecn net.ipv4.tcp_congestion_control net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.shmmni kernel.shmmax kernel.shmall kernel.perf_event_paranoid kernel.sched_rt_runtime_us kernel.softlockup_panic kernel.yama.ptrace_scope kernel.kptr_restrict kernel.dmesg_restrict kernel.sysrq fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_background_bytes vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_bytes vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes", +"description": "The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.neigh.default.gc_thresh1 net.ipv4.neigh.default.gc_thresh2 net.ipv4.neigh.default.gc_thresh3 net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_mtu_probing net.ipv4.tcp_max_orphans net.ipv4.tcp_max_tw_buckets net.ipv4.tcp_syn_retries net.ipv4.tcp_ecn net.ipv4.tcp_congestion_control net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.keys.maxkeys kernel.keys.maxbytes kernel.shmmni kernel.shmmax kernel.shmall kernel.perf_event_paranoid kernel.sched_rt_runtime_us kernel.softlockup_panic kernel.yama.ptrace_scope kernel.kptr_restrict kernel.dmesg_restrict kernel.sysrq fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_background_bytes vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_bytes vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes", "type": "object" }, "transparentHugepageDefrag": { @@ -6577,6 +6764,10 @@ false ], "type": "string" }, +"dataplaneV2Config": { +"$ref": "DataplaneV2Config", +"description": "Optional. DataplaneV2Config specifies the DPv2 configuration." +}, "defaultEnablePrivateNodes": { "description": "Controls whether by default nodes have private IP addresses only. It is invalid to specify both PrivateClusterConfig.enablePrivateNodes and this field at the same time. To update the default setting, use ClusterUpdate.desired_default_enable_private_nodes", "type": "boolean" @@ -6948,6 +7139,10 @@ false "description": "Setting this field will assign instances of this pool to run on the specified node group. This is useful for running workloads on [sole tenant nodes](https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes).", "type": "string" }, +"nodeImageConfig": { +"$ref": "CustomImageConfig", +"description": "The node image configuration to use for this node pool. Note that this is only applicable for node pools using image_type=CUSTOM." +}, "oauthScopes": { "description": "The set of Google API scopes to be made available on all of the node VMs under the \"default\" service account. The following scopes are recommended, but not required, and by default are not included: * `https://www.googleapis.com/auth/compute` is required for mounting persistent storage on your nodes. * `https://www.googleapis.com/auth/devstorage.read_only` is required for communicating with **gcr.io** (the [Artifact Registry](https://cloud.google.com/artifact-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added.", "items": { @@ -7064,10 +7259,41 @@ false }, "type": "object" }, +"NodeCreationConfig": { +"description": "NodeCreationConfig defines the settings of node creation mode.", +"id": "NodeCreationConfig", +"properties": { +"nodeCreationMode": { +"description": "The mode of node creation.", +"enum": [ +"MODE_UNSPECIFIED", +"VIA_KUBELET", +"VIA_CONTROL_PLANE" +], +"enumDescriptions": [ +"When no user input is provided.", +"Kubelet registers itself.", +"gcp-controller-manager automatically creates the node object after CSR approval." +], +"type": "string" +} +}, +"type": "object" +}, "NodeDrainConfig": { "description": "NodeDrainConfig contains the node drain related configurations for this node pool.", "id": "NodeDrainConfig", "properties": { +"graceTerminationDuration": { +"description": "The duration of the grace termination period for node drain.", +"format": "google-duration", +"type": "string" +}, +"pdbTimeoutDuration": { +"description": "The duration of the PDB timeout period for node drain.", +"format": "google-duration", +"type": "string" +}, "respectPdbDuringNodePoolDeletion": { "description": "Whether to respect PDB during node pool deletion.", "type": "boolean" @@ -7269,6 +7495,10 @@ false "description": "Whether nodes have internal IP addresses only. If enable_private_nodes is not specified, then the value is derived from Cluster.NetworkConfig.default_enable_private_nodes", "type": "boolean" }, +"network": { +"description": "Optional. Immutable. The VPC network for the node pool.", +"type": "string" +}, "networkPerformanceConfig": { "$ref": "NetworkPerformanceConfig", "description": "Network bandwidth tier configuration." @@ -7354,6 +7584,10 @@ false }, "type": "array" }, +"maintenancePolicy": { +"$ref": "NodePoolMaintenancePolicy", +"description": "Optional. Specifies the maintenance policy for the node pool." +}, "management": { "$ref": "NodeManagement", "description": "NodeManagement configuration for this NodePool." @@ -7533,6 +7767,17 @@ false }, "type": "object" }, +"NodePoolMaintenancePolicy": { +"description": "Defines the maintenance policy for the node pool.", +"id": "NodePoolMaintenancePolicy", +"properties": { +"exclusionUntilEndOfSupport": { +"$ref": "ExclusionUntilEndOfSupport", +"description": "Optional. The exclusion until end of support for the node pool." +} +}, +"type": "object" +}, "NodePoolUpgradeInfo": { "description": "NodePoolUpgradeInfo contains the upgrade information of a node pool.", "id": "NodePoolUpgradeInfo", @@ -9654,6 +9899,14 @@ false "$ref": "VirtualNIC", "description": "Enable or disable gvnic on the node pool." }, +"image": { +"description": "The desired name of the image name to use for this node. This is used to create clusters using a custom image.", +"type": "string" +}, +"imageProject": { +"description": "The project containing the desired image to use for this node pool. This is used to create clusters using a custom image.", +"type": "string" +}, "imageType": { "description": "Required. The desired image type for the node pool. Please see https://cloud.google.com/kubernetes-engine/docs/concepts/node-images for available image types.", "type": "string" diff --git a/googleapiclient/discovery_cache/documents/container.v1beta1.json b/googleapiclient/discovery_cache/documents/container.v1beta1.json index f664c8080f..16407ab0ac 100644 --- a/googleapiclient/discovery_cache/documents/container.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/container.v1beta1.json @@ -4,6 +4,12 @@ "scopes": { "https://www.googleapis.com/auth/cloud-platform": { "description": "See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account." +}, +"https://www.googleapis.com/auth/container": { +"description": "See, edit, configure, and delete your Google Kubernetes Engine data and see the email address for your Google Account" +}, +"https://www.googleapis.com/auth/container.read-only": { +"description": "See your Google Kubernetes Engine data and the email address of your Google Account" } } } @@ -149,7 +155,9 @@ "$ref": "ListUsableSubnetworksResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/container", +"https://www.googleapis.com/auth/container.read-only" ] } } @@ -192,7 +200,9 @@ "$ref": "ServerConfig" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/container", +"https://www.googleapis.com/auth/container.read-only" ] }, "list": { @@ -217,7 +227,8 @@ "$ref": "ListLocationsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/container" ] } }, @@ -246,7 +257,9 @@ "$ref": "CheckAutopilotCompatibilityResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/container", +"https://www.googleapis.com/auth/container.read-only" ] }, "completeControlPlaneUpgrade": { @@ -274,7 +287,8 @@ "$ref": "Operation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/container" ] }, "completeIpRotation": { @@ -302,7 +316,8 @@ "$ref": "Operation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/container" ] }, "create": { @@ -330,7 +345,8 @@ "$ref": "Operation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/container" ] }, "delete": { @@ -373,7 +389,8 @@ "$ref": "Operation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/container" ] }, "fetchClusterUpgradeInfo": { @@ -403,7 +420,9 @@ "$ref": "ClusterUpgradeInfo" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/container", +"https://www.googleapis.com/auth/container.read-only" ] }, "get": { @@ -446,7 +465,9 @@ "$ref": "Cluster" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/container", +"https://www.googleapis.com/auth/container.read-only" ] }, "getJwks": { @@ -505,7 +526,9 @@ "$ref": "ListClustersResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/container", +"https://www.googleapis.com/auth/container.read-only" ] }, "setAddons": { @@ -533,7 +556,8 @@ "$ref": "Operation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/container" ] }, "setLegacyAbac": { @@ -561,7 +585,8 @@ "$ref": "Operation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/container" ] }, "setLocations": { @@ -590,7 +615,8 @@ "$ref": "Operation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/container" ] }, "setLogging": { @@ -618,7 +644,8 @@ "$ref": "Operation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/container" ] }, "setMaintenancePolicy": { @@ -646,7 +673,8 @@ "$ref": "Operation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/container" ] }, "setMasterAuth": { @@ -674,7 +702,8 @@ "$ref": "Operation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/container" ] }, "setMonitoring": { @@ -702,7 +731,8 @@ "$ref": "Operation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/container" ] }, "setNetworkPolicy": { @@ -730,7 +760,8 @@ "$ref": "Operation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/container" ] }, "setResourceLabels": { @@ -758,7 +789,8 @@ "$ref": "Operation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/container" ] }, "startIpRotation": { @@ -786,7 +818,8 @@ "$ref": "Operation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/container" ] }, "update": { @@ -814,7 +847,8 @@ "$ref": "Operation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/container" ] }, "updateMaster": { @@ -842,7 +876,8 @@ "$ref": "Operation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/container" ] } }, @@ -874,7 +909,8 @@ "$ref": "Empty" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/container" ] }, "create": { @@ -902,7 +938,8 @@ "$ref": "Operation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/container" ] }, "delete": { @@ -951,7 +988,8 @@ "$ref": "Operation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/container" ] }, "fetchNodePoolUpgradeInfo": { @@ -981,7 +1019,9 @@ "$ref": "NodePoolUpgradeInfo" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/container", +"https://www.googleapis.com/auth/container.read-only" ] }, "get": { @@ -1030,7 +1070,9 @@ "$ref": "NodePool" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/container", +"https://www.googleapis.com/auth/container.read-only" ] }, "list": { @@ -1073,7 +1115,9 @@ "$ref": "ListNodePoolsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/container", +"https://www.googleapis.com/auth/container.read-only" ] }, "rollback": { @@ -1101,7 +1145,8 @@ "$ref": "Operation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/container" ] }, "setAutoscaling": { @@ -1129,7 +1174,8 @@ "$ref": "Operation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/container" ] }, "setManagement": { @@ -1157,7 +1203,8 @@ "$ref": "Operation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/container" ] }, "setSize": { @@ -1185,7 +1232,8 @@ "$ref": "Operation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/container" ] }, "update": { @@ -1213,7 +1261,8 @@ "$ref": "Operation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/container" ] } } @@ -1273,7 +1322,8 @@ "$ref": "Empty" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/container" ] }, "get": { @@ -1316,7 +1366,9 @@ "$ref": "Operation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/container", +"https://www.googleapis.com/auth/container.read-only" ] }, "list": { @@ -1353,7 +1405,9 @@ "$ref": "ListOperationsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/container", +"https://www.googleapis.com/auth/container.read-only" ] } } @@ -1395,7 +1449,9 @@ "$ref": "ServerConfig" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/container", +"https://www.googleapis.com/auth/container.read-only" ] } }, @@ -1440,7 +1496,8 @@ "$ref": "Operation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/container" ] }, "completeControlPlaneUpgrade": { @@ -1468,7 +1525,8 @@ "$ref": "Operation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/container" ] }, "completeIpRotation": { @@ -1509,7 +1567,8 @@ "$ref": "Operation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/container" ] }, "create": { @@ -1543,7 +1602,8 @@ "$ref": "Operation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/container" ] }, "delete": { @@ -1586,7 +1646,8 @@ "$ref": "Operation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/container" ] }, "fetchClusterUpgradeInfo": { @@ -1616,7 +1677,9 @@ "$ref": "ClusterUpgradeInfo" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/container", +"https://www.googleapis.com/auth/container.read-only" ] }, "get": { @@ -1659,7 +1722,9 @@ "$ref": "Cluster" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/container", +"https://www.googleapis.com/auth/container.read-only" ] }, "legacyAbac": { @@ -1700,7 +1765,8 @@ "$ref": "Operation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/container" ] }, "list": { @@ -1736,7 +1802,9 @@ "$ref": "ListClustersResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/container", +"https://www.googleapis.com/auth/container.read-only" ] }, "locations": { @@ -1778,7 +1846,8 @@ "$ref": "Operation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/container" ] }, "logging": { @@ -1819,7 +1888,8 @@ "$ref": "Operation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/container" ] }, "master": { @@ -1860,7 +1930,8 @@ "$ref": "Operation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/container" ] }, "monitoring": { @@ -1901,7 +1972,8 @@ "$ref": "Operation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/container" ] }, "resourceLabels": { @@ -1942,7 +2014,8 @@ "$ref": "Operation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/container" ] }, "setMaintenancePolicy": { @@ -1983,7 +2056,8 @@ "$ref": "Operation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/container" ] }, "setMasterAuth": { @@ -2024,7 +2098,8 @@ "$ref": "Operation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/container" ] }, "setNetworkPolicy": { @@ -2065,7 +2140,8 @@ "$ref": "Operation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/container" ] }, "startIpRotation": { @@ -2106,7 +2182,8 @@ "$ref": "Operation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/container" ] }, "update": { @@ -2147,7 +2224,8 @@ "$ref": "Operation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/container" ] } }, @@ -2199,7 +2277,8 @@ "$ref": "Operation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/container" ] }, "create": { @@ -2240,7 +2319,8 @@ "$ref": "Operation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/container" ] }, "delete": { @@ -2290,7 +2370,8 @@ "$ref": "Operation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/container" ] }, "fetchNodePoolUpgradeInfo": { @@ -2320,7 +2401,9 @@ "$ref": "NodePoolUpgradeInfo" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/container", +"https://www.googleapis.com/auth/container.read-only" ] }, "get": { @@ -2370,7 +2453,9 @@ "$ref": "NodePool" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/container", +"https://www.googleapis.com/auth/container.read-only" ] }, "list": { @@ -2413,7 +2498,9 @@ "$ref": "ListNodePoolsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/container", +"https://www.googleapis.com/auth/container.read-only" ] }, "rollback": { @@ -2461,7 +2548,8 @@ "$ref": "Operation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/container" ] }, "setManagement": { @@ -2509,7 +2597,8 @@ "$ref": "Operation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/container" ] }, "setSize": { @@ -2557,7 +2646,8 @@ "$ref": "Operation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/container" ] }, "update": { @@ -2605,7 +2695,8 @@ "$ref": "Operation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/container" ] } } @@ -2652,7 +2743,8 @@ "$ref": "Empty" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/container" ] }, "get": { @@ -2695,7 +2787,9 @@ "$ref": "Operation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/container", +"https://www.googleapis.com/auth/container.read-only" ] }, "list": { @@ -2731,7 +2825,9 @@ "$ref": "ListOperationsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/container", +"https://www.googleapis.com/auth/container.read-only" ] } } @@ -2741,7 +2837,7 @@ } } }, -"revision": "20260421", +"revision": "20260519", "rootUrl": "https://container.googleapis.com/", "schemas": { "AcceleratorConfig": { @@ -3927,6 +4023,10 @@ "deprecated": true, "description": "Parameters used in creating the cluster's nodes. For requests, this field should only be used in lieu of a \"node_pool\" object, since this configuration (along with the \"initial_node_count\") will be used to create a \"NodePool\" object with an auto-generated name. Do not use this and a node_pool at the same time. For responses, this field will be populated with the node configuration of the first node pool. (For configuration of each node pool, see `node_pool.config`) If unspecified, the defaults are used. This field is deprecated, use node_pool.config instead." }, +"nodeCreationConfig": { +"$ref": "NodeCreationConfig", +"description": "Optional. Configuration for Node Creation Mode." +}, "nodeIpv4CidrSize": { "description": "Output only. The size of the address space on each node for hosting containers. This is provisioned from within the `container_ipv4_cidr` range. This field will only be set when cluster is in route-based network mode.", "format": "int32", @@ -4389,6 +4489,14 @@ "$ref": "IdentityServiceConfig", "description": "The desired Identity Service component configuration." }, +"desiredImage": { +"description": "The desired name of the image to use for this node. This is used to create clusters using a custom image.", +"type": "string" +}, +"desiredImageProject": { +"description": "The project containing the desired image to use for this node. This is used to create clusters using a custom image.", +"type": "string" +}, "desiredImageType": { "description": "The desired image type for the node pool. NOTE: Set the \"desired_node_pool\" field as well.", "type": "string" @@ -4475,6 +4583,10 @@ "$ref": "NetworkTierConfig", "description": "The desired network tier configuration for the cluster." }, +"desiredNodeCreationConfig": { +"$ref": "NodeCreationConfig", +"description": "Optional. The desired NodeCreationConfig for the cluster." +}, "desiredNodeKubeletConfig": { "$ref": "NodeKubeletConfig", "description": "The desired node kubelet config for the cluster." @@ -5032,6 +5144,25 @@ }, "type": "object" }, +"CustomImageConfig": { +"description": "CustomImageConfig contains the information r", +"id": "CustomImageConfig", +"properties": { +"image": { +"description": "The name of the image to use for this node.", +"type": "string" +}, +"imageFamily": { +"description": "The name of the image family to use for this node.", +"type": "string" +}, +"imageProject": { +"description": "The project containing the image to use for this node.", +"type": "string" +} +}, +"type": "object" +}, "CustomNodeInit": { "description": "Support for running custom init code while bootstrapping nodes.", "id": "CustomNodeInit", @@ -5200,6 +5331,27 @@ }, "type": "object" }, +"DataplaneV2Config": { +"description": "DataplaneV2Config is the configuration for DPv2.", +"id": "DataplaneV2Config", +"properties": { +"scalabilityMode": { +"description": "Optional. Scalability mode for the cluster.", +"enum": [ +"SCALABILITY_MODE_UNSPECIFIED", +"DISABLED", +"SCALE_OPTIMIZED" +], +"enumDescriptions": [ +"Default value.", +"Disables the scale optimized mode for DPv2.", +"Enables the scale optimized mode for DPv2." +], +"type": "string" +} +}, +"type": "object" +}, "Date": { "description": "Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp", "id": "Date", @@ -5562,6 +5714,29 @@ }, "type": "object" }, +"ExclusionUntilEndOfSupport": { +"description": "Defines the maintenance exclusion for the node pool.", +"id": "ExclusionUntilEndOfSupport", +"properties": { +"enabled": { +"description": "Optional. Indicates whether the exclusion is enabled.", +"type": "boolean" +}, +"endTime": { +"description": "Output only. The end time of the maintenance exclusion. It is output only. It is the cluster control plane version's end of support time, or end of extended support time when the cluster is on extended support channel.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"startTime": { +"description": "Output only. The start time of the maintenance exclusion. It is output only. It is the exclusion creation time.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, "FastSocket": { "description": "Configuration of Fast Socket feature.", "id": "FastSocket", @@ -6434,7 +6609,7 @@ false "additionalProperties": { "type": "string" }, -"description": "The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_mtu_probing net.ipv4.tcp_max_orphans net.ipv4.tcp_max_tw_buckets net.ipv4.tcp_syn_retries net.ipv4.tcp_ecn net.ipv4.tcp_congestion_control net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.shmmni kernel.shmmax kernel.shmall kernel.perf_event_paranoid kernel.sched_rt_runtime_us kernel.softlockup_panic kernel.yama.ptrace_scope kernel.kptr_restrict kernel.dmesg_restrict kernel.sysrq fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_background_bytes vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_bytes vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes", +"description": "The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.neigh.default.gc_thresh1 net.ipv4.neigh.default.gc_thresh2 net.ipv4.neigh.default.gc_thresh3 net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_mtu_probing net.ipv4.tcp_max_orphans net.ipv4.tcp_max_tw_buckets net.ipv4.tcp_syn_retries net.ipv4.tcp_ecn net.ipv4.tcp_congestion_control net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.keys.maxkeys kernel.keys.maxbytes kernel.shmmni kernel.shmmax kernel.shmall kernel.perf_event_paranoid kernel.sched_rt_runtime_us kernel.softlockup_panic kernel.yama.ptrace_scope kernel.kptr_restrict kernel.dmesg_restrict kernel.sysrq fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_background_bytes vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_bytes vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes", "type": "object" }, "transparentHugepageDefrag": { @@ -7060,6 +7235,10 @@ false ], "type": "string" }, +"dataplaneV2Config": { +"$ref": "DataplaneV2Config", +"description": "Optional. DataplaneV2Config specifies the DPv2 configuration." +}, "defaultEnablePrivateNodes": { "description": "Controls whether by default nodes have private IP addresses only. It is invalid to specify both PrivateClusterConfig.enablePrivateNodes and this field at the same time. To update the default setting, use ClusterUpdate.desired_default_enable_private_nodes", "type": "boolean" @@ -7451,6 +7630,10 @@ false "description": "Setting this field will assign instances of this pool to run on the specified node group. This is useful for running workloads on [sole tenant nodes](https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes).", "type": "string" }, +"nodeImageConfig": { +"$ref": "CustomImageConfig", +"description": "The node image configuration to use for this node pool. Note that this is only applicable for node pools using image_type=CUSTOM." +}, "oauthScopes": { "description": "The set of Google API scopes to be made available on all of the node VMs under the \"default\" service account. The following scopes are recommended, but not required, and by default are not included: * `https://www.googleapis.com/auth/compute` is required for mounting persistent storage on your nodes. * `https://www.googleapis.com/auth/devstorage.read_only` is required for communicating with **gcr.io** (the [Artifact Registry](https://cloud.google.com/artifact-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added.", "items": { @@ -7571,10 +7754,41 @@ false }, "type": "object" }, +"NodeCreationConfig": { +"description": "NodeCreationConfig defines the settings of node creation mode.", +"id": "NodeCreationConfig", +"properties": { +"nodeCreationMode": { +"description": "The mode of node creation.", +"enum": [ +"MODE_UNSPECIFIED", +"VIA_KUBELET", +"VIA_CONTROL_PLANE" +], +"enumDescriptions": [ +"When no user input is provided.", +"Kubelet registers itself.", +"gcp-controller-manager automatically creates the node object after CSR approval." +], +"type": "string" +} +}, +"type": "object" +}, "NodeDrainConfig": { "description": "NodeDrainConfig contains the node drain related configurations for this node pool.", "id": "NodeDrainConfig", "properties": { +"graceTerminationDuration": { +"description": "The duration of the grace termination period for node drain.", +"format": "google-duration", +"type": "string" +}, +"pdbTimeoutDuration": { +"description": "The duration of the PDB timeout period for node drain.", +"format": "google-duration", +"type": "string" +}, "respectPdbDuringNodePoolDeletion": { "description": "Whether to respect PDB during node pool deletion.", "type": "boolean" @@ -7776,6 +7990,10 @@ false "description": "Whether nodes have internal IP addresses only. If enable_private_nodes is not specified, then the value is derived from Cluster.NetworkConfig.default_enable_private_nodes", "type": "boolean" }, +"network": { +"description": "Optional. Immutable. The VPC network for the node pool.", +"type": "string" +}, "networkPerformanceConfig": { "$ref": "NetworkPerformanceConfig", "description": "Network bandwidth tier configuration." @@ -7861,6 +8079,10 @@ false }, "type": "array" }, +"maintenancePolicy": { +"$ref": "NodePoolMaintenancePolicy", +"description": "Optional. Specifies the maintenance policy for the node pool." +}, "management": { "$ref": "NodeManagement", "description": "NodeManagement configuration for this NodePool." @@ -8040,6 +8262,17 @@ false }, "type": "object" }, +"NodePoolMaintenancePolicy": { +"description": "Defines the maintenance policy for the node pool.", +"id": "NodePoolMaintenancePolicy", +"properties": { +"exclusionUntilEndOfSupport": { +"$ref": "ExclusionUntilEndOfSupport", +"description": "Optional. The exclusion until end of support for the node pool." +} +}, +"type": "object" +}, "NodePoolUpgradeConcurrencyConfig": { "description": "NodePoolUpgradeConcurrencyConfig is the configuration for the node pool auto upgrade concurrency.", "id": "NodePoolUpgradeConcurrencyConfig", @@ -10322,6 +10555,14 @@ false "$ref": "VirtualNIC", "description": "Enable or disable gvnic on the node pool." }, +"image": { +"description": "The desired name of the image name to use for this node. This is used to create clusters using a custom image.", +"type": "string" +}, +"imageProject": { +"description": "The project containing the desired image to use for this node pool. This is used to create clusters using a custom image.", +"type": "string" +}, "imageType": { "description": "Required. The desired image type for the node pool. Please see https://cloud.google.com/kubernetes-engine/docs/concepts/node-images for available image types.", "type": "string" diff --git a/googleapiclient/discovery_cache/documents/containeranalysis.v1.json b/googleapiclient/discovery_cache/documents/containeranalysis.v1.json index a0395a4582..1d9e4ca7f6 100644 --- a/googleapiclient/discovery_cache/documents/containeranalysis.v1.json +++ b/googleapiclient/discovery_cache/documents/containeranalysis.v1.json @@ -1715,7 +1715,7 @@ } } }, -"revision": "20260505", +"revision": "20260521", "rootUrl": "https://containeranalysis.googleapis.com/", "schemas": { "AISkillAnalysisNote": { @@ -2329,6 +2329,7 @@ "id": "CVSS", "properties": { "attackComplexity": { +"description": "Attack Complexity (AC). Defined in CVSS v2, v3, v4.", "enum": [ "ATTACK_COMPLEXITY_UNSPECIFIED", "ATTACK_COMPLEXITY_LOW", @@ -2336,15 +2337,29 @@ "ATTACK_COMPLEXITY_MEDIUM" ], "enumDescriptions": [ -"", -"", -"", -"" +"Unspecified.", +"Low attack complexity (AC:L). Defined in CVSS v2, v3, v4.", +"High attack complexity (AC:H). Defined in CVSS v2, v3, v4.", +"Medium attack complexity (AC:M). Defined in CVSS v2." +], +"type": "string" +}, +"attackRequirements": { +"description": "Attack Requirements (AT). Defined in CVSS v4.", +"enum": [ +"ATTACK_REQUIREMENTS_UNSPECIFIED", +"ATTACK_REQUIREMENTS_NONE", +"ATTACK_REQUIREMENTS_PRESENT" +], +"enumDescriptions": [ +"Unspecified.", +"No attack requirements (AT:N). Defined in CVSS v4.", +"Attack requirements: Present (AT:P). Defined in CVSS v4." ], "type": "string" }, "attackVector": { -"description": "Base Metrics Represents the intrinsic characteristics of a vulnerability that are constant over time and across user environments.", +"description": "Attack Vector (AV). Defined in CVSS v2, v3, v4.", "enum": [ "ATTACK_VECTOR_UNSPECIFIED", "ATTACK_VECTOR_NETWORK", @@ -2353,15 +2368,16 @@ "ATTACK_VECTOR_PHYSICAL" ], "enumDescriptions": [ -"", -"", -"", -"", -"" +"Unspecified.", +"Attack Vector: Network (AV:N). Defined in CVSS v2, v3, v4.", +"Attack Vector: Adjacent (AV:A). Defined in CVSS v2, v3, v4.", +"Attack Vector: Local (AV:L). Defined in CVSS v2, v3, v4.", +"Attack Vector: Physical (AV:P). Defined in CVSS v3, v4." ], "type": "string" }, "authentication": { +"description": "Authentication (Au). Defined in CVSS v2.", "enum": [ "AUTHENTICATION_UNSPECIFIED", "AUTHENTICATION_MULTIPLE", @@ -2369,14 +2385,15 @@ "AUTHENTICATION_NONE" ], "enumDescriptions": [ -"", -"", -"", -"" +"Unspecified.", +"Multiple authentication required (Au:M). Defined in CVSS v2.", +"Single authentication required (Au:S). Defined in CVSS v2.", +"No authentication required (Au:N). Defined in CVSS v2." ], "type": "string" }, "availabilityImpact": { +"description": "Availability Impact (A). Defined in CVSS v2, v3.", "enum": [ "IMPACT_UNSPECIFIED", "IMPACT_HIGH", @@ -2386,12 +2403,12 @@ "IMPACT_COMPLETE" ], "enumDescriptions": [ -"", -"", -"", -"", -"", -"" +"Unspecified.", +"High impact (H). Defined in CVSS v3, v4.", +"Low impact (L). Defined in CVSS v3, v4.", +"No impact (N). Defined in CVSS v2, v3, v4.", +"Partial impact (P). Defined in CVSS v2.", +"Complete impact (C). Defined in CVSS v2." ], "type": "string" }, @@ -2401,6 +2418,7 @@ "type": "number" }, "confidentialityImpact": { +"description": "Confidentiality Impact (C). Defined in CVSS v2, v3.", "enum": [ "IMPACT_UNSPECIFIED", "IMPACT_HIGH", @@ -2410,12 +2428,12 @@ "IMPACT_COMPLETE" ], "enumDescriptions": [ -"", -"", -"", -"", -"", -"" +"Unspecified.", +"High impact (H). Defined in CVSS v3, v4.", +"Low impact (L). Defined in CVSS v3, v4.", +"No impact (N). Defined in CVSS v2, v3, v4.", +"Partial impact (P). Defined in CVSS v2.", +"Complete impact (C). Defined in CVSS v2." ], "type": "string" }, @@ -2428,6 +2446,7 @@ "type": "number" }, "integrityImpact": { +"description": "Integrity Impact (I). Defined in CVSS v2, v3.", "enum": [ "IMPACT_UNSPECIFIED", "IMPACT_HIGH", @@ -2437,16 +2456,17 @@ "IMPACT_COMPLETE" ], "enumDescriptions": [ -"", -"", -"", -"", -"", -"" +"Unspecified.", +"High impact (H). Defined in CVSS v3, v4.", +"Low impact (L). Defined in CVSS v3, v4.", +"No impact (N). Defined in CVSS v2, v3, v4.", +"Partial impact (P). Defined in CVSS v2.", +"Complete impact (C). Defined in CVSS v2." ], "type": "string" }, "privilegesRequired": { +"description": "Privileges Required (PR). Defined in CVSS v3, v4.", "enum": [ "PRIVILEGES_REQUIRED_UNSPECIFIED", "PRIVILEGES_REQUIRED_NONE", @@ -2454,36 +2474,162 @@ "PRIVILEGES_REQUIRED_HIGH" ], "enumDescriptions": [ -"", -"", -"", -"" +"Unspecified.", +"No privileges required (PR:N). Defined in CVSS v3, v4.", +"Low privileges required (PR:L). Defined in CVSS v3, v4.", +"High privileges required (PR:H). Defined in CVSS v3, v4." ], "type": "string" }, "scope": { +"description": "Scope (S). Defined in CVSS v3.", "enum": [ "SCOPE_UNSPECIFIED", "SCOPE_UNCHANGED", "SCOPE_CHANGED" ], "enumDescriptions": [ -"", -"", -"" +"Unspecified.", +"Scope: Unchanged (S:U). Defined in CVSS v3.", +"Scope: Changed (S:C). Defined in CVSS v3." +], +"type": "string" +}, +"subsequentSystemAvailabilityImpact": { +"description": "Subsequent System Availability Impact (SA). Defined in CVSS v4.", +"enum": [ +"IMPACT_UNSPECIFIED", +"IMPACT_HIGH", +"IMPACT_LOW", +"IMPACT_NONE", +"IMPACT_PARTIAL", +"IMPACT_COMPLETE" +], +"enumDescriptions": [ +"Unspecified.", +"High impact (H). Defined in CVSS v3, v4.", +"Low impact (L). Defined in CVSS v3, v4.", +"No impact (N). Defined in CVSS v2, v3, v4.", +"Partial impact (P). Defined in CVSS v2.", +"Complete impact (C). Defined in CVSS v2." +], +"type": "string" +}, +"subsequentSystemConfidentialityImpact": { +"description": "Subsequent System Confidentiality Impact (SC). Defined in CVSS v4.", +"enum": [ +"IMPACT_UNSPECIFIED", +"IMPACT_HIGH", +"IMPACT_LOW", +"IMPACT_NONE", +"IMPACT_PARTIAL", +"IMPACT_COMPLETE" +], +"enumDescriptions": [ +"Unspecified.", +"High impact (H). Defined in CVSS v3, v4.", +"Low impact (L). Defined in CVSS v3, v4.", +"No impact (N). Defined in CVSS v2, v3, v4.", +"Partial impact (P). Defined in CVSS v2.", +"Complete impact (C). Defined in CVSS v2." +], +"type": "string" +}, +"subsequentSystemIntegrityImpact": { +"description": "Subsequent System Integrity Impact (SI). Defined in CVSS v4.", +"enum": [ +"IMPACT_UNSPECIFIED", +"IMPACT_HIGH", +"IMPACT_LOW", +"IMPACT_NONE", +"IMPACT_PARTIAL", +"IMPACT_COMPLETE" +], +"enumDescriptions": [ +"Unspecified.", +"High impact (H). Defined in CVSS v3, v4.", +"Low impact (L). Defined in CVSS v3, v4.", +"No impact (N). Defined in CVSS v2, v3, v4.", +"Partial impact (P). Defined in CVSS v2.", +"Complete impact (C). Defined in CVSS v2." ], "type": "string" }, "userInteraction": { +"description": "User Interaction (UI). Defined in CVSS v3, v4.", "enum": [ "USER_INTERACTION_UNSPECIFIED", "USER_INTERACTION_NONE", -"USER_INTERACTION_REQUIRED" +"USER_INTERACTION_REQUIRED", +"USER_INTERACTION_PASSIVE", +"USER_INTERACTION_ACTIVE" ], "enumDescriptions": [ -"", -"", -"" +"Unspecified.", +"No user interaction required (UI:N). Defined in CVSS v3, v4.", +"User interaction required (UI:R). Defined in CVSS v3.", +"Passive user interaction required (UI:P). Defined in CVSS v4.", +"Active user interaction required (UI:A). Defined in CVSS v4." +], +"type": "string" +}, +"vulnerableSystemAvailabilityImpact": { +"description": "Vulnerable System Availability Impact (VA). Defined in CVSS v4.", +"enum": [ +"IMPACT_UNSPECIFIED", +"IMPACT_HIGH", +"IMPACT_LOW", +"IMPACT_NONE", +"IMPACT_PARTIAL", +"IMPACT_COMPLETE" +], +"enumDescriptions": [ +"Unspecified.", +"High impact (H). Defined in CVSS v3, v4.", +"Low impact (L). Defined in CVSS v3, v4.", +"No impact (N). Defined in CVSS v2, v3, v4.", +"Partial impact (P). Defined in CVSS v2.", +"Complete impact (C). Defined in CVSS v2." +], +"type": "string" +}, +"vulnerableSystemConfidentialityImpact": { +"description": "Vulnerable System Confidentiality Impact (VC). Defined in CVSS v4.", +"enum": [ +"IMPACT_UNSPECIFIED", +"IMPACT_HIGH", +"IMPACT_LOW", +"IMPACT_NONE", +"IMPACT_PARTIAL", +"IMPACT_COMPLETE" +], +"enumDescriptions": [ +"Unspecified.", +"High impact (H). Defined in CVSS v3, v4.", +"Low impact (L). Defined in CVSS v3, v4.", +"No impact (N). Defined in CVSS v2, v3, v4.", +"Partial impact (P). Defined in CVSS v2.", +"Complete impact (C). Defined in CVSS v2." +], +"type": "string" +}, +"vulnerableSystemIntegrityImpact": { +"description": "Vulnerable System Integrity Impact (VI). Defined in CVSS v4.", +"enum": [ +"IMPACT_UNSPECIFIED", +"IMPACT_HIGH", +"IMPACT_LOW", +"IMPACT_NONE", +"IMPACT_PARTIAL", +"IMPACT_COMPLETE" +], +"enumDescriptions": [ +"Unspecified.", +"High impact (H). Defined in CVSS v3, v4.", +"Low impact (L). Defined in CVSS v3, v4.", +"No impact (N). Defined in CVSS v2, v3, v4.", +"Partial impact (P). Defined in CVSS v2.", +"Complete impact (C). Defined in CVSS v2." ], "type": "string" } @@ -7294,12 +7440,14 @@ false "enum": [ "CVSS_VERSION_UNSPECIFIED", "CVSS_VERSION_2", -"CVSS_VERSION_3" +"CVSS_VERSION_3", +"CVSS_VERSION_4" ], "enumDescriptions": [ -"", -"", -"" +"Unspecified.", +"CVSS v2.", +"CVSS v3.", +"CVSS v4." ], "type": "string" }, @@ -7363,12 +7511,14 @@ false "enum": [ "CVSS_VERSION_UNSPECIFIED", "CVSS_VERSION_2", -"CVSS_VERSION_3" +"CVSS_VERSION_3", +"CVSS_VERSION_4" ], "enumDescriptions": [ -"", -"", -"" +"Unspecified.", +"CVSS v2.", +"CVSS v3.", +"CVSS v4." ], "type": "string" }, diff --git a/googleapiclient/discovery_cache/documents/containeranalysis.v1beta1.json b/googleapiclient/discovery_cache/documents/containeranalysis.v1beta1.json index 08b8457a7f..300457a38a 100644 --- a/googleapiclient/discovery_cache/documents/containeranalysis.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/containeranalysis.v1beta1.json @@ -1771,7 +1771,7 @@ } } }, -"revision": "20260505", +"revision": "20260521", "rootUrl": "https://containeranalysis.googleapis.com/", "schemas": { "AISkillAnalysisNote": { @@ -2388,11 +2388,11 @@ "type": "object" }, "CVSS": { -"description": "Common Vulnerability Scoring System. This message is compatible with CVSS v2 and v3. For CVSS v2 details, see https://www.first.org/cvss/v2/guide CVSS v2 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v2-calculator For CVSS v3 details, see https://www.first.org/cvss/specification-document CVSS v3 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v3-calculator", +"description": "Common Vulnerability Scoring System. This message is compatible with CVSS v2, v3, and v4. For CVSS v2 details, see https://www.first.org/cvss/v2/guide CVSS v2 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v2-calculator For CVSS v3 details, see https://www.first.org/cvss/specification-document CVSS v3 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v3-calculator For CVSS v4 details, see https://www.first.org/cvss/v4.0/user-guide CVSS v4 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v4-calculator", "id": "CVSS", "properties": { "attackComplexity": { -"description": "Defined in CVSS v3, CVSS v2", +"description": "Attack Complexity (AC). Defined in CVSS v2, v3, v4.", "enum": [ "ATTACK_COMPLEXITY_UNSPECIFIED", "ATTACK_COMPLEXITY_LOW", @@ -2400,15 +2400,29 @@ "ATTACK_COMPLEXITY_MEDIUM" ], "enumDescriptions": [ -"Defined in CVSS v3, CVSS v2", -"Defined in CVSS v3, CVSS v2", -"Defined in CVSS v3, CVSS v2", -"Defined in CVSS v2" +"Unspecified.", +"Low attack complexity (AC:L). Defined in CVSS v2, v3, v4.", +"High attack complexity (AC:H). Defined in CVSS v2, v3, v4.", +"Medium attack complexity (AC:M). Defined in CVSS v2." +], +"type": "string" +}, +"attackRequirements": { +"description": "Attack Requirements (AT). Defined in CVSS v4.", +"enum": [ +"ATTACK_REQUIREMENTS_UNSPECIFIED", +"ATTACK_REQUIREMENTS_NONE", +"ATTACK_REQUIREMENTS_PRESENT" +], +"enumDescriptions": [ +"Unspecified.", +"No attack requirements (AT:N). Defined in CVSS v4.", +"Attack requirements: Present (AT:P). Defined in CVSS v4." ], "type": "string" }, "attackVector": { -"description": "Base Metrics Represents the intrinsic characteristics of a vulnerability that are constant over time and across user environments. Defined in CVSS v3, CVSS v2", +"description": "Attack Vector (AV). Defined in CVSS v2, v3, v4.", "enum": [ "ATTACK_VECTOR_UNSPECIFIED", "ATTACK_VECTOR_NETWORK", @@ -2417,16 +2431,16 @@ "ATTACK_VECTOR_PHYSICAL" ], "enumDescriptions": [ -"Defined in CVSS v3, CVSS v2", -"Defined in CVSS v3, CVSS v2", -"Defined in CVSS v3, CVSS v2", -"Defined in CVSS v3, CVSS v2", -"Defined in CVSS v3" +"Unspecified.", +"Attack Vector: Network (AV:N). Defined in CVSS v2, v3, v4.", +"Attack Vector: Adjacent (AV:A). Defined in CVSS v2, v3, v4.", +"Attack Vector: Local (AV:L). Defined in CVSS v2, v3, v4.", +"Attack Vector: Physical (AV:P). Defined in CVSS v3, v4." ], "type": "string" }, "authentication": { -"description": "Defined in CVSS v2", +"description": "Authentication (Au). Defined in CVSS v2.", "enum": [ "AUTHENTICATION_UNSPECIFIED", "AUTHENTICATION_MULTIPLE", @@ -2434,15 +2448,15 @@ "AUTHENTICATION_NONE" ], "enumDescriptions": [ -"Defined in CVSS v2", -"Defined in CVSS v2", -"Defined in CVSS v2", -"Defined in CVSS v2" +"Unspecified.", +"Multiple authentication required (Au:M). Defined in CVSS v2.", +"Single authentication required (Au:S). Defined in CVSS v2.", +"No authentication required (Au:N). Defined in CVSS v2." ], "type": "string" }, "availabilityImpact": { -"description": "Defined in CVSS v3, CVSS v2", +"description": "Availability Impact (A). Defined in CVSS v2, v3.", "enum": [ "IMPACT_UNSPECIFIED", "IMPACT_HIGH", @@ -2452,12 +2466,12 @@ "IMPACT_COMPLETE" ], "enumDescriptions": [ -"Defined in CVSS v3, CVSS v2", -"Defined in CVSS v3", -"Defined in CVSS v3", -"Defined in CVSS v3, CVSS v2", -"Defined in CVSS v2", -"Defined in CVSS v2" +"Unspecified.", +"High impact (H). Defined in CVSS v3, v4.", +"Low impact (L). Defined in CVSS v3, v4.", +"No impact (N). Defined in CVSS v2, v3, v4.", +"Partial impact (P). Defined in CVSS v2.", +"Complete impact (C). Defined in CVSS v2." ], "type": "string" }, @@ -2467,7 +2481,7 @@ "type": "number" }, "confidentialityImpact": { -"description": "Defined in CVSS v3, CVSS v2", +"description": "Confidentiality Impact (C). Defined in CVSS v2, v3.", "enum": [ "IMPACT_UNSPECIFIED", "IMPACT_HIGH", @@ -2477,12 +2491,12 @@ "IMPACT_COMPLETE" ], "enumDescriptions": [ -"Defined in CVSS v3, CVSS v2", -"Defined in CVSS v3", -"Defined in CVSS v3", -"Defined in CVSS v3, CVSS v2", -"Defined in CVSS v2", -"Defined in CVSS v2" +"Unspecified.", +"High impact (H). Defined in CVSS v3, v4.", +"Low impact (L). Defined in CVSS v3, v4.", +"No impact (N). Defined in CVSS v2, v3, v4.", +"Partial impact (P). Defined in CVSS v2.", +"Complete impact (C). Defined in CVSS v2." ], "type": "string" }, @@ -2495,7 +2509,7 @@ "type": "number" }, "integrityImpact": { -"description": "Defined in CVSS v3, CVSS v2", +"description": "Integrity Impact (I). Defined in CVSS v2, v3.", "enum": [ "IMPACT_UNSPECIFIED", "IMPACT_HIGH", @@ -2505,17 +2519,17 @@ "IMPACT_COMPLETE" ], "enumDescriptions": [ -"Defined in CVSS v3, CVSS v2", -"Defined in CVSS v3", -"Defined in CVSS v3", -"Defined in CVSS v3, CVSS v2", -"Defined in CVSS v2", -"Defined in CVSS v2" +"Unspecified.", +"High impact (H). Defined in CVSS v3, v4.", +"Low impact (L). Defined in CVSS v3, v4.", +"No impact (N). Defined in CVSS v2, v3, v4.", +"Partial impact (P). Defined in CVSS v2.", +"Complete impact (C). Defined in CVSS v2." ], "type": "string" }, "privilegesRequired": { -"description": "Defined in CVSS v3", +"description": "Privileges Required (PR). Defined in CVSS v3, v4.", "enum": [ "PRIVILEGES_REQUIRED_UNSPECIFIED", "PRIVILEGES_REQUIRED_NONE", @@ -2523,38 +2537,162 @@ "PRIVILEGES_REQUIRED_HIGH" ], "enumDescriptions": [ -"Defined in CVSS v3", -"Defined in CVSS v3", -"Defined in CVSS v3", -"Defined in CVSS v3" +"Unspecified.", +"No privileges required (PR:N). Defined in CVSS v3, v4.", +"Low privileges required (PR:L). Defined in CVSS v3, v4.", +"High privileges required (PR:H). Defined in CVSS v3, v4." ], "type": "string" }, "scope": { -"description": "Defined in CVSS v3", +"description": "Scope (S). Defined in CVSS v3.", "enum": [ "SCOPE_UNSPECIFIED", "SCOPE_UNCHANGED", "SCOPE_CHANGED" ], "enumDescriptions": [ -"Defined in CVSS v3", -"Defined in CVSS v3", -"Defined in CVSS v3" +"Unspecified.", +"Scope: Unchanged (S:U). Defined in CVSS v3.", +"Scope: Changed (S:C). Defined in CVSS v3." +], +"type": "string" +}, +"subsequentSystemAvailabilityImpact": { +"description": "Subsequent System Availability Impact (SA). Defined in CVSS v4.", +"enum": [ +"IMPACT_UNSPECIFIED", +"IMPACT_HIGH", +"IMPACT_LOW", +"IMPACT_NONE", +"IMPACT_PARTIAL", +"IMPACT_COMPLETE" +], +"enumDescriptions": [ +"Unspecified.", +"High impact (H). Defined in CVSS v3, v4.", +"Low impact (L). Defined in CVSS v3, v4.", +"No impact (N). Defined in CVSS v2, v3, v4.", +"Partial impact (P). Defined in CVSS v2.", +"Complete impact (C). Defined in CVSS v2." +], +"type": "string" +}, +"subsequentSystemConfidentialityImpact": { +"description": "Subsequent System Confidentiality Impact (SC). Defined in CVSS v4.", +"enum": [ +"IMPACT_UNSPECIFIED", +"IMPACT_HIGH", +"IMPACT_LOW", +"IMPACT_NONE", +"IMPACT_PARTIAL", +"IMPACT_COMPLETE" +], +"enumDescriptions": [ +"Unspecified.", +"High impact (H). Defined in CVSS v3, v4.", +"Low impact (L). Defined in CVSS v3, v4.", +"No impact (N). Defined in CVSS v2, v3, v4.", +"Partial impact (P). Defined in CVSS v2.", +"Complete impact (C). Defined in CVSS v2." +], +"type": "string" +}, +"subsequentSystemIntegrityImpact": { +"description": "Subsequent System Integrity Impact (SI). Defined in CVSS v4.", +"enum": [ +"IMPACT_UNSPECIFIED", +"IMPACT_HIGH", +"IMPACT_LOW", +"IMPACT_NONE", +"IMPACT_PARTIAL", +"IMPACT_COMPLETE" +], +"enumDescriptions": [ +"Unspecified.", +"High impact (H). Defined in CVSS v3, v4.", +"Low impact (L). Defined in CVSS v3, v4.", +"No impact (N). Defined in CVSS v2, v3, v4.", +"Partial impact (P). Defined in CVSS v2.", +"Complete impact (C). Defined in CVSS v2." ], "type": "string" }, "userInteraction": { -"description": "Defined in CVSS v3", +"description": "User Interaction (UI). Defined in CVSS v3, v4.", "enum": [ "USER_INTERACTION_UNSPECIFIED", "USER_INTERACTION_NONE", -"USER_INTERACTION_REQUIRED" +"USER_INTERACTION_REQUIRED", +"USER_INTERACTION_PASSIVE", +"USER_INTERACTION_ACTIVE" +], +"enumDescriptions": [ +"Unspecified.", +"No user interaction required (UI:N). Defined in CVSS v3, v4.", +"User interaction required (UI:R). Defined in CVSS v3.", +"Passive user interaction required (UI:P). Defined in CVSS v4.", +"Active user interaction required (UI:A). Defined in CVSS v4." +], +"type": "string" +}, +"vulnerableSystemAvailabilityImpact": { +"description": "Vulnerable System Availability Impact (VA). Defined in CVSS v4.", +"enum": [ +"IMPACT_UNSPECIFIED", +"IMPACT_HIGH", +"IMPACT_LOW", +"IMPACT_NONE", +"IMPACT_PARTIAL", +"IMPACT_COMPLETE" ], "enumDescriptions": [ -"Defined in CVSS v3", -"Defined in CVSS v3", -"Defined in CVSS v3" +"Unspecified.", +"High impact (H). Defined in CVSS v3, v4.", +"Low impact (L). Defined in CVSS v3, v4.", +"No impact (N). Defined in CVSS v2, v3, v4.", +"Partial impact (P). Defined in CVSS v2.", +"Complete impact (C). Defined in CVSS v2." +], +"type": "string" +}, +"vulnerableSystemConfidentialityImpact": { +"description": "Vulnerable System Confidentiality Impact (VC). Defined in CVSS v4.", +"enum": [ +"IMPACT_UNSPECIFIED", +"IMPACT_HIGH", +"IMPACT_LOW", +"IMPACT_NONE", +"IMPACT_PARTIAL", +"IMPACT_COMPLETE" +], +"enumDescriptions": [ +"Unspecified.", +"High impact (H). Defined in CVSS v3, v4.", +"Low impact (L). Defined in CVSS v3, v4.", +"No impact (N). Defined in CVSS v2, v3, v4.", +"Partial impact (P). Defined in CVSS v2.", +"Complete impact (C). Defined in CVSS v2." +], +"type": "string" +}, +"vulnerableSystemIntegrityImpact": { +"description": "Vulnerable System Integrity Impact (VI). Defined in CVSS v4.", +"enum": [ +"IMPACT_UNSPECIFIED", +"IMPACT_HIGH", +"IMPACT_LOW", +"IMPACT_NONE", +"IMPACT_PARTIAL", +"IMPACT_COMPLETE" +], +"enumDescriptions": [ +"Unspecified.", +"High impact (H). Defined in CVSS v3, v4.", +"Low impact (L). Defined in CVSS v3, v4.", +"No impact (N). Defined in CVSS v2, v3, v4.", +"Partial impact (P). Defined in CVSS v2.", +"Complete impact (C). Defined in CVSS v2." ], "type": "string" } @@ -5442,12 +5580,14 @@ false "enum": [ "CVSS_VERSION_UNSPECIFIED", "CVSS_VERSION_2", -"CVSS_VERSION_3" +"CVSS_VERSION_3", +"CVSS_VERSION_4" ], "enumDescriptions": [ -"", -"", -"" +"Unspecified.", +"CVSS v2.", +"CVSS v3.", +"CVSS v4." ], "type": "string" }, @@ -7584,12 +7724,14 @@ false "enum": [ "CVSS_VERSION_UNSPECIFIED", "CVSS_VERSION_2", -"CVSS_VERSION_3" +"CVSS_VERSION_3", +"CVSS_VERSION_4" ], "enumDescriptions": [ -"", -"", -"" +"Unspecified.", +"CVSS v2.", +"CVSS v3.", +"CVSS v4." ], "type": "string" }, diff --git a/googleapiclient/discovery_cache/documents/dataform.v1.json b/googleapiclient/discovery_cache/documents/dataform.v1.json index c6023433c7..f716b05231 100644 --- a/googleapiclient/discovery_cache/documents/dataform.v1.json +++ b/googleapiclient/discovery_cache/documents/dataform.v1.json @@ -3150,7 +3150,7 @@ "type": "string" }, "pageSize": { -"description": "Optional. Maximum number of TeamFolders to return. The server may return fewer items than requested. If unspecified, the server will pick an appropriate default.", +"description": "Optional. Maximum number of TeamFolders to return. The server may return fewer items than requested. If unspecified, the server will pick a default of page_size = 50.", "format": "int32", "location": "query", "type": "integer" @@ -3235,7 +3235,7 @@ } } }, -"revision": "20260430", +"revision": "20260515", "rootUrl": "https://dataform.googleapis.com/", "schemas": { "ActionErrorTable": { @@ -3898,11 +3898,11 @@ "id": "DirectoryEntry", "properties": { "directory": { -"description": "A child directory in the directory.", +"description": "A child directory in the directory. The path is returned including the full folder structure from the root.", "type": "string" }, "file": { -"description": "A file in the directory.", +"description": "A file in the directory. The path is returned including the full folder structure from the root.", "type": "string" }, "metadata": { @@ -4157,7 +4157,12 @@ "type": "string" }, "defaultBranch": { -"description": "Required. The Git remote's default branch name. If not set, `main` will be used and stored for the repository.", +"description": "Optional. The Git remote's default branch name. If not set `main` will be used.", +"type": "string" +}, +"effectiveDefaultBranch": { +"description": "Output only. The Git remote's effective default branch name. This is the default branch name of the Git remote if it is set, otherwise it is `main`.", +"readOnly": true, "type": "string" }, "sshAuthenticationConfig": { diff --git a/googleapiclient/discovery_cache/documents/dataform.v1beta1.json b/googleapiclient/discovery_cache/documents/dataform.v1beta1.json index 47c804e334..1ace51a02c 100644 --- a/googleapiclient/discovery_cache/documents/dataform.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/dataform.v1beta1.json @@ -1087,6 +1087,35 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, +"deleteLongRunning": { +"description": "Deletes a single Repository asynchronously.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}:deleteLongRunning", +"httpMethod": "POST", +"id": "dataform.projects.locations.repositories.deleteLongRunning", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The repository's name.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/repositories/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+name}:deleteLongRunning", +"request": { +"$ref": "DeleteRepositoryLongRunningRequest" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/bigquery", +"https://www.googleapis.com/auth/cloud-platform" +] +}, "fetchHistory": { "description": "Fetches a Repository's history of commits. The Repository must not have a value for `git_remote_settings.url`.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}:fetchHistory", @@ -3162,7 +3191,7 @@ "type": "string" }, "pageSize": { -"description": "Optional. Maximum number of TeamFolders to return. The server may return fewer items than requested. If unspecified, the server will pick an appropriate default.", +"description": "Optional. Maximum number of TeamFolders to return. The server may return fewer items than requested. If unspecified, the server will pick a default of page_size = 50.", "format": "int32", "location": "query", "type": "integer" @@ -3247,7 +3276,7 @@ } } }, -"revision": "20260430", +"revision": "20260515", "rootUrl": "https://dataform.googleapis.com/", "schemas": { "ActionErrorTable": { @@ -3894,6 +3923,17 @@ }, "type": "object" }, +"DeleteRepositoryLongRunningRequest": { +"description": "`DeleteRepositoryLongRunning` request message.", +"id": "DeleteRepositoryLongRunningRequest", +"properties": { +"force": { +"description": "Optional. If set to true, child resources of this repository (compilation results and workflow invocations) will also be deleted. Otherwise, the request will only succeed if the repository has no child resources. **Note:** *This flag doesn't support deletion of workspaces, release configs or workflow configs. If any of such resources exists in the repository, the request will fail.*", +"type": "boolean" +} +}, +"type": "object" +}, "DeleteTeamFolderTreeRequest": { "description": "`DeleteTeamFolderTree` request message.", "id": "DeleteTeamFolderTreeRequest", @@ -3910,11 +3950,11 @@ "id": "DirectoryEntry", "properties": { "directory": { -"description": "A child directory in the directory.", +"description": "A child directory in the directory. The path is returned including the full folder structure from the root.", "type": "string" }, "file": { -"description": "A file in the directory.", +"description": "A file in the directory. The path is returned including the full folder structure from the root.", "type": "string" }, "metadata": { @@ -4169,7 +4209,12 @@ "type": "string" }, "defaultBranch": { -"description": "Required. The Git remote's default branch name. If not set, `main` will be used and stored for the repository.", +"description": "Optional. The Git remote's default branch name. If not set `main` will be used.", +"type": "string" +}, +"effectiveDefaultBranch": { +"description": "Output only. The Git remote's effective default branch name. This is the default branch name of the Git remote if it is set, otherwise it is `main`.", +"readOnly": true, "type": "string" }, "sshAuthenticationConfig": { diff --git a/googleapiclient/discovery_cache/documents/datalineage.v1.json b/googleapiclient/discovery_cache/documents/datalineage.v1.json index 8f7e446484..535a15b3c2 100644 --- a/googleapiclient/discovery_cache/documents/datalineage.v1.json +++ b/googleapiclient/discovery_cache/documents/datalineage.v1.json @@ -4,6 +4,12 @@ "scopes": { "https://www.googleapis.com/auth/cloud-platform": { "description": "See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account." +}, +"https://www.googleapis.com/auth/datalineage.read-write": { +"description": "See, edit, configure, and delete your Google Cloud Data Lineage data and see the email address for your Google Account" +}, +"https://www.googleapis.com/auth/datalineage.readonly": { +"description": "See your Google Cloud Data Lineage data and the email address of your Google Account" } } } @@ -581,7 +587,9 @@ "$ref": "GoogleCloudDatacatalogLineageV1SearchLineageStreamingResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/datalineage.read-write", +"https://www.googleapis.com/auth/datalineage.readonly" ] }, "searchLinks": { @@ -1275,7 +1283,7 @@ } } }, -"revision": "20260511", +"revision": "20260522", "rootUrl": "https://datalineage.googleapis.com/", "schemas": { "GoogleCloudDatacatalogLineageConfigmanagementV1Config": { @@ -1947,7 +1955,7 @@ "description": "Optional. Limits for the search." }, "locations": { -"description": "Required. The locations to search in.", +"description": "Required. The locations to search in. This list should contain the location from the `parent` field.", "items": { "type": "string" }, diff --git a/googleapiclient/discovery_cache/documents/datamanager.v1.json b/googleapiclient/discovery_cache/documents/datamanager.v1.json index 7805f7b6f7..afc364b21b 100644 --- a/googleapiclient/discovery_cache/documents/datamanager.v1.json +++ b/googleapiclient/discovery_cache/documents/datamanager.v1.json @@ -820,13 +820,24 @@ } } }, -"revision": "20260507", +"revision": "20260527", "rootUrl": "https://datamanager.googleapis.com/", "schemas": { "AdIdentifiers": { "description": "Identifiers and other information used to match the conversion event with other online activity (such as ad clicks).", "id": "AdIdentifiers", "properties": { +"dclid": { +"description": "Optional. The display click ID associated with this event.", +"type": "string" +}, +"encryptedUserIds": { +"description": "Optional. Any number of encrypted user IDs.", +"items": { +"$ref": "EncryptedUserId" +}, +"type": "array" +}, "gbraid": { "description": "Optional. The click identifier for clicks associated with app events and originating from iOS devices starting with iOS14.", "type": "string" @@ -835,10 +846,18 @@ "description": "Optional. The Google click ID (gclid) associated with this event.", "type": "string" }, +"impressionId": { +"description": "Optional. The impression ID associated with this event.", +"type": "string" +}, "landingPageDeviceInfo": { "$ref": "DeviceInfo", "description": "Optional. Information gathered about the device being used (if any) at the time of landing onto the advertiser\u2019s site after interacting with the ad." }, +"matchId": { +"description": "Optional. The match ID field used to join this event with a previous event.", +"type": "string" +}, "mobileDeviceId": { "description": "Optional. The mobile identifier for advertisers. This would be IDFA on iOS, AdID on Android, or other platforms\u2019 identifiers for advertisers.", "type": "string" @@ -881,6 +900,10 @@ "description": "The audience member to be operated on.", "id": "AudienceMember", "properties": { +"compositeData": { +"$ref": "CompositeData", +"description": "Group of multiple identifier types." +}, "consent": { "$ref": "Consent", "description": "Optional. The consent setting for the user." @@ -999,6 +1022,24 @@ }, "type": "object" }, +"CompositeData": { +"description": "Composite data holding identifiers and associated data for a user. At least one of `user_data` or `ip_data` is required.", +"id": "CompositeData", +"properties": { +"ipData": { +"description": "Optional. IP address data representing customer interaction used to build the audience.", +"items": { +"$ref": "IpData" +}, +"type": "array" +}, +"userData": { +"$ref": "UserData", +"description": "Optional. User-provided data that identifies the user." +} +}, +"type": "object" +}, "Consent": { "description": "[Digital Markets Act (DMA)](//digital-markets-act.ec.europa.eu/index_en) consent settings for the user.", "id": "Consent", @@ -1087,6 +1128,36 @@ }, "type": "object" }, +"DataTypeCount": { +"description": "The count for a specific data type.", +"id": "DataTypeCount", +"properties": { +"count": { +"description": "The count for this data type.", +"format": "int64", +"type": "string" +}, +"type": { +"description": "The type of data.", +"enum": [ +"DATA_TYPE_UNSPECIFIED", +"EMAIL", +"PHONE_NUMBER", +"ADDRESS", +"IP_ADDRESS" +], +"enumDescriptions": [ +"The data type is unspecified.", +"The data is an email address.", +"The data is a phone number.", +"The data is a physical address.", +"The data is an IP address." +], +"type": "string" +} +}, +"type": "object" +}, "Destination": { "description": "The Google product you're sending data to. For example, a Google Ads account.", "id": "Destination", @@ -1177,6 +1248,58 @@ "properties": {}, "type": "object" }, +"EncryptedUserId": { +"description": "A user identifier issued to be used for attribution. All fields are required if this is used.", +"id": "EncryptedUserId", +"properties": { +"encryptedId": { +"description": "Required. The alphanumeric encrypted id.", +"type": "string" +}, +"entityId": { +"description": "Required. The encryption entity ID. This should match the encryption configuration for ad serving or Data Transfer.", +"format": "int64", +"type": "string" +}, +"entityType": { +"description": "Required. The encryption entity type. This should match the encryption configuration for ad serving or Data Transfer.", +"enum": [ +"ENCRYPTION_ENTITY_TYPE_UNSPECIFIED", +"CAMPAIGN_MANAGER_ACCOUNT", +"CAMPAIGN_MANAGER_ADVERTISER", +"DISPLAY_VIDEO_PARTNER", +"DISPLAY_VIDEO_ADVERTISER", +"GOOGLE_ADS_CUSTOMER", +"GOOGLE_AD_MANAGER_NETWORK_CODE" +], +"enumDescriptions": [ +"Unspecified encryption entity type.", +"Campaign Manager 360 account.", +"Campaign Manager 360 advertiser.", +"Display & Video 360 partner.", +"Display & Video 360 advertiser.", +"Google Ads customer.", +"Google Ad Manager network code." +], +"type": "string" +}, +"source": { +"description": "Required. Describes whether the encrypted cookie was received from ad serving (the %m macro) or from Data Transfer.", +"enum": [ +"ENCRYPTION_SOURCE_UNSPECIFIED", +"AD_SERVING", +"DATA_TRANSFER" +], +"enumDescriptions": [ +"Unspecified encryption source.", +"Ad serving encryption source.", +"Data transfer encryption source." +], +"type": "string" +} +}, +"type": "object" +}, "EncryptionInfo": { "description": "Encryption information for the data being ingested.", "id": "EncryptionInfo", @@ -1227,7 +1350,22 @@ "PROCESSING_ERROR_REASON_AWS_AUTH_FAILED", "PROCESSING_ERROR_REASON_USER_IDENTIFIER_DECRYPTION_ERROR", "PROCESSING_ERROR_OPERATING_ACCOUNT_MISMATCH_FOR_AD_IDENTIFIER", -"PROCESSING_ERROR_REASON_ONE_PER_CLICK_CONVERSION_ACTION_NOT_PERMITTED_WITH_BRAID" +"PROCESSING_ERROR_REASON_ONE_PER_CLICK_CONVERSION_ACTION_NOT_PERMITTED_WITH_BRAID", +"PROCESSING_ERROR_REASON_MATCH_ID_NOT_FOUND", +"PROCESSING_ERROR_REASON_USER_ID_NOT_FOUND_FOR_MATCH_ID", +"PROCESSING_ERROR_REASON_USER_ID_NOT_FOUND_FOR_GCLID", +"PROCESSING_ERROR_REASON_USER_ID_NOT_FOUND_FOR_DCLID", +"PROCESSING_ERROR_REASON_INVALID_AD_IDENTIFIERS", +"PROCESSING_ERROR_REASON_INVALID_MOBILE_ID_FORMAT", +"PROCESSING_ERROR_REASON_ORIGINAL_CONVERSIONS_NOT_FOUND", +"PROCESSING_ERROR_REASON_EVENT_ID_DECODE_ERROR", +"PROCESSING_ERROR_REASON_USER_ID_NOT_FOUND_FOR_IMPRESSION_ID", +"PROCESSING_ERROR_REASON_USER_ID_NOT_FOUND", +"PROCESSING_ERROR_REASON_CONVERSION_PRECEDES_CLICK", +"PROCESSING_ERROR_REASON_TOO_RECENT_CLICK", +"PROCESSING_ERROR_REASON_INVALID_CLICK", +"PROCESSING_ERROR_REASON_INVALID_OPERATING_ACCOUNT_FOR_CLICK", +"PROCESSING_ERROR_REASON_CLICK_NOT_FOUND" ], "enumDescriptions": [ "The processing error reason is unknown.", @@ -1258,7 +1396,22 @@ "The system failed to authenticate with AWS.", "Failed to decrypt the UserIdentifier data using the DEK.", "The user attempted to ingest events with an ad identifier that isn't from the operating account's ads.", -"One-per-click conversion actions cannot be used with BRAIDs." +"One-per-click conversion actions cannot be used with BRAIDs.", +"The match ID can not be found.", +"The user ID can not be found for the match ID.", +"The user ID can not be found for the GCLID.", +"The user ID can not be found for the DCLID.", +"There are ad identifiers that are invalid.", +"The mobile ID format is invalid.", +"The original conversions can't be found.", +"The event ID (dclid or impression ID) cannot be decoded.", +"The user ID cannot be found for the given impression ID.", +"The user ID cannot be found.", +"The event timestamp on the event was earlier than the associated click.", +"The click occurred too recently.", +"The event can't be attributed to a click (GCLID). This may be because the click did not come from a Google Ads campaign, for example.", +"The click from the event isn't associated with the `operating_account` of the destination.", +"A corresponding click can't be found that matches the provided attributes." ], "type": "string" }, @@ -1315,6 +1468,11 @@ "$ref": "Consent", "description": "Optional. Information about whether the associated user has provided different types of consent." }, +"conversionCount": { +"description": "Optional. The conversion quantity associated with the event, for counting-based conversions.", +"format": "double", +"type": "number" +}, "conversionValue": { "description": "Optional. The conversion value associated with the event, for value-based conversions.", "format": "double", @@ -1570,6 +1728,10 @@ "description": "The status of the ingest audience members request.", "id": "IngestAudienceMembersStatus", "properties": { +"compositeDataIngestionStatus": { +"$ref": "IngestCompositeDataStatus", +"description": "The status of the composite data ingestion to the destination." +}, "mobileDataIngestionStatus": { "$ref": "IngestMobileDataStatus", "description": "The status of the mobile data ingestion to the destination." @@ -1593,6 +1755,55 @@ }, "type": "object" }, +"IngestCompositeDataStatus": { +"description": "The status of the composite data ingestion to the destination containing stats related to the ingestion.", +"id": "IngestCompositeDataStatus", +"properties": { +"dataTypeCounts": { +"description": "The total count of data types sent in the upload request for the destination, broken down by data type. Includes all data types in the request, regardless of whether they were successfully ingested or not.", +"items": { +"$ref": "DataTypeCount" +}, +"type": "array" +}, +"recordCount": { +"description": "The total count of audience members sent in the upload request for the destination. Includes all audience members in the request, regardless of whether they were successfully ingested or not.", +"format": "int64", +"type": "string" +}, +"uploadMatchRateRange": { +"description": "The match rate range of the upload.", +"enum": [ +"MATCH_RATE_RANGE_UNKNOWN", +"MATCH_RATE_RANGE_NOT_ELIGIBLE", +"MATCH_RATE_RANGE_LESS_THAN_20", +"MATCH_RATE_RANGE_20_TO_30", +"MATCH_RATE_RANGE_31_TO_40", +"MATCH_RATE_RANGE_41_TO_50", +"MATCH_RATE_RANGE_51_TO_60", +"MATCH_RATE_RANGE_61_TO_70", +"MATCH_RATE_RANGE_71_TO_80", +"MATCH_RATE_RANGE_81_TO_90", +"MATCH_RATE_RANGE_91_TO_100" +], +"enumDescriptions": [ +"The match rate range is unknown.", +"The match rate range is not eligible.", +"The match rate range is less than 20% (in the interval `[0, 20)`).", +"The match rate range is between 20% and 30% (in the interval `[20, 31)`).", +"The match rate range is between 31% and 40% (in the interval `[31, 41)`).", +"The match rate range is between 41% and 50% (in the interval `[41, 51)`).", +"The match rate range is between 51% and 60% (in the interval `[51, 61)`.", +"The match rate range is between 61% and 70% (in the interval `[61, 71)`).", +"The match rate range is between 71% and 80% (in the interval `[71, 81)`).", +"The match rate range is between 81% and 90% (in the interval `[81, 91)`).", +"The match rate range is between 91% and 100% (in the interval `[91, 100]`)." +], +"type": "string" +} +}, +"type": "object" +}, "IngestEventsRequest": { "description": "Request to upload audience members to the provided destinations. Returns an IngestEventsResponse.", "id": "IngestEventsRequest", @@ -1832,6 +2043,27 @@ }, "type": "object" }, +"IpData": { +"description": "IP address information for a user. We recommend including observe_start_time and observe_end_time to help improve Customer Match match rates.", +"id": "IpData", +"properties": { +"ipAddress": { +"description": "Required. IP address captured at the time of customer interaction. Accepts standard string formats for both IPv4 and IPv6.", +"type": "string" +}, +"observeEndTime": { +"description": "Optional. Last recorded interaction time from this IP address in a session.", +"format": "google-datetime", +"type": "string" +}, +"observeStartTime": { +"description": "Optional. First recorded interaction time from this IP address in a session.", +"format": "google-datetime", +"type": "string" +} +}, +"type": "object" +}, "Item": { "description": "Represents an item in the cart associated with the event.", "id": "Item", @@ -2285,7 +2517,8 @@ "DISPLAY_VIDEO_ADVERTISER", "DATA_PARTNER", "GOOGLE_ANALYTICS_PROPERTY", -"GOOGLE_AD_MANAGER_AUDIENCE_LINK" +"GOOGLE_AD_MANAGER_AUDIENCE_LINK", +"FLOODLIGHT_CONFIG" ], "enumDescriptions": [ "Unspecified product. Should never be used.", @@ -2294,7 +2527,8 @@ "Display & Video 360 advertiser.", "Data Partner.", "Google Analytics.", -"Google Ad Manager audience link." +"Google Ad Manager audience link.", +"Floodlight configuration." ], "type": "string" }, @@ -2407,6 +2641,10 @@ "description": "The status of the remove audience members request.", "id": "RemoveAudienceMembersStatus", "properties": { +"compositeDataRemovalStatus": { +"$ref": "RemoveCompositeDataStatus", +"description": "The status of the composite data removal from the destination." +}, "mobileDataRemovalStatus": { "$ref": "RemoveMobileDataStatus", "description": "The status of the mobile data removal from the destination." @@ -2430,6 +2668,25 @@ }, "type": "object" }, +"RemoveCompositeDataStatus": { +"description": "The status of the composite data removal from the destination.", +"id": "RemoveCompositeDataStatus", +"properties": { +"dataTypeCounts": { +"description": "The total count of data types sent in the removal request, broken down by data type. Includes all data types in the request, regardless of whether they were successfully removed or not.", +"items": { +"$ref": "DataTypeCount" +}, +"type": "array" +}, +"recordCount": { +"description": "The total count of audience members sent in the removal request. Includes all audience members in the request, regardless of whether they were successfully removed or not.", +"format": "int64", +"type": "string" +} +}, +"type": "object" +}, "RemoveMobileDataStatus": { "description": "The status of the mobile data removal from the destination.", "id": "RemoveMobileDataStatus", diff --git a/googleapiclient/discovery_cache/documents/dataplex.v1.json b/googleapiclient/discovery_cache/documents/dataplex.v1.json index 7c3d7497a6..64f3648ca4 100644 --- a/googleapiclient/discovery_cache/documents/dataplex.v1.json +++ b/googleapiclient/discovery_cache/documents/dataplex.v1.json @@ -1377,6 +1377,92 @@ }, "changeRequests": { "methods": { +"approve": { +"description": "Approves a ChangeRequest.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/changeRequests/{changeRequestsId}:approve", +"httpMethod": "POST", +"id": "dataplex.projects.locations.changeRequests.approve", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The name of the ChangeRequest to approve.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/changeRequests/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}:approve", +"request": { +"$ref": "GoogleCloudDataplexV1ApproveChangeRequestRequest" +}, +"response": { +"$ref": "GoogleCloudDataplexV1ChangeRequest" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataplex.read-write" +] +}, +"delete": { +"description": "Deletes a ChangeRequest.Behavior depends on the caller's permissions and the resource's state: 1. Callers with dataplex.changeRequests.delete can only delete ChangeRequests in the NEW state. 2. Callers with the dataplex.changeRequests.adminDelete permission can delete ChangeRequests regardless of their state.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/changeRequests/{changeRequestsId}", +"httpMethod": "DELETE", +"id": "dataplex.projects.locations.changeRequests.delete", +"parameterOrder": [ +"name" +], +"parameters": { +"etag": { +"description": "Optional. The etag of the ChangeRequest.", +"location": "query", +"type": "string" +}, +"name": { +"description": "Required. The name of the ChangeRequest to delete. Format: projects/{project_number}/locations/{location_id}/changeRequests/{change_request_id}", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/changeRequests/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}", +"response": { +"$ref": "Empty" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataplex.read-write" +] +}, +"get": { +"description": "Gets a ChangeRequest.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/changeRequests/{changeRequestsId}", +"httpMethod": "GET", +"id": "dataplex.projects.locations.changeRequests.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The name of the ChangeRequest to retrieve. Format: projects/{project_number}/locations/{location_id}/changeRequests/{change_request_id}", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/changeRequests/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}", +"response": { +"$ref": "GoogleCloudDataplexV1ChangeRequest" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataplex.read-write" +] +}, "getIamPolicy": { "description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/changeRequests/{changeRequestsId}:getIamPolicy", @@ -1409,6 +1495,117 @@ "https://www.googleapis.com/auth/dataplex.read-write" ] }, +"list": { +"description": "Lists ChangeRequests.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/changeRequests", +"httpMethod": "GET", +"id": "dataplex.projects.locations.changeRequests.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"filter": { +"description": "Optional. Filter request. Supports filtering by: state, author, resource, create_time, update_time.", +"location": "query", +"type": "string" +}, +"orderBy": { +"description": "Optional. Order by fields for the result.", +"location": "query", +"type": "string" +}, +"pageSize": { +"description": "Optional. Maximum number of ChangeRequests to return. The service may return fewer.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "Optional. Page token received from a previous ListChangeRequests call.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The parent, which owns this collection of ChangeRequests. Format: projects/{project_number}/locations/{location_id}", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+parent}/changeRequests", +"response": { +"$ref": "GoogleCloudDataplexV1ListChangeRequestsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataplex.read-write" +] +}, +"patch": { +"description": "Updates a ChangeRequest. Only allowed when the state is NEW.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/changeRequests/{changeRequestsId}", +"httpMethod": "PATCH", +"id": "dataplex.projects.locations.changeRequests.patch", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Identifier. The relative resource name of the ChangeRequest, of the form: projects/{project_number}/locations/{location_id}/changeRequests/{change_request_id}", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/changeRequests/[^/]+$", +"required": true, +"type": "string" +}, +"updateMask": { +"description": "Optional. The list of fields to update.", +"format": "google-fieldmask", +"location": "query", +"type": "string" +} +}, +"path": "v1/{+name}", +"request": { +"$ref": "GoogleCloudDataplexV1ChangeRequest" +}, +"response": { +"$ref": "GoogleCloudDataplexV1ChangeRequest" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataplex.read-write" +] +}, +"reject": { +"description": "Rejects a ChangeRequest.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/changeRequests/{changeRequestsId}:reject", +"httpMethod": "POST", +"id": "dataplex.projects.locations.changeRequests.reject", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The name of the ChangeRequest to reject.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/changeRequests/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}:reject", +"request": { +"$ref": "GoogleCloudDataplexV1RejectChangeRequestRequest" +}, +"response": { +"$ref": "GoogleCloudDataplexV1ChangeRequest" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataplex.read-write" +] +}, "setIamPolicy": { "description": "Sets the access control policy on the specified resource. Replaces any existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/changeRequests/{changeRequestsId}:setIamPolicy", @@ -7519,7 +7716,7 @@ } } }, -"revision": "20260514", +"revision": "20260520", "rootUrl": "https://dataplex.googleapis.com/", "schemas": { "Empty": { @@ -7737,6 +7934,17 @@ "properties": {}, "type": "object" }, +"GoogleCloudDataplexV1ApproveChangeRequestRequest": { +"description": "Request message for ApproveChangeRequest.", +"id": "GoogleCloudDataplexV1ApproveChangeRequestRequest", +"properties": { +"etag": { +"description": "Optional. The etag of the ChangeRequest.", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDataplexV1Aspect": { "description": "Represents a single piece of metadata describing an entry or entry link.", "id": "GoogleCloudDataplexV1Aspect", @@ -8480,7 +8688,8 @@ "DELETE_GLOSSARY_CATEGORY", "CREATE_GLOSSARY_TERM", "UPDATE_GLOSSARY_TERM", -"DELETE_GLOSSARY_TERM" +"DELETE_GLOSSARY_TERM", +"REQUEST_DATA_PRODUCT_ACCESS" ], "enumDescriptions": [ "State unspecified.", @@ -8497,7 +8706,8 @@ "Request to delete a GlossaryCategory.", "Request to create a GlossaryTerm.", "Request to update a GlossaryTerm.", -"Request to delete a GlossaryTerm." +"Request to delete a GlossaryTerm.", +"Request to request Data Product access." ], "readOnly": true, "type": "string" @@ -8528,6 +8738,10 @@ "readOnly": true, "type": "string" }, +"dataProductAccessRequest": { +"$ref": "GoogleCloudDataplexV1DataProductAccessRequest", +"description": "Payload for Data Product access request." +}, "deleteEntry": { "$ref": "GoogleCloudDataplexV1DeleteEntryRequest", "description": "Payload for deleting an Entry." @@ -9171,11 +9385,6 @@ "description": "Describes options for unstructured data discovery.", "id": "GoogleCloudDataplexV1DataDiscoverySpecStorageConfigUnstructuredDataOptions", "properties": { -"entityInferenceEnabled": { -"deprecated": true, -"description": "Optional. Deprecated: Use semantic_inference_enabled instead. Specifies whether deeper entity inference over the objects' contents using GenAI is enabled.", -"type": "boolean" -}, "semanticInferenceEnabled": { "description": "Optional. Specifies whether deeper semantic inference over the objects' contents using GenAI is enabled.", "type": "boolean" @@ -9528,6 +9737,30 @@ }, "type": "object" }, +"GoogleCloudDataplexV1DataProductAccessRequest": { +"description": "Message for requesting access to a Data Product. This will be used to create a ChangeRequest of type REQUEST_DATA_PRODUCT_ACCESS.", +"id": "GoogleCloudDataplexV1DataProductAccessRequest", +"properties": { +"accessGroupDisplayName": { +"description": "Output only. The display name of the access group defined in the Data Product for which access is being requested.", +"readOnly": true, +"type": "string" +}, +"accessGroupId": { +"description": "Required. The ID of the access group for which access is being requested. This corresponds to the unique identifier of the AccessGroup defined in the Data Product.", +"type": "string" +}, +"parent": { +"description": "Required. The resource name of the data product. Format: projects/{project_number}/locations/{location_id}/dataProducts/{data_product_id}", +"type": "string" +}, +"requestedPrincipal": { +"description": "Optional. The principal for which access is being requested in IAM format. If not specified, the requestor's principal will be used. Example: serviceAccount:my-sa@my-project.iam.gserviceaccount.com. Only service account principals are currently supported. https://cloud.google.com/iam/docs/principal-identifiers", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDataplexV1DataProductPrincipal": { "description": "Represents the principal entity associated with an access group, as per https://cloud.google.com/iam/docs/principals-overview.", "id": "GoogleCloudDataplexV1DataProductPrincipal", @@ -13102,6 +13335,31 @@ }, "type": "object" }, +"GoogleCloudDataplexV1ListChangeRequestsResponse": { +"description": "Response message for ListChangeRequests.", +"id": "GoogleCloudDataplexV1ListChangeRequestsResponse", +"properties": { +"changeRequests": { +"description": "The ChangeRequests from the specified project and location.", +"items": { +"$ref": "GoogleCloudDataplexV1ChangeRequest" +}, +"type": "array" +}, +"nextPageToken": { +"description": "A token, which can be sent as page_token to retrieve the next page.", +"type": "string" +}, +"unreachable": { +"description": "Locations that could not be reached.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, "GoogleCloudDataplexV1ListDataAssetsResponse": { "description": "Response message for listing data assets.", "id": "GoogleCloudDataplexV1ListDataAssetsResponse", @@ -14238,6 +14496,21 @@ }, "type": "object" }, +"GoogleCloudDataplexV1RejectChangeRequestRequest": { +"description": "Request message for RejectChangeRequest.", +"id": "GoogleCloudDataplexV1RejectChangeRequestRequest", +"properties": { +"comment": { +"description": "Optional. The reason for rejecting the ChangeRequest.", +"type": "string" +}, +"etag": { +"description": "Optional. The etag of the ChangeRequest.", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDataplexV1RequestDataProductAccessRequest": { "description": "Message for requesting access to a Data Product.", "id": "GoogleCloudDataplexV1RequestDataProductAccessRequest", diff --git a/googleapiclient/discovery_cache/documents/dataproc.v1.json b/googleapiclient/discovery_cache/documents/dataproc.v1.json index 76ca2a570d..910edc6bfd 100644 --- a/googleapiclient/discovery_cache/documents/dataproc.v1.json +++ b/googleapiclient/discovery_cache/documents/dataproc.v1.json @@ -5224,7 +5224,7 @@ } } }, -"revision": "20260501", +"revision": "20260509", "rootUrl": "https://dataproc.googleapis.com/", "schemas": { "AcceleratorConfig": { @@ -6228,7 +6228,7 @@ "enumDescriptions": [ "The engine is not specified. Works the same as ENGINE_DEFAULT.", "The cluster is a default engine cluster.", -"The cluster is a lightning engine cluster." +"The cluster is a Lightning Engine (https://cloud.google.com/dataproc/docs/guides/lightning-engine) cluster." ], "type": "string" }, @@ -13125,11 +13125,26 @@ "id": "UsageMetrics", "properties": { "acceleratorType": { -"description": "Optional. DEPRECATED Accelerator type being used, if any", +"description": "Optional. Accelerator type being used, if any Deprecated: This field is only used in runtime versions below 3.0.", "type": "string" }, "milliAcceleratorSeconds": { -"description": "Optional. DEPRECATED Accelerator usage in (milliAccelerator x seconds) (see Dataproc Serverless pricing (https://cloud.google.com/dataproc-serverless/pricing)).", +"description": "Optional. Accelerator usage in (milliAccelerator x seconds) (see Dataproc Serverless pricing (https://cloud.google.com/dataproc-serverless/pricing)). Deprecated: This field is only used in runtime versions below 3.0.", +"format": "int64", +"type": "string" +}, +"milliAcceleratorSecondsA10040": { +"description": "Optional. A100-40 accelerator usage in (milliAccelerator x seconds) (see Dataproc Serverless pricing (https://cloud.google.com/dataproc-serverless/pricing)).", +"format": "int64", +"type": "string" +}, +"milliAcceleratorSecondsA10080": { +"description": "Optional. A100-80 accelerator usage in (milliAccelerator x seconds) (see Dataproc Serverless pricing (https://cloud.google.com/dataproc-serverless/pricing)).", +"format": "int64", +"type": "string" +}, +"milliAcceleratorSecondsL4": { +"description": "Optional. L4 accelerator usage in (milliAccelerator x seconds) (see Dataproc Serverless pricing (https://cloud.google.com/dataproc-serverless/pricing)).", "format": "int64", "type": "string" }, @@ -13156,11 +13171,26 @@ "id": "UsageSnapshot", "properties": { "acceleratorType": { -"description": "Optional. Accelerator type being used, if any", +"description": "Optional. Accelerator type being used, if any Deprecated: This field is only used in runtime versions below 3.0.", "type": "string" }, "milliAccelerator": { -"description": "Optional. Milli (one-thousandth) accelerator. (see Dataproc Serverless pricing (https://cloud.google.com/dataproc-serverless/pricing))", +"description": "Optional. Milli (one-thousandth) accelerator. (see Dataproc Serverless pricing (https://cloud.google.com/dataproc-serverless/pricing)) Deprecated: This field is only used in runtime versions below 3.0.", +"format": "int64", +"type": "string" +}, +"milliAcceleratorA10040": { +"description": "Optional. Milli (one-thousandth) accelerator for A100-40 accelerators. (see Dataproc Serverless pricing (https://cloud.google.com/dataproc-serverless/pricing))", +"format": "int64", +"type": "string" +}, +"milliAcceleratorA10080": { +"description": "Optional. Milli (one-thousandth) accelerator for A100-80 accelerators. (see Dataproc Serverless pricing (https://cloud.google.com/dataproc-serverless/pricing))", +"format": "int64", +"type": "string" +}, +"milliAcceleratorL4": { +"description": "Optional. Milli (one-thousandth) accelerator for L4 accelerators. (see Dataproc Serverless pricing (https://cloud.google.com/dataproc-serverless/pricing))", "format": "int64", "type": "string" }, diff --git a/googleapiclient/discovery_cache/documents/developerconnect.v1.json b/googleapiclient/discovery_cache/documents/developerconnect.v1.json index 8790e36bb7..1e293b70ee 100644 --- a/googleapiclient/discovery_cache/documents/developerconnect.v1.json +++ b/googleapiclient/discovery_cache/documents/developerconnect.v1.json @@ -1795,7 +1795,7 @@ } } }, -"revision": "20260426", +"revision": "20260527", "rootUrl": "https://developerconnect.googleapis.com/", "schemas": { "AccountConnector": { @@ -1954,6 +1954,14 @@ "readOnly": true, "type": "string" }, +"sourceCodeUris": { +"description": "Output only. The URIs of the source code, if available. For Cloud Run source deploy for example: `gs://my-bucket/my-folder/1234567890.abcde-fdbe.zip#1234567890`", +"items": { +"type": "string" +}, +"readOnly": true, +"type": "array" +}, "sourceCommitUris": { "description": "Output only. The source commits at which this artifact was built. Extracted from provenance.", "items": { diff --git a/googleapiclient/discovery_cache/documents/developerknowledge.v1.json b/googleapiclient/discovery_cache/documents/developerknowledge.v1.json index 927e15e05c..a0644f9013 100644 --- a/googleapiclient/discovery_cache/documents/developerknowledge.v1.json +++ b/googleapiclient/discovery_cache/documents/developerknowledge.v1.json @@ -115,7 +115,7 @@ "parameterOrder": [], "parameters": { "names": { -"description": "Required. Specifies the names of the documents to retrieve. A maximum of 20 documents can be retrieved in a batch. The documents are returned in the same order as the `names` in the request. Format: `documents/{uri_without_scheme}` Example: `documents/docs.cloud.google.com/storage/docs/creating-buckets` If you are changing the batch size, consider the value of `maxConcurrentGCSFetches` constant in the service implementation: http://cs///depot/google3/devrel/boq/developerknowledge/service/developerknowledge.go", +"description": "Required. Specifies the names of the documents to retrieve. A maximum of 20 documents can be retrieved in a batch. The documents are returned in the same order as the `names` in the request. Format: `documents/{uri_without_scheme}` Example: `documents/docs.cloud.google.com/storage/docs/creating-buckets` ", "location": "query", "repeated": true, "type": "string" @@ -228,7 +228,7 @@ } } }, -"revision": "20260510", +"revision": "20260524", "rootUrl": "https://developerknowledge.googleapis.com/", "schemas": { "BatchGetDocumentsResponse": { diff --git a/googleapiclient/discovery_cache/documents/developerknowledge.v1alpha.json b/googleapiclient/discovery_cache/documents/developerknowledge.v1alpha.json index e48dc85415..1915679ef0 100644 --- a/googleapiclient/discovery_cache/documents/developerknowledge.v1alpha.json +++ b/googleapiclient/discovery_cache/documents/developerknowledge.v1alpha.json @@ -115,7 +115,7 @@ "parameterOrder": [], "parameters": { "names": { -"description": "Required. Specifies the names of the documents to retrieve. A maximum of 20 documents can be retrieved in a batch. The documents are returned in the same order as the `names` in the request. Format: `documents/{uri_without_scheme}` Example: `documents/docs.cloud.google.com/storage/docs/creating-buckets` If you are changing the batch size, consider the value of `maxConcurrentGCSFetches` constant in the service implementation: http://cs///depot/google3/devrel/boq/developerknowledge/service/developerknowledge.go", +"description": "Required. Specifies the names of the documents to retrieve. A maximum of 20 documents can be retrieved in a batch. The documents are returned in the same order as the `names` in the request. Format: `documents/{uri_without_scheme}` Example: `documents/docs.cloud.google.com/storage/docs/creating-buckets` ", "location": "query", "repeated": true, "type": "string" @@ -250,7 +250,7 @@ } } }, -"revision": "20260510", +"revision": "20260524", "rootUrl": "https://developerknowledge.googleapis.com/", "schemas": { "Answer": { @@ -260,6 +260,49 @@ "answerText": { "description": "Contains the text of the answer.", "type": "string" +}, +"citations": { +"description": "Output only. Contains citations for the answer.", +"items": { +"$ref": "AnswerCitation" +}, +"readOnly": true, +"type": "array" +}, +"references": { +"description": "Output only. Contains references for the answer.", +"items": { +"$ref": "AnswerReference" +}, +"readOnly": true, +"type": "array" +} +}, +"type": "object" +}, +"AnswerCitation": { +"description": "Citation info for a segment.", +"id": "AnswerCitation", +"properties": { +"endIndex": { +"description": "Output only. Indicates the end of the segment, measured in bytes (UTF-8 unicode), exclusive. If there are multi-byte characters, such as non-ASCII characters, the index measurement is longer than the string length.", +"format": "int32", +"readOnly": true, +"type": "integer" +}, +"sources": { +"description": "Output only. Contains citation sources for the attributed segment.", +"items": { +"$ref": "CitationSource" +}, +"readOnly": true, +"type": "array" +}, +"startIndex": { +"description": "Output only. Indicates the start of the segment, measured in bytes (UTF-8 unicode), inclusive. If there are multi-byte characters, such as non-ASCII characters, the index measurement is longer than the string length.", +"format": "int32", +"readOnly": true, +"type": "integer" } }, "type": "object" @@ -286,6 +329,18 @@ }, "type": "object" }, +"AnswerReference": { +"description": "Represents a reference to a source.", +"id": "AnswerReference", +"properties": { +"documentReference": { +"$ref": "DocumentReference", +"description": "Output only. The reference document.", +"readOnly": true +} +}, +"type": "object" +}, "BatchGetDocumentsResponse": { "description": "Response message for DeveloperKnowledge.BatchGetDocuments.", "id": "BatchGetDocumentsResponse", @@ -300,6 +355,19 @@ }, "type": "object" }, +"CitationSource": { +"description": "Citation source.", +"id": "CitationSource", +"properties": { +"referenceIndex": { +"description": "Output only. Contains the index of the Answer.AnswerReference in the `references` repeated field.", +"format": "int32", +"readOnly": true, +"type": "integer" +} +}, +"type": "object" +}, "Document": { "description": "A Document represents a piece of content from the Developer Knowledge corpus.", "id": "Document", @@ -386,6 +454,18 @@ }, "type": "object" }, +"DocumentReference": { +"description": "Represents a reference to a document.", +"id": "DocumentReference", +"properties": { +"documentChunk": { +"$ref": "DocumentChunk", +"description": "Output only. Contains the document chunk. The `document_chunk.id` field is not set and will be empty.", +"readOnly": true +} +}, +"type": "object" +}, "SearchDocumentChunksResponse": { "description": "Response message for DeveloperKnowledge.SearchDocumentChunks.", "id": "SearchDocumentChunksResponse", diff --git a/googleapiclient/discovery_cache/documents/dfareporting.v5.json b/googleapiclient/discovery_cache/documents/dfareporting.v5.json index 28f2c3e1b7..5aa1986df6 100644 --- a/googleapiclient/discovery_cache/documents/dfareporting.v5.json +++ b/googleapiclient/discovery_cache/documents/dfareporting.v5.json @@ -10091,7 +10091,7 @@ } } }, -"revision": "20260511", +"revision": "20260527", "rootUrl": "https://dfareporting.googleapis.com/", "schemas": { "Account": { @@ -16494,27 +16494,18 @@ "CONVERSION_CATEGORY_SIGNUP", "CONVERSION_CATEGORY_PAGE_VIEW", "CONVERSION_CATEGORY_DOWNLOAD", -"CONVERSION_CATEGORY_BOOM_EVENT", "CONVERSION_CATEGORY_ADD_TO_CART", "CONVERSION_CATEGORY_BEGIN_CHECKOUT", "CONVERSION_CATEGORY_SUBSCRIBE_PAID", -"CONVERSION_CATEGORY_SUBSCRIBE_FREE", -"CONVERSION_CATEGORY_PHONE_CALL_LEAD", -"CONVERSION_CATEGORY_IMPORTED_LEAD", "CONVERSION_CATEGORY_SUBMIT_LEAD_FORM", "CONVERSION_CATEGORY_BOOK_APPOINTMENT", "CONVERSION_CATEGORY_REQUEST_QUOTE", "CONVERSION_CATEGORY_GET_DIRECTIONS", "CONVERSION_CATEGORY_OUTBOUND_CLICK", "CONVERSION_CATEGORY_CONTACT", -"CONVERSION_CATEGORY_VIEW_KEY_PAGE", -"CONVERSION_CATEGORY_ENGAGEMENT", -"CONVERSION_CATEGORY_STORE_VISIT", -"CONVERSION_CATEGORY_STORE_SALE", "CONVERSION_CATEGORY_QUALIFIED_LEAD", "CONVERSION_CATEGORY_CONVERTED_LEAD", -"CONVERSION_CATEGORY_IN_APP_AD_REVENUE", -"CONVERSION_CATEGORY_MESSAGE_LEAD" +"CONVERSION_CATEGORY_IN_APP_AD_REVENUE" ], "enumDescriptions": [ "Unspecified category (called \"Other\" externally).", @@ -16522,27 +16513,18 @@ "Signup user action.", "User visiting a page.", "Software download action (as for an app). A conversion type that is created as a download type may not have its category changed.", -"Boom event (for user list creation). This is an internal-only category.", ". The addition of items to a shopping cart or bag on an advertiser site.", "When someone enters the checkout flow on an advertiser site.", "The start of a paid subscription for a product or service.", -"The start of a free subscription for a product or service.", -"A call to indicate interesting in an advertiser's offering. Note: this is different from support calls.", -"A lead conversion imported from an external source into Google Ads.", "A submission of a form on an advertiser site indicating business interest.", "A booking of an appointment with an advertiser's business.", "A quote or price estimate request.", "A search for an advertiser's business location.", "A click to an advertiser's partner site, e.g. a referral.", "A call, SMS, email, chat or other type of contact to an advertiser.", -"Key page views (ex: product page, article).", -"A website engagement event", -"A visit to a physical store location.", -"A sale occurring in a physical store.", "A lead conversion imported from an external source into Google Ads, that has been further qualified by the advertiser.", "A lead conversion imported from an external source into Google Ads, that has further completed a desired stage as defined by the lead gen advertiser.", -"Conversion event that provides the revenue value of impressions that were shown in-app to users.", -"Message exchanges which indicate an interest in an advertiser's offering." +"Conversion event that provides the revenue value of impressions that were shown in-app to users." ], "type": "string" }, diff --git a/googleapiclient/discovery_cache/documents/dialogflow.v2.json b/googleapiclient/discovery_cache/documents/dialogflow.v2.json index 44220c5d30..26192049a4 100644 --- a/googleapiclient/discovery_cache/documents/dialogflow.v2.json +++ b/googleapiclient/discovery_cache/documents/dialogflow.v2.json @@ -8780,7 +8780,7 @@ } } }, -"revision": "20260509", +"revision": "20260518", "rootUrl": "https://dialogflow.googleapis.com/", "schemas": { "GoogleCloudDialogflowCxV3AdvancedSettings": { @@ -14315,6 +14315,9 @@ true "securitySettings": { "type": "string" }, +"sipConfig": { +"$ref": "GoogleCloudDialogflowV2SipConfig" +}, "sttConfig": { "$ref": "GoogleCloudDialogflowV2SpeechToTextConfig" }, @@ -17157,6 +17160,13 @@ true "GoogleCloudDialogflowV2KnowledgeAssistDebugInfo": { "id": "GoogleCloudDialogflowV2KnowledgeAssistDebugInfo", "properties": { +"cesDebugInfo": { +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" +}, +"type": "object" +}, "datastoreResponseReason": { "enum": [ "DATASTORE_RESPONSE_REASON_UNSPECIFIED", @@ -17205,6 +17215,9 @@ true ], "type": "string" }, +"queryGenerationDebugInfo": { +"$ref": "GoogleCloudDialogflowV2KnowledgeAssistDebugInfoQueryGenerationDebugInfo" +}, "queryGenerationFailureReason": { "enum": [ "QUERY_GENERATION_FAILURE_REASON_UNSPECIFIED", @@ -17298,6 +17311,24 @@ true }, "type": "object" }, +"GoogleCloudDialogflowV2KnowledgeAssistDebugInfoQueryGenerationDebugInfo": { +"id": "GoogleCloudDialogflowV2KnowledgeAssistDebugInfoQueryGenerationDebugInfo", +"properties": { +"candidatesTokenCount": { +"format": "int32", +"type": "integer" +}, +"promptTokenCount": { +"format": "int32", +"type": "integer" +}, +"totalTokenCount": { +"format": "int32", +"type": "integer" +} +}, +"type": "object" +}, "GoogleCloudDialogflowV2KnowledgeBase": { "id": "GoogleCloudDialogflowV2KnowledgeBase", "properties": { @@ -18606,6 +18637,37 @@ true }, "type": "object" }, +"GoogleCloudDialogflowV2SipConfig": { +"id": "GoogleCloudDialogflowV2SipConfig", +"properties": { +"allowVirtualAgentInteraction": { +"type": "boolean" +}, +"copyInboundCallLegHeaders": { +"items": { +"type": "string" +}, +"type": "array" +}, +"createConversationOnTheFly": { +"type": "boolean" +}, +"ignoreReinviteMediaDirection": { +"type": "boolean" +}, +"inactiveStart": { +"type": "boolean" +}, +"keepConversationRunning": { +"type": "boolean" +}, +"maxAudioRecordingDuration": { +"format": "google-duration", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDialogflowV2SipTrunk": { "id": "GoogleCloudDialogflowV2SipTrunk", "properties": { @@ -22167,6 +22229,13 @@ true "GoogleCloudDialogflowV2beta1KnowledgeAssistDebugInfo": { "id": "GoogleCloudDialogflowV2beta1KnowledgeAssistDebugInfo", "properties": { +"cesDebugInfo": { +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" +}, +"type": "object" +}, "datastoreResponseReason": { "enum": [ "DATASTORE_RESPONSE_REASON_UNSPECIFIED", @@ -22215,6 +22284,9 @@ true ], "type": "string" }, +"queryGenerationDebugInfo": { +"$ref": "GoogleCloudDialogflowV2beta1KnowledgeAssistDebugInfoQueryGenerationDebugInfo" +}, "queryGenerationFailureReason": { "enum": [ "QUERY_GENERATION_FAILURE_REASON_UNSPECIFIED", @@ -22308,6 +22380,24 @@ true }, "type": "object" }, +"GoogleCloudDialogflowV2beta1KnowledgeAssistDebugInfoQueryGenerationDebugInfo": { +"id": "GoogleCloudDialogflowV2beta1KnowledgeAssistDebugInfoQueryGenerationDebugInfo", +"properties": { +"candidatesTokenCount": { +"format": "int32", +"type": "integer" +}, +"promptTokenCount": { +"format": "int32", +"type": "integer" +}, +"totalTokenCount": { +"format": "int32", +"type": "integer" +} +}, +"type": "object" +}, "GoogleCloudDialogflowV2beta1KnowledgeOperationMetadata": { "id": "GoogleCloudDialogflowV2beta1KnowledgeOperationMetadata", "properties": { diff --git a/googleapiclient/discovery_cache/documents/dialogflow.v2beta1.json b/googleapiclient/discovery_cache/documents/dialogflow.v2beta1.json index 993ec50ce2..06b3fa9966 100644 --- a/googleapiclient/discovery_cache/documents/dialogflow.v2beta1.json +++ b/googleapiclient/discovery_cache/documents/dialogflow.v2beta1.json @@ -8431,7 +8431,7 @@ } } }, -"revision": "20260509", +"revision": "20260518", "rootUrl": "https://dialogflow.googleapis.com/", "schemas": { "GoogleCloudDialogflowCxV3AdvancedSettings": { @@ -14285,6 +14285,13 @@ true "GoogleCloudDialogflowV2KnowledgeAssistDebugInfo": { "id": "GoogleCloudDialogflowV2KnowledgeAssistDebugInfo", "properties": { +"cesDebugInfo": { +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" +}, +"type": "object" +}, "datastoreResponseReason": { "enum": [ "DATASTORE_RESPONSE_REASON_UNSPECIFIED", @@ -14333,6 +14340,9 @@ true ], "type": "string" }, +"queryGenerationDebugInfo": { +"$ref": "GoogleCloudDialogflowV2KnowledgeAssistDebugInfoQueryGenerationDebugInfo" +}, "queryGenerationFailureReason": { "enum": [ "QUERY_GENERATION_FAILURE_REASON_UNSPECIFIED", @@ -14426,6 +14436,24 @@ true }, "type": "object" }, +"GoogleCloudDialogflowV2KnowledgeAssistDebugInfoQueryGenerationDebugInfo": { +"id": "GoogleCloudDialogflowV2KnowledgeAssistDebugInfoQueryGenerationDebugInfo", +"properties": { +"candidatesTokenCount": { +"format": "int32", +"type": "integer" +}, +"promptTokenCount": { +"format": "int32", +"type": "integer" +}, +"totalTokenCount": { +"format": "int32", +"type": "integer" +} +}, +"type": "object" +}, "GoogleCloudDialogflowV2KnowledgeOperationMetadata": { "id": "GoogleCloudDialogflowV2KnowledgeOperationMetadata", "properties": { @@ -16581,6 +16609,9 @@ true "securitySettings": { "type": "string" }, +"sipConfig": { +"$ref": "GoogleCloudDialogflowV2beta1SipConfig" +}, "sttConfig": { "$ref": "GoogleCloudDialogflowV2beta1SpeechToTextConfig" }, @@ -19520,6 +19551,13 @@ true "GoogleCloudDialogflowV2beta1KnowledgeAssistDebugInfo": { "id": "GoogleCloudDialogflowV2beta1KnowledgeAssistDebugInfo", "properties": { +"cesDebugInfo": { +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" +}, +"type": "object" +}, "datastoreResponseReason": { "enum": [ "DATASTORE_RESPONSE_REASON_UNSPECIFIED", @@ -19568,6 +19606,9 @@ true ], "type": "string" }, +"queryGenerationDebugInfo": { +"$ref": "GoogleCloudDialogflowV2beta1KnowledgeAssistDebugInfoQueryGenerationDebugInfo" +}, "queryGenerationFailureReason": { "enum": [ "QUERY_GENERATION_FAILURE_REASON_UNSPECIFIED", @@ -19661,6 +19702,24 @@ true }, "type": "object" }, +"GoogleCloudDialogflowV2beta1KnowledgeAssistDebugInfoQueryGenerationDebugInfo": { +"id": "GoogleCloudDialogflowV2beta1KnowledgeAssistDebugInfoQueryGenerationDebugInfo", +"properties": { +"candidatesTokenCount": { +"format": "int32", +"type": "integer" +}, +"promptTokenCount": { +"format": "int32", +"type": "integer" +}, +"totalTokenCount": { +"format": "int32", +"type": "integer" +} +}, +"type": "object" +}, "GoogleCloudDialogflowV2beta1KnowledgeBase": { "id": "GoogleCloudDialogflowV2beta1KnowledgeBase", "properties": { @@ -21129,6 +21188,37 @@ true }, "type": "object" }, +"GoogleCloudDialogflowV2beta1SipConfig": { +"id": "GoogleCloudDialogflowV2beta1SipConfig", +"properties": { +"allowVirtualAgentInteraction": { +"type": "boolean" +}, +"copyInboundCallLegHeaders": { +"items": { +"type": "string" +}, +"type": "array" +}, +"createConversationOnTheFly": { +"type": "boolean" +}, +"ignoreReinviteMediaDirection": { +"type": "boolean" +}, +"inactiveStart": { +"type": "boolean" +}, +"keepConversationRunning": { +"type": "boolean" +}, +"maxAudioRecordingDuration": { +"format": "google-duration", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDialogflowV2beta1SipTrunk": { "id": "GoogleCloudDialogflowV2beta1SipTrunk", "properties": { diff --git a/googleapiclient/discovery_cache/documents/dialogflow.v3.json b/googleapiclient/discovery_cache/documents/dialogflow.v3.json index 71739b2982..c739d166cb 100644 --- a/googleapiclient/discovery_cache/documents/dialogflow.v3.json +++ b/googleapiclient/discovery_cache/documents/dialogflow.v3.json @@ -5031,7 +5031,7 @@ } } }, -"revision": "20260426", +"revision": "20260518", "rootUrl": "https://dialogflow.googleapis.com/", "schemas": { "GoogleCloudDialogflowCxV3Action": { @@ -15094,6 +15094,13 @@ true "GoogleCloudDialogflowV2KnowledgeAssistDebugInfo": { "id": "GoogleCloudDialogflowV2KnowledgeAssistDebugInfo", "properties": { +"cesDebugInfo": { +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" +}, +"type": "object" +}, "datastoreResponseReason": { "enum": [ "DATASTORE_RESPONSE_REASON_UNSPECIFIED", @@ -15142,6 +15149,9 @@ true ], "type": "string" }, +"queryGenerationDebugInfo": { +"$ref": "GoogleCloudDialogflowV2KnowledgeAssistDebugInfoQueryGenerationDebugInfo" +}, "queryGenerationFailureReason": { "enum": [ "QUERY_GENERATION_FAILURE_REASON_UNSPECIFIED", @@ -15235,6 +15245,24 @@ true }, "type": "object" }, +"GoogleCloudDialogflowV2KnowledgeAssistDebugInfoQueryGenerationDebugInfo": { +"id": "GoogleCloudDialogflowV2KnowledgeAssistDebugInfoQueryGenerationDebugInfo", +"properties": { +"candidatesTokenCount": { +"format": "int32", +"type": "integer" +}, +"promptTokenCount": { +"format": "int32", +"type": "integer" +}, +"totalTokenCount": { +"format": "int32", +"type": "integer" +} +}, +"type": "object" +}, "GoogleCloudDialogflowV2KnowledgeOperationMetadata": { "id": "GoogleCloudDialogflowV2KnowledgeOperationMetadata", "properties": { @@ -17834,6 +17862,13 @@ true "GoogleCloudDialogflowV2beta1KnowledgeAssistDebugInfo": { "id": "GoogleCloudDialogflowV2beta1KnowledgeAssistDebugInfo", "properties": { +"cesDebugInfo": { +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" +}, +"type": "object" +}, "datastoreResponseReason": { "enum": [ "DATASTORE_RESPONSE_REASON_UNSPECIFIED", @@ -17882,6 +17917,9 @@ true ], "type": "string" }, +"queryGenerationDebugInfo": { +"$ref": "GoogleCloudDialogflowV2beta1KnowledgeAssistDebugInfoQueryGenerationDebugInfo" +}, "queryGenerationFailureReason": { "enum": [ "QUERY_GENERATION_FAILURE_REASON_UNSPECIFIED", @@ -17975,6 +18013,24 @@ true }, "type": "object" }, +"GoogleCloudDialogflowV2beta1KnowledgeAssistDebugInfoQueryGenerationDebugInfo": { +"id": "GoogleCloudDialogflowV2beta1KnowledgeAssistDebugInfoQueryGenerationDebugInfo", +"properties": { +"candidatesTokenCount": { +"format": "int32", +"type": "integer" +}, +"promptTokenCount": { +"format": "int32", +"type": "integer" +}, +"totalTokenCount": { +"format": "int32", +"type": "integer" +} +}, +"type": "object" +}, "GoogleCloudDialogflowV2beta1KnowledgeOperationMetadata": { "id": "GoogleCloudDialogflowV2beta1KnowledgeOperationMetadata", "properties": { diff --git a/googleapiclient/discovery_cache/documents/dialogflow.v3beta1.json b/googleapiclient/discovery_cache/documents/dialogflow.v3beta1.json index cdd1adc968..d3a5739601 100644 --- a/googleapiclient/discovery_cache/documents/dialogflow.v3beta1.json +++ b/googleapiclient/discovery_cache/documents/dialogflow.v3beta1.json @@ -5151,7 +5151,7 @@ } } }, -"revision": "20260426", +"revision": "20260518", "rootUrl": "https://dialogflow.googleapis.com/", "schemas": { "GoogleCloudDialogflowCxV3AdvancedSettings": { @@ -16139,6 +16139,13 @@ true "GoogleCloudDialogflowV2KnowledgeAssistDebugInfo": { "id": "GoogleCloudDialogflowV2KnowledgeAssistDebugInfo", "properties": { +"cesDebugInfo": { +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" +}, +"type": "object" +}, "datastoreResponseReason": { "enum": [ "DATASTORE_RESPONSE_REASON_UNSPECIFIED", @@ -16187,6 +16194,9 @@ true ], "type": "string" }, +"queryGenerationDebugInfo": { +"$ref": "GoogleCloudDialogflowV2KnowledgeAssistDebugInfoQueryGenerationDebugInfo" +}, "queryGenerationFailureReason": { "enum": [ "QUERY_GENERATION_FAILURE_REASON_UNSPECIFIED", @@ -16280,6 +16290,24 @@ true }, "type": "object" }, +"GoogleCloudDialogflowV2KnowledgeAssistDebugInfoQueryGenerationDebugInfo": { +"id": "GoogleCloudDialogflowV2KnowledgeAssistDebugInfoQueryGenerationDebugInfo", +"properties": { +"candidatesTokenCount": { +"format": "int32", +"type": "integer" +}, +"promptTokenCount": { +"format": "int32", +"type": "integer" +}, +"totalTokenCount": { +"format": "int32", +"type": "integer" +} +}, +"type": "object" +}, "GoogleCloudDialogflowV2KnowledgeOperationMetadata": { "id": "GoogleCloudDialogflowV2KnowledgeOperationMetadata", "properties": { @@ -18879,6 +18907,13 @@ true "GoogleCloudDialogflowV2beta1KnowledgeAssistDebugInfo": { "id": "GoogleCloudDialogflowV2beta1KnowledgeAssistDebugInfo", "properties": { +"cesDebugInfo": { +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" +}, +"type": "object" +}, "datastoreResponseReason": { "enum": [ "DATASTORE_RESPONSE_REASON_UNSPECIFIED", @@ -18927,6 +18962,9 @@ true ], "type": "string" }, +"queryGenerationDebugInfo": { +"$ref": "GoogleCloudDialogflowV2beta1KnowledgeAssistDebugInfoQueryGenerationDebugInfo" +}, "queryGenerationFailureReason": { "enum": [ "QUERY_GENERATION_FAILURE_REASON_UNSPECIFIED", @@ -19020,6 +19058,24 @@ true }, "type": "object" }, +"GoogleCloudDialogflowV2beta1KnowledgeAssistDebugInfoQueryGenerationDebugInfo": { +"id": "GoogleCloudDialogflowV2beta1KnowledgeAssistDebugInfoQueryGenerationDebugInfo", +"properties": { +"candidatesTokenCount": { +"format": "int32", +"type": "integer" +}, +"promptTokenCount": { +"format": "int32", +"type": "integer" +}, +"totalTokenCount": { +"format": "int32", +"type": "integer" +} +}, +"type": "object" +}, "GoogleCloudDialogflowV2beta1KnowledgeOperationMetadata": { "id": "GoogleCloudDialogflowV2beta1KnowledgeOperationMetadata", "properties": { diff --git a/googleapiclient/discovery_cache/documents/discoveryengine.v1.json b/googleapiclient/discovery_cache/documents/discoveryengine.v1.json index 208e371dcf..e909d71dfe 100644 --- a/googleapiclient/discovery_cache/documents/discoveryengine.v1.json +++ b/googleapiclient/discovery_cache/documents/discoveryengine.v1.json @@ -2832,7 +2832,7 @@ "type": "string" }, "orderBy": { -"description": "A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Supported fields: * `update_time` * `create_time` * `session_name` * `is_pinned` Example: * `update_time desc` * `create_time` * `is_pinned desc,update_time desc`: list sessions by is_pinned first, then by update_time.", +"description": "A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Supported fields: * `update_time` * `create_time` * `session_name` * `is_pinned` * `display_name` Example: * `update_time desc` * `create_time` * `is_pinned desc,update_time desc`: list sessions by is_pinned first, then by update_time.", "location": "query", "type": "string" }, @@ -5646,7 +5646,7 @@ "type": "string" }, "orderBy": { -"description": "A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Supported fields: * `update_time` * `create_time` * `session_name` * `is_pinned` Example: * `update_time desc` * `create_time` * `is_pinned desc,update_time desc`: list sessions by is_pinned first, then by update_time.", +"description": "A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Supported fields: * `update_time` * `create_time` * `session_name` * `is_pinned` * `display_name` Example: * `update_time desc` * `create_time` * `is_pinned desc,update_time desc`: list sessions by is_pinned first, then by update_time.", "location": "query", "type": "string" }, @@ -7804,7 +7804,7 @@ "type": "string" }, "orderBy": { -"description": "A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Supported fields: * `update_time` * `create_time` * `session_name` * `is_pinned` Example: * `update_time desc` * `create_time` * `is_pinned desc,update_time desc`: list sessions by is_pinned first, then by update_time.", +"description": "A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Supported fields: * `update_time` * `create_time` * `session_name` * `is_pinned` * `display_name` Example: * `update_time desc` * `create_time` * `is_pinned desc,update_time desc`: list sessions by is_pinned first, then by update_time.", "location": "query", "type": "string" }, @@ -9637,7 +9637,7 @@ } } }, -"revision": "20260512", +"revision": "20260524", "rootUrl": "https://discoveryengine.googleapis.com/", "schemas": { "A2aV1APIKeySecurityScheme": { @@ -19299,7 +19299,7 @@ "description": "The query expansion specification that specifies the conditions under which query expansion occurs." }, "rankingExpression": { -"description": "Optional. The ranking expression controls the customized ranking on retrieval documents. This overrides ServingConfig.ranking_expression. The syntax and supported features depend on the `ranking_expression_backend` value. If `ranking_expression_backend` is not provided, it defaults to `RANK_BY_EMBEDDING`. If ranking_expression_backend is not provided or set to `RANK_BY_EMBEDDING`, it should be a single function or multiple functions that are joined by \"+\". * ranking_expression = function, { \" + \", function }; Supported functions: * double * relevance_score * double * dotProduct(embedding_field_path) Function variables: * `relevance_score`: pre-defined keywords, used for measure relevance between query and document. * `embedding_field_path`: the document embedding field used with query embedding vector. * `dotProduct`: embedding function between `embedding_field_path` and query embedding vector. Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`. If ranking_expression_backend is set to `RANK_BY_FORMULA`, the following expression types (and combinations of those chained using + or * operators) are supported: * `double` * `signal` * `log(signal)` * `exp(signal)` * `rr(signal, double > 0)` -- reciprocal rank transformation with second argument being a denominator constant. * `is_nan(signal)` -- returns 0 if signal is NaN, 1 otherwise. * `fill_nan(signal1, signal2 | double)` -- if signal1 is NaN, returns signal2 | double, else returns signal1. Here are a few examples of ranking formulas that use the supported ranking expression types: - `0.2 * semantic_similarity_score + 0.8 * log(keyword_similarity_score)` -- mostly rank by the logarithm of `keyword_similarity_score` with slight `semantic_smilarity_score` adjustment. - `0.2 * exp(fill_nan(semantic_similarity_score, 0)) + 0.3 * is_nan(keyword_similarity_score)` -- rank by the exponent of `semantic_similarity_score` filling the value with 0 if it's NaN, also add constant 0.3 adjustment to the final score if `semantic_similarity_score` is NaN. - `0.2 * rr(semantic_similarity_score, 16) + 0.8 * rr(keyword_similarity_score, 16)` -- mostly rank by the reciprocal rank of `keyword_similarity_score` with slight adjustment of reciprocal rank of `semantic_smilarity_score`. The following signals are supported: * `semantic_similarity_score`: semantic similarity adjustment that is calculated using the embeddings generated by a proprietary Google model. This score determines how semantically similar a search query is to a document. * `keyword_similarity_score`: keyword match adjustment uses the Best Match 25 (BM25) ranking function. This score is calculated using a probabilistic model to estimate the probability that a document is relevant to a given query. * `relevance_score`: semantic relevance adjustment that uses a proprietary Google model to determine the meaning and intent behind a user's query in context with the content in the documents. * `pctr_rank`: predicted conversion rate adjustment as a rank use predicted Click-through rate (pCTR) to gauge the relevance and attractiveness of a search result from a user's perspective. A higher pCTR suggests that the result is more likely to satisfy the user's query and intent, making it a valuable signal for ranking. * `freshness_rank`: freshness adjustment as a rank * `document_age`: The time in hours elapsed since the document was last updated, a floating-point number (e.g., 0.25 means 15 minutes). * `topicality_rank`: topicality adjustment as a rank. Uses proprietary Google model to determine the keyword-based overlap between the query and the document. * `base_rank`: the default rank of the result", +"description": "Optional. The ranking expression controls the customized ranking on retrieval documents. This overrides ServingConfig.ranking_expression. The syntax and supported features depend on the `ranking_expression_backend` value. If `ranking_expression_backend` is not provided, it defaults to `RANK_BY_EMBEDDING`. If ranking_expression_backend is not provided or set to `RANK_BY_EMBEDDING`, it should be a single function or multiple functions that are joined by \"+\". * ranking_expression = function, { \" + \", function }; Supported functions: * double * relevance_score * double * dotProduct(embedding_field_path) Function variables: * `relevance_score`: pre-defined keywords, used for measure relevance between query and document. * `embedding_field_path`: the document embedding field used with query embedding vector. * `dotProduct`: embedding function between `embedding_field_path` and query embedding vector. Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`. If ranking_expression_backend is set to `RANK_BY_FORMULA`, the following expression types (and combinations of those chained using + or * operators) are supported: * `double` * `signal` * `log(signal)` * `exp(signal)` * `rr(signal, double > 0)` -- reciprocal rank transformation with second argument being a denominator constant. * `is_nan(signal)` -- returns 0 if signal is NaN, 1 otherwise. * `fill_nan(signal1, signal2 | double)` -- if signal1 is NaN, returns signal2 | double, else returns signal1. Here are a few examples of ranking formulas that use the supported ranking expression types: - `0.2 * semantic_similarity_score + 0.8 * log(keyword_similarity_score)` -- mostly rank by the logarithm of `keyword_similarity_score` with slight `semantic_smilarity_score` adjustment. - `0.2 * exp(fill_nan(semantic_similarity_score, 0)) + 0.3 * is_nan(keyword_similarity_score)` -- rank by the exponent of `semantic_similarity_score` filling the value with 0 if it's NaN, also add constant 0.3 adjustment to the final score if `semantic_similarity_score` is NaN. - `0.2 * rr(semantic_similarity_score, 16) + 0.8 * rr(keyword_similarity_score, 16)` -- mostly rank by the reciprocal rank of `keyword_similarity_score` with slight adjustment of reciprocal rank of `semantic_smilarity_score`. The following signals are supported: * `semantic_similarity_score`: semantic similarity adjustment that is calculated using the embeddings generated by a proprietary Google model. This score determines how semantically similar a search query is to a document. * `keyword_similarity_score`: keyword match adjustment uses the Best Match 25 (BM25) ranking function. This score is calculated using a probabilistic model to estimate the probability that a document is relevant to a given query. * `relevance_score`: semantic relevance adjustment that uses a proprietary Google model to determine the meaning and intent behind a user's query in context with the content in the documents. * `pctr_rank`: predicted conversion rate adjustment as a rank use predicted Click-through rate (pCTR) to gauge the relevance and attractiveness of a search result from a user's perspective. A higher pCTR suggests that the result is more likely to satisfy the user's query and intent, making it a valuable signal for ranking. * `freshness_rank`: freshness adjustment as a rank * `document_age`: The time in hours elapsed since the document was last updated, a floating-point number (e.g., 0.25 means 15 minutes). * `topicality_rank`: topicality adjustment as a rank. Uses proprietary Google model to determine the keyword-based overlap between the query and the document. * `base_rank`: the default rank of the result * `media_actor_match`: whether the media actor matches the query * `media_director_match`: whether the media director matches the query * `media_genre_match`: whether the media genre matches the query * `media_language_match`: whether the media language matches the query * `media_title_match`: whether the media title matches the query * `media_prefix_similarity_rank`: prefix similarity rank for media results * `media_semantic_similarity_rank`: semantic similarity rank for media results", "type": "string" }, "rankingExpressionBackend": { @@ -21133,6 +21133,13 @@ false }, "type": "array" }, +"invokedSkills": { +"description": "The skills executed during the turn.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1StreamAssistResponseInvokedSkill" +}, +"type": "array" +}, "sessionInfo": { "$ref": "GoogleCloudDiscoveryengineV1StreamAssistResponseSessionInfo", "description": "Session information. Only included in the final StreamAssistResponse of the response stream." @@ -21140,6 +21147,21 @@ false }, "type": "object" }, +"GoogleCloudDiscoveryengineV1StreamAssistResponseInvokedSkill": { +"description": "Represents a skill used during the assist call.", +"id": "GoogleCloudDiscoveryengineV1StreamAssistResponseInvokedSkill", +"properties": { +"displayName": { +"description": "The display name of the skill.", +"type": "string" +}, +"name": { +"description": "The resource name of the skill.", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1StreamAssistResponseSessionInfo": { "description": "Information about the session.", "id": "GoogleCloudDiscoveryengineV1StreamAssistResponseSessionInfo", @@ -22537,7 +22559,8 @@ false "id": "GoogleCloudDiscoveryengineV1WorkspaceConfig", "properties": { "dasherCustomerId": { -"description": "Obfuscated Dasher customer ID.", +"description": "Output only. Obfuscated Dasher customer ID. Derived by the server from the project's GCP organization at data store creation time; any value supplied in the request payload is ignored.", +"readOnly": true, "type": "string" }, "superAdminEmailAddress": { @@ -26986,7 +27009,7 @@ false "type": "array" }, "searchableFieldImportance": { -"description": "Optional. Specifies the importance of the field when `searchable_option` is `SEARCHABLE_ENABLED`. If `searchable_option` is `SEARCHABLE_DISABLED`, this field is ignored. If `searchable_option` is `SEARCHABLE_ENABLED` and this is `SEARCHABLE_FIELD_IMPORTANCE_UNSPECIFIED`, it behaves as `DEFAULT_IMPORTANCE`.", +"description": "Optional. Specifies the importance of the field when `searchable_option` is `SEARCHABLE_ENABLED`. If `searchable_option` is `SEARCHABLE_DISABLED`, this field is ignored. If `searchable_option` is `SEARCHABLE_ENABLED` and this is `SEARCHABLE_FIELD_IMPORTANCE_UNSPECIFIED`, it behaves as `DEFAULT_IMPORTANCE`. For more information, see [Weight searchable fields](https://cloud.google.com/generative-ai-app-builder/docs/configure-field-settings#weight-search).", "enum": [ "SEARCHABLE_FIELD_IMPORTANCE_UNSPECIFIED", "VERY_LOW_IMPORTANCE", @@ -27606,7 +27629,7 @@ false "type": "string" }, "orderBy": { -"description": "A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Supported fields: * `update_time` * `create_time` * `session_name` * `is_pinned` Example: * `update_time desc` * `create_time` * `is_pinned desc,update_time desc`: list sessions by is_pinned first, then by update_time.", +"description": "A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Supported fields: * `update_time` * `create_time` * `session_name` * `is_pinned` * `display_name` Example: * `update_time desc` * `create_time` * `is_pinned desc,update_time desc`: list sessions by is_pinned first, then by update_time.", "type": "string" }, "pageSize": { @@ -28841,7 +28864,7 @@ false "description": "The query expansion specification that specifies the conditions under which query expansion occurs." }, "rankingExpression": { -"description": "Optional. The ranking expression controls the customized ranking on retrieval documents. This overrides ServingConfig.ranking_expression. The syntax and supported features depend on the `ranking_expression_backend` value. If `ranking_expression_backend` is not provided, it defaults to `RANK_BY_EMBEDDING`. If ranking_expression_backend is not provided or set to `RANK_BY_EMBEDDING`, it should be a single function or multiple functions that are joined by \"+\". * ranking_expression = function, { \" + \", function }; Supported functions: * double * relevance_score * double * dotProduct(embedding_field_path) Function variables: * `relevance_score`: pre-defined keywords, used for measure relevance between query and document. * `embedding_field_path`: the document embedding field used with query embedding vector. * `dotProduct`: embedding function between `embedding_field_path` and query embedding vector. Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`. If ranking_expression_backend is set to `RANK_BY_FORMULA`, the following expression types (and combinations of those chained using + or * operators) are supported: * `double` * `signal` * `log(signal)` * `exp(signal)` * `rr(signal, double > 0)` -- reciprocal rank transformation with second argument being a denominator constant. * `is_nan(signal)` -- returns 0 if signal is NaN, 1 otherwise. * `fill_nan(signal1, signal2 | double)` -- if signal1 is NaN, returns signal2 | double, else returns signal1. Here are a few examples of ranking formulas that use the supported ranking expression types: - `0.2 * semantic_similarity_score + 0.8 * log(keyword_similarity_score)` -- mostly rank by the logarithm of `keyword_similarity_score` with slight `semantic_smilarity_score` adjustment. - `0.2 * exp(fill_nan(semantic_similarity_score, 0)) + 0.3 * is_nan(keyword_similarity_score)` -- rank by the exponent of `semantic_similarity_score` filling the value with 0 if it's NaN, also add constant 0.3 adjustment to the final score if `semantic_similarity_score` is NaN. - `0.2 * rr(semantic_similarity_score, 16) + 0.8 * rr(keyword_similarity_score, 16)` -- mostly rank by the reciprocal rank of `keyword_similarity_score` with slight adjustment of reciprocal rank of `semantic_smilarity_score`. The following signals are supported: * `semantic_similarity_score`: semantic similarity adjustment that is calculated using the embeddings generated by a proprietary Google model. This score determines how semantically similar a search query is to a document. * `keyword_similarity_score`: keyword match adjustment uses the Best Match 25 (BM25) ranking function. This score is calculated using a probabilistic model to estimate the probability that a document is relevant to a given query. * `relevance_score`: semantic relevance adjustment that uses a proprietary Google model to determine the meaning and intent behind a user's query in context with the content in the documents. * `pctr_rank`: predicted conversion rate adjustment as a rank use predicted Click-through rate (pCTR) to gauge the relevance and attractiveness of a search result from a user's perspective. A higher pCTR suggests that the result is more likely to satisfy the user's query and intent, making it a valuable signal for ranking. * `freshness_rank`: freshness adjustment as a rank * `document_age`: The time in hours elapsed since the document was last updated, a floating-point number (e.g., 0.25 means 15 minutes). * `topicality_rank`: topicality adjustment as a rank. Uses proprietary Google model to determine the keyword-based overlap between the query and the document. * `base_rank`: the default rank of the result", +"description": "Optional. The ranking expression controls the customized ranking on retrieval documents. This overrides ServingConfig.ranking_expression. The syntax and supported features depend on the `ranking_expression_backend` value. If `ranking_expression_backend` is not provided, it defaults to `RANK_BY_EMBEDDING`. If ranking_expression_backend is not provided or set to `RANK_BY_EMBEDDING`, it should be a single function or multiple functions that are joined by \"+\". * ranking_expression = function, { \" + \", function }; Supported functions: * double * relevance_score * double * dotProduct(embedding_field_path) Function variables: * `relevance_score`: pre-defined keywords, used for measure relevance between query and document. * `embedding_field_path`: the document embedding field used with query embedding vector. * `dotProduct`: embedding function between `embedding_field_path` and query embedding vector. Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`. If ranking_expression_backend is set to `RANK_BY_FORMULA`, the following expression types (and combinations of those chained using + or * operators) are supported: * `double` * `signal` * `log(signal)` * `exp(signal)` * `rr(signal, double > 0)` -- reciprocal rank transformation with second argument being a denominator constant. * `is_nan(signal)` -- returns 0 if signal is NaN, 1 otherwise. * `fill_nan(signal1, signal2 | double)` -- if signal1 is NaN, returns signal2 | double, else returns signal1. Here are a few examples of ranking formulas that use the supported ranking expression types: - `0.2 * semantic_similarity_score + 0.8 * log(keyword_similarity_score)` -- mostly rank by the logarithm of `keyword_similarity_score` with slight `semantic_smilarity_score` adjustment. - `0.2 * exp(fill_nan(semantic_similarity_score, 0)) + 0.3 * is_nan(keyword_similarity_score)` -- rank by the exponent of `semantic_similarity_score` filling the value with 0 if it's NaN, also add constant 0.3 adjustment to the final score if `semantic_similarity_score` is NaN. - `0.2 * rr(semantic_similarity_score, 16) + 0.8 * rr(keyword_similarity_score, 16)` -- mostly rank by the reciprocal rank of `keyword_similarity_score` with slight adjustment of reciprocal rank of `semantic_smilarity_score`. The following signals are supported: * `semantic_similarity_score`: semantic similarity adjustment that is calculated using the embeddings generated by a proprietary Google model. This score determines how semantically similar a search query is to a document. * `keyword_similarity_score`: keyword match adjustment uses the Best Match 25 (BM25) ranking function. This score is calculated using a probabilistic model to estimate the probability that a document is relevant to a given query. * `relevance_score`: semantic relevance adjustment that uses a proprietary Google model to determine the meaning and intent behind a user's query in context with the content in the documents. * `pctr_rank`: predicted conversion rate adjustment as a rank use predicted Click-through rate (pCTR) to gauge the relevance and attractiveness of a search result from a user's perspective. A higher pCTR suggests that the result is more likely to satisfy the user's query and intent, making it a valuable signal for ranking. * `freshness_rank`: freshness adjustment as a rank * `document_age`: The time in hours elapsed since the document was last updated, a floating-point number (e.g., 0.25 means 15 minutes). * `topicality_rank`: topicality adjustment as a rank. Uses proprietary Google model to determine the keyword-based overlap between the query and the document. * `base_rank`: the default rank of the result * `media_actor_match`: whether the media actor matches the query * `media_director_match`: whether the media director matches the query * `media_genre_match`: whether the media genre matches the query * `media_language_match`: whether the media language matches the query * `media_title_match`: whether the media title matches the query * `media_prefix_similarity_rank`: prefix similarity rank for media results * `media_semantic_similarity_rank`: semantic similarity rank for media results", "type": "string" }, "rankingExpressionBackend": { @@ -30301,7 +30324,8 @@ false "id": "GoogleCloudDiscoveryengineV1alphaWorkspaceConfig", "properties": { "dasherCustomerId": { -"description": "Obfuscated Dasher customer ID.", +"description": "Output only. Obfuscated Dasher customer ID. Derived by the server from the project's GCP organization at data store creation time; any value supplied in the request payload is ignored.", +"readOnly": true, "type": "string" }, "superAdminEmailAddress": { @@ -33364,7 +33388,7 @@ false "description": "The query expansion specification that specifies the conditions under which query expansion occurs." }, "rankingExpression": { -"description": "Optional. The ranking expression controls the customized ranking on retrieval documents. This overrides ServingConfig.ranking_expression. The syntax and supported features depend on the `ranking_expression_backend` value. If `ranking_expression_backend` is not provided, it defaults to `RANK_BY_EMBEDDING`. If ranking_expression_backend is not provided or set to `RANK_BY_EMBEDDING`, it should be a single function or multiple functions that are joined by \"+\". * ranking_expression = function, { \" + \", function }; Supported functions: * double * relevance_score * double * dotProduct(embedding_field_path) Function variables: * `relevance_score`: pre-defined keywords, used for measure relevance between query and document. * `embedding_field_path`: the document embedding field used with query embedding vector. * `dotProduct`: embedding function between `embedding_field_path` and query embedding vector. Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`. If ranking_expression_backend is set to `RANK_BY_FORMULA`, the following expression types (and combinations of those chained using + or * operators) are supported: * `double` * `signal` * `log(signal)` * `exp(signal)` * `rr(signal, double > 0)` -- reciprocal rank transformation with second argument being a denominator constant. * `is_nan(signal)` -- returns 0 if signal is NaN, 1 otherwise. * `fill_nan(signal1, signal2 | double)` -- if signal1 is NaN, returns signal2 | double, else returns signal1. Here are a few examples of ranking formulas that use the supported ranking expression types: - `0.2 * semantic_similarity_score + 0.8 * log(keyword_similarity_score)` -- mostly rank by the logarithm of `keyword_similarity_score` with slight `semantic_smilarity_score` adjustment. - `0.2 * exp(fill_nan(semantic_similarity_score, 0)) + 0.3 * is_nan(keyword_similarity_score)` -- rank by the exponent of `semantic_similarity_score` filling the value with 0 if it's NaN, also add constant 0.3 adjustment to the final score if `semantic_similarity_score` is NaN. - `0.2 * rr(semantic_similarity_score, 16) + 0.8 * rr(keyword_similarity_score, 16)` -- mostly rank by the reciprocal rank of `keyword_similarity_score` with slight adjustment of reciprocal rank of `semantic_smilarity_score`. The following signals are supported: * `semantic_similarity_score`: semantic similarity adjustment that is calculated using the embeddings generated by a proprietary Google model. This score determines how semantically similar a search query is to a document. * `keyword_similarity_score`: keyword match adjustment uses the Best Match 25 (BM25) ranking function. This score is calculated using a probabilistic model to estimate the probability that a document is relevant to a given query. * `relevance_score`: semantic relevance adjustment that uses a proprietary Google model to determine the meaning and intent behind a user's query in context with the content in the documents. * `pctr_rank`: predicted conversion rate adjustment as a rank use predicted Click-through rate (pCTR) to gauge the relevance and attractiveness of a search result from a user's perspective. A higher pCTR suggests that the result is more likely to satisfy the user's query and intent, making it a valuable signal for ranking. * `freshness_rank`: freshness adjustment as a rank * `document_age`: The time in hours elapsed since the document was last updated, a floating-point number (e.g., 0.25 means 15 minutes). * `topicality_rank`: topicality adjustment as a rank. Uses proprietary Google model to determine the keyword-based overlap between the query and the document. * `base_rank`: the default rank of the result", +"description": "Optional. The ranking expression controls the customized ranking on retrieval documents. This overrides ServingConfig.ranking_expression. The syntax and supported features depend on the `ranking_expression_backend` value. If `ranking_expression_backend` is not provided, it defaults to `RANK_BY_EMBEDDING`. If ranking_expression_backend is not provided or set to `RANK_BY_EMBEDDING`, it should be a single function or multiple functions that are joined by \"+\". * ranking_expression = function, { \" + \", function }; Supported functions: * double * relevance_score * double * dotProduct(embedding_field_path) Function variables: * `relevance_score`: pre-defined keywords, used for measure relevance between query and document. * `embedding_field_path`: the document embedding field used with query embedding vector. * `dotProduct`: embedding function between `embedding_field_path` and query embedding vector. Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`. If ranking_expression_backend is set to `RANK_BY_FORMULA`, the following expression types (and combinations of those chained using + or * operators) are supported: * `double` * `signal` * `log(signal)` * `exp(signal)` * `rr(signal, double > 0)` -- reciprocal rank transformation with second argument being a denominator constant. * `is_nan(signal)` -- returns 0 if signal is NaN, 1 otherwise. * `fill_nan(signal1, signal2 | double)` -- if signal1 is NaN, returns signal2 | double, else returns signal1. Here are a few examples of ranking formulas that use the supported ranking expression types: - `0.2 * semantic_similarity_score + 0.8 * log(keyword_similarity_score)` -- mostly rank by the logarithm of `keyword_similarity_score` with slight `semantic_smilarity_score` adjustment. - `0.2 * exp(fill_nan(semantic_similarity_score, 0)) + 0.3 * is_nan(keyword_similarity_score)` -- rank by the exponent of `semantic_similarity_score` filling the value with 0 if it's NaN, also add constant 0.3 adjustment to the final score if `semantic_similarity_score` is NaN. - `0.2 * rr(semantic_similarity_score, 16) + 0.8 * rr(keyword_similarity_score, 16)` -- mostly rank by the reciprocal rank of `keyword_similarity_score` with slight adjustment of reciprocal rank of `semantic_smilarity_score`. The following signals are supported: * `semantic_similarity_score`: semantic similarity adjustment that is calculated using the embeddings generated by a proprietary Google model. This score determines how semantically similar a search query is to a document. * `keyword_similarity_score`: keyword match adjustment uses the Best Match 25 (BM25) ranking function. This score is calculated using a probabilistic model to estimate the probability that a document is relevant to a given query. * `relevance_score`: semantic relevance adjustment that uses a proprietary Google model to determine the meaning and intent behind a user's query in context with the content in the documents. * `pctr_rank`: predicted conversion rate adjustment as a rank use predicted Click-through rate (pCTR) to gauge the relevance and attractiveness of a search result from a user's perspective. A higher pCTR suggests that the result is more likely to satisfy the user's query and intent, making it a valuable signal for ranking. * `freshness_rank`: freshness adjustment as a rank * `document_age`: The time in hours elapsed since the document was last updated, a floating-point number (e.g., 0.25 means 15 minutes). * `topicality_rank`: topicality adjustment as a rank. Uses proprietary Google model to determine the keyword-based overlap between the query and the document. * `base_rank`: the default rank of the result * `media_actor_match`: whether the media actor matches the query * `media_director_match`: whether the media director matches the query * `media_genre_match`: whether the media genre matches the query * `media_language_match`: whether the media language matches the query * `media_title_match`: whether the media title matches the query * `media_prefix_similarity_rank`: prefix similarity rank for media results * `media_semantic_similarity_rank`: semantic similarity rank for media results", "type": "string" }, "rankingExpressionBackend": { @@ -34647,7 +34671,8 @@ false "id": "GoogleCloudDiscoveryengineV1betaWorkspaceConfig", "properties": { "dasherCustomerId": { -"description": "Obfuscated Dasher customer ID.", +"description": "Output only. Obfuscated Dasher customer ID. Derived by the server from the project's GCP organization at data store creation time; any value supplied in the request payload is ignored.", +"readOnly": true, "type": "string" }, "superAdminEmailAddress": { diff --git a/googleapiclient/discovery_cache/documents/discoveryengine.v1alpha.json b/googleapiclient/discovery_cache/documents/discoveryengine.v1alpha.json index 4a99ae7b09..3f58d7dac4 100644 --- a/googleapiclient/discovery_cache/documents/discoveryengine.v1alpha.json +++ b/googleapiclient/discovery_cache/documents/discoveryengine.v1alpha.json @@ -4103,7 +4103,7 @@ "type": "string" }, "orderBy": { -"description": "A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Supported fields: * `update_time` * `create_time` * `session_name` * `is_pinned` Example: * `update_time desc` * `create_time` * `is_pinned desc,update_time desc`: list sessions by is_pinned first, then by update_time.", +"description": "A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Supported fields: * `update_time` * `create_time` * `session_name` * `is_pinned` * `display_name` Example: * `update_time desc` * `create_time` * `is_pinned desc,update_time desc`: list sessions by is_pinned first, then by update_time.", "location": "query", "type": "string" }, @@ -7194,7 +7194,7 @@ "type": "string" }, "orderBy": { -"description": "A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Supported fields: * `update_time` * `create_time` * `session_name` * `is_pinned` Example: * `update_time desc` * `create_time` * `is_pinned desc,update_time desc`: list sessions by is_pinned first, then by update_time.", +"description": "A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Supported fields: * `update_time` * `create_time` * `session_name` * `is_pinned` * `display_name` Example: * `update_time desc` * `create_time` * `is_pinned desc,update_time desc`: list sessions by is_pinned first, then by update_time.", "location": "query", "type": "string" }, @@ -9878,7 +9878,7 @@ "type": "string" }, "orderBy": { -"description": "A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Supported fields: * `update_time` * `create_time` * `session_name` * `is_pinned` Example: * `update_time desc` * `create_time` * `is_pinned desc,update_time desc`: list sessions by is_pinned first, then by update_time.", +"description": "A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Supported fields: * `update_time` * `create_time` * `session_name` * `is_pinned` * `display_name` Example: * `update_time desc` * `create_time` * `is_pinned desc,update_time desc`: list sessions by is_pinned first, then by update_time.", "location": "query", "type": "string" }, @@ -12676,7 +12676,7 @@ } } }, -"revision": "20260512", +"revision": "20260524", "rootUrl": "https://discoveryengine.googleapis.com/", "schemas": { "GoogleApiDistribution": { @@ -17444,7 +17444,8 @@ "id": "GoogleCloudDiscoveryengineV1WorkspaceConfig", "properties": { "dasherCustomerId": { -"description": "Obfuscated Dasher customer ID.", +"description": "Output only. Obfuscated Dasher customer ID. Derived by the server from the project's GCP organization at data store creation time; any value supplied in the request payload is ignored.", +"readOnly": true, "type": "string" }, "superAdminEmailAddress": { @@ -25086,6 +25087,11 @@ "$ref": "GoogleCloudDiscoveryengineV1alphaExternalIdentityGroupMetadata", "description": "Metadata corresponding to the external user." }, +"subject": { +"description": "Output only. Represents the canonical IAM subject identifier (for users) or group identifier (for groups), derived from the workforce-pool claim mapping. Falls back to custom logic if not set. This must be used for IAM bindings.", +"readOnly": true, +"type": "string" +}, "userMetadata": { "$ref": "GoogleCloudDiscoveryengineV1alphaExternalIdentityUserMetadata", "description": "Metadata corresponding to the external user." @@ -25112,7 +25118,7 @@ "type": "string" }, "primaryEmail": { -"description": "The user's primary email address.", +"description": "The user's primary email address. Do not use this for IAM bindings. Use ExternalIdentity.subject.", "type": "string" } }, @@ -25372,7 +25378,7 @@ "type": "array" }, "searchableFieldImportance": { -"description": "Optional. Specifies the importance of the field when `searchable_option` is `SEARCHABLE_ENABLED`. If `searchable_option` is `SEARCHABLE_DISABLED`, this field is ignored. If `searchable_option` is `SEARCHABLE_ENABLED` and this is `SEARCHABLE_FIELD_IMPORTANCE_UNSPECIFIED`, it behaves as `DEFAULT_IMPORTANCE`.", +"description": "Optional. Specifies the importance of the field when `searchable_option` is `SEARCHABLE_ENABLED`. If `searchable_option` is `SEARCHABLE_DISABLED`, this field is ignored. If `searchable_option` is `SEARCHABLE_ENABLED` and this is `SEARCHABLE_FIELD_IMPORTANCE_UNSPECIFIED`, it behaves as `DEFAULT_IMPORTANCE`. For more information, see [Weight searchable fields](https://cloud.google.com/generative-ai-app-builder/docs/configure-field-settings#weight-search).", "enum": [ "SEARCHABLE_FIELD_IMPORTANCE_UNSPECIFIED", "VERY_LOW_IMPORTANCE", @@ -27145,7 +27151,7 @@ "type": "string" }, "orderBy": { -"description": "A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Supported fields: * `update_time` * `create_time` * `session_name` * `is_pinned` Example: * `update_time desc` * `create_time` * `is_pinned desc,update_time desc`: list sessions by is_pinned first, then by update_time.", +"description": "A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Supported fields: * `update_time` * `create_time` * `session_name` * `is_pinned` * `display_name` Example: * `update_time desc` * `create_time` * `is_pinned desc,update_time desc`: list sessions by is_pinned first, then by update_time.", "type": "string" }, "pageSize": { @@ -29379,7 +29385,7 @@ "description": "The query expansion specification that specifies the conditions under which query expansion occurs." }, "rankingExpression": { -"description": "Optional. The ranking expression controls the customized ranking on retrieval documents. This overrides ServingConfig.ranking_expression. The syntax and supported features depend on the `ranking_expression_backend` value. If `ranking_expression_backend` is not provided, it defaults to `RANK_BY_EMBEDDING`. If ranking_expression_backend is not provided or set to `RANK_BY_EMBEDDING`, it should be a single function or multiple functions that are joined by \"+\". * ranking_expression = function, { \" + \", function }; Supported functions: * double * relevance_score * double * dotProduct(embedding_field_path) Function variables: * `relevance_score`: pre-defined keywords, used for measure relevance between query and document. * `embedding_field_path`: the document embedding field used with query embedding vector. * `dotProduct`: embedding function between `embedding_field_path` and query embedding vector. Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`. If ranking_expression_backend is set to `RANK_BY_FORMULA`, the following expression types (and combinations of those chained using + or * operators) are supported: * `double` * `signal` * `log(signal)` * `exp(signal)` * `rr(signal, double > 0)` -- reciprocal rank transformation with second argument being a denominator constant. * `is_nan(signal)` -- returns 0 if signal is NaN, 1 otherwise. * `fill_nan(signal1, signal2 | double)` -- if signal1 is NaN, returns signal2 | double, else returns signal1. Here are a few examples of ranking formulas that use the supported ranking expression types: - `0.2 * semantic_similarity_score + 0.8 * log(keyword_similarity_score)` -- mostly rank by the logarithm of `keyword_similarity_score` with slight `semantic_smilarity_score` adjustment. - `0.2 * exp(fill_nan(semantic_similarity_score, 0)) + 0.3 * is_nan(keyword_similarity_score)` -- rank by the exponent of `semantic_similarity_score` filling the value with 0 if it's NaN, also add constant 0.3 adjustment to the final score if `semantic_similarity_score` is NaN. - `0.2 * rr(semantic_similarity_score, 16) + 0.8 * rr(keyword_similarity_score, 16)` -- mostly rank by the reciprocal rank of `keyword_similarity_score` with slight adjustment of reciprocal rank of `semantic_smilarity_score`. The following signals are supported: * `semantic_similarity_score`: semantic similarity adjustment that is calculated using the embeddings generated by a proprietary Google model. This score determines how semantically similar a search query is to a document. * `keyword_similarity_score`: keyword match adjustment uses the Best Match 25 (BM25) ranking function. This score is calculated using a probabilistic model to estimate the probability that a document is relevant to a given query. * `relevance_score`: semantic relevance adjustment that uses a proprietary Google model to determine the meaning and intent behind a user's query in context with the content in the documents. * `pctr_rank`: predicted conversion rate adjustment as a rank use predicted Click-through rate (pCTR) to gauge the relevance and attractiveness of a search result from a user's perspective. A higher pCTR suggests that the result is more likely to satisfy the user's query and intent, making it a valuable signal for ranking. * `freshness_rank`: freshness adjustment as a rank * `document_age`: The time in hours elapsed since the document was last updated, a floating-point number (e.g., 0.25 means 15 minutes). * `topicality_rank`: topicality adjustment as a rank. Uses proprietary Google model to determine the keyword-based overlap between the query and the document. * `base_rank`: the default rank of the result", +"description": "Optional. The ranking expression controls the customized ranking on retrieval documents. This overrides ServingConfig.ranking_expression. The syntax and supported features depend on the `ranking_expression_backend` value. If `ranking_expression_backend` is not provided, it defaults to `RANK_BY_EMBEDDING`. If ranking_expression_backend is not provided or set to `RANK_BY_EMBEDDING`, it should be a single function or multiple functions that are joined by \"+\". * ranking_expression = function, { \" + \", function }; Supported functions: * double * relevance_score * double * dotProduct(embedding_field_path) Function variables: * `relevance_score`: pre-defined keywords, used for measure relevance between query and document. * `embedding_field_path`: the document embedding field used with query embedding vector. * `dotProduct`: embedding function between `embedding_field_path` and query embedding vector. Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`. If ranking_expression_backend is set to `RANK_BY_FORMULA`, the following expression types (and combinations of those chained using + or * operators) are supported: * `double` * `signal` * `log(signal)` * `exp(signal)` * `rr(signal, double > 0)` -- reciprocal rank transformation with second argument being a denominator constant. * `is_nan(signal)` -- returns 0 if signal is NaN, 1 otherwise. * `fill_nan(signal1, signal2 | double)` -- if signal1 is NaN, returns signal2 | double, else returns signal1. Here are a few examples of ranking formulas that use the supported ranking expression types: - `0.2 * semantic_similarity_score + 0.8 * log(keyword_similarity_score)` -- mostly rank by the logarithm of `keyword_similarity_score` with slight `semantic_smilarity_score` adjustment. - `0.2 * exp(fill_nan(semantic_similarity_score, 0)) + 0.3 * is_nan(keyword_similarity_score)` -- rank by the exponent of `semantic_similarity_score` filling the value with 0 if it's NaN, also add constant 0.3 adjustment to the final score if `semantic_similarity_score` is NaN. - `0.2 * rr(semantic_similarity_score, 16) + 0.8 * rr(keyword_similarity_score, 16)` -- mostly rank by the reciprocal rank of `keyword_similarity_score` with slight adjustment of reciprocal rank of `semantic_smilarity_score`. The following signals are supported: * `semantic_similarity_score`: semantic similarity adjustment that is calculated using the embeddings generated by a proprietary Google model. This score determines how semantically similar a search query is to a document. * `keyword_similarity_score`: keyword match adjustment uses the Best Match 25 (BM25) ranking function. This score is calculated using a probabilistic model to estimate the probability that a document is relevant to a given query. * `relevance_score`: semantic relevance adjustment that uses a proprietary Google model to determine the meaning and intent behind a user's query in context with the content in the documents. * `pctr_rank`: predicted conversion rate adjustment as a rank use predicted Click-through rate (pCTR) to gauge the relevance and attractiveness of a search result from a user's perspective. A higher pCTR suggests that the result is more likely to satisfy the user's query and intent, making it a valuable signal for ranking. * `freshness_rank`: freshness adjustment as a rank * `document_age`: The time in hours elapsed since the document was last updated, a floating-point number (e.g., 0.25 means 15 minutes). * `topicality_rank`: topicality adjustment as a rank. Uses proprietary Google model to determine the keyword-based overlap between the query and the document. * `base_rank`: the default rank of the result * `media_actor_match`: whether the media actor matches the query * `media_director_match`: whether the media director matches the query * `media_genre_match`: whether the media genre matches the query * `media_language_match`: whether the media language matches the query * `media_title_match`: whether the media title matches the query * `media_prefix_similarity_rank`: prefix similarity rank for media results * `media_semantic_similarity_rank`: semantic similarity rank for media results", "type": "string" }, "rankingExpressionBackend": { @@ -31756,6 +31762,13 @@ false }, "type": "array" }, +"invokedSkills": { +"description": "The skills executed during the turn.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1alphaStreamAssistResponseInvokedSkill" +}, +"type": "array" +}, "sessionInfo": { "$ref": "GoogleCloudDiscoveryengineV1alphaStreamAssistResponseSessionInfo", "description": "Session information. Only included in the final StreamAssistResponse of the response stream." @@ -31763,6 +31776,21 @@ false }, "type": "object" }, +"GoogleCloudDiscoveryengineV1alphaStreamAssistResponseInvokedSkill": { +"description": "Represents a skill used during the assist call.", +"id": "GoogleCloudDiscoveryengineV1alphaStreamAssistResponseInvokedSkill", +"properties": { +"displayName": { +"description": "The display name of the skill.", +"type": "string" +}, +"name": { +"description": "The resource name of the skill.", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1alphaStreamAssistResponseSessionInfo": { "description": "Information about the session.", "id": "GoogleCloudDiscoveryengineV1alphaStreamAssistResponseSessionInfo", @@ -33344,7 +33372,8 @@ false "id": "GoogleCloudDiscoveryengineV1alphaWorkspaceConfig", "properties": { "dasherCustomerId": { -"description": "Obfuscated Dasher customer ID.", +"description": "Output only. Obfuscated Dasher customer ID. Derived by the server from the project's GCP organization at data store creation time; any value supplied in the request payload is ignored.", +"readOnly": true, "type": "string" }, "superAdminEmailAddress": { @@ -36418,7 +36447,7 @@ false "description": "The query expansion specification that specifies the conditions under which query expansion occurs." }, "rankingExpression": { -"description": "Optional. The ranking expression controls the customized ranking on retrieval documents. This overrides ServingConfig.ranking_expression. The syntax and supported features depend on the `ranking_expression_backend` value. If `ranking_expression_backend` is not provided, it defaults to `RANK_BY_EMBEDDING`. If ranking_expression_backend is not provided or set to `RANK_BY_EMBEDDING`, it should be a single function or multiple functions that are joined by \"+\". * ranking_expression = function, { \" + \", function }; Supported functions: * double * relevance_score * double * dotProduct(embedding_field_path) Function variables: * `relevance_score`: pre-defined keywords, used for measure relevance between query and document. * `embedding_field_path`: the document embedding field used with query embedding vector. * `dotProduct`: embedding function between `embedding_field_path` and query embedding vector. Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`. If ranking_expression_backend is set to `RANK_BY_FORMULA`, the following expression types (and combinations of those chained using + or * operators) are supported: * `double` * `signal` * `log(signal)` * `exp(signal)` * `rr(signal, double > 0)` -- reciprocal rank transformation with second argument being a denominator constant. * `is_nan(signal)` -- returns 0 if signal is NaN, 1 otherwise. * `fill_nan(signal1, signal2 | double)` -- if signal1 is NaN, returns signal2 | double, else returns signal1. Here are a few examples of ranking formulas that use the supported ranking expression types: - `0.2 * semantic_similarity_score + 0.8 * log(keyword_similarity_score)` -- mostly rank by the logarithm of `keyword_similarity_score` with slight `semantic_smilarity_score` adjustment. - `0.2 * exp(fill_nan(semantic_similarity_score, 0)) + 0.3 * is_nan(keyword_similarity_score)` -- rank by the exponent of `semantic_similarity_score` filling the value with 0 if it's NaN, also add constant 0.3 adjustment to the final score if `semantic_similarity_score` is NaN. - `0.2 * rr(semantic_similarity_score, 16) + 0.8 * rr(keyword_similarity_score, 16)` -- mostly rank by the reciprocal rank of `keyword_similarity_score` with slight adjustment of reciprocal rank of `semantic_smilarity_score`. The following signals are supported: * `semantic_similarity_score`: semantic similarity adjustment that is calculated using the embeddings generated by a proprietary Google model. This score determines how semantically similar a search query is to a document. * `keyword_similarity_score`: keyword match adjustment uses the Best Match 25 (BM25) ranking function. This score is calculated using a probabilistic model to estimate the probability that a document is relevant to a given query. * `relevance_score`: semantic relevance adjustment that uses a proprietary Google model to determine the meaning and intent behind a user's query in context with the content in the documents. * `pctr_rank`: predicted conversion rate adjustment as a rank use predicted Click-through rate (pCTR) to gauge the relevance and attractiveness of a search result from a user's perspective. A higher pCTR suggests that the result is more likely to satisfy the user's query and intent, making it a valuable signal for ranking. * `freshness_rank`: freshness adjustment as a rank * `document_age`: The time in hours elapsed since the document was last updated, a floating-point number (e.g., 0.25 means 15 minutes). * `topicality_rank`: topicality adjustment as a rank. Uses proprietary Google model to determine the keyword-based overlap between the query and the document. * `base_rank`: the default rank of the result", +"description": "Optional. The ranking expression controls the customized ranking on retrieval documents. This overrides ServingConfig.ranking_expression. The syntax and supported features depend on the `ranking_expression_backend` value. If `ranking_expression_backend` is not provided, it defaults to `RANK_BY_EMBEDDING`. If ranking_expression_backend is not provided or set to `RANK_BY_EMBEDDING`, it should be a single function or multiple functions that are joined by \"+\". * ranking_expression = function, { \" + \", function }; Supported functions: * double * relevance_score * double * dotProduct(embedding_field_path) Function variables: * `relevance_score`: pre-defined keywords, used for measure relevance between query and document. * `embedding_field_path`: the document embedding field used with query embedding vector. * `dotProduct`: embedding function between `embedding_field_path` and query embedding vector. Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`. If ranking_expression_backend is set to `RANK_BY_FORMULA`, the following expression types (and combinations of those chained using + or * operators) are supported: * `double` * `signal` * `log(signal)` * `exp(signal)` * `rr(signal, double > 0)` -- reciprocal rank transformation with second argument being a denominator constant. * `is_nan(signal)` -- returns 0 if signal is NaN, 1 otherwise. * `fill_nan(signal1, signal2 | double)` -- if signal1 is NaN, returns signal2 | double, else returns signal1. Here are a few examples of ranking formulas that use the supported ranking expression types: - `0.2 * semantic_similarity_score + 0.8 * log(keyword_similarity_score)` -- mostly rank by the logarithm of `keyword_similarity_score` with slight `semantic_smilarity_score` adjustment. - `0.2 * exp(fill_nan(semantic_similarity_score, 0)) + 0.3 * is_nan(keyword_similarity_score)` -- rank by the exponent of `semantic_similarity_score` filling the value with 0 if it's NaN, also add constant 0.3 adjustment to the final score if `semantic_similarity_score` is NaN. - `0.2 * rr(semantic_similarity_score, 16) + 0.8 * rr(keyword_similarity_score, 16)` -- mostly rank by the reciprocal rank of `keyword_similarity_score` with slight adjustment of reciprocal rank of `semantic_smilarity_score`. The following signals are supported: * `semantic_similarity_score`: semantic similarity adjustment that is calculated using the embeddings generated by a proprietary Google model. This score determines how semantically similar a search query is to a document. * `keyword_similarity_score`: keyword match adjustment uses the Best Match 25 (BM25) ranking function. This score is calculated using a probabilistic model to estimate the probability that a document is relevant to a given query. * `relevance_score`: semantic relevance adjustment that uses a proprietary Google model to determine the meaning and intent behind a user's query in context with the content in the documents. * `pctr_rank`: predicted conversion rate adjustment as a rank use predicted Click-through rate (pCTR) to gauge the relevance and attractiveness of a search result from a user's perspective. A higher pCTR suggests that the result is more likely to satisfy the user's query and intent, making it a valuable signal for ranking. * `freshness_rank`: freshness adjustment as a rank * `document_age`: The time in hours elapsed since the document was last updated, a floating-point number (e.g., 0.25 means 15 minutes). * `topicality_rank`: topicality adjustment as a rank. Uses proprietary Google model to determine the keyword-based overlap between the query and the document. * `base_rank`: the default rank of the result * `media_actor_match`: whether the media actor matches the query * `media_director_match`: whether the media director matches the query * `media_genre_match`: whether the media genre matches the query * `media_language_match`: whether the media language matches the query * `media_title_match`: whether the media title matches the query * `media_prefix_similarity_rank`: prefix similarity rank for media results * `media_semantic_similarity_rank`: semantic similarity rank for media results", "type": "string" }, "rankingExpressionBackend": { @@ -37701,7 +37730,8 @@ false "id": "GoogleCloudDiscoveryengineV1betaWorkspaceConfig", "properties": { "dasherCustomerId": { -"description": "Obfuscated Dasher customer ID.", +"description": "Output only. Obfuscated Dasher customer ID. Derived by the server from the project's GCP organization at data store creation time; any value supplied in the request payload is ignored.", +"readOnly": true, "type": "string" }, "superAdminEmailAddress": { diff --git a/googleapiclient/discovery_cache/documents/discoveryengine.v1beta.json b/googleapiclient/discovery_cache/documents/discoveryengine.v1beta.json index de2194a8e5..6a0537fb39 100644 --- a/googleapiclient/discovery_cache/documents/discoveryengine.v1beta.json +++ b/googleapiclient/discovery_cache/documents/discoveryengine.v1beta.json @@ -2696,7 +2696,7 @@ "type": "string" }, "orderBy": { -"description": "A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Supported fields: * `update_time` * `create_time` * `session_name` * `is_pinned` Example: * `update_time desc` * `create_time` * `is_pinned desc,update_time desc`: list sessions by is_pinned first, then by update_time.", +"description": "A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Supported fields: * `update_time` * `create_time` * `session_name` * `is_pinned` * `display_name` Example: * `update_time desc` * `create_time` * `is_pinned desc,update_time desc`: list sessions by is_pinned first, then by update_time.", "location": "query", "type": "string" }, @@ -5138,7 +5138,7 @@ "type": "string" }, "orderBy": { -"description": "A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Supported fields: * `update_time` * `create_time` * `session_name` * `is_pinned` Example: * `update_time desc` * `create_time` * `is_pinned desc,update_time desc`: list sessions by is_pinned first, then by update_time.", +"description": "A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Supported fields: * `update_time` * `create_time` * `session_name` * `is_pinned` * `display_name` Example: * `update_time desc` * `create_time` * `is_pinned desc,update_time desc`: list sessions by is_pinned first, then by update_time.", "location": "query", "type": "string" }, @@ -7217,7 +7217,7 @@ "type": "string" }, "orderBy": { -"description": "A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Supported fields: * `update_time` * `create_time` * `session_name` * `is_pinned` Example: * `update_time desc` * `create_time` * `is_pinned desc,update_time desc`: list sessions by is_pinned first, then by update_time.", +"description": "A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Supported fields: * `update_time` * `create_time` * `session_name` * `is_pinned` * `display_name` Example: * `update_time desc` * `create_time` * `is_pinned desc,update_time desc`: list sessions by is_pinned first, then by update_time.", "location": "query", "type": "string" }, @@ -9509,7 +9509,7 @@ } } }, -"revision": "20260512", +"revision": "20260524", "rootUrl": "https://discoveryengine.googleapis.com/", "schemas": { "GoogleApiDistribution": { @@ -14277,7 +14277,8 @@ "id": "GoogleCloudDiscoveryengineV1WorkspaceConfig", "properties": { "dasherCustomerId": { -"description": "Obfuscated Dasher customer ID.", +"description": "Output only. Obfuscated Dasher customer ID. Derived by the server from the project's GCP organization at data store creation time; any value supplied in the request payload is ignored.", +"readOnly": true, "type": "string" }, "superAdminEmailAddress": { @@ -18726,7 +18727,7 @@ "type": "array" }, "searchableFieldImportance": { -"description": "Optional. Specifies the importance of the field when `searchable_option` is `SEARCHABLE_ENABLED`. If `searchable_option` is `SEARCHABLE_DISABLED`, this field is ignored. If `searchable_option` is `SEARCHABLE_ENABLED` and this is `SEARCHABLE_FIELD_IMPORTANCE_UNSPECIFIED`, it behaves as `DEFAULT_IMPORTANCE`.", +"description": "Optional. Specifies the importance of the field when `searchable_option` is `SEARCHABLE_ENABLED`. If `searchable_option` is `SEARCHABLE_DISABLED`, this field is ignored. If `searchable_option` is `SEARCHABLE_ENABLED` and this is `SEARCHABLE_FIELD_IMPORTANCE_UNSPECIFIED`, it behaves as `DEFAULT_IMPORTANCE`. For more information, see [Weight searchable fields](https://cloud.google.com/generative-ai-app-builder/docs/configure-field-settings#weight-search).", "enum": [ "SEARCHABLE_FIELD_IMPORTANCE_UNSPECIFIED", "VERY_LOW_IMPORTANCE", @@ -19346,7 +19347,7 @@ "type": "string" }, "orderBy": { -"description": "A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Supported fields: * `update_time` * `create_time` * `session_name` * `is_pinned` Example: * `update_time desc` * `create_time` * `is_pinned desc,update_time desc`: list sessions by is_pinned first, then by update_time.", +"description": "A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Supported fields: * `update_time` * `create_time` * `session_name` * `is_pinned` * `display_name` Example: * `update_time desc` * `create_time` * `is_pinned desc,update_time desc`: list sessions by is_pinned first, then by update_time.", "type": "string" }, "pageSize": { @@ -20581,7 +20582,7 @@ "description": "The query expansion specification that specifies the conditions under which query expansion occurs." }, "rankingExpression": { -"description": "Optional. The ranking expression controls the customized ranking on retrieval documents. This overrides ServingConfig.ranking_expression. The syntax and supported features depend on the `ranking_expression_backend` value. If `ranking_expression_backend` is not provided, it defaults to `RANK_BY_EMBEDDING`. If ranking_expression_backend is not provided or set to `RANK_BY_EMBEDDING`, it should be a single function or multiple functions that are joined by \"+\". * ranking_expression = function, { \" + \", function }; Supported functions: * double * relevance_score * double * dotProduct(embedding_field_path) Function variables: * `relevance_score`: pre-defined keywords, used for measure relevance between query and document. * `embedding_field_path`: the document embedding field used with query embedding vector. * `dotProduct`: embedding function between `embedding_field_path` and query embedding vector. Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`. If ranking_expression_backend is set to `RANK_BY_FORMULA`, the following expression types (and combinations of those chained using + or * operators) are supported: * `double` * `signal` * `log(signal)` * `exp(signal)` * `rr(signal, double > 0)` -- reciprocal rank transformation with second argument being a denominator constant. * `is_nan(signal)` -- returns 0 if signal is NaN, 1 otherwise. * `fill_nan(signal1, signal2 | double)` -- if signal1 is NaN, returns signal2 | double, else returns signal1. Here are a few examples of ranking formulas that use the supported ranking expression types: - `0.2 * semantic_similarity_score + 0.8 * log(keyword_similarity_score)` -- mostly rank by the logarithm of `keyword_similarity_score` with slight `semantic_smilarity_score` adjustment. - `0.2 * exp(fill_nan(semantic_similarity_score, 0)) + 0.3 * is_nan(keyword_similarity_score)` -- rank by the exponent of `semantic_similarity_score` filling the value with 0 if it's NaN, also add constant 0.3 adjustment to the final score if `semantic_similarity_score` is NaN. - `0.2 * rr(semantic_similarity_score, 16) + 0.8 * rr(keyword_similarity_score, 16)` -- mostly rank by the reciprocal rank of `keyword_similarity_score` with slight adjustment of reciprocal rank of `semantic_smilarity_score`. The following signals are supported: * `semantic_similarity_score`: semantic similarity adjustment that is calculated using the embeddings generated by a proprietary Google model. This score determines how semantically similar a search query is to a document. * `keyword_similarity_score`: keyword match adjustment uses the Best Match 25 (BM25) ranking function. This score is calculated using a probabilistic model to estimate the probability that a document is relevant to a given query. * `relevance_score`: semantic relevance adjustment that uses a proprietary Google model to determine the meaning and intent behind a user's query in context with the content in the documents. * `pctr_rank`: predicted conversion rate adjustment as a rank use predicted Click-through rate (pCTR) to gauge the relevance and attractiveness of a search result from a user's perspective. A higher pCTR suggests that the result is more likely to satisfy the user's query and intent, making it a valuable signal for ranking. * `freshness_rank`: freshness adjustment as a rank * `document_age`: The time in hours elapsed since the document was last updated, a floating-point number (e.g., 0.25 means 15 minutes). * `topicality_rank`: topicality adjustment as a rank. Uses proprietary Google model to determine the keyword-based overlap between the query and the document. * `base_rank`: the default rank of the result", +"description": "Optional. The ranking expression controls the customized ranking on retrieval documents. This overrides ServingConfig.ranking_expression. The syntax and supported features depend on the `ranking_expression_backend` value. If `ranking_expression_backend` is not provided, it defaults to `RANK_BY_EMBEDDING`. If ranking_expression_backend is not provided or set to `RANK_BY_EMBEDDING`, it should be a single function or multiple functions that are joined by \"+\". * ranking_expression = function, { \" + \", function }; Supported functions: * double * relevance_score * double * dotProduct(embedding_field_path) Function variables: * `relevance_score`: pre-defined keywords, used for measure relevance between query and document. * `embedding_field_path`: the document embedding field used with query embedding vector. * `dotProduct`: embedding function between `embedding_field_path` and query embedding vector. Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`. If ranking_expression_backend is set to `RANK_BY_FORMULA`, the following expression types (and combinations of those chained using + or * operators) are supported: * `double` * `signal` * `log(signal)` * `exp(signal)` * `rr(signal, double > 0)` -- reciprocal rank transformation with second argument being a denominator constant. * `is_nan(signal)` -- returns 0 if signal is NaN, 1 otherwise. * `fill_nan(signal1, signal2 | double)` -- if signal1 is NaN, returns signal2 | double, else returns signal1. Here are a few examples of ranking formulas that use the supported ranking expression types: - `0.2 * semantic_similarity_score + 0.8 * log(keyword_similarity_score)` -- mostly rank by the logarithm of `keyword_similarity_score` with slight `semantic_smilarity_score` adjustment. - `0.2 * exp(fill_nan(semantic_similarity_score, 0)) + 0.3 * is_nan(keyword_similarity_score)` -- rank by the exponent of `semantic_similarity_score` filling the value with 0 if it's NaN, also add constant 0.3 adjustment to the final score if `semantic_similarity_score` is NaN. - `0.2 * rr(semantic_similarity_score, 16) + 0.8 * rr(keyword_similarity_score, 16)` -- mostly rank by the reciprocal rank of `keyword_similarity_score` with slight adjustment of reciprocal rank of `semantic_smilarity_score`. The following signals are supported: * `semantic_similarity_score`: semantic similarity adjustment that is calculated using the embeddings generated by a proprietary Google model. This score determines how semantically similar a search query is to a document. * `keyword_similarity_score`: keyword match adjustment uses the Best Match 25 (BM25) ranking function. This score is calculated using a probabilistic model to estimate the probability that a document is relevant to a given query. * `relevance_score`: semantic relevance adjustment that uses a proprietary Google model to determine the meaning and intent behind a user's query in context with the content in the documents. * `pctr_rank`: predicted conversion rate adjustment as a rank use predicted Click-through rate (pCTR) to gauge the relevance and attractiveness of a search result from a user's perspective. A higher pCTR suggests that the result is more likely to satisfy the user's query and intent, making it a valuable signal for ranking. * `freshness_rank`: freshness adjustment as a rank * `document_age`: The time in hours elapsed since the document was last updated, a floating-point number (e.g., 0.25 means 15 minutes). * `topicality_rank`: topicality adjustment as a rank. Uses proprietary Google model to determine the keyword-based overlap between the query and the document. * `base_rank`: the default rank of the result * `media_actor_match`: whether the media actor matches the query * `media_director_match`: whether the media director matches the query * `media_genre_match`: whether the media genre matches the query * `media_language_match`: whether the media language matches the query * `media_title_match`: whether the media title matches the query * `media_prefix_similarity_rank`: prefix similarity rank for media results * `media_semantic_similarity_rank`: semantic similarity rank for media results", "type": "string" }, "rankingExpressionBackend": { @@ -22041,7 +22042,8 @@ false "id": "GoogleCloudDiscoveryengineV1alphaWorkspaceConfig", "properties": { "dasherCustomerId": { -"description": "Obfuscated Dasher customer ID.", +"description": "Output only. Obfuscated Dasher customer ID. Derived by the server from the project's GCP organization at data store creation time; any value supplied in the request payload is ignored.", +"readOnly": true, "type": "string" }, "superAdminEmailAddress": { @@ -30339,7 +30341,7 @@ false "description": "The query expansion specification that specifies the conditions under which query expansion occurs." }, "rankingExpression": { -"description": "Optional. The ranking expression controls the customized ranking on retrieval documents. This overrides ServingConfig.ranking_expression. The syntax and supported features depend on the `ranking_expression_backend` value. If `ranking_expression_backend` is not provided, it defaults to `RANK_BY_EMBEDDING`. If ranking_expression_backend is not provided or set to `RANK_BY_EMBEDDING`, it should be a single function or multiple functions that are joined by \"+\". * ranking_expression = function, { \" + \", function }; Supported functions: * double * relevance_score * double * dotProduct(embedding_field_path) Function variables: * `relevance_score`: pre-defined keywords, used for measure relevance between query and document. * `embedding_field_path`: the document embedding field used with query embedding vector. * `dotProduct`: embedding function between `embedding_field_path` and query embedding vector. Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`. If ranking_expression_backend is set to `RANK_BY_FORMULA`, the following expression types (and combinations of those chained using + or * operators) are supported: * `double` * `signal` * `log(signal)` * `exp(signal)` * `rr(signal, double > 0)` -- reciprocal rank transformation with second argument being a denominator constant. * `is_nan(signal)` -- returns 0 if signal is NaN, 1 otherwise. * `fill_nan(signal1, signal2 | double)` -- if signal1 is NaN, returns signal2 | double, else returns signal1. Here are a few examples of ranking formulas that use the supported ranking expression types: - `0.2 * semantic_similarity_score + 0.8 * log(keyword_similarity_score)` -- mostly rank by the logarithm of `keyword_similarity_score` with slight `semantic_smilarity_score` adjustment. - `0.2 * exp(fill_nan(semantic_similarity_score, 0)) + 0.3 * is_nan(keyword_similarity_score)` -- rank by the exponent of `semantic_similarity_score` filling the value with 0 if it's NaN, also add constant 0.3 adjustment to the final score if `semantic_similarity_score` is NaN. - `0.2 * rr(semantic_similarity_score, 16) + 0.8 * rr(keyword_similarity_score, 16)` -- mostly rank by the reciprocal rank of `keyword_similarity_score` with slight adjustment of reciprocal rank of `semantic_smilarity_score`. The following signals are supported: * `semantic_similarity_score`: semantic similarity adjustment that is calculated using the embeddings generated by a proprietary Google model. This score determines how semantically similar a search query is to a document. * `keyword_similarity_score`: keyword match adjustment uses the Best Match 25 (BM25) ranking function. This score is calculated using a probabilistic model to estimate the probability that a document is relevant to a given query. * `relevance_score`: semantic relevance adjustment that uses a proprietary Google model to determine the meaning and intent behind a user's query in context with the content in the documents. * `pctr_rank`: predicted conversion rate adjustment as a rank use predicted Click-through rate (pCTR) to gauge the relevance and attractiveness of a search result from a user's perspective. A higher pCTR suggests that the result is more likely to satisfy the user's query and intent, making it a valuable signal for ranking. * `freshness_rank`: freshness adjustment as a rank * `document_age`: The time in hours elapsed since the document was last updated, a floating-point number (e.g., 0.25 means 15 minutes). * `topicality_rank`: topicality adjustment as a rank. Uses proprietary Google model to determine the keyword-based overlap between the query and the document. * `base_rank`: the default rank of the result", +"description": "Optional. The ranking expression controls the customized ranking on retrieval documents. This overrides ServingConfig.ranking_expression. The syntax and supported features depend on the `ranking_expression_backend` value. If `ranking_expression_backend` is not provided, it defaults to `RANK_BY_EMBEDDING`. If ranking_expression_backend is not provided or set to `RANK_BY_EMBEDDING`, it should be a single function or multiple functions that are joined by \"+\". * ranking_expression = function, { \" + \", function }; Supported functions: * double * relevance_score * double * dotProduct(embedding_field_path) Function variables: * `relevance_score`: pre-defined keywords, used for measure relevance between query and document. * `embedding_field_path`: the document embedding field used with query embedding vector. * `dotProduct`: embedding function between `embedding_field_path` and query embedding vector. Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`. If ranking_expression_backend is set to `RANK_BY_FORMULA`, the following expression types (and combinations of those chained using + or * operators) are supported: * `double` * `signal` * `log(signal)` * `exp(signal)` * `rr(signal, double > 0)` -- reciprocal rank transformation with second argument being a denominator constant. * `is_nan(signal)` -- returns 0 if signal is NaN, 1 otherwise. * `fill_nan(signal1, signal2 | double)` -- if signal1 is NaN, returns signal2 | double, else returns signal1. Here are a few examples of ranking formulas that use the supported ranking expression types: - `0.2 * semantic_similarity_score + 0.8 * log(keyword_similarity_score)` -- mostly rank by the logarithm of `keyword_similarity_score` with slight `semantic_smilarity_score` adjustment. - `0.2 * exp(fill_nan(semantic_similarity_score, 0)) + 0.3 * is_nan(keyword_similarity_score)` -- rank by the exponent of `semantic_similarity_score` filling the value with 0 if it's NaN, also add constant 0.3 adjustment to the final score if `semantic_similarity_score` is NaN. - `0.2 * rr(semantic_similarity_score, 16) + 0.8 * rr(keyword_similarity_score, 16)` -- mostly rank by the reciprocal rank of `keyword_similarity_score` with slight adjustment of reciprocal rank of `semantic_smilarity_score`. The following signals are supported: * `semantic_similarity_score`: semantic similarity adjustment that is calculated using the embeddings generated by a proprietary Google model. This score determines how semantically similar a search query is to a document. * `keyword_similarity_score`: keyword match adjustment uses the Best Match 25 (BM25) ranking function. This score is calculated using a probabilistic model to estimate the probability that a document is relevant to a given query. * `relevance_score`: semantic relevance adjustment that uses a proprietary Google model to determine the meaning and intent behind a user's query in context with the content in the documents. * `pctr_rank`: predicted conversion rate adjustment as a rank use predicted Click-through rate (pCTR) to gauge the relevance and attractiveness of a search result from a user's perspective. A higher pCTR suggests that the result is more likely to satisfy the user's query and intent, making it a valuable signal for ranking. * `freshness_rank`: freshness adjustment as a rank * `document_age`: The time in hours elapsed since the document was last updated, a floating-point number (e.g., 0.25 means 15 minutes). * `topicality_rank`: topicality adjustment as a rank. Uses proprietary Google model to determine the keyword-based overlap between the query and the document. * `base_rank`: the default rank of the result * `media_actor_match`: whether the media actor matches the query * `media_director_match`: whether the media director matches the query * `media_genre_match`: whether the media genre matches the query * `media_language_match`: whether the media language matches the query * `media_title_match`: whether the media title matches the query * `media_prefix_similarity_rank`: prefix similarity rank for media results * `media_semantic_similarity_rank`: semantic similarity rank for media results", "type": "string" }, "rankingExpressionBackend": { @@ -32577,6 +32579,13 @@ false }, "type": "array" }, +"invokedSkills": { +"description": "The skills executed during the turn.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1betaStreamAssistResponseInvokedSkill" +}, +"type": "array" +}, "sessionInfo": { "$ref": "GoogleCloudDiscoveryengineV1betaStreamAssistResponseSessionInfo", "description": "Session information. Only included in the final StreamAssistResponse of the response stream." @@ -32584,6 +32593,21 @@ false }, "type": "object" }, +"GoogleCloudDiscoveryengineV1betaStreamAssistResponseInvokedSkill": { +"description": "Represents a skill used during the assist call.", +"id": "GoogleCloudDiscoveryengineV1betaStreamAssistResponseInvokedSkill", +"properties": { +"displayName": { +"description": "The display name of the skill.", +"type": "string" +}, +"name": { +"description": "The resource name of the skill.", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1betaStreamAssistResponseSessionInfo": { "description": "Information about the session.", "id": "GoogleCloudDiscoveryengineV1betaStreamAssistResponseSessionInfo", @@ -33173,7 +33197,8 @@ false "id": "GoogleCloudDiscoveryengineV1betaWorkspaceConfig", "properties": { "dasherCustomerId": { -"description": "Obfuscated Dasher customer ID.", +"description": "Output only. Obfuscated Dasher customer ID. Derived by the server from the project's GCP organization at data store creation time; any value supplied in the request payload is ignored.", +"readOnly": true, "type": "string" }, "superAdminEmailAddress": { diff --git a/googleapiclient/discovery_cache/documents/dlp.v2.json b/googleapiclient/discovery_cache/documents/dlp.v2.json index 8dce40eef4..48a984f3d6 100644 --- a/googleapiclient/discovery_cache/documents/dlp.v2.json +++ b/googleapiclient/discovery_cache/documents/dlp.v2.json @@ -5128,7 +5128,7 @@ } } }, -"revision": "20260509", +"revision": "20260528", "rootUrl": "https://dlp.googleapis.com/", "schemas": { "GooglePrivacyDlpV2Action": { @@ -5303,6 +5303,12 @@ "properties": {}, "type": "object" }, +"GooglePrivacyDlpV2AllMessages": { +"description": "If set, indicates that the finding applies to all messages in the conversation.", +"id": "GooglePrivacyDlpV2AllMessages", +"properties": {}, +"type": "object" +}, "GooglePrivacyDlpV2AllOtherBigQueryTables": { "description": "Catch-all for all other tables not specified by other filters. Should always be last, except for single-table configurations, which will only have a TableReference target.", "id": "GooglePrivacyDlpV2AllOtherBigQueryTables", @@ -5506,6 +5512,29 @@ }, "type": "object" }, +"GooglePrivacyDlpV2BatchContentItem": { +"description": "Represents a batch of content to inspect or redact.", +"id": "GooglePrivacyDlpV2BatchContentItem", +"properties": { +"stringValueBatch": { +"$ref": "GooglePrivacyDlpV2StringValueBatch", +"description": "Optional. Represents a batch of string values to inspect or redact." +} +}, +"type": "object" +}, +"GooglePrivacyDlpV2BatchContentLocation": { +"description": "Location within a batch of content.", +"id": "GooglePrivacyDlpV2BatchContentLocation", +"properties": { +"itemIndex": { +"description": "Matches an index of a batch item in the batch provided in the request.", +"format": "int32", +"type": "integer" +} +}, +"type": "object" +}, "GooglePrivacyDlpV2BigQueryDiscoveryTarget": { "description": "Target used to match against for discovery with BigQuery tables", "id": "GooglePrivacyDlpV2BigQueryDiscoveryTarget", @@ -6517,6 +6546,10 @@ "description": "Type of content to inspect.", "id": "GooglePrivacyDlpV2ContentItem", "properties": { +"batchContentItem": { +"$ref": "GooglePrivacyDlpV2BatchContentItem", +"description": "Represents a batch of items to inspect." +}, "byteItem": { "$ref": "GooglePrivacyDlpV2ByteContentItem", "description": "Content data to inspect or redact. Replaces `type` and `data`." @@ -6525,6 +6558,10 @@ "$ref": "GooglePrivacyDlpV2ContentMetadata", "description": "User provided metadata for the content." }, +"conversation": { +"$ref": "GooglePrivacyDlpV2Conversation", +"description": "Represents a conversation (either complete or a slice). It is assumed that all included messages are contiguous and ordered in chronological order." +}, "table": { "$ref": "GooglePrivacyDlpV2Table", "description": "Structured content for inspection. See https://cloud.google.com/sensitive-data-protection/docs/inspecting-text#inspecting_a_table to learn more." @@ -6540,6 +6577,10 @@ "description": "Precise location of the finding within a document, record, image, or metadata container.", "id": "GooglePrivacyDlpV2ContentLocation", "properties": { +"batchContentLocation": { +"$ref": "GooglePrivacyDlpV2BatchContentLocation", +"description": "Location within a batch of content." +}, "containerName": { "description": "Name of the container where the finding is located. The top level name is the source file name or table name. Names of some common storage containers are formatted as follows: * BigQuery tables: `{project_id}:{dataset_id}.{table_id}` * Cloud Storage files: `gs://{bucket}/{path}` * Datastore namespace: {namespace} Nested names could be absent if the embedded object has no string identifier (for example, an image contained within a document).", "type": "string" @@ -6553,6 +6594,10 @@ "description": "Finding container version, if available (\"generation\" for Cloud Storage).", "type": "string" }, +"conversationLocation": { +"$ref": "GooglePrivacyDlpV2ConversationLocation", +"description": "Location within a conversation." +}, "documentLocation": { "$ref": "GooglePrivacyDlpV2DocumentLocation", "description": "Location data for document files." @@ -6586,6 +6631,65 @@ }, "type": "object" }, +"GooglePrivacyDlpV2Conversation": { +"description": "Complete conversation or slice of a conversation. It is assumed that all included messages are contiguous and ordered in chronological order.", +"id": "GooglePrivacyDlpV2Conversation", +"properties": { +"messages": { +"description": "Messages exchanged within this conversation. The maximum number of messages allowed is 50k. The order of the messages is assumed to be chronological and will be used to index findings in the response.", +"items": { +"$ref": "GooglePrivacyDlpV2ConversationMessage" +}, +"type": "array" +} +}, +"type": "object" +}, +"GooglePrivacyDlpV2ConversationLocation": { +"description": "Location within a conversation.", +"id": "GooglePrivacyDlpV2ConversationLocation", +"properties": { +"allMessages": { +"$ref": "GooglePrivacyDlpV2AllMessages", +"description": "If set, indicates that the finding applies to all messages in the conversation." +}, +"messageIndex": { +"description": "Matches an index of a message in the conversation provided in the request.", +"format": "int32", +"type": "integer" +} +}, +"type": "object" +}, +"GooglePrivacyDlpV2ConversationMessage": { +"description": "Single message in a conversation.", +"id": "GooglePrivacyDlpV2ConversationMessage", +"properties": { +"content": { +"description": "The contents of this message.", +"type": "string" +}, +"messageType": { +"description": "The type of message.", +"enum": [ +"MESSAGE_TYPE_UNSPECIFIED", +"CONTENT", +"CONTEXT" +], +"enumDescriptions": [ +"Unused.", +"Message contains content to be inspected.", +"Message contains context only and will not have findings reported from it during inspection or redacted from it during de-identification." +], +"type": "string" +}, +"participantId": { +"description": "Optional. The identifier of the participant. For example 'test-user' or 'gemini'. The participant ID can contain lowercase letters, numbers, and hyphens; that is, it must match the regular expression: `^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$`. The maximum length is 63 characters.", +"type": "string" +} +}, +"type": "object" +}, "GooglePrivacyDlpV2CreateConnectionRequest": { "description": "Request message for CreateConnection.", "id": "GooglePrivacyDlpV2CreateConnectionRequest", @@ -9989,7 +10093,7 @@ "id": "GooglePrivacyDlpV2InspectTemplate", "properties": { "allowLimitedAvailabilityInfoTypes": { -"description": "Optional. Enables the use of limited-availability built-in infoTypes in inspect_config. These infoTypes are supported only in specific regions and can cause scanning errors if used elsewhere. For more information, see https://cloud.google.com/sensitive-data-protection/docs/locations#location-specific_limitations to learn more about location-specific limitations.", +"description": "Optional. Enables the use of [limited-availability built-in infoTypes](https://docs.cloud.google.com/sensitive-data-protection/docs/infotypes-reference#limited-availability-infotypes) in inspect_config. These infoTypes are supported only in specific regions and can cause scanning errors if used elsewhere.", "type": "boolean" }, "createTime": { @@ -12275,6 +12379,20 @@ }, "type": "object" }, +"GooglePrivacyDlpV2StringValueBatch": { +"description": "Represents a batch of string values to inspect or redact.", +"id": "GooglePrivacyDlpV2StringValueBatch", +"properties": { +"values": { +"description": "Optional. Represents string data to inspect or redact.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, "GooglePrivacyDlpV2SummaryResult": { "description": "A collection that informs the user the number of times a particular `TransformationResultCode` and error details occurred.", "id": "GooglePrivacyDlpV2SummaryResult", diff --git a/googleapiclient/discovery_cache/documents/firebaseappdistribution.v1.json b/googleapiclient/discovery_cache/documents/firebaseappdistribution.v1.json index b5d7a00414..5000770430 100644 --- a/googleapiclient/discovery_cache/documents/firebaseappdistribution.v1.json +++ b/googleapiclient/discovery_cache/documents/firebaseappdistribution.v1.json @@ -946,7 +946,7 @@ } } }, -"revision": "20260511", +"revision": "20260518", "rootUrl": "https://firebaseappdistribution.googleapis.com/", "schemas": { "GdataBlobstore2Info": { @@ -1418,7 +1418,8 @@ "AAB_STATE_UNAVAILABLE", "PLAY_IAS_TERMS_NOT_ACCEPTED", "ADHOC_SHARING_KEY_NOT_GENERATED", -"ADHOC_SHARING_KEY_NOT_REGISTERED" +"ADHOC_SHARING_KEY_NOT_REGISTERED", +"PLAY_ANDROID_DEVELOPER_CONSOLE_ACCOUNT_NOT_FOUND" ], "enumDescriptions": [ "AAB integration state unspecified.", @@ -1429,7 +1430,8 @@ "Play App status is unavailable.", "Play in-app sharing terms not accepted.", "The ad-hoc sharing key has not been generated for this app.", -"The ad-hoc sharing key is not yet registered in ADI for this app." +"The ad-hoc sharing key is not yet registered in Android Developer Verification for this app.", +"The linked Play developer account was not found or is not fully set up in Android Developer Console." ], "type": "string" }, diff --git a/googleapiclient/discovery_cache/documents/firebaseappdistribution.v1alpha.json b/googleapiclient/discovery_cache/documents/firebaseappdistribution.v1alpha.json index b9ed0d1892..44714abaad 100644 --- a/googleapiclient/discovery_cache/documents/firebaseappdistribution.v1alpha.json +++ b/googleapiclient/discovery_cache/documents/firebaseappdistribution.v1alpha.json @@ -868,7 +868,7 @@ } } }, -"revision": "20260504", +"revision": "20260518", "rootUrl": "https://firebaseappdistribution.googleapis.com/", "schemas": { "AndroidxCrawlerOutputPoint": { @@ -1711,7 +1711,8 @@ "AAB_NO_APP_WITH_GIVEN_PACKAGE_NAME_IN_ACCOUNT", "AAB_UPLOAD_ERROR", "APP_NOT_FOUND", -"AAB_ADHOC_SHARING_KEY_NOT_REGISTERED" +"AAB_ADHOC_SHARING_KEY_NOT_REGISTERED", +"AAB_ANDROID_DEVELOPER_CONSOLE_ACCOUNT_NOT_FOUND" ], "enumDescriptions": [ "", @@ -1737,7 +1738,8 @@ "", "", "Happens if the Firebase app no longer exists by the time of extraction", -"" +"", +"A corresponding Android Developer Console account for this app's Play Console account was not found." ], "type": "string" }, diff --git a/googleapiclient/discovery_cache/documents/firebaseapphosting.v1.json b/googleapiclient/discovery_cache/documents/firebaseapphosting.v1.json index 1f4d879bc0..0ef54d7e93 100644 --- a/googleapiclient/discovery_cache/documents/firebaseapphosting.v1.json +++ b/googleapiclient/discovery_cache/documents/firebaseapphosting.v1.json @@ -1106,7 +1106,7 @@ } } }, -"revision": "20260506", +"revision": "20260514", "rootUrl": "https://firebaseapphosting.googleapis.com/", "schemas": { "ArchiveSource": { @@ -2552,14 +2552,14 @@ "type": "string" }, "ignoredPaths": { -"description": "Optional. A list of file paths patterns to exclude from triggering a rollout. Patterns in this list take precedence over required_paths. **Note**: All paths must be in the ignored_paths in order for the rollout to be skipped. Limited to 100 paths. Example: ignored_paths: { pattern: \"foo/bar/excluded/*\u201d type: GLOB }", +"description": "Optional. A list of file paths patterns to exclude from triggering a rollout. Patterns in this list take precedence over required_paths. **Note**: All paths must be in the ignored_paths in order for the rollout to be skipped. Limited to 100 paths. Example: ``` ignored_paths: { pattern: \"foo/bar/excluded/*\", type: \"GLOB\" } ```", "items": { "$ref": "Path" }, "type": "array" }, "requiredPaths": { -"description": "Optional. A list of file paths patterns that trigger a build and rollout if at least one of the changed files in the commit are present in this list. This field is optional; the rollout policy will default to triggering on all paths if both ignored_paths and required_paths are not populated. Limited to 100 paths. Example: \u201crequired_paths: { pattern: \"foo/bar/*\u201d type: GLOB }", +"description": "Optional. A list of file paths patterns that trigger a build and rollout if at least one of the changed files in the commit are present in this list. This field is optional; the rollout policy will default to triggering on all paths if both ignored_paths and required_paths are not populated. Limited to 100 paths. Example: ``` required_paths: { pattern: \"foo/bar/*\", type: \"GLOB\" } ```", "items": { "$ref": "Path" }, diff --git a/googleapiclient/discovery_cache/documents/firebaseapphosting.v1beta.json b/googleapiclient/discovery_cache/documents/firebaseapphosting.v1beta.json index 448d715e69..889cc4efbe 100644 --- a/googleapiclient/discovery_cache/documents/firebaseapphosting.v1beta.json +++ b/googleapiclient/discovery_cache/documents/firebaseapphosting.v1beta.json @@ -1138,7 +1138,7 @@ } } }, -"revision": "20260506", +"revision": "20260514", "rootUrl": "https://firebaseapphosting.googleapis.com/", "schemas": { "ArchiveSource": { @@ -1184,6 +1184,10 @@ "description": "Optional. The [ID of a Web App](https://firebase.google.com/docs/reference/firebase-management/rest/v1beta1/projects.webApps#WebApp.FIELDS.app_id) associated with the backend.", "type": "string" }, +"automaticBaseImageUpdatesDisabled": { +"description": "Optional. automatic_base_image_updates_disabled acts as a way for users to opt out of ABIU.", +"type": "boolean" +}, "codebase": { "$ref": "Codebase", "description": "Optional. If specified, the connection to an external source repository to watch for event-driven updates to the backend." @@ -1253,6 +1257,10 @@ "description": "Optional. A field that, if true, indicates that incoming request logs are disabled for this backend. Incoming request logs are enabled by default.", "type": "boolean" }, +"runtime": { +"$ref": "BackendRuntime", +"description": "Optional. The runtime that the backend will be built on. A default base_image will be chosen for a given runtime." +}, "serviceAccount": { "description": "Required. The name of the service account used for Cloud Build and Cloud Run. Should have the role roles/firebaseapphosting.computeRunner or equivalent permissions.", "type": "string" @@ -1290,6 +1298,17 @@ }, "type": "object" }, +"BackendRuntime": { +"description": "Runtime is a string that represents the runtime that is used to build the backend. Users can specify one of the following runtimes: nodejs20, nodejs22, nodejs24, nodejs. Runtime \"nodejs\" means that nodejs version will be determined at build time. If not specified or specified with a value that is not in the list above, the default runtime `nodejs` will be used and Automatic Base Image Updates will be disabled.", +"id": "BackendRuntime", +"properties": { +"value": { +"description": "Optional. The value of the runtime.", +"type": "string" +} +}, +"type": "object" +}, "Build": { "description": "A single build for a backend, at a specific point codebase reference tag and point in time. Encapsulates several resources, including an Artifact Registry container image, a Cloud Build invocation that built the image, and the Cloud Run revision that uses that image.", "id": "Build", @@ -2627,14 +2646,14 @@ "type": "string" }, "ignoredPaths": { -"description": "Optional. A list of file paths patterns to exclude from triggering a rollout. Patterns in this list take precedence over required_paths. **Note**: All paths must be in the ignored_paths in order for the rollout to be skipped. Limited to 100 paths. Example: ignored_paths: { pattern: \"foo/bar/excluded/*\u201d type: GLOB }", +"description": "Optional. A list of file paths patterns to exclude from triggering a rollout. Patterns in this list take precedence over required_paths. **Note**: All paths must be in the ignored_paths in order for the rollout to be skipped. Limited to 100 paths. Example: ``` ignored_paths: { pattern: \"foo/bar/excluded/*\", type: \"GLOB\" } ```", "items": { "$ref": "Path" }, "type": "array" }, "requiredPaths": { -"description": "Optional. A list of file paths patterns that trigger a build and rollout if at least one of the changed files in the commit are present in this list. This field is optional; the rollout policy will default to triggering on all paths if both ignored_paths and required_paths are not populated. Limited to 100 paths. Example: \u201crequired_paths: { pattern: \"foo/bar/*\u201d type: GLOB }", +"description": "Optional. A list of file paths patterns that trigger a build and rollout if at least one of the changed files in the commit are present in this list. This field is optional; the rollout policy will default to triggering on all paths if both ignored_paths and required_paths are not populated. Limited to 100 paths. Example: ``` required_paths: { pattern: \"foo/bar/*\", type: \"GLOB\" } ```", "items": { "$ref": "Path" }, diff --git a/googleapiclient/discovery_cache/documents/firebaseml.v2beta.json b/googleapiclient/discovery_cache/documents/firebaseml.v2beta.json index 1211da42c8..d8b5bbceb7 100644 --- a/googleapiclient/discovery_cache/documents/firebaseml.v2beta.json +++ b/googleapiclient/discovery_cache/documents/firebaseml.v2beta.json @@ -206,7 +206,7 @@ } } }, -"revision": "20260513", +"revision": "20260524", "rootUrl": "https://firebaseml.googleapis.com/", "schemas": { "Date": { @@ -2828,6 +2828,10 @@ false "$ref": "GoogleCloudAiplatformV1beta1EnterpriseWebSearch", "description": "Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance." }, +"exaAiSearch": { +"$ref": "GoogleCloudAiplatformV1beta1ToolExaAiSearch", +"description": "Optional. Uses Exa.ai to search for information to answer user queries. The search results will be grounded on Exa.ai and presented to the model for response generation" +}, "functionDeclarations": { "description": "Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided.", "items": { @@ -2873,23 +2877,15 @@ false "description": "Tool to support computer use.", "id": "GoogleCloudAiplatformV1beta1ToolComputerUse", "properties": { -"enablePromptInjectionDetection": { -"description": "Optional. Enables the prompt injection detection check on computer-use request.", -"type": "boolean" -}, "environment": { "description": "Required. The environment being operated.", "enum": [ "ENVIRONMENT_UNSPECIFIED", -"ENVIRONMENT_BROWSER", -"ENVIRONMENT_MOBILE", -"ENVIRONMENT_DESKTOP" +"ENVIRONMENT_BROWSER" ], "enumDescriptions": [ "Defaults to browser.", -"Operates in a web browser.", -"Operates in a mobile environment.", -"Operates in a desktop environment." +"Operates in a web browser." ], "type": "string" }, @@ -2918,6 +2914,25 @@ false }, "type": "object" }, +"GoogleCloudAiplatformV1beta1ToolExaAiSearch": { +"description": "ExaAiSearch tool type. A tool that uses the Exa.ai search engine for grounding.", +"id": "GoogleCloudAiplatformV1beta1ToolExaAiSearch", +"properties": { +"apiKey": { +"description": "Required. The API key for ExaAiSearch.", +"type": "string" +}, +"customConfigs": { +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" +}, +"description": "Optional. This field can be used to pass any parameter from the Exa.ai Search API.", +"type": "object" +} +}, +"type": "object" +}, "GoogleCloudAiplatformV1beta1ToolGoogleSearch": { "description": "GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google.", "id": "GoogleCloudAiplatformV1beta1ToolGoogleSearch", diff --git a/googleapiclient/discovery_cache/documents/gkehub.v1alpha.json b/googleapiclient/discovery_cache/documents/gkehub.v1alpha.json index 45de6ec411..e05dccfa0a 100644 --- a/googleapiclient/discovery_cache/documents/gkehub.v1alpha.json +++ b/googleapiclient/discovery_cache/documents/gkehub.v1alpha.json @@ -2598,7 +2598,7 @@ } } }, -"revision": "20260511", +"revision": "20260525", "rootUrl": "https://gkehub.googleapis.com/", "schemas": { "AppDevExperienceFeatureSpec": { @@ -7224,13 +7224,23 @@ "STATE_REASON_TYPE_UNSPECIFIED", "PAUSED_BY_USER", "PAUSED_BY_SYSTEM_CONFIG", -"PAUSED_WAITING_FOR_NEXT_STAGE" +"PAUSED_WAITING_FOR_NEXT_STAGE", +"CANCELLED_BY_USER", +"CANCELLED_PAUSED_TOO_LONG", +"CANCELLED_SUPERSEDED", +"CANCELLED_INCOMPATIBLE_ROLLOUT_SEQUENCE", +"CANCELLED_SUPERSEDED_BY_USER_ROLLOUT" ], "enumDescriptions": [ "Unspecified state reason.", "Paused by the user.", -"Paused by the RSv2 Orchestrator due to system config(ex. GKE freeze).", -"Paused waiting for the next stage to start." +"Paused by system config (ex. GKE freeze).", +"Paused waiting for the next stage to start.", +"Cancelled by the user.", +"Cancelled by the system because it was paused too long.", +"Cancelled by the system because the version is too old.", +"Cancelled by the system because the rollout sequence is incompatible, for example it has different number of stages, fleet projects or label selectors than the rollout.", +"Cancelled because of a new user-triggered rollout." ], "readOnly": true, "type": "string" @@ -7421,13 +7431,22 @@ "FORCED_SOAKING", "PAUSED" ], +"enumDeprecated": [ +false, +false, +false, +false, +false, +true, +false +], "enumDescriptions": [ "Default value.", -"The stage is pending.", -"The stage is running.", -"The stage is soaking.", +"The stage is waiting for previous stages to complete.", +"The stage targets are being upgraded.", +"The stage is waiting for a predetermined time before next stage.", "The stage is completed.", -"The stage is force soaking.", +"Deprecated: use SOAKING instead.", "The stage is paused." ], "readOnly": true, diff --git a/googleapiclient/discovery_cache/documents/gkehub.v1beta.json b/googleapiclient/discovery_cache/documents/gkehub.v1beta.json index 7461bc19b7..4b1291ddce 100644 --- a/googleapiclient/discovery_cache/documents/gkehub.v1beta.json +++ b/googleapiclient/discovery_cache/documents/gkehub.v1beta.json @@ -2454,7 +2454,7 @@ } } }, -"revision": "20260511", +"revision": "20260525", "rootUrl": "https://gkehub.googleapis.com/", "schemas": { "AppDevExperienceFeatureSpec": { @@ -6833,13 +6833,23 @@ "STATE_REASON_TYPE_UNSPECIFIED", "PAUSED_BY_USER", "PAUSED_BY_SYSTEM_CONFIG", -"PAUSED_WAITING_FOR_NEXT_STAGE" +"PAUSED_WAITING_FOR_NEXT_STAGE", +"CANCELLED_BY_USER", +"CANCELLED_PAUSED_TOO_LONG", +"CANCELLED_SUPERSEDED", +"CANCELLED_INCOMPATIBLE_ROLLOUT_SEQUENCE", +"CANCELLED_SUPERSEDED_BY_USER_ROLLOUT" ], "enumDescriptions": [ "Unspecified state reason.", "Paused by the user.", -"Paused by the RSv2 Orchestrator due to system config(ex. GKE freeze).", -"Paused waiting for the next stage to start." +"Paused by system config (ex. GKE freeze).", +"Paused waiting for the next stage to start.", +"Cancelled by the user.", +"Cancelled by the system because it was paused too long.", +"Cancelled by the system because the version is too old.", +"Cancelled by the system because the rollout sequence is incompatible, for example it has different number of stages, fleet projects or label selectors than the rollout.", +"Cancelled because of a new user-triggered rollout." ], "readOnly": true, "type": "string" @@ -7030,13 +7040,22 @@ "FORCED_SOAKING", "PAUSED" ], +"enumDeprecated": [ +false, +false, +false, +false, +false, +true, +false +], "enumDescriptions": [ "Default value.", -"The stage is pending.", -"The stage is running.", -"The stage is soaking.", +"The stage is waiting for previous stages to complete.", +"The stage targets are being upgraded.", +"The stage is waiting for a predetermined time before next stage.", "The stage is completed.", -"The stage is force soaking.", +"Deprecated: use SOAKING instead.", "The stage is paused." ], "readOnly": true, diff --git a/googleapiclient/discovery_cache/documents/gmail.v1.json b/googleapiclient/discovery_cache/documents/gmail.v1.json index fbae6aa2b3..b41f86cb74 100644 --- a/googleapiclient/discovery_cache/documents/gmail.v1.json +++ b/googleapiclient/discovery_cache/documents/gmail.v1.json @@ -3077,7 +3077,7 @@ } } }, -"revision": "20260511", +"revision": "20260525", "rootUrl": "https://gmail.googleapis.com/", "schemas": { "AutoForwarding": { @@ -3743,11 +3743,11 @@ "id": "LabelColor", "properties": { "backgroundColor": { -"description": "The background color represented as hex string #RRGGBB (ex #000000). This field is required in order to set the color of a label. Only the following predefined set of color values are allowed: \\#000000, #434343, #666666, #999999, #cccccc, #efefef, #f3f3f3, #ffffff, \\#fb4c2f, #ffad47, #fad165, #16a766, #43d692, #4a86e8, #a479e2, #f691b3, \\#f6c5be, #ffe6c7, #fef1d1, #b9e4d0, #c6f3de, #c9daf8, #e4d7f5, #fcdee8, \\#efa093, #ffd6a2, #fce8b3, #89d3b2, #a0eac9, #a4c2f4, #d0bcf1, #fbc8d9, \\#e66550, #ffbc6b, #fcda83, #44b984, #68dfa9, #6d9eeb, #b694e8, #f7a7c0, \\#cc3a21, #eaa041, #f2c960, #149e60, #3dc789, #3c78d8, #8e63ce, #e07798, \\#ac2b16, #cf8933, #d5ae49, #0b804b, #2a9c68, #285bac, #653e9b, #b65775, \\#822111, #a46a21, #aa8831, #076239, #1a764d, #1c4587, #41236d, #83334c, \\#464646, #e7e7e7, #0d3472, #b6cff5, #0d3b44, #98d7e4, #3d188e, #e3d7ff, \\#711a36, #fbd3e0, #8a1c0a, #f2b2a8, #7a2e0b, #ffc8af, #7a4706, #ffdeb5, \\#594c05, #fbe983, #684e07, #fdedc1, #0b4f30, #b3efd3, #04502e, #a2dcc1, \\#c2c2c2, #4986e7, #2da2bb, #b99aff, #994a64, #f691b2, #ff7537, #ffad46, \\#662e37, #ebdbde, #cca6ac, #094228, #42d692, #16a765", +"description": "The background color represented as hex string #RRGGBB (ex #000000). This field is required in order to set the color of a label. Only the following predefined set of color values are allowed: \\#000000, #434343, #666666, #999999, #cccccc, #efefef, #f3f3f3, #ffffff, \\#fb4c2f, #ffad47, #fad165, #16a766, #43d692, #4a86e8, #a479e2, #f691b3, \\#f6c5be, #ffe6c7, #fef1d1, #b9e4d0, #c6f3de, #c9daf8, #e4d7f5, #fcdee8, \\#efa093, #ffd6a2, #fce8b3, #89d3b2, #a0eac9, #a4c2f4, #d0bcf1, #fbc8d9, \\#e66550, #ffbc6b, #fcda83, #44b984, #68dfa9, #6d9eeb, #b694e8, #f7a7c0, \\#cc3a21, #eaa041, #f2c960, #149e60, #3dc789, #3c78d8, #8e63ce, #e07798, \\#ac2b16, #cf8933, #d5ae49, #0b804b, #2a9c68, #285bac, #653e9b, #b65775, \\#822111, #a46a21, #aa8831, #076239, #1a764d, #1c4587, #41236d, #83334c, \\#464646, #e7e7e7, #0d3472, #b6cff5, #0d3b44, #98d7e4, #3d188e, #e3d7ff, \\#711a36, #fbd3e0, #8a1c0a, #f2b2a8, #7a2e0b, #ffc8af, #7a4706, #ffdeb5, \\#594c05, #fbe983, #684e07, #fdedc1, #0b4f30, #b3efd3, #04502e, #a2dcc1, \\#c2c2c2, #4986e7, #2da2bb, #b99aff, #994a64, #f691b2, #ff7537, #ffad46, \\#662e37, #ebdbde, #cca6ac, #094228, #42d692, #16a765, #757575, #1e53b8, \\#007286, #7858c3, #c2185b, #d93025, #54240e, #633e04, #521d28, #202124, \\#083018", "type": "string" }, "textColor": { -"description": "The text color of the label, represented as hex string. This field is required in order to set the color of a label. Only the following predefined set of color values are allowed: \\#000000, #434343, #666666, #999999, #cccccc, #efefef, #f3f3f3, #ffffff, \\#fb4c2f, #ffad47, #fad165, #16a766, #43d692, #4a86e8, #a479e2, #f691b3, \\#f6c5be, #ffe6c7, #fef1d1, #b9e4d0, #c6f3de, #c9daf8, #e4d7f5, #fcdee8, \\#efa093, #ffd6a2, #fce8b3, #89d3b2, #a0eac9, #a4c2f4, #d0bcf1, #fbc8d9, \\#e66550, #ffbc6b, #fcda83, #44b984, #68dfa9, #6d9eeb, #b694e8, #f7a7c0, \\#cc3a21, #eaa041, #f2c960, #149e60, #3dc789, #3c78d8, #8e63ce, #e07798, \\#ac2b16, #cf8933, #d5ae49, #0b804b, #2a9c68, #285bac, #653e9b, #b65775, \\#822111, #a46a21, #aa8831, #076239, #1a764d, #1c4587, #41236d, #83334c, \\#464646, #e7e7e7, #0d3472, #b6cff5, #0d3b44, #98d7e4, #3d188e, #e3d7ff, \\#711a36, #fbd3e0, #8a1c0a, #f2b2a8, #7a2e0b, #ffc8af, #7a4706, #ffdeb5, \\#594c05, #fbe983, #684e07, #fdedc1, #0b4f30, #b3efd3, #04502e, #a2dcc1, \\#c2c2c2, #4986e7, #2da2bb, #b99aff, #994a64, #f691b2, #ff7537, #ffad46, \\#662e37, #ebdbde, #cca6ac, #094228, #42d692, #16a765", +"description": "The text color of the label, represented as hex string. This field is required in order to set the color of a label. Only the following predefined set of color values are allowed: \\#000000, #434343, #666666, #999999, #cccccc, #efefef, #f3f3f3, #ffffff, \\#fb4c2f, #ffad47, #fad165, #16a766, #43d692, #4a86e8, #a479e2, #f691b3, \\#f6c5be, #ffe6c7, #fef1d1, #b9e4d0, #c6f3de, #c9daf8, #e4d7f5, #fcdee8, \\#efa093, #ffd6a2, #fce8b3, #89d3b2, #a0eac9, #a4c2f4, #d0bcf1, #fbc8d9, \\#e66550, #ffbc6b, #fcda83, #44b984, #68dfa9, #6d9eeb, #b694e8, #f7a7c0, \\#cc3a21, #eaa041, #f2c960, #149e60, #3dc789, #3c78d8, #8e63ce, #e07798, \\#ac2b16, #cf8933, #d5ae49, #0b804b, #2a9c68, #285bac, #653e9b, #b65775, \\#822111, #a46a21, #aa8831, #076239, #1a764d, #1c4587, #41236d, #83334c, \\#464646, #e7e7e7, #0d3472, #b6cff5, #0d3b44, #98d7e4, #3d188e, #e3d7ff, \\#711a36, #fbd3e0, #8a1c0a, #f2b2a8, #7a2e0b, #ffc8af, #7a4706, #ffdeb5, \\#594c05, #fbe983, #684e07, #fdedc1, #0b4f30, #b3efd3, #04502e, #a2dcc1, \\#c2c2c2, #4986e7, #2da2bb, #b99aff, #994a64, #f691b2, #ff7537, #ffad46, \\#662e37, #ebdbde, #cca6ac, #094228, #42d692, #16a765, #757575, #1e53b8, \\#007286, #7858c3, #c2185b, #d93025, #54240e, #633e04, #521d28, #202124, \\#083018", "type": "string" } }, @@ -4007,13 +4007,11 @@ "raw": { "annotations": { "required": [ -"gmail.users.drafts.create", -"gmail.users.drafts.update", "gmail.users.messages.insert", "gmail.users.messages.send" ] }, -"description": "The entire email message in an RFC 2822 formatted and base64url encoded string. Returned in `messages.get` and `drafts.get` responses when the `format=RAW` parameter is supplied.", +"description": "The entire email message in an RFC 2822 formatted and base64url encoded string. Returned in `messages.get` and `drafts.get` responses when the `format=RAW` parameter is supplied. @required gmail.users.drafts.create gmail.users.drafts.update", "format": "byte", "type": "string" }, diff --git a/googleapiclient/discovery_cache/documents/health.v4.json b/googleapiclient/discovery_cache/documents/health.v4.json index e9c3e13ead..473c674b28 100644 --- a/googleapiclient/discovery_cache/documents/health.v4.json +++ b/googleapiclient/discovery_cache/documents/health.v4.json @@ -8,9 +8,15 @@ "https://www.googleapis.com/auth/googlehealth.activity_and_fitness.readonly": { "description": "See your Google Health activity and fitness data" }, +"https://www.googleapis.com/auth/googlehealth.ecg.readonly": { +"description": "See your Google Health ECG data" +}, "https://www.googleapis.com/auth/googlehealth.health_metrics_and_measurements.readonly": { "description": "See your Google Health health metrics and measurement data" }, +"https://www.googleapis.com/auth/googlehealth.irn.readonly": { +"description": "See your Google Health Irregular Rhythm Notifications data" +}, "https://www.googleapis.com/auth/googlehealth.location.readonly": { "description": "See exercise GPS location data in Google Health" }, @@ -260,6 +266,145 @@ "https://www.googleapis.com/auth/cloud-platform" ] } +}, +"resources": { +"subscriptions": { +"methods": { +"create": { +"description": "Creates a subscription for a specific user to a specific subscriber. This method requires the subscriber to have a `SubscriptionCreatePolicy` set to `MANUAL` for the given data types.", +"flatPath": "v4/projects/{projectsId}/subscribers/{subscribersId}/subscriptions", +"httpMethod": "POST", +"id": "health.projects.subscribers.subscriptions.create", +"parameterOrder": [ +"parent" +], +"parameters": { +"parent": { +"description": "Required. The parent subscriber. Format: projects/{project}/subscribers/{subscriber} The {subscriber} ID is user-settable (4-36 characters, matching /[a-z]([a-z0-9-]{2,34}[a-z0-9])/) if provided during creation, or system-generated otherwise.", +"location": "path", +"pattern": "^projects/[^/]+/subscribers/[^/]+$", +"required": true, +"type": "string" +}, +"subscriptionId": { +"description": "Optional. The {subscription_id} is user-settable (4-36 chars, matching /[a-z]([a-z0-9-]{2,34}[a-z0-9])/) or system-generated otherwise. If provided, the ID must be unique within the parent subscriber.", +"location": "query", +"type": "string" +} +}, +"path": "v4/{+parent}/subscriptions", +"request": { +"$ref": "CreateSubscriptionPayload" +}, +"response": { +"$ref": "Subscription" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"delete": { +"description": "Deletes a specific user subscription, stopping notifications for this user to this subscriber.", +"flatPath": "v4/projects/{projectsId}/subscribers/{subscribersId}/subscriptions/{subscriptionsId}", +"httpMethod": "DELETE", +"id": "health.projects.subscribers.subscriptions.delete", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The resource name of the subscription to delete. Format: `projects/{project}/subscribers/{subscriber}/subscriptions/{subscription}` Example: `projects/my-project/subscribers/my-subscriber-123/subscriptions/my-subscription-456` The {subscriber} ID is user-settable (4-36 characters, matching /[a-z]([a-z0-9-]{2,34}[a-z0-9])/) if provided during creation, or system-generated otherwise. The {subscription} ID is user-settable (4-36 characters, matching /[a-z]([a-z0-9-]{2,34}[a-z0-9])/) or system-generated if not provided during creation.", +"location": "path", +"pattern": "^projects/[^/]+/subscribers/[^/]+/subscriptions/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v4/{+name}", +"response": { +"$ref": "Empty" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"list": { +"description": "Lists all active subscriptions for a given subscriber. This can be filtered, for example, by user or data type.", +"flatPath": "v4/projects/{projectsId}/subscribers/{subscribersId}/subscriptions", +"httpMethod": "GET", +"id": "health.projects.subscribers.subscriptions.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"filter": { +"description": "Optional. A filter to apply to the list of subscriptions. The filter syntax is described in https://google.aip.dev/160. The filter can be applied to the following fields: - `user` - `data_type` The `user` identifier (e.g., `user1` in `users/user1`) refers to the public `health_user_id` Example: user = \"users/user1\" Example: user = \"users/user1\" OR user = \"users/user2\" Example: user = \"users/user1\" AND (data_type = \"sleep\" OR data_type = \"weight\")", +"location": "query", +"type": "string" +}, +"pageSize": { +"description": "Optional. The maximum number of subscriptions to return. The service may return fewer than this value. If unspecified, at most 50 subscriptions will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "Optional. A page token, received from a previous `ListSubscriptions` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListSubscriptions` must match the call that provided the page token.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The parent subscriber. Format: projects/{project}/subscribers/{subscriber} The {subscriber} ID is user-settable (4-36 characters, matching /[a-z]([a-z0-9-]{2,34}[a-z0-9])/) if provided during creation, or system-generated otherwise.", +"location": "path", +"pattern": "^projects/[^/]+/subscribers/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v4/{+parent}/subscriptions", +"response": { +"$ref": "ListSubscriptionsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"patch": { +"description": "Updates the data types for an existing user subscription.", +"flatPath": "v4/projects/{projectsId}/subscribers/{subscribersId}/subscriptions/{subscriptionsId}", +"httpMethod": "PATCH", +"id": "health.projects.subscribers.subscriptions.patch", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Identifier. The resource name of the Subscription. Format: `projects/{project}/subscribers/{subscriber}/subscriptions/{subscription}` Example: `projects/my-project/subscribers/my-subscriber-123/subscriptions/my-subscription-456` The {project} ID is mandatory (6-30 characters, matching /a-z{6,30}/) The {subscriber} ID is user-settable (4-36 characters, matching /[a-z]([a-z0-9-]{2,34}[a-z0-9])/) if provided during creation, or system-generated otherwise. The {subscription} ID is user-settable (4-36 chars, matching /[a-z]([a-z0-9-]{2,34}[a-z0-9])/) or system-generated otherwise.", +"location": "path", +"pattern": "^projects/[^/]+/subscribers/[^/]+/subscriptions/[^/]+$", +"required": true, +"type": "string" +}, +"updateMask": { +"description": "Optional. The list of fields to update.", +"format": "google-fieldmask", +"location": "query", +"type": "string" +} +}, +"path": "v4/{+name}", +"request": { +"$ref": "Subscription" +}, +"response": { +"$ref": "Subscription" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +} } } } @@ -289,12 +434,39 @@ }, "scopes": [ "https://www.googleapis.com/auth/googlehealth.activity_and_fitness.readonly", +"https://www.googleapis.com/auth/googlehealth.ecg.readonly", "https://www.googleapis.com/auth/googlehealth.health_metrics_and_measurements.readonly", +"https://www.googleapis.com/auth/googlehealth.irn.readonly", "https://www.googleapis.com/auth/googlehealth.profile.readonly", "https://www.googleapis.com/auth/googlehealth.settings.readonly", "https://www.googleapis.com/auth/googlehealth.sleep.readonly" ] }, +"getIrnProfile": { +"description": "Returns user's IRN Profile details.", +"flatPath": "v4/users/{usersId}/irnProfile", +"httpMethod": "GET", +"id": "health.users.getIrnProfile", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The resource name of the IRN Profile. Format: `users/{user}/irnProfile` Example: `users/1234567890/irnProfile` or `users/me/irnProfile` The {user} ID is a system-generated Google Health API user ID, a string of 1-63 characters consisting of lowercase and uppercase letters, numbers, and hyphens. The literal `me` can also be used to refer to the authenticated user.", +"location": "path", +"pattern": "^users/[^/]+/irnProfile$", +"required": true, +"type": "string" +} +}, +"path": "v4/{+name}", +"response": { +"$ref": "IrnProfile" +}, +"scopes": [ +"https://www.googleapis.com/auth/googlehealth.irn.readonly" +] +}, "getProfile": { "description": "Returns user Profile details.", "flatPath": "v4/users/{usersId}/profile", @@ -565,7 +737,7 @@ ], "parameters": { "filter": { -"description": "Optional. Filter expression following https://google.aip.dev/160. A time range (either physical or civil) can be specified. The supported filter fields are: - Interval start time: - Pattern: `{interval_data_type}.interval.start_time` - Supported comparison operators: `>=`, `<` - Timestamp literal expected in RFC-3339 format - Supported logical operators: `AND` - Example: - `steps.interval.start_time >= \"2023-11-24T00:00:00Z\" AND steps.interval.start_time < \"2023-11-25T00:00:00Z\"` - `distance.interval.start_time >= \"2024-08-14T12:34:56Z\"` - Interval civil start time: - Pattern: `{interval_data_type}.interval.civil_start_time` - Supported comparison operators: `>=`, `<` - Date with optional time literal expected in ISO 8601 `YYYY-MM-DD[THH:mm:ss]` format - Supported logical operators: `AND` - Example: - `steps.interval.civil_start_time >= \"2023-11-24\" AND steps.interval.civil_start_time < \"2023-11-25\"` - `distance.interval.civil_start_time >= \"2024-08-14T12:34:56\"` - Sample observation physical time: - Pattern: `{sample_data_type}.sample_time.physical_time` - Supported comparison operators: `>=`, `<` - Timestamp literal expected in RFC-3339 format - Supported logical operators: `AND` - Example: - `weight.sample_time.physical_time >= \"2023-11-24T00:00:00Z\" AND weight.sample_time.physical_time < \"2023-11-25T00:00:00Z\"` - `weight.sample_time.physical_time >= \"2024-08-14T12:34:56Z\"` - Sample observation civil time: - Pattern: `{sample_data_type}.sample_time.civil_time` - Supported comparison operators: `>=`, `<` - Date with optional time literal expected in ISO 8601 `YYYY-MM-DD[THH:mm:ss]` format - Supported logical operators: `AND` - Example: - `weight.sample_time.civil_time >= \"2023-11-24\" AND weight.sample_time.civil_time < \"2023-11-25\"` - `weight.sample_time.civil_time >= \"2024-08-14T12:34:56\"` - Daily summary date: - Pattern: `{daily_summary_data_type}.date` - Supported comparison operators: `>=`, `<` - Date literal expected in ISO 8601 `YYYY-MM-DD` format - Supported logical operators: `AND` - Example: - `daily_heart_rate_variability.date < \"2024-08-15\"` - Session start time (**ECG specific**): - Pattern: `electrocardiogram.interval.start_time` - Supported comparison operators: `>=` - Timestamp literal expected in RFC-3339 format - Example: - `electrocardiogram.interval.start_time >= \"2024-08-14T12:34:56Z\"` - Note: Only filtering by start time is supported for ECG. Filtering by end time (e.g., `electrocardiogram.interval.end_time`) is not supported. - Session civil start time (**Excluding Sleep**): - Pattern: `{session_data_type}.interval.civil_start_time` - Supported comparison operators: `>=`, `<` - Date with optional time literal expected in ISO 8601 `YYYY-MM-DD[THH:mm:ss]` format - Supported logical operators: `AND` - Example: - `exercise.interval.civil_start_time >= \"2023-11-24\" AND exercise.interval.civil_start_time < \"2023-11-25\"` - `exercise.interval.civil_start_time >= \"2024-08-14T12:34:56\"` - Session end time (**Sleep specific**): - Pattern: `sleep.interval.end_time` - Supported comparison operators: `>=`, `<` - Timestamp literal expected in RFC-3339 format - Supported logical operators: `AND`, `OR` - Example: - `sleep.interval.end_time >= \"2023-11-24T00:00:00Z\" AND sleep.interval.end_time < \"2023-11-25T00:00:00Z\"` - Session civil end time (**Sleep specific**): - Pattern: `sleep.interval.civil_end_time` - Supported comparison operators: `>=`, `<` - Date with optional time literal expected in ISO 8601 `YYYY-MM-DD[THH:mm:ss]` format - Supported logical operators: `AND`, `OR` - Example: - `sleep.interval.civil_end_time >= \"2023-11-24\" AND sleep.interval.civil_end_time < \"2023-11-25\"` Data points in the response will be ordered by the interval start time in descending order.", +"description": "Optional. Filter expression following https://google.aip.dev/160. A time range (either physical or civil) can be specified. The supported filter fields are: - Interval start time: - Pattern: `{interval_data_type}.interval.start_time` - Supported comparison operators: `>=`, `<` - Timestamp literal expected in RFC-3339 format - Supported logical operators: `AND` - Example: - `steps.interval.start_time >= \"2023-11-24T00:00:00Z\" AND steps.interval.start_time < \"2023-11-25T00:00:00Z\"` - `distance.interval.start_time >= \"2024-08-14T12:34:56Z\"` - Interval civil start time: - Pattern: `{interval_data_type}.interval.civil_start_time` - Supported comparison operators: `>=`, `<` - Date with optional time literal expected in ISO 8601 `YYYY-MM-DD[THH:mm:ss]` format - Supported logical operators: `AND` - Example: - `steps.interval.civil_start_time >= \"2023-11-24\" AND steps.interval.civil_start_time < \"2023-11-25\"` - `distance.interval.civil_start_time >= \"2024-08-14T12:34:56\"` - Sample observation physical time: - Pattern: `{sample_data_type}.sample_time.physical_time` - Supported comparison operators: `>=`, `<` - Timestamp literal expected in RFC-3339 format - Supported logical operators: `AND` - Example: - `weight.sample_time.physical_time >= \"2023-11-24T00:00:00Z\" AND weight.sample_time.physical_time < \"2023-11-25T00:00:00Z\"` - `weight.sample_time.physical_time >= \"2024-08-14T12:34:56Z\"` - Sample observation civil time: - Pattern: `{sample_data_type}.sample_time.civil_time` - Supported comparison operators: `>=`, `<` - Date with optional time literal expected in ISO 8601 `YYYY-MM-DD[THH:mm:ss]` format - Supported logical operators: `AND` - Example: - `weight.sample_time.civil_time >= \"2023-11-24\" AND weight.sample_time.civil_time < \"2023-11-25\"` - `weight.sample_time.civil_time >= \"2024-08-14T12:34:56\"` - Daily summary date: - Pattern: `{daily_summary_data_type}.date` - Supported comparison operators: `>=`, `<` - Date literal expected in ISO 8601 `YYYY-MM-DD` format - Supported logical operators: `AND` - Example: - `daily_heart_rate_variability.date < \"2024-08-15\"` - Session civil start time (**Excluding Sleep and ECG**): - Pattern: `{session_data_type}.interval.civil_start_time` - Supported comparison operators: `>=`, `<` - Date with optional time literal expected in ISO 8601 `YYYY-MM-DD[THH:mm:ss]` format - Supported logical operators: `AND` - Example: - `exercise.interval.civil_start_time >= \"2023-11-24\" AND exercise.interval.civil_start_time < \"2023-11-25\"` - `exercise.interval.civil_start_time >= \"2024-08-14T12:34:56\"` - Session start time (**ECG specific**): - Pattern: `electrocardiogram.interval.start_time` - Supported comparison operators: `>=` - Timestamp literal expected in RFC-3339 format - Example: - `electrocardiogram.interval.start_time >= \"2024-08-14T12:34:56Z\"` - Note: Only filtering by start time is supported for ECG. Filtering by end time (e.g., `electrocardiogram.interval.end_time`) is not supported. - Session end time (**Sleep specific**): - Pattern: `sleep.interval.end_time` - Supported comparison operators: `>=`, `<` - Timestamp literal expected in RFC-3339 format - Supported logical operators: `AND`, `OR` - Example: - `sleep.interval.end_time >= \"2023-11-24T00:00:00Z\" AND sleep.interval.end_time < \"2023-11-25T00:00:00Z\"` - Session civil end time (**Sleep specific**): - Pattern: `sleep.interval.civil_end_time` - Supported comparison operators: `>=`, `<` - Date with optional time literal expected in ISO 8601 `YYYY-MM-DD[THH:mm:ss]` format - Supported logical operators: `AND`, `OR` - Example: - `sleep.interval.civil_end_time >= \"2023-11-24\" AND sleep.interval.civil_end_time < \"2023-11-25\"` Data points in the response will be ordered by the interval start time in descending order.", "location": "query", "type": "string" }, @@ -707,13 +879,107 @@ } } } +}, +"pairedDevices": { +"methods": { +"get": { +"description": "Returns user's Device.", +"flatPath": "v4/users/{usersId}/pairedDevices/{pairedDevicesId}", +"httpMethod": "GET", +"id": "health.users.pairedDevices.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The name of the device to retrieve. Format: users/{user}/devices/{device}", +"location": "path", +"pattern": "^users/[^/]+/pairedDevices/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v4/{+name}", +"response": { +"$ref": "PairedDevice" +}, +"scopes": [ +"https://www.googleapis.com/auth/googlehealth.settings.readonly" +] +}, +"list": { +"description": "Returns the user's list of paired 1P trackers and smartwatches.", +"flatPath": "v4/users/{usersId}/pairedDevices", +"httpMethod": "GET", +"id": "health.users.pairedDevices.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"pageSize": { +"description": "Optional. The maximum number of devices to return. The service may return fewer than this value. If unspecified, at most 5 devices will be returned. The maximum value is 100. values above 100 will be coerced to 100.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "Optional. A page token, received from a previous `ListPairedDevices` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListPairedDevices` must match the call that provided the page token.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The parent, which owns this collection of devices. Format: users/{user}", +"location": "path", +"pattern": "^users/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v4/{+parent}/pairedDevices", +"response": { +"$ref": "ListPairedDevicesResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/googlehealth.settings.readonly" +] +} +} } } } }, -"revision": "20260515", +"revision": "20260527", "rootUrl": "https://health.googleapis.com/", "schemas": { +"ActiveEnergyBurned": { +"description": "Energy burned as part of an activity, excluding the basal energy burn.", +"id": "ActiveEnergyBurned", +"properties": { +"interval": { +"$ref": "ObservationTimeInterval", +"description": "Required. Observed interval" +}, +"kcal": { +"description": "Required. Energy burned during an activity, measured in kilocalories.", +"format": "double", +"type": "number" +} +}, +"type": "object" +}, +"ActiveEnergyBurnedRollupValue": { +"description": "Represents the result of the rollup of active energy burned.", +"id": "ActiveEnergyBurnedRollupValue", +"properties": { +"kcalSum": { +"description": "Output only. Sum of the active energy burned in kilocalories.", +"format": "double", +"readOnly": true, +"type": "number" +} +}, +"type": "object" +}, "ActiveMinutes": { "description": "Record of active minutes in a given time interval.", "id": "ActiveMinutes", @@ -929,6 +1195,54 @@ }, "type": "object" }, +"AlertWindow": { +"description": "An analysis window evaluated for AFib. Note: The current version of the algorithm will only produce alerts if all windows are positive. So anything returned from the API will always have the positive bit set to true. Internally, windows can be negative, however. We never save \"inconclusive\" windows (they aren't produced by the algorithm).", +"id": "AlertWindow", +"properties": { +"civilEndTime": { +"$ref": "CivilDateTime", +"description": "Output only. Observed interval end time in civil time in the timezone the subject is in at the end of the observed interval", +"readOnly": true +}, +"civilStartTime": { +"$ref": "CivilDateTime", +"description": "Output only. Observed interval start time in civil time in the timezone the subject is in at the start of the observed interval", +"readOnly": true +}, +"endTime": { +"description": "Required. The end time of the analysis window.", +"format": "google-datetime", +"type": "string" +}, +"endUtcOffset": { +"description": "Required. The UTC offset of the user's timezone when the analysis window ended.", +"format": "google-duration", +"type": "string" +}, +"heartBeats": { +"description": "Optional. All heart beats in the interval contained in this analysis window.", +"items": { +"$ref": "HeartBeat" +}, +"type": "array" +}, +"positive": { +"description": "Optional. Flag indicating whether the window was positive for AFib or not. A `true` value indicates that AFib was detected in this window. A `false` value means AFib was not detected, but does not guarantee the absence of AFib.", +"type": "boolean" +}, +"startTime": { +"description": "Required. Observed interval. The start time of the analysis window.", +"format": "google-datetime", +"type": "string" +}, +"startUtcOffset": { +"description": "Required. The UTC offset of the user's timezone when the analysis window started.", +"format": "google-duration", +"type": "string" +} +}, +"type": "object" +}, "Altitude": { "description": "Captures the altitude gain (i.e. deltas), and not level above sea, for a user in millimeters.", "id": "Altitude", @@ -1009,6 +1323,116 @@ }, "type": "object" }, +"BloodGlucose": { +"description": "Represents a blood glucose level measurement. LINT: LEGACY_NAMES", +"id": "BloodGlucose", +"properties": { +"bloodGlucoseMilligramsPerDeciliter": { +"description": "Required. Blood glucose level concentration in mg/dL.", +"format": "double", +"type": "number" +}, +"mealType": { +"description": "Optional. Meal type of the measurement.", +"enum": [ +"MEAL_TYPE_UNSPECIFIED", +"BREAKFAST", +"LUNCH", +"DINNER", +"SNACK" +], +"enumDescriptions": [ +"Unspecified meal type.", +"Breakfast.", +"Lunch.", +"Dinner.", +"Snack." +], +"type": "string" +}, +"measurementSource": { +"description": "Optional. Source of the measurement.", +"enum": [ +"MEASUREMENT_SOURCE_UNSPECIFIED", +"SELF_MONITORING_BLOOD_GLUCOSE", +"CONTINUOUS_GLUCOSE_MONITORING", +"LAB_TEST" +], +"enumDescriptions": [ +"Unspecified measurement source.", +"Self-monitoring of blood glucose (Blood glucose meter)", +"Continuous glucose monitoring device", +"Laboratory test" +], +"type": "string" +}, +"measurementTiming": { +"description": "Optional. Timing of the measurement.", +"enum": [ +"MEASUREMENT_TIMING_UNSPECIFIED", +"AFTER_MEAL", +"BEFORE_MEAL", +"FASTING", +"GENERAL", +"BEFORE_BED", +"OVER_NIGHT" +], +"enumDescriptions": [ +"Unspecified measurement timing.", +"Measurement taken after meal.", +"Measurement taken before meal.", +"Measurement taken while fasting.", +"General measurement (not associated with a meal or time of day).", +"Measurement taken before bed.", +"Measurement taken over night." +], +"type": "string" +}, +"notes": { +"description": "Optional. Standard free-form notes captured at manual logging.", +"type": "string" +}, +"sampleTime": { +"$ref": "ObservationSampleTime", +"description": "Required. The time at which blood glucose was measured." +}, +"specimen": { +"description": "Optional. Type of body fluid used to measure the blood glucose.", +"enum": [ +"SPECIMEN_UNSPECIFIED", +"CAPILLARY_BLOOD", +"INTERSTITIAL_FLUID", +"PLASMA", +"SERUM", +"TEARS", +"WHOLE_BLOOD" +], +"enumDescriptions": [ +"Unspecified specimen.", +"Capillary blood.", +"Interstitial fluid.", +"Plasma.", +"Serum.", +"Tears.", +"Whole blood." +], +"type": "string" +} +}, +"type": "object" +}, +"BloodGlucoseRollupValue": { +"description": "Represents the result of the rollup of the blood glucose data type. LINT: LEGACY_NAMES", +"id": "BloodGlucoseRollupValue", +"properties": { +"bloodGlucoseMilligramsPerDeciliterAvg": { +"description": "Average blood glucose level in mg/dL.", +"format": "double", +"type": "number" +} +}, +"type": "object" +}, "BodyFat": { "description": "Body fat measurement.", "id": "BodyFat", @@ -1111,6 +1535,92 @@ }, "type": "object" }, +"CoreBodyTemperature": { +"description": "Core body temperature measurement, distinct from peripheral body temperature, reflects the temperature of the body's internal organs.", +"id": "CoreBodyTemperature", +"properties": { +"id": { +"description": "Optional. The unique identifier of the core body temperature measurement.", +"type": "string" +}, +"measurementLocation": { +"description": "Optional. The location of the core body temperature measurement.", +"enum": [ +"MEASUREMENT_LOCATION_UNSPECIFIED", +"OTHER", +"ARMPIT", +"BODY", +"EAR", +"FINGER", +"GASTRO_INTESTINAL", +"MOUTH", +"RECTUM", +"TOE", +"EAR_DRUM", +"TEMPORAL_ARTERY", +"FOREHEAD", +"URINARY_BLADDER", +"NASAL", +"NASOPHARYNGEAL", +"WRIST", +"VAGINA" +], +"enumDescriptions": [ +"Measurement location is unspecified.", +"Other measurement location.", +"Armpit measurement location.", +"Body measurement location.", +"Ear measurement location.", +"Finger measurement location.", +"Gastro-intestinal measurement location.", +"Mouth measurement location.", +"Rectum measurement location.", +"Toe measurement location.", +"Ear drum measurement location.", +"Temporal artery measurement location.", +"Forehead measurement location.", +"Urinary bladder measurement location.", +"Nasal measurement location.", +"Nasopharyngeal measurement location.", +"Wrist measurement location.", +"Vagina measurement location." +], +"type": "string" +}, +"sampleTime": { +"$ref": "ObservationSampleTime", +"description": "Required. The time at which core body temperature was measured." +}, +"temperatureCelsius": { +"description": "Required. The core body temperature in Celsius.", +"format": "double", +"type": "number" +} +}, +"type": "object" +}, +"CoreBodyTemperatureRollupValue": { +"description": "Represents the result of the rollup of the core body temperature data type.", +"id": "CoreBodyTemperatureRollupValue", +"properties": { +"temperatureCelsiusAvg": { +"description": "Average core body temperature in Celsius.", +"format": "double", +"type": "number" +}, +"temperatureCelsiusMax": { +"description": "Maximum core body temperature in Celsius.", +"format": "double", +"type": "number" +}, +"temperatureCelsiusMin": { +"description": "Minimum core body temperature in Celsius.", +"format": "double", +"type": "number" +} +}, +"type": "object" +}, "CreateSubscriberPayload": { "description": "Payload for creating a subscriber.", "id": "CreateSubscriberPayload", @@ -1133,6 +1643,24 @@ }, "type": "object" }, +"CreateSubscriptionPayload": { +"description": "Payload for creating a subscription.", +"id": "CreateSubscriptionPayload", +"properties": { +"dataTypes": { +"description": "Optional. Data types subscribed to.", +"items": { +"type": "string" +}, +"type": "array" +}, +"user": { +"description": "Required. Immutable. The resource name of the user for whom this subscription is active. Format: `users/{user}` where `{user}` is the public `healthUserId` as returned by the `GetIdentity` action in the profile PAPI (see `google.devicesandservices.health.v4main.HealthProfileService.GetIdentity`).", +"type": "string" +} +}, +"type": "object" +}, "DailyHeartRateVariability": { "description": "Represents the daily heart rate variability data type. At least one of the following fields must be set: - `average_heart_rate_variability_milliseconds` - `non_rem_heart_rate_beats_per_minute` - `entropy` - `deep_sleep_root_mean_square_of_successive_differences_milliseconds`", "id": "DailyHeartRateVariability", @@ -1317,6 +1845,10 @@ "description": "Value of a daily rollup for a single civil time interval (aggregation window) of reconciled data points from all data sources, excluding those data points that are identified as recorded by wearables in intervals when they were not actually worn.", "id": "DailyRollupDataPoint", "properties": { +"activeEnergyBurned": { +"$ref": "ActiveEnergyBurnedRollupValue", +"description": "Returned by default when rolling up data points from the `active-energy-burned` data type." +}, "activeMinutes": { "$ref": "ActiveMinutesRollupValue", "description": "Returned by default when rolling up data points from the `active-minutes` data type, or when requested explicitly using the `active-minutes` rollup type identifier." @@ -1333,6 +1865,10 @@ "$ref": "AltitudeRollupValue", "description": "Returned by default when rolling up data points from the `altitude` data type, or when requested explicitly using the `altitude` rollup type identifier." }, +"bloodGlucose": { +"$ref": "BloodGlucoseRollupValue", +"description": "Returned by default when rolling up data points from the `blood-glucose` data type." +}, "bodyFat": { "$ref": "BodyFatRollupValue", "description": "Returned by default when rolling up data points from the `body-fat` data type, or when requested explicitly using the `body-fat` rollup type identifier." @@ -1349,6 +1885,10 @@ "$ref": "CivilDateTime", "description": "Start time of the window this value aggregates over" }, +"coreBodyTemperature": { +"$ref": "CoreBodyTemperatureRollupValue", +"description": "Returned by default when rolling up data points from the `core-body-temperature` data type, or when requested explicitly using the `core-body-temperature` rollup type identifier." +}, "distance": { "$ref": "DistanceRollupValue", "description": "Returned by default when rolling up data points from the `distance` data type, or when requested explicitly using the `distance` rollup type identifier." @@ -1369,6 +1909,10 @@ "$ref": "HydrationLogRollupValue", "description": "Returned by default when rolling up data points from the `hydration-log` data type, or when requested explicitly using the `hydration-log` rollup type identifier." }, +"nutritionLog": { +"$ref": "NutritionLogRollupValue", +"description": "Returned by default when rolling up data points from the `nutrition-log` data type, or when requested explicitly using the `nutrition-log` rollup type identifier." +}, "restingHeartRatePersonalRange": { "$ref": "RestingHeartRatePersonalRangeRollupValue", "description": "Returned by default when rolling up data points from the `daily-resting-heart-rate` data type, or when requested explicitly using the `resting-heart-rate-personal-range` rollup type identifier." @@ -1481,6 +2025,10 @@ "description": "A computed or recorded metric.", "id": "DataPoint", "properties": { +"activeEnergyBurned": { +"$ref": "ActiveEnergyBurned", +"description": "Optional. Data for points in the `active-energy-burned` interval data type collection." +}, "activeMinutes": { "$ref": "ActiveMinutes", "description": "Optional. Data for points in the `active-minutes` interval data type collection." @@ -1501,10 +2049,18 @@ "$ref": "BasalEnergyBurned", "description": "Optional. Data for points in the `basal-energy-burned` interval data type collection." }, +"bloodGlucose": { +"$ref": "BloodGlucose", +"description": "Optional. Data for points in the `blood-glucose` sample data type collection." +}, "bodyFat": { "$ref": "BodyFat", "description": "Optional. Data for points in the `body-fat` sample data type collection." }, +"coreBodyTemperature": { +"$ref": "CoreBodyTemperature", +"description": "Optional. Data for points in the `core-body-temperature` sample data type collection." +}, "dailyHeartRateVariability": { "$ref": "DailyHeartRateVariability", "description": "Optional. Data for points in the `daily-heart-rate-variability` daily data type collection." @@ -1541,6 +2097,10 @@ "$ref": "Distance", "description": "Optional. Data for points in the `distance` interval data type collection." }, +"electrocardiogram": { +"$ref": "Electrocardiogram", +"description": "Optional. Data for points in the `electrocardiogram` session data type collection." +}, "exercise": { "$ref": "Exercise", "description": "Optional. Data for points in the `exercise` session data type collection." @@ -1549,6 +2109,14 @@ "$ref": "Floors", "description": "Optional. Data for points in the `floors` interval data type collection." }, +"food": { +"$ref": "Food", +"description": "Optional. The food details." +}, +"foodMeasurementUnit": { +"$ref": "FoodMeasurementUnit", +"description": "Optional. The food measurement unit details." +}, "heartRate": { "$ref": "HeartRate", "description": "Optional. Data for points in the `heart-rate` sample data type collection." @@ -1565,10 +2133,18 @@ "$ref": "HydrationLog", "description": "Optional. Data for points in the `hydration-log` session data type collection." }, +"irregularRhythmNotification": { +"$ref": "IrregularRhythmNotification", +"description": "Optional. Data for points in the `irregular-rhythm-notification` session data type collection." +}, "name": { "description": "Identifier. Data point name, only supported for the subset of identifiable data types. For the majority of the data types, individual data points do not need to be identified and this field would be empty. Format: `users/{user}/dataTypes/{data_type}/dataPoints/{data_point}` Example: `users/abcd1234/dataTypes/sleep/dataPoints/a1b2c3d4-e5f6-7890-1234-567890abcdef` The `{user}` ID is a system-generated identifier, as described in Identity.health_user_id. The `{data_type}` ID corresponds to the kebab-case version of the field names in the DataPoint data union field, e.g. `total-calories` for the `total_calories` field. The `{data_point}` ID can be client-provided or system-generated. If client-provided, it must be a string of 4-63 characters, containing only lowercase letters, numbers, and hyphens.", "type": "string" }, +"nutritionLog": { +"$ref": "NutritionLog", +"description": "Optional. Data for points in the `nutrition-log` session data type collection." +}, "oxygenSaturation": { "$ref": "OxygenSaturation", "description": "Optional. Data for points in the `oxygen-saturation` sample data type collection." @@ -1819,6 +2395,80 @@ }, "type": "object" }, +"Electrocardiogram": { +"description": "Represents an Electrocardiogram (ECG) measurement session. This data type is based on SaMD feature and any changes to it may require additional review.", +"id": "Electrocardiogram", +"properties": { +"beatsPerMinuteAvg": { +"description": "Optional. Average heart rate recorded during ECG reading in beats per minute.", +"format": "int64", +"type": "string" +}, +"interval": { +"$ref": "SessionTimeInterval", +"description": "Required. Observed interval. NOTE: Historical ECG data lacks timezone offsets, so `start_utc_offset` and `end_utc_offset` will be missing or default to zero. As a result, the civil time fields within this interval will default to UTC. It is recommended to use physical time fields instead for accurate time referencing. NOTE: The `start_time` and `end_time` of the interval are equal, representing the reading time." +}, +"leadNumber": { +"description": "Optional. The number of leads used for ECG reading.", +"format": "int32", +"type": "integer" +}, +"medicalDeviceInfo": { +"$ref": "MedicalDeviceInfo", +"description": "Output only. The meta information for the compatible device used to conduct the measurement. ECG measurements typically populate `firmware_version`, `feature_version`, and `device_model`.", +"readOnly": true +}, +"millivoltsScalingFactor": { +"description": "Optional. The factor by which to divide waveform samples to get voltage in millivolts: millivolts = waveform_sample / millivolts_scaling_factor.", +"format": "int32", +"type": "integer" +}, +"resultClassification": { +"description": "Optional. The result classification of the ECG reading.", +"enum": [ +"RESULT_CLASSIFICATION_UNSPECIFIED", +"NORMAL_SINUS_RHYTHM", +"ATRIAL_FIBRILLATION", +"INCONCLUSIVE", +"INCONCLUSIVE_HIGH_HEART_RATE", +"INCONCLUSIVE_LOW_HEART_RATE", +"UNREADABLE", +"NOT_ANALYZED" +], +"enumDescriptions": [ +"Unspecified result classification.", +"Heart rhythm appears normal. Corresponds to result \"Normal Sinus Rhythm\".", +"Signs of Atrial Fibrillation detected. Corresponds to result \"Atrial Fibrillation\".", +"The reading is inconclusive as it could not be classified. Corresponds to result \"Inconclusive\".", +"The reading is inconclusive as it could not be classified because heart rate is high (>120bpm). Corresponds to result \"Inconclusive: High heart rate\".", +"The reading is inconclusive as it could not be classified because heart rate is low (<50bpm). Corresponds to result \"Inconclusive: Low heart rate\".", +"The reading is unreadable.", +"The reading was not analyzed." +], +"type": "string" +}, +"samplingFrequencyHertz": { +"description": "Optional. The sampling frequency of waveform samples in hertz.", +"format": "int32", +"type": "integer" +}, +"waveformSamples": { +"description": "Optional. An array of voltage values representing lead I ECG values. Each sample represents voltage difference in ECG graph. The first value in array corresponds to the start of the reading.", +"items": { +"format": "int32", +"type": "integer" +}, +"type": "array" +} +}, +"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" +}, "EndpointAuthorization": { "description": "Authorization mechanism for a subscriber endpoint. For all requests sent by the Webhooks service, the JSON payload is cryptographically signed. The signature is delivered in the `X-HEALTHAPI-SIGNATURE` HTTP header. This is an ECDSA (NIST P256) signature of the JSON payload. Clients must verify this signature using Google Health API's public key to confirm the payload was sent by the Health API.", "id": "EndpointAuthorization", @@ -1835,6 +2485,70 @@ }, "type": "object" }, +"EnergyQuantity": { +"description": "Represents the energy quantity.", +"id": "EnergyQuantity", +"properties": { +"kcal": { +"description": "Required. Value representing the energy in kilocalories.", +"format": "double", +"type": "number" +}, +"userProvidedUnit": { +"description": "Optional. Value representing the user provided unit.", +"enum": [ +"ENERGY_UNIT_UNSPECIFIED", +"JOULE", +"KILOJOULE", +"KILOCALORIE", +"SMALL_CALORIE", +"CALORIE" +], +"enumDescriptions": [ +"Unspecified energy unit.", +"Value representing joule.", +"Value representing kilojoule.", +"Value representing kilocalorie.", +"Value representing small calorie.", +"Value representing calorie." +], +"type": "string" +} +}, +"type": "object" +}, +"EnergyQuantityRollup": { +"description": "Rollup for the energy quantity.", +"id": "EnergyQuantityRollup", +"properties": { +"kcalSum": { +"description": "Required. The sum of the energy in kilocalories.", +"format": "double", +"type": "number" +}, +"userProvidedUnitLast": { +"description": "Optional. The user provided unit on the last element.", +"enum": [ +"ENERGY_UNIT_UNSPECIFIED", +"JOULE", +"KILOJOULE", +"KILOCALORIE", +"SMALL_CALORIE", +"CALORIE" +], +"enumDescriptions": [ +"Unspecified energy unit.", +"Value representing joule.", +"Value representing kilojoule.", +"Value representing kilocalorie.", +"Value representing small calorie.", +"Value representing calorie." +], +"type": "string" +} +}, +"type": "object" +}, "Exercise": { "description": "An exercise that stores information about a physical activity.", "id": "Exercise", @@ -2028,6 +2742,159 @@ }, "type": "object" }, +"Food": { +"description": "Represents a food item.", +"id": "Food", +"properties": { +"accessLevel": { +"description": "Required. The access level of the food.", +"enum": [ +"FOOD_ACCESS_LEVEL_UNSPECIFIED", +"FOOD_ACCESS_LEVEL_PUBLIC", +"FOOD_ACCESS_LEVEL_PRIVATE" +], +"enumDescriptions": [ +"Unspecified food access level.", +"Public food access level.", +"Private food access level." +], +"type": "string" +}, +"brand": { +"description": "Optional. The brand of the food.", +"type": "string" +}, +"defaultServing": { +"$ref": "FoodServing", +"description": "Required. Value representing the default serving of the food." +}, +"description": { +"description": "Optional. The description of the food.", +"type": "string" +}, +"displayName": { +"description": "Required. The display name of the food.", +"type": "string" +}, +"energyAvg": { +"$ref": "EnergyQuantity", +"description": "Optional. Value representing the average energy of the food for the default serving." +}, +"energyFromFat": { +"$ref": "EnergyQuantity", +"description": "Optional. Value representing the energy from fat of the food for the default serving." +}, +"energyMax": { +"$ref": "EnergyQuantity", +"description": "Optional. Value representing the maximum energy of the food for the default serving." +}, +"energyMin": { +"$ref": "EnergyQuantity", +"description": "Optional. Value representing the minimum energy of the food for the default serving." +}, +"languageCode": { +"description": "Optional. The language code where the food is available in format xx-XX. Supported values are defined in Settings.food_language_code.", +"type": "string" +}, +"mealType": { +"description": "Optional. The meal type associated with this food.", +"enum": [ +"MEAL_TYPE_UNSPECIFIED", +"BEFORE_BREAKFAST", +"BREAKFAST", +"BEFORE_LUNCH", +"LUNCH", +"BEFORE_DINNER", +"DINNER", +"AFTER_DINNER", +"SNACK", +"ANYTIME" +], +"enumDescriptions": [ +"Unspecified meal type.", +"Value representing a meal before breakfast.", +"Value representing a breakfast.", +"Value representing a morning snack.", +"Value representing a lunch.", +"Value representing an afternoon snack.", +"Value representing dinner.", +"Value representing an evening snack.", +"Value representing any meal outside of the usual three meals per day.", +"Value representing any time (legacy NA)." +], +"type": "string" +}, +"nutrients": { +"description": "Optional. Value representing the nutrients of the food for the default serving.", +"items": { +"$ref": "NutrientQuantity" +}, +"type": "array" +}, +"servings": { +"description": "Optional. The serving of the food.", +"items": { +"$ref": "FoodServing" +}, +"type": "array" +}, +"totalCarbohydrate": { +"$ref": "WeightQuantity", +"description": "Optional. Value representing the total carbohydrate of the food for the default serving." +}, +"totalFat": { +"$ref": "WeightQuantity", +"description": "Optional. Value representing the total fat of the food for the default serving." +} +}, +"type": "object" +}, +"FoodMeasurementUnit": { +"description": "Represents a food measurement unit.", +"id": "FoodMeasurementUnit", +"properties": { +"displayName": { +"description": "Required. The display name of the food measurement unit (e.g., \"gram\", \"piece\").", +"type": "string" +}, +"pluralDisplayName": { +"description": "Optional. The plural display name of the food measurement unit (e.g., \"grams\", \"pieces\").", +"type": "string" +} +}, +"type": "object" +}, +"FoodServing": { +"description": "Represents different properties and information about the serving of a specific food.", +"id": "FoodServing", +"properties": { +"amount": { +"description": "Optional. Amount of food consumed, fractional values are supported.", +"format": "double", +"type": "number" +}, +"foodMeasurementUnit": { +"description": "Required. Food measurement unit", +"type": "string" +}, +"foodMeasurementUnitDisplayName": { +"description": "Output only. Legacy measurement unit for serving size in singular form (e.g. \"piece\", \"gram\").", +"readOnly": true, +"type": "string" +}, +"foodMeasurementUnitDisplayNamePlural": { +"description": "Output only. Legacy measurement unit for serving size in plural form (e.g. \"pieces\", \"grams\").", +"readOnly": true, +"type": "string" +}, +"multiplier": { +"description": "Optional. Value representing the multiplier used to compute the energy when using this serving instead of the default serving.", +"format": "double", +"type": "number" +} +}, +"type": "object" +}, "GoogleDevicesandservicesHealthV4DataType": { "description": "Represents a type of health data a user can have data points recorded for. It matches the parent resource of collection containing data points of the given type. Clients currently do not need to interact with this resource directly.", "id": "GoogleDevicesandservicesHealthV4DataType", @@ -2037,15 +2904,53 @@ "type": "string" } }, -"type": "object" +"type": "object" +}, +"GoogleDevicesandservicesHealthV4User": { +"description": "Represents a user in the Google Health API. It matches the parent resource of collections owned by the user. Clients currently do not need to interact with this resource directly.", +"id": "GoogleDevicesandservicesHealthV4User", +"properties": { +"name": { +"description": "Identifier. The resource name of the user. The `{user}` ID is a system-generated identifier, as described in Identity.health_user_id. Format: `users/{user}`", +"type": "string" +} +}, +"type": "object" +}, +"GoogleDevicesandservicesHealthV4WebhookNotificationCloudLog": { +"description": "Log message for a webhook notification sent by the Google Health API to a subscriber's endpoint. Includes the HTTP response received from the endpoint.", +"id": "GoogleDevicesandservicesHealthV4WebhookNotificationCloudLog", +"properties": { +"httpResponse": { +"$ref": "HttpResponse", +"description": "Required. Represents the HTTP response. This message includes the status code, reason phrase, headers, and body." +} +}, +"type": "object" +}, +"HeartBeat": { +"description": "A single heart beat measurement.", +"id": "HeartBeat", +"properties": { +"beatsPerMinute": { +"description": "Required. The beats-per-minute value extrapolated from the time before the following heart beat. This is calculated as 60000 / rr, where rr is the gap between heart beats in milliseconds (IBI - Interbeat Interval).", +"format": "int32", +"type": "integer" +}, +"civilTime": { +"$ref": "CivilDateTime", +"description": "Output only. The civil time in the timezone the subject is in at the time of the observation.", +"readOnly": true +}, +"physicalTime": { +"description": "Required. The time of the heart beat measurement.", +"format": "google-datetime", +"type": "string" }, -"GoogleDevicesandservicesHealthV4WebhookNotificationCloudLog": { -"description": "Log message for a webhook notification sent by the Google Health API to a subscriber's endpoint. Includes the HTTP response received from the endpoint.", -"id": "GoogleDevicesandservicesHealthV4WebhookNotificationCloudLog", -"properties": { -"httpResponse": { -"$ref": "HttpResponse", -"description": "Required. Represents the HTTP response. This message includes the status code, reason phrase, headers, and body." +"utcOffset": { +"description": "Required. The UTC offset of the user's timezone when the heart beat measurement occurred.", +"format": "google-duration", +"type": "string" } }, "type": "object" @@ -2331,6 +3236,54 @@ }, "type": "object" }, +"IrnProfile": { +"description": "Irregular Rhythm Notifications (IRN) Profile details. The Irregular Rhythm Notifications (IRN) feature checks for signs of atrial fibrillation (AFib). The IrnProfile details include information about the user's onboarding status, enrollment status, and the last update time of analyzable data for this feature.", +"id": "IrnProfile", +"properties": { +"enrollmentStatus": { +"description": "Required. Whether or not the user is currently enrolled in having their data processed for IRN alerts.", +"type": "boolean" +}, +"name": { +"description": "Identifier. The resource name of this IrnProfile resource. Format: `users/{user}/irnProfile` Example: `users/1234567890/irnProfile` or `users/me/irnProfile` The {user} ID is a system-generated Google Health API user ID, a string of 1-63 characters consisting of lowercase and uppercase letters, numbers, and hyphens. The literal `me` can also be used to refer to the authenticated user.", +"type": "string" +}, +"onboardingStatus": { +"description": "Required. Whether or not the user has onboarded onto the IRN feature.", +"type": "boolean" +}, +"updateTime": { +"description": "Output only. The timestamp of the last piece of analyzable data synced by the user.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"IrregularRhythmNotification": { +"description": "Represents an Irregular Rhythm Notification alert, indicating a potential sign of atrial fibrillation (AFib). This data type is based on SaMD feature and any changes to it may require additional review.", +"id": "IrregularRhythmNotification", +"properties": { +"alertWindows": { +"description": "Optional. The overlapping analysis windows that were used to evaluate rhythm for potential AFib, containing specific information about the user's heart rhythm.", +"items": { +"$ref": "AlertWindow" +}, +"type": "array" +}, +"interval": { +"$ref": "SessionTimeInterval", +"description": "Required. Observed interval." +}, +"medicalDeviceInfo": { +"$ref": "MedicalDeviceInfo", +"description": "Output only. The meta information for the compatible device used to conduct the measurement. Irregular Rhythm Notification measurements typically populate `algorithm_version`, `service_version`, and `device_model`.", +"readOnly": true +} +}, +"type": "object" +}, "ListDataPointsResponse": { "description": "Response containing raw data points matching the query", "id": "ListDataPointsResponse", @@ -2349,6 +3302,24 @@ }, "type": "object" }, +"ListPairedDevicesResponse": { +"description": "Response message for ListPairedDevices.", +"id": "ListPairedDevicesResponse", +"properties": { +"nextPageToken": { +"description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", +"type": "string" +}, +"pairedDevices": { +"description": "The paired devices of the user.", +"items": { +"$ref": "PairedDevice" +}, +"type": "array" +} +}, +"type": "object" +}, "ListSubscribersResponse": { "description": "Response message for ListSubscribers.", "id": "ListSubscribersResponse", @@ -2372,6 +3343,56 @@ }, "type": "object" }, +"ListSubscriptionsResponse": { +"description": "Response message for ListSubscriptions.", +"id": "ListSubscriptionsResponse", +"properties": { +"nextPageToken": { +"description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", +"type": "string" +}, +"subscriptions": { +"description": "The subscriptions from the specified subscriber.", +"items": { +"$ref": "Subscription" +}, +"type": "array" +} +}, +"type": "object" +}, +"MedicalDeviceInfo": { +"description": "Software as Medical Device (SaMD) metadata. Used to construct the Unique Device Identifier (UDI).", +"id": "MedicalDeviceInfo", +"properties": { +"algorithmVersion": { +"description": "Output only. The algorithm version used by the feature.", +"readOnly": true, +"type": "string" +}, +"deviceModel": { +"description": "Output only. The model name or device type of the compatible device used to collect the data.", +"readOnly": true, +"type": "string" +}, +"featureVersion": { +"description": "Output only. The version of the feature/app running on the device.", +"readOnly": true, +"type": "string" +}, +"firmwareVersion": { +"description": "Output only. The firmware version running on the compatible device used to collect the data.", +"readOnly": true, +"type": "string" +}, +"serviceVersion": { +"description": "Output only. The service version used by the feature.", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, "MetricsSummary": { "description": "Summary metrics for an exercise.", "id": "MetricsSummary", @@ -2469,6 +3490,308 @@ }, "type": "object" }, +"NutrientQuantity": { +"description": "Represents the quantity of a nutrient.", +"id": "NutrientQuantity", +"properties": { +"nutrient": { +"description": "Required. Value representing the nutrient.", +"enum": [ +"NUTRIENT_UNSPECIFIED", +"BIOTIN", +"CAFFEINE", +"CALCIUM", +"CHLORIDE", +"CARBOHYDRATES", +"CHOLESTEROL", +"CHROMIUM", +"COPPER", +"DIETARY_FIBER", +"FOLIC_ACID", +"IODINE", +"IRON", +"MAGNESIUM", +"MANGANESE", +"MOLYBDENUM", +"MONOUNSATURATED_FAT", +"NIACIN", +"PANTOTHENIC_ACID", +"PHOSPHORUS", +"POLYUNSATURATED_FAT", +"POTASSIUM", +"PROTEIN", +"RIBOFLAVIN", +"SATURATED_FAT", +"SELENIUM", +"SODIUM", +"SUGAR", +"THIAMIN", +"TRANS_FAT", +"UNSATURATED_FAT", +"VITAMIN_A", +"VITAMIN_B12", +"VITAMIN_B6", +"VITAMIN_C", +"VITAMIN_D", +"VITAMIN_E", +"VITAMIN_K", +"ZINC", +"FOLATE" +], +"enumDescriptions": [ +"Unspecified nutrient.", +"Value representing biotin nutrient.", +"Value representing caffeine nutrient.", +"Value representing calcium nutrient.", +"Value representing chloride nutrient.", +"Value representing carbohydrates nutrient.", +"Value representing cholesterol nutrient.", +"Value representing chromium nutrient.", +"Value representing copper nutrient.", +"Value representing dietary fiber nutrient.", +"Value representing folic acid nutrient.", +"Value representing iodine nutrient.", +"Value representing iron nutrient.", +"Value representing magnesium nutrient.", +"Value representing manganese nutrient.", +"Value representing molybdenum nutrient.", +"Value representing monounsaturated fat nutrient.", +"Value representing niacin nutrient.", +"Value representing pantothenic acid nutrient.", +"Value representing phosphorus nutrient.", +"Value representing polyunsaturated fat nutrient.", +"Value representing potassium nutrient.", +"Value representing protein nutrient.", +"Value representing riboflavin nutrient.", +"Value representing saturated fat nutrient.", +"Value representing selenium nutrient.", +"Value representing sodium nutrient.", +"Value representing sugar nutrient.", +"Value representing thiamin nutrient.", +"Value representing trans fat nutrient.", +"Value representing unsaturated fat nutrient.", +"Value representing vitamin A nutrient.", +"Value representing vitamin B12 nutrient.", +"Value representing vitamin B6 nutrient.", +"Value representing vitamin C nutrient.", +"Value representing vitamin D nutrient.", +"Value representing vitamin E nutrient.", +"Value representing vitamin K nutrient.", +"Value representing zinc nutrient.", +"Value representing folate nutrient." +], +"type": "string" +}, +"quantity": { +"$ref": "WeightQuantity", +"description": "Required. Value representing the quantity of the nutrient." +} +}, +"type": "object" +}, +"NutrientQuantityRollup": { +"description": "Nutrient quantity rollup.", +"id": "NutrientQuantityRollup", +"properties": { +"nutrient": { +"description": "Required. Aggregated nutrient.", +"enum": [ +"NUTRIENT_UNSPECIFIED", +"BIOTIN", +"CAFFEINE", +"CALCIUM", +"CHLORIDE", +"CARBOHYDRATES", +"CHOLESTEROL", +"CHROMIUM", +"COPPER", +"DIETARY_FIBER", +"FOLIC_ACID", +"IODINE", +"IRON", +"MAGNESIUM", +"MANGANESE", +"MOLYBDENUM", +"MONOUNSATURATED_FAT", +"NIACIN", +"PANTOTHENIC_ACID", +"PHOSPHORUS", +"POLYUNSATURATED_FAT", +"POTASSIUM", +"PROTEIN", +"RIBOFLAVIN", +"SATURATED_FAT", +"SELENIUM", +"SODIUM", +"SUGAR", +"THIAMIN", +"TRANS_FAT", +"UNSATURATED_FAT", +"VITAMIN_A", +"VITAMIN_B12", +"VITAMIN_B6", +"VITAMIN_C", +"VITAMIN_D", +"VITAMIN_E", +"VITAMIN_K", +"ZINC", +"FOLATE" +], +"enumDescriptions": [ +"Unspecified nutrient.", +"Value representing biotin nutrient.", +"Value representing caffeine nutrient.", +"Value representing calcium nutrient.", +"Value representing chloride nutrient.", +"Value representing carbohydrates nutrient.", +"Value representing cholesterol nutrient.", +"Value representing chromium nutrient.", +"Value representing copper nutrient.", +"Value representing dietary fiber nutrient.", +"Value representing folic acid nutrient.", +"Value representing iodine nutrient.", +"Value representing iron nutrient.", +"Value representing magnesium nutrient.", +"Value representing manganese nutrient.", +"Value representing molybdenum nutrient.", +"Value representing monounsaturated fat nutrient.", +"Value representing niacin nutrient.", +"Value representing pantothenic acid nutrient.", +"Value representing phosphorus nutrient.", +"Value representing polyunsaturated fat nutrient.", +"Value representing potassium nutrient.", +"Value representing protein nutrient.", +"Value representing riboflavin nutrient.", +"Value representing saturated fat nutrient.", +"Value representing selenium nutrient.", +"Value representing sodium nutrient.", +"Value representing sugar nutrient.", +"Value representing thiamin nutrient.", +"Value representing trans fat nutrient.", +"Value representing unsaturated fat nutrient.", +"Value representing vitamin A nutrient.", +"Value representing vitamin B12 nutrient.", +"Value representing vitamin B6 nutrient.", +"Value representing vitamin C nutrient.", +"Value representing vitamin D nutrient.", +"Value representing vitamin E nutrient.", +"Value representing vitamin K nutrient.", +"Value representing zinc nutrient.", +"Value representing folate nutrient." +], +"type": "string" +}, +"quantity": { +"$ref": "WeightQuantityRollup", +"description": "Required. Aggregated nutrient weight." +} +}, +"type": "object" +}, +"NutritionLog": { +"description": "Holds information about a user logged food. There are two ways of creating a nutrition log based on the food type: 1. Identified food: Using the food field, which is a reference to a Food resource. In this case fields `nutrients`, `energy`, `energy_from_fat`, `total_carbohydrate`, `total_fat`, `food_display_name` will be populated based on the referenced food. 2. Anonymous food: Using the `food_display_name` field and setting the `nutrients`, `energy`, `energy_from_fat`, `total_carbohydrate`, `total_fat` fields manually. The identified food is preferred over the anonymous food. Nutrition logs created from anonymous food are not be editable.", +"id": "NutritionLog", +"properties": { +"energy": { +"$ref": "EnergyQuantity", +"description": "Optional. Value representing the energy of the nutrition log. For nutrition logs created from an identified food, this field will be populated based on the referenced food. For anonymous food, this field will be populated manually." +}, +"energyFromFat": { +"$ref": "EnergyQuantity", +"description": "Optional. Value representing the energy from fat of the nutrition log. For nutrition logs created from an identified food, this field will be populated based on the referenced food. For anonymous food, this field will be populated manually." +}, +"food": { +"description": "Required. Represents the food ID.", +"type": "string" +}, +"foodDisplayName": { +"description": "Value representing the display name of the food. For nutrition logs created from an identified food, this field will be populated based on the referenced food. For anonymous food, this field will be populated manually.", +"type": "string" +}, +"interval": { +"$ref": "SessionTimeInterval", +"description": "Required. Observed interval." +}, +"mealType": { +"description": "Optional. Value representing the meal type of the nutrition log.", +"enum": [ +"MEAL_TYPE_UNSPECIFIED", +"BEFORE_BREAKFAST", +"BREAKFAST", +"BEFORE_LUNCH", +"LUNCH", +"BEFORE_DINNER", +"DINNER", +"AFTER_DINNER", +"SNACK", +"ANYTIME" +], +"enumDescriptions": [ +"Unspecified meal type.", +"Value representing a meal before breakfast.", +"Value representing a breakfast.", +"Value representing a morning snack.", +"Value representing a lunch.", +"Value representing an afternoon snack.", +"Value representing dinner.", +"Value representing an evening snack.", +"Value representing any meal outside of the usual three meals per day.", +"Value representing any time (legacy NA)." +], +"type": "string" +}, +"nutrients": { +"description": "Optional. Value representing the nutrients of the nutrition log.", +"items": { +"$ref": "NutrientQuantity" +}, +"type": "array" +}, +"serving": { +"$ref": "Serving", +"description": "Optional. Value representing the nutrition log serving." +}, +"totalCarbohydrate": { +"$ref": "WeightQuantity", +"description": "Optional. Value representing the total carbohydrate of the nutrition log. For nutrition logs created from an identified food, this field will be populated based on the referenced food. For anonymous food, this field will be populated manually." +}, +"totalFat": { +"$ref": "WeightQuantity", +"description": "Optional. Value representing the total fat of the nutrition log. For nutrition logs created from an identified food, this field will be populated based on the referenced food. For anonymous food, this field will be populated manually." +} +}, +"type": "object" +}, +"NutritionLogRollupValue": { +"description": "Represents the result of the rollup of the nutrition log data type.", +"id": "NutritionLogRollupValue", +"properties": { +"energy": { +"$ref": "EnergyQuantityRollup", +"description": "Energy rollup." +}, +"energyFromFat": { +"$ref": "EnergyQuantityRollup", +"description": "Value Energy from fat rollup." +}, +"nutrients": { +"description": "List of the nutrient roll-ups by the nutrient type.", +"items": { +"$ref": "NutrientQuantityRollup" +}, +"type": "array" +}, +"totalCarbohydrate": { +"$ref": "WeightQuantityRollup", +"description": "Total carbohydrate rollup." +}, +"totalFat": { +"$ref": "WeightQuantityRollup", +"description": "Total fat rollup." +} +}, +"type": "object" +}, "ObservationSampleTime": { "description": "Represents a sample time of an observed data point.", "id": "ObservationSampleTime", @@ -2606,6 +3929,67 @@ }, "type": "object" }, +"PairedDevice": { +"description": "User's Paired 1P Device The PairedDevice details include information about the device type, battery status, battery level, last sync time, device version, mac address, and features.", +"id": "PairedDevice", +"properties": { +"batteryLevel": { +"description": "Output only. The battery level of the device.", +"format": "int32", +"readOnly": true, +"type": "integer" +}, +"batteryStatus": { +"description": "Output only. The battery status of the device. Supported: High | Medium | Low | Empty", +"readOnly": true, +"type": "string" +}, +"deviceType": { +"description": "Output only. The device type. Supported: TRACKER | SCALE", +"enum": [ +"DEVICE_TYPE_UNSPECIFIED", +"TRACKER", +"SCALE" +], +"enumDescriptions": [ +"Device type is not specified.", +"Device type is tracker.", +"Device type is scale." +], +"readOnly": true, +"type": "string" +}, +"deviceVersion": { +"description": "Output only. The product name of the device", +"readOnly": true, +"type": "string" +}, +"features": { +"description": "Output only. Lists of unique features supported by the device. Comprehensive list of supported features: **Fitness Tracking** - `ACTIVE_MINUTES`: Legacy active minutes. - `AUTOSTRIDE`: Automatic stride length calculation. - `BIKE_ONBOARDING`: Cycling UI support. - `CALORIES`: Daily burned calories. - `DISTANCE`: Daily distance tracking. - `ELEVATION`: Floors climbed. - `INACTIVITY_ALERTS`: Reminders to move. - `SEDENTARY_TIME`: Tracks inactive time. - `STEPS`: Daily steps. - `SWIM`: Swim tracking (laps/strokes). - `AUTORUN`: Automatic run detection. - `ACTIVE_ZONE_MINUTES`: Active Zone Minutes (AZM). **Heart Rate & Health** - `HEART_RATE`: Continuous heart rate (PPG). - `BAT_SIGNAL`: High/Low Heart Rate Alerts. **Advanced Sensors** - `SPO2`: Blood oxygen saturation. - `NIGHTTIME_OXYGEN_SATURATION`: Sleep SpO2. - `ESTIMATED_OXYGEN_VARIATION`: Estimated Oxygen Variation. - `EDA`: Electrodermal Activity (stress). - `SKIN_TEMPERATURE`: Skin temperature variation. - `INTERNAL_DEVICE_TEMPERATURE`: Internal device temperature. **Sleep & Wellness** - `SLEEP`: Basic sleep tracking. - `SMART_SLEEP`: Advanced sleep tracking (stages/score). - `BEDTIME_REMINDER`: Bedtime reminders. - `SOUNDSCAPE`: Snore and noise detection. **Advanced Workouts** - `WB`: Custom Workout Builder. - `AUTOCUES`: Auto Cues / Auto Lap. - `DWR_RUN`: Daily Run Recommendations. - `ADVANCED_RUNNING`: Advanced Running Dynamics (e.g., GCT, VO). **GPS & Location** - `GPS`: Built-in GPS. - `CONNECTED_GPS`: Connected GPS (uses phone). - `LOCATION_HINT`: Location helper. **Payments & NFC** - `PAYMENTS`: NFC payments (Fitbit Pay/Google Wallet). - `FELICA`: FeliCa support (Japan payments/transit). **Activity Detection** - `GROK`: SmartTrack automatic activity detection. - `RETRO_AR`: Retroactive Activity Recognition prompts. **Smart Features & UI** - `ALARMS`: Silent alarms. - `BLE_MUSIC_CONTROL`: BLE music control. - `MUSIC`: Direct music storage/control. - `YOUTUBE_MUSIC_SUPPORTED`: YouTube Music support. - `GALLERY`: App Gallery. - `TUTORIAL_SUPPORTED`: On-screen tutorials. - `SMILEY_EMOTE`: Legacy Zip face. - `MOBILE_TO_DEVICE_DEEPLINK`: Mobile to device settings deep link. - `HIDE_GALLERY`: Option to hide Gallery. - `HIDE_GOAL_SELECTION`: Option to hide goal selection. - `DIGITAL_WARRANTY_SUPPORTED`: Digital warranty display. - `DIRECT_DEVICE_SETTINGS_SUPPORTED`: Direct device settings management. **Gym HR Broadcasting** - `ASPEN_SUPPORTED`: Broadcast HR to gym equipment. - `ASPEN_REMOTE_UI_SUPPORTED`: Remote UI for HR sharing. **Privacy & Security** - `FINITE_IMPROBABILITY`: BLE Resolvable Private Address (RPA) privacy. - `DOMAIN_KEY_SYNC`: Domain key synchronization. **BLE Protocol** - `BONDING`: Secure BLE bonding. - `ADVERTISES_SERIAL`: Advertises serial number. - `STATUS_CHARACTERISTIC`: BLE Status Characteristic. - `TRACKER_CHANNEL_CHARACTERISTIC`: BLE Tracker Channel Characteristic. - `PING_CHARACTERISTIC`: BLE Ping Characteristic. **Cellular & Wi-Fi** - `MOBILE_DATA`: LTE cellular support. - `SINGLE_AP_WIFI`: Single AP Wi-Fi. - `MULTI_AP_WIFI`: Multi AP Wi-Fi. - `WIFI_FWUP`: Firmware updates over Wi-Fi. **Data Sync & Transfer** - `APP_SYNC`: Background app sync. - `LIVE_DATA`: Real-time data streaming. - `EVENT_BASED_SYNC_SUPPORTED`: Event-based sync. - `TIME_SERVICE`: Time synchronization service. - `REMOTE_FILE_PROVIDER`: Remote file transfer. - `DIRECT_COMMS_ALARMS`: Direct communication for alarms. - `DIRECT_COMMS_EXERCISE`: Direct communication for exercise. - `DIRECT_COMMS_BATTERY_ALERTS`: Direct communication for battery alerts. **Google Integrations** - `PARROT_TREE_SUPPORTED`: Find My Device support.", +"items": { +"type": "string" +}, +"readOnly": true, +"type": "array" +}, +"lastSyncTime": { +"description": "Output only. The time of last sync with the Fitbit mobile application.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"macAddress": { +"description": "Output only. Mac ID number of the device.", +"readOnly": true, +"type": "string" +}, +"name": { +"description": "Identifier. The resource name of this Device resource. Format: `users/{user}/pairedDevices/{paired_device}` Example: `users/1234567890/pairedDevices/123` or `users/me/pairedDevices/123`", +"type": "string" +} +}, +"type": "object" +}, "Profile": { "description": "Profile details.", "id": "Profile", @@ -2671,6 +4055,10 @@ "description": "A reconciled computed or recorded metric.", "id": "ReconciledDataPoint", "properties": { +"activeEnergyBurned": { +"$ref": "ActiveEnergyBurned", +"description": "Data for points in the `active-energy-burned` interval data type collection." +}, "activeMinutes": { "$ref": "ActiveMinutes", "description": "Data for points in the `active-minutes` interval data type collection." @@ -2691,10 +4079,18 @@ "$ref": "BasalEnergyBurned", "description": "Data for points in the `basal-energy-burned` interval data type collection." }, +"bloodGlucose": { +"$ref": "BloodGlucose", +"description": "Data for points in the `blood-glucose` sample data type collection." +}, "bodyFat": { "$ref": "BodyFat", "description": "Data for points in the `body-fat` sample data type collection." }, +"coreBodyTemperature": { +"$ref": "CoreBodyTemperature", +"description": "Data for points in the `core-body-temperature` sample data type collection." +}, "dailyHeartRateVariability": { "$ref": "DailyHeartRateVariability", "description": "Data for points in the `daily-heart-rate-variability` daily data type collection." @@ -2755,6 +4151,10 @@ "$ref": "HydrationLog", "description": "Data for points in the `hydration-log` session data type collection." }, +"nutritionLog": { +"$ref": "NutritionLog", +"description": "Data for points in the `nutrition-log` session data type collection." +}, "oxygenSaturation": { "$ref": "OxygenSaturation", "description": "Data for points in the `oxygen-saturation` sample data type collection." @@ -2915,6 +4315,10 @@ "description": "Value of a rollup for a single physical time interval (aggregation window) of reconciled data points from all data sources, excluding those data points that are identified as recorded by wearables in intervals when they were not actually worn.", "id": "RollupDataPoint", "properties": { +"activeEnergyBurned": { +"$ref": "ActiveEnergyBurnedRollupValue", +"description": "Returned by default when rolling up data points from the `active-energy-burned` data type." +}, "activeMinutes": { "$ref": "ActiveMinutesRollupValue", "description": "Returned by default when rolling up data points from the `active-minutes` data type, or when requested explicitly using the `active-minutes` rollup type identifier." @@ -2931,6 +4335,10 @@ "$ref": "AltitudeRollupValue", "description": "Returned by default when rolling up data points from the `altitude` data type, or when requested explicitly using the `altitude` rollup type identifier." }, +"bloodGlucose": { +"$ref": "BloodGlucoseRollupValue", +"description": "Returned by default when rolling up data points from the `blood-glucose` data type." +}, "bodyFat": { "$ref": "BodyFatRollupValue", "description": "Returned by default when rolling up data points from the `body-fat` data type, or when requested explicitly using the `body-fat` rollup type identifier." @@ -2939,6 +4347,10 @@ "$ref": "CaloriesInHeartRateZoneRollupValue", "description": "Returned by default when rolling up data points from the `calories-in-heart-rate-zone` data type, or when requested explicitly using the `calories-in-heart-rate-zone` rollup type identifier." }, +"coreBodyTemperature": { +"$ref": "CoreBodyTemperatureRollupValue", +"description": "Returned by default when rolling up data points from the `core-body-temperature` data type, or when requested explicitly using the `core-body-temperature` rollup type identifier." +}, "distance": { "$ref": "DistanceRollupValue", "description": "Returned by default when rolling up data points from the `distance` data type, or when requested explicitly using the `distance` rollup type identifier." @@ -2960,6 +4372,10 @@ "$ref": "HydrationLogRollupValue", "description": "Returned by default when rolling up data points from the `hydration-log` data type, or when requested explicitly using the `hydration-log` rollup type identifier." }, +"nutritionLog": { +"$ref": "NutritionLogRollupValue", +"description": "Returned by default when rolling up data points from the `nutrition-log` data type, or when requested explicitly using the `nutrition-log` rollup type identifier." +}, "runVo2Max": { "$ref": "RunVO2MaxRollupValue", "description": "Returned by default when rolling up data points from the `run-vo2-max` data type, or when requested explicitly using the `run-vo2-max` rollup type identifier." @@ -3057,6 +4473,27 @@ }, "type": "object" }, +"Serving": { +"description": "Represents different properties and information about the serving of a specific food.", +"id": "Serving", +"properties": { +"amount": { +"description": "Optional. Amount of food consumed, fractional values are supported.", +"format": "double", +"type": "number" +}, +"foodMeasurementUnit": { +"description": "Required. Food measurement unit", +"type": "string" +}, +"foodMeasurementUnitDisplayName": { +"description": "Output only. Legacy measurement unit for serving size in singular form (e.g. \"piece\", \"gram\").", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, "SessionTimeInterval": { "description": "Represents a time interval of session data point, which bundles multiple observed metrics together.", "id": "SessionTimeInterval", @@ -3116,6 +4553,11 @@ ], "type": "string" }, +"foodLanguageCode": { +"description": "Output only. The food language code derived from the user's food database. Possible values: `'en-US'`, `'en-GB'`, `'de-DE'`, `'es-ES'`, `'fr-FR'`, `'zh-CN'`, `'zh-TW'`, `'ja-JP'`, `'en-AU'`, `'en-CA'`, `'it-IT'`, `'ko-KR'`, `'es-MX'`, `'en-IN'`, `'en-SG'`, `'en-PH'`, `'en-IE'`, `'fr-CA'`. Updates to this field are currently not supported.", +"readOnly": true, +"type": "string" +}, "glucoseUnit": { "description": "Optional. The measurement unit defined in the user's account settings.", "enum": [ @@ -3712,6 +5154,28 @@ }, "type": "object" }, +"Subscription": { +"description": "A subscription to a data collection for a specific user, to be delivered to a subscriber.", +"id": "Subscription", +"properties": { +"dataTypes": { +"description": "Optional. Data types subscribed to. A subscriber will only receive notifications for data types that are declared here. A subscription can only subscribe to the data types of the subscriber. The values should be in the format \"users/{health_user_id}/dataTypes/{data_type}\" where `{data_type}` is one of \"altitude\", \"distance\", \"floors\", \"sleep\", \"steps\", \"weight\".", +"items": { +"type": "string" +}, +"type": "array" +}, +"name": { +"description": "Identifier. The resource name of the Subscription. Format: `projects/{project}/subscribers/{subscriber}/subscriptions/{subscription}` Example: `projects/my-project/subscribers/my-subscriber-123/subscriptions/my-subscription-456` The {project} ID is mandatory (6-30 characters, matching /a-z{6,30}/) The {subscriber} ID is user-settable (4-36 characters, matching /[a-z]([a-z0-9-]{2,34}[a-z0-9])/) if provided during creation, or system-generated otherwise. The {subscription} ID is user-settable (4-36 chars, matching /[a-z]([a-z0-9-]{2,34}[a-z0-9])/) or system-generated otherwise.", +"type": "string" +}, +"user": { +"description": "Immutable. The resource name of the user for whom this subscription is active. Format: `users/{user}` where `{user}` is the public `healthUserId` as returned by the `GetIdentity` action in the profile PAPI (see `google.devicesandservices.health.v4main.HealthProfileService.GetIdentity`).", +"type": "string" +} +}, +"type": "object" +}, "SwimLengthsData": { "description": "Swim lengths data over the time interval.", "id": "SwimLengthsData", @@ -4056,6 +5520,82 @@ }, "type": "object" }, +"WeightQuantity": { +"description": "Represents the weight quantity.", +"id": "WeightQuantity", +"properties": { +"grams": { +"description": "Required. Value representing the weight in grams.", +"format": "double", +"type": "number" +}, +"userProvidedUnit": { +"description": "Optional. Value representing the user provided unit.", +"enum": [ +"WEIGHT_UNIT_UNSPECIFIED", +"GRAM", +"KILOGRAM", +"OUNCE", +"POUND", +"STONE", +"MILLIGRAM", +"MICROGRAM", +"NANOGRAM" +], +"enumDescriptions": [ +"Unspecified weight unit.", +"Value representing gram.", +"Value representing kilogram.", +"Value representing ounce.", +"Value representing pound.", +"Value representing stone.", +"Value representing milligram.", +"Value representing microgram.", +"Value representing nanogram." +], +"type": "string" +} +}, +"type": "object" +}, +"WeightQuantityRollup": { +"description": "Rollup for the weight.", +"id": "WeightQuantityRollup", +"properties": { +"gramsSum": { +"description": "Required. The sum of the weight in grams.", +"format": "double", +"type": "number" +}, +"userProvidedUnitLast": { +"description": "Optional. The user provided unit on the last element.", +"enum": [ +"WEIGHT_UNIT_UNSPECIFIED", +"GRAM", +"KILOGRAM", +"OUNCE", +"POUND", +"STONE", +"MILLIGRAM", +"MICROGRAM", +"NANOGRAM" +], +"enumDescriptions": [ +"Unspecified weight unit.", +"Value representing gram.", +"Value representing kilogram.", +"Value representing ounce.", +"Value representing pound.", +"Value representing stone.", +"Value representing milligram.", +"Value representing microgram.", +"Value representing nanogram." +], +"type": "string" +} +}, +"type": "object" +}, "WeightRollupValue": { "description": "Represents the result of the rollup of the weight data type.", "id": "WeightRollupValue", diff --git a/googleapiclient/discovery_cache/documents/healthcare.v1beta1.json b/googleapiclient/discovery_cache/documents/healthcare.v1beta1.json index a18ce0b1ec..4d6067952d 100644 --- a/googleapiclient/discovery_cache/documents/healthcare.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/healthcare.v1beta1.json @@ -5718,7 +5718,7 @@ } } }, -"revision": "20260512", +"revision": "20260519", "rootUrl": "https://healthcare.googleapis.com/", "schemas": { "AccessDeterminationLogConfig": { @@ -6701,6 +6701,25 @@ "properties": {}, "type": "object" }, +"CustomRegex": { +"description": "Defines a custom regular expression pattern to detect and redact in the image.", +"id": "CustomRegex", +"properties": { +"groupIndexes": { +"description": "Optional. The capturing group indexes to redact. skip_request_analyics: true", +"items": { +"format": "int32", +"type": "integer" +}, +"type": "array" +}, +"pattern": { +"description": "Optional. The regular expression pattern to match.", +"type": "string" +} +}, +"type": "object" +}, "Dataset": { "description": "A message representing a health dataset. A health dataset represents a collection of healthcare data pertaining to one or more patients. This may include multiple modalities of healthcare data, such as electronic medical records or medical imaging data.", "id": "Dataset", @@ -8360,6 +8379,13 @@ }, "type": "array" }, +"customRegexes": { +"description": "Optional. Custom regex patterns to redact from the image.", +"items": { +"$ref": "CustomRegex" +}, +"type": "array" +}, "excludeInfoTypes": { "description": "InfoTypes to skip redacting, overriding those used by `text_redaction_mode`. Can only be used when `text_redaction_mode` is set to `REDACT_SENSITIVE_TEXT` or `REDACT_SENSITIVE_TEXT_CLEAN_DESCRIPTORS`.", "items": { diff --git a/googleapiclient/discovery_cache/documents/homegraph.v1.json b/googleapiclient/discovery_cache/documents/homegraph.v1.json index 1495dff168..9ab5e43fad 100644 --- a/googleapiclient/discovery_cache/documents/homegraph.v1.json +++ b/googleapiclient/discovery_cache/documents/homegraph.v1.json @@ -216,7 +216,7 @@ } } }, -"revision": "20260508", +"revision": "20260523", "rootUrl": "https://homegraph.googleapis.com/", "schemas": { "AgentDeviceId": { @@ -735,7 +735,7 @@ "description": "Properties of the object. Contains field @type with type URL.", "type": "any" }, -"description": "Optional. The Home API trait payload.", +"description": "The Provider Home API trait payload.", "type": "object" } }, diff --git a/googleapiclient/discovery_cache/documents/logging.v2.json b/googleapiclient/discovery_cache/documents/logging.v2.json index 7e446413c2..84f6aadc98 100644 --- a/googleapiclient/discovery_cache/documents/logging.v2.json +++ b/googleapiclient/discovery_cache/documents/logging.v2.json @@ -9167,7 +9167,7 @@ } } }, -"revision": "20260501", +"revision": "20260522", "rootUrl": "https://logging.googleapis.com/", "schemas": { "AppHub": { @@ -11429,6 +11429,10 @@ "truncationGranularity": { "description": "The truncation granularity when grouping by a time/date field. This will be used to truncate the field to the granularity specified. This can be either a date or a time granularity found at https://cloud.google.com/bigquery/docs/reference/standard-sql/timestamp_functions#timestamp_trunc_granularity_date and https://cloud.google.com/bigquery/docs/reference/standard-sql/timestamp_functions#timestamp_trunc_granularity_time respectively.", "type": "string" +}, +"virtualField": { +"$ref": "VirtualField", +"description": "Optional. A virtual field definition, used in place of field to define a field that is computed from other fields rather than being directly present in the data schema.For example, a virtual field can be defined using COALESCE to select the first non-null value from a list of fields.If virtual_field is set, field must not be set." } }, "type": "object" @@ -11990,6 +11994,32 @@ }, "type": "object" }, +"VirtualField": { +"description": "A virtual field is a field that is not physically present in the underlying data schema, but is created through specific operations within the query builder model based on other fields in the schema.", +"id": "VirtualField", +"properties": { +"underlyingFieldSources": { +"description": "The field sources that will be used to create the virtual field, based on the semantics of the virtual field type.The field sources must follow these rules, based on the virtual field type: - For VIRTUAL_FIELD_TYPE_UNSPECIFIED, this field must be empty. - For COALESCE, this field must be non-empty and include a minimum of two field sources. The underlying field sources must be actual projected fields that represent actual schema fields and that must not be transformed and aggregated in any way, except for casting. The type of all the underlying field sources must be equivalent so that picking one of them would result in the same value type.", +"items": { +"$ref": "FieldSource" +}, +"type": "array" +}, +"virtualFieldType": { +"description": "Required. The type of the virtual field.", +"enum": [ +"VIRTUAL_FIELD_TYPE_UNSPECIFIED", +"COALESCE" +], +"enumDescriptions": [ +"Invalid value, do not use.", +"Creates a virtual field by selecting the first non-null value from the list of fields specified in underlying_field_sources, similar to a COALESCE function in SQL." +], +"type": "string" +} +}, +"type": "object" +}, "WriteLogEntriesRequest": { "description": "The parameters to WriteLogEntries.", "id": "WriteLogEntriesRequest", diff --git a/googleapiclient/discovery_cache/documents/managedkafka.v1.json b/googleapiclient/discovery_cache/documents/managedkafka.v1.json index 50bf8784e0..b5cbe7fe36 100644 --- a/googleapiclient/discovery_cache/documents/managedkafka.v1.json +++ b/googleapiclient/discovery_cache/documents/managedkafka.v1.json @@ -3186,7 +3186,7 @@ } } }, -"revision": "20260423", +"revision": "20260507", "rootUrl": "https://managedkafka.googleapis.com/", "schemas": { "AccessConfig": { @@ -4404,6 +4404,24 @@ }, "type": "object" }, +"SchemaSubject": { +"description": "Subject defines the evolution scope of schemas as a holder of schema versions.", +"id": "SchemaSubject", +"properties": { +"name": { +"description": "Identifier. The name of the subject. Structured like: `projects/{project}/locations/{location}/schemaRegistries/{schema_registry}/subjects/{subject}` or `projects/{project}/locations/{location}/schemaRegistries/{schema_registry}/contexts/{context}/subjects/{subject}` Subject name {subject} can contain the following: * Up to 255 UTF-8 bytes. * Allowed characters: letters (uppercase or lowercase), numbers, and the following special characters: `.`, `-`, `_`, `+`, `%`, and `~`.", +"type": "string" +}, +"versions": { +"description": "Optional. The versions of the subject.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, "SchemaVersion": { "description": "Version of a schema.", "id": "SchemaVersion", diff --git a/googleapiclient/discovery_cache/documents/memcache.v1.json b/googleapiclient/discovery_cache/documents/memcache.v1.json index 698ffa6a44..5d73f9b71a 100644 --- a/googleapiclient/discovery_cache/documents/memcache.v1.json +++ b/googleapiclient/discovery_cache/documents/memcache.v1.json @@ -135,7 +135,7 @@ ] }, "list": { -"description": "Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project.", +"description": "Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the ListLocationsRequest.name field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.", "flatPath": "v1/projects/{projectsId}/locations", "httpMethod": "GET", "id": "memcache.projects.locations.list", @@ -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. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -648,7 +648,7 @@ } } }, -"revision": "20260205", +"revision": "20260517", "rootUrl": "https://memcache.googleapis.com/", "schemas": { "ApplyParametersRequest": { diff --git a/googleapiclient/discovery_cache/documents/memcache.v1beta2.json b/googleapiclient/discovery_cache/documents/memcache.v1beta2.json index de47d473a1..b54e51dc7d 100644 --- a/googleapiclient/discovery_cache/documents/memcache.v1beta2.json +++ b/googleapiclient/discovery_cache/documents/memcache.v1beta2.json @@ -135,7 +135,7 @@ ] }, "list": { -"description": "Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project.", +"description": "Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the ListLocationsRequest.name field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.", "flatPath": "v1beta2/projects/{projectsId}/locations", "httpMethod": "GET", "id": "memcache.projects.locations.list", @@ -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. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -623,7 +623,7 @@ } } }, -"revision": "20260205", +"revision": "20260517", "rootUrl": "https://memcache.googleapis.com/", "schemas": { "ApplyParametersRequest": { diff --git a/googleapiclient/discovery_cache/documents/merchantapi.accounts_v1.json b/googleapiclient/discovery_cache/documents/merchantapi.accounts_v1.json index 1ea326ce98..d4067d3e43 100644 --- a/googleapiclient/discovery_cache/documents/merchantapi.accounts_v1.json +++ b/googleapiclient/discovery_cache/documents/merchantapi.accounts_v1.json @@ -2438,7 +2438,7 @@ } } }, -"revision": "20260512", +"revision": "20260527", "rootUrl": "https://merchantapi.googleapis.com/", "schemas": { "About": { @@ -4889,11 +4889,13 @@ false "description": "The resource that changed, in this case it will always be `Product`.", "enum": [ "RESOURCE_UNSPECIFIED", -"PRODUCT" +"PRODUCT", +"ACCOUNT_SERVICE" ], "enumDescriptions": [ "Unspecified resource", -"Resource type : product" +"Resource type : product", +"Account service" ], "type": "string" } diff --git a/googleapiclient/discovery_cache/documents/merchantapi.accounts_v1beta.json b/googleapiclient/discovery_cache/documents/merchantapi.accounts_v1beta.json index 0c4ad54e1f..243b2965fc 100644 --- a/googleapiclient/discovery_cache/documents/merchantapi.accounts_v1beta.json +++ b/googleapiclient/discovery_cache/documents/merchantapi.accounts_v1beta.json @@ -2388,7 +2388,7 @@ } } }, -"revision": "20260512", +"revision": "20260527", "rootUrl": "https://merchantapi.googleapis.com/", "schemas": { "About": { @@ -4766,11 +4766,13 @@ false "description": "The resource that changed, in this case it will always be `Product`.", "enum": [ "RESOURCE_UNSPECIFIED", -"PRODUCT" +"PRODUCT", +"ACCOUNT_SERVICE" ], "enumDescriptions": [ "Unspecified resource", -"Resource type : product" +"Resource type : product", +"Account service" ], "type": "string" } diff --git a/googleapiclient/discovery_cache/documents/merchantapi.conversions_v1.json b/googleapiclient/discovery_cache/documents/merchantapi.conversions_v1.json index dabec591e0..4ee3a01881 100644 --- a/googleapiclient/discovery_cache/documents/merchantapi.conversions_v1.json +++ b/googleapiclient/discovery_cache/documents/merchantapi.conversions_v1.json @@ -295,7 +295,7 @@ } } }, -"revision": "20260223", +"revision": "20260527", "rootUrl": "https://merchantapi.googleapis.com/", "schemas": { "AttributionSettings": { @@ -628,11 +628,13 @@ false "description": "The resource that changed, in this case it will always be `Product`.", "enum": [ "RESOURCE_UNSPECIFIED", -"PRODUCT" +"PRODUCT", +"ACCOUNT_SERVICE" ], "enumDescriptions": [ "Unspecified resource", -"Resource type : product" +"Resource type : product", +"Account service" ], "type": "string" } diff --git a/googleapiclient/discovery_cache/documents/merchantapi.conversions_v1beta.json b/googleapiclient/discovery_cache/documents/merchantapi.conversions_v1beta.json index d692cfff55..d094e36bb2 100644 --- a/googleapiclient/discovery_cache/documents/merchantapi.conversions_v1beta.json +++ b/googleapiclient/discovery_cache/documents/merchantapi.conversions_v1beta.json @@ -295,7 +295,7 @@ } } }, -"revision": "20260223", +"revision": "20260527", "rootUrl": "https://merchantapi.googleapis.com/", "schemas": { "AttributionSettings": { @@ -628,11 +628,13 @@ false "description": "The resource that changed, in this case it will always be `Product`.", "enum": [ "RESOURCE_UNSPECIFIED", -"PRODUCT" +"PRODUCT", +"ACCOUNT_SERVICE" ], "enumDescriptions": [ "Unspecified resource", -"Resource type : product" +"Resource type : product", +"Account service" ], "type": "string" } diff --git a/googleapiclient/discovery_cache/documents/merchantapi.datasources_v1.json b/googleapiclient/discovery_cache/documents/merchantapi.datasources_v1.json index 5ffd55a5f0..17ba9b0636 100644 --- a/googleapiclient/discovery_cache/documents/merchantapi.datasources_v1.json +++ b/googleapiclient/discovery_cache/documents/merchantapi.datasources_v1.json @@ -321,7 +321,7 @@ } } }, -"revision": "20260303", +"revision": "20260527", "rootUrl": "https://merchantapi.googleapis.com/", "schemas": { "DataSource": { @@ -942,11 +942,13 @@ false "description": "The resource that changed, in this case it will always be `Product`.", "enum": [ "RESOURCE_UNSPECIFIED", -"PRODUCT" +"PRODUCT", +"ACCOUNT_SERVICE" ], "enumDescriptions": [ "Unspecified resource", -"Resource type : product" +"Resource type : product", +"Account service" ], "type": "string" } diff --git a/googleapiclient/discovery_cache/documents/merchantapi.datasources_v1beta.json b/googleapiclient/discovery_cache/documents/merchantapi.datasources_v1beta.json index 28f028d2ed..8955232cbf 100644 --- a/googleapiclient/discovery_cache/documents/merchantapi.datasources_v1beta.json +++ b/googleapiclient/discovery_cache/documents/merchantapi.datasources_v1beta.json @@ -321,7 +321,7 @@ } } }, -"revision": "20260303", +"revision": "20260527", "rootUrl": "https://merchantapi.googleapis.com/", "schemas": { "DataSource": { @@ -954,11 +954,13 @@ false "description": "The resource that changed, in this case it will always be `Product`.", "enum": [ "RESOURCE_UNSPECIFIED", -"PRODUCT" +"PRODUCT", +"ACCOUNT_SERVICE" ], "enumDescriptions": [ "Unspecified resource", -"Resource type : product" +"Resource type : product", +"Account service" ], "type": "string" } diff --git a/googleapiclient/discovery_cache/documents/merchantapi.inventories_v1.json b/googleapiclient/discovery_cache/documents/merchantapi.inventories_v1.json index 7ffe839d44..24af5ac11d 100644 --- a/googleapiclient/discovery_cache/documents/merchantapi.inventories_v1.json +++ b/googleapiclient/discovery_cache/documents/merchantapi.inventories_v1.json @@ -300,7 +300,7 @@ } } }, -"revision": "20260408", +"revision": "20260527", "rootUrl": "https://merchantapi.googleapis.com/", "schemas": { "Empty": { @@ -686,11 +686,13 @@ false "description": "The resource that changed, in this case it will always be `Product`.", "enum": [ "RESOURCE_UNSPECIFIED", -"PRODUCT" +"PRODUCT", +"ACCOUNT_SERVICE" ], "enumDescriptions": [ "Unspecified resource", -"Resource type : product" +"Resource type : product", +"Account service" ], "type": "string" } diff --git a/googleapiclient/discovery_cache/documents/merchantapi.inventories_v1beta.json b/googleapiclient/discovery_cache/documents/merchantapi.inventories_v1beta.json index e7a2e83fca..520ba617ba 100644 --- a/googleapiclient/discovery_cache/documents/merchantapi.inventories_v1beta.json +++ b/googleapiclient/discovery_cache/documents/merchantapi.inventories_v1beta.json @@ -300,7 +300,7 @@ } } }, -"revision": "20260411", +"revision": "20260527", "rootUrl": "https://merchantapi.googleapis.com/", "schemas": { "CustomAttribute": { @@ -610,11 +610,13 @@ false "description": "The resource that changed, in this case it will always be `Product`.", "enum": [ "RESOURCE_UNSPECIFIED", -"PRODUCT" +"PRODUCT", +"ACCOUNT_SERVICE" ], "enumDescriptions": [ "Unspecified resource", -"Resource type : product" +"Resource type : product", +"Account service" ], "type": "string" } diff --git a/googleapiclient/discovery_cache/documents/merchantapi.issueresolution_v1.json b/googleapiclient/discovery_cache/documents/merchantapi.issueresolution_v1.json index c0438a825b..1aa29dca8f 100644 --- a/googleapiclient/discovery_cache/documents/merchantapi.issueresolution_v1.json +++ b/googleapiclient/discovery_cache/documents/merchantapi.issueresolution_v1.json @@ -268,7 +268,7 @@ } } }, -"revision": "20260429", +"revision": "20260527", "rootUrl": "https://merchantapi.googleapis.com/", "schemas": { "Action": { @@ -986,11 +986,13 @@ false "description": "The resource that changed, in this case it will always be `Product`.", "enum": [ "RESOURCE_UNSPECIFIED", -"PRODUCT" +"PRODUCT", +"ACCOUNT_SERVICE" ], "enumDescriptions": [ "Unspecified resource", -"Resource type : product" +"Resource type : product", +"Account service" ], "type": "string" } diff --git a/googleapiclient/discovery_cache/documents/merchantapi.issueresolution_v1beta.json b/googleapiclient/discovery_cache/documents/merchantapi.issueresolution_v1beta.json index a6d883c131..a9e27b3dfa 100644 --- a/googleapiclient/discovery_cache/documents/merchantapi.issueresolution_v1beta.json +++ b/googleapiclient/discovery_cache/documents/merchantapi.issueresolution_v1beta.json @@ -268,7 +268,7 @@ } } }, -"revision": "20260429", +"revision": "20260527", "rootUrl": "https://merchantapi.googleapis.com/", "schemas": { "Action": { @@ -986,11 +986,13 @@ false "description": "The resource that changed, in this case it will always be `Product`.", "enum": [ "RESOURCE_UNSPECIFIED", -"PRODUCT" +"PRODUCT", +"ACCOUNT_SERVICE" ], "enumDescriptions": [ "Unspecified resource", -"Resource type : product" +"Resource type : product", +"Account service" ], "type": "string" } diff --git a/googleapiclient/discovery_cache/documents/merchantapi.lfp_v1.json b/googleapiclient/discovery_cache/documents/merchantapi.lfp_v1.json index 83599815ff..a43e1b2d0b 100644 --- a/googleapiclient/discovery_cache/documents/merchantapi.lfp_v1.json +++ b/googleapiclient/discovery_cache/documents/merchantapi.lfp_v1.json @@ -327,7 +327,7 @@ } } }, -"revision": "20260223", +"revision": "20260527", "rootUrl": "https://merchantapi.googleapis.com/", "schemas": { "CountrySettings": { @@ -886,11 +886,13 @@ false "description": "The resource that changed, in this case it will always be `Product`.", "enum": [ "RESOURCE_UNSPECIFIED", -"PRODUCT" +"PRODUCT", +"ACCOUNT_SERVICE" ], "enumDescriptions": [ "Unspecified resource", -"Resource type : product" +"Resource type : product", +"Account service" ], "type": "string" } diff --git a/googleapiclient/discovery_cache/documents/merchantapi.lfp_v1beta.json b/googleapiclient/discovery_cache/documents/merchantapi.lfp_v1beta.json index 4fc37aa339..f9424b21a8 100644 --- a/googleapiclient/discovery_cache/documents/merchantapi.lfp_v1beta.json +++ b/googleapiclient/discovery_cache/documents/merchantapi.lfp_v1beta.json @@ -327,7 +327,7 @@ } } }, -"revision": "20260223", +"revision": "20260527", "rootUrl": "https://merchantapi.googleapis.com/", "schemas": { "CountrySettings": { @@ -886,11 +886,13 @@ false "description": "The resource that changed, in this case it will always be `Product`.", "enum": [ "RESOURCE_UNSPECIFIED", -"PRODUCT" +"PRODUCT", +"ACCOUNT_SERVICE" ], "enumDescriptions": [ "Unspecified resource", -"Resource type : product" +"Resource type : product", +"Account service" ], "type": "string" } diff --git a/googleapiclient/discovery_cache/documents/merchantapi.notifications_v1.json b/googleapiclient/discovery_cache/documents/merchantapi.notifications_v1.json index 161591d308..d0f3717f75 100644 --- a/googleapiclient/discovery_cache/documents/merchantapi.notifications_v1.json +++ b/googleapiclient/discovery_cache/documents/merchantapi.notifications_v1.json @@ -262,7 +262,7 @@ } } }, -"revision": "20260223", +"revision": "20260527", "rootUrl": "https://merchantapi.googleapis.com/", "schemas": { "Empty": { @@ -467,11 +467,13 @@ false "description": "The resource that changed, in this case it will always be `Product`.", "enum": [ "RESOURCE_UNSPECIFIED", -"PRODUCT" +"PRODUCT", +"ACCOUNT_SERVICE" ], "enumDescriptions": [ "Unspecified resource", -"Resource type : product" +"Resource type : product", +"Account service" ], "type": "string" } diff --git a/googleapiclient/discovery_cache/documents/merchantapi.notifications_v1beta.json b/googleapiclient/discovery_cache/documents/merchantapi.notifications_v1beta.json index e4be7f79de..d93232f811 100644 --- a/googleapiclient/discovery_cache/documents/merchantapi.notifications_v1beta.json +++ b/googleapiclient/discovery_cache/documents/merchantapi.notifications_v1beta.json @@ -262,7 +262,7 @@ } } }, -"revision": "20260223", +"revision": "20260527", "rootUrl": "https://merchantapi.googleapis.com/", "schemas": { "Empty": { @@ -467,11 +467,13 @@ false "description": "The resource that changed, in this case it will always be `Product`.", "enum": [ "RESOURCE_UNSPECIFIED", -"PRODUCT" +"PRODUCT", +"ACCOUNT_SERVICE" ], "enumDescriptions": [ "Unspecified resource", -"Resource type : product" +"Resource type : product", +"Account service" ], "type": "string" } diff --git a/googleapiclient/discovery_cache/documents/merchantapi.ordertracking_v1.json b/googleapiclient/discovery_cache/documents/merchantapi.ordertracking_v1.json index 14587443f8..d9fea6aee6 100644 --- a/googleapiclient/discovery_cache/documents/merchantapi.ordertracking_v1.json +++ b/googleapiclient/discovery_cache/documents/merchantapi.ordertracking_v1.json @@ -147,7 +147,7 @@ } } }, -"revision": "20260221", +"revision": "20260527", "rootUrl": "https://merchantapi.googleapis.com/", "schemas": { "DateTime": { @@ -457,11 +457,13 @@ false "description": "The resource that changed, in this case it will always be `Product`.", "enum": [ "RESOURCE_UNSPECIFIED", -"PRODUCT" +"PRODUCT", +"ACCOUNT_SERVICE" ], "enumDescriptions": [ "Unspecified resource", -"Resource type : product" +"Resource type : product", +"Account service" ], "type": "string" } diff --git a/googleapiclient/discovery_cache/documents/merchantapi.ordertracking_v1beta.json b/googleapiclient/discovery_cache/documents/merchantapi.ordertracking_v1beta.json index ddcc28bb75..af7ad1dd9a 100644 --- a/googleapiclient/discovery_cache/documents/merchantapi.ordertracking_v1beta.json +++ b/googleapiclient/discovery_cache/documents/merchantapi.ordertracking_v1beta.json @@ -147,7 +147,7 @@ } } }, -"revision": "20260223", +"revision": "20260527", "rootUrl": "https://merchantapi.googleapis.com/", "schemas": { "DateTime": { @@ -462,11 +462,13 @@ false "description": "The resource that changed, in this case it will always be `Product`.", "enum": [ "RESOURCE_UNSPECIFIED", -"PRODUCT" +"PRODUCT", +"ACCOUNT_SERVICE" ], "enumDescriptions": [ "Unspecified resource", -"Resource type : product" +"Resource type : product", +"Account service" ], "type": "string" } diff --git a/googleapiclient/discovery_cache/documents/merchantapi.products_v1.json b/googleapiclient/discovery_cache/documents/merchantapi.products_v1.json index 4e9d507960..5bbd16a963 100644 --- a/googleapiclient/discovery_cache/documents/merchantapi.products_v1.json +++ b/googleapiclient/discovery_cache/documents/merchantapi.products_v1.json @@ -281,7 +281,7 @@ } } }, -"revision": "20260512", +"revision": "20260527", "rootUrl": "https://merchantapi.googleapis.com/", "schemas": { "AutomatedDiscounts": { @@ -643,7 +643,7 @@ ], "enumDescriptions": [ "Unspecified unit.", -"Grams per km." +"Grams per kilometer." ], "type": "string" }, @@ -793,7 +793,7 @@ false ], "enumDescriptions": [ "Unspecified unit.", -"Kilowatt hours per 100 km." +"Kilowatt hours per 100 kilometers." ], "type": "string" }, @@ -833,8 +833,8 @@ false ], "enumDescriptions": [ "Unspecified unit.", -"Liter per 100 km.", -"Kilograms per 100 km." +"Liter per 100 kilometers.", +"Kilograms per 100 kilometers." ], "type": "string" }, @@ -1486,6 +1486,13 @@ false "format": "double", "type": "number" }, +"documentLinks": { +"description": "Optional. Contains a list of PDF [document URLs](https://support.google.com/merchants/answer/17084656) for the product. Examples are training manuals, user guides, assembly instructions, package inserts, etc. Must start with \"http://\" or \"https://\"), ASCII characters only, and RFC 3986 compliant.", +"items": { +"type": "string" +}, +"type": "array" +}, "electricRange": { "$ref": "Mileage", "description": "The [electric range](https://support.google.com/google-ads/answer/15162232) of the vehicle in miles/kms." @@ -1738,6 +1745,10 @@ false "description": "Shared identifier for all variants of the same product.", "type": "string" }, +"itemGroupTitle": { +"description": "Optional. Represents the [title of the product group](https://support.google.com/merchants/answer/17085146) to which this variant product belongs. This can be used along with the [item group id](https://support.google.com/merchants/answer/6324507) attribute. It lets you perform better grouping of variant products, and helps identifying common product characteristics more efficiently.", +"type": "string" +}, "lifestyleImageLinks": { "description": "Additional URLs of lifestyle images of the item, used to explicitly identify images that showcase your item in a real-world context. See the [Help Center article](https://support.google.com/merchants/answer/9103186) for more information.", "items": { @@ -1940,6 +1951,11 @@ false ], "type": "string" }, +"popularityRank": { +"description": "Optional. Indicates the [popularity](https://support.google.com/merchants/answer/17085297) of the product in a merchant's inventory. Using a scale of 0.0 (lowest) to 100.0 (highest).", +"format": "float", +"type": "number" +}, "price": { "$ref": "Price", "description": "Price of the item." @@ -1988,6 +2004,20 @@ false }, "type": "array" }, +"questionsAndAnswers": { +"description": "Optional. Contains user-, merchant-, and manufacturer-authored [questions and answers](https://support.google.com/merchants/answer/17085211) about the product. Max 30 question and answer pairs. Max 5000 characters total. Each question can have max 1000 characters. Each answer can have max 1000 characters.", +"items": { +"$ref": "QuestionAndAnswer" +}, +"type": "array" +}, +"relatedProducts": { +"description": "Optional. Specifies how other [products are related](https://support.google.com/merchants/answer/17085213) to this product.", +"items": { +"$ref": "RelatedProduct" +}, +"type": "array" +}, "returnPolicyLabel": { "description": "The return label of the product, used to group products in account-level return policies. Max. 100 characters. For more information, see [Return policy label](https://support.google.com/merchants/answer/9445425).", "type": "string" @@ -2153,6 +2183,13 @@ false "$ref": "UnitPricingMeasure", "description": "The measure and dimension of an item." }, +"variantOptions": { +"description": "Optional. Contains the [list of all variant-identifying options](https://support.google.com/merchants/answer/17085214) of this product.", +"items": { +"$ref": "VariantOption" +}, +"type": "array" +}, "vehicleAllInPrice": { "$ref": "Price", "description": "The all-in advertised price for a vehicle, which includes costs for the following \u2013 any accessories attached to the vehicle, environmental levies, extra warranty, fuel, freight, pre-delivery inspection (PDI), dealer fees for handling licensing, provincial regulatory fees, miscellaneous dealer charges for security etching and nitrogen tire fill, and factory-to-customer or dealer-to-customer discounts or incentives. See the [Vehicle all-in price](https://support.google.com/google-ads/answer/14156981) for more information." @@ -2620,11 +2657,13 @@ false "description": "The resource that changed, in this case it will always be `Product`.", "enum": [ "RESOURCE_UNSPECIFIED", -"PRODUCT" +"PRODUCT", +"ACCOUNT_SERVICE" ], "enumDescriptions": [ "Unspecified resource", -"Resource type : product" +"Resource type : product", +"Account service" ], "type": "string" } @@ -2677,6 +2716,68 @@ false }, "type": "object" }, +"QuestionAndAnswer": { +"description": "The question and answer for the product.", +"id": "QuestionAndAnswer", +"properties": { +"answer": { +"description": "Required. The answer text.", +"type": "string" +}, +"question": { +"description": "Required. The question text.", +"type": "string" +} +}, +"type": "object" +}, +"RelatedProduct": { +"description": "Specifies how other products are related to this product.", +"id": "RelatedProduct", +"properties": { +"id": { +"description": "Required. The identifier of the related product.", +"type": "string" +}, +"idType": { +"description": "Required. The type of the identifier of the related product. For example, [GTIN](https://support.google.com/merchants/answer/6219078) or [product ID](https://support.google.com/merchants/answer/6324405).", +"enum": [ +"ID_TYPE_UNSPECIFIED", +"GTIN", +"ID" +], +"enumDescriptions": [ +"The identifier type is unspecified.", +"The identifier is a GTIN.", +"The identifier is a product ID in the feed." +], +"type": "string" +}, +"relationshipType": { +"description": "Required. The type of the relationship between this product and the related product.", +"enum": [ +"RELATIONSHIP_TYPE_UNSPECIFIED", +"PART_OF_SET", +"REQUIRED_PART", +"OFTEN_BOUGHT_WITH", +"SUBSTITUTE", +"DIFFERENT_BRAND", +"ACCESSORY" +], +"enumDescriptions": [ +"The relationship type is unspecified.", +"Part of a set of products that are often purchased together.", +"Part that is necessary for the product to function, for example a battery for a battery-operated lamp.", +"A product that this product is often purchased together with, for example a phone case with a phone.", +"Product that this product can be substituted for. For example a printer comparable in function to another printer.", +"An identical product sold under a different brand, for example a cheaper house brand.", +"An accessory to this product, for example a side table that matches the style of a couch." +], +"type": "string" +} +}, +"type": "object" +}, "Shipping": { "description": "The Shipping of the product.", "id": "Shipping", @@ -2910,6 +3011,21 @@ false }, "type": "object" }, +"VariantOption": { +"description": "Additional product variants for the product.", +"id": "VariantOption", +"properties": { +"name": { +"description": "Required. The name of the variant. For example, \"Color\", \"Memory\", \"Size\", \"Length\"", +"type": "string" +}, +"value": { +"description": "Required. The value of the variant. For example, \"Red\", \"128GB\", \"XL\", \"100cm\"", +"type": "string" +} +}, +"type": "object" +}, "Warranty": { "description": "The warranty of the vehicle.", "id": "Warranty", diff --git a/googleapiclient/discovery_cache/documents/merchantapi.products_v1beta.json b/googleapiclient/discovery_cache/documents/merchantapi.products_v1beta.json index d29ff4de41..e0412c49d8 100644 --- a/googleapiclient/discovery_cache/documents/merchantapi.products_v1beta.json +++ b/googleapiclient/discovery_cache/documents/merchantapi.products_v1beta.json @@ -281,7 +281,7 @@ } } }, -"revision": "20260512", +"revision": "20260527", "rootUrl": "https://merchantapi.googleapis.com/", "schemas": { "Attributes": { @@ -1602,11 +1602,13 @@ false "description": "The resource that changed, in this case it will always be `Product`.", "enum": [ "RESOURCE_UNSPECIFIED", -"PRODUCT" +"PRODUCT", +"ACCOUNT_SERVICE" ], "enumDescriptions": [ "Unspecified resource", -"Resource type : product" +"Resource type : product", +"Account service" ], "type": "string" } diff --git a/googleapiclient/discovery_cache/documents/merchantapi.promotions_v1.json b/googleapiclient/discovery_cache/documents/merchantapi.promotions_v1.json index 63a249cb12..9d5b475b16 100644 --- a/googleapiclient/discovery_cache/documents/merchantapi.promotions_v1.json +++ b/googleapiclient/discovery_cache/documents/merchantapi.promotions_v1.json @@ -203,7 +203,7 @@ } } }, -"revision": "20260228", +"revision": "20260527", "rootUrl": "https://merchantapi.googleapis.com/", "schemas": { "Attributes": { @@ -1015,11 +1015,13 @@ false "description": "The resource that changed, in this case it will always be `Product`.", "enum": [ "RESOURCE_UNSPECIFIED", -"PRODUCT" +"PRODUCT", +"ACCOUNT_SERVICE" ], "enumDescriptions": [ "Unspecified resource", -"Resource type : product" +"Resource type : product", +"Account service" ], "type": "string" } diff --git a/googleapiclient/discovery_cache/documents/merchantapi.promotions_v1beta.json b/googleapiclient/discovery_cache/documents/merchantapi.promotions_v1beta.json index df5081e2e8..6a993f4d97 100644 --- a/googleapiclient/discovery_cache/documents/merchantapi.promotions_v1beta.json +++ b/googleapiclient/discovery_cache/documents/merchantapi.promotions_v1beta.json @@ -203,7 +203,7 @@ } } }, -"revision": "20260228", +"revision": "20260527", "rootUrl": "https://merchantapi.googleapis.com/", "schemas": { "Attributes": { @@ -1015,11 +1015,13 @@ false "description": "The resource that changed, in this case it will always be `Product`.", "enum": [ "RESOURCE_UNSPECIFIED", -"PRODUCT" +"PRODUCT", +"ACCOUNT_SERVICE" ], "enumDescriptions": [ "Unspecified resource", -"Resource type : product" +"Resource type : product", +"Account service" ], "type": "string" } diff --git a/googleapiclient/discovery_cache/documents/merchantapi.quota_v1.json b/googleapiclient/discovery_cache/documents/merchantapi.quota_v1.json index c1ddd23df0..c17ac9810e 100644 --- a/googleapiclient/discovery_cache/documents/merchantapi.quota_v1.json +++ b/googleapiclient/discovery_cache/documents/merchantapi.quota_v1.json @@ -220,7 +220,7 @@ } } }, -"revision": "20260223", +"revision": "20260527", "rootUrl": "https://merchantapi.googleapis.com/", "schemas": { "AccountLimit": { @@ -469,11 +469,13 @@ false "description": "The resource that changed, in this case it will always be `Product`.", "enum": [ "RESOURCE_UNSPECIFIED", -"PRODUCT" +"PRODUCT", +"ACCOUNT_SERVICE" ], "enumDescriptions": [ "Unspecified resource", -"Resource type : product" +"Resource type : product", +"Account service" ], "type": "string" } diff --git a/googleapiclient/discovery_cache/documents/merchantapi.quota_v1beta.json b/googleapiclient/discovery_cache/documents/merchantapi.quota_v1beta.json index b3b5bd091d..6845057904 100644 --- a/googleapiclient/discovery_cache/documents/merchantapi.quota_v1beta.json +++ b/googleapiclient/discovery_cache/documents/merchantapi.quota_v1beta.json @@ -150,7 +150,7 @@ } } }, -"revision": "20260223", +"revision": "20260527", "rootUrl": "https://merchantapi.googleapis.com/", "schemas": { "ListQuotaGroupsResponse": { @@ -340,11 +340,13 @@ false "description": "The resource that changed, in this case it will always be `Product`.", "enum": [ "RESOURCE_UNSPECIFIED", -"PRODUCT" +"PRODUCT", +"ACCOUNT_SERVICE" ], "enumDescriptions": [ "Unspecified resource", -"Resource type : product" +"Resource type : product", +"Account service" ], "type": "string" } diff --git a/googleapiclient/discovery_cache/documents/merchantapi.reports_v1.json b/googleapiclient/discovery_cache/documents/merchantapi.reports_v1.json index 2438a0f855..069b834b06 100644 --- a/googleapiclient/discovery_cache/documents/merchantapi.reports_v1.json +++ b/googleapiclient/discovery_cache/documents/merchantapi.reports_v1.json @@ -142,7 +142,7 @@ } } }, -"revision": "20260411", +"revision": "20260527", "rootUrl": "https://merchantapi.googleapis.com/", "schemas": { "BestSellersBrandView": { @@ -1295,11 +1295,13 @@ false "description": "The resource that changed, in this case it will always be `Product`.", "enum": [ "RESOURCE_UNSPECIFIED", -"PRODUCT" +"PRODUCT", +"ACCOUNT_SERVICE" ], "enumDescriptions": [ "Unspecified resource", -"Resource type : product" +"Resource type : product", +"Account service" ], "type": "string" } diff --git a/googleapiclient/discovery_cache/documents/merchantapi.reports_v1beta.json b/googleapiclient/discovery_cache/documents/merchantapi.reports_v1beta.json index 94a9f0c147..49bc3547a6 100644 --- a/googleapiclient/discovery_cache/documents/merchantapi.reports_v1beta.json +++ b/googleapiclient/discovery_cache/documents/merchantapi.reports_v1beta.json @@ -142,7 +142,7 @@ } } }, -"revision": "20260411", +"revision": "20260527", "rootUrl": "https://merchantapi.googleapis.com/", "schemas": { "BestSellersBrandView": { @@ -1295,11 +1295,13 @@ false "description": "The resource that changed, in this case it will always be `Product`.", "enum": [ "RESOURCE_UNSPECIFIED", -"PRODUCT" +"PRODUCT", +"ACCOUNT_SERVICE" ], "enumDescriptions": [ "Unspecified resource", -"Resource type : product" +"Resource type : product", +"Account service" ], "type": "string" } diff --git a/googleapiclient/discovery_cache/documents/merchantapi.reviews_v1beta.json b/googleapiclient/discovery_cache/documents/merchantapi.reviews_v1beta.json index 2e41738412..6c3d4f04a6 100644 --- a/googleapiclient/discovery_cache/documents/merchantapi.reviews_v1beta.json +++ b/googleapiclient/discovery_cache/documents/merchantapi.reviews_v1beta.json @@ -356,7 +356,7 @@ } } }, -"revision": "20260223", +"revision": "20260527", "rootUrl": "https://merchantapi.googleapis.com/", "schemas": { "CustomAttribute": { @@ -1371,11 +1371,13 @@ false "description": "The resource that changed, in this case it will always be `Product`.", "enum": [ "RESOURCE_UNSPECIFIED", -"PRODUCT" +"PRODUCT", +"ACCOUNT_SERVICE" ], "enumDescriptions": [ "Unspecified resource", -"Resource type : product" +"Resource type : product", +"Account service" ], "type": "string" } diff --git a/googleapiclient/discovery_cache/documents/mybusinessverifications.v1.json b/googleapiclient/discovery_cache/documents/mybusinessverifications.v1.json index ef42b196ad..90dccaba84 100644 --- a/googleapiclient/discovery_cache/documents/mybusinessverifications.v1.json +++ b/googleapiclient/discovery_cache/documents/mybusinessverifications.v1.json @@ -256,7 +256,7 @@ } } }, -"revision": "20260415", +"revision": "20260527", "rootUrl": "https://mybusinessverifications.googleapis.com/", "schemas": { "AddressVerificationData": { @@ -374,10 +374,6 @@ "description": "Request message for Verifications.GenerateInstantVerificationToken.", "id": "GenerateInstantVerificationTokenRequest", "properties": { -"locationData": { -"$ref": "LocationData", -"description": "Immutable. The address and other details of the location to generate an instant verification token for." -}, "locationId": { "description": "The location identifier associated with an unverified listing. This is the location id generated at the time that the listing was originally created. It is the final portion of a location resource name as generated by the Google My Business API. Note: the caller must be an owner or manager of this listing in order to generate a verification token. See the [location resource](/my-business/reference/rest/v4/accounts.locations) documentation for more information.", "type": "string" @@ -429,21 +425,6 @@ }, "type": "object" }, -"LocationData": { -"description": "The address and other details of the location to generate an instant verification token for.", -"id": "LocationData", -"properties": { -"address": { -"$ref": "PostalAddress", -"description": "Immutable. A precise, accurate address to describe your business location. PO boxes or mailboxes located at remote locations are not acceptable. At this time, you can specify a maximum of five `address_lines` values in the address." -}, -"name": { -"description": "Immutable. Name should reflect your business's real-world name, as used consistently on your storefront, website, and stationery, and as known to customers. Any additional information, when relevant, can be included in other fields of the resource (for example, `Address`, `Categories`). Don't add unnecessary information to your name (for example, prefer \"Google\" over \"Google Inc. - Mountain View Corporate Headquarters\"). Don't include marketing taglines, store codes, special characters, hours or closed/open status, phone numbers, website URLs, service/product information, location/address or directions, or containment information (for example, \"Chase ATM in Duane Reade\").", -"type": "string" -} -}, -"type": "object" -}, "PostalAddress": { "description": "Represents a postal address, such as for postal delivery or payments addresses. With a postal address, a postal service can deliver items to a premise, P.O. box, or similar. A postal address is not intended to model geographical locations like roads, towns, or mountains. In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478.", "id": "PostalAddress", diff --git a/googleapiclient/discovery_cache/documents/netapp.v1.json b/googleapiclient/discovery_cache/documents/netapp.v1.json index 2274f42537..26c930df08 100644 --- a/googleapiclient/discovery_cache/documents/netapp.v1.json +++ b/googleapiclient/discovery_cache/documents/netapp.v1.json @@ -1753,6 +1753,34 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, +"restoreVolume": { +"description": "Restores a backup to an ONTAP-mode volume.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/storagePools/{storagePoolsId}:restoreVolume", +"httpMethod": "POST", +"id": "netapp.projects.locations.storagePools.restoreVolume", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The resource name of the ONTAP mode storage pool, in the format of `projects/{project}/locations/{location}/storagePools/{storage_pool}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/storagePools/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}:restoreVolume", +"request": { +"$ref": "RestoreVolumeRequest" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, "switch": { "description": "This operation will switch the active/replica zone for a regional storagePool.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/storagePools/{storagePoolsId}:switch", @@ -1781,6 +1809,34 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, +"updateBackupConfig": { +"description": "Updates the backup configuration for an ONTAP-mode volume.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/storagePools/{storagePoolsId}:updateBackupConfig", +"httpMethod": "POST", +"id": "netapp.projects.locations.storagePools.updateBackupConfig", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The resource name of the StoragePool, in the format: projects/{projectNumber}/locations/{locationId}/storagePools/{poolId}", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/storagePools/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}:updateBackupConfig", +"request": { +"$ref": "UpdateBackupConfigRequest" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, "validateDirectoryService": { "description": "ValidateDirectoryService does a connectivity check for a directory service policy attached to the storage pool.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/storagePools/{storagePoolsId}:validateDirectoryService", @@ -1811,6 +1867,56 @@ } }, "resources": { +"backupConfigs": { +"methods": { +"list": { +"description": "Lists backup configurations for all volumes in an ONTAP-mode Storage Pool.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/storagePools/{storagePoolsId}/backupConfigs", +"httpMethod": "GET", +"id": "netapp.projects.locations.storagePools.backupConfigs.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"filter": { +"description": "Optional. The standard list filter.", +"location": "query", +"type": "string" +}, +"orderBy": { +"description": "Optional. Sort results. Supported values are \"volume_id\" or \"\"", +"location": "query", +"type": "string" +}, +"pageSize": { +"description": "Optional. The maximum number of items to return. The service may return fewer than this value. The maximum value is 1000; values above 1000 will be coerced to 1000. If unspecified or set to 0, a default of 50 will be used.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "Optional. The next_page_token value to use if there are additional results to retrieve for this list request.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The ONTAP StoragePool for which to retrieve backup configuration information, in the format `projects/{project}/locations/{location}/storagePools/{storage_pool}`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/storagePools/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+parent}/backupConfigs", +"response": { +"$ref": "ListBackupConfigsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +}, "ontap": { "methods": { "executeOntapDelete": { @@ -2827,7 +2933,7 @@ } } }, -"revision": "20260513", +"revision": "20260518", "rootUrl": "https://netapp.googleapis.com/", "schemas": { "ActiveDirectory": { @@ -3018,6 +3124,10 @@ "description": "Identifier. The resource name of the backup. Format: `projects/{project_id}/locations/{location}/backupVaults/{backup_vault_id}/backups/{backup_id}`.", "type": "string" }, +"ontapSource": { +"$ref": "OntapSource", +"description": "Optional. Represents source details for ONTAP backups. Either source_volume or ontap_source should be provided." +}, "satisfiesPzi": { "description": "Output only. Reserved for future use", "readOnly": true, @@ -3203,6 +3313,24 @@ }, "type": "object" }, +"BackupSource": { +"description": "Represents the backup source of the restore operation.", +"id": "BackupSource", +"properties": { +"backup": { +"description": "Required. The backup resource name.", +"type": "string" +}, +"fileList": { +"description": "Optional. List of files to be restored in the form of their absolute path as in source volume. If provided, only these files will be restored. If not provided, the entire backup will be restored (Full Backup Restore)", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, "BackupVault": { "description": "A NetApp BackupVault.", "id": "BackupVault", @@ -4088,6 +4216,31 @@ }, "type": "object" }, +"ListBackupConfigsResponse": { +"description": "Message for response to listing BackupConfigs in an ONTAP StoragePool.", +"id": "ListBackupConfigsResponse", +"properties": { +"nextPageToken": { +"description": "The token you can use to retrieve the next page of results. Not returned if there are no more results in the list.", +"type": "string" +}, +"unreachable": { +"description": "Unordered list. Locations that could not be reached.", +"items": { +"type": "string" +}, +"type": "array" +}, +"volumeBackupConfigs": { +"description": "A list of backup configurations for volumes in the pool.", +"items": { +"$ref": "VolumeBackupConfig" +}, +"type": "array" +} +}, +"type": "object" +}, "ListBackupPoliciesResponse": { "description": "ListBackupPoliciesResponse contains all the backup policies requested.", "id": "ListBackupPoliciesResponse", @@ -4542,6 +4695,40 @@ }, "type": "object" }, +"OntapSource": { +"description": "Represents ONTAP source details.", +"id": "OntapSource", +"properties": { +"snapshotUuid": { +"description": "Optional. The UUID of the ONTAP source snapshot.", +"type": "string" +}, +"storagePool": { +"description": "Required. Name of the storage pool. This must be specified for creating backups for ONTAP mode volumes. Format: `projects/{projects_id}/locations/{location}/storagePools/{storage_pool_id}`", +"type": "string" +}, +"volumeUuid": { +"description": "Required. The UUID of the ONTAP source volume.", +"type": "string" +} +}, +"type": "object" +}, +"OntapVolumeTarget": { +"description": "Represents the ONTAP volume target of the restore operation.", +"id": "OntapVolumeTarget", +"properties": { +"restoreDestinationPath": { +"description": "Optional. Absolute directory path in the destination volume.", +"type": "string" +}, +"volumeUuid": { +"description": "Required. The UUID of the ONTAP volume to restore to.", +"type": "string" +} +}, +"type": "object" +}, "Operation": { "description": "This resource represents a long-running operation that is the result of a network API call.", "id": "Operation", @@ -4916,6 +5103,21 @@ }, "type": "object" }, +"RestoreVolumeRequest": { +"description": "Request message for `RestoreVolume` API.", +"id": "RestoreVolumeRequest", +"properties": { +"backupSource": { +"$ref": "BackupSource", +"description": "The backup source of the restore operation." +}, +"ontapVolumeTarget": { +"$ref": "OntapVolumeTarget", +"description": "The ONTAP volume target of the restore operation." +} +}, +"type": "object" +}, "ResumeReplicationRequest": { "description": "ResumeReplicationRequest resumes a stopped replication.", "id": "ResumeReplicationRequest", @@ -5490,6 +5692,26 @@ }, "type": "object" }, +"UpdateBackupConfigRequest": { +"description": "Request message for UpdateBackupConfig", +"id": "UpdateBackupConfigRequest", +"properties": { +"backupConfig": { +"$ref": "BackupConfig", +"description": "Required. Backup configuration to apply." +}, +"updateMask": { +"description": "Required. Field mask is used to specify the fields to be overwritten in the BackupConfig for the Volume. 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.", +"format": "google-fieldmask", +"type": "string" +}, +"volumeUuid": { +"description": "Required. The UUID of the ONTAP-mode volume.", +"type": "string" +} +}, +"type": "object" +}, "UserCommands": { "description": "UserCommands contains the commands to be executed by the customer.", "id": "UserCommands", @@ -5884,6 +6106,21 @@ }, "type": "object" }, +"VolumeBackupConfig": { +"description": "Backup configuration for a volume in a pool.", +"id": "VolumeBackupConfig", +"properties": { +"backupConfig": { +"$ref": "BackupConfig", +"description": "Backup configuration for the volume." +}, +"volumeUuid": { +"description": "Provides the Ontap UUID of the volume within the pool.", +"type": "string" +} +}, +"type": "object" +}, "WeeklySchedule": { "description": "Make a snapshot every week e.g. at Monday 04:00, Wednesday 05:20, Sunday 23:50", "id": "WeeklySchedule", diff --git a/googleapiclient/discovery_cache/documents/netapp.v1beta1.json b/googleapiclient/discovery_cache/documents/netapp.v1beta1.json index 1587482d4c..404d03ef82 100644 --- a/googleapiclient/discovery_cache/documents/netapp.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/netapp.v1beta1.json @@ -2,6 +2,9 @@ "auth": { "oauth2": { "scopes": { +"https://www.googleapis.com/auth/cloud-netapp": { +"description": "See, edit, configure, and delete your Google Cloud NetApp data and see the email address for your Google Account" +}, "https://www.googleapis.com/auth/cloud-platform": { "description": "See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account." } @@ -649,6 +652,7 @@ "$ref": "BackupPolicy" }, "scopes": [ +"https://www.googleapis.com/auth/cloud-netapp", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -695,6 +699,7 @@ "$ref": "ListBackupPoliciesResponse" }, "scopes": [ +"https://www.googleapis.com/auth/cloud-netapp", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -816,6 +821,7 @@ "$ref": "BackupVault" }, "scopes": [ +"https://www.googleapis.com/auth/cloud-netapp", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -862,6 +868,7 @@ "$ref": "ListBackupVaultsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/cloud-netapp", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -933,6 +940,7 @@ "$ref": "Operation" }, "scopes": [ +"https://www.googleapis.com/auth/cloud-netapp", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -983,6 +991,7 @@ "$ref": "Backup" }, "scopes": [ +"https://www.googleapis.com/auth/cloud-netapp", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -1029,6 +1038,7 @@ "$ref": "ListBackupsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/cloud-netapp", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -1670,6 +1680,7 @@ "$ref": "StoragePool" }, "scopes": [ +"https://www.googleapis.com/auth/cloud-netapp", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -1716,6 +1727,7 @@ "$ref": "ListStoragePoolsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/cloud-netapp", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -2144,6 +2156,7 @@ "$ref": "Volume" }, "scopes": [ +"https://www.googleapis.com/auth/cloud-netapp", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -2190,6 +2203,7 @@ "$ref": "ListVolumesResponse" }, "scopes": [ +"https://www.googleapis.com/auth/cloud-netapp", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -2791,6 +2805,7 @@ "$ref": "Operation" }, "scopes": [ +"https://www.googleapis.com/auth/cloud-netapp", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -2841,6 +2856,7 @@ "$ref": "Snapshot" }, "scopes": [ +"https://www.googleapis.com/auth/cloud-netapp", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -2887,6 +2903,7 @@ "$ref": "ListSnapshotsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/cloud-netapp", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -2933,7 +2950,7 @@ } } }, -"revision": "20260513", +"revision": "20260518", "rootUrl": "https://netapp.googleapis.com/", "schemas": { "ActiveDirectory": { diff --git a/googleapiclient/discovery_cache/documents/networkmanagement.v1.json b/googleapiclient/discovery_cache/documents/networkmanagement.v1.json index b2a332e6a3..d1b1c5ef87 100644 --- a/googleapiclient/discovery_cache/documents/networkmanagement.v1.json +++ b/googleapiclient/discovery_cache/documents/networkmanagement.v1.json @@ -978,6 +978,564 @@ } } }, +"networkMonitoringProviders": { +"methods": { +"create": { +"description": "Creates a NetworkMonitoringProvider resource.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/networkMonitoringProviders", +"httpMethod": "POST", +"id": "networkmanagement.projects.locations.networkMonitoringProviders.create", +"parameterOrder": [ +"parent" +], +"parameters": { +"networkMonitoringProviderId": { +"description": "Required. The ID to use for the NetworkMonitoringProvider resource, which will become the final component of the NetworkMonitoringProvider resource's name.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. Parent value for CreateNetworkMonitoringProviderRequest. Format: projects/{project}/locations/{location}", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+parent}/networkMonitoringProviders", +"request": { +"$ref": "NetworkMonitoringProvider" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"delete": { +"description": "Deletes a NetworkMonitoringProvider resource and all of its child resources.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/networkMonitoringProviders/{networkMonitoringProvidersId}", +"httpMethod": "DELETE", +"id": "networkmanagement.projects.locations.networkMonitoringProviders.delete", +"parameterOrder": [ +"name" +], +"parameters": { +"force": { +"description": "Optional. If set to true, any nested MonitoringPoints, NetworkPaths and WebPaths resources from this NetworkMonitoringProvider will also be deleted. Otherwise, the request will only work if there are no nested resources.", +"location": "query", +"type": "boolean" +}, +"name": { +"description": "Required. Name of the resource. Format: projects/{project}/locations/{location}/networkMonitoringProviders/{network_monitoring_provider}", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/networkMonitoringProviders/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}", +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"generateMonitoringPointConfig": { +"description": "Generates Monitoring Point configuration of a NetworkMonitoringProvider resource.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/networkMonitoringProviders/{networkMonitoringProvidersId}:generateMonitoringPointConfig", +"httpMethod": "GET", +"id": "networkmanagement.projects.locations.networkMonitoringProviders.generateMonitoringPointConfig", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. Name of the resource. Format: projects/{project}/locations/{location}/networkMonitoringProviders/{network_monitoring_provider}", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/networkMonitoringProviders/[^/]+$", +"required": true, +"type": "string" +}, +"privateConnectivityEnabled": { +"description": "Optional. For Google Cloud MPs, this field indicates whether the Monitoring Point is deployed in a Private Service Connect deployment. Not used for non-Google Cloud MPs.", +"location": "query", +"type": "boolean" +} +}, +"path": "v1/{+name}:generateMonitoringPointConfig", +"response": { +"$ref": "GenerateMonitoringPointConfigResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"generateProviderAccessToken": { +"description": "Generates a provider access token for a given Google access token. Provider access token is a short-lived token that is used to access resources in the provider's platform.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/networkMonitoringProviders/{networkMonitoringProvidersId}:generateProviderAccessToken", +"httpMethod": "GET", +"id": "networkmanagement.projects.locations.networkMonitoringProviders.generateProviderAccessToken", +"parameterOrder": [ +"name" +], +"parameters": { +"gcpAccessToken": { +"description": "Required. Google access token.", +"location": "query", +"type": "string" +}, +"name": { +"description": "Required. Name of the resource. Format: projects/{project}/locations/{location}/networkMonitoringProviders/{network_monitoring_provider}", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/networkMonitoringProviders/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}:generateProviderAccessToken", +"response": { +"$ref": "GenerateProviderAccessTokenResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"get": { +"description": "Gets the NetworkMonitoringProvider resource.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/networkMonitoringProviders/{networkMonitoringProvidersId}", +"httpMethod": "GET", +"id": "networkmanagement.projects.locations.networkMonitoringProviders.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. Name of the resource. Format: `projects/{project}/locations/{location}/networkMonitoringProviders/{network_monitoring_provider}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/networkMonitoringProviders/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}", +"response": { +"$ref": "NetworkMonitoringProvider" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"list": { +"description": "Lists NetworkMonitoringProviders for a given project and location.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/networkMonitoringProviders", +"httpMethod": "GET", +"id": "networkmanagement.projects.locations.networkMonitoringProviders.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"pageSize": { +"description": "Optional. The maximum number of monitoring points to return. The service may return fewer than this value. If unspecified, at most 20 monitoring points will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "Optional. A page token, received from a previous `ListMonitoringPoints` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListMonitoringPoints` must match the call that provided the page token.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. Parent value for ListNetworkMonitoringProvidersRequest. Format: `projects/{project}/locations/{location}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+parent}/networkMonitoringProviders", +"response": { +"$ref": "ListNetworkMonitoringProvidersResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +}, +"resources": { +"monitoringPoints": { +"methods": { +"downloadInstallScript": { +"description": "Downloads an install script for MonitoringPoints for a given network monitoring provider.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/networkMonitoringProviders/{networkMonitoringProvidersId}/monitoringPoints:downloadInstallScript", +"httpMethod": "GET", +"id": "networkmanagement.projects.locations.networkMonitoringProviders.monitoringPoints.downloadInstallScript", +"parameterOrder": [ +"parent" +], +"parameters": { +"_password": { +"description": "Optional. Password for logging into the MonitoringPoint.", +"location": "query", +"type": "string" +}, +"hostname": { +"description": "Required. The hostname of the MonitoringPoint, e.g. \"test-vm\"", +"location": "query", +"type": "string" +}, +"monitoringPointType": { +"description": "Required. The type of the monitoring point.", +"enum": [ +"MONITORING_POINT_TYPE_UNSPECIFIED", +"CONTAINER", +"KVM", +"VMWARE", +"HELM", +"GCE_VM", +"AZURE_VM" +], +"enumDescriptions": [ +"This value should not be used.", +"Monitoring Point that runs in a Docker container.", +"Monitoring Point that runs in a Kernel-based Virtual Machine (KVM) hypervisor.", +"Monitoring Point that runs in a VMware hypervisor.", +"Monitoring Point that runs on a K8S Helm.", +"Monitoring Point that runs as a startup script in a Compute Engine VM.", +"Monitoring Point that runs as a startup script in an Azure VM." +], +"location": "query", +"type": "string" +}, +"ntpServerAddress": { +"description": "Optional. Network Time Protocol a user can configure. If the user omits the field, the default is either NTP servers provided in the DHCP lease or a set of well-known NTP servers pre-configured on the monitoring point. This field can be an IP address or FQDN.", +"location": "query", +"type": "string" +}, +"ntpServerSecondaryAddress": { +"description": "Optional. Second NTP server.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. Parent value for DownloadInstallScriptRequest. Format: projects/{project}/locations/{location}/networkMonitoringProviders/{network_monitoring_provider}", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/networkMonitoringProviders/[^/]+$", +"required": true, +"type": "string" +}, +"privateConnectivityEnabled": { +"description": "Optional. For Google Cloud MPs, this field indicates whether the Monitoring Point is deployed in a Private Service Connect deployment. Not used for non-Google Cloud MPs.", +"location": "query", +"type": "boolean" +}, +"staticIpAddress.dnsServerAddress": { +"description": "Required. DNS server.", +"location": "query", +"type": "string" +}, +"staticIpAddress.dnsServerSecondaryAddress": { +"description": "Optional. Second DNS server.", +"location": "query", +"type": "string" +}, +"staticIpAddress.domain": { +"description": "Optional. Domain name of the MonitoringPoint.", +"location": "query", +"type": "string" +}, +"staticIpAddress.gatewayAddress": { +"description": "Required. Gateway IP address. Example: \"100.80.40.1\".", +"location": "query", +"type": "string" +}, +"staticIpAddress.ipAddress": { +"description": "Required. IP address of the MonitoringPoint.", +"location": "query", +"type": "string" +}, +"staticIpAddress.netmask": { +"description": "Optional. Networkmask and CIDR range. Example: \"255.255.255.0/24\"", +"location": "query", +"type": "string" +}, +"timeZone.id": { +"description": "IANA Time Zone Database time zone. For example \"America/New_York\".", +"location": "query", +"type": "string" +}, +"timeZone.version": { +"description": "Optional. IANA Time Zone Database version number. For example \"2019a\".", +"location": "query", +"type": "string" +}, +"useDhcp": { +"description": "Optional. Dynamic Host Configuration Protocol, is a network management protocol that automatically assigns IP addresses and other network configuration parameters to devices connecting to a network.", +"location": "query", +"type": "boolean" +} +}, +"path": "v1/{+parent}/monitoringPoints:downloadInstallScript", +"response": { +"$ref": "HttpBody" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"downloadRecreateInstallScript": { +"description": "Downloads an install script for a specific Container MonitoringPoint.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/networkMonitoringProviders/{networkMonitoringProvidersId}/monitoringPoints/{monitoringPointsId}:downloadRecreateInstallScript", +"httpMethod": "GET", +"id": "networkmanagement.projects.locations.networkMonitoringProviders.monitoringPoints.downloadRecreateInstallScript", +"parameterOrder": [ +"name" +], +"parameters": { +"hostname": { +"description": "Optional. The hostname of the MonitoringPoint, e.g. \"test-vm\"", +"location": "query", +"type": "string" +}, +"name": { +"description": "Required. Resource name of the MonitoringPoint. Format: projects/{project}/locations/{location}/networkMonitoringProviders/{network_monitoring_provider}/monitoringPoints/{monitoring_point}", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/networkMonitoringProviders/[^/]+/monitoringPoints/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}:downloadRecreateInstallScript", +"response": { +"$ref": "HttpBody" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"downloadServerConnectConfig": { +"description": "Downloads the server connect configuration for a given network monitoring provider.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/networkMonitoringProviders/{networkMonitoringProvidersId}/monitoringPoints:downloadServerConnectConfig", +"httpMethod": "GET", +"id": "networkmanagement.projects.locations.networkMonitoringProviders.monitoringPoints.downloadServerConnectConfig", +"parameterOrder": [ +"parent" +], +"parameters": { +"parent": { +"description": "Required. Parent value for DownloadServerConnectConfigRequest. Format: projects/{project}/locations/{location}/networkMonitoringProviders/{network_monitoring_provider}", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/networkMonitoringProviders/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+parent}/monitoringPoints:downloadServerConnectConfig", +"response": { +"$ref": "HttpBody" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"get": { +"description": "Gets the MonitoringPoint resource.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/networkMonitoringProviders/{networkMonitoringProvidersId}/monitoringPoints/{monitoringPointsId}", +"httpMethod": "GET", +"id": "networkmanagement.projects.locations.networkMonitoringProviders.monitoringPoints.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. Name of the resource. Format: projects/{project}/locations/{location}/networkMonitoringProviders/{network_monitoring_provider}/monitoringPoints/{monitoring_point}", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/networkMonitoringProviders/[^/]+/monitoringPoints/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}", +"response": { +"$ref": "MonitoringPoint" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"list": { +"description": "Lists MonitoringPoints for a given network monitoring provider.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/networkMonitoringProviders/{networkMonitoringProvidersId}/monitoringPoints", +"httpMethod": "GET", +"id": "networkmanagement.projects.locations.networkMonitoringProviders.monitoringPoints.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"pageSize": { +"description": "Optional. The maximum number of monitoring points to return. The service may return fewer than this value. If unspecified, at most 20 monitoring points will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "Optional. A page token, received from a previous `ListMonitoringPoints` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListMonitoringPoints` must match the call that provided the page token.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. Parent value for ListMonitoringPointsRequest. Format: projects/{project}/locations/{location}/networkMonitoringProviders/{network_monitoring_provider}", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/networkMonitoringProviders/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+parent}/monitoringPoints", +"response": { +"$ref": "ListMonitoringPointsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +}, +"networkPaths": { +"methods": { +"get": { +"description": "Gets the NetworkPath resource.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/networkMonitoringProviders/{networkMonitoringProvidersId}/networkPaths/{networkPathsId}", +"httpMethod": "GET", +"id": "networkmanagement.projects.locations.networkMonitoringProviders.networkPaths.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. Name of the resource. Format: projects/{project}/locations/{location}/networkMonitoringProviders/{network_monitoring_provider}/networkPaths/{network_path}", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/networkMonitoringProviders/[^/]+/networkPaths/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}", +"response": { +"$ref": "NetworkPath" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"list": { +"description": "Lists NetworkPaths for a given network monitoring provider.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/networkMonitoringProviders/{networkMonitoringProvidersId}/networkPaths", +"httpMethod": "GET", +"id": "networkmanagement.projects.locations.networkMonitoringProviders.networkPaths.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"pageSize": { +"description": "Optional. The maximum number of network paths to return. The service may return fewer than this value. If unspecified, at most 20 network pathswill be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "Optional. A page token, received from a previous `ListNetworkPaths` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListNetworkPaths` must match the call that provided the page token.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. Parent value for ListNetworkPathsRequest. Format: projects/{project}/locations/{location}/networkMonitoringProviders/{network_monitoring_provider}", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/networkMonitoringProviders/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+parent}/networkPaths", +"response": { +"$ref": "ListNetworkPathsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +}, +"webPaths": { +"methods": { +"get": { +"description": "Gets the WebPath resource.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/networkMonitoringProviders/{networkMonitoringProvidersId}/webPaths/{webPathsId}", +"httpMethod": "GET", +"id": "networkmanagement.projects.locations.networkMonitoringProviders.webPaths.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. Name of the resource.. Format: projects/{project}/locations/{location}/networkMonitoringProviders/{network_monitoring_provider}/webPaths/{web_path}", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/networkMonitoringProviders/[^/]+/webPaths/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}", +"response": { +"$ref": "WebPath" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"list": { +"description": "Lists WebPaths for a given network monitoring provider.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/networkMonitoringProviders/{networkMonitoringProvidersId}/webPaths", +"httpMethod": "GET", +"id": "networkmanagement.projects.locations.networkMonitoringProviders.webPaths.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"pageSize": { +"description": "Optional. The maximum number of web paths to return. The service may return fewer than this value. If unspecified, at most 20 web paths will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "Optional. A page token, received from a previous `ListWebPaths` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListWebPaths` must match the call that provided the page token.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. Parent value for ListWebPathsRequest. Format: projects/{project}/locations/{location}/networkMonitoringProviders/{network_monitoring_provider}", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/networkMonitoringProviders/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+parent}/webPaths", +"response": { +"$ref": "ListWebPathsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +} +} +}, "vpcFlowLogsConfigs": { "methods": { "create": { @@ -1237,7 +1795,7 @@ } } }, -"revision": "20260506", +"revision": "20260520", "rootUrl": "https://networkmanagement.googleapis.com/", "schemas": { "AbortInfo": { @@ -1552,6 +2110,25 @@ false }, "type": "object" }, +"CloudRunJobInfo": { +"description": "For display only. Metadata associated with a Cloud Run job.", +"id": "CloudRunJobInfo", +"properties": { +"displayName": { +"description": "Name of a Cloud Run job.", +"type": "string" +}, +"location": { +"description": "Location in which this job is deployed.", +"type": "string" +}, +"uri": { +"description": "URI of a Cloud Run job.", +"type": "string" +} +}, +"type": "object" +}, "CloudRunRevisionEndpoint": { "description": "Wrapper for Cloud Run revision attributes.", "id": "CloudRunRevisionEndpoint", @@ -1764,7 +2341,10 @@ false "GOOGLE_MANAGED_SERVICE", "REDIS_INSTANCE", "REDIS_CLUSTER", -"GKE_POD" +"GKE_POD", +"CLOUD_RUN_JOB", +"DMS_PRIVATE_CONNECTION", +"DATASTREAM_PRIVATE_CONNECTION" ], "enumDescriptions": [ "Target not specified.", @@ -1785,7 +2365,10 @@ false "Target is a Google-managed service. Used only for return traces.", "Target is a Redis Instance.", "Target is a Redis Cluster.", -"Target is a GKE Pod." +"Target is a GKE Pod.", +"Target is a Cloud Run Job. Used only for return traces.", +"Target is a DMS Private Connection. Used only for return traces.", +"Target is a Datastream Private Connection. Used only for return traces." ], "type": "string" } @@ -1866,6 +2449,8 @@ false "CLOUD_SQL_INSTANCE_UNAUTHORIZED_ACCESS", "DROPPED_INSIDE_GKE_SERVICE", "DROPPED_INSIDE_CLOUD_SQL_SERVICE", +"DROPPED_INSIDE_DMS_PRIVATE_CONNECTION", +"DROPPED_INSIDE_DATASTREAM_PRIVATE_CONNECTION", "GOOGLE_MANAGED_SERVICE_NO_PEERING", "GOOGLE_MANAGED_SERVICE_NO_PSC_ENDPOINT", "GKE_PSC_ENDPOINT_MISSING", @@ -1893,6 +2478,7 @@ false "HYBRID_NEG_NON_DYNAMIC_ROUTE_MATCHED", "HYBRID_NEG_NON_LOCAL_DYNAMIC_ROUTE_MATCHED", "CLOUD_RUN_REVISION_NOT_READY", +"CLOUD_RUN_JOB_NOT_READY", "DROPPED_INSIDE_PSC_SERVICE_PRODUCER", "LOAD_BALANCER_HAS_NO_PROXY_SUBNET", "CLOUD_NAT_NO_ADDRESSES", @@ -1975,6 +2561,8 @@ false "Access to the Cloud SQL instance endpoint is not authorized. See [Authorizing with authorized networks](https://cloud.google.com/sql/docs/mysql/authorize-networks) for more details.", "Packet was dropped inside Google Kubernetes Engine Service.", "Packet was dropped inside Cloud SQL Service.", +"Packet was dropped inside DMS Private Connection.", +"Packet was dropped inside Datastream Private Connection.", "Packet was dropped because there is no peering between the originating network and the Google Managed Services Network.", "Packet was dropped because the Google-managed service uses Private Service Connect (PSC), but the PSC endpoint is not found in the project.", "Packet was dropped because the GKE cluster uses Private Service Connect (PSC), but the PSC endpoint is not found in the project.", @@ -2002,6 +2590,7 @@ false "The packet sent from the hybrid NEG proxy matches a non-dynamic route, but such a configuration is not supported.", "The packet sent from the hybrid NEG proxy matches a dynamic route with a next hop in a different region, but such a configuration is not supported.", "Packet sent from a Cloud Run revision that is not ready.", +"Packet sent from a Cloud Run job that is not ready.", "Packet was dropped inside Private Service Connect service producer.", "Packet sent to a load balancer, which requires a proxy-only subnet and the subnet is not found.", "Packet sent to Cloud Nat without active NAT IPs.", @@ -2664,6 +3253,47 @@ false }, "type": "object" }, +"GenerateMonitoringPointConfigResponse": { +"description": "Message for response for getting Monitoring Point configuration of a NetworkMonitoringProvider resource.", +"id": "GenerateMonitoringPointConfigResponse", +"properties": { +"config": { +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" +}, +"description": "The Monitoring Point configuration of the provider in JSON format.", +"type": "object" +} +}, +"type": "object" +}, +"GenerateProviderAccessTokenResponse": { +"description": "Message for response for generating an access token for a NetworkMonitoringProvider resource.", +"id": "GenerateProviderAccessTokenResponse", +"properties": { +"providerAccessToken": { +"description": "Provider access token for the NetworkMonitoringProvider resource.", +"type": "string" +} +}, +"type": "object" +}, +"GeoLocation": { +"description": "The geographical location of the MonitoringPoint.", +"id": "GeoLocation", +"properties": { +"formattedAddress": { +"description": "Formatted address.", +"type": "string" +}, +"regionCode": { +"description": "Unicode CLDR region code.", +"type": "string" +} +}, +"type": "object" +}, "GkeNetworkPolicyInfo": { "description": "For display only. Metadata associated with a GKE Network Policy.", "id": "GkeNetworkPolicyInfo", @@ -2768,6 +3398,78 @@ false }, "type": "object" }, +"Host": { +"description": "Message describing information about the host.", +"id": "Host", +"properties": { +"cloudInstanceId": { +"description": "Output only. The cloud instance id of the host.", +"readOnly": true, +"type": "string" +}, +"cloudProjectId": { +"description": "Output only. The cloud project id of the host.", +"readOnly": true, +"type": "string" +}, +"cloudProvider": { +"description": "Output only. The cloud provider of the host.", +"readOnly": true, +"type": "string" +}, +"cloudRegion": { +"description": "Output only. The cloud region of the host.", +"readOnly": true, +"type": "string" +}, +"cloudVirtualNetworkIds": { +"description": "Output only. The ids of cloud virtual networks of the host.", +"items": { +"type": "string" +}, +"readOnly": true, +"type": "array" +}, +"cloudZone": { +"description": "Output only. The cloud zone of the host.", +"readOnly": true, +"type": "string" +}, +"os": { +"description": "Output only. The operating system of the host.", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"HttpBody": { +"description": "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.", +"id": "HttpBody", +"properties": { +"contentType": { +"description": "The HTTP Content-Type header value specifying the content type of the body.", +"type": "string" +}, +"data": { +"description": "The HTTP request/response body as raw binary.", +"format": "byte", +"type": "string" +}, +"extensions": { +"description": "Application specific response metadata. Must be set in the first response for streaming APIs.", +"items": { +"additionalProperties": { +"description": "Properties of the object. Contains field @type with type URL.", +"type": "any" +}, +"type": "object" +}, +"type": "array" +} +}, +"type": "object" +}, "HybridSubnetInfo": { "description": "For display only. Metadata associated with a hybrid subnet.", "id": "HybridSubnetInfo", @@ -3011,6 +3713,60 @@ false }, "type": "object" }, +"ListMonitoringPointsResponse": { +"description": "Message for response to listing MonitoringPoints", +"id": "ListMonitoringPointsResponse", +"properties": { +"monitoringPoints": { +"description": "The list of MonitoringPoints.", +"items": { +"$ref": "MonitoringPoint" +}, +"type": "array" +}, +"nextPageToken": { +"description": "A token identifying a page of results the server should return.", +"type": "string" +} +}, +"type": "object" +}, +"ListNetworkMonitoringProvidersResponse": { +"description": "Message for response to listing NetworkMonitoringProviders", +"id": "ListNetworkMonitoringProvidersResponse", +"properties": { +"networkMonitoringProviders": { +"description": "The list of NetworkMonitoringProvider", +"items": { +"$ref": "NetworkMonitoringProvider" +}, +"type": "array" +}, +"nextPageToken": { +"description": "A token identifying a page of results the server should return.", +"type": "string" +} +}, +"type": "object" +}, +"ListNetworkPathsResponse": { +"description": "Message for response to listing NetworkPaths", +"id": "ListNetworkPathsResponse", +"properties": { +"networkPaths": { +"description": "The list of NetworkPath", +"items": { +"$ref": "NetworkPath" +}, +"type": "array" +}, +"nextPageToken": { +"description": "A token identifying a page of results the server should return.", +"type": "string" +} +}, +"type": "object" +}, "ListOperationsResponse": { "description": "The response message for Operations.ListOperations.", "id": "ListOperationsResponse", @@ -3061,6 +3817,24 @@ false }, "type": "object" }, +"ListWebPathsResponse": { +"description": "Message for response to listing WebPaths", +"id": "ListWebPathsResponse", +"properties": { +"nextPageToken": { +"description": "A token identifying a page of results the server should return.", +"type": "string" +}, +"webPaths": { +"description": "The list of WebPath.", +"items": { +"$ref": "WebPath" +}, +"type": "array" +} +}, +"type": "object" +}, "LoadBalancerBackend": { "description": "For display only. Metadata associated with a specific load balancer backend.", "id": "LoadBalancerBackend", @@ -3233,27 +4007,189 @@ false "description": "The friendly name for this location, typically a nearby city name. For example, \"Tokyo\".", "type": "string" }, -"labels": { -"additionalProperties": { +"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" +}, +"MonitoringPoint": { +"description": "Message describing MonitoringPoint resource.", +"id": "MonitoringPoint", +"properties": { +"autoGeoLocationEnabled": { +"description": "Output only. Indicates if automaitic geographic location is enabled for the MonitoringPoint.", +"readOnly": true, +"type": "boolean" +}, +"connectionStatus": { +"description": "Output only. Connection status of the MonitoringPoint.", +"enum": [ +"CONNECTION_STATUS_UNSPECIFIED", +"ONLINE", +"OFFLINE" +], +"enumDescriptions": [ +"The default value. This value is used if the status is omitted.", +"MonitoringPoint is online.", +"MonitoringPoint is offline." +], +"readOnly": true, +"type": "string" +}, +"createTime": { +"description": "Output only. The time the MonitoringPoint was created.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"deploymentType": { +"description": "Output only. The deployment type of the MonitoringPoint.", +"enum": [ +"DEPLOYMENT_TYPE_UNSPECIFIED", +"DOCKER", +"PODMAN", +"HELM" +], +"enumDescriptions": [ +"The default value. This value is used if the type is omitted.", +"The MonitoringPoint is deployed as a Docker container.", +"The MonitoringPoint is deployed as a Podman container.", +"The MonitoringPoint is deployed as a Helm chart." +], +"readOnly": true, +"type": "string" +}, +"displayName": { +"description": "Output only. Display name of the MonitoringPoint.", +"readOnly": true, +"type": "string" +}, +"errors": { +"description": "Output only. The codes of errors detected in the MonitoringPoint.", +"items": { +"enum": [ +"ERROR_CODE_UNSPECIFIED", +"NTP_ERROR", +"UPGRADE_ERROR", +"DOWNLOAD_FAILED" +], +"enumDescriptions": [ +"The default value. This value is used if the error code is omitted.", +"Error detected in NTP service.", +"Error detected during the upgrade process.", +"Error detected while downloading." +], +"type": "string" +}, +"readOnly": true, +"type": "array" +}, +"geoLocation": { +"$ref": "GeoLocation", +"description": "Output only. The geographical location of the MonitoringPoint.", +"readOnly": true +}, +"guid": { +"description": "Output only. The GUID of the MonitoringPoint.", +"readOnly": true, +"type": "string" +}, +"host": { +"$ref": "Host", +"description": "Output only. The host information of the MonitoringPoint.", +"readOnly": true +}, +"hostname": { +"description": "Output only. The hostname of the MonitoringPoint.", +"readOnly": true, +"type": "string" +}, +"name": { +"description": "Identifier. Name of the resource. Format: `projects/{project}/locations/{location}/networkMonitoringProviders/{network_monitoring_provider}/monitoringPoints/{monitoring_point}`", +"type": "string" +}, +"networkInterfaces": { +"description": "Output only. The network interfaces of the MonitoringPoint.", +"items": { +"$ref": "NetworkInterface" +}, +"readOnly": true, +"type": "array" +}, +"originatingIp": { +"description": "Output only. IP address visible when MonitoringPoint connects to the provider.", +"readOnly": true, +"type": "string" +}, +"providerTags": { +"description": "Output only. The provider tags of the MonitoringPoint.", +"items": { +"$ref": "ProviderTag" +}, +"readOnly": true, +"type": "array" +}, +"type": { +"description": "Output only. Deployment type of the MonitoringPoint.", +"readOnly": true, "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\"`.", +"updateTime": { +"description": "Output only. The time the MonitoringPoint was updated.", +"format": "google-datetime", +"readOnly": true, "type": "string" }, -"metadata": { -"additionalProperties": { -"description": "Properties of the object. Contains field @type with type URL.", -"type": "any" +"upgradeAvailable": { +"description": "Output only. Indicates if an upgrade is available for the MonitoringPoint.", +"readOnly": true, +"type": "boolean" }, -"description": "Service-specific metadata. For example the available capacity at the given location.", -"type": "object" +"upgradeType": { +"description": "Output only. The type of upgrade available for the MonitoringPoint.", +"enum": [ +"UPGRADE_TYPE_UNSPECIFIED", +"MANUAL", +"MANAGED", +"SCHEDULED", +"AUTO", +"EXTERNAL" +], +"enumDescriptions": [ +"The default value. This value is used if the upgrade type is omitted.", +"Upgrades are performed manually.", +"Upgrades are managed.", +"Upgrade is scheduled.", +"Upgrades are performed automatically.", +"Upgrades are performed externally." +], +"readOnly": true, +"type": "string" }, -"name": { -"description": "Resource name for the location, which may vary between implementations. For example: `\"projects/example-project/locations/us-east1\"`", +"version": { +"description": "Output only. Version of the software running on the MonitoringPoint.", +"readOnly": true, "type": "string" } }, @@ -3385,6 +4321,239 @@ false }, "type": "object" }, +"NetworkInterface": { +"description": "Message describing network interfaces.", +"id": "NetworkInterface", +"properties": { +"adapterDescription": { +"description": "Output only. The description of the interface.", +"readOnly": true, +"type": "string" +}, +"cidr": { +"description": "Output only. The IP address of the interface and subnet mask in CIDR format. Examples: 192.168.1.0/24, 2001:db8::/32", +"readOnly": true, +"type": "string" +}, +"interfaceName": { +"description": "Output only. The name of the network interface. Examples: eth0, eno1", +"readOnly": true, +"type": "string" +}, +"ipAddress": { +"description": "Output only. The IP address of the interface.", +"readOnly": true, +"type": "string" +}, +"macAddress": { +"description": "Output only. The MAC address of the interface.", +"readOnly": true, +"type": "string" +}, +"speed": { +"description": "Output only. Speed of the interface in millions of bits per second.", +"format": "int64", +"readOnly": true, +"type": "string" +}, +"vlanId": { +"description": "Output only. The id of the VLAN.", +"format": "int64", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"NetworkMonitoringProvider": { +"description": "Message describing NetworkMonitoringProvider resource.", +"id": "NetworkMonitoringProvider", +"properties": { +"createTime": { +"description": "Output only. The time the NetworkMonitoringProvider was created.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"errors": { +"description": "Output only. The list of error messages detected for the NetworkMonitoringProvider.", +"items": { +"type": "string" +}, +"readOnly": true, +"type": "array" +}, +"name": { +"description": "Output only. Identifier. Name of the resource. Format: `projects/{project}/locations/{location}/networkMonitoringProviders/{network_monitoring_provider}`", +"readOnly": true, +"type": "string" +}, +"providerType": { +"description": "Required. Type of the NetworkMonitoringProvider.", +"enum": [ +"PROVIDER_TYPE_UNSPECIFIED", +"EXTERNAL" +], +"enumDescriptions": [ +"The default value. This value is used if the type is omitted.", +"External provider." +], +"type": "string" +}, +"providerUri": { +"description": "Output only. Link to the provider's UI.", +"readOnly": true, +"type": "string" +}, +"state": { +"description": "Output only. State of the NetworkMonitoringProvider.", +"enum": [ +"STATE_UNSPECIFIED", +"ACTIVATING", +"ACTIVE", +"SUSPENDING", +"SUSPENDED", +"DELETING", +"DELETED" +], +"enumDescriptions": [ +"The default value. This value is used if the status is omitted.", +"NetworkMonitoringProvider is being activated.", +"NetworkMonitoringProvider is active.", +"NetworkMonitoringProvider is being suspended.", +"NetworkMonitoringProvider is suspended.", +"NetworkMonitoringProvider is being deleted.", +"NetworkMonitoringProvider is deleted." +], +"readOnly": true, +"type": "string" +}, +"updateTime": { +"description": "Output only. The time the NetworkMonitoringProvider was updated.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"NetworkPath": { +"description": "Message describing NetworkPath resource.", +"id": "NetworkPath", +"properties": { +"createTime": { +"description": "Output only. The time the NetworkPath was created.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"destination": { +"description": "Output only. IP address or hostname of the network path destination.", +"readOnly": true, +"type": "string" +}, +"destinationGeoLocation": { +"$ref": "GeoLocation", +"description": "Output only. Geographical location of the destination MonitoringPoint.", +"readOnly": true +}, +"destinationMonitoringPointId": { +"description": "Output only. Provider's UUID of the destination MonitoringPoint. This id may not point to a resource in the Google Cloud.", +"readOnly": true, +"type": "string" +}, +"displayName": { +"description": "Output only. The display name of the network path.", +"readOnly": true, +"type": "string" +}, +"dualEnded": { +"description": "Output only. Indicates if the network path is dual ended. When true, the network path is measured both: from both source to destination, and from destination to source. When false, the network path is measured from the source through the destination back to the source (round trip measurement).", +"readOnly": true, +"type": "boolean" +}, +"monitoringEnabled": { +"description": "Output only. Is monitoring enabled for the network path.", +"readOnly": true, +"type": "boolean" +}, +"monitoringPolicyDisplayName": { +"description": "Output only. Display name of the monitoring policy.", +"readOnly": true, +"type": "string" +}, +"monitoringPolicyId": { +"description": "Output only. ID of monitoring policy.", +"readOnly": true, +"type": "string" +}, +"monitoringStatus": { +"description": "Output only. The monitoring status of the network path.", +"enum": [ +"MONITORING_STATUS_UNSPECIFIED", +"MONITORING", +"POLICY_MISMATCH", +"MONITORING_POINT_OFFLINE", +"DISABLED" +], +"enumDescriptions": [ +"The default value. This value is used if the status is omitted.", +"Monitoring is enabled.", +"Policy is mismatched.", +"Monitoring point is offline.", +"Monitoring is disabled." +], +"readOnly": true, +"type": "string" +}, +"name": { +"description": "Identifier. Name of the resource. Format: `projects/{project}/locations/{location}/networkMonitoringProviders/{network_monitoring_provider}/networkPaths/{network_path}`", +"type": "string" +}, +"networkProtocol": { +"description": "Output only. The network protocol of the network path.", +"enum": [ +"NETWORK_PROTOCOL_UNSPECIFIED", +"ICMP", +"UDP", +"TCP" +], +"enumDescriptions": [ +"The default value. This value is used if the network protocol is omitted.", +"ICMP.", +"UDP.", +"TCP." +], +"readOnly": true, +"type": "string" +}, +"providerTags": { +"description": "Output only. The provider tags of the network path.", +"items": { +"$ref": "ProviderTag" +}, +"readOnly": true, +"type": "array" +}, +"providerUiUri": { +"description": "Output only. Link to provider's UI; link shows the NetworkPath.", +"readOnly": true, +"type": "string" +}, +"sourceMonitoringPointId": { +"description": "Output only. Provider's UUID of the source MonitoringPoint. This id may not point to a resource in the Google Cloud.", +"readOnly": true, +"type": "string" +}, +"updateTime": { +"description": "Output only. The time the NetworkPath was updated.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, "NgfwPacketInspectionInfo": { "description": "For display only. Metadata associated with a layer 7 packet inspection by the firewall.", "id": "NgfwPacketInspectionInfo", @@ -3591,6 +4760,46 @@ false }, "type": "object" }, +"ProviderTag": { +"description": "Message describing the provider tag.", +"id": "ProviderTag", +"properties": { +"category": { +"description": "Output only. The category of the provider tag.", +"readOnly": true, +"type": "string" +}, +"resourceType": { +"description": "Output only. The resource type of the provider tag.", +"enum": [ +"RESOURCE_TYPE_UNSPECIFIED", +"NETWORK_PATH", +"WEB_PATH", +"MONITORING_POLICY", +"MONITORING_POINT", +"MONITORING_POINT_RULE", +"MONITORING_POINT_RULE_AUTO" +], +"enumDescriptions": [ +"The default value. This value is used if the status is omitted.", +"Network path.", +"Web path.", +"Monitoring policy.", +"Monitoring point.", +"This represents Provider Tag that a user manually assigns to a specific Rule within a Monitoring Policy. It is created when a user saves a Monitoring Policy with custom tags applied to its rules.", +"This represents auto-generated Provider Tags derived from the criteria defined in a Monitoring Point Rule (e.g., Subnet, VLAN, Interface). If \"Auto Network Rule Tagging\" is enabled, the system automatically generates these tags based on the rule's filter values." +], +"readOnly": true, +"type": "string" +}, +"value": { +"description": "Output only. The value of the provider tag.", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, "ProxyConnectionInfo": { "description": "For display only. Metadata associated with ProxyConnection.", "id": "ProxyConnectionInfo", @@ -4120,6 +5329,10 @@ false "$ref": "CloudFunctionInfo", "description": "Display information of a Cloud Function." }, +"cloudRunJob": { +"$ref": "CloudRunJobInfo", +"description": "Display information of a Cloud Run job." +}, "cloudRunRevision": { "$ref": "CloudRunRevisionInfo", "description": "Display information of a Cloud Run revision." @@ -4269,6 +5482,7 @@ false "START_FROM_CLOUD_FUNCTION", "START_FROM_APP_ENGINE_VERSION", "START_FROM_CLOUD_RUN_REVISION", +"START_FROM_CLOUD_RUN_JOB", "START_FROM_STORAGE_BUCKET", "START_FROM_PSC_PUBLISHED_SERVICE", "START_FROM_SERVERLESS_NEG", @@ -4331,6 +5545,7 @@ false, false, false, false, +false, true, true, false, @@ -4369,6 +5584,7 @@ false "Initial state: packet originating from a Cloud Function. A CloudFunctionInfo is populated with starting function information.", "Initial state: packet originating from an App Engine service version. An AppEngineVersionInfo is populated with starting version information.", "Initial state: packet originating from a Cloud Run revision. A CloudRunRevisionInfo is populated with starting revision information.", +"Initial state: packet originating from a Cloud Run Job. A CloudRunJobInfo is populated with starting Job information.", "Initial state: packet originating from a Storage Bucket. Used only for return traces. The storage_bucket information is populated.", "Initial state: packet originating from a published service that uses Private Service Connect. Used only for return traces.", "Initial state: packet originating from a serverless network endpoint group backend. Used only for return traces. The serverless_neg information is populated.", @@ -4739,6 +5955,122 @@ false } }, "type": "object" +}, +"WebPath": { +"description": "Message describing WebPath resource.", +"id": "WebPath", +"properties": { +"createTime": { +"description": "Output only. The time the WebPath was created.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"destination": { +"description": "Output only. Web monitoring target.", +"readOnly": true, +"type": "string" +}, +"destinationGeoLocation": { +"$ref": "GeoLocation", +"description": "Output only. Geographical location of the destination.", +"readOnly": true +}, +"displayName": { +"description": "Output only. Display name of the WebPath.", +"readOnly": true, +"type": "string" +}, +"interval": { +"description": "Output only. Monitoring interval.", +"format": "google-duration", +"readOnly": true, +"type": "string" +}, +"monitoringEnabled": { +"description": "Output only. Is monitoring enabled for the WebPath.", +"readOnly": true, +"type": "boolean" +}, +"monitoringPolicyDisplayName": { +"description": "Output only. Display name of the monitoring policy.", +"readOnly": true, +"type": "string" +}, +"monitoringPolicyId": { +"description": "Output only. ID of the monitoring policy.", +"readOnly": true, +"type": "string" +}, +"monitoringStatus": { +"description": "Output only. The monitoring status of the WebPath.", +"enum": [ +"MONITORING_STATUS_UNSPECIFIED", +"MONITORING", +"POLICY_MISMATCH", +"MONITORING_POINT_OFFLINE", +"DISABLED" +], +"enumDescriptions": [ +"The default value. This value is used if the status is omitted.", +"Monitoring is enabled.", +"Policy is mismatched.", +"Monitoring point is offline.", +"Monitoring is disabled." +], +"readOnly": true, +"type": "string" +}, +"name": { +"description": "Identifier. Name of the resource. Format: `projects/{project}/locations/{location}/networkMonitoringProviders/{network_monitoring_provider}/webPaths/{web_path}`", +"type": "string" +}, +"providerTags": { +"description": "Output only. The provider tags of the web path.", +"items": { +"$ref": "ProviderTag" +}, +"readOnly": true, +"type": "array" +}, +"providerUiUri": { +"description": "Output only. Link to provider's UI; link shows the WebPath.", +"readOnly": true, +"type": "string" +}, +"relatedNetworkPathId": { +"description": "Output only. Provider's UUID of the related NetworkPath.", +"readOnly": true, +"type": "string" +}, +"sourceMonitoringPointId": { +"description": "Output only. ID of the source MonitoringPoint.", +"readOnly": true, +"type": "string" +}, +"updateTime": { +"description": "Output only. The time the WebPath was updated.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"workflowType": { +"description": "Output only. The workflow type of the WebPath.", +"enum": [ +"WORKFLOW_TYPE_UNSPECIFIED", +"BROWSER", +"HTTP" +], +"enumDescriptions": [ +"The default value. This value is used if the status is omitted.", +"Browser.", +"HTTP." +], +"readOnly": true, +"type": "string" +} +}, +"type": "object" } }, "servicePath": "", diff --git a/googleapiclient/discovery_cache/documents/networkmanagement.v1beta1.json b/googleapiclient/discovery_cache/documents/networkmanagement.v1beta1.json index 0877f8ab89..cf6b85681b 100644 --- a/googleapiclient/discovery_cache/documents/networkmanagement.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/networkmanagement.v1beta1.json @@ -1237,7 +1237,7 @@ } } }, -"revision": "20260506", +"revision": "20260520", "rootUrl": "https://networkmanagement.googleapis.com/", "schemas": { "AbortInfo": { @@ -1552,6 +1552,25 @@ false }, "type": "object" }, +"CloudRunJobInfo": { +"description": "For display only. Metadata associated with a Cloud Run job.", +"id": "CloudRunJobInfo", +"properties": { +"displayName": { +"description": "Name of a Cloud Run job.", +"type": "string" +}, +"location": { +"description": "Location in which this job is deployed.", +"type": "string" +}, +"uri": { +"description": "URI of a Cloud Run job.", +"type": "string" +} +}, +"type": "object" +}, "CloudRunRevisionEndpoint": { "description": "Wrapper for Cloud Run revision attributes.", "id": "CloudRunRevisionEndpoint", @@ -1764,7 +1783,10 @@ false "GOOGLE_MANAGED_SERVICE", "REDIS_INSTANCE", "REDIS_CLUSTER", -"GKE_POD" +"GKE_POD", +"CLOUD_RUN_JOB", +"DMS_PRIVATE_CONNECTION", +"DATASTREAM_PRIVATE_CONNECTION" ], "enumDescriptions": [ "Target not specified.", @@ -1785,7 +1807,10 @@ false "Target is a Google-managed service. Used only for return traces.", "Target is a Redis Instance.", "Target is a Redis Cluster.", -"Target is a GKE Pod." +"Target is a GKE Pod.", +"Target is a Cloud Run Job. Used only for return traces.", +"Target is a DMS Private Connection. Used only for return traces.", +"Target is a Datastream Private Connection. Used only for return traces." ], "type": "string" } @@ -1866,6 +1891,8 @@ false "CLOUD_SQL_INSTANCE_UNAUTHORIZED_ACCESS", "DROPPED_INSIDE_GKE_SERVICE", "DROPPED_INSIDE_CLOUD_SQL_SERVICE", +"DROPPED_INSIDE_DMS_PRIVATE_CONNECTION", +"DROPPED_INSIDE_DATASTREAM_PRIVATE_CONNECTION", "GOOGLE_MANAGED_SERVICE_NO_PEERING", "GOOGLE_MANAGED_SERVICE_NO_PSC_ENDPOINT", "GKE_PSC_ENDPOINT_MISSING", @@ -1893,6 +1920,7 @@ false "HYBRID_NEG_NON_DYNAMIC_ROUTE_MATCHED", "HYBRID_NEG_NON_LOCAL_DYNAMIC_ROUTE_MATCHED", "CLOUD_RUN_REVISION_NOT_READY", +"CLOUD_RUN_JOB_NOT_READY", "DROPPED_INSIDE_PSC_SERVICE_PRODUCER", "LOAD_BALANCER_HAS_NO_PROXY_SUBNET", "CLOUD_NAT_NO_ADDRESSES", @@ -1975,6 +2003,8 @@ false "Access to the Cloud SQL instance endpoint is not authorized. See [Authorizing with authorized networks](https://cloud.google.com/sql/docs/mysql/authorize-networks) for more details.", "Packet was dropped inside Google Kubernetes Engine Service.", "Packet was dropped inside Cloud SQL Service.", +"Packet was dropped inside DMS Private Connection.", +"Packet was dropped inside Datastream Private Connection.", "Packet was dropped because there is no peering between the originating network and the Google Managed Services Network.", "Packet was dropped because the Google-managed service uses Private Service Connect (PSC), but the PSC endpoint is not found in the project.", "Packet was dropped because the GKE cluster uses Private Service Connect (PSC), but the PSC endpoint is not found in the project.", @@ -2002,6 +2032,7 @@ false "The packet sent from the hybrid NEG proxy matches a non-dynamic route, but such a configuration is not supported.", "The packet sent from the hybrid NEG proxy matches a dynamic route with a next hop in a different region, but such a configuration is not supported.", "Packet sent from a Cloud Run revision that is not ready.", +"Packet sent from a Cloud Run job that is not ready.", "Packet was dropped inside Private Service Connect service producer.", "Packet sent to a load balancer, which requires a proxy-only subnet and the subnet is not found.", "Packet sent to Cloud Nat without active NAT IPs.", @@ -4132,6 +4163,10 @@ false "$ref": "CloudFunctionInfo", "description": "Display information of a Cloud Function." }, +"cloudRunJob": { +"$ref": "CloudRunJobInfo", +"description": "Display information of a Cloud Run job." +}, "cloudRunRevision": { "$ref": "CloudRunRevisionInfo", "description": "Display information of a Cloud Run revision." @@ -4281,6 +4316,7 @@ false "START_FROM_CLOUD_FUNCTION", "START_FROM_APP_ENGINE_VERSION", "START_FROM_CLOUD_RUN_REVISION", +"START_FROM_CLOUD_RUN_JOB", "START_FROM_STORAGE_BUCKET", "START_FROM_PSC_PUBLISHED_SERVICE", "START_FROM_SERVERLESS_NEG", @@ -4343,6 +4379,7 @@ false, false, false, false, +false, true, true, false, @@ -4381,6 +4418,7 @@ false "Initial state: packet originating from a Cloud Function. A CloudFunctionInfo is populated with starting function information.", "Initial state: packet originating from an App Engine service version. An AppEngineVersionInfo is populated with starting version information.", "Initial state: packet originating from a Cloud Run revision. A CloudRunRevisionInfo is populated with starting revision information.", +"Initial state: packet originating from a Cloud Run Job. A CloudRunJobInfo is populated with starting Job information.", "Initial state: packet originating from a Storage Bucket. Used only for return traces. The storage_bucket information is populated.", "Initial state: packet originating from a published service that uses Private Service Connect. Used only for return traces.", "Initial state: packet originating from a serverless network endpoint group backend. Used only for return traces. The serverless_neg information is populated.", diff --git a/googleapiclient/discovery_cache/documents/networksecurity.v1.json b/googleapiclient/discovery_cache/documents/networksecurity.v1.json index e4a95bfd0f..50dd1e0ded 100644 --- a/googleapiclient/discovery_cache/documents/networksecurity.v1.json +++ b/googleapiclient/discovery_cache/documents/networksecurity.v1.json @@ -108,6 +108,80 @@ "organizations": { "resources": { "locations": { +"methods": { +"get": { +"description": "Gets information about a location.", +"flatPath": "v1/organizations/{organizationsId}/locations/{locationsId}", +"httpMethod": "GET", +"id": "networksecurity.organizations.locations.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Resource name for the location.", +"location": "path", +"pattern": "^organizations/[^/]+/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. This method lists locations based on the resource scope provided in the ListLocationsRequest.name field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.", +"flatPath": "v1/organizations/{organizationsId}/locations", +"httpMethod": "GET", +"id": "networksecurity.organizations.locations.list", +"parameterOrder": [ +"name" +], +"parameters": { +"extraLocationTypes": { +"description": "Optional. Do not use this field unless explicitly documented otherwise. This is primarily 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": "^organizations/[^/]+$", +"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": { "addressGroups": { "methods": { @@ -403,6 +477,34 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] +}, +"testIamPermissions": { +"description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.", +"flatPath": "v1/organizations/{organizationsId}/locations/{locationsId}/addressGroups/{addressGroupsId}:testIamPermissions", +"httpMethod": "POST", +"id": "networksecurity.organizations.locations.addressGroups.testIamPermissions", +"parameterOrder": [ +"resource" +], +"parameters": { +"resource": { +"description": "REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", +"location": "path", +"pattern": "^organizations/[^/]+/locations/[^/]+/addressGroups/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+resource}:testIamPermissions", +"request": { +"$ref": "GoogleIamV1TestIamPermissionsRequest" +}, +"response": { +"$ref": "GoogleIamV1TestIamPermissionsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] } } }, @@ -4846,6 +4948,292 @@ } } }, +"sacAttachments": { +"methods": { +"create": { +"description": "Creates a new SACAttachment in a given project and location.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/sacAttachments", +"httpMethod": "POST", +"id": "networksecurity.projects.locations.sacAttachments.create", +"parameterOrder": [ +"parent" +], +"parameters": { +"parent": { +"description": "Required. The parent, in the form `projects/{project}/locations/{location}`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +}, +"requestId": { +"description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", +"location": "query", +"type": "string" +}, +"sacAttachmentId": { +"description": "Required. ID of the created attachment. The ID must be 1-63 characters long, and comply with RFC1035. Specifically, it must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.", +"location": "query", +"type": "string" +} +}, +"path": "v1/{+parent}/sacAttachments", +"request": { +"$ref": "SACAttachment" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"delete": { +"description": "Deletes the specified attachment.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/sacAttachments/{sacAttachmentsId}", +"httpMethod": "DELETE", +"id": "networksecurity.projects.locations.sacAttachments.delete", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. Name of the resource, in the form `projects/{project}/locations/{location}/sacAttachments/{sac_attachment}`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/sacAttachments/[^/]+$", +"required": true, +"type": "string" +}, +"requestId": { +"description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", +"location": "query", +"type": "string" +} +}, +"path": "v1/{+name}", +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"get": { +"description": "Returns the specified attachment.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/sacAttachments/{sacAttachmentsId}", +"httpMethod": "GET", +"id": "networksecurity.projects.locations.sacAttachments.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. Name of the resource, in the form `projects/{project}/locations/{location}/sacAttachments/{sac_attachment}`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/sacAttachments/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}", +"response": { +"$ref": "SACAttachment" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"list": { +"description": "Lists SACAttachments in a given project and location.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/sacAttachments", +"httpMethod": "GET", +"id": "networksecurity.projects.locations.sacAttachments.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"filter": { +"description": "Optional. An expression that filters the list of results.", +"location": "query", +"type": "string" +}, +"orderBy": { +"description": "Optional. Sort the results by a certain order.", +"location": "query", +"type": "string" +}, +"pageSize": { +"description": "Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "Optional. A token identifying a page of results the server should return.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The parent, in the form `projects/{project}/locations/{location}`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+parent}/sacAttachments", +"response": { +"$ref": "ListSACAttachmentsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +}, +"sacRealms": { +"methods": { +"create": { +"description": "Creates a new SACRealm in a given project.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/sacRealms", +"httpMethod": "POST", +"id": "networksecurity.projects.locations.sacRealms.create", +"parameterOrder": [ +"parent" +], +"parameters": { +"parent": { +"description": "Required. The parent, in the form `projects/{project}/locations/global`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +}, +"requestId": { +"description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", +"location": "query", +"type": "string" +}, +"sacRealmId": { +"description": "Required. ID of the created realm. The ID must be 1-63 characters long, and comply with RFC1035. Specifically, it must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.", +"location": "query", +"type": "string" +} +}, +"path": "v1/{+parent}/sacRealms", +"request": { +"$ref": "SACRealm" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"delete": { +"description": "Deletes the specified realm.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/sacRealms/{sacRealmsId}", +"httpMethod": "DELETE", +"id": "networksecurity.projects.locations.sacRealms.delete", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. Name of the resource, in the form `projects/{project}/locations/global/sacRealms/{sacRealm}`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/sacRealms/[^/]+$", +"required": true, +"type": "string" +}, +"requestId": { +"description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", +"location": "query", +"type": "string" +} +}, +"path": "v1/{+name}", +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"get": { +"description": "Returns the specified realm.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/sacRealms/{sacRealmsId}", +"httpMethod": "GET", +"id": "networksecurity.projects.locations.sacRealms.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. Name of the resource, in the form `projects/{project}/locations/global/sacRealms/{sacRealm}`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/sacRealms/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}", +"response": { +"$ref": "SACRealm" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"list": { +"description": "Lists SACRealms in a given project.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/sacRealms", +"httpMethod": "GET", +"id": "networksecurity.projects.locations.sacRealms.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"filter": { +"description": "Optional. An expression that filters the list of results.", +"location": "query", +"type": "string" +}, +"orderBy": { +"description": "Optional. Sort the results by a certain order.", +"location": "query", +"type": "string" +}, +"pageSize": { +"description": "Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "Optional. A token identifying a page of results the server should return.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The parent, in the form `projects/{project}/locations/global`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+parent}/sacRealms", +"response": { +"$ref": "ListSACRealmsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +}, "securityProfileGroups": { "methods": { "create": { @@ -5743,7 +6131,7 @@ } } }, -"revision": "20260426", +"revision": "20260518", "rootUrl": "https://networksecurity.googleapis.com/", "schemas": { "AddAddressGroupItemsRequest": { @@ -6002,6 +6390,13 @@ "description": "Required. Identifier. Name of the `AuthzPolicy` resource in the following format: `projects/{project}/locations/{location}/authzPolicies/{authz_policy}`.", "type": "string" }, +"networkRules": { +"description": "Optional. A list of authorization network rules to match against the incoming request. A policy match occurs when at least one network rule matches the request. At least one network rule is required for Allow or Deny Action if no HTTP rules are provided. Network rules are mutually exclusive with HTTP rules. Limited to 5 rules.", +"items": { +"$ref": "AuthzPolicyAuthzRule" +}, +"type": "array" +}, "policyProfile": { "description": "Optional. Immutable. Defines the type of authorization being performed. If not specified, `REQUEST_AUTHZ` is applied. This field cannot be changed once AuthzPolicy is created.", "enum": [ @@ -6265,6 +6660,13 @@ "$ref": "AuthzPolicyAuthzRuleStringMatch" }, "type": "array" +}, +"snis": { +"description": "Optional. A list of SNIs to match against. The match can be one of exact, prefix, suffix, or contains (substring match). If there is no SNI (i.e. plaintext HTTP traffic), the request will be denied. Matches are always case sensitive unless the ignoreCase is set. Limited to 10 SNIs per Authorization Policy.", +"items": { +"$ref": "AuthzPolicyAuthzRuleStringMatch" +}, +"type": "array" } }, "type": "object" @@ -6675,7 +7077,7 @@ "properties": { "associatedNetworks": { "deprecated": true, -"description": "Output only. List of networks that are associated with this endpoint in the local zone. This is a projection of the FirewallEndpointAssociations pointing at this endpoint. A network will only appear in this list after traffic routing is fully configured. Format: projects/{project}/global/networks/{name}.", +"description": "Output only. Deprecated: List of networks that are associated with this endpoint in the local zone. This is a projection of the FirewallEndpointAssociations pointing at this endpoint. A network will only appear in this list after traffic routing is fully configured. Format: projects/{project}/global/networks/{name}.", "items": { "type": "string" }, @@ -8096,6 +8498,56 @@ }, "type": "object" }, +"ListSACAttachmentsResponse": { +"description": "Response for `ListSACAttachments` method.", +"id": "ListSACAttachmentsResponse", +"properties": { +"nextPageToken": { +"description": "A token identifying a page of results the server should return.", +"type": "string" +}, +"sacAttachments": { +"description": "The list of SACAttachments.", +"items": { +"$ref": "SACAttachment" +}, +"type": "array" +}, +"unreachable": { +"description": "Locations that could not be reached.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"ListSACRealmsResponse": { +"description": "Response for `ListSACRealms` method.", +"id": "ListSACRealmsResponse", +"properties": { +"nextPageToken": { +"description": "A token identifying a page of results the server should return.", +"type": "string" +}, +"sacRealms": { +"description": "The list of SACRealms.", +"items": { +"$ref": "SACRealm" +}, +"type": "array" +}, +"unreachable": { +"description": "Locations that could not be reached.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, "ListSecurityProfileGroupsResponse": { "description": "Response returned by the ListSecurityProfileGroups method.", "id": "ListSecurityProfileGroupsResponse", @@ -8882,6 +9334,145 @@ }, "type": "object" }, +"SACAttachment": { +"description": "Represents a Secure Access Connect (SAC) attachment resource. A Secure Access Connect attachment enables NCC Gateway to process traffic with an SSE product.", +"id": "SACAttachment", +"properties": { +"createTime": { +"description": "Output only. Timestamp when the attachment was created.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"labels": { +"additionalProperties": { +"type": "string" +}, +"description": "Optional. Optional list of labels applied to the resource.", +"type": "object" +}, +"name": { +"description": "Identifier. Resource name, in the form `projects/{project}/locations/{location}/sacAttachments/{sac_attachment}`.", +"type": "string" +}, +"nccGateway": { +"description": "Required. NCC Gateway associated with the attachment. This can be input as an ID or a full resource name. The output always has the form `projects/{project_number}/locations/{location}/spokes/{ncc_gateway}`.", +"type": "string" +}, +"sacRealm": { +"description": "Required. SAC Realm which owns the attachment. This can be input as an ID or a full resource name. The output always has the form `projects/{project_number}/locations/{location}/sacRealms/{sac_realm}`.", +"type": "string" +}, +"state": { +"description": "Output only. State of the attachment.", +"enum": [ +"STATE_UNSPECIFIED", +"PENDING_PARTNER_ATTACHMENT", +"PARTNER_ATTACHED", +"PARTNER_DETACHED" +], +"enumDescriptions": [ +"No state specified. This should not be used.", +"Has never been attached to a partner.", +"Currently attached to a partner.", +"Was once attached to a partner but has been detached." +], +"readOnly": true, +"type": "string" +}, +"updateTime": { +"description": "Output only. Timestamp when the attachment was last updated.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"SACRealm": { +"description": "Represents a Secure Access Connect (SAC) realm resource. A Secure Access Connect realm establishes a connection between your Google Cloud project and an SSE service.", +"id": "SACRealm", +"properties": { +"createTime": { +"description": "Output only. Timestamp when the realm was created.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"labels": { +"additionalProperties": { +"type": "string" +}, +"description": "Optional. Optional list of labels applied to the resource.", +"type": "object" +}, +"name": { +"description": "Identifier. Resource name, in the form `projects/{project}/locations/global/sacRealms/{sacRealm}`.", +"type": "string" +}, +"pairingKey": { +"$ref": "SACRealmPairingKey", +"description": "Output only. Key to be shared with SSE service provider during pairing.", +"readOnly": true +}, +"securityService": { +"description": "Immutable. SSE service provider associated with the realm.", +"enum": [ +"SECURITY_SERVICE_UNSPECIFIED", +"PALO_ALTO_PRISMA_ACCESS" +], +"enumDescriptions": [ +"The default value. This value is used if the state is omitted.", +"[Palo Alto Networks Prisma Access](https://www.paloaltonetworks.com/sase/access)." +], +"type": "string" +}, +"state": { +"description": "Output only. State of the realm.", +"enum": [ +"STATE_UNSPECIFIED", +"PENDING_PARTNER_ATTACHMENT", +"PARTNER_ATTACHED", +"PARTNER_DETACHED", +"KEY_EXPIRED" +], +"enumDescriptions": [ +"No state specified. This should not be used.", +"Has never been attached to a partner. Used only for Prisma Access.", +"Currently attached to a partner.", +"Was once attached to a partner but has been detached.", +"Is not attached to a partner and has an expired pairing key. Used only for Prisma Access." +], +"readOnly": true, +"type": "string" +}, +"updateTime": { +"description": "Output only. Timestamp when the realm was last updated.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"SACRealmPairingKey": { +"description": "Key to be shared with SSE service provider to establish global handshake.", +"id": "SACRealmPairingKey", +"properties": { +"expireTime": { +"description": "Output only. Timestamp in UTC of when this resource is considered expired. It expires 7 days after creation.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"key": { +"description": "Output only. Key value.", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, "SecurityProfile": { "description": "SecurityProfile is a resource that defines the behavior for one of many ProfileTypes.", "id": "SecurityProfile", diff --git a/googleapiclient/discovery_cache/documents/networksecurity.v1beta1.json b/googleapiclient/discovery_cache/documents/networksecurity.v1beta1.json index 382c39e9af..db8e639965 100644 --- a/googleapiclient/discovery_cache/documents/networksecurity.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/networksecurity.v1beta1.json @@ -108,6 +108,80 @@ "organizations": { "resources": { "locations": { +"methods": { +"get": { +"description": "Gets information about a location.", +"flatPath": "v1beta1/organizations/{organizationsId}/locations/{locationsId}", +"httpMethod": "GET", +"id": "networksecurity.organizations.locations.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Resource name for the location.", +"location": "path", +"pattern": "^organizations/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+name}", +"response": { +"$ref": "Location" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"list": { +"description": "Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the ListLocationsRequest.name field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.", +"flatPath": "v1beta1/organizations/{organizationsId}/locations", +"httpMethod": "GET", +"id": "networksecurity.organizations.locations.list", +"parameterOrder": [ +"name" +], +"parameters": { +"extraLocationTypes": { +"description": "Optional. Do not use this field unless explicitly documented otherwise. This is primarily 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": "^organizations/[^/]+$", +"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": "v1beta1/{+name}/locations", +"response": { +"$ref": "ListLocationsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +}, "resources": { "addressGroups": { "methods": { @@ -403,6 +477,34 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] +}, +"testIamPermissions": { +"description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.", +"flatPath": "v1beta1/organizations/{organizationsId}/locations/{locationsId}/addressGroups/{addressGroupsId}:testIamPermissions", +"httpMethod": "POST", +"id": "networksecurity.organizations.locations.addressGroups.testIamPermissions", +"parameterOrder": [ +"resource" +], +"parameters": { +"resource": { +"description": "REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", +"location": "path", +"pattern": "^organizations/[^/]+/locations/[^/]+/addressGroups/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+resource}:testIamPermissions", +"request": { +"$ref": "GoogleIamV1TestIamPermissionsRequest" +}, +"response": { +"$ref": "GoogleIamV1TestIamPermissionsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] } } }, @@ -586,6 +688,106 @@ "https://www.googleapis.com/auth/cloud-platform" ] } +}, +"resources": { +"wildfireVerdictChangeRequests": { +"methods": { +"create": { +"description": "Create WildfireVerdictChangeRequest in a given Firewall Endpoint in an organization and location.", +"flatPath": "v1beta1/organizations/{organizationsId}/locations/{locationsId}/firewallEndpoints/{firewallEndpointsId}/wildfireVerdictChangeRequests", +"httpMethod": "POST", +"id": "networksecurity.organizations.locations.firewallEndpoints.wildfireVerdictChangeRequests.create", +"parameterOrder": [ +"parent" +], +"parameters": { +"parent": { +"description": "Required. Parent value for CreateWildfireVerdictChangeRequestRequest. The parent is a firewall endpoint resource. Format: organizations|projects/{project_or_organization}/locations/{location}/firewallEndpoints/{firewall_endpoint}", +"location": "path", +"pattern": "^organizations/[^/]+/locations/[^/]+/firewallEndpoints/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+parent}/wildfireVerdictChangeRequests", +"request": { +"$ref": "WildfireVerdictChangeRequest" +}, +"response": { +"$ref": "WildfireVerdictChangeRequest" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"get": { +"description": "Get WildfireVerdictChangeRequest in a given Firewall Endpoint in an organization and location.", +"flatPath": "v1beta1/organizations/{organizationsId}/locations/{locationsId}/firewallEndpoints/{firewallEndpointsId}/wildfireVerdictChangeRequests/{wildfireVerdictChangeRequestsId}", +"httpMethod": "GET", +"id": "networksecurity.organizations.locations.firewallEndpoints.wildfireVerdictChangeRequests.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. Name of the WildfireVerdictChangeRequest to retrieve. Format: organizations|projects/{project_or_organization}/locations/{location}/firewallEndpoints/{firewall_endpoint}/wildfireVerdictChangeRequests/{wildfire_verdict_change_request_id} Where {wildfire_verdict_change_request_id} is the ID in the format: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", +"location": "path", +"pattern": "^organizations/[^/]+/locations/[^/]+/firewallEndpoints/[^/]+/wildfireVerdictChangeRequests/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+name}", +"response": { +"$ref": "WildfireVerdictChangeRequest" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"list": { +"description": "Lists WildfireVerdictChangeRequests in a given Firewall Endpoint in an organization and location.", +"flatPath": "v1beta1/organizations/{organizationsId}/locations/{locationsId}/firewallEndpoints/{firewallEndpointsId}/wildfireVerdictChangeRequests", +"httpMethod": "GET", +"id": "networksecurity.organizations.locations.firewallEndpoints.wildfireVerdictChangeRequests.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"filter": { +"description": "Optional. Filter expression to filter the results. See AIP-160 for filtering syntax. Supported fields are: - `sha256` (string, equality only, e.g. `sha256 = \"...\"`) - `state` (enum, equality only, e.g. `state = \"ACTIVE\"`) - `create_time` (timestamp, comparisons, e.g. `create_time > \"2026-01-01T00:00:00Z\"`)", +"location": "query", +"type": "string" +}, +"pageSize": { +"description": "Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "Optional. A token identifying a page of results the server should return.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. Parent value for ListWildfireVerdictChangeRequestsRequest. The parent is a firewall endpoint resource. Format: organizations|projects/{project_or_organization}/locations/{location}/firewallEndpoints/{firewall_endpoint}", +"location": "path", +"pattern": "^organizations/[^/]+/locations/[^/]+/firewallEndpoints/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+parent}/wildfireVerdictChangeRequests", +"response": { +"$ref": "ListWildfireVerdictChangeRequestsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +} } }, "operations": { @@ -2944,6 +3146,106 @@ "https://www.googleapis.com/auth/cloud-platform" ] } +}, +"resources": { +"wildfireVerdictChangeRequests": { +"methods": { +"create": { +"description": "Create WildfireVerdictChangeRequest in a given Firewall Endpoint in a project and location.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/firewallEndpoints/{firewallEndpointsId}/wildfireVerdictChangeRequests", +"httpMethod": "POST", +"id": "networksecurity.projects.locations.firewallEndpoints.wildfireVerdictChangeRequests.create", +"parameterOrder": [ +"parent" +], +"parameters": { +"parent": { +"description": "Required. Parent value for CreateWildfireVerdictChangeRequestRequest. The parent is a firewall endpoint resource. Format: organizations|projects/{project_or_organization}/locations/{location}/firewallEndpoints/{firewall_endpoint}", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/firewallEndpoints/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+parent}/wildfireVerdictChangeRequests", +"request": { +"$ref": "WildfireVerdictChangeRequest" +}, +"response": { +"$ref": "WildfireVerdictChangeRequest" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"get": { +"description": "Get WildfireVerdictChangeRequest in a given Firewall Endpoint in a project and location.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/firewallEndpoints/{firewallEndpointsId}/wildfireVerdictChangeRequests/{wildfireVerdictChangeRequestsId}", +"httpMethod": "GET", +"id": "networksecurity.projects.locations.firewallEndpoints.wildfireVerdictChangeRequests.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. Name of the WildfireVerdictChangeRequest to retrieve. Format: organizations|projects/{project_or_organization}/locations/{location}/firewallEndpoints/{firewall_endpoint}/wildfireVerdictChangeRequests/{wildfire_verdict_change_request_id} Where {wildfire_verdict_change_request_id} is the ID in the format: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/firewallEndpoints/[^/]+/wildfireVerdictChangeRequests/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+name}", +"response": { +"$ref": "WildfireVerdictChangeRequest" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"list": { +"description": "Lists WildfireVerdictChangeRequests in a given Firewall Endpoint in a project and location.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/firewallEndpoints/{firewallEndpointsId}/wildfireVerdictChangeRequests", +"httpMethod": "GET", +"id": "networksecurity.projects.locations.firewallEndpoints.wildfireVerdictChangeRequests.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"filter": { +"description": "Optional. Filter expression to filter the results. See AIP-160 for filtering syntax. Supported fields are: - `sha256` (string, equality only, e.g. `sha256 = \"...\"`) - `state` (enum, equality only, e.g. `state = \"ACTIVE\"`) - `create_time` (timestamp, comparisons, e.g. `create_time > \"2026-01-01T00:00:00Z\"`)", +"location": "query", +"type": "string" +}, +"pageSize": { +"description": "Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "Optional. A token identifying a page of results the server should return.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. Parent value for ListWildfireVerdictChangeRequestsRequest. The parent is a firewall endpoint resource. Format: organizations|projects/{project_or_organization}/locations/{location}/firewallEndpoints/{firewall_endpoint}", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/firewallEndpoints/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+parent}/wildfireVerdictChangeRequests", +"response": { +"$ref": "ListWildfireVerdictChangeRequestsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +} } }, "gatewaySecurityPolicies": { @@ -6029,7 +6331,7 @@ } } }, -"revision": "20260426", +"revision": "20260524", "rootUrl": "https://networksecurity.googleapis.com/", "schemas": { "AddAddressGroupItemsRequest": { @@ -6288,9 +6590,16 @@ "description": "Required. Identifier. Name of the `AuthzPolicy` resource in the following format: `projects/{project}/locations/{location}/authzPolicies/{authz_policy}`.", "type": "string" }, -"policyProfile": { -"description": "Optional. Immutable. Defines the type of authorization being performed. If not specified, `REQUEST_AUTHZ` is applied. This field cannot be changed once AuthzPolicy is created.", -"enum": [ +"networkRules": { +"description": "Optional. A list of authorization network rules to match against the incoming request. A policy match occurs when at least one network rule matches the request. At least one network rule is required for Allow or Deny Action if no HTTP rules are provided. Network rules are mutually exclusive with HTTP rules. Limited to 5 rules.", +"items": { +"$ref": "AuthzPolicyAuthzRule" +}, +"type": "array" +}, +"policyProfile": { +"description": "Optional. Immutable. Defines the type of authorization being performed. If not specified, `REQUEST_AUTHZ` is applied. This field cannot be changed once AuthzPolicy is created.", +"enum": [ "POLICY_PROFILE_UNSPECIFIED", "REQUEST_AUTHZ", "CONTENT_AUTHZ" @@ -6551,6 +6860,13 @@ "$ref": "AuthzPolicyAuthzRuleStringMatch" }, "type": "array" +}, +"snis": { +"description": "Optional. A list of SNIs to match against. The match can be one of exact, prefix, suffix, or contains (substring match). If there is no SNI (i.e. plaintext HTTP traffic), the request will be denied. Matches are always case sensitive unless the ignoreCase is set. Limited to 10 SNIs per Authorization Policy.", +"items": { +"$ref": "AuthzPolicyAuthzRuleStringMatch" +}, +"type": "array" } }, "type": "object" @@ -6961,7 +7277,7 @@ "properties": { "associatedNetworks": { "deprecated": true, -"description": "Output only. List of networks that are associated with this endpoint in the local zone. This is a projection of the FirewallEndpointAssociations pointing at this endpoint. A network will only appear in this list after traffic routing is fully configured. Format: projects/{project}/global/networks/{name}.", +"description": "Output only. Deprecated: List of networks that are associated with this endpoint in the local zone. This is a projection of the FirewallEndpointAssociations pointing at this endpoint. A network will only appear in this list after traffic routing is fully configured. Format: projects/{project}/global/networks/{name}.", "items": { "type": "string" }, @@ -7044,6 +7360,10 @@ "format": "google-datetime", "readOnly": true, "type": "string" +}, +"wildfireSettings": { +"$ref": "FirewallEndpointWildfireSettings", +"description": "Optional. Settings for WildFire analysis." } }, "type": "object" @@ -7141,6 +7461,54 @@ "description": "Settings for the endpoint.", "id": "FirewallEndpointEndpointSettings", "properties": { +"contentCloudRegion": { +"description": "Optional. The content cloud region of the endpoint.", +"enum": [ +"CONTENT_CLOUD_REGION_UNSPECIFIED", +"US_CENTRAL", +"APAC", +"INDIA", +"UK", +"FRANCE", +"JAPAN", +"AUSTRALIA", +"CANADA", +"SWITZERLAND", +"NETHERLANDS", +"INDONESIA", +"QATAR", +"TAIWAN", +"POLAND", +"SOUTH_KOREA", +"SAUDI_ARABIA", +"ITALY" +], +"enumDescriptions": [ +"PAN content cloud region not specified.", +"us.hawkeye.services-edge.paloaltonetworks.com", +"APAC content cloud portal: apac.hawkeye.services-edge.paloaltonetworks.com", +"India content cloud portal: in.hawkeye.services-edge.paloaltonetworks.com", +"UK content cloud portal: uk.hawkeye.services-edge.paloaltonetworks.com", +"France content cloud portal: fr.hawkeye.services-edge.paloaltonetworks.com", +"Japan content cloud portal: jp.hawkeye.services-edge.paloaltonetworks.com", +"Australia content cloud portal: au.hawkeye.services-edge.paloaltonetworks.com", +"Canada content cloud portal: ca.hawkeye.services-edge.paloaltonetworks.com", +"Switzerland content cloud portal: ch.hawkeye.services-edge.paloaltonetworks.com", +"Netherlands content cloud portal: nl.hawkeye.services-edge.paloaltonetworks.com", +"Indonesia content cloud portal: id.hawkeye.services-edge.paloaltonetworks.com", +"Qatar content cloud portal: qa.hawkeye.services-edge.paloaltonetworks.com", +"Taiwan content cloud portal: tw.hawkeye.services-edge.paloaltonetworks.com", +"Poland content cloud portal: pl.hawkeye.services-edge.paloaltonetworks.com", +"South Korea content cloud portal: kr.hawkeye.services-edge.paloaltonetworks.com", +"Saudi Arabia content cloud portal: sa.hawkeye.services-edge.paloaltonetworks.com", +"Italy content cloud portal: it.hawkeye.services-edge.paloaltonetworks.com" +], +"type": "string" +}, +"httpPartialResponseBlocked": { +"description": "Optional. Whether to block HTTP partial responses for the endpoint. When this is true, resumption of blocked malicious HTTP file downloads will be blocked by the firewall. False provides maximum availability, true provides maximum security.", +"type": "boolean" +}, "jumboFramesEnabled": { "description": "Optional. Immutable. Indicates whether Jumbo Frames are enabled. Default value is false.", "type": "boolean" @@ -7148,6 +7516,116 @@ }, "type": "object" }, +"FirewallEndpointWildfireSettings": { +"description": "Settings for WildFire analysis.", +"id": "FirewallEndpointWildfireSettings", +"properties": { +"enabled": { +"description": "Optional. Indicates whether WildFire analysis is enabled. Default value is false.", +"type": "boolean" +}, +"wildfireInlineCloudAnalysisSettings": { +"$ref": "FirewallEndpointWildfireSettingsWildfireInlineCloudAnalysisSettings", +"description": "Optional. Settings for WildFire inline cloud analysis." +}, +"wildfireRealtimeLookupDuration": { +"description": "Optional. Duration in milliseconds on a file being held while the WildFire real time signature cloud performs a signature lookup. Value between 1 to 5000 is valid. Default value is 1000.", +"format": "google-duration", +"type": "string" +}, +"wildfireRealtimeLookupTimeoutAction": { +"description": "Optional. Action to take on WildFire real time signature lookup timeout. Default value is ALLOW.", +"enum": [ +"WILDFIRE_REALTIME_SIGNATURE_LOOKUP_TIMEOUT_ACTION_UNSPECIFIED", +"ALLOW", +"DENY" +], +"enumDescriptions": [ +"WildFire real time signature lookup timeout action not specified.", +"The files that timed out in the signature lookup will be allowed to transmit.", +"The files that timed out in the signature lookup will be denied to transmit." +], +"type": "string" +}, +"wildfireRegion": { +"description": "Optional. The region where WildFire analysis will be performed. PAN supports regions: https://docs.paloaltonetworks.com/advanced-wildfire/administration/advanced-wildfire-overview/advanced-wildfire-deployments/advanced-wildfire-global-cloud", +"enum": [ +"WILDFIRE_REGION_UNSPECIFIED", +"CANADA", +"UNITED_STATES", +"JAPAN", +"SINGAPORE", +"UNITED_KINGDOM", +"AUSTRALIA", +"GERMANY", +"INDIA", +"SWITZERLAND", +"POLAND", +"INDONESIA", +"TAIWAN", +"FRANCE", +"QATAR", +"SOUTH_KOREA", +"ISRAEL", +"SAUDI_ARABIA", +"SPAIN" +], +"enumDescriptions": [ +"WildFire region not specified.", +"Canada cloud portal: ca.wildfire.paloaltonetworks.com", +"United States cloud portal: us-native.wildfire.paloaltonetworks.com", +"Japan cloud portal: jp.wildfire.paloaltonetworks.com", +"Singapore cloud portal: sg.wildfire.paloaltonetworks.com", +"United Kingdom cloud portal: uk.wildfire.paloaltonetworks.com", +"Australia cloud portal: au.wildfire.paloaltonetworks.com", +"Germany cloud portal: de.wildfire.paloaltonetworks.com", +"India cloud portal: in.wildfire.paloaltonetworks.com", +"Switzerland cloud portal: ch.wildfire.paloaltonetworks.com", +"Poland cloud portal: pl.wildfire.paloaltonetworks.com", +"Indonesia cloud portal: id.wildfire.paloaltonetworks.com", +"Taiwan cloud portal: tw.wildfire.paloaltonetworks.com", +"France cloud portal: fr.wildfire.paloaltonetworks.com", +"Qatar cloud portal: qatar.wildfire.paloaltonetworks.com", +"South Korea cloud portal: kr.wildfire.paloaltonetworks.com", +"Israel cloud portal: il.wildfire.paloaltonetworks.com", +"Saudi Arabia cloud portal: sa.wildfire.paloaltonetworks.com", +"Spain cloud portal: es.wildfire.paloaltonetworks.com" +], +"type": "string" +} +}, +"type": "object" +}, +"FirewallEndpointWildfireSettingsWildfireInlineCloudAnalysisSettings": { +"description": "Settings for WildFire inline cloud analysis.", +"id": "FirewallEndpointWildfireSettingsWildfireInlineCloudAnalysisSettings", +"properties": { +"maxAnalysisDuration": { +"description": "Optional. Timeout in milliseconds on a file being held while WildFire inline cloud analysis is performed. Value between 1 to 240000 is valid. Default value is 30000.", +"format": "google-duration", +"type": "string" +}, +"submissionTimeoutLoggingDisabled": { +"description": "Optional. Whether to disable WildFire submission log generation for files that timeout during WildFire inline cloud analysis.", +"type": "boolean" +}, +"timeoutAction": { +"description": "Optional. Action to take when WildFire inline cloud analysis times out. Default value is ALLOW.", +"enum": [ +"WILDFIRE_INLINE_CLOUD_ANALYSIS_TIMEOUT_ACTION_UNSPECIFIED", +"ALLOW", +"DENY" +], +"enumDescriptions": [ +"WildFire inline cloud analysis timeout action not specified.", +"The files that timed out will be allowed to transmit.", +"The files that timed out will be denied to transmit." +], +"type": "string" +} +}, +"type": "object" +}, "GatewaySecurityPolicy": { "description": "The GatewaySecurityPolicy resource contains a collection of GatewaySecurityPolicyRules and associated metadata.", "id": "GatewaySecurityPolicy", @@ -8312,7 +8790,7 @@ "type": "string" }, "unreachable": { -"description": "Locations that could not be reached.", +"description": "Unordered list. Locations that could not be reached. See https://google.aip.dev/217 for more details.", "items": { "type": "string" }, @@ -8543,6 +9021,31 @@ }, "type": "object" }, +"ListWildfireVerdictChangeRequestsResponse": { +"description": "Message for response to listing WildfireVerdictChangeRequests.", +"id": "ListWildfireVerdictChangeRequestsResponse", +"properties": { +"nextPageToken": { +"description": "A token identifying a page of results the server should return.", +"type": "string" +}, +"unreachable": { +"description": "Unordered list. Locations that could not be reached.", +"items": { +"type": "string" +}, +"type": "array" +}, +"wildfireVerdictChangeRequests": { +"description": "The list of WildfireVerdictChangeRequests", +"items": { +"$ref": "WildfireVerdictChangeRequest" +}, +"type": "array" +} +}, +"type": "object" +}, "Location": { "description": "A resource that represents a Google Cloud location.", "id": "Location", @@ -9477,14 +9980,16 @@ "THREAT_PREVENTION", "CUSTOM_MIRRORING", "CUSTOM_INTERCEPT", -"URL_FILTERING" +"URL_FILTERING", +"WILDFIRE_ANALYSIS" ], "enumDescriptions": [ "Profile type not specified.", "Profile type for threat prevention.", "Profile type for packet mirroring v2", "Profile type for TPPI.", -"Profile type for URL filtering." +"Profile type for URL filtering.", +"Profile type for WildFire Analysis." ], "type": "string" }, @@ -9497,6 +10002,10 @@ "urlFilteringProfile": { "$ref": "UrlFilteringProfile", "description": "The URL filtering configuration for the SecurityProfile." +}, +"wildfireAnalysisProfile": { +"$ref": "WildfireAnalysisProfile", +"description": "The WildFire Analysis configurations for SecurityProfile." } }, "type": "object" @@ -9558,6 +10067,10 @@ "urlFilteringProfile": { "description": "Optional. Reference to a SecurityProfile with the UrlFiltering configuration.", "type": "string" +}, +"wildfireAnalysisProfile": { +"description": "Optional. Reference to a SecurityProfile with the WildFire configuration.", +"type": "string" } }, "type": "object" @@ -9956,6 +10469,567 @@ } }, "type": "object" +}, +"WildfireAnalysisProfile": { +"description": "WildfireAnalysisProfile defines Palo Alto Networks WildFire behavior.", +"id": "WildfireAnalysisProfile", +"properties": { +"wildfireInlineCloudAnalysisRules": { +"description": "Optional. Configuration for WildFire inline cloud analysis.", +"items": { +"$ref": "WildfireInlineCloudAnalysisRule" +}, +"type": "array" +}, +"wildfireInlineMlOverrides": { +"description": "Optional. Configuration for overriding inline ML WildFire actions per protocol.", +"items": { +"$ref": "WildfireInlineMlOverride" +}, +"type": "array" +}, +"wildfireInlineMlSetting": { +"$ref": "WildfireInlineMlSettings", +"description": "Optional. Settings for WildFire Inline ML analysis." +}, +"wildfireInlineMlSettings": { +"deprecated": true, +"description": "Optional. Settings for WildFire Inline ML analysis.", +"items": { +"$ref": "WildfireInlineMlSettings" +}, +"type": "array" +}, +"wildfireOverrides": { +"description": "Optional. Configuration for overriding WildFire actions per protocol.", +"items": { +"$ref": "WildfireOverride" +}, +"type": "array" +}, +"wildfireRealtimeLookup": { +"description": "Optional. Whether to hold the transfer of a file while the WildFire real-time signature cloud performs a signature lookup. Default value is false.", +"type": "boolean" +}, +"wildfireSubmissionRules": { +"description": "Optional. Configurations for WildFire file submissions.", +"items": { +"$ref": "WildfireSubmissionRule" +}, +"type": "array" +}, +"wildfireThreatOverrides": { +"description": "Optional. Configuration for overriding WildFire threats action by threat_id match.", +"items": { +"$ref": "WildfireThreatOverride" +}, +"type": "array" +} +}, +"type": "object" +}, +"WildfireInlineCloudAnalysisRule": { +"description": "The list of file type configurations to be scanned by WildFire Inline Cloud Analysis.", +"id": "WildfireInlineCloudAnalysisRule", +"properties": { +"action": { +"description": "Required. Action to take when a threat is detected using WildFire Inline Cloud Analysis. The default Value is DENY.", +"enum": [ +"WILDFIRE_INLINE_CLOUD_ANALYSIS_ACTION_UNSPECIFIED", +"ALLOW", +"DENY", +"ALERT" +], +"enumDescriptions": [ +"WildFire Inline Cloud Analysis action not specified.", +"The files caught by WildFire Inline Cloud Analysis will be allowed to transmit.", +"The files caught by WildFire Inline Cloud Analysis will be denied to transmit.", +"The files caught by WildFire Inline Cloud Analysis will be allowed to transmit, but a wildfire_submission_log entry will be sent to the consumer project." +], +"type": "string" +}, +"customFileTypes": { +"$ref": "WildfireInlineCloudAnalysisRuleCustomFileTypes", +"description": "Submit a custom list of file types for WildFire analysis." +}, +"direction": { +"description": "Required. Direction for the file to be analyzed by WildFire Inline Cloud Analysis.", +"enum": [ +"DIRECTION_UNSPECIFIED", +"UPLOAD", +"DOWNLOAD", +"BOTH" +], +"enumDescriptions": [ +"Direction not specified.", +"Upload direction.", +"Download direction.", +"Both upload and download directions." +], +"type": "string" +}, +"fileSelectionMode": { +"description": "Required. File selection mode for WildFire inline cloud analysis.", +"enum": [ +"FILE_SELECTION_MODE_UNSPECIFIED", +"ALL_FILE_TYPES", +"CUSTOM_FILE_TYPES" +], +"enumDescriptions": [ +"File selection mode not specified.", +"Submit all the file types for scan.", +"Submit a custom list of file types for scan." +], +"type": "string" +} +}, +"type": "object" +}, +"WildfireInlineCloudAnalysisRuleCustomFileTypes": { +"description": "The options to submit a custom list of file types for scan.", +"id": "WildfireInlineCloudAnalysisRuleCustomFileTypes", +"properties": { +"fileTypes": { +"description": "Required. File types to be submitted for WildFire inline cloud analysis.", +"items": { +"enum": [ +"FILE_TYPE_UNSPECIFIED", +"PE" +], +"enumDescriptions": [ +"File type not specified.", +"Portable Executable (PE) files." +], +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"WildfireInlineMlFileException": { +"description": "Defines the file to exclude from WildFire Inline ML analysis.", +"id": "WildfireInlineMlFileException", +"properties": { +"filename": { +"description": "Optional. Name of the file to exclude from WildFire Inline ML analysis.", +"type": "string" +}, +"partialHash": { +"description": "Required. Machine learning partial hash of the file to exclude from WildFire Inline ML analysis.", +"type": "string" +} +}, +"type": "object" +}, +"WildfireInlineMlOverride": { +"description": "Defines what action to take for WildFire Inline ML threats per protocol.", +"id": "WildfireInlineMlOverride", +"properties": { +"action": { +"description": "Required. The action to take for WildFire Inline ML override.", +"enum": [ +"WILDFIRE_THREAT_ACTION_UNSPECIFIED", +"WILDFIRE_DEFAULT_ACTION", +"WILDFIRE_ALLOW", +"WILDFIRE_ALERT", +"WILDFIRE_DENY" +], +"enumDescriptions": [ +"Threat action not specified.", +"The default action (as specified by the vendor) is taken.", +"The packet matching this rule will be allowed to transmit.", +"The packet matching this rule will be allowed to transmit, but a threat_log entry will be sent to the consumer project.", +"The packet matching this rule will be dropped, and a threat_log entry will be sent to the consumer project." +], +"type": "string" +}, +"protocol": { +"description": "Required. Protocol to match for WildFire Inline ML override.", +"enum": [ +"WILDFIRE_PROTOCOL_UNSPECIFIED", +"WILDFIRE_SMTP", +"WILDFIRE_SMB", +"WILDFIRE_POP3", +"WILDFIRE_IMAP", +"WILDFIRE_HTTP2", +"WILDFIRE_HTTP", +"WILDFIRE_FTP" +], +"enumDescriptions": [ +"Protocol not specified.", +"SMTP protocol", +"SMB protocol", +"POP3 protocol", +"IMAP protocol", +"HTTP2 protocol", +"HTTP protocol", +"FTP protocol" +], +"type": "string" +} +}, +"type": "object" +}, +"WildfireInlineMlSettings": { +"description": "Defines the settings for WildFire Inline ML analysis.", +"id": "WildfireInlineMlSettings", +"properties": { +"fileExceptions": { +"description": "Optional. List of files to exclude from WildFire Inline ML analysis.", +"items": { +"$ref": "WildfireInlineMlFileException" +}, +"type": "array" +}, +"inlineMlConfigs": { +"description": "Optional. List of Inline ML configs to enable in WildFire Inline ML analysis.", +"items": { +"$ref": "WildfireInlineMlSettingsInlineMlConfig" +}, +"type": "array" +} +}, +"type": "object" +}, +"WildfireInlineMlSettingsInlineMlConfig": { +"description": "Configuration for WildFire Inline ML analysis per file type.", +"id": "WildfireInlineMlSettingsInlineMlConfig", +"properties": { +"action": { +"description": "Required. Action to take when a threat is detected using Inline ML.", +"enum": [ +"INLINE_ML_ACTION_UNSPECIFIED", +"DISABLE", +"ALERT", +"ENABLE" +], +"enumDescriptions": [ +"Inline ML threat action not specified.", +"Disable WildFire Inline ML for the associated file type.", +"Enable WildFire Inline ML for the associated file type. Overrides any protocol level settings with action stricter than ALERT to ALERT so that the malicious files detected generate a threat log to the consumer project but are not blocked.", +"Enable WildFire Inline ML for the associated file type, malicious files detected will be blocked." +], +"type": "string" +}, +"fileType": { +"description": "Required. File type to configure Inline ML for.", +"enum": [ +"INLINE_ML_CONFIG_UNSPECIFIED", +"WINDOWS_EXECUTABLE", +"POWERSHELL_SCRIPT1", +"POWERSHELL_SCRIPT2", +"ELF", +"MS_OFFICE", +"SHELL", +"OOXML", +"MACHO" +], +"enumDescriptions": [ +"Inline ML config not specified.", +"Enable machine learning engine to dynamically detect malicious PE files.", +"Enable machine learning engine to dynamically identify malicious PowerShell scripts with known length.", +"Enable machine learning engine to dynamically identify malicious PowerShell script without known length.", +"Enable machine learning engine to dynamically detect malicious ELF files.", +"Enable machine learning engine to dynamically detect malicious MSOffice (97-03) files.", +"Enable machine learning engine to dynamically detect malicious Shell files.", +"Enable machine learning engine to dynamically detect malicious Open Office XML files.", +"Enable machine learning engine to dynamically detect malicious Mach-O files." +], +"type": "string" +} +}, +"type": "object" +}, +"WildfireOverride": { +"description": "Defines what action to take for WildFire threats per protocol.", +"id": "WildfireOverride", +"properties": { +"action": { +"description": "Required. Threat action override. For some threat types, only a subset of actions applies.", +"enum": [ +"WILDFIRE_THREAT_ACTION_UNSPECIFIED", +"WILDFIRE_DEFAULT_ACTION", +"WILDFIRE_ALLOW", +"WILDFIRE_ALERT", +"WILDFIRE_DENY" +], +"enumDescriptions": [ +"Threat action not specified.", +"The default action (as specified by the vendor) is taken.", +"The packet matching this rule will be allowed to transmit.", +"The packet matching this rule will be allowed to transmit, but a threat_log entry will be sent to the consumer project.", +"The packet matching this rule will be dropped, and a threat_log entry will be sent to the consumer project." +], +"type": "string" +}, +"protocol": { +"description": "Required. Protocol to match.", +"enum": [ +"WILDFIRE_PROTOCOL_UNSPECIFIED", +"WILDFIRE_SMTP", +"WILDFIRE_SMB", +"WILDFIRE_POP3", +"WILDFIRE_IMAP", +"WILDFIRE_HTTP2", +"WILDFIRE_HTTP", +"WILDFIRE_FTP" +], +"enumDescriptions": [ +"Protocol not specified.", +"SMTP protocol", +"SMB protocol", +"POP3 protocol", +"IMAP protocol", +"HTTP2 protocol", +"HTTP protocol", +"FTP protocol" +], +"type": "string" +} +}, +"type": "object" +}, +"WildfireSubmissionRule": { +"description": "Defines the file types to be submitted for WildFire analysis and the direction of the traffic.", +"id": "WildfireSubmissionRule", +"properties": { +"customFileTypes": { +"$ref": "WildfireSubmissionRuleCustomFileTypes", +"description": "Submit a custom list of file types for WildFire analysis." +}, +"direction": { +"description": "Required. Direction for the files to be analyzed by WildFire.", +"enum": [ +"DIRECTION_UNSPECIFIED", +"UPLOAD", +"DOWNLOAD", +"BOTH" +], +"enumDescriptions": [ +"Direction not specified.", +"Upload direction.", +"Download direction.", +"Both upload and download directions." +], +"type": "string" +}, +"fileSelectionMode": { +"description": "Required. File selection mode for WildFire analysis.", +"enum": [ +"FILE_SELECTION_MODE_UNSPECIFIED", +"ALL_FILE_TYPES", +"CUSTOM_FILE_TYPES" +], +"enumDescriptions": [ +"File selection mode not specified.", +"Submit all the file types for scan.", +"Submit a custom list of file types for scan." +], +"type": "string" +} +}, +"type": "object" +}, +"WildfireSubmissionRuleCustomFileTypes": { +"description": "The options to submit a custom list of file types for scan.", +"id": "WildfireSubmissionRuleCustomFileTypes", +"properties": { +"fileTypes": { +"description": "Required. File types to be submitted for WildFire analysis.", +"items": { +"enum": [ +"FILE_TYPE_UNSPECIFIED", +"APK", +"ARCHIVE", +"EMAIL_LINK", +"FLASH", +"JAR", +"LINUX", +"MS_OFFICE", +"PDF", +"PE", +"SCRIPT" +], +"enumDescriptions": [ +"File type not specified.", +"Android Application Package (APK) files.", +"Roshal Archive (RAR) and 7-Zip (7z) archive files.", +"HTTP/HTTPS links contained in SMTP and POP3 email messages.", +"Adobe Flash applets and Flash content embedded in web pages.", +"Java applets (JAR/class files types).", +"Executable and Linkable Format (ELF) files.", +"Files used by Microsoft Office.", +"Portable Document Format (PDF) files.", +"Portable Executable (PE) files.", +"Various script files. Jscript (JS), VBScript (VBS), PowerShell Scripts (PS1), Batch (BAT), HTML Application (HTA)." +], +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"WildfireThreatOverride": { +"description": "Defines what action to take for a specific WildFire threat_id match.", +"id": "WildfireThreatOverride", +"properties": { +"action": { +"description": "Required. Threat action override.", +"enum": [ +"WILDFIRE_THREAT_ACTION_UNSPECIFIED", +"WILDFIRE_DEFAULT_ACTION", +"WILDFIRE_ALLOW", +"WILDFIRE_ALERT", +"WILDFIRE_DENY" +], +"enumDescriptions": [ +"Threat action not specified.", +"The default action (as specified by the vendor) is taken.", +"The packet matching this rule will be allowed to transmit.", +"The packet matching this rule will be allowed to transmit, but a threat_log entry will be sent to the consumer project.", +"The packet matching this rule will be dropped, and a threat_log entry will be sent to the consumer project." +], +"type": "string" +}, +"threatId": { +"description": "Required. Threat ID to match.", +"type": "string" +} +}, +"type": "object" +}, +"WildfireVerdictChangeRequest": { +"description": "Message for a WildfireVerdictChangeRequest.", +"id": "WildfireVerdictChangeRequest", +"properties": { +"comment": { +"description": "Required. The justification for the verdict change request. Max length 2048 characters.", +"type": "string" +}, +"createTime": { +"description": "Output only. The timestamp when the WildfireVerdictChangeRequest was created.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"fileName": { +"description": "Output only. The file name of the Malware Sample.", +"readOnly": true, +"type": "string" +}, +"fileType": { +"description": "Output only. The file type of the Malware Sample.", +"readOnly": true, +"type": "string" +}, +"finalVerdict": { +"description": "Output only. The final verdict of the Malware Sample.", +"enum": [ +"WILDFIRE_SAMPLE_VERDICT_UNKNOWN", +"BENIGN", +"MALWARE", +"GRAYWARE", +"PHISHING" +], +"enumDescriptions": [ +"Default value. Malware is not yet classified.", +"Sample is safe and does not exhibit malicious behavior.", +"Sample is malware and poses a security threat.", +"Sample does not pose a direct security threat, but might display otherwise obtrusive behavior.", +"Link directs users to a phishing site and poses a security threat." +], +"readOnly": true, +"type": "string" +}, +"name": { +"description": "Output only. Identifier. The relative name of the WildfireVerdictChangeRequest. Output only. This is a unique identifier generated by the third party API. Format: organizations|projects/{project_or_organization}/locations/{location}/firewallEndpoints/{firewall_endpoint}/wildfireVerdictChangeRequests/{wildfire_verdict_change_request_id} Where {wildfire_verdict_change_request_id} is the ID in the format: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", +"readOnly": true, +"type": "string" +}, +"newVerdict": { +"description": "Required. The suggested verdict to apply to the Malware Sample.", +"enum": [ +"WILDFIRE_SAMPLE_VERDICT_UNKNOWN", +"BENIGN", +"MALWARE", +"GRAYWARE", +"PHISHING" +], +"enumDescriptions": [ +"Default value. Malware is not yet classified.", +"Sample is safe and does not exhibit malicious behavior.", +"Sample is malware and poses a security threat.", +"Sample does not pose a direct security threat, but might display otherwise obtrusive behavior.", +"Link directs users to a phishing site and poses a security threat." +], +"type": "string" +}, +"oldVerdict": { +"description": "Output only. The original verdict of the Malware Sample.", +"enum": [ +"WILDFIRE_SAMPLE_VERDICT_UNKNOWN", +"BENIGN", +"MALWARE", +"GRAYWARE", +"PHISHING" +], +"enumDescriptions": [ +"Default value. Malware is not yet classified.", +"Sample is safe and does not exhibit malicious behavior.", +"Sample is malware and poses a security threat.", +"Sample does not pose a direct security threat, but might display otherwise obtrusive behavior.", +"Link directs users to a phishing site and poses a security threat." +], +"readOnly": true, +"type": "string" +}, +"resolutionTime": { +"description": "Output only. The timestamp when the WildfireVerdictChangeRequest was resolved.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"sha256": { +"description": "Required. The SHA256 hash of the Malware Sample to change the verdict of.", +"type": "string" +}, +"sourceRegion": { +"description": "Output only. The region of the file associated with the Malware Sample.", +"readOnly": true, +"type": "string" +}, +"state": { +"description": "Output only. The review state of the WildfireVerdictChangeRequest.", +"enum": [ +"VERDICT_CHANGE_REQUEST_STATE_UNSPECIFIED", +"OPEN", +"CLOSED", +"PENDING" +], +"enumDescriptions": [ +"Default value. Request does not have a state. This value is unused.", +"Request has been created and review has not started.", +"Malware Sample has been reviewed and the final verdict has been updated.", +"Malware Sample is currently being reviewed." +], +"readOnly": true, +"type": "string" +}, +"updateTime": { +"description": "Output only. The timestamp when the WildfireVerdictChangeRequest was last updated.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"wildfireVerdictChangeRequestId": { +"description": "Output only. The ID of the WildfireVerdictChangeRequest. This is a unique identifier generated by the third party API. Format: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", +"readOnly": true, +"type": "string" +} +}, +"type": "object" } }, "servicePath": "", diff --git a/googleapiclient/discovery_cache/documents/notebooks.v1.json b/googleapiclient/discovery_cache/documents/notebooks.v1.json index 0011252103..48511322bc 100644 --- a/googleapiclient/discovery_cache/documents/notebooks.v1.json +++ b/googleapiclient/discovery_cache/documents/notebooks.v1.json @@ -135,7 +135,7 @@ ] }, "list": { -"description": "Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the [ListLocationsRequest.name] field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.", +"description": "Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the ListLocationsRequest.name field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.", "flatPath": "v1/projects/{projectsId}/locations", "httpMethod": "GET", "id": "notebooks.projects.locations.list", @@ -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. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -2019,7 +2019,7 @@ } } }, -"revision": "20260401", +"revision": "20260521", "rootUrl": "https://notebooks.googleapis.com/", "schemas": { "AcceleratorConfig": { diff --git a/googleapiclient/discovery_cache/documents/notebooks.v2.json b/googleapiclient/discovery_cache/documents/notebooks.v2.json index 965d695607..354a9ab07f 100644 --- a/googleapiclient/discovery_cache/documents/notebooks.v2.json +++ b/googleapiclient/discovery_cache/documents/notebooks.v2.json @@ -135,7 +135,7 @@ ] }, "list": { -"description": "Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the [ListLocationsRequest.name] field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.", +"description": "Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the ListLocationsRequest.name field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.", "flatPath": "v2/projects/{projectsId}/locations", "httpMethod": "GET", "id": "notebooks.projects.locations.list", @@ -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. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -971,7 +971,7 @@ } } }, -"revision": "20260401", +"revision": "20260521", "rootUrl": "https://notebooks.googleapis.com/", "schemas": { "AcceleratorConfig": { @@ -1000,7 +1000,8 @@ "NVIDIA_TESLA_T4_VWS", "NVIDIA_TESLA_P100_VWS", "NVIDIA_TESLA_P4_VWS", -"NVIDIA_B200" +"NVIDIA_B200", +"NVIDIA_RTX6000" ], "enumDescriptions": [ "Accelerator type is not specified.", @@ -1017,7 +1018,8 @@ "Accelerator type is NVIDIA Tesla T4 Virtual Workstations.", "Accelerator type is NVIDIA Tesla P100 Virtual Workstations.", "Accelerator type is NVIDIA Tesla P4 Virtual Workstations.", -"Accelerator type is NVIDIA B200." +"Accelerator type is NVIDIA B200.", +"NVIDIA RTX 6000." ], "type": "string" } @@ -2309,7 +2311,12 @@ "UpgradeInstanceRequest": { "description": "Request for upgrading a notebook instance", "id": "UpgradeInstanceRequest", -"properties": {}, +"properties": { +"imageFamily": { +"description": "Optional. The Compute Engine image family resource name to upgrade to. Format: `projects/{project_id}/global/images/family/{image_family}` If specified, the instance will be upgraded to the latest image in the specified image family, allowing upgrades across image families. If not specified, the instance will be upgraded to the latest image in its current image family.", +"type": "string" +} +}, "type": "object" }, "UpgradeInstanceSystemRequest": { diff --git a/googleapiclient/discovery_cache/documents/observability.v1.json b/googleapiclient/discovery_cache/documents/observability.v1.json index 057ab3d742..e33cd2938b 100644 --- a/googleapiclient/discovery_cache/documents/observability.v1.json +++ b/googleapiclient/discovery_cache/documents/observability.v1.json @@ -33,6 +33,11 @@ }, { "description": "Regional Endpoint", +"endpointUrl": "https://observability.asia-northeast1.rep.googleapis.com/", +"location": "asia-northeast1" +}, +{ +"description": "Regional Endpoint", "endpointUrl": "https://observability.asia-northeast2.rep.googleapis.com/", "location": "asia-northeast2" }, @@ -53,6 +58,11 @@ }, { "description": "Regional Endpoint", +"endpointUrl": "https://observability.asia-southeast1.rep.googleapis.com/", +"location": "asia-southeast1" +}, +{ +"description": "Regional Endpoint", "endpointUrl": "https://observability.asia-southeast2.rep.googleapis.com/", "location": "asia-southeast2" }, @@ -63,21 +73,56 @@ }, { "description": "Regional Endpoint", +"endpointUrl": "https://observability.australia-southeast1.rep.googleapis.com/", +"location": "australia-southeast1" +}, +{ +"description": "Regional Endpoint", "endpointUrl": "https://observability.australia-southeast2.rep.googleapis.com/", "location": "australia-southeast2" }, { "description": "Regional Endpoint", +"endpointUrl": "https://observability.europe-central2.rep.googleapis.com/", +"location": "europe-central2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://observability.europe-north1.rep.googleapis.com/", +"location": "europe-north1" +}, +{ +"description": "Regional Endpoint", "endpointUrl": "https://observability.europe-north2.rep.googleapis.com/", "location": "europe-north2" }, { "description": "Regional Endpoint", +"endpointUrl": "https://observability.europe-southwest1.rep.googleapis.com/", +"location": "europe-southwest1" +}, +{ +"description": "Regional Endpoint", "endpointUrl": "https://observability.europe-west1.rep.googleapis.com/", "location": "europe-west1" }, { "description": "Regional Endpoint", +"endpointUrl": "https://observability.europe-west10.rep.googleapis.com/", +"location": "europe-west10" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://observability.europe-west12.rep.googleapis.com/", +"location": "europe-west12" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://observability.europe-west2.rep.googleapis.com/", +"location": "europe-west2" +}, +{ +"description": "Regional Endpoint", "endpointUrl": "https://observability.europe-west3.rep.googleapis.com/", "location": "europe-west3" }, @@ -103,6 +148,21 @@ }, { "description": "Regional Endpoint", +"endpointUrl": "https://observability.me-central2.rep.googleapis.com/", +"location": "me-central2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://observability.me-west1.rep.googleapis.com/", +"location": "me-west1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://observability.northamerica-northeast1.rep.googleapis.com/", +"location": "northamerica-northeast1" +}, +{ +"description": "Regional Endpoint", "endpointUrl": "https://observability.northamerica-northeast2.rep.googleapis.com/", "location": "northamerica-northeast2" }, @@ -113,6 +173,11 @@ }, { "description": "Regional Endpoint", +"endpointUrl": "https://observability.southamerica-east1.rep.googleapis.com/", +"location": "southamerica-east1" +}, +{ +"description": "Regional Endpoint", "endpointUrl": "https://observability.southamerica-west1.rep.googleapis.com/", "location": "southamerica-west1" }, @@ -123,11 +188,21 @@ }, { "description": "Regional Endpoint", +"endpointUrl": "https://observability.us-central2.rep.googleapis.com/", +"location": "us-central2" +}, +{ +"description": "Regional Endpoint", "endpointUrl": "https://observability.us-east1.rep.googleapis.com/", "location": "us-east1" }, { "description": "Regional Endpoint", +"endpointUrl": "https://observability.us-east4.rep.googleapis.com/", +"location": "us-east4" +}, +{ +"description": "Regional Endpoint", "endpointUrl": "https://observability.us-east5.rep.googleapis.com/", "location": "us-east5" }, @@ -153,6 +228,11 @@ }, { "description": "Regional Endpoint", +"endpointUrl": "https://observability.us-west4.rep.googleapis.com/", +"location": "us-west4" +}, +{ +"description": "Regional Endpoint", "endpointUrl": "https://observability.us.rep.googleapis.com/", "location": "us" }, @@ -1646,7 +1726,7 @@ } } }, -"revision": "20260423", +"revision": "20260514", "rootUrl": "https://observability.googleapis.com/", "schemas": { "Bucket": { diff --git a/googleapiclient/discovery_cache/documents/oracledatabase.v1.json b/googleapiclient/discovery_cache/documents/oracledatabase.v1.json index 62b5051341..e00039982e 100644 --- a/googleapiclient/discovery_cache/documents/oracledatabase.v1.json +++ b/googleapiclient/discovery_cache/documents/oracledatabase.v1.json @@ -3297,7 +3297,7 @@ } } }, -"revision": "20260512", +"revision": "20260526", "rootUrl": "https://oracledatabase.googleapis.com/", "schemas": { "AllConnectionStrings": { @@ -4982,15 +4982,13 @@ "type": "array" }, "scanListenerPortTcp": { -"description": "Output only. SCAN listener port - TCP", +"description": "Optional. SCAN listener port - TCP", "format": "int32", -"readOnly": true, "type": "integer" }, "scanListenerPortTcpSsl": { -"description": "Output only. SCAN listener port - TLS", +"description": "Optional. SCAN listener port - TLS", "format": "int32", -"readOnly": true, "type": "integer" }, "shape": { @@ -5940,7 +5938,7 @@ ], "enumDescriptions": [ "The storage management is unspecified.", -"Automatic storage management.", +"Automatic storage management. This option is not supported. Only LVM is supported.", "Logical Volume management." ], "type": "string" @@ -8467,7 +8465,7 @@ "id": "GoldengateGoogleBigQueryConnectionProperties", "properties": { "serviceAccountKeyFile": { -"description": "Optional. The service account key file Cloud Storage containing the credentials required to use Google BigQuery.", +"description": "Optional. The base64 encoded content of the service account key file containing the credentials required to use Google BigQuery.", "type": "string" }, "technologyType": { @@ -8482,7 +8480,7 @@ "id": "GoldengateGoogleCloudStorageConnectionProperties", "properties": { "serviceAccountKeyFile": { -"description": "Optional. The service account key Cloud Storage file containing the credentials required to use Google Cloud Storage.", +"description": "Optional. The base64 encoded content of the service account key file containing the credentials required to use Google Cloud Storage.", "type": "string" }, "technologyType": { @@ -8497,7 +8495,7 @@ "id": "GoldengateGooglePubsubConnectionProperties", "properties": { "serviceAccountKeyFile": { -"description": "Optional. The content of the service account key file containing the credentials required to use Google Pub/Sub.", +"description": "Optional. The base64 encoded content of the service account key file containing the credentials required to use Google Pub/Sub.", "type": "string" }, "technologyType": { @@ -8615,7 +8613,7 @@ "type": "string" }, "keyStoreFile": { -"description": "Optional. The content of the KeyStore file.", +"description": "Optional. The base64 encoded content of the KeyStore file.", "type": "string" }, "keyStorePassword": { @@ -8663,7 +8661,7 @@ "type": "string" }, "trustStoreFile": { -"description": "Optional. The content of the TrustStore file.", +"description": "Optional. The base64 encoded content of the TrustStore file.", "type": "string" }, "trustStorePassword": { @@ -8701,11 +8699,11 @@ "type": "string" }, "consumerPropertiesFile": { -"description": "Optional. The content of the consumer.properties file.", +"description": "Optional. The base64 encoded content of the consumer.properties file.", "type": "string" }, "keyStoreFile": { -"description": "Optional. The content of the KeyStore file.", +"description": "Optional. The base64 encoded content of the KeyStore file.", "type": "string" }, "keyStorePassword": { @@ -8725,7 +8723,7 @@ "type": "string" }, "producerPropertiesFile": { -"description": "Optional. The content of the producer.properties file.", +"description": "Optional. The base64 encoded content of the producer.properties file.", "type": "string" }, "securityProtocol": { @@ -8763,7 +8761,7 @@ "type": "string" }, "trustStoreFile": { -"description": "Optional. The content of the TrustStore file.", +"description": "Optional. The base64 encoded content of the TrustStore file.", "type": "string" }, "trustStorePassword": { @@ -8806,7 +8804,7 @@ "type": "string" }, "keyStoreFile": { -"description": "Optional. The content of the KeyStore file.", +"description": "Optional. The base64 encoded content of the KeyStore file.", "type": "string" }, "keyStorePassword": { @@ -8838,7 +8836,7 @@ "type": "string" }, "trustStoreFile": { -"description": "Optional. The content of the TrustStore file.", +"description": "Optional. The base64 encoded content of the TrustStore file.", "type": "string" }, "trustStorePassword": { @@ -9005,7 +9003,7 @@ "type": "boolean" }, "sslCaFile": { -"description": "Optional. Database Certificate - The content of a .pem or .crt file containing the server public key (for 1-way SSL).", +"description": "Optional. Database Certificate - The base64 encoded content of a .pem or .crt file containing the server public key (for 1-way SSL).", "type": "string" }, "technologyType": { @@ -9060,11 +9058,11 @@ "type": "string" }, "tlsCaFile": { -"description": "Optional. Database Certificate - The content of a .pem file, containing the server public key (for 1 and 2-way SSL).", +"description": "Optional. Database Certificate - The base64 encoded content of a .pem file, containing the server public key (for 1 and 2-way SSL).", "type": "string" }, "tlsCertificateKeyFile": { -"description": "Optional. Client Certificate - The content of a .pem file, containing the client public key (for 2-way SSL).", +"description": "Optional. Client Certificate - The base64 encoded content of a .pem file, containing the client public key (for 2-way SSL).", "type": "string" }, "tlsCertificateKeyFilePassword": { @@ -9135,19 +9133,19 @@ "type": "string" }, "sslCaFile": { -"description": "Optional. Database Certificate - The content of a .pem or .crt file containing the server public key (for 1 and 2-way SSL).", +"description": "Optional. Database Certificate - The base64 encoded content of a .pem or .crt file containing the server public key (for 1 and 2-way SSL).", "type": "string" }, "sslCertFile": { -"description": "Optional. Client Certificate - The content of a .pem or .crt file containing the client public key (for 2-way SSL).", +"description": "Optional. Client Certificate - The base64 encoded content of a .pem or .crt file containing the client public key (for 2-way SSL).", "type": "string" }, "sslCrlFile": { -"description": "Optional. The list of certificates revoked by the trusted certificate authorities (Trusted CA).", +"description": "Optional. The base64 encoded list of certificates revoked by the trusted certificate authorities (Trusted CA).", "type": "string" }, "sslKeyFile": { -"description": "Optional. Client Key - The content of a .pem or .crt file containing the client private key (for 2-way SSL).", +"description": "Optional. Client Key - The base64 encoded content of a .pem or .crt file containing the client private key (for 2-way SSL).", "type": "string" }, "sslMode": { @@ -9382,7 +9380,7 @@ "type": "string" }, "walletFile": { -"description": "Optional. The wallet contents Oracle Goldengate uses to make connections to a database.", +"description": "Optional. The wallet contents Oracle Goldengate uses to make connections to a database. This attribute is expected to be base64 encoded.", "type": "string" } }, @@ -9497,19 +9495,19 @@ "type": "string" }, "sslCaFile": { -"description": "Optional. The certificate of the trusted certificate authorities (Trusted CA) for PostgreSQL.", +"description": "Optional. The base64 encoded certificate of the trusted certificate authorities (Trusted CA) for PostgreSQL.", "type": "string" }, "sslCertFile": { -"description": "Optional. The certificate of the PostgreSQL server.", +"description": "Optional. The base64 encoded certificate of the PostgreSQL server.", "type": "string" }, "sslCrlFile": { -"description": "Optional. The list of certificates revoked by the trusted certificate authorities (Trusted CA).", +"description": "Optional. The base64 encoded list of certificates revoked by the trusted certificate authorities (Trusted CA).", "type": "string" }, "sslKeyFile": { -"description": "Optional. The private key of the PostgreSQL server.", +"description": "Optional. The base64 encoded private key of the PostgreSQL server.", "type": "string" }, "sslMode": { @@ -9560,7 +9558,7 @@ "type": "string" }, "keyStoreFile": { -"description": "Optional. The content of the KeyStore file.", +"description": "Optional. The base64 encoded content of the KeyStore file.", "type": "string" }, "keyStorePassword": { @@ -9608,7 +9606,7 @@ "type": "string" }, "trustStoreFile": { -"description": "Optional. The content of the TrustStore file.", +"description": "Optional. The base64 encoded content of the TrustStore file.", "type": "string" }, "trustStorePassword": { @@ -9688,7 +9686,7 @@ "type": "string" }, "serviceAccountKeyFile": { -"description": "Optional. The service account key file of Google Cloud Storage.", +"description": "Optional. The base64 encoded content of the service account key file of Google Cloud Storage.", "type": "string" } }, @@ -11188,7 +11186,7 @@ "id": "RestIcebergCatalog", "properties": { "properties": { -"description": "Optional. The content of the configuration file containing additional properties for the REST catalog.", +"description": "Optional. The base64 encoded content of the configuration file containing additional properties for the REST catalog.", "type": "string" }, "uri": { diff --git a/googleapiclient/discovery_cache/documents/places.v1.json b/googleapiclient/discovery_cache/documents/places.v1.json index 7e0d91e579..af8ce75b55 100644 --- a/googleapiclient/discovery_cache/documents/places.v1.json +++ b/googleapiclient/discovery_cache/documents/places.v1.json @@ -280,7 +280,7 @@ } } }, -"revision": "20260323", +"revision": "20260524", "rootUrl": "https://places.googleapis.com/", "schemas": { "GoogleGeoTypeViewport": { @@ -691,11 +691,11 @@ "type": "object" }, "GoogleMapsPlacesV1ContextualContent": { -"description": "Experimental: See https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative for more details. Content that is contextual to the place query.", +"description": "Content that is contextual to the place query.", "id": "GoogleMapsPlacesV1ContextualContent", "properties": { "justifications": { -"description": "Experimental: See https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative for more details. Justifications for the place.", +"description": "Justifications for the place.", "items": { "$ref": "GoogleMapsPlacesV1ContextualContentJustification" }, @@ -719,22 +719,20 @@ "type": "object" }, "GoogleMapsPlacesV1ContextualContentJustification": { -"description": "Experimental: See https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative for more details. Justifications for the place. Justifications answers the question of why a place could interest an end user.", +"description": "Justifications for the place. Justifications answers the question of why a place could interest an end user.", "id": "GoogleMapsPlacesV1ContextualContentJustification", "properties": { "businessAvailabilityAttributesJustification": { -"$ref": "GoogleMapsPlacesV1ContextualContentJustificationBusinessAvailabilityAttributesJustification", -"description": "Experimental: See https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative for more details." +"$ref": "GoogleMapsPlacesV1ContextualContentJustificationBusinessAvailabilityAttributesJustification" }, "reviewJustification": { -"$ref": "GoogleMapsPlacesV1ContextualContentJustificationReviewJustification", -"description": "Experimental: See https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative for more details." +"$ref": "GoogleMapsPlacesV1ContextualContentJustificationReviewJustification" } }, "type": "object" }, "GoogleMapsPlacesV1ContextualContentJustificationBusinessAvailabilityAttributesJustification": { -"description": "Experimental: See https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative for more details. BusinessAvailabilityAttributes justifications. This shows some attributes a business has that could interest an end user.", +"description": "BusinessAvailabilityAttributes justifications. This shows some attributes a business has that could interest an end user.", "id": "GoogleMapsPlacesV1ContextualContentJustificationBusinessAvailabilityAttributesJustification", "properties": { "delivery": { @@ -753,7 +751,7 @@ "type": "object" }, "GoogleMapsPlacesV1ContextualContentJustificationReviewJustification": { -"description": "Experimental: See https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative for more details. User review justifications. This highlights a section of the user review that would interest an end user. For instance, if the search query is \"firewood pizza\", the review justification highlights the text relevant to the search query.", +"description": "User review justifications. This highlights a section of the user review that would interest an end user. For instance, if the search query is \"firewood pizza\", the review justification highlights the text relevant to the search query.", "id": "GoogleMapsPlacesV1ContextualContentJustificationReviewJustification", "properties": { "highlightedText": { @@ -1357,6 +1355,10 @@ "$ref": "GoogleTypeTimeZone", "description": "IANA Time Zone Database time zone. For example \"America/New_York\"." }, +"transitStation": { +"$ref": "GoogleMapsPlacesV1TransitStation", +"description": "The transit station information for the place." +}, "types": { "description": "A set of type tags for this result. For example, \"political\" and \"locality\". For the complete list of possible values, see Table A and Table B at https://developers.google.com/maps/documentation/places/web-service/place-types", "items": { @@ -2384,6 +2386,202 @@ }, "type": "object" }, +"GoogleMapsPlacesV1TransitAgency": { +"description": "Represents a transit agency.", +"id": "GoogleMapsPlacesV1TransitAgency", +"properties": { +"displayName": { +"$ref": "GoogleTypeLocalizedText", +"description": "Agency name (e.g. \"VTA\") in the requested language." +}, +"fareUrl": { +"description": "The URL of the agency's fare details page.", +"type": "string" +}, +"icon": { +"$ref": "GoogleMapsPlacesV1TransitIcon", +"description": "Icon identifier for localized branded icon of a transit system (e.g. London Underground) which should be used instead of TransitLine.vehicle_icon in the UI." +}, +"lines": { +"description": "The transit lines that are served by this agency.", +"items": { +"$ref": "GoogleMapsPlacesV1TransitLine" +}, +"type": "array" +}, +"url": { +"description": "The URL of the agency's homepage.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleMapsPlacesV1TransitIcon": { +"description": "Icon for a transit line, vehicle, or agency.", +"id": "GoogleMapsPlacesV1TransitIcon", +"properties": { +"nameIncluded": { +"description": "Whether the name is contained in the icon and there is no need to display it next to the icon.", +"type": "boolean" +}, +"url": { +"description": "The URL of the icon.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleMapsPlacesV1TransitLine": { +"description": "Represents a single transit line.", +"id": "GoogleMapsPlacesV1TransitLine", +"properties": { +"backgroundColor": { +"description": "The background color of the labels for this transit line in #RRGGBB hex format, e.g. #909CE1. This color can also be used for drawing shapes for this transit line.", +"type": "string" +}, +"displayName": { +"$ref": "GoogleTypeLocalizedText", +"description": "The long name for this transit line (e.g. \"Sunnydale local\")." +}, +"icon": { +"$ref": "GoogleMapsPlacesV1TransitIcon", +"description": "Icon identifier for this particular line (e.g. subway lines in New York)." +}, +"id": { +"description": "The id of the transit line that can be used to uniquely identify the line among other transit lines in the same transit station. This identifier is not guaranteed to be stable across different responses.", +"type": "string" +}, +"shortDisplayName": { +"$ref": "GoogleTypeLocalizedText", +"description": "The short name for this transit line (e.g. \"S2\")." +}, +"textColor": { +"description": "The text color of labels for this transit line in #RRGGBB hex format, e.g. #909CE1.", +"type": "string" +}, +"url": { +"description": "The URL of a webpage with details about this line.", +"type": "string" +}, +"vehicleIcon": { +"$ref": "GoogleMapsPlacesV1TransitIcon", +"description": "Icon identifier for this particular vehicle type." +}, +"vehicleType": { +"description": "The type of vehicle using this line.", +"enum": [ +"VEHICLE_TYPE_UNSPECIFIED", +"RAIL", +"METRO_RAIL", +"SUBWAY", +"TRAM", +"MONORAIL", +"HEAVY_RAIL", +"COMMUTER_TRAIN", +"HIGH_SPEED_TRAIN", +"LONG_DISTANCE_TRAIN", +"BUS", +"INTERCITY_BUS", +"TROLLEYBUS", +"SHARE_TAXI", +"COACH", +"FERRY", +"CABLE_CAR", +"GONDOLA_LIFT", +"FUNICULAR", +"SPECIAL", +"HORSE_CARRIAGE", +"AIRPLANE" +], +"enumDescriptions": [ +"Default value when vehicle type is not specified.", +"Rail.", +"Metro rail.", +"Subway.", +"Tram.", +"Monorail.", +"Heavy rail.", +"Commuter train.", +"High speed train.", +"Long distance train.", +"Bus.", +"Intercity bus.", +"Trolleybus.", +"Share taxi.", +"Coach.", +"Ferry.", +"Cable car.", +"Gondola lift.", +"Funicular.", +"Special.", +"Horse carriage.", +"Airplane." +], +"type": "string" +} +}, +"type": "object" +}, +"GoogleMapsPlacesV1TransitStation": { +"description": "Represents transit-specific information for a place.", +"id": "GoogleMapsPlacesV1TransitStation", +"properties": { +"agencies": { +"description": "The transit agencies that serve this station.", +"items": { +"$ref": "GoogleMapsPlacesV1TransitAgency" +}, +"type": "array" +}, +"displayName": { +"$ref": "GoogleTypeLocalizedText", +"description": "The name of the station in the local language." +}, +"stops": { +"description": "Transit stops at this station.", +"items": { +"$ref": "GoogleMapsPlacesV1TransitStop" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleMapsPlacesV1TransitStop": { +"description": "Represents a transit stop within a station. This is a specific location where passengers board and alight transit vehicles, such as a platform or bus bay. This is distinct from a `Departure`, which is an event of a vehicle leaving a stop at a specific time.", +"id": "GoogleMapsPlacesV1TransitStop", +"properties": { +"displayName": { +"$ref": "GoogleTypeLocalizedText", +"description": "The name of the stop." +}, +"id": { +"description": "The id of the transit stop that can be used to uniquely identify the stop among other transit stops in the same transit station. This identifier is not guaranteed to be stable across different responses.", +"type": "string" +}, +"location": { +"$ref": "GoogleTypeLatLng", +"description": "The stop's location." +}, +"platformCode": { +"$ref": "GoogleTypeLocalizedText", +"description": "The platform code represented by this stop. It can be formatted in any way. (eg: \"2\", \"Platform 2\", \"2-4\", or \"1x\")." +}, +"signageText": { +"$ref": "GoogleTypeLocalizedText", +"description": "The verbatim text written on the signboard for this platform, e.g. \"Towards Central\" or \"East side & Brooklyn\". When `platform_code` is absent, this field is potentially the only identifier for the platform; however, both `platform_code` and `signage_text` may be set simultaneously." +}, +"stopCode": { +"$ref": "GoogleTypeLocalizedText", +"description": "Human readable identifier of the stop, used by transit agencies to distinguish stops with the same name." +}, +"wheelchairAccessibleEntrance": { +"description": "Wheelchair accessibility of this stop. This field indicates whether there is an accessible path from outside the station to the stop. It does not indicate whether it is possible to board a vehicle from the stop.", +"type": "boolean" +} +}, +"type": "object" +}, "GoogleTypeDate": { "description": "Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp", "id": "GoogleTypeDate", diff --git a/googleapiclient/discovery_cache/documents/recaptchaenterprise.v1.json b/googleapiclient/discovery_cache/documents/recaptchaenterprise.v1.json index c2e6c01d65..4e44a387c1 100644 --- a/googleapiclient/discovery_cache/documents/recaptchaenterprise.v1.json +++ b/googleapiclient/discovery_cache/documents/recaptchaenterprise.v1.json @@ -786,7 +786,7 @@ } } }, -"revision": "20260505", +"revision": "20260517", "rootUrl": "https://recaptchaenterprise.googleapis.com/", "schemas": { "GoogleCloudRecaptchaenterpriseV1AccountDefenderAssessment": { @@ -833,13 +833,15 @@ "RISK_REASON_UNSPECIFIED", "CLIENT_HISTORICAL_BOT_ACTIVITY", "ACCOUNT_IN_LARGE_RELATED_GROUP", -"CLIENT_ACCESSED_MANY_ACCOUNTS" +"CLIENT_ACCESSED_MANY_ACCOUNTS", +"DISPOSABLE_EMAIL_DOMAIN" ], "enumDescriptions": [ "Default unspecified type.", "The client has been observed sending bot-like traffic to this site in the past. This reason incorporates historical reputation and indicates that the client is known to use bots, even if the current request is being made by a human.", "The account is part of a large group of related accounts, indicating that it may be part of a fraudulent network. Related accounts are identified based on having similar traffic patterns and request characteristics.", -"The client has been observed accessing many accounts on this site." +"The client has been observed accessing many accounts on this site.", +"This email domain is a suspected provider of disposable email addresses." ], "readOnly": true, "type": "string" diff --git a/googleapiclient/discovery_cache/documents/redis.v1.json b/googleapiclient/discovery_cache/documents/redis.v1.json index 79f7e8429f..d17fe1505c 100644 --- a/googleapiclient/discovery_cache/documents/redis.v1.json +++ b/googleapiclient/discovery_cache/documents/redis.v1.json @@ -1608,7 +1608,7 @@ } } }, -"revision": "20260423", +"revision": "20260526", "rootUrl": "https://redis.googleapis.com/", "schemas": { "AOFConfig": { @@ -3321,9 +3321,17 @@ false "type": "object" }, "DatabaseResourceMetadata": { -"description": "Common model for database resource instance metadata. Next ID: 32", +"description": "Common model for database resource instance metadata. Next ID: 35", "id": "DatabaseResourceMetadata", "properties": { +"additionalMetadata": { +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" +}, +"description": "Field to ingest additional metadata whichd does not support proto format.", +"type": "object" +}, "availabilityConfiguration": { "$ref": "AvailabilityConfiguration", "description": "Availability configuration for this instance" @@ -3477,6 +3485,18 @@ false ], "type": "string" }, +"internalAdditionalMetadata": { +"additionalProperties": { +"description": "Properties of the object. Contains field @type with type URL.", +"type": "any" +}, +"description": "Field to ingest additional metadata which support proto format.", +"type": "object" +}, +"ipAddress": { +"$ref": "IpAddress", +"description": "Optional. Private and public IP address of the resource." +}, "isDeletionProtectionEnabled": { "description": "Optional. Whether deletion protection is enabled for this resource.", "type": "boolean" @@ -4703,6 +4723,21 @@ false }, "type": "object" }, +"IpAddress": { +"description": "Used to send IP address information for a database resource.", +"id": "IpAddress", +"properties": { +"privateIp": { +"description": "The private IP address assigned to the resource within a Virtual Private Cloud (VPC). This IP is only reachable from within the same VPC network. Stored in standard string format (e.g., \"10.0.0.2\").", +"type": "string" +}, +"publicIp": { +"description": "The public IP address assigned to the resource. This IP is reachable from the internet. Stored in standard string format (e.g., \"34.72.1.1\").", +"type": "string" +} +}, +"type": "object" +}, "ListAclPoliciesResponse": { "description": "Response for `ListAclPolicies`.", "id": "ListAclPoliciesResponse", @@ -5373,6 +5408,7 @@ false "ENGINE_CLOUD_SPANNER_WITH_GOOGLESQL_DIALECT", "ENGINE_MEMORYSTORE_FOR_REDIS", "ENGINE_MEMORYSTORE_FOR_REDIS_CLUSTER", +"ENGINE_MEMORSTORE_FOR_VALKEY", "ENGINE_OTHER", "ENGINE_FIRESTORE_WITH_NATIVE_MODE", "ENGINE_FIRESTORE_WITH_DATASTORE_MODE", @@ -5399,6 +5435,7 @@ false, false, false, false, +false, false ], "enumDescriptions": [ @@ -5415,6 +5452,7 @@ false "Cloud Spanner with Google SQL dialect.", "Memorystore with Redis dialect.", "Memorystore with Redis cluster dialect.", +"Memorystore with Valkey dialect.", "Other refers to rest of other database engine. This is to be when engine is known, but it is not present in this enum.", "Firestore with native mode.", "Firestore with datastore mode.", @@ -5909,6 +5947,13 @@ false "description": "Optional. Current Maintenance version of the database resource. Example: \"MYSQL_8_0_41.R20250531.01_15\"", "type": "string" }, +"nextAvailableMaintenanceVersions": { +"description": "Optional. List of next available maintenance versions.", +"items": { +"type": "string" +}, +"type": "array" +}, "upcomingMaintenance": { "$ref": "UpcomingMaintenance", "description": "Optional. Upcoming maintenance for the database resource. This field is populated once SLM generates and publishes upcoming maintenance window." diff --git a/googleapiclient/discovery_cache/documents/redis.v1beta1.json b/googleapiclient/discovery_cache/documents/redis.v1beta1.json index 8f221cddbc..69f3bee766 100644 --- a/googleapiclient/discovery_cache/documents/redis.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/redis.v1beta1.json @@ -1604,7 +1604,7 @@ } } }, -"revision": "20260423", +"revision": "20260526", "rootUrl": "https://redis.googleapis.com/", "schemas": { "AOFConfig": { @@ -3317,9 +3317,17 @@ false "type": "object" }, "DatabaseResourceMetadata": { -"description": "Common model for database resource instance metadata. Next ID: 32", +"description": "Common model for database resource instance metadata. Next ID: 35", "id": "DatabaseResourceMetadata", "properties": { +"additionalMetadata": { +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" +}, +"description": "Field to ingest additional metadata whichd does not support proto format.", +"type": "object" +}, "availabilityConfiguration": { "$ref": "AvailabilityConfiguration", "description": "Availability configuration for this instance" @@ -3473,6 +3481,18 @@ false ], "type": "string" }, +"internalAdditionalMetadata": { +"additionalProperties": { +"description": "Properties of the object. Contains field @type with type URL.", +"type": "any" +}, +"description": "Field to ingest additional metadata which support proto format.", +"type": "object" +}, +"ipAddress": { +"$ref": "IpAddress", +"description": "Optional. Private and public IP address of the resource." +}, "isDeletionProtectionEnabled": { "description": "Optional. Whether deletion protection is enabled for this resource.", "type": "boolean" @@ -4706,6 +4726,21 @@ false }, "type": "object" }, +"IpAddress": { +"description": "Used to send IP address information for a database resource.", +"id": "IpAddress", +"properties": { +"privateIp": { +"description": "The private IP address assigned to the resource within a Virtual Private Cloud (VPC). This IP is only reachable from within the same VPC network. Stored in standard string format (e.g., \"10.0.0.2\").", +"type": "string" +}, +"publicIp": { +"description": "The public IP address assigned to the resource. This IP is reachable from the internet. Stored in standard string format (e.g., \"34.72.1.1\").", +"type": "string" +} +}, +"type": "object" +}, "ListAclPoliciesResponse": { "description": "Response for `ListAclPolicies`.", "id": "ListAclPoliciesResponse", @@ -5376,6 +5411,7 @@ false "ENGINE_CLOUD_SPANNER_WITH_GOOGLESQL_DIALECT", "ENGINE_MEMORYSTORE_FOR_REDIS", "ENGINE_MEMORYSTORE_FOR_REDIS_CLUSTER", +"ENGINE_MEMORSTORE_FOR_VALKEY", "ENGINE_OTHER", "ENGINE_FIRESTORE_WITH_NATIVE_MODE", "ENGINE_FIRESTORE_WITH_DATASTORE_MODE", @@ -5402,6 +5438,7 @@ false, false, false, false, +false, false ], "enumDescriptions": [ @@ -5418,6 +5455,7 @@ false "Cloud Spanner with Google SQL dialect.", "Memorystore with Redis dialect.", "Memorystore with Redis cluster dialect.", +"Memorystore with Valkey dialect.", "Other refers to rest of other database engine. This is to be when engine is known, but it is not present in this enum.", "Firestore with native mode.", "Firestore with datastore mode.", @@ -5912,6 +5950,13 @@ false "description": "Optional. Current Maintenance version of the database resource. Example: \"MYSQL_8_0_41.R20250531.01_15\"", "type": "string" }, +"nextAvailableMaintenanceVersions": { +"description": "Optional. List of next available maintenance versions.", +"items": { +"type": "string" +}, +"type": "array" +}, "upcomingMaintenance": { "$ref": "UpcomingMaintenance", "description": "Optional. Upcoming maintenance for the database resource. This field is populated once SLM generates and publishes upcoming maintenance window." diff --git a/googleapiclient/discovery_cache/documents/run.v1.json b/googleapiclient/discovery_cache/documents/run.v1.json index 07db05cef4..a0d787f659 100644 --- a/googleapiclient/discovery_cache/documents/run.v1.json +++ b/googleapiclient/discovery_cache/documents/run.v1.json @@ -3612,7 +3612,7 @@ } } }, -"revision": "20260512", +"revision": "20260522", "rootUrl": "https://run.googleapis.com/", "schemas": { "Addressable": { @@ -6302,11 +6302,6 @@ false "description": "Optional. Email address of the IAM service account associated with the Instance. The service account represents the identity of the running container, and determines what permissions the Instance has. If not provided, the Instance will use the project's default service account.", "type": "string" }, -"timeout": { -"description": "Optional. Duration the instance may be active before the system will shut it down.", -"format": "google-duration", -"type": "string" -}, "volumes": { "description": "Optional. List of volumes that can be mounted by containers belonging to the Instance.", "items": { diff --git a/googleapiclient/discovery_cache/documents/run.v2.json b/googleapiclient/discovery_cache/documents/run.v2.json index b6bb96fd25..53eee85e35 100644 --- a/googleapiclient/discovery_cache/documents/run.v2.json +++ b/googleapiclient/discovery_cache/documents/run.v2.json @@ -2610,7 +2610,7 @@ } } }, -"revision": "20260512", +"revision": "20260522", "rootUrl": "https://run.googleapis.com/", "schemas": { "GoogleCloudRunV2BinaryAuthorization": { @@ -3827,11 +3827,6 @@ "description": "Output only. The Condition of this Instance, containing its readiness status, and detailed error information in case it did not reach a serving state. See comments in `reconciling` for additional information on reconciliation process in Cloud Run.", "readOnly": true }, -"timeout": { -"description": "Optional. Duration the instance may be active before the system will shut it down.", -"format": "google-duration", -"type": "string" -}, "uid": { "description": "Output only. Server assigned unique identifier for the trigger. The value is a UUID4 string and guaranteed to remain unchanged until the resource is deleted.", "readOnly": true, diff --git a/googleapiclient/discovery_cache/documents/securitycenter.v1.json b/googleapiclient/discovery_cache/documents/securitycenter.v1.json index d23f8d32f0..6ab4e2dff7 100644 --- a/googleapiclient/discovery_cache/documents/securitycenter.v1.json +++ b/googleapiclient/discovery_cache/documents/securitycenter.v1.json @@ -128,7 +128,7 @@ "methods": { "group": { "deprecated": true, -"description": "Filters an organization's assets and groups them by their specified properties.", +"description": "", "flatPath": "v1/folders/{foldersId}/assets:group", "httpMethod": "POST", "id": "securitycenter.folders.assets.group", @@ -137,7 +137,6 @@ ], "parameters": { "parent": { -"description": "Required. The name of the parent to group the assets by. Its format is `organizations/[organization_id]`, `folders/[folder_id]`, or `projects/[project_id]`.", "location": "path", "pattern": "^folders/[^/]+$", "required": true, @@ -157,7 +156,7 @@ }, "list": { "deprecated": true, -"description": "Lists an organization's assets.", +"description": "", "flatPath": "v1/folders/{foldersId}/assets", "httpMethod": "GET", "id": "securitycenter.folders.assets.list", @@ -166,47 +165,39 @@ ], "parameters": { "compareDuration": { -"description": "When compare_duration is set, the ListAssetsResult's \"state_change\" attribute is updated to indicate whether the asset was added, removed, or remained present during the compare_duration period of time that precedes the read_time. This is the time between (read_time - compare_duration) and read_time. The state_change value is derived based on the presence of the asset at the two points in time. Intermediate state changes between the two times don't affect the result. For example, the results aren't affected if the asset is removed and re-created again. Possible \"state_change\" values when compare_duration is specified: * \"ADDED\": indicates that the asset was not present at the start of compare_duration, but present at read_time. * \"REMOVED\": indicates that the asset was present at the start of compare_duration, but not present at read_time. * \"ACTIVE\": indicates that the asset was present at both the start and the end of the time period defined by compare_duration and read_time. If compare_duration is not specified, then the only possible state_change is \"UNUSED\", which will be the state_change set for all assets present at read_time.", "format": "google-duration", "location": "query", "type": "string" }, "fieldMask": { -"description": "A field mask to specify the ListAssetsResult fields to be listed in the response. An empty field mask will list all fields.", "format": "google-fieldmask", "location": "query", "type": "string" }, "filter": { -"description": "Expression that defines the filter to apply across assets. The expression is a list of zero or more restrictions combined via logical operators `AND` and `OR`. Parentheses are supported, and `OR` has higher precedence than `AND`. Restrictions have the form ` ` and may have a `-` character in front of them to indicate negation. The fields map to those defined in the Asset resource. Examples include: * name * security_center_properties.resource_name * resource_properties.a_property * security_marks.marks.marka The supported operators are: * `=` for all value types. * `>`, `<`, `>=`, `<=` for integer values. * `:`, meaning substring matching, for strings. The supported value types are: * string literals in quotes. * integer literals without quotes. * boolean literals `true` and `false` without quotes. The following are the allowed field and operator combinations: * name: `=` * update_time: `=`, `>`, `<`, `>=`, `<=` Usage: This should be milliseconds since epoch or an RFC3339 string. Examples: `update_time = \"2019-06-10T16:07:18-07:00\"` `update_time = 1560208038000` * create_time: `=`, `>`, `<`, `>=`, `<=` Usage: This should be milliseconds since epoch or an RFC3339 string. Examples: `create_time = \"2019-06-10T16:07:18-07:00\"` `create_time = 1560208038000` * iam_policy.policy_blob: `=`, `:` * resource_properties: `=`, `:`, `>`, `<`, `>=`, `<=` * security_marks.marks: `=`, `:` * security_center_properties.resource_name: `=`, `:` * security_center_properties.resource_display_name: `=`, `:` * security_center_properties.resource_type: `=`, `:` * security_center_properties.resource_parent: `=`, `:` * security_center_properties.resource_parent_display_name: `=`, `:` * security_center_properties.resource_project: `=`, `:` * security_center_properties.resource_project_display_name: `=`, `:` * security_center_properties.resource_owners: `=`, `:` For example, `resource_properties.size = 100` is a valid filter string. Use a partial match on the empty string to filter based on a property existing: `resource_properties.my_property : \"\"` Use a negated partial match on the empty string to filter based on a property not existing: `-resource_properties.my_property : \"\"`", "location": "query", "type": "string" }, "orderBy": { -"description": "Expression that defines what fields and order to use for sorting. The string value should follow SQL syntax: comma separated list of fields. For example: \"name,resource_properties.a_property\". The default sorting order is ascending. To specify descending order for a field, a suffix \" desc\" should be appended to the field name. For example: \"name desc,resource_properties.a_property\". Redundant space characters in the syntax are insignificant. \"name desc,resource_properties.a_property\" and \" name desc , resource_properties.a_property \" are equivalent. The following fields are supported: name update_time resource_properties security_marks.marks security_center_properties.resource_name security_center_properties.resource_display_name security_center_properties.resource_parent security_center_properties.resource_parent_display_name security_center_properties.resource_project security_center_properties.resource_project_display_name security_center_properties.resource_type", "location": "query", "type": "string" }, "pageSize": { -"description": "The maximum number of results to return in a single response. Default is 10, minimum is 1, maximum is 1000.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { -"description": "The value returned by the last `ListAssetsResponse`; indicates that this is a continuation of a prior `ListAssets` call, and that the system should return the next page of data.", "location": "query", "type": "string" }, "parent": { -"description": "Required. The name of the parent resource that contains the assets. The value that you can specify on parent depends on the method in which you specify parent. You can specify one of the following values: `organizations/[organization_id]`, `folders/[folder_id]`, or `projects/[project_id]`.", "location": "path", "pattern": "^folders/[^/]+$", "required": true, "type": "string" }, "readTime": { -"description": "Time used as a reference point when filtering assets. The filter is limited to assets existing at the supplied time and their values are those at that specific time. Absence of this field will default to the API's version of NOW.", "format": "google-datetime", "location": "query", "type": "string" @@ -221,7 +212,7 @@ ] }, "updateSecurityMarks": { -"description": "Updates security marks.", +"description": "", "flatPath": "v1/folders/{foldersId}/assets/{assetsId}/securityMarks", "httpMethod": "PATCH", "id": "securitycenter.folders.assets.updateSecurityMarks", @@ -230,20 +221,17 @@ ], "parameters": { "name": { -"description": "The relative resource name of the SecurityMarks. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Examples: \"organizations/{organization_id}/assets/{asset_id}/securityMarks\" \"organizations/{organization_id}/sources/{source_id}/findings/{finding_id}/securityMarks\".", "location": "path", "pattern": "^folders/[^/]+/assets/[^/]+/securityMarks$", "required": true, "type": "string" }, "startTime": { -"description": "The time at which the updated SecurityMarks take effect. If not set uses current server time. Updates will be applied to the SecurityMarks that are active immediately preceding this time. Must be earlier or equal to the server time.", "format": "google-datetime", "location": "query", "type": "string" }, "updateMask": { -"description": "The FieldMask to use when updating the security marks resource. The field mask must not contain duplicate fields. If empty or set to \"marks\", all marks will be replaced. Individual marks can be updated using \"marks.\".", "format": "google-fieldmask", "location": "query", "type": "string" @@ -265,7 +253,7 @@ "bigQueryExports": { "methods": { "create": { -"description": "Creates a BigQuery export.", +"description": "", "flatPath": "v1/folders/{foldersId}/bigQueryExports", "httpMethod": "POST", "id": "securitycenter.folders.bigQueryExports.create", @@ -274,12 +262,10 @@ ], "parameters": { "bigQueryExportId": { -"description": "Required. Unique identifier provided by the client within the parent scope. It must consist of only lowercase letters, numbers, and hyphens, must start with a letter, must end with either a letter or a number, and must be 63 characters or less.", "location": "query", "type": "string" }, "parent": { -"description": "Required. The name of the parent resource of the new BigQuery export. Its format is `organizations/[organization_id]`, `folders/[folder_id]`, or `projects/[project_id]`.", "location": "path", "pattern": "^folders/[^/]+$", "required": true, @@ -298,7 +284,7 @@ ] }, "delete": { -"description": "Deletes an existing BigQuery export.", +"description": "", "flatPath": "v1/folders/{foldersId}/bigQueryExports/{bigQueryExportsId}", "httpMethod": "DELETE", "id": "securitycenter.folders.bigQueryExports.delete", @@ -307,7 +293,6 @@ ], "parameters": { "name": { -"description": "Required. The name of the BigQuery export to delete. Its format is `organizations/{organization}/bigQueryExports/{export_id}`, `folders/{folder}/bigQueryExports/{export_id}`, or `projects/{project}/bigQueryExports/{export_id}`", "location": "path", "pattern": "^folders/[^/]+/bigQueryExports/[^/]+$", "required": true, @@ -323,7 +308,7 @@ ] }, "get": { -"description": "Gets a BigQuery export.", +"description": "", "flatPath": "v1/folders/{foldersId}/bigQueryExports/{bigQueryExportsId}", "httpMethod": "GET", "id": "securitycenter.folders.bigQueryExports.get", @@ -332,7 +317,6 @@ ], "parameters": { "name": { -"description": "Required. Name of the BigQuery export to retrieve. Its format is `organizations/{organization}/bigQueryExports/{export_id}`, `folders/{folder}/bigQueryExports/{export_id}`, or `projects/{project}/bigQueryExports/{export_id}`", "location": "path", "pattern": "^folders/[^/]+/bigQueryExports/[^/]+$", "required": true, @@ -348,7 +332,7 @@ ] }, "list": { -"description": "Lists BigQuery exports. Note that when requesting BigQuery exports at a given level all exports under that level are also returned e.g. if requesting BigQuery exports under a folder, then all BigQuery exports immediately under the folder plus the ones created under the projects within the folder are returned.", +"description": "", "flatPath": "v1/folders/{foldersId}/bigQueryExports", "httpMethod": "GET", "id": "securitycenter.folders.bigQueryExports.list", @@ -357,18 +341,15 @@ ], "parameters": { "pageSize": { -"description": "The maximum number of configs to return. The service may return fewer than this value. If unspecified, at most 10 configs will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { -"description": "A page token, received from a previous `ListBigQueryExports` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListBigQueryExports` must match the call that provided the page token.", "location": "query", "type": "string" }, "parent": { -"description": "Required. The parent, which owns the collection of BigQuery exports. Its format is `organizations/[organization_id]`, `folders/[folder_id]`, `projects/[project_id]`.", "location": "path", "pattern": "^folders/[^/]+$", "required": true, @@ -384,7 +365,7 @@ ] }, "patch": { -"description": "Updates a BigQuery export.", +"description": "", "flatPath": "v1/folders/{foldersId}/bigQueryExports/{bigQueryExportsId}", "httpMethod": "PATCH", "id": "securitycenter.folders.bigQueryExports.patch", @@ -393,14 +374,12 @@ ], "parameters": { "name": { -"description": "The relative resource name of this export. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name. Example format: \"organizations/{organization_id}/bigQueryExports/{export_id}\" Example format: \"folders/{folder_id}/bigQueryExports/{export_id}\" Example format: \"projects/{project_id}/bigQueryExports/{export_id}\" This field is provided in responses, and is ignored when provided in create requests.", "location": "path", "pattern": "^folders/[^/]+/bigQueryExports/[^/]+$", "required": true, "type": "string" }, "updateMask": { -"description": "The list of fields to be updated. If empty all mutable fields will be updated.", "format": "google-fieldmask", "location": "query", "type": "string" @@ -422,7 +401,7 @@ "eventThreatDetectionSettings": { "methods": { "validateCustomModule": { -"description": "Validates the given Event Threat Detection custom module.", +"description": "", "flatPath": "v1/folders/{foldersId}/eventThreatDetectionSettings:validateCustomModule", "httpMethod": "POST", "id": "securitycenter.folders.eventThreatDetectionSettings.validateCustomModule", @@ -431,7 +410,6 @@ ], "parameters": { "parent": { -"description": "Required. Resource name of the parent to validate the Custom Module under. Its format is: * `organizations/{organization}/eventThreatDetectionSettings`. * `folders/{folder}/eventThreatDetectionSettings`. * `projects/{project}/eventThreatDetectionSettings`.", "location": "path", "pattern": "^folders/[^/]+/eventThreatDetectionSettings$", "required": true, @@ -454,7 +432,7 @@ "customModules": { "methods": { "create": { -"description": "Creates a resident Event Threat Detection custom module at the scope of the given Resource Manager parent, and also creates inherited custom modules for all descendants of the given parent. These modules are enabled by default.", +"description": "", "flatPath": "v1/folders/{foldersId}/eventThreatDetectionSettings/customModules", "httpMethod": "POST", "id": "securitycenter.folders.eventThreatDetectionSettings.customModules.create", @@ -463,7 +441,6 @@ ], "parameters": { "parent": { -"description": "Required. The new custom module's parent. Its format is: * `organizations/{organization}/eventThreatDetectionSettings`. * `folders/{folder}/eventThreatDetectionSettings`. * `projects/{project}/eventThreatDetectionSettings`.", "location": "path", "pattern": "^folders/[^/]+/eventThreatDetectionSettings$", "required": true, @@ -482,7 +459,7 @@ ] }, "delete": { -"description": "Deletes the specified Event Threat Detection custom module and all of its descendants in the Resource Manager hierarchy. This method is only supported for resident custom modules.", +"description": "", "flatPath": "v1/folders/{foldersId}/eventThreatDetectionSettings/customModules/{customModulesId}", "httpMethod": "DELETE", "id": "securitycenter.folders.eventThreatDetectionSettings.customModules.delete", @@ -491,7 +468,6 @@ ], "parameters": { "name": { -"description": "Required. Name of the custom module to delete. Its format is: * `organizations/{organization}/eventThreatDetectionSettings/customModules/{module}`. * `folders/{folder}/eventThreatDetectionSettings/customModules/{module}`. * `projects/{project}/eventThreatDetectionSettings/customModules/{module}`.", "location": "path", "pattern": "^folders/[^/]+/eventThreatDetectionSettings/customModules/[^/]+$", "required": true, @@ -507,7 +483,7 @@ ] }, "get": { -"description": "Gets an Event Threat Detection custom module.", +"description": "", "flatPath": "v1/folders/{foldersId}/eventThreatDetectionSettings/customModules/{customModulesId}", "httpMethod": "GET", "id": "securitycenter.folders.eventThreatDetectionSettings.customModules.get", @@ -516,7 +492,6 @@ ], "parameters": { "name": { -"description": "Required. Name of the custom module to get. Its format is: * `organizations/{organization}/eventThreatDetectionSettings/customModules/{module}`. * `folders/{folder}/eventThreatDetectionSettings/customModules/{module}`. * `projects/{project}/eventThreatDetectionSettings/customModules/{module}`.", "location": "path", "pattern": "^folders/[^/]+/eventThreatDetectionSettings/customModules/[^/]+$", "required": true, @@ -532,7 +507,7 @@ ] }, "list": { -"description": "Lists all Event Threat Detection custom modules for the given Resource Manager parent. This includes resident modules defined at the scope of the parent along with modules inherited from ancestors.", +"description": "", "flatPath": "v1/folders/{foldersId}/eventThreatDetectionSettings/customModules", "httpMethod": "GET", "id": "securitycenter.folders.eventThreatDetectionSettings.customModules.list", @@ -541,18 +516,15 @@ ], "parameters": { "pageSize": { -"description": "The maximum number of modules to return. The service may return fewer than this value. If unspecified, at most 10 configs will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { -"description": "A page token, received from a previous `ListEventThreatDetectionCustomModules` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListEventThreatDetectionCustomModules` must match the call that provided the page token.", "location": "query", "type": "string" }, "parent": { -"description": "Required. Name of the parent to list custom modules under. Its format is: * `organizations/{organization}/eventThreatDetectionSettings`. * `folders/{folder}/eventThreatDetectionSettings`. * `projects/{project}/eventThreatDetectionSettings`.", "location": "path", "pattern": "^folders/[^/]+/eventThreatDetectionSettings$", "required": true, @@ -568,7 +540,7 @@ ] }, "listDescendant": { -"description": "Lists all resident Event Threat Detection custom modules under the given Resource Manager parent and its descendants.", +"description": "", "flatPath": "v1/folders/{foldersId}/eventThreatDetectionSettings/customModules:listDescendant", "httpMethod": "GET", "id": "securitycenter.folders.eventThreatDetectionSettings.customModules.listDescendant", @@ -577,18 +549,15 @@ ], "parameters": { "pageSize": { -"description": "The maximum number of modules to return. The service may return fewer than this value. If unspecified, at most 10 configs will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { -"description": "A page token, received from a previous `ListDescendantEventThreatDetectionCustomModules` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListDescendantEventThreatDetectionCustomModules` must match the call that provided the page token.", "location": "query", "type": "string" }, "parent": { -"description": "Required. Name of the parent to list custom modules under. Its format is: * `organizations/{organization}/eventThreatDetectionSettings`. * `folders/{folder}/eventThreatDetectionSettings`. * `projects/{project}/eventThreatDetectionSettings`.", "location": "path", "pattern": "^folders/[^/]+/eventThreatDetectionSettings$", "required": true, @@ -604,7 +573,7 @@ ] }, "patch": { -"description": "Updates the Event Threat Detection custom module with the given name based on the given update mask. Updating the enablement state is supported for both resident and inherited modules (though resident modules cannot have an enablement state of \"inherited\"). Updating the display name or configuration of a module is supported for resident modules only. The type of a module cannot be changed.", +"description": "", "flatPath": "v1/folders/{foldersId}/eventThreatDetectionSettings/customModules/{customModulesId}", "httpMethod": "PATCH", "id": "securitycenter.folders.eventThreatDetectionSettings.customModules.patch", @@ -613,14 +582,12 @@ ], "parameters": { "name": { -"description": "Immutable. The resource name of the Event Threat Detection custom module. Its format is: * `organizations/{organization}/eventThreatDetectionSettings/customModules/{module}`. * `folders/{folder}/eventThreatDetectionSettings/customModules/{module}`. * `projects/{project}/eventThreatDetectionSettings/customModules/{module}`.", "location": "path", "pattern": "^folders/[^/]+/eventThreatDetectionSettings/customModules/[^/]+$", "required": true, "type": "string" }, "updateMask": { -"description": "The list of fields to be updated. If empty all mutable fields will be updated.", "format": "google-fieldmask", "location": "query", "type": "string" @@ -642,7 +609,7 @@ "effectiveCustomModules": { "methods": { "get": { -"description": "Gets an effective Event Threat Detection custom module at the given level.", +"description": "", "flatPath": "v1/folders/{foldersId}/eventThreatDetectionSettings/effectiveCustomModules/{effectiveCustomModulesId}", "httpMethod": "GET", "id": "securitycenter.folders.eventThreatDetectionSettings.effectiveCustomModules.get", @@ -651,7 +618,6 @@ ], "parameters": { "name": { -"description": "Required. The resource name of the effective Event Threat Detection custom module. Its format is: * `organizations/{organization}/eventThreatDetectionSettings/effectiveCustomModules/{module}`. * `folders/{folder}/eventThreatDetectionSettings/effectiveCustomModules/{module}`. * `projects/{project}/eventThreatDetectionSettings/effectiveCustomModules/{module}`.", "location": "path", "pattern": "^folders/[^/]+/eventThreatDetectionSettings/effectiveCustomModules/[^/]+$", "required": true, @@ -667,7 +633,7 @@ ] }, "list": { -"description": "Lists all effective Event Threat Detection custom modules for the given parent. This includes resident modules defined at the scope of the parent along with modules inherited from its ancestors.", +"description": "", "flatPath": "v1/folders/{foldersId}/eventThreatDetectionSettings/effectiveCustomModules", "httpMethod": "GET", "id": "securitycenter.folders.eventThreatDetectionSettings.effectiveCustomModules.list", @@ -676,18 +642,15 @@ ], "parameters": { "pageSize": { -"description": "The maximum number of modules to return. The service may return fewer than this value. If unspecified, at most 10 configs will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { -"description": "A page token, received from a previous `ListEffectiveEventThreatDetectionCustomModules` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListEffectiveEventThreatDetectionCustomModules` must match the call that provided the page token.", "location": "query", "type": "string" }, "parent": { -"description": "Required. Name of the parent to list custom modules for. Its format is: * `organizations/{organization}/eventThreatDetectionSettings`. * `folders/{folder}/eventThreatDetectionSettings`. * `projects/{project}/eventThreatDetectionSettings`.", "location": "path", "pattern": "^folders/[^/]+/eventThreatDetectionSettings$", "required": true, @@ -709,7 +672,7 @@ "findings": { "methods": { "bulkMute": { -"description": "Kicks off an LRO to bulk mute findings for a parent based on a filter. The parent can be either an organization, folder or project. The findings matched by the filter will be muted after the LRO is done.", +"description": "", "flatPath": "v1/folders/{foldersId}/findings:bulkMute", "httpMethod": "POST", "id": "securitycenter.folders.findings.bulkMute", @@ -718,7 +681,6 @@ ], "parameters": { "parent": { -"description": "Required. The parent, at which bulk action needs to be applied. Its format is `organizations/[organization_id]`, `folders/[folder_id]`, `projects/[project_id]`.", "location": "path", "pattern": "^folders/[^/]+$", "required": true, @@ -743,7 +705,7 @@ "muteConfigs": { "methods": { "delete": { -"description": "Deletes an existing mute config.", +"description": "", "flatPath": "v1/folders/{foldersId}/locations/{locationsId}/muteConfigs/{muteConfigsId}", "httpMethod": "DELETE", "id": "securitycenter.folders.locations.muteConfigs.delete", @@ -752,7 +714,6 @@ ], "parameters": { "name": { -"description": "Required. Name of the mute config to delete. Its format is `organizations/{organization}/muteConfigs/{config_id}`, `folders/{folder}/muteConfigs/{config_id}`, `projects/{project}/muteConfigs/{config_id}`, `organizations/{organization}/locations/global/muteConfigs/{config_id}`, `folders/{folder}/locations/global/muteConfigs/{config_id}`, or `projects/{project}/locations/global/muteConfigs/{config_id}`.", "location": "path", "pattern": "^folders/[^/]+/locations/[^/]+/muteConfigs/[^/]+$", "required": true, @@ -768,7 +729,7 @@ ] }, "get": { -"description": "Gets a mute config.", +"description": "", "flatPath": "v1/folders/{foldersId}/locations/{locationsId}/muteConfigs/{muteConfigsId}", "httpMethod": "GET", "id": "securitycenter.folders.locations.muteConfigs.get", @@ -777,7 +738,6 @@ ], "parameters": { "name": { -"description": "Required. Name of the mute config to retrieve. Its format is `organizations/{organization}/muteConfigs/{config_id}`, `folders/{folder}/muteConfigs/{config_id}`, `projects/{project}/muteConfigs/{config_id}`, `organizations/{organization}/locations/global/muteConfigs/{config_id}`, `folders/{folder}/locations/global/muteConfigs/{config_id}`, or `projects/{project}/locations/global/muteConfigs/{config_id}`.", "location": "path", "pattern": "^folders/[^/]+/locations/[^/]+/muteConfigs/[^/]+$", "required": true, @@ -793,7 +753,7 @@ ] }, "patch": { -"description": "Updates a mute config.", +"description": "", "flatPath": "v1/folders/{foldersId}/locations/{locationsId}/muteConfigs/{muteConfigsId}", "httpMethod": "PATCH", "id": "securitycenter.folders.locations.muteConfigs.patch", @@ -802,14 +762,12 @@ ], "parameters": { "name": { -"description": "This field will be ignored if provided on config creation. Format `organizations/{organization}/muteConfigs/{mute_config}` `folders/{folder}/muteConfigs/{mute_config}` `projects/{project}/muteConfigs/{mute_config}` `organizations/{organization}/locations/global/muteConfigs/{mute_config}` `folders/{folder}/locations/global/muteConfigs/{mute_config}` `projects/{project}/locations/global/muteConfigs/{mute_config}`", "location": "path", "pattern": "^folders/[^/]+/locations/[^/]+/muteConfigs/[^/]+$", "required": true, "type": "string" }, "updateMask": { -"description": "The list of fields to be updated. If empty all mutable fields will be updated.", "format": "google-fieldmask", "location": "query", "type": "string" @@ -833,7 +791,7 @@ "muteConfigs": { "methods": { "create": { -"description": "Creates a mute config.", +"description": "", "flatPath": "v1/folders/{foldersId}/muteConfigs", "httpMethod": "POST", "id": "securitycenter.folders.muteConfigs.create", @@ -842,12 +800,10 @@ ], "parameters": { "muteConfigId": { -"description": "Required. Unique identifier provided by the client within the parent scope. It must consist of only lowercase letters, numbers, and hyphens, must start with a letter, must end with either a letter or a number, and must be 63 characters or less.", "location": "query", "type": "string" }, "parent": { -"description": "Required. Resource name of the new mute configs's parent. Its format is `organizations/[organization_id]`, `folders/[folder_id]`, or `projects/[project_id]`.", "location": "path", "pattern": "^folders/[^/]+$", "required": true, @@ -866,7 +822,7 @@ ] }, "delete": { -"description": "Deletes an existing mute config.", +"description": "", "flatPath": "v1/folders/{foldersId}/muteConfigs/{muteConfigsId}", "httpMethod": "DELETE", "id": "securitycenter.folders.muteConfigs.delete", @@ -875,7 +831,6 @@ ], "parameters": { "name": { -"description": "Required. Name of the mute config to delete. Its format is `organizations/{organization}/muteConfigs/{config_id}`, `folders/{folder}/muteConfigs/{config_id}`, `projects/{project}/muteConfigs/{config_id}`, `organizations/{organization}/locations/global/muteConfigs/{config_id}`, `folders/{folder}/locations/global/muteConfigs/{config_id}`, or `projects/{project}/locations/global/muteConfigs/{config_id}`.", "location": "path", "pattern": "^folders/[^/]+/muteConfigs/[^/]+$", "required": true, @@ -891,7 +846,7 @@ ] }, "get": { -"description": "Gets a mute config.", +"description": "", "flatPath": "v1/folders/{foldersId}/muteConfigs/{muteConfigsId}", "httpMethod": "GET", "id": "securitycenter.folders.muteConfigs.get", @@ -900,7 +855,6 @@ ], "parameters": { "name": { -"description": "Required. Name of the mute config to retrieve. Its format is `organizations/{organization}/muteConfigs/{config_id}`, `folders/{folder}/muteConfigs/{config_id}`, `projects/{project}/muteConfigs/{config_id}`, `organizations/{organization}/locations/global/muteConfigs/{config_id}`, `folders/{folder}/locations/global/muteConfigs/{config_id}`, or `projects/{project}/locations/global/muteConfigs/{config_id}`.", "location": "path", "pattern": "^folders/[^/]+/muteConfigs/[^/]+$", "required": true, @@ -916,7 +870,7 @@ ] }, "list": { -"description": "Lists mute configs.", +"description": "", "flatPath": "v1/folders/{foldersId}/muteConfigs", "httpMethod": "GET", "id": "securitycenter.folders.muteConfigs.list", @@ -925,18 +879,15 @@ ], "parameters": { "pageSize": { -"description": "The maximum number of configs to return. The service may return fewer than this value. If unspecified, at most 10 configs will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { -"description": "A page token, received from a previous `ListMuteConfigs` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListMuteConfigs` must match the call that provided the page token.", "location": "query", "type": "string" }, "parent": { -"description": "Required. The parent, which owns the collection of mute configs. Its format is `organizations/[organization_id]`, `folders/[folder_id]`, `projects/[project_id]`.", "location": "path", "pattern": "^folders/[^/]+$", "required": true, @@ -952,7 +903,7 @@ ] }, "patch": { -"description": "Updates a mute config.", +"description": "", "flatPath": "v1/folders/{foldersId}/muteConfigs/{muteConfigsId}", "httpMethod": "PATCH", "id": "securitycenter.folders.muteConfigs.patch", @@ -961,14 +912,12 @@ ], "parameters": { "name": { -"description": "This field will be ignored if provided on config creation. Format `organizations/{organization}/muteConfigs/{mute_config}` `folders/{folder}/muteConfigs/{mute_config}` `projects/{project}/muteConfigs/{mute_config}` `organizations/{organization}/locations/global/muteConfigs/{mute_config}` `folders/{folder}/locations/global/muteConfigs/{mute_config}` `projects/{project}/locations/global/muteConfigs/{mute_config}`", "location": "path", "pattern": "^folders/[^/]+/muteConfigs/[^/]+$", "required": true, "type": "string" }, "updateMask": { -"description": "The list of fields to be updated. If empty all mutable fields will be updated.", "format": "google-fieldmask", "location": "query", "type": "string" @@ -990,7 +939,7 @@ "notificationConfigs": { "methods": { "create": { -"description": "Creates a notification config.", +"description": "", "flatPath": "v1/folders/{foldersId}/notificationConfigs", "httpMethod": "POST", "id": "securitycenter.folders.notificationConfigs.create", @@ -999,12 +948,10 @@ ], "parameters": { "configId": { -"description": "Required. Unique identifier provided by the client within the parent scope. It must be between 1 and 128 characters and contain alphanumeric characters, underscores, or hyphens only.", "location": "query", "type": "string" }, "parent": { -"description": "Required. Resource name of the new notification config's parent. Its format is `organizations/[organization_id]`, `folders/[folder_id]`, or `projects/[project_id]`.", "location": "path", "pattern": "^folders/[^/]+$", "required": true, @@ -1023,7 +970,7 @@ ] }, "delete": { -"description": "Deletes a notification config.", +"description": "", "flatPath": "v1/folders/{foldersId}/notificationConfigs/{notificationConfigsId}", "httpMethod": "DELETE", "id": "securitycenter.folders.notificationConfigs.delete", @@ -1032,7 +979,6 @@ ], "parameters": { "name": { -"description": "Required. Name of the notification config to delete. Its format is `organizations/[organization_id]/notificationConfigs/[config_id]`, `folders/[folder_id]/notificationConfigs/[config_id]`, or `projects/[project_id]/notificationConfigs/[config_id]`.", "location": "path", "pattern": "^folders/[^/]+/notificationConfigs/[^/]+$", "required": true, @@ -1048,7 +994,7 @@ ] }, "get": { -"description": "Gets a notification config.", +"description": "", "flatPath": "v1/folders/{foldersId}/notificationConfigs/{notificationConfigsId}", "httpMethod": "GET", "id": "securitycenter.folders.notificationConfigs.get", @@ -1057,7 +1003,6 @@ ], "parameters": { "name": { -"description": "Required. Name of the notification config to get. Its format is `organizations/[organization_id]/notificationConfigs/[config_id]`, `folders/[folder_id]/notificationConfigs/[config_id]`, or `projects/[project_id]/notificationConfigs/[config_id]`.", "location": "path", "pattern": "^folders/[^/]+/notificationConfigs/[^/]+$", "required": true, @@ -1073,7 +1018,7 @@ ] }, "list": { -"description": "Lists notification configs.", +"description": "", "flatPath": "v1/folders/{foldersId}/notificationConfigs", "httpMethod": "GET", "id": "securitycenter.folders.notificationConfigs.list", @@ -1082,18 +1027,15 @@ ], "parameters": { "pageSize": { -"description": "The maximum number of results to return in a single response. Default is 10, minimum is 1, maximum is 1000.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { -"description": "The value returned by the last `ListNotificationConfigsResponse`; indicates that this is a continuation of a prior `ListNotificationConfigs` call, and that the system should return the next page of data.", "location": "query", "type": "string" }, "parent": { -"description": "Required. The name of the parent in which to list the notification configurations. Its format is \"organizations/[organization_id]\", \"folders/[folder_id]\", or \"projects/[project_id]\".", "location": "path", "pattern": "^folders/[^/]+$", "required": true, @@ -1109,7 +1051,7 @@ ] }, "patch": { -"description": " Updates a notification config. The following update fields are allowed: description, pubsub_topic, streaming_config.filter", +"description": "", "flatPath": "v1/folders/{foldersId}/notificationConfigs/{notificationConfigsId}", "httpMethod": "PATCH", "id": "securitycenter.folders.notificationConfigs.patch", @@ -1118,14 +1060,12 @@ ], "parameters": { "name": { -"description": "The relative resource name of this notification config. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Example: \"organizations/{organization_id}/notificationConfigs/notify_public_bucket\", \"folders/{folder_id}/notificationConfigs/notify_public_bucket\", or \"projects/{project_id}/notificationConfigs/notify_public_bucket\".", "location": "path", "pattern": "^folders/[^/]+/notificationConfigs/[^/]+$", "required": true, "type": "string" }, "updateMask": { -"description": "The FieldMask to use when updating the notification config. If empty all mutable fields will be updated.", "format": "google-fieldmask", "location": "query", "type": "string" @@ -1149,7 +1089,7 @@ "customModules": { "methods": { "create": { -"description": "Creates a resident SecurityHealthAnalyticsCustomModule at the scope of the given CRM parent, and also creates inherited SecurityHealthAnalyticsCustomModules for all CRM descendants of the given parent. These modules are enabled by default.", +"description": "", "flatPath": "v1/folders/{foldersId}/securityHealthAnalyticsSettings/customModules", "httpMethod": "POST", "id": "securitycenter.folders.securityHealthAnalyticsSettings.customModules.create", @@ -1158,7 +1098,6 @@ ], "parameters": { "parent": { -"description": "Required. Resource name of the new custom module's parent. Its format is `organizations/{organization}/securityHealthAnalyticsSettings`, `folders/{folder}/securityHealthAnalyticsSettings`, or `projects/{project}/securityHealthAnalyticsSettings`", "location": "path", "pattern": "^folders/[^/]+/securityHealthAnalyticsSettings$", "required": true, @@ -1177,7 +1116,7 @@ ] }, "delete": { -"description": "Deletes the specified SecurityHealthAnalyticsCustomModule and all of its descendants in the CRM hierarchy. This method is only supported for resident custom modules.", +"description": "", "flatPath": "v1/folders/{foldersId}/securityHealthAnalyticsSettings/customModules/{customModulesId}", "httpMethod": "DELETE", "id": "securitycenter.folders.securityHealthAnalyticsSettings.customModules.delete", @@ -1186,7 +1125,6 @@ ], "parameters": { "name": { -"description": "Required. Name of the custom module to delete. Its format is `organizations/{organization}/securityHealthAnalyticsSettings/customModules/{customModule}`, `folders/{folder}/securityHealthAnalyticsSettings/customModules/{customModule}`, or `projects/{project}/securityHealthAnalyticsSettings/customModules/{customModule}`", "location": "path", "pattern": "^folders/[^/]+/securityHealthAnalyticsSettings/customModules/[^/]+$", "required": true, @@ -1202,7 +1140,7 @@ ] }, "get": { -"description": "Retrieves a SecurityHealthAnalyticsCustomModule.", +"description": "", "flatPath": "v1/folders/{foldersId}/securityHealthAnalyticsSettings/customModules/{customModulesId}", "httpMethod": "GET", "id": "securitycenter.folders.securityHealthAnalyticsSettings.customModules.get", @@ -1211,7 +1149,6 @@ ], "parameters": { "name": { -"description": "Required. Name of the custom module to get. Its format is `organizations/{organization}/securityHealthAnalyticsSettings/customModules/{customModule}`, `folders/{folder}/securityHealthAnalyticsSettings/customModules/{customModule}`, or `projects/{project}/securityHealthAnalyticsSettings/customModules/{customModule}`", "location": "path", "pattern": "^folders/[^/]+/securityHealthAnalyticsSettings/customModules/[^/]+$", "required": true, @@ -1227,7 +1164,7 @@ ] }, "list": { -"description": "Returns a list of all SecurityHealthAnalyticsCustomModules for the given parent. This includes resident modules defined at the scope of the parent, and inherited modules, inherited from CRM ancestors.", +"description": "", "flatPath": "v1/folders/{foldersId}/securityHealthAnalyticsSettings/customModules", "httpMethod": "GET", "id": "securitycenter.folders.securityHealthAnalyticsSettings.customModules.list", @@ -1236,18 +1173,15 @@ ], "parameters": { "pageSize": { -"description": "The maximum number of results to return in a single response. Default is 10, minimum is 1, maximum is 1000.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { -"description": "The value returned by the last call indicating a continuation", "location": "query", "type": "string" }, "parent": { -"description": "Required. Name of parent to list custom modules. Its format is `organizations/{organization}/securityHealthAnalyticsSettings`, `folders/{folder}/securityHealthAnalyticsSettings`, or `projects/{project}/securityHealthAnalyticsSettings`", "location": "path", "pattern": "^folders/[^/]+/securityHealthAnalyticsSettings$", "required": true, @@ -1263,7 +1197,7 @@ ] }, "listDescendant": { -"description": "Returns a list of all resident SecurityHealthAnalyticsCustomModules under the given CRM parent and all of the parent\u2019s CRM descendants.", +"description": "", "flatPath": "v1/folders/{foldersId}/securityHealthAnalyticsSettings/customModules:listDescendant", "httpMethod": "GET", "id": "securitycenter.folders.securityHealthAnalyticsSettings.customModules.listDescendant", @@ -1272,18 +1206,15 @@ ], "parameters": { "pageSize": { -"description": "The maximum number of results to return in a single response. Default is 10, minimum is 1, maximum is 1000.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { -"description": "The value returned by the last call indicating a continuation", "location": "query", "type": "string" }, "parent": { -"description": "Required. Name of parent to list descendant custom modules. Its format is `organizations/{organization}/securityHealthAnalyticsSettings`, `folders/{folder}/securityHealthAnalyticsSettings`, or `projects/{project}/securityHealthAnalyticsSettings`", "location": "path", "pattern": "^folders/[^/]+/securityHealthAnalyticsSettings$", "required": true, @@ -1299,7 +1230,7 @@ ] }, "patch": { -"description": "Updates the SecurityHealthAnalyticsCustomModule under the given name based on the given update mask. Updating the enablement state is supported on both resident and inherited modules (though resident modules cannot have an enablement state of \"inherited\"). Updating the display name and custom config of a module is supported on resident modules only.", +"description": "", "flatPath": "v1/folders/{foldersId}/securityHealthAnalyticsSettings/customModules/{customModulesId}", "httpMethod": "PATCH", "id": "securitycenter.folders.securityHealthAnalyticsSettings.customModules.patch", @@ -1308,14 +1239,12 @@ ], "parameters": { "name": { -"description": "Immutable. The resource name of the custom module. Its format is \"organizations/{organization}/securityHealthAnalyticsSettings/customModules/{customModule}\", or \"folders/{folder}/securityHealthAnalyticsSettings/customModules/{customModule}\", or \"projects/{project}/securityHealthAnalyticsSettings/customModules/{customModule}\" The id {customModule} is server-generated and is not user settable. It will be a numeric id containing 1-20 digits.", "location": "path", "pattern": "^folders/[^/]+/securityHealthAnalyticsSettings/customModules/[^/]+$", "required": true, "type": "string" }, "updateMask": { -"description": "The list of fields to be updated. The only fields that can be updated are `enablement_state` and `custom_config`. If empty or set to the wildcard value `*`, both `enablement_state` and `custom_config` are updated.", "format": "google-fieldmask", "location": "query", "type": "string" @@ -1333,7 +1262,7 @@ ] }, "simulate": { -"description": "Simulates a given SecurityHealthAnalyticsCustomModule and Resource.", +"description": "", "flatPath": "v1/folders/{foldersId}/securityHealthAnalyticsSettings/customModules:simulate", "httpMethod": "POST", "id": "securitycenter.folders.securityHealthAnalyticsSettings.customModules.simulate", @@ -1342,7 +1271,6 @@ ], "parameters": { "parent": { -"description": "Required. The relative resource name of the organization, project, or folder. For more information about relative resource names, see [Relative Resource Name](https://cloud.google.com/apis/design/resource_names#relative_resource_name) Example: `organizations/{organization_id}`", "location": "path", "pattern": "^folders/[^/]+/securityHealthAnalyticsSettings$", "required": true, @@ -1365,7 +1293,7 @@ "effectiveCustomModules": { "methods": { "get": { -"description": "Retrieves an EffectiveSecurityHealthAnalyticsCustomModule.", +"description": "", "flatPath": "v1/folders/{foldersId}/securityHealthAnalyticsSettings/effectiveCustomModules/{effectiveCustomModulesId}", "httpMethod": "GET", "id": "securitycenter.folders.securityHealthAnalyticsSettings.effectiveCustomModules.get", @@ -1374,7 +1302,6 @@ ], "parameters": { "name": { -"description": "Required. Name of the effective custom module to get. Its format is `organizations/{organization}/securityHealthAnalyticsSettings/effectiveCustomModules/{customModule}`, `folders/{folder}/securityHealthAnalyticsSettings/effectiveCustomModules/{customModule}`, or `projects/{project}/securityHealthAnalyticsSettings/effectiveCustomModules/{customModule}`", "location": "path", "pattern": "^folders/[^/]+/securityHealthAnalyticsSettings/effectiveCustomModules/[^/]+$", "required": true, @@ -1390,7 +1317,7 @@ ] }, "list": { -"description": "Returns a list of all EffectiveSecurityHealthAnalyticsCustomModules for the given parent. This includes resident modules defined at the scope of the parent, and inherited modules, inherited from CRM ancestors.", +"description": "", "flatPath": "v1/folders/{foldersId}/securityHealthAnalyticsSettings/effectiveCustomModules", "httpMethod": "GET", "id": "securitycenter.folders.securityHealthAnalyticsSettings.effectiveCustomModules.list", @@ -1399,18 +1326,15 @@ ], "parameters": { "pageSize": { -"description": "The maximum number of results to return in a single response. Default is 10, minimum is 1, maximum is 1000.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { -"description": "The value returned by the last call indicating a continuation", "location": "query", "type": "string" }, "parent": { -"description": "Required. Name of parent to list effective custom modules. Its format is `organizations/{organization}/securityHealthAnalyticsSettings`, `folders/{folder}/securityHealthAnalyticsSettings`, or `projects/{project}/securityHealthAnalyticsSettings`", "location": "path", "pattern": "^folders/[^/]+/securityHealthAnalyticsSettings$", "required": true, @@ -1432,7 +1356,7 @@ "sources": { "methods": { "list": { -"description": "Lists all sources belonging to an organization.", +"description": "", "flatPath": "v1/folders/{foldersId}/sources", "httpMethod": "GET", "id": "securitycenter.folders.sources.list", @@ -1441,18 +1365,15 @@ ], "parameters": { "pageSize": { -"description": "The maximum number of results to return in a single response. Default is 10, minimum is 1, maximum is 1000.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { -"description": "The value returned by the last `ListSourcesResponse`; indicates that this is a continuation of a prior `ListSources` call, and that the system should return the next page of data.", "location": "query", "type": "string" }, "parent": { -"description": "Required. Resource name of the parent of sources to list. Its format should be `organizations/[organization_id]`, `folders/[folder_id]`, or `projects/[project_id]`.", "location": "path", "pattern": "^folders/[^/]+$", "required": true, @@ -1472,7 +1393,7 @@ "findings": { "methods": { "group": { -"description": "Filters an organization or source's findings and groups them by their specified properties. To group across all sources provide a `-` as the source id. Example: /v1/organizations/{organization_id}/sources/-/findings, /v1/folders/{folder_id}/sources/-/findings, /v1/projects/{project_id}/sources/-/findings", +"description": "", "flatPath": "v1/folders/{foldersId}/sources/{sourcesId}/findings:group", "httpMethod": "POST", "id": "securitycenter.folders.sources.findings.group", @@ -1481,7 +1402,6 @@ ], "parameters": { "parent": { -"description": "Required. Name of the source to groupBy. Its format is `organizations/[organization_id]/sources/[source_id]`, `folders/[folder_id]/sources/[source_id]`, or `projects/[project_id]/sources/[source_id]`. To groupBy across all sources provide a source_id of `-`. For example: `organizations/{organization_id}/sources/-, folders/{folder_id}/sources/-`, or `projects/{project_id}/sources/-`", "location": "path", "pattern": "^folders/[^/]+/sources/[^/]+$", "required": true, @@ -1500,7 +1420,7 @@ ] }, "list": { -"description": "Lists an organization or source's findings. To list across all sources provide a `-` as the source id. Example: /v1/organizations/{organization_id}/sources/-/findings", +"description": "", "flatPath": "v1/folders/{foldersId}/sources/{sourcesId}/findings", "httpMethod": "GET", "id": "securitycenter.folders.sources.findings.list", @@ -1510,40 +1430,33 @@ "parameters": { "compareDuration": { "deprecated": true, -"description": "When compare_duration is set, the ListFindingsResult's \"state_change\" attribute is updated to indicate whether the finding had its state changed, the finding's state remained unchanged, or if the finding was added in any state during the compare_duration period of time that precedes the read_time. This is the time between (read_time - compare_duration) and read_time. The state_change value is derived based on the presence and state of the finding at the two points in time. Intermediate state changes between the two times don't affect the result. For example, the results aren't affected if the finding is made inactive and then active again. Possible \"state_change\" values when compare_duration is specified: * \"CHANGED\": indicates that the finding was present and matched the given filter at the start of compare_duration, but changed its state at read_time. * \"UNCHANGED\": indicates that the finding was present and matched the given filter at the start of compare_duration and did not change state at read_time. * \"ADDED\": indicates that the finding did not match the given filter or was not present at the start of compare_duration, but was present at read_time. * \"REMOVED\": indicates that the finding was present and matched the filter at the start of compare_duration, but did not match the filter at read_time. If compare_duration is not specified, then the only possible state_change is \"UNUSED\", which will be the state_change set for all findings present at read_time.", "format": "google-duration", "location": "query", "type": "string" }, "fieldMask": { -"description": "A field mask to specify the Finding fields to be listed in the response. An empty field mask will list all fields.", "format": "google-fieldmask", "location": "query", "type": "string" }, "filter": { -"description": "Expression that defines the filter to apply across findings. The expression is a list of one or more restrictions combined via logical operators `AND` and `OR`. Parentheses are supported, and `OR` has higher precedence than `AND`. Restrictions have the form ` ` and may have a `-` character in front of them to indicate negation. Examples include: * name * source_properties.a_property * security_marks.marks.marka The supported operators are: * `=` for all value types. * `>`, `<`, `>=`, `<=` for integer values. * `:`, meaning substring matching, for strings. The supported value types are: * string literals in quotes. * integer literals without quotes. * boolean literals `true` and `false` without quotes. The following field and operator combinations are supported: * name: `=` * parent: `=`, `:` * resource_name: `=`, `:` * state: `=`, `:` * category: `=`, `:` * external_uri: `=`, `:` * event_time: `=`, `>`, `<`, `>=`, `<=` Usage: This should be milliseconds since epoch or an RFC3339 string. Examples: `event_time = \"2019-06-10T16:07:18-07:00\"` `event_time = 1560208038000` * severity: `=`, `:` * workflow_state: `=`, `:` * security_marks.marks: `=`, `:` * source_properties: `=`, `:`, `>`, `<`, `>=`, `<=` For example, `source_properties.size = 100` is a valid filter string. Use a partial match on the empty string to filter based on a property existing: `source_properties.my_property : \"\"` Use a negated partial match on the empty string to filter based on a property not existing: `-source_properties.my_property : \"\"` * resource: * resource.name: `=`, `:` * resource.parent_name: `=`, `:` * resource.parent_display_name: `=`, `:` * resource.project_name: `=`, `:` * resource.project_display_name: `=`, `:` * resource.type: `=`, `:` * resource.folders.resource_folder: `=`, `:` * resource.display_name: `=`, `:`", "location": "query", "type": "string" }, "orderBy": { -"description": "Expression that defines what fields and order to use for sorting. The string value should follow SQL syntax: comma separated list of fields. For example: \"name,resource_properties.a_property\". The default sorting order is ascending. To specify descending order for a field, a suffix \" desc\" should be appended to the field name. For example: \"name desc,source_properties.a_property\". Redundant space characters in the syntax are insignificant. \"name desc,source_properties.a_property\" and \" name desc , source_properties.a_property \" are equivalent. The following fields are supported: name parent state category resource_name event_time source_properties security_marks.marks", "location": "query", "type": "string" }, "pageSize": { -"description": "The maximum number of results to return in a single response. Default is 10, minimum is 1, maximum is 1000.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { -"description": "The value returned by the last `ListFindingsResponse`; indicates that this is a continuation of a prior `ListFindings` call, and that the system should return the next page of data.", "location": "query", "type": "string" }, "parent": { -"description": "Required. Name of the source the findings belong to. Its format is `organizations/[organization_id]/sources/[source_id]`, `folders/[folder_id]/sources/[source_id]`, or `projects/[project_id]/sources/[source_id]`. To list across all sources provide a source_id of `-`. For example: `organizations/{organization_id}/sources/-`, `folders/{folder_id}/sources/-` or `projects/{projects_id}/sources/-`", "location": "path", "pattern": "^folders/[^/]+/sources/[^/]+$", "required": true, @@ -1551,7 +1464,6 @@ }, "readTime": { "deprecated": true, -"description": "Time used as a reference point when filtering findings. The filter is limited to findings existing at the supplied time and their values are those at that specific time. Absence of this field will default to the API's version of NOW.", "format": "google-datetime", "location": "query", "type": "string" @@ -1566,7 +1478,7 @@ ] }, "patch": { -"description": "Creates or updates a finding. The corresponding source must exist for a finding creation to succeed.", +"description": "", "flatPath": "v1/folders/{foldersId}/sources/{sourcesId}/findings/{findingsId}", "httpMethod": "PATCH", "id": "securitycenter.folders.sources.findings.patch", @@ -1575,14 +1487,12 @@ ], "parameters": { "name": { -"description": "The [relative resource name](https://cloud.google.com/apis/design/resource_names#relative_resource_name) of the finding. Example: \"organizations/{organization_id}/sources/{source_id}/findings/{finding_id}\", \"folders/{folder_id}/sources/{source_id}/findings/{finding_id}\", \"projects/{project_id}/sources/{source_id}/findings/{finding_id}\".", "location": "path", "pattern": "^folders/[^/]+/sources/[^/]+/findings/[^/]+$", "required": true, "type": "string" }, "updateMask": { -"description": "The FieldMask to use when updating the finding resource. This field should not be specified when creating a finding. When updating a finding, an empty mask is treated as updating all mutable fields and replacing source_properties. Individual source_properties can be added/updated by using \"source_properties.\" in the field mask.", "format": "google-fieldmask", "location": "query", "type": "string" @@ -1600,7 +1510,7 @@ ] }, "setMute": { -"description": "Updates the mute state of a finding.", +"description": "", "flatPath": "v1/folders/{foldersId}/sources/{sourcesId}/findings/{findingsId}:setMute", "httpMethod": "POST", "id": "securitycenter.folders.sources.findings.setMute", @@ -1609,7 +1519,6 @@ ], "parameters": { "name": { -"description": "Required. The [relative resource name](https://cloud.google.com/apis/design/resource_names#relative_resource_name) of the finding. Example: `organizations/{organization_id}/sources/{source_id}/findings/{finding_id}`, `folders/{folder_id}/sources/{source_id}/findings/{finding_id}`, `projects/{project_id}/sources/{source_id}/findings/{finding_id}`.", "location": "path", "pattern": "^folders/[^/]+/sources/[^/]+/findings/[^/]+$", "required": true, @@ -1628,7 +1537,7 @@ ] }, "setState": { -"description": "Updates the state of a finding.", +"description": "", "flatPath": "v1/folders/{foldersId}/sources/{sourcesId}/findings/{findingsId}:setState", "httpMethod": "POST", "id": "securitycenter.folders.sources.findings.setState", @@ -1637,7 +1546,6 @@ ], "parameters": { "name": { -"description": "Required. The [relative resource name](https://cloud.google.com/apis/design/resource_names#relative_resource_name) of the finding. Example: `organizations/{organization_id}/sources/{source_id}/findings/{finding_id}`, `folders/{folder_id}/sources/{source_id}/findings/{finding_id}`, `projects/{project_id}/sources/{source_id}/findings/{finding_id}`.", "location": "path", "pattern": "^folders/[^/]+/sources/[^/]+/findings/[^/]+$", "required": true, @@ -1656,7 +1564,7 @@ ] }, "updateSecurityMarks": { -"description": "Updates security marks.", +"description": "", "flatPath": "v1/folders/{foldersId}/sources/{sourcesId}/findings/{findingsId}/securityMarks", "httpMethod": "PATCH", "id": "securitycenter.folders.sources.findings.updateSecurityMarks", @@ -1665,20 +1573,17 @@ ], "parameters": { "name": { -"description": "The relative resource name of the SecurityMarks. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Examples: \"organizations/{organization_id}/assets/{asset_id}/securityMarks\" \"organizations/{organization_id}/sources/{source_id}/findings/{finding_id}/securityMarks\".", "location": "path", "pattern": "^folders/[^/]+/sources/[^/]+/findings/[^/]+/securityMarks$", "required": true, "type": "string" }, "startTime": { -"description": "The time at which the updated SecurityMarks take effect. If not set uses current server time. Updates will be applied to the SecurityMarks that are active immediately preceding this time. Must be earlier or equal to the server time.", "format": "google-datetime", "location": "query", "type": "string" }, "updateMask": { -"description": "The FieldMask to use when updating the security marks resource. The field mask must not contain duplicate fields. If empty or set to \"marks\", all marks will be replaced. Individual marks can be updated using \"marks.\".", "format": "google-fieldmask", "location": "query", "type": "string" @@ -1700,7 +1605,7 @@ "externalSystems": { "methods": { "patch": { -"description": "Updates external system. This is for a given finding.", +"description": "", "flatPath": "v1/folders/{foldersId}/sources/{sourcesId}/findings/{findingsId}/externalSystems/{externalSystemsId}", "httpMethod": "PATCH", "id": "securitycenter.folders.sources.findings.externalSystems.patch", @@ -1709,14 +1614,12 @@ ], "parameters": { "name": { -"description": "Full resource name of the external system, for example: \"organizations/1234/sources/5678/findings/123456/externalSystems/jira\", \"folders/1234/sources/5678/findings/123456/externalSystems/jira\", \"projects/1234/sources/5678/findings/123456/externalSystems/jira\"", "location": "path", "pattern": "^folders/[^/]+/sources/[^/]+/findings/[^/]+/externalSystems/[^/]+$", "required": true, "type": "string" }, "updateMask": { -"description": "The FieldMask to use when updating the external system resource. If empty all mutable fields will be updated.", "format": "google-fieldmask", "location": "query", "type": "string" @@ -1744,7 +1647,7 @@ "organizations": { "methods": { "getOrganizationSettings": { -"description": "Gets the settings for an organization.", +"description": "", "flatPath": "v1/organizations/{organizationsId}/organizationSettings", "httpMethod": "GET", "id": "securitycenter.organizations.getOrganizationSettings", @@ -1753,7 +1656,6 @@ ], "parameters": { "name": { -"description": "Required. Name of the organization to get organization settings for. Its format is `organizations/[organization_id]/organizationSettings`.", "location": "path", "pattern": "^organizations/[^/]+/organizationSettings$", "required": true, @@ -1770,7 +1672,7 @@ }, "updateOrganizationSettings": { "deprecated": true, -"description": "Updates an organization's settings.", +"description": "", "flatPath": "v1/organizations/{organizationsId}/organizationSettings", "httpMethod": "PATCH", "id": "securitycenter.organizations.updateOrganizationSettings", @@ -1779,14 +1681,12 @@ ], "parameters": { "name": { -"description": "The relative resource name of the settings. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Example: \"organizations/{organization_id}/organizationSettings\".", "location": "path", "pattern": "^organizations/[^/]+/organizationSettings$", "required": true, "type": "string" }, "updateMask": { -"description": "The FieldMask to use when updating the settings resource. If empty all mutable fields will be updated.", "format": "google-fieldmask", "location": "query", "type": "string" @@ -1809,7 +1709,7 @@ "methods": { "group": { "deprecated": true, -"description": "Filters an organization's assets and groups them by their specified properties.", +"description": "", "flatPath": "v1/organizations/{organizationsId}/assets:group", "httpMethod": "POST", "id": "securitycenter.organizations.assets.group", @@ -1818,7 +1718,6 @@ ], "parameters": { "parent": { -"description": "Required. The name of the parent to group the assets by. Its format is `organizations/[organization_id]`, `folders/[folder_id]`, or `projects/[project_id]`.", "location": "path", "pattern": "^organizations/[^/]+$", "required": true, @@ -1838,7 +1737,7 @@ }, "list": { "deprecated": true, -"description": "Lists an organization's assets.", +"description": "", "flatPath": "v1/organizations/{organizationsId}/assets", "httpMethod": "GET", "id": "securitycenter.organizations.assets.list", @@ -1847,47 +1746,39 @@ ], "parameters": { "compareDuration": { -"description": "When compare_duration is set, the ListAssetsResult's \"state_change\" attribute is updated to indicate whether the asset was added, removed, or remained present during the compare_duration period of time that precedes the read_time. This is the time between (read_time - compare_duration) and read_time. The state_change value is derived based on the presence of the asset at the two points in time. Intermediate state changes between the two times don't affect the result. For example, the results aren't affected if the asset is removed and re-created again. Possible \"state_change\" values when compare_duration is specified: * \"ADDED\": indicates that the asset was not present at the start of compare_duration, but present at read_time. * \"REMOVED\": indicates that the asset was present at the start of compare_duration, but not present at read_time. * \"ACTIVE\": indicates that the asset was present at both the start and the end of the time period defined by compare_duration and read_time. If compare_duration is not specified, then the only possible state_change is \"UNUSED\", which will be the state_change set for all assets present at read_time.", "format": "google-duration", "location": "query", "type": "string" }, "fieldMask": { -"description": "A field mask to specify the ListAssetsResult fields to be listed in the response. An empty field mask will list all fields.", "format": "google-fieldmask", "location": "query", "type": "string" }, "filter": { -"description": "Expression that defines the filter to apply across assets. The expression is a list of zero or more restrictions combined via logical operators `AND` and `OR`. Parentheses are supported, and `OR` has higher precedence than `AND`. Restrictions have the form ` ` and may have a `-` character in front of them to indicate negation. The fields map to those defined in the Asset resource. Examples include: * name * security_center_properties.resource_name * resource_properties.a_property * security_marks.marks.marka The supported operators are: * `=` for all value types. * `>`, `<`, `>=`, `<=` for integer values. * `:`, meaning substring matching, for strings. The supported value types are: * string literals in quotes. * integer literals without quotes. * boolean literals `true` and `false` without quotes. The following are the allowed field and operator combinations: * name: `=` * update_time: `=`, `>`, `<`, `>=`, `<=` Usage: This should be milliseconds since epoch or an RFC3339 string. Examples: `update_time = \"2019-06-10T16:07:18-07:00\"` `update_time = 1560208038000` * create_time: `=`, `>`, `<`, `>=`, `<=` Usage: This should be milliseconds since epoch or an RFC3339 string. Examples: `create_time = \"2019-06-10T16:07:18-07:00\"` `create_time = 1560208038000` * iam_policy.policy_blob: `=`, `:` * resource_properties: `=`, `:`, `>`, `<`, `>=`, `<=` * security_marks.marks: `=`, `:` * security_center_properties.resource_name: `=`, `:` * security_center_properties.resource_display_name: `=`, `:` * security_center_properties.resource_type: `=`, `:` * security_center_properties.resource_parent: `=`, `:` * security_center_properties.resource_parent_display_name: `=`, `:` * security_center_properties.resource_project: `=`, `:` * security_center_properties.resource_project_display_name: `=`, `:` * security_center_properties.resource_owners: `=`, `:` For example, `resource_properties.size = 100` is a valid filter string. Use a partial match on the empty string to filter based on a property existing: `resource_properties.my_property : \"\"` Use a negated partial match on the empty string to filter based on a property not existing: `-resource_properties.my_property : \"\"`", "location": "query", "type": "string" }, "orderBy": { -"description": "Expression that defines what fields and order to use for sorting. The string value should follow SQL syntax: comma separated list of fields. For example: \"name,resource_properties.a_property\". The default sorting order is ascending. To specify descending order for a field, a suffix \" desc\" should be appended to the field name. For example: \"name desc,resource_properties.a_property\". Redundant space characters in the syntax are insignificant. \"name desc,resource_properties.a_property\" and \" name desc , resource_properties.a_property \" are equivalent. The following fields are supported: name update_time resource_properties security_marks.marks security_center_properties.resource_name security_center_properties.resource_display_name security_center_properties.resource_parent security_center_properties.resource_parent_display_name security_center_properties.resource_project security_center_properties.resource_project_display_name security_center_properties.resource_type", "location": "query", "type": "string" }, "pageSize": { -"description": "The maximum number of results to return in a single response. Default is 10, minimum is 1, maximum is 1000.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { -"description": "The value returned by the last `ListAssetsResponse`; indicates that this is a continuation of a prior `ListAssets` call, and that the system should return the next page of data.", "location": "query", "type": "string" }, "parent": { -"description": "Required. The name of the parent resource that contains the assets. The value that you can specify on parent depends on the method in which you specify parent. You can specify one of the following values: `organizations/[organization_id]`, `folders/[folder_id]`, or `projects/[project_id]`.", "location": "path", "pattern": "^organizations/[^/]+$", "required": true, "type": "string" }, "readTime": { -"description": "Time used as a reference point when filtering assets. The filter is limited to assets existing at the supplied time and their values are those at that specific time. Absence of this field will default to the API's version of NOW.", "format": "google-datetime", "location": "query", "type": "string" @@ -1903,7 +1794,7 @@ }, "runDiscovery": { "deprecated": true, -"description": "Runs asset discovery. The discovery is tracked with a long-running operation. This API can only be called with limited frequency for an organization. If it is called too frequently the caller will receive a TOO_MANY_REQUESTS error.", +"description": "", "flatPath": "v1/organizations/{organizationsId}/assets:runDiscovery", "httpMethod": "POST", "id": "securitycenter.organizations.assets.runDiscovery", @@ -1912,7 +1803,6 @@ ], "parameters": { "parent": { -"description": "Required. Name of the organization to run asset discovery for. Its format is `organizations/[organization_id]`.", "location": "path", "pattern": "^organizations/[^/]+$", "required": true, @@ -1931,7 +1821,7 @@ ] }, "updateSecurityMarks": { -"description": "Updates security marks.", +"description": "", "flatPath": "v1/organizations/{organizationsId}/assets/{assetsId}/securityMarks", "httpMethod": "PATCH", "id": "securitycenter.organizations.assets.updateSecurityMarks", @@ -1940,20 +1830,17 @@ ], "parameters": { "name": { -"description": "The relative resource name of the SecurityMarks. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Examples: \"organizations/{organization_id}/assets/{asset_id}/securityMarks\" \"organizations/{organization_id}/sources/{source_id}/findings/{finding_id}/securityMarks\".", "location": "path", "pattern": "^organizations/[^/]+/assets/[^/]+/securityMarks$", "required": true, "type": "string" }, "startTime": { -"description": "The time at which the updated SecurityMarks take effect. If not set uses current server time. Updates will be applied to the SecurityMarks that are active immediately preceding this time. Must be earlier or equal to the server time.", "format": "google-datetime", "location": "query", "type": "string" }, "updateMask": { -"description": "The FieldMask to use when updating the security marks resource. The field mask must not contain duplicate fields. If empty or set to \"marks\", all marks will be replaced. Individual marks can be updated using \"marks.\".", "format": "google-fieldmask", "location": "query", "type": "string" @@ -1975,7 +1862,7 @@ "attackPaths": { "methods": { "list": { -"description": "Lists the attack paths for a set of simulation results or valued resources and filter.", +"description": "", "flatPath": "v1/organizations/{organizationsId}/attackPaths", "httpMethod": "GET", "id": "securitycenter.organizations.attackPaths.list", @@ -1984,23 +1871,19 @@ ], "parameters": { "filter": { -"description": "The filter expression that filters the attack path in the response. Supported fields: * `valued_resources` supports =", "location": "query", "type": "string" }, "pageSize": { -"description": "The maximum number of results to return in a single response. Default is 10, minimum is 1, maximum is 1000.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { -"description": "The value returned by the last `ListAttackPathsResponse`; indicates that this is a continuation of a prior `ListAttackPaths` call, and that the system should return the next page of data.", "location": "query", "type": "string" }, "parent": { -"description": "Required. Name of parent to list attack paths. Valid formats: `organizations/{organization}`, `organizations/{organization}/simulations/{simulation}` `organizations/{organization}/simulations/{simulation}/attackExposureResults/{attack_exposure_result_v2}` `organizations/{organization}/simulations/{simulation}/valuedResources/{valued_resource}`", "location": "path", "pattern": "^organizations/[^/]+$", "required": true, @@ -2020,7 +1903,7 @@ "bigQueryExports": { "methods": { "create": { -"description": "Creates a BigQuery export.", +"description": "", "flatPath": "v1/organizations/{organizationsId}/bigQueryExports", "httpMethod": "POST", "id": "securitycenter.organizations.bigQueryExports.create", @@ -2029,12 +1912,10 @@ ], "parameters": { "bigQueryExportId": { -"description": "Required. Unique identifier provided by the client within the parent scope. It must consist of only lowercase letters, numbers, and hyphens, must start with a letter, must end with either a letter or a number, and must be 63 characters or less.", "location": "query", "type": "string" }, "parent": { -"description": "Required. The name of the parent resource of the new BigQuery export. Its format is `organizations/[organization_id]`, `folders/[folder_id]`, or `projects/[project_id]`.", "location": "path", "pattern": "^organizations/[^/]+$", "required": true, @@ -2053,7 +1934,7 @@ ] }, "delete": { -"description": "Deletes an existing BigQuery export.", +"description": "", "flatPath": "v1/organizations/{organizationsId}/bigQueryExports/{bigQueryExportsId}", "httpMethod": "DELETE", "id": "securitycenter.organizations.bigQueryExports.delete", @@ -2062,7 +1943,6 @@ ], "parameters": { "name": { -"description": "Required. The name of the BigQuery export to delete. Its format is `organizations/{organization}/bigQueryExports/{export_id}`, `folders/{folder}/bigQueryExports/{export_id}`, or `projects/{project}/bigQueryExports/{export_id}`", "location": "path", "pattern": "^organizations/[^/]+/bigQueryExports/[^/]+$", "required": true, @@ -2078,7 +1958,7 @@ ] }, "get": { -"description": "Gets a BigQuery export.", +"description": "", "flatPath": "v1/organizations/{organizationsId}/bigQueryExports/{bigQueryExportsId}", "httpMethod": "GET", "id": "securitycenter.organizations.bigQueryExports.get", @@ -2087,7 +1967,6 @@ ], "parameters": { "name": { -"description": "Required. Name of the BigQuery export to retrieve. Its format is `organizations/{organization}/bigQueryExports/{export_id}`, `folders/{folder}/bigQueryExports/{export_id}`, or `projects/{project}/bigQueryExports/{export_id}`", "location": "path", "pattern": "^organizations/[^/]+/bigQueryExports/[^/]+$", "required": true, @@ -2103,7 +1982,7 @@ ] }, "list": { -"description": "Lists BigQuery exports. Note that when requesting BigQuery exports at a given level all exports under that level are also returned e.g. if requesting BigQuery exports under a folder, then all BigQuery exports immediately under the folder plus the ones created under the projects within the folder are returned.", +"description": "", "flatPath": "v1/organizations/{organizationsId}/bigQueryExports", "httpMethod": "GET", "id": "securitycenter.organizations.bigQueryExports.list", @@ -2112,18 +1991,15 @@ ], "parameters": { "pageSize": { -"description": "The maximum number of configs to return. The service may return fewer than this value. If unspecified, at most 10 configs will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { -"description": "A page token, received from a previous `ListBigQueryExports` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListBigQueryExports` must match the call that provided the page token.", "location": "query", "type": "string" }, "parent": { -"description": "Required. The parent, which owns the collection of BigQuery exports. Its format is `organizations/[organization_id]`, `folders/[folder_id]`, `projects/[project_id]`.", "location": "path", "pattern": "^organizations/[^/]+$", "required": true, @@ -2139,7 +2015,7 @@ ] }, "patch": { -"description": "Updates a BigQuery export.", +"description": "", "flatPath": "v1/organizations/{organizationsId}/bigQueryExports/{bigQueryExportsId}", "httpMethod": "PATCH", "id": "securitycenter.organizations.bigQueryExports.patch", @@ -2148,14 +2024,12 @@ ], "parameters": { "name": { -"description": "The relative resource name of this export. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name. Example format: \"organizations/{organization_id}/bigQueryExports/{export_id}\" Example format: \"folders/{folder_id}/bigQueryExports/{export_id}\" Example format: \"projects/{project_id}/bigQueryExports/{export_id}\" This field is provided in responses, and is ignored when provided in create requests.", "location": "path", "pattern": "^organizations/[^/]+/bigQueryExports/[^/]+$", "required": true, "type": "string" }, "updateMask": { -"description": "The list of fields to be updated. If empty all mutable fields will be updated.", "format": "google-fieldmask", "location": "query", "type": "string" @@ -2177,7 +2051,7 @@ "eventThreatDetectionSettings": { "methods": { "validateCustomModule": { -"description": "Validates the given Event Threat Detection custom module.", +"description": "", "flatPath": "v1/organizations/{organizationsId}/eventThreatDetectionSettings:validateCustomModule", "httpMethod": "POST", "id": "securitycenter.organizations.eventThreatDetectionSettings.validateCustomModule", @@ -2186,7 +2060,6 @@ ], "parameters": { "parent": { -"description": "Required. Resource name of the parent to validate the Custom Module under. Its format is: * `organizations/{organization}/eventThreatDetectionSettings`. * `folders/{folder}/eventThreatDetectionSettings`. * `projects/{project}/eventThreatDetectionSettings`.", "location": "path", "pattern": "^organizations/[^/]+/eventThreatDetectionSettings$", "required": true, @@ -2209,7 +2082,7 @@ "customModules": { "methods": { "create": { -"description": "Creates a resident Event Threat Detection custom module at the scope of the given Resource Manager parent, and also creates inherited custom modules for all descendants of the given parent. These modules are enabled by default.", +"description": "", "flatPath": "v1/organizations/{organizationsId}/eventThreatDetectionSettings/customModules", "httpMethod": "POST", "id": "securitycenter.organizations.eventThreatDetectionSettings.customModules.create", @@ -2218,7 +2091,6 @@ ], "parameters": { "parent": { -"description": "Required. The new custom module's parent. Its format is: * `organizations/{organization}/eventThreatDetectionSettings`. * `folders/{folder}/eventThreatDetectionSettings`. * `projects/{project}/eventThreatDetectionSettings`.", "location": "path", "pattern": "^organizations/[^/]+/eventThreatDetectionSettings$", "required": true, @@ -2237,7 +2109,7 @@ ] }, "delete": { -"description": "Deletes the specified Event Threat Detection custom module and all of its descendants in the Resource Manager hierarchy. This method is only supported for resident custom modules.", +"description": "", "flatPath": "v1/organizations/{organizationsId}/eventThreatDetectionSettings/customModules/{customModulesId}", "httpMethod": "DELETE", "id": "securitycenter.organizations.eventThreatDetectionSettings.customModules.delete", @@ -2246,7 +2118,6 @@ ], "parameters": { "name": { -"description": "Required. Name of the custom module to delete. Its format is: * `organizations/{organization}/eventThreatDetectionSettings/customModules/{module}`. * `folders/{folder}/eventThreatDetectionSettings/customModules/{module}`. * `projects/{project}/eventThreatDetectionSettings/customModules/{module}`.", "location": "path", "pattern": "^organizations/[^/]+/eventThreatDetectionSettings/customModules/[^/]+$", "required": true, @@ -2262,7 +2133,7 @@ ] }, "get": { -"description": "Gets an Event Threat Detection custom module.", +"description": "", "flatPath": "v1/organizations/{organizationsId}/eventThreatDetectionSettings/customModules/{customModulesId}", "httpMethod": "GET", "id": "securitycenter.organizations.eventThreatDetectionSettings.customModules.get", @@ -2271,7 +2142,6 @@ ], "parameters": { "name": { -"description": "Required. Name of the custom module to get. Its format is: * `organizations/{organization}/eventThreatDetectionSettings/customModules/{module}`. * `folders/{folder}/eventThreatDetectionSettings/customModules/{module}`. * `projects/{project}/eventThreatDetectionSettings/customModules/{module}`.", "location": "path", "pattern": "^organizations/[^/]+/eventThreatDetectionSettings/customModules/[^/]+$", "required": true, @@ -2287,7 +2157,7 @@ ] }, "list": { -"description": "Lists all Event Threat Detection custom modules for the given Resource Manager parent. This includes resident modules defined at the scope of the parent along with modules inherited from ancestors.", +"description": "", "flatPath": "v1/organizations/{organizationsId}/eventThreatDetectionSettings/customModules", "httpMethod": "GET", "id": "securitycenter.organizations.eventThreatDetectionSettings.customModules.list", @@ -2296,18 +2166,15 @@ ], "parameters": { "pageSize": { -"description": "The maximum number of modules to return. The service may return fewer than this value. If unspecified, at most 10 configs will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { -"description": "A page token, received from a previous `ListEventThreatDetectionCustomModules` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListEventThreatDetectionCustomModules` must match the call that provided the page token.", "location": "query", "type": "string" }, "parent": { -"description": "Required. Name of the parent to list custom modules under. Its format is: * `organizations/{organization}/eventThreatDetectionSettings`. * `folders/{folder}/eventThreatDetectionSettings`. * `projects/{project}/eventThreatDetectionSettings`.", "location": "path", "pattern": "^organizations/[^/]+/eventThreatDetectionSettings$", "required": true, @@ -2323,7 +2190,7 @@ ] }, "listDescendant": { -"description": "Lists all resident Event Threat Detection custom modules under the given Resource Manager parent and its descendants.", +"description": "", "flatPath": "v1/organizations/{organizationsId}/eventThreatDetectionSettings/customModules:listDescendant", "httpMethod": "GET", "id": "securitycenter.organizations.eventThreatDetectionSettings.customModules.listDescendant", @@ -2332,18 +2199,15 @@ ], "parameters": { "pageSize": { -"description": "The maximum number of modules to return. The service may return fewer than this value. If unspecified, at most 10 configs will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { -"description": "A page token, received from a previous `ListDescendantEventThreatDetectionCustomModules` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListDescendantEventThreatDetectionCustomModules` must match the call that provided the page token.", "location": "query", "type": "string" }, "parent": { -"description": "Required. Name of the parent to list custom modules under. Its format is: * `organizations/{organization}/eventThreatDetectionSettings`. * `folders/{folder}/eventThreatDetectionSettings`. * `projects/{project}/eventThreatDetectionSettings`.", "location": "path", "pattern": "^organizations/[^/]+/eventThreatDetectionSettings$", "required": true, @@ -2359,7 +2223,7 @@ ] }, "patch": { -"description": "Updates the Event Threat Detection custom module with the given name based on the given update mask. Updating the enablement state is supported for both resident and inherited modules (though resident modules cannot have an enablement state of \"inherited\"). Updating the display name or configuration of a module is supported for resident modules only. The type of a module cannot be changed.", +"description": "", "flatPath": "v1/organizations/{organizationsId}/eventThreatDetectionSettings/customModules/{customModulesId}", "httpMethod": "PATCH", "id": "securitycenter.organizations.eventThreatDetectionSettings.customModules.patch", @@ -2368,14 +2232,12 @@ ], "parameters": { "name": { -"description": "Immutable. The resource name of the Event Threat Detection custom module. Its format is: * `organizations/{organization}/eventThreatDetectionSettings/customModules/{module}`. * `folders/{folder}/eventThreatDetectionSettings/customModules/{module}`. * `projects/{project}/eventThreatDetectionSettings/customModules/{module}`.", "location": "path", "pattern": "^organizations/[^/]+/eventThreatDetectionSettings/customModules/[^/]+$", "required": true, "type": "string" }, "updateMask": { -"description": "The list of fields to be updated. If empty all mutable fields will be updated.", "format": "google-fieldmask", "location": "query", "type": "string" @@ -2397,7 +2259,7 @@ "effectiveCustomModules": { "methods": { "get": { -"description": "Gets an effective Event Threat Detection custom module at the given level.", +"description": "", "flatPath": "v1/organizations/{organizationsId}/eventThreatDetectionSettings/effectiveCustomModules/{effectiveCustomModulesId}", "httpMethod": "GET", "id": "securitycenter.organizations.eventThreatDetectionSettings.effectiveCustomModules.get", @@ -2406,7 +2268,6 @@ ], "parameters": { "name": { -"description": "Required. The resource name of the effective Event Threat Detection custom module. Its format is: * `organizations/{organization}/eventThreatDetectionSettings/effectiveCustomModules/{module}`. * `folders/{folder}/eventThreatDetectionSettings/effectiveCustomModules/{module}`. * `projects/{project}/eventThreatDetectionSettings/effectiveCustomModules/{module}`.", "location": "path", "pattern": "^organizations/[^/]+/eventThreatDetectionSettings/effectiveCustomModules/[^/]+$", "required": true, @@ -2422,7 +2283,7 @@ ] }, "list": { -"description": "Lists all effective Event Threat Detection custom modules for the given parent. This includes resident modules defined at the scope of the parent along with modules inherited from its ancestors.", +"description": "", "flatPath": "v1/organizations/{organizationsId}/eventThreatDetectionSettings/effectiveCustomModules", "httpMethod": "GET", "id": "securitycenter.organizations.eventThreatDetectionSettings.effectiveCustomModules.list", @@ -2431,18 +2292,15 @@ ], "parameters": { "pageSize": { -"description": "The maximum number of modules to return. The service may return fewer than this value. If unspecified, at most 10 configs will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { -"description": "A page token, received from a previous `ListEffectiveEventThreatDetectionCustomModules` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListEffectiveEventThreatDetectionCustomModules` must match the call that provided the page token.", "location": "query", "type": "string" }, "parent": { -"description": "Required. Name of the parent to list custom modules for. Its format is: * `organizations/{organization}/eventThreatDetectionSettings`. * `folders/{folder}/eventThreatDetectionSettings`. * `projects/{project}/eventThreatDetectionSettings`.", "location": "path", "pattern": "^organizations/[^/]+/eventThreatDetectionSettings$", "required": true, @@ -2464,7 +2322,7 @@ "findings": { "methods": { "bulkMute": { -"description": "Kicks off an LRO to bulk mute findings for a parent based on a filter. The parent can be either an organization, folder or project. The findings matched by the filter will be muted after the LRO is done.", +"description": "", "flatPath": "v1/organizations/{organizationsId}/findings:bulkMute", "httpMethod": "POST", "id": "securitycenter.organizations.findings.bulkMute", @@ -2473,7 +2331,6 @@ ], "parameters": { "parent": { -"description": "Required. The parent, at which bulk action needs to be applied. Its format is `organizations/[organization_id]`, `folders/[folder_id]`, `projects/[project_id]`.", "location": "path", "pattern": "^organizations/[^/]+$", "required": true, @@ -2498,7 +2355,7 @@ "muteConfigs": { "methods": { "delete": { -"description": "Deletes an existing mute config.", +"description": "", "flatPath": "v1/organizations/{organizationsId}/locations/{locationsId}/muteConfigs/{muteConfigsId}", "httpMethod": "DELETE", "id": "securitycenter.organizations.locations.muteConfigs.delete", @@ -2507,7 +2364,6 @@ ], "parameters": { "name": { -"description": "Required. Name of the mute config to delete. Its format is `organizations/{organization}/muteConfigs/{config_id}`, `folders/{folder}/muteConfigs/{config_id}`, `projects/{project}/muteConfigs/{config_id}`, `organizations/{organization}/locations/global/muteConfigs/{config_id}`, `folders/{folder}/locations/global/muteConfigs/{config_id}`, or `projects/{project}/locations/global/muteConfigs/{config_id}`.", "location": "path", "pattern": "^organizations/[^/]+/locations/[^/]+/muteConfigs/[^/]+$", "required": true, @@ -2523,7 +2379,7 @@ ] }, "get": { -"description": "Gets a mute config.", +"description": "", "flatPath": "v1/organizations/{organizationsId}/locations/{locationsId}/muteConfigs/{muteConfigsId}", "httpMethod": "GET", "id": "securitycenter.organizations.locations.muteConfigs.get", @@ -2532,7 +2388,6 @@ ], "parameters": { "name": { -"description": "Required. Name of the mute config to retrieve. Its format is `organizations/{organization}/muteConfigs/{config_id}`, `folders/{folder}/muteConfigs/{config_id}`, `projects/{project}/muteConfigs/{config_id}`, `organizations/{organization}/locations/global/muteConfigs/{config_id}`, `folders/{folder}/locations/global/muteConfigs/{config_id}`, or `projects/{project}/locations/global/muteConfigs/{config_id}`.", "location": "path", "pattern": "^organizations/[^/]+/locations/[^/]+/muteConfigs/[^/]+$", "required": true, @@ -2548,7 +2403,7 @@ ] }, "patch": { -"description": "Updates a mute config.", +"description": "", "flatPath": "v1/organizations/{organizationsId}/locations/{locationsId}/muteConfigs/{muteConfigsId}", "httpMethod": "PATCH", "id": "securitycenter.organizations.locations.muteConfigs.patch", @@ -2557,14 +2412,12 @@ ], "parameters": { "name": { -"description": "This field will be ignored if provided on config creation. Format `organizations/{organization}/muteConfigs/{mute_config}` `folders/{folder}/muteConfigs/{mute_config}` `projects/{project}/muteConfigs/{mute_config}` `organizations/{organization}/locations/global/muteConfigs/{mute_config}` `folders/{folder}/locations/global/muteConfigs/{mute_config}` `projects/{project}/locations/global/muteConfigs/{mute_config}`", "location": "path", "pattern": "^organizations/[^/]+/locations/[^/]+/muteConfigs/[^/]+$", "required": true, "type": "string" }, "updateMask": { -"description": "The list of fields to be updated. If empty all mutable fields will be updated.", "format": "google-fieldmask", "location": "query", "type": "string" @@ -2588,7 +2441,7 @@ "muteConfigs": { "methods": { "create": { -"description": "Creates a mute config.", +"description": "", "flatPath": "v1/organizations/{organizationsId}/muteConfigs", "httpMethod": "POST", "id": "securitycenter.organizations.muteConfigs.create", @@ -2597,12 +2450,10 @@ ], "parameters": { "muteConfigId": { -"description": "Required. Unique identifier provided by the client within the parent scope. It must consist of only lowercase letters, numbers, and hyphens, must start with a letter, must end with either a letter or a number, and must be 63 characters or less.", "location": "query", "type": "string" }, "parent": { -"description": "Required. Resource name of the new mute configs's parent. Its format is `organizations/[organization_id]`, `folders/[folder_id]`, or `projects/[project_id]`.", "location": "path", "pattern": "^organizations/[^/]+$", "required": true, @@ -2621,7 +2472,7 @@ ] }, "delete": { -"description": "Deletes an existing mute config.", +"description": "", "flatPath": "v1/organizations/{organizationsId}/muteConfigs/{muteConfigsId}", "httpMethod": "DELETE", "id": "securitycenter.organizations.muteConfigs.delete", @@ -2630,7 +2481,6 @@ ], "parameters": { "name": { -"description": "Required. Name of the mute config to delete. Its format is `organizations/{organization}/muteConfigs/{config_id}`, `folders/{folder}/muteConfigs/{config_id}`, `projects/{project}/muteConfigs/{config_id}`, `organizations/{organization}/locations/global/muteConfigs/{config_id}`, `folders/{folder}/locations/global/muteConfigs/{config_id}`, or `projects/{project}/locations/global/muteConfigs/{config_id}`.", "location": "path", "pattern": "^organizations/[^/]+/muteConfigs/[^/]+$", "required": true, @@ -2646,7 +2496,7 @@ ] }, "get": { -"description": "Gets a mute config.", +"description": "", "flatPath": "v1/organizations/{organizationsId}/muteConfigs/{muteConfigsId}", "httpMethod": "GET", "id": "securitycenter.organizations.muteConfigs.get", @@ -2655,7 +2505,6 @@ ], "parameters": { "name": { -"description": "Required. Name of the mute config to retrieve. Its format is `organizations/{organization}/muteConfigs/{config_id}`, `folders/{folder}/muteConfigs/{config_id}`, `projects/{project}/muteConfigs/{config_id}`, `organizations/{organization}/locations/global/muteConfigs/{config_id}`, `folders/{folder}/locations/global/muteConfigs/{config_id}`, or `projects/{project}/locations/global/muteConfigs/{config_id}`.", "location": "path", "pattern": "^organizations/[^/]+/muteConfigs/[^/]+$", "required": true, @@ -2671,7 +2520,7 @@ ] }, "list": { -"description": "Lists mute configs.", +"description": "", "flatPath": "v1/organizations/{organizationsId}/muteConfigs", "httpMethod": "GET", "id": "securitycenter.organizations.muteConfigs.list", @@ -2680,18 +2529,15 @@ ], "parameters": { "pageSize": { -"description": "The maximum number of configs to return. The service may return fewer than this value. If unspecified, at most 10 configs will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { -"description": "A page token, received from a previous `ListMuteConfigs` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListMuteConfigs` must match the call that provided the page token.", "location": "query", "type": "string" }, "parent": { -"description": "Required. The parent, which owns the collection of mute configs. Its format is `organizations/[organization_id]`, `folders/[folder_id]`, `projects/[project_id]`.", "location": "path", "pattern": "^organizations/[^/]+$", "required": true, @@ -2707,7 +2553,7 @@ ] }, "patch": { -"description": "Updates a mute config.", +"description": "", "flatPath": "v1/organizations/{organizationsId}/muteConfigs/{muteConfigsId}", "httpMethod": "PATCH", "id": "securitycenter.organizations.muteConfigs.patch", @@ -2716,14 +2562,12 @@ ], "parameters": { "name": { -"description": "This field will be ignored if provided on config creation. Format `organizations/{organization}/muteConfigs/{mute_config}` `folders/{folder}/muteConfigs/{mute_config}` `projects/{project}/muteConfigs/{mute_config}` `organizations/{organization}/locations/global/muteConfigs/{mute_config}` `folders/{folder}/locations/global/muteConfigs/{mute_config}` `projects/{project}/locations/global/muteConfigs/{mute_config}`", "location": "path", "pattern": "^organizations/[^/]+/muteConfigs/[^/]+$", "required": true, "type": "string" }, "updateMask": { -"description": "The list of fields to be updated. If empty all mutable fields will be updated.", "format": "google-fieldmask", "location": "query", "type": "string" @@ -2745,7 +2589,7 @@ "notificationConfigs": { "methods": { "create": { -"description": "Creates a notification config.", +"description": "", "flatPath": "v1/organizations/{organizationsId}/notificationConfigs", "httpMethod": "POST", "id": "securitycenter.organizations.notificationConfigs.create", @@ -2754,12 +2598,10 @@ ], "parameters": { "configId": { -"description": "Required. Unique identifier provided by the client within the parent scope. It must be between 1 and 128 characters and contain alphanumeric characters, underscores, or hyphens only.", "location": "query", "type": "string" }, "parent": { -"description": "Required. Resource name of the new notification config's parent. Its format is `organizations/[organization_id]`, `folders/[folder_id]`, or `projects/[project_id]`.", "location": "path", "pattern": "^organizations/[^/]+$", "required": true, @@ -2778,7 +2620,7 @@ ] }, "delete": { -"description": "Deletes a notification config.", +"description": "", "flatPath": "v1/organizations/{organizationsId}/notificationConfigs/{notificationConfigsId}", "httpMethod": "DELETE", "id": "securitycenter.organizations.notificationConfigs.delete", @@ -2787,7 +2629,6 @@ ], "parameters": { "name": { -"description": "Required. Name of the notification config to delete. Its format is `organizations/[organization_id]/notificationConfigs/[config_id]`, `folders/[folder_id]/notificationConfigs/[config_id]`, or `projects/[project_id]/notificationConfigs/[config_id]`.", "location": "path", "pattern": "^organizations/[^/]+/notificationConfigs/[^/]+$", "required": true, @@ -2803,7 +2644,7 @@ ] }, "get": { -"description": "Gets a notification config.", +"description": "", "flatPath": "v1/organizations/{organizationsId}/notificationConfigs/{notificationConfigsId}", "httpMethod": "GET", "id": "securitycenter.organizations.notificationConfigs.get", @@ -2812,7 +2653,6 @@ ], "parameters": { "name": { -"description": "Required. Name of the notification config to get. Its format is `organizations/[organization_id]/notificationConfigs/[config_id]`, `folders/[folder_id]/notificationConfigs/[config_id]`, or `projects/[project_id]/notificationConfigs/[config_id]`.", "location": "path", "pattern": "^organizations/[^/]+/notificationConfigs/[^/]+$", "required": true, @@ -2828,7 +2668,7 @@ ] }, "list": { -"description": "Lists notification configs.", +"description": "", "flatPath": "v1/organizations/{organizationsId}/notificationConfigs", "httpMethod": "GET", "id": "securitycenter.organizations.notificationConfigs.list", @@ -2837,18 +2677,15 @@ ], "parameters": { "pageSize": { -"description": "The maximum number of results to return in a single response. Default is 10, minimum is 1, maximum is 1000.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { -"description": "The value returned by the last `ListNotificationConfigsResponse`; indicates that this is a continuation of a prior `ListNotificationConfigs` call, and that the system should return the next page of data.", "location": "query", "type": "string" }, "parent": { -"description": "Required. The name of the parent in which to list the notification configurations. Its format is \"organizations/[organization_id]\", \"folders/[folder_id]\", or \"projects/[project_id]\".", "location": "path", "pattern": "^organizations/[^/]+$", "required": true, @@ -2864,7 +2701,7 @@ ] }, "patch": { -"description": " Updates a notification config. The following update fields are allowed: description, pubsub_topic, streaming_config.filter", +"description": "", "flatPath": "v1/organizations/{organizationsId}/notificationConfigs/{notificationConfigsId}", "httpMethod": "PATCH", "id": "securitycenter.organizations.notificationConfigs.patch", @@ -2873,14 +2710,12 @@ ], "parameters": { "name": { -"description": "The relative resource name of this notification config. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Example: \"organizations/{organization_id}/notificationConfigs/notify_public_bucket\", \"folders/{folder_id}/notificationConfigs/notify_public_bucket\", or \"projects/{project_id}/notificationConfigs/notify_public_bucket\".", "location": "path", "pattern": "^organizations/[^/]+/notificationConfigs/[^/]+$", "required": true, "type": "string" }, "updateMask": { -"description": "The FieldMask to use when updating the notification config. If empty all mutable fields will be updated.", "format": "google-fieldmask", "location": "query", "type": "string" @@ -2902,7 +2737,7 @@ "operations": { "methods": { "cancel": { -"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", +"description": "", "flatPath": "v1/organizations/{organizationsId}/operations/{operationsId}:cancel", "httpMethod": "POST", "id": "securitycenter.organizations.operations.cancel", @@ -2911,7 +2746,6 @@ ], "parameters": { "name": { -"description": "The name of the operation resource to be cancelled.", "location": "path", "pattern": "^organizations/[^/]+/operations/[^/]+$", "required": true, @@ -2927,7 +2761,7 @@ ] }, "delete": { -"description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", +"description": "", "flatPath": "v1/organizations/{organizationsId}/operations/{operationsId}", "httpMethod": "DELETE", "id": "securitycenter.organizations.operations.delete", @@ -2936,7 +2770,6 @@ ], "parameters": { "name": { -"description": "The name of the operation resource to be deleted.", "location": "path", "pattern": "^organizations/[^/]+/operations/[^/]+$", "required": true, @@ -2952,7 +2785,7 @@ ] }, "get": { -"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", +"description": "", "flatPath": "v1/organizations/{organizationsId}/operations/{operationsId}", "httpMethod": "GET", "id": "securitycenter.organizations.operations.get", @@ -2961,7 +2794,6 @@ ], "parameters": { "name": { -"description": "The name of the operation resource.", "location": "path", "pattern": "^organizations/[^/]+/operations/[^/]+$", "required": true, @@ -2977,7 +2809,7 @@ ] }, "list": { -"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", +"description": "", "flatPath": "v1/organizations/{organizationsId}/operations", "httpMethod": "GET", "id": "securitycenter.organizations.operations.list", @@ -2986,30 +2818,25 @@ ], "parameters": { "filter": { -"description": "The standard list filter.", "location": "query", "type": "string" }, "name": { -"description": "The name of the operation's parent resource.", "location": "path", "pattern": "^organizations/[^/]+/operations$", "required": true, "type": "string" }, "pageSize": { -"description": "The standard list page size.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { -"description": "The standard list page token.", "location": "query", "type": "string" }, "returnPartialSuccess": { -"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "location": "query", "type": "boolean" } @@ -3027,7 +2854,7 @@ "resourceValueConfigs": { "methods": { "batchCreate": { -"description": "Creates a ResourceValueConfig for an organization. Maps user's tags to difference resource values for use by the attack path simulation.", +"description": "", "flatPath": "v1/organizations/{organizationsId}/resourceValueConfigs:batchCreate", "httpMethod": "POST", "id": "securitycenter.organizations.resourceValueConfigs.batchCreate", @@ -3036,7 +2863,6 @@ ], "parameters": { "parent": { -"description": "Required. Resource name of the new ResourceValueConfig's parent. The parent field in the CreateResourceValueConfigRequest messages must either be empty or match this field.", "location": "path", "pattern": "^organizations/[^/]+$", "required": true, @@ -3055,7 +2881,7 @@ ] }, "delete": { -"description": "Deletes a ResourceValueConfig.", +"description": "", "flatPath": "v1/organizations/{organizationsId}/resourceValueConfigs/{resourceValueConfigsId}", "httpMethod": "DELETE", "id": "securitycenter.organizations.resourceValueConfigs.delete", @@ -3064,7 +2890,6 @@ ], "parameters": { "name": { -"description": "Required. Name of the ResourceValueConfig to delete", "location": "path", "pattern": "^organizations/[^/]+/resourceValueConfigs/[^/]+$", "required": true, @@ -3080,7 +2905,7 @@ ] }, "get": { -"description": "Gets a ResourceValueConfig.", +"description": "", "flatPath": "v1/organizations/{organizationsId}/resourceValueConfigs/{resourceValueConfigsId}", "httpMethod": "GET", "id": "securitycenter.organizations.resourceValueConfigs.get", @@ -3089,7 +2914,6 @@ ], "parameters": { "name": { -"description": "Required. Name of the resource value config to retrieve. Its format is `organizations/{organization}/resourceValueConfigs/{config_id}`.", "location": "path", "pattern": "^organizations/[^/]+/resourceValueConfigs/[^/]+$", "required": true, @@ -3105,7 +2929,7 @@ ] }, "list": { -"description": "Lists all ResourceValueConfigs.", +"description": "", "flatPath": "v1/organizations/{organizationsId}/resourceValueConfigs", "httpMethod": "GET", "id": "securitycenter.organizations.resourceValueConfigs.list", @@ -3114,18 +2938,15 @@ ], "parameters": { "pageSize": { -"description": "The number of results to return. The service may return fewer than this value. If unspecified, at most 10 configs will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { -"description": "A page token, received from a previous `ListResourceValueConfigs` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListResourceValueConfigs` must match the call that provided the page token. page_size can be specified, and the new page_size will be used.", "location": "query", "type": "string" }, "parent": { -"description": "Required. The parent, which owns the collection of resource value configs. Its format is `organizations/[organization_id]`", "location": "path", "pattern": "^organizations/[^/]+$", "required": true, @@ -3141,7 +2962,7 @@ ] }, "patch": { -"description": "Updates an existing ResourceValueConfigs with new rules.", +"description": "", "flatPath": "v1/organizations/{organizationsId}/resourceValueConfigs/{resourceValueConfigsId}", "httpMethod": "PATCH", "id": "securitycenter.organizations.resourceValueConfigs.patch", @@ -3150,14 +2971,12 @@ ], "parameters": { "name": { -"description": "Name for the resource value configuration", "location": "path", "pattern": "^organizations/[^/]+/resourceValueConfigs/[^/]+$", "required": true, "type": "string" }, "updateMask": { -"description": "The list of fields to be updated. If empty all mutable fields will be updated.", "format": "google-fieldmask", "location": "query", "type": "string" @@ -3181,7 +3000,7 @@ "customModules": { "methods": { "create": { -"description": "Creates a resident SecurityHealthAnalyticsCustomModule at the scope of the given CRM parent, and also creates inherited SecurityHealthAnalyticsCustomModules for all CRM descendants of the given parent. These modules are enabled by default.", +"description": "", "flatPath": "v1/organizations/{organizationsId}/securityHealthAnalyticsSettings/customModules", "httpMethod": "POST", "id": "securitycenter.organizations.securityHealthAnalyticsSettings.customModules.create", @@ -3190,7 +3009,6 @@ ], "parameters": { "parent": { -"description": "Required. Resource name of the new custom module's parent. Its format is `organizations/{organization}/securityHealthAnalyticsSettings`, `folders/{folder}/securityHealthAnalyticsSettings`, or `projects/{project}/securityHealthAnalyticsSettings`", "location": "path", "pattern": "^organizations/[^/]+/securityHealthAnalyticsSettings$", "required": true, @@ -3209,7 +3027,7 @@ ] }, "delete": { -"description": "Deletes the specified SecurityHealthAnalyticsCustomModule and all of its descendants in the CRM hierarchy. This method is only supported for resident custom modules.", +"description": "", "flatPath": "v1/organizations/{organizationsId}/securityHealthAnalyticsSettings/customModules/{customModulesId}", "httpMethod": "DELETE", "id": "securitycenter.organizations.securityHealthAnalyticsSettings.customModules.delete", @@ -3218,7 +3036,6 @@ ], "parameters": { "name": { -"description": "Required. Name of the custom module to delete. Its format is `organizations/{organization}/securityHealthAnalyticsSettings/customModules/{customModule}`, `folders/{folder}/securityHealthAnalyticsSettings/customModules/{customModule}`, or `projects/{project}/securityHealthAnalyticsSettings/customModules/{customModule}`", "location": "path", "pattern": "^organizations/[^/]+/securityHealthAnalyticsSettings/customModules/[^/]+$", "required": true, @@ -3234,7 +3051,7 @@ ] }, "get": { -"description": "Retrieves a SecurityHealthAnalyticsCustomModule.", +"description": "", "flatPath": "v1/organizations/{organizationsId}/securityHealthAnalyticsSettings/customModules/{customModulesId}", "httpMethod": "GET", "id": "securitycenter.organizations.securityHealthAnalyticsSettings.customModules.get", @@ -3243,7 +3060,6 @@ ], "parameters": { "name": { -"description": "Required. Name of the custom module to get. Its format is `organizations/{organization}/securityHealthAnalyticsSettings/customModules/{customModule}`, `folders/{folder}/securityHealthAnalyticsSettings/customModules/{customModule}`, or `projects/{project}/securityHealthAnalyticsSettings/customModules/{customModule}`", "location": "path", "pattern": "^organizations/[^/]+/securityHealthAnalyticsSettings/customModules/[^/]+$", "required": true, @@ -3259,7 +3075,7 @@ ] }, "list": { -"description": "Returns a list of all SecurityHealthAnalyticsCustomModules for the given parent. This includes resident modules defined at the scope of the parent, and inherited modules, inherited from CRM ancestors.", +"description": "", "flatPath": "v1/organizations/{organizationsId}/securityHealthAnalyticsSettings/customModules", "httpMethod": "GET", "id": "securitycenter.organizations.securityHealthAnalyticsSettings.customModules.list", @@ -3268,18 +3084,15 @@ ], "parameters": { "pageSize": { -"description": "The maximum number of results to return in a single response. Default is 10, minimum is 1, maximum is 1000.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { -"description": "The value returned by the last call indicating a continuation", "location": "query", "type": "string" }, "parent": { -"description": "Required. Name of parent to list custom modules. Its format is `organizations/{organization}/securityHealthAnalyticsSettings`, `folders/{folder}/securityHealthAnalyticsSettings`, or `projects/{project}/securityHealthAnalyticsSettings`", "location": "path", "pattern": "^organizations/[^/]+/securityHealthAnalyticsSettings$", "required": true, @@ -3295,7 +3108,7 @@ ] }, "listDescendant": { -"description": "Returns a list of all resident SecurityHealthAnalyticsCustomModules under the given CRM parent and all of the parent\u2019s CRM descendants.", +"description": "", "flatPath": "v1/organizations/{organizationsId}/securityHealthAnalyticsSettings/customModules:listDescendant", "httpMethod": "GET", "id": "securitycenter.organizations.securityHealthAnalyticsSettings.customModules.listDescendant", @@ -3304,18 +3117,15 @@ ], "parameters": { "pageSize": { -"description": "The maximum number of results to return in a single response. Default is 10, minimum is 1, maximum is 1000.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { -"description": "The value returned by the last call indicating a continuation", "location": "query", "type": "string" }, "parent": { -"description": "Required. Name of parent to list descendant custom modules. Its format is `organizations/{organization}/securityHealthAnalyticsSettings`, `folders/{folder}/securityHealthAnalyticsSettings`, or `projects/{project}/securityHealthAnalyticsSettings`", "location": "path", "pattern": "^organizations/[^/]+/securityHealthAnalyticsSettings$", "required": true, @@ -3331,7 +3141,7 @@ ] }, "patch": { -"description": "Updates the SecurityHealthAnalyticsCustomModule under the given name based on the given update mask. Updating the enablement state is supported on both resident and inherited modules (though resident modules cannot have an enablement state of \"inherited\"). Updating the display name and custom config of a module is supported on resident modules only.", +"description": "", "flatPath": "v1/organizations/{organizationsId}/securityHealthAnalyticsSettings/customModules/{customModulesId}", "httpMethod": "PATCH", "id": "securitycenter.organizations.securityHealthAnalyticsSettings.customModules.patch", @@ -3340,14 +3150,12 @@ ], "parameters": { "name": { -"description": "Immutable. The resource name of the custom module. Its format is \"organizations/{organization}/securityHealthAnalyticsSettings/customModules/{customModule}\", or \"folders/{folder}/securityHealthAnalyticsSettings/customModules/{customModule}\", or \"projects/{project}/securityHealthAnalyticsSettings/customModules/{customModule}\" The id {customModule} is server-generated and is not user settable. It will be a numeric id containing 1-20 digits.", "location": "path", "pattern": "^organizations/[^/]+/securityHealthAnalyticsSettings/customModules/[^/]+$", "required": true, "type": "string" }, "updateMask": { -"description": "The list of fields to be updated. The only fields that can be updated are `enablement_state` and `custom_config`. If empty or set to the wildcard value `*`, both `enablement_state` and `custom_config` are updated.", "format": "google-fieldmask", "location": "query", "type": "string" @@ -3365,7 +3173,7 @@ ] }, "simulate": { -"description": "Simulates a given SecurityHealthAnalyticsCustomModule and Resource.", +"description": "", "flatPath": "v1/organizations/{organizationsId}/securityHealthAnalyticsSettings/customModules:simulate", "httpMethod": "POST", "id": "securitycenter.organizations.securityHealthAnalyticsSettings.customModules.simulate", @@ -3374,7 +3182,6 @@ ], "parameters": { "parent": { -"description": "Required. The relative resource name of the organization, project, or folder. For more information about relative resource names, see [Relative Resource Name](https://cloud.google.com/apis/design/resource_names#relative_resource_name) Example: `organizations/{organization_id}`", "location": "path", "pattern": "^organizations/[^/]+/securityHealthAnalyticsSettings$", "required": true, @@ -3397,7 +3204,7 @@ "effectiveCustomModules": { "methods": { "get": { -"description": "Retrieves an EffectiveSecurityHealthAnalyticsCustomModule.", +"description": "", "flatPath": "v1/organizations/{organizationsId}/securityHealthAnalyticsSettings/effectiveCustomModules/{effectiveCustomModulesId}", "httpMethod": "GET", "id": "securitycenter.organizations.securityHealthAnalyticsSettings.effectiveCustomModules.get", @@ -3406,7 +3213,6 @@ ], "parameters": { "name": { -"description": "Required. Name of the effective custom module to get. Its format is `organizations/{organization}/securityHealthAnalyticsSettings/effectiveCustomModules/{customModule}`, `folders/{folder}/securityHealthAnalyticsSettings/effectiveCustomModules/{customModule}`, or `projects/{project}/securityHealthAnalyticsSettings/effectiveCustomModules/{customModule}`", "location": "path", "pattern": "^organizations/[^/]+/securityHealthAnalyticsSettings/effectiveCustomModules/[^/]+$", "required": true, @@ -3422,7 +3228,7 @@ ] }, "list": { -"description": "Returns a list of all EffectiveSecurityHealthAnalyticsCustomModules for the given parent. This includes resident modules defined at the scope of the parent, and inherited modules, inherited from CRM ancestors.", +"description": "", "flatPath": "v1/organizations/{organizationsId}/securityHealthAnalyticsSettings/effectiveCustomModules", "httpMethod": "GET", "id": "securitycenter.organizations.securityHealthAnalyticsSettings.effectiveCustomModules.list", @@ -3431,18 +3237,15 @@ ], "parameters": { "pageSize": { -"description": "The maximum number of results to return in a single response. Default is 10, minimum is 1, maximum is 1000.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { -"description": "The value returned by the last call indicating a continuation", "location": "query", "type": "string" }, "parent": { -"description": "Required. Name of parent to list effective custom modules. Its format is `organizations/{organization}/securityHealthAnalyticsSettings`, `folders/{folder}/securityHealthAnalyticsSettings`, or `projects/{project}/securityHealthAnalyticsSettings`", "location": "path", "pattern": "^organizations/[^/]+/securityHealthAnalyticsSettings$", "required": true, @@ -3464,7 +3267,7 @@ "simulations": { "methods": { "get": { -"description": "Get the simulation by name or the latest simulation for the given organization.", +"description": "", "flatPath": "v1/organizations/{organizationsId}/simulations/{simulationsId}", "httpMethod": "GET", "id": "securitycenter.organizations.simulations.get", @@ -3473,7 +3276,6 @@ ], "parameters": { "name": { -"description": "Required. The organization name or simulation name of this simulation Valid format: `organizations/{organization}/simulations/latest` `organizations/{organization}/simulations/{simulation}`", "location": "path", "pattern": "^organizations/[^/]+/simulations/[^/]+$", "required": true, @@ -3495,7 +3297,7 @@ "attackPaths": { "methods": { "list": { -"description": "Lists the attack paths for a set of simulation results or valued resources and filter.", +"description": "", "flatPath": "v1/organizations/{organizationsId}/simulations/{simulationsId}/attackExposureResults/{attackExposureResultsId}/attackPaths", "httpMethod": "GET", "id": "securitycenter.organizations.simulations.attackExposureResults.attackPaths.list", @@ -3504,23 +3306,19 @@ ], "parameters": { "filter": { -"description": "The filter expression that filters the attack path in the response. Supported fields: * `valued_resources` supports =", "location": "query", "type": "string" }, "pageSize": { -"description": "The maximum number of results to return in a single response. Default is 10, minimum is 1, maximum is 1000.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { -"description": "The value returned by the last `ListAttackPathsResponse`; indicates that this is a continuation of a prior `ListAttackPaths` call, and that the system should return the next page of data.", "location": "query", "type": "string" }, "parent": { -"description": "Required. Name of parent to list attack paths. Valid formats: `organizations/{organization}`, `organizations/{organization}/simulations/{simulation}` `organizations/{organization}/simulations/{simulation}/attackExposureResults/{attack_exposure_result_v2}` `organizations/{organization}/simulations/{simulation}/valuedResources/{valued_resource}`", "location": "path", "pattern": "^organizations/[^/]+/simulations/[^/]+/attackExposureResults/[^/]+$", "required": true, @@ -3540,7 +3338,7 @@ "valuedResources": { "methods": { "list": { -"description": "Lists the valued resources for a set of simulation results and filter.", +"description": "", "flatPath": "v1/organizations/{organizationsId}/simulations/{simulationsId}/attackExposureResults/{attackExposureResultsId}/valuedResources", "httpMethod": "GET", "id": "securitycenter.organizations.simulations.attackExposureResults.valuedResources.list", @@ -3549,28 +3347,23 @@ ], "parameters": { "filter": { -"description": "The filter expression that filters the valued resources in the response. Supported fields: * `resource_value` supports = * `resource_type` supports =", "location": "query", "type": "string" }, "orderBy": { -"description": "Optional. The fields by which to order the valued resources response. Supported fields: * `exposed_score` * `resource_value` * `resource_type` * `resource` * `display_name` Values should be a comma separated list of fields. For example: `exposed_score,resource_value`. The default sorting order is descending. To specify ascending or descending order for a field, append a ` ASC` or a ` DESC` suffix, respectively; for example: `exposed_score DESC`.", "location": "query", "type": "string" }, "pageSize": { -"description": "The maximum number of results to return in a single response. Default is 10, minimum is 1, maximum is 1000.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { -"description": "The value returned by the last `ListValuedResourcesResponse`; indicates that this is a continuation of a prior `ListValuedResources` call, and that the system should return the next page of data.", "location": "query", "type": "string" }, "parent": { -"description": "Required. Name of parent to list valued resources. Valid formats: `organizations/{organization}`, `organizations/{organization}/simulations/{simulation}` `organizations/{organization}/simulations/{simulation}/attackExposureResults/{attack_exposure_result_v2}`", "location": "path", "pattern": "^organizations/[^/]+/simulations/[^/]+/attackExposureResults/[^/]+$", "required": true, @@ -3592,7 +3385,7 @@ "attackPaths": { "methods": { "list": { -"description": "Lists the attack paths for a set of simulation results or valued resources and filter.", +"description": "", "flatPath": "v1/organizations/{organizationsId}/simulations/{simulationsId}/attackPaths", "httpMethod": "GET", "id": "securitycenter.organizations.simulations.attackPaths.list", @@ -3601,23 +3394,19 @@ ], "parameters": { "filter": { -"description": "The filter expression that filters the attack path in the response. Supported fields: * `valued_resources` supports =", "location": "query", "type": "string" }, "pageSize": { -"description": "The maximum number of results to return in a single response. Default is 10, minimum is 1, maximum is 1000.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { -"description": "The value returned by the last `ListAttackPathsResponse`; indicates that this is a continuation of a prior `ListAttackPaths` call, and that the system should return the next page of data.", "location": "query", "type": "string" }, "parent": { -"description": "Required. Name of parent to list attack paths. Valid formats: `organizations/{organization}`, `organizations/{organization}/simulations/{simulation}` `organizations/{organization}/simulations/{simulation}/attackExposureResults/{attack_exposure_result_v2}` `organizations/{organization}/simulations/{simulation}/valuedResources/{valued_resource}`", "location": "path", "pattern": "^organizations/[^/]+/simulations/[^/]+$", "required": true, @@ -3637,7 +3426,7 @@ "valuedResources": { "methods": { "get": { -"description": "Get the valued resource by name", +"description": "", "flatPath": "v1/organizations/{organizationsId}/simulations/{simulationsId}/valuedResources/{valuedResourcesId}", "httpMethod": "GET", "id": "securitycenter.organizations.simulations.valuedResources.get", @@ -3646,7 +3435,6 @@ ], "parameters": { "name": { -"description": "Required. The name of this valued resource Valid format: `organizations/{organization}/simulations/{simulation}/valuedResources/{valued_resource}`", "location": "path", "pattern": "^organizations/[^/]+/simulations/[^/]+/valuedResources/[^/]+$", "required": true, @@ -3662,7 +3450,7 @@ ] }, "list": { -"description": "Lists the valued resources for a set of simulation results and filter.", +"description": "", "flatPath": "v1/organizations/{organizationsId}/simulations/{simulationsId}/valuedResources", "httpMethod": "GET", "id": "securitycenter.organizations.simulations.valuedResources.list", @@ -3671,28 +3459,23 @@ ], "parameters": { "filter": { -"description": "The filter expression that filters the valued resources in the response. Supported fields: * `resource_value` supports = * `resource_type` supports =", "location": "query", "type": "string" }, "orderBy": { -"description": "Optional. The fields by which to order the valued resources response. Supported fields: * `exposed_score` * `resource_value` * `resource_type` * `resource` * `display_name` Values should be a comma separated list of fields. For example: `exposed_score,resource_value`. The default sorting order is descending. To specify ascending or descending order for a field, append a ` ASC` or a ` DESC` suffix, respectively; for example: `exposed_score DESC`.", "location": "query", "type": "string" }, "pageSize": { -"description": "The maximum number of results to return in a single response. Default is 10, minimum is 1, maximum is 1000.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { -"description": "The value returned by the last `ListValuedResourcesResponse`; indicates that this is a continuation of a prior `ListValuedResources` call, and that the system should return the next page of data.", "location": "query", "type": "string" }, "parent": { -"description": "Required. Name of parent to list valued resources. Valid formats: `organizations/{organization}`, `organizations/{organization}/simulations/{simulation}` `organizations/{organization}/simulations/{simulation}/attackExposureResults/{attack_exposure_result_v2}`", "location": "path", "pattern": "^organizations/[^/]+/simulations/[^/]+$", "required": true, @@ -3712,7 +3495,7 @@ "attackPaths": { "methods": { "list": { -"description": "Lists the attack paths for a set of simulation results or valued resources and filter.", +"description": "", "flatPath": "v1/organizations/{organizationsId}/simulations/{simulationsId}/valuedResources/{valuedResourcesId}/attackPaths", "httpMethod": "GET", "id": "securitycenter.organizations.simulations.valuedResources.attackPaths.list", @@ -3721,23 +3504,19 @@ ], "parameters": { "filter": { -"description": "The filter expression that filters the attack path in the response. Supported fields: * `valued_resources` supports =", "location": "query", "type": "string" }, "pageSize": { -"description": "The maximum number of results to return in a single response. Default is 10, minimum is 1, maximum is 1000.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { -"description": "The value returned by the last `ListAttackPathsResponse`; indicates that this is a continuation of a prior `ListAttackPaths` call, and that the system should return the next page of data.", "location": "query", "type": "string" }, "parent": { -"description": "Required. Name of parent to list attack paths. Valid formats: `organizations/{organization}`, `organizations/{organization}/simulations/{simulation}` `organizations/{organization}/simulations/{simulation}/attackExposureResults/{attack_exposure_result_v2}` `organizations/{organization}/simulations/{simulation}/valuedResources/{valued_resource}`", "location": "path", "pattern": "^organizations/[^/]+/simulations/[^/]+/valuedResources/[^/]+$", "required": true, @@ -3761,7 +3540,7 @@ "sources": { "methods": { "create": { -"description": "Creates a source.", +"description": "", "flatPath": "v1/organizations/{organizationsId}/sources", "httpMethod": "POST", "id": "securitycenter.organizations.sources.create", @@ -3770,7 +3549,6 @@ ], "parameters": { "parent": { -"description": "Required. Resource name of the new source's parent. Its format should be `organizations/[organization_id]`.", "location": "path", "pattern": "^organizations/[^/]+$", "required": true, @@ -3789,7 +3567,7 @@ ] }, "get": { -"description": "Gets a source.", +"description": "", "flatPath": "v1/organizations/{organizationsId}/sources/{sourcesId}", "httpMethod": "GET", "id": "securitycenter.organizations.sources.get", @@ -3798,7 +3576,6 @@ ], "parameters": { "name": { -"description": "Required. Relative resource name of the source. Its format is `organizations/[organization_id]/source/[source_id]`.", "location": "path", "pattern": "^organizations/[^/]+/sources/[^/]+$", "required": true, @@ -3814,7 +3591,7 @@ ] }, "getIamPolicy": { -"description": "Gets the access control policy on the specified Source.", +"description": "", "flatPath": "v1/organizations/{organizationsId}/sources/{sourcesId}:getIamPolicy", "httpMethod": "POST", "id": "securitycenter.organizations.sources.getIamPolicy", @@ -3823,7 +3600,6 @@ ], "parameters": { "resource": { -"description": "REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", "location": "path", "pattern": "^organizations/[^/]+/sources/[^/]+$", "required": true, @@ -3842,7 +3618,7 @@ ] }, "list": { -"description": "Lists all sources belonging to an organization.", +"description": "", "flatPath": "v1/organizations/{organizationsId}/sources", "httpMethod": "GET", "id": "securitycenter.organizations.sources.list", @@ -3851,18 +3627,15 @@ ], "parameters": { "pageSize": { -"description": "The maximum number of results to return in a single response. Default is 10, minimum is 1, maximum is 1000.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { -"description": "The value returned by the last `ListSourcesResponse`; indicates that this is a continuation of a prior `ListSources` call, and that the system should return the next page of data.", "location": "query", "type": "string" }, "parent": { -"description": "Required. Resource name of the parent of sources to list. Its format should be `organizations/[organization_id]`, `folders/[folder_id]`, or `projects/[project_id]`.", "location": "path", "pattern": "^organizations/[^/]+$", "required": true, @@ -3878,7 +3651,7 @@ ] }, "patch": { -"description": "Updates a source.", +"description": "", "flatPath": "v1/organizations/{organizationsId}/sources/{sourcesId}", "httpMethod": "PATCH", "id": "securitycenter.organizations.sources.patch", @@ -3887,14 +3660,12 @@ ], "parameters": { "name": { -"description": "The relative resource name of this source. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Example: \"organizations/{organization_id}/sources/{source_id}\"", "location": "path", "pattern": "^organizations/[^/]+/sources/[^/]+$", "required": true, "type": "string" }, "updateMask": { -"description": "The FieldMask to use when updating the source resource. If empty all mutable fields will be updated.", "format": "google-fieldmask", "location": "query", "type": "string" @@ -3912,7 +3683,7 @@ ] }, "setIamPolicy": { -"description": "Sets the access control policy on the specified Source.", +"description": "", "flatPath": "v1/organizations/{organizationsId}/sources/{sourcesId}:setIamPolicy", "httpMethod": "POST", "id": "securitycenter.organizations.sources.setIamPolicy", @@ -3921,7 +3692,6 @@ ], "parameters": { "resource": { -"description": "REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", "location": "path", "pattern": "^organizations/[^/]+/sources/[^/]+$", "required": true, @@ -3940,7 +3710,7 @@ ] }, "testIamPermissions": { -"description": "Returns the permissions that a caller has on the specified source.", +"description": "", "flatPath": "v1/organizations/{organizationsId}/sources/{sourcesId}:testIamPermissions", "httpMethod": "POST", "id": "securitycenter.organizations.sources.testIamPermissions", @@ -3949,7 +3719,6 @@ ], "parameters": { "resource": { -"description": "REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", "location": "path", "pattern": "^organizations/[^/]+/sources/[^/]+$", "required": true, @@ -3972,7 +3741,7 @@ "findings": { "methods": { "create": { -"description": "Creates a finding. The corresponding source must exist for finding creation to succeed.", +"description": "", "flatPath": "v1/organizations/{organizationsId}/sources/{sourcesId}/findings", "httpMethod": "POST", "id": "securitycenter.organizations.sources.findings.create", @@ -3981,12 +3750,10 @@ ], "parameters": { "findingId": { -"description": "Required. Unique identifier provided by the client within the parent scope. It must be alphanumeric and less than or equal to 32 characters and greater than 0 characters in length.", "location": "query", "type": "string" }, "parent": { -"description": "Required. Resource name of the new finding's parent. Its format should be `organizations/[organization_id]/sources/[source_id]`.", "location": "path", "pattern": "^organizations/[^/]+/sources/[^/]+$", "required": true, @@ -4005,7 +3772,7 @@ ] }, "group": { -"description": "Filters an organization or source's findings and groups them by their specified properties. To group across all sources provide a `-` as the source id. Example: /v1/organizations/{organization_id}/sources/-/findings, /v1/folders/{folder_id}/sources/-/findings, /v1/projects/{project_id}/sources/-/findings", +"description": "", "flatPath": "v1/organizations/{organizationsId}/sources/{sourcesId}/findings:group", "httpMethod": "POST", "id": "securitycenter.organizations.sources.findings.group", @@ -4014,7 +3781,6 @@ ], "parameters": { "parent": { -"description": "Required. Name of the source to groupBy. Its format is `organizations/[organization_id]/sources/[source_id]`, `folders/[folder_id]/sources/[source_id]`, or `projects/[project_id]/sources/[source_id]`. To groupBy across all sources provide a source_id of `-`. For example: `organizations/{organization_id}/sources/-, folders/{folder_id}/sources/-`, or `projects/{project_id}/sources/-`", "location": "path", "pattern": "^organizations/[^/]+/sources/[^/]+$", "required": true, @@ -4033,7 +3799,7 @@ ] }, "list": { -"description": "Lists an organization or source's findings. To list across all sources provide a `-` as the source id. Example: /v1/organizations/{organization_id}/sources/-/findings", +"description": "", "flatPath": "v1/organizations/{organizationsId}/sources/{sourcesId}/findings", "httpMethod": "GET", "id": "securitycenter.organizations.sources.findings.list", @@ -4043,40 +3809,33 @@ "parameters": { "compareDuration": { "deprecated": true, -"description": "When compare_duration is set, the ListFindingsResult's \"state_change\" attribute is updated to indicate whether the finding had its state changed, the finding's state remained unchanged, or if the finding was added in any state during the compare_duration period of time that precedes the read_time. This is the time between (read_time - compare_duration) and read_time. The state_change value is derived based on the presence and state of the finding at the two points in time. Intermediate state changes between the two times don't affect the result. For example, the results aren't affected if the finding is made inactive and then active again. Possible \"state_change\" values when compare_duration is specified: * \"CHANGED\": indicates that the finding was present and matched the given filter at the start of compare_duration, but changed its state at read_time. * \"UNCHANGED\": indicates that the finding was present and matched the given filter at the start of compare_duration and did not change state at read_time. * \"ADDED\": indicates that the finding did not match the given filter or was not present at the start of compare_duration, but was present at read_time. * \"REMOVED\": indicates that the finding was present and matched the filter at the start of compare_duration, but did not match the filter at read_time. If compare_duration is not specified, then the only possible state_change is \"UNUSED\", which will be the state_change set for all findings present at read_time.", "format": "google-duration", "location": "query", "type": "string" }, "fieldMask": { -"description": "A field mask to specify the Finding fields to be listed in the response. An empty field mask will list all fields.", "format": "google-fieldmask", "location": "query", "type": "string" }, "filter": { -"description": "Expression that defines the filter to apply across findings. The expression is a list of one or more restrictions combined via logical operators `AND` and `OR`. Parentheses are supported, and `OR` has higher precedence than `AND`. Restrictions have the form ` ` and may have a `-` character in front of them to indicate negation. Examples include: * name * source_properties.a_property * security_marks.marks.marka The supported operators are: * `=` for all value types. * `>`, `<`, `>=`, `<=` for integer values. * `:`, meaning substring matching, for strings. The supported value types are: * string literals in quotes. * integer literals without quotes. * boolean literals `true` and `false` without quotes. The following field and operator combinations are supported: * name: `=` * parent: `=`, `:` * resource_name: `=`, `:` * state: `=`, `:` * category: `=`, `:` * external_uri: `=`, `:` * event_time: `=`, `>`, `<`, `>=`, `<=` Usage: This should be milliseconds since epoch or an RFC3339 string. Examples: `event_time = \"2019-06-10T16:07:18-07:00\"` `event_time = 1560208038000` * severity: `=`, `:` * workflow_state: `=`, `:` * security_marks.marks: `=`, `:` * source_properties: `=`, `:`, `>`, `<`, `>=`, `<=` For example, `source_properties.size = 100` is a valid filter string. Use a partial match on the empty string to filter based on a property existing: `source_properties.my_property : \"\"` Use a negated partial match on the empty string to filter based on a property not existing: `-source_properties.my_property : \"\"` * resource: * resource.name: `=`, `:` * resource.parent_name: `=`, `:` * resource.parent_display_name: `=`, `:` * resource.project_name: `=`, `:` * resource.project_display_name: `=`, `:` * resource.type: `=`, `:` * resource.folders.resource_folder: `=`, `:` * resource.display_name: `=`, `:`", "location": "query", "type": "string" }, "orderBy": { -"description": "Expression that defines what fields and order to use for sorting. The string value should follow SQL syntax: comma separated list of fields. For example: \"name,resource_properties.a_property\". The default sorting order is ascending. To specify descending order for a field, a suffix \" desc\" should be appended to the field name. For example: \"name desc,source_properties.a_property\". Redundant space characters in the syntax are insignificant. \"name desc,source_properties.a_property\" and \" name desc , source_properties.a_property \" are equivalent. The following fields are supported: name parent state category resource_name event_time source_properties security_marks.marks", "location": "query", "type": "string" }, "pageSize": { -"description": "The maximum number of results to return in a single response. Default is 10, minimum is 1, maximum is 1000.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { -"description": "The value returned by the last `ListFindingsResponse`; indicates that this is a continuation of a prior `ListFindings` call, and that the system should return the next page of data.", "location": "query", "type": "string" }, "parent": { -"description": "Required. Name of the source the findings belong to. Its format is `organizations/[organization_id]/sources/[source_id]`, `folders/[folder_id]/sources/[source_id]`, or `projects/[project_id]/sources/[source_id]`. To list across all sources provide a source_id of `-`. For example: `organizations/{organization_id}/sources/-`, `folders/{folder_id}/sources/-` or `projects/{projects_id}/sources/-`", "location": "path", "pattern": "^organizations/[^/]+/sources/[^/]+$", "required": true, @@ -4084,7 +3843,6 @@ }, "readTime": { "deprecated": true, -"description": "Time used as a reference point when filtering findings. The filter is limited to findings existing at the supplied time and their values are those at that specific time. Absence of this field will default to the API's version of NOW.", "format": "google-datetime", "location": "query", "type": "string" @@ -4099,7 +3857,7 @@ ] }, "patch": { -"description": "Creates or updates a finding. The corresponding source must exist for a finding creation to succeed.", +"description": "", "flatPath": "v1/organizations/{organizationsId}/sources/{sourcesId}/findings/{findingsId}", "httpMethod": "PATCH", "id": "securitycenter.organizations.sources.findings.patch", @@ -4108,14 +3866,12 @@ ], "parameters": { "name": { -"description": "The [relative resource name](https://cloud.google.com/apis/design/resource_names#relative_resource_name) of the finding. Example: \"organizations/{organization_id}/sources/{source_id}/findings/{finding_id}\", \"folders/{folder_id}/sources/{source_id}/findings/{finding_id}\", \"projects/{project_id}/sources/{source_id}/findings/{finding_id}\".", "location": "path", "pattern": "^organizations/[^/]+/sources/[^/]+/findings/[^/]+$", "required": true, "type": "string" }, "updateMask": { -"description": "The FieldMask to use when updating the finding resource. This field should not be specified when creating a finding. When updating a finding, an empty mask is treated as updating all mutable fields and replacing source_properties. Individual source_properties can be added/updated by using \"source_properties.\" in the field mask.", "format": "google-fieldmask", "location": "query", "type": "string" @@ -4133,7 +3889,7 @@ ] }, "setMute": { -"description": "Updates the mute state of a finding.", +"description": "", "flatPath": "v1/organizations/{organizationsId}/sources/{sourcesId}/findings/{findingsId}:setMute", "httpMethod": "POST", "id": "securitycenter.organizations.sources.findings.setMute", @@ -4142,7 +3898,6 @@ ], "parameters": { "name": { -"description": "Required. The [relative resource name](https://cloud.google.com/apis/design/resource_names#relative_resource_name) of the finding. Example: `organizations/{organization_id}/sources/{source_id}/findings/{finding_id}`, `folders/{folder_id}/sources/{source_id}/findings/{finding_id}`, `projects/{project_id}/sources/{source_id}/findings/{finding_id}`.", "location": "path", "pattern": "^organizations/[^/]+/sources/[^/]+/findings/[^/]+$", "required": true, @@ -4161,7 +3916,7 @@ ] }, "setState": { -"description": "Updates the state of a finding.", +"description": "", "flatPath": "v1/organizations/{organizationsId}/sources/{sourcesId}/findings/{findingsId}:setState", "httpMethod": "POST", "id": "securitycenter.organizations.sources.findings.setState", @@ -4170,7 +3925,6 @@ ], "parameters": { "name": { -"description": "Required. The [relative resource name](https://cloud.google.com/apis/design/resource_names#relative_resource_name) of the finding. Example: `organizations/{organization_id}/sources/{source_id}/findings/{finding_id}`, `folders/{folder_id}/sources/{source_id}/findings/{finding_id}`, `projects/{project_id}/sources/{source_id}/findings/{finding_id}`.", "location": "path", "pattern": "^organizations/[^/]+/sources/[^/]+/findings/[^/]+$", "required": true, @@ -4189,7 +3943,7 @@ ] }, "updateSecurityMarks": { -"description": "Updates security marks.", +"description": "", "flatPath": "v1/organizations/{organizationsId}/sources/{sourcesId}/findings/{findingsId}/securityMarks", "httpMethod": "PATCH", "id": "securitycenter.organizations.sources.findings.updateSecurityMarks", @@ -4198,20 +3952,17 @@ ], "parameters": { "name": { -"description": "The relative resource name of the SecurityMarks. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Examples: \"organizations/{organization_id}/assets/{asset_id}/securityMarks\" \"organizations/{organization_id}/sources/{source_id}/findings/{finding_id}/securityMarks\".", "location": "path", "pattern": "^organizations/[^/]+/sources/[^/]+/findings/[^/]+/securityMarks$", "required": true, "type": "string" }, "startTime": { -"description": "The time at which the updated SecurityMarks take effect. If not set uses current server time. Updates will be applied to the SecurityMarks that are active immediately preceding this time. Must be earlier or equal to the server time.", "format": "google-datetime", "location": "query", "type": "string" }, "updateMask": { -"description": "The FieldMask to use when updating the security marks resource. The field mask must not contain duplicate fields. If empty or set to \"marks\", all marks will be replaced. Individual marks can be updated using \"marks.\".", "format": "google-fieldmask", "location": "query", "type": "string" @@ -4233,7 +3984,7 @@ "externalSystems": { "methods": { "patch": { -"description": "Updates external system. This is for a given finding.", +"description": "", "flatPath": "v1/organizations/{organizationsId}/sources/{sourcesId}/findings/{findingsId}/externalSystems/{externalSystemsId}", "httpMethod": "PATCH", "id": "securitycenter.organizations.sources.findings.externalSystems.patch", @@ -4242,14 +3993,12 @@ ], "parameters": { "name": { -"description": "Full resource name of the external system, for example: \"organizations/1234/sources/5678/findings/123456/externalSystems/jira\", \"folders/1234/sources/5678/findings/123456/externalSystems/jira\", \"projects/1234/sources/5678/findings/123456/externalSystems/jira\"", "location": "path", "pattern": "^organizations/[^/]+/sources/[^/]+/findings/[^/]+/externalSystems/[^/]+$", "required": true, "type": "string" }, "updateMask": { -"description": "The FieldMask to use when updating the external system resource. If empty all mutable fields will be updated.", "format": "google-fieldmask", "location": "query", "type": "string" @@ -4275,7 +4024,7 @@ "valuedResources": { "methods": { "list": { -"description": "Lists the valued resources for a set of simulation results and filter.", +"description": "", "flatPath": "v1/organizations/{organizationsId}/valuedResources", "httpMethod": "GET", "id": "securitycenter.organizations.valuedResources.list", @@ -4284,28 +4033,23 @@ ], "parameters": { "filter": { -"description": "The filter expression that filters the valued resources in the response. Supported fields: * `resource_value` supports = * `resource_type` supports =", "location": "query", "type": "string" }, "orderBy": { -"description": "Optional. The fields by which to order the valued resources response. Supported fields: * `exposed_score` * `resource_value` * `resource_type` * `resource` * `display_name` Values should be a comma separated list of fields. For example: `exposed_score,resource_value`. The default sorting order is descending. To specify ascending or descending order for a field, append a ` ASC` or a ` DESC` suffix, respectively; for example: `exposed_score DESC`.", "location": "query", "type": "string" }, "pageSize": { -"description": "The maximum number of results to return in a single response. Default is 10, minimum is 1, maximum is 1000.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { -"description": "The value returned by the last `ListValuedResourcesResponse`; indicates that this is a continuation of a prior `ListValuedResources` call, and that the system should return the next page of data.", "location": "query", "type": "string" }, "parent": { -"description": "Required. Name of parent to list valued resources. Valid formats: `organizations/{organization}`, `organizations/{organization}/simulations/{simulation}` `organizations/{organization}/simulations/{simulation}/attackExposureResults/{attack_exposure_result_v2}`", "location": "path", "pattern": "^organizations/[^/]+$", "required": true, @@ -4330,7 +4074,7 @@ "methods": { "group": { "deprecated": true, -"description": "Filters an organization's assets and groups them by their specified properties.", +"description": "", "flatPath": "v1/projects/{projectsId}/assets:group", "httpMethod": "POST", "id": "securitycenter.projects.assets.group", @@ -4339,7 +4083,6 @@ ], "parameters": { "parent": { -"description": "Required. The name of the parent to group the assets by. Its format is `organizations/[organization_id]`, `folders/[folder_id]`, or `projects/[project_id]`.", "location": "path", "pattern": "^projects/[^/]+$", "required": true, @@ -4359,7 +4102,7 @@ }, "list": { "deprecated": true, -"description": "Lists an organization's assets.", +"description": "", "flatPath": "v1/projects/{projectsId}/assets", "httpMethod": "GET", "id": "securitycenter.projects.assets.list", @@ -4368,47 +4111,39 @@ ], "parameters": { "compareDuration": { -"description": "When compare_duration is set, the ListAssetsResult's \"state_change\" attribute is updated to indicate whether the asset was added, removed, or remained present during the compare_duration period of time that precedes the read_time. This is the time between (read_time - compare_duration) and read_time. The state_change value is derived based on the presence of the asset at the two points in time. Intermediate state changes between the two times don't affect the result. For example, the results aren't affected if the asset is removed and re-created again. Possible \"state_change\" values when compare_duration is specified: * \"ADDED\": indicates that the asset was not present at the start of compare_duration, but present at read_time. * \"REMOVED\": indicates that the asset was present at the start of compare_duration, but not present at read_time. * \"ACTIVE\": indicates that the asset was present at both the start and the end of the time period defined by compare_duration and read_time. If compare_duration is not specified, then the only possible state_change is \"UNUSED\", which will be the state_change set for all assets present at read_time.", "format": "google-duration", "location": "query", "type": "string" }, "fieldMask": { -"description": "A field mask to specify the ListAssetsResult fields to be listed in the response. An empty field mask will list all fields.", "format": "google-fieldmask", "location": "query", "type": "string" }, "filter": { -"description": "Expression that defines the filter to apply across assets. The expression is a list of zero or more restrictions combined via logical operators `AND` and `OR`. Parentheses are supported, and `OR` has higher precedence than `AND`. Restrictions have the form ` ` and may have a `-` character in front of them to indicate negation. The fields map to those defined in the Asset resource. Examples include: * name * security_center_properties.resource_name * resource_properties.a_property * security_marks.marks.marka The supported operators are: * `=` for all value types. * `>`, `<`, `>=`, `<=` for integer values. * `:`, meaning substring matching, for strings. The supported value types are: * string literals in quotes. * integer literals without quotes. * boolean literals `true` and `false` without quotes. The following are the allowed field and operator combinations: * name: `=` * update_time: `=`, `>`, `<`, `>=`, `<=` Usage: This should be milliseconds since epoch or an RFC3339 string. Examples: `update_time = \"2019-06-10T16:07:18-07:00\"` `update_time = 1560208038000` * create_time: `=`, `>`, `<`, `>=`, `<=` Usage: This should be milliseconds since epoch or an RFC3339 string. Examples: `create_time = \"2019-06-10T16:07:18-07:00\"` `create_time = 1560208038000` * iam_policy.policy_blob: `=`, `:` * resource_properties: `=`, `:`, `>`, `<`, `>=`, `<=` * security_marks.marks: `=`, `:` * security_center_properties.resource_name: `=`, `:` * security_center_properties.resource_display_name: `=`, `:` * security_center_properties.resource_type: `=`, `:` * security_center_properties.resource_parent: `=`, `:` * security_center_properties.resource_parent_display_name: `=`, `:` * security_center_properties.resource_project: `=`, `:` * security_center_properties.resource_project_display_name: `=`, `:` * security_center_properties.resource_owners: `=`, `:` For example, `resource_properties.size = 100` is a valid filter string. Use a partial match on the empty string to filter based on a property existing: `resource_properties.my_property : \"\"` Use a negated partial match on the empty string to filter based on a property not existing: `-resource_properties.my_property : \"\"`", "location": "query", "type": "string" }, "orderBy": { -"description": "Expression that defines what fields and order to use for sorting. The string value should follow SQL syntax: comma separated list of fields. For example: \"name,resource_properties.a_property\". The default sorting order is ascending. To specify descending order for a field, a suffix \" desc\" should be appended to the field name. For example: \"name desc,resource_properties.a_property\". Redundant space characters in the syntax are insignificant. \"name desc,resource_properties.a_property\" and \" name desc , resource_properties.a_property \" are equivalent. The following fields are supported: name update_time resource_properties security_marks.marks security_center_properties.resource_name security_center_properties.resource_display_name security_center_properties.resource_parent security_center_properties.resource_parent_display_name security_center_properties.resource_project security_center_properties.resource_project_display_name security_center_properties.resource_type", "location": "query", "type": "string" }, "pageSize": { -"description": "The maximum number of results to return in a single response. Default is 10, minimum is 1, maximum is 1000.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { -"description": "The value returned by the last `ListAssetsResponse`; indicates that this is a continuation of a prior `ListAssets` call, and that the system should return the next page of data.", "location": "query", "type": "string" }, "parent": { -"description": "Required. The name of the parent resource that contains the assets. The value that you can specify on parent depends on the method in which you specify parent. You can specify one of the following values: `organizations/[organization_id]`, `folders/[folder_id]`, or `projects/[project_id]`.", "location": "path", "pattern": "^projects/[^/]+$", "required": true, "type": "string" }, "readTime": { -"description": "Time used as a reference point when filtering assets. The filter is limited to assets existing at the supplied time and their values are those at that specific time. Absence of this field will default to the API's version of NOW.", "format": "google-datetime", "location": "query", "type": "string" @@ -4423,7 +4158,7 @@ ] }, "updateSecurityMarks": { -"description": "Updates security marks.", +"description": "", "flatPath": "v1/projects/{projectsId}/assets/{assetsId}/securityMarks", "httpMethod": "PATCH", "id": "securitycenter.projects.assets.updateSecurityMarks", @@ -4432,20 +4167,17 @@ ], "parameters": { "name": { -"description": "The relative resource name of the SecurityMarks. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Examples: \"organizations/{organization_id}/assets/{asset_id}/securityMarks\" \"organizations/{organization_id}/sources/{source_id}/findings/{finding_id}/securityMarks\".", "location": "path", "pattern": "^projects/[^/]+/assets/[^/]+/securityMarks$", "required": true, "type": "string" }, "startTime": { -"description": "The time at which the updated SecurityMarks take effect. If not set uses current server time. Updates will be applied to the SecurityMarks that are active immediately preceding this time. Must be earlier or equal to the server time.", "format": "google-datetime", "location": "query", "type": "string" }, "updateMask": { -"description": "The FieldMask to use when updating the security marks resource. The field mask must not contain duplicate fields. If empty or set to \"marks\", all marks will be replaced. Individual marks can be updated using \"marks.\".", "format": "google-fieldmask", "location": "query", "type": "string" @@ -4467,7 +4199,7 @@ "bigQueryExports": { "methods": { "create": { -"description": "Creates a BigQuery export.", +"description": "", "flatPath": "v1/projects/{projectsId}/bigQueryExports", "httpMethod": "POST", "id": "securitycenter.projects.bigQueryExports.create", @@ -4476,12 +4208,10 @@ ], "parameters": { "bigQueryExportId": { -"description": "Required. Unique identifier provided by the client within the parent scope. It must consist of only lowercase letters, numbers, and hyphens, must start with a letter, must end with either a letter or a number, and must be 63 characters or less.", "location": "query", "type": "string" }, "parent": { -"description": "Required. The name of the parent resource of the new BigQuery export. Its format is `organizations/[organization_id]`, `folders/[folder_id]`, or `projects/[project_id]`.", "location": "path", "pattern": "^projects/[^/]+$", "required": true, @@ -4500,7 +4230,7 @@ ] }, "delete": { -"description": "Deletes an existing BigQuery export.", +"description": "", "flatPath": "v1/projects/{projectsId}/bigQueryExports/{bigQueryExportsId}", "httpMethod": "DELETE", "id": "securitycenter.projects.bigQueryExports.delete", @@ -4509,7 +4239,6 @@ ], "parameters": { "name": { -"description": "Required. The name of the BigQuery export to delete. Its format is `organizations/{organization}/bigQueryExports/{export_id}`, `folders/{folder}/bigQueryExports/{export_id}`, or `projects/{project}/bigQueryExports/{export_id}`", "location": "path", "pattern": "^projects/[^/]+/bigQueryExports/[^/]+$", "required": true, @@ -4525,7 +4254,7 @@ ] }, "get": { -"description": "Gets a BigQuery export.", +"description": "", "flatPath": "v1/projects/{projectsId}/bigQueryExports/{bigQueryExportsId}", "httpMethod": "GET", "id": "securitycenter.projects.bigQueryExports.get", @@ -4534,7 +4263,6 @@ ], "parameters": { "name": { -"description": "Required. Name of the BigQuery export to retrieve. Its format is `organizations/{organization}/bigQueryExports/{export_id}`, `folders/{folder}/bigQueryExports/{export_id}`, or `projects/{project}/bigQueryExports/{export_id}`", "location": "path", "pattern": "^projects/[^/]+/bigQueryExports/[^/]+$", "required": true, @@ -4550,7 +4278,7 @@ ] }, "list": { -"description": "Lists BigQuery exports. Note that when requesting BigQuery exports at a given level all exports under that level are also returned e.g. if requesting BigQuery exports under a folder, then all BigQuery exports immediately under the folder plus the ones created under the projects within the folder are returned.", +"description": "", "flatPath": "v1/projects/{projectsId}/bigQueryExports", "httpMethod": "GET", "id": "securitycenter.projects.bigQueryExports.list", @@ -4559,18 +4287,15 @@ ], "parameters": { "pageSize": { -"description": "The maximum number of configs to return. The service may return fewer than this value. If unspecified, at most 10 configs will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { -"description": "A page token, received from a previous `ListBigQueryExports` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListBigQueryExports` must match the call that provided the page token.", "location": "query", "type": "string" }, "parent": { -"description": "Required. The parent, which owns the collection of BigQuery exports. Its format is `organizations/[organization_id]`, `folders/[folder_id]`, `projects/[project_id]`.", "location": "path", "pattern": "^projects/[^/]+$", "required": true, @@ -4586,7 +4311,7 @@ ] }, "patch": { -"description": "Updates a BigQuery export.", +"description": "", "flatPath": "v1/projects/{projectsId}/bigQueryExports/{bigQueryExportsId}", "httpMethod": "PATCH", "id": "securitycenter.projects.bigQueryExports.patch", @@ -4595,14 +4320,12 @@ ], "parameters": { "name": { -"description": "The relative resource name of this export. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name. Example format: \"organizations/{organization_id}/bigQueryExports/{export_id}\" Example format: \"folders/{folder_id}/bigQueryExports/{export_id}\" Example format: \"projects/{project_id}/bigQueryExports/{export_id}\" This field is provided in responses, and is ignored when provided in create requests.", "location": "path", "pattern": "^projects/[^/]+/bigQueryExports/[^/]+$", "required": true, "type": "string" }, "updateMask": { -"description": "The list of fields to be updated. If empty all mutable fields will be updated.", "format": "google-fieldmask", "location": "query", "type": "string" @@ -4624,7 +4347,7 @@ "eventThreatDetectionSettings": { "methods": { "validateCustomModule": { -"description": "Validates the given Event Threat Detection custom module.", +"description": "", "flatPath": "v1/projects/{projectsId}/eventThreatDetectionSettings:validateCustomModule", "httpMethod": "POST", "id": "securitycenter.projects.eventThreatDetectionSettings.validateCustomModule", @@ -4633,7 +4356,6 @@ ], "parameters": { "parent": { -"description": "Required. Resource name of the parent to validate the Custom Module under. Its format is: * `organizations/{organization}/eventThreatDetectionSettings`. * `folders/{folder}/eventThreatDetectionSettings`. * `projects/{project}/eventThreatDetectionSettings`.", "location": "path", "pattern": "^projects/[^/]+/eventThreatDetectionSettings$", "required": true, @@ -4656,7 +4378,7 @@ "customModules": { "methods": { "create": { -"description": "Creates a resident Event Threat Detection custom module at the scope of the given Resource Manager parent, and also creates inherited custom modules for all descendants of the given parent. These modules are enabled by default.", +"description": "", "flatPath": "v1/projects/{projectsId}/eventThreatDetectionSettings/customModules", "httpMethod": "POST", "id": "securitycenter.projects.eventThreatDetectionSettings.customModules.create", @@ -4665,7 +4387,6 @@ ], "parameters": { "parent": { -"description": "Required. The new custom module's parent. Its format is: * `organizations/{organization}/eventThreatDetectionSettings`. * `folders/{folder}/eventThreatDetectionSettings`. * `projects/{project}/eventThreatDetectionSettings`.", "location": "path", "pattern": "^projects/[^/]+/eventThreatDetectionSettings$", "required": true, @@ -4684,7 +4405,7 @@ ] }, "delete": { -"description": "Deletes the specified Event Threat Detection custom module and all of its descendants in the Resource Manager hierarchy. This method is only supported for resident custom modules.", +"description": "", "flatPath": "v1/projects/{projectsId}/eventThreatDetectionSettings/customModules/{customModulesId}", "httpMethod": "DELETE", "id": "securitycenter.projects.eventThreatDetectionSettings.customModules.delete", @@ -4693,7 +4414,6 @@ ], "parameters": { "name": { -"description": "Required. Name of the custom module to delete. Its format is: * `organizations/{organization}/eventThreatDetectionSettings/customModules/{module}`. * `folders/{folder}/eventThreatDetectionSettings/customModules/{module}`. * `projects/{project}/eventThreatDetectionSettings/customModules/{module}`.", "location": "path", "pattern": "^projects/[^/]+/eventThreatDetectionSettings/customModules/[^/]+$", "required": true, @@ -4709,7 +4429,7 @@ ] }, "get": { -"description": "Gets an Event Threat Detection custom module.", +"description": "", "flatPath": "v1/projects/{projectsId}/eventThreatDetectionSettings/customModules/{customModulesId}", "httpMethod": "GET", "id": "securitycenter.projects.eventThreatDetectionSettings.customModules.get", @@ -4718,7 +4438,6 @@ ], "parameters": { "name": { -"description": "Required. Name of the custom module to get. Its format is: * `organizations/{organization}/eventThreatDetectionSettings/customModules/{module}`. * `folders/{folder}/eventThreatDetectionSettings/customModules/{module}`. * `projects/{project}/eventThreatDetectionSettings/customModules/{module}`.", "location": "path", "pattern": "^projects/[^/]+/eventThreatDetectionSettings/customModules/[^/]+$", "required": true, @@ -4734,7 +4453,7 @@ ] }, "list": { -"description": "Lists all Event Threat Detection custom modules for the given Resource Manager parent. This includes resident modules defined at the scope of the parent along with modules inherited from ancestors.", +"description": "", "flatPath": "v1/projects/{projectsId}/eventThreatDetectionSettings/customModules", "httpMethod": "GET", "id": "securitycenter.projects.eventThreatDetectionSettings.customModules.list", @@ -4743,18 +4462,15 @@ ], "parameters": { "pageSize": { -"description": "The maximum number of modules to return. The service may return fewer than this value. If unspecified, at most 10 configs will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { -"description": "A page token, received from a previous `ListEventThreatDetectionCustomModules` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListEventThreatDetectionCustomModules` must match the call that provided the page token.", "location": "query", "type": "string" }, "parent": { -"description": "Required. Name of the parent to list custom modules under. Its format is: * `organizations/{organization}/eventThreatDetectionSettings`. * `folders/{folder}/eventThreatDetectionSettings`. * `projects/{project}/eventThreatDetectionSettings`.", "location": "path", "pattern": "^projects/[^/]+/eventThreatDetectionSettings$", "required": true, @@ -4770,7 +4486,7 @@ ] }, "listDescendant": { -"description": "Lists all resident Event Threat Detection custom modules under the given Resource Manager parent and its descendants.", +"description": "", "flatPath": "v1/projects/{projectsId}/eventThreatDetectionSettings/customModules:listDescendant", "httpMethod": "GET", "id": "securitycenter.projects.eventThreatDetectionSettings.customModules.listDescendant", @@ -4779,18 +4495,15 @@ ], "parameters": { "pageSize": { -"description": "The maximum number of modules to return. The service may return fewer than this value. If unspecified, at most 10 configs will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { -"description": "A page token, received from a previous `ListDescendantEventThreatDetectionCustomModules` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListDescendantEventThreatDetectionCustomModules` must match the call that provided the page token.", "location": "query", "type": "string" }, "parent": { -"description": "Required. Name of the parent to list custom modules under. Its format is: * `organizations/{organization}/eventThreatDetectionSettings`. * `folders/{folder}/eventThreatDetectionSettings`. * `projects/{project}/eventThreatDetectionSettings`.", "location": "path", "pattern": "^projects/[^/]+/eventThreatDetectionSettings$", "required": true, @@ -4806,7 +4519,7 @@ ] }, "patch": { -"description": "Updates the Event Threat Detection custom module with the given name based on the given update mask. Updating the enablement state is supported for both resident and inherited modules (though resident modules cannot have an enablement state of \"inherited\"). Updating the display name or configuration of a module is supported for resident modules only. The type of a module cannot be changed.", +"description": "", "flatPath": "v1/projects/{projectsId}/eventThreatDetectionSettings/customModules/{customModulesId}", "httpMethod": "PATCH", "id": "securitycenter.projects.eventThreatDetectionSettings.customModules.patch", @@ -4815,14 +4528,12 @@ ], "parameters": { "name": { -"description": "Immutable. The resource name of the Event Threat Detection custom module. Its format is: * `organizations/{organization}/eventThreatDetectionSettings/customModules/{module}`. * `folders/{folder}/eventThreatDetectionSettings/customModules/{module}`. * `projects/{project}/eventThreatDetectionSettings/customModules/{module}`.", "location": "path", "pattern": "^projects/[^/]+/eventThreatDetectionSettings/customModules/[^/]+$", "required": true, "type": "string" }, "updateMask": { -"description": "The list of fields to be updated. If empty all mutable fields will be updated.", "format": "google-fieldmask", "location": "query", "type": "string" @@ -4844,7 +4555,7 @@ "effectiveCustomModules": { "methods": { "get": { -"description": "Gets an effective Event Threat Detection custom module at the given level.", +"description": "", "flatPath": "v1/projects/{projectsId}/eventThreatDetectionSettings/effectiveCustomModules/{effectiveCustomModulesId}", "httpMethod": "GET", "id": "securitycenter.projects.eventThreatDetectionSettings.effectiveCustomModules.get", @@ -4853,7 +4564,6 @@ ], "parameters": { "name": { -"description": "Required. The resource name of the effective Event Threat Detection custom module. Its format is: * `organizations/{organization}/eventThreatDetectionSettings/effectiveCustomModules/{module}`. * `folders/{folder}/eventThreatDetectionSettings/effectiveCustomModules/{module}`. * `projects/{project}/eventThreatDetectionSettings/effectiveCustomModules/{module}`.", "location": "path", "pattern": "^projects/[^/]+/eventThreatDetectionSettings/effectiveCustomModules/[^/]+$", "required": true, @@ -4869,7 +4579,7 @@ ] }, "list": { -"description": "Lists all effective Event Threat Detection custom modules for the given parent. This includes resident modules defined at the scope of the parent along with modules inherited from its ancestors.", +"description": "", "flatPath": "v1/projects/{projectsId}/eventThreatDetectionSettings/effectiveCustomModules", "httpMethod": "GET", "id": "securitycenter.projects.eventThreatDetectionSettings.effectiveCustomModules.list", @@ -4878,18 +4588,15 @@ ], "parameters": { "pageSize": { -"description": "The maximum number of modules to return. The service may return fewer than this value. If unspecified, at most 10 configs will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { -"description": "A page token, received from a previous `ListEffectiveEventThreatDetectionCustomModules` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListEffectiveEventThreatDetectionCustomModules` must match the call that provided the page token.", "location": "query", "type": "string" }, "parent": { -"description": "Required. Name of the parent to list custom modules for. Its format is: * `organizations/{organization}/eventThreatDetectionSettings`. * `folders/{folder}/eventThreatDetectionSettings`. * `projects/{project}/eventThreatDetectionSettings`.", "location": "path", "pattern": "^projects/[^/]+/eventThreatDetectionSettings$", "required": true, @@ -4911,7 +4618,7 @@ "findings": { "methods": { "bulkMute": { -"description": "Kicks off an LRO to bulk mute findings for a parent based on a filter. The parent can be either an organization, folder or project. The findings matched by the filter will be muted after the LRO is done.", +"description": "", "flatPath": "v1/projects/{projectsId}/findings:bulkMute", "httpMethod": "POST", "id": "securitycenter.projects.findings.bulkMute", @@ -4920,7 +4627,6 @@ ], "parameters": { "parent": { -"description": "Required. The parent, at which bulk action needs to be applied. Its format is `organizations/[organization_id]`, `folders/[folder_id]`, `projects/[project_id]`.", "location": "path", "pattern": "^projects/[^/]+$", "required": true, @@ -4945,7 +4651,7 @@ "muteConfigs": { "methods": { "delete": { -"description": "Deletes an existing mute config.", +"description": "", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/muteConfigs/{muteConfigsId}", "httpMethod": "DELETE", "id": "securitycenter.projects.locations.muteConfigs.delete", @@ -4954,7 +4660,6 @@ ], "parameters": { "name": { -"description": "Required. Name of the mute config to delete. Its format is `organizations/{organization}/muteConfigs/{config_id}`, `folders/{folder}/muteConfigs/{config_id}`, `projects/{project}/muteConfigs/{config_id}`, `organizations/{organization}/locations/global/muteConfigs/{config_id}`, `folders/{folder}/locations/global/muteConfigs/{config_id}`, or `projects/{project}/locations/global/muteConfigs/{config_id}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/muteConfigs/[^/]+$", "required": true, @@ -4970,7 +4675,7 @@ ] }, "get": { -"description": "Gets a mute config.", +"description": "", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/muteConfigs/{muteConfigsId}", "httpMethod": "GET", "id": "securitycenter.projects.locations.muteConfigs.get", @@ -4979,7 +4684,6 @@ ], "parameters": { "name": { -"description": "Required. Name of the mute config to retrieve. Its format is `organizations/{organization}/muteConfigs/{config_id}`, `folders/{folder}/muteConfigs/{config_id}`, `projects/{project}/muteConfigs/{config_id}`, `organizations/{organization}/locations/global/muteConfigs/{config_id}`, `folders/{folder}/locations/global/muteConfigs/{config_id}`, or `projects/{project}/locations/global/muteConfigs/{config_id}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/muteConfigs/[^/]+$", "required": true, @@ -4995,7 +4699,7 @@ ] }, "patch": { -"description": "Updates a mute config.", +"description": "", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/muteConfigs/{muteConfigsId}", "httpMethod": "PATCH", "id": "securitycenter.projects.locations.muteConfigs.patch", @@ -5004,14 +4708,12 @@ ], "parameters": { "name": { -"description": "This field will be ignored if provided on config creation. Format `organizations/{organization}/muteConfigs/{mute_config}` `folders/{folder}/muteConfigs/{mute_config}` `projects/{project}/muteConfigs/{mute_config}` `organizations/{organization}/locations/global/muteConfigs/{mute_config}` `folders/{folder}/locations/global/muteConfigs/{mute_config}` `projects/{project}/locations/global/muteConfigs/{mute_config}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/muteConfigs/[^/]+$", "required": true, "type": "string" }, "updateMask": { -"description": "The list of fields to be updated. If empty all mutable fields will be updated.", "format": "google-fieldmask", "location": "query", "type": "string" @@ -5035,7 +4737,7 @@ "muteConfigs": { "methods": { "create": { -"description": "Creates a mute config.", +"description": "", "flatPath": "v1/projects/{projectsId}/muteConfigs", "httpMethod": "POST", "id": "securitycenter.projects.muteConfigs.create", @@ -5044,12 +4746,10 @@ ], "parameters": { "muteConfigId": { -"description": "Required. Unique identifier provided by the client within the parent scope. It must consist of only lowercase letters, numbers, and hyphens, must start with a letter, must end with either a letter or a number, and must be 63 characters or less.", "location": "query", "type": "string" }, "parent": { -"description": "Required. Resource name of the new mute configs's parent. Its format is `organizations/[organization_id]`, `folders/[folder_id]`, or `projects/[project_id]`.", "location": "path", "pattern": "^projects/[^/]+$", "required": true, @@ -5068,7 +4768,7 @@ ] }, "delete": { -"description": "Deletes an existing mute config.", +"description": "", "flatPath": "v1/projects/{projectsId}/muteConfigs/{muteConfigsId}", "httpMethod": "DELETE", "id": "securitycenter.projects.muteConfigs.delete", @@ -5077,7 +4777,6 @@ ], "parameters": { "name": { -"description": "Required. Name of the mute config to delete. Its format is `organizations/{organization}/muteConfigs/{config_id}`, `folders/{folder}/muteConfigs/{config_id}`, `projects/{project}/muteConfigs/{config_id}`, `organizations/{organization}/locations/global/muteConfigs/{config_id}`, `folders/{folder}/locations/global/muteConfigs/{config_id}`, or `projects/{project}/locations/global/muteConfigs/{config_id}`.", "location": "path", "pattern": "^projects/[^/]+/muteConfigs/[^/]+$", "required": true, @@ -5093,7 +4792,7 @@ ] }, "get": { -"description": "Gets a mute config.", +"description": "", "flatPath": "v1/projects/{projectsId}/muteConfigs/{muteConfigsId}", "httpMethod": "GET", "id": "securitycenter.projects.muteConfigs.get", @@ -5102,7 +4801,6 @@ ], "parameters": { "name": { -"description": "Required. Name of the mute config to retrieve. Its format is `organizations/{organization}/muteConfigs/{config_id}`, `folders/{folder}/muteConfigs/{config_id}`, `projects/{project}/muteConfigs/{config_id}`, `organizations/{organization}/locations/global/muteConfigs/{config_id}`, `folders/{folder}/locations/global/muteConfigs/{config_id}`, or `projects/{project}/locations/global/muteConfigs/{config_id}`.", "location": "path", "pattern": "^projects/[^/]+/muteConfigs/[^/]+$", "required": true, @@ -5118,7 +4816,7 @@ ] }, "list": { -"description": "Lists mute configs.", +"description": "", "flatPath": "v1/projects/{projectsId}/muteConfigs", "httpMethod": "GET", "id": "securitycenter.projects.muteConfigs.list", @@ -5127,18 +4825,15 @@ ], "parameters": { "pageSize": { -"description": "The maximum number of configs to return. The service may return fewer than this value. If unspecified, at most 10 configs will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { -"description": "A page token, received from a previous `ListMuteConfigs` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListMuteConfigs` must match the call that provided the page token.", "location": "query", "type": "string" }, "parent": { -"description": "Required. The parent, which owns the collection of mute configs. Its format is `organizations/[organization_id]`, `folders/[folder_id]`, `projects/[project_id]`.", "location": "path", "pattern": "^projects/[^/]+$", "required": true, @@ -5154,7 +4849,7 @@ ] }, "patch": { -"description": "Updates a mute config.", +"description": "", "flatPath": "v1/projects/{projectsId}/muteConfigs/{muteConfigsId}", "httpMethod": "PATCH", "id": "securitycenter.projects.muteConfigs.patch", @@ -5163,14 +4858,12 @@ ], "parameters": { "name": { -"description": "This field will be ignored if provided on config creation. Format `organizations/{organization}/muteConfigs/{mute_config}` `folders/{folder}/muteConfigs/{mute_config}` `projects/{project}/muteConfigs/{mute_config}` `organizations/{organization}/locations/global/muteConfigs/{mute_config}` `folders/{folder}/locations/global/muteConfigs/{mute_config}` `projects/{project}/locations/global/muteConfigs/{mute_config}`", "location": "path", "pattern": "^projects/[^/]+/muteConfigs/[^/]+$", "required": true, "type": "string" }, "updateMask": { -"description": "The list of fields to be updated. If empty all mutable fields will be updated.", "format": "google-fieldmask", "location": "query", "type": "string" @@ -5192,7 +4885,7 @@ "notificationConfigs": { "methods": { "create": { -"description": "Creates a notification config.", +"description": "", "flatPath": "v1/projects/{projectsId}/notificationConfigs", "httpMethod": "POST", "id": "securitycenter.projects.notificationConfigs.create", @@ -5201,12 +4894,10 @@ ], "parameters": { "configId": { -"description": "Required. Unique identifier provided by the client within the parent scope. It must be between 1 and 128 characters and contain alphanumeric characters, underscores, or hyphens only.", "location": "query", "type": "string" }, "parent": { -"description": "Required. Resource name of the new notification config's parent. Its format is `organizations/[organization_id]`, `folders/[folder_id]`, or `projects/[project_id]`.", "location": "path", "pattern": "^projects/[^/]+$", "required": true, @@ -5225,7 +4916,7 @@ ] }, "delete": { -"description": "Deletes a notification config.", +"description": "", "flatPath": "v1/projects/{projectsId}/notificationConfigs/{notificationConfigsId}", "httpMethod": "DELETE", "id": "securitycenter.projects.notificationConfigs.delete", @@ -5234,7 +4925,6 @@ ], "parameters": { "name": { -"description": "Required. Name of the notification config to delete. Its format is `organizations/[organization_id]/notificationConfigs/[config_id]`, `folders/[folder_id]/notificationConfigs/[config_id]`, or `projects/[project_id]/notificationConfigs/[config_id]`.", "location": "path", "pattern": "^projects/[^/]+/notificationConfigs/[^/]+$", "required": true, @@ -5250,7 +4940,7 @@ ] }, "get": { -"description": "Gets a notification config.", +"description": "", "flatPath": "v1/projects/{projectsId}/notificationConfigs/{notificationConfigsId}", "httpMethod": "GET", "id": "securitycenter.projects.notificationConfigs.get", @@ -5259,7 +4949,6 @@ ], "parameters": { "name": { -"description": "Required. Name of the notification config to get. Its format is `organizations/[organization_id]/notificationConfigs/[config_id]`, `folders/[folder_id]/notificationConfigs/[config_id]`, or `projects/[project_id]/notificationConfigs/[config_id]`.", "location": "path", "pattern": "^projects/[^/]+/notificationConfigs/[^/]+$", "required": true, @@ -5275,7 +4964,7 @@ ] }, "list": { -"description": "Lists notification configs.", +"description": "", "flatPath": "v1/projects/{projectsId}/notificationConfigs", "httpMethod": "GET", "id": "securitycenter.projects.notificationConfigs.list", @@ -5284,18 +4973,15 @@ ], "parameters": { "pageSize": { -"description": "The maximum number of results to return in a single response. Default is 10, minimum is 1, maximum is 1000.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { -"description": "The value returned by the last `ListNotificationConfigsResponse`; indicates that this is a continuation of a prior `ListNotificationConfigs` call, and that the system should return the next page of data.", "location": "query", "type": "string" }, "parent": { -"description": "Required. The name of the parent in which to list the notification configurations. Its format is \"organizations/[organization_id]\", \"folders/[folder_id]\", or \"projects/[project_id]\".", "location": "path", "pattern": "^projects/[^/]+$", "required": true, @@ -5311,7 +4997,7 @@ ] }, "patch": { -"description": " Updates a notification config. The following update fields are allowed: description, pubsub_topic, streaming_config.filter", +"description": "", "flatPath": "v1/projects/{projectsId}/notificationConfigs/{notificationConfigsId}", "httpMethod": "PATCH", "id": "securitycenter.projects.notificationConfigs.patch", @@ -5320,14 +5006,12 @@ ], "parameters": { "name": { -"description": "The relative resource name of this notification config. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Example: \"organizations/{organization_id}/notificationConfigs/notify_public_bucket\", \"folders/{folder_id}/notificationConfigs/notify_public_bucket\", or \"projects/{project_id}/notificationConfigs/notify_public_bucket\".", "location": "path", "pattern": "^projects/[^/]+/notificationConfigs/[^/]+$", "required": true, "type": "string" }, "updateMask": { -"description": "The FieldMask to use when updating the notification config. If empty all mutable fields will be updated.", "format": "google-fieldmask", "location": "query", "type": "string" @@ -5351,7 +5035,7 @@ "customModules": { "methods": { "create": { -"description": "Creates a resident SecurityHealthAnalyticsCustomModule at the scope of the given CRM parent, and also creates inherited SecurityHealthAnalyticsCustomModules for all CRM descendants of the given parent. These modules are enabled by default.", +"description": "", "flatPath": "v1/projects/{projectsId}/securityHealthAnalyticsSettings/customModules", "httpMethod": "POST", "id": "securitycenter.projects.securityHealthAnalyticsSettings.customModules.create", @@ -5360,7 +5044,6 @@ ], "parameters": { "parent": { -"description": "Required. Resource name of the new custom module's parent. Its format is `organizations/{organization}/securityHealthAnalyticsSettings`, `folders/{folder}/securityHealthAnalyticsSettings`, or `projects/{project}/securityHealthAnalyticsSettings`", "location": "path", "pattern": "^projects/[^/]+/securityHealthAnalyticsSettings$", "required": true, @@ -5379,7 +5062,7 @@ ] }, "delete": { -"description": "Deletes the specified SecurityHealthAnalyticsCustomModule and all of its descendants in the CRM hierarchy. This method is only supported for resident custom modules.", +"description": "", "flatPath": "v1/projects/{projectsId}/securityHealthAnalyticsSettings/customModules/{customModulesId}", "httpMethod": "DELETE", "id": "securitycenter.projects.securityHealthAnalyticsSettings.customModules.delete", @@ -5388,7 +5071,6 @@ ], "parameters": { "name": { -"description": "Required. Name of the custom module to delete. Its format is `organizations/{organization}/securityHealthAnalyticsSettings/customModules/{customModule}`, `folders/{folder}/securityHealthAnalyticsSettings/customModules/{customModule}`, or `projects/{project}/securityHealthAnalyticsSettings/customModules/{customModule}`", "location": "path", "pattern": "^projects/[^/]+/securityHealthAnalyticsSettings/customModules/[^/]+$", "required": true, @@ -5404,7 +5086,7 @@ ] }, "get": { -"description": "Retrieves a SecurityHealthAnalyticsCustomModule.", +"description": "", "flatPath": "v1/projects/{projectsId}/securityHealthAnalyticsSettings/customModules/{customModulesId}", "httpMethod": "GET", "id": "securitycenter.projects.securityHealthAnalyticsSettings.customModules.get", @@ -5413,7 +5095,6 @@ ], "parameters": { "name": { -"description": "Required. Name of the custom module to get. Its format is `organizations/{organization}/securityHealthAnalyticsSettings/customModules/{customModule}`, `folders/{folder}/securityHealthAnalyticsSettings/customModules/{customModule}`, or `projects/{project}/securityHealthAnalyticsSettings/customModules/{customModule}`", "location": "path", "pattern": "^projects/[^/]+/securityHealthAnalyticsSettings/customModules/[^/]+$", "required": true, @@ -5429,7 +5110,7 @@ ] }, "list": { -"description": "Returns a list of all SecurityHealthAnalyticsCustomModules for the given parent. This includes resident modules defined at the scope of the parent, and inherited modules, inherited from CRM ancestors.", +"description": "", "flatPath": "v1/projects/{projectsId}/securityHealthAnalyticsSettings/customModules", "httpMethod": "GET", "id": "securitycenter.projects.securityHealthAnalyticsSettings.customModules.list", @@ -5438,18 +5119,15 @@ ], "parameters": { "pageSize": { -"description": "The maximum number of results to return in a single response. Default is 10, minimum is 1, maximum is 1000.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { -"description": "The value returned by the last call indicating a continuation", "location": "query", "type": "string" }, "parent": { -"description": "Required. Name of parent to list custom modules. Its format is `organizations/{organization}/securityHealthAnalyticsSettings`, `folders/{folder}/securityHealthAnalyticsSettings`, or `projects/{project}/securityHealthAnalyticsSettings`", "location": "path", "pattern": "^projects/[^/]+/securityHealthAnalyticsSettings$", "required": true, @@ -5465,7 +5143,7 @@ ] }, "listDescendant": { -"description": "Returns a list of all resident SecurityHealthAnalyticsCustomModules under the given CRM parent and all of the parent\u2019s CRM descendants.", +"description": "", "flatPath": "v1/projects/{projectsId}/securityHealthAnalyticsSettings/customModules:listDescendant", "httpMethod": "GET", "id": "securitycenter.projects.securityHealthAnalyticsSettings.customModules.listDescendant", @@ -5474,18 +5152,15 @@ ], "parameters": { "pageSize": { -"description": "The maximum number of results to return in a single response. Default is 10, minimum is 1, maximum is 1000.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { -"description": "The value returned by the last call indicating a continuation", "location": "query", "type": "string" }, "parent": { -"description": "Required. Name of parent to list descendant custom modules. Its format is `organizations/{organization}/securityHealthAnalyticsSettings`, `folders/{folder}/securityHealthAnalyticsSettings`, or `projects/{project}/securityHealthAnalyticsSettings`", "location": "path", "pattern": "^projects/[^/]+/securityHealthAnalyticsSettings$", "required": true, @@ -5501,7 +5176,7 @@ ] }, "patch": { -"description": "Updates the SecurityHealthAnalyticsCustomModule under the given name based on the given update mask. Updating the enablement state is supported on both resident and inherited modules (though resident modules cannot have an enablement state of \"inherited\"). Updating the display name and custom config of a module is supported on resident modules only.", +"description": "", "flatPath": "v1/projects/{projectsId}/securityHealthAnalyticsSettings/customModules/{customModulesId}", "httpMethod": "PATCH", "id": "securitycenter.projects.securityHealthAnalyticsSettings.customModules.patch", @@ -5510,14 +5185,12 @@ ], "parameters": { "name": { -"description": "Immutable. The resource name of the custom module. Its format is \"organizations/{organization}/securityHealthAnalyticsSettings/customModules/{customModule}\", or \"folders/{folder}/securityHealthAnalyticsSettings/customModules/{customModule}\", or \"projects/{project}/securityHealthAnalyticsSettings/customModules/{customModule}\" The id {customModule} is server-generated and is not user settable. It will be a numeric id containing 1-20 digits.", "location": "path", "pattern": "^projects/[^/]+/securityHealthAnalyticsSettings/customModules/[^/]+$", "required": true, "type": "string" }, "updateMask": { -"description": "The list of fields to be updated. The only fields that can be updated are `enablement_state` and `custom_config`. If empty or set to the wildcard value `*`, both `enablement_state` and `custom_config` are updated.", "format": "google-fieldmask", "location": "query", "type": "string" @@ -5535,7 +5208,7 @@ ] }, "simulate": { -"description": "Simulates a given SecurityHealthAnalyticsCustomModule and Resource.", +"description": "", "flatPath": "v1/projects/{projectsId}/securityHealthAnalyticsSettings/customModules:simulate", "httpMethod": "POST", "id": "securitycenter.projects.securityHealthAnalyticsSettings.customModules.simulate", @@ -5544,7 +5217,6 @@ ], "parameters": { "parent": { -"description": "Required. The relative resource name of the organization, project, or folder. For more information about relative resource names, see [Relative Resource Name](https://cloud.google.com/apis/design/resource_names#relative_resource_name) Example: `organizations/{organization_id}`", "location": "path", "pattern": "^projects/[^/]+/securityHealthAnalyticsSettings$", "required": true, @@ -5567,7 +5239,7 @@ "effectiveCustomModules": { "methods": { "get": { -"description": "Retrieves an EffectiveSecurityHealthAnalyticsCustomModule.", +"description": "", "flatPath": "v1/projects/{projectsId}/securityHealthAnalyticsSettings/effectiveCustomModules/{effectiveCustomModulesId}", "httpMethod": "GET", "id": "securitycenter.projects.securityHealthAnalyticsSettings.effectiveCustomModules.get", @@ -5576,7 +5248,6 @@ ], "parameters": { "name": { -"description": "Required. Name of the effective custom module to get. Its format is `organizations/{organization}/securityHealthAnalyticsSettings/effectiveCustomModules/{customModule}`, `folders/{folder}/securityHealthAnalyticsSettings/effectiveCustomModules/{customModule}`, or `projects/{project}/securityHealthAnalyticsSettings/effectiveCustomModules/{customModule}`", "location": "path", "pattern": "^projects/[^/]+/securityHealthAnalyticsSettings/effectiveCustomModules/[^/]+$", "required": true, @@ -5592,7 +5263,7 @@ ] }, "list": { -"description": "Returns a list of all EffectiveSecurityHealthAnalyticsCustomModules for the given parent. This includes resident modules defined at the scope of the parent, and inherited modules, inherited from CRM ancestors.", +"description": "", "flatPath": "v1/projects/{projectsId}/securityHealthAnalyticsSettings/effectiveCustomModules", "httpMethod": "GET", "id": "securitycenter.projects.securityHealthAnalyticsSettings.effectiveCustomModules.list", @@ -5601,18 +5272,15 @@ ], "parameters": { "pageSize": { -"description": "The maximum number of results to return in a single response. Default is 10, minimum is 1, maximum is 1000.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { -"description": "The value returned by the last call indicating a continuation", "location": "query", "type": "string" }, "parent": { -"description": "Required. Name of parent to list effective custom modules. Its format is `organizations/{organization}/securityHealthAnalyticsSettings`, `folders/{folder}/securityHealthAnalyticsSettings`, or `projects/{project}/securityHealthAnalyticsSettings`", "location": "path", "pattern": "^projects/[^/]+/securityHealthAnalyticsSettings$", "required": true, @@ -5634,7 +5302,7 @@ "sources": { "methods": { "list": { -"description": "Lists all sources belonging to an organization.", +"description": "", "flatPath": "v1/projects/{projectsId}/sources", "httpMethod": "GET", "id": "securitycenter.projects.sources.list", @@ -5643,18 +5311,15 @@ ], "parameters": { "pageSize": { -"description": "The maximum number of results to return in a single response. Default is 10, minimum is 1, maximum is 1000.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { -"description": "The value returned by the last `ListSourcesResponse`; indicates that this is a continuation of a prior `ListSources` call, and that the system should return the next page of data.", "location": "query", "type": "string" }, "parent": { -"description": "Required. Resource name of the parent of sources to list. Its format should be `organizations/[organization_id]`, `folders/[folder_id]`, or `projects/[project_id]`.", "location": "path", "pattern": "^projects/[^/]+$", "required": true, @@ -5674,7 +5339,7 @@ "findings": { "methods": { "group": { -"description": "Filters an organization or source's findings and groups them by their specified properties. To group across all sources provide a `-` as the source id. Example: /v1/organizations/{organization_id}/sources/-/findings, /v1/folders/{folder_id}/sources/-/findings, /v1/projects/{project_id}/sources/-/findings", +"description": "", "flatPath": "v1/projects/{projectsId}/sources/{sourcesId}/findings:group", "httpMethod": "POST", "id": "securitycenter.projects.sources.findings.group", @@ -5683,7 +5348,6 @@ ], "parameters": { "parent": { -"description": "Required. Name of the source to groupBy. Its format is `organizations/[organization_id]/sources/[source_id]`, `folders/[folder_id]/sources/[source_id]`, or `projects/[project_id]/sources/[source_id]`. To groupBy across all sources provide a source_id of `-`. For example: `organizations/{organization_id}/sources/-, folders/{folder_id}/sources/-`, or `projects/{project_id}/sources/-`", "location": "path", "pattern": "^projects/[^/]+/sources/[^/]+$", "required": true, @@ -5702,7 +5366,7 @@ ] }, "list": { -"description": "Lists an organization or source's findings. To list across all sources provide a `-` as the source id. Example: /v1/organizations/{organization_id}/sources/-/findings", +"description": "", "flatPath": "v1/projects/{projectsId}/sources/{sourcesId}/findings", "httpMethod": "GET", "id": "securitycenter.projects.sources.findings.list", @@ -5712,40 +5376,33 @@ "parameters": { "compareDuration": { "deprecated": true, -"description": "When compare_duration is set, the ListFindingsResult's \"state_change\" attribute is updated to indicate whether the finding had its state changed, the finding's state remained unchanged, or if the finding was added in any state during the compare_duration period of time that precedes the read_time. This is the time between (read_time - compare_duration) and read_time. The state_change value is derived based on the presence and state of the finding at the two points in time. Intermediate state changes between the two times don't affect the result. For example, the results aren't affected if the finding is made inactive and then active again. Possible \"state_change\" values when compare_duration is specified: * \"CHANGED\": indicates that the finding was present and matched the given filter at the start of compare_duration, but changed its state at read_time. * \"UNCHANGED\": indicates that the finding was present and matched the given filter at the start of compare_duration and did not change state at read_time. * \"ADDED\": indicates that the finding did not match the given filter or was not present at the start of compare_duration, but was present at read_time. * \"REMOVED\": indicates that the finding was present and matched the filter at the start of compare_duration, but did not match the filter at read_time. If compare_duration is not specified, then the only possible state_change is \"UNUSED\", which will be the state_change set for all findings present at read_time.", "format": "google-duration", "location": "query", "type": "string" }, "fieldMask": { -"description": "A field mask to specify the Finding fields to be listed in the response. An empty field mask will list all fields.", "format": "google-fieldmask", "location": "query", "type": "string" }, "filter": { -"description": "Expression that defines the filter to apply across findings. The expression is a list of one or more restrictions combined via logical operators `AND` and `OR`. Parentheses are supported, and `OR` has higher precedence than `AND`. Restrictions have the form ` ` and may have a `-` character in front of them to indicate negation. Examples include: * name * source_properties.a_property * security_marks.marks.marka The supported operators are: * `=` for all value types. * `>`, `<`, `>=`, `<=` for integer values. * `:`, meaning substring matching, for strings. The supported value types are: * string literals in quotes. * integer literals without quotes. * boolean literals `true` and `false` without quotes. The following field and operator combinations are supported: * name: `=` * parent: `=`, `:` * resource_name: `=`, `:` * state: `=`, `:` * category: `=`, `:` * external_uri: `=`, `:` * event_time: `=`, `>`, `<`, `>=`, `<=` Usage: This should be milliseconds since epoch or an RFC3339 string. Examples: `event_time = \"2019-06-10T16:07:18-07:00\"` `event_time = 1560208038000` * severity: `=`, `:` * workflow_state: `=`, `:` * security_marks.marks: `=`, `:` * source_properties: `=`, `:`, `>`, `<`, `>=`, `<=` For example, `source_properties.size = 100` is a valid filter string. Use a partial match on the empty string to filter based on a property existing: `source_properties.my_property : \"\"` Use a negated partial match on the empty string to filter based on a property not existing: `-source_properties.my_property : \"\"` * resource: * resource.name: `=`, `:` * resource.parent_name: `=`, `:` * resource.parent_display_name: `=`, `:` * resource.project_name: `=`, `:` * resource.project_display_name: `=`, `:` * resource.type: `=`, `:` * resource.folders.resource_folder: `=`, `:` * resource.display_name: `=`, `:`", "location": "query", "type": "string" }, "orderBy": { -"description": "Expression that defines what fields and order to use for sorting. The string value should follow SQL syntax: comma separated list of fields. For example: \"name,resource_properties.a_property\". The default sorting order is ascending. To specify descending order for a field, a suffix \" desc\" should be appended to the field name. For example: \"name desc,source_properties.a_property\". Redundant space characters in the syntax are insignificant. \"name desc,source_properties.a_property\" and \" name desc , source_properties.a_property \" are equivalent. The following fields are supported: name parent state category resource_name event_time source_properties security_marks.marks", "location": "query", "type": "string" }, "pageSize": { -"description": "The maximum number of results to return in a single response. Default is 10, minimum is 1, maximum is 1000.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { -"description": "The value returned by the last `ListFindingsResponse`; indicates that this is a continuation of a prior `ListFindings` call, and that the system should return the next page of data.", "location": "query", "type": "string" }, "parent": { -"description": "Required. Name of the source the findings belong to. Its format is `organizations/[organization_id]/sources/[source_id]`, `folders/[folder_id]/sources/[source_id]`, or `projects/[project_id]/sources/[source_id]`. To list across all sources provide a source_id of `-`. For example: `organizations/{organization_id}/sources/-`, `folders/{folder_id}/sources/-` or `projects/{projects_id}/sources/-`", "location": "path", "pattern": "^projects/[^/]+/sources/[^/]+$", "required": true, @@ -5753,7 +5410,6 @@ }, "readTime": { "deprecated": true, -"description": "Time used as a reference point when filtering findings. The filter is limited to findings existing at the supplied time and their values are those at that specific time. Absence of this field will default to the API's version of NOW.", "format": "google-datetime", "location": "query", "type": "string" @@ -5768,7 +5424,7 @@ ] }, "patch": { -"description": "Creates or updates a finding. The corresponding source must exist for a finding creation to succeed.", +"description": "", "flatPath": "v1/projects/{projectsId}/sources/{sourcesId}/findings/{findingsId}", "httpMethod": "PATCH", "id": "securitycenter.projects.sources.findings.patch", @@ -5777,14 +5433,12 @@ ], "parameters": { "name": { -"description": "The [relative resource name](https://cloud.google.com/apis/design/resource_names#relative_resource_name) of the finding. Example: \"organizations/{organization_id}/sources/{source_id}/findings/{finding_id}\", \"folders/{folder_id}/sources/{source_id}/findings/{finding_id}\", \"projects/{project_id}/sources/{source_id}/findings/{finding_id}\".", "location": "path", "pattern": "^projects/[^/]+/sources/[^/]+/findings/[^/]+$", "required": true, "type": "string" }, "updateMask": { -"description": "The FieldMask to use when updating the finding resource. This field should not be specified when creating a finding. When updating a finding, an empty mask is treated as updating all mutable fields and replacing source_properties. Individual source_properties can be added/updated by using \"source_properties.\" in the field mask.", "format": "google-fieldmask", "location": "query", "type": "string" @@ -5802,7 +5456,7 @@ ] }, "setMute": { -"description": "Updates the mute state of a finding.", +"description": "", "flatPath": "v1/projects/{projectsId}/sources/{sourcesId}/findings/{findingsId}:setMute", "httpMethod": "POST", "id": "securitycenter.projects.sources.findings.setMute", @@ -5811,7 +5465,6 @@ ], "parameters": { "name": { -"description": "Required. The [relative resource name](https://cloud.google.com/apis/design/resource_names#relative_resource_name) of the finding. Example: `organizations/{organization_id}/sources/{source_id}/findings/{finding_id}`, `folders/{folder_id}/sources/{source_id}/findings/{finding_id}`, `projects/{project_id}/sources/{source_id}/findings/{finding_id}`.", "location": "path", "pattern": "^projects/[^/]+/sources/[^/]+/findings/[^/]+$", "required": true, @@ -5830,7 +5483,7 @@ ] }, "setState": { -"description": "Updates the state of a finding.", +"description": "", "flatPath": "v1/projects/{projectsId}/sources/{sourcesId}/findings/{findingsId}:setState", "httpMethod": "POST", "id": "securitycenter.projects.sources.findings.setState", @@ -5839,7 +5492,6 @@ ], "parameters": { "name": { -"description": "Required. The [relative resource name](https://cloud.google.com/apis/design/resource_names#relative_resource_name) of the finding. Example: `organizations/{organization_id}/sources/{source_id}/findings/{finding_id}`, `folders/{folder_id}/sources/{source_id}/findings/{finding_id}`, `projects/{project_id}/sources/{source_id}/findings/{finding_id}`.", "location": "path", "pattern": "^projects/[^/]+/sources/[^/]+/findings/[^/]+$", "required": true, @@ -5858,7 +5510,7 @@ ] }, "updateSecurityMarks": { -"description": "Updates security marks.", +"description": "", "flatPath": "v1/projects/{projectsId}/sources/{sourcesId}/findings/{findingsId}/securityMarks", "httpMethod": "PATCH", "id": "securitycenter.projects.sources.findings.updateSecurityMarks", @@ -5867,20 +5519,17 @@ ], "parameters": { "name": { -"description": "The relative resource name of the SecurityMarks. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Examples: \"organizations/{organization_id}/assets/{asset_id}/securityMarks\" \"organizations/{organization_id}/sources/{source_id}/findings/{finding_id}/securityMarks\".", "location": "path", "pattern": "^projects/[^/]+/sources/[^/]+/findings/[^/]+/securityMarks$", "required": true, "type": "string" }, "startTime": { -"description": "The time at which the updated SecurityMarks take effect. If not set uses current server time. Updates will be applied to the SecurityMarks that are active immediately preceding this time. Must be earlier or equal to the server time.", "format": "google-datetime", "location": "query", "type": "string" }, "updateMask": { -"description": "The FieldMask to use when updating the security marks resource. The field mask must not contain duplicate fields. If empty or set to \"marks\", all marks will be replaced. Individual marks can be updated using \"marks.\".", "format": "google-fieldmask", "location": "query", "type": "string" @@ -5902,7 +5551,7 @@ "externalSystems": { "methods": { "patch": { -"description": "Updates external system. This is for a given finding.", +"description": "", "flatPath": "v1/projects/{projectsId}/sources/{sourcesId}/findings/{findingsId}/externalSystems/{externalSystemsId}", "httpMethod": "PATCH", "id": "securitycenter.projects.sources.findings.externalSystems.patch", @@ -5911,14 +5560,12 @@ ], "parameters": { "name": { -"description": "Full resource name of the external system, for example: \"organizations/1234/sources/5678/findings/123456/externalSystems/jira\", \"folders/1234/sources/5678/findings/123456/externalSystems/jira\", \"projects/1234/sources/5678/findings/123456/externalSystems/jira\"", "location": "path", "pattern": "^projects/[^/]+/sources/[^/]+/findings/[^/]+/externalSystems/[^/]+$", "required": true, "type": "string" }, "updateMask": { -"description": "The FieldMask to use when updating the external system resource. If empty all mutable fields will be updated.", "format": "google-fieldmask", "location": "query", "type": "string" @@ -5944,104 +5591,82 @@ } } }, -"revision": "20260424", +"revision": "20260526", "rootUrl": "https://securitycenter.googleapis.com/", "schemas": { "Access": { -"description": "Represents an access event.", "id": "Access", "properties": { "callerIp": { -"description": "Caller's IP address, such as \"1.1.1.1\".", "type": "string" }, "callerIpGeo": { -"$ref": "Geolocation", -"description": "The caller IP's geolocation, which identifies where the call came from." +"$ref": "Geolocation" }, "methodName": { -"description": "The method that the service account called, e.g. \"SetIamPolicy\".", "type": "string" }, "principalEmail": { -"description": "Associated email, such as \"foo@google.com\". The email address of the authenticated user or a service account acting on behalf of a 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" }, "principalSubject": { -"description": "A string that represents the principal_subject that is associated with the identity. Unlike `principal_email`, `principal_subject` supports principals that aren't associated with email addresses, such as third party principals. For most identities, the format is `principal://iam.googleapis.com/{identity pool name}/subject/{subject}`. Some GKE identities, such as GKE_WORKLOAD, FREEFORM, and GKE_HUB_WORKLOAD, still use the legacy format `serviceAccount:{identity pool name}[{subject}]`.", "type": "string" }, "serviceAccountDelegationInfo": { -"description": "The identity delegation history of an authenticated service account that made the request. The `serviceAccountDelegationInfo[]` object contains information about the real authorities that try to access Google Cloud resources by delegating on a service account. When multiple authorities are present, they are guaranteed to be sorted based on the original ordering of the identity delegation events.", "items": { "$ref": "ServiceAccountDelegationInfo" }, "type": "array" }, "serviceAccountKeyName": { -"description": "The name of the service account key that was used to create or exchange credentials when authenticating the service account that made the request. This is a scheme-less URI full resource name. For example: \"//iam.googleapis.com/projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}/keys/{key}\". ", "type": "string" }, "serviceName": { -"description": "This is the API service that the service account made a call to, e.g. \"iam.googleapis.com\"", "type": "string" }, "userAgent": { -"description": "The caller's user agent string associated with the finding.", "type": "string" }, "userAgentFamily": { -"description": "Type of user agent associated with the finding. For example, an operating system shell or an embedded or standalone application.", "type": "string" }, "userName": { -"description": "A string that represents a username. The username provided depends on the type of the finding and is likely not an IAM principal. For example, this can be a system username if the finding is related to a virtual machine, or it can be an application login username.", "type": "string" } }, "type": "object" }, "AccessReview": { -"description": "Conveys information about a Kubernetes access review (such as one returned by a [`kubectl auth can-i`](https://kubernetes.io/docs/reference/access-authn-authz/authorization/#checking-api-access) command) that was involved in a finding.", "id": "AccessReview", "properties": { "group": { -"description": "The API group of the resource. \"*\" means all.", "type": "string" }, "name": { -"description": "The name of the resource being requested. Empty means all.", "type": "string" }, "ns": { -"description": "Namespace of the action being requested. Currently, there is no distinction between no namespace and all namespaces. Both are represented by \"\" (empty).", "type": "string" }, "resource": { -"description": "The optional resource type requested. \"*\" means all.", "type": "string" }, "subresource": { -"description": "The optional subresource type.", "type": "string" }, "verb": { -"description": "A Kubernetes resource API verb, like get, list, watch, create, update, delete, proxy. \"*\" means all.", "type": "string" }, "version": { -"description": "The API version of the resource. \"*\" means all.", "type": "string" } }, "type": "object" }, "AdaptiveProtection": { -"description": "Information about [Google Cloud Armor Adaptive Protection](https://cloud.google.com/armor/docs/cloud-armor-overview#google-cloud-armor-adaptive-protection).", "id": "AdaptiveProtection", "properties": { "confidence": { -"description": "A score of 0 means that there is low confidence that the detected event is an actual attack. A score of 1 means that there is high confidence that the detected event is an attack. See the [Adaptive Protection documentation](https://cloud.google.com/armor/docs/adaptive-protection-overview#configure-alert-tuning) for further explanation.", "format": "double", "type": "number" } @@ -6049,48 +5674,39 @@ "type": "object" }, "AdcApplication": { -"description": "Represents an ADC application associated with the finding.", "id": "AdcApplication", "properties": { "attributes": { -"$ref": "GoogleCloudSecuritycenterV1ResourceApplicationAttributes", -"description": "Consumer provided attributes for the AppHub application." +"$ref": "GoogleCloudSecuritycenterV1ResourceApplicationAttributes" }, "name": { -"description": "The resource name of an ADC Application. Format: projects/{project}/locations/{location}/spaces/{space}/applications/{application}", "type": "string" } }, "type": "object" }, "AdcApplicationTemplateRevision": { -"description": "Represents an ADC template associated with the finding.", "id": "AdcApplicationTemplateRevision", "properties": { "name": { -"description": "The resource name of an ADC Application Template Revision. Format: projects/{project}/locations/{location}/spaces/{space}/applicationTemplates/{application_template}/revisions/{revision}", "type": "string" } }, "type": "object" }, "AdcSharedTemplateRevision": { -"description": "Represents an ADC shared template associated with the finding.", "id": "AdcSharedTemplateRevision", "properties": { "name": { -"description": "The resource name of an ADC Shared Template Revision. Format: projects/{project}/locations/{location}/spaces/{space}/applicationTemplates/{application_template}/revisions/{revision}", "type": "string" } }, "type": "object" }, "AffectedResources": { -"description": "Details about resources affected by this finding.", "id": "AffectedResources", "properties": { "count": { -"description": "The count of resources affected by the finding.", "format": "int64", "type": "string" } @@ -6098,20 +5714,16 @@ "type": "object" }, "AgentDataAccessEvent": { -"description": "Details about a data access attempt made by an agent principal not authorized under applicable data security policy.", "id": "AgentDataAccessEvent", "properties": { "eventId": { -"description": "Unique identifier for data access event.", "type": "string" }, "eventTime": { -"description": "Timestamp of data access event.", "format": "google-datetime", "type": "string" }, "operation": { -"description": "The operation performed by the principal to access the data.", "enum": [ "OPERATION_UNSPECIFIED", "READ", @@ -6119,26 +5731,23 @@ "COPY" ], "enumDescriptions": [ -"The operation is unspecified.", -"Represents a read operation.", -"Represents a move operation.", -"Represents a copy operation." +"", +"", +"", +"" ], "type": "string" }, "principalSubject": { -"description": "The agent principal that accessed the data.", "type": "string" } }, "type": "object" }, "AiModel": { -"description": "Contains information about the AI model associated with the finding.", "id": "AiModel", "properties": { "deploymentPlatform": { -"description": "The platform on which the model is deployed.", "enum": [ "DEPLOYMENT_PLATFORM_UNSPECIFIED", "VERTEX_AI", @@ -6147,51 +5756,42 @@ "FINE_TUNED_MODEL" ], "enumDescriptions": [ -"Unspecified deployment platform.", -"Vertex AI.", -"Google Kubernetes Engine.", -"Google Compute Engine.", -"Fine tuned model." +"", +"", +"", +"", +"" ], "type": "string" }, "displayName": { -"description": "The user defined display name of model. Ex. baseline-classification-model", "type": "string" }, "domain": { -"description": "The domain of the model, for example, \u201cimage-classification\u201d.", "type": "string" }, "library": { -"description": "The name of the model library, for example, \u201ctransformers\u201d.", "type": "string" }, "location": { -"description": "The region in which the model is used, for example, \u201cus-central1\u201d.", "type": "string" }, "name": { -"description": "The name of the AI model, for example, \"gemini:1.0.0\".", "type": "string" }, "publisher": { -"description": "The publisher of the model, for example, \u201cgoogle\u201d or \u201cnvidia\u201d.", "type": "string" }, "usageCategory": { -"description": "The purpose of the model, for example, \"Inteference\" or \"Training\".", "type": "string" } }, "type": "object" }, "Allowed": { -"description": "Allowed IP rule.", "id": "Allowed", "properties": { "ipRules": { -"description": "Optional. Optional list of allowed IP rules.", "items": { "$ref": "IpRule" }, @@ -6201,59 +5801,49 @@ "type": "object" }, "Application": { -"description": "Represents an application associated with a finding.", "id": "Application", "properties": { "baseUri": { -"description": "The base URI that identifies the network location of the application in which the vulnerability was detected. For example, `http://example.com`.", "type": "string" }, "fullUri": { -"description": "The full URI with payload that can be used to reproduce the vulnerability. For example, `http://example.com?p=aMmYgI6H`.", "type": "string" } }, "type": "object" }, "ArtifactGuardPolicies": { -"description": "Represents the result of evaluating artifact guard policies.", "id": "ArtifactGuardPolicies", "properties": { "failingPolicies": { -"description": "A list of failing policies.", "items": { "$ref": "ArtifactGuardPolicy" }, "type": "array" }, "resourceId": { -"description": "The ID of the resource that has policies configured for it.", "type": "string" } }, "type": "object" }, "ArtifactGuardPolicy": { -"description": "Represents an artifact guard policy.", "id": "ArtifactGuardPolicy", "properties": { "failureReason": { -"description": "The reason for the policy failure, for example, \"severity=HIGH AND max_vuln_count=2\".", "type": "string" }, "policyId": { -"description": "The ID of the failing policy, for example, \"organizations/3392779/locations/global/policies/prod-policy\".", "type": "string" }, "type": { -"description": "The type of the policy evaluation.", "enum": [ "ARTIFACT_GUARD_POLICY_TYPE_UNSPECIFIED", "VULNERABILITY" ], "enumDescriptions": [ -"Default value. This value is unused.", -"Vulnerability type." +"", +"" ], "type": "string" } @@ -6261,43 +5851,34 @@ "type": "object" }, "Asset": { -"description": "Security Command Center representation of a Google Cloud resource. The Asset is a Security Command Center resource that captures information about a single Google Cloud resource. All modifications to an Asset are only within the context of Security Command Center and don't affect the referenced Google Cloud resource.", "id": "Asset", "properties": { "canonicalName": { -"description": "The canonical name of the resource. It's either \"organizations/{organization_id}/assets/{asset_id}\", \"folders/{folder_id}/assets/{asset_id}\" or \"projects/{project_number}/assets/{asset_id}\", depending on the closest CRM ancestor of the resource.", "type": "string" }, "createTime": { -"description": "The time at which the asset was created in Security Command Center.", "format": "google-datetime", "type": "string" }, "iamPolicy": { -"$ref": "IamPolicy", -"description": "Cloud IAM Policy information associated with the Google Cloud resource described by the Security Command Center asset. This information is managed and defined by the Google Cloud resource and cannot be modified by the user." +"$ref": "IamPolicy" }, "name": { -"description": "The relative resource name of this asset. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Example: \"organizations/{organization_id}/assets/{asset_id}\".", "type": "string" }, "resourceProperties": { "additionalProperties": { "type": "any" }, -"description": "Resource managed properties. These properties are managed and defined by the Google Cloud resource and cannot be modified by the user.", "type": "object" }, "securityCenterProperties": { -"$ref": "SecurityCenterProperties", -"description": "Security Command Center managed properties. These properties are managed by Security Command Center and cannot be modified by the user." +"$ref": "SecurityCenterProperties" }, "securityMarks": { -"$ref": "SecurityMarks", -"description": "User specified security marks. These marks are entirely managed by the user and come from the SecurityMarks resource that belongs to the asset." +"$ref": "SecurityMarks" }, "updateTime": { -"description": "The time at which the asset was last updated or added in Cloud SCC.", "format": "google-datetime", "type": "string" } @@ -6305,32 +5886,28 @@ "type": "object" }, "AssetDiscoveryConfig": { -"description": "The configuration used for Asset Discovery runs.", "id": "AssetDiscoveryConfig", "properties": { "folderIds": { -"description": "The folder ids to use for filtering asset discovery. It consists of only digits, e.g., 756619654966.", "items": { "type": "string" }, "type": "array" }, "inclusionMode": { -"description": "The mode to use for filtering asset discovery.", "enum": [ "INCLUSION_MODE_UNSPECIFIED", "INCLUDE_ONLY", "EXCLUDE" ], "enumDescriptions": [ -"Unspecified. Setting the mode with this value will disable inclusion/exclusion filtering for Asset Discovery.", -"Asset Discovery will capture only the resources within the projects specified. All other resources will be ignored.", -"Asset Discovery will ignore all resources under the projects specified. All other resources will be retrieved." +"", +"", +"" ], "type": "string" }, "projectIds": { -"description": "The project ids to use for filtering asset discovery.", "items": { "type": "string" }, @@ -6340,32 +5917,26 @@ "type": "object" }, "Attack": { -"description": "Information about DDoS attack volume and classification.", "id": "Attack", "properties": { "classification": { -"description": "Type of attack, for example, 'SYN-flood', 'NTP-udp', or 'CHARGEN-udp'.", "type": "string" }, "volumeBps": { "deprecated": true, -"description": "Total BPS (bytes per second) volume of attack. Deprecated - refer to volume_bps_long instead.", "format": "int32", "type": "integer" }, "volumeBpsLong": { -"description": "Total BPS (bytes per second) volume of attack.", "format": "int64", "type": "string" }, "volumePps": { "deprecated": true, -"description": "Total PPS (packets per second) volume of attack. Deprecated - refer to volume_pps_long instead.", "format": "int32", "type": "integer" }, "volumePpsLong": { -"description": "Total PPS (packets per second) volume of attack.", "format": "int64", "type": "string" } @@ -6373,49 +5944,41 @@ "type": "object" }, "AttackExposure": { -"description": "An attack exposure contains the results of an attack path simulation run.", "id": "AttackExposure", "properties": { "attackExposureResult": { -"description": "The resource name of the attack path simulation result that contains the details regarding this attack exposure score. Example: `organizations/123/simulations/456/attackExposureResults/789`", "type": "string" }, "exposedHighValueResourcesCount": { -"description": "The number of high value resources that are exposed as a result of this finding.", "format": "int32", "type": "integer" }, "exposedLowValueResourcesCount": { -"description": "The number of high value resources that are exposed as a result of this finding.", "format": "int32", "type": "integer" }, "exposedMediumValueResourcesCount": { -"description": "The number of medium value resources that are exposed as a result of this finding.", "format": "int32", "type": "integer" }, "latestCalculationTime": { -"description": "The most recent time the attack exposure was updated on this finding.", "format": "google-datetime", "type": "string" }, "score": { -"description": "A number between 0 (inclusive) and infinity that represents how important this finding is to remediate. The higher the score, the more important it is to remediate.", "format": "double", "type": "number" }, "state": { -"description": "What state this AttackExposure is in. This captures whether or not an attack exposure has been calculated or not.", "enum": [ "STATE_UNSPECIFIED", "CALCULATED", "NOT_CALCULATED" ], "enumDescriptions": [ -"The state is not specified.", -"The attack exposure has been calculated.", -"The attack exposure has not been calculated." +"", +"", +"" ], "type": "string" } @@ -6423,22 +5986,18 @@ "type": "object" }, "AttackPath": { -"description": "A path that an attacker could take to reach an exposed resource.", "id": "AttackPath", "properties": { "edges": { -"description": "A list of the edges between nodes in this attack path.", "items": { "$ref": "AttackPathEdge" }, "type": "array" }, "name": { -"description": "The attack path name, for example, `organizations/12/simulation/34/valuedResources/56/attackPaths/78`", "type": "string" }, "pathNodes": { -"description": "A list of nodes that exist in this attack path.", "items": { "$ref": "AttackPathNode" }, @@ -6448,78 +6007,63 @@ "type": "object" }, "AttackPathEdge": { -"description": "Represents a connection between a source node and a destination node in this attack path.", "id": "AttackPathEdge", "properties": { "destination": { -"description": "The attack node uuid of the destination node.", "type": "string" }, "source": { -"description": "The attack node uuid of the source node.", "type": "string" } }, "type": "object" }, "AttackPathNode": { -"description": "Represents one point that an attacker passes through in this attack path.", "id": "AttackPathNode", "properties": { "associatedFindings": { -"description": "The findings associated with this node in the attack path.", "items": { "$ref": "PathNodeAssociatedFinding" }, "type": "array" }, "attackSteps": { -"description": "A list of attack step nodes that exist in this attack path node.", "items": { "$ref": "AttackStepNode" }, "type": "array" }, "displayName": { -"description": "Human-readable name of this resource.", "type": "string" }, "resource": { -"description": "The name of the resource at this point in the attack path. The format of the name follows the Cloud Asset Inventory [resource name format](https://cloud.google.com/asset-inventory/docs/resource-name-format)", "type": "string" }, "resourceType": { -"description": "The [supported resource type](https://cloud.google.com/asset-inventory/docs/supported-asset-types)", "type": "string" }, "uuid": { -"description": "Unique id of the attack path node.", "type": "string" } }, "type": "object" }, "AttackStepNode": { -"description": "Detailed steps the attack can take between path nodes.", "id": "AttackStepNode", "properties": { "description": { -"description": "Attack step description", "type": "string" }, "displayName": { -"description": "User friendly name of the attack step", "type": "string" }, "labels": { "additionalProperties": { "type": "string" }, -"description": "Attack step labels for metadata", "type": "object" }, "type": { -"description": "Attack step type. Can be either AND, OR or DEFENSE", "enum": [ "NODE_TYPE_UNSPECIFIED", "NODE_TYPE_AND", @@ -6528,52 +6072,45 @@ "NODE_TYPE_ATTACKER" ], "enumDescriptions": [ -"Type not specified", -"Incoming edge joined with AND", -"Incoming edge joined with OR", -"Incoming edge is defense", -"Incoming edge is attacker" +"", +"", +"", +"", +"" ], "type": "string" }, "uuid": { -"description": "Unique ID for one Node", "type": "string" } }, "type": "object" }, "AuditConfig": { -"description": "Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { \"audit_configs\": [ { \"service\": \"allServices\", \"audit_log_configs\": [ { \"log_type\": \"DATA_READ\", \"exempted_members\": [ \"user:jose@example.com\" ] }, { \"log_type\": \"DATA_WRITE\" }, { \"log_type\": \"ADMIN_READ\" } ] }, { \"service\": \"sampleservice.googleapis.com\", \"audit_log_configs\": [ { \"log_type\": \"DATA_READ\" }, { \"log_type\": \"DATA_WRITE\", \"exempted_members\": [ \"user:aliya@example.com\" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging.", "id": "AuditConfig", "properties": { "auditLogConfigs": { -"description": "The configuration for logging of each type of permission.", "items": { "$ref": "AuditLogConfig" }, "type": "array" }, "service": { -"description": "Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services.", "type": "string" } }, "type": "object" }, "AuditLogConfig": { -"description": "Provides the configuration for logging a type of permissions. Example: { \"audit_log_configs\": [ { \"log_type\": \"DATA_READ\", \"exempted_members\": [ \"user:jose@example.com\" ] }, { \"log_type\": \"DATA_WRITE\" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.", "id": "AuditLogConfig", "properties": { "exemptedMembers": { -"description": "Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.", "items": { "type": "string" }, "type": "array" }, "logType": { -"description": "The log type that this config enables.", "enum": [ "LOG_TYPE_UNSPECIFIED", "ADMIN_READ", @@ -6581,10 +6118,10 @@ "DATA_READ" ], "enumDescriptions": [ -"Default case. Should never be this.", -"Admin reads. Example: CloudIAM getIamPolicy", -"Data writes. Example: CloudSQL Users create", -"Data reads. Example: CloudSQL Users list" +"", +"", +"", +"" ], "type": "string" } @@ -6592,34 +6129,27 @@ "type": "object" }, "AwsAccount": { -"description": "An AWS account that is a member of an organization.", "id": "AwsAccount", "properties": { "id": { -"description": "The unique identifier (ID) of the account, containing exactly 12 digits.", "type": "string" }, "name": { -"description": "The friendly name of this account.", "type": "string" } }, "type": "object" }, "AwsMetadata": { -"description": "AWS metadata associated with the resource, only applicable if the finding's cloud provider is Amazon Web Services.", "id": "AwsMetadata", "properties": { "account": { -"$ref": "AwsAccount", -"description": "The AWS account associated with the resource." +"$ref": "AwsAccount" }, "organization": { -"$ref": "AwsOrganization", -"description": "The AWS organization associated with the resource." +"$ref": "AwsOrganization" }, "organizationalUnits": { -"description": "A list of AWS organizational units associated with the resource, ordered from lowest level (closest to the account) to highest level.", "items": { "$ref": "AwsOrganizationalUnit" }, @@ -6629,180 +6159,145 @@ "type": "object" }, "AwsOrganization": { -"description": "An organization is a collection of accounts that are centrally managed together using consolidated billing, organized hierarchically with organizational units (OUs), and controlled with policies.", "id": "AwsOrganization", "properties": { "id": { -"description": "The unique identifier (ID) for the organization. The regex pattern for an organization ID string requires \"o-\" followed by from 10 to 32 lowercase letters or digits.", "type": "string" } }, "type": "object" }, "AwsOrganizationalUnit": { -"description": "An Organizational Unit (OU) is a container of AWS accounts within a root of an organization. Policies that are attached to an OU apply to all accounts contained in that OU and in any child OUs.", "id": "AwsOrganizationalUnit", "properties": { "id": { -"description": "The unique identifier (ID) associated with this OU. The regex pattern for an organizational unit ID string requires \"ou-\" followed by from 4 to 32 lowercase letters or digits (the ID of the root that contains the OU). This string is followed by a second \"-\" dash and from 8 to 32 additional lowercase letters or digits. For example, \"ou-ab12-cd34ef56\".", "type": "string" }, "name": { -"description": "The friendly name of the OU.", "type": "string" } }, "type": "object" }, "AzureManagementGroup": { -"description": "Represents an Azure management group.", "id": "AzureManagementGroup", "properties": { "displayName": { -"description": "The display name of the Azure management group.", "type": "string" }, "id": { -"description": "The UUID of the Azure management group, for example, `20000000-0001-0000-0000-000000000000`.", "type": "string" } }, "type": "object" }, "AzureMetadata": { -"description": "Azure metadata associated with the resource, only applicable if the finding's cloud provider is Microsoft Azure.", "id": "AzureMetadata", "properties": { "managementGroups": { -"description": "A list of Azure management groups associated with the resource, ordered from lowest level (closest to the subscription) to highest level.", "items": { "$ref": "AzureManagementGroup" }, "type": "array" }, "resourceGroup": { -"$ref": "AzureResourceGroup", -"description": "The Azure resource group associated with the resource." +"$ref": "AzureResourceGroup" }, "subscription": { -"$ref": "AzureSubscription", -"description": "The Azure subscription associated with the resource." +"$ref": "AzureSubscription" }, "tenant": { -"$ref": "AzureTenant", -"description": "The Azure Entra tenant associated with the resource." +"$ref": "AzureTenant" } }, "type": "object" }, "AzureResourceGroup": { -"description": "Represents an Azure resource group.", "id": "AzureResourceGroup", "properties": { "id": { -"description": "The ID of the Azure resource group.", "type": "string" }, "name": { -"description": "The name of the Azure resource group. This is not a UUID.", "type": "string" } }, "type": "object" }, "AzureSubscription": { -"description": "Represents an Azure subscription.", "id": "AzureSubscription", "properties": { "displayName": { -"description": "The display name of the Azure subscription.", "type": "string" }, "id": { -"description": "The UUID of the Azure subscription, for example, `291bba3f-e0a5-47bc-a099-3bdcb2a50a05`.", "type": "string" } }, "type": "object" }, "AzureTenant": { -"description": "Represents a Microsoft Entra tenant.", "id": "AzureTenant", "properties": { "displayName": { -"description": "The display name of the Azure tenant.", "type": "string" }, "id": { -"description": "The ID of the Microsoft Entra tenant, for example, \"a11aaa11-aa11-1aa1-11aa-1aaa11a\".", "type": "string" } }, "type": "object" }, "BackupDisasterRecovery": { -"description": "Information related to Google Cloud Backup and DR Service findings.", "id": "BackupDisasterRecovery", "properties": { "appliance": { -"description": "The name of the Backup and DR appliance that captures, moves, and manages the lifecycle of backup data. For example, `backup-server-57137`.", "type": "string" }, "applications": { -"description": "The names of Backup and DR applications. An application is a VM, database, or file system on a managed host monitored by a backup and recovery appliance. For example, `centos7-01-vol00`, `centos7-01-vol01`, `centos7-01-vol02`.", "items": { "type": "string" }, "type": "array" }, "backupCreateTime": { -"description": "The timestamp at which the Backup and DR backup was created.", "format": "google-datetime", "type": "string" }, "backupTemplate": { -"description": "The name of a Backup and DR template which comprises one or more backup policies. See the [Backup and DR documentation](https://cloud.google.com/backup-disaster-recovery/docs/concepts/backup-plan#temp) for more information. For example, `snap-ov`.", "type": "string" }, "backupType": { -"description": "The backup type of the Backup and DR image. For example, `Snapshot`, `Remote Snapshot`, `OnVault`.", "type": "string" }, "host": { -"description": "The name of a Backup and DR host, which is managed by the backup and recovery appliance and known to the management console. The host can be of type Generic (for example, Compute Engine, SQL Server, Oracle DB, SMB file system, etc.), vCenter, or an ESX server. See the [Backup and DR documentation on hosts](https://cloud.google.com/backup-disaster-recovery/docs/configuration/manage-hosts-and-their-applications) for more information. For example, `centos7-01`.", "type": "string" }, "policies": { -"description": "The names of Backup and DR policies that are associated with a template and that define when to run a backup, how frequently to run a backup, and how long to retain the backup image. For example, `onvaults`.", "items": { "type": "string" }, "type": "array" }, "policyOptions": { -"description": "The names of Backup and DR advanced policy options of a policy applying to an application. See the [Backup and DR documentation on policy options](https://cloud.google.com/backup-disaster-recovery/docs/create-plan/policy-settings). For example, `skipofflineappsincongrp, nounmap`.", "items": { "type": "string" }, "type": "array" }, "profile": { -"description": "The name of the Backup and DR resource profile that specifies the storage media for backups of application and VM data. See the [Backup and DR documentation on profiles](https://cloud.google.com/backup-disaster-recovery/docs/concepts/backup-plan#profile). For example, `GCP`.", "type": "string" }, "storagePool": { -"description": "The name of the Backup and DR storage pool that the backup and recovery appliance is storing data in. The storage pool could be of type Cloud, Primary, Snapshot, or OnVault. See the [Backup and DR documentation on storage pools](https://cloud.google.com/backup-disaster-recovery/docs/concepts/storage-pools). For example, `DiskPoolOne`.", "type": "string" } }, "type": "object" }, "BatchCreateResourceValueConfigsRequest": { -"description": "Request message to create multiple resource value configs", "id": "BatchCreateResourceValueConfigsRequest", "properties": { "requests": { -"description": "Required. The resource value configs to be created.", "items": { "$ref": "CreateResourceValueConfigRequest" }, @@ -6812,11 +6307,9 @@ "type": "object" }, "BatchCreateResourceValueConfigsResponse": { -"description": "Response message for BatchCreateResourceValueConfigs", "id": "BatchCreateResourceValueConfigsResponse", "properties": { "resourceValueConfigs": { -"description": "The resource value configs created", "items": { "$ref": "GoogleCloudSecuritycenterV1ResourceValueConfig" }, @@ -6826,62 +6319,52 @@ "type": "object" }, "BigQueryDestination": { -"description": "The destination BigQuery dataset to export findings to.", "id": "BigQueryDestination", "properties": { "dataset": { -"description": "Required. The relative resource name of the destination dataset, in the form projects/{projectId}/datasets/{datasetId}.", "type": "string" } }, "type": "object" }, "Binding": { -"description": "Associates `members`, or principals, with a `role`.", "id": "Binding", "properties": { "condition": { -"$ref": "Expr", -"description": "The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies)." +"$ref": "Expr" }, "members": { -"description": "Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.", "items": { "type": "string" }, "type": "array" }, "role": { -"description": "Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles).", "type": "string" } }, "type": "object" }, "BulkMuteFindingsRequest": { -"description": "Request message for bulk findings update. Note: 1. If multiple bulk update requests match the same resource, the order in which they get executed is not defined. 2. Once a bulk operation is started, there is no way to stop it.", "id": "BulkMuteFindingsRequest", "properties": { "filter": { -"description": "Expression that identifies findings that should be updated. The expression is a list of zero or more restrictions combined via logical operators `AND` and `OR`. Parentheses are supported, and `OR` has higher precedence than `AND`. Restrictions have the form ` ` and may have a `-` character in front of them to indicate negation. The fields map to those defined in the corresponding resource. The supported operators are: * `=` for all value types. * `>`, `<`, `>=`, `<=` for integer values. * `:`, meaning substring matching, for strings. The supported value types are: * string literals in quotes. * integer literals without quotes. * boolean literals `true` and `false` without quotes.", "type": "string" }, "muteAnnotation": { "deprecated": true, -"description": "This can be a mute configuration name or any identifier for mute/unmute of findings based on the filter.", "type": "string" }, "muteState": { -"description": "Optional. All findings matching the given filter will have their mute state set to this value. The default value is `MUTED`. Setting this to `UNDEFINED` will clear the mute state on all matching findings.", "enum": [ "MUTE_STATE_UNSPECIFIED", "MUTED", "UNDEFINED" ], "enumDescriptions": [ -"Unused.", -"Matching findings will be muted (default).", -"Matching findings will have their mute state cleared." +"", +"", +"" ], "type": "string" } @@ -6889,11 +6372,9 @@ "type": "object" }, "Chokepoint": { -"description": "Contains details about a chokepoint, which is a resource or resource group where high-risk attack paths converge, based on [attack path simulations] (https://cloud.google.com/security-command-center/docs/attack-exposure-learn#attack_path_simulations).", "id": "Chokepoint", "properties": { "relatedFindings": { -"description": "List of resource names of findings associated with this chokepoint. For example, organizations/123/sources/456/findings/789. This list will have at most 100 findings.", "items": { "type": "string" }, @@ -6903,65 +6384,53 @@ "type": "object" }, "CloudArmor": { -"description": "Fields related to Google Cloud Armor findings.", "id": "CloudArmor", "properties": { "adaptiveProtection": { -"$ref": "AdaptiveProtection", -"description": "Information about potential Layer 7 DDoS attacks identified by [Google Cloud Armor Adaptive Protection](https://cloud.google.com/armor/docs/adaptive-protection-overview)." +"$ref": "AdaptiveProtection" }, "attack": { -"$ref": "Attack", -"description": "Information about DDoS attack volume and classification." +"$ref": "Attack" }, "duration": { -"description": "Duration of attack from the start until the current moment (updated every 5 minutes).", "format": "google-duration", "type": "string" }, "requests": { -"$ref": "Requests", -"description": "Information about incoming requests evaluated by [Google Cloud Armor security policies](https://cloud.google.com/armor/docs/security-policy-overview)." +"$ref": "Requests" }, "securityPolicy": { -"$ref": "SecurityPolicy", -"description": "Information about the [Google Cloud Armor security policy](https://cloud.google.com/armor/docs/security-policy-overview) relevant to the finding." +"$ref": "SecurityPolicy" }, "threatVector": { -"description": "Distinguish between volumetric & protocol DDoS attack and application layer attacks. For example, \"L3_4\" for Layer 3 and Layer 4 DDoS attacks, or \"L_7\" for Layer 7 DDoS attacks.", "type": "string" } }, "type": "object" }, "CloudControl": { -"description": "CloudControl associated with the finding.", "id": "CloudControl", "properties": { "cloudControlName": { -"description": "Name of the CloudControl associated with the finding.", "type": "string" }, "policyType": { -"description": "Policy type of the CloudControl", "type": "string" }, "type": { -"description": "Type of cloud control.", "enum": [ "CLOUD_CONTROL_TYPE_UNSPECIFIED", "BUILT_IN", "CUSTOM" ], "enumDescriptions": [ -"Unspecified.", -"Built in Cloud Control.", -"Custom Cloud Control." +"", +"", +"" ], "type": "string" }, "version": { -"description": "Version of the Cloud Control", "format": "int32", "type": "integer" } @@ -6969,31 +6438,27 @@ "type": "object" }, "CloudDlpDataProfile": { -"description": "The [data profile](https://cloud.google.com/dlp/docs/data-profiles) associated with the finding.", "id": "CloudDlpDataProfile", "properties": { "dataProfile": { -"description": "Name of the data profile, for example, `projects/123/locations/europe/tableProfiles/8383929`.", "type": "string" }, "infoTypes": { -"description": "Type of information detected by SDP. Info type includes name, version and sensitivity of the detected information type.", "items": { "$ref": "InfoType" }, "type": "array" }, "parentType": { -"description": "The resource hierarchy level at which the data profile was generated.", "enum": [ "PARENT_TYPE_UNSPECIFIED", "ORGANIZATION", "PROJECT" ], "enumDescriptions": [ -"Unspecified parent type.", -"Organization-level configurations.", -"Project-level configurations." +"", +"", +"" ], "type": "string" } @@ -7001,47 +6466,37 @@ "type": "object" }, "CloudDlpInspection": { -"description": "Details about the Cloud Data Loss Prevention (Cloud DLP) [inspection job](https://cloud.google.com/dlp/docs/concepts-job-triggers) that produced the finding.", "id": "CloudDlpInspection", "properties": { "fullScan": { -"description": "Whether Cloud DLP scanned the complete resource or a sampled subset.", "type": "boolean" }, "infoType": { -"description": "The type of information (or *[infoType](https://cloud.google.com/dlp/docs/infotypes-reference)*) found, for example, `EMAIL_ADDRESS` or `STREET_ADDRESS`.", "type": "string" }, "infoTypeCount": { -"description": "The number of times Cloud DLP found this infoType within this job and resource.", "format": "int64", "type": "string" }, "inspectJob": { -"description": "Name of the inspection job, for example, `projects/123/locations/europe/dlpJobs/i-8383929`.", "type": "string" } }, "type": "object" }, "CloudLoggingEntry": { -"description": "Metadata taken from a [Cloud Logging LogEntry](https://cloud.google.com/logging/docs/reference/v2/rest/v2/LogEntry)", "id": "CloudLoggingEntry", "properties": { "insertId": { -"description": "A unique identifier for the log entry.", "type": "string" }, "logId": { -"description": "The type of the log (part of `log_name`. `log_name` is the resource name of the log to which this log entry belongs). For example: `cloudresourcemanager.googleapis.com/activity`. Note that this field is not URL-encoded, unlike the `LOG_ID` field in `LogEntry`.", "type": "string" }, "resourceContainer": { -"description": "The organization, folder, or project of the monitored resource that produced this log entry.", "type": "string" }, "timestamp": { -"description": "The time the event described by the log entry occurred.", "format": "google-datetime", "type": "string" } @@ -7049,44 +6504,36 @@ "type": "object" }, "Compliance": { -"description": "Contains compliance information about a security standard indicating unmet recommendations.", "id": "Compliance", "properties": { "ids": { -"description": "Policies within the standard or benchmark, for example, A.12.4.1", "items": { "type": "string" }, "type": "array" }, "standard": { -"description": "Industry-wide compliance standards or benchmarks, such as CIS, PCI, and OWASP.", "type": "string" }, "version": { -"description": "Version of the standard or benchmark, for example, 1.1", "type": "string" } }, "type": "object" }, "ComplianceDetails": { -"description": "Compliance Details associated with the finding.", "id": "ComplianceDetails", "properties": { "cloudControl": { -"$ref": "CloudControl", -"description": "CloudControl associated with the finding" +"$ref": "CloudControl" }, "cloudControlDeploymentNames": { -"description": "Cloud Control Deployments associated with the finding. For example, organizations/123/locations/global/cloudControlDeployments/deploymentIdentifier", "items": { "type": "string" }, "type": "array" }, "frameworks": { -"description": "Details of Frameworks associated with the finding", "items": { "$ref": "Framework" }, @@ -7096,20 +6543,16 @@ "type": "object" }, "Connection": { -"description": "Contains information about the IP connection associated with the finding.", "id": "Connection", "properties": { "destinationIp": { -"description": "Destination IP address. Not present for sockets that are listening and not connected.", "type": "string" }, "destinationPort": { -"description": "Destination port. Not present for sockets that are listening and not connected.", "format": "int32", "type": "integer" }, "protocol": { -"description": "IANA Internet Protocol Number such as TCP(6) and UDP(17).", "enum": [ "PROTOCOL_UNSPECIFIED", "ICMP", @@ -7119,21 +6562,19 @@ "ESP" ], "enumDescriptions": [ -"Unspecified protocol (not HOPOPT).", -"Internet Control Message Protocol.", -"Transmission Control Protocol.", -"User Datagram Protocol.", -"Generic Routing Encapsulation.", -"Encap Security Payload." +"", +"", +"", +"", +"", +"" ], "type": "string" }, "sourceIp": { -"description": "Source IP address.", "type": "string" }, "sourcePort": { -"description": "Source port.", "format": "int32", "type": "integer" } @@ -7141,22 +6582,18 @@ "type": "object" }, "Contact": { -"description": "The email address of a contact.", "id": "Contact", "properties": { "email": { -"description": "An email address. For example, \"`person123@company.com`\".", "type": "string" } }, "type": "object" }, "ContactDetails": { -"description": "Details about specific contacts", "id": "ContactDetails", "properties": { "contacts": { -"description": "A list of contacts", "items": { "$ref": "Contact" }, @@ -7166,95 +6603,76 @@ "type": "object" }, "Container": { -"description": "Container associated with the finding.", "id": "Container", "properties": { "createTime": { -"description": "The time that the container was created.", "format": "google-datetime", "type": "string" }, "imageId": { -"description": "Optional container image ID, if provided by the container runtime. Uniquely identifies the container image launched using a container image digest.", "type": "string" }, "labels": { -"description": "Container labels, as provided by the container runtime.", "items": { "$ref": "Label" }, "type": "array" }, "name": { -"description": "Name of the container.", "type": "string" }, "uri": { -"description": "Container image URI provided when configuring a pod or container. This string can identify a container image version using mutable tags.", "type": "string" } }, "type": "object" }, "Control": { -"description": "Compliance control associated with the finding.", "id": "Control", "properties": { "controlName": { -"description": "Name of the Control", "type": "string" }, "displayName": { -"description": "Display name of the control. For example, AU-02.", "type": "string" } }, "type": "object" }, "CreateResourceValueConfigRequest": { -"description": "Request message to create single resource value config", "id": "CreateResourceValueConfigRequest", "properties": { "parent": { -"description": "Required. Resource name of the new ResourceValueConfig's parent.", "type": "string" }, "resourceValueConfig": { -"$ref": "GoogleCloudSecuritycenterV1ResourceValueConfig", -"description": "Required. The resource value config being created." +"$ref": "GoogleCloudSecuritycenterV1ResourceValueConfig" } }, "type": "object" }, "CustomModuleValidationError": { -"description": "An error encountered while validating the uploaded configuration of an Event Threat Detection Custom Module.", "id": "CustomModuleValidationError", "properties": { "description": { -"description": "A description of the error, suitable for human consumption. Required.", "type": "string" }, "end": { -"$ref": "Position", -"description": "The end position of the error in the uploaded text version of the module. This field may be omitted if no specific position applies, or if one could not be computed." +"$ref": "Position" }, "fieldPath": { -"description": "The path, in RFC 8901 JSON Pointer format, to the field that failed validation. This may be left empty if no specific field is affected.", "type": "string" }, "start": { -"$ref": "Position", -"description": "The initial position of the error in the uploaded text version of the module. This field may be omitted if no specific position applies, or if one could not be computed." +"$ref": "Position" } }, "type": "object" }, "CustomModuleValidationErrors": { -"description": "A list of zero or more errors encountered while validating the uploaded configuration of an Event Threat Detection Custom Module.", "id": "CustomModuleValidationErrors", "properties": { "errors": { -"description": "The list of errors.", "items": { "$ref": "CustomModuleValidationError" }, @@ -7264,20 +6682,16 @@ "type": "object" }, "Cve": { -"description": "CVE stands for Common Vulnerabilities and Exposures. Information from the [CVE record](https://www.cve.org/ResourcesSupport/Glossary) that describes this vulnerability.", "id": "Cve", "properties": { "cvssv3": { -"$ref": "Cvssv3", -"description": "Describe Common Vulnerability Scoring System specified at https://www.first.org/cvss/v3.1/specification-document" +"$ref": "Cvssv3" }, "exploitReleaseDate": { -"description": "Date the first publicly available exploit or PoC was released.", "format": "google-datetime", "type": "string" }, "exploitationActivity": { -"description": "The exploitation activity of the vulnerability in the wild.", "enum": [ "EXPLOITATION_ACTIVITY_UNSPECIFIED", "WIDE", @@ -7287,26 +6701,23 @@ "NO_KNOWN" ], "enumDescriptions": [ -"Invalid or empty value.", -"Exploitation has been reported or confirmed to widely occur.", -"Limited reported or confirmed exploitation activities.", -"Exploit is publicly available.", -"No known exploitation activity, but has a high potential for exploitation.", -"No known exploitation activity." +"", +"", +"", +"", +"", +"" ], "type": "string" }, "firstExploitationDate": { -"description": "Date of the earliest known exploitation.", "format": "google-datetime", "type": "string" }, "id": { -"description": "The unique identifier for the vulnerability. e.g. CVE-2021-34527", "type": "string" }, "impact": { -"description": "The potential impact of the vulnerability if it was to be exploited.", "enum": [ "RISK_RATING_UNSPECIFIED", "LOW", @@ -7315,56 +6726,49 @@ "CRITICAL" ], "enumDescriptions": [ -"Invalid or empty value.", -"Exploitation would have little to no security impact.", -"Exploitation would enable attackers to perform activities, or could allow attackers to have a direct impact, but would require additional steps.", -"Exploitation would enable attackers to have a notable direct impact without needing to overcome any major mitigating factors.", -"Exploitation would fundamentally undermine the security of affected systems, enable actors to perform significant attacks with minimal effort, with little to no mitigating factors to overcome." +"", +"", +"", +"", +"" ], "type": "string" }, "observedInTheWild": { -"description": "Whether or not the vulnerability has been observed in the wild.", "type": "boolean" }, "references": { -"description": "Additional information about the CVE. e.g. https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2021-34527", "items": { "$ref": "Reference" }, "type": "array" }, "upstreamFixAvailable": { -"description": "Whether upstream fix is available for the CVE.", "type": "boolean" }, "zeroDay": { -"description": "Whether or not the vulnerability was zero day when the finding was published.", "type": "boolean" } }, "type": "object" }, "Cvssv3": { -"description": "Common Vulnerability Scoring System version 3.", "id": "Cvssv3", "properties": { "attackComplexity": { -"description": "This metric describes the conditions beyond the attacker's control that must exist in order to exploit the vulnerability.", "enum": [ "ATTACK_COMPLEXITY_UNSPECIFIED", "ATTACK_COMPLEXITY_LOW", "ATTACK_COMPLEXITY_HIGH" ], "enumDescriptions": [ -"Invalid value.", -"Specialized access conditions or extenuating circumstances do not exist. An attacker can expect repeatable success when attacking the vulnerable component.", -"A successful attack depends on conditions beyond the attacker's control. That is, a successful attack cannot be accomplished at will, but requires the attacker to invest in some measurable amount of effort in preparation or execution against the vulnerable component before a successful attack can be expected." +"", +"", +"" ], "type": "string" }, "attackVector": { -"description": "Base Metrics Represents the intrinsic characteristics of a vulnerability that are constant over time and across user environments. This metric reflects the context by which vulnerability exploitation is possible.", "enum": [ "ATTACK_VECTOR_UNSPECIFIED", "ATTACK_VECTOR_NETWORK", @@ -7373,16 +6777,15 @@ "ATTACK_VECTOR_PHYSICAL" ], "enumDescriptions": [ -"Invalid value.", -"The vulnerable component is bound to the network stack and the set of possible attackers extends beyond the other options listed below, up to and including the entire Internet.", -"The vulnerable component is bound to the network stack, but the attack is limited at the protocol level to a logically adjacent topology.", -"The vulnerable component is not bound to the network stack and the attacker's path is via read/write/execute capabilities.", -"The attack requires the attacker to physically touch or manipulate the vulnerable component." +"", +"", +"", +"", +"" ], "type": "string" }, "availabilityImpact": { -"description": "This metric measures the impact to the availability of the impacted component resulting from a successfully exploited vulnerability.", "enum": [ "IMPACT_UNSPECIFIED", "IMPACT_HIGH", @@ -7390,20 +6793,18 @@ "IMPACT_NONE" ], "enumDescriptions": [ -"Invalid value.", -"High impact.", -"Low impact.", -"No impact." +"", +"", +"", +"" ], "type": "string" }, "baseScore": { -"description": "The base score is a function of the base metric scores.", "format": "double", "type": "number" }, "confidentialityImpact": { -"description": "This metric measures the impact to the confidentiality of the information resources managed by a software component due to a successfully exploited vulnerability.", "enum": [ "IMPACT_UNSPECIFIED", "IMPACT_HIGH", @@ -7411,15 +6812,14 @@ "IMPACT_NONE" ], "enumDescriptions": [ -"Invalid value.", -"High impact.", -"Low impact.", -"No impact." +"", +"", +"", +"" ], "type": "string" }, "integrityImpact": { -"description": "This metric measures the impact to integrity of a successfully exploited vulnerability.", "enum": [ "IMPACT_UNSPECIFIED", "IMPACT_HIGH", @@ -7427,15 +6827,14 @@ "IMPACT_NONE" ], "enumDescriptions": [ -"Invalid value.", -"High impact.", -"Low impact.", -"No impact." +"", +"", +"", +"" ], "type": "string" }, "privilegesRequired": { -"description": "This metric describes the level of privileges an attacker must possess before successfully exploiting the vulnerability.", "enum": [ "PRIVILEGES_REQUIRED_UNSPECIFIED", "PRIVILEGES_REQUIRED_NONE", @@ -7443,38 +6842,36 @@ "PRIVILEGES_REQUIRED_HIGH" ], "enumDescriptions": [ -"Invalid value.", -"The attacker is unauthorized prior to attack, and therefore does not require any access to settings or files of the vulnerable system to carry out an attack.", -"The attacker requires privileges that provide basic user capabilities that could normally affect only settings and files owned by a user. Alternatively, an attacker with Low privileges has the ability to access only non-sensitive resources.", -"The attacker requires privileges that provide significant (e.g., administrative) control over the vulnerable component allowing access to component-wide settings and files." +"", +"", +"", +"" ], "type": "string" }, "scope": { -"description": "The Scope metric captures whether a vulnerability in one vulnerable component impacts resources in components beyond its security scope.", "enum": [ "SCOPE_UNSPECIFIED", "SCOPE_UNCHANGED", "SCOPE_CHANGED" ], "enumDescriptions": [ -"Invalid value.", -"An exploited vulnerability can only affect resources managed by the same security authority.", -"An exploited vulnerability can affect resources beyond the security scope managed by the security authority of the vulnerable component." +"", +"", +"" ], "type": "string" }, "userInteraction": { -"description": "This metric captures the requirement for a human user, other than the attacker, to participate in the successful compromise of the vulnerable component.", "enum": [ "USER_INTERACTION_UNSPECIFIED", "USER_INTERACTION_NONE", "USER_INTERACTION_REQUIRED" ], "enumDescriptions": [ -"Invalid value.", -"The vulnerable system can be exploited without interaction from any user.", -"Successful exploitation of this vulnerability requires a user to take some action before the vulnerability can be exploited." +"", +"", +"" ], "type": "string" } @@ -7482,15 +6879,12 @@ "type": "object" }, "Cwe": { -"description": "CWE stands for Common Weakness Enumeration. Information about this weakness, as described by [CWE](https://cwe.mitre.org/).", "id": "Cwe", "properties": { "id": { -"description": "The CWE identifier, e.g. CWE-94", "type": "string" }, "references": { -"description": "Any reference to the details on the CWE, for example, https://cwe.mitre.org/data/definitions/94.html", "items": { "$ref": "Reference" }, @@ -7500,20 +6894,16 @@ "type": "object" }, "DataAccessEvent": { -"description": "Details about a data access attempt made by a principal not authorized under applicable data security policy.", "id": "DataAccessEvent", "properties": { "eventId": { -"description": "Unique identifier for data access event.", "type": "string" }, "eventTime": { -"description": "Timestamp of data access event.", "format": "google-datetime", "type": "string" }, "operation": { -"description": "The operation performed by the principal to access the data.", "enum": [ "OPERATION_UNSPECIFIED", "READ", @@ -7521,35 +6911,30 @@ "COPY" ], "enumDescriptions": [ -"The operation is unspecified.", -"Represents a read operation.", -"Represents a move operation.", -"Represents a copy operation." +"", +"", +"", +"" ], "type": "string" }, "principalEmail": { -"description": "The email address of the principal that accessed the data. The principal could be a user account, service account, Google group, or other.", "type": "string" } }, "type": "object" }, "DataFlowEvent": { -"description": "Details about a data flow event, in which either the data is moved to or is accessed from a non-compliant geo-location, as defined in the applicable data security policy.", "id": "DataFlowEvent", "properties": { "eventId": { -"description": "Unique identifier for data flow event.", "type": "string" }, "eventTime": { -"description": "Timestamp of data flow event.", "format": "google-datetime", "type": "string" }, "operation": { -"description": "The operation performed by the principal for the data flow event.", "enum": [ "OPERATION_UNSPECIFIED", "READ", @@ -7557,40 +6942,34 @@ "COPY" ], "enumDescriptions": [ -"The operation is unspecified.", -"Represents a read operation.", -"Represents a move operation.", -"Represents a copy operation." +"", +"", +"", +"" ], "type": "string" }, "principalEmail": { -"description": "The email address of the principal that initiated the data flow event. The principal could be a user account, service account, Google group, or other.", "type": "string" }, "violatedLocation": { -"description": "Non-compliant location of the principal or the data destination.", "type": "string" } }, "type": "object" }, "DataRetentionDeletionEvent": { -"description": "Details about data retention deletion violations, in which the data is non-compliant based on their retention or deletion time, as defined in the applicable data security policy. The Data Retention Deletion (DRD) control is a control of the DSPM (Data Security Posture Management) suite that enables organizations to manage data retention and deletion policies in compliance with regulations, such as GDPR and CRPA. DRD supports two primary policy types: maximum storage length (max TTL) and minimum storage length (min TTL). Both are aimed at helping organizations meet regulatory and data management commitments.", "id": "DataRetentionDeletionEvent", "properties": { "dataObjectCount": { -"description": "Number of objects that violated the policy for this resource. If the number is less than 1,000, then the value of this field is the exact number. If the number of objects that violated the policy is greater than or equal to 1,000, then the value of this field is 1000.", "format": "int64", "type": "string" }, "eventDetectionTime": { -"description": "Timestamp indicating when the event was detected.", "format": "google-datetime", "type": "string" }, "eventType": { -"description": "Type of the DRD event.", "enum": [ "EVENT_TYPE_UNSPECIFIED", "EVENT_TYPE_MAX_TTL_EXCEEDED", @@ -7606,21 +6985,19 @@ false, false ], "enumDescriptions": [ -"Unspecified event type.", -"Deprecated: This field is pending removal. Use EVENT_TYPE_MAX_TTL_FROM_CREATION or EVENT_TYPE_MAX_TTL_FROM_LAST_MODIFICATION instead.", -"Max TTL from the asset's creation time.", -"Max TTL from the asset's last modification time.", -"Min TTL from the asset's creation time." +"", +"", +"", +"", +"" ], "type": "string" }, "maxRetentionAllowed": { -"description": "Maximum duration of retention allowed from the DRD control. This comes from the DRD control where users set a max TTL for their data. For example, suppose that a user sets the max TTL for a Cloud Storage bucket to 90 days. However, an object in that bucket is 100 days old. In this case, a DataRetentionDeletionEvent will be generated for that Cloud Storage bucket, and the max_retention_allowed is 90 days.", "format": "google-duration", "type": "string" }, "minRetentionAllowed": { -"description": "Min duration of retention allowed from the DSPM retention control. This field is only populated when event type is set to EVENT_TYPE_MIN_TTL_FROM_CREATION.", "format": "google-duration", "type": "string" } @@ -7628,64 +7005,51 @@ false "type": "object" }, "Database": { -"description": "Represents database access information, such as queries. A database may be a sub-resource of an instance (as in the case of Cloud SQL instances or Cloud Spanner instances), or the database instance itself. Some database resources might not have the [full resource name](https://google.aip.dev/122#full-resource-names) populated because these resource types, such as Cloud SQL databases, are not yet supported by Cloud Asset Inventory. In these cases only the display name is provided.", "id": "Database", "properties": { "displayName": { -"description": "The human-readable name of the database that the user connected to.", "type": "string" }, "grantees": { -"description": "The target usernames, roles, or groups of an SQL privilege grant, which is not an IAM policy change.", "items": { "type": "string" }, "type": "array" }, "name": { -"description": "Some database resources may not have the [full resource name](https://google.aip.dev/122#full-resource-names) populated because these resource types are not yet supported by Cloud Asset Inventory (e.g. Cloud SQL databases). In these cases only the display name will be provided. The [full resource name](https://google.aip.dev/122#full-resource-names) of the database that the user connected to, if it is supported by Cloud Asset Inventory.", "type": "string" }, "query": { -"description": "The SQL statement that is associated with the database access.", "type": "string" }, "userName": { -"description": "The username used to connect to the database. The username might not be an IAM principal and does not have a set format.", "type": "string" }, "version": { -"description": "The version of the database, for example, POSTGRES_14. See [the complete list](https://cloud.google.com/sql/docs/mysql/admin-api/rest/v1/SqlDatabaseVersion).", "type": "string" } }, "type": "object" }, "Dataset": { -"description": "Vertex AI dataset associated with the finding.", "id": "Dataset", "properties": { "displayName": { -"description": "The user defined display name of dataset, e.g. plants-dataset", "type": "string" }, "name": { -"description": "Resource name of the dataset, e.g. projects/{project}/locations/{location}/datasets/2094040236064505856", "type": "string" }, "source": { -"description": "Data source, such as BigQuery source URI, e.g. bq://scc-nexus-test.AIPPtest.gsod", "type": "string" } }, "type": "object" }, "Denied": { -"description": "Denied IP rule.", "id": "Denied", "properties": { "ipRules": { -"description": "Optional. Optional list of denied IP rules.", "items": { "$ref": "IpRule" }, @@ -7695,15 +7059,12 @@ false "type": "object" }, "Detection": { -"description": "Memory hash detection contributing to the binary family match.", "id": "Detection", "properties": { "binary": { -"description": "The name of the binary associated with the memory hash signature detection.", "type": "string" }, "percentPagesMatched": { -"description": "The percentage of memory page hashes in the signature that were matched.", "format": "double", "type": "number" } @@ -7711,35 +7072,29 @@ false "type": "object" }, "DiscoveredWorkload": { -"description": "Represents discovered, customer managed workload that is not registered with the respective GCP service.", "id": "DiscoveredWorkload", "properties": { "confidence": { -"description": "The confidence in detection of this workload.", "enum": [ "CONFIDENCE_UNSPECIFIED", "CONFIDENCE_HIGH" ], "enumDescriptions": [ -"Unspecified confidence level.", -"High confidence in detection of a workload." +"", +"" ], "type": "string" }, "detectedRelevantHardware": { -"description": "A boolean flag set to true if associated hardware strongly predicts the workload type.", "type": "boolean" }, "detectedRelevantKeywords": { -"description": "A boolean flag set to true if associated keywords strongly predict the workload type.", "type": "boolean" }, "detectedRelevantPackages": { -"description": "A boolean flag set to true if installed packages strongly predict the workload type.", "type": "boolean" }, "workloadType": { -"description": "The type of workload.", "enum": [ "WORKLOAD_TYPE_UNSPECIFIED", "MCP_SERVER", @@ -7747,10 +7102,10 @@ false "AGENT" ], "enumDescriptions": [ -"Unspecified workload type", -"A workload of type MCP Server", -"A workload of type AI Inference", -"A workload of type LLM Agent" +"", +"", +"", +"" ], "type": "string" } @@ -7758,53 +7113,43 @@ false "type": "object" }, "Disk": { -"description": "Contains information about the disk associated with the finding.", "id": "Disk", "properties": { "name": { -"description": "The name of the disk, for example, \"https://www.googleapis.com/compute/v1/projects/{project-id}/zones/{zone-id}/disks/{disk-id}\".", "type": "string" } }, "type": "object" }, "DiskPath": { -"description": "Path of the file in terms of underlying disk/partition identifiers.", "id": "DiskPath", "properties": { "partitionUuid": { -"description": "UUID of the partition (format https://wiki.archlinux.org/title/persistent_block_device_naming#by-uuid)", "type": "string" }, "relativePath": { -"description": "Relative path of the file in the partition as a JSON encoded string. Example: /home/user1/executable_file.sh", "type": "string" } }, "type": "object" }, "DynamicMuteRecord": { -"description": "The record of a dynamic mute rule that matches the finding.", "id": "DynamicMuteRecord", "properties": { "matchTime": { -"description": "When the dynamic mute rule first matched the finding.", "format": "google-datetime", "type": "string" }, "muteConfig": { -"description": "The relative resource name of the mute rule, represented by a mute config, that created this record, for example `organizations/123/muteConfigs/mymuteconfig` or `organizations/123/locations/global/muteConfigs/mymuteconfig`.", "type": "string" } }, "type": "object" }, "EffectiveEventThreatDetectionCustomModule": { -"description": "An EffectiveEventThreatDetectionCustomModule is the representation of an Event Threat Detection custom module at a specified level of the resource hierarchy: organization, folder, or project. If a custom module is inherited from a parent organization or folder, the value of the `enablement_state` property in EffectiveEventThreatDetectionCustomModule is set to the value that is effective in the parent, instead of `INHERITED`. For example, if the module is enabled in a parent organization or folder, the effective `enablement_state` for the module in all child folders or projects is also `enabled`. EffectiveEventThreatDetectionCustomModule is read-only.", "id": "EffectiveEventThreatDetectionCustomModule", "properties": { "cloudProvider": { -"description": "The cloud provider of the custom module.", "enum": [ "CLOUD_PROVIDER_UNSPECIFIED", "GOOGLE_CLOUD_PLATFORM", @@ -7812,10 +7157,10 @@ false "MICROSOFT_AZURE" ], "enumDescriptions": [ -"Unspecified cloud provider.", -"Google Cloud.", -"Amazon Web Services.", -"Microsoft Azure." +"", +"", +"", +"" ], "type": "string" }, @@ -7824,42 +7169,36 @@ false "description": "Properties of the object.", "type": "any" }, -"description": "Output only. Config for the effective module.", "readOnly": true, "type": "object" }, "description": { -"description": "Output only. The description for the module.", "readOnly": true, "type": "string" }, "displayName": { -"description": "Output only. The human readable name to be displayed for the module.", "readOnly": true, "type": "string" }, "enablementState": { -"description": "Output only. The effective state of enablement for the module at the given level of the hierarchy.", "enum": [ "ENABLEMENT_STATE_UNSPECIFIED", "ENABLED", "DISABLED" ], "enumDescriptions": [ -"Unspecified enablement state.", -"The module is enabled at the given level.", -"The module is disabled at the given level." +"", +"", +"" ], "readOnly": true, "type": "string" }, "name": { -"description": "Output only. The resource name of the effective ETD custom module. Its format is: * `organizations/{organization}/eventThreatDetectionSettings/effectiveCustomModules/{module}`. * `folders/{folder}/eventThreatDetectionSettings/effectiveCustomModules/{module}`. * `projects/{project}/eventThreatDetectionSettings/effectiveCustomModules/{module}`.", "readOnly": true, "type": "string" }, "type": { -"description": "Output only. Type for the module. e.g. CONFIGURABLE_BAD_IP.", "readOnly": true, "type": "string" } @@ -7867,37 +7206,30 @@ false "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" }, "EnvironmentVariable": { -"description": "A name-value pair representing an environment variable used in an operating system process.", "id": "EnvironmentVariable", "properties": { "name": { -"description": "Environment variable name as a JSON encoded string.", "type": "string" }, "val": { -"description": "Environment variable value as a JSON encoded string.", "type": "string" } }, "type": "object" }, "EventThreatDetectionCustomModule": { -"description": "Represents an instance of an Event Threat Detection custom module, including its full module name, display name, enablement state, and last updated time. You can create a custom module at the organization, folder, or project level. Custom modules that you create at the organization or folder level are inherited by child folders and projects.", "id": "EventThreatDetectionCustomModule", "properties": { "ancestorModule": { -"description": "Output only. The closest ancestor module that this module inherits the enablement state from. The format is the same as the EventThreatDetectionCustomModule resource name.", "readOnly": true, "type": "string" }, "cloudProvider": { -"description": "The cloud provider of the custom module.", "enum": [ "CLOUD_PROVIDER_UNSPECIFIED", "GOOGLE_CLOUD_PLATFORM", @@ -7905,10 +7237,10 @@ false "MICROSOFT_AZURE" ], "enumDescriptions": [ -"Unspecified cloud provider.", -"Google Cloud.", -"Amazon Web Services (AWS).", -"Microsoft Azure." +"", +"", +"", +"" ], "type": "string" }, @@ -7917,19 +7249,15 @@ false "description": "Properties of the object.", "type": "any" }, -"description": "Config for the module. For the resident module, its config value is defined at this level. For the inherited module, its config value is inherited from the ancestor module.", "type": "object" }, "description": { -"description": "The description for the module.", "type": "string" }, "displayName": { -"description": "The human readable name to be displayed for the module.", "type": "string" }, "enablementState": { -"description": "The state of enablement for the module at the given level of the hierarchy.", "enum": [ "ENABLEMENT_STATE_UNSPECIFIED", "ENABLED", @@ -7937,28 +7265,24 @@ false "INHERITED" ], "enumDescriptions": [ -"Unspecified enablement state.", -"The module is enabled at the given level.", -"The module is disabled at the given level.", -"When the enablement state is inherited." +"", +"", +"", +"" ], "type": "string" }, "lastEditor": { -"description": "Output only. The editor the module was last updated by.", "readOnly": true, "type": "string" }, "name": { -"description": "Immutable. The resource name of the Event Threat Detection custom module. Its format is: * `organizations/{organization}/eventThreatDetectionSettings/customModules/{module}`. * `folders/{folder}/eventThreatDetectionSettings/customModules/{module}`. * `projects/{project}/eventThreatDetectionSettings/customModules/{module}`.", "type": "string" }, "type": { -"description": "Type for the module. e.g. CONFIGURABLE_BAD_IP.", "type": "string" }, "updateTime": { -"description": "Output only. The time the module was last updated.", "format": "google-datetime", "readOnly": true, "type": "string" @@ -7967,43 +7291,36 @@ false "type": "object" }, "ExfilResource": { -"description": "Resource where data was exfiltrated from or exfiltrated to.", "id": "ExfilResource", "properties": { "components": { -"description": "Subcomponents of the asset that was exfiltrated, like URIs used during exfiltration, table names, databases, and filenames. For example, multiple tables might have been exfiltrated from the same Cloud SQL instance, or multiple files might have been exfiltrated from the same Cloud Storage bucket.", "items": { "type": "string" }, "type": "array" }, "name": { -"description": "The resource's [full resource name](https://cloud.google.com/apis/design/resource_names#full_resource_name).", "type": "string" } }, "type": "object" }, "Exfiltration": { -"description": "Exfiltration represents a data exfiltration attempt from one or more sources to one or more targets. The `sources` attribute lists the sources of the exfiltrated data. The `targets` attribute lists the destinations the data was copied to.", "id": "Exfiltration", "properties": { "sources": { -"description": "If there are multiple sources, then the data is considered \"joined\" between them. For instance, BigQuery can join multiple tables, and each table would be considered a source.", "items": { "$ref": "ExfilResource" }, "type": "array" }, "targets": { -"description": "If there are multiple targets, each target would get a complete copy of the \"joined\" source data.", "items": { "$ref": "ExfilResource" }, "type": "array" }, "totalExfiltratedBytes": { -"description": "Total exfiltrated bytes processed for the entire job.", "format": "int64", "type": "string" } @@ -8011,15 +7328,12 @@ false "type": "object" }, "ExportFindingsMetadata": { -"description": "The LRO metadata for a ExportFindings request.", "id": "ExportFindingsMetadata", "properties": { "bigQueryDestination": { -"$ref": "BigQueryDestination", -"description": "Required. The destination BigQuery dataset to export findings to." +"$ref": "BigQueryDestination" }, "exportStartTime": { -"description": "Optional. Timestamp at which export was started", "format": "google-datetime", "type": "string" } @@ -8027,176 +7341,139 @@ false "type": "object" }, "ExportFindingsResponse": { -"description": "The response to a ExportFindings request. Contains the LRO information.", "id": "ExportFindingsResponse", "properties": {}, "type": "object" }, "Expr": { -"description": "Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: \"Summary size limit\" description: \"Determines if a summary is less than 100 chars\" expression: \"document.summary.size() < 100\" Example (Equality): title: \"Requestor is owner\" description: \"Determines if requestor is the document owner\" expression: \"document.owner == request.auth.claims.email\" Example (Logic): title: \"Public documents\" description: \"Determine whether the document should be publicly visible\" expression: \"document.type != 'private' && document.type != 'internal'\" Example (Data Manipulation): title: \"Notification string\" description: \"Create a notification string with a timestamp.\" expression: \"'New message received at ' + string(document.create_time)\" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information.", "id": "Expr", "properties": { "description": { -"description": "Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.", "type": "string" }, "expression": { -"description": "Textual representation of an expression in Common Expression Language syntax.", "type": "string" }, "location": { -"description": "Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.", "type": "string" }, "title": { -"description": "Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.", "type": "string" } }, "type": "object" }, "ExternalExposure": { -"description": "Details about the externally exposed resource associated with the finding.", "id": "ExternalExposure", "properties": { "backendBucket": { -"description": "The full resource name of the load balancer backend bucket, for example, \"//compute.googleapis.com/projects/{project-id}/global/backendBuckets/{name}\"", "type": "string" }, "backendService": { -"description": "The full resource name of load balancer backend service, for example, \"//compute.googleapis.com/projects/{project-id}/global/backendServices/{name}\".", "type": "string" }, "exposedApplication": { -"description": "The name and version of the exposed web application, for example, \"Jenkins 2.184\".", "type": "string" }, "exposedEndpoint": { -"description": "The resource which is running the exposed service, for example, \"//compute.googleapis.com/projects/{project-id}/zones/{zone}/instances/{instance}.\u201d", "type": "string" }, "exposedService": { -"description": "The name and version of the service, for example, \"Jupyter Notebook 6.14.0\".", "type": "string" }, "forwardingRule": { -"description": "The full resource name of the forwarding rule, for example, \"//compute.googleapis.com/projects/{project-id}/global/forwardingRules/{forwarding-rule-name}\".", "type": "string" }, "hostnameUri": { -"description": "Hostname of the exposed application, for example, \"https://test-app.a.run.app/\"", "type": "string" }, "httpResponse": { -"description": "The http response returned by the web application.", "items": { "$ref": "HttpResponse" }, "type": "array" }, "instanceGroup": { -"description": "The full resource name of the instance group, for example, \"//compute.googleapis.com/projects/{project-id}/global/instanceGroups/{name}\".", "type": "string" }, "internalBackendService": { -"description": "The full resource name of load balancer backend service in the internal project having resource exposed via PSC, for example, \"//compute.googleapis.com/projects/{project-id}/global/backendServices/{name}\".", "type": "string" }, "loadBalancerFirewallPolicy": { -"description": "The full resource name of the load balancer firewall policy, for example, \"//compute.googleapis.com/projects/{project-id}/global/firewallPolicies/{policy-name}\".", "type": "string" }, "networkEndpointGroup": { -"description": "The full resource name of the network endpoint group, for example, \"//compute.googleapis.com/projects/{project-id}/global/networkEndpointGroups/{name}\".", "type": "string" }, "networkIngressFirewallPolicy": { -"description": "The full resource name of the network ingress firewall policy, for example, \"//compute.googleapis.com/projects/{project-id}/global/firewallPolicies/{name}\".", "type": "string" }, "privateIpAddress": { -"description": "Private IP address of the exposed endpoint.", "type": "string" }, "privatePort": { -"description": "Port number associated with private IP address.", "type": "string" }, "pscNetworkAttachment": { -"description": "The full resource name of the PSC (Private Service Connect) network attachment that network interface controller is attached to, for example, \"//compute.googleapis.com/projects/{project-id}/regions/{region}/networkAttachments/{name}\"", "type": "string" }, "pscServiceAttachment": { -"description": "The full resource name of the PSC (Private Service Connect) service attachment that the load balancer network endpoint group targets, for example, \"//compute.googleapis.com/projects/{project-id}/regions/{region}/serviceAttachments/{name}\"", "type": "string" }, "publicIpAddress": { -"description": "Public IP address of the exposed endpoint.", "type": "string" }, "publicPort": { -"description": "Public port number of the exposed endpoint.", "type": "string" }, "serviceFirewallPolicy": { -"description": "The full resource name of the firewall policy of the exposed service, for example, \"//compute.googleapis.com/projects/{project-id}/global/firewallPolicies/{policy-name}\".", "type": "string" } }, "type": "object" }, "File": { -"description": "File information about the related binary/library used by an executable, or the script used by a script interpreter", "id": "File", "properties": { "contents": { -"description": "Prefix of the file contents as a JSON-encoded string.", "type": "string" }, "diskPath": { -"$ref": "DiskPath", -"description": "Path of the file in terms of underlying disk/partition identifiers." +"$ref": "DiskPath" }, "fileLoadState": { -"description": "The load state of the file.", "enum": [ "FILE_LOAD_STATE_UNSPECIFIED", "LOADED_BY_PROCESS", "NOT_LOADED_BY_PROCESS" ], "enumDescriptions": [ -"The file state is unspecified.", -"The file is being used by an active process at the time of scanning.", -"The file is not being used by any active process at the time of scanning." +"", +"", +"" ], "type": "string" }, "hashedSize": { -"description": "The length in bytes of the file prefix that was hashed. If hashed_size == size, any hashes reported represent the entire file.", "format": "int64", "type": "string" }, "operations": { -"description": "Operation(s) performed on a file.", "items": { "$ref": "FileOperation" }, "type": "array" }, "partiallyHashed": { -"description": "True when the hash covers only a prefix of the file.", "type": "boolean" }, "path": { -"description": "Absolute path of the file as a JSON encoded string.", "type": "string" }, "sha256": { -"description": "SHA256 hash of the first hashed_size bytes of the file encoded as a hex string. If hashed_size == size, sha256 represents the SHA256 hash of the entire file.", "type": "string" }, "size": { -"description": "Size of the file in bytes.", "format": "int64", "type": "string" } @@ -8204,11 +7481,9 @@ false "type": "object" }, "FileOperation": { -"description": "Operation(s) performed on a file.", "id": "FileOperation", "properties": { "type": { -"description": "The type of the operation", "enum": [ "OPERATION_TYPE_UNSPECIFIED", "OPEN", @@ -8218,12 +7493,12 @@ false "EXECUTE" ], "enumDescriptions": [ -"The operation is unspecified.", -"Represents an open operation.", -"Represents a read operation.", -"Represents a rename operation.", -"Represents a write operation.", -"Represents an execute operation." +"", +"", +"", +"", +"", +"" ], "type": "string" } @@ -8231,81 +7506,63 @@ false "type": "object" }, "Finding": { -"description": "Security Command Center finding. A finding is a record of assessment data like security, risk, health, or privacy, that is ingested into Security Command Center for presentation, notification, analysis, policy testing, and enforcement. For example, a cross-site scripting (XSS) vulnerability in an App Engine application is a finding.", "id": "Finding", "properties": { "access": { -"$ref": "Access", -"description": "Access details associated with the finding, such as more information on the caller, which method was accessed, and from where." +"$ref": "Access" }, "affectedResources": { -"$ref": "AffectedResources", -"description": "AffectedResources associated with the finding." +"$ref": "AffectedResources" }, "agentDataAccessEvents": { -"description": "Agent data access events associated with the finding.", "items": { "$ref": "AgentDataAccessEvent" }, "type": "array" }, "aiModel": { -"$ref": "AiModel", -"description": "The AI model associated with the finding." +"$ref": "AiModel" }, "application": { -"$ref": "Application", -"description": "Represents an application associated with the finding." +"$ref": "Application" }, "artifactGuardPolicies": { -"$ref": "ArtifactGuardPolicies", -"description": "ArtifactGuardPolicies associated with the finding." +"$ref": "ArtifactGuardPolicies" }, "attackExposure": { -"$ref": "AttackExposure", -"description": "The results of an attack path simulation relevant to this finding." +"$ref": "AttackExposure" }, "backupDisasterRecovery": { -"$ref": "BackupDisasterRecovery", -"description": "Fields related to Backup and DR findings." +"$ref": "BackupDisasterRecovery" }, "canonicalName": { -"description": "The canonical name of the finding. It's either \"organizations/{organization_id}/sources/{source_id}/findings/{finding_id}\", \"folders/{folder_id}/sources/{source_id}/findings/{finding_id}\" or \"projects/{project_number}/sources/{source_id}/findings/{finding_id}\", depending on the closest CRM ancestor of the resource associated with the finding.", "type": "string" }, "category": { -"description": "The additional taxonomy group within findings from a given source. This field is immutable after creation time. Example: \"XSS_FLASH_INJECTION\"", "type": "string" }, "chokepoint": { -"$ref": "Chokepoint", -"description": "Contains details about a chokepoint, which is a resource or resource group where high-risk attack paths converge, based on [attack path simulations] (https://cloud.google.com/security-command-center/docs/attack-exposure-learn#attack_path_simulations). This field cannot be updated. Its value is ignored in all update requests." +"$ref": "Chokepoint" }, "cloudArmor": { -"$ref": "CloudArmor", -"description": "Fields related to Cloud Armor findings." +"$ref": "CloudArmor" }, "cloudDlpDataProfile": { -"$ref": "CloudDlpDataProfile", -"description": "Cloud DLP data profile that is associated with the finding." +"$ref": "CloudDlpDataProfile" }, "cloudDlpInspection": { -"$ref": "CloudDlpInspection", -"description": "Cloud Data Loss Prevention (Cloud DLP) inspection results that are associated with the finding." +"$ref": "CloudDlpInspection" }, "complianceDetails": { -"$ref": "ComplianceDetails", -"description": "Details about the compliance implications of the finding." +"$ref": "ComplianceDetails" }, "compliances": { -"description": "Contains compliance information for security standards associated to the finding.", "items": { "$ref": "Compliance" }, "type": "array" }, "connections": { -"description": "Contains information about the IP connection associated with the finding.", "items": { "$ref": "Connection" }, @@ -8315,93 +7572,76 @@ false "additionalProperties": { "$ref": "ContactDetails" }, -"description": "Output only. Map containing the points of contact for the given finding. The key represents the type of contact, while the value contains a list of all the contacts that pertain. Please refer to: https://cloud.google.com/resource-manager/docs/managing-notification-contacts#notification-categories { \"security\": { \"contacts\": [ { \"email\": \"person1@company.com\" }, { \"email\": \"person2@company.com\" } ] } }", "readOnly": true, "type": "object" }, "containers": { -"description": "Containers associated with the finding. This field provides information for both Kubernetes and non-Kubernetes containers.", "items": { "$ref": "Container" }, "type": "array" }, "createTime": { -"description": "The time at which the finding was created in Security Command Center.", "format": "google-datetime", "type": "string" }, "dataAccessEvents": { -"description": "Data access events associated with the finding.", "items": { "$ref": "DataAccessEvent" }, "type": "array" }, "dataFlowEvents": { -"description": "Data flow events associated with the finding.", "items": { "$ref": "DataFlowEvent" }, "type": "array" }, "dataRetentionDeletionEvents": { -"description": "Data retention deletion events associated with the finding.", "items": { "$ref": "DataRetentionDeletionEvent" }, "type": "array" }, "database": { -"$ref": "Database", -"description": "Database associated with the finding." +"$ref": "Database" }, "description": { -"description": "Contains more details about the finding.", "type": "string" }, "discoveredWorkload": { -"$ref": "DiscoveredWorkload", -"description": "DiscoveredWorkload associated with the finding." +"$ref": "DiscoveredWorkload" }, "disk": { -"$ref": "Disk", -"description": "Disk associated with the finding." +"$ref": "Disk" }, "eventTime": { -"description": "The time the finding was first detected. If an existing finding is updated, then this is the time the update occurred. For example, if the finding represents an open firewall, this property captures the time the detector believes the firewall became open. The accuracy is determined by the detector. If the finding is later resolved, then this time reflects when the finding was resolved. This must not be set to a value greater than the current timestamp.", "format": "google-datetime", "type": "string" }, "exfiltration": { -"$ref": "Exfiltration", -"description": "Represents exfiltrations associated with the finding." +"$ref": "Exfiltration" }, "externalExposure": { -"$ref": "ExternalExposure", -"description": "External exposure associated with the finding." +"$ref": "ExternalExposure" }, "externalSystems": { "additionalProperties": { "$ref": "GoogleCloudSecuritycenterV1ExternalSystem" }, -"description": "Output only. Third party SIEM/SOAR fields within SCC, contains external system information and external system finding fields.", "readOnly": true, "type": "object" }, "externalUri": { -"description": "The URI that, if available, points to a web page outside of Security Command Center where additional information about the finding can be found. This field is guaranteed to be either empty or a well formed URL.", "type": "string" }, "files": { -"description": "File associated with the finding.", "items": { "$ref": "File" }, "type": "array" }, "findingClass": { -"description": "The class of the finding.", "enum": [ "FINDING_CLASS_UNSPECIFIED", "THREAT", @@ -8417,79 +7657,67 @@ false "SECRET" ], "enumDescriptions": [ -"Unspecified finding class.", -"Describes unwanted or malicious activity.", -"Describes a potential weakness in software that increases risk to Confidentiality & Integrity & Availability.", -"Describes a potential weakness in cloud resource/asset configuration that increases risk.", -"Describes a security observation that is for informational purposes.", -"Describes an error that prevents some SCC functionality.", -"Describes a potential security risk due to a change in the security posture.", -"Describes a group of security issues that, when the issues occur together, represent a greater risk than when the issues occur independently. A group of such issues is referred to as a toxic combination.", -"Describes a potential security risk to data assets that contain sensitive data.", -"Describes a resource or resource group where high risk attack paths converge, based on attack path simulations (APS).", -"Describes a potential security risk due to the resource being exposed to the internet.", -"Describes a potential security risk due to plaintext credentials, keys, or tokens being exposed in an asset or workload." +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"" ], "type": "string" }, "groupMemberships": { -"description": "Contains details about groups of which this finding is a member. A group is a collection of findings that are related in some way. This field cannot be updated. Its value is ignored in all update requests.", "items": { "$ref": "GroupMembership" }, "type": "array" }, "iamBindings": { -"description": "Represents IAM bindings associated with the finding.", "items": { "$ref": "IamBinding" }, "type": "array" }, "indicator": { -"$ref": "Indicator", -"description": "Represents what's commonly known as an *indicator of compromise* (IoC) in computer forensics. This is an artifact observed on a network or in an operating system that, with high confidence, indicates a computer intrusion. For more information, see [Indicator of compromise](https://en.wikipedia.org/wiki/Indicator_of_compromise)." +"$ref": "Indicator" }, "ipRules": { -"$ref": "IpRules", -"description": "IP rules associated with the finding." +"$ref": "IpRules" }, "job": { -"$ref": "Job", -"description": "Job associated with the finding." +"$ref": "Job" }, "kernelRootkit": { -"$ref": "KernelRootkit", -"description": "Signature of the kernel rootkit." +"$ref": "KernelRootkit" }, "kubernetes": { -"$ref": "Kubernetes", -"description": "Kubernetes resources associated with the finding." +"$ref": "Kubernetes" }, "loadBalancers": { -"description": "The load balancers associated with the finding.", "items": { "$ref": "LoadBalancer" }, "type": "array" }, "logEntries": { -"description": "Log entries that are relevant to the finding.", "items": { "$ref": "LogEntry" }, "type": "array" }, "mitreAttack": { -"$ref": "MitreAttack", -"description": "MITRE ATT&CK tactics and techniques related to this finding. See: https://attack.mitre.org" +"$ref": "MitreAttack" }, "moduleName": { -"description": "Unique identifier of the module which generated the finding. Example: folders/598186756061/securityHealthAnalyticsSettings/customModules/56799441161885", "type": "string" }, "mute": { -"description": "Indicates the mute state of a finding (either muted, unmuted or undefined). Unlike other attributes of a finding, a finding provider shouldn't set the value of mute.", "enum": [ "MUTE_UNSPECIFIED", "MUTED", @@ -8497,93 +7725,76 @@ false "UNDEFINED" ], "enumDescriptions": [ -"Unspecified.", -"Finding has been muted.", -"Finding has been unmuted.", -"Finding has never been muted/unmuted." +"", +"", +"", +"" ], "type": "string" }, "muteInfo": { "$ref": "MuteInfo", -"description": "Output only. The mute information regarding this finding.", "readOnly": true }, "muteInitiator": { -"description": "Records additional information about the mute operation, for example, the [mute configuration](/security-command-center/docs/how-to-mute-findings) that muted the finding and the user who muted the finding.", "type": "string" }, "muteUpdateTime": { -"description": "Output only. The most recent time this finding was muted or unmuted.", "format": "google-datetime", "readOnly": true, "type": "string" }, "name": { -"description": "The [relative resource name](https://cloud.google.com/apis/design/resource_names#relative_resource_name) of the finding. Example: \"organizations/{organization_id}/sources/{source_id}/findings/{finding_id}\", \"folders/{folder_id}/sources/{source_id}/findings/{finding_id}\", \"projects/{project_id}/sources/{source_id}/findings/{finding_id}\".", "type": "string" }, "networks": { -"description": "Represents the VPC networks that the resource is attached to.", "items": { "$ref": "Network" }, "type": "array" }, "nextSteps": { -"description": "Steps to address the finding.", "type": "string" }, "notebook": { -"$ref": "Notebook", -"description": "Notebook associated with the finding." +"$ref": "Notebook" }, "orgPolicies": { -"description": "Contains information about the org policies associated with the finding.", "items": { "$ref": "OrgPolicy" }, "type": "array" }, "parent": { -"description": "The relative resource name of the source the finding belongs to. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name This field is immutable after creation time. For example: \"organizations/{organization_id}/sources/{source_id}\"", "type": "string" }, "parentDisplayName": { -"description": "Output only. The human readable display name of the finding source such as \"Event Threat Detection\" or \"Security Health Analytics\".", "readOnly": true, "type": "string" }, "policyViolationSummary": { -"$ref": "PolicyViolationSummary", -"description": "PolicyViolationSummary associated with the finding." +"$ref": "PolicyViolationSummary" }, "processes": { -"description": "Represents operating system processes associated with the Finding.", "items": { "$ref": "Process" }, "type": "array" }, "resourceName": { -"description": "For findings on Google Cloud resources, the full resource name of the Google Cloud resource this finding is for. See: https://cloud.google.com/apis/design/resource_names#full_resource_name When the finding is for a non-Google Cloud resource, the resourceName can be a customer or partner defined string. This field is immutable after creation time.", "type": "string" }, "secret": { -"$ref": "Secret", -"description": "Secret associated with the finding." +"$ref": "Secret" }, "securityMarks": { "$ref": "SecurityMarks", -"description": "Output only. User specified security marks. These marks are entirely managed by the user and come from the SecurityMarks resource that belongs to the finding.", "readOnly": true }, "securityPosture": { -"$ref": "SecurityPosture", -"description": "The security posture associated with the finding." +"$ref": "SecurityPosture" }, "severity": { -"description": "The severity of the finding. This field is managed by the source that writes the finding.", "enum": [ "SEVERITY_UNSPECIFIED", "CRITICAL", @@ -8592,11 +7803,11 @@ false "LOW" ], "enumDescriptions": [ -"This value is used for findings when a source doesn't write a severity value.", -"Vulnerability: A critical vulnerability is easily discoverable by an external actor, exploitable, and results in the direct ability to execute arbitrary code, exfiltrate data, and otherwise gain additional access and privileges to cloud resources and workloads. Examples include publicly accessible unprotected user data and public SSH access with weak or no passwords. Threat: Indicates a threat that is able to access, modify, or delete data or execute unauthorized code within existing resources.", -"Vulnerability: A high risk vulnerability can be easily discovered and exploited in combination with other vulnerabilities in order to gain direct access and the ability to execute arbitrary code, exfiltrate data, and otherwise gain additional access and privileges to cloud resources and workloads. An example is a database with weak or no passwords that is only accessible internally. This database could easily be compromised by an actor that had access to the internal network. Threat: Indicates a threat that is able to create new computational resources in an environment but not able to access data or execute code in existing resources.", -"Vulnerability: A medium risk vulnerability could be used by an actor to gain access to resources or privileges that enable them to eventually (through multiple steps or a complex exploit) gain access and the ability to execute arbitrary code or exfiltrate data. An example is a service account with access to more projects than it should have. If an actor gains access to the service account, they could potentially use that access to manipulate a project the service account was not intended to. Threat: Indicates a threat that is able to cause operational impact but may not access data or execute unauthorized code.", -"Vulnerability: A low risk vulnerability hampers a security organization's ability to detect vulnerabilities or active threats in their deployment, or prevents the root cause investigation of security issues. An example is monitoring and logs being disabled for resource configurations and access. Threat: Indicates a threat that has obtained minimal access to an environment but is not able to access data, execute code, or create resources." +"", +"", +"", +"", +"" ], "type": "string" }, @@ -8604,59 +7815,49 @@ false "additionalProperties": { "type": "any" }, -"description": "Source specific properties. These properties are managed by the source that writes the finding. The key names in the source_properties map must be between 1 and 255 characters, and must start with a letter and contain alphanumeric characters or underscores only.", "type": "object" }, "state": { -"description": "The state of the finding.", "enum": [ "STATE_UNSPECIFIED", "ACTIVE", "INACTIVE" ], "enumDescriptions": [ -"Unspecified state.", -"The finding requires attention and has not been addressed yet.", -"The finding has been fixed, triaged as a non-issue or otherwise addressed and is no longer active." +"", +"", +"" ], "type": "string" }, "toxicCombination": { -"$ref": "ToxicCombination", -"description": "Contains details about a group of security issues that, when the issues occur together, represent a greater risk than when the issues occur independently. A group of such issues is referred to as a toxic combination. This field cannot be updated. Its value is ignored in all update requests." +"$ref": "ToxicCombination" }, "vertexAi": { -"$ref": "VertexAi", -"description": "VertexAi associated with the finding." +"$ref": "VertexAi" }, "vulnerability": { -"$ref": "Vulnerability", -"description": "Represents vulnerability-specific fields like CVE and CVSS scores. CVE stands for Common Vulnerabilities and Exposures (https://cve.mitre.org/about/)" +"$ref": "Vulnerability" } }, "type": "object" }, "Folder": { -"description": "Message that contains the resource name and display name of a folder resource.", "id": "Folder", "properties": { "resourceFolder": { -"description": "Full resource name of this folder. See: https://cloud.google.com/apis/design/resource_names#full_resource_name", "type": "string" }, "resourceFolderDisplayName": { -"description": "The user defined display name for this folder.", "type": "string" } }, "type": "object" }, "Framework": { -"description": "Compliance framework associated with the finding.", "id": "Framework", "properties": { "category": { -"description": "Category of the framework associated with the finding. E.g. Security Benchmark, or Assured Workloads", "items": { "enum": [ "FRAMEWORK_CATEGORY_UNSPECIFIED", @@ -8667,43 +7868,39 @@ false "CUSTOM_FRAMEWORK" ], "enumDescriptions": [ -"Default value. This value is unused.", -"Security Benchmarks framework", -"Assured Workloads framework", -"Data Security framework", -"Google Best Practices framework", -"A user-created framework" +"", +"", +"", +"", +"", +"" ], "type": "string" }, "type": "array" }, "controls": { -"description": "The controls associated with the framework.", "items": { "$ref": "Control" }, "type": "array" }, "displayName": { -"description": "Display name of the framework. For a standard framework, this will look like e.g. PCI DSS 3.2.1, whereas for a custom framework it can be a user defined string like MyFramework", "type": "string" }, "name": { -"description": "Name of the framework associated with the finding", "type": "string" }, "type": { -"description": "Type of the framework associated with the finding, to specify whether the framework is built-in (pre-defined and immutable) or a custom framework defined by the customer (equivalent to security posture)", "enum": [ "FRAMEWORK_TYPE_UNSPECIFIED", "FRAMEWORK_TYPE_BUILT_IN", "FRAMEWORK_TYPE_CUSTOM" ], "enumDescriptions": [ -"Default value. This value is unused.", -"The framework is a built-in framework if it is created and managed by GCP.", -"The framework is a custom framework if it is created and managed by the user." +"", +"", +"" ], "type": "string" } @@ -8711,11 +7908,9 @@ false "type": "object" }, "GcpMetadata": { -"description": "Google Cloud metadata associated with the resource. Only applicable if the finding's cloud provider is Google Cloud.", "id": "GcpMetadata", "properties": { "folders": { -"description": "Output only. Contains a Folder message for each folder in the assets ancestry. The first folder is the deepest nested folder, and the last folder is the folder directly under the Organization.", "items": { "$ref": "GoogleCloudSecuritycenterV2Folder" }, @@ -8723,56 +7918,45 @@ false "type": "array" }, "organization": { -"description": "The name of the organization that the resource belongs to.", "type": "string" }, "parent": { -"description": "The full resource name of resource's parent.", "type": "string" }, "parentDisplayName": { -"description": "The human readable name of resource's parent.", "type": "string" }, "project": { -"description": "The full resource name of project that the resource belongs to.", "type": "string" }, "projectDisplayName": { -"description": "The project ID that the resource belongs to.", "type": "string" } }, "type": "object" }, "Geolocation": { -"description": "Represents a geographical location for a given access.", "id": "Geolocation", "properties": { "regionCode": { -"description": "A CLDR.", "type": "string" } }, "type": "object" }, "GetIamPolicyRequest": { -"description": "Request message for `GetIamPolicy` method.", "id": "GetIamPolicyRequest", "properties": { "options": { -"$ref": "GetPolicyOptions", -"description": "OPTIONAL: A `GetPolicyOptions` object for specifying options to `GetIamPolicy`." +"$ref": "GetPolicyOptions" } }, "type": "object" }, "GetPolicyOptions": { -"description": "Encapsulates settings provided to GetIamPolicy.", "id": "GetPolicyOptions", "properties": { "requestedPolicyVersion": { -"description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", "format": "int32", "type": "integer" } @@ -8780,43 +7964,34 @@ false "type": "object" }, "GoogleCloudSecuritycenterV1BigQueryExport": { -"description": "Configures how to deliver Findings to BigQuery Instance.", "id": "GoogleCloudSecuritycenterV1BigQueryExport", "properties": { "createTime": { -"description": "Output only. The time at which the BigQuery export was created. This field is set by the server and will be ignored if provided on export on creation.", "format": "google-datetime", "readOnly": true, "type": "string" }, "dataset": { -"description": "The dataset to write findings' updates to. Its format is \"projects/[project_id]/datasets/[bigquery_dataset_id]\". BigQuery Dataset unique ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_).", "type": "string" }, "description": { -"description": "The description of the export (max of 1024 characters).", "type": "string" }, "filter": { -"description": "Expression that defines the filter to apply across create/update events of findings. The expression is a list of zero or more restrictions combined via logical operators `AND` and `OR`. Parentheses are supported, and `OR` has higher precedence than `AND`. Restrictions have the form ` ` and may have a `-` character in front of them to indicate negation. The fields map to those defined in the corresponding resource. The supported operators are: * `=` for all value types. * `>`, `<`, `>=`, `<=` for integer values. * `:`, meaning substring matching, for strings. The supported value types are: * string literals in quotes. * integer literals without quotes. * boolean literals `true` and `false` without quotes.", "type": "string" }, "mostRecentEditor": { -"description": "Output only. Email address of the user who last edited the BigQuery export. This field is set by the server and will be ignored if provided on export creation or update.", "readOnly": true, "type": "string" }, "name": { -"description": "The relative resource name of this export. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name. Example format: \"organizations/{organization_id}/bigQueryExports/{export_id}\" Example format: \"folders/{folder_id}/bigQueryExports/{export_id}\" Example format: \"projects/{project_id}/bigQueryExports/{export_id}\" This field is provided in responses, and is ignored when provided in create requests.", "type": "string" }, "principal": { -"description": "Output only. The service account that needs permission to create table and upload data to the BigQuery dataset.", "readOnly": true, "type": "string" }, "updateTime": { -"description": "Output only. The most recent time at which the BigQuery export was updated. This field is set by the server and will be ignored if provided on export creation or update.", "format": "google-datetime", "readOnly": true, "type": "string" @@ -8825,23 +8000,18 @@ false "type": "object" }, "GoogleCloudSecuritycenterV1Binding": { -"description": "Represents a Kubernetes RoleBinding or ClusterRoleBinding.", "id": "GoogleCloudSecuritycenterV1Binding", "properties": { "name": { -"description": "Name for the binding.", "type": "string" }, "ns": { -"description": "Namespace for the binding.", "type": "string" }, "role": { -"$ref": "Role", -"description": "The Role or ClusterRole referenced by the binding." +"$ref": "Role" }, "subjects": { -"description": "Represents one or more subjects that are bound to the role. Not always available for PATCH requests.", "items": { "$ref": "Subject" }, @@ -8851,37 +8021,29 @@ false "type": "object" }, "GoogleCloudSecuritycenterV1BulkMuteFindingsResponse": { -"description": "The response to a BulkMute request. Contains the LRO information.", "id": "GoogleCloudSecuritycenterV1BulkMuteFindingsResponse", "properties": {}, "type": "object" }, "GoogleCloudSecuritycenterV1CustomConfig": { -"description": "Defines the properties in a custom module configuration for Security Health Analytics. Use the custom module configuration to create custom detectors that generate custom findings for resources that you specify.", "id": "GoogleCloudSecuritycenterV1CustomConfig", "properties": { "customOutput": { -"$ref": "GoogleCloudSecuritycenterV1CustomOutputSpec", -"description": "Custom output properties." +"$ref": "GoogleCloudSecuritycenterV1CustomOutputSpec" }, "description": { -"description": "Text that describes the vulnerability or misconfiguration that the custom module detects. This explanation is returned with each finding instance to help investigators understand the detected issue. The text must be enclosed in quotation marks.", "type": "string" }, "predicate": { -"$ref": "Expr", -"description": "The CEL expression to evaluate to produce findings. When the expression evaluates to true against a resource, a finding is generated." +"$ref": "Expr" }, "recommendation": { -"description": "An explanation of the recommended steps that security teams can take to resolve the detected issue. This explanation is returned with each finding generated by this module in the `nextSteps` property of the finding JSON.", "type": "string" }, "resourceSelector": { -"$ref": "GoogleCloudSecuritycenterV1ResourceSelector", -"description": "The resource types that the custom module operates on. Each custom module can specify up to 5 resource types." +"$ref": "GoogleCloudSecuritycenterV1ResourceSelector" }, "severity": { -"description": "The severity to assign to findings generated by the module.", "enum": [ "SEVERITY_UNSPECIFIED", "CRITICAL", @@ -8890,11 +8052,11 @@ false "LOW" ], "enumDescriptions": [ -"Unspecified severity.", -"Critical severity.", -"High severity.", -"Medium severity.", -"Low severity." +"", +"", +"", +"", +"" ], "type": "string" } @@ -8902,11 +8064,9 @@ false "type": "object" }, "GoogleCloudSecuritycenterV1CustomOutputSpec": { -"description": "A set of optional name-value pairs that define custom source properties to return with each finding that is generated by the custom module. The custom source properties that are defined here are included in the finding JSON under `sourceProperties`.", "id": "GoogleCloudSecuritycenterV1CustomOutputSpec", "properties": { "properties": { -"description": "A list of custom output properties to add to the finding.", "items": { "$ref": "GoogleCloudSecuritycenterV1Property" }, @@ -8916,11 +8076,9 @@ false "type": "object" }, "GoogleCloudSecuritycenterV1EffectiveSecurityHealthAnalyticsCustomModule": { -"description": "An EffectiveSecurityHealthAnalyticsCustomModule is the representation of a Security Health Analytics custom module at a specified level of the resource hierarchy: organization, folder, or project. If a custom module is inherited from a parent organization or folder, the value of the `enablementState` property in EffectiveSecurityHealthAnalyticsCustomModule is set to the value that is effective in the parent, instead of `INHERITED`. For example, if the module is enabled in a parent organization or folder, the effective enablement_state for the module in all child folders or projects is also `enabled`. EffectiveSecurityHealthAnalyticsCustomModule is read-only.", "id": "GoogleCloudSecuritycenterV1EffectiveSecurityHealthAnalyticsCustomModule", "properties": { "cloudProvider": { -"description": "The cloud provider of the custom module.", "enum": [ "CLOUD_PROVIDER_UNSPECIFIED", "GOOGLE_CLOUD_PLATFORM", @@ -8928,40 +8086,36 @@ false "MICROSOFT_AZURE" ], "enumDescriptions": [ -"Unspecified cloud provider.", -"Google Cloud.", -"Amazon Web Services.", -"Microsoft Azure." +"", +"", +"", +"" ], "type": "string" }, "customConfig": { "$ref": "GoogleCloudSecuritycenterV1CustomConfig", -"description": "Output only. The user-specified configuration for the module.", "readOnly": true }, "displayName": { -"description": "Output only. The display name for the custom module. The name must be between 1 and 128 characters, start with a lowercase letter, and contain alphanumeric characters or underscores only.", "readOnly": true, "type": "string" }, "enablementState": { -"description": "Output only. The effective state of enablement for the module at the given level of the hierarchy.", "enum": [ "ENABLEMENT_STATE_UNSPECIFIED", "ENABLED", "DISABLED" ], "enumDescriptions": [ -"Unspecified enablement state.", -"The module is enabled at the given level.", -"The module is disabled at the given level." +"", +"", +"" ], "readOnly": true, "type": "string" }, "name": { -"description": "Output only. The resource name of the custom module. Its format is \"organizations/{organization}/securityHealthAnalyticsSettings/effectiveCustomModules/{customModule}\", or \"folders/{folder}/securityHealthAnalyticsSettings/effectiveCustomModules/{customModule}\", or \"projects/{project}/securityHealthAnalyticsSettings/effectiveCustomModules/{customModule}\"", "readOnly": true, "type": "string" } @@ -8969,116 +8123,94 @@ false "type": "object" }, "GoogleCloudSecuritycenterV1ExternalSystem": { -"description": "Representation of third party SIEM/SOAR fields within SCC.", "id": "GoogleCloudSecuritycenterV1ExternalSystem", "properties": { "assignees": { -"description": "References primary/secondary etc assignees in the external system.", "items": { "type": "string" }, "type": "array" }, "caseCloseTime": { -"description": "The time when the case was closed, as reported by the external system.", "format": "google-datetime", "type": "string" }, "caseCreateTime": { -"description": "The time when the case was created, as reported by the external system.", "format": "google-datetime", "type": "string" }, "casePriority": { -"description": "The priority of the finding's corresponding case in the external system.", "type": "string" }, "caseSla": { -"description": "The SLA of the finding's corresponding case in the external system.", "format": "google-datetime", "type": "string" }, "caseUri": { -"description": "The link to the finding's corresponding case in the external system.", "type": "string" }, "externalSystemUpdateTime": { -"description": "The time when the case was last updated, as reported by the external system.", "format": "google-datetime", "type": "string" }, "externalUid": { -"description": "The identifier that's used to track the finding's corresponding case in the external system.", "type": "string" }, "name": { -"description": "Full resource name of the external system, for example: \"organizations/1234/sources/5678/findings/123456/externalSystems/jira\", \"folders/1234/sources/5678/findings/123456/externalSystems/jira\", \"projects/1234/sources/5678/findings/123456/externalSystems/jira\"", "type": "string" }, "status": { -"description": "The most recent status of the finding's corresponding case, as reported by the external system.", "type": "string" }, "ticketInfo": { -"$ref": "TicketInfo", -"description": "Information about the ticket, if any, that is being used to track the resolution of the issue that is identified by this finding." +"$ref": "TicketInfo" } }, "type": "object" }, "GoogleCloudSecuritycenterV1MuteConfig": { -"description": "A mute config is a Cloud SCC resource that contains the configuration to mute create/update events of findings.", "id": "GoogleCloudSecuritycenterV1MuteConfig", "properties": { "createTime": { -"description": "Output only. The time at which the mute config was created. This field is set by the server and will be ignored if provided on config creation.", "format": "google-datetime", "readOnly": true, "type": "string" }, "description": { -"description": "A description of the mute config.", "type": "string" }, "displayName": { "deprecated": true, -"description": "The human readable name to be displayed for the mute config.", "type": "string" }, "expiryTime": { -"description": "Optional. The expiry of the mute config. Only applicable for dynamic configs. If the expiry is set, when the config expires, it is removed from all findings.", "format": "google-datetime", "type": "string" }, "filter": { -"description": "Required. An expression that defines the filter to apply across create/update events of findings. While creating a filter string, be mindful of the scope in which the mute configuration is being created. E.g., If a filter contains project = X but is created under the project = Y scope, it might not match any findings. The following field and operator combinations are supported: * severity: `=`, `:` * category: `=`, `:` * resource.name: `=`, `:` * resource.project_name: `=`, `:` * resource.project_display_name: `=`, `:` * resource.folders.resource_folder: `=`, `:` * resource.parent_name: `=`, `:` * resource.parent_display_name: `=`, `:` * resource.type: `=`, `:` * finding_class: `=`, `:` * indicator.ip_addresses: `=`, `:` * indicator.domains: `=`, `:`", "type": "string" }, "mostRecentEditor": { -"description": "Output only. Email address of the user who last edited the mute config. This field is set by the server and will be ignored if provided on config creation or update.", "readOnly": true, "type": "string" }, "name": { -"description": "This field will be ignored if provided on config creation. Format `organizations/{organization}/muteConfigs/{mute_config}` `folders/{folder}/muteConfigs/{mute_config}` `projects/{project}/muteConfigs/{mute_config}` `organizations/{organization}/locations/global/muteConfigs/{mute_config}` `folders/{folder}/locations/global/muteConfigs/{mute_config}` `projects/{project}/locations/global/muteConfigs/{mute_config}`", "type": "string" }, "type": { -"description": "Optional. The type of the mute config, which determines what type of mute state the config affects. The static mute state takes precedence over the dynamic mute state. Immutable after creation. STATIC by default if not set during creation.", "enum": [ "MUTE_CONFIG_TYPE_UNSPECIFIED", "STATIC", "DYNAMIC" ], "enumDescriptions": [ -"Unused.", -"A static mute config, which sets the static mute state of future matching findings to muted. Once the static mute state has been set, finding or config modifications will not affect the state.", -"A dynamic mute config, which is applied to existing and future matching findings, setting their dynamic mute state to \"muted\". If the config is updated or deleted, or a matching finding is updated, such that the finding doesn't match the config, the config will be removed from the finding, and the finding's dynamic mute state may become \"unmuted\" (unless other configs still match)." +"", +"", +"" ], "type": "string" }, "updateTime": { -"description": "Output only. The most recent time at which the mute config was updated. This field is set by the server and will be ignored if provided on config creation or update.", "format": "google-datetime", "readOnly": true, "type": "string" @@ -9087,69 +8219,54 @@ false "type": "object" }, "GoogleCloudSecuritycenterV1NotificationMessage": { -"description": "Cloud SCC's Notification", "id": "GoogleCloudSecuritycenterV1NotificationMessage", "properties": { "finding": { -"$ref": "Finding", -"description": "If it's a Finding based notification config, this field will be populated." +"$ref": "Finding" }, "notificationConfigName": { -"description": "Name of the notification config that generated current notification.", "type": "string" }, "resource": { -"$ref": "GoogleCloudSecuritycenterV1Resource", -"description": "The Cloud resource tied to this notification's Finding." +"$ref": "GoogleCloudSecuritycenterV1Resource" } }, "type": "object" }, "GoogleCloudSecuritycenterV1Property": { -"description": "An individual name-value pair that defines a custom source property.", "id": "GoogleCloudSecuritycenterV1Property", "properties": { "name": { -"description": "Name of the property for the custom output.", "type": "string" }, "valueExpression": { -"$ref": "Expr", -"description": "The CEL expression for the custom output. A resource property can be specified to return the value of the property or a text string enclosed in quotation marks." +"$ref": "Expr" } }, "type": "object" }, "GoogleCloudSecuritycenterV1Resource": { -"description": "Information related to the Google Cloud resource.", "id": "GoogleCloudSecuritycenterV1Resource", "properties": { "adcApplication": { -"$ref": "AdcApplication", -"description": "The ADC application associated with the finding." +"$ref": "AdcApplication" }, "adcApplicationTemplate": { -"$ref": "AdcApplicationTemplateRevision", -"description": "The ADC template associated with the finding." +"$ref": "AdcApplicationTemplateRevision" }, "adcSharedTemplate": { -"$ref": "AdcSharedTemplateRevision", -"description": "The ADC shared template associated with the finding." +"$ref": "AdcSharedTemplateRevision" }, "application": { -"$ref": "GoogleCloudSecuritycenterV1ResourceApplication", -"description": "The App Hub application this resource belongs to." +"$ref": "GoogleCloudSecuritycenterV1ResourceApplication" }, "awsMetadata": { -"$ref": "AwsMetadata", -"description": "The AWS metadata associated with the finding." +"$ref": "AwsMetadata" }, "azureMetadata": { -"$ref": "AzureMetadata", -"description": "The Azure metadata associated with the finding." +"$ref": "AzureMetadata" }, "cloudProvider": { -"description": "Indicates which cloud provider the resource resides in.", "enum": [ "CLOUD_PROVIDER_UNSPECIFIED", "GOOGLE_CLOUD_PLATFORM", @@ -9157,19 +8274,17 @@ false "MICROSOFT_AZURE" ], "enumDescriptions": [ -"The cloud provider is unspecified.", -"The cloud provider is Google Cloud.", -"The cloud provider is Amazon Web Services.", -"The cloud provider is Microsoft Azure." +"", +"", +"", +"" ], "type": "string" }, "displayName": { -"description": "The human readable name of the resource.", "type": "string" }, "folders": { -"description": "Output only. Contains a Folder message for each folder in the assets ancestry. The first folder is the deepest nested folder, and the last folder is the folder directly under the Organization.", "items": { "$ref": "Folder" }, @@ -9177,95 +8292,75 @@ false "type": "array" }, "location": { -"description": "The region or location of the service (if applicable).", "type": "string" }, "name": { -"description": "The full resource name of the resource. See: https://cloud.google.com/apis/design/resource_names#full_resource_name", "type": "string" }, "organization": { -"description": "Indicates which organization or tenant in the cloud provider the finding applies to.", "type": "string" }, "parent": { -"description": "The full resource name of resource's parent.", "type": "string" }, "parentDisplayName": { -"description": "The human readable name of resource's parent.", "type": "string" }, "project": { -"description": "The full resource name of project that the resource belongs to.", "type": "string" }, "projectDisplayName": { -"description": "The project ID that the resource belongs to.", "type": "string" }, "resourcePath": { -"$ref": "ResourcePath", -"description": "Provides the path to the resource within the resource hierarchy." +"$ref": "ResourcePath" }, "resourcePathString": { -"description": "A string representation of the resource path. For Google Cloud, it has the format of `organizations/{organization_id}/folders/{folder_id}/folders/{folder_id}/projects/{project_id}` where there can be any number of folders. For AWS, it has the format of `org/{organization_id}/ou/{organizational_unit_id}/ou/{organizational_unit_id}/account/{account_id}` where there can be any number of organizational units. For Azure, it has the format of `mg/{management_group_id}/mg/{management_group_id}/subscription/{subscription_id}/rg/{resource_group_name}` where there can be any number of management groups.", "type": "string" }, "service": { -"description": "The parent service or product from which the resource is provided, for example, GKE or SNS.", "type": "string" }, "type": { -"description": "The full resource type of the resource.", "type": "string" } }, "type": "object" }, "GoogleCloudSecuritycenterV1ResourceApplication": { -"description": "The App Hub Application associated with the finding's resource.", "id": "GoogleCloudSecuritycenterV1ResourceApplication", "properties": { "attributes": { -"$ref": "GoogleCloudSecuritycenterV1ResourceApplicationAttributes", -"description": "Consumer provided attributes for the application" +"$ref": "GoogleCloudSecuritycenterV1ResourceApplicationAttributes" }, "name": { -"description": "The resource name of an Application. Format: `projects/{host-project-id}/locations/{location}/applications/{application-id}`", "type": "string" } }, "type": "object" }, "GoogleCloudSecuritycenterV1ResourceApplicationAttributes": { -"description": "Consumer provided attributes for the application", "id": "GoogleCloudSecuritycenterV1ResourceApplicationAttributes", "properties": { "businessOwners": { -"description": "Business team that ensures user needs are met and value is delivered", "items": { "$ref": "GoogleCloudSecuritycenterV1ResourceApplicationAttributesContactInfo" }, "type": "array" }, "criticality": { -"$ref": "GoogleCloudSecuritycenterV1ResourceApplicationAttributesCriticality", -"description": "User-defined criticality information." +"$ref": "GoogleCloudSecuritycenterV1ResourceApplicationAttributesCriticality" }, "developerOwners": { -"description": "Developer team that owns development and coding.", "items": { "$ref": "GoogleCloudSecuritycenterV1ResourceApplicationAttributesContactInfo" }, "type": "array" }, "environment": { -"$ref": "GoogleCloudSecuritycenterV1ResourceApplicationAttributesEnvironment", -"description": "User-defined environment information." +"$ref": "GoogleCloudSecuritycenterV1ResourceApplicationAttributesEnvironment" }, "operatorOwners": { -"description": "Operator team that ensures runtime and operations.", "items": { "$ref": "GoogleCloudSecuritycenterV1ResourceApplicationAttributesContactInfo" }, @@ -9275,22 +8370,18 @@ false "type": "object" }, "GoogleCloudSecuritycenterV1ResourceApplicationAttributesContactInfo": { -"description": "Contact information of stakeholders.", "id": "GoogleCloudSecuritycenterV1ResourceApplicationAttributesContactInfo", "properties": { "email": { -"description": "Email address of the contacts.", "type": "string" } }, "type": "object" }, "GoogleCloudSecuritycenterV1ResourceApplicationAttributesCriticality": { -"description": "Criticality of the Application, Service, or Workload", "id": "GoogleCloudSecuritycenterV1ResourceApplicationAttributesCriticality", "properties": { "type": { -"description": "Criticality Type.", "enum": [ "CRITICALITY_TYPE_UNSPECIFIED", "MISSION_CRITICAL", @@ -9299,11 +8390,11 @@ false "LOW" ], "enumDescriptions": [ -"Unspecified type.", -"Mission critical service, application or workload.", -"High impact.", -"Medium impact.", -"Low impact." +"", +"", +"", +"", +"" ], "type": "string" } @@ -9311,11 +8402,9 @@ false "type": "object" }, "GoogleCloudSecuritycenterV1ResourceApplicationAttributesEnvironment": { -"description": "Environment of the Application, Service, or Workload", "id": "GoogleCloudSecuritycenterV1ResourceApplicationAttributesEnvironment", "properties": { "type": { -"description": "Environment Type.", "enum": [ "ENVIRONMENT_TYPE_UNSPECIFIED", "PRODUCTION", @@ -9324,11 +8413,11 @@ false "DEVELOPMENT" ], "enumDescriptions": [ -"Unspecified type.", -"Production environment.", -"Staging environment.", -"Test environment.", -"Development environment." +"", +"", +"", +"", +"" ], "type": "string" } @@ -9336,11 +8425,9 @@ false "type": "object" }, "GoogleCloudSecuritycenterV1ResourceSelector": { -"description": "Resource for selecting resource type.", "id": "GoogleCloudSecuritycenterV1ResourceSelector", "properties": { "resourceTypes": { -"description": "The resource types to run the detector on.", "items": { "type": "string" }, @@ -9350,11 +8437,9 @@ false "type": "object" }, "GoogleCloudSecuritycenterV1ResourceValueConfig": { -"description": "A resource value configuration (RVC) is a mapping configuration of user's resources to resource values. Used in Attack path simulations.", "id": "GoogleCloudSecuritycenterV1ResourceValueConfig", "properties": { "cloudProvider": { -"description": "Cloud provider this configuration applies to", "enum": [ "CLOUD_PROVIDER_UNSPECIFIED", "GOOGLE_CLOUD_PLATFORM", @@ -9362,40 +8447,34 @@ false "MICROSOFT_AZURE" ], "enumDescriptions": [ -"The cloud provider is unspecified.", -"The cloud provider is Google Cloud.", -"The cloud provider is Amazon Web Services.", -"The cloud provider is Microsoft Azure." +"", +"", +"", +"" ], "type": "string" }, "createTime": { -"description": "Output only. Timestamp this resource value configuration was created.", "format": "google-datetime", "readOnly": true, "type": "string" }, "description": { -"description": "Description of the resource value configuration.", "type": "string" }, "name": { -"description": "Name for the resource value configuration", "type": "string" }, "resourceLabelsSelector": { "additionalProperties": { "type": "string" }, -"description": "List of resource labels to search for, evaluated with `AND`. For example, `\"resource_labels_selector\": {\"key\": \"value\", \"env\": \"prod\"}` will match resources with labels \"key\": \"value\" `AND` \"env\": \"prod\" https://cloud.google.com/resource-manager/docs/creating-managing-labels", "type": "object" }, "resourceType": { -"description": "Apply resource_value only to resources that match resource_type. resource_type will be checked with `AND` of other resources. For example, \"storage.googleapis.com/Bucket\" with resource_value \"HIGH\" will apply \"HIGH\" value only to \"storage.googleapis.com/Bucket\" resources.", "type": "string" }, "resourceValue": { -"description": "Required. Resource value level this expression represents", "enum": [ "RESOURCE_VALUE_UNSPECIFIED", "HIGH", @@ -9404,31 +8483,27 @@ false "NONE" ], "enumDescriptions": [ -"Unspecific value", -"High resource value", -"Medium resource value", -"Low resource value", -"No resource value, e.g. ignore these resources" +"", +"", +"", +"", +"" ], "type": "string" }, "scope": { -"description": "Project or folder to scope this configuration to. For example, \"project/456\" would apply this configuration only to resources in \"project/456\" scope will be checked with `AND` of other resources.", "type": "string" }, "sensitiveDataProtectionMapping": { -"$ref": "GoogleCloudSecuritycenterV1SensitiveDataProtectionMapping", -"description": "A mapping of the sensitivity on Sensitive Data Protection finding to resource values. This mapping can only be used in combination with a resource_type that is related to BigQuery, e.g. \"bigquery.googleapis.com/Dataset\"." +"$ref": "GoogleCloudSecuritycenterV1SensitiveDataProtectionMapping" }, "tagValues": { -"description": "Required. Tag values combined with `AND` to check against. For Google Cloud resources, they are tag value IDs in the form of \"tagValues/123\". Example: `[ \"tagValues/123\", \"tagValues/456\", \"tagValues/789\" ]` https://cloud.google.com/resource-manager/docs/tags/tags-creating-and-managing", "items": { "type": "string" }, "type": "array" }, "updateTime": { -"description": "Output only. Timestamp this resource value configuration was last updated.", "format": "google-datetime", "readOnly": true, "type": "string" @@ -9437,16 +8512,13 @@ false "type": "object" }, "GoogleCloudSecuritycenterV1RunAssetDiscoveryResponse": { -"description": "Response of asset discovery run", "id": "GoogleCloudSecuritycenterV1RunAssetDiscoveryResponse", "properties": { "duration": { -"description": "The duration between asset discovery run start and end", "format": "google-duration", "type": "string" }, "state": { -"description": "The state of an asset discovery run.", "enum": [ "STATE_UNSPECIFIED", "COMPLETED", @@ -9454,10 +8526,10 @@ false "TERMINATED" ], "enumDescriptions": [ -"Asset discovery run state was unspecified.", -"Asset discovery run completed successfully.", -"Asset discovery run was cancelled with tasks still pending, as another run for the same organization was started with a higher priority.", -"Asset discovery run was killed and terminated." +"", +"", +"", +"" ], "type": "string" } @@ -9465,16 +8537,13 @@ false "type": "object" }, "GoogleCloudSecuritycenterV1SecurityHealthAnalyticsCustomModule": { -"description": "Represents an instance of a Security Health Analytics custom module, including its full module name, display name, enablement state, and last updated time. You can create a custom module at the organization, folder, or project level. Custom modules that you create at the organization or folder level are inherited by the child folders and projects.", "id": "GoogleCloudSecuritycenterV1SecurityHealthAnalyticsCustomModule", "properties": { "ancestorModule": { -"description": "Output only. If empty, indicates that the custom module was created in the organization, folder, or project in which you are viewing the custom module. Otherwise, `ancestor_module` specifies the organization or folder from which the custom module is inherited.", "readOnly": true, "type": "string" }, "cloudProvider": { -"description": "The cloud provider of the custom module.", "enum": [ "CLOUD_PROVIDER_UNSPECIFIED", "GOOGLE_CLOUD_PLATFORM", @@ -9482,23 +8551,20 @@ false "MICROSOFT_AZURE" ], "enumDescriptions": [ -"Unspecified cloud provider.", -"Google Cloud.", -"Amazon Web Services (AWS).", -"Microsoft Azure." +"", +"", +"", +"" ], "type": "string" }, "customConfig": { -"$ref": "GoogleCloudSecuritycenterV1CustomConfig", -"description": "The user specified custom configuration for the module." +"$ref": "GoogleCloudSecuritycenterV1CustomConfig" }, "displayName": { -"description": "The display name of the Security Health Analytics custom module. This display name becomes the finding category for all findings that are returned by this custom module. The display name must be between 1 and 128 characters, start with a lowercase letter, and contain alphanumeric characters or underscores only.", "type": "string" }, "enablementState": { -"description": "The enablement state of the custom module.", "enum": [ "ENABLEMENT_STATE_UNSPECIFIED", "ENABLED", @@ -9506,24 +8572,21 @@ false "INHERITED" ], "enumDescriptions": [ -"Unspecified enablement state.", -"The module is enabled at the given CRM resource.", -"The module is disabled at the given CRM resource.", -"State is inherited from an ancestor module. The module will either be effectively ENABLED or DISABLED based on its closest non-inherited ancestor module in the CRM hierarchy." +"", +"", +"", +"" ], "type": "string" }, "lastEditor": { -"description": "Output only. The editor that last updated the custom module.", "readOnly": true, "type": "string" }, "name": { -"description": "Immutable. The resource name of the custom module. Its format is \"organizations/{organization}/securityHealthAnalyticsSettings/customModules/{customModule}\", or \"folders/{folder}/securityHealthAnalyticsSettings/customModules/{customModule}\", or \"projects/{project}/securityHealthAnalyticsSettings/customModules/{customModule}\" The id {customModule} is server-generated and is not user settable. It will be a numeric id containing 1-20 digits.", "type": "string" }, "updateTime": { -"description": "Output only. The time at which the custom module was last updated.", "format": "google-datetime", "readOnly": true, "type": "string" @@ -9532,11 +8595,9 @@ false "type": "object" }, "GoogleCloudSecuritycenterV1SensitiveDataProtectionMapping": { -"description": "Resource value mapping for Sensitive Data Protection findings. If any of these mappings have a resource value that is not unspecified, the resource_value field will be ignored when reading this configuration.", "id": "GoogleCloudSecuritycenterV1SensitiveDataProtectionMapping", "properties": { "highSensitivityMapping": { -"description": "Resource value mapping for high-sensitivity Sensitive Data Protection findings", "enum": [ "RESOURCE_VALUE_UNSPECIFIED", "HIGH", @@ -9545,16 +8606,15 @@ false "NONE" ], "enumDescriptions": [ -"Unspecific value", -"High resource value", -"Medium resource value", -"Low resource value", -"No resource value, e.g. ignore these resources" +"", +"", +"", +"", +"" ], "type": "string" }, "mediumSensitivityMapping": { -"description": "Resource value mapping for medium-sensitivity Sensitive Data Protection findings", "enum": [ "RESOURCE_VALUE_UNSPECIFIED", "HIGH", @@ -9563,11 +8623,11 @@ false "NONE" ], "enumDescriptions": [ -"Unspecific value", -"High resource value", -"Medium resource value", -"Low resource value", -"No resource value, e.g. ignore these resources" +"", +"", +"", +"", +"" ], "type": "string" } @@ -9575,16 +8635,13 @@ false "type": "object" }, "GoogleCloudSecuritycenterV1beta1RunAssetDiscoveryResponse": { -"description": "Response of asset discovery run", "id": "GoogleCloudSecuritycenterV1beta1RunAssetDiscoveryResponse", "properties": { "duration": { -"description": "The duration between asset discovery run start and end", "format": "google-duration", "type": "string" }, "state": { -"description": "The state of an asset discovery run.", "enum": [ "STATE_UNSPECIFIED", "COMPLETED", @@ -9592,10 +8649,10 @@ false "TERMINATED" ], "enumDescriptions": [ -"Asset discovery run state was unspecified.", -"Asset discovery run completed successfully.", -"Asset discovery run was cancelled with tasks still pending, as another run for the same organization was started with a higher priority.", -"Asset discovery run was killed and terminated." +"", +"", +"", +"" ], "type": "string" } @@ -9603,50 +8660,39 @@ false "type": "object" }, "GoogleCloudSecuritycenterV1p1beta1Finding": { -"description": "Security Command Center finding. A finding is a record of assessment data (security, risk, health or privacy) ingested into Security Command Center for presentation, notification, analysis, policy testing, and enforcement. For example, an XSS vulnerability in an App Engine application is a finding.", "id": "GoogleCloudSecuritycenterV1p1beta1Finding", "properties": { "canonicalName": { -"description": "The canonical name of the finding. It's either \"organizations/{organization_id}/sources/{source_id}/findings/{finding_id}\", \"folders/{folder_id}/sources/{source_id}/findings/{finding_id}\" or \"projects/{project_number}/sources/{source_id}/findings/{finding_id}\", depending on the closest CRM ancestor of the resource associated with the finding.", "type": "string" }, "category": { -"description": "The additional taxonomy group within findings from a given source. This field is immutable after creation time. Example: \"XSS_FLASH_INJECTION\"", "type": "string" }, "createTime": { -"description": "The time at which the finding was created in Security Command Center.", "format": "google-datetime", "type": "string" }, "eventTime": { -"description": "The time at which the event took place, or when an update to the finding occurred. For example, if the finding represents an open firewall it would capture the time the detector believes the firewall became open. The accuracy is determined by the detector. If the finding were to be resolved afterward, this time would reflect when the finding was resolved. Must not be set to a value greater than the current timestamp.", "format": "google-datetime", "type": "string" }, "externalUri": { -"description": "The URI that, if available, points to a web page outside of Security Command Center where additional information about the finding can be found. This field is guaranteed to be either empty or a well formed URL.", "type": "string" }, "name": { -"description": "The relative resource name of this finding. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Example: \"organizations/{organization_id}/sources/{source_id}/findings/{finding_id}\"", "type": "string" }, "parent": { -"description": "The relative resource name of the source the finding belongs to. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name This field is immutable after creation time. For example: \"organizations/{organization_id}/sources/{source_id}\"", "type": "string" }, "resourceName": { -"description": "For findings on Google Cloud resources, the full resource name of the Google Cloud resource this finding is for. See: https://cloud.google.com/apis/design/resource_names#full_resource_name When the finding is for a non-Google Cloud resource, the resourceName can be a customer or partner defined string. This field is immutable after creation time.", "type": "string" }, "securityMarks": { "$ref": "GoogleCloudSecuritycenterV1p1beta1SecurityMarks", -"description": "Output only. User specified security marks. These marks are entirely managed by the user and come from the SecurityMarks resource that belongs to the finding.", "readOnly": true }, "severity": { -"description": "The severity of the finding. This field is managed by the source that writes the finding.", "enum": [ "SEVERITY_UNSPECIFIED", "CRITICAL", @@ -9655,11 +8701,11 @@ false "LOW" ], "enumDescriptions": [ -"No severity specified. The default value.", -"Critical severity.", -"High severity.", -"Medium severity.", -"Low severity." +"", +"", +"", +"", +"" ], "type": "string" }, @@ -9667,20 +8713,18 @@ false "additionalProperties": { "type": "any" }, -"description": "Source specific properties. These properties are managed by the source that writes the finding. The key names in the source_properties map must be between 1 and 255 characters, and must start with a letter and contain alphanumeric characters or underscores only.", "type": "object" }, "state": { -"description": "The state of the finding.", "enum": [ "STATE_UNSPECIFIED", "ACTIVE", "INACTIVE" ], "enumDescriptions": [ -"Unspecified state.", -"The finding requires attention and has not been addressed yet.", -"The finding has been fixed, triaged as a non-issue or otherwise addressed and is no longer active." +"", +"", +"" ], "type": "string" } @@ -9688,45 +8732,36 @@ false "type": "object" }, "GoogleCloudSecuritycenterV1p1beta1Folder": { -"description": "Message that contains the resource name and display name of a folder resource.", "id": "GoogleCloudSecuritycenterV1p1beta1Folder", "properties": { "resourceFolder": { -"description": "Full resource name of this folder. See: https://cloud.google.com/apis/design/resource_names#full_resource_name", "type": "string" }, "resourceFolderDisplayName": { -"description": "The user defined display name for this folder.", "type": "string" } }, "type": "object" }, "GoogleCloudSecuritycenterV1p1beta1NotificationMessage": { -"description": "Security Command Center's Notification", "id": "GoogleCloudSecuritycenterV1p1beta1NotificationMessage", "properties": { "finding": { -"$ref": "GoogleCloudSecuritycenterV1p1beta1Finding", -"description": "If it's a Finding based notification config, this field will be populated." +"$ref": "GoogleCloudSecuritycenterV1p1beta1Finding" }, "notificationConfigName": { -"description": "Name of the notification config that generated current notification.", "type": "string" }, "resource": { -"$ref": "GoogleCloudSecuritycenterV1p1beta1Resource", -"description": "The Cloud resource tied to the notification." +"$ref": "GoogleCloudSecuritycenterV1p1beta1Resource" } }, "type": "object" }, "GoogleCloudSecuritycenterV1p1beta1Resource": { -"description": "Information related to the Google Cloud resource.", "id": "GoogleCloudSecuritycenterV1p1beta1Resource", "properties": { "folders": { -"description": "Output only. Contains a Folder message for each folder in the assets ancestry. The first folder is the deepest nested folder, and the last folder is the folder directly under the Organization.", "items": { "$ref": "GoogleCloudSecuritycenterV1p1beta1Folder" }, @@ -9734,39 +8769,31 @@ false "type": "array" }, "name": { -"description": "The full resource name of the resource. See: https://cloud.google.com/apis/design/resource_names#full_resource_name", "type": "string" }, "parent": { -"description": "The full resource name of resource's parent.", "type": "string" }, "parentDisplayName": { -"description": "The human readable name of resource's parent.", "type": "string" }, "project": { -"description": "The full resource name of project that the resource belongs to.", "type": "string" }, "projectDisplayName": { -"description": "The project id that the resource belongs to.", "type": "string" } }, "type": "object" }, "GoogleCloudSecuritycenterV1p1beta1RunAssetDiscoveryResponse": { -"description": "Response of asset discovery run", "id": "GoogleCloudSecuritycenterV1p1beta1RunAssetDiscoveryResponse", "properties": { "duration": { -"description": "The duration between asset discovery run start and end", "format": "google-duration", "type": "string" }, "state": { -"description": "The state of an asset discovery run.", "enum": [ "STATE_UNSPECIFIED", "COMPLETED", @@ -9774,10 +8801,10 @@ false "TERMINATED" ], "enumDescriptions": [ -"Asset discovery run state was unspecified.", -"Asset discovery run completed successfully.", -"Asset discovery run was cancelled with tasks still pending, as another run for the same organization was started with a higher priority.", -"Asset discovery run was killed and terminated." +"", +"", +"", +"" ], "type": "string" } @@ -9785,122 +8812,96 @@ false "type": "object" }, "GoogleCloudSecuritycenterV1p1beta1SecurityMarks": { -"description": "User specified security marks that are attached to the parent Security Command Center resource. Security marks are scoped within a Security Command Center organization -- they can be modified and viewed by all users who have proper permissions on the organization.", "id": "GoogleCloudSecuritycenterV1p1beta1SecurityMarks", "properties": { "canonicalName": { -"description": "The canonical name of the marks. Examples: \"organizations/{organization_id}/assets/{asset_id}/securityMarks\" \"folders/{folder_id}/assets/{asset_id}/securityMarks\" \"projects/{project_number}/assets/{asset_id}/securityMarks\" \"organizations/{organization_id}/sources/{source_id}/findings/{finding_id}/securityMarks\" \"folders/{folder_id}/sources/{source_id}/findings/{finding_id}/securityMarks\" \"projects/{project_number}/sources/{source_id}/findings/{finding_id}/securityMarks\"", "type": "string" }, "marks": { "additionalProperties": { "type": "string" }, -"description": "Mutable user specified security marks belonging to the parent resource. Constraints are as follows: * Keys and values are treated as case insensitive * Keys must be between 1 - 256 characters (inclusive) * Keys must be letters, numbers, underscores, or dashes * Values have leading and trailing whitespace trimmed, remaining characters must be between 1 - 4096 characters (inclusive)", "type": "object" }, "name": { -"description": "The relative resource name of the SecurityMarks. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Examples: \"organizations/{organization_id}/assets/{asset_id}/securityMarks\" \"organizations/{organization_id}/sources/{source_id}/findings/{finding_id}/securityMarks\".", "type": "string" } }, "type": "object" }, "GoogleCloudSecuritycenterV2Access": { -"description": "Represents an access event.", "id": "GoogleCloudSecuritycenterV2Access", "properties": { "callerIp": { -"description": "Caller's IP address, such as \"1.1.1.1\".", "type": "string" }, "callerIpGeo": { -"$ref": "GoogleCloudSecuritycenterV2Geolocation", -"description": "The caller IP's geolocation, which identifies where the call came from." +"$ref": "GoogleCloudSecuritycenterV2Geolocation" }, "methodName": { -"description": "The method that the service account called, e.g. \"SetIamPolicy\".", "type": "string" }, "principalEmail": { -"description": "Associated email, such as \"foo@google.com\". The email address of the authenticated user or a service account acting on behalf of a 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" }, "principalSubject": { -"description": "A string that represents the principal_subject that is associated with the identity. Unlike `principal_email`, `principal_subject` supports principals that aren't associated with email addresses, such as third party principals. For most identities, the format is `principal://iam.googleapis.com/{identity pool name}/subject/{subject}`. Some GKE identities, such as GKE_WORKLOAD, FREEFORM, and GKE_HUB_WORKLOAD, still use the legacy format `serviceAccount:{identity pool name}[{subject}]`.", "type": "string" }, "serviceAccountDelegationInfo": { -"description": "The identity delegation history of an authenticated service account that made the request. The `serviceAccountDelegationInfo[]` object contains information about the real authorities that try to access Google Cloud resources by delegating on a service account. When multiple authorities are present, they are guaranteed to be sorted based on the original ordering of the identity delegation events.", "items": { "$ref": "GoogleCloudSecuritycenterV2ServiceAccountDelegationInfo" }, "type": "array" }, "serviceAccountKeyName": { -"description": "The name of the service account key that was used to create or exchange credentials when authenticating the service account that made the request. This is a scheme-less URI full resource name. For example: \"//iam.googleapis.com/projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}/keys/{key}\". ", "type": "string" }, "serviceName": { -"description": "This is the API service that the service account made a call to, e.g. \"iam.googleapis.com\"", "type": "string" }, "userAgent": { -"description": "The caller's user agent string associated with the finding.", "type": "string" }, "userAgentFamily": { -"description": "Type of user agent associated with the finding. For example, an operating system shell or an embedded or standalone application.", "type": "string" }, "userName": { -"description": "A string that represents a username. The username provided depends on the type of the finding and is likely not an IAM principal. For example, this can be a system username if the finding is related to a virtual machine, or it can be an application login username.", "type": "string" } }, "type": "object" }, "GoogleCloudSecuritycenterV2AccessReview": { -"description": "Conveys information about a Kubernetes access review (such as one returned by a [`kubectl auth can-i`](https://kubernetes.io/docs/reference/access-authn-authz/authorization/#checking-api-access) command) that was involved in a finding.", "id": "GoogleCloudSecuritycenterV2AccessReview", "properties": { "group": { -"description": "The API group of the resource. \"*\" means all.", "type": "string" }, "name": { -"description": "The name of the resource being requested. Empty means all.", "type": "string" }, "ns": { -"description": "Namespace of the action being requested. Currently, there is no distinction between no namespace and all namespaces. Both are represented by \"\" (empty).", "type": "string" }, "resource": { -"description": "The optional resource type requested. \"*\" means all.", "type": "string" }, "subresource": { -"description": "The optional subresource type.", "type": "string" }, "verb": { -"description": "A Kubernetes resource API verb, like get, list, watch, create, update, delete, proxy. \"*\" means all.", "type": "string" }, "version": { -"description": "The API version of the resource. \"*\" means all.", "type": "string" } }, "type": "object" }, "GoogleCloudSecuritycenterV2AdaptiveProtection": { -"description": "Information about [Google Cloud Armor Adaptive Protection](https://cloud.google.com/armor/docs/cloud-armor-overview#google-cloud-armor-adaptive-protection).", "id": "GoogleCloudSecuritycenterV2AdaptiveProtection", "properties": { "confidence": { -"description": "A score of 0 means that there is low confidence that the detected event is an actual attack. A score of 1 means that there is high confidence that the detected event is an attack. See the [Adaptive Protection documentation](https://cloud.google.com/armor/docs/adaptive-protection-overview#configure-alert-tuning) for further explanation.", "format": "double", "type": "number" } @@ -9908,48 +8909,39 @@ false "type": "object" }, "GoogleCloudSecuritycenterV2AdcApplication": { -"description": "Represents an ADC application associated with the finding.", "id": "GoogleCloudSecuritycenterV2AdcApplication", "properties": { "attributes": { -"$ref": "GoogleCloudSecuritycenterV2ResourceApplicationAttributes", -"description": "Consumer provided attributes for the AppHub application." +"$ref": "GoogleCloudSecuritycenterV2ResourceApplicationAttributes" }, "name": { -"description": "The resource name of an ADC Application. Format: projects/{project}/locations/{location}/spaces/{space}/applications/{application}", "type": "string" } }, "type": "object" }, "GoogleCloudSecuritycenterV2AdcApplicationTemplateRevision": { -"description": "Represents an ADC template associated with the finding.", "id": "GoogleCloudSecuritycenterV2AdcApplicationTemplateRevision", "properties": { "name": { -"description": "The resource name of an ADC Application Template Revision. Format: projects/{project}/locations/{location}/spaces/{space}/applicationTemplates/{application_template}/revisions/{revision}", "type": "string" } }, "type": "object" }, "GoogleCloudSecuritycenterV2AdcSharedTemplateRevision": { -"description": "Represents an ADC shared template associated with the finding.", "id": "GoogleCloudSecuritycenterV2AdcSharedTemplateRevision", "properties": { "name": { -"description": "The resource name of an ADC Shared Template Revision. Format: projects/{project}/locations/{location}/spaces/{space}/applicationTemplates/{application_template}/revisions/{revision}", "type": "string" } }, "type": "object" }, "GoogleCloudSecuritycenterV2AffectedResources": { -"description": "Details about resources affected by this finding.", "id": "GoogleCloudSecuritycenterV2AffectedResources", "properties": { "count": { -"description": "The count of resources affected by the finding.", "format": "int64", "type": "string" } @@ -9957,20 +8949,16 @@ false "type": "object" }, "GoogleCloudSecuritycenterV2AgentDataAccessEvent": { -"description": "Details about a data access attempt made by an agent principal not authorized under applicable data security policy.", "id": "GoogleCloudSecuritycenterV2AgentDataAccessEvent", "properties": { "eventId": { -"description": "Unique identifier for data access event.", "type": "string" }, "eventTime": { -"description": "Timestamp of data access event.", "format": "google-datetime", "type": "string" }, "operation": { -"description": "The operation performed by the principal to access the data.", "enum": [ "OPERATION_UNSPECIFIED", "READ", @@ -9978,26 +8966,23 @@ false "COPY" ], "enumDescriptions": [ -"The operation is unspecified.", -"Represents a read operation.", -"Represents a move operation.", -"Represents a copy operation." +"", +"", +"", +"" ], "type": "string" }, "principalSubject": { -"description": "The agent principal that accessed the data.", "type": "string" } }, "type": "object" }, "GoogleCloudSecuritycenterV2AiModel": { -"description": "Contains information about the AI model associated with the finding.", "id": "GoogleCloudSecuritycenterV2AiModel", "properties": { "deploymentPlatform": { -"description": "The platform on which the model is deployed.", "enum": [ "DEPLOYMENT_PLATFORM_UNSPECIFIED", "VERTEX_AI", @@ -10006,51 +8991,42 @@ false "FINE_TUNED_MODEL" ], "enumDescriptions": [ -"Unspecified deployment platform.", -"Vertex AI.", -"Google Kubernetes Engine.", -"Google Compute Engine.", -"Fine tuned model." +"", +"", +"", +"", +"" ], "type": "string" }, "displayName": { -"description": "The user defined display name of model. Ex. baseline-classification-model", "type": "string" }, "domain": { -"description": "The domain of the model, for example, \u201cimage-classification\u201d.", "type": "string" }, "library": { -"description": "The name of the model library, for example, \u201ctransformers\u201d.", "type": "string" }, "location": { -"description": "The region in which the model is used, for example, \u201cus-central1\u201d.", "type": "string" }, "name": { -"description": "The name of the AI model, for example, \"gemini:1.0.0\".", "type": "string" }, "publisher": { -"description": "The publisher of the model, for example, \u201cgoogle\u201d or \u201cnvidia\u201d.", "type": "string" }, "usageCategory": { -"description": "The purpose of the model, for example, \"Inteference\" or \"Training\".", "type": "string" } }, "type": "object" }, "GoogleCloudSecuritycenterV2Allowed": { -"description": "Allowed IP rule.", "id": "GoogleCloudSecuritycenterV2Allowed", "properties": { "ipRules": { -"description": "Optional. Optional list of allowed IP rules.", "items": { "$ref": "GoogleCloudSecuritycenterV2IpRule" }, @@ -10060,59 +9036,49 @@ false "type": "object" }, "GoogleCloudSecuritycenterV2Application": { -"description": "Represents an application associated with a finding.", "id": "GoogleCloudSecuritycenterV2Application", "properties": { "baseUri": { -"description": "The base URI that identifies the network location of the application in which the vulnerability was detected. For example, `http://example.com`.", "type": "string" }, "fullUri": { -"description": "The full URI with payload that could be used to reproduce the vulnerability. For example, `http://example.com?p=aMmYgI6H`.", "type": "string" } }, "type": "object" }, "GoogleCloudSecuritycenterV2ArtifactGuardPolicies": { -"description": "Represents the result of evaluating artifact guard policies.", "id": "GoogleCloudSecuritycenterV2ArtifactGuardPolicies", "properties": { "failingPolicies": { -"description": "A list of failing policies.", "items": { "$ref": "GoogleCloudSecuritycenterV2ArtifactGuardPolicy" }, "type": "array" }, "resourceId": { -"description": "The ID of the resource that has policies configured for it.", "type": "string" } }, "type": "object" }, "GoogleCloudSecuritycenterV2ArtifactGuardPolicy": { -"description": "Represents an artifact guard policy.", "id": "GoogleCloudSecuritycenterV2ArtifactGuardPolicy", "properties": { "failureReason": { -"description": "The reason for the policy failure, for example, \"severity=HIGH AND max_vuln_count=2\".", "type": "string" }, "policyId": { -"description": "The ID of the failing policy, for example, \"organizations/3392779/locations/global/policies/prod-policy\".", "type": "string" }, "type": { -"description": "The type of the policy evaluation.", "enum": [ "ARTIFACT_GUARD_POLICY_TYPE_UNSPECIFIED", "VULNERABILITY" ], "enumDescriptions": [ -"Default value. This value is unused.", -"Vulnerability type." +"", +"" ], "type": "string" } @@ -10120,32 +9086,26 @@ false "type": "object" }, "GoogleCloudSecuritycenterV2Attack": { -"description": "Information about DDoS attack volume and classification.", "id": "GoogleCloudSecuritycenterV2Attack", "properties": { "classification": { -"description": "Type of attack, for example, 'SYN-flood', 'NTP-udp', or 'CHARGEN-udp'.", "type": "string" }, "volumeBps": { "deprecated": true, -"description": "Total BPS (bytes per second) volume of attack. Deprecated - refer to volume_bps_long instead.", "format": "int32", "type": "integer" }, "volumeBpsLong": { -"description": "Total BPS (bytes per second) volume of attack.", "format": "int64", "type": "string" }, "volumePps": { "deprecated": true, -"description": "Total PPS (packets per second) volume of attack. Deprecated - refer to volume_pps_long instead.", "format": "int32", "type": "integer" }, "volumePpsLong": { -"description": "Total PPS (packets per second) volume of attack.", "format": "int64", "type": "string" } @@ -10153,49 +9113,41 @@ false "type": "object" }, "GoogleCloudSecuritycenterV2AttackExposure": { -"description": "An attack exposure contains the results of an attack path simulation run.", "id": "GoogleCloudSecuritycenterV2AttackExposure", "properties": { "attackExposureResult": { -"description": "The resource name of the attack path simulation result that contains the details regarding this attack exposure score. Example: `organizations/123/simulations/456/attackExposureResults/789`", "type": "string" }, "exposedHighValueResourcesCount": { -"description": "The number of high value resources that are exposed as a result of this finding.", "format": "int32", "type": "integer" }, "exposedLowValueResourcesCount": { -"description": "The number of high value resources that are exposed as a result of this finding.", "format": "int32", "type": "integer" }, "exposedMediumValueResourcesCount": { -"description": "The number of medium value resources that are exposed as a result of this finding.", "format": "int32", "type": "integer" }, "latestCalculationTime": { -"description": "The most recent time the attack exposure was updated on this finding.", "format": "google-datetime", "type": "string" }, "score": { -"description": "A number between 0 (inclusive) and infinity that represents how important this finding is to remediate. The higher the score, the more important it is to remediate.", "format": "double", "type": "number" }, "state": { -"description": "Output only. What state this AttackExposure is in. This captures whether or not an attack exposure has been calculated or not.", "enum": [ "STATE_UNSPECIFIED", "CALCULATED", "NOT_CALCULATED" ], "enumDescriptions": [ -"The state is not specified.", -"The attack exposure has been calculated.", -"The attack exposure has not been calculated." +"", +"", +"" ], "readOnly": true, "type": "string" @@ -10204,34 +9156,27 @@ false "type": "object" }, "GoogleCloudSecuritycenterV2AwsAccount": { -"description": "An AWS account that is a member of an organization.", "id": "GoogleCloudSecuritycenterV2AwsAccount", "properties": { "id": { -"description": "The unique identifier (ID) of the account, containing exactly 12 digits.", "type": "string" }, "name": { -"description": "The friendly name of this account.", "type": "string" } }, "type": "object" }, "GoogleCloudSecuritycenterV2AwsMetadata": { -"description": "AWS metadata associated with the resource, only applicable if the finding's cloud provider is Amazon Web Services.", "id": "GoogleCloudSecuritycenterV2AwsMetadata", "properties": { "account": { -"$ref": "GoogleCloudSecuritycenterV2AwsAccount", -"description": "The AWS account associated with the resource." +"$ref": "GoogleCloudSecuritycenterV2AwsAccount" }, "organization": { -"$ref": "GoogleCloudSecuritycenterV2AwsOrganization", -"description": "The AWS organization associated with the resource." +"$ref": "GoogleCloudSecuritycenterV2AwsOrganization" }, "organizationalUnits": { -"description": "A list of AWS organizational units associated with the resource, ordered from lowest level (closest to the account) to highest level.", "items": { "$ref": "GoogleCloudSecuritycenterV2AwsOrganizationalUnit" }, @@ -10241,217 +9186,174 @@ false "type": "object" }, "GoogleCloudSecuritycenterV2AwsOrganization": { -"description": "An organization is a collection of accounts that are centrally managed together using consolidated billing, organized hierarchically with organizational units (OUs), and controlled with policies.", "id": "GoogleCloudSecuritycenterV2AwsOrganization", "properties": { "id": { -"description": "The unique identifier (ID) for the organization. The regex pattern for an organization ID string requires \"o-\" followed by from 10 to 32 lowercase letters or digits.", "type": "string" } }, "type": "object" }, "GoogleCloudSecuritycenterV2AwsOrganizationalUnit": { -"description": "An Organizational Unit (OU) is a container of AWS accounts within a root of an organization. Policies that are attached to an OU apply to all accounts contained in that OU and in any child OUs.", "id": "GoogleCloudSecuritycenterV2AwsOrganizationalUnit", "properties": { "id": { -"description": "The unique identifier (ID) associated with this OU. The regex pattern for an organizational unit ID string requires \"ou-\" followed by from 4 to 32 lowercase letters or digits (the ID of the root that contains the OU). This string is followed by a second \"-\" dash and from 8 to 32 additional lowercase letters or digits. For example, \"ou-ab12-cd34ef56\".", "type": "string" }, "name": { -"description": "The friendly name of the OU.", "type": "string" } }, "type": "object" }, "GoogleCloudSecuritycenterV2AzureManagementGroup": { -"description": "Represents an Azure management group.", "id": "GoogleCloudSecuritycenterV2AzureManagementGroup", "properties": { "displayName": { -"description": "The display name of the Azure management group.", "type": "string" }, "id": { -"description": "The UUID of the Azure management group, for example, `20000000-0001-0000-0000-000000000000`.", "type": "string" } }, "type": "object" }, "GoogleCloudSecuritycenterV2AzureMetadata": { -"description": "Azure metadata associated with the resource, only applicable if the finding's cloud provider is Microsoft Azure.", "id": "GoogleCloudSecuritycenterV2AzureMetadata", "properties": { "managementGroups": { -"description": "A list of Azure management groups associated with the resource, ordered from lowest level (closest to the subscription) to highest level.", "items": { "$ref": "GoogleCloudSecuritycenterV2AzureManagementGroup" }, "type": "array" }, "resourceGroup": { -"$ref": "GoogleCloudSecuritycenterV2AzureResourceGroup", -"description": "The Azure resource group associated with the resource." +"$ref": "GoogleCloudSecuritycenterV2AzureResourceGroup" }, "subscription": { -"$ref": "GoogleCloudSecuritycenterV2AzureSubscription", -"description": "The Azure subscription associated with the resource." +"$ref": "GoogleCloudSecuritycenterV2AzureSubscription" }, "tenant": { -"$ref": "GoogleCloudSecuritycenterV2AzureTenant", -"description": "The Azure Entra tenant associated with the resource." +"$ref": "GoogleCloudSecuritycenterV2AzureTenant" } }, "type": "object" }, "GoogleCloudSecuritycenterV2AzureResourceGroup": { -"description": "Represents an Azure resource group.", "id": "GoogleCloudSecuritycenterV2AzureResourceGroup", "properties": { "id": { -"description": "The ID of the Azure resource group.", "type": "string" }, "name": { -"description": "The name of the Azure resource group. This is not a UUID.", "type": "string" } }, "type": "object" }, "GoogleCloudSecuritycenterV2AzureSubscription": { -"description": "Represents an Azure subscription.", "id": "GoogleCloudSecuritycenterV2AzureSubscription", "properties": { "displayName": { -"description": "The display name of the Azure subscription.", "type": "string" }, "id": { -"description": "The UUID of the Azure subscription, for example, `291bba3f-e0a5-47bc-a099-3bdcb2a50a05`.", "type": "string" } }, "type": "object" }, "GoogleCloudSecuritycenterV2AzureTenant": { -"description": "Represents a Microsoft Entra tenant.", "id": "GoogleCloudSecuritycenterV2AzureTenant", "properties": { "displayName": { -"description": "The display name of the Azure tenant.", "type": "string" }, "id": { -"description": "The ID of the Microsoft Entra tenant, for example, \"a11aaa11-aa11-1aa1-11aa-1aaa11a\".", "type": "string" } }, "type": "object" }, "GoogleCloudSecuritycenterV2BackupDisasterRecovery": { -"description": "Information related to Google Cloud Backup and DR Service findings.", "id": "GoogleCloudSecuritycenterV2BackupDisasterRecovery", "properties": { "appliance": { -"description": "The name of the Backup and DR appliance that captures, moves, and manages the lifecycle of backup data. For example, `backup-server-57137`.", "type": "string" }, "applications": { -"description": "The names of Backup and DR applications. An application is a VM, database, or file system on a managed host monitored by a backup and recovery appliance. For example, `centos7-01-vol00`, `centos7-01-vol01`, `centos7-01-vol02`.", "items": { "type": "string" }, "type": "array" }, "backupCreateTime": { -"description": "The timestamp at which the Backup and DR backup was created.", "format": "google-datetime", "type": "string" }, "backupTemplate": { -"description": "The name of a Backup and DR template which comprises one or more backup policies. See the [Backup and DR documentation](https://cloud.google.com/backup-disaster-recovery/docs/concepts/backup-plan#temp) for more information. For example, `snap-ov`.", "type": "string" }, "backupType": { -"description": "The backup type of the Backup and DR image. For example, `Snapshot`, `Remote Snapshot`, `OnVault`.", "type": "string" }, "host": { -"description": "The name of a Backup and DR host, which is managed by the backup and recovery appliance and known to the management console. The host can be of type Generic (for example, Compute Engine, SQL Server, Oracle DB, SMB file system, etc.), vCenter, or an ESX server. See the [Backup and DR documentation on hosts](https://cloud.google.com/backup-disaster-recovery/docs/configuration/manage-hosts-and-their-applications) for more information. For example, `centos7-01`.", "type": "string" }, "policies": { -"description": "The names of Backup and DR policies that are associated with a template and that define when to run a backup, how frequently to run a backup, and how long to retain the backup image. For example, `onvaults`.", "items": { "type": "string" }, "type": "array" }, "policyOptions": { -"description": "The names of Backup and DR advanced policy options of a policy applying to an application. See the [Backup and DR documentation on policy options](https://cloud.google.com/backup-disaster-recovery/docs/create-plan/policy-settings). For example, `skipofflineappsincongrp, nounmap`.", "items": { "type": "string" }, "type": "array" }, "profile": { -"description": "The name of the Backup and DR resource profile that specifies the storage media for backups of application and VM data. See the [Backup and DR documentation on profiles](https://cloud.google.com/backup-disaster-recovery/docs/concepts/backup-plan#profile). For example, `GCP`.", "type": "string" }, "storagePool": { -"description": "The name of the Backup and DR storage pool that the backup and recovery appliance is storing data in. The storage pool could be of type Cloud, Primary, Snapshot, or OnVault. See the [Backup and DR documentation on storage pools](https://cloud.google.com/backup-disaster-recovery/docs/concepts/storage-pools). For example, `DiskPoolOne`.", "type": "string" } }, "type": "object" }, "GoogleCloudSecuritycenterV2BigQueryExport": { -"description": "Configures how to deliver Findings to BigQuery Instance.", "id": "GoogleCloudSecuritycenterV2BigQueryExport", "properties": { "createTime": { -"description": "Output only. The time at which the BigQuery export was created. This field is set by the server and will be ignored if provided on export on creation.", "format": "google-datetime", "readOnly": true, "type": "string" }, "cryptoKeyName": { -"description": "Output only. The resource name of the Cloud KMS `CryptoKey` used to protect this configuration's data, if configured during Security Command Center activation.", "readOnly": true, "type": "string" }, "dataset": { -"description": "The dataset to write findings' updates to. Its format is \"projects/[project_id]/datasets/[bigquery_dataset_id]\". BigQuery dataset unique ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_).", "type": "string" }, "description": { -"description": "The description of the export (max of 1024 characters).", "type": "string" }, "filter": { -"description": "Expression that defines the filter to apply across create/update events of findings. The expression is a list of zero or more restrictions combined via logical operators `AND` and `OR`. Parentheses are supported, and `OR` has higher precedence than `AND`. Restrictions have the form ` ` and may have a `-` character in front of them to indicate negation. The fields map to those defined in the corresponding resource. The supported operators are: * `=` for all value types. * `>`, `<`, `>=`, `<=` for integer values. * `:`, meaning substring matching, for strings. The supported value types are: * string literals in quotes. * integer literals without quotes. * boolean literals `true` and `false` without quotes.", "type": "string" }, "mostRecentEditor": { -"description": "Output only. Email address of the user who last edited the BigQuery export. This field is set by the server and will be ignored if provided on export creation or update.", "readOnly": true, "type": "string" }, "name": { -"description": "Identifier. The relative resource name of this export. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name. The following list shows some examples: + `organizations/{organization_id}/locations/{location_id}/bigQueryExports/{export_id}` + `folders/{folder_id}/locations/{location_id}/bigQueryExports/{export_id}` + `projects/{project_id}/locations/{location_id}/bigQueryExports/{export_id}` This field is provided in responses, and is ignored when provided in create requests.", "type": "string" }, "principal": { -"description": "Output only. The service account that needs permission to create table and upload data to the BigQuery dataset.", "readOnly": true, "type": "string" }, "updateTime": { -"description": "Output only. The most recent time at which the BigQuery export was updated. This field is set by the server and will be ignored if provided on export creation or update.", "format": "google-datetime", "readOnly": true, "type": "string" @@ -10460,23 +9362,18 @@ false "type": "object" }, "GoogleCloudSecuritycenterV2Binding": { -"description": "Represents a Kubernetes RoleBinding or ClusterRoleBinding.", "id": "GoogleCloudSecuritycenterV2Binding", "properties": { "name": { -"description": "Name for the binding.", "type": "string" }, "ns": { -"description": "Namespace for the binding.", "type": "string" }, "role": { -"$ref": "GoogleCloudSecuritycenterV2Role", -"description": "The Role or ClusterRole referenced by the binding." +"$ref": "GoogleCloudSecuritycenterV2Role" }, "subjects": { -"description": "Represents one or more subjects that are bound to the role. Not always available for PATCH requests.", "items": { "$ref": "GoogleCloudSecuritycenterV2Subject" }, @@ -10486,17 +9383,14 @@ false "type": "object" }, "GoogleCloudSecuritycenterV2BulkMuteFindingsResponse": { -"description": "The response to a BulkMute request. Contains the LRO information.", "id": "GoogleCloudSecuritycenterV2BulkMuteFindingsResponse", "properties": {}, "type": "object" }, "GoogleCloudSecuritycenterV2Chokepoint": { -"description": "Contains details about a chokepoint, which is a resource or resource group where high-risk attack paths converge, based on [attack path simulations] (https://cloud.google.com/security-command-center/docs/attack-exposure-learn#attack_path_simulations).", "id": "GoogleCloudSecuritycenterV2Chokepoint", "properties": { "relatedFindings": { -"description": "List of resource names of findings associated with this chokepoint. For example, organizations/123/sources/456/findings/789. This list will have at most 100 findings.", "items": { "type": "string" }, @@ -10506,65 +9400,53 @@ false "type": "object" }, "GoogleCloudSecuritycenterV2CloudArmor": { -"description": "Fields related to Google Cloud Armor findings.", "id": "GoogleCloudSecuritycenterV2CloudArmor", "properties": { "adaptiveProtection": { -"$ref": "GoogleCloudSecuritycenterV2AdaptiveProtection", -"description": "Information about potential Layer 7 DDoS attacks identified by [Google Cloud Armor Adaptive Protection](https://cloud.google.com/armor/docs/adaptive-protection-overview)." +"$ref": "GoogleCloudSecuritycenterV2AdaptiveProtection" }, "attack": { -"$ref": "GoogleCloudSecuritycenterV2Attack", -"description": "Information about DDoS attack volume and classification." +"$ref": "GoogleCloudSecuritycenterV2Attack" }, "duration": { -"description": "Duration of attack from the start until the current moment (updated every 5 minutes).", "format": "google-duration", "type": "string" }, "requests": { -"$ref": "GoogleCloudSecuritycenterV2Requests", -"description": "Information about incoming requests evaluated by [Google Cloud Armor security policies](https://cloud.google.com/armor/docs/security-policy-overview)." +"$ref": "GoogleCloudSecuritycenterV2Requests" }, "securityPolicy": { -"$ref": "GoogleCloudSecuritycenterV2SecurityPolicy", -"description": "Information about the [Google Cloud Armor security policy](https://cloud.google.com/armor/docs/security-policy-overview) relevant to the finding." +"$ref": "GoogleCloudSecuritycenterV2SecurityPolicy" }, "threatVector": { -"description": "Distinguish between volumetric & protocol DDoS attack and application layer attacks. For example, \"L3_4\" for Layer 3 and Layer 4 DDoS attacks, or \"L_7\" for Layer 7 DDoS attacks.", "type": "string" } }, "type": "object" }, "GoogleCloudSecuritycenterV2CloudControl": { -"description": "CloudControl associated with the finding.", "id": "GoogleCloudSecuritycenterV2CloudControl", "properties": { "cloudControlName": { -"description": "Name of the CloudControl associated with the finding.", "type": "string" }, "policyType": { -"description": "Policy type of the CloudControl", "type": "string" }, "type": { -"description": "Type of cloud control.", "enum": [ "CLOUD_CONTROL_TYPE_UNSPECIFIED", "BUILT_IN", "CUSTOM" ], "enumDescriptions": [ -"Unspecified.", -"Built in Cloud Control.", -"Custom Cloud Control." +"", +"", +"" ], "type": "string" }, "version": { -"description": "Version of the Cloud Control", "format": "int32", "type": "integer" } @@ -10572,31 +9454,27 @@ false "type": "object" }, "GoogleCloudSecuritycenterV2CloudDlpDataProfile": { -"description": "The [data profile](https://cloud.google.com/dlp/docs/data-profiles) associated with the finding.", "id": "GoogleCloudSecuritycenterV2CloudDlpDataProfile", "properties": { "dataProfile": { -"description": "Name of the data profile, for example, `projects/123/locations/europe/tableProfiles/8383929`.", "type": "string" }, "infoTypes": { -"description": "Type of information detected by SDP. Info type includes name, version and sensitivity of the detected information type.", "items": { "$ref": "GoogleCloudSecuritycenterV2InfoType" }, "type": "array" }, "parentType": { -"description": "The resource hierarchy level at which the data profile was generated.", "enum": [ "PARENT_TYPE_UNSPECIFIED", "ORGANIZATION", "PROJECT" ], "enumDescriptions": [ -"Unspecified parent type.", -"Organization-level configurations.", -"Project-level configurations." +"", +"", +"" ], "type": "string" } @@ -10604,47 +9482,37 @@ false "type": "object" }, "GoogleCloudSecuritycenterV2CloudDlpInspection": { -"description": "Details about the Cloud Data Loss Prevention (Cloud DLP) [inspection job](https://cloud.google.com/dlp/docs/concepts-job-triggers) that produced the finding.", "id": "GoogleCloudSecuritycenterV2CloudDlpInspection", "properties": { "fullScan": { -"description": "Whether Cloud DLP scanned the complete resource or a sampled subset.", "type": "boolean" }, "infoType": { -"description": "The type of information (or *[infoType](https://cloud.google.com/dlp/docs/infotypes-reference)*) found, for example, `EMAIL_ADDRESS` or `STREET_ADDRESS`.", "type": "string" }, "infoTypeCount": { -"description": "The number of times Cloud DLP found this infoType within this job and resource.", "format": "int64", "type": "string" }, "inspectJob": { -"description": "Name of the inspection job, for example, `projects/123/locations/europe/dlpJobs/i-8383929`.", "type": "string" } }, "type": "object" }, "GoogleCloudSecuritycenterV2CloudLoggingEntry": { -"description": "Metadata taken from a [Cloud Logging LogEntry](https://cloud.google.com/logging/docs/reference/v2/rest/v2/LogEntry)", "id": "GoogleCloudSecuritycenterV2CloudLoggingEntry", "properties": { "insertId": { -"description": "A unique identifier for the log entry.", "type": "string" }, "logId": { -"description": "The type of the log (part of `log_name`. `log_name` is the resource name of the log to which this log entry belongs). For example: `cloudresourcemanager.googleapis.com/activity` Note that this field is not URL-encoded, unlike in `LogEntry`.", "type": "string" }, "resourceContainer": { -"description": "The organization, folder, or project of the monitored resource that produced this log entry.", "type": "string" }, "timestamp": { -"description": "The time the event described by the log entry occurred.", "format": "google-datetime", "type": "string" } @@ -10652,44 +9520,36 @@ false "type": "object" }, "GoogleCloudSecuritycenterV2Compliance": { -"description": "Contains compliance information about a security standard indicating unmet recommendations.", "id": "GoogleCloudSecuritycenterV2Compliance", "properties": { "ids": { -"description": "Policies within the standard or benchmark, for example, A.12.4.1", "items": { "type": "string" }, "type": "array" }, "standard": { -"description": "Industry-wide compliance standards or benchmarks, such as CIS, PCI, and OWASP.", "type": "string" }, "version": { -"description": "Version of the standard or benchmark, for example, 1.1", "type": "string" } }, "type": "object" }, "GoogleCloudSecuritycenterV2ComplianceDetails": { -"description": "Compliance Details associated with the finding.", "id": "GoogleCloudSecuritycenterV2ComplianceDetails", "properties": { "cloudControl": { -"$ref": "GoogleCloudSecuritycenterV2CloudControl", -"description": "CloudControl associated with the finding" +"$ref": "GoogleCloudSecuritycenterV2CloudControl" }, "cloudControlDeploymentNames": { -"description": "Cloud Control Deployments associated with the finding. For example, organizations/123/locations/global/cloudControlDeployments/deploymentIdentifier", "items": { "type": "string" }, "type": "array" }, "frameworks": { -"description": "Details of Frameworks associated with the finding", "items": { "$ref": "GoogleCloudSecuritycenterV2Framework" }, @@ -10699,20 +9559,16 @@ false "type": "object" }, "GoogleCloudSecuritycenterV2Connection": { -"description": "Contains information about the IP connection associated with the finding.", "id": "GoogleCloudSecuritycenterV2Connection", "properties": { "destinationIp": { -"description": "Destination IP address. Not present for sockets that are listening and not connected.", "type": "string" }, "destinationPort": { -"description": "Destination port. Not present for sockets that are listening and not connected.", "format": "int32", "type": "integer" }, "protocol": { -"description": "IANA Internet Protocol Number such as TCP(6) and UDP(17).", "enum": [ "PROTOCOL_UNSPECIFIED", "ICMP", @@ -10722,21 +9578,19 @@ false "ESP" ], "enumDescriptions": [ -"Unspecified protocol (not HOPOPT).", -"Internet Control Message Protocol.", -"Transmission Control Protocol.", -"User Datagram Protocol.", -"Generic Routing Encapsulation.", -"Encap Security Payload." +"", +"", +"", +"", +"", +"" ], "type": "string" }, "sourceIp": { -"description": "Source IP address.", "type": "string" }, "sourcePort": { -"description": "Source port.", "format": "int32", "type": "integer" } @@ -10744,22 +9598,18 @@ false "type": "object" }, "GoogleCloudSecuritycenterV2Contact": { -"description": "The email address of a contact.", "id": "GoogleCloudSecuritycenterV2Contact", "properties": { "email": { -"description": "An email address. For example, \"`person123@company.com`\".", "type": "string" } }, "type": "object" }, "GoogleCloudSecuritycenterV2ContactDetails": { -"description": "Details about specific contacts", "id": "GoogleCloudSecuritycenterV2ContactDetails", "properties": { "contacts": { -"description": "A list of contacts", "items": { "$ref": "GoogleCloudSecuritycenterV2Contact" }, @@ -10769,66 +9619,53 @@ false "type": "object" }, "GoogleCloudSecuritycenterV2Container": { -"description": "Container associated with the finding.", "id": "GoogleCloudSecuritycenterV2Container", "properties": { "createTime": { -"description": "The time that the container was created.", "format": "google-datetime", "type": "string" }, "imageId": { -"description": "Optional container image ID, if provided by the container runtime. Uniquely identifies the container image launched using a container image digest.", "type": "string" }, "labels": { -"description": "Container labels, as provided by the container runtime.", "items": { "$ref": "GoogleCloudSecuritycenterV2Label" }, "type": "array" }, "name": { -"description": "Name of the container.", "type": "string" }, "uri": { -"description": "Container image URI provided when configuring a pod or container. This string can identify a container image version using mutable tags.", "type": "string" } }, "type": "object" }, "GoogleCloudSecuritycenterV2Control": { -"description": "Compliance control associated with the finding.", "id": "GoogleCloudSecuritycenterV2Control", "properties": { "controlName": { -"description": "Name of the Control", "type": "string" }, "displayName": { -"description": "Display name of the control. For example, AU-02.", "type": "string" } }, "type": "object" }, "GoogleCloudSecuritycenterV2Cve": { -"description": "CVE stands for Common Vulnerabilities and Exposures. Information from the [CVE record](https://www.cve.org/ResourcesSupport/Glossary) that describes this vulnerability.", "id": "GoogleCloudSecuritycenterV2Cve", "properties": { "cvssv3": { -"$ref": "GoogleCloudSecuritycenterV2Cvssv3", -"description": "Describe Common Vulnerability Scoring System specified at https://www.first.org/cvss/v3.1/specification-document" +"$ref": "GoogleCloudSecuritycenterV2Cvssv3" }, "exploitReleaseDate": { -"description": "Date the first publicly available exploit or PoC was released.", "format": "google-datetime", "type": "string" }, "exploitationActivity": { -"description": "The exploitation activity of the vulnerability in the wild.", "enum": [ "EXPLOITATION_ACTIVITY_UNSPECIFIED", "WIDE", @@ -10838,26 +9675,23 @@ false "NO_KNOWN" ], "enumDescriptions": [ -"Invalid or empty value.", -"Exploitation has been reported or confirmed to widely occur.", -"Limited reported or confirmed exploitation activities.", -"Exploit is publicly available.", -"No known exploitation activity, but has a high potential for exploitation.", -"No known exploitation activity." +"", +"", +"", +"", +"", +"" ], "type": "string" }, "firstExploitationDate": { -"description": "Date of the earliest known exploitation.", "format": "google-datetime", "type": "string" }, "id": { -"description": "The unique identifier for the vulnerability. e.g. CVE-2021-34527", "type": "string" }, "impact": { -"description": "The potential impact of the vulnerability if it was to be exploited.", "enum": [ "RISK_RATING_UNSPECIFIED", "LOW", @@ -10866,56 +9700,49 @@ false "CRITICAL" ], "enumDescriptions": [ -"Invalid or empty value.", -"Exploitation would have little to no security impact.", -"Exploitation would enable attackers to perform activities, or could allow attackers to have a direct impact, but would require additional steps.", -"Exploitation would enable attackers to have a notable direct impact without needing to overcome any major mitigating factors.", -"Exploitation would fundamentally undermine the security of affected systems, enable actors to perform significant attacks with minimal effort, with little to no mitigating factors to overcome." +"", +"", +"", +"", +"" ], "type": "string" }, "observedInTheWild": { -"description": "Whether or not the vulnerability has been observed in the wild.", "type": "boolean" }, "references": { -"description": "Additional information about the CVE. e.g. https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2021-34527", "items": { "$ref": "GoogleCloudSecuritycenterV2Reference" }, "type": "array" }, "upstreamFixAvailable": { -"description": "Whether upstream fix is available for the CVE.", "type": "boolean" }, "zeroDay": { -"description": "Whether or not the vulnerability was zero day when the finding was published.", "type": "boolean" } }, "type": "object" }, "GoogleCloudSecuritycenterV2Cvssv3": { -"description": "Common Vulnerability Scoring System version 3.", "id": "GoogleCloudSecuritycenterV2Cvssv3", "properties": { "attackComplexity": { -"description": "This metric describes the conditions beyond the attacker's control that must exist in order to exploit the vulnerability.", "enum": [ "ATTACK_COMPLEXITY_UNSPECIFIED", "ATTACK_COMPLEXITY_LOW", "ATTACK_COMPLEXITY_HIGH" ], "enumDescriptions": [ -"Invalid value.", -"Specialized access conditions or extenuating circumstances do not exist. An attacker can expect repeatable success when attacking the vulnerable component.", -"A successful attack depends on conditions beyond the attacker's control. That is, a successful attack cannot be accomplished at will, but requires the attacker to invest in some measurable amount of effort in preparation or execution against the vulnerable component before a successful attack can be expected." +"", +"", +"" ], "type": "string" }, "attackVector": { -"description": "Base Metrics Represents the intrinsic characteristics of a vulnerability that are constant over time and across user environments. This metric reflects the context by which vulnerability exploitation is possible.", "enum": [ "ATTACK_VECTOR_UNSPECIFIED", "ATTACK_VECTOR_NETWORK", @@ -10924,16 +9751,15 @@ false "ATTACK_VECTOR_PHYSICAL" ], "enumDescriptions": [ -"Invalid value.", -"The vulnerable component is bound to the network stack and the set of possible attackers extends beyond the other options listed below, up to and including the entire Internet.", -"The vulnerable component is bound to the network stack, but the attack is limited at the protocol level to a logically adjacent topology.", -"The vulnerable component is not bound to the network stack and the attacker's path is via read/write/execute capabilities.", -"The attack requires the attacker to physically touch or manipulate the vulnerable component." +"", +"", +"", +"", +"" ], "type": "string" }, "availabilityImpact": { -"description": "This metric measures the impact to the availability of the impacted component resulting from a successfully exploited vulnerability.", "enum": [ "IMPACT_UNSPECIFIED", "IMPACT_HIGH", @@ -10941,20 +9767,18 @@ false "IMPACT_NONE" ], "enumDescriptions": [ -"Invalid value.", -"High impact.", -"Low impact.", -"No impact." +"", +"", +"", +"" ], "type": "string" }, "baseScore": { -"description": "The base score is a function of the base metric scores.", "format": "double", "type": "number" }, "confidentialityImpact": { -"description": "This metric measures the impact to the confidentiality of the information resources managed by a software component due to a successfully exploited vulnerability.", "enum": [ "IMPACT_UNSPECIFIED", "IMPACT_HIGH", @@ -10962,15 +9786,14 @@ false "IMPACT_NONE" ], "enumDescriptions": [ -"Invalid value.", -"High impact.", -"Low impact.", -"No impact." +"", +"", +"", +"" ], "type": "string" }, "integrityImpact": { -"description": "This metric measures the impact to integrity of a successfully exploited vulnerability.", "enum": [ "IMPACT_UNSPECIFIED", "IMPACT_HIGH", @@ -10978,15 +9801,14 @@ false "IMPACT_NONE" ], "enumDescriptions": [ -"Invalid value.", -"High impact.", -"Low impact.", -"No impact." +"", +"", +"", +"" ], "type": "string" }, "privilegesRequired": { -"description": "This metric describes the level of privileges an attacker must possess before successfully exploiting the vulnerability.", "enum": [ "PRIVILEGES_REQUIRED_UNSPECIFIED", "PRIVILEGES_REQUIRED_NONE", @@ -10994,38 +9816,36 @@ false "PRIVILEGES_REQUIRED_HIGH" ], "enumDescriptions": [ -"Invalid value.", -"The attacker is unauthorized prior to attack, and therefore does not require any access to settings or files of the vulnerable system to carry out an attack.", -"The attacker requires privileges that provide basic user capabilities that could normally affect only settings and files owned by a user. Alternatively, an attacker with Low privileges has the ability to access only non-sensitive resources.", -"The attacker requires privileges that provide significant (e.g., administrative) control over the vulnerable component allowing access to component-wide settings and files." +"", +"", +"", +"" ], "type": "string" }, "scope": { -"description": "The Scope metric captures whether a vulnerability in one vulnerable component impacts resources in components beyond its security scope.", "enum": [ "SCOPE_UNSPECIFIED", "SCOPE_UNCHANGED", "SCOPE_CHANGED" ], "enumDescriptions": [ -"Invalid value.", -"An exploited vulnerability can only affect resources managed by the same security authority.", -"An exploited vulnerability can affect resources beyond the security scope managed by the security authority of the vulnerable component." +"", +"", +"" ], "type": "string" }, "userInteraction": { -"description": "This metric captures the requirement for a human user, other than the attacker, to participate in the successful compromise of the vulnerable component.", "enum": [ "USER_INTERACTION_UNSPECIFIED", "USER_INTERACTION_NONE", "USER_INTERACTION_REQUIRED" ], "enumDescriptions": [ -"Invalid value.", -"The vulnerable system can be exploited without interaction from any user.", -"Successful exploitation of this vulnerability requires a user to take some action before the vulnerability can be exploited." +"", +"", +"" ], "type": "string" } @@ -11033,15 +9853,12 @@ false "type": "object" }, "GoogleCloudSecuritycenterV2Cwe": { -"description": "CWE stands for Common Weakness Enumeration. Information about this weakness, as described by [CWE](https://cwe.mitre.org/).", "id": "GoogleCloudSecuritycenterV2Cwe", "properties": { "id": { -"description": "The CWE identifier, e.g. CWE-94", "type": "string" }, "references": { -"description": "Any reference to the details on the CWE, for example, https://cwe.mitre.org/data/definitions/94.html", "items": { "$ref": "GoogleCloudSecuritycenterV2Reference" }, @@ -11051,20 +9868,16 @@ false "type": "object" }, "GoogleCloudSecuritycenterV2DataAccessEvent": { -"description": "Details about a data access attempt made by a principal not authorized under applicable data security policy.", "id": "GoogleCloudSecuritycenterV2DataAccessEvent", "properties": { "eventId": { -"description": "Unique identifier for data access event.", "type": "string" }, "eventTime": { -"description": "Timestamp of data access event.", "format": "google-datetime", "type": "string" }, "operation": { -"description": "The operation performed by the principal to access the data.", "enum": [ "OPERATION_UNSPECIFIED", "READ", @@ -11072,35 +9885,30 @@ false "COPY" ], "enumDescriptions": [ -"The operation is unspecified.", -"Represents a read operation.", -"Represents a move operation.", -"Represents a copy operation." +"", +"", +"", +"" ], "type": "string" }, "principalEmail": { -"description": "The email address of the principal that accessed the data. The principal could be a user account, service account, Google group, or other.", "type": "string" } }, "type": "object" }, "GoogleCloudSecuritycenterV2DataFlowEvent": { -"description": "Details about a data flow event, in which either the data is moved to or is accessed from a non-compliant geo-location, as defined in the applicable data security policy.", "id": "GoogleCloudSecuritycenterV2DataFlowEvent", "properties": { "eventId": { -"description": "Unique identifier for data flow event.", "type": "string" }, "eventTime": { -"description": "Timestamp of data flow event.", "format": "google-datetime", "type": "string" }, "operation": { -"description": "The operation performed by the principal for the data flow event.", "enum": [ "OPERATION_UNSPECIFIED", "READ", @@ -11108,40 +9916,34 @@ false "COPY" ], "enumDescriptions": [ -"The operation is unspecified.", -"Represents a read operation.", -"Represents a move operation.", -"Represents a copy operation." +"", +"", +"", +"" ], "type": "string" }, "principalEmail": { -"description": "The email address of the principal that initiated the data flow event. The principal could be a user account, service account, Google group, or other.", "type": "string" }, "violatedLocation": { -"description": "Non-compliant location of the principal or the data destination.", "type": "string" } }, "type": "object" }, "GoogleCloudSecuritycenterV2DataRetentionDeletionEvent": { -"description": "Details about data retention deletion violations, in which the data is non-compliant based on their retention or deletion time, as defined in the applicable data security policy. The Data Retention Deletion (DRD) control is a control of the DSPM (Data Security Posture Management) suite that enables organizations to manage data retention and deletion policies in compliance with regulations, such as GDPR and CRPA. DRD supports two primary policy types: maximum storage length (max TTL) and minimum storage length (min TTL). Both are aimed at helping organizations meet regulatory and data management commitments.", "id": "GoogleCloudSecuritycenterV2DataRetentionDeletionEvent", "properties": { "dataObjectCount": { -"description": "Number of objects that violated the policy for this resource. If the number is less than 1,000, then the value of this field is the exact number. If the number of objects that violated the policy is greater than or equal to 1,000, then the value of this field is 1000.", "format": "int64", "type": "string" }, "eventDetectionTime": { -"description": "Timestamp indicating when the event was detected.", "format": "google-datetime", "type": "string" }, "eventType": { -"description": "Type of the DRD event.", "enum": [ "EVENT_TYPE_UNSPECIFIED", "EVENT_TYPE_MAX_TTL_EXCEEDED", @@ -11157,21 +9959,19 @@ false, false ], "enumDescriptions": [ -"Unspecified event type.", -"Deprecated: This field is pending removal. Use EVENT_TYPE_MAX_TTL_FROM_CREATION or EVENT_TYPE_MAX_TTL_FROM_LAST_MODIFICATION instead.", -"Max TTL from the asset's creation time.", -"Max TTL from the asset's last modification time.", -"Min TTL from the asset's creation time." +"", +"", +"", +"", +"" ], "type": "string" }, "maxRetentionAllowed": { -"description": "Maximum duration of retention allowed from the DRD control. This comes from the DRD control where users set a max TTL for their data. For example, suppose that a user sets the max TTL for a Cloud Storage bucket to 90 days. However, an object in that bucket is 100 days old. In this case, a DataRetentionDeletionEvent will be generated for that Cloud Storage bucket, and the max_retention_allowed is 90 days.", "format": "google-duration", "type": "string" }, "minRetentionAllowed": { -"description": "Min duration of retention allowed from the DSPM retention control. This field is only populated when event type is set to EVENT_TYPE_MIN_TTL_FROM_CREATION.", "format": "google-duration", "type": "string" } @@ -11179,64 +9979,51 @@ false "type": "object" }, "GoogleCloudSecuritycenterV2Database": { -"description": "Represents database access information, such as queries. A database may be a sub-resource of an instance (as in the case of Cloud SQL instances or Cloud Spanner instances), or the database instance itself. Some database resources might not have the [full resource name](https://google.aip.dev/122#full-resource-names) populated because these resource types, such as Cloud SQL databases, are not yet supported by Cloud Asset Inventory. In these cases only the display name is provided.", "id": "GoogleCloudSecuritycenterV2Database", "properties": { "displayName": { -"description": "The human-readable name of the database that the user connected to.", "type": "string" }, "grantees": { -"description": "The target usernames, roles, or groups of an SQL privilege grant, which is not an IAM policy change.", "items": { "type": "string" }, "type": "array" }, "name": { -"description": "Some database resources may not have the [full resource name](https://google.aip.dev/122#full-resource-names) populated because these resource types are not yet supported by Cloud Asset Inventory (e.g. Cloud SQL databases). In these cases only the display name will be provided. The [full resource name](https://google.aip.dev/122#full-resource-names) of the database that the user connected to, if it is supported by Cloud Asset Inventory.", "type": "string" }, "query": { -"description": "The SQL statement that is associated with the database access.", "type": "string" }, "userName": { -"description": "The username used to connect to the database. The username might not be an IAM principal and does not have a set format.", "type": "string" }, "version": { -"description": "The version of the database, for example, POSTGRES_14. See [the complete list](https://cloud.google.com/sql/docs/mysql/admin-api/rest/v1/SqlDatabaseVersion).", "type": "string" } }, "type": "object" }, "GoogleCloudSecuritycenterV2Dataset": { -"description": "Vertex AI dataset associated with the finding.", "id": "GoogleCloudSecuritycenterV2Dataset", "properties": { "displayName": { -"description": "The user defined display name of dataset, e.g. plants-dataset", "type": "string" }, "name": { -"description": "Resource name of the dataset, e.g. projects/{project}/locations/{location}/datasets/2094040236064505856", "type": "string" }, "source": { -"description": "Data source, such as a BigQuery source URI, e.g. bq://scc-nexus-test.AIPPtest.gsod", "type": "string" } }, "type": "object" }, "GoogleCloudSecuritycenterV2Denied": { -"description": "Denied IP rule.", "id": "GoogleCloudSecuritycenterV2Denied", "properties": { "ipRules": { -"description": "Optional. Optional list of denied IP rules.", "items": { "$ref": "GoogleCloudSecuritycenterV2IpRule" }, @@ -11246,15 +10033,12 @@ false "type": "object" }, "GoogleCloudSecuritycenterV2Detection": { -"description": "Memory hash detection contributing to the binary family match.", "id": "GoogleCloudSecuritycenterV2Detection", "properties": { "binary": { -"description": "The name of the binary associated with the memory hash signature detection.", "type": "string" }, "percentPagesMatched": { -"description": "The percentage of memory page hashes in the signature that were matched.", "format": "double", "type": "number" } @@ -11262,35 +10046,29 @@ false "type": "object" }, "GoogleCloudSecuritycenterV2DiscoveredWorkload": { -"description": "Represents discovered, customer managed workload that is not registered with the respective GCP service.", "id": "GoogleCloudSecuritycenterV2DiscoveredWorkload", "properties": { "confidence": { -"description": "The confidence in detection of this workload.", "enum": [ "CONFIDENCE_UNSPECIFIED", "CONFIDENCE_HIGH" ], "enumDescriptions": [ -"Unspecified confidence level.", -"High confidence in detection of a workload." +"", +"" ], "type": "string" }, "detectedRelevantHardware": { -"description": "A boolean flag set to true if associated hardware strongly predicts the workload type.", "type": "boolean" }, "detectedRelevantKeywords": { -"description": "A boolean flag set to true if associated keywords strongly predict the workload type.", "type": "boolean" }, "detectedRelevantPackages": { -"description": "A boolean flag set to true if installed packages strongly predict the workload type.", "type": "boolean" }, "workloadType": { -"description": "The type of workload.", "enum": [ "WORKLOAD_TYPE_UNSPECIFIED", "MCP_SERVER", @@ -11298,10 +10076,10 @@ false "AGENT" ], "enumDescriptions": [ -"Unspecified workload type", -"A workload of type MCP Server", -"A workload of type AI Inference", -"A workload of type LLM Agent" +"", +"", +"", +"" ], "type": "string" } @@ -11309,100 +10087,82 @@ false "type": "object" }, "GoogleCloudSecuritycenterV2Disk": { -"description": "Contains information about the disk associated with the finding.", "id": "GoogleCloudSecuritycenterV2Disk", "properties": { "name": { -"description": "The name of the disk, for example, \"https://www.googleapis.com/compute/v1/projects/{project-id}/zones/{zone-id}/disks/{disk-id}\".", "type": "string" } }, "type": "object" }, "GoogleCloudSecuritycenterV2DiskPath": { -"description": "Path of the file in terms of underlying disk/partition identifiers.", "id": "GoogleCloudSecuritycenterV2DiskPath", "properties": { "partitionUuid": { -"description": "UUID of the partition (format https://wiki.archlinux.org/title/persistent_block_device_naming#by-uuid)", "type": "string" }, "relativePath": { -"description": "Relative path of the file in the partition as a JSON encoded string. Example: /home/user1/executable_file.sh", "type": "string" } }, "type": "object" }, "GoogleCloudSecuritycenterV2DynamicMuteRecord": { -"description": "The record of a dynamic mute rule that matches the finding.", "id": "GoogleCloudSecuritycenterV2DynamicMuteRecord", "properties": { "matchTime": { -"description": "When the dynamic mute rule first matched the finding.", "format": "google-datetime", "type": "string" }, "muteConfig": { -"description": "The relative resource name of the mute rule, represented by a mute config, that created this record, for example `organizations/123/muteConfigs/mymuteconfig` or `organizations/123/locations/global/muteConfigs/mymuteconfig`.", "type": "string" } }, "type": "object" }, "GoogleCloudSecuritycenterV2EnvironmentVariable": { -"description": "A name-value pair representing an environment variable used in an operating system process.", "id": "GoogleCloudSecuritycenterV2EnvironmentVariable", "properties": { "name": { -"description": "Environment variable name as a JSON encoded string.", "type": "string" }, "val": { -"description": "Environment variable value as a JSON encoded string.", "type": "string" } }, "type": "object" }, "GoogleCloudSecuritycenterV2ExfilResource": { -"description": "Resource where data was exfiltrated from or exfiltrated to.", "id": "GoogleCloudSecuritycenterV2ExfilResource", "properties": { "components": { -"description": "Subcomponents of the asset that was exfiltrated, like URIs used during exfiltration, table names, databases, and filenames. For example, multiple tables might have been exfiltrated from the same Cloud SQL instance, or multiple files might have been exfiltrated from the same Cloud Storage bucket.", "items": { "type": "string" }, "type": "array" }, "name": { -"description": "The resource's [full resource name](https://cloud.google.com/apis/design/resource_names#full_resource_name).", "type": "string" } }, "type": "object" }, "GoogleCloudSecuritycenterV2Exfiltration": { -"description": "Exfiltration represents a data exfiltration attempt from one or more sources to one or more targets. The `sources` attribute lists the sources of the exfiltrated data. The `targets` attribute lists the destinations the data was copied to.", "id": "GoogleCloudSecuritycenterV2Exfiltration", "properties": { "sources": { -"description": "If there are multiple sources, then the data is considered \"joined\" between them. For instance, BigQuery can join multiple tables, and each table would be considered a source.", "items": { "$ref": "GoogleCloudSecuritycenterV2ExfilResource" }, "type": "array" }, "targets": { -"description": "If there are multiple targets, each target would get a complete copy of the \"joined\" source data.", "items": { "$ref": "GoogleCloudSecuritycenterV2ExfilResource" }, "type": "array" }, "totalExfiltratedBytes": { -"description": "Total exfiltrated bytes processed for the entire job.", "format": "int64", "type": "string" } @@ -11410,205 +10170,162 @@ false "type": "object" }, "GoogleCloudSecuritycenterV2ExternalExposure": { -"description": "Details about the externally exposed resource associated with the finding.", "id": "GoogleCloudSecuritycenterV2ExternalExposure", "properties": { "backendBucket": { -"description": "The full resource name of the load balancer backend bucket, for example, \"//compute.googleapis.com/projects/{project-id}/global/backendBuckets/{name}\"", "type": "string" }, "backendService": { -"description": "The full resource name of load balancer backend service, for example, \"//compute.googleapis.com/projects/{project-id}/global/backendServices/{name}\".", "type": "string" }, "exposedApplication": { -"description": "The name and version of the exposed web application, for example, \"Jenkins 2.184\".", "type": "string" }, "exposedEndpoint": { -"description": "The resource which is running the exposed service, for example, \"//compute.googleapis.com/projects/{project-id}/zones/{zone}/instances/{instance}.\u201d", "type": "string" }, "exposedService": { -"description": "The name and version of the service, for example, \"Jupyter Notebook 6.14.0\".", "type": "string" }, "forwardingRule": { -"description": "The full resource name of the forwarding rule, for example, \"//compute.googleapis.com/projects/{project-id}/global/forwardingRules/{forwarding-rule-name}\".", "type": "string" }, "hostnameUri": { -"description": "Hostname of the exposed application, for example, \"https://test-app.a.run.app/\"", "type": "string" }, "httpResponse": { -"description": "The http response returned by the web application.", "items": { "$ref": "GoogleCloudSecuritycenterV2HttpResponse" }, "type": "array" }, "instanceGroup": { -"description": "The full resource name of the instance group, for example, \"//compute.googleapis.com/projects/{project-id}/global/instanceGroups/{name}\".", "type": "string" }, "internalBackendService": { -"description": "The full resource name of load balancer backend service in the internal project having resource exposed via PSC, for example, \"//compute.googleapis.com/projects/{project-id}/global/backendServices/{name}\".", "type": "string" }, "loadBalancerFirewallPolicy": { -"description": "The full resource name of the load balancer firewall policy, for example, \"//compute.googleapis.com/projects/{project-id}/global/firewallPolicies/{policy-name}\".", "type": "string" }, "networkEndpointGroup": { -"description": "The full resource name of the network endpoint group, for example, \"//compute.googleapis.com/projects/{project-id}/global/networkEndpointGroups/{name}\".", "type": "string" }, "networkIngressFirewallPolicy": { -"description": "The full resource name of the network ingress firewall policy, for example, \"//compute.googleapis.com/projects/{project-id}/global/firewallPolicies/{name}\".", "type": "string" }, "privateIpAddress": { -"description": "Private IP address of the exposed endpoint.", "type": "string" }, "privatePort": { -"description": "Port number associated with private IP address.", "type": "string" }, "pscNetworkAttachment": { -"description": "The full resource name of the PSC (Private Service Connect) network attachment that network interface controller is attached to, for example, \"//compute.googleapis.com/projects/{project-id}/regions/{region}/networkAttachments/{name}\"", "type": "string" }, "pscServiceAttachment": { -"description": "The full resource name of the PSC (Private Service Connect) service attachment that the load balancer network endpoint group targets, for example, \"//compute.googleapis.com/projects/{project-id}/regions/{region}/serviceAttachments/{name}\"", "type": "string" }, "publicIpAddress": { -"description": "Public IP address of the exposed endpoint.", "type": "string" }, "publicPort": { -"description": "Public port number of the exposed endpoint.", "type": "string" }, "serviceFirewallPolicy": { -"description": "The full resource name of the firewall policy of the exposed service, for example, \"//compute.googleapis.com/projects/{project-id}/global/firewallPolicies/{policy-name}\".", "type": "string" } }, "type": "object" }, "GoogleCloudSecuritycenterV2ExternalSystem": { -"description": "Representation of third party SIEM/SOAR fields within SCC.", "id": "GoogleCloudSecuritycenterV2ExternalSystem", "properties": { "assignees": { -"description": "References primary/secondary etc assignees in the external system.", "items": { "type": "string" }, "type": "array" }, "caseCloseTime": { -"description": "The time when the case was closed, as reported by the external system.", "format": "google-datetime", "type": "string" }, "caseCreateTime": { -"description": "The time when the case was created, as reported by the external system.", "format": "google-datetime", "type": "string" }, "casePriority": { -"description": "The priority of the finding's corresponding case in the external system.", "type": "string" }, "caseSla": { -"description": "The SLA of the finding's corresponding case in the external system.", "format": "google-datetime", "type": "string" }, "caseUri": { -"description": "The link to the finding's corresponding case in the external system.", "type": "string" }, "externalSystemUpdateTime": { -"description": "The time when the case was last updated, as reported by the external system.", "format": "google-datetime", "type": "string" }, "externalUid": { -"description": "The identifier that's used to track the finding's corresponding case in the external system.", "type": "string" }, "name": { -"description": "Full resource name of the external system. The following list shows some examples: + `organizations/1234/sources/5678/findings/123456/externalSystems/jira` + `organizations/1234/sources/5678/locations/us/findings/123456/externalSystems/jira` + `folders/1234/sources/5678/findings/123456/externalSystems/jira` + `folders/1234/sources/5678/locations/us/findings/123456/externalSystems/jira` + `projects/1234/sources/5678/findings/123456/externalSystems/jira` + `projects/1234/sources/5678/locations/us/findings/123456/externalSystems/jira`", "type": "string" }, "status": { -"description": "The most recent status of the finding's corresponding case, as reported by the external system.", "type": "string" }, "ticketInfo": { -"$ref": "GoogleCloudSecuritycenterV2TicketInfo", -"description": "Information about the ticket, if any, that is being used to track the resolution of the issue that is identified by this finding." +"$ref": "GoogleCloudSecuritycenterV2TicketInfo" } }, "type": "object" }, "GoogleCloudSecuritycenterV2File": { -"description": "File information about the related binary/library used by an executable, or the script used by a script interpreter", "id": "GoogleCloudSecuritycenterV2File", "properties": { "contents": { -"description": "Prefix of the file contents as a JSON-encoded string.", "type": "string" }, "diskPath": { -"$ref": "GoogleCloudSecuritycenterV2DiskPath", -"description": "Path of the file in terms of underlying disk/partition identifiers." +"$ref": "GoogleCloudSecuritycenterV2DiskPath" }, "fileLoadState": { -"description": "The load state of the file.", "enum": [ "FILE_LOAD_STATE_UNSPECIFIED", "LOADED_BY_PROCESS", "NOT_LOADED_BY_PROCESS" ], "enumDescriptions": [ -"The file state is unspecified.", -"The file is being used by an active process at the time of scanning.", -"The file is not being used by any active process at the time of scanning." +"", +"", +"" ], "type": "string" }, "hashedSize": { -"description": "The length in bytes of the file prefix that was hashed. If hashed_size == size, any hashes reported represent the entire file.", "format": "int64", "type": "string" }, "operations": { -"description": "Operation(s) performed on a file.", "items": { "$ref": "GoogleCloudSecuritycenterV2FileOperation" }, "type": "array" }, "partiallyHashed": { -"description": "True when the hash covers only a prefix of the file.", "type": "boolean" }, "path": { -"description": "Absolute path of the file as a JSON encoded string.", "type": "string" }, "sha256": { -"description": "SHA256 hash of the first hashed_size bytes of the file encoded as a hex string. If hashed_size == size, sha256 represents the SHA256 hash of the entire file.", "type": "string" }, "size": { -"description": "Size of the file in bytes.", "format": "int64", "type": "string" } @@ -11616,11 +10333,9 @@ false "type": "object" }, "GoogleCloudSecuritycenterV2FileOperation": { -"description": "Operation(s) performed on a file.", "id": "GoogleCloudSecuritycenterV2FileOperation", "properties": { "type": { -"description": "The type of the operation", "enum": [ "OPERATION_TYPE_UNSPECIFIED", "OPEN", @@ -11630,12 +10345,12 @@ false "EXECUTE" ], "enumDescriptions": [ -"The operation is unspecified.", -"Represents an open operation.", -"Represents a read operation.", -"Represents a rename operation.", -"Represents a write operation.", -"Represents an execute operation." +"", +"", +"", +"", +"", +"" ], "type": "string" } @@ -11643,82 +10358,64 @@ false "type": "object" }, "GoogleCloudSecuritycenterV2Finding": { -"description": "Security Command Center finding. A finding is a record of assessment data like security, risk, health, or privacy, that is ingested into Security Command Center for presentation, notification, analysis, policy testing, and enforcement. For example, a cross-site scripting (XSS) vulnerability in an App Engine application is a finding.", "id": "GoogleCloudSecuritycenterV2Finding", "properties": { "access": { -"$ref": "GoogleCloudSecuritycenterV2Access", -"description": "Access details associated with the finding, such as more information on the caller, which method was accessed, and from where." +"$ref": "GoogleCloudSecuritycenterV2Access" }, "affectedResources": { -"$ref": "GoogleCloudSecuritycenterV2AffectedResources", -"description": "AffectedResources associated with the finding." +"$ref": "GoogleCloudSecuritycenterV2AffectedResources" }, "agentDataAccessEvents": { -"description": "Agent data access events associated with the finding.", "items": { "$ref": "GoogleCloudSecuritycenterV2AgentDataAccessEvent" }, "type": "array" }, "aiModel": { -"$ref": "GoogleCloudSecuritycenterV2AiModel", -"description": "The AI model associated with the finding." +"$ref": "GoogleCloudSecuritycenterV2AiModel" }, "application": { -"$ref": "GoogleCloudSecuritycenterV2Application", -"description": "Represents an application associated with the finding." +"$ref": "GoogleCloudSecuritycenterV2Application" }, "artifactGuardPolicies": { -"$ref": "GoogleCloudSecuritycenterV2ArtifactGuardPolicies", -"description": "ArtifactGuardPolicies associated with the finding." +"$ref": "GoogleCloudSecuritycenterV2ArtifactGuardPolicies" }, "attackExposure": { -"$ref": "GoogleCloudSecuritycenterV2AttackExposure", -"description": "The results of an attack path simulation relevant to this finding." +"$ref": "GoogleCloudSecuritycenterV2AttackExposure" }, "backupDisasterRecovery": { -"$ref": "GoogleCloudSecuritycenterV2BackupDisasterRecovery", -"description": "Fields related to Backup and DR findings." +"$ref": "GoogleCloudSecuritycenterV2BackupDisasterRecovery" }, "canonicalName": { -"description": "Output only. The canonical name of the finding. The following list shows some examples: + `organizations/{organization_id}/sources/{source_id}/locations/{location_id}/findings/{finding_id}` + `folders/{folder_id}/sources/{source_id}/locations/{location_id}/findings/{finding_id}` + `projects/{project_id}/sources/{source_id}/locations/{location_id}/findings/{finding_id}` The prefix is the closest CRM ancestor of the resource associated with the finding.", "readOnly": true, "type": "string" }, "category": { -"description": "Immutable. The additional taxonomy group within findings from a given source. Example: \"XSS_FLASH_INJECTION\"", "type": "string" }, "chokepoint": { -"$ref": "GoogleCloudSecuritycenterV2Chokepoint", -"description": "Contains details about a chokepoint, which is a resource or resource group where high-risk attack paths converge, based on [attack path simulations] (https://cloud.google.com/security-command-center/docs/attack-exposure-learn#attack_path_simulations). This field cannot be updated. Its value is ignored in all update requests." +"$ref": "GoogleCloudSecuritycenterV2Chokepoint" }, "cloudArmor": { -"$ref": "GoogleCloudSecuritycenterV2CloudArmor", -"description": "Fields related to Cloud Armor findings." +"$ref": "GoogleCloudSecuritycenterV2CloudArmor" }, "cloudDlpDataProfile": { -"$ref": "GoogleCloudSecuritycenterV2CloudDlpDataProfile", -"description": "Cloud DLP data profile that is associated with the finding." +"$ref": "GoogleCloudSecuritycenterV2CloudDlpDataProfile" }, "cloudDlpInspection": { -"$ref": "GoogleCloudSecuritycenterV2CloudDlpInspection", -"description": "Cloud Data Loss Prevention (Cloud DLP) inspection results that are associated with the finding." +"$ref": "GoogleCloudSecuritycenterV2CloudDlpInspection" }, "complianceDetails": { -"$ref": "GoogleCloudSecuritycenterV2ComplianceDetails", -"description": "Details about the compliance implications of the finding." +"$ref": "GoogleCloudSecuritycenterV2ComplianceDetails" }, "compliances": { -"description": "Contains compliance information for security standards associated to the finding.", "items": { "$ref": "GoogleCloudSecuritycenterV2Compliance" }, "type": "array" }, "connections": { -"description": "Contains information about the IP connection associated with the finding.", "items": { "$ref": "GoogleCloudSecuritycenterV2Connection" }, @@ -11728,99 +10425,81 @@ false "additionalProperties": { "$ref": "GoogleCloudSecuritycenterV2ContactDetails" }, -"description": "Output only. Map containing the points of contact for the given finding. The key represents the type of contact, while the value contains a list of all the contacts that pertain. Please refer to: https://cloud.google.com/resource-manager/docs/managing-notification-contacts#notification-categories { \"security\": { \"contacts\": [ { \"email\": \"person1@company.com\" }, { \"email\": \"person2@company.com\" } ] } }", "readOnly": true, "type": "object" }, "containers": { -"description": "Containers associated with the finding. This field provides information for both Kubernetes and non-Kubernetes containers.", "items": { "$ref": "GoogleCloudSecuritycenterV2Container" }, "type": "array" }, "createTime": { -"description": "Output only. The time at which the finding was created in Security Command Center.", "format": "google-datetime", "readOnly": true, "type": "string" }, "cryptoKeyName": { -"description": "Output only. The name of the Cloud KMS key used to encrypt this finding, if any.", "readOnly": true, "type": "string" }, "dataAccessEvents": { -"description": "Data access events associated with the finding.", "items": { "$ref": "GoogleCloudSecuritycenterV2DataAccessEvent" }, "type": "array" }, "dataFlowEvents": { -"description": "Data flow events associated with the finding.", "items": { "$ref": "GoogleCloudSecuritycenterV2DataFlowEvent" }, "type": "array" }, "dataRetentionDeletionEvents": { -"description": "Data retention deletion events associated with the finding.", "items": { "$ref": "GoogleCloudSecuritycenterV2DataRetentionDeletionEvent" }, "type": "array" }, "database": { -"$ref": "GoogleCloudSecuritycenterV2Database", -"description": "Database associated with the finding." +"$ref": "GoogleCloudSecuritycenterV2Database" }, "description": { -"description": "Contains more details about the finding.", "type": "string" }, "discoveredWorkload": { -"$ref": "GoogleCloudSecuritycenterV2DiscoveredWorkload", -"description": "DiscoveredWorkload associated with the finding." +"$ref": "GoogleCloudSecuritycenterV2DiscoveredWorkload" }, "disk": { -"$ref": "GoogleCloudSecuritycenterV2Disk", -"description": "Disk associated with the finding." +"$ref": "GoogleCloudSecuritycenterV2Disk" }, "eventTime": { -"description": "The time the finding was first detected. If an existing finding is updated, then this is the time the update occurred. For example, if the finding represents an open firewall, this property captures the time the detector believes the firewall became open. The accuracy is determined by the detector. If the finding is later resolved, then this time reflects when the finding was resolved. This must not be set to a value greater than the current timestamp.", "format": "google-datetime", "type": "string" }, "exfiltration": { -"$ref": "GoogleCloudSecuritycenterV2Exfiltration", -"description": "Represents exfiltrations associated with the finding." +"$ref": "GoogleCloudSecuritycenterV2Exfiltration" }, "externalExposure": { -"$ref": "GoogleCloudSecuritycenterV2ExternalExposure", -"description": "External exposure associated with the finding." +"$ref": "GoogleCloudSecuritycenterV2ExternalExposure" }, "externalSystems": { "additionalProperties": { "$ref": "GoogleCloudSecuritycenterV2ExternalSystem" }, -"description": "Output only. Third party SIEM/SOAR fields within SCC, contains external system information and external system finding fields.", "readOnly": true, "type": "object" }, "externalUri": { -"description": "The URI that, if available, points to a web page outside of Security Command Center where additional information about the finding can be found. This field is guaranteed to be either empty or a well formed URL.", "type": "string" }, "files": { -"description": "File associated with the finding.", "items": { "$ref": "GoogleCloudSecuritycenterV2File" }, "type": "array" }, "findingClass": { -"description": "The class of the finding.", "enum": [ "FINDING_CLASS_UNSPECIFIED", "THREAT", @@ -11836,79 +10515,67 @@ false "SECRET" ], "enumDescriptions": [ -"Unspecified finding class.", -"Describes unwanted or malicious activity.", -"Describes a potential weakness in software that increases risk to Confidentiality & Integrity & Availability.", -"Describes a potential weakness in cloud resource/asset configuration that increases risk.", -"Describes a security observation that is for informational purposes.", -"Describes an error that prevents some SCC functionality.", -"Describes a potential security risk due to a change in the security posture.", -"Describes a combination of security issues that represent a more severe security problem when taken together.", -"Describes a potential security risk to data assets that contain sensitive data.", -"Describes a resource or resource group where high risk attack paths converge, based on attack path simulations (APS).", -"Describes a potential security risk due to the resource being exposed to the internet.", -"Describes a potential security risk due to plaintext credentials, keys, or tokens being exposed in an asset or workload." +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"" ], "type": "string" }, "groupMemberships": { -"description": "Contains details about groups of which this finding is a member. A group is a collection of findings that are related in some way. This field cannot be updated. Its value is ignored in all update requests.", "items": { "$ref": "GoogleCloudSecuritycenterV2GroupMembership" }, "type": "array" }, "iamBindings": { -"description": "Represents IAM bindings associated with the finding.", "items": { "$ref": "GoogleCloudSecuritycenterV2IamBinding" }, "type": "array" }, "indicator": { -"$ref": "GoogleCloudSecuritycenterV2Indicator", -"description": "Represents what's commonly known as an *indicator of compromise* (IoC) in computer forensics. This is an artifact observed on a network or in an operating system that, with high confidence, indicates a computer intrusion. For more information, see [Indicator of compromise](https://en.wikipedia.org/wiki/Indicator_of_compromise)." +"$ref": "GoogleCloudSecuritycenterV2Indicator" }, "ipRules": { -"$ref": "GoogleCloudSecuritycenterV2IpRules", -"description": "IP rules associated with the finding." +"$ref": "GoogleCloudSecuritycenterV2IpRules" }, "job": { -"$ref": "GoogleCloudSecuritycenterV2Job", -"description": "Job associated with the finding." +"$ref": "GoogleCloudSecuritycenterV2Job" }, "kernelRootkit": { -"$ref": "GoogleCloudSecuritycenterV2KernelRootkit", -"description": "Signature of the kernel rootkit." +"$ref": "GoogleCloudSecuritycenterV2KernelRootkit" }, "kubernetes": { -"$ref": "GoogleCloudSecuritycenterV2Kubernetes", -"description": "Kubernetes resources associated with the finding." +"$ref": "GoogleCloudSecuritycenterV2Kubernetes" }, "loadBalancers": { -"description": "The load balancers associated with the finding.", "items": { "$ref": "GoogleCloudSecuritycenterV2LoadBalancer" }, "type": "array" }, "logEntries": { -"description": "Log entries that are relevant to the finding.", "items": { "$ref": "GoogleCloudSecuritycenterV2LogEntry" }, "type": "array" }, "mitreAttack": { -"$ref": "GoogleCloudSecuritycenterV2MitreAttack", -"description": "MITRE ATT&CK tactics and techniques related to this finding. See: https://attack.mitre.org" +"$ref": "GoogleCloudSecuritycenterV2MitreAttack" }, "moduleName": { -"description": "Unique identifier of the module which generated the finding. Example: folders/598186756061/securityHealthAnalyticsSettings/customModules/56799441161885", "type": "string" }, "mute": { -"description": "Indicates the mute state of a finding (either muted, unmuted or undefined). Unlike other attributes of a finding, a finding provider shouldn't set the value of mute.", "enum": [ "MUTE_UNSPECIFIED", "MUTED", @@ -11916,93 +10583,76 @@ false "UNDEFINED" ], "enumDescriptions": [ -"Unspecified.", -"Finding has been muted.", -"Finding has been unmuted.", -"Finding has never been muted/unmuted." +"", +"", +"", +"" ], "type": "string" }, "muteInfo": { "$ref": "GoogleCloudSecuritycenterV2MuteInfo", -"description": "Output only. The mute information regarding this finding.", "readOnly": true }, "muteInitiator": { -"description": "Records additional information about the mute operation, for example, the [mute configuration](https://cloud.google.com/security-command-center/docs/how-to-mute-findings) that muted the finding and the user who muted the finding.", "type": "string" }, "muteUpdateTime": { -"description": "Output only. The most recent time this finding was muted or unmuted.", "format": "google-datetime", "readOnly": true, "type": "string" }, "name": { -"description": "Identifier. The [relative resource name](https://cloud.google.com/apis/design/resource_names#relative_resource_name) of the finding. The following list shows some examples: + `organizations/{organization_id}/sources/{source_id}/findings/{finding_id}` + `organizations/{organization_id}/sources/{source_id}/locations/{location_id}/findings/{finding_id}` + `folders/{folder_id}/sources/{source_id}/findings/{finding_id}` + `folders/{folder_id}/sources/{source_id}/locations/{location_id}/findings/{finding_id}` + `projects/{project_id}/sources/{source_id}/findings/{finding_id}` + `projects/{project_id}/sources/{source_id}/locations/{location_id}/findings/{finding_id}`", "type": "string" }, "networks": { -"description": "Represents the VPC networks that the resource is attached to.", "items": { "$ref": "GoogleCloudSecuritycenterV2Network" }, "type": "array" }, "nextSteps": { -"description": "Steps to address the finding.", "type": "string" }, "notebook": { -"$ref": "GoogleCloudSecuritycenterV2Notebook", -"description": "Notebook associated with the finding." +"$ref": "GoogleCloudSecuritycenterV2Notebook" }, "orgPolicies": { -"description": "Contains information about the org policies associated with the finding.", "items": { "$ref": "GoogleCloudSecuritycenterV2OrgPolicy" }, "type": "array" }, "parent": { -"description": "The relative resource name of the source and location the finding belongs to. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name This field is immutable after creation time. The following list shows some examples: + `organizations/{organization_id}/sources/{source_id}` + `folders/{folders_id}/sources/{source_id}` + `projects/{projects_id}/sources/{source_id}` + `organizations/{organization_id}/sources/{source_id}/locations/{location_id}` + `folders/{folders_id}/sources/{source_id}/locations/{location_id}` + `projects/{projects_id}/sources/{source_id}/locations/{location_id}`", "type": "string" }, "parentDisplayName": { -"description": "Output only. The human readable display name of the finding source such as \"Event Threat Detection\" or \"Security Health Analytics\".", "readOnly": true, "type": "string" }, "policyViolationSummary": { -"$ref": "GoogleCloudSecuritycenterV2PolicyViolationSummary", -"description": "PolicyViolationSummary associated with the finding." +"$ref": "GoogleCloudSecuritycenterV2PolicyViolationSummary" }, "processes": { -"description": "Represents operating system processes associated with the Finding.", "items": { "$ref": "GoogleCloudSecuritycenterV2Process" }, "type": "array" }, "resourceName": { -"description": "Immutable. For findings on Google Cloud resources, the full resource name of the Google Cloud resource this finding is for. See: https://cloud.google.com/apis/design/resource_names#full_resource_name When the finding is for a non-Google Cloud resource, the resourceName can be a customer or partner defined string.", "type": "string" }, "secret": { -"$ref": "GoogleCloudSecuritycenterV2Secret", -"description": "Secret associated with the finding." +"$ref": "GoogleCloudSecuritycenterV2Secret" }, "securityMarks": { "$ref": "GoogleCloudSecuritycenterV2SecurityMarks", -"description": "Output only. User specified security marks. These marks are entirely managed by the user and come from the SecurityMarks resource that belongs to the finding.", "readOnly": true }, "securityPosture": { -"$ref": "GoogleCloudSecuritycenterV2SecurityPosture", -"description": "The security posture associated with the finding." +"$ref": "GoogleCloudSecuritycenterV2SecurityPosture" }, "severity": { -"description": "The severity of the finding. This field is managed by the source that writes the finding.", "enum": [ "SEVERITY_UNSPECIFIED", "CRITICAL", @@ -12011,11 +10661,11 @@ false "LOW" ], "enumDescriptions": [ -"This value is used for findings when a source doesn't write a severity value.", -"Vulnerability: A critical vulnerability is easily discoverable by an external actor, exploitable, and results in the direct ability to execute arbitrary code, exfiltrate data, and otherwise gain additional access and privileges to cloud resources and workloads. Examples include publicly accessible unprotected user data and public SSH access with weak or no passwords. Threat: Indicates a threat that is able to access, modify, or delete data or execute unauthorized code within existing resources.", -"Vulnerability: A high risk vulnerability can be easily discovered and exploited in combination with other vulnerabilities in order to gain direct access and the ability to execute arbitrary code, exfiltrate data, and otherwise gain additional access and privileges to cloud resources and workloads. An example is a database with weak or no passwords that is only accessible internally. This database could easily be compromised by an actor that had access to the internal network. Threat: Indicates a threat that is able to create new computational resources in an environment but not able to access data or execute code in existing resources.", -"Vulnerability: A medium risk vulnerability could be used by an actor to gain access to resources or privileges that enable them to eventually (through multiple steps or a complex exploit) gain access and the ability to execute arbitrary code or exfiltrate data. An example is a service account with access to more projects than it should have. If an actor gains access to the service account, they could potentially use that access to manipulate a project the service account was not intended to. Threat: Indicates a threat that is able to cause operational impact but may not access data or execute unauthorized code.", -"Vulnerability: A low risk vulnerability hampers a security organization's ability to detect vulnerabilities or active threats in their deployment, or prevents the root cause investigation of security issues. An example is monitoring and logs being disabled for resource configurations and access. Threat: Indicates a threat that has obtained minimal access to an environment but is not able to access data, execute code, or create resources." +"", +"", +"", +"", +"" ], "type": "string" }, @@ -12023,60 +10673,50 @@ false "additionalProperties": { "type": "any" }, -"description": "Source specific properties. These properties are managed by the source that writes the finding. The key names in the source_properties map must be between 1 and 255 characters, and must start with a letter and contain alphanumeric characters or underscores only.", "type": "object" }, "state": { -"description": "Output only. The state of the finding.", "enum": [ "STATE_UNSPECIFIED", "ACTIVE", "INACTIVE" ], "enumDescriptions": [ -"Unspecified state.", -"The finding requires attention and has not been addressed yet.", -"The finding has been fixed, triaged as a non-issue or otherwise addressed and is no longer active." +"", +"", +"" ], "readOnly": true, "type": "string" }, "toxicCombination": { -"$ref": "GoogleCloudSecuritycenterV2ToxicCombination", -"description": "Contains details about a group of security issues that, when the issues occur together, represent a greater risk than when the issues occur independently. A group of such issues is referred to as a toxic combination. This field cannot be updated. Its value is ignored in all update requests." +"$ref": "GoogleCloudSecuritycenterV2ToxicCombination" }, "vertexAi": { -"$ref": "GoogleCloudSecuritycenterV2VertexAi", -"description": "VertexAi associated with the finding." +"$ref": "GoogleCloudSecuritycenterV2VertexAi" }, "vulnerability": { -"$ref": "GoogleCloudSecuritycenterV2Vulnerability", -"description": "Represents vulnerability-specific fields like CVE and CVSS scores. CVE stands for Common Vulnerabilities and Exposures (https://cve.mitre.org/about/)" +"$ref": "GoogleCloudSecuritycenterV2Vulnerability" } }, "type": "object" }, "GoogleCloudSecuritycenterV2Folder": { -"description": "Message that contains the resource name and display name of a folder resource.", "id": "GoogleCloudSecuritycenterV2Folder", "properties": { "resourceFolder": { -"description": "Full resource name of this folder. See: https://cloud.google.com/apis/design/resource_names#full_resource_name", "type": "string" }, "resourceFolderDisplayName": { -"description": "The user defined display name for this folder.", "type": "string" } }, "type": "object" }, "GoogleCloudSecuritycenterV2Framework": { -"description": "Compliance framework associated with the finding.", "id": "GoogleCloudSecuritycenterV2Framework", "properties": { "category": { -"description": "Category of the framework associated with the finding. E.g. Security Benchmark, or Assured Workloads", "items": { "enum": [ "FRAMEWORK_CATEGORY_UNSPECIFIED", @@ -12087,43 +10727,39 @@ false "CUSTOM_FRAMEWORK" ], "enumDescriptions": [ -"Default value. This value is unused.", -"Security Benchmarks framework", -"Assured Workloads framework", -"Data Security framework", -"Google Best Practices framework", -"A user-created framework" +"", +"", +"", +"", +"", +"" ], "type": "string" }, "type": "array" }, "controls": { -"description": "The controls associated with the framework.", "items": { "$ref": "GoogleCloudSecuritycenterV2Control" }, "type": "array" }, "displayName": { -"description": "Display name of the framework. For a standard framework, this will look like e.g. PCI DSS 3.2.1, whereas for a custom framework it can be a user defined string like MyFramework", "type": "string" }, "name": { -"description": "Name of the framework associated with the finding", "type": "string" }, "type": { -"description": "Type of the framework associated with the finding, to specify whether the framework is built-in (pre-defined and immutable) or a custom framework defined by the customer (equivalent to security posture)", "enum": [ "FRAMEWORK_TYPE_UNSPECIFIED", "FRAMEWORK_TYPE_BUILT_IN", "FRAMEWORK_TYPE_CUSTOM" ], "enumDescriptions": [ -"Default value. This value is unused.", -"The framework is a built-in framework if it is created and managed by GCP.", -"The framework is a custom framework if it is created and managed by the user." +"", +"", +"" ], "type": "string" } @@ -12131,35 +10767,30 @@ false "type": "object" }, "GoogleCloudSecuritycenterV2Geolocation": { -"description": "Represents a geographical location for a given access.", "id": "GoogleCloudSecuritycenterV2Geolocation", "properties": { "regionCode": { -"description": "A CLDR.", "type": "string" } }, "type": "object" }, "GoogleCloudSecuritycenterV2GroupMembership": { -"description": "Contains details about groups of which this finding is a member. A group is a collection of findings that are related in some way.", "id": "GoogleCloudSecuritycenterV2GroupMembership", "properties": { "groupId": { -"description": "ID of the group.", "type": "string" }, "groupType": { -"description": "Type of group.", "enum": [ "GROUP_TYPE_UNSPECIFIED", "GROUP_TYPE_TOXIC_COMBINATION", "GROUP_TYPE_CHOKEPOINT" ], "enumDescriptions": [ -"Default value.", -"Group represents a toxic combination.", -"Group represents a chokepoint." +"", +"", +"" ], "type": "string" } @@ -12167,76 +10798,64 @@ false "type": "object" }, "GoogleCloudSecuritycenterV2HttpResponse": { -"description": "The http response returned by the web application.", "id": "GoogleCloudSecuritycenterV2HttpResponse", "properties": { "path": { -"description": "The http path for which response code was returned by web application, for example, \"https://test-app.a.run.app/test\".", "type": "string" }, "statusCode": { -"description": "The http response code returned by the web application, for example, 200.", "type": "string" } }, "type": "object" }, "GoogleCloudSecuritycenterV2IamBinding": { -"description": "Represents a particular IAM binding, which captures a member's role addition, removal, or state.", "id": "GoogleCloudSecuritycenterV2IamBinding", "properties": { "action": { -"description": "The action that was performed on a Binding.", "enum": [ "ACTION_UNSPECIFIED", "ADD", "REMOVE" ], "enumDescriptions": [ -"Unspecified.", -"Addition of a Binding.", -"Removal of a Binding." +"", +"", +"" ], "type": "string" }, "member": { -"description": "A single identity requesting access for a Cloud Platform resource, for example, \"foo@google.com\".", "type": "string" }, "role": { -"description": "Role that is assigned to \"members\". For example, \"roles/viewer\", \"roles/editor\", or \"roles/owner\".", "type": "string" } }, "type": "object" }, "GoogleCloudSecuritycenterV2Indicator": { -"description": "Represents what's commonly known as an _indicator of compromise_ (IoC) in computer forensics. This is an artifact observed on a network or in an operating system that, with high confidence, indicates a computer intrusion. For more information, see [Indicator of compromise](https://en.wikipedia.org/wiki/Indicator_of_compromise).", "id": "GoogleCloudSecuritycenterV2Indicator", "properties": { "domains": { -"description": "List of domains associated to the Finding.", "items": { "type": "string" }, "type": "array" }, "ipAddresses": { -"description": "The list of IP addresses that are associated with the finding.", "items": { "type": "string" }, "type": "array" }, "signatures": { -"description": "The list of matched signatures indicating that the given process is present in the environment.", "items": { "$ref": "GoogleCloudSecuritycenterV2ProcessSignature" }, "type": "array" }, "uris": { -"description": "The list of URIs associated to the Findings.", "items": { "type": "string" }, @@ -12246,84 +10865,70 @@ false "type": "object" }, "GoogleCloudSecuritycenterV2InfoType": { -"description": "Type of information detected by the API.", "id": "GoogleCloudSecuritycenterV2InfoType", "properties": { "name": { -"description": "Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`.", "type": "string" }, "sensitivityScore": { -"$ref": "GoogleCloudSecuritycenterV2SensitivityScore", -"description": "Optional custom sensitivity for this InfoType. This only applies to data profiling." +"$ref": "GoogleCloudSecuritycenterV2SensitivityScore" }, "version": { -"description": "Optional version name for this InfoType.", "type": "string" } }, "type": "object" }, "GoogleCloudSecuritycenterV2IpRule": { -"description": "IP rule information.", "id": "GoogleCloudSecuritycenterV2IpRule", "properties": { "portRanges": { -"description": "Optional. An optional list of ports to which this rule applies. This field is only applicable for the UDP or (S)TCP protocols. Each entry must be either an integer or a range including a min and max port number.", "items": { "$ref": "GoogleCloudSecuritycenterV2PortRange" }, "type": "array" }, "protocol": { -"description": "The IP protocol this rule applies to. This value can either be one of the following well known protocol strings (TCP, UDP, ICMP, ESP, AH, IPIP, SCTP) or a string representation of the integer value.", "type": "string" } }, "type": "object" }, "GoogleCloudSecuritycenterV2IpRules": { -"description": "IP rules associated with the finding.", "id": "GoogleCloudSecuritycenterV2IpRules", "properties": { "allowed": { -"$ref": "GoogleCloudSecuritycenterV2Allowed", -"description": "Tuple with allowed rules." +"$ref": "GoogleCloudSecuritycenterV2Allowed" }, "denied": { -"$ref": "GoogleCloudSecuritycenterV2Denied", -"description": "Tuple with denied rules." +"$ref": "GoogleCloudSecuritycenterV2Denied" }, "destinationIpRanges": { -"description": "If destination IP ranges are specified, the firewall rule applies only to traffic that has a destination IP address in these ranges. These ranges must be expressed in CIDR format. Only supports IPv4.", "items": { "type": "string" }, "type": "array" }, "direction": { -"description": "The direction that the rule is applicable to, one of ingress or egress.", "enum": [ "DIRECTION_UNSPECIFIED", "INGRESS", "EGRESS" ], "enumDescriptions": [ -"Unspecified direction value.", -"Ingress direction value.", -"Egress direction value." +"", +"", +"" ], "type": "string" }, "exposedServices": { -"description": "Name of the network protocol service, such as FTP, that is exposed by the open port. Follows the naming convention available at: https://www.iana.org/assignments/service-names-port-numbers/service-names-port-numbers.xhtml.", "items": { "type": "string" }, "type": "array" }, "sourceIpRanges": { -"description": "If source IP ranges are specified, the firewall rule applies only to traffic that has a source IP address in these ranges. These ranges must be expressed in CIDR format. Only supports IPv4.", "items": { "type": "string" }, @@ -12333,37 +10938,30 @@ false "type": "object" }, "GoogleCloudSecuritycenterV2Issue": { -"description": "Security Command Center Issue.", "id": "GoogleCloudSecuritycenterV2Issue", "properties": { "createTime": { -"description": "Output only. The time the issue was created.", "format": "google-datetime", "readOnly": true, "type": "string" }, "description": { -"description": "The description of the issue in Markdown format.", "type": "string" }, "detection": { -"description": "The finding category or rule name that generated the issue.", "type": "string" }, "domains": { -"description": "The domains of the issue.", "items": { "$ref": "GoogleCloudSecuritycenterV2IssueDomain" }, "type": "array" }, "exposureScore": { -"description": "The exposure score of the issue.", "format": "double", "type": "number" }, "issueType": { -"description": "The type of the issue.", "enum": [ "ISSUE_TYPE_UNSPECIFIED", "CHOKEPOINT", @@ -12371,60 +10969,51 @@ false "INSIGHT" ], "enumDescriptions": [ -"Unspecified issue type.", -"Chokepoint issue type.", -"Toxic combination issue type.", -"Insight issue type." +"", +"", +"", +"" ], "type": "string" }, "lastObservationTime": { -"description": "The time the issue was last observed.", "format": "google-datetime", "type": "string" }, "mute": { -"$ref": "GoogleCloudSecuritycenterV2IssueMute", -"description": "The mute information of the issue." +"$ref": "GoogleCloudSecuritycenterV2IssueMute" }, "name": { -"description": "Identifier. The name of the issue. Format: organizations/{organization}/locations/{location}/issues/{issue}", "type": "string" }, "primaryResource": { -"$ref": "GoogleCloudSecuritycenterV2IssueResource", -"description": "The primary resource associated with the issue." +"$ref": "GoogleCloudSecuritycenterV2IssueResource" }, "relatedFindings": { -"description": "The findings related to the issue.", "items": { "$ref": "GoogleCloudSecuritycenterV2IssueFinding" }, "type": "array" }, "remediations": { -"description": "Approaches to remediate the issue in Markdown format.", "items": { "type": "string" }, "type": "array" }, "secondaryResources": { -"description": "Additional resources associated with the issue.", "items": { "$ref": "GoogleCloudSecuritycenterV2IssueResource" }, "type": "array" }, "securityContexts": { -"description": "The security context of the issue.", "items": { "$ref": "GoogleCloudSecuritycenterV2IssueSecurityContext" }, "type": "array" }, "severity": { -"description": "The severity of the issue.", "enum": [ "SEVERITY_UNSPECIFIED", "CRITICAL", @@ -12433,31 +11022,29 @@ false "LOW" ], "enumDescriptions": [ -"Unspecified severity.", -"Critical severity.", -"High severity.", -"Medium severity.", -"Low severity." +"", +"", +"", +"", +"" ], "type": "string" }, "state": { -"description": "Output only. The state of the issue.", "enum": [ "STATE_UNSPECIFIED", "ACTIVE", "INACTIVE" ], "enumDescriptions": [ -"Unspecified state.", -"Active state.", -"Inactive state." +"", +"", +"" ], "readOnly": true, "type": "string" }, "updateTime": { -"description": "Output only. The time the issue was last updated.", "format": "google-datetime", "readOnly": true, "type": "string" @@ -12466,11 +11053,9 @@ false "type": "object" }, "GoogleCloudSecuritycenterV2IssueDomain": { -"description": "The domains of an issue.", "id": "GoogleCloudSecuritycenterV2IssueDomain", "properties": { "domainCategory": { -"description": "The domain category of the issue.", "enum": [ "DOMAIN_CATEGORY_UNSPECIFIED", "AI", @@ -12482,14 +11067,14 @@ false "THREAT" ], "enumDescriptions": [ -"Unspecified domain category.", -"Issues in the AI domain.", -"Issues in the code domain.", -"Issues in the container domain.", -"Issues in the data domain.", -"Issues in the identity and access domain.", -"Issues in the vulnerability domain.", -"Issues in the threat domain." +"", +"", +"", +"", +"", +"", +"", +"" ], "type": "string" } @@ -12497,75 +11082,62 @@ false "type": "object" }, "GoogleCloudSecuritycenterV2IssueFinding": { -"description": "Finding related to an issue.", "id": "GoogleCloudSecuritycenterV2IssueFinding", "properties": { "cve": { -"$ref": "GoogleCloudSecuritycenterV2IssueFindingCve", -"description": "The CVE of the finding." +"$ref": "GoogleCloudSecuritycenterV2IssueFindingCve" }, "name": { -"description": "The name of the finding.", "type": "string" }, "securityBulletin": { -"$ref": "GoogleCloudSecuritycenterV2IssueFindingSecurityBulletin", -"description": "The security bulletin of the finding." +"$ref": "GoogleCloudSecuritycenterV2IssueFindingSecurityBulletin" } }, "type": "object" }, "GoogleCloudSecuritycenterV2IssueFindingCve": { -"description": "The CVE of the finding.", "id": "GoogleCloudSecuritycenterV2IssueFindingCve", "properties": { "name": { -"description": "The CVE name.", "type": "string" } }, "type": "object" }, "GoogleCloudSecuritycenterV2IssueFindingSecurityBulletin": { -"description": "The security bulletin of the finding.", "id": "GoogleCloudSecuritycenterV2IssueFindingSecurityBulletin", "properties": { "name": { -"description": "The security bulletin name.", "type": "string" } }, "type": "object" }, "GoogleCloudSecuritycenterV2IssueMute": { -"description": "The mute information of the issue.", "id": "GoogleCloudSecuritycenterV2IssueMute", "properties": { "muteInitiator": { -"description": "The email address of the user who last changed the mute state of the issue.", "type": "string" }, "muteReason": { -"description": "The user-provided reason for muting the issue.", "type": "string" }, "muteState": { -"description": "Output only. The mute state of the issue.", "enum": [ "MUTE_STATE_UNSPECIFIED", "NOT_MUTED", "MUTED" ], "enumDescriptions": [ -"Unspecified mute state.", -"Not muted.", -"Muted." +"", +"", +"" ], "readOnly": true, "type": "string" }, "muteUpdateTime": { -"description": "The time the issue was muted.", "format": "google-datetime", "type": "string" } @@ -12573,35 +11145,27 @@ false "type": "object" }, "GoogleCloudSecuritycenterV2IssueResource": { -"description": "A resource associated with the an issue.", "id": "GoogleCloudSecuritycenterV2IssueResource", "properties": { "adcApplication": { -"$ref": "GoogleCloudSecuritycenterV2IssueResourceAdcApplication", -"description": "The ADC application associated with the finding." +"$ref": "GoogleCloudSecuritycenterV2IssueResourceAdcApplication" }, "adcApplicationTemplate": { -"$ref": "GoogleCloudSecuritycenterV2IssueResourceAdcApplicationTemplateRevision", -"description": "The ADC template associated with the finding." +"$ref": "GoogleCloudSecuritycenterV2IssueResourceAdcApplicationTemplateRevision" }, "adcSharedTemplate": { -"$ref": "GoogleCloudSecuritycenterV2IssueResourceAdcSharedTemplateRevision", -"description": "The ADC shared template associated with the finding." +"$ref": "GoogleCloudSecuritycenterV2IssueResourceAdcSharedTemplateRevision" }, "application": { -"$ref": "GoogleCloudSecuritycenterV2IssueResourceApplication", -"description": "The AppHub application associated with the resource, if any. Only populated for the primary resource." +"$ref": "GoogleCloudSecuritycenterV2IssueResourceApplication" }, "awsMetadata": { -"$ref": "GoogleCloudSecuritycenterV2IssueResourceAwsMetadata", -"description": "The AWS metadata of the resource associated with the issue. Only populated for AWS resources." +"$ref": "GoogleCloudSecuritycenterV2IssueResourceAwsMetadata" }, "azureMetadata": { -"$ref": "GoogleCloudSecuritycenterV2IssueResourceAzureMetadata", -"description": "The Azure metadata of the resource associated with the issue. Only populated for Azure resources." +"$ref": "GoogleCloudSecuritycenterV2IssueResourceAzureMetadata" }, "cloudProvider": { -"description": "The cloud provider of the resource associated with the issue.", "enum": [ "CLOUD_PROVIDER_UNSPECIFIED", "GOOGLE_CLOUD", @@ -12609,112 +11173,92 @@ false "MICROSOFT_AZURE" ], "enumDescriptions": [ -"Unspecified cloud provider.", -"Google Cloud.", -"Amazon Web Services.", -"Microsoft Azure." +"", +"", +"", +"" ], "type": "string" }, "displayName": { -"description": "The resource-type specific display name of the resource associated with the issue.", "type": "string" }, "googleCloudMetadata": { -"$ref": "GoogleCloudSecuritycenterV2IssueResourceGoogleCloudMetadata", -"description": "The Google Cloud metadata of the resource associated with the issue. Only populated for Google Cloud resources." +"$ref": "GoogleCloudSecuritycenterV2IssueResourceGoogleCloudMetadata" }, "name": { -"description": "The full resource name of the resource associated with the issue.", "type": "string" }, "type": { -"description": "The type of the resource associated with the issue.", "type": "string" } }, "type": "object" }, "GoogleCloudSecuritycenterV2IssueResourceAdcApplication": { -"description": "Represents an ADC application associated with the finding.", "id": "GoogleCloudSecuritycenterV2IssueResourceAdcApplication", "properties": { "attributes": { -"$ref": "GoogleCloudSecuritycenterV2IssueResourceApplicationAttributes", -"description": "Consumer provided attributes for the AppHub application." +"$ref": "GoogleCloudSecuritycenterV2IssueResourceApplicationAttributes" }, "name": { -"description": "The resource name of an ADC Application. Format: projects/{project}/locations/{location}/spaces/{space}/applications/{application}", "type": "string" } }, "type": "object" }, "GoogleCloudSecuritycenterV2IssueResourceAdcApplicationTemplateRevision": { -"description": "Represents an ADC template associated with the finding.", "id": "GoogleCloudSecuritycenterV2IssueResourceAdcApplicationTemplateRevision", "properties": { "name": { -"description": "The resource name of an ADC Application Template Revision. Format: projects/{project}/locations/{location}/spaces/{space}/applicationTemplates/{application_template}/revisions/{revision}", "type": "string" } }, "type": "object" }, "GoogleCloudSecuritycenterV2IssueResourceAdcSharedTemplateRevision": { -"description": "Represents an ADC shared template associated with the finding.", "id": "GoogleCloudSecuritycenterV2IssueResourceAdcSharedTemplateRevision", "properties": { "name": { -"description": "The resource name of an ADC Shared Template Revision. Format: projects/{project}/locations/{location}/spaces/{space}/applicationTemplates/{application_template}/revisions/{revision}", "type": "string" } }, "type": "object" }, "GoogleCloudSecuritycenterV2IssueResourceApplication": { -"description": "The AppHub application associated with the resource, if any.", "id": "GoogleCloudSecuritycenterV2IssueResourceApplication", "properties": { "attributes": { -"$ref": "GoogleCloudSecuritycenterV2IssueResourceApplicationAttributes", -"description": "Consumer provided attributes for the application" +"$ref": "GoogleCloudSecuritycenterV2IssueResourceApplicationAttributes" }, "name": { -"description": "The resource name of an Application. Format: `projects/{host-project-id}/locations/{location}/applications/{application-id}`", "type": "string" } }, "type": "object" }, "GoogleCloudSecuritycenterV2IssueResourceApplicationAttributes": { -"description": "Consumer provided attributes for the application", "id": "GoogleCloudSecuritycenterV2IssueResourceApplicationAttributes", "properties": { "businessOwners": { -"description": "Business team that ensures user needs are met and value is delivered", "items": { "$ref": "GoogleCloudSecuritycenterV2IssueResourceApplicationAttributesContactInfo" }, "type": "array" }, "criticality": { -"$ref": "GoogleCloudSecuritycenterV2IssueResourceApplicationAttributesCriticality", -"description": "User-defined criticality information." +"$ref": "GoogleCloudSecuritycenterV2IssueResourceApplicationAttributesCriticality" }, "developerOwners": { -"description": "Developer team that owns development and coding.", "items": { "$ref": "GoogleCloudSecuritycenterV2IssueResourceApplicationAttributesContactInfo" }, "type": "array" }, "environment": { -"$ref": "GoogleCloudSecuritycenterV2IssueResourceApplicationAttributesEnvironment", -"description": "User-defined environment information." +"$ref": "GoogleCloudSecuritycenterV2IssueResourceApplicationAttributesEnvironment" }, "operatorOwners": { -"description": "Operator team that ensures runtime and operations.", "items": { "$ref": "GoogleCloudSecuritycenterV2IssueResourceApplicationAttributesContactInfo" }, @@ -12724,22 +11268,18 @@ false "type": "object" }, "GoogleCloudSecuritycenterV2IssueResourceApplicationAttributesContactInfo": { -"description": "Contact information of stakeholders.", "id": "GoogleCloudSecuritycenterV2IssueResourceApplicationAttributesContactInfo", "properties": { "email": { -"description": "Email address of the contacts.", "type": "string" } }, "type": "object" }, "GoogleCloudSecuritycenterV2IssueResourceApplicationAttributesCriticality": { -"description": "Criticality of the Application, Service, or Workload", "id": "GoogleCloudSecuritycenterV2IssueResourceApplicationAttributesCriticality", "properties": { "type": { -"description": "Criticality Type.", "enum": [ "CRITICALITY_TYPE_UNSPECIFIED", "MISSION_CRITICAL", @@ -12748,11 +11288,11 @@ false "LOW" ], "enumDescriptions": [ -"Unspecified type.", -"Mission critical service, application or workload.", -"High impact.", -"Medium impact.", -"Low impact." +"", +"", +"", +"", +"" ], "type": "string" } @@ -12760,11 +11300,9 @@ false "type": "object" }, "GoogleCloudSecuritycenterV2IssueResourceApplicationAttributesEnvironment": { -"description": "Environment of the Application, Service, or Workload", "id": "GoogleCloudSecuritycenterV2IssueResourceApplicationAttributesEnvironment", "properties": { "type": { -"description": "Environment Type.", "enum": [ "ENVIRONMENT_TYPE_UNSPECIFIED", "PRODUCTION", @@ -12773,11 +11311,11 @@ false "DEVELOPMENT" ], "enumDescriptions": [ -"Unspecified type.", -"Production environment.", -"Staging environment.", -"Test environment.", -"Development environment." +"", +"", +"", +"", +"" ], "type": "string" } @@ -12785,93 +11323,75 @@ false "type": "object" }, "GoogleCloudSecuritycenterV2IssueResourceAwsMetadata": { -"description": "The AWS metadata of a resource associated with an issue.", "id": "GoogleCloudSecuritycenterV2IssueResourceAwsMetadata", "properties": { "account": { -"$ref": "GoogleCloudSecuritycenterV2IssueResourceAwsMetadataAwsAccount", -"description": "The AWS account of the resource associated with the issue." +"$ref": "GoogleCloudSecuritycenterV2IssueResourceAwsMetadataAwsAccount" } }, "type": "object" }, "GoogleCloudSecuritycenterV2IssueResourceAwsMetadataAwsAccount": { -"description": "The AWS account of the resource associated with the issue.", "id": "GoogleCloudSecuritycenterV2IssueResourceAwsMetadataAwsAccount", "properties": { "id": { -"description": "The AWS account ID of the resource associated with the issue.", "type": "string" }, "name": { -"description": "The AWS account name of the resource associated with the issue.", "type": "string" } }, "type": "object" }, "GoogleCloudSecuritycenterV2IssueResourceAzureMetadata": { -"description": "The Azure metadata of a resource associated with an issue.", "id": "GoogleCloudSecuritycenterV2IssueResourceAzureMetadata", "properties": { "subscription": { -"$ref": "GoogleCloudSecuritycenterV2IssueResourceAzureMetadataAzureSubscription", -"description": "The Azure subscription of the resource associated with the issue." +"$ref": "GoogleCloudSecuritycenterV2IssueResourceAzureMetadataAzureSubscription" } }, "type": "object" }, "GoogleCloudSecuritycenterV2IssueResourceAzureMetadataAzureSubscription": { -"description": "The Azure subscription of the resource associated with the issue.", "id": "GoogleCloudSecuritycenterV2IssueResourceAzureMetadataAzureSubscription", "properties": { "displayName": { -"description": "The Azure subscription display name of the resource associated with the issue.", "type": "string" }, "id": { -"description": "The Azure subscription ID of the resource associated with the issue.", "type": "string" } }, "type": "object" }, "GoogleCloudSecuritycenterV2IssueResourceGoogleCloudMetadata": { -"description": "Google Cloud metadata of a resource associated with an issue.", "id": "GoogleCloudSecuritycenterV2IssueResourceGoogleCloudMetadata", "properties": { "projectId": { -"description": "The project ID that the resource associated with the issue belongs to.", "type": "string" } }, "type": "object" }, "GoogleCloudSecuritycenterV2IssueSecurityContext": { -"description": "Security context associated with an issue.", "id": "GoogleCloudSecuritycenterV2IssueSecurityContext", "properties": { "aggregatedCount": { -"$ref": "GoogleCloudSecuritycenterV2IssueSecurityContextAggregatedCount", -"description": "The aggregated count of the security context." +"$ref": "GoogleCloudSecuritycenterV2IssueSecurityContextAggregatedCount" }, "context": { -"$ref": "GoogleCloudSecuritycenterV2IssueSecurityContextContext", -"description": "The context of the security context." +"$ref": "GoogleCloudSecuritycenterV2IssueSecurityContextContext" } }, "type": "object" }, "GoogleCloudSecuritycenterV2IssueSecurityContextAggregatedCount": { -"description": "Aggregated count of a security context.", "id": "GoogleCloudSecuritycenterV2IssueSecurityContextAggregatedCount", "properties": { "key": { -"description": "Aggregation key.", "type": "string" }, "value": { -"description": "Aggregation value.", "format": "int32", "type": "integer" } @@ -12879,15 +11399,12 @@ false "type": "object" }, "GoogleCloudSecuritycenterV2IssueSecurityContextContext": { -"description": "Context of a security context.", "id": "GoogleCloudSecuritycenterV2IssueSecurityContextContext", "properties": { "type": { -"description": "Context type.", "type": "string" }, "values": { -"description": "Context values.", "items": { "type": "string" }, @@ -12897,24 +11414,19 @@ false "type": "object" }, "GoogleCloudSecuritycenterV2Job": { -"description": "Describes a job", "id": "GoogleCloudSecuritycenterV2Job", "properties": { "errorCode": { -"description": "Optional. If the job did not complete successfully, this field describes why.", "format": "int32", "type": "integer" }, "location": { -"description": "Optional. Gives the location where the job ran, such as `US` or `europe-west1`", "type": "string" }, "name": { -"description": "The fully-qualified name for a job. e.g. `projects//jobs/`", "type": "string" }, "state": { -"description": "Output only. State of the job, such as `RUNNING` or `PENDING`.", "enum": [ "JOB_STATE_UNSPECIFIED", "PENDING", @@ -12923,11 +11435,11 @@ false "FAILED" ], "enumDescriptions": [ -"Unspecified represents an unknown state and should not be used.", -"Job is scheduled and pending for run", -"Job in progress", -"Job has completed with success", -"Job has completed but with failure" +"", +"", +"", +"", +"" ], "readOnly": true, "type": "string" @@ -12936,96 +11448,78 @@ false "type": "object" }, "GoogleCloudSecuritycenterV2KernelRootkit": { -"description": "Kernel mode rootkit signatures.", "id": "GoogleCloudSecuritycenterV2KernelRootkit", "properties": { "name": { -"description": "Rootkit name, when available.", "type": "string" }, "unexpectedCodeModification": { -"description": "True if unexpected modifications of kernel code memory are present.", "type": "boolean" }, "unexpectedFtraceHandler": { -"description": "True if `ftrace` points are present with callbacks pointing to regions that are not in the expected kernel or module code range.", "type": "boolean" }, "unexpectedInterruptHandler": { -"description": "True if interrupt handlers that are are not in the expected kernel or module code regions are present.", "type": "boolean" }, "unexpectedKernelCodePages": { -"description": "True if kernel code pages that are not in the expected kernel or module code regions are present.", "type": "boolean" }, "unexpectedKprobeHandler": { -"description": "True if `kprobe` points are present with callbacks pointing to regions that are not in the expected kernel or module code range.", "type": "boolean" }, "unexpectedProcessesInRunqueue": { -"description": "True if unexpected processes in the scheduler run queue are present. Such processes are in the run queue, but not in the process task list.", "type": "boolean" }, "unexpectedReadOnlyDataModification": { -"description": "True if unexpected modifications of kernel read-only data memory are present.", "type": "boolean" }, "unexpectedSystemCallHandler": { -"description": "True if system call handlers that are are not in the expected kernel or module code regions are present.", "type": "boolean" } }, "type": "object" }, "GoogleCloudSecuritycenterV2Kubernetes": { -"description": "Kubernetes-related attributes.", "id": "GoogleCloudSecuritycenterV2Kubernetes", "properties": { "accessReviews": { -"description": "Provides information on any Kubernetes access reviews (privilege checks) relevant to the finding.", "items": { "$ref": "GoogleCloudSecuritycenterV2AccessReview" }, "type": "array" }, "bindings": { -"description": "Provides Kubernetes role binding information for findings that involve [RoleBindings or ClusterRoleBindings](https://cloud.google.com/kubernetes-engine/docs/how-to/role-based-access-control).", "items": { "$ref": "GoogleCloudSecuritycenterV2Binding" }, "type": "array" }, "nodePools": { -"description": "GKE [node pools](https://cloud.google.com/kubernetes-engine/docs/concepts/node-pools) associated with the finding. This field contains node pool information for each node, when it is available.", "items": { "$ref": "GoogleCloudSecuritycenterV2NodePool" }, "type": "array" }, "nodes": { -"description": "Provides Kubernetes [node](https://cloud.google.com/kubernetes-engine/docs/concepts/cluster-architecture#nodes) information.", "items": { "$ref": "GoogleCloudSecuritycenterV2Node" }, "type": "array" }, "objects": { -"description": "Kubernetes objects related to the finding.", "items": { "$ref": "GoogleCloudSecuritycenterV2Object" }, "type": "array" }, "pods": { -"description": "Kubernetes [Pods](https://cloud.google.com/kubernetes-engine/docs/concepts/pod) associated with the finding. This field contains Pod records for each container that is owned by a Pod.", "items": { "$ref": "GoogleCloudSecuritycenterV2Pod" }, "type": "array" }, "roles": { -"description": "Provides Kubernetes role information for findings that involve [Roles or ClusterRoles](https://cloud.google.com/kubernetes-engine/docs/how-to/role-based-access-control).", "items": { "$ref": "GoogleCloudSecuritycenterV2Role" }, @@ -13035,52 +11529,42 @@ false "type": "object" }, "GoogleCloudSecuritycenterV2Label": { -"description": "Represents a generic name-value label. A label has separate name and value fields to support filtering with the `contains()` function. For more information, see [Filtering on array-type fields](https://cloud.google.com/security-command-center/docs/how-to-api-list-findings#array-contains-filtering).", "id": "GoogleCloudSecuritycenterV2Label", "properties": { "name": { -"description": "Name of the label.", "type": "string" }, "value": { -"description": "Value that corresponds to the label's name.", "type": "string" } }, "type": "object" }, "GoogleCloudSecuritycenterV2LoadBalancer": { -"description": "Contains information related to the load balancer associated with the finding.", "id": "GoogleCloudSecuritycenterV2LoadBalancer", "properties": { "name": { -"description": "The name of the load balancer associated with the finding.", "type": "string" } }, "type": "object" }, "GoogleCloudSecuritycenterV2LogEntry": { -"description": "An individual entry in a log.", "id": "GoogleCloudSecuritycenterV2LogEntry", "properties": { "cloudLoggingEntry": { -"$ref": "GoogleCloudSecuritycenterV2CloudLoggingEntry", -"description": "An individual entry in a log stored in Cloud Logging." +"$ref": "GoogleCloudSecuritycenterV2CloudLoggingEntry" } }, "type": "object" }, "GoogleCloudSecuritycenterV2MemoryHashSignature": { -"description": "A signature corresponding to memory page hashes.", "id": "GoogleCloudSecuritycenterV2MemoryHashSignature", "properties": { "binaryFamily": { -"description": "The binary family.", "type": "string" }, "detections": { -"description": "The list of memory hash detections contributing to the binary family match.", "items": { "$ref": "GoogleCloudSecuritycenterV2Detection" }, @@ -13090,11 +11574,9 @@ false "type": "object" }, "GoogleCloudSecuritycenterV2MitreAttack": { -"description": "MITRE ATT&CK tactics and techniques related to this finding. See: https://attack.mitre.org", "id": "GoogleCloudSecuritycenterV2MitreAttack", "properties": { "additionalTactics": { -"description": "Additional MITRE ATT&CK tactics related to this finding, if any.", "items": { "enum": [ "TACTIC_UNSPECIFIED", @@ -13114,28 +11596,27 @@ false "IMPACT" ], "enumDescriptions": [ -"Unspecified value.", -"TA0043", -"TA0042", -"TA0001", -"TA0002", -"TA0003", -"TA0004", -"TA0005", -"TA0006", -"TA0007", -"TA0008", -"TA0009", -"TA0011", -"TA0010", -"TA0040" +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"" ], "type": "string" }, "type": "array" }, "additionalTechniques": { -"description": "Additional MITRE ATT&CK techniques related to this finding, if any, along with any of their respective parent techniques.", "items": { "enum": [ "TECHNIQUE_UNSPECIFIED", @@ -13279,152 +11760,151 @@ false "FINANCIAL_THEFT" ], "enumDescriptions": [ -"Unspecified value.", -"T1001", -"T1001.002", -"T1003", -"T1003.007", -"T1003.008", -"T1005", -"T1020", -"T1027", -"T1027.003", -"T1027.004", -"T1027.010", -"T1029", -"T1033", -"T1036", -"T1036.005", -"T1037", -"T1037.005", -"T1046", -"T1053", -"T1053.003", -"T1053.007", -"T1055", -"T1056", -"T1056.001", -"T1057", -"T1059", -"T1059.004", -"T1059.006", -"T1068", -"T1069", -"T1069.003", -"T1070", -"T1070.002", -"T1070.003", -"T1070.004", -"T1070.006", -"T1070.008", -"T1071", -"T1071.004", -"T1072", -"T1078", -"T1078.001", -"T1078.003", -"T1078.004", -"T1083", -"T1087.001", -"T1090", -"T1090.002", -"T1090.003", -"T1098", -"T1098.001", -"T1098.003", -"T1098.004", -"T1098.006", -"T1104", -"T1105", -"T1106", -"T1110", -"T1119", -"T1129", -"T1132", -"T1132.001", -"T1134", -"T1134.001", -"T1136", -"T1136.001", -"T1140", -"T1190", -"T1195", -"T1195.001", -"T1203", -"T1204", -"T1212", -"T1222.002", -"T1484", -"T1485", -"T1486", -"T1489", -"T1490", -"T1495", -"T1496", -"T1498", -"T1526", -"T1528", -"T1531", -"T1537", -"T1539", -"T1543", -"T1546", -"T1547", -"T1547.006", -"T1547.009", -"T1548", -"T1548.001", -"T1548.003", -"T1552", -"T1552.001", -"T1552.003", -"T1552.004", -"T1553", -"T1553.004", -"T1554", -"T1555", -"T1556", -"T1556.003", -"T1556.006", -"T1562", -"T1562.001", -"T1562.006", -"T1562.012", -"T1564", -"T1564.001", -"T1564.002", -"T1567", -"T1567.002", -"T1568", -"T1570", -"T1574", -"T1574.006", -"T1578", -"T1578.001", -"T1580", -"T1587", -"T1587.001", -"T1588", -"T1588.001", -"T1588.006", -"T1595", -"T1595.001", -"T1608", -"T1608.001", -"T1609", -"T1610", -"T1611", -"T1613", -"T1620", -"T1649", -"T1657" +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"" ], "type": "string" }, "type": "array" }, "primaryTactic": { -"description": "The MITRE ATT&CK tactic most closely represented by this finding, if any.", "enum": [ "TACTIC_UNSPECIFIED", "RECONNAISSANCE", @@ -13443,26 +11923,25 @@ false "IMPACT" ], "enumDescriptions": [ -"Unspecified value.", -"TA0043", -"TA0042", -"TA0001", -"TA0002", -"TA0003", -"TA0004", -"TA0005", -"TA0006", -"TA0007", -"TA0008", -"TA0009", -"TA0011", -"TA0010", -"TA0040" +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"" ], "type": "string" }, "primaryTechniques": { -"description": "The MITRE ATT&CK technique most closely represented by this finding, if any. primary_techniques is a repeated field because there are multiple levels of MITRE ATT&CK techniques. If the technique most closely represented by this finding is a sub-technique (e.g. `SCANNING_IP_BLOCKS`), both the sub-technique and its parent technique(s) will be listed (e.g. `SCANNING_IP_BLOCKS`, `ACTIVE_SCANNING`).", "items": { "enum": [ "TECHNIQUE_UNSPECIFIED", @@ -13606,210 +12085,199 @@ false "FINANCIAL_THEFT" ], "enumDescriptions": [ -"Unspecified value.", -"T1001", -"T1001.002", -"T1003", -"T1003.007", -"T1003.008", -"T1005", -"T1020", -"T1027", -"T1027.003", -"T1027.004", -"T1027.010", -"T1029", -"T1033", -"T1036", -"T1036.005", -"T1037", -"T1037.005", -"T1046", -"T1053", -"T1053.003", -"T1053.007", -"T1055", -"T1056", -"T1056.001", -"T1057", -"T1059", -"T1059.004", -"T1059.006", -"T1068", -"T1069", -"T1069.003", -"T1070", -"T1070.002", -"T1070.003", -"T1070.004", -"T1070.006", -"T1070.008", -"T1071", -"T1071.004", -"T1072", -"T1078", -"T1078.001", -"T1078.003", -"T1078.004", -"T1083", -"T1087.001", -"T1090", -"T1090.002", -"T1090.003", -"T1098", -"T1098.001", -"T1098.003", -"T1098.004", -"T1098.006", -"T1104", -"T1105", -"T1106", -"T1110", -"T1119", -"T1129", -"T1132", -"T1132.001", -"T1134", -"T1134.001", -"T1136", -"T1136.001", -"T1140", -"T1190", -"T1195", -"T1195.001", -"T1203", -"T1204", -"T1212", -"T1222.002", -"T1484", -"T1485", -"T1486", -"T1489", -"T1490", -"T1495", -"T1496", -"T1498", -"T1526", -"T1528", -"T1531", -"T1537", -"T1539", -"T1543", -"T1546", -"T1547", -"T1547.006", -"T1547.009", -"T1548", -"T1548.001", -"T1548.003", -"T1552", -"T1552.001", -"T1552.003", -"T1552.004", -"T1553", -"T1553.004", -"T1554", -"T1555", -"T1556", -"T1556.003", -"T1556.006", -"T1562", -"T1562.001", -"T1562.006", -"T1562.012", -"T1564", -"T1564.001", -"T1564.002", -"T1567", -"T1567.002", -"T1568", -"T1570", -"T1574", -"T1574.006", -"T1578", -"T1578.001", -"T1580", -"T1587", -"T1587.001", -"T1588", -"T1588.001", -"T1588.006", -"T1595", -"T1595.001", -"T1608", -"T1608.001", -"T1609", -"T1610", -"T1611", -"T1613", -"T1620", -"T1649", -"T1657" +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"" ], "type": "string" }, "type": "array" }, "version": { -"description": "The MITRE ATT&CK version referenced by the above fields. E.g. \"8\".", "type": "string" } }, "type": "object" }, "GoogleCloudSecuritycenterV2MuteConfig": { -"description": "A mute config is a Cloud SCC resource that contains the configuration to mute create/update events of findings.", "id": "GoogleCloudSecuritycenterV2MuteConfig", "properties": { "createTime": { -"description": "Output only. The time at which the mute config was created. This field is set by the server and will be ignored if provided on config creation.", "format": "google-datetime", "readOnly": true, "type": "string" }, "cryptoKeyName": { -"description": "Output only. The resource name of the Cloud KMS `CryptoKey` used to encrypt this configuration data, if CMEK was enabled during Security Command Center activation.", "readOnly": true, "type": "string" }, "description": { -"description": "A description of the mute config.", "type": "string" }, "expiryTime": { -"description": "Optional. The expiry of the mute config. Only applicable for dynamic configs. If the expiry is set, when the config expires, it is removed from all findings.", "format": "google-datetime", "type": "string" }, "filter": { -"description": "Required. An expression that defines the filter to apply across create/update events of findings. While creating a filter string, be mindful of the scope in which the mute configuration is being created. E.g., If a filter contains project = X but is created under the project = Y scope, it might not match any findings. The following field and operator combinations are supported: * severity: `=`, `:` * category: `=`, `:` * resource.name: `=`, `:` * resource.project_name: `=`, `:` * resource.project_display_name: `=`, `:` * resource.folders.resource_folder: `=`, `:` * resource.parent_name: `=`, `:` * resource.parent_display_name: `=`, `:` * resource.type: `=`, `:` * finding_class: `=`, `:` * indicator.ip_addresses: `=`, `:` * indicator.domains: `=`, `:`", "type": "string" }, "mostRecentEditor": { -"description": "Output only. Email address of the user who last edited the mute config. This field is set by the server and will be ignored if provided on config creation or update.", "readOnly": true, "type": "string" }, "name": { -"description": "Identifier. This field will be ignored if provided on config creation. The following list shows some examples of the format: + `organizations/{organization}/muteConfigs/{mute_config}` + `organizations/{organization}locations/{location}//muteConfigs/{mute_config}` + `folders/{folder}/muteConfigs/{mute_config}` + `folders/{folder}/locations/{location}/muteConfigs/{mute_config}` + `projects/{project}/muteConfigs/{mute_config}` + `projects/{project}/locations/{location}/muteConfigs/{mute_config}`", "type": "string" }, "type": { -"description": "Required. The type of the mute config, which determines what type of mute state the config affects. Immutable after creation.", "enum": [ "MUTE_CONFIG_TYPE_UNSPECIFIED", "STATIC", "DYNAMIC" ], "enumDescriptions": [ -"Unused.", -"A static mute config, which sets the static mute state of future matching findings to muted. Once the static mute state has been set, finding or config modifications will not affect the state.", -"A dynamic mute config, which is applied to existing and future matching findings, setting their dynamic mute state to \"muted\". If the config is updated or deleted, or a matching finding is updated, such that the finding doesn't match the config, the config will be removed from the finding, and the finding's dynamic mute state may become \"unmuted\" (unless other configs still match)." +"", +"", +"" ], "type": "string" }, "updateTime": { -"description": "Output only. The most recent time at which the mute config was updated. This field is set by the server and will be ignored if provided on config creation or update.", "format": "google-datetime", "readOnly": true, "type": "string" @@ -13818,55 +12286,45 @@ false "type": "object" }, "GoogleCloudSecuritycenterV2MuteInfo": { -"description": "Mute information about the finding, including whether the finding has a static mute or any matching dynamic mute rules.", "id": "GoogleCloudSecuritycenterV2MuteInfo", "properties": { "dynamicMuteRecords": { -"description": "The list of dynamic mute rules that currently match the finding.", "items": { "$ref": "GoogleCloudSecuritycenterV2DynamicMuteRecord" }, "type": "array" }, "staticMute": { -"$ref": "GoogleCloudSecuritycenterV2StaticMute", -"description": "If set, the static mute applied to this finding. Static mutes override dynamic mutes. If unset, there is no static mute." +"$ref": "GoogleCloudSecuritycenterV2StaticMute" } }, "type": "object" }, "GoogleCloudSecuritycenterV2Network": { -"description": "Contains information about a VPC network associated with the finding.", "id": "GoogleCloudSecuritycenterV2Network", "properties": { "name": { -"description": "The name of the VPC network resource, for example, `//compute.googleapis.com/projects/my-project/global/networks/my-network`.", "type": "string" } }, "type": "object" }, "GoogleCloudSecuritycenterV2Node": { -"description": "Kubernetes nodes associated with the finding.", "id": "GoogleCloudSecuritycenterV2Node", "properties": { "name": { -"description": "[Full resource name](https://google.aip.dev/122#full-resource-names) of the Compute Engine VM running the cluster node.", "type": "string" } }, "type": "object" }, "GoogleCloudSecuritycenterV2NodePool": { -"description": "Provides GKE node pool information.", "id": "GoogleCloudSecuritycenterV2NodePool", "properties": { "name": { -"description": "Kubernetes node pool name.", "type": "string" }, "nodes": { -"description": "Nodes associated with the finding.", "items": { "$ref": "GoogleCloudSecuritycenterV2Node" }, @@ -13876,196 +12334,157 @@ false "type": "object" }, "GoogleCloudSecuritycenterV2Notebook": { -"description": "Represents a Jupyter notebook IPYNB file, such as a [Colab Enterprise notebook](https://cloud.google.com/colab/docs/introduction) file, that is associated with a finding.", "id": "GoogleCloudSecuritycenterV2Notebook", "properties": { "lastAuthor": { -"description": "The user ID of the latest author to modify the notebook.", "type": "string" }, "name": { -"description": "The name of the notebook.", "type": "string" }, "notebookUpdateTime": { -"description": "The most recent time the notebook was updated.", "format": "google-datetime", "type": "string" }, "service": { -"description": "The source notebook service, for example, \"Colab Enterprise\".", "type": "string" } }, "type": "object" }, "GoogleCloudSecuritycenterV2NotificationMessage": { -"description": "Cloud SCC's Notification", "id": "GoogleCloudSecuritycenterV2NotificationMessage", "properties": { "finding": { -"$ref": "GoogleCloudSecuritycenterV2Finding", -"description": "If it's a Finding based notification config, this field will be populated." +"$ref": "GoogleCloudSecuritycenterV2Finding" }, "notificationConfigName": { -"description": "Name of the notification config that generated current notification.", "type": "string" }, "resource": { -"$ref": "GoogleCloudSecuritycenterV2Resource", -"description": "The Cloud resource tied to this notification's Finding." +"$ref": "GoogleCloudSecuritycenterV2Resource" } }, "type": "object" }, "GoogleCloudSecuritycenterV2Object": { -"description": "Kubernetes object related to the finding, uniquely identified by GKNN. Used if the object Kind is not one of Pod, Node, NodePool, Binding, or AccessReview.", "id": "GoogleCloudSecuritycenterV2Object", "properties": { "containers": { -"description": "Pod containers associated with this finding, if any.", "items": { "$ref": "GoogleCloudSecuritycenterV2Container" }, "type": "array" }, "group": { -"description": "Kubernetes object group, such as \"policy.k8s.io/v1\".", "type": "string" }, "kind": { -"description": "Kubernetes object kind, such as \"Namespace\".", "type": "string" }, "name": { -"description": "Kubernetes object name. For details see https://kubernetes.io/docs/concepts/overview/working-with-objects/names/.", "type": "string" }, "ns": { -"description": "Kubernetes object namespace. Must be a valid DNS label. Named \"ns\" to avoid collision with C++ namespace keyword. For details see https://kubernetes.io/docs/tasks/administer-cluster/namespaces/.", "type": "string" } }, "type": "object" }, "GoogleCloudSecuritycenterV2OrgPolicy": { -"description": "Contains information about the org policies associated with the finding.", "id": "GoogleCloudSecuritycenterV2OrgPolicy", "properties": { "name": { -"description": "Identifier. The resource name of the org policy. Example: \"organizations/{organization_id}/policies/{constraint_name}\"", "type": "string" } }, "type": "object" }, "GoogleCloudSecuritycenterV2Package": { -"description": "Package is a generic definition of a package.", "id": "GoogleCloudSecuritycenterV2Package", "properties": { "cpeUri": { -"description": "The CPE URI where the vulnerability was detected.", "type": "string" }, "packageName": { -"description": "The name of the package where the vulnerability was detected.", "type": "string" }, "packageType": { -"description": "Type of package, for example, os, maven, or go.", "type": "string" }, "packageVersion": { -"description": "The version of the package.", "type": "string" } }, "type": "object" }, "GoogleCloudSecuritycenterV2Pipeline": { -"description": "Vertex AI training pipeline associated with the finding.", "id": "GoogleCloudSecuritycenterV2Pipeline", "properties": { "displayName": { -"description": "The user-defined display name of pipeline, e.g. plants-classification", "type": "string" }, "name": { -"description": "Resource name of the pipeline, e.g. projects/{project}/locations/{location}/trainingPipelines/5253428229225578496", "type": "string" } }, "type": "object" }, "GoogleCloudSecuritycenterV2Pod": { -"description": "A Kubernetes Pod.", "id": "GoogleCloudSecuritycenterV2Pod", "properties": { "containers": { -"description": "Pod containers associated with this finding, if any.", "items": { "$ref": "GoogleCloudSecuritycenterV2Container" }, "type": "array" }, "labels": { -"description": "Pod labels. For Kubernetes containers, these are applied to the container.", "items": { "$ref": "GoogleCloudSecuritycenterV2Label" }, "type": "array" }, "name": { -"description": "Kubernetes Pod name.", "type": "string" }, "ns": { -"description": "Kubernetes Pod namespace.", "type": "string" } }, "type": "object" }, "GoogleCloudSecuritycenterV2PolicyDriftDetails": { -"description": "The policy field that violates the deployed posture and its expected and detected values.", "id": "GoogleCloudSecuritycenterV2PolicyDriftDetails", "properties": { "detectedValue": { -"description": "The detected value that violates the deployed posture, for example, `false` or `allowed_values={\"projects/22831892\"}`.", "type": "string" }, "expectedValue": { -"description": "The value of this field that was configured in a posture, for example, `true` or `allowed_values={\"projects/29831892\"}`.", "type": "string" }, "field": { -"description": "The name of the updated field, for example constraint.implementation.policy_rules[0].enforce", "type": "string" } }, "type": "object" }, "GoogleCloudSecuritycenterV2PolicyViolationSummary": { -"description": "Metadata summarizing policy violations of child resources of the affected resource. `finding_category` and `resource` determine the exact semantics of the counts. For example, when category=DATA_SECURITY_POSTURE_OBJECT_PUBLIC_ACCESS_VIOLATION and resource='storage.googleapis.com/buckets/my-bucket-name' then this counts the number of Cloud Storage objects in my-bucket-name which violate a Public Access control.", "id": "GoogleCloudSecuritycenterV2PolicyViolationSummary", "properties": { "conformantResourcesCount": { -"description": "Total number of child resources that conform to the policy.", "format": "int64", "type": "string" }, "evaluationErrorsCount": { -"description": "Number of child resources for which errors during evaluation occurred. The evaluation result for these child resources is effectively \"unknown\".", "format": "int64", "type": "string" }, "outOfScopeResourcesCount": { -"description": "Total count of child resources which were not in scope for evaluation.", "format": "int64", "type": "string" }, "policyViolationsCount": { -"description": "Count of child resources in violation of the policy.", "format": "int64", "type": "string" } @@ -14073,16 +12492,13 @@ false "type": "object" }, "GoogleCloudSecuritycenterV2PortRange": { -"description": "A port range which is inclusive of the min and max values. Values are between 0 and 2^16-1. The max can be equal / must be not smaller than the min value. If min and max are equal this indicates that it is a single port.", "id": "GoogleCloudSecuritycenterV2PortRange", "properties": { "max": { -"description": "Maximum port value.", "format": "int64", "type": "string" }, "min": { -"description": "Minimum port value.", "format": "int64", "type": "string" } @@ -14090,62 +12506,50 @@ false "type": "object" }, "GoogleCloudSecuritycenterV2Process": { -"description": "Represents an operating system process.", "id": "GoogleCloudSecuritycenterV2Process", "properties": { "args": { -"description": "Process arguments as JSON encoded strings.", "items": { "type": "string" }, "type": "array" }, "argumentsTruncated": { -"description": "True if `args` is incomplete.", "type": "boolean" }, "binary": { -"$ref": "GoogleCloudSecuritycenterV2File", -"description": "File information for the process executable." +"$ref": "GoogleCloudSecuritycenterV2File" }, "envVariables": { -"description": "Process environment variables.", "items": { "$ref": "GoogleCloudSecuritycenterV2EnvironmentVariable" }, "type": "array" }, "envVariablesTruncated": { -"description": "True if `env_variables` is incomplete.", "type": "boolean" }, "libraries": { -"description": "File information for libraries loaded by the process.", "items": { "$ref": "GoogleCloudSecuritycenterV2File" }, "type": "array" }, "name": { -"description": "The process name, as displayed in utilities like `top` and `ps`. This name can be accessed through `/proc/[pid]/comm` and changed with `prctl(PR_SET_NAME)`.", "type": "string" }, "parentPid": { -"description": "The parent process ID.", "format": "int64", "type": "string" }, "pid": { -"description": "The process ID.", "format": "int64", "type": "string" }, "script": { -"$ref": "GoogleCloudSecuritycenterV2File", -"description": "When the process represents the invocation of a script, `binary` provides information about the interpreter, while `script` provides information about the script file provided to the interpreter." +"$ref": "GoogleCloudSecuritycenterV2File" }, "userId": { -"description": "The ID of the user that executed the process. E.g. If this is the root user this will always be 0.", "format": "int64", "type": "string" } @@ -14153,70 +12557,58 @@ false "type": "object" }, "GoogleCloudSecuritycenterV2ProcessSignature": { -"description": "Indicates what signature matched this process.", "id": "GoogleCloudSecuritycenterV2ProcessSignature", "properties": { "memoryHashSignature": { -"$ref": "GoogleCloudSecuritycenterV2MemoryHashSignature", -"description": "Signature indicating that a binary family was matched." +"$ref": "GoogleCloudSecuritycenterV2MemoryHashSignature" }, "signatureType": { -"description": "Describes the type of resource associated with the signature.", "enum": [ "SIGNATURE_TYPE_UNSPECIFIED", "SIGNATURE_TYPE_PROCESS", "SIGNATURE_TYPE_FILE" ], "enumDescriptions": [ -"The default signature type.", -"Used for signatures concerning processes.", -"Used for signatures concerning disks." +"", +"", +"" ], "type": "string" }, "yaraRuleSignature": { -"$ref": "GoogleCloudSecuritycenterV2YaraRuleSignature", -"description": "Signature indicating that a YARA rule was matched." +"$ref": "GoogleCloudSecuritycenterV2YaraRuleSignature" } }, "type": "object" }, "GoogleCloudSecuritycenterV2Reference": { -"description": "Additional Links", "id": "GoogleCloudSecuritycenterV2Reference", "properties": { "source": { -"description": "Source of the reference e.g. NVD", "type": "string" }, "uri": { -"description": "Uri for the mentioned source e.g. https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2021-34527.", "type": "string" } }, "type": "object" }, "GoogleCloudSecuritycenterV2Requests": { -"description": "Information about the requests relevant to the finding.", "id": "GoogleCloudSecuritycenterV2Requests", "properties": { "longTermAllowed": { -"description": "Allowed RPS (requests per second) over the long term.", "format": "int32", "type": "integer" }, "longTermDenied": { -"description": "Denied RPS (requests per second) over the long term.", "format": "int32", "type": "integer" }, "ratio": { -"description": "For 'Increasing deny ratio', the ratio is the denied traffic divided by the allowed traffic. For 'Allowed traffic spike', the ratio is the allowed traffic in the short term divided by allowed traffic in the long term.", "format": "double", "type": "number" }, "shortTermAllowed": { -"description": "Allowed RPS (requests per second) in the short term.", "format": "int32", "type": "integer" } @@ -14224,35 +12616,27 @@ false "type": "object" }, "GoogleCloudSecuritycenterV2Resource": { -"description": "Information related to the Google Cloud resource.", "id": "GoogleCloudSecuritycenterV2Resource", "properties": { "adcApplication": { -"$ref": "GoogleCloudSecuritycenterV2AdcApplication", -"description": "The ADC application associated with the finding." +"$ref": "GoogleCloudSecuritycenterV2AdcApplication" }, "adcApplicationTemplate": { -"$ref": "GoogleCloudSecuritycenterV2AdcApplicationTemplateRevision", -"description": "The ADC template associated with the finding." +"$ref": "GoogleCloudSecuritycenterV2AdcApplicationTemplateRevision" }, "adcSharedTemplate": { -"$ref": "GoogleCloudSecuritycenterV2AdcSharedTemplateRevision", -"description": "The ADC shared template associated with the finding." +"$ref": "GoogleCloudSecuritycenterV2AdcSharedTemplateRevision" }, "application": { -"$ref": "GoogleCloudSecuritycenterV2ResourceApplication", -"description": "The App Hub application this resource belongs to." +"$ref": "GoogleCloudSecuritycenterV2ResourceApplication" }, "awsMetadata": { -"$ref": "GoogleCloudSecuritycenterV2AwsMetadata", -"description": "The AWS metadata associated with the finding." +"$ref": "GoogleCloudSecuritycenterV2AwsMetadata" }, "azureMetadata": { -"$ref": "GoogleCloudSecuritycenterV2AzureMetadata", -"description": "The Azure metadata associated with the finding." +"$ref": "GoogleCloudSecuritycenterV2AzureMetadata" }, "cloudProvider": { -"description": "Indicates which cloud provider the finding is from.", "enum": [ "CLOUD_PROVIDER_UNSPECIFIED", "GOOGLE_CLOUD_PLATFORM", @@ -14260,91 +12644,74 @@ false "MICROSOFT_AZURE" ], "enumDescriptions": [ -"The cloud provider is unspecified.", -"The cloud provider is Google Cloud.", -"The cloud provider is Amazon Web Services.", -"The cloud provider is Microsoft Azure." +"", +"", +"", +"" ], "type": "string" }, "displayName": { -"description": "The human readable name of the resource.", "type": "string" }, "gcpMetadata": { -"$ref": "GcpMetadata", -"description": "The Google Cloud metadata associated with the finding." +"$ref": "GcpMetadata" }, "location": { -"description": "The region or location of the service (if applicable).", "type": "string" }, "name": { -"description": "The full resource name of the resource. See: https://cloud.google.com/apis/design/resource_names#full_resource_name", "type": "string" }, "resourcePath": { -"$ref": "GoogleCloudSecuritycenterV2ResourcePath", -"description": "Provides the path to the resource within the resource hierarchy." +"$ref": "GoogleCloudSecuritycenterV2ResourcePath" }, "resourcePathString": { -"description": "A string representation of the resource path. For Google Cloud, it has the format of `organizations/{organization_id}/folders/{folder_id}/folders/{folder_id}/projects/{project_id}` where there can be any number of folders. For AWS, it has the format of `org/{organization_id}/ou/{organizational_unit_id}/ou/{organizational_unit_id}/account/{account_id}` where there can be any number of organizational units. For Azure, it has the format of `mg/{management_group_id}/mg/{management_group_id}/subscription/{subscription_id}/rg/{resource_group_name}` where there can be any number of management groups.", "type": "string" }, "service": { -"description": "The service or resource provider associated with the resource.", "type": "string" }, "type": { -"description": "The full resource type of the resource.", "type": "string" } }, "type": "object" }, "GoogleCloudSecuritycenterV2ResourceApplication": { -"description": "The App Hub Application associated with the finding's resource.", "id": "GoogleCloudSecuritycenterV2ResourceApplication", "properties": { "attributes": { -"$ref": "GoogleCloudSecuritycenterV2ResourceApplicationAttributes", -"description": "Consumer provided attributes for the application" +"$ref": "GoogleCloudSecuritycenterV2ResourceApplicationAttributes" }, "name": { -"description": "The resource name of an Application. Format: `projects/{host-project-id}/locations/{location}/applications/{application-id}`", "type": "string" } }, "type": "object" }, "GoogleCloudSecuritycenterV2ResourceApplicationAttributes": { -"description": "Consumer provided attributes for the application", "id": "GoogleCloudSecuritycenterV2ResourceApplicationAttributes", "properties": { "businessOwners": { -"description": "Business team that ensures user needs are met and value is delivered", "items": { "$ref": "GoogleCloudSecuritycenterV2ResourceApplicationAttributesContactInfo" }, "type": "array" }, "criticality": { -"$ref": "GoogleCloudSecuritycenterV2ResourceApplicationAttributesCriticality", -"description": "User-defined criticality information." +"$ref": "GoogleCloudSecuritycenterV2ResourceApplicationAttributesCriticality" }, "developerOwners": { -"description": "Developer team that owns development and coding.", "items": { "$ref": "GoogleCloudSecuritycenterV2ResourceApplicationAttributesContactInfo" }, "type": "array" }, "environment": { -"$ref": "GoogleCloudSecuritycenterV2ResourceApplicationAttributesEnvironment", -"description": "User-defined environment information." +"$ref": "GoogleCloudSecuritycenterV2ResourceApplicationAttributesEnvironment" }, "operatorOwners": { -"description": "Operator team that ensures runtime and operations.", "items": { "$ref": "GoogleCloudSecuritycenterV2ResourceApplicationAttributesContactInfo" }, @@ -14354,22 +12721,18 @@ false "type": "object" }, "GoogleCloudSecuritycenterV2ResourceApplicationAttributesContactInfo": { -"description": "Contact information of stakeholders.", "id": "GoogleCloudSecuritycenterV2ResourceApplicationAttributesContactInfo", "properties": { "email": { -"description": "Email address of the contacts.", "type": "string" } }, "type": "object" }, "GoogleCloudSecuritycenterV2ResourceApplicationAttributesCriticality": { -"description": "Criticality of the Application, Service, or Workload", "id": "GoogleCloudSecuritycenterV2ResourceApplicationAttributesCriticality", "properties": { "type": { -"description": "Criticality Type.", "enum": [ "CRITICALITY_TYPE_UNSPECIFIED", "MISSION_CRITICAL", @@ -14378,11 +12741,11 @@ false "LOW" ], "enumDescriptions": [ -"Unspecified type.", -"Mission critical service, application or workload.", -"High impact.", -"Medium impact.", -"Low impact." +"", +"", +"", +"", +"" ], "type": "string" } @@ -14390,11 +12753,9 @@ false "type": "object" }, "GoogleCloudSecuritycenterV2ResourceApplicationAttributesEnvironment": { -"description": "Environment of the Application, Service, or Workload", "id": "GoogleCloudSecuritycenterV2ResourceApplicationAttributesEnvironment", "properties": { "type": { -"description": "Environment Type.", "enum": [ "ENVIRONMENT_TYPE_UNSPECIFIED", "PRODUCTION", @@ -14403,11 +12764,11 @@ false "DEVELOPMENT" ], "enumDescriptions": [ -"Unspecified type.", -"Production environment.", -"Staging environment.", -"Test environment.", -"Development environment." +"", +"", +"", +"", +"" ], "type": "string" } @@ -14415,11 +12776,9 @@ false "type": "object" }, "GoogleCloudSecuritycenterV2ResourcePath": { -"description": "Represents the path of resources leading up to the resource this finding is about.", "id": "GoogleCloudSecuritycenterV2ResourcePath", "properties": { "nodes": { -"description": "The list of nodes that make the up resource path, ordered from lowest level to highest level.", "items": { "$ref": "GoogleCloudSecuritycenterV2ResourcePathNode" }, @@ -14429,19 +12788,15 @@ false "type": "object" }, "GoogleCloudSecuritycenterV2ResourcePathNode": { -"description": "A node within the resource path. Each node represents a resource within the resource hierarchy.", "id": "GoogleCloudSecuritycenterV2ResourcePathNode", "properties": { "displayName": { -"description": "The display name of the resource this node represents.", "type": "string" }, "id": { -"description": "The ID of the resource this node represents.", "type": "string" }, "nodeType": { -"description": "The type of resource this node represents.", "enum": [ "RESOURCE_PATH_NODE_TYPE_UNSPECIFIED", "GCP_ORGANIZATION", @@ -14455,16 +12810,16 @@ false "AZURE_RESOURCE_GROUP" ], "enumDescriptions": [ -"Node type is unspecified.", -"The node represents a Google Cloud organization.", -"The node represents a Google Cloud folder.", -"The node represents a Google Cloud project.", -"The node represents an AWS organization.", -"The node represents an AWS organizational unit.", -"The node represents an AWS account.", -"The node represents an Azure management group.", -"The node represents an Azure subscription.", -"The node represents an Azure resource group." +"", +"", +"", +"", +"", +"", +"", +"", +"", +"" ], "type": "string" } @@ -14472,11 +12827,9 @@ false "type": "object" }, "GoogleCloudSecuritycenterV2ResourceValueConfig": { -"description": "A resource value configuration (RVC) is a mapping configuration of user's resources to resource values. Used in Attack path simulations.", "id": "GoogleCloudSecuritycenterV2ResourceValueConfig", "properties": { "cloudProvider": { -"description": "Cloud provider this configuration applies to", "enum": [ "CLOUD_PROVIDER_UNSPECIFIED", "GOOGLE_CLOUD_PLATFORM", @@ -14484,40 +12837,34 @@ false "MICROSOFT_AZURE" ], "enumDescriptions": [ -"The cloud provider is unspecified.", -"The cloud provider is Google Cloud.", -"The cloud provider is Amazon Web Services.", -"The cloud provider is Microsoft Azure." +"", +"", +"", +"" ], "type": "string" }, "createTime": { -"description": "Output only. Timestamp this resource value configuration was created.", "format": "google-datetime", "readOnly": true, "type": "string" }, "description": { -"description": "Description of the resource value configuration.", "type": "string" }, "name": { -"description": "Identifier. Name for the resource value configuration", "type": "string" }, "resourceLabelsSelector": { "additionalProperties": { "type": "string" }, -"description": "List of resource labels to search for, evaluated with `AND`. For example, \"resource_labels_selector\": {\"key\": \"value\", \"env\": \"prod\"} will match resources with labels \"key\": \"value\" `AND` \"env\": \"prod\" https://cloud.google.com/resource-manager/docs/creating-managing-labels", "type": "object" }, "resourceType": { -"description": "Apply resource_value only to resources that match resource_type. resource_type will be checked with `AND` of other resources. For example, \"storage.googleapis.com/Bucket\" with resource_value \"HIGH\" will apply \"HIGH\" value only to \"storage.googleapis.com/Bucket\" resources.", "type": "string" }, "resourceValue": { -"description": "Resource value level this expression represents Only required when there is no Sensitive Data Protection mapping in the request", "enum": [ "RESOURCE_VALUE_UNSPECIFIED", "HIGH", @@ -14526,31 +12873,27 @@ false "NONE" ], "enumDescriptions": [ -"Unspecific value", -"High resource value", -"Medium resource value", -"Low resource value", -"No resource value, e.g. ignore these resources" +"", +"", +"", +"", +"" ], "type": "string" }, "scope": { -"description": "Project or folder to scope this configuration to. For example, \"project/456\" would apply this configuration only to resources in \"project/456\" scope and will be checked with `AND` of other resources.", "type": "string" }, "sensitiveDataProtectionMapping": { -"$ref": "GoogleCloudSecuritycenterV2SensitiveDataProtectionMapping", -"description": "A mapping of the sensitivity on Sensitive Data Protection finding to resource values. This mapping can only be used in combination with a resource_type that is related to BigQuery, e.g. \"bigquery.googleapis.com/Dataset\"." +"$ref": "GoogleCloudSecuritycenterV2SensitiveDataProtectionMapping" }, "tagValues": { -"description": "Tag values combined with `AND` to check against. For Google Cloud resources, they are tag value IDs in the form of \"tagValues/123\". Example: `[ \"tagValues/123\", \"tagValues/456\", \"tagValues/789\" ]` https://cloud.google.com/resource-manager/docs/tags/tags-creating-and-managing", "items": { "type": "string" }, "type": "array" }, "updateTime": { -"description": "Output only. Timestamp this resource value configuration was last updated.", "format": "google-datetime", "readOnly": true, "type": "string" @@ -14559,90 +12902,74 @@ false "type": "object" }, "GoogleCloudSecuritycenterV2Role": { -"description": "Kubernetes Role or ClusterRole.", "id": "GoogleCloudSecuritycenterV2Role", "properties": { "kind": { -"description": "Role type.", "enum": [ "KIND_UNSPECIFIED", "ROLE", "CLUSTER_ROLE" ], "enumDescriptions": [ -"Role type is not specified.", -"Kubernetes Role.", -"Kubernetes ClusterRole." +"", +"", +"" ], "type": "string" }, "name": { -"description": "Role name.", "type": "string" }, "ns": { -"description": "Role namespace.", "type": "string" } }, "type": "object" }, "GoogleCloudSecuritycenterV2Secret": { -"description": "Details about a secret or credential associated with the finding.", "id": "GoogleCloudSecuritycenterV2Secret", "properties": { "environmentVariable": { -"$ref": "GoogleCloudSecuritycenterV2SecretEnvironmentVariable", -"description": "The environment variable containing the secret." +"$ref": "GoogleCloudSecuritycenterV2SecretEnvironmentVariable" }, "filePath": { -"$ref": "GoogleCloudSecuritycenterV2SecretFilePath", -"description": "The file containing the secret." +"$ref": "GoogleCloudSecuritycenterV2SecretFilePath" }, "status": { -"$ref": "GoogleCloudSecuritycenterV2SecretStatus", -"description": "The status of the secret." +"$ref": "GoogleCloudSecuritycenterV2SecretStatus" }, "type": { -"description": "The type of secret, for example, GCP_API_KEY.", "type": "string" } }, "type": "object" }, "GoogleCloudSecuritycenterV2SecretEnvironmentVariable": { -"description": "Environment variable containing the secret.", "id": "GoogleCloudSecuritycenterV2SecretEnvironmentVariable", "properties": { "key": { -"description": "Environment variable name as a JSON encoded string. Note that value is not included since the value contains the secret data, which is sensitive core content.", "type": "string" } }, "type": "object" }, "GoogleCloudSecuritycenterV2SecretFilePath": { -"description": "File path containing the secret.", "id": "GoogleCloudSecuritycenterV2SecretFilePath", "properties": { "path": { -"description": "Path to the file.", "type": "string" } }, "type": "object" }, "GoogleCloudSecuritycenterV2SecretStatus": { -"description": "The status of the secret.", "id": "GoogleCloudSecuritycenterV2SecretStatus", "properties": { "lastUpdatedTime": { -"description": "Time that the secret was found.", "format": "google-datetime", "type": "string" }, "validity": { -"description": "The validity of the secret.", "enum": [ "SECRET_VALIDITY_UNSPECIFIED", "SECRET_VALIDITY_UNSUPPORTED", @@ -14651,11 +12978,11 @@ false "SECRET_VALIDITY_VALID" ], "enumDescriptions": [ -"Default value; no validation was attempted.", -"There is no mechanism to validate the secret.", -"Validation is supported but the validation failed.", -"The secret is confirmed to be invalid.", -"The secret is confirmed to be valid." +"", +"", +"", +"", +"" ], "type": "string" } @@ -14663,114 +12990,91 @@ false "type": "object" }, "GoogleCloudSecuritycenterV2SecurityBulletin": { -"description": "SecurityBulletin are notifications of vulnerabilities of Google products.", "id": "GoogleCloudSecuritycenterV2SecurityBulletin", "properties": { "bulletinId": { -"description": "ID of the bulletin corresponding to the vulnerability.", "type": "string" }, "submissionTime": { -"description": "Submission time of this Security Bulletin.", "format": "google-datetime", "type": "string" }, "suggestedUpgradeVersion": { -"description": "This represents a version that the cluster receiving this notification should be upgraded to, based on its current version. For example, 1.15.0", "type": "string" } }, "type": "object" }, "GoogleCloudSecuritycenterV2SecurityMarks": { -"description": "User specified security marks that are attached to the parent Security Command Center resource. Security marks are scoped within a Security Command Center organization -- they can be modified and viewed by all users who have proper permissions on the organization.", "id": "GoogleCloudSecuritycenterV2SecurityMarks", "properties": { "canonicalName": { -"description": "The canonical name of the marks. The following list shows some examples: + `organizations/{organization_id}/assets/{asset_id}/securityMarks` + `organizations/{organization_id}/sources/{source_id}/findings/{finding_id}/securityMarks` + `organizations/{organization_id}/sources/{source_id}/locations/{location}/findings/{finding_id}/securityMarks` + `folders/{folder_id}/assets/{asset_id}/securityMarks` + `folders/{folder_id}/sources/{source_id}/findings/{finding_id}/securityMarks` + `folders/{folder_id}/sources/{source_id}/locations/{location}/findings/{finding_id}/securityMarks` + `projects/{project_number}/assets/{asset_id}/securityMarks` + `projects/{project_number}/sources/{source_id}/findings/{finding_id}/securityMarks` + `projects/{project_number}/sources/{source_id}/locations/{location}/findings/{finding_id}/securityMarks`", "type": "string" }, "marks": { "additionalProperties": { "type": "string" }, -"description": "Mutable user specified security marks belonging to the parent resource. Constraints are as follows: * Keys and values are treated as case insensitive * Keys must be between 1 - 256 characters (inclusive) * Keys must be letters, numbers, underscores, or dashes * Values have leading and trailing whitespace trimmed, remaining characters must be between 1 - 4096 characters (inclusive)", "type": "object" }, "name": { -"description": "The relative resource name of the SecurityMarks. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name The following list shows some examples: + `organizations/{organization_id}/assets/{asset_id}/securityMarks` + `organizations/{organization_id}/sources/{source_id}/findings/{finding_id}/securityMarks` + `organizations/{organization_id}/sources/{source_id}/locations/{location}/findings/{finding_id}/securityMarks`", "type": "string" } }, "type": "object" }, "GoogleCloudSecuritycenterV2SecurityPolicy": { -"description": "Information about the [Google Cloud Armor security policy](https://cloud.google.com/armor/docs/security-policy-overview) relevant to the finding.", "id": "GoogleCloudSecuritycenterV2SecurityPolicy", "properties": { "name": { -"description": "The name of the Google Cloud Armor security policy, for example, \"my-security-policy\".", "type": "string" }, "preview": { -"description": "Whether or not the associated rule or policy is in preview mode.", "type": "boolean" }, "type": { -"description": "The type of Google Cloud Armor security policy for example, 'backend security policy', 'edge security policy', 'network edge security policy', or 'always-on DDoS protection'.", "type": "string" } }, "type": "object" }, "GoogleCloudSecuritycenterV2SecurityPosture": { -"description": "Represents a posture that is deployed on Google Cloud by the Security Command Center Posture Management service. A posture contains one or more policy sets. A policy set is a group of policies that enforce a set of security rules on Google Cloud.", "id": "GoogleCloudSecuritycenterV2SecurityPosture", "properties": { "changedPolicy": { -"description": "The name of the updated policy, for example, `projects/{project_id}/policies/{constraint_name}`.", "type": "string" }, "name": { -"description": "Name of the posture, for example, `CIS-Posture`.", "type": "string" }, "policy": { -"description": "The ID of the updated policy, for example, `compute-policy-1`.", "type": "string" }, "policyDriftDetails": { -"description": "The details about a change in an updated policy that violates the deployed posture.", "items": { "$ref": "GoogleCloudSecuritycenterV2PolicyDriftDetails" }, "type": "array" }, "policySet": { -"description": "The name of the updated policy set, for example, `cis-policyset`.", "type": "string" }, "postureDeployment": { -"description": "The name of the posture deployment, for example, `organizations/{org_id}/posturedeployments/{posture_deployment_id}`.", "type": "string" }, "postureDeploymentResource": { -"description": "The project, folder, or organization on which the posture is deployed, for example, `projects/{project_number}`.", "type": "string" }, "revisionId": { -"description": "The version of the posture, for example, `c7cfa2a8`.", "type": "string" } }, "type": "object" }, "GoogleCloudSecuritycenterV2SensitiveDataProtectionMapping": { -"description": "Resource value mapping for Sensitive Data Protection findings If any of these mappings have a resource value that is not unspecified, the resource_value field will be ignored when reading this configuration.", "id": "GoogleCloudSecuritycenterV2SensitiveDataProtectionMapping", "properties": { "highSensitivityMapping": { -"description": "Resource value mapping for high-sensitivity Sensitive Data Protection findings", "enum": [ "RESOURCE_VALUE_UNSPECIFIED", "HIGH", @@ -14779,16 +13083,15 @@ false "NONE" ], "enumDescriptions": [ -"Unspecific value", -"High resource value", -"Medium resource value", -"Low resource value", -"No resource value, e.g. ignore these resources" +"", +"", +"", +"", +"" ], "type": "string" }, "mediumSensitivityMapping": { -"description": "Resource value mapping for medium-sensitivity Sensitive Data Protection findings", "enum": [ "RESOURCE_VALUE_UNSPECIFIED", "HIGH", @@ -14797,11 +13100,11 @@ false "NONE" ], "enumDescriptions": [ -"Unspecific value", -"High resource value", -"Medium resource value", -"Low resource value", -"No resource value, e.g. ignore these resources" +"", +"", +"", +"", +"" ], "type": "string" } @@ -14809,11 +13112,9 @@ false "type": "object" }, "GoogleCloudSecuritycenterV2SensitivityScore": { -"description": "Score is calculated from of all elements in the data profile. A higher level means the data is more sensitive.", "id": "GoogleCloudSecuritycenterV2SensitivityScore", "properties": { "score": { -"description": "The sensitivity score applied to the resource.", "enum": [ "SENSITIVITY_SCORE_LEVEL_UNSPECIFIED", "SENSITIVITY_LOW", @@ -14822,11 +13123,11 @@ false "SENSITIVITY_HIGH" ], "enumDescriptions": [ -"Unused.", -"No sensitive information detected. The resource isn't publicly accessible.", -"Unable to determine sensitivity.", -"Medium risk. Contains personally identifiable information (PII), potentially sensitive data, or fields with free-text data that are at a higher risk of having intermittent sensitive data. Consider limiting access.", -"High risk. Sensitive personally identifiable information (SPII) can be present. Exfiltration of data can lead to user data loss. Re-identification of users might be possible. Consider limiting usage and or removing SPII." +"", +"", +"", +"", +"" ], "type": "string" } @@ -14834,31 +13135,25 @@ false "type": "object" }, "GoogleCloudSecuritycenterV2ServiceAccountDelegationInfo": { -"description": "Identity delegation history of an authenticated service account.", "id": "GoogleCloudSecuritycenterV2ServiceAccountDelegationInfo", "properties": { "principalEmail": { -"description": "The email address of a Google account.", "type": "string" }, "principalSubject": { -"description": "A string representing the principal_subject associated with the identity. As compared to `principal_email`, supports principals that aren't associated with email addresses, such as third party principals. For most identities, the format will be `principal://iam.googleapis.com/{identity pool name}/subjects/{subject}` except for some GKE identities (GKE_WORKLOAD, FREEFORM, GKE_HUB_WORKLOAD) that are still in the legacy format `serviceAccount:{identity pool name}[{subject}]`", "type": "string" } }, "type": "object" }, "GoogleCloudSecuritycenterV2StaticMute": { -"description": "Information about the static mute state. A static mute state overrides any dynamic mute rules that apply to this finding. The static mute state can be set by a static mute rule or by muting the finding directly.", "id": "GoogleCloudSecuritycenterV2StaticMute", "properties": { "applyTime": { -"description": "When the static mute was applied.", "format": "google-datetime", "type": "string" }, "state": { -"description": "The static mute state. If the value is `MUTED` or `UNMUTED`, then the finding's overall mute state will have the same value.", "enum": [ "MUTE_UNSPECIFIED", "MUTED", @@ -14866,10 +13161,10 @@ false "UNDEFINED" ], "enumDescriptions": [ -"Unspecified.", -"Finding has been muted.", -"Finding has been unmuted.", -"Finding has never been muted/unmuted." +"", +"", +"", +"" ], "type": "string" } @@ -14877,11 +13172,9 @@ false "type": "object" }, "GoogleCloudSecuritycenterV2Subject": { -"description": "Represents a Kubernetes subject.", "id": "GoogleCloudSecuritycenterV2Subject", "properties": { "kind": { -"description": "Authentication type for the subject.", "enum": [ "AUTH_TYPE_UNSPECIFIED", "USER", @@ -14889,67 +13182,55 @@ false "GROUP" ], "enumDescriptions": [ -"Authentication is not specified.", -"User with valid certificate.", -"Users managed by Kubernetes API with credentials stored as secrets.", -"Collection of users." +"", +"", +"", +"" ], "type": "string" }, "name": { -"description": "Name for the subject.", "type": "string" }, "ns": { -"description": "Namespace for the subject.", "type": "string" } }, "type": "object" }, "GoogleCloudSecuritycenterV2TicketInfo": { -"description": "Information about the ticket, if any, that is being used to track the resolution of the issue that is identified by this finding.", "id": "GoogleCloudSecuritycenterV2TicketInfo", "properties": { "assignee": { -"description": "The assignee of the ticket in the ticket system.", "type": "string" }, "description": { -"description": "The description of the ticket in the ticket system.", "type": "string" }, "id": { -"description": "The identifier of the ticket in the ticket system.", "type": "string" }, "status": { -"description": "The latest status of the ticket, as reported by the ticket system.", "type": "string" }, "updateTime": { -"description": "The time when the ticket was last updated, as reported by the ticket system.", "format": "google-datetime", "type": "string" }, "uri": { -"description": "The link to the ticket in the ticket system.", "type": "string" } }, "type": "object" }, "GoogleCloudSecuritycenterV2ToxicCombination": { -"description": "Contains details about a group of security issues that, when the issues occur together, represent a greater risk than when the issues occur independently. A group of such issues is referred to as a toxic combination.", "id": "GoogleCloudSecuritycenterV2ToxicCombination", "properties": { "attackExposureScore": { -"description": "The [Attack exposure score](https://cloud.google.com/security-command-center/docs/attack-exposure-learn#attack_exposure_scores) of this toxic combination. The score is a measure of how much this toxic combination exposes one or more high-value resources to potential attack.", "format": "double", "type": "number" }, "relatedFindings": { -"description": "List of resource names of findings associated with this toxic combination. For example, `organizations/123/sources/456/findings/789`.", "items": { "type": "string" }, @@ -14959,18 +13240,15 @@ false "type": "object" }, "GoogleCloudSecuritycenterV2VertexAi": { -"description": "Vertex AI-related information associated with the finding.", "id": "GoogleCloudSecuritycenterV2VertexAi", "properties": { "datasets": { -"description": "Datasets associated with the finding.", "items": { "$ref": "GoogleCloudSecuritycenterV2Dataset" }, "type": "array" }, "pipelines": { -"description": "Pipelines associated with the finding.", "items": { "$ref": "GoogleCloudSecuritycenterV2Pipeline" }, @@ -14980,83 +13258,66 @@ false "type": "object" }, "GoogleCloudSecuritycenterV2Vulnerability": { -"description": "Refers to common vulnerability fields e.g. cve, cvss, cwe etc.", "id": "GoogleCloudSecuritycenterV2Vulnerability", "properties": { "cve": { -"$ref": "GoogleCloudSecuritycenterV2Cve", -"description": "CVE stands for Common Vulnerabilities and Exposures (https://cve.mitre.org/about/)" +"$ref": "GoogleCloudSecuritycenterV2Cve" }, "cwes": { -"description": "Represents one or more Common Weakness Enumeration (CWE) information on this vulnerability.", "items": { "$ref": "GoogleCloudSecuritycenterV2Cwe" }, "type": "array" }, "fixedPackage": { -"$ref": "GoogleCloudSecuritycenterV2Package", -"description": "The fixed package is relevant to the finding." +"$ref": "GoogleCloudSecuritycenterV2Package" }, "offendingPackage": { -"$ref": "GoogleCloudSecuritycenterV2Package", -"description": "The offending package is relevant to the finding." +"$ref": "GoogleCloudSecuritycenterV2Package" }, "providerRiskScore": { -"description": "Provider provided risk_score based on multiple factors. The higher the risk score, the more risky the vulnerability is.", "format": "int64", "type": "string" }, "reachable": { -"description": "Represents whether the vulnerability is reachable (detected via static analysis)", "type": "boolean" }, "securityBulletin": { -"$ref": "GoogleCloudSecuritycenterV2SecurityBulletin", -"description": "The security bulletin is relevant to this finding." +"$ref": "GoogleCloudSecuritycenterV2SecurityBulletin" } }, "type": "object" }, "GoogleCloudSecuritycenterV2YaraRuleSignature": { -"description": "A signature corresponding to a YARA rule.", "id": "GoogleCloudSecuritycenterV2YaraRuleSignature", "properties": { "yaraRule": { -"description": "The name of the YARA rule.", "type": "string" } }, "type": "object" }, "GroupAssetsRequest": { -"description": "Request message for grouping by assets.", "id": "GroupAssetsRequest", "properties": { "compareDuration": { -"description": "When compare_duration is set, the GroupResult's \"state_change\" property is updated to indicate whether the asset was added, removed, or remained present during the compare_duration period of time that precedes the read_time. This is the time between (read_time - compare_duration) and read_time. The state change value is derived based on the presence of the asset at the two points in time. Intermediate state changes between the two times don't affect the result. For example, the results aren't affected if the asset is removed and re-created again. Possible \"state_change\" values when compare_duration is specified: * \"ADDED\": indicates that the asset was not present at the start of compare_duration, but present at reference_time. * \"REMOVED\": indicates that the asset was present at the start of compare_duration, but not present at reference_time. * \"ACTIVE\": indicates that the asset was present at both the start and the end of the time period defined by compare_duration and reference_time. If compare_duration is not specified, then the only possible state_change is \"UNUSED\", which will be the state_change set for all assets present at read_time. If this field is set then `state_change` must be a specified field in `group_by`.", "format": "google-duration", "type": "string" }, "filter": { -"description": "Expression that defines the filter to apply across assets. The expression is a list of zero or more restrictions combined via logical operators `AND` and `OR`. Parentheses are supported, and `OR` has higher precedence than `AND`. Restrictions have the form ` ` and may have a `-` character in front of them to indicate negation. The fields map to those defined in the Asset resource. Examples include: * name * security_center_properties.resource_name * resource_properties.a_property * security_marks.marks.marka The supported operators are: * `=` for all value types. * `>`, `<`, `>=`, `<=` for integer values. * `:`, meaning substring matching, for strings. The supported value types are: * string literals in quotes. * integer literals without quotes. * boolean literals `true` and `false` without quotes. The following field and operator combinations are supported: * name: `=` * update_time: `=`, `>`, `<`, `>=`, `<=` Usage: This should be milliseconds since epoch or an RFC3339 string. Examples: `update_time = \"2019-06-10T16:07:18-07:00\"` `update_time = 1560208038000` * create_time: `=`, `>`, `<`, `>=`, `<=` Usage: This should be milliseconds since epoch or an RFC3339 string. Examples: `create_time = \"2019-06-10T16:07:18-07:00\"` `create_time = 1560208038000` * iam_policy.policy_blob: `=`, `:` * resource_properties: `=`, `:`, `>`, `<`, `>=`, `<=` * security_marks.marks: `=`, `:` * security_center_properties.resource_name: `=`, `:` * security_center_properties.resource_display_name: `=`, `:` * security_center_properties.resource_type: `=`, `:` * security_center_properties.resource_parent: `=`, `:` * security_center_properties.resource_parent_display_name: `=`, `:` * security_center_properties.resource_project: `=`, `:` * security_center_properties.resource_project_display_name: `=`, `:` * security_center_properties.resource_owners: `=`, `:` For example, `resource_properties.size = 100` is a valid filter string. Use a partial match on the empty string to filter based on a property existing: `resource_properties.my_property : \"\"` Use a negated partial match on the empty string to filter based on a property not existing: `-resource_properties.my_property : \"\"`", "type": "string" }, "groupBy": { -"description": "Required. Expression that defines what assets fields to use for grouping. The string value should follow SQL syntax: comma separated list of fields. For example: \"security_center_properties.resource_project,security_center_properties.project\". The following fields are supported when compare_duration is not set: * security_center_properties.resource_project * security_center_properties.resource_project_display_name * security_center_properties.resource_type * security_center_properties.resource_parent * security_center_properties.resource_parent_display_name The following fields are supported when compare_duration is set: * security_center_properties.resource_type * security_center_properties.resource_project_display_name * security_center_properties.resource_parent_display_name", "type": "string" }, "pageSize": { -"description": "The maximum number of results to return in a single response. Default is 10, minimum is 1, maximum is 1000.", "format": "int32", "type": "integer" }, "pageToken": { -"description": "The value returned by the last `GroupAssetsResponse`; indicates that this is a continuation of a prior `GroupAssets` call, and that the system should return the next page of data.", "type": "string" }, "readTime": { -"description": "Time used as a reference point when filtering assets. The filter is limited to assets existing at the supplied time and their values are those at that specific time. Absence of this field will default to the API's version of NOW.", "format": "google-datetime", "type": "string" } @@ -15064,27 +13325,22 @@ false "type": "object" }, "GroupAssetsResponse": { -"description": "Response message for grouping by assets.", "id": "GroupAssetsResponse", "properties": { "groupByResults": { -"description": "Group results. There exists an element for each existing unique combination of property/values. The element contains a count for the number of times those specific property/values appear.", "items": { "$ref": "GroupResult" }, "type": "array" }, "nextPageToken": { -"description": "Token to retrieve the next page of results, or empty if there are no more results.", "type": "string" }, "readTime": { -"description": "Time used for executing the groupBy request.", "format": "google-datetime", "type": "string" }, "totalSize": { -"description": "The total number of results matching the query.", "format": "int32", "type": "integer" } @@ -15092,35 +13348,28 @@ false "type": "object" }, "GroupFindingsRequest": { -"description": "Request message for grouping by findings.", "id": "GroupFindingsRequest", "properties": { "compareDuration": { "deprecated": true, -"description": "When compare_duration is set, the GroupResult's \"state_change\" attribute is updated to indicate whether the finding had its state changed, the finding's state remained unchanged, or if the finding was added during the compare_duration period of time that precedes the read_time. This is the time between (read_time - compare_duration) and read_time. The state_change value is derived based on the presence and state of the finding at the two points in time. Intermediate state changes between the two times don't affect the result. For example, the results aren't affected if the finding is made inactive and then active again. Possible \"state_change\" values when compare_duration is specified: * \"CHANGED\": indicates that the finding was present and matched the given filter at the start of compare_duration, but changed its state at read_time. * \"UNCHANGED\": indicates that the finding was present and matched the given filter at the start of compare_duration and did not change state at read_time. * \"ADDED\": indicates that the finding did not match the given filter or was not present at the start of compare_duration, but was present at read_time. * \"REMOVED\": indicates that the finding was present and matched the filter at the start of compare_duration, but did not match the filter at read_time. If compare_duration is not specified, then the only possible state_change is \"UNUSED\", which will be the state_change set for all findings present at read_time. If this field is set then `state_change` must be a specified field in `group_by`.", "format": "google-duration", "type": "string" }, "filter": { -"description": "Expression that defines the filter to apply across findings. The expression is a list of one or more restrictions combined via logical operators `AND` and `OR`. Parentheses are supported, and `OR` has higher precedence than `AND`. Restrictions have the form ` ` and may have a `-` character in front of them to indicate negation. Examples include: * name * source_properties.a_property * security_marks.marks.marka The supported operators are: * `=` for all value types. * `>`, `<`, `>=`, `<=` for integer values. * `:`, meaning substring matching, for strings. The supported value types are: * string literals in quotes. * integer literals without quotes. * boolean literals `true` and `false` without quotes. The following field and operator combinations are supported: * name: `=` * parent: `=`, `:` * resource_name: `=`, `:` * state: `=`, `:` * category: `=`, `:` * external_uri: `=`, `:` * event_time: `=`, `>`, `<`, `>=`, `<=` Usage: This should be milliseconds since epoch or an RFC3339 string. Examples: `event_time = \"2019-06-10T16:07:18-07:00\"` `event_time = 1560208038000` * severity: `=`, `:` * workflow_state: `=`, `:` * security_marks.marks: `=`, `:` * source_properties: `=`, `:`, `>`, `<`, `>=`, `<=` For example, `source_properties.size = 100` is a valid filter string. Use a partial match on the empty string to filter based on a property existing: `source_properties.my_property : \"\"` Use a negated partial match on the empty string to filter based on a property not existing: `-source_properties.my_property : \"\"` * resource: * resource.name: `=`, `:` * resource.parent_name: `=`, `:` * resource.parent_display_name: `=`, `:` * resource.project_name: `=`, `:` * resource.project_display_name: `=`, `:` * resource.type: `=`, `:`", "type": "string" }, "groupBy": { -"description": "Required. Expression that defines what assets fields to use for grouping (including `state_change`). The string value should follow SQL syntax: comma separated list of fields. For example: \"parent,resource_name\". The following fields are supported when compare_duration is set: * state_change", "type": "string" }, "pageSize": { -"description": "The maximum number of results to return in a single response. Default is 10, minimum is 1, maximum is 1000.", "format": "int32", "type": "integer" }, "pageToken": { -"description": "The value returned by the last `GroupFindingsResponse`; indicates that this is a continuation of a prior `GroupFindings` call, and that the system should return the next page of data.", "type": "string" }, "readTime": { "deprecated": true, -"description": "Time used as a reference point when filtering findings. The filter is limited to findings existing at the supplied time and their values are those at that specific time. Absence of this field will default to the API's version of NOW.", "format": "google-datetime", "type": "string" } @@ -15128,27 +13377,22 @@ false "type": "object" }, "GroupFindingsResponse": { -"description": "Response message for group by findings.", "id": "GroupFindingsResponse", "properties": { "groupByResults": { -"description": "Group results. There exists an element for each existing unique combination of property/values. The element contains a count for the number of times those specific property/values appear.", "items": { "$ref": "GroupResult" }, "type": "array" }, "nextPageToken": { -"description": "Token to retrieve the next page of results, or empty if there are no more results.", "type": "string" }, "readTime": { -"description": "Time used for executing the groupBy request.", "format": "google-datetime", "type": "string" }, "totalSize": { -"description": "The total number of results matching the query.", "format": "int32", "type": "integer" } @@ -15156,24 +13400,21 @@ false "type": "object" }, "GroupMembership": { -"description": "Contains details about groups of which this finding is a member. A group is a collection of findings that are related in some way.", "id": "GroupMembership", "properties": { "groupId": { -"description": "ID of the group.", "type": "string" }, "groupType": { -"description": "Type of group.", "enum": [ "GROUP_TYPE_UNSPECIFIED", "GROUP_TYPE_TOXIC_COMBINATION", "GROUP_TYPE_CHOKEPOINT" ], "enumDescriptions": [ -"Default value.", -"Group represents a toxic combination.", -"Group represents a chokepoint." +"", +"", +"" ], "type": "string" } @@ -15181,11 +13422,9 @@ false "type": "object" }, "GroupResult": { -"description": "Result containing the properties and count of a groupBy request.", "id": "GroupResult", "properties": { "count": { -"description": "Total count of resources for the given properties.", "format": "int64", "type": "string" }, @@ -15193,94 +13432,79 @@ false "additionalProperties": { "type": "any" }, -"description": "Properties matching the groupBy fields in the request.", "type": "object" } }, "type": "object" }, "HttpResponse": { -"description": "The http response returned by the web application.", "id": "HttpResponse", "properties": { "path": { -"description": "The http path for which response code was returned by web application, for example, \"https://test-app.a.run.app/test\".", "type": "string" }, "statusCode": { -"description": "The http response code returned by the web application, for example, 200.", "type": "string" } }, "type": "object" }, "IamBinding": { -"description": "Represents a particular IAM binding, which captures a member's role addition, removal, or state.", "id": "IamBinding", "properties": { "action": { -"description": "The action that was performed on a Binding.", "enum": [ "ACTION_UNSPECIFIED", "ADD", "REMOVE" ], "enumDescriptions": [ -"Unspecified.", -"Addition of a Binding.", -"Removal of a Binding." +"", +"", +"" ], "type": "string" }, "member": { -"description": "A single identity requesting access for a Cloud Platform resource, for example, \"foo@google.com\".", "type": "string" }, "role": { -"description": "Role that is assigned to \"members\". For example, \"roles/viewer\", \"roles/editor\", or \"roles/owner\".", "type": "string" } }, "type": "object" }, "IamPolicy": { -"description": "Cloud IAM Policy information associated with the Google Cloud resource described by the Security Command Center asset. This information is managed and defined by the Google Cloud resource and cannot be modified by the user.", "id": "IamPolicy", "properties": { "policyBlob": { -"description": "The JSON representation of the Policy associated with the asset. See https://cloud.google.com/iam/reference/rest/v1/Policy for format details.", "type": "string" } }, "type": "object" }, "Indicator": { -"description": "Represents what's commonly known as an _indicator of compromise_ (IoC) in computer forensics. This is an artifact observed on a network or in an operating system that, with high confidence, indicates a computer intrusion. For more information, see [Indicator of compromise](https://en.wikipedia.org/wiki/Indicator_of_compromise).", "id": "Indicator", "properties": { "domains": { -"description": "List of domains associated to the Finding.", "items": { "type": "string" }, "type": "array" }, "ipAddresses": { -"description": "The list of IP addresses that are associated with the finding.", "items": { "type": "string" }, "type": "array" }, "signatures": { -"description": "The list of matched signatures indicating that the given process is present in the environment.", "items": { "$ref": "ProcessSignature" }, "type": "array" }, "uris": { -"description": "The list of URIs associated to the Findings.", "items": { "type": "string" }, @@ -15290,84 +13514,70 @@ false "type": "object" }, "InfoType": { -"description": "Type of information detected by the API.", "id": "InfoType", "properties": { "name": { -"description": "Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`.", "type": "string" }, "sensitivityScore": { -"$ref": "SensitivityScore", -"description": "Optional custom sensitivity for this InfoType. This only applies to data profiling." +"$ref": "SensitivityScore" }, "version": { -"description": "Optional version name for this InfoType.", "type": "string" } }, "type": "object" }, "IpRule": { -"description": "IP rule information.", "id": "IpRule", "properties": { "portRanges": { -"description": "Optional. An optional list of ports to which this rule applies. This field is only applicable for the UDP or (S)TCP protocols. Each entry must be either an integer or a range including a min and max port number.", "items": { "$ref": "PortRange" }, "type": "array" }, "protocol": { -"description": "The IP protocol this rule applies to. This value can either be one of the following well known protocol strings (TCP, UDP, ICMP, ESP, AH, IPIP, SCTP) or a string representation of the integer value.", "type": "string" } }, "type": "object" }, "IpRules": { -"description": "IP rules associated with the finding.", "id": "IpRules", "properties": { "allowed": { -"$ref": "Allowed", -"description": "Tuple with allowed rules." +"$ref": "Allowed" }, "denied": { -"$ref": "Denied", -"description": "Tuple with denied rules." +"$ref": "Denied" }, "destinationIpRanges": { -"description": "If destination IP ranges are specified, the firewall rule applies only to traffic that has a destination IP address in these ranges. These ranges must be expressed in CIDR format. Only supports IPv4.", "items": { "type": "string" }, "type": "array" }, "direction": { -"description": "The direction that the rule is applicable to, one of ingress or egress.", "enum": [ "DIRECTION_UNSPECIFIED", "INGRESS", "EGRESS" ], "enumDescriptions": [ -"Unspecified direction value.", -"Ingress direction value.", -"Egress direction value." +"", +"", +"" ], "type": "string" }, "exposedServices": { -"description": "Name of the network protocol service, such as FTP, that is exposed by the open port. Follows the naming convention available at: https://www.iana.org/assignments/service-names-port-numbers/service-names-port-numbers.xhtml.", "items": { "type": "string" }, "type": "array" }, "sourceIpRanges": { -"description": "If source IP ranges are specified, the firewall rule applies only to traffic that has a source IP address in these ranges. These ranges must be expressed in CIDR format. Only supports IPv4.", "items": { "type": "string" }, @@ -15377,24 +13587,19 @@ false "type": "object" }, "Job": { -"description": "Describes a job", "id": "Job", "properties": { "errorCode": { -"description": "Optional. If the job did not complete successfully, this field describes why.", "format": "int32", "type": "integer" }, "location": { -"description": "Optional. Gives the location where the job ran, such as `US` or `europe-west1`", "type": "string" }, "name": { -"description": "The fully-qualified name for a job. e.g. `projects//jobs/`", "type": "string" }, "state": { -"description": "Output only. State of the job, such as `RUNNING` or `PENDING`.", "enum": [ "JOB_STATE_UNSPECIFIED", "PENDING", @@ -15403,11 +13608,11 @@ false "FAILED" ], "enumDescriptions": [ -"Unspecified represents an unknown state and should not be used.", -"Job is scheduled and pending for run", -"Job in progress", -"Job has completed with success", -"Job has completed but with failure" +"", +"", +"", +"", +"" ], "readOnly": true, "type": "string" @@ -15416,96 +13621,78 @@ false "type": "object" }, "KernelRootkit": { -"description": "Kernel mode rootkit signatures.", "id": "KernelRootkit", "properties": { "name": { -"description": "Rootkit name, when available.", "type": "string" }, "unexpectedCodeModification": { -"description": "True if unexpected modifications of kernel code memory are present.", "type": "boolean" }, "unexpectedFtraceHandler": { -"description": "True if `ftrace` points are present with callbacks pointing to regions that are not in the expected kernel or module code range.", "type": "boolean" }, "unexpectedInterruptHandler": { -"description": "True if interrupt handlers that are are not in the expected kernel or module code regions are present.", "type": "boolean" }, "unexpectedKernelCodePages": { -"description": "True if kernel code pages that are not in the expected kernel or module code regions are present.", "type": "boolean" }, "unexpectedKprobeHandler": { -"description": "True if `kprobe` points are present with callbacks pointing to regions that are not in the expected kernel or module code range.", "type": "boolean" }, "unexpectedProcessesInRunqueue": { -"description": "True if unexpected processes in the scheduler run queue are present. Such processes are in the run queue, but not in the process task list.", "type": "boolean" }, "unexpectedReadOnlyDataModification": { -"description": "True if unexpected modifications of kernel read-only data memory are present.", "type": "boolean" }, "unexpectedSystemCallHandler": { -"description": "True if system call handlers that are are not in the expected kernel or module code regions are present.", "type": "boolean" } }, "type": "object" }, "Kubernetes": { -"description": "Kubernetes-related attributes.", "id": "Kubernetes", "properties": { "accessReviews": { -"description": "Provides information on any Kubernetes access reviews (privilege checks) relevant to the finding.", "items": { "$ref": "AccessReview" }, "type": "array" }, "bindings": { -"description": "Provides Kubernetes role binding information for findings that involve [RoleBindings or ClusterRoleBindings](https://cloud.google.com/kubernetes-engine/docs/how-to/role-based-access-control).", "items": { "$ref": "GoogleCloudSecuritycenterV1Binding" }, "type": "array" }, "nodePools": { -"description": "GKE [node pools](https://cloud.google.com/kubernetes-engine/docs/concepts/node-pools) associated with the finding. This field contains node pool information for each node, when it is available.", "items": { "$ref": "NodePool" }, "type": "array" }, "nodes": { -"description": "Provides Kubernetes [node](https://cloud.google.com/kubernetes-engine/docs/concepts/cluster-architecture#nodes) information.", "items": { "$ref": "Node" }, "type": "array" }, "objects": { -"description": "Kubernetes objects related to the finding.", "items": { "$ref": "Object" }, "type": "array" }, "pods": { -"description": "Kubernetes [Pods](https://cloud.google.com/kubernetes-engine/docs/concepts/pod) associated with the finding. This field contains Pod records for each container that is owned by a Pod.", "items": { "$ref": "Pod" }, "type": "array" }, "roles": { -"description": "Provides Kubernetes role information for findings that involve [Roles or ClusterRoles](https://cloud.google.com/kubernetes-engine/docs/how-to/role-based-access-control).", "items": { "$ref": "Role" }, @@ -15515,42 +13702,34 @@ false "type": "object" }, "Label": { -"description": "Represents a generic name-value label. A label has separate name and value fields to support filtering with the `contains()` function. For more information, see [Filtering on array-type fields](https://cloud.google.com/security-command-center/docs/how-to-api-list-findings#array-contains-filtering).", "id": "Label", "properties": { "name": { -"description": "Name of the label.", "type": "string" }, "value": { -"description": "Value that corresponds to the label's name.", "type": "string" } }, "type": "object" }, "ListAssetsResponse": { -"description": "Response message for listing assets.", "id": "ListAssetsResponse", "properties": { "listAssetsResults": { -"description": "Assets matching the list request.", "items": { "$ref": "ListAssetsResult" }, "type": "array" }, "nextPageToken": { -"description": "Token to retrieve the next page of results, or empty if there are no more results.", "type": "string" }, "readTime": { -"description": "Time used for executing the list request.", "format": "google-datetime", "type": "string" }, "totalSize": { -"description": "The total number of assets matching the query.", "format": "int32", "type": "integer" } @@ -15558,15 +13737,12 @@ false "type": "object" }, "ListAssetsResult": { -"description": "Result containing the Asset and its State.", "id": "ListAssetsResult", "properties": { "asset": { -"$ref": "Asset", -"description": "Asset matching the search request." +"$ref": "Asset" }, "stateChange": { -"description": "State change of the asset between the points in time.", "enum": [ "UNUSED", "ADDED", @@ -15574,10 +13750,10 @@ false "ACTIVE" ], "enumDescriptions": [ -"State change is unused, this is the canonical default for this enum.", -"Asset was added between the points in time.", -"Asset was removed between the points in time.", -"Asset was present at both point(s) in time." +"", +"", +"", +"" ], "type": "string" } @@ -15585,69 +13761,57 @@ false "type": "object" }, "ListAttackPathsResponse": { -"description": "Response message for listing the attack paths for a given simulation or valued resource.", "id": "ListAttackPathsResponse", "properties": { "attackPaths": { -"description": "The attack paths that the attack path simulation identified.", "items": { "$ref": "AttackPath" }, "type": "array" }, "nextPageToken": { -"description": "Token to retrieve the next page of results, or empty if there are no more results.", "type": "string" } }, "type": "object" }, "ListBigQueryExportsResponse": { -"description": "Response message for listing BigQuery exports.", "id": "ListBigQueryExportsResponse", "properties": { "bigQueryExports": { -"description": "The BigQuery exports from the specified parent.", "items": { "$ref": "GoogleCloudSecuritycenterV1BigQueryExport" }, "type": "array" }, "nextPageToken": { -"description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", "type": "string" } }, "type": "object" }, "ListDescendantEventThreatDetectionCustomModulesResponse": { -"description": "Response for listing current and descendant resident Event Threat Detection custom modules.", "id": "ListDescendantEventThreatDetectionCustomModulesResponse", "properties": { "eventThreatDetectionCustomModules": { -"description": "Custom modules belonging to the requested parent.", "items": { "$ref": "EventThreatDetectionCustomModule" }, "type": "array" }, "nextPageToken": { -"description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", "type": "string" } }, "type": "object" }, "ListDescendantSecurityHealthAnalyticsCustomModulesResponse": { -"description": "Response message for listing descendant Security Health Analytics custom modules.", "id": "ListDescendantSecurityHealthAnalyticsCustomModulesResponse", "properties": { "nextPageToken": { -"description": "If not empty, indicates that there may be more custom modules to be returned.", "type": "string" }, "securityHealthAnalyticsCustomModules": { -"description": "Custom modules belonging to the requested parent and its descendants.", "items": { "$ref": "GoogleCloudSecuritycenterV1SecurityHealthAnalyticsCustomModule" }, @@ -15657,81 +13821,67 @@ false "type": "object" }, "ListEffectiveEventThreatDetectionCustomModulesResponse": { -"description": "Response for listing EffectiveEventThreatDetectionCustomModules.", "id": "ListEffectiveEventThreatDetectionCustomModulesResponse", "properties": { "effectiveEventThreatDetectionCustomModules": { -"description": "Effective custom modules belonging to the requested parent.", "items": { "$ref": "EffectiveEventThreatDetectionCustomModule" }, "type": "array" }, "nextPageToken": { -"description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", "type": "string" } }, "type": "object" }, "ListEffectiveSecurityHealthAnalyticsCustomModulesResponse": { -"description": "Response message for listing effective Security Health Analytics custom modules.", "id": "ListEffectiveSecurityHealthAnalyticsCustomModulesResponse", "properties": { "effectiveSecurityHealthAnalyticsCustomModules": { -"description": "Effective custom modules belonging to the requested parent.", "items": { "$ref": "GoogleCloudSecuritycenterV1EffectiveSecurityHealthAnalyticsCustomModule" }, "type": "array" }, "nextPageToken": { -"description": "If not empty, indicates that there may be more effective custom modules to be returned.", "type": "string" } }, "type": "object" }, "ListEventThreatDetectionCustomModulesResponse": { -"description": "Response for listing Event Threat Detection custom modules.", "id": "ListEventThreatDetectionCustomModulesResponse", "properties": { "eventThreatDetectionCustomModules": { -"description": "Custom modules belonging to the requested parent.", "items": { "$ref": "EventThreatDetectionCustomModule" }, "type": "array" }, "nextPageToken": { -"description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", "type": "string" } }, "type": "object" }, "ListFindingsResponse": { -"description": "Response message for listing findings.", "id": "ListFindingsResponse", "properties": { "listFindingsResults": { -"description": "Findings matching the list request.", "items": { "$ref": "ListFindingsResult" }, "type": "array" }, "nextPageToken": { -"description": "Token to retrieve the next page of results, or empty if there are no more results.", "type": "string" }, "readTime": { -"description": "Time used for executing the list request.", "format": "google-datetime", "type": "string" }, "totalSize": { -"description": "The total number of findings matching the query.", "format": "int32", "type": "integer" } @@ -15739,20 +13889,16 @@ false "type": "object" }, "ListFindingsResult": { -"description": "Result containing the Finding and its StateChange.", "id": "ListFindingsResult", "properties": { "finding": { -"$ref": "Finding", -"description": "Finding matching the search request." +"$ref": "Finding" }, "resource": { "$ref": "Resource", -"description": "Output only. Resource that is associated with this finding.", "readOnly": true }, "stateChange": { -"description": "State change of the finding between the points in time.", "enum": [ "UNUSED", "CHANGED", @@ -15761,11 +13907,11 @@ false "REMOVED" ], "enumDescriptions": [ -"State change is unused, this is the canonical default for this enum.", -"The finding has changed state in some way between the points in time and existed at both points.", -"The finding has not changed state between the points in time and existed at both points.", -"The finding was created between the points in time.", -"The finding at timestamp does not match the filter specified, but it did at timestamp - compare_duration." +"", +"", +"", +"", +"" ], "type": "string" } @@ -15773,33 +13919,27 @@ false "type": "object" }, "ListMuteConfigsResponse": { -"description": "Response message for listing mute configs.", "id": "ListMuteConfigsResponse", "properties": { "muteConfigs": { -"description": "The mute configs from the specified parent.", "items": { "$ref": "GoogleCloudSecuritycenterV1MuteConfig" }, "type": "array" }, "nextPageToken": { -"description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", "type": "string" } }, "type": "object" }, "ListNotificationConfigsResponse": { -"description": "Response message for listing notification configs.", "id": "ListNotificationConfigsResponse", "properties": { "nextPageToken": { -"description": "Token to retrieve the next page of results, or empty if there are no more results.", "type": "string" }, "notificationConfigs": { -"description": "Notification configs belonging to the requested parent.", "items": { "$ref": "NotificationConfig" }, @@ -15809,22 +13949,18 @@ false "type": "object" }, "ListOperationsResponse": { -"description": "The response message for Operations.ListOperations.", "id": "ListOperationsResponse", "properties": { "nextPageToken": { -"description": "The standard List next-page token.", "type": "string" }, "operations": { -"description": "A list of operations that matches the specified filter in the request.", "items": { "$ref": "Operation" }, "type": "array" }, "unreachable": { -"description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections. For example, when attempting to list all resources across all supported locations.", "items": { "type": "string" }, @@ -15834,15 +13970,12 @@ false "type": "object" }, "ListResourceValueConfigsResponse": { -"description": "Response message to list resource value configs", "id": "ListResourceValueConfigsResponse", "properties": { "nextPageToken": { -"description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is empty, there are no subsequent pages.", "type": "string" }, "resourceValueConfigs": { -"description": "The resource value configs from the specified parent.", "items": { "$ref": "GoogleCloudSecuritycenterV1ResourceValueConfig" }, @@ -15852,15 +13985,12 @@ false "type": "object" }, "ListSecurityHealthAnalyticsCustomModulesResponse": { -"description": "Response message for listing Security Health Analytics custom modules.", "id": "ListSecurityHealthAnalyticsCustomModulesResponse", "properties": { "nextPageToken": { -"description": "If not empty, indicates that there may be more custom modules to be returned.", "type": "string" }, "securityHealthAnalyticsCustomModules": { -"description": "Custom modules belonging to the requested parent.", "items": { "$ref": "GoogleCloudSecuritycenterV1SecurityHealthAnalyticsCustomModule" }, @@ -15870,15 +14000,12 @@ false "type": "object" }, "ListSourcesResponse": { -"description": "Response message for listing sources.", "id": "ListSourcesResponse", "properties": { "nextPageToken": { -"description": "Token to retrieve the next page of results, or empty if there are no more results.", "type": "string" }, "sources": { -"description": "Sources belonging to the requested parent.", "items": { "$ref": "Source" }, @@ -15888,20 +14015,16 @@ false "type": "object" }, "ListValuedResourcesResponse": { -"description": "Response message for listing the valued resources for a given simulation.", "id": "ListValuedResourcesResponse", "properties": { "nextPageToken": { -"description": "Token to retrieve the next page of results, or empty if there are no more results.", "type": "string" }, "totalSize": { -"description": "The estimated total number of results matching the query.", "format": "int32", "type": "integer" }, "valuedResources": { -"description": "The valued resources that the attack path simulation identified.", "items": { "$ref": "ValuedResource" }, @@ -15911,37 +14034,30 @@ false "type": "object" }, "LoadBalancer": { -"description": "Contains information related to the load balancer associated with the finding.", "id": "LoadBalancer", "properties": { "name": { -"description": "The name of the load balancer associated with the finding.", "type": "string" } }, "type": "object" }, "LogEntry": { -"description": "An individual entry in a log.", "id": "LogEntry", "properties": { "cloudLoggingEntry": { -"$ref": "CloudLoggingEntry", -"description": "An individual entry in a log stored in Cloud Logging." +"$ref": "CloudLoggingEntry" } }, "type": "object" }, "MemoryHashSignature": { -"description": "A signature corresponding to memory page hashes.", "id": "MemoryHashSignature", "properties": { "binaryFamily": { -"description": "The binary family.", "type": "string" }, "detections": { -"description": "The list of memory hash detections contributing to the binary family match.", "items": { "$ref": "Detection" }, @@ -15951,11 +14067,9 @@ false "type": "object" }, "MitreAttack": { -"description": "MITRE ATT&CK tactics and techniques related to this finding. See: https://attack.mitre.org", "id": "MitreAttack", "properties": { "additionalTactics": { -"description": "Additional MITRE ATT&CK tactics related to this finding, if any.", "items": { "enum": [ "TACTIC_UNSPECIFIED", @@ -15975,28 +14089,27 @@ false "IMPACT" ], "enumDescriptions": [ -"Unspecified value.", -"TA0043", -"TA0042", -"TA0001", -"TA0002", -"TA0003", -"TA0004", -"TA0005", -"TA0006", -"TA0007", -"TA0008", -"TA0009", -"TA0011", -"TA0010", -"TA0040" +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"" ], "type": "string" }, "type": "array" }, "additionalTechniques": { -"description": "Additional MITRE ATT&CK techniques related to this finding, if any, along with any of their respective parent techniques.", "items": { "enum": [ "TECHNIQUE_UNSPECIFIED", @@ -16140,152 +14253,151 @@ false "FINANCIAL_THEFT" ], "enumDescriptions": [ -"Unspecified value.", -"T1001", -"T1001.002", -"T1003", -"T1003.007", -"T1003.008", -"T1005", -"T1020", -"T1027", -"T1027.003", -"T1027.004", -"T1027.010", -"T1029", -"T1033", -"T1036", -"T1036.005", -"T1037", -"T1037.005", -"T1046", -"T1053", -"T1053.003", -"T1053.007", -"T1055", -"T1056", -"T1056.001", -"T1057", -"T1059", -"T1059.004", -"T1059.006", -"T1068", -"T1069", -"T1069.003", -"T1070", -"T1070.002", -"T1070.003", -"T1070.004", -"T1070.006", -"T1070.008", -"T1071", -"T1071.004", -"T1072", -"T1078", -"T1078.001", -"T1078.003", -"T1078.004", -"T1083", -"T1087.001", -"T1090", -"T1090.002", -"T1090.003", -"T1098", -"T1098.001", -"T1098.003", -"T1098.004", -"T1098.006", -"T1104", -"T1105", -"T1106", -"T1110", -"T1119", -"T1129", -"T1132", -"T1132.001", -"T1134", -"T1134.001", -"T1136", -"T1136.001", -"T1140", -"T1190", -"T1195", -"T1195.001", -"T1203", -"T1204", -"T1212", -"T1222.002", -"T1484", -"T1485", -"T1486", -"T1489", -"T1490", -"T1495", -"T1496", -"T1498", -"T1526", -"T1528", -"T1531", -"T1537", -"T1539", -"T1543", -"T1546", -"T1547", -"T1547.006", -"T1547.009", -"T1548", -"T1548.001", -"T1548.003", -"T1552", -"T1552.001", -"T1552.003", -"T1552.004", -"T1553", -"T1553.004", -"T1554", -"T1555", -"T1556", -"T1556.003", -"T1556.006", -"T1562", -"T1562.001", -"T1562.006", -"T1562.012", -"T1564", -"T1564.001", -"T1564.002", -"T1567", -"T1567.002", -"T1568", -"T1570", -"T1574", -"T1574.006", -"T1578", -"T1578.001", -"T1580", -"T1587", -"T1587.001", -"T1588", -"T1588.001", -"T1588.006", -"T1595", -"T1595.001", -"T1608", -"T1608.001", -"T1609", -"T1610", -"T1611", -"T1613", -"T1620", -"T1649", -"T1657" +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"" ], "type": "string" }, "type": "array" }, "primaryTactic": { -"description": "The MITRE ATT&CK tactic most closely represented by this finding, if any.", "enum": [ "TACTIC_UNSPECIFIED", "RECONNAISSANCE", @@ -16304,26 +14416,25 @@ false "IMPACT" ], "enumDescriptions": [ -"Unspecified value.", -"TA0043", -"TA0042", -"TA0001", -"TA0002", -"TA0003", -"TA0004", -"TA0005", -"TA0006", -"TA0007", -"TA0008", -"TA0009", -"TA0011", -"TA0010", -"TA0040" +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"" ], "type": "string" }, "primaryTechniques": { -"description": "The MITRE ATT&CK technique most closely represented by this finding, if any. primary_techniques is a repeated field because there are multiple levels of MITRE ATT&CK techniques. If the technique most closely represented by this finding is a sub-technique (e.g. `SCANNING_IP_BLOCKS`), both the sub-technique and its parent technique(s) will be listed (e.g. `SCANNING_IP_BLOCKS`, `ACTIVE_SCANNING`).", "items": { "enum": [ "TECHNIQUE_UNSPECIFIED", @@ -16467,207 +14578,196 @@ false "FINANCIAL_THEFT" ], "enumDescriptions": [ -"Unspecified value.", -"T1001", -"T1001.002", -"T1003", -"T1003.007", -"T1003.008", -"T1005", -"T1020", -"T1027", -"T1027.003", -"T1027.004", -"T1027.010", -"T1029", -"T1033", -"T1036", -"T1036.005", -"T1037", -"T1037.005", -"T1046", -"T1053", -"T1053.003", -"T1053.007", -"T1055", -"T1056", -"T1056.001", -"T1057", -"T1059", -"T1059.004", -"T1059.006", -"T1068", -"T1069", -"T1069.003", -"T1070", -"T1070.002", -"T1070.003", -"T1070.004", -"T1070.006", -"T1070.008", -"T1071", -"T1071.004", -"T1072", -"T1078", -"T1078.001", -"T1078.003", -"T1078.004", -"T1083", -"T1087.001", -"T1090", -"T1090.002", -"T1090.003", -"T1098", -"T1098.001", -"T1098.003", -"T1098.004", -"T1098.006", -"T1104", -"T1105", -"T1106", -"T1110", -"T1119", -"T1129", -"T1132", -"T1132.001", -"T1134", -"T1134.001", -"T1136", -"T1136.001", -"T1140", -"T1190", -"T1195", -"T1195.001", -"T1203", -"T1204", -"T1212", -"T1222.002", -"T1484", -"T1485", -"T1486", -"T1489", -"T1490", -"T1495", -"T1496", -"T1498", -"T1526", -"T1528", -"T1531", -"T1537", -"T1539", -"T1543", -"T1546", -"T1547", -"T1547.006", -"T1547.009", -"T1548", -"T1548.001", -"T1548.003", -"T1552", -"T1552.001", -"T1552.003", -"T1552.004", -"T1553", -"T1553.004", -"T1554", -"T1555", -"T1556", -"T1556.003", -"T1556.006", -"T1562", -"T1562.001", -"T1562.006", -"T1562.012", -"T1564", -"T1564.001", -"T1564.002", -"T1567", -"T1567.002", -"T1568", -"T1570", -"T1574", -"T1574.006", -"T1578", -"T1578.001", -"T1580", -"T1587", -"T1587.001", -"T1588", -"T1588.001", -"T1588.006", -"T1595", -"T1595.001", -"T1608", -"T1608.001", -"T1609", -"T1610", -"T1611", -"T1613", -"T1620", -"T1649", -"T1657" +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"" ], "type": "string" }, "type": "array" }, "version": { -"description": "The MITRE ATT&CK version referenced by the above fields. E.g. \"8\".", "type": "string" } }, "type": "object" }, "MuteInfo": { -"description": "Mute information about the finding, including whether the finding has a static mute or any matching dynamic mute rules.", "id": "MuteInfo", "properties": { "dynamicMuteRecords": { -"description": "The list of dynamic mute rules that currently match the finding.", "items": { "$ref": "DynamicMuteRecord" }, "type": "array" }, "staticMute": { -"$ref": "StaticMute", -"description": "If set, the static mute applied to this finding. Static mutes override dynamic mutes. If unset, there is no static mute." +"$ref": "StaticMute" } }, "type": "object" }, "Network": { -"description": "Contains information about a VPC network associated with the finding.", "id": "Network", "properties": { "name": { -"description": "The name of the VPC network resource, for example, `//compute.googleapis.com/projects/my-project/global/networks/my-network`.", "type": "string" } }, "type": "object" }, "Node": { -"description": "Kubernetes nodes associated with the finding.", "id": "Node", "properties": { "name": { -"description": "[Full resource name](https://google.aip.dev/122#full-resource-names) of the Compute Engine VM running the cluster node.", "type": "string" } }, "type": "object" }, "NodePool": { -"description": "Provides GKE node pool information.", "id": "NodePool", "properties": { "name": { -"description": "Kubernetes node pool name.", "type": "string" }, "nodes": { -"description": "Nodes associated with the finding.", "items": { "$ref": "Node" }, @@ -16677,109 +14777,87 @@ false "type": "object" }, "Notebook": { -"description": "Represents a Jupyter notebook IPYNB file, such as a [Colab Enterprise notebook](https://cloud.google.com/colab/docs/introduction) file, that is associated with a finding.", "id": "Notebook", "properties": { "lastAuthor": { -"description": "The user ID of the latest author to modify the notebook.", "type": "string" }, "name": { -"description": "The name of the notebook.", "type": "string" }, "notebookUpdateTime": { -"description": "The most recent time the notebook was updated.", "format": "google-datetime", "type": "string" }, "service": { -"description": "The source notebook service, for example, \"Colab Enterprise\".", "type": "string" } }, "type": "object" }, "NotificationConfig": { -"description": "Cloud Security Command Center (Cloud SCC) notification configs. A notification config is a Cloud SCC resource that contains the configuration to send notifications for create/update events of findings, assets and etc.", "id": "NotificationConfig", "properties": { "description": { -"description": "The description of the notification config (max of 1024 characters).", "type": "string" }, "name": { -"description": "The relative resource name of this notification config. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Example: \"organizations/{organization_id}/notificationConfigs/notify_public_bucket\", \"folders/{folder_id}/notificationConfigs/notify_public_bucket\", or \"projects/{project_id}/notificationConfigs/notify_public_bucket\".", "type": "string" }, "pubsubTopic": { -"description": "The Pub/Sub topic to send notifications to. Its format is \"projects/[project_id]/topics/[topic]\".", "type": "string" }, "serviceAccount": { -"description": "Output only. The service account that needs \"pubsub.topics.publish\" permission to publish to the Pub/Sub topic.", "readOnly": true, "type": "string" }, "streamingConfig": { -"$ref": "StreamingConfig", -"description": "The config for triggering streaming-based notifications." +"$ref": "StreamingConfig" } }, "type": "object" }, "Object": { -"description": "Kubernetes object related to the finding, uniquely identified by GKNN. Used if the object Kind is not one of Pod, Node, NodePool, Binding, or AccessReview.", "id": "Object", "properties": { "containers": { -"description": "Pod containers associated with this finding, if any.", "items": { "$ref": "Container" }, "type": "array" }, "group": { -"description": "Kubernetes object group, such as \"policy.k8s.io/v1\".", "type": "string" }, "kind": { -"description": "Kubernetes object kind, such as \"Namespace\".", "type": "string" }, "name": { -"description": "Kubernetes object name. For details see https://kubernetes.io/docs/concepts/overview/working-with-objects/names/.", "type": "string" }, "ns": { -"description": "Kubernetes object namespace. Must be a valid DNS label. Named \"ns\" to avoid collision with C++ namespace keyword. For details see https://kubernetes.io/docs/tasks/administer-cluster/namespaces/.", "type": "string" } }, "type": "object" }, "Operation": { -"description": "This resource represents a long-running operation that is the result of a network API call.", "id": "Operation", "properties": { "done": { -"description": "If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.", "type": "boolean" }, "error": { -"$ref": "Status", -"description": "The error result of the operation in case of failure or cancellation." +"$ref": "Status" }, "metadata": { "additionalProperties": { "description": "Properties of the object. Contains field @type with type URL.", "type": "any" }, -"description": "Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.", "type": "object" }, "name": { -"description": "The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.", "type": "string" }, "response": { @@ -16787,153 +14865,124 @@ false "description": "Properties of the object. Contains field @type with type URL.", "type": "any" }, -"description": "The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.", "type": "object" } }, "type": "object" }, "OrgPolicy": { -"description": "Contains information about the org policies associated with the finding.", "id": "OrgPolicy", "properties": { "name": { -"description": "The resource name of the org policy. Example: \"organizations/{organization_id}/policies/{constraint_name}\"", "type": "string" } }, "type": "object" }, "OrganizationSettings": { -"description": "User specified settings that are attached to the Security Command Center organization.", "id": "OrganizationSettings", "properties": { "assetDiscoveryConfig": { -"$ref": "AssetDiscoveryConfig", -"description": "The configuration used for Asset Discovery runs." +"$ref": "AssetDiscoveryConfig" }, "enableAssetDiscovery": { -"description": "A flag that indicates if Asset Discovery should be enabled. If the flag is set to `true`, then discovery of assets will occur. If it is set to `false`, all historical assets will remain, but discovery of future assets will not occur.", "type": "boolean" }, "name": { -"description": "The relative resource name of the settings. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Example: \"organizations/{organization_id}/organizationSettings\".", "type": "string" } }, "type": "object" }, "Package": { -"description": "Package is a generic definition of a package.", "id": "Package", "properties": { "cpeUri": { -"description": "The CPE URI where the vulnerability was detected.", "type": "string" }, "packageName": { -"description": "The name of the package where the vulnerability was detected.", "type": "string" }, "packageType": { -"description": "Type of package, for example, os, maven, or go.", "type": "string" }, "packageVersion": { -"description": "The version of the package.", "type": "string" } }, "type": "object" }, "PathNodeAssociatedFinding": { -"description": "A finding that is associated with this node in the attack path.", "id": "PathNodeAssociatedFinding", "properties": { "canonicalFinding": { -"description": "Canonical name of the associated findings. Example: `organizations/123/sources/456/findings/789`", "type": "string" }, "findingCategory": { -"description": "The additional taxonomy group within findings from a given source.", "type": "string" }, "name": { -"description": "Full resource name of the finding.", "type": "string" } }, "type": "object" }, "Pipeline": { -"description": "Vertex AI training pipeline associated with the finding.", "id": "Pipeline", "properties": { "displayName": { -"description": "The user defined display name of pipeline, e.g. plants-classification", "type": "string" }, "name": { -"description": "Resource name of the pipeline, e.g. projects/{project}/locations/{location}/trainingPipelines/5253428229225578496", "type": "string" } }, "type": "object" }, "Pod": { -"description": "A Kubernetes Pod.", "id": "Pod", "properties": { "containers": { -"description": "Pod containers associated with this finding, if any.", "items": { "$ref": "Container" }, "type": "array" }, "labels": { -"description": "Pod labels. For Kubernetes containers, these are applied to the container.", "items": { "$ref": "Label" }, "type": "array" }, "name": { -"description": "Kubernetes Pod name.", "type": "string" }, "ns": { -"description": "Kubernetes Pod namespace.", "type": "string" } }, "type": "object" }, "Policy": { -"description": "An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { \"bindings\": [ { \"role\": \"roles/resourcemanager.organizationAdmin\", \"members\": [ \"user:mike@example.com\", \"group:admins@example.com\", \"domain:google.com\", \"serviceAccount:my-project-id@appspot.gserviceaccount.com\" ] }, { \"role\": \"roles/resourcemanager.organizationViewer\", \"members\": [ \"user:eve@example.com\" ], \"condition\": { \"title\": \"expirable access\", \"description\": \"Does not grant access after Sep 2020\", \"expression\": \"request.time < timestamp('2020-10-01T00:00:00.000Z')\", } } ], \"etag\": \"BwWWja0YfJA=\", \"version\": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).", "id": "Policy", "properties": { "auditConfigs": { -"description": "Specifies cloud audit logging configuration for this policy.", "items": { "$ref": "AuditConfig" }, "type": "array" }, "bindings": { -"description": "Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`.", "items": { "$ref": "Binding" }, "type": "array" }, "etag": { -"description": "`etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.", "format": "byte", "type": "string" }, "version": { -"description": "Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", "format": "int32", "type": "integer" } @@ -16941,45 +14990,36 @@ false "type": "object" }, "PolicyDriftDetails": { -"description": "The policy field that violates the deployed posture and its expected and detected values.", "id": "PolicyDriftDetails", "properties": { "detectedValue": { -"description": "The detected value that violates the deployed posture, for example, `false` or `allowed_values={\"projects/22831892\"}`.", "type": "string" }, "expectedValue": { -"description": "The value of this field that was configured in a posture, for example, `true` or `allowed_values={\"projects/29831892\"}`.", "type": "string" }, "field": { -"description": "The name of the updated field, for example constraint.implementation.policy_rules[0].enforce", "type": "string" } }, "type": "object" }, "PolicyViolationSummary": { -"description": "Metadata summarizing policy violations of child resources of the affected resource. `finding_category` and `resource` determine the exact semantics of the counts. For example, when category=DATA_SECURITY_POSTURE_OBJECT_PUBLIC_ACCESS_VIOLATION and resource='storage.googleapis.com/buckets/my-bucket-name' then this counts the number of Cloud Storage objects in my-bucket-name which violate a Public Access control.", "id": "PolicyViolationSummary", "properties": { "conformantResourcesCount": { -"description": "Total number of child resources that conform to the policy.", "format": "int64", "type": "string" }, "evaluationErrorsCount": { -"description": "Number of child resources for which errors during evaluation occurred. The evaluation result for these child resources is effectively \"unknown\".", "format": "int64", "type": "string" }, "outOfScopeResourcesCount": { -"description": "Total count of child resources which were not in scope for evaluation.", "format": "int64", "type": "string" }, "policyViolationsCount": { -"description": "Count of child resources in violation of the policy.", "format": "int64", "type": "string" } @@ -16987,16 +15027,13 @@ false "type": "object" }, "PortRange": { -"description": "A port range which is inclusive of the min and max values. Values are between 0 and 2^16-1. The max can be equal / must be not smaller than the min value. If min and max are equal this indicates that it is a single port.", "id": "PortRange", "properties": { "max": { -"description": "Maximum port value.", "format": "int64", "type": "string" }, "min": { -"description": "Minimum port value.", "format": "int64", "type": "string" } @@ -17004,16 +15041,13 @@ false "type": "object" }, "Position": { -"description": "A position in the uploaded text version of a module.", "id": "Position", "properties": { "columnNumber": { -"description": "The column number.", "format": "int32", "type": "integer" }, "lineNumber": { -"description": "The line number.", "format": "int32", "type": "integer" } @@ -17021,62 +15055,50 @@ false "type": "object" }, "Process": { -"description": "Represents an operating system process.", "id": "Process", "properties": { "args": { -"description": "Process arguments as JSON encoded strings.", "items": { "type": "string" }, "type": "array" }, "argumentsTruncated": { -"description": "True if `args` is incomplete.", "type": "boolean" }, "binary": { -"$ref": "File", -"description": "File information for the process executable." +"$ref": "File" }, "envVariables": { -"description": "Process environment variables.", "items": { "$ref": "EnvironmentVariable" }, "type": "array" }, "envVariablesTruncated": { -"description": "True if `env_variables` is incomplete.", "type": "boolean" }, "libraries": { -"description": "File information for libraries loaded by the process.", "items": { "$ref": "File" }, "type": "array" }, "name": { -"description": "The process name, as displayed in utilities like `top` and `ps`. This name can be accessed through `/proc/[pid]/comm` and changed with `prctl(PR_SET_NAME)`.", "type": "string" }, "parentPid": { -"description": "The parent process ID.", "format": "int64", "type": "string" }, "pid": { -"description": "The process ID.", "format": "int64", "type": "string" }, "script": { -"$ref": "File", -"description": "When the process represents the invocation of a script, `binary` provides information about the interpreter, while `script` provides information about the script file provided to the interpreter." +"$ref": "File" }, "userId": { -"description": "The ID of the user that executed the process. E.g. If this is the root user this will always be 0.", "format": "int64", "type": "string" } @@ -17084,70 +15106,58 @@ false "type": "object" }, "ProcessSignature": { -"description": "Indicates what signature matched this process.", "id": "ProcessSignature", "properties": { "memoryHashSignature": { -"$ref": "MemoryHashSignature", -"description": "Signature indicating that a binary family was matched." +"$ref": "MemoryHashSignature" }, "signatureType": { -"description": "Describes the type of resource associated with the signature.", "enum": [ "SIGNATURE_TYPE_UNSPECIFIED", "SIGNATURE_TYPE_PROCESS", "SIGNATURE_TYPE_FILE" ], "enumDescriptions": [ -"The default signature type.", -"Used for signatures concerning processes.", -"Used for signatures concerning disks." +"", +"", +"" ], "type": "string" }, "yaraRuleSignature": { -"$ref": "YaraRuleSignature", -"description": "Signature indicating that a YARA rule was matched." +"$ref": "YaraRuleSignature" } }, "type": "object" }, "Reference": { -"description": "Additional Links", "id": "Reference", "properties": { "source": { -"description": "Source of the reference e.g. NVD", "type": "string" }, "uri": { -"description": "Uri for the mentioned source e.g. https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2021-34527.", "type": "string" } }, "type": "object" }, "Requests": { -"description": "Information about the requests relevant to the finding.", "id": "Requests", "properties": { "longTermAllowed": { -"description": "Allowed RPS (requests per second) over the long term.", "format": "int32", "type": "integer" }, "longTermDenied": { -"description": "Denied RPS (requests per second) over the long term.", "format": "int32", "type": "integer" }, "ratio": { -"description": "For 'Increasing deny ratio', the ratio is the denied traffic divided by the allowed traffic. For 'Allowed traffic spike', the ratio is the allowed traffic in the short term divided by allowed traffic in the long term.", "format": "double", "type": "number" }, "shortTermAllowed": { -"description": "Allowed RPS (requests per second) in the short term.", "format": "int32", "type": "integer" } @@ -17155,35 +15165,27 @@ false "type": "object" }, "Resource": { -"description": "Information related to the Google Cloud resource that is associated with this finding.", "id": "Resource", "properties": { "adcApplication": { -"$ref": "AdcApplication", -"description": "The ADC application associated with the finding." +"$ref": "AdcApplication" }, "adcApplicationTemplate": { -"$ref": "AdcApplicationTemplateRevision", -"description": "The ADC template associated with the finding." +"$ref": "AdcApplicationTemplateRevision" }, "adcSharedTemplate": { -"$ref": "AdcSharedTemplateRevision", -"description": "The ADC shared template associated with the finding." +"$ref": "AdcSharedTemplateRevision" }, "application": { -"$ref": "GoogleCloudSecuritycenterV1ResourceApplication", -"description": "The App Hub application this resource belongs to." +"$ref": "GoogleCloudSecuritycenterV1ResourceApplication" }, "awsMetadata": { -"$ref": "AwsMetadata", -"description": "The AWS metadata associated with the finding." +"$ref": "AwsMetadata" }, "azureMetadata": { -"$ref": "AzureMetadata", -"description": "The Azure metadata associated with the finding." +"$ref": "AzureMetadata" }, "cloudProvider": { -"description": "Indicates which cloud provider the finding is from.", "enum": [ "CLOUD_PROVIDER_UNSPECIFIED", "GOOGLE_CLOUD_PLATFORM", @@ -17191,77 +15193,62 @@ false "MICROSOFT_AZURE" ], "enumDescriptions": [ -"The cloud provider is unspecified.", -"The cloud provider is Google Cloud.", -"The cloud provider is Amazon Web Services.", -"The cloud provider is Microsoft Azure." +"", +"", +"", +"" ], "type": "string" }, "displayName": { -"description": "The human readable name of the resource.", "type": "string" }, "folders": { -"description": "Contains a Folder message for each folder in the assets ancestry. The first folder is the deepest nested folder, and the last folder is the folder directly under the Organization.", "items": { "$ref": "Folder" }, "type": "array" }, "location": { -"description": "The region or location of the service (if applicable).", "type": "string" }, "name": { -"description": "The full resource name of the resource. See: https://cloud.google.com/apis/design/resource_names#full_resource_name", "type": "string" }, "organization": { -"description": "Indicates which organization / tenant the finding is for.", "type": "string" }, "parentDisplayName": { -"description": "The human readable name of resource's parent.", "type": "string" }, "parentName": { -"description": "The full resource name of resource's parent.", "type": "string" }, "projectDisplayName": { -"description": "The project ID that the resource belongs to.", "type": "string" }, "projectName": { -"description": "The full resource name of project that the resource belongs to.", "type": "string" }, "resourcePath": { -"$ref": "ResourcePath", -"description": "Provides the path to the resource within the resource hierarchy." +"$ref": "ResourcePath" }, "resourcePathString": { -"description": "A string representation of the resource path. For Google Cloud, it has the format of `org/{organization_id}/folder/{folder_id}/folder/{folder_id}/project/{project_id}` where there can be any number of folders. For AWS, it has the format of `org/{organization_id}/ou/{organizational_unit_id}/ou/{organizational_unit_id}/account/{account_id}` where there can be any number of organizational units. For Azure, it has the format of `mg/{management_group_id}/mg/{management_group_id}/subscription/{subscription_id}/rg/{resource_group_name}` where there can be any number of management groups.", "type": "string" }, "service": { -"description": "The service or resource provider associated with the resource.", "type": "string" }, "type": { -"description": "The full resource type of the resource.", "type": "string" } }, "type": "object" }, "ResourcePath": { -"description": "Represents the path of resources leading up to the resource this finding is about.", "id": "ResourcePath", "properties": { "nodes": { -"description": "The list of nodes that make the up resource path, ordered from lowest level to highest level.", "items": { "$ref": "ResourcePathNode" }, @@ -17271,19 +15258,15 @@ false "type": "object" }, "ResourcePathNode": { -"description": "A node within the resource path. Each node represents a resource within the resource hierarchy.", "id": "ResourcePathNode", "properties": { "displayName": { -"description": "The display name of the resource this node represents.", "type": "string" }, "id": { -"description": "The ID of the resource this node represents.", "type": "string" }, "nodeType": { -"description": "The type of resource this node represents.", "enum": [ "RESOURCE_PATH_NODE_TYPE_UNSPECIFIED", "GCP_ORGANIZATION", @@ -17297,16 +15280,16 @@ false "AZURE_RESOURCE_GROUP" ], "enumDescriptions": [ -"Node type is unspecified.", -"The node represents a Google Cloud organization.", -"The node represents a Google Cloud folder.", -"The node represents a Google Cloud project.", -"The node represents an AWS organization.", -"The node represents an AWS organizational unit.", -"The node represents an AWS account.", -"The node represents an Azure management group.", -"The node represents an Azure subscription.", -"The node represents an Azure resource group." +"", +"", +"", +"", +"", +"", +"", +"", +"", +"" ], "type": "string" } @@ -17314,107 +15297,88 @@ false "type": "object" }, "ResourceValueConfigMetadata": { -"description": "Metadata about a ResourceValueConfig. For example, id and name.", "id": "ResourceValueConfigMetadata", "properties": { "name": { -"description": "Resource value config name", "type": "string" } }, "type": "object" }, "Role": { -"description": "Kubernetes Role or ClusterRole.", "id": "Role", "properties": { "kind": { -"description": "Role type.", "enum": [ "KIND_UNSPECIFIED", "ROLE", "CLUSTER_ROLE" ], "enumDescriptions": [ -"Role type is not specified.", -"Kubernetes Role.", -"Kubernetes ClusterRole." +"", +"", +"" ], "type": "string" }, "name": { -"description": "Role name.", "type": "string" }, "ns": { -"description": "Role namespace.", "type": "string" } }, "type": "object" }, "RunAssetDiscoveryRequest": { -"description": "Request message for running asset discovery for an organization.", "id": "RunAssetDiscoveryRequest", "properties": {}, "type": "object" }, "Secret": { -"description": "Details about a secret or credential associated with the finding.", "id": "Secret", "properties": { "environmentVariable": { -"$ref": "SecretEnvironmentVariable", -"description": "The environment variable containing the secret." +"$ref": "SecretEnvironmentVariable" }, "filePath": { -"$ref": "SecretFilePath", -"description": "The file containing the secret." +"$ref": "SecretFilePath" }, "status": { -"$ref": "SecretStatus", -"description": "The status of the secret." +"$ref": "SecretStatus" }, "type": { -"description": "The type of secret, for example, GCP_API_KEY.", "type": "string" } }, "type": "object" }, "SecretEnvironmentVariable": { -"description": "Environment variable containing the secret.", "id": "SecretEnvironmentVariable", "properties": { "key": { -"description": "Environment variable name as a JSON encoded string. Note that value is not included since the value contains the secret data, which is sensitive core content.", "type": "string" } }, "type": "object" }, "SecretFilePath": { -"description": "File path containing the secret.", "id": "SecretFilePath", "properties": { "path": { -"description": "Path to the file.", "type": "string" } }, "type": "object" }, "SecretStatus": { -"description": "The status of the secret.", "id": "SecretStatus", "properties": { "lastUpdatedTime": { -"description": "Time that the secret was found.", "format": "google-datetime", "type": "string" }, "validity": { -"description": "The validity of the secret.", "enum": [ "SECRET_VALIDITY_UNSPECIFIED", "SECRET_VALIDITY_UNSUPPORTED", @@ -17423,11 +15387,11 @@ false "SECRET_VALIDITY_VALID" ], "enumDescriptions": [ -"Default value; no validation was attempted.", -"There is no mechanism to validate the secret.", -"Validation is supported but the validation failed.", -"The secret is confirmed to be invalid.", -"The secret is confirmed to be valid." +"", +"", +"", +"", +"" ], "type": "string" } @@ -17435,163 +15399,130 @@ false "type": "object" }, "SecurityBulletin": { -"description": "SecurityBulletin are notifications of vulnerabilities of Google products.", "id": "SecurityBulletin", "properties": { "bulletinId": { -"description": "ID of the bulletin corresponding to the vulnerability.", "type": "string" }, "submissionTime": { -"description": "Submission time of this Security Bulletin.", "format": "google-datetime", "type": "string" }, "suggestedUpgradeVersion": { -"description": "This represents a version that the cluster receiving this notification should be upgraded to, based on its current version. For example, 1.15.0", "type": "string" } }, "type": "object" }, "SecurityCenterProperties": { -"description": "Security Command Center managed properties. These properties are managed by Security Command Center and cannot be modified by the user.", "id": "SecurityCenterProperties", "properties": { "folders": { -"description": "Contains a Folder message for each folder in the assets ancestry. The first folder is the deepest nested folder, and the last folder is the folder directly under the Organization.", "items": { "$ref": "Folder" }, "type": "array" }, "resourceDisplayName": { -"description": "The user defined display name for this resource.", "type": "string" }, "resourceName": { -"description": "The full resource name of the Google Cloud resource this asset represents. This field is immutable after create time. See: https://cloud.google.com/apis/design/resource_names#full_resource_name", "type": "string" }, "resourceOwners": { -"description": "Owners of the Google Cloud resource.", "items": { "type": "string" }, "type": "array" }, "resourceParent": { -"description": "The full resource name of the immediate parent of the resource. See: https://cloud.google.com/apis/design/resource_names#full_resource_name", "type": "string" }, "resourceParentDisplayName": { -"description": "The user defined display name for the parent of this resource.", "type": "string" }, "resourceProject": { -"description": "The full resource name of the project the resource belongs to. See: https://cloud.google.com/apis/design/resource_names#full_resource_name", "type": "string" }, "resourceProjectDisplayName": { -"description": "The user defined display name for the project of this resource.", "type": "string" }, "resourceType": { -"description": "The type of the Google Cloud resource. Examples include: APPLICATION, PROJECT, and ORGANIZATION. This is a case insensitive field defined by Security Command Center and/or the producer of the resource and is immutable after create time.", "type": "string" } }, "type": "object" }, "SecurityMarks": { -"description": "User specified security marks that are attached to the parent Security Command Center resource. Security marks are scoped within a Security Command Center organization -- they can be modified and viewed by all users who have proper permissions on the organization.", "id": "SecurityMarks", "properties": { "canonicalName": { -"description": "The canonical name of the marks. Examples: \"organizations/{organization_id}/assets/{asset_id}/securityMarks\" \"folders/{folder_id}/assets/{asset_id}/securityMarks\" \"projects/{project_number}/assets/{asset_id}/securityMarks\" \"organizations/{organization_id}/sources/{source_id}/findings/{finding_id}/securityMarks\" \"folders/{folder_id}/sources/{source_id}/findings/{finding_id}/securityMarks\" \"projects/{project_number}/sources/{source_id}/findings/{finding_id}/securityMarks\"", "type": "string" }, "marks": { "additionalProperties": { "type": "string" }, -"description": "Mutable user specified security marks belonging to the parent resource. Constraints are as follows: * Keys and values are treated as case insensitive * Keys must be between 1 - 256 characters (inclusive) * Keys must be letters, numbers, underscores, or dashes * Values have leading and trailing whitespace trimmed, remaining characters must be between 1 - 4096 characters (inclusive)", "type": "object" }, "name": { -"description": "The relative resource name of the SecurityMarks. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Examples: \"organizations/{organization_id}/assets/{asset_id}/securityMarks\" \"organizations/{organization_id}/sources/{source_id}/findings/{finding_id}/securityMarks\".", "type": "string" } }, "type": "object" }, "SecurityPolicy": { -"description": "Information about the [Google Cloud Armor security policy](https://cloud.google.com/armor/docs/security-policy-overview) relevant to the finding.", "id": "SecurityPolicy", "properties": { "name": { -"description": "The name of the Google Cloud Armor security policy, for example, \"my-security-policy\".", "type": "string" }, "preview": { -"description": "Whether or not the associated rule or policy is in preview mode.", "type": "boolean" }, "type": { -"description": "The type of Google Cloud Armor security policy for example, 'backend security policy', 'edge security policy', 'network edge security policy', or 'always-on DDoS protection'.", "type": "string" } }, "type": "object" }, "SecurityPosture": { -"description": "Represents a posture that is deployed on Google Cloud by the Security Command Center Posture Management service. A posture contains one or more policy sets. A policy set is a group of policies that enforce a set of security rules on Google Cloud.", "id": "SecurityPosture", "properties": { "changedPolicy": { -"description": "The name of the updated policy, for example, `projects/{project_id}/policies/{constraint_name}`.", "type": "string" }, "name": { -"description": "Name of the posture, for example, `CIS-Posture`.", "type": "string" }, "policy": { -"description": "The ID of the updated policy, for example, `compute-policy-1`.", "type": "string" }, "policyDriftDetails": { -"description": "The details about a change in an updated policy that violates the deployed posture.", "items": { "$ref": "PolicyDriftDetails" }, "type": "array" }, "policySet": { -"description": "The name of the updated policyset, for example, `cis-policyset`.", "type": "string" }, "postureDeployment": { -"description": "The name of the posture deployment, for example, `organizations/{org_id}/posturedeployments/{posture_deployment_id}`.", "type": "string" }, "postureDeploymentResource": { -"description": "The project, folder, or organization on which the posture is deployed, for example, `projects/{project_number}`.", "type": "string" }, "revisionId": { -"description": "The version of the posture, for example, `c7cfa2a8`.", "type": "string" } }, "type": "object" }, "SensitivityScore": { -"description": "Score is calculated from of all elements in the data profile. A higher level means the data is more sensitive.", "id": "SensitivityScore", "properties": { "score": { -"description": "The sensitivity score applied to the resource.", "enum": [ "SENSITIVITY_SCORE_LEVEL_UNSPECIFIED", "SENSITIVITY_LOW", @@ -17600,11 +15531,11 @@ false "SENSITIVITY_HIGH" ], "enumDescriptions": [ -"Unused.", -"No sensitive information detected. The resource isn't publicly accessible.", -"Unable to determine sensitivity.", -"Medium risk. Contains personally identifiable information (PII), potentially sensitive data, or fields with free-text data that are at a higher risk of having intermittent sensitive data. Consider limiting access.", -"High risk. Sensitive personally identifiable information (SPII) can be present. Exfiltration of data can lead to user data loss. Re-identification of users might be possible. Consider limiting usage and or removing SPII." +"", +"", +"", +"", +"" ], "type": "string" } @@ -17612,41 +15543,35 @@ false "type": "object" }, "ServiceAccountDelegationInfo": { -"description": "Identity delegation history of an authenticated service account.", "id": "ServiceAccountDelegationInfo", "properties": { "principalEmail": { -"description": "The email address of a Google account.", "type": "string" }, "principalSubject": { -"description": "A string representing the principal_subject associated with the identity. As compared to `principal_email`, supports principals that aren't associated with email addresses, such as third party principals. For most identities, the format will be `principal://iam.googleapis.com/{identity pool name}/subjects/{subject}` except for some GKE identities (GKE_WORKLOAD, FREEFORM, GKE_HUB_WORKLOAD) that are still in the legacy format `serviceAccount:{identity pool name}[{subject}]`", "type": "string" } }, "type": "object" }, "SetFindingStateRequest": { -"description": "Request message for updating a finding's state.", "id": "SetFindingStateRequest", "properties": { "startTime": { "deprecated": true, -"description": "Optional. The time at which the updated state takes effect. If unset, defaults to the request time.", "format": "google-datetime", "type": "string" }, "state": { -"description": "Required. The desired State of the finding.", "enum": [ "STATE_UNSPECIFIED", "ACTIVE", "INACTIVE" ], "enumDescriptions": [ -"Unspecified state.", -"The finding requires attention and has not been addressed yet.", -"The finding has been fixed, triaged as a non-issue or otherwise addressed and is no longer active." +"", +"", +"" ], "type": "string" } @@ -17654,15 +15579,12 @@ false "type": "object" }, "SetIamPolicyRequest": { -"description": "Request message for `SetIamPolicy` method.", "id": "SetIamPolicyRequest", "properties": { "policy": { -"$ref": "Policy", -"description": "REQUIRED: The complete policy to be applied to the `resource`. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Google Cloud services (such as Projects) might reject them." +"$ref": "Policy" }, "updateMask": { -"description": "OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only the fields in the mask will be modified. If no mask is provided, the following default mask is used: `paths: \"bindings, etag\"`", "format": "google-fieldmask", "type": "string" } @@ -17670,11 +15592,9 @@ false "type": "object" }, "SetMuteRequest": { -"description": "Request message for updating a finding's mute status.", "id": "SetMuteRequest", "properties": { "mute": { -"description": "Required. The desired state of the Mute.", "enum": [ "MUTE_UNSPECIFIED", "MUTED", @@ -17682,10 +15602,10 @@ false "UNDEFINED" ], "enumDescriptions": [ -"Unspecified.", -"Finding has been muted.", -"Finding has been unmuted.", -"Finding has never been muted/unmuted." +"", +"", +"", +"" ], "type": "string" } @@ -17693,79 +15613,64 @@ false "type": "object" }, "SimulateSecurityHealthAnalyticsCustomModuleRequest": { -"description": "Request message to simulate a CustomConfig against a given test resource. Maximum size of the request is 4 MB by default.", "id": "SimulateSecurityHealthAnalyticsCustomModuleRequest", "properties": { "customConfig": { -"$ref": "GoogleCloudSecuritycenterV1CustomConfig", -"description": "Required. The custom configuration that you need to test." +"$ref": "GoogleCloudSecuritycenterV1CustomConfig" }, "resource": { -"$ref": "SimulatedResource", -"description": "Required. Resource data to simulate custom module against." +"$ref": "SimulatedResource" } }, "type": "object" }, "SimulateSecurityHealthAnalyticsCustomModuleResponse": { -"description": "Response message for simulating a `SecurityHealthAnalyticsCustomModule` against a given resource.", "id": "SimulateSecurityHealthAnalyticsCustomModuleResponse", "properties": { "result": { -"$ref": "SimulatedResult", -"description": "Result for test case in the corresponding request." +"$ref": "SimulatedResult" } }, "type": "object" }, "SimulatedResource": { -"description": "Manually constructed resource name. If the custom module evaluates against only the resource data, you can omit the `iam_policy_data` field. If it evaluates only the `iam_policy_data` field, you can omit the resource data.", "id": "SimulatedResource", "properties": { "iamPolicyData": { -"$ref": "Policy", -"description": "Optional. A representation of the IAM policy." +"$ref": "Policy" }, "resourceData": { "additionalProperties": { "description": "Properties of the object.", "type": "any" }, -"description": "Optional. A representation of the Google Cloud resource. Should match the Google Cloud resource JSON format.", "type": "object" }, "resourceType": { -"description": "Required. The type of the resource, for example, `compute.googleapis.com/Disk`.", "type": "string" } }, "type": "object" }, "SimulatedResult": { -"description": "Possible test result.", "id": "SimulatedResult", "properties": { "error": { -"$ref": "Status", -"description": "Error encountered during the test." +"$ref": "Status" }, "finding": { -"$ref": "Finding", -"description": "Finding that would be published for the test case, if a violation is detected." +"$ref": "Finding" }, "noViolation": { -"$ref": "Empty", -"description": "Indicates that the test case does not trigger any violation." +"$ref": "Empty" } }, "type": "object" }, "Simulation": { -"description": "Attack path simulation", "id": "Simulation", "properties": { "cloudProvider": { -"description": "Indicates which cloud provider was used in this simulation.", "enum": [ "CLOUD_PROVIDER_UNSPECIFIED", "GOOGLE_CLOUD_PLATFORM", @@ -17773,25 +15678,22 @@ false "MICROSOFT_AZURE" ], "enumDescriptions": [ -"The cloud provider is unspecified.", -"The cloud provider is Google Cloud.", -"The cloud provider is Amazon Web Services.", -"The cloud provider is Microsoft Azure." +"", +"", +"", +"" ], "type": "string" }, "createTime": { -"description": "Output only. Time simulation was created", "format": "google-datetime", "readOnly": true, "type": "string" }, "name": { -"description": "Full resource name of the Simulation: `organizations/123/simulations/456`", "type": "string" }, "resourceValueConfigsMetadata": { -"description": "Resource value configurations' metadata used in this simulation. Maximum of 100.", "items": { "$ref": "ResourceValueConfigMetadata" }, @@ -17801,39 +15703,31 @@ false "type": "object" }, "Source": { -"description": "Security Command Center finding source. A finding source is an entity or a mechanism that can produce a finding. A source is like a container of findings that come from the same scanner, logger, monitor, and other tools.", "id": "Source", "properties": { "canonicalName": { -"description": "The canonical name of the finding source. It's either \"organizations/{organization_id}/sources/{source_id}\", \"folders/{folder_id}/sources/{source_id}\", or \"projects/{project_number}/sources/{source_id}\", depending on the closest CRM ancestor of the resource associated with the finding.", "type": "string" }, "description": { -"description": "The description of the source (max of 1024 characters). Example: \"Web Security Scanner is a web security scanner for common vulnerabilities in App Engine applications. It can automatically scan and detect four common vulnerabilities, including cross-site-scripting (XSS), Flash injection, mixed content (HTTP in HTTPS), and outdated or insecure libraries.\"", "type": "string" }, "displayName": { -"description": "The source's display name. A source's display name must be unique amongst its siblings, for example, two sources with the same parent can't share the same display name. The display name must have a length between 1 and 64 characters (inclusive).", "type": "string" }, "name": { -"description": "The relative resource name of this source. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Example: \"organizations/{organization_id}/sources/{source_id}\"", "type": "string" } }, "type": "object" }, "StaticMute": { -"description": "Information about the static mute state. A static mute state overrides any dynamic mute rules that apply to this finding. The static mute state can be set by a static mute rule or by muting the finding directly.", "id": "StaticMute", "properties": { "applyTime": { -"description": "When the static mute was applied.", "format": "google-datetime", "type": "string" }, "state": { -"description": "The static mute state. If the value is `MUTED` or `UNMUTED`, then the finding's overall mute state will have the same value.", "enum": [ "MUTE_UNSPECIFIED", "MUTED", @@ -17841,10 +15735,10 @@ false "UNDEFINED" ], "enumDescriptions": [ -"Unspecified.", -"Finding has been muted.", -"Finding has been unmuted.", -"Finding has never been muted/unmuted." +"", +"", +"", +"" ], "type": "string" } @@ -17852,16 +15746,13 @@ false "type": "object" }, "Status": { -"description": "The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).", "id": "Status", "properties": { "code": { -"description": "The status code, which should be an enum value of google.rpc.Code.", "format": "int32", "type": "integer" }, "details": { -"description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.", "items": { "additionalProperties": { "description": "Properties of the object. Contains field @type with type URL.", @@ -17872,29 +15763,24 @@ false "type": "array" }, "message": { -"description": "A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.", "type": "string" } }, "type": "object" }, "StreamingConfig": { -"description": "The config for streaming-based notifications, which send each event as soon as it is detected.", "id": "StreamingConfig", "properties": { "filter": { -"description": "Expression that defines the filter to apply across create/update events of assets or findings as specified by the event type. The expression is a list of zero or more restrictions combined via logical operators `AND` and `OR`. Parentheses are supported, and `OR` has higher precedence than `AND`. Restrictions have the form ` ` and may have a `-` character in front of them to indicate negation. The fields map to those defined in the corresponding resource. The supported operators are: * `=` for all value types. * `>`, `<`, `>=`, `<=` for integer values. * `:`, meaning substring matching, for strings. The supported value types are: * string literals in quotes. * integer literals without quotes. * boolean literals `true` and `false` without quotes.", "type": "string" } }, "type": "object" }, "Subject": { -"description": "Represents a Kubernetes subject.", "id": "Subject", "properties": { "kind": { -"description": "Authentication type for the subject.", "enum": [ "AUTH_TYPE_UNSPECIFIED", "USER", @@ -17902,30 +15788,26 @@ false "GROUP" ], "enumDescriptions": [ -"Authentication is not specified.", -"User with valid certificate.", -"Users managed by Kubernetes API with credentials stored as secrets.", -"Collection of users." +"", +"", +"", +"" ], "type": "string" }, "name": { -"description": "Name for the subject.", "type": "string" }, "ns": { -"description": "Namespace for the subject.", "type": "string" } }, "type": "object" }, "TestIamPermissionsRequest": { -"description": "Request message for `TestIamPermissions` method.", "id": "TestIamPermissionsRequest", "properties": { "permissions": { -"description": "The set of permissions to check for the `resource`. Permissions with wildcards (such as `*` or `storage.*`) are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).", "items": { "type": "string" }, @@ -17935,11 +15817,9 @@ false "type": "object" }, "TestIamPermissionsResponse": { -"description": "Response message for `TestIamPermissions` method.", "id": "TestIamPermissionsResponse", "properties": { "permissions": { -"description": "A subset of `TestPermissionsRequest.permissions` that the caller is allowed.", "items": { "type": "string" }, @@ -17949,48 +15829,38 @@ false "type": "object" }, "TicketInfo": { -"description": "Information about the ticket, if any, that is being used to track the resolution of the issue that is identified by this finding.", "id": "TicketInfo", "properties": { "assignee": { -"description": "The assignee of the ticket in the ticket system.", "type": "string" }, "description": { -"description": "The description of the ticket in the ticket system.", "type": "string" }, "id": { -"description": "The identifier of the ticket in the ticket system.", "type": "string" }, "status": { -"description": "The latest status of the ticket, as reported by the ticket system.", "type": "string" }, "updateTime": { -"description": "The time when the ticket was last updated, as reported by the ticket system.", "format": "google-datetime", "type": "string" }, "uri": { -"description": "The link to the ticket in the ticket system.", "type": "string" } }, "type": "object" }, "ToxicCombination": { -"description": "Contains details about a group of security issues that, when the issues occur together, represent a greater risk than when the issues occur independently. A group of such issues is referred to as a toxic combination.", "id": "ToxicCombination", "properties": { "attackExposureScore": { -"description": "The [Attack exposure score](https://cloud.google.com/security-command-center/docs/attack-exposure-learn#attack_exposure_scores) of this toxic combination. The score is a measure of how much this toxic combination exposes one or more high-value resources to potential attack.", "format": "double", "type": "number" }, "relatedFindings": { -"description": "List of resource names of findings associated with this toxic combination. For example, `organizations/123/sources/456/findings/789`.", "items": { "type": "string" }, @@ -18000,58 +15870,46 @@ false "type": "object" }, "ValidateEventThreatDetectionCustomModuleRequest": { -"description": "Request to validate an Event Threat Detection custom module.", "id": "ValidateEventThreatDetectionCustomModuleRequest", "properties": { "rawText": { -"description": "Required. The raw text of the module's contents. Used to generate error messages.", "type": "string" }, "type": { -"description": "Required. The type of the module (e.g. CONFIGURABLE_BAD_IP).", "type": "string" } }, "type": "object" }, "ValidateEventThreatDetectionCustomModuleResponse": { -"description": "Response to validating an Event Threat Detection custom module.", "id": "ValidateEventThreatDetectionCustomModuleResponse", "properties": { "errors": { -"$ref": "CustomModuleValidationErrors", -"description": "A list of errors returned by the validator. If the list is empty, there were no errors." +"$ref": "CustomModuleValidationErrors" } }, "type": "object" }, "ValuedResource": { -"description": "A resource that is determined to have value to a user's system", "id": "ValuedResource", "properties": { "displayName": { -"description": "Human-readable name of the valued resource.", "type": "string" }, "exposedScore": { -"description": "Exposed score for this valued resource. A value of 0 means no exposure was detected exposure.", "format": "double", "type": "number" }, "name": { -"description": "Valued resource name, for example, e.g.: `organizations/123/simulations/456/valuedResources/789`", "type": "string" }, "resource": { -"description": "The [full resource name](https://cloud.google.com/apis/design/resource_names#full_resource_name) of the valued resource.", "type": "string" }, "resourceType": { -"description": "The [resource type](https://cloud.google.com/asset-inventory/docs/supported-asset-types) of the valued resource.", "type": "string" }, "resourceValue": { -"description": "How valuable this resource is.", "enum": [ "RESOURCE_VALUE_UNSPECIFIED", "RESOURCE_VALUE_LOW", @@ -18059,15 +15917,14 @@ false "RESOURCE_VALUE_HIGH" ], "enumDescriptions": [ -"The resource value isn't specified.", -"This is a low-value resource.", -"This is a medium-value resource.", -"This is a high-value resource." +"", +"", +"", +"" ], "type": "string" }, "resourceValueConfigsUsed": { -"description": "List of resource value configurations' metadata used to determine the value of this resource. Maximum of 100.", "items": { "$ref": "ResourceValueConfigMetadata" }, @@ -18077,18 +15934,15 @@ false "type": "object" }, "VertexAi": { -"description": "Vertex AI-related information associated with the finding.", "id": "VertexAi", "properties": { "datasets": { -"description": "Datasets associated with the finding.", "items": { "$ref": "Dataset" }, "type": "array" }, "pipelines": { -"description": "Pipelines associated with the finding.", "items": { "$ref": "Pipeline" }, @@ -18098,46 +15952,37 @@ false "type": "object" }, "Vulnerability": { -"description": "Refers to common vulnerability fields e.g. cve, cvss, cwe etc.", "id": "Vulnerability", "properties": { "cve": { -"$ref": "Cve", -"description": "CVE stands for Common Vulnerabilities and Exposures (https://cve.mitre.org/about/)" +"$ref": "Cve" }, "cwes": { -"description": "Represents one or more Common Weakness Enumeration (CWE) information on this vulnerability.", "items": { "$ref": "Cwe" }, "type": "array" }, "fixedPackage": { -"$ref": "Package", -"description": "The fixed package is relevant to the finding." +"$ref": "Package" }, "offendingPackage": { -"$ref": "Package", -"description": "The offending package is relevant to the finding." +"$ref": "Package" }, "providerRiskScore": { -"description": "Provider provided risk_score based on multiple factors. The higher the risk score, the more risky the vulnerability is.", "format": "int64", "type": "string" }, "reachable": { -"description": "Represents whether the vulnerability is reachable (detected via static analysis)", "type": "boolean" }, "securityBulletin": { -"$ref": "SecurityBulletin", -"description": "The security bulletin is relevant to this finding." +"$ref": "SecurityBulletin" } }, "type": "object" }, "VulnerabilityCountBySeverity": { -"description": "Vulnerability count by severity.", "id": "VulnerabilityCountBySeverity", "properties": { "severityToFindingCount": { @@ -18145,18 +15990,15 @@ false "format": "int64", "type": "string" }, -"description": "Key is the Severity enum.", "type": "object" } }, "type": "object" }, "VulnerabilitySnapshot": { -"description": "Result containing the properties and count of a VulnerabilitySnapshot request.", "id": "VulnerabilitySnapshot", "properties": { "cloudProvider": { -"description": "The cloud provider for the vulnerability snapshot.", "enum": [ "CLOUD_PROVIDER_UNSPECIFIED", "GOOGLE_CLOUD_PLATFORM", @@ -18164,23 +16006,20 @@ false "MICROSOFT_AZURE" ], "enumDescriptions": [ -"The cloud provider is unspecified.", -"The cloud provider is Google Cloud.", -"The cloud provider is Amazon Web Services.", -"The cloud provider is Microsoft Azure." +"", +"", +"", +"" ], "type": "string" }, "findingCount": { -"$ref": "VulnerabilityCountBySeverity", -"description": "The vulnerability count by severity." +"$ref": "VulnerabilityCountBySeverity" }, "name": { -"description": "Identifier. The vulnerability snapshot name. Format: //locations//vulnerabilitySnapshots/", "type": "string" }, "snapshotTime": { -"description": "The time that the snapshot was taken.", "format": "google-datetime", "type": "string" } @@ -18188,11 +16027,9 @@ false "type": "object" }, "YaraRuleSignature": { -"description": "A signature corresponding to a YARA rule.", "id": "YaraRuleSignature", "properties": { "yaraRule": { -"description": "The name of the YARA rule.", "type": "string" } }, diff --git a/googleapiclient/discovery_cache/documents/securitycenter.v1beta1.json b/googleapiclient/discovery_cache/documents/securitycenter.v1beta1.json index 6d51918488..4407405f07 100644 --- a/googleapiclient/discovery_cache/documents/securitycenter.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/securitycenter.v1beta1.json @@ -125,7 +125,7 @@ "organizations": { "methods": { "getOrganizationSettings": { -"description": "Gets the settings for an organization.", +"description": "", "flatPath": "v1beta1/organizations/{organizationsId}/organizationSettings", "httpMethod": "GET", "id": "securitycenter.organizations.getOrganizationSettings", @@ -134,7 +134,6 @@ ], "parameters": { "name": { -"description": "Required. Name of the organization to get organization settings for. Its format is \"organizations/[organization_id]/organizationSettings\".", "location": "path", "pattern": "^organizations/[^/]+/organizationSettings$", "required": true, @@ -151,7 +150,7 @@ }, "updateOrganizationSettings": { "deprecated": true, -"description": "Updates an organization's settings.", +"description": "", "flatPath": "v1beta1/organizations/{organizationsId}/organizationSettings", "httpMethod": "PATCH", "id": "securitycenter.organizations.updateOrganizationSettings", @@ -160,14 +159,12 @@ ], "parameters": { "name": { -"description": "The relative resource name of the settings. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Example: \"organizations/{organization_id}/organizationSettings\".", "location": "path", "pattern": "^organizations/[^/]+/organizationSettings$", "required": true, "type": "string" }, "updateMask": { -"description": "The FieldMask to use when updating the settings resource.", "format": "google-fieldmask", "location": "query", "type": "string" @@ -189,7 +186,7 @@ "assets": { "methods": { "group": { -"description": "Filters an organization's assets and groups them by their specified properties.", +"description": "", "flatPath": "v1beta1/organizations/{organizationsId}/assets:group", "httpMethod": "POST", "id": "securitycenter.organizations.assets.group", @@ -198,7 +195,6 @@ ], "parameters": { "parent": { -"description": "Required. Name of the organization to groupBy. Its format is \"organizations/[organization_id]\".", "location": "path", "pattern": "^organizations/[^/]+$", "required": true, @@ -217,7 +213,7 @@ ] }, "list": { -"description": "Lists an organization's assets.", +"description": "", "flatPath": "v1beta1/organizations/{organizationsId}/assets", "httpMethod": "GET", "id": "securitycenter.organizations.assets.list", @@ -226,47 +222,39 @@ ], "parameters": { "compareDuration": { -"description": "When compare_duration is set, the ListAssetResult's \"state\" attribute is updated to indicate whether the asset was added, removed, or remained present during the compare_duration period of time that precedes the read_time. This is the time between (read_time - compare_duration) and read_time. The state value is derived based on the presence of the asset at the two points in time. Intermediate state changes between the two times don't affect the result. For example, the results aren't affected if the asset is removed and re-created again. Possible \"state\" values when compare_duration is specified: * \"ADDED\": indicates that the asset was not present before compare_duration, but present at read_time. * \"REMOVED\": indicates that the asset was present at the start of compare_duration, but not present at read_time. * \"ACTIVE\": indicates that the asset was present at both the start and the end of the time period defined by compare_duration and read_time. If compare_duration is not specified, then the only possible state is \"UNUSED\", which indicates that the asset is present at read_time.", "format": "google-duration", "location": "query", "type": "string" }, "fieldMask": { -"description": "Optional. A field mask to specify the ListAssetsResult fields to be listed in the response. An empty field mask will list all fields.", "format": "google-fieldmask", "location": "query", "type": "string" }, "filter": { -"description": "Expression that defines the filter to apply across assets. The expression is a list of zero or more restrictions combined via logical operators `AND` and `OR`. Parentheses are not supported, and `OR` has higher precedence than `AND`. Restrictions have the form ` ` and may have a `-` character in front of them to indicate negation. The fields map to those defined in the Asset resource. Examples include: * name * security_center_properties.resource_name * resource_properties.a_property * security_marks.marks.marka The supported operators are: * `=` for all value types. * `>`, `<`, `>=`, `<=` for integer values. * `:`, meaning substring matching, for strings. The supported value types are: * string literals in quotes. * integer literals without quotes. * boolean literals `true` and `false` without quotes. For example, `resource_properties.size = 100` is a valid filter string.", "location": "query", "type": "string" }, "orderBy": { -"description": "Expression that defines what fields and order to use for sorting. The string value should follow SQL syntax: comma separated list of fields. For example: \"name,resource_properties.a_property\". The default sorting order is ascending. To specify descending order for a field, a suffix \" desc\" should be appended to the field name. For example: \"name desc,resource_properties.a_property\". Redundant space characters in the syntax are insignificant. \"name desc,resource_properties.a_property\" and \" name desc , resource_properties.a_property \" are equivalent.", "location": "query", "type": "string" }, "pageSize": { -"description": "The maximum number of results to return in a single response. Default is 10, minimum is 1, maximum is 1000.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { -"description": "The value returned by the last `ListAssetsResponse`; indicates that this is a continuation of a prior `ListAssets` call, and that the system should return the next page of data.", "location": "query", "type": "string" }, "parent": { -"description": "Required. Name of the organization assets should belong to. Its format is \"organizations/[organization_id]\".", "location": "path", "pattern": "^organizations/[^/]+$", "required": true, "type": "string" }, "readTime": { -"description": "Time used as a reference point when filtering assets. The filter is limited to assets existing at the supplied time and their values are those at that specific time. Absence of this field will default to the API's version of NOW.", "format": "google-datetime", "location": "query", "type": "string" @@ -281,7 +269,7 @@ ] }, "runDiscovery": { -"description": "Runs asset discovery. The discovery is tracked with a long-running operation. This API can only be called with limited frequency for an organization. If it is called too frequently the caller will receive a TOO_MANY_REQUESTS error.", +"description": "", "flatPath": "v1beta1/organizations/{organizationsId}/assets:runDiscovery", "httpMethod": "POST", "id": "securitycenter.organizations.assets.runDiscovery", @@ -290,7 +278,6 @@ ], "parameters": { "parent": { -"description": "Required. Name of the organization to run asset discovery for. Its format is \"organizations/[organization_id]\".", "location": "path", "pattern": "^organizations/[^/]+$", "required": true, @@ -309,7 +296,7 @@ ] }, "updateSecurityMarks": { -"description": "Updates security marks.", +"description": "", "flatPath": "v1beta1/organizations/{organizationsId}/assets/{assetsId}/securityMarks", "httpMethod": "PATCH", "id": "securitycenter.organizations.assets.updateSecurityMarks", @@ -318,20 +305,17 @@ ], "parameters": { "name": { -"description": "The relative resource name of the SecurityMarks. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Examples: \"organizations/{organization_id}/assets/{asset_id}/securityMarks\" \"organizations/{organization_id}/sources/{source_id}/findings/{finding_id}/securityMarks\".", "location": "path", "pattern": "^organizations/[^/]+/assets/[^/]+/securityMarks$", "required": true, "type": "string" }, "startTime": { -"description": "The time at which the updated SecurityMarks take effect.", "format": "google-datetime", "location": "query", "type": "string" }, "updateMask": { -"description": "The FieldMask to use when updating the security marks resource.", "format": "google-fieldmask", "location": "query", "type": "string" @@ -353,7 +337,7 @@ "operations": { "methods": { "cancel": { -"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", +"description": "", "flatPath": "v1beta1/organizations/{organizationsId}/operations/{operationsId}:cancel", "httpMethod": "POST", "id": "securitycenter.organizations.operations.cancel", @@ -362,7 +346,6 @@ ], "parameters": { "name": { -"description": "The name of the operation resource to be cancelled.", "location": "path", "pattern": "^organizations/[^/]+/operations/[^/]+$", "required": true, @@ -381,7 +364,7 @@ ] }, "delete": { -"description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", +"description": "", "flatPath": "v1beta1/organizations/{organizationsId}/operations/{operationsId}", "httpMethod": "DELETE", "id": "securitycenter.organizations.operations.delete", @@ -390,7 +373,6 @@ ], "parameters": { "name": { -"description": "The name of the operation resource to be deleted.", "location": "path", "pattern": "^organizations/[^/]+/operations/[^/]+$", "required": true, @@ -406,7 +388,7 @@ ] }, "get": { -"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", +"description": "", "flatPath": "v1beta1/organizations/{organizationsId}/operations/{operationsId}", "httpMethod": "GET", "id": "securitycenter.organizations.operations.get", @@ -415,7 +397,6 @@ ], "parameters": { "name": { -"description": "The name of the operation resource.", "location": "path", "pattern": "^organizations/[^/]+/operations/[^/]+$", "required": true, @@ -431,7 +412,7 @@ ] }, "list": { -"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", +"description": "", "flatPath": "v1beta1/organizations/{organizationsId}/operations", "httpMethod": "GET", "id": "securitycenter.organizations.operations.list", @@ -440,30 +421,25 @@ ], "parameters": { "filter": { -"description": "The standard list filter.", "location": "query", "type": "string" }, "name": { -"description": "The name of the operation's parent resource.", "location": "path", "pattern": "^organizations/[^/]+/operations$", "required": true, "type": "string" }, "pageSize": { -"description": "The standard list page size.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { -"description": "The standard list page token.", "location": "query", "type": "string" }, "returnPartialSuccess": { -"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "location": "query", "type": "boolean" } @@ -481,7 +457,7 @@ "sources": { "methods": { "create": { -"description": "Creates a source.", +"description": "", "flatPath": "v1beta1/organizations/{organizationsId}/sources", "httpMethod": "POST", "id": "securitycenter.organizations.sources.create", @@ -490,7 +466,6 @@ ], "parameters": { "parent": { -"description": "Required. Resource name of the new source's parent. Its format should be \"organizations/[organization_id]\".", "location": "path", "pattern": "^organizations/[^/]+$", "required": true, @@ -509,7 +484,7 @@ ] }, "get": { -"description": "Gets a source.", +"description": "", "flatPath": "v1beta1/organizations/{organizationsId}/sources/{sourcesId}", "httpMethod": "GET", "id": "securitycenter.organizations.sources.get", @@ -518,7 +493,6 @@ ], "parameters": { "name": { -"description": "Required. Relative resource name of the source. Its format is \"organizations/[organization_id]/source/[source_id]\".", "location": "path", "pattern": "^organizations/[^/]+/sources/[^/]+$", "required": true, @@ -534,7 +508,7 @@ ] }, "getIamPolicy": { -"description": "Gets the access control policy on the specified Source.", +"description": "", "flatPath": "v1beta1/organizations/{organizationsId}/sources/{sourcesId}:getIamPolicy", "httpMethod": "POST", "id": "securitycenter.organizations.sources.getIamPolicy", @@ -543,7 +517,6 @@ ], "parameters": { "resource": { -"description": "REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", "location": "path", "pattern": "^organizations/[^/]+/sources/[^/]+$", "required": true, @@ -562,7 +535,7 @@ ] }, "list": { -"description": "Lists all sources belonging to an organization.", +"description": "", "flatPath": "v1beta1/organizations/{organizationsId}/sources", "httpMethod": "GET", "id": "securitycenter.organizations.sources.list", @@ -571,18 +544,15 @@ ], "parameters": { "pageSize": { -"description": "The maximum number of results to return in a single response. Default is 10, minimum is 1, maximum is 1000.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { -"description": "The value returned by the last `ListSourcesResponse`; indicates that this is a continuation of a prior `ListSources` call, and that the system should return the next page of data.", "location": "query", "type": "string" }, "parent": { -"description": "Required. Resource name of the parent of sources to list. Its format should be \"organizations/[organization_id]\".", "location": "path", "pattern": "^organizations/[^/]+$", "required": true, @@ -598,7 +568,7 @@ ] }, "patch": { -"description": "Updates a source.", +"description": "", "flatPath": "v1beta1/organizations/{organizationsId}/sources/{sourcesId}", "httpMethod": "PATCH", "id": "securitycenter.organizations.sources.patch", @@ -607,14 +577,12 @@ ], "parameters": { "name": { -"description": "The relative resource name of this source. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Example: \"organizations/{organization_id}/sources/{source_id}\"", "location": "path", "pattern": "^organizations/[^/]+/sources/[^/]+$", "required": true, "type": "string" }, "updateMask": { -"description": "The FieldMask to use when updating the source resource.", "format": "google-fieldmask", "location": "query", "type": "string" @@ -632,7 +600,7 @@ ] }, "setIamPolicy": { -"description": "Sets the access control policy on the specified Source.", +"description": "", "flatPath": "v1beta1/organizations/{organizationsId}/sources/{sourcesId}:setIamPolicy", "httpMethod": "POST", "id": "securitycenter.organizations.sources.setIamPolicy", @@ -641,7 +609,6 @@ ], "parameters": { "resource": { -"description": "REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", "location": "path", "pattern": "^organizations/[^/]+/sources/[^/]+$", "required": true, @@ -660,7 +627,7 @@ ] }, "testIamPermissions": { -"description": " Returns the permissions that a caller has on the specified source.", +"description": "", "flatPath": "v1beta1/organizations/{organizationsId}/sources/{sourcesId}:testIamPermissions", "httpMethod": "POST", "id": "securitycenter.organizations.sources.testIamPermissions", @@ -669,7 +636,6 @@ ], "parameters": { "resource": { -"description": "REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", "location": "path", "pattern": "^organizations/[^/]+/sources/[^/]+$", "required": true, @@ -692,7 +658,7 @@ "findings": { "methods": { "create": { -"description": "Creates a finding. The corresponding source must exist for finding creation to succeed.", +"description": "", "flatPath": "v1beta1/organizations/{organizationsId}/sources/{sourcesId}/findings", "httpMethod": "POST", "id": "securitycenter.organizations.sources.findings.create", @@ -701,12 +667,10 @@ ], "parameters": { "findingId": { -"description": "Required. Unique identifier provided by the client within the parent scope. It must be alphanumeric and less than or equal to 32 characters and greater than 0 characters in length.", "location": "query", "type": "string" }, "parent": { -"description": "Required. Resource name of the new finding's parent. Its format should be \"organizations/[organization_id]/sources/[source_id]\".", "location": "path", "pattern": "^organizations/[^/]+/sources/[^/]+$", "required": true, @@ -725,7 +689,7 @@ ] }, "group": { -"description": "Filters an organization or source's findings and groups them by their specified properties. To group across all sources provide a `-` as the source id. Example: /v1beta1/organizations/{organization_id}/sources/-/findings", +"description": "", "flatPath": "v1beta1/organizations/{organizationsId}/sources/{sourcesId}/findings:group", "httpMethod": "POST", "id": "securitycenter.organizations.sources.findings.group", @@ -734,7 +698,6 @@ ], "parameters": { "parent": { -"description": "Required. Name of the source to groupBy. Its format is \"organizations/[organization_id]/sources/[source_id]\". To groupBy across all sources provide a source_id of `-`. For example: organizations/{organization_id}/sources/-", "location": "path", "pattern": "^organizations/[^/]+/sources/[^/]+$", "required": true, @@ -753,7 +716,7 @@ ] }, "list": { -"description": "Lists an organization or source's findings. To list across all sources provide a `-` as the source id. Example: /v1beta1/organizations/{organization_id}/sources/-/findings", +"description": "", "flatPath": "v1beta1/organizations/{organizationsId}/sources/{sourcesId}/findings", "httpMethod": "GET", "id": "securitycenter.organizations.sources.findings.list", @@ -762,41 +725,34 @@ ], "parameters": { "fieldMask": { -"description": "Optional. A field mask to specify the Finding fields to be listed in the response. An empty field mask will list all fields.", "format": "google-fieldmask", "location": "query", "type": "string" }, "filter": { -"description": "Expression that defines the filter to apply across findings. The expression is a list of one or more restrictions combined via logical operators `AND` and `OR`. Parentheses are not supported, and `OR` has higher precedence than `AND`. Restrictions have the form ` ` and may have a `-` character in front of them to indicate negation. Examples include: * name * source_properties.a_property * security_marks.marks.marka The supported operators are: * `=` for all value types. * `>`, `<`, `>=`, `<=` for integer values. * `:`, meaning substring matching, for strings. The supported value types are: * string literals in quotes. * integer literals without quotes. * boolean literals `true` and `false` without quotes. For example, `source_properties.size = 100` is a valid filter string.", "location": "query", "type": "string" }, "orderBy": { -"description": "Expression that defines what fields and order to use for sorting. The string value should follow SQL syntax: comma separated list of fields. For example: \"name,resource_properties.a_property\". The default sorting order is ascending. To specify descending order for a field, a suffix \" desc\" should be appended to the field name. For example: \"name desc,source_properties.a_property\". Redundant space characters in the syntax are insignificant. \"name desc,source_properties.a_property\" and \" name desc , source_properties.a_property \" are equivalent.", "location": "query", "type": "string" }, "pageSize": { -"description": "The maximum number of results to return in a single response. Default is 10, minimum is 1, maximum is 1000.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { -"description": "The value returned by the last `ListFindingsResponse`; indicates that this is a continuation of a prior `ListFindings` call, and that the system should return the next page of data.", "location": "query", "type": "string" }, "parent": { -"description": "Required. Name of the source the findings belong to. Its format is \"organizations/[organization_id]/sources/[source_id]\". To list across all sources provide a source_id of `-`. For example: organizations/{organization_id}/sources/-", "location": "path", "pattern": "^organizations/[^/]+/sources/[^/]+$", "required": true, "type": "string" }, "readTime": { -"description": "Time used as a reference point when filtering findings. The filter is limited to findings existing at the supplied time and their values are those at that specific time. Absence of this field will default to the API's version of NOW.", "format": "google-datetime", "location": "query", "type": "string" @@ -811,7 +767,7 @@ ] }, "patch": { -"description": "Creates or updates a finding. The corresponding source must exist for a finding creation to succeed.", +"description": "", "flatPath": "v1beta1/organizations/{organizationsId}/sources/{sourcesId}/findings/{findingsId}", "httpMethod": "PATCH", "id": "securitycenter.organizations.sources.findings.patch", @@ -820,14 +776,12 @@ ], "parameters": { "name": { -"description": "The relative resource name of this finding. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Example: \"organizations/{organization_id}/sources/{source_id}/findings/{finding_id}\"", "location": "path", "pattern": "^organizations/[^/]+/sources/[^/]+/findings/[^/]+$", "required": true, "type": "string" }, "updateMask": { -"description": "The FieldMask to use when updating the finding resource. This field should not be specified when creating a finding.", "format": "google-fieldmask", "location": "query", "type": "string" @@ -845,7 +799,7 @@ ] }, "setState": { -"description": "Updates the state of a finding.", +"description": "", "flatPath": "v1beta1/organizations/{organizationsId}/sources/{sourcesId}/findings/{findingsId}:setState", "httpMethod": "POST", "id": "securitycenter.organizations.sources.findings.setState", @@ -854,7 +808,6 @@ ], "parameters": { "name": { -"description": "Required. The relative resource name of the finding. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Example: \"organizations/{organization_id}/sources/{source_id}/finding/{finding_id}\".", "location": "path", "pattern": "^organizations/[^/]+/sources/[^/]+/findings/[^/]+$", "required": true, @@ -873,7 +826,7 @@ ] }, "updateSecurityMarks": { -"description": "Updates security marks.", +"description": "", "flatPath": "v1beta1/organizations/{organizationsId}/sources/{sourcesId}/findings/{findingsId}/securityMarks", "httpMethod": "PATCH", "id": "securitycenter.organizations.sources.findings.updateSecurityMarks", @@ -882,20 +835,17 @@ ], "parameters": { "name": { -"description": "The relative resource name of the SecurityMarks. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Examples: \"organizations/{organization_id}/assets/{asset_id}/securityMarks\" \"organizations/{organization_id}/sources/{source_id}/findings/{finding_id}/securityMarks\".", "location": "path", "pattern": "^organizations/[^/]+/sources/[^/]+/findings/[^/]+/securityMarks$", "required": true, "type": "string" }, "startTime": { -"description": "The time at which the updated SecurityMarks take effect.", "format": "google-datetime", "location": "query", "type": "string" }, "updateMask": { -"description": "The FieldMask to use when updating the security marks resource.", "format": "google-fieldmask", "location": "query", "type": "string" @@ -919,104 +869,82 @@ } } }, -"revision": "20260424", +"revision": "20260526", "rootUrl": "https://securitycenter.googleapis.com/", "schemas": { "Access": { -"description": "Represents an access event.", "id": "Access", "properties": { "callerIp": { -"description": "Caller's IP address, such as \"1.1.1.1\".", "type": "string" }, "callerIpGeo": { -"$ref": "Geolocation", -"description": "The caller IP's geolocation, which identifies where the call came from." +"$ref": "Geolocation" }, "methodName": { -"description": "The method that the service account called, e.g. \"SetIamPolicy\".", "type": "string" }, "principalEmail": { -"description": "Associated email, such as \"foo@google.com\". The email address of the authenticated user or a service account acting on behalf of a 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" }, "principalSubject": { -"description": "A string that represents the principal_subject that is associated with the identity. Unlike `principal_email`, `principal_subject` supports principals that aren't associated with email addresses, such as third party principals. For most identities, the format is `principal://iam.googleapis.com/{identity pool name}/subject/{subject}`. Some GKE identities, such as GKE_WORKLOAD, FREEFORM, and GKE_HUB_WORKLOAD, still use the legacy format `serviceAccount:{identity pool name}[{subject}]`.", "type": "string" }, "serviceAccountDelegationInfo": { -"description": "The identity delegation history of an authenticated service account that made the request. The `serviceAccountDelegationInfo[]` object contains information about the real authorities that try to access Google Cloud resources by delegating on a service account. When multiple authorities are present, they are guaranteed to be sorted based on the original ordering of the identity delegation events.", "items": { "$ref": "ServiceAccountDelegationInfo" }, "type": "array" }, "serviceAccountKeyName": { -"description": "The name of the service account key that was used to create or exchange credentials when authenticating the service account that made the request. This is a scheme-less URI full resource name. For example: \"//iam.googleapis.com/projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}/keys/{key}\". ", "type": "string" }, "serviceName": { -"description": "This is the API service that the service account made a call to, e.g. \"iam.googleapis.com\"", "type": "string" }, "userAgent": { -"description": "The caller's user agent string associated with the finding.", "type": "string" }, "userAgentFamily": { -"description": "Type of user agent associated with the finding. For example, an operating system shell or an embedded or standalone application.", "type": "string" }, "userName": { -"description": "A string that represents a username. The username provided depends on the type of the finding and is likely not an IAM principal. For example, this can be a system username if the finding is related to a virtual machine, or it can be an application login username.", "type": "string" } }, "type": "object" }, "AccessReview": { -"description": "Conveys information about a Kubernetes access review (such as one returned by a [`kubectl auth can-i`](https://kubernetes.io/docs/reference/access-authn-authz/authorization/#checking-api-access) command) that was involved in a finding.", "id": "AccessReview", "properties": { "group": { -"description": "The API group of the resource. \"*\" means all.", "type": "string" }, "name": { -"description": "The name of the resource being requested. Empty means all.", "type": "string" }, "ns": { -"description": "Namespace of the action being requested. Currently, there is no distinction between no namespace and all namespaces. Both are represented by \"\" (empty).", "type": "string" }, "resource": { -"description": "The optional resource type requested. \"*\" means all.", "type": "string" }, "subresource": { -"description": "The optional subresource type.", "type": "string" }, "verb": { -"description": "A Kubernetes resource API verb, like get, list, watch, create, update, delete, proxy. \"*\" means all.", "type": "string" }, "version": { -"description": "The API version of the resource. \"*\" means all.", "type": "string" } }, "type": "object" }, "AdaptiveProtection": { -"description": "Information about [Google Cloud Armor Adaptive Protection](https://cloud.google.com/armor/docs/cloud-armor-overview#google-cloud-armor-adaptive-protection).", "id": "AdaptiveProtection", "properties": { "confidence": { -"description": "A score of 0 means that there is low confidence that the detected event is an actual attack. A score of 1 means that there is high confidence that the detected event is an attack. See the [Adaptive Protection documentation](https://cloud.google.com/armor/docs/adaptive-protection-overview#configure-alert-tuning) for further explanation.", "format": "double", "type": "number" } @@ -1024,48 +952,39 @@ "type": "object" }, "AdcApplication": { -"description": "Represents an ADC application associated with the finding.", "id": "AdcApplication", "properties": { "attributes": { -"$ref": "GoogleCloudSecuritycenterV1ResourceApplicationAttributes", -"description": "Consumer provided attributes for the AppHub application." +"$ref": "GoogleCloudSecuritycenterV1ResourceApplicationAttributes" }, "name": { -"description": "The resource name of an ADC Application. Format: projects/{project}/locations/{location}/spaces/{space}/applications/{application}", "type": "string" } }, "type": "object" }, "AdcApplicationTemplateRevision": { -"description": "Represents an ADC template associated with the finding.", "id": "AdcApplicationTemplateRevision", "properties": { "name": { -"description": "The resource name of an ADC Application Template Revision. Format: projects/{project}/locations/{location}/spaces/{space}/applicationTemplates/{application_template}/revisions/{revision}", "type": "string" } }, "type": "object" }, "AdcSharedTemplateRevision": { -"description": "Represents an ADC shared template associated with the finding.", "id": "AdcSharedTemplateRevision", "properties": { "name": { -"description": "The resource name of an ADC Shared Template Revision. Format: projects/{project}/locations/{location}/spaces/{space}/applicationTemplates/{application_template}/revisions/{revision}", "type": "string" } }, "type": "object" }, "AffectedResources": { -"description": "Details about resources affected by this finding.", "id": "AffectedResources", "properties": { "count": { -"description": "The count of resources affected by the finding.", "format": "int64", "type": "string" } @@ -1073,20 +992,16 @@ "type": "object" }, "AgentDataAccessEvent": { -"description": "Details about a data access attempt made by an agent principal not authorized under applicable data security policy.", "id": "AgentDataAccessEvent", "properties": { "eventId": { -"description": "Unique identifier for data access event.", "type": "string" }, "eventTime": { -"description": "Timestamp of data access event.", "format": "google-datetime", "type": "string" }, "operation": { -"description": "The operation performed by the principal to access the data.", "enum": [ "OPERATION_UNSPECIFIED", "READ", @@ -1094,26 +1009,23 @@ "COPY" ], "enumDescriptions": [ -"The operation is unspecified.", -"Represents a read operation.", -"Represents a move operation.", -"Represents a copy operation." +"", +"", +"", +"" ], "type": "string" }, "principalSubject": { -"description": "The agent principal that accessed the data.", "type": "string" } }, "type": "object" }, "AiModel": { -"description": "Contains information about the AI model associated with the finding.", "id": "AiModel", "properties": { "deploymentPlatform": { -"description": "The platform on which the model is deployed.", "enum": [ "DEPLOYMENT_PLATFORM_UNSPECIFIED", "VERTEX_AI", @@ -1122,51 +1034,42 @@ "FINE_TUNED_MODEL" ], "enumDescriptions": [ -"Unspecified deployment platform.", -"Vertex AI.", -"Google Kubernetes Engine.", -"Google Compute Engine.", -"Fine tuned model." +"", +"", +"", +"", +"" ], "type": "string" }, "displayName": { -"description": "The user defined display name of model. Ex. baseline-classification-model", "type": "string" }, "domain": { -"description": "The domain of the model, for example, \u201cimage-classification\u201d.", "type": "string" }, "library": { -"description": "The name of the model library, for example, \u201ctransformers\u201d.", "type": "string" }, "location": { -"description": "The region in which the model is used, for example, \u201cus-central1\u201d.", "type": "string" }, "name": { -"description": "The name of the AI model, for example, \"gemini:1.0.0\".", "type": "string" }, "publisher": { -"description": "The publisher of the model, for example, \u201cgoogle\u201d or \u201cnvidia\u201d.", "type": "string" }, "usageCategory": { -"description": "The purpose of the model, for example, \"Inteference\" or \"Training\".", "type": "string" } }, "type": "object" }, "Allowed": { -"description": "Allowed IP rule.", "id": "Allowed", "properties": { "ipRules": { -"description": "Optional. Optional list of allowed IP rules.", "items": { "$ref": "IpRule" }, @@ -1176,59 +1079,49 @@ "type": "object" }, "Application": { -"description": "Represents an application associated with a finding.", "id": "Application", "properties": { "baseUri": { -"description": "The base URI that identifies the network location of the application in which the vulnerability was detected. For example, `http://example.com`.", "type": "string" }, "fullUri": { -"description": "The full URI with payload that can be used to reproduce the vulnerability. For example, `http://example.com?p=aMmYgI6H`.", "type": "string" } }, "type": "object" }, "ArtifactGuardPolicies": { -"description": "Represents the result of evaluating artifact guard policies.", "id": "ArtifactGuardPolicies", "properties": { "failingPolicies": { -"description": "A list of failing policies.", "items": { "$ref": "ArtifactGuardPolicy" }, "type": "array" }, "resourceId": { -"description": "The ID of the resource that has policies configured for it.", "type": "string" } }, "type": "object" }, "ArtifactGuardPolicy": { -"description": "Represents an artifact guard policy.", "id": "ArtifactGuardPolicy", "properties": { "failureReason": { -"description": "The reason for the policy failure, for example, \"severity=HIGH AND max_vuln_count=2\".", "type": "string" }, "policyId": { -"description": "The ID of the failing policy, for example, \"organizations/3392779/locations/global/policies/prod-policy\".", "type": "string" }, "type": { -"description": "The type of the policy evaluation.", "enum": [ "ARTIFACT_GUARD_POLICY_TYPE_UNSPECIFIED", "VULNERABILITY" ], "enumDescriptions": [ -"Default value. This value is unused.", -"Vulnerability type." +"", +"" ], "type": "string" } @@ -1236,35 +1129,28 @@ "type": "object" }, "Asset": { -"description": "Security Command Center representation of a Google Cloud resource. The Asset is a Security Command Center resource that captures information about a single Google Cloud resource. All modifications to an Asset are only within the context of Security Command Center and don't affect the referenced Google Cloud resource.", "id": "Asset", "properties": { "createTime": { -"description": "The time at which the asset was created in Security Command Center.", "format": "google-datetime", "type": "string" }, "name": { -"description": "The relative resource name of this asset. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Example: \"organizations/{organization_id}/assets/{asset_id}\".", "type": "string" }, "resourceProperties": { "additionalProperties": { "type": "any" }, -"description": "Resource managed properties. These properties are managed and defined by the Google Cloud resource and cannot be modified by the user.", "type": "object" }, "securityCenterProperties": { -"$ref": "SecurityCenterProperties", -"description": "Security Command Center managed properties. These properties are managed by Security Command Center and cannot be modified by the user." +"$ref": "SecurityCenterProperties" }, "securityMarks": { -"$ref": "GoogleCloudSecuritycenterV1beta1SecurityMarks", -"description": "User specified security marks. These marks are entirely managed by the user and come from the SecurityMarks resource that belongs to the asset." +"$ref": "GoogleCloudSecuritycenterV1beta1SecurityMarks" }, "updateTime": { -"description": "The time at which the asset was last updated, added, or deleted in Security Command Center.", "format": "google-datetime", "type": "string" } @@ -1272,25 +1158,22 @@ "type": "object" }, "AssetDiscoveryConfig": { -"description": "The configuration used for Asset Discovery runs.", "id": "AssetDiscoveryConfig", "properties": { "inclusionMode": { -"description": "The mode to use for filtering asset discovery.", "enum": [ "INCLUSION_MODE_UNSPECIFIED", "INCLUDE_ONLY", "EXCLUDE" ], "enumDescriptions": [ -"Unspecified. Setting the mode with this value will disable inclusion/exclusion filtering for Asset Discovery.", -"Asset Discovery will capture only the resources within the projects specified. All other resources will be ignored.", -"Asset Discovery will ignore all resources under the projects specified. All other resources will be retrieved." +"", +"", +"" ], "type": "string" }, "projectIds": { -"description": "The project ids to use for filtering asset discovery.", "items": { "type": "string" }, @@ -1300,32 +1183,26 @@ "type": "object" }, "Attack": { -"description": "Information about DDoS attack volume and classification.", "id": "Attack", "properties": { "classification": { -"description": "Type of attack, for example, 'SYN-flood', 'NTP-udp', or 'CHARGEN-udp'.", "type": "string" }, "volumeBps": { "deprecated": true, -"description": "Total BPS (bytes per second) volume of attack. Deprecated - refer to volume_bps_long instead.", "format": "int32", "type": "integer" }, "volumeBpsLong": { -"description": "Total BPS (bytes per second) volume of attack.", "format": "int64", "type": "string" }, "volumePps": { "deprecated": true, -"description": "Total PPS (packets per second) volume of attack. Deprecated - refer to volume_pps_long instead.", "format": "int32", "type": "integer" }, "volumePpsLong": { -"description": "Total PPS (packets per second) volume of attack.", "format": "int64", "type": "string" } @@ -1333,49 +1210,41 @@ "type": "object" }, "AttackExposure": { -"description": "An attack exposure contains the results of an attack path simulation run.", "id": "AttackExposure", "properties": { "attackExposureResult": { -"description": "The resource name of the attack path simulation result that contains the details regarding this attack exposure score. Example: `organizations/123/simulations/456/attackExposureResults/789`", "type": "string" }, "exposedHighValueResourcesCount": { -"description": "The number of high value resources that are exposed as a result of this finding.", "format": "int32", "type": "integer" }, "exposedLowValueResourcesCount": { -"description": "The number of high value resources that are exposed as a result of this finding.", "format": "int32", "type": "integer" }, "exposedMediumValueResourcesCount": { -"description": "The number of medium value resources that are exposed as a result of this finding.", "format": "int32", "type": "integer" }, "latestCalculationTime": { -"description": "The most recent time the attack exposure was updated on this finding.", "format": "google-datetime", "type": "string" }, "score": { -"description": "A number between 0 (inclusive) and infinity that represents how important this finding is to remediate. The higher the score, the more important it is to remediate.", "format": "double", "type": "number" }, "state": { -"description": "What state this AttackExposure is in. This captures whether or not an attack exposure has been calculated or not.", "enum": [ "STATE_UNSPECIFIED", "CALCULATED", "NOT_CALCULATED" ], "enumDescriptions": [ -"The state is not specified.", -"The attack exposure has been calculated.", -"The attack exposure has not been calculated." +"", +"", +"" ], "type": "string" } @@ -1383,36 +1252,30 @@ "type": "object" }, "AuditConfig": { -"description": "Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { \"audit_configs\": [ { \"service\": \"allServices\", \"audit_log_configs\": [ { \"log_type\": \"DATA_READ\", \"exempted_members\": [ \"user:jose@example.com\" ] }, { \"log_type\": \"DATA_WRITE\" }, { \"log_type\": \"ADMIN_READ\" } ] }, { \"service\": \"sampleservice.googleapis.com\", \"audit_log_configs\": [ { \"log_type\": \"DATA_READ\" }, { \"log_type\": \"DATA_WRITE\", \"exempted_members\": [ \"user:aliya@example.com\" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging.", "id": "AuditConfig", "properties": { "auditLogConfigs": { -"description": "The configuration for logging of each type of permission.", "items": { "$ref": "AuditLogConfig" }, "type": "array" }, "service": { -"description": "Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services.", "type": "string" } }, "type": "object" }, "AuditLogConfig": { -"description": "Provides the configuration for logging a type of permissions. Example: { \"audit_log_configs\": [ { \"log_type\": \"DATA_READ\", \"exempted_members\": [ \"user:jose@example.com\" ] }, { \"log_type\": \"DATA_WRITE\" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.", "id": "AuditLogConfig", "properties": { "exemptedMembers": { -"description": "Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.", "items": { "type": "string" }, "type": "array" }, "logType": { -"description": "The log type that this config enables.", "enum": [ "LOG_TYPE_UNSPECIFIED", "ADMIN_READ", @@ -1420,10 +1283,10 @@ "DATA_READ" ], "enumDescriptions": [ -"Default case. Should never be this.", -"Admin reads. Example: CloudIAM getIamPolicy", -"Data writes. Example: CloudSQL Users create", -"Data reads. Example: CloudSQL Users list" +"", +"", +"", +"" ], "type": "string" } @@ -1431,34 +1294,27 @@ "type": "object" }, "AwsAccount": { -"description": "An AWS account that is a member of an organization.", "id": "AwsAccount", "properties": { "id": { -"description": "The unique identifier (ID) of the account, containing exactly 12 digits.", "type": "string" }, "name": { -"description": "The friendly name of this account.", "type": "string" } }, "type": "object" }, "AwsMetadata": { -"description": "AWS metadata associated with the resource, only applicable if the finding's cloud provider is Amazon Web Services.", "id": "AwsMetadata", "properties": { "account": { -"$ref": "AwsAccount", -"description": "The AWS account associated with the resource." +"$ref": "AwsAccount" }, "organization": { -"$ref": "AwsOrganization", -"description": "The AWS organization associated with the resource." +"$ref": "AwsOrganization" }, "organizationalUnits": { -"description": "A list of AWS organizational units associated with the resource, ordered from lowest level (closest to the account) to highest level.", "items": { "$ref": "AwsOrganizationalUnit" }, @@ -1468,219 +1324,177 @@ "type": "object" }, "AwsOrganization": { -"description": "An organization is a collection of accounts that are centrally managed together using consolidated billing, organized hierarchically with organizational units (OUs), and controlled with policies.", "id": "AwsOrganization", "properties": { "id": { -"description": "The unique identifier (ID) for the organization. The regex pattern for an organization ID string requires \"o-\" followed by from 10 to 32 lowercase letters or digits.", "type": "string" } }, "type": "object" }, "AwsOrganizationalUnit": { -"description": "An Organizational Unit (OU) is a container of AWS accounts within a root of an organization. Policies that are attached to an OU apply to all accounts contained in that OU and in any child OUs.", "id": "AwsOrganizationalUnit", "properties": { "id": { -"description": "The unique identifier (ID) associated with this OU. The regex pattern for an organizational unit ID string requires \"ou-\" followed by from 4 to 32 lowercase letters or digits (the ID of the root that contains the OU). This string is followed by a second \"-\" dash and from 8 to 32 additional lowercase letters or digits. For example, \"ou-ab12-cd34ef56\".", "type": "string" }, "name": { -"description": "The friendly name of the OU.", "type": "string" } }, "type": "object" }, "AzureManagementGroup": { -"description": "Represents an Azure management group.", "id": "AzureManagementGroup", "properties": { "displayName": { -"description": "The display name of the Azure management group.", "type": "string" }, "id": { -"description": "The UUID of the Azure management group, for example, `20000000-0001-0000-0000-000000000000`.", "type": "string" } }, "type": "object" }, "AzureMetadata": { -"description": "Azure metadata associated with the resource, only applicable if the finding's cloud provider is Microsoft Azure.", "id": "AzureMetadata", "properties": { "managementGroups": { -"description": "A list of Azure management groups associated with the resource, ordered from lowest level (closest to the subscription) to highest level.", "items": { "$ref": "AzureManagementGroup" }, "type": "array" }, "resourceGroup": { -"$ref": "AzureResourceGroup", -"description": "The Azure resource group associated with the resource." +"$ref": "AzureResourceGroup" }, "subscription": { -"$ref": "AzureSubscription", -"description": "The Azure subscription associated with the resource." +"$ref": "AzureSubscription" }, "tenant": { -"$ref": "AzureTenant", -"description": "The Azure Entra tenant associated with the resource." +"$ref": "AzureTenant" } }, "type": "object" }, "AzureResourceGroup": { -"description": "Represents an Azure resource group.", "id": "AzureResourceGroup", "properties": { "id": { -"description": "The ID of the Azure resource group.", "type": "string" }, "name": { -"description": "The name of the Azure resource group. This is not a UUID.", "type": "string" } }, "type": "object" }, "AzureSubscription": { -"description": "Represents an Azure subscription.", "id": "AzureSubscription", "properties": { "displayName": { -"description": "The display name of the Azure subscription.", "type": "string" }, "id": { -"description": "The UUID of the Azure subscription, for example, `291bba3f-e0a5-47bc-a099-3bdcb2a50a05`.", "type": "string" } }, "type": "object" }, "AzureTenant": { -"description": "Represents a Microsoft Entra tenant.", "id": "AzureTenant", "properties": { "displayName": { -"description": "The display name of the Azure tenant.", "type": "string" }, "id": { -"description": "The ID of the Microsoft Entra tenant, for example, \"a11aaa11-aa11-1aa1-11aa-1aaa11a\".", "type": "string" } }, "type": "object" }, "BackupDisasterRecovery": { -"description": "Information related to Google Cloud Backup and DR Service findings.", "id": "BackupDisasterRecovery", "properties": { "appliance": { -"description": "The name of the Backup and DR appliance that captures, moves, and manages the lifecycle of backup data. For example, `backup-server-57137`.", "type": "string" }, "applications": { -"description": "The names of Backup and DR applications. An application is a VM, database, or file system on a managed host monitored by a backup and recovery appliance. For example, `centos7-01-vol00`, `centos7-01-vol01`, `centos7-01-vol02`.", "items": { "type": "string" }, "type": "array" }, "backupCreateTime": { -"description": "The timestamp at which the Backup and DR backup was created.", "format": "google-datetime", "type": "string" }, "backupTemplate": { -"description": "The name of a Backup and DR template which comprises one or more backup policies. See the [Backup and DR documentation](https://cloud.google.com/backup-disaster-recovery/docs/concepts/backup-plan#temp) for more information. For example, `snap-ov`.", "type": "string" }, "backupType": { -"description": "The backup type of the Backup and DR image. For example, `Snapshot`, `Remote Snapshot`, `OnVault`.", "type": "string" }, "host": { -"description": "The name of a Backup and DR host, which is managed by the backup and recovery appliance and known to the management console. The host can be of type Generic (for example, Compute Engine, SQL Server, Oracle DB, SMB file system, etc.), vCenter, or an ESX server. See the [Backup and DR documentation on hosts](https://cloud.google.com/backup-disaster-recovery/docs/configuration/manage-hosts-and-their-applications) for more information. For example, `centos7-01`.", "type": "string" }, "policies": { -"description": "The names of Backup and DR policies that are associated with a template and that define when to run a backup, how frequently to run a backup, and how long to retain the backup image. For example, `onvaults`.", "items": { "type": "string" }, "type": "array" }, "policyOptions": { -"description": "The names of Backup and DR advanced policy options of a policy applying to an application. See the [Backup and DR documentation on policy options](https://cloud.google.com/backup-disaster-recovery/docs/create-plan/policy-settings). For example, `skipofflineappsincongrp, nounmap`.", "items": { "type": "string" }, "type": "array" }, "profile": { -"description": "The name of the Backup and DR resource profile that specifies the storage media for backups of application and VM data. See the [Backup and DR documentation on profiles](https://cloud.google.com/backup-disaster-recovery/docs/concepts/backup-plan#profile). For example, `GCP`.", "type": "string" }, "storagePool": { -"description": "The name of the Backup and DR storage pool that the backup and recovery appliance is storing data in. The storage pool could be of type Cloud, Primary, Snapshot, or OnVault. See the [Backup and DR documentation on storage pools](https://cloud.google.com/backup-disaster-recovery/docs/concepts/storage-pools). For example, `DiskPoolOne`.", "type": "string" } }, "type": "object" }, "BigQueryDestination": { -"description": "The destination BigQuery dataset to export findings to.", "id": "BigQueryDestination", "properties": { "dataset": { -"description": "Required. The relative resource name of the destination dataset, in the form projects/{projectId}/datasets/{datasetId}.", "type": "string" } }, "type": "object" }, "Binding": { -"description": "Associates `members`, or principals, with a `role`.", "id": "Binding", "properties": { "condition": { -"$ref": "Expr", -"description": "The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies)." +"$ref": "Expr" }, "members": { -"description": "Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.", "items": { "type": "string" }, "type": "array" }, "role": { -"description": "Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles).", "type": "string" } }, "type": "object" }, "CancelOperationRequest": { -"description": "The request message for Operations.CancelOperation.", "id": "CancelOperationRequest", "properties": {}, "type": "object" }, "Chokepoint": { -"description": "Contains details about a chokepoint, which is a resource or resource group where high-risk attack paths converge, based on [attack path simulations] (https://cloud.google.com/security-command-center/docs/attack-exposure-learn#attack_path_simulations).", "id": "Chokepoint", "properties": { "relatedFindings": { -"description": "List of resource names of findings associated with this chokepoint. For example, organizations/123/sources/456/findings/789. This list will have at most 100 findings.", "items": { "type": "string" }, @@ -1690,65 +1504,53 @@ "type": "object" }, "CloudArmor": { -"description": "Fields related to Google Cloud Armor findings.", "id": "CloudArmor", "properties": { "adaptiveProtection": { -"$ref": "AdaptiveProtection", -"description": "Information about potential Layer 7 DDoS attacks identified by [Google Cloud Armor Adaptive Protection](https://cloud.google.com/armor/docs/adaptive-protection-overview)." +"$ref": "AdaptiveProtection" }, "attack": { -"$ref": "Attack", -"description": "Information about DDoS attack volume and classification." +"$ref": "Attack" }, "duration": { -"description": "Duration of attack from the start until the current moment (updated every 5 minutes).", "format": "google-duration", "type": "string" }, "requests": { -"$ref": "Requests", -"description": "Information about incoming requests evaluated by [Google Cloud Armor security policies](https://cloud.google.com/armor/docs/security-policy-overview)." +"$ref": "Requests" }, "securityPolicy": { -"$ref": "SecurityPolicy", -"description": "Information about the [Google Cloud Armor security policy](https://cloud.google.com/armor/docs/security-policy-overview) relevant to the finding." +"$ref": "SecurityPolicy" }, "threatVector": { -"description": "Distinguish between volumetric & protocol DDoS attack and application layer attacks. For example, \"L3_4\" for Layer 3 and Layer 4 DDoS attacks, or \"L_7\" for Layer 7 DDoS attacks.", "type": "string" } }, "type": "object" }, "CloudControl": { -"description": "CloudControl associated with the finding.", "id": "CloudControl", "properties": { "cloudControlName": { -"description": "Name of the CloudControl associated with the finding.", "type": "string" }, "policyType": { -"description": "Policy type of the CloudControl", "type": "string" }, "type": { -"description": "Type of cloud control.", "enum": [ "CLOUD_CONTROL_TYPE_UNSPECIFIED", "BUILT_IN", "CUSTOM" ], "enumDescriptions": [ -"Unspecified.", -"Built in Cloud Control.", -"Custom Cloud Control." +"", +"", +"" ], "type": "string" }, "version": { -"description": "Version of the Cloud Control", "format": "int32", "type": "integer" } @@ -1756,31 +1558,27 @@ "type": "object" }, "CloudDlpDataProfile": { -"description": "The [data profile](https://cloud.google.com/dlp/docs/data-profiles) associated with the finding.", "id": "CloudDlpDataProfile", "properties": { "dataProfile": { -"description": "Name of the data profile, for example, `projects/123/locations/europe/tableProfiles/8383929`.", "type": "string" }, "infoTypes": { -"description": "Type of information detected by SDP. Info type includes name, version and sensitivity of the detected information type.", "items": { "$ref": "InfoType" }, "type": "array" }, "parentType": { -"description": "The resource hierarchy level at which the data profile was generated.", "enum": [ "PARENT_TYPE_UNSPECIFIED", "ORGANIZATION", "PROJECT" ], "enumDescriptions": [ -"Unspecified parent type.", -"Organization-level configurations.", -"Project-level configurations." +"", +"", +"" ], "type": "string" } @@ -1788,47 +1586,37 @@ "type": "object" }, "CloudDlpInspection": { -"description": "Details about the Cloud Data Loss Prevention (Cloud DLP) [inspection job](https://cloud.google.com/dlp/docs/concepts-job-triggers) that produced the finding.", "id": "CloudDlpInspection", "properties": { "fullScan": { -"description": "Whether Cloud DLP scanned the complete resource or a sampled subset.", "type": "boolean" }, "infoType": { -"description": "The type of information (or *[infoType](https://cloud.google.com/dlp/docs/infotypes-reference)*) found, for example, `EMAIL_ADDRESS` or `STREET_ADDRESS`.", "type": "string" }, "infoTypeCount": { -"description": "The number of times Cloud DLP found this infoType within this job and resource.", "format": "int64", "type": "string" }, "inspectJob": { -"description": "Name of the inspection job, for example, `projects/123/locations/europe/dlpJobs/i-8383929`.", "type": "string" } }, "type": "object" }, "CloudLoggingEntry": { -"description": "Metadata taken from a [Cloud Logging LogEntry](https://cloud.google.com/logging/docs/reference/v2/rest/v2/LogEntry)", "id": "CloudLoggingEntry", "properties": { "insertId": { -"description": "A unique identifier for the log entry.", "type": "string" }, "logId": { -"description": "The type of the log (part of `log_name`. `log_name` is the resource name of the log to which this log entry belongs). For example: `cloudresourcemanager.googleapis.com/activity`. Note that this field is not URL-encoded, unlike the `LOG_ID` field in `LogEntry`.", "type": "string" }, "resourceContainer": { -"description": "The organization, folder, or project of the monitored resource that produced this log entry.", "type": "string" }, "timestamp": { -"description": "The time the event described by the log entry occurred.", "format": "google-datetime", "type": "string" } @@ -1836,44 +1624,36 @@ "type": "object" }, "Compliance": { -"description": "Contains compliance information about a security standard indicating unmet recommendations.", "id": "Compliance", "properties": { "ids": { -"description": "Policies within the standard or benchmark, for example, A.12.4.1", "items": { "type": "string" }, "type": "array" }, "standard": { -"description": "Industry-wide compliance standards or benchmarks, such as CIS, PCI, and OWASP.", "type": "string" }, "version": { -"description": "Version of the standard or benchmark, for example, 1.1", "type": "string" } }, "type": "object" }, "ComplianceDetails": { -"description": "Compliance Details associated with the finding.", "id": "ComplianceDetails", "properties": { "cloudControl": { -"$ref": "CloudControl", -"description": "CloudControl associated with the finding" +"$ref": "CloudControl" }, "cloudControlDeploymentNames": { -"description": "Cloud Control Deployments associated with the finding. For example, organizations/123/locations/global/cloudControlDeployments/deploymentIdentifier", "items": { "type": "string" }, "type": "array" }, "frameworks": { -"description": "Details of Frameworks associated with the finding", "items": { "$ref": "Framework" }, @@ -1883,20 +1663,16 @@ "type": "object" }, "Connection": { -"description": "Contains information about the IP connection associated with the finding.", "id": "Connection", "properties": { "destinationIp": { -"description": "Destination IP address. Not present for sockets that are listening and not connected.", "type": "string" }, "destinationPort": { -"description": "Destination port. Not present for sockets that are listening and not connected.", "format": "int32", "type": "integer" }, "protocol": { -"description": "IANA Internet Protocol Number such as TCP(6) and UDP(17).", "enum": [ "PROTOCOL_UNSPECIFIED", "ICMP", @@ -1906,21 +1682,19 @@ "ESP" ], "enumDescriptions": [ -"Unspecified protocol (not HOPOPT).", -"Internet Control Message Protocol.", -"Transmission Control Protocol.", -"User Datagram Protocol.", -"Generic Routing Encapsulation.", -"Encap Security Payload." +"", +"", +"", +"", +"", +"" ], "type": "string" }, "sourceIp": { -"description": "Source IP address.", "type": "string" }, "sourcePort": { -"description": "Source port.", "format": "int32", "type": "integer" } @@ -1928,22 +1702,18 @@ "type": "object" }, "Contact": { -"description": "The email address of a contact.", "id": "Contact", "properties": { "email": { -"description": "An email address. For example, \"`person123@company.com`\".", "type": "string" } }, "type": "object" }, "ContactDetails": { -"description": "Details about specific contacts", "id": "ContactDetails", "properties": { "contacts": { -"description": "A list of contacts", "items": { "$ref": "Contact" }, @@ -1953,66 +1723,53 @@ "type": "object" }, "Container": { -"description": "Container associated with the finding.", "id": "Container", "properties": { "createTime": { -"description": "The time that the container was created.", "format": "google-datetime", "type": "string" }, "imageId": { -"description": "Optional container image ID, if provided by the container runtime. Uniquely identifies the container image launched using a container image digest.", "type": "string" }, "labels": { -"description": "Container labels, as provided by the container runtime.", "items": { "$ref": "Label" }, "type": "array" }, "name": { -"description": "Name of the container.", "type": "string" }, "uri": { -"description": "Container image URI provided when configuring a pod or container. This string can identify a container image version using mutable tags.", "type": "string" } }, "type": "object" }, "Control": { -"description": "Compliance control associated with the finding.", "id": "Control", "properties": { "controlName": { -"description": "Name of the Control", "type": "string" }, "displayName": { -"description": "Display name of the control. For example, AU-02.", "type": "string" } }, "type": "object" }, "Cve": { -"description": "CVE stands for Common Vulnerabilities and Exposures. Information from the [CVE record](https://www.cve.org/ResourcesSupport/Glossary) that describes this vulnerability.", "id": "Cve", "properties": { "cvssv3": { -"$ref": "Cvssv3", -"description": "Describe Common Vulnerability Scoring System specified at https://www.first.org/cvss/v3.1/specification-document" +"$ref": "Cvssv3" }, "exploitReleaseDate": { -"description": "Date the first publicly available exploit or PoC was released.", "format": "google-datetime", "type": "string" }, "exploitationActivity": { -"description": "The exploitation activity of the vulnerability in the wild.", "enum": [ "EXPLOITATION_ACTIVITY_UNSPECIFIED", "WIDE", @@ -2022,26 +1779,23 @@ "NO_KNOWN" ], "enumDescriptions": [ -"Invalid or empty value.", -"Exploitation has been reported or confirmed to widely occur.", -"Limited reported or confirmed exploitation activities.", -"Exploit is publicly available.", -"No known exploitation activity, but has a high potential for exploitation.", -"No known exploitation activity." +"", +"", +"", +"", +"", +"" ], "type": "string" }, "firstExploitationDate": { -"description": "Date of the earliest known exploitation.", "format": "google-datetime", "type": "string" }, "id": { -"description": "The unique identifier for the vulnerability. e.g. CVE-2021-34527", "type": "string" }, "impact": { -"description": "The potential impact of the vulnerability if it was to be exploited.", "enum": [ "RISK_RATING_UNSPECIFIED", "LOW", @@ -2050,56 +1804,49 @@ "CRITICAL" ], "enumDescriptions": [ -"Invalid or empty value.", -"Exploitation would have little to no security impact.", -"Exploitation would enable attackers to perform activities, or could allow attackers to have a direct impact, but would require additional steps.", -"Exploitation would enable attackers to have a notable direct impact without needing to overcome any major mitigating factors.", -"Exploitation would fundamentally undermine the security of affected systems, enable actors to perform significant attacks with minimal effort, with little to no mitigating factors to overcome." +"", +"", +"", +"", +"" ], "type": "string" }, "observedInTheWild": { -"description": "Whether or not the vulnerability has been observed in the wild.", "type": "boolean" }, "references": { -"description": "Additional information about the CVE. e.g. https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2021-34527", "items": { "$ref": "Reference" }, "type": "array" }, "upstreamFixAvailable": { -"description": "Whether upstream fix is available for the CVE.", "type": "boolean" }, "zeroDay": { -"description": "Whether or not the vulnerability was zero day when the finding was published.", "type": "boolean" } }, "type": "object" }, "Cvssv3": { -"description": "Common Vulnerability Scoring System version 3.", "id": "Cvssv3", "properties": { "attackComplexity": { -"description": "This metric describes the conditions beyond the attacker's control that must exist in order to exploit the vulnerability.", "enum": [ "ATTACK_COMPLEXITY_UNSPECIFIED", "ATTACK_COMPLEXITY_LOW", "ATTACK_COMPLEXITY_HIGH" ], "enumDescriptions": [ -"Invalid value.", -"Specialized access conditions or extenuating circumstances do not exist. An attacker can expect repeatable success when attacking the vulnerable component.", -"A successful attack depends on conditions beyond the attacker's control. That is, a successful attack cannot be accomplished at will, but requires the attacker to invest in some measurable amount of effort in preparation or execution against the vulnerable component before a successful attack can be expected." +"", +"", +"" ], "type": "string" }, "attackVector": { -"description": "Base Metrics Represents the intrinsic characteristics of a vulnerability that are constant over time and across user environments. This metric reflects the context by which vulnerability exploitation is possible.", "enum": [ "ATTACK_VECTOR_UNSPECIFIED", "ATTACK_VECTOR_NETWORK", @@ -2108,16 +1855,15 @@ "ATTACK_VECTOR_PHYSICAL" ], "enumDescriptions": [ -"Invalid value.", -"The vulnerable component is bound to the network stack and the set of possible attackers extends beyond the other options listed below, up to and including the entire Internet.", -"The vulnerable component is bound to the network stack, but the attack is limited at the protocol level to a logically adjacent topology.", -"The vulnerable component is not bound to the network stack and the attacker's path is via read/write/execute capabilities.", -"The attack requires the attacker to physically touch or manipulate the vulnerable component." +"", +"", +"", +"", +"" ], "type": "string" }, "availabilityImpact": { -"description": "This metric measures the impact to the availability of the impacted component resulting from a successfully exploited vulnerability.", "enum": [ "IMPACT_UNSPECIFIED", "IMPACT_HIGH", @@ -2125,20 +1871,18 @@ "IMPACT_NONE" ], "enumDescriptions": [ -"Invalid value.", -"High impact.", -"Low impact.", -"No impact." +"", +"", +"", +"" ], "type": "string" }, "baseScore": { -"description": "The base score is a function of the base metric scores.", "format": "double", "type": "number" }, "confidentialityImpact": { -"description": "This metric measures the impact to the confidentiality of the information resources managed by a software component due to a successfully exploited vulnerability.", "enum": [ "IMPACT_UNSPECIFIED", "IMPACT_HIGH", @@ -2146,15 +1890,14 @@ "IMPACT_NONE" ], "enumDescriptions": [ -"Invalid value.", -"High impact.", -"Low impact.", -"No impact." +"", +"", +"", +"" ], "type": "string" }, "integrityImpact": { -"description": "This metric measures the impact to integrity of a successfully exploited vulnerability.", "enum": [ "IMPACT_UNSPECIFIED", "IMPACT_HIGH", @@ -2162,15 +1905,14 @@ "IMPACT_NONE" ], "enumDescriptions": [ -"Invalid value.", -"High impact.", -"Low impact.", -"No impact." +"", +"", +"", +"" ], "type": "string" }, "privilegesRequired": { -"description": "This metric describes the level of privileges an attacker must possess before successfully exploiting the vulnerability.", "enum": [ "PRIVILEGES_REQUIRED_UNSPECIFIED", "PRIVILEGES_REQUIRED_NONE", @@ -2178,38 +1920,36 @@ "PRIVILEGES_REQUIRED_HIGH" ], "enumDescriptions": [ -"Invalid value.", -"The attacker is unauthorized prior to attack, and therefore does not require any access to settings or files of the vulnerable system to carry out an attack.", -"The attacker requires privileges that provide basic user capabilities that could normally affect only settings and files owned by a user. Alternatively, an attacker with Low privileges has the ability to access only non-sensitive resources.", -"The attacker requires privileges that provide significant (e.g., administrative) control over the vulnerable component allowing access to component-wide settings and files." +"", +"", +"", +"" ], "type": "string" }, "scope": { -"description": "The Scope metric captures whether a vulnerability in one vulnerable component impacts resources in components beyond its security scope.", "enum": [ "SCOPE_UNSPECIFIED", "SCOPE_UNCHANGED", "SCOPE_CHANGED" ], "enumDescriptions": [ -"Invalid value.", -"An exploited vulnerability can only affect resources managed by the same security authority.", -"An exploited vulnerability can affect resources beyond the security scope managed by the security authority of the vulnerable component." +"", +"", +"" ], "type": "string" }, "userInteraction": { -"description": "This metric captures the requirement for a human user, other than the attacker, to participate in the successful compromise of the vulnerable component.", "enum": [ "USER_INTERACTION_UNSPECIFIED", "USER_INTERACTION_NONE", "USER_INTERACTION_REQUIRED" ], "enumDescriptions": [ -"Invalid value.", -"The vulnerable system can be exploited without interaction from any user.", -"Successful exploitation of this vulnerability requires a user to take some action before the vulnerability can be exploited." +"", +"", +"" ], "type": "string" } @@ -2217,15 +1957,12 @@ "type": "object" }, "Cwe": { -"description": "CWE stands for Common Weakness Enumeration. Information about this weakness, as described by [CWE](https://cwe.mitre.org/).", "id": "Cwe", "properties": { "id": { -"description": "The CWE identifier, e.g. CWE-94", "type": "string" }, "references": { -"description": "Any reference to the details on the CWE, for example, https://cwe.mitre.org/data/definitions/94.html", "items": { "$ref": "Reference" }, @@ -2235,20 +1972,16 @@ "type": "object" }, "DataAccessEvent": { -"description": "Details about a data access attempt made by a principal not authorized under applicable data security policy.", "id": "DataAccessEvent", "properties": { "eventId": { -"description": "Unique identifier for data access event.", "type": "string" }, "eventTime": { -"description": "Timestamp of data access event.", "format": "google-datetime", "type": "string" }, "operation": { -"description": "The operation performed by the principal to access the data.", "enum": [ "OPERATION_UNSPECIFIED", "READ", @@ -2256,35 +1989,30 @@ "COPY" ], "enumDescriptions": [ -"The operation is unspecified.", -"Represents a read operation.", -"Represents a move operation.", -"Represents a copy operation." +"", +"", +"", +"" ], "type": "string" }, "principalEmail": { -"description": "The email address of the principal that accessed the data. The principal could be a user account, service account, Google group, or other.", "type": "string" } }, "type": "object" }, "DataFlowEvent": { -"description": "Details about a data flow event, in which either the data is moved to or is accessed from a non-compliant geo-location, as defined in the applicable data security policy.", "id": "DataFlowEvent", "properties": { "eventId": { -"description": "Unique identifier for data flow event.", "type": "string" }, "eventTime": { -"description": "Timestamp of data flow event.", "format": "google-datetime", "type": "string" }, "operation": { -"description": "The operation performed by the principal for the data flow event.", "enum": [ "OPERATION_UNSPECIFIED", "READ", @@ -2292,40 +2020,34 @@ "COPY" ], "enumDescriptions": [ -"The operation is unspecified.", -"Represents a read operation.", -"Represents a move operation.", -"Represents a copy operation." +"", +"", +"", +"" ], "type": "string" }, "principalEmail": { -"description": "The email address of the principal that initiated the data flow event. The principal could be a user account, service account, Google group, or other.", "type": "string" }, "violatedLocation": { -"description": "Non-compliant location of the principal or the data destination.", "type": "string" } }, "type": "object" }, "DataRetentionDeletionEvent": { -"description": "Details about data retention deletion violations, in which the data is non-compliant based on their retention or deletion time, as defined in the applicable data security policy. The Data Retention Deletion (DRD) control is a control of the DSPM (Data Security Posture Management) suite that enables organizations to manage data retention and deletion policies in compliance with regulations, such as GDPR and CRPA. DRD supports two primary policy types: maximum storage length (max TTL) and minimum storage length (min TTL). Both are aimed at helping organizations meet regulatory and data management commitments.", "id": "DataRetentionDeletionEvent", "properties": { "dataObjectCount": { -"description": "Number of objects that violated the policy for this resource. If the number is less than 1,000, then the value of this field is the exact number. If the number of objects that violated the policy is greater than or equal to 1,000, then the value of this field is 1000.", "format": "int64", "type": "string" }, "eventDetectionTime": { -"description": "Timestamp indicating when the event was detected.", "format": "google-datetime", "type": "string" }, "eventType": { -"description": "Type of the DRD event.", "enum": [ "EVENT_TYPE_UNSPECIFIED", "EVENT_TYPE_MAX_TTL_EXCEEDED", @@ -2341,21 +2063,19 @@ false, false ], "enumDescriptions": [ -"Unspecified event type.", -"Deprecated: This field is pending removal. Use EVENT_TYPE_MAX_TTL_FROM_CREATION or EVENT_TYPE_MAX_TTL_FROM_LAST_MODIFICATION instead.", -"Max TTL from the asset's creation time.", -"Max TTL from the asset's last modification time.", -"Min TTL from the asset's creation time." +"", +"", +"", +"", +"" ], "type": "string" }, "maxRetentionAllowed": { -"description": "Maximum duration of retention allowed from the DRD control. This comes from the DRD control where users set a max TTL for their data. For example, suppose that a user sets the max TTL for a Cloud Storage bucket to 90 days. However, an object in that bucket is 100 days old. In this case, a DataRetentionDeletionEvent will be generated for that Cloud Storage bucket, and the max_retention_allowed is 90 days.", "format": "google-duration", "type": "string" }, "minRetentionAllowed": { -"description": "Min duration of retention allowed from the DSPM retention control. This field is only populated when event type is set to EVENT_TYPE_MIN_TTL_FROM_CREATION.", "format": "google-duration", "type": "string" } @@ -2363,64 +2083,51 @@ false "type": "object" }, "Database": { -"description": "Represents database access information, such as queries. A database may be a sub-resource of an instance (as in the case of Cloud SQL instances or Cloud Spanner instances), or the database instance itself. Some database resources might not have the [full resource name](https://google.aip.dev/122#full-resource-names) populated because these resource types, such as Cloud SQL databases, are not yet supported by Cloud Asset Inventory. In these cases only the display name is provided.", "id": "Database", "properties": { "displayName": { -"description": "The human-readable name of the database that the user connected to.", "type": "string" }, "grantees": { -"description": "The target usernames, roles, or groups of an SQL privilege grant, which is not an IAM policy change.", "items": { "type": "string" }, "type": "array" }, "name": { -"description": "Some database resources may not have the [full resource name](https://google.aip.dev/122#full-resource-names) populated because these resource types are not yet supported by Cloud Asset Inventory (e.g. Cloud SQL databases). In these cases only the display name will be provided. The [full resource name](https://google.aip.dev/122#full-resource-names) of the database that the user connected to, if it is supported by Cloud Asset Inventory.", "type": "string" }, "query": { -"description": "The SQL statement that is associated with the database access.", "type": "string" }, "userName": { -"description": "The username used to connect to the database. The username might not be an IAM principal and does not have a set format.", "type": "string" }, "version": { -"description": "The version of the database, for example, POSTGRES_14. See [the complete list](https://cloud.google.com/sql/docs/mysql/admin-api/rest/v1/SqlDatabaseVersion).", "type": "string" } }, "type": "object" }, "Dataset": { -"description": "Vertex AI dataset associated with the finding.", "id": "Dataset", "properties": { "displayName": { -"description": "The user defined display name of dataset, e.g. plants-dataset", "type": "string" }, "name": { -"description": "Resource name of the dataset, e.g. projects/{project}/locations/{location}/datasets/2094040236064505856", "type": "string" }, "source": { -"description": "Data source, such as BigQuery source URI, e.g. bq://scc-nexus-test.AIPPtest.gsod", "type": "string" } }, "type": "object" }, "Denied": { -"description": "Denied IP rule.", "id": "Denied", "properties": { "ipRules": { -"description": "Optional. Optional list of denied IP rules.", "items": { "$ref": "IpRule" }, @@ -2430,15 +2137,12 @@ false "type": "object" }, "Detection": { -"description": "Memory hash detection contributing to the binary family match.", "id": "Detection", "properties": { "binary": { -"description": "The name of the binary associated with the memory hash signature detection.", "type": "string" }, "percentPagesMatched": { -"description": "The percentage of memory page hashes in the signature that were matched.", "format": "double", "type": "number" } @@ -2446,35 +2150,29 @@ false "type": "object" }, "DiscoveredWorkload": { -"description": "Represents discovered, customer managed workload that is not registered with the respective GCP service.", "id": "DiscoveredWorkload", "properties": { "confidence": { -"description": "The confidence in detection of this workload.", "enum": [ "CONFIDENCE_UNSPECIFIED", "CONFIDENCE_HIGH" ], "enumDescriptions": [ -"Unspecified confidence level.", -"High confidence in detection of a workload." +"", +"" ], "type": "string" }, "detectedRelevantHardware": { -"description": "A boolean flag set to true if associated hardware strongly predicts the workload type.", "type": "boolean" }, "detectedRelevantKeywords": { -"description": "A boolean flag set to true if associated keywords strongly predict the workload type.", "type": "boolean" }, "detectedRelevantPackages": { -"description": "A boolean flag set to true if installed packages strongly predict the workload type.", "type": "boolean" }, "workloadType": { -"description": "The type of workload.", "enum": [ "WORKLOAD_TYPE_UNSPECIFIED", "MCP_SERVER", @@ -2482,10 +2180,10 @@ false "AGENT" ], "enumDescriptions": [ -"Unspecified workload type", -"A workload of type MCP Server", -"A workload of type AI Inference", -"A workload of type LLM Agent" +"", +"", +"", +"" ], "type": "string" } @@ -2493,106 +2191,87 @@ false "type": "object" }, "Disk": { -"description": "Contains information about the disk associated with the finding.", "id": "Disk", "properties": { "name": { -"description": "The name of the disk, for example, \"https://www.googleapis.com/compute/v1/projects/{project-id}/zones/{zone-id}/disks/{disk-id}\".", "type": "string" } }, "type": "object" }, "DiskPath": { -"description": "Path of the file in terms of underlying disk/partition identifiers.", "id": "DiskPath", "properties": { "partitionUuid": { -"description": "UUID of the partition (format https://wiki.archlinux.org/title/persistent_block_device_naming#by-uuid)", "type": "string" }, "relativePath": { -"description": "Relative path of the file in the partition as a JSON encoded string. Example: /home/user1/executable_file.sh", "type": "string" } }, "type": "object" }, "DynamicMuteRecord": { -"description": "The record of a dynamic mute rule that matches the finding.", "id": "DynamicMuteRecord", "properties": { "matchTime": { -"description": "When the dynamic mute rule first matched the finding.", "format": "google-datetime", "type": "string" }, "muteConfig": { -"description": "The relative resource name of the mute rule, represented by a mute config, that created this record, for example `organizations/123/muteConfigs/mymuteconfig` or `organizations/123/locations/global/muteConfigs/mymuteconfig`.", "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" }, "EnvironmentVariable": { -"description": "A name-value pair representing an environment variable used in an operating system process.", "id": "EnvironmentVariable", "properties": { "name": { -"description": "Environment variable name as a JSON encoded string.", "type": "string" }, "val": { -"description": "Environment variable value as a JSON encoded string.", "type": "string" } }, "type": "object" }, "ExfilResource": { -"description": "Resource where data was exfiltrated from or exfiltrated to.", "id": "ExfilResource", "properties": { "components": { -"description": "Subcomponents of the asset that was exfiltrated, like URIs used during exfiltration, table names, databases, and filenames. For example, multiple tables might have been exfiltrated from the same Cloud SQL instance, or multiple files might have been exfiltrated from the same Cloud Storage bucket.", "items": { "type": "string" }, "type": "array" }, "name": { -"description": "The resource's [full resource name](https://cloud.google.com/apis/design/resource_names#full_resource_name).", "type": "string" } }, "type": "object" }, "Exfiltration": { -"description": "Exfiltration represents a data exfiltration attempt from one or more sources to one or more targets. The `sources` attribute lists the sources of the exfiltrated data. The `targets` attribute lists the destinations the data was copied to.", "id": "Exfiltration", "properties": { "sources": { -"description": "If there are multiple sources, then the data is considered \"joined\" between them. For instance, BigQuery can join multiple tables, and each table would be considered a source.", "items": { "$ref": "ExfilResource" }, "type": "array" }, "targets": { -"description": "If there are multiple targets, each target would get a complete copy of the \"joined\" source data.", "items": { "$ref": "ExfilResource" }, "type": "array" }, "totalExfiltratedBytes": { -"description": "Total exfiltrated bytes processed for the entire job.", "format": "int64", "type": "string" } @@ -2600,15 +2279,12 @@ false "type": "object" }, "ExportFindingsMetadata": { -"description": "The LRO metadata for a ExportFindings request.", "id": "ExportFindingsMetadata", "properties": { "bigQueryDestination": { -"$ref": "BigQueryDestination", -"description": "Required. The destination BigQuery dataset to export findings to." +"$ref": "BigQueryDestination" }, "exportStartTime": { -"description": "Optional. Timestamp at which export was started", "format": "google-datetime", "type": "string" } @@ -2616,176 +2292,139 @@ false "type": "object" }, "ExportFindingsResponse": { -"description": "The response to a ExportFindings request. Contains the LRO information.", "id": "ExportFindingsResponse", "properties": {}, "type": "object" }, "Expr": { -"description": "Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: \"Summary size limit\" description: \"Determines if a summary is less than 100 chars\" expression: \"document.summary.size() < 100\" Example (Equality): title: \"Requestor is owner\" description: \"Determines if requestor is the document owner\" expression: \"document.owner == request.auth.claims.email\" Example (Logic): title: \"Public documents\" description: \"Determine whether the document should be publicly visible\" expression: \"document.type != 'private' && document.type != 'internal'\" Example (Data Manipulation): title: \"Notification string\" description: \"Create a notification string with a timestamp.\" expression: \"'New message received at ' + string(document.create_time)\" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information.", "id": "Expr", "properties": { "description": { -"description": "Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.", "type": "string" }, "expression": { -"description": "Textual representation of an expression in Common Expression Language syntax.", "type": "string" }, "location": { -"description": "Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.", "type": "string" }, "title": { -"description": "Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.", "type": "string" } }, "type": "object" }, "ExternalExposure": { -"description": "Details about the externally exposed resource associated with the finding.", "id": "ExternalExposure", "properties": { "backendBucket": { -"description": "The full resource name of the load balancer backend bucket, for example, \"//compute.googleapis.com/projects/{project-id}/global/backendBuckets/{name}\"", "type": "string" }, "backendService": { -"description": "The full resource name of load balancer backend service, for example, \"//compute.googleapis.com/projects/{project-id}/global/backendServices/{name}\".", "type": "string" }, "exposedApplication": { -"description": "The name and version of the exposed web application, for example, \"Jenkins 2.184\".", "type": "string" }, "exposedEndpoint": { -"description": "The resource which is running the exposed service, for example, \"//compute.googleapis.com/projects/{project-id}/zones/{zone}/instances/{instance}.\u201d", "type": "string" }, "exposedService": { -"description": "The name and version of the service, for example, \"Jupyter Notebook 6.14.0\".", "type": "string" }, "forwardingRule": { -"description": "The full resource name of the forwarding rule, for example, \"//compute.googleapis.com/projects/{project-id}/global/forwardingRules/{forwarding-rule-name}\".", "type": "string" }, "hostnameUri": { -"description": "Hostname of the exposed application, for example, \"https://test-app.a.run.app/\"", "type": "string" }, "httpResponse": { -"description": "The http response returned by the web application.", "items": { "$ref": "HttpResponse" }, "type": "array" }, "instanceGroup": { -"description": "The full resource name of the instance group, for example, \"//compute.googleapis.com/projects/{project-id}/global/instanceGroups/{name}\".", "type": "string" }, "internalBackendService": { -"description": "The full resource name of load balancer backend service in the internal project having resource exposed via PSC, for example, \"//compute.googleapis.com/projects/{project-id}/global/backendServices/{name}\".", "type": "string" }, "loadBalancerFirewallPolicy": { -"description": "The full resource name of the load balancer firewall policy, for example, \"//compute.googleapis.com/projects/{project-id}/global/firewallPolicies/{policy-name}\".", "type": "string" }, "networkEndpointGroup": { -"description": "The full resource name of the network endpoint group, for example, \"//compute.googleapis.com/projects/{project-id}/global/networkEndpointGroups/{name}\".", "type": "string" }, "networkIngressFirewallPolicy": { -"description": "The full resource name of the network ingress firewall policy, for example, \"//compute.googleapis.com/projects/{project-id}/global/firewallPolicies/{name}\".", "type": "string" }, "privateIpAddress": { -"description": "Private IP address of the exposed endpoint.", "type": "string" }, "privatePort": { -"description": "Port number associated with private IP address.", "type": "string" }, "pscNetworkAttachment": { -"description": "The full resource name of the PSC (Private Service Connect) network attachment that network interface controller is attached to, for example, \"//compute.googleapis.com/projects/{project-id}/regions/{region}/networkAttachments/{name}\"", "type": "string" }, "pscServiceAttachment": { -"description": "The full resource name of the PSC (Private Service Connect) service attachment that the load balancer network endpoint group targets, for example, \"//compute.googleapis.com/projects/{project-id}/regions/{region}/serviceAttachments/{name}\"", "type": "string" }, "publicIpAddress": { -"description": "Public IP address of the exposed endpoint.", "type": "string" }, "publicPort": { -"description": "Public port number of the exposed endpoint.", "type": "string" }, "serviceFirewallPolicy": { -"description": "The full resource name of the firewall policy of the exposed service, for example, \"//compute.googleapis.com/projects/{project-id}/global/firewallPolicies/{policy-name}\".", "type": "string" } }, "type": "object" }, "File": { -"description": "File information about the related binary/library used by an executable, or the script used by a script interpreter", "id": "File", "properties": { "contents": { -"description": "Prefix of the file contents as a JSON-encoded string.", "type": "string" }, "diskPath": { -"$ref": "DiskPath", -"description": "Path of the file in terms of underlying disk/partition identifiers." +"$ref": "DiskPath" }, "fileLoadState": { -"description": "The load state of the file.", "enum": [ "FILE_LOAD_STATE_UNSPECIFIED", "LOADED_BY_PROCESS", "NOT_LOADED_BY_PROCESS" ], "enumDescriptions": [ -"The file state is unspecified.", -"The file is being used by an active process at the time of scanning.", -"The file is not being used by any active process at the time of scanning." +"", +"", +"" ], "type": "string" }, "hashedSize": { -"description": "The length in bytes of the file prefix that was hashed. If hashed_size == size, any hashes reported represent the entire file.", "format": "int64", "type": "string" }, "operations": { -"description": "Operation(s) performed on a file.", "items": { "$ref": "FileOperation" }, "type": "array" }, "partiallyHashed": { -"description": "True when the hash covers only a prefix of the file.", "type": "boolean" }, "path": { -"description": "Absolute path of the file as a JSON encoded string.", "type": "string" }, "sha256": { -"description": "SHA256 hash of the first hashed_size bytes of the file encoded as a hex string. If hashed_size == size, sha256 represents the SHA256 hash of the entire file.", "type": "string" }, "size": { -"description": "Size of the file in bytes.", "format": "int64", "type": "string" } @@ -2793,11 +2432,9 @@ false "type": "object" }, "FileOperation": { -"description": "Operation(s) performed on a file.", "id": "FileOperation", "properties": { "type": { -"description": "The type of the operation", "enum": [ "OPERATION_TYPE_UNSPECIFIED", "OPEN", @@ -2807,12 +2444,12 @@ false "EXECUTE" ], "enumDescriptions": [ -"The operation is unspecified.", -"Represents an open operation.", -"Represents a read operation.", -"Represents a rename operation.", -"Represents a write operation.", -"Represents an execute operation." +"", +"", +"", +"", +"", +"" ], "type": "string" } @@ -2820,81 +2457,63 @@ false "type": "object" }, "Finding": { -"description": "Security Command Center finding. A finding is a record of assessment data like security, risk, health, or privacy, that is ingested into Security Command Center for presentation, notification, analysis, policy testing, and enforcement. For example, a cross-site scripting (XSS) vulnerability in an App Engine application is a finding.", "id": "Finding", "properties": { "access": { -"$ref": "Access", -"description": "Access details associated with the finding, such as more information on the caller, which method was accessed, and from where." +"$ref": "Access" }, "affectedResources": { -"$ref": "AffectedResources", -"description": "AffectedResources associated with the finding." +"$ref": "AffectedResources" }, "agentDataAccessEvents": { -"description": "Agent data access events associated with the finding.", "items": { "$ref": "AgentDataAccessEvent" }, "type": "array" }, "aiModel": { -"$ref": "AiModel", -"description": "The AI model associated with the finding." +"$ref": "AiModel" }, "application": { -"$ref": "Application", -"description": "Represents an application associated with the finding." +"$ref": "Application" }, "artifactGuardPolicies": { -"$ref": "ArtifactGuardPolicies", -"description": "ArtifactGuardPolicies associated with the finding." +"$ref": "ArtifactGuardPolicies" }, "attackExposure": { -"$ref": "AttackExposure", -"description": "The results of an attack path simulation relevant to this finding." +"$ref": "AttackExposure" }, "backupDisasterRecovery": { -"$ref": "BackupDisasterRecovery", -"description": "Fields related to Backup and DR findings." +"$ref": "BackupDisasterRecovery" }, "canonicalName": { -"description": "The canonical name of the finding. It's either \"organizations/{organization_id}/sources/{source_id}/findings/{finding_id}\", \"folders/{folder_id}/sources/{source_id}/findings/{finding_id}\" or \"projects/{project_number}/sources/{source_id}/findings/{finding_id}\", depending on the closest CRM ancestor of the resource associated with the finding.", "type": "string" }, "category": { -"description": "The additional taxonomy group within findings from a given source. This field is immutable after creation time. Example: \"XSS_FLASH_INJECTION\"", "type": "string" }, "chokepoint": { -"$ref": "Chokepoint", -"description": "Contains details about a chokepoint, which is a resource or resource group where high-risk attack paths converge, based on [attack path simulations] (https://cloud.google.com/security-command-center/docs/attack-exposure-learn#attack_path_simulations). This field cannot be updated. Its value is ignored in all update requests." +"$ref": "Chokepoint" }, "cloudArmor": { -"$ref": "CloudArmor", -"description": "Fields related to Cloud Armor findings." +"$ref": "CloudArmor" }, "cloudDlpDataProfile": { -"$ref": "CloudDlpDataProfile", -"description": "Cloud DLP data profile that is associated with the finding." +"$ref": "CloudDlpDataProfile" }, "cloudDlpInspection": { -"$ref": "CloudDlpInspection", -"description": "Cloud Data Loss Prevention (Cloud DLP) inspection results that are associated with the finding." +"$ref": "CloudDlpInspection" }, "complianceDetails": { -"$ref": "ComplianceDetails", -"description": "Details about the compliance implications of the finding." +"$ref": "ComplianceDetails" }, "compliances": { -"description": "Contains compliance information for security standards associated to the finding.", "items": { "$ref": "Compliance" }, "type": "array" }, "connections": { -"description": "Contains information about the IP connection associated with the finding.", "items": { "$ref": "Connection" }, @@ -2904,93 +2523,76 @@ false "additionalProperties": { "$ref": "ContactDetails" }, -"description": "Output only. Map containing the points of contact for the given finding. The key represents the type of contact, while the value contains a list of all the contacts that pertain. Please refer to: https://cloud.google.com/resource-manager/docs/managing-notification-contacts#notification-categories { \"security\": { \"contacts\": [ { \"email\": \"person1@company.com\" }, { \"email\": \"person2@company.com\" } ] } }", "readOnly": true, "type": "object" }, "containers": { -"description": "Containers associated with the finding. This field provides information for both Kubernetes and non-Kubernetes containers.", "items": { "$ref": "Container" }, "type": "array" }, "createTime": { -"description": "The time at which the finding was created in Security Command Center.", "format": "google-datetime", "type": "string" }, "dataAccessEvents": { -"description": "Data access events associated with the finding.", "items": { "$ref": "DataAccessEvent" }, "type": "array" }, "dataFlowEvents": { -"description": "Data flow events associated with the finding.", "items": { "$ref": "DataFlowEvent" }, "type": "array" }, "dataRetentionDeletionEvents": { -"description": "Data retention deletion events associated with the finding.", "items": { "$ref": "DataRetentionDeletionEvent" }, "type": "array" }, "database": { -"$ref": "Database", -"description": "Database associated with the finding." +"$ref": "Database" }, "description": { -"description": "Contains more details about the finding.", "type": "string" }, "discoveredWorkload": { -"$ref": "DiscoveredWorkload", -"description": "DiscoveredWorkload associated with the finding." +"$ref": "DiscoveredWorkload" }, "disk": { -"$ref": "Disk", -"description": "Disk associated with the finding." +"$ref": "Disk" }, "eventTime": { -"description": "The time the finding was first detected. If an existing finding is updated, then this is the time the update occurred. For example, if the finding represents an open firewall, this property captures the time the detector believes the firewall became open. The accuracy is determined by the detector. If the finding is later resolved, then this time reflects when the finding was resolved. This must not be set to a value greater than the current timestamp.", "format": "google-datetime", "type": "string" }, "exfiltration": { -"$ref": "Exfiltration", -"description": "Represents exfiltrations associated with the finding." +"$ref": "Exfiltration" }, "externalExposure": { -"$ref": "ExternalExposure", -"description": "External exposure associated with the finding." +"$ref": "ExternalExposure" }, "externalSystems": { "additionalProperties": { "$ref": "GoogleCloudSecuritycenterV1ExternalSystem" }, -"description": "Output only. Third party SIEM/SOAR fields within SCC, contains external system information and external system finding fields.", "readOnly": true, "type": "object" }, "externalUri": { -"description": "The URI that, if available, points to a web page outside of Security Command Center where additional information about the finding can be found. This field is guaranteed to be either empty or a well formed URL.", "type": "string" }, "files": { -"description": "File associated with the finding.", "items": { "$ref": "File" }, "type": "array" }, "findingClass": { -"description": "The class of the finding.", "enum": [ "FINDING_CLASS_UNSPECIFIED", "THREAT", @@ -3006,79 +2608,67 @@ false "SECRET" ], "enumDescriptions": [ -"Unspecified finding class.", -"Describes unwanted or malicious activity.", -"Describes a potential weakness in software that increases risk to Confidentiality & Integrity & Availability.", -"Describes a potential weakness in cloud resource/asset configuration that increases risk.", -"Describes a security observation that is for informational purposes.", -"Describes an error that prevents some SCC functionality.", -"Describes a potential security risk due to a change in the security posture.", -"Describes a group of security issues that, when the issues occur together, represent a greater risk than when the issues occur independently. A group of such issues is referred to as a toxic combination.", -"Describes a potential security risk to data assets that contain sensitive data.", -"Describes a resource or resource group where high risk attack paths converge, based on attack path simulations (APS).", -"Describes a potential security risk due to the resource being exposed to the internet.", -"Describes a potential security risk due to plaintext credentials, keys, or tokens being exposed in an asset or workload." +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"" ], "type": "string" }, "groupMemberships": { -"description": "Contains details about groups of which this finding is a member. A group is a collection of findings that are related in some way. This field cannot be updated. Its value is ignored in all update requests.", "items": { "$ref": "GroupMembership" }, "type": "array" }, "iamBindings": { -"description": "Represents IAM bindings associated with the finding.", "items": { "$ref": "IamBinding" }, "type": "array" }, "indicator": { -"$ref": "Indicator", -"description": "Represents what's commonly known as an *indicator of compromise* (IoC) in computer forensics. This is an artifact observed on a network or in an operating system that, with high confidence, indicates a computer intrusion. For more information, see [Indicator of compromise](https://en.wikipedia.org/wiki/Indicator_of_compromise)." +"$ref": "Indicator" }, "ipRules": { -"$ref": "IpRules", -"description": "IP rules associated with the finding." +"$ref": "IpRules" }, "job": { -"$ref": "Job", -"description": "Job associated with the finding." +"$ref": "Job" }, "kernelRootkit": { -"$ref": "KernelRootkit", -"description": "Signature of the kernel rootkit." +"$ref": "KernelRootkit" }, "kubernetes": { -"$ref": "Kubernetes", -"description": "Kubernetes resources associated with the finding." +"$ref": "Kubernetes" }, "loadBalancers": { -"description": "The load balancers associated with the finding.", "items": { "$ref": "LoadBalancer" }, "type": "array" }, "logEntries": { -"description": "Log entries that are relevant to the finding.", "items": { "$ref": "LogEntry" }, "type": "array" }, "mitreAttack": { -"$ref": "MitreAttack", -"description": "MITRE ATT&CK tactics and techniques related to this finding. See: https://attack.mitre.org" +"$ref": "MitreAttack" }, "moduleName": { -"description": "Unique identifier of the module which generated the finding. Example: folders/598186756061/securityHealthAnalyticsSettings/customModules/56799441161885", "type": "string" }, "mute": { -"description": "Indicates the mute state of a finding (either muted, unmuted or undefined). Unlike other attributes of a finding, a finding provider shouldn't set the value of mute.", "enum": [ "MUTE_UNSPECIFIED", "MUTED", @@ -3086,93 +2676,76 @@ false "UNDEFINED" ], "enumDescriptions": [ -"Unspecified.", -"Finding has been muted.", -"Finding has been unmuted.", -"Finding has never been muted/unmuted." +"", +"", +"", +"" ], "type": "string" }, "muteInfo": { "$ref": "MuteInfo", -"description": "Output only. The mute information regarding this finding.", "readOnly": true }, "muteInitiator": { -"description": "Records additional information about the mute operation, for example, the [mute configuration](/security-command-center/docs/how-to-mute-findings) that muted the finding and the user who muted the finding.", "type": "string" }, "muteUpdateTime": { -"description": "Output only. The most recent time this finding was muted or unmuted.", "format": "google-datetime", "readOnly": true, "type": "string" }, "name": { -"description": "The [relative resource name](https://cloud.google.com/apis/design/resource_names#relative_resource_name) of the finding. Example: \"organizations/{organization_id}/sources/{source_id}/findings/{finding_id}\", \"folders/{folder_id}/sources/{source_id}/findings/{finding_id}\", \"projects/{project_id}/sources/{source_id}/findings/{finding_id}\".", "type": "string" }, "networks": { -"description": "Represents the VPC networks that the resource is attached to.", "items": { "$ref": "Network" }, "type": "array" }, "nextSteps": { -"description": "Steps to address the finding.", "type": "string" }, "notebook": { -"$ref": "Notebook", -"description": "Notebook associated with the finding." +"$ref": "Notebook" }, "orgPolicies": { -"description": "Contains information about the org policies associated with the finding.", "items": { "$ref": "OrgPolicy" }, "type": "array" }, "parent": { -"description": "The relative resource name of the source the finding belongs to. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name This field is immutable after creation time. For example: \"organizations/{organization_id}/sources/{source_id}\"", "type": "string" }, "parentDisplayName": { -"description": "Output only. The human readable display name of the finding source such as \"Event Threat Detection\" or \"Security Health Analytics\".", "readOnly": true, "type": "string" }, "policyViolationSummary": { -"$ref": "PolicyViolationSummary", -"description": "PolicyViolationSummary associated with the finding." +"$ref": "PolicyViolationSummary" }, "processes": { -"description": "Represents operating system processes associated with the Finding.", "items": { "$ref": "Process" }, "type": "array" }, "resourceName": { -"description": "For findings on Google Cloud resources, the full resource name of the Google Cloud resource this finding is for. See: https://cloud.google.com/apis/design/resource_names#full_resource_name When the finding is for a non-Google Cloud resource, the resourceName can be a customer or partner defined string. This field is immutable after creation time.", "type": "string" }, "secret": { -"$ref": "Secret", -"description": "Secret associated with the finding." +"$ref": "Secret" }, "securityMarks": { "$ref": "SecurityMarks", -"description": "Output only. User specified security marks. These marks are entirely managed by the user and come from the SecurityMarks resource that belongs to the finding.", "readOnly": true }, "securityPosture": { -"$ref": "SecurityPosture", -"description": "The security posture associated with the finding." +"$ref": "SecurityPosture" }, "severity": { -"description": "The severity of the finding. This field is managed by the source that writes the finding.", "enum": [ "SEVERITY_UNSPECIFIED", "CRITICAL", @@ -3181,11 +2754,11 @@ false "LOW" ], "enumDescriptions": [ -"This value is used for findings when a source doesn't write a severity value.", -"Vulnerability: A critical vulnerability is easily discoverable by an external actor, exploitable, and results in the direct ability to execute arbitrary code, exfiltrate data, and otherwise gain additional access and privileges to cloud resources and workloads. Examples include publicly accessible unprotected user data and public SSH access with weak or no passwords. Threat: Indicates a threat that is able to access, modify, or delete data or execute unauthorized code within existing resources.", -"Vulnerability: A high risk vulnerability can be easily discovered and exploited in combination with other vulnerabilities in order to gain direct access and the ability to execute arbitrary code, exfiltrate data, and otherwise gain additional access and privileges to cloud resources and workloads. An example is a database with weak or no passwords that is only accessible internally. This database could easily be compromised by an actor that had access to the internal network. Threat: Indicates a threat that is able to create new computational resources in an environment but not able to access data or execute code in existing resources.", -"Vulnerability: A medium risk vulnerability could be used by an actor to gain access to resources or privileges that enable them to eventually (through multiple steps or a complex exploit) gain access and the ability to execute arbitrary code or exfiltrate data. An example is a service account with access to more projects than it should have. If an actor gains access to the service account, they could potentially use that access to manipulate a project the service account was not intended to. Threat: Indicates a threat that is able to cause operational impact but may not access data or execute unauthorized code.", -"Vulnerability: A low risk vulnerability hampers a security organization's ability to detect vulnerabilities or active threats in their deployment, or prevents the root cause investigation of security issues. An example is monitoring and logs being disabled for resource configurations and access. Threat: Indicates a threat that has obtained minimal access to an environment but is not able to access data, execute code, or create resources." +"", +"", +"", +"", +"" ], "type": "string" }, @@ -3193,59 +2766,49 @@ false "additionalProperties": { "type": "any" }, -"description": "Source specific properties. These properties are managed by the source that writes the finding. The key names in the source_properties map must be between 1 and 255 characters, and must start with a letter and contain alphanumeric characters or underscores only.", "type": "object" }, "state": { -"description": "The state of the finding.", "enum": [ "STATE_UNSPECIFIED", "ACTIVE", "INACTIVE" ], "enumDescriptions": [ -"Unspecified state.", -"The finding requires attention and has not been addressed yet.", -"The finding has been fixed, triaged as a non-issue or otherwise addressed and is no longer active." +"", +"", +"" ], "type": "string" }, "toxicCombination": { -"$ref": "ToxicCombination", -"description": "Contains details about a group of security issues that, when the issues occur together, represent a greater risk than when the issues occur independently. A group of such issues is referred to as a toxic combination. This field cannot be updated. Its value is ignored in all update requests." +"$ref": "ToxicCombination" }, "vertexAi": { -"$ref": "VertexAi", -"description": "VertexAi associated with the finding." +"$ref": "VertexAi" }, "vulnerability": { -"$ref": "Vulnerability", -"description": "Represents vulnerability-specific fields like CVE and CVSS scores. CVE stands for Common Vulnerabilities and Exposures (https://cve.mitre.org/about/)" +"$ref": "Vulnerability" } }, "type": "object" }, "Folder": { -"description": "Message that contains the resource name and display name of a folder resource.", "id": "Folder", "properties": { "resourceFolder": { -"description": "Full resource name of this folder. See: https://cloud.google.com/apis/design/resource_names#full_resource_name", "type": "string" }, "resourceFolderDisplayName": { -"description": "The user defined display name for this folder.", "type": "string" } }, "type": "object" }, "Framework": { -"description": "Compliance framework associated with the finding.", "id": "Framework", "properties": { "category": { -"description": "Category of the framework associated with the finding. E.g. Security Benchmark, or Assured Workloads", "items": { "enum": [ "FRAMEWORK_CATEGORY_UNSPECIFIED", @@ -3256,43 +2819,39 @@ false "CUSTOM_FRAMEWORK" ], "enumDescriptions": [ -"Default value. This value is unused.", -"Security Benchmarks framework", -"Assured Workloads framework", -"Data Security framework", -"Google Best Practices framework", -"A user-created framework" +"", +"", +"", +"", +"", +"" ], "type": "string" }, "type": "array" }, "controls": { -"description": "The controls associated with the framework.", "items": { "$ref": "Control" }, "type": "array" }, "displayName": { -"description": "Display name of the framework. For a standard framework, this will look like e.g. PCI DSS 3.2.1, whereas for a custom framework it can be a user defined string like MyFramework", "type": "string" }, "name": { -"description": "Name of the framework associated with the finding", "type": "string" }, "type": { -"description": "Type of the framework associated with the finding, to specify whether the framework is built-in (pre-defined and immutable) or a custom framework defined by the customer (equivalent to security posture)", "enum": [ "FRAMEWORK_TYPE_UNSPECIFIED", "FRAMEWORK_TYPE_BUILT_IN", "FRAMEWORK_TYPE_CUSTOM" ], "enumDescriptions": [ -"Default value. This value is unused.", -"The framework is a built-in framework if it is created and managed by GCP.", -"The framework is a custom framework if it is created and managed by the user." +"", +"", +"" ], "type": "string" } @@ -3300,11 +2859,9 @@ false "type": "object" }, "GcpMetadata": { -"description": "Google Cloud metadata associated with the resource. Only applicable if the finding's cloud provider is Google Cloud.", "id": "GcpMetadata", "properties": { "folders": { -"description": "Output only. Contains a Folder message for each folder in the assets ancestry. The first folder is the deepest nested folder, and the last folder is the folder directly under the Organization.", "items": { "$ref": "GoogleCloudSecuritycenterV2Folder" }, @@ -3312,56 +2869,45 @@ false "type": "array" }, "organization": { -"description": "The name of the organization that the resource belongs to.", "type": "string" }, "parent": { -"description": "The full resource name of resource's parent.", "type": "string" }, "parentDisplayName": { -"description": "The human readable name of resource's parent.", "type": "string" }, "project": { -"description": "The full resource name of project that the resource belongs to.", "type": "string" }, "projectDisplayName": { -"description": "The project ID that the resource belongs to.", "type": "string" } }, "type": "object" }, "Geolocation": { -"description": "Represents a geographical location for a given access.", "id": "Geolocation", "properties": { "regionCode": { -"description": "A CLDR.", "type": "string" } }, "type": "object" }, "GetIamPolicyRequest": { -"description": "Request message for `GetIamPolicy` method.", "id": "GetIamPolicyRequest", "properties": { "options": { -"$ref": "GetPolicyOptions", -"description": "OPTIONAL: A `GetPolicyOptions` object for specifying options to `GetIamPolicy`." +"$ref": "GetPolicyOptions" } }, "type": "object" }, "GetPolicyOptions": { -"description": "Encapsulates settings provided to GetIamPolicy.", "id": "GetPolicyOptions", "properties": { "requestedPolicyVersion": { -"description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", "format": "int32", "type": "integer" } @@ -3369,43 +2915,34 @@ false "type": "object" }, "GoogleCloudSecuritycenterV1BigQueryExport": { -"description": "Configures how to deliver Findings to BigQuery Instance.", "id": "GoogleCloudSecuritycenterV1BigQueryExport", "properties": { "createTime": { -"description": "Output only. The time at which the BigQuery export was created. This field is set by the server and will be ignored if provided on export on creation.", "format": "google-datetime", "readOnly": true, "type": "string" }, "dataset": { -"description": "The dataset to write findings' updates to. Its format is \"projects/[project_id]/datasets/[bigquery_dataset_id]\". BigQuery Dataset unique ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_).", "type": "string" }, "description": { -"description": "The description of the export (max of 1024 characters).", "type": "string" }, "filter": { -"description": "Expression that defines the filter to apply across create/update events of findings. The expression is a list of zero or more restrictions combined via logical operators `AND` and `OR`. Parentheses are supported, and `OR` has higher precedence than `AND`. Restrictions have the form ` ` and may have a `-` character in front of them to indicate negation. The fields map to those defined in the corresponding resource. The supported operators are: * `=` for all value types. * `>`, `<`, `>=`, `<=` for integer values. * `:`, meaning substring matching, for strings. The supported value types are: * string literals in quotes. * integer literals without quotes. * boolean literals `true` and `false` without quotes.", "type": "string" }, "mostRecentEditor": { -"description": "Output only. Email address of the user who last edited the BigQuery export. This field is set by the server and will be ignored if provided on export creation or update.", "readOnly": true, "type": "string" }, "name": { -"description": "The relative resource name of this export. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name. Example format: \"organizations/{organization_id}/bigQueryExports/{export_id}\" Example format: \"folders/{folder_id}/bigQueryExports/{export_id}\" Example format: \"projects/{project_id}/bigQueryExports/{export_id}\" This field is provided in responses, and is ignored when provided in create requests.", "type": "string" }, "principal": { -"description": "Output only. The service account that needs permission to create table and upload data to the BigQuery dataset.", "readOnly": true, "type": "string" }, "updateTime": { -"description": "Output only. The most recent time at which the BigQuery export was updated. This field is set by the server and will be ignored if provided on export creation or update.", "format": "google-datetime", "readOnly": true, "type": "string" @@ -3414,23 +2951,18 @@ false "type": "object" }, "GoogleCloudSecuritycenterV1Binding": { -"description": "Represents a Kubernetes RoleBinding or ClusterRoleBinding.", "id": "GoogleCloudSecuritycenterV1Binding", "properties": { "name": { -"description": "Name for the binding.", "type": "string" }, "ns": { -"description": "Namespace for the binding.", "type": "string" }, "role": { -"$ref": "Role", -"description": "The Role or ClusterRole referenced by the binding." +"$ref": "Role" }, "subjects": { -"description": "Represents one or more subjects that are bound to the role. Not always available for PATCH requests.", "items": { "$ref": "Subject" }, @@ -3440,37 +2972,29 @@ false "type": "object" }, "GoogleCloudSecuritycenterV1BulkMuteFindingsResponse": { -"description": "The response to a BulkMute request. Contains the LRO information.", "id": "GoogleCloudSecuritycenterV1BulkMuteFindingsResponse", "properties": {}, "type": "object" }, "GoogleCloudSecuritycenterV1CustomConfig": { -"description": "Defines the properties in a custom module configuration for Security Health Analytics. Use the custom module configuration to create custom detectors that generate custom findings for resources that you specify.", "id": "GoogleCloudSecuritycenterV1CustomConfig", "properties": { "customOutput": { -"$ref": "GoogleCloudSecuritycenterV1CustomOutputSpec", -"description": "Custom output properties." +"$ref": "GoogleCloudSecuritycenterV1CustomOutputSpec" }, "description": { -"description": "Text that describes the vulnerability or misconfiguration that the custom module detects. This explanation is returned with each finding instance to help investigators understand the detected issue. The text must be enclosed in quotation marks.", "type": "string" }, "predicate": { -"$ref": "Expr", -"description": "The CEL expression to evaluate to produce findings. When the expression evaluates to true against a resource, a finding is generated." +"$ref": "Expr" }, "recommendation": { -"description": "An explanation of the recommended steps that security teams can take to resolve the detected issue. This explanation is returned with each finding generated by this module in the `nextSteps` property of the finding JSON.", "type": "string" }, "resourceSelector": { -"$ref": "GoogleCloudSecuritycenterV1ResourceSelector", -"description": "The resource types that the custom module operates on. Each custom module can specify up to 5 resource types." +"$ref": "GoogleCloudSecuritycenterV1ResourceSelector" }, "severity": { -"description": "The severity to assign to findings generated by the module.", "enum": [ "SEVERITY_UNSPECIFIED", "CRITICAL", @@ -3479,11 +3003,11 @@ false "LOW" ], "enumDescriptions": [ -"Unspecified severity.", -"Critical severity.", -"High severity.", -"Medium severity.", -"Low severity." +"", +"", +"", +"", +"" ], "type": "string" } @@ -3491,11 +3015,9 @@ false "type": "object" }, "GoogleCloudSecuritycenterV1CustomOutputSpec": { -"description": "A set of optional name-value pairs that define custom source properties to return with each finding that is generated by the custom module. The custom source properties that are defined here are included in the finding JSON under `sourceProperties`.", "id": "GoogleCloudSecuritycenterV1CustomOutputSpec", "properties": { "properties": { -"description": "A list of custom output properties to add to the finding.", "items": { "$ref": "GoogleCloudSecuritycenterV1Property" }, @@ -3505,11 +3027,9 @@ false "type": "object" }, "GoogleCloudSecuritycenterV1EffectiveSecurityHealthAnalyticsCustomModule": { -"description": "An EffectiveSecurityHealthAnalyticsCustomModule is the representation of a Security Health Analytics custom module at a specified level of the resource hierarchy: organization, folder, or project. If a custom module is inherited from a parent organization or folder, the value of the `enablementState` property in EffectiveSecurityHealthAnalyticsCustomModule is set to the value that is effective in the parent, instead of `INHERITED`. For example, if the module is enabled in a parent organization or folder, the effective enablement_state for the module in all child folders or projects is also `enabled`. EffectiveSecurityHealthAnalyticsCustomModule is read-only.", "id": "GoogleCloudSecuritycenterV1EffectiveSecurityHealthAnalyticsCustomModule", "properties": { "cloudProvider": { -"description": "The cloud provider of the custom module.", "enum": [ "CLOUD_PROVIDER_UNSPECIFIED", "GOOGLE_CLOUD_PLATFORM", @@ -3517,40 +3037,36 @@ false "MICROSOFT_AZURE" ], "enumDescriptions": [ -"Unspecified cloud provider.", -"Google Cloud.", -"Amazon Web Services.", -"Microsoft Azure." +"", +"", +"", +"" ], "type": "string" }, "customConfig": { "$ref": "GoogleCloudSecuritycenterV1CustomConfig", -"description": "Output only. The user-specified configuration for the module.", "readOnly": true }, "displayName": { -"description": "Output only. The display name for the custom module. The name must be between 1 and 128 characters, start with a lowercase letter, and contain alphanumeric characters or underscores only.", "readOnly": true, "type": "string" }, "enablementState": { -"description": "Output only. The effective state of enablement for the module at the given level of the hierarchy.", "enum": [ "ENABLEMENT_STATE_UNSPECIFIED", "ENABLED", "DISABLED" ], "enumDescriptions": [ -"Unspecified enablement state.", -"The module is enabled at the given level.", -"The module is disabled at the given level." +"", +"", +"" ], "readOnly": true, "type": "string" }, "name": { -"description": "Output only. The resource name of the custom module. Its format is \"organizations/{organization}/securityHealthAnalyticsSettings/effectiveCustomModules/{customModule}\", or \"folders/{folder}/securityHealthAnalyticsSettings/effectiveCustomModules/{customModule}\", or \"projects/{project}/securityHealthAnalyticsSettings/effectiveCustomModules/{customModule}\"", "readOnly": true, "type": "string" } @@ -3558,116 +3074,94 @@ false "type": "object" }, "GoogleCloudSecuritycenterV1ExternalSystem": { -"description": "Representation of third party SIEM/SOAR fields within SCC.", "id": "GoogleCloudSecuritycenterV1ExternalSystem", "properties": { "assignees": { -"description": "References primary/secondary etc assignees in the external system.", "items": { "type": "string" }, "type": "array" }, "caseCloseTime": { -"description": "The time when the case was closed, as reported by the external system.", "format": "google-datetime", "type": "string" }, "caseCreateTime": { -"description": "The time when the case was created, as reported by the external system.", "format": "google-datetime", "type": "string" }, "casePriority": { -"description": "The priority of the finding's corresponding case in the external system.", "type": "string" }, "caseSla": { -"description": "The SLA of the finding's corresponding case in the external system.", "format": "google-datetime", "type": "string" }, "caseUri": { -"description": "The link to the finding's corresponding case in the external system.", "type": "string" }, "externalSystemUpdateTime": { -"description": "The time when the case was last updated, as reported by the external system.", "format": "google-datetime", "type": "string" }, "externalUid": { -"description": "The identifier that's used to track the finding's corresponding case in the external system.", "type": "string" }, "name": { -"description": "Full resource name of the external system, for example: \"organizations/1234/sources/5678/findings/123456/externalSystems/jira\", \"folders/1234/sources/5678/findings/123456/externalSystems/jira\", \"projects/1234/sources/5678/findings/123456/externalSystems/jira\"", "type": "string" }, "status": { -"description": "The most recent status of the finding's corresponding case, as reported by the external system.", "type": "string" }, "ticketInfo": { -"$ref": "TicketInfo", -"description": "Information about the ticket, if any, that is being used to track the resolution of the issue that is identified by this finding." +"$ref": "TicketInfo" } }, "type": "object" }, "GoogleCloudSecuritycenterV1MuteConfig": { -"description": "A mute config is a Cloud SCC resource that contains the configuration to mute create/update events of findings.", "id": "GoogleCloudSecuritycenterV1MuteConfig", "properties": { "createTime": { -"description": "Output only. The time at which the mute config was created. This field is set by the server and will be ignored if provided on config creation.", "format": "google-datetime", "readOnly": true, "type": "string" }, "description": { -"description": "A description of the mute config.", "type": "string" }, "displayName": { "deprecated": true, -"description": "The human readable name to be displayed for the mute config.", "type": "string" }, "expiryTime": { -"description": "Optional. The expiry of the mute config. Only applicable for dynamic configs. If the expiry is set, when the config expires, it is removed from all findings.", "format": "google-datetime", "type": "string" }, "filter": { -"description": "Required. An expression that defines the filter to apply across create/update events of findings. While creating a filter string, be mindful of the scope in which the mute configuration is being created. E.g., If a filter contains project = X but is created under the project = Y scope, it might not match any findings. The following field and operator combinations are supported: * severity: `=`, `:` * category: `=`, `:` * resource.name: `=`, `:` * resource.project_name: `=`, `:` * resource.project_display_name: `=`, `:` * resource.folders.resource_folder: `=`, `:` * resource.parent_name: `=`, `:` * resource.parent_display_name: `=`, `:` * resource.type: `=`, `:` * finding_class: `=`, `:` * indicator.ip_addresses: `=`, `:` * indicator.domains: `=`, `:`", "type": "string" }, "mostRecentEditor": { -"description": "Output only. Email address of the user who last edited the mute config. This field is set by the server and will be ignored if provided on config creation or update.", "readOnly": true, "type": "string" }, "name": { -"description": "This field will be ignored if provided on config creation. Format `organizations/{organization}/muteConfigs/{mute_config}` `folders/{folder}/muteConfigs/{mute_config}` `projects/{project}/muteConfigs/{mute_config}` `organizations/{organization}/locations/global/muteConfigs/{mute_config}` `folders/{folder}/locations/global/muteConfigs/{mute_config}` `projects/{project}/locations/global/muteConfigs/{mute_config}`", "type": "string" }, "type": { -"description": "Optional. The type of the mute config, which determines what type of mute state the config affects. The static mute state takes precedence over the dynamic mute state. Immutable after creation. STATIC by default if not set during creation.", "enum": [ "MUTE_CONFIG_TYPE_UNSPECIFIED", "STATIC", "DYNAMIC" ], "enumDescriptions": [ -"Unused.", -"A static mute config, which sets the static mute state of future matching findings to muted. Once the static mute state has been set, finding or config modifications will not affect the state.", -"A dynamic mute config, which is applied to existing and future matching findings, setting their dynamic mute state to \"muted\". If the config is updated or deleted, or a matching finding is updated, such that the finding doesn't match the config, the config will be removed from the finding, and the finding's dynamic mute state may become \"unmuted\" (unless other configs still match)." +"", +"", +"" ], "type": "string" }, "updateTime": { -"description": "Output only. The most recent time at which the mute config was updated. This field is set by the server and will be ignored if provided on config creation or update.", "format": "google-datetime", "readOnly": true, "type": "string" @@ -3676,69 +3170,54 @@ false "type": "object" }, "GoogleCloudSecuritycenterV1NotificationMessage": { -"description": "Cloud SCC's Notification", "id": "GoogleCloudSecuritycenterV1NotificationMessage", "properties": { "finding": { -"$ref": "Finding", -"description": "If it's a Finding based notification config, this field will be populated." +"$ref": "Finding" }, "notificationConfigName": { -"description": "Name of the notification config that generated current notification.", "type": "string" }, "resource": { -"$ref": "GoogleCloudSecuritycenterV1Resource", -"description": "The Cloud resource tied to this notification's Finding." +"$ref": "GoogleCloudSecuritycenterV1Resource" } }, "type": "object" }, "GoogleCloudSecuritycenterV1Property": { -"description": "An individual name-value pair that defines a custom source property.", "id": "GoogleCloudSecuritycenterV1Property", "properties": { "name": { -"description": "Name of the property for the custom output.", "type": "string" }, "valueExpression": { -"$ref": "Expr", -"description": "The CEL expression for the custom output. A resource property can be specified to return the value of the property or a text string enclosed in quotation marks." +"$ref": "Expr" } }, "type": "object" }, "GoogleCloudSecuritycenterV1Resource": { -"description": "Information related to the Google Cloud resource.", "id": "GoogleCloudSecuritycenterV1Resource", "properties": { "adcApplication": { -"$ref": "AdcApplication", -"description": "The ADC application associated with the finding." +"$ref": "AdcApplication" }, "adcApplicationTemplate": { -"$ref": "AdcApplicationTemplateRevision", -"description": "The ADC template associated with the finding." +"$ref": "AdcApplicationTemplateRevision" }, "adcSharedTemplate": { -"$ref": "AdcSharedTemplateRevision", -"description": "The ADC shared template associated with the finding." +"$ref": "AdcSharedTemplateRevision" }, "application": { -"$ref": "GoogleCloudSecuritycenterV1ResourceApplication", -"description": "The App Hub application this resource belongs to." +"$ref": "GoogleCloudSecuritycenterV1ResourceApplication" }, "awsMetadata": { -"$ref": "AwsMetadata", -"description": "The AWS metadata associated with the finding." +"$ref": "AwsMetadata" }, "azureMetadata": { -"$ref": "AzureMetadata", -"description": "The Azure metadata associated with the finding." +"$ref": "AzureMetadata" }, "cloudProvider": { -"description": "Indicates which cloud provider the resource resides in.", "enum": [ "CLOUD_PROVIDER_UNSPECIFIED", "GOOGLE_CLOUD_PLATFORM", @@ -3746,19 +3225,17 @@ false "MICROSOFT_AZURE" ], "enumDescriptions": [ -"The cloud provider is unspecified.", -"The cloud provider is Google Cloud.", -"The cloud provider is Amazon Web Services.", -"The cloud provider is Microsoft Azure." +"", +"", +"", +"" ], "type": "string" }, "displayName": { -"description": "The human readable name of the resource.", "type": "string" }, "folders": { -"description": "Output only. Contains a Folder message for each folder in the assets ancestry. The first folder is the deepest nested folder, and the last folder is the folder directly under the Organization.", "items": { "$ref": "Folder" }, @@ -3766,95 +3243,75 @@ false "type": "array" }, "location": { -"description": "The region or location of the service (if applicable).", "type": "string" }, "name": { -"description": "The full resource name of the resource. See: https://cloud.google.com/apis/design/resource_names#full_resource_name", "type": "string" }, "organization": { -"description": "Indicates which organization or tenant in the cloud provider the finding applies to.", "type": "string" }, "parent": { -"description": "The full resource name of resource's parent.", "type": "string" }, "parentDisplayName": { -"description": "The human readable name of resource's parent.", "type": "string" }, "project": { -"description": "The full resource name of project that the resource belongs to.", "type": "string" }, "projectDisplayName": { -"description": "The project ID that the resource belongs to.", "type": "string" }, "resourcePath": { -"$ref": "ResourcePath", -"description": "Provides the path to the resource within the resource hierarchy." +"$ref": "ResourcePath" }, "resourcePathString": { -"description": "A string representation of the resource path. For Google Cloud, it has the format of `organizations/{organization_id}/folders/{folder_id}/folders/{folder_id}/projects/{project_id}` where there can be any number of folders. For AWS, it has the format of `org/{organization_id}/ou/{organizational_unit_id}/ou/{organizational_unit_id}/account/{account_id}` where there can be any number of organizational units. For Azure, it has the format of `mg/{management_group_id}/mg/{management_group_id}/subscription/{subscription_id}/rg/{resource_group_name}` where there can be any number of management groups.", "type": "string" }, "service": { -"description": "The parent service or product from which the resource is provided, for example, GKE or SNS.", "type": "string" }, "type": { -"description": "The full resource type of the resource.", "type": "string" } }, "type": "object" }, "GoogleCloudSecuritycenterV1ResourceApplication": { -"description": "The App Hub Application associated with the finding's resource.", "id": "GoogleCloudSecuritycenterV1ResourceApplication", "properties": { "attributes": { -"$ref": "GoogleCloudSecuritycenterV1ResourceApplicationAttributes", -"description": "Consumer provided attributes for the application" +"$ref": "GoogleCloudSecuritycenterV1ResourceApplicationAttributes" }, "name": { -"description": "The resource name of an Application. Format: `projects/{host-project-id}/locations/{location}/applications/{application-id}`", "type": "string" } }, "type": "object" }, "GoogleCloudSecuritycenterV1ResourceApplicationAttributes": { -"description": "Consumer provided attributes for the application", "id": "GoogleCloudSecuritycenterV1ResourceApplicationAttributes", "properties": { "businessOwners": { -"description": "Business team that ensures user needs are met and value is delivered", "items": { "$ref": "GoogleCloudSecuritycenterV1ResourceApplicationAttributesContactInfo" }, "type": "array" }, "criticality": { -"$ref": "GoogleCloudSecuritycenterV1ResourceApplicationAttributesCriticality", -"description": "User-defined criticality information." +"$ref": "GoogleCloudSecuritycenterV1ResourceApplicationAttributesCriticality" }, "developerOwners": { -"description": "Developer team that owns development and coding.", "items": { "$ref": "GoogleCloudSecuritycenterV1ResourceApplicationAttributesContactInfo" }, "type": "array" }, "environment": { -"$ref": "GoogleCloudSecuritycenterV1ResourceApplicationAttributesEnvironment", -"description": "User-defined environment information." +"$ref": "GoogleCloudSecuritycenterV1ResourceApplicationAttributesEnvironment" }, "operatorOwners": { -"description": "Operator team that ensures runtime and operations.", "items": { "$ref": "GoogleCloudSecuritycenterV1ResourceApplicationAttributesContactInfo" }, @@ -3864,22 +3321,18 @@ false "type": "object" }, "GoogleCloudSecuritycenterV1ResourceApplicationAttributesContactInfo": { -"description": "Contact information of stakeholders.", "id": "GoogleCloudSecuritycenterV1ResourceApplicationAttributesContactInfo", "properties": { "email": { -"description": "Email address of the contacts.", "type": "string" } }, "type": "object" }, "GoogleCloudSecuritycenterV1ResourceApplicationAttributesCriticality": { -"description": "Criticality of the Application, Service, or Workload", "id": "GoogleCloudSecuritycenterV1ResourceApplicationAttributesCriticality", "properties": { "type": { -"description": "Criticality Type.", "enum": [ "CRITICALITY_TYPE_UNSPECIFIED", "MISSION_CRITICAL", @@ -3888,11 +3341,11 @@ false "LOW" ], "enumDescriptions": [ -"Unspecified type.", -"Mission critical service, application or workload.", -"High impact.", -"Medium impact.", -"Low impact." +"", +"", +"", +"", +"" ], "type": "string" } @@ -3900,11 +3353,9 @@ false "type": "object" }, "GoogleCloudSecuritycenterV1ResourceApplicationAttributesEnvironment": { -"description": "Environment of the Application, Service, or Workload", "id": "GoogleCloudSecuritycenterV1ResourceApplicationAttributesEnvironment", "properties": { "type": { -"description": "Environment Type.", "enum": [ "ENVIRONMENT_TYPE_UNSPECIFIED", "PRODUCTION", @@ -3913,11 +3364,11 @@ false "DEVELOPMENT" ], "enumDescriptions": [ -"Unspecified type.", -"Production environment.", -"Staging environment.", -"Test environment.", -"Development environment." +"", +"", +"", +"", +"" ], "type": "string" } @@ -3925,11 +3376,9 @@ false "type": "object" }, "GoogleCloudSecuritycenterV1ResourceSelector": { -"description": "Resource for selecting resource type.", "id": "GoogleCloudSecuritycenterV1ResourceSelector", "properties": { "resourceTypes": { -"description": "The resource types to run the detector on.", "items": { "type": "string" }, @@ -3939,11 +3388,9 @@ false "type": "object" }, "GoogleCloudSecuritycenterV1ResourceValueConfig": { -"description": "A resource value configuration (RVC) is a mapping configuration of user's resources to resource values. Used in Attack path simulations.", "id": "GoogleCloudSecuritycenterV1ResourceValueConfig", "properties": { "cloudProvider": { -"description": "Cloud provider this configuration applies to", "enum": [ "CLOUD_PROVIDER_UNSPECIFIED", "GOOGLE_CLOUD_PLATFORM", @@ -3951,40 +3398,34 @@ false "MICROSOFT_AZURE" ], "enumDescriptions": [ -"The cloud provider is unspecified.", -"The cloud provider is Google Cloud.", -"The cloud provider is Amazon Web Services.", -"The cloud provider is Microsoft Azure." +"", +"", +"", +"" ], "type": "string" }, "createTime": { -"description": "Output only. Timestamp this resource value configuration was created.", "format": "google-datetime", "readOnly": true, "type": "string" }, "description": { -"description": "Description of the resource value configuration.", "type": "string" }, "name": { -"description": "Name for the resource value configuration", "type": "string" }, "resourceLabelsSelector": { "additionalProperties": { "type": "string" }, -"description": "List of resource labels to search for, evaluated with `AND`. For example, `\"resource_labels_selector\": {\"key\": \"value\", \"env\": \"prod\"}` will match resources with labels \"key\": \"value\" `AND` \"env\": \"prod\" https://cloud.google.com/resource-manager/docs/creating-managing-labels", "type": "object" }, "resourceType": { -"description": "Apply resource_value only to resources that match resource_type. resource_type will be checked with `AND` of other resources. For example, \"storage.googleapis.com/Bucket\" with resource_value \"HIGH\" will apply \"HIGH\" value only to \"storage.googleapis.com/Bucket\" resources.", "type": "string" }, "resourceValue": { -"description": "Required. Resource value level this expression represents", "enum": [ "RESOURCE_VALUE_UNSPECIFIED", "HIGH", @@ -3993,31 +3434,27 @@ false "NONE" ], "enumDescriptions": [ -"Unspecific value", -"High resource value", -"Medium resource value", -"Low resource value", -"No resource value, e.g. ignore these resources" +"", +"", +"", +"", +"" ], "type": "string" }, "scope": { -"description": "Project or folder to scope this configuration to. For example, \"project/456\" would apply this configuration only to resources in \"project/456\" scope will be checked with `AND` of other resources.", "type": "string" }, "sensitiveDataProtectionMapping": { -"$ref": "GoogleCloudSecuritycenterV1SensitiveDataProtectionMapping", -"description": "A mapping of the sensitivity on Sensitive Data Protection finding to resource values. This mapping can only be used in combination with a resource_type that is related to BigQuery, e.g. \"bigquery.googleapis.com/Dataset\"." +"$ref": "GoogleCloudSecuritycenterV1SensitiveDataProtectionMapping" }, "tagValues": { -"description": "Required. Tag values combined with `AND` to check against. For Google Cloud resources, they are tag value IDs in the form of \"tagValues/123\". Example: `[ \"tagValues/123\", \"tagValues/456\", \"tagValues/789\" ]` https://cloud.google.com/resource-manager/docs/tags/tags-creating-and-managing", "items": { "type": "string" }, "type": "array" }, "updateTime": { -"description": "Output only. Timestamp this resource value configuration was last updated.", "format": "google-datetime", "readOnly": true, "type": "string" @@ -4026,16 +3463,13 @@ false "type": "object" }, "GoogleCloudSecuritycenterV1RunAssetDiscoveryResponse": { -"description": "Response of asset discovery run", "id": "GoogleCloudSecuritycenterV1RunAssetDiscoveryResponse", "properties": { "duration": { -"description": "The duration between asset discovery run start and end", "format": "google-duration", "type": "string" }, "state": { -"description": "The state of an asset discovery run.", "enum": [ "STATE_UNSPECIFIED", "COMPLETED", @@ -4043,10 +3477,10 @@ false "TERMINATED" ], "enumDescriptions": [ -"Asset discovery run state was unspecified.", -"Asset discovery run completed successfully.", -"Asset discovery run was cancelled with tasks still pending, as another run for the same organization was started with a higher priority.", -"Asset discovery run was killed and terminated." +"", +"", +"", +"" ], "type": "string" } @@ -4054,16 +3488,13 @@ false "type": "object" }, "GoogleCloudSecuritycenterV1SecurityHealthAnalyticsCustomModule": { -"description": "Represents an instance of a Security Health Analytics custom module, including its full module name, display name, enablement state, and last updated time. You can create a custom module at the organization, folder, or project level. Custom modules that you create at the organization or folder level are inherited by the child folders and projects.", "id": "GoogleCloudSecuritycenterV1SecurityHealthAnalyticsCustomModule", "properties": { "ancestorModule": { -"description": "Output only. If empty, indicates that the custom module was created in the organization, folder, or project in which you are viewing the custom module. Otherwise, `ancestor_module` specifies the organization or folder from which the custom module is inherited.", "readOnly": true, "type": "string" }, "cloudProvider": { -"description": "The cloud provider of the custom module.", "enum": [ "CLOUD_PROVIDER_UNSPECIFIED", "GOOGLE_CLOUD_PLATFORM", @@ -4071,23 +3502,20 @@ false "MICROSOFT_AZURE" ], "enumDescriptions": [ -"Unspecified cloud provider.", -"Google Cloud.", -"Amazon Web Services (AWS).", -"Microsoft Azure." +"", +"", +"", +"" ], "type": "string" }, "customConfig": { -"$ref": "GoogleCloudSecuritycenterV1CustomConfig", -"description": "The user specified custom configuration for the module." +"$ref": "GoogleCloudSecuritycenterV1CustomConfig" }, "displayName": { -"description": "The display name of the Security Health Analytics custom module. This display name becomes the finding category for all findings that are returned by this custom module. The display name must be between 1 and 128 characters, start with a lowercase letter, and contain alphanumeric characters or underscores only.", "type": "string" }, "enablementState": { -"description": "The enablement state of the custom module.", "enum": [ "ENABLEMENT_STATE_UNSPECIFIED", "ENABLED", @@ -4095,24 +3523,21 @@ false "INHERITED" ], "enumDescriptions": [ -"Unspecified enablement state.", -"The module is enabled at the given CRM resource.", -"The module is disabled at the given CRM resource.", -"State is inherited from an ancestor module. The module will either be effectively ENABLED or DISABLED based on its closest non-inherited ancestor module in the CRM hierarchy." +"", +"", +"", +"" ], "type": "string" }, "lastEditor": { -"description": "Output only. The editor that last updated the custom module.", "readOnly": true, "type": "string" }, "name": { -"description": "Immutable. The resource name of the custom module. Its format is \"organizations/{organization}/securityHealthAnalyticsSettings/customModules/{customModule}\", or \"folders/{folder}/securityHealthAnalyticsSettings/customModules/{customModule}\", or \"projects/{project}/securityHealthAnalyticsSettings/customModules/{customModule}\" The id {customModule} is server-generated and is not user settable. It will be a numeric id containing 1-20 digits.", "type": "string" }, "updateTime": { -"description": "Output only. The time at which the custom module was last updated.", "format": "google-datetime", "readOnly": true, "type": "string" @@ -4121,11 +3546,9 @@ false "type": "object" }, "GoogleCloudSecuritycenterV1SensitiveDataProtectionMapping": { -"description": "Resource value mapping for Sensitive Data Protection findings. If any of these mappings have a resource value that is not unspecified, the resource_value field will be ignored when reading this configuration.", "id": "GoogleCloudSecuritycenterV1SensitiveDataProtectionMapping", "properties": { "highSensitivityMapping": { -"description": "Resource value mapping for high-sensitivity Sensitive Data Protection findings", "enum": [ "RESOURCE_VALUE_UNSPECIFIED", "HIGH", @@ -4134,16 +3557,15 @@ false "NONE" ], "enumDescriptions": [ -"Unspecific value", -"High resource value", -"Medium resource value", -"Low resource value", -"No resource value, e.g. ignore these resources" +"", +"", +"", +"", +"" ], "type": "string" }, "mediumSensitivityMapping": { -"description": "Resource value mapping for medium-sensitivity Sensitive Data Protection findings", "enum": [ "RESOURCE_VALUE_UNSPECIFIED", "HIGH", @@ -4152,11 +3574,11 @@ false "NONE" ], "enumDescriptions": [ -"Unspecific value", -"High resource value", -"Medium resource value", -"Low resource value", -"No resource value, e.g. ignore these resources" +"", +"", +"", +"", +"" ], "type": "string" } @@ -4164,62 +3586,51 @@ false "type": "object" }, "GoogleCloudSecuritycenterV1beta1Finding": { -"description": "Security Command Center finding. A finding is a record of assessment data (security, risk, health or privacy) ingested into Security Command Center for presentation, notification, analysis, policy testing, and enforcement. For example, an XSS vulnerability in an App Engine application is a finding.", "id": "GoogleCloudSecuritycenterV1beta1Finding", "properties": { "category": { -"description": "The additional taxonomy group within findings from a given source. This field is immutable after creation time. Example: \"XSS_FLASH_INJECTION\"", "type": "string" }, "createTime": { -"description": "The time at which the finding was created in Security Command Center.", "format": "google-datetime", "type": "string" }, "eventTime": { -"description": "The time at which the event took place, or when an update to the finding occurred. For example, if the finding represents an open firewall it would capture the time the detector believes the firewall became open. The accuracy is determined by the detector. If the finding were to be resolved afterward, this time would reflect when the finding was resolved.", "format": "google-datetime", "type": "string" }, "externalUri": { -"description": "The URI that, if available, points to a web page outside of Security Command Center where additional information about the finding can be found. This field is guaranteed to be either empty or a well formed URL.", "type": "string" }, "name": { -"description": "The relative resource name of this finding. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Example: \"organizations/{organization_id}/sources/{source_id}/findings/{finding_id}\"", "type": "string" }, "parent": { -"description": "Immutable. The relative resource name of the source the finding belongs to. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name This field is immutable after creation time. For example: \"organizations/{organization_id}/sources/{source_id}\"", "type": "string" }, "resourceName": { -"description": "For findings on Google Cloud resources, the full resource name of the Google Cloud resource this finding is for. See: https://cloud.google.com/apis/design/resource_names#full_resource_name When the finding is for a non-Google Cloud resource, the resourceName can be a customer or partner defined string. This field is immutable after creation time.", "type": "string" }, "securityMarks": { "$ref": "GoogleCloudSecuritycenterV1beta1SecurityMarks", -"description": "Output only. User specified security marks. These marks are entirely managed by the user and come from the SecurityMarks resource that belongs to the finding.", "readOnly": true }, "sourceProperties": { "additionalProperties": { "type": "any" }, -"description": "Source specific properties. These properties are managed by the source that writes the finding. The key names in the source_properties map must be between 1 and 255 characters, and must start with a letter and contain alphanumeric characters or underscores only.", "type": "object" }, "state": { -"description": "The state of the finding.", "enum": [ "STATE_UNSPECIFIED", "ACTIVE", "INACTIVE" ], "enumDescriptions": [ -"Unspecified state.", -"The finding requires attention and has not been addressed yet.", -"The finding has been fixed, triaged as a non-issue or otherwise addressed and is no longer active." +"", +"", +"" ], "type": "string" } @@ -4227,16 +3638,13 @@ false "type": "object" }, "GoogleCloudSecuritycenterV1beta1RunAssetDiscoveryResponse": { -"description": "Response of asset discovery run", "id": "GoogleCloudSecuritycenterV1beta1RunAssetDiscoveryResponse", "properties": { "duration": { -"description": "The duration between asset discovery run start and end", "format": "google-duration", "type": "string" }, "state": { -"description": "The state of an asset discovery run.", "enum": [ "STATE_UNSPECIFIED", "COMPLETED", @@ -4244,10 +3652,10 @@ false "TERMINATED" ], "enumDescriptions": [ -"Asset discovery run state was unspecified.", -"Asset discovery run completed successfully.", -"Asset discovery run was cancelled with tasks still pending, as another run for the same organization was started with a higher priority.", -"Asset discovery run was killed and terminated." +"", +"", +"", +"" ], "type": "string" } @@ -4255,68 +3663,54 @@ false "type": "object" }, "GoogleCloudSecuritycenterV1beta1SecurityMarks": { -"description": "User specified security marks that are attached to the parent Security Command Center resource. Security marks are scoped within a Security Command Center organization -- they can be modified and viewed by all users who have proper permissions on the organization.", "id": "GoogleCloudSecuritycenterV1beta1SecurityMarks", "properties": { "marks": { "additionalProperties": { "type": "string" }, -"description": "Mutable user specified security marks belonging to the parent resource. Constraints are as follows: * Keys and values are treated as case insensitive * Keys must be between 1 - 256 characters (inclusive) * Keys must be letters, numbers, underscores, or dashes * Values have leading and trailing whitespace trimmed, remaining characters must be between 1 - 4096 characters (inclusive)", "type": "object" }, "name": { -"description": "The relative resource name of the SecurityMarks. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Examples: \"organizations/{organization_id}/assets/{asset_id}/securityMarks\" \"organizations/{organization_id}/sources/{source_id}/findings/{finding_id}/securityMarks\".", "type": "string" } }, "type": "object" }, "GoogleCloudSecuritycenterV1p1beta1Finding": { -"description": "Security Command Center finding. A finding is a record of assessment data (security, risk, health or privacy) ingested into Security Command Center for presentation, notification, analysis, policy testing, and enforcement. For example, an XSS vulnerability in an App Engine application is a finding.", "id": "GoogleCloudSecuritycenterV1p1beta1Finding", "properties": { "canonicalName": { -"description": "The canonical name of the finding. It's either \"organizations/{organization_id}/sources/{source_id}/findings/{finding_id}\", \"folders/{folder_id}/sources/{source_id}/findings/{finding_id}\" or \"projects/{project_number}/sources/{source_id}/findings/{finding_id}\", depending on the closest CRM ancestor of the resource associated with the finding.", "type": "string" }, "category": { -"description": "The additional taxonomy group within findings from a given source. This field is immutable after creation time. Example: \"XSS_FLASH_INJECTION\"", "type": "string" }, "createTime": { -"description": "The time at which the finding was created in Security Command Center.", "format": "google-datetime", "type": "string" }, "eventTime": { -"description": "The time at which the event took place, or when an update to the finding occurred. For example, if the finding represents an open firewall it would capture the time the detector believes the firewall became open. The accuracy is determined by the detector. If the finding were to be resolved afterward, this time would reflect when the finding was resolved. Must not be set to a value greater than the current timestamp.", "format": "google-datetime", "type": "string" }, "externalUri": { -"description": "The URI that, if available, points to a web page outside of Security Command Center where additional information about the finding can be found. This field is guaranteed to be either empty or a well formed URL.", "type": "string" }, "name": { -"description": "The relative resource name of this finding. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Example: \"organizations/{organization_id}/sources/{source_id}/findings/{finding_id}\"", "type": "string" }, "parent": { -"description": "The relative resource name of the source the finding belongs to. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name This field is immutable after creation time. For example: \"organizations/{organization_id}/sources/{source_id}\"", "type": "string" }, "resourceName": { -"description": "For findings on Google Cloud resources, the full resource name of the Google Cloud resource this finding is for. See: https://cloud.google.com/apis/design/resource_names#full_resource_name When the finding is for a non-Google Cloud resource, the resourceName can be a customer or partner defined string. This field is immutable after creation time.", "type": "string" }, "securityMarks": { "$ref": "GoogleCloudSecuritycenterV1p1beta1SecurityMarks", -"description": "Output only. User specified security marks. These marks are entirely managed by the user and come from the SecurityMarks resource that belongs to the finding.", "readOnly": true }, "severity": { -"description": "The severity of the finding. This field is managed by the source that writes the finding.", "enum": [ "SEVERITY_UNSPECIFIED", "CRITICAL", @@ -4325,11 +3719,11 @@ false "LOW" ], "enumDescriptions": [ -"No severity specified. The default value.", -"Critical severity.", -"High severity.", -"Medium severity.", -"Low severity." +"", +"", +"", +"", +"" ], "type": "string" }, @@ -4337,20 +3731,18 @@ false "additionalProperties": { "type": "any" }, -"description": "Source specific properties. These properties are managed by the source that writes the finding. The key names in the source_properties map must be between 1 and 255 characters, and must start with a letter and contain alphanumeric characters or underscores only.", "type": "object" }, "state": { -"description": "The state of the finding.", "enum": [ "STATE_UNSPECIFIED", "ACTIVE", "INACTIVE" ], "enumDescriptions": [ -"Unspecified state.", -"The finding requires attention and has not been addressed yet.", -"The finding has been fixed, triaged as a non-issue or otherwise addressed and is no longer active." +"", +"", +"" ], "type": "string" } @@ -4358,45 +3750,36 @@ false "type": "object" }, "GoogleCloudSecuritycenterV1p1beta1Folder": { -"description": "Message that contains the resource name and display name of a folder resource.", "id": "GoogleCloudSecuritycenterV1p1beta1Folder", "properties": { "resourceFolder": { -"description": "Full resource name of this folder. See: https://cloud.google.com/apis/design/resource_names#full_resource_name", "type": "string" }, "resourceFolderDisplayName": { -"description": "The user defined display name for this folder.", "type": "string" } }, "type": "object" }, "GoogleCloudSecuritycenterV1p1beta1NotificationMessage": { -"description": "Security Command Center's Notification", "id": "GoogleCloudSecuritycenterV1p1beta1NotificationMessage", "properties": { "finding": { -"$ref": "GoogleCloudSecuritycenterV1p1beta1Finding", -"description": "If it's a Finding based notification config, this field will be populated." +"$ref": "GoogleCloudSecuritycenterV1p1beta1Finding" }, "notificationConfigName": { -"description": "Name of the notification config that generated current notification.", "type": "string" }, "resource": { -"$ref": "GoogleCloudSecuritycenterV1p1beta1Resource", -"description": "The Cloud resource tied to the notification." +"$ref": "GoogleCloudSecuritycenterV1p1beta1Resource" } }, "type": "object" }, "GoogleCloudSecuritycenterV1p1beta1Resource": { -"description": "Information related to the Google Cloud resource.", "id": "GoogleCloudSecuritycenterV1p1beta1Resource", "properties": { "folders": { -"description": "Output only. Contains a Folder message for each folder in the assets ancestry. The first folder is the deepest nested folder, and the last folder is the folder directly under the Organization.", "items": { "$ref": "GoogleCloudSecuritycenterV1p1beta1Folder" }, @@ -4404,39 +3787,31 @@ false "type": "array" }, "name": { -"description": "The full resource name of the resource. See: https://cloud.google.com/apis/design/resource_names#full_resource_name", "type": "string" }, "parent": { -"description": "The full resource name of resource's parent.", "type": "string" }, "parentDisplayName": { -"description": "The human readable name of resource's parent.", "type": "string" }, "project": { -"description": "The full resource name of project that the resource belongs to.", "type": "string" }, "projectDisplayName": { -"description": "The project id that the resource belongs to.", "type": "string" } }, "type": "object" }, "GoogleCloudSecuritycenterV1p1beta1RunAssetDiscoveryResponse": { -"description": "Response of asset discovery run", "id": "GoogleCloudSecuritycenterV1p1beta1RunAssetDiscoveryResponse", "properties": { "duration": { -"description": "The duration between asset discovery run start and end", "format": "google-duration", "type": "string" }, "state": { -"description": "The state of an asset discovery run.", "enum": [ "STATE_UNSPECIFIED", "COMPLETED", @@ -4444,10 +3819,10 @@ false "TERMINATED" ], "enumDescriptions": [ -"Asset discovery run state was unspecified.", -"Asset discovery run completed successfully.", -"Asset discovery run was cancelled with tasks still pending, as another run for the same organization was started with a higher priority.", -"Asset discovery run was killed and terminated." +"", +"", +"", +"" ], "type": "string" } @@ -4455,122 +3830,96 @@ false "type": "object" }, "GoogleCloudSecuritycenterV1p1beta1SecurityMarks": { -"description": "User specified security marks that are attached to the parent Security Command Center resource. Security marks are scoped within a Security Command Center organization -- they can be modified and viewed by all users who have proper permissions on the organization.", "id": "GoogleCloudSecuritycenterV1p1beta1SecurityMarks", "properties": { "canonicalName": { -"description": "The canonical name of the marks. Examples: \"organizations/{organization_id}/assets/{asset_id}/securityMarks\" \"folders/{folder_id}/assets/{asset_id}/securityMarks\" \"projects/{project_number}/assets/{asset_id}/securityMarks\" \"organizations/{organization_id}/sources/{source_id}/findings/{finding_id}/securityMarks\" \"folders/{folder_id}/sources/{source_id}/findings/{finding_id}/securityMarks\" \"projects/{project_number}/sources/{source_id}/findings/{finding_id}/securityMarks\"", "type": "string" }, "marks": { "additionalProperties": { "type": "string" }, -"description": "Mutable user specified security marks belonging to the parent resource. Constraints are as follows: * Keys and values are treated as case insensitive * Keys must be between 1 - 256 characters (inclusive) * Keys must be letters, numbers, underscores, or dashes * Values have leading and trailing whitespace trimmed, remaining characters must be between 1 - 4096 characters (inclusive)", "type": "object" }, "name": { -"description": "The relative resource name of the SecurityMarks. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Examples: \"organizations/{organization_id}/assets/{asset_id}/securityMarks\" \"organizations/{organization_id}/sources/{source_id}/findings/{finding_id}/securityMarks\".", "type": "string" } }, "type": "object" }, "GoogleCloudSecuritycenterV2Access": { -"description": "Represents an access event.", "id": "GoogleCloudSecuritycenterV2Access", "properties": { "callerIp": { -"description": "Caller's IP address, such as \"1.1.1.1\".", "type": "string" }, "callerIpGeo": { -"$ref": "GoogleCloudSecuritycenterV2Geolocation", -"description": "The caller IP's geolocation, which identifies where the call came from." +"$ref": "GoogleCloudSecuritycenterV2Geolocation" }, "methodName": { -"description": "The method that the service account called, e.g. \"SetIamPolicy\".", "type": "string" }, "principalEmail": { -"description": "Associated email, such as \"foo@google.com\". The email address of the authenticated user or a service account acting on behalf of a 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" }, "principalSubject": { -"description": "A string that represents the principal_subject that is associated with the identity. Unlike `principal_email`, `principal_subject` supports principals that aren't associated with email addresses, such as third party principals. For most identities, the format is `principal://iam.googleapis.com/{identity pool name}/subject/{subject}`. Some GKE identities, such as GKE_WORKLOAD, FREEFORM, and GKE_HUB_WORKLOAD, still use the legacy format `serviceAccount:{identity pool name}[{subject}]`.", "type": "string" }, "serviceAccountDelegationInfo": { -"description": "The identity delegation history of an authenticated service account that made the request. The `serviceAccountDelegationInfo[]` object contains information about the real authorities that try to access Google Cloud resources by delegating on a service account. When multiple authorities are present, they are guaranteed to be sorted based on the original ordering of the identity delegation events.", "items": { "$ref": "GoogleCloudSecuritycenterV2ServiceAccountDelegationInfo" }, "type": "array" }, "serviceAccountKeyName": { -"description": "The name of the service account key that was used to create or exchange credentials when authenticating the service account that made the request. This is a scheme-less URI full resource name. For example: \"//iam.googleapis.com/projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}/keys/{key}\". ", "type": "string" }, "serviceName": { -"description": "This is the API service that the service account made a call to, e.g. \"iam.googleapis.com\"", "type": "string" }, "userAgent": { -"description": "The caller's user agent string associated with the finding.", "type": "string" }, "userAgentFamily": { -"description": "Type of user agent associated with the finding. For example, an operating system shell or an embedded or standalone application.", "type": "string" }, "userName": { -"description": "A string that represents a username. The username provided depends on the type of the finding and is likely not an IAM principal. For example, this can be a system username if the finding is related to a virtual machine, or it can be an application login username.", "type": "string" } }, "type": "object" }, "GoogleCloudSecuritycenterV2AccessReview": { -"description": "Conveys information about a Kubernetes access review (such as one returned by a [`kubectl auth can-i`](https://kubernetes.io/docs/reference/access-authn-authz/authorization/#checking-api-access) command) that was involved in a finding.", "id": "GoogleCloudSecuritycenterV2AccessReview", "properties": { "group": { -"description": "The API group of the resource. \"*\" means all.", "type": "string" }, "name": { -"description": "The name of the resource being requested. Empty means all.", "type": "string" }, "ns": { -"description": "Namespace of the action being requested. Currently, there is no distinction between no namespace and all namespaces. Both are represented by \"\" (empty).", "type": "string" }, "resource": { -"description": "The optional resource type requested. \"*\" means all.", "type": "string" }, "subresource": { -"description": "The optional subresource type.", "type": "string" }, "verb": { -"description": "A Kubernetes resource API verb, like get, list, watch, create, update, delete, proxy. \"*\" means all.", "type": "string" }, "version": { -"description": "The API version of the resource. \"*\" means all.", "type": "string" } }, "type": "object" }, "GoogleCloudSecuritycenterV2AdaptiveProtection": { -"description": "Information about [Google Cloud Armor Adaptive Protection](https://cloud.google.com/armor/docs/cloud-armor-overview#google-cloud-armor-adaptive-protection).", "id": "GoogleCloudSecuritycenterV2AdaptiveProtection", "properties": { "confidence": { -"description": "A score of 0 means that there is low confidence that the detected event is an actual attack. A score of 1 means that there is high confidence that the detected event is an attack. See the [Adaptive Protection documentation](https://cloud.google.com/armor/docs/adaptive-protection-overview#configure-alert-tuning) for further explanation.", "format": "double", "type": "number" } @@ -4578,48 +3927,39 @@ false "type": "object" }, "GoogleCloudSecuritycenterV2AdcApplication": { -"description": "Represents an ADC application associated with the finding.", "id": "GoogleCloudSecuritycenterV2AdcApplication", "properties": { "attributes": { -"$ref": "GoogleCloudSecuritycenterV2ResourceApplicationAttributes", -"description": "Consumer provided attributes for the AppHub application." +"$ref": "GoogleCloudSecuritycenterV2ResourceApplicationAttributes" }, "name": { -"description": "The resource name of an ADC Application. Format: projects/{project}/locations/{location}/spaces/{space}/applications/{application}", "type": "string" } }, "type": "object" }, "GoogleCloudSecuritycenterV2AdcApplicationTemplateRevision": { -"description": "Represents an ADC template associated with the finding.", "id": "GoogleCloudSecuritycenterV2AdcApplicationTemplateRevision", "properties": { "name": { -"description": "The resource name of an ADC Application Template Revision. Format: projects/{project}/locations/{location}/spaces/{space}/applicationTemplates/{application_template}/revisions/{revision}", "type": "string" } }, "type": "object" }, "GoogleCloudSecuritycenterV2AdcSharedTemplateRevision": { -"description": "Represents an ADC shared template associated with the finding.", "id": "GoogleCloudSecuritycenterV2AdcSharedTemplateRevision", "properties": { "name": { -"description": "The resource name of an ADC Shared Template Revision. Format: projects/{project}/locations/{location}/spaces/{space}/applicationTemplates/{application_template}/revisions/{revision}", "type": "string" } }, "type": "object" }, "GoogleCloudSecuritycenterV2AffectedResources": { -"description": "Details about resources affected by this finding.", "id": "GoogleCloudSecuritycenterV2AffectedResources", "properties": { "count": { -"description": "The count of resources affected by the finding.", "format": "int64", "type": "string" } @@ -4627,20 +3967,16 @@ false "type": "object" }, "GoogleCloudSecuritycenterV2AgentDataAccessEvent": { -"description": "Details about a data access attempt made by an agent principal not authorized under applicable data security policy.", "id": "GoogleCloudSecuritycenterV2AgentDataAccessEvent", "properties": { "eventId": { -"description": "Unique identifier for data access event.", "type": "string" }, "eventTime": { -"description": "Timestamp of data access event.", "format": "google-datetime", "type": "string" }, "operation": { -"description": "The operation performed by the principal to access the data.", "enum": [ "OPERATION_UNSPECIFIED", "READ", @@ -4648,26 +3984,23 @@ false "COPY" ], "enumDescriptions": [ -"The operation is unspecified.", -"Represents a read operation.", -"Represents a move operation.", -"Represents a copy operation." +"", +"", +"", +"" ], "type": "string" }, "principalSubject": { -"description": "The agent principal that accessed the data.", "type": "string" } }, "type": "object" }, "GoogleCloudSecuritycenterV2AiModel": { -"description": "Contains information about the AI model associated with the finding.", "id": "GoogleCloudSecuritycenterV2AiModel", "properties": { "deploymentPlatform": { -"description": "The platform on which the model is deployed.", "enum": [ "DEPLOYMENT_PLATFORM_UNSPECIFIED", "VERTEX_AI", @@ -4676,51 +4009,42 @@ false "FINE_TUNED_MODEL" ], "enumDescriptions": [ -"Unspecified deployment platform.", -"Vertex AI.", -"Google Kubernetes Engine.", -"Google Compute Engine.", -"Fine tuned model." +"", +"", +"", +"", +"" ], "type": "string" }, "displayName": { -"description": "The user defined display name of model. Ex. baseline-classification-model", "type": "string" }, "domain": { -"description": "The domain of the model, for example, \u201cimage-classification\u201d.", "type": "string" }, "library": { -"description": "The name of the model library, for example, \u201ctransformers\u201d.", "type": "string" }, "location": { -"description": "The region in which the model is used, for example, \u201cus-central1\u201d.", "type": "string" }, "name": { -"description": "The name of the AI model, for example, \"gemini:1.0.0\".", "type": "string" }, "publisher": { -"description": "The publisher of the model, for example, \u201cgoogle\u201d or \u201cnvidia\u201d.", "type": "string" }, "usageCategory": { -"description": "The purpose of the model, for example, \"Inteference\" or \"Training\".", "type": "string" } }, "type": "object" }, "GoogleCloudSecuritycenterV2Allowed": { -"description": "Allowed IP rule.", "id": "GoogleCloudSecuritycenterV2Allowed", "properties": { "ipRules": { -"description": "Optional. Optional list of allowed IP rules.", "items": { "$ref": "GoogleCloudSecuritycenterV2IpRule" }, @@ -4730,59 +4054,49 @@ false "type": "object" }, "GoogleCloudSecuritycenterV2Application": { -"description": "Represents an application associated with a finding.", "id": "GoogleCloudSecuritycenterV2Application", "properties": { "baseUri": { -"description": "The base URI that identifies the network location of the application in which the vulnerability was detected. For example, `http://example.com`.", "type": "string" }, "fullUri": { -"description": "The full URI with payload that could be used to reproduce the vulnerability. For example, `http://example.com?p=aMmYgI6H`.", "type": "string" } }, "type": "object" }, "GoogleCloudSecuritycenterV2ArtifactGuardPolicies": { -"description": "Represents the result of evaluating artifact guard policies.", "id": "GoogleCloudSecuritycenterV2ArtifactGuardPolicies", "properties": { "failingPolicies": { -"description": "A list of failing policies.", "items": { "$ref": "GoogleCloudSecuritycenterV2ArtifactGuardPolicy" }, "type": "array" }, "resourceId": { -"description": "The ID of the resource that has policies configured for it.", "type": "string" } }, "type": "object" }, "GoogleCloudSecuritycenterV2ArtifactGuardPolicy": { -"description": "Represents an artifact guard policy.", "id": "GoogleCloudSecuritycenterV2ArtifactGuardPolicy", "properties": { "failureReason": { -"description": "The reason for the policy failure, for example, \"severity=HIGH AND max_vuln_count=2\".", "type": "string" }, "policyId": { -"description": "The ID of the failing policy, for example, \"organizations/3392779/locations/global/policies/prod-policy\".", "type": "string" }, "type": { -"description": "The type of the policy evaluation.", "enum": [ "ARTIFACT_GUARD_POLICY_TYPE_UNSPECIFIED", "VULNERABILITY" ], "enumDescriptions": [ -"Default value. This value is unused.", -"Vulnerability type." +"", +"" ], "type": "string" } @@ -4790,32 +4104,26 @@ false "type": "object" }, "GoogleCloudSecuritycenterV2Attack": { -"description": "Information about DDoS attack volume and classification.", "id": "GoogleCloudSecuritycenterV2Attack", "properties": { "classification": { -"description": "Type of attack, for example, 'SYN-flood', 'NTP-udp', or 'CHARGEN-udp'.", "type": "string" }, "volumeBps": { "deprecated": true, -"description": "Total BPS (bytes per second) volume of attack. Deprecated - refer to volume_bps_long instead.", "format": "int32", "type": "integer" }, "volumeBpsLong": { -"description": "Total BPS (bytes per second) volume of attack.", "format": "int64", "type": "string" }, "volumePps": { "deprecated": true, -"description": "Total PPS (packets per second) volume of attack. Deprecated - refer to volume_pps_long instead.", "format": "int32", "type": "integer" }, "volumePpsLong": { -"description": "Total PPS (packets per second) volume of attack.", "format": "int64", "type": "string" } @@ -4823,49 +4131,41 @@ false "type": "object" }, "GoogleCloudSecuritycenterV2AttackExposure": { -"description": "An attack exposure contains the results of an attack path simulation run.", "id": "GoogleCloudSecuritycenterV2AttackExposure", "properties": { "attackExposureResult": { -"description": "The resource name of the attack path simulation result that contains the details regarding this attack exposure score. Example: `organizations/123/simulations/456/attackExposureResults/789`", "type": "string" }, "exposedHighValueResourcesCount": { -"description": "The number of high value resources that are exposed as a result of this finding.", "format": "int32", "type": "integer" }, "exposedLowValueResourcesCount": { -"description": "The number of high value resources that are exposed as a result of this finding.", "format": "int32", "type": "integer" }, "exposedMediumValueResourcesCount": { -"description": "The number of medium value resources that are exposed as a result of this finding.", "format": "int32", "type": "integer" }, "latestCalculationTime": { -"description": "The most recent time the attack exposure was updated on this finding.", "format": "google-datetime", "type": "string" }, "score": { -"description": "A number between 0 (inclusive) and infinity that represents how important this finding is to remediate. The higher the score, the more important it is to remediate.", "format": "double", "type": "number" }, "state": { -"description": "Output only. What state this AttackExposure is in. This captures whether or not an attack exposure has been calculated or not.", "enum": [ "STATE_UNSPECIFIED", "CALCULATED", "NOT_CALCULATED" ], "enumDescriptions": [ -"The state is not specified.", -"The attack exposure has been calculated.", -"The attack exposure has not been calculated." +"", +"", +"" ], "readOnly": true, "type": "string" @@ -4874,34 +4174,27 @@ false "type": "object" }, "GoogleCloudSecuritycenterV2AwsAccount": { -"description": "An AWS account that is a member of an organization.", "id": "GoogleCloudSecuritycenterV2AwsAccount", "properties": { "id": { -"description": "The unique identifier (ID) of the account, containing exactly 12 digits.", "type": "string" }, "name": { -"description": "The friendly name of this account.", "type": "string" } }, "type": "object" }, "GoogleCloudSecuritycenterV2AwsMetadata": { -"description": "AWS metadata associated with the resource, only applicable if the finding's cloud provider is Amazon Web Services.", "id": "GoogleCloudSecuritycenterV2AwsMetadata", "properties": { "account": { -"$ref": "GoogleCloudSecuritycenterV2AwsAccount", -"description": "The AWS account associated with the resource." +"$ref": "GoogleCloudSecuritycenterV2AwsAccount" }, "organization": { -"$ref": "GoogleCloudSecuritycenterV2AwsOrganization", -"description": "The AWS organization associated with the resource." +"$ref": "GoogleCloudSecuritycenterV2AwsOrganization" }, "organizationalUnits": { -"description": "A list of AWS organizational units associated with the resource, ordered from lowest level (closest to the account) to highest level.", "items": { "$ref": "GoogleCloudSecuritycenterV2AwsOrganizationalUnit" }, @@ -4911,217 +4204,174 @@ false "type": "object" }, "GoogleCloudSecuritycenterV2AwsOrganization": { -"description": "An organization is a collection of accounts that are centrally managed together using consolidated billing, organized hierarchically with organizational units (OUs), and controlled with policies.", "id": "GoogleCloudSecuritycenterV2AwsOrganization", "properties": { "id": { -"description": "The unique identifier (ID) for the organization. The regex pattern for an organization ID string requires \"o-\" followed by from 10 to 32 lowercase letters or digits.", "type": "string" } }, "type": "object" }, "GoogleCloudSecuritycenterV2AwsOrganizationalUnit": { -"description": "An Organizational Unit (OU) is a container of AWS accounts within a root of an organization. Policies that are attached to an OU apply to all accounts contained in that OU and in any child OUs.", "id": "GoogleCloudSecuritycenterV2AwsOrganizationalUnit", "properties": { "id": { -"description": "The unique identifier (ID) associated with this OU. The regex pattern for an organizational unit ID string requires \"ou-\" followed by from 4 to 32 lowercase letters or digits (the ID of the root that contains the OU). This string is followed by a second \"-\" dash and from 8 to 32 additional lowercase letters or digits. For example, \"ou-ab12-cd34ef56\".", "type": "string" }, "name": { -"description": "The friendly name of the OU.", "type": "string" } }, "type": "object" }, "GoogleCloudSecuritycenterV2AzureManagementGroup": { -"description": "Represents an Azure management group.", "id": "GoogleCloudSecuritycenterV2AzureManagementGroup", "properties": { "displayName": { -"description": "The display name of the Azure management group.", "type": "string" }, "id": { -"description": "The UUID of the Azure management group, for example, `20000000-0001-0000-0000-000000000000`.", "type": "string" } }, "type": "object" }, "GoogleCloudSecuritycenterV2AzureMetadata": { -"description": "Azure metadata associated with the resource, only applicable if the finding's cloud provider is Microsoft Azure.", "id": "GoogleCloudSecuritycenterV2AzureMetadata", "properties": { "managementGroups": { -"description": "A list of Azure management groups associated with the resource, ordered from lowest level (closest to the subscription) to highest level.", "items": { "$ref": "GoogleCloudSecuritycenterV2AzureManagementGroup" }, "type": "array" }, "resourceGroup": { -"$ref": "GoogleCloudSecuritycenterV2AzureResourceGroup", -"description": "The Azure resource group associated with the resource." +"$ref": "GoogleCloudSecuritycenterV2AzureResourceGroup" }, "subscription": { -"$ref": "GoogleCloudSecuritycenterV2AzureSubscription", -"description": "The Azure subscription associated with the resource." +"$ref": "GoogleCloudSecuritycenterV2AzureSubscription" }, "tenant": { -"$ref": "GoogleCloudSecuritycenterV2AzureTenant", -"description": "The Azure Entra tenant associated with the resource." +"$ref": "GoogleCloudSecuritycenterV2AzureTenant" } }, "type": "object" }, "GoogleCloudSecuritycenterV2AzureResourceGroup": { -"description": "Represents an Azure resource group.", "id": "GoogleCloudSecuritycenterV2AzureResourceGroup", "properties": { "id": { -"description": "The ID of the Azure resource group.", "type": "string" }, "name": { -"description": "The name of the Azure resource group. This is not a UUID.", "type": "string" } }, "type": "object" }, "GoogleCloudSecuritycenterV2AzureSubscription": { -"description": "Represents an Azure subscription.", "id": "GoogleCloudSecuritycenterV2AzureSubscription", "properties": { "displayName": { -"description": "The display name of the Azure subscription.", "type": "string" }, "id": { -"description": "The UUID of the Azure subscription, for example, `291bba3f-e0a5-47bc-a099-3bdcb2a50a05`.", "type": "string" } }, "type": "object" }, "GoogleCloudSecuritycenterV2AzureTenant": { -"description": "Represents a Microsoft Entra tenant.", "id": "GoogleCloudSecuritycenterV2AzureTenant", "properties": { "displayName": { -"description": "The display name of the Azure tenant.", "type": "string" }, "id": { -"description": "The ID of the Microsoft Entra tenant, for example, \"a11aaa11-aa11-1aa1-11aa-1aaa11a\".", "type": "string" } }, "type": "object" }, "GoogleCloudSecuritycenterV2BackupDisasterRecovery": { -"description": "Information related to Google Cloud Backup and DR Service findings.", "id": "GoogleCloudSecuritycenterV2BackupDisasterRecovery", "properties": { "appliance": { -"description": "The name of the Backup and DR appliance that captures, moves, and manages the lifecycle of backup data. For example, `backup-server-57137`.", "type": "string" }, "applications": { -"description": "The names of Backup and DR applications. An application is a VM, database, or file system on a managed host monitored by a backup and recovery appliance. For example, `centos7-01-vol00`, `centos7-01-vol01`, `centos7-01-vol02`.", "items": { "type": "string" }, "type": "array" }, "backupCreateTime": { -"description": "The timestamp at which the Backup and DR backup was created.", "format": "google-datetime", "type": "string" }, "backupTemplate": { -"description": "The name of a Backup and DR template which comprises one or more backup policies. See the [Backup and DR documentation](https://cloud.google.com/backup-disaster-recovery/docs/concepts/backup-plan#temp) for more information. For example, `snap-ov`.", "type": "string" }, "backupType": { -"description": "The backup type of the Backup and DR image. For example, `Snapshot`, `Remote Snapshot`, `OnVault`.", "type": "string" }, "host": { -"description": "The name of a Backup and DR host, which is managed by the backup and recovery appliance and known to the management console. The host can be of type Generic (for example, Compute Engine, SQL Server, Oracle DB, SMB file system, etc.), vCenter, or an ESX server. See the [Backup and DR documentation on hosts](https://cloud.google.com/backup-disaster-recovery/docs/configuration/manage-hosts-and-their-applications) for more information. For example, `centos7-01`.", "type": "string" }, "policies": { -"description": "The names of Backup and DR policies that are associated with a template and that define when to run a backup, how frequently to run a backup, and how long to retain the backup image. For example, `onvaults`.", "items": { "type": "string" }, "type": "array" }, "policyOptions": { -"description": "The names of Backup and DR advanced policy options of a policy applying to an application. See the [Backup and DR documentation on policy options](https://cloud.google.com/backup-disaster-recovery/docs/create-plan/policy-settings). For example, `skipofflineappsincongrp, nounmap`.", "items": { "type": "string" }, "type": "array" }, "profile": { -"description": "The name of the Backup and DR resource profile that specifies the storage media for backups of application and VM data. See the [Backup and DR documentation on profiles](https://cloud.google.com/backup-disaster-recovery/docs/concepts/backup-plan#profile). For example, `GCP`.", "type": "string" }, "storagePool": { -"description": "The name of the Backup and DR storage pool that the backup and recovery appliance is storing data in. The storage pool could be of type Cloud, Primary, Snapshot, or OnVault. See the [Backup and DR documentation on storage pools](https://cloud.google.com/backup-disaster-recovery/docs/concepts/storage-pools). For example, `DiskPoolOne`.", "type": "string" } }, "type": "object" }, "GoogleCloudSecuritycenterV2BigQueryExport": { -"description": "Configures how to deliver Findings to BigQuery Instance.", "id": "GoogleCloudSecuritycenterV2BigQueryExport", "properties": { "createTime": { -"description": "Output only. The time at which the BigQuery export was created. This field is set by the server and will be ignored if provided on export on creation.", "format": "google-datetime", "readOnly": true, "type": "string" }, "cryptoKeyName": { -"description": "Output only. The resource name of the Cloud KMS `CryptoKey` used to protect this configuration's data, if configured during Security Command Center activation.", "readOnly": true, "type": "string" }, "dataset": { -"description": "The dataset to write findings' updates to. Its format is \"projects/[project_id]/datasets/[bigquery_dataset_id]\". BigQuery dataset unique ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_).", "type": "string" }, "description": { -"description": "The description of the export (max of 1024 characters).", "type": "string" }, "filter": { -"description": "Expression that defines the filter to apply across create/update events of findings. The expression is a list of zero or more restrictions combined via logical operators `AND` and `OR`. Parentheses are supported, and `OR` has higher precedence than `AND`. Restrictions have the form ` ` and may have a `-` character in front of them to indicate negation. The fields map to those defined in the corresponding resource. The supported operators are: * `=` for all value types. * `>`, `<`, `>=`, `<=` for integer values. * `:`, meaning substring matching, for strings. The supported value types are: * string literals in quotes. * integer literals without quotes. * boolean literals `true` and `false` without quotes.", "type": "string" }, "mostRecentEditor": { -"description": "Output only. Email address of the user who last edited the BigQuery export. This field is set by the server and will be ignored if provided on export creation or update.", "readOnly": true, "type": "string" }, "name": { -"description": "Identifier. The relative resource name of this export. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name. The following list shows some examples: + `organizations/{organization_id}/locations/{location_id}/bigQueryExports/{export_id}` + `folders/{folder_id}/locations/{location_id}/bigQueryExports/{export_id}` + `projects/{project_id}/locations/{location_id}/bigQueryExports/{export_id}` This field is provided in responses, and is ignored when provided in create requests.", "type": "string" }, "principal": { -"description": "Output only. The service account that needs permission to create table and upload data to the BigQuery dataset.", "readOnly": true, "type": "string" }, "updateTime": { -"description": "Output only. The most recent time at which the BigQuery export was updated. This field is set by the server and will be ignored if provided on export creation or update.", "format": "google-datetime", "readOnly": true, "type": "string" @@ -5130,23 +4380,18 @@ false "type": "object" }, "GoogleCloudSecuritycenterV2Binding": { -"description": "Represents a Kubernetes RoleBinding or ClusterRoleBinding.", "id": "GoogleCloudSecuritycenterV2Binding", "properties": { "name": { -"description": "Name for the binding.", "type": "string" }, "ns": { -"description": "Namespace for the binding.", "type": "string" }, "role": { -"$ref": "GoogleCloudSecuritycenterV2Role", -"description": "The Role or ClusterRole referenced by the binding." +"$ref": "GoogleCloudSecuritycenterV2Role" }, "subjects": { -"description": "Represents one or more subjects that are bound to the role. Not always available for PATCH requests.", "items": { "$ref": "GoogleCloudSecuritycenterV2Subject" }, @@ -5156,17 +4401,14 @@ false "type": "object" }, "GoogleCloudSecuritycenterV2BulkMuteFindingsResponse": { -"description": "The response to a BulkMute request. Contains the LRO information.", "id": "GoogleCloudSecuritycenterV2BulkMuteFindingsResponse", "properties": {}, "type": "object" }, "GoogleCloudSecuritycenterV2Chokepoint": { -"description": "Contains details about a chokepoint, which is a resource or resource group where high-risk attack paths converge, based on [attack path simulations] (https://cloud.google.com/security-command-center/docs/attack-exposure-learn#attack_path_simulations).", "id": "GoogleCloudSecuritycenterV2Chokepoint", "properties": { "relatedFindings": { -"description": "List of resource names of findings associated with this chokepoint. For example, organizations/123/sources/456/findings/789. This list will have at most 100 findings.", "items": { "type": "string" }, @@ -5176,65 +4418,53 @@ false "type": "object" }, "GoogleCloudSecuritycenterV2CloudArmor": { -"description": "Fields related to Google Cloud Armor findings.", "id": "GoogleCloudSecuritycenterV2CloudArmor", "properties": { "adaptiveProtection": { -"$ref": "GoogleCloudSecuritycenterV2AdaptiveProtection", -"description": "Information about potential Layer 7 DDoS attacks identified by [Google Cloud Armor Adaptive Protection](https://cloud.google.com/armor/docs/adaptive-protection-overview)." +"$ref": "GoogleCloudSecuritycenterV2AdaptiveProtection" }, "attack": { -"$ref": "GoogleCloudSecuritycenterV2Attack", -"description": "Information about DDoS attack volume and classification." +"$ref": "GoogleCloudSecuritycenterV2Attack" }, "duration": { -"description": "Duration of attack from the start until the current moment (updated every 5 minutes).", "format": "google-duration", "type": "string" }, "requests": { -"$ref": "GoogleCloudSecuritycenterV2Requests", -"description": "Information about incoming requests evaluated by [Google Cloud Armor security policies](https://cloud.google.com/armor/docs/security-policy-overview)." +"$ref": "GoogleCloudSecuritycenterV2Requests" }, "securityPolicy": { -"$ref": "GoogleCloudSecuritycenterV2SecurityPolicy", -"description": "Information about the [Google Cloud Armor security policy](https://cloud.google.com/armor/docs/security-policy-overview) relevant to the finding." +"$ref": "GoogleCloudSecuritycenterV2SecurityPolicy" }, "threatVector": { -"description": "Distinguish between volumetric & protocol DDoS attack and application layer attacks. For example, \"L3_4\" for Layer 3 and Layer 4 DDoS attacks, or \"L_7\" for Layer 7 DDoS attacks.", "type": "string" } }, "type": "object" }, "GoogleCloudSecuritycenterV2CloudControl": { -"description": "CloudControl associated with the finding.", "id": "GoogleCloudSecuritycenterV2CloudControl", "properties": { "cloudControlName": { -"description": "Name of the CloudControl associated with the finding.", "type": "string" }, "policyType": { -"description": "Policy type of the CloudControl", "type": "string" }, "type": { -"description": "Type of cloud control.", "enum": [ "CLOUD_CONTROL_TYPE_UNSPECIFIED", "BUILT_IN", "CUSTOM" ], "enumDescriptions": [ -"Unspecified.", -"Built in Cloud Control.", -"Custom Cloud Control." +"", +"", +"" ], "type": "string" }, "version": { -"description": "Version of the Cloud Control", "format": "int32", "type": "integer" } @@ -5242,31 +4472,27 @@ false "type": "object" }, "GoogleCloudSecuritycenterV2CloudDlpDataProfile": { -"description": "The [data profile](https://cloud.google.com/dlp/docs/data-profiles) associated with the finding.", "id": "GoogleCloudSecuritycenterV2CloudDlpDataProfile", "properties": { "dataProfile": { -"description": "Name of the data profile, for example, `projects/123/locations/europe/tableProfiles/8383929`.", "type": "string" }, "infoTypes": { -"description": "Type of information detected by SDP. Info type includes name, version and sensitivity of the detected information type.", "items": { "$ref": "GoogleCloudSecuritycenterV2InfoType" }, "type": "array" }, "parentType": { -"description": "The resource hierarchy level at which the data profile was generated.", "enum": [ "PARENT_TYPE_UNSPECIFIED", "ORGANIZATION", "PROJECT" ], "enumDescriptions": [ -"Unspecified parent type.", -"Organization-level configurations.", -"Project-level configurations." +"", +"", +"" ], "type": "string" } @@ -5274,47 +4500,37 @@ false "type": "object" }, "GoogleCloudSecuritycenterV2CloudDlpInspection": { -"description": "Details about the Cloud Data Loss Prevention (Cloud DLP) [inspection job](https://cloud.google.com/dlp/docs/concepts-job-triggers) that produced the finding.", "id": "GoogleCloudSecuritycenterV2CloudDlpInspection", "properties": { "fullScan": { -"description": "Whether Cloud DLP scanned the complete resource or a sampled subset.", "type": "boolean" }, "infoType": { -"description": "The type of information (or *[infoType](https://cloud.google.com/dlp/docs/infotypes-reference)*) found, for example, `EMAIL_ADDRESS` or `STREET_ADDRESS`.", "type": "string" }, "infoTypeCount": { -"description": "The number of times Cloud DLP found this infoType within this job and resource.", "format": "int64", "type": "string" }, "inspectJob": { -"description": "Name of the inspection job, for example, `projects/123/locations/europe/dlpJobs/i-8383929`.", "type": "string" } }, "type": "object" }, "GoogleCloudSecuritycenterV2CloudLoggingEntry": { -"description": "Metadata taken from a [Cloud Logging LogEntry](https://cloud.google.com/logging/docs/reference/v2/rest/v2/LogEntry)", "id": "GoogleCloudSecuritycenterV2CloudLoggingEntry", "properties": { "insertId": { -"description": "A unique identifier for the log entry.", "type": "string" }, "logId": { -"description": "The type of the log (part of `log_name`. `log_name` is the resource name of the log to which this log entry belongs). For example: `cloudresourcemanager.googleapis.com/activity` Note that this field is not URL-encoded, unlike in `LogEntry`.", "type": "string" }, "resourceContainer": { -"description": "The organization, folder, or project of the monitored resource that produced this log entry.", "type": "string" }, "timestamp": { -"description": "The time the event described by the log entry occurred.", "format": "google-datetime", "type": "string" } @@ -5322,44 +4538,36 @@ false "type": "object" }, "GoogleCloudSecuritycenterV2Compliance": { -"description": "Contains compliance information about a security standard indicating unmet recommendations.", "id": "GoogleCloudSecuritycenterV2Compliance", "properties": { "ids": { -"description": "Policies within the standard or benchmark, for example, A.12.4.1", "items": { "type": "string" }, "type": "array" }, "standard": { -"description": "Industry-wide compliance standards or benchmarks, such as CIS, PCI, and OWASP.", "type": "string" }, "version": { -"description": "Version of the standard or benchmark, for example, 1.1", "type": "string" } }, "type": "object" }, "GoogleCloudSecuritycenterV2ComplianceDetails": { -"description": "Compliance Details associated with the finding.", "id": "GoogleCloudSecuritycenterV2ComplianceDetails", "properties": { "cloudControl": { -"$ref": "GoogleCloudSecuritycenterV2CloudControl", -"description": "CloudControl associated with the finding" +"$ref": "GoogleCloudSecuritycenterV2CloudControl" }, "cloudControlDeploymentNames": { -"description": "Cloud Control Deployments associated with the finding. For example, organizations/123/locations/global/cloudControlDeployments/deploymentIdentifier", "items": { "type": "string" }, "type": "array" }, "frameworks": { -"description": "Details of Frameworks associated with the finding", "items": { "$ref": "GoogleCloudSecuritycenterV2Framework" }, @@ -5369,20 +4577,16 @@ false "type": "object" }, "GoogleCloudSecuritycenterV2Connection": { -"description": "Contains information about the IP connection associated with the finding.", "id": "GoogleCloudSecuritycenterV2Connection", "properties": { "destinationIp": { -"description": "Destination IP address. Not present for sockets that are listening and not connected.", "type": "string" }, "destinationPort": { -"description": "Destination port. Not present for sockets that are listening and not connected.", "format": "int32", "type": "integer" }, "protocol": { -"description": "IANA Internet Protocol Number such as TCP(6) and UDP(17).", "enum": [ "PROTOCOL_UNSPECIFIED", "ICMP", @@ -5392,21 +4596,19 @@ false "ESP" ], "enumDescriptions": [ -"Unspecified protocol (not HOPOPT).", -"Internet Control Message Protocol.", -"Transmission Control Protocol.", -"User Datagram Protocol.", -"Generic Routing Encapsulation.", -"Encap Security Payload." +"", +"", +"", +"", +"", +"" ], "type": "string" }, "sourceIp": { -"description": "Source IP address.", "type": "string" }, "sourcePort": { -"description": "Source port.", "format": "int32", "type": "integer" } @@ -5414,22 +4616,18 @@ false "type": "object" }, "GoogleCloudSecuritycenterV2Contact": { -"description": "The email address of a contact.", "id": "GoogleCloudSecuritycenterV2Contact", "properties": { "email": { -"description": "An email address. For example, \"`person123@company.com`\".", "type": "string" } }, "type": "object" }, "GoogleCloudSecuritycenterV2ContactDetails": { -"description": "Details about specific contacts", "id": "GoogleCloudSecuritycenterV2ContactDetails", "properties": { "contacts": { -"description": "A list of contacts", "items": { "$ref": "GoogleCloudSecuritycenterV2Contact" }, @@ -5439,66 +4637,53 @@ false "type": "object" }, "GoogleCloudSecuritycenterV2Container": { -"description": "Container associated with the finding.", "id": "GoogleCloudSecuritycenterV2Container", "properties": { "createTime": { -"description": "The time that the container was created.", "format": "google-datetime", "type": "string" }, "imageId": { -"description": "Optional container image ID, if provided by the container runtime. Uniquely identifies the container image launched using a container image digest.", "type": "string" }, "labels": { -"description": "Container labels, as provided by the container runtime.", "items": { "$ref": "GoogleCloudSecuritycenterV2Label" }, "type": "array" }, "name": { -"description": "Name of the container.", "type": "string" }, "uri": { -"description": "Container image URI provided when configuring a pod or container. This string can identify a container image version using mutable tags.", "type": "string" } }, "type": "object" }, "GoogleCloudSecuritycenterV2Control": { -"description": "Compliance control associated with the finding.", "id": "GoogleCloudSecuritycenterV2Control", "properties": { "controlName": { -"description": "Name of the Control", "type": "string" }, "displayName": { -"description": "Display name of the control. For example, AU-02.", "type": "string" } }, "type": "object" }, "GoogleCloudSecuritycenterV2Cve": { -"description": "CVE stands for Common Vulnerabilities and Exposures. Information from the [CVE record](https://www.cve.org/ResourcesSupport/Glossary) that describes this vulnerability.", "id": "GoogleCloudSecuritycenterV2Cve", "properties": { "cvssv3": { -"$ref": "GoogleCloudSecuritycenterV2Cvssv3", -"description": "Describe Common Vulnerability Scoring System specified at https://www.first.org/cvss/v3.1/specification-document" +"$ref": "GoogleCloudSecuritycenterV2Cvssv3" }, "exploitReleaseDate": { -"description": "Date the first publicly available exploit or PoC was released.", "format": "google-datetime", "type": "string" }, "exploitationActivity": { -"description": "The exploitation activity of the vulnerability in the wild.", "enum": [ "EXPLOITATION_ACTIVITY_UNSPECIFIED", "WIDE", @@ -5508,26 +4693,23 @@ false "NO_KNOWN" ], "enumDescriptions": [ -"Invalid or empty value.", -"Exploitation has been reported or confirmed to widely occur.", -"Limited reported or confirmed exploitation activities.", -"Exploit is publicly available.", -"No known exploitation activity, but has a high potential for exploitation.", -"No known exploitation activity." +"", +"", +"", +"", +"", +"" ], "type": "string" }, "firstExploitationDate": { -"description": "Date of the earliest known exploitation.", "format": "google-datetime", "type": "string" }, "id": { -"description": "The unique identifier for the vulnerability. e.g. CVE-2021-34527", "type": "string" }, "impact": { -"description": "The potential impact of the vulnerability if it was to be exploited.", "enum": [ "RISK_RATING_UNSPECIFIED", "LOW", @@ -5536,56 +4718,49 @@ false "CRITICAL" ], "enumDescriptions": [ -"Invalid or empty value.", -"Exploitation would have little to no security impact.", -"Exploitation would enable attackers to perform activities, or could allow attackers to have a direct impact, but would require additional steps.", -"Exploitation would enable attackers to have a notable direct impact without needing to overcome any major mitigating factors.", -"Exploitation would fundamentally undermine the security of affected systems, enable actors to perform significant attacks with minimal effort, with little to no mitigating factors to overcome." +"", +"", +"", +"", +"" ], "type": "string" }, "observedInTheWild": { -"description": "Whether or not the vulnerability has been observed in the wild.", "type": "boolean" }, "references": { -"description": "Additional information about the CVE. e.g. https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2021-34527", "items": { "$ref": "GoogleCloudSecuritycenterV2Reference" }, "type": "array" }, "upstreamFixAvailable": { -"description": "Whether upstream fix is available for the CVE.", "type": "boolean" }, "zeroDay": { -"description": "Whether or not the vulnerability was zero day when the finding was published.", "type": "boolean" } }, "type": "object" }, "GoogleCloudSecuritycenterV2Cvssv3": { -"description": "Common Vulnerability Scoring System version 3.", "id": "GoogleCloudSecuritycenterV2Cvssv3", "properties": { "attackComplexity": { -"description": "This metric describes the conditions beyond the attacker's control that must exist in order to exploit the vulnerability.", "enum": [ "ATTACK_COMPLEXITY_UNSPECIFIED", "ATTACK_COMPLEXITY_LOW", "ATTACK_COMPLEXITY_HIGH" ], "enumDescriptions": [ -"Invalid value.", -"Specialized access conditions or extenuating circumstances do not exist. An attacker can expect repeatable success when attacking the vulnerable component.", -"A successful attack depends on conditions beyond the attacker's control. That is, a successful attack cannot be accomplished at will, but requires the attacker to invest in some measurable amount of effort in preparation or execution against the vulnerable component before a successful attack can be expected." +"", +"", +"" ], "type": "string" }, "attackVector": { -"description": "Base Metrics Represents the intrinsic characteristics of a vulnerability that are constant over time and across user environments. This metric reflects the context by which vulnerability exploitation is possible.", "enum": [ "ATTACK_VECTOR_UNSPECIFIED", "ATTACK_VECTOR_NETWORK", @@ -5594,16 +4769,15 @@ false "ATTACK_VECTOR_PHYSICAL" ], "enumDescriptions": [ -"Invalid value.", -"The vulnerable component is bound to the network stack and the set of possible attackers extends beyond the other options listed below, up to and including the entire Internet.", -"The vulnerable component is bound to the network stack, but the attack is limited at the protocol level to a logically adjacent topology.", -"The vulnerable component is not bound to the network stack and the attacker's path is via read/write/execute capabilities.", -"The attack requires the attacker to physically touch or manipulate the vulnerable component." +"", +"", +"", +"", +"" ], "type": "string" }, "availabilityImpact": { -"description": "This metric measures the impact to the availability of the impacted component resulting from a successfully exploited vulnerability.", "enum": [ "IMPACT_UNSPECIFIED", "IMPACT_HIGH", @@ -5611,20 +4785,18 @@ false "IMPACT_NONE" ], "enumDescriptions": [ -"Invalid value.", -"High impact.", -"Low impact.", -"No impact." +"", +"", +"", +"" ], "type": "string" }, "baseScore": { -"description": "The base score is a function of the base metric scores.", "format": "double", "type": "number" }, "confidentialityImpact": { -"description": "This metric measures the impact to the confidentiality of the information resources managed by a software component due to a successfully exploited vulnerability.", "enum": [ "IMPACT_UNSPECIFIED", "IMPACT_HIGH", @@ -5632,15 +4804,14 @@ false "IMPACT_NONE" ], "enumDescriptions": [ -"Invalid value.", -"High impact.", -"Low impact.", -"No impact." +"", +"", +"", +"" ], "type": "string" }, "integrityImpact": { -"description": "This metric measures the impact to integrity of a successfully exploited vulnerability.", "enum": [ "IMPACT_UNSPECIFIED", "IMPACT_HIGH", @@ -5648,15 +4819,14 @@ false "IMPACT_NONE" ], "enumDescriptions": [ -"Invalid value.", -"High impact.", -"Low impact.", -"No impact." +"", +"", +"", +"" ], "type": "string" }, "privilegesRequired": { -"description": "This metric describes the level of privileges an attacker must possess before successfully exploiting the vulnerability.", "enum": [ "PRIVILEGES_REQUIRED_UNSPECIFIED", "PRIVILEGES_REQUIRED_NONE", @@ -5664,38 +4834,36 @@ false "PRIVILEGES_REQUIRED_HIGH" ], "enumDescriptions": [ -"Invalid value.", -"The attacker is unauthorized prior to attack, and therefore does not require any access to settings or files of the vulnerable system to carry out an attack.", -"The attacker requires privileges that provide basic user capabilities that could normally affect only settings and files owned by a user. Alternatively, an attacker with Low privileges has the ability to access only non-sensitive resources.", -"The attacker requires privileges that provide significant (e.g., administrative) control over the vulnerable component allowing access to component-wide settings and files." +"", +"", +"", +"" ], "type": "string" }, "scope": { -"description": "The Scope metric captures whether a vulnerability in one vulnerable component impacts resources in components beyond its security scope.", "enum": [ "SCOPE_UNSPECIFIED", "SCOPE_UNCHANGED", "SCOPE_CHANGED" ], "enumDescriptions": [ -"Invalid value.", -"An exploited vulnerability can only affect resources managed by the same security authority.", -"An exploited vulnerability can affect resources beyond the security scope managed by the security authority of the vulnerable component." +"", +"", +"" ], "type": "string" }, "userInteraction": { -"description": "This metric captures the requirement for a human user, other than the attacker, to participate in the successful compromise of the vulnerable component.", "enum": [ "USER_INTERACTION_UNSPECIFIED", "USER_INTERACTION_NONE", "USER_INTERACTION_REQUIRED" ], "enumDescriptions": [ -"Invalid value.", -"The vulnerable system can be exploited without interaction from any user.", -"Successful exploitation of this vulnerability requires a user to take some action before the vulnerability can be exploited." +"", +"", +"" ], "type": "string" } @@ -5703,15 +4871,12 @@ false "type": "object" }, "GoogleCloudSecuritycenterV2Cwe": { -"description": "CWE stands for Common Weakness Enumeration. Information about this weakness, as described by [CWE](https://cwe.mitre.org/).", "id": "GoogleCloudSecuritycenterV2Cwe", "properties": { "id": { -"description": "The CWE identifier, e.g. CWE-94", "type": "string" }, "references": { -"description": "Any reference to the details on the CWE, for example, https://cwe.mitre.org/data/definitions/94.html", "items": { "$ref": "GoogleCloudSecuritycenterV2Reference" }, @@ -5721,20 +4886,16 @@ false "type": "object" }, "GoogleCloudSecuritycenterV2DataAccessEvent": { -"description": "Details about a data access attempt made by a principal not authorized under applicable data security policy.", "id": "GoogleCloudSecuritycenterV2DataAccessEvent", "properties": { "eventId": { -"description": "Unique identifier for data access event.", "type": "string" }, "eventTime": { -"description": "Timestamp of data access event.", "format": "google-datetime", "type": "string" }, "operation": { -"description": "The operation performed by the principal to access the data.", "enum": [ "OPERATION_UNSPECIFIED", "READ", @@ -5742,35 +4903,30 @@ false "COPY" ], "enumDescriptions": [ -"The operation is unspecified.", -"Represents a read operation.", -"Represents a move operation.", -"Represents a copy operation." +"", +"", +"", +"" ], "type": "string" }, "principalEmail": { -"description": "The email address of the principal that accessed the data. The principal could be a user account, service account, Google group, or other.", "type": "string" } }, "type": "object" }, "GoogleCloudSecuritycenterV2DataFlowEvent": { -"description": "Details about a data flow event, in which either the data is moved to or is accessed from a non-compliant geo-location, as defined in the applicable data security policy.", "id": "GoogleCloudSecuritycenterV2DataFlowEvent", "properties": { "eventId": { -"description": "Unique identifier for data flow event.", "type": "string" }, "eventTime": { -"description": "Timestamp of data flow event.", "format": "google-datetime", "type": "string" }, "operation": { -"description": "The operation performed by the principal for the data flow event.", "enum": [ "OPERATION_UNSPECIFIED", "READ", @@ -5778,40 +4934,34 @@ false "COPY" ], "enumDescriptions": [ -"The operation is unspecified.", -"Represents a read operation.", -"Represents a move operation.", -"Represents a copy operation." +"", +"", +"", +"" ], "type": "string" }, "principalEmail": { -"description": "The email address of the principal that initiated the data flow event. The principal could be a user account, service account, Google group, or other.", "type": "string" }, "violatedLocation": { -"description": "Non-compliant location of the principal or the data destination.", "type": "string" } }, "type": "object" }, "GoogleCloudSecuritycenterV2DataRetentionDeletionEvent": { -"description": "Details about data retention deletion violations, in which the data is non-compliant based on their retention or deletion time, as defined in the applicable data security policy. The Data Retention Deletion (DRD) control is a control of the DSPM (Data Security Posture Management) suite that enables organizations to manage data retention and deletion policies in compliance with regulations, such as GDPR and CRPA. DRD supports two primary policy types: maximum storage length (max TTL) and minimum storage length (min TTL). Both are aimed at helping organizations meet regulatory and data management commitments.", "id": "GoogleCloudSecuritycenterV2DataRetentionDeletionEvent", "properties": { "dataObjectCount": { -"description": "Number of objects that violated the policy for this resource. If the number is less than 1,000, then the value of this field is the exact number. If the number of objects that violated the policy is greater than or equal to 1,000, then the value of this field is 1000.", "format": "int64", "type": "string" }, "eventDetectionTime": { -"description": "Timestamp indicating when the event was detected.", "format": "google-datetime", "type": "string" }, "eventType": { -"description": "Type of the DRD event.", "enum": [ "EVENT_TYPE_UNSPECIFIED", "EVENT_TYPE_MAX_TTL_EXCEEDED", @@ -5827,21 +4977,19 @@ false, false ], "enumDescriptions": [ -"Unspecified event type.", -"Deprecated: This field is pending removal. Use EVENT_TYPE_MAX_TTL_FROM_CREATION or EVENT_TYPE_MAX_TTL_FROM_LAST_MODIFICATION instead.", -"Max TTL from the asset's creation time.", -"Max TTL from the asset's last modification time.", -"Min TTL from the asset's creation time." +"", +"", +"", +"", +"" ], "type": "string" }, "maxRetentionAllowed": { -"description": "Maximum duration of retention allowed from the DRD control. This comes from the DRD control where users set a max TTL for their data. For example, suppose that a user sets the max TTL for a Cloud Storage bucket to 90 days. However, an object in that bucket is 100 days old. In this case, a DataRetentionDeletionEvent will be generated for that Cloud Storage bucket, and the max_retention_allowed is 90 days.", "format": "google-duration", "type": "string" }, "minRetentionAllowed": { -"description": "Min duration of retention allowed from the DSPM retention control. This field is only populated when event type is set to EVENT_TYPE_MIN_TTL_FROM_CREATION.", "format": "google-duration", "type": "string" } @@ -5849,64 +4997,51 @@ false "type": "object" }, "GoogleCloudSecuritycenterV2Database": { -"description": "Represents database access information, such as queries. A database may be a sub-resource of an instance (as in the case of Cloud SQL instances or Cloud Spanner instances), or the database instance itself. Some database resources might not have the [full resource name](https://google.aip.dev/122#full-resource-names) populated because these resource types, such as Cloud SQL databases, are not yet supported by Cloud Asset Inventory. In these cases only the display name is provided.", "id": "GoogleCloudSecuritycenterV2Database", "properties": { "displayName": { -"description": "The human-readable name of the database that the user connected to.", "type": "string" }, "grantees": { -"description": "The target usernames, roles, or groups of an SQL privilege grant, which is not an IAM policy change.", "items": { "type": "string" }, "type": "array" }, "name": { -"description": "Some database resources may not have the [full resource name](https://google.aip.dev/122#full-resource-names) populated because these resource types are not yet supported by Cloud Asset Inventory (e.g. Cloud SQL databases). In these cases only the display name will be provided. The [full resource name](https://google.aip.dev/122#full-resource-names) of the database that the user connected to, if it is supported by Cloud Asset Inventory.", "type": "string" }, "query": { -"description": "The SQL statement that is associated with the database access.", "type": "string" }, "userName": { -"description": "The username used to connect to the database. The username might not be an IAM principal and does not have a set format.", "type": "string" }, "version": { -"description": "The version of the database, for example, POSTGRES_14. See [the complete list](https://cloud.google.com/sql/docs/mysql/admin-api/rest/v1/SqlDatabaseVersion).", "type": "string" } }, "type": "object" }, "GoogleCloudSecuritycenterV2Dataset": { -"description": "Vertex AI dataset associated with the finding.", "id": "GoogleCloudSecuritycenterV2Dataset", "properties": { "displayName": { -"description": "The user defined display name of dataset, e.g. plants-dataset", "type": "string" }, "name": { -"description": "Resource name of the dataset, e.g. projects/{project}/locations/{location}/datasets/2094040236064505856", "type": "string" }, "source": { -"description": "Data source, such as a BigQuery source URI, e.g. bq://scc-nexus-test.AIPPtest.gsod", "type": "string" } }, "type": "object" }, "GoogleCloudSecuritycenterV2Denied": { -"description": "Denied IP rule.", "id": "GoogleCloudSecuritycenterV2Denied", "properties": { "ipRules": { -"description": "Optional. Optional list of denied IP rules.", "items": { "$ref": "GoogleCloudSecuritycenterV2IpRule" }, @@ -5916,15 +5051,12 @@ false "type": "object" }, "GoogleCloudSecuritycenterV2Detection": { -"description": "Memory hash detection contributing to the binary family match.", "id": "GoogleCloudSecuritycenterV2Detection", "properties": { "binary": { -"description": "The name of the binary associated with the memory hash signature detection.", "type": "string" }, "percentPagesMatched": { -"description": "The percentage of memory page hashes in the signature that were matched.", "format": "double", "type": "number" } @@ -5932,35 +5064,29 @@ false "type": "object" }, "GoogleCloudSecuritycenterV2DiscoveredWorkload": { -"description": "Represents discovered, customer managed workload that is not registered with the respective GCP service.", "id": "GoogleCloudSecuritycenterV2DiscoveredWorkload", "properties": { "confidence": { -"description": "The confidence in detection of this workload.", "enum": [ "CONFIDENCE_UNSPECIFIED", "CONFIDENCE_HIGH" ], "enumDescriptions": [ -"Unspecified confidence level.", -"High confidence in detection of a workload." +"", +"" ], "type": "string" }, "detectedRelevantHardware": { -"description": "A boolean flag set to true if associated hardware strongly predicts the workload type.", "type": "boolean" }, "detectedRelevantKeywords": { -"description": "A boolean flag set to true if associated keywords strongly predict the workload type.", "type": "boolean" }, "detectedRelevantPackages": { -"description": "A boolean flag set to true if installed packages strongly predict the workload type.", "type": "boolean" }, "workloadType": { -"description": "The type of workload.", "enum": [ "WORKLOAD_TYPE_UNSPECIFIED", "MCP_SERVER", @@ -5968,10 +5094,10 @@ false "AGENT" ], "enumDescriptions": [ -"Unspecified workload type", -"A workload of type MCP Server", -"A workload of type AI Inference", -"A workload of type LLM Agent" +"", +"", +"", +"" ], "type": "string" } @@ -5979,100 +5105,82 @@ false "type": "object" }, "GoogleCloudSecuritycenterV2Disk": { -"description": "Contains information about the disk associated with the finding.", "id": "GoogleCloudSecuritycenterV2Disk", "properties": { "name": { -"description": "The name of the disk, for example, \"https://www.googleapis.com/compute/v1/projects/{project-id}/zones/{zone-id}/disks/{disk-id}\".", "type": "string" } }, "type": "object" }, "GoogleCloudSecuritycenterV2DiskPath": { -"description": "Path of the file in terms of underlying disk/partition identifiers.", "id": "GoogleCloudSecuritycenterV2DiskPath", "properties": { "partitionUuid": { -"description": "UUID of the partition (format https://wiki.archlinux.org/title/persistent_block_device_naming#by-uuid)", "type": "string" }, "relativePath": { -"description": "Relative path of the file in the partition as a JSON encoded string. Example: /home/user1/executable_file.sh", "type": "string" } }, "type": "object" }, "GoogleCloudSecuritycenterV2DynamicMuteRecord": { -"description": "The record of a dynamic mute rule that matches the finding.", "id": "GoogleCloudSecuritycenterV2DynamicMuteRecord", "properties": { "matchTime": { -"description": "When the dynamic mute rule first matched the finding.", "format": "google-datetime", "type": "string" }, "muteConfig": { -"description": "The relative resource name of the mute rule, represented by a mute config, that created this record, for example `organizations/123/muteConfigs/mymuteconfig` or `organizations/123/locations/global/muteConfigs/mymuteconfig`.", "type": "string" } }, "type": "object" }, "GoogleCloudSecuritycenterV2EnvironmentVariable": { -"description": "A name-value pair representing an environment variable used in an operating system process.", "id": "GoogleCloudSecuritycenterV2EnvironmentVariable", "properties": { "name": { -"description": "Environment variable name as a JSON encoded string.", "type": "string" }, "val": { -"description": "Environment variable value as a JSON encoded string.", "type": "string" } }, "type": "object" }, "GoogleCloudSecuritycenterV2ExfilResource": { -"description": "Resource where data was exfiltrated from or exfiltrated to.", "id": "GoogleCloudSecuritycenterV2ExfilResource", "properties": { "components": { -"description": "Subcomponents of the asset that was exfiltrated, like URIs used during exfiltration, table names, databases, and filenames. For example, multiple tables might have been exfiltrated from the same Cloud SQL instance, or multiple files might have been exfiltrated from the same Cloud Storage bucket.", "items": { "type": "string" }, "type": "array" }, "name": { -"description": "The resource's [full resource name](https://cloud.google.com/apis/design/resource_names#full_resource_name).", "type": "string" } }, "type": "object" }, "GoogleCloudSecuritycenterV2Exfiltration": { -"description": "Exfiltration represents a data exfiltration attempt from one or more sources to one or more targets. The `sources` attribute lists the sources of the exfiltrated data. The `targets` attribute lists the destinations the data was copied to.", "id": "GoogleCloudSecuritycenterV2Exfiltration", "properties": { "sources": { -"description": "If there are multiple sources, then the data is considered \"joined\" between them. For instance, BigQuery can join multiple tables, and each table would be considered a source.", "items": { "$ref": "GoogleCloudSecuritycenterV2ExfilResource" }, "type": "array" }, "targets": { -"description": "If there are multiple targets, each target would get a complete copy of the \"joined\" source data.", "items": { "$ref": "GoogleCloudSecuritycenterV2ExfilResource" }, "type": "array" }, "totalExfiltratedBytes": { -"description": "Total exfiltrated bytes processed for the entire job.", "format": "int64", "type": "string" } @@ -6080,205 +5188,162 @@ false "type": "object" }, "GoogleCloudSecuritycenterV2ExternalExposure": { -"description": "Details about the externally exposed resource associated with the finding.", "id": "GoogleCloudSecuritycenterV2ExternalExposure", "properties": { "backendBucket": { -"description": "The full resource name of the load balancer backend bucket, for example, \"//compute.googleapis.com/projects/{project-id}/global/backendBuckets/{name}\"", "type": "string" }, "backendService": { -"description": "The full resource name of load balancer backend service, for example, \"//compute.googleapis.com/projects/{project-id}/global/backendServices/{name}\".", "type": "string" }, "exposedApplication": { -"description": "The name and version of the exposed web application, for example, \"Jenkins 2.184\".", "type": "string" }, "exposedEndpoint": { -"description": "The resource which is running the exposed service, for example, \"//compute.googleapis.com/projects/{project-id}/zones/{zone}/instances/{instance}.\u201d", "type": "string" }, "exposedService": { -"description": "The name and version of the service, for example, \"Jupyter Notebook 6.14.0\".", "type": "string" }, "forwardingRule": { -"description": "The full resource name of the forwarding rule, for example, \"//compute.googleapis.com/projects/{project-id}/global/forwardingRules/{forwarding-rule-name}\".", "type": "string" }, "hostnameUri": { -"description": "Hostname of the exposed application, for example, \"https://test-app.a.run.app/\"", "type": "string" }, "httpResponse": { -"description": "The http response returned by the web application.", "items": { "$ref": "GoogleCloudSecuritycenterV2HttpResponse" }, "type": "array" }, "instanceGroup": { -"description": "The full resource name of the instance group, for example, \"//compute.googleapis.com/projects/{project-id}/global/instanceGroups/{name}\".", "type": "string" }, "internalBackendService": { -"description": "The full resource name of load balancer backend service in the internal project having resource exposed via PSC, for example, \"//compute.googleapis.com/projects/{project-id}/global/backendServices/{name}\".", "type": "string" }, "loadBalancerFirewallPolicy": { -"description": "The full resource name of the load balancer firewall policy, for example, \"//compute.googleapis.com/projects/{project-id}/global/firewallPolicies/{policy-name}\".", "type": "string" }, "networkEndpointGroup": { -"description": "The full resource name of the network endpoint group, for example, \"//compute.googleapis.com/projects/{project-id}/global/networkEndpointGroups/{name}\".", "type": "string" }, "networkIngressFirewallPolicy": { -"description": "The full resource name of the network ingress firewall policy, for example, \"//compute.googleapis.com/projects/{project-id}/global/firewallPolicies/{name}\".", "type": "string" }, "privateIpAddress": { -"description": "Private IP address of the exposed endpoint.", "type": "string" }, "privatePort": { -"description": "Port number associated with private IP address.", "type": "string" }, "pscNetworkAttachment": { -"description": "The full resource name of the PSC (Private Service Connect) network attachment that network interface controller is attached to, for example, \"//compute.googleapis.com/projects/{project-id}/regions/{region}/networkAttachments/{name}\"", "type": "string" }, "pscServiceAttachment": { -"description": "The full resource name of the PSC (Private Service Connect) service attachment that the load balancer network endpoint group targets, for example, \"//compute.googleapis.com/projects/{project-id}/regions/{region}/serviceAttachments/{name}\"", "type": "string" }, "publicIpAddress": { -"description": "Public IP address of the exposed endpoint.", "type": "string" }, "publicPort": { -"description": "Public port number of the exposed endpoint.", "type": "string" }, "serviceFirewallPolicy": { -"description": "The full resource name of the firewall policy of the exposed service, for example, \"//compute.googleapis.com/projects/{project-id}/global/firewallPolicies/{policy-name}\".", "type": "string" } }, "type": "object" }, "GoogleCloudSecuritycenterV2ExternalSystem": { -"description": "Representation of third party SIEM/SOAR fields within SCC.", "id": "GoogleCloudSecuritycenterV2ExternalSystem", "properties": { "assignees": { -"description": "References primary/secondary etc assignees in the external system.", "items": { "type": "string" }, "type": "array" }, "caseCloseTime": { -"description": "The time when the case was closed, as reported by the external system.", "format": "google-datetime", "type": "string" }, "caseCreateTime": { -"description": "The time when the case was created, as reported by the external system.", "format": "google-datetime", "type": "string" }, "casePriority": { -"description": "The priority of the finding's corresponding case in the external system.", "type": "string" }, "caseSla": { -"description": "The SLA of the finding's corresponding case in the external system.", "format": "google-datetime", "type": "string" }, "caseUri": { -"description": "The link to the finding's corresponding case in the external system.", "type": "string" }, "externalSystemUpdateTime": { -"description": "The time when the case was last updated, as reported by the external system.", "format": "google-datetime", "type": "string" }, "externalUid": { -"description": "The identifier that's used to track the finding's corresponding case in the external system.", "type": "string" }, "name": { -"description": "Full resource name of the external system. The following list shows some examples: + `organizations/1234/sources/5678/findings/123456/externalSystems/jira` + `organizations/1234/sources/5678/locations/us/findings/123456/externalSystems/jira` + `folders/1234/sources/5678/findings/123456/externalSystems/jira` + `folders/1234/sources/5678/locations/us/findings/123456/externalSystems/jira` + `projects/1234/sources/5678/findings/123456/externalSystems/jira` + `projects/1234/sources/5678/locations/us/findings/123456/externalSystems/jira`", "type": "string" }, "status": { -"description": "The most recent status of the finding's corresponding case, as reported by the external system.", "type": "string" }, "ticketInfo": { -"$ref": "GoogleCloudSecuritycenterV2TicketInfo", -"description": "Information about the ticket, if any, that is being used to track the resolution of the issue that is identified by this finding." +"$ref": "GoogleCloudSecuritycenterV2TicketInfo" } }, "type": "object" }, "GoogleCloudSecuritycenterV2File": { -"description": "File information about the related binary/library used by an executable, or the script used by a script interpreter", "id": "GoogleCloudSecuritycenterV2File", "properties": { "contents": { -"description": "Prefix of the file contents as a JSON-encoded string.", "type": "string" }, "diskPath": { -"$ref": "GoogleCloudSecuritycenterV2DiskPath", -"description": "Path of the file in terms of underlying disk/partition identifiers." +"$ref": "GoogleCloudSecuritycenterV2DiskPath" }, "fileLoadState": { -"description": "The load state of the file.", "enum": [ "FILE_LOAD_STATE_UNSPECIFIED", "LOADED_BY_PROCESS", "NOT_LOADED_BY_PROCESS" ], "enumDescriptions": [ -"The file state is unspecified.", -"The file is being used by an active process at the time of scanning.", -"The file is not being used by any active process at the time of scanning." +"", +"", +"" ], "type": "string" }, "hashedSize": { -"description": "The length in bytes of the file prefix that was hashed. If hashed_size == size, any hashes reported represent the entire file.", "format": "int64", "type": "string" }, "operations": { -"description": "Operation(s) performed on a file.", "items": { "$ref": "GoogleCloudSecuritycenterV2FileOperation" }, "type": "array" }, "partiallyHashed": { -"description": "True when the hash covers only a prefix of the file.", "type": "boolean" }, "path": { -"description": "Absolute path of the file as a JSON encoded string.", "type": "string" }, "sha256": { -"description": "SHA256 hash of the first hashed_size bytes of the file encoded as a hex string. If hashed_size == size, sha256 represents the SHA256 hash of the entire file.", "type": "string" }, "size": { -"description": "Size of the file in bytes.", "format": "int64", "type": "string" } @@ -6286,11 +5351,9 @@ false "type": "object" }, "GoogleCloudSecuritycenterV2FileOperation": { -"description": "Operation(s) performed on a file.", "id": "GoogleCloudSecuritycenterV2FileOperation", "properties": { "type": { -"description": "The type of the operation", "enum": [ "OPERATION_TYPE_UNSPECIFIED", "OPEN", @@ -6300,12 +5363,12 @@ false "EXECUTE" ], "enumDescriptions": [ -"The operation is unspecified.", -"Represents an open operation.", -"Represents a read operation.", -"Represents a rename operation.", -"Represents a write operation.", -"Represents an execute operation." +"", +"", +"", +"", +"", +"" ], "type": "string" } @@ -6313,82 +5376,64 @@ false "type": "object" }, "GoogleCloudSecuritycenterV2Finding": { -"description": "Security Command Center finding. A finding is a record of assessment data like security, risk, health, or privacy, that is ingested into Security Command Center for presentation, notification, analysis, policy testing, and enforcement. For example, a cross-site scripting (XSS) vulnerability in an App Engine application is a finding.", "id": "GoogleCloudSecuritycenterV2Finding", "properties": { "access": { -"$ref": "GoogleCloudSecuritycenterV2Access", -"description": "Access details associated with the finding, such as more information on the caller, which method was accessed, and from where." +"$ref": "GoogleCloudSecuritycenterV2Access" }, "affectedResources": { -"$ref": "GoogleCloudSecuritycenterV2AffectedResources", -"description": "AffectedResources associated with the finding." +"$ref": "GoogleCloudSecuritycenterV2AffectedResources" }, "agentDataAccessEvents": { -"description": "Agent data access events associated with the finding.", "items": { "$ref": "GoogleCloudSecuritycenterV2AgentDataAccessEvent" }, "type": "array" }, "aiModel": { -"$ref": "GoogleCloudSecuritycenterV2AiModel", -"description": "The AI model associated with the finding." +"$ref": "GoogleCloudSecuritycenterV2AiModel" }, "application": { -"$ref": "GoogleCloudSecuritycenterV2Application", -"description": "Represents an application associated with the finding." +"$ref": "GoogleCloudSecuritycenterV2Application" }, "artifactGuardPolicies": { -"$ref": "GoogleCloudSecuritycenterV2ArtifactGuardPolicies", -"description": "ArtifactGuardPolicies associated with the finding." +"$ref": "GoogleCloudSecuritycenterV2ArtifactGuardPolicies" }, "attackExposure": { -"$ref": "GoogleCloudSecuritycenterV2AttackExposure", -"description": "The results of an attack path simulation relevant to this finding." +"$ref": "GoogleCloudSecuritycenterV2AttackExposure" }, "backupDisasterRecovery": { -"$ref": "GoogleCloudSecuritycenterV2BackupDisasterRecovery", -"description": "Fields related to Backup and DR findings." +"$ref": "GoogleCloudSecuritycenterV2BackupDisasterRecovery" }, "canonicalName": { -"description": "Output only. The canonical name of the finding. The following list shows some examples: + `organizations/{organization_id}/sources/{source_id}/locations/{location_id}/findings/{finding_id}` + `folders/{folder_id}/sources/{source_id}/locations/{location_id}/findings/{finding_id}` + `projects/{project_id}/sources/{source_id}/locations/{location_id}/findings/{finding_id}` The prefix is the closest CRM ancestor of the resource associated with the finding.", "readOnly": true, "type": "string" }, "category": { -"description": "Immutable. The additional taxonomy group within findings from a given source. Example: \"XSS_FLASH_INJECTION\"", "type": "string" }, "chokepoint": { -"$ref": "GoogleCloudSecuritycenterV2Chokepoint", -"description": "Contains details about a chokepoint, which is a resource or resource group where high-risk attack paths converge, based on [attack path simulations] (https://cloud.google.com/security-command-center/docs/attack-exposure-learn#attack_path_simulations). This field cannot be updated. Its value is ignored in all update requests." +"$ref": "GoogleCloudSecuritycenterV2Chokepoint" }, "cloudArmor": { -"$ref": "GoogleCloudSecuritycenterV2CloudArmor", -"description": "Fields related to Cloud Armor findings." +"$ref": "GoogleCloudSecuritycenterV2CloudArmor" }, "cloudDlpDataProfile": { -"$ref": "GoogleCloudSecuritycenterV2CloudDlpDataProfile", -"description": "Cloud DLP data profile that is associated with the finding." +"$ref": "GoogleCloudSecuritycenterV2CloudDlpDataProfile" }, "cloudDlpInspection": { -"$ref": "GoogleCloudSecuritycenterV2CloudDlpInspection", -"description": "Cloud Data Loss Prevention (Cloud DLP) inspection results that are associated with the finding." +"$ref": "GoogleCloudSecuritycenterV2CloudDlpInspection" }, "complianceDetails": { -"$ref": "GoogleCloudSecuritycenterV2ComplianceDetails", -"description": "Details about the compliance implications of the finding." +"$ref": "GoogleCloudSecuritycenterV2ComplianceDetails" }, "compliances": { -"description": "Contains compliance information for security standards associated to the finding.", "items": { "$ref": "GoogleCloudSecuritycenterV2Compliance" }, "type": "array" }, "connections": { -"description": "Contains information about the IP connection associated with the finding.", "items": { "$ref": "GoogleCloudSecuritycenterV2Connection" }, @@ -6398,99 +5443,81 @@ false "additionalProperties": { "$ref": "GoogleCloudSecuritycenterV2ContactDetails" }, -"description": "Output only. Map containing the points of contact for the given finding. The key represents the type of contact, while the value contains a list of all the contacts that pertain. Please refer to: https://cloud.google.com/resource-manager/docs/managing-notification-contacts#notification-categories { \"security\": { \"contacts\": [ { \"email\": \"person1@company.com\" }, { \"email\": \"person2@company.com\" } ] } }", "readOnly": true, "type": "object" }, "containers": { -"description": "Containers associated with the finding. This field provides information for both Kubernetes and non-Kubernetes containers.", "items": { "$ref": "GoogleCloudSecuritycenterV2Container" }, "type": "array" }, "createTime": { -"description": "Output only. The time at which the finding was created in Security Command Center.", "format": "google-datetime", "readOnly": true, "type": "string" }, "cryptoKeyName": { -"description": "Output only. The name of the Cloud KMS key used to encrypt this finding, if any.", "readOnly": true, "type": "string" }, "dataAccessEvents": { -"description": "Data access events associated with the finding.", "items": { "$ref": "GoogleCloudSecuritycenterV2DataAccessEvent" }, "type": "array" }, "dataFlowEvents": { -"description": "Data flow events associated with the finding.", "items": { "$ref": "GoogleCloudSecuritycenterV2DataFlowEvent" }, "type": "array" }, "dataRetentionDeletionEvents": { -"description": "Data retention deletion events associated with the finding.", "items": { "$ref": "GoogleCloudSecuritycenterV2DataRetentionDeletionEvent" }, "type": "array" }, "database": { -"$ref": "GoogleCloudSecuritycenterV2Database", -"description": "Database associated with the finding." +"$ref": "GoogleCloudSecuritycenterV2Database" }, "description": { -"description": "Contains more details about the finding.", "type": "string" }, "discoveredWorkload": { -"$ref": "GoogleCloudSecuritycenterV2DiscoveredWorkload", -"description": "DiscoveredWorkload associated with the finding." +"$ref": "GoogleCloudSecuritycenterV2DiscoveredWorkload" }, "disk": { -"$ref": "GoogleCloudSecuritycenterV2Disk", -"description": "Disk associated with the finding." +"$ref": "GoogleCloudSecuritycenterV2Disk" }, "eventTime": { -"description": "The time the finding was first detected. If an existing finding is updated, then this is the time the update occurred. For example, if the finding represents an open firewall, this property captures the time the detector believes the firewall became open. The accuracy is determined by the detector. If the finding is later resolved, then this time reflects when the finding was resolved. This must not be set to a value greater than the current timestamp.", "format": "google-datetime", "type": "string" }, "exfiltration": { -"$ref": "GoogleCloudSecuritycenterV2Exfiltration", -"description": "Represents exfiltrations associated with the finding." +"$ref": "GoogleCloudSecuritycenterV2Exfiltration" }, "externalExposure": { -"$ref": "GoogleCloudSecuritycenterV2ExternalExposure", -"description": "External exposure associated with the finding." +"$ref": "GoogleCloudSecuritycenterV2ExternalExposure" }, "externalSystems": { "additionalProperties": { "$ref": "GoogleCloudSecuritycenterV2ExternalSystem" }, -"description": "Output only. Third party SIEM/SOAR fields within SCC, contains external system information and external system finding fields.", "readOnly": true, "type": "object" }, "externalUri": { -"description": "The URI that, if available, points to a web page outside of Security Command Center where additional information about the finding can be found. This field is guaranteed to be either empty or a well formed URL.", "type": "string" }, "files": { -"description": "File associated with the finding.", "items": { "$ref": "GoogleCloudSecuritycenterV2File" }, "type": "array" }, "findingClass": { -"description": "The class of the finding.", "enum": [ "FINDING_CLASS_UNSPECIFIED", "THREAT", @@ -6506,79 +5533,67 @@ false "SECRET" ], "enumDescriptions": [ -"Unspecified finding class.", -"Describes unwanted or malicious activity.", -"Describes a potential weakness in software that increases risk to Confidentiality & Integrity & Availability.", -"Describes a potential weakness in cloud resource/asset configuration that increases risk.", -"Describes a security observation that is for informational purposes.", -"Describes an error that prevents some SCC functionality.", -"Describes a potential security risk due to a change in the security posture.", -"Describes a combination of security issues that represent a more severe security problem when taken together.", -"Describes a potential security risk to data assets that contain sensitive data.", -"Describes a resource or resource group where high risk attack paths converge, based on attack path simulations (APS).", -"Describes a potential security risk due to the resource being exposed to the internet.", -"Describes a potential security risk due to plaintext credentials, keys, or tokens being exposed in an asset or workload." +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"" ], "type": "string" }, "groupMemberships": { -"description": "Contains details about groups of which this finding is a member. A group is a collection of findings that are related in some way. This field cannot be updated. Its value is ignored in all update requests.", "items": { "$ref": "GoogleCloudSecuritycenterV2GroupMembership" }, "type": "array" }, "iamBindings": { -"description": "Represents IAM bindings associated with the finding.", "items": { "$ref": "GoogleCloudSecuritycenterV2IamBinding" }, "type": "array" }, "indicator": { -"$ref": "GoogleCloudSecuritycenterV2Indicator", -"description": "Represents what's commonly known as an *indicator of compromise* (IoC) in computer forensics. This is an artifact observed on a network or in an operating system that, with high confidence, indicates a computer intrusion. For more information, see [Indicator of compromise](https://en.wikipedia.org/wiki/Indicator_of_compromise)." +"$ref": "GoogleCloudSecuritycenterV2Indicator" }, "ipRules": { -"$ref": "GoogleCloudSecuritycenterV2IpRules", -"description": "IP rules associated with the finding." +"$ref": "GoogleCloudSecuritycenterV2IpRules" }, "job": { -"$ref": "GoogleCloudSecuritycenterV2Job", -"description": "Job associated with the finding." +"$ref": "GoogleCloudSecuritycenterV2Job" }, "kernelRootkit": { -"$ref": "GoogleCloudSecuritycenterV2KernelRootkit", -"description": "Signature of the kernel rootkit." +"$ref": "GoogleCloudSecuritycenterV2KernelRootkit" }, "kubernetes": { -"$ref": "GoogleCloudSecuritycenterV2Kubernetes", -"description": "Kubernetes resources associated with the finding." +"$ref": "GoogleCloudSecuritycenterV2Kubernetes" }, "loadBalancers": { -"description": "The load balancers associated with the finding.", "items": { "$ref": "GoogleCloudSecuritycenterV2LoadBalancer" }, "type": "array" }, "logEntries": { -"description": "Log entries that are relevant to the finding.", "items": { "$ref": "GoogleCloudSecuritycenterV2LogEntry" }, "type": "array" }, "mitreAttack": { -"$ref": "GoogleCloudSecuritycenterV2MitreAttack", -"description": "MITRE ATT&CK tactics and techniques related to this finding. See: https://attack.mitre.org" +"$ref": "GoogleCloudSecuritycenterV2MitreAttack" }, "moduleName": { -"description": "Unique identifier of the module which generated the finding. Example: folders/598186756061/securityHealthAnalyticsSettings/customModules/56799441161885", "type": "string" }, "mute": { -"description": "Indicates the mute state of a finding (either muted, unmuted or undefined). Unlike other attributes of a finding, a finding provider shouldn't set the value of mute.", "enum": [ "MUTE_UNSPECIFIED", "MUTED", @@ -6586,93 +5601,76 @@ false "UNDEFINED" ], "enumDescriptions": [ -"Unspecified.", -"Finding has been muted.", -"Finding has been unmuted.", -"Finding has never been muted/unmuted." +"", +"", +"", +"" ], "type": "string" }, "muteInfo": { "$ref": "GoogleCloudSecuritycenterV2MuteInfo", -"description": "Output only. The mute information regarding this finding.", "readOnly": true }, "muteInitiator": { -"description": "Records additional information about the mute operation, for example, the [mute configuration](https://cloud.google.com/security-command-center/docs/how-to-mute-findings) that muted the finding and the user who muted the finding.", "type": "string" }, "muteUpdateTime": { -"description": "Output only. The most recent time this finding was muted or unmuted.", "format": "google-datetime", "readOnly": true, "type": "string" }, "name": { -"description": "Identifier. The [relative resource name](https://cloud.google.com/apis/design/resource_names#relative_resource_name) of the finding. The following list shows some examples: + `organizations/{organization_id}/sources/{source_id}/findings/{finding_id}` + `organizations/{organization_id}/sources/{source_id}/locations/{location_id}/findings/{finding_id}` + `folders/{folder_id}/sources/{source_id}/findings/{finding_id}` + `folders/{folder_id}/sources/{source_id}/locations/{location_id}/findings/{finding_id}` + `projects/{project_id}/sources/{source_id}/findings/{finding_id}` + `projects/{project_id}/sources/{source_id}/locations/{location_id}/findings/{finding_id}`", "type": "string" }, "networks": { -"description": "Represents the VPC networks that the resource is attached to.", "items": { "$ref": "GoogleCloudSecuritycenterV2Network" }, "type": "array" }, "nextSteps": { -"description": "Steps to address the finding.", "type": "string" }, "notebook": { -"$ref": "GoogleCloudSecuritycenterV2Notebook", -"description": "Notebook associated with the finding." +"$ref": "GoogleCloudSecuritycenterV2Notebook" }, "orgPolicies": { -"description": "Contains information about the org policies associated with the finding.", "items": { "$ref": "GoogleCloudSecuritycenterV2OrgPolicy" }, "type": "array" }, "parent": { -"description": "The relative resource name of the source and location the finding belongs to. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name This field is immutable after creation time. The following list shows some examples: + `organizations/{organization_id}/sources/{source_id}` + `folders/{folders_id}/sources/{source_id}` + `projects/{projects_id}/sources/{source_id}` + `organizations/{organization_id}/sources/{source_id}/locations/{location_id}` + `folders/{folders_id}/sources/{source_id}/locations/{location_id}` + `projects/{projects_id}/sources/{source_id}/locations/{location_id}`", "type": "string" }, "parentDisplayName": { -"description": "Output only. The human readable display name of the finding source such as \"Event Threat Detection\" or \"Security Health Analytics\".", "readOnly": true, "type": "string" }, "policyViolationSummary": { -"$ref": "GoogleCloudSecuritycenterV2PolicyViolationSummary", -"description": "PolicyViolationSummary associated with the finding." +"$ref": "GoogleCloudSecuritycenterV2PolicyViolationSummary" }, "processes": { -"description": "Represents operating system processes associated with the Finding.", "items": { "$ref": "GoogleCloudSecuritycenterV2Process" }, "type": "array" }, "resourceName": { -"description": "Immutable. For findings on Google Cloud resources, the full resource name of the Google Cloud resource this finding is for. See: https://cloud.google.com/apis/design/resource_names#full_resource_name When the finding is for a non-Google Cloud resource, the resourceName can be a customer or partner defined string.", "type": "string" }, "secret": { -"$ref": "GoogleCloudSecuritycenterV2Secret", -"description": "Secret associated with the finding." +"$ref": "GoogleCloudSecuritycenterV2Secret" }, "securityMarks": { "$ref": "GoogleCloudSecuritycenterV2SecurityMarks", -"description": "Output only. User specified security marks. These marks are entirely managed by the user and come from the SecurityMarks resource that belongs to the finding.", "readOnly": true }, "securityPosture": { -"$ref": "GoogleCloudSecuritycenterV2SecurityPosture", -"description": "The security posture associated with the finding." +"$ref": "GoogleCloudSecuritycenterV2SecurityPosture" }, "severity": { -"description": "The severity of the finding. This field is managed by the source that writes the finding.", "enum": [ "SEVERITY_UNSPECIFIED", "CRITICAL", @@ -6681,11 +5679,11 @@ false "LOW" ], "enumDescriptions": [ -"This value is used for findings when a source doesn't write a severity value.", -"Vulnerability: A critical vulnerability is easily discoverable by an external actor, exploitable, and results in the direct ability to execute arbitrary code, exfiltrate data, and otherwise gain additional access and privileges to cloud resources and workloads. Examples include publicly accessible unprotected user data and public SSH access with weak or no passwords. Threat: Indicates a threat that is able to access, modify, or delete data or execute unauthorized code within existing resources.", -"Vulnerability: A high risk vulnerability can be easily discovered and exploited in combination with other vulnerabilities in order to gain direct access and the ability to execute arbitrary code, exfiltrate data, and otherwise gain additional access and privileges to cloud resources and workloads. An example is a database with weak or no passwords that is only accessible internally. This database could easily be compromised by an actor that had access to the internal network. Threat: Indicates a threat that is able to create new computational resources in an environment but not able to access data or execute code in existing resources.", -"Vulnerability: A medium risk vulnerability could be used by an actor to gain access to resources or privileges that enable them to eventually (through multiple steps or a complex exploit) gain access and the ability to execute arbitrary code or exfiltrate data. An example is a service account with access to more projects than it should have. If an actor gains access to the service account, they could potentially use that access to manipulate a project the service account was not intended to. Threat: Indicates a threat that is able to cause operational impact but may not access data or execute unauthorized code.", -"Vulnerability: A low risk vulnerability hampers a security organization's ability to detect vulnerabilities or active threats in their deployment, or prevents the root cause investigation of security issues. An example is monitoring and logs being disabled for resource configurations and access. Threat: Indicates a threat that has obtained minimal access to an environment but is not able to access data, execute code, or create resources." +"", +"", +"", +"", +"" ], "type": "string" }, @@ -6693,60 +5691,50 @@ false "additionalProperties": { "type": "any" }, -"description": "Source specific properties. These properties are managed by the source that writes the finding. The key names in the source_properties map must be between 1 and 255 characters, and must start with a letter and contain alphanumeric characters or underscores only.", "type": "object" }, "state": { -"description": "Output only. The state of the finding.", "enum": [ "STATE_UNSPECIFIED", "ACTIVE", "INACTIVE" ], "enumDescriptions": [ -"Unspecified state.", -"The finding requires attention and has not been addressed yet.", -"The finding has been fixed, triaged as a non-issue or otherwise addressed and is no longer active." +"", +"", +"" ], "readOnly": true, "type": "string" }, "toxicCombination": { -"$ref": "GoogleCloudSecuritycenterV2ToxicCombination", -"description": "Contains details about a group of security issues that, when the issues occur together, represent a greater risk than when the issues occur independently. A group of such issues is referred to as a toxic combination. This field cannot be updated. Its value is ignored in all update requests." +"$ref": "GoogleCloudSecuritycenterV2ToxicCombination" }, "vertexAi": { -"$ref": "GoogleCloudSecuritycenterV2VertexAi", -"description": "VertexAi associated with the finding." +"$ref": "GoogleCloudSecuritycenterV2VertexAi" }, "vulnerability": { -"$ref": "GoogleCloudSecuritycenterV2Vulnerability", -"description": "Represents vulnerability-specific fields like CVE and CVSS scores. CVE stands for Common Vulnerabilities and Exposures (https://cve.mitre.org/about/)" +"$ref": "GoogleCloudSecuritycenterV2Vulnerability" } }, "type": "object" }, "GoogleCloudSecuritycenterV2Folder": { -"description": "Message that contains the resource name and display name of a folder resource.", "id": "GoogleCloudSecuritycenterV2Folder", "properties": { "resourceFolder": { -"description": "Full resource name of this folder. See: https://cloud.google.com/apis/design/resource_names#full_resource_name", "type": "string" }, "resourceFolderDisplayName": { -"description": "The user defined display name for this folder.", "type": "string" } }, "type": "object" }, "GoogleCloudSecuritycenterV2Framework": { -"description": "Compliance framework associated with the finding.", "id": "GoogleCloudSecuritycenterV2Framework", "properties": { "category": { -"description": "Category of the framework associated with the finding. E.g. Security Benchmark, or Assured Workloads", "items": { "enum": [ "FRAMEWORK_CATEGORY_UNSPECIFIED", @@ -6757,43 +5745,39 @@ false "CUSTOM_FRAMEWORK" ], "enumDescriptions": [ -"Default value. This value is unused.", -"Security Benchmarks framework", -"Assured Workloads framework", -"Data Security framework", -"Google Best Practices framework", -"A user-created framework" +"", +"", +"", +"", +"", +"" ], "type": "string" }, "type": "array" }, "controls": { -"description": "The controls associated with the framework.", "items": { "$ref": "GoogleCloudSecuritycenterV2Control" }, "type": "array" }, "displayName": { -"description": "Display name of the framework. For a standard framework, this will look like e.g. PCI DSS 3.2.1, whereas for a custom framework it can be a user defined string like MyFramework", "type": "string" }, "name": { -"description": "Name of the framework associated with the finding", "type": "string" }, "type": { -"description": "Type of the framework associated with the finding, to specify whether the framework is built-in (pre-defined and immutable) or a custom framework defined by the customer (equivalent to security posture)", "enum": [ "FRAMEWORK_TYPE_UNSPECIFIED", "FRAMEWORK_TYPE_BUILT_IN", "FRAMEWORK_TYPE_CUSTOM" ], "enumDescriptions": [ -"Default value. This value is unused.", -"The framework is a built-in framework if it is created and managed by GCP.", -"The framework is a custom framework if it is created and managed by the user." +"", +"", +"" ], "type": "string" } @@ -6801,35 +5785,30 @@ false "type": "object" }, "GoogleCloudSecuritycenterV2Geolocation": { -"description": "Represents a geographical location for a given access.", "id": "GoogleCloudSecuritycenterV2Geolocation", "properties": { "regionCode": { -"description": "A CLDR.", "type": "string" } }, "type": "object" }, "GoogleCloudSecuritycenterV2GroupMembership": { -"description": "Contains details about groups of which this finding is a member. A group is a collection of findings that are related in some way.", "id": "GoogleCloudSecuritycenterV2GroupMembership", "properties": { "groupId": { -"description": "ID of the group.", "type": "string" }, "groupType": { -"description": "Type of group.", "enum": [ "GROUP_TYPE_UNSPECIFIED", "GROUP_TYPE_TOXIC_COMBINATION", "GROUP_TYPE_CHOKEPOINT" ], "enumDescriptions": [ -"Default value.", -"Group represents a toxic combination.", -"Group represents a chokepoint." +"", +"", +"" ], "type": "string" } @@ -6837,76 +5816,64 @@ false "type": "object" }, "GoogleCloudSecuritycenterV2HttpResponse": { -"description": "The http response returned by the web application.", "id": "GoogleCloudSecuritycenterV2HttpResponse", "properties": { "path": { -"description": "The http path for which response code was returned by web application, for example, \"https://test-app.a.run.app/test\".", "type": "string" }, "statusCode": { -"description": "The http response code returned by the web application, for example, 200.", "type": "string" } }, "type": "object" }, "GoogleCloudSecuritycenterV2IamBinding": { -"description": "Represents a particular IAM binding, which captures a member's role addition, removal, or state.", "id": "GoogleCloudSecuritycenterV2IamBinding", "properties": { "action": { -"description": "The action that was performed on a Binding.", "enum": [ "ACTION_UNSPECIFIED", "ADD", "REMOVE" ], "enumDescriptions": [ -"Unspecified.", -"Addition of a Binding.", -"Removal of a Binding." +"", +"", +"" ], "type": "string" }, "member": { -"description": "A single identity requesting access for a Cloud Platform resource, for example, \"foo@google.com\".", "type": "string" }, "role": { -"description": "Role that is assigned to \"members\". For example, \"roles/viewer\", \"roles/editor\", or \"roles/owner\".", "type": "string" } }, "type": "object" }, "GoogleCloudSecuritycenterV2Indicator": { -"description": "Represents what's commonly known as an _indicator of compromise_ (IoC) in computer forensics. This is an artifact observed on a network or in an operating system that, with high confidence, indicates a computer intrusion. For more information, see [Indicator of compromise](https://en.wikipedia.org/wiki/Indicator_of_compromise).", "id": "GoogleCloudSecuritycenterV2Indicator", "properties": { "domains": { -"description": "List of domains associated to the Finding.", "items": { "type": "string" }, "type": "array" }, "ipAddresses": { -"description": "The list of IP addresses that are associated with the finding.", "items": { "type": "string" }, "type": "array" }, "signatures": { -"description": "The list of matched signatures indicating that the given process is present in the environment.", "items": { "$ref": "GoogleCloudSecuritycenterV2ProcessSignature" }, "type": "array" }, "uris": { -"description": "The list of URIs associated to the Findings.", "items": { "type": "string" }, @@ -6916,84 +5883,70 @@ false "type": "object" }, "GoogleCloudSecuritycenterV2InfoType": { -"description": "Type of information detected by the API.", "id": "GoogleCloudSecuritycenterV2InfoType", "properties": { "name": { -"description": "Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`.", "type": "string" }, "sensitivityScore": { -"$ref": "GoogleCloudSecuritycenterV2SensitivityScore", -"description": "Optional custom sensitivity for this InfoType. This only applies to data profiling." +"$ref": "GoogleCloudSecuritycenterV2SensitivityScore" }, "version": { -"description": "Optional version name for this InfoType.", "type": "string" } }, "type": "object" }, "GoogleCloudSecuritycenterV2IpRule": { -"description": "IP rule information.", "id": "GoogleCloudSecuritycenterV2IpRule", "properties": { "portRanges": { -"description": "Optional. An optional list of ports to which this rule applies. This field is only applicable for the UDP or (S)TCP protocols. Each entry must be either an integer or a range including a min and max port number.", "items": { "$ref": "GoogleCloudSecuritycenterV2PortRange" }, "type": "array" }, "protocol": { -"description": "The IP protocol this rule applies to. This value can either be one of the following well known protocol strings (TCP, UDP, ICMP, ESP, AH, IPIP, SCTP) or a string representation of the integer value.", "type": "string" } }, "type": "object" }, "GoogleCloudSecuritycenterV2IpRules": { -"description": "IP rules associated with the finding.", "id": "GoogleCloudSecuritycenterV2IpRules", "properties": { "allowed": { -"$ref": "GoogleCloudSecuritycenterV2Allowed", -"description": "Tuple with allowed rules." +"$ref": "GoogleCloudSecuritycenterV2Allowed" }, "denied": { -"$ref": "GoogleCloudSecuritycenterV2Denied", -"description": "Tuple with denied rules." +"$ref": "GoogleCloudSecuritycenterV2Denied" }, "destinationIpRanges": { -"description": "If destination IP ranges are specified, the firewall rule applies only to traffic that has a destination IP address in these ranges. These ranges must be expressed in CIDR format. Only supports IPv4.", "items": { "type": "string" }, "type": "array" }, "direction": { -"description": "The direction that the rule is applicable to, one of ingress or egress.", "enum": [ "DIRECTION_UNSPECIFIED", "INGRESS", "EGRESS" ], "enumDescriptions": [ -"Unspecified direction value.", -"Ingress direction value.", -"Egress direction value." +"", +"", +"" ], "type": "string" }, "exposedServices": { -"description": "Name of the network protocol service, such as FTP, that is exposed by the open port. Follows the naming convention available at: https://www.iana.org/assignments/service-names-port-numbers/service-names-port-numbers.xhtml.", "items": { "type": "string" }, "type": "array" }, "sourceIpRanges": { -"description": "If source IP ranges are specified, the firewall rule applies only to traffic that has a source IP address in these ranges. These ranges must be expressed in CIDR format. Only supports IPv4.", "items": { "type": "string" }, @@ -7003,37 +5956,30 @@ false "type": "object" }, "GoogleCloudSecuritycenterV2Issue": { -"description": "Security Command Center Issue.", "id": "GoogleCloudSecuritycenterV2Issue", "properties": { "createTime": { -"description": "Output only. The time the issue was created.", "format": "google-datetime", "readOnly": true, "type": "string" }, "description": { -"description": "The description of the issue in Markdown format.", "type": "string" }, "detection": { -"description": "The finding category or rule name that generated the issue.", "type": "string" }, "domains": { -"description": "The domains of the issue.", "items": { "$ref": "GoogleCloudSecuritycenterV2IssueDomain" }, "type": "array" }, "exposureScore": { -"description": "The exposure score of the issue.", "format": "double", "type": "number" }, "issueType": { -"description": "The type of the issue.", "enum": [ "ISSUE_TYPE_UNSPECIFIED", "CHOKEPOINT", @@ -7041,60 +5987,51 @@ false "INSIGHT" ], "enumDescriptions": [ -"Unspecified issue type.", -"Chokepoint issue type.", -"Toxic combination issue type.", -"Insight issue type." +"", +"", +"", +"" ], "type": "string" }, "lastObservationTime": { -"description": "The time the issue was last observed.", "format": "google-datetime", "type": "string" }, "mute": { -"$ref": "GoogleCloudSecuritycenterV2IssueMute", -"description": "The mute information of the issue." +"$ref": "GoogleCloudSecuritycenterV2IssueMute" }, "name": { -"description": "Identifier. The name of the issue. Format: organizations/{organization}/locations/{location}/issues/{issue}", "type": "string" }, "primaryResource": { -"$ref": "GoogleCloudSecuritycenterV2IssueResource", -"description": "The primary resource associated with the issue." +"$ref": "GoogleCloudSecuritycenterV2IssueResource" }, "relatedFindings": { -"description": "The findings related to the issue.", "items": { "$ref": "GoogleCloudSecuritycenterV2IssueFinding" }, "type": "array" }, "remediations": { -"description": "Approaches to remediate the issue in Markdown format.", "items": { "type": "string" }, "type": "array" }, "secondaryResources": { -"description": "Additional resources associated with the issue.", "items": { "$ref": "GoogleCloudSecuritycenterV2IssueResource" }, "type": "array" }, "securityContexts": { -"description": "The security context of the issue.", "items": { "$ref": "GoogleCloudSecuritycenterV2IssueSecurityContext" }, "type": "array" }, "severity": { -"description": "The severity of the issue.", "enum": [ "SEVERITY_UNSPECIFIED", "CRITICAL", @@ -7103,31 +6040,29 @@ false "LOW" ], "enumDescriptions": [ -"Unspecified severity.", -"Critical severity.", -"High severity.", -"Medium severity.", -"Low severity." +"", +"", +"", +"", +"" ], "type": "string" }, "state": { -"description": "Output only. The state of the issue.", "enum": [ "STATE_UNSPECIFIED", "ACTIVE", "INACTIVE" ], "enumDescriptions": [ -"Unspecified state.", -"Active state.", -"Inactive state." +"", +"", +"" ], "readOnly": true, "type": "string" }, "updateTime": { -"description": "Output only. The time the issue was last updated.", "format": "google-datetime", "readOnly": true, "type": "string" @@ -7136,11 +6071,9 @@ false "type": "object" }, "GoogleCloudSecuritycenterV2IssueDomain": { -"description": "The domains of an issue.", "id": "GoogleCloudSecuritycenterV2IssueDomain", "properties": { "domainCategory": { -"description": "The domain category of the issue.", "enum": [ "DOMAIN_CATEGORY_UNSPECIFIED", "AI", @@ -7152,14 +6085,14 @@ false "THREAT" ], "enumDescriptions": [ -"Unspecified domain category.", -"Issues in the AI domain.", -"Issues in the code domain.", -"Issues in the container domain.", -"Issues in the data domain.", -"Issues in the identity and access domain.", -"Issues in the vulnerability domain.", -"Issues in the threat domain." +"", +"", +"", +"", +"", +"", +"", +"" ], "type": "string" } @@ -7167,75 +6100,62 @@ false "type": "object" }, "GoogleCloudSecuritycenterV2IssueFinding": { -"description": "Finding related to an issue.", "id": "GoogleCloudSecuritycenterV2IssueFinding", "properties": { "cve": { -"$ref": "GoogleCloudSecuritycenterV2IssueFindingCve", -"description": "The CVE of the finding." +"$ref": "GoogleCloudSecuritycenterV2IssueFindingCve" }, "name": { -"description": "The name of the finding.", "type": "string" }, "securityBulletin": { -"$ref": "GoogleCloudSecuritycenterV2IssueFindingSecurityBulletin", -"description": "The security bulletin of the finding." +"$ref": "GoogleCloudSecuritycenterV2IssueFindingSecurityBulletin" } }, "type": "object" }, "GoogleCloudSecuritycenterV2IssueFindingCve": { -"description": "The CVE of the finding.", "id": "GoogleCloudSecuritycenterV2IssueFindingCve", "properties": { "name": { -"description": "The CVE name.", "type": "string" } }, "type": "object" }, "GoogleCloudSecuritycenterV2IssueFindingSecurityBulletin": { -"description": "The security bulletin of the finding.", "id": "GoogleCloudSecuritycenterV2IssueFindingSecurityBulletin", "properties": { "name": { -"description": "The security bulletin name.", "type": "string" } }, "type": "object" }, "GoogleCloudSecuritycenterV2IssueMute": { -"description": "The mute information of the issue.", "id": "GoogleCloudSecuritycenterV2IssueMute", "properties": { "muteInitiator": { -"description": "The email address of the user who last changed the mute state of the issue.", "type": "string" }, "muteReason": { -"description": "The user-provided reason for muting the issue.", "type": "string" }, "muteState": { -"description": "Output only. The mute state of the issue.", "enum": [ "MUTE_STATE_UNSPECIFIED", "NOT_MUTED", "MUTED" ], "enumDescriptions": [ -"Unspecified mute state.", -"Not muted.", -"Muted." +"", +"", +"" ], "readOnly": true, "type": "string" }, "muteUpdateTime": { -"description": "The time the issue was muted.", "format": "google-datetime", "type": "string" } @@ -7243,35 +6163,27 @@ false "type": "object" }, "GoogleCloudSecuritycenterV2IssueResource": { -"description": "A resource associated with the an issue.", "id": "GoogleCloudSecuritycenterV2IssueResource", "properties": { "adcApplication": { -"$ref": "GoogleCloudSecuritycenterV2IssueResourceAdcApplication", -"description": "The ADC application associated with the finding." +"$ref": "GoogleCloudSecuritycenterV2IssueResourceAdcApplication" }, "adcApplicationTemplate": { -"$ref": "GoogleCloudSecuritycenterV2IssueResourceAdcApplicationTemplateRevision", -"description": "The ADC template associated with the finding." +"$ref": "GoogleCloudSecuritycenterV2IssueResourceAdcApplicationTemplateRevision" }, "adcSharedTemplate": { -"$ref": "GoogleCloudSecuritycenterV2IssueResourceAdcSharedTemplateRevision", -"description": "The ADC shared template associated with the finding." +"$ref": "GoogleCloudSecuritycenterV2IssueResourceAdcSharedTemplateRevision" }, "application": { -"$ref": "GoogleCloudSecuritycenterV2IssueResourceApplication", -"description": "The AppHub application associated with the resource, if any. Only populated for the primary resource." +"$ref": "GoogleCloudSecuritycenterV2IssueResourceApplication" }, "awsMetadata": { -"$ref": "GoogleCloudSecuritycenterV2IssueResourceAwsMetadata", -"description": "The AWS metadata of the resource associated with the issue. Only populated for AWS resources." +"$ref": "GoogleCloudSecuritycenterV2IssueResourceAwsMetadata" }, "azureMetadata": { -"$ref": "GoogleCloudSecuritycenterV2IssueResourceAzureMetadata", -"description": "The Azure metadata of the resource associated with the issue. Only populated for Azure resources." +"$ref": "GoogleCloudSecuritycenterV2IssueResourceAzureMetadata" }, "cloudProvider": { -"description": "The cloud provider of the resource associated with the issue.", "enum": [ "CLOUD_PROVIDER_UNSPECIFIED", "GOOGLE_CLOUD", @@ -7279,112 +6191,92 @@ false "MICROSOFT_AZURE" ], "enumDescriptions": [ -"Unspecified cloud provider.", -"Google Cloud.", -"Amazon Web Services.", -"Microsoft Azure." +"", +"", +"", +"" ], "type": "string" }, "displayName": { -"description": "The resource-type specific display name of the resource associated with the issue.", "type": "string" }, "googleCloudMetadata": { -"$ref": "GoogleCloudSecuritycenterV2IssueResourceGoogleCloudMetadata", -"description": "The Google Cloud metadata of the resource associated with the issue. Only populated for Google Cloud resources." +"$ref": "GoogleCloudSecuritycenterV2IssueResourceGoogleCloudMetadata" }, "name": { -"description": "The full resource name of the resource associated with the issue.", "type": "string" }, "type": { -"description": "The type of the resource associated with the issue.", "type": "string" } }, "type": "object" }, "GoogleCloudSecuritycenterV2IssueResourceAdcApplication": { -"description": "Represents an ADC application associated with the finding.", "id": "GoogleCloudSecuritycenterV2IssueResourceAdcApplication", "properties": { "attributes": { -"$ref": "GoogleCloudSecuritycenterV2IssueResourceApplicationAttributes", -"description": "Consumer provided attributes for the AppHub application." +"$ref": "GoogleCloudSecuritycenterV2IssueResourceApplicationAttributes" }, "name": { -"description": "The resource name of an ADC Application. Format: projects/{project}/locations/{location}/spaces/{space}/applications/{application}", "type": "string" } }, "type": "object" }, "GoogleCloudSecuritycenterV2IssueResourceAdcApplicationTemplateRevision": { -"description": "Represents an ADC template associated with the finding.", "id": "GoogleCloudSecuritycenterV2IssueResourceAdcApplicationTemplateRevision", "properties": { "name": { -"description": "The resource name of an ADC Application Template Revision. Format: projects/{project}/locations/{location}/spaces/{space}/applicationTemplates/{application_template}/revisions/{revision}", "type": "string" } }, "type": "object" }, "GoogleCloudSecuritycenterV2IssueResourceAdcSharedTemplateRevision": { -"description": "Represents an ADC shared template associated with the finding.", "id": "GoogleCloudSecuritycenterV2IssueResourceAdcSharedTemplateRevision", "properties": { "name": { -"description": "The resource name of an ADC Shared Template Revision. Format: projects/{project}/locations/{location}/spaces/{space}/applicationTemplates/{application_template}/revisions/{revision}", "type": "string" } }, "type": "object" }, "GoogleCloudSecuritycenterV2IssueResourceApplication": { -"description": "The AppHub application associated with the resource, if any.", "id": "GoogleCloudSecuritycenterV2IssueResourceApplication", "properties": { "attributes": { -"$ref": "GoogleCloudSecuritycenterV2IssueResourceApplicationAttributes", -"description": "Consumer provided attributes for the application" +"$ref": "GoogleCloudSecuritycenterV2IssueResourceApplicationAttributes" }, "name": { -"description": "The resource name of an Application. Format: `projects/{host-project-id}/locations/{location}/applications/{application-id}`", "type": "string" } }, "type": "object" }, "GoogleCloudSecuritycenterV2IssueResourceApplicationAttributes": { -"description": "Consumer provided attributes for the application", "id": "GoogleCloudSecuritycenterV2IssueResourceApplicationAttributes", "properties": { "businessOwners": { -"description": "Business team that ensures user needs are met and value is delivered", "items": { "$ref": "GoogleCloudSecuritycenterV2IssueResourceApplicationAttributesContactInfo" }, "type": "array" }, "criticality": { -"$ref": "GoogleCloudSecuritycenterV2IssueResourceApplicationAttributesCriticality", -"description": "User-defined criticality information." +"$ref": "GoogleCloudSecuritycenterV2IssueResourceApplicationAttributesCriticality" }, "developerOwners": { -"description": "Developer team that owns development and coding.", "items": { "$ref": "GoogleCloudSecuritycenterV2IssueResourceApplicationAttributesContactInfo" }, "type": "array" }, "environment": { -"$ref": "GoogleCloudSecuritycenterV2IssueResourceApplicationAttributesEnvironment", -"description": "User-defined environment information." +"$ref": "GoogleCloudSecuritycenterV2IssueResourceApplicationAttributesEnvironment" }, "operatorOwners": { -"description": "Operator team that ensures runtime and operations.", "items": { "$ref": "GoogleCloudSecuritycenterV2IssueResourceApplicationAttributesContactInfo" }, @@ -7394,22 +6286,18 @@ false "type": "object" }, "GoogleCloudSecuritycenterV2IssueResourceApplicationAttributesContactInfo": { -"description": "Contact information of stakeholders.", "id": "GoogleCloudSecuritycenterV2IssueResourceApplicationAttributesContactInfo", "properties": { "email": { -"description": "Email address of the contacts.", "type": "string" } }, "type": "object" }, "GoogleCloudSecuritycenterV2IssueResourceApplicationAttributesCriticality": { -"description": "Criticality of the Application, Service, or Workload", "id": "GoogleCloudSecuritycenterV2IssueResourceApplicationAttributesCriticality", "properties": { "type": { -"description": "Criticality Type.", "enum": [ "CRITICALITY_TYPE_UNSPECIFIED", "MISSION_CRITICAL", @@ -7418,11 +6306,11 @@ false "LOW" ], "enumDescriptions": [ -"Unspecified type.", -"Mission critical service, application or workload.", -"High impact.", -"Medium impact.", -"Low impact." +"", +"", +"", +"", +"" ], "type": "string" } @@ -7430,11 +6318,9 @@ false "type": "object" }, "GoogleCloudSecuritycenterV2IssueResourceApplicationAttributesEnvironment": { -"description": "Environment of the Application, Service, or Workload", "id": "GoogleCloudSecuritycenterV2IssueResourceApplicationAttributesEnvironment", "properties": { "type": { -"description": "Environment Type.", "enum": [ "ENVIRONMENT_TYPE_UNSPECIFIED", "PRODUCTION", @@ -7443,11 +6329,11 @@ false "DEVELOPMENT" ], "enumDescriptions": [ -"Unspecified type.", -"Production environment.", -"Staging environment.", -"Test environment.", -"Development environment." +"", +"", +"", +"", +"" ], "type": "string" } @@ -7455,93 +6341,75 @@ false "type": "object" }, "GoogleCloudSecuritycenterV2IssueResourceAwsMetadata": { -"description": "The AWS metadata of a resource associated with an issue.", "id": "GoogleCloudSecuritycenterV2IssueResourceAwsMetadata", "properties": { "account": { -"$ref": "GoogleCloudSecuritycenterV2IssueResourceAwsMetadataAwsAccount", -"description": "The AWS account of the resource associated with the issue." +"$ref": "GoogleCloudSecuritycenterV2IssueResourceAwsMetadataAwsAccount" } }, "type": "object" }, "GoogleCloudSecuritycenterV2IssueResourceAwsMetadataAwsAccount": { -"description": "The AWS account of the resource associated with the issue.", "id": "GoogleCloudSecuritycenterV2IssueResourceAwsMetadataAwsAccount", "properties": { "id": { -"description": "The AWS account ID of the resource associated with the issue.", "type": "string" }, "name": { -"description": "The AWS account name of the resource associated with the issue.", "type": "string" } }, "type": "object" }, "GoogleCloudSecuritycenterV2IssueResourceAzureMetadata": { -"description": "The Azure metadata of a resource associated with an issue.", "id": "GoogleCloudSecuritycenterV2IssueResourceAzureMetadata", "properties": { "subscription": { -"$ref": "GoogleCloudSecuritycenterV2IssueResourceAzureMetadataAzureSubscription", -"description": "The Azure subscription of the resource associated with the issue." +"$ref": "GoogleCloudSecuritycenterV2IssueResourceAzureMetadataAzureSubscription" } }, "type": "object" }, "GoogleCloudSecuritycenterV2IssueResourceAzureMetadataAzureSubscription": { -"description": "The Azure subscription of the resource associated with the issue.", "id": "GoogleCloudSecuritycenterV2IssueResourceAzureMetadataAzureSubscription", "properties": { "displayName": { -"description": "The Azure subscription display name of the resource associated with the issue.", "type": "string" }, "id": { -"description": "The Azure subscription ID of the resource associated with the issue.", "type": "string" } }, "type": "object" }, "GoogleCloudSecuritycenterV2IssueResourceGoogleCloudMetadata": { -"description": "Google Cloud metadata of a resource associated with an issue.", "id": "GoogleCloudSecuritycenterV2IssueResourceGoogleCloudMetadata", "properties": { "projectId": { -"description": "The project ID that the resource associated with the issue belongs to.", "type": "string" } }, "type": "object" }, "GoogleCloudSecuritycenterV2IssueSecurityContext": { -"description": "Security context associated with an issue.", "id": "GoogleCloudSecuritycenterV2IssueSecurityContext", "properties": { "aggregatedCount": { -"$ref": "GoogleCloudSecuritycenterV2IssueSecurityContextAggregatedCount", -"description": "The aggregated count of the security context." +"$ref": "GoogleCloudSecuritycenterV2IssueSecurityContextAggregatedCount" }, "context": { -"$ref": "GoogleCloudSecuritycenterV2IssueSecurityContextContext", -"description": "The context of the security context." +"$ref": "GoogleCloudSecuritycenterV2IssueSecurityContextContext" } }, "type": "object" }, "GoogleCloudSecuritycenterV2IssueSecurityContextAggregatedCount": { -"description": "Aggregated count of a security context.", "id": "GoogleCloudSecuritycenterV2IssueSecurityContextAggregatedCount", "properties": { "key": { -"description": "Aggregation key.", "type": "string" }, "value": { -"description": "Aggregation value.", "format": "int32", "type": "integer" } @@ -7549,15 +6417,12 @@ false "type": "object" }, "GoogleCloudSecuritycenterV2IssueSecurityContextContext": { -"description": "Context of a security context.", "id": "GoogleCloudSecuritycenterV2IssueSecurityContextContext", "properties": { "type": { -"description": "Context type.", "type": "string" }, "values": { -"description": "Context values.", "items": { "type": "string" }, @@ -7567,24 +6432,19 @@ false "type": "object" }, "GoogleCloudSecuritycenterV2Job": { -"description": "Describes a job", "id": "GoogleCloudSecuritycenterV2Job", "properties": { "errorCode": { -"description": "Optional. If the job did not complete successfully, this field describes why.", "format": "int32", "type": "integer" }, "location": { -"description": "Optional. Gives the location where the job ran, such as `US` or `europe-west1`", "type": "string" }, "name": { -"description": "The fully-qualified name for a job. e.g. `projects//jobs/`", "type": "string" }, "state": { -"description": "Output only. State of the job, such as `RUNNING` or `PENDING`.", "enum": [ "JOB_STATE_UNSPECIFIED", "PENDING", @@ -7593,11 +6453,11 @@ false "FAILED" ], "enumDescriptions": [ -"Unspecified represents an unknown state and should not be used.", -"Job is scheduled and pending for run", -"Job in progress", -"Job has completed with success", -"Job has completed but with failure" +"", +"", +"", +"", +"" ], "readOnly": true, "type": "string" @@ -7606,96 +6466,78 @@ false "type": "object" }, "GoogleCloudSecuritycenterV2KernelRootkit": { -"description": "Kernel mode rootkit signatures.", "id": "GoogleCloudSecuritycenterV2KernelRootkit", "properties": { "name": { -"description": "Rootkit name, when available.", "type": "string" }, "unexpectedCodeModification": { -"description": "True if unexpected modifications of kernel code memory are present.", "type": "boolean" }, "unexpectedFtraceHandler": { -"description": "True if `ftrace` points are present with callbacks pointing to regions that are not in the expected kernel or module code range.", "type": "boolean" }, "unexpectedInterruptHandler": { -"description": "True if interrupt handlers that are are not in the expected kernel or module code regions are present.", "type": "boolean" }, "unexpectedKernelCodePages": { -"description": "True if kernel code pages that are not in the expected kernel or module code regions are present.", "type": "boolean" }, "unexpectedKprobeHandler": { -"description": "True if `kprobe` points are present with callbacks pointing to regions that are not in the expected kernel or module code range.", "type": "boolean" }, "unexpectedProcessesInRunqueue": { -"description": "True if unexpected processes in the scheduler run queue are present. Such processes are in the run queue, but not in the process task list.", "type": "boolean" }, "unexpectedReadOnlyDataModification": { -"description": "True if unexpected modifications of kernel read-only data memory are present.", "type": "boolean" }, "unexpectedSystemCallHandler": { -"description": "True if system call handlers that are are not in the expected kernel or module code regions are present.", "type": "boolean" } }, "type": "object" }, "GoogleCloudSecuritycenterV2Kubernetes": { -"description": "Kubernetes-related attributes.", "id": "GoogleCloudSecuritycenterV2Kubernetes", "properties": { "accessReviews": { -"description": "Provides information on any Kubernetes access reviews (privilege checks) relevant to the finding.", "items": { "$ref": "GoogleCloudSecuritycenterV2AccessReview" }, "type": "array" }, "bindings": { -"description": "Provides Kubernetes role binding information for findings that involve [RoleBindings or ClusterRoleBindings](https://cloud.google.com/kubernetes-engine/docs/how-to/role-based-access-control).", "items": { "$ref": "GoogleCloudSecuritycenterV2Binding" }, "type": "array" }, "nodePools": { -"description": "GKE [node pools](https://cloud.google.com/kubernetes-engine/docs/concepts/node-pools) associated with the finding. This field contains node pool information for each node, when it is available.", "items": { "$ref": "GoogleCloudSecuritycenterV2NodePool" }, "type": "array" }, "nodes": { -"description": "Provides Kubernetes [node](https://cloud.google.com/kubernetes-engine/docs/concepts/cluster-architecture#nodes) information.", "items": { "$ref": "GoogleCloudSecuritycenterV2Node" }, "type": "array" }, "objects": { -"description": "Kubernetes objects related to the finding.", "items": { "$ref": "GoogleCloudSecuritycenterV2Object" }, "type": "array" }, "pods": { -"description": "Kubernetes [Pods](https://cloud.google.com/kubernetes-engine/docs/concepts/pod) associated with the finding. This field contains Pod records for each container that is owned by a Pod.", "items": { "$ref": "GoogleCloudSecuritycenterV2Pod" }, "type": "array" }, "roles": { -"description": "Provides Kubernetes role information for findings that involve [Roles or ClusterRoles](https://cloud.google.com/kubernetes-engine/docs/how-to/role-based-access-control).", "items": { "$ref": "GoogleCloudSecuritycenterV2Role" }, @@ -7705,52 +6547,42 @@ false "type": "object" }, "GoogleCloudSecuritycenterV2Label": { -"description": "Represents a generic name-value label. A label has separate name and value fields to support filtering with the `contains()` function. For more information, see [Filtering on array-type fields](https://cloud.google.com/security-command-center/docs/how-to-api-list-findings#array-contains-filtering).", "id": "GoogleCloudSecuritycenterV2Label", "properties": { "name": { -"description": "Name of the label.", "type": "string" }, "value": { -"description": "Value that corresponds to the label's name.", "type": "string" } }, "type": "object" }, "GoogleCloudSecuritycenterV2LoadBalancer": { -"description": "Contains information related to the load balancer associated with the finding.", "id": "GoogleCloudSecuritycenterV2LoadBalancer", "properties": { "name": { -"description": "The name of the load balancer associated with the finding.", "type": "string" } }, "type": "object" }, "GoogleCloudSecuritycenterV2LogEntry": { -"description": "An individual entry in a log.", "id": "GoogleCloudSecuritycenterV2LogEntry", "properties": { "cloudLoggingEntry": { -"$ref": "GoogleCloudSecuritycenterV2CloudLoggingEntry", -"description": "An individual entry in a log stored in Cloud Logging." +"$ref": "GoogleCloudSecuritycenterV2CloudLoggingEntry" } }, "type": "object" }, "GoogleCloudSecuritycenterV2MemoryHashSignature": { -"description": "A signature corresponding to memory page hashes.", "id": "GoogleCloudSecuritycenterV2MemoryHashSignature", "properties": { "binaryFamily": { -"description": "The binary family.", "type": "string" }, "detections": { -"description": "The list of memory hash detections contributing to the binary family match.", "items": { "$ref": "GoogleCloudSecuritycenterV2Detection" }, @@ -7760,11 +6592,9 @@ false "type": "object" }, "GoogleCloudSecuritycenterV2MitreAttack": { -"description": "MITRE ATT&CK tactics and techniques related to this finding. See: https://attack.mitre.org", "id": "GoogleCloudSecuritycenterV2MitreAttack", "properties": { "additionalTactics": { -"description": "Additional MITRE ATT&CK tactics related to this finding, if any.", "items": { "enum": [ "TACTIC_UNSPECIFIED", @@ -7784,28 +6614,27 @@ false "IMPACT" ], "enumDescriptions": [ -"Unspecified value.", -"TA0043", -"TA0042", -"TA0001", -"TA0002", -"TA0003", -"TA0004", -"TA0005", -"TA0006", -"TA0007", -"TA0008", -"TA0009", -"TA0011", -"TA0010", -"TA0040" +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"" ], "type": "string" }, "type": "array" }, "additionalTechniques": { -"description": "Additional MITRE ATT&CK techniques related to this finding, if any, along with any of their respective parent techniques.", "items": { "enum": [ "TECHNIQUE_UNSPECIFIED", @@ -7949,152 +6778,151 @@ false "FINANCIAL_THEFT" ], "enumDescriptions": [ -"Unspecified value.", -"T1001", -"T1001.002", -"T1003", -"T1003.007", -"T1003.008", -"T1005", -"T1020", -"T1027", -"T1027.003", -"T1027.004", -"T1027.010", -"T1029", -"T1033", -"T1036", -"T1036.005", -"T1037", -"T1037.005", -"T1046", -"T1053", -"T1053.003", -"T1053.007", -"T1055", -"T1056", -"T1056.001", -"T1057", -"T1059", -"T1059.004", -"T1059.006", -"T1068", -"T1069", -"T1069.003", -"T1070", -"T1070.002", -"T1070.003", -"T1070.004", -"T1070.006", -"T1070.008", -"T1071", -"T1071.004", -"T1072", -"T1078", -"T1078.001", -"T1078.003", -"T1078.004", -"T1083", -"T1087.001", -"T1090", -"T1090.002", -"T1090.003", -"T1098", -"T1098.001", -"T1098.003", -"T1098.004", -"T1098.006", -"T1104", -"T1105", -"T1106", -"T1110", -"T1119", -"T1129", -"T1132", -"T1132.001", -"T1134", -"T1134.001", -"T1136", -"T1136.001", -"T1140", -"T1190", -"T1195", -"T1195.001", -"T1203", -"T1204", -"T1212", -"T1222.002", -"T1484", -"T1485", -"T1486", -"T1489", -"T1490", -"T1495", -"T1496", -"T1498", -"T1526", -"T1528", -"T1531", -"T1537", -"T1539", -"T1543", -"T1546", -"T1547", -"T1547.006", -"T1547.009", -"T1548", -"T1548.001", -"T1548.003", -"T1552", -"T1552.001", -"T1552.003", -"T1552.004", -"T1553", -"T1553.004", -"T1554", -"T1555", -"T1556", -"T1556.003", -"T1556.006", -"T1562", -"T1562.001", -"T1562.006", -"T1562.012", -"T1564", -"T1564.001", -"T1564.002", -"T1567", -"T1567.002", -"T1568", -"T1570", -"T1574", -"T1574.006", -"T1578", -"T1578.001", -"T1580", -"T1587", -"T1587.001", -"T1588", -"T1588.001", -"T1588.006", -"T1595", -"T1595.001", -"T1608", -"T1608.001", -"T1609", -"T1610", -"T1611", -"T1613", -"T1620", -"T1649", -"T1657" +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"" ], "type": "string" }, "type": "array" }, "primaryTactic": { -"description": "The MITRE ATT&CK tactic most closely represented by this finding, if any.", "enum": [ "TACTIC_UNSPECIFIED", "RECONNAISSANCE", @@ -8113,26 +6941,25 @@ false "IMPACT" ], "enumDescriptions": [ -"Unspecified value.", -"TA0043", -"TA0042", -"TA0001", -"TA0002", -"TA0003", -"TA0004", -"TA0005", -"TA0006", -"TA0007", -"TA0008", -"TA0009", -"TA0011", -"TA0010", -"TA0040" +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"" ], "type": "string" }, "primaryTechniques": { -"description": "The MITRE ATT&CK technique most closely represented by this finding, if any. primary_techniques is a repeated field because there are multiple levels of MITRE ATT&CK techniques. If the technique most closely represented by this finding is a sub-technique (e.g. `SCANNING_IP_BLOCKS`), both the sub-technique and its parent technique(s) will be listed (e.g. `SCANNING_IP_BLOCKS`, `ACTIVE_SCANNING`).", "items": { "enum": [ "TECHNIQUE_UNSPECIFIED", @@ -8276,210 +7103,199 @@ false "FINANCIAL_THEFT" ], "enumDescriptions": [ -"Unspecified value.", -"T1001", -"T1001.002", -"T1003", -"T1003.007", -"T1003.008", -"T1005", -"T1020", -"T1027", -"T1027.003", -"T1027.004", -"T1027.010", -"T1029", -"T1033", -"T1036", -"T1036.005", -"T1037", -"T1037.005", -"T1046", -"T1053", -"T1053.003", -"T1053.007", -"T1055", -"T1056", -"T1056.001", -"T1057", -"T1059", -"T1059.004", -"T1059.006", -"T1068", -"T1069", -"T1069.003", -"T1070", -"T1070.002", -"T1070.003", -"T1070.004", -"T1070.006", -"T1070.008", -"T1071", -"T1071.004", -"T1072", -"T1078", -"T1078.001", -"T1078.003", -"T1078.004", -"T1083", -"T1087.001", -"T1090", -"T1090.002", -"T1090.003", -"T1098", -"T1098.001", -"T1098.003", -"T1098.004", -"T1098.006", -"T1104", -"T1105", -"T1106", -"T1110", -"T1119", -"T1129", -"T1132", -"T1132.001", -"T1134", -"T1134.001", -"T1136", -"T1136.001", -"T1140", -"T1190", -"T1195", -"T1195.001", -"T1203", -"T1204", -"T1212", -"T1222.002", -"T1484", -"T1485", -"T1486", -"T1489", -"T1490", -"T1495", -"T1496", -"T1498", -"T1526", -"T1528", -"T1531", -"T1537", -"T1539", -"T1543", -"T1546", -"T1547", -"T1547.006", -"T1547.009", -"T1548", -"T1548.001", -"T1548.003", -"T1552", -"T1552.001", -"T1552.003", -"T1552.004", -"T1553", -"T1553.004", -"T1554", -"T1555", -"T1556", -"T1556.003", -"T1556.006", -"T1562", -"T1562.001", -"T1562.006", -"T1562.012", -"T1564", -"T1564.001", -"T1564.002", -"T1567", -"T1567.002", -"T1568", -"T1570", -"T1574", -"T1574.006", -"T1578", -"T1578.001", -"T1580", -"T1587", -"T1587.001", -"T1588", -"T1588.001", -"T1588.006", -"T1595", -"T1595.001", -"T1608", -"T1608.001", -"T1609", -"T1610", -"T1611", -"T1613", -"T1620", -"T1649", -"T1657" +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"" ], "type": "string" }, "type": "array" }, "version": { -"description": "The MITRE ATT&CK version referenced by the above fields. E.g. \"8\".", "type": "string" } }, "type": "object" }, "GoogleCloudSecuritycenterV2MuteConfig": { -"description": "A mute config is a Cloud SCC resource that contains the configuration to mute create/update events of findings.", "id": "GoogleCloudSecuritycenterV2MuteConfig", "properties": { "createTime": { -"description": "Output only. The time at which the mute config was created. This field is set by the server and will be ignored if provided on config creation.", "format": "google-datetime", "readOnly": true, "type": "string" }, "cryptoKeyName": { -"description": "Output only. The resource name of the Cloud KMS `CryptoKey` used to encrypt this configuration data, if CMEK was enabled during Security Command Center activation.", "readOnly": true, "type": "string" }, "description": { -"description": "A description of the mute config.", "type": "string" }, "expiryTime": { -"description": "Optional. The expiry of the mute config. Only applicable for dynamic configs. If the expiry is set, when the config expires, it is removed from all findings.", "format": "google-datetime", "type": "string" }, "filter": { -"description": "Required. An expression that defines the filter to apply across create/update events of findings. While creating a filter string, be mindful of the scope in which the mute configuration is being created. E.g., If a filter contains project = X but is created under the project = Y scope, it might not match any findings. The following field and operator combinations are supported: * severity: `=`, `:` * category: `=`, `:` * resource.name: `=`, `:` * resource.project_name: `=`, `:` * resource.project_display_name: `=`, `:` * resource.folders.resource_folder: `=`, `:` * resource.parent_name: `=`, `:` * resource.parent_display_name: `=`, `:` * resource.type: `=`, `:` * finding_class: `=`, `:` * indicator.ip_addresses: `=`, `:` * indicator.domains: `=`, `:`", "type": "string" }, "mostRecentEditor": { -"description": "Output only. Email address of the user who last edited the mute config. This field is set by the server and will be ignored if provided on config creation or update.", "readOnly": true, "type": "string" }, "name": { -"description": "Identifier. This field will be ignored if provided on config creation. The following list shows some examples of the format: + `organizations/{organization}/muteConfigs/{mute_config}` + `organizations/{organization}locations/{location}//muteConfigs/{mute_config}` + `folders/{folder}/muteConfigs/{mute_config}` + `folders/{folder}/locations/{location}/muteConfigs/{mute_config}` + `projects/{project}/muteConfigs/{mute_config}` + `projects/{project}/locations/{location}/muteConfigs/{mute_config}`", "type": "string" }, "type": { -"description": "Required. The type of the mute config, which determines what type of mute state the config affects. Immutable after creation.", "enum": [ "MUTE_CONFIG_TYPE_UNSPECIFIED", "STATIC", "DYNAMIC" ], "enumDescriptions": [ -"Unused.", -"A static mute config, which sets the static mute state of future matching findings to muted. Once the static mute state has been set, finding or config modifications will not affect the state.", -"A dynamic mute config, which is applied to existing and future matching findings, setting their dynamic mute state to \"muted\". If the config is updated or deleted, or a matching finding is updated, such that the finding doesn't match the config, the config will be removed from the finding, and the finding's dynamic mute state may become \"unmuted\" (unless other configs still match)." +"", +"", +"" ], "type": "string" }, "updateTime": { -"description": "Output only. The most recent time at which the mute config was updated. This field is set by the server and will be ignored if provided on config creation or update.", "format": "google-datetime", "readOnly": true, "type": "string" @@ -8488,55 +7304,45 @@ false "type": "object" }, "GoogleCloudSecuritycenterV2MuteInfo": { -"description": "Mute information about the finding, including whether the finding has a static mute or any matching dynamic mute rules.", "id": "GoogleCloudSecuritycenterV2MuteInfo", "properties": { "dynamicMuteRecords": { -"description": "The list of dynamic mute rules that currently match the finding.", "items": { "$ref": "GoogleCloudSecuritycenterV2DynamicMuteRecord" }, "type": "array" }, "staticMute": { -"$ref": "GoogleCloudSecuritycenterV2StaticMute", -"description": "If set, the static mute applied to this finding. Static mutes override dynamic mutes. If unset, there is no static mute." +"$ref": "GoogleCloudSecuritycenterV2StaticMute" } }, "type": "object" }, "GoogleCloudSecuritycenterV2Network": { -"description": "Contains information about a VPC network associated with the finding.", "id": "GoogleCloudSecuritycenterV2Network", "properties": { "name": { -"description": "The name of the VPC network resource, for example, `//compute.googleapis.com/projects/my-project/global/networks/my-network`.", "type": "string" } }, "type": "object" }, "GoogleCloudSecuritycenterV2Node": { -"description": "Kubernetes nodes associated with the finding.", "id": "GoogleCloudSecuritycenterV2Node", "properties": { "name": { -"description": "[Full resource name](https://google.aip.dev/122#full-resource-names) of the Compute Engine VM running the cluster node.", "type": "string" } }, "type": "object" }, "GoogleCloudSecuritycenterV2NodePool": { -"description": "Provides GKE node pool information.", "id": "GoogleCloudSecuritycenterV2NodePool", "properties": { "name": { -"description": "Kubernetes node pool name.", "type": "string" }, "nodes": { -"description": "Nodes associated with the finding.", "items": { "$ref": "GoogleCloudSecuritycenterV2Node" }, @@ -8546,196 +7352,157 @@ false "type": "object" }, "GoogleCloudSecuritycenterV2Notebook": { -"description": "Represents a Jupyter notebook IPYNB file, such as a [Colab Enterprise notebook](https://cloud.google.com/colab/docs/introduction) file, that is associated with a finding.", "id": "GoogleCloudSecuritycenterV2Notebook", "properties": { "lastAuthor": { -"description": "The user ID of the latest author to modify the notebook.", "type": "string" }, "name": { -"description": "The name of the notebook.", "type": "string" }, "notebookUpdateTime": { -"description": "The most recent time the notebook was updated.", "format": "google-datetime", "type": "string" }, "service": { -"description": "The source notebook service, for example, \"Colab Enterprise\".", "type": "string" } }, "type": "object" }, "GoogleCloudSecuritycenterV2NotificationMessage": { -"description": "Cloud SCC's Notification", "id": "GoogleCloudSecuritycenterV2NotificationMessage", "properties": { "finding": { -"$ref": "GoogleCloudSecuritycenterV2Finding", -"description": "If it's a Finding based notification config, this field will be populated." +"$ref": "GoogleCloudSecuritycenterV2Finding" }, "notificationConfigName": { -"description": "Name of the notification config that generated current notification.", "type": "string" }, "resource": { -"$ref": "GoogleCloudSecuritycenterV2Resource", -"description": "The Cloud resource tied to this notification's Finding." +"$ref": "GoogleCloudSecuritycenterV2Resource" } }, "type": "object" }, "GoogleCloudSecuritycenterV2Object": { -"description": "Kubernetes object related to the finding, uniquely identified by GKNN. Used if the object Kind is not one of Pod, Node, NodePool, Binding, or AccessReview.", "id": "GoogleCloudSecuritycenterV2Object", "properties": { "containers": { -"description": "Pod containers associated with this finding, if any.", "items": { "$ref": "GoogleCloudSecuritycenterV2Container" }, "type": "array" }, "group": { -"description": "Kubernetes object group, such as \"policy.k8s.io/v1\".", "type": "string" }, "kind": { -"description": "Kubernetes object kind, such as \"Namespace\".", "type": "string" }, "name": { -"description": "Kubernetes object name. For details see https://kubernetes.io/docs/concepts/overview/working-with-objects/names/.", "type": "string" }, "ns": { -"description": "Kubernetes object namespace. Must be a valid DNS label. Named \"ns\" to avoid collision with C++ namespace keyword. For details see https://kubernetes.io/docs/tasks/administer-cluster/namespaces/.", "type": "string" } }, "type": "object" }, "GoogleCloudSecuritycenterV2OrgPolicy": { -"description": "Contains information about the org policies associated with the finding.", "id": "GoogleCloudSecuritycenterV2OrgPolicy", "properties": { "name": { -"description": "Identifier. The resource name of the org policy. Example: \"organizations/{organization_id}/policies/{constraint_name}\"", "type": "string" } }, "type": "object" }, "GoogleCloudSecuritycenterV2Package": { -"description": "Package is a generic definition of a package.", "id": "GoogleCloudSecuritycenterV2Package", "properties": { "cpeUri": { -"description": "The CPE URI where the vulnerability was detected.", "type": "string" }, "packageName": { -"description": "The name of the package where the vulnerability was detected.", "type": "string" }, "packageType": { -"description": "Type of package, for example, os, maven, or go.", "type": "string" }, "packageVersion": { -"description": "The version of the package.", "type": "string" } }, "type": "object" }, "GoogleCloudSecuritycenterV2Pipeline": { -"description": "Vertex AI training pipeline associated with the finding.", "id": "GoogleCloudSecuritycenterV2Pipeline", "properties": { "displayName": { -"description": "The user-defined display name of pipeline, e.g. plants-classification", "type": "string" }, "name": { -"description": "Resource name of the pipeline, e.g. projects/{project}/locations/{location}/trainingPipelines/5253428229225578496", "type": "string" } }, "type": "object" }, "GoogleCloudSecuritycenterV2Pod": { -"description": "A Kubernetes Pod.", "id": "GoogleCloudSecuritycenterV2Pod", "properties": { "containers": { -"description": "Pod containers associated with this finding, if any.", "items": { "$ref": "GoogleCloudSecuritycenterV2Container" }, "type": "array" }, "labels": { -"description": "Pod labels. For Kubernetes containers, these are applied to the container.", "items": { "$ref": "GoogleCloudSecuritycenterV2Label" }, "type": "array" }, "name": { -"description": "Kubernetes Pod name.", "type": "string" }, "ns": { -"description": "Kubernetes Pod namespace.", "type": "string" } }, "type": "object" }, "GoogleCloudSecuritycenterV2PolicyDriftDetails": { -"description": "The policy field that violates the deployed posture and its expected and detected values.", "id": "GoogleCloudSecuritycenterV2PolicyDriftDetails", "properties": { "detectedValue": { -"description": "The detected value that violates the deployed posture, for example, `false` or `allowed_values={\"projects/22831892\"}`.", "type": "string" }, "expectedValue": { -"description": "The value of this field that was configured in a posture, for example, `true` or `allowed_values={\"projects/29831892\"}`.", "type": "string" }, "field": { -"description": "The name of the updated field, for example constraint.implementation.policy_rules[0].enforce", "type": "string" } }, "type": "object" }, "GoogleCloudSecuritycenterV2PolicyViolationSummary": { -"description": "Metadata summarizing policy violations of child resources of the affected resource. `finding_category` and `resource` determine the exact semantics of the counts. For example, when category=DATA_SECURITY_POSTURE_OBJECT_PUBLIC_ACCESS_VIOLATION and resource='storage.googleapis.com/buckets/my-bucket-name' then this counts the number of Cloud Storage objects in my-bucket-name which violate a Public Access control.", "id": "GoogleCloudSecuritycenterV2PolicyViolationSummary", "properties": { "conformantResourcesCount": { -"description": "Total number of child resources that conform to the policy.", "format": "int64", "type": "string" }, "evaluationErrorsCount": { -"description": "Number of child resources for which errors during evaluation occurred. The evaluation result for these child resources is effectively \"unknown\".", "format": "int64", "type": "string" }, "outOfScopeResourcesCount": { -"description": "Total count of child resources which were not in scope for evaluation.", "format": "int64", "type": "string" }, "policyViolationsCount": { -"description": "Count of child resources in violation of the policy.", "format": "int64", "type": "string" } @@ -8743,16 +7510,13 @@ false "type": "object" }, "GoogleCloudSecuritycenterV2PortRange": { -"description": "A port range which is inclusive of the min and max values. Values are between 0 and 2^16-1. The max can be equal / must be not smaller than the min value. If min and max are equal this indicates that it is a single port.", "id": "GoogleCloudSecuritycenterV2PortRange", "properties": { "max": { -"description": "Maximum port value.", "format": "int64", "type": "string" }, "min": { -"description": "Minimum port value.", "format": "int64", "type": "string" } @@ -8760,62 +7524,50 @@ false "type": "object" }, "GoogleCloudSecuritycenterV2Process": { -"description": "Represents an operating system process.", "id": "GoogleCloudSecuritycenterV2Process", "properties": { "args": { -"description": "Process arguments as JSON encoded strings.", "items": { "type": "string" }, "type": "array" }, "argumentsTruncated": { -"description": "True if `args` is incomplete.", "type": "boolean" }, "binary": { -"$ref": "GoogleCloudSecuritycenterV2File", -"description": "File information for the process executable." +"$ref": "GoogleCloudSecuritycenterV2File" }, "envVariables": { -"description": "Process environment variables.", "items": { "$ref": "GoogleCloudSecuritycenterV2EnvironmentVariable" }, "type": "array" }, "envVariablesTruncated": { -"description": "True if `env_variables` is incomplete.", "type": "boolean" }, "libraries": { -"description": "File information for libraries loaded by the process.", "items": { "$ref": "GoogleCloudSecuritycenterV2File" }, "type": "array" }, "name": { -"description": "The process name, as displayed in utilities like `top` and `ps`. This name can be accessed through `/proc/[pid]/comm` and changed with `prctl(PR_SET_NAME)`.", "type": "string" }, "parentPid": { -"description": "The parent process ID.", "format": "int64", "type": "string" }, "pid": { -"description": "The process ID.", "format": "int64", "type": "string" }, "script": { -"$ref": "GoogleCloudSecuritycenterV2File", -"description": "When the process represents the invocation of a script, `binary` provides information about the interpreter, while `script` provides information about the script file provided to the interpreter." +"$ref": "GoogleCloudSecuritycenterV2File" }, "userId": { -"description": "The ID of the user that executed the process. E.g. If this is the root user this will always be 0.", "format": "int64", "type": "string" } @@ -8823,70 +7575,58 @@ false "type": "object" }, "GoogleCloudSecuritycenterV2ProcessSignature": { -"description": "Indicates what signature matched this process.", "id": "GoogleCloudSecuritycenterV2ProcessSignature", "properties": { "memoryHashSignature": { -"$ref": "GoogleCloudSecuritycenterV2MemoryHashSignature", -"description": "Signature indicating that a binary family was matched." +"$ref": "GoogleCloudSecuritycenterV2MemoryHashSignature" }, "signatureType": { -"description": "Describes the type of resource associated with the signature.", "enum": [ "SIGNATURE_TYPE_UNSPECIFIED", "SIGNATURE_TYPE_PROCESS", "SIGNATURE_TYPE_FILE" ], "enumDescriptions": [ -"The default signature type.", -"Used for signatures concerning processes.", -"Used for signatures concerning disks." +"", +"", +"" ], "type": "string" }, "yaraRuleSignature": { -"$ref": "GoogleCloudSecuritycenterV2YaraRuleSignature", -"description": "Signature indicating that a YARA rule was matched." +"$ref": "GoogleCloudSecuritycenterV2YaraRuleSignature" } }, "type": "object" }, "GoogleCloudSecuritycenterV2Reference": { -"description": "Additional Links", "id": "GoogleCloudSecuritycenterV2Reference", "properties": { "source": { -"description": "Source of the reference e.g. NVD", "type": "string" }, "uri": { -"description": "Uri for the mentioned source e.g. https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2021-34527.", "type": "string" } }, "type": "object" }, "GoogleCloudSecuritycenterV2Requests": { -"description": "Information about the requests relevant to the finding.", "id": "GoogleCloudSecuritycenterV2Requests", "properties": { "longTermAllowed": { -"description": "Allowed RPS (requests per second) over the long term.", "format": "int32", "type": "integer" }, "longTermDenied": { -"description": "Denied RPS (requests per second) over the long term.", "format": "int32", "type": "integer" }, "ratio": { -"description": "For 'Increasing deny ratio', the ratio is the denied traffic divided by the allowed traffic. For 'Allowed traffic spike', the ratio is the allowed traffic in the short term divided by allowed traffic in the long term.", "format": "double", "type": "number" }, "shortTermAllowed": { -"description": "Allowed RPS (requests per second) in the short term.", "format": "int32", "type": "integer" } @@ -8894,35 +7634,27 @@ false "type": "object" }, "GoogleCloudSecuritycenterV2Resource": { -"description": "Information related to the Google Cloud resource.", "id": "GoogleCloudSecuritycenterV2Resource", "properties": { "adcApplication": { -"$ref": "GoogleCloudSecuritycenterV2AdcApplication", -"description": "The ADC application associated with the finding." +"$ref": "GoogleCloudSecuritycenterV2AdcApplication" }, "adcApplicationTemplate": { -"$ref": "GoogleCloudSecuritycenterV2AdcApplicationTemplateRevision", -"description": "The ADC template associated with the finding." +"$ref": "GoogleCloudSecuritycenterV2AdcApplicationTemplateRevision" }, "adcSharedTemplate": { -"$ref": "GoogleCloudSecuritycenterV2AdcSharedTemplateRevision", -"description": "The ADC shared template associated with the finding." +"$ref": "GoogleCloudSecuritycenterV2AdcSharedTemplateRevision" }, "application": { -"$ref": "GoogleCloudSecuritycenterV2ResourceApplication", -"description": "The App Hub application this resource belongs to." +"$ref": "GoogleCloudSecuritycenterV2ResourceApplication" }, "awsMetadata": { -"$ref": "GoogleCloudSecuritycenterV2AwsMetadata", -"description": "The AWS metadata associated with the finding." +"$ref": "GoogleCloudSecuritycenterV2AwsMetadata" }, "azureMetadata": { -"$ref": "GoogleCloudSecuritycenterV2AzureMetadata", -"description": "The Azure metadata associated with the finding." +"$ref": "GoogleCloudSecuritycenterV2AzureMetadata" }, "cloudProvider": { -"description": "Indicates which cloud provider the finding is from.", "enum": [ "CLOUD_PROVIDER_UNSPECIFIED", "GOOGLE_CLOUD_PLATFORM", @@ -8930,91 +7662,74 @@ false "MICROSOFT_AZURE" ], "enumDescriptions": [ -"The cloud provider is unspecified.", -"The cloud provider is Google Cloud.", -"The cloud provider is Amazon Web Services.", -"The cloud provider is Microsoft Azure." +"", +"", +"", +"" ], "type": "string" }, "displayName": { -"description": "The human readable name of the resource.", "type": "string" }, "gcpMetadata": { -"$ref": "GcpMetadata", -"description": "The Google Cloud metadata associated with the finding." +"$ref": "GcpMetadata" }, "location": { -"description": "The region or location of the service (if applicable).", "type": "string" }, "name": { -"description": "The full resource name of the resource. See: https://cloud.google.com/apis/design/resource_names#full_resource_name", "type": "string" }, "resourcePath": { -"$ref": "GoogleCloudSecuritycenterV2ResourcePath", -"description": "Provides the path to the resource within the resource hierarchy." +"$ref": "GoogleCloudSecuritycenterV2ResourcePath" }, "resourcePathString": { -"description": "A string representation of the resource path. For Google Cloud, it has the format of `organizations/{organization_id}/folders/{folder_id}/folders/{folder_id}/projects/{project_id}` where there can be any number of folders. For AWS, it has the format of `org/{organization_id}/ou/{organizational_unit_id}/ou/{organizational_unit_id}/account/{account_id}` where there can be any number of organizational units. For Azure, it has the format of `mg/{management_group_id}/mg/{management_group_id}/subscription/{subscription_id}/rg/{resource_group_name}` where there can be any number of management groups.", "type": "string" }, "service": { -"description": "The service or resource provider associated with the resource.", "type": "string" }, "type": { -"description": "The full resource type of the resource.", "type": "string" } }, "type": "object" }, "GoogleCloudSecuritycenterV2ResourceApplication": { -"description": "The App Hub Application associated with the finding's resource.", "id": "GoogleCloudSecuritycenterV2ResourceApplication", "properties": { "attributes": { -"$ref": "GoogleCloudSecuritycenterV2ResourceApplicationAttributes", -"description": "Consumer provided attributes for the application" +"$ref": "GoogleCloudSecuritycenterV2ResourceApplicationAttributes" }, "name": { -"description": "The resource name of an Application. Format: `projects/{host-project-id}/locations/{location}/applications/{application-id}`", "type": "string" } }, "type": "object" }, "GoogleCloudSecuritycenterV2ResourceApplicationAttributes": { -"description": "Consumer provided attributes for the application", "id": "GoogleCloudSecuritycenterV2ResourceApplicationAttributes", "properties": { "businessOwners": { -"description": "Business team that ensures user needs are met and value is delivered", "items": { "$ref": "GoogleCloudSecuritycenterV2ResourceApplicationAttributesContactInfo" }, "type": "array" }, "criticality": { -"$ref": "GoogleCloudSecuritycenterV2ResourceApplicationAttributesCriticality", -"description": "User-defined criticality information." +"$ref": "GoogleCloudSecuritycenterV2ResourceApplicationAttributesCriticality" }, "developerOwners": { -"description": "Developer team that owns development and coding.", "items": { "$ref": "GoogleCloudSecuritycenterV2ResourceApplicationAttributesContactInfo" }, "type": "array" }, "environment": { -"$ref": "GoogleCloudSecuritycenterV2ResourceApplicationAttributesEnvironment", -"description": "User-defined environment information." +"$ref": "GoogleCloudSecuritycenterV2ResourceApplicationAttributesEnvironment" }, "operatorOwners": { -"description": "Operator team that ensures runtime and operations.", "items": { "$ref": "GoogleCloudSecuritycenterV2ResourceApplicationAttributesContactInfo" }, @@ -9024,22 +7739,18 @@ false "type": "object" }, "GoogleCloudSecuritycenterV2ResourceApplicationAttributesContactInfo": { -"description": "Contact information of stakeholders.", "id": "GoogleCloudSecuritycenterV2ResourceApplicationAttributesContactInfo", "properties": { "email": { -"description": "Email address of the contacts.", "type": "string" } }, "type": "object" }, "GoogleCloudSecuritycenterV2ResourceApplicationAttributesCriticality": { -"description": "Criticality of the Application, Service, or Workload", "id": "GoogleCloudSecuritycenterV2ResourceApplicationAttributesCriticality", "properties": { "type": { -"description": "Criticality Type.", "enum": [ "CRITICALITY_TYPE_UNSPECIFIED", "MISSION_CRITICAL", @@ -9048,11 +7759,11 @@ false "LOW" ], "enumDescriptions": [ -"Unspecified type.", -"Mission critical service, application or workload.", -"High impact.", -"Medium impact.", -"Low impact." +"", +"", +"", +"", +"" ], "type": "string" } @@ -9060,11 +7771,9 @@ false "type": "object" }, "GoogleCloudSecuritycenterV2ResourceApplicationAttributesEnvironment": { -"description": "Environment of the Application, Service, or Workload", "id": "GoogleCloudSecuritycenterV2ResourceApplicationAttributesEnvironment", "properties": { "type": { -"description": "Environment Type.", "enum": [ "ENVIRONMENT_TYPE_UNSPECIFIED", "PRODUCTION", @@ -9073,11 +7782,11 @@ false "DEVELOPMENT" ], "enumDescriptions": [ -"Unspecified type.", -"Production environment.", -"Staging environment.", -"Test environment.", -"Development environment." +"", +"", +"", +"", +"" ], "type": "string" } @@ -9085,11 +7794,9 @@ false "type": "object" }, "GoogleCloudSecuritycenterV2ResourcePath": { -"description": "Represents the path of resources leading up to the resource this finding is about.", "id": "GoogleCloudSecuritycenterV2ResourcePath", "properties": { "nodes": { -"description": "The list of nodes that make the up resource path, ordered from lowest level to highest level.", "items": { "$ref": "GoogleCloudSecuritycenterV2ResourcePathNode" }, @@ -9099,19 +7806,15 @@ false "type": "object" }, "GoogleCloudSecuritycenterV2ResourcePathNode": { -"description": "A node within the resource path. Each node represents a resource within the resource hierarchy.", "id": "GoogleCloudSecuritycenterV2ResourcePathNode", "properties": { "displayName": { -"description": "The display name of the resource this node represents.", "type": "string" }, "id": { -"description": "The ID of the resource this node represents.", "type": "string" }, "nodeType": { -"description": "The type of resource this node represents.", "enum": [ "RESOURCE_PATH_NODE_TYPE_UNSPECIFIED", "GCP_ORGANIZATION", @@ -9125,16 +7828,16 @@ false "AZURE_RESOURCE_GROUP" ], "enumDescriptions": [ -"Node type is unspecified.", -"The node represents a Google Cloud organization.", -"The node represents a Google Cloud folder.", -"The node represents a Google Cloud project.", -"The node represents an AWS organization.", -"The node represents an AWS organizational unit.", -"The node represents an AWS account.", -"The node represents an Azure management group.", -"The node represents an Azure subscription.", -"The node represents an Azure resource group." +"", +"", +"", +"", +"", +"", +"", +"", +"", +"" ], "type": "string" } @@ -9142,11 +7845,9 @@ false "type": "object" }, "GoogleCloudSecuritycenterV2ResourceValueConfig": { -"description": "A resource value configuration (RVC) is a mapping configuration of user's resources to resource values. Used in Attack path simulations.", "id": "GoogleCloudSecuritycenterV2ResourceValueConfig", "properties": { "cloudProvider": { -"description": "Cloud provider this configuration applies to", "enum": [ "CLOUD_PROVIDER_UNSPECIFIED", "GOOGLE_CLOUD_PLATFORM", @@ -9154,40 +7855,34 @@ false "MICROSOFT_AZURE" ], "enumDescriptions": [ -"The cloud provider is unspecified.", -"The cloud provider is Google Cloud.", -"The cloud provider is Amazon Web Services.", -"The cloud provider is Microsoft Azure." +"", +"", +"", +"" ], "type": "string" }, "createTime": { -"description": "Output only. Timestamp this resource value configuration was created.", "format": "google-datetime", "readOnly": true, "type": "string" }, "description": { -"description": "Description of the resource value configuration.", "type": "string" }, "name": { -"description": "Identifier. Name for the resource value configuration", "type": "string" }, "resourceLabelsSelector": { "additionalProperties": { "type": "string" }, -"description": "List of resource labels to search for, evaluated with `AND`. For example, \"resource_labels_selector\": {\"key\": \"value\", \"env\": \"prod\"} will match resources with labels \"key\": \"value\" `AND` \"env\": \"prod\" https://cloud.google.com/resource-manager/docs/creating-managing-labels", "type": "object" }, "resourceType": { -"description": "Apply resource_value only to resources that match resource_type. resource_type will be checked with `AND` of other resources. For example, \"storage.googleapis.com/Bucket\" with resource_value \"HIGH\" will apply \"HIGH\" value only to \"storage.googleapis.com/Bucket\" resources.", "type": "string" }, "resourceValue": { -"description": "Resource value level this expression represents Only required when there is no Sensitive Data Protection mapping in the request", "enum": [ "RESOURCE_VALUE_UNSPECIFIED", "HIGH", @@ -9196,31 +7891,27 @@ false "NONE" ], "enumDescriptions": [ -"Unspecific value", -"High resource value", -"Medium resource value", -"Low resource value", -"No resource value, e.g. ignore these resources" +"", +"", +"", +"", +"" ], "type": "string" }, "scope": { -"description": "Project or folder to scope this configuration to. For example, \"project/456\" would apply this configuration only to resources in \"project/456\" scope and will be checked with `AND` of other resources.", "type": "string" }, "sensitiveDataProtectionMapping": { -"$ref": "GoogleCloudSecuritycenterV2SensitiveDataProtectionMapping", -"description": "A mapping of the sensitivity on Sensitive Data Protection finding to resource values. This mapping can only be used in combination with a resource_type that is related to BigQuery, e.g. \"bigquery.googleapis.com/Dataset\"." +"$ref": "GoogleCloudSecuritycenterV2SensitiveDataProtectionMapping" }, "tagValues": { -"description": "Tag values combined with `AND` to check against. For Google Cloud resources, they are tag value IDs in the form of \"tagValues/123\". Example: `[ \"tagValues/123\", \"tagValues/456\", \"tagValues/789\" ]` https://cloud.google.com/resource-manager/docs/tags/tags-creating-and-managing", "items": { "type": "string" }, "type": "array" }, "updateTime": { -"description": "Output only. Timestamp this resource value configuration was last updated.", "format": "google-datetime", "readOnly": true, "type": "string" @@ -9229,90 +7920,74 @@ false "type": "object" }, "GoogleCloudSecuritycenterV2Role": { -"description": "Kubernetes Role or ClusterRole.", "id": "GoogleCloudSecuritycenterV2Role", "properties": { "kind": { -"description": "Role type.", "enum": [ "KIND_UNSPECIFIED", "ROLE", "CLUSTER_ROLE" ], "enumDescriptions": [ -"Role type is not specified.", -"Kubernetes Role.", -"Kubernetes ClusterRole." +"", +"", +"" ], "type": "string" }, "name": { -"description": "Role name.", "type": "string" }, "ns": { -"description": "Role namespace.", "type": "string" } }, "type": "object" }, "GoogleCloudSecuritycenterV2Secret": { -"description": "Details about a secret or credential associated with the finding.", "id": "GoogleCloudSecuritycenterV2Secret", "properties": { "environmentVariable": { -"$ref": "GoogleCloudSecuritycenterV2SecretEnvironmentVariable", -"description": "The environment variable containing the secret." +"$ref": "GoogleCloudSecuritycenterV2SecretEnvironmentVariable" }, "filePath": { -"$ref": "GoogleCloudSecuritycenterV2SecretFilePath", -"description": "The file containing the secret." +"$ref": "GoogleCloudSecuritycenterV2SecretFilePath" }, "status": { -"$ref": "GoogleCloudSecuritycenterV2SecretStatus", -"description": "The status of the secret." +"$ref": "GoogleCloudSecuritycenterV2SecretStatus" }, "type": { -"description": "The type of secret, for example, GCP_API_KEY.", "type": "string" } }, "type": "object" }, "GoogleCloudSecuritycenterV2SecretEnvironmentVariable": { -"description": "Environment variable containing the secret.", "id": "GoogleCloudSecuritycenterV2SecretEnvironmentVariable", "properties": { "key": { -"description": "Environment variable name as a JSON encoded string. Note that value is not included since the value contains the secret data, which is sensitive core content.", "type": "string" } }, "type": "object" }, "GoogleCloudSecuritycenterV2SecretFilePath": { -"description": "File path containing the secret.", "id": "GoogleCloudSecuritycenterV2SecretFilePath", "properties": { "path": { -"description": "Path to the file.", "type": "string" } }, "type": "object" }, "GoogleCloudSecuritycenterV2SecretStatus": { -"description": "The status of the secret.", "id": "GoogleCloudSecuritycenterV2SecretStatus", "properties": { "lastUpdatedTime": { -"description": "Time that the secret was found.", "format": "google-datetime", "type": "string" }, "validity": { -"description": "The validity of the secret.", "enum": [ "SECRET_VALIDITY_UNSPECIFIED", "SECRET_VALIDITY_UNSUPPORTED", @@ -9321,11 +7996,11 @@ false "SECRET_VALIDITY_VALID" ], "enumDescriptions": [ -"Default value; no validation was attempted.", -"There is no mechanism to validate the secret.", -"Validation is supported but the validation failed.", -"The secret is confirmed to be invalid.", -"The secret is confirmed to be valid." +"", +"", +"", +"", +"" ], "type": "string" } @@ -9333,114 +8008,91 @@ false "type": "object" }, "GoogleCloudSecuritycenterV2SecurityBulletin": { -"description": "SecurityBulletin are notifications of vulnerabilities of Google products.", "id": "GoogleCloudSecuritycenterV2SecurityBulletin", "properties": { "bulletinId": { -"description": "ID of the bulletin corresponding to the vulnerability.", "type": "string" }, "submissionTime": { -"description": "Submission time of this Security Bulletin.", "format": "google-datetime", "type": "string" }, "suggestedUpgradeVersion": { -"description": "This represents a version that the cluster receiving this notification should be upgraded to, based on its current version. For example, 1.15.0", "type": "string" } }, "type": "object" }, "GoogleCloudSecuritycenterV2SecurityMarks": { -"description": "User specified security marks that are attached to the parent Security Command Center resource. Security marks are scoped within a Security Command Center organization -- they can be modified and viewed by all users who have proper permissions on the organization.", "id": "GoogleCloudSecuritycenterV2SecurityMarks", "properties": { "canonicalName": { -"description": "The canonical name of the marks. The following list shows some examples: + `organizations/{organization_id}/assets/{asset_id}/securityMarks` + `organizations/{organization_id}/sources/{source_id}/findings/{finding_id}/securityMarks` + `organizations/{organization_id}/sources/{source_id}/locations/{location}/findings/{finding_id}/securityMarks` + `folders/{folder_id}/assets/{asset_id}/securityMarks` + `folders/{folder_id}/sources/{source_id}/findings/{finding_id}/securityMarks` + `folders/{folder_id}/sources/{source_id}/locations/{location}/findings/{finding_id}/securityMarks` + `projects/{project_number}/assets/{asset_id}/securityMarks` + `projects/{project_number}/sources/{source_id}/findings/{finding_id}/securityMarks` + `projects/{project_number}/sources/{source_id}/locations/{location}/findings/{finding_id}/securityMarks`", "type": "string" }, "marks": { "additionalProperties": { "type": "string" }, -"description": "Mutable user specified security marks belonging to the parent resource. Constraints are as follows: * Keys and values are treated as case insensitive * Keys must be between 1 - 256 characters (inclusive) * Keys must be letters, numbers, underscores, or dashes * Values have leading and trailing whitespace trimmed, remaining characters must be between 1 - 4096 characters (inclusive)", "type": "object" }, "name": { -"description": "The relative resource name of the SecurityMarks. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name The following list shows some examples: + `organizations/{organization_id}/assets/{asset_id}/securityMarks` + `organizations/{organization_id}/sources/{source_id}/findings/{finding_id}/securityMarks` + `organizations/{organization_id}/sources/{source_id}/locations/{location}/findings/{finding_id}/securityMarks`", "type": "string" } }, "type": "object" }, "GoogleCloudSecuritycenterV2SecurityPolicy": { -"description": "Information about the [Google Cloud Armor security policy](https://cloud.google.com/armor/docs/security-policy-overview) relevant to the finding.", "id": "GoogleCloudSecuritycenterV2SecurityPolicy", "properties": { "name": { -"description": "The name of the Google Cloud Armor security policy, for example, \"my-security-policy\".", "type": "string" }, "preview": { -"description": "Whether or not the associated rule or policy is in preview mode.", "type": "boolean" }, "type": { -"description": "The type of Google Cloud Armor security policy for example, 'backend security policy', 'edge security policy', 'network edge security policy', or 'always-on DDoS protection'.", "type": "string" } }, "type": "object" }, "GoogleCloudSecuritycenterV2SecurityPosture": { -"description": "Represents a posture that is deployed on Google Cloud by the Security Command Center Posture Management service. A posture contains one or more policy sets. A policy set is a group of policies that enforce a set of security rules on Google Cloud.", "id": "GoogleCloudSecuritycenterV2SecurityPosture", "properties": { "changedPolicy": { -"description": "The name of the updated policy, for example, `projects/{project_id}/policies/{constraint_name}`.", "type": "string" }, "name": { -"description": "Name of the posture, for example, `CIS-Posture`.", "type": "string" }, "policy": { -"description": "The ID of the updated policy, for example, `compute-policy-1`.", "type": "string" }, "policyDriftDetails": { -"description": "The details about a change in an updated policy that violates the deployed posture.", "items": { "$ref": "GoogleCloudSecuritycenterV2PolicyDriftDetails" }, "type": "array" }, "policySet": { -"description": "The name of the updated policy set, for example, `cis-policyset`.", "type": "string" }, "postureDeployment": { -"description": "The name of the posture deployment, for example, `organizations/{org_id}/posturedeployments/{posture_deployment_id}`.", "type": "string" }, "postureDeploymentResource": { -"description": "The project, folder, or organization on which the posture is deployed, for example, `projects/{project_number}`.", "type": "string" }, "revisionId": { -"description": "The version of the posture, for example, `c7cfa2a8`.", "type": "string" } }, "type": "object" }, "GoogleCloudSecuritycenterV2SensitiveDataProtectionMapping": { -"description": "Resource value mapping for Sensitive Data Protection findings If any of these mappings have a resource value that is not unspecified, the resource_value field will be ignored when reading this configuration.", "id": "GoogleCloudSecuritycenterV2SensitiveDataProtectionMapping", "properties": { "highSensitivityMapping": { -"description": "Resource value mapping for high-sensitivity Sensitive Data Protection findings", "enum": [ "RESOURCE_VALUE_UNSPECIFIED", "HIGH", @@ -9449,16 +8101,15 @@ false "NONE" ], "enumDescriptions": [ -"Unspecific value", -"High resource value", -"Medium resource value", -"Low resource value", -"No resource value, e.g. ignore these resources" +"", +"", +"", +"", +"" ], "type": "string" }, "mediumSensitivityMapping": { -"description": "Resource value mapping for medium-sensitivity Sensitive Data Protection findings", "enum": [ "RESOURCE_VALUE_UNSPECIFIED", "HIGH", @@ -9467,11 +8118,11 @@ false "NONE" ], "enumDescriptions": [ -"Unspecific value", -"High resource value", -"Medium resource value", -"Low resource value", -"No resource value, e.g. ignore these resources" +"", +"", +"", +"", +"" ], "type": "string" } @@ -9479,11 +8130,9 @@ false "type": "object" }, "GoogleCloudSecuritycenterV2SensitivityScore": { -"description": "Score is calculated from of all elements in the data profile. A higher level means the data is more sensitive.", "id": "GoogleCloudSecuritycenterV2SensitivityScore", "properties": { "score": { -"description": "The sensitivity score applied to the resource.", "enum": [ "SENSITIVITY_SCORE_LEVEL_UNSPECIFIED", "SENSITIVITY_LOW", @@ -9492,11 +8141,11 @@ false "SENSITIVITY_HIGH" ], "enumDescriptions": [ -"Unused.", -"No sensitive information detected. The resource isn't publicly accessible.", -"Unable to determine sensitivity.", -"Medium risk. Contains personally identifiable information (PII), potentially sensitive data, or fields with free-text data that are at a higher risk of having intermittent sensitive data. Consider limiting access.", -"High risk. Sensitive personally identifiable information (SPII) can be present. Exfiltration of data can lead to user data loss. Re-identification of users might be possible. Consider limiting usage and or removing SPII." +"", +"", +"", +"", +"" ], "type": "string" } @@ -9504,31 +8153,25 @@ false "type": "object" }, "GoogleCloudSecuritycenterV2ServiceAccountDelegationInfo": { -"description": "Identity delegation history of an authenticated service account.", "id": "GoogleCloudSecuritycenterV2ServiceAccountDelegationInfo", "properties": { "principalEmail": { -"description": "The email address of a Google account.", "type": "string" }, "principalSubject": { -"description": "A string representing the principal_subject associated with the identity. As compared to `principal_email`, supports principals that aren't associated with email addresses, such as third party principals. For most identities, the format will be `principal://iam.googleapis.com/{identity pool name}/subjects/{subject}` except for some GKE identities (GKE_WORKLOAD, FREEFORM, GKE_HUB_WORKLOAD) that are still in the legacy format `serviceAccount:{identity pool name}[{subject}]`", "type": "string" } }, "type": "object" }, "GoogleCloudSecuritycenterV2StaticMute": { -"description": "Information about the static mute state. A static mute state overrides any dynamic mute rules that apply to this finding. The static mute state can be set by a static mute rule or by muting the finding directly.", "id": "GoogleCloudSecuritycenterV2StaticMute", "properties": { "applyTime": { -"description": "When the static mute was applied.", "format": "google-datetime", "type": "string" }, "state": { -"description": "The static mute state. If the value is `MUTED` or `UNMUTED`, then the finding's overall mute state will have the same value.", "enum": [ "MUTE_UNSPECIFIED", "MUTED", @@ -9536,10 +8179,10 @@ false "UNDEFINED" ], "enumDescriptions": [ -"Unspecified.", -"Finding has been muted.", -"Finding has been unmuted.", -"Finding has never been muted/unmuted." +"", +"", +"", +"" ], "type": "string" } @@ -9547,11 +8190,9 @@ false "type": "object" }, "GoogleCloudSecuritycenterV2Subject": { -"description": "Represents a Kubernetes subject.", "id": "GoogleCloudSecuritycenterV2Subject", "properties": { "kind": { -"description": "Authentication type for the subject.", "enum": [ "AUTH_TYPE_UNSPECIFIED", "USER", @@ -9559,67 +8200,55 @@ false "GROUP" ], "enumDescriptions": [ -"Authentication is not specified.", -"User with valid certificate.", -"Users managed by Kubernetes API with credentials stored as secrets.", -"Collection of users." +"", +"", +"", +"" ], "type": "string" }, "name": { -"description": "Name for the subject.", "type": "string" }, "ns": { -"description": "Namespace for the subject.", "type": "string" } }, "type": "object" }, "GoogleCloudSecuritycenterV2TicketInfo": { -"description": "Information about the ticket, if any, that is being used to track the resolution of the issue that is identified by this finding.", "id": "GoogleCloudSecuritycenterV2TicketInfo", "properties": { "assignee": { -"description": "The assignee of the ticket in the ticket system.", "type": "string" }, "description": { -"description": "The description of the ticket in the ticket system.", "type": "string" }, "id": { -"description": "The identifier of the ticket in the ticket system.", "type": "string" }, "status": { -"description": "The latest status of the ticket, as reported by the ticket system.", "type": "string" }, "updateTime": { -"description": "The time when the ticket was last updated, as reported by the ticket system.", "format": "google-datetime", "type": "string" }, "uri": { -"description": "The link to the ticket in the ticket system.", "type": "string" } }, "type": "object" }, "GoogleCloudSecuritycenterV2ToxicCombination": { -"description": "Contains details about a group of security issues that, when the issues occur together, represent a greater risk than when the issues occur independently. A group of such issues is referred to as a toxic combination.", "id": "GoogleCloudSecuritycenterV2ToxicCombination", "properties": { "attackExposureScore": { -"description": "The [Attack exposure score](https://cloud.google.com/security-command-center/docs/attack-exposure-learn#attack_exposure_scores) of this toxic combination. The score is a measure of how much this toxic combination exposes one or more high-value resources to potential attack.", "format": "double", "type": "number" }, "relatedFindings": { -"description": "List of resource names of findings associated with this toxic combination. For example, `organizations/123/sources/456/findings/789`.", "items": { "type": "string" }, @@ -9629,18 +8258,15 @@ false "type": "object" }, "GoogleCloudSecuritycenterV2VertexAi": { -"description": "Vertex AI-related information associated with the finding.", "id": "GoogleCloudSecuritycenterV2VertexAi", "properties": { "datasets": { -"description": "Datasets associated with the finding.", "items": { "$ref": "GoogleCloudSecuritycenterV2Dataset" }, "type": "array" }, "pipelines": { -"description": "Pipelines associated with the finding.", "items": { "$ref": "GoogleCloudSecuritycenterV2Pipeline" }, @@ -9650,83 +8276,66 @@ false "type": "object" }, "GoogleCloudSecuritycenterV2Vulnerability": { -"description": "Refers to common vulnerability fields e.g. cve, cvss, cwe etc.", "id": "GoogleCloudSecuritycenterV2Vulnerability", "properties": { "cve": { -"$ref": "GoogleCloudSecuritycenterV2Cve", -"description": "CVE stands for Common Vulnerabilities and Exposures (https://cve.mitre.org/about/)" +"$ref": "GoogleCloudSecuritycenterV2Cve" }, "cwes": { -"description": "Represents one or more Common Weakness Enumeration (CWE) information on this vulnerability.", "items": { "$ref": "GoogleCloudSecuritycenterV2Cwe" }, "type": "array" }, "fixedPackage": { -"$ref": "GoogleCloudSecuritycenterV2Package", -"description": "The fixed package is relevant to the finding." +"$ref": "GoogleCloudSecuritycenterV2Package" }, "offendingPackage": { -"$ref": "GoogleCloudSecuritycenterV2Package", -"description": "The offending package is relevant to the finding." +"$ref": "GoogleCloudSecuritycenterV2Package" }, "providerRiskScore": { -"description": "Provider provided risk_score based on multiple factors. The higher the risk score, the more risky the vulnerability is.", "format": "int64", "type": "string" }, "reachable": { -"description": "Represents whether the vulnerability is reachable (detected via static analysis)", "type": "boolean" }, "securityBulletin": { -"$ref": "GoogleCloudSecuritycenterV2SecurityBulletin", -"description": "The security bulletin is relevant to this finding." +"$ref": "GoogleCloudSecuritycenterV2SecurityBulletin" } }, "type": "object" }, "GoogleCloudSecuritycenterV2YaraRuleSignature": { -"description": "A signature corresponding to a YARA rule.", "id": "GoogleCloudSecuritycenterV2YaraRuleSignature", "properties": { "yaraRule": { -"description": "The name of the YARA rule.", "type": "string" } }, "type": "object" }, "GroupAssetsRequest": { -"description": "Request message for grouping by assets.", "id": "GroupAssetsRequest", "properties": { "compareDuration": { -"description": "When compare_duration is set, the Asset's \"state\" property is updated to indicate whether the asset was added, removed, or remained present during the compare_duration period of time that precedes the read_time. This is the time between (read_time - compare_duration) and read_time. The state value is derived based on the presence of the asset at the two points in time. Intermediate state changes between the two times don't affect the result. For example, the results aren't affected if the asset is removed and re-created again. Possible \"state\" values when compare_duration is specified: * \"ADDED\": indicates that the asset was not present before compare_duration, but present at reference_time. * \"REMOVED\": indicates that the asset was present at the start of compare_duration, but not present at reference_time. * \"ACTIVE\": indicates that the asset was present at both the start and the end of the time period defined by compare_duration and reference_time. This field is ignored if `state` is not a field in `group_by`.", "format": "google-duration", "type": "string" }, "filter": { -"description": "Expression that defines the filter to apply across assets. The expression is a list of zero or more restrictions combined via logical operators `AND` and `OR`. Parentheses are not supported, and `OR` has higher precedence than `AND`. Restrictions have the form ` ` and may have a `-` character in front of them to indicate negation. The fields map to those defined in the Asset resource. Examples include: * name * security_center_properties.resource_name * resource_properties.a_property * security_marks.marks.marka The supported operators are: * `=` for all value types. * `>`, `<`, `>=`, `<=` for integer values. * `:`, meaning substring matching, for strings. The supported value types are: * string literals in quotes. * integer literals without quotes. * boolean literals `true` and `false` without quotes. For example, `resource_properties.size = 100` is a valid filter string.", "type": "string" }, "groupBy": { -"description": "Required. Expression that defines what assets fields to use for grouping. The string value should follow SQL syntax: comma separated list of fields. For example: \"security_center_properties.resource_project,security_center_properties.project\". The following fields are supported when compare_duration is not set: * security_center_properties.resource_project * security_center_properties.resource_type * security_center_properties.resource_parent The following fields are supported when compare_duration is set: * security_center_properties.resource_type", "type": "string" }, "pageSize": { -"description": "The maximum number of results to return in a single response. Default is 10, minimum is 1, maximum is 1000.", "format": "int32", "type": "integer" }, "pageToken": { -"description": "The value returned by the last `GroupAssetsResponse`; indicates that this is a continuation of a prior `GroupAssets` call, and that the system should return the next page of data.", "type": "string" }, "readTime": { -"description": "Time used as a reference point when filtering assets. The filter is limited to assets existing at the supplied time and their values are those at that specific time. Absence of this field will default to the API's version of NOW.", "format": "google-datetime", "type": "string" } @@ -9734,22 +8343,18 @@ false "type": "object" }, "GroupAssetsResponse": { -"description": "Response message for grouping by assets.", "id": "GroupAssetsResponse", "properties": { "groupByResults": { -"description": "Group results. There exists an element for each existing unique combination of property/values. The element contains a count for the number of times those specific property/values appear.", "items": { "$ref": "GroupResult" }, "type": "array" }, "nextPageToken": { -"description": "Token to retrieve the next page of results, or empty if there are no more results.", "type": "string" }, "readTime": { -"description": "Time used for executing the groupBy request.", "format": "google-datetime", "type": "string" } @@ -9757,28 +8362,22 @@ false "type": "object" }, "GroupFindingsRequest": { -"description": "Request message for grouping by findings.", "id": "GroupFindingsRequest", "properties": { "filter": { -"description": "Expression that defines the filter to apply across findings. The expression is a list of one or more restrictions combined via logical operators `AND` and `OR`. Parentheses are not supported, and `OR` has higher precedence than `AND`. Restrictions have the form ` ` and may have a `-` character in front of them to indicate negation. Examples include: * name * source_properties.a_property * security_marks.marks.marka The supported operators are: * `=` for all value types. * `>`, `<`, `>=`, `<=` for integer values. * `:`, meaning substring matching, for strings. The supported value types are: * string literals in quotes. * integer literals without quotes. * boolean literals `true` and `false` without quotes. For example, `source_properties.size = 100` is a valid filter string.", "type": "string" }, "groupBy": { -"description": "Required. Expression that defines what assets fields to use for grouping (including `state`). The string value should follow SQL syntax: comma separated list of fields. For example: \"parent,resource_name\". The following fields are supported: * resource_name * category * state * parent", "type": "string" }, "pageSize": { -"description": "The maximum number of results to return in a single response. Default is 10, minimum is 1, maximum is 1000.", "format": "int32", "type": "integer" }, "pageToken": { -"description": "The value returned by the last `GroupFindingsResponse`; indicates that this is a continuation of a prior `GroupFindings` call, and that the system should return the next page of data.", "type": "string" }, "readTime": { -"description": "Time used as a reference point when filtering findings. The filter is limited to findings existing at the supplied time and their values are those at that specific time. Absence of this field will default to the API's version of NOW.", "format": "google-datetime", "type": "string" } @@ -9786,22 +8385,18 @@ false "type": "object" }, "GroupFindingsResponse": { -"description": "Response message for group by findings.", "id": "GroupFindingsResponse", "properties": { "groupByResults": { -"description": "Group results. There exists an element for each existing unique combination of property/values. The element contains a count for the number of times those specific property/values appear.", "items": { "$ref": "GroupResult" }, "type": "array" }, "nextPageToken": { -"description": "Token to retrieve the next page of results, or empty if there are no more results.", "type": "string" }, "readTime": { -"description": "Time used for executing the groupBy request.", "format": "google-datetime", "type": "string" } @@ -9809,24 +8404,21 @@ false "type": "object" }, "GroupMembership": { -"description": "Contains details about groups of which this finding is a member. A group is a collection of findings that are related in some way.", "id": "GroupMembership", "properties": { "groupId": { -"description": "ID of the group.", "type": "string" }, "groupType": { -"description": "Type of group.", "enum": [ "GROUP_TYPE_UNSPECIFIED", "GROUP_TYPE_TOXIC_COMBINATION", "GROUP_TYPE_CHOKEPOINT" ], "enumDescriptions": [ -"Default value.", -"Group represents a toxic combination.", -"Group represents a chokepoint." +"", +"", +"" ], "type": "string" } @@ -9834,11 +8426,9 @@ false "type": "object" }, "GroupResult": { -"description": "Result containing the properties and count of a groupBy request.", "id": "GroupResult", "properties": { "count": { -"description": "Total count of resources for the given properties.", "format": "int64", "type": "string" }, @@ -9846,83 +8436,70 @@ false "additionalProperties": { "type": "any" }, -"description": "Properties matching the groupBy fields in the request.", "type": "object" } }, "type": "object" }, "HttpResponse": { -"description": "The http response returned by the web application.", "id": "HttpResponse", "properties": { "path": { -"description": "The http path for which response code was returned by web application, for example, \"https://test-app.a.run.app/test\".", "type": "string" }, "statusCode": { -"description": "The http response code returned by the web application, for example, 200.", "type": "string" } }, "type": "object" }, "IamBinding": { -"description": "Represents a particular IAM binding, which captures a member's role addition, removal, or state.", "id": "IamBinding", "properties": { "action": { -"description": "The action that was performed on a Binding.", "enum": [ "ACTION_UNSPECIFIED", "ADD", "REMOVE" ], "enumDescriptions": [ -"Unspecified.", -"Addition of a Binding.", -"Removal of a Binding." +"", +"", +"" ], "type": "string" }, "member": { -"description": "A single identity requesting access for a Cloud Platform resource, for example, \"foo@google.com\".", "type": "string" }, "role": { -"description": "Role that is assigned to \"members\". For example, \"roles/viewer\", \"roles/editor\", or \"roles/owner\".", "type": "string" } }, "type": "object" }, "Indicator": { -"description": "Represents what's commonly known as an _indicator of compromise_ (IoC) in computer forensics. This is an artifact observed on a network or in an operating system that, with high confidence, indicates a computer intrusion. For more information, see [Indicator of compromise](https://en.wikipedia.org/wiki/Indicator_of_compromise).", "id": "Indicator", "properties": { "domains": { -"description": "List of domains associated to the Finding.", "items": { "type": "string" }, "type": "array" }, "ipAddresses": { -"description": "The list of IP addresses that are associated with the finding.", "items": { "type": "string" }, "type": "array" }, "signatures": { -"description": "The list of matched signatures indicating that the given process is present in the environment.", "items": { "$ref": "ProcessSignature" }, "type": "array" }, "uris": { -"description": "The list of URIs associated to the Findings.", "items": { "type": "string" }, @@ -9932,84 +8509,70 @@ false "type": "object" }, "InfoType": { -"description": "Type of information detected by the API.", "id": "InfoType", "properties": { "name": { -"description": "Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`.", "type": "string" }, "sensitivityScore": { -"$ref": "SensitivityScore", -"description": "Optional custom sensitivity for this InfoType. This only applies to data profiling." +"$ref": "SensitivityScore" }, "version": { -"description": "Optional version name for this InfoType.", "type": "string" } }, "type": "object" }, "IpRule": { -"description": "IP rule information.", "id": "IpRule", "properties": { "portRanges": { -"description": "Optional. An optional list of ports to which this rule applies. This field is only applicable for the UDP or (S)TCP protocols. Each entry must be either an integer or a range including a min and max port number.", "items": { "$ref": "PortRange" }, "type": "array" }, "protocol": { -"description": "The IP protocol this rule applies to. This value can either be one of the following well known protocol strings (TCP, UDP, ICMP, ESP, AH, IPIP, SCTP) or a string representation of the integer value.", "type": "string" } }, "type": "object" }, "IpRules": { -"description": "IP rules associated with the finding.", "id": "IpRules", "properties": { "allowed": { -"$ref": "Allowed", -"description": "Tuple with allowed rules." +"$ref": "Allowed" }, "denied": { -"$ref": "Denied", -"description": "Tuple with denied rules." +"$ref": "Denied" }, "destinationIpRanges": { -"description": "If destination IP ranges are specified, the firewall rule applies only to traffic that has a destination IP address in these ranges. These ranges must be expressed in CIDR format. Only supports IPv4.", "items": { "type": "string" }, "type": "array" }, "direction": { -"description": "The direction that the rule is applicable to, one of ingress or egress.", "enum": [ "DIRECTION_UNSPECIFIED", "INGRESS", "EGRESS" ], "enumDescriptions": [ -"Unspecified direction value.", -"Ingress direction value.", -"Egress direction value." +"", +"", +"" ], "type": "string" }, "exposedServices": { -"description": "Name of the network protocol service, such as FTP, that is exposed by the open port. Follows the naming convention available at: https://www.iana.org/assignments/service-names-port-numbers/service-names-port-numbers.xhtml.", "items": { "type": "string" }, "type": "array" }, "sourceIpRanges": { -"description": "If source IP ranges are specified, the firewall rule applies only to traffic that has a source IP address in these ranges. These ranges must be expressed in CIDR format. Only supports IPv4.", "items": { "type": "string" }, @@ -10019,24 +8582,19 @@ false "type": "object" }, "Job": { -"description": "Describes a job", "id": "Job", "properties": { "errorCode": { -"description": "Optional. If the job did not complete successfully, this field describes why.", "format": "int32", "type": "integer" }, "location": { -"description": "Optional. Gives the location where the job ran, such as `US` or `europe-west1`", "type": "string" }, "name": { -"description": "The fully-qualified name for a job. e.g. `projects//jobs/`", "type": "string" }, "state": { -"description": "Output only. State of the job, such as `RUNNING` or `PENDING`.", "enum": [ "JOB_STATE_UNSPECIFIED", "PENDING", @@ -10045,11 +8603,11 @@ false "FAILED" ], "enumDescriptions": [ -"Unspecified represents an unknown state and should not be used.", -"Job is scheduled and pending for run", -"Job in progress", -"Job has completed with success", -"Job has completed but with failure" +"", +"", +"", +"", +"" ], "readOnly": true, "type": "string" @@ -10058,96 +8616,78 @@ false "type": "object" }, "KernelRootkit": { -"description": "Kernel mode rootkit signatures.", "id": "KernelRootkit", "properties": { "name": { -"description": "Rootkit name, when available.", "type": "string" }, "unexpectedCodeModification": { -"description": "True if unexpected modifications of kernel code memory are present.", "type": "boolean" }, "unexpectedFtraceHandler": { -"description": "True if `ftrace` points are present with callbacks pointing to regions that are not in the expected kernel or module code range.", "type": "boolean" }, "unexpectedInterruptHandler": { -"description": "True if interrupt handlers that are are not in the expected kernel or module code regions are present.", "type": "boolean" }, "unexpectedKernelCodePages": { -"description": "True if kernel code pages that are not in the expected kernel or module code regions are present.", "type": "boolean" }, "unexpectedKprobeHandler": { -"description": "True if `kprobe` points are present with callbacks pointing to regions that are not in the expected kernel or module code range.", "type": "boolean" }, "unexpectedProcessesInRunqueue": { -"description": "True if unexpected processes in the scheduler run queue are present. Such processes are in the run queue, but not in the process task list.", "type": "boolean" }, "unexpectedReadOnlyDataModification": { -"description": "True if unexpected modifications of kernel read-only data memory are present.", "type": "boolean" }, "unexpectedSystemCallHandler": { -"description": "True if system call handlers that are are not in the expected kernel or module code regions are present.", "type": "boolean" } }, "type": "object" }, "Kubernetes": { -"description": "Kubernetes-related attributes.", "id": "Kubernetes", "properties": { "accessReviews": { -"description": "Provides information on any Kubernetes access reviews (privilege checks) relevant to the finding.", "items": { "$ref": "AccessReview" }, "type": "array" }, "bindings": { -"description": "Provides Kubernetes role binding information for findings that involve [RoleBindings or ClusterRoleBindings](https://cloud.google.com/kubernetes-engine/docs/how-to/role-based-access-control).", "items": { "$ref": "GoogleCloudSecuritycenterV1Binding" }, "type": "array" }, "nodePools": { -"description": "GKE [node pools](https://cloud.google.com/kubernetes-engine/docs/concepts/node-pools) associated with the finding. This field contains node pool information for each node, when it is available.", "items": { "$ref": "NodePool" }, "type": "array" }, "nodes": { -"description": "Provides Kubernetes [node](https://cloud.google.com/kubernetes-engine/docs/concepts/cluster-architecture#nodes) information.", "items": { "$ref": "Node" }, "type": "array" }, "objects": { -"description": "Kubernetes objects related to the finding.", "items": { "$ref": "Object" }, "type": "array" }, "pods": { -"description": "Kubernetes [Pods](https://cloud.google.com/kubernetes-engine/docs/concepts/pod) associated with the finding. This field contains Pod records for each container that is owned by a Pod.", "items": { "$ref": "Pod" }, "type": "array" }, "roles": { -"description": "Provides Kubernetes role information for findings that involve [Roles or ClusterRoles](https://cloud.google.com/kubernetes-engine/docs/how-to/role-based-access-control).", "items": { "$ref": "Role" }, @@ -10157,42 +8697,34 @@ false "type": "object" }, "Label": { -"description": "Represents a generic name-value label. A label has separate name and value fields to support filtering with the `contains()` function. For more information, see [Filtering on array-type fields](https://cloud.google.com/security-command-center/docs/how-to-api-list-findings#array-contains-filtering).", "id": "Label", "properties": { "name": { -"description": "Name of the label.", "type": "string" }, "value": { -"description": "Value that corresponds to the label's name.", "type": "string" } }, "type": "object" }, "ListAssetsResponse": { -"description": "Response message for listing assets.", "id": "ListAssetsResponse", "properties": { "listAssetsResults": { -"description": "Assets matching the list request.", "items": { "$ref": "ListAssetsResult" }, "type": "array" }, "nextPageToken": { -"description": "Token to retrieve the next page of results, or empty if there are no more results.", "type": "string" }, "readTime": { -"description": "Time used for executing the list request.", "format": "google-datetime", "type": "string" }, "totalSize": { -"description": "The total number of assets matching the query.", "format": "int32", "type": "integer" } @@ -10200,15 +8732,12 @@ false "type": "object" }, "ListAssetsResult": { -"description": "Result containing the Asset and its State.", "id": "ListAssetsResult", "properties": { "asset": { -"$ref": "Asset", -"description": "Asset matching the search request." +"$ref": "Asset" }, "state": { -"description": "State of the asset.", "enum": [ "STATE_UNSPECIFIED", "UNUSED", @@ -10217,11 +8746,11 @@ false "ACTIVE" ], "enumDescriptions": [ -"Unspecified state.", -"Request did not specify use of this field in the result.", -"Asset was added between the points in time.", -"Asset was removed between the points in time.", -"Asset was active at both point(s) in time." +"", +"", +"", +"", +"" ], "type": "string" } @@ -10229,27 +8758,22 @@ false "type": "object" }, "ListFindingsResponse": { -"description": "Response message for listing findings.", "id": "ListFindingsResponse", "properties": { "findings": { -"description": "Findings matching the list request.", "items": { "$ref": "GoogleCloudSecuritycenterV1beta1Finding" }, "type": "array" }, "nextPageToken": { -"description": "Token to retrieve the next page of results, or empty if there are no more results.", "type": "string" }, "readTime": { -"description": "Time used for executing the list request.", "format": "google-datetime", "type": "string" }, "totalSize": { -"description": "The total number of findings matching the query.", "format": "int32", "type": "integer" } @@ -10257,22 +8781,18 @@ false "type": "object" }, "ListOperationsResponse": { -"description": "The response message for Operations.ListOperations.", "id": "ListOperationsResponse", "properties": { "nextPageToken": { -"description": "The standard List next-page token.", "type": "string" }, "operations": { -"description": "A list of operations that matches the specified filter in the request.", "items": { "$ref": "Operation" }, "type": "array" }, "unreachable": { -"description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections. For example, when attempting to list all resources across all supported locations.", "items": { "type": "string" }, @@ -10282,15 +8802,12 @@ false "type": "object" }, "ListSourcesResponse": { -"description": "Response message for listing sources.", "id": "ListSourcesResponse", "properties": { "nextPageToken": { -"description": "Token to retrieve the next page of results, or empty if there are no more results.", "type": "string" }, "sources": { -"description": "Sources belonging to the requested parent.", "items": { "$ref": "Source" }, @@ -10300,37 +8817,30 @@ false "type": "object" }, "LoadBalancer": { -"description": "Contains information related to the load balancer associated with the finding.", "id": "LoadBalancer", "properties": { "name": { -"description": "The name of the load balancer associated with the finding.", "type": "string" } }, "type": "object" }, "LogEntry": { -"description": "An individual entry in a log.", "id": "LogEntry", "properties": { "cloudLoggingEntry": { -"$ref": "CloudLoggingEntry", -"description": "An individual entry in a log stored in Cloud Logging." +"$ref": "CloudLoggingEntry" } }, "type": "object" }, "MemoryHashSignature": { -"description": "A signature corresponding to memory page hashes.", "id": "MemoryHashSignature", "properties": { "binaryFamily": { -"description": "The binary family.", "type": "string" }, "detections": { -"description": "The list of memory hash detections contributing to the binary family match.", "items": { "$ref": "Detection" }, @@ -10340,11 +8850,9 @@ false "type": "object" }, "MitreAttack": { -"description": "MITRE ATT&CK tactics and techniques related to this finding. See: https://attack.mitre.org", "id": "MitreAttack", "properties": { "additionalTactics": { -"description": "Additional MITRE ATT&CK tactics related to this finding, if any.", "items": { "enum": [ "TACTIC_UNSPECIFIED", @@ -10364,28 +8872,27 @@ false "IMPACT" ], "enumDescriptions": [ -"Unspecified value.", -"TA0043", -"TA0042", -"TA0001", -"TA0002", -"TA0003", -"TA0004", -"TA0005", -"TA0006", -"TA0007", -"TA0008", -"TA0009", -"TA0011", -"TA0010", -"TA0040" +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"" ], "type": "string" }, "type": "array" }, "additionalTechniques": { -"description": "Additional MITRE ATT&CK techniques related to this finding, if any, along with any of their respective parent techniques.", "items": { "enum": [ "TECHNIQUE_UNSPECIFIED", @@ -10529,152 +9036,151 @@ false "FINANCIAL_THEFT" ], "enumDescriptions": [ -"Unspecified value.", -"T1001", -"T1001.002", -"T1003", -"T1003.007", -"T1003.008", -"T1005", -"T1020", -"T1027", -"T1027.003", -"T1027.004", -"T1027.010", -"T1029", -"T1033", -"T1036", -"T1036.005", -"T1037", -"T1037.005", -"T1046", -"T1053", -"T1053.003", -"T1053.007", -"T1055", -"T1056", -"T1056.001", -"T1057", -"T1059", -"T1059.004", -"T1059.006", -"T1068", -"T1069", -"T1069.003", -"T1070", -"T1070.002", -"T1070.003", -"T1070.004", -"T1070.006", -"T1070.008", -"T1071", -"T1071.004", -"T1072", -"T1078", -"T1078.001", -"T1078.003", -"T1078.004", -"T1083", -"T1087.001", -"T1090", -"T1090.002", -"T1090.003", -"T1098", -"T1098.001", -"T1098.003", -"T1098.004", -"T1098.006", -"T1104", -"T1105", -"T1106", -"T1110", -"T1119", -"T1129", -"T1132", -"T1132.001", -"T1134", -"T1134.001", -"T1136", -"T1136.001", -"T1140", -"T1190", -"T1195", -"T1195.001", -"T1203", -"T1204", -"T1212", -"T1222.002", -"T1484", -"T1485", -"T1486", -"T1489", -"T1490", -"T1495", -"T1496", -"T1498", -"T1526", -"T1528", -"T1531", -"T1537", -"T1539", -"T1543", -"T1546", -"T1547", -"T1547.006", -"T1547.009", -"T1548", -"T1548.001", -"T1548.003", -"T1552", -"T1552.001", -"T1552.003", -"T1552.004", -"T1553", -"T1553.004", -"T1554", -"T1555", -"T1556", -"T1556.003", -"T1556.006", -"T1562", -"T1562.001", -"T1562.006", -"T1562.012", -"T1564", -"T1564.001", -"T1564.002", -"T1567", -"T1567.002", -"T1568", -"T1570", -"T1574", -"T1574.006", -"T1578", -"T1578.001", -"T1580", -"T1587", -"T1587.001", -"T1588", -"T1588.001", -"T1588.006", -"T1595", -"T1595.001", -"T1608", -"T1608.001", -"T1609", -"T1610", -"T1611", -"T1613", -"T1620", -"T1649", -"T1657" +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"" ], "type": "string" }, "type": "array" }, "primaryTactic": { -"description": "The MITRE ATT&CK tactic most closely represented by this finding, if any.", "enum": [ "TACTIC_UNSPECIFIED", "RECONNAISSANCE", @@ -10693,26 +9199,25 @@ false "IMPACT" ], "enumDescriptions": [ -"Unspecified value.", -"TA0043", -"TA0042", -"TA0001", -"TA0002", -"TA0003", -"TA0004", -"TA0005", -"TA0006", -"TA0007", -"TA0008", -"TA0009", -"TA0011", -"TA0010", -"TA0040" +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"" ], "type": "string" }, "primaryTechniques": { -"description": "The MITRE ATT&CK technique most closely represented by this finding, if any. primary_techniques is a repeated field because there are multiple levels of MITRE ATT&CK techniques. If the technique most closely represented by this finding is a sub-technique (e.g. `SCANNING_IP_BLOCKS`), both the sub-technique and its parent technique(s) will be listed (e.g. `SCANNING_IP_BLOCKS`, `ACTIVE_SCANNING`).", "items": { "enum": [ "TECHNIQUE_UNSPECIFIED", @@ -10856,207 +9361,196 @@ false "FINANCIAL_THEFT" ], "enumDescriptions": [ -"Unspecified value.", -"T1001", -"T1001.002", -"T1003", -"T1003.007", -"T1003.008", -"T1005", -"T1020", -"T1027", -"T1027.003", -"T1027.004", -"T1027.010", -"T1029", -"T1033", -"T1036", -"T1036.005", -"T1037", -"T1037.005", -"T1046", -"T1053", -"T1053.003", -"T1053.007", -"T1055", -"T1056", -"T1056.001", -"T1057", -"T1059", -"T1059.004", -"T1059.006", -"T1068", -"T1069", -"T1069.003", -"T1070", -"T1070.002", -"T1070.003", -"T1070.004", -"T1070.006", -"T1070.008", -"T1071", -"T1071.004", -"T1072", -"T1078", -"T1078.001", -"T1078.003", -"T1078.004", -"T1083", -"T1087.001", -"T1090", -"T1090.002", -"T1090.003", -"T1098", -"T1098.001", -"T1098.003", -"T1098.004", -"T1098.006", -"T1104", -"T1105", -"T1106", -"T1110", -"T1119", -"T1129", -"T1132", -"T1132.001", -"T1134", -"T1134.001", -"T1136", -"T1136.001", -"T1140", -"T1190", -"T1195", -"T1195.001", -"T1203", -"T1204", -"T1212", -"T1222.002", -"T1484", -"T1485", -"T1486", -"T1489", -"T1490", -"T1495", -"T1496", -"T1498", -"T1526", -"T1528", -"T1531", -"T1537", -"T1539", -"T1543", -"T1546", -"T1547", -"T1547.006", -"T1547.009", -"T1548", -"T1548.001", -"T1548.003", -"T1552", -"T1552.001", -"T1552.003", -"T1552.004", -"T1553", -"T1553.004", -"T1554", -"T1555", -"T1556", -"T1556.003", -"T1556.006", -"T1562", -"T1562.001", -"T1562.006", -"T1562.012", -"T1564", -"T1564.001", -"T1564.002", -"T1567", -"T1567.002", -"T1568", -"T1570", -"T1574", -"T1574.006", -"T1578", -"T1578.001", -"T1580", -"T1587", -"T1587.001", -"T1588", -"T1588.001", -"T1588.006", -"T1595", -"T1595.001", -"T1608", -"T1608.001", -"T1609", -"T1610", -"T1611", -"T1613", -"T1620", -"T1649", -"T1657" +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"" ], "type": "string" }, "type": "array" }, "version": { -"description": "The MITRE ATT&CK version referenced by the above fields. E.g. \"8\".", "type": "string" } }, "type": "object" }, "MuteInfo": { -"description": "Mute information about the finding, including whether the finding has a static mute or any matching dynamic mute rules.", "id": "MuteInfo", "properties": { "dynamicMuteRecords": { -"description": "The list of dynamic mute rules that currently match the finding.", "items": { "$ref": "DynamicMuteRecord" }, "type": "array" }, "staticMute": { -"$ref": "StaticMute", -"description": "If set, the static mute applied to this finding. Static mutes override dynamic mutes. If unset, there is no static mute." +"$ref": "StaticMute" } }, "type": "object" }, "Network": { -"description": "Contains information about a VPC network associated with the finding.", "id": "Network", "properties": { "name": { -"description": "The name of the VPC network resource, for example, `//compute.googleapis.com/projects/my-project/global/networks/my-network`.", "type": "string" } }, "type": "object" }, "Node": { -"description": "Kubernetes nodes associated with the finding.", "id": "Node", "properties": { "name": { -"description": "[Full resource name](https://google.aip.dev/122#full-resource-names) of the Compute Engine VM running the cluster node.", "type": "string" } }, "type": "object" }, "NodePool": { -"description": "Provides GKE node pool information.", "id": "NodePool", "properties": { "name": { -"description": "Kubernetes node pool name.", "type": "string" }, "nodes": { -"description": "Nodes associated with the finding.", "items": { "$ref": "Node" }, @@ -11066,81 +9560,65 @@ false "type": "object" }, "Notebook": { -"description": "Represents a Jupyter notebook IPYNB file, such as a [Colab Enterprise notebook](https://cloud.google.com/colab/docs/introduction) file, that is associated with a finding.", "id": "Notebook", "properties": { "lastAuthor": { -"description": "The user ID of the latest author to modify the notebook.", "type": "string" }, "name": { -"description": "The name of the notebook.", "type": "string" }, "notebookUpdateTime": { -"description": "The most recent time the notebook was updated.", "format": "google-datetime", "type": "string" }, "service": { -"description": "The source notebook service, for example, \"Colab Enterprise\".", "type": "string" } }, "type": "object" }, "Object": { -"description": "Kubernetes object related to the finding, uniquely identified by GKNN. Used if the object Kind is not one of Pod, Node, NodePool, Binding, or AccessReview.", "id": "Object", "properties": { "containers": { -"description": "Pod containers associated with this finding, if any.", "items": { "$ref": "Container" }, "type": "array" }, "group": { -"description": "Kubernetes object group, such as \"policy.k8s.io/v1\".", "type": "string" }, "kind": { -"description": "Kubernetes object kind, such as \"Namespace\".", "type": "string" }, "name": { -"description": "Kubernetes object name. For details see https://kubernetes.io/docs/concepts/overview/working-with-objects/names/.", "type": "string" }, "ns": { -"description": "Kubernetes object namespace. Must be a valid DNS label. Named \"ns\" to avoid collision with C++ namespace keyword. For details see https://kubernetes.io/docs/tasks/administer-cluster/namespaces/.", "type": "string" } }, "type": "object" }, "Operation": { -"description": "This resource represents a long-running operation that is the result of a network API call.", "id": "Operation", "properties": { "done": { -"description": "If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.", "type": "boolean" }, "error": { -"$ref": "Status", -"description": "The error result of the operation in case of failure or cancellation." +"$ref": "Status" }, "metadata": { "additionalProperties": { "description": "Properties of the object. Contains field @type with type URL.", "type": "any" }, -"description": "Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.", "type": "object" }, "name": { -"description": "The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.", "type": "string" }, "response": { @@ -11148,134 +9626,109 @@ false "description": "Properties of the object. Contains field @type with type URL.", "type": "any" }, -"description": "The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.", "type": "object" } }, "type": "object" }, "OrgPolicy": { -"description": "Contains information about the org policies associated with the finding.", "id": "OrgPolicy", "properties": { "name": { -"description": "The resource name of the org policy. Example: \"organizations/{organization_id}/policies/{constraint_name}\"", "type": "string" } }, "type": "object" }, "OrganizationSettings": { -"description": "User specified settings that are attached to the Security Command Center organization.", "id": "OrganizationSettings", "properties": { "assetDiscoveryConfig": { -"$ref": "AssetDiscoveryConfig", -"description": "The configuration used for Asset Discovery runs." +"$ref": "AssetDiscoveryConfig" }, "enableAssetDiscovery": { -"description": "A flag that indicates if Asset Discovery should be enabled. If the flag is set to `true`, then discovery of assets will occur. If it is set to `false`, all historical assets will remain, but discovery of future assets will not occur.", "type": "boolean" }, "name": { -"description": "The relative resource name of the settings. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Example: \"organizations/{organization_id}/organizationSettings\".", "type": "string" } }, "type": "object" }, "Package": { -"description": "Package is a generic definition of a package.", "id": "Package", "properties": { "cpeUri": { -"description": "The CPE URI where the vulnerability was detected.", "type": "string" }, "packageName": { -"description": "The name of the package where the vulnerability was detected.", "type": "string" }, "packageType": { -"description": "Type of package, for example, os, maven, or go.", "type": "string" }, "packageVersion": { -"description": "The version of the package.", "type": "string" } }, "type": "object" }, "Pipeline": { -"description": "Vertex AI training pipeline associated with the finding.", "id": "Pipeline", "properties": { "displayName": { -"description": "The user defined display name of pipeline, e.g. plants-classification", "type": "string" }, "name": { -"description": "Resource name of the pipeline, e.g. projects/{project}/locations/{location}/trainingPipelines/5253428229225578496", "type": "string" } }, "type": "object" }, "Pod": { -"description": "A Kubernetes Pod.", "id": "Pod", "properties": { "containers": { -"description": "Pod containers associated with this finding, if any.", "items": { "$ref": "Container" }, "type": "array" }, "labels": { -"description": "Pod labels. For Kubernetes containers, these are applied to the container.", "items": { "$ref": "Label" }, "type": "array" }, "name": { -"description": "Kubernetes Pod name.", "type": "string" }, "ns": { -"description": "Kubernetes Pod namespace.", "type": "string" } }, "type": "object" }, "Policy": { -"description": "An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { \"bindings\": [ { \"role\": \"roles/resourcemanager.organizationAdmin\", \"members\": [ \"user:mike@example.com\", \"group:admins@example.com\", \"domain:google.com\", \"serviceAccount:my-project-id@appspot.gserviceaccount.com\" ] }, { \"role\": \"roles/resourcemanager.organizationViewer\", \"members\": [ \"user:eve@example.com\" ], \"condition\": { \"title\": \"expirable access\", \"description\": \"Does not grant access after Sep 2020\", \"expression\": \"request.time < timestamp('2020-10-01T00:00:00.000Z')\", } } ], \"etag\": \"BwWWja0YfJA=\", \"version\": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).", "id": "Policy", "properties": { "auditConfigs": { -"description": "Specifies cloud audit logging configuration for this policy.", "items": { "$ref": "AuditConfig" }, "type": "array" }, "bindings": { -"description": "Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`.", "items": { "$ref": "Binding" }, "type": "array" }, "etag": { -"description": "`etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.", "format": "byte", "type": "string" }, "version": { -"description": "Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", "format": "int32", "type": "integer" } @@ -11283,45 +9736,36 @@ false "type": "object" }, "PolicyDriftDetails": { -"description": "The policy field that violates the deployed posture and its expected and detected values.", "id": "PolicyDriftDetails", "properties": { "detectedValue": { -"description": "The detected value that violates the deployed posture, for example, `false` or `allowed_values={\"projects/22831892\"}`.", "type": "string" }, "expectedValue": { -"description": "The value of this field that was configured in a posture, for example, `true` or `allowed_values={\"projects/29831892\"}`.", "type": "string" }, "field": { -"description": "The name of the updated field, for example constraint.implementation.policy_rules[0].enforce", "type": "string" } }, "type": "object" }, "PolicyViolationSummary": { -"description": "Metadata summarizing policy violations of child resources of the affected resource. `finding_category` and `resource` determine the exact semantics of the counts. For example, when category=DATA_SECURITY_POSTURE_OBJECT_PUBLIC_ACCESS_VIOLATION and resource='storage.googleapis.com/buckets/my-bucket-name' then this counts the number of Cloud Storage objects in my-bucket-name which violate a Public Access control.", "id": "PolicyViolationSummary", "properties": { "conformantResourcesCount": { -"description": "Total number of child resources that conform to the policy.", "format": "int64", "type": "string" }, "evaluationErrorsCount": { -"description": "Number of child resources for which errors during evaluation occurred. The evaluation result for these child resources is effectively \"unknown\".", "format": "int64", "type": "string" }, "outOfScopeResourcesCount": { -"description": "Total count of child resources which were not in scope for evaluation.", "format": "int64", "type": "string" }, "policyViolationsCount": { -"description": "Count of child resources in violation of the policy.", "format": "int64", "type": "string" } @@ -11329,16 +9773,13 @@ false "type": "object" }, "PortRange": { -"description": "A port range which is inclusive of the min and max values. Values are between 0 and 2^16-1. The max can be equal / must be not smaller than the min value. If min and max are equal this indicates that it is a single port.", "id": "PortRange", "properties": { "max": { -"description": "Maximum port value.", "format": "int64", "type": "string" }, "min": { -"description": "Minimum port value.", "format": "int64", "type": "string" } @@ -11346,62 +9787,50 @@ false "type": "object" }, "Process": { -"description": "Represents an operating system process.", "id": "Process", "properties": { "args": { -"description": "Process arguments as JSON encoded strings.", "items": { "type": "string" }, "type": "array" }, "argumentsTruncated": { -"description": "True if `args` is incomplete.", "type": "boolean" }, "binary": { -"$ref": "File", -"description": "File information for the process executable." +"$ref": "File" }, "envVariables": { -"description": "Process environment variables.", "items": { "$ref": "EnvironmentVariable" }, "type": "array" }, "envVariablesTruncated": { -"description": "True if `env_variables` is incomplete.", "type": "boolean" }, "libraries": { -"description": "File information for libraries loaded by the process.", "items": { "$ref": "File" }, "type": "array" }, "name": { -"description": "The process name, as displayed in utilities like `top` and `ps`. This name can be accessed through `/proc/[pid]/comm` and changed with `prctl(PR_SET_NAME)`.", "type": "string" }, "parentPid": { -"description": "The parent process ID.", "format": "int64", "type": "string" }, "pid": { -"description": "The process ID.", "format": "int64", "type": "string" }, "script": { -"$ref": "File", -"description": "When the process represents the invocation of a script, `binary` provides information about the interpreter, while `script` provides information about the script file provided to the interpreter." +"$ref": "File" }, "userId": { -"description": "The ID of the user that executed the process. E.g. If this is the root user this will always be 0.", "format": "int64", "type": "string" } @@ -11409,70 +9838,58 @@ false "type": "object" }, "ProcessSignature": { -"description": "Indicates what signature matched this process.", "id": "ProcessSignature", "properties": { "memoryHashSignature": { -"$ref": "MemoryHashSignature", -"description": "Signature indicating that a binary family was matched." +"$ref": "MemoryHashSignature" }, "signatureType": { -"description": "Describes the type of resource associated with the signature.", "enum": [ "SIGNATURE_TYPE_UNSPECIFIED", "SIGNATURE_TYPE_PROCESS", "SIGNATURE_TYPE_FILE" ], "enumDescriptions": [ -"The default signature type.", -"Used for signatures concerning processes.", -"Used for signatures concerning disks." +"", +"", +"" ], "type": "string" }, "yaraRuleSignature": { -"$ref": "YaraRuleSignature", -"description": "Signature indicating that a YARA rule was matched." +"$ref": "YaraRuleSignature" } }, "type": "object" }, "Reference": { -"description": "Additional Links", "id": "Reference", "properties": { "source": { -"description": "Source of the reference e.g. NVD", "type": "string" }, "uri": { -"description": "Uri for the mentioned source e.g. https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2021-34527.", "type": "string" } }, "type": "object" }, "Requests": { -"description": "Information about the requests relevant to the finding.", "id": "Requests", "properties": { "longTermAllowed": { -"description": "Allowed RPS (requests per second) over the long term.", "format": "int32", "type": "integer" }, "longTermDenied": { -"description": "Denied RPS (requests per second) over the long term.", "format": "int32", "type": "integer" }, "ratio": { -"description": "For 'Increasing deny ratio', the ratio is the denied traffic divided by the allowed traffic. For 'Allowed traffic spike', the ratio is the allowed traffic in the short term divided by allowed traffic in the long term.", "format": "double", "type": "number" }, "shortTermAllowed": { -"description": "Allowed RPS (requests per second) in the short term.", "format": "int32", "type": "integer" } @@ -11480,11 +9897,9 @@ false "type": "object" }, "ResourcePath": { -"description": "Represents the path of resources leading up to the resource this finding is about.", "id": "ResourcePath", "properties": { "nodes": { -"description": "The list of nodes that make the up resource path, ordered from lowest level to highest level.", "items": { "$ref": "ResourcePathNode" }, @@ -11494,19 +9909,15 @@ false "type": "object" }, "ResourcePathNode": { -"description": "A node within the resource path. Each node represents a resource within the resource hierarchy.", "id": "ResourcePathNode", "properties": { "displayName": { -"description": "The display name of the resource this node represents.", "type": "string" }, "id": { -"description": "The ID of the resource this node represents.", "type": "string" }, "nodeType": { -"description": "The type of resource this node represents.", "enum": [ "RESOURCE_PATH_NODE_TYPE_UNSPECIFIED", "GCP_ORGANIZATION", @@ -11520,16 +9931,16 @@ false "AZURE_RESOURCE_GROUP" ], "enumDescriptions": [ -"Node type is unspecified.", -"The node represents a Google Cloud organization.", -"The node represents a Google Cloud folder.", -"The node represents a Google Cloud project.", -"The node represents an AWS organization.", -"The node represents an AWS organizational unit.", -"The node represents an AWS account.", -"The node represents an Azure management group.", -"The node represents an Azure subscription.", -"The node represents an Azure resource group." +"", +"", +"", +"", +"", +"", +"", +"", +"", +"" ], "type": "string" } @@ -11537,96 +9948,79 @@ false "type": "object" }, "Role": { -"description": "Kubernetes Role or ClusterRole.", "id": "Role", "properties": { "kind": { -"description": "Role type.", "enum": [ "KIND_UNSPECIFIED", "ROLE", "CLUSTER_ROLE" ], "enumDescriptions": [ -"Role type is not specified.", -"Kubernetes Role.", -"Kubernetes ClusterRole." +"", +"", +"" ], "type": "string" }, "name": { -"description": "Role name.", "type": "string" }, "ns": { -"description": "Role namespace.", "type": "string" } }, "type": "object" }, "RunAssetDiscoveryRequest": { -"description": "Request message for running asset discovery for an organization.", "id": "RunAssetDiscoveryRequest", "properties": {}, "type": "object" }, "Secret": { -"description": "Details about a secret or credential associated with the finding.", "id": "Secret", "properties": { "environmentVariable": { -"$ref": "SecretEnvironmentVariable", -"description": "The environment variable containing the secret." +"$ref": "SecretEnvironmentVariable" }, "filePath": { -"$ref": "SecretFilePath", -"description": "The file containing the secret." +"$ref": "SecretFilePath" }, "status": { -"$ref": "SecretStatus", -"description": "The status of the secret." +"$ref": "SecretStatus" }, "type": { -"description": "The type of secret, for example, GCP_API_KEY.", "type": "string" } }, "type": "object" }, "SecretEnvironmentVariable": { -"description": "Environment variable containing the secret.", "id": "SecretEnvironmentVariable", "properties": { "key": { -"description": "Environment variable name as a JSON encoded string. Note that value is not included since the value contains the secret data, which is sensitive core content.", "type": "string" } }, "type": "object" }, "SecretFilePath": { -"description": "File path containing the secret.", "id": "SecretFilePath", "properties": { "path": { -"description": "Path to the file.", "type": "string" } }, "type": "object" }, "SecretStatus": { -"description": "The status of the secret.", "id": "SecretStatus", "properties": { "lastUpdatedTime": { -"description": "Time that the secret was found.", "format": "google-datetime", "type": "string" }, "validity": { -"description": "The validity of the secret.", "enum": [ "SECRET_VALIDITY_UNSPECIFIED", "SECRET_VALIDITY_UNSUPPORTED", @@ -11635,11 +10029,11 @@ false "SECRET_VALIDITY_VALID" ], "enumDescriptions": [ -"Default value; no validation was attempted.", -"There is no mechanism to validate the secret.", -"Validation is supported but the validation failed.", -"The secret is confirmed to be invalid.", -"The secret is confirmed to be valid." +"", +"", +"", +"", +"" ], "type": "string" } @@ -11647,144 +10041,115 @@ false "type": "object" }, "SecurityBulletin": { -"description": "SecurityBulletin are notifications of vulnerabilities of Google products.", "id": "SecurityBulletin", "properties": { "bulletinId": { -"description": "ID of the bulletin corresponding to the vulnerability.", "type": "string" }, "submissionTime": { -"description": "Submission time of this Security Bulletin.", "format": "google-datetime", "type": "string" }, "suggestedUpgradeVersion": { -"description": "This represents a version that the cluster receiving this notification should be upgraded to, based on its current version. For example, 1.15.0", "type": "string" } }, "type": "object" }, "SecurityCenterProperties": { -"description": "Security Command Center managed properties. These properties are managed by Security Command Center and cannot be modified by the user.", "id": "SecurityCenterProperties", "properties": { "resourceName": { -"description": "Immutable. The full resource name of the Google Cloud resource this asset represents. This field is immutable after create time. See: https://cloud.google.com/apis/design/resource_names#full_resource_name", "type": "string" }, "resourceOwners": { -"description": "Owners of the Google Cloud resource.", "items": { "type": "string" }, "type": "array" }, "resourceParent": { -"description": "The full resource name of the immediate parent of the resource. See: https://cloud.google.com/apis/design/resource_names#full_resource_name", "type": "string" }, "resourceProject": { -"description": "The full resource name of the project the resource belongs to. See: https://cloud.google.com/apis/design/resource_names#full_resource_name", "type": "string" }, "resourceType": { -"description": "The type of the Google Cloud resource. Examples include: APPLICATION, PROJECT, and ORGANIZATION. This is a case insensitive field defined by Security Command Center and/or the producer of the resource and is immutable after create time.", "type": "string" } }, "type": "object" }, "SecurityMarks": { -"description": "User specified security marks that are attached to the parent Security Command Center resource. Security marks are scoped within a Security Command Center organization -- they can be modified and viewed by all users who have proper permissions on the organization.", "id": "SecurityMarks", "properties": { "canonicalName": { -"description": "The canonical name of the marks. Examples: \"organizations/{organization_id}/assets/{asset_id}/securityMarks\" \"folders/{folder_id}/assets/{asset_id}/securityMarks\" \"projects/{project_number}/assets/{asset_id}/securityMarks\" \"organizations/{organization_id}/sources/{source_id}/findings/{finding_id}/securityMarks\" \"folders/{folder_id}/sources/{source_id}/findings/{finding_id}/securityMarks\" \"projects/{project_number}/sources/{source_id}/findings/{finding_id}/securityMarks\"", "type": "string" }, "marks": { "additionalProperties": { "type": "string" }, -"description": "Mutable user specified security marks belonging to the parent resource. Constraints are as follows: * Keys and values are treated as case insensitive * Keys must be between 1 - 256 characters (inclusive) * Keys must be letters, numbers, underscores, or dashes * Values have leading and trailing whitespace trimmed, remaining characters must be between 1 - 4096 characters (inclusive)", "type": "object" }, "name": { -"description": "The relative resource name of the SecurityMarks. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Examples: \"organizations/{organization_id}/assets/{asset_id}/securityMarks\" \"organizations/{organization_id}/sources/{source_id}/findings/{finding_id}/securityMarks\".", "type": "string" } }, "type": "object" }, "SecurityPolicy": { -"description": "Information about the [Google Cloud Armor security policy](https://cloud.google.com/armor/docs/security-policy-overview) relevant to the finding.", "id": "SecurityPolicy", "properties": { "name": { -"description": "The name of the Google Cloud Armor security policy, for example, \"my-security-policy\".", "type": "string" }, "preview": { -"description": "Whether or not the associated rule or policy is in preview mode.", "type": "boolean" }, "type": { -"description": "The type of Google Cloud Armor security policy for example, 'backend security policy', 'edge security policy', 'network edge security policy', or 'always-on DDoS protection'.", "type": "string" } }, "type": "object" }, "SecurityPosture": { -"description": "Represents a posture that is deployed on Google Cloud by the Security Command Center Posture Management service. A posture contains one or more policy sets. A policy set is a group of policies that enforce a set of security rules on Google Cloud.", "id": "SecurityPosture", "properties": { "changedPolicy": { -"description": "The name of the updated policy, for example, `projects/{project_id}/policies/{constraint_name}`.", "type": "string" }, "name": { -"description": "Name of the posture, for example, `CIS-Posture`.", "type": "string" }, "policy": { -"description": "The ID of the updated policy, for example, `compute-policy-1`.", "type": "string" }, "policyDriftDetails": { -"description": "The details about a change in an updated policy that violates the deployed posture.", "items": { "$ref": "PolicyDriftDetails" }, "type": "array" }, "policySet": { -"description": "The name of the updated policyset, for example, `cis-policyset`.", "type": "string" }, "postureDeployment": { -"description": "The name of the posture deployment, for example, `organizations/{org_id}/posturedeployments/{posture_deployment_id}`.", "type": "string" }, "postureDeploymentResource": { -"description": "The project, folder, or organization on which the posture is deployed, for example, `projects/{project_number}`.", "type": "string" }, "revisionId": { -"description": "The version of the posture, for example, `c7cfa2a8`.", "type": "string" } }, "type": "object" }, "SensitivityScore": { -"description": "Score is calculated from of all elements in the data profile. A higher level means the data is more sensitive.", "id": "SensitivityScore", "properties": { "score": { -"description": "The sensitivity score applied to the resource.", "enum": [ "SENSITIVITY_SCORE_LEVEL_UNSPECIFIED", "SENSITIVITY_LOW", @@ -11793,11 +10158,11 @@ false "SENSITIVITY_HIGH" ], "enumDescriptions": [ -"Unused.", -"No sensitive information detected. The resource isn't publicly accessible.", -"Unable to determine sensitivity.", -"Medium risk. Contains personally identifiable information (PII), potentially sensitive data, or fields with free-text data that are at a higher risk of having intermittent sensitive data. Consider limiting access.", -"High risk. Sensitive personally identifiable information (SPII) can be present. Exfiltration of data can lead to user data loss. Re-identification of users might be possible. Consider limiting usage and or removing SPII." +"", +"", +"", +"", +"" ], "type": "string" } @@ -11805,40 +10170,34 @@ false "type": "object" }, "ServiceAccountDelegationInfo": { -"description": "Identity delegation history of an authenticated service account.", "id": "ServiceAccountDelegationInfo", "properties": { "principalEmail": { -"description": "The email address of a Google account.", "type": "string" }, "principalSubject": { -"description": "A string representing the principal_subject associated with the identity. As compared to `principal_email`, supports principals that aren't associated with email addresses, such as third party principals. For most identities, the format will be `principal://iam.googleapis.com/{identity pool name}/subjects/{subject}` except for some GKE identities (GKE_WORKLOAD, FREEFORM, GKE_HUB_WORKLOAD) that are still in the legacy format `serviceAccount:{identity pool name}[{subject}]`", "type": "string" } }, "type": "object" }, "SetFindingStateRequest": { -"description": "Request message for updating a finding's state.", "id": "SetFindingStateRequest", "properties": { "startTime": { -"description": "Optional. The time at which the updated state takes effect. If not set uses the current time.", "format": "google-datetime", "type": "string" }, "state": { -"description": "Required. The desired State of the finding.", "enum": [ "STATE_UNSPECIFIED", "ACTIVE", "INACTIVE" ], "enumDescriptions": [ -"Unspecified state.", -"The finding requires attention and has not been addressed yet.", -"The finding has been fixed, triaged as a non-issue or otherwise addressed and is no longer active." +"", +"", +"" ], "type": "string" } @@ -11846,15 +10205,12 @@ false "type": "object" }, "SetIamPolicyRequest": { -"description": "Request message for `SetIamPolicy` method.", "id": "SetIamPolicyRequest", "properties": { "policy": { -"$ref": "Policy", -"description": "REQUIRED: The complete policy to be applied to the `resource`. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Google Cloud services (such as Projects) might reject them." +"$ref": "Policy" }, "updateMask": { -"description": "OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only the fields in the mask will be modified. If no mask is provided, the following default mask is used: `paths: \"bindings, etag\"`", "format": "google-fieldmask", "type": "string" } @@ -11862,35 +10218,28 @@ false "type": "object" }, "Source": { -"description": "Security Command Center finding source. A finding source is an entity or a mechanism that can produce a finding. A source is like a container of findings that come from the same scanner, logger, monitor, etc.", "id": "Source", "properties": { "description": { -"description": "The description of the source (max of 1024 characters). Example: \"Web Security Scanner is a web security scanner for common vulnerabilities in App Engine applications. It can automatically scan and detect four common vulnerabilities, including cross-site-scripting (XSS), Flash injection, mixed content (HTTP in HTTPS), and outdated/insecure libraries.\"", "type": "string" }, "displayName": { -"description": "The source's display name. A source's display name must be unique amongst its siblings, for example, two sources with the same parent can't share the same display name. The display name must have a length between 1 and 64 characters (inclusive).", "type": "string" }, "name": { -"description": "The relative resource name of this source. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Example: \"organizations/{organization_id}/sources/{source_id}\"", "type": "string" } }, "type": "object" }, "StaticMute": { -"description": "Information about the static mute state. A static mute state overrides any dynamic mute rules that apply to this finding. The static mute state can be set by a static mute rule or by muting the finding directly.", "id": "StaticMute", "properties": { "applyTime": { -"description": "When the static mute was applied.", "format": "google-datetime", "type": "string" }, "state": { -"description": "The static mute state. If the value is `MUTED` or `UNMUTED`, then the finding's overall mute state will have the same value.", "enum": [ "MUTE_UNSPECIFIED", "MUTED", @@ -11898,10 +10247,10 @@ false "UNDEFINED" ], "enumDescriptions": [ -"Unspecified.", -"Finding has been muted.", -"Finding has been unmuted.", -"Finding has never been muted/unmuted." +"", +"", +"", +"" ], "type": "string" } @@ -11909,16 +10258,13 @@ false "type": "object" }, "Status": { -"description": "The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).", "id": "Status", "properties": { "code": { -"description": "The status code, which should be an enum value of google.rpc.Code.", "format": "int32", "type": "integer" }, "details": { -"description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.", "items": { "additionalProperties": { "description": "Properties of the object. Contains field @type with type URL.", @@ -11929,18 +10275,15 @@ false "type": "array" }, "message": { -"description": "A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.", "type": "string" } }, "type": "object" }, "Subject": { -"description": "Represents a Kubernetes subject.", "id": "Subject", "properties": { "kind": { -"description": "Authentication type for the subject.", "enum": [ "AUTH_TYPE_UNSPECIFIED", "USER", @@ -11948,30 +10291,26 @@ false "GROUP" ], "enumDescriptions": [ -"Authentication is not specified.", -"User with valid certificate.", -"Users managed by Kubernetes API with credentials stored as secrets.", -"Collection of users." +"", +"", +"", +"" ], "type": "string" }, "name": { -"description": "Name for the subject.", "type": "string" }, "ns": { -"description": "Namespace for the subject.", "type": "string" } }, "type": "object" }, "TestIamPermissionsRequest": { -"description": "Request message for `TestIamPermissions` method.", "id": "TestIamPermissionsRequest", "properties": { "permissions": { -"description": "The set of permissions to check for the `resource`. Permissions with wildcards (such as `*` or `storage.*`) are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).", "items": { "type": "string" }, @@ -11981,11 +10320,9 @@ false "type": "object" }, "TestIamPermissionsResponse": { -"description": "Response message for `TestIamPermissions` method.", "id": "TestIamPermissionsResponse", "properties": { "permissions": { -"description": "A subset of `TestPermissionsRequest.permissions` that the caller is allowed.", "items": { "type": "string" }, @@ -11995,48 +10332,38 @@ false "type": "object" }, "TicketInfo": { -"description": "Information about the ticket, if any, that is being used to track the resolution of the issue that is identified by this finding.", "id": "TicketInfo", "properties": { "assignee": { -"description": "The assignee of the ticket in the ticket system.", "type": "string" }, "description": { -"description": "The description of the ticket in the ticket system.", "type": "string" }, "id": { -"description": "The identifier of the ticket in the ticket system.", "type": "string" }, "status": { -"description": "The latest status of the ticket, as reported by the ticket system.", "type": "string" }, "updateTime": { -"description": "The time when the ticket was last updated, as reported by the ticket system.", "format": "google-datetime", "type": "string" }, "uri": { -"description": "The link to the ticket in the ticket system.", "type": "string" } }, "type": "object" }, "ToxicCombination": { -"description": "Contains details about a group of security issues that, when the issues occur together, represent a greater risk than when the issues occur independently. A group of such issues is referred to as a toxic combination.", "id": "ToxicCombination", "properties": { "attackExposureScore": { -"description": "The [Attack exposure score](https://cloud.google.com/security-command-center/docs/attack-exposure-learn#attack_exposure_scores) of this toxic combination. The score is a measure of how much this toxic combination exposes one or more high-value resources to potential attack.", "format": "double", "type": "number" }, "relatedFindings": { -"description": "List of resource names of findings associated with this toxic combination. For example, `organizations/123/sources/456/findings/789`.", "items": { "type": "string" }, @@ -12046,18 +10373,15 @@ false "type": "object" }, "VertexAi": { -"description": "Vertex AI-related information associated with the finding.", "id": "VertexAi", "properties": { "datasets": { -"description": "Datasets associated with the finding.", "items": { "$ref": "Dataset" }, "type": "array" }, "pipelines": { -"description": "Pipelines associated with the finding.", "items": { "$ref": "Pipeline" }, @@ -12067,46 +10391,37 @@ false "type": "object" }, "Vulnerability": { -"description": "Refers to common vulnerability fields e.g. cve, cvss, cwe etc.", "id": "Vulnerability", "properties": { "cve": { -"$ref": "Cve", -"description": "CVE stands for Common Vulnerabilities and Exposures (https://cve.mitre.org/about/)" +"$ref": "Cve" }, "cwes": { -"description": "Represents one or more Common Weakness Enumeration (CWE) information on this vulnerability.", "items": { "$ref": "Cwe" }, "type": "array" }, "fixedPackage": { -"$ref": "Package", -"description": "The fixed package is relevant to the finding." +"$ref": "Package" }, "offendingPackage": { -"$ref": "Package", -"description": "The offending package is relevant to the finding." +"$ref": "Package" }, "providerRiskScore": { -"description": "Provider provided risk_score based on multiple factors. The higher the risk score, the more risky the vulnerability is.", "format": "int64", "type": "string" }, "reachable": { -"description": "Represents whether the vulnerability is reachable (detected via static analysis)", "type": "boolean" }, "securityBulletin": { -"$ref": "SecurityBulletin", -"description": "The security bulletin is relevant to this finding." +"$ref": "SecurityBulletin" } }, "type": "object" }, "VulnerabilityCountBySeverity": { -"description": "Vulnerability count by severity.", "id": "VulnerabilityCountBySeverity", "properties": { "severityToFindingCount": { @@ -12114,18 +10429,15 @@ false "format": "int64", "type": "string" }, -"description": "Key is the Severity enum.", "type": "object" } }, "type": "object" }, "VulnerabilitySnapshot": { -"description": "Result containing the properties and count of a VulnerabilitySnapshot request.", "id": "VulnerabilitySnapshot", "properties": { "cloudProvider": { -"description": "The cloud provider for the vulnerability snapshot.", "enum": [ "CLOUD_PROVIDER_UNSPECIFIED", "GOOGLE_CLOUD_PLATFORM", @@ -12133,23 +10445,20 @@ false "MICROSOFT_AZURE" ], "enumDescriptions": [ -"The cloud provider is unspecified.", -"The cloud provider is Google Cloud.", -"The cloud provider is Amazon Web Services.", -"The cloud provider is Microsoft Azure." +"", +"", +"", +"" ], "type": "string" }, "findingCount": { -"$ref": "VulnerabilityCountBySeverity", -"description": "The vulnerability count by severity." +"$ref": "VulnerabilityCountBySeverity" }, "name": { -"description": "Identifier. The vulnerability snapshot name. Format: //locations//vulnerabilitySnapshots/", "type": "string" }, "snapshotTime": { -"description": "The time that the snapshot was taken.", "format": "google-datetime", "type": "string" } @@ -12157,11 +10466,9 @@ false "type": "object" }, "YaraRuleSignature": { -"description": "A signature corresponding to a YARA rule.", "id": "YaraRuleSignature", "properties": { "yaraRule": { -"description": "The name of the YARA rule.", "type": "string" } }, diff --git a/googleapiclient/discovery_cache/documents/securitycenter.v1beta2.json b/googleapiclient/discovery_cache/documents/securitycenter.v1beta2.json index b9070b9054..875499f8ca 100644 --- a/googleapiclient/discovery_cache/documents/securitycenter.v1beta2.json +++ b/googleapiclient/discovery_cache/documents/securitycenter.v1beta2.json @@ -125,7 +125,7 @@ "folders": { "methods": { "getContainerThreatDetectionSettings": { -"description": "Get the ContainerThreatDetectionSettings resource. In the returned settings response, a missing field only indicates that it was not explicitly set, so no assumption should be made about these fields. In other words, GetContainerThreatDetectionSettings does not calculate the effective service settings for the resource, which accounts for inherited settings and defaults. Instead, use CalculateContainerThreatDetectionSettings for this purpose.", +"description": "", "flatPath": "v1beta2/folders/{foldersId}/containerThreatDetectionSettings", "httpMethod": "GET", "id": "securitycenter.folders.getContainerThreatDetectionSettings", @@ -134,7 +134,6 @@ ], "parameters": { "name": { -"description": "Required. The name of the ContainerThreatDetectionSettings to retrieve. Formats: * organizations/{organization}/containerThreatDetectionSettings * folders/{folder}/containerThreatDetectionSettings * projects/{project}/containerThreatDetectionSettings * projects/{project}/locations/{location}/clusters/{cluster}/containerThreatDetectionSettings", "location": "path", "pattern": "^folders/[^/]+/containerThreatDetectionSettings$", "required": true, @@ -150,7 +149,7 @@ ] }, "getEventThreatDetectionSettings": { -"description": "Get the EventThreatDetectionSettings resource. In the returned settings response, a missing field only indicates that it was not explicitly set, so no assumption should be made about these fields. In other words, GetEventThreatDetectionSettings does not calculate the effective service settings for the resource, which accounts for inherited settings and defaults. Instead, use CalculateEventThreatDetectionSettings for this purpose.", +"description": "", "flatPath": "v1beta2/folders/{foldersId}/eventThreatDetectionSettings", "httpMethod": "GET", "id": "securitycenter.folders.getEventThreatDetectionSettings", @@ -159,7 +158,6 @@ ], "parameters": { "name": { -"description": "Required. The name of the EventThreatDetectionSettings to retrieve. Formats: * organizations/{organization}/eventThreatDetectionSettings * folders/{folder}/eventThreatDetectionSettings * projects/{project}/eventThreatDetectionSettings", "location": "path", "pattern": "^folders/[^/]+/eventThreatDetectionSettings$", "required": true, @@ -175,7 +173,7 @@ ] }, "getRapidVulnerabilityDetectionSettings": { -"description": "Get the RapidVulnerabilityDetectionSettings resource. In the returned settings response, a missing field only indicates that it was not explicitly set, so no assumption should be made about these fields. In other words, GetRapidVulnerabilityDetectionSettings does not calculate the effective service settings for the resource, which accounts for inherited settings and defaults. Instead, use CalculateRapidVulnerabilityDetectionSettings for this purpose.", +"description": "", "flatPath": "v1beta2/folders/{foldersId}/rapidVulnerabilityDetectionSettings", "httpMethod": "GET", "id": "securitycenter.folders.getRapidVulnerabilityDetectionSettings", @@ -184,7 +182,6 @@ ], "parameters": { "name": { -"description": "Required. The name of the RapidVulnerabilityDetectionSettings to retrieve. Formats: * organizations/{organization}/rapidVulnerabilityDetectionSettings * folders/{folder}/rapidVulnerabilityDetectionSettings * projects/{project}/rapidVulnerabilityDetectionSettings", "location": "path", "pattern": "^folders/[^/]+/rapidVulnerabilityDetectionSettings$", "required": true, @@ -200,7 +197,7 @@ ] }, "getSecurityCenterSettings": { -"description": "Get the SecurityCenterSettings resource.", +"description": "", "flatPath": "v1beta2/folders/{foldersId}/securityCenterSettings", "httpMethod": "GET", "id": "securitycenter.folders.getSecurityCenterSettings", @@ -209,7 +206,6 @@ ], "parameters": { "name": { -"description": "Required. The name of the SecurityCenterSettings to retrieve. Format: organizations/{organization}/securityCenterSettings Format: folders/{folder}/securityCenterSettings Format: projects/{project}/securityCenterSettings", "location": "path", "pattern": "^folders/[^/]+/securityCenterSettings$", "required": true, @@ -225,7 +221,7 @@ ] }, "getSecurityHealthAnalyticsSettings": { -"description": "Get the SecurityHealthAnalyticsSettings resource. In the returned settings response, a missing field only indicates that it was not explicitly set, so no assumption should be made about these fields. In other words, GetSecurityHealthAnalyticsSettings does not calculate the effective service settings for the resource, which accounts for inherited settings and defaults. Instead, use CalculateSecurityHealthAnalyticsSettings for this purpose.", +"description": "", "flatPath": "v1beta2/folders/{foldersId}/securityHealthAnalyticsSettings", "httpMethod": "GET", "id": "securitycenter.folders.getSecurityHealthAnalyticsSettings", @@ -234,7 +230,6 @@ ], "parameters": { "name": { -"description": "Required. The name of the SecurityHealthAnalyticsSettings to retrieve. Formats: * organizations/{organization}/securityHealthAnalyticsSettings * folders/{folder}/securityHealthAnalyticsSettings * projects/{project}/securityHealthAnalyticsSettings", "location": "path", "pattern": "^folders/[^/]+/securityHealthAnalyticsSettings$", "required": true, @@ -250,7 +245,7 @@ ] }, "getVirtualMachineThreatDetectionSettings": { -"description": "Get the VirtualMachineThreatDetectionSettings resource. In the returned settings response, a missing field only indicates that it was not explicitly set, so no assumption should be made about these fields. In other words, GetVirtualMachineThreatDetectionSettings does not calculate the effective service settings for the resource, which accounts for inherited settings and defaults. Instead, use CalculateVirtualMachineThreatDetectionSettings for this purpose.", +"description": "", "flatPath": "v1beta2/folders/{foldersId}/virtualMachineThreatDetectionSettings", "httpMethod": "GET", "id": "securitycenter.folders.getVirtualMachineThreatDetectionSettings", @@ -259,7 +254,6 @@ ], "parameters": { "name": { -"description": "Required. The name of the VirtualMachineThreatDetectionSettings to retrieve. Formats: * organizations/{organization}/virtualMachineThreatDetectionSettings * folders/{folder}/virtualMachineThreatDetectionSettings * projects/{project}/virtualMachineThreatDetectionSettings", "location": "path", "pattern": "^folders/[^/]+/virtualMachineThreatDetectionSettings$", "required": true, @@ -275,7 +269,7 @@ ] }, "getWebSecurityScannerSettings": { -"description": "Get the WebSecurityScannerSettings resource. In the returned settings response, a missing field only indicates that it was not explicitly set, so no assumption should be made about these fields. In other words, GetWebSecurityScannerSettings does not calculate the effective service settings for the resource, which accounts for inherited settings and defaults. Instead, use CalculateWebSecurityScannerSettings for this purpose.", +"description": "", "flatPath": "v1beta2/folders/{foldersId}/webSecurityScannerSettings", "httpMethod": "GET", "id": "securitycenter.folders.getWebSecurityScannerSettings", @@ -284,7 +278,6 @@ ], "parameters": { "name": { -"description": "Required. The name of the WebSecurityScannerSettings to retrieve. Formats: * organizations/{organization}/webSecurityScannerSettings * folders/{folder}/webSecurityScannerSettings * projects/{project}/webSecurityScannerSettings", "location": "path", "pattern": "^folders/[^/]+/webSecurityScannerSettings$", "required": true, @@ -300,7 +293,7 @@ ] }, "updateContainerThreatDetectionSettings": { -"description": "Update the ContainerThreatDetectionSettings resource.", +"description": "", "flatPath": "v1beta2/folders/{foldersId}/containerThreatDetectionSettings", "httpMethod": "PATCH", "id": "securitycenter.folders.updateContainerThreatDetectionSettings", @@ -309,14 +302,12 @@ ], "parameters": { "name": { -"description": "Identifier. The resource name of the ContainerThreatDetectionSettings. Formats: * organizations/{organization}/containerThreatDetectionSettings * folders/{folder}/containerThreatDetectionSettings * projects/{project}/containerThreatDetectionSettings * projects/{project}/locations/{location}/clusters/{cluster}/containerThreatDetectionSettings", "location": "path", "pattern": "^folders/[^/]+/containerThreatDetectionSettings$", "required": true, "type": "string" }, "updateMask": { -"description": "The list of fields to be updated.", "format": "google-fieldmask", "location": "query", "type": "string" @@ -334,7 +325,7 @@ ] }, "updateEventThreatDetectionSettings": { -"description": "Update the EventThreatDetectionSettings resource.", +"description": "", "flatPath": "v1beta2/folders/{foldersId}/eventThreatDetectionSettings", "httpMethod": "PATCH", "id": "securitycenter.folders.updateEventThreatDetectionSettings", @@ -343,14 +334,12 @@ ], "parameters": { "name": { -"description": "Identifier. The resource name of the EventThreatDetectionSettings. Formats: * organizations/{organization}/eventThreatDetectionSettings * folders/{folder}/eventThreatDetectionSettings * projects/{project}/eventThreatDetectionSettings", "location": "path", "pattern": "^folders/[^/]+/eventThreatDetectionSettings$", "required": true, "type": "string" }, "updateMask": { -"description": "The list of fields to be updated.", "format": "google-fieldmask", "location": "query", "type": "string" @@ -368,7 +357,7 @@ ] }, "updateRapidVulnerabilityDetectionSettings": { -"description": "Update the RapidVulnerabilityDetectionSettings resource.", +"description": "", "flatPath": "v1beta2/folders/{foldersId}/rapidVulnerabilityDetectionSettings", "httpMethod": "PATCH", "id": "securitycenter.folders.updateRapidVulnerabilityDetectionSettings", @@ -377,14 +366,12 @@ ], "parameters": { "name": { -"description": "The resource name of the RapidVulnerabilityDetectionSettings. Formats: * organizations/{organization}/rapidVulnerabilityDetectionSettings * folders/{folder}/rapidVulnerabilityDetectionSettings * projects/{project}/rapidVulnerabilityDetectionSettings", "location": "path", "pattern": "^folders/[^/]+/rapidVulnerabilityDetectionSettings$", "required": true, "type": "string" }, "updateMask": { -"description": "The list of fields to be updated.", "format": "google-fieldmask", "location": "query", "type": "string" @@ -402,7 +389,7 @@ ] }, "updateSecurityHealthAnalyticsSettings": { -"description": "Update the SecurityHealthAnalyticsSettings resource.", +"description": "", "flatPath": "v1beta2/folders/{foldersId}/securityHealthAnalyticsSettings", "httpMethod": "PATCH", "id": "securitycenter.folders.updateSecurityHealthAnalyticsSettings", @@ -411,14 +398,12 @@ ], "parameters": { "name": { -"description": "Identifier. The resource name of the SecurityHealthAnalyticsSettings. Formats: * organizations/{organization}/securityHealthAnalyticsSettings * folders/{folder}/securityHealthAnalyticsSettings * projects/{project}/securityHealthAnalyticsSettings", "location": "path", "pattern": "^folders/[^/]+/securityHealthAnalyticsSettings$", "required": true, "type": "string" }, "updateMask": { -"description": "The list of fields to be updated.", "format": "google-fieldmask", "location": "query", "type": "string" @@ -436,7 +421,7 @@ ] }, "updateVirtualMachineThreatDetectionSettings": { -"description": "Update the VirtualMachineThreatDetectionSettings resource.", +"description": "", "flatPath": "v1beta2/folders/{foldersId}/virtualMachineThreatDetectionSettings", "httpMethod": "PATCH", "id": "securitycenter.folders.updateVirtualMachineThreatDetectionSettings", @@ -445,14 +430,12 @@ ], "parameters": { "name": { -"description": "Identifier. The resource name of the VirtualMachineThreatDetectionSettings. Formats: * organizations/{organization}/virtualMachineThreatDetectionSettings * folders/{folder}/virtualMachineThreatDetectionSettings * projects/{project}/virtualMachineThreatDetectionSettings", "location": "path", "pattern": "^folders/[^/]+/virtualMachineThreatDetectionSettings$", "required": true, "type": "string" }, "updateMask": { -"description": "The list of fields to be updated.", "format": "google-fieldmask", "location": "query", "type": "string" @@ -470,7 +453,7 @@ ] }, "updateWebSecurityScannerSettings": { -"description": "Update the WebSecurityScannerSettings resource.", +"description": "", "flatPath": "v1beta2/folders/{foldersId}/webSecurityScannerSettings", "httpMethod": "PATCH", "id": "securitycenter.folders.updateWebSecurityScannerSettings", @@ -479,14 +462,12 @@ ], "parameters": { "name": { -"description": "Identifier. The resource name of the WebSecurityScannerSettings. Formats: * organizations/{organization}/webSecurityScannerSettings * folders/{folder}/webSecurityScannerSettings * projects/{project}/webSecurityScannerSettings", "location": "path", "pattern": "^folders/[^/]+/webSecurityScannerSettings$", "required": true, "type": "string" }, "updateMask": { -"description": "The list of fields to be updated.", "format": "google-fieldmask", "location": "query", "type": "string" @@ -508,7 +489,7 @@ "containerThreatDetectionSettings": { "methods": { "calculate": { -"description": "Calculates the effective ContainerThreatDetectionSettings based on its level in the resource hierarchy and its settings. Settings provided closer to the target resource take precedence over those further away (e.g. folder will override organization level settings). The default SCC setting for the detector service defaults can be overridden at organization, folder and project levels. No assumptions should be made about the SCC defaults as it is considered an internal implementation detail.", +"description": "", "flatPath": "v1beta2/folders/{foldersId}/containerThreatDetectionSettings:calculate", "httpMethod": "GET", "id": "securitycenter.folders.containerThreatDetectionSettings.calculate", @@ -517,14 +498,12 @@ ], "parameters": { "name": { -"description": "Required. The name of the ContainerThreatDetectionSettings to calculate. Formats: * organizations/{organization}/containerThreatDetectionSettings * folders/{folder}/containerThreatDetectionSettings * projects/{project}/containerThreatDetectionSettings * projects/{project}/locations/{location}/clusters/{cluster}/containerThreatDetectionSettings", "location": "path", "pattern": "^folders/[^/]+/containerThreatDetectionSettings$", "required": true, "type": "string" }, "showEligibleModulesOnly": { -"description": "Optional. When set, will only retrieve the modules that are in scope. By default, all modules will be shown.", "location": "query", "type": "boolean" } @@ -542,7 +521,7 @@ "eventThreatDetectionSettings": { "methods": { "calculate": { -"description": "Calculates the effective EventThreatDetectionSettings based on its level in the resource hierarchy and its settings. Settings provided closer to the target resource take precedence over those further away (e.g. folder will override organization level settings). The default SCC setting for the detector service defaults can be overridden at organization, folder and project levels. No assumptions should be made about the SCC defaults as it is considered an internal implementation detail.", +"description": "", "flatPath": "v1beta2/folders/{foldersId}/eventThreatDetectionSettings:calculate", "httpMethod": "GET", "id": "securitycenter.folders.eventThreatDetectionSettings.calculate", @@ -551,14 +530,12 @@ ], "parameters": { "name": { -"description": "Required. The name of the EventThreatDetectionSettings to calculate. Formats: * organizations/{organization}/eventThreatDetectionSettings * folders/{folder}/eventThreatDetectionSettings * projects/{project}/eventThreatDetectionSettings", "location": "path", "pattern": "^folders/[^/]+/eventThreatDetectionSettings$", "required": true, "type": "string" }, "showEligibleModulesOnly": { -"description": "Optional. When set, will only retrieve the modules that are in scope. By default, all modules will be shown.", "location": "query", "type": "boolean" } @@ -576,7 +553,7 @@ "rapidVulnerabilityDetectionSettings": { "methods": { "calculate": { -"description": "Calculates the effective RapidVulnerabilityDetectionSettings based on its level in the resource hierarchy and its settings. Settings provided closer to the target resource take precedence over those further away (e.g. folder will override organization level settings). The default SCC setting for the detector service defaults can be overridden at organization, folder and project levels. No assumptions should be made about the SCC defaults as it is considered an internal implementation detail.", +"description": "", "flatPath": "v1beta2/folders/{foldersId}/rapidVulnerabilityDetectionSettings:calculate", "httpMethod": "GET", "id": "securitycenter.folders.rapidVulnerabilityDetectionSettings.calculate", @@ -585,7 +562,6 @@ ], "parameters": { "name": { -"description": "Required. The name of the RapidVulnerabilityDetectionSettings to calculate. Formats: * organizations/{organization}/rapidVulnerabilityDetectionSettings * folders/{folder}/rapidVulnerabilityDetectionSettings * projects/{project}/rapidVulnerabilityDetectionSettings", "location": "path", "pattern": "^folders/[^/]+/rapidVulnerabilityDetectionSettings$", "required": true, @@ -605,7 +581,7 @@ "securityHealthAnalyticsSettings": { "methods": { "calculate": { -"description": "Calculates the effective SecurityHealthAnalyticsSettings based on its level in the resource hierarchy and its settings. Settings provided closer to the target resource take precedence over those further away (e.g. folder will override organization level settings). The default SCC setting for the detector service defaults can be overridden at organization, folder and project levels. No assumptions should be made about the SCC defaults as it is considered an internal implementation detail.", +"description": "", "flatPath": "v1beta2/folders/{foldersId}/securityHealthAnalyticsSettings:calculate", "httpMethod": "GET", "id": "securitycenter.folders.securityHealthAnalyticsSettings.calculate", @@ -614,14 +590,12 @@ ], "parameters": { "name": { -"description": "Required. The name of the SecurityHealthAnalyticsSettings to calculate. Formats: * organizations/{organization}/securityHealthAnalyticsSettings * folders/{folder}/securityHealthAnalyticsSettings * projects/{project}/securityHealthAnalyticsSettings", "location": "path", "pattern": "^folders/[^/]+/securityHealthAnalyticsSettings$", "required": true, "type": "string" }, "showEligibleModulesOnly": { -"description": "Optional. When set, will only retrieve the modules that are in scope. By default, all modules will be shown.", "location": "query", "type": "boolean" } @@ -639,7 +613,7 @@ "virtualMachineThreatDetectionSettings": { "methods": { "calculate": { -"description": "Calculates the effective VirtualMachineThreatDetectionSettings based on its level in the resource hierarchy and its settings. Settings provided closer to the target resource take precedence over those further away (e.g. folder will override organization level settings). The default SCC setting for the detector service defaults can be overridden at organization, folder and project levels. No assumptions should be made about the SCC defaults as it is considered an internal implementation detail.", +"description": "", "flatPath": "v1beta2/folders/{foldersId}/virtualMachineThreatDetectionSettings:calculate", "httpMethod": "GET", "id": "securitycenter.folders.virtualMachineThreatDetectionSettings.calculate", @@ -648,14 +622,12 @@ ], "parameters": { "name": { -"description": "Required. The name of the VirtualMachineThreatDetectionSettings to calculate. Formats: * organizations/{organization}/virtualMachineThreatDetectionSettings * folders/{folder}/virtualMachineThreatDetectionSettings * projects/{project}/virtualMachineThreatDetectionSettings", "location": "path", "pattern": "^folders/[^/]+/virtualMachineThreatDetectionSettings$", "required": true, "type": "string" }, "showEligibleModulesOnly": { -"description": "Optional. When set, will only retrieve the modules that are in scope. By default, all modules will be shown.", "location": "query", "type": "boolean" } @@ -673,7 +645,7 @@ "webSecurityScannerSettings": { "methods": { "calculate": { -"description": "Calculates the effective WebSecurityScannerSettings based on its level in the resource hierarchy and its settings. Settings provided closer to the target resource take precedence over those further away (e.g. folder will override organization level settings). The default SCC setting for the detector service defaults can be overridden at organization, folder and project levels. No assumptions should be made about the SCC defaults as it is considered an internal implementation detail.", +"description": "", "flatPath": "v1beta2/folders/{foldersId}/webSecurityScannerSettings:calculate", "httpMethod": "GET", "id": "securitycenter.folders.webSecurityScannerSettings.calculate", @@ -682,14 +654,12 @@ ], "parameters": { "name": { -"description": "Required. The name of the WebSecurityScannerSettings to calculate. Formats: * organizations/{organization}/webSecurityScannerSettings * folders/{folder}/webSecurityScannerSettings * projects/{project}/webSecurityScannerSettings", "location": "path", "pattern": "^folders/[^/]+/webSecurityScannerSettings$", "required": true, "type": "string" }, "showEligibleModulesOnly": { -"description": "Optional. When set, will only retrieve the modules that are in scope. By default, all modules will be shown.", "location": "query", "type": "boolean" } @@ -709,7 +679,7 @@ "organizations": { "methods": { "getContainerThreatDetectionSettings": { -"description": "Get the ContainerThreatDetectionSettings resource. In the returned settings response, a missing field only indicates that it was not explicitly set, so no assumption should be made about these fields. In other words, GetContainerThreatDetectionSettings does not calculate the effective service settings for the resource, which accounts for inherited settings and defaults. Instead, use CalculateContainerThreatDetectionSettings for this purpose.", +"description": "", "flatPath": "v1beta2/organizations/{organizationsId}/containerThreatDetectionSettings", "httpMethod": "GET", "id": "securitycenter.organizations.getContainerThreatDetectionSettings", @@ -718,7 +688,6 @@ ], "parameters": { "name": { -"description": "Required. The name of the ContainerThreatDetectionSettings to retrieve. Formats: * organizations/{organization}/containerThreatDetectionSettings * folders/{folder}/containerThreatDetectionSettings * projects/{project}/containerThreatDetectionSettings * projects/{project}/locations/{location}/clusters/{cluster}/containerThreatDetectionSettings", "location": "path", "pattern": "^organizations/[^/]+/containerThreatDetectionSettings$", "required": true, @@ -734,7 +703,7 @@ ] }, "getEventThreatDetectionSettings": { -"description": "Get the EventThreatDetectionSettings resource. In the returned settings response, a missing field only indicates that it was not explicitly set, so no assumption should be made about these fields. In other words, GetEventThreatDetectionSettings does not calculate the effective service settings for the resource, which accounts for inherited settings and defaults. Instead, use CalculateEventThreatDetectionSettings for this purpose.", +"description": "", "flatPath": "v1beta2/organizations/{organizationsId}/eventThreatDetectionSettings", "httpMethod": "GET", "id": "securitycenter.organizations.getEventThreatDetectionSettings", @@ -743,7 +712,6 @@ ], "parameters": { "name": { -"description": "Required. The name of the EventThreatDetectionSettings to retrieve. Formats: * organizations/{organization}/eventThreatDetectionSettings * folders/{folder}/eventThreatDetectionSettings * projects/{project}/eventThreatDetectionSettings", "location": "path", "pattern": "^organizations/[^/]+/eventThreatDetectionSettings$", "required": true, @@ -759,7 +727,7 @@ ] }, "getRapidVulnerabilityDetectionSettings": { -"description": "Get the RapidVulnerabilityDetectionSettings resource. In the returned settings response, a missing field only indicates that it was not explicitly set, so no assumption should be made about these fields. In other words, GetRapidVulnerabilityDetectionSettings does not calculate the effective service settings for the resource, which accounts for inherited settings and defaults. Instead, use CalculateRapidVulnerabilityDetectionSettings for this purpose.", +"description": "", "flatPath": "v1beta2/organizations/{organizationsId}/rapidVulnerabilityDetectionSettings", "httpMethod": "GET", "id": "securitycenter.organizations.getRapidVulnerabilityDetectionSettings", @@ -768,7 +736,6 @@ ], "parameters": { "name": { -"description": "Required. The name of the RapidVulnerabilityDetectionSettings to retrieve. Formats: * organizations/{organization}/rapidVulnerabilityDetectionSettings * folders/{folder}/rapidVulnerabilityDetectionSettings * projects/{project}/rapidVulnerabilityDetectionSettings", "location": "path", "pattern": "^organizations/[^/]+/rapidVulnerabilityDetectionSettings$", "required": true, @@ -784,7 +751,7 @@ ] }, "getSecurityCenterSettings": { -"description": "Get the SecurityCenterSettings resource.", +"description": "", "flatPath": "v1beta2/organizations/{organizationsId}/securityCenterSettings", "httpMethod": "GET", "id": "securitycenter.organizations.getSecurityCenterSettings", @@ -793,7 +760,6 @@ ], "parameters": { "name": { -"description": "Required. The name of the SecurityCenterSettings to retrieve. Format: organizations/{organization}/securityCenterSettings Format: folders/{folder}/securityCenterSettings Format: projects/{project}/securityCenterSettings", "location": "path", "pattern": "^organizations/[^/]+/securityCenterSettings$", "required": true, @@ -809,7 +775,7 @@ ] }, "getSecurityHealthAnalyticsSettings": { -"description": "Get the SecurityHealthAnalyticsSettings resource. In the returned settings response, a missing field only indicates that it was not explicitly set, so no assumption should be made about these fields. In other words, GetSecurityHealthAnalyticsSettings does not calculate the effective service settings for the resource, which accounts for inherited settings and defaults. Instead, use CalculateSecurityHealthAnalyticsSettings for this purpose.", +"description": "", "flatPath": "v1beta2/organizations/{organizationsId}/securityHealthAnalyticsSettings", "httpMethod": "GET", "id": "securitycenter.organizations.getSecurityHealthAnalyticsSettings", @@ -818,7 +784,6 @@ ], "parameters": { "name": { -"description": "Required. The name of the SecurityHealthAnalyticsSettings to retrieve. Formats: * organizations/{organization}/securityHealthAnalyticsSettings * folders/{folder}/securityHealthAnalyticsSettings * projects/{project}/securityHealthAnalyticsSettings", "location": "path", "pattern": "^organizations/[^/]+/securityHealthAnalyticsSettings$", "required": true, @@ -834,7 +799,7 @@ ] }, "getSubscription": { -"description": "Get the Subscription resource.", +"description": "", "flatPath": "v1beta2/organizations/{organizationsId}/subscription", "httpMethod": "GET", "id": "securitycenter.organizations.getSubscription", @@ -843,7 +808,6 @@ ], "parameters": { "name": { -"description": "Required. The name of the subscription to retrieve. Format: organizations/{organization}/subscription", "location": "path", "pattern": "^organizations/[^/]+/subscription$", "required": true, @@ -859,7 +823,7 @@ ] }, "getVirtualMachineThreatDetectionSettings": { -"description": "Get the VirtualMachineThreatDetectionSettings resource. In the returned settings response, a missing field only indicates that it was not explicitly set, so no assumption should be made about these fields. In other words, GetVirtualMachineThreatDetectionSettings does not calculate the effective service settings for the resource, which accounts for inherited settings and defaults. Instead, use CalculateVirtualMachineThreatDetectionSettings for this purpose.", +"description": "", "flatPath": "v1beta2/organizations/{organizationsId}/virtualMachineThreatDetectionSettings", "httpMethod": "GET", "id": "securitycenter.organizations.getVirtualMachineThreatDetectionSettings", @@ -868,7 +832,6 @@ ], "parameters": { "name": { -"description": "Required. The name of the VirtualMachineThreatDetectionSettings to retrieve. Formats: * organizations/{organization}/virtualMachineThreatDetectionSettings * folders/{folder}/virtualMachineThreatDetectionSettings * projects/{project}/virtualMachineThreatDetectionSettings", "location": "path", "pattern": "^organizations/[^/]+/virtualMachineThreatDetectionSettings$", "required": true, @@ -884,7 +847,7 @@ ] }, "getWebSecurityScannerSettings": { -"description": "Get the WebSecurityScannerSettings resource. In the returned settings response, a missing field only indicates that it was not explicitly set, so no assumption should be made about these fields. In other words, GetWebSecurityScannerSettings does not calculate the effective service settings for the resource, which accounts for inherited settings and defaults. Instead, use CalculateWebSecurityScannerSettings for this purpose.", +"description": "", "flatPath": "v1beta2/organizations/{organizationsId}/webSecurityScannerSettings", "httpMethod": "GET", "id": "securitycenter.organizations.getWebSecurityScannerSettings", @@ -893,7 +856,6 @@ ], "parameters": { "name": { -"description": "Required. The name of the WebSecurityScannerSettings to retrieve. Formats: * organizations/{organization}/webSecurityScannerSettings * folders/{folder}/webSecurityScannerSettings * projects/{project}/webSecurityScannerSettings", "location": "path", "pattern": "^organizations/[^/]+/webSecurityScannerSettings$", "required": true, @@ -909,7 +871,7 @@ ] }, "updateContainerThreatDetectionSettings": { -"description": "Update the ContainerThreatDetectionSettings resource.", +"description": "", "flatPath": "v1beta2/organizations/{organizationsId}/containerThreatDetectionSettings", "httpMethod": "PATCH", "id": "securitycenter.organizations.updateContainerThreatDetectionSettings", @@ -918,14 +880,12 @@ ], "parameters": { "name": { -"description": "Identifier. The resource name of the ContainerThreatDetectionSettings. Formats: * organizations/{organization}/containerThreatDetectionSettings * folders/{folder}/containerThreatDetectionSettings * projects/{project}/containerThreatDetectionSettings * projects/{project}/locations/{location}/clusters/{cluster}/containerThreatDetectionSettings", "location": "path", "pattern": "^organizations/[^/]+/containerThreatDetectionSettings$", "required": true, "type": "string" }, "updateMask": { -"description": "The list of fields to be updated.", "format": "google-fieldmask", "location": "query", "type": "string" @@ -943,7 +903,7 @@ ] }, "updateEventThreatDetectionSettings": { -"description": "Update the EventThreatDetectionSettings resource.", +"description": "", "flatPath": "v1beta2/organizations/{organizationsId}/eventThreatDetectionSettings", "httpMethod": "PATCH", "id": "securitycenter.organizations.updateEventThreatDetectionSettings", @@ -952,14 +912,12 @@ ], "parameters": { "name": { -"description": "Identifier. The resource name of the EventThreatDetectionSettings. Formats: * organizations/{organization}/eventThreatDetectionSettings * folders/{folder}/eventThreatDetectionSettings * projects/{project}/eventThreatDetectionSettings", "location": "path", "pattern": "^organizations/[^/]+/eventThreatDetectionSettings$", "required": true, "type": "string" }, "updateMask": { -"description": "The list of fields to be updated.", "format": "google-fieldmask", "location": "query", "type": "string" @@ -977,7 +935,7 @@ ] }, "updateRapidVulnerabilityDetectionSettings": { -"description": "Update the RapidVulnerabilityDetectionSettings resource.", +"description": "", "flatPath": "v1beta2/organizations/{organizationsId}/rapidVulnerabilityDetectionSettings", "httpMethod": "PATCH", "id": "securitycenter.organizations.updateRapidVulnerabilityDetectionSettings", @@ -986,14 +944,12 @@ ], "parameters": { "name": { -"description": "The resource name of the RapidVulnerabilityDetectionSettings. Formats: * organizations/{organization}/rapidVulnerabilityDetectionSettings * folders/{folder}/rapidVulnerabilityDetectionSettings * projects/{project}/rapidVulnerabilityDetectionSettings", "location": "path", "pattern": "^organizations/[^/]+/rapidVulnerabilityDetectionSettings$", "required": true, "type": "string" }, "updateMask": { -"description": "The list of fields to be updated.", "format": "google-fieldmask", "location": "query", "type": "string" @@ -1011,7 +967,7 @@ ] }, "updateSecurityHealthAnalyticsSettings": { -"description": "Update the SecurityHealthAnalyticsSettings resource.", +"description": "", "flatPath": "v1beta2/organizations/{organizationsId}/securityHealthAnalyticsSettings", "httpMethod": "PATCH", "id": "securitycenter.organizations.updateSecurityHealthAnalyticsSettings", @@ -1020,14 +976,12 @@ ], "parameters": { "name": { -"description": "Identifier. The resource name of the SecurityHealthAnalyticsSettings. Formats: * organizations/{organization}/securityHealthAnalyticsSettings * folders/{folder}/securityHealthAnalyticsSettings * projects/{project}/securityHealthAnalyticsSettings", "location": "path", "pattern": "^organizations/[^/]+/securityHealthAnalyticsSettings$", "required": true, "type": "string" }, "updateMask": { -"description": "The list of fields to be updated.", "format": "google-fieldmask", "location": "query", "type": "string" @@ -1045,7 +999,7 @@ ] }, "updateVirtualMachineThreatDetectionSettings": { -"description": "Update the VirtualMachineThreatDetectionSettings resource.", +"description": "", "flatPath": "v1beta2/organizations/{organizationsId}/virtualMachineThreatDetectionSettings", "httpMethod": "PATCH", "id": "securitycenter.organizations.updateVirtualMachineThreatDetectionSettings", @@ -1054,14 +1008,12 @@ ], "parameters": { "name": { -"description": "Identifier. The resource name of the VirtualMachineThreatDetectionSettings. Formats: * organizations/{organization}/virtualMachineThreatDetectionSettings * folders/{folder}/virtualMachineThreatDetectionSettings * projects/{project}/virtualMachineThreatDetectionSettings", "location": "path", "pattern": "^organizations/[^/]+/virtualMachineThreatDetectionSettings$", "required": true, "type": "string" }, "updateMask": { -"description": "The list of fields to be updated.", "format": "google-fieldmask", "location": "query", "type": "string" @@ -1079,7 +1031,7 @@ ] }, "updateWebSecurityScannerSettings": { -"description": "Update the WebSecurityScannerSettings resource.", +"description": "", "flatPath": "v1beta2/organizations/{organizationsId}/webSecurityScannerSettings", "httpMethod": "PATCH", "id": "securitycenter.organizations.updateWebSecurityScannerSettings", @@ -1088,14 +1040,12 @@ ], "parameters": { "name": { -"description": "Identifier. The resource name of the WebSecurityScannerSettings. Formats: * organizations/{organization}/webSecurityScannerSettings * folders/{folder}/webSecurityScannerSettings * projects/{project}/webSecurityScannerSettings", "location": "path", "pattern": "^organizations/[^/]+/webSecurityScannerSettings$", "required": true, "type": "string" }, "updateMask": { -"description": "The list of fields to be updated.", "format": "google-fieldmask", "location": "query", "type": "string" @@ -1117,7 +1067,7 @@ "containerThreatDetectionSettings": { "methods": { "calculate": { -"description": "Calculates the effective ContainerThreatDetectionSettings based on its level in the resource hierarchy and its settings. Settings provided closer to the target resource take precedence over those further away (e.g. folder will override organization level settings). The default SCC setting for the detector service defaults can be overridden at organization, folder and project levels. No assumptions should be made about the SCC defaults as it is considered an internal implementation detail.", +"description": "", "flatPath": "v1beta2/organizations/{organizationsId}/containerThreatDetectionSettings:calculate", "httpMethod": "GET", "id": "securitycenter.organizations.containerThreatDetectionSettings.calculate", @@ -1126,14 +1076,12 @@ ], "parameters": { "name": { -"description": "Required. The name of the ContainerThreatDetectionSettings to calculate. Formats: * organizations/{organization}/containerThreatDetectionSettings * folders/{folder}/containerThreatDetectionSettings * projects/{project}/containerThreatDetectionSettings * projects/{project}/locations/{location}/clusters/{cluster}/containerThreatDetectionSettings", "location": "path", "pattern": "^organizations/[^/]+/containerThreatDetectionSettings$", "required": true, "type": "string" }, "showEligibleModulesOnly": { -"description": "Optional. When set, will only retrieve the modules that are in scope. By default, all modules will be shown.", "location": "query", "type": "boolean" } @@ -1151,7 +1099,7 @@ "eventThreatDetectionSettings": { "methods": { "calculate": { -"description": "Calculates the effective EventThreatDetectionSettings based on its level in the resource hierarchy and its settings. Settings provided closer to the target resource take precedence over those further away (e.g. folder will override organization level settings). The default SCC setting for the detector service defaults can be overridden at organization, folder and project levels. No assumptions should be made about the SCC defaults as it is considered an internal implementation detail.", +"description": "", "flatPath": "v1beta2/organizations/{organizationsId}/eventThreatDetectionSettings:calculate", "httpMethod": "GET", "id": "securitycenter.organizations.eventThreatDetectionSettings.calculate", @@ -1160,14 +1108,12 @@ ], "parameters": { "name": { -"description": "Required. The name of the EventThreatDetectionSettings to calculate. Formats: * organizations/{organization}/eventThreatDetectionSettings * folders/{folder}/eventThreatDetectionSettings * projects/{project}/eventThreatDetectionSettings", "location": "path", "pattern": "^organizations/[^/]+/eventThreatDetectionSettings$", "required": true, "type": "string" }, "showEligibleModulesOnly": { -"description": "Optional. When set, will only retrieve the modules that are in scope. By default, all modules will be shown.", "location": "query", "type": "boolean" } @@ -1185,7 +1131,7 @@ "rapidVulnerabilityDetectionSettings": { "methods": { "calculate": { -"description": "Calculates the effective RapidVulnerabilityDetectionSettings based on its level in the resource hierarchy and its settings. Settings provided closer to the target resource take precedence over those further away (e.g. folder will override organization level settings). The default SCC setting for the detector service defaults can be overridden at organization, folder and project levels. No assumptions should be made about the SCC defaults as it is considered an internal implementation detail.", +"description": "", "flatPath": "v1beta2/organizations/{organizationsId}/rapidVulnerabilityDetectionSettings:calculate", "httpMethod": "GET", "id": "securitycenter.organizations.rapidVulnerabilityDetectionSettings.calculate", @@ -1194,7 +1140,6 @@ ], "parameters": { "name": { -"description": "Required. The name of the RapidVulnerabilityDetectionSettings to calculate. Formats: * organizations/{organization}/rapidVulnerabilityDetectionSettings * folders/{folder}/rapidVulnerabilityDetectionSettings * projects/{project}/rapidVulnerabilityDetectionSettings", "location": "path", "pattern": "^organizations/[^/]+/rapidVulnerabilityDetectionSettings$", "required": true, @@ -1214,7 +1159,7 @@ "securityHealthAnalyticsSettings": { "methods": { "calculate": { -"description": "Calculates the effective SecurityHealthAnalyticsSettings based on its level in the resource hierarchy and its settings. Settings provided closer to the target resource take precedence over those further away (e.g. folder will override organization level settings). The default SCC setting for the detector service defaults can be overridden at organization, folder and project levels. No assumptions should be made about the SCC defaults as it is considered an internal implementation detail.", +"description": "", "flatPath": "v1beta2/organizations/{organizationsId}/securityHealthAnalyticsSettings:calculate", "httpMethod": "GET", "id": "securitycenter.organizations.securityHealthAnalyticsSettings.calculate", @@ -1223,14 +1168,12 @@ ], "parameters": { "name": { -"description": "Required. The name of the SecurityHealthAnalyticsSettings to calculate. Formats: * organizations/{organization}/securityHealthAnalyticsSettings * folders/{folder}/securityHealthAnalyticsSettings * projects/{project}/securityHealthAnalyticsSettings", "location": "path", "pattern": "^organizations/[^/]+/securityHealthAnalyticsSettings$", "required": true, "type": "string" }, "showEligibleModulesOnly": { -"description": "Optional. When set, will only retrieve the modules that are in scope. By default, all modules will be shown.", "location": "query", "type": "boolean" } @@ -1248,7 +1191,7 @@ "virtualMachineThreatDetectionSettings": { "methods": { "calculate": { -"description": "Calculates the effective VirtualMachineThreatDetectionSettings based on its level in the resource hierarchy and its settings. Settings provided closer to the target resource take precedence over those further away (e.g. folder will override organization level settings). The default SCC setting for the detector service defaults can be overridden at organization, folder and project levels. No assumptions should be made about the SCC defaults as it is considered an internal implementation detail.", +"description": "", "flatPath": "v1beta2/organizations/{organizationsId}/virtualMachineThreatDetectionSettings:calculate", "httpMethod": "GET", "id": "securitycenter.organizations.virtualMachineThreatDetectionSettings.calculate", @@ -1257,14 +1200,12 @@ ], "parameters": { "name": { -"description": "Required. The name of the VirtualMachineThreatDetectionSettings to calculate. Formats: * organizations/{organization}/virtualMachineThreatDetectionSettings * folders/{folder}/virtualMachineThreatDetectionSettings * projects/{project}/virtualMachineThreatDetectionSettings", "location": "path", "pattern": "^organizations/[^/]+/virtualMachineThreatDetectionSettings$", "required": true, "type": "string" }, "showEligibleModulesOnly": { -"description": "Optional. When set, will only retrieve the modules that are in scope. By default, all modules will be shown.", "location": "query", "type": "boolean" } @@ -1282,7 +1223,7 @@ "webSecurityScannerSettings": { "methods": { "calculate": { -"description": "Calculates the effective WebSecurityScannerSettings based on its level in the resource hierarchy and its settings. Settings provided closer to the target resource take precedence over those further away (e.g. folder will override organization level settings). The default SCC setting for the detector service defaults can be overridden at organization, folder and project levels. No assumptions should be made about the SCC defaults as it is considered an internal implementation detail.", +"description": "", "flatPath": "v1beta2/organizations/{organizationsId}/webSecurityScannerSettings:calculate", "httpMethod": "GET", "id": "securitycenter.organizations.webSecurityScannerSettings.calculate", @@ -1291,14 +1232,12 @@ ], "parameters": { "name": { -"description": "Required. The name of the WebSecurityScannerSettings to calculate. Formats: * organizations/{organization}/webSecurityScannerSettings * folders/{folder}/webSecurityScannerSettings * projects/{project}/webSecurityScannerSettings", "location": "path", "pattern": "^organizations/[^/]+/webSecurityScannerSettings$", "required": true, "type": "string" }, "showEligibleModulesOnly": { -"description": "Optional. When set, will only retrieve the modules that are in scope. By default, all modules will be shown.", "location": "query", "type": "boolean" } @@ -1318,7 +1257,7 @@ "projects": { "methods": { "getContainerThreatDetectionSettings": { -"description": "Get the ContainerThreatDetectionSettings resource. In the returned settings response, a missing field only indicates that it was not explicitly set, so no assumption should be made about these fields. In other words, GetContainerThreatDetectionSettings does not calculate the effective service settings for the resource, which accounts for inherited settings and defaults. Instead, use CalculateContainerThreatDetectionSettings for this purpose.", +"description": "", "flatPath": "v1beta2/projects/{projectsId}/containerThreatDetectionSettings", "httpMethod": "GET", "id": "securitycenter.projects.getContainerThreatDetectionSettings", @@ -1327,7 +1266,6 @@ ], "parameters": { "name": { -"description": "Required. The name of the ContainerThreatDetectionSettings to retrieve. Formats: * organizations/{organization}/containerThreatDetectionSettings * folders/{folder}/containerThreatDetectionSettings * projects/{project}/containerThreatDetectionSettings * projects/{project}/locations/{location}/clusters/{cluster}/containerThreatDetectionSettings", "location": "path", "pattern": "^projects/[^/]+/containerThreatDetectionSettings$", "required": true, @@ -1343,7 +1281,7 @@ ] }, "getEventThreatDetectionSettings": { -"description": "Get the EventThreatDetectionSettings resource. In the returned settings response, a missing field only indicates that it was not explicitly set, so no assumption should be made about these fields. In other words, GetEventThreatDetectionSettings does not calculate the effective service settings for the resource, which accounts for inherited settings and defaults. Instead, use CalculateEventThreatDetectionSettings for this purpose.", +"description": "", "flatPath": "v1beta2/projects/{projectsId}/eventThreatDetectionSettings", "httpMethod": "GET", "id": "securitycenter.projects.getEventThreatDetectionSettings", @@ -1352,7 +1290,6 @@ ], "parameters": { "name": { -"description": "Required. The name of the EventThreatDetectionSettings to retrieve. Formats: * organizations/{organization}/eventThreatDetectionSettings * folders/{folder}/eventThreatDetectionSettings * projects/{project}/eventThreatDetectionSettings", "location": "path", "pattern": "^projects/[^/]+/eventThreatDetectionSettings$", "required": true, @@ -1368,7 +1305,7 @@ ] }, "getRapidVulnerabilityDetectionSettings": { -"description": "Get the RapidVulnerabilityDetectionSettings resource. In the returned settings response, a missing field only indicates that it was not explicitly set, so no assumption should be made about these fields. In other words, GetRapidVulnerabilityDetectionSettings does not calculate the effective service settings for the resource, which accounts for inherited settings and defaults. Instead, use CalculateRapidVulnerabilityDetectionSettings for this purpose.", +"description": "", "flatPath": "v1beta2/projects/{projectsId}/rapidVulnerabilityDetectionSettings", "httpMethod": "GET", "id": "securitycenter.projects.getRapidVulnerabilityDetectionSettings", @@ -1377,7 +1314,6 @@ ], "parameters": { "name": { -"description": "Required. The name of the RapidVulnerabilityDetectionSettings to retrieve. Formats: * organizations/{organization}/rapidVulnerabilityDetectionSettings * folders/{folder}/rapidVulnerabilityDetectionSettings * projects/{project}/rapidVulnerabilityDetectionSettings", "location": "path", "pattern": "^projects/[^/]+/rapidVulnerabilityDetectionSettings$", "required": true, @@ -1393,7 +1329,7 @@ ] }, "getSecurityCenterSettings": { -"description": "Get the SecurityCenterSettings resource.", +"description": "", "flatPath": "v1beta2/projects/{projectsId}/securityCenterSettings", "httpMethod": "GET", "id": "securitycenter.projects.getSecurityCenterSettings", @@ -1402,7 +1338,6 @@ ], "parameters": { "name": { -"description": "Required. The name of the SecurityCenterSettings to retrieve. Format: organizations/{organization}/securityCenterSettings Format: folders/{folder}/securityCenterSettings Format: projects/{project}/securityCenterSettings", "location": "path", "pattern": "^projects/[^/]+/securityCenterSettings$", "required": true, @@ -1418,7 +1353,7 @@ ] }, "getSecurityHealthAnalyticsSettings": { -"description": "Get the SecurityHealthAnalyticsSettings resource. In the returned settings response, a missing field only indicates that it was not explicitly set, so no assumption should be made about these fields. In other words, GetSecurityHealthAnalyticsSettings does not calculate the effective service settings for the resource, which accounts for inherited settings and defaults. Instead, use CalculateSecurityHealthAnalyticsSettings for this purpose.", +"description": "", "flatPath": "v1beta2/projects/{projectsId}/securityHealthAnalyticsSettings", "httpMethod": "GET", "id": "securitycenter.projects.getSecurityHealthAnalyticsSettings", @@ -1427,7 +1362,6 @@ ], "parameters": { "name": { -"description": "Required. The name of the SecurityHealthAnalyticsSettings to retrieve. Formats: * organizations/{organization}/securityHealthAnalyticsSettings * folders/{folder}/securityHealthAnalyticsSettings * projects/{project}/securityHealthAnalyticsSettings", "location": "path", "pattern": "^projects/[^/]+/securityHealthAnalyticsSettings$", "required": true, @@ -1443,7 +1377,7 @@ ] }, "getVirtualMachineThreatDetectionSettings": { -"description": "Get the VirtualMachineThreatDetectionSettings resource. In the returned settings response, a missing field only indicates that it was not explicitly set, so no assumption should be made about these fields. In other words, GetVirtualMachineThreatDetectionSettings does not calculate the effective service settings for the resource, which accounts for inherited settings and defaults. Instead, use CalculateVirtualMachineThreatDetectionSettings for this purpose.", +"description": "", "flatPath": "v1beta2/projects/{projectsId}/virtualMachineThreatDetectionSettings", "httpMethod": "GET", "id": "securitycenter.projects.getVirtualMachineThreatDetectionSettings", @@ -1452,7 +1386,6 @@ ], "parameters": { "name": { -"description": "Required. The name of the VirtualMachineThreatDetectionSettings to retrieve. Formats: * organizations/{organization}/virtualMachineThreatDetectionSettings * folders/{folder}/virtualMachineThreatDetectionSettings * projects/{project}/virtualMachineThreatDetectionSettings", "location": "path", "pattern": "^projects/[^/]+/virtualMachineThreatDetectionSettings$", "required": true, @@ -1468,7 +1401,7 @@ ] }, "getWebSecurityScannerSettings": { -"description": "Get the WebSecurityScannerSettings resource. In the returned settings response, a missing field only indicates that it was not explicitly set, so no assumption should be made about these fields. In other words, GetWebSecurityScannerSettings does not calculate the effective service settings for the resource, which accounts for inherited settings and defaults. Instead, use CalculateWebSecurityScannerSettings for this purpose.", +"description": "", "flatPath": "v1beta2/projects/{projectsId}/webSecurityScannerSettings", "httpMethod": "GET", "id": "securitycenter.projects.getWebSecurityScannerSettings", @@ -1477,7 +1410,6 @@ ], "parameters": { "name": { -"description": "Required. The name of the WebSecurityScannerSettings to retrieve. Formats: * organizations/{organization}/webSecurityScannerSettings * folders/{folder}/webSecurityScannerSettings * projects/{project}/webSecurityScannerSettings", "location": "path", "pattern": "^projects/[^/]+/webSecurityScannerSettings$", "required": true, @@ -1493,7 +1425,7 @@ ] }, "updateContainerThreatDetectionSettings": { -"description": "Update the ContainerThreatDetectionSettings resource.", +"description": "", "flatPath": "v1beta2/projects/{projectsId}/containerThreatDetectionSettings", "httpMethod": "PATCH", "id": "securitycenter.projects.updateContainerThreatDetectionSettings", @@ -1502,14 +1434,12 @@ ], "parameters": { "name": { -"description": "Identifier. The resource name of the ContainerThreatDetectionSettings. Formats: * organizations/{organization}/containerThreatDetectionSettings * folders/{folder}/containerThreatDetectionSettings * projects/{project}/containerThreatDetectionSettings * projects/{project}/locations/{location}/clusters/{cluster}/containerThreatDetectionSettings", "location": "path", "pattern": "^projects/[^/]+/containerThreatDetectionSettings$", "required": true, "type": "string" }, "updateMask": { -"description": "The list of fields to be updated.", "format": "google-fieldmask", "location": "query", "type": "string" @@ -1527,7 +1457,7 @@ ] }, "updateEventThreatDetectionSettings": { -"description": "Update the EventThreatDetectionSettings resource.", +"description": "", "flatPath": "v1beta2/projects/{projectsId}/eventThreatDetectionSettings", "httpMethod": "PATCH", "id": "securitycenter.projects.updateEventThreatDetectionSettings", @@ -1536,14 +1466,12 @@ ], "parameters": { "name": { -"description": "Identifier. The resource name of the EventThreatDetectionSettings. Formats: * organizations/{organization}/eventThreatDetectionSettings * folders/{folder}/eventThreatDetectionSettings * projects/{project}/eventThreatDetectionSettings", "location": "path", "pattern": "^projects/[^/]+/eventThreatDetectionSettings$", "required": true, "type": "string" }, "updateMask": { -"description": "The list of fields to be updated.", "format": "google-fieldmask", "location": "query", "type": "string" @@ -1561,7 +1489,7 @@ ] }, "updateRapidVulnerabilityDetectionSettings": { -"description": "Update the RapidVulnerabilityDetectionSettings resource.", +"description": "", "flatPath": "v1beta2/projects/{projectsId}/rapidVulnerabilityDetectionSettings", "httpMethod": "PATCH", "id": "securitycenter.projects.updateRapidVulnerabilityDetectionSettings", @@ -1570,14 +1498,12 @@ ], "parameters": { "name": { -"description": "The resource name of the RapidVulnerabilityDetectionSettings. Formats: * organizations/{organization}/rapidVulnerabilityDetectionSettings * folders/{folder}/rapidVulnerabilityDetectionSettings * projects/{project}/rapidVulnerabilityDetectionSettings", "location": "path", "pattern": "^projects/[^/]+/rapidVulnerabilityDetectionSettings$", "required": true, "type": "string" }, "updateMask": { -"description": "The list of fields to be updated.", "format": "google-fieldmask", "location": "query", "type": "string" @@ -1595,7 +1521,7 @@ ] }, "updateSecurityHealthAnalyticsSettings": { -"description": "Update the SecurityHealthAnalyticsSettings resource.", +"description": "", "flatPath": "v1beta2/projects/{projectsId}/securityHealthAnalyticsSettings", "httpMethod": "PATCH", "id": "securitycenter.projects.updateSecurityHealthAnalyticsSettings", @@ -1604,14 +1530,12 @@ ], "parameters": { "name": { -"description": "Identifier. The resource name of the SecurityHealthAnalyticsSettings. Formats: * organizations/{organization}/securityHealthAnalyticsSettings * folders/{folder}/securityHealthAnalyticsSettings * projects/{project}/securityHealthAnalyticsSettings", "location": "path", "pattern": "^projects/[^/]+/securityHealthAnalyticsSettings$", "required": true, "type": "string" }, "updateMask": { -"description": "The list of fields to be updated.", "format": "google-fieldmask", "location": "query", "type": "string" @@ -1629,7 +1553,7 @@ ] }, "updateVirtualMachineThreatDetectionSettings": { -"description": "Update the VirtualMachineThreatDetectionSettings resource.", +"description": "", "flatPath": "v1beta2/projects/{projectsId}/virtualMachineThreatDetectionSettings", "httpMethod": "PATCH", "id": "securitycenter.projects.updateVirtualMachineThreatDetectionSettings", @@ -1638,14 +1562,12 @@ ], "parameters": { "name": { -"description": "Identifier. The resource name of the VirtualMachineThreatDetectionSettings. Formats: * organizations/{organization}/virtualMachineThreatDetectionSettings * folders/{folder}/virtualMachineThreatDetectionSettings * projects/{project}/virtualMachineThreatDetectionSettings", "location": "path", "pattern": "^projects/[^/]+/virtualMachineThreatDetectionSettings$", "required": true, "type": "string" }, "updateMask": { -"description": "The list of fields to be updated.", "format": "google-fieldmask", "location": "query", "type": "string" @@ -1663,7 +1585,7 @@ ] }, "updateWebSecurityScannerSettings": { -"description": "Update the WebSecurityScannerSettings resource.", +"description": "", "flatPath": "v1beta2/projects/{projectsId}/webSecurityScannerSettings", "httpMethod": "PATCH", "id": "securitycenter.projects.updateWebSecurityScannerSettings", @@ -1672,14 +1594,12 @@ ], "parameters": { "name": { -"description": "Identifier. The resource name of the WebSecurityScannerSettings. Formats: * organizations/{organization}/webSecurityScannerSettings * folders/{folder}/webSecurityScannerSettings * projects/{project}/webSecurityScannerSettings", "location": "path", "pattern": "^projects/[^/]+/webSecurityScannerSettings$", "required": true, "type": "string" }, "updateMask": { -"description": "The list of fields to be updated.", "format": "google-fieldmask", "location": "query", "type": "string" @@ -1701,7 +1621,7 @@ "containerThreatDetectionSettings": { "methods": { "calculate": { -"description": "Calculates the effective ContainerThreatDetectionSettings based on its level in the resource hierarchy and its settings. Settings provided closer to the target resource take precedence over those further away (e.g. folder will override organization level settings). The default SCC setting for the detector service defaults can be overridden at organization, folder and project levels. No assumptions should be made about the SCC defaults as it is considered an internal implementation detail.", +"description": "", "flatPath": "v1beta2/projects/{projectsId}/containerThreatDetectionSettings:calculate", "httpMethod": "GET", "id": "securitycenter.projects.containerThreatDetectionSettings.calculate", @@ -1710,14 +1630,12 @@ ], "parameters": { "name": { -"description": "Required. The name of the ContainerThreatDetectionSettings to calculate. Formats: * organizations/{organization}/containerThreatDetectionSettings * folders/{folder}/containerThreatDetectionSettings * projects/{project}/containerThreatDetectionSettings * projects/{project}/locations/{location}/clusters/{cluster}/containerThreatDetectionSettings", "location": "path", "pattern": "^projects/[^/]+/containerThreatDetectionSettings$", "required": true, "type": "string" }, "showEligibleModulesOnly": { -"description": "Optional. When set, will only retrieve the modules that are in scope. By default, all modules will be shown.", "location": "query", "type": "boolean" } @@ -1735,7 +1653,7 @@ "eventThreatDetectionSettings": { "methods": { "calculate": { -"description": "Calculates the effective EventThreatDetectionSettings based on its level in the resource hierarchy and its settings. Settings provided closer to the target resource take precedence over those further away (e.g. folder will override organization level settings). The default SCC setting for the detector service defaults can be overridden at organization, folder and project levels. No assumptions should be made about the SCC defaults as it is considered an internal implementation detail.", +"description": "", "flatPath": "v1beta2/projects/{projectsId}/eventThreatDetectionSettings:calculate", "httpMethod": "GET", "id": "securitycenter.projects.eventThreatDetectionSettings.calculate", @@ -1744,14 +1662,12 @@ ], "parameters": { "name": { -"description": "Required. The name of the EventThreatDetectionSettings to calculate. Formats: * organizations/{organization}/eventThreatDetectionSettings * folders/{folder}/eventThreatDetectionSettings * projects/{project}/eventThreatDetectionSettings", "location": "path", "pattern": "^projects/[^/]+/eventThreatDetectionSettings$", "required": true, "type": "string" }, "showEligibleModulesOnly": { -"description": "Optional. When set, will only retrieve the modules that are in scope. By default, all modules will be shown.", "location": "query", "type": "boolean" } @@ -1771,7 +1687,7 @@ "clusters": { "methods": { "getContainerThreatDetectionSettings": { -"description": "Get the ContainerThreatDetectionSettings resource. In the returned settings response, a missing field only indicates that it was not explicitly set, so no assumption should be made about these fields. In other words, GetContainerThreatDetectionSettings does not calculate the effective service settings for the resource, which accounts for inherited settings and defaults. Instead, use CalculateContainerThreatDetectionSettings for this purpose.", +"description": "", "flatPath": "v1beta2/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/containerThreatDetectionSettings", "httpMethod": "GET", "id": "securitycenter.projects.locations.clusters.getContainerThreatDetectionSettings", @@ -1780,7 +1696,6 @@ ], "parameters": { "name": { -"description": "Required. The name of the ContainerThreatDetectionSettings to retrieve. Formats: * organizations/{organization}/containerThreatDetectionSettings * folders/{folder}/containerThreatDetectionSettings * projects/{project}/containerThreatDetectionSettings * projects/{project}/locations/{location}/clusters/{cluster}/containerThreatDetectionSettings", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+/containerThreatDetectionSettings$", "required": true, @@ -1796,7 +1711,7 @@ ] }, "updateContainerThreatDetectionSettings": { -"description": "Update the ContainerThreatDetectionSettings resource.", +"description": "", "flatPath": "v1beta2/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/containerThreatDetectionSettings", "httpMethod": "PATCH", "id": "securitycenter.projects.locations.clusters.updateContainerThreatDetectionSettings", @@ -1805,14 +1720,12 @@ ], "parameters": { "name": { -"description": "Identifier. The resource name of the ContainerThreatDetectionSettings. Formats: * organizations/{organization}/containerThreatDetectionSettings * folders/{folder}/containerThreatDetectionSettings * projects/{project}/containerThreatDetectionSettings * projects/{project}/locations/{location}/clusters/{cluster}/containerThreatDetectionSettings", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+/containerThreatDetectionSettings$", "required": true, "type": "string" }, "updateMask": { -"description": "The list of fields to be updated.", "format": "google-fieldmask", "location": "query", "type": "string" @@ -1834,7 +1747,7 @@ "containerThreatDetectionSettings": { "methods": { "calculate": { -"description": "Calculates the effective ContainerThreatDetectionSettings based on its level in the resource hierarchy and its settings. Settings provided closer to the target resource take precedence over those further away (e.g. folder will override organization level settings). The default SCC setting for the detector service defaults can be overridden at organization, folder and project levels. No assumptions should be made about the SCC defaults as it is considered an internal implementation detail.", +"description": "", "flatPath": "v1beta2/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/containerThreatDetectionSettings:calculate", "httpMethod": "GET", "id": "securitycenter.projects.locations.clusters.containerThreatDetectionSettings.calculate", @@ -1843,14 +1756,12 @@ ], "parameters": { "name": { -"description": "Required. The name of the ContainerThreatDetectionSettings to calculate. Formats: * organizations/{organization}/containerThreatDetectionSettings * folders/{folder}/containerThreatDetectionSettings * projects/{project}/containerThreatDetectionSettings * projects/{project}/locations/{location}/clusters/{cluster}/containerThreatDetectionSettings", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+/containerThreatDetectionSettings$", "required": true, "type": "string" }, "showEligibleModulesOnly": { -"description": "Optional. When set, will only retrieve the modules that are in scope. By default, all modules will be shown.", "location": "query", "type": "boolean" } @@ -1872,7 +1783,7 @@ "rapidVulnerabilityDetectionSettings": { "methods": { "calculate": { -"description": "Calculates the effective RapidVulnerabilityDetectionSettings based on its level in the resource hierarchy and its settings. Settings provided closer to the target resource take precedence over those further away (e.g. folder will override organization level settings). The default SCC setting for the detector service defaults can be overridden at organization, folder and project levels. No assumptions should be made about the SCC defaults as it is considered an internal implementation detail.", +"description": "", "flatPath": "v1beta2/projects/{projectsId}/rapidVulnerabilityDetectionSettings:calculate", "httpMethod": "GET", "id": "securitycenter.projects.rapidVulnerabilityDetectionSettings.calculate", @@ -1881,7 +1792,6 @@ ], "parameters": { "name": { -"description": "Required. The name of the RapidVulnerabilityDetectionSettings to calculate. Formats: * organizations/{organization}/rapidVulnerabilityDetectionSettings * folders/{folder}/rapidVulnerabilityDetectionSettings * projects/{project}/rapidVulnerabilityDetectionSettings", "location": "path", "pattern": "^projects/[^/]+/rapidVulnerabilityDetectionSettings$", "required": true, @@ -1901,7 +1811,7 @@ "securityHealthAnalyticsSettings": { "methods": { "calculate": { -"description": "Calculates the effective SecurityHealthAnalyticsSettings based on its level in the resource hierarchy and its settings. Settings provided closer to the target resource take precedence over those further away (e.g. folder will override organization level settings). The default SCC setting for the detector service defaults can be overridden at organization, folder and project levels. No assumptions should be made about the SCC defaults as it is considered an internal implementation detail.", +"description": "", "flatPath": "v1beta2/projects/{projectsId}/securityHealthAnalyticsSettings:calculate", "httpMethod": "GET", "id": "securitycenter.projects.securityHealthAnalyticsSettings.calculate", @@ -1910,14 +1820,12 @@ ], "parameters": { "name": { -"description": "Required. The name of the SecurityHealthAnalyticsSettings to calculate. Formats: * organizations/{organization}/securityHealthAnalyticsSettings * folders/{folder}/securityHealthAnalyticsSettings * projects/{project}/securityHealthAnalyticsSettings", "location": "path", "pattern": "^projects/[^/]+/securityHealthAnalyticsSettings$", "required": true, "type": "string" }, "showEligibleModulesOnly": { -"description": "Optional. When set, will only retrieve the modules that are in scope. By default, all modules will be shown.", "location": "query", "type": "boolean" } @@ -1935,7 +1843,7 @@ "virtualMachineThreatDetectionSettings": { "methods": { "calculate": { -"description": "Calculates the effective VirtualMachineThreatDetectionSettings based on its level in the resource hierarchy and its settings. Settings provided closer to the target resource take precedence over those further away (e.g. folder will override organization level settings). The default SCC setting for the detector service defaults can be overridden at organization, folder and project levels. No assumptions should be made about the SCC defaults as it is considered an internal implementation detail.", +"description": "", "flatPath": "v1beta2/projects/{projectsId}/virtualMachineThreatDetectionSettings:calculate", "httpMethod": "GET", "id": "securitycenter.projects.virtualMachineThreatDetectionSettings.calculate", @@ -1944,14 +1852,12 @@ ], "parameters": { "name": { -"description": "Required. The name of the VirtualMachineThreatDetectionSettings to calculate. Formats: * organizations/{organization}/virtualMachineThreatDetectionSettings * folders/{folder}/virtualMachineThreatDetectionSettings * projects/{project}/virtualMachineThreatDetectionSettings", "location": "path", "pattern": "^projects/[^/]+/virtualMachineThreatDetectionSettings$", "required": true, "type": "string" }, "showEligibleModulesOnly": { -"description": "Optional. When set, will only retrieve the modules that are in scope. By default, all modules will be shown.", "location": "query", "type": "boolean" } @@ -1969,7 +1875,7 @@ "webSecurityScannerSettings": { "methods": { "calculate": { -"description": "Calculates the effective WebSecurityScannerSettings based on its level in the resource hierarchy and its settings. Settings provided closer to the target resource take precedence over those further away (e.g. folder will override organization level settings). The default SCC setting for the detector service defaults can be overridden at organization, folder and project levels. No assumptions should be made about the SCC defaults as it is considered an internal implementation detail.", +"description": "", "flatPath": "v1beta2/projects/{projectsId}/webSecurityScannerSettings:calculate", "httpMethod": "GET", "id": "securitycenter.projects.webSecurityScannerSettings.calculate", @@ -1978,14 +1884,12 @@ ], "parameters": { "name": { -"description": "Required. The name of the WebSecurityScannerSettings to calculate. Formats: * organizations/{organization}/webSecurityScannerSettings * folders/{folder}/webSecurityScannerSettings * projects/{project}/webSecurityScannerSettings", "location": "path", "pattern": "^projects/[^/]+/webSecurityScannerSettings$", "required": true, "type": "string" }, "showEligibleModulesOnly": { -"description": "Optional. When set, will only retrieve the modules that are in scope. By default, all modules will be shown.", "location": "query", "type": "boolean" } @@ -2003,104 +1907,82 @@ } } }, -"revision": "20260424", +"revision": "20260526", "rootUrl": "https://securitycenter.googleapis.com/", "schemas": { "Access": { -"description": "Represents an access event.", "id": "Access", "properties": { "callerIp": { -"description": "Caller's IP address, such as \"1.1.1.1\".", "type": "string" }, "callerIpGeo": { -"$ref": "Geolocation", -"description": "The caller IP's geolocation, which identifies where the call came from." +"$ref": "Geolocation" }, "methodName": { -"description": "The method that the service account called, e.g. \"SetIamPolicy\".", "type": "string" }, "principalEmail": { -"description": "Associated email, such as \"foo@google.com\". The email address of the authenticated user or a service account acting on behalf of a 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" }, "principalSubject": { -"description": "A string that represents the principal_subject that is associated with the identity. Unlike `principal_email`, `principal_subject` supports principals that aren't associated with email addresses, such as third party principals. For most identities, the format is `principal://iam.googleapis.com/{identity pool name}/subject/{subject}`. Some GKE identities, such as GKE_WORKLOAD, FREEFORM, and GKE_HUB_WORKLOAD, still use the legacy format `serviceAccount:{identity pool name}[{subject}]`.", "type": "string" }, "serviceAccountDelegationInfo": { -"description": "The identity delegation history of an authenticated service account that made the request. The `serviceAccountDelegationInfo[]` object contains information about the real authorities that try to access Google Cloud resources by delegating on a service account. When multiple authorities are present, they are guaranteed to be sorted based on the original ordering of the identity delegation events.", "items": { "$ref": "ServiceAccountDelegationInfo" }, "type": "array" }, "serviceAccountKeyName": { -"description": "The name of the service account key that was used to create or exchange credentials when authenticating the service account that made the request. This is a scheme-less URI full resource name. For example: \"//iam.googleapis.com/projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}/keys/{key}\". ", "type": "string" }, "serviceName": { -"description": "This is the API service that the service account made a call to, e.g. \"iam.googleapis.com\"", "type": "string" }, "userAgent": { -"description": "The caller's user agent string associated with the finding.", "type": "string" }, "userAgentFamily": { -"description": "Type of user agent associated with the finding. For example, an operating system shell or an embedded or standalone application.", "type": "string" }, "userName": { -"description": "A string that represents a username. The username provided depends on the type of the finding and is likely not an IAM principal. For example, this can be a system username if the finding is related to a virtual machine, or it can be an application login username.", "type": "string" } }, "type": "object" }, "AccessReview": { -"description": "Conveys information about a Kubernetes access review (such as one returned by a [`kubectl auth can-i`](https://kubernetes.io/docs/reference/access-authn-authz/authorization/#checking-api-access) command) that was involved in a finding.", "id": "AccessReview", "properties": { "group": { -"description": "The API group of the resource. \"*\" means all.", "type": "string" }, "name": { -"description": "The name of the resource being requested. Empty means all.", "type": "string" }, "ns": { -"description": "Namespace of the action being requested. Currently, there is no distinction between no namespace and all namespaces. Both are represented by \"\" (empty).", "type": "string" }, "resource": { -"description": "The optional resource type requested. \"*\" means all.", "type": "string" }, "subresource": { -"description": "The optional subresource type.", "type": "string" }, "verb": { -"description": "A Kubernetes resource API verb, like get, list, watch, create, update, delete, proxy. \"*\" means all.", "type": "string" }, "version": { -"description": "The API version of the resource. \"*\" means all.", "type": "string" } }, "type": "object" }, "AdaptiveProtection": { -"description": "Information about [Google Cloud Armor Adaptive Protection](https://cloud.google.com/armor/docs/cloud-armor-overview#google-cloud-armor-adaptive-protection).", "id": "AdaptiveProtection", "properties": { "confidence": { -"description": "A score of 0 means that there is low confidence that the detected event is an actual attack. A score of 1 means that there is high confidence that the detected event is an attack. See the [Adaptive Protection documentation](https://cloud.google.com/armor/docs/adaptive-protection-overview#configure-alert-tuning) for further explanation.", "format": "double", "type": "number" } @@ -2108,48 +1990,39 @@ "type": "object" }, "AdcApplication": { -"description": "Represents an ADC application associated with the finding.", "id": "AdcApplication", "properties": { "attributes": { -"$ref": "GoogleCloudSecuritycenterV1ResourceApplicationAttributes", -"description": "Consumer provided attributes for the AppHub application." +"$ref": "GoogleCloudSecuritycenterV1ResourceApplicationAttributes" }, "name": { -"description": "The resource name of an ADC Application. Format: projects/{project}/locations/{location}/spaces/{space}/applications/{application}", "type": "string" } }, "type": "object" }, "AdcApplicationTemplateRevision": { -"description": "Represents an ADC template associated with the finding.", "id": "AdcApplicationTemplateRevision", "properties": { "name": { -"description": "The resource name of an ADC Application Template Revision. Format: projects/{project}/locations/{location}/spaces/{space}/applicationTemplates/{application_template}/revisions/{revision}", "type": "string" } }, "type": "object" }, "AdcSharedTemplateRevision": { -"description": "Represents an ADC shared template associated with the finding.", "id": "AdcSharedTemplateRevision", "properties": { "name": { -"description": "The resource name of an ADC Shared Template Revision. Format: projects/{project}/locations/{location}/spaces/{space}/applicationTemplates/{application_template}/revisions/{revision}", "type": "string" } }, "type": "object" }, "AffectedResources": { -"description": "Details about resources affected by this finding.", "id": "AffectedResources", "properties": { "count": { -"description": "The count of resources affected by the finding.", "format": "int64", "type": "string" } @@ -2157,20 +2030,16 @@ "type": "object" }, "AgentDataAccessEvent": { -"description": "Details about a data access attempt made by an agent principal not authorized under applicable data security policy.", "id": "AgentDataAccessEvent", "properties": { "eventId": { -"description": "Unique identifier for data access event.", "type": "string" }, "eventTime": { -"description": "Timestamp of data access event.", "format": "google-datetime", "type": "string" }, "operation": { -"description": "The operation performed by the principal to access the data.", "enum": [ "OPERATION_UNSPECIFIED", "READ", @@ -2178,26 +2047,23 @@ "COPY" ], "enumDescriptions": [ -"The operation is unspecified.", -"Represents a read operation.", -"Represents a move operation.", -"Represents a copy operation." +"", +"", +"", +"" ], "type": "string" }, "principalSubject": { -"description": "The agent principal that accessed the data.", "type": "string" } }, "type": "object" }, "AiModel": { -"description": "Contains information about the AI model associated with the finding.", "id": "AiModel", "properties": { "deploymentPlatform": { -"description": "The platform on which the model is deployed.", "enum": [ "DEPLOYMENT_PLATFORM_UNSPECIFIED", "VERTEX_AI", @@ -2206,51 +2072,42 @@ "FINE_TUNED_MODEL" ], "enumDescriptions": [ -"Unspecified deployment platform.", -"Vertex AI.", -"Google Kubernetes Engine.", -"Google Compute Engine.", -"Fine tuned model." +"", +"", +"", +"", +"" ], "type": "string" }, "displayName": { -"description": "The user defined display name of model. Ex. baseline-classification-model", "type": "string" }, "domain": { -"description": "The domain of the model, for example, \u201cimage-classification\u201d.", "type": "string" }, "library": { -"description": "The name of the model library, for example, \u201ctransformers\u201d.", "type": "string" }, "location": { -"description": "The region in which the model is used, for example, \u201cus-central1\u201d.", "type": "string" }, "name": { -"description": "The name of the AI model, for example, \"gemini:1.0.0\".", "type": "string" }, "publisher": { -"description": "The publisher of the model, for example, \u201cgoogle\u201d or \u201cnvidia\u201d.", "type": "string" }, "usageCategory": { -"description": "The purpose of the model, for example, \"Inteference\" or \"Training\".", "type": "string" } }, "type": "object" }, "Allowed": { -"description": "Allowed IP rule.", "id": "Allowed", "properties": { "ipRules": { -"description": "Optional. Optional list of allowed IP rules.", "items": { "$ref": "IpRule" }, @@ -2260,59 +2117,49 @@ "type": "object" }, "Application": { -"description": "Represents an application associated with a finding.", "id": "Application", "properties": { "baseUri": { -"description": "The base URI that identifies the network location of the application in which the vulnerability was detected. For example, `http://example.com`.", "type": "string" }, "fullUri": { -"description": "The full URI with payload that can be used to reproduce the vulnerability. For example, `http://example.com?p=aMmYgI6H`.", "type": "string" } }, "type": "object" }, "ArtifactGuardPolicies": { -"description": "Represents the result of evaluating artifact guard policies.", "id": "ArtifactGuardPolicies", "properties": { "failingPolicies": { -"description": "A list of failing policies.", "items": { "$ref": "ArtifactGuardPolicy" }, "type": "array" }, "resourceId": { -"description": "The ID of the resource that has policies configured for it.", "type": "string" } }, "type": "object" }, "ArtifactGuardPolicy": { -"description": "Represents an artifact guard policy.", "id": "ArtifactGuardPolicy", "properties": { "failureReason": { -"description": "The reason for the policy failure, for example, \"severity=HIGH AND max_vuln_count=2\".", "type": "string" }, "policyId": { -"description": "The ID of the failing policy, for example, \"organizations/3392779/locations/global/policies/prod-policy\".", "type": "string" }, "type": { -"description": "The type of the policy evaluation.", "enum": [ "ARTIFACT_GUARD_POLICY_TYPE_UNSPECIFIED", "VULNERABILITY" ], "enumDescriptions": [ -"Default value. This value is unused.", -"Vulnerability type." +"", +"" ], "type": "string" } @@ -2320,32 +2167,26 @@ "type": "object" }, "Attack": { -"description": "Information about DDoS attack volume and classification.", "id": "Attack", "properties": { "classification": { -"description": "Type of attack, for example, 'SYN-flood', 'NTP-udp', or 'CHARGEN-udp'.", "type": "string" }, "volumeBps": { "deprecated": true, -"description": "Total BPS (bytes per second) volume of attack. Deprecated - refer to volume_bps_long instead.", "format": "int32", "type": "integer" }, "volumeBpsLong": { -"description": "Total BPS (bytes per second) volume of attack.", "format": "int64", "type": "string" }, "volumePps": { "deprecated": true, -"description": "Total PPS (packets per second) volume of attack. Deprecated - refer to volume_pps_long instead.", "format": "int32", "type": "integer" }, "volumePpsLong": { -"description": "Total PPS (packets per second) volume of attack.", "format": "int64", "type": "string" } @@ -2353,49 +2194,41 @@ "type": "object" }, "AttackExposure": { -"description": "An attack exposure contains the results of an attack path simulation run.", "id": "AttackExposure", "properties": { "attackExposureResult": { -"description": "The resource name of the attack path simulation result that contains the details regarding this attack exposure score. Example: `organizations/123/simulations/456/attackExposureResults/789`", "type": "string" }, "exposedHighValueResourcesCount": { -"description": "The number of high value resources that are exposed as a result of this finding.", "format": "int32", "type": "integer" }, "exposedLowValueResourcesCount": { -"description": "The number of high value resources that are exposed as a result of this finding.", "format": "int32", "type": "integer" }, "exposedMediumValueResourcesCount": { -"description": "The number of medium value resources that are exposed as a result of this finding.", "format": "int32", "type": "integer" }, "latestCalculationTime": { -"description": "The most recent time the attack exposure was updated on this finding.", "format": "google-datetime", "type": "string" }, "score": { -"description": "A number between 0 (inclusive) and infinity that represents how important this finding is to remediate. The higher the score, the more important it is to remediate.", "format": "double", "type": "number" }, "state": { -"description": "What state this AttackExposure is in. This captures whether or not an attack exposure has been calculated or not.", "enum": [ "STATE_UNSPECIFIED", "CALCULATED", "NOT_CALCULATED" ], "enumDescriptions": [ -"The state is not specified.", -"The attack exposure has been calculated.", -"The attack exposure has not been calculated." +"", +"", +"" ], "type": "string" } @@ -2403,34 +2236,27 @@ "type": "object" }, "AwsAccount": { -"description": "An AWS account that is a member of an organization.", "id": "AwsAccount", "properties": { "id": { -"description": "The unique identifier (ID) of the account, containing exactly 12 digits.", "type": "string" }, "name": { -"description": "The friendly name of this account.", "type": "string" } }, "type": "object" }, "AwsMetadata": { -"description": "AWS metadata associated with the resource, only applicable if the finding's cloud provider is Amazon Web Services.", "id": "AwsMetadata", "properties": { "account": { -"$ref": "AwsAccount", -"description": "The AWS account associated with the resource." +"$ref": "AwsAccount" }, "organization": { -"$ref": "AwsOrganization", -"description": "The AWS organization associated with the resource." +"$ref": "AwsOrganization" }, "organizationalUnits": { -"description": "A list of AWS organizational units associated with the resource, ordered from lowest level (closest to the account) to highest level.", "items": { "$ref": "AwsOrganizationalUnit" }, @@ -2440,191 +2266,154 @@ "type": "object" }, "AwsOrganization": { -"description": "An organization is a collection of accounts that are centrally managed together using consolidated billing, organized hierarchically with organizational units (OUs), and controlled with policies.", "id": "AwsOrganization", "properties": { "id": { -"description": "The unique identifier (ID) for the organization. The regex pattern for an organization ID string requires \"o-\" followed by from 10 to 32 lowercase letters or digits.", "type": "string" } }, "type": "object" }, "AwsOrganizationalUnit": { -"description": "An Organizational Unit (OU) is a container of AWS accounts within a root of an organization. Policies that are attached to an OU apply to all accounts contained in that OU and in any child OUs.", "id": "AwsOrganizationalUnit", "properties": { "id": { -"description": "The unique identifier (ID) associated with this OU. The regex pattern for an organizational unit ID string requires \"ou-\" followed by from 4 to 32 lowercase letters or digits (the ID of the root that contains the OU). This string is followed by a second \"-\" dash and from 8 to 32 additional lowercase letters or digits. For example, \"ou-ab12-cd34ef56\".", "type": "string" }, "name": { -"description": "The friendly name of the OU.", "type": "string" } }, "type": "object" }, "AzureManagementGroup": { -"description": "Represents an Azure management group.", "id": "AzureManagementGroup", "properties": { "displayName": { -"description": "The display name of the Azure management group.", "type": "string" }, "id": { -"description": "The UUID of the Azure management group, for example, `20000000-0001-0000-0000-000000000000`.", "type": "string" } }, "type": "object" }, "AzureMetadata": { -"description": "Azure metadata associated with the resource, only applicable if the finding's cloud provider is Microsoft Azure.", "id": "AzureMetadata", "properties": { "managementGroups": { -"description": "A list of Azure management groups associated with the resource, ordered from lowest level (closest to the subscription) to highest level.", "items": { "$ref": "AzureManagementGroup" }, "type": "array" }, "resourceGroup": { -"$ref": "AzureResourceGroup", -"description": "The Azure resource group associated with the resource." +"$ref": "AzureResourceGroup" }, "subscription": { -"$ref": "AzureSubscription", -"description": "The Azure subscription associated with the resource." +"$ref": "AzureSubscription" }, "tenant": { -"$ref": "AzureTenant", -"description": "The Azure Entra tenant associated with the resource." +"$ref": "AzureTenant" } }, "type": "object" }, "AzureResourceGroup": { -"description": "Represents an Azure resource group.", "id": "AzureResourceGroup", "properties": { "id": { -"description": "The ID of the Azure resource group.", "type": "string" }, "name": { -"description": "The name of the Azure resource group. This is not a UUID.", "type": "string" } }, "type": "object" }, "AzureSubscription": { -"description": "Represents an Azure subscription.", "id": "AzureSubscription", "properties": { "displayName": { -"description": "The display name of the Azure subscription.", "type": "string" }, "id": { -"description": "The UUID of the Azure subscription, for example, `291bba3f-e0a5-47bc-a099-3bdcb2a50a05`.", "type": "string" } }, "type": "object" }, "AzureTenant": { -"description": "Represents a Microsoft Entra tenant.", "id": "AzureTenant", "properties": { "displayName": { -"description": "The display name of the Azure tenant.", "type": "string" }, "id": { -"description": "The ID of the Microsoft Entra tenant, for example, \"a11aaa11-aa11-1aa1-11aa-1aaa11a\".", "type": "string" } }, "type": "object" }, "BackupDisasterRecovery": { -"description": "Information related to Google Cloud Backup and DR Service findings.", "id": "BackupDisasterRecovery", "properties": { "appliance": { -"description": "The name of the Backup and DR appliance that captures, moves, and manages the lifecycle of backup data. For example, `backup-server-57137`.", "type": "string" }, "applications": { -"description": "The names of Backup and DR applications. An application is a VM, database, or file system on a managed host monitored by a backup and recovery appliance. For example, `centos7-01-vol00`, `centos7-01-vol01`, `centos7-01-vol02`.", "items": { "type": "string" }, "type": "array" }, "backupCreateTime": { -"description": "The timestamp at which the Backup and DR backup was created.", "format": "google-datetime", "type": "string" }, "backupTemplate": { -"description": "The name of a Backup and DR template which comprises one or more backup policies. See the [Backup and DR documentation](https://cloud.google.com/backup-disaster-recovery/docs/concepts/backup-plan#temp) for more information. For example, `snap-ov`.", "type": "string" }, "backupType": { -"description": "The backup type of the Backup and DR image. For example, `Snapshot`, `Remote Snapshot`, `OnVault`.", "type": "string" }, "host": { -"description": "The name of a Backup and DR host, which is managed by the backup and recovery appliance and known to the management console. The host can be of type Generic (for example, Compute Engine, SQL Server, Oracle DB, SMB file system, etc.), vCenter, or an ESX server. See the [Backup and DR documentation on hosts](https://cloud.google.com/backup-disaster-recovery/docs/configuration/manage-hosts-and-their-applications) for more information. For example, `centos7-01`.", "type": "string" }, "policies": { -"description": "The names of Backup and DR policies that are associated with a template and that define when to run a backup, how frequently to run a backup, and how long to retain the backup image. For example, `onvaults`.", "items": { "type": "string" }, "type": "array" }, "policyOptions": { -"description": "The names of Backup and DR advanced policy options of a policy applying to an application. See the [Backup and DR documentation on policy options](https://cloud.google.com/backup-disaster-recovery/docs/create-plan/policy-settings). For example, `skipofflineappsincongrp, nounmap`.", "items": { "type": "string" }, "type": "array" }, "profile": { -"description": "The name of the Backup and DR resource profile that specifies the storage media for backups of application and VM data. See the [Backup and DR documentation on profiles](https://cloud.google.com/backup-disaster-recovery/docs/concepts/backup-plan#profile). For example, `GCP`.", "type": "string" }, "storagePool": { -"description": "The name of the Backup and DR storage pool that the backup and recovery appliance is storing data in. The storage pool could be of type Cloud, Primary, Snapshot, or OnVault. See the [Backup and DR documentation on storage pools](https://cloud.google.com/backup-disaster-recovery/docs/concepts/storage-pools). For example, `DiskPoolOne`.", "type": "string" } }, "type": "object" }, "BigQueryDestination": { -"description": "The destination BigQuery dataset to export findings to.", "id": "BigQueryDestination", "properties": { "dataset": { -"description": "Required. The relative resource name of the destination dataset, in the form projects/{projectId}/datasets/{datasetId}.", "type": "string" } }, "type": "object" }, "Chokepoint": { -"description": "Contains details about a chokepoint, which is a resource or resource group where high-risk attack paths converge, based on [attack path simulations] (https://cloud.google.com/security-command-center/docs/attack-exposure-learn#attack_path_simulations).", "id": "Chokepoint", "properties": { "relatedFindings": { -"description": "List of resource names of findings associated with this chokepoint. For example, organizations/123/sources/456/findings/789. This list will have at most 100 findings.", "items": { "type": "string" }, @@ -2634,65 +2423,53 @@ "type": "object" }, "CloudArmor": { -"description": "Fields related to Google Cloud Armor findings.", "id": "CloudArmor", "properties": { "adaptiveProtection": { -"$ref": "AdaptiveProtection", -"description": "Information about potential Layer 7 DDoS attacks identified by [Google Cloud Armor Adaptive Protection](https://cloud.google.com/armor/docs/adaptive-protection-overview)." +"$ref": "AdaptiveProtection" }, "attack": { -"$ref": "Attack", -"description": "Information about DDoS attack volume and classification." +"$ref": "Attack" }, "duration": { -"description": "Duration of attack from the start until the current moment (updated every 5 minutes).", "format": "google-duration", "type": "string" }, "requests": { -"$ref": "Requests", -"description": "Information about incoming requests evaluated by [Google Cloud Armor security policies](https://cloud.google.com/armor/docs/security-policy-overview)." +"$ref": "Requests" }, "securityPolicy": { -"$ref": "SecurityPolicy", -"description": "Information about the [Google Cloud Armor security policy](https://cloud.google.com/armor/docs/security-policy-overview) relevant to the finding." +"$ref": "SecurityPolicy" }, "threatVector": { -"description": "Distinguish between volumetric & protocol DDoS attack and application layer attacks. For example, \"L3_4\" for Layer 3 and Layer 4 DDoS attacks, or \"L_7\" for Layer 7 DDoS attacks.", "type": "string" } }, "type": "object" }, "CloudControl": { -"description": "CloudControl associated with the finding.", "id": "CloudControl", "properties": { "cloudControlName": { -"description": "Name of the CloudControl associated with the finding.", "type": "string" }, "policyType": { -"description": "Policy type of the CloudControl", "type": "string" }, "type": { -"description": "Type of cloud control.", "enum": [ "CLOUD_CONTROL_TYPE_UNSPECIFIED", "BUILT_IN", "CUSTOM" ], "enumDescriptions": [ -"Unspecified.", -"Built in Cloud Control.", -"Custom Cloud Control." +"", +"", +"" ], "type": "string" }, "version": { -"description": "Version of the Cloud Control", "format": "int32", "type": "integer" } @@ -2700,31 +2477,27 @@ "type": "object" }, "CloudDlpDataProfile": { -"description": "The [data profile](https://cloud.google.com/dlp/docs/data-profiles) associated with the finding.", "id": "CloudDlpDataProfile", "properties": { "dataProfile": { -"description": "Name of the data profile, for example, `projects/123/locations/europe/tableProfiles/8383929`.", "type": "string" }, "infoTypes": { -"description": "Type of information detected by SDP. Info type includes name, version and sensitivity of the detected information type.", "items": { "$ref": "InfoType" }, "type": "array" }, "parentType": { -"description": "The resource hierarchy level at which the data profile was generated.", "enum": [ "PARENT_TYPE_UNSPECIFIED", "ORGANIZATION", "PROJECT" ], "enumDescriptions": [ -"Unspecified parent type.", -"Organization-level configurations.", -"Project-level configurations." +"", +"", +"" ], "type": "string" } @@ -2732,47 +2505,37 @@ "type": "object" }, "CloudDlpInspection": { -"description": "Details about the Cloud Data Loss Prevention (Cloud DLP) [inspection job](https://cloud.google.com/dlp/docs/concepts-job-triggers) that produced the finding.", "id": "CloudDlpInspection", "properties": { "fullScan": { -"description": "Whether Cloud DLP scanned the complete resource or a sampled subset.", "type": "boolean" }, "infoType": { -"description": "The type of information (or *[infoType](https://cloud.google.com/dlp/docs/infotypes-reference)*) found, for example, `EMAIL_ADDRESS` or `STREET_ADDRESS`.", "type": "string" }, "infoTypeCount": { -"description": "The number of times Cloud DLP found this infoType within this job and resource.", "format": "int64", "type": "string" }, "inspectJob": { -"description": "Name of the inspection job, for example, `projects/123/locations/europe/dlpJobs/i-8383929`.", "type": "string" } }, "type": "object" }, "CloudLoggingEntry": { -"description": "Metadata taken from a [Cloud Logging LogEntry](https://cloud.google.com/logging/docs/reference/v2/rest/v2/LogEntry)", "id": "CloudLoggingEntry", "properties": { "insertId": { -"description": "A unique identifier for the log entry.", "type": "string" }, "logId": { -"description": "The type of the log (part of `log_name`. `log_name` is the resource name of the log to which this log entry belongs). For example: `cloudresourcemanager.googleapis.com/activity`. Note that this field is not URL-encoded, unlike the `LOG_ID` field in `LogEntry`.", "type": "string" }, "resourceContainer": { -"description": "The organization, folder, or project of the monitored resource that produced this log entry.", "type": "string" }, "timestamp": { -"description": "The time the event described by the log entry occurred.", "format": "google-datetime", "type": "string" } @@ -2780,44 +2543,36 @@ "type": "object" }, "Compliance": { -"description": "Contains compliance information about a security standard indicating unmet recommendations.", "id": "Compliance", "properties": { "ids": { -"description": "Policies within the standard or benchmark, for example, A.12.4.1", "items": { "type": "string" }, "type": "array" }, "standard": { -"description": "Industry-wide compliance standards or benchmarks, such as CIS, PCI, and OWASP.", "type": "string" }, "version": { -"description": "Version of the standard or benchmark, for example, 1.1", "type": "string" } }, "type": "object" }, "ComplianceDetails": { -"description": "Compliance Details associated with the finding.", "id": "ComplianceDetails", "properties": { "cloudControl": { -"$ref": "CloudControl", -"description": "CloudControl associated with the finding" +"$ref": "CloudControl" }, "cloudControlDeploymentNames": { -"description": "Cloud Control Deployments associated with the finding. For example, organizations/123/locations/global/cloudControlDeployments/deploymentIdentifier", "items": { "type": "string" }, "type": "array" }, "frameworks": { -"description": "Details of Frameworks associated with the finding", "items": { "$ref": "Framework" }, @@ -2827,11 +2582,9 @@ "type": "object" }, "Config": { -"description": "Configuration of a module.", "id": "Config", "properties": { "moduleEnablementState": { -"description": "The state of enablement for the module at its level of the resource hierarchy.", "enum": [ "ENABLEMENT_STATE_UNSPECIFIED", "INHERITED", @@ -2839,10 +2592,10 @@ "DISABLED" ], "enumDescriptions": [ -"Default value. This value is unused.", -"State is inherited from the parent resource.", -"State is enabled.", -"State is disabled." +"", +"", +"", +"" ], "type": "string" }, @@ -2851,27 +2604,22 @@ "description": "Properties of the object.", "type": "any" }, -"description": "The configuration value for the module. The absence of this field implies its inheritance from the parent.", "type": "object" } }, "type": "object" }, "Connection": { -"description": "Contains information about the IP connection associated with the finding.", "id": "Connection", "properties": { "destinationIp": { -"description": "Destination IP address. Not present for sockets that are listening and not connected.", "type": "string" }, "destinationPort": { -"description": "Destination port. Not present for sockets that are listening and not connected.", "format": "int32", "type": "integer" }, "protocol": { -"description": "IANA Internet Protocol Number such as TCP(6) and UDP(17).", "enum": [ "PROTOCOL_UNSPECIFIED", "ICMP", @@ -2881,21 +2629,19 @@ "ESP" ], "enumDescriptions": [ -"Unspecified protocol (not HOPOPT).", -"Internet Control Message Protocol.", -"Transmission Control Protocol.", -"User Datagram Protocol.", -"Generic Routing Encapsulation.", -"Encap Security Payload." +"", +"", +"", +"", +"", +"" ], "type": "string" }, "sourceIp": { -"description": "Source IP address.", "type": "string" }, "sourcePort": { -"description": "Source port.", "format": "int32", "type": "integer" } @@ -2903,22 +2649,18 @@ "type": "object" }, "Contact": { -"description": "The email address of a contact.", "id": "Contact", "properties": { "email": { -"description": "An email address. For example, \"`person123@company.com`\".", "type": "string" } }, "type": "object" }, "ContactDetails": { -"description": "Details about specific contacts", "id": "ContactDetails", "properties": { "contacts": { -"description": "A list of contacts", "items": { "$ref": "Contact" }, @@ -2928,58 +2670,47 @@ "type": "object" }, "Container": { -"description": "Container associated with the finding.", "id": "Container", "properties": { "createTime": { -"description": "The time that the container was created.", "format": "google-datetime", "type": "string" }, "imageId": { -"description": "Optional container image ID, if provided by the container runtime. Uniquely identifies the container image launched using a container image digest.", "type": "string" }, "labels": { -"description": "Container labels, as provided by the container runtime.", "items": { "$ref": "Label" }, "type": "array" }, "name": { -"description": "Name of the container.", "type": "string" }, "uri": { -"description": "Container image URI provided when configuring a pod or container. This string can identify a container image version using mutable tags.", "type": "string" } }, "type": "object" }, "ContainerThreatDetectionSettings": { -"description": "Resource capturing the settings for the Container Threat Detection service.", "id": "ContainerThreatDetectionSettings", "properties": { "modules": { "additionalProperties": { "$ref": "Config" }, -"description": "The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's configuration.", "type": "object" }, "name": { -"description": "Identifier. The resource name of the ContainerThreatDetectionSettings. Formats: * organizations/{organization}/containerThreatDetectionSettings * folders/{folder}/containerThreatDetectionSettings * projects/{project}/containerThreatDetectionSettings * projects/{project}/locations/{location}/clusters/{cluster}/containerThreatDetectionSettings", "type": "string" }, "serviceAccount": { -"description": "Output only. The service account used by Container Threat Detection for scanning. Service accounts are scoped at the project level meaning this field will be empty at any level above a project.", "readOnly": true, "type": "string" }, "serviceEnablementState": { -"description": "The state of enablement for the service at its level of the resource hierarchy. A DISABLED state will override all module enablement_states to DISABLED.", "enum": [ "ENABLEMENT_STATE_UNSPECIFIED", "INHERITED", @@ -2987,15 +2718,14 @@ "DISABLED" ], "enumDescriptions": [ -"Default value. This value is unused.", -"State is inherited from the parent resource.", -"State is enabled.", -"State is disabled." +"", +"", +"", +"" ], "type": "string" }, "updateTime": { -"description": "Output only. The time the settings were last updated.", "format": "google-datetime", "readOnly": true, "type": "string" @@ -3004,35 +2734,28 @@ "type": "object" }, "Control": { -"description": "Compliance control associated with the finding.", "id": "Control", "properties": { "controlName": { -"description": "Name of the Control", "type": "string" }, "displayName": { -"description": "Display name of the control. For example, AU-02.", "type": "string" } }, "type": "object" }, "Cve": { -"description": "CVE stands for Common Vulnerabilities and Exposures. Information from the [CVE record](https://www.cve.org/ResourcesSupport/Glossary) that describes this vulnerability.", "id": "Cve", "properties": { "cvssv3": { -"$ref": "Cvssv3", -"description": "Describe Common Vulnerability Scoring System specified at https://www.first.org/cvss/v3.1/specification-document" +"$ref": "Cvssv3" }, "exploitReleaseDate": { -"description": "Date the first publicly available exploit or PoC was released.", "format": "google-datetime", "type": "string" }, "exploitationActivity": { -"description": "The exploitation activity of the vulnerability in the wild.", "enum": [ "EXPLOITATION_ACTIVITY_UNSPECIFIED", "WIDE", @@ -3042,26 +2765,23 @@ "NO_KNOWN" ], "enumDescriptions": [ -"Invalid or empty value.", -"Exploitation has been reported or confirmed to widely occur.", -"Limited reported or confirmed exploitation activities.", -"Exploit is publicly available.", -"No known exploitation activity, but has a high potential for exploitation.", -"No known exploitation activity." +"", +"", +"", +"", +"", +"" ], "type": "string" }, "firstExploitationDate": { -"description": "Date of the earliest known exploitation.", "format": "google-datetime", "type": "string" }, "id": { -"description": "The unique identifier for the vulnerability. e.g. CVE-2021-34527", "type": "string" }, "impact": { -"description": "The potential impact of the vulnerability if it was to be exploited.", "enum": [ "RISK_RATING_UNSPECIFIED", "LOW", @@ -3070,56 +2790,49 @@ "CRITICAL" ], "enumDescriptions": [ -"Invalid or empty value.", -"Exploitation would have little to no security impact.", -"Exploitation would enable attackers to perform activities, or could allow attackers to have a direct impact, but would require additional steps.", -"Exploitation would enable attackers to have a notable direct impact without needing to overcome any major mitigating factors.", -"Exploitation would fundamentally undermine the security of affected systems, enable actors to perform significant attacks with minimal effort, with little to no mitigating factors to overcome." +"", +"", +"", +"", +"" ], "type": "string" }, "observedInTheWild": { -"description": "Whether or not the vulnerability has been observed in the wild.", "type": "boolean" }, "references": { -"description": "Additional information about the CVE. e.g. https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2021-34527", "items": { "$ref": "Reference" }, "type": "array" }, "upstreamFixAvailable": { -"description": "Whether upstream fix is available for the CVE.", "type": "boolean" }, "zeroDay": { -"description": "Whether or not the vulnerability was zero day when the finding was published.", "type": "boolean" } }, "type": "object" }, "Cvssv3": { -"description": "Common Vulnerability Scoring System version 3.", "id": "Cvssv3", "properties": { "attackComplexity": { -"description": "This metric describes the conditions beyond the attacker's control that must exist in order to exploit the vulnerability.", "enum": [ "ATTACK_COMPLEXITY_UNSPECIFIED", "ATTACK_COMPLEXITY_LOW", "ATTACK_COMPLEXITY_HIGH" ], "enumDescriptions": [ -"Invalid value.", -"Specialized access conditions or extenuating circumstances do not exist. An attacker can expect repeatable success when attacking the vulnerable component.", -"A successful attack depends on conditions beyond the attacker's control. That is, a successful attack cannot be accomplished at will, but requires the attacker to invest in some measurable amount of effort in preparation or execution against the vulnerable component before a successful attack can be expected." +"", +"", +"" ], "type": "string" }, "attackVector": { -"description": "Base Metrics Represents the intrinsic characteristics of a vulnerability that are constant over time and across user environments. This metric reflects the context by which vulnerability exploitation is possible.", "enum": [ "ATTACK_VECTOR_UNSPECIFIED", "ATTACK_VECTOR_NETWORK", @@ -3128,16 +2841,15 @@ "ATTACK_VECTOR_PHYSICAL" ], "enumDescriptions": [ -"Invalid value.", -"The vulnerable component is bound to the network stack and the set of possible attackers extends beyond the other options listed below, up to and including the entire Internet.", -"The vulnerable component is bound to the network stack, but the attack is limited at the protocol level to a logically adjacent topology.", -"The vulnerable component is not bound to the network stack and the attacker's path is via read/write/execute capabilities.", -"The attack requires the attacker to physically touch or manipulate the vulnerable component." +"", +"", +"", +"", +"" ], "type": "string" }, "availabilityImpact": { -"description": "This metric measures the impact to the availability of the impacted component resulting from a successfully exploited vulnerability.", "enum": [ "IMPACT_UNSPECIFIED", "IMPACT_HIGH", @@ -3145,20 +2857,18 @@ "IMPACT_NONE" ], "enumDescriptions": [ -"Invalid value.", -"High impact.", -"Low impact.", -"No impact." +"", +"", +"", +"" ], "type": "string" }, "baseScore": { -"description": "The base score is a function of the base metric scores.", "format": "double", "type": "number" }, "confidentialityImpact": { -"description": "This metric measures the impact to the confidentiality of the information resources managed by a software component due to a successfully exploited vulnerability.", "enum": [ "IMPACT_UNSPECIFIED", "IMPACT_HIGH", @@ -3166,15 +2876,14 @@ "IMPACT_NONE" ], "enumDescriptions": [ -"Invalid value.", -"High impact.", -"Low impact.", -"No impact." +"", +"", +"", +"" ], "type": "string" }, "integrityImpact": { -"description": "This metric measures the impact to integrity of a successfully exploited vulnerability.", "enum": [ "IMPACT_UNSPECIFIED", "IMPACT_HIGH", @@ -3182,15 +2891,14 @@ "IMPACT_NONE" ], "enumDescriptions": [ -"Invalid value.", -"High impact.", -"Low impact.", -"No impact." +"", +"", +"", +"" ], "type": "string" }, "privilegesRequired": { -"description": "This metric describes the level of privileges an attacker must possess before successfully exploiting the vulnerability.", "enum": [ "PRIVILEGES_REQUIRED_UNSPECIFIED", "PRIVILEGES_REQUIRED_NONE", @@ -3198,38 +2906,36 @@ "PRIVILEGES_REQUIRED_HIGH" ], "enumDescriptions": [ -"Invalid value.", -"The attacker is unauthorized prior to attack, and therefore does not require any access to settings or files of the vulnerable system to carry out an attack.", -"The attacker requires privileges that provide basic user capabilities that could normally affect only settings and files owned by a user. Alternatively, an attacker with Low privileges has the ability to access only non-sensitive resources.", -"The attacker requires privileges that provide significant (e.g., administrative) control over the vulnerable component allowing access to component-wide settings and files." +"", +"", +"", +"" ], "type": "string" }, "scope": { -"description": "The Scope metric captures whether a vulnerability in one vulnerable component impacts resources in components beyond its security scope.", "enum": [ "SCOPE_UNSPECIFIED", "SCOPE_UNCHANGED", "SCOPE_CHANGED" ], "enumDescriptions": [ -"Invalid value.", -"An exploited vulnerability can only affect resources managed by the same security authority.", -"An exploited vulnerability can affect resources beyond the security scope managed by the security authority of the vulnerable component." +"", +"", +"" ], "type": "string" }, "userInteraction": { -"description": "This metric captures the requirement for a human user, other than the attacker, to participate in the successful compromise of the vulnerable component.", "enum": [ "USER_INTERACTION_UNSPECIFIED", "USER_INTERACTION_NONE", "USER_INTERACTION_REQUIRED" ], "enumDescriptions": [ -"Invalid value.", -"The vulnerable system can be exploited without interaction from any user.", -"Successful exploitation of this vulnerability requires a user to take some action before the vulnerability can be exploited." +"", +"", +"" ], "type": "string" } @@ -3237,15 +2943,12 @@ "type": "object" }, "Cwe": { -"description": "CWE stands for Common Weakness Enumeration. Information about this weakness, as described by [CWE](https://cwe.mitre.org/).", "id": "Cwe", "properties": { "id": { -"description": "The CWE identifier, e.g. CWE-94", "type": "string" }, "references": { -"description": "Any reference to the details on the CWE, for example, https://cwe.mitre.org/data/definitions/94.html", "items": { "$ref": "Reference" }, @@ -3255,20 +2958,16 @@ "type": "object" }, "DataAccessEvent": { -"description": "Details about a data access attempt made by a principal not authorized under applicable data security policy.", "id": "DataAccessEvent", "properties": { "eventId": { -"description": "Unique identifier for data access event.", "type": "string" }, "eventTime": { -"description": "Timestamp of data access event.", "format": "google-datetime", "type": "string" }, "operation": { -"description": "The operation performed by the principal to access the data.", "enum": [ "OPERATION_UNSPECIFIED", "READ", @@ -3276,35 +2975,30 @@ "COPY" ], "enumDescriptions": [ -"The operation is unspecified.", -"Represents a read operation.", -"Represents a move operation.", -"Represents a copy operation." +"", +"", +"", +"" ], "type": "string" }, "principalEmail": { -"description": "The email address of the principal that accessed the data. The principal could be a user account, service account, Google group, or other.", "type": "string" } }, "type": "object" }, "DataFlowEvent": { -"description": "Details about a data flow event, in which either the data is moved to or is accessed from a non-compliant geo-location, as defined in the applicable data security policy.", "id": "DataFlowEvent", "properties": { "eventId": { -"description": "Unique identifier for data flow event.", "type": "string" }, "eventTime": { -"description": "Timestamp of data flow event.", "format": "google-datetime", "type": "string" }, "operation": { -"description": "The operation performed by the principal for the data flow event.", "enum": [ "OPERATION_UNSPECIFIED", "READ", @@ -3312,40 +3006,34 @@ "COPY" ], "enumDescriptions": [ -"The operation is unspecified.", -"Represents a read operation.", -"Represents a move operation.", -"Represents a copy operation." +"", +"", +"", +"" ], "type": "string" }, "principalEmail": { -"description": "The email address of the principal that initiated the data flow event. The principal could be a user account, service account, Google group, or other.", "type": "string" }, "violatedLocation": { -"description": "Non-compliant location of the principal or the data destination.", "type": "string" } }, "type": "object" }, "DataRetentionDeletionEvent": { -"description": "Details about data retention deletion violations, in which the data is non-compliant based on their retention or deletion time, as defined in the applicable data security policy. The Data Retention Deletion (DRD) control is a control of the DSPM (Data Security Posture Management) suite that enables organizations to manage data retention and deletion policies in compliance with regulations, such as GDPR and CRPA. DRD supports two primary policy types: maximum storage length (max TTL) and minimum storage length (min TTL). Both are aimed at helping organizations meet regulatory and data management commitments.", "id": "DataRetentionDeletionEvent", "properties": { "dataObjectCount": { -"description": "Number of objects that violated the policy for this resource. If the number is less than 1,000, then the value of this field is the exact number. If the number of objects that violated the policy is greater than or equal to 1,000, then the value of this field is 1000.", "format": "int64", "type": "string" }, "eventDetectionTime": { -"description": "Timestamp indicating when the event was detected.", "format": "google-datetime", "type": "string" }, "eventType": { -"description": "Type of the DRD event.", "enum": [ "EVENT_TYPE_UNSPECIFIED", "EVENT_TYPE_MAX_TTL_EXCEEDED", @@ -3361,21 +3049,19 @@ false, false ], "enumDescriptions": [ -"Unspecified event type.", -"Deprecated: This field is pending removal. Use EVENT_TYPE_MAX_TTL_FROM_CREATION or EVENT_TYPE_MAX_TTL_FROM_LAST_MODIFICATION instead.", -"Max TTL from the asset's creation time.", -"Max TTL from the asset's last modification time.", -"Min TTL from the asset's creation time." +"", +"", +"", +"", +"" ], "type": "string" }, "maxRetentionAllowed": { -"description": "Maximum duration of retention allowed from the DRD control. This comes from the DRD control where users set a max TTL for their data. For example, suppose that a user sets the max TTL for a Cloud Storage bucket to 90 days. However, an object in that bucket is 100 days old. In this case, a DataRetentionDeletionEvent will be generated for that Cloud Storage bucket, and the max_retention_allowed is 90 days.", "format": "google-duration", "type": "string" }, "minRetentionAllowed": { -"description": "Min duration of retention allowed from the DSPM retention control. This field is only populated when event type is set to EVENT_TYPE_MIN_TTL_FROM_CREATION.", "format": "google-duration", "type": "string" } @@ -3383,64 +3069,51 @@ false "type": "object" }, "Database": { -"description": "Represents database access information, such as queries. A database may be a sub-resource of an instance (as in the case of Cloud SQL instances or Cloud Spanner instances), or the database instance itself. Some database resources might not have the [full resource name](https://google.aip.dev/122#full-resource-names) populated because these resource types, such as Cloud SQL databases, are not yet supported by Cloud Asset Inventory. In these cases only the display name is provided.", "id": "Database", "properties": { "displayName": { -"description": "The human-readable name of the database that the user connected to.", "type": "string" }, "grantees": { -"description": "The target usernames, roles, or groups of an SQL privilege grant, which is not an IAM policy change.", "items": { "type": "string" }, "type": "array" }, "name": { -"description": "Some database resources may not have the [full resource name](https://google.aip.dev/122#full-resource-names) populated because these resource types are not yet supported by Cloud Asset Inventory (e.g. Cloud SQL databases). In these cases only the display name will be provided. The [full resource name](https://google.aip.dev/122#full-resource-names) of the database that the user connected to, if it is supported by Cloud Asset Inventory.", "type": "string" }, "query": { -"description": "The SQL statement that is associated with the database access.", "type": "string" }, "userName": { -"description": "The username used to connect to the database. The username might not be an IAM principal and does not have a set format.", "type": "string" }, "version": { -"description": "The version of the database, for example, POSTGRES_14. See [the complete list](https://cloud.google.com/sql/docs/mysql/admin-api/rest/v1/SqlDatabaseVersion).", "type": "string" } }, "type": "object" }, "Dataset": { -"description": "Vertex AI dataset associated with the finding.", "id": "Dataset", "properties": { "displayName": { -"description": "The user defined display name of dataset, e.g. plants-dataset", "type": "string" }, "name": { -"description": "Resource name of the dataset, e.g. projects/{project}/locations/{location}/datasets/2094040236064505856", "type": "string" }, "source": { -"description": "Data source, such as BigQuery source URI, e.g. bq://scc-nexus-test.AIPPtest.gsod", "type": "string" } }, "type": "object" }, "Denied": { -"description": "Denied IP rule.", "id": "Denied", "properties": { "ipRules": { -"description": "Optional. Optional list of denied IP rules.", "items": { "$ref": "IpRule" }, @@ -3450,36 +3123,38 @@ false "type": "object" }, "Details": { -"description": "Details of a subscription.", "id": "Details", "properties": { "endTime": { -"description": "The time the subscription has or will end.", "format": "google-datetime", "type": "string" }, "startTime": { -"description": "The time the subscription has or will start.", "format": "google-datetime", "type": "string" }, "type": { -"description": "The type of subscription", "enum": [ "TYPE_UNSPECIFIED", "STANDARD", "TRIAL", "ALPHA", "DEMO", -"PAY_AS_YOU_GO" +"PAY_AS_YOU_GO", +"SUBSCRIPTION", +"SUB_FIXED", +"SUB_BASE_OVERAGE" ], "enumDescriptions": [ -"Default value. This value is unused.", -"The standard subscription.", -"The trial subscription.", -"The alpha subscription.", -"The demo subscription for channel partners.", -"Pay-as-you-go subscription." +"", +"", +"", +"", +"", +"", +"", +"", +"" ], "type": "string" } @@ -3487,15 +3162,12 @@ false "type": "object" }, "Detection": { -"description": "Memory hash detection contributing to the binary family match.", "id": "Detection", "properties": { "binary": { -"description": "The name of the binary associated with the memory hash signature detection.", "type": "string" }, "percentPagesMatched": { -"description": "The percentage of memory page hashes in the signature that were matched.", "format": "double", "type": "number" } @@ -3503,35 +3175,29 @@ false "type": "object" }, "DiscoveredWorkload": { -"description": "Represents discovered, customer managed workload that is not registered with the respective GCP service.", "id": "DiscoveredWorkload", "properties": { "confidence": { -"description": "The confidence in detection of this workload.", "enum": [ "CONFIDENCE_UNSPECIFIED", "CONFIDENCE_HIGH" ], "enumDescriptions": [ -"Unspecified confidence level.", -"High confidence in detection of a workload." +"", +"" ], "type": "string" }, "detectedRelevantHardware": { -"description": "A boolean flag set to true if associated hardware strongly predicts the workload type.", "type": "boolean" }, "detectedRelevantKeywords": { -"description": "A boolean flag set to true if associated keywords strongly predict the workload type.", "type": "boolean" }, "detectedRelevantPackages": { -"description": "A boolean flag set to true if installed packages strongly predict the workload type.", "type": "boolean" }, "workloadType": { -"description": "The type of workload.", "enum": [ "WORKLOAD_TYPE_UNSPECIFIED", "MCP_SERVER", @@ -3539,10 +3205,10 @@ false "AGENT" ], "enumDescriptions": [ -"Unspecified workload type", -"A workload of type MCP Server", -"A workload of type AI Inference", -"A workload of type LLM Agent" +"", +"", +"", +"" ], "type": "string" } @@ -3550,79 +3216,64 @@ false "type": "object" }, "Disk": { -"description": "Contains information about the disk associated with the finding.", "id": "Disk", "properties": { "name": { -"description": "The name of the disk, for example, \"https://www.googleapis.com/compute/v1/projects/{project-id}/zones/{zone-id}/disks/{disk-id}\".", "type": "string" } }, "type": "object" }, "DiskPath": { -"description": "Path of the file in terms of underlying disk/partition identifiers.", "id": "DiskPath", "properties": { "partitionUuid": { -"description": "UUID of the partition (format https://wiki.archlinux.org/title/persistent_block_device_naming#by-uuid)", "type": "string" }, "relativePath": { -"description": "Relative path of the file in the partition as a JSON encoded string. Example: /home/user1/executable_file.sh", "type": "string" } }, "type": "object" }, "DynamicMuteRecord": { -"description": "The record of a dynamic mute rule that matches the finding.", "id": "DynamicMuteRecord", "properties": { "matchTime": { -"description": "When the dynamic mute rule first matched the finding.", "format": "google-datetime", "type": "string" }, "muteConfig": { -"description": "The relative resource name of the mute rule, represented by a mute config, that created this record, for example `organizations/123/muteConfigs/mymuteconfig` or `organizations/123/locations/global/muteConfigs/mymuteconfig`.", "type": "string" } }, "type": "object" }, "EnvironmentVariable": { -"description": "A name-value pair representing an environment variable used in an operating system process.", "id": "EnvironmentVariable", "properties": { "name": { -"description": "Environment variable name as a JSON encoded string.", "type": "string" }, "val": { -"description": "Environment variable value as a JSON encoded string.", "type": "string" } }, "type": "object" }, "EventThreatDetectionSettings": { -"description": "Resource capturing the settings for the Event Threat Detection service.", "id": "EventThreatDetectionSettings", "properties": { "modules": { "additionalProperties": { "$ref": "Config" }, -"description": "The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's configuration.", "type": "object" }, "name": { -"description": "Identifier. The resource name of the EventThreatDetectionSettings. Formats: * organizations/{organization}/eventThreatDetectionSettings * folders/{folder}/eventThreatDetectionSettings * projects/{project}/eventThreatDetectionSettings", "type": "string" }, "serviceEnablementState": { -"description": "The state of enablement for the service at its level of the resource hierarchy. A DISABLED state will override all module enablement_states to DISABLED.", "enum": [ "ENABLEMENT_STATE_UNSPECIFIED", "INHERITED", @@ -3630,15 +3281,14 @@ false "DISABLED" ], "enumDescriptions": [ -"Default value. This value is unused.", -"State is inherited from the parent resource.", -"State is enabled.", -"State is disabled." +"", +"", +"", +"" ], "type": "string" }, "updateTime": { -"description": "Output only. The time the settings were last updated.", "format": "google-datetime", "readOnly": true, "type": "string" @@ -3647,43 +3297,36 @@ false "type": "object" }, "ExfilResource": { -"description": "Resource where data was exfiltrated from or exfiltrated to.", "id": "ExfilResource", "properties": { "components": { -"description": "Subcomponents of the asset that was exfiltrated, like URIs used during exfiltration, table names, databases, and filenames. For example, multiple tables might have been exfiltrated from the same Cloud SQL instance, or multiple files might have been exfiltrated from the same Cloud Storage bucket.", "items": { "type": "string" }, "type": "array" }, "name": { -"description": "The resource's [full resource name](https://cloud.google.com/apis/design/resource_names#full_resource_name).", "type": "string" } }, "type": "object" }, "Exfiltration": { -"description": "Exfiltration represents a data exfiltration attempt from one or more sources to one or more targets. The `sources` attribute lists the sources of the exfiltrated data. The `targets` attribute lists the destinations the data was copied to.", "id": "Exfiltration", "properties": { "sources": { -"description": "If there are multiple sources, then the data is considered \"joined\" between them. For instance, BigQuery can join multiple tables, and each table would be considered a source.", "items": { "$ref": "ExfilResource" }, "type": "array" }, "targets": { -"description": "If there are multiple targets, each target would get a complete copy of the \"joined\" source data.", "items": { "$ref": "ExfilResource" }, "type": "array" }, "totalExfiltratedBytes": { -"description": "Total exfiltrated bytes processed for the entire job.", "format": "int64", "type": "string" } @@ -3691,15 +3334,12 @@ false "type": "object" }, "ExportFindingsMetadata": { -"description": "The LRO metadata for a ExportFindings request.", "id": "ExportFindingsMetadata", "properties": { "bigQueryDestination": { -"$ref": "BigQueryDestination", -"description": "Required. The destination BigQuery dataset to export findings to." +"$ref": "BigQueryDestination" }, "exportStartTime": { -"description": "Optional. Timestamp at which export was started", "format": "google-datetime", "type": "string" } @@ -3707,176 +3347,139 @@ false "type": "object" }, "ExportFindingsResponse": { -"description": "The response to a ExportFindings request. Contains the LRO information.", "id": "ExportFindingsResponse", "properties": {}, "type": "object" }, "Expr": { -"description": "Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: \"Summary size limit\" description: \"Determines if a summary is less than 100 chars\" expression: \"document.summary.size() < 100\" Example (Equality): title: \"Requestor is owner\" description: \"Determines if requestor is the document owner\" expression: \"document.owner == request.auth.claims.email\" Example (Logic): title: \"Public documents\" description: \"Determine whether the document should be publicly visible\" expression: \"document.type != 'private' && document.type != 'internal'\" Example (Data Manipulation): title: \"Notification string\" description: \"Create a notification string with a timestamp.\" expression: \"'New message received at ' + string(document.create_time)\" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information.", "id": "Expr", "properties": { "description": { -"description": "Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.", "type": "string" }, "expression": { -"description": "Textual representation of an expression in Common Expression Language syntax.", "type": "string" }, "location": { -"description": "Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.", "type": "string" }, "title": { -"description": "Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.", "type": "string" } }, "type": "object" }, "ExternalExposure": { -"description": "Details about the externally exposed resource associated with the finding.", "id": "ExternalExposure", "properties": { "backendBucket": { -"description": "The full resource name of the load balancer backend bucket, for example, \"//compute.googleapis.com/projects/{project-id}/global/backendBuckets/{name}\"", "type": "string" }, "backendService": { -"description": "The full resource name of load balancer backend service, for example, \"//compute.googleapis.com/projects/{project-id}/global/backendServices/{name}\".", "type": "string" }, "exposedApplication": { -"description": "The name and version of the exposed web application, for example, \"Jenkins 2.184\".", "type": "string" }, "exposedEndpoint": { -"description": "The resource which is running the exposed service, for example, \"//compute.googleapis.com/projects/{project-id}/zones/{zone}/instances/{instance}.\u201d", "type": "string" }, "exposedService": { -"description": "The name and version of the service, for example, \"Jupyter Notebook 6.14.0\".", "type": "string" }, "forwardingRule": { -"description": "The full resource name of the forwarding rule, for example, \"//compute.googleapis.com/projects/{project-id}/global/forwardingRules/{forwarding-rule-name}\".", "type": "string" }, "hostnameUri": { -"description": "Hostname of the exposed application, for example, \"https://test-app.a.run.app/\"", "type": "string" }, "httpResponse": { -"description": "The http response returned by the web application.", "items": { "$ref": "HttpResponse" }, "type": "array" }, "instanceGroup": { -"description": "The full resource name of the instance group, for example, \"//compute.googleapis.com/projects/{project-id}/global/instanceGroups/{name}\".", "type": "string" }, "internalBackendService": { -"description": "The full resource name of load balancer backend service in the internal project having resource exposed via PSC, for example, \"//compute.googleapis.com/projects/{project-id}/global/backendServices/{name}\".", "type": "string" }, "loadBalancerFirewallPolicy": { -"description": "The full resource name of the load balancer firewall policy, for example, \"//compute.googleapis.com/projects/{project-id}/global/firewallPolicies/{policy-name}\".", "type": "string" }, "networkEndpointGroup": { -"description": "The full resource name of the network endpoint group, for example, \"//compute.googleapis.com/projects/{project-id}/global/networkEndpointGroups/{name}\".", "type": "string" }, "networkIngressFirewallPolicy": { -"description": "The full resource name of the network ingress firewall policy, for example, \"//compute.googleapis.com/projects/{project-id}/global/firewallPolicies/{name}\".", "type": "string" }, "privateIpAddress": { -"description": "Private IP address of the exposed endpoint.", "type": "string" }, "privatePort": { -"description": "Port number associated with private IP address.", "type": "string" }, "pscNetworkAttachment": { -"description": "The full resource name of the PSC (Private Service Connect) network attachment that network interface controller is attached to, for example, \"//compute.googleapis.com/projects/{project-id}/regions/{region}/networkAttachments/{name}\"", "type": "string" }, "pscServiceAttachment": { -"description": "The full resource name of the PSC (Private Service Connect) service attachment that the load balancer network endpoint group targets, for example, \"//compute.googleapis.com/projects/{project-id}/regions/{region}/serviceAttachments/{name}\"", "type": "string" }, "publicIpAddress": { -"description": "Public IP address of the exposed endpoint.", "type": "string" }, "publicPort": { -"description": "Public port number of the exposed endpoint.", "type": "string" }, "serviceFirewallPolicy": { -"description": "The full resource name of the firewall policy of the exposed service, for example, \"//compute.googleapis.com/projects/{project-id}/global/firewallPolicies/{policy-name}\".", "type": "string" } }, "type": "object" }, "File": { -"description": "File information about the related binary/library used by an executable, or the script used by a script interpreter", "id": "File", "properties": { "contents": { -"description": "Prefix of the file contents as a JSON-encoded string.", "type": "string" }, "diskPath": { -"$ref": "DiskPath", -"description": "Path of the file in terms of underlying disk/partition identifiers." +"$ref": "DiskPath" }, "fileLoadState": { -"description": "The load state of the file.", "enum": [ "FILE_LOAD_STATE_UNSPECIFIED", "LOADED_BY_PROCESS", "NOT_LOADED_BY_PROCESS" ], "enumDescriptions": [ -"The file state is unspecified.", -"The file is being used by an active process at the time of scanning.", -"The file is not being used by any active process at the time of scanning." +"", +"", +"" ], "type": "string" }, "hashedSize": { -"description": "The length in bytes of the file prefix that was hashed. If hashed_size == size, any hashes reported represent the entire file.", "format": "int64", "type": "string" }, "operations": { -"description": "Operation(s) performed on a file.", "items": { "$ref": "FileOperation" }, "type": "array" }, "partiallyHashed": { -"description": "True when the hash covers only a prefix of the file.", "type": "boolean" }, "path": { -"description": "Absolute path of the file as a JSON encoded string.", "type": "string" }, "sha256": { -"description": "SHA256 hash of the first hashed_size bytes of the file encoded as a hex string. If hashed_size == size, sha256 represents the SHA256 hash of the entire file.", "type": "string" }, "size": { -"description": "Size of the file in bytes.", "format": "int64", "type": "string" } @@ -3884,11 +3487,9 @@ false "type": "object" }, "FileOperation": { -"description": "Operation(s) performed on a file.", "id": "FileOperation", "properties": { "type": { -"description": "The type of the operation", "enum": [ "OPERATION_TYPE_UNSPECIFIED", "OPEN", @@ -3898,12 +3499,12 @@ false "EXECUTE" ], "enumDescriptions": [ -"The operation is unspecified.", -"Represents an open operation.", -"Represents a read operation.", -"Represents a rename operation.", -"Represents a write operation.", -"Represents an execute operation." +"", +"", +"", +"", +"", +"" ], "type": "string" } @@ -3911,81 +3512,63 @@ false "type": "object" }, "Finding": { -"description": "Security Command Center finding. A finding is a record of assessment data like security, risk, health, or privacy, that is ingested into Security Command Center for presentation, notification, analysis, policy testing, and enforcement. For example, a cross-site scripting (XSS) vulnerability in an App Engine application is a finding.", "id": "Finding", "properties": { "access": { -"$ref": "Access", -"description": "Access details associated with the finding, such as more information on the caller, which method was accessed, and from where." +"$ref": "Access" }, "affectedResources": { -"$ref": "AffectedResources", -"description": "AffectedResources associated with the finding." +"$ref": "AffectedResources" }, "agentDataAccessEvents": { -"description": "Agent data access events associated with the finding.", "items": { "$ref": "AgentDataAccessEvent" }, "type": "array" }, "aiModel": { -"$ref": "AiModel", -"description": "The AI model associated with the finding." +"$ref": "AiModel" }, "application": { -"$ref": "Application", -"description": "Represents an application associated with the finding." +"$ref": "Application" }, "artifactGuardPolicies": { -"$ref": "ArtifactGuardPolicies", -"description": "ArtifactGuardPolicies associated with the finding." +"$ref": "ArtifactGuardPolicies" }, "attackExposure": { -"$ref": "AttackExposure", -"description": "The results of an attack path simulation relevant to this finding." +"$ref": "AttackExposure" }, "backupDisasterRecovery": { -"$ref": "BackupDisasterRecovery", -"description": "Fields related to Backup and DR findings." +"$ref": "BackupDisasterRecovery" }, "canonicalName": { -"description": "The canonical name of the finding. It's either \"organizations/{organization_id}/sources/{source_id}/findings/{finding_id}\", \"folders/{folder_id}/sources/{source_id}/findings/{finding_id}\" or \"projects/{project_number}/sources/{source_id}/findings/{finding_id}\", depending on the closest CRM ancestor of the resource associated with the finding.", "type": "string" }, "category": { -"description": "The additional taxonomy group within findings from a given source. This field is immutable after creation time. Example: \"XSS_FLASH_INJECTION\"", "type": "string" }, "chokepoint": { -"$ref": "Chokepoint", -"description": "Contains details about a chokepoint, which is a resource or resource group where high-risk attack paths converge, based on [attack path simulations] (https://cloud.google.com/security-command-center/docs/attack-exposure-learn#attack_path_simulations). This field cannot be updated. Its value is ignored in all update requests." +"$ref": "Chokepoint" }, "cloudArmor": { -"$ref": "CloudArmor", -"description": "Fields related to Cloud Armor findings." +"$ref": "CloudArmor" }, "cloudDlpDataProfile": { -"$ref": "CloudDlpDataProfile", -"description": "Cloud DLP data profile that is associated with the finding." +"$ref": "CloudDlpDataProfile" }, "cloudDlpInspection": { -"$ref": "CloudDlpInspection", -"description": "Cloud Data Loss Prevention (Cloud DLP) inspection results that are associated with the finding." +"$ref": "CloudDlpInspection" }, "complianceDetails": { -"$ref": "ComplianceDetails", -"description": "Details about the compliance implications of the finding." +"$ref": "ComplianceDetails" }, "compliances": { -"description": "Contains compliance information for security standards associated to the finding.", "items": { "$ref": "Compliance" }, "type": "array" }, "connections": { -"description": "Contains information about the IP connection associated with the finding.", "items": { "$ref": "Connection" }, @@ -3995,93 +3578,76 @@ false "additionalProperties": { "$ref": "ContactDetails" }, -"description": "Output only. Map containing the points of contact for the given finding. The key represents the type of contact, while the value contains a list of all the contacts that pertain. Please refer to: https://cloud.google.com/resource-manager/docs/managing-notification-contacts#notification-categories { \"security\": { \"contacts\": [ { \"email\": \"person1@company.com\" }, { \"email\": \"person2@company.com\" } ] } }", "readOnly": true, "type": "object" }, "containers": { -"description": "Containers associated with the finding. This field provides information for both Kubernetes and non-Kubernetes containers.", "items": { "$ref": "Container" }, "type": "array" }, "createTime": { -"description": "The time at which the finding was created in Security Command Center.", "format": "google-datetime", "type": "string" }, "dataAccessEvents": { -"description": "Data access events associated with the finding.", "items": { "$ref": "DataAccessEvent" }, "type": "array" }, "dataFlowEvents": { -"description": "Data flow events associated with the finding.", "items": { "$ref": "DataFlowEvent" }, "type": "array" }, "dataRetentionDeletionEvents": { -"description": "Data retention deletion events associated with the finding.", "items": { "$ref": "DataRetentionDeletionEvent" }, "type": "array" }, "database": { -"$ref": "Database", -"description": "Database associated with the finding." +"$ref": "Database" }, "description": { -"description": "Contains more details about the finding.", "type": "string" }, "discoveredWorkload": { -"$ref": "DiscoveredWorkload", -"description": "DiscoveredWorkload associated with the finding." +"$ref": "DiscoveredWorkload" }, "disk": { -"$ref": "Disk", -"description": "Disk associated with the finding." +"$ref": "Disk" }, "eventTime": { -"description": "The time the finding was first detected. If an existing finding is updated, then this is the time the update occurred. For example, if the finding represents an open firewall, this property captures the time the detector believes the firewall became open. The accuracy is determined by the detector. If the finding is later resolved, then this time reflects when the finding was resolved. This must not be set to a value greater than the current timestamp.", "format": "google-datetime", "type": "string" }, "exfiltration": { -"$ref": "Exfiltration", -"description": "Represents exfiltrations associated with the finding." +"$ref": "Exfiltration" }, "externalExposure": { -"$ref": "ExternalExposure", -"description": "External exposure associated with the finding." +"$ref": "ExternalExposure" }, "externalSystems": { "additionalProperties": { "$ref": "GoogleCloudSecuritycenterV1ExternalSystem" }, -"description": "Output only. Third party SIEM/SOAR fields within SCC, contains external system information and external system finding fields.", "readOnly": true, "type": "object" }, "externalUri": { -"description": "The URI that, if available, points to a web page outside of Security Command Center where additional information about the finding can be found. This field is guaranteed to be either empty or a well formed URL.", "type": "string" }, "files": { -"description": "File associated with the finding.", "items": { "$ref": "File" }, "type": "array" }, "findingClass": { -"description": "The class of the finding.", "enum": [ "FINDING_CLASS_UNSPECIFIED", "THREAT", @@ -4097,79 +3663,67 @@ false "SECRET" ], "enumDescriptions": [ -"Unspecified finding class.", -"Describes unwanted or malicious activity.", -"Describes a potential weakness in software that increases risk to Confidentiality & Integrity & Availability.", -"Describes a potential weakness in cloud resource/asset configuration that increases risk.", -"Describes a security observation that is for informational purposes.", -"Describes an error that prevents some SCC functionality.", -"Describes a potential security risk due to a change in the security posture.", -"Describes a group of security issues that, when the issues occur together, represent a greater risk than when the issues occur independently. A group of such issues is referred to as a toxic combination.", -"Describes a potential security risk to data assets that contain sensitive data.", -"Describes a resource or resource group where high risk attack paths converge, based on attack path simulations (APS).", -"Describes a potential security risk due to the resource being exposed to the internet.", -"Describes a potential security risk due to plaintext credentials, keys, or tokens being exposed in an asset or workload." +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"" ], "type": "string" }, "groupMemberships": { -"description": "Contains details about groups of which this finding is a member. A group is a collection of findings that are related in some way. This field cannot be updated. Its value is ignored in all update requests.", "items": { "$ref": "GroupMembership" }, "type": "array" }, "iamBindings": { -"description": "Represents IAM bindings associated with the finding.", "items": { "$ref": "IamBinding" }, "type": "array" }, "indicator": { -"$ref": "Indicator", -"description": "Represents what's commonly known as an *indicator of compromise* (IoC) in computer forensics. This is an artifact observed on a network or in an operating system that, with high confidence, indicates a computer intrusion. For more information, see [Indicator of compromise](https://en.wikipedia.org/wiki/Indicator_of_compromise)." +"$ref": "Indicator" }, "ipRules": { -"$ref": "IpRules", -"description": "IP rules associated with the finding." +"$ref": "IpRules" }, "job": { -"$ref": "Job", -"description": "Job associated with the finding." +"$ref": "Job" }, "kernelRootkit": { -"$ref": "KernelRootkit", -"description": "Signature of the kernel rootkit." +"$ref": "KernelRootkit" }, "kubernetes": { -"$ref": "Kubernetes", -"description": "Kubernetes resources associated with the finding." +"$ref": "Kubernetes" }, "loadBalancers": { -"description": "The load balancers associated with the finding.", "items": { "$ref": "LoadBalancer" }, "type": "array" }, "logEntries": { -"description": "Log entries that are relevant to the finding.", "items": { "$ref": "LogEntry" }, "type": "array" }, "mitreAttack": { -"$ref": "MitreAttack", -"description": "MITRE ATT&CK tactics and techniques related to this finding. See: https://attack.mitre.org" +"$ref": "MitreAttack" }, "moduleName": { -"description": "Unique identifier of the module which generated the finding. Example: folders/598186756061/securityHealthAnalyticsSettings/customModules/56799441161885", "type": "string" }, "mute": { -"description": "Indicates the mute state of a finding (either muted, unmuted or undefined). Unlike other attributes of a finding, a finding provider shouldn't set the value of mute.", "enum": [ "MUTE_UNSPECIFIED", "MUTED", @@ -4177,93 +3731,76 @@ false "UNDEFINED" ], "enumDescriptions": [ -"Unspecified.", -"Finding has been muted.", -"Finding has been unmuted.", -"Finding has never been muted/unmuted." +"", +"", +"", +"" ], "type": "string" }, "muteInfo": { "$ref": "MuteInfo", -"description": "Output only. The mute information regarding this finding.", "readOnly": true }, "muteInitiator": { -"description": "Records additional information about the mute operation, for example, the [mute configuration](/security-command-center/docs/how-to-mute-findings) that muted the finding and the user who muted the finding.", "type": "string" }, "muteUpdateTime": { -"description": "Output only. The most recent time this finding was muted or unmuted.", "format": "google-datetime", "readOnly": true, "type": "string" }, "name": { -"description": "The [relative resource name](https://cloud.google.com/apis/design/resource_names#relative_resource_name) of the finding. Example: \"organizations/{organization_id}/sources/{source_id}/findings/{finding_id}\", \"folders/{folder_id}/sources/{source_id}/findings/{finding_id}\", \"projects/{project_id}/sources/{source_id}/findings/{finding_id}\".", "type": "string" }, "networks": { -"description": "Represents the VPC networks that the resource is attached to.", "items": { "$ref": "Network" }, "type": "array" }, "nextSteps": { -"description": "Steps to address the finding.", "type": "string" }, "notebook": { -"$ref": "Notebook", -"description": "Notebook associated with the finding." +"$ref": "Notebook" }, "orgPolicies": { -"description": "Contains information about the org policies associated with the finding.", "items": { "$ref": "OrgPolicy" }, "type": "array" }, "parent": { -"description": "The relative resource name of the source the finding belongs to. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name This field is immutable after creation time. For example: \"organizations/{organization_id}/sources/{source_id}\"", "type": "string" }, "parentDisplayName": { -"description": "Output only. The human readable display name of the finding source such as \"Event Threat Detection\" or \"Security Health Analytics\".", "readOnly": true, "type": "string" }, "policyViolationSummary": { -"$ref": "PolicyViolationSummary", -"description": "PolicyViolationSummary associated with the finding." +"$ref": "PolicyViolationSummary" }, "processes": { -"description": "Represents operating system processes associated with the Finding.", "items": { "$ref": "Process" }, "type": "array" }, "resourceName": { -"description": "For findings on Google Cloud resources, the full resource name of the Google Cloud resource this finding is for. See: https://cloud.google.com/apis/design/resource_names#full_resource_name When the finding is for a non-Google Cloud resource, the resourceName can be a customer or partner defined string. This field is immutable after creation time.", "type": "string" }, "secret": { -"$ref": "Secret", -"description": "Secret associated with the finding." +"$ref": "Secret" }, "securityMarks": { "$ref": "SecurityMarks", -"description": "Output only. User specified security marks. These marks are entirely managed by the user and come from the SecurityMarks resource that belongs to the finding.", "readOnly": true }, "securityPosture": { -"$ref": "SecurityPosture", -"description": "The security posture associated with the finding." +"$ref": "SecurityPosture" }, "severity": { -"description": "The severity of the finding. This field is managed by the source that writes the finding.", "enum": [ "SEVERITY_UNSPECIFIED", "CRITICAL", @@ -4272,11 +3809,11 @@ false "LOW" ], "enumDescriptions": [ -"This value is used for findings when a source doesn't write a severity value.", -"Vulnerability: A critical vulnerability is easily discoverable by an external actor, exploitable, and results in the direct ability to execute arbitrary code, exfiltrate data, and otherwise gain additional access and privileges to cloud resources and workloads. Examples include publicly accessible unprotected user data and public SSH access with weak or no passwords. Threat: Indicates a threat that is able to access, modify, or delete data or execute unauthorized code within existing resources.", -"Vulnerability: A high risk vulnerability can be easily discovered and exploited in combination with other vulnerabilities in order to gain direct access and the ability to execute arbitrary code, exfiltrate data, and otherwise gain additional access and privileges to cloud resources and workloads. An example is a database with weak or no passwords that is only accessible internally. This database could easily be compromised by an actor that had access to the internal network. Threat: Indicates a threat that is able to create new computational resources in an environment but not able to access data or execute code in existing resources.", -"Vulnerability: A medium risk vulnerability could be used by an actor to gain access to resources or privileges that enable them to eventually (through multiple steps or a complex exploit) gain access and the ability to execute arbitrary code or exfiltrate data. An example is a service account with access to more projects than it should have. If an actor gains access to the service account, they could potentially use that access to manipulate a project the service account was not intended to. Threat: Indicates a threat that is able to cause operational impact but may not access data or execute unauthorized code.", -"Vulnerability: A low risk vulnerability hampers a security organization's ability to detect vulnerabilities or active threats in their deployment, or prevents the root cause investigation of security issues. An example is monitoring and logs being disabled for resource configurations and access. Threat: Indicates a threat that has obtained minimal access to an environment but is not able to access data, execute code, or create resources." +"", +"", +"", +"", +"" ], "type": "string" }, @@ -4284,59 +3821,49 @@ false "additionalProperties": { "type": "any" }, -"description": "Source specific properties. These properties are managed by the source that writes the finding. The key names in the source_properties map must be between 1 and 255 characters, and must start with a letter and contain alphanumeric characters or underscores only.", "type": "object" }, "state": { -"description": "The state of the finding.", "enum": [ "STATE_UNSPECIFIED", "ACTIVE", "INACTIVE" ], "enumDescriptions": [ -"Unspecified state.", -"The finding requires attention and has not been addressed yet.", -"The finding has been fixed, triaged as a non-issue or otherwise addressed and is no longer active." +"", +"", +"" ], "type": "string" }, "toxicCombination": { -"$ref": "ToxicCombination", -"description": "Contains details about a group of security issues that, when the issues occur together, represent a greater risk than when the issues occur independently. A group of such issues is referred to as a toxic combination. This field cannot be updated. Its value is ignored in all update requests." +"$ref": "ToxicCombination" }, "vertexAi": { -"$ref": "VertexAi", -"description": "VertexAi associated with the finding." +"$ref": "VertexAi" }, "vulnerability": { -"$ref": "Vulnerability", -"description": "Represents vulnerability-specific fields like CVE and CVSS scores. CVE stands for Common Vulnerabilities and Exposures (https://cve.mitre.org/about/)" +"$ref": "Vulnerability" } }, "type": "object" }, "Folder": { -"description": "Message that contains the resource name and display name of a folder resource.", "id": "Folder", "properties": { "resourceFolder": { -"description": "Full resource name of this folder. See: https://cloud.google.com/apis/design/resource_names#full_resource_name", "type": "string" }, "resourceFolderDisplayName": { -"description": "The user defined display name for this folder.", "type": "string" } }, "type": "object" }, "Framework": { -"description": "Compliance framework associated with the finding.", "id": "Framework", "properties": { "category": { -"description": "Category of the framework associated with the finding. E.g. Security Benchmark, or Assured Workloads", "items": { "enum": [ "FRAMEWORK_CATEGORY_UNSPECIFIED", @@ -4347,43 +3874,39 @@ false "CUSTOM_FRAMEWORK" ], "enumDescriptions": [ -"Default value. This value is unused.", -"Security Benchmarks framework", -"Assured Workloads framework", -"Data Security framework", -"Google Best Practices framework", -"A user-created framework" +"", +"", +"", +"", +"", +"" ], "type": "string" }, "type": "array" }, "controls": { -"description": "The controls associated with the framework.", "items": { "$ref": "Control" }, "type": "array" }, "displayName": { -"description": "Display name of the framework. For a standard framework, this will look like e.g. PCI DSS 3.2.1, whereas for a custom framework it can be a user defined string like MyFramework", "type": "string" }, "name": { -"description": "Name of the framework associated with the finding", "type": "string" }, "type": { -"description": "Type of the framework associated with the finding, to specify whether the framework is built-in (pre-defined and immutable) or a custom framework defined by the customer (equivalent to security posture)", "enum": [ "FRAMEWORK_TYPE_UNSPECIFIED", "FRAMEWORK_TYPE_BUILT_IN", "FRAMEWORK_TYPE_CUSTOM" ], "enumDescriptions": [ -"Default value. This value is unused.", -"The framework is a built-in framework if it is created and managed by GCP.", -"The framework is a custom framework if it is created and managed by the user." +"", +"", +"" ], "type": "string" } @@ -4391,11 +3914,9 @@ false "type": "object" }, "GcpMetadata": { -"description": "Google Cloud metadata associated with the resource. Only applicable if the finding's cloud provider is Google Cloud.", "id": "GcpMetadata", "properties": { "folders": { -"description": "Output only. Contains a Folder message for each folder in the assets ancestry. The first folder is the deepest nested folder, and the last folder is the folder directly under the Organization.", "items": { "$ref": "GoogleCloudSecuritycenterV2Folder" }, @@ -4403,77 +3924,61 @@ false "type": "array" }, "organization": { -"description": "The name of the organization that the resource belongs to.", "type": "string" }, "parent": { -"description": "The full resource name of resource's parent.", "type": "string" }, "parentDisplayName": { -"description": "The human readable name of resource's parent.", "type": "string" }, "project": { -"description": "The full resource name of project that the resource belongs to.", "type": "string" }, "projectDisplayName": { -"description": "The project ID that the resource belongs to.", "type": "string" } }, "type": "object" }, "Geolocation": { -"description": "Represents a geographical location for a given access.", "id": "Geolocation", "properties": { "regionCode": { -"description": "A CLDR.", "type": "string" } }, "type": "object" }, "GoogleCloudSecuritycenterV1BigQueryExport": { -"description": "Configures how to deliver Findings to BigQuery Instance.", "id": "GoogleCloudSecuritycenterV1BigQueryExport", "properties": { "createTime": { -"description": "Output only. The time at which the BigQuery export was created. This field is set by the server and will be ignored if provided on export on creation.", "format": "google-datetime", "readOnly": true, "type": "string" }, "dataset": { -"description": "The dataset to write findings' updates to. Its format is \"projects/[project_id]/datasets/[bigquery_dataset_id]\". BigQuery Dataset unique ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_).", "type": "string" }, "description": { -"description": "The description of the export (max of 1024 characters).", "type": "string" }, "filter": { -"description": "Expression that defines the filter to apply across create/update events of findings. The expression is a list of zero or more restrictions combined via logical operators `AND` and `OR`. Parentheses are supported, and `OR` has higher precedence than `AND`. Restrictions have the form ` ` and may have a `-` character in front of them to indicate negation. The fields map to those defined in the corresponding resource. The supported operators are: * `=` for all value types. * `>`, `<`, `>=`, `<=` for integer values. * `:`, meaning substring matching, for strings. The supported value types are: * string literals in quotes. * integer literals without quotes. * boolean literals `true` and `false` without quotes.", "type": "string" }, "mostRecentEditor": { -"description": "Output only. Email address of the user who last edited the BigQuery export. This field is set by the server and will be ignored if provided on export creation or update.", "readOnly": true, "type": "string" }, "name": { -"description": "The relative resource name of this export. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name. Example format: \"organizations/{organization_id}/bigQueryExports/{export_id}\" Example format: \"folders/{folder_id}/bigQueryExports/{export_id}\" Example format: \"projects/{project_id}/bigQueryExports/{export_id}\" This field is provided in responses, and is ignored when provided in create requests.", "type": "string" }, "principal": { -"description": "Output only. The service account that needs permission to create table and upload data to the BigQuery dataset.", "readOnly": true, "type": "string" }, "updateTime": { -"description": "Output only. The most recent time at which the BigQuery export was updated. This field is set by the server and will be ignored if provided on export creation or update.", "format": "google-datetime", "readOnly": true, "type": "string" @@ -4482,23 +3987,18 @@ false "type": "object" }, "GoogleCloudSecuritycenterV1Binding": { -"description": "Represents a Kubernetes RoleBinding or ClusterRoleBinding.", "id": "GoogleCloudSecuritycenterV1Binding", "properties": { "name": { -"description": "Name for the binding.", "type": "string" }, "ns": { -"description": "Namespace for the binding.", "type": "string" }, "role": { -"$ref": "Role", -"description": "The Role or ClusterRole referenced by the binding." +"$ref": "Role" }, "subjects": { -"description": "Represents one or more subjects that are bound to the role. Not always available for PATCH requests.", "items": { "$ref": "Subject" }, @@ -4508,37 +4008,29 @@ false "type": "object" }, "GoogleCloudSecuritycenterV1BulkMuteFindingsResponse": { -"description": "The response to a BulkMute request. Contains the LRO information.", "id": "GoogleCloudSecuritycenterV1BulkMuteFindingsResponse", "properties": {}, "type": "object" }, "GoogleCloudSecuritycenterV1CustomConfig": { -"description": "Defines the properties in a custom module configuration for Security Health Analytics. Use the custom module configuration to create custom detectors that generate custom findings for resources that you specify.", "id": "GoogleCloudSecuritycenterV1CustomConfig", "properties": { "customOutput": { -"$ref": "GoogleCloudSecuritycenterV1CustomOutputSpec", -"description": "Custom output properties." +"$ref": "GoogleCloudSecuritycenterV1CustomOutputSpec" }, "description": { -"description": "Text that describes the vulnerability or misconfiguration that the custom module detects. This explanation is returned with each finding instance to help investigators understand the detected issue. The text must be enclosed in quotation marks.", "type": "string" }, "predicate": { -"$ref": "Expr", -"description": "The CEL expression to evaluate to produce findings. When the expression evaluates to true against a resource, a finding is generated." +"$ref": "Expr" }, "recommendation": { -"description": "An explanation of the recommended steps that security teams can take to resolve the detected issue. This explanation is returned with each finding generated by this module in the `nextSteps` property of the finding JSON.", "type": "string" }, "resourceSelector": { -"$ref": "GoogleCloudSecuritycenterV1ResourceSelector", -"description": "The resource types that the custom module operates on. Each custom module can specify up to 5 resource types." +"$ref": "GoogleCloudSecuritycenterV1ResourceSelector" }, "severity": { -"description": "The severity to assign to findings generated by the module.", "enum": [ "SEVERITY_UNSPECIFIED", "CRITICAL", @@ -4547,11 +4039,11 @@ false "LOW" ], "enumDescriptions": [ -"Unspecified severity.", -"Critical severity.", -"High severity.", -"Medium severity.", -"Low severity." +"", +"", +"", +"", +"" ], "type": "string" } @@ -4559,11 +4051,9 @@ false "type": "object" }, "GoogleCloudSecuritycenterV1CustomOutputSpec": { -"description": "A set of optional name-value pairs that define custom source properties to return with each finding that is generated by the custom module. The custom source properties that are defined here are included in the finding JSON under `sourceProperties`.", "id": "GoogleCloudSecuritycenterV1CustomOutputSpec", "properties": { "properties": { -"description": "A list of custom output properties to add to the finding.", "items": { "$ref": "GoogleCloudSecuritycenterV1Property" }, @@ -4573,11 +4063,9 @@ false "type": "object" }, "GoogleCloudSecuritycenterV1EffectiveSecurityHealthAnalyticsCustomModule": { -"description": "An EffectiveSecurityHealthAnalyticsCustomModule is the representation of a Security Health Analytics custom module at a specified level of the resource hierarchy: organization, folder, or project. If a custom module is inherited from a parent organization or folder, the value of the `enablementState` property in EffectiveSecurityHealthAnalyticsCustomModule is set to the value that is effective in the parent, instead of `INHERITED`. For example, if the module is enabled in a parent organization or folder, the effective enablement_state for the module in all child folders or projects is also `enabled`. EffectiveSecurityHealthAnalyticsCustomModule is read-only.", "id": "GoogleCloudSecuritycenterV1EffectiveSecurityHealthAnalyticsCustomModule", "properties": { "cloudProvider": { -"description": "The cloud provider of the custom module.", "enum": [ "CLOUD_PROVIDER_UNSPECIFIED", "GOOGLE_CLOUD_PLATFORM", @@ -4585,40 +4073,36 @@ false "MICROSOFT_AZURE" ], "enumDescriptions": [ -"Unspecified cloud provider.", -"Google Cloud.", -"Amazon Web Services.", -"Microsoft Azure." +"", +"", +"", +"" ], "type": "string" }, "customConfig": { "$ref": "GoogleCloudSecuritycenterV1CustomConfig", -"description": "Output only. The user-specified configuration for the module.", "readOnly": true }, "displayName": { -"description": "Output only. The display name for the custom module. The name must be between 1 and 128 characters, start with a lowercase letter, and contain alphanumeric characters or underscores only.", "readOnly": true, "type": "string" }, "enablementState": { -"description": "Output only. The effective state of enablement for the module at the given level of the hierarchy.", "enum": [ "ENABLEMENT_STATE_UNSPECIFIED", "ENABLED", "DISABLED" ], "enumDescriptions": [ -"Unspecified enablement state.", -"The module is enabled at the given level.", -"The module is disabled at the given level." +"", +"", +"" ], "readOnly": true, "type": "string" }, "name": { -"description": "Output only. The resource name of the custom module. Its format is \"organizations/{organization}/securityHealthAnalyticsSettings/effectiveCustomModules/{customModule}\", or \"folders/{folder}/securityHealthAnalyticsSettings/effectiveCustomModules/{customModule}\", or \"projects/{project}/securityHealthAnalyticsSettings/effectiveCustomModules/{customModule}\"", "readOnly": true, "type": "string" } @@ -4626,116 +4110,94 @@ false "type": "object" }, "GoogleCloudSecuritycenterV1ExternalSystem": { -"description": "Representation of third party SIEM/SOAR fields within SCC.", "id": "GoogleCloudSecuritycenterV1ExternalSystem", "properties": { "assignees": { -"description": "References primary/secondary etc assignees in the external system.", "items": { "type": "string" }, "type": "array" }, "caseCloseTime": { -"description": "The time when the case was closed, as reported by the external system.", "format": "google-datetime", "type": "string" }, "caseCreateTime": { -"description": "The time when the case was created, as reported by the external system.", "format": "google-datetime", "type": "string" }, "casePriority": { -"description": "The priority of the finding's corresponding case in the external system.", "type": "string" }, "caseSla": { -"description": "The SLA of the finding's corresponding case in the external system.", "format": "google-datetime", "type": "string" }, "caseUri": { -"description": "The link to the finding's corresponding case in the external system.", "type": "string" }, "externalSystemUpdateTime": { -"description": "The time when the case was last updated, as reported by the external system.", "format": "google-datetime", "type": "string" }, "externalUid": { -"description": "The identifier that's used to track the finding's corresponding case in the external system.", "type": "string" }, "name": { -"description": "Full resource name of the external system, for example: \"organizations/1234/sources/5678/findings/123456/externalSystems/jira\", \"folders/1234/sources/5678/findings/123456/externalSystems/jira\", \"projects/1234/sources/5678/findings/123456/externalSystems/jira\"", "type": "string" }, "status": { -"description": "The most recent status of the finding's corresponding case, as reported by the external system.", "type": "string" }, "ticketInfo": { -"$ref": "TicketInfo", -"description": "Information about the ticket, if any, that is being used to track the resolution of the issue that is identified by this finding." +"$ref": "TicketInfo" } }, "type": "object" }, "GoogleCloudSecuritycenterV1MuteConfig": { -"description": "A mute config is a Cloud SCC resource that contains the configuration to mute create/update events of findings.", "id": "GoogleCloudSecuritycenterV1MuteConfig", "properties": { "createTime": { -"description": "Output only. The time at which the mute config was created. This field is set by the server and will be ignored if provided on config creation.", "format": "google-datetime", "readOnly": true, "type": "string" }, "description": { -"description": "A description of the mute config.", "type": "string" }, "displayName": { "deprecated": true, -"description": "The human readable name to be displayed for the mute config.", "type": "string" }, "expiryTime": { -"description": "Optional. The expiry of the mute config. Only applicable for dynamic configs. If the expiry is set, when the config expires, it is removed from all findings.", "format": "google-datetime", "type": "string" }, "filter": { -"description": "Required. An expression that defines the filter to apply across create/update events of findings. While creating a filter string, be mindful of the scope in which the mute configuration is being created. E.g., If a filter contains project = X but is created under the project = Y scope, it might not match any findings. The following field and operator combinations are supported: * severity: `=`, `:` * category: `=`, `:` * resource.name: `=`, `:` * resource.project_name: `=`, `:` * resource.project_display_name: `=`, `:` * resource.folders.resource_folder: `=`, `:` * resource.parent_name: `=`, `:` * resource.parent_display_name: `=`, `:` * resource.type: `=`, `:` * finding_class: `=`, `:` * indicator.ip_addresses: `=`, `:` * indicator.domains: `=`, `:`", "type": "string" }, "mostRecentEditor": { -"description": "Output only. Email address of the user who last edited the mute config. This field is set by the server and will be ignored if provided on config creation or update.", "readOnly": true, "type": "string" }, "name": { -"description": "This field will be ignored if provided on config creation. Format `organizations/{organization}/muteConfigs/{mute_config}` `folders/{folder}/muteConfigs/{mute_config}` `projects/{project}/muteConfigs/{mute_config}` `organizations/{organization}/locations/global/muteConfigs/{mute_config}` `folders/{folder}/locations/global/muteConfigs/{mute_config}` `projects/{project}/locations/global/muteConfigs/{mute_config}`", "type": "string" }, "type": { -"description": "Optional. The type of the mute config, which determines what type of mute state the config affects. The static mute state takes precedence over the dynamic mute state. Immutable after creation. STATIC by default if not set during creation.", "enum": [ "MUTE_CONFIG_TYPE_UNSPECIFIED", "STATIC", "DYNAMIC" ], "enumDescriptions": [ -"Unused.", -"A static mute config, which sets the static mute state of future matching findings to muted. Once the static mute state has been set, finding or config modifications will not affect the state.", -"A dynamic mute config, which is applied to existing and future matching findings, setting their dynamic mute state to \"muted\". If the config is updated or deleted, or a matching finding is updated, such that the finding doesn't match the config, the config will be removed from the finding, and the finding's dynamic mute state may become \"unmuted\" (unless other configs still match)." +"", +"", +"" ], "type": "string" }, "updateTime": { -"description": "Output only. The most recent time at which the mute config was updated. This field is set by the server and will be ignored if provided on config creation or update.", "format": "google-datetime", "readOnly": true, "type": "string" @@ -4744,69 +4206,54 @@ false "type": "object" }, "GoogleCloudSecuritycenterV1NotificationMessage": { -"description": "Cloud SCC's Notification", "id": "GoogleCloudSecuritycenterV1NotificationMessage", "properties": { "finding": { -"$ref": "Finding", -"description": "If it's a Finding based notification config, this field will be populated." +"$ref": "Finding" }, "notificationConfigName": { -"description": "Name of the notification config that generated current notification.", "type": "string" }, "resource": { -"$ref": "GoogleCloudSecuritycenterV1Resource", -"description": "The Cloud resource tied to this notification's Finding." +"$ref": "GoogleCloudSecuritycenterV1Resource" } }, "type": "object" }, "GoogleCloudSecuritycenterV1Property": { -"description": "An individual name-value pair that defines a custom source property.", "id": "GoogleCloudSecuritycenterV1Property", "properties": { "name": { -"description": "Name of the property for the custom output.", "type": "string" }, "valueExpression": { -"$ref": "Expr", -"description": "The CEL expression for the custom output. A resource property can be specified to return the value of the property or a text string enclosed in quotation marks." +"$ref": "Expr" } }, "type": "object" }, "GoogleCloudSecuritycenterV1Resource": { -"description": "Information related to the Google Cloud resource.", "id": "GoogleCloudSecuritycenterV1Resource", "properties": { "adcApplication": { -"$ref": "AdcApplication", -"description": "The ADC application associated with the finding." +"$ref": "AdcApplication" }, "adcApplicationTemplate": { -"$ref": "AdcApplicationTemplateRevision", -"description": "The ADC template associated with the finding." +"$ref": "AdcApplicationTemplateRevision" }, "adcSharedTemplate": { -"$ref": "AdcSharedTemplateRevision", -"description": "The ADC shared template associated with the finding." +"$ref": "AdcSharedTemplateRevision" }, "application": { -"$ref": "GoogleCloudSecuritycenterV1ResourceApplication", -"description": "The App Hub application this resource belongs to." +"$ref": "GoogleCloudSecuritycenterV1ResourceApplication" }, "awsMetadata": { -"$ref": "AwsMetadata", -"description": "The AWS metadata associated with the finding." +"$ref": "AwsMetadata" }, "azureMetadata": { -"$ref": "AzureMetadata", -"description": "The Azure metadata associated with the finding." +"$ref": "AzureMetadata" }, "cloudProvider": { -"description": "Indicates which cloud provider the resource resides in.", "enum": [ "CLOUD_PROVIDER_UNSPECIFIED", "GOOGLE_CLOUD_PLATFORM", @@ -4814,19 +4261,17 @@ false "MICROSOFT_AZURE" ], "enumDescriptions": [ -"The cloud provider is unspecified.", -"The cloud provider is Google Cloud.", -"The cloud provider is Amazon Web Services.", -"The cloud provider is Microsoft Azure." +"", +"", +"", +"" ], "type": "string" }, "displayName": { -"description": "The human readable name of the resource.", "type": "string" }, "folders": { -"description": "Output only. Contains a Folder message for each folder in the assets ancestry. The first folder is the deepest nested folder, and the last folder is the folder directly under the Organization.", "items": { "$ref": "Folder" }, @@ -4834,95 +4279,75 @@ false "type": "array" }, "location": { -"description": "The region or location of the service (if applicable).", "type": "string" }, "name": { -"description": "The full resource name of the resource. See: https://cloud.google.com/apis/design/resource_names#full_resource_name", "type": "string" }, "organization": { -"description": "Indicates which organization or tenant in the cloud provider the finding applies to.", "type": "string" }, "parent": { -"description": "The full resource name of resource's parent.", "type": "string" }, "parentDisplayName": { -"description": "The human readable name of resource's parent.", "type": "string" }, "project": { -"description": "The full resource name of project that the resource belongs to.", "type": "string" }, "projectDisplayName": { -"description": "The project ID that the resource belongs to.", "type": "string" }, "resourcePath": { -"$ref": "ResourcePath", -"description": "Provides the path to the resource within the resource hierarchy." +"$ref": "ResourcePath" }, "resourcePathString": { -"description": "A string representation of the resource path. For Google Cloud, it has the format of `organizations/{organization_id}/folders/{folder_id}/folders/{folder_id}/projects/{project_id}` where there can be any number of folders. For AWS, it has the format of `org/{organization_id}/ou/{organizational_unit_id}/ou/{organizational_unit_id}/account/{account_id}` where there can be any number of organizational units. For Azure, it has the format of `mg/{management_group_id}/mg/{management_group_id}/subscription/{subscription_id}/rg/{resource_group_name}` where there can be any number of management groups.", "type": "string" }, "service": { -"description": "The parent service or product from which the resource is provided, for example, GKE or SNS.", "type": "string" }, "type": { -"description": "The full resource type of the resource.", "type": "string" } }, "type": "object" }, "GoogleCloudSecuritycenterV1ResourceApplication": { -"description": "The App Hub Application associated with the finding's resource.", "id": "GoogleCloudSecuritycenterV1ResourceApplication", "properties": { "attributes": { -"$ref": "GoogleCloudSecuritycenterV1ResourceApplicationAttributes", -"description": "Consumer provided attributes for the application" +"$ref": "GoogleCloudSecuritycenterV1ResourceApplicationAttributes" }, "name": { -"description": "The resource name of an Application. Format: `projects/{host-project-id}/locations/{location}/applications/{application-id}`", "type": "string" } }, "type": "object" }, "GoogleCloudSecuritycenterV1ResourceApplicationAttributes": { -"description": "Consumer provided attributes for the application", "id": "GoogleCloudSecuritycenterV1ResourceApplicationAttributes", "properties": { "businessOwners": { -"description": "Business team that ensures user needs are met and value is delivered", "items": { "$ref": "GoogleCloudSecuritycenterV1ResourceApplicationAttributesContactInfo" }, "type": "array" }, "criticality": { -"$ref": "GoogleCloudSecuritycenterV1ResourceApplicationAttributesCriticality", -"description": "User-defined criticality information." +"$ref": "GoogleCloudSecuritycenterV1ResourceApplicationAttributesCriticality" }, "developerOwners": { -"description": "Developer team that owns development and coding.", "items": { "$ref": "GoogleCloudSecuritycenterV1ResourceApplicationAttributesContactInfo" }, "type": "array" }, "environment": { -"$ref": "GoogleCloudSecuritycenterV1ResourceApplicationAttributesEnvironment", -"description": "User-defined environment information." +"$ref": "GoogleCloudSecuritycenterV1ResourceApplicationAttributesEnvironment" }, "operatorOwners": { -"description": "Operator team that ensures runtime and operations.", "items": { "$ref": "GoogleCloudSecuritycenterV1ResourceApplicationAttributesContactInfo" }, @@ -4932,22 +4357,18 @@ false "type": "object" }, "GoogleCloudSecuritycenterV1ResourceApplicationAttributesContactInfo": { -"description": "Contact information of stakeholders.", "id": "GoogleCloudSecuritycenterV1ResourceApplicationAttributesContactInfo", "properties": { "email": { -"description": "Email address of the contacts.", "type": "string" } }, "type": "object" }, "GoogleCloudSecuritycenterV1ResourceApplicationAttributesCriticality": { -"description": "Criticality of the Application, Service, or Workload", "id": "GoogleCloudSecuritycenterV1ResourceApplicationAttributesCriticality", "properties": { "type": { -"description": "Criticality Type.", "enum": [ "CRITICALITY_TYPE_UNSPECIFIED", "MISSION_CRITICAL", @@ -4956,11 +4377,11 @@ false "LOW" ], "enumDescriptions": [ -"Unspecified type.", -"Mission critical service, application or workload.", -"High impact.", -"Medium impact.", -"Low impact." +"", +"", +"", +"", +"" ], "type": "string" } @@ -4968,11 +4389,9 @@ false "type": "object" }, "GoogleCloudSecuritycenterV1ResourceApplicationAttributesEnvironment": { -"description": "Environment of the Application, Service, or Workload", "id": "GoogleCloudSecuritycenterV1ResourceApplicationAttributesEnvironment", "properties": { "type": { -"description": "Environment Type.", "enum": [ "ENVIRONMENT_TYPE_UNSPECIFIED", "PRODUCTION", @@ -4981,11 +4400,11 @@ false "DEVELOPMENT" ], "enumDescriptions": [ -"Unspecified type.", -"Production environment.", -"Staging environment.", -"Test environment.", -"Development environment." +"", +"", +"", +"", +"" ], "type": "string" } @@ -4993,11 +4412,9 @@ false "type": "object" }, "GoogleCloudSecuritycenterV1ResourceSelector": { -"description": "Resource for selecting resource type.", "id": "GoogleCloudSecuritycenterV1ResourceSelector", "properties": { "resourceTypes": { -"description": "The resource types to run the detector on.", "items": { "type": "string" }, @@ -5007,11 +4424,9 @@ false "type": "object" }, "GoogleCloudSecuritycenterV1ResourceValueConfig": { -"description": "A resource value configuration (RVC) is a mapping configuration of user's resources to resource values. Used in Attack path simulations.", "id": "GoogleCloudSecuritycenterV1ResourceValueConfig", "properties": { "cloudProvider": { -"description": "Cloud provider this configuration applies to", "enum": [ "CLOUD_PROVIDER_UNSPECIFIED", "GOOGLE_CLOUD_PLATFORM", @@ -5019,40 +4434,34 @@ false "MICROSOFT_AZURE" ], "enumDescriptions": [ -"The cloud provider is unspecified.", -"The cloud provider is Google Cloud.", -"The cloud provider is Amazon Web Services.", -"The cloud provider is Microsoft Azure." +"", +"", +"", +"" ], "type": "string" }, "createTime": { -"description": "Output only. Timestamp this resource value configuration was created.", "format": "google-datetime", "readOnly": true, "type": "string" }, "description": { -"description": "Description of the resource value configuration.", "type": "string" }, "name": { -"description": "Name for the resource value configuration", "type": "string" }, "resourceLabelsSelector": { "additionalProperties": { "type": "string" }, -"description": "List of resource labels to search for, evaluated with `AND`. For example, `\"resource_labels_selector\": {\"key\": \"value\", \"env\": \"prod\"}` will match resources with labels \"key\": \"value\" `AND` \"env\": \"prod\" https://cloud.google.com/resource-manager/docs/creating-managing-labels", "type": "object" }, "resourceType": { -"description": "Apply resource_value only to resources that match resource_type. resource_type will be checked with `AND` of other resources. For example, \"storage.googleapis.com/Bucket\" with resource_value \"HIGH\" will apply \"HIGH\" value only to \"storage.googleapis.com/Bucket\" resources.", "type": "string" }, "resourceValue": { -"description": "Required. Resource value level this expression represents", "enum": [ "RESOURCE_VALUE_UNSPECIFIED", "HIGH", @@ -5061,31 +4470,27 @@ false "NONE" ], "enumDescriptions": [ -"Unspecific value", -"High resource value", -"Medium resource value", -"Low resource value", -"No resource value, e.g. ignore these resources" +"", +"", +"", +"", +"" ], "type": "string" }, "scope": { -"description": "Project or folder to scope this configuration to. For example, \"project/456\" would apply this configuration only to resources in \"project/456\" scope will be checked with `AND` of other resources.", "type": "string" }, "sensitiveDataProtectionMapping": { -"$ref": "GoogleCloudSecuritycenterV1SensitiveDataProtectionMapping", -"description": "A mapping of the sensitivity on Sensitive Data Protection finding to resource values. This mapping can only be used in combination with a resource_type that is related to BigQuery, e.g. \"bigquery.googleapis.com/Dataset\"." +"$ref": "GoogleCloudSecuritycenterV1SensitiveDataProtectionMapping" }, "tagValues": { -"description": "Required. Tag values combined with `AND` to check against. For Google Cloud resources, they are tag value IDs in the form of \"tagValues/123\". Example: `[ \"tagValues/123\", \"tagValues/456\", \"tagValues/789\" ]` https://cloud.google.com/resource-manager/docs/tags/tags-creating-and-managing", "items": { "type": "string" }, "type": "array" }, "updateTime": { -"description": "Output only. Timestamp this resource value configuration was last updated.", "format": "google-datetime", "readOnly": true, "type": "string" @@ -5094,16 +4499,13 @@ false "type": "object" }, "GoogleCloudSecuritycenterV1RunAssetDiscoveryResponse": { -"description": "Response of asset discovery run", "id": "GoogleCloudSecuritycenterV1RunAssetDiscoveryResponse", "properties": { "duration": { -"description": "The duration between asset discovery run start and end", "format": "google-duration", "type": "string" }, "state": { -"description": "The state of an asset discovery run.", "enum": [ "STATE_UNSPECIFIED", "COMPLETED", @@ -5111,10 +4513,10 @@ false "TERMINATED" ], "enumDescriptions": [ -"Asset discovery run state was unspecified.", -"Asset discovery run completed successfully.", -"Asset discovery run was cancelled with tasks still pending, as another run for the same organization was started with a higher priority.", -"Asset discovery run was killed and terminated." +"", +"", +"", +"" ], "type": "string" } @@ -5122,16 +4524,13 @@ false "type": "object" }, "GoogleCloudSecuritycenterV1SecurityHealthAnalyticsCustomModule": { -"description": "Represents an instance of a Security Health Analytics custom module, including its full module name, display name, enablement state, and last updated time. You can create a custom module at the organization, folder, or project level. Custom modules that you create at the organization or folder level are inherited by the child folders and projects.", "id": "GoogleCloudSecuritycenterV1SecurityHealthAnalyticsCustomModule", "properties": { "ancestorModule": { -"description": "Output only. If empty, indicates that the custom module was created in the organization, folder, or project in which you are viewing the custom module. Otherwise, `ancestor_module` specifies the organization or folder from which the custom module is inherited.", "readOnly": true, "type": "string" }, "cloudProvider": { -"description": "The cloud provider of the custom module.", "enum": [ "CLOUD_PROVIDER_UNSPECIFIED", "GOOGLE_CLOUD_PLATFORM", @@ -5139,23 +4538,20 @@ false "MICROSOFT_AZURE" ], "enumDescriptions": [ -"Unspecified cloud provider.", -"Google Cloud.", -"Amazon Web Services (AWS).", -"Microsoft Azure." +"", +"", +"", +"" ], "type": "string" }, "customConfig": { -"$ref": "GoogleCloudSecuritycenterV1CustomConfig", -"description": "The user specified custom configuration for the module." +"$ref": "GoogleCloudSecuritycenterV1CustomConfig" }, "displayName": { -"description": "The display name of the Security Health Analytics custom module. This display name becomes the finding category for all findings that are returned by this custom module. The display name must be between 1 and 128 characters, start with a lowercase letter, and contain alphanumeric characters or underscores only.", "type": "string" }, "enablementState": { -"description": "The enablement state of the custom module.", "enum": [ "ENABLEMENT_STATE_UNSPECIFIED", "ENABLED", @@ -5163,24 +4559,21 @@ false "INHERITED" ], "enumDescriptions": [ -"Unspecified enablement state.", -"The module is enabled at the given CRM resource.", -"The module is disabled at the given CRM resource.", -"State is inherited from an ancestor module. The module will either be effectively ENABLED or DISABLED based on its closest non-inherited ancestor module in the CRM hierarchy." +"", +"", +"", +"" ], "type": "string" }, "lastEditor": { -"description": "Output only. The editor that last updated the custom module.", "readOnly": true, "type": "string" }, "name": { -"description": "Immutable. The resource name of the custom module. Its format is \"organizations/{organization}/securityHealthAnalyticsSettings/customModules/{customModule}\", or \"folders/{folder}/securityHealthAnalyticsSettings/customModules/{customModule}\", or \"projects/{project}/securityHealthAnalyticsSettings/customModules/{customModule}\" The id {customModule} is server-generated and is not user settable. It will be a numeric id containing 1-20 digits.", "type": "string" }, "updateTime": { -"description": "Output only. The time at which the custom module was last updated.", "format": "google-datetime", "readOnly": true, "type": "string" @@ -5189,11 +4582,9 @@ false "type": "object" }, "GoogleCloudSecuritycenterV1SensitiveDataProtectionMapping": { -"description": "Resource value mapping for Sensitive Data Protection findings. If any of these mappings have a resource value that is not unspecified, the resource_value field will be ignored when reading this configuration.", "id": "GoogleCloudSecuritycenterV1SensitiveDataProtectionMapping", "properties": { "highSensitivityMapping": { -"description": "Resource value mapping for high-sensitivity Sensitive Data Protection findings", "enum": [ "RESOURCE_VALUE_UNSPECIFIED", "HIGH", @@ -5202,16 +4593,15 @@ false "NONE" ], "enumDescriptions": [ -"Unspecific value", -"High resource value", -"Medium resource value", -"Low resource value", -"No resource value, e.g. ignore these resources" +"", +"", +"", +"", +"" ], "type": "string" }, "mediumSensitivityMapping": { -"description": "Resource value mapping for medium-sensitivity Sensitive Data Protection findings", "enum": [ "RESOURCE_VALUE_UNSPECIFIED", "HIGH", @@ -5220,11 +4610,11 @@ false "NONE" ], "enumDescriptions": [ -"Unspecific value", -"High resource value", -"Medium resource value", -"Low resource value", -"No resource value, e.g. ignore these resources" +"", +"", +"", +"", +"" ], "type": "string" } @@ -5232,16 +4622,13 @@ false "type": "object" }, "GoogleCloudSecuritycenterV1beta1RunAssetDiscoveryResponse": { -"description": "Response of asset discovery run", "id": "GoogleCloudSecuritycenterV1beta1RunAssetDiscoveryResponse", "properties": { "duration": { -"description": "The duration between asset discovery run start and end", "format": "google-duration", "type": "string" }, "state": { -"description": "The state of an asset discovery run.", "enum": [ "STATE_UNSPECIFIED", "COMPLETED", @@ -5249,10 +4636,10 @@ false "TERMINATED" ], "enumDescriptions": [ -"Asset discovery run state was unspecified.", -"Asset discovery run completed successfully.", -"Asset discovery run was cancelled with tasks still pending, as another run for the same organization was started with a higher priority.", -"Asset discovery run was killed and terminated." +"", +"", +"", +"" ], "type": "string" } @@ -5260,50 +4647,39 @@ false "type": "object" }, "GoogleCloudSecuritycenterV1p1beta1Finding": { -"description": "Security Command Center finding. A finding is a record of assessment data (security, risk, health or privacy) ingested into Security Command Center for presentation, notification, analysis, policy testing, and enforcement. For example, an XSS vulnerability in an App Engine application is a finding.", "id": "GoogleCloudSecuritycenterV1p1beta1Finding", "properties": { "canonicalName": { -"description": "The canonical name of the finding. It's either \"organizations/{organization_id}/sources/{source_id}/findings/{finding_id}\", \"folders/{folder_id}/sources/{source_id}/findings/{finding_id}\" or \"projects/{project_number}/sources/{source_id}/findings/{finding_id}\", depending on the closest CRM ancestor of the resource associated with the finding.", "type": "string" }, "category": { -"description": "The additional taxonomy group within findings from a given source. This field is immutable after creation time. Example: \"XSS_FLASH_INJECTION\"", "type": "string" }, "createTime": { -"description": "The time at which the finding was created in Security Command Center.", "format": "google-datetime", "type": "string" }, "eventTime": { -"description": "The time at which the event took place, or when an update to the finding occurred. For example, if the finding represents an open firewall it would capture the time the detector believes the firewall became open. The accuracy is determined by the detector. If the finding were to be resolved afterward, this time would reflect when the finding was resolved. Must not be set to a value greater than the current timestamp.", "format": "google-datetime", "type": "string" }, "externalUri": { -"description": "The URI that, if available, points to a web page outside of Security Command Center where additional information about the finding can be found. This field is guaranteed to be either empty or a well formed URL.", "type": "string" }, "name": { -"description": "The relative resource name of this finding. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Example: \"organizations/{organization_id}/sources/{source_id}/findings/{finding_id}\"", "type": "string" }, "parent": { -"description": "The relative resource name of the source the finding belongs to. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name This field is immutable after creation time. For example: \"organizations/{organization_id}/sources/{source_id}\"", "type": "string" }, "resourceName": { -"description": "For findings on Google Cloud resources, the full resource name of the Google Cloud resource this finding is for. See: https://cloud.google.com/apis/design/resource_names#full_resource_name When the finding is for a non-Google Cloud resource, the resourceName can be a customer or partner defined string. This field is immutable after creation time.", "type": "string" }, "securityMarks": { "$ref": "GoogleCloudSecuritycenterV1p1beta1SecurityMarks", -"description": "Output only. User specified security marks. These marks are entirely managed by the user and come from the SecurityMarks resource that belongs to the finding.", "readOnly": true }, "severity": { -"description": "The severity of the finding. This field is managed by the source that writes the finding.", "enum": [ "SEVERITY_UNSPECIFIED", "CRITICAL", @@ -5312,11 +4688,11 @@ false "LOW" ], "enumDescriptions": [ -"No severity specified. The default value.", -"Critical severity.", -"High severity.", -"Medium severity.", -"Low severity." +"", +"", +"", +"", +"" ], "type": "string" }, @@ -5324,20 +4700,18 @@ false "additionalProperties": { "type": "any" }, -"description": "Source specific properties. These properties are managed by the source that writes the finding. The key names in the source_properties map must be between 1 and 255 characters, and must start with a letter and contain alphanumeric characters or underscores only.", "type": "object" }, "state": { -"description": "The state of the finding.", "enum": [ "STATE_UNSPECIFIED", "ACTIVE", "INACTIVE" ], "enumDescriptions": [ -"Unspecified state.", -"The finding requires attention and has not been addressed yet.", -"The finding has been fixed, triaged as a non-issue or otherwise addressed and is no longer active." +"", +"", +"" ], "type": "string" } @@ -5345,45 +4719,36 @@ false "type": "object" }, "GoogleCloudSecuritycenterV1p1beta1Folder": { -"description": "Message that contains the resource name and display name of a folder resource.", "id": "GoogleCloudSecuritycenterV1p1beta1Folder", "properties": { "resourceFolder": { -"description": "Full resource name of this folder. See: https://cloud.google.com/apis/design/resource_names#full_resource_name", "type": "string" }, "resourceFolderDisplayName": { -"description": "The user defined display name for this folder.", "type": "string" } }, "type": "object" }, "GoogleCloudSecuritycenterV1p1beta1NotificationMessage": { -"description": "Security Command Center's Notification", "id": "GoogleCloudSecuritycenterV1p1beta1NotificationMessage", "properties": { "finding": { -"$ref": "GoogleCloudSecuritycenterV1p1beta1Finding", -"description": "If it's a Finding based notification config, this field will be populated." +"$ref": "GoogleCloudSecuritycenterV1p1beta1Finding" }, "notificationConfigName": { -"description": "Name of the notification config that generated current notification.", "type": "string" }, "resource": { -"$ref": "GoogleCloudSecuritycenterV1p1beta1Resource", -"description": "The Cloud resource tied to the notification." +"$ref": "GoogleCloudSecuritycenterV1p1beta1Resource" } }, "type": "object" }, "GoogleCloudSecuritycenterV1p1beta1Resource": { -"description": "Information related to the Google Cloud resource.", "id": "GoogleCloudSecuritycenterV1p1beta1Resource", "properties": { "folders": { -"description": "Output only. Contains a Folder message for each folder in the assets ancestry. The first folder is the deepest nested folder, and the last folder is the folder directly under the Organization.", "items": { "$ref": "GoogleCloudSecuritycenterV1p1beta1Folder" }, @@ -5391,39 +4756,31 @@ false "type": "array" }, "name": { -"description": "The full resource name of the resource. See: https://cloud.google.com/apis/design/resource_names#full_resource_name", "type": "string" }, "parent": { -"description": "The full resource name of resource's parent.", "type": "string" }, "parentDisplayName": { -"description": "The human readable name of resource's parent.", "type": "string" }, "project": { -"description": "The full resource name of project that the resource belongs to.", "type": "string" }, "projectDisplayName": { -"description": "The project id that the resource belongs to.", "type": "string" } }, "type": "object" }, "GoogleCloudSecuritycenterV1p1beta1RunAssetDiscoveryResponse": { -"description": "Response of asset discovery run", "id": "GoogleCloudSecuritycenterV1p1beta1RunAssetDiscoveryResponse", "properties": { "duration": { -"description": "The duration between asset discovery run start and end", "format": "google-duration", "type": "string" }, "state": { -"description": "The state of an asset discovery run.", "enum": [ "STATE_UNSPECIFIED", "COMPLETED", @@ -5431,10 +4788,10 @@ false "TERMINATED" ], "enumDescriptions": [ -"Asset discovery run state was unspecified.", -"Asset discovery run completed successfully.", -"Asset discovery run was cancelled with tasks still pending, as another run for the same organization was started with a higher priority.", -"Asset discovery run was killed and terminated." +"", +"", +"", +"" ], "type": "string" } @@ -5442,122 +4799,96 @@ false "type": "object" }, "GoogleCloudSecuritycenterV1p1beta1SecurityMarks": { -"description": "User specified security marks that are attached to the parent Security Command Center resource. Security marks are scoped within a Security Command Center organization -- they can be modified and viewed by all users who have proper permissions on the organization.", "id": "GoogleCloudSecuritycenterV1p1beta1SecurityMarks", "properties": { "canonicalName": { -"description": "The canonical name of the marks. Examples: \"organizations/{organization_id}/assets/{asset_id}/securityMarks\" \"folders/{folder_id}/assets/{asset_id}/securityMarks\" \"projects/{project_number}/assets/{asset_id}/securityMarks\" \"organizations/{organization_id}/sources/{source_id}/findings/{finding_id}/securityMarks\" \"folders/{folder_id}/sources/{source_id}/findings/{finding_id}/securityMarks\" \"projects/{project_number}/sources/{source_id}/findings/{finding_id}/securityMarks\"", "type": "string" }, "marks": { "additionalProperties": { "type": "string" }, -"description": "Mutable user specified security marks belonging to the parent resource. Constraints are as follows: * Keys and values are treated as case insensitive * Keys must be between 1 - 256 characters (inclusive) * Keys must be letters, numbers, underscores, or dashes * Values have leading and trailing whitespace trimmed, remaining characters must be between 1 - 4096 characters (inclusive)", "type": "object" }, "name": { -"description": "The relative resource name of the SecurityMarks. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Examples: \"organizations/{organization_id}/assets/{asset_id}/securityMarks\" \"organizations/{organization_id}/sources/{source_id}/findings/{finding_id}/securityMarks\".", "type": "string" } }, "type": "object" }, "GoogleCloudSecuritycenterV2Access": { -"description": "Represents an access event.", "id": "GoogleCloudSecuritycenterV2Access", "properties": { "callerIp": { -"description": "Caller's IP address, such as \"1.1.1.1\".", "type": "string" }, "callerIpGeo": { -"$ref": "GoogleCloudSecuritycenterV2Geolocation", -"description": "The caller IP's geolocation, which identifies where the call came from." +"$ref": "GoogleCloudSecuritycenterV2Geolocation" }, "methodName": { -"description": "The method that the service account called, e.g. \"SetIamPolicy\".", "type": "string" }, "principalEmail": { -"description": "Associated email, such as \"foo@google.com\". The email address of the authenticated user or a service account acting on behalf of a 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" }, "principalSubject": { -"description": "A string that represents the principal_subject that is associated with the identity. Unlike `principal_email`, `principal_subject` supports principals that aren't associated with email addresses, such as third party principals. For most identities, the format is `principal://iam.googleapis.com/{identity pool name}/subject/{subject}`. Some GKE identities, such as GKE_WORKLOAD, FREEFORM, and GKE_HUB_WORKLOAD, still use the legacy format `serviceAccount:{identity pool name}[{subject}]`.", "type": "string" }, "serviceAccountDelegationInfo": { -"description": "The identity delegation history of an authenticated service account that made the request. The `serviceAccountDelegationInfo[]` object contains information about the real authorities that try to access Google Cloud resources by delegating on a service account. When multiple authorities are present, they are guaranteed to be sorted based on the original ordering of the identity delegation events.", "items": { "$ref": "GoogleCloudSecuritycenterV2ServiceAccountDelegationInfo" }, "type": "array" }, "serviceAccountKeyName": { -"description": "The name of the service account key that was used to create or exchange credentials when authenticating the service account that made the request. This is a scheme-less URI full resource name. For example: \"//iam.googleapis.com/projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}/keys/{key}\". ", "type": "string" }, "serviceName": { -"description": "This is the API service that the service account made a call to, e.g. \"iam.googleapis.com\"", "type": "string" }, "userAgent": { -"description": "The caller's user agent string associated with the finding.", "type": "string" }, "userAgentFamily": { -"description": "Type of user agent associated with the finding. For example, an operating system shell or an embedded or standalone application.", "type": "string" }, "userName": { -"description": "A string that represents a username. The username provided depends on the type of the finding and is likely not an IAM principal. For example, this can be a system username if the finding is related to a virtual machine, or it can be an application login username.", "type": "string" } }, "type": "object" }, "GoogleCloudSecuritycenterV2AccessReview": { -"description": "Conveys information about a Kubernetes access review (such as one returned by a [`kubectl auth can-i`](https://kubernetes.io/docs/reference/access-authn-authz/authorization/#checking-api-access) command) that was involved in a finding.", "id": "GoogleCloudSecuritycenterV2AccessReview", "properties": { "group": { -"description": "The API group of the resource. \"*\" means all.", "type": "string" }, "name": { -"description": "The name of the resource being requested. Empty means all.", "type": "string" }, "ns": { -"description": "Namespace of the action being requested. Currently, there is no distinction between no namespace and all namespaces. Both are represented by \"\" (empty).", "type": "string" }, "resource": { -"description": "The optional resource type requested. \"*\" means all.", "type": "string" }, "subresource": { -"description": "The optional subresource type.", "type": "string" }, "verb": { -"description": "A Kubernetes resource API verb, like get, list, watch, create, update, delete, proxy. \"*\" means all.", "type": "string" }, "version": { -"description": "The API version of the resource. \"*\" means all.", "type": "string" } }, "type": "object" }, "GoogleCloudSecuritycenterV2AdaptiveProtection": { -"description": "Information about [Google Cloud Armor Adaptive Protection](https://cloud.google.com/armor/docs/cloud-armor-overview#google-cloud-armor-adaptive-protection).", "id": "GoogleCloudSecuritycenterV2AdaptiveProtection", "properties": { "confidence": { -"description": "A score of 0 means that there is low confidence that the detected event is an actual attack. A score of 1 means that there is high confidence that the detected event is an attack. See the [Adaptive Protection documentation](https://cloud.google.com/armor/docs/adaptive-protection-overview#configure-alert-tuning) for further explanation.", "format": "double", "type": "number" } @@ -5565,48 +4896,39 @@ false "type": "object" }, "GoogleCloudSecuritycenterV2AdcApplication": { -"description": "Represents an ADC application associated with the finding.", "id": "GoogleCloudSecuritycenterV2AdcApplication", "properties": { "attributes": { -"$ref": "GoogleCloudSecuritycenterV2ResourceApplicationAttributes", -"description": "Consumer provided attributes for the AppHub application." +"$ref": "GoogleCloudSecuritycenterV2ResourceApplicationAttributes" }, "name": { -"description": "The resource name of an ADC Application. Format: projects/{project}/locations/{location}/spaces/{space}/applications/{application}", "type": "string" } }, "type": "object" }, "GoogleCloudSecuritycenterV2AdcApplicationTemplateRevision": { -"description": "Represents an ADC template associated with the finding.", "id": "GoogleCloudSecuritycenterV2AdcApplicationTemplateRevision", "properties": { "name": { -"description": "The resource name of an ADC Application Template Revision. Format: projects/{project}/locations/{location}/spaces/{space}/applicationTemplates/{application_template}/revisions/{revision}", "type": "string" } }, "type": "object" }, "GoogleCloudSecuritycenterV2AdcSharedTemplateRevision": { -"description": "Represents an ADC shared template associated with the finding.", "id": "GoogleCloudSecuritycenterV2AdcSharedTemplateRevision", "properties": { "name": { -"description": "The resource name of an ADC Shared Template Revision. Format: projects/{project}/locations/{location}/spaces/{space}/applicationTemplates/{application_template}/revisions/{revision}", "type": "string" } }, "type": "object" }, "GoogleCloudSecuritycenterV2AffectedResources": { -"description": "Details about resources affected by this finding.", "id": "GoogleCloudSecuritycenterV2AffectedResources", "properties": { "count": { -"description": "The count of resources affected by the finding.", "format": "int64", "type": "string" } @@ -5614,20 +4936,16 @@ false "type": "object" }, "GoogleCloudSecuritycenterV2AgentDataAccessEvent": { -"description": "Details about a data access attempt made by an agent principal not authorized under applicable data security policy.", "id": "GoogleCloudSecuritycenterV2AgentDataAccessEvent", "properties": { "eventId": { -"description": "Unique identifier for data access event.", "type": "string" }, "eventTime": { -"description": "Timestamp of data access event.", "format": "google-datetime", "type": "string" }, "operation": { -"description": "The operation performed by the principal to access the data.", "enum": [ "OPERATION_UNSPECIFIED", "READ", @@ -5635,26 +4953,23 @@ false "COPY" ], "enumDescriptions": [ -"The operation is unspecified.", -"Represents a read operation.", -"Represents a move operation.", -"Represents a copy operation." +"", +"", +"", +"" ], "type": "string" }, "principalSubject": { -"description": "The agent principal that accessed the data.", "type": "string" } }, "type": "object" }, "GoogleCloudSecuritycenterV2AiModel": { -"description": "Contains information about the AI model associated with the finding.", "id": "GoogleCloudSecuritycenterV2AiModel", "properties": { "deploymentPlatform": { -"description": "The platform on which the model is deployed.", "enum": [ "DEPLOYMENT_PLATFORM_UNSPECIFIED", "VERTEX_AI", @@ -5663,51 +4978,42 @@ false "FINE_TUNED_MODEL" ], "enumDescriptions": [ -"Unspecified deployment platform.", -"Vertex AI.", -"Google Kubernetes Engine.", -"Google Compute Engine.", -"Fine tuned model." +"", +"", +"", +"", +"" ], "type": "string" }, "displayName": { -"description": "The user defined display name of model. Ex. baseline-classification-model", "type": "string" }, "domain": { -"description": "The domain of the model, for example, \u201cimage-classification\u201d.", "type": "string" }, "library": { -"description": "The name of the model library, for example, \u201ctransformers\u201d.", "type": "string" }, "location": { -"description": "The region in which the model is used, for example, \u201cus-central1\u201d.", "type": "string" }, "name": { -"description": "The name of the AI model, for example, \"gemini:1.0.0\".", "type": "string" }, "publisher": { -"description": "The publisher of the model, for example, \u201cgoogle\u201d or \u201cnvidia\u201d.", "type": "string" }, "usageCategory": { -"description": "The purpose of the model, for example, \"Inteference\" or \"Training\".", "type": "string" } }, "type": "object" }, "GoogleCloudSecuritycenterV2Allowed": { -"description": "Allowed IP rule.", "id": "GoogleCloudSecuritycenterV2Allowed", "properties": { "ipRules": { -"description": "Optional. Optional list of allowed IP rules.", "items": { "$ref": "GoogleCloudSecuritycenterV2IpRule" }, @@ -5717,59 +5023,49 @@ false "type": "object" }, "GoogleCloudSecuritycenterV2Application": { -"description": "Represents an application associated with a finding.", "id": "GoogleCloudSecuritycenterV2Application", "properties": { "baseUri": { -"description": "The base URI that identifies the network location of the application in which the vulnerability was detected. For example, `http://example.com`.", "type": "string" }, "fullUri": { -"description": "The full URI with payload that could be used to reproduce the vulnerability. For example, `http://example.com?p=aMmYgI6H`.", "type": "string" } }, "type": "object" }, "GoogleCloudSecuritycenterV2ArtifactGuardPolicies": { -"description": "Represents the result of evaluating artifact guard policies.", "id": "GoogleCloudSecuritycenterV2ArtifactGuardPolicies", "properties": { "failingPolicies": { -"description": "A list of failing policies.", "items": { "$ref": "GoogleCloudSecuritycenterV2ArtifactGuardPolicy" }, "type": "array" }, "resourceId": { -"description": "The ID of the resource that has policies configured for it.", "type": "string" } }, "type": "object" }, "GoogleCloudSecuritycenterV2ArtifactGuardPolicy": { -"description": "Represents an artifact guard policy.", "id": "GoogleCloudSecuritycenterV2ArtifactGuardPolicy", "properties": { "failureReason": { -"description": "The reason for the policy failure, for example, \"severity=HIGH AND max_vuln_count=2\".", "type": "string" }, "policyId": { -"description": "The ID of the failing policy, for example, \"organizations/3392779/locations/global/policies/prod-policy\".", "type": "string" }, "type": { -"description": "The type of the policy evaluation.", "enum": [ "ARTIFACT_GUARD_POLICY_TYPE_UNSPECIFIED", "VULNERABILITY" ], "enumDescriptions": [ -"Default value. This value is unused.", -"Vulnerability type." +"", +"" ], "type": "string" } @@ -5777,32 +5073,26 @@ false "type": "object" }, "GoogleCloudSecuritycenterV2Attack": { -"description": "Information about DDoS attack volume and classification.", "id": "GoogleCloudSecuritycenterV2Attack", "properties": { "classification": { -"description": "Type of attack, for example, 'SYN-flood', 'NTP-udp', or 'CHARGEN-udp'.", "type": "string" }, "volumeBps": { "deprecated": true, -"description": "Total BPS (bytes per second) volume of attack. Deprecated - refer to volume_bps_long instead.", "format": "int32", "type": "integer" }, "volumeBpsLong": { -"description": "Total BPS (bytes per second) volume of attack.", "format": "int64", "type": "string" }, "volumePps": { "deprecated": true, -"description": "Total PPS (packets per second) volume of attack. Deprecated - refer to volume_pps_long instead.", "format": "int32", "type": "integer" }, "volumePpsLong": { -"description": "Total PPS (packets per second) volume of attack.", "format": "int64", "type": "string" } @@ -5810,49 +5100,41 @@ false "type": "object" }, "GoogleCloudSecuritycenterV2AttackExposure": { -"description": "An attack exposure contains the results of an attack path simulation run.", "id": "GoogleCloudSecuritycenterV2AttackExposure", "properties": { "attackExposureResult": { -"description": "The resource name of the attack path simulation result that contains the details regarding this attack exposure score. Example: `organizations/123/simulations/456/attackExposureResults/789`", "type": "string" }, "exposedHighValueResourcesCount": { -"description": "The number of high value resources that are exposed as a result of this finding.", "format": "int32", "type": "integer" }, "exposedLowValueResourcesCount": { -"description": "The number of high value resources that are exposed as a result of this finding.", "format": "int32", "type": "integer" }, "exposedMediumValueResourcesCount": { -"description": "The number of medium value resources that are exposed as a result of this finding.", "format": "int32", "type": "integer" }, "latestCalculationTime": { -"description": "The most recent time the attack exposure was updated on this finding.", "format": "google-datetime", "type": "string" }, "score": { -"description": "A number between 0 (inclusive) and infinity that represents how important this finding is to remediate. The higher the score, the more important it is to remediate.", "format": "double", "type": "number" }, "state": { -"description": "Output only. What state this AttackExposure is in. This captures whether or not an attack exposure has been calculated or not.", "enum": [ "STATE_UNSPECIFIED", "CALCULATED", "NOT_CALCULATED" ], "enumDescriptions": [ -"The state is not specified.", -"The attack exposure has been calculated.", -"The attack exposure has not been calculated." +"", +"", +"" ], "readOnly": true, "type": "string" @@ -5861,34 +5143,27 @@ false "type": "object" }, "GoogleCloudSecuritycenterV2AwsAccount": { -"description": "An AWS account that is a member of an organization.", "id": "GoogleCloudSecuritycenterV2AwsAccount", "properties": { "id": { -"description": "The unique identifier (ID) of the account, containing exactly 12 digits.", "type": "string" }, "name": { -"description": "The friendly name of this account.", "type": "string" } }, "type": "object" }, "GoogleCloudSecuritycenterV2AwsMetadata": { -"description": "AWS metadata associated with the resource, only applicable if the finding's cloud provider is Amazon Web Services.", "id": "GoogleCloudSecuritycenterV2AwsMetadata", "properties": { "account": { -"$ref": "GoogleCloudSecuritycenterV2AwsAccount", -"description": "The AWS account associated with the resource." +"$ref": "GoogleCloudSecuritycenterV2AwsAccount" }, "organization": { -"$ref": "GoogleCloudSecuritycenterV2AwsOrganization", -"description": "The AWS organization associated with the resource." +"$ref": "GoogleCloudSecuritycenterV2AwsOrganization" }, "organizationalUnits": { -"description": "A list of AWS organizational units associated with the resource, ordered from lowest level (closest to the account) to highest level.", "items": { "$ref": "GoogleCloudSecuritycenterV2AwsOrganizationalUnit" }, @@ -5898,217 +5173,174 @@ false "type": "object" }, "GoogleCloudSecuritycenterV2AwsOrganization": { -"description": "An organization is a collection of accounts that are centrally managed together using consolidated billing, organized hierarchically with organizational units (OUs), and controlled with policies.", "id": "GoogleCloudSecuritycenterV2AwsOrganization", "properties": { "id": { -"description": "The unique identifier (ID) for the organization. The regex pattern for an organization ID string requires \"o-\" followed by from 10 to 32 lowercase letters or digits.", "type": "string" } }, "type": "object" }, "GoogleCloudSecuritycenterV2AwsOrganizationalUnit": { -"description": "An Organizational Unit (OU) is a container of AWS accounts within a root of an organization. Policies that are attached to an OU apply to all accounts contained in that OU and in any child OUs.", "id": "GoogleCloudSecuritycenterV2AwsOrganizationalUnit", "properties": { "id": { -"description": "The unique identifier (ID) associated with this OU. The regex pattern for an organizational unit ID string requires \"ou-\" followed by from 4 to 32 lowercase letters or digits (the ID of the root that contains the OU). This string is followed by a second \"-\" dash and from 8 to 32 additional lowercase letters or digits. For example, \"ou-ab12-cd34ef56\".", "type": "string" }, "name": { -"description": "The friendly name of the OU.", "type": "string" } }, "type": "object" }, "GoogleCloudSecuritycenterV2AzureManagementGroup": { -"description": "Represents an Azure management group.", "id": "GoogleCloudSecuritycenterV2AzureManagementGroup", "properties": { "displayName": { -"description": "The display name of the Azure management group.", "type": "string" }, "id": { -"description": "The UUID of the Azure management group, for example, `20000000-0001-0000-0000-000000000000`.", "type": "string" } }, "type": "object" }, "GoogleCloudSecuritycenterV2AzureMetadata": { -"description": "Azure metadata associated with the resource, only applicable if the finding's cloud provider is Microsoft Azure.", "id": "GoogleCloudSecuritycenterV2AzureMetadata", "properties": { "managementGroups": { -"description": "A list of Azure management groups associated with the resource, ordered from lowest level (closest to the subscription) to highest level.", "items": { "$ref": "GoogleCloudSecuritycenterV2AzureManagementGroup" }, "type": "array" }, "resourceGroup": { -"$ref": "GoogleCloudSecuritycenterV2AzureResourceGroup", -"description": "The Azure resource group associated with the resource." +"$ref": "GoogleCloudSecuritycenterV2AzureResourceGroup" }, "subscription": { -"$ref": "GoogleCloudSecuritycenterV2AzureSubscription", -"description": "The Azure subscription associated with the resource." +"$ref": "GoogleCloudSecuritycenterV2AzureSubscription" }, "tenant": { -"$ref": "GoogleCloudSecuritycenterV2AzureTenant", -"description": "The Azure Entra tenant associated with the resource." +"$ref": "GoogleCloudSecuritycenterV2AzureTenant" } }, "type": "object" }, "GoogleCloudSecuritycenterV2AzureResourceGroup": { -"description": "Represents an Azure resource group.", "id": "GoogleCloudSecuritycenterV2AzureResourceGroup", "properties": { "id": { -"description": "The ID of the Azure resource group.", "type": "string" }, "name": { -"description": "The name of the Azure resource group. This is not a UUID.", "type": "string" } }, "type": "object" }, "GoogleCloudSecuritycenterV2AzureSubscription": { -"description": "Represents an Azure subscription.", "id": "GoogleCloudSecuritycenterV2AzureSubscription", "properties": { "displayName": { -"description": "The display name of the Azure subscription.", "type": "string" }, "id": { -"description": "The UUID of the Azure subscription, for example, `291bba3f-e0a5-47bc-a099-3bdcb2a50a05`.", "type": "string" } }, "type": "object" }, "GoogleCloudSecuritycenterV2AzureTenant": { -"description": "Represents a Microsoft Entra tenant.", "id": "GoogleCloudSecuritycenterV2AzureTenant", "properties": { "displayName": { -"description": "The display name of the Azure tenant.", "type": "string" }, "id": { -"description": "The ID of the Microsoft Entra tenant, for example, \"a11aaa11-aa11-1aa1-11aa-1aaa11a\".", "type": "string" } }, "type": "object" }, "GoogleCloudSecuritycenterV2BackupDisasterRecovery": { -"description": "Information related to Google Cloud Backup and DR Service findings.", "id": "GoogleCloudSecuritycenterV2BackupDisasterRecovery", "properties": { "appliance": { -"description": "The name of the Backup and DR appliance that captures, moves, and manages the lifecycle of backup data. For example, `backup-server-57137`.", "type": "string" }, "applications": { -"description": "The names of Backup and DR applications. An application is a VM, database, or file system on a managed host monitored by a backup and recovery appliance. For example, `centos7-01-vol00`, `centos7-01-vol01`, `centos7-01-vol02`.", "items": { "type": "string" }, "type": "array" }, "backupCreateTime": { -"description": "The timestamp at which the Backup and DR backup was created.", "format": "google-datetime", "type": "string" }, "backupTemplate": { -"description": "The name of a Backup and DR template which comprises one or more backup policies. See the [Backup and DR documentation](https://cloud.google.com/backup-disaster-recovery/docs/concepts/backup-plan#temp) for more information. For example, `snap-ov`.", "type": "string" }, "backupType": { -"description": "The backup type of the Backup and DR image. For example, `Snapshot`, `Remote Snapshot`, `OnVault`.", "type": "string" }, "host": { -"description": "The name of a Backup and DR host, which is managed by the backup and recovery appliance and known to the management console. The host can be of type Generic (for example, Compute Engine, SQL Server, Oracle DB, SMB file system, etc.), vCenter, or an ESX server. See the [Backup and DR documentation on hosts](https://cloud.google.com/backup-disaster-recovery/docs/configuration/manage-hosts-and-their-applications) for more information. For example, `centos7-01`.", "type": "string" }, "policies": { -"description": "The names of Backup and DR policies that are associated with a template and that define when to run a backup, how frequently to run a backup, and how long to retain the backup image. For example, `onvaults`.", "items": { "type": "string" }, "type": "array" }, "policyOptions": { -"description": "The names of Backup and DR advanced policy options of a policy applying to an application. See the [Backup and DR documentation on policy options](https://cloud.google.com/backup-disaster-recovery/docs/create-plan/policy-settings). For example, `skipofflineappsincongrp, nounmap`.", "items": { "type": "string" }, "type": "array" }, "profile": { -"description": "The name of the Backup and DR resource profile that specifies the storage media for backups of application and VM data. See the [Backup and DR documentation on profiles](https://cloud.google.com/backup-disaster-recovery/docs/concepts/backup-plan#profile). For example, `GCP`.", "type": "string" }, "storagePool": { -"description": "The name of the Backup and DR storage pool that the backup and recovery appliance is storing data in. The storage pool could be of type Cloud, Primary, Snapshot, or OnVault. See the [Backup and DR documentation on storage pools](https://cloud.google.com/backup-disaster-recovery/docs/concepts/storage-pools). For example, `DiskPoolOne`.", "type": "string" } }, "type": "object" }, "GoogleCloudSecuritycenterV2BigQueryExport": { -"description": "Configures how to deliver Findings to BigQuery Instance.", "id": "GoogleCloudSecuritycenterV2BigQueryExport", "properties": { "createTime": { -"description": "Output only. The time at which the BigQuery export was created. This field is set by the server and will be ignored if provided on export on creation.", "format": "google-datetime", "readOnly": true, "type": "string" }, "cryptoKeyName": { -"description": "Output only. The resource name of the Cloud KMS `CryptoKey` used to protect this configuration's data, if configured during Security Command Center activation.", "readOnly": true, "type": "string" }, "dataset": { -"description": "The dataset to write findings' updates to. Its format is \"projects/[project_id]/datasets/[bigquery_dataset_id]\". BigQuery dataset unique ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_).", "type": "string" }, "description": { -"description": "The description of the export (max of 1024 characters).", "type": "string" }, "filter": { -"description": "Expression that defines the filter to apply across create/update events of findings. The expression is a list of zero or more restrictions combined via logical operators `AND` and `OR`. Parentheses are supported, and `OR` has higher precedence than `AND`. Restrictions have the form ` ` and may have a `-` character in front of them to indicate negation. The fields map to those defined in the corresponding resource. The supported operators are: * `=` for all value types. * `>`, `<`, `>=`, `<=` for integer values. * `:`, meaning substring matching, for strings. The supported value types are: * string literals in quotes. * integer literals without quotes. * boolean literals `true` and `false` without quotes.", "type": "string" }, "mostRecentEditor": { -"description": "Output only. Email address of the user who last edited the BigQuery export. This field is set by the server and will be ignored if provided on export creation or update.", "readOnly": true, "type": "string" }, "name": { -"description": "Identifier. The relative resource name of this export. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name. The following list shows some examples: + `organizations/{organization_id}/locations/{location_id}/bigQueryExports/{export_id}` + `folders/{folder_id}/locations/{location_id}/bigQueryExports/{export_id}` + `projects/{project_id}/locations/{location_id}/bigQueryExports/{export_id}` This field is provided in responses, and is ignored when provided in create requests.", "type": "string" }, "principal": { -"description": "Output only. The service account that needs permission to create table and upload data to the BigQuery dataset.", "readOnly": true, "type": "string" }, "updateTime": { -"description": "Output only. The most recent time at which the BigQuery export was updated. This field is set by the server and will be ignored if provided on export creation or update.", "format": "google-datetime", "readOnly": true, "type": "string" @@ -6117,23 +5349,18 @@ false "type": "object" }, "GoogleCloudSecuritycenterV2Binding": { -"description": "Represents a Kubernetes RoleBinding or ClusterRoleBinding.", "id": "GoogleCloudSecuritycenterV2Binding", "properties": { "name": { -"description": "Name for the binding.", "type": "string" }, "ns": { -"description": "Namespace for the binding.", "type": "string" }, "role": { -"$ref": "GoogleCloudSecuritycenterV2Role", -"description": "The Role or ClusterRole referenced by the binding." +"$ref": "GoogleCloudSecuritycenterV2Role" }, "subjects": { -"description": "Represents one or more subjects that are bound to the role. Not always available for PATCH requests.", "items": { "$ref": "GoogleCloudSecuritycenterV2Subject" }, @@ -6143,17 +5370,14 @@ false "type": "object" }, "GoogleCloudSecuritycenterV2BulkMuteFindingsResponse": { -"description": "The response to a BulkMute request. Contains the LRO information.", "id": "GoogleCloudSecuritycenterV2BulkMuteFindingsResponse", "properties": {}, "type": "object" }, "GoogleCloudSecuritycenterV2Chokepoint": { -"description": "Contains details about a chokepoint, which is a resource or resource group where high-risk attack paths converge, based on [attack path simulations] (https://cloud.google.com/security-command-center/docs/attack-exposure-learn#attack_path_simulations).", "id": "GoogleCloudSecuritycenterV2Chokepoint", "properties": { "relatedFindings": { -"description": "List of resource names of findings associated with this chokepoint. For example, organizations/123/sources/456/findings/789. This list will have at most 100 findings.", "items": { "type": "string" }, @@ -6163,65 +5387,53 @@ false "type": "object" }, "GoogleCloudSecuritycenterV2CloudArmor": { -"description": "Fields related to Google Cloud Armor findings.", "id": "GoogleCloudSecuritycenterV2CloudArmor", "properties": { "adaptiveProtection": { -"$ref": "GoogleCloudSecuritycenterV2AdaptiveProtection", -"description": "Information about potential Layer 7 DDoS attacks identified by [Google Cloud Armor Adaptive Protection](https://cloud.google.com/armor/docs/adaptive-protection-overview)." +"$ref": "GoogleCloudSecuritycenterV2AdaptiveProtection" }, "attack": { -"$ref": "GoogleCloudSecuritycenterV2Attack", -"description": "Information about DDoS attack volume and classification." +"$ref": "GoogleCloudSecuritycenterV2Attack" }, "duration": { -"description": "Duration of attack from the start until the current moment (updated every 5 minutes).", "format": "google-duration", "type": "string" }, "requests": { -"$ref": "GoogleCloudSecuritycenterV2Requests", -"description": "Information about incoming requests evaluated by [Google Cloud Armor security policies](https://cloud.google.com/armor/docs/security-policy-overview)." +"$ref": "GoogleCloudSecuritycenterV2Requests" }, "securityPolicy": { -"$ref": "GoogleCloudSecuritycenterV2SecurityPolicy", -"description": "Information about the [Google Cloud Armor security policy](https://cloud.google.com/armor/docs/security-policy-overview) relevant to the finding." +"$ref": "GoogleCloudSecuritycenterV2SecurityPolicy" }, "threatVector": { -"description": "Distinguish between volumetric & protocol DDoS attack and application layer attacks. For example, \"L3_4\" for Layer 3 and Layer 4 DDoS attacks, or \"L_7\" for Layer 7 DDoS attacks.", "type": "string" } }, "type": "object" }, "GoogleCloudSecuritycenterV2CloudControl": { -"description": "CloudControl associated with the finding.", "id": "GoogleCloudSecuritycenterV2CloudControl", "properties": { "cloudControlName": { -"description": "Name of the CloudControl associated with the finding.", "type": "string" }, "policyType": { -"description": "Policy type of the CloudControl", "type": "string" }, "type": { -"description": "Type of cloud control.", "enum": [ "CLOUD_CONTROL_TYPE_UNSPECIFIED", "BUILT_IN", "CUSTOM" ], "enumDescriptions": [ -"Unspecified.", -"Built in Cloud Control.", -"Custom Cloud Control." +"", +"", +"" ], "type": "string" }, "version": { -"description": "Version of the Cloud Control", "format": "int32", "type": "integer" } @@ -6229,31 +5441,27 @@ false "type": "object" }, "GoogleCloudSecuritycenterV2CloudDlpDataProfile": { -"description": "The [data profile](https://cloud.google.com/dlp/docs/data-profiles) associated with the finding.", "id": "GoogleCloudSecuritycenterV2CloudDlpDataProfile", "properties": { "dataProfile": { -"description": "Name of the data profile, for example, `projects/123/locations/europe/tableProfiles/8383929`.", "type": "string" }, "infoTypes": { -"description": "Type of information detected by SDP. Info type includes name, version and sensitivity of the detected information type.", "items": { "$ref": "GoogleCloudSecuritycenterV2InfoType" }, "type": "array" }, "parentType": { -"description": "The resource hierarchy level at which the data profile was generated.", "enum": [ "PARENT_TYPE_UNSPECIFIED", "ORGANIZATION", "PROJECT" ], "enumDescriptions": [ -"Unspecified parent type.", -"Organization-level configurations.", -"Project-level configurations." +"", +"", +"" ], "type": "string" } @@ -6261,47 +5469,37 @@ false "type": "object" }, "GoogleCloudSecuritycenterV2CloudDlpInspection": { -"description": "Details about the Cloud Data Loss Prevention (Cloud DLP) [inspection job](https://cloud.google.com/dlp/docs/concepts-job-triggers) that produced the finding.", "id": "GoogleCloudSecuritycenterV2CloudDlpInspection", "properties": { "fullScan": { -"description": "Whether Cloud DLP scanned the complete resource or a sampled subset.", "type": "boolean" }, "infoType": { -"description": "The type of information (or *[infoType](https://cloud.google.com/dlp/docs/infotypes-reference)*) found, for example, `EMAIL_ADDRESS` or `STREET_ADDRESS`.", "type": "string" }, "infoTypeCount": { -"description": "The number of times Cloud DLP found this infoType within this job and resource.", "format": "int64", "type": "string" }, "inspectJob": { -"description": "Name of the inspection job, for example, `projects/123/locations/europe/dlpJobs/i-8383929`.", "type": "string" } }, "type": "object" }, "GoogleCloudSecuritycenterV2CloudLoggingEntry": { -"description": "Metadata taken from a [Cloud Logging LogEntry](https://cloud.google.com/logging/docs/reference/v2/rest/v2/LogEntry)", "id": "GoogleCloudSecuritycenterV2CloudLoggingEntry", "properties": { "insertId": { -"description": "A unique identifier for the log entry.", "type": "string" }, "logId": { -"description": "The type of the log (part of `log_name`. `log_name` is the resource name of the log to which this log entry belongs). For example: `cloudresourcemanager.googleapis.com/activity` Note that this field is not URL-encoded, unlike in `LogEntry`.", "type": "string" }, "resourceContainer": { -"description": "The organization, folder, or project of the monitored resource that produced this log entry.", "type": "string" }, "timestamp": { -"description": "The time the event described by the log entry occurred.", "format": "google-datetime", "type": "string" } @@ -6309,44 +5507,36 @@ false "type": "object" }, "GoogleCloudSecuritycenterV2Compliance": { -"description": "Contains compliance information about a security standard indicating unmet recommendations.", "id": "GoogleCloudSecuritycenterV2Compliance", "properties": { "ids": { -"description": "Policies within the standard or benchmark, for example, A.12.4.1", "items": { "type": "string" }, "type": "array" }, "standard": { -"description": "Industry-wide compliance standards or benchmarks, such as CIS, PCI, and OWASP.", "type": "string" }, "version": { -"description": "Version of the standard or benchmark, for example, 1.1", "type": "string" } }, "type": "object" }, "GoogleCloudSecuritycenterV2ComplianceDetails": { -"description": "Compliance Details associated with the finding.", "id": "GoogleCloudSecuritycenterV2ComplianceDetails", "properties": { "cloudControl": { -"$ref": "GoogleCloudSecuritycenterV2CloudControl", -"description": "CloudControl associated with the finding" +"$ref": "GoogleCloudSecuritycenterV2CloudControl" }, "cloudControlDeploymentNames": { -"description": "Cloud Control Deployments associated with the finding. For example, organizations/123/locations/global/cloudControlDeployments/deploymentIdentifier", "items": { "type": "string" }, "type": "array" }, "frameworks": { -"description": "Details of Frameworks associated with the finding", "items": { "$ref": "GoogleCloudSecuritycenterV2Framework" }, @@ -6356,20 +5546,16 @@ false "type": "object" }, "GoogleCloudSecuritycenterV2Connection": { -"description": "Contains information about the IP connection associated with the finding.", "id": "GoogleCloudSecuritycenterV2Connection", "properties": { "destinationIp": { -"description": "Destination IP address. Not present for sockets that are listening and not connected.", "type": "string" }, "destinationPort": { -"description": "Destination port. Not present for sockets that are listening and not connected.", "format": "int32", "type": "integer" }, "protocol": { -"description": "IANA Internet Protocol Number such as TCP(6) and UDP(17).", "enum": [ "PROTOCOL_UNSPECIFIED", "ICMP", @@ -6379,21 +5565,19 @@ false "ESP" ], "enumDescriptions": [ -"Unspecified protocol (not HOPOPT).", -"Internet Control Message Protocol.", -"Transmission Control Protocol.", -"User Datagram Protocol.", -"Generic Routing Encapsulation.", -"Encap Security Payload." +"", +"", +"", +"", +"", +"" ], "type": "string" }, "sourceIp": { -"description": "Source IP address.", "type": "string" }, "sourcePort": { -"description": "Source port.", "format": "int32", "type": "integer" } @@ -6401,22 +5585,18 @@ false "type": "object" }, "GoogleCloudSecuritycenterV2Contact": { -"description": "The email address of a contact.", "id": "GoogleCloudSecuritycenterV2Contact", "properties": { "email": { -"description": "An email address. For example, \"`person123@company.com`\".", "type": "string" } }, "type": "object" }, "GoogleCloudSecuritycenterV2ContactDetails": { -"description": "Details about specific contacts", "id": "GoogleCloudSecuritycenterV2ContactDetails", "properties": { "contacts": { -"description": "A list of contacts", "items": { "$ref": "GoogleCloudSecuritycenterV2Contact" }, @@ -6426,66 +5606,53 @@ false "type": "object" }, "GoogleCloudSecuritycenterV2Container": { -"description": "Container associated with the finding.", "id": "GoogleCloudSecuritycenterV2Container", "properties": { "createTime": { -"description": "The time that the container was created.", "format": "google-datetime", "type": "string" }, "imageId": { -"description": "Optional container image ID, if provided by the container runtime. Uniquely identifies the container image launched using a container image digest.", "type": "string" }, "labels": { -"description": "Container labels, as provided by the container runtime.", "items": { "$ref": "GoogleCloudSecuritycenterV2Label" }, "type": "array" }, "name": { -"description": "Name of the container.", "type": "string" }, "uri": { -"description": "Container image URI provided when configuring a pod or container. This string can identify a container image version using mutable tags.", "type": "string" } }, "type": "object" }, "GoogleCloudSecuritycenterV2Control": { -"description": "Compliance control associated with the finding.", "id": "GoogleCloudSecuritycenterV2Control", "properties": { "controlName": { -"description": "Name of the Control", "type": "string" }, "displayName": { -"description": "Display name of the control. For example, AU-02.", "type": "string" } }, "type": "object" }, "GoogleCloudSecuritycenterV2Cve": { -"description": "CVE stands for Common Vulnerabilities and Exposures. Information from the [CVE record](https://www.cve.org/ResourcesSupport/Glossary) that describes this vulnerability.", "id": "GoogleCloudSecuritycenterV2Cve", "properties": { "cvssv3": { -"$ref": "GoogleCloudSecuritycenterV2Cvssv3", -"description": "Describe Common Vulnerability Scoring System specified at https://www.first.org/cvss/v3.1/specification-document" +"$ref": "GoogleCloudSecuritycenterV2Cvssv3" }, "exploitReleaseDate": { -"description": "Date the first publicly available exploit or PoC was released.", "format": "google-datetime", "type": "string" }, "exploitationActivity": { -"description": "The exploitation activity of the vulnerability in the wild.", "enum": [ "EXPLOITATION_ACTIVITY_UNSPECIFIED", "WIDE", @@ -6495,26 +5662,23 @@ false "NO_KNOWN" ], "enumDescriptions": [ -"Invalid or empty value.", -"Exploitation has been reported or confirmed to widely occur.", -"Limited reported or confirmed exploitation activities.", -"Exploit is publicly available.", -"No known exploitation activity, but has a high potential for exploitation.", -"No known exploitation activity." +"", +"", +"", +"", +"", +"" ], "type": "string" }, "firstExploitationDate": { -"description": "Date of the earliest known exploitation.", "format": "google-datetime", "type": "string" }, "id": { -"description": "The unique identifier for the vulnerability. e.g. CVE-2021-34527", "type": "string" }, "impact": { -"description": "The potential impact of the vulnerability if it was to be exploited.", "enum": [ "RISK_RATING_UNSPECIFIED", "LOW", @@ -6523,56 +5687,49 @@ false "CRITICAL" ], "enumDescriptions": [ -"Invalid or empty value.", -"Exploitation would have little to no security impact.", -"Exploitation would enable attackers to perform activities, or could allow attackers to have a direct impact, but would require additional steps.", -"Exploitation would enable attackers to have a notable direct impact without needing to overcome any major mitigating factors.", -"Exploitation would fundamentally undermine the security of affected systems, enable actors to perform significant attacks with minimal effort, with little to no mitigating factors to overcome." +"", +"", +"", +"", +"" ], "type": "string" }, "observedInTheWild": { -"description": "Whether or not the vulnerability has been observed in the wild.", "type": "boolean" }, "references": { -"description": "Additional information about the CVE. e.g. https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2021-34527", "items": { "$ref": "GoogleCloudSecuritycenterV2Reference" }, "type": "array" }, "upstreamFixAvailable": { -"description": "Whether upstream fix is available for the CVE.", "type": "boolean" }, "zeroDay": { -"description": "Whether or not the vulnerability was zero day when the finding was published.", "type": "boolean" } }, "type": "object" }, "GoogleCloudSecuritycenterV2Cvssv3": { -"description": "Common Vulnerability Scoring System version 3.", "id": "GoogleCloudSecuritycenterV2Cvssv3", "properties": { "attackComplexity": { -"description": "This metric describes the conditions beyond the attacker's control that must exist in order to exploit the vulnerability.", "enum": [ "ATTACK_COMPLEXITY_UNSPECIFIED", "ATTACK_COMPLEXITY_LOW", "ATTACK_COMPLEXITY_HIGH" ], "enumDescriptions": [ -"Invalid value.", -"Specialized access conditions or extenuating circumstances do not exist. An attacker can expect repeatable success when attacking the vulnerable component.", -"A successful attack depends on conditions beyond the attacker's control. That is, a successful attack cannot be accomplished at will, but requires the attacker to invest in some measurable amount of effort in preparation or execution against the vulnerable component before a successful attack can be expected." +"", +"", +"" ], "type": "string" }, "attackVector": { -"description": "Base Metrics Represents the intrinsic characteristics of a vulnerability that are constant over time and across user environments. This metric reflects the context by which vulnerability exploitation is possible.", "enum": [ "ATTACK_VECTOR_UNSPECIFIED", "ATTACK_VECTOR_NETWORK", @@ -6581,16 +5738,15 @@ false "ATTACK_VECTOR_PHYSICAL" ], "enumDescriptions": [ -"Invalid value.", -"The vulnerable component is bound to the network stack and the set of possible attackers extends beyond the other options listed below, up to and including the entire Internet.", -"The vulnerable component is bound to the network stack, but the attack is limited at the protocol level to a logically adjacent topology.", -"The vulnerable component is not bound to the network stack and the attacker's path is via read/write/execute capabilities.", -"The attack requires the attacker to physically touch or manipulate the vulnerable component." +"", +"", +"", +"", +"" ], "type": "string" }, "availabilityImpact": { -"description": "This metric measures the impact to the availability of the impacted component resulting from a successfully exploited vulnerability.", "enum": [ "IMPACT_UNSPECIFIED", "IMPACT_HIGH", @@ -6598,20 +5754,18 @@ false "IMPACT_NONE" ], "enumDescriptions": [ -"Invalid value.", -"High impact.", -"Low impact.", -"No impact." +"", +"", +"", +"" ], "type": "string" }, "baseScore": { -"description": "The base score is a function of the base metric scores.", "format": "double", "type": "number" }, "confidentialityImpact": { -"description": "This metric measures the impact to the confidentiality of the information resources managed by a software component due to a successfully exploited vulnerability.", "enum": [ "IMPACT_UNSPECIFIED", "IMPACT_HIGH", @@ -6619,15 +5773,14 @@ false "IMPACT_NONE" ], "enumDescriptions": [ -"Invalid value.", -"High impact.", -"Low impact.", -"No impact." +"", +"", +"", +"" ], "type": "string" }, "integrityImpact": { -"description": "This metric measures the impact to integrity of a successfully exploited vulnerability.", "enum": [ "IMPACT_UNSPECIFIED", "IMPACT_HIGH", @@ -6635,15 +5788,14 @@ false "IMPACT_NONE" ], "enumDescriptions": [ -"Invalid value.", -"High impact.", -"Low impact.", -"No impact." +"", +"", +"", +"" ], "type": "string" }, "privilegesRequired": { -"description": "This metric describes the level of privileges an attacker must possess before successfully exploiting the vulnerability.", "enum": [ "PRIVILEGES_REQUIRED_UNSPECIFIED", "PRIVILEGES_REQUIRED_NONE", @@ -6651,38 +5803,36 @@ false "PRIVILEGES_REQUIRED_HIGH" ], "enumDescriptions": [ -"Invalid value.", -"The attacker is unauthorized prior to attack, and therefore does not require any access to settings or files of the vulnerable system to carry out an attack.", -"The attacker requires privileges that provide basic user capabilities that could normally affect only settings and files owned by a user. Alternatively, an attacker with Low privileges has the ability to access only non-sensitive resources.", -"The attacker requires privileges that provide significant (e.g., administrative) control over the vulnerable component allowing access to component-wide settings and files." +"", +"", +"", +"" ], "type": "string" }, "scope": { -"description": "The Scope metric captures whether a vulnerability in one vulnerable component impacts resources in components beyond its security scope.", "enum": [ "SCOPE_UNSPECIFIED", "SCOPE_UNCHANGED", "SCOPE_CHANGED" ], "enumDescriptions": [ -"Invalid value.", -"An exploited vulnerability can only affect resources managed by the same security authority.", -"An exploited vulnerability can affect resources beyond the security scope managed by the security authority of the vulnerable component." +"", +"", +"" ], "type": "string" }, "userInteraction": { -"description": "This metric captures the requirement for a human user, other than the attacker, to participate in the successful compromise of the vulnerable component.", "enum": [ "USER_INTERACTION_UNSPECIFIED", "USER_INTERACTION_NONE", "USER_INTERACTION_REQUIRED" ], "enumDescriptions": [ -"Invalid value.", -"The vulnerable system can be exploited without interaction from any user.", -"Successful exploitation of this vulnerability requires a user to take some action before the vulnerability can be exploited." +"", +"", +"" ], "type": "string" } @@ -6690,15 +5840,12 @@ false "type": "object" }, "GoogleCloudSecuritycenterV2Cwe": { -"description": "CWE stands for Common Weakness Enumeration. Information about this weakness, as described by [CWE](https://cwe.mitre.org/).", "id": "GoogleCloudSecuritycenterV2Cwe", "properties": { "id": { -"description": "The CWE identifier, e.g. CWE-94", "type": "string" }, "references": { -"description": "Any reference to the details on the CWE, for example, https://cwe.mitre.org/data/definitions/94.html", "items": { "$ref": "GoogleCloudSecuritycenterV2Reference" }, @@ -6708,20 +5855,16 @@ false "type": "object" }, "GoogleCloudSecuritycenterV2DataAccessEvent": { -"description": "Details about a data access attempt made by a principal not authorized under applicable data security policy.", "id": "GoogleCloudSecuritycenterV2DataAccessEvent", "properties": { "eventId": { -"description": "Unique identifier for data access event.", "type": "string" }, "eventTime": { -"description": "Timestamp of data access event.", "format": "google-datetime", "type": "string" }, "operation": { -"description": "The operation performed by the principal to access the data.", "enum": [ "OPERATION_UNSPECIFIED", "READ", @@ -6729,35 +5872,30 @@ false "COPY" ], "enumDescriptions": [ -"The operation is unspecified.", -"Represents a read operation.", -"Represents a move operation.", -"Represents a copy operation." +"", +"", +"", +"" ], "type": "string" }, "principalEmail": { -"description": "The email address of the principal that accessed the data. The principal could be a user account, service account, Google group, or other.", "type": "string" } }, "type": "object" }, "GoogleCloudSecuritycenterV2DataFlowEvent": { -"description": "Details about a data flow event, in which either the data is moved to or is accessed from a non-compliant geo-location, as defined in the applicable data security policy.", "id": "GoogleCloudSecuritycenterV2DataFlowEvent", "properties": { "eventId": { -"description": "Unique identifier for data flow event.", "type": "string" }, "eventTime": { -"description": "Timestamp of data flow event.", "format": "google-datetime", "type": "string" }, "operation": { -"description": "The operation performed by the principal for the data flow event.", "enum": [ "OPERATION_UNSPECIFIED", "READ", @@ -6765,40 +5903,34 @@ false "COPY" ], "enumDescriptions": [ -"The operation is unspecified.", -"Represents a read operation.", -"Represents a move operation.", -"Represents a copy operation." +"", +"", +"", +"" ], "type": "string" }, "principalEmail": { -"description": "The email address of the principal that initiated the data flow event. The principal could be a user account, service account, Google group, or other.", "type": "string" }, "violatedLocation": { -"description": "Non-compliant location of the principal or the data destination.", "type": "string" } }, "type": "object" }, "GoogleCloudSecuritycenterV2DataRetentionDeletionEvent": { -"description": "Details about data retention deletion violations, in which the data is non-compliant based on their retention or deletion time, as defined in the applicable data security policy. The Data Retention Deletion (DRD) control is a control of the DSPM (Data Security Posture Management) suite that enables organizations to manage data retention and deletion policies in compliance with regulations, such as GDPR and CRPA. DRD supports two primary policy types: maximum storage length (max TTL) and minimum storage length (min TTL). Both are aimed at helping organizations meet regulatory and data management commitments.", "id": "GoogleCloudSecuritycenterV2DataRetentionDeletionEvent", "properties": { "dataObjectCount": { -"description": "Number of objects that violated the policy for this resource. If the number is less than 1,000, then the value of this field is the exact number. If the number of objects that violated the policy is greater than or equal to 1,000, then the value of this field is 1000.", "format": "int64", "type": "string" }, "eventDetectionTime": { -"description": "Timestamp indicating when the event was detected.", "format": "google-datetime", "type": "string" }, "eventType": { -"description": "Type of the DRD event.", "enum": [ "EVENT_TYPE_UNSPECIFIED", "EVENT_TYPE_MAX_TTL_EXCEEDED", @@ -6814,21 +5946,19 @@ false, false ], "enumDescriptions": [ -"Unspecified event type.", -"Deprecated: This field is pending removal. Use EVENT_TYPE_MAX_TTL_FROM_CREATION or EVENT_TYPE_MAX_TTL_FROM_LAST_MODIFICATION instead.", -"Max TTL from the asset's creation time.", -"Max TTL from the asset's last modification time.", -"Min TTL from the asset's creation time." +"", +"", +"", +"", +"" ], "type": "string" }, "maxRetentionAllowed": { -"description": "Maximum duration of retention allowed from the DRD control. This comes from the DRD control where users set a max TTL for their data. For example, suppose that a user sets the max TTL for a Cloud Storage bucket to 90 days. However, an object in that bucket is 100 days old. In this case, a DataRetentionDeletionEvent will be generated for that Cloud Storage bucket, and the max_retention_allowed is 90 days.", "format": "google-duration", "type": "string" }, "minRetentionAllowed": { -"description": "Min duration of retention allowed from the DSPM retention control. This field is only populated when event type is set to EVENT_TYPE_MIN_TTL_FROM_CREATION.", "format": "google-duration", "type": "string" } @@ -6836,64 +5966,51 @@ false "type": "object" }, "GoogleCloudSecuritycenterV2Database": { -"description": "Represents database access information, such as queries. A database may be a sub-resource of an instance (as in the case of Cloud SQL instances or Cloud Spanner instances), or the database instance itself. Some database resources might not have the [full resource name](https://google.aip.dev/122#full-resource-names) populated because these resource types, such as Cloud SQL databases, are not yet supported by Cloud Asset Inventory. In these cases only the display name is provided.", "id": "GoogleCloudSecuritycenterV2Database", "properties": { "displayName": { -"description": "The human-readable name of the database that the user connected to.", "type": "string" }, "grantees": { -"description": "The target usernames, roles, or groups of an SQL privilege grant, which is not an IAM policy change.", "items": { "type": "string" }, "type": "array" }, "name": { -"description": "Some database resources may not have the [full resource name](https://google.aip.dev/122#full-resource-names) populated because these resource types are not yet supported by Cloud Asset Inventory (e.g. Cloud SQL databases). In these cases only the display name will be provided. The [full resource name](https://google.aip.dev/122#full-resource-names) of the database that the user connected to, if it is supported by Cloud Asset Inventory.", "type": "string" }, "query": { -"description": "The SQL statement that is associated with the database access.", "type": "string" }, "userName": { -"description": "The username used to connect to the database. The username might not be an IAM principal and does not have a set format.", "type": "string" }, "version": { -"description": "The version of the database, for example, POSTGRES_14. See [the complete list](https://cloud.google.com/sql/docs/mysql/admin-api/rest/v1/SqlDatabaseVersion).", "type": "string" } }, "type": "object" }, "GoogleCloudSecuritycenterV2Dataset": { -"description": "Vertex AI dataset associated with the finding.", "id": "GoogleCloudSecuritycenterV2Dataset", "properties": { "displayName": { -"description": "The user defined display name of dataset, e.g. plants-dataset", "type": "string" }, "name": { -"description": "Resource name of the dataset, e.g. projects/{project}/locations/{location}/datasets/2094040236064505856", "type": "string" }, "source": { -"description": "Data source, such as a BigQuery source URI, e.g. bq://scc-nexus-test.AIPPtest.gsod", "type": "string" } }, "type": "object" }, "GoogleCloudSecuritycenterV2Denied": { -"description": "Denied IP rule.", "id": "GoogleCloudSecuritycenterV2Denied", "properties": { "ipRules": { -"description": "Optional. Optional list of denied IP rules.", "items": { "$ref": "GoogleCloudSecuritycenterV2IpRule" }, @@ -6903,15 +6020,12 @@ false "type": "object" }, "GoogleCloudSecuritycenterV2Detection": { -"description": "Memory hash detection contributing to the binary family match.", "id": "GoogleCloudSecuritycenterV2Detection", "properties": { "binary": { -"description": "The name of the binary associated with the memory hash signature detection.", "type": "string" }, "percentPagesMatched": { -"description": "The percentage of memory page hashes in the signature that were matched.", "format": "double", "type": "number" } @@ -6919,35 +6033,29 @@ false "type": "object" }, "GoogleCloudSecuritycenterV2DiscoveredWorkload": { -"description": "Represents discovered, customer managed workload that is not registered with the respective GCP service.", "id": "GoogleCloudSecuritycenterV2DiscoveredWorkload", "properties": { "confidence": { -"description": "The confidence in detection of this workload.", "enum": [ "CONFIDENCE_UNSPECIFIED", "CONFIDENCE_HIGH" ], "enumDescriptions": [ -"Unspecified confidence level.", -"High confidence in detection of a workload." +"", +"" ], "type": "string" }, "detectedRelevantHardware": { -"description": "A boolean flag set to true if associated hardware strongly predicts the workload type.", "type": "boolean" }, "detectedRelevantKeywords": { -"description": "A boolean flag set to true if associated keywords strongly predict the workload type.", "type": "boolean" }, "detectedRelevantPackages": { -"description": "A boolean flag set to true if installed packages strongly predict the workload type.", "type": "boolean" }, "workloadType": { -"description": "The type of workload.", "enum": [ "WORKLOAD_TYPE_UNSPECIFIED", "MCP_SERVER", @@ -6955,10 +6063,10 @@ false "AGENT" ], "enumDescriptions": [ -"Unspecified workload type", -"A workload of type MCP Server", -"A workload of type AI Inference", -"A workload of type LLM Agent" +"", +"", +"", +"" ], "type": "string" } @@ -6966,100 +6074,82 @@ false "type": "object" }, "GoogleCloudSecuritycenterV2Disk": { -"description": "Contains information about the disk associated with the finding.", "id": "GoogleCloudSecuritycenterV2Disk", "properties": { "name": { -"description": "The name of the disk, for example, \"https://www.googleapis.com/compute/v1/projects/{project-id}/zones/{zone-id}/disks/{disk-id}\".", "type": "string" } }, "type": "object" }, "GoogleCloudSecuritycenterV2DiskPath": { -"description": "Path of the file in terms of underlying disk/partition identifiers.", "id": "GoogleCloudSecuritycenterV2DiskPath", "properties": { "partitionUuid": { -"description": "UUID of the partition (format https://wiki.archlinux.org/title/persistent_block_device_naming#by-uuid)", "type": "string" }, "relativePath": { -"description": "Relative path of the file in the partition as a JSON encoded string. Example: /home/user1/executable_file.sh", "type": "string" } }, "type": "object" }, "GoogleCloudSecuritycenterV2DynamicMuteRecord": { -"description": "The record of a dynamic mute rule that matches the finding.", "id": "GoogleCloudSecuritycenterV2DynamicMuteRecord", "properties": { "matchTime": { -"description": "When the dynamic mute rule first matched the finding.", "format": "google-datetime", "type": "string" }, "muteConfig": { -"description": "The relative resource name of the mute rule, represented by a mute config, that created this record, for example `organizations/123/muteConfigs/mymuteconfig` or `organizations/123/locations/global/muteConfigs/mymuteconfig`.", "type": "string" } }, "type": "object" }, "GoogleCloudSecuritycenterV2EnvironmentVariable": { -"description": "A name-value pair representing an environment variable used in an operating system process.", "id": "GoogleCloudSecuritycenterV2EnvironmentVariable", "properties": { "name": { -"description": "Environment variable name as a JSON encoded string.", "type": "string" }, "val": { -"description": "Environment variable value as a JSON encoded string.", "type": "string" } }, "type": "object" }, "GoogleCloudSecuritycenterV2ExfilResource": { -"description": "Resource where data was exfiltrated from or exfiltrated to.", "id": "GoogleCloudSecuritycenterV2ExfilResource", "properties": { "components": { -"description": "Subcomponents of the asset that was exfiltrated, like URIs used during exfiltration, table names, databases, and filenames. For example, multiple tables might have been exfiltrated from the same Cloud SQL instance, or multiple files might have been exfiltrated from the same Cloud Storage bucket.", "items": { "type": "string" }, "type": "array" }, "name": { -"description": "The resource's [full resource name](https://cloud.google.com/apis/design/resource_names#full_resource_name).", "type": "string" } }, "type": "object" }, "GoogleCloudSecuritycenterV2Exfiltration": { -"description": "Exfiltration represents a data exfiltration attempt from one or more sources to one or more targets. The `sources` attribute lists the sources of the exfiltrated data. The `targets` attribute lists the destinations the data was copied to.", "id": "GoogleCloudSecuritycenterV2Exfiltration", "properties": { "sources": { -"description": "If there are multiple sources, then the data is considered \"joined\" between them. For instance, BigQuery can join multiple tables, and each table would be considered a source.", "items": { "$ref": "GoogleCloudSecuritycenterV2ExfilResource" }, "type": "array" }, "targets": { -"description": "If there are multiple targets, each target would get a complete copy of the \"joined\" source data.", "items": { "$ref": "GoogleCloudSecuritycenterV2ExfilResource" }, "type": "array" }, "totalExfiltratedBytes": { -"description": "Total exfiltrated bytes processed for the entire job.", "format": "int64", "type": "string" } @@ -7067,205 +6157,162 @@ false "type": "object" }, "GoogleCloudSecuritycenterV2ExternalExposure": { -"description": "Details about the externally exposed resource associated with the finding.", "id": "GoogleCloudSecuritycenterV2ExternalExposure", "properties": { "backendBucket": { -"description": "The full resource name of the load balancer backend bucket, for example, \"//compute.googleapis.com/projects/{project-id}/global/backendBuckets/{name}\"", "type": "string" }, "backendService": { -"description": "The full resource name of load balancer backend service, for example, \"//compute.googleapis.com/projects/{project-id}/global/backendServices/{name}\".", "type": "string" }, "exposedApplication": { -"description": "The name and version of the exposed web application, for example, \"Jenkins 2.184\".", "type": "string" }, "exposedEndpoint": { -"description": "The resource which is running the exposed service, for example, \"//compute.googleapis.com/projects/{project-id}/zones/{zone}/instances/{instance}.\u201d", "type": "string" }, "exposedService": { -"description": "The name and version of the service, for example, \"Jupyter Notebook 6.14.0\".", "type": "string" }, "forwardingRule": { -"description": "The full resource name of the forwarding rule, for example, \"//compute.googleapis.com/projects/{project-id}/global/forwardingRules/{forwarding-rule-name}\".", "type": "string" }, "hostnameUri": { -"description": "Hostname of the exposed application, for example, \"https://test-app.a.run.app/\"", "type": "string" }, "httpResponse": { -"description": "The http response returned by the web application.", "items": { "$ref": "GoogleCloudSecuritycenterV2HttpResponse" }, "type": "array" }, "instanceGroup": { -"description": "The full resource name of the instance group, for example, \"//compute.googleapis.com/projects/{project-id}/global/instanceGroups/{name}\".", "type": "string" }, "internalBackendService": { -"description": "The full resource name of load balancer backend service in the internal project having resource exposed via PSC, for example, \"//compute.googleapis.com/projects/{project-id}/global/backendServices/{name}\".", "type": "string" }, "loadBalancerFirewallPolicy": { -"description": "The full resource name of the load balancer firewall policy, for example, \"//compute.googleapis.com/projects/{project-id}/global/firewallPolicies/{policy-name}\".", "type": "string" }, "networkEndpointGroup": { -"description": "The full resource name of the network endpoint group, for example, \"//compute.googleapis.com/projects/{project-id}/global/networkEndpointGroups/{name}\".", "type": "string" }, "networkIngressFirewallPolicy": { -"description": "The full resource name of the network ingress firewall policy, for example, \"//compute.googleapis.com/projects/{project-id}/global/firewallPolicies/{name}\".", "type": "string" }, "privateIpAddress": { -"description": "Private IP address of the exposed endpoint.", "type": "string" }, "privatePort": { -"description": "Port number associated with private IP address.", "type": "string" }, "pscNetworkAttachment": { -"description": "The full resource name of the PSC (Private Service Connect) network attachment that network interface controller is attached to, for example, \"//compute.googleapis.com/projects/{project-id}/regions/{region}/networkAttachments/{name}\"", "type": "string" }, "pscServiceAttachment": { -"description": "The full resource name of the PSC (Private Service Connect) service attachment that the load balancer network endpoint group targets, for example, \"//compute.googleapis.com/projects/{project-id}/regions/{region}/serviceAttachments/{name}\"", "type": "string" }, "publicIpAddress": { -"description": "Public IP address of the exposed endpoint.", "type": "string" }, "publicPort": { -"description": "Public port number of the exposed endpoint.", "type": "string" }, "serviceFirewallPolicy": { -"description": "The full resource name of the firewall policy of the exposed service, for example, \"//compute.googleapis.com/projects/{project-id}/global/firewallPolicies/{policy-name}\".", "type": "string" } }, "type": "object" }, "GoogleCloudSecuritycenterV2ExternalSystem": { -"description": "Representation of third party SIEM/SOAR fields within SCC.", "id": "GoogleCloudSecuritycenterV2ExternalSystem", "properties": { "assignees": { -"description": "References primary/secondary etc assignees in the external system.", "items": { "type": "string" }, "type": "array" }, "caseCloseTime": { -"description": "The time when the case was closed, as reported by the external system.", "format": "google-datetime", "type": "string" }, "caseCreateTime": { -"description": "The time when the case was created, as reported by the external system.", "format": "google-datetime", "type": "string" }, "casePriority": { -"description": "The priority of the finding's corresponding case in the external system.", "type": "string" }, "caseSla": { -"description": "The SLA of the finding's corresponding case in the external system.", "format": "google-datetime", "type": "string" }, "caseUri": { -"description": "The link to the finding's corresponding case in the external system.", "type": "string" }, "externalSystemUpdateTime": { -"description": "The time when the case was last updated, as reported by the external system.", "format": "google-datetime", "type": "string" }, "externalUid": { -"description": "The identifier that's used to track the finding's corresponding case in the external system.", "type": "string" }, "name": { -"description": "Full resource name of the external system. The following list shows some examples: + `organizations/1234/sources/5678/findings/123456/externalSystems/jira` + `organizations/1234/sources/5678/locations/us/findings/123456/externalSystems/jira` + `folders/1234/sources/5678/findings/123456/externalSystems/jira` + `folders/1234/sources/5678/locations/us/findings/123456/externalSystems/jira` + `projects/1234/sources/5678/findings/123456/externalSystems/jira` + `projects/1234/sources/5678/locations/us/findings/123456/externalSystems/jira`", "type": "string" }, "status": { -"description": "The most recent status of the finding's corresponding case, as reported by the external system.", "type": "string" }, "ticketInfo": { -"$ref": "GoogleCloudSecuritycenterV2TicketInfo", -"description": "Information about the ticket, if any, that is being used to track the resolution of the issue that is identified by this finding." +"$ref": "GoogleCloudSecuritycenterV2TicketInfo" } }, "type": "object" }, "GoogleCloudSecuritycenterV2File": { -"description": "File information about the related binary/library used by an executable, or the script used by a script interpreter", "id": "GoogleCloudSecuritycenterV2File", "properties": { "contents": { -"description": "Prefix of the file contents as a JSON-encoded string.", "type": "string" }, "diskPath": { -"$ref": "GoogleCloudSecuritycenterV2DiskPath", -"description": "Path of the file in terms of underlying disk/partition identifiers." +"$ref": "GoogleCloudSecuritycenterV2DiskPath" }, "fileLoadState": { -"description": "The load state of the file.", "enum": [ "FILE_LOAD_STATE_UNSPECIFIED", "LOADED_BY_PROCESS", "NOT_LOADED_BY_PROCESS" ], "enumDescriptions": [ -"The file state is unspecified.", -"The file is being used by an active process at the time of scanning.", -"The file is not being used by any active process at the time of scanning." +"", +"", +"" ], "type": "string" }, "hashedSize": { -"description": "The length in bytes of the file prefix that was hashed. If hashed_size == size, any hashes reported represent the entire file.", "format": "int64", "type": "string" }, "operations": { -"description": "Operation(s) performed on a file.", "items": { "$ref": "GoogleCloudSecuritycenterV2FileOperation" }, "type": "array" }, "partiallyHashed": { -"description": "True when the hash covers only a prefix of the file.", "type": "boolean" }, "path": { -"description": "Absolute path of the file as a JSON encoded string.", "type": "string" }, "sha256": { -"description": "SHA256 hash of the first hashed_size bytes of the file encoded as a hex string. If hashed_size == size, sha256 represents the SHA256 hash of the entire file.", "type": "string" }, "size": { -"description": "Size of the file in bytes.", "format": "int64", "type": "string" } @@ -7273,11 +6320,9 @@ false "type": "object" }, "GoogleCloudSecuritycenterV2FileOperation": { -"description": "Operation(s) performed on a file.", "id": "GoogleCloudSecuritycenterV2FileOperation", "properties": { "type": { -"description": "The type of the operation", "enum": [ "OPERATION_TYPE_UNSPECIFIED", "OPEN", @@ -7287,12 +6332,12 @@ false "EXECUTE" ], "enumDescriptions": [ -"The operation is unspecified.", -"Represents an open operation.", -"Represents a read operation.", -"Represents a rename operation.", -"Represents a write operation.", -"Represents an execute operation." +"", +"", +"", +"", +"", +"" ], "type": "string" } @@ -7300,82 +6345,64 @@ false "type": "object" }, "GoogleCloudSecuritycenterV2Finding": { -"description": "Security Command Center finding. A finding is a record of assessment data like security, risk, health, or privacy, that is ingested into Security Command Center for presentation, notification, analysis, policy testing, and enforcement. For example, a cross-site scripting (XSS) vulnerability in an App Engine application is a finding.", "id": "GoogleCloudSecuritycenterV2Finding", "properties": { "access": { -"$ref": "GoogleCloudSecuritycenterV2Access", -"description": "Access details associated with the finding, such as more information on the caller, which method was accessed, and from where." +"$ref": "GoogleCloudSecuritycenterV2Access" }, "affectedResources": { -"$ref": "GoogleCloudSecuritycenterV2AffectedResources", -"description": "AffectedResources associated with the finding." +"$ref": "GoogleCloudSecuritycenterV2AffectedResources" }, "agentDataAccessEvents": { -"description": "Agent data access events associated with the finding.", "items": { "$ref": "GoogleCloudSecuritycenterV2AgentDataAccessEvent" }, "type": "array" }, "aiModel": { -"$ref": "GoogleCloudSecuritycenterV2AiModel", -"description": "The AI model associated with the finding." +"$ref": "GoogleCloudSecuritycenterV2AiModel" }, "application": { -"$ref": "GoogleCloudSecuritycenterV2Application", -"description": "Represents an application associated with the finding." +"$ref": "GoogleCloudSecuritycenterV2Application" }, "artifactGuardPolicies": { -"$ref": "GoogleCloudSecuritycenterV2ArtifactGuardPolicies", -"description": "ArtifactGuardPolicies associated with the finding." +"$ref": "GoogleCloudSecuritycenterV2ArtifactGuardPolicies" }, "attackExposure": { -"$ref": "GoogleCloudSecuritycenterV2AttackExposure", -"description": "The results of an attack path simulation relevant to this finding." +"$ref": "GoogleCloudSecuritycenterV2AttackExposure" }, "backupDisasterRecovery": { -"$ref": "GoogleCloudSecuritycenterV2BackupDisasterRecovery", -"description": "Fields related to Backup and DR findings." +"$ref": "GoogleCloudSecuritycenterV2BackupDisasterRecovery" }, "canonicalName": { -"description": "Output only. The canonical name of the finding. The following list shows some examples: + `organizations/{organization_id}/sources/{source_id}/locations/{location_id}/findings/{finding_id}` + `folders/{folder_id}/sources/{source_id}/locations/{location_id}/findings/{finding_id}` + `projects/{project_id}/sources/{source_id}/locations/{location_id}/findings/{finding_id}` The prefix is the closest CRM ancestor of the resource associated with the finding.", "readOnly": true, "type": "string" }, "category": { -"description": "Immutable. The additional taxonomy group within findings from a given source. Example: \"XSS_FLASH_INJECTION\"", "type": "string" }, "chokepoint": { -"$ref": "GoogleCloudSecuritycenterV2Chokepoint", -"description": "Contains details about a chokepoint, which is a resource or resource group where high-risk attack paths converge, based on [attack path simulations] (https://cloud.google.com/security-command-center/docs/attack-exposure-learn#attack_path_simulations). This field cannot be updated. Its value is ignored in all update requests." +"$ref": "GoogleCloudSecuritycenterV2Chokepoint" }, "cloudArmor": { -"$ref": "GoogleCloudSecuritycenterV2CloudArmor", -"description": "Fields related to Cloud Armor findings." +"$ref": "GoogleCloudSecuritycenterV2CloudArmor" }, "cloudDlpDataProfile": { -"$ref": "GoogleCloudSecuritycenterV2CloudDlpDataProfile", -"description": "Cloud DLP data profile that is associated with the finding." +"$ref": "GoogleCloudSecuritycenterV2CloudDlpDataProfile" }, "cloudDlpInspection": { -"$ref": "GoogleCloudSecuritycenterV2CloudDlpInspection", -"description": "Cloud Data Loss Prevention (Cloud DLP) inspection results that are associated with the finding." +"$ref": "GoogleCloudSecuritycenterV2CloudDlpInspection" }, "complianceDetails": { -"$ref": "GoogleCloudSecuritycenterV2ComplianceDetails", -"description": "Details about the compliance implications of the finding." +"$ref": "GoogleCloudSecuritycenterV2ComplianceDetails" }, "compliances": { -"description": "Contains compliance information for security standards associated to the finding.", "items": { "$ref": "GoogleCloudSecuritycenterV2Compliance" }, "type": "array" }, "connections": { -"description": "Contains information about the IP connection associated with the finding.", "items": { "$ref": "GoogleCloudSecuritycenterV2Connection" }, @@ -7385,99 +6412,81 @@ false "additionalProperties": { "$ref": "GoogleCloudSecuritycenterV2ContactDetails" }, -"description": "Output only. Map containing the points of contact for the given finding. The key represents the type of contact, while the value contains a list of all the contacts that pertain. Please refer to: https://cloud.google.com/resource-manager/docs/managing-notification-contacts#notification-categories { \"security\": { \"contacts\": [ { \"email\": \"person1@company.com\" }, { \"email\": \"person2@company.com\" } ] } }", "readOnly": true, "type": "object" }, "containers": { -"description": "Containers associated with the finding. This field provides information for both Kubernetes and non-Kubernetes containers.", "items": { "$ref": "GoogleCloudSecuritycenterV2Container" }, "type": "array" }, "createTime": { -"description": "Output only. The time at which the finding was created in Security Command Center.", "format": "google-datetime", "readOnly": true, "type": "string" }, "cryptoKeyName": { -"description": "Output only. The name of the Cloud KMS key used to encrypt this finding, if any.", "readOnly": true, "type": "string" }, "dataAccessEvents": { -"description": "Data access events associated with the finding.", "items": { "$ref": "GoogleCloudSecuritycenterV2DataAccessEvent" }, "type": "array" }, "dataFlowEvents": { -"description": "Data flow events associated with the finding.", "items": { "$ref": "GoogleCloudSecuritycenterV2DataFlowEvent" }, "type": "array" }, "dataRetentionDeletionEvents": { -"description": "Data retention deletion events associated with the finding.", "items": { "$ref": "GoogleCloudSecuritycenterV2DataRetentionDeletionEvent" }, "type": "array" }, "database": { -"$ref": "GoogleCloudSecuritycenterV2Database", -"description": "Database associated with the finding." +"$ref": "GoogleCloudSecuritycenterV2Database" }, "description": { -"description": "Contains more details about the finding.", "type": "string" }, "discoveredWorkload": { -"$ref": "GoogleCloudSecuritycenterV2DiscoveredWorkload", -"description": "DiscoveredWorkload associated with the finding." +"$ref": "GoogleCloudSecuritycenterV2DiscoveredWorkload" }, "disk": { -"$ref": "GoogleCloudSecuritycenterV2Disk", -"description": "Disk associated with the finding." +"$ref": "GoogleCloudSecuritycenterV2Disk" }, "eventTime": { -"description": "The time the finding was first detected. If an existing finding is updated, then this is the time the update occurred. For example, if the finding represents an open firewall, this property captures the time the detector believes the firewall became open. The accuracy is determined by the detector. If the finding is later resolved, then this time reflects when the finding was resolved. This must not be set to a value greater than the current timestamp.", "format": "google-datetime", "type": "string" }, "exfiltration": { -"$ref": "GoogleCloudSecuritycenterV2Exfiltration", -"description": "Represents exfiltrations associated with the finding." +"$ref": "GoogleCloudSecuritycenterV2Exfiltration" }, "externalExposure": { -"$ref": "GoogleCloudSecuritycenterV2ExternalExposure", -"description": "External exposure associated with the finding." +"$ref": "GoogleCloudSecuritycenterV2ExternalExposure" }, "externalSystems": { "additionalProperties": { "$ref": "GoogleCloudSecuritycenterV2ExternalSystem" }, -"description": "Output only. Third party SIEM/SOAR fields within SCC, contains external system information and external system finding fields.", "readOnly": true, "type": "object" }, "externalUri": { -"description": "The URI that, if available, points to a web page outside of Security Command Center where additional information about the finding can be found. This field is guaranteed to be either empty or a well formed URL.", "type": "string" }, "files": { -"description": "File associated with the finding.", "items": { "$ref": "GoogleCloudSecuritycenterV2File" }, "type": "array" }, "findingClass": { -"description": "The class of the finding.", "enum": [ "FINDING_CLASS_UNSPECIFIED", "THREAT", @@ -7493,79 +6502,67 @@ false "SECRET" ], "enumDescriptions": [ -"Unspecified finding class.", -"Describes unwanted or malicious activity.", -"Describes a potential weakness in software that increases risk to Confidentiality & Integrity & Availability.", -"Describes a potential weakness in cloud resource/asset configuration that increases risk.", -"Describes a security observation that is for informational purposes.", -"Describes an error that prevents some SCC functionality.", -"Describes a potential security risk due to a change in the security posture.", -"Describes a combination of security issues that represent a more severe security problem when taken together.", -"Describes a potential security risk to data assets that contain sensitive data.", -"Describes a resource or resource group where high risk attack paths converge, based on attack path simulations (APS).", -"Describes a potential security risk due to the resource being exposed to the internet.", -"Describes a potential security risk due to plaintext credentials, keys, or tokens being exposed in an asset or workload." +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"" ], "type": "string" }, "groupMemberships": { -"description": "Contains details about groups of which this finding is a member. A group is a collection of findings that are related in some way. This field cannot be updated. Its value is ignored in all update requests.", "items": { "$ref": "GoogleCloudSecuritycenterV2GroupMembership" }, "type": "array" }, "iamBindings": { -"description": "Represents IAM bindings associated with the finding.", "items": { "$ref": "GoogleCloudSecuritycenterV2IamBinding" }, "type": "array" }, "indicator": { -"$ref": "GoogleCloudSecuritycenterV2Indicator", -"description": "Represents what's commonly known as an *indicator of compromise* (IoC) in computer forensics. This is an artifact observed on a network or in an operating system that, with high confidence, indicates a computer intrusion. For more information, see [Indicator of compromise](https://en.wikipedia.org/wiki/Indicator_of_compromise)." +"$ref": "GoogleCloudSecuritycenterV2Indicator" }, "ipRules": { -"$ref": "GoogleCloudSecuritycenterV2IpRules", -"description": "IP rules associated with the finding." +"$ref": "GoogleCloudSecuritycenterV2IpRules" }, "job": { -"$ref": "GoogleCloudSecuritycenterV2Job", -"description": "Job associated with the finding." +"$ref": "GoogleCloudSecuritycenterV2Job" }, "kernelRootkit": { -"$ref": "GoogleCloudSecuritycenterV2KernelRootkit", -"description": "Signature of the kernel rootkit." +"$ref": "GoogleCloudSecuritycenterV2KernelRootkit" }, "kubernetes": { -"$ref": "GoogleCloudSecuritycenterV2Kubernetes", -"description": "Kubernetes resources associated with the finding." +"$ref": "GoogleCloudSecuritycenterV2Kubernetes" }, "loadBalancers": { -"description": "The load balancers associated with the finding.", "items": { "$ref": "GoogleCloudSecuritycenterV2LoadBalancer" }, "type": "array" }, "logEntries": { -"description": "Log entries that are relevant to the finding.", "items": { "$ref": "GoogleCloudSecuritycenterV2LogEntry" }, "type": "array" }, "mitreAttack": { -"$ref": "GoogleCloudSecuritycenterV2MitreAttack", -"description": "MITRE ATT&CK tactics and techniques related to this finding. See: https://attack.mitre.org" +"$ref": "GoogleCloudSecuritycenterV2MitreAttack" }, "moduleName": { -"description": "Unique identifier of the module which generated the finding. Example: folders/598186756061/securityHealthAnalyticsSettings/customModules/56799441161885", "type": "string" }, "mute": { -"description": "Indicates the mute state of a finding (either muted, unmuted or undefined). Unlike other attributes of a finding, a finding provider shouldn't set the value of mute.", "enum": [ "MUTE_UNSPECIFIED", "MUTED", @@ -7573,93 +6570,76 @@ false "UNDEFINED" ], "enumDescriptions": [ -"Unspecified.", -"Finding has been muted.", -"Finding has been unmuted.", -"Finding has never been muted/unmuted." +"", +"", +"", +"" ], "type": "string" }, "muteInfo": { "$ref": "GoogleCloudSecuritycenterV2MuteInfo", -"description": "Output only. The mute information regarding this finding.", "readOnly": true }, "muteInitiator": { -"description": "Records additional information about the mute operation, for example, the [mute configuration](https://cloud.google.com/security-command-center/docs/how-to-mute-findings) that muted the finding and the user who muted the finding.", "type": "string" }, "muteUpdateTime": { -"description": "Output only. The most recent time this finding was muted or unmuted.", "format": "google-datetime", "readOnly": true, "type": "string" }, "name": { -"description": "Identifier. The [relative resource name](https://cloud.google.com/apis/design/resource_names#relative_resource_name) of the finding. The following list shows some examples: + `organizations/{organization_id}/sources/{source_id}/findings/{finding_id}` + `organizations/{organization_id}/sources/{source_id}/locations/{location_id}/findings/{finding_id}` + `folders/{folder_id}/sources/{source_id}/findings/{finding_id}` + `folders/{folder_id}/sources/{source_id}/locations/{location_id}/findings/{finding_id}` + `projects/{project_id}/sources/{source_id}/findings/{finding_id}` + `projects/{project_id}/sources/{source_id}/locations/{location_id}/findings/{finding_id}`", "type": "string" }, "networks": { -"description": "Represents the VPC networks that the resource is attached to.", "items": { "$ref": "GoogleCloudSecuritycenterV2Network" }, "type": "array" }, "nextSteps": { -"description": "Steps to address the finding.", "type": "string" }, "notebook": { -"$ref": "GoogleCloudSecuritycenterV2Notebook", -"description": "Notebook associated with the finding." +"$ref": "GoogleCloudSecuritycenterV2Notebook" }, "orgPolicies": { -"description": "Contains information about the org policies associated with the finding.", "items": { "$ref": "GoogleCloudSecuritycenterV2OrgPolicy" }, "type": "array" }, "parent": { -"description": "The relative resource name of the source and location the finding belongs to. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name This field is immutable after creation time. The following list shows some examples: + `organizations/{organization_id}/sources/{source_id}` + `folders/{folders_id}/sources/{source_id}` + `projects/{projects_id}/sources/{source_id}` + `organizations/{organization_id}/sources/{source_id}/locations/{location_id}` + `folders/{folders_id}/sources/{source_id}/locations/{location_id}` + `projects/{projects_id}/sources/{source_id}/locations/{location_id}`", "type": "string" }, "parentDisplayName": { -"description": "Output only. The human readable display name of the finding source such as \"Event Threat Detection\" or \"Security Health Analytics\".", "readOnly": true, "type": "string" }, "policyViolationSummary": { -"$ref": "GoogleCloudSecuritycenterV2PolicyViolationSummary", -"description": "PolicyViolationSummary associated with the finding." +"$ref": "GoogleCloudSecuritycenterV2PolicyViolationSummary" }, "processes": { -"description": "Represents operating system processes associated with the Finding.", "items": { "$ref": "GoogleCloudSecuritycenterV2Process" }, "type": "array" }, "resourceName": { -"description": "Immutable. For findings on Google Cloud resources, the full resource name of the Google Cloud resource this finding is for. See: https://cloud.google.com/apis/design/resource_names#full_resource_name When the finding is for a non-Google Cloud resource, the resourceName can be a customer or partner defined string.", "type": "string" }, "secret": { -"$ref": "GoogleCloudSecuritycenterV2Secret", -"description": "Secret associated with the finding." +"$ref": "GoogleCloudSecuritycenterV2Secret" }, "securityMarks": { "$ref": "GoogleCloudSecuritycenterV2SecurityMarks", -"description": "Output only. User specified security marks. These marks are entirely managed by the user and come from the SecurityMarks resource that belongs to the finding.", "readOnly": true }, "securityPosture": { -"$ref": "GoogleCloudSecuritycenterV2SecurityPosture", -"description": "The security posture associated with the finding." +"$ref": "GoogleCloudSecuritycenterV2SecurityPosture" }, "severity": { -"description": "The severity of the finding. This field is managed by the source that writes the finding.", "enum": [ "SEVERITY_UNSPECIFIED", "CRITICAL", @@ -7668,11 +6648,11 @@ false "LOW" ], "enumDescriptions": [ -"This value is used for findings when a source doesn't write a severity value.", -"Vulnerability: A critical vulnerability is easily discoverable by an external actor, exploitable, and results in the direct ability to execute arbitrary code, exfiltrate data, and otherwise gain additional access and privileges to cloud resources and workloads. Examples include publicly accessible unprotected user data and public SSH access with weak or no passwords. Threat: Indicates a threat that is able to access, modify, or delete data or execute unauthorized code within existing resources.", -"Vulnerability: A high risk vulnerability can be easily discovered and exploited in combination with other vulnerabilities in order to gain direct access and the ability to execute arbitrary code, exfiltrate data, and otherwise gain additional access and privileges to cloud resources and workloads. An example is a database with weak or no passwords that is only accessible internally. This database could easily be compromised by an actor that had access to the internal network. Threat: Indicates a threat that is able to create new computational resources in an environment but not able to access data or execute code in existing resources.", -"Vulnerability: A medium risk vulnerability could be used by an actor to gain access to resources or privileges that enable them to eventually (through multiple steps or a complex exploit) gain access and the ability to execute arbitrary code or exfiltrate data. An example is a service account with access to more projects than it should have. If an actor gains access to the service account, they could potentially use that access to manipulate a project the service account was not intended to. Threat: Indicates a threat that is able to cause operational impact but may not access data or execute unauthorized code.", -"Vulnerability: A low risk vulnerability hampers a security organization's ability to detect vulnerabilities or active threats in their deployment, or prevents the root cause investigation of security issues. An example is monitoring and logs being disabled for resource configurations and access. Threat: Indicates a threat that has obtained minimal access to an environment but is not able to access data, execute code, or create resources." +"", +"", +"", +"", +"" ], "type": "string" }, @@ -7680,60 +6660,50 @@ false "additionalProperties": { "type": "any" }, -"description": "Source specific properties. These properties are managed by the source that writes the finding. The key names in the source_properties map must be between 1 and 255 characters, and must start with a letter and contain alphanumeric characters or underscores only.", "type": "object" }, "state": { -"description": "Output only. The state of the finding.", "enum": [ "STATE_UNSPECIFIED", "ACTIVE", "INACTIVE" ], "enumDescriptions": [ -"Unspecified state.", -"The finding requires attention and has not been addressed yet.", -"The finding has been fixed, triaged as a non-issue or otherwise addressed and is no longer active." +"", +"", +"" ], "readOnly": true, "type": "string" }, "toxicCombination": { -"$ref": "GoogleCloudSecuritycenterV2ToxicCombination", -"description": "Contains details about a group of security issues that, when the issues occur together, represent a greater risk than when the issues occur independently. A group of such issues is referred to as a toxic combination. This field cannot be updated. Its value is ignored in all update requests." +"$ref": "GoogleCloudSecuritycenterV2ToxicCombination" }, "vertexAi": { -"$ref": "GoogleCloudSecuritycenterV2VertexAi", -"description": "VertexAi associated with the finding." +"$ref": "GoogleCloudSecuritycenterV2VertexAi" }, "vulnerability": { -"$ref": "GoogleCloudSecuritycenterV2Vulnerability", -"description": "Represents vulnerability-specific fields like CVE and CVSS scores. CVE stands for Common Vulnerabilities and Exposures (https://cve.mitre.org/about/)" +"$ref": "GoogleCloudSecuritycenterV2Vulnerability" } }, "type": "object" }, "GoogleCloudSecuritycenterV2Folder": { -"description": "Message that contains the resource name and display name of a folder resource.", "id": "GoogleCloudSecuritycenterV2Folder", "properties": { "resourceFolder": { -"description": "Full resource name of this folder. See: https://cloud.google.com/apis/design/resource_names#full_resource_name", "type": "string" }, "resourceFolderDisplayName": { -"description": "The user defined display name for this folder.", "type": "string" } }, "type": "object" }, "GoogleCloudSecuritycenterV2Framework": { -"description": "Compliance framework associated with the finding.", "id": "GoogleCloudSecuritycenterV2Framework", "properties": { "category": { -"description": "Category of the framework associated with the finding. E.g. Security Benchmark, or Assured Workloads", "items": { "enum": [ "FRAMEWORK_CATEGORY_UNSPECIFIED", @@ -7744,43 +6714,39 @@ false "CUSTOM_FRAMEWORK" ], "enumDescriptions": [ -"Default value. This value is unused.", -"Security Benchmarks framework", -"Assured Workloads framework", -"Data Security framework", -"Google Best Practices framework", -"A user-created framework" +"", +"", +"", +"", +"", +"" ], "type": "string" }, "type": "array" }, "controls": { -"description": "The controls associated with the framework.", "items": { "$ref": "GoogleCloudSecuritycenterV2Control" }, "type": "array" }, "displayName": { -"description": "Display name of the framework. For a standard framework, this will look like e.g. PCI DSS 3.2.1, whereas for a custom framework it can be a user defined string like MyFramework", "type": "string" }, "name": { -"description": "Name of the framework associated with the finding", "type": "string" }, "type": { -"description": "Type of the framework associated with the finding, to specify whether the framework is built-in (pre-defined and immutable) or a custom framework defined by the customer (equivalent to security posture)", "enum": [ "FRAMEWORK_TYPE_UNSPECIFIED", "FRAMEWORK_TYPE_BUILT_IN", "FRAMEWORK_TYPE_CUSTOM" ], "enumDescriptions": [ -"Default value. This value is unused.", -"The framework is a built-in framework if it is created and managed by GCP.", -"The framework is a custom framework if it is created and managed by the user." +"", +"", +"" ], "type": "string" } @@ -7788,35 +6754,30 @@ false "type": "object" }, "GoogleCloudSecuritycenterV2Geolocation": { -"description": "Represents a geographical location for a given access.", "id": "GoogleCloudSecuritycenterV2Geolocation", "properties": { "regionCode": { -"description": "A CLDR.", "type": "string" } }, "type": "object" }, "GoogleCloudSecuritycenterV2GroupMembership": { -"description": "Contains details about groups of which this finding is a member. A group is a collection of findings that are related in some way.", "id": "GoogleCloudSecuritycenterV2GroupMembership", "properties": { "groupId": { -"description": "ID of the group.", "type": "string" }, "groupType": { -"description": "Type of group.", "enum": [ "GROUP_TYPE_UNSPECIFIED", "GROUP_TYPE_TOXIC_COMBINATION", "GROUP_TYPE_CHOKEPOINT" ], "enumDescriptions": [ -"Default value.", -"Group represents a toxic combination.", -"Group represents a chokepoint." +"", +"", +"" ], "type": "string" } @@ -7824,76 +6785,64 @@ false "type": "object" }, "GoogleCloudSecuritycenterV2HttpResponse": { -"description": "The http response returned by the web application.", "id": "GoogleCloudSecuritycenterV2HttpResponse", "properties": { "path": { -"description": "The http path for which response code was returned by web application, for example, \"https://test-app.a.run.app/test\".", "type": "string" }, "statusCode": { -"description": "The http response code returned by the web application, for example, 200.", "type": "string" } }, "type": "object" }, "GoogleCloudSecuritycenterV2IamBinding": { -"description": "Represents a particular IAM binding, which captures a member's role addition, removal, or state.", "id": "GoogleCloudSecuritycenterV2IamBinding", "properties": { "action": { -"description": "The action that was performed on a Binding.", "enum": [ "ACTION_UNSPECIFIED", "ADD", "REMOVE" ], "enumDescriptions": [ -"Unspecified.", -"Addition of a Binding.", -"Removal of a Binding." +"", +"", +"" ], "type": "string" }, "member": { -"description": "A single identity requesting access for a Cloud Platform resource, for example, \"foo@google.com\".", "type": "string" }, "role": { -"description": "Role that is assigned to \"members\". For example, \"roles/viewer\", \"roles/editor\", or \"roles/owner\".", "type": "string" } }, "type": "object" }, "GoogleCloudSecuritycenterV2Indicator": { -"description": "Represents what's commonly known as an _indicator of compromise_ (IoC) in computer forensics. This is an artifact observed on a network or in an operating system that, with high confidence, indicates a computer intrusion. For more information, see [Indicator of compromise](https://en.wikipedia.org/wiki/Indicator_of_compromise).", "id": "GoogleCloudSecuritycenterV2Indicator", "properties": { "domains": { -"description": "List of domains associated to the Finding.", "items": { "type": "string" }, "type": "array" }, "ipAddresses": { -"description": "The list of IP addresses that are associated with the finding.", "items": { "type": "string" }, "type": "array" }, "signatures": { -"description": "The list of matched signatures indicating that the given process is present in the environment.", "items": { "$ref": "GoogleCloudSecuritycenterV2ProcessSignature" }, "type": "array" }, "uris": { -"description": "The list of URIs associated to the Findings.", "items": { "type": "string" }, @@ -7903,84 +6852,70 @@ false "type": "object" }, "GoogleCloudSecuritycenterV2InfoType": { -"description": "Type of information detected by the API.", "id": "GoogleCloudSecuritycenterV2InfoType", "properties": { "name": { -"description": "Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`.", "type": "string" }, "sensitivityScore": { -"$ref": "GoogleCloudSecuritycenterV2SensitivityScore", -"description": "Optional custom sensitivity for this InfoType. This only applies to data profiling." +"$ref": "GoogleCloudSecuritycenterV2SensitivityScore" }, "version": { -"description": "Optional version name for this InfoType.", "type": "string" } }, "type": "object" }, "GoogleCloudSecuritycenterV2IpRule": { -"description": "IP rule information.", "id": "GoogleCloudSecuritycenterV2IpRule", "properties": { "portRanges": { -"description": "Optional. An optional list of ports to which this rule applies. This field is only applicable for the UDP or (S)TCP protocols. Each entry must be either an integer or a range including a min and max port number.", "items": { "$ref": "GoogleCloudSecuritycenterV2PortRange" }, "type": "array" }, "protocol": { -"description": "The IP protocol this rule applies to. This value can either be one of the following well known protocol strings (TCP, UDP, ICMP, ESP, AH, IPIP, SCTP) or a string representation of the integer value.", "type": "string" } }, "type": "object" }, "GoogleCloudSecuritycenterV2IpRules": { -"description": "IP rules associated with the finding.", "id": "GoogleCloudSecuritycenterV2IpRules", "properties": { "allowed": { -"$ref": "GoogleCloudSecuritycenterV2Allowed", -"description": "Tuple with allowed rules." +"$ref": "GoogleCloudSecuritycenterV2Allowed" }, "denied": { -"$ref": "GoogleCloudSecuritycenterV2Denied", -"description": "Tuple with denied rules." +"$ref": "GoogleCloudSecuritycenterV2Denied" }, "destinationIpRanges": { -"description": "If destination IP ranges are specified, the firewall rule applies only to traffic that has a destination IP address in these ranges. These ranges must be expressed in CIDR format. Only supports IPv4.", "items": { "type": "string" }, "type": "array" }, "direction": { -"description": "The direction that the rule is applicable to, one of ingress or egress.", "enum": [ "DIRECTION_UNSPECIFIED", "INGRESS", "EGRESS" ], "enumDescriptions": [ -"Unspecified direction value.", -"Ingress direction value.", -"Egress direction value." +"", +"", +"" ], "type": "string" }, "exposedServices": { -"description": "Name of the network protocol service, such as FTP, that is exposed by the open port. Follows the naming convention available at: https://www.iana.org/assignments/service-names-port-numbers/service-names-port-numbers.xhtml.", "items": { "type": "string" }, "type": "array" }, "sourceIpRanges": { -"description": "If source IP ranges are specified, the firewall rule applies only to traffic that has a source IP address in these ranges. These ranges must be expressed in CIDR format. Only supports IPv4.", "items": { "type": "string" }, @@ -7990,37 +6925,30 @@ false "type": "object" }, "GoogleCloudSecuritycenterV2Issue": { -"description": "Security Command Center Issue.", "id": "GoogleCloudSecuritycenterV2Issue", "properties": { "createTime": { -"description": "Output only. The time the issue was created.", "format": "google-datetime", "readOnly": true, "type": "string" }, "description": { -"description": "The description of the issue in Markdown format.", "type": "string" }, "detection": { -"description": "The finding category or rule name that generated the issue.", "type": "string" }, "domains": { -"description": "The domains of the issue.", "items": { "$ref": "GoogleCloudSecuritycenterV2IssueDomain" }, "type": "array" }, "exposureScore": { -"description": "The exposure score of the issue.", "format": "double", "type": "number" }, "issueType": { -"description": "The type of the issue.", "enum": [ "ISSUE_TYPE_UNSPECIFIED", "CHOKEPOINT", @@ -8028,60 +6956,51 @@ false "INSIGHT" ], "enumDescriptions": [ -"Unspecified issue type.", -"Chokepoint issue type.", -"Toxic combination issue type.", -"Insight issue type." +"", +"", +"", +"" ], "type": "string" }, "lastObservationTime": { -"description": "The time the issue was last observed.", "format": "google-datetime", "type": "string" }, "mute": { -"$ref": "GoogleCloudSecuritycenterV2IssueMute", -"description": "The mute information of the issue." +"$ref": "GoogleCloudSecuritycenterV2IssueMute" }, "name": { -"description": "Identifier. The name of the issue. Format: organizations/{organization}/locations/{location}/issues/{issue}", "type": "string" }, "primaryResource": { -"$ref": "GoogleCloudSecuritycenterV2IssueResource", -"description": "The primary resource associated with the issue." +"$ref": "GoogleCloudSecuritycenterV2IssueResource" }, "relatedFindings": { -"description": "The findings related to the issue.", "items": { "$ref": "GoogleCloudSecuritycenterV2IssueFinding" }, "type": "array" }, "remediations": { -"description": "Approaches to remediate the issue in Markdown format.", "items": { "type": "string" }, "type": "array" }, "secondaryResources": { -"description": "Additional resources associated with the issue.", "items": { "$ref": "GoogleCloudSecuritycenterV2IssueResource" }, "type": "array" }, "securityContexts": { -"description": "The security context of the issue.", "items": { "$ref": "GoogleCloudSecuritycenterV2IssueSecurityContext" }, "type": "array" }, "severity": { -"description": "The severity of the issue.", "enum": [ "SEVERITY_UNSPECIFIED", "CRITICAL", @@ -8090,31 +7009,29 @@ false "LOW" ], "enumDescriptions": [ -"Unspecified severity.", -"Critical severity.", -"High severity.", -"Medium severity.", -"Low severity." +"", +"", +"", +"", +"" ], "type": "string" }, "state": { -"description": "Output only. The state of the issue.", "enum": [ "STATE_UNSPECIFIED", "ACTIVE", "INACTIVE" ], "enumDescriptions": [ -"Unspecified state.", -"Active state.", -"Inactive state." +"", +"", +"" ], "readOnly": true, "type": "string" }, "updateTime": { -"description": "Output only. The time the issue was last updated.", "format": "google-datetime", "readOnly": true, "type": "string" @@ -8123,11 +7040,9 @@ false "type": "object" }, "GoogleCloudSecuritycenterV2IssueDomain": { -"description": "The domains of an issue.", "id": "GoogleCloudSecuritycenterV2IssueDomain", "properties": { "domainCategory": { -"description": "The domain category of the issue.", "enum": [ "DOMAIN_CATEGORY_UNSPECIFIED", "AI", @@ -8139,14 +7054,14 @@ false "THREAT" ], "enumDescriptions": [ -"Unspecified domain category.", -"Issues in the AI domain.", -"Issues in the code domain.", -"Issues in the container domain.", -"Issues in the data domain.", -"Issues in the identity and access domain.", -"Issues in the vulnerability domain.", -"Issues in the threat domain." +"", +"", +"", +"", +"", +"", +"", +"" ], "type": "string" } @@ -8154,75 +7069,62 @@ false "type": "object" }, "GoogleCloudSecuritycenterV2IssueFinding": { -"description": "Finding related to an issue.", "id": "GoogleCloudSecuritycenterV2IssueFinding", "properties": { "cve": { -"$ref": "GoogleCloudSecuritycenterV2IssueFindingCve", -"description": "The CVE of the finding." +"$ref": "GoogleCloudSecuritycenterV2IssueFindingCve" }, "name": { -"description": "The name of the finding.", "type": "string" }, "securityBulletin": { -"$ref": "GoogleCloudSecuritycenterV2IssueFindingSecurityBulletin", -"description": "The security bulletin of the finding." +"$ref": "GoogleCloudSecuritycenterV2IssueFindingSecurityBulletin" } }, "type": "object" }, "GoogleCloudSecuritycenterV2IssueFindingCve": { -"description": "The CVE of the finding.", "id": "GoogleCloudSecuritycenterV2IssueFindingCve", "properties": { "name": { -"description": "The CVE name.", "type": "string" } }, "type": "object" }, "GoogleCloudSecuritycenterV2IssueFindingSecurityBulletin": { -"description": "The security bulletin of the finding.", "id": "GoogleCloudSecuritycenterV2IssueFindingSecurityBulletin", "properties": { "name": { -"description": "The security bulletin name.", "type": "string" } }, "type": "object" }, "GoogleCloudSecuritycenterV2IssueMute": { -"description": "The mute information of the issue.", "id": "GoogleCloudSecuritycenterV2IssueMute", "properties": { "muteInitiator": { -"description": "The email address of the user who last changed the mute state of the issue.", "type": "string" }, "muteReason": { -"description": "The user-provided reason for muting the issue.", "type": "string" }, "muteState": { -"description": "Output only. The mute state of the issue.", "enum": [ "MUTE_STATE_UNSPECIFIED", "NOT_MUTED", "MUTED" ], "enumDescriptions": [ -"Unspecified mute state.", -"Not muted.", -"Muted." +"", +"", +"" ], "readOnly": true, "type": "string" }, "muteUpdateTime": { -"description": "The time the issue was muted.", "format": "google-datetime", "type": "string" } @@ -8230,35 +7132,27 @@ false "type": "object" }, "GoogleCloudSecuritycenterV2IssueResource": { -"description": "A resource associated with the an issue.", "id": "GoogleCloudSecuritycenterV2IssueResource", "properties": { "adcApplication": { -"$ref": "GoogleCloudSecuritycenterV2IssueResourceAdcApplication", -"description": "The ADC application associated with the finding." +"$ref": "GoogleCloudSecuritycenterV2IssueResourceAdcApplication" }, "adcApplicationTemplate": { -"$ref": "GoogleCloudSecuritycenterV2IssueResourceAdcApplicationTemplateRevision", -"description": "The ADC template associated with the finding." +"$ref": "GoogleCloudSecuritycenterV2IssueResourceAdcApplicationTemplateRevision" }, "adcSharedTemplate": { -"$ref": "GoogleCloudSecuritycenterV2IssueResourceAdcSharedTemplateRevision", -"description": "The ADC shared template associated with the finding." +"$ref": "GoogleCloudSecuritycenterV2IssueResourceAdcSharedTemplateRevision" }, "application": { -"$ref": "GoogleCloudSecuritycenterV2IssueResourceApplication", -"description": "The AppHub application associated with the resource, if any. Only populated for the primary resource." +"$ref": "GoogleCloudSecuritycenterV2IssueResourceApplication" }, "awsMetadata": { -"$ref": "GoogleCloudSecuritycenterV2IssueResourceAwsMetadata", -"description": "The AWS metadata of the resource associated with the issue. Only populated for AWS resources." +"$ref": "GoogleCloudSecuritycenterV2IssueResourceAwsMetadata" }, "azureMetadata": { -"$ref": "GoogleCloudSecuritycenterV2IssueResourceAzureMetadata", -"description": "The Azure metadata of the resource associated with the issue. Only populated for Azure resources." +"$ref": "GoogleCloudSecuritycenterV2IssueResourceAzureMetadata" }, "cloudProvider": { -"description": "The cloud provider of the resource associated with the issue.", "enum": [ "CLOUD_PROVIDER_UNSPECIFIED", "GOOGLE_CLOUD", @@ -8266,112 +7160,92 @@ false "MICROSOFT_AZURE" ], "enumDescriptions": [ -"Unspecified cloud provider.", -"Google Cloud.", -"Amazon Web Services.", -"Microsoft Azure." +"", +"", +"", +"" ], "type": "string" }, "displayName": { -"description": "The resource-type specific display name of the resource associated with the issue.", "type": "string" }, "googleCloudMetadata": { -"$ref": "GoogleCloudSecuritycenterV2IssueResourceGoogleCloudMetadata", -"description": "The Google Cloud metadata of the resource associated with the issue. Only populated for Google Cloud resources." +"$ref": "GoogleCloudSecuritycenterV2IssueResourceGoogleCloudMetadata" }, "name": { -"description": "The full resource name of the resource associated with the issue.", "type": "string" }, "type": { -"description": "The type of the resource associated with the issue.", "type": "string" } }, "type": "object" }, "GoogleCloudSecuritycenterV2IssueResourceAdcApplication": { -"description": "Represents an ADC application associated with the finding.", "id": "GoogleCloudSecuritycenterV2IssueResourceAdcApplication", "properties": { "attributes": { -"$ref": "GoogleCloudSecuritycenterV2IssueResourceApplicationAttributes", -"description": "Consumer provided attributes for the AppHub application." +"$ref": "GoogleCloudSecuritycenterV2IssueResourceApplicationAttributes" }, "name": { -"description": "The resource name of an ADC Application. Format: projects/{project}/locations/{location}/spaces/{space}/applications/{application}", "type": "string" } }, "type": "object" }, "GoogleCloudSecuritycenterV2IssueResourceAdcApplicationTemplateRevision": { -"description": "Represents an ADC template associated with the finding.", "id": "GoogleCloudSecuritycenterV2IssueResourceAdcApplicationTemplateRevision", "properties": { "name": { -"description": "The resource name of an ADC Application Template Revision. Format: projects/{project}/locations/{location}/spaces/{space}/applicationTemplates/{application_template}/revisions/{revision}", "type": "string" } }, "type": "object" }, "GoogleCloudSecuritycenterV2IssueResourceAdcSharedTemplateRevision": { -"description": "Represents an ADC shared template associated with the finding.", "id": "GoogleCloudSecuritycenterV2IssueResourceAdcSharedTemplateRevision", "properties": { "name": { -"description": "The resource name of an ADC Shared Template Revision. Format: projects/{project}/locations/{location}/spaces/{space}/applicationTemplates/{application_template}/revisions/{revision}", "type": "string" } }, "type": "object" }, "GoogleCloudSecuritycenterV2IssueResourceApplication": { -"description": "The AppHub application associated with the resource, if any.", "id": "GoogleCloudSecuritycenterV2IssueResourceApplication", "properties": { "attributes": { -"$ref": "GoogleCloudSecuritycenterV2IssueResourceApplicationAttributes", -"description": "Consumer provided attributes for the application" +"$ref": "GoogleCloudSecuritycenterV2IssueResourceApplicationAttributes" }, "name": { -"description": "The resource name of an Application. Format: `projects/{host-project-id}/locations/{location}/applications/{application-id}`", "type": "string" } }, "type": "object" }, "GoogleCloudSecuritycenterV2IssueResourceApplicationAttributes": { -"description": "Consumer provided attributes for the application", "id": "GoogleCloudSecuritycenterV2IssueResourceApplicationAttributes", "properties": { "businessOwners": { -"description": "Business team that ensures user needs are met and value is delivered", "items": { "$ref": "GoogleCloudSecuritycenterV2IssueResourceApplicationAttributesContactInfo" }, "type": "array" }, "criticality": { -"$ref": "GoogleCloudSecuritycenterV2IssueResourceApplicationAttributesCriticality", -"description": "User-defined criticality information." +"$ref": "GoogleCloudSecuritycenterV2IssueResourceApplicationAttributesCriticality" }, "developerOwners": { -"description": "Developer team that owns development and coding.", "items": { "$ref": "GoogleCloudSecuritycenterV2IssueResourceApplicationAttributesContactInfo" }, "type": "array" }, "environment": { -"$ref": "GoogleCloudSecuritycenterV2IssueResourceApplicationAttributesEnvironment", -"description": "User-defined environment information." +"$ref": "GoogleCloudSecuritycenterV2IssueResourceApplicationAttributesEnvironment" }, "operatorOwners": { -"description": "Operator team that ensures runtime and operations.", "items": { "$ref": "GoogleCloudSecuritycenterV2IssueResourceApplicationAttributesContactInfo" }, @@ -8381,22 +7255,18 @@ false "type": "object" }, "GoogleCloudSecuritycenterV2IssueResourceApplicationAttributesContactInfo": { -"description": "Contact information of stakeholders.", "id": "GoogleCloudSecuritycenterV2IssueResourceApplicationAttributesContactInfo", "properties": { "email": { -"description": "Email address of the contacts.", "type": "string" } }, "type": "object" }, "GoogleCloudSecuritycenterV2IssueResourceApplicationAttributesCriticality": { -"description": "Criticality of the Application, Service, or Workload", "id": "GoogleCloudSecuritycenterV2IssueResourceApplicationAttributesCriticality", "properties": { "type": { -"description": "Criticality Type.", "enum": [ "CRITICALITY_TYPE_UNSPECIFIED", "MISSION_CRITICAL", @@ -8405,11 +7275,11 @@ false "LOW" ], "enumDescriptions": [ -"Unspecified type.", -"Mission critical service, application or workload.", -"High impact.", -"Medium impact.", -"Low impact." +"", +"", +"", +"", +"" ], "type": "string" } @@ -8417,11 +7287,9 @@ false "type": "object" }, "GoogleCloudSecuritycenterV2IssueResourceApplicationAttributesEnvironment": { -"description": "Environment of the Application, Service, or Workload", "id": "GoogleCloudSecuritycenterV2IssueResourceApplicationAttributesEnvironment", "properties": { "type": { -"description": "Environment Type.", "enum": [ "ENVIRONMENT_TYPE_UNSPECIFIED", "PRODUCTION", @@ -8430,11 +7298,11 @@ false "DEVELOPMENT" ], "enumDescriptions": [ -"Unspecified type.", -"Production environment.", -"Staging environment.", -"Test environment.", -"Development environment." +"", +"", +"", +"", +"" ], "type": "string" } @@ -8442,93 +7310,75 @@ false "type": "object" }, "GoogleCloudSecuritycenterV2IssueResourceAwsMetadata": { -"description": "The AWS metadata of a resource associated with an issue.", "id": "GoogleCloudSecuritycenterV2IssueResourceAwsMetadata", "properties": { "account": { -"$ref": "GoogleCloudSecuritycenterV2IssueResourceAwsMetadataAwsAccount", -"description": "The AWS account of the resource associated with the issue." +"$ref": "GoogleCloudSecuritycenterV2IssueResourceAwsMetadataAwsAccount" } }, "type": "object" }, "GoogleCloudSecuritycenterV2IssueResourceAwsMetadataAwsAccount": { -"description": "The AWS account of the resource associated with the issue.", "id": "GoogleCloudSecuritycenterV2IssueResourceAwsMetadataAwsAccount", "properties": { "id": { -"description": "The AWS account ID of the resource associated with the issue.", "type": "string" }, "name": { -"description": "The AWS account name of the resource associated with the issue.", "type": "string" } }, "type": "object" }, "GoogleCloudSecuritycenterV2IssueResourceAzureMetadata": { -"description": "The Azure metadata of a resource associated with an issue.", "id": "GoogleCloudSecuritycenterV2IssueResourceAzureMetadata", "properties": { "subscription": { -"$ref": "GoogleCloudSecuritycenterV2IssueResourceAzureMetadataAzureSubscription", -"description": "The Azure subscription of the resource associated with the issue." +"$ref": "GoogleCloudSecuritycenterV2IssueResourceAzureMetadataAzureSubscription" } }, "type": "object" }, "GoogleCloudSecuritycenterV2IssueResourceAzureMetadataAzureSubscription": { -"description": "The Azure subscription of the resource associated with the issue.", "id": "GoogleCloudSecuritycenterV2IssueResourceAzureMetadataAzureSubscription", "properties": { "displayName": { -"description": "The Azure subscription display name of the resource associated with the issue.", "type": "string" }, "id": { -"description": "The Azure subscription ID of the resource associated with the issue.", "type": "string" } }, "type": "object" }, "GoogleCloudSecuritycenterV2IssueResourceGoogleCloudMetadata": { -"description": "Google Cloud metadata of a resource associated with an issue.", "id": "GoogleCloudSecuritycenterV2IssueResourceGoogleCloudMetadata", "properties": { "projectId": { -"description": "The project ID that the resource associated with the issue belongs to.", "type": "string" } }, "type": "object" }, "GoogleCloudSecuritycenterV2IssueSecurityContext": { -"description": "Security context associated with an issue.", "id": "GoogleCloudSecuritycenterV2IssueSecurityContext", "properties": { "aggregatedCount": { -"$ref": "GoogleCloudSecuritycenterV2IssueSecurityContextAggregatedCount", -"description": "The aggregated count of the security context." +"$ref": "GoogleCloudSecuritycenterV2IssueSecurityContextAggregatedCount" }, "context": { -"$ref": "GoogleCloudSecuritycenterV2IssueSecurityContextContext", -"description": "The context of the security context." +"$ref": "GoogleCloudSecuritycenterV2IssueSecurityContextContext" } }, "type": "object" }, "GoogleCloudSecuritycenterV2IssueSecurityContextAggregatedCount": { -"description": "Aggregated count of a security context.", "id": "GoogleCloudSecuritycenterV2IssueSecurityContextAggregatedCount", "properties": { "key": { -"description": "Aggregation key.", "type": "string" }, "value": { -"description": "Aggregation value.", "format": "int32", "type": "integer" } @@ -8536,15 +7386,12 @@ false "type": "object" }, "GoogleCloudSecuritycenterV2IssueSecurityContextContext": { -"description": "Context of a security context.", "id": "GoogleCloudSecuritycenterV2IssueSecurityContextContext", "properties": { "type": { -"description": "Context type.", "type": "string" }, "values": { -"description": "Context values.", "items": { "type": "string" }, @@ -8554,24 +7401,19 @@ false "type": "object" }, "GoogleCloudSecuritycenterV2Job": { -"description": "Describes a job", "id": "GoogleCloudSecuritycenterV2Job", "properties": { "errorCode": { -"description": "Optional. If the job did not complete successfully, this field describes why.", "format": "int32", "type": "integer" }, "location": { -"description": "Optional. Gives the location where the job ran, such as `US` or `europe-west1`", "type": "string" }, "name": { -"description": "The fully-qualified name for a job. e.g. `projects//jobs/`", "type": "string" }, "state": { -"description": "Output only. State of the job, such as `RUNNING` or `PENDING`.", "enum": [ "JOB_STATE_UNSPECIFIED", "PENDING", @@ -8580,11 +7422,11 @@ false "FAILED" ], "enumDescriptions": [ -"Unspecified represents an unknown state and should not be used.", -"Job is scheduled and pending for run", -"Job in progress", -"Job has completed with success", -"Job has completed but with failure" +"", +"", +"", +"", +"" ], "readOnly": true, "type": "string" @@ -8593,96 +7435,78 @@ false "type": "object" }, "GoogleCloudSecuritycenterV2KernelRootkit": { -"description": "Kernel mode rootkit signatures.", "id": "GoogleCloudSecuritycenterV2KernelRootkit", "properties": { "name": { -"description": "Rootkit name, when available.", "type": "string" }, "unexpectedCodeModification": { -"description": "True if unexpected modifications of kernel code memory are present.", "type": "boolean" }, "unexpectedFtraceHandler": { -"description": "True if `ftrace` points are present with callbacks pointing to regions that are not in the expected kernel or module code range.", "type": "boolean" }, "unexpectedInterruptHandler": { -"description": "True if interrupt handlers that are are not in the expected kernel or module code regions are present.", "type": "boolean" }, "unexpectedKernelCodePages": { -"description": "True if kernel code pages that are not in the expected kernel or module code regions are present.", "type": "boolean" }, "unexpectedKprobeHandler": { -"description": "True if `kprobe` points are present with callbacks pointing to regions that are not in the expected kernel or module code range.", "type": "boolean" }, "unexpectedProcessesInRunqueue": { -"description": "True if unexpected processes in the scheduler run queue are present. Such processes are in the run queue, but not in the process task list.", "type": "boolean" }, "unexpectedReadOnlyDataModification": { -"description": "True if unexpected modifications of kernel read-only data memory are present.", "type": "boolean" }, "unexpectedSystemCallHandler": { -"description": "True if system call handlers that are are not in the expected kernel or module code regions are present.", "type": "boolean" } }, "type": "object" }, "GoogleCloudSecuritycenterV2Kubernetes": { -"description": "Kubernetes-related attributes.", "id": "GoogleCloudSecuritycenterV2Kubernetes", "properties": { "accessReviews": { -"description": "Provides information on any Kubernetes access reviews (privilege checks) relevant to the finding.", "items": { "$ref": "GoogleCloudSecuritycenterV2AccessReview" }, "type": "array" }, "bindings": { -"description": "Provides Kubernetes role binding information for findings that involve [RoleBindings or ClusterRoleBindings](https://cloud.google.com/kubernetes-engine/docs/how-to/role-based-access-control).", "items": { "$ref": "GoogleCloudSecuritycenterV2Binding" }, "type": "array" }, "nodePools": { -"description": "GKE [node pools](https://cloud.google.com/kubernetes-engine/docs/concepts/node-pools) associated with the finding. This field contains node pool information for each node, when it is available.", "items": { "$ref": "GoogleCloudSecuritycenterV2NodePool" }, "type": "array" }, "nodes": { -"description": "Provides Kubernetes [node](https://cloud.google.com/kubernetes-engine/docs/concepts/cluster-architecture#nodes) information.", "items": { "$ref": "GoogleCloudSecuritycenterV2Node" }, "type": "array" }, "objects": { -"description": "Kubernetes objects related to the finding.", "items": { "$ref": "GoogleCloudSecuritycenterV2Object" }, "type": "array" }, "pods": { -"description": "Kubernetes [Pods](https://cloud.google.com/kubernetes-engine/docs/concepts/pod) associated with the finding. This field contains Pod records for each container that is owned by a Pod.", "items": { "$ref": "GoogleCloudSecuritycenterV2Pod" }, "type": "array" }, "roles": { -"description": "Provides Kubernetes role information for findings that involve [Roles or ClusterRoles](https://cloud.google.com/kubernetes-engine/docs/how-to/role-based-access-control).", "items": { "$ref": "GoogleCloudSecuritycenterV2Role" }, @@ -8692,52 +7516,42 @@ false "type": "object" }, "GoogleCloudSecuritycenterV2Label": { -"description": "Represents a generic name-value label. A label has separate name and value fields to support filtering with the `contains()` function. For more information, see [Filtering on array-type fields](https://cloud.google.com/security-command-center/docs/how-to-api-list-findings#array-contains-filtering).", "id": "GoogleCloudSecuritycenterV2Label", "properties": { "name": { -"description": "Name of the label.", "type": "string" }, "value": { -"description": "Value that corresponds to the label's name.", "type": "string" } }, "type": "object" }, "GoogleCloudSecuritycenterV2LoadBalancer": { -"description": "Contains information related to the load balancer associated with the finding.", "id": "GoogleCloudSecuritycenterV2LoadBalancer", "properties": { "name": { -"description": "The name of the load balancer associated with the finding.", "type": "string" } }, "type": "object" }, "GoogleCloudSecuritycenterV2LogEntry": { -"description": "An individual entry in a log.", "id": "GoogleCloudSecuritycenterV2LogEntry", "properties": { "cloudLoggingEntry": { -"$ref": "GoogleCloudSecuritycenterV2CloudLoggingEntry", -"description": "An individual entry in a log stored in Cloud Logging." +"$ref": "GoogleCloudSecuritycenterV2CloudLoggingEntry" } }, "type": "object" }, "GoogleCloudSecuritycenterV2MemoryHashSignature": { -"description": "A signature corresponding to memory page hashes.", "id": "GoogleCloudSecuritycenterV2MemoryHashSignature", "properties": { "binaryFamily": { -"description": "The binary family.", "type": "string" }, "detections": { -"description": "The list of memory hash detections contributing to the binary family match.", "items": { "$ref": "GoogleCloudSecuritycenterV2Detection" }, @@ -8747,11 +7561,9 @@ false "type": "object" }, "GoogleCloudSecuritycenterV2MitreAttack": { -"description": "MITRE ATT&CK tactics and techniques related to this finding. See: https://attack.mitre.org", "id": "GoogleCloudSecuritycenterV2MitreAttack", "properties": { "additionalTactics": { -"description": "Additional MITRE ATT&CK tactics related to this finding, if any.", "items": { "enum": [ "TACTIC_UNSPECIFIED", @@ -8771,28 +7583,27 @@ false "IMPACT" ], "enumDescriptions": [ -"Unspecified value.", -"TA0043", -"TA0042", -"TA0001", -"TA0002", -"TA0003", -"TA0004", -"TA0005", -"TA0006", -"TA0007", -"TA0008", -"TA0009", -"TA0011", -"TA0010", -"TA0040" +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"" ], "type": "string" }, "type": "array" }, "additionalTechniques": { -"description": "Additional MITRE ATT&CK techniques related to this finding, if any, along with any of their respective parent techniques.", "items": { "enum": [ "TECHNIQUE_UNSPECIFIED", @@ -8936,152 +7747,151 @@ false "FINANCIAL_THEFT" ], "enumDescriptions": [ -"Unspecified value.", -"T1001", -"T1001.002", -"T1003", -"T1003.007", -"T1003.008", -"T1005", -"T1020", -"T1027", -"T1027.003", -"T1027.004", -"T1027.010", -"T1029", -"T1033", -"T1036", -"T1036.005", -"T1037", -"T1037.005", -"T1046", -"T1053", -"T1053.003", -"T1053.007", -"T1055", -"T1056", -"T1056.001", -"T1057", -"T1059", -"T1059.004", -"T1059.006", -"T1068", -"T1069", -"T1069.003", -"T1070", -"T1070.002", -"T1070.003", -"T1070.004", -"T1070.006", -"T1070.008", -"T1071", -"T1071.004", -"T1072", -"T1078", -"T1078.001", -"T1078.003", -"T1078.004", -"T1083", -"T1087.001", -"T1090", -"T1090.002", -"T1090.003", -"T1098", -"T1098.001", -"T1098.003", -"T1098.004", -"T1098.006", -"T1104", -"T1105", -"T1106", -"T1110", -"T1119", -"T1129", -"T1132", -"T1132.001", -"T1134", -"T1134.001", -"T1136", -"T1136.001", -"T1140", -"T1190", -"T1195", -"T1195.001", -"T1203", -"T1204", -"T1212", -"T1222.002", -"T1484", -"T1485", -"T1486", -"T1489", -"T1490", -"T1495", -"T1496", -"T1498", -"T1526", -"T1528", -"T1531", -"T1537", -"T1539", -"T1543", -"T1546", -"T1547", -"T1547.006", -"T1547.009", -"T1548", -"T1548.001", -"T1548.003", -"T1552", -"T1552.001", -"T1552.003", -"T1552.004", -"T1553", -"T1553.004", -"T1554", -"T1555", -"T1556", -"T1556.003", -"T1556.006", -"T1562", -"T1562.001", -"T1562.006", -"T1562.012", -"T1564", -"T1564.001", -"T1564.002", -"T1567", -"T1567.002", -"T1568", -"T1570", -"T1574", -"T1574.006", -"T1578", -"T1578.001", -"T1580", -"T1587", -"T1587.001", -"T1588", -"T1588.001", -"T1588.006", -"T1595", -"T1595.001", -"T1608", -"T1608.001", -"T1609", -"T1610", -"T1611", -"T1613", -"T1620", -"T1649", -"T1657" +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"" ], "type": "string" }, "type": "array" }, "primaryTactic": { -"description": "The MITRE ATT&CK tactic most closely represented by this finding, if any.", "enum": [ "TACTIC_UNSPECIFIED", "RECONNAISSANCE", @@ -9100,26 +7910,25 @@ false "IMPACT" ], "enumDescriptions": [ -"Unspecified value.", -"TA0043", -"TA0042", -"TA0001", -"TA0002", -"TA0003", -"TA0004", -"TA0005", -"TA0006", -"TA0007", -"TA0008", -"TA0009", -"TA0011", -"TA0010", -"TA0040" +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"" ], "type": "string" }, "primaryTechniques": { -"description": "The MITRE ATT&CK technique most closely represented by this finding, if any. primary_techniques is a repeated field because there are multiple levels of MITRE ATT&CK techniques. If the technique most closely represented by this finding is a sub-technique (e.g. `SCANNING_IP_BLOCKS`), both the sub-technique and its parent technique(s) will be listed (e.g. `SCANNING_IP_BLOCKS`, `ACTIVE_SCANNING`).", "items": { "enum": [ "TECHNIQUE_UNSPECIFIED", @@ -9263,210 +8072,199 @@ false "FINANCIAL_THEFT" ], "enumDescriptions": [ -"Unspecified value.", -"T1001", -"T1001.002", -"T1003", -"T1003.007", -"T1003.008", -"T1005", -"T1020", -"T1027", -"T1027.003", -"T1027.004", -"T1027.010", -"T1029", -"T1033", -"T1036", -"T1036.005", -"T1037", -"T1037.005", -"T1046", -"T1053", -"T1053.003", -"T1053.007", -"T1055", -"T1056", -"T1056.001", -"T1057", -"T1059", -"T1059.004", -"T1059.006", -"T1068", -"T1069", -"T1069.003", -"T1070", -"T1070.002", -"T1070.003", -"T1070.004", -"T1070.006", -"T1070.008", -"T1071", -"T1071.004", -"T1072", -"T1078", -"T1078.001", -"T1078.003", -"T1078.004", -"T1083", -"T1087.001", -"T1090", -"T1090.002", -"T1090.003", -"T1098", -"T1098.001", -"T1098.003", -"T1098.004", -"T1098.006", -"T1104", -"T1105", -"T1106", -"T1110", -"T1119", -"T1129", -"T1132", -"T1132.001", -"T1134", -"T1134.001", -"T1136", -"T1136.001", -"T1140", -"T1190", -"T1195", -"T1195.001", -"T1203", -"T1204", -"T1212", -"T1222.002", -"T1484", -"T1485", -"T1486", -"T1489", -"T1490", -"T1495", -"T1496", -"T1498", -"T1526", -"T1528", -"T1531", -"T1537", -"T1539", -"T1543", -"T1546", -"T1547", -"T1547.006", -"T1547.009", -"T1548", -"T1548.001", -"T1548.003", -"T1552", -"T1552.001", -"T1552.003", -"T1552.004", -"T1553", -"T1553.004", -"T1554", -"T1555", -"T1556", -"T1556.003", -"T1556.006", -"T1562", -"T1562.001", -"T1562.006", -"T1562.012", -"T1564", -"T1564.001", -"T1564.002", -"T1567", -"T1567.002", -"T1568", -"T1570", -"T1574", -"T1574.006", -"T1578", -"T1578.001", -"T1580", -"T1587", -"T1587.001", -"T1588", -"T1588.001", -"T1588.006", -"T1595", -"T1595.001", -"T1608", -"T1608.001", -"T1609", -"T1610", -"T1611", -"T1613", -"T1620", -"T1649", -"T1657" +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"" ], "type": "string" }, "type": "array" }, "version": { -"description": "The MITRE ATT&CK version referenced by the above fields. E.g. \"8\".", "type": "string" } }, "type": "object" }, "GoogleCloudSecuritycenterV2MuteConfig": { -"description": "A mute config is a Cloud SCC resource that contains the configuration to mute create/update events of findings.", "id": "GoogleCloudSecuritycenterV2MuteConfig", "properties": { "createTime": { -"description": "Output only. The time at which the mute config was created. This field is set by the server and will be ignored if provided on config creation.", "format": "google-datetime", "readOnly": true, "type": "string" }, "cryptoKeyName": { -"description": "Output only. The resource name of the Cloud KMS `CryptoKey` used to encrypt this configuration data, if CMEK was enabled during Security Command Center activation.", "readOnly": true, "type": "string" }, "description": { -"description": "A description of the mute config.", "type": "string" }, "expiryTime": { -"description": "Optional. The expiry of the mute config. Only applicable for dynamic configs. If the expiry is set, when the config expires, it is removed from all findings.", "format": "google-datetime", "type": "string" }, "filter": { -"description": "Required. An expression that defines the filter to apply across create/update events of findings. While creating a filter string, be mindful of the scope in which the mute configuration is being created. E.g., If a filter contains project = X but is created under the project = Y scope, it might not match any findings. The following field and operator combinations are supported: * severity: `=`, `:` * category: `=`, `:` * resource.name: `=`, `:` * resource.project_name: `=`, `:` * resource.project_display_name: `=`, `:` * resource.folders.resource_folder: `=`, `:` * resource.parent_name: `=`, `:` * resource.parent_display_name: `=`, `:` * resource.type: `=`, `:` * finding_class: `=`, `:` * indicator.ip_addresses: `=`, `:` * indicator.domains: `=`, `:`", "type": "string" }, "mostRecentEditor": { -"description": "Output only. Email address of the user who last edited the mute config. This field is set by the server and will be ignored if provided on config creation or update.", "readOnly": true, "type": "string" }, "name": { -"description": "Identifier. This field will be ignored if provided on config creation. The following list shows some examples of the format: + `organizations/{organization}/muteConfigs/{mute_config}` + `organizations/{organization}locations/{location}//muteConfigs/{mute_config}` + `folders/{folder}/muteConfigs/{mute_config}` + `folders/{folder}/locations/{location}/muteConfigs/{mute_config}` + `projects/{project}/muteConfigs/{mute_config}` + `projects/{project}/locations/{location}/muteConfigs/{mute_config}`", "type": "string" }, "type": { -"description": "Required. The type of the mute config, which determines what type of mute state the config affects. Immutable after creation.", "enum": [ "MUTE_CONFIG_TYPE_UNSPECIFIED", "STATIC", "DYNAMIC" ], "enumDescriptions": [ -"Unused.", -"A static mute config, which sets the static mute state of future matching findings to muted. Once the static mute state has been set, finding or config modifications will not affect the state.", -"A dynamic mute config, which is applied to existing and future matching findings, setting their dynamic mute state to \"muted\". If the config is updated or deleted, or a matching finding is updated, such that the finding doesn't match the config, the config will be removed from the finding, and the finding's dynamic mute state may become \"unmuted\" (unless other configs still match)." +"", +"", +"" ], "type": "string" }, "updateTime": { -"description": "Output only. The most recent time at which the mute config was updated. This field is set by the server and will be ignored if provided on config creation or update.", "format": "google-datetime", "readOnly": true, "type": "string" @@ -9475,55 +8273,45 @@ false "type": "object" }, "GoogleCloudSecuritycenterV2MuteInfo": { -"description": "Mute information about the finding, including whether the finding has a static mute or any matching dynamic mute rules.", "id": "GoogleCloudSecuritycenterV2MuteInfo", "properties": { "dynamicMuteRecords": { -"description": "The list of dynamic mute rules that currently match the finding.", "items": { "$ref": "GoogleCloudSecuritycenterV2DynamicMuteRecord" }, "type": "array" }, "staticMute": { -"$ref": "GoogleCloudSecuritycenterV2StaticMute", -"description": "If set, the static mute applied to this finding. Static mutes override dynamic mutes. If unset, there is no static mute." +"$ref": "GoogleCloudSecuritycenterV2StaticMute" } }, "type": "object" }, "GoogleCloudSecuritycenterV2Network": { -"description": "Contains information about a VPC network associated with the finding.", "id": "GoogleCloudSecuritycenterV2Network", "properties": { "name": { -"description": "The name of the VPC network resource, for example, `//compute.googleapis.com/projects/my-project/global/networks/my-network`.", "type": "string" } }, "type": "object" }, "GoogleCloudSecuritycenterV2Node": { -"description": "Kubernetes nodes associated with the finding.", "id": "GoogleCloudSecuritycenterV2Node", "properties": { "name": { -"description": "[Full resource name](https://google.aip.dev/122#full-resource-names) of the Compute Engine VM running the cluster node.", "type": "string" } }, "type": "object" }, "GoogleCloudSecuritycenterV2NodePool": { -"description": "Provides GKE node pool information.", "id": "GoogleCloudSecuritycenterV2NodePool", "properties": { "name": { -"description": "Kubernetes node pool name.", "type": "string" }, "nodes": { -"description": "Nodes associated with the finding.", "items": { "$ref": "GoogleCloudSecuritycenterV2Node" }, @@ -9533,196 +8321,157 @@ false "type": "object" }, "GoogleCloudSecuritycenterV2Notebook": { -"description": "Represents a Jupyter notebook IPYNB file, such as a [Colab Enterprise notebook](https://cloud.google.com/colab/docs/introduction) file, that is associated with a finding.", "id": "GoogleCloudSecuritycenterV2Notebook", "properties": { "lastAuthor": { -"description": "The user ID of the latest author to modify the notebook.", "type": "string" }, "name": { -"description": "The name of the notebook.", "type": "string" }, "notebookUpdateTime": { -"description": "The most recent time the notebook was updated.", "format": "google-datetime", "type": "string" }, "service": { -"description": "The source notebook service, for example, \"Colab Enterprise\".", "type": "string" } }, "type": "object" }, "GoogleCloudSecuritycenterV2NotificationMessage": { -"description": "Cloud SCC's Notification", "id": "GoogleCloudSecuritycenterV2NotificationMessage", "properties": { "finding": { -"$ref": "GoogleCloudSecuritycenterV2Finding", -"description": "If it's a Finding based notification config, this field will be populated." +"$ref": "GoogleCloudSecuritycenterV2Finding" }, "notificationConfigName": { -"description": "Name of the notification config that generated current notification.", "type": "string" }, "resource": { -"$ref": "GoogleCloudSecuritycenterV2Resource", -"description": "The Cloud resource tied to this notification's Finding." +"$ref": "GoogleCloudSecuritycenterV2Resource" } }, "type": "object" }, "GoogleCloudSecuritycenterV2Object": { -"description": "Kubernetes object related to the finding, uniquely identified by GKNN. Used if the object Kind is not one of Pod, Node, NodePool, Binding, or AccessReview.", "id": "GoogleCloudSecuritycenterV2Object", "properties": { "containers": { -"description": "Pod containers associated with this finding, if any.", "items": { "$ref": "GoogleCloudSecuritycenterV2Container" }, "type": "array" }, "group": { -"description": "Kubernetes object group, such as \"policy.k8s.io/v1\".", "type": "string" }, "kind": { -"description": "Kubernetes object kind, such as \"Namespace\".", "type": "string" }, "name": { -"description": "Kubernetes object name. For details see https://kubernetes.io/docs/concepts/overview/working-with-objects/names/.", "type": "string" }, "ns": { -"description": "Kubernetes object namespace. Must be a valid DNS label. Named \"ns\" to avoid collision with C++ namespace keyword. For details see https://kubernetes.io/docs/tasks/administer-cluster/namespaces/.", "type": "string" } }, "type": "object" }, "GoogleCloudSecuritycenterV2OrgPolicy": { -"description": "Contains information about the org policies associated with the finding.", "id": "GoogleCloudSecuritycenterV2OrgPolicy", "properties": { "name": { -"description": "Identifier. The resource name of the org policy. Example: \"organizations/{organization_id}/policies/{constraint_name}\"", "type": "string" } }, "type": "object" }, "GoogleCloudSecuritycenterV2Package": { -"description": "Package is a generic definition of a package.", "id": "GoogleCloudSecuritycenterV2Package", "properties": { "cpeUri": { -"description": "The CPE URI where the vulnerability was detected.", "type": "string" }, "packageName": { -"description": "The name of the package where the vulnerability was detected.", "type": "string" }, "packageType": { -"description": "Type of package, for example, os, maven, or go.", "type": "string" }, "packageVersion": { -"description": "The version of the package.", "type": "string" } }, "type": "object" }, "GoogleCloudSecuritycenterV2Pipeline": { -"description": "Vertex AI training pipeline associated with the finding.", "id": "GoogleCloudSecuritycenterV2Pipeline", "properties": { "displayName": { -"description": "The user-defined display name of pipeline, e.g. plants-classification", "type": "string" }, "name": { -"description": "Resource name of the pipeline, e.g. projects/{project}/locations/{location}/trainingPipelines/5253428229225578496", "type": "string" } }, "type": "object" }, "GoogleCloudSecuritycenterV2Pod": { -"description": "A Kubernetes Pod.", "id": "GoogleCloudSecuritycenterV2Pod", "properties": { "containers": { -"description": "Pod containers associated with this finding, if any.", "items": { "$ref": "GoogleCloudSecuritycenterV2Container" }, "type": "array" }, "labels": { -"description": "Pod labels. For Kubernetes containers, these are applied to the container.", "items": { "$ref": "GoogleCloudSecuritycenterV2Label" }, "type": "array" }, "name": { -"description": "Kubernetes Pod name.", "type": "string" }, "ns": { -"description": "Kubernetes Pod namespace.", "type": "string" } }, "type": "object" }, "GoogleCloudSecuritycenterV2PolicyDriftDetails": { -"description": "The policy field that violates the deployed posture and its expected and detected values.", "id": "GoogleCloudSecuritycenterV2PolicyDriftDetails", "properties": { "detectedValue": { -"description": "The detected value that violates the deployed posture, for example, `false` or `allowed_values={\"projects/22831892\"}`.", "type": "string" }, "expectedValue": { -"description": "The value of this field that was configured in a posture, for example, `true` or `allowed_values={\"projects/29831892\"}`.", "type": "string" }, "field": { -"description": "The name of the updated field, for example constraint.implementation.policy_rules[0].enforce", "type": "string" } }, "type": "object" }, "GoogleCloudSecuritycenterV2PolicyViolationSummary": { -"description": "Metadata summarizing policy violations of child resources of the affected resource. `finding_category` and `resource` determine the exact semantics of the counts. For example, when category=DATA_SECURITY_POSTURE_OBJECT_PUBLIC_ACCESS_VIOLATION and resource='storage.googleapis.com/buckets/my-bucket-name' then this counts the number of Cloud Storage objects in my-bucket-name which violate a Public Access control.", "id": "GoogleCloudSecuritycenterV2PolicyViolationSummary", "properties": { "conformantResourcesCount": { -"description": "Total number of child resources that conform to the policy.", "format": "int64", "type": "string" }, "evaluationErrorsCount": { -"description": "Number of child resources for which errors during evaluation occurred. The evaluation result for these child resources is effectively \"unknown\".", "format": "int64", "type": "string" }, "outOfScopeResourcesCount": { -"description": "Total count of child resources which were not in scope for evaluation.", "format": "int64", "type": "string" }, "policyViolationsCount": { -"description": "Count of child resources in violation of the policy.", "format": "int64", "type": "string" } @@ -9730,16 +8479,13 @@ false "type": "object" }, "GoogleCloudSecuritycenterV2PortRange": { -"description": "A port range which is inclusive of the min and max values. Values are between 0 and 2^16-1. The max can be equal / must be not smaller than the min value. If min and max are equal this indicates that it is a single port.", "id": "GoogleCloudSecuritycenterV2PortRange", "properties": { "max": { -"description": "Maximum port value.", "format": "int64", "type": "string" }, "min": { -"description": "Minimum port value.", "format": "int64", "type": "string" } @@ -9747,62 +8493,50 @@ false "type": "object" }, "GoogleCloudSecuritycenterV2Process": { -"description": "Represents an operating system process.", "id": "GoogleCloudSecuritycenterV2Process", "properties": { "args": { -"description": "Process arguments as JSON encoded strings.", "items": { "type": "string" }, "type": "array" }, "argumentsTruncated": { -"description": "True if `args` is incomplete.", "type": "boolean" }, "binary": { -"$ref": "GoogleCloudSecuritycenterV2File", -"description": "File information for the process executable." +"$ref": "GoogleCloudSecuritycenterV2File" }, "envVariables": { -"description": "Process environment variables.", "items": { "$ref": "GoogleCloudSecuritycenterV2EnvironmentVariable" }, "type": "array" }, "envVariablesTruncated": { -"description": "True if `env_variables` is incomplete.", "type": "boolean" }, "libraries": { -"description": "File information for libraries loaded by the process.", "items": { "$ref": "GoogleCloudSecuritycenterV2File" }, "type": "array" }, "name": { -"description": "The process name, as displayed in utilities like `top` and `ps`. This name can be accessed through `/proc/[pid]/comm` and changed with `prctl(PR_SET_NAME)`.", "type": "string" }, "parentPid": { -"description": "The parent process ID.", "format": "int64", "type": "string" }, "pid": { -"description": "The process ID.", "format": "int64", "type": "string" }, "script": { -"$ref": "GoogleCloudSecuritycenterV2File", -"description": "When the process represents the invocation of a script, `binary` provides information about the interpreter, while `script` provides information about the script file provided to the interpreter." +"$ref": "GoogleCloudSecuritycenterV2File" }, "userId": { -"description": "The ID of the user that executed the process. E.g. If this is the root user this will always be 0.", "format": "int64", "type": "string" } @@ -9810,70 +8544,58 @@ false "type": "object" }, "GoogleCloudSecuritycenterV2ProcessSignature": { -"description": "Indicates what signature matched this process.", "id": "GoogleCloudSecuritycenterV2ProcessSignature", "properties": { "memoryHashSignature": { -"$ref": "GoogleCloudSecuritycenterV2MemoryHashSignature", -"description": "Signature indicating that a binary family was matched." +"$ref": "GoogleCloudSecuritycenterV2MemoryHashSignature" }, "signatureType": { -"description": "Describes the type of resource associated with the signature.", "enum": [ "SIGNATURE_TYPE_UNSPECIFIED", "SIGNATURE_TYPE_PROCESS", "SIGNATURE_TYPE_FILE" ], "enumDescriptions": [ -"The default signature type.", -"Used for signatures concerning processes.", -"Used for signatures concerning disks." +"", +"", +"" ], "type": "string" }, "yaraRuleSignature": { -"$ref": "GoogleCloudSecuritycenterV2YaraRuleSignature", -"description": "Signature indicating that a YARA rule was matched." +"$ref": "GoogleCloudSecuritycenterV2YaraRuleSignature" } }, "type": "object" }, "GoogleCloudSecuritycenterV2Reference": { -"description": "Additional Links", "id": "GoogleCloudSecuritycenterV2Reference", "properties": { "source": { -"description": "Source of the reference e.g. NVD", "type": "string" }, "uri": { -"description": "Uri for the mentioned source e.g. https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2021-34527.", "type": "string" } }, "type": "object" }, "GoogleCloudSecuritycenterV2Requests": { -"description": "Information about the requests relevant to the finding.", "id": "GoogleCloudSecuritycenterV2Requests", "properties": { "longTermAllowed": { -"description": "Allowed RPS (requests per second) over the long term.", "format": "int32", "type": "integer" }, "longTermDenied": { -"description": "Denied RPS (requests per second) over the long term.", "format": "int32", "type": "integer" }, "ratio": { -"description": "For 'Increasing deny ratio', the ratio is the denied traffic divided by the allowed traffic. For 'Allowed traffic spike', the ratio is the allowed traffic in the short term divided by allowed traffic in the long term.", "format": "double", "type": "number" }, "shortTermAllowed": { -"description": "Allowed RPS (requests per second) in the short term.", "format": "int32", "type": "integer" } @@ -9881,35 +8603,27 @@ false "type": "object" }, "GoogleCloudSecuritycenterV2Resource": { -"description": "Information related to the Google Cloud resource.", "id": "GoogleCloudSecuritycenterV2Resource", "properties": { "adcApplication": { -"$ref": "GoogleCloudSecuritycenterV2AdcApplication", -"description": "The ADC application associated with the finding." +"$ref": "GoogleCloudSecuritycenterV2AdcApplication" }, "adcApplicationTemplate": { -"$ref": "GoogleCloudSecuritycenterV2AdcApplicationTemplateRevision", -"description": "The ADC template associated with the finding." +"$ref": "GoogleCloudSecuritycenterV2AdcApplicationTemplateRevision" }, "adcSharedTemplate": { -"$ref": "GoogleCloudSecuritycenterV2AdcSharedTemplateRevision", -"description": "The ADC shared template associated with the finding." +"$ref": "GoogleCloudSecuritycenterV2AdcSharedTemplateRevision" }, "application": { -"$ref": "GoogleCloudSecuritycenterV2ResourceApplication", -"description": "The App Hub application this resource belongs to." +"$ref": "GoogleCloudSecuritycenterV2ResourceApplication" }, "awsMetadata": { -"$ref": "GoogleCloudSecuritycenterV2AwsMetadata", -"description": "The AWS metadata associated with the finding." +"$ref": "GoogleCloudSecuritycenterV2AwsMetadata" }, "azureMetadata": { -"$ref": "GoogleCloudSecuritycenterV2AzureMetadata", -"description": "The Azure metadata associated with the finding." +"$ref": "GoogleCloudSecuritycenterV2AzureMetadata" }, "cloudProvider": { -"description": "Indicates which cloud provider the finding is from.", "enum": [ "CLOUD_PROVIDER_UNSPECIFIED", "GOOGLE_CLOUD_PLATFORM", @@ -9917,91 +8631,74 @@ false "MICROSOFT_AZURE" ], "enumDescriptions": [ -"The cloud provider is unspecified.", -"The cloud provider is Google Cloud.", -"The cloud provider is Amazon Web Services.", -"The cloud provider is Microsoft Azure." +"", +"", +"", +"" ], "type": "string" }, "displayName": { -"description": "The human readable name of the resource.", "type": "string" }, "gcpMetadata": { -"$ref": "GcpMetadata", -"description": "The Google Cloud metadata associated with the finding." +"$ref": "GcpMetadata" }, "location": { -"description": "The region or location of the service (if applicable).", "type": "string" }, "name": { -"description": "The full resource name of the resource. See: https://cloud.google.com/apis/design/resource_names#full_resource_name", "type": "string" }, "resourcePath": { -"$ref": "GoogleCloudSecuritycenterV2ResourcePath", -"description": "Provides the path to the resource within the resource hierarchy." +"$ref": "GoogleCloudSecuritycenterV2ResourcePath" }, "resourcePathString": { -"description": "A string representation of the resource path. For Google Cloud, it has the format of `organizations/{organization_id}/folders/{folder_id}/folders/{folder_id}/projects/{project_id}` where there can be any number of folders. For AWS, it has the format of `org/{organization_id}/ou/{organizational_unit_id}/ou/{organizational_unit_id}/account/{account_id}` where there can be any number of organizational units. For Azure, it has the format of `mg/{management_group_id}/mg/{management_group_id}/subscription/{subscription_id}/rg/{resource_group_name}` where there can be any number of management groups.", "type": "string" }, "service": { -"description": "The service or resource provider associated with the resource.", "type": "string" }, "type": { -"description": "The full resource type of the resource.", "type": "string" } }, "type": "object" }, "GoogleCloudSecuritycenterV2ResourceApplication": { -"description": "The App Hub Application associated with the finding's resource.", "id": "GoogleCloudSecuritycenterV2ResourceApplication", "properties": { "attributes": { -"$ref": "GoogleCloudSecuritycenterV2ResourceApplicationAttributes", -"description": "Consumer provided attributes for the application" +"$ref": "GoogleCloudSecuritycenterV2ResourceApplicationAttributes" }, "name": { -"description": "The resource name of an Application. Format: `projects/{host-project-id}/locations/{location}/applications/{application-id}`", "type": "string" } }, "type": "object" }, "GoogleCloudSecuritycenterV2ResourceApplicationAttributes": { -"description": "Consumer provided attributes for the application", "id": "GoogleCloudSecuritycenterV2ResourceApplicationAttributes", "properties": { "businessOwners": { -"description": "Business team that ensures user needs are met and value is delivered", "items": { "$ref": "GoogleCloudSecuritycenterV2ResourceApplicationAttributesContactInfo" }, "type": "array" }, "criticality": { -"$ref": "GoogleCloudSecuritycenterV2ResourceApplicationAttributesCriticality", -"description": "User-defined criticality information." +"$ref": "GoogleCloudSecuritycenterV2ResourceApplicationAttributesCriticality" }, "developerOwners": { -"description": "Developer team that owns development and coding.", "items": { "$ref": "GoogleCloudSecuritycenterV2ResourceApplicationAttributesContactInfo" }, "type": "array" }, "environment": { -"$ref": "GoogleCloudSecuritycenterV2ResourceApplicationAttributesEnvironment", -"description": "User-defined environment information." +"$ref": "GoogleCloudSecuritycenterV2ResourceApplicationAttributesEnvironment" }, "operatorOwners": { -"description": "Operator team that ensures runtime and operations.", "items": { "$ref": "GoogleCloudSecuritycenterV2ResourceApplicationAttributesContactInfo" }, @@ -10011,22 +8708,18 @@ false "type": "object" }, "GoogleCloudSecuritycenterV2ResourceApplicationAttributesContactInfo": { -"description": "Contact information of stakeholders.", "id": "GoogleCloudSecuritycenterV2ResourceApplicationAttributesContactInfo", "properties": { "email": { -"description": "Email address of the contacts.", "type": "string" } }, "type": "object" }, "GoogleCloudSecuritycenterV2ResourceApplicationAttributesCriticality": { -"description": "Criticality of the Application, Service, or Workload", "id": "GoogleCloudSecuritycenterV2ResourceApplicationAttributesCriticality", "properties": { "type": { -"description": "Criticality Type.", "enum": [ "CRITICALITY_TYPE_UNSPECIFIED", "MISSION_CRITICAL", @@ -10035,11 +8728,11 @@ false "LOW" ], "enumDescriptions": [ -"Unspecified type.", -"Mission critical service, application or workload.", -"High impact.", -"Medium impact.", -"Low impact." +"", +"", +"", +"", +"" ], "type": "string" } @@ -10047,11 +8740,9 @@ false "type": "object" }, "GoogleCloudSecuritycenterV2ResourceApplicationAttributesEnvironment": { -"description": "Environment of the Application, Service, or Workload", "id": "GoogleCloudSecuritycenterV2ResourceApplicationAttributesEnvironment", "properties": { "type": { -"description": "Environment Type.", "enum": [ "ENVIRONMENT_TYPE_UNSPECIFIED", "PRODUCTION", @@ -10060,11 +8751,11 @@ false "DEVELOPMENT" ], "enumDescriptions": [ -"Unspecified type.", -"Production environment.", -"Staging environment.", -"Test environment.", -"Development environment." +"", +"", +"", +"", +"" ], "type": "string" } @@ -10072,11 +8763,9 @@ false "type": "object" }, "GoogleCloudSecuritycenterV2ResourcePath": { -"description": "Represents the path of resources leading up to the resource this finding is about.", "id": "GoogleCloudSecuritycenterV2ResourcePath", "properties": { "nodes": { -"description": "The list of nodes that make the up resource path, ordered from lowest level to highest level.", "items": { "$ref": "GoogleCloudSecuritycenterV2ResourcePathNode" }, @@ -10086,19 +8775,15 @@ false "type": "object" }, "GoogleCloudSecuritycenterV2ResourcePathNode": { -"description": "A node within the resource path. Each node represents a resource within the resource hierarchy.", "id": "GoogleCloudSecuritycenterV2ResourcePathNode", "properties": { "displayName": { -"description": "The display name of the resource this node represents.", "type": "string" }, "id": { -"description": "The ID of the resource this node represents.", "type": "string" }, "nodeType": { -"description": "The type of resource this node represents.", "enum": [ "RESOURCE_PATH_NODE_TYPE_UNSPECIFIED", "GCP_ORGANIZATION", @@ -10112,16 +8797,16 @@ false "AZURE_RESOURCE_GROUP" ], "enumDescriptions": [ -"Node type is unspecified.", -"The node represents a Google Cloud organization.", -"The node represents a Google Cloud folder.", -"The node represents a Google Cloud project.", -"The node represents an AWS organization.", -"The node represents an AWS organizational unit.", -"The node represents an AWS account.", -"The node represents an Azure management group.", -"The node represents an Azure subscription.", -"The node represents an Azure resource group." +"", +"", +"", +"", +"", +"", +"", +"", +"", +"" ], "type": "string" } @@ -10129,11 +8814,9 @@ false "type": "object" }, "GoogleCloudSecuritycenterV2ResourceValueConfig": { -"description": "A resource value configuration (RVC) is a mapping configuration of user's resources to resource values. Used in Attack path simulations.", "id": "GoogleCloudSecuritycenterV2ResourceValueConfig", "properties": { "cloudProvider": { -"description": "Cloud provider this configuration applies to", "enum": [ "CLOUD_PROVIDER_UNSPECIFIED", "GOOGLE_CLOUD_PLATFORM", @@ -10141,40 +8824,34 @@ false "MICROSOFT_AZURE" ], "enumDescriptions": [ -"The cloud provider is unspecified.", -"The cloud provider is Google Cloud.", -"The cloud provider is Amazon Web Services.", -"The cloud provider is Microsoft Azure." +"", +"", +"", +"" ], "type": "string" }, "createTime": { -"description": "Output only. Timestamp this resource value configuration was created.", "format": "google-datetime", "readOnly": true, "type": "string" }, "description": { -"description": "Description of the resource value configuration.", "type": "string" }, "name": { -"description": "Identifier. Name for the resource value configuration", "type": "string" }, "resourceLabelsSelector": { "additionalProperties": { "type": "string" }, -"description": "List of resource labels to search for, evaluated with `AND`. For example, \"resource_labels_selector\": {\"key\": \"value\", \"env\": \"prod\"} will match resources with labels \"key\": \"value\" `AND` \"env\": \"prod\" https://cloud.google.com/resource-manager/docs/creating-managing-labels", "type": "object" }, "resourceType": { -"description": "Apply resource_value only to resources that match resource_type. resource_type will be checked with `AND` of other resources. For example, \"storage.googleapis.com/Bucket\" with resource_value \"HIGH\" will apply \"HIGH\" value only to \"storage.googleapis.com/Bucket\" resources.", "type": "string" }, "resourceValue": { -"description": "Resource value level this expression represents Only required when there is no Sensitive Data Protection mapping in the request", "enum": [ "RESOURCE_VALUE_UNSPECIFIED", "HIGH", @@ -10183,31 +8860,27 @@ false "NONE" ], "enumDescriptions": [ -"Unspecific value", -"High resource value", -"Medium resource value", -"Low resource value", -"No resource value, e.g. ignore these resources" +"", +"", +"", +"", +"" ], "type": "string" }, "scope": { -"description": "Project or folder to scope this configuration to. For example, \"project/456\" would apply this configuration only to resources in \"project/456\" scope and will be checked with `AND` of other resources.", "type": "string" }, "sensitiveDataProtectionMapping": { -"$ref": "GoogleCloudSecuritycenterV2SensitiveDataProtectionMapping", -"description": "A mapping of the sensitivity on Sensitive Data Protection finding to resource values. This mapping can only be used in combination with a resource_type that is related to BigQuery, e.g. \"bigquery.googleapis.com/Dataset\"." +"$ref": "GoogleCloudSecuritycenterV2SensitiveDataProtectionMapping" }, "tagValues": { -"description": "Tag values combined with `AND` to check against. For Google Cloud resources, they are tag value IDs in the form of \"tagValues/123\". Example: `[ \"tagValues/123\", \"tagValues/456\", \"tagValues/789\" ]` https://cloud.google.com/resource-manager/docs/tags/tags-creating-and-managing", "items": { "type": "string" }, "type": "array" }, "updateTime": { -"description": "Output only. Timestamp this resource value configuration was last updated.", "format": "google-datetime", "readOnly": true, "type": "string" @@ -10216,90 +8889,74 @@ false "type": "object" }, "GoogleCloudSecuritycenterV2Role": { -"description": "Kubernetes Role or ClusterRole.", "id": "GoogleCloudSecuritycenterV2Role", "properties": { "kind": { -"description": "Role type.", "enum": [ "KIND_UNSPECIFIED", "ROLE", "CLUSTER_ROLE" ], "enumDescriptions": [ -"Role type is not specified.", -"Kubernetes Role.", -"Kubernetes ClusterRole." +"", +"", +"" ], "type": "string" }, "name": { -"description": "Role name.", "type": "string" }, "ns": { -"description": "Role namespace.", "type": "string" } }, "type": "object" }, "GoogleCloudSecuritycenterV2Secret": { -"description": "Details about a secret or credential associated with the finding.", "id": "GoogleCloudSecuritycenterV2Secret", "properties": { "environmentVariable": { -"$ref": "GoogleCloudSecuritycenterV2SecretEnvironmentVariable", -"description": "The environment variable containing the secret." +"$ref": "GoogleCloudSecuritycenterV2SecretEnvironmentVariable" }, "filePath": { -"$ref": "GoogleCloudSecuritycenterV2SecretFilePath", -"description": "The file containing the secret." +"$ref": "GoogleCloudSecuritycenterV2SecretFilePath" }, "status": { -"$ref": "GoogleCloudSecuritycenterV2SecretStatus", -"description": "The status of the secret." +"$ref": "GoogleCloudSecuritycenterV2SecretStatus" }, "type": { -"description": "The type of secret, for example, GCP_API_KEY.", "type": "string" } }, "type": "object" }, "GoogleCloudSecuritycenterV2SecretEnvironmentVariable": { -"description": "Environment variable containing the secret.", "id": "GoogleCloudSecuritycenterV2SecretEnvironmentVariable", "properties": { "key": { -"description": "Environment variable name as a JSON encoded string. Note that value is not included since the value contains the secret data, which is sensitive core content.", "type": "string" } }, "type": "object" }, "GoogleCloudSecuritycenterV2SecretFilePath": { -"description": "File path containing the secret.", "id": "GoogleCloudSecuritycenterV2SecretFilePath", "properties": { "path": { -"description": "Path to the file.", "type": "string" } }, "type": "object" }, "GoogleCloudSecuritycenterV2SecretStatus": { -"description": "The status of the secret.", "id": "GoogleCloudSecuritycenterV2SecretStatus", "properties": { "lastUpdatedTime": { -"description": "Time that the secret was found.", "format": "google-datetime", "type": "string" }, "validity": { -"description": "The validity of the secret.", "enum": [ "SECRET_VALIDITY_UNSPECIFIED", "SECRET_VALIDITY_UNSUPPORTED", @@ -10308,11 +8965,11 @@ false "SECRET_VALIDITY_VALID" ], "enumDescriptions": [ -"Default value; no validation was attempted.", -"There is no mechanism to validate the secret.", -"Validation is supported but the validation failed.", -"The secret is confirmed to be invalid.", -"The secret is confirmed to be valid." +"", +"", +"", +"", +"" ], "type": "string" } @@ -10320,114 +8977,91 @@ false "type": "object" }, "GoogleCloudSecuritycenterV2SecurityBulletin": { -"description": "SecurityBulletin are notifications of vulnerabilities of Google products.", "id": "GoogleCloudSecuritycenterV2SecurityBulletin", "properties": { "bulletinId": { -"description": "ID of the bulletin corresponding to the vulnerability.", "type": "string" }, "submissionTime": { -"description": "Submission time of this Security Bulletin.", "format": "google-datetime", "type": "string" }, "suggestedUpgradeVersion": { -"description": "This represents a version that the cluster receiving this notification should be upgraded to, based on its current version. For example, 1.15.0", "type": "string" } }, "type": "object" }, "GoogleCloudSecuritycenterV2SecurityMarks": { -"description": "User specified security marks that are attached to the parent Security Command Center resource. Security marks are scoped within a Security Command Center organization -- they can be modified and viewed by all users who have proper permissions on the organization.", "id": "GoogleCloudSecuritycenterV2SecurityMarks", "properties": { "canonicalName": { -"description": "The canonical name of the marks. The following list shows some examples: + `organizations/{organization_id}/assets/{asset_id}/securityMarks` + `organizations/{organization_id}/sources/{source_id}/findings/{finding_id}/securityMarks` + `organizations/{organization_id}/sources/{source_id}/locations/{location}/findings/{finding_id}/securityMarks` + `folders/{folder_id}/assets/{asset_id}/securityMarks` + `folders/{folder_id}/sources/{source_id}/findings/{finding_id}/securityMarks` + `folders/{folder_id}/sources/{source_id}/locations/{location}/findings/{finding_id}/securityMarks` + `projects/{project_number}/assets/{asset_id}/securityMarks` + `projects/{project_number}/sources/{source_id}/findings/{finding_id}/securityMarks` + `projects/{project_number}/sources/{source_id}/locations/{location}/findings/{finding_id}/securityMarks`", "type": "string" }, "marks": { "additionalProperties": { "type": "string" }, -"description": "Mutable user specified security marks belonging to the parent resource. Constraints are as follows: * Keys and values are treated as case insensitive * Keys must be between 1 - 256 characters (inclusive) * Keys must be letters, numbers, underscores, or dashes * Values have leading and trailing whitespace trimmed, remaining characters must be between 1 - 4096 characters (inclusive)", "type": "object" }, "name": { -"description": "The relative resource name of the SecurityMarks. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name The following list shows some examples: + `organizations/{organization_id}/assets/{asset_id}/securityMarks` + `organizations/{organization_id}/sources/{source_id}/findings/{finding_id}/securityMarks` + `organizations/{organization_id}/sources/{source_id}/locations/{location}/findings/{finding_id}/securityMarks`", "type": "string" } }, "type": "object" }, "GoogleCloudSecuritycenterV2SecurityPolicy": { -"description": "Information about the [Google Cloud Armor security policy](https://cloud.google.com/armor/docs/security-policy-overview) relevant to the finding.", "id": "GoogleCloudSecuritycenterV2SecurityPolicy", "properties": { "name": { -"description": "The name of the Google Cloud Armor security policy, for example, \"my-security-policy\".", "type": "string" }, "preview": { -"description": "Whether or not the associated rule or policy is in preview mode.", "type": "boolean" }, "type": { -"description": "The type of Google Cloud Armor security policy for example, 'backend security policy', 'edge security policy', 'network edge security policy', or 'always-on DDoS protection'.", "type": "string" } }, "type": "object" }, "GoogleCloudSecuritycenterV2SecurityPosture": { -"description": "Represents a posture that is deployed on Google Cloud by the Security Command Center Posture Management service. A posture contains one or more policy sets. A policy set is a group of policies that enforce a set of security rules on Google Cloud.", "id": "GoogleCloudSecuritycenterV2SecurityPosture", "properties": { "changedPolicy": { -"description": "The name of the updated policy, for example, `projects/{project_id}/policies/{constraint_name}`.", "type": "string" }, "name": { -"description": "Name of the posture, for example, `CIS-Posture`.", "type": "string" }, "policy": { -"description": "The ID of the updated policy, for example, `compute-policy-1`.", "type": "string" }, "policyDriftDetails": { -"description": "The details about a change in an updated policy that violates the deployed posture.", "items": { "$ref": "GoogleCloudSecuritycenterV2PolicyDriftDetails" }, "type": "array" }, "policySet": { -"description": "The name of the updated policy set, for example, `cis-policyset`.", "type": "string" }, "postureDeployment": { -"description": "The name of the posture deployment, for example, `organizations/{org_id}/posturedeployments/{posture_deployment_id}`.", "type": "string" }, "postureDeploymentResource": { -"description": "The project, folder, or organization on which the posture is deployed, for example, `projects/{project_number}`.", "type": "string" }, "revisionId": { -"description": "The version of the posture, for example, `c7cfa2a8`.", "type": "string" } }, "type": "object" }, "GoogleCloudSecuritycenterV2SensitiveDataProtectionMapping": { -"description": "Resource value mapping for Sensitive Data Protection findings If any of these mappings have a resource value that is not unspecified, the resource_value field will be ignored when reading this configuration.", "id": "GoogleCloudSecuritycenterV2SensitiveDataProtectionMapping", "properties": { "highSensitivityMapping": { -"description": "Resource value mapping for high-sensitivity Sensitive Data Protection findings", "enum": [ "RESOURCE_VALUE_UNSPECIFIED", "HIGH", @@ -10436,16 +9070,15 @@ false "NONE" ], "enumDescriptions": [ -"Unspecific value", -"High resource value", -"Medium resource value", -"Low resource value", -"No resource value, e.g. ignore these resources" +"", +"", +"", +"", +"" ], "type": "string" }, "mediumSensitivityMapping": { -"description": "Resource value mapping for medium-sensitivity Sensitive Data Protection findings", "enum": [ "RESOURCE_VALUE_UNSPECIFIED", "HIGH", @@ -10454,11 +9087,11 @@ false "NONE" ], "enumDescriptions": [ -"Unspecific value", -"High resource value", -"Medium resource value", -"Low resource value", -"No resource value, e.g. ignore these resources" +"", +"", +"", +"", +"" ], "type": "string" } @@ -10466,11 +9099,9 @@ false "type": "object" }, "GoogleCloudSecuritycenterV2SensitivityScore": { -"description": "Score is calculated from of all elements in the data profile. A higher level means the data is more sensitive.", "id": "GoogleCloudSecuritycenterV2SensitivityScore", "properties": { "score": { -"description": "The sensitivity score applied to the resource.", "enum": [ "SENSITIVITY_SCORE_LEVEL_UNSPECIFIED", "SENSITIVITY_LOW", @@ -10479,11 +9110,11 @@ false "SENSITIVITY_HIGH" ], "enumDescriptions": [ -"Unused.", -"No sensitive information detected. The resource isn't publicly accessible.", -"Unable to determine sensitivity.", -"Medium risk. Contains personally identifiable information (PII), potentially sensitive data, or fields with free-text data that are at a higher risk of having intermittent sensitive data. Consider limiting access.", -"High risk. Sensitive personally identifiable information (SPII) can be present. Exfiltration of data can lead to user data loss. Re-identification of users might be possible. Consider limiting usage and or removing SPII." +"", +"", +"", +"", +"" ], "type": "string" } @@ -10491,31 +9122,25 @@ false "type": "object" }, "GoogleCloudSecuritycenterV2ServiceAccountDelegationInfo": { -"description": "Identity delegation history of an authenticated service account.", "id": "GoogleCloudSecuritycenterV2ServiceAccountDelegationInfo", "properties": { "principalEmail": { -"description": "The email address of a Google account.", "type": "string" }, "principalSubject": { -"description": "A string representing the principal_subject associated with the identity. As compared to `principal_email`, supports principals that aren't associated with email addresses, such as third party principals. For most identities, the format will be `principal://iam.googleapis.com/{identity pool name}/subjects/{subject}` except for some GKE identities (GKE_WORKLOAD, FREEFORM, GKE_HUB_WORKLOAD) that are still in the legacy format `serviceAccount:{identity pool name}[{subject}]`", "type": "string" } }, "type": "object" }, "GoogleCloudSecuritycenterV2StaticMute": { -"description": "Information about the static mute state. A static mute state overrides any dynamic mute rules that apply to this finding. The static mute state can be set by a static mute rule or by muting the finding directly.", "id": "GoogleCloudSecuritycenterV2StaticMute", "properties": { "applyTime": { -"description": "When the static mute was applied.", "format": "google-datetime", "type": "string" }, "state": { -"description": "The static mute state. If the value is `MUTED` or `UNMUTED`, then the finding's overall mute state will have the same value.", "enum": [ "MUTE_UNSPECIFIED", "MUTED", @@ -10523,10 +9148,10 @@ false "UNDEFINED" ], "enumDescriptions": [ -"Unspecified.", -"Finding has been muted.", -"Finding has been unmuted.", -"Finding has never been muted/unmuted." +"", +"", +"", +"" ], "type": "string" } @@ -10534,11 +9159,9 @@ false "type": "object" }, "GoogleCloudSecuritycenterV2Subject": { -"description": "Represents a Kubernetes subject.", "id": "GoogleCloudSecuritycenterV2Subject", "properties": { "kind": { -"description": "Authentication type for the subject.", "enum": [ "AUTH_TYPE_UNSPECIFIED", "USER", @@ -10546,67 +9169,55 @@ false "GROUP" ], "enumDescriptions": [ -"Authentication is not specified.", -"User with valid certificate.", -"Users managed by Kubernetes API with credentials stored as secrets.", -"Collection of users." +"", +"", +"", +"" ], "type": "string" }, "name": { -"description": "Name for the subject.", "type": "string" }, "ns": { -"description": "Namespace for the subject.", "type": "string" } }, "type": "object" }, "GoogleCloudSecuritycenterV2TicketInfo": { -"description": "Information about the ticket, if any, that is being used to track the resolution of the issue that is identified by this finding.", "id": "GoogleCloudSecuritycenterV2TicketInfo", "properties": { "assignee": { -"description": "The assignee of the ticket in the ticket system.", "type": "string" }, "description": { -"description": "The description of the ticket in the ticket system.", "type": "string" }, "id": { -"description": "The identifier of the ticket in the ticket system.", "type": "string" }, "status": { -"description": "The latest status of the ticket, as reported by the ticket system.", "type": "string" }, "updateTime": { -"description": "The time when the ticket was last updated, as reported by the ticket system.", "format": "google-datetime", "type": "string" }, "uri": { -"description": "The link to the ticket in the ticket system.", "type": "string" } }, "type": "object" }, "GoogleCloudSecuritycenterV2ToxicCombination": { -"description": "Contains details about a group of security issues that, when the issues occur together, represent a greater risk than when the issues occur independently. A group of such issues is referred to as a toxic combination.", "id": "GoogleCloudSecuritycenterV2ToxicCombination", "properties": { "attackExposureScore": { -"description": "The [Attack exposure score](https://cloud.google.com/security-command-center/docs/attack-exposure-learn#attack_exposure_scores) of this toxic combination. The score is a measure of how much this toxic combination exposes one or more high-value resources to potential attack.", "format": "double", "type": "number" }, "relatedFindings": { -"description": "List of resource names of findings associated with this toxic combination. For example, `organizations/123/sources/456/findings/789`.", "items": { "type": "string" }, @@ -10616,18 +9227,15 @@ false "type": "object" }, "GoogleCloudSecuritycenterV2VertexAi": { -"description": "Vertex AI-related information associated with the finding.", "id": "GoogleCloudSecuritycenterV2VertexAi", "properties": { "datasets": { -"description": "Datasets associated with the finding.", "items": { "$ref": "GoogleCloudSecuritycenterV2Dataset" }, "type": "array" }, "pipelines": { -"description": "Pipelines associated with the finding.", "items": { "$ref": "GoogleCloudSecuritycenterV2Pipeline" }, @@ -10637,74 +9245,61 @@ false "type": "object" }, "GoogleCloudSecuritycenterV2Vulnerability": { -"description": "Refers to common vulnerability fields e.g. cve, cvss, cwe etc.", "id": "GoogleCloudSecuritycenterV2Vulnerability", "properties": { "cve": { -"$ref": "GoogleCloudSecuritycenterV2Cve", -"description": "CVE stands for Common Vulnerabilities and Exposures (https://cve.mitre.org/about/)" +"$ref": "GoogleCloudSecuritycenterV2Cve" }, "cwes": { -"description": "Represents one or more Common Weakness Enumeration (CWE) information on this vulnerability.", "items": { "$ref": "GoogleCloudSecuritycenterV2Cwe" }, "type": "array" }, "fixedPackage": { -"$ref": "GoogleCloudSecuritycenterV2Package", -"description": "The fixed package is relevant to the finding." +"$ref": "GoogleCloudSecuritycenterV2Package" }, "offendingPackage": { -"$ref": "GoogleCloudSecuritycenterV2Package", -"description": "The offending package is relevant to the finding." +"$ref": "GoogleCloudSecuritycenterV2Package" }, "providerRiskScore": { -"description": "Provider provided risk_score based on multiple factors. The higher the risk score, the more risky the vulnerability is.", "format": "int64", "type": "string" }, "reachable": { -"description": "Represents whether the vulnerability is reachable (detected via static analysis)", "type": "boolean" }, "securityBulletin": { -"$ref": "GoogleCloudSecuritycenterV2SecurityBulletin", -"description": "The security bulletin is relevant to this finding." +"$ref": "GoogleCloudSecuritycenterV2SecurityBulletin" } }, "type": "object" }, "GoogleCloudSecuritycenterV2YaraRuleSignature": { -"description": "A signature corresponding to a YARA rule.", "id": "GoogleCloudSecuritycenterV2YaraRuleSignature", "properties": { "yaraRule": { -"description": "The name of the YARA rule.", "type": "string" } }, "type": "object" }, "GroupMembership": { -"description": "Contains details about groups of which this finding is a member. A group is a collection of findings that are related in some way.", "id": "GroupMembership", "properties": { "groupId": { -"description": "ID of the group.", "type": "string" }, "groupType": { -"description": "Type of group.", "enum": [ "GROUP_TYPE_UNSPECIFIED", "GROUP_TYPE_TOXIC_COMBINATION", "GROUP_TYPE_CHOKEPOINT" ], "enumDescriptions": [ -"Default value.", -"Group represents a toxic combination.", -"Group represents a chokepoint." +"", +"", +"" ], "type": "string" } @@ -10712,76 +9307,64 @@ false "type": "object" }, "HttpResponse": { -"description": "The http response returned by the web application.", "id": "HttpResponse", "properties": { "path": { -"description": "The http path for which response code was returned by web application, for example, \"https://test-app.a.run.app/test\".", "type": "string" }, "statusCode": { -"description": "The http response code returned by the web application, for example, 200.", "type": "string" } }, "type": "object" }, "IamBinding": { -"description": "Represents a particular IAM binding, which captures a member's role addition, removal, or state.", "id": "IamBinding", "properties": { "action": { -"description": "The action that was performed on a Binding.", "enum": [ "ACTION_UNSPECIFIED", "ADD", "REMOVE" ], "enumDescriptions": [ -"Unspecified.", -"Addition of a Binding.", -"Removal of a Binding." +"", +"", +"" ], "type": "string" }, "member": { -"description": "A single identity requesting access for a Cloud Platform resource, for example, \"foo@google.com\".", "type": "string" }, "role": { -"description": "Role that is assigned to \"members\". For example, \"roles/viewer\", \"roles/editor\", or \"roles/owner\".", "type": "string" } }, "type": "object" }, "Indicator": { -"description": "Represents what's commonly known as an _indicator of compromise_ (IoC) in computer forensics. This is an artifact observed on a network or in an operating system that, with high confidence, indicates a computer intrusion. For more information, see [Indicator of compromise](https://en.wikipedia.org/wiki/Indicator_of_compromise).", "id": "Indicator", "properties": { "domains": { -"description": "List of domains associated to the Finding.", "items": { "type": "string" }, "type": "array" }, "ipAddresses": { -"description": "The list of IP addresses that are associated with the finding.", "items": { "type": "string" }, "type": "array" }, "signatures": { -"description": "The list of matched signatures indicating that the given process is present in the environment.", "items": { "$ref": "ProcessSignature" }, "type": "array" }, "uris": { -"description": "The list of URIs associated to the Findings.", "items": { "type": "string" }, @@ -10791,84 +9374,70 @@ false "type": "object" }, "InfoType": { -"description": "Type of information detected by the API.", "id": "InfoType", "properties": { "name": { -"description": "Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`.", "type": "string" }, "sensitivityScore": { -"$ref": "SensitivityScore", -"description": "Optional custom sensitivity for this InfoType. This only applies to data profiling." +"$ref": "SensitivityScore" }, "version": { -"description": "Optional version name for this InfoType.", "type": "string" } }, "type": "object" }, "IpRule": { -"description": "IP rule information.", "id": "IpRule", "properties": { "portRanges": { -"description": "Optional. An optional list of ports to which this rule applies. This field is only applicable for the UDP or (S)TCP protocols. Each entry must be either an integer or a range including a min and max port number.", "items": { "$ref": "PortRange" }, "type": "array" }, "protocol": { -"description": "The IP protocol this rule applies to. This value can either be one of the following well known protocol strings (TCP, UDP, ICMP, ESP, AH, IPIP, SCTP) or a string representation of the integer value.", "type": "string" } }, "type": "object" }, "IpRules": { -"description": "IP rules associated with the finding.", "id": "IpRules", "properties": { "allowed": { -"$ref": "Allowed", -"description": "Tuple with allowed rules." +"$ref": "Allowed" }, "denied": { -"$ref": "Denied", -"description": "Tuple with denied rules." +"$ref": "Denied" }, "destinationIpRanges": { -"description": "If destination IP ranges are specified, the firewall rule applies only to traffic that has a destination IP address in these ranges. These ranges must be expressed in CIDR format. Only supports IPv4.", "items": { "type": "string" }, "type": "array" }, "direction": { -"description": "The direction that the rule is applicable to, one of ingress or egress.", "enum": [ "DIRECTION_UNSPECIFIED", "INGRESS", "EGRESS" ], "enumDescriptions": [ -"Unspecified direction value.", -"Ingress direction value.", -"Egress direction value." +"", +"", +"" ], "type": "string" }, "exposedServices": { -"description": "Name of the network protocol service, such as FTP, that is exposed by the open port. Follows the naming convention available at: https://www.iana.org/assignments/service-names-port-numbers/service-names-port-numbers.xhtml.", "items": { "type": "string" }, "type": "array" }, "sourceIpRanges": { -"description": "If source IP ranges are specified, the firewall rule applies only to traffic that has a source IP address in these ranges. These ranges must be expressed in CIDR format. Only supports IPv4.", "items": { "type": "string" }, @@ -10878,24 +9447,19 @@ false "type": "object" }, "Job": { -"description": "Describes a job", "id": "Job", "properties": { "errorCode": { -"description": "Optional. If the job did not complete successfully, this field describes why.", "format": "int32", "type": "integer" }, "location": { -"description": "Optional. Gives the location where the job ran, such as `US` or `europe-west1`", "type": "string" }, "name": { -"description": "The fully-qualified name for a job. e.g. `projects//jobs/`", "type": "string" }, "state": { -"description": "Output only. State of the job, such as `RUNNING` or `PENDING`.", "enum": [ "JOB_STATE_UNSPECIFIED", "PENDING", @@ -10904,11 +9468,11 @@ false "FAILED" ], "enumDescriptions": [ -"Unspecified represents an unknown state and should not be used.", -"Job is scheduled and pending for run", -"Job in progress", -"Job has completed with success", -"Job has completed but with failure" +"", +"", +"", +"", +"" ], "readOnly": true, "type": "string" @@ -10917,96 +9481,78 @@ false "type": "object" }, "KernelRootkit": { -"description": "Kernel mode rootkit signatures.", "id": "KernelRootkit", "properties": { "name": { -"description": "Rootkit name, when available.", "type": "string" }, "unexpectedCodeModification": { -"description": "True if unexpected modifications of kernel code memory are present.", "type": "boolean" }, "unexpectedFtraceHandler": { -"description": "True if `ftrace` points are present with callbacks pointing to regions that are not in the expected kernel or module code range.", "type": "boolean" }, "unexpectedInterruptHandler": { -"description": "True if interrupt handlers that are are not in the expected kernel or module code regions are present.", "type": "boolean" }, "unexpectedKernelCodePages": { -"description": "True if kernel code pages that are not in the expected kernel or module code regions are present.", "type": "boolean" }, "unexpectedKprobeHandler": { -"description": "True if `kprobe` points are present with callbacks pointing to regions that are not in the expected kernel or module code range.", "type": "boolean" }, "unexpectedProcessesInRunqueue": { -"description": "True if unexpected processes in the scheduler run queue are present. Such processes are in the run queue, but not in the process task list.", "type": "boolean" }, "unexpectedReadOnlyDataModification": { -"description": "True if unexpected modifications of kernel read-only data memory are present.", "type": "boolean" }, "unexpectedSystemCallHandler": { -"description": "True if system call handlers that are are not in the expected kernel or module code regions are present.", "type": "boolean" } }, "type": "object" }, "Kubernetes": { -"description": "Kubernetes-related attributes.", "id": "Kubernetes", "properties": { "accessReviews": { -"description": "Provides information on any Kubernetes access reviews (privilege checks) relevant to the finding.", "items": { "$ref": "AccessReview" }, "type": "array" }, "bindings": { -"description": "Provides Kubernetes role binding information for findings that involve [RoleBindings or ClusterRoleBindings](https://cloud.google.com/kubernetes-engine/docs/how-to/role-based-access-control).", "items": { "$ref": "GoogleCloudSecuritycenterV1Binding" }, "type": "array" }, "nodePools": { -"description": "GKE [node pools](https://cloud.google.com/kubernetes-engine/docs/concepts/node-pools) associated with the finding. This field contains node pool information for each node, when it is available.", "items": { "$ref": "NodePool" }, "type": "array" }, "nodes": { -"description": "Provides Kubernetes [node](https://cloud.google.com/kubernetes-engine/docs/concepts/cluster-architecture#nodes) information.", "items": { "$ref": "Node" }, "type": "array" }, "objects": { -"description": "Kubernetes objects related to the finding.", "items": { "$ref": "Object" }, "type": "array" }, "pods": { -"description": "Kubernetes [Pods](https://cloud.google.com/kubernetes-engine/docs/concepts/pod) associated with the finding. This field contains Pod records for each container that is owned by a Pod.", "items": { "$ref": "Pod" }, "type": "array" }, "roles": { -"description": "Provides Kubernetes role information for findings that involve [Roles or ClusterRoles](https://cloud.google.com/kubernetes-engine/docs/how-to/role-based-access-control).", "items": { "$ref": "Role" }, @@ -11016,52 +9562,42 @@ false "type": "object" }, "Label": { -"description": "Represents a generic name-value label. A label has separate name and value fields to support filtering with the `contains()` function. For more information, see [Filtering on array-type fields](https://cloud.google.com/security-command-center/docs/how-to-api-list-findings#array-contains-filtering).", "id": "Label", "properties": { "name": { -"description": "Name of the label.", "type": "string" }, "value": { -"description": "Value that corresponds to the label's name.", "type": "string" } }, "type": "object" }, "LoadBalancer": { -"description": "Contains information related to the load balancer associated with the finding.", "id": "LoadBalancer", "properties": { "name": { -"description": "The name of the load balancer associated with the finding.", "type": "string" } }, "type": "object" }, "LogEntry": { -"description": "An individual entry in a log.", "id": "LogEntry", "properties": { "cloudLoggingEntry": { -"$ref": "CloudLoggingEntry", -"description": "An individual entry in a log stored in Cloud Logging." +"$ref": "CloudLoggingEntry" } }, "type": "object" }, "MemoryHashSignature": { -"description": "A signature corresponding to memory page hashes.", "id": "MemoryHashSignature", "properties": { "binaryFamily": { -"description": "The binary family.", "type": "string" }, "detections": { -"description": "The list of memory hash detections contributing to the binary family match.", "items": { "$ref": "Detection" }, @@ -11071,11 +9607,9 @@ false "type": "object" }, "MitreAttack": { -"description": "MITRE ATT&CK tactics and techniques related to this finding. See: https://attack.mitre.org", "id": "MitreAttack", "properties": { "additionalTactics": { -"description": "Additional MITRE ATT&CK tactics related to this finding, if any.", "items": { "enum": [ "TACTIC_UNSPECIFIED", @@ -11095,28 +9629,27 @@ false "IMPACT" ], "enumDescriptions": [ -"Unspecified value.", -"TA0043", -"TA0042", -"TA0001", -"TA0002", -"TA0003", -"TA0004", -"TA0005", -"TA0006", -"TA0007", -"TA0008", -"TA0009", -"TA0011", -"TA0010", -"TA0040" +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"" ], "type": "string" }, "type": "array" }, "additionalTechniques": { -"description": "Additional MITRE ATT&CK techniques related to this finding, if any, along with any of their respective parent techniques.", "items": { "enum": [ "TECHNIQUE_UNSPECIFIED", @@ -11260,152 +9793,151 @@ false "FINANCIAL_THEFT" ], "enumDescriptions": [ -"Unspecified value.", -"T1001", -"T1001.002", -"T1003", -"T1003.007", -"T1003.008", -"T1005", -"T1020", -"T1027", -"T1027.003", -"T1027.004", -"T1027.010", -"T1029", -"T1033", -"T1036", -"T1036.005", -"T1037", -"T1037.005", -"T1046", -"T1053", -"T1053.003", -"T1053.007", -"T1055", -"T1056", -"T1056.001", -"T1057", -"T1059", -"T1059.004", -"T1059.006", -"T1068", -"T1069", -"T1069.003", -"T1070", -"T1070.002", -"T1070.003", -"T1070.004", -"T1070.006", -"T1070.008", -"T1071", -"T1071.004", -"T1072", -"T1078", -"T1078.001", -"T1078.003", -"T1078.004", -"T1083", -"T1087.001", -"T1090", -"T1090.002", -"T1090.003", -"T1098", -"T1098.001", -"T1098.003", -"T1098.004", -"T1098.006", -"T1104", -"T1105", -"T1106", -"T1110", -"T1119", -"T1129", -"T1132", -"T1132.001", -"T1134", -"T1134.001", -"T1136", -"T1136.001", -"T1140", -"T1190", -"T1195", -"T1195.001", -"T1203", -"T1204", -"T1212", -"T1222.002", -"T1484", -"T1485", -"T1486", -"T1489", -"T1490", -"T1495", -"T1496", -"T1498", -"T1526", -"T1528", -"T1531", -"T1537", -"T1539", -"T1543", -"T1546", -"T1547", -"T1547.006", -"T1547.009", -"T1548", -"T1548.001", -"T1548.003", -"T1552", -"T1552.001", -"T1552.003", -"T1552.004", -"T1553", -"T1553.004", -"T1554", -"T1555", -"T1556", -"T1556.003", -"T1556.006", -"T1562", -"T1562.001", -"T1562.006", -"T1562.012", -"T1564", -"T1564.001", -"T1564.002", -"T1567", -"T1567.002", -"T1568", -"T1570", -"T1574", -"T1574.006", -"T1578", -"T1578.001", -"T1580", -"T1587", -"T1587.001", -"T1588", -"T1588.001", -"T1588.006", -"T1595", -"T1595.001", -"T1608", -"T1608.001", -"T1609", -"T1610", -"T1611", -"T1613", -"T1620", -"T1649", -"T1657" +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"" ], "type": "string" }, "type": "array" }, "primaryTactic": { -"description": "The MITRE ATT&CK tactic most closely represented by this finding, if any.", "enum": [ "TACTIC_UNSPECIFIED", "RECONNAISSANCE", @@ -11424,26 +9956,25 @@ false "IMPACT" ], "enumDescriptions": [ -"Unspecified value.", -"TA0043", -"TA0042", -"TA0001", -"TA0002", -"TA0003", -"TA0004", -"TA0005", -"TA0006", -"TA0007", -"TA0008", -"TA0009", -"TA0011", -"TA0010", -"TA0040" +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"" ], "type": "string" }, "primaryTechniques": { -"description": "The MITRE ATT&CK technique most closely represented by this finding, if any. primary_techniques is a repeated field because there are multiple levels of MITRE ATT&CK techniques. If the technique most closely represented by this finding is a sub-technique (e.g. `SCANNING_IP_BLOCKS`), both the sub-technique and its parent technique(s) will be listed (e.g. `SCANNING_IP_BLOCKS`, `ACTIVE_SCANNING`).", "items": { "enum": [ "TECHNIQUE_UNSPECIFIED", @@ -11587,207 +10118,196 @@ false "FINANCIAL_THEFT" ], "enumDescriptions": [ -"Unspecified value.", -"T1001", -"T1001.002", -"T1003", -"T1003.007", -"T1003.008", -"T1005", -"T1020", -"T1027", -"T1027.003", -"T1027.004", -"T1027.010", -"T1029", -"T1033", -"T1036", -"T1036.005", -"T1037", -"T1037.005", -"T1046", -"T1053", -"T1053.003", -"T1053.007", -"T1055", -"T1056", -"T1056.001", -"T1057", -"T1059", -"T1059.004", -"T1059.006", -"T1068", -"T1069", -"T1069.003", -"T1070", -"T1070.002", -"T1070.003", -"T1070.004", -"T1070.006", -"T1070.008", -"T1071", -"T1071.004", -"T1072", -"T1078", -"T1078.001", -"T1078.003", -"T1078.004", -"T1083", -"T1087.001", -"T1090", -"T1090.002", -"T1090.003", -"T1098", -"T1098.001", -"T1098.003", -"T1098.004", -"T1098.006", -"T1104", -"T1105", -"T1106", -"T1110", -"T1119", -"T1129", -"T1132", -"T1132.001", -"T1134", -"T1134.001", -"T1136", -"T1136.001", -"T1140", -"T1190", -"T1195", -"T1195.001", -"T1203", -"T1204", -"T1212", -"T1222.002", -"T1484", -"T1485", -"T1486", -"T1489", -"T1490", -"T1495", -"T1496", -"T1498", -"T1526", -"T1528", -"T1531", -"T1537", -"T1539", -"T1543", -"T1546", -"T1547", -"T1547.006", -"T1547.009", -"T1548", -"T1548.001", -"T1548.003", -"T1552", -"T1552.001", -"T1552.003", -"T1552.004", -"T1553", -"T1553.004", -"T1554", -"T1555", -"T1556", -"T1556.003", -"T1556.006", -"T1562", -"T1562.001", -"T1562.006", -"T1562.012", -"T1564", -"T1564.001", -"T1564.002", -"T1567", -"T1567.002", -"T1568", -"T1570", -"T1574", -"T1574.006", -"T1578", -"T1578.001", -"T1580", -"T1587", -"T1587.001", -"T1588", -"T1588.001", -"T1588.006", -"T1595", -"T1595.001", -"T1608", -"T1608.001", -"T1609", -"T1610", -"T1611", -"T1613", -"T1620", -"T1649", -"T1657" +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"" ], "type": "string" }, "type": "array" }, "version": { -"description": "The MITRE ATT&CK version referenced by the above fields. E.g. \"8\".", "type": "string" } }, "type": "object" }, "MuteInfo": { -"description": "Mute information about the finding, including whether the finding has a static mute or any matching dynamic mute rules.", "id": "MuteInfo", "properties": { "dynamicMuteRecords": { -"description": "The list of dynamic mute rules that currently match the finding.", "items": { "$ref": "DynamicMuteRecord" }, "type": "array" }, "staticMute": { -"$ref": "StaticMute", -"description": "If set, the static mute applied to this finding. Static mutes override dynamic mutes. If unset, there is no static mute." +"$ref": "StaticMute" } }, "type": "object" }, "Network": { -"description": "Contains information about a VPC network associated with the finding.", "id": "Network", "properties": { "name": { -"description": "The name of the VPC network resource, for example, `//compute.googleapis.com/projects/my-project/global/networks/my-network`.", "type": "string" } }, "type": "object" }, "Node": { -"description": "Kubernetes nodes associated with the finding.", "id": "Node", "properties": { "name": { -"description": "[Full resource name](https://google.aip.dev/122#full-resource-names) of the Compute Engine VM running the cluster node.", "type": "string" } }, "type": "object" }, "NodePool": { -"description": "Provides GKE node pool information.", "id": "NodePool", "properties": { "name": { -"description": "Kubernetes node pool name.", "type": "string" }, "nodes": { -"description": "Nodes associated with the finding.", "items": { "$ref": "Node" }, @@ -11797,177 +10317,142 @@ false "type": "object" }, "Notebook": { -"description": "Represents a Jupyter notebook IPYNB file, such as a [Colab Enterprise notebook](https://cloud.google.com/colab/docs/introduction) file, that is associated with a finding.", "id": "Notebook", "properties": { "lastAuthor": { -"description": "The user ID of the latest author to modify the notebook.", "type": "string" }, "name": { -"description": "The name of the notebook.", "type": "string" }, "notebookUpdateTime": { -"description": "The most recent time the notebook was updated.", "format": "google-datetime", "type": "string" }, "service": { -"description": "The source notebook service, for example, \"Colab Enterprise\".", "type": "string" } }, "type": "object" }, "Object": { -"description": "Kubernetes object related to the finding, uniquely identified by GKNN. Used if the object Kind is not one of Pod, Node, NodePool, Binding, or AccessReview.", "id": "Object", "properties": { "containers": { -"description": "Pod containers associated with this finding, if any.", "items": { "$ref": "Container" }, "type": "array" }, "group": { -"description": "Kubernetes object group, such as \"policy.k8s.io/v1\".", "type": "string" }, "kind": { -"description": "Kubernetes object kind, such as \"Namespace\".", "type": "string" }, "name": { -"description": "Kubernetes object name. For details see https://kubernetes.io/docs/concepts/overview/working-with-objects/names/.", "type": "string" }, "ns": { -"description": "Kubernetes object namespace. Must be a valid DNS label. Named \"ns\" to avoid collision with C++ namespace keyword. For details see https://kubernetes.io/docs/tasks/administer-cluster/namespaces/.", "type": "string" } }, "type": "object" }, "OrgPolicy": { -"description": "Contains information about the org policies associated with the finding.", "id": "OrgPolicy", "properties": { "name": { -"description": "The resource name of the org policy. Example: \"organizations/{organization_id}/policies/{constraint_name}\"", "type": "string" } }, "type": "object" }, "Package": { -"description": "Package is a generic definition of a package.", "id": "Package", "properties": { "cpeUri": { -"description": "The CPE URI where the vulnerability was detected.", "type": "string" }, "packageName": { -"description": "The name of the package where the vulnerability was detected.", "type": "string" }, "packageType": { -"description": "Type of package, for example, os, maven, or go.", "type": "string" }, "packageVersion": { -"description": "The version of the package.", "type": "string" } }, "type": "object" }, "Pipeline": { -"description": "Vertex AI training pipeline associated with the finding.", "id": "Pipeline", "properties": { "displayName": { -"description": "The user defined display name of pipeline, e.g. plants-classification", "type": "string" }, "name": { -"description": "Resource name of the pipeline, e.g. projects/{project}/locations/{location}/trainingPipelines/5253428229225578496", "type": "string" } }, "type": "object" }, "Pod": { -"description": "A Kubernetes Pod.", "id": "Pod", "properties": { "containers": { -"description": "Pod containers associated with this finding, if any.", "items": { "$ref": "Container" }, "type": "array" }, "labels": { -"description": "Pod labels. For Kubernetes containers, these are applied to the container.", "items": { "$ref": "Label" }, "type": "array" }, "name": { -"description": "Kubernetes Pod name.", "type": "string" }, "ns": { -"description": "Kubernetes Pod namespace.", "type": "string" } }, "type": "object" }, "PolicyDriftDetails": { -"description": "The policy field that violates the deployed posture and its expected and detected values.", "id": "PolicyDriftDetails", "properties": { "detectedValue": { -"description": "The detected value that violates the deployed posture, for example, `false` or `allowed_values={\"projects/22831892\"}`.", "type": "string" }, "expectedValue": { -"description": "The value of this field that was configured in a posture, for example, `true` or `allowed_values={\"projects/29831892\"}`.", "type": "string" }, "field": { -"description": "The name of the updated field, for example constraint.implementation.policy_rules[0].enforce", "type": "string" } }, "type": "object" }, "PolicyViolationSummary": { -"description": "Metadata summarizing policy violations of child resources of the affected resource. `finding_category` and `resource` determine the exact semantics of the counts. For example, when category=DATA_SECURITY_POSTURE_OBJECT_PUBLIC_ACCESS_VIOLATION and resource='storage.googleapis.com/buckets/my-bucket-name' then this counts the number of Cloud Storage objects in my-bucket-name which violate a Public Access control.", "id": "PolicyViolationSummary", "properties": { "conformantResourcesCount": { -"description": "Total number of child resources that conform to the policy.", "format": "int64", "type": "string" }, "evaluationErrorsCount": { -"description": "Number of child resources for which errors during evaluation occurred. The evaluation result for these child resources is effectively \"unknown\".", "format": "int64", "type": "string" }, "outOfScopeResourcesCount": { -"description": "Total count of child resources which were not in scope for evaluation.", "format": "int64", "type": "string" }, "policyViolationsCount": { -"description": "Count of child resources in violation of the policy.", "format": "int64", "type": "string" } @@ -11975,16 +10460,13 @@ false "type": "object" }, "PortRange": { -"description": "A port range which is inclusive of the min and max values. Values are between 0 and 2^16-1. The max can be equal / must be not smaller than the min value. If min and max are equal this indicates that it is a single port.", "id": "PortRange", "properties": { "max": { -"description": "Maximum port value.", "format": "int64", "type": "string" }, "min": { -"description": "Minimum port value.", "format": "int64", "type": "string" } @@ -11992,62 +10474,50 @@ false "type": "object" }, "Process": { -"description": "Represents an operating system process.", "id": "Process", "properties": { "args": { -"description": "Process arguments as JSON encoded strings.", "items": { "type": "string" }, "type": "array" }, "argumentsTruncated": { -"description": "True if `args` is incomplete.", "type": "boolean" }, "binary": { -"$ref": "File", -"description": "File information for the process executable." +"$ref": "File" }, "envVariables": { -"description": "Process environment variables.", "items": { "$ref": "EnvironmentVariable" }, "type": "array" }, "envVariablesTruncated": { -"description": "True if `env_variables` is incomplete.", "type": "boolean" }, "libraries": { -"description": "File information for libraries loaded by the process.", "items": { "$ref": "File" }, "type": "array" }, "name": { -"description": "The process name, as displayed in utilities like `top` and `ps`. This name can be accessed through `/proc/[pid]/comm` and changed with `prctl(PR_SET_NAME)`.", "type": "string" }, "parentPid": { -"description": "The parent process ID.", "format": "int64", "type": "string" }, "pid": { -"description": "The process ID.", "format": "int64", "type": "string" }, "script": { -"$ref": "File", -"description": "When the process represents the invocation of a script, `binary` provides information about the interpreter, while `script` provides information about the script file provided to the interpreter." +"$ref": "File" }, "userId": { -"description": "The ID of the user that executed the process. E.g. If this is the root user this will always be 0.", "format": "int64", "type": "string" } @@ -12055,51 +10525,43 @@ false "type": "object" }, "ProcessSignature": { -"description": "Indicates what signature matched this process.", "id": "ProcessSignature", "properties": { "memoryHashSignature": { -"$ref": "MemoryHashSignature", -"description": "Signature indicating that a binary family was matched." +"$ref": "MemoryHashSignature" }, "signatureType": { -"description": "Describes the type of resource associated with the signature.", "enum": [ "SIGNATURE_TYPE_UNSPECIFIED", "SIGNATURE_TYPE_PROCESS", "SIGNATURE_TYPE_FILE" ], "enumDescriptions": [ -"The default signature type.", -"Used for signatures concerning processes.", -"Used for signatures concerning disks." +"", +"", +"" ], "type": "string" }, "yaraRuleSignature": { -"$ref": "YaraRuleSignature", -"description": "Signature indicating that a YARA rule was matched." +"$ref": "YaraRuleSignature" } }, "type": "object" }, "RapidVulnerabilityDetectionSettings": { -"description": "Resource capturing the settings for the Rapid Vulnerability Detection service.", "id": "RapidVulnerabilityDetectionSettings", "properties": { "modules": { "additionalProperties": { "$ref": "Config" }, -"description": "The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's.", "type": "object" }, "name": { -"description": "The resource name of the RapidVulnerabilityDetectionSettings. Formats: * organizations/{organization}/rapidVulnerabilityDetectionSettings * folders/{folder}/rapidVulnerabilityDetectionSettings * projects/{project}/rapidVulnerabilityDetectionSettings", "type": "string" }, "serviceEnablementState": { -"description": "The state of enablement for the service at its level of the resource hierarchy. A DISABLED state will override all module enablement_states to DISABLED.", "enum": [ "ENABLEMENT_STATE_UNSPECIFIED", "INHERITED", @@ -12107,15 +10569,14 @@ false "DISABLED" ], "enumDescriptions": [ -"Default value. This value is unused.", -"State is inherited from the parent resource.", -"State is enabled.", -"State is disabled." +"", +"", +"", +"" ], "type": "string" }, "updateTime": { -"description": "Output only. The time the settings were last updated.", "format": "google-datetime", "readOnly": true, "type": "string" @@ -12124,41 +10585,33 @@ false "type": "object" }, "Reference": { -"description": "Additional Links", "id": "Reference", "properties": { "source": { -"description": "Source of the reference e.g. NVD", "type": "string" }, "uri": { -"description": "Uri for the mentioned source e.g. https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2021-34527.", "type": "string" } }, "type": "object" }, "Requests": { -"description": "Information about the requests relevant to the finding.", "id": "Requests", "properties": { "longTermAllowed": { -"description": "Allowed RPS (requests per second) over the long term.", "format": "int32", "type": "integer" }, "longTermDenied": { -"description": "Denied RPS (requests per second) over the long term.", "format": "int32", "type": "integer" }, "ratio": { -"description": "For 'Increasing deny ratio', the ratio is the denied traffic divided by the allowed traffic. For 'Allowed traffic spike', the ratio is the allowed traffic in the short term divided by allowed traffic in the long term.", "format": "double", "type": "number" }, "shortTermAllowed": { -"description": "Allowed RPS (requests per second) in the short term.", "format": "int32", "type": "integer" } @@ -12166,11 +10619,9 @@ false "type": "object" }, "ResourcePath": { -"description": "Represents the path of resources leading up to the resource this finding is about.", "id": "ResourcePath", "properties": { "nodes": { -"description": "The list of nodes that make the up resource path, ordered from lowest level to highest level.", "items": { "$ref": "ResourcePathNode" }, @@ -12180,19 +10631,15 @@ false "type": "object" }, "ResourcePathNode": { -"description": "A node within the resource path. Each node represents a resource within the resource hierarchy.", "id": "ResourcePathNode", "properties": { "displayName": { -"description": "The display name of the resource this node represents.", "type": "string" }, "id": { -"description": "The ID of the resource this node represents.", "type": "string" }, "nodeType": { -"description": "The type of resource this node represents.", "enum": [ "RESOURCE_PATH_NODE_TYPE_UNSPECIFIED", "GCP_ORGANIZATION", @@ -12206,16 +10653,16 @@ false "AZURE_RESOURCE_GROUP" ], "enumDescriptions": [ -"Node type is unspecified.", -"The node represents a Google Cloud organization.", -"The node represents a Google Cloud folder.", -"The node represents a Google Cloud project.", -"The node represents an AWS organization.", -"The node represents an AWS organizational unit.", -"The node represents an AWS account.", -"The node represents an Azure management group.", -"The node represents an Azure subscription.", -"The node represents an Azure resource group." +"", +"", +"", +"", +"", +"", +"", +"", +"", +"" ], "type": "string" } @@ -12223,90 +10670,74 @@ false "type": "object" }, "Role": { -"description": "Kubernetes Role or ClusterRole.", "id": "Role", "properties": { "kind": { -"description": "Role type.", "enum": [ "KIND_UNSPECIFIED", "ROLE", "CLUSTER_ROLE" ], "enumDescriptions": [ -"Role type is not specified.", -"Kubernetes Role.", -"Kubernetes ClusterRole." +"", +"", +"" ], "type": "string" }, "name": { -"description": "Role name.", "type": "string" }, "ns": { -"description": "Role namespace.", "type": "string" } }, "type": "object" }, "Secret": { -"description": "Details about a secret or credential associated with the finding.", "id": "Secret", "properties": { "environmentVariable": { -"$ref": "SecretEnvironmentVariable", -"description": "The environment variable containing the secret." +"$ref": "SecretEnvironmentVariable" }, "filePath": { -"$ref": "SecretFilePath", -"description": "The file containing the secret." +"$ref": "SecretFilePath" }, "status": { -"$ref": "SecretStatus", -"description": "The status of the secret." +"$ref": "SecretStatus" }, "type": { -"description": "The type of secret, for example, GCP_API_KEY.", "type": "string" } }, "type": "object" }, "SecretEnvironmentVariable": { -"description": "Environment variable containing the secret.", "id": "SecretEnvironmentVariable", "properties": { "key": { -"description": "Environment variable name as a JSON encoded string. Note that value is not included since the value contains the secret data, which is sensitive core content.", "type": "string" } }, "type": "object" }, "SecretFilePath": { -"description": "File path containing the secret.", "id": "SecretFilePath", "properties": { "path": { -"description": "Path to the file.", "type": "string" } }, "type": "object" }, "SecretStatus": { -"description": "The status of the secret.", "id": "SecretStatus", "properties": { "lastUpdatedTime": { -"description": "Time that the secret was found.", "format": "google-datetime", "type": "string" }, "validity": { -"description": "The validity of the secret.", "enum": [ "SECRET_VALIDITY_UNSPECIFIED", "SECRET_VALIDITY_UNSUPPORTED", @@ -12315,11 +10746,11 @@ false "SECRET_VALIDITY_VALID" ], "enumDescriptions": [ -"Default value; no validation was attempted.", -"There is no mechanism to validate the secret.", -"Validation is supported but the validation failed.", -"The secret is confirmed to be invalid.", -"The secret is confirmed to be valid." +"", +"", +"", +"", +"" ], "type": "string" } @@ -12327,49 +10758,39 @@ false "type": "object" }, "SecurityBulletin": { -"description": "SecurityBulletin are notifications of vulnerabilities of Google products.", "id": "SecurityBulletin", "properties": { "bulletinId": { -"description": "ID of the bulletin corresponding to the vulnerability.", "type": "string" }, "submissionTime": { -"description": "Submission time of this Security Bulletin.", "format": "google-datetime", "type": "string" }, "suggestedUpgradeVersion": { -"description": "This represents a version that the cluster receiving this notification should be upgraded to, based on its current version. For example, 1.15.0", "type": "string" } }, "type": "object" }, "SecurityCenterSettings": { -"description": "Resource capturing the settings for Security Center.", "id": "SecurityCenterSettings", "properties": { "cryptoKeyName": { -"description": "The KMS key name used for CMEK encryption. Format: projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{key_name}", "type": "string" }, "logSinkProject": { -"description": "The resource name of the project to send logs to. This project must be part of the organization this resource resides in. The format is `projects/{project_id}`. An empty value disables logging. This value is only referenced by services that support log sink. Please refer to the documentation for an updated list of compatible services. This may only be specified for organization level onboarding.", "type": "string" }, "name": { -"description": "The resource name of the SecurityCenterSettings. Format: organizations/{organization}/securityCenterSettings Format: folders/{folder}/securityCenterSettings Format: projects/{project}/securityCenterSettings", "type": "string" }, "onboardingTime": { -"description": "Output only. Timestamp of when the customer organization was onboarded to SCC.", "format": "google-datetime", "readOnly": true, "type": "string" }, "orgServiceAccount": { -"description": "Output only. The organization level service account to be used for security center components.", "readOnly": true, "type": "string" } @@ -12377,27 +10798,22 @@ false "type": "object" }, "SecurityHealthAnalyticsSettings": { -"description": "Resource capturing the settings for the Security Health Analytics service.", "id": "SecurityHealthAnalyticsSettings", "properties": { "modules": { "additionalProperties": { "$ref": "Config" }, -"description": "The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's configuration.", "type": "object" }, "name": { -"description": "Identifier. The resource name of the SecurityHealthAnalyticsSettings. Formats: * organizations/{organization}/securityHealthAnalyticsSettings * folders/{folder}/securityHealthAnalyticsSettings * projects/{project}/securityHealthAnalyticsSettings", "type": "string" }, "serviceAccount": { -"description": "Output only. The service account used by Security Health Analytics detectors.", "readOnly": true, "type": "string" }, "serviceEnablementState": { -"description": "The state of enablement for the service at its level of the resource hierarchy. A DISABLED state will override all module enablement_states to DISABLED.", "enum": [ "ENABLEMENT_STATE_UNSPECIFIED", "INHERITED", @@ -12405,15 +10821,14 @@ false "DISABLED" ], "enumDescriptions": [ -"Default value. This value is unused.", -"State is inherited from the parent resource.", -"State is enabled.", -"State is disabled." +"", +"", +"", +"" ], "type": "string" }, "updateTime": { -"description": "Output only. The time the settings were last updated.", "format": "google-datetime", "readOnly": true, "type": "string" @@ -12422,94 +10837,75 @@ false "type": "object" }, "SecurityMarks": { -"description": "User specified security marks that are attached to the parent Security Command Center resource. Security marks are scoped within a Security Command Center organization -- they can be modified and viewed by all users who have proper permissions on the organization.", "id": "SecurityMarks", "properties": { "canonicalName": { -"description": "The canonical name of the marks. Examples: \"organizations/{organization_id}/assets/{asset_id}/securityMarks\" \"folders/{folder_id}/assets/{asset_id}/securityMarks\" \"projects/{project_number}/assets/{asset_id}/securityMarks\" \"organizations/{organization_id}/sources/{source_id}/findings/{finding_id}/securityMarks\" \"folders/{folder_id}/sources/{source_id}/findings/{finding_id}/securityMarks\" \"projects/{project_number}/sources/{source_id}/findings/{finding_id}/securityMarks\"", "type": "string" }, "marks": { "additionalProperties": { "type": "string" }, -"description": "Mutable user specified security marks belonging to the parent resource. Constraints are as follows: * Keys and values are treated as case insensitive * Keys must be between 1 - 256 characters (inclusive) * Keys must be letters, numbers, underscores, or dashes * Values have leading and trailing whitespace trimmed, remaining characters must be between 1 - 4096 characters (inclusive)", "type": "object" }, "name": { -"description": "The relative resource name of the SecurityMarks. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Examples: \"organizations/{organization_id}/assets/{asset_id}/securityMarks\" \"organizations/{organization_id}/sources/{source_id}/findings/{finding_id}/securityMarks\".", "type": "string" } }, "type": "object" }, "SecurityPolicy": { -"description": "Information about the [Google Cloud Armor security policy](https://cloud.google.com/armor/docs/security-policy-overview) relevant to the finding.", "id": "SecurityPolicy", "properties": { "name": { -"description": "The name of the Google Cloud Armor security policy, for example, \"my-security-policy\".", "type": "string" }, "preview": { -"description": "Whether or not the associated rule or policy is in preview mode.", "type": "boolean" }, "type": { -"description": "The type of Google Cloud Armor security policy for example, 'backend security policy', 'edge security policy', 'network edge security policy', or 'always-on DDoS protection'.", "type": "string" } }, "type": "object" }, "SecurityPosture": { -"description": "Represents a posture that is deployed on Google Cloud by the Security Command Center Posture Management service. A posture contains one or more policy sets. A policy set is a group of policies that enforce a set of security rules on Google Cloud.", "id": "SecurityPosture", "properties": { "changedPolicy": { -"description": "The name of the updated policy, for example, `projects/{project_id}/policies/{constraint_name}`.", "type": "string" }, "name": { -"description": "Name of the posture, for example, `CIS-Posture`.", "type": "string" }, "policy": { -"description": "The ID of the updated policy, for example, `compute-policy-1`.", "type": "string" }, "policyDriftDetails": { -"description": "The details about a change in an updated policy that violates the deployed posture.", "items": { "$ref": "PolicyDriftDetails" }, "type": "array" }, "policySet": { -"description": "The name of the updated policyset, for example, `cis-policyset`.", "type": "string" }, "postureDeployment": { -"description": "The name of the posture deployment, for example, `organizations/{org_id}/posturedeployments/{posture_deployment_id}`.", "type": "string" }, "postureDeploymentResource": { -"description": "The project, folder, or organization on which the posture is deployed, for example, `projects/{project_number}`.", "type": "string" }, "revisionId": { -"description": "The version of the posture, for example, `c7cfa2a8`.", "type": "string" } }, "type": "object" }, "SensitivityScore": { -"description": "Score is calculated from of all elements in the data profile. A higher level means the data is more sensitive.", "id": "SensitivityScore", "properties": { "score": { -"description": "The sensitivity score applied to the resource.", "enum": [ "SENSITIVITY_SCORE_LEVEL_UNSPECIFIED", "SENSITIVITY_LOW", @@ -12518,11 +10914,11 @@ false "SENSITIVITY_HIGH" ], "enumDescriptions": [ -"Unused.", -"No sensitive information detected. The resource isn't publicly accessible.", -"Unable to determine sensitivity.", -"Medium risk. Contains personally identifiable information (PII), potentially sensitive data, or fields with free-text data that are at a higher risk of having intermittent sensitive data. Consider limiting access.", -"High risk. Sensitive personally identifiable information (SPII) can be present. Exfiltration of data can lead to user data loss. Re-identification of users might be possible. Consider limiting usage and or removing SPII." +"", +"", +"", +"", +"" ], "type": "string" } @@ -12530,31 +10926,25 @@ false "type": "object" }, "ServiceAccountDelegationInfo": { -"description": "Identity delegation history of an authenticated service account.", "id": "ServiceAccountDelegationInfo", "properties": { "principalEmail": { -"description": "The email address of a Google account.", "type": "string" }, "principalSubject": { -"description": "A string representing the principal_subject associated with the identity. As compared to `principal_email`, supports principals that aren't associated with email addresses, such as third party principals. For most identities, the format will be `principal://iam.googleapis.com/{identity pool name}/subjects/{subject}` except for some GKE identities (GKE_WORKLOAD, FREEFORM, GKE_HUB_WORKLOAD) that are still in the legacy format `serviceAccount:{identity pool name}[{subject}]`", "type": "string" } }, "type": "object" }, "StaticMute": { -"description": "Information about the static mute state. A static mute state overrides any dynamic mute rules that apply to this finding. The static mute state can be set by a static mute rule or by muting the finding directly.", "id": "StaticMute", "properties": { "applyTime": { -"description": "When the static mute was applied.", "format": "google-datetime", "type": "string" }, "state": { -"description": "The static mute state. If the value is `MUTED` or `UNMUTED`, then the finding's overall mute state will have the same value.", "enum": [ "MUTE_UNSPECIFIED", "MUTED", @@ -12562,10 +10952,10 @@ false "UNDEFINED" ], "enumDescriptions": [ -"Unspecified.", -"Finding has been muted.", -"Finding has been unmuted.", -"Finding has never been muted/unmuted." +"", +"", +"", +"" ], "type": "string" } @@ -12573,11 +10963,9 @@ false "type": "object" }, "Subject": { -"description": "Represents a Kubernetes subject.", "id": "Subject", "properties": { "kind": { -"description": "Authentication type for the subject.", "enum": [ "AUTH_TYPE_UNSPECIFIED", "USER", @@ -12585,38 +10973,32 @@ false "GROUP" ], "enumDescriptions": [ -"Authentication is not specified.", -"User with valid certificate.", -"Users managed by Kubernetes API with credentials stored as secrets.", -"Collection of users." +"", +"", +"", +"" ], "type": "string" }, "name": { -"description": "Name for the subject.", "type": "string" }, "ns": { -"description": "Namespace for the subject.", "type": "string" } }, "type": "object" }, "Subscription": { -"description": "Resource capturing the state of an organization's subscription.", "id": "Subscription", "properties": { "details": { -"$ref": "Details", -"description": "The details of the most recent active subscription. If there has never been a subscription this will be empty." +"$ref": "Details" }, "name": { -"description": "The resource name of the subscription. Format: organizations/{organization}/subscription", "type": "string" }, "tier": { -"description": "The tier of SCC features this organization currently has access to.", "enum": [ "TIER_UNSPECIFIED", "STANDARD", @@ -12625,11 +11007,11 @@ false "ENTERPRISE_MC" ], "enumDescriptions": [ -"Default value. This value is unused.", -"The standard tier.", -"The premium tier.", -"The enterprise tier.", -"The enterprise MC tier." +"", +"", +"", +"", +"" ], "type": "string" } @@ -12637,48 +11019,38 @@ false "type": "object" }, "TicketInfo": { -"description": "Information about the ticket, if any, that is being used to track the resolution of the issue that is identified by this finding.", "id": "TicketInfo", "properties": { "assignee": { -"description": "The assignee of the ticket in the ticket system.", "type": "string" }, "description": { -"description": "The description of the ticket in the ticket system.", "type": "string" }, "id": { -"description": "The identifier of the ticket in the ticket system.", "type": "string" }, "status": { -"description": "The latest status of the ticket, as reported by the ticket system.", "type": "string" }, "updateTime": { -"description": "The time when the ticket was last updated, as reported by the ticket system.", "format": "google-datetime", "type": "string" }, "uri": { -"description": "The link to the ticket in the ticket system.", "type": "string" } }, "type": "object" }, "ToxicCombination": { -"description": "Contains details about a group of security issues that, when the issues occur together, represent a greater risk than when the issues occur independently. A group of such issues is referred to as a toxic combination.", "id": "ToxicCombination", "properties": { "attackExposureScore": { -"description": "The [Attack exposure score](https://cloud.google.com/security-command-center/docs/attack-exposure-learn#attack_exposure_scores) of this toxic combination. The score is a measure of how much this toxic combination exposes one or more high-value resources to potential attack.", "format": "double", "type": "number" }, "relatedFindings": { -"description": "List of resource names of findings associated with this toxic combination. For example, `organizations/123/sources/456/findings/789`.", "items": { "type": "string" }, @@ -12688,18 +11060,15 @@ false "type": "object" }, "VertexAi": { -"description": "Vertex AI-related information associated with the finding.", "id": "VertexAi", "properties": { "datasets": { -"description": "Datasets associated with the finding.", "items": { "$ref": "Dataset" }, "type": "array" }, "pipelines": { -"description": "Pipelines associated with the finding.", "items": { "$ref": "Pipeline" }, @@ -12709,27 +11078,22 @@ false "type": "object" }, "VirtualMachineThreatDetectionSettings": { -"description": "Resource capturing the settings for the Virtual Machine Threat Detection service.", "id": "VirtualMachineThreatDetectionSettings", "properties": { "modules": { "additionalProperties": { "$ref": "Config" }, -"description": "The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's configuration.", "type": "object" }, "name": { -"description": "Identifier. The resource name of the VirtualMachineThreatDetectionSettings. Formats: * organizations/{organization}/virtualMachineThreatDetectionSettings * folders/{folder}/virtualMachineThreatDetectionSettings * projects/{project}/virtualMachineThreatDetectionSettings", "type": "string" }, "serviceAccount": { -"description": "Output only. The service account used by Virtual Machine Threat Detection detectors.", "readOnly": true, "type": "string" }, "serviceEnablementState": { -"description": "The state of enablement for the service at its level of the resource hierarchy. A DISABLED state will override all module enablement_states to DISABLED.", "enum": [ "ENABLEMENT_STATE_UNSPECIFIED", "INHERITED", @@ -12737,15 +11101,14 @@ false "DISABLED" ], "enumDescriptions": [ -"Default value. This value is unused.", -"State is inherited from the parent resource.", -"State is enabled.", -"State is disabled." +"", +"", +"", +"" ], "type": "string" }, "updateTime": { -"description": "Output only. The time the settings were last updated.", "format": "google-datetime", "readOnly": true, "type": "string" @@ -12754,46 +11117,37 @@ false "type": "object" }, "Vulnerability": { -"description": "Refers to common vulnerability fields e.g. cve, cvss, cwe etc.", "id": "Vulnerability", "properties": { "cve": { -"$ref": "Cve", -"description": "CVE stands for Common Vulnerabilities and Exposures (https://cve.mitre.org/about/)" +"$ref": "Cve" }, "cwes": { -"description": "Represents one or more Common Weakness Enumeration (CWE) information on this vulnerability.", "items": { "$ref": "Cwe" }, "type": "array" }, "fixedPackage": { -"$ref": "Package", -"description": "The fixed package is relevant to the finding." +"$ref": "Package" }, "offendingPackage": { -"$ref": "Package", -"description": "The offending package is relevant to the finding." +"$ref": "Package" }, "providerRiskScore": { -"description": "Provider provided risk_score based on multiple factors. The higher the risk score, the more risky the vulnerability is.", "format": "int64", "type": "string" }, "reachable": { -"description": "Represents whether the vulnerability is reachable (detected via static analysis)", "type": "boolean" }, "securityBulletin": { -"$ref": "SecurityBulletin", -"description": "The security bulletin is relevant to this finding." +"$ref": "SecurityBulletin" } }, "type": "object" }, "VulnerabilityCountBySeverity": { -"description": "Vulnerability count by severity.", "id": "VulnerabilityCountBySeverity", "properties": { "severityToFindingCount": { @@ -12801,18 +11155,15 @@ false "format": "int64", "type": "string" }, -"description": "Key is the Severity enum.", "type": "object" } }, "type": "object" }, "VulnerabilitySnapshot": { -"description": "Result containing the properties and count of a VulnerabilitySnapshot request.", "id": "VulnerabilitySnapshot", "properties": { "cloudProvider": { -"description": "The cloud provider for the vulnerability snapshot.", "enum": [ "CLOUD_PROVIDER_UNSPECIFIED", "GOOGLE_CLOUD_PLATFORM", @@ -12820,23 +11171,20 @@ false "MICROSOFT_AZURE" ], "enumDescriptions": [ -"The cloud provider is unspecified.", -"The cloud provider is Google Cloud.", -"The cloud provider is Amazon Web Services.", -"The cloud provider is Microsoft Azure." +"", +"", +"", +"" ], "type": "string" }, "findingCount": { -"$ref": "VulnerabilityCountBySeverity", -"description": "The vulnerability count by severity." +"$ref": "VulnerabilityCountBySeverity" }, "name": { -"description": "Identifier. The vulnerability snapshot name. Format: //locations//vulnerabilitySnapshots/", "type": "string" }, "snapshotTime": { -"description": "The time that the snapshot was taken.", "format": "google-datetime", "type": "string" } @@ -12844,22 +11192,18 @@ false "type": "object" }, "WebSecurityScannerSettings": { -"description": "Resource capturing the settings for the Web Security Scanner service.", "id": "WebSecurityScannerSettings", "properties": { "modules": { "additionalProperties": { "$ref": "Config" }, -"description": "The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's configuration.", "type": "object" }, "name": { -"description": "Identifier. The resource name of the WebSecurityScannerSettings. Formats: * organizations/{organization}/webSecurityScannerSettings * folders/{folder}/webSecurityScannerSettings * projects/{project}/webSecurityScannerSettings", "type": "string" }, "serviceEnablementState": { -"description": "The state of enablement for the service at its level of the resource hierarchy. A DISABLED state will override all module enablement_states to DISABLED.", "enum": [ "ENABLEMENT_STATE_UNSPECIFIED", "INHERITED", @@ -12867,15 +11211,14 @@ false "DISABLED" ], "enumDescriptions": [ -"Default value. This value is unused.", -"State is inherited from the parent resource.", -"State is enabled.", -"State is disabled." +"", +"", +"", +"" ], "type": "string" }, "updateTime": { -"description": "Output only. The time the settings were last updated.", "format": "google-datetime", "readOnly": true, "type": "string" @@ -12884,11 +11227,9 @@ false "type": "object" }, "YaraRuleSignature": { -"description": "A signature corresponding to a YARA rule.", "id": "YaraRuleSignature", "properties": { "yaraRule": { -"description": "The name of the YARA rule.", "type": "string" } }, diff --git a/googleapiclient/discovery_cache/documents/servicecontrol.v1.json b/googleapiclient/discovery_cache/documents/servicecontrol.v1.json index 00ff874208..8aa13f6e4f 100644 --- a/googleapiclient/discovery_cache/documents/servicecontrol.v1.json +++ b/googleapiclient/discovery_cache/documents/servicecontrol.v1.json @@ -197,7 +197,7 @@ } } }, -"revision": "20260428", +"revision": "20260512", "rootUrl": "https://servicecontrol.googleapis.com/", "schemas": { "AllocateInfo": { @@ -422,6 +422,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" }, +"credentialId": { +"description": "Identifies the client credential id used for authentication. credential_id is in the format of AUTH_METHOD:IDENTIFIER, e.g. \"serviceaccount:XXXXX, apikey:XXXXX\" where the format of the IDENTIFIER can vary for different AUTH_METHODs.", +"type": "string" +}, "oauth": { "$ref": "Oauth", "description": "Attributes of the OAuth token associated with the request." diff --git a/googleapiclient/discovery_cache/documents/servicecontrol.v2.json b/googleapiclient/discovery_cache/documents/servicecontrol.v2.json index d67a2a8bec..f9b3a91dac 100644 --- a/googleapiclient/discovery_cache/documents/servicecontrol.v2.json +++ b/googleapiclient/discovery_cache/documents/servicecontrol.v2.json @@ -169,7 +169,7 @@ } } }, -"revision": "20260428", +"revision": "20260512", "rootUrl": "https://servicecontrol.googleapis.com/", "schemas": { "Api": { @@ -363,6 +363,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" }, +"credentialId": { +"description": "Identifies the client credential id used for authentication. credential_id is in the format of AUTH_METHOD:IDENTIFIER, e.g. \"serviceaccount:XXXXX, apikey:XXXXX\" where the format of the IDENTIFIER can vary for different AUTH_METHODs.", +"type": "string" +}, "oauth": { "$ref": "Oauth", "description": "Attributes of the OAuth token associated with the request." diff --git a/googleapiclient/discovery_cache/documents/storage.v1.json b/googleapiclient/discovery_cache/documents/storage.v1.json index f9603b7f5d..7ddeb56927 100644 --- a/googleapiclient/discovery_cache/documents/storage.v1.json +++ b/googleapiclient/discovery_cache/documents/storage.v1.json @@ -253,7 +253,7 @@ "location": "northamerica-south1" } ], -"etag": "\"3136383236333536383830353031333435373432\"", +"etag": "\"3135343638383433383330343638393536313030\"", "icons": { "x16": "https://www.google.com/images/icons/product/cloud_storage-16.png", "x32": "https://www.google.com/images/icons/product/cloud_storage-32.png" @@ -4605,7 +4605,7 @@ } } }, -"revision": "20260408", +"revision": "20260524", "rootUrl": "https://storage.googleapis.com/", "schemas": { "AdvanceRelocateBucketOperationRequest": { @@ -5118,6 +5118,16 @@ "description": "Relevant only for versioned objects. If the value is N, this condition is satisfied when there are at least N versions (including the live version) newer than this version of the object.", "format": "int32", "type": "integer" +}, +"sizeAboveBytes": { +"description": "Objects having a size greater than this value in bytes will be matched.", +"format": "int64", +"type": "string" +}, +"sizeBelowBytes": { +"description": "Objects having a size less than this value in bytes will be matched.", +"format": "int64", +"type": "string" } }, "type": "object" diff --git a/googleapiclient/discovery_cache/documents/tagmanager.v2.json b/googleapiclient/discovery_cache/documents/tagmanager.v2.json index a571ca5cd9..0c88ad6879 100644 --- a/googleapiclient/discovery_cache/documents/tagmanager.v2.json +++ b/googleapiclient/discovery_cache/documents/tagmanager.v2.json @@ -3986,7 +3986,7 @@ } } }, -"revision": "20260511", +"revision": "20260527", "rootUrl": "https://tagmanager.googleapis.com/", "schemas": { "Account": { @@ -6593,12 +6593,14 @@ "enum": [ "decimalSeparatorTypeUnspecified", "period", -"comma" +"comma", +"automatic" ], "enumDescriptions": [ "", "The option to convert a variable value to a number with a period as the decimal separator.", -"The option to convert a variable value to a number with a comma as the decimal separator." +"The option to convert a variable value to a number with a comma as the decimal separator.", +"The option to convert a variable value to a number with automatic decimal separator detection." ], "type": "string" }, diff --git a/googleapiclient/discovery_cache/documents/threatintelligence.v1beta.json b/googleapiclient/discovery_cache/documents/threatintelligence.v1beta.json index efe0624753..a6cfed0f76 100644 --- a/googleapiclient/discovery_cache/documents/threatintelligence.v1beta.json +++ b/googleapiclient/discovery_cache/documents/threatintelligence.v1beta.json @@ -20,21 +20,6 @@ "description": "Regional Endpoint", "endpointUrl": "https://threatintelligence.us-central1.rep.googleapis.com/", "location": "us-central1" -}, -{ -"description": "Regional Endpoint", -"endpointUrl": "https://threatintelligence.us-east5.rep.googleapis.com/", -"location": "us-east5" -}, -{ -"description": "Regional Endpoint", -"endpointUrl": "https://threatintelligence.us-west2.rep.googleapis.com/", -"location": "us-west2" -}, -{ -"description": "Regional Endpoint", -"endpointUrl": "https://threatintelligence.us.rep.googleapis.com/", -"location": "us" } ], "fullyEncodeReservedExpansion": true, @@ -832,7 +817,7 @@ } } }, -"revision": "20260513", +"revision": "20260527", "rootUrl": "https://threatintelligence.googleapis.com/", "schemas": { "Alert": { @@ -1122,6 +1107,10 @@ "readOnly": true, "type": "string" }, +"etag": { +"description": "If included when updating a configuration, this should be set to the current etag of the configuration. If the etags do not match, the update will be rejected and an ABORTED error will be returned.", +"type": "string" +}, "name": { "description": "Identifier. Server generated name for the configuration. format is projects/{project}/configurations/{configuration}", "type": "string" diff --git a/googleapiclient/discovery_cache/documents/toolresults.v1beta3.json b/googleapiclient/discovery_cache/documents/toolresults.v1beta3.json index f53ccf3ec8..a2610b3dda 100644 --- a/googleapiclient/discovery_cache/documents/toolresults.v1beta3.json +++ b/googleapiclient/discovery_cache/documents/toolresults.v1beta3.json @@ -1464,7 +1464,7 @@ } } }, -"revision": "20260325", +"revision": "20260528", "rootUrl": "https://toolresults.googleapis.com/", "schemas": { "ANR": { @@ -2336,6 +2336,12 @@ "properties": {}, "type": "object" }, +"LicensingProtectionTermination": { +"description": "Licensing protection termination (Pairip) was detected.", +"id": "LicensingProtectionTermination", +"properties": {}, +"type": "object" +}, "ListEnvironmentsResponse": { "description": "Response message for EnvironmentService.ListEnvironments.", "id": "ListEnvironmentsResponse", @@ -3640,7 +3646,8 @@ "deviceOutOfMemory", "logcatCollectionError", "detectedAppSplashScreen", -"assetIssue" +"assetIssue", +"licensingProtectionTermination" ], "enumDescriptions": [ "Default unspecified type. Do not use. For versioning only.", @@ -3675,7 +3682,8 @@ "Device running out of memory was detected", "Problems detected while collecting logcat", "Robo detected a splash screen provided by app (vs. Android OS splash screen).", -"There was an issue with the assets in this test." +"There was an issue with the assets in this test.", +"Licensing protection termination (Pairip) was detected." ], "type": "string" }, diff --git a/googleapiclient/discovery_cache/documents/travelimpactmodel.v1.json b/googleapiclient/discovery_cache/documents/travelimpactmodel.v1.json index 1e396a3456..5a103329c2 100644 --- a/googleapiclient/discovery_cache/documents/travelimpactmodel.v1.json +++ b/googleapiclient/discovery_cache/documents/travelimpactmodel.v1.json @@ -99,7 +99,7 @@ "flights": { "methods": { "computeFlightEmissions": { -"description": "Stateless method to retrieve emission estimates. Details on how emission estimates are computed are in [GitHub](https://github.com/google/travel-impact-model) The response will contain all entries that match the input flight legs, in the same order. If there are no estimates available for a certain flight leg, the response will return the flight leg object with empty emission fields. The request will still be considered successful. Reasons for missing emission estimates include: * The flight is unknown to the server. * The input flight leg is missing one or more identifiers. * The flight date is in the past. * The aircraft type is not supported by the model. * Missing seat configuration. The request can contain up to 1000 flight legs. If the request has more than 1000 direct flights, if will fail with an INVALID_ARGUMENT error.", +"description": "Stateless method to retrieve emission estimates. Details on how emission estimates are computed are in [GitHub](https://github.com/google/travel-impact-model). The response will contain all entries that match the input flight legs, in the same order. If there are no estimates available for a certain flight leg, the response will return the flight leg object with empty emission fields. The request will still be considered successful. Reasons for missing emission estimates include: * The flight is unknown to the server. * The input flight leg is missing one or more identifiers. * The flight date is in the past. * The aircraft type is not supported by the model. * Missing seat configuration. The request can contain up to 1000 flight legs. If the request has more than 1000 direct flights, if will fail with an INVALID_ARGUMENT error.", "flatPath": "v1/flights:computeFlightEmissions", "httpMethod": "POST", "id": "travelimpactmodel.flights.computeFlightEmissions", @@ -146,7 +146,7 @@ } } }, -"revision": "20260325", +"revision": "20260525", "rootUrl": "https://travelimpactmodel.googleapis.com/", "schemas": { "ComputeFlightEmissionsRequest": { diff --git a/googleapiclient/discovery_cache/documents/vault.v1.json b/googleapiclient/discovery_cache/documents/vault.v1.json index 802f93955a..893abc2209 100644 --- a/googleapiclient/discovery_cache/documents/vault.v1.json +++ b/googleapiclient/discovery_cache/documents/vault.v1.json @@ -1208,7 +1208,7 @@ } } }, -"revision": "20251126", +"revision": "20260528", "rootUrl": "https://vault.googleapis.com/", "schemas": { "AccountCount": { @@ -1352,14 +1352,16 @@ "MBOX", "PST", "ICS", -"XML" +"XML", +"JSON" ], "enumDescriptions": [ "No export format specified.", "Export as MBOX. Only available for Gmail, Groups, Hangouts and Voice.", "Export as PST. Only available for Gmail, Groups, Hangouts, Voice and Calendar.", "Export as ICS. Only available for Calendar.", -"Export as XML. Only available for Gemini." +"Export as XML. Only available for Gemini.", +"Export as JSON. Only available for Gemini in Workpace." ], "type": "string" } @@ -1827,14 +1829,16 @@ "MBOX", "PST", "ICS", -"XML" +"XML", +"JSON" ], "enumDescriptions": [ "No export format specified.", "Export as MBOX. Only available for Gmail, Groups, Hangouts and Voice.", "Export as PST. Only available for Gmail, Groups, Hangouts, Voice and Calendar.", "Export as ICS. Only available for Calendar.", -"Export as XML. Only available for Gemini." +"Export as XML. Only available for Gemini.", +"Export as JSON. Only available for Gemini in Workpace." ], "type": "string" } @@ -1896,14 +1900,16 @@ "MBOX", "PST", "ICS", -"XML" +"XML", +"JSON" ], "enumDescriptions": [ "No export format specified.", "Export as MBOX. Only available for Gmail, Groups, Hangouts and Voice.", "Export as PST. Only available for Gmail, Groups, Hangouts, Voice and Calendar.", "Export as ICS. Only available for Calendar.", -"Export as XML. Only available for Gemini." +"Export as XML. Only available for Gemini.", +"Export as JSON. Only available for Gemini in Workpace." ], "type": "string" } @@ -1921,14 +1927,16 @@ "MBOX", "PST", "ICS", -"XML" +"XML", +"JSON" ], "enumDescriptions": [ "No export format specified.", "Export as MBOX. Only available for Gmail, Groups, Hangouts and Voice.", "Export as PST. Only available for Gmail, Groups, Hangouts, Voice and Calendar.", "Export as ICS. Only available for Calendar.", -"Export as XML. Only available for Gemini." +"Export as XML. Only available for Gemini.", +"Export as JSON. Only available for Gemini in Workpace." ], "type": "string" } @@ -2324,14 +2332,16 @@ "MBOX", "PST", "ICS", -"XML" +"XML", +"JSON" ], "enumDescriptions": [ "No export format specified.", "Export as MBOX. Only available for Gmail, Groups, Hangouts and Voice.", "Export as PST. Only available for Gmail, Groups, Hangouts, Voice and Calendar.", "Export as ICS. Only available for Calendar.", -"Export as XML. Only available for Gemini." +"Export as XML. Only available for Gemini.", +"Export as JSON. Only available for Gemini in Workpace." ], "type": "string" }, @@ -2886,14 +2896,16 @@ false "MBOX", "PST", "ICS", -"XML" +"XML", +"JSON" ], "enumDescriptions": [ "No export format specified.", "Export as MBOX. Only available for Gmail, Groups, Hangouts and Voice.", "Export as PST. Only available for Gmail, Groups, Hangouts, Voice and Calendar.", "Export as ICS. Only available for Calendar.", -"Export as XML. Only available for Gemini." +"Export as XML. Only available for Gemini.", +"Export as JSON. Only available for Gemini in Workpace." ], "type": "string" } diff --git a/googleapiclient/discovery_cache/documents/vmmigration.v1.json b/googleapiclient/discovery_cache/documents/vmmigration.v1.json index c5e9287c08..072b95659e 100644 --- a/googleapiclient/discovery_cache/documents/vmmigration.v1.json +++ b/googleapiclient/discovery_cache/documents/vmmigration.v1.json @@ -2548,7 +2548,7 @@ } } }, -"revision": "20260423", +"revision": "20260521", "rootUrl": "https://vmmigration.googleapis.com/", "schemas": { "AccessKeyCredentials": { @@ -3668,6 +3668,13 @@ ], "type": "string" }, +"disks": { +"description": "Optional. The details of each disk to create.", +"items": { +"$ref": "PersistentDiskDefaults" +}, +"type": "array" +}, "enableIntegrityMonitoring": { "description": "Optional. Defines whether the instance has integrity monitoring enabled. This can be set to true only if the VM boot option is EFI, and vTPM is enabled.", "type": "boolean" @@ -5960,12 +5967,14 @@ "id": "PersistentDisk", "properties": { "diskUri": { -"description": "The URI of the Persistent Disk.", +"description": "Output only. The URI of the Persistent Disk.", +"readOnly": true, "type": "string" }, "sourceDiskNumber": { -"description": "The ordinal number of the source VM disk.", +"description": "Output only. The ordinal number of the source VM disk.", "format": "int32", +"readOnly": true, "type": "integer" } }, diff --git a/googleapiclient/discovery_cache/documents/vmmigration.v1alpha1.json b/googleapiclient/discovery_cache/documents/vmmigration.v1alpha1.json index 2b5262b43a..cd6a5816a9 100644 --- a/googleapiclient/discovery_cache/documents/vmmigration.v1alpha1.json +++ b/googleapiclient/discovery_cache/documents/vmmigration.v1alpha1.json @@ -2548,7 +2548,7 @@ } } }, -"revision": "20260423", +"revision": "20260521", "rootUrl": "https://vmmigration.googleapis.com/", "schemas": { "AccessKeyCredentials": { @@ -3680,6 +3680,13 @@ ], "type": "string" }, +"disks": { +"description": "Optional. The details of each disk to create.", +"items": { +"$ref": "PersistentDiskDefaults" +}, +"type": "array" +}, "enableIntegrityMonitoring": { "description": "Optional. Defines whether the instance has integrity monitoring enabled. This can be set to true only if the VM boot option is EFI, and vTPM is enabled.", "type": "boolean" @@ -6005,12 +6012,14 @@ "id": "PersistentDisk", "properties": { "diskUri": { -"description": "The URI of the Persistent Disk.", +"description": "Output only. The URI of the Persistent Disk.", +"readOnly": true, "type": "string" }, "sourceDiskNumber": { -"description": "The ordinal number of the source VM disk.", +"description": "Output only. The ordinal number of the source VM disk.", "format": "int32", +"readOnly": true, "type": "integer" } }, diff --git a/googleapiclient/discovery_cache/documents/vmwareengine.v1.json b/googleapiclient/discovery_cache/documents/vmwareengine.v1.json index 29249ac8ce..a5f3896414 100644 --- a/googleapiclient/discovery_cache/documents/vmwareengine.v1.json +++ b/googleapiclient/discovery_cache/documents/vmwareengine.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. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -1579,6 +1579,34 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, +"migrateManagementVms": { +"description": "Migrates the management VMs of the PC from the current management cluster to a workload cluster. Post this migration, the provided workload cluster becomes the management cluster", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/privateClouds/{privateCloudsId}:migrateManagementVms", +"httpMethod": "POST", +"id": "vmwareengine.projects.locations.privateClouds.migrateManagementVms", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The resource name of the private cloud whose management vms are getting migrated. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-project/locations/us-central1-a/privateClouds/my-cloud`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/privateClouds/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}:migrateManagementVms", +"request": { +"$ref": "MigrateManagementVmsRequest" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, "patch": { "description": "Modifies a `PrivateCloud` resource. Only the following fields can be updated: `description`. Only fields specified in `updateMask` are applied. During operation processing, the resource is temporarily in the `ACTIVE` state before the operation fully completes. For that period of time, you can't update the resource. Use the operation status to determine when the processing fully completes.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/privateClouds/{privateCloudsId}", @@ -3714,7 +3742,7 @@ } } }, -"revision": "20260420", +"revision": "20260518", "rootUrl": "https://vmwareengine.googleapis.com/", "schemas": { "AcceleratePrivateCloudDeletionRequest": { @@ -5356,6 +5384,25 @@ }, "type": "object" }, +"MigrateManagementVmsRequest": { +"description": "Request message for VmwareEngine.MigrateManagementVms", +"id": "MigrateManagementVmsRequest", +"properties": { +"clusterId": { +"description": "Required. The user-provided identifier of the workload cluster to which the management VMs are to be migrated. The cluster must be in the same private cloud as the one specified in `name`, and must be a workload cluster. The eventual cluster name will be constructed from the private cloud name and this cluster ID.", +"type": "string" +}, +"etag": { +"description": "Optional. Checksum used to ensure that the user-provided value is up to date before the server processes the request. The server compares provided checksum with the current checksum of the resource. If the user-provided value is out of date, this request returns an `ABORTED` error.", +"type": "string" +}, +"requestId": { +"description": "Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server guarantees that a request doesn't result in creation of duplicate commitments for at least 60 minutes. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if the original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", +"type": "string" +} +}, +"type": "object" +}, "MountDatastoreRequest": { "description": "Mount Datastore Request message", "id": "MountDatastoreRequest", diff --git a/googleapiclient/discovery_cache/documents/webcontentpublisher.v1.json b/googleapiclient/discovery_cache/documents/webcontentpublisher.v1.json new file mode 100644 index 0000000000..ffc8798398 --- /dev/null +++ b/googleapiclient/discovery_cache/documents/webcontentpublisher.v1.json @@ -0,0 +1,167 @@ +{ +"auth": { +"oauth2": { +"scopes": { +"https://www.googleapis.com/auth/subscribewithgoogle.publications.entitlements.readonly": { +"description": "See and review your subscription information" +} +} +} +}, +"basePath": "", +"baseUrl": "https://webcontentpublisher.googleapis.com/", +"batchPath": "batch", +"canonicalName": "Web Content Publisher", +"description": "webcontentpublisher.googleapis.com API, a service for web content publishers.", +"discoveryVersion": "v1", +"documentationLink": "https://developers.google.com/news/subscribe", +"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": "webcontentpublisher:v1", +"kind": "discovery#restDescription", +"mtlsRootUrl": "https://webcontentpublisher.mtls.googleapis.com/", +"name": "webcontentpublisher", +"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": { +"publications": { +"methods": { +"checkFreeAccess": { +"description": "Checks if a user is eligible for free article access.", +"flatPath": "v1/publications/{publicationsId}:checkFreeAccess", +"httpMethod": "GET", +"id": "webcontentpublisher.publications.checkFreeAccess", +"parameterOrder": [ +"name" +], +"parameters": { +"httpReferrer": { +"description": "Required. The HTTP referrer.", +"location": "query", +"type": "string" +}, +"name": { +"description": "Required. The resource name of the publication. Format: publications/{publication_id}", +"location": "path", +"pattern": "^publications/[^/]+$", +"required": true, +"type": "string" +}, +"uri": { +"description": "Required. The URI of the content.", +"location": "query", +"type": "string" +} +}, +"path": "v1/{+name}:checkFreeAccess", +"response": { +"$ref": "CheckFreeAccessResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/subscribewithgoogle.publications.entitlements.readonly" +] +} +} +} +}, +"revision": "20260526", +"rootUrl": "https://webcontentpublisher.googleapis.com/", +"schemas": { +"CheckFreeAccessResponse": { +"description": "Response message for CheckFreeAccess", +"id": "CheckFreeAccessResponse", +"properties": { +"isAllowed": { +"description": "True if free access should be allowed, false otherwise.", +"type": "boolean" +} +}, +"type": "object" +} +}, +"servicePath": "", +"title": "Web Content Publisher API", +"version": "v1", +"version_module": true +} \ No newline at end of file diff --git a/googleapiclient/discovery_cache/documents/webrisk.v1.json b/googleapiclient/discovery_cache/documents/webrisk.v1.json index 7fb98fa411..448499bb55 100644 --- a/googleapiclient/discovery_cache/documents/webrisk.v1.json +++ b/googleapiclient/discovery_cache/documents/webrisk.v1.json @@ -275,7 +275,7 @@ "submissions": { "methods": { "create": { -"description": "Creates a Submission of a URI suspected of containing phishing content to be reviewed. If the result verifies the existence of malicious phishing content, the site will be added to the [Google's Social Engineering lists](https://support.google.com/webmasters/answer/6350487/) in order to protect users that could get exposed to this threat in the future. Only allowlisted projects can use this method during Early Access. Please reach out to Sales or your customer engineer to obtain access.", +"description": "Creates a Submission of a URI suspected of containing phishing content for review. If the review confirms malicious phishing content, Google adds the site to [Google's Social Engineering lists](https://support.google.com/webmasters/answer/6350487/) to help protect users. Only allowlisted projects can use this method during Early Access. To obtain access, contact Sales or your customer engineer.", "flatPath": "v1/projects/{projectsId}/submissions", "httpMethod": "POST", "id": "webrisk.projects.submissions.create", @@ -425,7 +425,7 @@ } } }, -"revision": "20251202", +"revision": "20260517", "rootUrl": "https://webrisk.googleapis.com/", "schemas": { "GoogleCloudWebriskV1ComputeThreatListDiffResponse": { diff --git a/googleapiclient/discovery_cache/documents/workspaceevents.v1.json b/googleapiclient/discovery_cache/documents/workspaceevents.v1.json index 4301159fec..651db2251d 100644 --- a/googleapiclient/discovery_cache/documents/workspaceevents.v1.json +++ b/googleapiclient/discovery_cache/documents/workspaceevents.v1.json @@ -44,6 +44,12 @@ "https://www.googleapis.com/auth/chat.spaces.readonly": { "description": "View chat and spaces in Google Chat" }, +"https://www.googleapis.com/auth/chat.users.availability": { +"description": "See and change your availability status in Google Chat." +}, +"https://www.googleapis.com/auth/chat.users.availability.readonly": { +"description": "See your availability status in Google Chat." +}, "https://www.googleapis.com/auth/chat.users.readstate": { "description": "View and modify last read time for Google Chat conversations" }, @@ -223,6 +229,8 @@ "https://www.googleapis.com/auth/chat.messages.readonly", "https://www.googleapis.com/auth/chat.spaces", "https://www.googleapis.com/auth/chat.spaces.readonly", +"https://www.googleapis.com/auth/chat.users.availability", +"https://www.googleapis.com/auth/chat.users.availability.readonly", "https://www.googleapis.com/auth/chat.users.readstate", "https://www.googleapis.com/auth/chat.users.readstate.readonly", "https://www.googleapis.com/auth/drive", @@ -272,6 +280,8 @@ "https://www.googleapis.com/auth/chat.messages.readonly", "https://www.googleapis.com/auth/chat.spaces", "https://www.googleapis.com/auth/chat.spaces.readonly", +"https://www.googleapis.com/auth/chat.users.availability", +"https://www.googleapis.com/auth/chat.users.availability.readonly", "https://www.googleapis.com/auth/chat.users.readstate", "https://www.googleapis.com/auth/chat.users.readstate.readonly", "https://www.googleapis.com/auth/drive", @@ -329,6 +339,8 @@ "https://www.googleapis.com/auth/chat.messages.readonly", "https://www.googleapis.com/auth/chat.spaces", "https://www.googleapis.com/auth/chat.spaces.readonly", +"https://www.googleapis.com/auth/chat.users.availability", +"https://www.googleapis.com/auth/chat.users.availability.readonly", "https://www.googleapis.com/auth/chat.users.readstate", "https://www.googleapis.com/auth/chat.users.readstate.readonly", "https://www.googleapis.com/auth/drive", @@ -371,6 +383,8 @@ "https://www.googleapis.com/auth/chat.messages.readonly", "https://www.googleapis.com/auth/chat.spaces", "https://www.googleapis.com/auth/chat.spaces.readonly", +"https://www.googleapis.com/auth/chat.users.availability", +"https://www.googleapis.com/auth/chat.users.availability.readonly", "https://www.googleapis.com/auth/chat.users.readstate", "https://www.googleapis.com/auth/chat.users.readstate.readonly", "https://www.googleapis.com/auth/drive", @@ -420,6 +434,8 @@ "https://www.googleapis.com/auth/chat.messages.readonly", "https://www.googleapis.com/auth/chat.spaces", "https://www.googleapis.com/auth/chat.spaces.readonly", +"https://www.googleapis.com/auth/chat.users.availability", +"https://www.googleapis.com/auth/chat.users.availability.readonly", "https://www.googleapis.com/auth/chat.users.readstate", "https://www.googleapis.com/auth/chat.users.readstate.readonly", "https://www.googleapis.com/auth/drive", @@ -480,6 +496,8 @@ "https://www.googleapis.com/auth/chat.messages.readonly", "https://www.googleapis.com/auth/chat.spaces", "https://www.googleapis.com/auth/chat.spaces.readonly", +"https://www.googleapis.com/auth/chat.users.availability", +"https://www.googleapis.com/auth/chat.users.availability.readonly", "https://www.googleapis.com/auth/chat.users.readstate", "https://www.googleapis.com/auth/chat.users.readstate.readonly", "https://www.googleapis.com/auth/drive", @@ -529,6 +547,8 @@ "https://www.googleapis.com/auth/chat.messages.readonly", "https://www.googleapis.com/auth/chat.spaces", "https://www.googleapis.com/auth/chat.spaces.readonly", +"https://www.googleapis.com/auth/chat.users.availability", +"https://www.googleapis.com/auth/chat.users.availability.readonly", "https://www.googleapis.com/auth/chat.users.readstate", "https://www.googleapis.com/auth/chat.users.readstate.readonly", "https://www.googleapis.com/auth/drive", @@ -765,7 +785,7 @@ } } }, -"revision": "20260510", +"revision": "20260517", "rootUrl": "https://workspaceevents.googleapis.com/", "schemas": { "Artifact": { diff --git a/googleapiclient/discovery_cache/documents/youtube.v3.json b/googleapiclient/discovery_cache/documents/youtube.v3.json index 0fad32a6f3..6fa9e5b070 100644 --- a/googleapiclient/discovery_cache/documents/youtube.v3.json +++ b/googleapiclient/discovery_cache/documents/youtube.v3.json @@ -2756,7 +2756,7 @@ ], "parameters": { "channelId": { -"description": "Filter on resources belonging to this channelId.", +"description": "Filter on resources belonging to this channelId. (Force TAP rebuild)", "location": "query", "type": "string" }, @@ -4176,7 +4176,7 @@ } } }, -"revision": "20260430", +"revision": "20260525", "rootUrl": "https://youtube.googleapis.com/", "schemas": { "AbuseReport": { @@ -10578,7 +10578,7 @@ true "$ref": "TokenPagination" }, "visitorId": { -"description": "The visitorId identifies the visitor.", +"description": "The visitor ID identifies the visitor.", "type": "string" } },